diff --git a/marked/Rel-16/29_series/29007/05da2a3257316bbf6f448a830dc0380a_img.jpg b/marked/Rel-16/29_series/29007/05da2a3257316bbf6f448a830dc0380a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7cca00a17d22a879ef358fa667544d68a7509c91 --- /dev/null +++ b/marked/Rel-16/29_series/29007/05da2a3257316bbf6f448a830dc0380a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5780b93bae90e80d060e98beb182b42a3a91dcf7e94d573696040cdb377a38e1 +size 39563 diff --git a/marked/Rel-16/29_series/29007/0f6e3cdce0f01d6ccceabcced508bb5b_img.jpg b/marked/Rel-16/29_series/29007/0f6e3cdce0f01d6ccceabcced508bb5b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b0d026e0d91b5224bca01e7ed7732a4f332458d3 --- /dev/null +++ b/marked/Rel-16/29_series/29007/0f6e3cdce0f01d6ccceabcced508bb5b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:06018bcd6dcfb3dac4f4338e664987f0b3cfa89d854d767740c3a06e282a8bc6 +size 37808 diff --git a/marked/Rel-16/29_series/29007/1399c76ef88f22b70d05ed3f781d3c48_img.jpg b/marked/Rel-16/29_series/29007/1399c76ef88f22b70d05ed3f781d3c48_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..367a782ba89f3fd3f6d7ecddc1f207e177b69dd2 --- /dev/null +++ b/marked/Rel-16/29_series/29007/1399c76ef88f22b70d05ed3f781d3c48_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4b696a6ee909a176a1d4d3ff9081f894f2071358a2600eb858e58c14c85add27 +size 32441 diff --git a/marked/Rel-16/29_series/29007/190217f95ce423a68d4a144cbd9df011_img.jpg b/marked/Rel-16/29_series/29007/190217f95ce423a68d4a144cbd9df011_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..176ad58dc048ed1e38eab3705ec824237487b2ec --- /dev/null +++ b/marked/Rel-16/29_series/29007/190217f95ce423a68d4a144cbd9df011_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:95db50ce49e52a6b9d381141dce83ceae2065be9b93d6ddbda5c7d66cf587c2b +size 45058 diff --git a/marked/Rel-16/29_series/29007/24a27d17656bcf0ee131539f2bbb34cd_img.jpg b/marked/Rel-16/29_series/29007/24a27d17656bcf0ee131539f2bbb34cd_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3cf0b80593922d630fc9be1699d08d80a324884f --- /dev/null +++ b/marked/Rel-16/29_series/29007/24a27d17656bcf0ee131539f2bbb34cd_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0172177a724d5760122003288bbaf690065424a9f109d7202064827b037083fe +size 49036 diff --git a/marked/Rel-16/29_series/29007/2734e7f9be3e1dc046f14be2e6c9a085_img.jpg b/marked/Rel-16/29_series/29007/2734e7f9be3e1dc046f14be2e6c9a085_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..28134ad1ddea2290269c63945c8cb201f28c1f27 --- /dev/null +++ b/marked/Rel-16/29_series/29007/2734e7f9be3e1dc046f14be2e6c9a085_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ea98921a03f78dc97f80741683a68843bc6cb355a96a49f2f6e600115a720155 +size 7742 diff --git a/marked/Rel-16/29_series/29007/29a9cd1cb2a960eb91dbf79aab5d8668_img.jpg b/marked/Rel-16/29_series/29007/29a9cd1cb2a960eb91dbf79aab5d8668_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b85bca846f29125a7c11f27e298aa6c24da380f9 --- /dev/null +++ b/marked/Rel-16/29_series/29007/29a9cd1cb2a960eb91dbf79aab5d8668_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:baaf88a60a1bb30cb99730e37810c48a85c5f7238788da22f95264e45abaadc3 +size 26484 diff --git a/marked/Rel-16/29_series/29007/303fadfb9def251d1575d6221199b158_img.jpg b/marked/Rel-16/29_series/29007/303fadfb9def251d1575d6221199b158_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6ab19a7cc878a893f81cdcddc1f0e5a2110f83f5 --- /dev/null +++ b/marked/Rel-16/29_series/29007/303fadfb9def251d1575d6221199b158_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e29807861654941c39f4b4feac9378648775de6c49ad97a69f7e1b9f81519cc5 +size 29650 diff --git a/marked/Rel-16/29_series/29007/32ff77da4286b58c4778033acaa10836_img.jpg b/marked/Rel-16/29_series/29007/32ff77da4286b58c4778033acaa10836_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..de9f9376d6440ce5dd57aa0b8a9e274c332ae553 --- /dev/null +++ b/marked/Rel-16/29_series/29007/32ff77da4286b58c4778033acaa10836_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0377de3c881d0b7f7e7b7c62e6e4d4951c2737d45609037bb192ddd55363110d +size 65870 diff --git a/marked/Rel-16/29_series/29007/4dd5f00d74e7db5bbb2d011609bcc43d_img.jpg b/marked/Rel-16/29_series/29007/4dd5f00d74e7db5bbb2d011609bcc43d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..dc52f783209eadfb4cc5c656dda3065e8085d550 --- /dev/null +++ b/marked/Rel-16/29_series/29007/4dd5f00d74e7db5bbb2d011609bcc43d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0ab427cd269957bbeb5d33e9ebc87877501b99e249f7cb80c5fdba0164f5c4e3 +size 13566 diff --git a/marked/Rel-16/29_series/29007/659f4d3d272deea8021d0bb2e22465fd_img.jpg b/marked/Rel-16/29_series/29007/659f4d3d272deea8021d0bb2e22465fd_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3b2cf6d6f78190fc8a192e509afc142af52daf87 --- /dev/null +++ b/marked/Rel-16/29_series/29007/659f4d3d272deea8021d0bb2e22465fd_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:40535d86c1a1b0ab96de3c06ca2b1ad77c16b1af8e96802f5ee0d6cd016f417f +size 32541 diff --git a/marked/Rel-16/29_series/29007/7e1c9b51e067a48cd0fcc9748d8bd8d8_img.jpg b/marked/Rel-16/29_series/29007/7e1c9b51e067a48cd0fcc9748d8bd8d8_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..41a5cb2c03d1c3e156b0ae07c8d392e006fdaad5 --- /dev/null +++ b/marked/Rel-16/29_series/29007/7e1c9b51e067a48cd0fcc9748d8bd8d8_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2a3946fb0bb81adb5eb4d4ef96cf670d6aa4c66d36ec4d55b856b99054b68003 +size 54106 diff --git a/marked/Rel-16/29_series/29007/7fe4241eea8865aa6d2686d711c13ba6_img.jpg b/marked/Rel-16/29_series/29007/7fe4241eea8865aa6d2686d711c13ba6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2eba6dabc5094290dde03bc55b5335477bfe5f47 --- /dev/null +++ b/marked/Rel-16/29_series/29007/7fe4241eea8865aa6d2686d711c13ba6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:150a8d5c77f966612e8d46bf7e65ddeb336f1d1ad29e7a3ae338a364259b32ee +size 15906 diff --git a/marked/Rel-16/29_series/29007/a0eb8d30ac11ba97b2733c187b89ff22_img.jpg b/marked/Rel-16/29_series/29007/a0eb8d30ac11ba97b2733c187b89ff22_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8a56a139d7faa626916c5907d7398ee5f61f196c --- /dev/null +++ b/marked/Rel-16/29_series/29007/a0eb8d30ac11ba97b2733c187b89ff22_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f3594a3fd0c2d43a125ec638daec291267996c6d5b0281812d1c32956b3c542d +size 78105 diff --git a/marked/Rel-16/29_series/29007/a320e67b369bfde4a5fa360b100da55c_img.jpg b/marked/Rel-16/29_series/29007/a320e67b369bfde4a5fa360b100da55c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..80a13e2f9838f979f978afd8d8a421857994eb0a --- /dev/null +++ b/marked/Rel-16/29_series/29007/a320e67b369bfde4a5fa360b100da55c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f75820a1b9969ca2cfcf0079af984cbb7f0cc228d167038e15ea37b54a159e1a +size 162972 diff --git a/marked/Rel-16/29_series/29007/ced309874aec0546651b0976d5030a42_img.jpg b/marked/Rel-16/29_series/29007/ced309874aec0546651b0976d5030a42_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f1933dd8245e353c9373d226a0ee4f028eb5abbd --- /dev/null +++ b/marked/Rel-16/29_series/29007/ced309874aec0546651b0976d5030a42_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ec87845aa09f80ace1c386f2c63bdf0834595702fffc46ddfdd3f97024417c37 +size 15557 diff --git a/marked/Rel-16/29_series/29007/db0c433df107439122051d7b834cd262_img.jpg b/marked/Rel-16/29_series/29007/db0c433df107439122051d7b834cd262_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e047b7128d12b8ac0e4f6184ae9ac97c3459d14e --- /dev/null +++ b/marked/Rel-16/29_series/29007/db0c433df107439122051d7b834cd262_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7952b10f739a28aa99d3f8184baf672557f58b29fe2079ff41dfe9b9f5c82d7d +size 20656 diff --git a/marked/Rel-16/29_series/29007/ddee3e67e0dfc22e25188fa635a19558_img.jpg b/marked/Rel-16/29_series/29007/ddee3e67e0dfc22e25188fa635a19558_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..bfdb8ce2db74e84e12cf7c3f6b30cf98bebbf8b4 --- /dev/null +++ b/marked/Rel-16/29_series/29007/ddee3e67e0dfc22e25188fa635a19558_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3e5cced3bc5d5e4eab944a1ddb89e45e9cd7ddeec8e45d65af15c98b9970fc1e +size 55880 diff --git a/marked/Rel-16/29_series/29007/eb03559a4d92ea9ebd63ea9be663c50a_img.jpg b/marked/Rel-16/29_series/29007/eb03559a4d92ea9ebd63ea9be663c50a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..95e1fa6629d1913f4f8a28aa74f815ed267ad2b1 --- /dev/null +++ b/marked/Rel-16/29_series/29007/eb03559a4d92ea9ebd63ea9be663c50a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9e819df31ad4ff6f5c01037dd1eea3d8b0cc8b4cf6f4754df1650df56466ea33 +size 53187 diff --git a/marked/Rel-16/29_series/29007/f0a97d0d3818a253c1d2a009966081b1_img.jpg b/marked/Rel-16/29_series/29007/f0a97d0d3818a253c1d2a009966081b1_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0ce2cb092b19f3db55bd76582169bef13db61391 --- /dev/null +++ b/marked/Rel-16/29_series/29007/f0a97d0d3818a253c1d2a009966081b1_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0c1b20c190c832b5fb758191bc84e472c36029422110b007795d423d85c6ef2b +size 11709 diff --git a/marked/Rel-16/29_series/29007/f59ced6eaab3181501fc23fdfb52297e_img.jpg b/marked/Rel-16/29_series/29007/f59ced6eaab3181501fc23fdfb52297e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5b4ac8f17ce5be8bedfca89f2e026021ebc5989d --- /dev/null +++ b/marked/Rel-16/29_series/29007/f59ced6eaab3181501fc23fdfb52297e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b312203347f9f2246bc8b705a49744cb9c95b3567011b310a037da4caecaf1cd +size 41721 diff --git a/marked/Rel-16/29_series/29007/raw.md b/marked/Rel-16/29_series/29007/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..3f8c5883da2db62af76ae8ac3c1b4e6ceab0b270 --- /dev/null +++ b/marked/Rel-16/29_series/29007/raw.md @@ -0,0 +1,3807 @@ + + + + +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|-------------------------------------------------------------------------------|----| +| Foreword ..... | 8 | +| 1 Scope..... | 9 | +| 2 References..... | 9 | +| 3 Definitions and abbreviations ..... | 14 | +| 3.1 Definitions..... | 14 | +| 3.2 Abbreviations ..... | 15 | +| 4 Introduction..... | 15 | +| 5 Void..... | 16 | +| 6 Network Characteristics..... | 16 | +| 6.1 Key Characteristics of Networks Concerned ..... | 16 | +| 6.1.1 Characteristics of PLMNs ..... | 16 | +| 6.1.2 Characteristics of PSTNs..... | 16 | +| 6.1.3 Characteristics of ISDN..... | 17 | +| 7 Interworking classifications ..... | 17 | +| 7.1 Service interworking ..... | 17 | +| 7.2 Network interworking ..... | 17 | +| 7.3 Signalling interworking..... | 18 | +| 7.4 Numbering..... | 18 | +| 7.5 Supplementary service interworking..... | 18 | +| 8 Compatibility and subscription checking..... | 18 | +| 9 Interworking to PSTN..... | 19 | +| 9.1 Speech Calls..... | 19 | +| 9.1.1 Interworking indications to PLMN terminal ..... | 19 | +| 9.1.2 Transmission aspects..... | 19 | +| 9.1.3 Generation of In-band Tones and Announcements (PLMN-PSTN) ..... | 19 | +| 9.2 Data Calls..... | 19 | +| 9.2.1 Network interworking mobile originated ..... | 20 | +| 9.2.1.1 Selection of interworking function ..... | 20 | +| 9.2.1.2 Modem Selection..... | 20 | +| 9.2.1.3 Mapping of BC-IE from PLMN to ISUP (or other) ..... | 21 | +| 9.2.2 Network Interworking Mobile terminated PSTN Originated..... | 21 | +| 9.2.2.1 Multi-numbering Scheme ..... | 21 | +| 9.2.2.2 Single-numbering Scheme..... | 23 | +| 9.2.3 Transparent service support..... | 24 | +| 9.2.3.1 Structure of the MSC/IWF for Iu mode..... | 25 | +| 9.2.3.2 Structure of the MSC/IWF for A/Gb mode ..... | 25 | +| 9.2.3.3 Mapping of signalling UE/MSC/IWF to modem interface requirements..... | 25 | +| 9.2.3.4 Establishment of end-to-end terminal synchronizations..... | 26 | +| 9.2.3.4.1 Terminating side (towards the UE)..... | 27 | +| 9.2.3.4.1.1 Traffic channel types TCH/F4.8 and TCH/F9.6 for A/Gb mode ..... | 27 | +| 9.2.3.4.1.2 Traffic channel type TCH/F14.4 for A/Gb mode ..... | 27 | +| 9.2.3.4.2 Transit side (towards the fixed network)..... | 28 | +| 9.2.3.5 Network Independent Clocking (NIC) ..... | 28 | +| 9.2.4 Non-transparent service support..... | 29 | +| 9.2.4.1 Structure of the MSC/IWF for Iu mode..... | 29 | +| 9.2.4.2 Structure of the MSC/IWF for A/Gb mode ..... | 29 | +| 9.2.4.3 Re-constitution of user data ..... | 29 | +| 9.2.4.4 Layer 2 relay functionality..... | 29 | +| 9.2.4.5 In band signalling mapping flow control..... | 30 | +| 9.2.4.5.1 Conditions requiring flow control towards the fixed network ..... | 30 | +| 9.2.4.5.2 Conditions requiring flow control towards the UE ..... | 30 | +| 9.2.4.6 Data buffers..... | 30 | +| 9.2.4.6.1 Transmit buffers (towards UE) ..... | 30 | + +| | | | +|--------------|---------------------------------------------------------------------------------------------------|----| +| 9.2.4.6.2 | Receive buffers (from UE)..... | 31 | +| 9.2.4.7 | Transportation of the Break condition..... | 31 | +| 9.2.4.8 | In band signalling mapping modem status information..... | 31 | +| 9.2.4.9 | Support of out-band flow control..... | 32 | +| 9.2.4.10 | Establishment of end-to-end terminal synchronizations..... | 32 | +| 9.2.4.10.1 | Terminating side (towards the UE)..... | 32 | +| 9.2.4.10.2 | Transit side (towards the fixed network)..... | 32 | +| 9.2.4.11 | Data compression..... | 33 | +| 9.2.4.12 | Service level up and down grading..... | 33 | +| 9.2.5 | DTE/DCE interface (Filtering)..... | 33 | +| 9.3 | Interworking Alternate Speech / Facsimile Group 3 Calls ..... | 34 | +| 9.3.1 | General ..... | 34 | +| 9.3.2 | Mobile originated PSTN terminated calls ..... | 35 | +| 9.3.3 | PSTN originated mobile terminated calls..... | 35 | +| 9.3.4 | BICC network architecture..... | 35 | +| 9.4 | 3G-H.324/M calls over 3,1kHz audio ..... | 35 | +| 9.4.1 | Mobile originated multimedia call ..... | 36 | +| 9.4.1.1 | Call setup ..... | 36 | +| 9.4.1.2 | Fallback to speech after setup..... | 36 | +| 9.4.2 | Mobile terminated multimedia call ..... | 36 | +| 9.4.2.1 | Call setup ..... | 36 | +| 9.4.2.2 | Fallback to speech after setup..... | 37 | +| 9.4.3 | Seamless data rate change ..... | 37 | +| 10 | Interworking to the ISDN ..... | 37 | +| 10.1 | Speech Calls..... | 38 | +| 10.2 | Data Calls..... | 38 | +| 10.2.1 | Network interworking mobile originated ..... | 38 | +| 10.2.2 | Network interworking mobile terminated ..... | 38 | +| 10.2.2.1 | General..... | 38 | +| 10.2.2.2 | Functions in GMSC ..... | 39 | +| 10.2.2.3 | Functions in HLR..... | 39 | +| 10.2.2.4 | Functions in VMSC ..... | 40 | +| 10.2.2.4A | Functions in VLR..... | 41 | +| 10.2.2.5 | Call Flows..... | 43 | +| 10.2.2.6 | Mapping Functions ..... | 44 | +| 10.2.2.7 | Creation of Backup Bearer Capability Information Element ..... | 60 | +| 10.2.3 | Transparent service support..... | 66 | +| 10.2.3.1 | Structure of the MSC/IWF for Iu mode..... | 66 | +| 10.2.3.2 | Structure of the MSC/IWF for A/Gb mode ..... | 66 | +| 10.2.3.3 | Mapping of signalling UE/MSC/IWF to modem or ISDN (V.110) TA-function interface requirements..... | 66 | +| 10.2.3.4 | Establishment of end-to-end terminal synchronizations..... | 67 | +| 10.2.3.4.1 | Terminating side (towards the UE)..... | 68 | +| 10.2.3.4.1.1 | Traffic channel types TCH/F4.8 and TCH/F9.6 in A/Gb mode..... | 68 | +| 10.2.3.4.1.2 | Traffic channel type TCH/F14.4 for A/Gb mode ..... | 68 | +| 10.2.3.4.1.3 | User Plane for Iu mode..... | 68 | +| 10.2.3.4.2 | Transit side (towards the fixed network)..... | 68 | +| 10.2.3.5 | Network independent Clocking (NIC)..... | 69 | +| 10.2.4 | Non-transparent service support..... | 69 | +| 10.2.4.1 | Structure of the MSC/IWF for Iu mode..... | 69 | +| 10.2.4.2 | Structure of the MSC/IWF for A/Gb mode ..... | 69 | +| 10.2.4.3 | Re-constitution of user data ..... | 70 | +| 10.2.4.4 | Layer 2 relay functionality..... | 70 | +| 10.2.4.5 | In band signalling mapping flow control..... | 70 | +| 10.2.4.5.1 | Conditions requiring flow control - if flow control is provided - towards the fixed network . | 71 | +| 10.2.4.5.2 | Conditions requiring flow control towards the UE ..... | 71 | +| 10.2.4.6 | Data buffers..... | 71 | +| 10.2.4.6.1 | Transmit buffers (towards UE) ..... | 71 | +| 10.2.4.6.2 | Receive buffers (from UE)..... | 71 | +| 10.2.4.7 | BREAK Indication..... | 72 | + +| | | | +|---------------|-------------------------------------------------------------------------------------------------|----| +| 10.2.4.8 | Signalling mapping of modem or ISDN (V.110, V.120 or PIAFS) TA-function status information..... | 72 | +| 10.2.4.9 | Support of out-band flow control..... | 72 | +| 10.2.4.10 | Synchronizations..... | 73 | +| 10.2.4.10.1 | V.110 and V.120 Frame synchronizations ..... | 73 | +| 10.2.4.10.2 | RLP Frame start indication ..... | 73 | +| 10.2.4.10.3 | L2R Frame synchronizations ..... | 73 | +| 10.2.4.10.4 | Establishment of end-to-end terminal synchronizations ..... | 73 | +| 10.2.4.10.4.1 | Terminating side (towards the UE) ..... | 73 | +| 10.2.4.10.4.2 | Transit side (towards the fixed network)..... | 73 | +| 10.2.4.11 | Data compression..... | 74 | +| 10.2.4.12 | Additional aspects of V.120 Interworking..... | 74 | +| 10.2.4.12.1 | V.120 Signalling parameters ..... | 74 | +| 10.2.4.12.2 | V.120 Protocol parameters..... | 74 | +| 10.2.4.12.3 | Data compression on the ISDN..... | 74 | +| 10.2.4.12.4 | Use of the V.120 Control State (header extension) octet..... | 75 | +| 10.2.4.13 | Interworking with restricted 64 kbit/s networks ..... | 75 | +| 10.2.4.13.1 | Rate adaptation..... | 75 | +| 10.2.4.13.2 | MSC - ISDN signalling..... | 75 | +| 10.2.4.14 | Service level up and down grading..... | 75 | +| 10.2.4.15 | Interworking in Frame Tunneling Mode ..... | 75 | +| 10.2.4.16 | Additional aspects of PIAFS Interworking..... | 76 | +| 10.2.5 | DTE/DCE interface (Filtering)..... | 76 | +| 10.3 | Interworking Alternate speech facsimile group 3 calls..... | 76 | +| 10.3.1 | Alternate speech data bearer interworking..... | 76 | +| 10.3.1.1 | General..... | 76 | +| 10.3.1.2 | Mobile originated ISDN terminated ..... | 77 | +| 10.3.1.3 | ISDN originated mobile terminated..... | 77 | +| 10.4 | 3G-H.324/M calls over UDI/RDI..... | 77 | +| 10.4.1 | Mobile originated multimedia call ..... | 77 | +| 10.4.1.1 | Call setup ..... | 77 | +| 10.4.1.2 | Fallback after setup..... | 78 | +| 10.4.1.3 | User initiated service change after setup ..... | 78 | +| 10.4.2 | Mobile terminated multimedia call ..... | 78 | +| 10.4.2.1 | Call setup ..... | 78 | +| 10.4.2.2 | User initiated service change after setup ..... | 78 | +| 11 | Interworking between A/Gb mode MSC and Iu mode MSC ..... | 78 | +| 11.0 | Signalling issues..... | 78 | +| 11.0.1 | Loss of BC Information during Handover from A/Gb mode to UTRAN Iu mode..... | 78 | +| 11.0.2 | Handover from UTRAN Iu mode to A/Gb mode..... | 79 | +| 11.0.3 | Loss of BC Information during Handover from A/Gb mode to GERAN Iu mode ..... | 79 | +| 11.0.4 | Handover from GERAN Iu mode to A/Gb mode..... | 79 | +| 11.0.5 | Handover from UTRAN Iu mode to GERAN Iu mode ..... | 79 | +| 11.0.6 | Handover from GERAN Iu mode to UTRAN Iu mode ..... | 80 | +| 11.1 | Handover to A/Gb mode MSC..... | 80 | +| 11.2 | Handover from A/Gb mode MSC to UTRAN Iu mode MSC..... | 80 | +| 11.3 | Handover from A/Gb mode MSC to GERAN Iu mode MSC..... | 81 | +| 11.3.1 | User plane for transparent services..... | 81 | +| 11.3.2 | User plane for non-transparent services ..... | 81 | +| 11.4 | Handover within Iu mode PLMNs..... | 81 | +| 11.5 | Handover for 56kbit/s..... | 82 | +| 11.6 | Void..... | 83 | +| 11a | Transport Protocols ..... | 83 | +| 11a.1 | Core Network ..... | 83 | +| 11a.1.0 | Overview ..... | 83 | +| 11a.1.1 | Void..... | 84 | +| 11a.1.2 | Transport beyond the IWF..... | 84 | +| 11a.1.2.1 | UDI and RDI..... | 84 | +| 11a.1.2.2 | Modem..... | 84 | +| 11a.1.3 | Transport on the access side of the IWF..... | 84 | + +| | | | +|-------------------------------|----------------------------------------------------------------------------------------------------------------|------------| +| 11a.1.3.0 | Inter MSC-Relocation..... | 84 | +| 11a.1.3.0a | Several MGWs controlled by same MSC server ..... | 85 | +| 11a.1.3.1 | Non-Transparent CSD ..... | 86 | +| 11a.1.3.2 | Transparent CSD..... | 88 | +| 11a.2 | NT services..... | 90 | +| 11a.2.1 | Iu interface and Nb interface at access side of IWF in a BICC based CS CN ..... | 90 | +| 11a.2.2 | Nb interface at access side of IWF in a BICC based CS CN for Inter-MSC relocation ..... | 90 | +| 11a.2.3 | Nb interface at network side of IWF in a BICC based CS CN ..... | 90 | +| 11a.2.4 | Nb interface at access side of IWF in a SIP-I based CS CN ..... | 90 | +| 11a.2.5 | Nb interface at network side of IWF in a SIP-I based CS CN ..... | 91 | +| 11a.2.6 | A interface with IP transport ..... | 91 | +| 11a.3 | T services..... | 91 | +| 11a.3.0 | Iu interface..... | 91 | +| 11a.3.0a | Nb interface in BICC based CS CN ..... | 91 | +| 11a.3.1 | Avoidance of delay at RNC..... | 91 | +| 11a.3.2 | Recovery from the loss of ATM cells ..... | 92 | +| 11a.3.3 | A interface with IP transport ..... | 92 | +| 11a.3.4 | Nb interface at access side of IWF in a SIP-I based CS CN ..... | 92 | +| 11a.3.5 | Nb interface at network side of IWF in a SIP-I based CS CN ..... | 92 | +| 12 | Frame Synchronization ..... | 92 | +| 12.1 | Initial frame synchronization ..... | 93 | +| 12.1.1 | Terminating side (towards the UE) ..... | 93 | +| 12.1.2 | Transit side (towards the fixed network)..... | 93 | +| 12.1.2.1 | Interworking to the PSTN..... | 93 | +| 12.1.2.2 | Interworking to the ISDN ..... | 93 | +| 12.2 | Action on loss of frame synchronization..... | 93 | +| 12.2.1 | Loss on the transit side (towards the fixed network)..... | 93 | +| 12.2.2 | Loss on the terminating side (towards the UE) ..... | 93 | +| 13 | Call Clearing ..... | 94 | +| 14 | The A-TRAU Framing Protocols..... | 94 | +| 14.1 | A-TRAU' Protocol ..... | 94 | +| 14.1.1 | Frame layout for the different transparent user rates..... | 94 | +| 14.1.2 | A-TRAU' frame format ..... | 95 | +| 14.2 | A-TRAU'' Protocol ..... | 97 | +| 15 | RTP Payload Type Negotiation for Data Calls within a SIP-I based CS Core Network..... | 99 | +| 15.1 | RTP payload type negotiation at access side of IWF..... | 99 | +| 15.2 | RTP payload type negotiation at network side of IWF ..... | 99 | +| Annex A (informative): | SDLs..... | 100 | +| Annex B (informative): | General mapping of V.24 circuits to channel status bits ..... | 102 | +| Annex C (normative): | RTP payload type for SCUDIF in SIP-I based CS core network .... | 102 | +| C.1 | Scope ..... | 102 | +| C.2 | RTP payload Type definition ..... | 103 | +| C.3 | Describing the RTP payload Type in SDP..... | 103 | +| C.4 | SDP Offer-Answer considerations ..... | 103 | +| C.5 | SDP Example ..... | 103 | +| Annex D (informative): | IANA registration information for RTP payload types for SCUDIF
in SIP-I based CS core network .....
| 104 | +| D.1 | Introduction ..... | 104 | +| D.2 | IANA Registration information ..... | 104 | +| D.2.1 | Media Type Name ..... | 104 | +| D.2.2 | Subtype Name ..... | 104 | +| D.2.3 | Required parameters ..... | 104 | +| D.2.4 | Optional parameters..... | 104 | +| D.2.5 | Encoding considerations..... | 104 | +| D.2.6 | Security considerations..... | 104 | +| D.2.7 | Interoperability considerations ..... | 104 | + +| | | | +|------------------------|-------------------------------------------------|-----| +| D.2.8 | Published specification..... | 104 | +| D.2.9 | Applications which use this media type ..... | 105 | +| D.2.10 | Additional information ..... | 105 | +| D.2.10.1 | Magic number(s)..... | 105 | +| D.2.10.2 | File extension(s)..... | 105 | +| D.2.10.3 | Macintosh File Type Code(s)..... | 105 | +| D.2.10.2 | Object Identifier(s) or OID(s) ..... | 105 | +| D.2.11 | Intended usage ..... | 105 | +| D.2.12 | Other Information/General Comment ..... | 105 | +| D.2.13 | Person to contact for further information ..... | 105 | +| Annex E (informative): | Change history..... | 106 | + +# --- Foreword + +This Technical Specification (TS) has been produced by the 3rd Generation Partnership Project (3GPP). + +The present document identifies the Mobile-services Switching Centre/Interworking functions (MSC/IWFs) and requirements to support interworking between: + +- i) PLMN and PSTN; +- ii) PLMN and ISDN; + +within the 3GPP system. + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 1 Scope + +The present document identifies the Mobile-services Switching Centre/Interworking Functions (MSC/IWFs) and requirements to support interworking between: + +- a) PLMN and PSTN; +- b) PLMN and ISDN; + +for circuit switched services in the PLMN. It is not possible to treat ISDN and PSTN as one type of network, even when both ISDN and PSTN subscribers are served by the same exchange because of the limitations of the PSTN subscribers access i.e. analogue connection without D-channel signalling. + +Within the present document, the requirements for voice and non-voice (data) calls are considered separately. + +From R99 onwards the following services are no longer required by a PLMN: + +- the dual Bearer Services "alternate speech/data" (BS 61) and "speech followed by data" (BS 81); +- the dedicated services for PAD (BS 4x) and Packet access (BS 5x); +- the single asynchronous and synchronous Bearer Services (BS 21..26, BS 31..34). + +From Rel-4 onwards the following services are no longer required by a PLMN: + +- the synchronous Bearer Service non-transparent (BS 30 NT); +- the Basic Packet access; +- Non-transparent facsimile (TS 61/62 NT) for the A/Gb mode and GERAN Iu mode. + +If a PLMN still provides these services it shall fulfil the specification of former releases. + +The present document is valid for a PLMN in A/Gb mode as well as in Iu mode. If text applies only for one of these systems it is explicitly mentioned by using the terms "A/Gb mode" and "Iu mode". If text applies to both of the systems, but a distinction between the ISDN/PSTN and the PLMN is necessary, the term "PLMN" is used. + +NOTE: The Gb interface does not play any role in the scope of the present document although the term "A/Gb mode" is used. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] ITU-T Recommendation G.711 (11/88): "Pulse Code Modulation (PCM) of voice frequencies". +- [2] ITU-T Recommendation I.460 (02/99): "Multiplexing, rate adaption and support of existing interfaces". +- [3] ITU-T Recommendation I.464 (02/99): "Multiplexing, rate adaption and support of existing interfaces for restricted 64 kbit/s transfer capability". +- [4] ITU-T Recommendation Q.922 (1992): "DSS 1 Data link layer: ISDN data link layer specification for frame mode bearer services". + +- [5] ITU-T Recommendation Q.931 (05/98): "DSS 1 - ISDN user network interface layer 3 specification for basic call control". +- [6] ITU-T Recommendation V.22 (11/88): "1200 bits per second duplex modem standardized for use in the general switched telephone network and on point-to-point 2-wire leased telephone-type circuits". +- [7] ITU-T Recommendation V.24: "List of definitions for interchange circuits between data terminal equipment (DTE) and data circuit-terminating equipment (DCE)". +- [8] ITU-T Recommendation V.25 (10/96): "Automatic answering equipment and general procedures for automatic calling equipment on the general switched telephone network including procedures for disabling of echo control devices for both manually and automatically established calls". +- [9] ITU-T Recommendation V.32 (03/93): "A family of 2-wire, duplex modems operating at data signalling rates of up to 9600 bit/s for use on the general switched telephone network and on leased telephone-type circuits". +- [10] ITU-T Recommendation V.32bis (02/91): "A duplex modem operating at data signalling rates of up to 14 400 bit/s for use on the general switched telephone network and on leased point-to-point 2-wire telephone-type circuits". +- [11] ITU-T Recommendation V.34 (02/98): "A modem operating at data signalling rates of up to 33 600 bit/s for use on the general switched telephone network and on leased point-to-point 2-wire telephone-type circuits". +- [12] ITU-T Recommendation V.42 (03/02): "Error-correcting procedures for DCEs using asynchronous-to-synchronous conversion". +- [13] ITU-T Recommendation V.42bis (01/90): "Data compression procedures for Data Circuit Terminating Equipment (DCE) using error correction procedures". +- [14] ITU-T Recommendation V.90 (09/98): "A digital modem and analogue modem pair for use on the Public Switched Telephone Network (PSTN) at data signalling rates of up to 56 000 bit/s downstream and up to 33 600 bit/s upstream". +- [15] ITU-T Recommendation V.110: "Support by an ISDN of data terminal equipments with V-Series type interfaces". +- [16] ITU-T Recommendation V.120 (10/96): "Support by an ISDN of data terminal equipment with V-Series type interfaces with provision for statistical multiplexing". +- [17] ETSI ETR 018 (11/95): "Integrated Services Digital Network (ISDN); Application of the Bearer Capability (BC), High Layer Compatibility (HLC) and Low Layer Compatibility (LLC) information elements by terminals supporting ISDN services". +- [18] ETSI ETS 300 102-1 Edition 1 (1990): "Integrated Services Digital Network (ISDN); User-network interface layer 3; Specifications for basic call control". +- [19] ETSI EN 300 403-1 V1.2.2 (1998-04): "Integrated Services Digital Network (ISDN); Digital Subscriber Signalling System No. one (DSS1) protocol; Signalling network layer for circuit-mode basic call control; Part 1: Protocol specification". +- [20] 3GPP TS 41.103: "GSM Release 5 specifications". +- [21] 3GPP TR 21.905: "Vocabulary for 3GPP specifications" +- [22] 3GPP TS 22.001: "Principles of circuit telecommunication services supported by a Public Land Mobile Network (PLMN)". +- [23] 3GPP TS 22.003: "Circuit teleservices supported by a Public Land Mobile Network (PLMN)". +- [24] 3GPP TS 43.010: "GSM Public Land Mobile Network (PLMN) connection types ". +- [25] 3GPP TS 43.045: "Technical realization of facsimile group 3 service - transparent". + +- [26] 3GPP TS 43.050: "Transmission planning aspects of the speech service in the GSM Public Land Mobile Network (PLMN) system". +- [27] 3GPP TS 44.021: "Rate adaption on the Mobile Station - Base Station System (MS - BSS) interface". +- [28] 3GPP TS 48.020: "Rate adaption on the Base Station System - Mobile-services Switching Centre (BSS - MSC) interface". +- [29] 3GPP TS 48.060: "Inband control of remote transcoders and rate adaptors for full rate traffic channels". +- [30] 3GPP TS 09.02 : "Mobile Application Part (MAP) specification GSM Phase 1". +- [31] 3GPP TS 49.003: "Signalling requirements on interworking between the Integrated Services Digital Network (ISDN) or Public Switched Telephone Network (PSTN) and the Public Land Mobile Network (PLMN)". +- [32] 3GPP TS 21.103: "3rd Generation mobile system Release 5 specifications ". +- [33] 3GPP TS 22.002: "Circuit Bearer Services (BS) supported by a Public Land Mobile Network (PLMN)". +- [34] 3GPP TS 22.004: "General on supplementary services". +- [35] 3GPP TS 23.003: "Numbering, addressing and identification". +- [36] 3GPP TS 23.008: "Organization of subscriber data". +- [37] 3GPP TS 23.011: "Technical realization of supplementary services". +- [38] 3GPP TS 23.146: "Technical realization of facsimile group 3 non-transparent". +- [39] Void. +- [40] 3GPP TS 24.008: "Mobile radio interface layer 3 specification; Core network protocols; Stage 3". +- [41] 3GPP TS 24.022: "Radio Link Protocol (RLP) for circuit switched bearer and teleservices ". +- [42] 3GPP TS 25.415: "UTRAN Iu interface user plane protocols". +- [43] 3GPP TS 27.001: "General on Terminal Adaptation Functions (TAF) for Mobile Stations (MS)". +- [44] 3GPP TS 27.002: "Terminal Adaptation Functions (TAF) for services using Asynchronous bearer capabilities". +- [45] 3GPP TS 27.003: "Terminal Adaptation Functions (TAF) for services using Synchronous bearer capabilities". +- [46] 3GPP TS 29.002: "Mobile Application Part (MAP) specification". +- [47] 3GPP TS 24.002: "GSM - UMTS Public Land Mobile Network (PLMN) access reference configuration " +- [48] ISO/IEC 3309 (1993): "Information technology - Telecommunications and information exchange between systems - High-level Data Link Control (HDLC) procedures - Frame structure". +- [49] IETF RFC 1662: "PPP in HDLC-like framing". +- [50] Mobile Internet Access Forum: "PIAFS Specification Ver. 1.1, 2.1". +- [51] ITU-T Recommendation V.8: "Procedures for starting sessions of data transmission over the public switched telephone network". +- [52] 3GPP TS 26.111: "Codec for circuit switched multimedia telephony service; Modifications to H.324". + +- [53] Void +- [54] ITU-T Recommendation H.223 (03/96): "Multiplexing protocol for low bit rate multimedia communication". +- [55] ITU-T Recommendation H.223 (Annex A) (02/98): "Multiplexing protocol for low bit rate multimedia communication over low error-prone channels". +- [56] ITU-T Recommendation H.223 (Annex B) (02/98): "Multiplexing protocol for low bit rate multimedia communication over moderate error-prone channels". +- [57] ITU-T Recommendation H.223 (Annex C) (02/98): "Multiplexing protocol for low bit rate multimedia communication over highly error-prone channels". +- [58] ITU-T Recommendation H.324: "Terminal for low bit-rate multimedia communication". +- [59] ITU-T Recommendation H.221: "Frame structure for a 64 to 1920 kbit/s channel in audiovisual teleservices". +- [60] ITU-T Recommendation H.242: "System for establishing communication between audiovisual terminals using digital channels up to 2 Mbit/s". +- [61] ITU-T Recommendation H.245: "Control protocol for multimedia communication". +- [62] ITU-T Recommendation V.8 bis: "Procedures for the identification and selection of common modes of operation between data circuit-terminating equipments (DCEs) and between data terminal equipments (DTEs) over the public switched telephone network and on leased point-to-point telephone-type circuits". +- [63] ITU-T Recommendation V.21 (11/88): "300 bits per second duplex modem standardized for use in the general switched telephone network". +- [64] ITU-T Recommendation V.22bis (1988): "2400 bits per second duplex modem using the frequency division technique standardized for use on the general switched telephone network and on point-to-point 2-wire leased telephone-type circuits". +- [65] ITU-T Recommendation V.23 (11/88): "600/1200-baud modem standardized for use in the general switched telephone network". +- [66] ITU-T Recommendation V.26 (11/88): "2400 bits per second modem standardized for use on 4-wire leased telephone-type circuits". +- [67] ITU-T Recommendation V.26 bis (11/88): "2400/1200 bits per second modem standardized for use in the general switched telephone network". +- [68] ITU-T Recommendation V.26 ter (11/88): "2400 bits per second duplex modem using the echo cancellation technique standardized for use on the general switched telephone network and on point-to-point 2-wire leased telephone-type circuits". +- [69] ITU-T Recommendation V.27 (11/88): "4800 bits per second modem with manual equalizer standardized for use on leased telephone-type circuits". +- [70] ITU-T Recommendation V.27 bis (11/88): "4800/2400 bits per second modem with automatic equalizer standardized for use on leased telephone-type circuits". +- [71] ITU-T Recommendation V.29 (11/88): "9 600 bits per second modem standardized for use on point-to-point 4-wire leased telephone-type circuits". +- [72] ITU-T Recommendation Q.921 (09/97): "ISDN user-network interface - Data link layer specification". +- [73] ITU-T Recommendation X.21 (09/92): "Interface between Data Terminal Equipment (DTE) and Data Circuit-terminating Equipment (DCE) for synchronous operation on public data networks". + +- [74] ITU-T Recommendation X.25 (10/96): "Interface between Data Terminal Equipment (DTE) and Data Circuit - terminating Equipment (DCE) for terminals operating in the packet mode and connected to public data networks by dedicated circuit". +- [75] ITU-T Recommendation X.28 (12/97): "DTE/DCE interface for a start-stop mode Data Terminal Equipment accessing the Packet Assembly/Disassembly facility (PAD) in a public data network situated in the same country". +- [76] ITU-T Recommendation X.31 (11/95): "Support of packet mode terminal equipment by an ISDN". +- [77] ITU-T Recommendation X.75 (10/96): "Packet-switched signalling system between public networks providing data transmission services". +- [78] ISO 2110 (1989): "Information technology - Data communication - 25-pole DTE/DCE interface connector and contact number assignments". +- [79] ISO/IEC 6429 (1992): "Information technology - Control functions for coded character sets". +- [80] 3GPP TS 29.415: "Core Network Nb Interface User Plane Protocols" +- [81] ITU-T Recommendation I.366.2: "AAL type 2 service specific convergence sublayer for trunking". +- [82] 3GPP TS 29.232: "Media Gateway Controller (MGC); Media Gateway (MGW) interface; Stage 3" +- [83] 3GPP TS 23.172: "Technical Realisation of the Circuit Switched (CS) multimedia service; UDI/RDI fallback and service modification; Stage 2" +- [84] ITU-T Recommendation E.163 (11/88): "Numbering plan for the international telephone service". +- [85] ITU-T Recommendation E.164 (02/05): "The international public telecommunication numbering plan". +- [86] 3GPP TS 27.001: "General on Terminal Adaption Functions (TAF) for Mobile Station (MS)". +- [87] ITU-T Recommendation I.363.2: "B-ISDN ATM Adaptation Layer specification : Type 2 AAL". +- [88] ITU-T Recommendation I.366.2: "AAL type 2 service specific convergence sublayer for narrow-band services". +- [89] ITU-T Recommendation Q.2630.1 (12/99): "AAL type 2 signalling protocol (Capability Set 1)". +- [90] 3GPP TS 23.202: "Circuit switched data bearer services". +- [91] 3GPP TS 23.153: "Out of band transcoder control; Stage 2". +- [92] IETF RFC 4040: "RTP Payload Format for a 64 kbit/s Transparent Call " +- [93] 3GPP TS 29.414: "Core network Nb data transport and transport signalling ". +- [94] IETF RFC 2198: "RTP Payload for Redundant Audio Data". +- [95] IETF RFC 3551: "RTP Profile for Audio and Video Conferences with Minimal Control". +- [96] ITU-T Recommendation T.38: "Procedures for real-time Group 3 facsimile communication over IP networks" +- [97] IETF RFC 3362: "Real-time Facsimile (T.38) - image/t38 MIME Sub-type Registration" +- [98] IETF RFC 4566: "SDP: Session Description Protocol". +- [99] 3GPP TS 23.231: "SIP-I based Circuit Switched Core Network; Stage 2" + +# 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the following terms and definitions apply: + +**bearer capability information:** specific information defining the lower layer characteristics required within the network. + +**low layer compatibility information:** information defining the lower layer characteristics of the terminal. + +**high layer compatibility information:** information defining the higher layer characteristics of the terminal. + +**compatibility information:** this term subsumes the entirety of Bearer Capability, Low Layer Compatibility, High Layer Compatibility, Progress Indicator and Address Information conveyed out-of-band prior to call establishment for the support of compatibility checking and terminal/function/service selection at the ISDN-type user-network interface. + +**protocol identifier:** information defining the specific protocols utilized for the support of data transfer by a terminal. + +**progress indicator:** information supplied to indicate to the terminal that network interworking has taken place. + +**out-of-band parameter exchange:** information exchanged via an associated or non-associated signalling link e.g. SS No 7. + +**PSTN:** subscriber to network interface supports only analogue terminals. + +**ISDN:** subscriber to network interface supports digital or analogue terminals, plus a standardized user to network associated signalling system and a standardized internetwork signalling system. + +**autobauding type 1:** this information element value may be contained in the setup or call confirm messages from the UE in association with a non transparent data service. This implies that the MSC/IWF may select any speed and modem type according to what it can negotiate with the remote modem on the PSTN/ISDN. The parameters User Rate and FNUR (Fixed Network User Rate), if present, has no meaning when Modem Type is autobauding type 1. + +**Multi self selecting speed modem:** this term applies to V series modems capable of handling one or more lower speeds as a fall back position. When such a modem is requested in the call setup or call confirm message from the UE in association with a non transparent service, the MSC/IWF may select any of the speeds supported according to the negotiation with the remote modem on the PSTN/ISDN. The parameters User Rate and FNUR (Fixed Network User Rate), if present, has no meaning when Modem Type is autobauding type 1. + +**Unrestricted 64 kbit/s network:** a digital network which has 64 kbit/s octet-structured Information Transfer Capability (ITC) with no restrictions on the contents of each octet. + +**restricted 64 kbit/s network:** ITU-T Recommendation I.464 defines "restricted 64 kbit/s transfer capability" as "64 kbit/s octet-structured capability with the exception that an all-zero octet is not permitted". In the present document, the term "restricted 64 kbit/s network" refers not only to networks with the ITU-T Recommendation I.464 restriction but also to those in which the 8th bit of each octet is unusable for data transmission. + +**directly connected restricted 64 kbit/s network:** restricted 64 kbit/s network which is connected directly to the MSC/IWF. + +**indirectly connected restricted 64 kbit/s network:** restricted 64 kbit/s network which is connected to the MSC/IWF via an unrestricted 64 kbit/s network. + +**EDGE channel:** general term referring to channels based on 8PSK modulation; i.e. TCH/F28.8, TCH/F32.0, and TCH/F43.2. + +**A/Gb mode:** a system or a subsystem operates in A/Gb mode if an A or Gb interface is used between the radio access network and the core network. + +**Iu mode:** a system or a subsystem operates in Iu mode if an Iu-CS or Iu-PS interface is used between the radio access network and the core network. It operates in UTRAN Iu mode if UTRAN is used as radio access network. It operates in GERAN Iu mode if GERAN is used as radio access network. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 and the following apply: + +| | | +|---------|-------------------------------------------------| +| ADPCM | Adaptive Differential Pulse Coded Modulation | +| BS | Bearer Service | +| DP | Dial Pulse | +| DSS1 | Digital Subscriber Signalling 1 | +| FTM | Frame Tunnelling Mode | +| ITC | Information Transfer Capability | +| LE | Local Exchange | +| NT | Network Termination | +| NT | non-transparent | +| PABX | Private Automatic Branch Exchange | +| PIAFS | PHS Internet Access Forum Standard | +| PPP | Point to Point Protocol | +| SPC | Stored Program Control | +| SS No.7 | Signalling System No.7 | +| T | transparent | +| TE | Terminal Equipment | +| TA | Terminal Adaptor | +| TS | Teleservice | +| TS | Technical Specification | +| TUP | Telephone User Part (of Signalling System No.7) | +| UNI | User Network Interface | + +# --- 4 Introduction + +Since the numbering plan for the ISDN era (E.164) includes the numbering plan for the telephone network (E.163), it is not possible to distinguish by the number whether a given subscriber is a PSTN or ISDN subscriber. Further, in some countries both PSTN and ISDN subscribers will be connected to the same exchange, so the only difference for this type of combined network will be in the nature of the customer access. In the present document a PSTN is considered to support only an analogue interface towards the subscriber. An ISDN shall be considered to support digital interface towards the subscriber. In addition, the ISDN is considered to support a standardized outband signalling protocol both between the subscriber and the network and within the network, i.e. DSS1 and ISUP, thus enabling the generation and transport of Compatibility Information for compatibility checking and terminal/function/service selection at the user-network interface as well as for MSC/IWF selection. + +There now exist networks which do not fall into either of these categories in that they provide for digital connectivity from subscriber to subscriber through the network. The subscribers have access to a wide range of services by a limited set of standard multi-purpose user network interfaces. However, these networks do not support the standardized inter-exchange signalling protocol throughout, in that they are e.g. using TUP or National User Part (NUP). These types of network support 64 kbit/s connections, so in service support are comparable to ISDN, however, the signalling system provided may not support transport of all Compatibility Information allowed for in the standardized ISDN signalling. The present document will therefore identify interworking to PSTN and ISDN on the principle of the network characteristics as identified in the previous paragraph. The aforementioned existing networks then constitute one particular case in the ISDN interworking scenarios. These cases will be itemized when the implication of the various degrees of exhaustiveness of the Compatibility Information - delivered via the ISDN - used for deducting a PLMN Basic Service needs to be set forth. + +When two dissimilar networks are required to interwork in order to support a communication between two subscribers, one on each network, a number of Interworking Functions (MSC/IWFs) are required to support the communication. Some of these are related to the differences in signalling and are dealt with in 3GPP TS 49.003. + +Examples of other aspects of interworking are: + +- the need or otherwise of echo control devices; +- the need or otherwise of modem pools and network-based rate adaptation. + +For the purposes of determining the required MSC/IWFs, it is necessary, however, to consider separately each type of interworking (i.e. PLMN-ISDN and PLMN-PSTN) since, in the worst case, "PSTN" could refer to an essentially analogue network with electromechanical switching not controlled by software and without common-channel signalling. + +Some facilities associated with alternate speech and facsimile group 3 may not be available with version 1 of the MAP (3GPP TS 09.02). Version 1 of the Mobile Application Part (MAP) does not support in-call modification and channel mode modification following an inter-MSC handover. + +# 5 Void + +# 6 Network Characteristics + +## 6.1 Key Characteristics of Networks Concerned + +**Table 1: Key Characteristics of Networks Concerned** + +| Characteristic | PLMN | ISDN | PSTN | +|-----------------------------------|------------------------------------------------------------------|---------------------------------------------------------|------------------------------------------------------------------------| +| Subscriber Interface | Digital | Digital | Analogue | +| User-network signalling | 3GPP TS 24.008 | DSS1, other UNIs | loop-disconnect and DTMF | +| User-terminal equipment supported | see 3GPP TS 24.002 | Digital TE (ISDN NT, TE1 or TE2+TA)
see e.g. 1.411 | Analogue TE (e.g. dial pulse telephones PABXs modern equipped DTEs) | +| Inter-exchange signalling | SS No.7 ISUP
TUP+, MAP | SS No.7 ISUP
TUP+, TUP, NUP | Channel associated (e.g. R2, No.4, No.5) or common channel (e.g. No.6) | +| Transmission facilities | Digital | Digital | Analogue | +| Exchange types | Digital | Digital | Analogue/digital | +| Information transfer mode | Circuit | Circuit | Circuit | +| Information transfer capability | Speech, digital unrestricted, alternate speech/ group 3 fax etc. | Speech, digital unrestricted, 3,1 kHz audio, video etc. | 3,1 kHz audio (voice/voice- band data) | + +### 6.1.1 Characteristics of PLMNs + +The PLMN is fully defined in the Technical Specifications summarised in 3GPP TS 41.003 for a 2nd generation PLMN (A/Gb mode) or in 3GPP TS 21.103 for a 3rd generation PLMN (Iu mode). + +### 6.1.2 Characteristics of PSTNs + +Because of the efforts at an early stage to standardize ISDNs in different countries, the differences between any two ISDNs will be small compared with the differences between PSTNs, which have evolved in different ways in different countries. In some cases the evolution has occurred over many decades, and therefore each PSTN is distinct, and for a recommendation on interworking, it is necessary to make certain assumptions about a generalized PSTN. + +Whilst the key characteristics of PSTNs are given in table 1 above, the specific MSC/IWFs needed to allow interworking between a PLMN and a PSTN will depend on the nature of the PSTN concerned. + +Table 2 gives a number of categories that can be used to classify PSTNs and a number of possibilities within each category. + +**Table 2: Characteristics of PSTNs** + +| Category | Possibilities within Category | +|------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------| +| Type of subscriber signalling | a) PSTN with loop disconnect subscriber signalling (10 pps)
b) PSTN with DTMF subscriber signalling | +| Type of interexchange signalling | a) PSTN with channel-associated signalling
b) PSTN with common-channel signalling | +| Type of interexchange transmission | a) Analogue
b) Digital | +| Type of exchange switching | a) PSTN with electro-mechanical switching
b) PSTN with electronic (non-digital) switching
c) PSTN with electronic digital switching | +| Type of exchange control | a) Non-SPC
b) SPC | +| NOTE: | Under each category, it is possible that a PSTN will have a combination of the possibilities rather than only one. | + +### 6.1.3 Characteristics of ISDN + +For the "standardized ISDN" in principle taken into account here, these are defined in the ETS/ITU-T-series. + +# --- 7 Interworking classifications + +## 7.1 Service interworking + +Service interworking is required when the Teleservices at the calling and called terminals are different. No service interworking, except for facsimile group 3 (Teleservice 61 or 62 interworking with standard facsimile group 3 service), has been identified as a requirement of the PLMN system for PSTN/ISDN network based services. + +## 7.2 Network interworking + +Network interworking is required whenever a PLMN and a non-PLMN together are involved to provide an end to end connection and may be required in instances of PLMN to PLMN connections. + +The concept of Bearer Services was developed for the ISDN and has been extended to the PLMN. A bearer service is defined (in 3GPP TS 22.001) as. + +A type of telecommunication service that provides the capability for the transmission of signals between user-network interfaces. + +Bearer services are described by a number of attributes, where an attribute is defined as a specified characteristic of an object or element whose values distinguish that object or element from others. + +For the purpose of the present document, a PSTN is assumed to provide a bearer service which equates to an ISDN 3,1 kHz audio bearer service. + +Refer to 3GPP TS 22.002 for complete list of bearer services. Refer to 3GPP TS 24.008 for coding of Bearer Capabilities. Refer to 3GPP TS 27.001 for the allowed combinations of parameter value settings. + +**Table 3: Bearer Service Interworking** + +| Bearer service category in PLMN | Bearer Service in PLMN | Bearer service in ISDN | Service in PSTN | +|---------------------------------------------------------------------------------------------------|-------------------------------|-----------------------------------------------|---------------------------| +| Circuit mode unstructured with unrestricted digital capability
Transparent and Non-transparent | Asynchronous Data general | Cct mode structured
64 kbit/s unrestricted | Not Applicable | +| Circuit mode unstructured with unrestricted digital capability
Transparent | Synchronous Data general | | | +| 3,1 kHz Audio Ex PLMN
Transparent and Non-transparent | Asynchronous Data general | Cct Mode
3,1 kHz Audio | Cct Mode
3,1 kHz Audio | +| 3,1 kHz Audio Ex PLMN
Transparent | Synchronous Data general | | | + +**Table 4: Network interworking of Teleservices** + +| Teleservice in PLMN | Lower layer capabilities addressed in the PLMN Bearer Capabilities IE | Bearer service in ISDN | Service in PSTN | +|------------------------------------|------------------------------------------------------------------------------------------------------------|-------------------------------|------------------------| +| Telephony | Unstructured with speech capability | Speech or Cct mode | Cct Mode | +| Emergency calls | Unstructured with speech capability | 3,1 kHz audio | 3,1 kHz audio | +| Alternate speech/facsimile group 3 | Data Cct duplex synchronous (A/Gb mode) / asynchronous (UTRAN Iu mode) access alternate speech group 3 fax | Cct mode 3,1 kHz audio | Cct mode 3,1 kHz audio | +| Automatic Facsimile group 3 | Data Cct duplex synchronous (A/Gb mode) / asynchronous (UTRAN Iu mode) access group 3 fax | Cct mode 3,1 kHz audio | | + +This table does not identify any relationship between Teleservices in the PLMN with those in the ISDN/PSTN, it is merely to identify the interworking of the lower network layers of that teleservice with the network layers i.e. bearer service in the ISDN/PSTN. + +## 7.3 Signalling interworking + +See 3GPP TS 49.003[31]. + +## 7.4 Numbering + +See 3GPP TS 23.003[35] + +## 7.5 Supplementary service interworking + +For general aspects of supplementary services refer to 3GPP TS 22.004[34] and 23.011[37]. + +Not every supplementary service may be used in combination with each basic service. The applicability of each supplementary service for a basic service is defined in 3GPP TS 22.004[34]. + +# 8 Compatibility and subscription checking + +Compatibility checking is carried out on the following items: + +- Low layer compatibility - utilizing low layer compatibility and bearer capability information elements. +- High layer compatibility - utilizing high layer compatibility information element. + +The use of the progress indicator for compatibility checking is outside the scope of the present document. + +Indication of compatibility requirements is carried out as described in subclauses 9.2.2 and 10.2.2. + +For subscription checking, relevant for the interworking described in clauses 9 and 10 of the present document, refer to 3GPP TS 22.001. + +# 9 Interworking to PSTN + +## 9.1 Speech Calls + +### 9.1.1 Interworking indications to PLMN terminal + +An indication to inform the PLMN terminal that: + +- i) instead of receiving out-of-band indications for certain types of failure conditions, a tone or announcement will be received in-band from the PSTN. +- ii) the available compatibility information will be not exhaustive for deducing a PLMN Basic Service and there will be a limitation on address - the terminal may be required to accept the call on the basis of indicating its compatibility requirements. +- iii) (if a DTE) in-band handshaking signals should be anticipated. + +### 9.1.2 Transmission aspects + +Includes control of Speech Processing and Echo Control Devices, see 3GPP TS 43.050. + +### 9.1.3 Generation of In-band Tones and Announcements (PLMN-PSTN) + +In-band tones and announcements shall be provided for all speech and 3,1 kHz audio bearer services between a PLMN and a PSTN. + +## 9.2 Data Calls + +Low Layer Compatibility Checking on the received PLMN bearer capability information element will be carried out by the MSC/IWF to check if the call setup is compatible to the bearer service (3,1 kHz audio) provided by a PSTN and to the IWFs provided by the PLMN. + +In case the call setup does not conform to these requirements (e.g. an information transfer capability value "unrestricted digital information" is requested), the call shall fail with an error cause indicating that the network is unable to support the service requested. + +As well as compatibility checking subscription checking shall be performed. If the subscription check fails the call setup shall be rejected. + +For the case where the UE offers negotiable values in the PLMN bearer capability information element (e.g. both transparent and non-transparent connection element) refer to the definitions specified in 3GPP TS 27.001. + +For interworking of data calls between a PLMN and a PSTN a modem will be utilized to provide the interworking function. + +![Diagram of PLMN PSTN interworking for circuit switched calls. The diagram shows a sequence of components: a triangle labeled 'TE' connected to a rectangle labeled 'MT'. 'MT' is connected to a large oval labeled 'PLMN'. Inside the 'PLMN' oval, there is a rectangle labeled 'RA MODEM' and 'IWF' below it. The 'RA MODEM' is connected to an oval labeled 'PSTN'. The 'PSTN' oval is connected to a rectangle labeled 'MODEM'. Finally, the 'MODEM' is connected to a triangle labeled 'V.series'.](db0c433df107439122051d7b834cd262_img.jpg) + +Diagram of PLMN PSTN interworking for circuit switched calls. The diagram shows a sequence of components: a triangle labeled 'TE' connected to a rectangle labeled 'MT'. 'MT' is connected to a large oval labeled 'PLMN'. Inside the 'PLMN' oval, there is a rectangle labeled 'RA MODEM' and 'IWF' below it. The 'RA MODEM' is connected to an oval labeled 'PSTN'. The 'PSTN' oval is connected to a rectangle labeled 'MODEM'. Finally, the 'MODEM' is connected to a triangle labeled 'V.series'. + +Figure 1: PLMN PSTN interworking for circuit switched calls + +### 9.2.1 Network interworking mobile originated + +#### 9.2.1.1 Selection of interworking function + +The interworking function will need to negotiate with the user to establish the appropriate modem selection e.g. data rate, modulation scheme, etc. In addition, it will also be required to convert the signalling format, from a combination of out of band and in band, to that suitable for controlling the modem and the autocalling line procedure function where applicable. It is assumed that the interworking function and modems will be associated with each MSC. + +For a data call originated by a circuit mode data terminal on the PLMN, the modem selection is done by using the elements "modem type" and "other modem type" in the bearer capability (PLMN-BC) of the call set-up message. + +In addition, other elements of the call setup will indicate the user rate, etc. to be used via that modem. The use of this information however means that the network is only able to select a modem from the modem pool which conforms to the speed which the terminal is utilizing at the DTE/DCE interface at the UE (e.g. V.22 for 1 200 bps). The exception to this is where the user has selected the non transparent service in which case either an autobauding or multi self selecting speed modem (e.g. V.32) may be used. + +If in A/Gb or GERAN Iu mode the PLMN-BC(s) received with the set-up message indicated a multislot, 14.4 kbit/s, or EDGE-operation (refer to 3GPP TS 27.001) and the network does not support any of the required such services, the PLMN-BC(s) sent with the call proceeding message shall not contain the "fixed network user rate", "other modem type" and "user initiated modification indicator" parameters - the MSC shall discard the multislot, 14.4 kbit/s and EDGE-related parameters and use the fall-back bearer service indicated by the remaining parameters of the PLMN-BS(s) on a singleslot configuration (refer to 3GPP TS 48.020 and 3GPP TS 44.021) on the MSC/IWF-RAN link. The MSC/IWF shall modify the relevant parameters in a possibly present LLC accordingly. + +If the MSC supports in A/Gb or GERAN Iu mode the multislot, 14.4 kbit/s, or EDGE-operation or if the MSC supports UTRAN Iu mode, the PLMN-BC(s) shall include the "fixed network user rate", "other modem type" and if applicable the "user initiated modification indicator" parameters of the call proceeding message if these parameters were present in the call set-up message received from the UE. In A/Gb or GERAN Iu mode the MSC shall apply on the MSC/IWF-RAN link a singleslot or multislot configuration according to the rules defined in 3GPP TS 44.021, 3GPP TS 48.020 and 3GPP TS 24.022. In case the UE signals an ACC containing TCH/F4.8 only and the network does not support TCH/F4.8 channel coding, then the MSC may act as if TCH/F9.6 were included in the ACC. + +If in A/Gb or GERAN Iu mode the PLMN-BC(s) received with the set-up message did not indicate a multislot, 14.4 kbit/s or EDGE-operation, the MSC shall not include the "fixed network user rate", "other modem type" and "user initiated modification indicator" parameters in the PLMN-BC(s) of the call proceeding message - the MSC shall use a singleslot configuration on the MSC/IWF-RAN link. + +The MSC may negotiate parameters with the UE according to the rules defined in 3GPP TS 27.001. The MSC/IWF shall modify the relevant parameters in a possibly present LLC accordingly. + +#### 9.2.1.2 Modem Selection + +In general terms the indication of the bearer capability parameter "Information Transfer Capability" will be utilized in the call set-up message to determine when the modem should be selected in the call. + +In case of single calls, the modem function shall operate in the calling mode in case of mobile originated calls and in the answering mode in case of mobile terminated calls. + +In case of dual data calls (alternate speech/facsimile group 3) the operation mode of the modem (working in calling or answering mode) depend on the initial call setup direction and on the optional parameter "Reverse Call Setup Direction" information element of the MODIFY message. If this information element is omitted the direction is derived from the initial call setup direction, i.e. the mode is the same as in case of single calls. + +For the attribute value "3,1 kHz audio Ex PLMN" and "facsimile group 3", the modem will be selected immediately. The line procedure according to ITU-T Recommendation V.25 will then be carried out using the appropriate modem functions. + +For the Teleservice 61 "Alternate speech/facsimile group 3", (if speech is selected as the first service), the modem is made available but not selected until the subscriber indicates the change of service request (see subclause 9.3). + +For "alternate speech/facsimile group 3" calls refer to 3GPP TS 43.045 (A/Gb mode) and 3GPP TS 23.146 (UTRAN Iu mode). + +#### 9.2.1.3 Mapping of BC-IE from PLMN to ISUP (or other) + +As it cannot be determined from the called address whether the distant network is a PSTN or an ISDN the same mapping takes place as for ISDN calls (see table 7A), if ISDN signalling is used between different MSCs (e.g. on the link VMSC - GMSC). + +### 9.2.2 Network Interworking Mobile terminated PSTN Originated + +This subclause describes the interworking of calls where the calling subscriber cannot generate or communicate Compatibility Information exhaustive for deducing a PLMN Basic Service to a PLMN (gateway MSC/interrogating node) because of lack of ISDN signalling capability. Thus the HLR is relieved from any compatibility checking for such calls. + +Two methods of allocating UE International ISDN Numbers (MSISDNs) are allowed: Firstly, a separate MSISDN may be allocated for each service, or service option, which a subscriber uses for incoming calls; or, alternatively, a single number, applicable for all incoming calls is used. + +It should be noted that it is possible for both schemes to co-exist within the PLMN and that they are not mutually exclusive. + +- a) Multiple MSISDNs are used ("The Multi-numbering Scheme"). See figure 2. +- b) A single MSISDN is used ("The Single-numbering Scheme"). See figure 3. + +#### 9.2.2.1 Multi-numbering Scheme + +In this scheme, the HPLMN will allocate a number of MSISDNs to a subscriber and associate with each of these numbers a Bearer Capability to identify a Bearer or a Teleservice. This Bearer Capability comprises a complete PLMN Bearer Capability (PLMN BC) information element with contents according to 3GPP TS 27.001 and coded as per 3GPP TS 24.008. In either case, when the HLR receives an interrogation relating to an incoming call (i.e. the MAP "Send Routing Information" procedure), it requests a roaming number (MSRN) from the VLR. This request will contain the PLMN BC reflecting the service associated with the called MSISDN, i.e. the PLMN BC is passed to the VLR within the MAP parameter "GSM Bearer Capability" of the message "Provide Roaming Number". + +If the HLR completes the MAP "Send Routing Information" procedure by providing the MAP "GSM Bearer Capability" to the interrogating entity, as specified in sub-clause 10.2.2.3, the GMSC may then map the received PLMN BC into the User Service Information field of the IAM message sent to the succeeding node according to the rules defined in table 7A. This allows subsequent transit switches to select a codec transparent for data call (e.g. G.711). If the GMSC belongs to a Layered Architecture -backbone, it may also use the PLMN BC to select an appropriate codec for the call during the BICC codec negotiation (e.g. transparent codec for a data call). + +If the MAP "GSM Bearer Capability" is not included in the MAP "Send Routing Information" response, the GMSC may use the MAP "Basic Service Code", if received in the MAP "Send Routing Information" response, to determine whether the call is a speech or data call. + +At the VMSC, when the incoming call arrives, the PLMN BC associated with the MSRN are retrieved from the VLR and sent to the UE at call set-up. + +Where the PLMN specific parameter "connection element" contained in the retrieved PLMN BC-IE, indicates dual capabilities then the VMSC shall set it according to its capabilities/preferences. Additionally the parameters correlated to "connection element" shall be modified in accordance with 3GPP TS 27.001. + +The same applies to the parameter modem type if "autobauding type 1" is indicated but the IWF does not support this feature. The parameter "data compression" may also be modified according to the capabilities of the IWF. + +Where single capabilities are indicated then the VMSC shall use the requested values if it is able to support the service requested. If it is unable to support the requested service then it shall set them according to its capabilities/preferences. + +Where the Compatibility Information is provided in a degree exhaustive to deduce a PLMN Basic Service (see application rules in subclause 10.2.2), then the VMSC in providing the PLMN BC IE in the setup message shall set the PLMN specific parameters to its capabilities/preferences. + +On receipt of a Set-up message containing the compatibility information, the UE will analyse the contents to decide whether the service can be supported (with or without modification, see 3GPP TS 27.001) and the call will be accepted or rejected as appropriate. + +The UE may negotiate parameters with the MSC according to the rules defined in 3GPP TS 27.001. If the UE proposes to the network to modify the User Rate as well as the correlated parameters Modem Type and Intermediate Rate in the call confirmed message or if the UE proposes to the network to modify the Fixed Network User Rate and Other Modem Type parameters for multislot, 14.4kbit/s, EDGE and Iu Mode operations, the network may accept or release the call (see 3GPP TS 27.001). + +This negotiation takes place by means of the UE reflecting back to the MSC a complete bearer capability information element in the call confirmed message, with the relevant parameters changed. If this does not take place (i.e. if there is no PLMN BC present in the call confirmed message), then the MSC will assume that the values originally transmitted to the UE are accepted with the following exceptions: + +- If in A/Gb or GERAN Iu mode, the PLMN-BC sent with the set-up message contained the "fixed network user rate", "other modem type" and if applicable the "user initiated modification indicator" parameters and no multislot, 14.4 kbit/s, and/or EDGE related parameters (refer to 3GPP TS 27.001 and 24.008) are received in the PLMN-BC of the call confirmed message or no PLMN-BC is received, the MSC shall discard the "fixed network user rate", "other modem type" and "user initiated modification indicator" parameters - the MSC shall use the fall-back bearer service indicated by the remaining parameters of the PLMN-BC on a singleslot configuration (refer to 3GPP TS 48.020 and 3GPP TS 44.021) on the MSC/IWF-RAN link. +- On the other hand, if in A/Gb or GERAN Iu mode the PLMN-BC received with the call confirmed message contain(s) multislot, 14.4kbit/s or EDGE-related parameters the MSC shall apply on the MSC/IWF-RAN link a singleslot or multislot configuration according to the rules defined in 3GPP TS 44.021, 3GPP TS 48.020 and 3GPP TS 24.022. In case the UE signals an ACC containing TCH/F4.8 only and the network does not support TCH/F4.8 channel coding, then the MSC may act as if TCH/F9.6 were included in the ACC. +- If in UTRAN Iu mode the PLMN-BC sent with the set-up message contained the "fixed network user rate", "other modem type" and if applicable the "user initiated modification indicator" parameters, but no related parameters (refer to 3GPP TS 27.001 and 24.008) are received in the PLMN-BC of the call confirmed message or no PLMN-BC is received, the MSC shall release the call. + +The VMSC may map the received PLMN BC into an ISDN BC according to the rules defined in table 7A. This ISDN BC can be transported together with possibly available LLC and HLC in the access transport parameter of the Answer message (ANM) according to ITU-T Q.763. + +![Sequence diagram showing the call flow for a mobile terminated, PSTN originated call. The diagram involves five lifelines: UE, VMSC, VLR, HLR, and IN. The sequence of messages is: (1) IN sends SRI (MSISDNk) to HLR; HLR responds with PRN (Bck) to VLR, which then sends MSRN to HLR, which sends MSRN to IN. (2) HLR sends IAM to VMSC; VMSC sends SIFICSU (MSRN) to VLR, which sends Comp. Call (BC' k) to VMSC, which then sends Setup (BC' k) to UE. (3) UE sends Call Conf. (BC' k) to VMSC. (4) VMSC sends ANM to VLR, which sends (BC'' k) to VMSC, which then sends (BC'' k) to IN.](eb03559a4d92ea9ebd63ea9be663c50a_img.jpg) + +``` + +sequenceDiagram + participant IN as IN + participant HLR as HLR + participant VLR as VLR + participant VMSC as VMSC + participant UE as UE + + Note right of IN: Incoming Call + IN->>HLR: SRI (MSISDNk) + Note right of HLR: (1) + HLR->>VLR: PRN (Bck) + VLR->>HLR: MSRN + HLR->>IN: MSRN + HLR->>VMSC: IAM + VMSC->>VLR: SIFICSU (MSRN) + VLR->>VMSC: Comp. Call (BC' k) + VMSC->>UE: Setup (BC' k) + Note right of UE: (2) + UE->>VMSC: Call Conf. (BC' k) + Note right of VMSC: (3) + Note right of VMSC: ..... + VMSC->>VLR: ANM + VLR->>VMSC: (BC'' k) + VMSC->>IN: (BC'' k) + Note right of IN: (4) + +``` + +Sequence diagram showing the call flow for a mobile terminated, PSTN originated call. The diagram involves five lifelines: UE, VMSC, VLR, HLR, and IN. The sequence of messages is: (1) IN sends SRI (MSISDNk) to HLR; HLR responds with PRN (Bck) to VLR, which then sends MSRN to HLR, which sends MSRN to IN. (2) HLR sends IAM to VMSC; VMSC sends SIFICSU (MSRN) to VLR, which sends Comp. Call (BC' k) to VMSC, which then sends Setup (BC' k) to UE. (3) UE sends Call Conf. (BC' k) to VMSC. (4) VMSC sends ANM to VLR, which sends (BC'' k) to VMSC, which then sends (BC'' k) to IN. + +- NOTES: (1) The HLR translates the received MSISDN\_ called address (MSISDNk) into the relevant bearer capability information (Bck). + (2) Some parameters of Bck may be provided/modified according to the MSC's capabilities/preferences. See subclause 9.2.2. + (3) In the "Call Confirmed" message, the UE may modify some parameters of the BC. See subclause 9.2.2. + (4) The VMSC may map the PLMN BC (BC'k) into an ISDN BC (BC''k) according to the rules defined in table 7A. + +Abbr.: + SRI - Send Routing Information. + PRN - Provide Roaming Number. + MSRN - Mobile Station Roaming Number. + IAM - Initial Address Message. + SIFICSU - Send Information For Incoming Call Set Up. + ANM- Answer Message + +**Figure 2: Call Flow for a mobile terminated, PSTN originated call where the compatibility information provided are not exhaustive for deducing a PLMN Bearer Service; HLR uses multiple MSISDN numbers with corresponding BCs** + +#### 9.2.2.2 Single-numbering Scheme + +In the single-numbering scheme, the HPLMN will allocate one MSISDN to a subscriber, applicable to all services. + +In this case, when the HLR receives an interrogation relating to an incoming call without compatibility information exhaustive for deducing a PLMN Basic Service (i.e. the MAP "Send Routing Information" procedure), the request to the VLR for a roaming number will not contain compatibility information i.e. a PLMN BC. + +At the VLR, when the incoming call arrives, there is no PLMN BC associated with the MSRN and so the call set-up to the UE will not contain the PLMN BC information element. However, the VMSC may include all available information in the BACKUP BC information element of the call set-up message, see subclause 10.2.2.7. + +In the case the PLMN was not able to provide a PLMN BC, the UE will return a complete single or dual PLMN BC in the Call Confirmed message, indicating the service required by the mobile subscriber. The VMSC will analyse this + +PLMN BC and optionally perform subscription checking (see 3GPP TS 22.001). If the requested PLMN BC can be supported the call is established, otherwise the call will be released. + +The VMSC may map the received PLMN BC into an ISDN BC according to the rules defined in table 7A. This ISDN BC can be transported together with possibly available LLC and HLC in the access transport parameter of the Answer message (ANM) according to ITU-T Q.763. + +![Sequence diagram showing call flow for a mobile terminated, PSTN originated call. Lifelines: UE, VMSC, VLR, HLR, IN. The sequence starts with an Incoming Call from IN to HLR (SRI (MSISDNk)). HLR sends PRN (no BC) to VLR. VLR sends (MSRN) to HLR. HLR sends (MSRN) to IN. IN sends IAM (MSRN) to VMSC. VMSC sends SIFICSU (MSRN) to VLR. VLR sends Comp. Call (no BC) to VMSC. VMSC sends Setup (no BC, Backup BC) to UE. UE sends Call Conf. (BC) to VMSC. VMSC sends ANM (BC') to IN. Call numbers (1), (2), (3) are indicated on the right.](7e1c9b51e067a48cd0fcc9748d8bd8d8_img.jpg) + +``` + +sequenceDiagram + participant IN as IN + participant HLR as HLR + participant VLR as VLR + participant VMSC as VMSC + participant UE as UE + + Note right of IN: Incoming Call + IN->>HLR: SRI (MSISDNk) + HLR->>VLR: PRN (no BC) + VLR-->>HLR: (MSRN) + HLR-->>IN: (MSRN) + IN->>VMSC: IAM (MSRN) + VMSC->>VLR: SIFICSU (MSRN) + VLR-->>VMSC: Comp. Call (no BC) + VMSC->>UE: Setup (no BC, Backup BC) + Note right of UE: (2) + UE->>VMSC: Call Conf. (BC) + Note right of VMSC: (1) + Note right of VMSC: ..... + VMSC->>IN: ANM (BC') + Note right of IN: (3) + +``` + +Sequence diagram showing call flow for a mobile terminated, PSTN originated call. Lifelines: UE, VMSC, VLR, HLR, IN. The sequence starts with an Incoming Call from IN to HLR (SRI (MSISDNk)). HLR sends PRN (no BC) to VLR. VLR sends (MSRN) to HLR. HLR sends (MSRN) to IN. IN sends IAM (MSRN) to VMSC. VMSC sends SIFICSU (MSRN) to VLR. VLR sends Comp. Call (no BC) to VMSC. VMSC sends Setup (no BC, Backup BC) to UE. UE sends Call Conf. (BC) to VMSC. VMSC sends ANM (BC') to IN. Call numbers (1), (2), (3) are indicated on the right. + +- NOTE: (1) This BC is derived from information stored in the UE, according to its configuration. The UE may also use the information provided in the Backup BC. + (2) The Backup BC may be included if the BC is missing. + (3) The VMSC may map the PLMN BC (BC) into an ISDN BC (BC') according to the rules defined in table 7A. + (4) Abbreviations: see figure 2. + +**Figure 3: Call Flow for a mobile terminated, PSTN originated call where the compatibility information provided are not exhaustive for deducing a PLMN Bearer Service; HLR uses single MSISDN numbers (no corresponding BC stored). Per call MSRN allocation** + +### 9.2.3 Transparent service support + +The protocol stacks for transparent services are specified in 3GPP TS 43.010 and in Clause 11a.3. + +In Iu mode, the transparent services are based in the Iu User Plane protocol specified in 3GPP TS 25.415. + +In A/Gb mode the rate adaptation scheme shall be utilized on the RAN to MSC link as identified in 3GPP TS 48.020. The transcoding function will generate the 64 kbit/s rate adapted format utilizing the 8 and 16 kbit/s intermediate data rates. The MSC to MSC/IWF link (e.g. in the case of handover) will utilize the same 64 kbit/s rate adaptation scheme as that indicated in 3GPP TS 48.020. + +For the transparent service support the MSC/IWF will select the modem and speed based on the Compatibility information contained in either the call set-up or call confirmed message reference subclauses 9.2.1 and 9.2.2. Where the modem type indicated is one of the multi-speed versions, e.g. V.32, then the MSC/IWF will restrict the modem to the speed indicated in the call set-up and call confirmed message, respectively, i.e. will inhibit the modem from changing speed, irrespective of the conditions, error rate, encountered on the PSTN link. This scenario is also applicable for the use of "autobauding" modems, in that only the specifically requested modem type and speed will be selected at the MSC/IWF (however Facsimile Group 3 can use channel mode modify). + +#### 9.2.3.1 Structure of the MSC/IWF for Iu mode + +The transmission towards the RNC is based on AAL2. The Iu UP is used in the transparent mode. + +![Figure 4: Structure of MSC/IWF for Iu mode. A diagram showing a vertical stack of three boxes: 'Iu UP', 'AAL2', and 'ATM'. A line connects the 'Iu UP' box to a 'MODEM' box on the right. Another line extends from the left side of the 'ATM' box.](2734e7f9be3e1dc046f14be2e6c9a085_img.jpg) + +Figure 4: Structure of MSC/IWF for Iu mode. A diagram showing a vertical stack of three boxes: 'Iu UP', 'AAL2', and 'ATM'. A line connects the 'Iu UP' box to a 'MODEM' box on the right. Another line extends from the left side of the 'ATM' box. + +**Figure 4: Structure of MSC/IWF** + +#### 9.2.3.2 Structure of the MSC/IWF for A/Gb mode + +The rate adaptation process is a reverse of that provided in the Terminal Adaptation function of the UE. The rate adaptation RA1 is based on the ITU-T Recommendation V.110 80 bit frame for TCH/F2.4, TCH/F4.8 and TCH/F9.6 and on A-TRAU frame for TCH/F14.4. 3GPP TS 44.021 and 3GPP TS 48.020, respectively, refer to the rate adaptation mechanisms to be provided. For multislot configurations refer to 3GPP TS 43.010. + +NOTE: From MSC/IWF's perspective a TCH/F28.8 EDGE configuration is identical to a multislot 2×TCH/F14.4 configuration. + +![Figure 5: Rate adaptation schematic. A diagram showing the flow of data from an MSC to a PSTN through an IWF. Inside the IWF, there are three rate adaptation blocks: RA2 (64 kbit/s, 2^k*8 kbit/s), RA1 (2^k*8 kbit/s, 2^n*600 bit/s), and RA0 (Stop bit). These blocks are connected in series. A MODEM block is also shown within the IWF, connected to the RA0 block and the PSTN line.](303fadfb9def251d1575d6221199b158_img.jpg) + +Figure 5: Rate adaptation schematic. A diagram showing the flow of data from an MSC to a PSTN through an IWF. Inside the IWF, there are three rate adaptation blocks: RA2 (64 kbit/s, 2^k\*8 kbit/s), RA1 (2^k\*8 kbit/s, 2^n\*600 bit/s), and RA0 (Stop bit). These blocks are connected in series. A MODEM block is also shown within the IWF, connected to the RA0 block and the PSTN line. + +**Figure 5: Rate adaptation schematic** + +In case of asynchronous bearer services and the facsimile teleservices in the transparent mode, the IWF shall disregard the value of bits E4, E5, E6 and E7 in the data transmission phase. + +#### 9.2.3.3 Mapping of signalling UE/MSC/IWF to modem interface requirements + +This process also is a reverse of the function provided in the Terminal Adaptation function of the UE for the mapping of DTE/DCE signalling information to Dm channel and in band signalling information. See 3GPP TS 27.002 and 3GPP TS 27.003. + +![Figure 6: Signalling mapping schematic. A diagram showing two boxes: '(Dm or) inband signalling functions' on the left and 'V-series DCE functions' on the right. Two arrows labeled 'Mapping' connect them, one pointing from left to right and the other from right to left.](ced309874aec0546651b0976d5030a42_img.jpg) + +Figure 6: Signalling mapping schematic. A diagram showing two boxes: '(Dm or) inband signalling functions' on the left and 'V-series DCE functions' on the right. Two arrows labeled 'Mapping' connect them, one pointing from left to right and the other from right to left. + +**Figure 6: Signalling mapping schematic** + +Status bits SA, SB and X can be used to convey channel control information associated with the data bits in the data transfer state. Table 5 shows the mapping scheme between the V.24 circuit numbers corresponding to the V-series DCE + +functions and the status bits for the transparent mode. It also shows how the unused status bits should be handled. It is derived from the General Mapping scheme described in annex B. A binary 0 corresponds to the ON condition, a binary 1 to the OFF condition. + +The transport of these status bits by the various channel codings is described in 3GPP TS 44.021 and 3GPP TS 48.020 for A/Gb mode. For Iu mode refer to Clause 11a. + +NOTE Although the interface to the modem is described in terms of V.24 interchange circuit functions, this does not imply that such circuits need to be physically realised. + +**Table 5: Mapping scheme at the IWF for the transparent mode** + +| Mapping direction: UE to IWF | Mapping direction: IWF to UE | Signal at IWF modem interface or condition within the IWF | +|------------------------------|------------------------------|-----------------------------------------------------------| +| always ON (note 1) | | CT 105 | +| | to status bit X | CT 106 | +| | not mapped (note 5) | CT 107 | +| not mapped (note 6) | | CT 108 | +| | to status bit SB | CT 109 | +| always ON (note 2) | | CT 133 | +| from status bit SA (note 3) | | ignored by IWF | +| from status bit SB (note 1) | | ignored by IWF | +| from status bit X (note 4) | | ignored by IWF | +| | to status bit SA (note 3) | always ON | + +NOTE 1: The SB bit towards the IWF, according to the General Mapping (annex B), could be used to carry CT 105 from the mobile DTE to the modem in the IWF. However, CT 105 should always be ON at the DTE interface in the data transfer state since only duplex operation is supported. Also, many DTEs use the connector pin assigned to CT 105 for CT 133. Therefore, CT 105 shall always be set to ON at the IWF modem during the data transfer state. + +NOTE 2: CT 133 is not mapped since there is no flow control in transparent mode. + +NOTE 3: The SA bits in both directions are available only with certain channel codings. Therefore, for maximum compatibility, they should not be mapped. + +NOTE 4: The X bit towards the IWF is not mapped since there is no flow control in transparent mode. + +NOTE 5: CT 107 is not used by the IWF. + +NOTE 6: CT 108 is used in the call setup and answering processes. + +In general it is not required for the modem in the MSC/IWF to support a "remote looping" request from a modem in the PSTN. In addition the invocation of a "remote looping" request from the mobile subscriber to a modem in the PSTN need not be supported (see also 3GPP TS 27.001). Specific test loops for mobile subscribers to contact may be provided at the network operators discretion. + +#### 9.2.3.4 Establishment of end-to-end terminal synchronizations + +Prior to exposing the traffic channel of a PLMN connection to transmission of user data, the controlling entities of the connection shall assure of the availability of the traffic channel. This is done by a so called synchronizations process: + +- starting on the indication of "physical connection established" resulting from the PLMN-inherent outband signalling procedure. This indication is given: + - for MOC: on sending the CONNECT message; + - for MTC: on sending the CONNECT ACKNOWLEDGE message; + - for mobile initiated in-call modification: on sending the MODIFY COMPLETE message (which is sent after reception of the ASSIGNMENT COMPLETE or RAB ASSIGNMENT RESPONSE message); and + - for network initiated in-call modification: on reception of the ASSIGNMENT COMPLETE or RAB ASSIGNMENT RESPONSE message; + +- ending by indicating the successful execution of this process to the controlling entity, which then takes care of the further use of the inband information (data, status). + +Network interworking within an MSC/IWF is concerned with the terminating side (to the UE) and the transit side (to the fixed network) of a connection. Both sides have to be treated individually related to the synchronizations process. + +##### 9.2.3.4.1 Terminating side (towards the UE) + +###### 9.2.3.4.1.1 Traffic channel types TCH/F4.8 and TCH/F9.6 for A/Gb mode + +With respect to the terminating side the procedure is as follows: + +- sending of synchronizations pattern 1/OFF (all data bits "1"/all status bits "OFF") to the UE using the RA1/RA2 rate adaptation function. In multislot transparent operation, the synchronisation pattern sent is 1/OFF with the exception of the bit positions S1, first X, S3, and S4 which contain the substream number and multiframe alignment pattern (see 3GPP TS 44.021); +- searching for detection of the synchronizations pattern from the UE within valid V.110 frames, and in multislot operation, also searching for the multiframe alignment pattern "0000 1001 0110 0111 1100 0110 1110 101" (see 3GPP TS 44.021) in bit position S4 and substream numbers in bit positions S1, first X, and S3. This implies that the E1, E2 and E3 bit of the V.110 frame shall be checked for the appropriate user rate in order to distinguish the synchronization pattern from the RAN idle data frame; +- timer T (= 500 ms) is started for each of the allocated traffic channel(s) of the call on receipt of the synchronizations pattern from the UE; +- when the frame alignment pattern and, in case of multislot operation, the multiframe alignment pattern have been recognized as a steady state, the MSC/IWF continues sending the synchronizations patterns to the UE until a timer T expires. + +###### 9.2.3.4.1.2 Traffic channel type TCH/F14.4 for A/Gb mode + +With respect to the terminating side the procedure is as follows: + +- sending A-TRAU frames with the data rate set in the bits C1-C4 (TS 48.020) and data bits set to one, sending the multiframe structure with the alignment pattern (bit M1) and with the status bits OFF (bit M2) and, in a multislot case, sending substream numbers (bit M2); +- searching for the detection of the multiframe alignment pattern "0000 1001 0110 0111 1100 0110 1110 101" (TS 44.021) in the bit M1 and, in a multislot case, searching for substream numbers in the bit M2. (Any 5 bit sequence in the multiframe alignment pattern is unique, i.e. the multiframe alignment can take place by recognition of five successive M1 bits); +- timer T (= 500 ms) is started for each of the allocated traffic channel(s) of the call on receipt of the synchronizations pattern from the UE; +- when the frame alignment pattern and the multiframe alignment pattern have been recognized as a steady state, the MSC/IWF continues sending the synchronizations patterns to the UE until a timer T expires. + +###### 9.2.3.4.1.3 User Plane for Iu mode + +The IWF does not send any frame down link until the modem connection has been established and the modems have synchronised. Thereafter the IWF through connects, mapping data from the fixed network side onto frames that are sent toward the UE, and mapping data in the received frames to the fixed network side. + +##### 9.2.3.4.2 Transit side (towards the fixed network) + +With respect to the transit side the procedure is as follows: + +- at the start of timer T for each of the allocated traffic channel(s) of the call, circuit 108 to the selected modem associated with the connection will be switched from the "OFF" to "ON" condition, thus initiating the establishment of the modem connection. In the case of mobile originated calls, this initiates the auto calling sequence and after signalling, calling tone according to V.25 shall be generated by the modem in the IWF; +- the interchange circuits towards the modem (with the exception of CT108) are held in the OFF condition until timer T expires, when they are switched to ON; + +- from this time, after the expiration of the timer T of every allocated traffic channel, the information on CT106 and CT109 from the IWF Modem are directly mapped to the SB and X bits toward the UE. For TCH/F14.4 the SB and X bits are mapped to the M2 multiframe bits according to 3GPP TS 44.021. The IWF is allowed to map CT104 to the data bits sent towards the UE and to map data bits received from the UE to CT103. + +#### 9.2.3.5 Network Independent Clocking (NIC) + +The network independent clocking function applies only to A/Gb mode. It is invoked by the VMSC/IWF when the service requested (MO or MT) is 3,1 kHz Ex PLMN and synchronous. The above rule applies irrespective of the information contained in the 3GPP TS 24.008 setup message regarding NIC. For all other services NIC is not used. + +Within the PLMN the coding of the values for bits associated with NIC is specified in 3GPP TS 44.021 and 3GPP TS 48.020. In the forward (transmitting) direction the multiframes shall be coded in exact accordance with that specified in those specifications. Bit E6 is set to "1" in alternate modified V.110 frames at the transmitter. However, the use of this bit at the receiver for monitoring frame synchronization, or any other purpose, is not specified and is left to the discretion of the implementer. + +A "perfect linear block Code" is used in C1-C5, whose error correction properties may be utilized in the receiver, in order to ensure reliable operation of NIC. + +The NIC sending function shall recognize when the difference between the applicable clock speed of the PLMN and the interface speed generates a positive or negative whole bit requirement. When this positive or negative condition occurs, the NIC codewords specified in 3GPP TS 44.021 are used to transport this condition to the receiving NIC function. Transmission of the codeword shall clear the positive or negative condition related to that codeword at the sending function. The sending function shall not send more than one positive or negative compensation within a contiguous period of time corresponding to 10 000 user data bits minus the maximum NIC code framing delay (e.g. in the case of TCH/F2.4, TCH/F4.8 or TCH/F9.6, the number of user data bits necessary to make up an even number of V.110 frames between compensation). NIC compensation is coded in two V.110 frames in the case of TCH/F2.4, TCH/F4.8 or TCH/F9.6 and in one multiframe in the case of TCH/F14.4. This results from the requirements to compensate for maximum clock differences of $\pm 100$ parts per million. If the receiving function receives NIC compensations in the average more often than a contiguous period of time corresponding to 10000 user data bits, there is no guarantee that data will not be lost. + +The NIC receiving function shall provide the capability to support the compensation requirements of the sending function. This compensation is managed by manipulating the clock speed of the interface, within the standard constraints of that interface. + +Overall, the compensation functions shall be capable of managing clock tolerances of $\pm 100$ parts per million. + +Action on loss of synchronization. + +If five consecutive NIC multiframes in the V.110 frame have incorrect framing bit values in E7 or if the A-TRAU multiframe synchronisation is lost, the receiver shall stop applying clocking compensation to the received data. Resynchronization will be attempted and compensation will resume when synchronization is achieved. + +### 9.2.4 Non-transparent service support + +The protocol stacks for non-transparent services are specified in 3GPP TS 43.010 and in Clause 11a.2. Both of the systems use the Radio Link Protocol (RLP) specified in 3GPP TS 24.022. + +In Iu mode, the non-transparent services are based in the Iu User Plane protocol specified in 3GPP TS 25.415. + +In A/Gb mode the corresponding necessary support concerning the rate adaptation scheme shall be utilized on the RAN-MSC link as identified in 3GPP TS 48.020. + +For the non-transparent service support the MSC/IWF will select the modem and speed based on the Compatibility information contained in either the call set-up or call confirmed message, reference subclauses 9.2.1 and 9.2.2. Where the Modem Type indicated is autobauding type 1, the MSC/IWF may select any speed and modem type according to what it can negotiate with the remote modem. In this case User Rate and Fixed Network User Rate, if present, has no meaning. + +#### 9.2.4.1 Structure of the MSC/IWF for Iu mode + +The transmission towards the RNC is based on AAL2. The Iu UP is used in the support mode. The RLP/L2R extends to the UE. + +![Diagram showing the protocol stack for MSC/IWF in Iu mode. The stack consists of four layers: RLP/L2R (top, split into two triangles), Iu UP, AAL2, and ATM (bottom). The RLP/L2R layer is connected to a MODEM block on the right. The ATM layer has an input line on the left.](f0a97d0d3818a253c1d2a009966081b1_img.jpg) + +Diagram showing the protocol stack for MSC/IWF in Iu mode. The stack consists of four layers: RLP/L2R (top, split into two triangles), Iu UP, AAL2, and ATM (bottom). The RLP/L2R layer is connected to a MODEM block on the right. The ATM layer has an input line on the left. + +**Figure 7: Structure of MSC/IWF** + +#### 9.2.4.2 Structure of the MSC/IWF for A/Gb mode + +The rate adaptation process will be the same as for the transparent case (see figure 5), except that a TCH/F43.2 channel coding is also supported. From MSC/IWF's perspective a TCH/F43.2 EDGE configuration is identical to a multislot 3×TCH/F14.4 configuration. + +3GPP TS 43.010 identifies the protocol layer structures for the non-transparent case, the physical layer to the PSTN is provided by means of a modem. + +#### 9.2.4.3 Re-constitution of user data + +3GPP TS 24.022 refers to the frame of user data in the radio link protocol. The layer 2 relay functions in the UE and the MSC/IWF (identified in 3GPP TS 43.010) contain the mechanism for packing and unpacking the user data into the L2R protocol data units. + +#### 9.2.4.4 Layer 2 relay functionality + +Specific functionality is required of the L2R dependant upon the service which is being requested to be supported. The selection of the appropriate L2R function will be determined by the MSC/IWF on the basis of the bearer capability information signalled in either the call set-up request, or call confirmation messages. The prime information element being transparent or non transparent service indication. In addition the particular L2R function will be selected on the basis of the users layer 2 indication - type of protocol to be terminated and mode of flow control to be applied (see appropriate clauses of the 3GPP TS 27 series). + +The specific interaction between the L2R function and the RLP function and the L2R frame structure will be the same as that detailed in the annex to the appropriate 3GPP TS 27 series. + +#### 9.2.4.5 In band signalling mapping flow control + +This entails the L2R function providing the means of controlling and responding to flow control functions of the modem plus any synchronization requirements related to flow control. For asynchronous services a specific rule applies for flow control (see 3GPP TS 27.001). + +The flow control function chosen will be dependent upon the information contained or not contained in the "user information layer 2" information element of the PLMN BC received from the UE. + +If flow control is provided, irrespective of the type used the L2R function shall: + +- (a) provide immediate indication of flow control to the fixed network on receipt of flow control request from the UE; and/or +- (b) provide immediate indication of flow control to the UE on receipt of flow control request from the fixed network i.e. in the next available L2R status octet to be transmitted. + +Where in-band (X-on/X-off) flow control is in use, then the X-on/X-off characters will not be passed across the radio interface. + +For outband flow control refer to subclause 9.2.4.9. + +If no flow control is provided, the involved end systems are responsible for performing in-band flow control on their own by taking into account the buffer capacity of the MSC/IWF stated below. + +##### 9.2.4.5.1 Conditions requiring flow control towards the fixed network + +The L2R function will initiate flow control - if flow control is present - in the following circumstances: + +- 1) the transmit buffer reaches a preset threshold (BACK PRESSURE); +- 2) the L2R function receives an explicit "flow control active" indication. + +No flow control initiation/removal will take place at the L2R function and loss of data may occur if no flow control is provided. + +On removal of buffer congestion or receipt of L2R "flow control inactive" the flow control will be removed. + +##### 9.2.4.5.2 Conditions requiring flow control towards the UE + +The L2R function will transmit to the UE an explicit "flow control active indication" if flow control is provided in the following circumstances: + +- 1) if the receive buffer from the radio side reaches a preset threshold (BACK PRESSURE); +- 2) if a flow control indication is received from the fixed network customer. On receipt of this flow control indication, transmission of data from the receive buffers towards the fixed network terminal is halted. + +On removal of the buffer congestion or fixed network flow control indication, the L2R function will send a "flow control inactive" indication towards the UE. In addition, for the fixed network indication, transmission of data from the receive buffers will be restarted. + +If no flow control is provided at the L2R function, no flow control initiation/removal will take place by the MSC/IWF. Data might be lost without any indication by the MSC/IWF to the end systems involved. + +#### 9.2.4.6 Data buffers + +##### 9.2.4.6.1 Transmit buffers (towards UE) + +Incoming data from the fixed network customer shall be buffered such that if the MSC/IWF is unable to transfer data over the radio path the data is not lost. + +The buffer shall be capable of holding the data. Its size is up to the implementers. When the buffer is half full flow control towards the fixed network shall be initiated if flow control is provided as per subclause 9.2.4.5.1. + +##### 9.2.4.6.2 Receive buffers (from UE) + +Incoming data from the UE is buffered such that if the fixed network terminal is unable to accept the data then it is not lost. + +The buffer shall be capable of holding the data. Its size is up to the implementers. When the buffer becomes half full, the L2R function will send a "flow control active" indication towards the UE if flow control is provided at the L2R function, as per subclause 9.2.4.5.2. + +#### 9.2.4.7 Transportation of the Break condition + +The "BREAK" condition shall be recognized by the L2R function and passed immediately to the UE. The L2R will generate a "BREAK" condition towards the fixed network on receipt of a break indication from the MS. The action of the "BREAK" on the L2R transmit and receive and the length of the "BREAK" signal to be generated towards the fixed network is described in 3GPP TS 27.002. + +#### 9.2.4.8 In band signalling mapping modem status information + +Status information is carried between the modem in the IWF and the terminal adaptation function in the UE by the L2R function. The L2RCOP entity transfers interface status information between L2Rs via the status octets SA, SB and X in L2RCOP-PDUs (3GPP TS 27.002). Table 6 shows the mapping scheme between the V.24 circuit numbers corresponding to the V-series DCE functions and the status bits for the non-transparent mode. It also shows how the unused status bits should be handled. It is derived from the general mapping scheme described in annex B. A binary 0 corresponds to the ON condition, a binary 1 to the OFF condition. + +NOTE: Although the interface to the modem is described in terms of V.24 interchange circuit functions, this does not imply that such circuits need to be physically realised. + +**Table 6: Mapping scheme at the IWF for the non-transparent mode** + +| Mapping direction: UE to IWF | Mapping direction: IWF to UE | Signal at IWF modem interface or condition within the IWF | +|------------------------------|------------------------------|-----------------------------------------------------------| +| always ON (note 1) | | CT 105 | +| | to status bit X (notes 4, 7) | CT 106 (note 7) | +| | not mapped (note 5) | CT 107 | +| not mapped (note 6) | | CT 108 | +| | to status bit SB | CT 109 | +| from status bit X (note 8) | | CT 133 (notes 3, 8) | +| from status bit SA (note 2) | | ignored by IWF | +| from status bit SB (note 1) | | ignored by IWF | +| | to status bit SA (note 2) | always ON | + +NOTE 1: The SB bit towards the IWF, according to the General Mapping (annex B), could be used to carry CT 105 from the mobile DTE to the modem in the IWF. However, CT 105 should always be ON at the DTE interface in the data transfer state since only duplex operation is supported. Also, many DTEs use the connector pin assigned to CT 105 for CT 133. Therefore, CT 105 shall always be set to ON at the IWF modem during the data transfer state. + +NOTE 2: The SA bits (both directions) are not mapped since CTs 107 and 108 are handled locally (notes 5 and 6). + +NOTE 3: The condition of CT 133 (or other flow control mechanism) may also be affected by the state of the L2R transmit buffer (towards the UE) in the IWF and the state of RLP (RR/RNR). + +NOTE 4: The condition of status bit X towards the UE may also be affected by the state of the L2R receive buffer (from the UE) in the IWF. + +NOTE 5: CT 107 is not used by the IWF. + +NOTE 6: CT 108 is used in the call setup and answering processes. + +NOTE 7: For inband flow control, CT 106 is not mapped and the status bit X towards the UE is controlled by the reception of XON and XOFF characters from the modem. + +NOTE 8: For inband flow control, changes in the condition of the status bit X from the UE result in the sending of XON or XOFF to the modem. CT 133 is always set to ON. + +#### 9.2.4.9 Support of out-band flow control + +Out-band flow control in case of the asynchronous bearer service requires V.42 functionality in the modems in the MSC/IWF and the fixed network. + +If this functionality is requested by the UE but cannot be provided by the MSC/IWF or the remote (fixed network) modem for any reason, the call shall be supported without V.42 functionality (fall back to the non-error correction mode according to ITU-T Recommendation V.42). + +This implies that no flow control initiation/removal (refer to subclause 9.2.4.5.1) is possible towards the fixed network. In this case the L2R transmit buffers in the IWF (towards the UE, refer to subclause 9.2.4.6.1) shall overbridge temporary throughput problems on the radio interface and the case where the UE initiates flow control. The IWF however shall release the connection if an overflow of these buffers occurs. + +#### 9.2.4.10 Establishment of end-to-end terminal synchronizations + +Prior to exposing the traffic channel of a PLMN connection to transmission of user data, the controlling entities of the connection shall assure of the availability of the traffic channel. This is done by a so called synchronization process: + +- starting on the indication of "physical connection established" resulting from the PLMN-inherent outband signalling procedure. This indication is given: + - for MOC: on sending the CONNECT message; + - for MTC: on sending the CONNECT ACKNOWLEDGE message; + - for mobile initiated in-call modification: on sending the MODIFY COMPLETE message (which is sent after reception of the ASSIGNMENT COMPLETE or RAB ASSIGNMENT RESPONSE message); and + - for network initiated in-call modification: on reception of the ASSIGNMENT COMPLETE or RAB ASSIGNMENT RESPONSE message; +- ending by indicating the successful execution of this process to the controlling entity, which then takes care of the further use of the in-band information (data, status). + +Network interworking within an MSC/IWF is concerned with the terminating side (to the UE) and the transit side (to the fixed network) of a connection. Both sides shall be treated individually related to the synchronization process. + +##### 9.2.4.10.1 Terminating side (towards the UE) + +With respect to the terminating side the procedure in A/Gb mode is as follows: + +- reception of V.110 or A-TRAU frames on all allocated traffic channels for the call is required before the MSC/IWF shall reply with an RLP-UA frame to the MT's RLP link establishment request (if the MSC/IWF initiates the RLP link establishment, reception of V.110 frames or A-TRAU on all allocated traffic channels for the call shall be detected first); +- waiting for the RLP link establishment by the MT (in addition the MSC/IWF may initiate the RLP establishment). + +In Iu mode at the IWF, the synchronisation of modems on the transit network is performed after establishment of the physical connection. The RLP establishment may be initiated by the IWF, but is normally initiated by the UE. If the modems synchronise before the RLP has been established, the IWF stores the information received from the other modem in the L2R buffers. + +##### 9.2.4.10.2 Transit side (towards the fixed network) + +Depending upon implementation - CT108 will be turned ON to enable the autocalling/autoanswering function of the selected modem either when the RLP has been established or in parallel to RLP establishment. If CT 108 is turned ON in parallel to the RLP establishment, the modem connection may be established before the RLP is established. In this case, data received from the transit side during RLP establishment shall be stored within the L2R buffers until the RLP establishment at the terminating side has been finished. When the RLP has been established, the information from/to the RLP including status changes will be mapped by the L2R entity applicable to the particular bearer capability. After signalling, for MO calls, calling tone according to V.25 shall be generated by the modem in the IWF. + +#### 9.2.4.11 Data compression + +When data compression is invoked within a non-transparent bearer service, interworking to the fixed network is realized as follows. + +The PLMN BC is used to indicate the interworking modem type and user rate. The modems shall try to negotiate data compression and flow control. If negotiation of data compression fails in the fixed network, the call continues with data compression between UE and IWF only. + +#### 9.2.4.12 Service level up and down grading + +Service level up and down grading is only applicable for A/Gb mode and GERAN Iu mode. If the value of the RLP parameter "UP signalling" is negotiated to 1, the IWF shall send a suggestion to the UE to initiate an upgrading whenever the following condition holds: + +The IWF: + +- 1) is receiving user data from the fixed network side at a higher rate than the current AIUR; or + +- 2) in symmetrical calls only, can send user data towards the fixed network side at a higher rate than the current AIUR. + +When the above condition does not hold, the IWF sets the value of the UP bit continuously to 0. When the condition above does hold, the IWF indicates the number of traffic channels to upgrade by, by sending that number of 1s between two consecutive 0s in the UP bit sequence. This indication is not repeated since the FCS protects it. For instance, if the current number of traffic channels is two and an upgrading to four traffic channels is suggested, the UP bit sequence shall be ..01100... How the IWF detects the condition and additional details for setting and resetting of the UP bit, e.g., hysteresis levels, may depend on implementation. + +NOTE: From MSC/IWF's perspective a TCH/F28.8 or TCH/F43.2 EDGE configuration is identical to a multislot $2 \times \text{TCH/F14.4}$ or $3 \times \text{TCH/F14.4}$ configuration. In this case, rather than suggesting the number of channels to add, the IWF suggests a number of 14.4 substreams to add and therefore a factor of $\frac{1}{2}$ or $\frac{1}{3}$ shall be applied to the suggested increase when the assigned up link channel is TCH/F28.8 or TCH/F43.2 respectively. + +### 9.2.5 DTE/DCE interface (Filtering) + +The DTEs taken into account for the PLMN at the UE side conform to ITU-T's DTE/DCE interface specifications, which assume basically an error-free environment, i.e.: + +- limited distance, point-to-point local interconnection of the interface circuits for data and status; +- steady state signalling. + +The envisaged use of these DTE's in the PLMN environment leads to the exposure of these "interconnections" - which may, in the ISDN case, lead to the ISDN Rate Adaptation rather than to a Modem in the MSC/IWF - to the PLMN Radio Channel. To assure proper operation even under these conditions appropriate measures shall be taken. In the "non-transparent case" the RLP satisfies the requirement for both data and status lines. In the "transparent" case, the: + +- data line aspects shall be dealt with end-to-end between the users; while +- status line aspects are of concern to the network which are dealt with in the following. + +The use of the channel control information for the remote control of the DTE/DCE control interchange-circuits between the UE and the MSC/IWF (the conveyance of which is supported by the rate adaptation scheme adopted for PLMN application) requires alignment to the particular transmission occurrences in the traffic channel to be taken into account within the PLMN. In principle this can be best achieved by: + +- relying only on the PLMN outband signalling as far as connection control is concerned; +- eliminating the dependence upon the transmission of channel control information via the radio link. + +Support for this strategy is given to a certain extent by the confinement of PLMN data connections to: + +- full duplex operation (no turning round of the connection is required); +- switched service (demand access); +- mapping of connection-control relevant conditions of the DTE/DCE control interchange-circuits to/from outband PLMN signalling according to 3GPP TS 24.008 after successful traffic channel synchronization; +- flow control by a network entity supported only in non-transparent mode; +- support of connections with the same user data rate only (no TA to TA end-to-end flow control in case of transparent mode). + +The only DTE/DCE control interchange-circuit conditions, which actually are not covered by the above confinements, are the indications of readiness for data transmission, i.e. CT106/109 in case of V.-series interface and I-circuit of X.-series interface. As the effect of a condition change of the afore-mentioned DTE/DCE interchange-circuits depends on the: + +- phase within the course of the connection; +- direction of change (ON-OFF or OFF-ON). + +The required precaution to be applied (Filtering) shall be determined individually in view of: + +- function deduced from the change; +- resilience of the connection needed; +- error condition possibly invoked due to a delay in performing the condition change of the control interchange circuit; +- potential loss of performance in connection usage. + +The details of the filtering function are laid down in 3GPP TS 27- series. Filtering of channel control information is only relevant at the UE side in the transparent mode of operation. + +## 9.3 Interworking Alternate Speech / Facsimile Group 3 Calls + +### 9.3.1 General + +The procedure for the alternate speech/facsimile group 3 services is invoked at UE-MSC link during the call set-up phase. This service is invoked by indication of repeated bearer capability information elements in the setup message and/or call confirmed message respectively (preceded by a repeat indicator "circular"), one indicating speech and the other indicating facsimile group 3. The facsimile service requested will be indicated by the information transfer capability "facsimile group 3", as for a normal single call. The bearer capability first indicated i.e. speech or facsimile group 3 determines the first selection required of the network by the subscriber. Depending on the type of service requested and direction of call establishment (MO/MT, see relevant clauses of 3GPP TS 27 series) low layer and high layer capabilities may also be included. The MSC/IWF will perform both compatibility checking and subscription checking on both sets of capabilities as for normal data calls. If either the subscription check or the compatibility check fails then the call will be rejected. The only exception to this is when TS61/TS62 negotiation takes place, see 3GPP TS 27.001. + +The applicable rules for provision of supplementary services are laid down in 3GPP TS 22.004. + +The "speech" phase of the call, when invoked is handled by the transcoder and will utilize normal telephony teleservice interworking requirements and mobile network capabilities. This includes any requirements for echo cancellers etc. as indicated in subclause 9.1. The "facsimile group 3" phase of the call, when invoked, shall utilize the appropriate data interworking capability (IWF including modem) and shall use the transparent mobile network capability in A/Gb mode or the non-transparent mobile network capability in UTRAN Iu mode. + +The network shall provide, for service and operational reasons, a rapid and reliable changeover of capability upon request from the mobile user. This changeover may involve the disabling, by-passing or introduction of particular network functions (e.g. speech coder, modem etc.) and change of the channel configuration on the radio interface. This changeover is initiated on the receipt of the "MODIFY" message (see 3GPP TS 24.008) from the UE. The network itself will not initiate a changeover. + +### 9.3.2 Mobile originated PSTN terminated calls + +The call is set up in the normal manner (but with repeated bearer capability information elements as described in subclause 9.3.1 and handled by the MSC/IWF as indicated in the general clause. + +### 9.3.3 PSTN originated mobile terminated calls + +The call set up request for this particular service is performed in a similar manner to that indicated in subclause 9.2 for normal PSTN originated calls. + +When multiple MSISDNs are used by the HLR ("Multi-numbering scheme"), one PLMN BC-IE with the ITC value set to "alternate speech/facsimile group 3, starting with speech" is passed to the VLR in the MAP operation "provide roaming number". The VLR stores this information against the MSRN. + +When the call arrives at the visited MSC this information is retrieved from the VLR and sent to the UE in the setup message as defined in 3GPP TS 27.001. + +If the ITC of the PLMN BC-IE retrieved from the VLR has the value "alternate speech/facsimile group 3, starting with speech" this PLMN BC-IE shall be mapped to two PLMN BC-IEs (preceded by a repeat indicator "circular"), one + +representing speech, the other representing facsimile group 3. The order in which these two PLMN BC-IEs are sent towards the UE, in the setup message, is a network option. + +In order to allow auto answering mode for the facsimile phase (i.e. the call starts automatically with the facsimile phase), the UE can reflect back to MSC the dual Bearer Capability in the Call Confirm message with the BC elements interchanged to those in the original Call Set-up message (i.e. facsimile element first or negotiate to facsimile only, see subclause 9.2.2 and 3GPP TS 27.001). In all other aspects it is handled as indicated for mobile originated. + +NOTE: However, the PLMN specific parameters "connection element" and "radio channel requirements" of the retrieved PLMN BC-IE may be modified, or added in line with the principles identified in subclause 9.2.2. + +When a single MSISDN is allocated to the subscriber ("single numbering scheme"), the call is handled as described in case b) of subclause 9.2.2. In the "call confirmed" message, however, two PLMN BC-IEs are preceded by a repeat indicator "circular", with the first PLMN BC-IE indicating the initial phase of the connection. + +### 9.3.4 BICC network architecture + +In a BICC network architecture the following procedures apply for both mobile originated and mobile terminated alternate speech/facsimile group 3 calls: + +The PLMN BC-IE value of ITC equal to "alternate speech/facsimile group 3, starting with speech" shall not be used in the H.248 signalling towards the MGW. Instead, the MGW terminations shall be configured for the speech portion of the call using the Acocodec property. + +To switch to fax mode, the PLMNBC property with ITC indicating "facsimile group 3" shall be applied on appropriate terminations, as detailed in Clause 11a.1.3, to insert the MGW IWF and configure the fax call. Usual procedures to setup a CSD call is followed as described TS 29.232 [82]. + +Similarly, to switch from fax to speech mode, the PLMNBC property shall be removed and the terminations shall be re-configured for the speech portion of the call using the Acocodec property. + +## 9.4 3G-H.324/M calls over 3,1kHz audio + +In case of 3G-H.324/M calls over 3.1kHz audio, the IWF shall provide the V.34 modem modulation and the V.8 procedure with the indication of H.324 support in the call function category of the V.8 handshaking. H.223 and H.245 flow is not terminated in the modem function. + +The performance of V.8bis by the modem function is FFS. + +### 9.4.1 Mobile originated multimedia call + +#### 9.4.1.1 Call setup + +The setup message sent by the UE contains either a multimedia BC-IE indicating a multimedia only call request (i.e. no fallback to speech allowed) or both a speech BC-IE and a 3.1kHz multimedia BC-IE to indicate the support of a fallback to speech (see 3GPP TS 27.001 and 3GPP TS 24.008). + +The MSC shall not accept a requested service to which the user has no subscription. On the condition the user has the required subscriptions (i.e. to multimedia and/or speech) the following applies: + +- in case of a multimedia only BC-IE the MSC may accept the setup as such or with modifications sent to the UE in the call proceeding message (see 3GPP TS 27.001); +- in case of both a speech BC-IE and a 3.1kHz multimedia BC-IE the MSC may either accept the possibility of a fallback to speech by responding with two BC-IEs or turn the call to a speech call by sending only a speech BC-IE in the call proceeding message or turn the call to a multimedia only call by sending only a multimedia BC-IE in the call proceeding message (See 3GPP TS 27.001). + +The IWF V.34 modem shall initiate the ITU-T Recommendation V.8 handshaking and indicate the support of H.324/M in the call function category of the V.8 handshaking. If the called party's modem does not indicate a H.324 support in its V.8 inband signalling response, the IWF may clear the call. If the called party responds with a modem answering tone but there is no V.8 response at all, the IWF shall clear the call. + +If FNUR = 33.6 kbit/s is agreed on in the setup, the IWF shall configure its V.34 modem to operate in automode with an upper data rate limit of 33.6 kbit/s and a lower data rate limit of 28.8 kbit/s. If the modems handshake to 31.2 kbit/s or 28.8 kbit/s, the MSC shall initiate a MODIFY message (see 3GPP TS 24.008) to indicate the new data rate to the UE. HDLC flag stuffing or the stuffing mode defined in ITU-T Recommendation H.223 (Annexes A, B and C) shall be used to adapt the 31.2 kbit/s or 28.8 kbit/s data rate to the 33.6 kbit/s traffic channel between the UE and the IWF. In order to be able to use the correct stuffing pattern, the IWF shall detect the stuffing mode patterns exchanged between the multimedia terminals after the traffic channel setup (see ITU-T Recommendation H.324). The IWF may start the stuffing immediately after the detection of the used method. In downlink stuffing the IWF inserts stuffing patterns between the H.223 frames. In uplink stuffing the IWF removes stuffing patterns from between the H.223 frames received from the UE. If the UE responds with a MODIFY REJECT message, the MSC shall clear the call. + +#### 9.4.1.2 Fallback to speech after setup + +If the MSC has accepted the possibility of a fallback to speech and the IWF modem does not recognize the answering tone of the called modem within the expiration of a timer started at the reception of the answer message, the MSC IWF shall initiate an In Call Modification procedure (see 3GPP TS 24.008) in order to fall back to a speech mode. As a result of the procedure the IWF resource shall be released and a speech channel shall be set up between the calling UE and the fixed network. If the fallback fails e.g. due to a failing In Call Modification procedure, the IWF shall clear the call. + +A recommended minimum value for the timer is 3 seconds (see ITU-T Recommendation V.25). + +### 9.4.2 Mobile terminated multimedia call + +#### 9.4.2.1 Call setup + +If the user has a subscription to both the multimedia bearer service and the speech teleservice and if the network supports both services and the fallback functionality, the MSC shall send both a multimedia BC-IE and a speech BC-IE in the setup message to the user equipment. If the user has a subscription only to the multimedia bearer service the MSC shall send only a multimedia BC-IE. + +In case of both a speech BC-IE and a 3,1 kHz multimedia BC-IE in the setup the user equipment may either accept the possibility of a fallback to speech by responding with two BC-IEs or turn the call to a speech call by sending only a speech BC-IE in the call confirmed message or to a multimedia only call (i.e. no fallback to speech allowed) by sending only a multimedia BC-IE in the call confirmed message. In case of a multimedia only BC-IE in the setup the UE may accept the setup as such or with modifications sent to the MSC in the call confirmed message. + +If no service definition is available in the network, the MSC shall send no BC-IE(s) to the user equipment in the call setup. The MSC shall analyse the received BC-IE(s) and optionally perform a subscription check to the multimedia and/or speech service(s) requested by the user equipment in the call confirmed message and shall not accept a requested service rejected by the subscription check. + +The IWF V.34 modem shall await the ITU-T Recommendation V.8 handshaking to be initiated by the calling party's modem and shall recognize the support of H.324 in the call function category of the incoming V.8 handshaking. If the calling party's modem does not indicate a H.324 support in its V.8 inband signalling, the IWF may clear the call. If the calling modem tries to handshake another than V.34 modem scheme, the IWF shall clear the call. + +If FNUR = 33.6 kbit/s is agreed on in the setup, the IWF shall configure its V.34 modem to operate in automode with an upper data rate limit of 33.6 kbit/s and a lower data rate limit of 28.8 kbit/s. If the modems handshake to 31.2 or 28.8 kbit/s, the MSC shall initiate a MODIFY message (see 3GPP TS 24.008) to indicate the new data rate to the UE. HDLC flag stuffing or the stuffing mode defined in ITU-T Recommendation H.223 (Annexes A, B and C) shall be used to adapt the 31.2 or 28.8 kbit/s data rate to the 33.6 kbit/s traffic channel between the UE and the IWF. In order to be able to use the correct stuffing pattern, the IWF shall detect the stuffing mode patterns exchanged between the multimedia terminals after the traffic channel setup (see ITU-T Recommendation H.324). The IWF may start the stuffing immediately after the detection of the used method. In downlink stuffing the IWF inserts stuffing patterns between the H.223 frames. In uplink stuffing the IWF removes stuffing patterns from between the H.223 frames received from the UE. If the UE responds with a MODIFY REJECT message, the MSC shall clear the call. + +#### 9.4.2.2 Fallback to speech after setup + +If the MSC supports a fallback to speech and the user has a subscription to the speech service and the user equipment accepts the possibility of a fallback to speech in the call confirmed message and the IWF modem does not recognize a call tone nor a V.8 Call Indication nor a V.8 Call Menu within the expiration of a timer started at the sending of the ANSam answer tone (i.e. the calling party is not a V.34 modem), the IWF shall initiate an In Call Modification + +procedure (see 3GPP TS 24.008) in order to fall back to a speech mode. As a result of the procedure the IWF resource shall be released and a speech channel shall be set up between the called UE and the fixed network. If the fallback fails e.g. due to a missing subscription to speech or a failing In Call Modification procedure, the IWF shall clear the call. + +A recommended minimum timer value is 3 seconds (see ITU-T Recommendation V.8). + +### 9.4.3 Seamless data rate change + +If the modems change the data rate during an ongoing multimedia call (using the ITU-T Recommendation V.34 seamless data rate change mechanism), the MSC shall initiate a MODIFY message (see 3GPP TS 24.008) to indicate the new data rate to the UE. HDLC flag stuffing or the stuffing mode defined in ITU-T Recommendation H.223 (Annexes A, B and C) shall be used to adapt the 31.2 or 28.8 kbit/s data rate to the 33.6 kbit/s traffic channel between the UE and the IWF. The stuffing pattern found out during the traffic channel setup (see subclauses Call setup) is used. The IWF may start the stuffing immediately after the detection of the data rate change by the modems. + +--- + +## 10 Interworking to the ISDN + +The interworking to the ISDN is specified on the principle of the network supporting standardized associated signalling protocol as outlined in clause 6, i.e. DSS1 and ISUP. An ISDN not complying with this definition differs - for the purpose of the present document - in that it does not support the compatibility information to that degree necessary for deducing a PLMN Basic Service. These networks will find their reflection in the following where those implications are to be set out. + +The calling address sent in a mobile originated call to the ISDN is always the basic MSISDN even if the ISDN user shall use a different MSISDN (multi numbering scheme, see 9.2.2 case a) for a mobile terminated call (call back) as only the basic MSISDN is available at the VLR (see 3GPP TS 29.002). + +The scope of this clause is to describe the handling of the content of the Information Elements where "content" is understood to be the value of the parameter fields of the Information Elements, namely BC-IE, HLC and LLC, after the length indicator. For the transport of these Information Elements within the PLMN refer to 3GPP TS 29.002. + +The handling of multislot, 14.4kbit/s, EDGE and Iu Mode related parameters of the call control signalling and the applicability of single- or multislot configurations (refer to 3GPP TS 48.020 and 3GPP TS 44.021) is the same as for the PSTN interworking cases. + +### 10.1 Speech Calls + +Since at the interworking point the transcoder provides for A-law or $\mu$ -law (PCS-1900) PCM at 64 kbit/s, no particular interworking is required. It is anticipated that the ISDN Teleservice Telephony and ISDN Bearer Service speech, respectively would be used. Transmission aspects are covered in 3GPP TS 43.050. Any further requirements are a national matter. + +### 10.2 Data Calls + +In this case it is assumed that the ISDN bearer service 3,1 kHz audio shall only be interworked by means of a modem pool in the PLMN. If a network operator provides this facility, then the MSC/IWF operation will be similar to that described for interworking to the PSTN. + +Where the bearer capability information indicates that the call is a circuit switched unrestricted digital call, then the MSC/IWF shall select the appropriate rate adapted ISDN and PLMN bearer services. + +#### 10.2.1 Network interworking mobile originated + +Low layer compatibility checking of the mobile originated call is carried out by the MSC/IWF to determine the appropriate bearer service selection in the ISDN. This will entail the MSC/IWF in mapping appropriately the PLMN BC-IE to the ISDN BC-IE (bearer capability information element). If it is not possible for the MSC/IWF to provide a bearer service match, then the MSC/IWF shall fail the call and indicate the reason to the user. + +The UE shall provide further compatibility information (LLC/HLC-IEs) if required for defining end-to-end compatibility. + +As well as compatibility checking, subscription checking should be performed. + +The selection of the MSC/IWF will be by means of the bearer capability information within the call set up message. The mobile subscriber shall be able to select the unrestricted digital capability, which the MSC/IWF will map to the same capability in the ISDN call set up message. If an interworking point is encountered within the ISDN which does not support this service request, then either a call release message including an appropriate error cause or progress message is returned to the PLMN, indicating that the ISDN network is unable to support the service requested. In the case of a call release message the network shall release the call. In the case of progress message the network releases the call or forwards it (see 3GPP TS 24.008) to the mobile which will release the call. + +## 10.2.2 Network interworking mobile terminated + +### 10.2.2.1 General + +This subclause describes the interworking of calls where the calling subscriber can communicate ISDN compatibility information with exhaustive contents for deducing a PLMN Basic Service to a PLMN (gateway MSC/interrogating node) i.e. by means of ISDN signalling. + +The GMSC shall perform a mapping of the received Basic Service Information for the transport to the HLR, for details of this transport refer to 3GPP TS 29.002. + +Compatibility checking of the low layers of the ISDN originated call is carried out by the MSC/IWF to determine the appropriate bearer service selection in the PLMN. This will entail the MSC/IWF in mapping appropriately the ISDN BC/LLC-IE to the PLMN BC-IE. + +As well as compatibility checking, subscription checking should be performed. If either the subscription check or the compatibility check fails then the call will be rejected. + +For ISDN originated calls it will not be possible to signal mobile specific requirements e.g. transparent/non transparent, full/half rate channel. Therefore the MSC/IWF shall select a default setting appropriate to the visited PLMN's network capabilities. In general it will be beneficial, where a network supports both full and half rate channels and transparent/non transparent capabilities, to indicate so in the appropriate PLMN BC field of 3GPP TS 24.008. The mobile subscriber has the option to indicate in the call confirmation message a change to this default setting according to the rules specified in 3GPP TS 27.001. The appropriate MSC/IWF shall be selected on the basis of this requirement. + +### 10.2.2.2 Functions in GMSC + +At call Set-up, the interrogating node passes in the "send routing information" to the HLR, the ISDN BC, LLC and HLC received in the initial address message. The coding of these parameters shall comply with Q.931 (05/98). For MT calls, and for backward compatibility purposes only, the mapping of the modem type according to ETS 300-102-1 (12/90) shall also be accepted, see note 12 of table 7B. + +The information possibly signaled backwards from the VMSC to the GMSC contained in the access transport parameter of the Answer message (ANM) can be used to perform service related functions (e.g. accounting) at the GMSC. + +### 10.2.2.3 Functions in HLR + +According to the contents of the Compatibility Information, i.e. the ISDN BC, LLC and HLC received, the HLR applies one of the following: + +- 1) No ISDN BC is received, or one from which a PLMN Basic Service cannot be deduced (i.e. with the information Transfer Capability field set to "3,1 kHz audio" but without any associated modem type1 in the ISDN BC and LLC, or without HLC indication of group 3 facsimile). Two cases shall be considered: + - a) The called MSISDN has a corresponding PLMN BC stored in the HLR (see 9.2.2.1); then the service attached to this number in the HLR tables is applicable and the corresponding PLMN BC is passed to the VLR in the "Provide Roaming Number" request. See figure 8; + - b) The called MSISDN has no corresponding PLMN BC stored in the HLR (see 9.2.2.2). In this case no PLMN BC is passed to the VLR in the "Provide Roaming Number" request. +- 2) Compatibility Information is received from which a PLMN Basic Service can be deduced, i.e. the ITC field in the ISDN BC is "unrestricted digital" and the fields for the applicable user layer 1 protocol and user rate (except + +--- + +1 "Modem type" in connection with the ITC value "3,1 kHz audio" means hereafter that either an ISDN BC modem type value is present or the autobauding modem function is indicated (see note 16 of table 7B) + +for the 64kbit/s case, see Note 22 Table 7B) are available (in either the ISDN BC or the LLC), or the ITC field is "3,1 kHz audio", and a modem type, user rate, etc. is indicated but the HLC does not indicate "facsimile group 3". The received ISDN BC (and possibly LLC plus HLC) is then considered applicable regardless of the kind of MSISDN received (PLMN BC associated or not) and either the equivalent PLMN BC or the original ISDN BC/LLC is sent to the VLR. In both cases the originally received HLC may also be sent to the VLR; see figure 9. + +As an exception to this the BC stored in the HLR is regarded as valid if one of the following cases applies: + +- If ITC = UDI/RDI and User Rate = 32 kbit/s /56 kbit/s and User information layer 1 protocol = V.110, I.460/X.30 and the stored BC indicates FTM, PIAFS or Multimedia. +- If ITC = 3,1 kHz audio and User Rate = 28.8 kbit/s and Modem Type = V.34 and the stored BC indicates Multimedia. + +When the HLR interworks with a GSM phase 1 VPLMN (VLR/VMSC), then the HLR shall convert the ISDN BC to the equivalent PLMN BC, and forward it to the VLR. In this case the LLC cannot be forwarded. + +- 3) Compatibility Information is received from which the PLMN Teleservice category Facsimile transmission can be deduced, i.e. the ITC field in the ISDN BC is "3,1kHz audio" and the HLC indicates "facsimile group 3" (see figure 9). The following two cases shall be considered: + - a) The called MSISDN has a corresponding PLMN BC stored in the HLR (indicating either TS 61 or TS 62). In this case the service attached to the MSISDN in the HLR tables is applicable and the corresponding PLMN BC is passed to the VLR in the "Provide Roaming Number" request; see also subclause 10.3.1.3; + - b) The called MSISDN has no corresponding PLMN BC stored in the HLR. In this case the HLR shall forward the appropriate PLMN BC to the VLR in line with the subscriber's subscription to Teleservice TS 61 or TS 62. + +For TS 61 the value of the PLMN BC parameter "Information Transfer Capability" shall be set to "alternate speech/facsimile group 3, starting with speech". + +In both cases the HLC should be passed to the VLR in the "Provide Roaming Number" request. + +Alternatively the HLR may forward the originally received ISDN/LLC/HLC, when interworking with a GSM or later phase 2 VLR + +- 4) If the Compatibility Information received does not allow the HLR to deduce a PLMN Bearer Service, i.e. the ITC field in the ISDN BC is "unrestricted digital", but without the fields indicating the applicable user layer 1 protocol, user rate, etc. (in either the ISDN BC or the ISDN LLC), then the call is managed as for a UDI call according to subclause 9.2.2, i.e. either the "multi numbering" or "single numbering" scenario is applied depending on which capability is provided by the home PLMN/HLR. +- 5) Compatibility information is received, the ITC field in the ISDN BC is "speech" and this value differs from the ITC field in the PLMN BC stored in the HLR. Then the PLMN BC stored in the HLR is considered applicable and shall be sent to the VLR. + +If the HLR supports the option to return the MAP "GSM Bearer Capability" to the GMSC in the MAP "Send Routing Information" response, it shall pass the PLMN-BC stored in the HLR if the latter is considered applicable as per the preceding rules. Otherwise no MAP "GSM Bearer Capability" shall be returned. This requirement shall apply irrespectively of whether the MAP "Send Routing Information" response contains a MAP "MSRN", "GMSC Camel Subscription Info", "Forwarding Data" or not. As an exception, to avoid transferring twice the MAP "GSM Bearer Capability" for a call involving two MAP "Send Routing Information" procedures to the HLR, the HLR should not include the MAP "GSM Bearer Capability" in the MAP "Send Routing Information" response if the MAP "Send Routing Information" request contains the MAP "Suppress T-CSI" IE. + +#### 10.2.2.4 Functions in VMSC + +When the incoming call arrives, the VMSC attempts to derive a PLMN basic service from the information received in the IAM, and requests information from the VLR to handle the call. In general, the LLC and HLC are sent with the PLMN BC to the UE at call set-up. In particular, however the following rules apply: + +- 1) If the Initial Address Message (IAM) contains no ISDN BC and no PLMN or ISDN BC/LLC/HLC was retrieved from the VLR, the call is handled as in subclause 9.2.2.2. + +- 2) If there is no ISDN BC in the IAM but a PLMN or ISDN BC/LLC/HLC was retrieved from the VLR, the PLMN or ISDN BC/LLC/HLC retrieved from the VLR applies. +- 3) If there is an ISDN BC in the IAM with the ITC field set to "3,1 kHz audio" but without any associated modem type or indication of facsimile group 3 in the HLC, the PLMN or ISDN BC/LLC/HLC retrieved from the VLR is considered as applicable when it exists. If no PLMN or ISDN BC is retrieved from the VLR, the call is handled as in subclause 9.2.2.2. +- 4) If there is an ISDN BC in the IAM with the ITC field set to "unrestricted digital information" and the fields for the applicable user layer 1 protocol and user rate (except for the 64kbit/s case; see note 22 to table 7B) are available (either in the ISDN BC or ISDN LLC), or if 3,1 kHz audio and a modem type is indicated, this ISDN BC is applicable regardless of what has been retrieved from the VLR. In this case the ISDN BC shall be mapped to an appropriate PLMN BC (refer to table 7B). + +As an exception to this the BC retrieved from the VLR is sent to the UE if one of the following applies: + +If ITC = UDI/RDI and User Rate = 32 kbit/s /56 kbit/s and User information layer 1 protocol = V.110, I.460/X.30 and the BC retrieved from the VLR indicates FTM, PIAFS or Multimedia. + +If ITC = 3,1 kHz audio and User Rate = 28,8 kbit/s and Modem Type = V.34 and the BC retrieved from the VLR indicates Multimedia. + +- 5) If there is an ISDN BC in the IAM with the ITC field set to "3,1kHz audio" and there is an HLC indicating "facsimile group 3", the PLMN BC retrieved from the VLR is applicable when it exists. If a PLMN BC with the parameter "information transfer capability" set to "alternate speech/facsimile group 3, starting with speech" (i.e. TS 61) is retrieved from the VLR, this shall be mapped to two PLMN BC-IEs preceded by a repeat indicator, one representing speech, the other representing facsimile group 3. + +For TS 61, the order in which the two PLMN BC-IEs are sent towards the UE in the setup message is a network option. + +- 6) If there is an ISDN BC in the IAM with the ITC field set to "unrestricted digital information" but without applicable "user layer 1 protocol" and "user rate", etc. fields, in either the ISDN BC no the ISDN LLC, then the PLMN or ISDN BC/LLC retrieved from the VLR is applicable, if available, otherwise subclause 9.2.2.2 applies. +- 7) If there is an ISDN BC in the IAM with the ITC field set to "Speech" and this value differs from the ITC field of the BC retrieved from the VLR for this call, then the BC/LLC/HLC retrieved from the VLR is considered applicable. If no PLMN or ISDN BC is retrieved from the VLR, the call is handled as in subclause 9.2.2.2. + +In all cases where the VMSC retrieves a PLMN BC from the VLR, the VMSC may add or modify PLMN-specific parameters in the PLMN BC, as described in subclause 9.2.2, before sending the PLMN BC-IE towards the UE. + +In all cases when no PLMN or ISDN BC is retrieved from the VLR and no ISDN Compatibility information allowing deduction of a PLMN Bearer Service is available, then no PLMN BC is inserted by the VMSC and subclause 9.2.2.2 applies. + +The mapping between PLMN and ISDN BCs is shown in table 7. + +The UE may negotiate parameters with the MSC according to the rules defined in 3GPP TS 27.001. If the UE proposes to the network to modify the User Rate as well as the correlated parameters Modem Type and Intermediate Rate in the call confirmed message, the network may accept or release the call (see 3GPP TS 27.001). For multislot, 14.4kbit/s, EDGE and Iu Mode operations, the UE may also propose to the network to modify the Fixed Network User Rate and Other Modem Type parameters (see 3GPP TS 27.001). In case a transparent service is used, the call shall be released. For a non-transparent service with flow control, the MSC/IWF shall use towards the fixed network the unmodified "fixed network user rate" and shall use the "wanted air interface user rate" or the modified "fixed network user rate" towards the user equipment. + +The VMSC may map the received PLMN BC into an ISDN BC according to the rules defined in table 7A. This ISDN BC can be transported together with possibly available LLC and HLC in the access transport parameter of the Answer message (ANM) according to ITU-T Q.763. + +#### 10.2.2.4A Functions in VLR + +When the VLR receives from the VMSC a request for information to handle an incoming call, it performs two functions: + +- 1) It determines the basic service which applies for the call, according to the following principles: + - a) If the basic service received in the request from the VMSC was the same as the basic service indicated by the compatibility information received in the "Provide Roaming Number" request, the VLR applies that basic service. + - b) If the basic service received in the request from the VMSC was Telephony but the compatibility information received in the "Provide Roaming Number" request indicated a basic service different from Telephony, the VLR applies the basic service derived from the compatibility information received in the "Provide Roaming Number" request. + - c) If the basic service received in the request from the VMSC was Facsimile Group 3 and the compatibility information received in the "Provide Roaming Number" request indicated Alternate Speech and Facsimile Group 3, the VLR applies the basic service Alternate Speech and Facsimile Group 3. + - d) If the basic service received in the request from the VMSC was Telephony and no compatibility information was received in the "Provide Roaming Number" request, the VLR applies the basic service Telephony. + - e) If the basic service received in the request from the VMSC was Facsimile Group 3 but no compatibility information was received in the "Provide Roaming Number" request, the VLR checks the subscription information stored in its database, and applies the appropriate subscribed basic service (Facsimile Group 3 or Alternate Speech and Facsimile Group 3). + - f) If the basic service received in the request from the VMSC was anything except Telephony or Facsimile Group 3, the VLR applies the basic service received in the request from the VMSC, regardless of any information received in the "Provide Roaming Number" request or stored subscription information. + - g) If no basic service was received in the request from the VMSC but compatibility information was received in the "Provide Roaming Number" request, the VLR applies the basic service derived from the compatibility information received in the "Provide Roaming Number" request. + - h) If no basic service was received in the request from the VMSC and no compatibility information was received in the "Provide Roaming Number" request, the VLR applies the basic service determined by the network operator, taking account of the subscribed basic services. +- 2) It returns compatibility information (PLMN BC or ISDN BC, and possibly ISDN HLC and ISDN LLC, according to the following principles: + - a) If the request from the VMSC included a basic service Facsimile Group 3, the VLR checks the subscription information stored in its database, and returns the appropriate compatibility information according to the subscribed basic service: + - i) A PLMN BC with the parameter "information transfer capability" set to "alternate speech/facsimile group 3, starting with speech" (i.e. TS 61) if the subscribed basic service is Alternate Speech and Facsimile Group 3; + - ii) A PLMN BC with the parameter "information transfer capability" set to " facsimile group 3" (i.e. TS 62) if the subscribed basic service is Facsimile Group 3. + - b) If the request from the VMSC did not include a basic service Facsimile Group 3 and compatibility information was received in the "Provide Roaming Number" request, the VLR processes the compatibility information received in the "Provide Roaming Number" request: + - i) If the compatibility information received in the "Provide Roaming Number" request consisted of an ISDN BC/LLC/HLC the VLR maps this to an appropriate PLMN BC as shown in table 7B. + - ii) If the compatibility information received in the "Provide Roaming Number" request consisted of a PLMN BC, possibly with an ISDN LLC/HLC, the VLR retains the PLMN BC + +- c) If the request from the VMSC did not include a basic service Facsimile Group 3 and no compatibility information was received in the "Provide Roaming Number" request, the VLR sends no compatibility information to the VMSC. + +## 10.2.2.5 Call Flows + +![Sequence diagram showing call flow for a mobile terminated, ISDN originated call. Lifelines: UE, VMSC, VLR, HLR, IN. The sequence starts with an incoming call from IN to HLR, followed by routing information exchange between HLR, VLR, and VMSC. The VMSC then sends a Setup message to the UE. The UE responds with Call Conf. and Connect messages. The VMSC also sends an ANM message to the IN. Various parameters like (BCgk), (MSRN), (3,1 kHz, MSISDNk), (BC' gk), (BC''gk), and (BC'''gk) are shown in the messages.](ddee3e67e0dfc22e25188fa635a19558_img.jpg) + +``` + +sequenceDiagram + participant IN + participant HLR + participant VLR + participant VMSC + participant UE + + Note right of IN: (1) + IN->>HLR: IAM (3,1 kHz, MSISDNk) + HLR->>VLR: SRI (3,1 kHz, MSISDNk) + VLR->>HLR: PRN (BCgk) + HLR->>VLR: (MSRN) + HLR->>IN: (MSRN) + VLR->>VMSC: IAM (3,1 kHz, MSRN) + VMSC->>VLR: SIFICSU (MSRN) + VLR->>VMSC: Comp. Call (BC' gk) + VMSC->>UE: Setup (BC' gk) + Note right of UE: (2) + UE->>VMSC: Call Conf. (BC''gk) + Note right of VMSC: (3) + VMSC->>IN: ANM (BC'''gk) + +``` + +Sequence diagram showing call flow for a mobile terminated, ISDN originated call. Lifelines: UE, VMSC, VLR, HLR, IN. The sequence starts with an incoming call from IN to HLR, followed by routing information exchange between HLR, VLR, and VMSC. The VMSC then sends a Setup message to the UE. The UE responds with Call Conf. and Connect messages. The VMSC also sends an ANM message to the IN. Various parameters like (BCgk), (MSRN), (3,1 kHz, MSISDNk), (BC' gk), (BC''gk), and (BC'''gk) are shown in the messages. + +- NOTE: (1) Some parameters of BCgk may be provided/modified according to the MSC's capabilities/preferences. See subclause 9.2.2. + (2) In the "Call Confirm" message, the UE may modify some parameters of the PLMN BC. See subclause 9.2.2. + (3) The VMSC may map the PLMN BC (BC''gk) into an ISDN BC (BC'''gk) according to the rules defined in table 7A + (4) Abbreviations: see figure 2. + +**Figure 8: Call Flow for a mobile terminated, ISDN originated call** + where compatibility information provided are not exhaustive for deducing a PLMN Bearer Service, + but Information Transfer Capability = 3,1 kHz audio, no modem type and no HLC IE indicating + facsimile group 3 HLR stores PLMN BC against MSISDN number multi-numbering scheme + +![Sequence diagram showing the call flow for a mobile terminated, ISDN originated call. The diagram involves five entities: UE, VMSC, VLR, HLR, and IN. The sequence of messages is as follows: (1) IN sends IAM (LLC HLC BCij) to HLR; (2) HLR sends SRI (LLC HLC BCij) to IN; (3) HLR sends PRN (GSM BCgj/HLC or BCij/LLC/HLC) to VLR; (4) VLR sends (MSRN) to HLR; (5) HLR sends (MSRN) to IN; (6) IN sends IAM (BC'i,j, MSRN) to VMSC; (7) VMSC sends SIFICSU (MSRN) to VLR; (8) VLR sends Comp. Call (GSM BCgj/HLC or BCij/LLC/HLC) to VMSC; (9) VMSC sends Setup (BC'gj, LLC, HLC) to UE; (10) UE sends Call Conf. (BC''gj, LLC, HLC) to VMSC; (11) VMSC sends ANM (BC'''gj, LLC, HLC) to IN; (12) IN sends Connect to VMSC.](32ff77da4286b58c4778033acaa10836_img.jpg) + +``` + +sequenceDiagram + participant IN + participant HLR + participant VLR + participant VMSC + participant UE + + Note right of IN: (1) + IN->>HLR: IAM (LLC HLC BCij) + Note right of HLR: (6) + HLR->>IN: SRI (LLC HLC BCij) + Note right of HLR: (1) + HLR->>VLR: PRN (GSM BCgj/HLC or BCij/LLC/HLC) + Note right of VLR: (6) + VLR->>HLR: (MSRN) + Note right of HLR: (2) + HLR->>IN: (MSRN) + IN->>VMSC: IAM (BC'i,j, MSRN) + Note right of VMSC: (3) + VMSC->>VLR: SIFICSU (MSRN) + VLR->>VMSC: Comp. Call (GSM BCgj/HLC or BCij/LLC/HLC) + VMSC->>UE: Setup (BC'gj, LLC, HLC) + Note right of UE: (4) + UE->>VMSC: Call Conf. (BC''gj, LLC, HLC) + Note right of VMSC: (5) + VMSC->>IN: ANM (BC'''gj, LLC, HLC) + Note right of IN: (7) + IN->>VMSC: Connect + +``` + +Sequence diagram showing the call flow for a mobile terminated, ISDN originated call. The diagram involves five entities: UE, VMSC, VLR, HLR, and IN. The sequence of messages is as follows: (1) IN sends IAM (LLC HLC BCij) to HLR; (2) HLR sends SRI (LLC HLC BCij) to IN; (3) HLR sends PRN (GSM BCgj/HLC or BCij/LLC/HLC) to VLR; (4) VLR sends (MSRN) to HLR; (5) HLR sends (MSRN) to IN; (6) IN sends IAM (BC'i,j, MSRN) to VMSC; (7) VMSC sends SIFICSU (MSRN) to VLR; (8) VLR sends Comp. Call (GSM BCgj/HLC or BCij/LLC/HLC) to VMSC; (9) VMSC sends Setup (BC'gj, LLC, HLC) to UE; (10) UE sends Call Conf. (BC''gj, LLC, HLC) to VMSC; (11) VMSC sends ANM (BC'''gj, LLC, HLC) to IN; (12) IN sends Connect to VMSC. + +- NOTES: (1) BCij denotes ISDN BC\*; BCgj is the corresponding PLMN BC. + (2) Assumes signalling capabilities permit the transfer of BC between IN and VMSC. If this is not the case, the VLR uses the stored BC/LLC/HLC. + (3) BC'ij denotes BCij as maybe modified by intervening networks. + (4) Some parameters of BCgj may be provided/modified according to the MSC's capabilities/preferences. See subclause 9.2.2. + (5) In the "Call Confirm" message, the UE may modify some parameters of the BC. See subclause 9.2.2. + (6) For details on how the BC, HLC, and LLC are transported, refer to 3GPP TS 29.002. + \* HLC and LLC refers to ISDN values. + (7) The VMSC may map the PLMN BC (BC'gj, LLC, HLC) into an ISDN BC (BC'''gj, LLC, HLC) according to the rules defined in table 7A + (8) Abbreviations: see figure 2. + +**Figure 9: Call Flow for a mobile terminated, ISDN originated call** +**where compatibility information provided are sufficient information to deduce a PLMN Bearer Service** +**or Information Transfer Capability = 3,1 kHz audio with HLC IE indicating facsimile group 3** + +### 10.2.2.6 Mapping Functions + +The following tables (7A + 7B) show that only the ISDN BC is used for mapping (exceptions are indicated). + +NOTE: The ISDN/PLMN BC-IE mapping shall be performed as specified in tables 7A and 7B. This shall be done to allow setup of a compatible end-to-end connection between two UEs or one UE and an ISDN terminal. + +In the following tables 7A and 7B the comparison is drawn between parameters in the PLMN call set up request message and that of the ISDN call set up request message. In some cases no comparable values are available and these will be marked as such. In these cases reference will need to be made to the table of network interworking in 3GPP TS 29.007 to identify the appropriate choice. In some cases it is not necessary to support a particular option, and in this case those parameters will be annotated appropriately. + +The PLMN parameters and values are as in 3GPP TS 24.008 in combination as in 3GPP TS 27.001. The ISDN parameters and values are as in Q.931 (05/98). + +**Table 7A: Comparable setting of parameters in PLMN and ISDN: Mobile Originated** + +| Octet | PLMN BC parameter value | Octet | ISDN BC parameter value | +|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Bearer Capability IEI | 1 | Bearer Capability IEI | +| 2 | Length of BC contents | 2 | Length of BC contents | +| 3
#7..6 | Radio channel requirement
half rate channel
full rate channel
dual, full, rate preferred
dual, half rate preferred | | No comparable field | +| 3
#5 | Coding Standard
GSM standard coding | 3
#7..6 | Coding Standard
CCITT standardized coding | +| 3
#4 | Transfer mode
circuit mode
packet mode (note 7) | 4
#7..6 | Transfer mode
circuit mode
packet mode | +| 3
#3..1 | Information transfer capability
speech
unrestricted digital
3,1 kHz audio ex PLMN
facsimile group 3 (note 1)
other ITC (see octet 5a) | 3
#5..1 | Information transfer capability
speech
unrestricted digital
3,1 kHz audio
3,1 kHz audio
no comparable value | +| 5a
#7..6 | Other ITC
restricted digital | | (note 18) | +| 4
#7 | Compression (note 14)
data compression allowed
data compression not allowed | | No comparable field | +| 4
#6..5 | Structure
SDU integrity
unstructured | 4a
#7..5 | Structure (note 4) | +| 4
#4 | Duplex mode
half duplex
full duplex | 5d
#7 | Duplex mode
half duplex
full duplex | +| 4
#3 | Configuration
point to point | 4a
#4..3 | Configuration (note 4) | +| 4
#1 | Establishment
demand | 4a
#2..1 | Establishment (note 4) | +| 4 | NIRR (note 12)
no meaning
Data $\leq$ 4.8kbit/s, FR nt,
6kbit/s radio interface is requested | | No comparable field | +| 5
#5..4 | Rate adaptation
no rate adaptation (note 2)
V.110, I.460/X.30 rate adaptation

CCITT X.31 flag stuffing (note 25)

No comparable value(note 11)
No comparable value(note 11)

No comparable value(note 11)

other rate adaptation (see octet 5a) | 5
#5..1 | User information layer 1 protocol
no comparable value
CCITT standardized rate adaption
V.110, I.460/X.30
(note 25)
Recommendation G.711 $\mu$ -law
Recommendation G.711 A-law (note 3)
Recommendation G.721 32 kbit/s
ADPCM and I.460
No comparable value | +| 5a
#5..4 | Other rate adaptation
V.120 (note 17)
PIAFS (note 27)
H.223 & H.245 | | No comparable value

H.223 & H.245 (note 26) | +| 5
#3..1 | Signalling access protocol
I.440/I.450
X.21 (note 24)
X.28, ded.PAD, indiv.NUI (note 24)
X.28, ded PAD, univ.NUI (note 24)
X.28, non-ded PAD (note 24)
X.32 (note 24) | | No comparable field | +| 6
#1 | Synchronous/asynchronous
synchronous
asynchronous | 5a
#7 | Synchronous/asynchronous
synchronous
asynchronous | +| 6
#5..2 | User info. layer 1 protocol
default layer 1 protocol | 5
#5..1 | User info. layer 1 protocol
see section under rate adaptation for
3GPP TS 24.008 above | + +| Octet | PLMN BC parameter value | Octet | ISDN BC parameter value | +|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 6a
#7 | Number of stop bits
1 bit
2 bits | 5c
#7..6 | Number of stop bits
1 bit
2 bits | +| 6a
#6 | Negotiation
In band neg. not possible
no comparable value | 5a
#6 | Negotiation
In band neg. not possible
In band neg. possible (note 10) | +| 6a
#5 | Number of data bits

7 bits
8 bits | 5c
#5..4 | Number of data bits excluding parity if present
7 bits
8 bits | +| 6a
#4..1 | User rate
0.3 kbit/s
1.2 kbit/s
2.4 kbit/s
4.8 kbit/s
9.6 kbit/s
12 kbit/s (note 7)
1.2 kbit/s / 75 bit/s (note 24)
any value
no comparable value | 5a
#5..1 | User rate
0.3 kbit/s
1.2 kbit/s
2.4 kbit/s
4.8 kbit/s
9.6 kbit/s
12 kbit/s
75 bit/s / 1.2 kbit/s
19.2 kbit/s (note 14)
Ebites or inband negotiation (note 10) | +| 6b
#7..6 | Intermediate rate
8 kbit/s
16 kbit/s
any value | 5b
#7..6 | Intermediate rate (note 13)
8 kbit/s or not used
16 kbit/s or not used
32 kbit/s or not used (note 14) | +| 6b
#5 | NIC on Tx
does not require
requires (note7) | 5b
#5b | NIC on Tx
does not require
requires (note 8) | +| 6b
#4 | NIC on Rx
cannot accept
can accept (note 7) | 5b
#4 | NIC on Rx
cannot accept
can accept (note 8) | +| 6b
#3..1 | Parity information
odd
even
none
forced to 0
forced to 1 | 5c
#3..1 | Parity information
odd
even
none
forced to 0
forced to 1 | +| 6c
#7..6 | Connection element
transparent
non-transparent (RLP)
both, transp. preferred
both, non-transp. preferred | | No comparable field | +| 6c
#5..1 | Modem type
none
V.21
V.22
V.22bis
V.23 (note 24)
V.26ter
V.32
modem for undef. interface
autobauding type 1 | 5d
#6..1 | Modem type
no comparable value (note 5)
V.21
V.22
V.22bis
V.23
V.26ter
V.32
No comparable value (note 5)
No comparable value (note 5, note 10) | +| 7
#5..1 | User info. layer 2 protocol
X.25 link level (note 24)
ISO 6429, codeset 0
COPnoFICt
videotex profile 1 (note 7)
X.75 layer 2 modified (CAPI) (note 24) | 6 | User info.layer 2 prot. (note 6)
X.25 link level
no comparable value
no comparable value
no comparable value
X.25 link level | + +| Octet | PLMN BC parameter value | Octet | ISDN BC parameter value | +|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 6d
#5..1 | Fixed network user rate (note 15)
FNUR not applicable (note 7)
9,6 kbit/s
12 kbit/s (note 7)
14,4 kbit/s
19,2 kbit/s
28,8 kbit/s
32,0 kbit/s
33,6 kbit/s
38,4 kbit/s
48,0 kbit/s
56,0 kbit/s
64,0 kbit/s | 5a
#5..1 | User rate
no comparable value
9,6 kbit/s
12 kbit/s
14,4 kbit/s
19,2 kbit/s
28,8 kbit/s
32,0 kbit/s
no comparable value
38,4 kbit/s
48,0 kbit/s
56,0 kbit/s
no comparable value (note 16) | +| 6e
#3..1 | Maximum number of traffic channels
1 TCH
2 TCH
3 TCH
4 TCH
5 TCH
6 TCH
7 TCH (note 7)
8 TCH (note 7) | | No comparable field | +| 6f
#4..1 | Wanted air interface user rate (note 23)
air interface user rate not applicable (note 7)
9,6 kbit/s
14,4 kbit/s
19,2 kbit/s
28,8 kbit/s
38,4 kbit/s
43,2 kbit/s
57,6 kbit/s
interpreted by the network as 38.4 kbit/s (note 7) | | No comparable field | +| 6d
#7..6 | Other modem type (note 15)
No other modem type
V.34 | 5d
#6..1 | Modem type
no comparable value
V.34 | +| 6e
#7..4 | Acceptable channel coding(s)
TCH/F4.8 acceptable (note 19)
TCH/F9.6 acceptable
TCH/F14.4 acceptable | | No comparable field | +| 6f
#7..5 | User initiated modification indicator (note 23)
User initiated modification not required
User initiated modification upto 1
TCH/F may be requested
User initiated modification upto 2
TCH/F may be requested
User initiated modification upto 3
TCH/F may be requested
User initiated modification upto 4
TCH/F may be requested | | No comparable field | +| 6g
#7..5 | Acceptable channel coding(s) (note 20)
TCH/F28.8 acceptable
TCH/F32.0 acceptable
TCH/F43.2 acceptable (note 22) | | No comparable field | +| 6g
#4..3 | Asymmetry preference indication (Note 23)
no preference
up link biased asymmetry preference
down link biased asymmetry preference | | No comparable field | + +The application rules for coding the information elements ISDN-BC/LLC/HLC as set out in ETR 018 and Q.931 (05/98) shall apply. + +Other field values in the ISDN BC-IE not supported in 3GPP TS 24.008 are: + +Information transfer rate:                     In this case default 64 kbit/s is selected. + +Flow control on transmission: + +Flow control on reception:                   This shall be selected if outband flow control applies. Outband flow control is indicated by the absence of the UIL2P parameter for non-transparent connections. + +User information layer 3 protocol:       Octet 7 shall not be sent unless specific application rules are given for particular cases (to be defined by PLMN). End-to-end significant User Information layer 3 protocol shall be sent by LLC. + +Notes regarding particular entries in table 7A: + +**NOTE 1:** If the PLMN BC "Information Transfer Capability" indicates "Facsimile group 3" and only a single PLMN BC is contained in the call set-up request then this shall be mapped to an ISDN BC with: + +- coding standard:                                 CCITT; +- information transfer capability: 3,1 kHz audio; +- transfer mode:                                 circuit; +- information transfer rate:               64 kbit/s; +- user layer 1 protocol:                       G711 A-law or $\mu$ -law (PCS-1900); and +- if an HLC is not present, the network will insert a "Facsimile group 2/3" HLC; +- if an HLC element is present, the network will pass it through unmodified. + +If the PLMN BC "Information Transfer Capability" indicates "Facsimile group 3" and two PLMN BCs are contained in the call set-up request, then the same ISDN BC as mentioned above is created. If the first PLMN BC indicates "facsimile group 3" an HLC "facsimile group 2/3" will be inserted by the network (if not received from the UE). However if the first PLMN BC indicates "speech", the network will not send a HLC, irrespective where a HLC was received from the UE or not. + +**NOTE 2:** This value is present in combination with information transfer capability parameter value "3,1 kHz audio Ex PLMN" or "facsimile group 3" and will therefore be mapped to the value "Recommendation G.711 A-law" or "Recommendation G.711 $\mu$ -law" (PCS-1900) of the Q.931 (05/98) parameter user layer 1 protocol (see note 3). + +**NOTE 3:** The value "Recommendation G.711 A-law" or "Recommendation G.711 $\mu$ -law" (PCS-1900) applies only when the Q.931 (05/98) parameter information transfer capability indicates "3,1 kHz audio" or "speech". + +**NOTE 4:** When interworking with an ISDN according to ETS 300 102-1 octets 4a and 4b shall not be included because default values apply. In an ISDN according to Q.931 (05/98) these octets no more exist. + +**NOTE 5:** In this case octet 5d shall not be included. + +**NOTE 6:** Octet 6 shall not be sent unless specific application rules are given for a particular case (PLMN specified). End-to-end significant user information layer 2 protocol shall be sent by LLC. + +**NOTE 7:** Not used for currently defined Bearer Services and Teleservices. + +**NOTE 8:** These values will only be set if the "Information Transfer Capability" indicates "3,1 kHz audio", synchronous data transmission is used and octet 5b of the ISDN BC is present. + +**NOTE 9:** (VOID). + +NOTE 10: The PLMN BC-IE parameter value "autobauding modem type 1" will be mapped to the ISDN BC-IE parameter values "inband negotiation possible" and "user rate indicated by E-bits specified in ITU-T Recommendation I.460 or may be negotiated inband" (octet 5a of ISDN BC-IE). If data compression is used, high speed modems, like V.32bis, V.34 and/or V.90 may be used in the IWF. Autobauding may also be used to support user rates less than 9.6 kbit/s towards the PSTN. + +NOTE 11: The ITC value of the PLMN BC-IE "speech", "3,1 kHz audio Ex PLMN" will indicate these requirements. + +NOTE 12: For the use of NIRR see 3GPP TS 27.001. + +NOTE 13: The value of the Intermediate Rate field of the ISDN Bearer Capability information element shall only depend on the values of the User Rate and the Information Transfer Capability in the same information element. The correspondence is: + +Intermediate Rate = not used if User Rate > than 19.2 kbit/s. + Intermediate Rate = 32 kbit/s if User Rate = 19,2 kbit/s or 14.4 kbit/s. + Intermediate Rate = 16 kbit/s if User Rate = 9,6 kbit/s. + Intermediate Rate = 8 kbit/s otherwise. + +For Audio calls the value of the Intermediate Rate may be set to "not used". + +NOTE 14: If compression is supported by the MSC and "data compression allowed" is indicated, then the ISDN user rate for UDI calls shall be set as follows. If the parameter "FNUR" is present the ISDN user rate shall be set to this value. Otherwise the PLMN user rate shall be mapped to an equal or any higher ISDN user rate value (for V.110 the highest ISDN user rate shall be 19,2 kbit/s). The Intermediate Rate shall be set to an appropriate value.(see subclause 10.2.4.11). + +For "3,1 kHz audio" the modem shall try to negotiate data compression and flow control (see subclause 9.2.4.11). For "autobauding type 1" high speed modems may be used (see note 10). + +NOTE 15: User rate of the PLMN -BC is overridden by the fixed network user rate of the PLMN BC-IE if available. When the MT indicates „autobauding", „modem for undefined interface" or „none", the other modem type shall be set to „no other modem type"; any other value of the modem type is overridden by the other modem type value (see 3GPP TS 27.001). In Iu mode, if octet 6d is not present in the PLMN BC, the MSC shall reject the call. The support of user rates lower than 9.6 kbit/s in Iu mode are only possible in the scope of autobauding (see note 10). + +NOTE 16: In the case Other rate adaptation = H.223 & H.245 the ISDN BC-IE shall be coded as follows: + +Coding standard: ITU-T + Information Transfer capability: UDI + Transfer mode: circuit + Information transfer rate: 64 kbit/s + User information layer 1 protocol: H.223 & H.245 + +In all the other cases the ISDN-BC will consist of the octets 1 to 4 only, coded: + +Coding standard: CCITT + Information Transfer capability: UDI + Transfer mode: circuit + Information transfer rate: 64 kbit/s + +NOTE 17: V.120 interworking is selected. + +If an LLC element is not present, the network will insert an LLC. If an LLC is present it may be modified. The PLMN -BC parameters negotiated with the UE shall be mapped to the LLC parameters. The LLC parameter Rate Adaptation will be set to "V.120". + +When interworking with unrestricted 64 kbit/s networks the ISDN BC shall be coded according to note 16. + +NOTE 18: When the MSC is directly connected to a restricted 64 kbit/s network, the ISDN BC-IE is coded with an ITC = RDI. + +When indirectly interworking with a restricted 64 kbit/s network the ISDN BC-IE shall be coded according to ETR 018, as shown below: + +| | | +|------------------------------------|----------------------------------| +| Coding standard: | CCITT | +| Information Transfer capability: | UDI | +| Transfer mode: | circuit | +| Information transfer rate: | 64 kbit/s | +| User information layer 1 protocol: | V.110/X.30 | +| Synchronous/Asynchronous: | synchronous | +| Negotiation: | In-band negotiation not possible | +| User rate: | 56 kbit/s | + +If an LLC element is not present, the network will insert an LLC. If an LLC is present it may be modified. The PLMN -BC parameters negotiated with the UE shall be mapped to the LLC parameters according to the rules in this table. The LLC parameter Information Transfer Capability will be set to „restricted digital“ + +NOTE 19: If the UE signals an ACC containing TCH/F4.8 only and the network does not support TCH/F4.8 channel coding, then the MSC may act as if TCH/F9.6 were included in the ACC. + +NOTE 20: Extension of the 'Acceptable channel codings' field in octet 6e if EDGE channel codings are supported. + +NOTE 21: Void + +NOTE 22: Only applicable for non-transparent services. + +NOTE 23: This parameter shall be included if EDGE channel codings are indicated in ACC. In cases where this parameter would not otherwise be included, the value is set to 'Air interface user rate not applicable' or 'User initiated modification not requested' or 'No preference'. + +NOTE 24: This value was used by services defined for former PLMN releases and does not need to be supported. + +NOTE 25: The case of FTM is identified by Rate adaptation in the PLMN BC-IE set to "CCITT X.31 flag stuffing", Connection element set to "non-transparent", and Synchronous/asynchronous set to "asynchronous". The MSC applies one of the following alternatives: + +1) IF FNUR=64 kbit/s + +- the ISDN BC-IE shall be coded as follows: + +| | | +|----------------------------------|-----------| +| Coding standard: | ITU-T | +| Information Transfer capability: | UDI | +| Transfer mode: | circuit | +| Information transfer rate: | 64 kbit/s | + +- the LLC-IE shall be coded according to ETR 018 as follows: + +| | | +|------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------| +| Coding standard: | ITU-T | +| Information Transfer capability: | UDI | +| Transfer mode: | circuit | +| Information transfer rate: | 64 kbit/s | +| User information layer 1 protocol: | (CCITT standardized rate adaptation X.31 HDLC flag stuffing) (note: the absence of octet 5 indicates that HDLC flag stuffing applies) | +| User information layer 2 protocol: | Recommendation X.25, link layer | +| User information layer 3 protocol: | Recommendation X.25, packet layer | + +If user information layer 1 protocol is indicated by absence of octet 5 user information layer 2/3 protocol are also absent. + +2) If FNUR=56 kbit/s and the MSC is directly connected to a restricted 64 kbit/s network: + +- the ISDN BC-IE shall be coded as follows: + +| | | +|----------------------------------|-----------| +| Coding standard: | ITU-T | +| Information Transfer capability: | RDI | +| Transfer mode: | circuit | +| Information transfer rate: | 64 kbit/s | + +- the LLC-IE shall be coded as follows: + +| | | +|------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------| +| Coding standard: | ITU-T | +| Information Transfer capability: | RDI | +| Transfer mode: | circuit | +| Information transfer rate: | 64 kbit/s | +| User information layer 1 protocol: | (CCITT standardized rate adaptation X.31 HDLC flag stuffing) (note: the absence of octet 5 indicates that HDLC flag stuffing applies) | +| User information layer 2 protocol: | Recommendation X.25, link layer | +| User information layer 3 protocol: | Recommendation X.25, packet layer | + +If user information layer 1 protocol is indicated by absence of octet 5 user information layer 2/3 protocol are also absent. + +3) If FNUR=56 kbit/s and the MSC is indirectly interworking with a restricted 64 kbit/s network: + +- the ISDN BC-IE shall be coded according to ETR 018, as shown below: + +| | | +|------------------------------------|----------------------------------| +| Coding standard: | ITU-T | +| Information Transfer capability: | UDI | +| Transfer mode: | circuit | +| Information transfer rate: | 64 kbit/s | +| User information layer 1 protocol: | V.110/X.30 | +| Synchronous/Asynchronous: | synchronous | +| Negotiation: | In-band negotiation not possible | +| User rate: | 56 kbit/s | + +- If an LLC element is not present, the network will insert an LLC. If an LLC is present it may be modified. The PLMN -BC parameters negotiated with the MS shall be mapped to the LLC parameters according to the rules in this table. The LLC parameter Information Transfer Capability will be set to „restricted digital" and the LLC parameter User information layer 1 protocol will be set to “X.31 flag stuffing”. + +NOTE 26: If FNUR=64 kbit/s the ISDN BC-IE shall be coded as follows: + +| | | +|------------------------------------|-----------------| +| Coding standard: | ITU-T | +| Information Transfer capability: | UDI | +| Transfer mode: | circuit | +| Information transfer rate: | 64 kbit/s | +| User information layer 1 protocol: | H.223 and H.245 | + +If FNUR=56 kbit/s the ISDN BC-IE shall be coded as in note 18. + +If FNUR=32 kbit/s the ISDN BC-IE shall be coded as follows: + +| | | +|------------------------------------|----------------------------------| +| Coding standard: | ITU-T | +| Information Transfer capability: | UDI | +| Transfer mode: | circuit | +| Information transfer rate: | 64 kbit/s | +| User information layer 1 protocol: | V.110, I.460 & X.30 | +| Synchronous/Asynchronous: | synchronous | +| Negotiation: | In-band negotiation not possible | +| User rate: | 32 kbit/s | + +If FNUR=28.8 kbit/s the ISDN BC-IE shall be coded as follows: + +| | | +|------------------------------------|----------------------------------| +| Coding standard: | ITU-T | +| Information Transfer capability: | 3,1 kHz Audio | +| Transfer mode: | circuit | +| Information transfer rate: | 64 kbit/s | +| User information layer 1 protocol: | G.711 A-law or $\mu$ -law | +| Synchronous/Asynchronous: | synchronous | +| Negotiation: | In-band negotiation not possible | +| Modem type: | V.34 | +| User rate: | 28.8 kbit/s | + +If FNUR=33.6 kbit/s the ISDN BC-IE shall be coded as follows: + +| | | +|------------------------------------|---------------------------| +| Coding standard: | ITU-T | +| Information Transfer capability: | 3,1 kHz Audio | +| Transfer mode: | circuit | +| Information transfer rate: | 64 kbit/s | +| User information layer 1 protocol: | G.711 A-law or $\mu$ -law | + +NOTE 27: If FNUR=32 kbit/s the ISDN BC-IE shall be coded for PIAFS as follows: + +| | | +|------------------------------------|----------------------------------| +| Coding standard: | ITU-T | +| Information Transfer capability: | UDI | +| Transfer mode: | circuit | +| Information transfer rate: | 64 kbit/s | +| User information layer 1 protocol: | V.110, I.460 and X.30 | +| Synchronous/Asynchronous: | synchronous | +| Negotiation: | In-band negotiation not possible | +| User rate: | 32 kbit/s | + +If FNUR=64 kbit/s the ISDN BC-IE shall be coded for PIAFS as in note 16. + +**Table 7B: Comparable setting of parameters in PLMN and ISDN: Mobile Terminated** + +| Octet | ISDN BC parameter value | Octet | PLMN BC parameter value | +|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Bearer Capability IEI | 1 | Bearer Capability IEI | +| 2 | Length of BC contents | 2 | Length of BC contents | +| | no comparable field | 3
#7..6 | Radio channel requirement
full rate channel (these bits are spare in the network to UE direction) | +| 3
#7..6 | Coding standard
CCITT standardized coding | 3
#5 | Coding standard
GSM standardized coding | +| 3
#5..1 | Information transfer capability
speech
unrestricted digital
3,1 kHz audio
no comparable value
no comparable value
7 kHz audio
video
(note 23) | 3
#3..1 | Information transfer capability
speech
unrestricted digital
3,1 kHz audio ex PLMN (note2)
facsimile group 3 (note 3)
other ITC (see octet 5a)
not supported
not supported | +| | | 5a
#7..6 | Other ITC
restricted digital | +| 4
#7..6 | Transfer mode
circuit mode
packet mode | 3
#4 | Transfer mode
circuit mode
not supported | +| 4
#5..1 | Information transfer rate
64 kbit/s | | no comparable field | +| | No comparable field | 4
#7 | Compression (note 18)
data compression possible
data compression not possible | +| | No comparable field (note 4) | (4) 4
#6..5 | Structure (note 9)
SDU integrity
unstructured | +| 4a
#4..3 | No comparable field (note 4) | 4
#3 | Configuration
point-to-point (note 5) | +| | No comparable field | 4
#2 | NIRR (note 17)
No meaning
Data $\leq$ 4.8 kbit/s, FR nt,
6 kbit/s radio interface requested | +| 4a
#2..1 | No comparable field (note 4) | 4
#1 | Establishment
demand (note 5) | +| 4b
#7..6 | | | | +| 4b
#5..1 | | | | +| 5
#5..1 | User information layer 1 protocol
no comparable value
CCITT V.110, I.460 / X.30
G.711 A-law
CCITT X.31 flag stuffing
no comparable value

No comparable value

H.221 & H.242(note 28)
H.223 & H.245 | 5
#5..4 | Rate adaption
no rate adaption (note 11)
V.110, I.460/X.30 rate adaption
no comparable value
not supported
other rate adaption (see octet 5a) | +| | | 5a
#5..4 | Other rate adaptation
V.120 (note 24)
PIAFS
H.223 & H.245
H.223 & H.245 | +| | no comparable field | 5
#3..1 | Signalling access protocol
I.440/I.450
X.21 (note 26)
X.28, ded.PAD, indiv.NUI (note 26)
X.28, ded.PAD, univ.NUI (note 26)
X.28, non-ded.PAD (note 26)
X.32 (note 26) | +| | any of the above values | 6
#5..2 | User information layer 1 protocol
default layer 1 protocol | +| 5a
#7 | Synchronous / asynchronous
synchronous
asynchronous | 6
#1 | Synchronous/asynchronous
synchronous
asynchronous | +| 5a
#6 | Negotiation
not possible
inband neg, possible (note 16) | 6a
#6 | Negotiation
not possible
no comparable value | + +| Octet | ISDN BC parameter value | Octet | PLMN BC parameter value | +|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 5a
#5..1 | User rate
0,3 kbit/s
1,2 kbit/s
2,4 kbit/s
4,8 kbit/s
9,6 kbit/s
12 kbit/s
rate is indicated by Ebit as specified in rec. I.460
0,6 kbit/s
3,6 kbit/s
7,2 kbit/s
8 kbit/s
14,4 kbit/s
16 kbit/s
19.2 kbit/s
28.8 kbit/s
32 kbit/s
38.4 kbit/s
48 kbit/s
56 kbit/s
57.6 kbit/s
0,1345 kbit/s
0,1 kbit/s
75 bit/s / 1,2 kbit/s
1,2 kbit/s / 75 bit/s
0,110 kbit/s
0,2 kbit/s | 6a
#4..1 | User rate (note 18 and 29)
0,3 kbit/s
1,2 kbit/s
2,4 kbit/s
4,8 kbit/s
9,6 kbit/s
12 kbit/s (note 13)
(note 16)

not supported
not supported
not supported
not supported
(note 20)
not supported
(note 20)
(note 20)
(note 20)
(note 20)
(note 20)
not supported
not supported
not supported
not supported
not supported
not supported
not supported
not supported | +| 5b
#7..6 | Intermediate rate
not used (note 19)
8 kbit/s
16 kbit/s
32 kbit/s | 6b
#7..6 | Intermediate rate (note 6) (note 18)
8 or 16 kbit/s
8 kbit/s
16 kbit/s | +| 5b
#5 | NIC on Tx (note 14)
does not require
requires | 6b
#5 | NIC on Tx
does not require
requires (note 13) | +| 5b
#4 | NIC on Rx (note 14)
cannot accept
can accept | 6b
#4 | NIC on Rx
cannot accept
can accept (note 13) | +| 5b
#3 | Flow control on Tx (note 15)
Not Required
Required | | no comparable field | +| 5b
#2 | Flow control on Rx (note 15)
Cannot Accept
Accept | | no comparable field | +| 5c
#7..6 | Number of stop bits
1 bit
2 bits
not used
1.5 bits | 6a
#7 | Number of stop bits
1 bit
2 bits
no comparable value
not supported | +| 5c
#5..4 | Number of data bits
7 bits
8 bits
not used
5 bits | 6a
#5 | Number of data bits
7 bits
8 bits
no comparable value
not supported | +| 5c
#3..1 | Parity information
odd
even
none
forced to 0
forced to 1 | 6b
#3..1 | Parity information
odd
even
none
forced to 0
forced to 1 | +| | no comparable field | 6c
#7..6 | Connection element (note 1)
transparent
non-transparent (RLP)
both, transp. preferred
both, non-transp preferred | + +| Octet | ISDN BC parameter value | Octet | PLMN BC parameter value | +|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 5d
#7 | Duplex mode
half duplex
full duplex | 4
#4 | Duplex mode
half duplex (note 13)
full duplex (note 5) | +| 5d
#6..1 | Modem type
reserved
V.21
V.22
V.22bis
V.23
V.26ter
V.32
V.26
V.26bis
V.27
V.27bis
V.29

no comparable value | 6c
#5..1 | Modem type (note 12)
none (note 7)
V.21
V.22
V.22bis
not supported
V.26ter
V.32
not supported
not supported
not supported
not supported
not supported

autobauding type 1 (note 16) | +| 5a
#5..1 | User rate
no comparable value
9,6 kbit/s
14,4 kbit/s
19,2 kbit/s
28,8 kbit/s
32,0 kbit/s
38,4 kbit/s
48 kbit/s
56 kbit/s
no comparable value | 6d
#5..1 | Fixed network user rate (note 20)
FNUR not applicable
9,6 kbit/s
14,4 kbit/s
19,2 kbit/s
28,8 kbit/s
32,0 kbit/s (note 27)
38,4 kbit/s
48,0 kbit/s
56,0 kbit/s
64,0 kbit/s (note 22) | +| | Modem type
no comparable value (note 21)
V.34 | 6d
#7..6 | Other modem type
No other modem type
V.34 | +| | No comparable field | 6f
#7..5 | User initiated modification indicator (note 1) (note 25)
User initiated modification not required
User initiated modification upto 1
TCH/F may be requested
User initiated modification upto 2
TCH/F may be requested
User initiated modification upto 3
TCH/F may be requested
User initiated modification upto 4
TCH/F may be requested | +| 6
#5..1 | User information layer 2 protocol (note 10)
Q.921 (I.441)
X.25, link level
no comparable value | 7 | User information layer 2 protocol (note 8)
no comparable value
not supported
ISO 6429, codeset 0 | +| 7 | User information layer 3 protocol (note 10)
Q.931 (I.451)
X.25, packet level | |

not supported
not supported | + +## General notes: + +- 1) Other ISDN BC parameter values than those listed in the table, if indicated in the BC-IE, will be rejected by clearing the call, exception see mapping note 4. +- 2) Only the PLMN BC parameter values listed in the table may be generated (comparable values) during a mobile-terminated call by mapping the ISDN BC parameter values, exception see (10). +- 3) According to Q.931 (05/98) and 3GPP TS 24.008, respectively, the octets are counted from 1 to n onwards; the bit position in a particular octet is indicated by #x..y, with {x,y} = 1..8 (bit 1 is the least and bit 8 the most significant bit). + +- 4) If octets 5 to 5d of the ISDN BC are absent but present in the LLC, the LLC octets should apply for the mapping as indicated above. For V.120 interworking (see note 24) these LLC octets shall apply. +- 5) If within the ISDN BC the parameters information transfer capability indicates "3,1 kHz audio" and user layer 1 protocol indicates "G711 A-law" or "G.711 $\mu$ -law" (PCS-1900) but no modem type is available and the HLC does not indicate "facsimile group 3", octets 5 to 5d of the LLC, if available, apply for the above mapping procedure. +- 6) The number of octets which shall be encoded for the PLMN BC-IE must comply to encoding rules in 3GPP TS 24.008 and the combination of the different parameter values shall be in accordance to 3GPP TS 27.001. + +Notes regarding particular entries in table 7B: + +- 1) This PLMN parameter value is inserted according to user rate requirements and network capabilities / preferences. +- 2) This PLMN parameter value is inserted, if the information transfer capability in ISDN BC is "3,1kHz audio" and a comparable modem type is specified. +- 3) This PLMN parameter value is inserted, if the information transfer capability is "3,1 kHz audio" and the content of the HLC-IE, if any, indicates "facsimile group 2/3", (for details refer to subclause 10.2.2.3 case 3 for HLR action and subclause 10.2.2.4 case 5 for VMSC action). Note that via MAP the value "alternate speech/facsimile group 3 - starting with speech" shall be used, when TS 61 applies. +- 4) When interworking with an ISDN according to ETS 300 102-1, octets 4a and 4b may be present. The values are ignored and PLMN values are set according to notes 5 and 9. +- 5) This PLMN parameter value is inserted if the comparable ISDN parameter value is missing. +- 6) The value of the Intermediate Rate field of the PLMN Bearer Capability information element shall only depend on the value of the user rate in the same information element. If the connection element is "transparent", the value is 16 kbit/s, if the user rate is 9.6 or 12 kbit/s, and 8 kbit/s otherwise. For any other connection element setting the value is 16 kbit/s. +- 7) This PLMN BC parameter value is inserted, if the PLMN BC parameter "Information Transfer Capability" indicates "Unrestricted digital information", "facsimile group 3" or "alternate speech/facsimile group 3, starting with speech". +- 8) Where the network indicates "asynchronous" and connection elements "non-transparent", "both, transparent preferred" or "both, non-transparent preferred", then the PLMN BC should be forwarded without parameter user information layer 2 protocol, see also (10). +- 9) The PLMN parameter value shall be set to "unstructured" where the network indicates connection element "transparent". Where the network indicates connection elements "non transparent" "both, transparent preferred" or "both, non transparent preferred" the value of the parameter structure shall be set to "SDU Integrity". +- 10) Mapping of parameter values of this octet to PLMN BC parameters and values are subject to specific application rules, i.e. unless otherwise explicitly stated in an appropriate TS mapping to PLMN BC parameters shall not take place. +- 11) This value shall be used when the value of the PLMN BC parameter "Information Transfer Capability" indicates the value "3,1 kHz audio ex PLMN", "facsimile group 3" or "alternate speech/facsimile group 3, starting with speech" which is reserved for MAP operations. +- 12) The modem encoding of both Q.931 (05/98) and ETS 300 102-1 version 1 shall be accepted and mapped according to 3GPP TS 24.008. +- 13) Value not used for currently defined bearer services and Teleservices. +- 14) NIC is only supported in A/Gb mode for "3,1 kHz Ex PLMN audio" interworking with synchronous data transmission. +- 15) Because the required flow control mechanism can not be indicated to the UE (refer to 3GPP TS 27.001), the network shall check if the flow control mechanism selected by the UE and indicated in the CALL CONFIRMED message suits to the requirements requested by the ISDN terminal adaptor. If there is a mismatch the call shall be released in the IWF. + +Because an asymmetric flow control mechanism (with respect to transmitting and receiving side) is not supported in the PLMN, the different values of the ISDN BC-IE parameters "flow control on Tx" and "flow control on Rx" shall be interpreted in the following way: + +- "Flow control on Rx" set to "accepted" matches with "outband flow control", irrespective of the value of the parameter "flow control on Tx". + - "Flow control on Rx" set to "not accepted" and "flow control on Tx" set to "not required" matches with "inband flow control" and "no flow control". + - where "Flow control on Rx" is set to "not accepted" and "flow control on Tx" to "required" the call shall be released by the IWF. +- 16) If 3,1 kHz audio interworking "inband negotiation possible" is indicated and the parameter user rate is set to "rate is indicated by E bits specified in Recommendation I.460 or may be negotiated inband" the user rate in the PLMN BC-IE shall be set according to a network preferred value. If ISDN-BC parameter modem type is present, its value shall be ignored. The PLMN BC parameter modem type shall be set according to the user rate for connection element "transparent" and to "autobauding type 1" for connection element "non transparent", "both, transparent preferred" or "both, non transparent preferred". If data compression is used, high speed modems, like V.32bis, V.34 and/or V.90 may be used in the IWF. Autobauding may also be used to support user rates less than 9.6 kbit/s towards the PSTN. + +For unrestricted digital interworking the call shall be rejected if these values are indicated. + +If the PLMN-BC parameter modem type indicates "autobauding type 1" or "none", then the PLMN-BC parameter other modem type shall be set to "no other modem type". + +- 17) For the use of NIRR see 3GPP TS 27.001. The VMSC shall set this parameter dependent upon its capabilities and preferences. +- 18) If compression is supported by the MSC, the value "data compression possible" may be set. Depending on the capabilities of the MSC, the user rate value and the intermediate rate value is set to an appropriate value. +- 19) Only applicable if the parameter ISDN-BC ITC indicates "3,1 kHz audio" and for "UDI" calls if User Rate > "19,2 kbit/s". +- 20) The user rate of the PLMN BC is set to the value for the fall-back bearer service. If the user equipment does not support the fixed network user rate (i.e. the call confirmation message does not contain the fixed network user rate parameter), the network may release the call for a transparent connection element. +- 21) The modem type parameter of the PLMN -BC is taken into account, only. +- 22) If no LLC is received and the ISDN-BC received consists of octets 1 to 4 only, coded: + +| | | +|----------------------------------|----------| +| Coding standard: | CCITT | +| Information Transfer capability: | UDI | +| Transfer mode: | circuit | +| Information transfer rate: | 64kbit/s | + +the following PLMN -BC parameters, shall be set to: + +| | | +|--------------------------|--------------------------------------------------------| +| fixed network user rate: | 64 kbit/s | +| connection element: | transparent
bothNT or bothT (If IWF supports PIAFS) | + +The other parameters of the PLMN -BC shall be set to values indicating a fall-back service. + +If an LLC indicating UIL1P=X.31 (either explicitly or implicitly by octet 5 missing) is received and the ISDN-BC received consists of 1 to 4 only, coded: + +| | | +|----------------------------------|----------| +| Coding standard: | ITU-T | +| Information Transfer capability: | UDI | +| Transfer mode: | circuit | +| Information transfer rate: | 64kbit/s | + +the following PLMN BC parameters, shall be set to: + +| | | +|--------------------------|-----------------| +| fixed network user rate: | 64 kbit/s | +| connection element: | non-transparent | +| Synchronous/Asynchronous | asynchronous | + +all other parameters shall be set according to 3GPP TS 27.001 to indicate FTM. + +If an LLC indicating UIL1P=X.31 (either explicitly or implicitly by octet 5 missing) is received and the ISDN-BC received consists of 1 to 4 only, coded: + +| | | +|----------------------------------|----------| +| Coding standard: | ITU-T | +| Information Transfer capability: | RDI | +| Transfer mode: | circuit | +| Information transfer rate: | 64kbit/s | + +the following PLMN BC parameters, shall be set to: + +| | | +|--------------------------|-----------------| +| fixed network user rate: | 56 kbit/s | +| connection element: | non-transparent | +| Synchronous/Asynchronous | asynchronous | + +all other parameters shall be set according to 3GPP TS 27.001 to indicate FTM. + +23) When the MSC is directly connected to a restricted 64 kbit/s network, the ISDN BC-IE is coded with an ITC = RDI. + +An ISDN BC-IE, as specified in ETR 018 and shown below, shall be taken to indicate that interworking with an indirectly connected restricted 64 kbit/s network is required: + +| | | +|------------------------------------|----------------------------------| +| Coding standard: | CCITT | +| Information Transfer capability: | UDI | +| Transfer mode: | circuit | +| Information transfer rate: | 64 kbit/s | +| User information layer 1 protocol: | V.110/X.30 | +| Synchronous/Asynchronous: | synchronous | +| Negotiation: | In-band negotiation not possible | +| User rate: | 56 kbit/s | + +In this case the PLMN BC parameter Information Transfer Capability is set to „Other ITC" and Other ITC parameter is set to „restricted digital". If ISDN LLC exists, all the corresponding fields in the PLMN BC shall be derived from the ISDN LLC. Otherwise, the corresponding fields in the PLMN BC shall be derived from the ISDN BC. In the above both case, Connection element is set as follows. + +| | | +|---------------------|-----------------------------------------------------------------| +| Connection element: | transparent | +| | bothNT or bothT (If IWF supports FTM) and LLC does not indicate | +| | User information layer 1 protocol = "X.31 flag stuffing") | +| | non-transparent (if IWF supports FTM and LLC indicates | +| | User information layer 1 protocol = "X.31 flag stuffing") | + +24) V.120 interworking is required if the ISDN LLC parameter User Information Layer 1 Protocol is set to „V.120". In this case the PLMN BC parameter Rate Adaptation is set to „Other rate adaptation" and Other Rate Adaptation parameter is set to „V.120". All the corresponding fields in the PLMN BC shall be derived from the ISDN LLC. + +25) This parameter is only included for non-transparent multislot connections. + +26) This value was used by services defined for former PLMN releases and does not need to be supported. + +27) Following BC parameters in SETUP message shall be set to: + +| | | +|-------------------------|-------------------------------------------------------------| +| Fixed network user rate | 32 kbit/s | +| Connection element | transparent (for multimedia) | +| | bothNT or bothT (If IWF supports PIAFS, UTRAN Iu mode only) | + +- 28) UIL1P is set to "H.221 & H.242" or "H.223 & H.245" by H.324/I. If UIL1P is set to "H.221 and H.242", this should be mapped to "H.223 & H.245". +- 29) In Iu mode, if the User Rate of the ISDN BC is less than 9,6 kbit/s and the Connection Element is mapped to "NT", then FNUR is fixed to 9,6 kbit/s. + +### 10.2.2.7 Creation of Backup Bearer Capability Information Element + +If the VMSC is not able to send a PLMN BC to the MS/UE for mobile terminated calls, it may include all available information in the Backup BC information element (Backup BC IE) of the call set-up message. + +In the following table 7C the comparison is drawn between parameters in the ISDN call set up request message and that of the PLMN call set up request message. In some cases no comparable values are available and these will be marked as such. In some cases it is not necessary to support a particular option, and in this case those parameters will be annotated appropriately. + +The PLMN parameters and values shall as in 3GPP TS 24.008 in combination as in 3GPP TS 27.001. The ISDN parameters and values are as in Q.931 (05/98). + +**Table 7C: Setting of parameters in Backup BC IE** + +| Octet | ISDN BC / LLC parameter value | Octet | BACKUP BC parameter value | +|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Bearer Capability IEI | 1 | Bearer Capability IEI | +| 2 | Length of BC contents | 2 | Length of BC contents | +| | no comparable field | 3
#7..6 | Radio channel requirement
full rate channel (these bits are spare) | +| 3
#7..6 | Coding standard
CCITT standardized coding | 3
#5 | Coding standard
GSM standardized coding | +| 3
#5..1 | Information transfer capability
speech
unrestricted digital
3,1 kHz audio
no comparable value
no comparable value
7 kHz audio
video
(note 23) | 3
#3..1 | Information transfer capability
speech
unrestricted digital
3,1 kHz audio ex PLMN (note2)
facsimile group 3 (note 3)
other ITC (see octet 5a)
not supported
not supported | +| | | 5a
#7..6 | Other ITC
restricted digital | +| 4
#7..6 | Transfer mode
circuit mode
packet mode | 3
#4 | Transfer mode
circuit mode
not supported | +| | no comparable field | 4
#7 | Compression (note 18)
data compression not possible | +| 4a
#7..5 | no comparable field (note 4) | (4) 4
#6..5 | Structure (note 9)
SDU integrity
unstructured | +| 4a
#4..3 | no comparable field (note 4) | 4
#3 | Configuration
point-to-point (note 5) | +| | no comparable field | 4
#2 | NIRR (note 17)
No meaning | +| 4a
#2..1 | no comparable field (note 4) | 4
#1 | Establishment
demand (note 5) | +| 5
#5..1 | User information layer 1 protocol
no comparable value
CCITT V.110, I.460 / X.30
G.711 A-law
CCITT X.31 flag stuffing
no comparable value

H.221 & H.242 (note 28)
H.223 & H.245 | 5
#5..4 | Rate adaption
no rate adaption (note 11)
V.110, I.460/X.30 rate adaption
no comparable value
not supported
other rate adaption (see octet 5a) | +| | | 5a
#5..4 | Other rate adaptation
H.223 & H.245
H.223 & H.245 | +| | no comparable field | 5
#3..1 | Signalling access protocol
I.440/I.450 | +| | any of the above values | 6
#5..2 | User information layer 1 protocol
default layer 1 protocol | +| 5a
#7 | Synchronous / asynchronous (note 30)
synchronous
asynchronous | 6
#1 | Synchronous/asynchronous
synchronous
asynchronous | +| 5a
#6 | Negotiation
not possible
inband neg. possible (note 16) | 6a
#6 | Negotiation
not possible (note 5)
no comparable value | + +| Octet | ISDN BC / LLC parameter value | Octet | BACKUP BC parameter value | +|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 5a
#5..1 | User rate
0,3 kbit/s
1,2 kbit/s
2,4 kbit/s
4,8 kbit/s
9,6 kbit/s
12 kbit/s
rate is indicated by Ebit as specified in rec.
1.460
0,6 kbit/s
3,6 kbit/s
7,2 kbit/s
8 kbit/s
14,4 kbit/s
16 kbit/s
19.2 kbit/s
28.8 kbit/s
32 kbit/s
38.4 kbit/s
48 kbit/s
56 kbit/s
57.6 kbit/s
0,1345 kbit/s
0,1 kbit/s
75 bit/s / 1,2 kbit/s
1,2 kbit/s / 75 bit/s
0,110 kbit/s
0,2 kbit/s
no comparable value | 6a
#4..1 | User rate (note 29)
0,3 kbit/s
1,2 kbit/s
2,4 kbit/s
4,8 kbit/s
9,6 kbit/s
12 kbit/s (note 13)
(note 16)

not supported
not supported
not supported
not supported
(note 20)
not supported
(note 20)
(note 20)
(note 20)
(note 20)
(note 20)
not supported
not supported
not supported
not supported
not supported
not supported
not supported
unknown | +| 5b
#7..6 | Intermediate rate
any value | 6b
#7..6 | Intermediate rate (note 6)
8 kbit/s
16 kbit/s | +| 5b
#5 | NIC on Tx (note 14)
does not require
requires | 6b
#5 | NIC on Tx
does not require (note 5)
requires (note 13) | +| 5b
#4 | NIC on Rx (note 14)
cannot accept
can accept | 6b
#4 | NIC on Rx
cannot accept (note 5)
can accept (note 13) | +| 5c
#7..6 | Number of stop bits
1 bit
2 bits
not used
1.5 bits | 6a
#7 | Number of stop bits
1 bit (note 5)
2 bits
no comparable value
not supported | +| 5c
#5..4 | Number of data bits
7 bits
8 bits
not used
5 bits | 6a
#5 | Number of data bits
7 bits
8 bits (note 5)
no comparable value
not supported | +| 5c
#3..1 | Parity information
odd
even
none
forced to 0
forced to 1 | 6b
#3..1 | Parity information
odd
even
none (note 5)
forced to 0
forced to 1 | +| | no comparable field | 6c
#7..6 | Connection element (note 1)
transparent
non-transparent (RLP)
both, transp. preferred
both, non-transp preferred | +| 5d
#7 | Duplex mode
half duplex
full duplex | 4
#4 | Duplex mode
half duplex (note 13)
full duplex (note 5) | + +| Octet | ISDN BC / LLC parameter value | Octet | BACKUP BC parameter value | +|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 5d
#6..1 | Modem type
reserved
V.21
V.22
V.22bis
V.23
V.26ter
V.32
V.26
V.26bis
V.27
V.27bis
V.29

no comparable value | 6c
#5..1 | Modem type (note 12)
none (note 7)
V.21
V.22
V.22bis
not supported
V.26ter
V.32
not supported
not supported
not supported
not supported
not supported

autobauding type 1 (note 16) | +| 5a
#5..1 | User rate
no comparable value
9,6 kbit/s
14,4 kbit/s
19,2 kbit/s
28,8 kbit/s
32,0 kbit/s
38,4 kbit/s
48 kbit/s
56 kbit/s
no comparable value | 6d
#5..1 | Fixed network user rate (note 20)
FNUR not applicable / unknown
9,6 kbit/s
14,4 kbit/s
19,2 kbit/s
28,8 kbit/s
32,0 kbit/s (note 27)
38,4 kbit/s
48,0 kbit/s
56,0 kbit/s
64,0 kbit/s (note 22) | +| | Modem type
no comparable value (note 21)
V.34 | 6d
#7..6 | Other modem type
No other modem type
V.34 | +| | no comparable field | 6e
#7..6 | Acceptable channel codings
spare | +| | no comparable field | 6e
#5..1 | Maximum number of traffic channels
spare | +| | No comparable field | 6f
#7..5 | User initiated modification indicator (note 1) (note 25)
User initiated modification not required
User initiated modification upto 1
TCH/F may be requested
User initiated modification upto 2
TCH/F may be requested
User initiated modification upto 3
TCH/F may be requested
User initiated modification upto 4
TCH/F may be requested | +| | no comparable field | 6f
#4..1 | Wanted air interface user rate
spare | +| | no comparable field | 6g
#7..5 | Acceptable channel codings extended
spare | +| | no comparable field | 6g
#4..3 | Asymmetry indications
spare | +| 6
#5..1 | User information layer 2 protocol (note 10)
Q.921 (I.441)
X.25, link level
no comparable value
no comparable value | 7 | User information layer 2 protocol (note 8)
no comparable value
not supported
ISO 6429, codeset 0
unknown | + +General notes: + +- 1) Only the PLMN BC parameter values listed in the table may be generated (comparable values) during a mobile-terminated call by mapping the ISDN BC parameter values, exception see (10). + +- 2) According to Q.931 (05/98) and 3GPP TS 24.008, respectively, the octets are counted from 1 to n onwards; the bit position in a particular octet is indicated by #x.y, with {x,y} = 1..8 (bit 1 is the least and bit 8 the most significant bit). +- 3) If octets of the ISDN BC are absent but present in the LLC, the LLC octets should apply for the mapping. +- 4) The number of octets which shall be encoded for the Backup BC-IE must comply to encoding rules in 3GPP TS 24.008 and the combination of the different parameter values shall be in accordance to 3GPP TS 27.001 with the modification that some parameters may be absent, if a whole octet is absent, and some parameters may get values defined for the Backup BC only. However, parameter values that are valid for both the PLMN BC and the Backup BC shall not be in contradiction to 3GPP TS 27.001. + +Notes regarding particular entries in table 7C: + +- 1) This PLMN parameter value is inserted according to user rate requirements and network capabilities / preferences. +- 2) This PLMN parameter value is inserted, if the information transfer capability in ISDN BC is "3,1kHz audio" and a comparable modem type is specified. +- 3) This PLMN parameter value is inserted, if the information transfer capability is "3,1 kHz audio" and the content of the HLC-IE, if any, indicates "facsimile group 2/3", (for details refer to subclause 10.2.2.3 case 3 for HLR action and subclause 10.2.2.4 case 5 for VMSC action). +- 4) When interworking with an ISDN according to ETS 300 102-1, octets 4a and 4b may be present. The values are ignored and PLMN values are set according to notes 5 and 9. +- 5) This PLMN parameter value is inserted if the comparable ISDN parameter value is missing. +- 6) The value of the Intermediate Rate field of the PLMN Bearer Capability information element shall only depend on the value of the user rate in the same information element. If the connection element is "transparent", the value is 16 kbit/s, if the user rate is 9.6 or 12 kbit/s, and 8 kbit/s otherwise. For any other connection element setting the value is 16 kbit/s. If the user rate value is "unknown" any value can be used, it has to be ignored by the UE +- 7) This PLMN BC parameter value is inserted, if the PLMN BC parameter "Information Transfer Capability" indicates "Unrestricted digital information "or "facsimile group 3". +- 8) Where the network indicates "asynchronous" and connection elements "non-transparent", "both, transparent preferred" or "both, non-transparent preferred" , then the PLMN BC should be forwarded without parameter user information layer 2 protocol, see also (10). +- 9) The PLMN parameter value shall be set to "unstructured" where the network indicates connection element "transparent". Where the network indicates connection elements "non transparent" "both, transparent preferred" or "both, non transparent preferred" the value of the parameter structure shall be set to "SDU Integrity". +- 10) Mapping of parameter values of this octet to PLMN BC parameters and values are subject to specific application rules, i.e. unless otherwise explicitly stated in an appropriate TS mapping to PLMN BC parameters shall not take place. +- 11) This value shall be used when the value of the PLMN BC parameter "Information Transfer Capability" indicates the value "3,1 kHz audio ex PLMN" or "facsimile group 3". +- 12) The modem encoding of both Q.931 (05/98) and ETS 300 102-1 version 1 shall be accepted and mapped according to 3GPP TS 24.008. +- 13) Value not used for currently defined bearer services and Teleservices. +- 14) NIC is only supported in A/Gb mode for "3,1 kHz Ex PLMN audio" interworking with synchronous data transmission. +- 15) void. +- 16) If 3,1 kHz audio interworking "inband negotiation possible" is indicated and the parameter user rate is set to "rate is indicated by E bits specified in Recommendation I.460 or may be negotiated inband" the user rate in the PLMN BC-IE shall be set according to a network preferred value. If ISDN-BC parameter modem type is present, + +its value shall be ignored. The PLMN-BC parameter modem type shall be set according to the user rate for connection element "transparent" and to "autobauding type 1" for connection element "non transparent", "both, transparent preferred" or "both, non transparent preferred". If data compression is used, high speed modems, like V.32bis, V.34 and/or V.90 may be used in the IWF. Autobauding may also be used to support user rates less than 9.6 kbit/s towards the PSTN. + +For unrestricted digital interworking the call shall be rejected if these values are indicated. + +If the PLMN-BC parameter modem type indicates "autobauding type 1" or "none", then the PLMN-BC parameter other modem type shall be set to "no other modem type". + +17) An indication of NIRR is not possible in the Backup BC because it has to be negotiated by parameter values in the PLMN BC. + +18) An indication of compression is not possible in the Backup BC because it has to be negotiated by parameter values in the PLMN BC. + +19) void. + +20) The user rate of the PLMN BC is set to the value for the fall-back bearer service. If the user equipment does not support the fixed network user rate (i.e. the call confirmation message does not contain the fixed network user rate parameter), the network may release the call for a transparent connection element. + +21) The modem type parameter of the PLMN -BC is taken into account, only. + +22) If no LLC is received and the ISDN-BC received consists of octets 1 to 4 only, coded: + +| | | +|----------------------------------|----------| +| Coding standard: | CCITT | +| Information Transfer capability: | UDI | +| Transfer mode: | circuit | +| Information transfer rate: | 64kbit/s | + +the following PLMN -BC parameters, shall be set to: + +| | | +|--------------------------|---------------------------------------| +| fixed network user rate: | 64 kbit/s | +| connection element: | transparent | +| | bothNT or bothT (If IWF supports FTM) | + +The other parameters of the PLMN -BC shall be set to values indicating a fall-back service. + +23) When the MSC is directly connected to a restricted 64 kbit/s network, the ISDN BC-IE is coded with an ITC = RDI. + +An ISDN BC-IE, as specified in ETR 018 and shown below, shall be taken to indicate that interworking with an indirectly connected restricted 64 kbit/s network is required: + +| | | +|------------------------------------|----------------------------------| +| Coding standard: | CCITT | +| Information Transfer capability: | UDI | +| Transfer mode: | circuit | +| Information transfer rate: | 64 kbit/s | +| User information layer 1 protocol: | V.110/X.30 | +| Synchronous/Asynchronous: | synchronous | +| Negotiation: | In-band negotiation not possible | +| User rate: | 56 kbit/s | + +In this case the PLMN BC parameter Information Transfer Capability is set to „Other ITC" and Other ITC parameter is set to „restricted digital". If ISDN LLC exists, all the corresponding fields in the PLMN BC shall be derived from the ISDN LLC. Otherwise, the corresponding fields in the PLMN BC shall be derived from the ISDN BC. In the above both case, Connection element is set as follows. + +| | | +|---------------------|---------------------------------------| +| Connection element: | transparent | +| | bothNT or bothT (If IWF supports FTM) | + +24) Void. + +25) This parameter is only included for non-transparent multislot connections. + +26) This value was used by services defined for former PLMN releases and does not need to be supported. + +27) Following BC parameters in SETUP message shall be set to: + +| | | +|-------------------------|------------------------------| +| Fixed network user rate | 32 kbit/s | +| Connection element | transparent (for multimedia) | + +28) UIL1P is set to "H.221 & H.242" or "H.223 & H.245" by H.324/I. If UIL1P is set to "H.221 and H.242", this should be mapped to "H.223 & H.245". + +29) In Iu mode, if the User Rate of the ISDN BC is less than 9,6 kbit/s and the Connection Element is mapped to "NT", then FNUR is fixed to 9,6 kbit/s. + +30) If this parameter value is missing, the Backup BC shall not contain parameter octets 6 and higher. + +### 10.2.3 Transparent service support + +The protocol stacks for transparent services are specified in 3GPP TS 43.010 and in Clause 11a.3. + +In Iu mode, the transparent services are based in the Iu User Plane protocol specified in 3GPP TS 25.415. + +In A/Gb mode identifies the rate adaptation scheme shall be utilized on the RAN to MSC link as identified in 3GPP TS 48.020. The transcoding function will generate the 64 kbit/s rate adapted format utilizing the 8 and 16 kbit/s intermediate data rates. The MSC - MSC/IWF will utilize the same rate adaptation scheme as that indicated in 3GPP TS 48.020, i.e. adapted to 64 kbit/s. + +#### 10.2.3.1 Structure of the MSC/IWF for Iu mode + +The transmission towards the RNC is based on AAL2. The Iu UP is used in the transparent mode. + +![Diagram of the MSC/IWF structure for Iu mode. On the left, a vertical stack of three boxes labeled 'Iu UP', 'AAL2', and 'ATM' is shown. Lines from each of these boxes point to a central 'MODEM' box. From the 'MODEM' box, a line points to a 'CODEC' box, which outputs '3.1kHz audio'. From the 'MODEM' box, another line points to an 'ISDN TA function' box, which outputs '64 kbit/s unrestricted or 56 kbit/s restricted'. A third line from the 'MODEM' box points to a label '64 kbit/s unrestricted or 56 kbit/s restricted'.](29a9cd1cb2a960eb91dbf79aab5d8668_img.jpg) + +Diagram of the MSC/IWF structure for Iu mode. On the left, a vertical stack of three boxes labeled 'Iu UP', 'AAL2', and 'ATM' is shown. Lines from each of these boxes point to a central 'MODEM' box. From the 'MODEM' box, a line points to a 'CODEC' box, which outputs '3.1kHz audio'. From the 'MODEM' box, another line points to an 'ISDN TA function' box, which outputs '64 kbit/s unrestricted or 56 kbit/s restricted'. A third line from the 'MODEM' box points to a label '64 kbit/s unrestricted or 56 kbit/s restricted'. + +**Figure 10: Structure of the MSC/IWF (transparent)** + +#### 10.2.3.2 Structure of the MSC/IWF for A/Gb mode + +When interworking to the unrestricted digital bearer service rate adaptation according to ITU-T Recommendation V.110 will be necessary within the MSC/IWF. For multislot, TCH/F14.4 or EDGE operations MSC/IWF shall adapt the data stream as defined in 3GPP TS 44.021 and 3GPP TS 48.020. + +NOTE: From the perspective of MSC/IWF, a TCH/F28.8 EDGE configuration is identical to a multislot 2×TCH/F14.4 configuration. + +When interworking to the 3,1 kHz audio service, then the same process as for the PSTN case is necessary (section 9.2.3.2). + +![Figure 11: Structure of the MSC/IWF (transparent). The diagram shows three RA units (RA0, RA1, RA2) connected to a MODEM and an ISDN TA function. RA0 is connected to the MODEM via 'data' lines. RA1 is connected to the MODEM via 'status' lines and to the ISDN TA function via 'status' lines. RA2 is connected to the ISDN TA function via a line labeled '64 kbit/s unrestricted or 56 kbit/s restricted'. The MODEM is connected to a CODEC, which outputs '3.1 kHz audio'. The ISDN TA function outputs '64 kbit/s unrestricted or 56 kbit/s restricted'.](0f6e3cdce0f01d6ccceabcced508bb5b_img.jpg) + +Figure 11: Structure of the MSC/IWF (transparent). The diagram shows three RA units (RA0, RA1, RA2) connected to a MODEM and an ISDN TA function. RA0 is connected to the MODEM via 'data' lines. RA1 is connected to the MODEM via 'status' lines and to the ISDN TA function via 'status' lines. RA2 is connected to the ISDN TA function via a line labeled '64 kbit/s unrestricted or 56 kbit/s restricted'. The MODEM is connected to a CODEC, which outputs '3.1 kHz audio'. The ISDN TA function outputs '64 kbit/s unrestricted or 56 kbit/s restricted'. + +**Figure 11: Structure of the MSC/IWF (transparent)** + +### 10.2.3.3 Mapping of signalling UE/MSC/IWF to modem or ISDN (V.110) TA-function interface requirements + +For the 3,1 kHz audio interworking case see subclause 9.2.3.3. + +Status bits SA, SB and X can be used to convey channel control information associated with the data bits in the data transfer state. Table 8 shows the mapping scheme between the V.24 circuit numbers corresponding to the V-series DCE functions and the status bits for the transparent mode. It also shows how the unused status bits should be handled. It is derived from the General Mapping scheme described in annex B. A binary 0 corresponds to the ON condition, a binary 1 to the OFF condition. + +The transport of these status bits by the various channel codings is described in 3GPP TS 44.021 and 48.020 for A/Gb mode. For Iu mode refer to 3GPP Clause 11a. + +**NOTE** Although the interface to the ISDN TA function is described in terms of V.24 interchange circuit functions, this does not imply that such circuits need to be physically realised. + +**Table 8: Mapping scheme at the IWF for the transparent mode** + +| Mapping direction: UE to IWF | Mapping direction: IWF to UE | Signal at IWF ISDN TA interface or condition within the IWF | +|------------------------------|------------------------------|-------------------------------------------------------------| +| always ON (note 1) | | CT 105 | +| | to status bit X | CT 106 | +| | not mapped (note 5) | CT 107 | +| not mapped (note 6) | | CT 108 | +| | to status bit SB | CT 109 | +| always ON (note 2) | | CT 133 | +| from status bit SA (note 3) | | ignored by IWF | +| from status bit SB (note 1) | | ignored by IWF | +| from status bit X (note 4) | | ignored by IWF | +| | to status bit SA (note 3) | always ON | + +NOTE 1: The SB bit towards the IWF, according to the General Mapping (annex B), could be used to carry CT 105 from the mobile DTE to the ISDN TA function in the IWF. However, CT 105 should always be ON at the DTE interface in the data transfer state since only duplex operation is supported. Also, many DTEs use the connector pin assigned to CT 105 for CT 133. Therefore, CT 105 shall always be set to ON at the IWF ISDN TA function during the data transfer state. + +NOTE 2: CT 133 is not mapped since there is no flow control in transparent mode. + +NOTE 3: The SA bits in both directions are available only with certain channel codings. Therefore, for maximum compatibility, they should not be mapped. + +NOTE 4: The X bit towards the IWF is not mapped since there is no flow control in transparent mode. + +NOTE 5: CT 107 is not used by the IWF. + +NOTE 6: CT 108 is used in the call setup and answering processes. + +### 10.2.3.4 Establishment of end-to-end terminal synchronizations + +Prior to exposing the traffic channel of a PLMN connection to transmission of user data, the controlling entities of the connection shall assure of the availability of the traffic channel. This is done by a so called synchronizations process: + +- starting on the indication of "physical connection established" resulting from the PLMN-inherent outband signalling procedure This indication is given: + - for MOC: on sending the CONNECT message; + - for MTC: on sending the CONNECT ACKNOWLEDGE message; + - for mobile initiated in-call modification: on sending the MODIFY COMPLETE message (which is sent after reception of the ASSIGNMENT COMPLETE or RAB ASSIGNMENT RESPONSE message); and + - for network initiated in-call modification: on reception of the ASSIGNMENT COMPLETE or RAB ASSIGNMENT RESPONSE message; +- ending by indicating the successful execution of this process to the controlling entity, which then takes care of the further use of the inband information (data, status). + +Network interworking within an MSC/IWF is concerned with the terminating side (to the UE) and the transit side (to the fixed network) of a connection. Both sides shall be treated individually related to the synchronizations process. + +#### 10.2.3.4.1 Terminating side (towards the UE) + +##### 10.2.3.4.1.1 Traffic channel types TCH/F4.8 and TCH/F9.6 in A/Gb mode + +With respect to the terminating side the procedure is as follows: + +- sending of synchronizations pattern 1/OFF (all data bits "1"/all status bits "OFF") to the UE using the RA1/RA2 rate adaptation function. In multislot transparent operation, the synchronisation pattern sent is 1/OFF with the exception of the bit positions S1, first X, S3, and S4 which contain the substream number and multiframe alignment pattern (see 3GPP TS 44.021); +- searching for detection of the synchronizations pattern from the UE within valid V.110 frames, and in multislot operation, also searching for the multiframe alignment pattern "0000 1001 0110 0111 1100 0110 1110 101" (see 3GPP TS 44.021) in bit position S4 and substream numbers in bit positions S1, first X, and S3. This implies that the E1, E2 and E3 bit of the V.110 frame shall be checked for the appropriate user rate in order to distinguish the synchronization pattern from the RAN idle data frame. +- Timer T (= 500 ms) is started for each of the allocated traffic channel(s) of the call on receipt of the synchronizations pattern from the UE. +- When the frame alignment pattern and, in case of multislot operation, the multiframe alignment pattern have been recognized as a steady state, the MSC/IWF continues sending the synchronizations patterns to the UE until a timer T expires. + +##### 10.2.3.4.1.2 Traffic channel type TCH/F14.4 for A/Gb mode + +With respect to the terminating side the procedure is as follows: + +- Sending A-TRAU frames with the data rate set in the bits C1-C4 (TS 48.020) and data bits set to one, sending the multiframe structure with the alignment pattern (bit M1) and with the status bits OFF (bit M2) and, in a multislot case, sending substream numbers (bit M2). +- Searching for the detection of the multiframe alignment pattern ,,0000 1001 0110 0111 1100 0110 1110 101" (TS 44.021) in the bit M1 and, in a multislot case, searching for substream numbers in the bit M2. (Any 5 bit sequence in the multiframe alignment pattern is unique, i.e. the multiframe alignment can take place by recognition of five successive M1 bits). +- Timer T (= 500 ms) is started for each of the allocated traffic channel(s) of the call on receipt of the synchronizations pattern from the UE. +- When the frame alignment pattern and the multiframe alignment pattern have been recognized as a steady state, the MSC/IWF continues sending the synchronizations patterns to the UE until a timer T expires. + +#### 10.2.3.4.1.3 User Plane for Iu mode + +The procedures are the same as for the modem case, but, depending on implementation, the IWF may through connect before the fixed network leg has been synchronised. + +#### 10.2.3.4.2 Transit side (towards the fixed network). + +In case of interworking to the ISDN "3,1 kHz audio" bearer service the synchronization process is as for the PSTN interworking case (see subclause 9.2.3.4.2). + +In case of V.110 interworking to the ISDN unrestricted digital bearer service the following synchronization process shall be performed. + +The interchange circuits towards the V.110 ISDN TA function are held in the OFF condition until timer T expires, when they are switched to ON. + +From this time, after the expiration of the timer T of every allocated traffic channel, the information on CT106 and CT109 from the IWF V.110 ISDN TA function are directly mapped to the X and SB bits, respectively, towards the UE. For TCH/F14.4 the X and SB bits are mapped to the M2 multiframe bits according to 3GPP TS 44.021. Circuit 108 to the selected V.110 ISDN TA function associated with the connection will be switched from the "OFF" to "ON" condition, thus initiating the synchronization process on the fixed network according to ITU-T Recommendation V.110. The IWF is allowed to map CT 104 to the data bits sent towards the UE and to map data bits received from the UE to CT 103. + +#### 10.2.3.5 Network independent Clocking (NIC) + +Due to the incompatibility between the ISDN and the PLMN requirements for NIC interworking is not provided between these two formats. As such no NIC function is required in providing interworking to the ISDN. In this case, the IWF shall disregard the value of bits E4, E5, E6 and E7 in the data transmission phase. + +### 10.2.4 Non-transparent service support + +The protocol stacks for non-transparent services are specified in 3GPP TS 43.010 and in Clause 11a.2. Both of the systems use the Radio Link Protocol (RLP) specified in 3GPP TS 24.022. + +In Iu mode, the non-transparent services are based in the Iu User Plane protocol specified in 3GPP TS 25.415. + +In A/Gb mode the corresponding necessary support concerning the rate adaptation scheme shall be utilized on the RAN-MSC link as identified in 3GPP TS 48.020. + +For the non-transparent service support the MSC/IWF will select the modem and speed based on the Compatibility information contained in either the call set-up or call confirmed message, reference subclauses 9.2.1 and 9.2.2. Where the Modem Type indicated is autobauding type 1, the MSC/IWF may select any speed and modem type according to what it can negotiate with the remote modem. In this case User Rate and Fixed Network User Rate, if present, has no meaning. + +#### 10.2.4.1 Structure of the MSC/IWF for Iu mode + +The transmission towards the RNC is based on AAL2. The Iu UP is used in the support mode. The RLP/L2R extends to the UE. + +![Diagram showing the structure of the MSC/IWF for Iu mode. On the left, a stack of protocols is shown: L2R (containing RLP), Iu UP, AAL2, and ATM. A line labeled 'Data and status' connects this stack to two parallel paths. The top path goes through a MODEM block to a CODEC block, which outputs '3.1 kHz audio'. The bottom path goes through an 'ISDN TA function' block, which outputs '64 kbit/s unrestricted or 56 kbit/s restricted' with a footnote '1) not applicable for PIAFS'.](659f4d3d272deea8021d0bb2e22465fd_img.jpg) + +``` + +graph LR + subgraph Stack [Protocol Stack] + L2R[L2R
RLP] + Iu_UP[Iu UP] + AAL2[AAL2] + ATM[ATM] + end + Stack -- "Data and status" --> MODEM[MODEM] + Stack -- "Data and status" --> ISDN_TA[ISDN TA function] + MODEM --> CODEC[CODEC] + CODEC --> Audio[3.1 kHz audio] + ISDN_TA --> ISDN_Out[64 kbit/s unrestricted
or 56 kbit/s restricted] + ISDN_Out -.-> Footnote[1) not applicable for PIAFS] + +``` + +Diagram showing the structure of the MSC/IWF for Iu mode. On the left, a stack of protocols is shown: L2R (containing RLP), Iu UP, AAL2, and ATM. A line labeled 'Data and status' connects this stack to two parallel paths. The top path goes through a MODEM block to a CODEC block, which outputs '3.1 kHz audio'. The bottom path goes through an 'ISDN TA function' block, which outputs '64 kbit/s unrestricted or 56 kbit/s restricted' with a footnote '1) not applicable for PIAFS'. + +Figure 12: Structure of the MSC/IWF (non-transparent) + +### 10.2.4.2 Structure of the MSC/IWF for A/Gb mode + +The rate adaptation process will be the same as for the transparent case, except that a TCH/F43.2 channel coding is also supported. From MSC/IWF's perspective a TCH/F43.2 EDGE configuration is identical to a multislot 3×TCH/F14.4 configuration. + +3GPP TS 43.010 identifies the protocol layer structure for the non-transparent case, the MSC/IWF provides the inverse of the action in the UE terminal adaptation function. For a multislot configuration refer to 3GPP TS 43.010. + +The V.110, V.120 and PIAFS ISDN TA (terminal adapter) functions provide the same functionality and operational behaviour as fixed ISDN terminal adapters that conform to the corresponding ITU-T Recommendations (V.110 or V.120). + +![Figure 13: Structure of the MSC/IWF (non-transparent). The diagram shows a central block divided into L2R and RLP. The RLP section is connected to RA1, which is connected to RA2. The L2R section is connected to a MODEM, which is connected to a CODEC, which outputs 3.1 kHz audio. The L2R section is also connected to an ISDN TA function, which outputs 64 kbit/s unrestricted or restricted. A 'Data and status' line connects the RLP section to the ISDN TA function.](1399c76ef88f22b70d05ed3f781d3c48_img.jpg) + +``` + +graph LR + subgraph MSC_IWF [MSC/IWF] + L2R[L2R] + RLP[RLP] + end + RLP --- RA1[RA1] + RA1 --- RA2[RA2] + L2R --- MODEM[MODEM] + MODEM --- CODEC[CODEC] + CODEC --- Audio[3.1 kHz audio] + L2R --- ISDN_TA[ISDN TA function] + ISDN_TA --- ISDN_Out[64 kbit/s unrestricted or restricted] + RLP --- DS[Data and status] + DS --- ISDN_TA + +``` + +Figure 13: Structure of the MSC/IWF (non-transparent). The diagram shows a central block divided into L2R and RLP. The RLP section is connected to RA1, which is connected to RA2. The L2R section is connected to a MODEM, which is connected to a CODEC, which outputs 3.1 kHz audio. The L2R section is also connected to an ISDN TA function, which outputs 64 kbit/s unrestricted or restricted. A 'Data and status' line connects the RLP section to the ISDN TA function. + +Figure 13: Structure of the MSC/IWF (non-transparent) + +### 10.2.4.3 Re-constitution of user data + +3GPP TS 24.022 refers to the frame of user data in the radio link protocol. The layer 2 relay functions in the UE and the MSC/IWF (identified in 3GPP TS 43.010 and 3GPP TS 23.202 [90]) contain the mechanism for packing and unpacking the user data into the L2R protocol data units. + +### 10.2.4.4 Layer 2 relay functionality + +Specific functionality is required on the L2R dependant upon the service which is being requested to be supported. The selection of the appropriate L2R function will be determined by the MSC/IWF on the basis of the bearer capability information signalled in the call set-up request, or call confirmation message. The prime information element being transparent or non transparent service indication. In addition the particular L2R function - type of protocol to be terminated and mode of flow control to be applied (see appropriate subclauses in 3GPP TS 27 series) - will be selected on the basis of the user's layer 2 indication. + +The specific interaction between the L2R function and the RLP function and the L2R frame structure will be the same as that detailed in the Annex to the appropriate 3GPP TS 27 series. + +### 10.2.4.5 In band signalling mapping flow control + +This entails the L2R function providing the means of controlling and responding to flow control function of the modem (or in the rate adapted frame) plus any synchronizations requirements related to flow control. For asynchronous services a specific rule applies for flow control (see 3GPP TS 27.001). + +In case of interworking to the ISDN "3,1kHz audio" bearer service the flow control process is as for the PSTN interworking case (see subclause 9.2.4.5). In case of interworking to the ISDN unrestricted digital bearer service the following procedures apply: + +The flow control function chosen will be dependent upon the availability of the "user information layer 2" information element of the PLMN BC and if available its value. + +For V.110 interworking, outband flow control will be by means of the "X" bit in the V.110 frame to the ISDN. + +For V.120 interworking, outband flow control shall be as follows. In Multiple frame acknowledged mode the functions of the data link control sublayer (send RNR or withhold update of the sequence state variable V(R)) shall be used. In Unacknowledged mode the RR bit in the Control State octet shall be used. + +For PIAFS interworking, outband flow control shall be as follows. The functions of the data link control sublayer (withhold update of the frame number) shall be used. + +If flow control is provided irrespective of the type used, the L2R function shall: + +- a) provide immediate indication of flow control to the fixed network on receipt of flow control request from the UE; and/or +- b) provide immediate indication of flow control to the UE on receipt of flow control request from the fixed network i.e. in the next available L2R status octet to be transmitted. + +Where in band (X-on/X-off) flow control is in use, then the X-on/X-off characters will not be passed across the radio interface. + +If no flow control is provided the involved end systems are responsible for performing in-band flow control on their own by taking into account the buffer capacity of the MSC/IWF as stated below. + +#### 10.2.4.5.1 Conditions requiring flow control - if flow control is provided - towards the fixed network + +The L2R function will initiate flow control in the following circumstances: + +- 1) the transmit buffer to the radio side reaches a preset threshold (BACK PRESSURE); +- 2) the L2R function receives a "flow control active" indication. + +On removal of buffer congestion or receipt of L2R "flow control inactive" the flow control will be removed. + +No flow initiation/removal will take place at the L2R function and loss of data may occur, if no flow control is provided. + +#### 10.2.4.5.2 Conditions requiring flow control towards the UE + +The L2R function will transmit to the UE a "flow control active indication", if flow control is provided, in the following circumstances: + +- 1) if the receive buffer from the radio side reaches a preset threshold (BACK PRESSURE); +- 2) if a flow control indication is received from the fixed network customer. On receipt of this flow control indication, transmission of data from the receive buffers towards the fixed network terminal is halted. + +On removal of the buffer congestion or fixed network flow control indication, the L2R function will send a "flow control inactive" indication towards the UE. In addition, for the fixed network indication, transmission of data from the receive buffers will be restarted. + +If no flow control is provided at the L2R function, no flow control initiation/removal will take place by the MSC/IWF. Data might be lost without any indication by the MSC/IWF to the end systems involved. + +#### 10.2.4.6 Data buffers + +##### 10.2.4.6.1 Transmit buffers (towards UE) + +Incoming data from the fixed network customer shall be buffered such that if the MSC/IWF is unable to transfer data over the radio path the data is not lost. + +The buffer shall be capable of holding the data. Its size is up to the implementers. When the buffer is half full flow control towards the fixed network shall be initiated if flow control is provided as per subclause 10.2.4.5.1. + +##### 10.2.4.6.2 Receive buffers (from UE) + +Incoming data from the UE is buffered such that if the fixed network terminal is unable to accept the data then it is not lost. + +The buffer shall be capable of holding the data. Its size is up to the implementers. When the buffer becomes half full, the L2R function will send a "flow control active" indication towards the UE if flow control is provided at the L2R function, as per subclause 10.2.4.5.2. + +#### 10.2.4.7 BREAK Indication + +The BREAK indication is managed as detailed in subclause 9.2.4.7. + +When V.120 rate adaptation is being used in protocol sensitive asynchronous mode on the ISDN, the L2R break condition shall map on to the BR bit of the V.120 header octet. + +#### 10.2.4.8 Signalling mapping of modem or ISDN (V.110, V.120 or PIAFS) TA-function status information + +Status information is carried between the modem or ISDN (V.110, V.120 or PIAFS) TA-function in the IWF and the terminal adaption function in the UE by the L2R function. The L2RCOP entity transfers interface status information between L2Rs via the status octets SA, SB and X in L2RCOP-PDUs (3GPP TS 27.002). Table 9 shows the mapping scheme between the V.24 circuit numbers corresponding to the V-series DCE functions and the status bits for the non-transparent mode. It also shows how the unused status bits should be handled. It is derived from the General Mapping scheme described in annex B. A binary 0 corresponds to the ON condition, a binary 1 to the OFF condition. + +NOTE. Although the interface to the ISDN TA function is described in terms of V.24 interchange circuit functions, this does not imply that such circuits need to be physically realised. + +**Table 9: Mapping scheme at the IWF for the non-transparent mode** + +| Mapping direction: UE to IWF | Mapping direction: IWF to UE | Signal at IWF ISDN TA interface or condition within the IWF | +|------------------------------|------------------------------|-------------------------------------------------------------| +| always ON (note 1) | | CT 105 | +| | to status bit X (notes 4, 7) | CT 106 (note 7) | +| | not mapped (note 5) | CT 107 | +| not mapped (note 6) | | CT 108 | +| | to status bit SB | CT 109 | +| from status bit X (note 8) | | CT 133 (notes 3, 8) | +| from status bit SA (note 2) | | ignored by IWF | +| from status bit SB (note 1) | | ignored by IWF | +| | to status bit SA (note 2) | always ON | + +NOTE 1: The SB bit towards the IWF, according to the General Mapping (annex B), could be used to carry CT 105 from the mobile DTE to the ISDN TA function in the IWF. However, CT 105 should always be ON at the mobile DTE interface in the data transfer state since only duplex operation is supported. Also, many DTEs use the connector pin assigned to CT 105 for CT 133. Therefore, CT 105 shall always be set to ON at the ISDN TA function during the data transfer state. + +NOTE 2: The SA bits (both directions) are not mapped since CTs 107 and 108 are handled locally (notes 5, 6). + +NOTE 3: The condition of CT 133 (or other flow control mechanism) may also be affected by the state of the L2R transmit buffer (towards the UE) in the IWF and the state of RLP (RR/RNR). + +NOTE 4: The condition of status bit X towards the UE may also be affected by the state of the L2R receive buffer in the IWF (from the UE). + +NOTE 5: CT 107 is not used by the IWF. + +NOTE 6: CT 108 is used in the call setup and answering processes. + +NOTE 7: For inband flow control, CT 106 is not mapped and the status bit X towards the UE is controlled by the reception of XON and XOFF characters from the ISDN TA function. + +NOTE 8: For inband flow control, changes in the condition of the status bit X from the UE result in the sending of XON or XOFF to the ISDN TA function. CT 133 is always set to ON. + +#### 10.2.4.9 Support of out-band flow control + +Out-band flow control in the case of V.110 rate adaption requires V.110 TA to TA "end-to-end flow control" as defined therein. If this functionality is requested by UE but cannot be supported by the MSC/IWF for any reason (refer also to note 15 of table 7B) the call pending shall be released. + +For V.120 interworking, outband flow control shall be as follows. In Multiple frame acknowledged mode the functions of the data link control sublayer (send RNR or withhold update of the sequence state variable V(R)) shall be used. In Unacknowledged mode the RR bit in the Control State octet shall be used. + +#### 10.2.4.10 Synchronizations + +In case of interworking to the ISDN "3,1kHz audio" bearer service the synchronization process is as for the PSTN interworking case (see subclause 9.2.3.4). In case of interworking to the ISDN unrestricted digital bearer service the following synchronization process shall be performed: + +##### 10.2.4.10.1 V.110 and V.120 Frame synchronizations + +The ISDN frame synchronizations will need to be mapped to the frame synchronizations utilized on the MSC/IWF to MSC link. + +##### 10.2.4.10.2 RLP Frame start indication + +The frame start indication is defined in 3GPP TS 48.020. Link establishment and frame error recovery are defined in 3GPP TS 24.022. + +##### 10.2.4.10.3 L2R Frame synchronizations + +The synchronizations of user data and its interaction between the L2R function and RLP function are defined in 3GPP TS 27 series. + +##### 10.2.4.10.4 Establishment of end-to-end terminal synchronizations + +Prior to exposing the traffic channel of a PLMN connection to transmission of user data, the controlling entities of the connection shall assure of the availability of the traffic channel. This is done by a so called synchronization process: + +- starting on the indication of "physical connection established" resulting from the PLMN-inherent outband signalling procedure This indication is : + - for MOC: on sending the CONNECT message; + - for MTC: on sending the CONNECT ACKNOWLEDGE message; + - for mobile initiated in-call modification: on sending the MODIFY COMPLETE message (which is sent after reception of the ASSIGNMENT COMPLETE or RAB ASSIGNMENT RESPONSE message); and + - for network initiated in-call modification: on reception of the ASSIGNMENT COMPLETE or RAB ASSIGNMENT RESPONSE message; +- ending by indicating the successful execution of this process to the controlling entity, which then takes care of the further use of the in-band information (data, status). + +Network interworking within an MSC/IWF is concerned with the terminating side (to the UE) and the transit side (to the fixed network) of a connection. Both sides shall be treated individually related to the synchronization process. + +###### 10.2.4.10.4.1 Terminating side (towards the UE) + +The procedures are the same as for the modem case. + +###### 10.2.4.10.4.2 Transit side (towards the fixed network) + +Depending upon implementation, the synchronization of the V.110 or V.120 rate adaptation protocol on the ISDN transit network may be performed either after RLP establishment or in parallel to the RLP establishment. In case of the parallel establishment, data received from the transit side during RLP establishment shall be stored within the L2R buffers until the RLP establishment at the terminating side has been finished. When the RLP has been established and on recognizing frame alignment the information from/to the RLP is mapped by the L2R entity applicable to this particular bearer capability. + +For V.110 rate adaptation on the ISDN, the synchronization process consists of sending the V.110 frame structure and looking for incoming frame synchronization according to the procedures in ITU-T Recommendation V.110. + +For V.120 rate adaptation the following applies. In Multiple frame acknowledged mode, data (I frames) may be sent following an exchange of SABME and UA in the traffic channel. In Unacknowledged mode, data (UI frames) may be sent immediately after an ISUP CONNECT or CONNECT COMPLETE message has been received on the ISDN signalling channel. Optionally, an XID exchange may take place in the traffic channel to verify link integrity. + +Note. V.120 allows UI frames to be sent in Multiple frame acknowledged mode at any time in addition to I frames. Whilst the IWF shall not follow this procedure when sending frames, such a sequence of I and UI frames may be received by the IWF. Although not specified in V.120, it is recommended that the IWF should deliver to the UE, the contents of the sequence of I and UI frames in the order in which they are received. + +For PIAFS rate adaptation the following applies. Data frame is sent following an exchange of initial negotiation and control frame in the traffic channel. + +#### 10.2.4.11 Data compression + +When data compression is invoked within a non-transparent bearer service, interworking to the ISDN is realized by mapping the PLMN user rate to at least the same user rate in the ISDN. When the ISDN user rate is the same flow control will ensure data integrity, but the overall performance will be slow. When the ISDN user rate is higher the overall performance may be faster. + +#### 10.2.4.12 Additional aspects of V.120 Interworking + +V.120 rate adaptation may be invoked with asynchronous services only. V.120 is applicable to both UDI and RDI connections. + +##### 10.2.4.12.1 V.120 Signalling parameters + +The signalling parameters relevant to V.120 will be carried in the ISDN LLC and PLMN BC and PLMN LLC information elements. The mapping of the parameter values takes place in the MSC/IWF. + +For mobile terminated calls both single-numbering and multi-numbering scenarios may apply, as defined in subclause 9.2.2. The HLR shall not store an ISDN LLC with the MSISDN. + +##### 10.2.4.12.2 V.120 Protocol parameters + +The following restrictions apply for the parameters relevant for V.120: + +- BS 20 NT will use the protocol sensitive asynchronous mode. As a consequence, the rate adaption header shall always be present. +- Only the default logical link will be established, i.e. the LLI negotiation value is "Default, LLI=256 only". +- V.120 recommends the use of the multiple frame acknowledged information transfer procedure for the protocol sensitive mode of operation. +- The IWF shall use the default value for the V.120 window size and the default value for the maximum transmit information field size. It shall be able to receive frames with the default maximum size. + +NOTE: V.120 does not specify the values for these and other HDLC-related parameters directly. They are specified in Q.922 (1992) section 5.9. The information field includes the V.120 terminal adaption data field, the rate adaption header and the header extension (Control State octet), if present. + +##### 10.2.4.12.3 Data compression on the ISDN + +Whilst V.110 rate adaptation does not support standardized data compression, V.42bis data compression may be used with V.120 protocol sensitive asynchronous mode. This is described in V.120 (10/96) annex C. + +##### 10.2.4.12.4 Use of the V.120 Control State (header extension) octet + +The bits in the V.120 Control State octet are not used for the control of V.24 interface circuits. In unacknowledged mode the RR bit in the Control State octet is used to carry flow control information between the peer terminal adaption protocol entities. In acknowledged mode the Control State octet is not required. + +## 10.2.4.13 Interworking with restricted 64 kbit/s networks + +### 10.2.4.13.1 Rate adaptation + +Both V.110 and V.120 rate adaption protocols may be used on a restricted 64 kbit/s network. + +For V.110 rate adaption, the procedure is described in ITU-T Recommendation I.464. The RA2 function shall set the 8th bit of each octet in the 64 kbit/s stream to binary 1. A consequence of this is that the highest permitted intermediate rate is 32 kbit/s. At the receiver, the 8th bit shall be ignored. + +Rec. V.120 states that the user data shall be rate adapted to 56 kbit/s by using only the first 7 bits of each octet in the 64 kbit/s stream. The 8th bit shall be set to binary 1. At the receiver, the 8th bit shall be ignored. + +### 10.2.4.13.2 MSC - ISDN signalling + +When interworking indirectly with restricted 64 kbit/s networks the ISDN BC information element shall be coded according to ETR 018 (as shown in the notes to tables 7A and 7B). The information corresponding to the PLMN BC-IE shall be communicated in the ISDN LLC-IE which shall be provided by the UE for mobile originated calls. + +In the case of direct interworking, an ITC = RDI in the PLMN BC-IE maps on to an ITC = RDI in the ISDN BC-IE for both MO and MT calls. + +## 10.2.4.14 Service level up and down grading + +Text in 9.2.4.12 applies here as well. + +## 10.2.4.15 Interworking in Frame Tunneling Mode + +Figure 14 below shows the protocol stack used for FTM. The interface between the two asynchronous-synchronous conversion functions in the IWF and the remote terminal adapter (TA) is a 64 kbit/s UDI or a 56 kbit/s RDI connection. X.31 flag stuffing is used to adapt the rate between the two conversion functions. Data transparency is provided through bit stuffing. + +![Figure 14: The FTM protocol stack diagram. The diagram shows three main components: a TA (Terminal Adapter) on the left, an MSC/IWF (Mobile Switching Center/Interworking Function) in the center, and a remote terminal adapter on the right. The TA contains a 'Higher layer (e.g., PPP)' connected to a 'TAF' block, which contains 'D L2RCOP C', 'RLP', and 'L1'. The MSC/IWF contains 'L2RCOP D C', 'RLP', and a 'Conv' block with 'A-HDLC' and 'S-HDLC'. The remote terminal adapter contains a 'Higher layer (e.g., PPP)' connected to a 'Conv' block with 'S-HDLC' and 'A-HDLC'. A red double-headed arrow connects the 'Higher layer (e.g., PPP)' in the TA to the 'Higher layer (e.g., PPP)' in the remote terminal adapter. The 'L1' block in the TA is connected to the 'Conv' block in the MSC/IWF, which is then connected to the 'Conv' block in the remote terminal adapter.](24a27d17656bcf0ee131539f2bbb34cd_img.jpg) + +Figure 14: The FTM protocol stack diagram. The diagram shows three main components: a TA (Terminal Adapter) on the left, an MSC/IWF (Mobile Switching Center/Interworking Function) in the center, and a remote terminal adapter on the right. The TA contains a 'Higher layer (e.g., PPP)' connected to a 'TAF' block, which contains 'D L2RCOP C', 'RLP', and 'L1'. The MSC/IWF contains 'L2RCOP D C', 'RLP', and a 'Conv' block with 'A-HDLC' and 'S-HDLC'. The remote terminal adapter contains a 'Higher layer (e.g., PPP)' connected to a 'Conv' block with 'S-HDLC' and 'A-HDLC'. A red double-headed arrow connects the 'Higher layer (e.g., PPP)' in the TA to the 'Higher layer (e.g., PPP)' in the remote terminal adapter. The 'L1' block in the TA is connected to the 'Conv' block in the MSC/IWF, which is then connected to the 'Conv' block in the remote terminal adapter. + +Figure 14: The FTM protocol stack + +Data compression between the TAF and the IWF is optionally applied. The asynchronous to synchronous HDLC conversion follows from ISO/IEC 3309[48]. + +A particular aspect of the asynchronous HDLC protocol is the provision of control character transparency. This means that flags (0x7E) and the control escape character (0x7D) are escaped, by insertion of the control escape character in front of the character to be escaped, and that the 6th bit of the escaped character is complemented (i.e., the escaped character is XOR'ed with 0x20). ISO/IEC 3309[48] allows additional control characters to be escaped by prior agreement or negotiation between the peer entities. For instance, in PPP [49], a negotiation procedure is defined using an Asynchronous Control Character Map (ACCM). By examining the contents of the HDLC frames that pass through it, the IWF shall identify whether the higher layer protocol is PPP, in which case, it shall detect and interpret the ACCM negotiation result. If PPP is used, the conversion function in the IWF shall apply a default ACCM until another is negotiated. + +### 10.2.4.16 Additional aspects of PIAFS Interworking + +PIAFS has several U-Plane protocol suites, but "Data Transmission Protocol (fixed rate)"[50] is only applied for UTRAN Iu mode in consideration of simplicity. Details of frame structure and retransmission procedure etc. conform to reference [50]. + +In case of 32kbit/s mode, IWF performs rate adaptation based on I.460 for fixed network. + +In case of 64 kbit/s mode, restriction on throughput may be caused by (the maximum frame length of 572bits in RLP). + +## 10.2.5 DTE/DCE interface (Filtering) + +This is described in section 9.2.5. + +# 10.3 Interworking Alternate speech facsimile group 3 calls + +## 10.3.1 Alternate speech data bearer interworking + +### 10.3.1.1 General + +The procedure for the alternate speech/facsimile group 3 service is invoked at the UE-MSC link during the call set-up phase. This service is invoked by indication of repeated bearer capability information elements in the setup message and/or call confirmed message, respectively (preceded by a repeat indicator "circular"), one indicating speech and the other indicating "facsimile group 3" plus user rate etc., as for normal single calls. The bearer capability first indicated i.e. speech or facsimile determines the first selection required of the network by the subscriber. Depending on the type of service requested and direction of call establishment (MO/MT, see relevant clauses of the 3GPP TS 27 series) low layer and high layer capabilities may also be included. The MSC/IWF will perform both compatibility checking and subscription checking for mobile originated calls and optionally for mobile terminated calls (single numbering scheme) on both sets of capabilities as for normal data calls. If either the subscription check or the compatibility check fails then the call shall be rejected. The only exception to this is when TS61/TS62 negotiation takes place, see 3GPP TS 27.001. + +As regards the supplementary services the application rules are laid down in 3GPP TS 22.004. + +The speech phase of the call, when invoked, is handled by the transcoder and will utilize the normal telephony teleservice interworking requirements and mobile network capabilities. The Facsimile group 3 phase of the call, when invoked, shall utilize the appropriate data interworking capability (e.g. IWF) and shall use the transparent mobile network capability in A/Gb mode or the non-transparent mobile network capability in UTRAN Iu mode. + +The network shall provide, for service and operational reasons, a rapid and reliable changeover of capability upon request from the mobile user. This changeover may involve the disabling, by-passing or introduction of particular network functions (e.g. speech coder, modem etc.) and change of the channel configuration on the radio interface. This changeover is initiated on the receipt of the "MODIFY" message (see 3GPP TS 24.008) from the UE. The network itself will not initiate a changeover. + +### 10.3.1.2 Mobile originated ISDN terminated + +If one bearer capability information element indicates the ITC value "facsimile group 3", the call set up is as for the PSTN case. Interworking is provided to the ISDN bearer service 3,1 kHz audio for the whole connection, including the speech phase. The MODIFY message (see 3GPP TS 24.008) will be generated by the mobile subscriber. This message is not transmitted to the ISDN, i.e. no outband correlation between the user on the fixed network and the mobile user will be possible. In this instance it is necessary for change of network capabilities to be carried out in the mobile network. + +### 10.3.1.3 ISDN originated mobile terminated + +In principle this is handled as for a normal ISDN originated call. + +However when the calling user indicates an ISDN BC-IE with an ITC value "3,1 kHz audio" and an HLC "facsimile group 3", i.e. the call arrives at the PLMN with compatibility information allowing for deducing the Teleservice "Facsimile transmission", the call setup is as described in subclause 10.2.2.3 case 3 in the HLR, and subclause 10.2.2.4 case 5 in the VMSC. + +In the information transfer phase the call is dealt with as indicated in the previous paragraph. + +## 10.4 3G-H.324/M calls over UDI/RDI + +3G-H.324/M calls provide UDI/RDI (e.g. 32 kbit/s transparent data, 56 kbit/s transparent data or 64 kbit/s transparent data). H.223 and H.245 flow is not terminated in the MSC. + +3G-H.324 calls over 64 kbit/s transparent data and 56kbit/s transparent data can be connected to H.324/I calls over UDI/RDI. H.223 protocol is transparent to IWF. + +In case of 3G-H.324M calls over 32 kbit/s, IWF which performs rate adaptation between 64kbit/s and 32kbit/s is used. Rate adaptation is based on ITU-T Recommendation I.460. + +The Service Change and Fallback functionality for UDI/RDI multimedia calls is described in 3GPP TS 23.172 [83]. + +The support of IWF which transcodes the multiplexes and the content of control, audio, video and data in MSC is FFS. + +### 10.4.1 Mobile originated multimedia call + +#### 10.4.1.1 Call setup + +The setup message sent by the UE contains either a multimedia BC-IE indicating a multimedia only call request (*i.e.* no fallback / service change allowed) or both a speech BC-IE and a multimedia BC-IE to indicate the support of fallback and service change (see 3GPP TS 27.001 [43] and 3GPP TS 24.008 [40]). + +The MSC shall not accept a requested service to which the user is not provisioned for. Provided that the user is provisioned for the BS30 bearer service – and/or speech the following applies : + +- in case of a multimedia only BC-IE, the MSC shall either accept the setup as such or with modifications sent to the UE in the call proceeding message (see 3GPP TS 27.001 [43]) ; +- in case of both a speech BC-IE and a multimedia BC-IE in either order, the MSC shall either accept the possibility of fallback or service change by responding with the two BC-IEs in the same order as received, in the reverse order (relayed from terminating user), or turn the call to a speech call by sending only a speech BC-IE in the call proceeding message, or turn the call to a multimedia only call by sending only the multimedia BC-IE in the call proceeding message (see 3GPP TS 27.001 [43]). +- in case of a multimedia BC-IE with FNUR = 32 kbit/s and a speech BC-IE, the MSC shall reply with only a multimedia BC-IE in the call proceeding message (see 3GPP TS 23.172 [83]). + +#### 10.4.1.2 Fallback after setup + +If the MSC has accepted the possibility of a fallback and service change, and the transit network or the terminating side does not allow one of the bearers, the MSC shall initiate an In-Call Modification procedure (see 3GPP TS 24.008 [40]) in order to fallback to the allowed mode. As a result of the procedure, the radio and network resources are modified and the relevant channel is set up between the calling UE and the fixed network. If the fallback fails, *e.g.* due to an unsuccessful In-Call Modification procedure, the MSC shall clear the call. + +#### 10.4.1.3 User initiated service change after setup + +If the MSC has accepted the possibility of a service change and the user initiates an In-Call Modification procedure (see 3GPP TS 24.008 [40]) in order to change the service either from speech to multimedia or vice-versa, the MSC shall invoke the service change as an In-Call Modification procedure. As a result of the procedure, the radio and core network resources are modified in order to comply with the requested service change. + +## 10.4.2 Mobile terminated multimedia call + +### 10.4.2.1 Call setup + +If the user is provisioned to use both the transparent bearer service (for multimedia) and the speech teleservice, and if the network supports both services and the service change functionality, the MSC shall send both a multimedia BC-IE and a speech BC-IE in the setup message to the mobile station. In case the MSC receives a multimedia call, the multimedia BC-IE is prioritised (first BC). In case the MSC receives a speech call, the speech BC is prioritised. + +If the user is provisioned to use only the transparent bearer service and if the network supports the multimedia service, the MSC shall only send a multimedia BC-IE, which results in a fallback to multimedia if the call was a speech call. + +If the user is provisioned to use only the speech teleservice, the MSC shall only send a speech BC-IE, which results in a fallback to speech if the call was a multimedia call. + +In case both a speech BC-IE and a multimedia BC-IE are included in the setup message, the mobile station shall either accept the service change capability by responding with two BC-IEs in the same or reversed order, or turn the call to a speech call by sending only a speech BC-IE in the call confirmed message, or to a multimedia only call (*i.e.* no service change allowed) by sending only a multimedia BC-IE in the call confirmed message. + +In case of a multimedia only BC-IE in the setup, the UE may accept the setup as such or with modifications sent to the MSC in the call confirmed message. + +#### 10.4.2.2 User initiated service change after setup + +If the MSC supports the possibility of a service change and the user initiates an In-Call Modification procedure (see 3GPP TS 24.008 [40]) in order to change the service either from speech to multimedia or vice-versa, the MSC shall invoke the service change as an In-Call Modification procedure. As a result of the procedure, the radio and core network resources are modified in order to comply with the requested service change. + +--- + +## 11 Interworking between A/Gb mode MSC and Iu mode MSC + +### 11.0 Signalling issues + +#### 11.0.1 Loss of BC Information during Handover from A/Gb mode to UTRAN Iu mode + +In the case of inter-MSC handover from A/Gb mode to UTRAN Iu mode, the serving A/Gb mode MSC/VLR sends a MAP message Prepare Handover carrying the BSSMAP message Handover Request. This message includes the parameter Channel Type, indicating whether radio resources are to be allocated for speech or data (parameter 'Speech or data indicator') and, among other data, the type of data service (transparent/non transparent) and the user rates (both included in the parameter 'Data rate and transparency indicator'). + +As no other bearer capability related parameters are received, it is not possible to distinguish between any other services than 'speech', 'data transparent' and 'data non-transparent'. + +The mapping into QoS radio access parameters would be done as described in 3GPP TS 27.001[86], annex B, subclause B.1.13., limited to the services 'speech', 'data, non-transparent' and 'data, transparent'. + +#### 11.0.2 Handover from UTRAN Iu mode to A/Gb mode + +In case a UTRAN Iu mode call is set up in the CN, the BC IE parameters are mapped into QoS RAB parameters at call setup. + +If the CN has to perform a handover towards A/Gb mode, the non-anchor MSC needs to perform an assignment based on GSM traffic channel parameters. + +In case of handover from UTRAN Iu mode to A/Gb mode, the anchor MSC maps the BC IE parameters into A/Gb mode traffic channel parameters. This requires that the BC IE is coded according to A/Gb mode protocol requirements, *i.e.* all those parameters ignored in UTRAN Iu mode should nevertheless be correctly specified by the UE in order to perform a handover to A/Gb mode. + +#### 11.0.3 Loss of BC Information during Handover from A/Gb mode to GERAN Iu mode + +Subclause 11.0.1 applies also to handover from A/Gb mode to GERAN Iu mode. + +Additionally, the serving A/Gb mode MSC/VLR will include the parameter GERAN Classmark in the MAP message Prepare Handover, if this parameter is available. The GERAN Classmark, which indicates the capabilities of the BSS in the target cell (e.g. allowed channel codings and maximum number of traffic channels), shall be taken into account by the target MSC when it performs the mapping into QoS radio access parameters. + +### 11.0.4 Handover from GERAN Iu mode to A/Gb mode + +Subclause 11.0.2 applies also to handover from GERAN Iu mode to A/Gb mode. + +NOTE: The protocol requirements for the coding of the BC IE according to GERAN Iu mode are the same as for A/Gb mode, i.e. all those parameters needed in order to perform a handover to A/Gb mode are available. + +### 11.0.5 Handover from UTRAN Iu mode to GERAN Iu mode + +The serving UTRAN Iu mode MSC/VLR will send a MAP message Prepare Handover carrying the RANAP message Relocation Request. When setting the QoS RAB parameters in the RANAP message Relocation Request, the serving UTRAN Iu mode MSC/VLR shall take into account: + +- the GERAN Classmark of the target cell, if this parameter is available; +- the allowed channel codings and the maximum number of traffic channels from the BC IE, if the serving MSC is the anchor MSC; and +- the allowed radio interface rates (included in the parameter Channel Type), if the serving MSC is not the anchor MSC. + +This requires that the BC IE is coded according to GERAN Iu mode protocol requirements, i.e. all those parameters ignored in UTRAN Iu mode should nevertheless be correctly specified by the UE in order to perform a handover to GERAN Iu mode. Furthermore, it requires that the anchor MSC maps the BC IE parameters into A/Gb mode traffic channel parameters and includes the parameter Channel Type in the MAP message Prepare Handover also for basic handover to UTRAN Iu mode. + +### 11.0.6 Handover from GERAN Iu mode to UTRAN Iu mode + +The serving GERAN Iu mode MSC/VLR will send a MAP message Prepare Handover carrying the RANAP message Relocation Request. When setting the QoS RAB parameters in the RANAP message Relocation Request, the serving GERAN Iu mode MSC/VLR shall take the mode of the target cell into account. (See 3GPP TS 27.001[86], annex B, subclause B.1.13. For non-transparent services, some of the RAB Subflow Combination bit rates are supported in GERAN Iu mode, but not in UTRAN Iu mode.) + +## 11.1 Handover to A/Gb mode MSC + +After a handover from an Iu mode MSC or an A/Gb mode MSC to an A/Gb mode MSC the user plane between the anchor MSC and the visited MSC shall comply to: + +- the standard A-interface protocols if both MSCs are connected via a TDM interface, i.e.: + - A-TRAU or modified V.110 frames as defined in 3GPP TS 44.021 [27] and 3GPP TS 48.020 [28]; + - up to four 16kbit/s substreams are multiplexed in one 64kbit/s channel (Split/Combine function and Multiplexing function as defined in 3GPP TS 44.021 [27] and 3GPP TS 48.020 [28]). +- the Nb UP protocol if the anchor MSC or MGW and the visited MSC or MGW are connected via an ATM transport interface or IP transport interface in a BICC based CS CN. The NbUP shall be configured in support mode, the data is transported in a 64 kbit/s bit stream, formatted in SDUs of 40 octets and transmitted every 5 ms, in accordance with Annex P of ITU-T Recommendation I.366.2 [81]. PDU type 0 is used, i.e., payload CRC is applied. This is needed for the framing to be handled the same for all transports but the Frame Quality Classification control shall be ignored (3GUP property Delivery Of Erroneous SDUs = yes) and therefore interim nodes shall only pass on the CRC. The data is encoded between MSC-B/MGW-B (non-Anchor) and MSC-A/MGW-A (Anchor) as for the TDM case. Furthermore, Clause 11a.1.3 is applicable. +- the CLEARMODE payload type, see IETF RFC 4040 [92], within RTP/IP if SIP-I over Nc is deployed in the CN. The data is transported in a 64 kbit/s bit stream. The data is encoded between MSC-B/MGW-B (non-Anchor) and MSC-A/MGW-A (Anchor) as for the TDM case. Furthermore, Clause 11a.1.3 is applicable. + +## 11.2 Handover from A/Gb mode MSC to UTRAN Iu mode MSC + +After a handover from an A/Gb mode MSC to an UTRAN Iu mode MSC the user plane between the anchor MSC and the visited MSC shall comply to: + +- the A-TRAU' protocol if both MSCs are connected via a TDM interface except for FNUR = 32 kbit/s (ITC = UDI), FNUR = 56 kbit/s (ITC=RDI) and FNUR = 64 kbit/s (ITC=UDI). For these exceptions a plain 64 kbit/s channel is used between the MSCs. +- the Nb UP protocol if the anchor MSC or MGW and the visited MSC or MGW are connected via an ATM transport interface or IP transport interface in a BICC based CS CN. The NbUP shall be configured in support mode, the data is transported in a 64 kbit/s bit stream, formatted in SDUs of 40 octets and transmitted every 5 ms, in accordance with Annex P of ITU-T Recommendation I.366.2 [81]. PDU type 0 is used, i.e., payload CRC is applied. This is needed for the framing to be handled the same for all transports but the Frame Quality Classification control shall be ignored (3GUP property Delivery Of Erroneous SDUs = yes) and therefore interim nodes shall only pass on the CRC. The data is encoded between MSC-B/MGW-B (non-Anchor) and MSC-A/MGW-A (Anchor) as for the TDM case (A-TRAU' protocol or plain 64kbits/s). Furthermore, Clause 11a.1.3 is applicable. +- the CLEARMODE payload type, see IETF RFC 4040 [92], within RTP/IP if SIP-I over Nc is deployed in the CN. The data is transported in a 64 kbit/s bit stream. The data is encoded between MSC-B/MGW-B (non-Anchor) and MSC-A/MGW-A (Anchor) as for the TDM case. Furthermore, Clause 11a.1.3 is applicable. + +## 11.3 Handover from A/Gb mode MSC to GERAN Iu mode MSC + +### 11.3.1 User plane for transparent services + +After a handover from a GERAN A/Gb mode MSC to a GERAN Iu mode MSC the user plane for transparent services between the anchor MSC and the visited MSC shall comply to: + +- the A-TRAU' protocol except for FNUR = 32 kbit/s (ITC = UDI), FNUR = 56 kbit/s (ITC=RDI) and FNUR = 64 kbit/s (ITC = UDI). For these exceptions a plain 64 kbit/s channel is used between the MSCs. The rate adaptation between 64 kbit/s and 32 kbit/s is based on ITU-T Recommendation I.460. +- the Nb UP protocol if the anchor MSC or MGW and the visited MSC or MGW are connected via an ATM transport interface or IP transport interface in a BICC based CS CN. The NbUP shall be configured in support mode, the data is transported in a 64 kbit/s bit stream, formatted in SDUs of 40 octets and transmitted every 5 ms, in accordance with Annex P of ITU-T Recommendation I.366.2 [81]. PDU type 0 is used, i.e., payload CRC is applied. This is needed for the framing to be handled the same for all transports but the Frame Quality Classification control shall be ignored (3GUP property Delivery Of Erroneous SDUs = yes) and therefore interim nodes shall only pass on the CRC. The data is encoded between MSC-B/MGW-B (non-Anchor) and MSC-A/MGW-A (Anchor) as for the TDM case (A-TRAU' protocol or plain 64kbits/s). Furthermore, Clause 11a.1.3 is applicable. +- the CLEARMODE payload type, see IETF RFC 4040 [92], within RTP/IP if SIP-I over Nc is deployed in the CN. The data is transported in a 64 kbit/s bit stream. The data is encoded between MSC-B/MGW-B (non-Anchor) and MSC-A/MGW-A (Anchor) as for the TDM case. Furthermore, Clause 11a.1.3 is applicable. + +### 11.3.2 User plane for non-transparent services + +After a handover from a GERAN A/Gb mode MSC to a GERAN Iu mode MSC the user plane for transparent services between the anchor MSC and the visited MSC shall comply to: + +- the A-TRAU'' protocol as defined below for the RAB subflows with 12 kbit/s, 24 kbit/s, 36 kbit/s and 48 kbit/s and the A-TRAU' protocol for the RAB subflows with 14,4 kbit/s, 28,8 kbit/s, 43,2 kbit/s and 57,6 kbit/s, if both MSCs are connected via a TDM interface. +- the Nb UP protocol if the anchor MSC or MGW and the visited MSC or MGW are connected via an ATM transport interface or IP transport interface in a BICC based CS CN. The NbUP shall be configured in support mode, the data is transported in a 64 kbit/s bit stream, formatted in SDUs of 40 octets and transmitted every 5 ms, in accordance with Annex P of ITU-T Recommendation I.366.2 [81]. PDU type 0 is used, i.e., payload CRC is applied. This is needed for the framing to be handled the same for all transports but the Frame Quality Classification control shall be ignored (3GUP property Delivery Of Erroneous SDUs = yes) and therefore + +interim nodes shall only pass on the CRC. The data is encoded between MSC-B/MGW-B (non-Anchor) and MSC-A/MGW-A (Anchor) as for the TDM case (A-TRAU'' or A-TRAU' protocol). Furthermore, Clause 11a.1.3 is applicable. + +- the CLEARMODE payload type, see IETF RFC 4040 [92], within RTP/IP if SIP-I over Nc is deployed in the CN. The data is transported in a 64 kbit/s bit stream. The data is encoded between MSC-B/MGW-B (non-Anchor) and MSC-A/MGW-A (Anchor) as for the TDM case. Furthermore, Clause 11a.1.3 is applicable + +## 11.4 Handover within Iu mode PLMNs + +After a handover from an Iu mode MSC to a UTRAN Iu mode MSC the user plane between the anchor MSC or MGW and the visited MSC or MGW shall comply to: + +- the A-TRAU' protocol if both MSCs are connected via a TDM interface except for the transparent case FNUR = 32 kbit/s (ITC = UDI or RDI), FNUR = 56 kbit/s (ITC=RDI) and FNUR = 64 kbit/s (ITC=UDI). For these exceptions a plain 64 kbit/s channel is used between the MSCs. The rate adaptation between 64 kbit/s and 32 kbit/s is based on ITU-T Recommendation I.460 [2]. +- the Nb UP protocol if the anchor MSC or MGW and the visited MSC or MGW are connected via an ATM transport interface or IP transport interface in a BICC based CS CN. The NbUP shall be configured in support mode, the data is transported in a 64 kbit/s bit stream, formatted in SDUs of 40 octets and transmitted every 5 ms, in accordance with Annex P of ITU-T Recommendation I.366.2 [81]. PDU type 0 is used, i.e., payload CRC is applied. This is needed for the framing to be handled the same for all transports but the Frame Quality Classification control shall be ignored (3GUP property Delivery Of Erroneous SDUs = yes) and therefore interim nodes shall only pass on the CRC. The data is encoded between MSC-B/MGW-B (non-Anchor) and MSC-A/MGW-A (Anchor) as for the TDM case (A-TRAU' protocol or plain 64kbits/s). +- the CLEARMODE payload type, see IETF RFC 4040 [92], within RTP/IP if SIP-I over Nc is deployed in the CN. The data is transported in a 64 kbit/s bit stream. The data is encoded between MSC-B/MGW-B (non-Anchor) and MSC-A/MGW-A (Anchor) as for the TDM case. Furthermore, Clause 11a.1.3 is applicable. + +After a handover from an Iu mode MSC to a GERAN Iu mode MSC the user plane between the anchor MSC or MGW and the visited MSC or MGW shall comply to + +- the A-TRAU' or A-TRAU'' protocol or a plain 64 kbit/s channel if both MSC are connected via a TDM interface. The A-TRAU' protocol shall be used for transparent services except for the transparent cases FNUR = 32 kbit/s (ITC = UDI), FNUR = 56 kbit/s (ITC=RDI) and FNUR = 64 kbit/s (ITC=UDI). For these exceptions a plain 64 kbit/s channel is used between the MSCs. The rate adaptation between 64kbit/s and 32kbit/s is based on ITU-T Recommendation I.460. For non-transparent services, the A-TRAU'' protocol shall be used for the RAB subflows with 12 kbit/s, 24 kbit/s, 36 kbit/s and 48 kbit/s and the A-TRAU' protocol shall be used for the RAB subflows with 14,4 kbit/s, 28,8 kbit/s, 43,2 kbit/s and 57,6 kbit/s. +- the Nb UP protocol if the anchor MSC or MGW and the visited MSC or MGW are connected via an ATM transport interface or IP transport interface in a BICC based CS CN. The NbUP shall be configured in support mode, the data is transported in a 64 kbit/s bit stream, formatted in SDUs of 40 octets and transmitted every 5 ms, in accordance with Annex P of ITU-T Recommendation I.366.2 [81]. PDU type 0 is used, i.e., payload CRC is applied. This is needed for the framing to be handled the same for all transports but the Frame Quality Classification control shall be ignored (3GUP property Delivery Of Erroneous SDUs = yes) and therefore interim nodes shall only pass on the CRC. The data is encoded between MSC-B/MGW-B (non-Anchor) and MSC-A/MGW-A (Anchor) as for the TDM case (A-TRAU'' protocol, A-TRAU' protocol or plain 64kbits/s). Furthermore, Clause 11a.1.3 is applicable. +- the CLEARMODE payload type, see IETF RFC 4040 [92], within RTP/IP if SIP-I over Nc is deployed in the CN. The data is transported in a 64 kbit/s bit stream. The data is encoded between MSC-B/MGW-B (non-Anchor) and MSC-A/MGW-A (Anchor) as for the TDM case. Furthermore, Clause 11a.1.3 is applicable + +## 11.5 Handover for 56kbit/s + +The FNUR = 56 kbit/s in transparent mode can be supported in A/Gb mode by two configurations: + +1. without IWF with the following channel codings + - 2\*TCH/F32.0 + +- 5\*TCH/F9.6 +- 2. with IWF with the following channel coding + - 4\*TCH/F14.4 + +The FNUR = 56 kbit/s in transparent mode is supported in Iu mode by a configuration without IWF only. Therefore handover for 56kbit/s in transparent mode between Iu mode MSC and A/Gb mode can be supported only for configurations without IWF. + +**Note:** Handover between configurations with and without IWF are also not supported within A/Gb mode. + +## 11.6 Void + +# 11a Transport Protocols + +## 11a.1 Core Network + +### 11a.1.0 Overview + +The Nb UP protocol is used to transport user data in BICC based Core Network, see 3GPP TS 29.415 [80]. + +The RTP protocol is used to transport user data in SIP-I based Core Network, see 3GPP TS 29.414 [93]. The CLEARMODE payload type shall be applied, see IETF RFC 4040 [92] for 64k data. + +Figures 16 and 16a below show the different cases to consider: + +1. Transport on the access side of the IWF +2. Transport beyond the IWF, i.e., between the IWF and the fixed network + +![Figure 16: Transport of data within the BICC based Core Network. The diagram shows three MGW (Media Gateway) units connected via Nb interfaces. The first MGW contains a Relay Function and two UP (User Plane) blocks: Iu UP and Nb UP. The second MGW contains an IWF (Interworking Function) and two Nb UP blocks. The third MGW contains an Nb UP block and a TDM (Time Division Multiplex) block. All three MGWs are connected to a common Transport Layer. Vertical dashed lines labeled 'Nb' indicate the interfaces between the MGWs.](05da2a3257316bbf6f448a830dc0380a_img.jpg) + +Figure 16: Transport of data within the BICC based Core Network. The diagram shows three MGW (Media Gateway) units connected via Nb interfaces. The first MGW contains a Relay Function and two UP (User Plane) blocks: Iu UP and Nb UP. The second MGW contains an IWF (Interworking Function) and two Nb UP blocks. The third MGW contains an Nb UP block and a TDM (Time Division Multiplex) block. All three MGWs are connected to a common Transport Layer. Vertical dashed lines labeled 'Nb' indicate the interfaces between the MGWs. + +**Figure 16: Transport of data within the BICC based Core Network** + +![Figure 16a: Transport of data within the SIP-I based Core Network. The diagram shows three MGW (Media Gateway) units connected via Nb interfaces. The first MGW contains a Framing Protocol Interworking block and two UP blocks: Iu UP and CLEARMODE/RTP. The second MGW contains an IWF (Interworking Function) and two CLEARMODE/RTP blocks. The third MGW contains a CLEARMODE/RTP block and a TDM (Time Division Multiplex) block. All three MGWs are connected to a common Transport Layer. Vertical dashed lines labeled 'Nb' indicate the interfaces between the MGWs.](190217f95ce423a68d4a144cbd9df011_img.jpg) + +Figure 16a: Transport of data within the SIP-I based Core Network. The diagram shows three MGW (Media Gateway) units connected via Nb interfaces. The first MGW contains a Framing Protocol Interworking block and two UP blocks: Iu UP and CLEARMODE/RTP. The second MGW contains an IWF (Interworking Function) and two CLEARMODE/RTP blocks. The third MGW contains a CLEARMODE/RTP block and a TDM (Time Division Multiplex) block. All three MGWs are connected to a common Transport Layer. Vertical dashed lines labeled 'Nb' indicate the interfaces between the MGWs. + +**Figure 16a: Transport of data within the SIP-I based Core Network** + +### 11a.1.1 Void + +### 11a.1.2 Transport beyond the IWF + +#### 11a.1.2.1 UDI and RDI + +The data is transported in a 64 kbit/s bit stream, formatted in SDUs of 40 octets and transmitted every 5 ms, in accordance with Annex P of ITU-T Recommendation I.366.2 [81]. For BICC based CS CN, PDU type 0 is used, i.e., payload CRC is applied. + +At the border between the CN and the fixed (ISDN) network, for BICC based CS CN conversion between Nb UP and TDM shall be applied. For SIP-I based CS CN conversion between "CLEARMODE" payload type and TDM shall be applied. In case of RDI interworking, the 56 kbit/s RDI bit stream is transmitted within the CN as 64 kbit/s bit stream where the last bit of each octet is ignored. For this reason the octet alignment shall be preserved in the SDUs transported in the CN. + +#### 11a.1.2.2 Modem + +The modem signals are PCM encoded and transported on a 64 kbit/s bit stream. The transmission is otherwise identical to the UDI/RDI case, see Section 11a.1.2.1 + +### 11a.1.3 Transport on the access side of the IWF + +#### 11a.1.3.0 Inter MSC-Relocation + +After inter-MSC relocation, Clause 11 is applicable. + +Furthermore, for the BICC based CS CN the Nb UP is used in support mode, for SIP-I CLEARMODE/RTP shall be used; all interim Server nodes are assumed not to be aware of the relocation case – i.e. receive BICC IAM with same information as for connections beyond the IWF (Clause 11a.1.2). + +Figure 17 indicates the relevant connections, where MSC-A/MGW-A are the Anchor nodes and MSC-B/MGW-B are the Non-Anchor nodes. The CSD MGW Termination Properties for the terminations in Figure 17 shall be used as described in Tables 16 and 17. + +![Figure 17: Bearer Independent connections for Inter-MSC SRNS Relocation. The diagram shows a network architecture for inter-MSC SRNS relocation. At the top, MSC-A and MSC-B are connected via a MAP interface. MSC-A is connected to MGW-A via a BICC interface (T0). MGW-A is connected to an 'Other party' via T0 and to RNC-A/BSC-A via T1 (Iu/A). MGW-A is also connected to MGW-T via Nb (T2). MGW-T is connected to another MGW-T via Nb (T3, T4). The second MGW-T is connected to MGW-B via Nb (T5, T6). MGW-B is connected to RNC-B/BSC-B via T8 (Iu/A). Servers are connected between MSC-A and MSC-B via BICC/ISUP interfaces (T3, T4, T5, T6).](f59ced6eaab3181501fc23fdfb52297e_img.jpg) + +Figure 17: Bearer Independent connections for Inter-MSC SRNS Relocation. The diagram shows a network architecture for inter-MSC SRNS relocation. At the top, MSC-A and MSC-B are connected via a MAP interface. MSC-A is connected to MGW-A via a BICC interface (T0). MGW-A is connected to an 'Other party' via T0 and to RNC-A/BSC-A via T1 (Iu/A). MGW-A is also connected to MGW-T via Nb (T2). MGW-T is connected to another MGW-T via Nb (T3, T4). The second MGW-T is connected to MGW-B via Nb (T5, T6). MGW-B is connected to RNC-B/BSC-B via T8 (Iu/A). Servers are connected between MSC-A and MSC-B via BICC/ISUP interfaces (T3, T4, T5, T6). + +**Figure 17: Bearer Independent connections for Inter-MSC SRNS Relocation** + +The Iu UP for BICC based CS CN shall be initialised on each Nb leg in a forward direction (regardless if Forward Bearer or Backward Bearer procedures are used), i.e. in the direction of the IAM. For further details see TS 23.205 [83]. + +When setting up the call leg towards MSC-B, the anchor node MSC-A shall request an UDI bearer in out-of-band signalling. For UDI/RDI multimedia calls with fallback and service change according to 3GPP TS 23.172 [17], the anchor node MSC-A shall negotiate the multimedia dummy codec as specified in 3GPP TS 23.153 [91]. + +Figure 18 shows the scenario where the IWF resides in a MGW directly interfacing an Iu or A interface, as encountered e.g. before an inter-MSC handover. The CSD MGW Termination Properties for the terminations in Figure 18 shall be used as described in Tables 16 and 17. + +![Figure 18: IWF in MGW interfacing Iu or A interface. The diagram shows a vertical stack of three boxes. The top box is labeled 'MSC-A'. A line connects it to the middle box, labeled 'MGW-A'. To the left of the MGW-A box, an arrow labeled 'Other party' points to a termination labeled 'T0'. Below the MGW-A box, a line connects it to the bottom box, labeled 'RNC-A / BSC-A'. This connection is labeled 'T1' and 'Iu/A'. On the left side of the MGW-A box, there is a black rectangle labeled 'IWF'.](4dd5f00d74e7db5bbb2d011609bcc43d_img.jpg) + +Figure 18: IWF in MGW interfacing Iu or A interface. The diagram shows a vertical stack of three boxes. The top box is labeled 'MSC-A'. A line connects it to the middle box, labeled 'MGW-A'. To the left of the MGW-A box, an arrow labeled 'Other party' points to a termination labeled 'T0'. Below the MGW-A box, a line connects it to the bottom box, labeled 'RNC-A / BSC-A'. This connection is labeled 'T1' and 'Iu/A'. On the left side of the MGW-A box, there is a black rectangle labeled 'IWF'. + +**Figure 18: IWF in MGW interfacing Iu or A interface** + +#### 11a.1.3.0a Several MGWs controlled by same MSC server + +In other cases than inter-MSC relocation where the IWF is not interfacing an Iu UP layer protocol entity, the following bullets are applicable (For example, an MSC-server may control two MGWs and route the call through both, as one MGW interfaces Iu and the other one hosts the user plane part of the IWF): + +- If the access network uses A/Gb mode, the same transport as described in Clause 11.1 shall be applied. +- If the access network uses Iu mode, the same transport as described in Clause 11.4 shall be applied. + +Furthermore, for BICC CS CN the Nb UP is used in support mode. + +Figure 19 indicates the relevant connections, where MGW-A is where the IWF resides. The CSD MGW Termination Properties for the terminations in Figure 19 shall be used as described in Tables 16 and 17. + +![Figure 19: Transport on the access side of the IWF if the same MSC server controls one MGW A hosting the IWF and another MGW B interfacing the radio access network. The diagram shows an 'MSC' box at the top. Two lines connect it to 'MGW-A' and 'MGW-B' boxes below. The line to MGW-A is labeled 'T0' and 'T2'. The line to MGW-B is labeled 'T7'. A horizontal line labeled 'Nb' connects MGW-A and MGW-B. From MGW-A, an arrow labeled 'Other party' points to a termination labeled 'T0'. On the left side of MGW-A, there is a black rectangle labeled 'IWF'. From MGW-B, a line connects to a box labeled 'RNC-B / BSC-B'. This connection is labeled 'T8' and 'Iu/A'.](7fe4241eea8865aa6d2686d711c13ba6_img.jpg) + +Figure 19: Transport on the access side of the IWF if the same MSC server controls one MGW A hosting the IWF and another MGW B interfacing the radio access network. The diagram shows an 'MSC' box at the top. Two lines connect it to 'MGW-A' and 'MGW-B' boxes below. The line to MGW-A is labeled 'T0' and 'T2'. The line to MGW-B is labeled 'T7'. A horizontal line labeled 'Nb' connects MGW-A and MGW-B. From MGW-A, an arrow labeled 'Other party' points to a termination labeled 'T0'. On the left side of MGW-A, there is a black rectangle labeled 'IWF'. From MGW-B, a line connects to a box labeled 'RNC-B / BSC-B'. This connection is labeled 'T8' and 'Iu/A'. + +**Figure 19: Transport on the access side of the IWF if the same MSC server controls one MGW A hosting the IWF and another MGW B interfacing the radio access network** + +The MSC server selects the direction of the IuUP initialisation if BICC based CS CN. + +### 11a.1.3.1 Non-Transparent CSD + +**Table 16: Non-Transparent CSD MGW Termination Properties For Inter-MSC SRNS Relocation** + +| Termination Packages/Parameters | MSC-A | | | | MSC-B | | | Intermediate Nodes | +|---------------------------------|-----------------------------------------------------|---------|----------------|--------------------------|--------------------------|--------------|----------------|--------------------------| +| | T0 | T1 (lu) | T1 (A) | T2 | T7 | T8 (lu) | T8 (A) | T3, T4, T5, T6 | +| TMR | TMR (NOTE 5) | - | - | UDI (NOTE 3) | UDI | UDI (NOTE 7) | UDI (NOTE 3) | UDI | +| threeegcsd:plmnb | - | PLMN BC | PLMN BC | PLMN BC | - | - | - | - | +| threegup:interface | CN (NOTE 2) | RAN | - | CN (NOTE 2) | CN (NOTE 2) | RAN | - | CN (NOTE 2) | +| threegup:initdir | (NOTE 2) (NOTE 4) | IN | - | OUT (NOTE 2) (NOTE 6) | IN (NOTE 2) (NOTE 6) | OUT | - | IN (NOTE 2) | +| threegup:mode | Support (NOTE 2) | support | - | Support (NOTE 2) | Support (NOTE 2) | support | - | Support (NOTE 2) | +| threeegcsde:bitrate | - | - | - | - | - | BITRATE | - | - | +| threeegcsd:gsmchancod | - | - | GSM CC | GSM CC (NOTE 1) | - | - | - | - | +| IP Interface Type | NboIP(NOTE 8) | - | AoIP (NOTE 9) | NboIP(NOTE 8) | NboIP(NOTE 8) | - | AoIP (NOTE 9) | NboIP(NOTE 8) | +| Payload Type | CLEARMODE [92], G711 [1,x], or T.38 [y,z] (NOTE 11) | - | AoIP (NOTE 10) | CLEARMODE [92] (NOTE 11) | CLEARMODE [92] (NOTE 11) | - | AoIP (NOTE 10) | CLEARMODE [92] (NOTE 11) | + +NOTE 1: GSM CC shall only be provided if T8 is an A interface. GSM CC shall not be provided if T8 is an lu interface. + +NOTE 2: Only applicable for a BICC network. + +NOTE 3: Optional + +NOTE 4: Value depends on call direction: IN if terminating call, OUT if originating call. + +NOTE 5: TMR is set according to the value received from ISDN/BICC signalling. In addition, a received USI may be supplied. If no TMR value from ISDN/BICC signalling is available, but the MSC determines with the help of PLMN\_BC exchanged with the UE that the call is a data call, it shall supply a value derived from the PLMN\_BC. + +NOTE 6: If several MGWs are controlled by the same MSC server, the server may also select the other value. + +NOTE 7: For a data rate of 64 kbit/s, TMR "UDI" may be supplied. For other data rates, TMR "UDI" shall not be sent. + +NOTE 8: The parameter may be supplied with value "NboIP" for a termination towards a SIP-I based CS CN. For termination towards a BICC based CS CN, the parameter shall not be supplied. + +NOTE 9: For an A interface with TDM transport, the IP interface type shall not be supplied. For an A interface with IP transport, the value "AoIP" may be supplied as IP interface type. + +NOTE 10: For an A interface with TDM transport, the Payload Type shall not be supplied. For an A interface with IP transport, CLEARMODE (see IETF RFC 4040 [92]) or Redundant RTP payload for Audio Data as specified in IETF RFC 2198 [94] encapsulating the CLEARMODE payload shall be supplied as payload type. + +NOTE 11: The parameter shall be supplied for a termination towards a SIP-I based CS CN. For terminations towards a BICC based CS CN, the parameter shall not be supplied. + +### 11a.1.3.2 Transparent CSD + +**Table 17: Transparent CSD MGW Termination Properties For Inter-MSC SRNS Relocation** + +| Termination Packages/Parameters | MSC-A | | | | MSC-B | | | Intermediate Nodes | +|---------------------------------|-----------------------------------------|------------------|----------------|------------------------|----------------------|------------------|----------------|---------------------| +| | T0 | T1 (iu) | T1 (A) | T2 | T7 | T8 (iu) | T8 (A) | T3, T4, T5, T6 | +| TMR | TMR (NOTE 6) | - | - | UDI (NOTE 4) (NOTE 10) | UDI (NOTE 10) | UDI (NOTE 8) | UDI (NOTE 4) | UDI | +| threegcd:plmnb | - | PLMN_BC (NOTE 9) | PLMN_BC | PLMN_BC (NOTE 10) | - | - | - | - | +| threegup:interface | CN (NOTE 3) | RAN | - | CN (NOTE 3) | CN (NOTE 3) | RAN | - | CN (NOTE 3) | +| threegup:mode | (NOTE 3) Support | transparent | - | Support (NOTE 3) | Support (NOTE 3) | transparent | - | Support (NOTE 3) | +| threegup:initdir | (NOTE 3) (NOTE 5) | - | - | OUT (NOTE 3) (NOTE 7) | IN (NOTE 3) (NOTE 7) | - | - | IN (NOTE 3) | +| threegcden:bitrate | - | - | - | - | - | BITRATE (NOTE 1) | - | - | +| threegcd:gsmchancod | - | - | GSM CC | GSM CC (NOTE 2) | - | - | - | - | +| IP Interface Type | NboIP(NOTE 11) | - | AoIP(NOTE 12) | NboIP(NOTE 11) | NboIP(NOTE 11) | - | AoIP (NOTE 12) | NboIP(NOTE 11) | +| Payload Type | CLEARMODE [92] or G.711 [1,x] (NOTE 14) | - | AoIP (NOTE 13) | CLEARMODE (NOTE 14) | CLEARMODE (NOTE 14) | - | AoIP (NOTE 13) | CLEARMODE (NOTE 14) | + +- NOTE 1: This is optional if rate is 64kb/s. In this case no rate adaptation is required. +- NOTE 2: GSM CC shall only be provided if T8 is an A interface. GSM CC shall not be provided if T8 is an Iu interface. +- NOTE 3: Only applicable for a BICC network. +- NOTE 4: Optional +- NOTE 5: Value depends on call direction: IN if terminating call, OUT if originating call. +- NOTE 6: TMR is set according to the value received from ISDN/BICC signalling. In addition, a received USI may be supplied. If no TMR value from ISDN/BICC signalling is available, but the MSC determines with the help of PLMN\_BCs exchanged with the UE that the call is a data call, it shall supply a value derived from the PLMN\_BC. +- NOTE 7: If several MGWs are controlled by the same MSC server, the server may also select the other value. +- NOTE 8: For a data rate of 64 kbit/s, TMR "UDI" may be supplied. For other data rates, TMR "UDI" shall not be sent. +- NOTE 9: For a SCUDIF multimedia call, the MuMe codec shall be configured instead. +- NOTE 10: For a SCUDIF multimedia call, the MuMe codec shall be configured instead in case of BICC termination. +- NOTE 11: The parameter may be supplied with value " Nb0IP" for a termination towards a SIP-I based CS CN. For terminations towards a BICC based CS CN, the parameter shall not be supplied. +- NOTE 12: For an A interface with TDM transport, the IP interface type shall not be supplied. For an A interface with IP transport, the value "AoIP" may be supplied as IP interface type. +- NOTE 13: For an A interface with TDM transport, the Payload Type shall not be supplied. For an A interface with IP transport, CLEARMODE (see IETF RFC 4040 [92]) or Redundant RTP payload for Audio Data as specified in IETF RFC 2198 [94] encapsulating the CLEARMODE payload shall be supplied as payload type. +- NOTE 14: The payload type parameter shall be supplied for a termination towards a SIP-I based CS CN. For terminations towards a BICC based CS CN, the parameter shall not be supplied. + +## 11a.2 NT services + +### 11a.2.1 Iu interface and Nb interface at access side of IWF in a BICC based CS CN + +On the Iu interface and if TDM or SIP-I is not used in the CN between the access network and the IWF, this paragraph is applicable, except for the Nb interface in the case of inter-MSC relocation. The Iu and Nb user planes are used in support mode, see 3GPP TS 25.415 [42] and 3GPP TS 29.415 [80]. Each SDU corresponds to one RLP frame and, consequently, is 576 bits long. In GERAN Iu mode another SDU size of 480 bits is possible. It carries two RLP frames of 240 bits and is used if TCH/F9.6 is used in GERAN. Each SDU is transported in one Iu or Nb UP PDU of Type 1. In UTRAN Iu mode, the range of RAB Subflow Combination bit rate values is 14,4 kbit/s, 28,8 kbit/s, 57,6 kbit/s, limited by the maximum bit rate, and varies with the transmission period on the Uu interface, which is 40 ms, 20 ms or 10 ms. In GERAN Iu mode these values are valid if TCH/F14.4, TCH/28.8 or TCH/F43.2 is used. In addition GERAN Iu mode has a RAB Subflow Combination bit rate of 43,2 kbit/s with a transmission period of 13½ ms. If TCH/F9.6 is used, the range of RAB Subflow Combination bit rate values is 12 kbit/s, 24 kbit/s, 36 kbit/s, 48 kbit/s, limited by the maximum bit rate, and varies with the transmission period on the Um interface, which is 40 ms, 20 ms, 13½ ms or 10 ms. A change in the transmission period is signalled to the IWF through the Iu and Nb UP protocols. The Iu or Nb UP primitive Iu- or Nb-UP-DATA-REQUEST is invoked each time an RLP frame is ready to be sent from the IWF towards the UE. DTX indication is not used. + +The following table shows the connection between the RAB subflow combination bit rate and the AIUR. + +**Table 18: Connection between the RAB subflow combination bit rate and AIUR for Non-Transparent CSD Services** + +| RAB subflow combination bit rate | AIUR | Used number of traffic channels and channel coding for GERAN Iu mode | Comment | +|-------------------------------------------------------------------------------------|-------------|----------------------------------------------------------------------|----------| +| 57,6 kbit/s | 57,6 kbit/s | 4xTCH/F14.4, 2xTCH/F28.8 | (Note 1) | +| 43,2 kbit/s | 43,2 kbit/s | 3xTCH/F14.4, 1xTCH/F43.2 | (Note 2) | +| 48 kbit/s | 38,4 kbit/s | 4xTCH/F9.6 | (Note 2) | +| 36 kbit/s | 28,8 kbit/s | 3xTCH/F9.6 | (Note 2) | +| 28,8 kbit/s | 28,8 kbit/s | 2xTCH/F14.4, 1xTCH/F28.8 | (Note 1) | +| 24 kbit/s | 19,2 kbit/s | 2xTCH/F9.6 | (Note 2) | +| 14,4 kbit/s | 14,4 kbit/s | 1xTCH/F14.4 | (Note 1) | +| 12 kbit/s | 9,6 kbit/s | 1xTCH/F9.6 | (Note 2) | +| NOTE 1: RAB subflow combination bit rate is used in UTRAN Iu mode and GERAN Iu mode | | | | +| NOTE 2: RAB subflow combination bit rate is only used in GERAN Iu mode | | | | + +### 11a.2.2 Nb interface at access side of IWF in a BICC based CS CN for Inter-MSC relocation + +For Inter-MSC relocation this paragraph is applicable for the Nb interface in BICC based CS CN between the access network and the IWF. The Nb UP protocol is applied in support mode and the SDU size is 320 bits, transmitted every 5 ms. PDU type 0 is used. The data within the PDU is encoded as A-TRAU' and A-TRAU" frames. + +### 11a.2.3 Nb interface at network side of IWF in a BICC based CS CN + +If TDM is not used, then between the IWF and the fixed network (ISDN or PSTN), for the BICC based CS CN the Nb UP protocol is applied in support mode and the SDU size is 320 bits, transmitted every 5 ms. PDU type 0 is used. + +### 11a.2.4 Nb interface at access side of IWF in a SIP-I based CS CN + +The CLEARMODE RTP payload type shall be used with a framing period of 20 msecs. The data within the CLEARMODE RTP payload type shall be transported in a 64 kbit/s bit stream and shall be encoded as for the TDM case of the A interface. + +### 11a.2.5 Nb interface at network side of IWF in a SIP-I based CS CN + +For non-transparent CSD calls CLEARMODE [92] shall be supported in addition to G.711 [1,x] as RTP payload type. + +NOTE: G.711 will only be used if an offerer is not able to determine whether a call is a data call or a speech call. + +For facsimile calls T.38 [y,z] may be supported in addition to G.711. + +For SCUDIF (see TS 23.172 [83]), the "vnd.3gpp.clearmode" RTP payload type (see Annex C) shall be used. + +The negotiation of payload types is described in Clause 15. + +## 11a.2.6 A interface with IP transport + +The CLEARMODE RTP payload type (see IETF RFC 4040[92]) or Redundant RTP payload for Audio Data as specified in IETF RFC 2198 [94] encapsulating the CLEARMODE payload shall be used. Transport without redundancy shall be supported. Transport with redundancy may be supported. Only the redundancy level 2 and level 3 are applicable on the AoIP interface. + +Note: The redundancy level is signalled from the MSC server by the Mc interface as negotiated between the MSC server with the BSC. + +The data within the CLEARMODE RTP payload type shall be transported with a framing period of 20 ms in a 64 kbit/s bit stream and shall be encoded as for the TDM case of the A interface. + +## 11a.3 T services + +### 11a.3.0 Iu interface + +On the Iu interface, the Iu UP is used in transparent mode, see 3GPP TS 25.415 [42]. The payload of the Iu and Nb frames will consist of user data bits only for synchronous data, and RA0 synchronous bit streams for asynchronous data. + +On the Iu interfaces, the payload (SDU) size is fixed, determined by the bit rate. Following table shows SDU sizes. AAL2 is used. The AAL2 SSCS layer shall be supported for segmentation and re-assembly. + +**Table 19: SDU sizes for Transparent CSD Services at Iu interface** + +| Bit rate | SDU size (= RLC PDU payload size) | +|--------------|-----------------------------------| +| 28.8 kbit/s | 576 bits | +| 33.6 kbit/s | 672 bits | +| 32 kbit/s | 640 bits | +| 56/64 kbit/s | 640 bits | + +The primitive Iu-UP \_UNIT-DATA-REQUEST is invoked at regular intervals in order to have a constant bit rate (every SDU). + +### 11a.3.0a Nb interface in BICC based CS CN + +If TDM is not used at the Nb interface, then the Nb UP protocol is applied in support mode and the SDU size is 320 bits, transmitted every 5 ms. PDU type 0 is used. + +### 11a.3.1 Avoidance of delay at RNC + +The TTI-to-CPS Packet packaging delay can be avoided by choosing the length of the CPS packet payload so that the payloads of an integer number of CPS Packets fill one TTI. The contents of the whole TTI can be sent further towards the MSC immediately after the reception without waiting for the next TTI. + +### 11a.3.2 Recovery from the loss of ATM cells + +The ATM cell loss rate is estimated to be very small (less than $10^{-6}$ ... $10^{-8}$ ), the quality of transmission being comparable to that of a high quality ISDN. + +The following happens if a cell is lost (see ITU-T Recommendation I.363.2 [87]): + +- At least one CPS packet is distorted. +- The distorted CPS packet(s) is/are discarded by the receiver. + +- If only one CPS packet is discarded, the upper layer can identify the event by the UUI/SSSAR sequence number, and consequently insert a fill sequence of the length of a CPS payload field to the correct place in the bit stream. ITU-T Recommendation I.366.1[88] (SSSAR) describes that UUI takes value between 0 and 26 for final data and value 27 for more data, but UUI should take value 26 for final data considering compatibility with other SSCS specifications. When UUI works as sequence number by repetition of 27 and 26, CPS packet payload size is equal to half a SDU size. This CPS packet payload size also satisfies the requirement described in subclause 6.2.1. CPS packet payload size is set by ITU-T Recommendation Q.2630.1 [89] over Iu interface. +- If more than one CPS packets are discarded, the upper layer can identify the event by monitoring the buffer level at the ATM/TDM interface or by monitoring the reception of CPS packets with a timer. (The modulo 2 sequence number cannot indicate the loss of two consecutive CPS packets). The following figures apply for the 40 octet payload field. +- Worst case: 2 packets lost $\Rightarrow 2 \times 40$ octets $\times 8$ bits/octet : 64 kbit/s = 10 ms, i.e. buffer level decreased by 80 octets. +- Consequently, recovery with fill inserted in the correct place is possible, if the ATM cell jitter (i.e. transmission delay variation) is less than 5 ms. With a bigger jitter fill may be inserted in a wrong place in the TDM bit stream. + +### 11a.3.3 A interface with IP transport + +The CLEARMODE RTP payload type (see IETF RFC 4040[92]) or Redundant RTP payload for Audio Data as specified in IETF RFC 2198 [94] encapsulating the CLEARMODE payload shall be used. Transport without redundancy shall be supported. Transport with redundancy may be supported. Only the redundancy level 2 and level 3 are applicable on the AoIP interface. + +Note: The redundancy level is signalled from the MSC server by the Mc interface as negotiated between the MSC server with the BSC. + +The data within the CLEARMODE RTP payload type shall be transported with a framing period of 20 ms in a 64 kbit/s bit stream and shall be encoded as for the TDM case of the A interface. + +### 11a.3.4 Nb interface at access side of IWF in a SIP-I based CS CN + +The CLEARMODE RTP payload type shall be used with a framing period of 20 msec. The data within the CLEARMODE RTP payload type shall be transported in a 64 kbit/s bit stream and shall be encoded as for the TDM case of the A interface. + +### 11a.3.5 Nb interface at network side of IWF in a SIP-I based CS CN + +CLEARMODE [92] shall be supported in addition to G.711 [1,x] as RTP payload types. + +The negotiation of payload types is described in Clause 15. + +--- + +## 12 Frame Synchronization + +Potentially two links are involved in the MSC/IWF regarding the need for frame synchronization, i.e. the link towards the UE and the link towards the fixed network. The links towards the UE are covered by 3GPP TS 48.020 and 48.060 for A/Gb mode and 3GPP TS 25.415 for Iu mode. For the link towards the fixed network, the appropriate sections of ITU-T Recommendation V-series modem, V.110, V.120 and PIAFS Recommendations apply. + +## 12.1 Initial frame synchronization + +### 12.1.1 Terminating side (towards the UE) + +In Iu mode, the terminating side is not synchronous. + +In A/Gb mode, for transparent/non-transparent and interworking to the PSTN or ISDN the interface to the RAN is managed as follows. As soon as the outband signalling exchange indicates that the traffic channel is available the MSC/IWF will start sending frames with the frame contents set as indicated in subclause 9.2.3.4.1 towards the RAN. The MSC/IWF will seek to attain V.110 or A-TRAU frame synchronization on the incoming data from the RAN. V.110 synchronization will be considered to be completed in line with the procedures described in subclause 9.2.3.4.1.1. A-TRAU frame synchronization will be considered to be completed in line with the procedures described in subclause 9.2.3.4.1.2. The incoming data will only be considered valid once the frame synchronization procedure defined in subclause 9.2.3.4.1 is complete. For non-transparent interworking to the PSTN or ISDN, the procedures described in subclause 9.2.4.10.1 shall be followed. + +### 12.1.2 Transit side (towards the fixed network) + +#### 12.1.2.1 Interworking to the PSTN + +In the case of interworking to the PSTN the procedures for initial synchronization for the transparent services are covered in subclause 9.2.3.4.2 and the non-transparent services in subclause 9.2.4.10.2. + +#### 12.1.2.2 Interworking to the ISDN + +In the case of interworking to the ISDN the procedures for initial synchronization for the transparent services are covered in subclause 10.2.3.4.2 and the non-transparent services in subclause 10.2.4.10.2. + +## 12.2 Action on loss of frame synchronization + +The IWF should attempt to recover synchronization as described in the following subsections. If the resynchronization attempt fails, the IWF may clear the call. + +### 12.2.1 Loss on the transit side (towards the fixed network) + +If loss of frame synchronization is detected from the fixed network in line with the procedures specified in the ITU-T or PIAFS recommendation applicable to the type of interworking (V.110, V.120, PIAFS or V-series modem), then re-synchronization is initiated in line with the procedures specified in that recommendation. No change of behaviour of the MSC/IWF on the RAN/MSC link is necessary. + +### 12.2.2 Loss on the terminating side (towards the UE) + +In Iu mode, the terminating side is not synchronous, so loss of synchronisation is not possible. For T services, frames may be lost or arrive irregularly, which handling is implementation dependent. + +In A/Gb mode, if the MSC/IWF detects a loss of frame synchronisation on one or more substreams on the RAN/MSC link, the MSC/IWF initiates a re-synchronisation on the substreams in question as specified in the following. + +The MSC/IWF shall detect a loss of V.110 frame synchronisation in line with the rules specified in ITU-T Recommendation V.110. The MSC/IWF shall detect a loss of A-TRAU frame synchronisation when an A-TRAU frame has been received with at least one error in the synchronisation pattern (ref 3GPP TS 48.020). + +If loss of synchronization is detected on the RAN/MSC link then a re-synchronization process should be initiated. However for this link to the RAN it is only necessary to search for the frame alignment pattern incoming from the RAN. In the case of A-TRAU the synchronisation shall take care of the multiframe alignment according to subclause 9.2.3.4.1.2 and the MSC/IWF shall set the control bit UFE (Uplink Frame Error, see 3GPP TS 48.020) in the next downlink A-TRAU frame to indicate the framing error to the RAN. + +There shall be no action regarding the outgoing frame towards the RAN, other than to continue sending the rate adapted frames made up of the incoming data from the fixed network. During the re-synchronization process data shall continue to be sent towards the fixed network via the modem or ISDN (V.110, V.120, or PIAFS) TA-function as if the frame synchronization were still available. The mapping of the status bits is unchanged during re-synchronization. + +Once synchronization has been re-attained the RLP will recover any possible loss of data on the RAN/MSC link in the case of non-transparent services. The indication of UFE will be stopped in the case of A-TRAU. + +## 13 Call Clearing + +When a call is to be cleared, the MSC/IWF shall handle both the links, towards the UE as well as towards the fixed network. + +At the link towards the UE out-band (3GPP TS 24.008) signalling shall be used. Changes in the in-band status bits shall not be used to signal call clearing. + +At the link towards the fixed network, the clearing procedures appropriate to the fixed network shall be used, together with any additional procedures described in the ITU-T Recommendation applicable to the type of interworking (V.110, V.120, PIAFS or V-series modem). + +## 14 The A-TRAU Framing Protocols + +### 14.1 A-TRAU' Protocol + +The A-TRAU' protocol is defined as follows: + +- A-TRAU' frames are transmitted in regular intervals of 10ms; +- an A-TRAU' frame consists of two consecutive A-TRAU frames (as defined in 3GPP TS 48.020 [28]) each with a length of 320 bit; +- the A-TRAU' protocol is used on a plain 64 kbit/s channel without substreams; +- the same A-TRAU' format is used for the transparent and non-transparent transmission mode; +- in transparent mode the number of data bits in an A-TRAU' frame depend on the user rate only, each user rate corresponds to a fixed number of data bits (see below); +- in non-transparent mode A-TRAU' frames contain always complete RLP frames, rate adaptation is performed by means of the M2 bit; +- the M1-bit is used to identify 1st and 2nd frame in both transmission modes. + +#### 14.1.1 Frame layout for the different transparent user rates + +The number of data bits in an A-TRAU' frame depend on the user rate only, each user rate corresponds to a fixed number of data bits in an A-TRAU' frame. + +**Table 20: A-TRAU' frame layout for transparent user rate** + +| Date Rate | Number of data bits per A-TRAU' frame | +|-------------|---------------------------------------| +| 33.6 kbit/s | 336 | +| 28.8 kbit/s | 288 | + +The data bits are inserted in the A-TRAU' frame starting with D1 of Data field 1 of the first A-TRAU frame. The unused bits are filled with binary '1'. + +#### 14.1.2 A-TRAU' frame format + +One A-TRAU' frame consists of two consecutive A-TRAU frames. Figure 20 shows the format of one A-TRAU frame. + +| Octet number | bit number | | | | | | | | | +|--------------|------------|-----------|-----------|-----------|-----------|-----------|-----------|-----------|---------------------| +| | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | | +| 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | | +| 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | | +| 2 | 1 | C1 | C2 | C3 | C4 | C5 | M1 | M2 | | +| 3 | Z1 | D1 | D2 | D3 | D4 | D5 | D6 | D7 | | +| 4 | D8 | D9 | D10 | D11 | D12 | D13 | D14 | D15 | 36 bit data field 1 | +| 5 | D16 | D17 | D18 | D19 | D20 | D21 | D22 | D23 | | +| 6 | D24 | D25 | D26 | D27 | D28 | D29 | D30 | D31 | | +| 7 | D32 | D33 | D34 | D35 | D36 | Z2 | D1 | D2 | | +| 8 | D3 | D4 | D5 | D6 | D7 | D8 | D9 | D10 | | +| 9 | D11 | D12 | D13 | D14 | D15 | D16 | D17 | D18 | 36 bit data field 2 | +| 10 | D19 | D20 | D21 | D22 | D23 | D24 | D25 | D26 | | +| 11 | D27 | D28 | D29 | D30 | D31 | D32 | D33 | D34 | | +| 12 | D35 | D36 | Z3 | D1 | D2 | D3 | D4 | D5 | | +| 13 | D6 | D7 | D8 | D9 | D10 | D11 | D12 | D13 | | +| 14 | D14 | D15 | D16 | D17 | D18 | D19 | D20 | D21 | 36 bit data field 3 | +| 15 | D22 | D23 | D24 | D25 | D26 | D27 | D28 | D29 | | +| 16 | D30 | D31 | D32 | D33 | D34 | D35 | D36 | Z4 | | +| 17 | D1 | D2 | D3 | D4 | D5 | D6 | D7 | D8 | | +| 18 | D9 | D10 | D11 | D12 | D13 | D14 | D15 | D16 | 36 bit data field 4 | +| 19 | D17 | D18 | D19 | D20 | D21 | D22 | D23 | D24 | | +| 20 | D25 | D26 | D27 | D28 | D29 | D30 | D31 | D32 | | +| 21 | D33 | D34 | D35 | D36 | Z5 | D1 | D2 | D3 | | +| 22 | D4 | D5 | D6 | D7 | D8 | D9 | D10 | D11 | | +| 23 | D12 | D13 | D14 | D15 | D16 | D17 | D18 | D19 | 36 bit data field 5 | +| 24 | D20 | D21 | D22 | D23 | D24 | D25 | D26 | D27 | | +| 25 | D28 | D29 | D30 | D31 | D32 | D33 | D34 | D35 | | +| 26 | D36 | Z6 | D1 | D2 | D3 | D4 | D5 | D6 | | +| 27 | D7 | D8 | D9 | D10 | D11 | D12 | D13 | D14 | | +| 28 | D15 | D16 | D17 | D18 | D19 | D20 | D21 | D22 | 36 bit data field 6 | +| 29 | D23 | D24 | D25 | D26 | D27 | D28 | D29 | D30 | | +| 30 | D31 | D32 | D33 | D34 | D35 | D36 | Z7 | D1 | | +| 31 | D2 | D3 | D4 | D5 | D6 | D7 | D8 | D9 | | +| 32 | D10 | D11 | D12 | D13 | D14 | D15 | D16 | D17 | | +| 33 | D18 | D19 | D20 | D21 | D22 | D23 | D24 | D25 | 36 bit data field 7 | +| 34 | D26 | D27 | D28 | D29 | D30 | D31 | D32 | D33 | | +| 35 | D34 | D35 | D36 | Z8 | D1 | D2 | D3 | D4 | | +| 36 | D5 | D6 | D7 | D8 | D9 | D10 | D11 | D12 | | +| 37 | D13 | D14 | D15 | D16 | D17 | D18 | D19 | D20 | 36 bit data field 8 | +| 38 | D21 | D22 | D23 | D24 | D25 | D26 | D27 | D28 | | +| 39 | D29 | D30 | D31 | D32 | D33 | D34 | D35 | D36 | | + +Figure 20: A-TRAU 320 bit frame + +**Data Bits (Dxx):** + +The 288 data bits of an A-TRAU frame are divided in eight fields of 36 bits. + +**Control bits (C Bits):****C1 to C4:** + +The Control bits C1 to C4 define the used data rate. C1 to C4 in the first A-TRAU frame indicate the data rate in send direction. + +C1 to C4 in the second A-TRAU frame indicate the used data rate in backward direction. This is required for Rate Control that is required in uplink direction. For details on Rate Control see 3GPP TS 25.415 [42]. + +**Table 21: A-TRAU' control bits** + +| C1 | C2 | C3 | C4 | Radio Interface User Rate | +|----|----|----|----|---------------------------| +| 1 | 0 | 1 | 1 | 57,6 kbit/s | +| 1 | 0 | 0 | 1 | 43,2 kbit/s | +| 1 | 0 | 1 | 0 | 33,6 kbit/s | +| 1 | 0 | 0 | 0 | 28,8 kbit/s | +| 0 | 1 | 1 | 1 | 14,4 kbit/s | + +**C5:** + +C5 is not used, it is set to binary '1'. + +**Bit M1:** + +An A-TRAU' frame is made of two consecutive A-TRAU which build the transport container for 576 data bits. Bit M1 is used to determine the order of the A-TRAU frames within an A-TRAU' frame. + +The two M1 bits are referred to as the Frame Start Identifier. The FSI value is 01. These values are assigned to the M1 bit as shown below: + +**Table 22: Frame Start Identifier** + +| | M1 bit | +|---------------------|--------| +| First A-TRAU frame | 0 | +| Second A-TRAU frame | 1 | + +**Bit M2:** + +The M2 bit is used to indicate 'valid' A-TRAU' frames. The M2 bit in both of the two consecutive A-TRAU frames relating to an A-TRAU' frame shall have the same value. + +Transparent mode: + +In transparent mode M2 is clamped to binary '0'. + +Non-transparent mode: + +In non-transparent mode M2 is used for DTX. If DTX is applied, M2 is set to binary '1'. If DTX is not to be applied, M2 bit is set to binary '0'. The DTX handling is used in both directions for rate adaptation purpose. This means that the sending entity will insert 'fill RLP-frames' with DTX set to binary '1' in case no RLP-frame is available. + +Fill frames are also sent in order to adapt the RLP transmission frequency to the AIUR. The ratio between RLP frames and 'fill' RLP frames is defined in the following table: + +**Table 23: RLP transmission frequency** + +| AIUR | Ratio between RLP and 'fill' RLP frames | +|-------------|-------------------------------------------| +| 57.6 kbit/s | Only valid frames | +| 43.2 kbit/s | 3 valid frame followed by 1 'fill' frame | +| 28.8 kbit/s | 1 valid frame followed by 1 'fill' frame | +| 14.4 kbit/s | 1 valid frame followed by 3 'fill' frames | + +**Z bits:** + +The bits Zi are used for Framing Pattern Substitution mechanism. This mechanism is defined in 3GPP TS 48.020 [28]. + +**Mapping of A-TRAU' frames to PCM time slots:** + +A-TRAU' frames shall be mapped octet aligned to PCM time slots. I.e. bit number 0 to 7 of each octet of an A-TRAU' frame shall be mapped to bit number 0 to 7 of the PCM time slot. + +## 14.2 A-TRAU" Protocol + +The RLP frame length of 240 bit shall be used. For the transfer of this RLP frame length the A-TRAU" protocol is introduced. An A-TRAU" frame has the same layout as the A-TRAU' frame and contains two A-TRAU frames. + +One RLP frame with the length of 240 bit is contained in one A-TRAU frame. The A-TRAU" protocol is only used for the non-transparent services. + +In Figure 21, the format of the A-TRAU frame for the RLP frame length of 240 is shown. + +| Octet number | Bit number | | | | | | | | | +|--------------|------------|-----------|-----------|-----------|-----------|-----------|-----------|-----------|---------------------| +| | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | | +| 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | | +| 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | | +| 2 | 1 | C1 | C2 | C3 | C4 | C5 | M1 | M2 | | +| 3 | Z1 | D1 | D2 | D3 | D4 | D5 | D6 | D7 | | +| 4 | D8 | D9 | D10 | D11 | D12 | D13 | D14 | D15 | 36 bit data field 1 | +| 5 | D16 | D17 | D18 | D19 | D20 | D21 | D22 | D23 | | +| 6 | D24 | D25 | D26 | D27 | D28 | D29 | D30 | D31 | | +| 7 | D32 | D33 | D34 | D35 | D36 | Z2 | D1 | D2 | | +| 8 | D3 | D4 | D5 | D6 | D7 | D8 | D9 | D10 | | +| 9 | D11 | D12 | D13 | D14 | D15 | D16 | D17 | D18 | 36 bit data field 2 | +| 10 | D19 | D20 | D21 | D22 | D23 | D24 | D25 | D26 | | +| 11 | D27 | D28 | D29 | D30 | D31 | D32 | D33 | D34 | | +| 12 | D35 | D36 | Z3 | D1 | D2 | D3 | D4 | D5 | | +| 13 | D6 | D7 | D8 | D9 | D10 | D11 | D12 | D13 | | +| 14 | D14 | D15 | D16 | D17 | D18 | D19 | D20 | D21 | 36 bit data field 3 | +| 15 | D22 | D23 | D24 | D25 | D26 | D27 | D28 | D29 | | +| 16 | D30 | D31 | D32 | D33 | D34 | D35 | D36 | Z4 | | +| 17 | D1 | D2 | D3 | D4 | D5 | D6 | D7 | D8 | | +| 18 | D9 | D10 | D11 | D12 | D13 | D14 | D15 | D16 | 36 bit data field 4 | +| 19 | D17 | D18 | D19 | D20 | D21 | D22 | D23 | D24 | | +| 20 | D25 | D26 | D27 | D28 | D29 | D30 | D31 | D32 | | +| 21 | D33 | D34 | D35 | D36 | Z5 | D1 | D2 | D3 | | +| 22 | D4 | D5 | D6 | D7 | D8 | D9 | D10 | D11 | | +| 23 | D12 | D13 | D14 | D15 | D16 | D17 | D18 | D19 | 36 bit data field 5 | +| 24 | D20 | D21 | D22 | D23 | D24 | D25 | D26 | D27 | | +| 25 | D28 | D29 | D30 | D31 | D32 | D33 | D34 | D35 | | +| 26 | D36 | Z6 | D1 | D2 | D3 | D4 | D5 | D6 | | +| 27 | D7 | D8 | D9 | D10 | D11 | D12 | D13 | D14 | | +| 28 | D15 | D16 | D17 | D18 | D19 | D20 | D21 | D22 | 36 bit data field 6 | +| 29 | D23 | D24 | D25 | D26 | D27 | D28 | D29 | D30 | | +| 30 | D31 | D32 | D33 | D34 | D35 | D36 | Z7 | D1 | | +| 31 | D2 | D3 | D4 | D5 | D6 | D7 | D8 | D9 | | +| 32 | D10 | D11 | D12 | D13 | D14 | D15 | D16 | D17 | | +| 33 | D18 | D19 | D20 | D21 | D22 | D23 | D24 | D25 | 36 bit data field 7 | +| 34 | D26 | D27 | D28 | D29 | D30 | D31 | D32 | D33 | | +| 35 | D34 | D35 | D36 | Z8 | D1 | D2 | D3 | D4 | | +| 36 | D5 | D6 | D7 | D8 | D9 | D10 | D11 | D12 | | +| 37 | D13 | D14 | D15 | D16 | D17 | D18 | D19 | D20 | 36 bit data field 8 | +| 38 | D21 | D22 | D23 | D24 | D25 | D26 | D27 | D28 | | +| 39 | D29 | D30 | D31 | D32 | D33 | D34 | D35 | D36 | | + +Figure 21: Use of A-TRAU frame for RLP frame size of 240 bits + +### Data Bits (Dxx): + +The 288 data bits of an A-TRAU frame are divided in eight fields of 36 bits. + +Only 240 data bits will be used. The data bits D25 ... D 26 of the data field 7 and the data bits D1 ... D36 of the data field 8 are set to '1' in of transfer of 240 bit long RLP frames. + +### Control bits (C Bits): + +#### C1 to C4: + +The Control bits C1 to C4 define the used data rate. C1 to C4 in the first A-TRAU frame indicate the data rate in send direction. + +C1 to C4 in the second A-TRAU frame indicate the used data rate in backward direction. This is required for Rate Control in uplink direction. + +**Table 24: A-TRAU control bits for A-TRAU"** + +| C1 | C2 | C3 | C4 | Radio Interface User Rate | +|----|----|----|----|---------------------------| +| 1 | 0 | 0 | 0 | 28,8 kbit/s | +| 0 | 1 | 1 | 0 | 38,4 kbit/s | +| 0 | 1 | 0 | 1 | 19,2 kbit/s | +| 0 | 1 | 0 | 0 | 9,6 kbit/s | + +#### C5: + +The C5 bit indicates that the A-TRAU" protocol is used and one A-TRAU frame contains one RLP frame with the length of 240 bit. In this case C5 is set binary '0'. + +#### Bit M1: + +For A-TRAU" the M1 bit in each A-TRAU frame is always set to 1. + +#### Bit M2: + +A-TRAU" protocol is only used in non-transparent mode. + +The M2 is used for DTX. If DTX is applied, M2 is set to binary '1'. If DTX is not to be applied, M2 bit is set to binary '0'. The DTX handling is used in both directions for rate adaptation purpose. This means that the sending entity will insert 'fill RLP-frames' with DTX set to binary '1' in case no RLP-frame is available. + +Fill frames are also sent in order to adapt the RLP transmission frequency to the AIUR. The ratio between RLP frames and 'fill' RLP frames is defined in the following table for the A-TRAU" protocol: + +**Table 25: RLP transmission frequency** + +| AIUR | Ratio between RLP and 'fill' RLP frames | +|-------------|-----------------------------------------------------------------------------------------------------------------------| +| 38,4 kbit/s | Each A-TRAU frame is valid | +| 28,8 kbit/s | An A-TRAU" frame with two valid frames is followed by an A-TRAU" frame containing one valid frame and one fill frame. | +| 19,2 kbit/s | Each A-TRAU" frame contains one valid frame and one fill frame. | +| 9,6 kbit/s | An A-TRAU" frame with one valid frame and one fill frame is followed by an A-TRAU" frame containing two fill frames | + +#### Z bits: + +The bits Zi are used for Framing Pattern Substitution mechanism. This mechanism is defined in 3GPP TS 48.020 [28]. + +#### Mapping of A-TRAU" frames to PCM time slots: + +A-TRAU" frames shall be mapped octet aligned to PCM time slots. I.e. bit number 0 to 7 of each octet of an A-TRAU" frame shall be mapped to bit number 0 to 7 of the PCM time slot. + +--- + +## 15 RTP Payload Type Negotiation for Data Calls within a SIP-I based CS Core Network + +### 15.1 RTP payload type negotiation at access side of IWF + +For any data call, the SDP offer shall contain a single m-line with only the CLEARMODE payload type (see IETF RFC4040 [92]). In addition, the ISUP IAM encapsulated in the INVITE to set up the corresponding call leg shall contain TMR UDI. + +### 15.2 RTP payload type negotiation at network side of IWF + +If a call is determined to be a data call other than facsimile or Modem (i.e. TMR "UDI") by the offerer, the SDP offer shall contain a single m-line with only the CLEARMODE payload type (see IETF RFC 4040 [92]). + +If a call is determined to be a facsimile or Modem call by the offerer, the SDP offer shall contain an m-line including only the PCM codec. For facsimile, the offer may include an additional m-line including the t38 payload type (see ITU-T Recommendation T.38 [96] and IETF RFC 3362 [97]). + +If an offerer is not able to determine if a call is a data call or a speech call (TMR "3.1 kHz Audio"), it shall only offer speech codec(s) including the PCM codec. If the PCM codec is offered in combination with other speech codecs, the OoBTC procedures in Clauses 6.12 and 9.3 of TS 23.153 [91] are applicable, + +For SCUDIF (see TS 23.172 [83]), the "vnd.3gpp.clearmode" RTP payload type (see Annex C) shall be offered together with speech codec(s) in a single SDP m-line. The OoBTC procedures in Clause 9.3 of TS 23.153 [91] are applicable. + +## Annex A (informative): SDLs + +The following SDLs are intended to assist in the interpretation of the text in subclause 10.2.2 and are not intended to indicate implementation requirements. Therefore these SDLs are informative only. + +![](a320e67b369bfde4a5fa360b100da55c_img.jpg) + +Procedure DataFlow\_HLR + +Sheet1(1) + +Procedure employed in the HLR + +``` + + stateDiagram-v2 + [*] --> SendRoutingInfo + SendRoutingInfo: 'Send Routing Information' from GMSC + SendRoutingInfo --> ISDN_BC_Present + + ISDN_BC_Present: ISDN-BC Present? + ISDN_BC_Present --> ITC_Speech: Yes + ISDN_BC_Present --> MSISDN_PLMN_BC_1: No + + ITC_Speech: ITC= Speech? + ITC_Speech --> MSISDN_PLMN_BC_1: Yes + ITC_Speech --> ITC_31kHz: No + + ITC_31kHz: ITC= 3.1kHz? + ITC_31kHz --> HLC_FAX: Yes + ITC_31kHz --> ITC_UDI: No + + HLC_FAX: HLC= FAX? + HLC_FAX --> MSISDN_PLMN_BC_1: Yes + HLC_FAX --> ModemDefined: No + + ITC_UDI: ITC= UDI? + ITC_UDI --> ModemDefined: Yes + ITC_UDI --> ReturnError: No + + ReturnError: Return ERROR for 'Send RoutingInfo' + + ModemDefined: modem defined in LLC or ISDN-BC? + ModemDefined --> UserRate: Yes + ModemDefined --> Note4: No + + UserRate: ISDN-BC or LLC has User Rate? (except for the 64kbit/s case) + UserRate --> Note2: Yes + UserRate --> ProvideRoaming_1: No + + MSISDN_PLMN_BC_1: MSISDN has PLMN-BC + MSISDN_PLMN_BC_1 --> PLMN_BC_31kHz: Yes + MSISDN_PLMN_BC_1 --> MSISDN_PLMN_BC_2: No + + PLMN_BC_31kHz: PLMN-BC = 3,1kHz + PLMN_BC_31kHz --> MSISDN_PLMN_BC_3: No + PLMN_BC_31kHz --> Note2_3b: Yes + + MSISDN_PLMN_BC_3: MSISDN has PLMN-BC + MSISDN_PLMN_BC_3 --> Note3a: Yes + MSISDN_PLMN_BC_3 --> ProvideRoaming_1: No + + MSISDN_PLMN_BC_2: MSISDN has PLMN-BC + MSISDN_PLMN_BC_2 --> Note1a_5: YES + MSISDN_PLMN_BC_2 --> Note1b: NO + + Note1a_5: Ref. Section 10.2.2.3 HLR Note 1a&5 + Note1a_5 --> ProvideRoaming_2 + + Note1b: Ref. Section 10.2.2.3 HLR Note 1b + Note1b --> ProvideRoaming_3 + + ProvideRoaming_1: 'Provide Roaming Number' includes PLMN-BC/HLC or ISDN-BC/LLC/HLC + ProvideRoaming_2: 'Provide Roaming Number' includes Stored PLMN-BC/HLC + ProvideRoaming_3: 'Provide Roaming Number' sent with No PLMN-BC + +``` + +Multiple or single numbering scheme? + +*In exception to this the BC stored in the HLR is regarded valid if one of the following cases applies:* +*If ITC = UDI/RDI and User Rate = 32 kbit/s /56 kbit/s and User information layer 1 protocol = V.110, I.460/X.30 and the stored BC indicates FTM, PIAFS or Multimedia.* +*If ITC = 3.1 kHz audio and User Rate = 28.8 kbit/s and Modem Type = V.34 and the stored BC indicates Multimedia.* + +Note: The SDLs presented here are indicative of the procedures in section 10.2.2 and are therefore informative only. + +**Figure A.1 (Sheet 1 of 1): Procedures in the HLR** + +Procedure DataFlow\_MSC\_VLR + +![Flowchart for Procedure DataFlow_MSC_VLR showing decision points for ISDN-BC, ITC, HLC, and VLR stored BC, leading to various 'SETUP' BC generation or retrieval actions.](a0eb8d30ac11ba97b2733c187b89ff22_img.jpg) + +``` + +graph TD + Start[Initial Address Message from GMSC] --> D1{ISDN-BC Present?} + D1 -- yes --> D2{ITC= Speech?} + D1 -- no --> D3{VLR has stored BC?} + D2 -- yes --> Ref1[Ref Section 10.2.2 VMSC Note 7] --> Action1["* SETUP* BC uses VLR (BC/LLC/HLC)"] + D2 -- no --> D4{ITC= 3.1 KHz?} + D4 -- yes --> D5{HLC= FAX?} + D4 -- no --> D6{ITC= UDI?} + D5 -- yes --> D7{VLR has stored BC?} + D5 -- no --> D8{ISDN-BC or LLC has User Rate?} + D6 -- yes --> D8 + D6 -- no --> Error1[ERROR in IAM (BC)] + D8 -- yes --> Ref2[Ref Section 10.2.2 GMSC Note 4] --> Action2["* SETUP* BC derived from IAM (BC/HLC/LLC)"] + D8 -- no --> Connector1((1)) + D7 -- yes --> Ref3[Ref Section 10.2.2 VMSC Note 5] --> Action3["* SETUP* BC uses stored VLR (BC/LLC/HLC)"] + D7 -- no --> Ref4[Ref Section 10.2.2 VMSC Note 5] --> Action4["* SETUP* BC generated dependent upon Subscription to FAX TS61 or TS62"] + D3 -- yes --> Ref5[Ref Section 10.2.2 VLR Note 2,3&6] --> Action5["* SETUP* BC uses VLR (BC/LLC/HLC)"] + D3 -- no --> Ref6[Ref Section 10.2.2 VLR Note 1,3&6] --> Action6["* SETUP* BC is NOT present"] + +``` + +**Exception Note:** In exception to this the BC stored in the VLR is received and send to the MS if one of the following cases apply: + IF ITC = UDI/UDI and User Rate = 32 kbit/s / 56 kbit/s and User Information Layer 1 protocol = V.110, I.430/X.30 and the stored BC indicates FTML, PIAPS or Multimedia. + IF ITC = 3.1 KHz audio and User Rate = 28.8 kbit/s and Modem Type = V.34 and the stored BC indicates Multimedia. + +**Note:** The SDLa presented here are indicative of the procedure in section 10.2.2 and are therefore informative only. + +Flowchart for Procedure DataFlow\_MSC\_VLR showing decision points for ISDN-BC, ITC, HLC, and VLR stored BC, leading to various 'SETUP' BC generation or retrieval actions. + +Figure A.2 (Sheet 1 of 1): Procedures in the MSC/VLR + +## Annex B (informative): General mapping of V.24 circuits to channel status bits + +In the data transfer state, status bits SA, SB and X can be used to convey channel control information associated with the data bits. Table C1 shows the general mapping scheme between the V.24 circuit numbers and the status bits in the IWF. A binary 0 corresponds to the ON condition, a binary 1 to the OFF condition. The specific mappings for the various PLMN bearer types are given elsewhere in the present document. + +Since the V.24 circuits that are outputs from a DCE are inputs to a DTE (and vice versa), this mapping is the reverse of that used in the MT (3GPP TS 27.002, 3GPP TS 27.003). + +For example, CT 109 is an output from the modem in the IWF and maps on to SB towards the MT. In the MT, SB is mapped on to CT 109 which is an input to the attached DTE. + +**Table B1: General mapping scheme at the IWF** + +| Status bit
direction: UE to IWF | Status bit
direction: IWF to UE | Signal at IWF modem
interface | +|------------------------------------|------------------------------------|----------------------------------| +| SB | | 105 (note 3) | +| | X (note 1) | 106 | +| | SA | 107 | +| SA | | 108 | +| | SB | 109 | +| X | | 133 (notes 2 and 3) | + +NOTE 1: The condition of X towards the UE may also be affected by the state of any transmit buffer in the IWF. +NOTE 2: The condition of CT 133 towards the modem may also be affected by the state of any receive buffer in the IWF or layer 2 flow control condition between the MT and IWF. +NOTE 3: CT105 and CT133 are assigned to the same connector pin on both the standard 25 pin connector (ISO/IEC 2110 [78]) and the commonly used 9 pin connector (annex B). When this pin is used for CT133 at the DTE/MT interface then on the MT side of the interface CT 105 is treated as being always in the ON condition. SB towards the IWF will therefore also always be ON. Similarly, when this pin is being used for CT105 then on the MT side of the interface CT 133 is treated as being always in the ON condition. X towards the IWF will therefore also always be ON. As circuit 133 is used only in duplex operation and circuit 105 is used only in half duplex operation (which is not supported by the PLMN) there should be no conflict. + +## Annex C (normative): RTP payload type for SCUDIF in SIP-I based CS core network + +### C.1 Scope + +This Annex defines the "vnd.3gpp.clearmode" RTP payload type which shall be used within SDP (see IETF RFC 4566 [98]) to denote the 3G-324.M and the 3G-324.M2 "dummy codecs" defined to indicate a multimedia call for SCUDIF in 3GPP TS 23.172 [83]. Procedures for the codec negotiation applying these codecs are defined in 3GPP TS 23.172 [83] and in Clause 15.2 + +### C.2 RTP payload Type definition + +The "vnd.3gpp.clearmode" RTP payload type shall have the same PDU format and contents as defined for the Clearmode RTP payload type in IETF RFC 4040 [92]. + +The "vnd.3gpp.clearmode" RTP payload type shall be an "audio" media type. + +In addition to the optional "ptime" and "maxptime" parameters, which shall have the same meaning as specified for the Clearmode RTP payload type in IETF RFC 4040 [92], the following additional optional MIME parameter is defined: + +"network-initiated-service-change": + +This parameter shall be supplied for the "3G-324.M2" codec defined in 3GPP TS 23.172 [83]. It shall be omitted for the "3G-324.M" codec defined in 3GPP TS 23.172 [83]. No values shall be supplied for this parameter. + +### C.3 Describing the RTP payload Type in SDP + +The "vnd.3gpp.clearmode" RTP payload shall be described in SDP (see IETF RFC 4566 [98]) as follows. + +- The MIME type ("audio") shall be used in the SDP "m=" line as the media name +- A dynamic RTP payload type number shall be used in the SDP "m=" line. +- The meaning of the dynamic RTP payload type number shall be described by supplying "vnd.3gpp.clearmode" as MIME subtype within an SDP "rtpmap" attribute. +- If supplied, the optional parameter "ptime" shall be encoded as "ptime" SDP attribute. +- If supplied, the optional parameter "maxptime" shall be encoded as "maxptime" SDP attribute. +- If supplied, the optional parameter "network-initiated-service-change" shall be encoded within the "fmtp" SDP attribute. No values for the parameter shall be supplied. + +### C.4 SDP Offer-Answer considerations + +The "network-initiated-service-change" is a declarative parameter. If an "vnd.3gpp.clearmode" RTP payload type with an associated "network-initiated-service-change" parameter is included in an SDP "m="-line in an SDP offer, this RTP payload type shall either be rejected by excluding it from the "m="-line in the SDP answer, or the RTP payload type shall be included in the answer and the associated "network-initiated-service-change" parameter shall then be supplied in the answer. + +### C.5 SDP Example + +The following example shows an SDP offer during the setup of a SCUDIF call, where Multimedia is the preferred encoding and the network initiated service change is supported. AMR and PCM are offered as speech codecs for a fallback. + +``` +m=audio 12345 RTP/AVP 97 98 99 0 +a=rtpmap:97 vnd.3gpp.clearmode/8000 +a=rtpmap:98 vnd.3gpp.clearmode/8000 +a=fmtp:98 network-initiated-service-change +a=rtpmap:99 AMR/8000/1 +a=3gOoBTC +``` + +--- + +## Annex D (informative): IANA registration information for RTP payload types for SCUDIF in SIP-I based CS core network + +### D.1 Introduction + +This Annex provides information required for the registration of the "vnd.3gpp.clearmode" RTP payload type at IANA. + +NOTE: Such an IANA registration has not been performed. + +## D.2 IANA Registration information + +### D.2.1 Media Type Name + +audio + +### D.2.2 Subtype Name + +vnd.3gpp.clearmode + +### D.2.3 Required parameters + +none + +### D.2.4 Optional parameters + +"ptime" gives the length of time in milliseconds represented by the media in a packet, as described in RFC 4566 [98]. + +"maxptime" represents the maximum amount of media, which can be encapsulated in each packet, expressed as time in milliseconds, as described in IETF RFC 4566 [98]. + +"network-initiated-service-change" denotes if a network initiated service change is supported or applied. It shall be used according to the rules in 3GPP TS 29.007 and 3GPP TS 23.172 [83]. No values shall be supplied for this parameter + +### D.2.5 Encoding considerations + +Framed encoding. + +### D.2.6 Security considerations + +See Section 6 of RFC 4040 [92] + +### D.2.7 Interoperability considerations + +none + +### D.2.8 Published specification + +3GPP TS 29.007. + +### D.2.9 Applications which use this media type + +Service change and UDI/RDI Fallback (SCUDIF), as defined in 3GPP TS 23.172 [83] + +### D.2.10 Additional information + +This type is only defined for transfer via RTP. + +#### D.2.10.1 Magic number(s) + +none + +#### D.2.10.2 File extension(s) + +none + +#### D.2.10.3 Macintosh File Type Code(s) + +none + +#### D.2.10.2 Object Identifier(s) or OID(s) + +none + +## D.2.11 Intended usage + +Limited use. + +This RTP payload type will only be applied within a 3GPP SIP-I based circuit switched core network, as specified in 3GPP TS 23.231 [99] + +## D.2.12 Other Information/General Comment + +none + +## D.2.13 Person to contact for further information + +3GPP Specifications Manager + +[3gppContact@etsi.org](mailto:3gppContact@etsi.org) + +--- + +## Annex E (informative): Change history + +| Change history | | | | | | | | +|----------------|-------|-----------|-----|-----|------------------------------------------------------------------------------------|-------|-------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 1999-04 | | | | | 09.07 Transferred to 3GPP CN3 | 7.1.0 | | +| | CN#03 | | | | Approved at CN#03 | | 3.0.0 | +| | CN#04 | | 001 | | Introduction of EDGE channel codings into the specifications | 3.0.0 | 3.1.0 | +| | CN#05 | | 002 | | R99 Service Clean-up | 3.1.0 | 3.2.0 | +| | CN#05 | | 003 | | EDGE related corrections | 3.1.0 | 3.2.0 | +| | CN#05 | | 004 | | EDGE Asymmetric channel coding | 3.1.0 | 3.2.0 | +| | CN#06 | | 006 | | R99 service clean up | 3.2.0 | 3.3.0 | +| | CN#06 | | 007 | | Correction of intermediate rate values | 3.2.0 | 3.3.0 | +| | CN#06 | | 008 | | Introduction of Frame Tunnelling Mode | 3.2.0 | 3.3.0 | +| | CN#06 | | 009 | | Updates for UMTS | 3.2.0 | 3.3.0 | +| | CN#06 | | 010 | | Introduction of PIAFS and enhancement of processing at mobile terminated call | 3.2.0 | 3.3.0 | +| | CN#06 | | 011 | | Multimedia call | 3.2.0 | 3.3.0 | +| | CN#07 | | 012 | | Change of reference from ETS 300102-1 to Q.931 | 3.3.0 | 3.4.0 | +| | CN#07 | | 013 | | Handover between GSM and UMTS | 3.3.0 | 3.4.0 | +| | CN#07 | | 014 | | Changes to support fallback to speech in a circuit switched multimedia call set-up | 3.3.0 | 3.4.0 | +| | CN#08 | | 015 | | Handover between 3G MSCs | 3.4.0 | 3.5.0 | +| | CN#08 | | 016 | | Rejection of lower user rates | 3.4.0 | 3.5.0 | +| | CN#08 | | 017 | | Fax | 3.4.0 | 3.5.0 | +| | CN#08 | | 018 | | Clarification of the VMSC behaviour in case of interworking | 3.4.0 | 3.5.0 | +| | CN#08 | | 019 | | Handover between 3G MSCs (Clarification for 56 and 64 kbit/s) | 3.4.0 | 3.5.0 | +| | CN#08 | | 020 | | ISDN TA function in case of bit transparent 56 kbit/s (RDI) and 64 kbit/s (UDI) | 3.4.0 | 3.5.0 | +| | CN#08 | | 021 | | 33.6 kbit/s for multimedia | 3.4.0 | 3.5.0 | +| | CN#09 | | 022 | | Transparent 32 kbit/s data rate with I.460 rate adaptation | 3.5.0 | 4.0.0 | +| | CN#09 | | 025 | | Correction of incomplete part related to the introduction of UMTS NT-RT FAX | 3.5.0 | 4.0.0 | +| | CN#09 | | 026 | | 3.1 kHz multimedia at 33.6 kbit/s | 3.5.0 | 4.0.0 | +| | CN#09 | | 028 | | Clarification related to RCR | 3.5.0 | 4.0.0 | +| | CN#09 | | 029 | | 32 kbit/s UDI/RDI multimedia | 3.5.0 | 4.0.0 | +| | CN#10 | | 032 | | Handover for 56kbit/s | 4.0.0 | 4.1.0 | +| | CN#10 | | 033 | | Removal of BS 30 NT | 4.0.0 | 4.1.0 | +| | CN#11 | | 035 | | A-TRAU' Correction | 4.1.0 | 4.2.0 | +| | CN#11 | | 037 | | A-TRAU' Synchronization | 4.1.0 | 4.2.0 | +| | CN#11 | | 038 | | Removal of FAX NT in GSM from Rel-4 | 4.1.0 | 4.2.0 | +| | CN#11 | | 039 | | Introduction of Nb UP | 4.1.0 | 4.2.0 | +| 2001-12 | CN#14 | NP-010571 | 043 | | Removal of Shared IWF | 4.2.0 | 4.3.0 | + +| Change history | | | | | | | | +|-----------------------|--------------|-----------------|-----------|------------|------------------------------------------------------------------------------------------|------------|------------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 2001-12 | CN#14 | NP-010574 | 045 | | SDU size for transparent data at 33.6 kbit/s | 4.2.0 | 4.3.0 | +| 2001-12 | CN#14 | NP-010604 | 044 | 3 | New terminology required by TSG GERAN | 4.3.0 | 5.0.0 | +| 2002-03 | CN#15 | NP-020084 | 049 | 1 | Mobile terminated call with single numbering scheme | 5.0.0 | 5.1.0 | +| 2002-06 | CN#16 | NP-020169 | 046 | 6 | Service change and fallback for UDI/RDI multimedia calls | 5.1.0 | 5.2.0 | +| 2002-06 | CN#16 | NP-020172 | 048 | 1 | Clarification to VMSC/HLR logic for modem/facsimile calls which are signalled as Speech. | 5.1.0 | 5.2.0 | +| 2002-06 | CN#16 | NP-020172 | 052 | 1 | Signalling of FTM calls | 5.1.0 | 5.2.0 | +| 2002-09 | CN#17 | NP-020406 | 055 | 1 | Handling of CSD calls and Inter-MSC Relocation | 5.2.0 | 5.3.0 | +| 2002-09 | CN#17 | NP-020407 | 053 | 3 | Determining the basic service for MT calls | 5.2.0 | 5.3.0 | +| 2002-12 | CN#18 | NP-020617 | 056 | 1 | CS Data Services (including HSCSD and EDGE) for GERAN lu mode | 5.3.0 | 5.4.0 | +| 2002-12 | CN#18 | NP-020616 | 058 | 1 | Use of lu UP in support mode for transparent data services at the Nb interface | 5.3.0 | 5.4.0 | +| 2002-12 | CN#18 | NP-020615 | 059 | | Correction on mapping of BC-IE | 5.3.0 | 5.4.0 | +| 2002-12 | CN#18 | NP-020619 | 060 | 3 | Mobile originating BC handling for SCUDIF calls | 5.3.0 | 5.4.0 | +| 2003-03 | CN#19 | NP-030076 | 065 | | Correction of erroneous implemented CR | 5.4.0 | 5.5.0 | +| 2003-03 | CN#19 | NP-030076 | 067 | 1 | Use of Nb UP protocol after inter-MSC handover | 5.4.0 | 5.5.0 | +| 2003-06 | CN#20 | NP-030201 | 070 | | Negotiation of fixed network user rate (FNUR) | 5.5.0 | 5.6.0 | +| 2003-06 | CN#20 | NP-030201 | 071 | 1 | Use of single or multislot configurations | 5.5.0 | 5.6.0 | +| 2003-06 | CN#20 | NP-030203 | 073 | 1 | Subscription check after Call Confirmed | 5.5.0 | 5.6.0 | +| 2003-09 | CN#21 | NP-030328 | 080 | 2 | Interpretation of "no BC-IE in CALL PROC/CONF messages" | 5.6.0 | 5.7.0 | +| 2003-09 | CN#21 | NP-030329 | 081 | 1 | Alignment of negotiation rules with 27.001 | 5.6.0 | 5.7.0 | +| 2003-09 | CN#21 | NP-030327 | 084 | 2 | Clarification of Handover description | 5.6.0 | 5.7.0 | +| 2003-12 | CN#22 | NP-030455 | 089 | 4 | Backward signalling of service information between VMSC and GMSC for MTC | 5.7.0 | 5.8.0 | +| 2004-03 | CN#23 | NP-040082 | 096 | | Signalling of LLC and HLC | 5.8.0 | 5.9.0 | +| 2004-06 | CN#24 | NP-040239 | 099 | 1 | Addition of network initiated in-call modification | 5.9.0 | 5.10.0 | +| 2004-12 | CN#26 | NP-040587 | 106 | 1 | Transfer of information from TR 23.910 | 5.10.0 | 6.0.0 | +| 2005-03 | CN#27 | NP-050099 | 109 | 3 | Nb transport for handover between UMTS and GSM | 6.0.0 | 6.1.0 | +| 2005-09 | CP#29 | CP-050375 | 121 | 1 | CSD MGW Termination Properties For Inter-MSC SRNS Relocation | 6.1.0 | 6.2.0 | +| 2005-09 | CP#29 | CP-050380 | 125 | 1 | Correction of References | 6.1.0 | 6.2.0 | +| 2005-09 | CP#29 | CP-050386 | 114 | 2 | CS data Mobile Terminating calls from PSTN | 6.2.0 | 7.0.0 | +| 2005-12 | CP#30 | CP-050506 | 134 | 2 | Correction to transport at access side of IWF | 7.0.0 | 7.1.0 | +| 2005-12 | CP#30 | CP-050507 | 135 | 1 | Corrections to the A-TRAU' and A-TRAU" descriptions | 7.0.0 | 7.1.0 | +| 2006-03 | CP#31 | CP-060053 | 139 | 1 | Clarification of the speech followed by fax case in an splitted (BICC) architecture | 7.1.0 | 7.2.0 | +| 2006-06 | CP#32 | CP-060218 | 145 | 3 | Multimedia & CSD calls | 7.2.0 | 7.3.0 | + +| Change history | | | | | | | | +|-----------------------|--------------|-----------------|-----------|------------|------------------------------------------------------------------|------------|------------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 2008-05 | CP#40 | CP-080300 | 147 | 2 | GSM Bearer Capability in SRI-Ack | 7.3.0 | 7.4.0 | +| 2008-09 | CP#41 | CP-080566 | 148 | 2 | Update to TS 29.007 for SIP-I | 7.4.0 | 8.0.0 | +| 2008-12 | CP#42 | CP-080764 | 149 | 6 | AoIP impacts to Mc parameters | 8.0.0 | 8.1.0 | +| 2008-12 | CP#42 | CP-080754 | 150 | 5 | Data call transport at network side of IWF for SIP-I based CS CN | 8.0.0 | 8.1.0 | +| 2008-12 | CP#42 | CP-080754 | 151 | 1 | RTP payload types for SCUDIF | 8.0.0 | 8.1.0 | +| 2009-12 | CP#46 | | | | Automatic upgrade from previous Release | 8.1.0 | 9.0.0 | +| 2010-09 | CP#49 | CP-100549 | 152 | 1 | Correcting unspecific external reference | 9.0.0 | 9.1.0 | +| 2011-03 | CP#51 | | | | Automatic upgrade from previous Release version 9.1.0 | 9.1.0 | 10.0.0 | +| 2012-09 | CP#57 | | | | Automatic upgrade from previous Release version 10.0.0 | 10.0.0 | 11.0.0 | +| 2014-10 | | | | | Automatic upgrade from previous Release | 11.0.0 | 12.0.0 | +| 2015-12 | | | | | Automatic upgrade from previous Release | 12.0.0 | 13.0.0 | + + + +| Change history | | | | | | | | | +|-----------------------|--------------|-----------------|-----------|------------|------------|-----------------------------------------|------------|------------| +| Date | TSG # | TSG Doc. | CR | Rev | Cat | Subject/Comment | Old | New | +| 2017-03 | CT#75 | | | | | Automatic upgrade from previous Release | | 14.0.0 | +| 2018-06 | CT#80 | | | | | Automatic upgrade from previous Release | | 15.0.0 | +| 2018-12 | CT#82 | CP-183121 | 0161 | 1 | A | Correction of Editor's Notes | | 15.1.0 | +| 2020-06 | CT#88e | - | - | - | | Update to Rel-16 version (MCC) | | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29013/08441fa90c5fd11994626f662ac13f19_img.jpg b/marked/Rel-16/29_series/29013/08441fa90c5fd11994626f662ac13f19_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e5068d93ab0e92150c9456705d96716c444b5b23 --- /dev/null +++ b/marked/Rel-16/29_series/29013/08441fa90c5fd11994626f662ac13f19_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2ece6a7a7b4f2643427b45ed0461a3f51bff85bfcf784cc71312c977fb2435b0 +size 26092 diff --git a/marked/Rel-16/29_series/29013/16152cf1d84aea10848758f51a91ff6a_img.jpg b/marked/Rel-16/29_series/29013/16152cf1d84aea10848758f51a91ff6a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a6b464a6bb3764eabd838f67f06f7d3962d67330 --- /dev/null +++ b/marked/Rel-16/29_series/29013/16152cf1d84aea10848758f51a91ff6a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:66864449980677469369cbad4c648e6064046817cb148c766ea072422f5d72f1 +size 26454 diff --git a/marked/Rel-16/29_series/29013/16c1175b5f05a4b55e6d396fc51b15b3_img.jpg b/marked/Rel-16/29_series/29013/16c1175b5f05a4b55e6d396fc51b15b3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8fa110749bf1299a59d4d0af1ac9011f4fb3a2c7 --- /dev/null +++ b/marked/Rel-16/29_series/29013/16c1175b5f05a4b55e6d396fc51b15b3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ae5fbbe72aa8f28bdfcdf6889c8c07c7390e783d0cfa6004bcd6a029e9c6e7c1 +size 29941 diff --git a/marked/Rel-16/29_series/29013/28d250125d6a79bb23a8a3d459f54cb6_img.jpg b/marked/Rel-16/29_series/29013/28d250125d6a79bb23a8a3d459f54cb6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..aba95fb5eb52c553fedfb6ec3f4e303e300f4442 --- /dev/null +++ b/marked/Rel-16/29_series/29013/28d250125d6a79bb23a8a3d459f54cb6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d07601f6243b28543f1ec42b7de4351bfd7f5f29b0bdfbd681929e1334ac1991 +size 63255 diff --git a/marked/Rel-16/29_series/29013/3ad00ce93ad9dea9ee0f47535e5355e6_img.jpg b/marked/Rel-16/29_series/29013/3ad00ce93ad9dea9ee0f47535e5355e6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..11b2c3313166a139da399ab88c44f24c26b27e1a --- /dev/null +++ b/marked/Rel-16/29_series/29013/3ad00ce93ad9dea9ee0f47535e5355e6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:99776fc60c05e08d3c396f5af52a14904d85968609057feadb91636f3394fea8 +size 27410 diff --git a/marked/Rel-16/29_series/29013/5dfc130b129ace4df375839020a5700d_img.jpg b/marked/Rel-16/29_series/29013/5dfc130b129ace4df375839020a5700d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7e3182f118789180f50acf4bd02980be4dee09bd --- /dev/null +++ b/marked/Rel-16/29_series/29013/5dfc130b129ace4df375839020a5700d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1178ddeb6db83782316d5f645cd72b43da5f6cff59e8c4b621bfa609b3ec0771 +size 31450 diff --git a/marked/Rel-16/29_series/29013/6f341f415ee0f8c724e5d6daeb1e9b4a_img.jpg b/marked/Rel-16/29_series/29013/6f341f415ee0f8c724e5d6daeb1e9b4a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..84d98aab3a9b3ec5b854b5ab03662a2d1eea7d70 --- /dev/null +++ b/marked/Rel-16/29_series/29013/6f341f415ee0f8c724e5d6daeb1e9b4a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:83b1a43eebed33448668bdae33b86fc96e85b13ae32b6518e1e17e481eeb93b5 +size 28408 diff --git a/marked/Rel-16/29_series/29013/70de8885bd7de15723aaad5eb5c5febf_img.jpg b/marked/Rel-16/29_series/29013/70de8885bd7de15723aaad5eb5c5febf_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..fbd60570d108c1016408894cf76e2b1568d093e0 --- /dev/null +++ b/marked/Rel-16/29_series/29013/70de8885bd7de15723aaad5eb5c5febf_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3c9bf9faf838c9350ccc249a896507e0ebd1c4c7e0a2e6243b4ffcf41f308c76 +size 29286 diff --git a/marked/Rel-16/29_series/29013/75f0cb39f1cd165dfe4a6aa6c4d9388d_img.jpg b/marked/Rel-16/29_series/29013/75f0cb39f1cd165dfe4a6aa6c4d9388d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7a1b493cbac96034472dbad71704151b40e59fdb --- /dev/null +++ b/marked/Rel-16/29_series/29013/75f0cb39f1cd165dfe4a6aa6c4d9388d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d52a436f914a75999bb2411fa23622483faf479e2d880fe28b9e03ccc4260e4c +size 26427 diff --git a/marked/Rel-16/29_series/29013/7e670a2b556b53ea9002dfff3a420e08_img.jpg b/marked/Rel-16/29_series/29013/7e670a2b556b53ea9002dfff3a420e08_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..fa1a6ea8f87e4a075a247f8c9cef7c8bb675e1ed --- /dev/null +++ b/marked/Rel-16/29_series/29013/7e670a2b556b53ea9002dfff3a420e08_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3338ba963ad6527db236cd55bc7e722a89b69cf51c7c8152fb316b8f59659b10 +size 24601 diff --git a/marked/Rel-16/29_series/29013/a234352dfaccdc24745c88eef7724cc6_img.jpg b/marked/Rel-16/29_series/29013/a234352dfaccdc24745c88eef7724cc6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6c175b207ad7b4ab34c70b10eb6b0cd40c165f51 --- /dev/null +++ b/marked/Rel-16/29_series/29013/a234352dfaccdc24745c88eef7724cc6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9ed70988bd7fdf4a434a705576a43a9f1729148ff1e4a2cb0dacda7f489f2743 +size 25659 diff --git a/marked/Rel-16/29_series/29013/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg b/marked/Rel-16/29_series/29013/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..588788e8e61be10f4395990b8cf5fde7d0b9f6ca --- /dev/null +++ b/marked/Rel-16/29_series/29013/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fe188d3a7a8796b0c9ed02a73eaa45d2d1d0e05495c11d7b906641a1d45351d6 +size 20213 diff --git a/marked/Rel-16/29_series/29013/b3c108e7145f2017957569d06ea359cb_img.jpg b/marked/Rel-16/29_series/29013/b3c108e7145f2017957569d06ea359cb_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..361b7baefb1724466c6249c0bb9707da60a18ac8 --- /dev/null +++ b/marked/Rel-16/29_series/29013/b3c108e7145f2017957569d06ea359cb_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bcd2d6c398f0eb3bdf7fabfe2dce7ee82dfe9821512b804a87947213d588fe2c +size 27079 diff --git a/marked/Rel-16/29_series/29013/d17f75945bbb3feb84a153ecfedb9b81_img.jpg b/marked/Rel-16/29_series/29013/d17f75945bbb3feb84a153ecfedb9b81_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..bafc1faa430a0aadff0eebccb03a02fd46019d3b --- /dev/null +++ b/marked/Rel-16/29_series/29013/d17f75945bbb3feb84a153ecfedb9b81_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0425bace708c7af313ef2b0db90e10521e0f455e49522ad22f091efcb7c8fe3d +size 28360 diff --git a/marked/Rel-16/29_series/29013/df82d77a0d2637cbf2da9ea920a554fa_img.jpg b/marked/Rel-16/29_series/29013/df82d77a0d2637cbf2da9ea920a554fa_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8cb9ea9eaca9e0ff929df7d9e3715a7ded5cdd54 --- /dev/null +++ b/marked/Rel-16/29_series/29013/df82d77a0d2637cbf2da9ea920a554fa_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:dd76ec28d226034790ec3f91128672b18453bce9b491d7879b75604762588263 +size 29297 diff --git a/marked/Rel-16/29_series/29013/ea37ab05b033e59cfdf7b074161aaf5a_img.jpg b/marked/Rel-16/29_series/29013/ea37ab05b033e59cfdf7b074161aaf5a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9c04ed520ad74d8ebd6a3ad315f57c5b9b95f93f --- /dev/null +++ b/marked/Rel-16/29_series/29013/ea37ab05b033e59cfdf7b074161aaf5a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e1d2ec119a5a91966330ecb64c2b03ae051bd9c0290399b81b110e1515102d17 +size 7993 diff --git a/marked/Rel-16/29_series/29013/raw.md b/marked/Rel-16/29_series/29013/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..3ed1d3f73affed85e0758d488e82c5930ecda9e7 --- /dev/null +++ b/marked/Rel-16/29_series/29013/raw.md @@ -0,0 +1,697 @@ + + + + +Error! No +text of + +Error! No text of specified style in +document. + +# Contents + +| | | +|---------------------------------------------------------------------------|----| +| Foreword ..... | 4 | +| 1 Scope..... | 4 | +| 2 References..... | 4 | +| 3 Definitions and abbreviations ..... | 5 | +| 3.1 Definitions..... | 5 | +| 3.2 Abbreviations ..... | 5 | +| 4 General..... | 6 | +| 4.1 GSM CCBS Architecture Overview ..... | 6 | +| 4.2 GSM CCBS - ISDN CCBS ASE Interworking Overview ..... | 7 | +| 4.3 Overview on the use of CCBS procedures and parameters values ..... | 8 | +| 4.4 Mapping between MAP and SSAP application layer messages ..... | 8 | +| 4.4.1 MAP D-interface to SSAP interface mapping in HLR A..... | 8 | +| 4.4.2 SSAP interface to MAP D-interface interface mapping in HLR A..... | 8 | +| 5 Mapping between MAP message parameters and SSAP message parameters..... | 9 | +| 5.1 CCBS Request Invocation..... | 9 | +| 5.1.1 Encoding of called party subaddress information ..... | 11 | +| 5.2 CCBS Request Result..... | 11 | +| 5.3 CCBS Request Error ..... | 12 | +| 6 Dialogue handling on the SSAP interface..... | 13 | +| 6.1 Dialogue Beginning..... | 13 | +| 6.1.1 CCBS Request Invocation..... | 13 | +| 6.2 Dialogue Continuation ..... | 13 | +| 6.2.1 CCBS Request Result..... | 13 | +| 6.2.2 CCBS Remote User Free Invocation..... | 14 | +| 6.2.3 CCBS Suspend Invocation ..... | 14 | +| 6.2.4 CCBS Resume Invocation..... | 15 | +| 6.3 Dialogue End..... | 15 | +| 6.3.1 Normal dialogue end ..... | 15 | +| 6.3.2 CCBS Cancel Invocation (from A-side)..... | 16 | +| 6.3.3 CCBS Cancel Invocation (from B-side)..... | 16 | +| 6.3.4 CCBS Request Error..... | 17 | +| 7 Addressing of SCCP layer messages on the SSAP interface..... | 17 | +| 7.1 Use of SCCP..... | 17 | +| 7.2 Addressing of messages at the originating PLMN..... | 17 | +| 7.2.1 TC-BEGIN message from the originating network HLR..... | 17 | +| 7.2.2 TC-CONTINUE, TC-END messages from the originating network HLR ..... | 18 | +| 7.3 Addressing of messages at the destination PLMN..... | 18 | +| 7.3.1 TC-CONTINUE, TC-END messages from the destination network HLR ..... | 18 | +| 7.4 Number formats of the SCCP address parameters ..... | 19 | +| 7.4.1 Originating PLMN..... | 19 | +| 7.4.2 Destination PLMN..... | 19 | +| Annex A (informative): Change history..... | 20 | + +# --- Foreword + +This Technical Specification has been produced by the 3GPP. + +This TS provides a detailed specification for interworking between the ISDN Supplementary Services ASE protocol and the Mobile Application Part (MAP) D interface protocol for handling of supplementary services within the 3GPP system. + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of this TS, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version 3.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 Indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the specification; + +# --- 1 Scope + +The scope of the present document is to provide a specification for interworking between the ISDN Application Service Element (ASE) protocol for supplementary services and the Mobile Application Part (MAP) protocol on MAP D-interface protocol for handling of supplementary services within the digital cellular telecommunications system (Phase 2+). This version of the specification includes the interworking for the Call Completion to Busy Subscriber (CCBS) service between the ISDN CCBS-ASE and MAP. + +The MAP protocol for CCBS service is specified in GSM 09.02. The ISDN CCBS-ASE protocol is specified in ETS 300 356-18. The ISDN CCBS-ASE protocol is also commonly referred to as the SSAP protocol in GSM 03.93. This specification clarifies the interworking within the HLR between these protocols for the Call Completion to Busy Subscriber (CCBS) service. + +Clause 4 describes the mapping between MAP application layer messages and SSAP application layer messages. + +Clause 5 describes the mapping between MAP message parameters and SSAP message parameters. + +Clause 6 describes the dialogue handling on the SSAP interface. + +Clause 7 describes the SCCP layer addressing for messages on the SSAP interface. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. + +- [1] GSM 01.04: "Digital cellular telecommunications system (Phase 2+); Abbreviations and acronyms". +- [2] GSM 02.93: "Digital cellular telecommunications system (Phase 2+); Completion of calls to busy subscriber (CCBS) supplementary services - Stage 1". +- [3] GSM 03.93: "Digital cellular telecommunications system (Phase 2+); Technical Realisation of Completion of Calls to Busy Subscriber (CCBS); Stage 2". +- [4] GSM 04.80: "Digital cellular telecommunications system (Phase 2+); Mobile radio interface layer 3 supplementary services specification Formats and coding". +- [5] GSM 04.93: "Digital cellular telecommunications system (Phase 2+); Technical Realisation of Completion of Calls to Busy Subscriber (CCBS); Stage 3". +- [6] GSM 09.02 "Digital cellular telecommunications system (Phase 2+); Mobile Application Part (MAP) specification". +- [7] GSM 09.07 : "Digital cellular telecommunications system (Phase 2+); General requirements on interworking between the Public Land Mobile Network (PLMN) and the Integrated Services Digital Network (ISDN) or Public Switched Telephone Network (PSTN)". +- [8] ETS 300 102-1 (1990): "Integrated Services Digital Network (ISDN); User-network interface layer 3 specifications for basic call control". +- [9] ETS 300 356-18: "ISDN User Part (ISUP) version 2 for the international interface: Part 18: Completion of Calls to Busy Subscriber (CCBS) supplementary service". +- [10] ETS 300 358: "Integrated Services Digital Network (ISDN); Completion of Calls to Busy Subscriber (CCBS) supplementary service; Functional capabilities and information flows". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of this specification, the following definitions apply: + +**SSAP:** Supplementary Service Application Part. SSAP is the protocol used for CCBS procedures on the interface between the originating and destination network. Communication across this interface is performed using SCCP Connectionless Signalling (Refer to ETS 300 358). The terms CCBS-ASE defined in ETS 300 356-18 for the ISDN CCBS service and SSAP defined in GSM 03.93 are the same and are used interchangeably in this specification. The SSAP interface is between the originating network entities (HLR A, OLE) and the destination network entities (HLR B, DLE). + +## 3.2 Abbreviations + +Abbreviations used in this specification are listed in GSM 01.04. + +For the purposes of this specification, the following abbreviations apply: + +| | | +|------|----------------------------------------| +| ASE | Application Service Element | +| CCBS | Call Completion to Busy Subscriber | +| DLE | Destination Local Exchange | +| ISDN | Integrated Services Digital Network | +| MAP | Mobile Application Part | +| OLE | Originating Local Exchange | +| SCCP | Signalling Connection Control Part | +| SSAP | Supplementary Service Application Part | +| TC | Transaction Capabilities | + +# 4 General + +## 4.1 GSM CCBS Architecture Overview + +The stage 1 of the CCBS service is defined in GSM 02.93. + +The network architecture to support the CCBS service in GSM networks is defined in GSM 03.93. For convenience, the architecture is shown again in this specification. Figure 4.1.1 is an architectural overview of the CCBS service when interworking between the originating and the destination networks involved. The originating network may be a mobile network or a fixed network and the destination network may also be a mobile network or a fixed network. + +The call related signalling (see ETS 300 356-18) for CCBS is performed on ISUP links on the following interfaces: + +VMSC A - GMSC B; + +VMSC A - DLE; + +OLE - GMSC B; + +whereas the specific CCBS procedures (see ETS 300 356-18) are performed via the SSAP protocol, which is signalled on the following interfaces: + +HLR A - HLR B; + +HLR A - DLE; + +OLE - HLR B. + +This specification only describes the MAP - SSAP protocol interworking. + +![Figure 4.1: Architectural overview showing common point of interworking. The diagram shows an originating network on the left and a destination network on the right, both connected to a central 'TRANSIT NETWORK(S)' cloud. On the left, a 'Fixed Network' (OLE) connects via ISUP and SSAP, and a 'Mobile Network' (HLR A, VLR A, VMSC A) connects via SSAP and ISUP. On the right, a 'Fixed Network' (DLE) connects via ISUP and SSAP, and a 'Mobile Network' (HLR B, VLR B, VMSC B) connects via SSAP, MAP, and ISUP. The GMSC B is shown as an intermediate node between the transit network and the destination mobile network.](28d250125d6a79bb23a8a3d459f54cb6_img.jpg) + +Figure 4.1: Architectural overview showing common point of interworking. The diagram shows an originating network on the left and a destination network on the right, both connected to a central 'TRANSIT NETWORK(S)' cloud. On the left, a 'Fixed Network' (OLE) connects via ISUP and SSAP, and a 'Mobile Network' (HLR A, VLR A, VMSC A) connects via SSAP and ISUP. On the right, a 'Fixed Network' (DLE) connects via ISUP and SSAP, and a 'Mobile Network' (HLR B, VLR B, VMSC B) connects via SSAP, MAP, and ISUP. The GMSC B is shown as an intermediate node between the transit network and the destination mobile network. + +Figure 4.1: Architectural overview showing common point of interworking + +## 4.2 GSM CCBS - ISDN CCBS ASE Interworking Overview + +The non-call related signalling procedures for CCBS between the originating network and the destination network are defined in ETS 300 356-18 as the ISDN CCBS-ASE. The GSM network also uses these signalling procedures for + +CCBS without any changes. The ISDN CCBS ASE protocol is supported in GSM networks in the HLR A (originating network) and HLR B (destination network). Therefore no protocol interworking for ISDN CCBS-ASE is needed for the CCBS service between GSM networks and ISDN networks. + +In GSM networks, the CCBS functionality is distributed across several network entities (see GSM 03.93) including the HLR, VLR, MSC and the MS. The HLR shall provide any necessary signalling interworking between the MAP protocol for call completion services on the MAP D-interface (between the VLR and the HLR) and ISDN CCBS-ASE protocol between the originating and destination networks. + +The MAP protocol for CCBS service is specified in GSM 09.02. The ISDN CCBS-ASE protocol is specified in ETS 300 356-18. This specification clarifies the interworking within the HLR between these protocols. + +## 4.3 Overview on the use of CCBS procedures and parameters values + +A GSM subscriber can roam while there is an active CCBS request. The called party address (MSISDN) information is used to initiate a dialogue with the destination network on the SSAP interface. The dialogue on the SSAP interface is opened and maintained while there is an active CCBS request (see ETS 300 356-18). However, the dialogues on the MAP D interface can be closed and reopened as necessary (see GSM 09.02 and GSM 03.93) and use the IMSI information for addressing. + +## 4.4 Mapping between MAP and SSAP application layer messages + +The mapping of MAP messages on the D interface and SSAP messages between the originating and destination networks is described. The precise coding of these messages is given in GSM 09.02 and ETS 300 356-18. + +### 4.4.1 MAP D-interface to SSAP interface mapping in HLR A + +**Table 4.1: Mapping of GSM 09.02 (MAP) operations to ETS 300 356-18 (SSAP) operations** + +| MAP OPERATIONS | SSAP OPERATIONS | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------| +| RegisterCCEntry | CcbsRequest | +| EraseCCEntry/ A GSM 03.93 Event (note 1) | CcbsCancel | +| RemoteUserFree Result/
RemoteUserFree Error/
A GSM 03.93 Event (note 2) | CcbsSuspend | +| StatusReport/
A GSM 03.93 Event (note 3) | CcbsResume | +| NOTE 1 This event may be local to HLR A. See GSM 03.93 for a dynamic description of possible events in HLR A leading to a CCBS request being cancelled. The SSAP CcbsCancel operation can include a cause code parameter; this shall be set to the appropriate value corresponding to the actual dynamic event by HLR A (e.g. cCBS-T3-Timeout, cCBS-T4-Timeout). | | +| NOTE 2 This event may be local to HLR A. See GSM 03.93 for a dynamic description of possible events in HLR A leading to a CCBS request being suspended. | | +| NOTE 3 This event may be local to HLR A. See GSM 03.93 for a dynamic description of possible events in HLR A leading to a CCBS request being resumed. | | + +### 4.4.2 SSAP interface to MAP D-interface interface mapping in HLR A + +| SSAP OPERATIONS | MAP OPERATIONS | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------| +| CcbsRequest Result | RegisterCCEntry Result | +| CcbsRequest Error | RegisterCCEntry Error | +| RemoteUserFree | RemoteUserFree | +| CcbsCancel | SetReportingState/A GSM 03.93 Event (note 1) | +| NOTE 1 This event may be local to HLR A. See GSM 03.93 for a dynamic description of possible events in HLR A resulting from a CCBS request being cancelled. The SSAP CcbsCancel operation can include a cause code parameter(e.g. cCBS-T7-Timeout, cCBS-T9-Timeout). | | + +# 5 Mapping between MAP message parameters and SSAP message parameters + +The mapping between MAP message parameters and SSAP message parameters is described. The precise coding of these messages is given in GSM 09.02 and ETS 300 356-18. + +The following messages on the SSAP interface do not contain any parameters: + +- RemoteUserFree; +- Suspend; +- Resume. + +## 5.1 CCBS Request Invocation + +![Sequence diagram showing the signalling flow for CCBS Request Invocation between VLRA, HLRA, and DESTINATION NETWORK B.](a234352dfaccdc24745c88eef7724cc6_img.jpg) + +The diagram illustrates the signalling flow for CCBS Request Invocation across three entities: VLRA, HLRA, and DESTINATION NETWORK B. Each entity is represented by a vertical dashed line with a '+' at the top. The sequence of messages is as follows: 1. VLRA sends a 'RegisterCCEntry' message to HLRA, accompanied by a 'TC-BEGIN' indicator. 2. HLRA then sends a 'CcbsRequest' message to DESTINATION NETWORK B, also accompanied by a 'TC-BEGIN' indicator. All messages are represented by horizontal dashed arrows. + +Sequence diagram showing the signalling flow for CCBS Request Invocation between VLRA, HLRA, and DESTINATION NETWORK B. + +Figure 5.1: Signalling flow for CCBS Request Invocation + +**Table 5.1: Mapping of CCBS Request Invocation parameters** + +| RegisterCCEntry PARAMETERS | CcbsRequest PARAMETERS | +|---------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ss-Code | not present | +| ccbs-Feature | | +| - b-subscriberSubaddress (note 1) | accessTransportParameter (note 2) | +| translatedB-Number | calledPartyNumber (note 3) | +| serviceIndicator | not present | +| callInfo | not present | +| networkSignallInfo
- ISDN BC Tag, Length, Content (note 4) | userServiceInf | +| networkSignallInfo
- HLC Tag, Length, Content (note 5) | accessTransportParameter (note 2) | +| networkSignallInfo
- LLC Tag, Length, Content (note 6) | accessTransportParameter (note 2) | +| not present | retainSupported (note 7) | +| not present | callingPartyNumber (note 8) | +| not present | userServiceInfPrime (note 9) | +| NOTE 1 | CCBS-Feature contains the b-subscriberSubaddress parameter which is the called party subaddress. The GSM HLR A shall map the called party subaddress into the accessTransportParameter if received from the VLR. The entire called party subaddress information (i.e. called party subaddress IEI, LENGTH and CONTENT ) is mapped into the accessTransportParameter. See subclause 5.1.1. for details of the required encoding. | +| NOTE 2 | The CcbsRequest contains only one accessTransportParameter. This parameter contains information on the ISDN HLC, LLC and Subaddress. | +| NOTE 3 | The calledParty Number shall be in the international E.164 format. | +| NOTE 4 | The networkSignallInfo contains three information elements ISDN BC, HLC, LLC. The structure of this is defined in GSM 09.02 and the content in GSM 09.07. The ISDN BC information element CONTENT (i.e. without ISDN BC TAG, LENGTH ) is mapped into the userServiceInf parameter. | +| NOTE 5 | The networkSignallInfo contains three information elements ISDN BC, HLC, LLC. The structure of this is defined in GSM 09.02 and the content in GSM 09.07. The entire ISDN HLC information element (i.e. ISDN HLC TAG, LENGTH and CONTENT ) is mapped into the accessTransportParameter. | +| NOTE 6 | The networkSignallInfo contains three information elements ISDN BC, HLC, LLC. The structure of this is defined in GSM 09.02 and the content in GSM 09.07. The entire ISDN LLC information element (i.e. ISDN LLC TAG, LENGTH and CONTENT ) is mapped into the accessTransportParameter. | +| NOTE 7 | This information is local to the HLR A. This information element shall be coded by HLR A to reflect whether it supports CCBS Retention capability. | +| NOTE 8 | This information is local to HLR A. The HLR A provides callingPartyNumber if CLIR was not invoked (See the serviceIndicator parameter in GSM 09.02 and GSM 03.93). If sent, the A subscriber's identity shall be the Basic MSISDN (i.e. the main MSISDN) and shall be in the international E.164 format. | +| NOTE 9 | The GSM HLR A shall not send the userServiceInfPrime | + +### 5.1.1 Encoding of called party subaddress information + +The CCBS-Feature parameter is received from the VLR and it may include the b-subscriberSubaddress parameter as defined in GSM 09.02. The Called Party Subaddress information requires additional processing in HLR to ensure correct encoding of this information on the SSAP interface. The HLR shall add two octets to the ISDN-SubaddressString received from the VLR as indicated in figure 5.2. + +![](7e670a2b556b53ea9002dfff3a420e08_img.jpg) + +| | +|--------------------------------------------------------------------------| +| Called Party Subaddress IEI
(See ETS 300 102-1)
0111 0001 (note 1) | +| Length of the called party address
contents (note 2) | +| ISDN-SubaddressString
(See GSM 09.02)

(note 3) | + +NOTE 1 Called Party Subaddress Information Element Identifier (IEI) is defined by ETS 300 102-1. Its value is "01110001". This information is not sent from the VLR and has to be derived locally in the HLR for interworking purposes. + +NOTE 2 This information has to be derived locally in the HLR for interworking purposes. + +NOTE 3 This information is sent by the VLR. The ISDN-SubaddressString contents is defined in GSM 09.02. + +**Figure 5.2: Encoding of Called Party Subaddress information** + +## 5.2 CCBS Request Result + +![Signalling flow diagram for CCBS Request Result showing interactions between VLRA, HLRA, and DESTINATION NETWORK B.](b3c108e7145f2017957569d06ea359cb_img.jpg) + +``` + +sequenceDiagram + participant VLRA + participant HLRA + participant DN as DESTINATION NETWORK B + Note right of DN: CcbsRequest-Result + Note right of DN: TC-CONTINUE + DN-->HLRA: + Note right of HLRA: RegisterCCEntry-Result + Note right of HLRA: TC-END + HLRA-->VLRA: + +``` + +Signalling flow diagram for CCBS Request Result showing interactions between VLRA, HLRA, and DESTINATION NETWORK B. + +**Figure 5.3: Signalling flow for CCBS Request Result** + +**Table 5.2: Mapping of CCBS Request Result parameters** + +| CcbsRequest_ Result PARAMETERS | RegisterCCEntry_ Result PARAMETERS | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------| +| retainSupported (note 1) | not present | +| not present | ccbs-Feature (note 2) | +| NOTE 1 This information is associated with each CCBS Request and indicates whether CCBS Retention is supported by the destination B network (see GSM 03.93). | | +| NOTE 2 This information is local to the HLR A. Some of information contained in ccbs-Feature (e.g. ccbs-index) is allocated by the HLR A. The ccbs-Feature information is sent to the MS (see GSM 03.93, GSM 04.93). | | + +## 5.3 CCBS Request Error + +![Signalling flow diagram for CCBS Request Error. It shows three vertical lifelines: VLRA, HLRA, and DESTINATION NETWORK B. The sequence starts with a request from VLRA to HLRA. An error message 'CcbsRequest-Error' is sent from DESTINATION NETWORK B to HLRA. HLRA then sends a 'RegisterCCEntry-Error' message back to VLRA. Both error messages are followed by a 'TC-END' indicator.](08441fa90c5fd11994626f662ac13f19_img.jpg) + +``` + +sequenceDiagram + participant VLRA + participant HLRA + participant DESTINATION_NETWORK_B as DESTINATION NETWORK B + Note left of VLRA: Request + Note right of DESTINATION_NETWORK_B: CcbsRequest-Error + DESTINATION_NETWORK_B-->>HLRA: CcbsRequest-Error + Note right of HLRA: TC-END + HLRA-->>VLRA: RegisterCCEntry-Error + Note left of VLRA: TC-END + +``` + +Signalling flow diagram for CCBS Request Error. It shows three vertical lifelines: VLRA, HLRA, and DESTINATION NETWORK B. The sequence starts with a request from VLRA to HLRA. An error message 'CcbsRequest-Error' is sent from DESTINATION NETWORK B to HLRA. HLRA then sends a 'RegisterCCEntry-Error' message back to VLRA. Both error messages are followed by a 'TC-END' indicator. + +**Figure 5.4: Signalling flow for CCBS Request Error****Table 5.3: Mapping of CCBS Request Error parameters** + +| CcbsRequest_ Error PARAMETERS | RegisterCCEntry_ Error PARAMETERS | +|----------------------------------------------------------------------------------------------------------------------|------------------------------------------| +| shortTermDenial/ longTermDenial (note 1) | shortTermDenial/ longTermDenial (note 2) | +| NOTE 1 For coding of these User Errors see ETS 300 356-18. | | +| NOTE 2 For coding of these User Errors see GSM 09.02. This information is sent to the MS (see GSM 04.93, GSM 04.80). | | + +# 6 Dialogue handling on the SSAP interface + +The dialogue handling on the SSAP interface and the mapping between the corresponding TC transaction sublayer messages on the MAP D and SSAP interfaces is described. The diagrams show the general principle of dialogue handling. Specific message flows depend on the dynamics of the application in the network elements, see GSM 03.93 and GSM 09.02. + +## 6.1 Dialogue Beginning + +### 6.1.1 CCBS Request Invocation + +![Sequence diagram showing the signalling flow for CCBS REQUEST INVOCATION between VLRA, HLRA, and DESTINATION NETWORK B. VLRA sends a RegisterCCEntry (TC-BEGIN) to HLRA, which then sends a CcbsRequest (TC-BEGIN SCCP) to DESTINATION NETWORK B.](3ad00ce93ad9dea9ee0f47535e5355e6_img.jpg) + +``` + +sequenceDiagram + participant VLRA + participant HLRA + participant DESTINATION NETWORK B + VLRA->>HLRA: RegisterCCEntry (TC-BEGIN) + HLRA->>DESTINATION NETWORK B: CcbsRequest (TC-BEGIN, SCCP) + +``` + +Sequence diagram showing the signalling flow for CCBS REQUEST INVOCATION between VLRA, HLRA, and DESTINATION NETWORK B. VLRA sends a RegisterCCEntry (TC-BEGIN) to HLRA, which then sends a CcbsRequest (TC-BEGIN SCCP) to DESTINATION NETWORK B. + +Figure 6.1: Signalling flow for CCBS REQUEST INVOCATION + +The CCBS Request invocation is carried by TC-BEGIN. The SCCP addressing parameters on the SSAP interface shall be as shown in table 7.1. + +## 6.2 Dialogue Continuation + +### 6.2.1 CCBS Request Result + +![Sequence diagram showing the signalling flow for CCBS Request Result between DESTINATION NETWORK B, HLRA, and VLRA. DESTINATION NETWORK B sends a CcbsRequest-Result (TC-CONTINUE SCCP) to HLRA, which then sends a RegisterCCEntry-Result (TC-END) to VLRA.](5dfc130b129ace4df375839020a5700d_img.jpg) + +``` + +sequenceDiagram + participant VLRA + participant HLRA + participant DESTINATION NETWORK B + DESTINATION NETWORK B->>HLRA: CcbsRequest-Result (TC-CONTINUE, SCCP) + HLRA->>VLRA: RegisterCCEntry-Result (TC-END) + +``` + +Sequence diagram showing the signalling flow for CCBS Request Result between DESTINATION NETWORK B, HLRA, and VLRA. DESTINATION NETWORK B sends a CcbsRequest-Result (TC-CONTINUE SCCP) to HLRA, which then sends a RegisterCCEntry-Result (TC-END) to VLRA. + +Figure 6.2: Signalling flow for CCBS Request Result + +The CCBS Request Result is carried by TC-CONTINUE. The SCCP addressing parameters on the SSAP interface shall be as shown in table 7.3. + +### 6.2.2 CCBS Remote User Free Invocation + +![Sequence diagram showing the entities VLRA, HLRA, and DESTINATION NETWORK B, but without any message flows depicted between them.](ea37ab05b033e59cfdf7b074161aaf5a_img.jpg) + +``` + +sequenceDiagram + participant VLRA + participant HLRA + participant DESTINATION NETWORK B + +``` + +Sequence diagram showing the entities VLRA, HLRA, and DESTINATION NETWORK B, but without any message flows depicted between them. + +![Sequence diagram for Remote User Free Invocation. It shows two lifelines. The right lifeline sends a RemoteUserFree message with TC-CONTINUE and SCCP to the left lifeline. The left lifeline then sends RemoteUserFree with TC-BEGIN to the right lifeline.](a33da0f14e456f92539ce3e9b7d81f9a_img.jpg) + +``` + +sequenceDiagram + participant Left as + participant Right as + Right->>Left: RemoteUserFree +TC-CONTINUE +SCCP + Left->>Right: RemoteUserFree +TC-BEGIN + +``` + +Sequence diagram for Remote User Free Invocation. It shows two lifelines. The right lifeline sends a RemoteUserFree message with TC-CONTINUE and SCCP to the left lifeline. The left lifeline then sends RemoteUserFree with TC-BEGIN to the right lifeline. + +**Figure 6.3: Signalling flow for Remote User Free Invocation** + +The CCBS Remote User Free Invocation is carried by TC-CONTINUE. The SCCP addressing parameters on the SSAP interface shall be as shown in table 7.3. + +### 6.2.3 CCBS Suspend Invocation + +![Sequence diagram for CCBS Suspend Invocation (RemoteUserFree_Result). It shows three lifelines: VLRA, HLRA, and DESTINATION NETWORK B. VLRA sends RemoteUserFree-Result and TC-END to HLRA. HLRA then sends CcbsSuspend (note 1), TC-CONTINUE, and SCCP to DESTINATION NETWORK B.](16c1175b5f05a4b55e6d396fc51b15b3_img.jpg) + +``` + +sequenceDiagram + participant VLRA + participant HLRA + participant DESTINATION_NETWORK_B as DESTINATION NETWORK B + VLRA->>HLRA: RemoteUserFree-Result +TC-END + HLRA->>DESTINATION_NETWORK_B: CcbsSuspend (note 1) +TC-CONTINUE +SCCP + +``` + +Sequence diagram for CCBS Suspend Invocation (RemoteUserFree\_Result). It shows three lifelines: VLRA, HLRA, and DESTINATION NETWORK B. VLRA sends RemoteUserFree-Result and TC-END to HLRA. HLRA then sends CcbsSuspend (note 1), TC-CONTINUE, and SCCP to DESTINATION NETWORK B. + +NOTE 1 For conditions leading to a request being suspended, see GSM 03.93 + +**Figure 6.4: Signalling flow for CCBS Suspend Invocation (RemoteUserFree\_Result)** + +![Sequence diagram for CCBS Suspend Invocation (RemoteUserFree_Error). It shows three lifelines: VLRA, HLRA, and DESTINATION NETWORK B. VLRA sends RemoteUserFree-Error and TC-END to HLRA. HLRA then sends CcbsSuspend (note 1), TC-CONTINUE, and SCCP to DESTINATION NETWORK B.](d17f75945bbb3feb84a153ecfedb9b81_img.jpg) + +``` + +sequenceDiagram + participant VLRA + participant HLRA + participant DESTINATION_NETWORK_B as DESTINATION NETWORK B + VLRA->>HLRA: RemoteUserFree-Error +TC-END + HLRA->>DESTINATION_NETWORK_B: CcbsSuspend (note 1) +TC-CONTINUE +SCCP + +``` + +Sequence diagram for CCBS Suspend Invocation (RemoteUserFree\_Error). It shows three lifelines: VLRA, HLRA, and DESTINATION NETWORK B. VLRA sends RemoteUserFree-Error and TC-END to HLRA. HLRA then sends CcbsSuspend (note 1), TC-CONTINUE, and SCCP to DESTINATION NETWORK B. + +NOTE 1 For conditions leading to a request being suspended, see GSM 03.93 + +**Figure 6.5: Signalling flow for CCBS Suspend Invocation (RemoteUserFree\_Error)** + +The CCBS Suspend Invocation is carried by TC-CONTINUE. The SCCP addressing parameters on the SSAP interface shall be as shown in table 7.2 + +### 6.2.4 CCBS Resume Invocation + +![Sequence diagram for CCBS Resume Invocation showing signaling flow between VLRA, HLRA, and DESTINATION NETWORK B.](75f0cb39f1cd165dfe4a6aa6c4d9388d_img.jpg) + +``` + +sequenceDiagram + participant VLRA + participant HLRA + participant DN as DESTINATION NETWORK B + Note left of VLRA: +--+\n | |\n +--+\n Note right of HLRA: +--+\n | |\n +--+\n Note right of DN: +--+\n | |\n +--+\n VLRA->>HLRA: StatusReport\n Note left of HLRA: TC-BEGIN\n HLRA->>DN: CcbsResume (note 1)\n Note right of DN: TC-CONTINUE\n Note right of DN: SCCP + +``` + +Sequence diagram for CCBS Resume Invocation showing signaling flow between VLRA, HLRA, and DESTINATION NETWORK B. + +NOTE 1 For conditions leading to a request being resumed, see GSM 03.93 + +**Figure 6.6: Signalling flow for CCBS Resume Invocation** + +The CCBS Resume Invocation is carried by TC-CONTINUE. The SCCP addressing parameters on the SSAP interface shall be as shown in table 7.2. + +## 6.3 Dialogue End + +### 6.3.1 Normal dialogue end + +![Sequence diagram for Normal dialogue end showing signaling flow between VLRA, HLRA, and DESTINATION NETWORK B.](70de8885bd7de15723aaad5eb5c5febf_img.jpg) + +``` + +sequenceDiagram + participant VLRA + participant HLRA + participant DN as DESTINATION NETWORK B + Note left of VLRA: +--+\n | |\n +--+\n Note right of HLRA: +--+\n | |\n +--+\n Note right of DN: +--+\n | |\n +--+\n DN->>HLRA: No component primitive\n Note left of HLRA: TC-END\n Note left of HLRA: SCCP\n HLRA->>VLRA: SetReportingState (note 1)\n Note left of VLRA: TC-BEGIN + +``` + +Sequence diagram for Normal dialogue end showing signaling flow between VLRA, HLRA, and DESTINATION NETWORK B. + +NOTE 1 If the monitoring function is active in VLR A and all outstanding CCBS Requests have been deactivated, the HLR A sends SetReportingState to deactivate the monitoring function (see GSM 03.93). + +**Figure 6.7: Signalling flow for normal dialogue end** + +The normal ending of CCBS dialogue from the B-side is carried by TC-END. The SCCP addressing parameters on the SSAP interface shall be as shown in table 7.3. + +### 6.3.2 CCBS Cancel Invocation (from A-side) + +![Sequence diagram for CCBS Cancel Invocation from A-side](16152cf1d84aea10848758f51a91ff6a_img.jpg) + +``` +sequenceDiagram + participant VLRA + participant HLRA + participant DN as DESTINATION NETWORK B + Note left of VLRA: (note 1) + VLRA->>HLRA: EraseCCEntry + Note right of HLRA: (note 1) + HLRA->>DN: CcbsCancel + Note right of DN: (note 1) +``` + +The diagram illustrates the signalling flow for CCBS Cancel Invocation from the A-side. It involves three entities: VLRA, HLRA, and DESTINATION NETWORK B. The sequence of messages is as follows: VLRA sends an 'EraseCCEntry' message to HLRA, with a note indicating that all outstanding CCBS Requests have been deactivated. HLRA then sends a 'CcbsCancel' message to DESTINATION NETWORK B, with a note indicating that the message is sent to each corresponding Destination Network B. The 'CcbsCancel' message is accompanied by 'TC-END' and 'SCCP' parameters. + +Sequence diagram for CCBS Cancel Invocation from A-side + +NOTE 1 Where all outstanding CCBS Requests have been deactivated, CCBS Cancel is sent to each corresponding Destination Network B with the appropriate Destination Network B E.164 Called Party Address (see GSM 03.93, GSM 04.93). + +**Figure 6.8: Signalling flow for CCBS Cancel Invocation (from A-side)** + +The CCBS Cancel Invocation from the A-side is carried by TC-END. The SCCP addressing parameters on the SSAP interface shall be as shown in table 7.2. + +### 6.3.3 CCBS Cancel Invocation (from B-side) + +![Sequence diagram for CCBS Cancel Invocation from B-side](6f341f415ee0f8c724e5d6daeb1e9b4a_img.jpg) + +``` +sequenceDiagram + participant VLRA + participant HLRA + participant DN as DESTINATION NETWORK B + Note left of HLRA: (note 1) + HLRA->>VLRA: SetReportingState + Note right of VLRA: (note 1) + DN->>HLRA: CcbsCancel + Note right of HLRA: (note 1) +``` + +The diagram illustrates the signalling flow for CCBS Cancel Invocation from the B-side. It involves three entities: VLRA, HLRA, and DESTINATION NETWORK B. The sequence of messages is as follows: DESTINATION NETWORK B sends a 'CcbsCancel' message to HLRA, with a note indicating that the message is sent to each corresponding Destination Network B. HLRA then sends a 'SetReportingState' message to VLRA, with a note indicating that the monitoring function is active in VLR A and all outstanding CCBS Requests have been deactivated. The 'SetReportingState' message is accompanied by 'TC-BEGIN' parameters. + +Sequence diagram for CCBS Cancel Invocation from B-side + +NOTE 1: If the monitoring function is active in VLR A and all outstanding CCBS Requests have been deactivated, the HLR A sends SetReportingState to deactivate the monitoring function (see GSM 03.93). + +**Figure 6.9: Signalling flow for CCBS Cancel Invocation (from B-side)** + +The CCBS Cancel Invocation from the B-side is carried by TC-END. The SCCP addressing parameters on the SSAP interface shall be as shown in table 7.3. + +### 6.3.4 CCBS Request Error + +![Sequence diagram showing signalling flow for CCBS Request Error between VLRA, HLRA, and DESTINATION NETWORK B. The diagram shows two error messages: RegisterCCEntry-Error from DESTINATION NETWORK B to VLRA, and CcbsRequest-Error from DESTINATION NETWORK B to HLRA. Both messages include TC-END and SCCP parameters.](df82d77a0d2637cbf2da9ea920a554fa_img.jpg) + +``` + +sequenceDiagram + participant VLRA + participant HLRA + participant DN as DESTINATION NETWORK B + Note right of DN: CcbsRequest-Error +TC-END +SCCP + DN-->HLRA: CcbsRequest-Error + Note right of DN: RegisterCCEntry-Error +TC-END + DN-->VLRA: RegisterCCEntry-Error + +``` + +Sequence diagram showing signalling flow for CCBS Request Error between VLRA, HLRA, and DESTINATION NETWORK B. The diagram shows two error messages: RegisterCCEntry-Error from DESTINATION NETWORK B to VLRA, and CcbsRequest-Error from DESTINATION NETWORK B to HLRA. Both messages include TC-END and SCCP parameters. + +Figure 6.10: Signalling flow for CCBS Request Error + +The CCBS Request Error is carried by TC-END. The SCCP addressing parameters on the SSAP interface shall be as shown in table 7.3. + +# 7 Addressing of SCCP layer messages on the SSAP interface + +The SCCP layer addressing for messages on the SSAP interface is described. + +## 7.1 Use of SCCP + +Clarifications and restrictions on the use and coding of the main SCCP parameters impacted by CCBS on the SSAP interface are indicated. See ETS 300 356-18 and the associated references for the full specification on the use of SCCP on the SSAP interface. The SCCP routeing on the SSAP interface shall be based on the Global Title (GT) translation mechanism as for routeing on the international interface. GT addressing shall be used for inter and intra PLMN signalling. This allows any impact of other network features e.g. Mobile Number Portability to be minimised. + +## 7.2 Addressing of messages at the originating PLMN + +### 7.2.1 TC-BEGIN message from the originating network HLR + +The relevant SCCP parameters in the first message from the HLR A transporting TC-BEGIN are shown in table 7.1. All other SCCP parameters shall be as indicated in ETS 300 356-18. + +**Table 7.1: SCCP parameters used by HLR A for TC-BEGIN** + +| SCCP PARAMETERS for the message transporting TC-BEGIN | PARAMETER VALUE | +|--------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| CdPA-Called Party Address | E.164 number of the Called Party. This may be in either international or national E.164 format, see subclause 7.4.1. It is derived from the translatedB-Number parameter which is available from the CCBS application in HLRA, see RegisterCCEntry in GSM 09.02. | +| CgPA-Calling Party Address | E.164 number of HLR A. This may be in either international or national E.164 format, see subclause 7.4.1. | +| SSN- Subsystem Number | 0000 1011
(See ETS 300 356-18) | +| TT- Translation Type | 0001 0001
(See ETS 300 356-18) | +| Other SCCP Parameters | See ETS 300 356-18 | + +### 7.2.2 TC-CONTINUE, TC-END messages from the originating network HLR + +The relevant SCCP parameters in the subsequent messages from the HLR A transporting TC-CONTINUE and TC-END are shown in table 7.2. All other SCCP parameters shall be as indicated in ETS 300 356-18. + +**Table 7.2: SCCP parameters used by HLR A for TC-CONTINUE, TC-END** + +| SCCP PARAMETERS for the message transporting TC-CONTINUE, TC-END | PARAMETER VALUE | +|-------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| CdPA-Called Party Address | The Called Party Address is the E.164 address of the calling entity in the destination network that was received in the first response message from the destination network (note 1). | +| CgPA-Calling Party Address | E.164 number of HLR A. This may be in either international or national E.164 format as used in the message transporting TC-BEGIN, see subclause 7.4.1. | +| SSN- Subsystem Number | 0000 1011
(See ETS 300 356-18) | +| TT- Translation Type | 0001 0001
(See ETS 300 356-18) | +| Other SCCP Parameters | See ETS 300 356-18 | +| NOTE 1 | If the destination network is a GSM PLMN, this is E.164 number of HLR B. | + +## 7.3 Addressing of messages at the destination PLMN + +### 7.3.1 TC-CONTINUE, TC-END messages from the destination network HLR + +The relevant SCCP parameters in the first and subsequent messages from the HLR B transporting TC-CONTINUE and TC-END are shown in table 7.3. All other SCCP parameters shall be as indicated in ETS 300 356-18. + +**Table 7.3: SCCP parameters for TC-CONTINUE, TC-END used by HLR B** + +| SCCP PARAMETERS for the message transporting TC-CONTINUE, TC-END | PARAMETER VALUE | +|-------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| CdPA-Called Party Address | The Called Party Address is the E.164 address of the calling entity in the originating network that was received in the first message transporting TC-BEGIN from the originating network (note 1). | +| CgPA-Calling Party Address | E.164 number of HLR B. This may be in either international or national E.164 format, see subclause 7.4.2 (note 2) | +| SSN- Subsystem Number | 0000 1011
(See ETS 300 356-18) | +| TT- Translation Type | 0001 0001
(See ETS 300 356-18) | +| Other SCCP Parameters | See ETS 300 356-18 | +| NOTE 1 | If the originating network is a GSM PLMN, this is E.164 number of HLR A. | +| NOTE 2 | The E.164 number of HLR B is used as this allows any impact of other network features to be minimised. | + +## 7.4 parameters + +### Number formats of the SCCP address + +The Called and Calling Party Address information in SCCP should be in international E.164 format. Optionally national format E.164 addresses may be used in SCCP for routing of national traffic. For this, the HLR has to modify the addresses which are in international E.164 format to a national E.164 format. If a national format E.164 option is used, all involved network nodes in a given country (i.e. the originating network, any transit networks and the destination network) need support that option. As negotiation is not possible, the option selected by the originating network shall determine the addressing used for all messages which are a part of a single dialogue. + +### 7.4.1 Originating PLMN + +The Called and Calling Party Address information in SCCP should be in international E.164 format. + +The originating network HLR A may use the SCCP Called Party Address in national E.164 format if the called destination (as indicated by the translatedB-number) is in the same country as HLR A. + +The originating network HLR A may use the SCCP Calling Party Address in national E.164 format if the called destination (as indicated by the translatedB-number) is in the same country as HLR A. + +The originating network HLR A shall ensure that the SCCP Called and Calling Party Addresses are either both in international format or national format. + +### 7.4.2 Destination PLMN + +The Called and Calling Party Address information in SCCP should be in international E.164 format. + +The destination network HLR B may use the SCCP Called Party Address in national E.164 format if the originating network is in the same country as HLR B. + +The destination network HLR B may use the SCCP Calling Party Address in national E.164 format if the originating network is in the same country as HLR B. + +The destination network HLR B shall ensure that the SCCP Called and Calling Party Addresses are either both in international format or national format. + +# Annex A (informative): Change history + +| TSG SA# | Spec | CR | | New Version | Subject/Comment | +|---------|--------|------|---------|-------------|--------------------------------| +| CN#04 | 29.013 | | R99 | 3.0.0 | Approved at CN#04 | +| CN#11 | 29.013 | | Rel-4 | 4.0.0 | Approved at CN#11 | +| CN#16 | 29.013 | | Rel-4 | 4.0.1 | References updated | +| CN#16 | 29.013 | | Rel-5 | 5.0.0 | Rel-5 created after CN#16 | +| CN#26 | 29.013 | | Rel-6 | 6.0.0 | Rel-6 created after CN#26 | +| CT#36 | 29.013 | | Rel-7 | 7.0.0 | Upgraded unchanged from Rel-6 | +| CT#42 | 29.013 | | Rel-8 | 8.0.0 | Upgraded unchanged from Rel-7 | +| CT#46 | 29.013 | 0006 | Rel-8 | 8.1.0 | ISDN BC mapping | +| CT#46 | 29.013 | | Rel-9 | 9.0.0 | Upgraded unchanged from Rel-8 | +| 2011-03 | 29.013 | - | Rel-10 | 10.0.0 | Update to Rel-10 version (MCC) | +| 2012-09 | 29.013 | - | Rel-11 | 11.0.0 | Update to Rel-11 version (MCC) | +| 2014-09 | 29.013 | - | Rel-12 | 12.0.0 | Update to Rel-12 version (MCC) | +| 2015-12 | 29.013 | - | Rel-13 | 13.0.0 | Update to Rel-13 version (MCC) | +| 2017-03 | 29.013 | - | Rel-14 | 14.0.0 | Update to Rel-14 version (MCC) | +| 2018-06 | 29.013 | - | Rel-15 | 15.0.0 | Update to Rel-15 version (MCC) | +| 2020-07 | 29.013 | - | Rel-16 | 16.0.0 | Update to Rel-16 version (MCC) | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29078/1a85642ed2356d183ce598f2c8b3ee8b_img.jpg b/marked/Rel-16/29_series/29078/1a85642ed2356d183ce598f2c8b3ee8b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..01b18b86762524e161bc44d09a71dba9a83668d5 --- /dev/null +++ b/marked/Rel-16/29_series/29078/1a85642ed2356d183ce598f2c8b3ee8b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:09886deeb229f5fee19acc1463736f80aa88167de77210ec4c39ba413ca06224 +size 28745 diff --git a/marked/Rel-16/29_series/29078/3da1a07cb87051bf616c9876db958cf0_img.jpg b/marked/Rel-16/29_series/29078/3da1a07cb87051bf616c9876db958cf0_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a8e59bccd0c7cb5c5edf42f3af05a97c98c8ee0c --- /dev/null +++ b/marked/Rel-16/29_series/29078/3da1a07cb87051bf616c9876db958cf0_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4e391fb7d97af218d39645760947003287516adebe48a874a6cb742466b4f4c7 +size 15923 diff --git a/marked/Rel-16/29_series/29078/552ca016af3d6240648ab5a2cad97f60_img.jpg b/marked/Rel-16/29_series/29078/552ca016af3d6240648ab5a2cad97f60_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..12419d6802c828a505fd811dacc5448fbbd9f698 --- /dev/null +++ b/marked/Rel-16/29_series/29078/552ca016af3d6240648ab5a2cad97f60_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f57e4d231f871f9241fc941b7872e189c48c331dc5712b232752b86d98b8ba06 +size 40184 diff --git a/marked/Rel-16/29_series/29078/5793a44ffdadd039928e2f9fe6daae06_img.jpg b/marked/Rel-16/29_series/29078/5793a44ffdadd039928e2f9fe6daae06_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ea8608e1db7be837273b95e32d13ac5afef95994 --- /dev/null +++ b/marked/Rel-16/29_series/29078/5793a44ffdadd039928e2f9fe6daae06_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3e4019e0c5bd740dcc4555f277ba4f688cca488ae943d9bc8adaa75c5f3bd95e +size 18250 diff --git a/marked/Rel-16/29_series/29078/75e4b78ee25f885d73120e3066a5253e_img.jpg b/marked/Rel-16/29_series/29078/75e4b78ee25f885d73120e3066a5253e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..20ab0f7d6480bb72d250a65eded9ce7b577ab207 --- /dev/null +++ b/marked/Rel-16/29_series/29078/75e4b78ee25f885d73120e3066a5253e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0763401d9a847155116d59359b2e6ccf2521e930c09b46051067538daa24836e +size 17695 diff --git a/marked/Rel-16/29_series/29078/79e1709a7317ead45379cbb8ff3ba802_img.jpg b/marked/Rel-16/29_series/29078/79e1709a7317ead45379cbb8ff3ba802_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..235c530b3002b4ba809d2adf90fff4d97bb5d449 --- /dev/null +++ b/marked/Rel-16/29_series/29078/79e1709a7317ead45379cbb8ff3ba802_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cdce930de22bef5282b17022803b68448bc40b901e739410093d3c9417505328 +size 26109 diff --git a/marked/Rel-16/29_series/29078/90ddb84c323b956e2d50a54d3f870566_img.jpg b/marked/Rel-16/29_series/29078/90ddb84c323b956e2d50a54d3f870566_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c2ea169724b6e0e0e83242a53b51c8a7538c88c4 --- /dev/null +++ b/marked/Rel-16/29_series/29078/90ddb84c323b956e2d50a54d3f870566_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d3881d72d34d4a7aa545d5d9ae9fab4a4754793d82814cc8fb5cd5c4b841a6fe +size 80528 diff --git a/marked/Rel-16/29_series/29078/a24e89a6fe9bb70c83f8bf5202baba95_img.jpg b/marked/Rel-16/29_series/29078/a24e89a6fe9bb70c83f8bf5202baba95_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a4c81b9c3c4b4b2cd425de13505845de2664dfb4 --- /dev/null +++ b/marked/Rel-16/29_series/29078/a24e89a6fe9bb70c83f8bf5202baba95_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:689d2936b49dd0e6b21392f71f508baca1b106750e526e64814ba46075eda8ae +size 39286 diff --git a/marked/Rel-16/29_series/29078/b2ea162a0f53d5e0504b7d28346e0754_img.jpg b/marked/Rel-16/29_series/29078/b2ea162a0f53d5e0504b7d28346e0754_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..72e6718e31297768d5e279b1fabc203bd2d1b8f4 --- /dev/null +++ b/marked/Rel-16/29_series/29078/b2ea162a0f53d5e0504b7d28346e0754_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a69dbea4d9dbca99fd550317c1d34e72c406110b514cb13b41e4944a8a189404 +size 23164 diff --git a/marked/Rel-16/29_series/29078/d9c0a780cd22626253dab4aa41699e2f_img.jpg b/marked/Rel-16/29_series/29078/d9c0a780cd22626253dab4aa41699e2f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..507fa4d4e3764973a764bf7c494671b3c32fbcda --- /dev/null +++ b/marked/Rel-16/29_series/29078/d9c0a780cd22626253dab4aa41699e2f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:80884669a6d6e9e0fbef7e02148cf239e0bb679a722750f550dc12c2f9a84655 +size 18894 diff --git a/marked/Rel-16/29_series/29078/e180f2b5fcbe8001554a7c0677cd3f82_img.jpg b/marked/Rel-16/29_series/29078/e180f2b5fcbe8001554a7c0677cd3f82_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1a3a988631dc824795162e099cf93b01e531dec2 --- /dev/null +++ b/marked/Rel-16/29_series/29078/e180f2b5fcbe8001554a7c0677cd3f82_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cd9127c2c6291a581bd93310083a098c6b69f35fa7280ee20ce6ec750a89478c +size 25720 diff --git a/marked/Rel-16/29_series/29078/eb03559a4d92ea9ebd63ea9be663c50a_img.jpg b/marked/Rel-16/29_series/29078/eb03559a4d92ea9ebd63ea9be663c50a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a329ad08a9cd201967a1d51527026b2ad459283b --- /dev/null +++ b/marked/Rel-16/29_series/29078/eb03559a4d92ea9ebd63ea9be663c50a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6dfb5ae7079da5f281c045b9c9416c33a07a5264f10956d3656331694a5a34c7 +size 14649 diff --git a/marked/Rel-16/29_series/29078/f7d969388c4f7e30cd04a061314bfa0e_img.jpg b/marked/Rel-16/29_series/29078/f7d969388c4f7e30cd04a061314bfa0e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..520dc5b99326308fba18f1d378b71bac8b000cff --- /dev/null +++ b/marked/Rel-16/29_series/29078/f7d969388c4f7e30cd04a061314bfa0e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:54a09fde5401308d91b3ef05277eb3a9e5b0080aaf421b08b507e2b5f62766f5 +size 39815 diff --git a/marked/Rel-16/29_series/29078/raw.md b/marked/Rel-16/29_series/29078/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..63b846b361aabc161544acbcbe435aadc69e0bd7 --- /dev/null +++ b/marked/Rel-16/29_series/29078/raw.md @@ -0,0 +1,13272 @@ + + + + +**Error:** + +**2** + +**Error: Reference source not** + +# Contents + +| | | +|--------------------------------------------------------------------------------------------------------------|----| +| Foreword..... | 14 | +| 1 Scope..... | 15 | +| 2 References..... | 15 | +| 2.1 Specifications used for IMPORTS for CAP..... | 17 | +| 3 Abbreviations..... | 18 | +| 4 Interface specification for telecommunication services..... | 19 | +| 4.1 General..... | 19 | +| 4.1.1 Definition methodology..... | 19 | +| 4.1.2 Example physical scenarios..... | 20 | +| 4.1.3 CAP protocol architecture..... | 26 | +| 4.1.4 Compatibility mechanisms used for CAP..... | 27 | +| 4.1.4.1 Introduction..... | 27 | +| 4.1.4.2 Definition of CAP compatibility mechanisms..... | 28 | +| 4.1.4.2.1 Compatibility mechanism for interworking of CAP with ETSI CS2 Core INAP and ITU-T Q.1228 INAP..... | 28 | +| 4.1.4.2.2 Procedures for major additions to CAP..... | 28 | +| 4.1.4.2.3 Procedures for minor additions to CAP..... | 28 | +| 4.1.4.2.4 Procedures for inclusion of network specific additions to CAP..... | 28 | +| 4.1.5 Definition and usage of LegID..... | 28 | +| 4.1.5.1 Definition of LegID..... | 28 | +| 4.1.5.2 Allocation of LegID..... | 29 | +| 4.2 SACF/MACF rules..... | 29 | +| 4.2.1 Reflection of TC AC..... | 29 | +| 4.2.2 Sequential/parallel execution of operations..... | 29 | +| 5 Common CAP Types..... | 29 | +| 5.1 Data types..... | 29 | +| 5.2 Error types..... | 49 | +| 5.3 Operation codes..... | 51 | +| 5.4 Error codes..... | 53 | +| 5.5 Classes..... | 53 | +| 5.6 Object Identifiers (IDs)..... | 57 | +| 5.7 User Abort Data..... | 60 | +| 6 Circuit Switched Call Control..... | 61 | +| 6.1 gsmSSF/CCF - gsmSCF Interface..... | 61 | +| 6.1.1 Operations and arguments..... | 61 | +| 6.1.2 gsmSSF/gsmSCF packages, contracts and ACs..... | 73 | +| 6.1.2.1 gsmSSF/gsmSCF ASN.1 module..... | 73 | +| 6.2 gsmSCF/gsmSRF interface..... | 81 | +| 6.2.1 gsmSCF/gsmSRF operations and arguments..... | 81 | +| 6.2.2 gsmSRF/gsmSCF contracts, packages and ACs..... | 83 | +| 6.2.2.1 gsmSRF/gsmSCF ASN.1 modules..... | 83 | +| 7 SMS Control..... | 85 | +| 7.1 SMS operations and arguments..... | 85 | +| 7.1.1 Operation timers..... | 89 | +| 7.2 SMS contracts, packages and ACs..... | 89 | +| 7.2.1 smsSSF/gsmSCF ASN.1 module..... | 89 | +| 8 GPRS Control..... | 92 | +| 8.1 gsmSCF/gprsSSF operations and arguments..... | 92 | +| 8.1.1 GPRS Reference Number..... | 97 | +| 8.1.2 Operation timers..... | 98 | +| 8.2 gsmSCF/gprsSSF contracts, packages and ACs..... | 99 | +| 8.2.1 gprsSSF/gsmSCF ASN.1 module..... | 99 | + +| | | | +|------------|--------------------------------------------------|-----| +| 9 | Application Entity procedures..... | 102 | +| 10 | Error procedures..... | 103 | +| 10.1 | Operation related error procedures..... | 103 | +| 10.1.1 | Canceled..... | 103 | +| 10.1.1.1 | General Description..... | 103 | +| 10.1.1.1.1 | Error description..... | 103 | +| 10.1.1.2 | Operations gsmSCF $\textcircled{/}$ gsmSRF..... | 103 | +| 10.1.2 | CancelFailed..... | 104 | +| 10.1.2.1 | General description..... | 104 | +| 10.1.2.1.1 | Error description..... | 104 | +| 10.1.2.2 | Operations gsmSCF $\textcircled{/}$ gsmSRF..... | 104 | +| 10.1.3 | ETCFailed..... | 104 | +| 10.1.3.1 | General description..... | 104 | +| 10.1.3.1.1 | Error description..... | 104 | +| 10.1.3.2 | Operations gsmSCF $\textcircled{/}$ gsmSSF..... | 104 | +| 10.1.4 | ImproperCallerResponse..... | 105 | +| 10.1.4.1 | General description..... | 105 | +| 10.1.4.1.1 | Error description..... | 105 | +| 10.1.4.2 | Operations gsmSCF $\textcircled{/}$ gsmSRF..... | 105 | +| 10.1.5 | MissingCustomerRecord..... | 105 | +| 10.1.5.1 | General description..... | 105 | +| 10.1.5.1.1 | Error description..... | 105 | +| 10.1.5.2 | Operations gsmSSF $\textcircled{/}$ gsmSCF..... | 105 | +| 10.1.5.3 | Operations gsmSRF $\textcircled{/}$ gsmSCF..... | 106 | +| 10.1.5.4 | Operations smsSSF $\textcircled{/}$ gsmSCF..... | 106 | +| 10.1.5.5 | Operations gprsSSF $\textcircled{/}$ gsmSCF..... | 106 | +| 10.1.6 | MissingParameter..... | 107 | +| 10.1.6.1 | General description..... | 107 | +| 10.1.6.1.1 | Error description..... | 107 | +| 10.1.6.2 | Operations gsmSCF $\textcircled{/}$ gsmSSF..... | 107 | +| 10.1.6.3 | Operations gsmSSF $\textcircled{/}$ gsmSCF..... | 107 | +| 10.1.6.4 | Operations gsmSCF $\textcircled{/}$ gsmSRF..... | 107 | +| 10.1.6.5 | Operations gsmSRF $\textcircled{/}$ gsmSCF..... | 108 | +| 10.1.6.6 | Operations smsSSF $\textcircled{/}$ gsmSCF..... | 108 | +| 10.1.6.7 | Operations gsmSCF $\textcircled{/}$ smsSSF..... | 108 | +| 10.1.6.8 | Operations gprsSSF $\textcircled{/}$ gsmSCF..... | 108 | +| 10.1.6.9 | Operations gsmSCF $\textcircled{/}$ gprsSSF..... | 109 | +| 10.1.7 | ParameterOutOfRange..... | 109 | +| 10.1.7.1 | General description..... | 109 | +| 10.1.7.1.1 | Error description..... | 109 | +| 10.1.7.2 | Operations gsmSCF $\textcircled{/}$ gsmSSF..... | 109 | +| 10.1.7.3 | Operations gsmSSF $\textcircled{/}$ gsmSCF..... | 109 | +| 10.1.7.4 | Operations gsmSCF $\textcircled{/}$ gsmSRF..... | 109 | +| 10.1.7.5 | Operations smsSSF $\textcircled{/}$ gsmSCF..... | 109 | +| 10.1.7.6 | Operations gsmSCF $\textcircled{/}$ smsSSF..... | 109 | +| 10.1.7.7 | Operations gprsSSF $\textcircled{/}$ gsmSCF..... | 109 | +| 10.1.7.8 | Operations gsmSCF $\textcircled{/}$ gprsSSF..... | 110 | +| 10.1.8 | RequestedInfoError..... | 110 | +| 10.1.8.1 | General description..... | 110 | +| 10.1.8.1.1 | Error description..... | 110 | +| 10.1.8.2 | Operations gsmSCF $\textcircled{/}$ gsmSSF..... | 110 | +| 10.1.9 | SystemFailure..... | 110 | +| 10.1.9.1 | General description..... | 110 | +| 10.1.9.1.1 | Error description..... | 110 | +| 10.1.9.2 | Operations gsmSCF $\textcircled{/}$ gsmSSF..... | 110 | +| 10.1.9.3 | Operations gsmSSF $\textcircled{/}$ gsmSCF..... | 110 | + +| | | | +|-------------|-------------------------------------------------------------------------------------------------|-----| +| 10.1.9.4 | Operations gsmSCF $\textcircled{/}$ gsmSRF..... | 110 | +| 10.1.9.5 | Operations gsmSRF $\textcircled{/}$ gsmSCF..... | 110 | +| 10.1.9.6 | Operations smsSSF $\textcircled{/}$ gsmSCF..... | 110 | +| 10.1.9.7 | Operations gsmSCF $\textcircled{/}$ smsSSF..... | 110 | +| 10.1.9.8 | Operations gprsSSF $\textcircled{/}$ gsmSCF..... | 110 | +| 10.1.9.9 | Operations gsmSCF $\textcircled{/}$ gprsSSF..... | 111 | +| 10.1.10 | TaskRefused..... | 111 | +| 10.1.10.1 | General description..... | 111 | +| 10.1.10.1.1 | Error description..... | 111 | +| 10.1.10.2 | Operations gsmSCF $\textcircled{/}$ gsmSSF..... | 111 | +| 10.1.10.3 | Operations gsmSSF $\textcircled{/}$ gsmSCF..... | 111 | +| 10.1.10.4 | Operations gsmSCF $\textcircled{/}$ gsmSRF..... | 111 | +| 10.1.10.5 | Operations gsmSRF $\textcircled{/}$ gsmSCF..... | 111 | +| 10.1.10.6 | Operations smsSSF $\textcircled{/}$ gsmSCF..... | 111 | +| 10.1.10.7 | Operations gsmSCF $\textcircled{/}$ smsSSF..... | 111 | +| 10.1.10.8 | Operations gprsSSF $\textcircled{/}$ gsmSCF..... | 111 | +| 10.1.10.9 | Operations gsmSCF $\textcircled{/}$ gprsSSF..... | 111 | +| 10.1.11 | UnavailableResource..... | 112 | +| 10.1.11.1 | General description..... | 112 | +| 10.1.11.1.1 | Error description..... | 112 | +| 10.1.11.2 | Operations gsmSCF $\textcircled{/}$ gsmSRF..... | 112 | +| 10.1.12 | UnexpectedComponentSequence..... | 112 | +| 10.1.12.1 | General description..... | 112 | +| 10.1.12.1.1 | Error description..... | 112 | +| 10.1.12.2 | Operations gsmSCF $\textcircled{/}$ gsmSSF..... | 112 | +| 10.1.12.3 | Operations gsmSSF $\textcircled{/}$ gsmSCF..... | 112 | +| 10.1.12.4 | Operations gsmSCF $\textcircled{/}$ gsmSRF (applicable for direct gsmSCF-gsmSRF case only)..... | 112 | +| 10.1.12.5 | Operations gsmSRF $\textcircled{/}$ gsmSCF..... | 112 | +| 10.1.12.6 | Operations smsSSF $\textcircled{/}$ gsmSCF..... | 113 | +| 10.1.12.7 | Operations gsmSCF $\textcircled{/}$ smsSSF..... | 113 | +| 10.1.12.8 | Operations gprsSSF $\textcircled{/}$ gsmSCF..... | 113 | +| 10.1.12.9 | Operations gsmSCF $\textcircled{/}$ gprsSSF..... | 113 | +| 10.1.13 | UnexpectedDataValue..... | 113 | +| 10.1.13.1 | General description..... | 113 | +| 10.1.13.1.1 | Error description..... | 113 | +| 10.1.13.2 | Operations gsmSCF $\textcircled{/}$ gsmSSF..... | 113 | +| 10.1.13.3 | Operations gsmSSF $\textcircled{/}$ gsmSCF..... | 113 | +| 10.1.13.4 | Operations gsmSCF $\textcircled{/}$ gsmSRF..... | 113 | +| 10.1.13.5 | Operations gsmSRF $\textcircled{/}$ gsmSCF..... | 113 | +| 10.1.13.6 | Operations smsSSF $\textcircled{/}$ gsmSCF..... | 114 | +| 10.1.13.7 | Operations gsmSCF $\textcircled{/}$ smsSSF..... | 114 | +| 10.1.13.8 | Operations gprsSSF $\textcircled{/}$ gsmSCF..... | 114 | +| 10.1.13.9 | Operations gsmSCF $\textcircled{/}$ gprsSSF..... | 114 | +| 10.1.14 | UnexpectedParameter..... | 114 | +| 10.1.14.1 | General description..... | 114 | +| 10.1.14.1.1 | Error description..... | 114 | +| 10.1.14.2 | Operations gsmSCF $\textcircled{/}$ gsmSSF..... | 114 | +| 10.1.14.3 | Operations gsmSSF $\textcircled{/}$ gsmSCF..... | 114 | +| 10.1.14.4 | Operations gsmSCF $\textcircled{/}$ gsmSRF..... | 114 | +| 10.1.14.5 | Operations gsmSRF $\textcircled{/}$ gsmSCF..... | 114 | +| 10.1.14.6 | Operations smsSSF $\textcircled{/}$ gsmSCF..... | 114 | +| 10.1.14.7 | Operations gsmSCF $\textcircled{/}$ smsSSF..... | 114 | +| 10.1.14.8 | Operations gprsSSF $\textcircled{/}$ gsmSCF..... | 114 | +| 10.1.14.9 | Operations gsmSCF $\textcircled{/}$ gprsSSF..... | 115 | + +| | | | +|-------------|----------------------------------------------------------------------|-----| +| 10.1.15 | UnknownLegID..... | 115 | +| 10.1.15.1 | General description..... | 115 | +| 10.1.15.1.1 | Error description..... | 115 | +| 10.1.15.2 | Operations gsmSCF ⌂ gsmSSF..... | 115 | +| 10.1.16 | UnknownCSID..... | 115 | +| 10.1.16.1 | General description..... | 115 | +| 10.1.16.1.1 | Error description..... | 115 | +| 10.1.16.2 | Operations gsmSCF ⌂ gsmSSF..... | 115 | +| 10.1.17 | UnknownPDPID..... | 115 | +| 10.1.17.1 | General description..... | 115 | +| 10.1.17.1.1 | Error description..... | 115 | +| 10.1.17.2 | Operations gprsSSF ⌂ gsmSCF..... | 115 | +| 10.1.17.3 | Operations gsmSCF ⌂ gprsSSF..... | 115 | +| 10.2 | Entity related error procedures..... | 115 | +| 10.2.1 | Expiration of Tssf..... | 116 | +| 10.2.1.1 | General description..... | 116 | +| 10.2.1.1.1 | Error description..... | 116 | +| 10.2.1.2 | Procedures gsmSSF ⌂ gsmSCF..... | 116 | +| 10.2.1.3 | Procedures gprsSSF ⌂ gsmSCF..... | 116 | +| 10.2.1.4 | Procedures smsSSF ⌂ gsmSCF..... | 116 | +| 10.2.2 | Expiration of Tsrf..... | 117 | +| 10.2.2.1 | General Description..... | 117 | +| 10.2.2.1.1 | Error description..... | 117 | +| 10.2.2.2 | Procedures description..... | 117 | +| 11 | Detailed operation procedures for circuit switched call control..... | 117 | +| 11.1 | ActivityTest procedure..... | 117 | +| 11.1.1 | General description..... | 117 | +| 11.1.1.1 | Parameters..... | 117 | +| 11.1.2 | Responding entity (gsmSSF, gsmSRF or assist gsmSSF)..... | 117 | +| 11.1.2.1 | Normal procedure..... | 117 | +| 11.1.2.2 | Error handling..... | 118 | +| 11.2 | ApplyCharging procedure..... | 118 | +| 11.2.1 | General description..... | 118 | +| 11.2.1.1 | Parameters..... | 118 | +| 11.2.2 | Responding entity (gsmSSF)..... | 119 | +| 11.2.2.1 | Normal procedure..... | 119 | +| 11.2.2.2 | Error handling..... | 120 | +| 11.3 | ApplyChargingReport procedure..... | 120 | +| 11.3.1 | General description..... | 120 | +| 11.3.1.1 | Parameters..... | 121 | +| 11.3.2 | Invoking entity (gsmSSF)..... | 122 | +| 11.3.2.1 | Normal procedure..... | 122 | +| 11.3.2.2 | Error handling..... | 122 | +| 11.4 | AssistRequestInstructions procedure..... | 122 | +| 11.4.1 | General description..... | 122 | +| 11.4.1.1 | Parameters..... | 122 | +| 11.4.2 | Invoking entity (gsmSSF/gsmSRF)..... | 123 | +| 11.4.2.1 | Normal procedure..... | 123 | +| 11.4.2.2 | Error handling..... | 123 | +| 11.5 | CallGap procedure..... | 123 | +| 11.5.1 | General description..... | 123 | +| 11.5.1.1 | Parameters..... | 123 | +| 11.5.2 | Responding entity (gsmSSF)..... | 125 | +| 11.5.2.1 | Normal procedure..... | 125 | +| 11.5.2.2 | Error handling..... | 127 | +| 11.6 | CallInformationReport procedure..... | 127 | +| 11.6.1 | General description..... | 127 | +| 11.6.1.1 | Parameters..... | 127 | +| 11.6.2 | Invoking entity (gsmSSF)..... | 127 | + +| | | | +|-----------|--------------------------------------------------------|-----| +| 11.6.2.1 | Normal procedure..... | 127 | +| 11.6.2.2 | Error handling..... | 128 | +| 11.7 | CallInformationRequest procedure..... | 128 | +| 11.7.1 | General description..... | 128 | +| 11.7.1.1 | Parameters..... | 128 | +| 11.7.2 | Responding entity (gsmSSF)..... | 128 | +| 11.7.2.1 | Normal procedure..... | 128 | +| 11.7.2.2 | Error handling..... | 129 | +| 11.8 | Cancel procedure..... | 129 | +| 11.8.1 | General description..... | 129 | +| 11.8.1.1 | Parameters..... | 129 | +| 11.8.2 | Responding entity (gsmSRF)..... | 129 | +| 11.8.2.1 | Normal procedure..... | 129 | +| 11.8.2.2 | Error handling..... | 130 | +| 11.8.3 | Responding entity (gsmSSF)..... | 130 | +| 11.8.3.1 | Normal procedure..... | 130 | +| 11.8.3.2 | Error handling..... | 130 | +| 11.8A | CollectInformation Procedure..... | 130 | +| 11.8A.1 | General description..... | 130 | +| 11.8A.1.1 | Parameters..... | 130 | +| 11.8A.2 | Responding entity (gsmSSF)..... | 130 | +| 11.8A.2.1 | Normal procedure..... | 130 | +| 11.8A.2.2 | Error handling..... | 131 | +| 11.9 | Connect procedure..... | 131 | +| 11.9.1 | General description..... | 131 | +| 11.9.1.1 | Parameters..... | 131 | +| 11.9.2 | Responding entity (gsmSSF)..... | 132 | +| 11.9.2.1 | Normal procedure..... | 132 | +| 11.9.2.2 | Error handling..... | 133 | +| 11.10 | ConnectToResource procedure..... | 133 | +| 11.10.1 | General description..... | 133 | +| 11.10.1.1 | Parameters..... | 133 | +| 11.10.2 | Responding entity (gsmSSF)..... | 133 | +| 11.10.2.1 | Normal procedure..... | 133 | +| 11.10.2.2 | Error handling..... | 134 | +| 11.11 | Continue procedure..... | 134 | +| 11.11.1 | General description..... | 134 | +| 11.11.1.1 | Parameters..... | 134 | +| 11.11.2 | Responding entity (gsmSSF)..... | 134 | +| 11.11.2.1 | Normal procedure..... | 134 | +| 11.11.2.2 | Error handling..... | 134 | +| 11.12 | ContinueWithArgument Procedure..... | 134 | +| 11.12.1 | General description..... | 134 | +| 11.12.1.1 | Parameters..... | 135 | +| 11.12.2 | Responding entity (gsmSSF)..... | 136 | +| 11.12.2.1 | Normal procedure..... | 136 | +| 11.12.2.2 | Error handling..... | 136 | +| 11.13 | DisconnectForwardConnection procedure..... | 136 | +| 11.13.1 | General Description..... | 136 | +| 11.13.1.1 | Parameters..... | 136 | +| 11.13.2 | Responding entity (gsmSSF)..... | 137 | +| 11.13.2.1 | Normal procedure..... | 137 | +| 11.13.2.2 | Error handling..... | 137 | +| 11.14 | DisconnectForwardConnectionWithArgument procedure..... | 137 | +| 11.14.1 | General Description..... | 137 | +| 11.14.1.1 | Parameters..... | 137 | +| 11.14.2 | Responding entity (gsmSSF)..... | 137 | +| 11.14.2.1 | Normal procedure..... | 137 | +| 11.14.2.2 | Error handling..... | 138 | +| 11.15 | DisconnectLeg procedure..... | 138 | +| 11.15.1 | General Description..... | 138 | + +| | | | +|-------------|---------------------------------------------|-----| +| 11.15.1.1 | Parameters..... | 138 | +| 11.15.2 | Responding entity (gsmSSF)..... | 138 | +| 11.15.2.1 | Normal procedure..... | 138 | +| 11.15.2.2 | Error handling..... | 139 | +| 11.16 | EntityReleased procedure..... | 139 | +| 11.16.1 | General Description..... | 139 | +| 11.16.1.1 | Parameters..... | 139 | +| 11.16.2 | Invoking entity (gsmSSF)..... | 139 | +| 11.16.2.1 | Normal procedure..... | 139 | +| 11.16.2.2 | Error handling..... | 139 | +| 11.17 | EstablishTemporaryConnection procedure..... | 140 | +| 11.17.1 | General Description..... | 140 | +| 11.17.1.1 | Parameters..... | 140 | +| 11.17.2 | Responding entity (gsmSSF)..... | 141 | +| 11.17.2.1 | Normal procedure..... | 141 | +| 11.17.2.2 | Error handling..... | 141 | +| 11.18 | EventReportBCSM procedure..... | 141 | +| 11.18.1 | General description..... | 141 | +| 11.18.1.1 | Parameters..... | 141 | +| 11.18.2 | Invoking entity (gsmSSF)..... | 143 | +| 11.18.2.1 | Normal procedure..... | 143 | +| 11.18.2.2 | Error handling..... | 143 | +| 11.19 | FurnishChargingInformation procedure..... | 144 | +| 11.19.1 | General description..... | 144 | +| 11.19.1.1 | Parameters..... | 144 | +| 11.19.2 | Responding entity (gsmSSF)..... | 144 | +| 11.19.2.1 | Normal procedure..... | 144 | +| 11.19.2.2 | Error handling..... | 145 | +| 11.20 | InitialDP procedure..... | 145 | +| 11.20.1 | General description..... | 145 | +| 11.20.1.1 | Parameters..... | 145 | +| 11.20.2 | Invoking entity (gsmSSF)..... | 148 | +| 11.20.2.1 | Normal procedure..... | 148 | +| 11.20.2.2 | Error handling..... | 149 | +| 11.21 | InitiateCallAttempt procedure..... | 149 | +| 11.21.1 | General Description..... | 149 | +| 11.21.1.1 | Parameters..... | 149 | +| 11.21.1.1.1 | Argument Parameters..... | 149 | +| 11.21.1.1.2 | Result Parameters..... | 149 | +| 11.21.2 | Responding entity (gsmSSF)..... | 150 | +| 11.21.2.1 | Normal procedure..... | 150 | +| 11.21.2.2 | Error handling..... | 150 | +| 11.22 | MoveLeg procedure..... | 150 | +| 11.22.1 | General Description..... | 150 | +| 11.22.1.1 | Parameters..... | 150 | +| 11.22.2 | Responding entity (gsmSSF)..... | 150 | +| 11.22.2.1 | Normal procedure..... | 150 | +| 11.22.2.2 | Error handling..... | 151 | +| 11.23 | PlayAnnouncement procedure..... | 151 | +| 11.23.1 | General description..... | 151 | +| 11.23.1.1 | Parameters..... | 151 | +| 11.23.2 | Responding entity (gsmSRF)..... | 152 | +| 11.23.2.1 | Normal procedure..... | 152 | +| 11.23.2.2 | Error handling..... | 153 | +| 11.24 | PlayTone procedure..... | 153 | +| 11.24.1 | General description..... | 153 | +| 11.24.1.1 | Parameters..... | 153 | +| 11.24.2 | Responding entity (gsmSSF)..... | 153 | +| 11.24.2.1 | Normal procedure..... | 153 | +| 11.24.2.2 | Error handling..... | 154 | +| 11.25 | PromptAndCollectUserInfo procedure..... | 154 | + +| | | | +|-----------|----------------------------------------------------|-----| +| 11.25.1 | General description..... | 154 | +| 11.25.1.1 | Parameters..... | 154 | +| 11.25.2 | Responding entity (gsmSRF)..... | 157 | +| 11.25.2.1 | Normal procedure..... | 157 | +| 11.25.2.2 | Error handling..... | 157 | +| 11.26 | ReleaseCall procedure..... | 158 | +| 11.26.1 | General description..... | 158 | +| 11.26.1.1 | Parameters..... | 158 | +| 11.26.2 | Responding entity (gsmSSF)..... | 158 | +| 11.26.2.1 | Normal procedure..... | 158 | +| 11.26.2.2 | Error handling..... | 158 | +| 11.27 | RequestReportBCSMEVENT procedure..... | 158 | +| 11.27.1 | General description..... | 158 | +| 11.27.1.1 | Parameters..... | 159 | +| 11.27.2 | Responding entity (gsmSSF)..... | 160 | +| 11.27.2.1 | Normal procedure..... | 160 | +| 11.27.2.2 | Error handling..... | 160 | +| 11.28 | ResetTimer procedure..... | 160 | +| 11.28.1 | General description..... | 160 | +| 11.28.1.1 | Parameters..... | 161 | +| 11.28.2 | Responding entity (gsmSSF)..... | 161 | +| 11.28.2.1 | Normal procedure..... | 161 | +| 11.28.2.2 | Error handling..... | 161 | +| 11.29 | SendChargingInformation procedure..... | 161 | +| 11.29.1 | General description..... | 161 | +| 11.29.1.1 | Parameters..... | 161 | +| 11.29.2 | Responding entity (gsmSSF)..... | 162 | +| 11.29.2.1 | Normal procedure..... | 162 | +| 11.29.2.2 | Error handling..... | 163 | +| 11.30 | SpecializedResourceReport procedure..... | 163 | +| 11.30.1 | General description..... | 163 | +| 11.30.1.1 | Parameters..... | 163 | +| 11.30.2 | Invoking entity (gsmSRF)..... | 163 | +| 11.30.2.1 | Normal procedure..... | 163 | +| 11.30.2.2 | Error handling..... | 164 | +| 11.31 | SplitLeg Procedure..... | 164 | +| 11.31.1 | General Description..... | 164 | +| 11.31.1.1 | Parameters..... | 164 | +| 11.31.2 | Responding entity (gsmSSF)..... | 164 | +| 11.31.2.1 | Normal procedure..... | 164 | +| 11.31.2.2 | Error handling..... | 164 | +| 12 | Detailed operation procedures for SMS control..... | 165 | +| 12.1 | ConnectSMS procedure..... | 165 | +| 12.1.1 | General description..... | 165 | +| 12.1.1.1 | Parameters..... | 165 | +| 12.1.2 | Responding entity (smsSSF)..... | 165 | +| 12.1.2.1 | Normal procedure..... | 165 | +| 12.1.2.2 | Error handling..... | 166 | +| 12.2 | ContinueSMS procedure..... | 166 | +| 12.2.1 | General description..... | 166 | +| 12.2.1.1 | Parameters..... | 166 | +| 12.2.2 | Responding entity (smsSSF)..... | 166 | +| 12.2.2.1 | Normal procedure..... | 166 | +| 12.2.2.2 | Error handling..... | 166 | +| 12.3 | EventReportSMS procedure..... | 166 | +| 12.3.1 | General description..... | 166 | +| 12.3.1.1 | Parameters..... | 166 | +| 12.3.2 | Invoking entity (smsSSF)..... | 167 | +| 12.3.2.1 | Normal procedure..... | 167 | +| 12.3.2.2 | Error handling..... | 167 | +| 12.4 | FurnishChargingInformationSMS procedure..... | 167 | + +| | | | +|----------|-----------------------------------------------------|-----| +| 12.4.1 | General description..... | 167 | +| 12.4.1.1 | Parameters..... | 167 | +| 12.4.2 | Responding entity (smsSSF)..... | 168 | +| 12.4.2.1 | Normal procedure..... | 168 | +| 12.4.2.2 | Error handling..... | 168 | +| 12.5 | InitialDPSMS procedure..... | 168 | +| 12.5.1 | General description..... | 168 | +| 12.5.1.1 | Parameters..... | 168 | +| 12.5.2 | Invoking entity (smsSSF)..... | 169 | +| 12.5.2.1 | Normal procedure..... | 169 | +| 12.5.2.2 | Error handling..... | 170 | +| 12.6 | ReleaseSMS procedure..... | 170 | +| 12.6.1 | General description..... | 170 | +| 12.6.1.1 | Parameters..... | 170 | +| 12.6.2 | Responding entity (smsSSF)..... | 170 | +| 12.6.2.1 | Normal procedure..... | 170 | +| 12.6.2.2 | Error handling..... | 170 | +| 12.7 | RequestReportSMSEvent procedure..... | 170 | +| 12.7.1 | General description..... | 170 | +| 12.7.1.1 | Parameters..... | 171 | +| 12.7.2 | Responding entity (smsSSF)..... | 171 | +| 12.7.2.1 | Normal procedure..... | 171 | +| 12.7.2.2 | Error handling..... | 171 | +| 12.8 | ResetTimerSMS procedure..... | 171 | +| 12.8.1 | General description..... | 171 | +| 12.8.1.1 | Parameters..... | 171 | +| 12.8.2 | Responding entity (smsSSF)..... | 172 | +| 12.8.2.1 | Normal procedure..... | 172 | +| 12.8.2.2 | Error handling..... | 172 | +| 13 | Detailed operation procedures for GPRS control..... | 172 | +| 13.1 | ActivityTestGPRS procedure..... | 172 | +| 13.1.1 | General description..... | 172 | +| 13.1.1.1 | Parameters..... | 172 | +| 13.1.2 | Responding entity (gprsSSF)..... | 172 | +| 13.1.2.1 | Normal procedure..... | 172 | +| 13.1.2.2 | Error handling..... | 173 | +| 13.2 | ApplyChargingGPRS procedure..... | 173 | +| 13.2.1 | General description..... | 173 | +| 13.2.1.1 | Parameters..... | 173 | +| 13.2.2 | Responding entity (gprsSSF)..... | 173 | +| 13.2.2.1 | Normal procedure..... | 173 | +| 13.2.2.2 | Error handling..... | 174 | +| 13.3 | ApplyChargingReportGPRS procedure..... | 174 | +| 13.3.1 | General description..... | 174 | +| 13.3.1.1 | Parameters..... | 174 | +| 13.3.2 | Invoking entity (gprsSSF)..... | 176 | +| 13.3.2.1 | Normal procedure..... | 176 | +| 13.3.2.2 | Error handling..... | 176 | +| 13.4 | CancelGPRS procedure..... | 177 | +| 13.4.1 | General description..... | 177 | +| 13.4.1.1 | Parameters..... | 177 | +| 13.4.2 | Responding entity (gprsSSF)..... | 177 | +| 13.4.2.1 | Normal procedure..... | 177 | +| 13.4.2.2 | Error handling..... | 177 | +| 13.5 | ConnectGPRS procedure..... | 177 | +| 13.5.1 | General description..... | 177 | +| 13.5.1.1 | Parameters..... | 177 | +| 13.5.2 | Responding entity (gprsSSF)..... | 178 | +| 13.5.2.1 | Normal procedure..... | 178 | +| 13.5.2.2 | Error handling..... | 178 | +| 13.6 | ContinueGPRS procedure..... | 178 | + +| | | | +|------------|-----------------------------------------------|-----| +| 13.6.1 | General description..... | 178 | +| 13.6.1.1 | Parameters..... | 178 | +| 13.6.2 | Responding entity (gprsSSF)..... | 178 | +| 13.6.2.1 | Normal procedure..... | 178 | +| 13.6.2.2 | Error handling..... | 179 | +| 13.7 | EntityReleasedGPRS procedure..... | 179 | +| 13.7.1 | General description..... | 179 | +| 13.7.1.1 | Parameters..... | 179 | +| 13.7.2 | Invoking entity (gprsSSF)..... | 179 | +| 13.7.2.1 | Normal procedure..... | 179 | +| 13.7.2.2 | Error handling..... | 179 | +| 13.8 | EventReportGPRS procedure..... | 180 | +| 13.8.1 | General description..... | 180 | +| 13.8.1.1 | Parameters..... | 180 | +| 13.8.2 | Invoking entity (gprsSSF)..... | 181 | +| 13.8.2.1 | Normal procedure..... | 181 | +| 13.8.2.2 | Error handling..... | 181 | +| 13.9 | FurnishChargingInformationGPRS procedure..... | 181 | +| 13.9.1 | General description..... | 181 | +| 13.9.1.1 | Parameters..... | 181 | +| 13.9.2 | Responding entity (gprsSSF)..... | 182 | +| 13.9.2.1 | Normal procedure..... | 182 | +| 13.9.2.2 | Error handling..... | 182 | +| 13.10 | InitialDPGPRS procedure..... | 182 | +| 13.10.1 | General description..... | 182 | +| 13.10.1.1 | Parameters..... | 182 | +| 13.10.2 | Invoking entity (gprsSSF)..... | 183 | +| 13.10.2.1 | Normal procedure..... | 183 | +| 13.10.2.2 | Error handling..... | 184 | +| 13.11 | ReleaseGPRS procedure..... | 184 | +| 13.11.1 | General description..... | 184 | +| 13.11.1.1 | Parameters..... | 184 | +| 13.11.2 | Responding entity (gprsSSF)..... | 184 | +| 13.11.2.1 | Normal procedure..... | 184 | +| 13.11.2.2 | Error handling..... | 185 | +| 13.12 | RequestReportGPRSEvent procedure..... | 185 | +| 13.12.1 | General description..... | 185 | +| 13.12.1.1 | Parameters..... | 185 | +| 13.12.2 | Responding entity (gprsSSF)..... | 185 | +| 13.12.2.1 | Normal procedure..... | 185 | +| 13.12.2.2 | Error handling..... | 186 | +| 13.13 | ResetTimerGPRS procedure..... | 186 | +| 13.13.1 | General description..... | 186 | +| 13.13.1.1 | Parameters..... | 186 | +| 13.13.2 | Responding entity (gprsSSF)..... | 186 | +| 13.13.2.1 | Normal procedure..... | 186 | +| 13.13.2.2 | Error handling..... | 186 | +| 13.14 | SendChargingInformationGPRS Procedure..... | 186 | +| 13.14.1 | General description..... | 186 | +| 13.14.1.1 | Parameters..... | 186 | +| 13.14.2 | Responding Entity (gprsSSF)..... | 187 | +| 13.14.2.1 | Normal Procedure..... | 187 | +| 13.14.2.2 | Error handling..... | 187 | +| 14 | Services assumed from lower layers..... | 188 | +| 14.1 | Services assumed from TC..... | 188 | +| 14.1.1 | Common procedures..... | 188 | +| 14.1.1.1 | Normal procedures..... | 188 | +| 14.1.1.2 | Abnormal procedures..... | 189 | +| 14.1.1.3 | Dialogue handling..... | 190 | +| 14.1.1.3.1 | Dialogue establishment..... | 190 | +| 14.1.1.3.2 | Dialogue continuation..... | 191 | + +| | | | +|--------------|-------------------------------------------------|-----| +| 14.1.1.3.3 | Dialogue termination..... | 191 | +| 14.1.1.3.4 | User abort..... | 191 | +| 14.1.1.3.5 | Provider abort..... | 192 | +| 14.1.1.3.6 | Mapping to TC dialogue primitives..... | 192 | +| 14.1.1.3.7 | Default mapping to TC dialogue parameters..... | 193 | +| 14.1.1.4 | Component handling..... | 193 | +| 14.1.1.4.1 | Procedures for CAP Operations..... | 193 | +| 14.1.1.4.2 | Mapping to TC component primitives..... | 195 | +| 14.1.1.4.3 | Default mapping to TC component parameters..... | 196 | +| 14.1.2 | gsmSSF-gsmSCF interfaces..... | 197 | +| 14.1.2.1 | Normal procedures..... | 197 | +| 14.1.2.1.1 | gsmSSF-to-gsmSCF messages..... | 197 | +| 14.1.2.1.2 | gsmSCF-to-gsmSSF messages..... | 198 | +| 14.1.2.1.3 | smsSSF -to-gsmSCF SMS related messages..... | 198 | +| 14.1.2.1.4 | gsmSCF-to-smsSSF SMS related messages..... | 199 | +| 14.1.2.1.5 | Use of dialogue handling services..... | 199 | +| 14.1.2.2 | Abnormal procedures..... | 199 | +| 14.1.2.2.1 | gsmSCF-to-gsmSSF/gsmSRF messages..... | 199 | +| 14.1.2.2.2 | gsmSSF/gsmSRF/ -to-gsmSCF messages..... | 199 | +| 14.1.2.2.3 | gsmSCF-to-smsSSF SMS related messages..... | 200 | +| 14.1.2.2.4 | smsSSF-to-gsmSCF SMS related messages..... | 200 | +| 14.1.2.2.5 | Use of dialogue handling services..... | 200 | +| 14.1.2.3 | Dialogue handling..... | 201 | +| 14.1.2.3.1 | Dialogue establishment..... | 201 | +| 14.1.2.3.2 | Dialogue continuation..... | 201 | +| 14.1.2.3.3 | Dialogue termination..... | 201 | +| 14.1.2.3.4 | User abort..... | 201 | +| 14.1.2.3.5 | Provider abort..... | 201 | +| 14.1.2.3.6 | Mapping to TC dialogue primitives..... | 201 | +| 14.1.2.4 | Component Handling..... | 201 | +| 14.1.2.4.1 | Procedures for CAP Operations..... | 201 | +| 14.1.2.4.2 | Mapping to TC component parameters..... | 201 | +| 14.1.3 | gsmSCF-gsmSRF interface..... | 202 | +| 14.1.3.1 | Normal procedures..... | 202 | +| 14.1.3.1.1 | gsmSCF-to/from-gsmSRF messages..... | 202 | +| 14.1.3.1.2 | Abnormal procedures..... | 202 | +| 14.1.3.1.3 | Dialogue handling..... | 202 | +| 14.1.3.1.3.1 | Dialogue establishment..... | 202 | +| 14.1.3.1.3.2 | Dialogue continuation..... | 202 | +| 14.1.3.1.3.3 | Dialogue termination..... | 202 | +| 14.1.3.1.3.4 | User abort..... | 202 | +| 14.1.3.1.3.5 | Provider abort..... | 202 | +| 14.1.3.1.3.6 | Mapping to TC dialogue primitives..... | 202 | +| 14.1.3.2 | Component handling..... | 203 | +| 14.1.3.2.1 | Procedures for CAP Operations..... | 203 | +| 14.1.3.2.2 | Mapping to TC component parameters..... | 203 | +| 14.1.4 | gprsSSF-gsmSCF interface..... | 203 | +| 14.1.4.1 | Normal procedures..... | 203 | +| 14.1.4.1.1 | TC-dialogues and relationships..... | 203 | +| 14.1.4.1.2 | Use of the GPRS Reference..... | 203 | +| 14.1.4.1.3 | gprsSSF-to-gsmSCF messages..... | 204 | +| 14.1.4.1.4 | gsmSCF-to-gprsSSF messages..... | 205 | +| 14.1.4.2 | Abnormal procedures..... | 205 | +| 14.1.4.2.1 | gsmSCF-to-gprsSSF messages..... | 205 | +| 14.1.4.2.2 | gprsSSF-to-gsmSCF messages..... | 206 | +| 14.1.4.2.3 | Default GPRS Handling..... | 206 | +| 14.2 | Services assumed from SCCP..... | 206 | +| 14.2.1 | Normal procedures..... | 207 | +| 14.2.2 | Service functions from SCCP..... | 207 | +| 14.2.2.1 | SCCP connectionless services..... | 207 | +| 14.2.2.1.1 | Sub-System Number (SSN)..... | 207 | + +| | | | +|------------|----------------------------------------|-----| +| 14.2.2.1.2 | Addressing..... | 207 | +| 14.2.2.1.3 | Sequence control..... | 211 | +| 14.2.2.1.4 | Return on error..... | 211 | +| 14.2.2.1.5 | Segmentation / reassembly..... | 211 | +| 14.2.2.1.6 | Congestion control..... | 211 | +| 14.2.2.2 | SCCP connection oriented services..... | 211 | +| 14.2.2.3 | SCCP management..... | 212 | + +**Annex A (normative): Mapping between CAP and ISUP.....213** + +| | | | +|-------|---------------------------------------------|-----| +| A.1 | InitialDP operation..... | 213 | +| A.1.1 | EventReportBCSM Operation..... | 214 | +| A.2 | ContinueWithArgument operation..... | 214 | +| A.3 | Connect operation..... | 214 | +| A.4 | AssistRequestInstructions operation..... | 217 | +| A.5 | ConnectToResource operation..... | 217 | +| A.6 | EstablishTemporaryConnection operation..... | 218 | +| A.7 | ReleaseCall operation..... | 219 | +| A.8 | InitiateCallAttempt operation..... | 219 | + +**Annex B (normative): Mapping between CAP and MAP and mapping between CAP and SM-CP.....220** + +| | | | +|---------|--------------------------------------|-----| +| B.1 | Mapping between CAP and MAP..... | 220 | +| B.1.1 | MO-SMS..... | 220 | +| B.1.1.1 | ConnectSMS operation..... | 220 | +| B.1.1.2 | EventReportSMS operation..... | 220 | +| B.1.2 | MT-SMS..... | 221 | +| B.1.2.1 | InitialDPSMS operation (MT-SMS)..... | 221 | +| B.1.2.2 | ReleaseSMS operation (MT-SMS)..... | 221 | +| B.2 | Mapping between CAP and SM-CP..... | 221 | +| B.2.1 | MO-SMS..... | 221 | +| B.2.1.1 | InitialDPSMS operation..... | 221 | +| B.2.1.2 | ReleaseSMS operation..... | 222 | +| B.2.2 | MT-SMS..... | 222 | +| B.2.2.1 | ConnectSMS operation..... | 222 | +| B.2.2.2 | EentReportSMS operation..... | 222 | + +**Annex C (informative): Change history.....223** + +--- + +## Foreword + +This Technical Specification (TS) has been produced by the 3rd Generation Partnership Project (3GPP). + +The present document identifies the 3G system specifications for Rel-5. + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# 1 Scope + +The present document specifies the CAMEL Application Part (CAP) supporting the fourth phase of the network feature Customized Applications for Mobile network Enhanced Logic. CAP is based on a sub-set of the ETSI Core INAP CS-2 as specified by ETSI EN 301 140-1 [26]. Descriptions and definitions provided by ETSI EN 301 140-1 [26] are directly referenced by this standard in the case no additions or clarifications are needed for the use in the CAP. + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. +- [1] EN 302 646-1 v7 (3GPP TS 09.12 Phase 2+): "Application of ISDN User Part (ISUP) version 2 for the ISDN-Public Land Mobile Network (PLMN) signalling interface; Part 1: Protocol specification". +- [2] 3GPP TS 22.024: "Description of Charge Advice Information (CAI)". +- [3] 3GPP TS 22.078: "Customised Applications for Mobile network Enhanced Logic (CAMEL); Service description, Stage 1". +- [4] 3GPP TS 22.115: "Service Aspects Charging and Billing". +- [5] 3GPP TS 23.003: "Numbering, addressing and identification". +- [6] 3GPP TS 23.040: "Technical realization of the Short Message Service (SMS); Point-to-Point (PP)". +- [7] 3GPP TS 23.078: " Customised Applications for Mobile network Enhanced Logic (CAMEL) Phase 3 - Stage 2". +- [8] 3GPP TS 23.079: "Support of Optimal Routeing (SOR); Technical realization". +- [9] 3GPP TS 24.008: "Digital cellular telecommunications system (Phase 2+); Mobile radio interface layer 3 specification (3GPP TS 24.008)". +- [10] 3GPP TS 24.011: "Point-to-Point (PP) Short Message Service (SMS); support on mobile radio interface". +- [11] 3GPP TS 29.002: "Digital cellular telecommunications system (Phase 2+); Mobile Application Part (MAP) specification (3GPP TS 29.002)". +- [12] 3GPP TS 29.060: "General Packet Radio Service (GPRS); GPRS Tunnelling Protocol (GTP) across the Gn and Gp Interface". +- [13] 3GPP TS 32.250: "Telecommunication Management; Charging Circuit Switched (CS) domain". +- [14] 3GPP TS 32.251: "Telecommunication Management; Charging Packet Switched (PS) domain". +- [15] 3GPP TS 23.038: "Alphabets and language-specific information". +- [16] 3GPP TS 23.172: "Technical realisation of Circuit Switched (CS) multimedia service UDI/RDI fallback and service modification; Stage 2". +- [17] – [20] (Void) + +- [21] ETSI ES 201 296: "Integrated Services Digital Network (ISDN); Signalling System No.7; ISDN User Part (ISUP); Signalling aspects of charging". +- [22] ETSI ETS 300 287-1: "Integrated Services Digital Network (ISDN); Signalling System No.7; Transaction Capabilities (TC) version 2; Part 1: Protocol specification [ITU-T Recommendations Q.771 to Q.775 (1993), modified]". +- [23] ETSI EN 300 356-1: "Integrated Services Digital Network (ISDN); Signalling System No.7; ISDN User Part (ISUP) version 3 for the international interface; Part 1: Basic services [ITU-T Recommendations Q.761 to Q.764 (1997), modified]". +- [24] ETSI ETS 300 374-1: "Intelligent Network (IN); Intelligent Network Capability Set 1 (CS1); Core Intelligent Network Application Protocol (INAP); Part 1: Protocol specification". +- [25] ETSI EN 300 403-1: "Integrated Services Digital Network (ISDN); Digital Subscriber Signalling System No. one (DSS1) protocol; Signalling network layer for circuit-mode basic call control; Part 1: Protocol specification [ITU-T Recommendation Q.931 (1993), modified]". +- [26] ETSI EN 301 140-5: "Intelligent Network (IN); Intelligent Network Application Protocol (INAP); Capability Set 2 (CS2); Part 1: Protocol Specification". +- [27] – [40] (Void) +- [41] ITU-T Recommendation Q.71: "ISDN circuit mode switched bearer services". +- [42] ITU-T Recommendation Q.713: "Specifications of Signalling System No.7; SCCP formats and codes". +- [43] ITU-T Recommendation Q.714: "Specifications of Signalling System No.7; Signalling Connection Control Part procedures". +- [44] ITU-T Recommendation Q.762: "General function of messages and signals of the ISDN user part of signalling system no.7". +- [45] ITU-T Recommendation Q.763: "Formats and codes of the ISDN user part of Signalling System No.7". +- [46] ITU-T Recommendation Q.773: "Specifications of Signalling System No.7; Transaction capabilities formats and encoding". +- [47] ITU-T Recommendation Q.850: "Usage of cause and location in the digital subscriber signalling system no.1 and the signalling system no.7 ISDN user part". +- [48] ITU-T Recommendation Q.932: "Digital subscriber Signalling System No.1 (DSS 1) - Generic procedures for the control of ISDN supplementary services". +- [49] ITU-T Recommendation Q.1218: "Interface Recommendation for Intelligent Network CS-1". +- [50] ITU-T Recommendation Q.1224: "Distributed functional plane for intelligent network CS2". +- [51] ITU-T Recommendation Q.1228: "Interface ITU-T Recommendation for intelligent network CS2". +- [52] ITU-T Recommendation Q.1400: "Architecture framework for the development of signalling and organization, administration and maintenance protocols using OSI principles". +- [53] ITU-T Recommendation X.680: "Information technology - Abstract Syntax Notation One (ASN.1): Specification of basic notation". +- [54] ITU-T Recommendation X.681: "Information technology – Abstract Syntax Notation One (ASN.1): Information object specification". +- [55] ITU-T Recommendation X.682: "Information technology – Abstract Syntax Notation One (ASN.1): Parameterization of ASN.1 specifications". +- [56] ITU-T Recommendation X.683: "Information technology – Abstract Syntax Notation One (ASN.1): Constraint specification". + +- [57] ITU-T Recommendation X.690: "ASN.1 encoding rules: Specification of Basic Encoding Rules (BER), Canonical Encoding Rules (CER) and Distinguished Encoding Rules (DER)". +- [58] ITU-T Recommendation X.880: "Data networks and open system communication - Open System Interconnection - Service definitions - Remote operations: Concepts, model and notation". +- [59] ITU-T Recommendation X.881: "Data networks and open system communication - Open System Interconnection - Service definitions - Remote operations: OSI Realizations – Remote Operations Service Element (ROSE) service definition". +- [60] ITU-T Recommendation X.882: "Data networks and open system communication - Open System Interconnection - Service definitions - Remote operations: OSI Realizations – Remote Operations Service Element (ROSE) protocol specification". +- [61] – [80] (Void) +- [81] ISO 9545 (1989): "Information technology - Open Systems Interconnection - Application Layer structure". +- [82] – [90] (Void) +- [91] ANSI T1.112-1996: "American National Standards for Telecommunications- Signalling System Number 7 (SS7) - Signalling Connection Control Part (SCCP)". +- [92] ANSI T1.113-1995: "American National Standards for Telecommunications- Signalling System Number 7 (SS7) - ISDN User Part". +- [93] 3GPP TS 23.060: "General Packet Radio Service (GPRS) Description; Stage 2". + +## 2.1 Specifications used for IMPORTS for CAP + +The following table lists the modules from which CAP V4 imports. For each module, the table indicates in which formal specification this module can be found. + +**Table 2-1: Module IMPORTS specifications** + +| Module Name | Specification | Ref | +|---------------------------------------------------------------------------------------------------------------------------------------------------------|----------------|------| +| CS1-DataTypes {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) umts-network(1) modules(3) cs1-datatypes(2) version1(0)} | ETS 300 374-1 | [24] | +| CS2-datatypes {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) umts-network(1) modules(3) in-cs2-datatypes (0) version1(0)} | EN 301 140-1 | [26] | +| MAP-CommonDataTypes {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) gsm-Network(1) modules(3) map-CommonDataTypes(18) version12(12)} | 3GPP TS 29.002 | [11] | +| MAP-MS-DataTypes {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) gsm-Network(1) modules(3) map-MS-DataTypes(11) version12(12)} | 3GPP TS 29.002 | [11] | +| MAP-CH-DataTypes {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) gsm-Network(1) modules(3) map-CH-DataTypes(13) version12(12)} | 3GPP TS 29.002 | [11] | +| MAP-ExtensionDataTypes {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) gsm-Network(1) modules(3) map-ExtensionDataTypes(21) version12(12)} | 3GPP TS 29.002 | [11] | +| TCAPMessages {itu-t recommendation q 773 modules(2) messages(1) version3(3)} | ITU-T Q.773 | [46] | +| Remote-Operations-Information-Objects {joint-iso-itu-t remote-operations(4) informationObjects(5) version1(0)} | ITU-T X.880 | [58] | +| TC-Notation-Extensions {itu-t recommendation q 775 modules(2) notation-extension (4) version1(1)} | ETS 300 287-1 | [22] | + +## 3 Abbreviations + +For the purposes of the present document, the following abbreviations apply: + +| | | +|----|---------------------| +| AC | Application Context | +| AE | Application Entity | + +| | | +|---------|----------------------------------------------------------------------------------| +| AEI | Application Entity Invocation | +| APDU | Application Protocol Data Unit | +| ASE | Application Service Element | +| ASN.1 | Abstract Syntax Notation One | +| BCSM | Basic Call State Model | +| CAP | CAMEL Application Part | +| CCF | Call Control Function | +| CCITT | International Telegraph and Telephone Consultative Committee | +| CPH | Call Party Handling | +| CS1 | Capability Set 1 | +| CS2 | Capability Set 2 | +| CS | Call Segment | +| | Circuit Switched | +| CSA | Call Segment Association | +| CSG | Closed Subscriber Group | +| CSG ID | Closed Subscriber Group Identity | +| CSI | CAMEL Subscription Information | +| CSID | Call Segment (followed by an identification Number e.g. CSID1) | +| DP | Detection Point | +| DSS1 | Digital Subscriber Signalling System No. One | +| EDP | Event Detection Point | +| EDP-N | Event Detection Point - Notification | +| EDP-R | Event Detection Point - Request | +| EDS | Enhanced Dialled Services | +| FE | Functional Entity | +| FEAM | Functional Entity Access Manager | +| ffs | for further study | +| FSM | Finite State Model | +| gprsSSF | GPRS Service Switching Function | +| gsmSCF | GSM Service Control Function | +| gsmSRF | GSM Specialized Resource Function | +| gsmSSF | GSM Service Switching Function | +| GT | Global Title | +| ID | Identifier | +| IN | Intelligent Network | +| INAP | Intelligent Network Application Protocol | +| IP | Intelligent Peripheral | +| ISDN | Integrated Services Digital Network | +| ISUP | ISDN User Part | +| ITU-T | International Telecommunication Union – Telecommunication Standardization Sector | +| LE | Local Exchange | +| MACF | Multiple Association Control Function | +| MO | Mobile Originated | +| MS | Mobile Station | +| MSC | Mobile services Switching Centre | +| MT | Mobile Terminated | +| MTP | Message Transfer Part | +| NA | North American | +| O-BCSM | Originating BCSM | +| PDU | Protocol Data Unit | +| PE | Physical Entity | +| PIA | Point In Association | +| PIC | Point In Call | +| PLMN | Public Land Mobile Network | +| PSTN | Public Switched Telecommunication Network | +| ROS | Remote Operations Service | +| ROSE | ROS Element | +| SACF | Single Association Control Function | +| SAO | Single Association Object | +| SCCP | Signalling Connection Control Part | +| SCP | Service Control Point | + +| | | +|--------|--------------------------------------------------| +| SDL | System Description Language | +| SL | Service Logic | +| SLP | Service Logic Program | +| SLPI | Service Logic Program Instance | +| SM | Short Message | +| SM-CP | Short Message Control Protocol | +| SMS | Short Message Service | +| SMSC | Short Message Service Centre | +| smsSSF | Short Message Service Service Switching Function | +| SMF | Service Management Function | +| SRME | gsmSRF Management Entity | +| SRSM | gsmSRF Call State Model | +| SS7 | Signalling System no. 7 | +| smsSSF | SMS Service Switching Function | +| SSME | gsmSSF Management Entity | +| SSN | Sub-System Number | +| SSP | Service Switching Point | +| T-BCSM | Terminating BCSM | +| TC | Transaction Capabilities | +| TCAP | Transaction Capabilities Application Part | +| TDP | Trigger Detection Point | +| TDP-R | Trigger Detection Point - Request | + +--- + +## 4 Interface specification for telecommunication services + +### 4.1 General + +#### 4.1.1 Definition methodology + +The definition of the protocol can be split into three sections: + +- the definition of the Single Association Control Function (SACF)/Multiple Association Control Function (MACF) rules for the protocol; +- the definition of the operations transferred between entities; +- the definition of the actions taken at each entity. + +The SACF/MACF rules are defined in prose. The operation definitions are in Abstract Syntax Notation One (ASN.1). For details on ASN.1 refer to ITU-T Recommendation X.680 [53] and ITU-T Recommendation X.681 [54]. The actions are defined in terms of state transition diagrams. Further guidance on the actions to be performed on receipt of an operation can be gained from the description of the relevant information flow in ITU-T Recommendation Q.1224 [50]. + +The CAMEL Application Part (CAP) is a ROS Element (ROSE) user protocol. Refer to ITU-T Recommendation X.880 [58], ITU-T Recommendation X.881 [59] and ITU-T Recommendation X.882 [60] for Remote Operations. The ROSE protocol is contained within the component sublayer of Transaction Capabilities Application Part (TCAP) (see ETS 300 287-1 [22]) and Digital Subscriber Signalling System No One (DSS1) (see ITU-T Recommendation Q.932 [48]). At present, the ROSE Application Protocol Data Units (APDUs) are conveyed in transaction sublayer messages in Signalling System no. 7 (SS7) and in the EN 300 403-1 [25] REGISTER, FACILITY and call control messages in DSS1. Other supporting protocols may be added at a later date. + +The CAP (as a ROSE user) and the ROSE protocol are specified in ASN.1, as defined in ITU-T Recommendation X.680 [53], ITU-T Recommendation X.681 [54], ITU-T Recommendation X.682 [55] and ITU-T Recommendation X.683 [56]. The encoding of the resulting Protocol Data Units (PDUs) shall be done in accordance with the Basic Encoding Rules as defined in ITU-T Recommendation X.690 [57]. + +### 4.1.2 Example physical scenarios + +The reader is referred to Intelligent Network Capability Set 1 (CS1) Core INAP [24] for details of the example physical scenarios. + +![Diagram of Scenario 1: Direct Path to IP. An SCP box contains an SCF box. The SCF box is connected to an SSP box and an IP box. The SSP box is connected to an SSF box. The SSF box is connected to an SRF box via an ISUP link. The IP box is also connected to the SRF box.](3da1a07cb87051bf616c9876db958cf0_img.jpg) + +``` +graph TD + SCP[SCP] --> SCF[SCF] + SCF --> SSP[SSP] + SCF --> IP[IP] + SSP --> SSF[SSF] + SSF -- ISUP --> SRF[SRF] + IP --> SRF +``` + +Diagram of Scenario 1: Direct Path to IP. An SCP box contains an SCF box. The SCF box is connected to an SSP box and an IP box. The SSP box is connected to an SSF box. The SSF box is connected to an SRF box via an ISUP link. The IP box is also connected to the SRF box. + +Scenario 1, Direct Path to IP (Ref. CS1 cases b) & d)). + +Figure 4-1/1: Scenarios + +![Diagram of Scenario 2: Connection to IP via an assisting SSP. An SCP box contains an SCF box. The SCF box is connected to an Initiating SSP box and an Assisting SSP box. The Initiating SSP box is connected to an SSF box. The SSF box is connected to an SSF relay box via an ISUP link. The SSF relay box is connected to an SRF box via an IP link. The Assisting SSP box contains the SSF relay box and the SRF box.](1a85642ed2356d183ce598f2c8b3ee8b_img.jpg) + +``` +graph TD + SCP[SCP] --> SCF[SCF] + SCF --> InitiatingSSP[Initiating SSP] + SCF --> AssistingSSP[Assisting SSP] + InitiatingSSP --> SSF[SSF] + SSF -- ISUP --> SSF_relay[SSF relay] + SSF_relay -- IP --> SRF[SRF] + subgraph AssistingSSP + SSF_relay + SRF + end +``` + +Diagram of Scenario 2: Connection to IP via an assisting SSP. An SCP box contains an SCF box. The SCF box is connected to an Initiating SSP box and an Assisting SSP box. The Initiating SSP box is connected to an SSF box. The SSF box is connected to an SSF relay box via an ISUP link. The SSF relay box is connected to an SRF box via an IP link. The Assisting SSP box contains the SSF relay box and the SRF box. + +Figure 4-1/2: Scenarios + +![Diagram of Scenario 2a: Connection to IP via an assisting gsmSSF with relay function. An SCP box contains a gsmSCF box. The gsmSCF box is connected to an InitiatingSSP box and an AssistingSSP box. The InitiatingSSP box contains a gsmSSF box and a CCF in MSC box. The gsmSSF box is connected to the AssistingSSP box via an ISUP link. The AssistingSSP box contains a gsmSSF box, a CCF in MSC box, and a gsmSRF box. The gsmSSF box is connected to the gsmSRF box via an internal link.](552ca016af3d6240648ab5a2cad97f60_img.jpg) + +``` +graph TD + SCP[SCP] --> gsmSCF[gsmSCF] + gsmSCF --> InitiatingSSP[InitiatingSSP] + gsmSCF --> AssistingSSP[AssistingSSP] + subgraph InitiatingSSP + gsmSSF1[gsmSSF] + CCF1[CCF in MSC] + end + subgraph AssistingSSP + gsmSSF2[gsmSSF] + CCF2[CCF in MSC] + gsmSRF[gsmSRF] + end + gsmSSF1 -- ISUP --> gsmSSF2 + gsmSSF2 -- internal --> gsmSRF +``` + +Diagram of Scenario 2a: Connection to IP via an assisting gsmSSF with relay function. An SCP box contains a gsmSCF box. The gsmSCF box is connected to an InitiatingSSP box and an AssistingSSP box. The InitiatingSSP box contains a gsmSSF box and a CCF in MSC box. The gsmSSF box is connected to the AssistingSSP box via an ISUP link. The AssistingSSP box contains a gsmSSF box, a CCF in MSC box, and a gsmSRF box. The gsmSSF box is connected to the gsmSRF box via an internal link. + +Scenario 2a, Connection to IP via an assisting gsmSSF with relay function; IP co-located with assisting gsmSSF (Ref. CS1 case c)). + +Figure 4-1/3: Scenarios + +![Diagram of Figure 4-1/4: Scenarios. It shows an SCP box containing an SCF box. Below it, an Initiating SSP box contains an SSF box, and an Assisting SSP box contains an SSF relay box. These two are connected by a line labeled ISUP. The SSF relay box is connected to an IP box containing an SRF box.](79e1709a7317ead45379cbb8ff3ba802_img.jpg) + +Diagram of Figure 4-1/4: Scenarios. It shows an SCP box containing an SCF box. Below it, an Initiating SSP box contains an SSF box, and an Assisting SSP box contains an SSF relay box. These two are connected by a line labeled ISUP. The SSF relay box is connected to an IP box containing an SRF box. + +Figure 4-1/4: Scenarios + +![Diagram of Figure 4-1/5: Scenarios. It shows an SCP box containing a gsmSCF box. Below it, an Initiating SSP box contains a gsmSSF box and a CCF in MSC box. An Assisting SSP box contains a gsmSSF box and a CCF in MSC box. These two are connected by a line labeled ISUP. The Assisting SSP box is connected to an IP box containing a gsmSRF box via lines labeled ISUP and DSSI.](a24e89a6fe9bb70c83f8bf5202baba95_img.jpg) + +Diagram of Figure 4-1/5: Scenarios. It shows an SCP box containing a gsmSCF box. Below it, an Initiating SSP box contains a gsmSSF box and a CCF in MSC box. An Assisting SSP box contains a gsmSSF box and a CCF in MSC box. These two are connected by a line labeled ISUP. The Assisting SSP box is connected to an IP box containing a gsmSRF box via lines labeled ISUP and DSSI. + +Figure 4-1/5: Scenarios + +Scenario 2b: Connection to IP via an assisting gsmSSF with relay function; IP not co-located with ssisting gsmSSF (Ref CS1 case c)). + +![Diagram of Figure 4-1/6: Scenarios. It shows an SCP box containing an SCF box. Below it, an SSP box contains an SSF relay box. The SCF box is connected to the SSF relay box. The SSF relay box is connected to an IP box containing an SRF box.](75e4b78ee25f885d73120e3066a5253e_img.jpg) + +Diagram of Figure 4-1/6: Scenarios. It shows an SCP box containing an SCF box. Below it, an SSP box contains an SSF relay box. The SCF box is connected to the SSF relay box. The SSF relay box is connected to an IP box containing an SRF box. + +Figure 4-1/6: Scenarios + +![Diagram of Figure 4-7: Scenarios. It shows an SCP box containing a gsmSCF oval. Below it is an SSP box (dashed border) containing a gsmSSF oval, a CCF in MSC oval, and a gsmSRF oval. Lines connect gsmSCF to gsmSSF, gsmSSF to CCF in MSC, and CCF in MSC to gsmSRF. The connection between CCF in MSC and gsmSRF is labeled 'internal'.](e180f2b5fcbe8001554a7c0677cd3f82_img.jpg) + +Diagram of Figure 4-7: Scenarios. It shows an SCP box containing a gsmSCF oval. Below it is an SSP box (dashed border) containing a gsmSSF oval, a CCF in MSC oval, and a gsmSRF oval. Lines connect gsmSCF to gsmSSF, gsmSSF to CCF in MSC, and CCF in MSC to gsmSRF. The connection between CCF in MSC and gsmSRF is labeled 'internal'. + +Scenario 3, Connection to IP with relay function; IP co-located with gsmSSF (Ref CS1 case a)). + +Figure 4-7: Scenarios + +![Diagram of Figure 4-1/8: Scenarios. It shows an Initiating SSP box connected to an SSF Relay box. The SSF Relay box is connected to an SRF box via a line labeled 'ISUP or D channel'. Above the SSF Relay box is an SCF box. The SRF box is connected to an IP box.](5793a44ffdadd039928e2f9fe6daae06_img.jpg) + +Diagram of Figure 4-1/8: Scenarios. It shows an Initiating SSP box connected to an SSF Relay box. The SSF Relay box is connected to an SRF box via a line labeled 'ISUP or D channel'. Above the SSF Relay box is an SCF box. The SRF box is connected to an IP box. + +Figure 4-1/8: Scenarios + +![Diagram of Figure 4-1/9: Scenarios. It shows an SCP box containing a gsmSCF oval. Below it is an SSP box containing a gsmSSF oval and a CCF in MSC oval. A line connects gsmSCF to gsmSSF. The SSP box is connected to an IP box containing a gsmSRF oval via two lines labeled 'ISUP' and 'DSSI'.](b2ea162a0f53d5e0504b7d28346e0754_img.jpg) + +Diagram of Figure 4-1/9: Scenarios. It shows an SCP box containing a gsmSCF oval. Below it is an SSP box containing a gsmSSF oval and a CCF in MSC oval. A line connects gsmSCF to gsmSSF. The SSP box is connected to an IP box containing a gsmSRF oval via two lines labeled 'ISUP' and 'DSSI'. + +Scenario 4, Connection to IP with relay function; IP not co-located with gsmSSF (Ref CS1 case a)). + +Figure 4-1/9: Scenarios + +![Diagram of Figure 4-1/10: Scenarios. It shows an SCP box containing an SCF box. Below it, an SGSN box contains an SSF box. To the right, a GGSN box is shown. A line connects the SCF in the SCP to the SSF in the SGSN. Another line connects the SSF in the SGSN to the GGSN, with a 'GTP' label above it. There is also a label 'SGSN' above the SGSN box and a small empty box above the GGSN box.](eb03559a4d92ea9ebd63ea9be663c50a_img.jpg) + +Diagram of Figure 4-1/10: Scenarios. It shows an SCP box containing an SCF box. Below it, an SGSN box contains an SSF box. To the right, a GGSN box is shown. A line connects the SCF in the SCP to the SSF in the SGSN. Another line connects the SSF in the SGSN to the GGSN, with a 'GTP' label above it. There is also a label 'SGSN' above the SGSN box and a small empty box above the GGSN box. + +Figure 4-1/10: Scenarios + +![Diagram of Figure 4-1/11: Scenarios. It shows an SCP box containing a gsmSCF box. Below it, an SGSN box contains a gprsSSF box. To the right, a GGSN box is shown. A line connects the gsmSCF in the SCP to the gprsSSF in the SGSN. Another line connects the gprsSSF in the SGSN to the GGSN, with a 'GTP' label above it. There is also a label 'SGSN' above the SGSN box and a small empty box above the GGSN box.](d9c0a780cd22626253dab4aa41699e2f_img.jpg) + +Diagram of Figure 4-1/11: Scenarios. It shows an SCP box containing a gsmSCF box. Below it, an SGSN box contains a gprsSSF box. To the right, a GGSN box is shown. A line connects the gsmSCF in the SCP to the gprsSSF in the SGSN. Another line connects the gprsSSF in the SGSN to the GGSN, with a 'GTP' label above it. There is also a label 'SGSN' above the SGSN box and a small empty box above the GGSN box. + +Scenario 5, GPRS interworking. No connection to IP. + +Figure 4-1/11: Scenarios + +The following table summarises the scenarios and corresponding interface connections that shall be supported by the CAP protocol. The following terms used in the table are defined as follows: + +- Basic: Fully defined in CAP and may be used between any two network operators supporting CAP. +- Bilateral: Additional clarifications of CAP capabilities between network operators and/or equipment vendors are necessary in order for CAP to be used between any two network operators supporting CAP. +- Direct: This refers to the case where CAP Operations are exchanged between the gsmSRF and the gsmSCF via a transaction-level relationship established directly between the gsmSRF and the gsmSCF. +- Relay: This refers to the case where CAP Operations are exchanged between the gsmSRF and the gsmSCF via two transaction-layer relationships. These relationships are: + - a) - gsmSCF to/from gsmSSF; + - b) - gsmSSF to/from gsmSRF. + +The gsmSSF sends operations it receives from the gsmSCF to the gsmSRF, and operations it receives from the gsmSRF to the gsmSCF. This is done without unpacking (and thus processing) of the relayed operations. + +The gsmSSF function referred to in the table is always located in an MSC or GMSC. + +The gprsSSF function referred to in the table is always located in an SGSN. + +Table 4-1 + +| Scenario | Interface Support | | | | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------|-----------------------|---------------------------------|------------------------------------------------------------------------------------------|---------------------------------| +| | GsmSSF to/from gsmSCF | gsmSSF to/from gsmSRF | gsmSSF to/from assisting gsmSSF | gsmSRF to/from gsmSCF | assisting gsmSSF to/from gsmSCF | +| Scenario 1

gsmSRF in IP connected to gsmSSF in MSC or GMSC via ISUP and accessed by gsmSCF through direct Signalling System No.7 Connection | See Note 1 | See Note 2 | - | See Notes 3 and 6.

For gsmSRF in VPLMN see Note 4; For gsmSRF in HPLMN see note 5 | - | +| Scenario 2a

assisting gsmSSF in MSC or GMSC connected to gsmSSF in MSC or GMSC via ISUP. Assisting gsmSSF is accessed by gsmSCF through direct Signalling System No.7 Connection.

gsmSRF is co-located with assisting gsmSSF and accessed (by gsmSCF) by relay via assisting gsmSSF over an internal nodal interface | See Note 1
For gsmSRF in VPLMN see Notes 4 and 6; For gsmSRF in HPLMN see note 5 and 6 | - | See Note 2 | - | See Note 3 | +| Scenario 2b

assisting gsmSSF in MSC or GMSC connected to gsmSSF in MSC or GMSC via ISUP. Assisting gsmSSF is accessed by gsmSCF through direct Signalling System No.7 Connection

gsmSRF is in IP connected to assisting gsmSSF and accessed (by gsmSCF) by relay through ISUP or DSS1 via assisting gsmSSF | See Note 1

See Notes 4 and 6 | See Notes 4 and 6 | See Note 2 | - | See Note 3 | +| Scenario 3

gsmSRF is co-located with a gsmSSF in an MSC or GMSC and accessed by relay via gsmSSF over an internal nodal interface | For gsmSRF in VPLMN see Notes 4; For gsmSRF in HPLMN see notes 5 and 6 | - | - | - | - | +| Scenario 4

gsmSRF in IP connected to gsmSSF and accessed by gsmSCF by relay through ISUP or DSS1 via gsmSSF | See Notes 4 and 6 | See Notes 4 and 6 | - | - | - | + +NOTE 1: Basic for establishment of interface when CorrelationID and SCFiD are transferred in the AssistingSSPIPRoutingAddress. Bilateral when CorrelationID and SCFiD are transferred by other means than in the AssistingSSPIPRoutingAddress. + +NOTE 2: Basic for establishment of interface when CorrelationID and SCFiD are transferred in the Called Party Number. Bilateral when CorrelationID and SCFiD are transferred by other means than in the Called Party Number. + +NOTE 3: Basic when the full Called Party Number received in VPLMN or HPLMN is transferred on its own in the AssistRequestInstructions operation CorrelationID parameter to a gsmSCF in HPLMN. + +Bilateral when CorrelationID is extracted from Called Party Number in HPLMN or VPLMN and transferred on its own in AssistRequestInstructions CorrelationID field to a gsmSCF in HPLMN. + +NOTE 4: Bilateral for the playing of announcements via elementaryMessageIDs and variableMessages, playing of tones and the collection of DTMF digits. + +NOTE 5: Basic for the playing of announcements via elementaryMessageIDs and variableMessages, playing of tones and the collection of DTMF digits. + +NOTE 6: Bilateral for the playing of announcements via text to speech translation, translation of DTMF digits via speech to caller and the translation of voice to digits. + +#### 4.1.3 CAP protocol architecture + +Many of the terms used in the present subclause are based on the OSI application layer structure as defined in ISO 9545 (1989) [81]. + +The CAP protocol architecture is illustrated in figure 4-2. + +A Physical Entity (PE) has either single interactions (case a) or multiple co-ordinated interactions (case b) with another PE. + +In case (a), SACF provides a co-ordination function in using Application Service Elements (ASEs), which includes the ordering of operations supported by ASE(s), in the order of received primitives. The Single Association Object (SAO) represents the SACF plus a set of ASEs to be used over a single interaction between a pair of PEs. + +In case (b), MACF provides a co-ordinating function among several SAO's, each of which interacts with an SAO in a remote PE. + +Each ASE supports one or more operations. Description of each operation is tied with the action of corresponding Functional Entity (FE) modelling. For FE modelling, refer to ITU-T Recommendation Q.1224 [50] and clause 11 of the present document. Each operation is specified using the OPERATION macro described in figure 4-3. + +![Diagram illustrating the CAP protocol architecture for two cases: Multiple coordinated interactions (case b) and Single interaction (case a).](f7d969388c4f7e30cd04a061314bfa0e_img.jpg) + +The diagram illustrates the CAP protocol architecture for two cases: + +- Multiple coordinated interactions case b:** + - An **Application process** is connected to a **MACF** block. + - The **MACF** block is connected to two **SAO** (Single Association Object) blocks. + - Each **SAO** block contains a table with two columns: **S A C F** and **A S E's**. The **A S E's** column is further divided into **TCAP**. + - Both **SAO** blocks are connected to a common **SCCP** block. + - The **SCCP** block is connected to an **MTP** block. +- Single interaction case a:** + - An **Application process** is connected to a **SAO** block. + - The **SAO** block contains a table with two columns: **S A C F** and **A S E's**. The **A S E's** column is further divided into **TCAP**. + - The **SAO** block is connected to a common **SCCP** block. + - The **SCCP** block is connected to an **MTP** block. + +Diagram illustrating the CAP protocol architecture for two cases: Multiple coordinated interactions (case b) and Single interaction (case a). + +NOTE: CAP is the collection of all specifications in ASEs. + +**Figure 4-2: CAP protocol architecture** + +![Diagram of Operation description showing INAP User ASEs and TCAP ASE layers and their interactions.](90ddb84c323b956e2d50a54d3f870566_img.jpg) + +The diagram illustrates the operation description for CAP, showing the interaction between INAP User ASEs and TCAP ASE. + +**INAP User ASEs** (top box) contains the following elements: + +- xyz OPERATION +- ARGUMENT {Parameter1, Parameter2,...} +- RESULT {Parameter1, Parameter2,...} +- LINKED {operation3, operation4,...} +- ERRORS {error1, error2....} +- error1 ERROR +- PARAMETER {Parameter6, Parameter7,...} +- etc + +An arrow labeled "to peer" points from the INAP User ASEs box to a list of elements: **Operations**, **Results**, and **Errors**. + +**TCAP ASE** (bottom box) contains two sub-layers: + +- COMPONENT SUB-LAYER** +- TRANSACTION SUB-LAYER** + +Arrows labeled "to peer" point from each sub-layer to a list of elements: + +- From **COMPONENT SUB-LAYER**: **INVOKE**, **RETURN RESULT**, **RETURN ERROR**, **REJECT** +- From **TRANSACTION SUB-LAYER**: **BEGIN**, **CONTINUE**, **END**, **ABORT**, **UNIDIRECTIONAL** + +A double-headed arrow points from the **TCAP ASE** box down to **CONNECTIONLESS SCCP**. + +Diagram of Operation description showing INAP User ASEs and TCAP ASE layers and their interactions. + +**Figure 4-3: Operation description** + +#### 4.1.4 Compatibility mechanisms used for CAP + +##### 4.1.4.1 Introduction + +The present subclause specifies the compatibility mechanisms that shall be used for CAP. + +Two major categories of compatibility are handled by these mechanisms: + +- compatibility with the ITU-T Recommendation Q.1228 [51] version of CS2 INAP and the specification EN 301 140-1 version of CS2 INAP [26]; +- compatibility with future versions of CAP. + +The second category has three subcategories of compatibility dealt with within the present subclause: + +- **Minor changes to CAP in future versions of CAP:** +A minor change can be defined as a change of a functionality which is not essential for the requested IN service. Where it is a modification of an existing function, it is acceptable that the addressed function is executed in either the older or the modified variant. If the change is purely additional, then it is acceptable that it is not executed at all and that the peer Application Entity (AE) need not know about the effects of the change. For minor changes, a new Application Context is not required. +- **Major changes to CAP in future versions of CAP:** +A major change can be defined as a change of a functionality which is essential for the requested IN service. Where it is a modification of an existing function, both application entities shall have a shared knowledge about the addressed functional variant. If the change is purely additional and one of the application entities does not support the additional functionality, then the requested IN service will not be provided. For major changes, a new Application Context is required. + +- Network-specific changes to CAP: + +These additions may be of either the major or minor type for a service. No new Application Context is expected to be defined for this type of change. At the time of definition of these network-specific changes to CAP, the additions would not be expected to be included in identical form in future versions of CAP. + +#### 4.1.4.2 Definition of CAP compatibility mechanisms + +##### 4.1.4.2.1 Compatibility mechanism for interworking of CAP with ETSI CS2 Core INAP and ITU-T Q.1228 INAP + +On receipt of an operation according to ITU-T Recommendation Q.1228 [51] or an operation according to ETSI EN 301 140-1 [26], which is not part of the CAP or is part of the CAP but which contains parameters which are not part of the CAP: + +- the gsmSSF, gsmSCF, assisting gsmSSF and gsmSRF shall apply the normal error handling for unknown operations or parameters, i.e. the normal error handling procedures as specified in clause 10 shall be followed. + +Tagging of CAP additions to ITU-T Recommendation Q.1228 [51] and ETSI EN 301 140-1 [26] are specified from 50 to 59. + +##### 4.1.4.2.2 Procedures for major additions to CAP + +In order to support the introduction of major functional changes, the protocol allows a synchronisation between the two applications with regard to which functionality is to be performed. This synchronisation takes place before the new function is invoked in either application entity, in order to avoid complicated fall-back procedures. + +##### 4.1.4.2.3 Procedures for minor additions to CAP + +The extension mechanism marker shall be used for future standardised minor additions to CAP. This mechanism implements extensions by including an "extensions marker" in the type definition. The extensions are expressed by optional fields that are placed after the marker. When an entity receives unrecognised parameters that occur after the extension marker, they are ignored. Refer to ITU-T Recommendation X.680 [53] for further details on the extension mechanism. + +##### 4.1.4.2.4 Procedures for inclusion of network specific additions to CAP + +This mechanism is based on the ability to explicitly declare fields of any type via the Macro facility in ASN.1 at the outermost level of a type definition. It works by defining an "ExtensionField" that is placed within the type definition. This extension field is defined as a set of extensions, where an extension can contain any type. Each extension is associated with an identification that unambiguously identifies the extension. Refer to ITU-T Recommendation Q.1400 [52] for a definition of this mechanism. + +#### 4.1.5 Definition and usage of LegID + +##### 4.1.5.1 Definition of LegID + +In CAP V4, two types of LegID may be exchanged between the gsmSCF and the gsmSSF. These are: + +- Sending Side LegID; and +- Receiving Side LegID. + +Sending Side LegID is always used in operations sent from the gsmSCF to the gsmSSF, and Receiving Side LegID is always used in operations sent from the gsmSSF to the gsmSCF. + +##### 4.1.5.2 Allocation of LegID + +For all operations containing a LegID: + +- LegID = 1 shall always refer to the Calling Party, more specifically that party in the call present when InitialDP is sent to the gsmSCF; +- LegID = 2 shall always refer to a Called Party, more specifically a party in the call created as a result of the InitialDP operation, followed by the Connect, Continue or ContinueWithArgument operation. + +- LegID > 2 shall always refer to a Called Party, more specifically a party in the call created as a result of the InitiateCallAttempt operation, followed by the ContinueWithArgument operation. + +## 4.2 SACF/MACF rules + +### 4.2.1 Reflection of TC AC + +TC AC negotiation rules require that the proposed AC, if acceptable, is reflected in the first backwards message. + +NOTE: If the gsmSSF, gprsSSF or smsSSF provides an AC which is not acceptable to the gsmSCF, then an alternate AC shall not be returned. If the AC presented to the gsmSCF is not acceptable, then this is most probably due to an error in subscriber data provisioning or an error at the gsmSSF, gprsSSF or smsSSF. + +### 4.2.2 Sequential/parallel execution of operations + +In some cases it may be necessary to distinguish whether operations should be performed sequentially or in parallel (synchronised). Operations which may be synchronised are: + +- charging operations; may be synchronised with any other operation(s). + +The method of indicating to the receiving entity that operations should be synchronised is to transmit these operations in a single TC message. If one of the operations identified above shall not be executed until the execution of another operation has progressed to a certain extent or has finished, then the sending PE shall control this by sending the operations in two separate TC messages. + +This method does not imply that all operations sent in a single TC message shall be executed simultaneously, but that where it could make sense to do so (in the situations identified above) the operations should be synchronised. + +In the case of inconsistency between the above-mentioned generic rules and the FE-specific rules, as specified in clause 9, the FE-specific rules take precedence over the generic rules. + +## 5 Common CAP Types + +### 5.1 Data types + +``` +CAP-datatypes {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) umts-network(1) +modules(3) cap-datatypes(52) version8(7)} +``` + +``` +DEFINITIONS IMPLICIT TAGS ::= BEGIN +``` + +``` +IMPORTS +``` + +``` +Duration, +Integer4, +Interval, +LegID, +ServiceKey +``` + +``` +FROM CS1-DataTypes {itu-t(0) identified-organization(4) etsi(0) inDomain(1) in-network(1) +modules(0) cs1-datatypes(2) version1(0)} +``` + +``` +BothwayThroughConnectionInd, +CriticalityType, +MiscCallInfo +``` + +``` +FROM CS2-datatypes {itu-t(0) identified-organization(4) etsi(0) inDomain(1) in-network(1) +cs2(20) modules(0) in-cs2-datatypes(0) version1(0)} +``` + +``` +AddressString, +CellGlobalIdOrServiceAreaIdFixedLength, +Ext-BasicServiceCode, +IMSI, +ISDN-AddressString, +LAIFixedLength, +NAEA-CIC +``` + +``` +FROM MAP-CommonDataTypes {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0)} +``` + +``` + +gsm-Network(1) modules(3) map-CommonDataTypes(18) version12(12)} + + Ext-QoS-Subscribed, + Ext2-QoS-Subscribed, + Ext3-QoS-Subscribed, + GeographicalInformation, + GSN-Address, + LocationInformation, + LSAIdentity, + QoS-Subscribed, + RAIdentity, + SubscriberState, + GPRSChargingID +FROM MAP-MS-DataTypes {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) +gsm-Network(1) modules(3) map-MS-DataTypes(11) version12(12)} + + CallReferenceNumber, + SuppressionOfAnnouncement +FROM MAP-CH-DataTypes {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) +gsm-Network(1) modules(3) map-CH-DataTypes(13) version12(12)} + + tc-Messages, + classes +FROM CAP-object-identifiers {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) +umts-network(1) modules(3) cap-object-identifiers(100) version8(7)} + + EXTENSION, + PARAMETERS-BOUND, + SupportedExtensions +FROM CAP-classes classes + + ExtensionContainer +FROM MAP-ExtensionDataTypes {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) +gsm-Network(1) modules(3) map-ExtensionDataTypes(21) version12(12)} + +; + +AccessPointName {PARAMETERS-BOUND : bound} ::= OCTET STRING (SIZE( + bound.&minAccessPointNameLength .. bound.&maxAccessPointNameLength)) +-- Indicates the AccessPointName, refer to 3GPP TS 24.008 [9] for the encoding. +-- It shall be coded as in the value part defined in 3GPP TS 24.008, +-- i.e. the 3GPP TS 24.008 IEI and 3GPP TS 24.008 octet length indicator +-- shall not be included. + +AChBillingChargingCharacteristics {PARAMETERS-BOUND : bound} ::= OCTET STRING (SIZE + (bound.&minAChBillingChargingLength .. bound.&maxAChBillingChargingLength)) + (CONSTRAINED BY {-- shall be the result of the BER-encoded value of the type -- + CAMEL-AChBillingChargingCharacteristics {bound}}) +-- The AChBillingChargingCharacteristics parameter specifies the charging related information +-- to be provided by the gsmSSF and the conditions on which this information has to be reported +-- back to the gsmSCF with the ApplyChargingReport operation. The value of the +-- AChBillingChargingCharacteristics of type OCTET STRING carries a value of the ASN.1 data type: +-- CAMEL-AChBillingChargingCharacteristics. The normal encoding rules are used to encode this +-- value. +-- The violation of the UserDefinedConstraint shall be handled as an ASN.1 syntax error. + +AChChargingAddress {PARAMETERS-BOUND : bound} ::= CHOICE { + legID [2] LegID, + srfConnection [50] CallSegmentID {bound} +} + +AdditionalCallingPartyNumber {PARAMETERS-BOUND : bound} ::= Digits {bound} +-- Indicates the Additional Calling Party Number. + +AlertingPattern ::= OCTET STRING (SIZE(3)) +-- Indicates a specific pattern that is used to alert a subscriber +-- (e.g. distinctive ringing, tones, etc.). + +``` + +- The encoding of the last octet of this parameter is as defined in 3GPP TS 29.002 [11]. +- Only the trailing OCTET is used, the remaining OCTETS shall be sent as NULL (zero) +- The receiving side shall ignore the leading two OCTETS. + +``` +AOCBeforeAnswer ::= SEQUENCE { + aOCInitial [0] CAI-GSM0224, + aOCSubsequent [1] AOCSubsequent OPTIONAL +} +``` + +``` +AOCGPRS ::= SEQUENCE { + aOCInitial [0] CAI-GSM0224, + aOCSubsequent [1] AOCSubsequent OPTIONAL +} +``` + +``` +AOCSubsequent ::= SEQUENCE { + cAI-GSM0224 [0] CAI-GSM0224 , + tariffSwitchInterval [1] INTEGER (1..86400) OPTIONAL +} +``` + +– tariffSwitchInterval is measured in 1 second units + +``` +AppendFreeFormatData ::= ENUMERATED { + overwrite(0), + append (1) +} +``` + +ApplicationTimer ::= INTEGER (0..2047) + +– Used by the gsmSCF to set a timer in the gsmSSF. The timer is in seconds. + +AssistingSSIPRoutingAddress {PARAMETERS-BOUND : bound} ::= Digits {bound} + +– Indicates the destination address of the gsmSRF for the assist procedure. + +``` +AudibleIndicator ::= CHOICE { + tone BOOLEAN, + burstList [1] BurstList +} +``` + +``` +BackwardServiceInteractionInd ::= SEQUENCE { + conferenceTreatmentIndicator [1] OCTET STRING (SIZE(1)) OPTIONAL, + -- acceptConferenceRequest 'xxxx xx01'B + -- rejectConferenceRequest 'xxxx xx10'B + -- if absent from Connect or ContinueWithArgument, + -- then CAMEL service does not affect conference treatment + callCompletionTreatmentIndicator [2] OCTET STRING (SIZE(1)) OPTIONAL, + -- acceptCallCompletionServiceRequest 'xxxx xx01'B, + -- rejectCallCompletionServiceRequest 'xxxx xx10'B + -- if absent from Connect or ContinueWithArgument, + -- then CAMEL service does not affect call completion treatment + ... +} +``` + +``` +BasicGapCriteria {PARAMETERS-BOUND : bound} ::= CHOICE { + calledAddressValue [0] Digits {bound}, + gapOnService [2] GapOnService, + calledAddressAndService [29] SEQUENCE { + calledAddressValue [0] Digits {bound}, + serviceKey [1] ServiceKey, + ... + }, + callingAddressAndService [30] SEQUENCE { + callingAddressValue [0] Digits {bound}, + serviceKey [1] ServiceKey, + ... + } +} +``` + +- Both calledAddressValue and callingAddressValue can be +- incomplete numbers, in the sense that a limited amount of digits can be given. + +- For the handling of numbers starting with the same digit string refer to the detailed procedure of the CallGap operation + +``` +BCSMEvent{PARAMETERS-BOUND : bound} ::= SEQUENCE { + eventTypeBCSM [0] EventTypeBCSM, + monitorMode [1] MonitorMode, + legID [2] LegID OPTIONAL, + dpSpecificCriteria [30] DpSpecificCriteria {bound} OPTIONAL, + automaticRearm [50] NULL OPTIONAL, + ... +} +``` + +- Indicates the BCSM Event information for monitoring. + +``` +BCSM-Failure {PARAMETERS-BOUND : bound} ::= SEQUENCE { + legID [0] LegID OPTIONAL, + cause [2] Cause {bound} OPTIONAL, + ... +} +``` + +``` +BearerCapability {PARAMETERS-BOUND : bound} ::= CHOICE { + bearerCap [0] OCTET STRING (SIZE(2..bound.&maxBearerCapabilityLength)) +} +``` + +- Indicates the type of bearer capability connection to the user. For bearerCap, the ISUP User +- Service Information, ETSI EN 300 356-1 [23] +- encoding shall be used. + +``` +Burst ::= SEQUENCE { + numberOfBursts [0] INTEGER (1..3) DEFAULT 1, + burstInterval [1] INTEGER (1..1200) DEFAULT 2, + numberOfTonesInBurst [2] INTEGER (1..3) DEFAULT 3, + toneDuration [3] INTEGER (1..20) DEFAULT 2, + toneInterval [4] INTEGER (1..20) DEFAULT 2, + ... +} +``` + +- burstInterval, toneDuration and toneInterval are measured in 100 millisecond units + +``` +BurstList ::= SEQUENCE { + warningPeriod [0] INTEGER (1..1200) DEFAULT 30, + bursts [1] Burst, + ... +} +``` + +- warningPeriod is measured in 1 second units. + +``` +CAI-GSM0224 ::= SEQUENCE { + e1 [0] INTEGER (0..8191) OPTIONAL, + e2 [1] INTEGER (0..8191) OPTIONAL, + e3 [2] INTEGER (0..8191) OPTIONAL, + e4 [3] INTEGER (0..8191) OPTIONAL, + e5 [4] INTEGER (0..8191) OPTIONAL, + e6 [5] INTEGER (0..8191) OPTIONAL, + e7 [6] INTEGER (0..8191) OPTIONAL +} +``` + +- Indicates Charge Advice Information to the Mobile Station. For information regarding +- parameter usage, refer to 3GPP TS 22.024 [2]. + +``` +CalledPartyBCDNumber {PARAMETERS-BOUND : bound} ::= OCTET STRING (SIZE( + bound.&minCalledPartyBCDNumberLength .. bound.&maxCalledPartyBCDNumberLength)) +``` + +- Indicates the Called Party Number, including service selection information. +- Refer to 3GPP TS 24.008 [9] for encoding. +- This data type carries only the 'type of number', 'numbering plan +- identification' and 'number digit' fields defined in 3GPP TS 24.008 [9]; +- it does not carry the 'called party BCD number IEI' or 'length of called +- party BCD number contents'. +- In the context of the DestinationSubscriberNumber field in ConnectSMSArg or +- InitialDPSMSArg, a CalledPartyBCDNumber may also contain an alphanumeric +- character string. In this case, type-of-number '101'B is used, in accordance +- with 3GPP TS 23.040 [6]. The address is coded in accordance with the +- GSM 7-bit default alphabet definition and the SMS packing rules + +-- as specified in 3GPP TS 23.038 [15] in this case. + +``` +CalledPartyNumber {PARAMETERS-BOUND : bound} ::= OCTET STRING (SIZE( + bound.&minCalledPartyNumberLength .. bound.&maxCalledPartyNumberLength)) +-- Indicates the Called Party Number. Refer to ETS EN 300 356-1 [23] for encoding. +``` + +-- A CalledPartyNumber may contain national-specific values of the *Nature Of Address indicator*. The filling-in of the national-specific *Nature Of Address indicator* values shall be done in accordance with the national ISUP of the gsmSSF country, e.g. + -- ANSI T1.113-1995 [92]. + -- In terms of ETS EN 300 356-1 [23], the *Destination Address Field* is not present if the *destination address length* is set to zero. This is the case e.g. when the ANSI ISUP *Nature Of Address indicator* indicates *no number present, operator requested* (1110100) or *no number present, cut-through call to carrier* (1110101). + -- See also see 3GPP TS 23.078 [7]. + +``` +CallingPartyNumber {PARAMETERS-BOUND : bound} ::= OCTET STRING (SIZE( + bound.&minCallingPartyNumberLength .. bound.&maxCallingPartyNumberLength)) +-- Indicates the Calling Party Number. Refer to ETS EN 300 356-1 [23] for encoding. +``` + +``` +CallResult {PARAMETERS-BOUND : bound} ::= OCTET STRING (SIZE( + bound.&minCallResultLength .. bound.&maxCallResultLength)) + (CONSTRAINED BY {-- shall be the result of the BER-encoded value of type - + CAMEL-CallResult {bound}}) +-- The violation of the UserDefinedConstraint shall be handled as an ASN.1 syntax error. +``` + +-- This parameter provides the gsmSCF with the charging related information previously requested + -- using the ApplyCharging operation. This shall include the partyToCharge parameter as + -- received in the related ApplyCharging operation to correlate the result to the request + +``` +CallSegmentFailure {PARAMETERS-BOUND : bound} ::= SEQUENCE { + callSegmentID [0] CallSegmentID {bound} OPTIONAL, + cause [2] Cause {bound} OPTIONAL, + ... + } +``` + +CallSegmentID {PARAMETERS-BOUND : bound} ::= INTEGER (1..bound.&numOfCSs) + +``` +CallSegmentToCancel {PARAMETERS-BOUND : bound} ::= SEQUENCE { + invokeID [0] InvokeID OPTIONAL, + callSegmentID [1] CallSegmentID {bound} OPTIONAL, + ... + } +``` + +``` +CAMEL-AChBillingChargingCharacteristics {PARAMETERS-BOUND : bound} ::= CHOICE { + timeDurationCharging [0] SEQUENCE { + maxCallPeriodDuration [0] INTEGER (1..864000), + releaseIfDurationExceeded [1] BOOLEAN DEFAULT FALSE, + tariffSwitchInterval [2] INTEGER (1..86400) OPTIONAL, + audibleIndicator [3] AudibleIndicator DEFAULT tone: FALSE, + extensions [4] Extensions {bound} OPTIONAL, + ... + } + } +``` + +-- tariffSwitchInterval is measured in 1 second units. + -- maxCallPeriodDuration is measured in 100 millisecond units + +``` +CAMEL-CallResult {PARAMETERS-BOUND : bound} ::= CHOICE { + timeDurationChargingResult [0] SEQUENCE { + partyToCharge [0] ReceivingSideID, + timeInformation [1] TimeInformation, + legActive [2] BOOLEAN DEFAULT TRUE, + callLegReleasedAtTcpExpiry [3] NULL OPTIONAL, + extensions [4] Extensions {bound} OPTIONAL, + aChChargingAddress [5] AChChargingAddress {bound} + DEFAULT legID:receivingSideID:leg1, + ... + } + } +``` + +``` +... +} +} +``` + +``` +CAMEL-FCIBillingChargingCharacteristics {PARAMETERS-BOUND : bound} ::= CHOICE{ + fCIBCCCAMELsequence1 [0] SEQUENCE { + freeFormatData [0] OCTET STRING (SIZE( + bound.&minFCIBillingChargingDataLength .. bound.&maxFCIBillingChargingDataLength)), + partyToCharge [1] SendingSideID DEFAULT sendingSideID: leg1, + appendFreeFormatData [2] AppendFreeFormatData DEFAULT overwrite, + } + ... +} +``` + +``` +CAMEL-FCIGPRSBillingChargingCharacteristics {PARAMETERS-BOUND : bound} ::= SEQUENCE{ + fCIBCCCAMELsequence1 [0] SEQUENCE { + freeFormatData [0] OCTET STRING (SIZE( + bound.&minFCIBillingChargingDataLength .. bound.&maxFCIBillingChargingDataLength)), + pDPID [1] PDPID OPTIONAL, + appendFreeFormatData [2] AppendFreeFormatData DEFAULT overwrite, + } + ... +} +``` + +``` +CAMEL-FCISMSBillingChargingCharacteristics {PARAMETERS-BOUND : bound} ::= CHOICE{ + fCIBCCCAMELsequence1 [0] SEQUENCE { + freeFormatData [0] OCTET STRING (SIZE( + bound.&minFCIBillingChargingDataLength .. bound.&maxFCIBillingChargingDataLength)), + appendFreeFormatData [1] AppendFreeFormatData DEFAULT overwrite + } +} +``` + +``` +CAMEL-SCIBillingChargingCharacteristics ::= CHOICE { + aOCBeforeAnswer [0] AOCBeforeAnswer, + aOCAfterAnswer [1] AOCS subsequent, + aOC-extension [2] CAMEL-SCIBillingChargingCharacteristicsAlt +} +``` + +``` +CAMEL-SCIBillingChargingCharacteristicsAlt ::= SEQUENCE { + ... +} +-- This datatype is for extension in future releases. +``` + +``` +CAMEL-SCIGPRSBillingChargingCharacteristics ::= SEQUENCE { + aOCGPRS [0] AOCGPRS, + pDPID [1] PDPID OPTIONAL, + ... +} +``` + +``` +Carrier {PARAMETERS-BOUND : bound} ::= OCTET STRING (SIZE( + bound.&minCarrierLength .. bound.&maxCarrierLength)) +-- This parameter is used for North America (na) only. +-- It contains the carrier selection field (first octet) followed by Carrier ID +-- information (North America (na)). +``` + +``` +-- The Carrier selection is one octet and is encoded as: +-- 00000000 No indication +-- 00000001 Selected carrier identification code (CIC) pre subscribed and not +-- input by calling party +-- 00000010 Selected carrier identification code (CIC) pre subscribed and input by +-- calling party +-- 00000011 Selected carrier identification code (CIC) pre subscribed, no +-- indication of whether input by calling party (undetermined) +-- 00000100 Selected carrier identification code (CIC) not pre subscribed and +-- input by calling party +``` + +- 00000101 +- to Spare +- 11111110 +- 11111111 Reserved + +- Refer to ANSI T1.113-1995 [92] for encoding of na carrier ID information (3 octets). + +Cause {PARAMETERS-BOUND : bound} ::= OCTET STRING (SIZE( + bound.&minCauseLength .. bound.&maxCauseLength)) + +- Indicates the cause for interface related information. +- Refer to ETSI EN 300 356-1 [23] Cause parameter for encoding. +- For the use of cause and location values refer to ITU-T Recommendation Q.850 [47] +- Shall always include the cause value and shall also include the diagnostics field, +- if available. + +CGEncountered ::= ENUMERATED { + noCGencountered (0), + manualCGencountered (1), + scpOverload (2) + } + +- Indicates the type of automatic call gapping encountered, if any. + +ChangeOfPositionControlInfo {PARAMETERS-BOUND : bound} ::= SEQUENCE SIZE + (1..bound.&numOfChangeOfPositionControlInfo) OF ChangeOfLocation {bound} + +ChangeOfLocation {PARAMETERS-BOUND : bound} ::= CHOICE { + cellGlobalId [0] CellGlobalIdOrServiceAreaIdFixedLength, + serviceAreaId [1] CellGlobalIdOrServiceAreaIdFixedLength, + locationAreaId [2] LAIFixedLength, + inter-SystemHandOver [3] NULL, + inter-PLMNHandOver [4] NULL, + inter-MSCHandOver [5] NULL, + changeOfLocationAlt [6] ChangeOfLocationAlt {bound} + } + +- The cellGlobalId shall contain a Cell Global Identification. + +- The serviceAreaId shall contain a Service Area Identification. + +ChangeOfLocationAlt {PARAMETERS-BOUND : bound} ::= SEQUENCE { + ... + } + +ChargeIndicator ::= OCTET STRING (SIZE (1)) + +- As specified in ITU-T Recommendation Q.763 as follows: +- no indication 'xxxx xx00'B +- no charge 'xxxx xx01'B +- charge 'xxxx xx10'B +- spare 'xxxx xx11'B +- Sending entity shall fill the upper six bits with '0's. +- Receiving entity shall ignore the upper six bits. + +ChargeNumber {PARAMETERS-BOUND : bound} ::= LocationNumber {bound} + +- Information sent in either direction indicating the chargeable number for the call and +- consisting of the odd/even indicator, nature of address indicator, numbering plan indicator, +- and address signals. + +- Uses the LocationNumber format which is based on the Location Number format as defined +- in ITU-T Recommendation Q.763 [45]. +- For example, the ChargeNumber may be a third party number to which a call is billed for +- the 3rd party billing service. In this case, the calling party may request operator assistance +- to charge the call to, for example, their home number. + +- For NA, this parameter uniquely identifies the chargeable number for a call sent into a North +- American long distance carrier. It transports the ChargeNumber Parameter Field as defined in +- ANSI T1.113-1995 [92]. This provides +- - 1 octet for the nature of address indicator field, plus + +- - 1 octet for a numbering plan field, plus +- - up to 5 octets for the address signal (up to 10 digits) +- The Charge Number in ANSI T1.113-1995 [92] normally contains a 10 digit national number within +- the North American Numbering Plan (NANP); longer (e.g. international) charge numbers are not +- supported in ANSI T1.113-1995 [92]. + +``` +ChargingCharacteristics ::= CHOICE { + maxTransferredVolume [0] INTEGER (1..4294967295), + maxElapsedTime [1] INTEGER (1..86400) +} +``` + +- maxTransferredVolume is measured in number of bytes +- maxElapsedTime is measured in seconds + +``` +ChargingResult ::= CHOICE { + transferredVolume [0] TransferredVolume, + elapsedTime [1] ElapsedTime +} +``` + +``` +ChargingRollOver ::= CHOICE { + transferredVolumeRollOver [0] TransferredVolumeRollOver, + elapsedTimeRollOver [1] ElapsedTimeRollOver +} +``` + +- *transferredVolumeRollOver* shall be reported if ApplyChargingReportGPRS reports volume and +- a roll-over has occurred in one or more volume counters. Otherwise, it shall be absent. +- *elapsedTimeRollOver* shall be reported if ApplyChargingReportGPRS reports duration and +- a roll-over has occurred in one or more duration counters. Otherwise, it shall be absent. + +``` +CollectedDigits ::= SEQUENCE { + minimumNbOfDigits [0] INTEGER (1..30) DEFAULT 1, + maximumNbOfDigits [1] INTEGER (1..30), + endOfReplyDigit [2] OCTET STRING (SIZE (1..2)) OPTIONAL, + cancelDigit [3] OCTET STRING (SIZE (1..2)) OPTIONAL, + startDigit [4] OCTET STRING (SIZE (1..2)) OPTIONAL, + firstDigitTimeOut [5] INTEGER (1..127) OPTIONAL, + interDigitTimeOut [6] INTEGER (1..127) OPTIONAL, + errorTreatment [7] ErrorTreatment DEFAULT stdErrorAndInfo, + interruptableAnnInd [8] BOOLEAN DEFAULT TRUE, + voiceInformation [9] BOOLEAN DEFAULT FALSE, + voiceBack [10] BOOLEAN DEFAULT FALSE +} +``` + +- The use of voiceBack and the support of voice recognition via voiceInformation +- is network operator specific. +- The endOfReplyDigit, cancelDigit, and startDigit parameters have been +- designated as OCTET STRING, and are to be encoded as BCD, one digit per octet +- only, contained in the four least significant bits of each OCTET. The following encoding shall +- be applied for the non-decimal characters: +- 1011 (\*), 1100 (#). +- The usage is service dependent. +- firstDigitTimeOut and interDigitTimeOut are measured in seconds. + +``` +CollectedInfo ::= CHOICE { + collectedDigits [0] CollectedDigits +} +``` + +``` +ConnectedNumberTreatmentInd ::= ENUMERATED { + noINImpact (0), + presentationRestricted (1), + presentCalledINNumber (2), + presentCallINNumberRestricted (3) +} +``` + +- This parameter is used to suppress or to display the connected number. + +``` +ControlType ::= ENUMERATED { + sCPOverloaded (0), +} +``` + +``` + +manuallyInitiated (1) +} + +``` + +``` + +CompoundCriteria {PARAMETERS-BOUND : bound} ::= SEQUENCE { + basicGapCriteria [0] BasicGapCriteria {bound}, + scfID [1] ScfID {bound} OPTIONAL +} + +``` + +CorrelationID {PARAMETERS-BOUND : bound} ::= Digits {bound} +– used by gsmSCF for correlation with a previous operation. + +DateAndTime ::= OCTET STRING (SIZE(7)) +– DateAndTime is BCD encoded. The year digit indicating millenium occupies bits +– 0-3 of the first octet, and the year digit indicating century occupies bits +– 4-7 of the first octet. +– The year digit indicating decade occupies bits 0-3 of the second octet, +– whilst the digit indicating the year within the decade occupies bits 4-7 of +– the second octet. +– The most significant month digit occupies bits 0-3 of the third octet, +– and the least significant month digit occupies bits 4-7 of the third octet. +– The most significant day digit occupies bits 0-3 of the fourth octet, +– and the least significant day digit occupies bits 4-7 of the fourth octet. +– The most significant hours digit occupies bits 0-3 of the fifth octet, +– and the least significant digit occupies bits 4-7 of the fifth octet. +– The most significant minutes digit occupies bits 0-3 of the sixth octet, +– and the least significant digit occupies bits 4-7 of the sixth octet. +– The most significant seconds digit occupies bits 0-3 of the seventh octet, +– and the least seconds significant digit occupies bits 4-7 of the seventh octet. +– For the encoding of digits in an octet, refer to the timeAndtimezone parameter. + +DestinationRoutingAddress {PARAMETERS-BOUND : bound} ::= SEQUENCE SIZE(1) OF +CalledPartyNumber {bound} +– Indicates the Called Party Number. + +Digits {PARAMETERS-BOUND : bound} ::= OCTET STRING (SIZE( +bound.&minDigitsLength .. bound.&maxDigitsLength)) +– Indicates the address signalling digits. +– Refer to ETSI EN 300 356-1 [23] Generic Number & Generic Digits parameters for encoding. +– The coding of the subfields 'NumberQualifier' in Generic Number and 'TypeOfDigits' in +– Generic Digits are irrelevant to the CAP; +– the ASN.1 tags are sufficient to identify the parameter. +– The ISUP format does not allow to exclude these subfields, +– therefore the value is network operator specific. +– +– The following parameters shall use Generic Number: +– - AdditionalCallingPartyNumber for InitialDP +– - AssistingSSPIPRoutingAddress for EstablishTemporaryConnection +– - CorrelationID for AssistRequestInstructions +– - CalledAddressValue for all occurrences, CallingAddressValue for all occurrences. +– +– The following parameters shall use Generic Digits: +– - CorrelationID in EstablishTemporaryConnection +– - number in VariablePart +– - digitsResponse in ReceivedInformationArg +– - midCallEvents in oMidCallSpecificInfo and tMidCallSpecificInfo +– +– In the digitsResponse and midCalEvents, the digits may also include the '\*', '#', +– a, b, c and d digits by using the IA5 character encoding scheme. If the BCD even or +– BCD odd encoding scheme is used, then the following encoding shall be applied for the +– non-decimal characters: 1011 (\*), 1100 (#). +– +– AssistingSSPIPRoutingAddress in EstablishTemporaryConnection and CorrelationID in +– AssistRequestInstructions may contain a Hex B digit as address signal. Refer to +– Annex A.6 for the usage of the Hex B digit. +– + +- Note that when CorrelationID is transported in Generic Digits, then the digits shall +- always be BCD encoded. + +``` + +DpSpecificCriteria { PARAMETERS-BOUND : bound } ::= CHOICE { + applicationTimer [1] ApplicationTimer, + midCallControlInfo [2] MidCallControlInfo, + dpSpecificCriteriaAlt [3] DpSpecificCriteriaAlt {bound} +} +-- Exception handling: reception of DpSpecificCriteriaAlt shall be treated like +-- reception of no DpSpecificCriteria. +-- The gsmSCF may set a timer in the gsmSSF for the No_Answer event. +-- If the user does not answer the call within the allotted time, +-- then the gsmSSF reports the event to the gsmSCF. +-- The gsmSCF may define a criterion for the detection of DTMF digits during a call. +-- The gsmSCF may define other criteria in the dpSpecificCriteriaAlt alternative +-- in future releases. + +``` + +``` + +DpSpecificCriteriaAlt { PARAMETERS-BOUND : bound } ::= SEQUENCE { + ... + changeOfPositionControlInfo [0] ChangeOfPositionControlInfo {bound} + numberOfDigits [1] NumberOfDigits OPTIONAL, + interDigitTimeout [2] INTEGER (1..127) OPTIONAL +} +-- interDigitTimeout duration in seconds. + +``` + +``` + +DpSpecificInfoAlt { PARAMETERS-BOUND : bound } ::= SEQUENCE { + ... + oServiceChangeSpecificInfo [0] SEQUENCE { + ext-basicServiceCode [0] Ext-BasicServiceCode OPTIONAL, + ... + initiatorOfServiceChange [1] InitiatorOfServiceChange OPTIONAL, + natureOfServiceChange [2] NatureOfServiceChange OPTIONAL + } + tServiceChangeSpecificInfo [1] SEQUENCE { + ext-basicServiceCode [0] Ext-BasicServiceCode OPTIONAL, + ... + initiatorOfServiceChange [1] InitiatorOfServiceChange OPTIONAL, + natureOfServiceChange [2] NatureOfServiceChange OPTIONAL + } + collectedInfoSpecificInfo [2] SEQUENCE { + calledPartyNumber [0] CalledPartyNumber OPTIONAL, + ... + } +} +-- This datatype is for extension in future releases. + +``` + +``` + +ElapsedTime ::= CHOICE { + timeGPRSIfNoTariffSwitch [0] INTEGER (0..86400), + timeGPRSIfTariffSwitch [1] SEQUENCE { + timeGPRSSinceLastTariffSwitch [0] INTEGER (0..86400), + timeGPRSTariffSwitchInterval [1] INTEGER (0..86400) OPTIONAL + } +} +-- timeGPRSIfNoTariffSwitch is measured in seconds +-- timeGPRSSinceLastTariffSwitch and timeGPRSTariffSwitchInterval are measured in seconds + +``` + +``` + +ElapsedTimeRollOver ::= CHOICE { + rO-TimeGPRSIfNoTariffSwitch [0] INTEGER (0..255), + rO-TimeGPRSIfTariffSwitch [1] SEQUENCE { + rO-TimeGPRSSinceLastTariffSwitch [0] INTEGER (0..255) OPTIONAL, + rO-TimeGPRSTariffSwitchInterval [1] INTEGER (0..255) OPTIONAL + } +} +-- rO-TimeGPRSIfNoTariffSwitch, rO-TimeGPRSSinceLastTariffSwitch and +-- rO-TimeGPRSTariffSwitchInterval +-- present counters indicating the number of parameter range rollovers. + +``` + +``` + +EndUserAddress {PARAMETERS-BOUND: bound} ::= SEQUENCE { + pDPTypeOrganization [0] OCTET STRING (SIZE(1)), + pDPTypeNumber [1] OCTET STRING (SIZE(1)), + pDPAddress [2] OCTET STRING (SIZE( + bound.&minPDPAddressLength .. bound.&maxPDPAddressLength)) OPTIONAL +} + +``` + +- Indicates the EndUserAddress, refer to 3GPP TS 29.060 [12] for the encoding. +- The pDPTypeOrganization shall use the least significant 4 bits of the octet encoded. +- The sender of this parameter shall set the most significant 4 bits of the octet to 1. +- The receiver of this parameter shall ignore the most significant 4 bits of this octet. + +``` + +ErrorTreatment ::= ENUMERATED { + stdErrorAndInfo (0), + help (1), + repeatPrompt (2) +} + +``` + +- stdErrorAndInfo means returning the 'ImproperCallerResponse' error in the event of an error +- condition during collection of user info. + +``` + +EventSpecificInformationBCSM {PARAMETERS-BOUND : bound} ::= CHOICE { + routeSelectFailureSpecificInfo[2] SEQUENCE { + failureCause [0] Cause {bound} OPTIONAL, + ... + }, + oCalledPartyBusySpecificInfo [3] SEQUENCE { + busyCause [0] Cause {bound} OPTIONAL, + ... + }, + oNoAnswerSpecificInfo [4] SEQUENCE { + -- no specific info defined -- + ... + }, + oAnswerSpecificInfo [5] SEQUENCE { + destinationAddress [50] CalledPartyNumber {bound} OPTIONAL, + or-Call [51] NULL OPTIONAL, + forwardedCall [52] NULL OPTIONAL, + chargeIndicator [53] ChargeIndicator OPTIONAL, + ext-basicServiceCode [54] Ext-BasicServiceCode OPTIONAL, + ext-basicServiceCode2 [55] Ext-BasicServiceCode OPTIONAL, + ... + }, + oMidCallSpecificInfo [6] SEQUENCE { + midCallEvents [1] CHOICE { + dTMFDigitsCompleted [3] Digits {bound}, + dTMFDigitsTimeOut [4] Digits {bound} + } OPTIONAL, + ... + }, + oDisconnectSpecificInfo [7] SEQUENCE { + releaseCause [0] Cause {bound} OPTIONAL, + ... + }, + tBusySpecificInfo [8] SEQUENCE { + busyCause [0] Cause {bound} OPTIONAL, + callForwarded [50] NULL OPTIONAL, + routeNotPermitted [51] NULL OPTIONAL, + forwardingDestinationNumber [52] CalledPartyNumber {bound} OPTIONAL, + ... + }, + tNoAnswerSpecificInfo [9] SEQUENCE { + callForwarded [50] NULL OPTIONAL, + forwardingDestinationNumber [52] CalledPartyNumber {bound} OPTIONAL, + ... + }, + tAnswerSpecificInfo [10] SEQUENCE { + destinationAddress [50] CalledPartyNumber {bound} OPTIONAL, + +``` + +``` + +or-Call [51] NULL OPTIONAL, +forwardedCall [52] NULL OPTIONAL, +chargeIndicator [53] ChargeIndicator OPTIONAL, +ext-basicServiceCode [54] Ext-BasicServiceCode OPTIONAL, +ext-basicServiceCode2 [55] Ext-BasicServiceCode OPTIONAL, +... +}, +tMidCallSpecificInfo [11] SEQUENCE { + midCallEvents [1] CHOICE { + dTMFDigitsCompleted [3] Digits {bound}, + dTMFDigitsTimeOut [4] Digits {bound} + } OPTIONAL, + ... +}, +tDisconnectSpecificInfo [12] SEQUENCE { + releaseCause [0] Cause {bound} OPTIONAL, + ... +}, +oTermSeizedSpecificInfo [13] SEQUENCE { + locationInformation [50] LocationInformation OPTIONAL, + ... +}, +callAcceptedSpecificInfo [20] SEQUENCE { + locationInformation [50] LocationInformation OPTIONAL, + ... +}, +oAbandonSpecificInfo [21] SEQUENCE { + routeNotPermitted [50] NULL OPTIONAL, + ... +}, +oChangeOfPositionSpecificInfo [50] SEQUENCE { + locationInformation [50] LocationInformation OPTIONAL, + ..., + metDPCriteriaList [51] MetDPCriteriaList {bound} OPTIONAL +}, +tChangeOfPositionSpecificInfo [51] SEQUENCE { + locationInformation [50] LocationInformation OPTIONAL, + ..., + metDPCriteriaList [51] MetDPCriteriaList {bound} OPTIONAL +}, +dpSpecificInfoAlt [52] DpSpecificInfoAlt {bound} +} + +``` + +-- Indicates the call related information specific to the event. + +``` + +EventSpecificInformationSMS ::= CHOICE { + o-smsFailureSpecificInfo [0] SEQUENCE { + failureCause [0] MO-SMSCause OPTIONAL, + ... + }, + o-smsSubmissionSpecificInfo [1] SEQUENCE { + -- no specific info defined-- + ... + }, + t-smsFailureSpecificInfo [2] SEQUENCE { + failureCause [0] MT-SMSCause OPTIONAL, + ... + }, + t-smsDeliverySpecificInfo [3] SEQUENCE { + -- no specific info defined-- + ... + } +} + +``` + +``` + +EventTypeBCSM ::= ENUMERATED { + collectedInfo (2), + analyzedInformation (3), + routeSelectFailure (4), + oCalledPartyBusy (5), + ... +} + +``` + +``` + + oNoAnswer (6), + oAnswer (7), + oMidCall (8), + oDisconnect (9), + oAbandon (10), + termAttemptAuthorized (12), + tBusy (13), + tNoAnswer (14), + tAnswer (15), + tMidCall (16), + tDisconnect (17), + tAbandon (18), + oTermSeized (19), + callAccepted (27), + oChangeOfPosition (50), + tChangeOfPosition (51), + ..., + oServiceChange (52), + tServiceChange (53) + } + +``` + +- Indicates the BCSM detection point event. +- Values analyzedInformation and termAttemptAuthorized may be used +- for TDPs only. +- Exception handling: reception of an unrecognized value shall be treated +- like reception of no detection point. + +``` + +EventTypeSMS ::= ENUMERATED { + sms-CollectedInfo (1), + o-smsFailure (2), + o-smsSubmission (3), + sms-DeliveryRequested (11), + t-smsFailure (12), + t-smsDelivery (13) +} + +``` + +- Values sms-CollectedInfo and sms-DeliveryRequested may be used for TDPs only. + +``` + +Extensions {PARAMETERS-BOUND : bound} ::= SEQUENCE SIZE (1..bound.&numOfExtensions) OF ExtensionField +ExtensionField ::= SEQUENCE { + +``` + +``` + + type EXTENSION.&id ({SupportedExtensions}), + -- shall identify the value of an EXTENSION type + criticality CriticalityType DEFAULT ignore, + value [1] EXTENSION.&ExtensionType ({SupportedExtensions}{@type}), + ... +} + +``` + +- This parameter indicates an extension of an argument data type. +- Its content is network operator specific + +``` + +FCIBillingChargingCharacteristics {PARAMETERS-BOUND : bound} ::= OCTET STRING (SIZE( + bound.&minFCIBillingChargingLength .. bound.&maxFCIBillingChargingLength)) + (CONSTRAINED BY {-- shall be the result of the BER-encoded value of type -- + CAMEL-FCIBillingChargingCharacteristics {bound}}) + +``` + +- This parameter indicates the billing and/or charging characteristics. +- The violation of the UserDefinedConstraint shall be handled as an ASN.1 syntax error. + +``` + +FCIGPRSBillingChargingCharacteristics {PARAMETERS-BOUND : bound} ::= OCTET STRING (SIZE( + bound.&minFCIBillingChargingLength .. bound.&maxFCIBillingChargingLength)) + (CONSTRAINED BY {-- shall be the result of the BER-encoded value of type - + CAMEL-FCIGPRSBillingChargingCharacteristics {bound}}) + +``` + +- This parameter indicates the GPRS billing and/or charging characteristics. +- The violation of the UserDefinedConstraint shall be handled as an ASN.1 syntax error. + +``` + +FCISMSBillingChargingCharacteristics {PARAMETERS-BOUND : bound} ::= OCTET STRING (SIZE( + bound.&minFCIBillingChargingLength .. bound.&maxFCIBillingChargingLength)) + (CONSTRAINED BY {-- shall be the result of the BER-encoded value of type - + CAMEL-FCISMSBillingChargingCharacteristics {bound}}) + +``` + +- This parameter indicates the SMS billing and/or charging characteristics. +- The violation of the UserDefinedConstraint shall be handled as an ASN.1 syntax error. + +``` + +ForwardServiceInteractionInd ::= SEQUENCE { + conferenceTreatmentIndicator [1] OCTET STRING (SIZE(1)) OPTIONAL, + -- acceptConferenceRequest 'xxxx xx01'B + -- rejectConferenceRequest 'xxxx xx10'B + -- if absent from Connect or ContinueWithArgument, + -- then CAMEL service does not affect conference treatment + callDiversionTreatmentIndicator [2] OCTET STRING (SIZE(1)) OPTIONAL, + -- callDiversionAllowed 'xxxx xx01'B + -- callDiversionNotAllowed 'xxxx xx10'B + -- if absent from Connect or ContinueWithArgument, + -- then CAMEL service does not affect call diversion treatment + callingPartyRestrictionIndicator [4] OCTET STRING (SIZE(1)) OPTIONAL, + -- noINImpact 'xxxx xx01'B + -- presentationRestricted 'xxxx xx10'B + -- if absent from Connect or ContinueWithArgument, + -- then CAMEL service does not affect calling party restriction treatment + ... +} + +``` + +``` + +GapCriteria {PARAMETERS-BOUND : bound} ::= CHOICE { + basicGapCriteria BasicGapCriteria {bound}, + compoundGapCriteria CompoundCriteria {bound} +} + +``` + +``` + +GapIndicators ::= SEQUENCE { + duration [0] Duration, + gapInterval [1] Interval, + ... +} + +``` + +- Indicates the call gapping characteristics. +- No call gapping when gapInterval equals 0. + +``` + +GapOnService ::= SEQUENCE { + serviceKey [0] ServiceKey, + ... +} + +``` + +``` + +GapTreatment {PARAMETERS-BOUND : bound} ::= CHOICE { + informationToSend [0] InformationToSend {bound}, + releaseCause [1] Cause {bound} +} + +``` + +- The default value for Cause is the same as in ISUP. + +``` + +GenericNumber {PARAMETERS-BOUND : bound} ::= OCTET STRING (SIZE( + bound.&minGenericNumberLength .. bound.&maxGenericNumberLength)) + +``` + +- Indicates a generic number. Refer to ETSI EN 300 356-1 [23] Generic number for encoding. + +``` + +GenericNumbers {PARAMETERS-BOUND : bound} ::= SET SIZE(1..bound.&numOfGenericNumbers) OF GenericNumber {bound} + +``` + +``` + +GPRS-QoS ::= CHOICE { + short-QoS-format [0] QoS-Subscribed, + long-QoS-format [1] Ext-QoS-Subscribed +} + +``` + +- Short-QoS-format shall be sent for QoS in pre GSM release 99 format. +- Long-QoS-format shall be sent for QoS in GSM release 99 (and beyond) format. +- Which of the two QoS formats shall be sent is determined by which QoS format is available in the SGSN at the time of sending. +- Refer to 3GPP TS 29.002 [11] for encoding details of QoS-Subscribed and Ext-QoS-Subscribed. + +``` + +GPRS-QoS-Extension ::= SEQUENCE { + supplement-to-long-QoS-format [0] Ext2-QoS-Subscribed, + ... +} + +``` + +``` + +additionalSupplement [1] Ext3-QoS-Subscribed OPTIONAL +} + +``` + +GPRSCause {PARAMETERS-BOUND : bound} ::= OCTET STRING (SIZE + (bound.&minGPRSCauseLength .. bound.&maxGPRSCauseLength)) + – Shall only include the cause value. + +- 00000000 Unspecified +- All other values shall be interpreted as 'Unspecified'. +- +- This parameter indicates the cause for CAP interface related information. +- The GPRSCause mapping to/from GTP cause values specified in the 3GPP TS 29.060 [12] and +- to/from 3GPP TS 24.008 [9] GMM cause and SM cause values are outside scope of this document. + +``` + +GPRSEvent ::= SEQUENCE { + gPRSEEventType [0] GPRSEventType, + monitorMode [1] MonitorMode +} + +``` + +- Indicates the GPRS event information for monitoring. + +GPRSEventSpecificInformation {PARAMETERS-BOUND : bound} ::= CHOICE { + +``` + +attachChangeOfPositionSpecificInformation + [0] SEQUENCE { + locationInformationGPRS [0] LocationInformationGPRS OPTIONAL, + ... + }, + +``` + +``` + +pdp-ContextchangeOfPositionSpecificInformation + [1] SEQUENCE { + accessPointName [0] AccessPointName {bound} OPTIONAL, + chargingID [1] GPRSChargingID OPTIONAL, + locationInformationGPRS [2] LocationInformationGPRS OPTIONAL, + endUserAddress [3] EndUserAddress {bound} OPTIONAL, + qualityOfService [4] QualityOfService OPTIONAL, + timeAndTimeZone [5] TimeAndTimezone {bound} OPTIONAL, + ..., + gGSNAddress [6] GSN-Address OPTIONAL + }, + +``` + +``` + +detachSpecificInformation [2] SEQUENCE { + initiatingEntity [0] InitiatingEntity OPTIONAL, + ..., + routeingAreaUpdate [1] NULL OPTIONAL +}, + +``` + +``` + +disconnectSpecificInformation [3] SEQUENCE { + initiatingEntity [0] InitiatingEntity OPTIONAL, + ..., + routeingAreaUpdate [1] NULL OPTIONAL +}, + +``` + +``` + +pDPContextEstablishmentSpecificInformation + [4] SEQUENCE { + accessPointName [0] AccessPointName {bound} OPTIONAL, + endUserAddress [1] EndUserAddress {bound} OPTIONAL, + qualityOfService [2] QualityOfService OPTIONAL, + locationInformationGPRS [3] LocationInformationGPRS OPTIONAL, + timeAndTimeZone [4] TimeAndTimezone {bound} OPTIONAL, + pDPInitiationType [5] PDPInitiationType OPTIONAL, + ..., + secondaryPDP-context [6] NULL OPTIONAL + }, + +``` + +``` + +pDPContextEstablishmentAcknowledgementSpecificInformation + [5] SEQUENCE { + +``` + +``` + + accessPointName [0] AccessPointName {bound} OPTIONAL, + chargingID [1] GPRSChargingID OPTIONAL, + endUserAddress [2] EndUserAddress {bound} OPTIONAL, + qualityOfService [3] QualityOfService OPTIONAL, + locationInformationGPRS [4] LocationInformationGPRS OPTIONAL, + timeAndTimeZone [5] TimeAndTimezone {bound} OPTIONAL, + ..., + gGSNAddress [6] GSN-Address OPTIONAL + } +} + +``` + +``` + +GPRSEventType ::= ENUMERATED { + attach (1), + attachChangeOfPosition (2), + detached (3), + pdp-ContextEstablishment (11), + pdp-ContextEstablishmentAcknowledgement (12), + disconnect (13), + pdp-ContextChangeOfPosition (14) +} + +``` + +``` + +InbandInfo {PARAMETERS-BOUND : bound} ::= SEQUENCE { + messageID [0] MessageID {bound}, + numberOfRepetitions [1] INTEGER (1..127) OPTIONAL, + duration [2] INTEGER (0..32767) OPTIONAL, + interval [3] INTEGER (0..32767) OPTIONAL, + ... +} + +``` + +- Interval is the time in seconds between each repeated announcement. Duration is the total +- amount of time in seconds, including repetitions and intervals. +- The end of announcement is either the end of duration or numberOfRepetitions, +- whatever comes first. +- duration with value 0 indicates infinite duration + +``` + +InformationToSend {PARAMETERS-BOUND : bound} ::= CHOICE { + inbandInfo [0] InbandInfo {bound}, + tone [1] Tone +} + +``` + +``` + +InitiatingEntity ::= ENUMERATED { + mobileStation (0), + sgsn (1), + hlr (2), + ggsn (3) +} + +``` + +``` + +InitiatorOfServiceChange ::= ENUMERATED { + a-side (0), + b-side (1) +} + +``` + +``` + +InvokeID ::= INTEGER (-128..127) + +``` + +``` + +IPRoutingAddress {PARAMETERS-BOUND : bound} ::= CalledPartyNumber {bound} +– Indicates the routing address for the IP. + +``` + +``` + +IPSSPCapabilities {PARAMETERS-BOUND : bound} ::= OCTET STRING (SIZE( + bound.&minIPSSPCapabilitiesLength .. bound.&maxIPSSPCapabilitiesLength)) +– Indicates the gsmSRF resources available. The parameter has two parts, a standard and a +– bilateral part. The standard part indicates capabilities defined as optional in CAP +– that shall be recognised (but not necessarily supported) by a gsmSCF. The bilateral +– part contains further information that is not specified in this standard, but which is set +– according to bilateral agreements between network operators and/or equipment vendors. +– The last octet of the standard part is indicated by bit 7 being set to 0, otherwise Bit 7 of +– a standard part octet is set to 1 indicating that the standard part continues in the following + +``` + +– octet. Coding is as follows: + +| | | | +|-----------------|------------------------------------------------------------|-----------------------------------------------------------| +| – Octet 1 | Standard Part for CAP | | +| – Bit | Value | Meaning | +| – 0 | 0 | IPRoutingAddress not supported | +| – | 1 | IPRoutingAddress supported | +| – 1 | 0 | VoiceBack not supported | +| – | 1 | VoiceBack supported | +| – 2 | 0 | VoiceInformation not supported, via speech recognition | +| – | 1 | VoiceInformation supported, via speech recognition | +| – 3 | 0 | VoiceInformation not supported, via voice recognition | +| – | 1 | VoiceInformation supported, via voice recognition | +| – 4 | 0 | Generation of voice announcements from Text not supported | +| – | 1 | Generation of voice announcements from Text supported | +| – 5 | - | Reserved | +| – 6 | - | Reserved | +| – 7 | 0 | End of standard part | +| – | 1 | This value is reserved in CAP | +| – | | | +| – Octets 2 to 4 | Bilateral Part: Network operator/equipment vendor specific | | + +``` +LegOrCallSegment {PARAMETERS-BOUND : bound} ::= CHOICE { + callSegmentID [0] CallSegmentID {bound}, + legID [1] LegID +} +``` + +LegType ::= OCTET STRING (SIZE(1)) + +leg1 LegType ::= '01'H + +leg2 LegType ::= '02'H + +``` +LocationInformationGPRS ::= SEQUENCE { + cellGlobalIdOrServiceAreaIdOrLAI [0] OCTET STRING (SIZE(5..7)) OPTIONAL, + routeingAreaIdentity [1] RAIdentity OPTIONAL, + geographicalInformation [2] GeographicalInformation OPTIONAL, + sgsn-Number [3] ISDN-AddressString OPTIONAL, + selectedLSAIdentity [4] LSAIdentity OPTIONAL, + extensionContainer [5] ExtensionContainer OPTIONAL, + ..., + sai-Present [6] NULL OPTIONAL, + userCSGInformation [7] UserCSGInformation OPTIONAL +} +``` + +– cellGlobalIdOrServiceAreaIdOrLAI shall contain the value part of the + +– CellGlobalIdOrServiceAreaIdFixedLength type or the LAIFixedLength type (i.e. excluding tags + +– and lengths) as defined in 3GPP TS 29.002 [13]. + +– sai-Present indicates that the cellGlobalIdOrServiceAreaIdOrLAI parameter contains + +– a Service Area Identity. + +– UserCSGInformation contains the CSG ID, Access mode, and the CSG Membership Indication in the + +-- case the Access mode is Hybrid Mode, as defined in 3GPP TS 23.060 [93]. + +``` +LocationNumber {PARAMETERS-BOUND : bound} ::= OCTET STRING (SIZE ( + bound.&minLocationNumberLength .. bound.&maxLocationNumberLength)) +``` + +– Indicates the Location Number for the calling party. + +– Refer to ETSI EN 300 356-1 [23] for encoding. + +``` +LowLayerCompatibility {PARAMETERS-BOUND : bound} ::= OCTET STRING (SIZE ( + bound.&minLowLayerCompatibilityLength .. bound.&maxLowLayerCompatibilityLength)) +``` + +– indicates the LowLayerCompatibility for the calling party. + +– Refer to 3GPP TS 24.008 [9] for encoding. + +– It shall be coded as in the value part defined in 3GPP TS 24.008. + +-- i.e. the 3GPP TS 24.008 IEI and 3GPP TS 24.008 octet length indicator + +-- shall not be included. + +``` +MessageID {PARAMETERS-BOUND : bound} ::= CHOICE { + elementaryMessageID [0] Integer4, + text [1] SEQUENCE { + messageContent [0] IA5String (SIZE( + bound.&minMessageContentLength .. bound.&maxMessageContentLength)), +``` + +``` + +attributes [1] OCTET STRING (SIZE( + bound.&minAttributesLength .. bound.&maxAttributesLength)) OPTIONAL +}, +elementaryMessageIDs [29] SEQUENCE SIZE (1.. bound.&numOfMessageIDs) OF Integer4, +variableMessage [30] SEQUENCE { + elementaryMessageID [0] Integer4, + variableParts [1] SEQUENCE SIZE (1..5) OF VariablePart {bound} +} +} + +``` + +– Use of the text parameter is network operator/equipment vendor specific. + +MetDPCriteriaList {PARAMETERS-BOUND : bound} ::= SEQUENCE SIZE (1..bound.&numOfChangeOfPositionControlInfo) OF MetDPCriterion {bound} + +``` + +MetDPCriterion {PARAMETERS-BOUND : bound} ::= CHOICE { + enteringCellGlobalId [0] CellGlobalIdOrServiceAreaIdFixedLength, + leavingCellGlobalId [1] CellGlobalIdOrServiceAreaIdFixedLength, + enteringServiceAreaId [2] CellGlobalIdOrServiceAreaIdFixedLength, + leavingServiceAreaId [3] CellGlobalIdOrServiceAreaIdFixedLength, + enteringLocationAreaId [4] LAIFixedLength, + leavingLocationAreaId [5] LAIFixedLength, + inter-SystemHandOverToUMTS [6] NULL, + inter-SystemHandOverToGSM [7] NULL, + inter-PLMNHandOver [8] NULL, + inter-MSCHandOver [9] NULL, + metDPCriterionAlt [10] MetDPCriterionAlt {bound} +} + +``` + +– The enteringCellGlobalId and leavingCellGlobalId shall contain a Cell Global Identification. + +– The enteringServiceAreaId and leavingServiceAreaId shall contain a Service Area Identification. + +MetDPCriterionAlt {PARAMETERS-BOUND : bound} ::= SEQUENCE { + +``` + +... +} + +``` + +``` + +MidCallControlInfo ::= SEQUENCE { + minimumNumberOfDigits [0] INTEGER (1..30) DEFAULT 1, + maximumNumberOfDigits [1] INTEGER (1..30) DEFAULT 30, + endOfReplyDigit [2] OCTET STRING (SIZE (1..2)) OPTIONAL, + cancelDigit [3] OCTET STRING (SIZE (1..2)) OPTIONAL, + startDigit [4] OCTET STRING (SIZE (1..2)) OPTIONAL, + interDigitTimeout [6] INTEGER (1..127) DEFAULT 10, + ... +} + +``` + +``` + +-- +-- - minimumNumberOfDigits specifies the minimum number of digits that shall be collected +-- - maximumNumberOfDigits specifies the maximum number of digits that shall be collected +-- - endOfReplyDigit specifies the digit string that denotes the end of the digits +-- to be collected. +-- - cancelDigit specifies the digit string that indicates that the input shall +-- be erased and digit collection shall start afresh. +-- - startDigit specifies the digit string that denotes the start of the digits +-- to be collected. +-- - interDigitTimeout specifies the maximum duration in seconds between successive +-- digits. +-- +-- endOfReplyDigit, cancelDigit and startDigit shall contain digits in the range 0..9, '*' and '#' +-- only. The collected digits string, reported to the gsmSCF, shall include the endOfReplyDigit and +-- the startDigit, if present. +-- +-- endOfReplyDigit, cancelDigit and startDigit shall be encoded as BCD digits. Each octet shall +-- contain one BCD digit, in the 4 least significant bits of each octet. +-- The following encoding shall be used for the over-decadic digits: 1011 (*), 1100 (#). + +``` + +``` + +MonitorMode ::= ENUMERATED { + interrupted (0), + notifyAndContinue (1), + transparent (2) +} + +``` + +– Indicates the event is relayed and/or processed by the SSP. + +– Transparent means that the gsmSSF or gprsSSF does not notify the gsmSCF of the event. + +-- For the use of this parameter refer to the procedure descriptions in clause 11. + +-- For the RequestNotificationCharging operation, 'interrupted' shall not be used in MonitorMode. + +``` +MO-SMSCause ::= ENUMERATED { + systemFailure (0), + unexpectedDataValue (1), + facilityNotSupported (2), + sM-DeliveryFailure (3), + releaseFromRadioInterface (4) +} +``` + +-- MO SMS error values which are reported to gsmSCF. + +-- Most of these values are received from the SMSC as a response to + +-- MO-ForwardSM operation. + +``` +MT-SMSCause ::= OCTET STRING (SIZE (1)) +``` + +-- This variable is sent to the gsmSCF for a Short Message delivery failure + +-- notification. + +-- If the delivery failure is due to RP-ERROR RPDU received from the MS, + +-- then MT-SMSCause shall be set to the RP-Cause component in the RP-ERROR RPDU. + +-- Refer to 3GPP TS 24.011 [10] for the encoding of RP-Cause values. + +-- Otherwise, if the delivery failure is due to internal failure in the MSC or SGSN + +-- or time-out from the MS, then MT-SMSCause shall be set to 'Protocol error, + +-- unspecified', as defined in 3GPP TS 24.011 [10]. + +``` +NAOliInfo ::= OCTET STRING (SIZE (1)) +``` + +-- NA Oli information takes the same value as defined in ANSI T1.113-1995 [92] + +-- e.g. '3D'H - Decimal value 61 - Cellular Service (Type 1) + +-- '3E'H - Decimal value 62 - Cellular Service (Type 2) + +-- '3F'H - Decimal value 63 - Cellular Service (roaming) + +``` +NatureOfServiceChange ::= ENUMERATED { + userInitiated (0), + networkInitiated (1) +} +``` + +``` +NumberOfDigits ::= INTEGER (1..255) +``` + +-- Indicates the number of digits to be collected. + +``` +OCSIAplicable ::= NULL +``` + +-- Indicates that the Originating CAMEL Subscription Information, if present, shall be + +-- applied on the outgoing call leg created with a Connect operation. For the use of this + +-- parameter see 3GPP TS 23.078 [7]. + +``` +OriginalCalledPartyID {PARAMETERS-BOUND : bound} ::= OCTET STRING (SIZE( +``` + +``` + bound.&minOriginalCalledPartyIDLength .. bound.&maxOriginalCalledPartyIDLength)) +``` + +-- Indicates the original called number. Refer to ETSI EN 300 356-1 [23] Original Called Number + +-- for encoding. + +``` +PDPID ::= OCTET STRING (SIZE (1)) +``` + +-- PDP Identifier is a counter used to identify a specific PDP Context within a control + +-- relationship between gprsSSF and gsmSCF. + +``` +PDPInitiationType ::= ENUMERATED { + mSInitiated (0), + networkInitiated (1) +} +``` + +``` +QualityOfService ::= SEQUENCE { +``` + +``` + requested-QoS [0] GPRS-QoS OPTIONAL, + subscribed-QoS [1] GPRS-QoS OPTIONAL, + negotiated-QoS [2] GPRS-QoS OPTIONAL, +``` + +``` + ..., +``` + +``` + requested-QoS-Extension [3] GPRS-QoS-Extension OPTIONAL, + subscribed-QoS-Extension [4] GPRS-QoS-Extension OPTIONAL, + negotiated-QoS-Extension [5] GPRS-QoS-Extension OPTIONAL +``` + +``` +} +``` + +``` +ReceivingSideID ::= CHOICE { +``` + +``` + receivingSideID [1] LegType +``` + +} + +– used to identify LegID in operations sent from gsmSSF to gsmSCF + +RedirectingPartyID {PARAMETERS-BOUND : bound} ::= OCTET STRING (SIZE ( + bound.&minRedirectingPartyIDLength .. bound.&maxRedirectingPartyIDLength)) + +– Indicates redirecting number. + +– Refer to ETSI EN 300 356-1 [23] Redirecting number for encoding. + +RequestedInformationList {PARAMETERS-BOUND : bound} ::= SEQUENCE SIZE (1.. numOfInfoItems) OF RequestedInformation {bound} + +RequestedInformationTypeList ::= SEQUENCE SIZE (1.. numOfInfoItems) OF RequestedInformationType + +RequestedInformation {PARAMETERS-BOUND : bound} ::= SEQUENCE { + requestedInformationType [0] RequestedInformationType, + requestedInformationValue [1] RequestedInformationValue {bound}, + ... + } + +RequestedInformationType ::= ENUMERATED { + callAttemptElapsedTime (0), + callStopTime (1), + callConnectedElapsedTime (2), + releaseCause (30) + } + +RequestedInformationValue {PARAMETERS-BOUND : bound} ::= CHOICE { + callAttemptElapsedTimeValue [0] INTEGER (0..255), + callStopTimeValue [1] DateAndTime, + callConnectedElapsedTimeValue [2] Integer4, + releaseCauseValue [30] Cause {bound} + } + +– The callAttemptElapsedTimeValue is specified in seconds. The unit for the + +– callConnectedElapsedTimeValue is 100 milliseconds + +RPCause ::= OCTET STRING (SIZE (1)) + +– RP cause according to 3GPP TS 24.011 [10] or 3GPP TS 29.002 [11]. + +– GsmSCF shall send this cause in the ReleaseSMS operation. + +-- For a MO-SMS service, the MSC or SGSN shall send the RP Cause to the originating MS. + +-- It shall be used to overwrite the RP-Cause element in the RP-ERROR RPDU. + +-- For a MT-SMS service, the MSC or SGSN shall send the RP Cause to the sending SMS-GMSC. + +-- It shall be used to overwrite the RP-Cause element in the RP-ERROR RPDU. + +ScfID {PARAMETERS-BOUND : bound} ::= OCTET STRING (SIZE( + bound.&minScfIDLength .. bound.&maxScfIDLength)) + +– format and length of ScfID is defined by the network operator. + +– Indicates the gsmSCF identity. + +SCIBillingChargingCharacteristics {PARAMETERS-BOUND : bound} ::= OCTET STRING (SIZE ( + bound.&minSCIBillingChargingLength .. bound.&maxSCIBillingChargingLength)) + (CONSTRAINED BY {– shall be the result of the BER-encoded value of type – + CAMEL-SCIBillingChargingCharacteristics}) + +– Indicates AOC information to be sent to a Mobile Station + +– The violation of the UserDefinedConstraint shall be handled as an ASN.1 syntax error. + +SCIGPRSBillingChargingCharacteristics {PARAMETERS-BOUND : bound} ::= OCTET STRING (SIZE ( + bound.&minSCIBillingChargingLength .. bound.&maxSCIBillingChargingLength)) + (CONSTRAINED BY {– shall be the result of the BER-encoded value of type – + CAMEL-SCIGPRSBillingChargingCharacteristics}) + +– Indicates AOC information to be sent to a Mobile Station + +– The violation of the UserDefinedConstraint shall be handled as an ASN.1 syntax error. + +SendingSideID ::= CHOICE {sendingSideID [0] LegType} + +– used to identify LegID in operations sent from gsmSCF to gsmSSF + +ServiceInteractionIndicatorsTwo ::= SEQUENCE { + +``` + +forwardServiceInteractionInd[0] ForwardServiceInteractionInd OPTIONAL, +-- applicable to operations InitialDP, Connect and ContinueWithArgument. +backwardServiceInteractionInd [1] BackwardServiceInteractionInd OPTIONAL, +-- applicable to operations Connect and ContinueWithArgument. +bothwayThroughConnectionInd [2] BothwayThroughConnectionInd OPTIONAL, +-- applicable to ConnectToResource and EstablishTemporaryConnection +connectedNumberTreatmentInd [4] ConnectedNumberTreatmentInd OPTIONAL, +-- applicable to Connect and ContinueWithArgument +nonCUGCall [13] NULL OPTIONAL, +-- applicable to Connect and ContinueWithArgument +-- indicates that no parameters for CUG shall be used for the call (i.e. the call shall +-- be a non-CUG call). +-- If not present, it indicates one of three things: +-- a) continue with modified CUG information (when one or more of either CUG Interlock Code +-- and Outgoing Access Indicator are present), or +-- b) continue with original CUG information (when neither CUG Interlock Code or Outgoing +-- Access Indicator are present), i.e. no IN impact. +-- c) continue with the original non-CUG call. +holdTreatmentIndicator [50] OCTET STRING (SIZE(1)) OPTIONAL, +-- applicable to InitialDP, Connect and ContinueWithArgument +-- acceptHoldRequest 'xxxx xx01'B +-- rejectHoldRequest 'xxxx xx10'B +-- if absent from Connect or ContinueWithArgument, +-- then CAMEL service does not affect call hold treatment +cwTreatmentIndicator [51] OCTET STRING (SIZE(1)) OPTIONAL, +-- applicable to InitialDP, Connect and ContinueWithArgument +-- acceptCw 'xxxx xx01'B +-- rejectCw 'xxxx xx10'B +-- if absent from Connect or ContinueWithArgument, +-- then CAMEL service does not affect call waiting treatment +ectTreatmentIndicator [52] OCTET STRING (SIZE(1)) OPTIONAL, +-- applicable to InitialDP, Connect and ContinueWithArgument +-- acceptEctRequest 'xxxx xx01'B +-- rejectEctRequest 'xxxx xx10'B +-- if absent from Connect or ContinueWithArgument, +-- then CAMEL service does not affect explicit call transfer treatment +... +} + +``` + +SGSNCapabilities ::= OCTET STRING (SIZE (1)) + +-- Indicates the SGSN capabilities. The coding of the parameter is as follows: + +| Bit | Value | Meaning | +|-----|-------|---------------------------------| +| 0 | 0 | AoC not supported by SGSN | +| | 1 | AoC supported by SGSN | +| 1 | - | This bit is reserved in CAP V.3 | +| 2 | - | This bit is reserved in CAP V.3 | +| 3 | - | This bit is reserved in CAP V.3 | +| 4 | - | This bit is reserved in CAP V.3 | +| 5 | - | This bit is reserved in CAP V.3 | +| 6 | - | This bit is reserved in CAP V.3 | +| 7 | - | This bit is reserved in CAP V.3 | + +SMS-AddressString ::= AddressString (SIZE (1 .. maxSMS-AddressStringLength)) + +-- This data type is used to transport CallingPartyNumber for MT-SMS. + +-- If this data type is used for MO-SMS, then the maximum number of digits shall be 16. + +-- An SMS-AddressString may contain an alphanumeric character string. In this + +-- case, a nature of address indicator '101'B is used, in accordance with + +-- 3GPP TS 23.040 [6]. The address is coded in accordance with the GSM 7-bit + +-- default alphabet definition and the SMS packing rules as specified in + +-- 3GPP TS 23.038 [15] in this case. + +maxSMS-AddressStringLength INTEGER ::= 11 + +``` + +SMSEvent ::= SEQUENCE { + eventTypeSMS [0] EventTypeSMS, + +``` + +``` + + monitorMode [1] MonitorMode + } + +``` + +``` + +TariffSwitchInterval ::= INTEGER (1 .. 86400) +-- TariffSwitchInterval is measured in 1 second units + +``` + +``` + +TimeAndTimezone {PARAMETERS-BOUND : bound} ::= OCTET STRING (SIZE( + bound.&minTimeAndTimezoneLength .. bound.&maxTimeAndTimezoneLength)) +-- Indicates the time and timezone, relative to GMT. This parameter is BCD encoded. +-- The year digit indicating millenium occupies bits 0-3 of the first octet, and the year +-- digit indicating century occupies bits 4-7 of the first octet. +-- The year digit indicating decade occupies bits 0-3 of the second octet, whilst the digit +-- indicating the year within the decade occupies bits 4-7 of the second octet. +-- The most significant month digit occupies bits 0-3 of the third octet, and the least +-- significant month digit occupies bits 4-7 of the third octet. +-- The most significant day digit occupies bits 0-3 of the fourth octet, and the least +-- significant day digit occupies bits 4-7 of the fourth octet. +-- The most significant hours digit occupies bits 0-3 of the fifth octet, and the least +-- significant hours digit occupies bits 4-7 of the fifth octet. +-- The most significant minutes digit occupies bits 0-3 of the sixth octet, and the least +-- significant minutes digit occupies bits 4-7 of the sixth octet. +-- The most significant seconds digit occupies bits 0-3 of the seventh octet, and the least +-- significant seconds digit occupies bits 4-7 of the seventh octet. +-- +-- The timezone information occupies the eighth octet. For the encoding of Timezone refer to +-- 3GPP TS 23.040 [6]. +-- +-- The BCD digits are packed and encoded as follows: +-- +-- Bit 7 6 5 4 | 3 2 1 0 +-- -- 2nd digit | 1st digit Octet 1 +-- -- 3rd digit | 4th digit Octet 2 +-- -- .. | .. Octet m +-- +-- 0000 digit 0 +-- 0001 digit 1 +-- 0010 digit 2 +-- 0011 digit 3 +-- 0100 digit 4 +-- 0101 digit 5 +-- 0110 digit 6 +-- 0111 digit 7 +-- 1000 digit 8 +-- 1001 digit 9 +-- 1010 spare +-- 1011 spare +-- 1100 spare +-- 1101 spare +-- 1110 spare +-- 1101 spare +-- +-- where the leftmost bit of the digit is either bit 7 or bit 3 of the octet. + +``` + +``` + +TimeIfNoTariffSwitch ::= INTEGER(0..864000) +-- TimeIfNoTariffSwitch is measured in 100 millisecond intervals + +``` + +``` + +TimeIfTariffSwitch ::= SEQUENCE { + timeSinceTariffSwitch [0] INTEGER(0..864000), + tariffSwitchInterval [1] INTEGER(1..864000) OPTIONAL +} +-- timeSinceTariffSwitch and tariffSwitchInterval are measured in 100 millisecond intervals + +``` + +``` + +TimeInformation ::= CHOICE { + timeIfNoTariffSwitch [0] TimeIfNoTariffSwitch, + +``` + +``` + +timeIfTariffSwitch [1] TimeIfTariffSwitch +} + +``` + +– Indicates call duration information + +``` + +TimerID ::= ENUMERATED { + tssf (0) +} + +``` + +– Indicates the timer to be reset. + +``` + +TimerValue ::= Integer4 + +``` + +– Indicates the timer value (in seconds). + +``` + +Tone ::= SEQUENCE { + toneID [0] Integer4, + duration [1] Integer4 OPTIONAL, + ... +} + +``` + +– The duration specifies the length of the tone in seconds, value 0 indicates infinite duration. + +``` + +TPDataCodingScheme ::= OCTET STRING (SIZE (1)) + +``` + +– TP Data Coding Scheme according to 3GPP TS 23.040 [6] + +``` + +TPProtocolIdentifier ::= OCTET STRING (SIZE (1)) + +``` + +– indicates the protocol used above the SM-Transfer Layer as specified in 3GPP TS 23.040 [6]. + +``` + +TPShortMessageSpecificInfo ::= OCTET STRING (SIZE (1)) + +``` + +– contains the 1st octet of the applicable TPDU or the SMS-COMMAND TPDU as specified in 3GPP TS 23.040 [6]. + +``` + +TPValidityPeriod ::= OCTET STRING (SIZE (1..7)) + +``` + +– indicates the length of the validity period or the absolute time of the validity + +– period termination as specified in 3GPP TS 23.040 [6]. + +– the length of ValidityPeriod is either 1 octet or 7 octets + +``` + +TransferredVolume ::= CHOICE { + volumeIfNoTariffSwitch [0] INTEGER (0..4294967295), + volumeIfTariffSwitch [1] SEQUENCE { + volumeSinceLastTariffSwitch [0] INTEGER (0..4294967295), + volumeTariffSwitchInterval [1] INTEGER (0..4294967295) OPTIONAL + } +} + +``` + +– volumeIfNoTariffSwitch, volumeSinceLastTariffSwitch and volumeTariffSwitchInterval + +– are measured in bytes. + +``` + +TransferredVolumeRollOver ::= CHOICE { + rO-VolumeIfNoTariffSwitch [0] INTEGER (0..255), + rO-VolumeIfTariffSwitch [1] SEQUENCE { + rO-VolumeSinceLastTariffSwitch [0] INTEGER (0..255) OPTIONAL, + rO-VolumeTariffSwitchInterval [1] INTEGER (0..255) OPTIONAL + } +} + +``` + +– rO-VolumeIfNoTariffSwitch, rO-VolumeSinceLastTariffSwitch and rO-VolumeTariffSwitchInterval + +– present counters indicating the number of parameter range rollovers. + +``` + +UnavailableNetworkResource ::= ENUMERATED { + unavailableResources (0), + componentFailure (1), + basicCallProcessingException (2), + resourceStatusFailure (3), + endUserFailure (4) +} + +``` + +– Indicates the network resource that failed. + +``` + +VariablePart {PARAMETERS-BOUND : bound} ::= CHOICE { + integer [0] Integer4, + +``` + +``` + +number [1] Digits {bound}, -- Generic digits +time [2] OCTET STRING (SIZE(2)), -- HH: MM, BCD coded +date [3] OCTET STRING (SIZE(4)), -- YYYYMMDD, BCD coded +price [4] OCTET STRING (SIZE(4)) +} + +``` + +- Indicates the variable part of the message. Time is BCD encoded. +- The most significant hours digit occupies bits 0-3 of the first octet, and the least +- significant digit occupies bits 4-7 of the first octet. The most significant minutes digit +- occupies bits 0-3 of the second octet, and the least significant digit occupies bits 4-7 +- of the second octet. +- +- Date is BCD encoded. The year digit indicating millennium occupies bits 0-3 of the first octet, +- and the year digit indicating century occupies bits 4-7 of the first octet. The year digit +- indicating decade occupies bits 0-3 of the second octet, whilst the digit indicating the year +- within the decade occupies bits 4-7 of the second octet. +- The most significant month digit occupies bits 0-3 of the third octet, and the least +- significant month digit occupies bits 4-7 of the third octet. The most significant day digit +- occupies bits 0-3 of the fourth octet, and the least significant day digit occupies bits 4-7 +- of the fourth octet. +- Price is BCD encoded. The digit indicating hundreds of thousands occupies bits 0-3 of the +- first octet, and the digit indicating tens of thousands occupies bits 4-7 of the first octet. +- The digit indicating thousands occupies bits 0-3 of the second octet, whilst the digit +- indicating hundreds occupies bits 4-7 of the second octet. The digit indicating tens occupies +- bits 0-3 of the third octet, and the digit indicating 0 to 9 occupies bits 4-7 of the third +- octet. The tenths digit occupies bits 0-3 of the fourth octet, and the hundredths digit +- occupies bits 4-7 of the fourth octet. +- +- For the encoding of digits in an octet, refer to the timeAndtimezone parameter + +-- The Definition of range of constants follows + numOfInfoItems INTEGER ::= 4 + +END + +## 5.2 Error types + +``` +CAP-errorTypes {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) umts-network(1) +modules(3) cap-errorTypes(51) version8(7)} +``` + +- This module contains the type definitions for the CAP Error Types. +- Where a parameter of type CHOICE is tagged with a specific tag value, the tag is automatically +- replaced with an EXPLICIT tag of the same value. + +``` +DEFINITIONS IMPLICIT TAGS ::= BEGIN +``` + +``` +IMPORTS +``` + +``` + ros-InformationObjects, + datatypes, + errorcodes +``` + +``` +FROM CAP-object-identifiers {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) +umts-network(1) modules(3) cap-object-identifiers(100) version8(7)} +``` + +``` + ERROR +``` + +``` +FROM Remote-Operations-Information-Objects ros-InformationObjects +``` + +``` + InvokeID, + UnavailableNetworkResource +FROM CAP-datatypes datatypes +``` + +``` + errcode-canceled, + errcode-cancelFailed, + errcode-eTCFailed, + errcode-improperCallerResponse, + errcode-missingCustomerRecord, + errcode-missingParameter, + errcode-parameterOutOfRange, + errcode-requestedInfoError, + errcode-systemFailure, +``` + +``` + errcode-taskRefused, + errcode-unavailableResource, + errcode-unexpectedComponentSequence, + errcode-unexpectedDataValue, + errcode-unexpectedParameter, + errcode-unknownLegID, + errcode-unknownCSID, + errcode-unknownPDPID +FROM CAP-errorcodes errorcodes + +; + +-- TYPE DEFINITION FOR CAP ERROR TYPES FOLLOWS + +canceled ERROR ::= { + CODE errcode-canceled +} +-- The operation has been canceled. + +cancelFailed ERROR ::= { + PARAMETER SEQUENCE { + problem [0] ENUMERATED { + unknownOperation (0), + tooLate (1), + operationNotCancellable (2) + }, + operation [1] InvokeID, + ... + } + CODE errcode-cancelFailed +} +-- The operation failed to be canceled. + +eTCFailed ERROR ::= { + CODE errcode-eTCFailed +} +-- The establish temporary connection failed. + +improperCallerResponse ERROR ::= { + CODE errcode-improperCallerResponse +} +-- The caller response was not as expected. + +missingCustomerRecord ERROR ::= { + CODE errcode-missingCustomerRecord +} +-- The Service Logic Program could not be found in the gsmSCF. + +missingParameter ERROR ::= { + CODE errcode-missingParameter +} +-- An expected optional parameter was not received. + +parameterOutOfRange ERROR ::= { + CODE errcode-parameterOutOfRange +} +-- The parameter was not as expected (e.g. missing or out of range). + +requestedInfoError ERROR ::= { + PARAMETER ENUMERATED { + unknownRequestedInfo (1), + requestedInfoNotAvailable (2) + } + CODE errcode-requestedInfoError +} +-- The requested information cannot be found. + +systemFailure ERROR ::= { + PARAMETER UnavailableNetworkResource + CODE errcode-systemFailure +} +-- The operation could not be completed due to a system failure at the serving physical entity. + +taskRefused ERROR ::= { + PARAMETER ENUMERATED { + generic (0), + unobtainable (1), + congestion (2) + } +} +``` + +``` + + } + CODE errcode-taskRefused + } + -- An entity normally capable of the task requested cannot or chooses not to perform the task at + -- this time. This includes error situations like congestion and unobtainable address as used in + -- e.g. the connect operation.) + + unavailableResource ERROR ::= { + CODE errcode-unavailableResource + } + -- A requested resource is not available at the serving entity. + + unexpectedComponentSequence ERROR ::= { + CODE errcode-unexpectedComponentSequence + } + -- An incorrect sequence of Components was received (e.g. 'DisconnectForwardConnection' + -- followed by 'PlayAnnouncement'). + + unexpectedDataValue ERROR ::= { + CODE errcode-unexpectedDataValue + } + -- The data value was not as expected (e.g. route number expected but billing number received) + + unexpectedParameter ERROR ::= { + CODE errcode-unexpectedParameter + } + -- A parameter received was not expected. + + unknownLegID ERROR ::= { + CODE errcode-unknownLegID + } + -- Leg not known to the gsmSSF. + + unknownCSID ERROR ::= { + CODE errcode-unknownCSID + } + -- Call Segment not known to the gsmSSF. + + unknownPDPID ERROR ::= { + CODE errcode-unknownPDPID + } + -- PDPID not known by the receiving entity. + +END + +``` + +## 5.3 Operation codes + +CAP-operationcodes {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) umts-network(1) modules(3) cap-operationcodes(53) version8(7)} + +DEFINITIONS ::= BEGIN + +IMPORTS + +ros-InformationObjects + FROM CAP-object-identifiers {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) umts-network(1) modules(3) cap-object-identifiers(100) version8(7)} + +Code + FROM Remote-Operations-Information-Objects ros-InformationObjects + +; + +-- the operations are grouped by the identified operation packages. + +``` + +-- gsmSCF activation Package + opcode-initialDP Code ::= local: 0 +-- gsmSCF/gsmSRF activation of assist Package + opcode-assistRequestInstructions Code ::= local: 16 +-- Assist connection establishment Package + opcode-establishTemporaryConnection Code ::= local: 17 +-- Generic disconnect resource Package + opcode-disconnectForwardConnection Code ::= local: 18 + opcode-dFCWithArgument Code ::= local: 86 +-- Non-assisted connection establishment Package + +``` + +``` + + opcode-connectToResource Code ::= local: 19 +-- Connect Package (elementary gsmSSF function) + opcode-connect Code ::= local: 20 +-- Call handling Package (elementary gsmSSF function) + opcode-releaseCall Code ::= local: 22 +-- BCSM Event handling Package + opcode-requestReportBCSMEVENT Code ::= local: 23 + opcode-eventReportBCSM Code ::= local: 24 +-- gsmSSF call processing Package + opcode-collectInformation Code ::= local: 27 + opcode-continue Code ::= local: 31 +-- gsmSCF call initiation Package + opcode-initiateCallAttempt Code ::= local: 32 +-- Timer Package + opcode-resetTimer Code ::= local: 33 +-- Billing Package + opcode-furnishChargingInformation Code ::= local: 34 +-- Charging Package + opcode-applyCharging Code ::= local: 35 + opcode-applyChargingReport Code ::= local: 36 +-- Traffic management Package + opcode-callGap Code ::= local: 41 +-- Call report Package + opcode-callInformationReport Code ::= local: 44 + opcode-callInformationRequest Code ::= local: 45 +-- Signalling control Package + opcode-sendChargingInformation Code ::= local: 46 +-- Specialized resource control Package + opcode-playAnnouncement Code ::= local: 47 + opcode-promptAndCollectUserInfo Code ::= local: 48 + opcode-specializedResourceReport Code ::= local: 49 +-- Cancel Package + opcode-cancel Code ::= local: 53 +-- Activity Test Package + opcode-activityTest Code ::= local: 55 +-- CPH Response Package + opcode-continueWithArgument Code ::= local: 88 + opcode-disconnectLeg Code ::= local: 90 + opcode-moveLeg Code ::= local: 93 + opcode-splitLeg Code ::= local: 95 +-- Exception Inform Package + opcode-entityReleased Code ::= local: 96 +-- Play Tone Package + opcode-playTone Code ::= local: 97 + +-- Sms Activation Package + opcode-initialDPSMS Code ::= local: 60 +-- Sms Billing Package + opcode-furnishChargingInformationSMS Code ::= local: 61 +-- Sms Connect Package + opcode-connectSMS Code ::= local: 62 +-- Sms Event Handling Package + opcode-requestReportSMSEVENT Code ::= local: 63 + opcode-eventReportSMS Code ::= local: 64 +-- Sms Processing Package + opcode-continueSMS Code ::= local: 65 +-- Sms Release Package + opcode-releaseSMS Code ::= local: 66 +-- Sms Timer Package + opcode-resetTimerSMS Code ::= local: 67 + +-- Gprs Activity Test Package + opcode-activityTestGPRS Code ::= local: 70 +-- Gprs Charging Package + opcode-applyChargingGPRS Code ::= local: 71 + opcode-applyChargingReportGPRS Code ::= local: 72 +-- Gprs Cancel Package + opcode-cancelGPRS Code ::= local: 73 +-- Gprs Connect Package + opcode-connectGPRS Code ::= local: 74 +-- Gprs Processing Package + opcode-continueGPRS Code ::= local: 75 +-- Gprs Exception Information Package + opcode-entityReleasedGPRS Code ::= local: 76 +-- Gprs Billing Package + opcode-furnishChargingInformationGPRS Code ::= local: 77 +-- Gprs Scf Activation Package + opcode-initialDPGPRS Code ::= local: 78 + +``` + +``` + +-- Gprs Release Package + opcode-releaseGPRS Code ::= local: 79 +-- Gprs Event Handling Package + opcode-eventReportGPRS Code ::= local: 80 + opcode-requestReportGPRSEvent Code ::= local: 81 +-- Gprs Timer Package + opcode-resetTimerGPRS Code ::= local: 82 +-- Gprs Charge Advice Package + opcode-sendChargingInformationGPRS Code ::= local: 83 + +END + +``` + +## 5.4 Error codes + +``` + +CAP-errorcodes { itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) umts-network(1) +modules(3) cap-errorcodes(57) version8(7) } + +``` + +``` + +DEFINITIONS ::= BEGIN + +``` + +``` + +IMPORTS + +``` + +``` + + ros-InformationObjects +FROM CAP-object-identifiers { itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) +umts-network(1) modules(3) cap-object-identifiers(100) version8(7) } + +``` + +``` + + Code +FROM Remote-Operations-Information-Objects ros-InformationObjects + +; + +``` + +``` + +errcode-canceled Code ::= local: 0 +errcode-cancelFailed Code ::= local: 1 +errcode-eTCFailed Code ::= local: 3 +errcode-improperCallerResponse Code ::= local: 4 +errcode-missingCustomerRecord Code ::= local: 6 +errcode-missingParameter Code ::= local: 7 +errcode-parameterOutOfRange Code ::= local: 8 +errcode-requestedInfoError Code ::= local: 10 +errcode-systemFailure Code ::= local: 11 +errcode-taskRefused Code ::= local: 12 +errcode-unavailableResource Code ::= local: 13 +errcode-unexpectedComponentSequence Code ::= local: 14 +errcode-unexpectedDataValue Code ::= local: 15 +errcode-unexpectedParameter Code ::= local: 16 +errcode-unknownLegID Code ::= local: 17 +errcode-unknownPDPID Code ::= local: 50 +errcode-unknownCSID Code ::= local: 51 + +``` + +``` + +END + +``` + +## 5.5 Classes + +``` + +CAP-classes { itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) umts-network(1) +modules(3) cap-classes(54) version8(7) } + +``` + +``` + +DEFINITIONS ::= BEGIN + +``` + +``` + +IMPORTS + +``` + +``` + + ROS-OBJECT-CLASS, + Code +FROM Remote-Operations-Information-Objects ros-InformationObjects + +``` + +``` + + id-rosObject-gprsSSF, + id-rosObject-gsmSRF, + id-rosObject-gsmSSF, + id-rosObject-smsSSF-V3, + id-rosObject-smsSSF-V4, + ros-InformationObjects, + gsmSSF-gsmSCF-Protocol, + gsmSCF-gsmSRF-Protocol, + smsSSF-gsmSCF-Protocol, + gprsSSF-gsmSCF-Protocol + +``` + +``` + +FROM CAP-object-identifiers {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) +umts-network(1) modules(3) cap-object-identifiers(100) version8(7)} + + capSsfToScfGeneric, + capAssistHandoffssfToScf, + capScfToSsfGeneric +FROM CAP-gsmSSF-gsmSCF-pkgs-contracts-acss gsmSSF-gsmSCF-Protocol + + gsmSRF-gsmSCF-contract +FROM CAP-gsmSCF-gsmSRF-pkgs-contracts-acss gsmSCF-gsmSRF-Protocol + + cap3SMS, + cap4SMS +FROM CAP-smsSSF-gsmSCF-pkgs-contracts-acss smsSSF-gsmSCF-Protocol + + capGprsSsfToScf, + capGsmScfToGprsSsf +FROM CAP-gprsSSF-gsmSCF-pkgs-contracts-acss gprsSSF-gsmSCF-Protocol + + CriticalityType +FROM CS2-datatypes {itu-t(0) identified-organization(4) etsi(0) inDomain(1) in-network(1) cs2(20) +modules(0) in-cs2-datatypes(0) version1(0)} + +; + +gsmSSF ROS-OBJECT-CLASS ::= { + INITIATES {capSsfToScfGeneric| + capAssistHandoffssfToScf} + RESPONDS {capScfToSsfGeneric} + ID id-rosObject-gsmSSF} +-- The Rel-6 'gsmSSF' definition uses the Rel-6 capSsfToScfGeneric, capAssistHandoffssfToScf +-- and capScfToSsfGeneric CONTRACT definitions. + +gsmSRF ROS-OBJECT-CLASS ::= { + INITIATES {gsmSRF-gsmSCF-contract} + ID id-rosObject-gsmSRF} +-- The Rel-6 'gsmSRF' definition uses the Rel-6 gsmSRF-gsmSCF-contract CONTRACT definition. + +smsSSF-V3 ROS-OBJECT-CLASS ::= { + INITIATES {cap3SMS} + ID id-rosObject-smsSSF-V3} +-- The Rel-6 'smsSSF-V3' definition uses the Rel-6 cap3SMS CONTRACT definition. The smsSSF-V3 +-- ROS-OBJECT-CLASS is used for MO SMS control. + +smsSSF-V4 ROS-OBJECT-CLASS ::= { + INITIATES {cap4SMS} + ID id-rosObject-smsSSF-V4} +-- The Rel-6 'smsSSF-V4' definition uses the Rel-6 cap4SMS CONTRACT definition. The smsSSF-V4 +-- ROS-OBJECT-CLASS is used for MT SMS control. + +gprsSSF ROS-OBJECT-CLASS ::= { + INITIATES {capGprsSsfToScf} + RESPONDS {capGsmScfToGprsSsf} + ID id-rosObject-gprsSSF} +-- The Rel-6 'gprsSSF' definition uses the Rel-6 capGprsSsfToGsmScf and capGsmScfToGprsSsf +-- CONTRACT definitions. + +EXTENSION ::= CLASS { + &ExtensionType, + &criticality CriticalityType DEFAULT ignore, + &id Code} + +WITH SYNTAX { + EXTENSION-SYNTAX &ExtensionType + CRITICALITY &criticality + IDENTIFIED BY &id +} +-- Only value Global OBJECT IDENTIFIER is used for &id; +-- Only the value ignore (0) is used for &criticality. + +-- Example of addition of an extension named 'Some Network Specific Indicator' of type +-- BOOLEAN, with criticality 'ignore' and identified by global Object Identifier. +-- +-- Example of definition using the above information object class: +-- +-- SomeNetworkSpecificIndicator EXTENSION ::= { + +``` + +``` + +- EXTENSION-SYNTAX BOOLEAN +- CRITICALITY ignore +- IDENTIFIED BY global:{itu-t(0) identified-organization(4) organisation(0) gsm(1) +-- capextension(2)} +- } + +-- Example of transfer syntax, using the ExtensionField datatype as specified in clause 5. +-- Assuming the value of the extension is set to TRUE, the extensions parameter becomes +-- a Sequence of type {itu-t(0) identified-organization(4) organisation(0) gsm(1) +-- capextension(2)}, criticality ENUMERATED ::= ignore(0) and value [1] EXPLICIT BOOLEAN +-- ::= TRUE. +-- +-- Use of ITU-T Recommendation Q.1400 [52] defined Extension is for further study. +-- In addition the extension mechanism marker is used to identify the future minor additions +-- to CAP. + +firstExtension EXTENSION ::= { + EXTENSION-SYNTAX NULL + CRITICALITY ignore + IDENTIFIED BY global : {itu-t(0) identified-organization(4) organisation(0) gsm(1) + capextension(2)} +} +-- firstExtension is just an example. + +SupportedExtensions EXTENSION ::= {firstExtension, ... +-- full set of network operator extensions -- +} +-- SupportedExtension is the full set of the network operator extensions. + +PARAMETERS-BOUND ::= CLASS { + &minAccessPointNameLength INTEGER, + &maxAccessPointNameLength INTEGER, + &minACHBillingChargingLength INTEGER, + &maxACHBillingChargingLength INTEGER, + &minAttributesLength INTEGER, + &maxAttributesLength INTEGER, + &maxBearerCapabilityLength INTEGER, + &minCalledPartyBCDNumberLength INTEGER, + &maxCalledPartyBCDNumberLength INTEGER, + &minCalledPartyNumberLength INTEGER, + &maxCalledPartyNumberLength INTEGER, + &minCallingPartyNumberLength INTEGER, + &maxCallingPartyNumberLength INTEGER, + &minCallResultLength INTEGER, + &maxCallResultLength INTEGER, + &minCarrierLength INTEGER, + &maxCarrierLength INTEGER, + &minCauseLength INTEGER, + &maxCauseLength INTEGER, + &minDigitsLength INTEGER, + &maxDigitsLength INTEGER, + &minFCIBillingChargingDataLength INTEGER, + &maxFCIBillingChargingDataLength INTEGER, + &minFCIBillingChargingLength INTEGER, + &maxFCIBillingChargingLength INTEGER, + &minGenericNumberLength INTEGER, + &maxGenericNumberLength INTEGER, + &minGPRSCauseLength INTEGER, + &maxGPRSCauseLength INTEGER, + &minIPSSPCapabilitiesLength INTEGER, + &maxIPSSPCapabilitiesLength INTEGER, + &minLocationNumberLength INTEGER, + &maxLocationNumberLength INTEGER, + &minLowLayerCompatibilityLength INTEGER, + &maxLowLayerCompatibilityLength INTEGER, + &minMessageContentLength INTEGER, + &maxMessageContentLength INTEGER, + &minOriginalCalledPartyIDLength INTEGER, + &maxOriginalCalledPartyIDLength INTEGER, + &minPDPAddressLength INTEGER, + &maxPDPAddressLength INTEGER, + &minRedirectingPartyIDLength INTEGER, + &maxRedirectingPartyIDLength INTEGER, + &minScfIDLength INTEGER, + &maxScfIDLength INTEGER, + &minSCIBillingChargingLength INTEGER, +} + +``` + +``` + + &maxSCIBillingChargingLength INTEGER, + &minTimeAndTimezoneLength INTEGER, + &maxTimeAndTimezoneLength INTEGER, + &numOfBCSMEvents INTEGER, + &numOfChangeOfPositionControlInfo INTEGER, + &numOfCSSs INTEGER, + &numOfSMSEvents INTEGER, + &numOfGPRSEvents INTEGER, + &numOfExtensions INTEGER, + &numOfGenericNumbers INTEGER, + &numOfMessageIDs INTEGER} + +WITH SYNTAX { + MINIMUM-FOR-ACCESS-POINT-NAME &minAccessPointNameLength + MAXIMUM-FOR-ACCESS-POINT-NAME &maxAccessPointNameLength + MINIMUM-FOR-ACH-BILLING-CHARGING &minAchBillingChargingLength + MAXIMUM-FOR-ACH-BILLING-CHARGING &maxAchBillingChargingLength + MINIMUM-FOR-ATTRIBUTES &minAttributesLength + MAXIMUM-FOR-ATTRIBUTES &maxAttributesLength + MAXIMUM-FOR-BEARER-CAPABILITY &maxBearerCapabilityLength + MINIMUM-FOR-CALLED-PARTY-BCD-NUMBER &minCalledPartyBCDNumberLength + MAXIMUM-FOR-CALLED-PARTY-BCD-NUMBER &maxCalledPartyBCDNumberLength + MINIMUM-FOR-CALLED-PARTY-NUMBER &minCalledPartyNumberLength + MAXIMUM-FOR-CALLED-PARTY-NUMBER &maxCalledPartyNumberLength + MINIMUM-FOR-CALLING-PARTY-NUMBER &minCallingPartyNumberLength + MAXIMUM-FOR-CALLING-PARTY-NUMBER &maxCallingPartyNumberLength + MINIMUM-FOR-CALL-RESULT &minCallResultLength + MAXIMUM-FOR-CALL-RESULT &maxCallResultLength + MINIMUM-FOR-CARRIER &minCarrierLength + MAXIMUM-FOR-CARRIER &maxCarrierLength + MINIMUM-FOR-CAUSE &minCauseLength + MAXIMUM-FOR-CAUSE &maxCauseLength + MINIMUM-FOR-DIGITS &minDigitsLength + MAXIMUM-FOR-DIGITS &maxDigitsLength + MINIMUM-FOR-FCI-BILLING-CHARGING-DATA &minFCIBillingChargingDataLength + MAXIMUM-FOR-FCI-BILLING-CHARGING-DATA &maxFCIBillingChargingDataLength + MINIMUM-FOR-FCI-BILLING-CHARGING &minFCIBillingChargingLength + MAXIMUM-FOR-FCI-BILLING-CHARGING &maxFCIBillingChargingLength + MINIMUM-FOR-GENERIC-NUMBER &minGenericNumberLength + MAXIMUM-FOR-GENERIC-NUMBER &maxGenericNumberLength + MINIMUM-FOR-GPRS-CAUSE-LENGTH &minGPRSCauseLength + MAXIMUM-FOR-GPRS-CAUSE-LENGTH &maxGPRSCauseLength + MINIMUM-FOR-IP-SSP-CAPABILITIES &minIPSSPCapabilitiesLength + MAXIMUM-FOR-IP-SSP-CAPABILITIES &maxIPSSPCapabilitiesLength + MINIMUM-FOR-LOCATION-NUMBER &minLocationNumberLength + MAXIMUM-FOR-LOCATION-NUMBER &maxLocationNumberLength + MINIMUM-FOR-LOW-LAYER-COMPATIBILITY &minLowLayerCompatibilityLength + MAXIMUM-FOR-LOW-LAYER-COMPATIBILITY &maxLowLayerCompatibilityLength + MINIMUM-FOR-MESSAGE-CONTENT &minMessageContentLength + MAXIMUM-FOR-MESSAGE-CONTENT &maxMessageContentLength + MINIMUM-FOR-ORIGINAL-CALLED-PARTY-ID &minOriginalCalledPartyIDLength + MAXIMUM-FOR-ORIGINAL-CALLED-PARTY-ID &maxOriginalCalledPartyIDLength + MINIMUM-FOR-PDP-ADDRESS-LENGTH &minPDPAddressLength + MAXIMUM-FOR-PDP-ADDRESS-LENGTH &maxPDPAddressLength + MINIMUM-FOR-REDIRECTING-ID &minRedirectingPartyIDLength + MAXIMUM-FOR-REDIRECTING-ID &maxRedirectingPartyIDLength + MINIMUM-FOR-GSMSCF-ID &minScfIDLength + MAXIMUM-FOR-GSMSCF-ID &maxScfIDLength + MINIMUM-FOR-SCI-BILLING-CHARGING &minSCIBillingChargingLength + MAXIMUM-FOR-SCI-BILLING-CHARGING &maxSCIBillingChargingLength + MINIMUM-FOR-TIME-AND-TIMEZONE &minTimeAndTimezoneLength + MAXIMUM-FOR-TIME-AND-TIMEZONE &maxTimeAndTimezoneLength + NUM-OF-BCSM-EVENT &numOfBCSMEvents + NUM-OF-CHANGE-OF-POSITION-CONTROL-INFO &numOfChangeOfPositionControlInfo + NUM-OF-CSS &numOfCSSs + NUM-OF-SMS-EVENTS &numOfSMSEvents + NUM-OF-GPRS-EVENTS &numOfGPRSEvents + NUM-OF-EXTENSIONS &numOfExtensions + NUM-OF-GENERIC-NUMBERS &numOfGenericNumbers + NUM-OF-MESSAGE-IDS &numOfMessageIDs} + +cAPSpecificBoundSet PARAMETERS-BOUND ::= { + MINIMUM-FOR-ACCESS-POINT-NAME 1 + MAXIMUM-FOR-ACCESS-POINT-NAME 100 + MINIMUM-FOR-ACH-BILLING-CHARGING 5 + MAXIMUM-FOR-ACH-BILLING-CHARGING 177 + MINIMUM-FOR-ATTRIBUTES 2 +} + +``` + +``` + +MAXIMUM-FOR-ATTRIBUTES 10 +MAXIMUM-FOR-BEARER-CAPABILITY 11 +MINIMUM-FOR-CALLED-PARTY-BCD-NUMBER 1 +MAXIMUM-FOR-CALLED-PARTY-BCD-NUMBER 41 +MINIMUM-FOR-CALLED-PARTY-NUMBER 2 +MAXIMUM-FOR-CALLED-PARTY-NUMBER 18 +MINIMUM-FOR-CALLING-PARTY-NUMBER 2 +MAXIMUM-FOR-CALLING-PARTY-NUMBER 10 +MINIMUM-FOR-CALL-RESULT 12 +MAXIMUM-FOR-CALL-RESULT 193 +MINIMUM-FOR-CARRIER 4 +MAXIMUM-FOR-CARRIER 4 +MINIMUM-FOR-CAUSE 2 +MAXIMUM-FOR-CAUSE 32 +MINIMUM-FOR-DIGITS 2 +MAXIMUM-FOR-DIGITS 16 +MINIMUM-FOR-FCI-BILLING-CHARGING-DATA 1 +MAXIMUM-FOR-FCI-BILLING-CHARGING-DATA 160 +MINIMUM-FOR-FCI-BILLING-CHARGING 5 +MAXIMUM-FOR-FCI-BILLING-CHARGING 225 +MINIMUM-FOR-GENERIC-NUMBER 3 +MAXIMUM-FOR-GENERIC-NUMBER 11 +MINIMUM-FOR-GPRS-CAUSE-LENGTH 1 +MAXIMUM-FOR-GPRS-CAUSE-LENGTH 1 +MINIMUM-FOR-IP-SSP-CAPABILITIES 1 +MAXIMUM-FOR-IP-SSP-CAPABILITIES 4 +MINIMUM-FOR-LOCATION-NUMBER 2 +MAXIMUM-FOR-LOCATION-NUMBER 10 +MINIMUM-FOR-LOW-LAYER-COMPATIBILITY 1 +MAXIMUM-FOR-LOW-LAYER-COMPATIBILITY 16 +MINIMUM-FOR-MESSAGE-CONTENT 1 +MAXIMUM-FOR-MESSAGE-CONTENT 127 +MINIMUM-FOR-ORIGINAL-CALLED-PARTY-ID 2 +MAXIMUM-FOR-ORIGINAL-CALLED-PARTY-ID 10 +MINIMUM-FOR-PDP-ADDRESS-LENGTH 1 +MAXIMUM-FOR-PDP-ADDRESS-LENGTH 63 +MINIMUM-FOR-REDIRECTING-ID 2 +MAXIMUM-FOR-REDIRECTING-ID 10 +MINIMUM-FOR-GSMSCF-ID 2 +MAXIMUM-FOR-GSMSCF-ID 25 +-- maximum length of the ScfID shall be 10 unless the operator defined format +-- of the ScfID requires a higher maximum length +MINIMUM-FOR-SCI-BILLING-CHARGING 4 +MAXIMUM-FOR-SCI-BILLING-CHARGING 225 +MINIMUM-FOR-TIME-AND-TIMEZONE 8 +MAXIMUM-FOR-TIME-AND-TIMEZONE 8 +NUM-OF-BCSM-EVENT 30 +NUM-OF-CHANGE-OF-POSITION-CONTROL-INFO 10 +NUM-OF-CSS 127 +NUM-OF-SMS-EVENTS 10 +NUM-OF-GPRS-EVENTS 10 +NUM-OF-EXTENSIONS 10 +NUM-OF-GENERIC-NUMBERS 5 +NUM-OF-MESSAGE-IDS 16} + +``` + +END + +## 5.6 Object Identifiers (IDs) + +``` + +CAP-object-identifiers {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) +umts-network(1) modules(3) cap-object-identifiers(100) version8(7)} + +``` + +``` + +DEFINITIONS ::= BEGIN + +``` + +``` + +-- This module assigns object identifiers for Modules, Packages, Contracts and ACs +-- used by CAP + +``` + +``` + +-- For Modules from TC, ROS, +tc-Messages OBJECT IDENTIFIER ::= +{itu-t recommendation q 773 modules(2) messages(1) version3(3)} + +``` + +``` + +tc-NotationExtensions OBJECT IDENTIFIER ::= +{itu-t recommendation q 775 modules(2) notation-extension (4) version1(1)} + +``` + +``` +ros-InformationObjects OBJECT IDENTIFIER ::= + {joint-iso-itu-t remote-operations(4) informationObjects(5) version1(0)} + +-- For CAP Modules +datatypes OBJECT IDENTIFIER ::= + {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) umts-network(1) modules(3) + cap-datatypes(52) version8(7)} + +errortypes OBJECT IDENTIFIER ::= + {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) umts-network(1) modules(3) + cap-errortypes(51) version8(7)} + +operationcodes OBJECT IDENTIFIER ::= + {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) umts-network(1) modules(3) + cap-operationcodes(53) version8(7)} + +errorcodes OBJECT IDENTIFIER ::= + {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) umts-network(1) modules(3) + cap-errorcodes(57) version8(7)} + +classes OBJECT IDENTIFIER ::= + {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) umts-network(1) modules(3) + cap-classes(54) version8(7)} + +gsmSSF-gsmSCF-Operations OBJECT IDENTIFIER ::= + {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) umts-network(1) modules(3) + cap-gsmSSF-gsmSCF-ops-args(101) version8(7)} +-- The Object Identifier 'gsmSSF-gsmSCF-Operations' is updated to version8(7) in Rel-6, so +-- other modules can IMPORT Rel-6 Operation definitions related to call control. + +gsmSSF-gsmSCF-Protocol OBJECT IDENTIFIER ::= + {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) umts-network(1) modules(3) + cap-gsmSSF-gsmSCF-pkgs-contracts-ac(102) version8(7)} +-- The Object Identifier 'gsmSSF-gsmSCF-Protocol' is updated to version8(7) in Rel-6, so +-- other modules can IMPORT Rel-6 Protocol definitions related to call control. + +gsmSCF-gsmSRF-Operations OBJECT IDENTIFIER ::= + {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) umts-network(1) modules(3) + cap-gsmSCF-gsmSRF-ops-args(103) version8(7)} +-- The Object Identifier 'gsmSCF-gsmSRF-Operations' is updated to version8(7) in Rel-6, so +-- other modules can IMPORT Rel-6 Operation definitions related to gsmSRF control. + +gsmSCF-gsmSRF-Protocol OBJECT IDENTIFIER ::= + {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) umts-network(1) modules(3) + cap-gsmSCF-gsmSRF-pkgs-contracts-ac(104) version8(7)} +-- The Object Identifier 'gsmSCF-gsmSRF-Protocol' is updated to version8(7) in Rel-6, so +-- other modules can IMPORT Rel-6 Protocol definitions related to gsmSRF control. + +sms-Operations OBJECT IDENTIFIER ::= + {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) umts-network(1) modules(3) + cap-SMS-ops-args(105) version8(7)} +-- The Object Identifier 'sms-Operations' is updated to version8(7) in Rel-6, so other +-- modules can IMPORT Rel-6 Operation definitions related to SMS control. + +smsSSF-gsmSCF-Protocol OBJECT IDENTIFIER ::= + {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) umts-network(1) modules(3) + cap-smsSSF-gsmSCF-pkgs-contracts-ac(106) version8(7)} +-- The Object Identifier 'smsSSF-gsmSCF-Protocol' is updated to version8(7) in Rel-6, so +-- other modules can IMPORT Rel-6 Protocol definitions related to SMS control. + +gprsSSF-gsmSCF-Operations OBJECT IDENTIFIER ::= + {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) umts-network(1) modules(3) + cap-GPRS-ops-args(107) version8(7)} +-- The Object Identifier 'gprsSSF-gsmSCF-Operations' is updated to version8(7) in Rel-6, so +-- other modules can IMPORT Rel-6 Operation definitions related to GPRS control. + +gprsSSF-gsmSCF-Protocol OBJECT IDENTIFIER ::= + {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) umts-network(1) modules(3) + cap-gprsSSF-gsmSCF-pkgs-contracts-ac(108) version8(7)} +-- The Object Identifier 'gprsSSF-gsmSCF-Protocol' is updated to version8(7) in Rel-6, so +-- other modules can IMPORT Rel-6 Protocol definitions related to GPRS control. + +id-CAP OBJECT IDENTIFIER ::= + {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) + umts-network(1) cap4(22)} +``` + +``` + +id-CAP3 OBJECT IDENTIFIER ::= + {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) + umts-network(1) cap3(20)} + +id-CAPOE OBJECT IDENTIFIER ::= + {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) + umts-network(1) cap4OE(23)} + +id-CAP3OE OBJECT IDENTIFIER ::= + {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) + umts-network(1) cap3OE(21)} + +id-ac OBJECT IDENTIFIER ::= {id-CAP ac(3)} +id-acE OBJECT IDENTIFIER ::= {id-CAPOE ac(3)} +id-ac3E OBJECT IDENTIFIER ::= {id-CAP3OEac(3)} +id-as OBJECT IDENTIFIER ::= {id-CAP as(5)} +id-asE OBJECT IDENTIFIER ::= {id-CAPOE as(5)} +id-rosObject OBJECT IDENTIFIER ::= {id-CAP rosObject(25)} +id-contract OBJECT IDENTIFIER ::= {id-CAP contract(26)} +id-contract3 OBJECT IDENTIFIER ::= {id-CAP3 contract(26)} +id-contractE OBJECT IDENTIFIER ::= {id-CAPOE contract(26)} +id-package OBJECT IDENTIFIER ::= {id-CAP package(27)} +id-packageE OBJECT IDENTIFIER ::= {id-CAPOE package(27)} + +-- for ac, as, rosObject, contract and package, the values are identical to ITU-T Recommendation +-- Q.1218 [49] + +-- ROS Objects + +id-rosObject-gsmSCF OBJECT IDENTIFIER ::= {id-rosObject 4} +id-rosObject-gsmSSF OBJECT IDENTIFIER ::= {id-rosObject 5} +id-rosObject-gsmSRF OBJECT IDENTIFIER ::= {id-rosObject 6} +id-rosObject-gprsSSF OBJECT IDENTIFIER ::= {id-rosObject 7} +id-rosObject-smsSSF-V3 OBJECT IDENTIFIER ::= {id-rosObject 8} +id-rosObject-smsSSF-V4 OBJECT IDENTIFIER ::= {id-rosObject 9} + +-- Application Contexts + +-- gsmSSF/gsmSCF AC +id-ac-CAP-gsmSSF-scfGenericAC OBJECT IDENTIFIER ::= {id-acE 4} +id-ac-CAP-gsmSSF-scfAssistHandoffAC OBJECT IDENTIFIER ::= {id-acE 6} +id-ac-CAP-scf-gsmSSFGenericAC OBJECT IDENTIFIER ::= {id-acE 8} + +-- gsmSRF/gsmSCF AC +id-ac-gsmSRF-gsmSCF OBJECT IDENTIFIER ::= {id-ac 14} + +-- gprsSSF/gsmSCF AC +id-ac-CAP-gprsSSF-gsmSCF-AC OBJECT IDENTIFIER ::= {id-ac3E 50} +id-ac-CAP-gsmSCF-gprsSSF-AC OBJECT IDENTIFIER ::= {id-ac3E 51} + +-- gprsSSF/gsmSCF or gsmSSF/gsmSCF AC +id-ac-cap3-sms-AC OBJECT IDENTIFIER ::= {id-ac3E 61} +id-ac-cap4-sms-AC OBJECT IDENTIFIER ::= {id-acE 61} + +-- Contracts + +-- gsmSSF/gsmSCF Contracts +id-CAPSSfToScfGeneric OBJECT IDENTIFIER ::= {id-contractE 3} +id-CAPAssistHandoffssfToScf OBJECT IDENTIFIER ::= {id-contractE 5} +id-CAPScfToSsfGeneric OBJECT IDENTIFIER ::= {id-contractE 6} + +-- gsmSRF/gsmSCF Contracts +id-contract-gsmSRF-gsmSCF OBJECT IDENTIFIER ::= {id-contract 13} + +-- gprsSSF/gsmSCF Contracts +id-capGprsSsfToGsmScf OBJECT IDENTIFIER ::= {id-contract 14} +id-capGsmScfToGprsSsf OBJECT IDENTIFIER ::= {id-contract 15} + +-- gprsSSF/gsmSCF or gsmSSF/gsmSCF Contracts +id-cap3SmsSsfToGsmScf OBJECT IDENTIFIER ::= {id-contract3 16} +id-cap4SmsSsfToGsmScf OBJECT IDENTIFIER ::= {id-contract 16} + +``` + +``` + +-- Operation Packages + +-- gsmSSF/gsmSCF Operation Packages +id-package-scfActivation OBJECT IDENTIFIER ::= {id-package 11} +id-package-gsmSRF-scfActivationOfAssist OBJECT IDENTIFIER ::= {id-package 15} +id-package-assistConnectionEstablishment OBJECT IDENTIFIER ::= {id-package 16} +id-package-genericDisconnectResource OBJECT IDENTIFIER ::= {id-package 17} +id-package-nonAssistedConnectionEstablishment OBJECT IDENTIFIER ::= {id-package 18} +id-package-connect OBJECT IDENTIFIER ::= {id-package 19} +id-package-callHandling OBJECT IDENTIFIER ::= {id-packageE 20} +id-package-bcsmEventHandling OBJECT IDENTIFIER ::= {id-package 21} +id-package-ssfCallProcessing OBJECT IDENTIFIER ::= {id-packageE 24} +id-package-scfCallInitiation OBJECT IDENTIFIER ::= {id-package 25} +id-package-timer OBJECT IDENTIFIER ::= {id-package 26} +id-package-billing OBJECT IDENTIFIER ::= {id-package 27} +id-package-charging OBJECT IDENTIFIER ::= {id-package 28} +id-package-trafficManagement OBJECT IDENTIFIER ::= {id-package 29} +id-package-callReport OBJECT IDENTIFIER ::= {id-package 32} +id-package-signallingControl OBJECT IDENTIFIER ::= {id-package 33} +id-package-activityTest OBJECT IDENTIFIER ::= {id-package 34} +id-package-cancel OBJECT IDENTIFIER ::= {id-packageE 36} +id-package-cphResponse OBJECT IDENTIFIER ::= {id-package 37} +id-package-exceptionInform OBJECT IDENTIFIER ::= {id-package 38} +id-package-playTone OBJECT IDENTIFIER ::= {id-package 39} + +-- gsmSRF/gsmSCF Operation Packages +id-package-specializedResourceControl OBJECT IDENTIFIER ::= {id-package 42} +id-package-gsmSRF-scfCancel OBJECT IDENTIFIER ::= {id-package 43} + +-- gprsSSF/gsmSCF Operation Packages +id-package-gprsContinue OBJECT IDENTIFIER ::= {id-package 49} +id-package-gprsExceptionInformation OBJECT IDENTIFIER ::= {id-package 50} +id-package-gprsScfActivation OBJECT IDENTIFIER ::= {id-package 51} +id-package-gprsConnect OBJECT IDENTIFIER ::= {id-package 52} +id-package-gprsRelease OBJECT IDENTIFIER ::= {id-package 53} +id-package-gprsEventHandling OBJECT IDENTIFIER ::= {id-package 54} +id-package-gprsTimer OBJECT IDENTIFIER ::= {id-package 55} +id-package-gprsBilling OBJECT IDENTIFIER ::= {id-package 56} +id-package-gprsCharging OBJECT IDENTIFIER ::= {id-package 57} +id-package-gprsActivityTest OBJECT IDENTIFIER ::= {id-package 58} +id-package-gprsCancel OBJECT IDENTIFIER ::= {id-package 59} +id-package-gprsChargeAdvice OBJECT IDENTIFIER ::= {id-package 60} + +-- gprsSSF/gsmSCF or gsmSSF/gsmSCF Operation Packages +id-package-smsActivation OBJECT IDENTIFIER ::= {id-package 61} +id-package-smsConnect OBJECT IDENTIFIER ::= {id-package 62} +id-package-smsContinue OBJECT IDENTIFIER ::= {id-package 63} +id-package-smsRelease OBJECT IDENTIFIER ::= {id-package 64} +id-package-smsEventHandling OBJECT IDENTIFIER ::= {id-package 65} +id-package-smsBilling OBJECT IDENTIFIER ::= {id-package 66} +id-package-smsTimer OBJECT IDENTIFIER ::= {id-package 67} + +-- Abstract Syntaxes + +-- gsmSSF/gsmSCF Abstract Syntaxes +id-as-gsmSSF-scfGenericAS OBJECT IDENTIFIER ::= {id-asE 4} +id-as-assistHandoff-gsmSSF-scfAS OBJECT IDENTIFIER ::= {id-asE 6} +id-as-scf-gsmSSFGenericAS OBJECT IDENTIFIER ::= {id-asE 7} + +-- gsmSRF/gsmSCF Abstract Syntaxes +id-as-basic-gsmSRF-gsmSCF OBJECT IDENTIFIER ::= {id-as 14} + +-- gprsSSF/gsmSCF Abstract Syntaxes +id-as-gprsSSF-gsmSCF-AS OBJECT IDENTIFIER ::= {id-as 50} +id-as-gsmSCF-gprsSSF-AS OBJECT IDENTIFIER ::= {id-as 51} + +-- gprsSSF/gsmSCF or gsmSSF/gsmSCF Abstract Syntaxes +id-as-smsSSF-gsmSCF-AS OBJECT IDENTIFIER ::= {id-as 61} + +END + +``` + +## 5.7 User Abort Data + +CAP-U-ABORT-Data {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) umts-network(1) modules(3) cap-u-abort-data(110) version8(7)} + +DEFINITIONS ::= BEGIN + +id-CAP-U-ABORT-Reason OBJECT IDENTIFIER ::= {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) umts-Network(1) as(1) cap-u-abort-reason(2) version3(2)} + +cap-U-ABORT-Reason-Abstract-Syntax ABSTRACT-SYNTAX ::= {CAP-U-ABORT-REASON IDENTIFIED BY id-CAP-U-ABORT-Reason} + +CAP-U-ABORT-REASON ::= ENUMERATED { + +no-reason-given (1), + application-timer-expired (2), + not-allowed-procedures (3), + abnormal-processing (4), + congestion (5), + invalid-reference (6), + missing-reference (7), + overlapping-dialogue (8) +} + +-- application-timer-expired shall be set when application timer (e.g. Tssf) is expired. + -- not-allowed-procedures shall be set when received signal is not allowed in CAP procedures. + -- For example, when a class 4 operation is received from the gsmSCF and the operation is not allowed in gsmSSF FSM. (gsmSSF FSM cannot continue state transition). (e.g. ReleaseCall operation received in Waiting for End of Temporary Connection state.) + -- abnormal-processing shall be set when abnormal procedures occur at entity action. + -- congestion shall be set when requested resource is unavailable due to congestion at TC user (CAP) level. + -- invalid-reference shall be set if the received destinationReference is unknown or for a known destination Reference the received originationReference does not match with the stored originationReference. + -- This abort reason is used for CAP defined GPRS-ReferenceNumber. + -- missing-reference shall be set when the destinationReference or the originationReference is absent in the received message but is required to be present according to the procedures in subclause 14.1.7. + -- This abort reason is used for CAP defined GPRS-ReferenceNumber. + -- overlapping-dialogue shall be used by the gprsSSF to indicate to the gsmSCF that a specific instance already has a TC dialogue open. This error cause is typically obtained when both the gsmSCF and gprsSSF open a new dialogue at the same time. + -- no-reason-given shall be set when any other reasons above do not apply + END -- of CAP-U-ABORT-Data + +## 6 Circuit Switched Call Control + +### 6.1 gsmSSF/CCF - gsmSCF Interface + +#### 6.1.1 Operations and arguments + +cap-gsmSSF-gsmSCF-ops-args {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) umts-network(1) modules(3) cap-gsmSSF-gsmSCF-ops-args(101) version8(7)} + +DEFINITIONS IMPLICIT TAGS ::= BEGIN + +-- This module contains the operations and operation arguments used for the + -- gsmSSF - gsmSCF interface, for the control of circuit switched calls. + -- The table in subclause 2.1 lists the specifications that contain the modules + -- that are used by CAP. + +IMPORTS + +``` +errortypes, +datatypes, +operationcodes, +classes, +tc-Messages, +ros-InformationObjects +FROM CAP-object-identifiers {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) +umts-network(1) modules(3) cap-object-identifiers(100) version8(7)} + +OPERATION +FROM Remote-Operations-Information-Objects ros-InformationObjects + +CallingPartysCategory, +HighLayerCompatibility, +LegID, +RedirectionInformation, +ServiceKey +FROM CS1-DataTypes {itu-t(0) identified-organization(4) etsi(0) inDomain(1) in-network(1) +modules(0) cs1-datatypes(2) version1(0)} + +MiscCallInfo +FROM CS2-datatypes {itu-t(0) identified-organization(4) etsi(0) inDomain(1) in-network(1) +cs2(20) modules(0) in-cs2-datatypes(0) version1(0)} + +Ext-BasicServiceCode, +IMEI, +IMSI, +ISDN-AddressString +FROM MAP-CommonDataTypes {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) +gsm-Network(1) modules(3) map-CommonDataTypes(18) version12(12)} + +CUG-Index, +CUG-Interlock, +CUG-Info, +LocationInformation, +MS-Classmark2, +SubscriberState, +SupportedCamelPhases, +OfferedCamel4Functionalities +FROM MAP-MS-DataTypes {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) +gsm-Network(1) modules(3) map-MS-DataTypes(11) version12(12)} + +CallReferenceNumber, +SuppressionOfAnnouncement, +UU-Data +FROM MAP-CH-DataTypes {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) +gsm-Network(1) modules(3) map-CH-DataTypes(13) version12(12)} + +PARAMETERS-BOUND +FROM CAP-classes classes + +opcode-activityTest, +opcode-applyCharging, +opcode-applyChargingReport, +opcode-assistRequestInstructions, +opcode-callGap, +opcode-callInformationReport, +opcode-callInformationRequest, +opcode-cancel, +opcode-collectInformation, +opcode-connect, +opcode-connectToResource, +opcode-continue, +opcode-continueWithArgument, +opcode-disconnectForwardConnection, +opcode-dFCWithArgument, +opcode-disconnectLeg, +opcode-entityReleased, +opcode-establishTemporaryConnection, +opcode-eventReportBCSM, +opcode-furnishChargingInformation, +opcode-initialDP, +opcode-initiateCallAttempt, +opcode-moveLeg, +opcode-playTone, +opcode-releaseCall, +opcode-requestReportBCSMEVENT, +``` + +``` +opcode-resetTimer, +opcode-sendChargingInformation, +opcode-splitLeg +FROM CAP-operationcodes operationcodes +-- The CAP Operation identifiers for CAP V4 in Rel-6 are the same as the CAP Operation +-- identifiers for CAP V4 in Rel-5. + +AChBillingChargingCharacteristics {}, +AdditionalCallingPartyNumber {}, +AlertingPattern, +AChChargingAddress {}, +AssistingSSPIPRoutingAddress {}, +BCSMEVENT {}, +BCSM-Failure, +BearerCapability {}, +Burst, +CalledPartyNumber {}, +CalledPartyBCDNumber {}, +CallingPartyNumber {}, +CallResult {}, +CallSegmentID {}, +CallSegmentToCancel {}, +CallSegmentFailure {}, +Carrier, +Cause {}, +CGEncountered, +ChargeNumber {}, +ControlType, +CorrelationID {}, +DestinationRoutingAddress {}, +EventSpecificInformationBCSM {}, +EventTypeBCSM, +Extensions {}, +FCIBillingChargingCharacteristics {}, +GapCriteria {}, +GapIndicators, +GapTreatment, +GenericNumbers {}, +InvokeID, +IPRoutingAddress {}, +IPSSPCapabilities {}, +leg1, +leg2, +LegOrCallSegment {}, +LocationNumber {}, +LowLayerCompatibility {}, +MonitorMode, +NAOLiInfo, +OCSIApplicable, +OriginalCalledPartyID {}, +ReceivingSideID, +RedirectingPartyID {}, +RequestedInformationList {}, +RequestedInformationTypeList, +ScfID {}, +SCIBillingChargingCharacteristics {}, +SendingSideID, +ServiceInteractionIndicatorsTwo, +TimeAndTimezone {}, +TimerID, +TimerValue +FROM CAP-datatypes datatypes +-- For Rel-6, the CAP-datatypes module is updated to version8(7); Object Identifier 'datatypes' +-- is also updated to version8(7). As a result, the present module uses Rel-6 data type definitions. + +cancelFailed, +eTCFailed, +missingCustomerRecord, +missingParameter, +parameterOutOfRange, +requestedInfoError, +systemFailure, +taskRefused, +unexpectedComponentSequence, +unexpectedDataValue, +unexpectedParameter, +unknownLegID, +unknownCSID +``` + +``` + +FROM CAP-errortypes errortypes +-- For Rel-6, the CAP-errortypes module is updated to version8(7); Object Identifier +-- 'errortypes' is also updated to version8(7). As a result, the present module uses Rel-6 +-- error type definitions. + +; + +activityTest OPERATION ::= { + RETURN RESULT TRUE + CODE opcode-activityTest} +-- Direction: gsmSCF -> gsmSSF, Timer: Tat +-- This operation is used to check for the continued existence of a relationship +-- between the gsmSCF and gsmSSF, assist gsmSSF or gsmSRF. If the relationship is +-- still in existence, then the gsmSSF will respond. If no reply is received, +-- then the gsmSCF will assume that the gsmSSF, assist gsmSSF or gsmSRF has failed +-- in some way. + +applyCharging {PARAMETERS-BOUND : bound} OPERATION ::= { + ARGUMENT ApplyChargingArg {bound} + RETURN RESULT FALSE + ERRORS {missingParameter | + unexpectedComponentSequence | + unexpectedParameter | + unexpectedDataValue | + parameterOutOfRange | + systemFailure | + taskRefused | + unknownLegID | + unknownCSID} + CODE opcode-applyCharging} +-- Direction: gsmSCF -> gsmSSF, Timer: Tac +-- This operation is used for interacting from the gsmSCF with the gsmSSF charging mechanisms. +-- The ApplyChargingReport operation provides the feedback from the gsmSSF to the gsmSCF. + +ApplyChargingArg {PARAMETERS-BOUND : bound} ::= SEQUENCE { + aChBillingChargingCharacteristics [0] AChBillingChargingCharacteristics {bound}, + partyToCharge [2] SendingSideID DEFAULT sendingSideID : leg1, + extensions [3] Extensions {bound} OPTIONAL, + aChChargingAddress [50] AChChargingAddress {bound} + DEFAULT legID:sendingSideID:leg1, + ... +} + +-- The partyToCharge parameter indicates the party in the call to which the ApplyCharging operation +-- shall be applied. + +applyChargingReport {PARAMETERS-BOUND : bound} OPERATION ::= { + ARGUMENT ApplyChargingReportArg {bound} + RETURN RESULT FALSE + ERRORS {missingParameter | + unexpectedComponentSequence | + unexpectedParameter | + unexpectedDataValue | + unknownCSID | + unknownLegID | + parameterOutOfRange | + systemFailure | + taskRefused} + CODE opcode-applyChargingReport} +-- Direction: gsmSSF -> gsmSCF, Timer: Tacr +-- This operation is used by the gsmSSF to report to the gsmSCF the occurrence of a +-- specific charging event as requested by the gsmSCF using the ApplyCharging operation. + +ApplyChargingReportArg {PARAMETERS-BOUND : bound} ::= CallResult {bound} + +assistRequestInstructions {PARAMETERS-BOUND : bound} OPERATION ::= { + ARGUMENT AssistRequestInstructionsArg {bound} + RETURN RESULT FALSE + ERRORS {missingCustomerRecord | + missingParameter | + systemFailure | + taskRefused | + unexpectedComponentSequence | + unexpectedDataValue | + unexpectedParameter} + CODE opcode-assistRequestInstructions} +-- Direction: gsmSSF -> gsmSCF or gsmSRF -> gsmSCF, Timer: Tari + +``` + +``` + +-- This operation is used when there is an assist procedure and may be +-- sent by the gsmSSF or gsmSRF to the gsmSCF. This operation is sent by the +-- assisting gsmSSF to gsmSCF, when the initiating gsmSSF has set up a connection to +-- the gsmSRF or to the assisting gsmSSF as a result of receiving an +-- EstablishTemporaryConnection from +-- the gsmSCF. +-- Refer to clause 11 for a description of the procedures associated with this operation. + +AssistRequestInstructionsArg {PARAMETERS-BOUND : bound} ::= SEQUENCE { + correlationID [0] CorrelationID {bound}, + iPSSPCapabilities [2] IPSSPCapabilities {bound}, + extensions [3] Extensions {bound} OPTIONAL, + ... +} + +-- OPTIONAL denotes network operator specific use. The value of the correlationID may be the +-- Called Party Number supplied by the initiating gsmSSF. + +callGap {PARAMETERS-BOUND : bound} OPERATION ::= { + ARGUMENT CallGapArg {bound} + RETURN RESULT FALSE + ALWAYS RESPONDS FALSE + CODE opcode-callGap} +-- Direction: gsmSCF -> gsmSSF, Timer: Tcg +-- This operation is used to request the gsmSSF to reduce the rate at which specific service +-- requests are sent to the gsmSCF. + +CallGapArg {PARAMETERS-BOUND : bound} ::= SEQUENCE { + gapCriteria [0] GapCriteria {bound}, + gapIndicators [1] GapIndicators, + controlType [2] ControlType OPTIONAL, + gapTreatment [3] GapTreatment {bound} OPTIONAL, + extensions [4] Extensions {bound} OPTIONAL, + ... +} + +-- OPTIONAL denotes network operator optional. If gapTreatment is not present, then the gsmSSF will +-- use a default treatment depending on network operator implementation. + +callInformationReport {PARAMETERS-BOUND : bound} OPERATION ::= { + ARGUMENT CallInformationReportArg {bound} + RETURN RESULT FALSE + ALWAYS RESPONDS FALSE + CODE opcode-callInformationReport} +-- Direction: gsmSSF -> gsmSCF, Timer: Tcirp +-- This operation is used to send specific call information for a single call party to the gsmSCF as +-- requested by the gsmSCF in a previous CallInformationRequest. + +CallInformationReportArg {PARAMETERS-BOUND : bound} ::= SEQUENCE { + requestedInformationList [0] RequestedInformationList {bound}, + extensions [2] Extensions {bound} OPTIONAL, + legID [3] ReceivingSideID DEFAULT receivingSideID:leg2, + ... +} + +callInformationRequest {PARAMETERS-BOUND : bound} OPERATION ::= { + ARGUMENT CallInformationRequestArg {bound} + RETURN RESULT FALSE + ERRORS {missingParameter | + parameterOutOfRange | + requestedInfoError | + systemFailure | + taskRefused | + unexpectedComponentSequence | + unexpectedDataValue | + unexpectedParameter | + unknownLegID} + CODE opcode-callInformationRequest} +-- Direction: gsmSCF -> gsmSSF, Timer: Tcirq +-- This operation is used to request the gsmSSF to record specific information about a single +-- call party and report it to the gsmSCF (with a CallInformationReport operation). + +CallInformationRequestArg {PARAMETERS-BOUND : bound} ::= SEQUENCE { + requestedInformationTypeList [0] RequestedInformationTypeList, + extensions [2] Extensions {bound} OPTIONAL, + legID [3] SendingSideID DEFAULT sendingSideID:leg2, + ... +} + +-- OPTIONAL denotes network operator optional. + +``` + +``` + +cancel {PARAMETERS-BOUND : bound} OPERATION ::= { + ARGUMENT CancelArg {bound} + RETURN RESULT FALSE + ERRORS {cancelFailed | + missingParameter | + taskRefused | + unknownCSID} + CODE opcode-cancel} +-- Direction: gsmSCF -> gsmSSF, or gsmSCF -> gsmSRF, Timer: Tcan +-- This operation cancels the correlated previous operation or all previous requests. The following +-- operations can be canceled: PlayAnnouncement, PromptAndCollectUserInformation. + +CancelArg {PARAMETERS-BOUND : bound} ::= CHOICE { + invokeID [0] InvokeID, + allRequests [1] NULL, + callSegmentToCancel [2] CallSegmentToCancel {bound} +} +-- The InvokeID has the same value as that which was used for the operation to be cancelled. + +collectInformation {PARAMETERS-BOUND : bound} OPERATION ::= { + ARGUMENT CollectInformationArg {bound} + RETURN RESULT FALSE + ERRORS {missingParameter | + parameterOutOfRange | + SystemFailure | + TaskRefused | + UnexpectedComponentSequence | + UnexpectedDataValue | + UnexpectedParameter} + CODE opcode-collectInformation} +-- Direction: gsmSCF-> gsmSSF, Timer: Tci +-- This operation is used to request the gsmSSF to perform the call +-- processing actions to prompt a calling party for additional digits. + +CollectInformationArg {PARAMETERS-BOUND : bound} ::= SEQUENCE{ + extensions [0] Extensions {bound} OPTIONAL, + ... +} + +connect {PARAMETERS-BOUND : bound} OPERATION ::= { + ARGUMENT ConnectArg {bound} + RETURN RESULT FALSE + ERRORS {missingParameter | + parameterOutOfRange | + systemFailure | + taskRefused | + unexpectedComponentSequence | + unexpectedDataValue | + unexpectedParameter | + unknownLegID} + CODE opcode-connect} +-- Direction: gsmSCF-> gsmSSF, Timer: Tcon +-- This operation is used to request the gsmSSF to perform the call processing actions +-- to route or forward a call to a specified destination. + +ConnectArg {PARAMETERS-BOUND : bound} ::= SEQUENCE { + destinationRoutingAddress [0] DestinationRoutingAddress {bound}, + alertingPattern [1] AlertingPattern OPTIONAL, + originalCalledPartyID [6] OriginalCalledPartyID {bound} OPTIONAL, + extensions [10] Extensions {bound} OPTIONAL, + carrier [11] Carrier {bound} OPTIONAL, + callingPartysCategory [28] CallingPartysCategory OPTIONAL, + redirectingPartyID [29] RedirectingPartyID {bound} OPTIONAL, + redirectionInformation [30] RedirectionInformation OPTIONAL, + genericNumbers [14] GenericNumbers {bound} OPTIONAL, + serviceInteractionIndicatorsTwo [15] ServiceInteractionIndicatorsTwo OPTIONAL, + chargeNumber [19] ChargeNumber {bound} OPTIONAL, + legToBeConnected [21] LegID OPTIONAL, + cug-Interlock [31] CUG-Interlock OPTIONAL, + cug-OutgoingAccess [32] NULL OPTIONAL, + suppressionOfAnnouncement [55] SuppressionOfAnnouncement OPTIONAL, + oCSIApplicable [56] OCSIApplicable OPTIONAL, + naOliInfo [57] NAOLIInfo OPTIONAL, + bor-InterrogationRequested [58] NULL OPTIONAL, + ... / + suppress-N-CSI [59] NULL OPTIONAL +} +-- na-Info is included at the discretion of the gsmSCF operator. + +``` + +``` + +connectToResource {PARAMETERS-BOUND : bound} OPERATION ::= { + ARGUMENT ConnectToResourceArg {bound} + RETURN RESULT FALSE + ERRORS {missingParameter | + systemFailure | + taskRefused | + unexpectedComponentSequence | + unexpectedDataValue | + unexpectedParameter | + unknownCSID} + CODE opcode-connectToResource} +-- Direction: gsmSCF -> gsmSSF, Timer: Tctr +-- This operation is used to connect a call segment from the gsmSSF to the +-- gsmSRF. + +ConnectToResourceArg {PARAMETERS-BOUND : bound} ::= SEQUENCE { + resourceAddress CHOICE { + ipRoutingAddress [0] IPRoutingAddress {bound}, + none [3] NULL + }, + extensions [4] Extensions {bound} OPTIONAL, + serviceInteractionIndicatorsTwo [7] ServiceInteractionIndicatorsTwo OPTIONAL, + callSegmentID [50] CallSegmentID {bound} OPTIONAL, + ... +} + +continue OPERATION ::= { + RETURN RESULT FALSE + ALWAYS RESPONDS FALSE + CODE opcode-continue} +-- Direction: gsmSCF -> gsmSSF, Timer: Tcue +-- This operation is used to request the gsmSSF to proceed with call processing at the +-- DP at which it previously suspended call processing to await gsmSCF instructions +-- (i.e. proceed to the next point in call in the BCSM). The gsmSSF continues call +-- processing without substituting new data from gsmSCF. + +continueWithArgument {PARAMETERS-BOUND : bound} OPERATION ::= { + ARGUMENT ContinueWithArgumentArg {bound} + RETURN RESULT FALSE + ERRORS {missingParameter | + parameterOutOfRange | + unexpectedComponentSequence | + unexpectedDataValue | + unexpectedParameter | + unknownLegID | + unknownCSID} + CODE opcode-continueWithArgument} +-- Direction: gsmSCF -> gsmSSF, Timer: Tcwa +-- This operation is used to request the gsmSSF to proceed with call processing at the +-- DP at which it previously suspended call processing to await gsmSCF instructions +-- (i.e. proceed to the next point in call in the BCSM). The gsmSSF continues call +-- processing with the modified call setup information as received from the gsmSCF. + +ContinueWithArgumentArg {PARAMETERS-BOUND : bound} ::= SEQUENCE { + alertingPattern [1] AlertingPattern OPTIONAL, + extensions [6] Extensions {bound} OPTIONAL, + serviceInteractionIndicatorsTwo [7] ServiceInteractionIndicatorsTwo OPTIONAL, + callingPartysCategory [12] CallingPartysCategory OPTIONAL, + genericNumbers [16] GenericNumbers {bound} OPTIONAL, + cug-Interlock [17] CUG-Interlock OPTIONAL, + cug-OutgoingAccess [18] NULL OPTIONAL, + chargeNumber [50] ChargeNumber {bound} OPTIONAL, + carrier [52] Carrier {bound} OPTIONAL, + suppressionOfAnnouncement [55] SuppressionOfAnnouncement OPTIONAL, + naOliInfo [56] NAOLIInfo OPTIONAL, + bor-InterrogationRequested [57] NULL OPTIONAL, + suppress-O-CSI [58] NULL OPTIONAL, + continueWithArgumentArgExtension [59] ContinueWithArgumentArgExtension {bound} OPTIONAL, + ... +} + +ContinueWithArgumentArgExtension {PARAMETERS-BOUND : bound} ::= SEQUENCE { + suppress-D-CSI [0] NULL OPTIONAL, + suppress-N-CSI [1] NULL OPTIONAL, + suppressOutgoingCallBarring [2] NULL OPTIONAL, + legOrCallSegment [3] LegOrCallSegment {bound} OPTIONAL, + ... +} + +``` + +``` + + } + + disconnectForwardConnection OPERATION ::= { + RETURN RESULT FALSE + ERRORS {systemFailure | + taskRefused | + unexpectedComponentSequence} + CODE opcode-disconnectForwardConnection} + -- Direction: gsmSCF -> gsmSSF, Timer: Tdfc + -- This operation is used to disconnect a forward temporary connection or a connection to a + -- resource. Refer to clause 11 for a description of the procedures associated with this operation. + + disconnectForwardConnectionWithArgument {PARAMETERS-BOUND : bound} OPERATION ::= { + ARGUMENT DisconnectForwardConnectionWithArgumentArg {bound} + RETURN RESULT FALSE + ERRORS {missingParameter | + systemFailure | + taskRefused | + unexpectedComponentSequence | + unexpectedDataValue | + unexpectedParameter | + unknownCSID} + CODE opcode-dFCWithArgument} + -- Direction gsmSCF -> gsmSSF, Timer Tdfcwa + -- This operation is used to disconnect a forward temporary connection or a connection to a + -- resource. Refer to clause 11 for a description of the procedures associated with this operation. + + DisconnectForwardConnectionWithArgumentArg {PARAMETERS-BOUND : bound} ::= SEQUENCE { + callSegmentID [1] CallSegmentID {bound} OPTIONAL, + extensions [2] Extensions {bound} OPTIONAL, + ... + } + + disconnectLeg {PARAMETERS-BOUND : bound} OPERATION ::= { + ARGUMENT DisconnectLegArg {bound} + RETURN RESULT TRUE + ERRORS {missingParameter | + systemFailure | + taskRefused | + unexpectedComponentSequence | + unexpectedDataValue | + unexpectedParameter | + unknownLegID} + CODE opcode-disconnectLeg} + -- Direction: gsmSCF -> gsmSSF, Timer Tdl + -- This operation is used by the gsmSCF to release a specific leg associated with the call and + -- retain any other legs not specified in the DisconnectLeg. Refer to clause 11 for a description + -- of the procedures associated with this operation. + + DisconnectLegArg {PARAMETERS-BOUND : bound} ::= SEQUENCE { + legToBeReleased [0] LegID, + releaseCause [1] Cause {bound} OPTIONAL, + extensions [2] Extensions {bound} OPTIONAL, + ... + } + + entityReleased {PARAMETERS-BOUND : bound} OPERATION ::= { + ARGUMENT EntityReleasedArg {bound} + RETURN RESULT FALSE + ALWAYS RESPONDS FALSE + CODE opcode-entityReleased} + -- Direction: gsmSSF -> gsmSCF, Timer: Ter + -- This operation is used by the gsmSSF to inform the gsmSCF of an error or exception + + EntityReleasedArg {PARAMETERS-BOUND : bound} ::= CHOICE { + callSegmentFailure [0] CallSegmentFailure {bound}, + bCSM-Failure [1] BCSM-Failure {bound} + } + + establishTemporaryConnection {PARAMETERS-BOUND : bound} OPERATION ::= { + ARGUMENT EstablishTemporaryConnectionArg {bound} + RETURN RESULT FALSE + ERRORS {eTCFailed | + missingParameter | + systemFailure | + taskRefused | + unexpectedComponentSequence | + +``` + +``` + + unexpectedDataValue | + unexpectedParameter | + unknownCSID} + CODE + opcode-establishTemporaryConnection} +-- Direction: gsmSCF -> gsmSSF, Timer: Tetc +-- This operation is used to create a connection to a resource for a limited period +-- of time (e.g. to play an announcement, to collect user information); it implies +-- the use of the assist procedure. Refer to clause 11 for a description of the +-- procedures associated with this operation. + +EstablishTemporaryConnectionArg {PARAMETERS-BOUND : bound} ::= SEQUENCE { + assistingSSPIRoutingAddress [0] AssistingSSPIRoutingAddress {bound}, + correlationID [1] CorrelationID {bound} OPTIONAL, + scfID [3] ScfID {bound} OPTIONAL, + extensions [4] Extensions {bound} OPTIONAL, + carrier [5] Carrier {bound} OPTIONAL, + serviceInteractionIndicatorsTwo [6] ServiceInteractionIndicatorsTwo OPTIONAL, + callSegmentID [7] CallSegmentID {bound} OPTIONAL, + naOliInfo [50] NAOLiInfo OPTIONAL, + chargeNumber [51] ChargeNumber {bound} OPTIONAL, + ... + originalCalledPartyID [52] OriginalCalledPartyID {bound} OPTIONAL, + callingPartyNumber [53] CallingPartyNumber {bound} OPTIONAL +} + +eventReportBCSM {PARAMETERS-BOUND : bound} OPERATION ::= { + ARGUMENT EventReportBCSMArg {bound} + RETURN RESULT FALSE + ALWAYS RESPONDS FALSE + CODE + opcode-eventReportBCSM} +-- Direction: gsmSSF -> gsmSCF, Timer: Terb +-- This operation is used to notify the gsmSCF of a call-related event (e.g. BCSM +-- events such as O_Busy or O_No_Answer) previously requested by the gsmSCF in a +-- RequestReportBCSMEVENT operation. + +EventReportBCSMArg {PARAMETERS-BOUND : bound} ::= SEQUENCE { + eventTypeBCSM [0] EventTypeBCSM, + eventSpecificInformationBCSM [2] EventSpecificInformationBCSM {bound} OPTIONAL, + legID [3] ReceivingSideID OPTIONAL, + miscCallInfo [4] MiscCallInfo DEFAULT {messageType request}, + extensions [5] Extensions {bound} OPTIONAL, + ... +} + +furnishChargingInformation {PARAMETERS-BOUND : bound} OPERATION ::= { + ARGUMENT FurnishChargingInformationArg {bound} + RETURN RESULT FALSE + ERRORS {missingParameter | + taskRefused | + unexpectedComponentSequence | + unexpectedDataValue | + unexpectedParameter | + unknownLegID} + CODE + opcode-furnishChargingInformation} +-- Direction: gsmSCF -> gsmSSF, Timer: Tfci +-- This operation is used to request the gsmSSF to generate, register a call record +-- or to include some information in the default call record. +-- The registered call record is intended for off line charging of the call. + +FurnishChargingInformationArg {PARAMETERS-BOUND : bound} ::= + FCIBillingChargingCharacteristics{bound} + +initialDP {PARAMETERS-BOUND : bound} OPERATION ::= { + ARGUMENT InitialDPArg {bound} + RETURN RESULT FALSE + ERRORS {missingCustomerRecord | + missingParameter | + parameterOutOfRange | + systemFailure | + taskRefused | + unexpectedComponentSequence | + unexpectedDataValue | + unexpectedParameter} + CODE + opcode-initialDP} +-- Direction: gsmSSF -> gsmSCF, Timer: Tidp +-- This operation is used after a TDP to indicate request for service. + +``` + +``` + +InitialDPArg {PARAMETERS-BOUND : bound} ::= SEQUENCE { + serviceKey [0] ServiceKey , + calledPartyNumber [2] CalledPartyNumber {bound} OPTIONAL, + callingPartyNumber [3] CallingPartyNumber {bound} OPTIONAL, + callingPartysCategory [5] CallingPartysCategory OPTIONAL, + cGEncountered [7] CGEncountered OPTIONAL, + iPSSPCapabilities [8] IPSSPCapabilities {bound} OPTIONAL, + locationNumber [10] LocationNumber {bound} OPTIONAL, + originalCalledPartyID [12] OriginalCalledPartyID {bound} OPTIONAL, + extensions [15] Extensions {bound} OPTIONAL, + highLayerCompatibility [23] HighLayerCompatibility OPTIONAL, + additionalCallingPartyNumber [25] AdditionalCallingPartyNumber {bound} OPTIONAL, + bearerCapability [27] BearerCapability {bound} OPTIONAL, + eventTypeBCSM [28] EventTypeBCSM OPTIONAL, + redirectingPartyID [29] RedirectingPartyID {bound} OPTIONAL, + redirectionInformation [30] RedirectionInformation OPTIONAL, + cause [17] Cause {bound} OPTIONAL, + serviceInteractionIndicatorsTwo [32] ServiceInteractionIndicatorsTwo OPTIONAL, + carrier [37] Carrier {bound} OPTIONAL, + cug-Index [45] CUG-Index OPTIONAL, + cug-Interlock [46] CUG-Interlock OPTIONAL, + cug-OutgoingAccess [47] NULL OPTIONAL, + IMSI [50] IMSI OPTIONAL, + subscriberState [51] SubscriberState OPTIONAL, + locationInformation [52] LocationInformation OPTIONAL, + ext-basicServiceCode [53] Ext-BasicServiceCode OPTIONAL, + callReferenceNumber [54] CallReferenceNumber OPTIONAL, + mscAddress [55] ISDN-AddressString OPTIONAL, + calledPartyBCDNumber [56] CalledPartyBCDNumber {bound} OPTIONAL, + timeAndTimezone [57] TimeAndTimezone {bound} OPTIONAL, + callForwardingSS-Pending [58] NULL OPTIONAL, + initialDPArgExtension [59] InitialDPArgExtension {bound} OPTIONAL, + ... +} + +InitialDPArgExtension {PARAMETERS-BOUND : bound} ::= SEQUENCE { + gmscAddress [0] ISDN-AddressString OPTIONAL, + forwardingDestinationNumber [1] CalledPartyNumber {bound} OPTIONAL, + ms-Classmark2 [2] MS-Classmark2 OPTIONAL, + iMEI [3] IMEI OPTIONAL, + supportedCamelPhases [4] SupportedCamelPhases OPTIONAL, + offeredCamel4Functionalities [5] OfferedCamel4Functionalities OPTIONAL, + bearerCapability2 [6] BearerCapability {bound} OPTIONAL, + ext-basicServiceCode2 [7] Ext-BasicServiceCode OPTIONAL, + highLayerCompatibility2 [8] HighLayerCompatibility OPTIONAL, + lowLayerCompatibility [9] LowLayerCompatibility {bound} OPTIONAL, + lowLayerCompatibility2 [10] LowLayerCompatibility {bound} OPTIONAL, + .... + enhancedDialledServicesAllowed [11] NULL OPTIONAL, + uu-Data [12] UU-Data OPTIONAL, + collectInformationAllowed [13] NULL OPTIONAL, + releaseCallArgExtensionAllowed [14] NULL OPTIONAL +} + +-- If iPSSPCapabilities is not present then this denotes that a colocated gsmSRF is not +-- supported by the gsmSSF. If present, then the gsmSSF supports a colocated gsmSRF capable +-- of playing announcements via elementaryMessageIDs and variableMessages, the playing of +-- tones and the collection of DTMF digits. Other supported capabilities are explicitly +-- detailed in the IPSSPCapabilities parameter itself. +-- Carrier is included at the discretion of the gsmSSF operator. +-- The UserCSGInformation is conveyed in the LocationInformation. The encoding of the parameter is +-- as defined in 3GPP TS 29.002 [11]. + +initiateCallAttempt {PARAMETERS-BOUND : bound} OPERATION ::= { + ARGUMENT InitiateCallAttemptArg {bound} + RESULT InitiateCallAttemptRes {bound} + ERRORS {missingParameter | + parameterOutOfRange | + systemFailure | + taskRefused | + unexpectedComponentSequence | + unexpectedDataValue | + unexpectedParameter + } + CODE opcode-initiateCallAttempt} +-- Direction: gsmSCF -> gsmSSF, Timer T_ica +-- This operation is used to instruct the gsmSSF to create a new call to a call party using the +-- address information provided by the gsmSCF. + +``` + +``` + +InitiateCallAttemptArg {PARAMETERS-BOUND : bound} ::= SEQUENCE { + destinationRoutingAddress [0] DestinationRoutingAddress {bound}, + extensions [4] Extensions {bound} OPTIONAL, + legToBeCreated [5] LegID OPTIONAL, + newCallSegment [6] CallSegmentID {bound} OPTIONAL, + callingPartyNumber [30] CallingPartyNumber {bound} OPTIONAL, + callReferenceNumber [51] CallReferenceNumber OPTIONAL, + gsmSCFAddress [52] ISDN-AddressString OPTIONAL, + suppress-T-CSI [53] NULL OPTIONAL, + ... +} + +InitiateCallAttemptRes {PARAMETERS-BOUND : bound} ::= SEQUENCE { + supportedCamelPhases [0] SupportedCamelPhases OPTIONAL, + offeredCamel4Functionalities [1] OfferedCamel4Functionalities OPTIONAL, + extensions [2] Extensions {bound} OPTIONAL, + ..., + releaseCallArgExtensionAllowed [3] NULL OPTIONAL +} + +moveLeg {PARAMETERS-BOUND : bound} OPERATION ::= { + ARGUMENT MoveLegArg {bound} + RETURN RESULT TRUE + ERRORS {missingParameter | + systemFailure | + taskRefused | + unexpectedComponentSequence | + unexpectedDataValue | + unexpectedParameter | + unknownLegID} + CODE opcode-moveLeg +-- Direction: gsmSCF -> gsmSSF, Timer: Tml +-- This operation is used by the gsmSCF to move a leg from one call segment to another call segment +-- within the same call segment association. + +MoveLegArg {PARAMETERS-BOUND : bound} ::= SEQUENCE { + legIDToMove [0] LegID, + extensions [2] Extensions {bound} OPTIONAL, + ... +} + +playTone {PARAMETERS-BOUND : bound} OPERATION ::= { + ARGUMENT PlayToneArg {bound} + RETURN RESULT FALSE + ERRORS {missingParameter | + parameterOutOfRange | + systemFailure | + unexpectedComponentSequence | + unexpectedDataValue | + unexpectedParameter | + unknownLegID | + unknownCSID} + CODE opcode-playTone +-- Direction: gsmSCF -> gsmSSF, Timer: Tpt +-- This operation is used to play tones to either a leg or a call segment using +-- the MSC's tone generator. + +PlayToneArg {PARAMETERS-BOUND : bound} ::= SEQUENCE { + legOrCallSegment [0] LegOrCallSegment {bound}, + bursts [1] Burst, + extensions [2] Extensions {bound} OPTIONAL, + ... +} + +releaseCall {PARAMETERS-BOUND : bound} OPERATION ::= { + ARGUMENT ReleaseCallArg {bound} + RETURN RESULT FALSE + ALWAYS RESPONDS FALSE + CODE opcode-releaseCall +-- Direction: gsmSCF -> gsmSSF, Timer: Trc +-- This operation is used to tear down an existing call at any phase of the call for all parties +-- involved in the call. + +ReleaseCallArg {PARAMETERS-BOUND : bound} ::= CHOICE { + allCallSegments AllCallSegments, + allCallSegmentsWithExtension [2] AllCallSegmentsWithExtension +} + +``` + +``` + + } + +AllCallSegments ::= Cause {bound} +-- A default value of decimal 31 (normal unspecified) shall be given. + +AllCallSegmentsWithExtension ::= SEQUENCE { + allCallSegments [0] AllCallSegments, + extensions [1] Extensions {bound} OPTIONAL +} + +requestReportBCSMEvent {PARAMETERS-BOUND : bound} OPERATION ::= { + ARGUMENT RequestReportBCSMEventArg {bound} + RETURN RESULT FALSE + ERRORS {missingParameter | + parameterOutOfRange | + systemFailure | + taskRefused | + unexpectedComponentSequence | + unexpectedDataValue | + unexpectedParameter | + unknownLegID} + CODE opcode-requestReportBCSMEvent} +-- Direction: gsmSCF -> gsmSSF, Timer: Trrb +-- This operation is used to request the gsmSSF to monitor for a call-related event +-- (e.g. BCSM events such as O_Busy or O_No_Answer) and to send a notification +-- to the gsmSCF when the event is detected. +-- +-- NOTE: +-- Every EDP must be explicitly armed by the gsmSCF via a RequestReportBCSMEvent operation. +-- No implicit arming of EDPs at the gsmSSF after reception of any operation (different +-- from RequestReportBCSMEvent) from the gsmSCF is allowed. + +RequestReportBCSMEventArg {PARAMETERS-BOUND : bound} ::= SEQUENCE { + bcsmEvents [0] SEQUENCE SIZE(1..bound.&numOfBCSMEvents) OF + BCSMEvent {bound}, + extensions [2] Extensions {bound} OPTIONAL, + ... +} +-- Indicates the BCSM related events for notification. + +resetTimer {PARAMETERS-BOUND : bound} OPERATION ::= { + ARGUMENT ResetTimerArg {bound} + RETURN RESULT FALSE + ERRORS {missingParameter | + parameterOutOfRange | + taskRefused | + unexpectedComponentSequence | + unexpectedDataValue | + unexpectedParameter | + unknownCSID} + CODE opcode-resetTimer} +-- Direction: gsmSCF -> gsmSSF, Timer: Ttr +-- This operation is used to request the gsmSSF to refresh an application timer in the gsmSSF. + +ResetTimerArg {PARAMETERS-BOUND : bound} ::= SEQUENCE { + timerID [0] TimerID DEFAULT tssf, + timerValue [1] TimerValue, + extensions [2] Extensions {bound} OPTIONAL, + callSegmentID [3] CallSegmentID {bound} OPTIONAL, + ... +} + +sendChargingInformation {PARAMETERS-BOUND : bound} OPERATION ::= { + ARGUMENT SendChargingInformationArg {bound} + RETURN RESULT FALSE + ERRORS {missingParameter | + unexpectedComponentSequence | + unexpectedParameter | + parameterOutOfRange | + systemFailure | + taskRefused | + unexpectedDataValue | + unknownLegID} + CODE opcode-sendChargingInformation} +-- Direction: gsmSCF -> gsmSSF, Timer: Tsci +-- This operation is used to instruct the gsmSSF on the charging information to send by the gsmSSF. +-- The charging information can either be sent back by means of signalling or internal +-- if the gsmSSF is located in the local exchange. In the local exchange + +``` + +-- this information may be used to update the charge meter or to create a standard call record. + +``` +SendChargingInformationArg {PARAMETERS-BOUND : bound} ::= SEQUENCE { + SCIBillingChargingCharacteristics [0] SCIBillingChargingCharacteristics {bound}, + partyToCharge [1] SendingSideID, + extensions [2] Extensions {bound} OPTIONAL, + ... +} +``` + +``` +splitLeg {PARAMETERS-BOUND : bound} OPERATION ::= { + ARGUMENT SplitLegArg {bound} + RETURN RESULT TRUE + ERRORS {missingParameter | + unexpectedComponentSequence | + unexpectedParameter | + unexpectedDataValue | + systemFailure | + taskRefused | + unknownLegID} + CODE opcode-splitLeg} +``` + +-- Direction: gsmSCF -> gsmSSF, Timer Tsl + +-- This operation is used by the gsmSCF to separate a leg from its source call segment and +-- place it in a new call segment within the same call segment association. + +``` +SplitLegArg {PARAMETERS-BOUND : bound} ::= SEQUENCE { + legToBeSplit [0] LegID, + newCallSegment [1] CallSegmentID {bound} OPTIONAL, + extensions [2] Extensions {bound} OPTIONAL, + ... +} +``` + +END + +The following value ranges apply for operation specific timers in CAP: + +| | | +|---------|------------------| +| short: | 1 s - 10 s | +| medium: | 1 s - 60 s | +| long: | 1 s - 30 minutes | + +Table 6-1 lists all operation timers and the value range for each timer. The definitive value for each operation timer may be network specific and has to be defined by the network operator. + +**Table 6-1: Timer value ranges** + +| Operation Name | Timer | value range | +|-----------------------------------------|--------------------|-------------| +| ActivityTest | T at | Short | +| ApplyCharging | T ac | Short | +| ApplyChargingReport | T acr | Short | +| AssistRequestInstructions | T ari | Short | +| CollectInformation | T ci | Short | +| CallInformationReport | T cirp | Short | +| CallInformationRequest | T cirq | Short | +| Cancel | T can | Short | +| CallGap | T cg | Short | +| Connect | T con | Short | +| ConnectToResource | T ctr | Short | +| Continue | T cue | Short | +| ContinueWithArgument | T cwa | Short | +| DisconnectForwardConnectionWithArgument | T dfcwa | Short | +| DisconnectLeg | T dl | Short | +| EntityReleased | T er | Short | +| DisconnectForwardConnection | T dfc | Short | +| EstablishTemporaryConnection | T etc | Medium | +| EventReportBCSM | T erb | Short | +| FurnishChargingInformation | T fci | Short | +| InitialDP | T idp | Short | +| InitiateCallAttempt | T ica | Short | +| MoveLeg | T ml | Short | +| PlayTone | T pt | Short | +| ReleaseCall | T rc | Short | +| RequestReportBCSMEVENT | T rrb | Short | +| ResetTimer | T rt | Short | +| SendChargingInformation | T sci | Short | +| SplitLeg | T sl | Short | + +## 6.1.2 gsmSSF/gsmSCF packages, contracts and ACs + +### 6.1.2.1 gsmSSF/gsmSCF ASN.1 module + +``` +CAP-gsmSSF-gsmSCF-pkgs-contracts-ac { itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) +umts-network(1) modules(3) cap-gsmSSF-gsmSCF-pkgs-contracts-ac(102) version8(7) } +``` + +``` +DEFINITIONS ::= BEGIN +``` + +``` +-- This module specifies the Operation Packages, Contracts, Application Contexts +-- and Abstract Syntaxes used for the gsmSSF - gsmSCF interface, for the control of +-- circuit switched calls. +``` + +``` +-- The table in subclause 2.1 lists the specifications that contain the modules +-- that are used by CAP. +``` + +``` +IMPORTS +``` + +``` + PARAMETERS-BOUND, + cAPSpecificBoundSet +FROM CAP-classes classes +-- Elements that exist in cAPSpecificBoundSet in Rel-5 are not changed in Rel-6. As a +-- result, the value range of data type definitions in Rel-5 are not changed in Rel-6. +``` + +``` +CONTRACT, +``` + +``` + + OPERATION-PACKAGE, + OPERATION +FROM Remote-Operations-Information-Objects ros-InformationObjects + + TCMessage {} +FROM TCAPMessages tc-Messages + + APPLICATION-CONTEXT, + dialogue-abstract-syntax +FROM TC-Notation-Extensions tc-NotationExtensions + + activityTest, + applyCharging {}, + applyChargingReport {}, + assistRequestInstructions {}, + callGap {}, + callInformationReport {}, + callInformationRequest {}, + cancel {}, + collectInformation {}, + connect {}, + connectToResource {}, + continue, + continueWithArgument {}, + disconnectForwardConnection, + disconnectForwardConnectionWithArgument {}, + disconnectLeg {}, + entityReleased {}, + establishTemporaryConnection {}, + eventReportBCSM {}, + furnishChargingInformation {}, + initialDP {}, + initiateCallAttempt {}, + moveLeg {}, + playTone {}, + releaseCall {}, + requestReportBCSMEVENT {}, + resetTimer {}, + sendChargingInformation {}, + splitLeg {} +FROM CAP-gsmSSF-gsmSCF-ops-args gsmSSF-gsmSCF-Operations +-- Object Identifier 'gsmSSF-gsmSCF-Operations' is updated to version8(7) in Rel-6. As +-- a result, the present module, 'CAP-gsmSSF-gsmSCF-pkgs-contracts-ac', IMPORTS CAP +-- Operation definitions from CAP-gsmSSF-gsmSCF-ops-args version8(7). Operation +-- definitions are used in the ABSTRACT SYNTAX definitions and in the OPERATION PACKAGE +-- definitions. + playAnnouncement {}, + promptAndCollectUserInformation {}, + specializedResourceReport +FROM CAP-gsmSCF-gsmSRF-ops-args gsmSCF-gsmSRF-Operations-- Object Identifier 'gsmSCF-gsmSRF- +Operations' is updated to version8(7) in Rel-6. AS +-- a result, the present module, 'CAP-gsmSSF-gsmSCF-pkgs-contracts-ac', IMPORTS CAP +-- Operation definitions from CAP-gsmSCF-gsmSRF-ops-args version8(7). Operation +-- definitions are used in the ABSTRACT SYNTAX definitions and in the OPERATION PACKAGE +-- definitions. + + specializedResourceControlPackage {} +FROM CAP-gsmSCF-gsmSRF-pkgs-contracts-ac gsmSCF-gsmSRF-Protocol +-- Object Identifier 'gsmSCF-gsmSRF-Protocol' is updated to version8(7) in Rel-6. As a +-- result, the present module, 'CAP-gsmSSF-gsmSCF-pkgs-contracts-ac', IMPORTS CAP Operation +-- Package definitions from CAP-gsmSCF-gsmSRF-pkgs-contracts-ac version8(7). Operation +-- Package definitions are used in the CONTRACT definitions. + + id-ac-CAP-gsmSSF-scfGenericAC, + id-ac-CAP-gsmSSF-scfAssistHandoffAC, + id-ac-CAP-scf-gsmSSFGenericAC, +-- The APPLICATION-CONTEXT Identifiers for CAP V4 in Rel-6 are the same as for CAP V4 in Rel-5. + + id-CAPssnToScfGeneric, + id-CAPAssistHandoffssnToScf, + id-CAPScfToSsfGeneric, +-- The CONTRACT Identifiers for CAP V4 in Rel-6 are the same as for CAP V4 in Rel-5. + + id-as-gsmSSF-scfGenericAS, + id-as-scf-gsmSSFGenericAS, + id-as-assistHandoff-gsmSSF-scfAS, +-- The ABSTRACT-SYNTAX Identifiers for CAP V4 in Rel-6 are the same as for CAP V4 in Rel-5. + +``` + +``` + +id-package-scfActivation, +id-package-gsmSRF-scfActivationOfAssist, +id-package-assistConnectionEstablishment, +id-package-genericDisconnectResource, +id-package-nonAssistedConnectionEstablishment, +id-package-connect, +id-package-callHandling, +id-package-bcsmEventHandling, +id-package-ssfCallProcessing, +id-package-scfCallInitiation, +id-package-timer, +id-package-billing, +id-package-charging, +id-package-trafficManagement, +id-package-callReport, +id-package-signallingControl, +id-package-activityTest, +id-package-cancel, +id-package-cphResponse, +id-package-exceptionInform, +id-package-playTone, +-- The OPERATION-PACKAGE Identifiers for CAP V4 in Rel-6 are the same as for CAP V4 in Rel-5. + +classes, +ros-InformationObjects, +tc-Messages, +tc-NotationExtensions, + +gsmSSF-gsmSCF-Operations, +gsmSCF-gsmSRF-Operations, +-- Object Identifiers gsmSSF-gsmSCF-Operations and gsmSCF-gsmSRF-Operations are updated +-- to version8(7) in Rel-6. As a result, the present module, 'CAP-gsmSSF-gsmSCF-pkgs- +-- contracts-ac', IMPORTS Rel-6 versions of the CAP Operation definitions. + +gsmSCF-gsmSRF-Protocol +-- Object Identifier gsmSCF-gsmSRF-Protocol is updated to version8(7) in Rel-6. As a result, +-- the present module IMPORTS Rel-6 versions of the CAP Operation Package definitions. + +FROM CAP-object-identifiers {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) +umts-network(1) modules(3) cap-object-identifiers(100) version8(7)}; + +-- Application Contexts + +-- CAP V4 Rel-5 and CAP V4 Rel-6 use the same Application Context version. The CONTRACT +-- and ABSTRACT SYNTAXES for the call control related Application Contexts, however, are +-- defined in Rel-6. This is needed to use parameter definitions that are defined in Rel-6. + +-- Refer to ITU-T Recommendation Q.775 for the formal definition of APPLICATION-CONTEXT. +-- The structured DIALOGUE MODE is defined in ITU-T Recommendation Q.771; the +-- dialogue-abstract-syntax ABSTRACT SYNTAX is defined in ITU-T Recommendation Q.775. + +capsf-scfGenericAC APPLICATION-CONTEXT ::= { + CONTRACT capSsfToScfGeneric + DIALOGUE MODE structured + ABSTRACT SYNTAXES {dialogue-abstract-syntax | + gsmSSF-scfGenericAbstractSyntax} + APPLICATION CONTEXT NAME id-ac-CAP-gsmSSF-scfGenericAC} +-- 'capSsfToScfGeneric' and 'gsmSSF-scfGenericAbstractSyntax' are defined in the present +-- module. + +capsf-scfAssistHandoffAC APPLICATION-CONTEXT ::= { + CONTRACT capAssistHandoffssfToScf + DIALOGUE MODE structured + ABSTRACT SYNTAXES {dialogue-abstract-syntax | + assistHandoff-gsmSSF-scfAbstractSyntax} + APPLICATION CONTEXT NAME id-ac-CAP-gsmSSF-scfAssistHandoffAC} +-- 'capAssistHandoffssfToScf' and 'assistHandoff-gsmSSF-scfAbstractSyntax' are defined in +-- the present module. + +capsf-ssfGenericAC APPLICATION-CONTEXT ::= { + CONTRACT capScfToSsfGeneric + DIALOGUE MODE structured + ABSTRACT SYNTAXES {dialogue-abstract-syntax | + scf-gsmSSFGenericAbstractSyntax} + APPLICATION CONTEXT NAME id-ac-CAP-scf-gsmSSFGenericAC} +-- 'capScfToSsfGeneric' and 'scf-gsmSSFGenericAbstractSyntax' are defined in the present +-- module. + +``` + +``` + +-- Contracts +-- The CONTRACT definitions are updated for Rel-6, due to the fact that the individual +-- OPERATION-PACKAGE definitions are updated in Rel-6. + +capSsfToScfGeneric CONTRACT ::= { +-- dialogue initiated by gsmSSF with InitialDP Operation + INITIATOR CONSUMER OF {exceptionInformPackage {CAPSpecificBoundSet} | + scfActivationPackage {CAPSpecificBoundSet}} + RESPONDER CONSUMER OF {activityTestPackage | + assistConnectionEstablishmentPackage {CAPSpecificBoundSet} | + bcsmEventHandlingPackage {CAPSpecificBoundSet} | + billingPackage {CAPSpecificBoundSet} | + callHandlingPackage {CAPSpecificBoundSet} | + callReportPackage {CAPSpecificBoundSet} | + cancelPackage {CAPSpecificBoundSet} | + chargingPackage {CAPSpecificBoundSet} | + connectPackage {CAPSpecificBoundSet} | + cphResponsePackage {CAPSpecificBoundSet} | + genericDisconnectResourcePackage {CAPSpecificBoundSet} | + nonAssistedConnectionEstablishmentPackage {CAPSpecificBoundSet} | + playTonePackage {CAPSpecificBoundSet} | + signallingControlPackage {CAPSpecificBoundSet} | + specializedResourceControlPackage {CAPSpecificBoundSet} | + ssfCallProcessingPackage {CAPSpecificBoundSet} | + timerPackage {CAPSpecificBoundSet} | + trafficManagementPackage {CAPSpecificBoundSet} | + scfCallInitiationPackage {CAPSpecificBoundSet}} + ID + id-CAPSsfToScfGeneric +-- The OPERATION-PACKAGES are defined in the present module, except for +-- specializedResourceControlPackage, which is defined in CAP-gsmSCF-gsmSRF-pkgs-contracts-ac. + +capAssistHandoffssnToScf CONTRACT ::= { +-- dialogue initiated by gsmSSF with AssistRequestInstructions + INITIATOR CONSUMER OF {gsmSRF-scfActivationOfAssistPackage {CAPSpecificBoundSet}} + RESPONDER CONSUMER OF {activityTestPackage | + cancelPackage {CAPSpecificBoundSet} | + genericDisconnectResourcePackage {CAPSpecificBoundSet} | + nonAssistedConnectionEstablishmentPackage {CAPSpecificBoundSet} | + specializedResourceControlPackage {CAPSpecificBoundSet} | + timerPackage {CAPSpecificBoundSet}} + ID + id-CAPAssistHandoffssnToScf +-- The OPERATION-PACKAGES are defined in the present module, except for +-- specializedResourceControlPackage, which is defined in CAP-gsmSCF-gsmSRF-pkgs-contracts-ac. + +capScfToSsfGeneric CONTRACT ::= { +-- dialogue initiated by gsmSCF with InitiateCallAttempt, Generic Case + INITIATOR CONSUMER OF {activityTestPackage | + assistConnectionEstablishmentPackage {CAPSpecificBoundSet} | + bcsmEventHandlingPackage {CAPSpecificBoundSet} | + billingPackage {CAPSpecificBoundSet} | + callHandlingPackage {CAPSpecificBoundSet} | + callReportPackage {CAPSpecificBoundSet} | + cancelPackage {CAPSpecificBoundSet} | + chargingPackage {CAPSpecificBoundSet} | + connectPackage {CAPSpecificBoundSet} | + cphResponsePackage {CAPSpecificBoundSet} | + genericDisconnectResourcePackage {CAPSpecificBoundSet} | + nonAssistedConnectionEstablishmentPackage {CAPSpecificBoundSet} | + playTonePackage {CAPSpecificBoundSet} | + scfCallInitiationPackage {CAPSpecificBoundSet} | + specializedResourceControlPackage {CAPSpecificBoundSet} | + ssfCallProcessingPackage {CAPSpecificBoundSet} | + timerPackage {CAPSpecificBoundSet}} + RESPONDER CONSUMER OF {exceptionInformPackage {CAPSpecificBoundSet}} + ID + id-CAPScfToSsfGeneric +-- The OPERATION-PACKAGES are defined in the present module, except for +-- specializedResourceControlPackage, which is defined in CAP-gsmSCF-gsmSRF-pkgs-contracts-ac. + +-- Operation Packages +-- The OPERATION-PACKAGE definitions are updated for Rel-6, due to the fact that the individual +-- OPERATION definitions are updated in Rel-6. The OPERATION definitions are IMPORTED from +-- CAP-gsmSSF-gsmSCF-ops-args and from CAP-gsmSCF-gsmSRF-ops-args. + +scfActivationPackage {PARAMETERS-BOUND : bound} OPERATION-PACKAGE ::= { + CONSUMER INVOKES {initialDP {bound}} + ID + id-package-scfActivation} + +``` + +``` +gsmSRF-scfActivationOfAssistPackage {PARAMETERS-BOUND : bound} OPERATION-PACKAGE ::= { + CONSUMER INVOKES {assistRequestInstructions {bound}} + ID id-package-gsmSRF-scfActivationOfAssist} + +assistConnectionEstablishmentPackage {PARAMETERS-BOUND : bound} OPERATION-PACKAGE ::= { + CONSUMER INVOKES {establishTemporaryConnection {bound}} + ID id-package-assistConnectionEstablishment} + +genericDisconnectResourcePackage {PARAMETERS-BOUND : bound} OPERATION-PACKAGE ::= { + CONSUMER INVOKES {disconnectForwardConnection | + disconnectForwardConnectionWithArgument {bound}} + ID id-package-genericDisconnectResource} + +nonAssistedConnectionEstablishmentPackage {PARAMETERS-BOUND : bound} OPERATION-PACKAGE ::= { + CONSUMER INVOKES {connectToResource {bound}} + ID id-package-nonAssistedConnectionEstablishment} + +connectPackage {PARAMETERS-BOUND : bound} OPERATION-PACKAGE ::= { + CONSUMER INVOKES {connect {bound}} + ID id-package-connect} + +callHandlingPackage {PARAMETERS-BOUND : bound} OPERATION-PACKAGE ::= { + CONSUMER INVOKES {releaseCall {bound}} + ID id-package-callHandling} + +bcsmEventHandlingPackage {PARAMETERS-BOUND : bound} OPERATION-PACKAGE ::= { + CONSUMER INVOKES {requestReportBCSMEVENT {bound}} + SUPPLIER INVOKES {eventReportBCSM {bound}} + ID id-package-bcsmEventHandling} + +ssfCallProcessingPackage {PARAMETERS-BOUND : bound} OPERATION-PACKAGE ::= { + CONSUMER INVOKES {collectInformation | continueWithArgument {bound} | continue} + ID id-package-ssfCallProcessing} + +scfCallInitiationPackage {PARAMETERS-BOUND : bound} OPERATION-PACKAGE ::= { + CONSUMER INVOKES {initiateCallAttempt {bound}} + ID id-package-scfCallInitiation} + +timerPackage {PARAMETERS-BOUND : bound} OPERATION-PACKAGE ::= { + CONSUMER INVOKES {resetTimer {bound}} + ID id-package-timer} + +billingPackage {PARAMETERS-BOUND : bound} OPERATION-PACKAGE ::= { + CONSUMER INVOKES {furnishChargingInformation {bound}} + ID id-package-billing} + +chargingPackage {PARAMETERS-BOUND : bound} OPERATION-PACKAGE ::= { + CONSUMER INVOKES {applyCharging {bound}} + SUPPLIER INVOKES {applyChargingReport {bound}} + ID id-package-charging} + +trafficManagementPackage {PARAMETERS-BOUND : bound} OPERATION-PACKAGE ::= { + CONSUMER INVOKES {callGap {bound}} + ID id-package-trafficManagement} + +callReportPackage {PARAMETERS-BOUND : bound} OPERATION-PACKAGE ::= { + CONSUMER INVOKES {callInformationRequest {bound}} + SUPPLIER INVOKES {callInformationReport {bound}} + ID id-package-callReport} + +signallingControlPackage {PARAMETERS-BOUND : bound} OPERATION-PACKAGE ::= { + CONSUMER INVOKES {sendChargingInformation {bound}} + ID id-package-signallingControl} + +activityTestPackage OPERATION-PACKAGE ::= { + CONSUMER INVOKES {activityTest} + ID id-package-activityTest} + +cancelPackage {PARAMETERS-BOUND : bound} OPERATION-PACKAGE ::= { + CONSUMER INVOKES {cancel {bound}} + ID id-package-cancel} + +cphResponsePackage {PARAMETERS-BOUND : bound} OPERATION-PACKAGE ::= { + CONSUMER INVOKES {continueWithArgument {bound} | + disconnectLeg {bound} | + moveLeg {bound} | + splitLeg {bound}} + ID id-package-cphResponse} +``` + +``` + +exceptionInformPackage {PARAMETERS-BOUND : bound} OPERATION-PACKAGE ::= { + CONSUMER INVOKES {entityReleased {bound}} + ID id-package-exceptionInform} + +playTonePackage {PARAMETERS-BOUND : bound} OPERATION-PACKAGE ::= { + CONSUMER INVOKES {playTone {bound}} + ID id-package-playTone} + +-- Abstract Syntaxes + +-- SsfToScfGenericInvokable and SsfToScfGenericReturnable use OPERATION definitions with +-- version8(7). As a result, GenericSSF-gsmSCF-PDUs uses version8(7) OPERATION definitions. +-- As a subsequent result, gsmSSF-scfGenericAbstractSyntax uses version8(7) OPERATION +-- definitions. That ABSTRACT-SYNTAX is used in the capssf-scfGenericAC APPLICATION-CONTEXT +-- definition (CAP from gsmSSF to gsmSCF). + +gsmSSF-scfGenericAbstractSyntax ABSTRACT-SYNTAX ::= { + GenericSSF-gsmSCF-PDUs + IDENTIFIED BY id-as-gsmSSF-scfGenericAS} +-- 'GenericSSF-gsmSCF-PDUs' is defined in the present module. + +GenericSSF-gsmSCF-PDUs ::= TCMessage {{SsfToScfGenericInvokable}, + {SsfToScfGenericReturnable}} +-- 'SsfToScfGenericInvokable' and 'SsfToScfGenericReturnable' are defined in the present module. + +SsfToScfGenericInvokable OPERATION ::= { + activityTest | + applyCharging {cAPSpecificBoundSet} | + applyChargingReport {cAPSpecificBoundSet} | + callInformationReport {cAPSpecificBoundSet} | + callInformationRequest {cAPSpecificBoundSet} | + cancel {cAPSpecificBoundSet} | + connect {cAPSpecificBoundSet} | + continueWithArgument {cAPSpecificBoundSet} | + connectToResource {cAPSpecificBoundSet} | + collectInformation | + disconnectForwardConnection | + disconnectForwardConnectionWithArgument {cAPSpecificBoundSet} | + disconnectLeg {cAPSpecificBoundSet} | + entityReleased {cAPSpecificBoundSet} | + establishTemporaryConnection {cAPSpecificBoundSet} | + eventReportBCSM {cAPSpecificBoundSet} | + furnishChargingInformation {cAPSpecificBoundSet} | + initialDP {cAPSpecificBoundSet} | + initiateCallAttempt {cAPSpecificBoundSet} | + moveLeg {cAPSpecificBoundSet} | + releaseCall {cAPSpecificBoundSet} | + requestReportBCSMEVENT {cAPSpecificBoundSet} | + resetTimer {cAPSpecificBoundSet} | + sendChargingInformation {cAPSpecificBoundSet} | + splitLeg {cAPSpecificBoundSet} | + playAnnouncement {cAPSpecificBoundSet} | + playTone {cAPSpecificBoundSet} | + promptAndCollectUserInfo {cAPSpecificBoundSet} | + specializedResourceReport +} +-- The OPERATION definitions are IMPORTED from CAP-gsmSSF-gsmSCF-ops-args and from +-- CAP-gsmSCF-gsmSRF-ops-args. + +SsfToScfGenericReturnable OPERATION ::= { + activityTest | + applyCharging {cAPSpecificBoundSet} | + applyChargingReport {cAPSpecificBoundSet} | + callGap {cAPSpecificBoundSet} | + callInformationRequest {cAPSpecificBoundSet} | + cancel {cAPSpecificBoundSet} | + connect {cAPSpecificBoundSet} | + connectToResource {cAPSpecificBoundSet} | + collectInformation | + continue | + continueWithArgument {cAPSpecificBoundSet} | + disconnectForwardConnection | + disconnectForwardConnectionWithArgument {cAPSpecificBoundSet} | + disconnectLeg {cAPSpecificBoundSet} | + entityReleased {cAPSpecificBoundSet} | + establishTemporaryConnection {cAPSpecificBoundSet} | +} + +``` + +``` + furnishChargingInformation {cAPSSpecificBoundSet} | + initialDP {cAPSSpecificBoundSet} | + initiateCallAttempt {cAPSSpecificBoundSet} | + moveLeg {cAPSSpecificBoundSet} | + releaseCall {cAPSSpecificBoundSet} | + requestReportBCSMEVENT {cAPSSpecificBoundSet} | + resetTimer {cAPSSpecificBoundSet} | + sendChargingInformation {cAPSSpecificBoundSet} | + splitLeg {cAPSSpecificBoundSet} | + playAnnouncement {cAPSSpecificBoundSet} | + playTone {cAPSSpecificBoundSet} | + promptAndCollectUserInfo {cAPSSpecificBoundSet} + } +-- The OPERATION definitions are IMPORTED from CAP-gsmSSF-gsmSCF-ops-args and from +-- CAP-gsmSCF-gsmSRF-ops-args. + +-- AssistHandoffssfToScfInvokable and AssistHandoffssfToScfReturnable use OPERATION definitions +-- with version8(7). As a result, AssistHandoffssf-gsmSCF-PDUs uses version8(7) OPERATION +-- definitions. As a subsequent result, assistHandoff-gsmSSF-scfAbstractSyntax uses version8(7) +-- OPERATION definitions. That ABSTRACT-SYNTAX is used in the capssf-scfAssistHandoffAC +-- APPLICATION-CONTEXT definition (CAP from assist gsmSSF to gsmSCF). + +assistHandoff-gsmSSF-scfAbstractSyntax ABSTRACT-SYNTAX ::= { + AssistHandoffssf-gsmSCF-PDUs + IDENTIFIED BY id-as-assistHandoff-gsmSSF-scfAS} +-- 'AssistHandoffssf-gsmSCF-PDUs' is defined in the present module. + +AssistHandoffssf-gsmSCF-PDUs ::= TCMessage {{AssistHandoffssfToScfInvokable}, + {AssistHandoffssfToScfReturnable}} +-- 'AssistHandoffssfToScfInvokable' and 'AssistHandoffssfToScfReturnable' are defined in the +-- present module. + +AssistHandoffssfToScfInvokable OPERATION ::= { + activityTest | + assistRequestInstructions {cAPSSpecificBoundSet} | + cancel {cAPSSpecificBoundSet} | + connectToResource {cAPSSpecificBoundSet} | + disconnectForwardConnection | + playAnnouncement {cAPSSpecificBoundSet} | + promptAndCollectUserInfo {cAPSSpecificBoundSet} | + resetTimer {cAPSSpecificBoundSet} | + specializedResourceReport +} +-- The OPERATION definitions are IMPORTED from CAP-gsmSSF-gsmSCF-ops-args and from +-- CAP-gsmSCF-gsmSRF-ops-args. + +AssistHandoffssfToScfReturnable OPERATION ::= { + activityTest | + assistRequestInstructions {cAPSSpecificBoundSet} | + cancel {cAPSSpecificBoundSet} | + connectToResource {cAPSSpecificBoundSet} | + disconnectForwardConnection | + playAnnouncement {cAPSSpecificBoundSet} | + promptAndCollectUserInfo {cAPSSpecificBoundSet} | + resetTimer {cAPSSpecificBoundSet} +} +-- The OPERATION definitions are IMPORTED from CAP-gsmSSF-gsmSCF-ops-args and from +-- CAP-gsmSCF-gsmSRF-ops-args. + +-- ScfToSsfGenericInvokable and ScfToSsfGenericReturnable use OPERATION definitions +-- with version8(7). As a result, GenericSCF-gsmSSF-PDUs uses version8(7) OPERATION +-- definitions. As a subsequent result, scf-gsmSSFGenericAbstractSyntax uses version8(7) +-- OPERATION definitions. That ABSTRACT-SYNTAX is used in the capscf-ssfGenericAC +-- APPLICATION-CONTEXT definition (CAP from gsmSCF to gsmSSF). +scf-gsmSSFGenericAbstractSyntax ABSTRACT-SYNTAX ::= { + GenericSCF-gsmSSF-PDUs + IDENTIFIED BY id-as-scf-gsmSSFGenericAS} +-- 'GenericSCF-gsmSSF-PDUs' is defined in the present module. + +GenericSCF-gsmSSF-PDUs ::= TCMessage {{ScfToSsfGenericInvokable}, + {ScfToSsfGenericReturnable}} +-- 'ScfToSsfGenericInvokable' and 'ScfToSsfGenericReturnable' are defined in the +-- present module. + +ScfToSsfGenericInvokable OPERATION ::= { + activityTest | + applyCharging {cAPSSpecificBoundSet} | +``` + +``` + + applyChargingReport {cAPSpecificBoundSet} | + callInformationRequest {cAPSpecificBoundSet} | + cancel {cAPSpecificBoundSet} | + collectInformation | + connect {cAPSpecificBoundSet} | + connectToResource {cAPSpecificBoundSet} | + continue | + continueWithArgument {cAPSpecificBoundSet} | + disconnectForwardConnection | + disconnectForwardConnectionWithArgument {cAPSpecificBoundSet} | + disconnectLeg {cAPSpecificBoundSet} | + establishTemporaryConnection {cAPSpecificBoundSet} | + furnishChargingInformation {cAPSpecificBoundSet} | + initiateCallAttempt {cAPSpecificBoundSet} | + moveLeg {cAPSpecificBoundSet} | + playTone {cAPSpecificBoundSet} | + releaseCall {cAPSpecificBoundSet} | + requestReportBCSMEVENT {cAPSpecificBoundSet} | + resetTimer {cAPSpecificBoundSet} | + sendChargingInformation {cAPSpecificBoundSet} | + splitLeg {cAPSpecificBoundSet} | + playAnnouncement {cAPSpecificBoundSet} | + promptAndCollectUserInfo {cAPSpecificBoundSet} + } + -- The OPERATION definitions are IMPORTED from CAP-gsmSSF-gsmSCF-ops-args and from + -- CAP-gsmSCF-gsmSRF-ops-args. + + ScfToSsfGenericReturnable OPERATION ::= { + activityTest | + applyCharging {cAPSpecificBoundSet} | + applyChargingReport {cAPSpecificBoundSet} | + callInformationReport {cAPSpecificBoundSet} | + callInformationRequest {cAPSpecificBoundSet} | + cancel {cAPSpecificBoundSet} | + connect {cAPSpecificBoundSet} | + connectToResource {cAPSpecificBoundSet} | + disconnectForwardConnection | + disconnectForwardConnectionWithArgument {cAPSpecificBoundSet} | + disconnectLeg {cAPSpecificBoundSet} | + entityReleased {cAPSpecificBoundSet} | + establishTemporaryConnection {cAPSpecificBoundSet} | + eventReportBCSM {cAPSpecificBoundSet} | + furnishChargingInformation {cAPSpecificBoundSet} | + initiateCallAttempt {cAPSpecificBoundSet} | + moveLeg {cAPSpecificBoundSet} | + requestReportBCSMEVENT {cAPSpecificBoundSet} | + resetTimer {cAPSpecificBoundSet} | + sendChargingInformation {cAPSpecificBoundSet} | + splitLeg {cAPSpecificBoundSet} | + playAnnouncement {cAPSpecificBoundSet} | + playTone {cAPSpecificBoundSet} | + promptAndCollectUserInfo {cAPSpecificBoundSet} | + specializedResourceReport + } + -- The OPERATION definitions are IMPORTED from CAP-gsmSSF-gsmSCF-ops-args and from + -- CAP-gsmSCF-gsmSRF-ops-args. + +END + +``` + +## 6.2 gsmSCF/gsmSRF interface + +### 6.2.1 gsmSCF/gsmSRF operations and arguments + +``` + +CAP-gsmSCF-gsmSRF-ops-args {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) +umts-network(1) modules(3) cap-gsmSCF-gsmSRF-ops-args(103) version8(7)} + +``` + +``` + +DEFINITIONS IMPLICIT TAGS ::= BEGIN + +``` + +``` + + -- This module contains the operations and operation arguments used for the + -- gsmSRF - gsmSCF interface, for the control of circuit switched calls. + + -- The table in subclause 2.1 lists the specifications that contain the modules + -- that are used by CAP. + +``` + +``` + +IMPORTS + +``` + +``` + +OPERATION +FROM Remote-Operations-Information-Objects ros-InformationObjects + + opcode-playAnnouncement, + opcode-promptAndCollectUserInfo, + opcode-specializedResourceReport +FROM CAP-operationcodes operationcodes +-- The CAP Operation identifiers for CAP V4 in Rel-6 are the same as the CAP Operation +-- identifiers for CAP V4 in Rel-5. + + CallSegmentID {}, + CollectedInfo, + Digits {}, + Extensions {}, + InformationToSend {} +FROM CAP-datatypes datatypes +-- For Rel-6, the CAP-datatypes module is updated to version8(7); Object Identifier 'datatypes' +-- is also updated to version8(7). As a result, the present module uses Rel-6 data type definitions. + + canceled, + improperCallerResponse, + missingParameter, + parameterOutOfRange, + systemFailure, + taskRefused, + unavailableResource, + unexpectedComponentSequence, + unexpectedDataValue, + unexpectedParameter, + unknownCSID +FROM CAP-errortypes errortypes +-- For Rel-6, the CAP-errortypes module is updated to version8(7); Object Identifier +-- 'errortypes' is also updated to version8(7). As a result, the present module uses Rel-6 +-- error type definitions. + +PARAMETERS-BOUND +FROM CAP-classes classes + + ros-InformationObjects, + operationcodes, + datatypes, + errortypes, + classes +FROM CAP-object-identifiers {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) +umts-network(1) modules(3) cap-object-identifiers(100) version8(7)} + +; + +playAnnouncement {PARAMETERS-BOUND : bound} OPERATION ::= { + ARGUMENT PlayAnnouncementArg {bound} + RETURN RESULT FALSE + ERRORS {canceled | + missingParameter | + parameterOutOfRange | + systemFailure | + taskRefused | + unexpectedComponentSequence | + unexpectedDataValue | + unexpectedParameter | + unavailableResource | + unknownCSID} + LINKED {specializedResourceReport} + CODE opcode-playAnnouncement} +-- Direction: gsmSCF -> gsmSRF, Timer: Tpa +-- This operation is to be used after Establish Temporary Connection (assist procedure +-- with a second gsmSSF) or a Connect to Resource (no assist) operation. It may be used +-- for inband interaction with a mobile station, or for interaction with an ISDN user. +-- In the former case, the gsmSRF is usually collocated with the gsmSSF for standard +-- tones (congestion tone...) or standard announcements. +-- In the latter case, the gsmSRF is always collocated with the gsmSSF in the switch. +-- Any error is returned to the gsmSCF. The timer associated with this operation must +-- be of a sufficient duration to allow its linked operation to be correctly correlated. + +PlayAnnouncementArg {PARAMETERS-BOUND : bound} ::= SEQUENCE { + informationToSend [0] InformationToSend {bound}, + disconnectFromIPForbidden [1] BOOLEAN DEFAULT TRUE, + requestAnnouncementCompleteNotification [2] BOOLEAN DEFAULT TRUE, +} + +``` + +``` + + extensions [3] Extensions {bound} OPTIONAL, + callSegmentID [5] CallSegmentID {bound} OPTIONAL, + requestAnnouncementStartedNotification [51] BOOLEAN DEFAULT FALSE, + ... + } + +promptAndCollectUserInformation {PARAMETERS-BOUND : bound} OPERATION ::= { + ARGUMENT PromptAndCollectUserInformationArg {bound} + RESULT ReceivedInformationArg {bound} + ERRORS {canceled | + improperCallerResponse | + missingParameter | + parameterOutOfRange | + systemFailure | + taskRefused | + unexpectedComponentSequence | + unavailableResource | + unexpectedDataValue | + unexpectedParameter | + unknownCSID} + LINKED {specializedResourceReport} + CODE opcode-promptAndCollectUserInformation} + -- Direction: gsmSCF -> gsmSRF, Timer: Tpc + -- This operation is used to interact with a user to collect information. + + PromptAndCollectUserInformationArg {PARAMETERS-BOUND : bound} ::= SEQUENCE { + collectedInfo [0] CollectedInfo, + disconnectFromIPForbidden [1] BOOLEAN DEFAULT TRUE, + informationToSend [2] InformationToSend {bound} OPTIONAL, + extensions [3] Extensions {bound} OPTIONAL, + callSegmentID [4] CallSegmentID {bound} OPTIONAL, + requestAnnouncementStartedNotification [51] BOOLEAN DEFAULT FALSE, + ... + } + + ReceivedInformationArg {PARAMETERS-BOUND : bound} ::= CHOICE { + digitsResponse [0] Digits {bound} + } + + specializedResourceReport OPERATION ::= { + ARGUMENT SpecializedResourceReportArg + RETURN RESULT FALSE + ALWAYS RESPONDS FALSE + CODE opcode-specializedResourceReport} + -- Direction: gsmSRF -> gsmSCF, Timer: Tsrr + -- This operation is used as the response to a PlayAnnouncement operation when the announcement + -- completed report indication is set. + + SpecializedResourceReportArg ::= CHOICE { + allAnnouncementsComplete [50] NULL, + firstAnnouncementStarted [51] NULL + } + +END + +``` + +The following value ranges apply for operation specific timers in CAP: + +| | | +|---------|------------------| +| short: | 1 s - 10 s | +| medium: | 1 s - 60 s | +| long: | 1 s - 30 minutes | + +Table 6-2 lists all operation timers and the value range for each timer. The definitive value for each operation timer may be network specific and has to be defined by the network operator. + +**Table 6-2: Operation timers and their value range** + +| Operation Name | Timer | Value range | +|---------------------------------|------------------|-------------| +| PlayAnnouncement | T pa | Long | +| PromptAndCollectUserInformation | T pc | Long | +| SpecializedResourceReport | T srr | Short | + +## 6.2.2 gsmSRF/gsmSCF contracts, packages and ACs + +### 6.2.2.1 gsmSRF/gsmSCF ASN.1 modules + +CAP-gsmSCF-gsmSRF-pkgs-contracts-ac {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) umts-network(1) modules(3) cap-gsmSCF-gsmSRF-pkgs-contracts-ac(104) version8(7)} + +DEFINITIONS ::= BEGIN + +- This module specifies the Operation Packages, Contracts, Application Contexts +- and Abstract Syntaxes used for the gsmSRF – gsmSCF interface, for the control of +- circuit switched calls. + +- The table in subclause 2.1 lists the specifications that contain the modules +- that are used by CAP. + +IMPORTS + +PARAMETERS-BOUND, +cAPSpecificBoundSet + +FROM CAP-classes classes + +- Elements that exist in cAPSpecificBoundSet in Rel-5 are not changed in Rel-6. As a +- result, the value range of data type definitions in Rel-5 are not changed in Rel-6. + +CONTRACT, +OPERATION-PACKAGE, +OPERATION + +FROM Remote-Operations-Information-Objects ros-InformationObjects + +TCMessage {} + +FROM TCAPMessages tc-Messages + +APPLICATION-CONTEXT, +dialogue-abstract-syntax + +FROM TC-Notation-Extensions tc-NotationExtensions + +playAnnouncement {}, +promptAndCollectUserInfo {}, +specializedResourceReport + +FROM CAP-gsmSCF-gsmSRF-ops-args gsmSCF-gsmSRF-Operations-- Object Identifier 'gsmSCF-gsmSRF-Operations' is updated to version8(7) in Rel-6. As + +- a result, the present module, 'CAP-gsmSCF-gsmSRF-pkgs-contracts-ac', IMPORTS CAP +- Operation definitions from CAP-gsmSCF-gsmSRF-ops-args version8(7). Operation +- definitions are used in the ABSTRACT SYNTAX definitions and in the OPERATION PACKAGE +- definitions. + +activityTest, +cancel {}, +assistRequestInstructions {} + +FROM CAP-gsmSSF-gsmSCF-ops-args gsmSSF-gsmSCF-Operations + +- Object Identifier 'gsmSSF-gsmSCF-Operations' is updated to version8(7) in Rel-6. AS +- a result, the present module, 'CAP-gsmSCF-gsmSRF-pkgs-contracts-ac', IMPORTS CAP +- Operation definitions from CAP-gsmSSF-gsmSCF-ops-args version8(7). Operation +- definitions are used in the ABSTRACT SYNTAX definitions and in the OPERATION PACKAGE +- definitions. + +gsmSRF-scfActivationOfAssistPackage {} + +FROM CAP-gsmSSF-gsmSCF-pkgs-contracts-ac gsmSSF-gsmSCF-Protocol + +- Object Identifier 'gsmSSF-gsmSCF-Protocol' is updated to version8(7) in Rel-6. As a +- result, the present module, 'CAP-gsmSCF-gsmSRF-pkgs-contracts-ac', IMPORTS CAP Operation +- Package definitions from CAP-gsmSSF-gsmSCF-pkgs-contracts-ac version8(7). Operation +- Package definitions are used in the CONTRACT definitions. + +id-package-specializedResourceControl, +id-package-activityTest, +id-package-gsmSRF-scfCancel, + +``` + +-- The OPERATION-PACKAGE Identifiers for CAP V4 in Rel-6 are the same as for CAP V4 in Rel-5. + + id-ac-gsmSRF-gsmSCF, +-- The APPLICATION-CONTEXT Identifiers for CAP V4 in Rel-6 are the same as for CAP V4 in Rel-5. + + id-contract-gsmSRF-gsmSCF, +-- The CONTRACT Identifiers for CAP V4 in Rel-6 are the same as for CAP V4 in Rel-5. + + id-as-basic-gsmSRF-gsmSCF, +-- The ABSTRACT-SYNTAX Identifiers for CAP V4 in Rel-6 are the same as for CAP V4 in Rel-5. + + classes, + ros-InformationObjects, + tc-Messages, + tc-NotationExtensions, + + gsmSCF-gsmSRF-Operations, + gsmSSF-gsmSCF-Operations, +-- Object Identifiers gsmSSF-gsmSCF-Operations and gsmSCF-gsmSRF-Operations are updated +-- to version8(7) in Rel-6. As a result, the present module, 'CAP-gsmSCF-gsmSRF-pkgs- +-- contracts-ac', IMPORTS Rel-6 versions of the CAP Operation definitions. + + gsmSSF-gsmSCF-Protocol +-- Object Identifier gsmSSF-gsmSCF-Protocol is updated to version8(7) in Rel-6. As a result, +-- the present module IMPORTS Rel-6 versions of the CAP Operation Package definitions. + +``` + +``` + +FROM CAP-object-identifiers {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) +umts-network(1) modules(3) cap-object-identifiers(100) version8(7)}; + +``` + +#### -- Application Contexts + +``` + +-- CAP V4 Rel-5 and CAP V4 Rel-6 use the same Application Context version. The CONTRACT +-- and ABSTRACT SYNTAXES for the call control related Application Contexts, however, are +-- defined in Rel-6. This is needed to use parameter definitions that are defined in Rel-6. + +-- Refer to ITU-T Recommendation Q.775 for the formal definition of APPLICATION-CONTEXT. +-- The structured DIALOGUE MODE is defined in ITU-T Recommendation Q.771; the +-- dialogue-abstract-syntax ABSTRACT SYNTAX is defined in ITU-T Recommendation Q.775. + +``` + +``` + +gsmSRF-gsmSCF-ac APPLICATION-CONTEXT ::= { + +``` + +``` + + CONTRACT gsmSRF-gsmSCF-contract + DIALOGUE MODE structured + TERMINATION basic + ABSTRACT SYNTAXES {dialogue-abstract-syntax | + gsmSRF-gsmSCF-abstract-syntax} + APPLICATION CONTEXT NAME id-ac-gsmSRF-gsmSCF} + +``` + +``` + +-- 'gsmSRF-gsmSCF-contract' and 'gsmSRF-gsmSCF-abstract-syntax' are defined in the present +-- module. + +``` + +#### -- Contracts + +``` + +-- The CONTRACT definitions are updated for Rel-6, due to the fact that the individual +-- OPERATION-PACKAGE definitions are updated in Rel-6. + +``` + +``` + +gsmSRF-gsmSCF-contract CONTRACT ::= { + +``` + +``` + + INITIATOR CONSUMER OF {gsmSRF-scfActivationOfAssistPackage {cAPSpecificBoundSet}} + RESPONDER CONSUMER OF {specializedResourceControlPackage {cAPSpecificBoundSet} | + activityTestPackage | + gsmSRF-scfCancelPackage {cAPSpecificBoundSet} } + +``` + +``` + + ID id-contract-gsmSRF-gsmSCF} + +``` + +``` + +-- The OPERATION-PACKAGES are defined in the present module, except for +-- gsmSRF-scfActivationOfAssistPackage, which is defined in CAP-gsmSSF-gsmSCF-pkgs-contracts-ac. + +``` + +#### -- Operation Packages + +``` + +-- The OPERATION-PACKAGE definitions are updated for Rel-6, due to the fact that the individual +-- OPERATION definitions are updated in Rel-6. The OPERATION definitions are IMPORTED from +-- CAP-gsmSSF-gsmSCF-ops-args and from CAP-gsmSCF-gsmSRF-ops-args. + +``` + +``` + +specializedResourceControlPackage {PARAMETERS-BOUND : bound} OPERATION-PACKAGE ::= { + +``` + +``` + + CONSUMER INVOKE {playAnnouncement {bound} | + +``` + +``` + + promptAndCollectUserInformation {bound}} + SUPPLIER INVOKES {specializedResourceReport} + ID id-package-specializedResourceControl} + +gsmSRF-scfCancelPackage {PARAMETERS-BOUND : bound} OPERATION-PACKAGE ::= { + CONSUMER INVOKES {cancel {bound}} + ID id-package-gsmSRF-scfCancel} + +activityTestPackage OPERATION-PACKAGE ::= { + CONSUMER INVOKES {activityTest} + ID id-package-activityTest} + +-- Abstract Syntaxes + +-- GsmSRFgsmSCFInvokable and GsmSRFgsmSCFReturnable use OPERATION definitions with +-- version8(7). As a result, BASIC-gsmSRF-gsmSCF-PDUs uses version8(7) OPERATION definitions. +-- As a subsequent result, gsmSRF-gsmSCF-abstract-syntax uses version8(7) OPERATION +-- definitions. That ABSTRACT-SYNTAX is used in the gsmSRF-gsmSCF-ac APPLICATION-CONTEXT +-- definition (CAP from gsmSRF to gsmSCF). + +gsmSRF-gsmSCF-abstract-syntax ABSTRACT-SYNTAX ::= { + BASIC-gsmSRF-gsmSCF-PDUs + IDENTIFIED BY id-as-basic-gsmSRF-gsmSCF} +-- 'BASIC-gsmSRF-gsmSCF-PDUs' is defined in the present module. + +BASIC-gsmSRF-gsmSCF-PDUs ::= TCMessage {{GsmSRFgsmSCFInvokable}, + {GsmSRFgsmSCFReturnable}} +-- 'GsmSRFgsmSCFInvokable' and 'GsmSRFgsmSCFReturnable' are defined in the present module. + +GsmSRFgsmSCFInvokable OPERATION ::= { + activityTest | + assistRequestInstructions {CAPSpecificBoundSet} | + cancel {CAPSpecificBoundSet} | + playAnnouncement {CAPSpecificBoundSet} | + promptAndCollectUserInformation {CAPSpecificBoundSet} | + specializedResourceReport +} +-- The OPERATION definitions are IMPORTED from CAP-gsmSSF-gsmSCF-ops-args and from +-- CAP-gsmSCF-gsmSRF-ops-args. + +GsmSRFgsmSCFReturnable OPERATION ::= { + activityTest | + assistRequestInstructions {CAPSpecificBoundSet} | + cancel {CAPSpecificBoundSet} | + playAnnouncement {CAPSpecificBoundSet} | + promptAndCollectUserInformation {CAPSpecificBoundSet} +} +-- The OPERATION definitions are IMPORTED from CAP-gsmSSF-gsmSCF-ops-args and from +-- CAP-gsmSCF-gsmSRF-ops-args. + +END + +``` + +## 7 SMS Control + +This clause defines the protocol used for CAMEL control of MO SMS and MT SMS. CAMEL control of MO SMS uses version 3 of the application context, and CAMEL control of MT SMS uses version 4 of the application context. + +### 7.1 SMS operations and arguments + +``` + +CAP-SMS-ops-args {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) umts-network(1) +modules(3) cap-SMS-ops-args(105) version8(7)} +-- The module CAP-SMS-ops-args is updated to version8(7) for Rel-6. The OPERATION definitions +-- are not modified. + +``` + +``` +DEFINITIONS IMPLICIT TAGS::= BEGIN + +-- This module contains the operations and operation arguments used for the +-- smsSSSF- gsmSCF interface, for the control of MO-SMS and MT-SMS. + +-- The table in subclause 2.1 lists the specifications that contain the modules +-- that are used by CAP. + +IMPORTS + + errortypes, + datatypes, + operationcodes, + classes, + ros-InformationObjects, + tc-Messages +FROM CAP-object-identifiers {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) +umts-network(1) modules(3) cap-object-identifiers(100) version8(7)} + + OPERATION +FROM Remote-Operations-Information-Objects ros-InformationObjects + + ServiceKey +FROM CS1-DataTypes {itu-t(0) identified-organization(4) etsi(0) inDomain(1) in-network(1) +modules(0) cs1-datatypes(2) version1(0)} + + MiscCallInfo +FROM CS2-datatypes {itu-t(0) identified-organization(4) etsi(0) inDomain(1) in-network(1) +cs2(20) modules(0) in-cs2-datatypes (0) version1(0)} + + IMEI, + IMSI, + ISDN-AddressString +FROM MAP-CommonDataTypes {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) +gsm-Network(1) modules(3) map-CommonDataTypes(18) version12(12)} + + GPRSMSClass, + LocationInformation, + MS-Classmark2 +FROM MAP-MS-DataTypes {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) +gsm-Network(1) modules(3) map-MS-DataTypes(11) version12(12)} + + PARAMETERS-BOUND +FROM CAP-classes classes + + opcode-connectSMS, + opcode-continueSMS, + opcode-eventReportSMS, + opcode-furnishChargingInformationSMS, + opcode-initialDPSMS, + opcode-releaseSMS, + opcode-requestReportSMSEvent, + opcode-resetTimerSMS +FROM CAP-operationcodes operationcodes +-- The CAP Operation identifiers for CAP V3 and CAP V4 for SMS in Rel-6 are the same as in Rel-5. + + CalledPartyBCDNumber {}, + EventSpecificInformationSMS, + EventTypeSMS, + Extensions {}, + FCISMSBillingChargingCharacteristics, + LocationInformationGPRS, + RPCause, + SMS-AddressString, + SMSEvent, + TimeAndTimezone {}, + TimerID, + TimerValue, + TPDataCodingScheme, + TPProtocolIdentifier, + TPShortMessageSpecificInfo, + TPValidityPeriod +FROM CAP-datatypes datatypes +-- For Rel-6, the CAP-datatypes module is updated to version8(7); Object Identifier 'datatypes' +-- is also updated to version8(7). As a result, the present module uses Rel-6 data type definitions. + + missingCustomerRecord, + missingParameter, +``` + +``` + +parameterOutOfRange, +systemFailure, +taskRefused, +unexpectedComponentSequence, +unexpectedDataValue, +unexpectedParameter +FROM CAP-errorTypes errorTypes +-- For Rel-6, the CAP-errorTypes module is updated to version8(7); Object Identifier +-- 'errorTypes' is also updated to version8(7). As a result, the present module uses Rel-6 +-- error type definitions. + +CallReferenceNumber +FROM MAP-CH-DataTypes {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) +gsm-Network(1) modules(3) map-CH-DataTypes(13) version12(12)} + +; + +connectSMS {PARAMETERS-BOUND : bound} OPERATION ::= { + ARGUMENT ConnectSMSArg {bound} + RETURN RESULT FALSE + ERRORS {missingParameter | + parameterOutOfRange | + systemFailure | + taskRefused | + unexpectedComponentSequence | + unexpectedDataValue | + unexpectedParameter} + CODE opcode-connectSMS} +-- Direction: gsmSCF -> gsmSSF or gprsSSF, Timer: Tconsms +-- This operation is used to request the smsSSF to perform the SMS processing +-- actions to route or forward a short message to a specified destination. + +ConnectSMSArg {PARAMETERS-BOUND : bound} ::= SEQUENCE { + callingPartyNumber [0] SMS-AddressString OPTIONAL, + destinationSubscriberNumber [1] CalledPartyBCDNumber {bound} OPTIONAL, + smSCAddress [2] ISDN-AddressString OPTIONAL, + extensions [10] Extensions {bound} OPTIONAL, + ... +} + +continueSMS OPERATION ::= { + RETURN RESULT FALSE + ALWAYS RESPONDS FALSE + CODE opcode-continueSMS} +-- Direction: gsmSCF -> smsSSF, Timer: Tcuesms +-- This operation is used to request the smsSSF to proceed with +-- Short Message processing at the DP at which it previously suspended +-- Short Message processing to await gsmSCF instructions (i.e. proceed +-- to the next Point in Association in the SMS FSM). The smsSSF +-- continues SMS processing without substituting new data from the gsmSCF. + +eventReportSMS {PARAMETERS-BOUND : bound} OPERATION ::= { + ARGUMENT EventReportSMSArg {bound} + RETURN RESULT FALSE + ALWAYS RESPONDS FALSE + CODE opcode-eventReportSMS} +-- Direction: gsmSSF or gprsSSF -> gsmSCF, Timer: Terbsms +-- This operation is used to notify the gsmSCF of a Short Message related event (FSM events +-- such as submission, delivery or failure) previously requested by the gsmSCF in a +-- RequestReportSMSEvent operation. + +EventReportSMSArg {PARAMETERS-BOUND : bound} ::= SEQUENCE { + eventTypeSMS [0] EventTypeSMS, + eventSpecificInformationSMS [1] EventSpecificInformationSMS OPTIONAL, + miscCallInfo [2] MiscCallInfo DEFAULT {messageType request}, + extensions [10] Extensions {bound} OPTIONAL, + ... +} + +furnishChargingInformationSMS {PARAMETERS-BOUND : bound} OPERATION ::= { + ARGUMENT FurnishChargingInformationSMSArg {bound} + RETURN RESULT FALSE + ERRORS {missingParameter | + taskRefused | + unexpectedComponentSequence | + unexpectedDataValue | + unexpectedParameter} + +``` + +``` + + CODE opcode-furnishChargingInformationSMS} +-- Direction: gsmSCF -> gsmSSF or gprsSSF, Timer: Tfcisms +-- This operation is used to request the smsSSF to generate, register a charging record +-- or to include some information in the default SM record. The registered charging record is +-- intended for off line charging of the Short Message. + +``` + +``` + +FurnishChargingInformationSMSArg {PARAMETERS-BOUND : bound} ::= + FCISMSBillingChargingCharacteristics {bound} + +``` + +``` + +initialDPSMS {PARAMETERS-BOUND : bound} OPERATION ::= { + ARGUMENT InitialDPSMSArg {bound} + RETURN RESULT FALSE + ERRORS {missingCustomerRecord | + missingParameter | + parameterOutOfRange | + systemFailure | + taskRefused | + unexpectedComponentSequence | + unexpectedDataValue | + unexpectedParameter} + CODE opcode-initialDPSMS} +-- Direction: gsmSSF or gprsSSF -> gsmSCF, Timer: Tidpsms +-- This operation is used after a TDP to indicate request for service. + +``` + +``` + +InitialDPSMSArg {PARAMETERS-BOUND : bound} ::= SEQUENCE { + serviceKey [0] ServiceKey, + destinationSubscriberNumber [1] CalledPartyBCDNumber {bound} OPTIONAL, + callingPartyNumber [2] SMS-AddressString OPTIONAL, + eventTypeSMS [3] EventTypeSMS OPTIONAL, + iMSI [4] IMSI OPTIONAL, + locationInformationMSC [5] LocationInformation OPTIONAL, + locationInformationGPRS [6] LocationInformationGPRS OPTIONAL, + sMSCAddress [7] ISDN-AddressString OPTIONAL, + timeAndTimezone [8] TimeAndTimezone {bound} OPTIONAL, + tpShortMessageSpecificInfo [9] TPShortMessageSpecificInfo OPTIONAL, + tpProtocolIdentifier [10] TPProtocolIdentifier OPTIONAL, + tpDataCodingScheme [11] TPDataCodingScheme OPTIONAL, + tpValidityPeriod [12] TPValidityPeriod OPTIONAL, + extensions [13] Extensions {bound} OPTIONAL, + ..., + smsReferenceNumber [14] CallReferenceNumber OPTIONAL, + mscAddress [15] ISDN-AddressString OPTIONAL, + sgsn-Number [16] ISDN-AddressString OPTIONAL, + ms-Classmark2 [17] MS-Classmark2 OPTIONAL, + gPRSMSClass [18] GPRSMSClass OPTIONAL, + iMEI [19] IMEI OPTIONAL, + calledPartyNumber [20] ISDN-AddressString OPTIONAL +} + +``` + +-- The UserCSGInformation is conveyed in the LocationInformation for CS and LocationInformationGPRS + -- for GPRS. The encoding of the parameter is as defined in 3GPP TS 29.002 [11]. + +``` + +releaseSMS OPERATION ::= { + ARGUMENT ReleaseSMSArg + RETURN RESULT FALSE + ALWAYS RESPONDS FALSE + CODE opcode-releaseSMS} +-- Direction: gsmSCF -> gsmSSF or gprsSSF, Timer: Trelsms +-- This operation is used to prevent an attempt to submit or deliver a short message. + +``` + +``` +ReleaseSMSArg ::= RPCause +``` + +``` + +requestReportSMSEvent {PARAMETERS-BOUND : bound} OPERATION ::= { + ARGUMENT RequestReportSMSEventArg {bound} + RETURN RESULT FALSE + ERRORS {missingParameter | + parameterOutOfRange | + systemFailure | + taskRefused | + unexpectedComponentSequence | + unexpectedDataValue | + unexpectedParameter} + CODE opcode-requestReportSMSEvent} +-- Direction: gsmSCF -> gsmSSF or gprsSSF, Timer: Trrbsms +-- This operation is used to request the gsmSSF or gprsSSF to monitor for a +-- Short Message related event (FSM events such as submission, delivery or failure) +-- and to send a notification to the gsmSCF when the event is detected. + +``` + +``` + +RequestReportSMSEventArg {PARAMETERS-BOUND : bound} ::= SEQUENCE { + smSEvents [0] SEQUENCE SIZE (1..bound.&numOfSMSEvents) OF SMSEvent, + extensions [10] Extensions {bound} OPTIONAL, + ... +} + +-- Indicates the Short Message related events(s) for notification. + +resetTimerSMS {PARAMETERS-BOUND : bound} OPERATION ::= { + ARGUMENT ResetTimerSMSArg {bound} + RETURN RESULT FALSE + ERRORS {missingParameter | + parameterOutOfRange | + taskRefused | + unexpectedComponentSequence | + unexpectedDataValue | + unexpectedParameter} + CODE opcode-resetTimerSMS} + +-- Direction: gsmSCF -> smsSSF, Timer: Trtsms +-- This operation is used to request the smsSSF to refresh an application +-- timer in the smsSSF. + +ResetTimerSMSArg {PARAMETERS-BOUND : bound} ::= SEQUENCE { + timerID [0] TimerID DEFAULT tssf, + timervalue [1] TimerValue, + extensions [2] Extensions {bound} OPTIONAL, + ... +} + +END + +``` + +### 7.1.1 Operation timers + +The following value ranges apply for operation specific timers in CAP: + +| | | +|---------|-------------------------| +| short: | 1 to 20 seconds; | +| medium: | 1 to 60 seconds; | +| long: | 1 second to 30 minutes. | + +Table 7-1 lists all operation timers and the value range for each timer. The definitive value for each operation timer may be network specific and has to be defined by the network operator. + +**Table 7-1: Operation timers and their value range** + +| Operation Name | Timer | Value range | +|-------------------------------|---------------------|-------------| +| ConnectSMS | T consms | Short | +| ContinueSMS | T cuesms | Short | +| EventReportSMS | T erbsms | Short | +| FurnishChargingInformationSMS | T fcisms | Short | +| InitialDPSMS | T idpsms | Short | +| ReleaseSMS | T relsms | Short | +| RequestReportSMSEvent | T rrbsms | Short | +| ResetTimerSMS | T rtsms | Short | + +## 7.2 SMS contracts, packages and ACs + +### 7.2.1 smsSSF/gsmSCF ASN.1 module + +``` + +CAP-smsSSF-gsmSCF-pkgs-contracts-ac {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) +umts-network(1) modules(3) cap-smsSSF-gsmSCF-pkgs-contracts-ac(106) version8(7)} + +``` + +``` + +DEFINITIONS ::= BEGIN + +``` + +``` + +-- This module specifies the Operation Packages, Contracts, Application Contexts +-- and Abstract Syntaxes used for the smsSSF - gsmSCF interface, for the + +``` + +``` + +-- control of MO-SMS and MT-SMS. + +-- The table in subclause 2.1 lists the specifications that contain the modules +-- that are used by CAP. + +IMPORTS + + PARAMETERS-BOUND, + cAPSpecificBoundSet +FROM CAP-classes classes +-- Elements that exist in cAPSpecificBoundSet in Rel-5 are not changed in Rel-6. As a +-- result, the value range of data type definitions in Rel-5 are not changed in Rel-6. + + CONTRACT, + OPERATION-PACKAGE, + OPERATION +FROM Remote-Operations-Information-Objects ros-InformationObjects + + TCMessage {} +FROM TCAPMessages tc-Messages + + APPLICATION-CONTEXT, + dialogue-abstract-syntax +FROM TC-Notation-Extensions tc-NotationExtensions + + connectSMS{}, + continueSMS, + eventReportSMS{}, + furnishChargingInformationSMS{}, + initialDPSMS{}, + releaseSMS, + requestReportSMSEvent{}, + resetTimerSMS{} +FROM CAP-SMS-ops-args sms-Operations +-- Object Identifier 'sms-Operations' is updated to version8(7) in Rel-6. As a result, +-- the present module, 'CAP-smsSSF-gsmSCF-pkgs-contracts-ac', IMPORTS CAP Operation +-- definitions from CAP-SMS-ops-args version8(7). Operation definitions are used in the +-- ABSTRACT SYNTAX definitions and in the OPERATION PACKAGE definitions. + + id-ac-cap3-sms-AC, + id-ac-cap4-sms-AC, +-- The APPLICATION-CONTEXT Identifiers for CAP V3 and CAP V4 for SMS in Rel-6 are the same as +-- in Rel-5. + + id-cap3SmsSsfTogsmScf, + id-cap4SmsSsfTogsmScf, +-- The CONTRACT Identifiers for CAP V3 and CAP V4 for SMS in Rel-6 are the same as in Rel-5. + + id-package-smsActivation, + id-package-smsConnect, + id-package-smsContinue, + id-package-smsRelease, + id-package-smsEventHandling, + id-package-smsBilling, + id-package-smsTimer, +-- The OPERATION-PACKAGE Identifiers for CAP V3 and CAP V4 for SMS in Rel-6 are the same as +-- in Rel-5. + + sms-Operations, +-- Object Identifier sms-Operations is updated to version8(7) in Rel-6. As a result, the present +-- module, 'CAP-smsSSF-gsmSCF-pkgs-contracts-ac', IMPORTS Rel-6 versions of the CAP Operation +-- definitions. + + tc-NotationExtensions, + tc-Messages, + ros-InformationObjects, + classes, + + id-as-smsSSF-gsmSCF-AS +-- The ABSTRACT-SYNTAX Identifiers for CAP V3 and CAP V4 for SMS in Rel-6 are the same as +-- in Rel-5. + +FROM CAP-object-identifiers {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) +umts-network(1) modules(3) cap-object-identifiers(100) version8(7)} + +; + +-- Application Contexts +``` + +``` +-- Rel-6 uses the same Application Context versions for SMS as Rel-5. The CONTRACT and ABSTRACT +-- SYNTAXES for SMS are defined in Rel-6. +``` + +``` +-- Refer to ITU-T Recommendation Q.775 for the formal definition of APPLICATION-CONTEXT. +-- The structured DIALOGUE MODE is defined in ITU-T Recommendation Q.771; the +-- dialogue-abstract-syntax ABSTRACT SYNTAX is defined in ITU-T Recommendation Q.775. +``` + +``` +cap3-sms-AC APPLICATION-CONTEXT ::= { +``` + +``` + CONTRACT cap3SMS + DIALOGUE MODE structured + ABSTRACT SYNTAXES {dialogue-abstract-syntax | + sms-AbstractSyntax} + APPLICATION CONTEXT NAME id-ac-cap3-sms-AC} +``` + +``` +-- This application context shall be used for CAMEL support of MO-SMS. +``` + +``` +-- 'cap3SMS' and 'sms-AbstractSyntax' are defined in the present module. +``` + +``` +cap4-sms-AC APPLICATION-CONTEXT ::= { +``` + +``` + CONTRACT cap4SMS + DIALOGUE MODE structured + ABSTRACT SYNTAXES {dialogue-abstract-syntax | + sms-AbstractSyntax} + APPLICATION CONTEXT NAME id-ac-cap4-sms-AC} +``` + +``` +-- This application context shall be used for CAMEL support of MT-SMS. +``` + +``` +-- 'cap4SMS' and 'sms-AbstractSyntax' are defined in the present module. +``` + +``` +-- Contracts +``` + +``` +-- The CONTRACT definitions for SMS in Rel-6 use OPERATION-PACKAGE definitions which are +``` + +``` +-- defined in Rel-6. +``` + +``` +cap3SMS CONTRACT ::= { +``` + +``` +-- dialogue initiated by gprsSSF or gsmSSF with InitialDPSMS Operation +``` + +``` + INITIATOR CONSUMER OF {smsActivationPackage {CAPSpecificBoundSet}} + RESPONDER CONSUMER OF {smsConnectPackage {CAPSpecificBoundSet} | + smsReleasePackage | + smsEventHandlingPackage {CAPSpecificBoundSet} | + smsTimerPackage {CAPSpecificBoundSet} | + smsBillingPackage {CAPSpecificBoundSet} | + smsProcessingPackage} +``` + +``` + ID id-cap3SmsSsfTogsmScf} +``` + +``` +-- The OPERATION-PACKAGES are defined in the present module. +``` + +``` +cap4SMS CONTRACT ::= { +``` + +``` +-- dialogue initiated by gprsSSF or gsmSSF with InitialDPSMS Operation +``` + +``` + INITIATOR CONSUMER OF {smsActivationPackage {CAPSpecificBoundSet}} + RESPONDER CONSUMER OF {smsConnectPackage {CAPSpecificBoundSet} | + smsReleasePackage | + smsEventHandlingPackage {CAPSpecificBoundSet} | + smsTimerPackage {CAPSpecificBoundSet} | + smsBillingPackage {CAPSpecificBoundSet} | + smsProcessingPackage } +``` + +``` + ID id-cap4SmsSsfTogsmScf} +``` + +``` +-- The OPERATION-PACKAGES are defined in the present module. +``` + +``` +-- Operation Packages +``` + +``` +-- The OPERATION-PACKAGE definitions for SMS in Rel-6 use Operation definitions from Rel-6. The +``` + +``` +-- OPERATION definitions are IMPORTED from CAP-SMS-ops-args. +``` + +``` +smsActivationPackage {PARAMETERS-BOUND : bound} OPERATION-PACKAGE ::= { +``` + +``` + CONSUMER INVOKE {initialDPSMS {bound}} + ID id-package-smsActivation} +``` + +``` +smsConnectPackage {PARAMETERS-BOUND : bound} OPERATION-PACKAGE ::= { +``` + +``` + CONSUMER INVOKE {connectSMS {bound}} + ID id-package-smsConnect} +``` + +``` +smsProcessingPackage OPERATION-PACKAGE ::= { +``` + +``` + CONSUMER INVOKE {continueSMS} + ID id-package-smsContinue} +``` + +``` +smsReleasePackage OPERATION-PACKAGE ::= { +``` + +``` + CONSUMER INVOKE {releaseSMS} +``` + +``` + +ID id-package-smsRelease} + +smsEventHandlingPackage {PARAMETERS-BOUND : bound} OPERATION-PACKAGE ::= { + CONSUMER INVOKES {requestReportSMSEvent {bound}} + SUPPLIER INVOKES {eventReportSMS {bound}} + ID id-package-smsEventHandling} + +smsBillingPackage {PARAMETERS-BOUND : bound} OPERATION-PACKAGE ::= { + CONSUMER INVOKES {furnishChargingInformationSMS {bound}} + ID id-package-smsBilling} + +smsTimerPackage {PARAMETERS-BOUND : bound} OPERATION-PACKAGE ::= { + CONSUMER INVOKES {resetTimerSMS {bound}} + ID id-package-smsTimer} + +-- Abstract Syntaxes + +-- SmsInvokable and SmsReturnable use OPERATION definitions with version8(7). As a result, +-- Generic-sms-PDUs uses version8(7) OPERATION definitions. As a subsequent result, +-- sms-AbstractSyntax uses version8(7) OPERATION definitions. That ABSTRACT-SYNTAX is used +-- in the cap3-sms-AC APPLICATION-CONTEXT definition and in the and cap4-sms-AC APPLICATION- +-- CONTEXT definition (CAP from smsSSF to gsmSCF). + +sms-AbstractSyntax ABSTRACT-SYNTAX ::= { + Generic-sms-PDUs + IDENTIFIED BY id-as-smsSSF-gsmSCF-AS } +-- 'Generic-sms-PDUs' is defined in the present module. + +Generic-sms-PDUs ::= TCMessage {{SmsInvokable}, + {SmsReturnable}} +-- 'SmsInvokable' and 'SmsReturnable' are defined in the present module. + +SmsInvokable OPERATION ::= { + connectSMS {cAPSpecificBoundSet} | + eventReportSMS {cAPSpecificBoundSet} | + furnishChargingInformationSMS {cAPSpecificBoundSet} | + initialDPSMS {cAPSpecificBoundSet} | + requestReportSMSEvent {cAPSpecificBoundSet} | + resetTimerSMS {cAPSpecificBoundSet}} +-- The OPERATION definitions are IMPORTED from CAP-SMS-ops-args version8(7). + +SmsReturnable OPERATION ::= { + connectSMS {cAPSpecificBoundSet} | + continueSMS | + furnishChargingInformationSMS {cAPSpecificBoundSet} | + initialDPSMS {cAPSpecificBoundSet} | + releaseSMS | + requestReportSMSEvent {cAPSpecificBoundSet} | + resetTimerSMS {cAPSpecificBoundSet}} +-- The OPERATION definitions are IMPORTED from CAP-SMS-ops-args version8(7). + +END + +``` + +## 8 GPRS Control + +### 8.1 gsmSCF/gprsSSF operations and arguments + +``` + +CAP-gprsSSF-gsmSCF-ops-args {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) + umts-network(1) modules(3) cap-GPRS-ops-args(107) version8(7)} +-- Module CAP-gprsSSF-gsmSCF-ops-args is updated to version8(7) for Rel-6. The OPERATION +-- definitions in this module are not modified, compared to Rel-5. + +``` + +``` +DEFINITIONS IMPLICIT TAGS ::= BEGIN +``` + +``` + +-- This module contains the operations and operation arguments used for the +-- gprsSSF - gsmSCF interface, for the control of GPRS. + +-- The table in subclause 2.1 lists the specifications that contain the modules +-- that are used by CAP. + +``` + +``` +IMPORTS +``` + +``` + errortypes, +``` + +``` + datatypes, + operationcodes, + classes, + ros-InformationObjects +FROM CAP-object-identifiers {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) +umts-network(1) modules(3) cap-object-identifiers(100) version8(7)} + + OPERATION +FROM Remote-Operations-Information-Objects ros-InformationObjects + + ServiceKey +FROM CS1-DataTypes {itu-t(0) identified-organization(4) etsi(0) inDomain(1) in-network(1) +modules(0) cs1-datatypes(2) version1(0)} + + MiscCallInfo +FROM CS2-datatypes {itu-t(0) identified-organization(4) etsi(0) inDomain(1) in-network(1) +cs2(20) modules(0) in-cs2-datatypes(0) version1(0)} + + IMEI, + IMSI, + ISDN-AddressString +FROM MAP-CommonDataTypes {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) +gsm-Network(1) modules(3) map-CommonDataTypes(18) version12(12)} + + GPRSChargingID, + GPRSMSClass, + GSN-Address, + RAIdentity +FROM MAP-MS-DataTypes {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) +gsm-Network(1) modules(3) map-MS-DataTypes(11) version12(12)} + + PARAMETERS-BOUND +FROM CAP-classes classes + + opcode-activityTestGPRS, + opcode-applyChargingGPRS, + opcode-applyChargingReportGPRS, + opcode-cancelGPRS, + opcode-connectGPRS, + opcode-continueGPRS, + opcode-entityReleasedGPRS, + opcode-eventReportGPRS, + opcode-furnishChargingInformationGPRS, + opcode-initialDPGPRS, + opcode-releaseGPRS, + opcode-requestReportGPRSEvent, + opcode-resetTimerGPRS, + opcode-sendChargingInformationGPRS +FROM CAP-operationcodes operationcodes +-- The CAP Operation identifiers for CAP V3 for GPRS in Rel-6 are the same as the CAP Operation +-- identifiers for CAP V3 for GPRS in Rel-5. + + AccessPointName {}, + GPRSCause {}, + ChargingCharacteristics, + ChargingResult, + ChargingRollOver, + EndUserAddress, + Extensions, + FCIGPRSBillingChargingCharacteristics, + GPRSEventSpecificInformation {}, + GPRSEvent, + GPRSEventType, + LocationInformationGPRS, + PDPID, + PDPInitiationType, + QualityOfService, + SCIGPRSBillingChargingCharacteristics {}, + SGSNCapabilities, + TimeAndTimezone {}, + TimerID, + TimerValue +FROM CAP-datatypes datatypes +-- For Rel-6, the CAP-datatypes module is updated to version8(7); Object Identifier 'datatypes' +-- is also updated to version8(7). As a result, the present module uses Rel-6 data type definitions. + + missingCustomerRecord, + missingParameter, +``` + +``` + +parameterOutOfRange, +systemFailure, +taskRefused, +unexpectedComponentSequence, +unexpectedDataValue, +unexpectedParameter, +unknownPDPID +FROM CAP-errortypes errortypes +-- For Rel-6, the CAP-errortypes module is updated to version8(7); Object Identifier +-- 'errortypes' is also updated to version8(7). As a result, the present module uses Rel-6 +-- error type definitions. + +; + +activityTestGPRS OPERATION ::= { + RETURN RESULT TRUE + CODE opcode-activityTestGPRS} +-- Direction: gsmSCF -> gprsSSF, Timer: Tatg +-- This operation is used to check for the continued existence of a relationship between the gsmSCF +-- and gprsSSF. If the relationship is still in existence, then the gprsSSF will respond. If no +-- reply is received, then the gsmSCF will assume that the gprsSSF has failed in some way +-- and will take the appropriate action. + +applyChargingGPRS OPERATION ::= { + ARGUMENT ApplyChargingGPRSArg + RETURN RESULT FALSE + ERRORS {missingParameter | + unexpectedComponentSequence | + unexpectedParameter | + unexpectedDataValue | + parameterOutOfRange | + systemFailure | + taskRefused | + unknownPDPID} + CODE opcode-applyChargingGPRS} +-- Direction gsmSCF -> gprsSSF, Timer Tacg +-- This operation is used for interacting from the gsmSCF with the gprsSSF CSE-controlled +-- GPRS session or PDP Context charging mechanism. + +ApplyChargingGPRSArg ::= SEQUENCE { + chargingCharacteristics [0] ChargingCharacteristics, + tariffSwitchInterval [1] INTEGER (1..86400) OPTIONAL, + pDPID [2] PDPID OPTIONAL, + ... +} +-- tariffSwitchInterval is measured in 1 second units. + +applyChargingReportGPRS OPERATION ::= { + ARGUMENT ApplyChargingReportGPRSArg + RETURN RESULT TRUE + ERRORS {missingParameter | + unexpectedComponentSequence | + unexpectedParameter | + unexpectedDataValue | + parameterOutOfRange | + systemFailure | + taskRefused | + unknownPDPID} + CODE opcode-applyChargingReportGPRS} +-- Direction gprsSSF -> gsmSCF, Timer Tacrg +-- The ApplyChargingReportGPRS operation provides the feedback from the gprsSSF to the gsmSCF +-- CSE-controlled GPRS session charging mechanism. + +ApplyChargingReportGPRSArg ::= SEQUENCE { + chargingResult [0] ChargingResult, + qualityOfService [1] QualityOfService OPTIONAL, + active [2] BOOLEAN DEFAULT TRUE, + pDPID [3] PDPID OPTIONAL, + ..., + chargingRollOver [4] ChargingRollOver OPTIONAL +} + +cancelGPRS OPERATION ::= { + ARGUMENT CancelGPRSArg + RETURN RESULT FALSE + ERRORS {missingParameter | + taskRefused | + +``` + +``` + + unknownPDPID} + CODE opcode-cancelGPRS} +-- Direction: gsmSCF -> gprsSSF, Timer: Tcag +-- This generic operation cancels all previous requests, +-- i.e. all EDPs and reports can be cancelled by the gsmSCF. + +CancelGPRSArg ::= SEQUENCE { + pDPID [0] PDPID OPTIONAL, + ... +} + +connectGPRS {PARAMETERS-BOUND: bound} OPERATION ::= { + ARGUMENT ConnectGPRSArg {bound} + RETURN RESULT FALSE + ERRORS {missingParameter | + parameterOutOfRange | + unknownPDPID | + systemFailure | + taskRefused | + unexpectedComponentSequence | + unexpectedDataValue | + unexpectedParameter} + CODE opcode-connectGPRS} +-- Direction: gsmSCF -> gprsSSF, Timer: Tcong +-- This operation is used to modify the Access Point Name used when establishing a PDP Context. + +ConnectGPRSArg {PARAMETERS-BOUND: bound} ::= SEQUENCE { + accessPointName [0] AccessPointName {bound}, + pDPID [1] PDPID OPTIONAL, + ... +} + +continueGPRS OPERATION ::= { + ARGUMENT ContinueGPRSArg + RETURN RESULT FALSE + ERRORS {missingParameter | + unknownPDPID | + unexpectedDataValue} + CODE opcode-continueGPRS} +-- Direction: gsmSCF -> gprsSSF, Timer: Tcueg +-- This operation is used to request the gprsSSF to proceed with processing at the DP at +-- which it previously suspended processing to await gsmSCF instructions (i.e., proceed to +-- the next point in processing in the Attach/Detach state model or PDP Context +-- state model) substituting new data from the gsmSCF. + +ContinueGPRSArg ::= SEQUENCE { + pDPID [0] PDPID OPTIONAL, + ... +} + +entityReleasedGPRS {PARAMETERS-BOUND : bound} OPERATION ::= { + ARGUMENT EntityReleasedGPRSArg {bound} + RETURN RESULT TRUE + ERRORS {missingParameter | + taskRefused | + unknownPDPID} + CODE opcode-entityReleasedGPRS} +-- Direction: gprsSSF -> gsmSCF, Timer: Terg +-- This operation is used when the GPRS Session is detached or a PDP Context is disconnected and +-- the associated event is not armed for reporting. +-- The usage of this operation is independent of the functional entity that initiates the Detach +-- or PDP Context Disconnection and is independent of the cause of the Detach or PDP Context +-- Disconnect. + +EntityReleasedGPRSArg {PARAMETERS-BOUND : bound} ::= SEQUENCE { + gPRSCause [0] GPRSCause {bound}, + pDPID [1] PDPID OPTIONAL, + ... +} + +eventReportGPRS {PARAMETERS-BOUND : bound} OPERATION ::= { + ARGUMENT EventReportGPRSArg {bound} + RETURN RESULT TRUE + ERRORS {unknownPDPID} + CODE opcode-eventReportGPRS} +-- Direction gprsSSF -> gsmSCF, Timer Tereg +-- This operation is used to notify the gsmSCF of a GPRS session or PDP context related + +``` + +``` + +-- events (e.g. PDP context activation) previously requested by the gsmSCF in a +-- RequestReportGPRSEventoperation. + +EventReportGPRSArg {PARAMETERS-BOUND : bound} ::= SEQUENCE { + gPRSEventType [0] GPRSEventType, + miscGPRSInfo [1] MiscCallInfo DEFAULT {messageType request}, + gPRSEventSpecificInformation [2] GPRSEventSpecificInformation {bound} OPTIONAL, + pDPID [3] PDPID OPTIONAL, + ... +} + +furnishChargingInformationGPRS {PARAMETERS-BOUND : bound} OPERATION ::= { + ARGUMENT FurnishChargingInformationGPRSArg {bound} + RETURN RESULT FALSE + ERRORS {missingParameter | + taskRefused | + unexpectedComponentSequence | + unexpectedDataValue | + unexpectedParameter | + unknownPDPID} + CODE opcode-furnishChargingInformationGPRS} +-- Direction: gsmSCF -> gprsSSF, Timer: Tfcig +-- This operation is used to request the gprsSSF to generate, register a logical record or to +-- include some information in the default logical GPRS record. +-- The registered logical record is intended for off line charging of the GPRS session +-- or PDP Context. + +FurnishChargingInformationGPRSArg {PARAMETERS-BOUND : bound} ::= + FCIGPRSBillingChargingCharacteristics{bound} + +initialDPGPRS {PARAMETERS-BOUND : bound} OPERATION ::= { + ARGUMENT InitialDPGPRSArg {bound} + RETURN RESULT FALSE + ERRORS {missingCustomerRecord | + missingParameter | + parameterOutOfRange | + systemFailure | + taskRefused | + unexpectedComponentSequence | + unexpectedDataValue | + unexpectedParameter} + CODE opcode-initialDPGPRS} +-- Direction gprsSSF -> gsmSCF, Timer Tidpg +-- This operation is used by the gprsSSF when a trigger is detected at a DP in the GPRS state +-- machines to request instructions from the gsmSCF + +InitialDPGPRSArg {PARAMETERS-BOUND : bound} ::= SEQUENCE { + serviceKey [0] ServiceKey, + gPRSEventType [1] GPRSEventType, + mSISDN [2] ISDN-AddressString, + iMSI [3] IMSI, + timeAndTimeZone [4] TimeAndTimezone {bound}, + gPRSMSClass [5] GPRSMSClass OPTIONAL, + endUserAddress [6] EndUserAddress {bound} OPTIONAL, + qualityOfService [7] QualityOfService OPTIONAL, + accessPointName [8] AccessPointName{bound} OPTIONAL, + routeingAreaIdentity [9] RAIdentity OPTIONAL, + chargingID [10] GPRSChargingID OPTIONAL, + sGSNCapabilities [11] SGSNCapabilities OPTIONAL, + locationInformationGPRS [12] LocationInformationGPRS OPTIONAL, + pDPInitiationType [13] PDPInitiationType OPTIONAL, + extensions [14] Extensions {bound} OPTIONAL, + ... + gGSNAddress [15] GSN-Address OPTIONAL, + secondaryPDP-context [16] NULL OPTIONAL, + iMEI [17] IMEI OPTIONAL +} +-- The RouteingAreaIdentity parameter is not used. +-- The receiving entity shall ignore RouteingAreaIdentity if received. +-- The RouteingAreaIdentity is conveyed in the LocationInformationGPRS parameter. +-- The CSGInformation is conveyed in the LocationInformationGPRS parameter. The encoding of the +-- parameter is as defined in 3GPP TS 29.002 [11]. + +releaseGPRS {PARAMETERS-BOUND : bound} OPERATION ::= { + ARGUMENT ReleaseGPRSArg {bound} + RETURN RESULT FALSE + ERRORS {missingParameter | + taskRefused | + +``` + +``` + + unknownPDPID} + CODE opcode-releaseGPRS} +-- Direction: gsmSCF -> gprsSSF, Timer: Trg +-- This operation is used to tear down an existing GPRS session or PDP Context at any phase. + +ReleaseGPRSArg {PARAMETERS-BOUND : bound} ::= SEQUENCE { + gprsCause [0] GPRSCause {bound}, + pDPID [1] PDPID OPTIONAL, + ... +} + +requestReportGPRSEvent {PARAMETERS-BOUND : bound} OPERATION ::= { + ARGUMENT RequestReportGPRSEventArg {bound} + RETURN RESULT FALSE + ERRORS {missingParameter | + parameterOutOfRange | + systemFailure | + taskRefused | + unexpectedComponentSequence | + unexpectedDataValue | + unexpectedParameter | + unknownPDPID} + CODE opcode-requestReportGPRSEvent} +-- Direction: gsmSCF -> gprsSSF, Timer: Trrqe +-- This operation is used to request the gprsSSF to monitor for an event (e.g., GPRS events +-- such as attach or PDP Context activation), then send a notification back to the +-- gsmSCF when the event is detected. + +RequestReportGPRSEventArg {PARAMETERS-BOUND : bound} ::= SEQUENCE { + gPRSEvent [0] SEQUENCE SIZE (1..bound.&numOfGPRSEvents) OF GPRSEvent, + pDPID [1] PDPID OPTIONAL, + ... +} +-- Indicates the GPRS related events for notification. + +resetTimerGPRS OPERATION ::= { + ARGUMENT ResetTimerGPRSArg + RETURN RESULT FALSE + ERRORS {missingParameter | + parameterOutOfRange | + taskRefused | + unexpectedComponentSequence | + unexpectedDataValue | + unexpectedParameter | + unknownPDPID} + CODE opcode-resetTimerGPRS} +-- Direction: gsmSCF -> gprsSSF, Timer: Trtg +-- This operation is used to request the gprsSSF to refresh an application timer in the gprsSSF. + +ResetTimerGPRSArg ::= SEQUENCE { + timerID [0] TimerID DEFAULT tssf, + timervalue [1] TimerValue, + ... +} + +sendChargingInformationGPRS {PARAMETERS-BOUND: bound} OPERATION ::= { + ARGUMENT SendChargingInformationGPRSArg { bound} + RETURN RESULT FALSE + ERRORS {missingParameter | + unexpectedComponentSequence | + unexpectedParameter | + parameterOutOfRange | + systemFailure | + taskRefused | + unexpectedDataValue | + unknownPDPID} + CODE opcode-sendChargingInformationGPRS} +-- Direction: gsmSCF -> gprsSSF, Timer: Tscig +-- This operation is used to instruct the gprsSSF on the charging information which the +-- gprsSSF shall send to the Mobile Station by means of GSM access signalling. + +SendChargingInformationGPRSArg {PARAMETERS-BOUND: bound} ::= SEQUENCE { + scIGPRSBillingChargingCharacteristics [0] SCIGPRSBillingChargingCharacteristics {bound}, + ... +} + +END + +``` + +### 8.1.1 GPRS Reference Number + +``` + +CAP-GPRS-ReferenceNumber {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) +umts-network(1) modules(3) cap-dialogueInformation(111) version8(7)} +-- Module CAP-GPRS-ReferenceNumber is updated to version8(7) for Rel-6. The definitions +-- in this module are not modified, compared to Rel-5. + +DEFINITIONS ::= BEGIN + +EXPORTS + id-CAP-GPRS-ReferenceNumber, + cAP-GPRS-ReferenceNumber-Abstract-Syntax; + +IMPORTS + + Integer4 +FROM CS1-DataTypes {itu-t(0) identified-organization(4) etsi(0) inDomain(1) in-network(1) +modules(0) cs1-datatypes(2) version1(0)} +; + +id-CAP-GPRS-ReferenceNumber OBJECT IDENTIFIER ::= {itu-t(0) identified-organization(4) etsi(0) +mobileDomain(0) umts-network(1) as(1) cap-GPRS-ReferenceNumber(5) version3(2)} + +CAP-GPRS-ReferenceNumber-Abstract-Syntax ABSTRACT-SYNTAX ::= {CAP-GPRS-ReferenceNumber IDENTIFIED BY +id-CAP-GPRS-ReferenceNumber} + +CAP-GPRS-ReferenceNumber ::= SEQUENCE { + destinationReference [0] Integer4 OPTIONAL, + originationReference [1] Integer4 OPTIONAL +} +-- This parameter is used to identify the relationship between SGSN and the gsmSCF. + +END -- of CAP-GPRS-ReferenceNumber + +``` + +### 8.1.2 Operation timers + +The following value ranges apply for operation specific timers in CAP: + +| | | +|---------|------------------------| +| short: | 1 to 20 seconds; | +| medium: | 1 to 60 seconds; | +| long: | 1 second to 30 minutes | + +Table 8-1 lists all operation timers and the value range for each timer. The definitive value for each operation timer may be network specific and has to be defined by the network operator. + +**Table 8-1: Operation timers and their value range** + +| Operation Name | Timer | value | +|--------------------------------|-------------------|-------| +| ActivityTestGPRST | T atg | Short | +| ApplyChargingGPRS | T acg | Short | +| ApplyChargingReportGPRS | T acrg | Short | +| CancelGPRS | T cag | Short | +| ConnectGPRS | T cong | Short | +| ContinueGPRS | T cueg | Short | +| EntityReleasedGPRS | T erg | Short | +| EventReportGPRS | T ereg | Short | +| FurnishChargingInformationGPRS | T fcig | Short | +| InitialDPGPRS | T idpg | Short | +| ReleaseGPRS | T trg | Short | +| RequestReportGPRSEvent | T rrqe | Short | +| ResetTimerGPRS | T rtg | Short | +| SendChargingInformationGPRS | T scig | Short | + +## 8.2 gsmSCF/gprsSSF contracts, packages and ACs + +### 8.2.1 gprsSSF/gsmSCF ASN.1 module + +``` + +CAP-gprsSSF-gsmSCF-pkgs-contracts-ac { itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) +umts-network(1) modules(3) cap-gprsSSF-gsmSCF-pkgs-contracts-ac(108) version8(7) } +DEFINITIONS ::= BEGIN + +-- This module specifies the Operation Packages, Contracts, Application Contexts +-- and Abstract Syntaxes used for the gprsSSF - gsmSCF interface, for the +-- control of GPRS. + +-- The table in subclause 2.1 lists the specifications that contain the modules +-- that are used by CAP. + +IMPORTS + + PARAMETERS-BOUND, + cAPSpecificBoundSet +FROM CAP-classes classes +-- Elements that exist in cAPSpecificBoundSet in Rel-5 are not changed in Rel-6. As a +-- result, the value range of data type definitions in Rel-5 are not changed in Rel-6. + + CONTRACT, + OPERATION-PACKAGE, + OPERATION +FROM Remote-Operations-Information-Objects ros-InformationObjects + + TCMessage { } +FROM TCAPMessages tc-Messages + + APPLICATION-CONTEXT, + dialogue-abstract-syntax +FROM TC-Notation-Extensions tc-NotationExtensions + + activityTestGPRS, + applyChargingGPRS, + applyChargingReportGPRS, + cancelGPRS, + connectGPRS {}, + continueGPRS, + entityReleasedGPRS {}, + furnishChargingInformationGPRS {}, + initialDPGPRS {}, + releaseGPRS {}, + eventReportGPRS {}, + requestReportGPRSEvent {}, + +``` + +``` + + resetTimerGPRS, + sendChargingInformationGPRS {} +FROM CAP-gprsSSF-gsmSCF-ops-args gprsSSF-gsmSCF-Operations + + id-ac-CAP-gprsSSF-gsmSCF-AC, + id-ac-CAP-gsmSCF-gprsSSF-AC, +-- The APPLICATION-CONTEXT Object Identifiers for CAP V3 for GPRS in Rel-6 are the same as for +-- CAP V3 for GPRS in Rel-5. + + id-capGprsSsfToGsmScf, + id-capGsmScfToGprsSsf, +-- The CONTRACT Object Identifiers for CAP V3 for GPRS are updated in Rel-6. + + id-as-gprsSSF-gsmSCF-AS, + id-as-gsmSCF-gprsSSF-AS, +-- The ABSTRACT-SYNTAX Object Identifiers for CAP V3 for GPRS are updated in Rel-6. + + id-package-gprsScfActivation, + id-package-gprsConnect, + id-package-gprsContinue, + id-package-gprsRelease, + id-package-gprsEventHandling, + id-package-gprsExceptionInformation, + id-package-gprsTimer, + id-package-gprsBilling, + id-package-gprsCharging, + id-package-gprsChargeAdvice, + id-package-gprsActivityTest, + id-package-gprsCancel, +-- The OPERATION-PACKAGE Object Identifiers for CAP V3 for GPRS are updated in Rel-6. + + classes, + ros-InformationObjects, + tc-Messages, + tc-NotationExtensions, + + gprsSSF-gsmSCF-Operations +-- Object Identifier 'gprsSSF-gsmSCF-Operations' is updated for Rel-6. + +FROM CAP-object-identifiers {itu-t(0) identified-organization(4) etsi(0) mobileDomain(0) +umts-network(1) modules(3) cap-object-identifiers(100) version8(7)} + +; + +-- Application Contexts + +-- The APPLICATION-CONTEXT definitions for CAP V3 for GPRS are updated in Rel-6. +-- However, the APPLICATION-CONTEXT definitions for CAP V3 for GPRS in Rel-6 use the same +-- Object Identifier for APPLICATION CONTEXT NAME as CAP V3 for GPRS in Rel-5. + +-- Refer to ITU-T Recommendation Q.775 for the formal definition of APPLICATION-CONTEXT. +-- The structured DIALOGUE MODE is defined in ITU-T Recommendation Q.771; the +-- dialogue-abstract-syntax ABSTRACT SYNTAX is defined in ITU-T Recommendation Q.775. + +cap-gprssf-scfAC APPLICATION-CONTEXT ::= { + CONTRACT capGprsSsfToScf + DIALOGUE MODE structured + ABSTRACT SYNTAXES {dialogue-abstract-syntax | + gprsSSF-gsmSCFAbstractSyntax} + APPLICATION CONTEXT NAME id-ac-CAP-gprsSSF-gsmSCF-AC} +-- 'capGprsSsfToScf' and 'gprsSSF-gsmSCFAbstractSyntax' are defined in the present +-- module. + +cap-gsmscf-gprssfAC APPLICATION-CONTEXT ::= { + CONTRACT capGsmScfToGprsSsf + DIALOGUE MODE structured + ABSTRACT SYNTAXES {dialogue-abstract-syntax | + gsmSCF-gprsSSFAbstractSyntax} + APPLICATION CONTEXT NAME id-ac-CAP-gsmSCF-gprsSSF-AC} +-- 'capGsmScfToGprsSsf' and 'gsmSCF-gprsSSFAbstractSyntax' are defined in the present +-- module. + +-- Contracts +-- The CONTRACT definitions for CAP V3 for GPRS are updated in Rel-6. + +capGprsSsfToScf CONTRACT ::= { +-- dialogue initiated by gprsSSF with InitialDPGPRS, ApplyChargingReportGPRS, +``` + +``` +-- EntityReleasedGPRS and EventReportGPRS Operations +INITIATOR CONSUMER OF {gprsScfActivationPackage {CAPSSpecificBoundSet}} | + gprsEventHandlingPackage {CAPSSpecificBoundSet} | + gprsChargingPackage | + gprsExceptionInformationPackage {CAPSSpecificBoundSet}} +RESPONDER CONSUMER OF {gprsConnectPackage {CAPSSpecificBoundSet}} | + gprsProcessingPackage | + gprsReleasePackage {CAPSSpecificBoundSet} | + gprsEventHandlingPackage {CAPSSpecificBoundSet} | + gprsTimerPackage | + gprsBillingPackage {CAPSSpecificBoundSet} | + gprsChargingPackage | + gprsCancelPackage | + gprsChargeAdvicePackage {CAPSSpecificBoundSet}} +ID + id-capGprsSsfToGsmScf +-- The OPERATION-PACKAGES are defined in the present module. + +capGsmScfToGprsSsf CONTRACT ::= { +-- dialogue initiated by gsmSCF with ApplyChargingGPRS, ActivityTestGPRS, +-- CancelGPRS, FurnishChargingInformationGPRS, ReleaseGPRS, +-- RequestReportGPRSEvent and SendChargingInformationGPRS Operations +INITIATOR CONSUMER OF {gprsReleasePackage {CAPSSpecificBoundSet}} | + gprsEventHandlingPackage {CAPSSpecificBoundSet} | + gprsBillingPackage {CAPSSpecificBoundSet} | + gprsChargingPackage | + gprsActivityTestPackage | + gprsCancelPackage | + gprsChargeAdvicePackage {CAPSSpecificBoundSet}} +ID + id-capGsmScfToGprsSsf +-- The OPERATION-PACKAGES are defined in the present module. + +-- Operation Packages + +-- The OPERATION-PACKAGE definitions for CAP V3 for GPRS are updated in Rel-6. + +gprsScfActivationPackage {PARAMETERS-BOUND : bound} OPERATION-PACKAGE ::= { + CONSUMER INVOKES {initialDPGPRS {bound}} + ID id-package-gprsScfActivation} + +gprsConnectPackage {PARAMETERS-BOUND : bound} OPERATION-PACKAGE ::= { + CONSUMER INVOKES {connectGPRS {bound}} + ID id-package-gprsConnect} + +gprsProcessingPackage OPERATION-PACKAGE ::= { + CONSUMER INVOKES {continueGPRS } + ID id-package-gprsContinue} + +gprsReleasePackage {PARAMETERS-BOUND : bound} OPERATION-PACKAGE ::= { + CONSUMER INVOKES {releaseGPRS {bound}} + ID id-package-gprsRelease} + +gprsEventHandlingPackage {PARAMETERS-BOUND : bound} OPERATION-PACKAGE ::= { + CONSUMER INVOKES {requestReportGPRSEvent {bound}} + SUPPLIER INVOKES {eventReportGPRS {bound}} + ID id-package-gprsEventHandling} + +gprsExceptionInformationPackage {PARAMETERS-BOUND : bound} OPERATION-PACKAGE ::= { + CONSUMER INVOKES {entityReleasedGPRS {bound}} + ID id-package-gprsExceptionInformation} + +gprsTimerPackage OPERATION-PACKAGE ::= { + CONSUMER INVOKES {resetTimerGPRS } + ID id-package-gprsTimer} + +gprsBillingPackage {PARAMETERS-BOUND : bound} OPERATION-PACKAGE ::= { + CONSUMER INVOKES {furnishChargingInformationGPRS {bound}} + ID id-package-gprsBilling} + +gprsChargingPackage OPERATION-PACKAGE ::= { + CONSUMER INVOKES {applyChargingGPRS} + SUPPLIER INVOKES {applyChargingReportGPRS} + ID id-package-gprsCharging} + +gprsChargeAdvicePackage {PARAMETERS-BOUND : bound} OPERATION-PACKAGE ::= { + CONSUMER INVOKES {sendChargingInformationGPRS {bound}} + ID id-package-gprsChargeAdvice} +``` + +``` +gprsActivityTestPackage OPERATION-PACKAGE ::= { + CONSUMER INVOKES {activityTestGPRS} + ID id-package-gprsActivityTest} + +gprsCancelPackage OPERATION-PACKAGE ::= { + CONSUMER INVOKES {cancelGPRS } + ID id-package-gprsCancel} + +-- Abstract Syntaxes + +-- The ABSTRACT-SYNTAX definitions for CAP V3 for GPRS are updated in Rel-6. + +gprsSSF-gsmSCFAbstractSyntax ABSTRACT-SYNTAX ::= { + GenericGprsSSF-gsmSCF-PDUs + IDENTIFIED BY id-as-gprsSSF-gsmSCF-AS} +-- 'GenericGprsSSF-gsmSCF-PDUs' is defined in the present module. + +GenericGprsSSF-gsmSCF-PDUs ::= TCMessage {{GprsSsfToGsmScfInvokable}, + {GprsSsfToGsmScfReturnable}} +-- 'GprsSsfToGsmScfInvokable' and 'GprsSsfToGsmScfReturnable' are defined in the present module. + +GprsSsfToGsmScfInvokable OPERATION ::= { + activityTestGPRS | + applyChargingGPRS | + applyChargingReportGPRS | + cancelGPRS | + connectGPRS {CAPSpecificBoundSet} | + entityReleasedGPRS {CAPSpecificBoundSet} | + eventReportGPRS {CAPSpecificBoundSet} | + furnishChargingInformationGPRS {CAPSpecificBoundSet} | + initialDPGPRS {CAPSpecificBoundSet} | + releaseGPRS {CAPSpecificBoundSet} | + requestReportGPRSEvent {CAPSpecificBoundSet} | + resetTimerGPRS | + sendChargingInformationGPRS {CAPSpecificBoundSet}} + +GprsSsfToGsmScfReturnable OPERATION ::= { + activityTestGPRS | + applyChargingGPRS | + applyChargingReportGPRS | + cancelGPRS | + connectGPRS {CAPSpecificBoundSet} | + continueGPRS | + entityReleasedGPRS {CAPSpecificBoundSet} | + furnishChargingInformationGPRS {CAPSpecificBoundSet} | + initialDPGPRS {CAPSpecificBoundSet} | + releaseGPRS {CAPSpecificBoundSet} | + requestReportGPRSEvent {CAPSpecificBoundSet} | + resetTimerGPRS | + sendChargingInformationGPRS {CAPSpecificBoundSet}} + +gsmSCF-gprsSSFAbstractSyntax ABSTRACT-SYNTAX ::= { + GenericGsmSCF-gprsSSF-PDUs + IDENTIFIED BY id-as-gsmSCF-gprsSSF-AS} +-- 'GenericGsmSCF-gprsSSF-PDUs' is defined in the present module. + +GenericGsmSCF-gprsSSF-PDUs ::= TCMessage {{GsmScfToGprsSsfInvokable}, + {GsmScfToGprsSsfReturnable}} +-- 'GsmScfToGprsSsfInvokable' and 'GsmScfToGprsSsfReturnable' are defined in the present module. + +GsmScfToGprsSsfInvokable OPERATION ::= { + activityTestGPRS | + applyChargingGPRS | + cancelGPRS | + furnishChargingInformationGPRS {CAPSpecificBoundSet} | + releaseGPRS {CAPSpecificBoundSet} | + requestReportGPRSEvent {CAPSpecificBoundSet} | + sendChargingInformationGPRS {CAPSpecificBoundSet}} + +GsmScfToGprsSsfReturnable OPERATION ::= { + activityTestGPRS | + applyChargingGPRS | + cancelGPRS | + furnishChargingInformationGPRS {CAPSpecificBoundSet} | + releaseGPRS {CAPSpecificBoundSet} | + requestReportGPRSEvent {CAPSpecificBoundSet} | +``` + +``` +sendChargingInformationGPRS {cAPSpecificBoundSet} +``` + +``` +END +``` + +--- + +## 9 Application Entity procedures + +The description of the application entity procedures for CAMEL Phase 3 can be found in 3GPP TS 23.078 [7]. + +--- + +## 10 Error procedures + +The present clause specifies the generic error procedures for CAP. The error procedure descriptions are divided in two subclauses, subclause 10.1 listing the errors related to CAP Operations and subclause 10.2 listing the errors related to error conditions in the different FEs which are not directly related to the CAP Operations. + +The gsmSSF FSM states, smsSSF FSM states and gprsSSF FSM states which are referred to in the present clause are described in 3GPP TS 23.078 [7]. The CAP Operations PlayAnnouncement, PromptAndCollectUserInfo and SpecializedResourceReport refer to states in the gsmSRF SRSM which are described in ETSI ETS 300 374-1 [24] as well as to states in 3GPP TS 23.078 [7]. + +### 10.1 Operation related error procedures + +The following subclauses specify the generic error handling for the CAP Operation related errors. The errors are defined as Operation Errors in clauses 6, 7 and 8. Errors which have a specific procedure for a CAP Operation are described in clause 11 with the detailed procedure of the related CAP Operation. + +The TC services which are used for reporting CAP Operation Errors are described in subclause 14.1. All Errors which can be detected by the ASN.1 decoder, already may have been detected during the decoding of the TC message and indicated by the TC error indication "MistypedParameter" in the TC-U-Reject. + +#### 10.1.1 Canceled + +##### 10.1.1.1 General Description + +###### 10.1.1.1.1 Error description + +The gsmSRF uses this Error to indicate" to the gsmSCF that the cancellation of a specific CAP Operation, as requested by the gsmSCF, has been successful. The only CAP Operations which may be cancelled are PlayAnnouncement and PromptAndCollectUserInfo. + +##### 10.1.1.2 Operations gsmSCF & gsmSRF + +###### Procedures at responding entity (gsmSRF) + +###### A) Receiving Cancel + +Precondition: SRSM FSM state "User Interaction". + +Postcondition: SRSM FSM state "User Interaction". + +If execution of the indicated CAP Operation has not yet started, then the indicated CAP Operation shall be removed from the buffer. If execution of the indicated CAP Operation is in progress, then the execution of that CAP Operation shall be terminated. If the indicated CAP Operation was already executed, then then this causes a failure ("CancelFailed"). + +###### B) Sending Error "Canceled" + +Precondition: SRSM FSM state "User Interaction". + +Postcondition: SRSM FSM state "User Interaction". + +After returning the Error "Canceled", the gsmSRF FSM remains in the same state. The execution of the indicated PlayAnnouncement or PromptAndCollectUserInfo CAP Operation is aborted. The gsmSRF shall remain + +connected and the next PlayAnnouncement or PromptAndCollectUserInfo CAP Operation, if available, shall be executed. + +## 10.1.2 CancelFailed + +### 10.1.2.1 General description + +#### 10.1.2.1.1 Error description + +The gsmSRF uses this Error to indicate to the gsmSCF that the cancellation of a specific CAP Operation, as requested by the gsmSCF, was not successful. Possible failure reasons are: + +- 0 "unknownOperation", when the InvokeID of the CAP Operation to cancel is not known to the gsmSRF (this may also happen when the CAP Operation has already been completed); +- 1 "tooLate", when the invokeID is known but the execution of the CAP Operation is in a state in which it cannot be canceled anymore. For instance the announcement is finished but the SpecializedResourceReport has not been sent to the gsmSCF yet. The conditions for the occurrence of failure reason "tooLate" are implementation dependent; +- 2 "operationNotCancellable", when the invokeID points to a CAP Operation that the gsmSCF is not allowed to cancel. + +### 10.1.2.2 Operations gsmSCF $\leftarrow$ gsmSRF + +#### **Procedures at responding entity (gsmSRF)** + +A) Receiving Cancel. However, the indicated CAP Operation is not known, or has already been executed or may not be cancelled. This causes a failure, "CancelFailed". + +**Precondition:** SRSM FSM state "User Interaction". + +**Postcondition:** SRSM FSM state "User Interaction" or + SRSM FSM state "Idle". + +B) Sending Error "CancelFailed" + +**Precondition:** SRSM FSM state "User Interaction" or + SRSM FSM state "Idle". + +**Postcondition:** SRSM FSM state "User Interaction" or + SRSM FSM state "Idle". + +After returning the Error "CancelFailed" the gsmSRF FSM remains in the same state. + +## 10.1.3 ETFailed + +### 10.1.3.1 General description + +#### 10.1.3.1.1 Error description + +The gsmSSF uses this Error to indicate to the gsmSCF that the establishment of a temporary connection to an assisting gsmSSF or gsmSRF was not successful (e.g., receiving a "Backwards Release" after sending an ISUP IAM). + +### 10.1.3.2 Operations gsmSCF $\leftarrow$ gsmSSF + +#### **Procedures at responding entity (gsmSSF)** + +A gsmSSF receives EstablishTemporaryConnection from a gsmSCF but the establishment of the connection fails, which results in returning the Error "ETFailed" to the gsmSCF. + +**Precondition:** gsmSSF FSM state "Waiting\_for\_Instructions". + +**Postcondition:** gsmSSF FSM state "Waiting\_for\_Instructions". + +No further error treatment. + +## 10.1.4 ImproperCallerResponse + +### 10.1.4.1 General description + +#### 10.1.4.1.1 Error description + +The gsmSRF uses this Error to indicate to the gsmSCF that the format of the user input has been checked by the gsmSRF, but does not correspond to the required format as it was defined in the initiating CAP Operation. + +### 10.1.4.2 Operations gsmSCF $\leftarrow$ gsmSRF + +#### Procedures at responding entity (gsmSRF) + +A) gsmSRF receives PromptAndCollectUserInformation + +Precondition: SRSM FSM state "Connected"; or +SRSM FSM state "User Interaction". + +Postcondition: SRSM FSM state "User Interaction". + +B) format of the user input is not correct, gsmSRF returns ImproperCallerResponse to gsmSCF + +Precondition: SRSM FSM state "User Interaction". + +Postcondition: SRSM FSM state "User Interaction". + +The gsmSRF shall wait for a new CAP Operation from the gsmSCF. This may be a new PromptAndCollectUserInformation or a PlayAnnouncement. + +## 10.1.5 MissingCustomerRecord + +### 10.1.5.1 General description + +#### 10.1.5.1.1 Error description + +The gsmSCF uses this Error to indicate to the gsmSSF, gprsSSF, smsSSF or gsmSRF, that the SLP could not be found in the gsmSCF, because the required customer record does not exist, or the requested SLPI, indicated by the correlationID in "AssistRequestInstructions" does not exist anymore. + +### 10.1.5.2 Operations gsmSSF $\leftarrow$ gsmSCF + +#### Procedures at invoking entity (gsmSSF) + +A) Sending CAP Operation + +Precondition: gsmSSF FSM state "Trigger processing" or +gsmSSF FSM state "Waiting\_for\_Instructions"; in the assisting gsmSSF case. + +Postcondition: gsmSSF FSM state "Waiting\_for\_Instructions". +gsmSSF FSM state "Waiting\_for\_Instructions"; in the assisting gsmSSF case. + +B) gsmSSF receives Error "MissingCustomerRecord" + +Precondition: gsmSSF FSM state "Waiting\_for\_Instructions" or +gsmSSF FSM state "Waiting\_for\_Instructions"; in the assisting gsmSSF case. + +Postcondition: gsmSSF FSM state "Idle" or +gsmSSF FSM state "Idle"; in the assisting gsmSSF case. + +The GMSC or VMSC shall handle the call in accordance with the Default Call Handling parameter of the valid CSI. + +### 10.1.5.3 Operations gsmSRF $\leftarrow$ gsmSCF + +#### Procedures at invoking entity (gsmSRF) + +A) Sending CAP Operation + +Precondition: SRSM FSM state "Connected". + +Postcondition: SRSM FSM state "Connected". + +B) gsmSRF receives Error "MissingCustomerRecord" + +Precondition: SRSM FSM state "Connected". + +Postcondition: SRSM FSM state "Idle". + +The gsmSRF shall initiate a Disconnect. + +### 10.1.5.4 Operations smsSSF $\leftarrow$ gsmSCF + +#### Procedures at invoking entity (smsSSF) + +A) Sending CAP Operation + +Precondition: smsSSF FSM state "Waiting\_for\_Instructions". + +Postcondition: smsSSF FSM state "Waiting\_for\_Instructions". + +B) smsSSF receives Error "MissingCustomerRecord" + +Precondition: smsSSF FSM state "Waiting\_for\_Instructions". + +Postcondition: smsSSF FSM state "Idle". + +The VMSC or SGSN shall handle the Short Message in accordance with the Default SMS Handling parameter of the valid CSI. + +### 10.1.5.5 Operations gprsSSF $\leftarrow$ gsmSCF + +#### Procedures at invoking entity (gprsSSF) + +A) Sending CAP Operation + +Precondition: gprsSSF FSM state "Waiting\_for\_Instructions". + +Postcondition: gprsSSF FSM state "Waiting\_for\_Instructions". + +B) gprsSSF receives Error "MissingCustomerRecord" + +Precondition: gprsSSF FSM state "Waiting\_for\_Instructions". + +Postcondition: gprsSSF FSM state "Idle". + +The SGSN shall handle the GPRS Session or PDP Context in accordance with the Default GPRS Handling parameter of the valid CSI. + +## 10.1.6 MissingParameter + +### 10.1.6.1 General description + +#### 10.1.6.1.1 Error description + +The gsmSCF, gsmSSF, gsmSRF, smsSSF or gprsSSF uses this Error to indicate that there is an error in the received CAP Operation argument. The responding entity cannot start the execution of the requested CAP Operation because the argument is incorrect: an expected optional parameter which is essential for the application is not included in the CAP Operation argument. + +### 10.1.6.2 Operations gsmSCF $\leftarrow$ gsmSSF + +#### Procedures at responding entity (gsmSSF) + +Precondition: (1) gsmSSF FSM appropriate state + (2) gsmSSF FSM Call associated CAP Operation received, appropriate event occurred + (3) gsmSSME FSM appropriate state + (4) gsmSSME FSM Non call associated CAP Operation received, appropriate event + +Postcondition: (1) No gsmSSF FSM transition + (2) gsmSSME FSM transition to the initial state (i.e., before receiving the erroneous CAP Operation) + +The gsmSSF detects the error in the received CAP Operation. The Error parameter "MissingParameter" is returned to inform the gsmSCF of this situation. + +### 10.1.6.3 Operations gsmSSF $\leftarrow$ gsmSCF + +#### Procedures at invoking entity (gsmSSF) + +A) Sending CAP Operation + +Precondition: gsmSSF FSM appropriate state + +Postcondition: gsmSSF FSM appropriate state as result of the transfer of the CAP Operation + +B) gsmSSF receives Error "MissingParameter" + +Precondition: gsmSSF FSM appropriate state as result of the transfer of any of the CAP Operation + +Postcondition: gsmSSF FSM state "Idle" + +After receiving this Error, the gsmSSF FSM shall return to the state "Idle". The GMSC or VMSC shall handle the call in accordance with the Default Call Handling parameter, valid for this CAMEL dialogue. In the case of an assisting gsmSSF, the temporary connection shall be released by the assisting gsmSSF. + +### 10.1.6.4 Operations gsmSCF $\leftarrow$ gsmSRF + +#### Procedures at responding entity (gsmSRF) + +Precondition: SRSM FSM state "Connected"; or + SRSM FSM state "User Interaction". + +Postcondition: SRSM FSM state "User Interaction". + +The SRSM detects that a required parameter is not present in the CAP Operation argument. The Error parameter "MissingParameter" is returned to inform the gsmSCF of this situation. + +### 10.1.6.5 Operations gsmSRF $\leftarrow$ gsmSCF + +#### Procedures at invoking entity (gsmSRF) + +A) Sending CAP Operation + +Precondition: SRSM FSM state "Connected". + +Postcondition: SRSM FSM state "Connected". + +B) Receiving Error + +Precondition: SRSM FSM state "Connected". + +Postcondition: SRSM FSM state "Idle". + +The gsmSCF detects the error in the received CAP Operation. The Error parameter "MissingParameter" is used to inform the gsmSRF of this situation. The SL and maintenance functions are informed. The gsmSCF might try another gsmSRF, route the call or release the call (SL dependent). + +### 10.1.6.6 Operations smsSSF $\leftarrow$ gsmSCF + +#### Procedures at invoking entity (smsSSF) + +##### A) Sending CAP Operation + +Precondition: smsSSF FSM state "WaitingForInstructions". + +Postcondition: smsSSF FSM state "WaitingForInstructions". + +##### B) Receiving Error + +Precondition: smsSSF FSM state "WaitingForInstructions". + +Postcondition: smsSSF FSM state "Idle". + +After receiving this error, the smsSSF FSM shall transit to the state "Idle". The SGSN or VMSC shall handle the Short Message in accordance with the Default SMS Handling parameter of the valid CSI. + +### 10.1.6.7 Operations gsmSCF $\leftarrow$ smsSSF + +#### Procedures at responding entity (smsSSF) + +precondition: + +- (1) smsSSF appropriate state. +- (2) smsSSF SMS associated CAP Operation received, appropriate event occurred. + +postcondition: + +- (1) smsSSF transition to the same state. + +The smsSSF detects the error in the received CAP Operation. The Error parameter "MissingParameter" is returned to inform the gsmSCF of this situation. + +### 10.1.6.8 Operations gprsSSF $\leftarrow$ gsmSCF + +#### Procedures at invoking entity (gprsSSF) + +##### A) Sending CAP Operation + +Precondition: gprsSSF FSM state "Waiting\_for\_Instructions". + +Postcondition: gprsSSF FSM state "Waiting\_for\_Instructions". + +##### B) Receiving Error + +Precondition: gprsSSF FSM state "Waiting\_for\_Instructions". + +Postcondition: gprsSSF FSM state "Idle". + +After receiving this error, the gprsSSF FSM shall transits to the state "Idle". The SGSN shall handle the GPRS Session or PDP Context in accordance with the Default GPRS Handling parameter of the valid CSI. + +### 10.1.6.9 Operations gsmSCF $\leftarrow$ gprsSSF + +#### Procedures at responding entity (gprsSSF) + +precondition: + +- (1) gprsSSF appropriate state. +- (2) gprsSSF CAP Operation received, appropriate event occurred. + +postcondition: + +(1) gprsSSF transition to the same state. + +The gprsSSF detects the error in the received CAP Operation. The Error parameter "MissingParameter" is returned to inform the gsmSCF of this situation. + +## 10.1.7 ParameterOutOfRange + +### 10.1.7.1 General description + +#### 10.1.7.1.1 Error description + +The gsmSCF, gsmSSF, gsmSRF, smsSSF or gprsSSF uses this Error to indicate that it cannot start the execution of the requested CAP Operation because an error in a parameter of the CAP Operation argument is detected: a parameter value is out of range. + +#### 10.1.7.2 Operations gsmSCF $\leftarrow$ gsmSSF + +Refer to subclause 10.1.6 MissingParameter for the appropriate error procedures. + +#### 10.1.7.3 Operations gsmSSF $\leftarrow$ gsmSCF + +Refer to subclause 10.1.6 MissingParameter for the appropriate error procedures. + +#### 10.1.7.4 Operations gsmSCF $\leftarrow$ gsmSRF + +Refer to subclause 10.1.6 MissingParameter for the appropriate error procedures. + +#### 10.1.7.5 Operations smsSSF $\leftarrow$ gsmSCF + +Refer to subclause 10.1.6 MissingParameter for the appropriate error procedures. + +#### 10.1.7.6 Operations gsmSCF $\leftarrow$ smsSSF + +Refer to subclause 10.1.6 MissingParameter for the appropriate error procedures. + +#### 10.1.7.7 Operations gprsSSF $\leftarrow$ gsmSCF + +Refer to subclause 10.1.6 MissingParameter for the appropriate error procedures. + +#### 10.1.7.8 Operations gsmSCF $\leftarrow$ gprsSSF + +Refer to subclause 10.1.6 MissingParameter for the appropriate error procedures. + +## 10.1.8 RequestedInfoError + +### 10.1.8.1 General description + +#### 10.1.8.1.1 Error description + +The gsmSSF uses this Error to indicate to the gsmSCF that the information requested in the CallInformationRequest CAP Operation is not known to the gsmSSF or is not available. + +#### 10.1.8.2 Operations gsmSCF $\leftarrow$ gsmSSF + +Refer to subclause 10.1.6 MissingParameter for the appropriate error procedures. + +## 10.1.9 SystemFailure + +### 10.1.9.1 General description + +#### 10.1.9.1.1 Error description + +The gsmSCF, gsmSSF, gsmSRF, smsSSF or gprsSSF uses this error to indicate that it is not able to execute a specific task as requested by a CAP Operation, and recovery is not expected to be completed within the current call instance. + +#### 10.1.9.2 Operations gsmSCF $\mathcal{C}$ gsmSSF + +Refer to subclause 10.1.6 MissingParameter for the appropriate error procedures. + +#### 10.1.9.3 Operations gsmSSF $\mathcal{C}$ gsmSCF + +Refer to subclause 10.1.6 MissingParameter for the appropriate error procedures. + +#### 10.1.9.4 Operations gsmSCF $\mathcal{C}$ gsmSRF + +Refer to subclause 10.1.6 MissingParameter for the appropriate error procedures. + +#### 10.1.9.5 Operations gsmSRF $\mathcal{C}$ gsmSCF + +Refer to subclause 10.1.6 MissingParameter for the appropriate error procedures. + +#### 10.1.9.6 Operations smsSSF $\mathcal{C}$ gsmSCF + +Refer to subclause 10.1.6 MissingParameter for the appropriate error procedures. + +#### 10.1.9.7 Operations gsmSCF $\mathcal{C}$ smsSSF + +Refer to subclause 10.1.6 MissingParameter for the appropriate error procedures. + +#### 10.1.9.8 Operations gprsSSF $\mathcal{C}$ gsmSCF + +Refer to subclause 10.1.6 MissingParameter for the appropriate error procedures. + +#### 10.1.9.9 Operations gsmSCF $\mathcal{C}$ gprsSSF + +Refer to subclause 10.1.6 MissingParameter for the appropriate error procedures. + +## 10.1.10 TaskRefused + +### 10.1.10.1 General description + +#### 10.1.10.1.1 Error description + +The gsmSCF, gsmSSF, gsmSRF, smsSSF or gprsSSF uses this Error to indicate that it is not able to execute a specific task as requested by a CAP Operation, and recovery is expected to be completed within the current call instance. + +If the gsmSSF requests MoveLeg or SplitLeg operations in the gsmSSF while user interaction is in progress in an affected Call Segment, then CAP\_Error (task refused) is returned. + +#### 10.1.10.2 Operations gsmSCF $\mathcal{C}$ gsmSSF + +Refer to subclause 10.1.6 MissingParameter for the appropriate error procedures. + +#### 10.1.10.3 Operations gsmSSF $\mathcal{C}$ gsmSCF + +Refer to subclause 10.1.6 MissingParameter for the appropriate error procedures. + +#### 10.1.10.4 Operations gsmSCF $\leftarrow$ gsmSRF + +Refer to subclause 10.1.6 MissingParameter for the appropriate error procedures. + +#### 10.1.10.5 Operations gsmSRF $\leftarrow$ gsmSCF + +Refer to subclause 10.1.6 MissingParameter for the appropriate error procedures. + +#### 10.1.10.6 Operations smsSSF $\leftarrow$ gsmSCF + +Refer to subclause 10.1.6 MissingParameter for the appropriate error procedures. + +#### 10.1.10.7 Operations gsmSCF $\leftarrow$ smsSSF + +##### SMS Related + +Refer to subclause 10.1.6 MissingParameter for the appropriate error procedures. + +#### 10.1.10.8 Operations gprsSSF $\leftarrow$ gsmSCF + +Refer to subclause 10.1.6 MissingParameter for the appropriate error procedures. + +#### 10.1.10.9 Operations gsmSCF $\leftarrow$ gprsSSF + +Refer to subclause 10.1.6 MissingParameter for the appropriate error procedures. + +### 10.1.11 UnavailableResource + +#### 10.1.11.1 General description + +##### 10.1.11.1.1 Error description + +The gsmSRF uses this Error to indicate to the gsmSCF that it is not able to perform its function (i.e., play a certain announcement and/or collect specific user information), and cannot be replaced. A reattempt is not possible. + +#### 10.1.11.2 Operations gsmSCF $\leftarrow$ gsmSRF + +##### Procedures at responding entity (gsmSRF) + +A) gsmSRF receiving PlayAnnouncement or PromptAndCollectUserInformation + +Precondition: SRSM FSM state "Connected"; if initial PlayAnnouncement or PromptAndCollectUserInformation; or SRSM FSM state "User Interaction"; if not initial PlayAnnouncement or PromptAndCollectUserInformation. + +B) gsmSRF is not able to perform its function (and cannot be replaced). The gsmSRF sends the Error "UnavailableResource". + +Precondition: SRSM FSM state "User Interaction". + +Postcondition: SRSM FSM state "User Interaction". + +### 10.1.12 UnexpectedComponentSequence + +#### 10.1.12.1 General description + +##### 10.1.12.1.1 Error description + +The gsmSCF, gsmSSF, gsmSRF, smsSSF or gprsSSF uses this Error to indicate that it cannot start the execution of the requested CAP Operation because a SACF or MACF rule is violated, or the CAP Operation cannot be executed in the current state of the FSM. + +### 10.1.12.2 Operations gsmSCF $\leftarrow$ gsmSSF + +In this case the gsmSSF detects the erroneous situation, sends the Error "UnexpectedComponentSequence" and remains in the same state. + +### 10.1.12.3 Operations gsmSSF $\leftarrow$ gsmSCF + +If the CAP Operation is sent by an "initiating" gsmSSF in the context of an existing relationship, then the gsmSCF returns the Error parameter. On receiving the error the gsmSSF FSM shall transit to the state "Idle". The VMSC or GMSC shall handle the call in accordance with the Default Call Handling parameter, valid for this CAMEL dialogue. + +### 10.1.12.4 Operations gsmSCF $\leftarrow$ gsmSRF (applicable for direct gsmSCF-gsmSRF case only) + +In this case the gsmSRF detects the erroneous situation, sends the Error "UnexpectedComponentSequence" and remains in the same state. + +### 10.1.12.5 Operations gsmSRF $\leftarrow$ gsmSCF + +In this case, an error occurs if the gsmSRF has already an established relationship with the gsmSCF and sends the CAP Operation AssistRequestInstructions. The gsmSCF detects the erroneous situation, informs SL and maintenance functions and returns the error parameter. On receiving the Error parameter, the gsmSRF FSM shall transit to the state "Idle" and releases the temporary connection. + +### 10.1.12.6 Operations smsSSF $\leftarrow$ gsmSCF + +If the CAP Operation is sent by the smsSSF in the context of an existing relationship, then the gsmSCF returns the Error parameter. On receiving the error, the smsSSF FSM shall transit to the state "Idle". The SGSN or VMSC shall handle the Short Message in accordance with the Default SMS Handling parameter of the valid CSI. + +### 10.1.12.7 Operations gsmSCF $\leftarrow$ smsSSF + +In this case the smsSSF detects the erroneous situation, sends the Error "UnexpectedComponentSequence" and remains in the same state. + +### 10.1.12.8 Operations gprsSSF $\leftarrow$ gsmSCF + +If the CAP Operation is sent by the gprsSSF in the context of an existing relationship, then the gsmSCF returns the Error parameter. On receiving the error, the gprsSSF FSM shall transit to the state "Idle". The SGSN shall handle the GPRS Session or PDP Context in accordance with the Default GPRS Handling parameter of the valid CSI. + +### 10.1.12.9 Operations gsmSCF $\leftarrow$ gprsSSF + +In this case the gprsSSF detects the erroneous situation, sends the Error "UnexpectedComponentSequence" and remains in the same state. + +## 10.1.13 UnexpectedDataValue + +### 10.1.13.1 General description + +#### 10.1.13.1.1 Error description + +The gsmSCF, gsmSSF, gsmSRF, smsSSF or gprsSSF uses this Error to indicate that it cannot execute the requested CAP Operation because a parameter has an unexpected data value. + +Note that this error does not overlap with "ParameterOutOfRange". + +EXAMPLE: startTime DateAndTime ::= -- value indicating January 32 1993, 12: 15: 01 + +The responding entity does not expect this value and responds with Error "UnexpectedDataValue". + +### 10.1.13.2 Operations gsmSCF $\leftarrow$ gsmSSF + +Refer to subclause 10.1.6 MissingParameter for the appropriate error procedures. + +### 10.1.13.3 Operations gsmSSF $\leftarrow$ gsmSCF + +Refer to subclause 10.1.6 MissingParameter for the appropriate error procedures. + +### 10.1.13.4 Operations gsmSCF $\leftarrow$ gsmSRF + +Refer to subclause 10.1.6 MissingParameter for the appropriate error procedures. + +### 10.1.13.5 Operations gsmSRF $\leftarrow$ gsmSCF + +Refer to subclause 10.1.6 MissingParameter for the appropriate error procedures. + +### 10.1.13.6 Operations smsSSF $\leftarrow$ gsmSCF + +Refer to subclause 10.1.6 MissingParameter for the appropriate error procedures. + +### 10.1.13.7 Operations gsmSCF $\leftarrow$ smsSSF + +Refer to subclause 10.1.6 MissingParameter for the appropriate error procedures. + +### 10.1.13.8 Operations gprsSSF $\leftarrow$ gsmSCF + +Refer to subclause 10.1.6 MissingParameter for the appropriate error procedures. + +### 10.1.13.9 Operations gsmSCF $\leftarrow$ gprsSSF + +Refer to subclause 10.1.6 MissingParameter for the appropriate error procedures. + +## 10.1.14 UnexpectedParameter + +### 10.1.14.1 General description + +#### 10.1.14.1.1 Error description + +The gsmSCF, gsmSSF, gsmSRF, smsSSF or gprsSSF uses this Error to indicate that there is an error in the received CAP Operation argument. A valid but unexpected parameter was present in the CAP Operation argument. The presence of this parameter is not consistent with the presence of the other parameters. The responding entity cannot start the execution of the CAP Operation. + +### 10.1.14.2 Operations gsmSCF $\leftarrow$ gsmSSF + +Refer to subclause 10.1.6 MissingParameter for the appropriate error procedures. + +### 10.1.14.3 Operations gsmSSF $\leftarrow$ gsmSCF + +Refer to subclause 10.1.6 MissingParameter for the appropriate error procedures. + +### 10.1.14.4 Operations gsmSCF $\leftarrow$ gsmSRF + +Refer to subclause 10.1.6 MissingParameter for the appropriate error procedures. + +### 10.1.14.5 Operations gsmSRF $\leftarrow$ gsmSCF + +Refer to subclause 10.1.6 MissingParameter for the appropriate error procedures. + +### 10.1.14.6 Operations smsSSF $\leftarrow$ gsmSCF + +Refer to subclause 10.1.6 MissingParameter for the appropriate error procedures. + +#### 10.1.14.7 Operations gsmSCF ⌚ smsSSF + +Refer to subclause 10.1.6 MissingParameter for the appropriate error procedures. + +#### 10.1.14.8 Operations gprsSSF ⌚ gsmSCF + +Refer to subclause 10.1.6 MissingParameter for the appropriate error procedures. + +#### 10.1.14.9 Operations gsmSCF ⌚ gprsSSF + +Refer to subclause 10.1.6 MissingParameter for the appropriate error procedures. + +### 10.1.15 UnknownLegID + +#### 10.1.15.1 General description + +##### 10.1.15.1.1 Error description + +The gsmSSF uses this error to indicate to the gsmSCF that a specific leg, indicated by the LegID parameter value in the CAP Operation, is unknown to the gsmSSF. + +#### 10.1.15.2 Operations gsmSCF ⌚ gsmSSF + +Refer to subclause 10.1.6 MissingParameter for the appropriate error procedures. + +### 10.1.16 UnknownCSID + +#### 10.1.16.1 General description + +##### 10.1.16.1.1 Error description + +The gsmSSF uses this error to indicate to the gsmSCF that a specific Call Segment, indicated by the callSegmentID parameter value in the CAP Operation, is unknown to the gsmSSF. + +#### 10.1.16.2 Operations gsmSCF ⌚ gsmSSF + +Refer to subclause 10.1.6 MissingParameter for the appropriate error procedures. + +### 10.1.17 UnknownPDPIID + +#### 10.1.17.1 General description + +##### 10.1.17.1.1 Error description + +The gsmSCF or gprsSSF uses this error to indicate that a specific PDP Context, indicated by the PDPIID parameter value in the CAP Operation argument, is unknown to the receiving entity. + +#### 10.1.17.2 Operations gprsSSF ⌚ gsmSCF + +Refer to subclause 10.1.6 MissingParameter for the appropriate error procedures. + +#### 10.1.17.3 Operations gsmSCF ⌚ gprsSSF + +Refer to subclause 10.1.6 MissingParameter for the appropriate error procedures. + +## 10.2 Entity related error procedures + +The following subclauses specify the error handling procedures for the Functional Entity related errors. Since the error situations are not originated by the reception of a CAP Operation, the invoking entity is denoted here as the entity at which the error situation is detected. The responding entity is the entity which receives the error report. + +The TC services used for reporting errors are described in clause 14. + +## 10.2.1 Expiration of Tssf + +### 10.2.1.1 General description + +#### 10.2.1.1.1 Error description + +A timeout has occurred in the gsmSSF, gprsSSF, smsSSF or assisting gsmSSF on the response from the gsmSCF. + +#### 10.2.1.2 Procedures gsmSSF $\leftarrow$ gsmSCF + +##### Procedure at the invoking entity (gsmSSF or assisting gsmSSF) + +Timeout occurs in gsmSSF on Tssf. + +Precondition: gsmSSF FSM state "Waiting\_for\_Instructions"; or +gsmSSF FSM state "Waiting\_for\_end\_of\_User\_Interaction"; or +gsmSSF FSM state "Waiting\_for\_end\_of\_Temporary\_Connection". + +Postcondition: gsmSSF FSM state "Idle". + +The gsmSSF shall abort the TC dialogue and shall transit to the state "Idle". The GMSC or VMSC shall handle the call in accordance with the Default Call Handling parameter, valid for this CAMEL dialogue. For CAMEL dialogues that are established as a result of a CSI, the Default Call Handling parameter is obtained from the CSI. For gsmSCF initiated CAMEL dialogues, the Default Call Handling parameter shall be "ReleaseCall". + +The assisting gsmSSF shall abort the TC dialogue and shall transit to the state "Idle". The assisting gsmSSF shall release the temporary connection. + +#### 10.2.1.3 Procedures gprsSSF $\leftarrow$ gsmSCF + +##### Procedure at the invoking entity (gprsSSF) + +Timeout occurs in gprsSSF on Tssf. + +Precondition: gprsSSF FSM state "Waiting\_for\_Instructions". + +Postcondition: gprsSSF FSM state "Idle". + +The gprsSSF shall abort the TC dialogue and and the GPRS dialogue and shall transit to the state "Idle". The SGSN shall handle the PDP Context in accordance with the Default GPRS Handling parameter of the valid CSI. + +#### 10.2.1.4 Procedures smsSSF $\leftarrow$ gsmSCF + +##### Procedure at the invoking entity (smsSSF) + +Timeout occurs in smsSSF on Tssf. + +Precondition: smsSSF FSM state "Waiting\_for\_Instructions". + +Postcondition: smsSSF FSM state "Idle". + +The smsSSF shall abort the TC dialogue and shall transit to the state "Idle". The MSC or SGSN shall handle the Short Message in accordance with the Default SMS Handling parameter of the valid CSI. + +## 10.2.2 Expiration of Tsrf + +### 10.2.2.1 General Description + +#### 10.2.2.1.1 Error description + +A timeout has occurred in the gsmSRF on the response from the gsmSCF. The procedures for handling this error are described in ETSI ETS 300 374-1 [24]. + +## 10.2.2.2 Procedures description + +The procedures for handling this error are described in ETSI ETS 300 374-1 [24]. + +--- + +# 11 Detailed operation procedures for circuit switched call control + +NOTE: The detailed operation procedures in the present clause which cross reference the gsmSCF FSMs for the pre- and postconditions are for information only. + +NOTE: Where a parameter for a circuit switched call control Operation is marked OPTIONAL in ASN.1, the reader is referred to the conditions for presence for this parameter, specified in the respective Information Flow in 3GPP TS 23.078 [7]. + +## 11.1 ActivityTest procedure + +### 11.1.1 General description + +The gsmSCF uses this operation to check for the continued existence of a relationship between the gsmSCF and the gsmSSF, between the gsmSCF and the gsmSRF or between the gsmSCF and the assist gsmSSF. If the relationship is still in existence, then the receiving entity will respond If the ActivityTest operation timer expires, then the gsmSCF will assume that the receiving entity has failed in some way and will take appropriate action. + +#### 11.1.1.1 Parameters + +None. + +### 11.1.2 Responding entity (gsmSSF, gsmSRF or assist gsmSSF) + +#### 11.1.2.1 Normal procedure + +gsmSSF preconditions: + +- (1) A relationship exists between the gsmSCF and the gsmSSF. +- (2) The gsmSSME FSM is in the state "Idle Management" or in the state "Non-call Associated Treatment". + +gsmSRF or assist gsmSSF preconditions: + +- (1) A relationship exists between the gsmSCF and the gsmSRF or assist gsmSSF. +- (2) The gsmSSME FSM is in the state "Idle Management". + +gsmSSF postconditions: + +- (1) The gsmSSME FSM stays in, or transits to the state "Non-call Associated Treatment". +- (2) If the TC Dialogue ID is active and there is a gsmSSF using the dialogue, then the gsmSSME FSM shall send a Return Result "ActivityTest" to the gsmSCF. If there are no other management activities (e.g. Call Gapping), then the gsmSSME FSM shall transit to the state "Idle Management". Otherwise, the gsmSSME FSM remains in the state "Non-call Associated Treatment". + +If the TC Dialogue ID is not active, then the TC in the gsmSSF will issue a P-Abort. The gsmSSME FSM will in that case not receive the "ActivityTest" indication and thus will not be able to reply. + +gsmSRF or assist gsmSSF postconditions: + +- (1) The gsmSSME FSM transits to the state "Non-call Associated Treatment". +- (2) If the TC Dialogue ID is active and there is a gsmSRF or assist gsmSSF using the dialogue, then the gsmSSME FSM shall send a Return Result "ActivityTest" to the gsmSCF. The gsmSSME FSM then returns to the state "Idle Management". + +If the TC Dialogue ID is not active, then the TC in the gsmSRF or assist gsmSSF will issue a P-Abort. The gsmSSME FSM will in that case not receive the ActivityTest indication and thus will not be able to reply. + +### 11.1.2.2 Error handling + +Operation related error handling is not applicable, due to class 3 operation. + +## 11.2 ApplyCharging procedure + +### 11.2.1 General description + +The gsmSCF uses this operation for interacting with the gsmSSF function: "CSE control of call duration". The ApplyChargingReport operation provides the feedback from the gsmSSF to the gsmSCF. + +The charging scenarios supported by this operation are those given in 3GPP TS 22.078 [3] for "CSE control of call duration". + +#### 11.2.1.1 Parameters + +- aChBillingChargingCharacteristics: + +This parameter specifies a list of parameters required for "CSE control of call duration": + +The list may contain the following parameters: + +- timeDurationCharging: + +This list contains the following parameters: + +- maxCallPeriodDuration: +This parameter specifies the period of time for which a call may progress before an ApplyChargingReport shall be sent to the gsmSCF. +- releaseIfDurationExceeded: +This parameter specifies the action to be taken at the gsmSSF when the duration specified above has been reached. +- audibleIndicator: +This parameter indicates to the gsmSSF that an audible indicator may be played to the served subscriber. This audible indicator may either be a predefined sequence of tones or a sequence defined by the gsmSCF. This parameter shall consist of either tone or burstlist as described below: + - tone: +This parameter indicates that a warning tone shall be played when the pre-defined warning tone timer expires. + - burstlist: +This parameter indicates that a variable sequence of tones shall be played when the gsmSCF-defined warning tone timer expires. This parameter may consist of the following parameters: + - c) - burst: +This parameter indicates the number of bursts that form the burstlist. + - d) - burstInterval: +This parameter indicates the time interval between the successive burst in the burstlist. + - e) - toneInBurst: +This parameter indicates the number of tones to be played in each burst. + - f) - toneDuration: +This parameter indicates the time duration that the tone shall be played for. + +g) - toneInterval: + +This parameter indicates the time interval between successive tones in a burst + +- tariffSwitchInterval (for the CSE control of call duration): + +This parameter indicates the time duration until the next tariff switch for the CSE control of call duration. The measurement of the elapsed tariff switch period shall start immediately after successful execution of this operation. + +- partyToCharge: + +This parameter indicates the party in the call. + +- aChChargingAddress: + +This parameter identifies the call party to which the ApplyCharging operation applies. That is the leg or srfConnection. + +This parameter is a choice of one of the following parameters: + +- legID: + +This parameter indicates that the "CSE control of call duration" is associated to the specified leg. + +or + +- srfConnection: + +This parameter indicates that the "CSE control of call duration" is associated to the Temporary Connection or to the connection to a gsmSRF. + +## 11.2.2 Responding entity (gsmSSF) + +### 11.2.2.1 Normal procedure + +gsmSSF preconditions: + +- (1) A control relationship exists between the gsmSCF and the gsmSSF. +- (2) The gsmSSF FSM is in one of the following states: + +"Waiting\_for\_Instructions"; or +"Waiting\_for\_end\_of\_User\_Interaction"; or +"Waiting\_for\_end\_of\_Temporary\_Connection"; or +"Monitoring". + +gsmSSF postconditions: + +- (1) No gsmSSF FSM state transition. + +On receipt of this operation, the gsmSSF sets the charging data using the information elements included in the operation and acts accordingly. + +If the aChChargingAddress indicates a legID, then: + +The "CSE control of call duration" is associated to the specified leg. If Answer has not already been received on the incoming or outgoing connection (leg) to the Call Party, then the gsmSSF shall start monitoring for the Answer event upon receipt of the ApplyCharging operation. Upon subsequent detection of the Answer event on the outgoing connection charging is started. If the Answer event has occurred on the incoming or outgoing connection already when the ApplyCharging operation is received, then charging starts immediately. + +A precautionary started DELTA measurement shall be taken into account when charging is started. + +For a change in the connection configuration of the legs - on CPH - the particular point in time when the new connection configuration is established shall be taken as Answer time. + +Upon release of the incoming or outgoing connection to the Call Party any indication of Answer event occurred on the incoming or outgoing connection shall be cleared, i.e. set to "Answer event not occurred". + +If the aChChargingAddress indicates a srfConnection, then: + +The "CSE control of call duration" is associated to the Temporary Connection or to the connection to a gsmSRF. If Answer has not already been received on the Temporary Connection, then the gsmSSF will start monitoring for the Answer event upon receipt of the ApplyCharging operation; or, if the gsmSRF is not yet connected, then the gsmSSF will start monitoring for a connection to a gsmSRF. Upon subsequent detection of the Answer event on the Temporary Connection or the subsequent connection to a gsmSRF, charging shall be started. If the Answer event has been received from a Temporary Connection already or if the gsmSRF is already connected when the ApplyCharging operation is received, then charging shall start immediately. + +Upon release of the Temporary Connection any indication of Answer event receipt on the outgoing connection shall be cleared i.e. set to "Answer event not received". Upon end of the connection to a gsmSRF, any indication of the connection to the gsmSRF shall be cleared. + +### 11.2.2.2 Error handling + +"TaskRefused": In addition to the generic error handling noted below, this error shall be indicated when: + +- a previously received call period duration is pending for this leg or srfConnection; +- a tariffSwitchInterval for the "CSE control of call duration" is indicated when a previously received tariffSwitchInterval for the "CSE control of call duration" is pending for the Called Party, the Temporary Connection or the connection to a gsmSRF. + +Generic error handling for the operation related errors is described in clause 10 and the TC services used for reporting operation errors are described in clause 14. + +## 11.3 ApplyChargingReport procedure + +### 11.3.1 General description + +The gsmSSF uses this operation to report charging related information to the gsmSCF as requested by the gsmSCF using the "ApplyCharging" operation. + +For a change in a connection configuration of the legs – on CPH – this operation shall be sent as an indication towards the gsmSCF that the supervision of that part of the connection is finished; i.e. + +- (i) the gsmSCF shall settle the account using the reported duration and +- (ii) the durations reported for subsequent AC/ACR cycles will not be accumulated to the reported duration. + +If Answer is detected by the gsmSSF, then timing of duration shall be started as requested by the ApplyCharging operation. It shall be started independently for a connection to a Called Party, a Temporary Connection and a gsmSRF connection. + +The charging report shall be generated as specified in the 3GPP TS 23.078 [7]. + +The tariff switch mentioned in the following subclause is the tariff switch for "CSE control of call duration" for the connection to which the ApplyChargingReport procedure applies. + +#### 11.3.1.1 Parameters + +- callResult: +This parameter provides the gsmSCF with the charging related information previously requested using the ApplyCharging operation. The "CallResult" is a list and may contain the following parameters: + - timeDurationChargingResult: +This parameter is a list, and can contain the following parameters: + - timeInformation: +This parameter is a choice of the following parameters: + - timeIfNoTariffSwitch: +This parameter shall be present if no tariff switch has occurred since the reception of the first ApplyCharging operation for the connection to the Called Party, Temporary Connection or gsmSRF connection, otherwise it shall be absent. +If Answer was detected for the connection to the Called Party, the Temporary Connection or the gsmSRF connection, then the elapsed time since detection of Answer shall be reported. If answer was + +not detected, then it shall be set to "0". + +For a change in the connection configuration of the legs - on CPH - the particular point in time when the new connection configuration is established shall be taken as Answer time. + +- timeIfTariffSwitch: + +This parameter shall be present if a tariff switch has occurred since the reception of the first ApplyCharging operation for the connection to the Called Party, Temporary Connection or gsmSRF connection, otherwise it shall be absent. + +The parameter may contain the following information: + +h) - timeSinceLastTariffSwitch: + +If Answer was detected for the connection to the Called Party, the Temporary Connection or the gsmSRF connection, then the elapsed time since detection of Answer or the last tariff switch (whichever of these events was last detected) shall be reported. If Answer was not detected, then it shall be set to "0". + +For a change in the connection configuration of the legs - on CPH - the particular point in time when the new connection configuration is established shall be taken as Answer time. + +i) - TariffSwitchInterval (for the "CSE control of call duration"): + +This parameter is present only if a tariff switch has occurred since the detection of Answer for the connection to the Called Party, the temporary connection or the gsmSRF connection in the reported call period. + +The time interval between either the detection of the Answer event or the previous tariff switch (whichever of these events was last detected) and the last tariff switch is reported. + +For a change in the connection configuration of the legs - on CPH - the particular point in time when the new connection configuration is established shall be taken as Answer time. + +- partyToCharge: + +The "partyToCharge" parameter as received in the related ApplyCharging operation or deduced from the default value. This parameter is used by the gsmSCF, to correlate the result to the request. + +- aChChargingAddress: + +The "aChChargingAddress" parameter as received in the related ApplyCharging operation or deduced from the default value. This parameter is used by the gsmSCF, to correlate the result to the request. + +- legActive: + +This parameter indicates whether the leg, the Temporary Connection or the connection to a gsmSRF is still active or has been released. + +- callLegReleasedAtTcpExpiry: + +This parameter indicates that the gsmSSF has released the call leg or the Temporary Connection or SRF connection + +## 11.3.2 Invoking entity (gsmSSF) + +### 11.3.2.1 Normal procedure + +gsmSSF preconditions: + +- (1) A relationship exists between the gsmSSF and the gsmSCF. +- (2) A charging event has been detected that was requested by the gsmSCF via an ApplyCharging operation or a Called Party, Temporary Connection or gsmSRF disconnection event has occurred. + +gsmSSF postconditions: + +- (1) If release of the call has occurred because the allowed call duration has been reached, then: + - All armed EDPs shall be disarmed; + - ApplyChargingReport shall be sent to gsmSCF followed by any pending CallInformationReports; + - The gsmSSF FSM shall transit to the state "Idle". +- (2) If release of the call has occurred but not because the allowed call duration has been reached, then: + +- If there are any armed EDPs or pending reports, then the gsmSSF FSM shall remain in the same state, else; + - The gsmSSF FSM shall transit to the state "Idle". +- (3) else: +- no gsmSSF FSM state transition. + +### 11.3.2.2 Error handling + +Generic error handling for the operation related errors are described in clause 10 and the TC services used for reporting operation errors are described in clause 14. + +## 11.4 AssistRequestInstructions procedure + +### 11.4.1 General description + +This operation may be used by an assist gsmSSF or by a gsmSRF. The operation is sent to the gsmSCF when the assisting gsmSSF or gsmSRF receives an indication from an initiating gsmSSF indicating an assist procedure. + +#### 11.4.1.1 Parameters + +- correlationID: +This parameter is used by the gsmSCF to associate the "AssistRequestInstructions" from the assisting gsmSSF or by a gsmSRF with the request from the initiating gsmSSF. The value of the "correlationID" may be extracted from the digits received from the initiating gsmSSF. +- iPSSPCapabilities: +Indicates which gsmSRF resources are attached, available and supported within: + - the MSC where the assisting gsmSSF resides; or + - the IP where the gsmSRF resides. + +### 11.4.2 Invoking entity (gsmSSF/gsmSRF) + +#### 11.4.2.1 Normal procedure + +assisting gsmSSF or gsmSRF preconditions: + +- (1) An assist indication is detected by the assisting gsmSSF or gsmSRF. + +assisting gsmSSF or gsmSRF postconditions: + +- (1) The assisting gsmSSF FSM is in the state "Waiting\_for\_Instructions" or the gsmSRF FSM is in the state "Connected". + +On receipt of an assist indication from the initiating gsmSSF, the assisting gsmSSF or gsmSRF shall ensure that the required resources are available to invoke an "AssistRequestInstructions" operation in the assist gsmSSF or gsmSRF and shall indicate to the initiating gsmSSF that the call is accepted. The "AssistRequestInstructions" operation is invoked by the assist gsmSSF or gsmSRF after the call, which initiated the assist indication, is accepted. + +#### 11.4.2.2 Error handling + +Generic error handling for the operation related errors are described in clause 10 and the TC services which are used for reporting operation errors are described in clause 14. + +## 11.5 CallGap procedure + +### 11.5.1 General description + +The gsmSCF uses this operation to request the gsmSSF to reduce the rate at which specific service requests are sent to the gsmSCF. This operation may be sent only within a dialogue that has been opened by the gsmSSF by an InitialDP operation. + +### 11.5.1.1 Parameters + +- gapCriteria: +This parameter identifies the criteria for a call to be subject to call gapping. It is a choice of the following parameters: "basicGapCriteria" or "compoundGapCriteria": + - basicGapCriteria: +This parameter consists of the following parameters: + - calledAddressValue: +This parameter indicates that call gapping shall be applied when the leading digits of the dialled number of a call attempt match those specified in "calledAddressValue". The called address is the one received from the current call control. + - gapOnService: +This parameter indicates that call gapping shall be applied when the Service Key of a Service initiation attempt matches the Service Key specified in "gapOnService". + - calledAddressAndService: +This parameter indicates that call gapping shall be applied when the Service Key of a Service initiation attempt matches the Service Key defined in "calledAddressAndService" and the leading digits of the dialled number of a that call attempt match the dialled digits defined in "calledAddressAndService". The called address is the one received from the current call control. + - callingAddressAndService: +This parameter indicates that call gapping shall be applied when the Service Key of a Service initiation attempt matches the Service Key defined in "callingAddressAndService" and the leading digits of the calling party number of that call attempt match the calling party number defined in "callingAddressAndService". In the case of call forwarding the calling address to be gapped shall the redirecting number which is placed in the Initial DP operation. + - compoundGapCriteria: +This parameter consists of the following parameters: + - basicGapCriteria: +This parameter is as described above. + - scfID: +This parameter identifies a gsmSCF. The scfID shall convey the necessary gsmSCF address information (e.g. Global Title) in the network to the requesting gsmSSF. Refer to ITU-T Recommendation Q.713 [42] "calling party address" parameter. The network operator shall decide about the actual mapping of this parameter on the used signalling system. +This parameter indicates the address of the gsmSCF which requests the call gapping. +If scfID is used in an operation that crosses an inter-network boundary, then its encoding must be understood in both networks and if the length is extended beyond 10 bytes this must be supported by both entities; this requires bilateral agreement on the encoding. If this parameter is not available, then the call gapping is not dedicated to a specific gsmSCF. +This parameter is restricted to include a fixed GT address string. + +NOTE: In the case where the GT addresses more than one SCP (e.g. a mated pair), then if one of these physical SCPs enters an overload conditions and issues a CallGap instruction, then the CallGap is applied to all these SCPs. + +- gapIndicators: +This parameter indicates the call gapping characteristics. +- duration: +This parameter specifies the total time interval during which call gapping for the specified gap criteria will be active. + +A duration of 0 indicates that call gapping shall be removed. + +A duration of -2 indicates a network specific duration. + +Other values indicate duration in seconds. A duration of -1 shall not be used. + +- gapInterval: +This parameter specifies the minimum time between calls being allowed through. + +An interval of 0 indicates that calls meeting the gap criteria shall not be rejected. + +An interval of -1 indicates that all calls meeting the gap criteria shall be rejected. + +Other values indicate the gap interval in milliseconds. + +- controlType: +This parameter indicates the reason for activating call gapping. + +The "controlType" value "sCPOverloaded" indicates that an automatic congestion detection and control mechanism in the SCP has detected a congestion situation. + +The "controlType" value "manuallyInitiated" indicates that the service, the network management centre or service management centre, or both has detected a congestion situation, or any other situation that requires manually initiated controls. + +NOTE: The controlType "manuallyInitiated" shall have priority over "sCPOverloaded" call gap. Also non-CAMEL controlled traffic control mechanism may apply to an exchange with the gsmSSF functionality. The non-CAMEL controlled traffic control may also have some influence to the CAMEL call. It is therefore recommended to take measures to co-ordinate several traffic control mechanisms. The non-CAMEL controlled traffic control and co-ordination of several traffic control mechanisms are out of the scope of CAP. + +- gapTreatment: +This parameter indicates how calls that were stopped by the call gapping mechanism shall be treated. + +- informationToSend: + +This parameter indicates an announcement or a tone to be sent to the calling party. At the end of information sending, the call shall be released. + +- inbandInfo: +This parameter specifies the inband information to be sent. + +- messageID: +This parameter indicates the message(s) to be sent, it can be one of the following: + +- j) - elementaryMessageID: +This parameter indicates a single announcement. + +- duration: +This parameter indicates the maximum time duration in seconds that the message shall be played or repeated. A value of "0" indicates endless repetition. + +- tone: +This parameter specifies a tone to be sent to the end-user. + +- toneID: +This parameter indicates the tone to be sent. + +- k) - duration: +This parameter indicates the time duration in seconds of the tone. A value of "0" indicates infinite duration. + +- releaseCause: +If the call shall be released, then this parameter indicates a specific cause value to be sent in the release message. See ETSI EN 300 356-1 [23]. + +## 11.5.2 Responding entity (gsmSSF) + +### 11.5.2.1 Normal procedure + +gsmSSF preconditions: + +- (1) Call gapping for gapCriteria is not active; or +Call gapping for gapCriteria is active. +- (2) The gsmSSF FSM is in any state except "Idle" and except "Wait\_For\_Request". + +gsmSSF postconditions: + +- (1) The gsmSSME FSM is in the state "Active". +- (2) Call gapping for gapCriteria is activated; or +Call gapping for gapCriteria is renewed; or +Call gapping for gapCriteria is removed. +- (3) No gsmSSF FSM state transition. + +If there is not already an existing gsmSSME FSM for the gap criteria and gsmSCFAddress provided, then a new gsmSSME FSM shall be created. If no gsmSCFAddress is provided, then this refers in general to the gsmSSME FSM without a gsmSCFAddress. This gsmSSME FSM enters the state "Active" and initialises call gapping for the specified CAMEL calls. The parameters "gapIndicators", "controlType", "gapTreatment" and "gsmSCFAddress" for the indicated gap criteria shall be set as provided by the "CallGap" operation. + +In the case that both "manuallyInitiated" and "sCPOverloaded" call gapping are active for the same "gapCriteria", the manuallyInitiated call gapping shall prevail over the "sCPOverloaded" call gapping. More specifically, the following rules shall be applied in the gsmSSF to manage the priority of different control Types associated with the same "gapCriteria": + +- If a gsmSSME FSM already exists for the "gapCriteria" and the gsmSCFAddress provided, then: + - (1) If the (new) "controlType" equals an existing "controlType", then the new parameters (i.e., "gapIndicators" and "gapTreatment") shall overwrite the existing parameters. + - (2) If the (new) "controlType" is different from the existing "controlType", then the new parameters (i.e., "controlType", "gapIndicators" and "gapTreatment") shall be appended to the appropriate gsmSSME FSM (in addition to the existing parameters). The gsmSSME FSM remains in the state "Active". + +If the gsmSSF meets a TDP, then it shall check if call gapping was initiated for the same gsmSCF as the one currently assigned to this TDP or if call gapping exists with no provided gsmSCFAddress. If neither call gapping was initiated nor exists, then an "InitialDP" operation may be sent. + +The gsmSSF shall check if call gapping was initiated either for the "serviceKey" or for the "calledAddressValue" assigned to this TDP. If this is not the case, then an "InitialDP" operation may be sent. If call gapping was initiated for "calledAddressAndService" or "callingAddressAndService" and the "serviceKey" matches, then a check on the "calledAddressValue" and "callingAddressValue" for active call gapping shall be performed. Otherwise, an "InitialDP" operation may be sent. + +If a call to a controlled number matches one "gapCriteria" only, then the corresponding control is applied. If both "manuallyInitiated" call gapping and "sCPOverload" call gapping controls are active, then only the "manuallyInitiated" call gapping shall be applied. + +If a call matches several active "basicGapCriteria", then the treatment as specified in the CallGap associated with the gapCriteria with the highest priority shall be applied, with the priority being from high to low: + +1. calledAddressAndService or calledAddressValue; +2. callingAddressAndService; +3. gapOnService. + +For example, a call with called number 123456 and ServiceKey = NP matches two CallGaps, one with gapCriteria "CalledAdressValue=123" and another one with gapCriteria "gapOnService=NP". Then the call shall be subject to the control of the service request CallGap with "CalledAdressValue=123". + +In the case that multiple call gapping procedures are active with the same gap criteria, the "manuallyInitiated" call gapping shall prevail over the "sCPOverloaded" call gapping. + +If a call to a controlled called number or from a controlled calling number matches several active "basicGapCriteria " of the same type (in this context "calledAddressAndService" and "calledAddressValue" are seen as one type), then only the "gapCriteria" associated with the longest called party number shall be used, and the corresponding control shall be applied. For example, the codes 1234 and 12345 are under control. Then the call with 123456 is subject to the control on 12345. + +If a call to a controlled called number matches calledAddressAndService and calledAddressValue with the same number length, then calledAddressAndService has priority. Furthermore, if both "manuallyInitiated" and "sCPOverloaded" "controlTypes" are active for this "gapCriteria", then the "manuallyInitiated" control shall be applied. + +If call gapping is performed on a call for a particular service and triggering of this service is allowed, then no other gap criteria shall be applied this service instance. + +Active GapCriteria with assigned scfID shall have higher priority than the other GapCriteria. In the case that an entry with scfID matching the current call exists, all other criteria without scfID shall not be evaluated. + +The matching entries with scfID shall be evaluated in accordance with the priority rules for the basic criteria listed above. + +If call gapping shall be applied and there is no gap interval active, then an "InitialDP" operation may be sent including the "cGEncountered" parameter in accordance with the specified controlType. A new gap interval shall be initiated as indicated by "gapInterval". + +If a gap interval is active, then no "InitialDP" operation shall be sent and the call shall be treated as defined by Default Call Handling of the valid CSI and "gapTreatment". + +If the indicated duration equals "0", then the call gap process shall be stopped. + +If call gapping proceeds, then the gsmSSME FSM remains in the state "Active". Otherwise, the gsmSSME FSM transits to the state "idle". + +## 11.5.2.2 Error handling + +Operation related error handling is not applicable, due to class 4 operation. + +# 11.6 CallInformationReport procedure + +## 11.6.1 General description + +The gsmSSF uses this operation to send specific call information for a single call party to the gsmSCF as requested by the gsmSCF in previous "CallInformationRequest" operation. The report shall be sent at the end of a call party connection which is indicated by one of the events specified below. + +### 11.6.1.1 Parameters + +- requestedInformationList: +The gsmSSF sends the appropriate types and values to the gsmSCF in accordance with the requested information. +- legID: +This parameter indicates the party in the call for which the information has been collected. + +## 11.6.2 Invoking entity (gsmSSF) + +### 11.6.2.1 Normal procedure + +gsmSSF preconditions: + +- (1) The indicated or default party is released from the call or call setup towards the indicated or default party is terminated prematurely. +- (2) Requested call information has been collected. +- (3) "CallInformationReport" is pending due to a previously received "CallInformationRequest" operation. +- (4) A control or a monitor relationship exists between the gsmSCF and the gsmSSF. + +gsmSSF postconditions: + +- (1) If there are no armed EDPs or pending reports, then the gsmSSF FSM shall transit to the state "Idle"; otherwise, the gsmSSF FSM shall remain in the same state. + +If the gsmSSF FSM executes a state transition caused by one of the following events: + +- release for the indicated or default leg; +- abandon for the indicated or default leg; +- Called party Busy or Not Reachable for the indicated or default leg; +- gsmSSF No\_Answer timer expiration for the indicated or default leg; +- route select failure for the indicated or default leg; +- release of call initiated by the gsmSCF (ReleaseCall), + +and "CallInformationRequest" is pending for the indicated or default leg, then one "CallInformationReport" operation shall be sent to the gsmSCF, containing all information requested for that leg. + +If a "CallInformationReport" has been sent to the gsmSCF, then no "CallInformationReport" is pending on that leg, i.e. if a further "CallInformationReport" on that leg is required, for example in the case of follow-on call, then this has to be explicitly requested by the gsmSCF. + +### 11.6.2.2 Error handling + +Operation related error handling is not applicable, due to class 4 operation. + +## 11.7 CallInformationRequest procedure + +### 11.7.1 General description + +The gsmSCF uses this operation to request the gsmSSF to record specific information about a single call party and report it to the gsmSCF using the "CallInformationReport" operation. + +#### 11.7.1.1 Parameters + +- requestedInformationTypeList: +This parameter specifies a list of specific items of information which is requested. The list may contain the following parameters: + - callAttemptElapsedTime: +This parameter indicates the duration between the end of CAP processing of operations initiating call setup ("Connect", "Continue" or "ContinueWithArgument") and the received answer indication from the called party. If the callAttemptElapsedTime is requested for the calling party, then a value of "0" shall be reported by the gsmSSF. + +In the case of unsuccessful call setup, the network event indicating the unsuccessful call setup stops the measurement of "callAttemptElapsedTime". + +- callStopTime: +This parameter indicates the time stamp when the connection is released. +- callConnectedElapsedTime: +This parameter indicates the duration between the received answer indication from the called party and the release of that connection. For the calling party it indicates the duration between the sending of InitialDP and the release of that party. +- releaseCause: +This parameter indicates the release cause for the call. +- legID: +This parameter indicates the party in the call for which the information shall be collected. + +## 11.7.2 Responding entity (gsmSSF) + +### 11.7.2.1 Normal procedure + +gsmSSF preconditions: + +- (1) A control relationship exists between gsmSSF and gsmSCF. +- (2) The gsmSSF FSM is in the state "Waiting\_for\_Instructions". + +gsmSSF postconditions: + +- (1) Requested call information is retained by the gsmSSF. +- (2) No gsmSSF FSM state transition. + +The gsmSSF allocates a record for the indicated or default party and stores the requested information if already available and prepares the recording of information items, that will become available later like for example "callStopTimeValue". + +Call information may be requested for any call party (identified by a legID). + +### 11.7.2.2 Error handling + +Generic error handling for the operation related errors are described in clause 10 and the TC services which are used for reporting operation errors are described in clause 14. + +## 11.8 Cancel procedure + +### 11.8.1 General description + +The gsmSCF uses this operation to request the gsmSRF or gsmSSF to cancel a correlated previous operation. + +The Cancel operation may be used for the following purposes: + +- (1) Cancel may be sent to the gsmSRF to cancel the "PlayAnnouncement" or the "PromptAndCollectUserInfo" operation. The cancellation of the operation is indicated via a respective error indication, "Canceled", to the invoking entity of the cancelled "PlayAnnouncement" or "PromptAndCollectUserInfo" operation. +- (2) Cancel may be sent to the gsmSSF to disarm all armed EDPs and cancel all pending reports. This enables the gsmSSF FSM to transit to the state "Idle". If Cancel is used for this purpose, then the Cancel operation does not specify any specific operation to be cancelled. + +### 11.8.1.1 Parameters + +- invokeID: +This parameter specifies which operation invocation shall be cancelled, i.e. PromptAndCollectUserInformation or PlayAnnouncement. +- callSegmentID: +This parameter specifies the Call Segment to which the cancellation of the user interaction operation shall apply. +- allRequests: +This parameter indicates that all armed EDP shall be disarmed and that any pending "ApplyChargingReport" and "CallInformationReport" shall be cancelled. + +## 11.8.2 Responding entity (gsmSRF) + +In the case of Cancel(invokeID), the gsmSRF is the responding entity. In this case, the Cancel operation may also contain the callSegmentID parameter. + +### 11.8.2.1 Normal procedure + +gsmSRF preconditions: + +- (1) A PlayAnnouncement or PromptAndCollectUserInformation operation has been received and the gsmSRF FSM is in the state "User Interaction". + +gsmSRF postconditions: + +- (1) The execution of the PlayAnnouncement or PromptAndCollectUserInformation operation has been aborted and the gsmSRF remains in the state "User Interaction". + +### 11.8.2.2 Error handling + +Generic error handling for the operation related errors are described in clause 10 and the TC services which are used for reporting operation errors are described in clause 14. + +## 11.8.3 Responding entity (gsmSSF) + +In the case of Cancel(allRequests), the gsmSSF is the responding entity. + +### 11.8.3.1 Normal procedure + +gsmSSF preconditions: + +- (1) The gsmSSF FSM is in the state "Waiting\_for\_Instructions" or in the state "Monitoring". + +gsmSSF postconditions: + +- (1) All armed EDPs are disarmed and all pending reports are cancelled. +- (2) If the gsmSSF FSM was in the state "Monitoring", then it shall transit to the state "Idle"; or +If the gsmSSF FSM was in the state "Waiting\_for\_Instructions", then it shall remain in that state. +A subsequent call-processing operation will result in a gsmSSF FSM state transition to the state "Idle". If the call is in the active state, then the gsmSSF shall treat it autonomously as a normal (non-CAMEL) call. + +### 11.8.3.2 Error handling + +Sending of return error on cancel is not applicable in the cancel "allRequests" case. Generic error handling for the operation related errors are described in clause 10 and the TC services which are used for reporting operation errors are described in clause 14. + +## 11.8A CollectInformation Procedure + +### 11.8A.1 General description + +The gsmSCF uses this operation to request the gsmSSF to perform the call processing actions to collect additional digits from the calling party and report it to the gsmSCF. The CollectInformation operation may be used for TO calls in the gsmSSF. The gsmSCF shall arm the Collected\_Info DP as EDP-R before sending this operation. + +#### 11.8A.1.1 Parameters + +None + +Note: An operation argument is supported for future extensibility. + +### 11.8A.2 Responding entity (gsmSSF) + +#### 11.8A.2.1 Normal procedure + +gsmSSF preconditions: + +- (1) A control relationship exists between the gsmSCF and the gsmSSF; +- (2) Basic call processing has been suspended at CollectedInfo DP or AnalysedInfo DP; +- (3) CollectedInfo DP has been armed as EDP-R; +- (4) The gsmSSF FSM is in the state "Waiting\_for\_Instructions". + +gsmSSF postconditions: + +- (1) The gsmSSF performs the call processing actions to collect additional dialled digits from the calling party; +- (2) The gsmSSF FSM transits to the state "Monitoring"; +- (3) In the O-BCSM, call processing resumes at PIC Collect\_Info or PIC Analyze\_Information. + +#### 11.8A.2.2 Error handling + +Generic error handling for the operation related errors are described in clause 10 and the TC services which are used for reporting operation errors are described in clause 14. + +## 11.9 Connect procedure + +### 11.9.1 General description + +The gsmSCF uses this operation to request the gsmSSF to perform the call processing actions to route a call to a specific destination. + +In general all parameters which are provided in a Connect operation to the gsmSSF shall replace the corresponding signalling parameter in the CCF in O-BCSM, in accordance with ETSI ES 201 296 [21] and shall be used for subsequent call processing. The CCF of the T-BCSM shall send corresponding signalling parameters to new call leg without using them in subsequent call processing. Parameters which are not provided by the Connect operation shall retain their value (if already assigned) in the CCF for subsequent call processing. + +#### 11.9.1.1 Parameters + +- destinationRoutingAddress: +This parameter contains the called party numbers towards which the call shall be routed. +- alertingPattern: +This parameter indicates the type of alerting to be applied. It is defined in 3GPP TS 29.002 [11]. + +- serviceInteractionIndicatorsTwo: +This parameter contains indicators to resolve interactions between CAMEL based services and network based services. +- callingPartyCategory: +This parameter indicates the type of calling party (e.g., operator, pay phone, ordinary subscriber). +- originalCalledPartyID: +If the call is forwarded by the gsmSCF, then this parameter carries the dialled digits. +- redirectingPartyID: +This parameter indicates the last directory number the call was redirected from. +- redirectionInformation: +This parameter contains forwarding related information, such as redirecting counter. +- genericNumbers: +This parameter allows the gsmSCF to set the Generic Number parameter used in the network. It is used for transfer of Additional Calling Party Number. +- suppressionOfAnnouncement: +This parameter indicates that announcements and tones which are played in the exchange at non-successful call set-up attempts shall be suppressed. +- oCSIApplicable: +This parameter indicates to the GMSC/gsmSSF or VMSC/gsmSSF that the Originating CAMEL Subscription Information, if present, shall be applied on the outgoing call leg created with the Connect operation. For the use of this parameter see 3GPP TS 23.078 [7]. +- Carrier: +This parameter indicates carrier information. It consists of the carrier selection field followed by the Carrier ID information to be used by gsmSSF for routeing a call to a carrier. + +It contains the following embedded parameters: + +- carrierSelectionField: +This parameter indicates how the selected carrier is provided (e.g. pre-subscribed). +- carrierID: +This parameter indicates the carrier to use for the call. It contains the digits of the carrier identification code. +- naOliInfo: +This parameter contains originating line information which identifies the charged party number type to the carrier. +- ChargeNumber: +This parameter contains the number that identifies the entity to be charged for the call. It identifies the chargeable number for the usage of a carrier (applicable on a call sent into a North American long distance carrier). For a definition of this parameter refer to ANSI T1.113-1995 [92]. +- cug-Interlock: +This parameter uniquely identifies a CUG within a network. +- cug-OutgoingAccess: +This parameter indicates if the calling user has subscribed to the outgoing access inter-CUG accessibility subscription option. +- bor-InterrogationRequested: +This parameter indicates that Basic Optimal Routeing is requested for the call. +- legToBeConnected: +This parameter indicates the leg to be connected. +- suppress-N-CSI: +This parameter indicates that N-CSI shall be suppressed + +## 11.9.2 Responding entity (gsmSSF) + +### 11.9.2.1 Normal procedure + +gsmSSF preconditions: + +- (1) A control relationship exists between the gsmSSF and the gsmSCF. +- (2) Basic call processing has been suspended at a DP. +- (3) The gsmSSF FSM is in the state "Waiting\_for\_Instructions". + +gsmSSF postconditions: + +- (1) The gsmSSF performs the call processing actions to route the call to the specified destination. +- (2) In the O-BCSM, call processing resumes at PIC Analyze\_Information. + +On receipt of this operation, the gsmSSF performs the following actions: + +- If no EDPs have been armed and neither a CallInformationReport nor an ApplyChargingReport has been requested, then the gsmSSF FSM transits to the state "Idle". Otherwise, the gsmSSF FSM transits to the state "Monitoring". + +The gsmSSF shall not perform any implicit arming or disarming of DPs. + +Statistic counter(s) are not affected. + +### 11.9.2.2 Error handling + +Generic error handling for the operation related errors are described in clause 10 and the TC services which are used for reporting operation errors are described in clause 14. + +## 11.10 ConnectToResource procedure + +### 11.10.1 General description + +The gsmSCF uses this operation to connect a call segment from the gsmSSF to a specialized resource. After successful connection to the gsmSRF, the interaction with the parties in the call segment can take place. The gsmSSF relays all operations for the gsmSRF and all responses from the gsmSRF. + +#### 11.10.1.1 Parameters + +- resourceAddress: +This parameter identifies the physical location of the gsmSRF. It may be one of the following parameters. + - iPRoutingAddress: +This parameter indicates the routeing address to set up a connection towards the gsmSRF. + - none: +This parameter indicates that the call segment shall be connected to a predefined gsmSRF. +- serviceInteractionIndicatorsTwo: +This parameter contains an indicator that is used for the control of the through connection to the Calling Party. + +NOTE The call segment to which the ConnectToResource applies does not have to contain a leg to the calling party. + +The assisting gsmSSF shall always assume that Bothway Throughconnection is required, and hence will ignore this parameter if received. + +- callSegmentId: +This parameter indicates the call segment to which the Connect To Resource procedure applies. + +## 11.10.2 Responding entity (gsmSSF) + +### 11.10.2.1 Normal procedure + +gsmSSF preconditions: + +- (1) A control relationship exists between the gsmSCF and the gsmSSF. +- (2) The gsmSSF FSM is in the state "Waiting\_for\_Instructions". + +gsmSSF postconditions: + +- (1) The call segment is connected to the gsmSRF. +- (2) A control relationship between the gsmSCF and the gsmSRF is established. +- (3) The gsmSSF FSM transits to the state "Waiting\_for\_end\_of\_User\_Interaction". + +NOTE: The successful connection to the gsmSRF causes a gsmSRF FSM state transition from the state "Idle" to the state "Connected". + +### 11.10.2.2 Error handling + +Generic error handling for the operation related errors are described in clause 10 and the TC services which are used for reporting operation errors are described in clause 14. + +## 11.11 Continue procedure + +### 11.11.1 General description + +The gsmSCF uses this operation to request the gsmSSF to proceed with call processing at the DP at which it previously suspended call processing to await gsmSCF instructions. The gsmSSF continues call processing without substituting new data from the gsmSCF. + +#### 11.11.1.1 Parameters + +None. + +## 11.11.2 Responding entity (gsmSSF) + +### 11.11.2.1 Normal procedure + +gsmSSF preconditions: + +- (1) A control relationship exists between the gsmSSF and the gsmSCF. +- (2) Basic call processing has been suspended at any DP. +- (3) The gsmSSF FSM is in the state "Waiting\_for\_Instructions". + +gsmSSF postconditions: + +- (1) BCSM: If the Call Segment has received all the required resumptions then basic call processing continues. +- (2) The gsmSSF FSM remains in the same state unless all resumptions have been received. + +If all resumptions have been received, then: + +- If there are armed EDPs or pending reports and no user interaction is ongoing, then the gsmSSF FSM transits to the state "Monitoring"; or +- If there are no armed EDPs neither pending reports, then the gsmSSF FSM transits to the state "Idle". + +### 11.11.2.2 Error handling + +Operation related error handling is not applicable, due to class 4 operation. + +## 11.12 ContinueWithArgument Procedure + +### 11.12.1 General description + +The gsmSCF uses this operation to request the gsmSSF to proceed with call processing at the DP at which it previously suspended call processing to await gsmSCF instructions. It is also used to provide additional service related information to a User (Called Party or Calling Party) whilst the call processing proceeds. + +In general all parameters which are provided in a ContinueWithArgument operation to the gsmSSF shall replace the corresponding signalling parameter in the CCF, in accordance with ETSI ES 201 296 [21], and shall be used for subsequent call processing. Parameters which are not provided by the ContinueWithArgument operation shall retain their value (if already assigned) in the CCF for subsequent call processing. + +#### 11.12.1.1 Parameters + +- legOrCallSegment: +This parameter indicates the leg or Call Segment to which the ContinueWithArgument operation shall apply. +- alertingPattern: +This parameter indicates the type of alerting to be applied. It is defined in 3GPP TS 29.002 [11]. +- serviceInteractionIndicatorsTwo: +This parameter contains indicators that are used to resolve interactions between CAMEL based services and network based services. +- callingPartysCategory: +This parameter indicates the type of calling party (e.g., operator, pay phone, ordinary subscriber). +- genericNumbers: +This parameter allows the gsmSCF to set the Generic Number parameter used in the network. It is used for transfer of Additional Calling Party Number. +- suppressionOfAnnouncement: +This parameter indicates that announcements and tones which are played in the exchange at non-successful call set-up attempts shall be suppressed. +- carrier: +This parameter indicates carrier information. It consists of the carrier selection field followed by the Carrier ID information to be used by gsmSSF for routing a call to a carrier. + +It contains the following embedded parameter: + +- carrierSelectionField: +This parameter indicates how the selected carrier is provided (e.g. pre-subscribed). +- carrierID: +This parameter indicates the carrier to use for the call. It contains the digits of the carrier identification code. +- naOliInfo: +This parameter contains originating line information which identifies the charged party number type to the carrier. +- chargeNumber: +This parameter contains the number that identifies the entity to be charged for the call. It identifies the chargeable number for the usage of a carrier (applicable on a call sent into a North American long distance carrier). For a definition of this parameter refer to ANSI T1.113-1995 [92]. +- cug-Interlock: +This parameter uniquely identifies a CUG within a network. + +- cug-OutgoingAccess: +This parameter indicates if the calling user has subscribed to the outgoing access inter-CUG accessibility subscription option. +- bor-InterrogationRequested: +This parameter indicates that Basic Optimal Routeing is requested for the call. +- suppress-O-CSI: +This parameter indicates that O-CSI shall be suppressed for the forwarding leg or deflecting leg. +- suppress-D-CSI: +This parameter indicates that D-CSI shall be suppressed for the leg. +- suppress-N-CSI: +This parameter indicates that N-CSI shall be suppressed for the leg or trunk originated call. +- suppressOutgoingCallBarring: +This parameter indicates that outgoing call barrings shall be suppressed for the leg. + +## 11.12.2 Responding entity (gsmSSF) + +### 11.12.2.1 Normal procedure + +gsmSSF preconditions: + +- (1) A control relationship exists between the gsmSSF and the gsmSCF. +- (2) Basic call processing has been suspended at a DP. +- (3) The gsmSSF FSM is in the state "Waiting\_for\_Instructions". + +gsmSSF postconditions: + +- (1) BCSM: If the Call Segment has received all the required resumptions then basic call processing continues with modified information, +- (2) The gsmSSF FSM remains in the same state unless all resumptions have been received. + +If all resumptions have been received, then: + +- If there are armed EDPs or pending reports and no user interaction is ongoing, then the gsmSSF FSM transits to the state "Monitoring"; or +- If there are no armed EDPs neither pending reports, then the gsmSSF FSM transits to the state "Idle". + +### 11.12.2.2 Error handling + +Generic error handling for the operation related errors are described in clause 10 and the TC services which are used for reporting operation errors are described in clause 14. + +## 11.13 DisconnectForwardConnection procedure + +### 11.13.1 General Description + +The gsmSCF uses this operation for the following two purposes: + +- (1) To clear a connection to a gsmSRF: + +The operation is used to explicitly disconnect a connection to a resource (gsmSRF) established previously with a "ConnectToResource" or an "EstablishTemporaryConnection" operation. It is used for a forward disconnection from the gsmSSF. + +An alternative solution is the backward disconnect from the gsmSRF, controlled by the "DisconnectFromIPForbidden" parameter in the "PlayAnnouncement" and "PromptAndCollectUserInformation" operations. + +- (2) To clear a connection to an assisting gsmSSF: + +The operation is sent to the non-assisting gsmSSF of a pair of gsmSSFs involved in an assist procedure. It is used to disconnect the temporary connection between the initiating gsmSSF and the assisting gsmSSF and the connection between the assisting gsmSSF and its associated gsmSRF. + +The DisconnectForwardConnection operation shall not be used when the CallSegmentID is required. + +#### 11.13.1.1 Parameters + +None. + +### 11.13.2 Responding entity (gsmSSF) + +#### 11.13.2.1 Normal procedure + +gsmSSF preconditions: + +- (1) The basic call processing has been suspended at a DP. The gsmSSF FSM in the initiating gsmSSF is in the state "Waiting\_for\_end\_of\_User\_Interaction" or in the state "Waiting\_for\_end\_of\_Temporary\_Connection". + +gsmSSF postconditions: + +- (1) The connection to the gsmSRF or assisting gsmSSF is released. +- (2) The gsmSSF FSM is in the state "Waiting\_for\_Instructions". + +The receipt of "DisconnectForwardConnection" results in a disconnection of the assisting gsmSSF or the PE containing the gsmSRF from the call. It does not result in a release of the connection between the gsmSSF and the end-user. + +On receipt of this operation, the gsmSSF shall perform the following actions: + +- The initiating gsmSSF releases the connection to the assisting gsmSSF or the gsmSRF. +- The gsmSSF FSM transits to the state "Waiting\_for\_Instructions". + +NOTE: The successful disconnection to the gsmSRF causes a gsmSRF FSM state transition to the state "Idle". A current order (e.g. "PlayAnnouncement" or "PromptAndCollectUserInfo") is cancelled and any queued order (e.g. "PlayAnnouncement" or "PromptAndCollectUserInfo") is discarded. + +#### 11.13.2.2 Error handling + +Generic error handling for the operation related errors are described in clause 10 and the TC services which are used for reporting operation errors are described in clause 14. + +### 11.14 DisconnectForwardConnectionWithArgument procedure + +#### 11.14.1 General Description + +The gsmSCF uses this operation to disconnect a connection to a resource (gsmSRF) established previously with a "ConnectToResource" or an "EstablishTemporaryConnection" operation. + +#### 11.14.1.1 Parameters + +- callSegmentID: +This parameter indicates the Call Segment to be disconnected from the resource. + +### 11.14.2 Responding entity (gsmSSF) + +#### 11.14.2.1 Normal procedure + +gsmSSF preconditions: + +- (1) The basic call processing has been suspended at a DP. The CS\_gsmSSF FSM in the initiating gsmSSF is in the state "Waiting\_for\_end\_of\_User\_Interaction" or in the state "Waiting\_for\_end\_of\_Temporary\_Connection". + +gsmSSF postconditions: + +- (1) The connection to the gsmSRF or assisting gsmSSF is released. +- (2) The CS\_gsmSSF FSM transits to the state "Waiting\_for\_Instructions". + +The receipt of "DisconnectForwardConnectionWithArgument" results in disconnecting the PE containing the gsmSRF from the specified Call Segment. It does not result in a release of the connection between the gsmSSF and the end-user. + +On receipt of this operation, the gsmSSF shall perform the following actions: + +- The gsmSSF releases the connection to the assisting gsmSSF or the gsmSRF. +- The gsmSSF FSM transits to the state "Waiting\_for\_Instructions". + +NOTE: The successful disconnection from the gsmSRF causes the gsmSRF to transit to the state "Idle". A current order (e.g. "PlayAnnouncement" or "PromptAndCollectUserInfo") is cancelled and any queued order (e.g. "PlayAnnouncement" or "PromptAndCollectUserInfo") is discarded. + +## 11.14.2.2 Error handling + +Generic error handling for the operation related errors is described in clause 10 and the TC services which are used for reporting operation errors are described in clause 14. + +# 11.15 DisconnectLeg procedure + +## 11.15.1 General Description + +The gsmSCF uses this operation to request the gsmSSF to release a specific leg associated with the call. Any other leg(s) not specified in the Disconnect Leg operation are retained. + +### 11.15.1.1 Parameters + +- legToBeReleased: +This parameter indicates the call leg to be released. +- releaseCause: +This parameter may be used by the MSC for generating specific tones to the party to be released or to fill in the "cause" parameter in the release message. + +## 11.15.2 Responding entity (gsmSSF) + +### 11.15.2.1 Normal procedure + +gsmSSF preconditions: + +- 1) A control relationship exists between the gsmSCF and the gsmSSF; +- 2) User interaction is not in progress in the Call Segment containing the leg to be disconnected. + +gsmSSF postconditions: + +- 1) The gsmSSF performs the call processing actions to release the indicated party. +- 2) Any armed EDPs on that leg shall be disarmed; any pending reports for that leg shall be sent to the gsmSCF. +- 3) If the released leg was the last leg within the Call Segment, then the CS\_gsmSSF FSM for that Call Segment returns to the state "Idle". +- 4) If the leg was the last leg within the call, then the CSA\_gsmSSF FSM returns to the state "Idle". + +- 5) If the CS\_gsmSSF FSM for the Call Segment concerned has not returned to the state "Idle", then it transits to the state "Waiting\_for\_Instructions". The remaining BCSM instances within the Call Segment shall transit to the O\_Mid\_Call DP or to the T\_Mid\_Call DP, unless already suspended at a DP. The Mid\_Call EDP shall not be reported for this case. +- 6) A Return Result shall be sent to the gsmSCF immediately after successful execution of this operation. + +## 11.15.2.2 Error handling + +Generic error handling for the operation related errors is described in clause 10, and the TC services which are used for reporting operation errors are described in clause 14. + +# 11.16 EntityReleased procedure + +## 11.16.1 General Description + +The CSA uses this operation to inform the gsmSCF about the release of a logical entity (Call Segment or BCSM) caused by exception or errors. The CSA shall use this operation if this information can not be conveyed in a TC\_ABORT or TC\_END TC message because the TC dialogue has to be maintained for other logical entities (Call Segment or BCSM) in this CSA which are not affected by this error or exception. The CSA shall not use this operation if the last Call Segment in the CSA was released. + +### 11.16.1.1 Parameters + +This operation consists of a choice of the following parameters: + +- CSFailure: +Indicates that a Call Segment was released. It contains of the following parameters: + - callSegmentID: +This parameter identifies the released Call Segment. + - cause: +This parameter indicates the cause for releasing this Call Segment. The cause may be used by the gsmSCF to decide the further handling of the call. +- BCSMFailure: +This parameter indicates that a leg was released. It consists of the following parameters: + - legID: +This parameter identifies the released leg. + - cause: +This parameter indicates the cause for releasing this BCSM. The cause may be used by the gsmSCF to decide the further handling of the call. + +## 11.16.2 Invoking entity (gsmSSF) + +### 11.16.2.1 Normal procedure + +CSA\_gsmSSF preconditions: + +- (1) Any CSA\_gsmSSF FSM state except "Idle". + +CSA\_gsmSSF postconditions: + +- + +gsmSSF postconditions: + +- (1) If the released entity was a BCSM (leg), then only the appropriate resources are released. If the released entity was a Call Segment, then the related CS\_gsmSSF FSM returns to the state "Idle". + +### 11.16.2.2 Error handling + +Generic error handling for the operation related errors is described in clause 10, and the TC services which are used for reporting operation errors are described in clause 14. + +## 11.17 EstablishTemporaryConnection procedure + +### 11.17.1 General Description + +The gsmSCF uses this operation to create a connection between an initiating gsmSSF and an assisting gsmSSF as part of a service assist procedure. It can also be used to create a connection between a gsmSSF and a gsmSRF, for the case where the gsmSRF exists in a separately addressable PE. + +The assistingSSPIRoutingAddress shall contain routeing digits, a correlationID and a scfID when a temporary connection shall be established between PLMNs and no bilateral agreement exists between the involved network operators to transfer correlationID and SCFiD as separate parameters. + +#### 11.17.1.1 Parameters + +- assistingSSPIRoutingAddress: +This parameter indicates the destination address of the gsmSRF for assist procedure. The "assistingSSPIRoutingAddress" may contain embedded within it, a "correlationID" and "scfID", but only if "correlationID" and "scfID" are not specified separately. +- correlationID: +This parameter is used by the gsmSCF to associate the "AssistRequestInstructions" from the assisting gsmSSF (or the gsmSRF) with the Request from the initiating gsmSSF. The "correlationID" shall be used only if the correlation id is not embedded in the "assistingSSPIRoutingAddress". The network operator has to decide about the actual mapping of this parameter on the used signalling system. +- scfID: +This parameter contains the gsmSCF identifier and enables the assisting gsmSSF to identify which gsmSCF the AssistRequestInstructions shall be sent to. +The "scfID" shall be used only if the gsmSCF id is not embedded in the "assistingSSPIRoutingAddress". The network operator has to decide about the actual mapping of this parameter on the used signalling system. +When ScfID is used in an operation which crosses an internetwork boundary, its encoding must be understood in both networks and if the length is extended beyond 10 bytes this must be supported by both entities; this requires bilateral agreement on the encoding. +- serviceInteractionIndicatorsTwo: +This parameter contains an indicator that is used for the control of the through connection to the Calling Party. +- Carrier: +This parameter contains carrier information. It consists of the carrier selection field followed by the Carrier ID information to be used by gsmSSF for routeing a call to a carrier. + +It contains the following embedded parameter: + +- carrierSelectionField: +This parameter indicates how the selected carrier is provided (e.g. pre-subscribed). +- carrierID: +This parameter indicates the carrier to use for the call. It contains the digits of the carrier identification code. +- naOliInfo: +This parameter contains originating line information which identifies the charged party number type to the carrier. +- chargeNumber: +This parameter contains the number that identifies the entity to be charged for the call. It identifies the chargeable number for the usage of a carrier (applicable on a call sent into a North American long distance carrier). For a definition of this parameter refer to ANSI T1.113-1995 [92]. + +- callSegmentID: +This parameter indicates the Call Segment to which the temporary connection shall be established. +- originalCalledPartyID: +This parameter identifies the original called party. +- callingPartyNumber: +This parameter identifies the calling party. + +## 11.17.2 Responding entity (gsmSSF) + +### 11.17.2.1 Normal procedure + +gsmSSF preconditions: + +- (1) The gsmSSF FSM is in the state "Waiting\_for\_Instructions". +- (2) The gsmSSF is not an assisting gsmSSF. + +gsmSSF postconditions: + +- (1) The gsmSSF performs the call processing actions to route the call to the assisting gsmSSF or gsmSRF in accordance with the "assistingSSPIPRoutingAddress" requested by the gsmSCF. +- (2) The gsmSSF FSM transits to the state "Waiting\_for\_end\_of\_Temporary\_Connection". + +On receipt of this operation, the gsmSSF shall perform the following actions: + +- Route the call to assisting gsmSSF or gsmSRF using "assistingSSPIPRoutingAddress"; + +### 11.17.2.2 Error handling + +Until the connection setup has been accepted (refer to ITU-T Recommendation Q.71 [41]) by the assisting gsmSSF or the gsmSRF, all received failure indications from the network on the ETC establishment shall be reported to the gsmSCF as EstablishTemporaryConnection error ETCFailed (e.g., busy, congestion). + +NOTE The operation timer for EstablishTemporaryConnection shall be longer than the maximum allowed time for the signalling procedures to accept the connection. + +Generic error handling for the operation related errors are described in clause 10 and the TC services which are used for reporting operation errors are described in clause 14. + +## 11.18 EventReportBCSM procedure + +### 11.18.1 General description + +The gsmSSF uses this operation to notify the gsmSCF of a call related event previously requested by the gsmSCF in a "RequestReportBCSMEVENT" operation. + +#### 11.18.1.1 Parameters + +- eventTypeBCSM: +This parameter specifies the type of event that is reported. +- eventSpecificInformationBCSM: +This parameter indicates the call related information specific to the event. + +For Collected\_Info it shall contain the CalledPartyNumber parameter. + +For Route\_Select\_Failure it shall contain the "FailureCause", if available. + +For O\_Busy it shall contain the "BusyCause", if available. + +- If the busy event is triggered by an ISUP release message, then the BusyCause is a copy of the ISUP release cause, for example: Subscriber absent, 20 or User busy, 17. + +- If the busy event is triggered by a MAP error, for example: Absent subscriber, received from the HLR, then the MAP cause is mapped to the corresponding ISUP release cause. + +NOTE 1: If no BusyCause is received, then the gsmSCF shall assume busy. + +For T\_Busy it may contain the following parameters, if available. + +- CallForwarded: +This parameter indicates that the busy event is triggered by call forwarding at the GMSC or VMSC. +- ForwardingDestinationNumber: +This parameter indicates the forwarding destination. +- RouteNotPermitted: +This parameter indicates that the busy event is triggered because call forwarding was not invoked in this GMSC due to the rules of Basic Optimal Routeing. +- BusyCause: + - If the busy event is triggered by an ISUP release message, then the BusyCause is a copy of the ISUP release cause, for example: Subscriber absent, 20 or User busy, 17. + - If the busy event is triggered by a MAP error, for example: Absent subscriber, received from the HLR, then the MAP cause is mapped to the corresponding ISUP release cause. + - If the busy event is triggered by call forwarding or call deflection invocation in the GMSC or VMSC, then the BusyCause will refer to the release cause in accordance with the mapping table in 3GPP TS 23.078 [7]. + - If the busy event is triggered by call forwarding at the GMSC, then the BusyCause reflects the forwarding reason (Subscriber Absent, 20 or User busy, 17). The eventSpecificInformationBCSM shall in that case also contain the CallForwarded indication. + +NOTE 2: If no BusyCause is received, then the gsmSCF shall assume busy. + +For O\_No\_Answer it shall be empty. + +For T\_No\_Answer it may contain the CallForwarded indication and the ForwardingDestinationNumber. + +- If the No\_Answer event is triggered by an ISUP release message or expiry of the CAMEL timer TNRY, then the eventSpecificInformationBCSM shall be empty. +- If the No\_Answer event is triggered by call forwarding at the GMSC or VMSC, then the eventSpecificInformationBCSM shall contain the CallForwarded indication and the ForwardingDestinationNumber. + +For O\_Answer or T\_Answer it shall contain the following information, if available: + +- The destination address for the call; +- The OR indicator, in the case that the call was subject to Basic Optimal Routeing, as specified in 3GPP TS 23.079 [8]; +- The forwarding indicator, in the case that the Call Forwarding Supplementary Service was invoked; +- The charge indicator; +- The Extended Basic Service Code, for SCUDIF calls (see 3GPP TS 23.172 [16]); +- The Extended Basic Service Code 2, for SCUDIF calls (see 3GPP TS 23.172 [16]). + +For O\_Mid\_Call and T\_Mid\_Call it shall contain the detected digit string, in accordance with the criterion defined in the RequestReportBCSMEVENT operation. + +For Call\_Accepted, O\_Term\_Seized, O\_Change\_Of\_Position and T\_Change\_Of\_Position it shall contain the following information: + +- locationInformation: +This parameter indicates the location of the MS. + +For O\_Disconnect and T\_Disconnect it shall contain the "releaseCause", if available. + +For O\_Abandon" it may contain the following parameter, if available. + +- routeNotPermitted: +This parameter indicates that the O-Abandon event is triggered because call set up shall not be invoked in this MSC due to the rules of Basic Optimal Routeing. + +For O\_Service\_Change or T\_Service\_Change it may contain the following information: + +- The Extended Basic Service Code, for SCUDIF calls (see 3GPP TS 23.172 [16]) ; + - The initiator of the Service Change; + - The nature of Service Change. +- legID: +This parameter indicates the party in the call for which the event is reported. The gsmSSF shall use the option "receivingSideID" only. + - receivingSideID: +If not included, then the default values for LegID are assumed according to the tables 11-1 and 11-2. +- The "legID" parameter shall always be included for the events O\_Disconnect and T\_Disconnect. +- miscCallInfo: +This parameter indicates Detection Point (DP) related information. + - messageType: +This parameter indicates whether the message is a request, i.e. resulting from a "RequestReportBCSMEVENT" with monitorMode = interrupted, or a notification, i.e. resulting from a "RequestReportBCSMEVENT" with "monitorMode" = "notifyAndContinue". + +## 11.18.2 Invoking entity (gsmSSF) + +### 11.18.2.1 Normal procedure + +gsmSSF preconditions: + +- (1) A control relationship or a monitoring relationship exists between the gsmSSF and the gsmSCF. +- (2) For the O\_Abandon DP and T\_Abandon DP, the gsmSSF FSM is in any state, except "Idle". For other DPs, refer to 3GPP TS 23.078 [7]. +- (3) The BCSM proceeds to an EDP that is armed. + +gsmSSF postconditions: + +- (1) If the message type was notification and there are still armed EDPs or pending reports, then the gsmSSF FSM stays in the state "Monitoring". +- (2) If the message type was notification and there are neither any armed EDPs nor pending reports, then the gsmSSF FSM transits to the state "Idle". +- (3) If the message type was request, then the gsmSSF FSM transits to the state "Waiting\_for\_Instructions". Call processing is interrupted. + +### 11.18.2.2 Error handling + +If the message type is "request" and the Tssf timer expires, then the gsmSSF shall abort the TC dialogue and shall instruct the MSC to treat the call in accordance with the Default Call Handling, valid for this CAMEL dialogue. + +Operation related error handling is not applicable, due to class 4 operation. + +## 11.19 FurnishChargingInformation procedure + +### 11.19.1 General description + +The gsmSCF uses this operation to send charging related information to a logical call record. This logical call record is CAMEL specific. The first FurnishChargingInformation operation of a call leg leads to the generation of a logical call record. The handling of subsequent FurnishChargingInformation operations for a call leg depends on the presence and value of the append free format data parameter in the FurnishChargingInformation operation. For details see 3GPP TS 23.078 [7]. + +If a FurnishChargingInformation operation is received for the called party when the gsmSSF FSM is in the state "Monitoring", or is suspended in one of the following DPs, then the charging information shall be included in the logical call record for the leg that has been or is to be established: + +- Collected\_Info; +- Analysed\_Information; +- O\_Answer; +- Terminating\_Attempt\_Authorised; or +- T\_Answer. + +If a FurnishChargingInformation operation is received for the called party when the gsmSSF is suspended in any other DP, then the charging information shall be included in the logical call record created for the last failed or disconnected called party. + +### 11.19.1.1 Parameters + +- fCIBillingChargingCharacteristics: +This parameter contains the following parameters; +- fCIBCCCAMELsequence1: +This parameter contains the following parameters; +- freeFormatData: +This parameter contains free-format billing and/or charging characteristics; +- partyToCharge: +This parameter indicates the party to bill and/or charge; +- appendFreeFormatData: +This parameter indicates whether previous FurnishChargingInformation free format data is appended or overwritten. Refer to 3GPP TS 23.078 [7] for details on the usage of this parameter. + +## 11.19.2 Responding entity (gsmSSF) + +### 11.19.2.1 Normal procedure + +gsmSSF preconditions: + +- (1) The gsmSSF FSM is in the state +"Waiting\_for\_Instructions"; or +"Waiting\_for\_end\_of\_User\_Interaction"; or +"Waiting\_for\_end\_of\_Temporary\_Connection"; or +"Monitoring". + +gsmSSF postconditions: + +- (1) No gsmSSF FSM state transition. + +On receipt of this operation the gsmSSF performs actions to create the Logical call record if necessary, and writes the free-format information carried in the operation into the Logical call record. A FurnishChargingInformation operation + +will create a Logical Call Data Record (CDR) if such a record does not already exist for the indicated leg. Refer to sect. 11.26.1 for the handling in the case of successive FurnishChargingInformation operations for a call leg. + +The Logical CDRs will be associated for a given call into one or more physical CDRs, as specified in 3GPP TS 32.250 [13]. + +A logical call record is output to a physical CDR when a disconnection event is propagated to the call leg associated with it, or when a Connect operation to create a connection to a Follow-on Called Party is received. Successive FurnishChargingInformation operations indicating the calling leg (leg1) may overwrite data from previously received FurnishChargingInformation operation(s) indicating that leg during the entire call or call attempt. Successive FurnishChargingInformation operations indicating a called leg (leg2 or higher) may overwrite any previously received data from FurnishChargingInformation operation(s) indicating that called leg until the called leg representing that particular called party number is released from the call. When a new called party is created as a result of a follow-on call, and a FurnishChargingInformation operation indicating the called leg is received, then a new Logical call record shall be created for that call leg, for that portion of the call. From then on, any subsequent FurnishChargingInformation operations for that called party may overwrite the data from any previous FurnishChargingInformation operation(s) for the called leg presenting that particular called party number. Logical call records that have been output already are not affected. + +No Logical call record is output at the end of a user interaction. + +## 11.19.2.2 Error handling + +Generic error handling for the operation related errors are described in clause 10 and the TC services which are used for reporting operation errors are described in clause 14. + +# 11.20 InitialDP procedure + +## 11.20.1 General description + +The gsmSSF uses this operation after detection of a TDP-R in the BCSM, to request the gsmSCF for instructions to complete the call. + +### 11.20.1.1 Parameters + +- **serviceKey:** +This parameter indicates to the gsmSCF the requested IN service. It is used to address the required application/SLP within the gsmSCF; this parameter is not for SCP addressing. +- **calledPartyNumber:** +This parameter contains the number used to identify the called party in the forward direction, i.e. see ETSI EN 300 356-1 [23]. This parameter shall be sent only in the Mobile Terminating, Mobile Forwarding, mobile originating on unsuccessful TDP and trunk originating cases. For the trunk originating case the end of pulsing signal (ST) is included in the calledPartyNumber address signals if it has been received or the MSC has determined that the called number information is complete. +- **callingPartyNumber:** +This parameter carries the calling party number to identify the calling party or the origin of the call. See ETSI EN 300 356-1 [23] Calling Party Number signalling information. +- **callingPartysCategory:** +Indicates the type of calling party (e.g. operator, pay phone, ordinary subscriber). See ETSI EN 300 356-1 [23] Calling Party Category signalling information. +- **locationNumber:** +This parameter is used to convey the geographical area address for mobility services, see ITU-T Recommendation Q.762 [44]. It is used when "callingPartyNumber" does not contain any information about the geographical location of the calling party (e.g., origin dependent routeing when the calling party is a mobile subscriber). +- **originalCalledPartyID:** +If the call has met call forwarding on the route to the gsmSSF, then this parameter carries the dialled digits. Refer to EN 300 356-1[23] Original Called Number signalling information. + +- **highLayerCompatibility:** +This parameter indicates the type of the high layer compatibility, which will be used to determine the ISDN - teleservice of a connected ISDN terminal. The highlayerCompatibility can also be transported by ISUP (e.g. within the ATP (see ITU-T Recommendation Q.763 [45]) parameter). +- **additionalCallingPartyNumber:** +The calling party number provided by the access signalling system of the calling user, e.g. provided by a PBX. +- **bearerCapability:** +This parameter indicates the type of the bearer capability connection or the transmission medium requirements to the user. It is a network option to select which of the two parameters to be used: + - **bearerCap:** +This parameter contains the value of the ISUP User Service Information parameter. + +The parameter "bearerCapability" shall be included in the "InitialDP" operation only in the case the ISUP User Service Information parameter is available at the gsmSSF. + +If User Service Information and User Service Information Prime are available at the gsmSSF, then the "bearerCap" shall contain the value of the User Service Information Prime parameter. +- **eventTypeBCSM:** +This parameter indicates the armed BCSM DP event, resulting in the "InitialDP" operation. +- **redirectingPartyID:** +This parameter indicates the last directory number the call was redirected from. +- **redirectionInformation:** +This parameter contains forwarding related information, such as redirecting counter. +See ITU-T Recommendation Q.763 [45] Redirection Information signalling information. +- **iPSSPCapabilities:** +This parameter indicates which gsmSRF resources supported within the VMSC or GMSC the gsmSSF resides in are attached and available. +- **serviceInteractionIndicatorsTwo:** +This parameter contains indicators that are used to resolve interactions between CAMEL based services and network based services. +- **iMSI:** +This parameter contains the IMSI of the mobile subscriber for which the service is invoked. +- **subscriberState:** +This parameter indicates the state of the mobile subscriber for which the service is invoked. The possible states are "busy", "idle" and "not reachable". +- **locationInformation:** +This parameter indicates the location of the MS and the age of the information defining the location. +- **ext-BasicServiceCode:** +This parameter indicates the Basic Service Code. +- **callReferenceNumber:** +This parameter contains the call reference number assigned to the call by the CCF. +- **mscAddress:** +This parameter contains the mscId assigned to the MSC. +- **gmscAddress:** +This parameter contains the gmscId assigned to the GMSC. +- **calledPartyBCDNumber:** +This parameter contains the number used to identify the called party in the forward direction. It may also include service selection information, including \* and # characters. + +- time&Timezone: +This parameter contains the time that the gsmSSF was triggered, and the time zone that the invoking gsmSSF resides in. +- callForwardingSS-Pending: +This parameter indicates that a forwarded-to-number was received and that the call will be forwarded due to the Call Forwarding supplementary service in the GMSC or in the VMSC, unless otherwise instructed by the gsmSCF. +- carrier: +This parameter contains carrier information. It consists of the carrier selection field followed by the Carrier ID information associated with the calling subscriber of a mobile originating call or trunk originating call, the called subscriber of a mobile terminating call or the forwarding subscriber of a mobile forwarded call. + +It contains the following embedded parameter: + +- carrierSelectionField: +This parameter indicates how the selected carrier is provided (e.g. pre-subscribed). +- carrierID: +This parameter indicates the carrier to use for the call. It contains the digits of the carrier identification code. +- cug-Index: +This parameter is used to select a CUG for an outgoing call at the user, or to indicate an incoming CUG call to the user. +- cug-Interlock: +This parameter uniquely identifies a CUG within a network. +- cug-OutgoingAccess: +This parameter indicates if the calling user has subscribed to the outgoing access inter-CUG accessibility subscription option. +- cGEncountered: +This parameter indicates the type of call gapping the related call has been subjected to, if any. +- cause: +This parameter indicates the release cause which triggered the event: + +For Route\_Select\_Failure" it shall contain the "FailureCause", if available. + +For T\_Busy it may contain the following parameters, if available. + +- If the busy event is triggered by an ISUP release message, then the BusyCause shall a copy of the ISUP release cause, for example: Subscriber absent, 20 or User busy, 17. +- If the busy event is triggered by a MAP error, for example: Absent subscriber, received from the HLR, then the MAP cause is mapped to the corresponding ISUP release cause. +- If the busy event is triggered by call forwarding invocation in the GMSC or VMSC, then the BusyCause shall refer to the type of the call forwarding service in accordance with the mapping table in 3GPP TS 23.078 [7]. +- forwardingDestinationNumber: +This parameter contains the forwarding destination. +- ms-Classmark2: +This parameter contains the MS Classmark 2 of the mobile subscriber for which the service is invoked. +- iMEI: +This parameter contains the IMEI (with software version) of the mobile subscriber for which the service is invoked. +- supportedCamelPhases: +This parameter indicates the CAMEL Phases supported in the GMSC or VMSC which sends this operation. +- offeredCamel4Functionalities: +This parameter contains the offered CAMEL phase 4 functionalities. + +- bearerCapability2: +This parameter indicates the type of the bearer capability connection or the transmission medium requirements to the user. +- ext-BasicServiceCode2: +This parameter indicates the Basic Service Code2. +- highLayerCompatibility2: +This parameter indicates the high layer compatibility2 for a SCUDIF call. +- lowLayerCompatibility: +This parameter indicates the low layer compatibility. +- lowLayerCompatibility2: +This parameter indicates the low layer compatibility2 for a SCUDIF call. +- enhancedDialledServicesAllowed: +This parameter indicates that the gsmSCF may use the Enhanced Dialled Services (EDS) for this call. +- UU-Data: +This parameter contains user-to-user signalling service related information. +- collectInformationAllowed: +This parameter indicates that the gsmSCF may use Collect Information for this call. +- releaseCallArgExtensionAllowed: +This parameter indicates that the gsmSCF may use Extensions in Release Call operation for this call. + +## 11.20.2 Invoking entity (gsmSSF) + +### 11.20.2.1 Normal procedure + +gsmSSF preconditions: + +- (1) An event fulfilling the criteria for the DP being executed has been detected. +- (2) Call gapping and SS7 overload are not in effect for the call. + +gsmSSF postconditions: + +- (1) If the DP was armed as a TDP-R and trigger conditions, if present, are fulfilled, then a control relationship between the gsmSCF and the gsmSSF is established. The gsmSSF FSM transits to the state "Waiting\_for\_Instructions". + +The address of the gsmSCF shall be fetched from the valid CSI. The gsmSSF shall provide all available parameters to the gsmSCF. + +If no triggering takes place, because trigger conditions were not fulfilled, then the gsmSSF shall proceed with call handling without CAMEL Service. + +The gsmSSF application timer Tssf is loaded and started when the gsmSSF sends "InitialDP" for requesting instructions from the gsmSCF. It is used to prevent excessive call suspension time. + +### 11.20.2.2 Error handling + +If the gsmSCF is not accessible, then the call proceeds in accordance with the Default Call Handling parameter in the CSI. + +When Tssf expires, then the gsmSSF shall abort the interaction with the gsmSCF by means of an abort to TC and shall call continue the call in accordance with the Default Call Handling parameter in the valid CSI. + +If the calling party abandons after the sending of "InitialDP" and before the TC dialogue is established, then the gsmSSF shall abort the interaction with the gsmSCF by means of an abort to TC. + +Generic error handling for the operation related errors are described in clause 10 and the TC services which are used for reporting operation errors are described in clause 14. + +## 11.21 InitiateCallAttempt procedure + +### 11.21.1 General Description + +The gsmSCF uses this operation to request the gsmSSF to create a new call leg to one call party using the address information provided by the gsmSCF (e.g. wake-up call). InitiateCallAttempt can also be used to create an additional call party in a new Call Segment within an existing Call Segment Association. In both use cases the gsmSCF shall subsequently arm O\_Answer as an EDP-R and the call failure events (Route\_Select\_Failure, O\_Busy and O\_No\_Answer) as EDP-Rs and/or EDP-Ns, in order to enable the gsmSCF to treat this call appropriately when any of these events is encountered. + +#### 11.21.1.1 Parameters + +##### 11.21.1.1.1 Argument Parameters + +- destinationRouteingAddress: +This parameter contains the called party number towards which the call shall be routed. +- callingPartyNumber: +This parameter identifies which number shall be regarded as the calling party for the created call. +- legToBeCreated: +This parameter indicates the LegID to be assigned to the newly created party. +- newCallSegment: +This parameter indicates the Call Segment ID to be assigned to the newly created Call Segment. +- callReferenceNumber: +This parameter contains the call reference number assigned to the call by the gsmSCF. +- gsmSCFAddress: +This parameter indicates the address of the gsmSCF initiating the operation. +- suppress-T-CSI: +This parameter indicates that the T-CSI for the served subscriber shall be suppressed for this call leg. + +##### 11.21.1.1.2 Result Parameters + +- supportedCamelPhases: +This parameter indicates the CAMEL Phases supported in the gsmSSF which receives this operation. +- offeredCamel4Functionalities: +This parameter contains the offered CAMEL phase 4 functionalities. +- releaseCallArgExtensionAllowed: +This parameter indicates that the gsmSCF may use Extensions in Release Call operation for this call. + +### 11.21.2 Responding entity (gsmSSF) + +#### 11.21.2.1 Normal procedure + +gsmSSF preconditions: + +None. + +gsmSSF postconditions: + +- 1) A new O-BCSM has been created; call processing is suspended. +- 2) A Return Result is sent to the gsmSCF. +- 3) The CS\_gsmSSF FSM transits from the state "Idle" to the state "Waiting\_for\_Instructions". + +All subsequent operations are treated in accordance with their normal procedures. + +### 11.21.2.2 Error handling + +Generic error handling for the operation related errors is described in clause 10, and the TC services which are used for reporting operation errors are described in clause 14. + +## 11.22 MoveLeg procedure + +### 11.22.1 General Description + +The gsmSCF uses this operation to request the gsmSSF to move the leg from its current Call Segment to CSID1. + +#### 11.22.1.1 Parameters + +- legIDToMove: +This parameter indicates the leg that shall be moved. + +### 11.22.2 Responding entity (gsmSSF) + +#### 11.22.2.1 Normal procedure + +gsmSSF preconditions: + +- 1) A control relationship exists between the gsmSCF and the gsmSSF. +- 2) The source BCSM is in the alerting phase or in the active phase. +- 3) The target Call Segment fulfills the following preconditions: + - At least one leg in the target Call Segment has reached the active phase, or + - The original BCSM in the target Call Segment is at Terminating\_Attempt\_Authorised, Analysed\_Information (for EDS only) or Collected\_Info detection point, and the outgoing leg of that BCSM has been disconnected by the gsmSCF, or + - The call was created by the gsmSCF. +- 4) The CS\_gsmSSF FSM for each Call Segment involved is in the state "Waiting\_for\_Instructions" or in the state "Monitoring". +- 5) User Interaction is not in progress in either Call Segment. + +gsmSSF postconditions: + +- 1) The gsmSSF performs the appropriate call processing actions. +- 2) The CS\_gsmSSF FSM for CSID1 transits to the state "Waiting\_for\_Instructions". The BCSM instances within CSID1 transit to the O\_Mid\_Call DP or to the T\_Mid\_Call DP, if not already suspended. The Mid\_Call EDP shall not be reported for this case. +- 3) The CS\_gsmSSF process for the source Call Segment is terminated. +- 4) A Return Result is sent to the gsmSCF immediately after successful execution of this operation. +- 5) A Pending ApplyChargingReport for the source call segment shall be sent to the gsmSCF. + +#### 11.22.2.2 Error handling + +Generic error handling for the operation related errors is described in clause 10, and the TC services which are used for reporting operation errors are described in clause 14. + +## 11.23 PlayAnnouncement procedure + +### 11.23.1 General description + +The gsmSCF uses this operation for inband interaction with a CS user. + +#### 11.23.1.1 Parameters + +- informationToSend: +This parameter indicates an announcement a tone to be sent to the end-user by the gsmSRF. + - inbandInfo: +This parameter specifies the inband information to be sent. + - messageID: +This parameter indicates the message(s) to be sent; this may be one of the following: + - elementaryMessageID: +This parameter indicates a single announcement. + - text: +This parameter indicates a text to be sent. The text shall be transformed to inband information (speech) by the gsmSRF. This parameter consists of two parameters; messageContent and attributes. The attributes of the text parameter may consist of items such as language. + - elementaryMessageIDs: +This parameter specifies a sequence of announcements. + - variableMessage: +This parameter specifies an announcement with one or more variable parts. + - numberOfRepetitions: +This parameter indicates the maximum number of times the message shall be sent to the end-user. + - duration: +This parameter indicates the maximum time duration in seconds that the message shall be played or repeated. A value of "0" indicates endless repetition. + - interval: +This parameter indicates the time interval in seconds between successive messages, i.e. the time between the end of the announcement and the start of the repetition of this announcement. This parameter may be used only when "numberOfRepetitions" is > 1. +- tone: +This parameter specifies a tone to be sent to the end-user. + - toneID: +This parameter indicates the tone to be sent. + - duration: +This parameter indicates the time duration in seconds of the tone to be sent. A value of "0" indicates infinite duration. +- disconnectFromIPForbidden: +This parameter indicates whether the gsmSRF may initiate a disconnection from the gsmSSF after the interaction has been completed. + +If this parameter is TRUE, then the gsmSRF shall not initiate a disconnection. If this parameter is FALSE, then the gsmSRF may initiate a disconnection. +- requestAnnouncementCompleteNotification: +This parameter indicates whether or not a "SpecializedResourceReport" shall be sent to the gsmSCF when all information has been sent. + +- requestAnnouncementStartedNotification: +This parameter indicates whether or not a "SpecializedResourceReport" shall be sent to the gsmSCF when the first announcement or tone has started. +- callSegmentID: +This parameter indicates the Call Segment to which the user interaction shall apply. + +## 11.23.2 Responding entity (gsmSRF) + +### 11.23.2.1 Normal procedure + +gsmSRF preconditions: + +- (1) The SRSM-FSM is in the state "Connected"; if the gsmSRF received previously an operation from the gsmSCF, then the SRSM-FSM is in the state "User Interaction". +- (2) When the first announcement or tone has started and "RequestAnnouncementStartedNotification" is TRUE, then the SRSM shall send a "SpecializedResourceReport" operation, containing the "FirstAnnouncementStarted" parameter, to the gsmSCF. + +gsmSRF postconditions: + +- (1) The gsmSRF sends the information to the user as indicated by "informationToSend". +- (2) The SRSM-FSM transits to the state "User Interaction", or remains in the same state. +- (3) If all information has been sent and "RequestAnnouncementCompleteNotification" is TRUE, then the SRSM shall send a "SpecializedResourceReport" operation, containing the "AllAnnouncementsComplete" parameter, to the gsmSCF. +- (4) If all information has been sent and "disconnectFromIPForbidden" is FALSE, then the SRSM disconnects the gsmSRF from the user. + +The announcement sent to the end-user is ended in the following conditions: + +- if neither "duration" nor "numberOfRepetitions" is specified, then the network specific announcement ending conditions shall apply; or +- if "numberOfRepetitions" is specified, when all repetitions have been sent; or +- if duration is specified, when the duration has expired. The announcement is repeated until this condition is met; or +- if "duration" and "numberOfRepetitions" is specified, when one of both conditions is satisfied (whichever comes first). + +### 11.23.2.2 Error handling + +If a Cancel operation is received before or during the processing of the operation, then that operation shall be cancelled immediately and the error "Canceled" shall be reported to the gsmSCF. + +Generic error handling for the operation related errors are described in clause 10 and the TC services which are used for reporting operation errors are described in clause 14. + +## 11.24 PlayTone procedure + +### 11.24.1 General description + +The gsmSCF uses this operation to instruct the gsmSSF to play tones to a leg or a Call Segment using the MSC's tone generator. + +If a Call Segment is indicated, then the tones shall be played to all active legs in that Call Segment. If a leg is indicated, then the tones shall be played to that leg only. + +### 11.24.1.1 Parameters + +- legOrCallSegment: +This parameter indicates the leg or Call Segment to which the PlayTone operation shall apply. +- bursts: +This parameter indicates the variable sequence of tones to be played and consists of the following parameters: + - numberOfBursts: +This parameter indicates the number of bursts that form the burstlist. + - burstInterval: +This parameter indicates the time interval between successive bursts in a sequence of bursts. + - numberOfTonesInBurst: +This parameter indicates the number of tones to be played in each burst. + - toneDuration: +This parameter indicates the time duration of a single tone in a burst. + - toneInterval: +This parameter indicates the time interval between successive tones in a burst. + +## 11.24.2 Responding entity (gsmSSF) + +### 11.24.2.1 Normal procedure + +gsmSSF preconditions: + +The gsmSSF FSM is in one of the following states: + +"Monitoring"; or +"Waiting\_for\_Instructions". + +If a Call Segment is indicated, then at least one of the legs in that Call Segment is in the active phase. + +gsmSSF postconditions: + +- (1) No gsmSSF FSM state transition. + +### 11.24.2.2 Error handling + +Generic error handling for the operation related errors is described in clause 10 and the TC services used for reporting operation errors are described in clause 14. + +## 11.25 PromptAndCollectUserInfo procedure + +### 11.25.1 General description + +The gsmSCF uses this operation to interact with a call party in order to collect information. + +#### 11.25.1.1 Parameters + +- collectedInfo: + - collectedDigits: + +- minimumNbOfDigits: +This parameter specifies the minimum number of valid digits to be collected. +- maximumNbOfDigits: +This parameter specifies the maximum number of valid digits to be collected. The following applies: +"maximumNbOfDigits" $\geq$ "minimumNbOfDigits". +- endOfReplyDigit: +This parameter indicates the digit string used to signal the end of input. + +In the case that the "maximumNbOfDigits" > "minimumNbOfDigits" the following applies: + +If "endOfReplyDigit" is not present, then the end of input is indicated: + +- l) - when the inter-digit timer expires; or +- m) - when the number of valid digits received equals the "maximumNbOfDigits". + +If "endOfReplyDigit" is present, then the end of input is indicated: + +- n) - when the inter-digit timer expires; or +- o) - when the end of reply digit is received; or +- p) - when the number of valid digits received equals the "maximumNbOfDigits". + +When the end of input is reached, the collected digits are sent from gsmSRF to the gsmSCF, including the "endOfReplyDigit" if received by the gsmSRF. In the case the number of valid digits received is less than the "minimumNbOfDigits" when the inter-digit timer expires or when the end of reply digit is received, the input is considered to be erroneous. + +- cancelDigit: +This parameter indicates the cancel digit string that may be entered by the user to request a retry. All digits already received by the gsmSRF are discarded and the PromptAndCollectUserInformation procedure is performed again, thus e.g. the same announcement to request user information is given to the user and information is collected. If this parameter is not present, then the user is not able to request a retry. +- startDigit: +This parameter indicates the start digit string that indicates the start of the valid digits to be collected. The digits that are received by the gsmSRF before this start digit is received, are discarded and are not considered to be valid. The start digit string itself is considered to be valid digits. + +If this parameter is not present, then all received digits are considered to be valid. + +When the end of input is reached, the collected digits are sent from gsmSRF to the gsmSCF, including the "startDigit" if received by the gsmSRF. + +- firstDigitTimeout: +If this parameter is present, then the first digit shall be received by the gsmSRF before first-digit timer expiration. If the first digit is not received before first-digit timer expiration, then the input is considered to be erroneous. + +If this parameter is not present, then the gsmSRF shall use a default value for the first-digit timer. + +If "startDigit" is present, then the first-digit timer shall be stopped after the start digit is received. If "startDigit" is not present, then the first-digit timer shall be stopped when any digit is received, except when the digit matches the "cancelDigit", if present. + +- interDigitTimeout: + +If this parameter is present, then any subsequent valid or invalid digit shall be received by the gsmSRF before the inter-digit timer expires. As a result of receiving a digit, the inter-digit timer is reset and restarted. + +If a subsequent valid or invalid digit is not received before the inter-digit timer expires and the number of received valid digits is less than "minimumNbOfDigits", then the input is considered to be unsuccessful. + +If a subsequent valid or invalid digit is not received before the inter-digit timer expires and the number of received valid digits is greater than "minimumNbOfDigits" and smaller than or equal to "maximumNbOfDigits", then the input is considered to be successful. + +If the "interDigitTimeout" is not present, then the gsmSRF shall use a default value for the inter-digit timer. + +- errorTreatment: + +This parameter defines what specific action shall be taken by the gsmSRF in the event of error conditions occurring. + +- interruptableAnnInd: + +If this parameter is TRUE, then the announcement shall interrupted after the first valid or invalid digit is received by the gsmSRF. If the announcement is interrupted, then a first-digit timer shall not apply anymore. However, if the announcement has not been interrupted, then the first-digit timer shall be started after the announcement has been finished. + +If this parameter is FALSE, then the announcement shall not be interrupted after the first digit is received by the gsmSRF. The received digits during the announcement are discarded and considered to be invalid. All other specified parameters ("minimumNbOfDigits", "maximumNbOfDigits", "endOfReplyDigit", etc.) do not apply before the announcement has been finished. The first-digit timer shall be started after the announcement has been finished. + +- voiceInformation: + +If this parameter is FALSE, then all valid or invalid digits shall be entered by DTMF. + +If this parameter is TRUE, then the calling user is required to provide all valid or invalid information by speech. The gsmSRF shall perform voice recognition and shall translate the provided information into digits. The end of reply digit(s), if required, shall be provided by speech. + +- voiceBack: + +If this parameter is FALSE, then no voice back information shall be given by the gsmSRF. + +If this parameter is TRUE, then the valid input digits received by the gsmSRF shall be announced back to the calling user immediately after the end of input is received. The invalid input digits will not be announced back to the calling user. The end of reply digit(s) shall not be voiced back to the calling user. + +- disconnectFromIPForbidden: + +This parameter indicates whether the gsmSRF may initiate a disconnection from the gsmSSF after the interaction has been completed. + +If this parameter is TRUE, then the gsmSRF shall not initiate a disconnection. If this parameter is FALSE, then the gsmSRF may initiate a disconnection. + +- informationToSend: + +This parameter indicates an announcement or tone to be sent to the end-user by the gsmSRF. + +- inbandInfo: +This parameter specifies the inband information to be sent. +- messageID: +This parameter indicates the message(s) to be sent,, this may be one of the following: + - elementaryMessageID: +This parameter indicates a single announcement. + - text: +This parameter indicates a text to be sent. The text shall be transformed to inband information (speech) by the gsmSRF. The attributes of text may consist of items such as language. + - elementaryMessageIDs: +This parameter specifies a sequence of announcements. + - variableMessage: +This parameter specifies an announcement with one or more variable parts. +- numberOfRepetitions: +This parameter indicates the maximum number of times the message shall be sent to the end-user. +- duration: +This parameter indicates the maximum time duration in seconds that the message shall be played or repeated. A value of "0" indicates endless repetition. +- interval: +This parameter indicates the time interval between successive messages, i.e. the time between the end of the announcement and the start of the repetition of this announcement. This parameter may be used only when "numberOfRepetitions " > 1. +- tone: +This parameter specifies a tone to be sent to the end-user. + - toneID: +This parameter indicates the tone to be sent. + - duration: +This parameter indicates the time duration in seconds of the tone. A value of "0" indicates infinite duration. +- requestAnnouncementStartedNotification: +This parameter indicate whether or not a "SpecializedResourceReport" shall be sent to the gsmSCF when the first announcement or tone has started. +- callSegmentID: +This parameter indicates the Call Segment to which the user interaction shall apply. + +#### Result Parameter: + +- digitsResponse: +This parameter contains the information collected from the end-user. + +## 11.25.2 Responding entity (gsmSRF) + +### 11.25.2.1 Normal procedure + +#### gsmSRF preconditions: + +- (1) The SRSM-FSM is in the state "Connected"; if the gsmSRF received previously an operation from the gsmSCF, then the SRSM-FSM is in the state "User Interaction". +- (2) If the first announcement or tone has started and "RequestAnnouncementStartedNotification" is TRUE, then the SRSM sends a "SpecializedResourceReport" operation, containing the "FirstAnnouncementStarted" parameter, to the gsmSCF. + +gsmSRF postconditions: + +- (1) The gsmSRF has sent the information to the end-user as indicated by "informationToSend". +- (2) The collected information from the end-user is sent to the gsmSCF as RETURN RESULT of the "PromptAndCollectUserInfoInformation". +- (3) If the "disconnectFromIPForbidden" is FALSE, then the gsmSRF initiates a bearer channel disconnect to the gsmSSF and the SRSM FSM transits to the state "Idle". +- (4) Otherwise, the SRSM FSM transits to the state "User Interaction" or remains in the same state. + +The announcement sent to the end-user is ended in the following conditions: + +- if neither "duration" nor "numberOfRepetitions" is specified, then the network specific announcement ending conditions shall apply; or +- if "numberOfRepetitions" is specified, when all repetitions have been sent; or +- if duration is specified, when the duration has expired. The announcement is repeated until this condition is met; or +- if "duration" and "numberOfRepetitions" is specified, when one of both conditions is satisfied (whichever comes first). + +If the parameter "interruptableAnnInd" is not FALSE and the end-user has responded with a digit during the sending of the announcement, then the above conditions are overruled. In that case, the announcement shall be ended immediately. + +The parameter "errorTreatment" specifies how the gsmSRF shall treat an error. The value "reportErrorToSCF" means that the error shall be reported to the gsmSCF by means of Return Error with "ImproperCallerResponse". The value "help" indicates that no error shall be reported to gsmSCF but assistance shall be given to the end-user in the form of a network dependent default announcement (which may be dependent on the context, i.e. the sent message). The value "repeatPrompt" indicates that no error shall be reported to the gsmSCF but the prompt shall be repeated to the end-user. The error handling procedures related to "help" and "repeatPrompt" shall be done only once per "PromptAndCollectUserInfoInformation" operation. + +**NOTE** Note on processing "endOfInput" + +The receipt of any "endOfInput" condition (e.g endOfReplyDigit, cancelDigit, firstDigitTimeout, interDigitTimeout) terminates immediately the ongoing input. In other words when e.g an endOfReplyDigit is received, then the receipt of a subsequent cancelDigit will not be processed anymore. + +## 11.25.2.2 Error handling + +If a Cancel operation is received before or during the processing of the operation, then the operation shall be cancelled immediately and the error "Canceled" shall be reported to the gsmSCF. + +Generic error handling for the operation related errors are described in clause 10, the TC services which are used for reporting operation errors are described in clause 14. + +If any of the parameter restrictions are violated (e.g. "minimumNbOfDigits" > "maximumNbOfDigits"), then an operation error has occurred. + +## 11.26 ReleaseCall procedure + +### 11.26.1 General description + +The gsmSCF uses this operation to tear down a call at any phase. + +#### 11.26.1.1 Parameters + +- allCallSegments: +This parameter gives an indication to the gsmSSF about the reason of releasing this specific call. This may be used by gsmSSF for generating specific tones to the different parties in the call or to fill in the "cause" in the release message. +- allCallSegmentsWithExtension: +This parameter gives an indication to the gsmSSF about the reason of releasing this specific call. This may be used by gsmSSF for generating specific tones to the different parties in the call or to fill in the "cause" in the release message. It additionally allows for the sending of the extensions parameter to the gsmSSF. + +### 11.26.2 Responding entity (gsmSSF) + +#### 11.26.2.1 Normal procedure + +gsmSSF preconditions: + +- (1) A control relationship exists between gsmSCF and gsmSSF. +- (2) The gsmSSF FSM is in the state "Waiting\_for\_Instructions" or in the state "Monitoring". + +gsmSSF postconditions: + +- (1) The gsmSSF FSM transits to the state "Idle" after sending any pending "CallInformationReport" or "ApplyChargingReport". All armed EDPs shall be disarmed. All connections and resources related to the call shall be released. + +#### 11.26.2.2 Error handling + +Operation related error handling is not applicable, due to class 4 operation. + +## 11.27 RequestReportBCSMEVENT procedure + +### 11.27.1 General description + +The gsmSCF uses this operation to request the gsmSSF to monitor for a call-related event (e.g., BCSM events such as O\_Busy or O\_No\_Answer) and to send a notification to the gsmSCF when the event is detected. + +The monitoring of more than one event may be requested with a single "RequestReportBCSMEVENT" operation, but each of these requested events will be reported in a separate "EventReportBCSM" operation. + +NOTE: If the RequestReportBCSMEVENT requests arming of the current DP from which the call processing was suspended, then the next occurrence of the DP encountered during BCSM processing will be detected (i.e. not the current one from which the call was suspended). + +The DP arming principle is as follows: + +- The DPs O\_Disconnect and T\_Disconnect can be armed for any or all legs depending on the direction for which events have to be captured. As an example, the O\_Disconnect DP can be armed for leg1 and leg2; in this case, if a release request is received from the A-party, then it will be detected by the O\_Disconnect DP armed for leg1, while a release request from the B-party will be detected by the O\_Disconnect DP armed for leg2. +- The O\_Abandon DP can be armed only for leg1 in the O-BCSM and the T\_Abandon DP can be armed only for leg1 in the T-BCSM. + +- The Collected\_Info DP can be armed only for leg1 in the O-BCSM for TO calls. + +**Table 11-1: DP Arming Table for O-BCSM:** + +| O-BCSM | leg1 | Not leg 1 | Default leg_ID | +|-------------------------|------|-----------|----------------| +| O_Term_Seized DP | - | X | 2 | +| Route_Select_Failure DP | - | X | 2 | +| O_Busy DP | - | X | 2 | +| O_No_Answer DP | - | X | 2 | +| O_Answer DP | - | X | 2 | +| O_Disconnect DP | X | X | -(note 1) | +| O_Abandon DP | X | - | 1 | +| O_Mid_Call | X | - | 1 | +| O_Change_Of_Position | X | - | 1 | +| O_Service_Change | X | - | 1 | +| Collected_Info DP | X | - | 1 | + +Note 1: The "legID" parameter shall be included +Nomenclature: X = Arming Applicable +- = Arming not Applicable + +**Table 11-2: DP Arming Table for T-BCSM:** + +| T-BCSM | leg2 | leg1 | Default Leg ID | +|----------------------|------|------------|----------------| +| Call_Accepted DP | X | - | 2 | +| T_Busy DP | X | - | 2 | +| T_No_Answer DP | X | - | 2 | +| T_Answer DP | X | - | 2 | +| T_Disconnect DP | X | X | -(note 1) | +| T_Abandon DP | - | X (note 2) | 1 | +| T_Mid_Call | X | - | 2 | +| T_Change_Of_Position | X | - | 2 | +| T_Service_Change | X | - | 2 | + +Note 1: The "legID" parameter shall be included +Note 2: T\_Abandon can be armed for leg1 only. +Nomenclature: X = Arming Applicable +- = Arming not Applicable + +### 11.27.1.1 Parameters + +- bcsmevents: +This parameter specifies the event or events of which a report is requested. + - eventTypeBCSM: +This parameter specifies the type of event of which a report is requested. + - monitorMode: +This parameter indicates how the event shall be reported. If the "monitorMode" is "interrupted", then the event shall be reported as a request; if the "monitorMode" is "notifyAndContinue", then the event shall be reported as a notification; if the "monitorMode" is "transparent", then the event shall not be reported. + - legID: +This parameter indicates the party in the call for which the event shall be reported. The gsmSCF shall use the option "sendingSideID" only. + - sendingSideID: + +If not included, then the default values for LegID are assumed according to the tables 11-1 and 11-2. + +The "legID" parameter shall always be included for the events O\_Disconnect and T\_Disconnect. + +- dPSSpecificCriteria: +This parameter contains information specific to the EDP that shall be armed. + +- **numberOfDigits:** +This parameter indicates the number of digits requested for the CollectedInfo event. +- **interDigitTimeout:** +This parameter indicates the inter-digit timer value for the CollectedInfo event. +- **applicationTimer:** +This parameter indicates the No\_Answer timer value for the No\_Answer event. If the called party does not answer the call within the allotted time, then the gsmSSF shall report the event to the gsmSCF. This timer shall be shorter than the network No\_Answer timer. +- **midCallControlInfo:** +This parameter defines the criterion for the detection and reporting of mid-call digits. If this parameter is absent, then the first digit entered shall be reported. +- **changeOfPositionControlInfo:** +This parameter defines the criterion for the reporting of change of location. If this parameter is absent, then any change of position shall be reported. +- **automaticRearm:** +This parameter indicates that the gsmSSF shall rearm the DP whenever it is encountered. + +## 11.27.2 Responding entity (gsmSSF) + +### 11.27.2.1 Normal procedure + +gsmSSF preconditions: + +- (1) A control relationship exists between the gsmSSF and the gsmSCF. +- (2) The gsmSSF FSM is in the state "Waiting\_for\_Instructions" or in the state "Monitoring". + +NOTE: In the state "monitoring" only requests to disarm detection points (with MonitorMode set to "Transparent") or to send notifications of events (with MonitorMode set to "NotifyAndContinue") shall be accepted by the gsmSSF. + +gsmSSF postconditions: + +- (1) The requested EDPs are armed or disarmed as indicated. +- (2) Previously requested events are monitored until ended by a transparent monitor mode, until the end of the call, until the EDPs are detected or until the corresponding leg is released. +- (3) The gsmSSF FSM remains in the same state, unless all EDPs have been disarmed and no CallInformationReport or ApplyChargingReport has been requested; in the latter case, the gsmSSF FSM transits to the state "Idle". + +### 11.27.2.2 Error handling + +Generic error handling for the operation related errors are described in clause 10 and the TC services which are used for reporting operation errors are described in clause 14. + +## 11.28 ResetTimer procedure + +### 11.28.1 General description + +The gsmSCF uses this operation to refresh the Tssf application timer, in order to avoid the Tssf time-out at the gsmSSF. + +#### 11.28.1.1 Parameters + +- **timerID:** +This parameter indicates which timer shall be reset. The only permissible value of this parameter is "tssf". +- **timerValue:** +This parameter specifies the value to which the timer shall be set. + +- callSegmentID: + +This parameter indicates the Call Segment in the gsmSSF for which the timer shall be reset. + +## 11.28.2 Responding entity (gsmSSF) + +### 11.28.2.1 Normal procedure + +gsmSSF preconditions: + +- (1) Basic call processing has been suspended at a DP. +- (2) The gsmSSF FSM is in the state "Waiting\_for\_Instructions", the state "Waiting\_for\_end\_of\_User\_Interaction" or in the state "Waiting\_for\_end\_of\_Temporary\_Connection". + +gsmSSF postconditions: + +- (1) The Tssf timer is loaded with the value received from the gsmSCF and is restarted. +- (2) No gsmSSF FSM state transition. + +### 11.28.2.2 Error handling + +Generic error handling for the operation related errors are described in clause 10 and the TC services which are used for reporting operation errors are described in clause 14. + +## 11.29 SendChargingInformation procedure + +### 11.29.1 General description + +The gsmSCF uses this operation to instruct the gsmSSF on the Advice of Charge information to be sent by the gsmSSF. The SendChargingInformation operation may be invoked on multiple occasions. + +The SendChargingInformation operation may be used for MO and MT calls in the VMSC. In the case of an MT call, the CSE provided e-parameters are not used by Mobile Station if a call forwarding or follow-on call occurs. + +#### 11.29.1.1 Parameters + +- sCIBillingChargingCharacteristics: +This parameter is a choice between two lists of information. + +The first list shall be sent only if there is neither an active call leg, nor a Temporary Connection, nor a connection to a gsmSRF. It contains the following parameters: + +- aOCBeforeAnswer: +This is a list of the following information: + - aOCInitial: +This is a set of Charge Advice Information (CAI) elements, as defined in 3GPP TS 22.024 [2]. These CAI elements shall be sent by the gsmSSF to the MS when Answer is detected and a tariff switch for the "CSE control of e-parameters" has not yet occurred. + - aOCSubsequent: +This list may contain the following information: + - cAIElements: +This is a set of Charge Advice Information (CAI) elements, as defined in 3GPP TS 22.024 [2]. These CAI elements shall be sent to the MS when Answer is detected and a tariff switch for the "CSE control of e-parameters" has occurred previously, or when Answer has previously been detected and a tariff switch for the "CSE control of e-parameters" occurs. + - tariffSwitchInterval (for the "CSE control of e-parameters"): +This parameter indicates the time duration until the next tariff switch for the "CSE control of e-parameters". The measurement of the elapsed tariff switch period shall start immediately after successful execution of this operation. + +The second list in the choice shall be sent only if there is an active call leg or a Temporary Connection or a connection to a gsmSRF. It contains the following parameters: + +-aOCAfterAnswer: + +This list may contain the following information: + +- cAIElements: + +This is a set of Charge Advice Information (CAI) elements, as defined in 3GPP TS 22.024 [2]. These CAI elements shall be sent to the MS by the gsmSSF when Answer is detected and a tariff switch for the "CSE control of e-parameters" has occurred previously, or when Answer has previously been detected and a tariff switch for the "CSE control of e-parameters" occurs. + +- tariffSwitchInterval (for the "CSE control of e-parameters"): + +This parameter indicates the time duration until the next tariff switch for the "CSE control of e-parameters". The measurement of the elapsed tariff switch period shall start immediately after successful execution of this operation. + +- legID: + +This parameter indicates where the charging information shall be sent. For Mobile Originated calls, only leg 1 shall be used. For Mobile Terminated calls in the VMSC, only the leg of the CAMEL subscriber shall be used. + +## 11.29.2 Responding entity (gsmSSF) + +### 11.29.2.1 Normal procedure + +gsmSSF preconditions: + +(1) The gsmSSF FSM is in one of the following states: + +"Waiting\_for\_Instructions"; or +"Waiting\_for\_end\_of\_User\_Interaction"; or +"Waiting\_for\_end\_of\_Temporary\_Connection"; or +"Monitoring". + +gsmSSF postconditions: + +(1) No gsmSSF FSM state transition. + +On receipt of this operation the gsmSSF performs actions to send the Advice of Charge information to the indicated Call Partys MS. + +If Advice of Charge shall be provided to a MS in conjunction with "CSE control of call duration", then the following sequence of operations may be sent by the gsmSCF to the gsmSSF in the following order, in the same TC-CONTINUE TC message: + +one or more ApplyCharging operations; SendChargingInformation operation. + +These operations shall be processed sequentially by the gsmSSF, in the order that they are sent by the gsmSCF. In this case, the parameters TariffSwitchInterval (for the "CSE control of call duration") may be present in any of the ApplyCharging operations and the parameter TariffSwitchInterval (for the "CSE control of e-parameters") may be present in the SendChargingInformation operation. + +The TariffSwitchInterval information received with the ApplyCharging operation shall set or overwrite the tariff switch timer for the "CSE control of call duration" in the gsmSSF and this duration timer shall run from the time of successful operation execution. + +The TariffSwitchInterval information received in the SendChargingInformation operation shall set or overwrite the tariff switch timer for the "CSE control of e-parameters" in the gsmSSF and this duration timer shall run from the time of successful operation execution. + +### 11.29.2.2 Error handling + +Generic error handling for the operation related errors are described in clause 10 and the TC services which are used for reporting operation errors are described in clause 14. + +## 11.30 SpecializedResourceReport procedure + +### 11.30.1 General description + +The gsmSRF uses this operation as a response to a "PlayAnnouncement" operation or a "PromptAndCollectUserInformation" operation. This operation shall be used only when the "requestAnnouncementCompleteNotification" parameter is TRUE or the "requestAnnouncementStartedNotification" parameter is TRUE in the "PlayAnnouncement" operation or the "PromptAndCollectUserInformation" operation. + +#### 11.30.1.1 Parameters + +- allAnnouncementsComplete: +This parameter indicates that all the announcements and tones are complete. +- firstAnnouncementStarted: +This parameter indicates that the first announcement or tone has started. + +### 11.30.2 Invoking entity (gsmSRF) + +#### 11.30.2.1 Normal procedure + +gsmSRF preconditions: + +- (1) The gsmSRF FSM is in the state "User\_Interaction". +- (2) Either: + - (i) The sending of announcements and tones as defined in the "PlayAnnouncement" operation or the "PromptAndCollectUserInformation" operation has started and the parameter "RequestAnnouncementStartedNotification" in the "PlayAnnouncement" or "PromptAndCollectUserInformation" operation is TRUE; or + - (ii) A "PlayAnnouncement" operation has been executed, all announcements and tones have been sent and the parameter "RequestAnnouncementCompleteNotification" in the "PlayAnnouncement" operation is TRUE. + +gsmSRF postconditions: + +- (1) No gsmSRF FSM state transition. +- (2) If the "DisconnectFromIPForbidden" parameter is FALSE, then the gsmSRF initiates a bearer channel disconnect sequence to the gsmSSF using the applicable bearer channel signalling system after sending the "SpecializedResourceReport" operation to the gsmSCF. The gsmSRF transits to the state "Idle". + +#### 11.30.2.2 Error handling + +Operation related error handling is not applicable, due to class 4 operation. + +## 11.31 SplitLeg Procedure + +### 11.31.1 General Description + +The gsmSCF uses this operation to request the gsmSSF to separate one party from the source Call Segment and place it in a new target Call Segment. + +#### 11.31.1.1 Parameters + +- legToBeSplit: +This parameter indicates the party in the call to be split from the source Call Segment. +- newCallSegment: +This parameter indicates the CSID to be assigned to the newly-created Call Segment. + +## 11.31.2 Responding entity (gsmSSF) + +### 11.31.2.1 Normal procedure + +gsmSSF preconditions: + +- 1) A control relationship exists between the gsmSCF and the gsmSSF. +- 2) The CSID1 is either the source Call Segment or the target Call Segment. +- 3) When SplitLeg is used to move a leg into CSID1 (when CSID1 does not exist), then the BCSM for the leg to be split shall be in the alerting phase or in the active phase. + +When SplitLeg is used to split a leg off from CSID1 into a new Call Segment, then the BCSM for the leg to be split shall be in the active phase. + +- 4) User interaction is not in progress in the source Call Segment. + +gsmSSF postconditions: + +- 1) The gsmSSF performs the necessary actions to separate the specified leg from its original Call Segment and place it in a new target Call Segment. +- 2) The CS\_gsmSSF FSM for the new Call Segment transits to the state "Waiting\_for\_Instructions". +- 3) The CS\_gsmSSF FSM for the source Call Segment transits to the state "Waiting\_for\_Instructions". +- 4) The remaining BCSM instances within the source Call Segment transit to the O\_Mid\_Call DP or to the T\_Mid\_Call DP, unless already suspended at a DP. The Mid\_Call EDP shall not be reported for this case. +- 5) A Return Result shall be sent to the gsmSCF immediately after successful execution of this operation. +- 6) A pending ApplyChargingReport for the source call segment shall be sent to the gsmSCF. + +### 11.31.2.2 Error handling + +Generic error handling for the operation related errors is described in clause 10, and the TC services which are used for reporting operation errors are described in clause 14. + +--- + +## 12 Detailed operation procedures for SMS control + +- NOTE: For Short Message processing in a Circuit Switched network, the CAMEL interaction with SMS is done through the MSC/smsSSF. +For Short Message processing in a Packet Switched network, the CAMEL interaction with SMS is done through the SGSN/smsSSF. + +Any reference to the smsSSF applies to both the smsSSF co-located with the MSC and the smsSSF co-located with the SGSN. + +- NOTE Where a parameter for an SMS control Operation is marked OPTIONAL in ASN.1, the reader is referred to the conditions for presence for this parameter, specified in the respective Information Flow in 3GPP TS 23.078 [7]. + +## 12.1 ConnectSMS procedure + +### 12.1.1 General description + +The gsmSCF uses this operation to request the smsSSF to continue Short Message processing, such as routeing a Short Message to a specific destination or delivering a Short Message to the served subscriber, with modified information. + +### 12.1.1.1 Parameters + +- callingPartyNumber: +This parameter allows the gsmSCF to set the Calling Party Number parameter used in the network. It is used for showing the sending party's id (i.e. the originating address) to the receiving party. +- destinationSubscriberNumber: +This parameter contains the destination address to which the Short Message shall be routed by the SMSC. +- smscAddress: +This parameter contains the Short Message Service Centre address towards which the Short Message shall be routed. + +## 12.1.2 Responding entity (smsSSF) + +### 12.1.2.1 Normal procedure + +smsSSF preconditions: + +- (1) Mobile originating Short Message submission or Mobile terminating Short Message delivery attempt has been initiated. +- (2) Short Message processing has been suspended at the DP SMS\_Collected\_Info or at DP SMS\_Delivery\_Requested. +- (3) The smsSSF FSM is in the state "Waiting\_for\_Instructions". + +smsSSF postconditions: + +- (1) The smsSSF performs the Short Message processing actions to route the Short Message to the specified destination or to deliver the Short Message to the served subscriber. + +On receipt of this operation, the smsSSF performs the following actions: + +- if the callingPartyNumber, destinationSubscriberNumber or smscAddress are supplied, then these values shall be used for subsequent processing; +- if no EDPs have been armed, then the smsSSF FSM transits to the state "Idle". Otherwise, the smsSSF FSM transits to the state "Monitoring". + +The smsSSF shall not perform any implicit arming or disarming of DPs. + +Statistic counter(s) are not affected. + +### 12.1.2.2 Error handling + +Generic error handling for the operation related errors is described in clause 10 and the TC services which are used for reporting operation errors are described in clause 14. + +## 12.2 ContinueSMS procedure + +### 12.2.1 General description + +The gsmSCF uses this operation to request the smsSSF to proceed with processing at the DP at which it previously suspended processing to await gsmSCF instructions. The smsSSF continues processing without substituting new data from the gsmSCF. + +### 12.2.1.1 Parameters + +None. + +## 12.2.2 Responding entity (smsSSF) + +### 12.2.2.1 Normal procedure + +smsSSF preconditions: + +- (1) processing has been suspended at any DP. +- (2) The smsSSF FSM is in the state "Waiting\_for\_Instructions". + +smsSSF postconditions: + +- (1) processing continues. +- (2) The smsSSF FSM is in one of the following states: + - State "Monitoring" because at least one EDP was armed; or + - State "Idle" because no EDPs were armed. + +### 12.2.2.2 Error handling + +Operation related error handling is not applicable, due to class 4 operation. + +## 12.3 EventReportSMS procedure + +### 12.3.1 General description + +The smsSSF uses this operation to notify the gsmSCF of a short message related event previously requested by the gsmSCF in a RequestReportSMSEvent operation. + +#### 12.3.1.1 Parameters + +- eventTypeSMS: +This parameter identifies the type of event that is reported. +- eventSpecificInformationSMS: +This parameter contains the Short Message related information specific to the event. + - For O\_SMS\_Failure it shall contain the O-SMSCause, if available. + - For T\_SMS\_Failure it shall contain the T-SMSCause, if available. + - For O\_SMS\_Submitted and for T\_SMS\_Delivery it shall be empty. +- miscCallInfo: +This parameter contains DP related information. + - messageType: +This parameter indicates whether the message is a request, i.e. resulting from a RequestReportSMSEvent with "monitorMode" = "interrupted", or a notification, i.e. resulting from a RequestReportSMSEvent with "monitorMode" = "notifyAndContinue". + +### 12.3.2 Invoking entity (smsSSF) + +#### 12.3.2.1 Normal procedure + +smsSSF preconditions: + +- (1) The smsSSF FSM is in the state "Monitoring"; +- (2) The smsSSF FSM proceeds to an EDP that is armed. + +smsSSF postconditions: + +- (1) The smsSSF has applied implicit disarming of EDPs. +- (2) If message type was notification and there are no more EDPs armed, then the smsSSF FSM transits to the state "Idle". Otherwise, the smsSSF FSM transits to the state "Waiting\_for\_Instructions". + +### 12.3.2.2 Error handling + +Operation related error handling is not applicable, due to class 4 operation. + +## 12.4 FurnishChargingInformationSMS procedure + +### 12.4.1 General description + +The gsmSCF uses this operation to send charging related information to a Logical SMS record. This Logical SMS record is CAMEL specific. The first FurnishChargingInformationSMS operation leads to the generation of a Logical SMS record. Receipt of subsequent FurnishChargingInformationSMS operations shall overwrite or append the contents of the Logical SMS record. + +#### 12.4.1.1 Parameters + +- fCISMSBillingChargingCharacteristics: +This parameter contains the following parameters; +- fCIBCCCAMELsequence1: +This parameter contains the following parameters; +- freeFormatData: +This parameter contains free-format billing and/or charging characteristics. +- appendFreeFormatData: +This parameter indicates whether previous free-format data shall be appended or overwritten. See 3GPP TS 23.078 [7] for details. + +### 12.4.2 Responding entity (smsSSF) + +#### 12.4.2.1 Normal procedure + +smsSSF preconditions: + +- (1) The smsSSF FSM is in the state "Waiting\_for\_Instructions". + +smsSSF postconditions: + +- (1) No smsSSF FSM state transition. + +On receipt of this operation, the smsSSF performs actions to create the Logical SMS record, if a Logical SMS record does not already exist, and writes the free-format information carried in the operation into the Logical SMS record. Subsequent FurnishChargingInformationSMS operations received, by default, will overwrite the free-format data previously written in the Logical SMS record, as specified in 3GPP TS 23.078 [7]. It is also possible to append free format data with subsequent FurnishChargingInformationSMS operations. + +The Logical SMS records will be associated for a given Short Message submission or Short Message delivery with one or more physical CDRs, as specified in 3GPP TS 32.250 [13], 3GPP TS 32.251 [14] and 3GPP TS 22.115 [4]. + +#### 12.4.2.2 Error handling + +Generic error handling for the operation related errors is described in clause 10 and the TC services which are used for reporting operation errors are described in clause 14. + +## 12.5 InitialDPSMS procedure + +### 12.5.1 General description + +The smsSSF uses this operation after detection of a TDP-R in the smsSF FSM, to request the gsmSCF for instructions to complete the Short Message submission to the SMSC or the Short Message delivery to the served subscriber. + +#### 12.5.1.1 Parameters + +- destinationSubscriberNumber: +This parameter carries the ISDN number of the entity receiving the short message or the destination address of the destination subscriber, in an MO-SMS procedure. +- callingPartyNumber: +In an MO-SMS procedure, this parameter carries the MSISDN of the subscriber. In an MT-SMS procedure, this parameter carries the address of the submitter of the short message (i.e. the originating address). +- eventType: +This parameter indicates the armed smSSF FSM DP, resulting in the InitialDPSMS operation. +- iMSI: +IMSI of the mobile subscriber for whom the CAMEL service is invoked. +- locationInformationInMSC: +This parameter indicates the location of the MSC of the served subscriber. This parameter shall be included only if the InitialDP operation is sent from the MSC. +- locationInformationInSGSN: +This parameter indicates the location of the SGSN of the served subscriber. This parameter shall be included only if the InitialDPSMS operation is sent from the SGSN. +- serviceKey: +This parameter indicates to the gsmSCF the requested IN service. It is used to address the required application/SLP within the gsmSCF; it is not for gsmSCF addressing. +- timeAndTimeZone: +This parameter contains the time that the smsSSF was triggered, and the time zone that the invoking smsSSF resides in. +- tPDataCodingScheme: +This parameter indicates the data coding scheme of the TP-User-Data element within the TPDU. It may indicate a message class. The message class may indicate e.g. the originator of the Short Message. +- tPShortMessageSpecificInfo: +This parameter contains the 1st octet of the TPDU. Refer to 3GPP TS 23.040 [6] for a description of the various TPUDUs. +- tPProtocolIdentifier: +This parameter indicates the protocol used above the SM-Transfer Layer. +- tPValidityPeriod: +This parameter indicates the length of the validity period or the absolute time of the validity period termination. +- sMSCAddress: +This parameter defines the address of the SMSC to which the Short Message is intended to be submitted. +- smsReferenceNumber: +This parameter contains the SMS Reference Number assigned to the Short Message by the MSC or SGSN. +- mscAddress: +This parameter contains the E.164 address of the MSC. It shall be present if the SMS processing takes place in the MSC; otherwise shall be absent. + +- **sgsn-Number:** +This parameter contains the Global Title of the SGSN. It shall be present if the SMS processing takes place in the SGSN; otherwise it shall be absent. +- **ms-Classmark2:** +This parameter contains the MS Classmark 2 of the mobile subscriber for which the service is invoked. +- **gPRSMSCClass:** +This parameter contains the GPRS MS capabilities of the mobile subscriber for which the CAMEL service is invoked. +- **iMEI:** +This parameter contains the IMEI (with software version) of the mobile subscriber for which the service is invoked. +- **calledPartyNumber:** +This parameter indicates the served subscriber in an MT-SMS procedure. + +## 12.5.2 Invoking entity (smsSSF) + +### 12.5.2.1 Normal procedure + +smsSSF preconditions: + +- (1) A Short Message submission attempt or a Short Message delivery attempt has been initiated. +- (2) An event has been detected at a DP. +- (3) For MT-SMS, the event fulfilled the criteria for the DP being executed. + +smsSSF postconditions: + +- (1) A control relationship has been established and the smsSSF waits for instructions from the gsmSCF. + +The address of the gsmSCF the InitialDPSMS operation shall be sent to, shall be fetched from the MO-SMS-CSI or the MT-SMS-CSI. The smsSSF shall provide all available parameters to the gsmSCF. + +A control relationship is established with the gsmSCF. The smsSSF application timer Tssf is laded with the deafult value and is started. It is used to prevent excessive Short Message submission or delivery suspension time. + +### 12.5.2.2 Error handling + +If the gsmSCF is not accessible, then the smsSSF instructs the MSC or SGSN to proceed with the Short Message processing in accordance with the Default SMS Handling parameter of the MO-SMS-CSI or MT-SMS-CSI. + +If Tssf expires, then the smsSSF aborts the interaction with the gsmSCF by means of an abort to TC and shall instruct the MSC or SGSN to proceed with the Short Message processing in accordance with the Default SMS Handling parameter of the MO-SMS-CSI CSI or MT-SMS-CSI. + +In the case of an MO-SMS Service, if the sending mobile party abandons after the sending of InitialDPSMS and before the TC dialogue is established, then the smsSSF shall abort the interaction with the gsmSCF by means of an abort to TC. + +Generic error handling for the operation related errors is described in clause 10 and the TC services which are used for reporting operation errors are described in clause 14. + +## 12.6 ReleaseSMS procedure + +### 12.6.1 General description + +The gsmSCF uses this operation to tear down a Short Message submission attempt or Short Message delivery attempt. The operation may be sent within a control relationship only; it is not allowed in a monitor relationship. + +#### 12.6.1.1 Parameters + +- rPCause: +This parameter gives an indication to the smsSSF about the reason of releasing this specific Short Message. For a MO-SMS Service, the rPCause shall be sent to the served subscriber in the RP-ERROR RPDU. For a MT-SMS Service, the rPCause shall be sent to the SMS-GMSC in the RP-ERROR RPDU. + +### 12.6.2 Responding entity (smsSSF) + +#### 12.6.2.1 Normal procedure + +smsSSF preconditions: + +- (1) The smsSSF FSM is in the state "Waiting\_for\_Instructions". +- (2) The FSM is in DP SMS\_Collected\_Info or in DP SMS\_Delivery\_Requested. + +smsSSF postconditions: + +- (1) The smsSSF FSM transits to the state "Idle". All armed EDPs shall be disarmed. All resources in the MSC or SGSN related to the Short Message shall be released. + +#### 12.6.2.2 Error handling + +Operation related error handling is not applicable, due to class 4 operation. + +## 12.7 RequestReportSMSEvent procedure + +### 12.7.1 General description + +The gsmSCF uses this operation to request the smsSSF to monitor for a Short Message related event (FSM events such as failure, delivery or submission) and to send a notification to the gsmSCF when the event is detected. + +The monitoring of more than one event may be requested with a single RequestReportSMSEvent operation, but each of these requested events will be reported in a separate EventReportSMS operation. + +#### 12.7.1.1 Parameters + +- smsEvents: +This parameter indicates the event or events of which a report is requested. + - eventTypeSMS: +This parameter indicates the type of event of which a report is requested. Values SMSCollectedInfo and SMSDeliveryRequested are not valid for the RequestReportSMSEvent operation. + - monitorMode: +This parameter indicates how the event shall be reported. When the "monitorMode" is "interrupted", the event shall be reported as a request, if the "monitorMode" is "notifyAndContinue", the event shall be reported as a notification, if the "monitorMode" is "transparent", then the event shall not be reported. + +### 12.7.2 Responding entity (smsSSF) + +#### 12.7.2.1 Normal procedure + +smsSSF preconditions: + +- (1) A control relationship exists between the smsSSF and the gsmSCF. +- (2) The smsSSF FSM is in the state "Waiting\_for\_Instructions". + +smsSSF postconditions: + +- (1) The requested EDPs have been armed or disarmed as indicated. +- (2) Armed events are monitored until ended by a transparent monitor mode, until the occurrence of the event or until the implicit disarming of the event. +- (3) No smsSSF FSM state transition. + +### 12.7.2.2 Error handling + +Generic error handling for the operation related errors is described in clause 10 and the TC services which are used for reporting operation errors are described in clause 14. + +## 12.8 ResetTimerSMS procedure + +### 12.8.1 General description + +The gsmSCF uses this operation to refresh the Tssf application timer, in order to prevent Tssf expiry at the smsSSF. + +#### 12.8.1.1 Parameters + +- timerID: +This parameter indicates which timer shall be reset. The only permissible value of this parameter is "tssf". +- timerValue: +This parameter defines the value to which the timer shall be set. + +### 12.8.2 Responding entity (smsSSF) + +#### 12.8.2.1 Normal procedure + +smsSSF preconditions: + +- (1) Short Message processing has been suspended at a DP. +- (2) The smsSSF FSM is in the state "Waiting\_for\_Instructions". + +smsSSF postconditions: + +- (1) The Tssf timer is loaded with the value received from the gsmSCF and is restarted. +- (2) No smsSSF FSM state transition. + +#### 12.8.2.2 Error handling + +Generic error handling for the operation related errors are described in clause 10 and the TC services which are used for reporting operation errors are described in clause 14. + +--- + +## 13 Detailed operation procedures for GPRS control + +NOTE Where a parameter for a GPRS control Operation is marked OPTIONAL in ASN.1, the reader is referred to the conditions for presence for this parameter, specified in the respective Information Flow in 3GPP TS 23.078 [7]. + +## 13.1 ActivityTestGPRS procedure + +### 13.1.1 General description + +The gsmSCF uses this operation to check for the continued existence of a relationship between the gsmSCF and the gprsSSF. If the relationship is still in existence, then the identified instance of gprsSSF will respond. If the ActivityTestGPRS operation timer expires, then the gsmSCF will assume that the receiving entity has failed in some way and will take appropriate action. This operation opens a new SS7 dialogue between gsmSCF and gprsSSF. + +#### 13.1.1.1 Parameters + +None. + +### 13.1.2 Responding entity (gprsSSF) + +#### 13.1.2.1 Normal procedure + +gprsSSF preconditions: + +- (1) A relationship exists between the gsmSCF and the gprsSSF. +- (2) The gprsSSME FSM is in the state "Idle Management". +- (3) No active TC dialogue exists at the moment of receiving ActivityTestGPRS. + +gprsSSF postconditions: + +- (1) The gprsSSME FSM transits to the state "Non-call Associated Treatment". +- (2) If there is a gprsSSF using the GPRS-Reference Number, then the gprsSSME FSM sends a Return Result "ActivityTestGPRS" to the gsmSCF. The gprsSSME FSM then returns to the state "Idle Management". + +If there is no gprsSSF using the GPRS-ReferenceNumber, then the gprsSSME FSM will issue a U-Abort. The gprsSSME FSM then returns to the state "Idle Management". + +- (3) The temporary TC dialogue is closed. + +If at the time of receiving ActivityTestGPRS there is an active TC dialogue for this GPRS Dialogue, then the gprsSSME FSM issues a U-Abort with Abort reason "overlapping-dialogue". + +#### 13.1.2.2 Error handling + +Generic error handling for the operation related errors is described in clause 10 and the TC services used for reporting operation errors are described in clause 14. + +## 13.2 ApplyChargingGPRS procedure + +### 13.2.1 General description + +The gsmSCF uses this operation for interacting with the gprsSSF function "CSE control of GPRS session or PDP Context duration and volume". The ApplyChargingGPRSReport operation provides the feedback from the gprsSSF to the gsmSCF. The charging scenarios supported by this operation are those given in 3GPP TS 22.078 [3] for "CSE control of GPRS session and PDP Context duration and volume". + +If this procedure is used within a PDP Context dialogue, then the charging instruction shall pertain to the PDP Context only. Data volume threshold and duration threshold may be defined separately. + +If this procedure is used within a GPRS Session dialogue, then the charging instruction may pertain to the GPRS Session or to a single PDP Context. Charging for a PDP Context may be on duration and/or volume. Charging for a GPRS Session may be on duration only. + +NOTE: Charging for a PDP Context on duration and volume requires two ApplyChargingGPRS operations. + +### 13.2.1.1 Parameters + +- **chargingCharacteristics:** +This parameter is a choice between parameters required for "CSE control of a GPRS session or a PDP Context duration or volume": + - **maxTransferredVolume:** +This parameter specifies the maximum volume that may be transferred before a ApplyChargingReportGPRS shall be sent to the gsmSCF. + - **maxElapsedTime:** +This parameter specifies the maximum period of time before a ApplyChargingReportGPRS shall be sent to the gsmSCF. +- **tariffSwitchInterval:** +This parameter indicates the time duration until the next tariff switch. The measurement of the elapsed tariff switch period shall start immediately after successful execution of this operation. +- **pDPID:** +This parameter identifies the PDP Context, within the GPRS Session dialogue, to which the charging instruction applies. + +## 13.2.2 Responding entity (gprsSSF) + +### 13.2.2.1 Normal procedure + +gprsSSF preconditions: + +- (1) A control relationship exists between the gsmSCF and the GPRS Session or PDP Context to which the operation applies. +- (2) The gprsSSF FSM is in one of the following states: "Waiting\_for\_Instructions" or "Monitoring". + +gprsSSF postconditions: + +- (1) No gprsSSF FSM state transition. + +On receipt of this operation, the gprsSSF shall set the charging data using the information elements included in the operation. + +### 13.2.2.2 Error handling + +"TaskRefused": In addition to the generic error handling noted below, this error shall be indicated when: + +- a previously received GPRS Session or PDP Context period or volume duration is pending; +- a tariffSwitchInterval is indicated when a previously received tariffSwitchInterval is pending; +- the gprsSSF has received an ApplyChargingGPRS operation for a PDP Context that is already disconnected; +- the gprsSSF has received an ApplyChargingGPRS operation for the GPRS Session when the subscriber is already detached. + +Generic error handling for the operation related errors is described in clause 10 and the TC services used for reporting operation errors are described in clause 14. + +## 13.3 ApplyChargingReportGPRS procedure + +### 13.3.1 General description + +The gprsSSF uses this operation to report charging related information to the gsmSCF as requested by the gsmSCF using the ApplyChargingGPRS operation. + +Timing of duration and measuring of transferred data (if applicable) shall be started when either an Attach, PDP Context Establishment Acknowledgement or an Inter SGSN Routeing Area Update acceptance is detected by the gprsSSF. + +A report shall be made when a PDP Context Disconnect, a Detach or a Change in QoS is detected by the gprsSSF or when the gprsSSF detects that the transferred volume or elapsed time duration indicated in the parameter "transferredVolume" or "elapsedTime" (received in ApplyChargingGPRS operation) has been reached. ApplyChargingReportGPRS shall be sent only on chargeable QoS changes. + +### 13.3.1.1 Parameters + +- **chargingResult:** + +This parameter provides the gsmSCF with the charging related information previously requested using the ApplyChargingGPRS operation. The "ChargingResult" is a choice, and can contain either of the following parameters: + +- **transferredVolume:** + +This is a choice of the following parameters: + +- **volumeIfNoTariffSwitch:** + +This parameter shall be present if no tariff switch has occurred for the PDP Context, otherwise it shall be absent. If present, then the volume transferred since the detection of the event that triggered volume count shall be reported. + +- **volumeIfTariffSwitch:** + +This parameter shall be present if a tariff switch has occurred for the PDP Context, otherwise it shall be absent. This parameter may contain the following information: + +- **volumeSinceLastTariffSwitch:** + +The volume since the detection of the event that triggered volume count or the last tariffSwitch (whichever of these events was last detected) shall be reported. + +- **VolumeTariffSwitchInterval:** + +This parameter shall be present only if a tariff switch was detected after the event that triggered volume count for the PDP Context in the current volume count period. If present, the volume between either the detection the event that triggered volume count or the previous tariff switch (whichever of these events was last detected) and the last tariff switch shall be reported. + +- **elapsedTime:** + +This parameter is a choice of the following parameters: + +- **timeGPRSIfNoTariffSwitch:** + +This parameter shall be present if no tariff switch has occurred for the GPRS Session or the PDP Context, otherwise it shall be absent. If present, then the elapsed time since the detection of the event that triggered time count shall be reported. + +- **timeGPRSIfTariffSwitch:** + +This parameter shall be present if a tariff switch has occurred for the GPRS Session or the PDP Context, otherwise it shall be absent. This parameter may contain the following information: + +- **timeGPRSSinceLastTariffSwitch:** + +The time since the event that triggered time count or the last tariffSwitch shall be reported. + +- **timeGPRSTariffSwitchInterval:** + +This parameter shall be present only if a tariff switch was detected after the event that triggered time count for the GPRS Session or PDP Context in the current time count period. If present, then the time between either the detection the event that triggered time count or the previous tariff switch (whichever of these events was last detected) and the last tariff switch shall be reported. + +- **qualityOfService:** + +This parameter identifies the QoS which was negotiated between the user, the SGSN and the GGSN. + +This parameter shall be present only if the sending of the ApplyChargingReportGPRS operation was triggered by a change in Quality of Service. The "negotiated-QoS-Extension" may be present as a supplement to the "negotiated-QoS". + +- active: +This parameter indicates whether the GPRS Session or PDP Context is still active +- pDPID: +This parameter identifies the PDP Context, within the GPRS Session dialogue, for which the charging report is valid. +- chargingRollOver: +This parameter indicates possible rollovers of the "ChargingResult" parameter due to the limited value ranges of the associated charging parameters. The "chargingRollOver" parameter is a choice and may contain either of the following parameters: + - transferredVolumeRollOver: +This parameter is a choice of the following parameters: + - rO-VolumeIfNoTariffSwitch: +This parameter indicates how many times the volumeIfNoTariffSwitch parameter of the chargingResult has rolled over. If no rollover has happened, then rO-VolumeIfNoTariffSwitch may be absent. + - rO-VolumeIfTariffSwitch: +This parameter is present if at least one of the parameters below is present. It may contain the following information: + - rO-VolumeSinceLastTariffSwitch: +This parameter indicates how many times the volumeSinceLastTariffSwitch parameter of the chargingResult has rolled over. If no rollover has happened, then rO-VolumeSinceLastTariffSwitch may be absent. + - rO-VolumeTariffSwitchInterval: +This parameter indicates how many times the VolumeTariffSwitchInterval parameter of the chargingResult has rolled over. If no rollover has happened, then rO-VolumeTariffSwitchInterval may be absent. + - elapsedTimeRollOver: +This parameter is a choice of the following parameters: + - rO-TimeGPRSIfNoTariffSwitch: +This parameter indicates how many times the timeGPRSIfNoTariffSwitch parameter of the chargingResult has rolled over. If no rollover has happened, then rO-TimeGPRSIfNoTariffSwitch may be absent. + - rO-TimeGPRSIfTariffSwitch: +This parameter shall be present if at least one of the parameters below is present. If It may contain the following information: + - rO-TimeGPRSSinceLastTariffSwitch: +This parameter indicates how many times the timeGPRSSinceLastTariffSwitch parameter of the chargingResult has rolled over. If no rollover has happened, then rO-TimeGPRSSinceLastTariffSwitch may be absent. + - rO-TimeGPRSTariffSwitchInterval: +This parameter indicates how many times the timeGPRSTariffSwitchInterval parameter of the chargingResult has rolled over. If no rollover has happened, then rO-TimeGPRSTariffSwitchInterval may be absent. + +## 13.3.2 Invoking entity (gprsSSF) + +### 13.3.2.1 Normal procedure + +gprsSSF preconditions: + +- (1) A relationship exists between the gsmSCF and the GPRS Session or PDP Context. +- (2) A charging event has been detected that was requested by the gsmSCF via an ApplyChargingGPRS operation. + +gprsSSF postconditions: + +- (1) If termination of the GPRS Session or a PDP Context has occurred, then: + - If the sending of ApplyChargingReportGPRS is directly followed by the reporting of an EDP-R, then the gprsSSF FSM shall transit to the state "Waiting\_for\_Instructions"; else + - If there are any armed EDPs or pending reports, then the gprsSSF FSM shall remain in the same state; else + - If there are no armed EDPs or pending reports, then the gprsSSF FSM shall transit to the state "Idle". +- (2) If the sending of ApplyChargingReportGPRS is due to a timer or counter expiry, then: + - If there are any armed EDPs or pending reports, then the gprsSSF FSM shall remain in the same state; else + - If there are no armed EDPs or pending reports, then the gprsSSF FSM shall transit to the state "Idle". +- (3) If the sending of ApplyChargingReportGPRS is due to a change in QoS of a PDP Context, then: + - The gprsSSF FSM shall remain in the same state. + +### 13.3.2.2 Error handling + +If the operation timer expires, then the gprsSSF shall abort the TC dialogue, terminate the GPRS dialogue and instruct the SGSN to handle the GPRS session or PDP context in accordance with the default GPRS handling parameter of the valid CSI. + +Generic error handling for the operation related errors is described in clause 10 and the TC services used for reporting operation errors are described in clause 14. + +## 13.4 CancelGPRS procedure + +### 13.4.1 General description + +The gsmSCF uses this operation to request the gprsSSF to disarm all pending EDPs and to cancel all pending reports for a GPRS Session or for a specific PDP Context. This enables the gprsSSF FSM to transit to the state "Idle". This procedure can not be used to cancel a previous operation. + +#### 13.4.1.1 Parameters + +- pDPID: +This parameter identifies the PDP Context, within the GPRS Session dialogue, for which the armed EDPs shall be disarmed and the pending reports shall be cancelled. + +### 13.4.2 Responding entity (gprsSSF) + +#### 13.4.2.1 Normal procedure + +gprsSSF preconditions: + +- (1) The gprsSSF FSM is in the state "Waiting\_for\_Instructions" or in the state "Monitoring". + +gprsSSF postconditions: + +- (1) All pending ApplyChargingReportGPRS are cancelled and all pending EDPs are disarmed. If a PDPID is included in the operation, then the cancelling of the pending reports and the disarming of the armed events applies to the indicated PDP Context only. +- (2) If the gprsSSF FSM was in the state "Monitoring" and there are no more armed EDPs or pending ApplyChargingReportsGPRS, then the gprsSSF FSM shall transit to the state "Idle". + +If the gprsSSF FSM was in the state "Waiting\_for\_Instructions", it shall remain in that state. If there are no more armed EDPs or pendingApplyChargingReportsGPRS, then subsequent GPRS Session or PDP Context processing operation will result in the gprsSSF FSM to transit the state "Idle". + +The GPRS Session or PDP Context to which the CancelGPRS operation applies, if in active state, shall further be treated by the gprsSSF autonomously as a normal (non-CAMEL) GPRS Session or PDP Context. + +### 13.4.2.2 Error handling + +Generic error handling for the operation related errors is described in clause 10 and the TC services which are used for reporting operation errors are described in clause 14. + +## 13.5 ConnectGPRS procedure + +### 13.5.1 General description + +The gsmSCF uses this operation to provide an APN to the gprsSSF, to be used for establishing a PDP Context. + +#### 13.5.1.1 Parameters + +- accessPointName: +This parameter contains the Access Point Name towards which the PDP Context shall be established. Refer to 3GPP TS 29.060 [12] for details on the Access Point Name. +- pDPID: +This parameter identifies the PDP Context, within the GPRS Session dialogue, for which the Access Point Name shall be used. + +### 13.5.2 Responding entity (gprsSSF) + +#### 13.5.2.1 Normal procedure + +gprsSSF preconditions: + +- (1) A control relationship exists between the gsmSCF and the PDP Context. +- (2) The GPRS PDP Context FSM is suspended at DP PDP\_Context\_Establishment. +- (3) The gprsSSF FSM is in the state "Waiting\_for\_Instructions". + +gprsSSF postconditions: + +- (1) The gprsSSF performs the actions to establish the PDP Context using the given Access Point Name. +- (2) The gprsSSF stops Tssf. +- (3) If no EDPs are armed, then the gprsSSF FSM transits to the state "Idle". Otherwise the gprsSSF FSM transits to the state "Monitoring". + +The gsmSSF shall not perform any implicit arming or disarming of DPs. + +#### 13.5.2.2 Error handling + +Generic error handling for the operation related errors is described in clause 10 and the TC services which are used for reporting operation errors are described in clause 14. + +## 13.6 ContinueGPRS procedure + +### 13.6.1 General description + +The gsmSCF uses this operation to request the gprsSSF to proceed with GPRS Session or PDP Context processing at the DP at which it previously suspended processing to await gsmSCF instructions. The gprsSSF continues processing without substituting new data from the gsmSCF. + +### 13.6.1.1 Parameters + +- pDPID: +This parameter identifies the PDP Context within the control relationship for which the processing shall continue. + +## 13.6.2 Responding entity (gprsSSF) + +### 13.6.2.1 Normal procedure + +gprsSSF preconditions: + +- (1) A control relationship exists between the gsmSCF and the GPRS Session or PDP Context. +- (2) The GPRS Session or PDP Context processing has been suspended at any DP. +- (3) The gprsSSF FSM is in the state "Waiting\_for\_Instructions". + +gsmSSF postconditions: + +- (1) GPRS Session or PDP Context processing continues. +- (2) The gprsSSF FSM is in one of the following states: + - "Monitoring" because at least one EDP was armed or an ApplyChargingReportGPRS was requested; or + - "Idle" because no EDPs were armed and no ApplyChargingReportGPRS was requested. + +### 13.6.2.2 Error handling + +Operation related error handling is not applicable, due to class 4 operation. + +## 13.7 EntityReleasedGPRS procedure + +### 13.7.1 General description + +The gprsSSF uses this operation to inform the gsmSCF that the GPRS Session is detached or a PDP Context is disconnected. It shall be used only when the associated event detection point (ie. for GPRS Session Detach: DP "Detach" and for PDP Context Disconnect: DP "PDP Context Disconnection") is at that moment not armed for reporting. + +This operation shall be used irrespectively of the functional entity that initiated the Detach or PDP Context Disconnect and irrespectively of the cause for the Detach or PDP Context Disconnect. + +When a PDP Context is terminated, then the gprsSSF shall send all pending reports of that PDP Context to the gsmSCF. When a GPRS Session is terminated, then the gprsSSF shall send all outstanding reports of the GPRS Session to the gsmSCF. + +### 13.7.1.1 Parameters + +- gPRSCause: +This parameter gives an indication to the gsmSCF about the reason for discontinuing the PDP Context or GPRS Session. This may be used by gsmSCF if a FurnishChargingInformationGPRS operation needs to be sent to the gprsSSF. +- pDPID: +This parameter identifies the PDP Context within the GPRS Session dialogue, which has terminated. + +### 13.7.2 Invoking entity (gprsSSF) + +### 13.7.2.1 Normal procedure + +gprsSSF preconditions: + +- (1) The gprsSSF FSM is in the state "Waiting\_for\_Instructions" or in the state "Monitoring". + +gprsSSF postconditions: + +- (1) All armed EDPs for the indicated PDP Context or GPRS Session shall be disarmed. All connections and resources related to the indicated PDP Context or GPRS Session shall be released. +If there are no more armed EDPs or pending reports, then the gprsSSF FSM transits to the state "Idle"; otherwise the gprsSSF FSM remains in the same state. + +### 13.7.2.2 Error handling + +If the operation timer expires, then the gprsSSF shall abort the TC dialogue, terminate the GPRS dialogue and instruct the SGSN to handle the GPRS session or PDP context in accordance with the default GPRS handling parameter of the valid CSI. + +Generic error handling for the operation related errors is described in clause 10 and the TC services which are used for reporting operation errors are described in clause 14. + +## 13.8 EventReportGPRS procedure + +### 13.8.1 General description + +The gprsSSF uses this operation to notify the gsmSCF of a GPRS Session or PDP Context event previously requested by the gsmSCF in a RequestReportGPRSEvent operation. + +#### 13.8.1.1 Parameters + +- gPRSEventType: +This parameter specifies the type of event that is reported. +- gPRSEventSpecificInformation: +This parameter indicates the GPRS Session or PDP Context related information specific to the event. + +For Change of Position GPRS Session it shall contain the "locationInformationGPRS", if available. + +For Change of Position PDP Context it shall contain the "accessPointName", "chargingID", "locationInformationGPRS", "endUserAddress", Quality of Service, "timeAndTimeZone" and "gGSNAddress" and "secondaryPDP-context", if available. + +For Detach and PDP Context Disconnect it shall contain the "initiatingEntity" and, conditionally, "routeingAreaUpdate". The "initiatingEntity" indicates the entity that initiated the Detach or PDP Context Disconnect. The "routeingAreaUpdate" indicates that the Detach or PDP Context Disconnect is due to inter-SGSN routeing area update. + +In the case of inter-SGSN routeing area update, the gsmSCF may ignore the "initiatingEntity". + +For PDP Context Establishment it shall contain the "accessPointName", "endUserAddress", "pDPInitiationType", Quality of Service, "locationInformationGPRS", "timeAndTimeZone" and "secondaryPDP-context", if available. + +The Quality of Service shall contain the Requested QoS and the Subscribed QoS. The "requested-QoS-Extension" and the "subscribed-QoS-Extension" may be present as supplements to the "requested-QoS" and the "subscribed-QoS" respectively. + +For PDP Context Establishment Acknowledgement it shall contain the "accessPointName", "chargingID", "endUserAddress", Quality of Service, "locationInformationGPRS", "timeAndTimeZone" and "gGSNAddress", if available. + +The Quality of Service shall contain the Requested QoS, the Subscribed QoS and the Negotiated QoS. The "requested-QoS-Extension", the "subscribed-QoS-Extension" and the "negotiated-QoS-Extension" may be present as supplements to the "requested-QoS", the "subscribed-QoS" and the "negotiated-QoS" respectively. + +All optional gPRSEventSpecificInformation parameters shall be sent in accordance with 3GPP TS 23.078 [7] subclause 6.6.1.4 and 3GPP TS 22.078 [3] annex "GPRS Information provided to the CSE". + +- miscGPRSInfo: +This parameter contains DP related information. + +- messageType: +This parameter indicates whether the message is a request, i.e. resulting from a RequestReportGPRSEvent with "monitorMode" = "interrupted", or a notification, i.e. resulting from a RequestReportGPRSEvent with "monitorMode" = "notifyAndContinue". +- pDPID: +This parameter identifies the PDP Context, within the GPRS Session dialogue, for which the event is reported. + +## 13.8.2 Invoking entity (gprsSSF) + +### 13.8.2.1 Normal procedure + +gprsSSF preconditions: + +- (1) The gprsSSF FSM is in the state "Monitoring" or in the state "WaitingForInstructions". +- (2) The GPRS Session or PDP Context FSM proceeds to an EDP that is armed. + +gprsSSF postconditions: + +- (1) If the message type was notification and there are still armed EDPs that can be met or there are any pending reports, then the gprsSSF FSM shall remain in the state "Monitoring". +- (2) If the message type was notification and there are no more EDPs armed that can be met and there are no pending reports, then the gprsSSF FSM shall transit to the state "Idle". +- (3) If the message type was request, then the gprsSSF FSM shall transit to the state "Waiting\_for\_Instructions". +GPRS Session or PDP Context processing is interrupted. + +If an EDP-R is met that causes the release of a GPRS Session or PDP Context, then all EDPs related to the GPRS Session or PDP Context shall be disarmed. + +### 13.8.2.2 Error handling + +If the operation timer expires, then the gprsSSF shall abort the TC dialogue, terminate the GPRS dialogue and instruct the SGSN to handle the GPRS session or PDP context in accordance with the default GPRS handling parameter of the valid CSI. + +If the message type is "request" and the Tssf timer expires, then the gprsSSF shall abort the TC dialogue and shall instruct the SGSN to treat the GPRS Session or PDP Context in accordance with the default GPRS handling of the valid CSI. + +Generic error handling for the operation related errors is described in clause 10 and the TC services which are used for reporting operation errors are described in clause 14. + +## 13.9 FurnishChargingInformationGPRS procedure + +### 13.9.1 General description + +The gsmSCF uses this operation to send charging related information to a Logical GPRS record. This Logical GPRS record is CAMEL specific. The first FurnishChargingInformationGPRS operation results in the generation of a Logical GPRS record. Receipt of subsequent FurnishChargingInformationGPRS operations shall overwrite or append the contents of the Logical GPRS record. + +#### 13.9.1.1 Parameters + +- fCIGPRSBillingChargingCharacteristics: +This parameter contains the following parameters; +- fCIBCCCAMELsequence1: +This parameter contains the following parameters; +- freeFormatData: +This parameter contains free-format billing and/or charging characteristics. + +- appendFreeFormatData: +This parameter indicates whether previous FCI free format data is appended or overwritten. Refer to 3GPP TS 23.078 [7] for details of this mechanism. +- pDPID: +This parameter indicates the PDP Context's Logical GPRS record to which the free format data belongs. + +## 13.9.2 Responding entity (gprsSSF) + +### 13.9.2.1 Normal procedure + +gprsSSF preconditions: + +- (1) The gprsSSF FSM is in the state "Waiting\_for\_Instructions" or in the state "Monitoring". + +gprsSSF postconditions: + +- (1) No gprsSSF FSM state transition. + +On receipt of this operation the gprsSSF performs actions to create the Logical GPRS record, if necessary, and writes the free-format information carried in the operation into the GPRS record. A FurnishChargingInformationGPRS operation will create a Logical GPRS Data Record (CDR) if such a record does not already exist. Subsequent FurnishChargingInformationGPRS operations received, will either overwrite or append the data previously written in the free-format CDR field depending on the presence and value of the parameter "appendFreeFormatData". + +The Logical GPRS records will be associated for a given GPRS Session or PDP Context with one or more physical CDRs, as specified in 3GPP TS 32.250 [14] and 3GPP TS 22.115 [4]. + +### 13.9.2.2 Error handling + +Generic error handling for the operation related errors is described in clause 10 and the TC services which are used for reporting operation errors are described in clause 14. + +## 13.10 InitialDPGPRS procedure + +### 13.10.1 General description + +The gprsSSF uses this operation after detection of a TDP-R in the GPRS Session or PDP Context state machine, to request the gsmSCF for instructions to complete the GPRS Session or PDP Context. + +For a GPRS Session, the "Attach" and "Change of Position Session" TDPs may result in the InitialDPGPRS Procedure. + +For a PDP Context, the "PDP Context Establishment", the "PDP Context Establishment Acknowledgement" and the "Change of Position Context" TDPs may result in the InitialDPGPRS Procedure. + +If a PDP Context related TDP is met and there is at that moment a GPRS dialogue for the GPRS Session, then the gprsSSF shall not initiate the InitialDPGPRS Procedure for that PDP Context. + +If the "PDP Context Establishment Acknowledgement" event occurs and this event is armed as a TDP, and there is at that moment a GPRS dialogue for the PDP Context, then the gprsSSF shall not initiate a new InitialDPGPRS Procedure for that PDP Context. + +#### 13.10.1.1 Parameters + +- serviceKey: +This parameter indicates to the gsmSCF the requested IN service. It is used to address the required application/SLP within the gsmSCF; it is not used for SCP addressing. +- gPRSEventType: +This parameter indicates the armed GPRS Attach/Detach FSM or PDP Context FSM DP event, resulting in the InitialDPGPRS operation. +- mSISDN: +This parameter contains the MSISDN of the mobile subscriber for which the CAMEL service is invoked. + +- iMSI: +This parameter contains the IMSI of the mobile subscriber for which the CAMEL service is invoked. +- timeAndTimezone: +This parameter contains the time that the gprsSSF is triggered, and the time zone that the invoking gprsSSF resides in. +- gPRSMSCClass: +This parameter contains the MS capabilities of the mobile subscriber for which the CAMEL service is invoked. +- endUserAddress: +This parameter identifies the PDP type, PDP type organisation and the actual PDP address. +- qualityOfService: +This parameter contains the Quality of Service. +If the InitialDPGPRS operation is sent as a result of the "PDP Context Establishment" TDP, then the Quality of Service parameter shall contain the Requested QoS and the Subscribed QoS. The "requested-QoS-Extension" and the "subscribed-QoS-Extension" may be present as supplements to the "requested-QoS" and the "subscribed-QoS" respectively. +If the InitialDPGPRS operation is sent as a result of the "PDP Context Establishment Acknowledgement" TDP or the Change of Position Context TDP, then the Quality of Service parameter shall contain the Requested QoS, the Subscribed QoS and the Negotiated QoS. The "requested-QoS-Extension", the "subscribed-QoS-Extension" and the "negotiated-QoS-Extension" may be present as supplements to the "requested-QoS", the "subscribed-QoS" and the "negotiated-QoS" respectively. +- accessPointName: +This parameter contains the requested address that the MS for which the CAMEL service is invoked for wants to connect to. +- routeingAreaIdentity: +This parameter contains the location information of the MS for which the CAMEL service is invoked. +- chargingID: +This parameter contains the charging ID that, together with the gGSNAddress, uniquely identifies the PDP Context for the MS for which the CAMEL service is invoked. +- sGSNcapabilities: +This parameter specifies the capabilities which the SGSN node can provide for the CAMEL service control. +- locationInformationInSGSN: +This parameter indicates the location of the sending MS. +- pDPInitiationType: +This parameter indicates whether a PDP Context was established as a result of a network-initiated request or as a result of a subscriber request. +- gGSNAddress: +This parameter refers to the IP address of the GGSN where the PDP Context terminates. It is used together with the chargingID for uniquely identification of the PDP Context for which the CAMEL service is invoked from. +- secondaryPDP-context: +This parameter indicates that the PDP Context is requested as a secondary PDP Context. +- iMEI: +This parameter contains the IMEI (with software version) of the mobile subscriber for which the service is invoked. + +## 13.10.2 Invoking entity (gprsSSF) + +### 13.10.2.1 Normal procedure + +gprsSSF preconditions: + +- (1) An event has been met that is armed as TDP. +- (2) There is no GPRS dialogue active for that PDP Context or for the GPRS Session. + +gprsSSF postconditions: + +- (1) A control relationship is established between the gsmSCF and the GPRS Session or the PDP Context. +- (2) The gprsSSF FSM is in the state "Waiting\_for\_Instructions". + +The address of the gsmSCF that the InitialDPGPRS operation shall be sent to, shall be fetched from the valid CSI. The gprsSSF shall provide all available parameters to the gsmSCF. + +The gprsSSF application timer Tssf shall be loaded and started when the gprsSSF sends InitialDPGPRS for requesting instructions from the gsmSCF. It is used to prevent excessive GPRS Session or PDP Context duration or volume usage. + +### 13.10.2.2 Error handling + +If the gsmSCF is not accessible, then the gprsSSF instructs the SGSN to handle the GPRS Session or PDP Context in accordance with the Default GPRS Handling parameter of the valid CSI. + +If Tssf expires, then the gprsSSF shall abort the interaction with the gsmSCF by means of an abort to TC and shall instruct the SGSN to handle the GPRS Session or PDP Context in accordance with the Default GPRS Handling parameter of the valid CSI. + +If the MS abandons the establishment of a GPRS Session or PDP Context after the sending of InitialDPGPRS and before the TC dialogue is established, then the gprsSSF shall abort the interaction with the gsmSCF by means of an abort to TC. + +Generic error handling for the operation related errors is described in clause 10 and the TC services which are used for reporting operation errors are described in clause 14. + +## 13.11 ReleaseGPRS procedure + +### 13.11.1 General description + +The gsmSCF uses this operation to tear down by the gsmSCF an existing GPRS Session or PDP Context at any phase. + +#### 13.11.1.1 Parameters + +- gPRSCause: +This parameter gives an indication to the gprsSSF about the reason of releasing the GPRS Session or a specific PDP Context. This may be used by gprsSSF for generating specific indications to the MS or to fill in the "cause" in the release message. +- pDPID: +This parameter identifies the PDP Context, within the GPRS Session dialogue, which shall be released. + +### 13.11.2 Responding entity (gprsSSF) + +#### 13.11.2.1 Normal procedure + +gprsSSF preconditions: + +- (1) A control relationship exists between gsmSCF and the GPRS Session or PDP Context. More specifically, in order to tear down an individual PDP Context, an EDP-R must be armed for that PDP Context. In order to make a SCP controlled detach an EDP-R must be armed for the GPRS Session. +- (2) The gprsSSF FSM is in the state "Waiting\_for\_Instructions" or in the state "Monitoring". + +gprsSSF postconditions: + +- (1) All pending reports for the GPRS Session or the PDP Context shall be reported to the gsmSCF. +- (2) All connections and resources related to the GPRS Session or the PDP Context shall be released. +- (3) All armed EDPs for the GPRS Session or the PDP Context shall be disarmed. + +- (4) If there are no more pending reports or armed events, then the gprsSSF FSM transits to the state "Idle". + +If there are any pending reports or armed events, then the gprsSSF FSM remains in the same state. + +### 13.11.2.2 Error handling + +Generic error handling for the operation related errors is described in clause 10 and the TC services which are used for reporting operation errors are described in clause 14. + +## 13.12 RequestReportGPRSEvent procedure + +### 13.12.1 General description + +The gsmSCF uses this operation to request the gprsSSF to monitor for a GPRS Session or PDP Context related event (e.g., events such as PDP Context establishment or detach) and to send a notification to the gsmSCF when the event is detected. + +The monitoring of more than one event may be requested with a single RequestReportGPRSEvent operation, but each of these requested events will be reported in a separate EventReportGPRS operation. + +#### 13.12.1.1 Parameters + +- gPRSEvent: +This parameter specifies the event or events of which a report is requested. +- gPRSEventType: +This parameter specifies the type of event of which a report is requested. +- monitorMode: +This parameter indicates how the event shall be reported. If the "monitorMode" is "interrupted", then the event shall be reported as a request; if the "monitorMode" is "notifyAndContinue", then the event shall be reported as a notification; if the "monitorMode" is "transparent", then the event shall not be reported. +- pDPID: +This parameter identifies the PDP Context, within the GPRS Session dialogue, for which the event reporting is requested + +### 13.12.2 Responding entity (gprsSSF) + +#### 13.12.2.1 Normal procedure + +gprsSSF preconditions: + +- (1) A control relationship exists between the gsmSCF and the GPRS Session or PDP Context. +- (2) The gprsSSF FSM is in the state "Waiting\_for\_Instructions" or the state "Monitoring". + +In the state "monitoring" only requests to disarm detection points (with MonitorMode set to "Transparent") or send notifications of events (with MonitorMode set to "NotifyAndContinue") shall be accepted. + +gprsSSF postconditions: + +- (1) The requested EDPs have been armed or disarmed as indicated. +- (2) Previously requested events are monitored until ended by a transparent monitor mode, until the end of the GPRS Session or PDP Context or until the EDPs are detected. +- (3) If there are no armed events or pending reports, then the gsmSSF FSM shall transit to the state "Idle". Otherwise it shall remain in the same state. + +#### 13.12.2.2 Error handling + +Generic error handling for the operation related errors is described in clause 10 and the TC services which are used for reporting operation errors are described in clause 14. + +## 13.13 ResetTimerGPRS procedure + +### 13.13.1 General description + +The gsmSCF uses this operation to refresh the Tssf application timer, in order to avoid the Tssf time-out at the gprsSSF. + +#### 13.13.1.1 Parameters + +- timerID: +This parameter indicates which timer shall be reset. The only permissible value for this parameter is "Tssf". +- timerValue: +This parameter specifies the value to which the timer shall be set. + +### 13.13.2 Responding entity (gprsSSF) + +#### 13.13.2.1 Normal procedure + +gprsSSF preconditions: + +- (1) GPRS Session or PDP Context processing has been suspended at a DP. +- (2) The gprsSSF FSM is in the state "Waiting\_for\_Instructions". + +gprsSSF postconditions: + +- (1) The Tssf timer is loaded with the value received from the gsmSCF and is restarted. +- (2) No gprsSSF FSM state transition. + +#### 13.13.2.2 Error handling + +Generic error handling for the operation related errors is described in clause 10 and the TC services which are used for reporting operation errors are described in clause 14. + +## 13.14 SendChargingInformationGPRS Procedure + +### 13.14.1 General description + +The gsmSCF uses this operation to instruct the gprsSSF on the Advice of Charge information to be sent to the MS, provided that the SGSN supports Advice of Charge. The operation may be invoked on multiple occasions. + +#### 13.14.1.1 Parameters + +- sCIGPRSBBillingChargingCharacteristics: +This parameter contains the Advice of Charge information: + - aOCGPRS: +This parameter specifies the Advice of Charge information that shall be sent to the MS. It may contain one or more of the following parameters: + - aOCInitial: +This is a set of Charge Advice Information elements, as defined in 3GPP TS 22.024 [2]. These CAI elements shall be sent by the gprsSSF to the MS when an Activate PDP Context Accept or Attach Accept is sent to MS and a tariff switch has not yet occurred. It may also be sent at any other time e.g. upon change of QoS or RAI. + - aOCSubsequent: +This parameter may contain the following information: + - cAIElements: +This is a set of Charge Advice Information (CAI) elements, as defined in 3GPP TS 22.024 [2]. These CAI elements shall be sent to the MS when an Activate PDP Context Accept or Attach Accept is + +detected and a tariff switch has occurred previously, or when Activate PDP Context Accept or Attach Accept has previously been detected and a tariff switch occurs. + +- **tariffSwitchInterval:** +This parameter indicates to the gprsSSF the time duration until the next tariff switch. The measurement of the elapsed tariff switch period shall start immediately after successful execution of this operation. +- **pDPID:** +This parameter identifies the PDP Context, within the GPRS Session dialogue, for which the Advice-of-Charge instruction applies. + +## 13.14.2 Responding Entity (gprsSSF) + +### 13.14.2.1 Normal Procedure + +gprsSSF preconditions: + +- (1) A relationship exists between the gsmSCF and the GPRS Session or PDP Context. +- (2) The gprsSSF FSM is in the state "Waiting\_for\_Instructions" or in the state "Monitoring". + +gprsSSF postconditions: + +- (1) No gprsSSF FSM state transition. + +On receipt of this operation, the gprsSSF performs actions to send the Advice of Charge information to the MS, provided that the SGSN supports Advice of Charge. + +If Advice of Charge is to be provided to an MS in conjunction with "CSE control of GPRS Session or PDP Context duration or volume", then the following sequence of operations shall be sent from the gsmSCF to the gprsSSF in the following order and in the same TC TC-CONTINUE or TC-BEGIN component: + +ApplyChargingGPRS; SendChargingInformationGPRS. + +These operations shall be processed sequentially by the gprsSSF, in the order that they are sent by the gsmSCF. In this, case parameter **TariffSwitchInterval** may be present either in the **ApplyChargingGPRS** operation or in the **SendChargingInformationGPRS** operation, but not in both operations. It is recommended that this parameter be transported in the **ApplyGPRSCharging** operation. + +The **TariffSwitchInterval** information received with either one of these operations shall set the same tariff switch timer in the gprsSSF. This duration timer shall run from the time of successful operation execution. + +### 13.14.2.2 Error handling + +"TaskRefused": In addition to the generic error handling noted below, this error shall be indicated when: + +- a **tariffSwitchInterval** is indicated when a previously received **tariffSwitchInterval** is pending. + +Generic error handling for the operation related errors is described in clause 10 and the TC services which are used for reporting operation errors are described in clause 14. + +## 14 Services assumed from lower layers + +### 14.1 Services assumed from TC + +The SS7 application layer protocol defined in this 3GPP TS, is a protocol to provide communication between a pair of application processes. In the SS7 environment this is represented as communication between a pair of application-entities (AEs) using the TC. The function of an AE is provided by a set of application-service-elements (ASEs). The interaction between AEs is described in terms of their use of the services provided by the ASEs. + +If AC are to be used for FE differentiation within a physical node, then the version of TC used must support the dialogue portion of TC (i.e. ETSI ETS 300 287-1 [22]). + +This requirement applies to all interfaces, not just those used for internetworking. + +Table 14-1 defines which versions of TC are the minimum versions required to support the defined CAP interfaces: + +**Table 14-1: Minimum TC requirements for CAP interfaces** + +| Interface | CAP | +|------------------------|------------| +| gsmSSF - gsmSCF | White Book | +| gsmSRF - gsmSCF | White Book | +| assist gsmSSF - gsmSCF | White Book | +| smsSSF - gsmSCF | White Book | +| gprsSSF - gsmSCF | White Book | + +## 14.1.1 Common procedures + +The present subclause defines the procedures and mapping which apply between CAP and TC to be used in the absence of specific procedures and mapping instructions for the specific CAP interfaces as defined in subsequent subclauses. + +### 14.1.1.1 Normal procedures + +The present subclause describes the procedures and TC primitives that shall be used for transmitting messages between AEs under normal operation. + +The CAP, as TC-user, uses only the structured dialogue facility provided by TC. The following situations can occur when a message is sent between two PE: + +- a dialogue shall be established: the TC-user issues a TC-BEGIN request primitive. +- a dialogue shall be maintained: the TC-user issues a TC-CONTINUE request primitive. +- a dialogue shall no longer be maintained: the TC-user issues a TC-END request primitive with either basic end or with pre-arranged end depending on the following conditions: + - Basic End + - In the case the dialogue is established, operations, leading to a termination of the relationship, can be transmitted by the FE with a TC-END request primitive (basic) in the case the FE is not interested in the reception of any ERROR or REJECT components for these sent operations. Once the FE dialogue resources have been released, any ERROR or REJECT components received for these operations will be discarded by TC as described in ETSI ETS 300 287-1 [22]. + - In the case that the dialogue is established and the FE has received an operation, leading to the termination of the relationship, does not wish to continue dialogue and there is no operation to be sent, a TC-END request primitive (basic) with zero components can be sent from the FE. + - Pre-arranged End + - Where an entity is interested in possible ERROR or REJECT messages on response to sent operations leading to a termination of the relationship, the dialogue is ended with a TC-END request primitive (pre-arranged end) after the last associated operation timer expires. The receiving entity can end the dialogue with a TC-END request primitive (pre-arranged end) after successful processing of these operations (i.e. the relationship is terminated). + - in general, the use of prearranged end shall be limited to the case for both communicating entities clearly recognizable that peer entity applies prearranged end. In all other cases, basic end shall be used. + +### 14.1.1.2 Abnormal procedures + +The present subclause describes the procedures and TC primitives that shall be used for reporting abnormal situations between AEs. The error cases are defined in clause 10. + +The following primitives shall be used to report abnormal situations: + +- operation errors, as defined in the CAP, are reported with TC-U-ERROR request primitive. + +- rejection of a TC component by the TC-user shall be reported with TC-U-REJECT request primitive. +- when the FE detecting error or rejecting operation decides the termination of TC dialogue, TC-END request primitive (basic) with error or reject can be used for the termination of TC dialogue. +- when the gsmSSF or the gsmSRF detecting error or rejecting operation recognizes the possibility to continue dialogue, TC-CONTINUE request primitive with error or reject can be used for the continuation of TC dialogue. +- a dialogue shall be aborted by the TC-user with a TC-U-ABORT request primitive. +- on expiration of application timer Tssf or Tsrf, dialogue shall be terminated by means of by TC-U-ABORT primitive with an Abort reason, regardless of TC dialogue is established or not. + +For abnormal situations detected by TC the same rules shall apply for reception of TC-R-REJECT indication as for transmission of TC-U-REJECT request and for transmission of TC-P-ABORT indication as for transmission of TC-U-ABORT request primitive. + +The following rules shall be applied to terminate the TC dialogue under abnormal situations: + +- in the case that abort condition is detected and TC dialogue is established, TC dialogue is terminated by TC-U-ABORT primitive with an Abort reason. +- in the case that abort condition is detected and TC dialogue is not established, TC dialogue is locally terminated by TC-U-ABORT primitive. (in the case such as application time out). + +In error situations prearranged end shall not be used to terminate the TC dialogue. In the case any AE encounters an error situation the peer entity shall be explicitly notified of the error, if possible. If from any entity's point of view the error encountered requires the relationship to be ended, then it shall close the dialogue via a TC-END request primitive with basic end or via a TC-U-ABORT request primitive, depending on whether any pending ERROR or REJECT component is to be sent or not. + +In the case an entity receives a TC-END indication primitive and after all components have been considered, the FSM is not in a state to terminate the relationship, an appropriate internal error should be provided. + +In cases when a dialogue needs to be closed by the initiating entity before its establishment has been completed (before the first TC indication primitive to the TC-BEGIN request primitive has been received from the responding entity), the TC-user shall issue a TC-END request primitive with prearranged end or a TC-U-ABORT request primitive. The result of these primitives will be only local, any subsequent TC indication received for this dialogue will be handled in accordance with the abnormal procedures as specified in ETSI ETS 300 287-1 [22]. + +When the gsmSSF, gprsSSF or smsSSF receives multiple Operation components in a single TC Message and there is an error in the processing of one of these Operations, then the gsmSSF FSM, gprsSSF FSM or smsSSF FSM shall process the error and shall discard all Operation components in that TC Message of which the processing has not yet started. + +### 14.1.1.3 Dialogue handling + +#### 14.1.1.3.1 Dialogue establishment + +The establishment of a CAP dialogue involves two application processes as described in clause 1, one that is the dialogue-initiator and one that is the dialogue-responder. + +This procedure is driven by the following signals: + +- A TC-BEGIN request primitive from the dialogue-initiator. +- A TC-BEGIN indication primitive occurring at the responding side +- The first TC-CONTINUE indication primitive occurring at the initiating side or under specific conditions: + - A TC-END indication primitive occurring at the initiating side + - A TC-U-ABORT indication primitive occurring at the initiating side + - A TC-P-ABORT indication primitive occurring at the initiating side + +*Sending of a TC-BEGIN request* + +Before issuing a TC-BEGIN request primitive, TC-USER shall store the AC-name and if present the user-information parameter. + +TC-USER shall request the invocation of the associated operations using the TC-INVOKE service. See subclause 14.1.1.4.1 for a description of the invocation procedure. + +After processing of the last invocation request, TC-USER shall issue a TC-BEGIN request primitive. + +The initiator TC-USER then waits for a TC indication primitive and will not issue any other requests, except a TC-U-ABORT request or a TC-END request with the release method parameter set to "pre-arranged release". + +*Receipt of a TC-BEGIN indication* + +On receipt of a TC-BEGIN indication primitive, responder TC-USER shall: + +- Analyse the application-context-name included in the primitive. If it is supported, then process any other indication primitives received from TC as described in subclause 14.1.1.4.1. +- If the application-context-name included in the primitive is not supported, then issue a TC-U-ABORT request primitive. + +*Receipt of the first TC-CONTINUE indication* + +On receipt of the first TC-CONTINUE indication primitive for a dialogue, TC-USER shall check the value of the application-context-name parameter. If this value matches the one used in the TC-BEGIN request primitive, then TC-USER shall process the following TC component handling indication primitives as described in subclause 14.1.1.4.1, otherwise it shall issue a TC-U-ABORT request primitive. + +*Receipt of a TC-END indication* + +On receipt of a TC-END indication primitive in the dialogue initiated state, TC-USER shall check the value of the application-context-name parameter. If this value match the one used in the TC-BEGIN request primitive, then the TC-USER shall process the following TC component handling indication primitives as described in subclause 14.1.1.4.1. + +*Receipt of a TC-U-ABORT indication* + +Receipt of a TC-U-ABORT indication primitive is described as part of user abort procedure (see 14.1.1.3.4.). + +*Receipt of a TC-P-ABORT indication* + +Receipt of a TC-P-ABORT indication primitive is described as part of provider abort procedure (see 14.1.1.3.5.). + +#### 14.1.1.3.2 Dialogue continuation + +Once established the dialogue is said to be in a continuation phase. + +Both application processes can request the transfer of CAP APDUs until one of them requests the termination of the dialogue. + +*Sending entity* + +TC-USER shall process any component handling request primitives as described in subclause 14.1.1.4.1. + +After processing the last component handling request primitive, TC-USER shall issue a TC-CONTINUE request primitive. + +*Receiving entity* + +On receipt of a TC-CONTINUE indication primitive TC-USER shall accept zero, one or several TC component handling indication primitives and process them as described in subclause 14.1.1.4.1. + +### 14.1.1.3.3 Dialogue termination + +Both the dialogue-initiator and the dialogue-responder have the ability to request the termination of a dialogue after it has been established when no dialogue is to be established or when a dialogue is no longer to be maintained according to the rules as stated in subclauses 14.1.2.1.1 and 14.1.2.1.2. + +The dialogue termination procedure is driven by the following events: + +- A TC-END request primitive +- A TC-END indication primitive + +#### *Sending of TC-END request* + +When the dialogue shall no longer be maintained, TC-USER shall process any component handling request primitives as described in subclause 14.1.1.4.1 + +After processing the last component handling request primitive (if any), TC-USER shall issue a TC-END request primitive with the release method parameter set to "basic end" or "prearranged release", in accordance with the rules as stated in subclauses 14.1.2.1.1 and 14.1.2.1.2. + +When no dialogue is to be established, refer to subclauses 14.1.1.3.1. + +#### *Receipt of a TC-END indication* + +On receipt of a TC-END indication primitive, the TC-USER shall accept any component handling indication primitives and process them as described in subclause 14.1.1.4.1. + +After processing the last component handling primitive all dialogue related resources are released. + +### 14.1.1.3.4 User abort + +Both the dialogue-initiator and the dialogue-responder have the ability to abort a dialogue at any time. + +The user abort procedure is driven by one of the following events: + +- A TC-U-ABORT request primitive +- A TC-U-ABORT indication primitive + +#### *Sending of TC-U-ABORT request* + +After issuing a TC-U-ABORT request primitive, all dialogue related resources are released. + +#### *Receipt of a TC-U-ABORT indication* + +On receipt of a TC-U-ABORT indication all dialogue related resources are released. + +### 14.1.1.3.5 Provider abort + +TC has the ability to abort a dialogue at both the dialogue-initiator side and the dialogue-responder side. + +The provider abort procedure is driven by the following event: + +- A TC-P-ABORT indication primitive + +#### *Receipt of a TC-P-ABORT indication* + +On receipt of a TC-P-ABORT indication, all dialogue related resources are released. + +#### 14.1.1.3.6 Mapping to TC dialogue primitives + +The TC-UNI service is not used by CAP. + +The mapping of parameters onto the TC Dialogue services is as follows: + +The use of parameters of the TC-BEGIN service is as defined in subclause 14.1.1.3.7 with the following qualifications: + +- The Destination Address parameter of the TC-BEGIN service shall be set to the CAP address of the AE which is to respond to the TC-BEGIN service. +NOTE 1: The address used in this parameter may be mapped by SCCP address translation to one of a number of alternative AEs. +- The AC Name parameter of the TC-BEGIN service shall be set according to the specific interface being used between the initiating AE and the responding AE. +- The Originating Address parameter of the TC-BEGIN service shall be set to the unambiguous CAP address of the AE initiating the TC-BEGIN service. + +The use of parameters of the TC-CONTINUE service is as defined in subclause 14.1.1.3.7 with the following qualifications: + +- The AC Name parameter of the TC-CONTINUE service shall be set to the value of the AC Name parameter of the TC-BEGIN service for the same TC Dialogue ID parameter value. +- If present, the Originating Address parameter of the TC-CONTINUE service shall be set to the unambiguous CAP address of the AE initiating the TC-CONTINUE service. This parameter is present only in the first TC-CONTINUE service after a TC-BEGIN service with the same TC Dialogue ID parameter value. + +The use of parameters of the TC-END service is as defined in subclause 14.1.1.3.7 with the following qualifications: + +- The AC Name parameter of the TC-END service shall be set to the value of the AC Name parameter of the TC-BEGIN service for the same TC Dialogue ID parameter value. This parameter is present only if the TC-END service is used immediately after the TC-BEGIN service. + +The use of parameters of the TC-U-ABORT service is as defined in subclause 14.1.1.3.7 with the following qualifications: + +- The Abort Reason parameter of the TC-U-ABORT service shall be used as specified in ETSI ETS 300 287-1 [22]. +- The AC Name parameter of the TC-U-ABORT service shall be set to the value used in the TC-BEGIN service. +NOTE 2: This parameter is present only if the TC-U-ABORT is the immediate response to a TC-BEGIN indication. + +The use of parameters of the TC-P-ABORT service is as defined in subclause 14.1.1.3.7 with the following qualifications: + +- The P-Abort parameter of the TC-P-ABORT service is set by TC to indicate the reason why TC aborted the dialogue. It shall take the values as defined in ETSI ETS 300 287-1 [22]. + +#### 14.1.1.3.7 Default mapping to TC dialogue parameters + +##### *Dialogue Id* + +The value of this parameter is associated with the CAP invocation in an implementation dependent manner. This parameter uniquely identifies a specific TC dialogue to a remote CAP AE for a CAP AE. + +*Application-context-name* + +The application-context-name parameter is set in accordance with the set of Operations which need to be supported by the TC dialogue. The defined AC Names can be found in clauses 6 to 8. + +*User information* + +This parameter may be used by both initiating and responding application processes. This parameter shall be used for the CAP-GPRS-ReferenceNumber as defined in 14.1.7. For interfaces other than the gprsSSF-gsmSCF interface and for SMS related messages (as in subclauses 14.1.3, 14.1.4 and 14.1.5) the receiving side may ignore this parameter if received. The User Information parameter shall be encoded in accordance with the definition provided in ITU-T Recommendation Q.773 [46], subclause 3.2, and the definition of EXTERNAL type provided in ITU-T Recommendation X.690 [57], with the restriction that: + +- a size (1..10) constraint of SEQUENCE OF EXTERNAL; +- an Object Identifier shall always be present to identify the user information and the entity which sent it; +- a single-ASN-1-type is used for encoding. + +For the use of CAP defined TC-U-Abort reason, see the ASN.1 notation in the subclause 5.7. + +For the use of CAP defined CAP-GPRS-ReferenceNumber, see subclause 14.1.7. For the abstract syntax of CAP defined CAP-GPRS-ReferenceNumber, see the ASN.1 notation in the subclause 8.1. + +*Component present* + +This parameter is used by TC-USER as described in ETSI ETS 300 287-1 [22]. + +*Termination* + +The value of the release method parameter of the TC-END request primitive is set by TC-USER according to the rules as stated in subclauses 14.1.2.1.1 and 14.1.2.1.2. + +*Quality of service* + +The quality of service of TC request primitives is set by the TC-USER to the following value: + +- Sequencing requested; +- return option, this parameter is set by TC-USER in an implementation dependent manner. + +#### 14.1.1.4 Component handling + +##### 14.1.1.4.1 Procedures for CAP Operations + +The present subclause describes the procedures for CAP Operations. + +*Operation invocation* + +TC-USER shall build an operation argument from the parameters received and request the invocation of the associated operation using the TC-INVOKE procedure. If a linked ID parameter is inserted in the primitive, then this indicates a child operation and implies that the operation is linked to a parent operation. + +*Operation invocation receipt* + +On receipt of a TC-INVOKE indication primitive, TC-USER shall: + +- If the operation code does not correspond to an operation supported by the application-context, then request the transfer of a reject component using the TC-U-REJECT request primitive, with the appropriate problem code (unrecognized operation); +- If a linked ID is included, then perform the following checks: If the operation referred to by the linked ID does not allow linked operations or if the operation code does not correspond to a permitted linked operation, or if the parent operation invocation is not active, then request the transfer of a reject component using the TC-U-REJECT request primitive, with the appropriate problem code (linked response unexpected or unexpected linked operation); + +- If a linked ID is not included, but a Linked ID is needed to correlate the indication primitive with a parent operation invocation, then request the transfer of a reject component using the TC-U-REJECT request primitive, with the appropriate problem code (mistyped parameter); +- If the type of the argument is not the one defined for the operation, then request the transfer of a reject component using the TC-U-REJECT request primitive, with the appropriate problem code (mistyped parameter); +- If the operation cannot be invoked because the CAP related dialogue is about to be released, then request the transfer of a reject component using the TC-U-REJECT request primitive with the problem code (Initiating Release); +- If sufficient CAP related resources are not available to perform the requested operation, then request the transfer of a reject component using the TC-U-REJECT request primitive with the problem code (Resource Limitation); +- Otherwise, accept the TC-INVOKED indication primitive. If the operation is to be user confirmed, then TC-USER waits for the corresponding response. + +#### *Operation Response* + +For user confirmed operations, TC-USER shall: + +- If no error indication is included in the response to a class 1 or 3 operation, then construct a result information element from the parameters received and request its transfer using the TC-RESULT-L service. +- If an error indication is included in the response to a class 1 or 2 operation, then construct an error parameter from the parameters received and request its transfer using the TC-U-ERROR request primitive. + +#### *Receipt of a response* + +On receipt of a TC-RESULT-NL indication, TC-USER shall: + +- Request the transfer of a reject component using the TC-U-REJECT request primitive, with the appropriate problem code (mistyped parameter). + +On receipt of a TC-RESULT-L indication, TC-USER shall: + +- If the type of the result parameter is not the one defined for the result of this operation, request the transfer of a reject component using the TC-U-REJECT request primitive, with the appropriate problem code (mistyped parameter); +- Otherwise, accept the TC-RESULT-L indication primitive. + +On receipt of a TC-U-ERROR indication, TC-USER shall: + +- If the error code is not defined for the TC-USER or is not one associated with the operation referred to by the invoke ID, request the transfer of a reject component using the TC-U-REJECT request primitive, with the appropriate problem code (unrecognized error or unexpected error); +- If the type of the error parameter is not the one defined for this error, request the transfer of a reject component using the TC-U-REJECT request primitive, with the appropriate problem code (mistyped parameter); +- Otherwise, accept the TC-U-ERROR indication primitive. + +On receipt of a TC-U-REJECT indication primitive which affects a pending operation, TC-USER shall: + +- accept the TC-U-REJECT indication primitive. + +On receipt of a TC-L-REJECT indicating "return result problem, return error unexpected", TC-USER shall inform the application process. + +On receipt of a TC-L-REJECT indicating "return error problem, return error unexpected", TC-USER shall inform the application process. + +This event occurs when the local TC detects a protocol error in an incoming component which affects an operation. + +When the problem code indicates a general problem, it is considered that the event cannot be related to an active operation even if the invoke Id is provided by TC. This is because it is unclear whether the invoke Id refers to a local or remote invocation. The behaviour of TC-USER in such a case is described in the subclause headed "other events". + +On receipt of a TC-L-CANCEL indication, the TC-USER shall: + +- If the associated operation is a class 1 operation, inform the application process; +- If the associated operation is a class 2 operation and no linked operations are defined for this operation, ignore the primitive; +- If the associated operation is a class 2 operation and has linked operations but none of them has been invoked, inform the application process; +- If the associated operation is a class 2 operation and a linked operation invocation has already been received in response to this operation, ignore the primitive; +- If the associated operation is a class 3 operation, inform the application process; +- If the associated operation is a class 4 operation, ignore the primitive; + +#### *Other events* + +This subclause describes the behaviour of TC-USER on receipt of a component handling indication primitive which cannot be related to any operation or which does not affect a pending one. + +On receipt of a TC-U-REJECT indication primitive which does not affect an active operation (i.e. indicating a return result or return error problem), it is up to the application process to abort, continue or terminate the dialogue, if not already terminated by the sending application process according to the rules as stated in subclause 14.1.2.1.2. This is also applicable for invoke problems related to a class 4 linked operation. + +On receipt of a TC-R-REJECT indication (i.e. when a protocol error has been detected by the peer TC entity) which does not affect an active operation, it is up to the application process to abort, continue or terminate the dialogue, if not already terminated by the sending application process according to the rules as stated in subclause 14.1.2.1.2. + +On receipt of a TC-L-REJECT indication primitive (i.e. when a protocol error has been detected by the local TC entity) which cannot be related to an active operation, it is up to the application process to continue, or to terminate the dialogue and implicitly trigger the transmission of the reject component or to abort the dialogue. + +On receipt of a TC-NOTICE indication primitive, which informs the TC-USER that a message cannot be delivered by the Network Layer, it is for the application process to decide whether to terminate the dialogue or retry. + +This primitive can occur only if the Return Option has been set (see subclause 14.1.1.3.6). + +#### 14.1.1.4.2 Mapping to TC component primitives + +The mapping of parameters onto the TC Component services is as follows: + +The TC-U-CANCEL service is not used. + +The TC-RESULT-NL service is not used. + +The use of parameters of the TC-INVOKE service is as defined in subclause 14.1.1.4.3 with the following qualifications: + +- The Operation parameter of the TC-INVOKE service shall contain the *operation.&operationCode* value of the CAP Operation to be invoked. The operation must be one of the valid operations supported by the AC for the TC dialogue and must be invokable by the local AE. +- The Parameters parameter of the TC-INVOKE service shall contain a value of the *operation.&ArgumentType* value for the operation being invoked, as specified by the Operation parameter. + +The use of parameters of the TC-RESULT-L service is as defined in subclause 14.1.1.4.3 with the following qualifications: + +- The Invoke Id parameter of the TC-RESULT-L service shall be set to the value of the Invoke Id parameter of the TC-INVOKE service from the remote AE to which a result is being sent. +- The Operation parameter of the TC-RESULT-L service be set to the value of the Operation parameter of the TC-INVOKE service from the remote AE which contains the same Invoke Id Parameter value. +- The Parameters parameter of the TC-RESULT-L service shall contain the *operation.&ResultType* value for the operation result, as specified by the Operation parameter. + +The use of parameters of the TC-U-ERROR service is as defined in subclause 14.1.1.4.3 with the following qualifications: + +- The Invoke Id parameter of the TC-U-ERROR service shall be set to the value of the Invoke Id parameter of the TC-INVOKE service from the remote AE to which an error is being sent. +- The Error parameter of the TC-U-ERROR service shall be set to the value of the *error.&errorCode* of the error to be sent. It must be one of the errors which is expected for the invoked operation as defined in the *operation.&Errors* specification. +- The Parameters parameter of the TC-U-ERROR service shall be set to the value of the *error.&ParameterType* of the error to be sent, as identified by the Error parameter. + +The use of parameters of the TC-U-REJECT service is as defined in subclause 14.1.1.4.3 with the following qualifications: + +- The Invoke Id parameter of the TC-U-REJECT service shall be set to the Invoke Id Parameter of the TC component service from the remote AE which is being rejected. + +The use of parameters of the TC-L-CANCEL service is as defined in subclause 14.1.1.4.3. + +#### 14.1.1.4.3 Default mapping to TC component parameters + +##### *Invoke Id* + +This parameter is set by the sending application process. It represents the unique identity of an instance of an operation which is invoked by an AE within a specific TC dialogue. The TC dialogue is identified by the Dialogue Id parameter. + +##### *Linked Id* + +This parameter is set by the sending application process. It represents the Invoke Id of an operation which was received from the remote AE for a specific TC dialogue to which the operation being invoked by the local AE is to be linked. This parameter is present only if the original operation invoked by the remote AE is defined as having linked operations. The type of local operation invoked must be the same type as one of the operations defined as being linked. + +##### *Dialogue Id* + +The value of this parameter is associated with the CAP invocation in an implementation dependent manner. It represents the identity of the established TC dialogue which will carry the component services between the local AE and the remote AE. + +##### *Class* + +The value of this parameter is set according to the type of the operation to be invoked according to the operation definitions in clauses 6 through 8. + +##### *Time out* + +The value of this parameter is set according to the type of operation invoked. + +##### *Last component* + +This parameter is used as described in ETSI ETS 300 287-1 [22]. + +##### *Problem code* + +This parameter is used as described in subclause 14.1.1.4.1. + +*Abort reason* + +This parameter is used by TC-USER, and attributes and coding are specified by network operator. + +## 14.1.2 gsmSSF-gsmSCF interfaces + +### 14.1.2.1 Normal procedures + +#### 14.1.2.1.1 gsmSSF-to-gsmSCF messages + +The present subclause defines the normal procedures for TC messages from the gsmSSF to the gsmSCF. + +*gsmSSF FSM related messages* + +A dialogue shall be established when the gsmSSF FSM transits from the state "Idle" to the state "Waiting\_for\_Instructions". + +The CAP Operation InitialDP shall be sent with a TC-BEGIN request primitive. + +When the dialogue was opened with InitialDP or InitiateCallAttempt operation then the gsmSSF shall maintain the dialogue when sending the SpecializedResourceReport operation indicating the announcement complete for PlayAnnouncement regardless of the fact whether the disconnectFromIPForbidden parameter was set to true or false. + +For all other operations sent from the gsmSSF FSM, the dialogue shall be maintained except for the following cases. + +When the gsmSSF FSM executes a non-error case state transition to the state "Idle" and there is one or more pending operation and TC dialogue is established, TC dialogue can be terminated by TC-END primitive with component(s). When the gsmSSF sends the last EventReportBCSM, ApplyChargingReport or CallInformationReport the dialogue may be ended from the gsmSSF by a TC-END request primitive with basic end. + +In the case that there is no pending operation and TC dialogue is established, TC dialogue can be terminated by TC-END primitive with zero component or prearranged end. When the gsmSSF FSM makes a non-error case state transition to the state "Idle" and there is no operation to be sent, the dialogue is ended by means of a TC-END request primitive (basic) with zero components, or the dialogue is locally ended by means of a TC-END request primitive with prearranged end. + +In the case where a call release is initiated by any other entity than a gsmSCF, the gsmSSF can end a dialogue with a TC-END request primitive with zero component or prearranged end if a TC dialogue is established and the gsmSSF has no pending call information requests (or pending requests which should be treated in the same way, see subclause 14.1.1.1) nor any armed EDP. + +When the gsmSSF has sent the last EventReportBCSM, ApplyChargingReport or CallInformationReport the dialogue may be ended from the gsmSCF by a TC-END request primitive with basic end. + +*Assisting gsmSSF FSM related messages* + +A dialogue shall be established when the assisting gsmSSF FSM transits from the state "Idle" to the state "Waiting\_for\_Instructions". The AssistRequestInstructions operation shall be transmitted with a TC-BEGIN request primitive. + +For all other operations sent from the assisting gsmSSF FSM, the dialogue shall be maintained except for the following cases. + +When the assisting gsmSSF FSM makes a non-error case state transition to the state "Idle" and there is one or more pending operation and TC dialogue is established, TC dialogue can be terminated by TC-END primitive with component(s). + +In the assisting gsmSSF case the same rules apply as for the gsmSCF as specified for the SpecializedResourceReport operation in subclause 14.1.3.1.1. + +In the case that there is no pending operation and TC dialogue is established, TC dialogue can be terminated by TC-END primitive with zero component or prearranged end. When the assisting gsmSSF FSM makes a non-error case state transition to the state "Idle" and there is no operation to be sent, the dialogue is ended by means of a TC-END request primitive (basic) with zero components, or the dialogue is locally ended by means of a TC-END request primitive with prearranged end. + +*gsmSSME FSM related messages* + +The following procedures shall be followed: + +- The dialogue shall be maintained when the ActivityTest Return Result is sent. + +#### 14.1.2.1.2 gsmSCF-to-gsmSSF messages + +The present subclause defines the normal procedures for TC messages from the gsmSCF to the gsmSSF. + +*SCSM-FSM related messages* + +A dialogue shall be established when the SCSM-FSM receives an InitialDP operation for TDP-R or an AssistRequestInstructions operation, or sends an InitiateCallAttempt operation. + +For subsequent operations sent from the SCSM-FSM, the dialogue shall be maintained except for the following cases; + +The dialogue shall no longer be maintained when the prearranged end condition is met in the gsmSCF. When the gsmSCF does not expect any messages other than possibly REJECT or ERROR messages for the operations sent and when the last associated operation timer expires, the dialogue is locally ended by means of a TC-END request primitive with prearranged end. + +Alternatively, the sending of operations, leading to the termination of the relationship, by means of a TC-END request primitive (basic end) is possible. + +*SCME-FSM related messages* + +The operations sent from the SCME-FSM shall be issued according to the following procedures: + +- The dialogue shall be maintained when the ActivityTest operation is sent. +- For sending one or more CallGap operations, the SCME FSM shall use an existing SCSM FSM associated dialogue which was initiated by a gsmSSF FSM (i.e. established for the transmission of the InitialDP operation). The dialogue shall be maintained. + +#### 14.1.2.1.3 smsSSF -to-gsmSCF SMS related messages + +A dialogue shall be established when the smsSSF has finalised trigger processing and transits to the state "Waiting\_for\_Instructions". The relevant CAP Operation, which can be the InitialDPSMS operation only, shall be transmitted in the same message. + +For all other operations sent from the smsSSF, the dialogue shall be maintained. + +The dialogue shall no longer be maintained when the prearranged end condition is met in the smsSSF. When the smsSSF makes a state transition to the state "Idle", the dialogue is locally ended by means of a TC-END request primitive with prearranged end. + +When the smsSSF FSM transits to the state "Idle", but no event was reported to the gsmSCF, then the smsSSF shall send TC-END with zero components to the gsmSCF. + +When the smsSSF has sent the last EventReportSMS operation the dialogue may be ended from the gsmSCF by a TC-END request primitive with basic end. If the smsSSF decides to apply basic end, then it shall send TC-END with zero components. + +#### 14.1.2.1.4 gsmSCF-to-smsSSF SMS related messages + +All operations are sent after a dialogue was established from the smsSSF (the gsmSCF has previously received a TC-BEGIN indication primitive with an InitialSMSEvent operation). + +The dialogue shall no longer be maintained when the prearranged end condition is met in the gsmSCF. When the gsmSCF does not expect any messages other than possibly REJECT or ERROR messages for the operations sent and when the last associated operation timer expires, the dialogue is locally ended by means of a TC-END request primitive with prearranged end. + +Alternatively, the sending of operations, leading to the termination of the control relationship, by means of a TC-END request primitive (basic end) is possible. + +#### 14.1.2.1.5 Use of dialogue handling services + +Dialogue handling services are used to trigger the sending of the APDUs associated with the operations involved in the CAP packages. + +Component grouping is performed under the control of the application-process through an appropriate usage of the TC-BEGIN, TC-CONTINUE and TC-END service. + +#### 14.1.2.2 Abnormal procedures + +The following procedures also apply to the gsmSCF-gsmSRF interfaces. + +##### 14.1.2.2.1 gsmSCF-to-gsmSSF/gsmSRF messages + +Considering that gsmSSF and gsmSRF do not have the logic to recover from error cases detected on the gsmSCF-gsmSSF/gsmSRF interface, the following shall apply: + +- Operation errors and rejection of TC components shall be transmitted to the gsmSSF and, respectively, the gsmSRF with a TC-END request primitive, basic end. + +If, in violation of the above procedure, an ERROR or REJECT component is received with a TC-CONTINUE indication primitive, then the gsmSSF and, respectively, the gsmSRF shall abort the dialogue with a TC-U-ABORT request primitive. + +##### 14.1.2.2.2 gsmSSF/gsmSRF/ -to-gsmSCF messages + +Operation errors and rejection of TC components shall be transmitted to the gsmSCF according to the following rules: + +- The dialogue shall be maintained when the preceding message, which contained the erroneous component, indicated that the dialogue shall be maintained. I.e. the error or reject shall be transmitted with a TC-CONTINUE request primitive if the erroneous component was received with a TC-CONTINUE indication primitive. +On receipt of an ERROR or REJECT component the gsmSCF decides on further processing. It may either continue, explicitly end or abort the dialogue. +- When the gsmSSF has received and processed InitiateCallAttempt and has acknowledged InitiateCallAttempt with InitiateCallAttempt-RESULT, then a User Error resulting from an erroneous component that is contained in the same TC\_Begin message as InitiateCallAttempt, shall be transmitted with a TC-CONTINUE indication primitive. +- In all other situations the dialogue shall no longer be maintained. I.e. the error or reject shall be transmitted with a TC-END request primitive, basic end, if the erroneous component was received with a TC-BEGIN indication primitive. +- on expiration of application timer Tssf or Tsrf, dialogue shall be terminated by means of by TC-U-ABORT primitive with an Abort reason, regardless of TC dialogue is established or not. + +If the error processing in the gsmSSF or gsmSRF leads to the case where the gsmSSF or gsmSRF is not able to process further gsmSCF operations while the dialogue is to be maintained, then the gsmSSF or gsmSRF aborts the dialogue with a TC-END request primitive with basic end or a TC-U-ABORT request primitive, depending on whether any pending ERROR or REJECT component is to be sent or not. + +The gsmSSF can end a dialogue with a TC-U-ABORT request primitive in the case that call release is initiated by any other entity then the gsmSCF and the gsmSSF has no pending call information requests (or pending requests which should be treated in the same way, i.e., ApplyCharging nor any armed EDP to notify the gsmSCF of the call release (for alternative way, see subclause 14.1.2.1.1). + +##### 14.1.2.2.3 gsmSCF-to-smsSSF SMS related messages + +Considering that the smsSSF does not have the logic to recover from error cases detected on the gsmSCF-smsSSF interface, the following shall apply: + +- operation errors and rejection of TC components shall be transmitted to the smsSSF with a TC-END request primitive, basic end. + +If, in violation of the above procedure, an ERROR or REJECT component is received with a TC-CONTINUE indication primitive, then the smsSSF shall abort the dialogue with a TC-U-ABORT request primitive. + +#### 14.1.2.2.4 smsSSF-to-gsmSCF SMS related messages + +Operation errors and rejection of TC components shall be transmitted to the gsmSCF according to the following rules: + +- the dialogue shall be maintained when the preceding message, which contained the erroneous component, indicated that the dialogue shall be maintained. I.e. the error or reject shall be transmitted with a TC-CONTINUE request primitive if the erroneous component was received with a TC-CONTINUE indication primitive; +- on receipt of an ERROR or REJECT component the gsmSCF decides on further processing. It may either continue, explicitly end or abort the dialogue; + +If the error processing in the smsSSF leads to the case where the smsSSF is not able to process further gsmSCF operations while the dialogue is to be maintained, then the smsSSF aborts the dialogue with a TC-U-ABORT request primitive. + +The smsSSF aborts a dialogue with a TC-U-ABORT request primitive if release is initiated by any other entity than the gsmSCF and the smsSSF has no armed EDPs to notify the gsmSCF. + +#### 14.1.2.2.5 Use of dialogue handling services + +On receipt of a TC-U-REJECT.ind in the FE, this primitive should be ignored. It is up to the application process to abort, continue or terminate the dialogue, if not already terminated by the sending application process according to the rules as stated in subclause 14.1.1.2. This is also applicable for invoke problems related to a class 4 linked operation. + +A TC-U-REJECT.req should be sent followed by a TC-CONTINUE.req. + +On receipt of a TC-R-REJECT.ind in the FE, this primitive should be ignored. It is up to the application process to abort, continue or terminate the dialogue, if not already terminated by the sending application process according to the rules as stated in subclause 14.1.1.2. This is also applicable for invoke problems related to a class 4 linked operation. + +On receipt of a TC-L-REJECT indication primitive (i.e. when a protocol error has been detected by the local TC entity) which cannot be related to an active operation, it is up to the application process to continue or to terminate the dialogue and implicitly trigger the transmission of the reject component or to abort the dialogue. + +On receipt of a TC-NOTICE indication the TC-USER is informed that a message cannot be delivered by the Network Layer. It occurs if the Return Option has been set (see subclause 14.1.1.3.7). It is for the application process to decide whether to terminate the dialogue or retry. + +The application-process is the sole user of the TC-P-ABORT service and TC-NOTICE service. + +The receipt of a TC-U-ABORT-Ind or TC-P-ABORT-Ind on a dialogue terminates all request processing. + +#### 14.1.2.3 Dialogue handling + +##### 14.1.2.3.1 Dialogue establishment + +##### 14.1.2.3.2 Dialogue continuation + +##### 14.1.2.3.3 Dialogue termination + +##### 14.1.2.3.4 User abort + +##### 14.1.2.3.5 Provider abort + +##### 14.1.2.3.6 Mapping to TC dialogue primitives + +The gsmSSF-gsmSCF IN services can be mapped onto TC services. The present subclause defines the mapping of the gsmSSF-gsmSCF IN services onto the services of the TC dialogue handling services defined in ETSI ETS 300 287-1 [22]. + +- a) The TC-BEGIN service is used to invoke the operations of the gsmSCF-gsmSSF connection packages as defined in clause 6. +- b) The TC-CONTINUE service is used to report the success of the operations invoked in a TC-BEGIN service and to invoke or respond to any other operations. +- c) The TC-U-ABORT service is used to report the failure of operations of the connection packages as defined in clause 6. + +The mapping of the parameters onto the TC-BEGIN primitive is defined in subclause 14.1.1.3.6 with the following qualifications: + +- The AC Name parameter shall take the value of the application-context-name field of the cap3-sms-AC object if the initiating AE is a gsmSSF. + +The mapping of the parameters onto the TC-CONTINUE primitive is defined in subclause 14.1.1.3.6. + +The mapping of the parameters onto the TC-U-ABORT primitive is defined in subclause 14.1.1.3.6 with the following qualifications: + +- The Application-Context-Name parameter shall be used as specified in ETSI ETS 300 287-1 [22]. When the responding AE refuses a dialogue because the application-context-name it receives is not supported, this parameter shall have the value of the application-context-name field of the cap3-sms-AC object if the responding AE is a gsmSCF. + +The use of the parameters of the TC-END service is defined in subclause 14.1.1.3.6. + +## 14.1.2.4 Component Handling + +### 14.1.2.4.1 Procedures for CAP Operations + +The CAP ASEs are users of the TC component handling services except for the TC-L-REJECT and TC-L-CANCEL services which are used by the application-process. Receipt of a TC-L-REJECT-Ind leads the application-process to abandon the dialogue (i.e. it issues a TC-U-ABORT-Request primitive). + +The TC-U-CANCEL service is never used. + +### 14.1.2.4.2 Mapping to TC component parameters + +The gsmSSF-gsmSCF IN ASE services are mapped onto the TC component handling services. The mapping of operations and errors onto TC services is defined in subclause 14.1.1.4.2 with the following qualifications: + +The timeout parameter of the TC-INVOKEReq primitives is set according to clause 6. + +## 14.1.3 gsmSCF-gsmSRF interface + +### 14.1.3.1 Normal procedures + +#### 14.1.3.1.1 gsmSCF-to/from-gsmSRF messages + +A dialogue is established when the gsmSRF sends an AssistRequestInstructions operation to the gsmSCF. For all other operations sent to/from the gsmSRF, the dialogue shall be maintained. + +In the case that there is no pending operation and TC dialogue is established, TC dialogue can be terminated by TC-END primitive with zero component. When the SCSM makes a non-error case state transition to end-user interaction and there is no operation to be sent, the dialogue is ended by means of a TC-END request primitive (basic) with zero components. + +When the dialogue is opened with the AssistRequestInstructions operation then the gsmSRF shall no longer maintain the dialogue when sending the SpecializedResourceReport operation indicating announcement complete for PlayAnnouncement with disconnectFromIPForbidden parameter was set to false or Return Result of the PromptAndCollectUserInfo with disconnectFromIPForbidden parameter was set to false. The dialogue is ended by means of a TC-END request primitive with basic end, and the SpecializedResourceReport operation is transmitted with the same request. + +Regardless of whether pending operation exists or not, when the SRSM-FSM is informed of the disconnection of bearer connection (in the case of gsmSCF initiated disconnection or call abandon from call party) and dialogue is established, the dialogue is ended by means of a TC-END request primitive (basic) with zero components or TC-END request primitive (prearranged end). + +The dialogue shall no longer be maintained when the prearranged end condition is met in the gsmSRF. When the SRSM-FSM is informed the disconnection of bearer connection and TC dialogue is not established, TC dialogue is locally terminated by TC-END primitive with prearranged end. + +When the gsmSCF does not expect any messages other than possibly REJECT or ERROR messages for the operations sent and when the last associated operation timer expires, the dialogue is locally ended by means of a TC-END request primitive with prearranged end. Alternatively, the sending of operations, leading to the termination of the relationship, by means of a TC-END request primitive (basic end) is possible. + +In the relay case, the gsmSRF-gsmSCF relationship uses the gsmSSF-gsmSCF TC dialogue. This is possible, because begin and end of the gsmSRF-gsmSCF relationship are embedded in the gsmSSF-gsmSCF relationship. gsmSRF-gsmSCF information shall be exchanged with TC-CONTINUE request primitives. + +#### 14.1.3.1.2 Abnormal procedures + +##### 14.1.3.1.3 Dialogue handling + +###### 14.1.3.1.3.1 Dialogue establishment + +###### 14.1.3.1.3.2 Dialogue continuation + +###### 14.1.3.1.3.3 Dialogue termination + +###### 14.1.3.1.3.4 User abort + +###### 14.1.3.1.3.5 Provider abort + +###### 14.1.3.1.3.6 Mapping to TC dialogue primitives + +The gsmSCF-gsmSRF IN services can be mapped onto TC services. The present subclause defines the mapping of the gsmSCF-gsmSRF IN services onto the services of the TC dialogue handling services defined in ETSI ETS 300 287-1 [22]. + +- a) The TC-BEGIN service is used to invoke the operations of the gsmSRF-gsmSCF connection packages as defined in clause 6. +- b) The TC-CONTINUE service is used to report the success of the operations invoked in a TC-BEGIN service and to invoke or respond to any other operations. +- c) The TC-U-ABORT service is used to report the failure of operation of the gsmSCF-gsmSRF operations packages as defined in clause 6. + +The mapping of parameters onto the TC Dialogue services is as defined in subclause 14.1.1.3.6 with the following qualifications: + +The mapping of the parameters onto the TC-BEGIN primitive is defined in subclause 14.1.1.3.6 with the following qualifications: + +- The AC Name parameter shall take the value of the application-context-name field of the gsmSRF-gsmSCF-ac object. + +#### 14.1.3.2 Component handling + +##### 14.1.3.2.1 Procedures for CAP Operations + +##### 14.1.3.2.2 Mapping to TC component parameters + +The mapping of parameters for the TC component services is defined in subclause 14.1.1.4.2 with the following qualifications. + +The Timeout Parameter of the TC-INVOKE service is set according to clauses 6. + +## 14.1.4 gprsSSF-gsmSCF interface + +### 14.1.4.1 Normal procedures + +#### 14.1.4.1.1 TC-dialogues and relationships + +The GPRS dialogue can consist of multiple consecutive TC-dialogues. A GPRS dialogue is identified by a GPRS-ReferenceNumber consisting of the originationReference and the destinationReference. One GPRS-Reference is assigned by the SGSN and shall be unique within this SGSN. The other GPRS-Reference is assigned by the gsmSCF and shall be unique within this gsmSCF. + +The *TC*-dialogues are closed and (re)opened whenever necessary. + +#### 14.1.4.1.2 Use of the GPRS Reference + +For the use of CAP defined GPRS-ReferenceNumber, see also the ASN.1 notation in the subclause 8.1. + +When the gprsSSF sends the first operation for a new GPRS dialogue (InitialDPGPRS), the gprsSSF shall include a GPRS Reference Number in the TC message. This GPRS Reference Number shall consist of the *SGSN Process Id* as originationReference, which is internally allocated by the gprsSSF. This number is used by the gprsSSF to associate an incoming TC message with an internal GPRS Process. + +When the gsmSCF has received the InitialDPGPRS operation, it shall store the SGSN Process ID and allocate an *SCF Process Id* which is used by the gsmSCF to associate an incoming TC message with an internal gsmSCF Process. + +The gsmSCF shall include the GPRS Reference Number in the first TC-CONTINUE message, *SGSN Process Id* in destinationReference and *SCF Process Id* in originationReference, returned to the gprsSSF. + +When the gprsSSF receives the first TC message from the gsmSCF for this GPRS dialogue, the gprsSSF shall store the gsmSCF Process Id together with the SGSN Process Id. + +From here onwards all the TC messages that open a new TC dialogue shall include the GPRS Reference Number consisting of the originationReference and the destinationReference to associate the internal process in the origination entity and the destination entity, respectively, until the end of the relationship between these processes. + +For any TC-CONTINUE in the existing TC dialogue, transporting the GPRS Reference Number is not needed except for the first response after the InitialDPGPRS operation. + +#### 14.1.4.1.3 gprsSSF-to-gsmSCF messages + +The present subclause defines the normal procedures for TC messages from the gprsSSF to the gsmSCF. + +##### *gprsSSF FSM related messages* + +A GPRS dialogue and a TC dialogue shall be established when the gprsSSF FSM transits from the state "Idle" to the state "Waiting\_for\_Instructions". The InitialDPGPRS operation shall be transmitted in the same TC message, i.e. TC-BEGIN. It shall contain the GPRS-Reference as assigned by the SGSN in the originationReference. The gprsSSF may initiate the subsequent TC dialogues for this GPRS dialogue with the following operations: + +- ApplyChargingReportGPRS +- EntityReleasedGPRS +- EventReportGPRS + +For the establishment of a new TC dialogue within the context of the current GPRS dialogue, the gprsSSF may apply one of the following mechanisms: + +- (1) the gprsSSF shall memorise the gsmSCF address used in the first response message to the InitialDPGPRS and use it to open the new TC dialogue; +- (2) the gprsSSF shall use the gsmSCF address from GPRS-CSI to open the new TC dialogue. + +The gsmSCF shall memorise the gprsSSF address received along with the InitialDPGPRS and use it for the opening of new TC dialogues within the context of the current GPRS dialogue. + +The gsmSCF may open subsequent TC dialogues with the following CAP Operations: + +- ActivityTestGPRS; +- ApplyChargingGPRS; +- CancelGPRS; +- FurnishChargingInformationGPRS; +- ReleaseGPRS; +- RequestReportGPRSEvent; +- SendChargingInformationGPRS. + +The CAP Operation that opens a TC dialogue shall be sent with a TC-BEGIN request primitive. This message shall contain the GPRS-ReferenceNumber assigned by the sender of this message in the originationReference. If the operation opens a subsequent TC dialogue, then this message shall contain also the previously received destinationReference. If an operation opens a GPRS dialogue, then the TC message reply shall contain the originationReference as assigned by the sender, i.e. the gsmSCF. + +The TC dialogue shall be closed for the idle periods, i.e. when the gprsSSF FSM transits from the state "Waiting\_for\_Instructions" to the state "Idle", if the gprsSSF FSM is in the state "Monitoring" and has received all replies or time-outs for the operations sent, after standalone operations of the gsmSCF in Monitoring state if gprsSSF FSM does not transit to the state "Idle" (ActivityTestGPRS, ApplyChargingGPRS, CancelGPRS, FurnishChargingInformationGPRS, RequestReportGPRSEvent, SendChargingInformationGPRS), or at the end of a GPRS dialogue. + +Each TC dialogue shall be terminated by the gprsSSF using TC-END (basic end). The following operations can cause the end of the GPRS dialogue: + +- ContinueGPRS; +- ConnectGPRS; +- ApplyChargingReportGPRS result; +- EntityReleasedGPRS result; +- EventReportGPRS (EDP-N) result; +- CancelGPRS; +- ReleaseGPRS; +- RequestReportGPRSEvent (disarming of DPs). + +When the gprsSSF FSM makes a non-error case state transition to the state "Idle" and there is one or more pending operation and TC dialogue is established, TC dialogue may be terminated by TC-END primitive with zero component(s) after all pending operations have been sent. When the gprsSSF sends the last EventReportGPRS, EntityreleasedGPRS or ApplyChargingReportGPRS, then after reception of the result or error, the GPRS dialogue may be ended from the gprsSSF by a TC-END request primitive with basic end. + +In the case that there is no pending operation, result nor error, and TC dialogue is established, TC dialogue shall be terminated by a TC-END primitive with zero component. + +In the case where a PDP Context release or detach is initiated by any other entity than a gsmSCF, the gprsSSF shall end a GPRS dialogue with the EntityReleasedGPRS operation if the gprsSSF has no armed DP to report nor pending ApplyChargingReportGPRS which should reported. + +In the case of overlapping dialogues for the same GPRS dialogue the gsmSCF opened TC dialogue is aborted by the gprsSSF with the abort reason overlapping-dialogue as specified in subclause 5.7. This abort reason is used to indicate to the gsmSCF that a specific instance already has a TC dialogue open. It is typically obtained when both the gsmSCF and gprsSSF open a new dialogue at the same time. While the gprsSSF waits for a response to an operation sent in TC-BEGIN it may receive an operation from the gsmSCF in TC-BEGIN. In such cases the dialogue opened by the gprsSSF is maintained and the dialogue opened by the gsmSCF is aborted with this abort reason. + +#### *gprsSSME FSM related messages* + +The following procedures shall be followed: + +- The TC dialogue shall be terminated by a TC-END primitive with zero components after the ActivityTestGPRS Return Result is sent. + +#### 14.1.4.1.4 gsmSCF-to-gprsSSF messages + +The present subclause defines the normal procedures for TC messages from the gsmSCF to the gprsSSF. + +In the case of overlapping dialogues for the same relationship the gsmSCF opened dialogue is closed by the gprsSSF as specified in subclause 5.7. The gsmSCF shall first respond normally to the operations sent by the gprsSSF, and then decide on the further actions. + +#### *SCME-FSM related messages* + +The operations sent from the SCME-FSM shall be issued according to the following procedures: + +- A new subsequent TC dialogue is established when the ActivityTestGPRS operation is sent. + +#### 14.1.4.2 Abnormal procedures + +##### 14.1.4.2.1 gsmSCF-to-gprsSSF messages + +The present subclause defines the abnormal procedures for TC messages from the gsmSCF to the gprsSSF. + +Considering that the gprsSSF does not have the logic to recover from error cases detected on the gsmSCF-gprsSSF interface, the following shall apply: + +- Operation errors and rejection of TC components shall be transmitted to the gprsSSF with a TC-END request primitive, basic end. +- The GPRS dialogue shall be closed. +- The gprsSSF shall apply Default GPRS Handling from the valid CSI to the PDP Context or GPRS Session. + +If, in violation of the above procedure, an ERROR or REJECT component is received with a TC-CONTINUE indication primitive, then the gprsSSF shall abort the dialogue with a TC-U-ABORT request primitive and shall apply Default GPRS Handling from the valid CSI to the PDP Context or GPRS Session. + +##### 14.1.4.2.2 gprsSSF-to-gsmSCF messages + +The present subclause defines the abnormal procedures for TC messages from the gprsSSF to the gsmSCF. + +Operation errors and rejection of TC components shall be transmitted to the gsmSCF according to the following rules: + +- The TC dialogue shall be maintained when the preceding message, which contained the erroneous component, indicated that the dialogue shall be maintained. I.e. the error or reject shall be transmitted with a TC-CONTINUE request primitive. +On receipt of an ERROR or REJECT component the gsmSCF decides on further processing. It may either continue, explicitly end or abort the TC dialogue. If the TC dialogue is closed due to such error, then the GPRS dialogue shall also be closed. +- on expiration of application timer Tssf, the TC dialogue shall be terminated by means of by TC-U-ABORT primitive with an Abort reason. The GPRS dialogue shall be closed. + +If the error processing in the gprsSSF leads to the case where the gprsSSF is not able to process further gsmSCF operations while the TC dialogue is to be maintained, then the gprsSSF aborts the TC dialogue with a TC-END request + +primitive with basic end or a TC-U-ABORT request primitive, depending on whether any pending ERROR or REJECT component is to be sent or not. + +The gprsSSF can end a TC dialogue with a TC-U-ABORT request primitive in the following case: + +- Any entity other than the gsmSCF initiates closure of the GPRS dialogue, and +- The gprsSSF has no pending reports, and +- The gprsSSF has no armed EDP to notify the gsmSCF that the GPRS dialogue has been closed. + +For an alternative method, see subclause 14.1.7.1.1. + +#### 14.1.4.2.3 Default GPRS Handling + +If a TC dialogue is closed due to unrecoverable TC/protocol error (does not apply to the overlapping TC dialogues), or aborted by the gsmSCF, or at the Tssf expiry, then the gprsSSF shall check the applicable Default GPRS Handling parameter of the GPRS-CSI. In this context the applicable Default GPRS Handling is the one that corresponds the TDP that opened the GPRS dialogue. The same default handling shall apply to all state models that are controlled by the particular GPRS dialogue. + +## 14.2 Services assumed from SCCP + +The present subclause describes the services required from the SCCP that may be used by the CAMEL applications for the CAMEL Application Part (CAP) used between the gsmSSF, assisting gsmSSF, gsmSRF, gprsSSF, and gsmSCF. + +The following SCCP revisions are supported by CAP: + +- Signalling Connection Control Part, Signalling System no. 7 CCITT ("Blue Book SCCP") +- Signalling Connection Control Part, Signalling System no. 7 ITU-T Recommendation Q.711 to Q.716 ("White Book SCCP") + +NOTE: Support of White Book SCCP at the receiving side shall be mandated from 00:01hrs, 1st July 2002(UTC). + +- ANSI T1.112-1996 [91]: "American National Standards for Telecommunications– Signalling System Number 7 (SS7) – Signalling Connection Control Part (SCCP)". + +When CAP uses White Book SCCP to send a message, and SCCP segments the message into one or more XUDT messages, then the transmission of this message may fail. + +Failure will occur when the destination SCCP, or any intermediate SCCP, does not support White Book SCCP. + +Support of ANSI T1.112-1996 [91] SCCP applies to PLMNs in North America only. Interworking between a PLMN in North America and a PLMN outside North America will involve a STP to translate between ANSI SCCP and ITU-T/CCITT SCCP. + +### 14.2.1 Normal procedures + +The SCCP forms the link between the TC and the MTP and provides (in conjunction with the MTP) the network services for the CAMEL applications. The network services provided allow the signalling messages sent by the application to the lower layers to be successfully delivered to the peer application. + +### 14.2.2 Service functions from SCCP + +#### 14.2.2.1 SCCP connectionless services + +The services described are those given in the SCCP ITU-T recommendations Q.711 to Q.716 should be consulted to identify possible interworking and compatibility issues between the different SCCP versions. + +The following Connection-less services are expected from the SCCP: + +- a) Network Addressing to enable signalling connections between SCCP users; + +- b) Sequence Control to enable the SCCP users to invoke "sequence guaranteed" or "sequence not guaranteed" options for a given stream of messages to the same destination; +- c) Segmentation/reassembly of large user messages (for "White Book SCCP" only); +- d) Return Option to enable the SCCP users to invoke "discard message on error" or "return message on error" for a given message not able to be delivered by the SCCP to the destination SCCP user, due to routeing or segmentation/re-assembly failure; +- e) Congestion control. + +The primitives used for the above services are given below. + +The N-UNITDATA request and N-UNITDATA indication primitives are used to send and receive data. The parameters of these primitives include the Called and Calling Addresses, Sequence Control, Return Option and User Data with the addressing parameters always mandatory. + +The N-NOTICE indication primitive is used to return undelivered data if return option is set and a routeing/segmentation error occurs. + +#### 14.2.2.1.1 Sub-System Number (SSN) + +The use of SSN is a network operator option and values for intra-PLMN usage are network specific. A CAP SSN has been reserved for inter-PLMN use, as defined in 3GPP TS 23.003 [5]. + +#### 14.2.2.1.2 Addressing + +The addressing elements consist of information contained within the Calling and the Called Party Addresses which are sent by the application to the lower layers. + +The application expects the SCCP to route messages by either (a) the use of the Destination Point Code (DPC) plus the Subsystem Number (SSN), or (b) the use of the GT plus optionally the SSN. The application also specifies to the lower layer whether to route the message on the DPC or the GT. + +Method (a) above may be used when the application is aware of the destination point code and the destination SSN located at that point code to which the message is to be delivered. Within a national network different SSNs, according to ITU-T Recommendation Q.713 [42], may be allocated for the different network specific applications, e.g. a SSN may be allocated for a gsmSCF functionality. + +Method (b) above may be used when a message is to be delivered to a SCCP-user which can be identified by the combination of the elements within the GT. An example of the use of this method is when messages have to be delivered between different networks. This method may be used since the originating network is unaware of the point code and SSN's allocations within the destination network. The network that determines the end-node to which the message is to be delivered has to perform a GT Translation to derive the destination Point Code and the SSN. If optionally the original address contained the SSN, then this may be used as the destination SSN, or the translation may, if required, provide an appropriate new SSN. + +When GT is used for addressing, the CAMEL application expects that the SCCP supports the following elements as defined in ITU-T Recommendation Q.713 [42]: + +##### *Address Indicator:* + +The application will set this indicator to indicate one or any combination of the elements "signalling point code, GT, subsystem number" in the address information octets. + +##### *GT Indicator:* + +This indicator specifies the method employed for the formatting of the address information. There are four values (1 to 4), for example, the value 4 indicates that the format includes the numbering plan, the nature of the address indicator and the translation type. The format with the indicator value 4 is always used for internetwork connections. + +##### *Translation Type:* + +The Translation Types are defined within ITU-T Recommendation Q.713 [42]. + +*Numbering Plan:* + +- 1) The *proposed* "generic numbering plan" is described within the ITU-T Recommendation Q.713 [42]. This numbering plan identifies the SCCP nodes or SCCP subsystems unambiguously such that messages may be efficiently routed within one or more networks, and is particularly useful when used in the Calling Address for the sending of a response message back to the originating node. This is achieved by having an international and a national part in the generic numbering plan. For response messages the responding node analyses the international part of the generic numbering plan to determine the gateway node to which the response is to be routed. Having routed to the gateway node, the national part (which was populated within the originating network) is analysed to determine the originating node within the originating network. +- 2) A numbering plan which would define particular nodes based specifically on services is outside the scope of CAMEL. +- 3) The SCCP caters for a number of other numbering plans (e.g. ISDN, Mobile etc. numbering plans). The whole range catered for is shown in [?]. These may be used by CAMEL applications if deemed suitable. + +*Encoding Scheme:* + +This identifies the encoding scheme employed by the application and is generally BCD encoded with odd or even number of digits. + +*GT Address Information:* + +These are the actual address digits supplied by the application and may be BCD digits or encoded as indicated by the encoding scheme. + +The network provider must ensure that any change of GT value during translation preserves any CAP specific information contained in the initial GT value. + +This requirement applies to all interfaces, not just those used for internetworking. + +If *route on SSN* is to be supported from the originating node, then an ITU-T non-zero internationally standardised SSN is required for international internetworking. + +In the absence of a ITU-T standardised non-zero SSN for CAP services, the use of *route on GT* is mandatory from the origin node to the network containing the destination node. + +When the SCCP of CCITT Signalling System No. 7 is used, the format and coding of address parameters carried by the SCCP for that purpose shall comply with ITU-T Recommendation Q.713 [42] with the following restrictions: + +- 1) Intra-PLMN addressing + +For communication between entities within the same PLMN, the use of SCCP addressing is network specific, and method (a) and (b) are both applicable. + +- 2) Inter-PLMN addressing + +method (b) with the mandatory SSN is applicable only with the following format: + +- i) Called Party Address + +- SSN indicator = a standardised SSN shall be used. The SSN used shall be that specified for CAP in 3GPP TS 23.003 [5]; +- Point Code indicator = 0; +- Global title indicator = 0100 (Global title includes translation type, numbering plan, encoding scheme and nature of address indicator); +- Translation type = 0 (Not used); +- Routing indicator = 0 (Routing on global title); + +The format is also described in the table 14-2 below (for NP=1, NAI=4): + +**Table 14-2: Called Party Address format** + +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +|----------------------------------------------------------|-------------------------------------------------|----------------|---|-----------------------------------|---|----------|---------|----------| +| 0 | RI = 0 | GTI = 4 (0100) | | | | SSNI = 1 | PCI = 0 | Octet 1 | +| SSN = a value for CAP as specified in 3GPP TS 23.003 [5] | | | | | | | | Octet 2 | +| Translation type = 0 | | | | | | | | Octet 3 | +| Numbering plan = 1 (E.164) | | | | Encoding scheme = 1 or 2 | | | | Octet 4 | +| 0 | Nature of address indicator = 4 (International) | | | | | | | Octet 5 | +| Country code digit 2 (if present) | | | | Country code digit 1 | | | | Octet 6 | +| National Destination Code (NDC) Digit 1 | | | | Country code digit 3 (if present) | | | | Octet 7 | +| NDC digit 3 (if present) | | | | NDC digit 2 (if present) | | | | Octet 8 | +| NDC digit 5 (if present) | | | | NDC digit 4 (if present) | | | | Octet 9 | +| Equipment identification digit 2 | | | | Equipment identification digit 1 | | | | Octet 10 | +| ... | | | | ... | | | | ... | +| filler = 0 (if needed) | | | | Equipment identification digit m | | | | Octet n | + +Note Country code, National Destination Code, and SN(equipment id) are provided as example, so each digit may differ for each Inter-PLMN addressing case. (e.g., there is a case where only CC digit 1 shall be used). See ITU-T Recommendation Q.713 [42] for translation rules. + +## ii) Calling Party Address + +- SSN indicator = a standardised SSN shall be used. The SSN used shall be that specified for CAP in 3GPP TS 23.003 [5]; +- Point code indicator = 0; +- Global title indicator = 0100 (Global title includes translation type, numbering plan, encoding scheme and nature of address indicator); +- Translation type = 0 (Not used); +- Routing indicator = 0 (Routeing on Global Title). + +The format is also described in the table 14-3 below (for NP=1, NAI=4): + +**Table 14-3: Calling Party Address format** + +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +|----------------------------------------------------------|-------------------------------------------------|---------|---|-----------------------------------|---|----------|---------|----------| +| 0 | RI = 0 | GTI = 4 | | | | SSNI = 1 | PCI = 0 | Octet 1 | +| SSN = a value for CAP as specified in 3GPP TS 23.003 [5] | | | | | | | | Octet 2 | +| Translation type = 0 | | | | | | | | Octet 3 | +| Numbering plan = 1 (E.164) | | | | Encoding scheme = 1 or 2 | | | | Octet 4 | +| 0 | Nature of address indicator = 4 (International) | | | | | | | Octet 5 | +| Country code digit 2 (if present) | | | | Country code digit 1 | | | | Octet 6 | +| National Destination Code (NDC) Digit 1 | | | | Country code digit 3 (if present) | | | | Octet 7 | +| NDC digit 3 (if present) | | | | NDC digit 2 (if present) | | | | Octet 8 | +| NDC digit 5 (if present) | | | | NDC digit 4 (if present) | | | | Octet 9 | +| Equipment identification digit 2 | | | | Equipment identification digit 1 | | | | Octet 10 | +| ... | | | | ... | | | | ... | +| Filler = 0 (if needed) | | | | Equipment identification digit m | | | | Octet n | + +Note Country code, National Destination Code, and SN(equipment id) are provided as example, so each digit may differ for each Inter-PLMN addressing case. (e.g., there is a case where only CC digit 1 shall be used). See ITU-T Recommendation Q.713 [42] for translation rules. + +When the SCCP of ANSI Signalling System No. 7 is used, the format and coding of address parameters carried by the SCCP for the purpose of signalling transfer shall comply with ANSI Recommendation T1.112-1996 [91] with the following restrictions: + +## 1) Intra-PLMN addressing + +For communication between entities within the same PLMN, the use of SCCP addressing is network specific. + +## 2) Inter-PLMN addressing + +### a) Called Party Address + +- SSN indicator = a standardised SSN shall be used. The SSN used shall be that specified for CAP in 3GPP TS 23.003 [5]; +- Point Code indicator = 0; +- Global title indicator = 0010 (Global title includes translation type); +- the Translation Type (TT) field shall be coded according to the content of the address information as follows: + - TT = 9 (decimal), if IMSI is included; or + - TT = 14 (decimal), if MSISDN is included; or + - TT = 10 (decimal), if a Network Element address is included. (If TT=10, then Number Portability is not applicable, if TT=14, then Number Portability is applicable) +- Routing indicator = 0 (Routeing on global title); + +### b) Calling Party Address + +- SSN indicator = a standardised SSN shall be used. The SSN used shall be that specified for CAP in 3GPP TS 23.003 [5]; +- Point code indicator = 0; +- Global title indicator = 0010 (Global title includes translation type); +- the Translation Type (TT) field shall be coded according to the content of the address information as follows: + - TT = 9 (decimal), if IMSI is included; or + - TT = 14 (decimal), if MSISDN is included; or + - TT = 10 (decimal), if a Network Element address is included. (If TT=10, then Number Portability is not applicable, if TT=14, then Number Portability is applicable) +- Routing indicator = 0 (Routeing on Global Title). + +### 14.2.2.1.3 Sequence control + +The application will specify whether SCCP protocol class 0 or 1 is required. Class 0 provides a basic connection-less service where the sequence of message delivery is not guaranteed. Class 1 connection-less service provides a guaranteed sequence delivery of messages (with the same called address) for a given stream of messages. Class 1 shall be requested by any application that can send more than 1 TC message to its peer (consecutive TR-CONTINUE) before receiving a response from its peer (TR-CONTINUE or TR-END). + +On receipt of a TC-RESULT-NL indication, the TC-USER shall request the transfer of a reject component using TC-U-REJECT request primitive, with the appropriate problem code (mistyped parameter). + +The return option may be used if requested by the application (Network Operator to determine). + +### 14.2.2.1.4 Return on error + +Return on Error mechanism may be required by the CAMEL applications such that the application is aware of messages that have not been delivered to the destination by the SCCP. The return option allows the return of the message that was not delivered due to routeing or segmentation/re-assembly failure back to the issuing user. This return option may be required in all segments of a long message or only in the first segment by the CAMEL applications. + +If the return option is invoked by the application and the message is not delivered, then the SCCP specifies the "return reason" as specified in ITU-T Recommendation Q.713 [42]. The N-NOTICE primitive is used to return the undelivered message to the originating user. + +#### 14.2.2.1.5 Segmentation / reassembly + +The application expects that since the SCCP can send up to 260 octets of user data (including the address information and TC-message) in a UDT message (248 octets in a XUDT message performing segmentation and congestion control), segmentation is available for long user messages. + +Also the SCCP is expected to perform the reassembly function on received segmented messages and deliver the reassembled message to the user. + +However, it should be noted that even though the theoretical maximum size of SCCP-user data and addresses that can be segmented by the SCCP is 3 968 octets, the SCCP-user would limit the length to about 2 560 octets to allow for the largest known addresses. Note that the application must also allow for the octets used for the TC-message in the 2 560 octets. + +The CAMEL application does not expect the SCCP to segment the long message into more than 16 segments. + +#### 14.2.2.1.6 Congestion control + +To help control of possible congestion that might occur in the lower layers the application may assign a value to indicate the importance of the message. The use of this parameter requires the use of SCCP (1997) ITU-T Recommendations. + +Also there exist other congestion control mechanisms as indicated below in SCCP Management. + +These congestion control methods are network operator option in the case of intra-PLMN network signalling, and shall not be used in the case of inter-PLMN network signalling. + +#### 14.2.2.2 SCCP connection oriented services + +The use by CAMEL applications for the Connection-oriented services is outside the scope of CAMEL. + +#### 14.2.2.3 SCCP management + +The subsystems used within the CAMEL application expect the SCCP to provide management procedures to maintain network performance by re-routeing in the event of failure of a subsystem, and in the case of network congestion by use of the congestion handling procedure. These procedures have appropriate interactions with the SCCP user as described in ITU-T Recommendations Q.713 [42] and ITU-T Recommendation Q.714 [43]. + +To achieve the above the SCCP is expected to perform the following procedures: + +- Signalling point status management (which include the signalling point prohibited, signalling point allowed, signalling point congested, and local MTP availability sub procedures). +- Subsystem status management (which include the subsystem prohibited, subsystem allowed, and subsystem status test sub procedures). +- Co-ordinated state change (a procedure which allows a duplicated subsystem to be withdrawn from service without affecting the performance of the network). + +These SCCP management procedures are network operator option in the case of intra-PLMN network signalling, and shall not be used in the case of inter-PLMN network signalling. + +## Annex A (normative): Mapping between CAP and ISUP + +### A.1 InitialDP operation + +Table A.1 + +| ISUP message
IAM (Note 1) | CAP Operation
InitialDP | +|-----------------------------------------------------------------------------------------------|---------------------------------------------------------------------| +| Called party number (note 6) | CalledPartyNumber | +| Calling party number | CallingPartyNumber | +| Calling party's category | CallingPartysCategory | +| Location number | LocationNumber | +| Original called number | OriginalCalledPartyID | +| User teleservice information (1 st priority) | HighLayerCompatibility | +| High layer compatibility IE contained in access transport (2 nd priority) (Note 2) | | +| High layer compatibility IE contained in access transport (Note 2) | HighLayerCompatibility2 | +| Low Layer compatibility IE contained in access transport (note 4) | LowLayerCompatibility | +| Low Layer compatibility IE contained in access transport (note 4) | LowLayerCompatibility2 | +| Generic number "additional calling party number" | AdditionalCallingPartyNumber | +| User service information prime (1 st priority) | BearerCapability | +| User service information (2 nd priority) (Note 3) | | +| User service information (Note 3) | BearerCapability2 | +| Redirecting number | RedirectingPartyID | +| Redirection information | RedirectionInformation | +| Call diversion treatment indicators | ServiceInteractionIndicatorsTwo.Call diversion treatment indicators | +| Conference treatment indicators | ServiceInteractionIndicatorsTwo.Conference treatment indicators | +| User-to-user indicators (Note 5) | UU-Data.UUIndicator | +| User-to-user information (Note 5) | UU-Data.UUI | + +NOTE 1: Optional parameters may be absent, i.e. they are only mapped only if these parameters are available at the DP. + +NOTE 2: If two high layer compatibility information elements are contained in the access transport parameter, then the second information element, carrying the preferred HLC, is mapped to the CAP highLayerCompatibility parameter, and the first information element, carrying the less preferred HLC, is mapped to the CAP highLayerCompatibility2 parameter. + +NOTE 3: If User service information prime and User service information are present, then one of the following two mapping rules shall be applied. The principles for the choice of mapping rule are specified in 3GPP TS 23.078 [7]. + +- One of User service information prime or User service information is mapped to Bearer Capability. +- User service information prime is mapped to BearerCapability and User service information is mapped to Bearer Capability2. + +NOTE 4: If two low layer compatibility information elements are contained in the access transport parameter, then the first information element, carrying the preferred LLC, is mapped to the CAP lowLayerCompatibility parameter, and the second information element, carrying the less preferred LLC, is mapped to the CAP lowLayerCompatibility2 parameter. + +NOTE 5: If present in ISUP IAM, user-to-user indicators and user-to-user information may optionally be mapped into the InitialDP Operation. + +NOTE 6: For trunk originating calls using overlap signalling, the called party number may contain partial address digits. + +## A.1.1 EventReportBCSM Operation + +Table A.1.1 + +| ISUP message
SAMs (Note 1) | CAP Operation
EventReportBCSM | +|-------------------------------|----------------------------------| +| Subsequent number | CalledPartyNumber | + +NOTE 1: For trunk originating calls using overlap signalling, subsequent address digits may be reported to the gsmSCF in EventReportBCSM, if requested by the gsmSCF with the 'Collect Information' operation. + +## A.2 ContinueWithArgument operation + +Table A.2 illustrates the mapping of parameters received in the ContinueWithArgument operation to parameters sent in the ISUP IAM to the succeeding exchange. All parameters which were received in the ISUP IAM and which are not replaced by parameters mapped from the ContinueWithArgument operation, shall be treated (and propagated to the succeeding exchange) according to the normal procedures. Propagation of ISUP parameters and mapping of parameters according to Table A.2 applies also for CWA when used to set up a new party leg in an existing call, except when the existing call is a NC call, in which case only mapping of parameters according to Table A.2 applies. The rule of copying ISUP parameters received from incoming leg to NP leg is valid also when the incoming leg no longer exists. + +For trunk originating calls using overlap signalling, the called party number in ISUP IAM may contain partial address digits. Any address digits received in SAMs, before the ISUP IAM is sent out, may also be included in the called party number parameter. Any address digits received in SAMs, after the ISUP IAM is sent out and before an ISUP ACM is received, shall be passed on to the succeeding exchange as received. + +On sending of the ISUP IAM the awaiting address complete timer is started. If the timer expires, then the call is released in both directions and an appropriate indication is returned to the calling subscriber. + +Table A.2 + +| CAP Operation ContinueWithArgument (Note 1) | ISUP message IAM | +|---------------------------------------------|-------------------------------------------| +| callingPartysCategory | Calling party's category | +| genericNumbers | Generic number (Note 2) | +| serviceInteractionIndicatorTwo | See Table A.4 | +| cug-Interlock | Closed user group interlock code | +| cug-OutgoingAccess | Optional forward call indicators (Note 3) | + +NOTE 1: Optional parameters may be absent, i.e. they are mapped only if received. + +NOTE 2: The set of generic numbers received in the genericNumbers parameter is mapped to the appropriate number of Generic Number parameters in the ISUP IAM. This shall be performed irrespective of the value of the screening indicator in the ISUP calling party number. + +NOTE 3: The cug-OutgoingAccess is mapped to the Closed User Group indicator which is carried in bits A & B of the Optional forward call indicators. + +## A.3 Connect operation + +On receipt of a Connect operation from the gsmSCF the called party number used for routing is derived from the destinationRoutingAddress (see Table A.3). If the triggering of the CAMEL service was made for a mobile terminating call in the GMSC or VMSC or for a mobile forwarded call, then an ISUP ACM shall be sent to the preceding exchange. The encoding of the backward call indicators in the ISUP ACM is specified in 3GPP TS 09.12 [1]. + +On receipt of a Connect operation from the gsmSCF for a trunk originating call, the called party number used for routing is derived from the destinationRoutingAddress (see Table A.3) and an ISUP ACM is sent to the preceding exchange (in an overlap signalling scenario this will prevent any further SAMs being sent by the preceding exchange). + +Table A.3 illustrates the mapping of parameters received in the Connect operation to parameters sent in the ISUP IAM to the succeeding exchange. Parameters which were received in the ISUP IAM and are not replaced by parameters of the Connect operation are treated according to the normal procedures. + +On sending of the ISUP IAM the awaiting address complete timer is started. If the timer expires, then the call is released in both directions and an appropriate indication is returned to the calling subscriber. + +**Table A.3** + +| CAP Operation
Connect (Note 1) | ISUP message
IAM | +|-----------------------------------|-------------------------------------------| +| DestinationRoutingAddress | Called party number | +| OriginalCalledPartyID | Original called number | +| callingPartysCategory | Calling party's category | +| redirectingPartyID | Redirecting number | +| redirectionInformation | Redirection information | +| GenericNumbers | Generic number (Note 2) | +| ServiceInteractionIndicatorTwo | See Table A.4 | +| Cug-Interlock | Closed user group interlock code | +| cug-OutgoingAccess | Optional forward call indicators (Note 3) | + +NOTE 1: Optional parameters may be absent, i.e. they are mapped only if received. + +NOTE 2: The set of generic numbers received in the genericNumbers parameter is mapped to the appropriate number of Generic Number parameters in the ISUP IAM. This shall be performed irrespective of the value of the screening indicator in the ISUP calling party number. + +NOTE 3: The cug-OutgoingAccess is mapped to the Closed User Group indicator which is carried in bits A & B of the Optional forward call indicators. + +Table A.4 – Mapping of the CAP Connect and ContinueWithArgument operation serviceInteractionIndicatorsTwo to ISUP. + +Table A.4 + +| CAP
ServiceInteractionIndicators | ISUP parameter in | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | ACM/CPG/CON/ANM/REL | IAM | +| Call to be diverted indicator
– call diversion allowed
– call diversion not allowed | --- | Call diversion treatment indicators parameter
Call to be diverted indicator
– no indication
– call diversion allowed
– call diversion not allowed | +| Conference at DLE accept. ind.
– accept conference request
– reject conference request | --- | Conference treatment indicators parameter
Conference acceptance ind.
– no indication
– accept conference request
– reject conference request | +| Calling party restriction indicator
– no IN impact
– presentation restricted | --- | Calling party number address presentation restricted indicator
– no impact
– presentation restricted | +| Conference at OLE accept. ind.
– accept conference request
– reject conference request | ACM/CPG/CON/ANM: Conference treatment indicators parameter
Conference acceptance ind.
– no indication
– accept conference request
– reject conference request | --- | +| Call completion treatment indicator
– accept CCBS service request
– reject CCBS service request | REL, busy cause
Diagnostig field
– CCBS possible
– CCBS not possible | --- | +| Connected number treatment indicator
– no IN impact
– presentation restricted
– present called IN number
– present called IN number restricted | Note 3 | | + +## NOTE 3: + +If "no IN impact" was received for Connected number treatment indicator in the serviceInteractionIndicatorsTwo, then a connected number parameter and a generic number parameter "additional connected number" are passed on unchanged. + +If "presentation restricted" was received for Connected number treatment indicator in the serviceInteractionIndicatorsTwo, then: + +- If a connected number parameter has been received in the ISUP ANM or ISUP CON, then the address presentation restricted indicator is set to "presentation restricted". +- If a generic number parameter "additional connected number" has been received in the ISUP ANM or ISUP CON, then the address presentation restricted indicator is set to "presentation restricted". +- If a redirection number parameter has been received, then a redirection number restriction parameter is sent in the ISUP ANM with bits AB set to "presentation restricted". + +If "present called IN number" was received for Connected number treatment indicator in the serviceInteractionIndicatorsTwo, then: + +- If a connected number parameter has been received in the ISUP ANM or ISUP CON, then the connected number parameter is modified as follows: + +nature of address indicator and numbering plan indicator are encoded as received in the called party number of the ISUP IAM, + +address presentation restricted indicator: 00 (presentation allowed), + +address signals:as received in the called party number and possible subsequent number parameters, until the ISUP ACM was sent. + +- b) A generic number parameter "additional connected number" is deleted from the message, if applicable, +- c) A redirection number parameter is deleted from the relevant messages, if applicable. + +If "present called IN number restricted" was received for Connected number treatment indicator in the serviceInteractionIndicatorsTwo, then: + +- a) If a connected number parameter has been received in the ISUP ANM or ISUP CON, then the connected number parameter is modified as follows: + +nature of address indicator and numbering plan indicator are encoded as received in the called party number of the ISUP IAM, + +address presentation restricted indicator: 01 (presentation restricted), + +address signals:as received in the called party number and possible subsequent number parameters, until the ISUP ACM was sent. + +- b) A generic number parameter "additional connected number" is deleted from the message, if applicable, +- c) A redirection number parameter is deleted from the relevant messages, if applicable. + +--- + +## A.4 AssistRequestInstructions operation + +If an ISUP IAM is received at an assisting SSP containing an assisting gsmSSF or at an IP containing a gsmSRF, then an AssistRequestInstructions operation is sent to the gsmSCF. The correlationID parameter in the AssistRequestInstructions operation can contain: + +- a) the CorrelationID digits extracted from the ISUP IAM Called Party Number, +- b) the whole Called Party Number received in the ISUP IAM (CorrelationID digits extracted at gsmSCF), +- c) the contents of the ISUP IAM CorrelationID parameter. + +In the case where the gsmSCF and the assisting gsmSSF are both in the HPLMN and ISUP 97 is supported then any of these mechanisms may be used. + +In the case where the gsmSCF and the assisting gsmSSF are both in the HPLMN and ISUP 97 is not supported then mechanisms a) and b) may be used. + +In the case where the gsmSCF is in the HPLMN and the assisting gsmSSF is in the VPLMN then only mechanism b) may be used when an all-ISUP 97 signalling path cannot be guaranteed. Mechanism a) may be used if bilateral agreements on the format of the information transferred in the ISUP IAM Called Party Number are defined between the HPLMN and the VPLMN. + +In the case where the gsmSCF is in the HPLMN and the assisting gsmSSF is in the VPLMN then mechanism c) may only be used if an all-ISUP 97 signalling path can be guaranteed between the HPLMN and the VPLMN. + +--- + +## A.5 ConnectToResource operation + +On receipt of a ConnectToResource operation from the gsmSCF, the gsmSRF is connected to the call, to facilitate User Interactive dialogue with the user. + +If the User Interactive dialogue is to be performed at a forwarding MSC or at a terminating MSC (GMSC or VMSC), then an ISUP ACM shall be sent to the preceding exchange. The encoding of the backward call indicators in the ISUP ACM is specified in 3GPP TS 09.12 [1], with the Optional Backward Call Indicators indicating "in-band information or an appropriate pattern is now available". + +If the User Interactive dialogue is to be performed at a forwarding MSC or at a terminating MSC (GMSC or VMSC), then when the gsmSRF indicates through-connection and the ConnectToResource operation indicates that a bothway + +throughconnection is required, an ISUP ANM shall be sent to the preceding exchange if answer has not previously been sent. As a network operator/equipment vendor option an ISUP CPG message may be sent if ISUP ANM has already been sent. + +## A.6 EstablishTemporaryConnection operation + +On receipt of an EstablishTemporaryConnection operation from the gsmSCF then if the triggering of the CAMEL service was made for a mobile terminating call in the GMSC or VMSC or for a forwarded call, then an ISUP ACM shall be sent to the preceding exchange. The encoding of the backward call indicators in the ISUP ACM is specified in 3GPP TS 09.12 [1]. In addition, an ISUP IAM shall be sent to the succeeding exchange. + +Table A.5 illustrates the mapping of parameters received in the EstablishTemporaryConnection operation to parameters sent in the ISUP IAM to the succeeding exchange. On sending of the ISUP IAM the awaiting address complete timer is started. If the timer expires, then the call is released in both directions and an appropriate indication is returned to the calling subscriber. + +**Table A.5** + +| CAP Operation
EstablishTemporaryConnection | ISUP message
IAM | +|-----------------------------------------------|---------------------------------| +| AssistingSSPIPRoutingAddress (note 1) | Called party number | +| CorrelationID | Correlation id (note 2) | +| ScfId | GsmSCF id (note 2) | +| OriginalCalledPartyID | Original called number (note 3) | +| CallingPartyNumber | Calling party number (note 3) | + +NOTE 1: The AssistingSSPIPRoutingAddress parameter may also include a Hex B digit, in order to delineate the boundary between digits used for routing and digits forming part of the SCFiD and/or CorrelationID. + +NOTE 2: These optional parameters may be absent, i.e. they are mapped only if received. If they are received and cannot be mapped, then an error is sent to the gsmSCF as detailed in clause 11. + +NOTE 3: These optional parameters may be absent, i.e. they are mapped only if received. + +Except for the Called Party Number the remaining mandatory ISUP IAM parameters are set as follows: + +a) Nature of connection indicators + +Satellite indicator: set as in an Originating MSC, + +Continuity check indicator: set as in Originating MSC, + +Echo control device indicator: set as in Originating MSC + +b) Forward Call Indicators + +National/international call indicator: set as in Originating MSC, + +End-to-end method indicator: 00 (no end-to-end method available), + +Interworking indicator: 0 (no interworking encountered), + +End-to-end information indicator: 0 (no end-to-end information available), + +ISDN User Part indicator: 1 (ISDN User Part used all the way), + +ISDN User Part preference indicator: 00 (ISDN User Part preferred all the way), + +ISDN access indicator: 0 (originating access non-ISDN), + +SCCP method indicator: 00 (no indication) + +c) Calling Party's Category + +00001010 (ordinary subscriber) + +d) Transmission Medium Requirement + +00000011 (3.1 kHz audio) + +The ISUP IAM optional parameter Propagation Delay Counter is set as in an Originating MSC. + +## A.7 ReleaseCall operation + +Upon receipt of the ReleaseCall operation, the GMSC/gsmSSF (VMSC/gsmSSF) sends REL messages in both directions. The cause indicators parameter contains the releaseCallArg parameter of the ReleaseCall operation. + +## A.8 InitiateCallAttempt operation + +On receipt of an InitiateCallAttempt operation, the GMSC/gsmSSF or VMSC/gsmSSF prepares to set up a new call leg in an existing call configuration, or to set up a new call, to the destination defined by the DestinationRoutingAddress parameter. The GMSC/gsmSSF or VMSC/gsmSSF does not send the ISUP IAM until it has received a ContinueWithArgument operation, which contains additional information needed to populate the parameters of the ISUP IAM. + +For a new call leg in an existing call, except a NC call, all parameters which were received in the ISUP IAM and which were not replaced by parameters mapped from the InitiateCallAttempt or ContinueWithArgument operation, shall be treated (and propagated to the succeeding exchange) according to the normal procedures. The rule of copying ISUP parameters received from incoming leg to NP leg is valid also when the incoming leg no longer exists. + +Table A.6 illustrates the mapping of parameters received in the InitiateCallAttempt operation to parameters sent in the ISUP IAM to the succeeding exchange. + +**Table A.6** + +| CAP Operation
InitiateCallAttempt (Note 1) | ISUP message
IAM | +|-----------------------------------------------|---------------------------------------------------| +| DestinationRoutingAddress | Called party number | +| CallingPartyNumber | Calling party number | +| | Transmission medium requirement (Note 2) (Note 4) | +| | Access transport (Note 3) (Note 4) | + +NOTE 1: Optional parameters may be absent, i.e. they are mapped only if received. + +NOTE 2: The transmission medium requirement parameter field shall be set to "speech". + +NOTE 3: The "Bearer capability" and "High layer compatibility information" elements shall be filled in accordance with ETSI EN 300 403-1 [25] for speech call. + +NOTE 4: Only the minimum set of parameters indicating the fact that the call is a speech call is described here. + +--- + +## Annex B (normative): Mapping between CAP and MAP and mapping between CAP and SM-CP + +The Short Message signalling between the SMS-GMSC and the MSC or SGSN, for the transport of SM RP-DUs, is specified in 3GPP TS 29.002 [11]. The Short Message signalling between the MSC or SGSN and the MS, for the transport of SM RP-DUs, is specified in 3GPP TS 24.011 [10]. + +--- + +### B.1 Mapping between CAP and MAP + +#### B.1.1 MO-SMS + +##### B.1.1.1 ConnectSMS operation + +The Short Message TPDU is carried by a Short Message RPDU. The RPDU between the MSC or SGSN and the SMS-IWMSC is conveyed in the MAP MO-ForwardSM OPERATION. The MSC or SGSN shall obtain information from CAP OPERATION ConnectSMS and place it in MAP OPERATION MO-ForwardSM. + +**Table B.1** + +| CAP ConnectSMS | MAP MO-ForwardSM ARGUMENT | +|-----------------------------|------------------------------------------------| +| CallingPartysNumber | sm-RP-OA; CHOICE set to msisdn | +| DestinationSubscriberNumber | sm-RP-UI; TP-Destination-Address | +| SMSCAddress | sm-RP-DA; CHOICE set to serviceCentreAddressDA | + +NOTE The encoding of "SignalInfo" in MO-ForwardSM is specified in 3GPP TS 23.040 [6]. + +##### B.1.1.2 EventReportSMS operation + +The MSC or SGSN may receive error information from the SMS-IWMSC, via the MAP OPERATION MO-ForwardSM ERROR. The MSC or SGSN shall obtain the error information from MAP OPERATION MO-ForwardSM and place it in the CAP OPERATION EventReportSMS. + +**Table B.2** + +| CAP EventReportSMS | MAP MO-ForwardSM ERROR | +|--------------------|--------------------------------------------------------------------------------| +| MO_SMS Cause | SM-DeliveryFailure; SM-DeliveryFailureCause; SM-EnumeratedDeliveryFailureCause | + +## B.1.2 MT-SMS + +### B.1.2.1 InitialDPSMS operation (MT-SMS) + +The Short Message TPDU is carried by a Short Message RPDUs. The RPDUs between the SMS-GMSC and the MSC or SGSN is conveyed in the MAP MT-ForwardSM OPERATION ARGUMENT. The MSC or SGSN shall obtain information from the MT-ForwardSM MAP Message and place it in CAP InitialDPSMS. + +Table B.3 + +| CAP InitialDPSMS | MAP MT-ForwardSM ARGUMENT | +|----------------------------|------------------------------------------------------------------------------------------| +| CallingPartysNumber | TP-Originating-Address from SMS-Deliver-TPDU. SMS-Deliver-TPDU is contained in sm-RP-UI. | +| SMSCAddress | sm-RP-OA | +| TPShortMessageSpecificInfo | First OCTET of the TPDU. The TPDU is contained in sm-RP-UI. | +| TPProtocolIdentifier | TP-Protocol-Identifier of the TPDU. The TPDU is contained in sm-RP-UI. | +| TPDataCodingScheme | TP-Data-Coding-Scheme of the TPDU. The TPDU is contained in sm-RP-UI. | +| TPValidityPeriod | TP-Validity-Period of the TPDU. The TPDU is contained in sm-RP-UI. | + +NOTE The encoding of "SignalInfo" in MT-ForwardSM is specified in 3GPP TS 23.040 [6]. + +### B.1.2.2 ReleaseSMS operation (MT-SMS) + +When the MSC or SGSN receives the CAP ReleaseSMS operation, it shall return a RP-ERROR RPDUs to the SMS-GMSC. The RP-ERROR RPDUs between the MSC or SGSN and the SMS-GMSC is conveyed in the MAP MT-ForwardSM OPERATION ERROR. + +Table B.4 + +| CAP ReleaseSMS | MAP MT-ForwardSM ERROR | +|----------------|--------------------------------------------------------------------------------| +| RPCause | SM-DeliveryFailure; sm-DeliveryFailureCause; sm-EnumeratedDeliveryFailureCause | + +## B.2 Mapping between CAP and SM-CP + +### B.2.1 MO-SMS + +#### B.2.1.1 InitialDPSMS operation + +The Short Message TPDU is carried by a Short Message RPDUs. The RPDUs between the MS and the MSC or SGSN is conveyed in the RP-DATA Relay Message. The MSC or SGSN shall obtain information from the RP-DATA Message and place it in CAP InitialDP OPERATION. + +Table B.5 + +| CAP InitialDPSMS ARGUMENT | SM-CP RP-DATA Message | +|-----------------------------|-----------------------------------------------| +| DestinationSubscriberNumber | RP-User Data; TPDU; TP-Destination-Address | +| SMSCAddress | RP-User Data; RP-Destination Address | +| TPShortMessageSpecificInfo | RP-User Data; TPDU; 1 st octet | +| TPProtocolIdentifier | RP-User Data; TPDU; TP-Protocol-Identifier | +| TPDataCodingScheme | RP-User Data; TPDU; TP-Data-Coding-Scheme | +| TPValidityPeriod | RP-User Data; TPDU; TP-Validity-Period-Format | + +## B.2.1.2 ReleaseSMS operation + +When the MSC or SGSN receives the CAP ReleaseSMS operation, it shall return a RP-ERROR RPDUs to the MS. The RP-ERROR RPDUs between the MSC or SGSN and the MS is conveyed in the RP-ERROR Relay Message. The MSC or SGSN shall obtain the RPCause from the CAP ReleaseSMS OPERATION and place it in the RP-ERROR Message. + +**Table B.6** + +| CAP ReleaseSMS ARGUMENT | SM-CP RP-ERROR Message | +|-------------------------|------------------------| +| RPCause | RP-Cause | + +## B.2.2 MT-SMS + +### B.2.2.1 ConnectSMS operation + +When the MSC or SGSN receives the ConnectSMS operation, it shall use the received information to replace data in the Short Message SMS-DELIVER TPDU. The SMS-DELIVER TPDU is carried in a RP-MT-DATA RPDUs. The RP-MT-DATA RPDUs between the MSC or SGSN and the MS is conveyed by the SM-CP CP-Data Message. + +**Table B.7** + +| CAP ConnectSMS | SM-CP RP-DATA Message | +|---------------------|--------------------------------------------| +| CallingPartysNumber | RP-User Data; TPDU; TP-Originating-Address | + +### B.2.2.2 EntReportSMS operation + +When the MSC or SGSN receives the RP-ERROR RPDUs from the MS, it shall send the RP-Cause to the gsmSCF. The RP-ERROR RPDUs between the MS and the MSC or SGSN is conveyed in the RP-ERROR Relay Message. The MSC or SGSN shall obtain the RPCause from the RP-ERROR Message and place it in CAP EventReportSMS. + +**Table B.8** + +| CAP EventReportSMS | SM-CP RP-ERROR Message | +|--------------------------|------------------------| +| EventSpecificInformation | RP-Cause | + +--- + +## Annex C (informative): Change history + +### Comments on CAMEL Phase 4 Rel-6 + +- For Release Rel-6, the version of module CAP-U-ABORT-Data is aligned with the other CAP modules; the module version is increased to version8(7). The increase of module version number does not affect the data type definitions contained within the module. +- CAP Operation "SpecialisedResourceReport" is spelled with a "z" (American spelling) in ASN.1. Therefore, TS 29.078 shall write in the text SpecializedResourceReport with a "z" consistently. +- For consistency purposes, module CAP-GPRS-ReferenceNumber is placed in a separate section. All CAP Modules (starting with BEGIN and ending with END) are specified in a separate section. +- The Rel-5 history overview ("How CAMEL Phase 4 Rel-5 Version 5.0.0 was created") is removed from the Rel-6 version of the present specification. + +| Date | TSG # | TSG Doc. | CR | Re
v | Subject/Comment | New | +|---------|-------|-----------|------|---------|--------------------------------------------------------------------------------------------------|--------| +| 2003-12 | CN#22 | NP-030527 | 332 | 1 | Collective CR for Rel-6 Enhanced Dialled Services | 6.0.0 | +| 2003-12 | CN#22 | NP-030528 | 343 | 1 | Change of position armed with criteria | 6.0.0 | +| 2004-03 | CN#23 | NP-040138 | 350 | 2 | Enhancement of Event Specific Information for DP 'Change of Position' | 6.1.0 | +| 2004-03 | CN#23 | NP-040095 | 352 | 1 | CAMEL4 SCUDIF notification during active call for prepay | 6.1.0 | +| 2004-03 | CN#23 | NP-040096 | 356 | 1 | LLC passes on the gsmSSF - gsmSCF interface | 6.1.0 | +| 2004-03 | CN#23 | NP-040136 | 360 | | Correction to description of Service Interaction Indicators Two parameter | 6.1.0 | +| 2004-03 | CN#23 | NP-040136 | 361 | | Correction to temporary connection establishment | 6.1.0 | +| 2004-03 | CN#23 | NP-040137 | 362 | | Correction to SplitLeg and MoveLeg preconditions | 6.1.0 | +| 2004-03 | CN#23 | NP-040138 | 363 | | Correction to Disconnect Leg preconditions | 6.1.0 | +| 2004-03 | CN#23 | NP-040138 | 364 | | Correction to GPRS protocol definition | 6.1.0 | +| 2004-06 | CN#24 | NP-040249 | 366 | 1 | Enhancement to User Interaction | 6.2.0 | +| 2004-06 | CN#24 | NP-040249 | 367 | 1 | Adding missing ROS Object Identifier | 6.2.0 | +| 2004-06 | CN#24 | NP-040207 | 370 | 1 | Mapping between ICA and IAM | 6.2.0 | +| 2004-06 | CN#24 | NP-040207 | 371 | | Correction to Tssf timer | 6.2.0 | +| 2004-06 | CN#24 | NP-040207 | 372 | | Correction to ERB pre-condition for gsmSSF FSM state | 6.2.0 | +| 2004-06 | CN#24 | NP-040207 | 374 | 2 | Correction to Move Leg pre-condition | 6.2.0 | +| 2004-06 | CN#24 | NP-040249 | 375 | | Correction to First Digit Timer for Prompt&Collect | 6.2.0 | +| 2004-09 | CN#25 | NP-040405 | 380 | | Support of User-to-User Information (UUI) in CAMEL InitialDP operation | 6.3.0 | +| 2004-09 | CN#25 | NP-040397 | 382 | 2 | Clarification on the handling of operation invocation when LinkedID is missing although expected | 6.3.0 | +| 2004-09 | CN#25 | NP-040406 | 383 | | Correction to usage of ACM for CAP ETC and CAP CTR | 6.3.0 | +| 2004-09 | CN#25 | NP-040406 | 384 | | Correction to Cancel procedure description | 6.3.0 | +| 2004-09 | CN#25 | NP-040406 | 385 | | Correction to SplitLeg ASN.1 description | 6.3.0 | +| 2004-09 | CN#25 | NP-040406 | 386 | | Correction to Apply Charging Report procedure | 6.3.0 | +| 2004-09 | CN#25 | NP-040406 | 387 | | Correction to Assist Request Instructions procedure | 6.3.0 | +| 2004-09 | CN#25 | NP-040406 | 388 | | Correction to Call Information Request and Report | 6.3.0 | +| 2004-09 | CN#25 | NP-040406 | 389 | | Correction to Tssf timer setting for SMS control | 6.3.0 | +| 2004-12 | CN#26 | NP-040544 | 390 | | Correction of wrong TS numbers in references | 6.4.0 | +| 2005-06 | CT#28 | CP-050103 | 392 | 1 | Additions to CAP for trunk originated services | 7.0.0 | +| 2005-09 | CT#29 | CP-050312 | 393 | 1 | Additions and clarifications to CAP for trunk originated services | 7.1.0 | +| 2005-12 | CT#30 | CP-050626 | 0396 | 1 | Support of an Operation Arg and Errors for CollectInformation | 7.2.0 | +| 2006-06 | CT#32 | CP-060311 | 0397 | 1 | Addition of information related to service change | 7.3.0 | +| 2007-09 | CT#37 | CP-070540 | 0399 | 2 | AC/ACR Handling | 7.4.0 | +| 2007-09 | CT#37 | CP-070540 | 0400 | | QoS Extension | 7.4.0 | +| 2008-12 | CT#42 | | | | Upgraded unchanged from Rel-7 | 8.0.0 | +| 2009-09 | CT#45 | CP-090523 | 0407 | | Correction to InvokeID syntax definition | 8.1.0 | +| 2009-12 | CT#46 | | | | Upgraded unchanged from Rel-8 | 9.0.0 | +| 2010-03 | CT#47 | CP-100029 | 0409 | 1 | User CSG Information for CAMEL | 9.1.0 | +| 2010-04 | | | | | Figures 4-1/4, 4-1/6 and 4-1/8 were not visible. Release corrected on cover page. | 9.1.1 | +| 2010-06 | CT#48 | CP-100261 | 0413 | | ASN.1 Module Version Update | 9.2.0 | +| 2011-03 | CT#51 | | | | Update to Rel-10 version (MCC) | 10.0.0 | +| 2011-09 | CT#53 | CP-110733 | 0414 | 2 | Extension parameter for Release Call | 11.0.0 | +| 2011-12 | CT#53 | CP-110813 | 0415 | 2 | Extension of ScfID parameter length | 11.1.0 | +| 2012-12 | CT#58 | CP-120749 | 0416 | 1 | CWA Correction and CWA and ICA Clarification | 11.2.0 | +| 2014-09 | - | - | - | - | Update to Rel-12 version (MCC) | 12.0.0 | +| 2015-12 | CT#70 | - | - | - | Update to Rel-13 version (MCC) | 13.0.0 | +| 2017-03 | CT#75 | - | - | - | Update to Rel-14 version (MCC) | 14.0.0 | +| 2018-06 | CT#80 | - | - | - | Update to Rel-15 version (MCC) | 15.0.0 | +| 2020-07 | - | - | - | - | Update to Rel-16 version (MCC) | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29079/2a476a0b3dbc3429436246db4784ff9f_img.jpg b/marked/Rel-16/29_series/29079/2a476a0b3dbc3429436246db4784ff9f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..32aaf1a7220fc0c7e7f5114a8ae9ebee3124e514 --- /dev/null +++ b/marked/Rel-16/29_series/29079/2a476a0b3dbc3429436246db4784ff9f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4d136df3a5c80ec2f879cf8b6eaf8965a00fe8ab4c3544045a8255d6fd08177a +size 107138 diff --git a/marked/Rel-16/29_series/29079/4af57aad638888edf2062306f8a54a6c_img.jpg b/marked/Rel-16/29_series/29079/4af57aad638888edf2062306f8a54a6c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8f7818146309c8295a4ce35cf3949168d3bfe0f0 --- /dev/null +++ b/marked/Rel-16/29_series/29079/4af57aad638888edf2062306f8a54a6c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fb8c6633b220cee30ca6cac3866510150c13272001ffd4f12c3cc13e243e4d45 +size 79156 diff --git a/marked/Rel-16/29_series/29079/56a5265d174ce056c1dbe5e7a60839fc_img.jpg b/marked/Rel-16/29_series/29079/56a5265d174ce056c1dbe5e7a60839fc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f7c8a462207ad4ae12c98ac8da21d737ce38848f --- /dev/null +++ b/marked/Rel-16/29_series/29079/56a5265d174ce056c1dbe5e7a60839fc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:820b8027d118efe1efc00c961b58c144b5b86eb7f02468f1d4f444988c4654a4 +size 230446 diff --git a/marked/Rel-16/29_series/29079/68a5a1a1a761c652b4b4c56da7cf9914_img.jpg b/marked/Rel-16/29_series/29079/68a5a1a1a761c652b4b4c56da7cf9914_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5352e691e1ec089486f9bbc84759b23605c6c9e9 --- /dev/null +++ b/marked/Rel-16/29_series/29079/68a5a1a1a761c652b4b4c56da7cf9914_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d26610e742bb6b3752e83f532205c964390c34b5658d55d47e6e09cb8dfdd0eb +size 78562 diff --git a/marked/Rel-16/29_series/29079/7c92fa3f1d1b465cc1d3c48a1a8728ff_img.jpg b/marked/Rel-16/29_series/29079/7c92fa3f1d1b465cc1d3c48a1a8728ff_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0f82004bf01cf70f79b31803e713666e6ba1197f --- /dev/null +++ b/marked/Rel-16/29_series/29079/7c92fa3f1d1b465cc1d3c48a1a8728ff_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c35879b612acde1006a2e21c4704e40542a28aa951e4b136fe5dcd63754de3ae +size 164965 diff --git a/marked/Rel-16/29_series/29079/dd5771673aececa53d42ece89218299d_img.jpg b/marked/Rel-16/29_series/29079/dd5771673aececa53d42ece89218299d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ceca180e76bbe61ea437ccde7e406139aa415b66 --- /dev/null +++ b/marked/Rel-16/29_series/29079/dd5771673aececa53d42ece89218299d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:870636269d5033ad37a5d5a5e0add42948ac82103c1d95834222df22c0241c53 +size 221956 diff --git a/marked/Rel-16/29_series/29079/e05122559f56af5699789b7118d8fe87_img.jpg b/marked/Rel-16/29_series/29079/e05122559f56af5699789b7118d8fe87_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2c24b42218fe26dd0823ba7d39e301914bb841dc --- /dev/null +++ b/marked/Rel-16/29_series/29079/e05122559f56af5699789b7118d8fe87_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fce5c4bfe61e21d7b2a1bd0303770733fa41196a6ddbe139e25b8f529aaf951c +size 243680 diff --git a/marked/Rel-16/29_series/29079/e94cbc0895c6914a2bb53f150ab7495e_img.jpg b/marked/Rel-16/29_series/29079/e94cbc0895c6914a2bb53f150ab7495e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c7e81fbc9c1a47df2c723f1a72f3cdee2c337583 --- /dev/null +++ b/marked/Rel-16/29_series/29079/e94cbc0895c6914a2bb53f150ab7495e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d802f6861b152cc4df0d6cd9b736ca9f0c8193d6226659756339be56238402d8 +size 80363 diff --git a/marked/Rel-16/29_series/29079/raw.md b/marked/Rel-16/29_series/29079/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..9f2361bfc363b96ad0077b99cdfa8d9a7ba3f5d4 --- /dev/null +++ b/marked/Rel-16/29_series/29079/raw.md @@ -0,0 +1,4157 @@ + + + + +Error! No +text of + +Error! No text of specified style in +document. + +# Contents + +| | | +|------------------------------------------------------------------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions, symbols and abbreviations..... | 7 | +| 3.1 Definitions ..... | 7 | +| 3.2 Symbols..... | 8 | +| 3.3 Abbreviations ..... | 8 | +| 4 General..... | 8 | +| 5 Common SDP Procedures..... | 9 | +| 5.1 General ..... | 9 | +| 5.2 Encapsulation of previous SDP information..... | 9 | +| 5.2.1 Media level information ..... | 9 | +| 5.2.2 Session level information ..... | 9 | +| 5.3 Determination of codec related SDP information associated to a previous realm instance..... | 10 | +| 5.4 Modifying codec related information..... | 11 | +| 5.4.1 Modifying the format list..... | 11 | +| 5.4.2 Modifying preferred configurations ..... | 11 | +| 5.5 Additional handling for SDP answer with actual configuration ..... | 12 | +| 5.6 Procedures specific to OMR attributes..... | 12 | +| 5.6.1 General ..... | 12 | +| 5.6.2 instance-number ..... | 12 | +| 5.6.3 Session and media checksum calculation..... | 13 | +| 5.7 Roaming architecture for voice over IMS with local breakout..... | 13 | +| 5.8 II-NNI traversal scenario..... | 13 | +| 6 IMS-ALG procedures ..... | 13 | +| 6.1 IMS-ALG handling of initial SDP offer ..... | 13 | +| 6.1.1 General ..... | 13 | +| 6.1.2 Validating the received SDP offer..... | 14 | +| 6.1.3 Deciding whether to allocate a primary local MR and if any previous MR can be bypassed..... | 14 | +| 6.1.4 Bypassing previous MRs..... | 16 | +| 6.1.5 Bypassing no previous MRs..... | 16 | +| 6.1.6 Allocating a primary local MR..... | 16 | +| 6.1.7 Allocating no primary local MR..... | 17 | +| 6.1.8 Allocating secondary local MRs ..... | 17 | +| 6.1.9 Forwarding SDP offer ..... | 18 | +| 6.2 IMS-ALG handling of initial SDP answer..... | 18 | +| 6.2.1 General ..... | 18 | +| 6.2.2 IMS-ALG bypasses an allocated transcoding MR ..... | 18 | +| 6.2.3 IMS-ALG allocates a local transcoding MR when performing proactive transcoding without resource reservation..... | 19 | +| 6.2.4 IMS-ALG determines steps required to complete the handling of the SDP answer ..... | 20 | +| 6.2.5 Receiving an unspecified connection address and a visited-realm instance ..... | 20 | +| 6.2.6 Receiving an unspecified connection address and a secondary-realm instance..... | 21 | +| 6.2.7 Other handling when no primary local MR allocated ..... | 21 | +| 6.2.8 Retaining a primary or secondary local MR..... | 21 | +| 6.2.9 Forwarding the SDP answer..... | 22 | +| 6.3 IMS-ALG OMR media resource operations ..... | 23 | +| 6.3.1 General ..... | 23 | +| 6.3.2 IMS-ALG operations..... | 23 | +| 6.4 Handling of connected IP realms ..... | 23 | +| 7 UA Procedures ..... | 24 | +| 7.1 UA sending an initial SDP offer ..... | 24 | +| 7.2 UA receiving an initial SDP offer ..... | 24 | +| 7.2.1 General ..... | 24 | +| 7.2.2 Validating the incoming SDP offer ..... | 24 | + +- 7.2.3 UA may choose an alternate realm instance to bypass an upstream MR..... 25 +- 7.3 UA receiving an initial SDP answer ..... 25 + - 7.3.1 General ..... 25 + - 7.3.2 Receiving SDP answer with an unspecified connection address ..... 25 + - 7.3.3 Receiving SDP answer with a valid connection address..... 25 +- 7.4 UA OMR media resource operations..... 26 + - 7.4.1 General ..... 26 + - 7.4.2 UA operations..... 26 +- 7.5 Handling of connected IP realms ..... 26 +- 8 Subsequent SDP offer/answer transactions..... 26 + - 8.1 General ..... 26 + - 8.2 IMS-ALG and UA subsequent SDP offer procedures ..... 27 + - 8.3 IMS-ALG and UA subsequent SDP answer procedures..... 27 + - 8.4 Handling media resources during a subsequent SDP offer/answer transaction ..... 28 +- Annex A (informative): Signalling flows..... 29** + - A.1 Scope of signalling flows..... 29 + - A.2 Introduction..... 29 + - A.3 Media bypassing all IMS-ALGs ..... 30 + - A.3.1 General ..... 30 + - A.3.2 Message flow..... 30 + - A.4 IMS-ALG allocates a local transcoding MR when performing proactive transcoding without resource reservation ..... 42 + - A.4.1 General ..... 42 + - A.4.2 Message flow..... 42 + - A.5 IMS-ALG bypasses an allocated transcoding MR..... 62 + - A.5.1 General ..... 62 + - A.5.2 Message flow..... 62 + - A.6 Loopback routeing via an intermediate network..... 75 + - A.6.1 General ..... 75 + - A.6.2 Message flow..... 76 +- Annex B (informative): Change history..... 90** + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 1 Scope + +The present document defines optional Optimal Media Routeing (OMR) procedures that can be applied by entities in the IP Multimedia Subsystem (IMS) that control media resources and are capable of manipulating the Session Description Protocol (SDP) as defined by IETF RFC 4566 [6]. + +The OMR procedures in the present specification relate to the handling of OMR-specific SDP attributes that are documented in TS 24.229 [4]. The OMR procedures use SDP offer/answer related procedures in IETF RFC 3264 [5] and in 3GPP TS 24.229 [4] in a backward-compatible manner. + +The 3GPP network architecture, including the configuration and network entities of the IMS, is defined in 3GPP TS 23.002 [2]. The Stage 2 of the IMS is defined 3GPP TS 23.228 [3]. Annex Q of 3GPP TS 23.228 [3] documents the architecture and call flows for OMR. + +The OMR procedures in this document are applicable to the following IMS entities that perform as an IMS-ALG or UA according to 3GPP TS 24.229 [4] and that control media resources: + +- an IBCF acting as an IMS-ALG; +- a P-CSCF acting as IMS-ALG; +- an AS acting as B2BUA and adapting IMS-ALG procedures to control an MRF; +- an AS acting as B2BUA and adapting UA procedures to control an MRF; and +- an MGCF acting as UA. + +NOTE 1: An AS acting as B2BUA to perform application functions such as conferencing or announcements will normally perform separate originating and terminating UA procedures, treating the media resource as an endpoint. An AS acting as B2BUA offering transcoding options will typically follow IMS-ALG procedures. + +NOTE 2: The controlled media resource can be a TrGW, IMS-AGW, MRF, or a media function of the entity performing OMR. + +The OMR procedures are not applicable for an UE. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.002: "Network architecture". +- [3] 3GPP TS 23.228: "IP multimedia subsystem; Stage 2". +- [4] 3GPP TS 24.229: "IP multimedia call control protocol based on Session Initiation Protocol (SIP) and Session Description Protocol (SDP); Stage 3". +- [5] IETF RFC 3264: "An Offer/Answer Model with Session Description Protocol (SDP)". +- [6] IETF RFC 4566: "SDP: Session Description Protocol". + +- [7] IETF RFC 2617: "HTTP Authentication: Basic and Digest Access Authentication". +- [8] IETF RFC 3605: "Real Time Control Protocol (RTCP) attribute in Session Description Protocol (SDP)". +- [9] 3GPP TS 29.238: "Interconnection Border Control Functions (IBCF) – Transition Gateway (TrGW) interface, Ix Interface; Stage 3". +- [10] 3GPP TS 29.334: "IMS Application Level Gateway (IMS-ALG) – IMS Access Gateway (IMS-AGW); Iq Interface; Stage 3". +- [11] IETF RFC 4240: "Basic Network Media Services with SIP". +- [12] IETF RFC 3260: "Media Control Channel Framework". +- [13] IETF RFC 6505: "A Mixer Control Package for the media Control Channel Framework". +- [14] 3GPP TS 29.332: "Media Gateway Control Function (MGCF) – IM Media Gateway Mn Interface". +- [15] 3GPP TS 23.334: "IP Multimedia Subsystem (IMS) Application Level Gateway (IMS-ALG) – IMS Access Gateway (IMS-AGW) interface: Procedures descriptions". +- [16] 3GPP TS 29.162: "Interworking between the IM CN subsystem and IP networks". +- [17] 3GPP TS 29.163: "Interworking between the IP Multimedia (IM) Core Network (CN) subsystem and Circuit Switched (CS) networks". +- [18] IETF RFC 5552: "SIP Interface to VoiceXML Media Services". +- [19] IETF RFC 4117: "Transcoding Services Invocation in the Session Initiation Protocol (SIP) Using Third Party Call Control (3pcc)". +- [20] IETF RFC 5939: "Session Description Protocol (SDP) Capability Negotiation". +- [21] IETF RFC 2234: "Augmented BNF for Syntax Specification: ABNF". +- [22] IETF RFC 7549: 3GPP SIP URI Inter Operator Traffic Leg parameter". + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in TR 21.905 [1], and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in TR 21.905 [1]. + +**Codec:** A media configuration for a media line in SDP that is specified by one or more formats in the format list of the m-line, by one or more preferred configurations (pcfg) associated with the media line, or by a combination of both. + +**Codec Change:** Any modification to the media configurations for the media line in the format list or the list of preferred configurations. + +**Codec List:** Either the format list of the m-line, or a combination of all the preferred configurations and the format list for the media line. + +**Connected IP realm:** Compared to a reference IP realm, a connected IP realm is one identified with a different unique name where all IP endpoints in the two IP realms are mutually reachable (accessible) by means of IP routing without address translation. Interconnection between the IP realms may be via direct link, via IP tunnel through other networks, via IP routing through intermediate networks, or via any other method of internetworking as long as their IP endpoints are mutually reachable. The property of connectedness is symmetric but not necessarily transitive. In particular, two IP realms connected to a reference IP realm are not necessarily themselves connected. + +**Incoming termination:** The termination at an MR in the direction from where an incoming SDP offer is being received at the IMS-ALG that is controlling the MR. + +**IP realm:** A collection of IP endpoints identified by a unique name, where all IP endpoints are mutually reachable by means of IP routing without address translation. + +**Media resource:** An IMS Network entity that provides resources to process media streams and is controlled by an entity applying OMR procedures. A TrGW, BGW, MRF, or a function internal to the entity performing OMR can be a media resource. + +**Loopback routing:** A method of routing a SIP request back to the visited network for local breakout according to the Roaming Architecture for Voice over IMS with Local Breakout as specified in TS 24.229 [4]. + +**Outgoing termination:** The termination at an MR in the direction towards where an outgoing SDP offer is being sent at the IMS-ALG that is controlling the MR. + +**Second SDP offer/answer:** An SDP offer/answer transaction initiated by any of the involved IMS-ALGs during session establishment towards the initial SDP answerer upon reception of the initial SDP answer and MR resources are required (e.g. when an intermediate IMS-ALG performs proactive transcoding without resource reservation) or not required (e.g. when MR resources are reserved for the purpose of transcoding and transcoding is not required). The second SDP offer is not an end-to-end negotiation and is handled as the initial SDP offer. + +**Subsequent SDP offer/answer:** An end-to-end SDP offer/answer transaction initiated after a completed initial or second SDP offer/answer transaction. The subsequent SDP offer contains no OMR specific attributes. + +## 3.2 Symbols + +For the purposes of the present document, the following symbols apply: + +| | | +|----|---------------------------------------------------------------| +| Ix | Reference Point between IBCF and TrGW | +| Iq | Reference Point between the P-CSCF and the IMS Access Gateway | + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in TR 21.905 [1], in TS 23.228 [3] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in TR 21.905 [1] or in TS 23.228 [3]. + +| | | +|-------|----------------------------------------| +| ALG | Application Level Gateway | +| B2BUA | Back-to-Back User Agent | +| IC | Interconnection | +| ICE | Interactive Connectivity Establishment | +| MR | Media Resource | +| OMR | Optimal Media Routing | +| TRF | Transit and Roaming Function | +| UA | User Agent | + +# 4 General + +The procedures in clause 5, clause 6, clause 7 and clause 8 shall apply separately to each media line with non-zero port value in each SDP message, and shall apply separately to each SDP offer/answer transaction. In the presence of forking of a SIP INVITE request that includes an SDP offer, the OMR procedures for handling of the SDP offer apply once for all forked dialogs, and the OMR procedures for handling of the corresponding SDP answer apply independently to each dialog. Entities supporting OMR use the OMR-specific SDP extension attributes defined in TS 24.229 [4]. + +OMR builds on the ALG NAT traversal model and is not consistent with ICE. + +OMR does not modify the SIP signalling route path and usually does not modify the flow of SIP messages except in some cases when transcoding options are offered. + +# 5 Common SDP Procedures + +## 5.1 General + +The IMS-ALG or UA using the OMR procedures in clause 6 or clause 7, respectively, shall additionally use the procedures in this clause when manipulating SDP. + +## 5.2 Encapsulation of previous SDP information + +### 5.2.1 Media level information + +If an IMS-ALG forwards an SDP offer and for a given media line: + +- adds or removes offered format(s); +- modifies the transport protocol; +- adds or removes other corresponding media level SDP attribute(s) than "visited-realm", "secondary-realm", "omr-codecs", "omr-m-att", "omr-s-att", "omr-m-bw", "omr-s-bw", "omr-s-cksum" or "omr-m-cksum" attributes; +- modifies the value of other corresponding media level SDP attribute(s) than "visited-realm", "secondary-realm", "omr-codecs", "omr-m-att", "omr-s-att", "omr-m-bw", "omr-s-bw", "omr-s-cksum" or "omr-m-cksum" attributes; +- adds or removes corresponding media level SDP bandwidth line(s); or +- modifies the value of corresponding media level SDP bandwidth line(s), + +then the IMS-ALG shall apply the procedures below to encapsulate all media level information of the corresponding media line. + +The IMS ALG shall encapsulate the received transport protocol and format list of the corresponding media line within an "omr-codecs" attribute and add this attribute as a media level attribute for the corresponding media line. + +The IMS ALG shall encapsulate each received attribute of the corresponding media line within an "omr-m-att" attribute and add this attribute as a media level attribute for the corresponding media line. + +The IMS ALG shall encapsulate each received bandwidth line of the corresponding media line within an "omr-m-bw" attribute and add this attribute as media level attribute for the corresponding media line. + +If the IMS-ALG received any visited-realm instances in the SDP offer, the IMS-ALG shall supply the instance number one above the highest instance number in the received SDP offer as instance number within the "omr-codecs", the "omr-m-att" and "omr-m-bw" attribute(s). Otherwise the IMS-ALG shall supply the instance number 2. + +### 5.2.2 Session level information + +If an IMS-ALG forwards an SDP offer and: + +- encapsulated any media level information according to the conditions in clause 5.2.1; +- adds or removes any session level SDP attribute(s); +- modifies the value of any session level SDP attribute(s); +- adds or removes session level SDP bandwidth line(s); or +- modifies the value of session level SDP bandwidth line(s), + +then the IMS-ALG shall apply the procedures below to encapsulate all session level information. + +The IMS ALG shall encapsulate each received session-level attribute within an "omr-s-att" attribute and add this attribute as a media level attribute for every media line. + +The IMS ALG shall encapsulate each received session-level bandwidth line within an "omr-s-bw" attribute and add this attribute as a media level attribute for every media line. + +If the IMS-ALG received any visited-realm instances in the SDP offer, the IMS-ALG shall supply the instance number one above the highest instance number in the received SDP offer as instance number within the "omr-s-att" and "omr-s-bw" attribute(s). Otherwise the IMS-ALG shall supply the instance number 2. + +NOTE 1: The instance number 1 is reserved for the incoming SDP offer when it contains no visited-realm instance. + +NOTE 2: The remaining SDP session level attributes (e.g., the "o" line) are not modified by the OMR procedures. + +## 5.3 Determination of codec related SDP information associated to a previous realm instance + +When deciding to bypass some previous MR, an IMS-ALG needs to determine the SDP information which is applicable together with the visited-realm instance or secondary-realm instance that the IMS selects for the bypass (see clause 6.1). The IMS-ALG will include that SDP information in a forwarded SDP offer or perform additional modifications on top of it, e.g., to offer transcoding at its own MR. + +To determine the codec related SDP information associated to that previous realm instance for the media line, the IMS-ALG shall use the procedures below. + +1) If any "omr-codecs", "omr-m-att", or "omr-m-bw" attributes with a higher instance number than the previous visited-realm instance or secondary-realm instance exist for a media line, the IMS-ALG shall consider the information within the set of attributes with the lowest instance number among those as follows: + +- the IMS-ALG shall replace the transport format and media formats in the media line with the transport format and media formats from the "omr-codecs" attribute with this instance number; +- the IMS-ALG shall retain all the "visited-realm", "secondary-realm", "omr-s-cksum", "omr-m-cksum", "omr-codecs", "omr-m-att", "omr-s-att", "omr-m-bw" and "omr-s-bw" attributes for the media line and replace all other SDP a-line(s) for the media line with the attributes extracted from the "omr-m-att" attribute(s) with this instance number; and + +NOTE 1: This procedure only describes update to codec related SDP information. Clauses 6 and 7 describe the corresponding modifications to the OMR related attributes. + +- the IMS-ALG shall replace the SDP b-line(s) for the media line with the b-line(s) extracted from the "omr-m-bw" attributes with this instance number. + +Otherwise, the IMS-ALG shall use the SDP a-lines, b-lines, transport format and list of media formats of the corresponding media line. + +2) If any "omr-s-att" or "omr-s-bw" attributes with a higher instance number than the previous visited-realm instance or secondary-realm instance exist, the IMS-ALG shall consider the information within the set of attributes with the lowest instance number among those as follows: + +- If the same attributes are provided for each media line, the IMS ALG shall replace all session-level SDP a-lines and b-lines with the encapsulated attributes and bandwidth within the "omr-s-att" attributes and "omr-s-bw" attributes of one media line as session level attributes and bandwidth, and may apply attribute or bandwidth modifier specific logic to verify and possibly adjust the session-level information from "omr-s-att" and "omr-s-bw" attributes and media level information determined as described above; + +NOTE 2: Verification helps in the possible event of splitting media lines by intermediate entities. + +- otherwise the IMS-ALG shall apply attribute or bandwidth modifier specific logic to derive appropriate session-level information from "omr-s-att" and "omr-s-bw" attributes and media level information determined as described above, or delete all those encapsulated attributes and all session-level SDP a-lines and b-lines. + +NOTE 3: In the possible event of merging of media lines by intermediate entities, there may be inconsistencies in the encapsulated session level a-lines and/or b-lines. + +3) Otherwise, the IMS-ALG shall use the session-level SDP a-lines and b-lines. + +For an SDP offer with several media lines, an IMS-ALG applies the OMR algorithm separately for each media line and can select different optimised paths. In such a case, the session-level attributes and bandwidth information determined + +by the above algorithm can differ for different optimised paths, depending on the selected visited-realm instance or secondary-realm instance for each media line. The IMS-ALG may then apply attribute or bandwidth modifier specific logic to determine the appropriate session-level information or discard conflicting information. An IMS-ALG may also apply a policy not to choose different optimised paths for different media to avoid such conflicts. + +NOTE 4: Upon receiving an SDP offer and validating the OMR attributes in the SDP offer, but before making any codec changes to the SDP offer, the IMS-ALG supporting OMR can delete any unsupported attributes from the SDP offer, e.g., attributes associated with capability negotiation. The IMS-ALG supporting OMR can also delete any ignored attributes, e.g., due to lack of support of a required extension to capability negotiation, as determined by the *creq* attribute defined in IETF RFC 5939 [20]. + +## 5.4 Modifying codec related information + +### 5.4.1 Modifying the format list + +When forwarding an SDP offer, the IMS-ALG should not make changes to the attributes associated with a format remaining in the format list of the m-line that require the allocation of an MR to translate the media payload between the format described by the received SDP offer and the format described by the forwarded SDP offer. + +NOTE 1: Examples include changing between AMR octet-aligned and bandwidth-efficient modes, and incompatible AMR mode-sets. + +To add a codec to the format list of the m-line in the SDP offer to be forwarded, the IMS-ALG shall either: + +- add a media format to the format list on the media line that is different from any format in the "omr-codecs" attributes for the media line, along with any necessary media attributes, or +- re-insert a format from an "omr-codecs" attribute for the media line that is not in the current format list, along with the corresponding attributes for the format with the same instance number in "omr-m-att" attributes. + +NOTE 2: This procedure avoids the potential need to retain a media resource to perform format mapping when performing proactive transcoding, if the bypass decision is based on the SDP answer. + +### 5.4.2 Modifying preferred configurations + +When forwarding an SDP offer, the IMS-ALG supporting SDP capability negotiation shall only make a change to a preferred configuration in the incoming SDP offer without changing the configuration number if the change is backward compatible. A backward compatible change is one that, if it is selected as the actual configuration, does not require the allocation of an MR to translate the media payload between the format described by the received SDP offer and the format described by the forwarded SDP offer, and does not require modification of the actual configuration number when forwarding the SDP answer. This applies to the preferred configuration (*pcfg*) itself and any capabilities referenced in the *pcfg*. + +NOTE 1: It is recommended that an IMS-ALG not make any codec list changes to an SDP offer that includes any mandatory session capabilities unless it also deletes all attributes associated with capability negotiation as if capability negotiation were not supported. + +To make any of the following changes to a preferred configuration in the SDP offer: + +- to change the priority of the preferred configuration with respect to others; +- to allow insertion of a new preferred configurations with higher priority; +- to allow reassignment of another preferred configuration to a higher priority; or +- to make any other changes to a preferred configuration that are not backward compatible and cannot be realized by inserting a new preferred configuration, + +the IMS-ALG shall reassign the configuration number to one unused in the SDP offer or in any of the encapsulated information for the media line in the SDP offer and add any necessary capability attributes. + +NOTE 2: Changing the priority of a codec or preferred configuration increases the possibility of introducing a transcoding function that is not otherwise needed. Normally new or changed preferred configurations are assigned with higher configuration numbers (of lower priority) than existing preferred configurations. + +When forwarding an SDP offer, the IMS-ALG supporting SDP capability negotiation shall not change any existing SDP capneg capability attributes, but may insert additional capability attributes. + +The IMS-ALG may delete a preferred configuration from the SDP offer. However, the IMS-ALG shall not delete any unreferenced capability attributes. + +If the IMS-ALG desires to add a preferred configuration, it should search for an equivalent or backward compatible preferred configuration within the encapsulated codec related information. If it finds such a suitable preferred configuration, the IMS-ALG should reuse the configuration number from the encapsulated preferred configuration if the resulting priority with respect to other preferred configurations is acceptable. + +To add a new preferred configuration to the media line of the SDP offer that is different from and not backward compatible with any pcfg attribute in encapsulated codec information for the media line, the IMS-ALG shall allocate a new configuration number for the new preferred configuration with a configuration number unused by any other preferred configuration within the SDP offer or within the encapsulated codec related information. + +## 5.5 Additional handling for SDP answer with actual configuration + +In clause 6.2.2 and clause 6.2.8 step 4), if the media line in the initial or second SDP answer includes an actual configuration, the IMS-ALG should perform the following procedure to determine if the codecs in the initial or second SDP answer are supported by a previous version of the received initial or second SDP offer: + +The IMS-ALG should compare the actual configuration with SDP capneg preferred configurations in encapsulated codec related information to determine if previous realm instances are associated with matching codec related information. The actual configuration matches a preferred configuration: + +- if the preferred configuration has the same configuration number as the actual configuration; or +- if the capabilities listed in the actual configuration match the capabilities available in the preferred configuration in the initial or second SDP offer. + +NOTE: An IMS-ALG can choose not to compare the SDP capneg actual configuration with encapsulated preferred configurations, or only to compare configuration numbers, but this may lead to a failure to find opportunities to bypass previous realm instances. However, SDP capneg procedures recommend that the offerer performs a second offer/answer transaction where the actual configuration is offered in normal SDP. Missed opportunities to bypass previous realm instances could still be found during this second offer/answer transaction. + +If the IMS-ALG selected a preferred configuration with a different configuration number than the actual configuration for bypassing a previous realm, the IMS-ALG shall change the capability number of the actual configuration to equal the capability number of the matching preferred configuration before forwarding the initial or second SDP answer. + +## 5.6 Procedures specific to OMR attributes + +### 5.6.1 General + +This clause describes additional procedures specific to SDP attributes associated with OMR specified in TS 24.229 [4], clause 7.5.3. + +### 5.6.2 instance-number + +When creating a new visited-realm instance for a media line in an SDP offer, the IMS-ALG shall assign an instance-number value for the instance that is "1" higher than the highest existing instance-number value for any visited-realm attribute for any media line in the received SDP offer, starting with the value "1" if there are no such attributes in the SDP offer. If the IMS-ALG adds visited-realm instances for several media lines, the IMS-ALG shall use the same instance-number. If the IMS-ALG adds a "secondary-realm" SDP attribute for a media line in the SDP offer the IMS-ALG shall assign the same instance-number value as assigned to the "visited-realm" SDP attribute. + +A UA creating a visited-realm instance for a media line in an SDP offer shall assign an instance-number value "1" for the instance. If the UA adds a "secondary-realm" SDP attribute for a media line in the SDP offer the UA shall assign the instance-number value "1" for a secondary-realm instance. + +### 5.6.3 Session and media checksum calculation + +An IMS ALG or a UA supporting OMR shall determine a session level checksum and a media level checksum for each media line containing a "visited-realm" SDP attribute or a "secondary-realm" SDP attribute in an SDP offer. + +NOTE: A session level checksum and a media level checksum calculation is not performed for an SDP answer containing media line with a "visited-realm" SDP attribute or a "secondary-realm" SDP attribute. + +The session level checksum shall be calculated by summing all the hex values of the individual ASCII characters (excluding all white space) of the "b" and "a" session level lines. The media level checksum shall be calculated by summing all the hex values of the individual ASCII characters (excluding all white space) of the "m", "b", and "a" media level lines including attributes specific to OMR but excluding the session and media level checksum attribute lines themselves. + +When there are no "b" or "a" session level lines to calculate the session level checksum, the session level checksum is set to "0". + +## 5.7 Roaming architecture for voice over IMS with local breakout + +In a network supporting the roaming architecture for voice over IMS with local breakout OMR related policies may depend on the identification of a roaming architecture for voice over IMS with local breakout session. + +An IBCF acting as an IMS-ALG can identify a session to be a roaming architecture for voice over IMS with local breakout session as specified in TS 24.229 [4], clause 5.10.9. + +## 5.8 II-NNI traversal scenario + +OMR related policies can depend on the II-NNI traversal scenario type. + +An IBCF acting as an IMS-ALG can identify the II-NNI traversal scenario type as specified in TS 24.229 [4]. + +# --- 6 IMS-ALG procedures + +## 6.1 IMS-ALG handling of initial SDP offer + +### 6.1.1 General + +Upon receiving an initial SDP offer, the IMS-ALG supporting OMR shall apply the procedures in the following clauses for each media line with non-zero port value. + +Upon receiving a second SDP offer that includes OMR attributes for some media lines, the IMS-ALG supporting OMR shall apply the procedures in the following clauses for each media line with non-zero port value and OMR attributes. + +NOTE: An example of a second SDP offer/answer transaction is when any of the IMS-ALGs performs proactive transcoding without resource reservation or removes media resources when transcoding is no longer required. See clauses 6.2.2 and 6.2.3. + +After the completion of an initial SDP offer/answer transaction and when receiving an SDP offer without OMR attributes for a media line, the IMS-ALG supporting OMR shall apply the procedures for subsequent SDP offer/answer transaction in clause 8 for that media line. + +### 6.1.2 Validating the received SDP offer + +If any of the following conditions are true: + +- 1) the received SDP offer includes any OMR attributes for the media line, but no visited-realm instance; +- 2) the connection-address and port information in the visited-realm instance with the highest value of instance-number for the media line does not match the connection address and port information for the media line; or +- 3) one of the following conditions are true: + +- the "omr-m-cksum" attribute does not match the checksum value computed for the media line as described in clause 5.6.3; or +- based on local policy, if the "omr-m-cksum" attribute matches the computed media line checksum, but the "omr-s-cksum" attribute does not match the checksum value computed for the session level lines as described in clause 5.6.3, + +then the IMS-ALG shall remove all OMR attributes associated with the media line from the received SDP offer and use the modified SDP offer as the received SDP offer in the procedures in the following clauses. + +### 6.1.3 Deciding whether to allocate a primary local MR and if any previous MR can be bypassed + +The IMS-ALG considers information in the received SDP offer and applies local policy to decide whether to allocate a primary local MR and if it is to bypass any previous MRs. + +**NOTE:** An IMS-ALG can revise these decisions when receiving the SDP answer, applying procedures in clause 6.2. + +The IMS-ALG shall perform the following steps: + +- 0) If the connection address for the media line in the received SDP offer is the unspecified address, then the IMS-ALG should: + - a) select to not allocate a primary local MR (regardless of local policy), and to not bypass any previous MRs; + - b) convert the unspecified address in the connection address for the media line in the received SDP offer to the addrtype of the outgoing IP realm, if necessary; + - c) if subsequently choosing to perform proactive transcoding in clause 6.1.7, then select to perform proactive transcoding without resource reservation (regardless of local policy); + - d) select to not add secondary-realm instances to the modified SDP offer when performing the procedure in clause 6.1.8 (regardless of local policy); and + - e) skip to step 6), +- 1) If all of the following conditions apply: + - a) local policy does not require the allocation of an MR for any non-OMR related reason (e.g. for hosted NAPT traversal on the incoming signalling path, or for legal interception; and + - b) the IP realm, nettype and addrtype for the outgoing signalling path is the same as the IP realm, nettype and addrtype associated with a visited-realm or secondary-realm instance for the media line + - such that the instance has an instance-number value $i$ that is less than the highest instance-number value $n$ associated with the media line in the received SDP offer; and + - such that the instance $i$ is associated with a codec list, determined using the procedures in clause 5.3, which includes all codecs required by local policy, unless the IMS-ALG has a policy to offer the missing codecs proactively without reserving an MR, + +then the IMS-ALG shall store an indication that the allocation of a primary local MR is not required and shall store the realm instances with instance-number greater than $i$ , which are associated with MRs that can be bypassed without allocating a primary local MR. + +- 2) If the following condition applies: + - a) the IMS-ALG controls an MR with access to an IP realm or connected IP realm, nettype and addrtype associated with a visited-realm or secondary-realm instance for the media line + - such that the instance has an instance-number value $j$ that is less than the highest instance-number value $n$ associated with the media line in the received SDP offer; and + +- such that the instance $j$ is associated with a codec list, determined using the procedures in clause 5.3, which includes all codecs required by local policy, unless such codecs are provided at a local MR via transcoding, + +then the IMS-ALG shall store the realm instances with instance-number greater than $j$ , which are associated with MRs that can be bypassed when allocating a primary local MR. + +3) If all of the following conditions apply: + +- the condition in step 1) does not apply; +- the IP realm, nettype and addrtype for the outgoing signalling path is the same as the IP realm, nettype and addrtype for the incoming signalling path; +- the codec list in the received SDP offer, determined from the SDP m-line and associated non-OMR attribute lines, includes all codecs required by local policy, unless the IMS-ALG has a policy to offer the missing codecs proactively without reserving an MR; and +- local policy does not require the allocation of an MR for any non-OMR related reason (e.g. for hosted NAPT traversal on the incoming signalling path, or for legal interception), + +then the IMS-ALG shall store an indication that the allocation of a primary local MR is not required and that no MRs can be bypassed when no primary local MR is allocated. + +4) If an indication that the allocation of a primary local MR is not required has been stored in steps 1) or 3), + +- then the IMS-ALG shall compare the realm instances (and MRs) that can be bypassed with or without allocation of a primary local MR, as determined in steps 1), 2) and 3), and shall use local policy to select whether to allocate a primary local MR, +- else the IMS-ALG shall select to allocate a primary local MR, + +NOTE: Usually the decision is made based on which choice retains the smallest total number of MRs in the media path, but local policy may apply other criteria. + +5) If the IMS-ALG selected in step 4) to allocate a primary local MR, then the IMS-ALG shall: + +- if one or more realm instances can be bypassed when allocating a primary local MR, then store instance-number value $k=j$ and apply the procedures in clause 6.1.4 to bypass previous MRs, else apply the procedures in clause 6.1.5 to not bypass previous MRs; and +- apply the procedures in clause 6.1.6 to allocate a primary local MR. + +6) If the IMS-ALG selected in step 4) to not allocate a primary local MR, then the IMS-ALG shall: + +- if one or more realm instances can be bypassed when not allocating a primary local MR, then store instance-number value $k=i$ and apply the procedures in clause 6.1.4 to bypass previous MRs, else apply the procedures in clause 6.1.5 to not bypass previous MRs; and +- apply the procedures in clause 6.1.7 to not allocate a primary local MR. + +### 6.1.4 Bypassing previous MRs + +If the IMS-ALG decides (applying the criteria in clauses 6.1.3, 6.2.2, 6.2.3 or 6.2.8) to bypass a previous MR, the IMS-ALG shall: + +- 1) use the connection address and port information from the selected instance $k$ for the media line in the received SDP offer as incoming connection address and incoming port information for the media line in the subsequent steps; +- 2) reconstruct the associated codec information for the media line in the received SDP offer from the selected instance $k$ as described in clause 5.3, and use that codec information as incoming codec information in the subsequent steps; and +- 3) delete every OMR attribute for the media line with instance-number value higher than $k$ . + +### 6.1.5 Bypassing no previous MRs + +If the IMS-ALG decides (applying the criteria in clauses 6.1.3, 6.2.2 or 6.2.3) not to bypass any previous MR, the IMS-ALG shall: + +- 1) use the connection-address from the SDP c-line in the received SDP offer as incoming connection-address in subsequent steps; +- 2) use the port information from the SDP m-line in the received SDP offer as incoming port information in subsequent steps; and +- 3) use the codec information from the SDP m-line and associated non-OMR attribute lines in the received SDP offer as incoming codec information in the subsequent steps. + +### 6.1.6 Allocating a primary local MR + +If the IMS-ALG decides (applying the criteria in clauses 6.1.3 or 6.2.3) to allocate a local MR, the IMS-ALG shall: + +- 1) if no MR context has been allocated due to a previous SDP offer-answer exchange, allocate an MR context with access to the IP realms, nettypes and addrtypes associated with the incoming connection address and port information determined in clause 6.1.4 or 6.1.5, and the outgoing signalling path, respectively applying procedures as described in clause 6.3; +- 2) if the IMS-ALG is not performing hosted NAPT traversal on the incoming side, then insert the incoming connection address and incoming port information for the media line, as determined in clause 6.1.4 or 6.1.5, into the remote connection address and port information for the incoming termination on the MR; +- 3) if the IMS-ALG is performing hosted NAPT traversal on the incoming side, then discover the remote connection address and port information for the incoming termination on the MR using latching or other unspecified technique; +- 4) if codec information is to be provided to the allocated MR on the incoming termination, provide to the MR the incoming codec information as determined in clause 6.1.4 or 6.1.5; + +NOTE: The IMS-ALG can defer the allocation of an MR termination at the incoming side and the related procedures in steps 1) to 4) until it processes the SDP answer. + +- 5) if the IMS-ALG requires according to local policy that its MR remain in the media path for reasons unrelated to OMR, remove all OMR specific attributes from the modified SDP offer; +- 6) if there is no visited-realm instance associated with the connection address and port information for the media line in the received (and possibly modified) SDP offer, and there is no local policy prohibiting removal of the allocated MR, then construct and add this visited-realm instance to the modified SDP offer; +- 7) replace the connection address and port information for the media line in the modified SDP offer with the connection address and port information from the MR termination on the outgoing side; +- 8) make any codec changes to incoming codec information, as determined in clause 6.1.4 or 6.1.5, according to local policy, taking into account the procedures in clause 5.4, and insert the changed codec information into the SDP m-line and associated attribute lines of the modified SDP offer; +- 9) if codec information is to be provided to the allocated MR for the outgoing termination, provide to the MR the modified codec information derived in step 8); and +- 10) add to the modified SDP offer a visited-realm instance for the IP realm associated with the connection address and port information for the media line in the modified SDP offer, including the incoming codec information encoded according to clause 5.2 if any codec changes were inserted in step 8). + +### 6.1.7 Allocating no primary local MR + +If the IMS-ALG decides (applying the criteria in clauses 6.1.3 or 6.2.2) not to allocate a primary local MR, the IMS-ALG shall: + +- 1) decide according to local policy if the IMS-ALG performs any codec changes to the incoming codec information, as determined in clause 6.1.4 or 6.1.5, without allocating an MR (i.e., for proactive transcoding without resource reservation); + +NOTE: The IMS-ALG can only make codec changes if the available SIP signalling allows the IMS-ALG to initiate a 2nd SDP offer/answer transaction if necessary to allocate a transcoding MR after receipt of the SDP answer, as described in clause 6.2.3. + +- 2) if the IMS-ALG decided in step 1) to perform any codec changes, then + - a) if there is no visited-realm instance associated with the connection address and port information for the media line in the received SDP offer, then construct and add this visited-realm instance; + - b) make the codec changes to incoming codec information according to local policy, taking into account the procedures in clause 5.4, and insert the changed codec information into the SDP m-line and associated attribute lines of the modified SDP offer; and + - c) add to the modified SDP offer a visited-realm instance with the same IP realm, connection address and port information as the previous visited-realm instance (after a possible execution of step 3 in clause 6.1.4 for the media line, including the incoming codec information encoded according to clause 5.2), +- 3) if the IMS-ALG decided in step 1) not to perform any codec changes, then + - a) insert the incoming codec information, determined in clause 6.1.4 or 6.1.5 into the SDP m-line and associated attribute lines of the modified SDP offer. +- 4) use the incoming connection address, determined in clause 6.1.4 or 6.1.5, as the connection address in the SDP c-line of the modified SDP offer; and +- 5) use the incoming port information as determined in previous steps as port information in the SDP m-line of the modified SDP offer. + +### 6.1.8 Allocating secondary local MRs + +According to local policy, the IMS-ALG may allocate a secondary MR for each combination of IP realm, nettype and addrtype on the outgoing side for which the IMS-ALG can allocate an MR context. However, if the IMS-ALG does not require a local MR for non-OMR reasons, the IMS ALG should only allocate a secondary MR for a combination of IP realm, nettype and addrtype if the IP realm, nettype and addrtype are not represented by a visited-realm or secondary-realm instance for the media line in the SDP offer. To allocate a secondary MR, the IMS-ALG shall: + +- 1) if no MR context has been allocated due to a previous SDP offer-answer exchange, allocate an MR context for the IP realm, nettype and addrtype on the outgoing side, using the incoming connection address and incoming port information for the media line, determined in clause 6.1.4 or 6.1.5, as the remote connection address and port information for the incoming termination; + - 2) if codec information is to be provided to the allocated MR for the incoming termination, provide to the MR the incoming codec information, as determined in clause 6.1.4 or 6.1.5; +- NOTE: The IMS-ALG can defer the allocation of an MR termination at the incoming side and the related procedures in steps 1) and 2) until it processes the SDP answer. +- 3) if any codec information is to be provided to the allocated MR for the outgoing termination, provide to the MR the codec information from the SDP m-line and associated attribute lines of the modified SDP offer; + - 4) if the IMS-ALG did not yet add a visited-realm instance for the outgoing side (the IMS-ALG did not allocate a primary MR and did not perform any codec changes, see clause 6.1.7); then + - a) if there is no visited-realm instance associated with the connection address and port information for the media line in the received SDP offer, then construct and add this visited-realm instance; and + - b) add to the SDP offer a visited-realm instance with the same IP realm, connection address and port information as the previous visited-realm instance (after a possible execution of step 3 in clause 6.1.4 for the media line), + - 5) add to the modified SDP offer a secondary-realm instance for the context allocated in step 1). + +### 6.1.9 Forwarding SDP offer + +The IMS-ALG shall: + +- 1) if local policy forbids sending of OMR related attributes to the outgoing IP realm, the IMS-ALG shall delete all OMR related attributes from the modified SDP offer; and +- 2) if the IMS-ALG has made any modifications to the received SDP offer before forwarding and the modified SDP offer includes OMR related attributes, the IMS-ALG shall compute checksum values as described in clause 5.6.3 and replace or add the "omr-s-cksum" and "omr-m-cksum" attributes for the media line. + +The IMS-ALG forwards the SDP offer according to TS 24.229 [4]. + +## 6.2 IMS-ALG handling of initial SDP answer + +### 6.2.1 General + +Upon receiving the initial or second SDP answer corresponding to the initial or second SDP offer sent in clause 6.1, the IMS-ALG supporting OMR shall perform the procedures in the following clauses for each media line in the initial or second SDP answer. + +### 6.2.2 IMS-ALG bypasses an allocated transcoding MR + +The IMS-ALG uses the following conditions to determine that a previously allocated primary local MR or upstream MR is to be bypassed and that a second SDP offer/answer transaction is needed to update the connection information on the outgoing side. Two examples of this procedure are given in Annex Q of TS 23.228 [3]: steps 5) and 6) of Figure Q.5, and steps 7) and 8) of Figure Q.7. + +If the following conditions are true: + +- 1) the received initial SDP answer includes connection address information for the media line that is a valid IP address other than the unspecified address (i.e., IPv4: "0.0.0.0", IPv6: "invalid.invalid"); and +- 2) it is possible to immediately initiate a second SDP offer/answer transaction towards the initial SDP answerer with the available SIP signalling, + +then the IMS-ALG should re-evaluate the conditions in clause 6.1.3, steps 1) to 4), taking into account the information from the originally received initial SDP offer, as well as the codecs received in the initial SDP answer as additional information (using the procedure in clause 5.5 if the initial SDP answer includes an actual configuration), to select again whether to allocate a primary local MR and to recompute how many realm instances can be bypassed. The IMS-ALG should select to modify the previous decision if a higher number of realm instances can be bypassed. + +If the IMS-ALG selected in the previous step to modify the previous decision and + +- to not allocate a primary local MR that has previously been allocated; or +- to not allocate a primary local MR and to bypass other previous realm instances than decided when previously evaluating clause 6.1.3, + +then the IMS-ALG shall: + +- 1) apply the procedures in clause 6.1.4 to bypass previous MRs or the procedures in clause 6.1.5 to not bypass previous MRs (using information from the originally received initial SDP offer), depending on its corresponding decision; +- 2) apply the procedures in clause 6.1.7 to not allocate a primary local MR without making any codec changes; +- 3) after clauses 6.2.2 and 6.2.3 are completed as applicable for all media lines, apply the procedures in clause 6.1.9 for each media line to send a second SDP offer within available SIP signalling, initiating a new second SDP offer/answer transaction towards the initial SDP answerer; and +- 4) upon receipt of the second SDP answer, continue handling of the second SDP answer as if it were the initial SDP answer, and reference the most recent data associated with the forwarding of the (modified) second SDP offer (i.e., incoming SDP information, allocated MRs and modified second SDP offer) as if it occurred the first time. + +### 6.2.3 IMS-ALG allocates a local transcoding MR when performing proactive transcoding without resource reservation + +The IMS-ALG uses the procedures in this clause if it receives an initial SDP answer without a realm instance, performed proactive transcoding without resource reservation when forwarding the initial SDP offer, as in step 2) of clause 6.1.7, and then determines that it needs to allocate an MR for proactive transcoding. + +If all the following conditions are true: + +- 1) the received initial SDP answer includes connection address information for the media line that is a valid IP address other than the unspecified address (i.e., IPv4: "0.0.0.0", IPv6: "invalid.invalid"); +- 2) the IMS-ALG performed proactive transcoding without resource reservation when previously forwarding the initial SDP offer, as in step 2) of clause 6.1.7; +- 3) the selected codec in the received initial SDP answer is not supported by the incoming media path and incoming codec information, as previously determined in clause 6.1.4 or 6.1.5 (using information from the originally received initial SDP offer), indicating that an MR must be allocated to provide transcoding; and +- 4) it is possible to immediately initiate a second SDP offer/answer transaction towards the SDP answerer with the available SIP signalling, + +NOTE: If a second SDP offer/answer transaction cannot be initiated with available SIP signalling, the OMR algorithm will fail to allocate a functioning end-to-end media path. + +then the IMS-ALG shall: + +- 1) if when previously handling the initial SDP offer it was determined in step 2) of clause 6.1.3 that one or more realm instances can be bypassed when allocating a primary local MR (using information from the originally received initial SDP offer), then store instance-number value $k=j$ and apply the procedures in clause 6.1.4 to bypass previous MRs, else apply the procedures in clause 6.1.5 to not bypass previous MRs (using information from the originally received initial SDP offer); +- 2) apply the procedures in clause 6.1.6 to allocate a primary local MR; +- 3) apply the procedures in clause 6.1.8 to update allocation of any secondary MRs, if necessary; +- 4) after clauses 6.2.2 and 6.2.3 are completed as applicable for all media lines, apply the procedures in clause 6.1.9 for each media line, to send a second SDP offer within available SIP signalling, and to initiate a new SDP offer/answer transaction towards the initial SDP answerer; and +- 5) upon receipt of the second SDP answer, continue handling of the second SDP answer as if it were the initial SDP answer, and reference the most recent data associated with the forwarding of the (modified) second SDP offer (i.e., incoming information, allocated MRs and modified second SDP offer) as if it occurred the first time. + +### 6.2.4 IMS-ALG determines steps required to complete the handling of the SDP answer + +The IMS-ALG performs the following steps to determine the disposition of any allocated MRs and to complete the handling of the SDP answer: + +- 1) if the received SDP answer for the media line includes a connection address with unspecified address and a visited-realm instance, then the IMS-ALG shall apply the procedures in clause 6.2.5; +- 2) if the received SDP answer for the media line includes a connection address with unspecified address and a secondary-realm instance, then the IMS-ALG shall apply the procedures in clause 6.2.6; +- 2a) If the received SDP answer for the media line includes a connection address with unspecified address and no visited-realm or secondary-realm instance, then the IMS-ALG shall: + - a) if necessary, update the unspecified connection address information in the SDP answer with the unspecified address of the appropriate type for the network into which the SDP answer will be sent (i.e., IPv4: "0.0.0.0", IPv6: "invalid.invalid"); + +- 3) if all the following conditions are true: + - a) the connection address for the media line in the received SDP answer is a valid (not unspecified) address; and + - b) the IMS-ALG did not allocate a primary local MR (i.e., executed clause 6.1.7) when forwarding the SDP offer,then the IMS-ALG shall apply the procedures in clause 6.2.7, and +- 4) if all the following conditions are true: + - a) the connection address for the media line in the received SDP answer is a valid (not unspecified) address; and + - b) the IMS-ALG allocated a primary local MR (i.e., executed clause 6.1.6) when forwarding the SDP offer,then the IMS-ALG shall apply the procedures in clause 6.2.8 to retain a primary local MR. + +### 6.2.5 Receiving an unspecified connection address and a visited-realm instance + +If the IMS-ALG receives a connection address with unspecified address and a visited-realm instance, then the IMS-ALG shall: + +- 1) If the visited-realm instance for the media line in the SDP answer has an instance-number that matches the visited-realm instance associated with the incoming SDP offer information, + +NOTE 1: The visited-realm instance associated with the incoming SDP offer information is either the one in the received SDP offer with highest instance-number (before any bypass decision is made), if one is present, or the one added in clause 6.1.6 step 6) or in clause 6.1.7 step 2a). + +NOTE 2: The IP realms in the two visited-realm instances either have the same name or are connected. + +then the IMS-ALG shall: + +- replace the connection address and port information for the media line in the SDP answer with the connection address and port information from the visited-realm instance in the received SDP answer, and + - retain the visited-realm instance in the SDP answer, +- 2) else the IMS-ALG shall: + - if necessary, update the unspecified connection address information in the SDP answer with the unspecified address of the appropriate type for the network into which the SDP answer will be sent (i.e., IPv4: "0.0.0.0", IPv6: "invalid.invalid"). + +### 6.2.6 Receiving an unspecified connection address and a secondary-realm instance + +If the IMS-ALG receives a connection address with unspecified address and a secondary-realm instance, then the IMS-ALG shall: + +- 1) if the secondary-realm instance for the media line in the SDP answer has an instance-number that matches a secondary-realm instance added by the IMS-ALG when applying procedures in clause 6.1.8 then the IMS-ALG shall apply the procedures in clause 6.2.8 to retain a secondary local MR, + +NOTE: The IP realms in the two secondary-realm instances either have the same name or are connected. + +- 2) else the IMS-ALG shall: + +- if necessary, update the unspecified connection address information in the SDP answer with the unspecified address of the appropriate type for the network into which the SDP answer will be sent (i.e., IPv4: "0.0.0.0", IPv6: "invalid.invalid"). + +### 6.2.7 Other handling when no primary local MR allocated + +If the IMS-ALG receives (as determined in clause 6.2.4) an SDP answer with a valid connection address after forwarding an SDP offer without allocating a primary local MR, then the IMS-ALG shall: + +- 1) If the IMS-ALG applied clause 6.1.4 to bypass previous MRs when handling the forwarding of the SDP offer, then the IMS-ALG shall: + - a) copy into the media line of the SDP answer the visited-realm or secondary-realm instance from the media line of the received SDP offer that was used to populate the connection address and port information in the forwarded SDP offer, replacing the connection-address and port information in the instance with the connection address and port information from the received SDP answer, and if the IP realm in the instance is a connected IP realm, replacing the IP realm name with the corresponding local IP realm name; and + - b) replace the connection address information in the SDP answer with the unspecified address of the appropriate type for the network into which the SDP answer will be sent (*i.e.*, IPv4: "0.0.0.0", IPv6: "invalid.invalid"), +- 2) else the IMS-ALG did not bypass previous MRs when forwarding the SDP offer and the IMS-ALG shall not modify the SDP answer. + +NOTE: In step 1) the received SDP answer never includes a realm instance. In step 2) the SDP answer can but does not necessarily include a realm instance. + +### 6.2.8 Retaining a primary or secondary local MR + +If the IMS-ALG decides (applying the criteria in clause 6.2.4 and clause 6.2.6) to retain a primary or secondary local MR, the IMS-ALG shall: + +- 1) if the IMS-ALG received an SDP answer with no secondary-realm instance for the media line, then the IMS-ALG shall: + + +NOTE: The IMS-ALG retains a primary local MR in this case. The IMS-ALG can but does not necessarily receive a visited-realm instance in an SDP answer when retaining a primary local MR. If present, the visited-realm instance can be used to identify the connected IP realm for the outgoing termination, if different from the IP realm of the outgoing termination. + + - a) update the remote connection address and port information for the outgoing termination on the selected primary local MR context with the connection address and port information for the media line in the received SDP answer, + - b) delete the visited-realm instance from the SDP answer, if present, +- 2) if the IMS-ALG received an SDP answer with a secondary-realm instance for the media line, then the IMS-ALG shall: + - a) update the remote connection address and port information for the outgoing termination on the selected secondary local MR context with the connection-address and port information from the secondary-realm instance in the received SDP answer; and + - b) delete the secondary-realm instance from the SDP answer, +- 3) if the selected codecs in the SDP answer are not in the set of codecs associated with the incoming SDP offer information, as determined in clause 6.1.4 or 6.1.5 when handling the SDP offer, then modify the SDP answer to include the codecs selected for the incoming termination of the selected local MR; +- 4) if the selected MR has access to an IP realm or connected IP realm, nettype and addrtype associated with a visited-realm or secondary-realm instance for the media line + - such that the instance has an instance-number value $k$ that is less than the highest instance-number value $n$ associated with the media line in the incoming SDP offer information, previously determined in clause 6.1.4 or 6.1.5; and + +- such that the instance $k$ is associated with a codec list, determined using the procedures in clause 5.3, which includes the codecs selected for the incoming termination of the selected local MR in step 3) (using the procedure in clause 5.5 if the SDP answer includes an actual configuration), + +then the IMS-ALG shall: + +- a) store the realm instances with instance-number greater than $k$ , which are associated with additional MRs that can be bypassed after selecting a codec for the incoming media path when allocating a primary local MR; + - b) apply the procedures in clause 6.1.4 to bypass additional previous MRs (using information from the originally received SDP offer); + - c) insert the incoming connection address and incoming port information for the media line, as determined in step b), as the remote connection address and port information for the selected IP realm on the incoming termination of the selected MR; + - d) if necessary, modify the selected codec information in the SDP answer to be a valid response to the incoming SDP offer codec information determined in step b); + - e) if codec information is to be provided to the allocated MR on the incoming termination, provide to the MR the incoming codec information as determined in step d); +- 5) If the IMS-ALG applied clause 6.1.4 to bypass previous MRs when forwarding the SDP offer or in step 4b), then the IMS-ALG shall: +- a) copy into the media line of the SDP answer the visited-realm or secondary-realm instance from the media line of the received SDP offer that was used for the remote connection address and port information for the incoming termination on the MR, replacing the connection-address and port information in the instance with the local connection address and port information for the incoming termination on the selected MR, and if the IP realm in the instance is a connected IP realm, replacing the IP realm name with the corresponding local IP realm name; and + - b) replace the connection address information in the SDP answer with the unspecified address of the appropriate type for the network into which the SDP answer will be sent (i.e., IPv4: "0.0.0.0", IPv6: "invalid.invalid"), +- 6) If the IMS-ALG applied clause 6.1.5 to not bypass previous MRs when forwarding the SDP offer, and did not bypass previous MRs in step 4b), then the IMS-ALG shall: +- a) replace the connection address and port information for the media line in the SDP answer with the local connection address and port information for the incoming termination on the selected MR. + +### 6.2.9 Forwarding the SDP answer + +The IMS-ALG forwards the SDP answer according to TS 24.229 [4]. + +The IMS-ALG shall release each MR for the media line, when it is no longer potentially needed for this and any other forked dialog. + +## 6.3 IMS-ALG OMR media resource operations + +### 6.3.1 General + +The IMS-ALG OMR procedures as specified by clauses 6.1 and 6.2 refer to generic MR allocation operation. When no MR was previously allocated, e.g. during the initial SDP offer/answer exchange, this allocation will result in the allocation of one or more local media termination point pairs (ingress and egress) – one for the primary IP realm and possible additional terminations points for secondary IP realms. + +Subsequent SDP offer/answer exchanges may result in the decision that a local MR is needed. If a local MR was not previously allocated, then one will now be allocated. If a local MR was previously allocated that matches the resource information needed, then the previously allocated resource will be used. If the previously allocated local MR does not match the resource information needed, then the local MR will be modified to meet the current need. + +If it is determined that local MR may be by-passed or no longer needed, then any previously allocated local MRs will be deallocated. + +### 6.3.2 IMS-ALG operations + +The OMR MR procedures in this document are applicable to the following IMS entities that perform as IMS-ALG using the media resource interface operations as indicated. + +- An IBCF acting as an IMS-ALG controlling a TrGW using the Ix interface as defined by TS 29.162 [16] and TS 29.238 [9]: + - Reserve TrGW Connection Point; + - Configure TrGW Connection Point, + - Reserve and Configure TrGW Connection Point; and + - Release TrGW Connection Point. +- A P-CSCF acting as IMS-ALG controlling an IMS-AGW using the Iq interface as defined by TS 23.334 [15] and TS 29.334 [10]: + - Reserve AGW Connection Point; + - Configure AGW Connection Point; + - Reserve and Configure AGW Connection Point; and + - Release AGW Connection Point. +- An AS acting as B2BUA and adapting IMS-ALG procedures to control an MRF shall use one or more of the following: + - IETF RFC 4240 [11] conference service; + - IETF RFC 4117 [19]; and + - IETF RFC 3260 [12] and IETF RFC 6505 [13]. + +## 6.4 Handling of connected IP realms + +For each IP realm to which a controlled MR has direct access, the IMS-ALG supporting OMR may be provisioned with a list of the names of connected IP realms, if any. The IMS-ALG shall determine if an IP realm is connected to a local IP realm based only on provisioning. + +NOTE 1: The OMR algorithm assumes that a first IMS-ALG or UA sending an SDP offer that offers connectivity via a local IP realm will accept from a second IMS-ALG or UA an SDP answer with an address in a connected IP realm, even if the first IMS-ALG or UA does not have provisioned information about the connected IP realm. + +NOTE 2: Connected IP realm lists only need to be provisioned at certain OMR-capable nodes. For example, it is preferred that an IBCF whose TrGW has connectivity to multiple peer networks via bilateral interconnect be provisioned with connected IP realm information. + +# --- 7 UA Procedures + +## 7.1 UA sending an initial SDP offer + +Upon preparing an initial SDP offer for sending to begin an initial SDP offer/answer transaction, a UA supporting OMR shall additionally: + +- 1) add to the initial SDP offer a visited-realm instance for the IP realm associated with the connection address and port information for the media line in the initial SDP offer; +- 2) for each combination of IP realm, nettype and addrtype on the outgoing side for which the UA can allocate an MR termination according to local policy, if the IP realm, nettype and addrtype are not associated with the media + +line in the initial SDP offer, allocate an MR termination for the IP realm, nettype and addrtype on the outgoing side, using the same codecs associated with the media line; + +- 3) add to the initial SDP offer a secondary-realm instance for each termination allocated in step 2); and +- 4) compute a checksum values as described in clause 5.6.3 and add the "omr-s-cksum" and "omr-m-cksum" attributes for the media line. + +The UA then sends the initial SDP offer according to TS 24.229 [4]. + +NOTE: A subsequent SDP offer is sent according to procedures in clause 8. + +## 7.2 UA receiving an initial SDP offer + +### 7.2.1 General + +Upon receiving an SDP offer that includes OMR attributes and selecting a codec for the media line, a UA supporting OMR shall perform the procedures specified in clauses 7.2.2 and 7.2.3, and then send the initial or second SDP answer according to TS 24.229 [4]. + +### 7.2.2 Validating the incoming SDP offer + +If any of the following conditions are true: + +- 1) the SDP offer includes any OMR attributes for the media line, but no visited-realm instance; +- 2) the connection-address and port information in the visited-realm instance with the highest value of instance-number for the media line does not match the connection address and port information for the media line; or +- 3) one of the following checksum comparison failures are true: + - the "omr-m-cksum" attribute does not match the checksum value computed for the media line as described in clause 5.6.3; or + - based on local policy, if the "omr-m-cksum" attribute matches the computed media line checksum, but the "omr-s-cksum" attribute does not match the checksum value computed for the session level lines as described in clause 5.6.3, + +then the UA shall remove all OMR related attributes associated with the media line. + +### 7.2.3 UA may choose an alternate realm instance to bypass an upstream MR + +If all the following conditions are true: + +- 1) the UA can make available a media termination in an IP realm, nettype and addrtype such that this IP realm or a connected IP realm, nettype and addrtype match the IP realm, nettype and addrtype of a visited-realm or secondary-realm instance for the media line in the SDP offer; +- 2) the instance does not match the connection address and port information in the SDP offer; and +- 3) the instance supports the codec selected by the UA, + +then the UA shall: + +- 1) select the visited-realm or secondary-realm instance with the lowest value of instance-number such that the UA can make available a media termination in the IP realm or connected IP realm, nettype and addrtype that matches the IP realm, nettype and addrtype of the instance and the instance supports the codec selected by the UA; +- 2) allocate a media termination in the selected IP realm, nettype and addrtype; +- 3) copy into the media line of the SDP answer the selected visited-realm or secondary-realm instance from the media line of the received SDP offer, replacing the connection-address and port information in the instance with the local connection address and port information for the allocated termination, and if the IP realm in the instance is a connected IP realm, replacing the IP realm name with the corresponding local IP realm name; and + +- 4) replace the connection address information in the SDP answer with the unspecified address of the appropriate type for the network into which the SDP answer will be sent (i.e., IPv4: "0.0.0.0", IPv6: "invalid.invalid"). + +## 7.3 UA receiving an initial SDP answer + +### 7.3.1 General + +Upon receiving the initial SDP answer corresponding to the initial SDP offer sent in clause 7.1, the UA supporting OMR shall perform the procedures specified in either clause 7.3.2 if the initial SDP answer included a realm instance or clause 7.3.3 if the initial SDP answer did not include a realm instance. + +### 7.3.2 Receiving SDP answer with an unspecified connection address + +If the received SDP answer for the media line includes an unspecified connection address (i.e., IPv4: "0.0.0.0", IPv6: "invalid.invalid") and a visited-realm or a secondary-realm instance with an instance-number that matches a visited-realm or secondary-realm instance for the media line from the SDP offer, then the UA shall: + +NOTE: The IP realms in the two realm instances either have the same name or are connected. + +- 1) update the remote connection address and port information for the selected outgoing termination with the connection-address and port information from the visited-realm or secondary-realm instance in the received SDP answer; and +- 2) release any other MR apart from the selected MR allocated for the media line, when it is no longer potentially needed for any other forked dialog. + +### 7.3.3 Receiving SDP answer with a valid connection address + +If the received SDP answer includes a valid (not unspecified) connection address for the media line, then the UA shall: + +- 1) update the remote connection address and port information for the primary outgoing termination with the connection address and port information from the received SDP answer; and +- 2) release any secondary MR allocated for the media line, when it is no longer potentially needed for any other forked dialog. + +## 7.4 UA OMR media resource operations + +### 7.4.1 General + +The UA OMR procedures as specified by clauses 7.1, 7.2, and 7.3 refer to generic MR allocation operation. This allocation will result in the allocation of a local media termination associated with the selected IP realm. + +Subsequent SDP offer/answer exchanges may result in either the exact same local MR being allocated or possibly a different local MR. If the UA is able to determine that the same resource information is being requested, the existing allocated local MR will be used. If the previously allocated local MR does not match the resource information needed, then the local MR will be modified to meet the current need. + +### 7.4.2 UA operations + +The OMR MR procedures in this document are applicable to the following IMS entities that perform as UA using the media resource interface operations as indicated. + +- An AS acting as B2BUA and adapting UA procedures to control an MRF shall use one or more of the following: + - IETF RFC 4240 [11] conference service and tone/announcement service; + - IETF RFC 5552 [18]; and + - IETF RFC 3260 [12] and IETF RFC 6505 [13]. +- An MGCF acting as an UA controlling an IM-MGW using the Mn interface as defined by TS 29.163 [17] and TS 29.332 [14]: + +- Reserve IMS Connection Point; +- Configure IMS Connection Point; +- Reserve and Configure IMS Connection Point; and +- Release IMS Connection Point. + +## 7.5 Handling of connected IP realms + +For each IP realm to which a controlled MR has direct access, the UA supporting OMR may be provisioned with a list of the names of connected IP realms, if any. The UA shall determine if an IP realm is connected to a local IP realm based only on provisioning. + +NOTE 1: The OMR algorithm assumes that a first IMS-ALG or UA sending an SDP offer that offers connectivity via a local IP realm will accept from a second IMS-ALG or UA an SDP answer with an address in a connected IP realm, even if the first IMS-ALG or UA does not have provisioned information about the connected IP realm. + +NOTE 2: Connected IP realm lists only need to be provisioned at certain OMR-capable nodes. For example, it is preferred that an IBCF whose TrGW has connectivity to multiple peer networks via bilateral interconnect be provisioned with connected IP realm information. + +# --- 8 Subsequent SDP offer/answer transactions + +## 8.1 General + +Any UA or IMS-ALG controlling a media stream may initiate a subsequent SDP offer/answer transaction at any time after first establishing the media flow, in order to modify characteristics of the media flow. + +NOTE: For example, a media endpoint (IP address) can change, the preferred codec can change, or a server can select to insert a media function such as a tone generator or conference focus. + +An IMS-ALG or UA shall handle a received SDP offer as a subsequent SDP offer as specified in clause 8.2 if an initial or second SDP offer/answer transaction has been completed and a received SDP offer contains no OMR specific SDP attributes. + +## 8.2 IMS-ALG and UA subsequent SDP offer procedures + +When a IMS-ALG determines according to clause 8.1 that a received SDP offer shall be handled as a subsequent SDP offer, the IMS-ALG with or without a local primary or secondary MR allocated shall perform the following steps: + +- 1) determine if the local primary or secondary MR can be inserted or removed from the media path as specified in clause 8.4; +- 2) if the IMS-ALG keeps an allocated MR or allocates a new MR and continues with an MR inserted in the media path, the IMS-ALG shall: + - if necessary (e.g. due to a codec change or allocation of a new MR) interact with the MR; + - update the connection address for the media line in the outgoing subsequent SDP offer; and + - forward the modified SDP offer as specified in 3GPP TS 24.229 [4]. +- 3) if the IMS-ALG does not allocate a new MR or deallocated an MR allocated in the initial or second SDP offer / answer transaction in clause 6 and continues without a MR inserted in the media path, forward the incoming subsequent SDP offer as received. + +When a UA (e.g. a conference application treating the media resource as an endpoint or an MGCF) determines according to clause 8.1 that a SDP offer shall be sent as a subsequent SDP offer , the UA shall not apply OMR + +procedures in clause 7 when sending the subsequent SDP offer. If the conditions in clause 8.4 for reallocating a MR are fulfilled, the UA may reallocate a MR. + +## 8.3 IMS-ALG and UA subsequent SDP answer procedures + +When an IMS-ALG receives a subsequent SDP answer as the result of a subsequent SDP offer generated according to clauses 8.2, the IMS-ALG with or without a local primary or secondary MR allocated shall perform the following steps: + +- 1) if the IMS-ALG has a local MR allocated: + +NOTE: The local MR can have been allocated during the initial or second SDP offer / answer transaction as described in clause 6 or as the result of the subsequent SDP offer generated in clause 8.2. + +- a) if necessary interact with the MR as described in clauses 6.3; and +- b) update connection address in the outgoing subsequent SDP answer for the media line with the MR connection information; +- c) forward the modified SDP answer as specified in 3GPP TS 24.229 [4]; and + +- 2) if the IMS-ALG has no local MR allocated: + +- a) if the local MR was allocated when the subsequent SDP offer was received, release MR resources; and +- b) forward the subsequent SDP answer as received. + +When a UA not acting as a B2BUA (e.g. a conference application treating the media resource as an endpoint or the MGCF) receives a subsequent SDP answer, the UA shall not apply OMR procedures specified in clause 7. + +## 8.4 Handling media resources during a subsequent SDP offer/answer transaction + +An IMS-ALG, an AS acting as B2BUA and adapting IMS-ALG procedures to control an MRF or a UA not acting as a B2BUA (e.g. a conference application treating the media resource as an endpoint or the MGCF) shall not allocate, deallocate or reallocate a MR during the subsequent SDP offer/answer transaction unless any of the following exceptions apply: + +- an IMS-ALG may allocate an MR resource if the downstream and upstream media anchoring points are within the same realm and in the same operator network as the IMS-ALG; +- an IMS-ALG may deallocate an MR resource if the downstream and upstream media anchoring points are within the same realm and in the same operator network as the IMS-ALG; or +- an UA may reallocate an MR resource if the downstream and upstream media anchoring point is within the same realm and in the same operator network as the UA. + +If an IMS-ALG or UA decides to allocate or reallocate a MR, the IMS-ALG or UA shall interact with the MR as described in clause 6.3 or 7.4. + +If a IMS-ALG decides to deallocate a MR, the IMS-ALG shall release the MR resource when receiving the subsequent SDP answer. + +# Annex A (informative): Signalling flows + +## A.1 Scope of signalling flows + +This annex gives examples of signalling flows for Optimized Media Routeing (OMR) based on the Session Initiation Protocol (SIP) and the Session Description Protocol (SDP). The OMR specific SDP syntax is described in TS 24.229 [4]. + +## A.2 Introduction + +The signalling flows in this annex are based on IP realm and IP structure in Figure A.2-1. + +![Diagram of IP realm and IP structure showing Home IMS network H, IPX network X, and Visited network V with various network elements like S-CSCF, IBCF, TrGW, IC, MGW, P-CSCF, PCRF, PDN, TRF, and UEs.](4af57aad638888edf2062306f8a54a6c_img.jpg) + +The diagram illustrates the IP realm and IP structure across three network domains: + +- Home IMS network H:** Realm Ha.operatorH.net. It contains an S-CSCF/BGCF connected to two parallel paths. Each path consists of an IBCF (IBCF-2 and IBCF-3) and a TrGW. IP addresses shown are 190.1.15.2 (Ha), Xa4 179.14.1.2, and Xa4 179.14.1.3. +- IPX network X:** Realm Xa.operatorX.net. It connects to the Home network via two parallel paths. Each path consists of an IC (IC-1 and IC-2) and an MGW. IP addresses shown are 179.14.1.1 (Xa2), 179.14.1.4 (Xa2), Xa2 178.15.1.2, and Xa2 178.15.1.3. +- Visited network V:** Realm Va.operatorV.net. It contains a UE-A (Va 192.0.2.1) connected to a P-CSCF-A, which is connected to a PCRF and a PDN. The PDN is connected to a TrGW (IBCF-1) with IP address 192.0.2.2. Another TrGW (IBCF-4) with IP address 192.0.2.3 is connected to a TRF, which is connected to another TrGW (IBCF-5) with IP address Va 192.0.2.4. + +**Legend:** + +- Solid line with double arrow: Control signalling path +- Dashed line with single arrow: Media path after OMR + +Diagram of IP realm and IP structure showing Home IMS network H, IPX network X, and Visited network V with various network elements like S-CSCF, IBCF, TrGW, IC, MGW, P-CSCF, PCRF, PDN, TRF, and UEs. + +Figure A.2-1: IP realm and IP structure + +Operator X and operator Y have an agreement to allow roaming users and to use OMR as much as possible. + +UE-A and UE-B are mobile users roaming into the visited network X. IP addresses etc. are obtained as described in TS 24.229 [4]. + +The operator X implements the IBCF policy to allow OMR optimization of anchoring if originating UE is a visiting/roaming user respectively if terminating UE is a visiting/roaming user. + +The operator Y implements the IBCF policy to allow OMR optimization of anchoring if home UE is visiting/roaming in another network. + +## --- A.3 Media bypassing all IMS-ALGs + +### A.3.1 General + +This clause provides an example of a call where the media is bypassing all IMS-ALG and sent directly between the UEs. + +### A.3.2 Message flow + +This clause describes the scenario when two mobile user A and B roams into a visited network X and both users belongs to the same operator Y. + +Preconditions: + +- Both user A and B are registered to the Home IMS network Y via the visited operator X network; +- the visited operator X and the operator of user A and B IMS home network Y have an agreement to allow media to be bypassed using OMR; +- both user A and B are connected to IP realm Xa of the visited operator network X; +- the AMR codec is allowed and accepted by all involved entities; and +- no B2BUA manipulating SDP is connected in the intermediate IM CN subsystem. + +Figure A.3.2-1 shows the message flow for the scenario. + +![Sequence diagram showing the signalling flow for media bypassing all IMS ALGs. The diagram illustrates the interaction between UE-A, P-CSCF A, IBCF-1, IBCF-2, Intermediate IM CN subsystem entities X, IBCF-3, IBCF-4, P-CSCF B, and UE-B. The flow includes INVITE, 183, PRACK, 200 OK (PRACK), UPDATE, 200 OK (UPDATE), 180, 200 OK (INVITE), and ACK messages. The audio media path is established between UE-A and UE-B via the Intermediate IM CN subsystem entities X.](dd5771673aececa53d42ece89218299d_img.jpg) + +The diagram illustrates the signalling flow for media bypassing all IMS ALGs. It shows the interaction between UE-A, P-CSCF A, IBCF-1, IBCF-2, Intermediate IM CN subsystem entities X, IBCF-3, IBCF-4, P-CSCF B, and UE-B. The flow includes INVITE, 183, PRACK, 200 OK (PRACK), UPDATE, 200 OK (UPDATE), 180, 200 OK (INVITE), and ACK messages. The audio media path is established between UE-A and UE-B via the Intermediate IM CN subsystem entities X. + +**Visited network X** (Realms: Xa.operatorX.net, X.operatorX.net, X.operatorY.net) + +**Home IMS network Y (of user A and B)** (Realms: Yb.operatorY.net, X.operatorY.net) + +**Visited network X** (Realms: Xa.operatorX.net, X.operatorX.net, X.operatorY.net) + +**Entities:** UE-A (192.0.2.1), P-CSCF A (192.0.2.2), IBCF-1 (13.24.1.1), IBCF-2 (13.24.1.2), Intermediate IM CN subsystem entities X (190.1.15.2), IBCF-3 (190.1.15.3), IBCF-4 (13.24.1.4), P-CSCF B (192.0.2.3), UE-B (192.0.2.4) + +**Signalling Flow:** + +1. INVITE [AMR, c=192.0.2.1] from UE-A to P-CSCF A +2. INVITE [AMR, c=192.0.2.1] from P-CSCF A to IBCF-1 +3. INVITE [AMR, c=13.24.1.1, visited-realm:1 Xa 192.0.2.1, visited-realm:2 X-Y 13.24.1.1] from IBCF-1 to IBCF-2 +4. INVITE [AMR, c=190.1.15.2, visited-realm:1 Xa 192.0.2.1, visited-realm:2 X-Y 13.24.1.1, visited-realm:3 Yb 190.1.15.2] from IBCF-2 to Intermediate IM CN subsystem entities X +5. INVITE [AMR, c=190.1.15.2, visited-realm:1 Xa 192.0.2.1, visited-realm:2 X-Y 13.24.1.1, visited-realm:3 Yb 190.1.15.2] from Intermediate IM CN subsystem entities X to IBCF-3 +6. INVITE [AMR, c=13.24.1.1, visited-realm:1 Xa 192.0.2.1, visited-realm:2 X-Y 13.24.1.1] from IBCF-3 to IBCF-4 +7. INVITE [AMR, c=192.0.2.1, visited-realm:1 Xa 192.0.2.1] from IBCF-4 to P-CSCF B +8. INVITE [c=192.0.2.1] from P-CSCF B to UE-B +9. 183 [c=192.0.2.4] from UE-B to P-CSCF B +10. 183 [AMR, c=192.0.2.4] from P-CSCF B to IBCF-4 +11. 183 [AMR, c=0.0.0.0, visited-realm:1 Xa 192.0.2.4] from IBCF-4 to IBCF-3 +12. 183 [AMR, c=0.0.0.0, visited-realm:1 Xa 192.0.2.4] from IBCF-3 to Intermediate IM CN subsystem entities X +13. 183 [AMR, c=0.0.0.0, visited-realm:1 Xa 192.0.2.4] from Intermediate IM CN subsystem entities X to IBCF-2 +14. 183 [AMR, c=0.0.0.0, visited-realm:1 Xa 192.0.2.4] from IBCF-2 to IBCF-1 +15. 183 [AMR, c=192.0.2.4] from IBCF-1 to P-CSCF A +16. 183 [AMR, c=192.0.2.4] from P-CSCF A to UE-A +17. PRACK from UE-A to P-CSCF A +18. PRACK from P-CSCF A to IBCF-1 +19. PRACK from IBCF-1 to IBCF-2 +20. PRACK from IBCF-2 to Intermediate IM CN subsystem entities X +21. PRACK from Intermediate IM CN subsystem entities X to IBCF-3 +22. PRACK from IBCF-3 to IBCF-4 +23. PRACK from IBCF-4 to P-CSCF B +24. PRACK from P-CSCF B to UE-B +25. 200 OK (PRACK) from UE-B to P-CSCF B +26. 200 OK (PRACK) from P-CSCF B to IBCF-4 +27. 200 OK (PRACK) from IBCF-4 to IBCF-3 +28. 200 OK (PRACK) from IBCF-3 to Intermediate IM CN subsystem entities X +29. 200 OK (PRACK) from Intermediate IM CN subsystem entities X to IBCF-2 +30. 200 OK (PRACK) from IBCF-2 to IBCF-1 +31. 200 OK (PRACK) from IBCF-1 to P-CSCF A +32. 200 OK (PRACK) from P-CSCF A to UE-A +33. UPDATE [AMR, c=192.0.2.1] from UE-A to P-CSCF A +34. UPDATE [AMR, c=192.0.2.1] from P-CSCF A to IBCF-1 +35. UPDATE [AMR, c=192.0.2.1] from IBCF-1 to IBCF-2 +36. UPDATE [AMR, c=192.0.2.1] from IBCF-2 to Intermediate IM CN subsystem entities X +37. UPDATE [AMR, c=192.0.2.1] from Intermediate IM CN subsystem entities X to IBCF-3 +38. UPDATE [AMR, c=192.0.2.1] from IBCF-3 to IBCF-4 +39. UPDATE [AMR, c=192.0.2.1] from IBCF-4 to P-CSCF B +40. UPDATE [AMR, c=192.0.2.1] from P-CSCF B to UE-B +41. 200 OK (UPDATE) [c=192.0.2.4] from UE-B to P-CSCF B +42. 200 OK (UPDATE) [AMR, c=192.0.2.4] from P-CSCF B to IBCF-4 +43. 200 OK (UPDATE) [AMR, c=192.0.2.4] from IBCF-4 to IBCF-3 +44. 200 OK (UPDATE) [AMR, c=192.0.2.4] from IBCF-3 to Intermediate IM CN subsystem entities X +45. 200 OK (UPDATE) [AMR, c=192.0.2.4] from Intermediate IM CN subsystem entities X to IBCF-2 +46. 200 OK (UPDATE) [AMR, c=192.0.2.4] from IBCF-2 to IBCF-1 +47. 200 OK (UPDATE) [AMR, c=192.0.2.4] from IBCF-1 to P-CSCF A +48. 200 OK (UPDATE) [AMR, c=192.0.2.4] from P-CSCF A to UE-A +49. 180 from UE-B to P-CSCF B +50. 180 from P-CSCF B to IBCF-4 +51. 180 from IBCF-4 to IBCF-3 +52. 180 from IBCF-3 to Intermediate IM CN subsystem entities X +53. 180 from Intermediate IM CN subsystem entities X to IBCF-2 +54. 180 from IBCF-2 to IBCF-1 +55. 180 from IBCF-1 to P-CSCF A +56. 180 from P-CSCF A to UE-A +57. 200 OK (INVITE) [c=192.0.2.4] from UE-B to P-CSCF B +58. 200 OK (INVITE) [AMR, c=192.0.2.4] from P-CSCF B to IBCF-4 +59. 200 OK (INVITE) [AMR, c=192.0.2.4] from IBCF-4 to IBCF-3 +60. 200 OK (INVITE) [AMR, c=192.0.2.4] from IBCF-3 to Intermediate IM CN subsystem entities X +61. 200 OK (INVITE) [AMR, c=192.0.2.4] from Intermediate IM CN subsystem entities X to IBCF-2 +62. 200 OK (INVITE) [AMR, c=192.0.2.4] from IBCF-2 to IBCF-1 +63. 200 OK (INVITE) [AMR, c=192.0.2.4] from IBCF-1 to P-CSCF A +64. 200 OK (INVITE) [AMR, c=192.0.2.4] from P-CSCF A to UE-A +65. ACK from UE-A to P-CSCF A +66. ACK from P-CSCF A to IBCF-1 +67. ACK from IBCF-1 to IBCF-2 +68. ACK from IBCF-2 to Intermediate IM CN subsystem entities X +69. ACK from Intermediate IM CN subsystem entities X to IBCF-3 +70. ACK from IBCF-3 to IBCF-4 +71. ACK from IBCF-4 to P-CSCF B +72. ACK from P-CSCF B to UE-B + +**audio media** (established between UE-A and UE-B via Intermediate IM CN subsystem entities X) + +Sequence diagram showing the signalling flow for media bypassing all IMS ALGs. The diagram illustrates the interaction between UE-A, P-CSCF A, IBCF-1, IBCF-2, Intermediate IM CN subsystem entities X, IBCF-3, IBCF-4, P-CSCF B, and UE-B. The flow includes INVITE, 183, PRACK, 200 OK (PRACK), UPDATE, 200 OK (UPDATE), 180, 200 OK (INVITE), and ACK messages. The audio media path is established between UE-A and UE-B via the Intermediate IM CN subsystem entities X. + +NOTE: For clarity, the SIP 100 (Trying) messages are not shown in the signalling flow. + +**Figure A.3.2-1: Signalling flow for media bypassing all IMS ALGs** + +The steps of the flow are as follows: + +#### **1. INVITE request (UE-A to P-CSCF-A) - see example in table A.3.2-1.** + +The UE-A sends a SIP INVITE request including an initial SDP offer according to TS 24.229 [4]. + +**Table A.3.2-1: SIP INVITE request (UE-A to P-CSCF-A)** + +``` + +INVITE SIP: user_B@operator_Y.net; SIP/2.0 + +SIP headers according to 3GPP TS 24.229 [4] + +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 2987933615 2987933615 IN IP4 192.0.2.1 +s= +t=0 0 +c=IN IP4 192.0.2.1 +m=audio 49170 RTP/AVP 96 97 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; mode-change-period=2 +a=rtpmap:96 telephone-event +a=maxptime:20 + +``` + +#### 2. INVITE request (P-CSCF-A to IBCF-1) - see example in table A.3.2-1. + +The P-CSCF-A uses the procedures in clauses 6.1.5, 6.1.7 and 6.1.9 since no MR could be bypassed and no MR is allocated. + +The P-CSCF-A: + +- uses the connection-address from the SDP c-line as incoming connection-address in subsequent steps; +- uses the port information from the SDP m-line as incoming port information in subsequent steps; +- uses the codec information from the SDP m-line in subsequent steps; +- inserts the incoming codec information into the SDP m-line and associated attribute lines of the modified initial SDP offer; +- uses the incoming connection address as the connection address in the SDP c-line of the forwarded initial SDP offer, and +- use the incoming port information as port information in the SDP m-line of the modified initial SDP offer. + +The P-CSCF-A then selects an IBCF, IBCF-1, in the IP realm "Xa.operatorX.net" and forwards the INVITE request with the initial SDP offer to the IBCF-1 according to TS 24.229 [4]. + +#### 3. INVITE request (IBCF-1 to IBCF-2) - see example in table A.3.2-3 + +The IBCF-1 uses the procedures in clauses 6.1.5, 6.1.6 and 6.1.9 since no previous realm instance offers an opportunity to bypass a previous MR and a local MR is required for IP realm matching. + +The IBCF-1: + +- uses the connection-address from the SDP c-line as incoming connection-address in subsequent steps; +- uses the port information from the SDP m-line as incoming port information in subsequent steps; +- uses the codec information from the SDP m-line in subsequent steps; +- allocates an MR context with access to the IP realms and addrtypes associated with the incoming and outgoing signalling paths; +- inserts the incoming connection address and incoming port information for the media line into the remote connection address and port information for the incoming termination on the MR; +- provides to the MR the incoming codec information; + +- replaces the connection address and port information for the media line in the initial SDP offer with the connection address and port information from the MR termination on the outgoing side; +- constructs and adds a visited-realm instance for the media line in the received initial SDP offer to the modified initial SDP offer; +- adds to the modified initial SDP offer a visited-realm instance for the IP realm associated with the connection address and port information for the media line in the modified initial SDP offer, including the incoming codec; and +- computes a checksum value for the media line as described in clause 5.6.3 and adds the "omr-m-cksum" and "omr-s-cksum" attributes for the media line. The "omr-s-cksum" is set to "0" since there are no session attributes to compute the checksum on. + +The IBCF-1 then selects an IBCF, IBCF-2, in the IP realm "X-Y.operatorX.net" and forwards the INVITE request with the initial SDP offer to the IBCF-2 according to TS 24.229 [4]. + +**Table A.3.2-3: SIP INVITE request (IBCF-1 to IBCF-2)** + +``` +INVITE SIP: user_B@operator_Y.net; SIP/2.0 + +SIP headers according to 3GPP TS 24.229 [4] + +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933615 IN IP4 192.0.2.1 +s= +t=0 0 +c=IN IP4 13.24.1.1 +m=audio 62111 RTP/AVP 96 97 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; mode-change-period=2 +a=rtpmap:96 telephone-event +a=maxptime:20 +a=visited-realm:1 Xa.operatorX.net IN IP4 192.0.2.1 49170 +a=visited-realm:2 X-Y.operator.netX IN IP4 13.24.1.1 62111 +a=omr-m-cksum:(..) +a=omr-s-cksum:0 +``` + +#### 4-5. INVITE request (IBCF-2 to IBCF-3 via intermediate IMS CN subsystem entities) - see example in table A.3.2-4. + +The IBCF-2 uses the procedure in clauses 6.1.5, 6.1.6 and 6.1.9 since no realm instance offers an opportunity to bypass a previous MR and a local MR is required for IP realm matching. + +The IBCF-2: + +- uses the connection-address from the SDP c-line as incoming connection-address in subsequent steps; +- uses the port information from the SDP m-line as incoming port information in subsequent steps; +- uses the codec information from the SDP m-line and associated non-OMR attribute lines as incoming codec information in subsequent steps; +- allocates an MR context with access to the IP realms, nettypes and addrtypes associated with the incoming and outgoing signalling paths, respectively, applying procedures as described in clause 6.3, +- insert the incoming connection address and incoming port information for the media line into the remote connection address and port information for the incoming termination on the MR; +- provides to the MR the incoming codec information; +- replaces the connection address and port information for the media line in the initial SDP offer with the connection address and port information from the MR termination on the outgoing side; + +- adds to the modified initial SDP offer a visited-realm instance for the IP realm associated with the connection address and port information for the media line in the modified SDP offer, including the incoming codec; and +- computes a checksum value for the media line as described in clause 5.3.4 and adds the "omr-m-cksum" and "omr-s-cksum" attributes for the media line The "omr-s-cksum" attribute is set to "0" since there are no session attributes to compute the checksum on.. + +The IBCF-2 forwards the INVITE request to the intermediate IMS CN subsystem entities in IP realm "Yb.operatorY.net" according to TS 24.229 [4]. + +None of the intermediate IMS CN subsystem entities manipulated with the initial SDP offer but the identity of [user\\_B@operator\\_Y.net](#) in the Request-URI is change to the contact address, i.e. UE-B@operatorX.net. + +The intermediate IMS CN subsystem entities select an IBCF, IBCF-3, and forward the INVITE request with the initial SDP offer to the IBCF-3 according to TS 24.229 [4]. + +**Table A.3.2-4: SIP INVITE request (IBCF-2 to IBCF-3 via intermediate IMS CN subsystem entities)** + +``` +INVITE SIP: sip:UE-B@operatorX.net; SIP/2.0 + +SIP headers according to 3GPP TS 24.229 [4] + +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933615 IN IP4 192.0.2.1 +s= +t=0 0 +c=IN IP4 190.1.15.2 +m=audio 11324 RTP/AVP 96 07 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; mode-change-period=2 +a=rtpmap:96 telephone-event +a=maxptime:20 +a=visited-realm:1 Xa.operatorX.net IN IP4 192.0.2.1 49170 +a=visited-realm:2 X-Y.operator.netX IN IP4 13.24.1.1 62111 +a=visited-realm:3 Yb.operatorY.net IN IP4 190.1.15.2 11324 +a=omr-m-cksum:(..) +a=omr-s-cksum:0 +``` + +#### 6. INVITE request (IBCF-3 to IBCF-4) - see example in table A.3.2-6. + +The IBCF-3 uses the procedures in clauses 6.1.4, 6.1.7 and 6.1.9 since a previous realm instance exists that can be used to bypass a previous MR, IBCF-2, and bypass is allowed according to operator X and operator Y agreements, and the previous realm instance match the outgoing IP realm so that no local MR is required. + +The IBCF-3: + +- uses the connection address and port information for the media line in the initial SDP offer with the connection-address and port information from the selected instance 2 as incoming connection address and incoming port information for the media line; +- deletes the visited-realm instance 3; +- inserts the incoming codec information into the SDP m-line and associated attribute lines of the modified initial SDP offer; +- uses the incoming connection address as the connection address in the SDP c-line of the forwarded initial SDP offer; +- uses the incoming port information as port information in the SDP m-line of the modified initial SDP offer; and + +- computes a checksum value for the media line as described in clause 5.3.4 and adds the "omr-m-cksum" and "omr-s-cksum" attributes for the media line. The "omr-s-cksum" attribute is set to "0" since there are no session attributes to compute the checksum on. + +The IBCF-3 then selects an IBCF, IBCF-4, in the IP realm "X.operatorX.net, Y.operatorY.net" and forwards the initial SDP offer according to TS 24.229 [4] to IBCF-4. + +**Table A.3.2-6: SIP INVITE request (IBCF-3 to IBCF-4)** + +``` +INVITE SIP: sip:UE-B@operatorX.net; SIP/2.0 + +SIP headers according to 3GPP TS 24.229 [4] + +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933615 IN IP4 192.0.2.1 +s= +t=0 0 +c=IN IP4 13.24.1.1 +m=audio 62111 RTP/AVP 96 07 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; mode-change-period=2 +a=rtpmap:96 telephone-event +a=maxptime:20 +a=visited-realm:1 Xa.operatorX.net IN IP4 192.0.2.1 49170 +a=visited-realm:2 X-Y.operator.netIN IP4 13.24.1.1 62111 +a=omr-m-cksum: (...) +a=omr-s-cksum:0 +``` + +#### 7. INVITE request (IBCF-4 to P-CSCF B) - see example in table A.3.2-7. + +The IBCF-4 uses the procedures in clauses 6.1.4, 6.1.7 and 6.1.9 since a previous realm instance exists that can be used to bypass a previous MR, IBCF-1, and the previous realm instance match the outgoing IP realm so that no local MR is required. + +The IBCF-4: + +- uses the connection address and port information for the media line in the initial SDP offer with the connection-address and port information from the selected instance 1 as incoming connection address and incoming port information for the media line; +- deletes the visited-realm instance 2; +- inserts the incoming codec information into the SDP m-line and associated attribute lines of the modified initial SDP offer; +- uses the incoming connection address as the connection address in the SDP c-line of the forwarded initial SDP offer; +- uses the incoming port information as port information in the SDP m-line of the modified initial SDP offer; and +- computes a checksum value for the media line as described in clause 5.3.4 and adds the "omr-m-cksum" and "omr-s-cksum" attributes for the media line. The "omr-s-cksum" attribute is set to "0" since there are no session attributes to compute the checksum on. + +The IBCF-4 forwards the INVITE request with the initial SDP offer to the P-CSCF-B, in the IP realm "X.operatorX.net" according to TS 24.229 [4]. + +**Table A.3.2-7: SIP INVITE request (IBCF-4 to P-CSCF B)** + +``` + +INVITE SIP: sip:UE-B@operatorX.net; SIP/2.0 + +SIP headers according to 3GPP TS 24.229 [4] + +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933615 IN IP4 192.0.2.1 +s= +t=0 0 +c=IN IP4 192.0.2.1 +m=audio 49170 RTP/AVP 96 97 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; mode-change-period=2 +a=rtpmap:96 telephone-event +a=maxptime:20 +a=visited-realm:1 Xa.operatorX.net IN IP4 192.0.2.1 49170 +a=omr-m-cksum:(..) +a=omr-s-cksum:0 + +``` + +#### **8. INVITE request (P-CSCF to UE- B) - see example in table A.3.2-8.** + +The P-CSCF-B uses the procedures in clauses 6.1.5, 6.1.7 and 6.1.9 since no previous realm instance offers an opportunity to bypass an MR and no local MR is required to match the incoming realm to the outgoing realm. + +- uses the connection-address from the SDP c-line as incoming connection-address; +- uses the port information from the SDP m-line as incoming port information; +- uses the codec information from the SDP m-line and associated non-OMR attribute lines as incoming codec information; and +- according to the local policy, deletes the visited-realm "visited-realm:1 Xa.operatorX.net IN IP4 192.0.2.1 49170", the "omr-m-cksum:(...)" and the "omr-s-cksum=:0" attributes from the SDP offer. + +The P-CSCF-B forwards the INVITE request with the initial SDP offer to the UE-B according to TS 24.229 [4]. + +**Table A.3.2-8: SIP INVITE request (P-CSCF to UE-B)** + +``` + +INVITE SIP: sip:UE-B@operatorX.net; SIP/2.0 + +SIP headers according to 3GPP TS 24.229 [4] + +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933615 IN IP4 192.0.2.1 +s= +t=0 0 +c=IN IP4 192.0.2.1 +m=audio 49170 RTP/AVP 96 97 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; mode-change-period=2 +a=rtpmap:96 telephone-event +a=maxptime:20 + +``` + +#### **9. 183 (Session Progress) response (UE-B to P-CSCF-B) - see example in table A.3.2-9.** + +The UE accepts the codec and sends a 183 (Session Progress) response with an initial SDP answer indicating that resources are not yet available to P-CSCF-B according to TS 24.229 [4]. + +**Table A.3.2-9: 183 (Session Progress) response (UE-B to P-CSCF-B)** + +``` + +SIP/2.0 183 Session Progress + +SIP headers according to 3GPP TS 24.229 [4] + +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933615 IN IP4 192.0.2.1 +s=- +c=IN IP4 192.0.2.4 +t=0 0 +m=audio 16511 RTP/AVP 97 98 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:98 AMR +a=fmtp:98 mode-set=0,2,5,7; mode-change-period=2 +a=rtpmap:97 telephone-event +a=maxptime:20 + +``` + +#### **10. 183 (Session Progress) response (P-CSCF-B to IBCF-4) - see example in table A.3.2-9** + +The P-CSCF-B uses the procedures in clauses 6.2.7 and 6.2.9 since the connection address is valid and no primary local MR was allocated. + +The P-CSCF-B:- does not modify the initial SDP answer and forwards the 183 (Session Progress) response with the initial SDP answer to IBCF-4 according to TS 24.229 [4]. + +#### **11. 183 (Session Progress) response (IBCF-4 to IBCF-3) - see example in table A.3.2-11** + +The IBCF-4 uses the procedures in clauses 6.2.7 and 6.2.9 since the connection address is valid and no primary local MR was allocated. + +The IBCF-4: + +- copies into the media line of the initial SDP answer the visited-realm instance 1 from the media line of the received initial SDP offer that was used to populate the connection address and port information in the forwarded initial SDP offer, replacing the connection-address and port information in the instance with the connection address and port information from the received initial SDP answer; and +- replaces the connection address information in the initial SDP answer with the unspecified IPv4 address. + +The IBCF-4 forwards the 183 (Session Progress) response with the initial SDP answer to IBCF-3 according to TS 24.229 [4]. + +**Table A.3.2-11 183 (Session Progress) response (IBCF-4 to IBCF-3)** + +``` + +SIP/2.0 183 Session Progress +SIP headers according to 3GPP TS 24.229 [4] + +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933615 IN IP4 192.0.2.1 +s=- +c=IN IP4 0.0.0.0 +t=0 0 +m=audio 16511 RTP/AVP 97 98 +a=curr:qos local none +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:98 AMR +a=fmtp:98 mode-set=0,2,5,7; mode-change-period=2 +a=rtpmap:97 telephone-event +a=maxptime:20 +a=visited-realm:1 Xa.operatorX.net IN IP4 192.0.2.4 16511 + +``` + +#### **12-13. 183 (Session Progress) response (IBCF-3 to IBCF-2 via intermediate IMS CN subsystem entities) - see example in table A.3.2-11** + +The IBCF-3 uses the procedures in clauses 6.2.5 and 6.2.9 since the initial SDP answer contained an unspecified connection address and a realm instance matching one in the received initial SDP offer and since no primary local MR was allocated. + +The IBCF-3 does not modify the initial SDP answer since the visited-realm instance does not match the information in the initial SDP offer. + +The IBCF-3 then forwards the 183 (Session Progress) response with the initial SDP answer to intermediate IMS CN subsystem entities according to TS 24.229 [4]. + +The intermediate IMS CN subsystem entities do not modify the initial SDP answer and forwards the 183 (Session Progress) response with the initial SDP answer to IBCF-2 according to TS 24.229 [4]. + +#### **14. 183 (Session Progress) response (IBCF-2 to IBCF-1) - see example in table A.3.2-11** + +The IBCF-2 uses the procedures in clauses 6.2.5 and 6.2.9 since the initial SDP answer contained an unspecified connection address and a realm instance matching one in the received initial SDP offer and the local MR allocated in step 4 can be bypassed. + +The IBCF does not modify the initial SDP answer since the visited-realm instance does not match the information in the initial SDP offer. + +The IBCF-2 forwards the 183 (Session Progress) response with initial SDP answer to IBCF-1 according to TS 24.229 [4]. + +The IBCF-2 retains the primary local MR allocated in step 4, until it is no longer potentially needed for this and any other forked dialog. + +#### **15. 183 (Session Progress) response (IBCF-1 to P-CSCF-A) - see example in table A.3.2-15** + +The IBCF-1 uses the procedures in clauses 6.2.5 and 6.2.8 since the initial SDP answer contained an unspecified connection address and a realm instance matching one in the received initial SDP offer and the local MR allocated in step 3 can be bypassed. + +The IMS-ALG: + +- replaces the connection address and port information for the media line in the initial SDP answer with the connection address and port information from the visited-realm instance in the received initial SDP answer. + +The IBCF-1 forwards the 183 (Session Progress) response with the initial SDP answer to P-CSCF-A according to TS 24.229 [4]. + +The IBCF-1 retains the primary local MR allocated in step 3, until it is no longer potentially needed for this and any other forked dialog. + +**Table A.3.2-15: 183 (Session Progress) response (IBCF-1 - P-CSCF-A)** + +``` +SIP/2.0 183 Session Progress + +SIP headers according to 3GPP TS 24.229 [4] + +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933615 IN IP4 192.0.2.1 +s=- +c=IN IP4 192.0.2.4 +t=0 0 +m=audio 16511 RTP/AVP 97 98 +a=curr:qos local none +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:98 AMR +a=fmtp:98 mode-set=0,2,5,7; mode-change-period=2 +a=rtpmap:97 telephone-event +a=maxptime:20 +``` + +#### **16. 183 (Session Progress) response (P-CSCF-A to UE-A) - see example in table A.3.2-15** + +The P-CSCF-A: + +- forwards the 183 (Session Progress) with the initial SDP answer to the UE-A according to TS 24.229 [4]; and +- deletes the visited-realm instance according to local policy. + +#### **17-24. PRACK request (UE-A to UE-B via P-CSCF-A, IBCF-1, IBCF-2, intermediate IMS CN subsystem entities, IBCF-3, IBCF-4 and P-CSCF-B).** + +The UE-A acknowledge the reception of the initial SDP answer and the 183 (Session Progress) response by means of a PRACK request. + +#### **25-32. 200 (OK) response to the PRACK request (UE-B to UE-A via P-CSCF-B, IBCF-4, IBCF-3, intermediate IMS CN subsystem entities, IBCF-2, IBCF-1 and P-CSCF-A).** + +The UE-B acknowledges the reception of the PRACK request by means of a 200 (OK) response. + +#### **33. UPDATE request (UE-A to P-CSCF-A) - see example in table A.3.2-33.** + +When the UE-A has got resources reserved the UE-A sends an UPDATE request. + +The subsequent SDP offer in the UPDATE the request is the same as the initial SDP offer in the INVITE request in the step 1 with the only exception that "a=curr:qos local none" is now changed to "a=curr:qos local sendrecv". + +**Table A.3.2-33: UPDATE request (UE-A to P-CSCF-A)** + +``` + +UPDATE SIP: sip:UE-A@operatorX.net; SIP/2.0 + +SIP headers according to 3GPP TS 24.229 [4] +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933616 IN IP4 192.0.2.4 +s=- +c=IN IP4 192.0.2.1 +t=0 0 +m=audio 16511 RTP/AVP 97 98 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:98 AMR +a=fmtp:98 mode-set=0,2,5,7; mode-change-period=2 +a=rtpmap:97 telephone-event +a=maxptime:20 + +``` + +#### **34-40. UPDATE request (P-CSCF-A to UE-B via IBCF-1, IBCF-2, intermediate IMS CN subsystem entities, IBCF-3, IBCF-4 and P-CSCF-B).** + +- 34) When the P-CSCF-A receives the UPDATE request, the P-CSCF-A forwards the UPDATE request without modifying the subsequent SDP offer. +- 35) When the IBCF-1 receives the UPDATE request, the IBCF-1 forwards the UPDATE request without modifying the subsequent SDP offer. +- 36) When the IBCF-2 receives the UPDATE request, the IBCF-2 forwards the UPDATE request without modifying the subsequent SDP offer. +- 37) Intermediate IMS CN subsystem entities do not manipulate the SDP offer. +- 38) When the IBCF-3 receives the UPDATE request, the IBCF-3 forwards the UPDATE request without modifying the subsequent SDP offer. +- 39) When the IBCF-4 receives the UPDATE request, the IBCF-4 forwards the UPDATE request without modifying the subsequent SDP offer. +- 40) When the P-CSCF-B receives the UPDATE request, the P-CSCF-B forwards the UPDATE request without modifying the subsequent SDP offer. + +#### **41. 200 (OK) response to the UPDATE request (UE-B to P-CSCF-B) - see example in table A.3.2-41.** + +The UE-B acknowledges the reception of the UPDATE request by means of a 200 (OK) response containing a subsequent SDP answer. + +**Table A.3.2-41: 200 (OK) response to the UPDATE request (UE-B to P-CSCF-B).** + +``` + +SIP/2.0 200 OK +Via: +To: ; tag=171828 +From: ; tag=543210 +Call-ID: cb03a0s09a2sdfglkj490237 +CSeq: +P-Preferred-Identity: +Contact: sip:UE-B@operatorX.net;gr=urn:uuid:354faf-7dad-22a1-b123-8a0d21f676f +Allow: +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933615 IN IP4 192.0.2.4 +s= +t=0 0 +c=IN IP4 192.0.2.4 +m=audio 49170 RTP/AVP 97 98 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; mode-change-period=2 +a=rtpmap:96 telephone-event +a=maxptime:20 + +``` + +#### **42-48. 200 (OK) response to the UPDATE request (P-CSCF-B to UE-A via IBCF-4, IBCF-3, intermediate IMS CN subsystem entities, IBCF-2 and IBCF-1).** + +- 42) When P-CSCF-B receives the 200 (OK) response to the UPDATE request, the P-CSCF-B forwards the response without modifying the subsequent SDP answer. +- 43) When IBCF-4 receives the 200 (OK) response to the UPDATE request, the IBCF-4 forwards the response without modifying the subsequent SDP answer. +- 44) When IBCF-3 receives the 200 (OK) response to the UPDATE request, the IBCF-3 forwards the response without modifying the subsequent SDP answer. +- 45) The intermediate IMS CN subsystem entities do not manipulate the SDP answer. +- 46) When IBCF-2 receives the 200 (OK) response to the UPDATE request, the IBCF-2 forwards the response without modifying the subsequent SDP answer. +- 47) When IBCF-1 receives the 200 (OK) response to the UPDATE request, the IBCF-1 forwards the response without modifying the subsequent SDP answer. +- 48) When P-CSCF-A receives the 200 (OK) response to the UPDATE request, the P-CSCF-A forwards the response without modifying the subsequent SDP answer. + +#### **49-56. 180 (Ringing) response (UE-B to UE-A via P-CSCF-B, IBCF-4, IBCF-3, intermediate IMS CN subsystem entities, IBCF-2, IBCF-1 and P-CSCF-A).** + +No OMR specific action is required. + +#### **57-64. 200 (OK) response to the INVITE request (UE-B to UE-A via P-CSCF-B, IBCF-4, IBCF-3, intermediated IMS CN subsystem, IBCF-2, IBCF-1 and P-CSCF-A).** + +The User B accepts the call and the UE-B sends a 200 (OK) response to the INVITE request. No OMR specific action is required. + +#### **65-72. ACK request (UE-A to UE-B via P-CSCF-A, IBCF-1, IBCF-2, intermediated IMS CN subsystem, IBCF-3, IBCF-4 and P-CSCF-B).** + +The UE-B acknowledges the reception of the 200 (OK) response by means of a 200 (OK) response. + +## A.4 IMS-ALG allocates a local transcoding MR when performing proactive transcoding without resource reservation + +### A.4.1 General + +This clause provides an example of a call where a transcoding MR adds the AMR codec to the initial SDP offer without MR allocation. + +The UE selects the added codec and the IMS-ALG needs to reserve MR and send an UPDATE request with the IP address and port number of the allocated MR. + +The IMS-ALG is transcoding between the AMR-WB codec and the AMR codec when the call is established. + +Figure A.4.1-1 shows the realm and IP structure used in this example. + +![Diagram of IP realm and IP structure showing Home IMS network H, IPX network X, and Visited network V with various network elements like S-CSCF, IBCF, TrGW, IC, MGW, P-CSCF, PCRF, PDN, and TRF.](e94cbc0895c6914a2bb53f150ab7495e_img.jpg) + +The diagram illustrates the IP realm and IP structure across three networks: + + +- Home IMS network H:** Realm Ha.operatorH.net. Contains S-CSCF/BGCF, IBCF-2 (IP: 190.1.15.2 Ha), TrGW (Xa4: 179.14.1.2), IBCF-3 (IP: 190.1.15.2 Ha), and TrGW (Xa4: 179.14.1.3). +- IPX network X:** Realm Xa.operatorX.net. Contains IC-1 (IP: 179.14.1.1 Xa2), MGW (Xa2: 178.15.1.2), IC-2 (IP: 179.14.1.4 Xa2), and MGW (Xa2: 178.15.1.3). +- Visited network V:** Realm Va.operatorV.net. Contains UE-A (IP: Va 192.0.2.1), P-CSCF-A, PCRF, PDN, IBCF-1 (IP: 178.15.1.1 Xa1), TrGW (IP: 192.0.2.2), IBCF-4 (IP: 178.15.1.4 Xa1), TrGW (IP: 192.0.2.3), TRF, IBCF-5 (IP: 192.0.2.4), and TrGW (IP: Va 192.0.2.4). + + Signaling paths (solid lines) connect UE-A to P-CSCF-A, then to IBCF-1, IBCF-4, TRF, and IBCF-5. Media paths (dashed lines) connect UE-A to PDN, then to IBCF-5. + +Diagram of IP realm and IP structure showing Home IMS network H, IPX network X, and Visited network V with various network elements like S-CSCF, IBCF, TrGW, IC, MGW, P-CSCF, PCRF, PDN, and TRF. + +Figure A.4.1-1: IP realm and IP structure + +### A.4.2 Message flow + +The user A at UE-A and the user B at UE-B are roaming into a visited network X and both users belong to the same operator Y. + +Preconditions: + +- Both user A and B are registered to the Home IMS network Y via the visited operator X network; +- the visited operator X and the operator Y have an agreement to allow media to be bypassed using OMR; +- both user A and B are connected to the realm "Xa.operatorX.net" of the visited operator network X; + +- the AMR-WB codec is allowed and accepted by all involved entities. However, the local policy of operator X is that the AMR codec shall always be included in the initial SDP offer from a UE in the operator X network; and +- no B2BUA manipulating SDP is connected in the intermediate IM CN subsystem. + +Figure A.4.2-1 shows the message flow for the scenario. + +![Sequence diagram showing message flow for proactive transcoding. Lifelines: UE-A, P-CSCF A, IBCF-1, IBCF-2, Intermediate IM CN subsystem entities X, IBCF-3, IBCF-4, P-CSCF B, UE-B. The diagram shows SIP messages (INVITE, 183, PRACK, 200 OK, UPDATE, 180, 200 OK (INVITE), ACK) with SDP details. At the bottom, a timeline indicates the active codec: AMR-WB for UE-A and P-CSCF A, and AMR for the rest of the network.](e05122559f56af5699789b7118d8fe87_img.jpg) + +The diagram illustrates a SIP message flow for a proactive transcoding scenario. It involves two User Equipment (UE) entities, UE-A and UE-B, connected through a series of Proxy-Call Session Control Functions (P-CSCF) and Interconnection Border Control Functions (IBCF) via an Intermediate IM CN subsystem. The flow is divided into three realms: Visited network X (for UE-A), Home IMS network Y (for user A and B), and Visited network X (for UE-B). The sequence of messages includes INVITE, 183, PRACK, 200 OK, UPDATE, 180, 200 OK (INVITE), and ACK. Each message carries SDP information detailing the supported codecs. At the bottom of the diagram, a horizontal timeline indicates the active codec for each entity: UE-A and P-CSCF A use AMR-WB, while the rest of the network entities use AMR. + +Sequence diagram showing message flow for proactive transcoding. Lifelines: UE-A, P-CSCF A, IBCF-1, IBCF-2, Intermediate IM CN subsystem entities X, IBCF-3, IBCF-4, P-CSCF B, UE-B. The diagram shows SIP messages (INVITE, 183, PRACK, 200 OK, UPDATE, 180, 200 OK (INVITE), ACK) with SDP details. At the bottom, a timeline indicates the active codec: AMR-WB for UE-A and P-CSCF A, and AMR for the rest of the network. + +NOTE: For clarity, the SIP 100 (Trying) messages are not shown in the signalling flow. + +Figure A.4.2-1: Message flow for proactive transcoder without resource reservation + +The steps of the flow are as follows: + +#### 1. INVITE request (UE-A to P-CSCF-A) - see example in table A.4.2-1. + +The UE-A sends a SIP INVITE request according to TS 24.229 [4]. The INVITE request includes an initial SDP offer proposing the use of the AMR-WB codec and inband DTMF. + +**Table A.4.2-1: SIP INVITE request (UE-A to P-CSCF-A)** + +``` + +INVITE SIP: user_B@operator_Y.net; SIP/2.0 + +SIP headers according to 3GPP TS 24.229 [4] + +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 2987933615 2987933615 IN IP4 192.0.2.1 +s= +b=AS:30 +b=RS:0 +b=RR:2000 +c=IN IP4 192.0.2.1 +m=audio 49170 RTP/AVP 96 97 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:96 telephone-event +a=rtpmap:97 AMR-WB/16000/1 +a=fmtp:97 mode-change-capability=2; max-red=220 +a=ptime:20 +a=maxptime:240 + +``` + +#### 2. INVITE request (P-CSCF-A to IBCF-1) - see example in table A.4.2-1. + +The P-CSCF-A uses the procedures in clauses 6.1.5, 6.1.7 and 6.1.9 since no MR could be bypassed and no MR is allocated. + +The P-CSCF-A: + +- uses the connection-address from the SDP c-line as incoming connection-address; +- uses the port information from the SDP m-line as incoming port information; +- uses the codec information from the SDP m-line; +- inserts the incoming codec information into the SDP m-line and associated attribute lines of the modified initial SDP offer; +- uses the incoming connection address as the connection address in the SDP c-line of the forwarded initial SDP offer, and +- uses the incoming port information as port information in the SDP m-line of the modified initial SDP offer. + +The P-CSCF-A then selects an IBCF, IBCF-1, in the realm "Xa.operatorX.net" and forwards the INVITE request with the initial SDP offer to the IBCF-1 according to TS 24.229 [4]. + +#### 3. INVITE request (IBCF-1 to IBCF-2) - see example in table A.4.2-3 + +The IBCF-1 uses the procedures in clauses 6.1.5, 6.1.7 and 6.1.9 since no previous realm instance offers an opportunity to bypass a previous MR and a local MR is not required for realm matching. The IBCF-1 has access to a transcoding MR. + +The IBCF-1: + +- uses the connection-address from the SDP c-line as incoming connection-address; +- uses the port information from the SDP m-line as incoming port information; +- uses the codec information from the SDP m-line; +- constructs and adds to the modified initial SDP offer a visited-realm instance 1 for the media line associated with the connection address and port information for the media line in the received initial SDP offer; + +- makes the codec changes to incoming codec information according to local policy, taking into account the procedures in clause 5.4, and inserts the AMR codec information into the SDP m-line and associated attribute lines of the modified initial SDP offer; +- adds to the modified initial SDP offer a visited-realm instance 2 with the same IP realm, connection address and port information as in the previous visited-realm instance 1 for the media line including the incoming codec information; and +- computes a checksum value for the media line as described in clause 5.6.3 and adds omr-m-cksum and omr-s-cksum attributes for the media line. The omr-s-cksum is set to "0" since there are no session line attributes left to calculate the checksum on. + +The IBCF-1 then selects an IBCF, IBCF-2, in the realm "Xa.operatorX.net" and forwards the INVITE request with the initial SDP offer to the IBCF-2 according to TS 24.229 [4]. + +**Table A.4.2.2-3: SIP INVITE request (IBCF-1 to IBCF-2)** + +``` +INVITE SIP: user_B@operator_Y.net; SIP/2.0 + +SIP headers according to 3GPP TS 24.229 [4] + +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 2987933615 2987933615 IN IP4 192.0.2.1 +s= +c=IN IP4 192.0.2.5 +m=audio 49170 RTP/AVP 96 97 98 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:96 telephone-event +a=rtpmap:97 AMR-WB/16000/1 +a=fmtp:97 mode-change-capability=2; max-red=220 +a=rtpmap:98 AMR/8000/1 +a=fmtp:98 mode-change-capability=2; max-red=220; octet-align=1 +a=ptime:20 +a=maxptime:240 +b=AS:30 +b=RS:0 +b=RR:2000 +a=visited-realm:1 Xa.operatorX.net IN IP4 192.0.2.1 49170 +a=visited-realm:2 Xa.operatorX.net IN IP4 192.0.2.5 49170 +a=omr-codecs:2 audio RTP/AVP 96 97 +a=omr-m-att:2 rtpmap:96 telephone-event +a=omr-m-att:2 rtpmap:97 AMR-WB/16000/1 +a=omr-m-att:2 fmtp:97 mode-change-capability=2; max-red=220 +a=omr-m-att:2 curr:qos local none +a=omr-m-att:2 curr:qos remote none +a=omr-m-att:2 des:qos mandatory local sendrecv +a=omr-m-att:2 des:qos none remote sendrecv +a=omr-m-att:2 ptime:20 +a=omr-m-att:2 maxptime:240 +a=omr-s-bw:2 AS:30 +a=omr-s-bw:2 RS:0 +a=omr-s-bw:2 RR:2000 +a=omr-m-cksum:(..) +a=omr-s-cksum:0 +``` + +#### 4-5. INVITE request (IBCF-2 to IBCF-3 via intermediate IMS CN subsystem entities) - see example in table A.4.2-4. + +The IBCF-2 uses the procedure in clauses 6.1.5, 6.1.6 and 6.1.9 since no realm instance offers an opportunity to bypass a previous MR and a local MR is required for realm matching. + +The IBCF-2: + +- uses the connection-address from the SDP c-line as incoming connection-address; +- uses the port information from the SDP m-line as incoming port information; + +- uses the codec information from the SDP m-line and associated non-OMR attribute lines as incoming codec information; +- allocates an MR context with access to the IP realms, nettypes and addrtypes associated with the incoming connection address and port information and outgoing signalling paths, respectively, applying procedures as described in clause 6.3, +- insert the incoming connection address and incoming port information for the media line into the remote connection address and port information for the incoming termination on the MR; +- provides to the MR the incoming codec information; +- replaces the connection address and port information for the media line in the initial SDP offer with the connection address and port information from the MR termination on the outgoing side; +- adds to the modified initial SDP offer a visited-realm instance 3 for the IP realm associated with the connection address and port information for the media line in the modified initial SDP offer; +- computes a checksum value for the media line as described in clause 5.6.3 and adds the omr-m-cksum and omr-s-cksum attributes for the media line. The omr-s-cksum attribute is set to "0" since there are no session line attributes to compute the checksum on; and +- forwards the INVITE request to the intermediate IMS CN subsystem entities in realm "Yb.operatorY.net" according to TS 24.229 [4]. + +None of the intermediate IMS CN subsystem entities manipulated with the initial SDP offer but the identity of [user\\_B@operator\\_Y.net](#) in the Request-URI is change to the contact address, i.e. UE-B@operatorX.net. + +The intermediate IMS CN subsystem entities select an IBCF, IBCF-3, and forward the INVITE request with the initial SDP offer to the IBCF-3 according to TS 24.229 [4]. + +**Table A.4.2-4: SIP INVITE request (IBCF-2 to IBCF-3 via intermediate IMS CN subsystem entities)** + +``` + +INVITE SIP: sip:user_B@operatorX.net; SIP/2.0 + +SIP headers according to 3GPP TS 24.229 [4] + +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933615 IN IP4 192.0.2.1 +s= +c=IN IP4 190.1.15.2 +m=audio 11324 RTP/AVP 96 97 98 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:96 telephone-event +a=rtpmap:97 AMR-WB/16000/1 +a=fmtp:97 mode-change-capability=2; max-red=220 +a=rtpmap:98 AMR/8000/1 +a=fmtp:98 mode-change-capability=2; max-red=220; octet-align=1 +a=ptime:20 +a=maxptime:240 +b=AS:30 +b=RS:0 +b=RR:2000 +a=visited-realm:1 Xa.operatorX.net IN IP4 192.0.2.1 49170 +a=visited-realm:2 Xa.operatorX.net IN IP4 192.0.2.5 49170 +a=omr-codecs:2 audio RTP/AVP 96 97 +a=omr-m-att:2 rtpmap:96 telephone-event +a=omr-m-att:2 rtpmap:97 AMR-WB/16000/1 +a=omr-m-att:2 fmtp:97 mode-change-capability=2; max-red=220 +a=omr-m-att:2 curr:qos local none +a=omr-m-att:2 curr:qos remote none +a=omr-m-att:2 des:qos mandatory local sendrecv +a=omr-m-att:2 des:qos none remote sendrecv +a=omr-m-att:2 ptime:20 +a=omr-m-att:2 maxptime:240 +a=omr-s-bw:2 AS:30 +a=omr-s-bw:2 RS:0 +a=omr-s-bw:2 RR:2000 +a=visited-realm:3 Yb.operatorY.net IN IP4 190.1.15.2 11324 +a=omr-m-cksum:(...) +a=omr-s-cksum:0 + +``` + +#### 6. INVITE request (IBCF-3 to IBCF-4) - see example in table A.4.2-6. + +The IBCF-3 uses the procedures in clauses 6.1.4, 6.1.7 and 6.1.9 since a previous realm instance exists that can be used to bypass a previous MR, IBCF-2, and bypass is allowed according to operator X and operator Y agreements, and the previous realm instance match the outgoing realm so that no local MR is required. + +The IBCF-3: + +- uses the connection address and port information for the media line in the initial SDP offer with the connection-address and port information from the selected instance 2 as incoming connection address and incoming port information for the media line; +- reconstruct the associated codec information for the media line in the received initial SDP offer from the selected instance 2 as described in clause 5.3, i.e. using the SDP a-lines, b-lines, transport format and list of media formats of the media line in the received initial SDP offer; +- deletes the visited-realm instance 3; +- inserts the incoming codec information into the SDP m-line and associated attribute lines of the modified initial SDP offer; +- uses the incoming connection address as the connection address in the SDP c-line of the forwarded initial SDP offer; +- uses the incoming port information as port information in the SDP m-line of the modified initial SDP offer; + +- computes a checksum value for the media line as described in clause 5.6.3 and adds the omr-m-cksum and omr-s-cksum attributes for the media line. The omr-s-cksum attribute is set to "0" since there are no session line attributes to compute the checksum on; and +- selects an IBCF, IBCF-4, in the realm "Xa.operatorX.net" and forwards the initial SDP offer according to TS 24.229 [4] to IBCF-4. + +**Table A.4.2-6: SIP INVITE request (IBCF-3 to IBCF-4)** + +``` + +INVITE SIP: sip:UE-B@operatorX.net; SIP/2.0 + +SIP headers according to 3GPP TS 24.229 [4] + +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933615 IN IP4 192.0.2.1 +s= +c=IN IP4 192.0.2.5 +m=audio 49170 RTP/AVP 96 97 98 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:96 telephone-event +a=rtpmap:97 AMR-WB/16000/1 +a=fmtp:97 mode-change-capability=2; max-red=220 +a=rtpmap:98 AMR/8000/1 +a=fmtp:98 mode-change-capability=2; max-red=220; octet-align=1 +a=ptime:20 +a=maxptime:240 +b=AS:30 +b=RS:0 +b=RR:2000 +a=visited-realm:1 Xa.operatorX.net IN IP4 192.0.2.1 49170 +a=visited-realm:2 Xa.operatorX.net IN IP4 192.0.2.5 49170 +a=omr-codecs:2 audio RTP/AVP 96 97 +a=omr-m-att:2 rtpmap:96 telephone-event +a=omr-m-att:2 rtpmap:97 AMR-WB/16000/1 +a=omr-m-att:2 fmtp:97 mode-change-capability=2; max-red=220 +a=omr-m-att:2 curr:qos local none +a=omr-m-att:2 curr:qos remote none +a=omr-m-att:2 des:qos mandatory local sendrecv +a=omr-m-att:2 des:qos none remote sendrecv +a=omr-m-att:2 ptime:20 +a=omr-m-att:2 maxptime:240 +a=omr-s-bw:2 AS:30 +a=omr-s-bw:2 RS:0 +a=omr-s-bw:2 RR:2000 +a=omr-m-cksum:(..) +a=omr-m-cksum:0 + +``` + +#### 7. INVITE request (IBCF-4 to P-CSCF B) - see example in table A.4.2-7. + +The IBCF-4 uses the procedures in clauses 6.1.5, 6.1.7 and 6.1.9 since a previous realm instance exists that can be used to bypass a previous MR, IBCF-1, and the previous realm instance match the outgoing realm so that no local MR is required. + +The IBCF-4: + +- uses the connection address and port information from the SDP c-line in the received initial SDP offer in the initial SDP offer as incoming connection address and incoming port information in subsequent steps; +- use the port information from the SDP m-line in the received initial SDP offer as incoming port in subsequent steps; +- uses the codec information from the SDP m-line and associated non-OMR attribute lines in the received initial SDP offer as incoming codec information in the subsequent steps; +- inserts the incoming codec information into the SDP m-line and associated attribute lines of the modified initial SDP offer; + +- uses the incoming connection address as the connection address in the SDP c-line of the forwarded initial SDP offer; and +- uses the incoming port information as port information in the SDP m-line of the modified initial SDP offer; and +- forwards the INVITE request with the unmodified initial SDP offer to the P-CSCF-B, in the realm "X.operatorX.net" according to TS 24.229 [4]. + +**Table A.4.2-7: SIP INVITE request (IBCF-4 to P-CSCF B)** + +``` + +INVITE SIP: sip:UE-B@operatorX.net; SIP/2.0 + +SIP headers according to 3GPP TS 24.229 [4] + +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933615 IN IP4 192.0.2.1 +s= +c=IN IP4 192.0.2.5 +m=audio 49170 RTP/AVP 96 97 98 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:96 telephone-event +a=rtpmap:97 AMR-WB/16000/1 +a=fmtp:97 mode-change-capability=2; max-red=220 +a=rtpmap:98 AMR/8000/1 +a=fmtp:98 mode-change-capability=2; max-red=220; octet-align=1 +a=ptime:20 +a=maxptime:240 +b=AS:30 +b=RS:0 +b=RR:2000 +a=visited-realm:1 Xa.operatorX.net IN IP4 192.0.2.1 49170 +a=visited-realm:2 Xa.operatorX.net IN IP4 192.0.2.5 49170 +a=omr-codecs:2 audio RTP/AVP 96 97 +a=omr-m-att:2 rtpmap:96 telephone-event +a=omr-m-att:2 rtpmap:97 AMR-WB/16000/1 +a=omr-m-att:2 fmtp:97 mode-change-capability=2; max-red=220 +a=omr-m-att:2 curr:qos local none +a=omr-m-att:2 curr:qos remote none +a=omr-m-att:2 des:qos mandatory local sendrecv +a=omr-m-att:2 des:qos none remote sendrecv +a=omr-m-att:2 ptime:20 +a=omr-m-att:2 maxptime:240 +a=omr-s-bw:2 AS:30 +a=omr-s-bw:2 RS:0 +a=omr-s-bw:2 RR:2000 +a=omr-m-cksum:(..) +a=omr-m-cksum:0 + +``` + +#### 8. INVITE request (P-CSCF to UE- B) - see example in table A.4.2-8. + +The P-CSCF-B uses the procedures in clauses 6.1.5, 6.1.7 and 6.1.9 since no previous realm instance offers an opportunity to bypass an MR and no local MR is required to match the incoming realm to the outgoing realm. + +- uses the connection-address from the SDP c-line as incoming connection-address; +- uses the port information from the SDP m-line as incoming port information; +- uses the codec information from the SDP m-line and associated non-OMR attribute lines as incoming codec information; +- according to the local policy, deletes all OMR attributes from the initial SDP offer; and +- forwards the INVITE request with the unmodified initial SDP offer to the UE-B according to TS 24.229 [4]. + +**Table A.4.2-8: SIP INVITE request (P-CSCF-B to UE-B)** + +``` + +INVITE SIP: sip:UE-B@operatorX.net; SIP/2.0 + +SIP headers according to 3GPP TS 24.229 [4] + +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933615 IN IP4 192.0.2.1 +s= +c=IN IP4 192.0.2.5 +m=audio 49170 RTP/AVP 96 97 98 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:96 telephone-event +a=rtpmap:97 AMR-WB/16000/1 +a=fmtp:97 mode-change-capability=2; max-red=220 +a=rtpmap:98 AMR/8000/1 +a=fmtp:98 mode-change-capability=2; max-red=220; octet-align=1 +a=ptime:20 +a=maxptime:240 +b=AS:30 +b=RS:0 +b=RR:2000 + +``` + +#### **9. 183 (Session Progress) response (UE-B to P-CSCF-B) - see example in table A.4.2-9.** + +The UE accepts the AMR codec and sends a 183 (Session Progress) response with an initial SDP answer indicating that resources are not yet available to P-CSCF-B according to TS 24.229 [4]. + +**Table A.4.2-9: 183 (Session Progress) response (UE-B to P-CSCF-B)** + +``` + +SIP/2.0 183 Session Progress + +SIP headers according to 3GPP TS 24.229 [4] + +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2312345678 IN IP4 192.0.2.1 +s= +c=IN IP4 192.0.2.4 +m=audio 16511 RTP/AVP 96 98 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:96 telephone-event +a=rtpmap:98 AMR/8000/1 +a=fmtp:98 mode-change-capability=2; max-red=220; octet-align=1 +a=ptime:20 +a=maxptime:240 +b=AS:30 +b=RS:0 +b=RR:2000 + +``` + +#### **10. 183 (Session Progress) response (P-CSCF-B to IBCF-4) - see example in table A.4.2-9** + +The P-CSCF-B uses the procedures in clauses 6.2.7 and 6.2.9 since the connection address is valid and no primary local MR was allocated. + +The P-CSCF-B: + +- does not modify the initial SDP answer and forwards the 183 (Session Progress) response with the initial SDP answer to IBCF-4 according to TS 24.229 [4]. + +#### **11. 183 (Session Progress) response (IBCF-4 to IBCF-3) - see example in table A.4.2-11** + +The IBCF-4 uses procedures in clauses 6.2.7 and 6.2.9 since a valid connection address was received in the initial SDP answer and no MR was allocated when sending the initial SDP answer. + +The IBCF-4: + +- copies into the media line of the SDP answer the visited-realm instance 2 from the media line of the received initial SDP offer that was used to populate the connection address and port information in the forwarded initial SDP offer, replacing the connection-address and port information in the instance with the connection address and port information from the received initial SDP answer; +- replaces the connection address information in the initial SDP answer with the unspecified address of IPv4, i.e. "0.0.0.0"; and +- forwards the 183 (Session Progress) response with the modified initial SDP answer according to TS 24.229 [4]. + +**Table A.4.2-11: 183 (Session Progress) response (IBCF-4 to IBCF-3)** + +``` +SIP/2.0 183 Session Progress + +SIP headers according to 3GPP TS 24.229 [4] + +Content-Type: application/sdp +Content-Length: (...) +v=0 +o=- 2987933615 2312345678 IN IP4 192.0.2.1 +s=- +c=IN IP4 0.0.0.0 +m=audio 16511 RTP/AVP 96 98 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:96 telephone-event +a=rtpmap:98 AMR/8000/1 +a=fmtp:98 mode-change-capability=2; max-red=220; octet-align=1 +a=ptime:20 +a=maxptime:240 +b=AS:30 +b=RS:0 +b=RR:2000 +a=visited-realm:1 Xa.operatorX.net IN IP4 192.0.2.4 16511 +``` + +#### 12-13. 183 (Session Progress) response (IBCF-3 to IBCF-2 via intermediate IMS CN subsystem entities) - see example in table A.4.2-11 + +The IBCF-3 uses procedures in clauses 6.2.5 and 6.2.9 since an unspecified connection address and a visited-realm was received. + +The IBCF-3 forwards the 183 (Session Progress) response with the unmodified initial SDP answer to the intermediate IM CN subsystem entities according to TS 24.229 [4]. + +The intermediate IM CN subsystem entities forward without modification the 183 (Session Progress) response to the IBCF-2 according to TS 24.229 [4]. + +#### 14. 183 (Session Progress) response (IBCF-2 to IBCF-1) - see example in table A.4.2-14 + +The IBCF-2 uses the procedures in clauses 6.2.5 and 6.2.9 since the initial SDP answer contained an unspecified connection address and a realm instance matching one in the received initial SDP offer and the local MR allocated in step 4 can be bypassed. + +The IBCF-2: + +- replaces the connection address and port information for the media line in the initial SDP answer with the connection address and port information from the visited-realm instance 2 in the received initial SDP answer. + +The IBCF-2 retains the primary local MR allocated for realm matching in step 4, until it is no longer potentially needed for this and any other forked dialog. + +The IBCF-2 forwards the 183 (Session Progress) response with initial SDP answer to IBCF-1 according to TS 24.229 [4]. + +**Table A.4.2-14: 183 (Session Progress) response (IBCF-2 to IBCF-1)** + +``` +SIP/2.0 183 Session Progress + +SIP headers according to 3GPP TS 24.229 [4] + +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2312345678 IN IP4 192.0.2.1 +s=- +c=IN IP4 192.0.2.4 +m=audio 16511 RTP/AVP 96 98 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:96 telephone-event +a=rtpmap:98 AMR/8000/1 +a=fmtp:98 mode-change-capability=2; max-red=220; octet-align=1 +a=ptime:20 +a=maxptime:240 +b=AS:30 +b=RS:0 +b=RR:2000 +``` + +#### 15. PRACK request (IBCF-1 to IBCF-2) - see example in table A.4.2-15 + +The IBCF-1 determines by clause 6.2.3 that a transcoder MR is needed since the UE-B selected the codec added by IBCF-1 in step 7. The IBCF-4 uses clause 6.1.5, 6.1.6 and 6.1.9 since no IMS-ALG can be bypassed and a primary MR is allocated. + +The IBCF-1: + +- uses the connection-address from the SDP c-line in the initial SDP offer as incoming connection-address in subsequent steps; +- uses the port information from the SDP m-line in the initial SDP offer as incoming port information in subsequent steps; +- use the codec information from the SDP m-line and associated non-OMR attribute lines in the initial SDP offer as incoming codec information in the subsequent steps; +- allocates an MR context with access to the IP realms, nettypes and addrtypes associated with the incoming connection address and port information and the outgoing signalling path; +- inserts the incoming connection address and incoming port information for the media line into the remote connection address and port information for the incoming termination on the MR; +- provides to the MR the incoming codec information; +- remove all OMR specific attributes from the modified second SDP offer; +- replaces the connection address and port information for the media line in the second SDP offer with the connection address and port information from the MR termination on the outgoing side; +- inserts the modified codec information (keeps the telephone-event codec, removes the AMR-WB codec and adds the AMR codec) into the SDP m-line and associated attribute lines of the modified second SDP offer; +- adds to the modified second SDP offer a visited-realm instance 2 for the IP realm associated with the connection address and port information for the media line in the modified second SDP offer; +- provides to the MR the modified codec information; +- computes checksum values as described in clause 5.6.3 adds the "omr-s-cksum" and "omr-m-cksum" attributes for the media line; and + +- forwards the PRACK request with the second SDP offer to IBCF-2 according to TS 24.229 [4]. + +**Table A.4.2-15: PRACK request (IBCF-1 to IBCF-2)** + +``` + +PRACK SIP: sip:UE-B@operatorX.net; SIP/2.0 + +SIP headers according to 3GPP TS 24.229 [4] + +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2087654321 IN IP4 192.0.2.1 +s= +b=AS:30 +b=RS:0 +b=RR:2000 +c=IN IP4 192.0.2.5 +m=audio 18435 RTP/AVP 96 97 98 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:96 telephone-event +a=rtpmap:97 AMR-WB/16000/1 +a=fmtp:97 mode-change-capability=2; max-red=220 +a=rtpmap:98 AMR/8000/1 +a=fmtp:98 mode-change-capability=2; max-red=220; octet-align=1 +a-ptime:20 +a=maxptime:240 +a=visited-realm:2 Xa.operatorX.net IN IP4 192.0.2.5 18435 +a=omr-m-cksum:(..) +a=omr-s-cksum:(..) + +``` + +#### **16-17. PRACK request (IBCF-2 to IBCF-3 via intermediate IMS CN subsystem entities) - see example in table A.4.2-16** + +The IBCF-2 uses the procedures in clauses 6.1.5, 6.1.6 and 6.1.9 since no previous MRs can be bypassed and a local MR is needed for realm matching. + +The IBCF-2: + +- uses the connection-address from the SDP c-line in the received second SDP offer as incoming connection-address in subsequent steps; +- uses the port information from the SDP m-line in the received second SDP offer as incoming port information in subsequent steps; and +- uses the codec information from the SDP m-line and associated non-OMR attribute lines in the received second SDP offer as incoming codec information in the subsequent steps. +- inserts the incoming connection address and incoming port information for the media line into the remote connection address and port information for the incoming termination on the MR; +- provides to the MR the incoming codec information;- +- replaces the connection address and port information for the media line in the second SDP offer with the connection address and port information from the MR termination on the outgoing side; +- add to the modified second SDP offer a visited-realm instance 3 for the IP realm associated with the connection address and port information for the media line in the modified second SDP offer; +- computes checksum values as described in clause 5.6.3 and replace or add the "omr-s-cksum" and "omr-m-cksum" attributes for the media line; and +- forwards the PRACK request with the modified second SDP offer to the intermediate IM CN subsystem entities according to TS 24.229 [4]. + +The intermediate IM CN subsystem entities forward the PRACK request without modifying the second SDP offer to the IBCF-3 according to TS 24.229 [4]. + +**Table A.4.2-16: PRACK request (IBCF-2 to IBCF-3 via intermediate IMS CN subsystem entities)** + +``` + +PRACK SIP: sip:UE-B@operatorX.net; SIP/2.0 + +SIP headers according to 3GPP TS 24.229 [4] + +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2087654321 IN IP4 192.0.2.1 +s= +b=AS:30 +b=RS:0 +b=RR:2000 +c=IN IP4 190.1.15.2 +m=audio 11324 RTP/AVP 96 97 98 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:96 telephone-event +a=rtpmap:97 AMR-WB/16000/1 +a=fmtp:97 mode-change-capability=2; max-red=220 +a=rtpmap:98 AMR/8000/1 +a=fmtp:98 mode-change-capability=2; max-red=220; octet-align=1 +a=ptime:20 +a=maxptime:240 +a=visited-realm:2 Xa.operatorX.net IN IP4 192.0.2.5 18435 +a=visited-realm:3 Yb.operatorY.net IN IP4 190.1.15.2 11324 +a=omr-m-cksum:(...) +a=omr-s-cksum:(...) + +``` + +#### **18. PRACK request (IBCF-3 to IBCF-4) - see example in table A.4.2-18** + +The IBCF-3 uses procedures in clauses 6.1.4, 6.1.7 and 6.1.9 since previous MR can be bypassed and no local MR is needed. + +The IBCF: + +- uses the connection address and port information from the selected instance 2 for the media line in the received second SDP offer as incoming connection address and incoming port information for the media line in the subsequent steps; +- reconstructs the associated codec information for the media line in the received second SDP offer from the selected instance 2 as described in clause 5.3, and use that codec information as incoming codec information in the subsequent steps; +- inserts the incoming codec information into the SDP m-line and associated attribute lines of the modified second SDP offer, +- uses the incoming connection address as the connection address in the SDP c-line of the forwarded second SDP offer; and +- uses the incoming port information as determined in previous steps as port information in the SDP m-line of the modified second SDP offer; +- computes checksum values as described in clause 5.6.3 and replaces the "omr-s-cksum" and "omr-m-cksum" attributes for the media line; and +- forwards the PRACK request with the modified second SDP offer to IBCF-2 according to TS 24.229 [4]. + +**Table A.4.2-18: PRACK request (IBCF-3 to IBCF-4)** + +``` + +PRACK SIP: sip:UE-B@operatorX.net; SIP/2.0 + +SIP headers according to 3GPP TS 24.229 [4] + +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 2987933615 2087654321 IN IP4 192.0.2.1 +s= +b=AS:30 +b=RS:0 +b=RR:2000 +c=IN IP4 192.0.2.5 +m=audio 18435 RTP/AVP 96 97 98 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:96 telephone-event +a=rtpmap:97 AMR-WB/16000/1 +a=fmtp:97 mode-change-capability=2; max-red=220 +a=rtpmap:98 AMR/8000/1 +a=fmtp:98 mode-change-capability=2; max-red=220; octet-align=1 +a=ptime:20 +a=maxptime:240 +a=visited-realm:2 Xa.operatorX.net IN IP4 192.0.2.5 18435 +a=omr-m-cksum:(..) +a=omr-s-cksum:(..) + +``` + +#### **19. PRACK request (IBCF-4 to P-CSCF-B) - see example in table A.4.2-18** + +The IBCF-4 uses the procedures in clauses 6.1.5, 6.1.7 and 6.1.9 since allocation of a local MR is not needed and no previous MR can be by passed. + +The IBCF-4: + +- uses the connection-address from the SDP c-line in the received second SDP offer as incoming connection-address in subsequent steps; +- uses the port information from the SDP m-line in the received second SDP offer as incoming port information in subsequent steps; +- uses the codec information from the SDP m-line and associated non-OMR attribute lines in the received second SDP offer as incoming codec information in the subsequent steps; +- inserts the incoming codec information into the SDP m-line and associated attribute lines of the modified second SDP offer; +- uses the incoming connection address as the connection address in the SDP c-line of the forwarded second SDP offer; +- uses the incoming port information as determined in previous steps as port information in the SDP m-line of the modified second SDP offer; and +- forwards the PRACK request with the unmodified second SDP offer to P-CSCF-B according to TS 24.229 [4]. + +#### **20. PRACK request (P-CSCF-B to UE- B) - see example in table A.4.2-20.** + +The P-CSCF-B uses the procedures in clauses 6.1.5, 6.1.7 and 6.1.9 since no previous realm instance offers an opportunity to bypass an MR and no local MR is required to match the incoming realm to the outgoing realm. + +- uses the connection-address from the SDP c-line as incoming connection-address; +- uses the port information from the SDP m-line as incoming port information; +- uses the codec information from the SDP m-line and associated non-OMR attribute lines as incoming codec information; + +- inserts the incoming codec information into the SDP m-line and associated attribute lines of the modified second SDP offer; +- uses the incoming connection address as the connection address in the SDP c-line of the forwarded second SDP offer; +- uses the incoming port information as port information in the SDP m-line of the modified second SDP offer; +- according to the local policy, deletes the visited-realm "visited-realm:1 Xa.operatorX.net IN IP4 192.0.2.5 18435", the omr-s-cksum=(..) and the "omr-m-cksum=(..)" from the second SDP offer ; and +- forwards the PRACK request with the modified second SDP offer to the UE-B according to TS 24.229 [4]. + +**Table A.4.2-20: SIP PRACK request (P-CSCF-B to UE-B)** + +``` +UPDATE SIP: sip:UE-B@operatorX.net; SIP/2.0 + +SIP headers according to 3GPP TS 24.229 [4] + +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 2987933615 2087654321 IN IP4 192.0.2.1 +s= +c=IN IP4 192.0.2.5 +m=audio 18435 RTP/AVP 96 98 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:96 telephone-event +a=rtpmap:98 AMR/8000/1 +a=fmtp:98 mode-change-capability=2; max-red=220; octet-align=1 +a=ptime:20 +a=maxptime:240 +``` + +#### **21. 200 (OK) response (UE-B to P-CSCF-B) - see example in table A.4.2-21.** + +The UE accepts the AMR codec (again) and sends a 200 (OK) response to the PRACK request with a second SDP answer still indicating that resources are not yet available to P-CSCF-B according to TS 24.229 [4]. + +**Table A.4.2-21: 200 (OK) response to PRACK request (UE-B to P-CSCF-B)** + +``` +SIP/2.0 200 OK + +SIP headers according to 3GPP TS 24.229 [4] + +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 2987933615 2312345678 IN IP4 192.0.2.1 +s= +b=AS:30 +b=RS:0 +b=RR:2000 +c=IN IP4 192.0.2.4 +m=audio 16511 RTP/AVP 96 98 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:96 telephone-event +a=rtpmap:98 AMR/8000/1 +a=fmtp:98 mode-change-capability=2; max-red=220; octet-align=1 +a=ptime:20 +a=maxptime:240 +``` + +#### **22. 200 (OK) response (P-CSCF-B to IBCF-4) - see example in table A.4.2-21.** + +The P-CSCF-B uses the procedures in clauses 6.2.7 and 6.2.9 since no local MR was allocated the connection address is valid and no visited-realm instance was received in the second SDP answer. + +The P-CSCF-B: + +- does not modify the second SDP answer and forwards the 200 (OK) response with the second SDP answer to IBCF-4 according to TS 24.229 [4]. + +#### **23. 200 (OK) response (IBCF-4 to IBCF-3) - see example in table A.4.2-21.** + +The IBCF-4 uses the procedures in clauses 6.2.7 and 6.2.9 since no local MR was allocated and a valid connection address was received in the second SDP answer. + +The IBCF-4 forwards the 200 (OK) response to the PRACK request with the unmodified second SDP answer according to TS 24.229 [4]. + +#### **24-25. 200 (OK) response (IBCF-3 to IBCF-2 via intermediate IM CN subsystem entities) - see example in table A.4.2-24.** + +The IBCF-3 uses procedures in clauses 6.2.7 and 6.2.9 since no local MR was allocated and an unspecified connection address and no visited-realm instance was received in the second SDP answer. + +The IBCF-3: + +- copies into the media line of the second SDP answer the visited-realm instance 2 from the media line of the received second SDP offer that was used to populate the connection address and port information in the forwarded second SDP offer, replacing the connection-address and port information in the instance with the connection address and port information from the received second SDP answer; +- replaces the connection address information in the second SDP answer with the unspecified address of the IPv4, i.e. "0.0.0.0"; and +- forwards the 200 (OK) response to the PRACK request with the modified second SDP answer to the intermediate IM CN subsystem entities according to TS 24.229 [4]. + +The intermediate IM CN subsystem entities forward the 200 (OK) response to the PRACK request to the IBCF-2 according to TS 24.229 [4] without modifying the second SDP answer. + +###### **Table A.4.2-24: 200 (OK) response to PRACK request (IBCF-3 to IBCF-2 via intermediate IM CN subsystem entities)** + +``` +SIP/2.0 200 OK + +SIP headers according to 3GPP TS 24.229 [4] + +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2312345678 IN IP4 192.0.2.1 +s=- +b=AS:30 +b=RS:0 +b=RR:2000 +c=IN IP4 0.0.0.0 +m=audio 16511 RTP/AVP 96 98 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:96 telephone-event +a=rtpmap:98 AMR/8000/1 +a=fmtp:98 mode-change-capability=2; max-red=220; octet-align=1 +a=ptime:20 +a=maxptime:240 +a=visited-realm:2 Xa.operatorX.net 192.0.2.4 16511 +``` + +#### **26. 200 (OK) response (IBCF-2 to IBCF-1) - see example in table A.4.2-26.** + +The IBCF-2 uses the procedures in clauses 6.2.5 and 6.2.9 since an unspecified connection address and a visited-realm instance was received. + +The IBCF-2: + +- replaces the connection address and port information for the media line in the second SDP answer with the connection address and port information from the visited-realm instance 2 in the received second SDP answer; +- forwards the 200 (OK) response to the PRACK request with the modified second SDP answer to IBCF-1 according to TS 24.229 [4]; and +- keeps the allocated MR until it is no longer potentially needed for this and any other forked dialog. + +**Table A.4.2-26: 200 (OK) response to PRACK request (IBCF-2 to IBCF-1)** + +``` + +SIP/2.0 200 OK + +SIP headers according to 3GPP TS 24.229 [4] + +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2312345678 IN IP4 192.0.2.1 +s=- +b=AS:30 +b=RS:0 +b=RR:2000 +c=IN IP4 192.0.2.4 +m=audio 16511 RTP/AVP 96 98 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:96 telephone-event +a=rtpmap:98 AMR/8000/1 +a=fmtp:98 mode-change-capability=2; max-red=220; octet-align=1 +a=ptime:20 +a=maxptime:240 + +``` + +#### **27.183 (Session Progress) response (IBCF-1 to P-CSCF-A) - see example in table A.4.2-27.** + +The IBCF-1 continues from the point when the 183 (Session Progress) response to the INVITE request was received in step 14 and uses the procedures in clauses 6.2.8 and 6.2.9 since the IBCF-4 retains the MR allocated in step 14. + +The IBCF-1: + +- updates the remote connection address and port information for the outgoing termination on the selected MR context with the connection address and port information for the media line in the received second SDP answer; +- modifies the initial SDP answer to include the codecs selected for the incoming termination of the selected local MR; +- replaces the connection address and port information for the media line in the initial SDP answer with the local connection address and port information for the incoming termination on the selected MR; +- removes the visited-realm instance; and +- forwards 183 (Session Progress) response with the modified initial SDP answer to P-CSCF-A according to TS 24.229 [4]. + +**Table A.4.2-27 183 (Session Progress) response (IBCF-1 to P-CSCF-A)** + +``` +SIP/2.0 183 Session Progress + +SIP headers according to 3GPP TS 24.229 [4] + +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2087654321 IN IP4 192.0.2.3 +s=- +b=AS:30 +b=RS:0 +b=RR:2000 +c=IN IP4 192.0.2.2 +m=audio 23563 RTP/AVP 96 97 +a=curr:qos local none +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:97 AMR-WB/16000/1 +a=fmtp:97 mode-change-capability=2; max-red=220 +a=rtpmap:96 telephone-event +a=maxptime:20 +a=maxptime:240 +``` + +#### **28. 183 (Session Progress) response (P-CSCF-A to UE-A) - see example in table A.4.2-27** + +The P-CSCF-A forwards the 183 (Session Progress) with the initial SDP answer to the UE-A according to TS 24.229 [4]. + +#### **29-30. PRACK request (UE-A to IBCF-1 via P-CSCF-A).** + +The UE-A acknowledge the reception of the initial SDP answer and the 183 (Session Progress) response by means of a PRACK request. + +#### **31-32. 200 (OK) response to the PRACK request (IBCF-1 to UE-A via P-CSCF-A).** + +The IBCF-1 acknowledges the reception of the PRACK request by means of a 200 (OK) response. + +#### **33. UPDATE request (UE-A to P-CSCF-A) - see example in table A.4.2-33.** + +When the UE-A has got resources reserved the UE-A sends an UPDATE request. + +The subsequent SDP offer in the UPDATE the request is the same as the initial SDP offer in the INVITE request in the step 1 with the only exception that "a=curr:qos local none" is now changed to "a=curr:qos local sendrecv". + +**Table A.4.2-33: UPDATE request (UE-A to P-CSCF-A)** + +``` +UPDATE SIP: sip:UE-A@operatorX.net; SIP/2.0 + +SIP headers according to 3GPP TS 24.229 [4] + +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933616 IN IP4 192.0.2.1 +s= +b=AS:30 +b=RS:0 +b=RR:2000 +c=IN IP4 192.0.2.1 +m=audio 49170 RTP/AVP 96 97 +a=curr:qos local sendrecv +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:96 telephone-event +a=rtpmap:97 AMR-WB/16000/1 +a=fmtp:97 mode-change-capability=2; max-red=220 +a=ptime:20 +a=maxptime:240 +``` + +#### **34-40. UPDATE request (P-CSCF-A to UE-B via IBCF-1, IBCF-2, intermediate IMS CN subsystem entities IBCF-3, IBCF-4 and P-CSCF-B).** + +- 34) The P-CSCF-A forwards the subsequent SDP offer as received. +- 35) The IBCF-1 replaces the connection information received in the subsequent SDP offer with the IBCF-1 own MR connection information. +- 36) The IBCF-2 forwards the subsequent SDP offer as received. +- 37) Intermediate IMS CN subsystem entities do not manipulate the SDP offer. +- 38) The IBCF-3 forwards the subsequent SDP offer as received. +- 39) The IBCF-4 forwards the subsequent SDP offer as received. +- 40) The P-CSCF-B forwards the subsequent SDP offer as received. + +#### **41. 200 (OK) response to the UPDATE request (UE-B to P-CSCF-B) - see example in table A.4.2-41.** + +The UE-B acknowledges the reception of the UPDATE request by means of a 200 (OK) response containing a subsequent SDP answer. + +**Table A.4.2-41: 200 (OK) response to the UPDATE request (UE-B to P-CSCF-B).** + +``` + +SIP/2.0 200 OK + +SIP headers according to 3GPP TS 24.229 [4] + +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 2987933615 2987933615 IN IP4 192.0.2.4 +s= +t=0 0 +c=IN IP4 192.0.2.4 +m=audio 16511 RTP/AVP 96 98 +a=curr:qos local sendrecv +a=curr:qos remote sendrecv +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:98 AMR/8000/1 +a=fmtp:98 mode-change-capability=2; max-red=220; octet-align=1 +a=rtpmap:96 telephone-event +a=maxptime:20 + +``` + +#### **42-48. 200 (OK) response to the UPDATE request (P-CSCF-B to UE-A via IBCF-4, IBCF-3, intermediate IMS CN subsystem entities, IBCF-2 and IBCF-1).** + +- 42) The P-CSCF-B forwards the subsequent SDP answer as received. +- 43) The IBCF-4 forwards the subsequent SDP answer as received. +- 44) The IBCF-3 forwards the subsequent SDP answer as received. +- 45) Intermediate IMS CN subsystem entities do not manipulate the SDP answer. +- 46) The IBCF-2 forwards the subsequent SDP answer as received. +- 47) The IBCF-1 replaces the connection information received in the subsequent SDP answer with the IBCF-1 own MR connection information. +- 48) The P-CSCF-A forwards the subsequent SDP answer as received. + +#### **49-56. 180 (Ringing) response (UE-B to UE-A via P-CSCF-B, IBCF-4, IBCF-3, intermediate IMS CN subsystem entities, IBCF-2, IBCF-1 and P-CSCF-A).** + +No OMR specific action is required. + +#### **57-64. 200 (OK) response to the INVITE request (UE-B to UE-A via P-CSCF-B, IBCF-4, IBCF-3, intermediated IMS CN subsystem, IBCF-2, IBCF-1 and P-CSCF-A).** + +The User B accepts the call and the UE-B sends a 200 (OK) response to the INVITE request. The response contains no SDP. + +The IBCF-2 releases the MR not used in the call. + +#### **65-72. ACK request (UE-A to UE-B via P-CSCF-A, IBCF-1, IBCF-2, intermediated IMS CN subsystem, IBCF-3, IBCF-4 and P-CSCF-B).** + +The UE-B acknowledges the reception of the 200 (OK) response by means of a 200 (OK) response. + +## A.5 IMS-ALG bypasses an allocated transcoding MR + +### A.5.1 General + +This clause provides an example of a call where the UE initiating a call offers the AMR codec. An IMS-ALG, IBCF-1 in figure A.2.1, adds the AMR-WB codec to the initial SDP offer and reserves an MR resource. + +The terminating UE selects the AMR codec and the IMS-ALG needs to deallocate the MR and update the terminating UE with the IP addresses of the UE-A in a realm instance to allow bypassing of the IMS-ALG itself. + +Figure A.5.1-1 shows the realm and IP structure used in this example. + +![Diagram of IP realm and IP structure showing Home IMS network H, IPX network X, and Visited network V with various network elements like S-CSCF, IBCF, TrGW, IC, MGW, P-CSCF, PCRF, PDN, and TRF.](68a5a1a1a761c652b4b4c56da7cf9914_img.jpg) + +The diagram illustrates the IP realm and IP structure across three network domains: + +- Home IMS network H: Realm Ha.operatorH.net** + - Contains S-CSCF/BGCF. + - Connected to two parallel paths: + - Path 1: IBCF-2 (Ha: 190.1.15.2) → TrGW (Xa4: 179.14.1.2). + - Path 2: IBCF-3 (Ha: 190.1.15.2) → TrGW (Xa4: 179.14.1.3). +- IPX network X: Realm Xa.operatorX.net** + - Receives traffic from Home IMS network H via the TrGWs. + - Contains two parallel paths: + - Path 1: IC-1 (Xa2: 179.14.1.1) → MGW (Xa2: 178.15.1.2). + - Path 2: IC-2 (Xa2: 179.14.1.4) → MGW (Xa2: 178.15.1.3). +- Visited network V: Realm Va.operatorV.net** + - Receives traffic from IPX network X via the MGWs. + - Contains two parallel paths: + - Path 1: IBCF-1 (Xa1: 178.15.1.1) → TrGW (192.0.2.2). + - Path 2: IBCF-4 (Xa1: 178.15.1.4) → TrGW (192.0.2.3). + - UE-A (Va: 192.0.2.1) is connected to P-CSCF-A, which is connected to IBCF-1. + - PCRF and PDN (dashed box) are also connected to P-CSCF-A. + - IBCF-4 is connected to TRF, which is connected to IBCF-5. + - IBCF-5 is connected to another UE (Va: 192.0.2.4). + +**Legend:** + +- Control signalling path: Solid line with double-headed arrow. +- Media path after OMR: Dashed line with double-headed arrow. + +Diagram of IP realm and IP structure showing Home IMS network H, IPX network X, and Visited network V with various network elements like S-CSCF, IBCF, TrGW, IC, MGW, P-CSCF, PCRF, PDN, and TRF. + +Figure A.5.1-1: IP realm and IP structure + +### A.5.2 Message flow + +The user A at UE-A and the user B at UE-B roams into a visited network X and both users belongs to the same operator Y. + +Preconditions: + +- Both users A and B are registered to the Home IMS network Y via the visited operator X network; +- the visited operator X and the operator of user A and B IMS home network Y have an agreement to allow media to be bypassed using OMR; +- both users A and B are connected to realm Xa of the visited operator network X; +- the AMR codec is allowed and accepted by all involved entities. However, the local policy of operator X is that the AMR-WB codec shall always be included in the initial SDP offers from the operator X network; and +- no B2BUA manipulating SDP is connected in the intermediate IM CN subsystem. + +Figure A.5.2-1 shows the message flow for the scenario. + +![Sequence diagram showing message flow for a transcoder with resource reservation. Lifelines include UE-A, P-CSCF A, IBCF-1, IBCF-2, Intermediate IM CN subsystem entities X, IBCF-3, IBCF-4, P-CSCF B, and UE-B. The diagram shows the exchange of SIP messages (INVITE, 183, PRACK, 200 OK, UPDATE, 180, ACK) across different network realms (Xa.operatorX.net, Yb.operatorY.net).](56a5265d174ce056c1dbe5e7a60839fc_img.jpg) + +The diagram illustrates the message flow for a transcoder with resource reservation. It is divided into three network domains: Visited network X (left), Home IMS network Y (of user A and B) (center), and Visited network X (right). The lifelines are: UE-A (192.0.2.1), P-CSCF A, IBCF-1 (192.0.2.2), IBCF-2 (192.0.2.6), Intermediate IM CN subsystem entities X, IBCF-3 (190.1.15.3), IBCF-4 (192.0.2.7), P-CSCF B, and UE-B (192.0.2.4). The realms are: Realm: Xa.operatorX.net (Xa in the flow below), Realm: Yb.operatorY.net (Yb in the flow below), and Realm: Xa.operatorX.net (Xa in the flow below). The sequence of messages is as follows: 1. INVITE [AMR, c=192.0.2.1] from UE-A to P-CSCF A; 2. INVITE [AMR, c=192.0.2.1] from P-CSCF A to IBCF-1; 3. INVITE [AMR and AMR-WB, c=192.0.2.5, visited-realm:1 Xa 192.0.2.1, visited-realm:2 Xa 192.0.2.5 AMR] from IBCF-1 to IBCF-2; 4. INVITE [AMR and AMR-WB, c=190.1.15.2, visited-realm:1 Xa 192.0.2.1, visited-realm:2 Xa 192.0.2.5 AMR, visited-realm:3 Yb 190.1.15.2] from IBCF-2 to Intermediate IM CN subsystem entities X; 5. INVITE [AMR and AMR-WB, c=190.1.15.2, visited-realm:1 Xa 192.0.2.1, visited-realm:2 Xa 192.0.2.5 AMR, visited-realm:3 Yb 190.1.15.2] from Intermediate IM CN subsystem entities X to IBCF-3; 6. INVITE [AMR and AMR-WB, c=192.0.2.5, visited-realm:1 Xa 192.0.2.1, visited-realm:2 Xa 192.0.2.5 AMR] from IBCF-3 to IBCF-4; 7. INVITE [AMR and AMR-WB, c=192.0.2.5, visited-realm:1 Xa 192.0.2.1, visited-realm:2 Xa 192.0.2.5 AMR] from IBCF-4 to P-CSCF B; 8. INVITE [AMR and AMR-WB, c=192.0.2.5] from P-CSCF B to UE-B; 9. 183 [AMR, c=192.0.2.4] from UE-B to P-CSCF B; 10. 183 [AMR, c=192.0.2.4] from P-CSCF B to IBCF-4; 11. PRACK [AMR, c=192.0.2.1, visited-realm:1 Xa 192.0.2.1] from IBCF-4 to IBCF-3; 12. PRACK [AMR, c=192.0.2.1] from IBCF-3 to IBCF-2; 13. 200 OK (PRACK) [AMR, c=192.0.2.4] from IBCF-2 to IBCF-1; 14. 200 OK (PRACK) [AMR, c=192.0.2.4] from IBCF-1 to Intermediate IM CN subsystem entities X; 15. 183 [AMR, c=0.0.0.0, visited-realm:1 Xa 192.0.2.4] from Intermediate IM CN subsystem entities X to IBCF-2; 16. 183 [AMR, c=0.0.0.0, visited-realm:1 Xa 192.0.2.4] from IBCF-2 to IBCF-1; 17. 183 [AMR, c=0.0.0.0, visited-realm:1 Xa 192.0.2.4] from IBCF-1 to P-CSCF A; 18. 183 [AMR, c=0.0.0.0, visited-realm:1 Xa 192.0.2.4] from P-CSCF A to UE-A; 19. 183 [AMR, c=192.0.2.4, visited-realm:1 Xa 192.0.2.4] from UE-A to P-CSCF A; 20. 183 [AMR, c=192.0.2.4] from P-CSCF A to IBCF-1; 21. PRACK from IBCF-1 to IBCF-2; 22. PRACK from IBCF-2 to Intermediate IM CN subsystem entities X; 23. PRACK from Intermediate IM CN subsystem entities X to IBCF-3; 24. PRACK from IBCF-3 to IBCF-4; 25. PRACK from IBCF-4 to P-CSCF B; 26. PRACK from P-CSCF B to UE-B; 27. 200 OK (PRACK) from UE-B to P-CSCF B; 28. 200 OK (PRACK) from P-CSCF B to IBCF-4; 29. 200 OK (PRACK) from IBCF-4 to IBCF-3; 30. 200 OK (PRACK) from IBCF-3 to IBCF-2; 31. 200 OK (PRACK) from IBCF-2 to IBCF-1; 32. 200 OK (PRACK) from IBCF-1 to P-CSCF A; 33. UPDATE [AMR, c=192.0.2.1] from P-CSCF A to UE-A; 34. UPDATE [AMR, c=192.0.2.1] from UE-A to P-CSCF A; 35. UPDATE [AMR, c=192.0.2.1] from P-CSCF A to IBCF-1; 36. UPDATE [AMR, c=192.0.2.1] from IBCF-1 to IBCF-2; 37. UPDATE [AMR, c=192.0.2.1] from IBCF-2 to Intermediate IM CN subsystem entities X; 38. UPDATE [AMR, c=192.0.2.1] from Intermediate IM CN subsystem entities X to IBCF-3; 39. UPDATE [AMR, c=192.0.2.1] from IBCF-3 to IBCF-4; 40. UPDATE [AMR, c=192.0.2.1] from IBCF-4 to P-CSCF B; 41. UPDATE [AMR, c=192.0.2.1] from P-CSCF B to UE-B; 42. 200 OK (UPDATE) from UE-B to P-CSCF B; 43. 200 OK (UPDATE) from P-CSCF B to IBCF-4; 44. 200 OK (UPDATE) from IBCF-4 to IBCF-3; 45. 200 OK (UPDATE) from IBCF-3 to IBCF-2; 46. 200 OK (UPDATE) from IBCF-2 to IBCF-1; 47. 200 OK (UPDATE) from IBCF-1 to P-CSCF A; 48. 200 OK (UPDATE) from P-CSCF A to UE-A; 49. 180 from UE-A to P-CSCF A; 50. 180 from P-CSCF A to IBCF-1; 51. 180 from IBCF-1 to IBCF-2; 52. 180 from IBCF-2 to Intermediate IM CN subsystem entities X; 53. 180 from Intermediate IM CN subsystem entities X to IBCF-3; 54. 180 from IBCF-3 to IBCF-4; 55. 180 from IBCF-4 to P-CSCF B; 56. 180 from P-CSCF B to UE-B; 57. 200 OK (INVITE) from UE-B to P-CSCF B; 58. 200 OK (INVITE) from P-CSCF B to IBCF-4; 59. 200 OK (INVITE) from IBCF-4 to IBCF-3; 60. 200 OK (INVITE) from IBCF-3 to IBCF-2; 61. 200 OK (INVITE) from IBCF-2 to IBCF-1; 62. 200 OK (INVITE) from IBCF-1 to P-CSCF A; 63. 200 OK (INVITE) from P-CSCF A to UE-A; 64. 200 OK (INVITE) from UE-A to P-CSCF A; 65. ACK from P-CSCF A to UE-A; 66. ACK from UE-A to P-CSCF A; 67. ACK from P-CSCF A to IBCF-1; 68. ACK from IBCF-1 to IBCF-2; 69. ACK from IBCF-2 to Intermediate IM CN subsystem entities X; 70. ACK from Intermediate IM CN subsystem entities X to IBCF-3; 71. ACK from IBCF-3 to IBCF-4; 72. ACK from IBCF-4 to P-CSCF B; 73. ACK from P-CSCF B to UE-B; AMR (Media flow) from UE-A to UE-B. + +Sequence diagram showing message flow for a transcoder with resource reservation. Lifelines include UE-A, P-CSCF A, IBCF-1, IBCF-2, Intermediate IM CN subsystem entities X, IBCF-3, IBCF-4, P-CSCF B, and UE-B. The diagram shows the exchange of SIP messages (INVITE, 183, PRACK, 200 OK, UPDATE, 180, ACK) across different network realms (Xa.operatorX.net, Yb.operatorY.net). + +Figure A.5.2-1: Message flow for transcoder with resource reservation, codec not selected + +NOTE: For clarity, the SIP 100 (Trying) messages are not shown in the signalling flow. + +The steps of the flow are as follows: + +#### 1. INVITE request (UE-A to P-CSCF-A) - see example in table A.5.2-1. + +The UE-A sends a SIP INVITE request according to TS 24.229 [4]. The INVITE request includes an initial SDP offer proposing the use of the AMR codec and inband DTMF. + +**Table A.5.2-1: SIP INVITE request (UE-A to P-CSCF-A)** + +``` + +INVITE SIP: user_B@operator_Y.net; SIP/2.0 + +SIP headers according to 3GPP TS 24.229 [4] + +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933615 IN IP4 192.0.2.1 +s= +b=AS:30 +b=RS:0 +b=RR:2000 +c=IN IP4 192.0.2.1 +m=audio 49170 RTP/AVP 96 97 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:96 telephone-event +a=rtpmap:97 AMR/8000/1 +a=fmtp:97 mode-change-capability=2; max-red=220; octet-align=1 +a=ptime:20 +a=maxptime:240 + +``` + +#### 2. INVITE request (P-CSCF-A to IBCF-1) - see example in table A.5.2-1. + +The P-CSCF-A uses the procedures in clauses 6.1.5, 6.1.7 and 6.1.9 since no MR could be bypassed and no MR is allocated. + +The P-CSCF-A: + +- uses the connection-address from the SDP c-line as incoming connection-address; +- uses the port information from the SDP m-line as incoming port information; +- uses the codec information from the SDP m-line; +- inserts the incoming codec information into the SDP m-line and associated attribute lines of the modified initial SDP offer; +- uses the incoming connection address as the connection address in the SDP c-line of the forwarded initial SDP offer, and +- use the incoming port information as port information in the SDP m-line of the modified initial SDP offer. + +The P-CSCF-A then selects an IBCF, IBCF-1, in the realm "Xa.operatorX.net" and forwards the INVITE request with the initial SDP offer to the IBCF-1 according to TS 24.229 [4]. + +#### 3. INVITE request (IBCF-1 to IBCF-2) - see example in table A.5.2-3 + +The IBCF-1 uses the procedures in 6.1.5, 6.1.6 and 6.1.9 since IBCF-1 determines according to local policy that a transcoding MR is needed and that there is no previous MR to bypass. + +The IBCF-1: + +- uses the connection-address from the SDP c-line in the received SDP offer as incoming connection-address in subsequent steps; +- uses the port information from the SDP m-line in the received SDP offer as incoming port information in subsequent steps; +- uses the codec information from the SDP m-line and associated non-OMR attribute lines in the received SDP offer as incoming codec information in the subsequent steps; +- allocates an MR context with access to the IP realms, nettypes and addrtypes associated with the incoming connection address and port information and the outgoing signalling path; + +- inserts the incoming connection address and incoming port information for the media line into the remote connection address and port information for the incoming termination on the MR; +- provides to the MR the incoming codec information; +- constructs a visited-realm instance 1; +- replaces the connection address and port information for the media line in the initial SDP offer with the connection address and port information from the MR termination on the outgoing side; +- adds a AMR-WB codec changes to incoming codec information, according to local policy, taking into account the procedures in clause 5.4, and insert the changed codec information into the SDP m-line and associated attribute lines of the modified initial SDP offer; +- provides to the MR the modified codec information; +- adds to the modified initial SDP offer a visited-realm instance 2 for the IP realm associated with the connection address and port information for the media line in the modified initial SDP offer, including the incoming codec information encoded according to clause 5.2; +- computes checksum values as described in clause 5.6.3 and adds the "omr-s-cksum" and "omr-m-cksum" attributes for the media line. The "omr-s-cksum" is set to "0" since there is no session line attributes to compute the checksum on; and +- selects an IBCF, IBCF-2, in the realm "Xa.operatorX.net" and forwards the INVITE request with the modified initial SDP offer to the IBCF-2 according to TS 24.229 [4]. + +**Table A.5.2-3: SIP INVITE request (IBCF-1 to IBCF-2)** + +``` + +INVITE SIP: user_B@operator_Y.net; SIP/2.0 + +SIP headers according to 3GPP TS 24.229 [4] + +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 2987933615 2987933615 IN IP4 192.0.2.1 +s= +c=IN IP4 192.0.2.5 +m=audio 62111 RTP/AVP 96 97 98 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:96 telephone-event +a=rtpmap:97 AMR/8000/1 +a=fmtp:97 mode-change-capability=2; max-red=220; octet-align=1 +a=rtpmap:98 AMR-WB/16000/1 +a=fmtp:98 mode-change-capability=2; max-red=220 +a=ptime:20 +a=maxptime:240 +b=AS:30 +b=RS:0 +b=RR:2000 +a=visited-realm:1 Xa.operatorX.net IN IP4 192.0.2.1 49170 +a=visited-realm:2 Xa.operatorX.net IN IP4 192.0.2.5 62111 +a=omr-codecs:2 audio RTP/AVP 96 97 +a=omr-m-att:2 rtpmap:96 +a=omr-m-att:2 telephone-event +a=omr-m-att:2 rtpmap:97 AMR/8000/1 +a=omr-m-att:2 fmtp:97 +a=omr-m-att:2 mode-change-capability=2; max-red=220; octet-align=1 +a=omr-m-att:2 curr:qos local none +a=omr-m-att:2 curr:qos remote none +a=omr-m-att:2 des:qos mandatory local sendrecv +a=omr-m-att:2 des:qos none remote sendrecv +a=omr-m-att:2 ptime:20 +a=omr-m-att:2 maxptime:240 +a=omr-s-bw:2 AS:30 +a=omr-s-bw:2 RS:0 +a=omr-s-bw:2 RR:2000 +a=omr-m-cksum:(..) +a=omr-s-cksum:0 + +``` + +#### 4.5. INVITE request (IBCF-2 to IBCF-3 via intermediate IMS CN subsystem entities) - see example in table A.5.2-4 + +The IMS-ALG uses the procedures in clauses 6.1.5, 6.1.6 and 6.1.9 since no MR can be bypassed and a local MR is needed for realm matching. + +The IBCF-2: + +- uses the connection-address from the SDP c-line as incoming connection-address in subsequent steps; +- uses the port information from the SDP m-line as incoming port information in subsequent steps; +- uses the codec information from the SDP m-line and associated non-OMR attribute lines as incoming codec information in the subsequent steps. +- allocates an MR context with access to the IP realms, nettypes and addrtypes associated with the incoming connection address and port information and the outgoing signalling path; +- inserts the incoming connection address and incoming port information for the media line into the remote connection address and port information for the incoming termination on the MR; +- provides to the MR the incoming codec information; +- replaces the connection address and port information for the media line in the initial SDP offer with the connection address and port information from the MR termination on the outgoing side; + +- adds to the modified initial SDP offer a visited-realm instance 3 for the IP realm associated with the connection address and port information for the media line in the modified initial SDP offer; and +- computes checksum values as described in clause 5.6.3 and adds the "omr-s-cksum" and "omr-m-cksum" attributes for the media line. The "omr-s-cksum" is set to "0" since there is no session line attributes to compute the checksum on. + +None of the intermediate IMS CN subsystem entities manipulated with the initial SDP offer but the identity of [user\\_B@operator\\_Y.net](#) in the Request-URI is change to the contact address, i.e. UE-B@operatorX.net. + +The intermediate IMS CN subsystem entities select an IBCF, IBCF-3, in the realm "Ya.operatorY.net" and forward the INVITE request with the initial SDP offer to the IBCF-3 according to TS 24.229 [4]. + +**Table A.5.2-4: SIP INVITE request (IBCF-2 to IBCF-3 via intermediate IMS CN subsystem entities)** + +``` +INVITE SIP: user_B@operator_Y.net; SIP/2.0 + +SIP headers according to 3GPP TS 24.229 [4] + +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933615 IN IP4 192.0.2.1 +s= +c=IN IP4 190.1.15.2 +m=audio 11324 RTP/AVP 96 97 98 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:96 telephone-event +a=rtpmap:97 AMR/8000/1 +a=fmtp:97 mode-change-capability=2; max-red=220; octet-align=1 +a=rtpmap:98 AMR-WB/16000/1 +a=fmtp:98 mode-change-capability=2; max-red=220 +a=ptime:20 +a=maxptime:240 +b=AS:30 +b=RS:0 +b=RR:2000 +a=visited-realm:1 Xa.operatorX.net IN IP4 192.0.2.1 49170 +a=visited-realm:2 Xa.operatorX.net IN IP4 192.0.2.5 62111 +a=omr-codes:2 audio RTP/AVP 96 97 +a=omr-m-att:2 rtpmap:96 +a=omr-m-att:2 telephone-event +a=omr-m-att:2 rtpmap:97 AMR/8000/1 +a=omr-m-att:2 fmtp:97 +a=omr-m-att:2 mode-change-capability=2; max-red=220; octet-align=1 +a=omr-m-att:2 curr:qos local none +a=omr-m-att:2 curr:qos remote none +a=omr-m-att:2 des:qos mandatory local sendrecv +a=omr-m-att:2 des:qos none remote sendrecv +a=omr-m-att:2 ptime:20 +a=omr-m-att:2 maxptime:240 +a=omr-s-bw:2 AS:30 +a=omr-s-bw:2 RS:0 +a=omr-s-bw:2 RR:2000 +a=visited-realm:3 Ya.operatorY.net IN IP4 190.1.15.2 11324 +a=omr-m-cksum:(..) +a=omr-s-cksum:0 +``` + +#### 6. INVITE request (IBCF-3 to IBCF-4) - see example in table A.5.2-6 + +The IBCF-3 uses procedures in clauses 6.1.4, 6.1.7 and 6.1.9 since previous MRs can be bypassed and no local MR is needed for realm matching. + +The IBCF-3: + +- uses the connection address and port information from the selected instance 2 for the media line in the initial SDP offer as incoming connection address and incoming port information for the media line in the subsequent steps. The instance 2 is selected since it contains more codecs than the visited-realm instance 1; + +- reconstructs the associated codec information for the media line in the initial SDP offer from the selected instance 2 according to clause 5.3 and uses that codec information as incoming codec information in the subsequent steps; +- deletes visited-realm instance 3; +- insert the incoming codec information into the SDP m-line and associated attribute lines of the modified initial SDP offer; +- uses the incoming connection address as the connection address in the SDP c-line of the forwarded initial SDP offer; +- uses the incoming port information as determined in previous steps as port information in the SDP m-line of the modified initial SDP offer; +- computes checksum values as described in clause 5.6.3 and adds the "omr-s-cksum" and "omr-m-cksum" attributes for the media line. The "omr-s-cksum" is set to "0" since there is no session line attributes to compute the checksum on; and +- selects an IBCF, IBCF-4, in the realm "Xa.operatorX.net" and forwards the INVITE request with the initial SDP offer according to TS 24.229 [4] to IBCF-4. + +**Table A.5.2-6: SIP INVITE request (IBCF-3 to IBCF-4)** + +``` + +INVITE SIP: UE-B@operator_Y.net; SIP/2.0 + +SIP headers according to 3GPP TS 24.229 [4] + +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933615 IN IP4 192.0.2.1 +s= +c=IN IP4 192.0.2.5 +m=audio 62111 RTP/AVP 96 97 98 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:96 telephone-event +a=rtpmap:97 AMR/8000/1 +a=fmtp:97 mode-change-capability=2; max-red=220; octet-align=1 +a=rtpmap:98 AMR-WB/16000/1 +a=fmtp:98 mode-change-capability=2; max-red=220 +a=ptime:20 +a=maxptime:240 +b=AS:30 +b=RS:0 +b=RR:2000 +a=visited-realm:1 Xa.operatorX.net IN IP4 192.0.2.1 49170 +a=visited-realm:2 Xa.operatorX.net IN IP4 192.0.2.5 62111 +a=omr-codecs:audio RTP/AVP 96 97 +a=omr-m-att:2 rtpmap:96 +a=omr-m-att:2 telephone-event +a=omr-m-att:2 rtpmap:97 AMR/8000/1 +a=omr-m-att:2 fmtp:97 +a=omr-m-att:2 mode-change-capability=2; max-red=220; octet-align=1 +a=omr-m-att:2 curr:qos local none +a=omr-m-att:2 curr:qos remote none +a=omr-m-att:2 des:qos mandatory local sendrecv +a=omr-m-att:2 des:qos none remote sendrecv +a=omr-m-att:2 ptime:20 +a=omr-m-att:2 maxptime:240 +a=omr-s-bw:2 AS:30 +a=omr-s-bw:2 RS:0 +a=omr-s-bw:2 RR:2000 +a=omr-m-cksum:(...) +a=omr-s-cksum:0 + +``` + +#### **7. INVITE request (IBCF-4 to P-CSCF B) - see example in table A.5.2-7.** + +The IBCF-4 uses procedures in clauses 6.1.5, 6.1.7 and 6.1.9 since the visited-realm with the highest instance number is connected to the same realm as the IBCF-4 and contains codecs according to the local policy. Using the visited-realm instance 1 would reduce the number of available codecs. No MR for realm matching is needed. + +The IBCF-4: + +- uses the connection-address from the SDP c-line in the received initial SDP offer as incoming connection-address in subsequent steps; +- uses the port information from the SDP m-line in the received initial SDP offer as incoming port information in subsequent steps; +- uses the codec information from the SDP m-line and associated non-OMR attribute lines in the received initial SDP offer as incoming codec information in the subsequent steps; +- inserts the incoming codec information into the SDP m-line and associated attribute lines of the modified initial SDP offer; +- uses the incoming connection address as the connection address in the SDP c-line of the forwarded initial SDP offer; and +- use the incoming port information as determined in previous steps as port information in the SDP m-line of the modified initial SDP offer; and +- forwards the INVITE request with the unmodified initial SDP offer to the P-CSCF-B according to TS 24.229 [4]. + +**Table A.5.2-7: SIP INVITE request (IBCF-4 to P-CSCF B)** + +``` + +INVITE SIP: UE-B@operator_Y.net; SIP/2.0 + +SIP headers according to 3GPP TS 24.229 [4] + +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 2987933615 2987933615 IN IP4 192.0.2.1 +s= +c=IN IP4 192.0.2.5 +m=audio 62111 RTP/AVP 96 97 98 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:96 telephone-event +a=rtpmap:97 AMR/8000/1 +a=fmtp:97 mode-change-capability=2; max-red=220; octet-align=1 +a=rtpmap:98 AMR-WB/16000/1 +a=fmtp:98 mode-change-capability=2; max-red=220 +a=ptime:20 +a=maxptime:240 +b=AS:30 +b=RS:0 +b=RR:2000 +a=visited-realm:1 Xa.operatorX.net IN IP4 192.0.2.1 49170 +a=visited-realm:2 Xa.operatorX.net IN IP4 192.0.2.5 62111 +a=omr-codecs:2 audio RTP/AVP 96 97 +a=omr-m-att:2 rtpmap:96 +a=omr-m-att:2 telephone-event +a=omr-m-att:2 rtpmap:97 AMR/8000/1 +a=omr-m-att:2 fmtp:97 +a=omr-m-att:2 mode-change-capability=2; max-red=220; octet-align=1 +a=omr-m-att:2 curr:qos local none +a=omr-m-att:2 curr:qos remote none +a=omr-m-att:2 des:qos mandatory local sendrecv +a=omr-m-att:2 des:qos none remote sendrecv +a=omr-m-att:2 ptime:20 +a=omr-m-att:2 maxptime:240 +a=omr-s-bw:2 AS:30 +a=omr-s-bw:2 RS:0 +a=omr-s-bw:2 RR:2000 +a=omr-m-cksum:(...) +a=omr-s-cksum:0 + +``` + +#### 8. INVITE request (P-CSCF to UE- B) - see example in table A.5.2-8. + +The P-CSCF-B uses the procedures in clauses 6.1.5, 6.1.7 and 6.1.9 since no previous realm instance offers an opportunity to bypass an MR and no local MR for realm matching is needed. + +The P-CSCF-B: + +- uses the connection-address from the SDP c-line in the received initial SDP offer as incoming connection-address in subsequent steps; +- uses the port information from the SDP m-line in the received initial SDP offer as incoming port information in subsequent steps; +- uses the codec information from the SDP m-line and associated non-OMR attribute lines in the received initial SDP offer as incoming codec information in the subsequent steps; +- inserts the incoming codec information into the SDP m-line and associated attribute lines of the modified initial SDP offer; +- uses the incoming connection address as the connection address in the SDP c-line of the forwarded initial SDP offer; +- use the incoming port information as determined in previous steps as port information in the SDP m-line of the modified initial SDP offer; + +- deletes all OMR attributes from the initial SDP offer according to the local policy; and +- forwards the INVITE request with the modified initial SDP offer to the UE-B according to TS 24.229 [4]. + +**Table A.5.2-8: SIP INVITE request (P-CSCF to UE-B)** + +``` +INVITE SIP: UE-B@operator_Y.net; SIP/2.0 + +SIP headers according to 3GPP TS 24.229 [4] + +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 2987933615 2987933615 IN IP4 192.0.2.1 +s= +c=IN IP4 192.0.2.5 +m=audio 62111 RTP/AVP 96 97 98 +b=AS:30 +b=RS:0 +b=RR:2000 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:96 telephone-event +a=rtpmap:97 AMR/8000/1 +a=fmtp:97 mode-change-capability=2; max-red=220; octet-align=1 +a=rtpmap:98 AMR-WB/16000/1 +a=fmtp:98 mode-change-capability=2; max-red=220 +a=ptime:20 +a=maxptime:240 +``` + +#### **9. 183 (Session Progress) response (UE-B to P-CSCF-B) - see example in table A.5.2-9.** + +The UE accepts the AMR codec and sends a 183 (Session Progress) response to P-CSCF-B with an initial SDP answer selecting the AMR codec and indicating that resources are not yet available according to TS 24.229 [4]. + +**Table A.5.2-9: 183 (Session Progress) response (UE-B to P-CSCF-B)** + +``` +SIP/2.0 183 Session Progress + +SIP headers according to 3GPP TS 24.229 [4] + +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 2987933615 2312345678 IN IP4 192.0.2.1 +s= +c=IN IP4 192.0.2.4 +m=audio 16511 RTP/AVP 96 97 +b=AS:30 +b=RS:0 +b=RR:2000 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:96 telephone-event +a=rtpmap: 97 AMR/8000/1 +a=fmtp: 97 mode-change-capability=2; max-red=220; octet-align=1 +a=ptime:20 +a=maxptime:240 +``` + +#### **10. 183 (Session Progress) response (P-CSCF-B to IBCF-4) - see example in table A.5.2-9** + +The P-CSCF-B uses the procedures in clauses 6.2.7 and 6.2.9 since the connection address is valid and no primary local MR was allocated when the initial SDP offer was sent. + +The P-CSCF-B forwards the 183 (Session Progress) response with the unmodified initial SDP answer to IBCF-4 according to TS 24.229 [4]. + +#### **11. PRACK request (IBCF-4 to P-CSCF-B) - see example in table A.5.2-11.** + +The IBCF-4 uses the procedure in clause 6.2.2 to determine that the transcoder allocated by IBCF-1 is not needed any longer and that a PRACK request can be sent to update the IP address according to visited-realm instance 1. + +The IBCF-4 uses the procedures in 6.1.4, 6.1.7 and 6.1.9 since the previous MR at IBCF-1 can be bypassed and no local MR is needed for realm matching. + +The IBCF-4: + +- uses the connection address and port information from the selected visited-realm instance 1 for the media line in the received initial SDP offer (received in the initial INVITE request in step 6) as incoming connection address and incoming port information for the media line in the subsequent steps; +- reconstructs the associated codec information for the media line in the received initial SDP offer from the selected instance 1 as described in clause 5.3, and use the AMR codec and associated attribute lines as incoming codec information in the subsequent steps; +- deletes every OMR attribute for the media line with instance-number value 2 and 3; +- inserts the incoming codec information into the SDP m-line and associated attribute lines of the modified second SDP offer; +- uses the incoming connection address as the connection address in the SDP c-line of the forwarded second SDP offer; +- uses the incoming port information as port information in the SDP m-line of the modified second SDP offer; +- computes checksum values as described in clause 5.6.3 and replaces or add the "omr-s-cksum" and "omr-m-cksum" attributes for the media line; and +- sends the PRACK request with the modified second SDP offer to P-CSCF-B according to TS 24.229 [4]. + +**Table A.5.2-11: SIP PRACK request (IBCF-4 to P-CSCF-B)** + +``` +UPDATE SIP: UE_B@operator_Y.net; SIP/2.0 + +SIP headers according to 3GPP TS 24.229 [4] + +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933615 IN IP4 192.0.2.1 +s= +b=AS:30 +b=RS:0 +b=RR:2000 +c= IN IP4 192.0.2.1 +m=audio 49170 RTP/AVP 96 97 +a=rtpmap:96 telephone-event +a=rtpmap:97 AMR/8000/1 +a=fmtp:97 mode-change-capability=2; max-red=220; octet-align=1 +a=qos local none +a=curr: qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=ptime:20 +a=maxptime:240 +a=visited-realm:1 Xa.operatorX.net IN IP4 192.0.2.1 49170 +a=omr-m-cksum:(..) +a=omr-s-cksum:(..) +``` + +#### 12. PRACK request (P-CSCF-B to UE-B) - see example in table A.5.2-12. + +The P-CSCF-B uses the procedure in 6.1.5, 6.1.7 and 6.1.9 since there are no MR to bypass and since no local MR is allocated for realm matching. + +The P-CSCF-B: + +- uses the connection-address from the SDP c-line in the received second SDP offer as incoming connection-address in subsequent steps; +- uses the port information from the SDP m-line in the received second SDP offer as incoming port information in subsequent steps; +- uses the codec information from the SDP m-line and associated non-OMR attribute lines in the received second SDP offer as incoming codec information in the subsequent steps; +- inserts the incoming codec information into the SDP m-line and associated attribute lines of the modified second SDP offer; +- uses the incoming connection address as the connection address in the SDP c-line of the forwarded second SDP offer; +- uses the incoming port information as port information in the SDP m-line of the modified second SDP offer; +- deletes all OMR related attributes from the second SDP offer according to local policy; and +- forwards the PRACK request and the modified second SDP offer to the UE-B according to TS 24.229 [4]. + +**Table A.5.2-12: SIP PRACK request (P-CSCF-B to UE-B)** + +``` + +PRACK SIP: UE_B@operator_Y.net; SIP/2.0 + +SIP headers according to 3GPP TS 24.229 [4] + +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933615 IN IP4 192.0.2.1 +s= +b=AS:30 +b=RS:0 +b=RR:2000 +c= IN IP4 192.0.2.1 +m=audio 49170 RTP/AVP 96 97 +a=rtpmap:96 telephone-event +a=rtpmap:97 AMR/8000/1 +a=fmtp:97 mode-change-capability=2; max-red=220; octet-align=1 +a=qos local none +a=curr: qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=ptime:20 +a=maxptime:240 + +``` + +#### **13. 200 (OK) response (UE-B to P-CSCF-B) - see the SDP example in table A.5.2-9.** + +The UE accepts the AMR codec and sends a 200 (OK) response to the PRACK request to P-CSCF-B with a second SDP answer indicating that resources are not yet available according to TS 24.229 [4]. + +#### **14. 200 (OK) response (P-CSCF-B to IBCF-4) - see the SDP example in table A.5.2-9.** + +The P-CSCF-B uses the procedures in clauses 6.2.7 and 6.2.9 since the connection address is valid and no primary local MR was allocated when the second SDP offer was sent. + +The P-CSCF-B forwards the 200 (OK) response to the PRACK request with the unmodified second SDP answer to IBCF-4 according to TS 24.229 [4]. + +#### **15. 183 (Session Progress) response (IBCF-4 - to IBCF-3) - see example in table A.5.2-15.** + +The IBCF-4 continues from the point in step 10 where the 183 (Session Progress) response was received with an initial SDP answer corresponding to the visited-realm 1 and no transcoding by IBCF-1 was required. + +The IBCF-4 uses the procedures in clause 6.2.7 and 6.2.9 since a valid connection address was received in the 200 (OK) response to the UPDATE request and no MR was allocated when the initial SDP offer was sent. + +The IBCF-4: + +- copies into the media line of the initial SDP answer the visited-realm instance 1 from the media line of the received initial SDP offer that was used to populate the connection address and port information in the forwarded second SDP offer, replacing the connection-address and port information in the instance with the connection address and port information from the received second SDP answer; +- replaces the connection address information in the initial SDP answer with the unspecified address of IPv4, "0.0.0.0"; and +- sends the 183 (Session Progress) response with the modified second SDP answer as the initial SDP answer to the IBCF-3 according to TS 24.229 [4]. + +**Table A.5.2-15: 183 (Session Progress) response (IBCF-4 - to IBCF-3)** + +``` +SIP/2.0 183 Session Progress + +SIP headers according to 3GPP TS 24.229 [4] + +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2312345678 IN IP4 192.0.2.1 +s=- +b=AS:30 +b=RS:0 +b=RR:2000 +c=IN IP4 0.0.0.0 +m=audio 16511 RTP/AVP 96 97 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:96 telephone-event +a=rtpmap:97 AMR/8000/1 +a=fmtp:97 mode-change-capability=2; max-red=220; octet-align=1 +a=ptime:20 +a=maxptime:240 +a=visited-realm:1 Xa.operatorX.net IN IP4 192.0.2.4 16511 +``` + +#### **16-17. 183 (Session Progress) response (IBCF-3 to IBCF-2 via intermediate IM CN subsystem entities) - see example in table A.5.2-16.** + +The IBCF-3 uses the procedures in clauses 6.2.5 and 6.2.9 since the initial SDP answer contains an unspecified connection address and a visited-realm instance and the allocated MR is not needed. + +The IBCF-3 forwards the 183 (Session Progress) response with the unmodified initial SDP answer to the intermediate IM CN subsystem entities according to TS 24.229 [4]. + +The intermediate IM CN subsystem entities forwards the 183 (Session Progress) response with the unmodified initial SDP answer to the IBCF-2 according to TS 24.229 [4]. + +#### **18. 183 (Session Progress) response (IBCF-2 to IBCF-1) - see example in table A.5.2-16.** + +The IBCF-2 uses procedures in clauses 6.2.5 and 6.2.9 since an unspecified connection address and a visited-realm instance was received and the allocated MR is not needed. + +IBCF-2: + +- forwards the 183 (Session Progress) response with the unmodified initial SDP answer to IBCF-1 according to TS 24.229 [4]; and +- keeps the allocated MR until it is no longer potentially needed for this and any other forked dialog. + +#### **19. 183 (Session Progress) response (IBCF-1 to P-CSCF-A) - see example in table A.5.2-19.** + +The IBCF-1 uses the procedures in clauses 6.2.5 and 6.2.9 since an unspecified connection address and a visited-realm instance was received and the MR allocated for transcoding is not needed. + +- replaces the connection address and port information for the media line in the initial SDP answer with the connection address and port information from the visited-realm instance 1 in the received initial SDP answer; + +- forwards the 183 (Session Progress) response with the modified initial SDP answer to P-CSCF-A according to TS 24.229 [4]; and +- keeps the MR allocated for transcoding until it is no longer potentially needed for this and any other forked dialog. + +**Table A.5.2-19: 183 (Session Progress) response (IBCF-1 to P-CSCF-A)** + +``` + +SIP/2.0 183 Session Progress + +SIP headers according to 3GPP TS 24.229 [4] + +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2312345678 IN IP4 192.0.2.1 +s=- +b=AS:30 +b=RS:0 +b=RR:2000 +c=IN IP4 192.0.2.4 +m=audio 16511 RTP/AVP 96 97 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:96 telephone-event +a=rtpmap:97 AMR/8000/1 +a=fmtp:97 mode-change-capability=2; max-red=220; octet-align=1 +a=ptime:20 +a=maxptime:240 + +``` + +#### **20. 183 (Session Progress) response (P-CSCF-A to UE-A) - see example in table A.5.2-23.** + +The P-CSCF-A uses procedures in clause 6.2.7 and 6.2.9 since a valid connection address is received and no MR was allocated when the initial SDP offer was sent. + +P-CSCF-A forwards the 183 (Session Progress) response with the unmodified initial SDP answer to the UE-B according to TS 24.229 [4]. + +#### **21-74. Remaining SIP message for establishing the call** + +The rest of the steps follow the same principles as described in clause A.3.2 steps 17 – 65. + +## A.6 Loopback routeing via an intermediate network + +### A.6.1 General + +This clause provides an example on how OMR is used to find an optimal media path when loopback routeing is used and how to preserve signalling paths and media paths compatible with the existing CS charging model. + +The example does not focus on the OMR algorithm as such instead the focus is on the selection and configuration of IP realm names. The example only describes the message flow on the originating side. + +Figure A.6.1-1 shows the IP realm and IP configuration used in this example. + +![Diagram showing IP realm and IP address configurations across three networks: Home IMS network H, IPX network X, and Visited network V. It details the flow of control and media paths through various network elements like S-CSCF, IBCF, TrGW, IC, MGW, P-CSCF, PCRF, PDN GW, and TRF.](2a476a0b3dbc3429436246db4784ff9f_img.jpg) + +The diagram illustrates the network architecture and IP address configurations for a roaming scenario. It consists of three main network domains: + +- Home IMS network H: Realm Ha.operatorH.net** + - Contains an **S-CSCF/BGCF** connected to two **IBCF** instances (**IBCF-2** and **IBCF-3**). + - Each IBCF is connected to a **TrGW**. + - IBCF-2** has IP address **190.1.15.2** (Ha) and **Xa4 179.14.1.2**. + - IBCF-3** has IP address **190.1.15.2** (Ha) and **Xa4 179.14.1.3**. +- IPX network X: Realm Xa.operatorX.net** + - Contains two **IC** instances (**IC-1** and **IC-2**), each connected to an **MGW**. + - IC-1** has IP address **179.14.1.1** (Xa2) and **Xa2 178.15.1.2**. + - IC-2** has IP address **179.14.1.4** (Xa2) and **Xa2 178.15.1.3**. +- Visited network V: Realm Va.operatorV.net** + - Contains a **P-CSCF-A** connected to a **PCRF** and a **PDN GW**. + - P-CSCF-A** is connected to **IBCF-1** (IP: **178.15.1.1** (Xa1), **192.0.2.2**). + - IBCF-1** is connected to **TrGW**. + - TrGW** is connected to **IBCF-4** (IP: **178.15.1.4** (Xa1), **192.0.2.3**). + - IBCF-4** is connected to **TrGW**. + - TrGW** is connected to a **TRF**. + - TRF** is connected to **IBCF-5** (IP: **192.0.2.4** (Va)). + - UE-A** (IP: **192.0.2.1** (Va)) is connected to **P-CSCF-A**. + +**Signalling and Media Paths:** + +- Control signalling path (solid line with double arrowheads):** UE-A ↔ P-CSCF-A ↔ IBCF-1 ↔ TrGW ↔ IBCF-4 ↔ TrGW ↔ TRF ↔ IBCF-5. +- Media path after OMR (dashed line with single arrowheads):** UE-A → PDN GW → IBCF-5. + +Diagram showing IP realm and IP address configurations across three networks: Home IMS network H, IPX network X, and Visited network V. It details the flow of control and media paths through various network elements like S-CSCF, IBCF, TrGW, IC, MGW, P-CSCF, PCRF, PDN GW, and TRF. + +**Figure A.6.1-1: IP realm and IP address configurations** + +### A.6.2 Message flow + +The user A at UE-A is roaming into a visited network V. The user A is a subscriber of operator H. + +Preconditions in this example: + +- The user A is registered to the Home IMS network H via the visited operator V network and the IC network X; The IC network does not store any registration information. +- P-CSCF-A and S-CSCF support loopback routing; +- IBCF-1, IBCF-2, IBCF-3, IBCF-4, IBCF-5, IC-1 and IC-2 support OMR and all networks supports loopback routing; +- IBCF-1, IBCF-4 and IBCF-5 are instances in the same physical IBCF in the visited network V; +- IC-1 and IC-2 are instances in the same physical IC hub; +- IBCF-2 and IBCF-3 are instances in the same physical IBCF in the home network H; and +- no B2BUA manipulating SDP is connected in the home operator H network. + +The "iotl" SIP URI parameter specified in IETF RFC 7549 [22] is included in the message flow in order to assist in determine the policy. + +Figure A.6.2-1 shows the message flow for the scenario. + +![Sequence diagram showing message flow for loopback routing via an IC network. The diagram spans across five network domains: Visited network V, IC network X, Home IMS network H (of user A), IC network X, and Visited network V. It shows the flow of INVITE, 183, PRACK, UPDATE, and 200 OK messages between various network elements including UE-A, P-CSCF-A, IBCF-1, IC1, IBCF-2, S-CSCF/BGCF, IBCF-3, IC2, IBCF-4, TRF, and IBCF-5. Each message is annotated with SIP headers and SDP details.](7c92fa3f1d1b465cc1d3c48a1a8728ff_img.jpg) + +The diagram illustrates a SIP message flow for loopback routing. The sequence of messages is as follows: + +- 1. INVITE**: UE-A to P-CSCF-A. SDP: AMR, c=192.0.2.1. +- 2. INVITE**: P-CSCF-A to IBCF-1. FC=TRF URI, PANI. SDP: AMR, c=192.0.2.1. +- 3. INVITE**: IBCF-1 to IC1. FC=TRF URI, PANI. SDP: AMR, c=178.15.1.1. visited-realm:1 Va 192.0.2.1, visited-realm:2 Xa1 178.15.1.1. +- 4. INVITE**: IC1 to IBCF-2. FC=TRF URI, PANI. SDP: AMR, c=179.14.1.1. visited-realm:1 Va 192.0.2.1, visited-realm:2 Xa1 178.15.1.1, visited-realm:3 Xa2 179.14.1.1. +- 5. INVITE**: IBCF-2 to S-CSCF/BGCF. FC=TRF URI, PANI. SDP: AMR, c=190.1.15.1. visited-realm:1 Va 192.0.2.1, visited-realm:2 Xa1 178.15.1.1, visited-realm:3 Xa2 179.14.1.1, visited-realm:4 Ha 190.1.15.1. +- 6. INVITE**: S-CSCF/BGCF to IBCF-3. FC=Loopback, PANI. R.TRF address. SDP: AMR, c=190.1.15.1. visited-realm:1 Va 192.0.2.1, visited-realm:2 Xa1 178.15.1.1, visited-realm:3 Xa2 179.14.1.1, visited-realm:4 Ha 190.1.15.1. +- 7. INVITE**: IBCF-3 to IC2. FC=Loopback, PANI. R.TRF address. SDP: AMR, c=179.14.1.3. visited-realm:1 Va 192.0.2.1, visited-realm:2 Xa1 178.15.1.1, visited-realm:3 Xa2 179.14.1.1, visited-realm:4 Ha 190.1.15.1, visited-realm:5 Xa4 179.14.1.3. +- 8. INVITE**: IC2 to IBCF-4. FC=Loopback, PANI. R.TRF address. SDP: AMR, c=179.14.1.1. visited-realm:1 Va 192.0.2.1, visited-realm:2 Xa1 178.15.1.1, visited-realm:3 Xa2 179.14.1.1. +- 9. INVITE**: IBCF-4 to TRF. FC=Loopback, PANI. R.TRF address. SDP: AMR, c=192.0.2.1. visited-realm:1 Va 192.0.2.1. +- 10. INVITE**: TRF to IBCF-5. SDP: AMR, c=192.0.2.1. +- 11. 183**: IBCF-5 to TRF. SDP: AMR, c=192.0.2.4, visited-realm:1 Va 192.0.2.4. +- 12. 183**: TRF to IBCF-4. SDP: AMR, c=192.0.2.4, visited-realm:1 Va 192.0.2.4. +- 13. 183**: IBCF-4 to IC2. SDP: AMR, c=0.0.0.0, visited-realm:1 Va 192.0.2.4. +- 14. 183**: IC2 to IBCF-3. SDP: AMR, c=0.0.0.0, visited-realm:1 Va 192.0.2.4. +- 15. 183**: IBCF-3 to S-CSCF/BGCF. SDP: AMR, c=0.0.0.0, visited-realm:1 Va 192.0.2.4. +- 16. 183**: S-CSCF/BGCF to IBCF-2. SDP: AMR, c=0.0.0.0, visited-realm:1 Va 192.0.2.4. +- 17. 183**: IBCF-2 to IC1. SDP: AMR, c=0.0.0.0, visited-realm:1 Va 192.0.2.4. +- 18. 183**: IC1 to IBCF-1. SDP: AMR, c=0.0.0.0, visited-realm:1 Va 192.0.2.4. +- 19. 183**: IBCF-1 to P-CSCF-A. SDP: AMR, c=192.0.2.4. +- 20. 183**: P-CSCF-A to UE-A. SDP: AMR, c=192.0.2.4. +- 21. PRACK and 200 OK**: PRACK without an SDP offer. +- 22. UPDATE and 200 OK**: following the same principles as in subclause A.3.2 steps 33 - 48. +- 23. 180 Ringing**: (Resources are reserved and no update needed since a=conf was not included by the UE-A) +- 24. 200 OK**: INVITE (without SDP) and ACK + +Sequence diagram showing message flow for loopback routing via an IC network. The diagram spans across five network domains: Visited network V, IC network X, Home IMS network H (of user A), IC network X, and Visited network V. It shows the flow of INVITE, 183, PRACK, UPDATE, and 200 OK messages between various network elements including UE-A, P-CSCF-A, IBCF-1, IC1, IBCF-2, S-CSCF/BGCF, IBCF-3, IC2, IBCF-4, TRF, and IBCF-5. Each message is annotated with SIP headers and SDP details. + +Figure A.6.2-1: Message flow for loopback routing via an IC network + +NOTE: For clarity, the SIP 100 (Trying) messages are not shown in the signalling flow. + +The steps of the flow are as follows: + +#### **1. INVITE request (UE-A to P-CSCF-A) - see example in table A.6.2-1.** + +The user A at UE-A initiates a call. The UE-A sends an initial INVITE request containing an initial SDP offer to the P-CSCF-A according to TS 24.229 [4]. + +**Table A.6.2-1: INVITE request (UE-A to P-CSCF-A)** + +``` + +INVITE SIP: tel:+4687197378; SIP/2.0 + +Route: + +Other SIP headers according to 3GPP TS 24.229 [4] + +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933615 IN IP4 192.0.2.1 +s= +t=0 0 +c=IN IP4 192.0.2.1 +m=audio 49170 RTP/AVP 96 97 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos optional remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; mode-change-period=2 +a=rtpmap:96 telephone-event +a=maxptime:20 + +``` + +#### **2. INVITE request (P-CSCF-A to IBCF-1) - see example in table A.6.2-2.** + +When the P-CSCF-A receives the initial INVITE request and, since the user A is a roaming user, the P-CSCF-A adds the Feature-Caps header field with the g.3gpp.trf with the address to the TRF; and + +The P-CSCF-A selects an IBCF (IBCF-1) to be the exit IBCF towards the home IMS network H of the user A and sends the INVITE request without modifying the initial SDP offer according to TS 24.229 [4] to IBCF-1. + +**Table A.6.2-2: INVITE request (P-CSCF-A to IBCF-1)** + +``` + +INVITE SIP: tel:+4687197378; SIP/2.0 + +Route: +Feature-Caps:*;+g.3gpp.trf="" +P-Access-Network-Info: 3GPP-UTRAN-TDD;utran-cell-id-3gpp=234151D0FCE11 +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024" + +Other SIP headers according to 3GPP TS 24.229 [4] + +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933615 IN IP4 192.0.2.1 +s= +t=0 0 +c=IN IP4 192.0.2.1 +m=audio 49170 RTP/AVP 96 97 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; mode-change-period=2 +a=rtpmap:96 telephone-event +a=maxptime:20 + +``` + +#### **3. INVITE request (IBCF-1 to IC-1) - see example in table A.6.2-3.** + +When the IBCF-1 receives the initial INVITE request containing the "+g.3gpp.trf" header field parameter in a Feature-Caps header field, the IBCF-1 updates the SDP as follows: + +- the media parameters received from the TrGW are included in the initial SDP offer; +- the IP address, port number and the IP realm Va.operatorV.net of the UE-A is included as the visited-realm 1 instance; + +- the IP address, port number of the TrGW and the local IP realm Xa1.operatorX.net are included as the visited-realm 2 instance. To avoid unwanted optimal media paths being created the local IP realm Xa1.operatorX.net is selected as this is a local IP realm only known by the IBCF-1, IBCF-4 and IBCF-5. + +The IBCF-1 selects to route the INVITE request via an IC network and sends the INVITE request with the modified SDP offer according to TS 24.229 [4] to the IC-1. + +**Table A.6.2-3: INVITE request (IBCF-1 to IC-1)** + +``` + +INVITE SIP: tel:+4687197378; SIP/2.0 + +Route: +Feature-Caps:*;+g.3gpp.trf="" +P-Access-Network-Info:3GPP-UTRAN-TDD;utran-cell-id-3gpp=234151D0FCE11 +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024" + +Other SIP headers according to 3GPP TS 24.229 [4] + +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o= 2987933615 2987933615 IN IP4 192.0.2.1 +s= +t=0 0 +c=IN IP4 178.15.1.1 +m=audio 62111 RTP/AVP 96 97 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; mode-change-period=2 +a=rtpmap:96 telephone-event +a=maxptime:20 +a=visited-realm:1 Va.operatorV.net IN IP4 192.0.2.1 49170 +a=visited-realm:2 Xa1.operatorX.net IN IP4 178.15.1.1 62111 +a=omr-m-cksum:(..) +a=omr-s-cksum:0 + +``` + +#### 4. INVITE request (IC-1 to IBCF-2) - see example in table A.6.2-4. + +When the IC-1 receives the initial INVITE request and since the IC-1 according to local policy allows itself to be bypassed by media then the IC-1 updates the initial SDP offer as follows: + +- the media parameters of the IC-1 are included in the initial SDP offer; and +- the IP address, port number of the IC-1 and the local IP realm Xa2.operatorX.net are included as the visited-realm 3 instance. To avoid unwanted optimal media paths being created the local IP realm Xa2.operatorX.net is selected as this is a local IP realm only known by the IC-1 and IC-2. + +The IC-1 selects an entry IBCF of the home IMS network H and sends the INVITE request with the modified initial SDP offer according to TS 24.229 [4] to the IBCF-2. + +**Table A.6.2-4: INVITE request (IC-1 to IBCF-2)** + +``` + +INVITE SIP: tel:+4687197378; SIP/2.0 + +Route: +Feature-Caps:*;+g.3gpp.trf="" +P-Access-Network-Info:3GPP-UTRAN-TDD;utran-cell-id-3gpp=234151D0FCE11 +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024";orig-ioi="Va.operatorV.net" + +Other SIP headers according to 3GPP TS 24.229 [4] + +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933615 IN IP4 192.0.2.1 +s= +t=0 0 +c=IN IP4 179.14.1.1 +m=audio 52211 RTP/AVP 96 97 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; mode-change-period=2 +a=rtpmap:96 telephone-event +a=maxptime:20 +a=visited-realm:1 Va.operatorV.net IN IP4 192.0.2.1 49170 +a=visited-realm:2 Xal.operatorX.net IN IP4 178.15.1.1 62111 +a=visited-realm:3 Xa2.operatorX.net IN IP4 179.14.1.1 52211 +a=omr-m-cksum:(..) +a=omr-s-cksum:0 + +``` + +#### 5. INVITE request (IBCF-2 to S-CSCF) - see example in table A.6.2-5. + +When the IBCF-2 receives the initial INVITE request containing the "+g.3gpp.trf" header field parameter in a Feature-Caps header field, the IBCF-2 updates the initial SDP offer as follows: + +- the media parameters of the TrGW are included in the initial SDP offer; and +- the IP address, port number of the TrGW and the IP realm Ha.operatorH.net are included as the visited-realm 4 instance. + +The IBCF-2 sends the INVITE request with the modified initial SDP offer according to TS 24.229 [4] to the S-CSCF. + +**Table A.6.2-5: INVITE request (IBCF-2 to S-CSCF)** + +``` + +INVITE SIP: tel:+4687197378; SIP/2.0 + +Route: +Feature-Caps:*;+g.3gpp.trf ="" +P-Access-Network-Info:3GPP-UTRAN-TDD;utran-cell-id-3gpp=234151D0FCE11 +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024";orig-ioi="Va.operatorV.net" + +Other SIP headers according to 3GPP TS 24.229 [4] + +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933615 IN IP4 192.0.2.1 +s= +t=0 0 +c=IN IP4 190.1.15.1 +m=audio 16789 RTP/AVP 96 97 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; mode-change-period=2 +a=rtpmap:96 telephone-event +a=maxptime:20 +a=visited-realm:1 Va.operatorV.net IN IP4 192.0.2.1 49170 +a=visited-realm:2 Xal.operatorX.net IN IP4 178.15.1.1 62111 +a=visited-realm:3 Xa2.operatorX.net IN IP4 179.14.1.1 52211 +a=visited-realm:4 Ha.operatorH.net IN IP4 190.1.15.1 16789 +a=omr-m-cksum:(..) +a=omr-s-cksum:0 + +``` + +#### **6. INVITE request (S-CSCF to IBCF-3) - see example in table A.6.2-6.** + +When the S-CSCF receives the initial INVITE request the S-CSCF decides according to local policy that loopback routeing shall be used. + +The S-CSCF: + +- includes the TRF URI included in the g.3gpp.trf in the Route header field; and +- includes in a Feature-Caps header field the feature tag +g.3gpp.loopback to indicate that loopback routeing is ongoing. + +NOTE: Number normalization and ENUM translation is deferred to the visited network. + +The S-CSCF/BGCF selects an entry IBCF and sends the INVITE request with the modified SDP offer according to TS 24.229 [4] to the IBCF-3. + +**Table A.6.2-6: INVITE request (S-CSCF to IBCF-3)** + +``` + +INVITE SIP: tel:+4687197378; SIP/2.0 + +Route: +Feature-Caps:*;+g.3gpp.loopback=<"homenetwork_A"> +P-Access-Network-Info:3GPP-UTRAN-TDD;utran-cell-id-3gpp=234151D0FCE11 +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024" + +Other SIP headers according to 3GPP TS 24.229 [4] + +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933615 IN IP4 192.0.2.1 +s= +t=0 0 +c=IN IP4 190.1.15.1 +m=audio 16789 RTP/AVP 96 97 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; mode-change-period=2 +a=rtpmap:96 telephone-event +a=maxptime:20 +a=visited-realm:1 Va.operatorV.net IN IP4 192.0.2.1 49170 +a=visited-realm:2 Xal.operatorX.net IN IP4 178.15.1.1 62111 +a=visited-realm:3 Xa2.operatorX.net IN IP4 179.14.1.1 52211 +a=visited-realm:4 Ha.operatorH.net IN IP4 190.1.15.1 16789 +a=omr-m-cksum:(...) +a=omr-s-cksum:0 + +``` + +#### 7. INVITE request (IBCF-3 to IC-2) - see example in table A.6.2-7. + +When the IBCF-3 receives the initial INVITE request containing the "+g.3gpp.loopback" header field parameter in a Feature-Caps header field, the IBCF-3 updates the initial SDP offer as follows: + +- the media parameters of the TrGW are included in the initial SDP offer; and +- the IP address, port number of the TrGW and the local IP realm Xa4.operatorX.net are included as the visited-realm 5 instance. To avoid unwanted optimal media paths being created the local IP realm Xa4.operatorX.net is selected as this is a local IP realm only known by the IBCF-2 and IBCF-3. + +The IBCF-3 selects to route the INVITE request via an IC network and sends the INVITE request with the modified initial SDP offer according to TS 24.229 [4] to the IC-2. + +**Table A.6.2-7: INVITE request (IBCF-3 to IC-2)** + +``` + +INVITE SIP: tel:+4687197378; SIP/2.0 + +Route: +Feature-Caps:*;+g.3gpp.loopback=<"homenetwork-A"> +P-Access-Network-Info:3GPP-UTRAN-TDD;utran-cell-id-3gpp=234151D0FCE11 +P-Charging-Vector:icid-value="AyretyU0dm+602IrT5tAFrbHLso=023551024" + +Other SIP headers according to 3GPP TS 24.229 [4] + +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933615 IN IP4 192.0.2.1 +s= +t=0 0 +c=IN IP4 179.14.1.3 +m=audio 34500 RTP/AVP 96 97 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; mode-change-period=2 +a=rtpmap:96 telephone-event +a=maxptime:20 +a=visited-realm:1 Va.operatorV.net IN IP4 192.0.2.1 49170 +a=visited-realm:2 Xal.operatorX.net IN IP4 178.15.1.1 62111 +a=visited-realm:3 Xa2.operatorX.net IN IP4 179.14.1.1 52211 +a=visited-realm:4 Ha.operatorH.net IN IP4 190.1.15.1 16789 +a=visited-realm:5 Xa4.operatorX.net IN IP4 179.14.1.3 34500 +a=omr-m-cksum:(..) +a=omr-s-cksum:0 + +``` + +#### **8. INVITE request (IC-2 to IBCF-4) - see example in table A.6.2-8.** + +When the IC-2 receives the initial INVITE request the IC-2 detects that an optimal media path avoiding media to be sent through the home IMS network H is possible. The IC-2 updates the initial SDP offer as follows: + +- the IP address and port number included by IC-1 in visited-realm instance 3 are included in the initial SDP offer; and +- the visited-realm instances 4 and 5 are removed so that the media path is no longer passing the home IMS network H. + +The IC-2 selects an entry IBCF in the visited network and sends the INVITE request with the modified initial SDP offer according to TS 24.229 [4] to the IBCF-4. + +**Table A.6.2-8: INVITE request (IC-2 to IBCF-4)** + +``` + +INVITE SIP: tel:+4687197378; SIP/2.0 + +Route: +Feature-Caps:*;+g.3gpp.loopback=<"homenetwork-A"> +P-Access-Network-Info:3GPP-UTRAN-TDD;utran-cell-id-3gpp=234151D0FCE11 +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024" + +Other SIP headers according to 3GPP TS 24.229 [4] + +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933615 IN IP4 192.0.2.1 +s= +t=0 0 +c=IN IP4 179.14.1.1 +m=audio 52211 RTP/AVP 96 97 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; mode-change-period=2 +a=rtpmap:96 telephone-event +a=maxptime:20 +a=visited-realm:1 Va.operatorV.net IN IP4 192.0.2.1 49170 +a=visited-realm:2 Xal.operatorX.net IN IP4 178.15.1.1 62111 +a=visited-realm:3 Xa2.operatorX.net IN IP4 179.14.1.1 52211 +a=omr-m-cksum:(..) +a=omr-s-cksum:0 + +``` + +#### 9. INVITE request (IBCF-4 to TRF) - see example in table A.6.2-9. + +When the IBCF-4 receives the initial INVITE request containing the "+g.3gpp.loopback" header field parameter in a Feature-Caps header field, the IBCF-4 searches for a possible optimal media path and detects that an optimal media path within the visited network is possible. The IBCF-4 updates the initial SDP offer as follows: + +- the IP address and port numbers in the visited-realm instance 1 is included in the initial SDP offer; and +- the visited-realm instances 2 and 3 are removed so that the media path is no longer passing the IC network. + +The IBCF-4 sends the INVITE request with the modified initial SDP offer according to TS 24.229 [4] to the TRF. + +**Table A.6.2-9: INVITE request (IBCF-4 to TRF)** + +``` + +INVITE SIP: tel:+4687197378; SIP/2.0 + +Route: +Feature-Caps:*;+g.3gpp.loopback=<"homenetwork-A">P-Access-Network-Info:3GPP-UTRAN-TDD;utran-cell-id- +3gpp=234151D0FCE11 +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024" + +Other SIP headers according to 3GPP TS 24.229 [4] + +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933615 IN IP4 192.0.2.1 +s= +t=0 0 +c=IN IP4 192.0.2.1 +m=audio 49170 RTP/AVP 96 97 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; mode-change-period=2 +a=rtpmap:96 telephone-event +a=maxptime:20 +a=visited-realm:1 Va.operatorV.net IN IP4 192.0.2.1 49170 +a=omr-m-cksum:(..) +a=omr-s-cksum:0 + +``` + +#### **10. INVITE request (TRF to IBCF-5) - see example in table A.6.2-10.** + +When the TRF receives the initial INVITE request the TRF: + +- performs number normalization and ENUM translation and updates the Request-URI if necessary; and +- appends "iotl" SIP URI parameter with the value "visitedA-homeB" to the Request-URI. + +The TRF selects an exit IBCF and sends the INVITE request with the unmodified initial SDP offer according to TS 24.229 [4] to the IBCF-5. + +**Table A.6.2-10: INVITE request (TRF to IBCF-5)** + +``` + +INVITE SIP: SIP/2.0 + +P-Access-Network-Info:3GPP-UTRAN-TDD;utran-cell-id-3gpp=234151D0FCE11 +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024";orig-ioi="Va.operatorV.net" + +Other SIP headers according to 3GPP TS 24.229 [4] + +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933615 IN IP4 192.0.2.1 +s= +t=0 0 +c=IN IP4 192.0.2.1 +m=audio 49170 RTP/AVP 96 97 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:97 AMR +a=fmtp:97 mode-set=0,2,5,7; mode-change-period=2 +a=rtpmap:96 telephone-event +a=maxptime:20 +a=visited-realm:1 Va.operatorV.net IN IP4 192.0.2.1 49170 +a=omr-m-cksum:(..) +a=omr-s-cksum:0 + +``` + +#### **11. 183 (Session Progress) response (IBCF-5 to TRF) - see example in table A.6.2-11.** + +When the IBCF-5 receives the initial INVITE request the IBCF-5 sends the INVITE request towards the terminating network. The INVITE request may or may not include OMR specific parameters based on the IBCF-5 local policy. + +When the IBCF-5 receives an initial SDP answer in a 183 (Session Progress) response from the terminating network the IBCF-5: + +- includes its own IP address and port number received from the TrGW in the initial SDP answer. + +The IBCF sends the 183 (Session Progress) response with the modified initial SDP answer according to TS 24.229 [4] to the TRF. + +**Table A.6.2-11: 183 (Session Progress) response (IBCF-5 to TRF)** + +``` +SIP/2.0 183 Session Progress + +P-Charging-Vector: icid-value="AyretyU0dm+602IrT5tAFrbHLso=023551024";term-ioi="y.operatorY.net" + +Other SIP headers according to 3GPP TS 24.229 [4] + +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933615 IN IP4 192.0.2.1 +s=- +c=IN IP4 192.0.2.4 +t=0 0 +m=audio 16511 RTP/AVP 97 98 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:98 AMR +a=fmtp:98 mode-set=0,2,5,7; mode-change-period=2 +a=rtpmap:97 telephone-event +a=maxptime:20 +a=visited-realm:1 Va.operatorV.net IN IP4 192.0.2.4 16511 +``` + +#### **12. 183 (Session Progress) response (TRF to IBCF-4) - see example in table A.6.2-12.** + +When the TRF receives the 183 (Session Progress) response the TRF stores the received term-ioi; and + +The TRF sends the 183 (Session Progress) response with the unmodified initial SDP answer according to TS 24.229 [4] to the IBCF-4. + +**Table A.6.2-12: 183 (Session Progress) response (TRF to IBCF-4)** + +``` +SIP/2.0 183 Session Progress + +SIP headers according to 3GPP TS 24.229 [4] + +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933615 IN IP4 192.0.2.1 +s=- +c=IN IP4 192.0.2.4 +t=0 0 +m=audio 16511 RTP/AVP 97 98 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:98 AMR +a=fmtp:98 mode-set=0,2,5,7; mode-change-period=2 +a=rtpmap:97 telephone-event +a=maxptime:20 +a=visited-realm:1 Va.operatorV.net IN IP4 192.0.2.4 16511 +``` + +#### **13-15. 183 (Session Progress) response (IBCF-4 to S-CSCF via IC-2 and IBCF-3) - see example in table A.6.2-13.** + +When the IBCF-4 receives the 183 (Session Progress) response the IBCF-4 updates the initial SDP answer as follows: + +- The c=IN IP4 192.0.2.4 is replaced with an invalid IPv4 address, i.e. c=IN IP4 0.0.0.0, since the IP realm on visited network side and the IC network side are not the same hence the received IP address is not valid on the IC side. + +The IBCF-4 sends the 183 (Session Progress) response with the modified initial SDP answer according to TS 24.229 [4] towards the S-CSCF via the IC-2 and IBCF-3. Neither the IC-2 nor the IBCF-3 updates the SDP. + +**Table A.6.2-13: 183 (Session Progress) response (IBCF-4 to S-CSCF via IC-2 and IBCF-3)** + +``` +SIP/2.0 183 Session Progress + +SIP headers according to 3GPP TS 24.229 [4] + +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933615 IN IP4 192.0.2.1 +s=- +c=IN IP4 0.0.0.0 +t=0 0 +m=audio 16511 RTP/AVP 97 98 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:98 AMR +a=fmtp:98 mode-set=0,2,5,7; mode-change-period=2 +a=rtpmap:97 telephone-event +a=maxptime:20 +a=visited-realm:1 Va.operatorV.net IN IP4 192.0.2.4 16511 +``` + +**16-18. 183 (Session Progress) response (S-CSCF to IBCF-1 via IBCF-2 and IC-1) - see example in table A.6.2-16.** + +The S-CSCF sends the 183 (Session Progress) response according to TS 24.229 [4] to the IBCF-1. Neither the IBCF-2 nor IC-1 updates the initial SDP answer. + +**Table A.6.2-16: 183 (Session Progress) response (S-CSCF to IBCF-1 via IBCF-2 and IC-1)** + +``` +SIP/2.0 183 Session Progress + +SIP headers according to 3GPP TS 24.229 [4] + +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933615 IN IP4 192.0.2.1 +s=- +c=IN IP4 0.0.0.0 +t=0 0 +m=audio 16511 RTP/AVP 97 98 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:98 AMR +a=fmtp:98 mode-set=0,2,5,7; mode-change-period=2 +a=rtpmap:97 telephone-event +a=maxptime:20 +a=visited-realm:1 Va.operatorV.net IN IP4 192.0.2.4 16511 +``` + +**19. 183 (Session Progress) response (IBCF-1 to P-CSCF-A) - see example in table A.6.2-19.** + +When the IBCF-1 receives the 183 (Session Progress) response the IBCF-1 updates the initial SDP answer. + +The IBCF-1: + +- replaces the received invalid IPv4 address with the IP address received in the visited-realm instance 1; and + +- removes all OMR specific attributes since the initial SDP offer from P-CSCF-A did not contain any OMR specific attributes. + +The IBCF-1 sends the 183 (Session Progress) response with the modified initial SDP answer according to TS 24.229 [4] to the P-CSCF-A. + +**Table A.6.2-19: 183 (Session Progress) response (IBCF-1 to P-CSCF-A)** + +``` +SIP/2.0 183 Session Progress + +SIP headers according to 3GPP TS 24.229 [4] + +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933615 IN IP4 192.0.2.1 +s=- +c=IN IP4 192.0.2.4 +t=0 0 +m=audio 16511 RTP/AVP 97 98 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:98 AMR +a=fmtp:98 mode-set=0,2,5,7; mode-change-period=2 +a=rtpmap:97 telephone-event +a=maxptime:20 +``` + +#### 20. 183 (Session Progress) response (P-CSCF-A to UE-A) - see example in table A.6.2-20. + +When the P-CSCF-A receives the 183 (Session Progress) response the P-CSCF authorizes the resources; + +The P-CSCF-A sends the 183 (Session Progress) response with the unmodified initial SDP answer according to TS 24.229 [4] to the UE-A. + +**Table A.6.2-20: 183 (Session Progress) response (P-CSCF-A to the UE-A)** + +``` +SIP/2.0 183 Session Progress + +SIP headers according to 3GPP TS 24.229 [4] + +Content-Type: application/sdp +Content-Length: (...) + +v=0 +o=- 2987933615 2987933615 IN IP4 192.0.2.1 +s=- +c=IN IP4 192.0.2.4 +t=0 0 +m=audio 16511 RTP/AVP 97 98 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv +a=rtpmap:98 AMR +a=fmtp:98 mode-set=0,2,5,7; mode-change-period=2 +a=rtpmap:97 telephone-event +a=maxptime:20 +``` + +#### 21. PRACK requests and SIP 200 (OK) response to the SIP PRACK request + +The PRACK is sent without any SDP offer/SDP answer between the UE-A and IBCF-5 according to TS 24.229 [4]. + +#### 22. UPDATE request and SIP 200 (OK) response to the SIP UPDATE request + +The UPDATE request and the 200 (OK) response to the UPDATE request is sent with a subsequent SDP offer and subsequent SDP answer following the same principle as in clause A.3.2 steps 33 - 48 but now indicating that resources are reserved at UE-A. + +#### **23. 180 (Ringing) response to INVITE request** + +The remote UE sends a 180 (Ringing) response when resources are reserved. The remote UE does not have to send an UPDATE request to indicate that resources are reserved since the subsequent SDP offer did not include the "a=conf" attribute. + +When the IBCF-5 receives the response the IBCF-5 forwards the response to the UE-A via all intermediate nodes. There are no OMR specific actions since the 180 (Ringing) response does not contain any SDP. + +#### **24. 200 (OK) response to INVITE request and the SIP ACK request** + +The 200 (OK) response to the initial INVITE request is sent according to TS 24.229 [4] between the IBCF-5 and UE-A via all intermediate nodes as specified in TS 24.229 [4]. + +The ACK request is sent according to TS 24.229 [4] between the UE-A and IBCF-5 via all intermediate nodes as specified in TS 24.229 [4]. + +# Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|--------|-----------|------|-----|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 11.30.10 | | | | | Version 1.0.0 was created by MCC | 0.3.0 | 1.0.0 | +| 01.31.11 | | | | | Version 1.1.0 created by rapporteur based on PCRs
C3-110028, C3-110030, C3-110031, C3-110032, C3-110033, C3-110034, C3-110233, C3-110234, C3-110235, C3-110238, C3-110374, C3-110375, C3-110376 | 1.0.0 | 1.1.0 | +| 02.28.11 | | | | | Version 1.2.0 created by rapporteur based on PCRs
C3-110472, C3-110579, C3-110580, C3-110582, C3-110601, C3-110603, C3-110604, C3-110605, C3-110650, C3-110651, C3-110696, C3-110699, C3-110723, C3-110755 | 1.1.0 | 1.2.0 | +| 03/2011 | TSG#51 | | | | 3GPP TS 29.079 2.0.0 have been approved in TSG#51 | 2.0.0 | 10.0.0 | +| 06/2011 | TSG#52 | CP-110408 | 0001 | 2 | Adding session checksum in the simple example flow | 10.0.0 | 10.1.0 | +| 06/2011 | TSG#52 | CP-110408 | 0002 | 2 | Update of proactive transcoder without resource reservation FLOW | 10.0.0 | 10.1.0 | +| 06/2011 | TSG#52 | CP-110408 | 0003 | 3 | Clarifying checksum calculation | 10.0.0 | 10.1.0 | +| 06/2011 | TSG#52 | CP-110408 | 0004 | 3 | Receiving and modified SDP offer clarification | 10.0.0 | 10.1.0 | +| 06/2011 | TSG#52 | CP-110408 | 0005 | 2 | IMS-ALG bypasses an allocated transcoding MR - FLOW | 10.0.0 | 10.1.0 | +| 06/2011 | TSG#52 | CP-110408 | 0006 | 2 | Enhanced IP realm definition | 10.0.0 | 10.1.0 | +| 06/2011 | TSG#52 | CP-110408 | 0007 | 2 | Making connected IP realm information available | 10.0.0 | 10.1.0 | +| 09/2011 | TSG#53 | | | | Editorial Improvement by MCC | 10.1.0 | 10.1.1 | +| 12/2011 | TSG#54 | CP-110834 | 0008 | | Updated references - Media Control Channel Framework | 10.1.1 | 10.2.0 | +| 06/2012 | TSG#56 | CP-120355 | 0009 | 3 | RAVEL Loop-back routeing example updates | 10.2.0 | 11.0.0 | +| 06/2012 | TSG#56 | CP-120357 | 0010 | | Incorrect IP address in example | 10.2.0 | 11.0.0 | +| 09/2012 | TSG#57 | CP-120535 | 0013 | | OMR modification | 11.0.0 | 11.1.0 | +| 09/2012 | TSG#57 | CP-120535 | 0014 | 1 | Naming of transit network | 11.0.0 | 11.1.0 | +| 12/2012 | TSG#58 | CP-120840 | 0015 | 1 | Updating loopback example | 11.1.0 | 11.2.0 | +| 12/2012 | TSG#58 | CP-120827 | 0018 | | Reference update of draft-ietf-mediactrl-mixer-control-package | 11.1.0 | 11.2.0 | +| 12/2012 | TSG#58 | CP-120827 | 0020 | 2 | OMR Signalling Flows | 11.1.0 | 11.2.0 | +| 03/2013 | TSG#59 | CP-130079 | 0016 | 4 | Identifying an RAVEL session | 11.2.0 | 11.3.0 | +| 03/2013 | TSG#59 | CP-130079 | 0021 | | Removing all editors notes in the loopback flow | 11.2.0 | 11.3.0 | +| 06-2014 | TSG#64 | CP-140362 | 0024 | 2 | Correcting IP addresses on OMR call flow examples | 11.3.0 | 11.4.0 | +| 06-2014 | TSG#64 | CP-140382 | 0022 | 1 | II-NNI traversal scenario identification | 11.3.0 | 12.0.0 | +| 09-2014 | CT-65 | CP-140528 | 0028 | - | Correcting references | 12.0.0 | 12.1.0 | +| 09-2014 | CT-65 | CP-140528 | 0032 | 1 | Message flow correction for media bypassing all IMS-ALGs | 12.0.0 | 12.1.0 | +| 09-2014 | CT-65 | CP-140536 | 0026 | 1 | Adding the "iotl" SIP URI parameter in the loopback message flow | 12.0.0 | 12.1.0 | +| 09-2014 | CT-65 | CP-140553 | 0025 | - | Removal of a non-existing feature-capability | 12.0.0 | 12.1.0 | +| 09-2014 | CT-65 | CP-140553 | 0029 | 2 | Adding missing home network identity in g.3gpp.loopback feature-capability indicator | 12.0.0 | 12.1.0 | +| 03-2015 | CT-67 | CP-150100 | 0036 | | Instance-number value for secondary-realm | 12.1.0 | 12.2.0 | +| 03-2015 | CT-67 | CP-150100 | 0039 | | Checksum calculation | 12.1.0 | 12.2.0 | +| 03-2015 | CT-67 | CP-150100 | 0042 | | Correcting UA procedure | 12.1.0 | 12.2.0 | +| 03-2015 | CT-67 | CP-150109 | 0046 | | Reference update: draft-holmberg-dispatch-iotl | 12.1.0 | 12.2.0 | +| 06-2015 | CT-68 | CP-150340 | 0049 | 2 | Procedures for avoiding changes in the OMR algorithm outcome on subsequent SDP offer/answer transactions | 12.2.0 | 12.3.0 | +| 06-2015 | CT-68 | CP-150347 | 0050 | - | draft-holmberg-dispatch-iotl-parameter-04 updated to RFC 7549 | 12.2.0 | 12.3.0 | +| 12-2015 | | | | | Automatic upgrade from previous Release | 12.3.0 | 13.0.0 | +| Change history | | | | | | | | +| Date | TSG # | TSG Doc. | CR | Rev | Cat | Subject/Comment | New | +| 03-2017 | CT#75 | | | | | Automatic upgrade from previous Release | 14.0.0 | +| 2018-06 | SA-80 | - | - | - | | Update to Rel-15 version (MCC) | 15.0.0 | +| 2020-06 | SA#88e | - | - | - | | Update to Rel-16 version (MCC) | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29108/raw.md b/marked/Rel-16/29_series/29108/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..46437b4462d5ed19af7bbdf89cb19e3fae550ce8 --- /dev/null +++ b/marked/Rel-16/29_series/29108/raw.md @@ -0,0 +1,413 @@ + + + + + + +# --- Contents + +| | | +|------------------------------------------------------------------------------------------------------------------|----| +| Foreword ..... | 4 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Abbreviations ..... | 5 | +| 4 Principles for the use of RANAP on the E-interface ..... | 6 | +| 4.1 General ..... | 6 | +| 4.2 Transfer of RANAP layer 3 messages on the E-interface..... | 6 | +| 4.3 Roles of 3G_MSC-A, 3G_MSC-I and 3G_MSC-T ..... | 6 | +| 5 Use of the RANAP on the E-interface ..... | 7 | +| 5.1 RAB Assignment..... | 7 | +| 5.2 RAB Release Request ..... | 7 | +| 5.3 Iu Release Request ..... | 8 | +| 5.4 Relocation Resource Allocation..... | 8 | +| 5.5 Relocation Cancel ..... | 8 | +| 5.6 Relocation Detect and Relocation Complete ..... | 8 | +| 5.7 CN Trace invocation ..... | 9 | +| 5.8 Security mode control ..... | 9 | +| 5.9 Location Reporting Control ..... | 9 | +| 5.10 Location Report..... | 9 | +| 5.11 Direct Transfer ..... | 9 | +| 5.12 Error Indication ..... | 10 | +| 5.13 CN Deactivate Trace..... | 10 | +| 5.14 Common ID..... | 10 | +| 5.15 Location Related Data..... | 10 | +| 5.16 UE Specific Information ..... | 10 | +| 5.17 RAB Modification Request..... | 10 | +| 6 RANAP messages transferred on the E-interface ..... | 11 | +| 7 Exceptions for RANAP message contents and information element coding when transferred on the E-interface ..... | 12 | +| 7.1 Message Contents..... | 12 | +| 8 RANAP message error handling when transferred on the E-interface ..... | 12 | +| Annex A (informative): Change history..... | 13 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 1 Scope + +The present document describes the subset of Radio Access Network Application Part (RANAP) messages and procedures, defined in 3GPP TS 25.413 [4], which is used on the E-interface. A general description can be found in 3GPP TS 23.002 [7] and 3GPP TS 23.009 [2]. + +For the initiation and execution of relocation of SRNS (relocation for short, throughout the whole document) between MSCs a subset of RANAP procedures are used. For the subsequent control of resources allocated to the User Equipment (UE) RANAP procedures are used. The Direct Transfer Elementary Procedure (EP) of RANAP, is used for the transfer of connection management and mobility management messages between the UE and the controlling 3G\_MSC. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. +- [1] 3GPP TR 21.905: "Vocabulary". +- [2] 3GPP TS 23.009: "Handover procedures". +- [3] Void +- [4] 3GPP TS 25.413: "UTRAN Iu Interface Radio Access Network Application Part (RANAP) signalling". +- [5] 3GPP TS 29.002: "Mobile Application Part (MAP) specification". +- [6] 3GPP TS 29.010: "Information element mapping between Mobile Station - Base Station System (MS - BSS) and Base Station System - Mobile-services Switching Centre (BSS - MSC); Signalling procedures and the Mobile Application Part (MAP)". +- [7] 3GPP TS 23.002: "Network architecture". +- [8] Void + +# --- 3 Abbreviations + +For the purposes of the present document, the abbreviations defined in TR 21.905 [1] and the following apply: + +| | | +|-----------|------------------------------------------------------------------------------------------------------------------------| +| 3G_MSC | A third generation Mobile services Switching Centre that supports the Iu interface (and possibly also the A-interface) | +| 3G_MSC-A | The controlling 3G_MSC on which the call was originally established | +| 3G_MSC-B | The 3G_MSC to which the UE is handed over in a Basic Handover | +| 3G_MSC-B' | The 3G_MSC to which the UE is handed over in a Subsequent Handover | +| 3G_MSC-I | Interworking 3G_MSC | +| 3G_MSC-T | Target 3G_MSC | +| EP | Elementary Procedure | +| NNSF | NAS Node Selection Function | +| RNC | Radio Network Controller | + +# 4 Principles for the use of RANAP on the E-interface + +## 4.1 General + +The mechanism for the transfer of the RANAP messages on the E-interface is defined in TS 29.002 [5]. The operation of the relocation procedures between 3G\_MSCs and the use of the RANAP messages for those procedures is described in TS 23.009 [2] and TS 29.010 [6]. + +RANAP is defined to connect the RNS to both, the cs and ps domain of an UMTS CN. Procedures, messages and IEs, only defined for communication between the RNS and the ps domain of an UMTS CN will, of course, never appear on the E-interface. + +In the same way as a the connection oriented service of SCCP is used for the messages relating to one UE on the 3G\_MSC-RNS interface a TCAP dialogue is used on the E-interface for messages relating to one UE. As no correspondence to the connectionless service on the 3G\_MSC-RNS interface is used on the E-interface none of the global procedures are applicable. + +The management of the terrestrial circuits between the 3G\_MSCs is outside the scope of the E-interface (see TS 23.009 [2]), therefore all procedures, messages and information elements relating to terrestrial circuits are also excluded from the RANAP procedures and messages used on the E-interface. + +## 4.2 Transfer of RANAP layer 3 messages on the E-interface + +The RANAP data which on the 3G\_MSC-RNS interface is contained in the user data field of the exchanged SCCP frames is on the E-interface transferred as the contents of the access network signalling info in the AN-APDU parameter as described in TS 29.002 [5], indicating the access network protocol identification "ts3G-25413". + +## 4.3 Roles of 3G\_MSC-A, 3G\_MSC-I and 3G\_MSC-T + +For the description in the present document, the 3G\_MSC's functionality related to the relocation between 3G\_MSCs has been split into three logical parts, 3G\_MSC-A, 3G\_MSC-T and 3G\_MSC-I. The different roles need not necessarily be performed by different 3G\_MSCs. + +3G\_MSC-A is the call/connection controlling part of the 3G\_MSC where the call/connection was originally established and the switching point for relocation between 3G\_MSCs. (This corresponds to 3G\_MSC-A as defined in TS 23.009 [2] and TS 29.002 [5]). The 3G\_MSC that is the 3G\_MSC-A will not be changed during the duration of a call/connection. + +3G\_MSC-T is the part relating to the transitory state during the relocation for the 3G\_MSC controlling the RNS the serving RNS functionality is relocated to, when basic relocation or subsequent relocation (see TS 23.009) take place. (This corresponds, depending on the type of relocation to 3G\_MSC-A, 3G\_MSC-B or 3G\_MSC-B' in TS 23.009 [2] and TS 29.002 [5]). + +3G\_MSC-I is the part of a 3G\_MSC through which the 3G\_MSC-A, via an E-interface (or an internal interface) is in contact with the UE. (This corresponds, depending on the type of relocation to 3G\_MSC-A, 3G\_MSC-B or 3G\_MSC-B' in TS 23.009 [2] and TS 29.002 [5]). + +The 3G\_MSC that is the 3G\_MSC-A can also have the role of either the 3G\_MSC-I or the 3G\_MSC-T during a period of the call/connection. + +The following is applicable for the involved 3G\_MSCs concerning the exchange of RANAP data on an E-interface before and after a successful inter 3G\_MSC relocation: + +- 1) At basic relocation, two 3G\_MSCs are involved, one 3G\_MSC being 3G\_MSC-A and one being 3G\_MSC-T. When this relocation has been performed, the two 3G\_MSCs interworking on the E-interface have the roles of 3G\_MSC-A and 3G\_MSC-I respectively, i.e. the 3G\_MSC that is the 3G\_MSC-T during the relocation is now the 3G\_MSC-I. +- 2) At subsequent relocation back to 3G\_MSC-A, two 3G\_MSCs are involved. The 3G\_MSC having the role of 3G\_MSC-A has also the role of 3G\_MSC-T. The other 3G\_MSC involved has the role of 3G\_MSC-I. When this relocation has been completed, there is no exchange of RANAP data on the E-interface, i.e. the 3G\_MSC being the 3G\_MSC-I before and during the relocation is now no longer taking part. + +- 3) At subsequent relocation of SRNS to an 3G\_MSC not being 3G\_MSC-A, three 3G\_MSCs are involved. The roles of these 3G\_MSCs are 3G\_MSC-A, 3G\_MSC-I, and 3G\_MSC-T respectively. When this relocation has been performed, the two 3G\_MSCs interworking on an E-interface have the roles of 3G\_MSC-A and 3G\_MSC-I respectively, i.e. the 3G\_MSC that is the 3G\_MSC-T during the relocation is now the 3G\_MSC-I and the 3G\_MSC being 3G\_MSC-I during the relocation is now no longer taking part. + +# --- 5 Use of the RANAP on the E-interface + +The dedicated RANAP procedures used on the E-interface to some extent are: + +- RAB assignment; +- RAB Release Request; +- Iu Release Request; +- Relocation resource allocation; +- Relocation Detect; +- Relocation Complete; +- Relocation Cancel; +- CN Invoke Trace; +- Security mode control; +- Location Reporting Control; +- Location Report; +- Direct Transfer; +- Error Indication; +- Common ID; +- Location Related Data; +- UE Specific Information; +- RAB Modification Request. + +## 5.1 RAB Assignment + +The RAB Assignment procedure (TS 25.413 [4] subclause 8.2) is applied on the E-interface with following conditions: + +- the 3G\_MSC-A acts as the 3G\_MSC; +- the 3G\_MSC-I acts as the RNS. + +The handling of terrestrial resources is not applicable, i.e. the RANAP IEs *Transport Layer Address* and *Iu Transport Association* will be assigned by the 3G\_MSC-I. + +## 5.2 RAB Release Request + +For the RAB Release Request procedure (TS 25.413 [4] subclauses 8.3) the involved 3G\_MSCs shall act according to the following: + +- the 3G\_MSC-I acts as the RNS; +- the 3G\_MSC-A acts as the 3G\_MSC. + +## 5.3 Iu Release Request + +For the Iu Release Request procedure (TS 25.413 [4] subclause 8.4) the involved 3G\_MSCs shall act according to the following: + +- the 3G\_MSC-I acts as the RNS; +- the 3G\_MSC-A acts as the 3G\_MSC. + +Additionally, at basic Inter-3G\_MSC relocation and at subsequent Inter-3G\_MSC relocation (TS 23.009 [2]), if the 3G\_MSC that is the 3G\_MSC-A is not also the 3G\_MSC-T, the Iu Release Request procedure (TS 25.413 [4] subclause 8.4) is applied on the E-interface with the following conditions: + +- the 3G\_MSC-T acts as the RNS; +- the 3G\_MSC-A acts as the 3G\_MSC. + +## 5.4 Relocation Resource Allocation + +At basic Inter-3G\_MSC relocation (TS 23.009 [2]) the Relocation Resource Allocation procedure (TS 25.413 [4] subclause 8.7) is applied on the E-interface with the following conditions: + +- the 3G\_MSC-A acts as the 3G\_MSC; +- the 3G\_MSC-T acts as the target RNS. + +At subsequent Inter-3G\_MSC relocation the Relocation Resource Allocation procedure is applied on the E-interface with the following conditions: + +- the 3G\_MSC-I acts as the 3G\_MSC; +- the 3G\_MSC-T acts as the target RNS; +- if the 3G\_MSC that is the 3G\_MSC-A is not also the 3G\_MSC-T, then this 3G\_MSC shall act as the target RNS towards the 3G\_MSC-I and as the 3G\_MSC towards the 3G\_MSC-T. + +The handling of terrestrial resources is not applicable, i.e. the RANAP IEs *Transport Layer Address* and *Iu Transport Association* will be assigned by the 3G\_MSC-T. + +In case NNSF is active, the *Iu Signalling Connection Identifier* IE and the *Global CN ID* IE shall be set by the 3G\_MSC-T towards Target RNC. + +## 5.5 Relocation Cancel + +For subsequent Inter-3G\_MSC relocation the Relocation Cancel procedure (TS 25.413 [4] subclause 8.10) is applied on the E-interface with the following conditions. + +- the 3G\_MSC-A, acts as the 3G\_MSC; +- the 3G\_MSC-I, acts as the serving RNS. + +## 5.6 Relocation Detect and Relocation Complete + +For the Relocation Detect and Relocation Complete procedure (TS 25.413 [4] subclauses 8.8 and 8.9) the applicable parts on the E-interface are the transfer of RELOCATION DETECT, RELOCATION COMPLETE messages at inter 3G\_MSC relocation. For those parts, the involved 3G\_MSCs shall act according to the following: + +- the 3G\_MSC-A acts as the 3G\_MSC; +- the 3G\_MSC-T acts as the target RNS. + +## 5.7 CN Trace invocation + +For the CN Trace invocation procedure (TS 25.413 [4], subclause 8.17), the involved 3G\_MSCs shall act according to the following: + +- the 3G\_MSC-A acts as the 3G\_MSC; +- the 3G\_MSC-I acts as the RNS. + +Additionally, at basic Inter-3G\_MSC relocation and at subsequent Inter-3G\_MSC relocation (TS 23.009 [2]), if the 3G\_MSC that is the 3G\_MSC-A is not also the 3G\_MSC-T, the CN Trace invocation procedure (TS 25.413 [4], subclause 8.17) is applied on the E-interface with the following conditions: + +- the 3G\_MSC-A acts as the 3G\_MSC; +- the 3G\_MSC-T acts as the RNS. + +## 5.8 Security mode control + +For the Security mode control procedure (TS 25.413 [4], subclause 8.18), the involved 3G\_MSCs shall act according to the following: + +- the 3G\_MSC-A acts as the 3G\_MSC; +- the 3G\_MSC-I acts as the RNS. + +## 5.9 Location Reporting Control + +For the Location Reporting Control procedure (TS 25.413 [4], subclause 8.19), the involved 3G\_MSCs shall act according to the following: + +- the 3G\_MSC-A acts as the 3G\_MSC; +- the 3G\_MSC-I acts as the RNS. + +Additionally, at basic Inter-3G\_MSC relocation and at subsequent Inter-3G\_MSC relocation (3GPP TS 23.009 [2]), if the 3G\_MSC that is the 3G\_MSC-A is not also the 3G\_MSC-T, the Location Reporting Control procedure (TS 25.413 [4] subclause 8.19) is applied on the E-interface with the following conditions: + +- the 3G\_MSC-A acts as the 3G\_MSC; +- the 3G\_MSC-T acts as the RNS. + +## 5.10 Location Report + +For the Location Report procedure (TS 25.413 [4], subclause 8.20), the involved 3G\_MSCs shall act according to the following: + +- the 3G\_MSC-A acts as the 3G\_MSC; +- the 3G\_MSC-I acts as the RNS. + +## 5.11 Direct Transfer + +For the Direct Transfer procedure (TS 25.413 [4], subclause 8.23), the involved 3G\_MSCs shall act according to the following: + +- the 3G\_MSC-A acts as the 3G\_MSC; +- the 3G\_MSC-I acts as the RNS. + +## 5.12 Error Indication + +For the Error Indication procedure (TS 25.413 [4], subclause 8.27), the involved 3G\_MSCs shall act according to the following: + +- the 3G\_MSC-A acts as the 3G\_MSC; +- the 3G\_MSC-I acts as the RNS. + +## 5.13 CN Deactivate Trace + +For the CN Deactivate Trace procedure procedure (TS 25.413 [4], subclause 8.28), the involved 3G\_MSCs shall act according to the following: + +- the 3G\_MSC-A acts as the 3G\_MSC; +- the 3G\_MSC-I acts as the RNS. + +## 5.14 Common ID + +For the Common ID procedure (TS 25.413 [4], subclause 8.16), the involved 3G MSCs shall act according to the following: + +- the 3G\_MSC-A acts as the 3G\_MSC; +- the 3G\_MSC-I acts as the RNS. + +## 5.15 Location Related Data + +For the Location Related Data procedure (TS 25.413 [4], subclause 8.31), the involved 3G\_MSCs shall act according to the following: + +- the 3G\_MSC-A acts as the 3G\_MSC; +- the 3G\_MSC-I acts as the RNS. + +## 5.16 UE Specific Information + +For the UE Specific Information procedure (TS 25.413 [4], subclause 8.33), the involved 3G MSCs shall act according to the following: + +- the 3G\_MSC-A acts as the 3G\_MSC; +- the 3G\_MSC-I acts as the RNS. + +## 5.17 RAB Modification Request + +For the RAB Modification Request procedure (TS 25.413 [4], subclause 8.30), the involved 3G MSCs shall act according to the following: + +- the 3G\_MSC-A acts as the 3G\_MSC; +- the 3G\_MSC-I acts as the RNS. + +# --- 6 RANAP messages transferred on the E-interface + +The list given below shows the RANAP messages, defined in TS 25.413 [4] subclause 9.1(tabular format) and 9.3 (ASN.1 notation) that are transferred on the E-interface. + +| | | +|-------------------------|------------------------| +| RAB ASSIGNMENT REQUEST | (3G_MSC-A -> 3G_MSC-I) | +| RAB ASSIGNMENT RESPONSE | (3G_MSC-I -> 3G_MSC-A) | + +| | | +|------------------------------------|-------------------------------------------------| +| RAB RELEASE REQUEST | (3G_MSC-I -> 3G_MSC-A) | +| IU RELEASE REQUEST | (3G_MSC-I -> 3G_MSC-A and 3G_MSC-T -> 3G_MSC-A) | +| * RELOCATION REQUEST | (3G_MSC-A -> 3G_MSC-T and 3G_MSC-I -> 3G_MSC-A) | +| * RELOCATION REQUEST ACKNOWLEDGE | (3G_MSC-T -> 3G_MSC-A and 3G_MSC-A -> 3G_MSC-I) | +| * RELOCATION DETECT | (3G_MSC-T -> 3G_MSC-A) | +| * RELOCATION COMPLETE | (3G_MSC-T -> 3G_MSC-A) | +| * RELOCATION FAILURE | (3G_MSC-T -> 3G_MSC-A and 3G_MSC-A -> 3G_MSC-I) | +| * RELOCATION CANCEL | (3G_MSC-I -> 3G_MSC-A) | +| * RELOCATION CANCEL ACKNOWLEDGE | (3G_MSC-A -> 3G_MSC-I) | +| # CN INVOKE TRACE | (3G_MSC-A -> 3G_MSC-I and 3G_MSC-A -> 3G_MSC-T) | +| SECURITY MODE COMMAND | (3G_MSC-A -> 3G_MSC-I) | +| SECURITY MODE COMPLETE | (3G_MSC-I -> 3G_MSC-A) | +| SECURITY MODE REJECT | (3G_MSC-I -> 3G_MSC-A) | +| LOCATION REPORTING CONTROL | (3G_MSC-A -> 3G_MSC-I and 3G_MSC-A -> 3G_MSC-T) | +| LOCATION REPORT | (3G_MSC-I -> 3G_MSC-A) | +| DIRECT TRANSFER | (3G_MSC-A -> 3G_MSC-I and 3G_MSC-I -> 3G_MSC-A) | +| ERROR INDICATION | (3G_MSC-A -> 3G_MSC-I and 3G_MSC-I -> 3G_MSC-A) | +| # CN DEACTIVATE TRACE | (3G_MSC-A -> 3G_MSC-I) | +| COMMON ID | (3G_MSC-A -> 3G_MSC-I) | +| LOCATION RELATED DATA REQUEST | (3G_MSC-A -> 3G_MSC-I) | +| LOCATION RELATED DATA RESPONSE | (3G_MSC-I -> 3G_MSC-A) | +| LOCATION RELATED DATA FAILURE | (3G_MSC-I -> 3G_MSC-A) | +| UE SPECIFIC INFORMATION INDICATION | (3G_MSC-A -> 3G_MSC-I) | +| RAB MODIFY REQUEST | (3G_MSC-I -> 3G_MSC-A) | + +All other RANAP messages shall be considered as non-existent on the E-interface. + +Some of the messages above are qualified by \* or #. This indicates whether the message, when sent on the E interface, is considered as: + +- relocation related message (\*); or +- trace related message (#). + +# --- 7 Exceptions for RANAP message contents and information element coding when transferred on the E-interface + +## 7.1 Message Contents + +For the applicable RANAP messages transferred on the E-interface the following exceptions to the descriptions in TS 25.413 [4] are valid: + +### RAB ASSIGNMENT REQUEST message + +- Transport Layer Address IE: + - if received, this IE shall be ignored; +- Iu Transport Association IE: + - if received, this IE shall be ignored; +- UP Mode Versions IE: + - the information given within this IE is only useful in case of TrFO. + +### RELOCATION REQUEST message + +- Transport Layer Address IE: + - if received, this IE shall be ignored; +- Iu Transport Association IE: + - if received, this IE shall be ignored; +- UP Mode Versions IE: + - the information given within this IE is only useful in case of TrFO; +- Iu Signalling Connection Identifier IE: + - if received, this IE shall be ignored; +- Global CN ID IE: + - if received, this IE shall be ignored. + +# --- 8 RANAP message error handling when transferred on the E-interface + +The RANAP error handling (TS 25.413 [4], clause 10) is applicable. The handling of faults concerning the use of SCCP is not applicable. + +The RANAP error messages sent on the E-interface shall only be sent as response to RANAP messages received on the same interface. + +# Annex A (informative): Change history + +| Change history | | | | | | +|----------------|---------|------------|-----------|-------------|--------------------------------------------------------| +| TSG RAN# | Version | CR | Tdoc RAN | New Version | Subject/Comment | +| RAN_08 | 2.0.0 | - | RP-000258 | 3.0.0 | Approved at TSG RAN #8 and placed under Change Control | +| RAN_10 | 3.0.0 | 001
002 | RP-000634 | 3.1.0 | Approved at TSG RAN #10 | + +| Change history | | | | | | | | +|----------------|-------|-----------|-----|-----|--------------------------------------------------------------------------|--------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 03/2001 | 11 | - | - | - | Approved at TSG RAN #11 and placed under Change Control | - | 4.0.0 | +| 09/2001 | 13 | RP-010590 | 004 | - | Iu Signalling Connection identifier on E-i/f | 4.0.0 | 4.1.0 | +| 03/2002 | 15 | - | - | - | Approved at TSG RAN #15 and placed under Change Control | 4.1.0 | 5.0.0 | +| 06/2002 | 16 | RP-020416 | 007 | - | Location Related Data procedure missing | 5.0.0 | 5.1.0 | +| 12/2002 | 18 | RP-020755 | 010 | 1 | Explicit indication of relocation related messages | 5.1.0 | 5.2.0 | +| 03/2003 | 19 | RP-030079 | 013 | 1 | Corrections to the list of RANAP messages transferred on the E-interface | 5.2.0 | 5.3.0 | +| 12/2003 | 22 | - | - | - | Introduction of Release 6 specification | 5.3.0 | 6.0.0 | +| 06/2004 | 24 | RP-040177 | 015 | - | PUESBINE support over E-interface | 6.0.0 | 6.1.0 | +| 03/2005 | 27 | RP-050120 | 017 | - | Full RANAP support of network initiated SCUDIF | 6.1.0 | 6.2.0 | +| 03/2006 | 31 | - | - | - | Introduction of Release 7 specification | 6.2.0 | 7.0.0 | +| 06/2003 | 32 | RP-060278 | 019 | - | Iu-Flex for Inter-3G MSC Relocation | 7.0.0 | 7.1.0 | +| 12/2008 | 42 | - | - | - | Upgrade to Release 8 without technical change | 7.1.0 | 8.0.0 | +| 12/2009 | - | - | - | - | Upgrade to Release 9 without technical change | 8.0.0 | 9.0.0 | +| 03/2011 | - | - | - | - | Upgrade to Release 10 without technical change | 9.0.0 | 10.0.0 | +| 06/2011 | 52 | RP-110684 | 020 | - | Corrections of References | 10.0.0 | 10.1.0 | +| 09/2012 | - | - | - | - | Update to Rel-11 version (MCC) | 10.1.0 | 11.0.0 | +| 09/2014 | - | - | - | - | Update to Rel-12 version (MCC) | 11.0.0 | 12.0.0 | +| 12/2015 | - | - | - | - | Update to Rel-13 version (MCC) | 12.0.0 | 13.0.0 | + +| Change history | | | | | | | | +|----------------|---------|------|----|-----|-----|--------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2017-03 | SA#75 | - | - | - | - | Promotion to Release 14 without technical change | 14.0.0 | +| 2018-07 | SA#80 | - | - | - | - | Promotion to Release 15 without technical change | 15.0.0 | +| 2020-07 | SA#88-e | - | - | - | - | Update to Rel-16 version (MCC) | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29109/1b5a812c8aa20fd5cba28e97001d32de_img.jpg b/marked/Rel-16/29_series/29109/1b5a812c8aa20fd5cba28e97001d32de_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5f414631d7167c3c7c7ee53a4bafce7b467a8454 --- /dev/null +++ b/marked/Rel-16/29_series/29109/1b5a812c8aa20fd5cba28e97001d32de_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d867cd64906959ed2c6733982edcb7f53b6ae56d726b89c8b25e3340c91cacf0 +size 96610 diff --git a/marked/Rel-16/29_series/29109/4cc7cdce3d498d8b0ba033a9be24ade5_img.jpg b/marked/Rel-16/29_series/29109/4cc7cdce3d498d8b0ba033a9be24ade5_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..39266067bb1c70f64c646ebd61e4633ce680b410 --- /dev/null +++ b/marked/Rel-16/29_series/29109/4cc7cdce3d498d8b0ba033a9be24ade5_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:dc0058da931c418e043ec176678177a9b93ddea13bbedfb3fb118d42eaac3580 +size 11134 diff --git a/marked/Rel-16/29_series/29109/5793a44ffdadd039928e2f9fe6daae06_img.jpg b/marked/Rel-16/29_series/29109/5793a44ffdadd039928e2f9fe6daae06_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..46fd1d4f886cf335c4020107db7facd80be7917f --- /dev/null +++ b/marked/Rel-16/29_series/29109/5793a44ffdadd039928e2f9fe6daae06_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d457b6f318177606e532248ad5f4ab0d8f4322672a44f10ea31299da605e21b8 +size 34713 diff --git a/marked/Rel-16/29_series/29109/5dfc130b129ace4df375839020a5700d_img.jpg b/marked/Rel-16/29_series/29109/5dfc130b129ace4df375839020a5700d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..cc3b05162e62879aa64e3dd50d478aad8b95717d --- /dev/null +++ b/marked/Rel-16/29_series/29109/5dfc130b129ace4df375839020a5700d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:87ceffa3a558289c81dbf9df571b964f9f10c291963c35f6cb3cbb276387bb98 +size 38807 diff --git a/marked/Rel-16/29_series/29109/608f1b5ef8f3dc0723f2b4ea1fb72be2_img.jpg b/marked/Rel-16/29_series/29109/608f1b5ef8f3dc0723f2b4ea1fb72be2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b06f04a27c07547b37c3393306a35294db48fc8e --- /dev/null +++ b/marked/Rel-16/29_series/29109/608f1b5ef8f3dc0723f2b4ea1fb72be2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:24b6aaecd9ac3945efb46e8c2cb9f3770b51dd2f964a7f40dca77e9edff81b73 +size 9062 diff --git a/marked/Rel-16/29_series/29109/6f31cdb576d2f15c35c3f266e5f59211_img.jpg b/marked/Rel-16/29_series/29109/6f31cdb576d2f15c35c3f266e5f59211_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0ca6a80abb06ed6e199a88f396d4e0f85777db97 --- /dev/null +++ b/marked/Rel-16/29_series/29109/6f31cdb576d2f15c35c3f266e5f59211_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8b64bf46816b524e86fef7ff52b1a6d905b85d048b82a3be5aaf5b11692351b5 +size 120866 diff --git a/marked/Rel-16/29_series/29109/7efae06af3af43ffe5d4b956a679cf54_img.jpg b/marked/Rel-16/29_series/29109/7efae06af3af43ffe5d4b956a679cf54_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2337bdb1900264c2fef20489e5ae81ff73abb7a8 --- /dev/null +++ b/marked/Rel-16/29_series/29109/7efae06af3af43ffe5d4b956a679cf54_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9519fffd6f241e3e0356e1070fba08f4a32e3d73387c83338bf0a0a75d21661f +size 86996 diff --git a/marked/Rel-16/29_series/29109/90ddb84c323b956e2d50a54d3f870566_img.jpg b/marked/Rel-16/29_series/29109/90ddb84c323b956e2d50a54d3f870566_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3d67b58404280a0282e98d9c8b01ab2957f1518f --- /dev/null +++ b/marked/Rel-16/29_series/29109/90ddb84c323b956e2d50a54d3f870566_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3322f4d4dd28c1c05ac5fb0006889f561a4777c65b661e681621346e811156e5 +size 106352 diff --git a/marked/Rel-16/29_series/29109/997233d405f0d4b89ddeb7683e047f66_img.jpg b/marked/Rel-16/29_series/29109/997233d405f0d4b89ddeb7683e047f66_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..07bd57b69731f791c63c99f1864ecf4c7717d2e0 --- /dev/null +++ b/marked/Rel-16/29_series/29109/997233d405f0d4b89ddeb7683e047f66_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1f185e4c6976da69a1d72e5774a3eb89cf8f969edd45366129e20f6ba0f9d11b +size 95883 diff --git a/marked/Rel-16/29_series/29109/9a159e2112eac7be06bdb97e84a0c49a_img.jpg b/marked/Rel-16/29_series/29109/9a159e2112eac7be06bdb97e84a0c49a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5f31f06cc66716ea4094180f9e200256930becdb --- /dev/null +++ b/marked/Rel-16/29_series/29109/9a159e2112eac7be06bdb97e84a0c49a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:00c13d3886a761c57ba7d60aeb220bdab02df1b113212911eecc96d5530f202d +size 75327 diff --git a/marked/Rel-16/29_series/29109/d0abac95583b52a3b35f74a215567334_img.jpg b/marked/Rel-16/29_series/29109/d0abac95583b52a3b35f74a215567334_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..05060b672c98558dd4c0c6c2c5ba3f7bc5160876 --- /dev/null +++ b/marked/Rel-16/29_series/29109/d0abac95583b52a3b35f74a215567334_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ad3b11a788b52090d6cf81e59a9cfe3a98ddfc59aa4adc615c4e7dbf6436223a +size 90937 diff --git a/marked/Rel-16/29_series/29109/ddc7460821484f1ae2835c67955c554c_img.jpg b/marked/Rel-16/29_series/29109/ddc7460821484f1ae2835c67955c554c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..02be253defa71671afa5a0de8f1d108172b603c2 --- /dev/null +++ b/marked/Rel-16/29_series/29109/ddc7460821484f1ae2835c67955c554c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:871b19d7d4fa0a7bc71faf4689119c1cf751184337400752d4d895056bd0351c +size 11115 diff --git a/marked/Rel-16/29_series/29109/e05b36c0d46549e681ce6581422c66b2_img.jpg b/marked/Rel-16/29_series/29109/e05b36c0d46549e681ce6581422c66b2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9f64c7fedb874935338ae9b3b4baf3b3265182d7 --- /dev/null +++ b/marked/Rel-16/29_series/29109/e05b36c0d46549e681ce6581422c66b2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3857a4a734d71f27aaa728ccab908e6fa36594a2765112a096cb08bc504154b6 +size 77131 diff --git a/marked/Rel-16/29_series/29109/e180f2b5fcbe8001554a7c0677cd3f82_img.jpg b/marked/Rel-16/29_series/29109/e180f2b5fcbe8001554a7c0677cd3f82_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1e5777e66166b558175f96c5a4141f11e71421cf --- /dev/null +++ b/marked/Rel-16/29_series/29109/e180f2b5fcbe8001554a7c0677cd3f82_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:94bbea7990a2d001f82bc26a5bb470907440b424f2cf8049b1826ec435976afc +size 41508 diff --git a/marked/Rel-16/29_series/29109/e9d825d87c5f85c8dba0664eace96ef4_img.jpg b/marked/Rel-16/29_series/29109/e9d825d87c5f85c8dba0664eace96ef4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c2d4eb163ecbf288df59298dde3913c63a5d5654 --- /dev/null +++ b/marked/Rel-16/29_series/29109/e9d825d87c5f85c8dba0664eace96ef4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:63126b2daa9cf3a22242393d3b1e2785b1fa6b7c7382817b8b101d57250e43e3 +size 14677 diff --git a/marked/Rel-16/29_series/29109/f6d72d7c790e7f585532140f3971639a_img.jpg b/marked/Rel-16/29_series/29109/f6d72d7c790e7f585532140f3971639a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..801ef061164b5b66fef37b9fd2ecf33075712929 --- /dev/null +++ b/marked/Rel-16/29_series/29109/f6d72d7c790e7f585532140f3971639a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a55e7ff7d11d1cad5f9caec530cbb31ecf7efa5d49947fb6d6823cc6aa848178 +size 61681 diff --git a/marked/Rel-16/29_series/29109/raw.md b/marked/Rel-16/29_series/29109/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..0fb250087e05498b6d10261520645fcfc438a9d9 --- /dev/null +++ b/marked/Rel-16/29_series/29109/raw.md @@ -0,0 +1,3517 @@ + + + + + + +# Contents + +| | | | +|----------|-------------------------------------------------------------------------|----| +| 1 | Scope..... | 5 | +| 2 | References..... | 9 | +| 3 | Definitions, symbols and abbreviations ..... | 11 | +| 3.1 | Definitions ..... | 11 | +| 3.2 | Symbols..... | 11 | +| 3.3 | Abbreviations ..... | 12 | +| 4 | GBA Bootstrapping Zh interface and Zh' interface ..... | 13 | +| 4.1 | Generic bootstrapping network architecture ..... | 13 | +| 4.2 | Protocol Zh between BSF and HSS ..... | 13 | +| 4.3 | Protocol Zh' between BSF and HLR..... | 18 | +| 4.3.1 | Public to Private Identity Resolution over Zh between BSF and HLR ..... | 19 | +| 5 | GAA Application Zn and Zpn interfaces..... | 21 | +| 5.1 | Applications' network architecture ..... | 21 | +| 5.2 | Protocol Zn between NAF and BSF based on Diameter..... | 22 | +| 5.3 | Protocol Zn between NAF and BSF based on Web Services ..... | 25 | +| 5.4 | Protocol Zpn between NAF and BSF based on Diameter..... | 28 | +| 5.5 | Protocol Zpn between NAF and BSF based on Web Services ..... | 32 | +| 6 | Diameter application for Zh, Zn and Zpn interfaces..... | 35 | +| 6.0 | Introduction ..... | 35 | +| 6.1 | Command-Code values ..... | 35 | +| 6.2 | Result-Code AVP values..... | 35 | +| 6.2.1 | Success ..... | 35 | +| 6.2.2 | Permanent failures ..... | 35 | +| 6.2.2.1 | DIAMETER_ERROR_IDENTITY_UNKNOWN (5401) ..... | 35 | +| 6.2.2.2 | DIAMETER_ERROR_NOT_AUTHORIZED (5402)..... | 36 | +| 6.2.2.3 | DIAMETER_ERROR_TRANSACTION_IDENTIFIER_INVALID (5403) ..... | 36 | +| 6.2.2.4 | Void ..... | 36 | +| 6.2.2.5 | Void ..... | 36 | +| 6.2.2.6 | Void ..... | 36 | +| 6.2.2.7 | Void ..... | 36 | +| 6.3 | AVPs ..... | 37 | +| 6.3.1 | Common AVPs..... | 38 | +| 6.3.1.1 | GBA-UserSecSettings AVP ..... | 38 | +| 6.3.1.2 | Transaction-Identifier AVP ..... | 38 | +| 6.3.1.3 | NAF-Id..... | 38 | +| 6.3.1.4 | GAA-Service-Identifier AVP ..... | 38 | +| 6.3.1.5 | Key-ExpiryTime AVP..... | 38 | +| 6.3.1.6 | ME-Key-Material AVP..... | 38 | +| 6.3.1.7 | UICC-Key-Material AVP ..... | 38 | +| 6.3.1.8 | GBA_U-Awareness-Indicator ..... | 38 | +| 6.3.1.9 | BootstrapInfoCreationTime AVP ..... | 39 | +| 6.3.1.10 | GUSS-Timestamp AVP..... | 39 | +| 6.3.1.11 | GBA-Type ..... | 39 | +| 6.3.1.12 | UE-Id ..... | 39 | +| 6.3.1.13 | UE-Id-Type ..... | 39 | +| 6.3.1.14 | UICC-App-Label ..... | 39 | +| 6.3.1.15 | UICC-ME..... | 39 | +| 6.3.1.16 | Requested-Key-Lifetime..... | 40 | +| 6.3.1.17 | Private-Identity-Request ..... | 40 | +| 6.3.1.18 | GBA-Push-Info ..... | 40 | +| 6.3.1.19 | NAF-SA-Identifier ..... | 40 | +| 6.3.1.20 | Security-Feature-Request..... | 40 | +| 6.3.1.21 | Security-Feature-Response ..... | 40 | +| 6.4 | User identity to HSS resolution..... | 40 | + +| | | | +|-------------------------------|-----------------------------------------------------------------|-----------| +| 7 | Use of namespaces..... | 42 | +| 7.1 | AVP codes..... | 42 | +| 7.2 | Experimental-Result-Code AVP values..... | 42 | +| 7.3 | Command Code values..... | 42 | +| Annex A (normative): | GBA-UserSecSettings XML definition..... | 43 | +| Annex B (normative): | GAA Service Type Codes ..... | 48 | +| Annex C (normative): | GAA Authorization flag codes ..... | 48 | +| Annex D (normative): | Web Services Definition for Zn interface..... | 49 | +| Annex E (informative): | Liberty authentication context definitions for GBA ..... | 50 | +| E.1 | Introduction..... | 50 | +| E.2 | GBA Authentication context statement data model..... | 50 | +| E.3 | GBA authentication context statement schema ..... | 51 | +| E.4 | GBA authentication context classes..... | 52 | +| E.4.1 | GBAOneFactorUnregistered..... | 52 | +| E.4.1.1 | Associated 3GPP URI ..... | 52 | +| E.4.1.2 | Class schema ..... | 53 | +| E.4.2 | GBATwoFactorUnregistered ..... | 53 | +| E.4.2.1 | Associated 3GPP URI ..... | 53 | +| E.4.2.2 | Class schema ..... | 53 | +| E.4.3 | GBAOneFactorContract..... | 54 | +| E.4.3.1 | Associated 3GPP URI ..... | 54 | +| E.4.3.2 | Class schema ..... | 54 | +| E.4.4 | GBATwoFactorContract..... | 55 | +| E.4.4.1 | Associated 3GPP URI ..... | 55 | +| E.4.4.2 | Class schema ..... | 55 | +| Annex F (informative): | SAML authentication context definitions for GBA ..... | 56 | +| F.1 | Introduction..... | 56 | +| F.2 | GBA authentication context declaration data model ..... | 56 | +| F.3 | GBA authentication context declaration types..... | 57 | +| F.4 | GBA authentication context declaration classes..... | 58 | +| F.4.1 | GBAOneFactorUnregistered..... | 58 | +| F.4.1.1 | Associated 3GPP URI ..... | 58 | +| F.4.1.2 | Class schema ..... | 58 | +| F.4.2 | GBATwoFactorUnregistered ..... | 61 | +| F.4.2.1 | Associated 3GPP URI ..... | 61 | +| F.4.2.2 | Class schema ..... | 61 | +| F.4.3 | GBAOneFactorContract..... | 63 | +| F.4.3.1 | Associated 3GPP URI ..... | 63 | +| F.4.3.2 | Class schema ..... | 63 | +| F.4.4 | GBATwoFactorContract..... | 65 | +| F.4.4.1 | Associated 3GPP URI ..... | 65 | +| F.4.4.2 | Class schema ..... | 65 | +| Annex G (normative): | Web Services Definition for Zpn interface ..... | 68 | +| Annex H (informative): | Change history..... | 69 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 1 Scope + +The present stage 3 specification defines the Diameter based implementation for bootstrapping Zh interface (BSF-HSS) and Dz interface (BSF-SLF) for HSS resolution for the BSF, the MAP based implementation for bootstrapping Zh' interface (BSF-HLR) and GAA Application Zn interface (BSF-NAF) in Generic Authentication Architecture (GAA). This specification also defines the Web Services based implementation for GAA Application Zn reference point (BSF-NAF). The definition contains procedures, message contents and coding. The procedures for bootstrapping and usage of bootstrapped security association are defined in 3GPP TS 33.220 [5]. + +The present document also specifies the Diameter and Web Services based implementation for the GAA Application Push Function Zpn reference point (BSF-NAF). The procedures for bootstrapping are defined in 3GPP TS 33.223 [23]. + +This specification is a part of the Generic Authentication Architecture (GAA) specification series. + +The diameter based implementation for the Zh interface is based on re-usage of Cx interface Multimedia-Auth-Request/Answer messages originally between CSCF and HSS. These messages are defined in 3GPP TS 29.229 [3]. The 3GPP IMS mobility management uses the same definitions between CSCF and HSS. The present document defines how the defined messages are used with the bootstrapping and GAA application procedures (e.g. subscriber certificates) and the application logic that is needed in GAA network elements (BSF, HSS, and NAF). + +Figure 1.1 depicts the relationships of these specifications to the other specifications for the Diameter based implementations. + +![Diagram showing the relationships between various specifications for Diameter-based implementations, categorized by 3GPP and IETF standards.](f6d72d7c790e7f585532140f3971639a_img.jpg) + +| | | | | +|----------------|--------------------------------------------------|---------|------------------| +| 3GPP | GAA System Description TR 33.919 | Stage 2 | IMS TS 23.228 | +| | GAA GBA TS 33.220
GBA Push Function TS 33.223 | | IMS MM TS 29.228 | +| | GAA Zh, Zn and Zpn TS 29.109 | Stage 3 | | +| IETF with 3GPP | IMS Cx Diameter message definitions TS 29.229 | | | +| IETF | Diameter Base Protocol RFC 3588 | | | +| | SCTP | | | +| | IP | | | + +Diagram showing the relationships between various specifications for Diameter-based implementations, categorized by 3GPP and IETF standards. + +**Figure 1.1: Relationships to other specifications** + +Figure 1.2 provides an informal overall quick introduction to the whole signalling procedures in GAA system. The important identifiers are marked **bold** and optional data items are *italicised*. The Ub and Ua interfaces, not defined in this TS, are simplified. + +NOTE: The Zh' interface (BSF-HLR) is not represented in this figure. + +![Diagram of the whole signalling procedure in GAA system. The diagram is divided into two domains: GAA Security Domain (top, green background) and GAA Application Domain (bottom, blue background). Entities involved are SLF, BSF, UE, HSS, and NAF (containing Auth.Proxy and Appl.Spec. Servers). The procedure consists of 9 steps: (1) UE sends IMPI to BSF via Ub; (2) BSF sends IMPI to SLF via Dz; (3) SLF sends AV, IMPI, and GUSS(USS*(UID*)) to BSF via Zh; (4) BSF sends B-TID and Key-Lifetime to UE via Ub; (5) UE sends B-TID and UID to NAF via Ua; (6) NAF sends B-TID, GSID*, and NAF-Id to BSF via Zn; (7) BSF sends USS*(UID*), Ks_(ext)_NAF, Key-Expirytime, BootstrapInfoCreationTime, Ks_int_NAF, and IMPI to HSS via Zn; (8) NAF sends a response to UE via Ua; (9) HSS sends Sh, GUP, etc. to NAF if needed via Ua.](997233d405f0d4b89ddeb7683e047f66_img.jpg) + +The diagram illustrates the signalling procedure in the GAA system, organized into two domains: the GAA Security Domain (top) and the GAA Application Domain (bottom). The entities involved are the UE (User Equipment), BSF (Bootstrap Function), SLF (SLF Function), HSS (Home Subscriber Server), and NAF (Network Application Function), which contains an Auth.Proxy and Appl.Spec. Servers. + +The procedure consists of the following steps: + +- (1) The UE sends an **IMPI** to the BSF via the **Ub** interface. +- (2) The BSF sends an **IMPI** to the SLF via the **Dz** interface. +- (3) The SLF sends an **AV**, **IMPI**, and **GUSS(USS\*(UID\*))** to the BSF via the **Zh** interface. +- (4) The BSF sends a **B-TID** and **Key-Lifetime** to the UE via the **Ub** interface. +- (5) The UE sends a **B-TID** and **UID** to the NAF via the **Ua** interface. +- (6) The NAF sends a **B-TID**, **GSID\***, and **NAF-Id** to the BSF via the **Zn** interface. +- (7) The BSF sends **USS\*(UID\*)**, **Ks\_(ext)\_NAF**, **Key-Expirytime**, **BootstrapInfoCreationTime**, **Ks\_int\_NAF**, and **IMPI** to the HSS via the **Zn** interface. +- (8) The NAF sends a response to the UE via the **Ua** interface. +- (9) if needed: **Sh**, **GUP**, etc. are sent from the HSS to the NAF via the **Ua** interface. + +**Bold**=Important Identity. *Italic*=optional items. Ub and Ua interfaces are simplified. + +Diagram of the whole signalling procedure in GAA system. The diagram is divided into two domains: GAA Security Domain (top, green background) and GAA Application Domain (bottom, blue background). Entities involved are SLF, BSF, UE, HSS, and NAF (containing Auth.Proxy and Appl.Spec. Servers). The procedure consists of 9 steps: (1) UE sends IMPI to BSF via Ub; (2) BSF sends IMPI to SLF via Dz; (3) SLF sends AV, IMPI, and GUSS(USS\*(UID\*)) to BSF via Zh; (4) BSF sends B-TID and Key-Lifetime to UE via Ub; (5) UE sends B-TID and UID to NAF via Ua; (6) NAF sends B-TID, GSID\*, and NAF-Id to BSF via Zn; (7) BSF sends USS\*(UID\*), Ks\_(ext)\_NAF, Key-Expirytime, BootstrapInfoCreationTime, Ks\_int\_NAF, and IMPI to HSS via Zn; (8) NAF sends a response to UE via Ua; (9) HSS sends Sh, GUP, etc. to NAF if needed via Ua. + +**Figure 1.2: The whole signalling procedure in GAA system** + +Figure 1.3 provides an informal overall quick introduction to the whole signalling procedures in GAA Push Function. The important identifiers are marked bold and optional data items are italicised. The Ua and Upa interfaces, not defined in this TS, are simplified. + +![Signalling procedure in GAA Bootstrapping Push Function diagram showing interactions between UE, SLF, BSF, HSS, and NAF across GAA Security and Application domains.](d0abac95583b52a3b35f74a215567334_img.jpg) + +The diagram illustrates the signalling procedure for GAA Bootstrapping Push Function across two domains: **GAA Security Domain** (top, green background) and **GAA Application Domain** (bottom, light blue background). + +**Entities:** + +- UE (User Equipment):** Located in the GAA Application Domain. +- SLF (Subscription Locator Function):** Located in the GAA Security Domain. +- BSF (Bootstrap Function):** Located in the GAA Security Domain. +- HSS (Home Subscriber Server):** Located in the GAA Security Domain. +- NAF (Network Application Function):** Located in the GAA Application Domain, connected to **Appl.Spec. Servers**. + +**Signalling Steps and Interfaces:** + +- (1)** UE to NAF: **UE-Id (Type)**, **P-TID**, **GSID\***, **NAF-Id**. +- (2)** BSF to HSS: **IMPI/IMPU**. +- (3)** HSS to BSF: **Zh** interface, carrying *AV, IMPI*, *GUSS(USS\*(UID\*))*. +- (4)** BSF to NAF: **Zpn** interface, carrying **GPI**, *USS\*(UID\*)*, **Ks\_(ext)\_NAF**, Key-Expirytime, BootstrapInfoCreationTime, *Ks\_int\_NAF*, **IMPI**. +- (5)** NAF to UE: **Upa** interface, carrying **GPI**. + +**Other Interfaces:** + +- Dz**: Interface between SLF and BSF, carrying **IMPI/IMPU**. + +Signalling procedure in GAA Bootstrapping Push Function diagram showing interactions between UE, SLF, BSF, HSS, and NAF across GAA Security and Application domains. + +**Bold**=Important Identity. *Italic*=optional items. Ub and Ua interfaces are simplified. + +**Figure 1.3: Signalling procedure in GAA Bootstrapping Push Function** + +# 2 References + +The following documents contain provisions that, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. +- [1] Void. +- [2] 3GPP TS 29.228: "IP Multimedia (IM) Subsystem Cx and Dx Interfaces; Signalling flows and message contents". +- [3] 3GPP TS 29.229: "Cx and Dx interfaces based on the Diameter protocol". +- [4] 3GPP TR 33.919 "Generic Authentication Architecture (GAA); System Description". +- [5] 3GPP TS 33.220 "Generic Authentication Architecture (GAA); Generic Bootstrapping Architecture". +- [6] 3GPP TS 33.221 "Generic Authentication Architecture (GAA); Support for Subscriber Certificates". +- [7] 3GPP TS 24.109: "Bootstrapping interface (Ub) and Network application function interface (Ua);Protocol details". +- [8] 3GPP TS 29.230: "Diameter applications; 3GPP specific codes and identifiers" +- [9] IETF RFC 3589: "Diameter Command Codes for Third Generation Partnership Project (3GPP)". +- [10] 3GPP TS 23.008: "Organisation of subscriber data" +- [11] 3GPP TS 33.222: "Generic Authentication Architecture (GAA); Access to network application functions using secure hypertext transfer protocol (HTTPS)". +- [12] 3GPP TS 23.228: "IP Multimedia Subsystem (IMS); Stage 2" +- [13] W3C: "Web Services Activity", . +- [14] W3C: "Web Services Description Language (WSDL) Version 2.0 Part 0: Primer", . +- [15] 3GPP TR 33.980: "Liberty Alliance and 3GPP Security Interworking; Interworking of Liberty Alliance ID-FF, ID-WSF and Generic Authentication Architecture". +- [16] Liberty Alliance Project: "Liberty ID-FF Authentication Context Specification". +- [17] 3GPP TS 33.110: "Key establishment between a Universal Integrated Circuit Card (UICC) and a terminal" +- [18] 3GPP TS 33.259: "Key establishment between a UICC Hosting Device and a Remote Device" +- [19] 3GPP TS 29.002: "Mobile Application Part (MAP) Specification" +- [20] 3GPP TS 33.102: "3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; 3G Security; Security architecture". +- [21] 3GPP TS 23.003: "Numbering, addressing and identification". +- [22] OASIS Standard: "Authentication Context for the OASIS Security Assertion Markup Language (SAML) V2.0 OASIS Standard, 15 March 2005, saml-authn-context-2.0-os". + +- [23] 3GPP TS 33.223 "Generic Authentication Architecture (GAA); Generic Bootstrapping Architecture (GBA) Push Function". +- [24] 3GPP TS 33.402: "3GPP System Architecture Evolution (SAE); Security aspects of non-3GPP accesses". +- [25] Void +- [26] 3GPP TS 26.237: "IP Multimedia Subsystem (IMS) based Packet Switched Streaming (PSS) Multimedia Broadcast/Multicast Services (MBMS); User Service; Protocols". +- [27] Void +- [28] Void +- [29] 3GPP TR 33.924: "Identity Management and 3GPP Security Interworking; Identity Management and Generic Authentication Architecture (GAA) Interworking". +- [30] 3GPP TS 33.224: "Generic Authentication Architecture (GAA); Generic Push Layer". +- [31] 3GPP TS 33.203: "Access security for IP-based services". +- [32] 3GPP TS 29.329: " Sh Interface based on the Diameter protocol; Protocol details". +- [33] IETF RFC 6733: "Diameter Base Protocol". + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TS 23.008 [10], 3GPP TR 33.919 [4], 3GPP TS 33.220 [5] apply with following additions. + +**Bootstrapping information** (Bootstrapped data) in a BSF consists of a bootstrapping transaction identifier (B-TID), a key material (Ks), the key lifetime (expiry time), the bootstrapinfo creation time, the IMPI and the GUSS (if received from HSS) with BSF control information. Each bootstrapping procedure creates a bootstrapped data entity with B-TID as retrieval key.. + +**GAA application** is an application that uses the security association created by GBA Bootstrapping procedure. + +**GAA service** is an operator specific end user service that uses the security association created by GAA Bootstrapping procedure. GAA services are identified by **GAA Service Identifiers**. A GAA service is implemented using some standardised or proprietary GAA application defined by GAA application type. + +**NAF specific Bootstrapping information** transferred from a BSF to a NAF contains NAF and its service specific parts from bootstrapped data and needed key information derived from the bootstrapped data. + +**Service/Application.** The term service is used here in its common meaning. A service is something that a MNO offers to subscribers. GAA Services are identified by GAA Service Identifier (GSID). In stage 2 documents ([4], [5], [6] and [11]) the term application is used in the same meaning i.e. MNOs offer applications to subscribers. There is a reason to avoid the usage of the term application here. The application is an already reserved term in Diameter. In Diameter applications are identified by Application Identifiers. + +## 3.2 Symbols + +For the purposes of the present document, the terms and definitions given in 3GPP TS 23.008 [10]. + +## 3.3 Abbreviations + +For the purposes of the present document, the following abbreviations apply: + +| | | +|------------|------------------------------------------------------------------------------------------------------------------------------------| +| AK | Anonymity Key | +| AKA | Authentication and Key Agreement | +| AUTN | Authentication token | +| AV | Authentication Vector. 3GPP AV=[RAND,AUTN,XRES,CK,IK]. | +| AVP | Attribute-Value-Pair in Diameter messages. | +| BIA | BootstrappingInfo-Answer message | +| BIR | BootstrappingInfo-Request message | +| BS | BootStrapping Procedure | +| BSF | Bootstrapping server functionality
BSF is hosted in a network element under the control of an MNO. | +| B-TID | Bootstrapping Transaction Identifier | +| CA | Certificate Authority | +| CK | Confidential Key | +| FQDN | Full Qualified Domain Name in URI (e.g. http://FQDN:80 ) | +| GAA | Generic Authentication Architecture | +| GBA | Generic Bootstrapping Architecture | +| GPI | GBA Push Information | +| GSID | GAA Service Identifier | +| GUSS | GBA User Security Settings | +| HSS | Home Subscriber System | +| IK | Integrity Key | +| IMPI | IP Multimedia Private Identity | +| IMPU | IP Multimedia Public Identity | +| Ks | Key Material | +| Ks_ext_NAF | MEbased key for a specific NAF | +| Ks_int_NAF | UICC based key for a specific NAF | +| ME | Mobile Equipment | +| MNO | Mobile network operator | +| NAF | Operator-controlled network application function functionality.
NAF is hosted in a network element under the control of an MNO. | +| P-TID | Push Temporary Identifier | +| RAND | Random challenge in authentication | +| REQ | In Diameter header indicates that the message is a Request. | +| SCTP | Stream Control Transmission Protocol | +| SLF | Subscription Location Function | +| SSC | Subscriber Certificate Procedure | +| Ua | UE-NAF interface for GAA applications | +| Ub | UE-BSF interface for bootstrapping | +| UE | User Equipment | +| USS | User Security Settings (a part of GUSS) | +| XRES | Expected response in authentication | +| Zh | BSF-HSS interface for bootstrapping procedure | +| Zh' | BSF-HLR interface for bootstrapping procedure | +| Zn | BSF-NAF interface for GAA applications | +| Zpn | BSF-NAF interface for GBA push. | + +# 4 GBA Bootstrapping Zh interface and Zh' interface + +## 4.1 Generic bootstrapping network architecture + +The network architecture of the Diameter based implementation for Bootstrapping procedure is presented in Figure 4.1-1. The interface Ub (bootstrapping) is defined in 3GPP TS 24.109 [7] and the interface Zh in this specification. + +![Figure 4.1-1: Network architecture of bootstrapping procedure. A diagram showing three entities: UE, BSF, and HSS. UE is connected to BSF via the Ub interface. BSF is connected to HSS via the Zh interface.](ddc7460821484f1ae2835c67955c554c_img.jpg) + +``` + +graph LR + UE[UE] -- Ub --> BSF[BSF] + BSF -- Zh --> HSS[HSS] + +``` + +Figure 4.1-1: Network architecture of bootstrapping procedure. A diagram showing three entities: UE, BSF, and HSS. UE is connected to BSF via the Ub interface. BSF is connected to HSS via the Zh interface. + +**Figure 4.1-1: Network architecture of bootstrapping procedure** + +The generic bootstrapping network architecture for Bootstrapping Push procedures is presented in Figure 4.1-2. The interface Zpn is also defined in this specification. + +![Figure 4.1-2: Network architecture of bootstrapping push procedure. A diagram showing four entities: UE, NAF, BSF, and HSS. UE is connected to NAF via the Upa interface. NAF is connected to BSF via the Zpn interface. BSF is connected to HSS via the Zh interface.](e9d825d87c5f85c8dba0664eace96ef4_img.jpg) + +``` + +graph LR + UE[UE] -- Upa --> NAF[NAF] + NAF -- Zpn --> BSF[BSF] + BSF -- Zh --> HSS[HSS] + +``` + +Figure 4.1-2: Network architecture of bootstrapping push procedure. A diagram showing four entities: UE, NAF, BSF, and HSS. UE is connected to NAF via the Upa interface. NAF is connected to BSF via the Zpn interface. BSF is connected to HSS via the Zh interface. + +**Figure 4.1-2: Network architecture of bootstrapping push procedure** + +The protocol stack of the Zh interface in Bootstrapping procedure is presented in Figure 4.2. The Diameter Base protocol is defined in IETF RFC 6733 [33] and the Diameter application in 3GPP TS 29.229 [3]. The requirements for Zh interface are defined in 3GPP TS 33.220 [5] and 3GPP TS 33.223 [23]. + +![Figure 4.2: Protocol stack of Zh interface. A diagram showing the protocol stacks for BSF and HSS. Both stacks consist of Zh application logic, Diameter application, Diameter Base Protocol, SCTP, and IP. The stacks are connected by the Zh interface.](5dfc130b129ace4df375839020a5700d_img.jpg) + +| BSF | HSS | +|-----------------------------|-----------------------------| +| Zh application logic in BSF | Zh application logic in HSS | +| Diameter application | Diameter application | +| Diameter Base Protocol | Diameter Base Protocol | +| SCTP | SCTP | +| IP | IP | + +The two IP layers are connected by the Zh interface. + +Figure 4.2: Protocol stack of Zh interface. A diagram showing the protocol stacks for BSF and HSS. Both stacks consist of Zh application logic, Diameter application, Diameter Base Protocol, SCTP, and IP. The stacks are connected by the Zh interface. + +**Figure 4.2: Protocol stack of Zh interface** + +The MAP based Bootstrapping Zh' interface is defined in the section 4.3. + +## 4.2 Protocol Zh between BSF and HSS + +The requirements for Zh interface are defined in 3GPP TS 33.220 [5] and 3GPP TS 33.223 [23]. + +The Bootstrapping Zh interface performs the retrieval of an authentication vector and possibly GBA User Security Settings from the HSS. + +The overall Bootstrapping procedure is depicted in Figure 4.3. The basic procedure is: + +- A UE starts the bootstrapping procedure by protocol Ub with a BSF giving the IMPI of the user (see 3GPP TS 24.109 [7]). +- The BSF starts protocol Zh with user's HSS + +- The BSF requests user's authentication vector and GBA User Security Settings (GUSS) corresponding to the IMPI. If the authentication scheme is to use SIP Digest credentials, the BSF shall indicate this in the request. +- The HSS supplies to the BSF the requested authentication vector and GUSS (if applicable, cf. 3GPP TS 33.220 [5]). The HSS supplies the requested authentication vector relating to SIP Digest only if explicitly indicated in the request. + +NOTE 1: If there is more than one HSS deployed within the network, the BSF may have to contact the SLF using the Dz interface prior to sending the request for information to the HSS (see section 6.4). + +C) The BSF continues the protocol Ub with the UE (see 3GPP TS 24.109 [7]). + +![Sequence diagram of the GBA bootstrapping procedure between UE, BSF, and HSS.](1b5a812c8aa20fd5cba28e97001d32de_img.jpg) + +``` + +sequenceDiagram + participant UE + participant BSF + participant HSS + + Note over UE, BSF: Ub + Note over BSF, HSS: Zh + + Note left of UE: If non-IMS subriber, +generates IMPI from IMSI + UE->>BSF: Bootstrapping-Request (IMPI) + BSF->>HSS: 1. Multimedia-Auth-Request ( IMPI ) + Note right of HSS: 2. HSS derives +Authentication data and +fetches GUSS for IMPI. + HSS->>BSF: 3. Multimedia-Auth-Answer +(Authentication data, +GAA-UserSecSettings) + Note left of BSF: 4. BSF stores bootstrapping +information tuple for IMPI. + BSF->>UE: Bootstrapping-Answer +(realm,nonce,algorithm) + Note over UE, BSF: The rest of the Boostrapping procedure + +``` + +The diagram illustrates the GBA bootstrapping procedure involving three main entities: UE (User Equipment), BSF (Bootstrap Server), and HSS (Home Subscriber Server). The sequence of messages is as follows: + + +- The UE sends a **Bootstrapping-Request (IMPI)** to the BSF over the **Ub** interface. A note indicates that if the UE is a non-IMS subriber, it generates the IMPI from the IMSI. +- The BSF sends a **1. Multimedia-Auth-Request ( IMPI )** to the HSS over the **Zh** interface. +- The HSS performs an internal step: **2. HSS derives Authentication data and fetches GUSS for IMPI.** +- The HSS sends a **3. Multimedia-Auth-Answer (Authentication data, GAA-UserSecSettings)** back to the BSF over the **Zh** interface. +- The BSF performs an internal step: **4. BSF stores bootstrapping information tuple for IMPI.** +- The BSF sends a **Bootstrapping-Answer (realm,nonce,algorithm)** back to the UE over the **Ub** interface. +- A final note indicates: **The rest of the Boostrapping procedure**. + +Sequence diagram of the GBA bootstrapping procedure between UE, BSF, and HSS. + +Figure 4.3: The GBA bootstrapping procedure + +The overall Bootstrapping Push procedure is depicted in Figure 4.4. The Push procedure shall not apply with an authentication scheme using SIP Digest credentials. The Push procedure is: + +A) A NAF sends a bootstrapping push request to the BSF via Zpn interface including the IMPI or IMPU of the user (see section 5). + +B) The BSF starts protocol Zh with user's HSS + +- The BSF requests user's authentication vector and GBA User Security Settings (GUSS) corresponding to the IMPI or IMPU. +- The HSS supplies to the BSF the requested authentication vector and GUSS (if any). + +NOTE 2: If there is more than one HSS deployed within the network, the BSF may have to contact the SLF using the Dz interface prior to sending the request for information to the HSS (see section 6.4). + +C) The BSF continues the protocol Zpn with the NAF (see section 5). + +D) The NAF starts protocol Upa with the UE, as specified in 3GPP TS 24.109 [7]. + +![Sequence diagram of the GBA bootstrapping Push procedure. Lifelines: UE, NAF, BSF, HSS. The process starts with NAF sending a 'Generate GPI Request' to BSF. BSF sends a 'GPI-Request (IMPI or IMPU, NAF-Id)' to HSS. HSS sends '1. Multimedia-Auth-Request (IMPI or IMPU)' to BSF. BSF sends '2. HSS generates AV and fetches GUSS for IMPI.' to HSS. HSS sends '3. Multimedia-Auth-Answer (RAND, AUTN, XRES, CK, IK, GAA-UserSecSettings)' to BSF. BSF sends '4. BSF generates GPI' to NAF. NAF sends 'GPI-Response (GPI)' to BSF. BSF sends 'GPI Push' to UE.](7efae06af3af43ffe5d4b956a679cf54_img.jpg) + +``` + +sequenceDiagram + participant UE + participant NAF + participant BSF + participant HSS + Note right of NAF: Generate GPI Request + NAF->>BSF: GPI-Request (IMPI or IMPU, NAF-Id) + BSF->>HSS: 1. Multimedia-Auth-Request (IMPI or IMPU) + HSS->>BSF: 2. HSS generates AV and fetches GUSS for IMPI. + BSF->>HSS: 3. Multimedia-Auth-Answer (RAND, AUTN, XRES, CK, IK, GAA-UserSecSettings) + BSF->>NAF: 4. BSF generates GPI + NAF->>BSF: GPI-Response (GPI) + BSF->>UE: GPI Push + +``` + +Sequence diagram of the GBA bootstrapping Push procedure. Lifelines: UE, NAF, BSF, HSS. The process starts with NAF sending a 'Generate GPI Request' to BSF. BSF sends a 'GPI-Request (IMPI or IMPU, NAF-Id)' to HSS. HSS sends '1. Multimedia-Auth-Request (IMPI or IMPU)' to BSF. BSF sends '2. HSS generates AV and fetches GUSS for IMPI.' to HSS. HSS sends '3. Multimedia-Auth-Answer (RAND, AUTN, XRES, CK, IK, GAA-UserSecSettings)' to BSF. BSF sends '4. BSF generates GPI' to NAF. NAF sends 'GPI-Response (GPI)' to BSF. BSF sends 'GPI Push' to UE. + +**Figure 4.4: The GBA bootstrapping Push procedure** + +The steps of the bootstrapping procedure over Zh reference point in Figure 4.3 and Figure 4.4 are: + +### Step 1 + +The BSF shall send the following Bootstrapping-Request to the HSS in the format of Multimedia-Auth-Request (MAR) message. The content of the message is given below in the same format as in 3GPP TS 29.229 [3]. The curly brackets indicate mandatory AVPs. The square brackets indicate optional AVPs. The "address of" refers to the Fully Qualified Host Name (FQDN). + +``` + + ::= + < Session-Id > + { Vendor-Specific-Application-Id } + { Auth-Session-State } ; NO_STATE_MAINTAINED + { Origin-Host } ; Address of BSF + { Origin-Realm } ; Realm of BSF + { Destination-Realm } ; Realm of HSS + [ Destination-Host ] ; Address of the HSS + [ User-Name ] ; IMPI from UE + [ Public-Identity ] ; IMPU from UE + [ SIP-Auth-Data-Item ] ; Authentication Scheme, + ; Synchronization Failure + [ GUSS-Timestamp ] ; Timestamp of GUSS in BSF + *[ AVP ] + *[ Proxy-Info ] + *[ Route-Record ] + +``` + +The content of mandatory Vendor-Specific-Application-ID according to IETF RFC 6733 [33] is: + +``` + + ::= + 1* [Vendor-Id] ; 3GPP is 10415 + 0*1 {Auth-Application-Id} ; 16777221 + 0*1 {Acct-Application-Id} ; Omitted + +``` + +When determining the value of Destination-Host AVP the BSF can use redirector function (SLF) to resolve the address of the HSS if needed (see 3GPP TS 29.229 [3]). The BSF shall set the Auth-Session-State AVP to NO\_STATE\_MAINTAINED to inform that the HSS does not need to maintain any status information for this session according 3GPP TS 29.229 [3]. + +The User-name is the IMS Private User Identity (IMPI) as defined in 3GPP TS 29.228 [2]. In bootstrapping push procedures, either the Public-Identity AVP or the User-Name AVP shall be present in the request, depending on the user identity provided by the NAF. For all other bootstrapping procedures, only the User-Name AVP shall be present. If the identity received from the NAF is an MSISDN, the BSF shall include this MSISDN in the form of a tel URI in the Public-Identity AVP (see 3GPP TS 29.229 [2]). + +If the BSF supports the GUSS timestamp mechanism and has local copy of the GUSS, which has a timestamp, the BSF may include the GUSS-Timestamp AVP. In this case the GUSS-Timestamp AVP shall contain the timestamp from subscriber's GUSS. Otherwise the GUSS-Timestamp AVP shall not be present. + +The SIP-Auth-Data-Item AVP, when present, shall indicate the authentication scheme chosen, i.e SIP Digest when applicable. By default, when the SIP-Auth-Data-Item AVP is not present, the authentication scheme is Digest-AKA v1-MD5. The SIP-Auth-Data-Item AVP should not be present to indicate the authentication scheme is Digest-AKA v1-MD5. + +NOTE 3: A pre-Rel-11 HSS only received SIP-Auth-Data-Item AVP in Zh MAR in case of synchronization failure for IMS-AKA. Apart from that, when SIP-Auth-Data-Item AVP was not present, it implied that the authentication scheme was Digest-AKA v1-MD5. Therefore, if SIP-Auth-Data-Item AVP is not present, it means that the authentication scheme is Digest-AKA v1-MD5, like before Rel-11. Moreover, in order to avoid interoperability problems between a pre-Rel-11 HSS and a Rel-11 (or later) BSF, the BSF should not include the SIP-Auth-Data-Item AVP to indicate the authentication scheme is Digest-AKA v1-MD5. + +If the Authentication Request is triggered by a synchronization failure (see 3GPP TS 24.109 [7]), the BSF shall include the SIP-Auth-Data-Item AVP within the MAR message according to 3GPP TS 29.228 [2]. + +### Step 2 + +When the HSS receives the MAR message, the HSS shall derive the user Authentication Vector (AV) information according the IMPI and, if present, the authentication scheme and populates it into SIP-Auth-Data-Item AVP as defined for IMS-AKA or SIP Digest authentication schemes in 3GPP TS 29.229 [3]. Only one AV shall be provided. + +If the Public User Identity is received, the HSS shall resolve to the corresponding IMPI/IMSI associated to such IMPU/MSISDN before deriving the AV information. If Public to Private identity resolution is not possible i.e. due to the IMPU is shared with multiple IMPIs, the HSS shall set the Experimental-Result-Code to DIAMETER\_ERROR\_OPERATION\_NOT\_ALLOWED (see 3GPP TS 29.329 [32]). + +If the request indicates that there is a synchronization failure, the HSS shall process AUTS as described in 3GPP TS 33.203 [31] and return the requested authentication information. The Result-Code shall be set to DIAMETER\_SUCCESS. + +If GUSS exists for the IMPI, the HSS shall do one of the following: + +- 1) If the HSS supports the GUSS timestamp mechanism and received the GUSS-Timestamp AVP in MAR message then it shall compare the timestamp of the GUSS in the HSS with the received timestamp. + - If timestamps are equal, then it shall populate the GBA-UserSecSettings AVP with static string "GUSS TIMESTAMP EQUAL". + - If the GUSS-Timestamp AVP was not received, or timestamps are not equal, then it shall populate the GBA-UserSecSettings AVP with the GUSS. +2. If the HSS does not support GUSS timestamp mechanism, it shall populate the GBA-UserSecSettings AVP with the GUSS. + +The MAR/MAA sequence in the Zh interface must not change possible status information of the possible simultaneously ongoing IMS MM application sessions in the HSS. + +If the User-Name (IMPI) or Public-Identity (IMPU) from the BSF is totally unknown to the HSS, the error situation 5401 is raised. + +Exceptions to the cases specified here shall be treated by HSS as error situations. The Result-Code shall be set to DIAMETER\_UNABLE\_TO\_COMPLY and no authentication or GUSS information shall be returned. + +### Step 3 + +The HSS shall send the following Bootstrapping-Answer message in the format of Multimedia-Auth-Answer (MAA) message back to the BSF. + +``` +< Multimedia-Auth-Answer> ::= < Diameter Header: 303, PXY, 16777221 > + < Session-Id > + { Vendor-Specific-Application-Id } + [ Result-Code ] + [ Experimental-Result ] + { Auth-Session-State } ; NO_STATE_MAINTAINED + { Origin-Host } ; Address of HSS + { Origin-Realm } ; Realm of HSS + [ User-Name ] ; IMPI + [ Public-Identity ] ; IMPU + [ SIP-Auth-Data-Item ] + [ GBA-UserSecSettings ] ; GUSS + *[ AVP ] + *[ Proxy-Info ] + *[ Route-Record ] +``` + +The HSS shall set the mandatory Auth-Session-State AVP to NO\_STATE\_MAINTAINED because the HSS does not maintain any state information about this session and the BSF does not need to send any session termination request 3GPP TS 29.229 [3]. + +If the Public-Identity was present in the request, both Public-Identity and User-Name AVPs shall be present in the response. Otherwise, the User-name AVP (IMPI) may be sent back for checking. + +The required authentication vector data is sent in the SIP-Auth-Data-Items AVP as defined for IMS-AKA or SIP Digest authentication schemes according to 3GPP TS 29.228 [2]. The security settings of user's all GAA applications are sent in GBA-UserSecSettings AVP. + +If the 2G GBA option (see 3GPP TS 33.220, Annex I [5]) is applied for the user the SIP-Auth-Data-Item AVP shall be filled as follows: The SIP-Authentication-Scheme AVP is set to "Digest-AKA-v1-MD5-2G-GBA" to indicate a 2G GBA vector for GBA. The SIP-Authenticate AVP contains only RAND. The SIP-Authorization AVP contains RES. The Confidentiality-Key AVP contains Kc. The Integrity-Key AVP shall not be present. If a 2G Authentication Vector is requested for the user but the 2G GBA option is not supported by the HSS, the HSS shall set the Experimental-Result-Code to DIAMETER\_AUTHENTICATION\_SCHEME\_NOT\_SUPPORTED (see 3GPP TS 29.228 [2]). + +### Step 4 + +When the BSF receives the MAA message, the BSF shall check the value of the SIP-Authentication-Scheme AVP. If the BSF does not support the authentication-scheme the BSF shall stop processing the message and should indicate an error via the O&M subsystem. + +The BSF generates the needed key material (Ks) as described in 3GPP TS 33.220 [5] and stores temporarily the tuple for further use in GAA applications. The rest of the bootstrapping procedure in Ub interface will later add also the Bootstrapping Transaction Identifier (B-TID) to that tuple as key and the key lifetime (expiry time). + +If the BSF sent the GUSS-Timestamp AVP in step 1, and if the GBA-UserSecSettings AVP contains a static string "GUSS TIMESTAMP EQUAL", then the local copy of the GUSS in the BSF shall be preserved. If the GBA-UserSecSettings AVP was not present in the MAA message, the local copy of the GUSS shall be deleted. If the GBA-UserSecSettings AVP contains a new GUSS, the local copy of the GUSS shall be deleted, and the new GUSS shall be stored in the BSF. + +In GBA Bootstrapping Push procedures, the BSF generates the requested NAF-key(s) according to provided NAF\_Id and the GBA Push Information (GPI). The BSF completes the rest of the bootstrapping push procedure sending its response to the NAF over Zpn interface, and deleting the Ks used as defined in section 5. + +## 4.3 Protocol Zh' between BSF and HLR + +The requirements for Zh' reference point are the same with the one for the Zh reference point defined in 3GPP TS 33.220 [5], except that the GBA User Security Settings (GUSS) are not supported. + +The Bootstrapping Zh' interface performs the retrieval of an authentication vector. The basic procedure is: + +- A) A UE starts the bootstrapping procedure by protocol Ub with a BSF giving the IMPI of the user (see 3GPP TS 24.109 [7]). In bootstrapping push procedures a NAF initiates a GBA Push Information Request by protocol Zpn with the BSF giving the user identity (see section 5). The BSF derives the IMSI from the IMPI. In bootstrapping push procedures when only the Public Identity of the user is made available to the BSF, the BSF shall perform public to private identity resolution as defined in section 4.3.1. +- B) The BSF starts protocol Zh' with user's HLR + - The BSF requests user's authentication vector corresponding to the IMSI. + - The HLR supplies to the BSF the requested authentication vector. +- C) The BSF continues the protocol Ub with the UE (see 3GPP TS 24.109 [7]). + +The BSF shall use the following Bootstrapping-Request to the HLR in the format of a MAP\_SEND\_AUTHENTICATION\_INFO. The content of the request, result and error messages is given below in the same format as in 3GPP TS 29.002 [19]. The parameter usage is as follows: + +### IMSI + +See 3GPP TS 29.002 [19] section 7.6.2 for the use of this parameter. + +#### Number of requested vectors + +The BSF shall only request one authentication vector at a time. + +### Requesting node type + +BSF + +### Re-synchronisation Info + +For definition and use of this parameter see 3GPP TS 33.102 [20]. + +### Segmentation prohibited indicator + +This parameter is not applicable and should not be sent by the BSF. + +### Immediate response preferred indicator + +This parameter indicates that one of the requested authentication vectors is requested for immediate use in the BSF. + +### Requesting PLMN ID + +The PLMN-ID of the requesting node. See 3GPP TS 23.003 [21]. + +### AuthenticationSetList + +One authentication vector is transferred from the HLR to the BSF, if the outcome of the service was successful. + +### User error + +One of the following error causes defined in 3GPP TS 29.002 [19] shall be sent by the user in case of unsuccessful outcome of the service, depending on the respective failure reason: + +- unknown subscriber; +- unexpected data value; +- system failure; + +- data missing. + +### Provider error + +See 3GPP TS 29.002 [19] for the use of this parameter. + +When the BSF receives the response of the MAP\_SEND\_AUTHENTICATION\_INFO service, then it shall generate the needed key material (Ks) from confidential key (CK) and integrity key (IK) as described in 3GPP TS 33.220 [5], respectively from Kc as described in 3GPP TS 33.220 [5] and stores temporarily the tuple for further use in GAA/GBA applications. The rest of the bootstrapping procedure in Ub interface will later add also the Bootstrapping Transaction Identifier (B-TID) to that tuple as key and the key lifetime (expiry time). + +### 4.3.1 Public to Private Identity Resolution over Zh between BSF and HLR + +When the UE identity used by the NAF in a GPI Request towards the BSF is an MSISDN, the BSF shall resolve the corresponding private user identity (IMSI) for the user. + +When Zh interface between BSF and HLR is used, the BSF shall resolve the private user identity with the HLR in the format of a MAP\_SEND\_IMSI or a MAP\_SEND\_ROUTING\_INFO\_FOR\_SM. + +The content of the request, result and error messages is given below in the same format as in 3GPP TS 29.002 [19]. The parameter usage when the MAP\_SEND\_IMSI operation is used is as follows: + +#### MSISDN + +See 3GPP TS 29.002 [19] section 7.6.2 for the use of this parameter. + +#### IMSI + +See 3GPP TS 29.002 [19] section 7.6.2 for the use of this parameter. The presence of this parameter is mandatory in a successful case. + +#### User error + +Only one of the following values is applicable: + +- Unknown subscriber; +- Unexpected data value; +- Data missing. + +The parameter usage when the MAP\_SEND\_ROUTING\_INFO\_FOR\_SM operation is used is as follows: + +#### MSISDN + +See 3GPP TS 29.002 [19] section 7.6.2 for the use of this parameter. + +#### SM-RP-PRI + +BSF shall set this parameter to indicate that delivery of the short message shall NOT be attempted when a service centre address is already contained in the Message Waiting Data file. + +#### Service Centre Address + +BSF shall include the BSF address within this parameter. + +#### SM-RP-MTI + +#### SM-RP-SMEA + +#### GPRS Support Indicator + +BSF shall not use these parameters in the public to private identity resolution request. + +#### SM-Delivery Not Intended + +BSF shall set this parameter to indicate that delivery of a short message is not intended and that only IMSI is requested. + +#### IMSI + +See 3GPP TS 29.002 [19] section 7.6.2 for the use of this parameter. The presence of this parameter is mandatory in a successful case. + +#### Network Node Number + +#### LMSI + +#### GPRS Node Indicator + +#### Additional Number + +BSF ignores these parameters if present in the public to private identity resolution response. + +#### User error + +One of the following error causes defined in 3GPP TS 29.002 [19] shall be sent by the user in case of unsuccessful outcome of the service, depending on the respective failure reason: + +- Unknown subscriber; +- Call Barred; +- Teleservice Not Provisioned; +- Absent Subscriber\_SM; +- Facility Not Supported; +- System failure; +- Unexpected Data Value; +- Data missing. + +#### Provider error + +See 3GPP TS 29.002 [19] for the use of this parameter. + +When the HLR is able to resolve the private identity of the user, the BSF continues with the bootstrapping procedures over Zh and requests a user's authentication vector corresponding to the IMSI as defined above. Otherwise the BSF provides the corresponding error to the NAF over Zpn as defined in section 5. + +# 5 GAA Application Zn and Zpn interfaces + +## 5.1 Applications' network architecture + +The network architecture of the GAA applications procedure using Zn is presented in Figure 5.1-1. The 3GPP GAA applications are listed in annex B. Different GAA applications may implement the Ua interface in different way. The Zn interface is defined in this specification. + +![Figure 5.1-1: Network architecture of GAA application using Zn. The diagram shows three yellow rectangular boxes labeled UE, NAF, and BSF connected in a horizontal line. The UE box is connected to the NAF box by a line labeled 'Ua'. The NAF box is connected to the BSF box by a line labeled 'Zn'.](4cc7cdce3d498d8b0ba033a9be24ade5_img.jpg) + +``` +graph LR; UE[UE] -- Ua --> NAF[NAF]; NAF -- Zn --> BSF[BSF]; +``` + +Figure 5.1-1: Network architecture of GAA application using Zn. The diagram shows three yellow rectangular boxes labeled UE, NAF, and BSF connected in a horizontal line. The UE box is connected to the NAF box by a line labeled 'Ua'. The NAF box is connected to the BSF box by a line labeled 'Zn'. + +**Figure 5.1-1: Network architecture of GAA application using Zn** + +The network architecture of GBA push procedure using Zpn is presented in Figure 5.1-2. The Zpn interface is also defined in this specification. + +![Figure 5.1-2: Network architecture of GBA push procedure using Zpn. The diagram shows three yellow rectangular boxes labeled UE, NAF, and BSF connected in a horizontal line. The UE box is connected to the NAF box by a line labeled 'Upa'. The NAF box is connected to the BSF box by a line labeled 'Zpn'.](608f1b5ef8f3dc0723f2b4ea1fb72be2_img.jpg) + +``` +graph LR; UE[UE] -- Upa --> NAF[NAF]; NAF -- Zpn --> BSF[BSF]; +``` + +Figure 5.1-2: Network architecture of GBA push procedure using Zpn. The diagram shows three yellow rectangular boxes labeled UE, NAF, and BSF connected in a horizontal line. The UE box is connected to the NAF box by a line labeled 'Upa'. The NAF box is connected to the BSF box by a line labeled 'Zpn'. + +**Figure 5.1-2: Network architecture of GBA push procedure using Zpn** + +Two options are specified for the protocol stack to be used on the Zn and Zpn interface: + +- The protocol stack of the DIAMETER based Zn interface, +- the protocol stack of the Web Services based Zn interface. + +The BSF shall support both options whereas the NAF shall support one or both of these options. + +The protocol stack of the Diameter based implementation of the Zn interface for GAA applications and Zpn interface for GBA push procedure is presented in Figure 5.2-1. The Zn interface is specified in clause 5.2. The Zpn interface is specified in clause 5.4. The Diameter base protocol is defined in IETF RFC 6733 [33] and the Diameter application in 3GPP TS 29.229 [3]. The requirements for Zn interface are defined in 3GPP TS 33.220 [5]. The requirements for Zpn interface are defined in 3GPP TS 33.223 [23]. + +![Figure 5.2-1: Protocol stack of Diameter based Zn and Zpn interfaces. The diagram shows two protocol stacks for NAF and BSF connected by a Zn/Zpn interface. Both stacks consist of five layers: Zn/Zpn application logic (top, yellow), Diameter application (light blue), Diameter Base (light blue), SCT (white), and IP (bottom, white). The Zn/Zpn interface is represented by a horizontal line connecting the IP layers of both stacks.](e180f2b5fcbe8001554a7c0677cd3f82_img.jpg) + +Figure 5.2-1: Protocol stack of Diameter based Zn and Zpn interfaces. The diagram shows two protocol stacks for NAF and BSF connected by a Zn/Zpn interface. Both stacks consist of five layers: Zn/Zpn application logic (top, yellow), Diameter application (light blue), Diameter Base (light blue), SCT (white), and IP (bottom, white). The Zn/Zpn interface is represented by a horizontal line connecting the IP layers of both stacks. + +**Figure 5.2-1: Protocol stack of Diameter based Zn and Zpn interfaces** + +The protocol stack of the Web Services based Zn interface for GAA applications and Zpn interface for GBA push procedure is presented in Figure 5.2-2. The Zn interface is specified in clause 5.3. The Zpn interface is specified in clause 5.5. + +![Figure 5.2-2: Protocol stack of Web Services based Zn interface. The diagram shows two protocol stacks for NAF and BSF connected by a Zn/Zpn interface. Both stacks consist of five layers: Zn/Zpn application logic (top, yellow), SOAP (light blue), HTTP (light blue), TCP (white), and IP (bottom, white). The Zn/Zpn interface is represented by a horizontal line connecting the IP layers of both stacks.](5793a44ffdadd039928e2f9fe6daae06_img.jpg) + +Figure 5.2-2: Protocol stack of Web Services based Zn interface. The diagram shows two protocol stacks for NAF and BSF connected by a Zn/Zpn interface. Both stacks consist of five layers: Zn/Zpn application logic (top, yellow), SOAP (light blue), HTTP (light blue), TCP (white), and IP (bottom, white). The Zn/Zpn interface is represented by a horizontal line connecting the IP layers of both stacks. + +**Figure 5.2-2: Protocol stack of Web Services based Zn interface** + +## 5.2 Protocol Zn between NAF and BSF based on Diameter + +The requirements for Zn interface are defined in 3GPP TS 33.220 [5]. + +The protocol Zn retrieves the key material and possibly user security settings data by NAF from BSF. After UE is authenticated with the BSF, every time the UE wants to interact with an NAF the following steps are executed as depicted in Figure 5.3. The basic procedure is: + +A) The UE starts protocol Ua (see 3GPP TS 33.220 [5]) + +- In general, the UE and the NAF will not yet share the key(s) required to protect protocol Ua. If they already do, there is no need for the NAF to invoke protocol Zn. +- It is assumed that UE supplies sufficient information to NAF, i.e. the Bootstrapping Transaction Identifier (B-TID), to allow the NAF to retrieve specific key material (e.g. Ks\_NAF in the case of GBA\_ME, and Ks\_ext\_NAF or Ks\_int\_NAF or both in the case of GBA\_U) from BSF. +- The UE derives the keys required to protect protocol Ua from the key material. + +B) The NAF starts protocol Zn with BSF + +- The NAF requests NAF specific key material corresponding to the information supplied by the UE to the NAF (i.e. the bootstrapping transaction identifier) in the start of protocol Ua. +- The BSF generates and supplies to the NAF the requested NAF specific key material, the expiry time, the bootstrapinfo creation time, and the appropriate User Security Settings defined for received application identifiers. + +C) The NAF continues protocol Ua with the UE (see 3GPP TS 33.221 [6]) + +Once the run of protocol Ua is completed the purpose of bootstrapping is fulfilled as it enabled UE and NAF to run protocol Ua in a secure way. + +The common GAA application procedure is presented in Figure 5.3. + +![Sequence diagram of the Diameter based GAA application procedure showing interactions between UE, NAF, and BSF.](6f31cdb576d2f15c35c3f266e5f59211_img.jpg) + +The diagram illustrates the Diameter based GAA application procedure involving three main entities: UE (User Equipment), NAF (Network Application Function), and BSF (Bootstrap Server Function). The UE and NAF are connected via the Ua interface, and the NAF and BSF are connected via the Zn interface. + +Initial state: The UE knows . The NAF has a security association created by bootstrapping. The BSF has a tuple: . GUSS is GBA User Security Settings. GSID is GAA Service Identifier. + +The procedure steps are: + +- The UE starts the GAA application procedure by sending a B-TID to the NAF. +- The NAF sends a **1. Bootstrapping-Info-Request ( B-TID, GSID\*, NAF-Id)** to the BSF. +- The BSF checks the B-TID and derives ME-Key and UICC-Key. +- The BSF sends a **3. Bootstrapping-Info-Answer ( IMPI, Key-ExpiryTime, Ks\_(ext)\_NAF, Ks\_int\_NAF, BootstrapInfoCreationTime, UserSecSetting\* )** to the NAF. +- Finally, the UE and NAF mutually authenticate each other using ME-Ks. + +Sequence diagram of the Diameter based GAA application procedure showing interactions between UE, NAF, and BSF. + +Figure 5.3: The Diameter based GAA application procedure + +The steps of the GAA application procedure in Figure 5.3 are: + +Step 1 + +The NAF shall send a Bootstrapping-Info-Request message (BIR) to the BSF. The content of the message is given here in the same format as in 3GPP TS 29.229 [3]. The curly brackets indicate mandatory AVPs. The square brackets indicate optional AVP. The address refers to the Fully Qualified Host Name (FQDN). + +``` + +< Bootstrapping-Info-Request> ::= < Diameter Header: 310, REQ, PXY, 16777220 > + < Session-Id > + { Vendor-Specific-Application-Id } + [ Auth-Session-State ] ; NO_STATE_MAINTAINED + { Origin-Host } ; Address of NAF + { Origin-Realm } ; Realm of NAF + { Destination-Realm } ; Realm of BSF + [ Destination-Host ] ; Address of the BSF + * [ GAA-Service-Identifier ] ; Service identifiers + { Transaction-Identifier } ; B-TID + { NAF-Id } ; NAF_ID + [ GBA_U-Awareness-Indicator ] ; GBA_U awareness of the NAF + * [ AVP ] + * [ Proxy-Info ] + * [ Route-Record ] + +``` + +The content of Vendor-Specific-Application-ID according IETF RFC 6733 [33] is: + +``` + + ::= + 1* [Vendor-Id] ; 3GPP is 10415 + 0*1 {Auth-Application-Id} ; 16777220 + 0*1 {Acct-Application-Id} ; Omitted + +``` + +The NAF should set the Auth-Session-State AVP to NO\_STATE\_MAINTAINED to inform that the BSF does not need to maintain any session state information for this session according 3GPP TS 29.229 [3]. + +The Destination-Realm AVP is set to subscriber's BSF. The address of the BSF is extracted from the B-TID. + +NOTE: In the case where the subscriber has contacted a NAF that is in a visited network, the NAF contacts the subscriber's home BSF through a Diameter based Proxy (Zn-Proxy) that is located in the same network as the NAF. The local BSF and the Zn-Proxy may be co-located. See 3GPP TS 33.220 [6]. + +The NAF indicates the GAA services for which the information is retrieved by GAA-Service-Identifier AVPs. The Bootstrapping Transaction Identifier defines the earlier bootstrapping procedure execution. + +### Step 2 + +In the successful case the BSF has a tuple identified by Bootstrapping Transaction Identifier (B-TID). When the BSF receives the request it checks the existence and validity of the tuple for given B-TID. If checking fails the BSF sends an Answer message with Experimental-Result set to indicate the error type 5403. If the tuple for B-TID exists, but is expired, error type 5403 is also sent to indicate needs for renewal of the bootstrapping procedure. In successful case the Result-Code is set to 2xxx as defined in IETF RFC 6733 [33]. + +The BSF derives the key material for the ME (i.e., Ks\_NAF in the case of GBA\_ME, and Ks\_ext\_NAF in the case of GBA\_U) and possibly the key material for the UICC (i.e., Ks\_int\_NAF in the case of GBA\_U) according to the B-TID and packs them into ME-Key-Material AVP and possible UICC-Key-Material AVP. The ME-Key-Material contains Ks\_(ext)\_NAF and the UICC-key-Material contains the Ks\_int\_NAF key. The BSF select correct user's Security Settings according the request's GAA-Service-Identifier AVP to GBA-UserSecSettings AVP. If NAF grouping is used by the operator and there are one or more USSs corresponding to the requested GSID, then also the nafGroup attribute of USS is checked. If the NAF has sent a GAA-Service-Identifier that does not have corresponding user's security settings, and the BSF is locally configured to reject those requests from the NAF, then the error 5402 is raised. If the NAF has sent a GAA-Service-Identifier that have corresponding user's security settings, but the BSF is locally configured to reject those from that NAF, then the error 5402 is raised too. + +The NAF may be addressed from the UE with different FQDNs. The BSF shall check if this NAF-Id is allowed to be used for the NAF. If the NAF identified by its Origin-Host AVP is configured in the BSF not to be authorized to use the given NAF-Id, the BSF may raise the error situation 5402. The BSF may also be configured so that a certain NAF is not authorized to use a certain GAA-Service-Identifier. This situation may be also indicated by error code 5402. + +Exceptions to the cases specified here shall be treated by BSF as error situations. The Result-Code shall be set to DIAMETER\_UNABLE\_TO\_COMPLY. + +### Step 3 + +After that the BSF shall send a Bootstrapping-Info-Answer message (BIA) back to the NAF. + +``` +< Boostrapping-Info-Answer> ::= < Diameter Header: 310, PXY, 16777220 > + < Session-Id > + { Vendor-Specific-Application-Id } + [ Result-Code ] + [ Experimental-Result ] + [ Auth-Session-State ] ; NO_STATE_MAINTAINED + { Origin-Host } ; Address of BSF + { Origin-Realm } ; Realm of BSF + [ User-Name ] ; IMPI + [ ME-Key-Material ] ; Required + [ UICC-Key-Material ] ; Conditional + [ Key-ExpiryTime ] ; Time of expiry + [ BootstrapInfoCreationTime ] ; Bootstrapinfo creation time + [ GBA-UserSecSettings ] ; Selected USSS + [ GBA-Type ] ; GBA type used in bootstrapping + *[ AVP ] + *[ Proxy-Info ] + *[ Route-Record ] +``` + +The BSF shall set the Auth-Session-State AVP to NO\_STATE\_MAINTAINED because the BSF does not maintain any session state information about this session and the NAF does not need to send any session termination request 3GPP TS 29.229 [3]. + +The BSF may or may not send the User-name AVP (IMPI) according its configuration. + +The mandatory common key material with the ME (Ks\_NAF or Ks\_ext\_NAF) is sent in the ME-Key-Material AVP. The common key material with the UICC (Ks\_int\_NAF) is optionally sent in the UICC-Key-Material AVP only if the "uiccType" tag in bsfInfo from the HSS is set to "GBA\_U". + +The Key-ExpiryTime AVP contains the expiry time of the Bootstrapping information in the BSF according its configuration. The expiry time is represented according the Diameter Time data format in seconds that have passed since 0h on January 1, 1900 UTC . If a special key lifetime value is given in the "lifeTime" tag inside the bsfInfo from the HSS in bootstrapping procedure, it is used instead of the BSF default configuration value when the expiry time is calculated. + +The BootstrapInfoCreationTime AVP contains the bootstrapinfo creation time, i.e., creation time of the Bootstrapping information in the BSF. The bootstrapinfo creation time is represented in seconds that have passed since January 1, 1900 00:00:00.000 UTC. + +The BSF selects the appropriate User Security Settings (if any) to the GBA-UserSecSettings AVP from stored GAA-UserSecSettings in Bootstrapping information according the GBA-Service-Identifier AVPs in the request message. + +The BSF shall indicate the type of used authentication in the bootstrapping procedure to the NAF in GBA-Type, if other than 3G GBA type has been performed. + +When the NAF receives the BIA message, the NAF shall check the value of the GBA-Type AVP if it is included in the message. If the NAF does not support the GBA-Type the NAF shall stop processing the message and should indicate an error via the O&M subsystem. The further procedure in the NAF when the BIA is received is described in 3GPP TS 33.220 [5], 3GPP TS 33.222 [11] and optionally in GAA service type specific TSs. + +## 5.3 Protocol Zn between NAF and BSF based on Web Services + +The procedures in the NAF and in the BSF related Web Services [13] based Zn interface are the same as specified in clause 5.2, but instead of Diameter messages a Web Services procedures shall be used to communicate over Zn interface. Annex D specifies the GBA Service for Web Services, i.e., it contains the Web Services Definition Language (WSDL) [14] specification for GBA Service. Below are the attributes that are defined for GBA Service request, response, and fault cases. + +![Sequence diagram of the Web Services based GAA application procedure. Lifelines: UE, NAF, BSF. UE knows . NAF has a security association created by bootstrapping. BSF has a tuple . UE starts GAA application by sending B-TID. NAF sends requestBootstrappingInfoRequest to BSF. BSF checks B-TID and derives ME-Key and UICC-Key. BSF sends requestBootstrappingInfoResponse to NAF. UE and NAF mutually authenticate using ME-Ks.](90ddb84c323b956e2d50a54d3f870566_img.jpg) + +``` + +sequenceDiagram + participant UE + participant NAF + participant BSF + + Note left of UE: UE knows: + Note right of NAF: { a security association created by bootstrapping } + Note right of BSF: BSF has tuple: + + UE->>NAF: UE start the GAA application procedure by sending a B-TID. + Note right of NAF: 1. requestBootstrappingInfoRequest ( b-tid, nafid, gsid*, gbaUAware, extension ) + NAF->>BSF: 1. requestBootstrappingInfoRequest + Note right of BSF: 2. BSF checks the B-TID and derives ME-Key and UICC-Key + BSF->>NAF: 3. requestBootstrappingInfoResponse ( impi, meKeyMaterial, uiccKeyMaterial, keyExpiryTime, bootstrappingInfoCreationTime, gbaType, ussList, extension ) + Note right of NAF: UE and NAF mutually authenticate each others using ME-Ks + +``` + +Sequence diagram of the Web Services based GAA application procedure. Lifelines: UE, NAF, BSF. UE knows . NAF has a security association created by bootstrapping. BSF has a tuple . UE starts GAA application by sending B-TID. NAF sends requestBootstrappingInfoRequest to BSF. BSF checks B-TID and derives ME-Key and UICC-Key. BSF sends requestBootstrappingInfoResponse to NAF. UE and NAF mutually authenticate using ME-Ks. + +**Figure 5.4: The Web Services based GAA application procedure** + +The possible attribute value definitions and restrictions for the request, response, and fault messages are the same as in clause 6 unless explicitly specified in this clause. The steps of the GAA application procedure in Figure 5.4 are: + +### Step 1 + +The NAF shall send a "requestBootstrappingInfoRequest" message to the BSF. The WSDL schema of this message is included in Annex D. + +Following elements are included into this message: + +- "btid" + +This is B-TID and defines the earlier bootstrapping procedure execution. Description in subclause 6.3.1.2 applies. + +- "nafid" + +This is the NAF-Id. Description in subclause 6.3.1.3 applies. + +- "gsid" + +This element contains the GAA Services Identifiers. Description in subclause 6.3.1.4 applies while the GAA Service Type Codes for 3GPP standardized services are defined in Annex B. + +- "gbaUAware" + +This element is optionally included. It indicates whether NAF is GBA\_U aware, and is capable of using and handling the "uiccKeyMaterial". The default value for "gbaUAware" is false. Description and values defined for the corresponding Diameter AVP in subclause 6.3.1.8 apply. + +The NAF may use one or more "extension" elements to include additional data to the request, but the BSF may ignore the additional data. + +This SOAP message shall be sent to BSF, then the URI of the message shall contain the BSF address extracted from "btid". In the case where the subscriber has contacted a NAF that is in a visited network, the + +NAF contacts the subscriber's home BSF through a GBA-Proxy that is located in the same network as the NAF. The local BSF and the GBA-Proxy may be co-located. See 3GPP TS 33.220 [6]. + +### Step 2 + +The procedures for step 2 are the same as in step 2 in clause 5.2. + +If any of the error situations described in step 2 in clause 5.2 arises, the BSF shall respond with a "requestBootstrappingInfoFault" message, as defined in Annex D. The "errorCode" element shall contain the corresponding Diameter error code (see clause 6.2.2). If the "errorText" is included, it shall contain a human-readable description of the error. + +### Step 3 + +After that, "requestBootstrappingInfoResponse" message is sent back to the NAF. The WSDL schema of this message is included in Annex D. + +Following elements are included into this message: + +- "impi" + +This element is optionally included according to BSF configuration. Description for User-Name AVP from 3GPP TS 29.229 [3] applies. + +- "meKeyMaterial" + +It includes the mandatory common key material with the ME (Ks\_NAF or Ks\_ext\_NAF). Description in subclause 6.3.1.6 applies. + +- "uiccKeyMaterial" + +This element is the common key material with the UICC (Ks\_int\_NAF). It is optionally sent only if the "uiccType" tag in "bsfInfo" (received by BSF from the HSS over Zh) is set to "GBA\_U". Description in subclause 6.3.1.7 applies. + +- "keyExpiryTime" + +It contains the expiry time of the Bootstrapping information in the BSF according its configuration. If a special key lifetime value is given in the "lifeTime" tag inside the "bsfInfo" (received by BSF from the HSS over Zh) in bootstrapping procedure, it shall be used instead of the BSF default configuration value when the expiry time is calculated. Description in subclause 6.3.1.5 applies. + +- "bootstrappingInfoCreationTime" + +This element contains the bootstrapinfo creation time, i.e., creation time of the Bootstrapping information in the BSF. Description in subclause 6.3.1.9 applies. + +- "gbaType" + +This element indicates the type of used authentication in the bootstrapping procedure to the NAF in "gbaType" element. It shall be included if other than 3G GBA type has been performed. Description and values defined for the corresponding Diameter AVP in subclause 6.3.1.11 apply. + +- "ussList" + +This element is optionally included. The BSF shall select the appropriate User Security Settings (if any) into the "ussList" element from stored GAA-UserSecSettings in Bootstrapping information according "gsid" elements in the request message. The "ussList" element contains a standalone XML document whose root element shall be "ussList" element as specified in Annex A and which contains the User Security Settings selected by the BSF. Description in subclause 6.3.1.1 applies. + +The BSF may use one or more "extension" elements to include additional data to the request, but the NAF may ignore the additional data. + +When the NAF receives the "requestBootstrappingInfoResponse" message, the NAF shall check the value of the "gbaType" element if it is included in the message. If the NAF does not support the GBA type the NAF + +shall stop processing the message and should indicate an error via the O&M subsystem. The further procedure in the NAF when the requestBootstrappingInfoResponse message is received is described in 3GPP TS 33.220 [5], 3GPP TS 33.222 [11] and optionally in GAA service type specific TSs. + +## 5.4 Protocol Zpn between NAF and BSF based on Diameter + +The requirements for Zpn interface are defined in 3GPP TS 33.223 [23]. + +The protocol Zpn retrieves the GPI, key material and possibly user security settings data by NAF from BSF. When the NAF wants to send data to the UE, but the NAF has no valid NAF-key available, the following steps are executed as depicted in Figure 5.4. The basic procedure is: + +In general, the UE and the NAF will not yet share the key(s) required to protect protocol Ua. If they already do, there is no need for the NAF to invoke protocol Zpn. + +It is assumed that the NAF has sufficient information available, i.e. user identity and the address of BSF. + +A) The NAF starts protocol Zpn with BSF + +- The NAF requests GBA-Push-Info (GPI), NAF specific key material corresponding to the user identity. +- The BSF fetches AVs from the HSS, generates and supplies to the NAF the requested GPI, NAF specific key material, the expiry time, the bootstrapinfo creation time, and the appropriate User Security Settings defined for received application identifiers. + +B) The NAF sends GPI over protocol Upa to the UE (see 3GPP TS 33.223 [23]) + +Once the run of protocol Upa is completed the purpose of bootstrapping is fulfilled and it will enable the UE and NAF to run protocol Ua in a secure way. + +The GBA push procedure over Zpn is presented in Figure 5.4. + +![Sequence diagram of the Diameter based GBA push procedure over Zpn. The diagram shows four entities: UE, NAF, BSF, and HSS. The NAF sends a GBA-Push-Info-Request to the BSF. The BSF sends an AV request to the HSS and receives an AV response. The BSF then sends a GBA-Push-Info-Answer to the NAF. Finally, the NAF sends a GPI push to the UE.](9a159e2112eac7be06bdb97e84a0c49a_img.jpg) + +``` + +sequenceDiagram + participant UE + participant NAF + participant BSF + participant HSS + + Note right of BSF: 2. BSF processing, generation of NAF keys and GPI + + NAF->>BSF: 1. GBA-Push-Info-Request (user identity, NAF-Id, GSID*, ...) + BSF->>HSS: AV request (user identity, ...) + HSS-->>BSF: AV response (AV, USS, ...) + BSF->>NAF: 3. GBA-Push-Info-Answer (IMPI, GPI, Ks_(ext)_NAF, Ks_int_NAF, USS, ...) + NAF->>UE: GPI push (cf. TS 33.223) + +``` + +Sequence diagram of the Diameter based GBA push procedure over Zpn. The diagram shows four entities: UE, NAF, BSF, and HSS. The NAF sends a GBA-Push-Info-Request to the BSF. The BSF sends an AV request to the HSS and receives an AV response. The BSF then sends a GBA-Push-Info-Answer to the NAF. Finally, the NAF sends a GPI push to the UE. + +Figure 5.4-1: The Diameter based GBA push procedure over Zpn + +The steps of the GBA push procedure in Figure 5.4-1 are: + +### - Step 1 + +The NAF shall send a GBA-Push-Info-Request message to the BSF. The content of the message is given here in the same format as in 3GPP TS 29.229 [3]. The curly brackets indicate mandatory AVPs. The square brackets indicate optional AVP. The address refers to the Fully Qualified Domain Name (FQDN). + +``` +< GBA-Push-Info-Request> ::= < Diameter Header: xxx, REQ, PXY, xxxxxxxx > + < Session-Id > + { Vendor-Specific-Application-Id } + { Origin-Host } ; Address of NAF + { Origin-Realm } ; Realm of NAF + { Destination-Realm } ; Realm of BSF + [ Destination-Host ] ; Address of the BSF + { UE-Id } ; User identity + { UE-Id-Type } ; Public or private identity + { UICC-App-Label } ; UICC application label + * [ GAA-Service-Identifier ] ; Service identifiers + { NAF-SA-Identifier } ; P-TID + { NAF-Id } ; NAF_ID + { UICC-ME } ; Use of GBA_ME or GBA_U + { Requested-Key-Lifetime } ; Requested NAF-Key lifetime + { Private-Identity-Request } ; Request private identity + [ GBA_U-Awareness-Indicator ] ; GBA_U awareness of the NAF + [ Security-Feature-Request ] ; Sec. feature request + * [ AVP ] + * [ Proxy-Info ] + * [ Route-Record ] +``` + +The content of Vendor-Specific-Application-ID according IETF RFC 6733 [33] is: + +``` + ::= + 1* [Vendor-Id] ; 3GPP is 10415 + 0*1 {Auth-Application-Id} ; xxxxxxxx + 0*1 {Acct-Application-Id} ; Omitted +``` + +The Destination-Realm AVP and Destination-Host AVP are set to subscriber's BSF. + +NOTE: In the case the NAF is in a visited network, the NAF contacts the subscriber's home BSF through a Diameter based Proxy (Zn-Proxy) that is located in the same network as the NAF. In this case the Destination-Host shall not be included. The local BSF and the Zn-Proxy may be co-located. See 3GPP TS 33.220 [6]. + +The NAF indicates the GAA services for which the information is retrieved by GAA-Service-Identifier AVPs. + +With UE-Id and UE-Id-Type AVPs the NAF indicates the user identity and its type, i.e. private or public. The NAF uses UICC-ME and UICC-App-Label AVPs to identify which UICC application is to be used and if GBA-ME or GBA\_U should be used. Private-Identity-Request indicates if the NAF requests the BSF to send the private user identity. Requested-Key-Lifetime AVP indicates the requested key lifetime for the NAF keys. NAF-SA-Identifier (P-TID) is sent to the BSF so that BSF can include it to the encrypted GPI. See 3GPP TS 33.223 [23]. + +The NAF may request information on the availability of security features using the Security-Features-Request AVP. The AVP may contain a semicolon-separated list of security features that are available ordered by preference. + +### - Step 2 + +When the BSF receives the GPI request it checks that the requested key lifetime in the GPI request is less than the allowed max value in the system. If checking fails the BSF sends an Answer message with Experimental-Result set to indicate the error type 5402. In successful case the Result-Code is set to 2xxx as defined in IETF RFC 6733 [33]. + +The BSF includes the received user identity (public or private) to the Zh protocol request. + +If GBA\_U was requested by the NAF, the BSF queries its database to find out if the private user identity is registered and if a valid Ks already exists. If a valid Ks exists, the BSF shall invalidate this Ks + +The BSF derives the key material for the ME (i.e., Ks\_NAF in the case of GBA\_ME, and Ks\_ext\_NAF in the case of GBA\_U) and possibly the key material for the UICC (i.e., Ks\_int\_NAF in the case of GBA\_U) according to the NAF-ID and packs them into ME-Key-Material AVP and possible UICC-Key-Material AVP. The ME-Key-Material contains Ks\_(ext)\_NAF and the UICC-key-Material contains the Ks\_int\_NAF key. The BSF select correct user's Security Settings according the request's GAA-Service-Identifier AVP to GBA-UserSecSettings AVP. If NAF grouping is used by the operator and there are one or more USSs corresponding to the requested GSID, then also the nafGroup attribute of USS is checked. If the NAF has sent a GAA-Service-Identifier that does not have corresponding user's security settings, and the BSF is locally configured to reject those requests from the NAF, then the error 5402 is raised. If the NAF has sent a GAA-Service-Identifier that have corresponding user's security settings, but the BSF is locally configured to reject those from that NAF, then the error 5402 is raised too. + +The BSF generates the GPI according to TS 33.223 [23]. + +The BSF shall check if this NAF-Id is allowed to be used for the NAF. If the NAF identified by its Origin-Host AVP is configured in the BSF not to be authorized to use the given NAF-Id, the BSF may raise the error situation 5402. The BSF may also be configured so that a certain NAF is not authorized to use a certain GAA-Service-Identifier. This situation may be also indicated by error code 5402. + +### - Step 3 + +After that the BSF shall send a GBA-Push-Info-Answer message back to the NAF. The BSF deletes the used Ks according to 3GPP TS 33.223 [23]. + +``` +< GBA-Push-Info-Answer> ::= < Diameter Header: xxx, PXY, xxxxxxxxx > + < Session-Id > + { Vendor-Specific-Application-Id } + [ Result-Code ] + [ Experimental-Result] + { Origin-Host } ; Address of BSF + { Origin-Realm } ; Realm of BSF + [ User-Name ] ; IMPI + [ ME-Key-Material ] ; Required + [ UICC-Key-Material ] ; Conditional + [ Key-ExpiryTime ] ; Time of expiry + [ BootstrapInfoCreationTime ] ; Bootstrapinfo creation time + [ GBA-UserSecSettings ] ; Selected USSs + [ GBA-Type ] ; GBA type used in bootstrapping + [ GBA-Push-Info ] ; GBA Push Info + [ Security-Feature-Response ] ; Sec. feature response + *[ AVP ] + *[ Proxy-Info ] + *[ Route-Record ] +``` + +The BSF may or may not send the User-name AVP (IMPI) It is only returned if requested and public user identity was used in the GBA-Push-Info-Request message according its configuration. + +The mandatory common key material with the ME (Ks\_NAF or Ks\_ext\_NAF) is sent in the ME-Key-Material AVP. The common key material with the UICC (Ks\_int\_NAF) is optionally sent in the UICC-Key-Material AVP only if the "uiccType" tag in bsfInfo from the HSS is set to "GBA\_U". + +The Key-ExpiryTime AVP contains the expiry time of the Bootstrapping information in the BSF according its configuration. The expiry time is represented according the Diameter Time data format in seconds that have passed since 0h on January 1, 1900 UTC . If a special key lifetime value is given in the "lifeTime" tag inside the bsfInfo from the HSS in bootstrapping procedure, it is used instead of the BSF default configuration value when the expiry time is calculated. + +The BootstrapInfoCreationTime AVP contains the bootstrapinfo creation time, i.e., creation time of the Bootstrapping information in the BSF. The bootstrapinfo creation time is represented in seconds that have passed since January 1, 1900 00:00:00.000 UTC. + +The BSF selects the appropriate User Security Settings (if any) to the GBA-UserSecSettings AVP from stored GAA-UserSecSettings in Bootstrapping information according the GBA-Service-Identifier AVPs in the request message. + +The BSF shall indicate the type of used authentication in the bootstrapping procedure to the NAF in GBA-Type, if other than 3G GBA type has been performed. + +The GBA-Push-Info AVP includes the GPI. The contents of GPI are defined in 3GPP TS 33.223 [23]. + +If the BSF supports the usage of securityFeature and the NAF has requested the securityFeatures from the BSF in the request, the BSF shall extract securityFeatures element from the bsfInfo element in subscriber's GUSS and add those security features to the Security-Features-Response AVP in the response which are common in the received securityFeatures request from the NAF and in the extracted information from the bsfInfo element. The common security features are added to the Security-Features-Response AVP in the order as they appear in the bsfInfo element. If securityFeatures element is not defined in the GUSS, or there is no common securityFeature, the BSF shall include an empty string to the Security-Features-Response AVP in the response. + +When the NAF receives the GBA-Push-Info-Answer message, the NAF shall check the value of the GBA-Type AVP if it is included in the message. If the NAF does not support the GBA-Type the NAF shall stop processing the message and should indicate an error via the O&M subsystem. The further procedure in the NAF when the GBA-Push-Info-Answer message is received is described in 3GPP TS 33.223 [23], 3GPP TS 24.109 [7]. + +## 5.5 Protocol Zpn between NAF and BSF based on Web Services + +The procedures in the NAF and in the BSF related Web Services [13] based Zpn interface are the same as specified in clause 5.4, but instead of Diameter messages a Web Services procedures shall be used to communicate over Zpn interface. AnnexG specifies the GBA Service for Web Services, i.e., it contains the Web Services Definition Language (WSDL) [14] specification for GBA Service. Below are the attributes that are defined for GBA Service request, response, and fault cases. + +![Sequence diagram of the Web Services based GAA application procedure. Lifelines: UE, NAF, BSF, HSS. The sequence starts with the NAF sending a 'requestGbaPushInfoRequest' to the BSF. The BSF then sends an 'AV request' to the HSS and receives an 'AV response'. The BSF performs internal processing and then sends a 'requestGbaPushInfoResponse' back to the NAF. Finally, the NAF sends a 'GPI push' message to the UE.](e05b36c0d46549e681ce6581422c66b2_img.jpg) + +``` + +sequenceDiagram + participant UE + participant NAF + participant BSF + participant HSS + + Note right of BSF: 2. BSF processing, generation of NAF keys and GPI + + NAF->>BSF: 1. requestGbaPushInfoRequest (user identity, NAF-Id, GSID*, ...) + BSF->>HSS: AV request (user identity, ...) + HSS-->>BSF: AV response (AV, USS, ...) + BSF->>NAF: 3. requestGbaPushInfoResponse (IMPI, GPI, Ks_(ext)_NAF, Ks_int_NAF, USS, ...) + NAF->>UE: GPI push (cf. TS 33.223) + +``` + +Sequence diagram of the Web Services based GAA application procedure. Lifelines: UE, NAF, BSF, HSS. The sequence starts with the NAF sending a 'requestGbaPushInfoRequest' to the BSF. The BSF then sends an 'AV request' to the HSS and receives an 'AV response'. The BSF performs internal processing and then sends a 'requestGbaPushInfoResponse' back to the NAF. Finally, the NAF sends a 'GPI push' message to the UE. + +**Figure 5.5: The Web Services based GAA application procedure** + +The possible attribute value definitions and restrictions for the request, response, and fault messages are the same as in clause 6 unless explicitly specified in this clause. The steps of the GAA application procedure in Figure 5.4 are: + +### Step 1 + +The NAF shall send a "requestGbaPushInfoRequest message" to the BSF. The WSDL schema of this message is included in Annex G. + +Following elements are included into this message: + +- "ptid" + +This is P-TID and it is given to the BSF so that it can be included in the encrypted "gbaPushInfo" element in the response. Description in subclause 6.3.1.19 applies. + +- "nafid" + +This is the NAF-Id. Description in subclause 6.3.1.3 applies. + +- "gsid" + +This element contains the GAA Services Identifiers. Description in subclause 6.3.1.4 applies while the GAA Service Type Codes for 3GPP standardized services are defined in Annex B. + +- "gbaUAware" + +This element is optionally included. It indicates whether NAF is GBA\_U aware, and is capable of using and handling the "uiccKeyMaterial". The default value for "gbaUAware" is false. Description and values defined for the corresponding Diameter AVP in subclause 6.3.1.8 apply. + +- "userId" + +This element indicates the user identity. Description in subclause 6.3.1.12 applies. + +- "userIdType" + +This element indicates the user identity type, i.e. private or public. Description and values defined for the corresponding Diameter AVP in subclause 6.3.1.13 apply. + +- "uiccAppLabel" + +This element includes the UICC application identity to be used. Description in subclause 6.3.1.14 applies. + +- "uiccOrMe" + +This element indicates the BSF whether GBA\_ME or GBA\_U is to be used for GBA push. Description and values defined for the corresponding Diameter AVP in subclause 6.3.1.15 apply. + +- "requestedLifeTime" + +This element indicates the requested key lifetime for the NAF keys. Description in subclause 6.3.1.16 applies. + +- "privateIdRequest" + +- If this element is present it indicates that the NAF requests the BSF to send the private user identity of the user. Description and values defined for the corresponding Diameter AVP in subclause 6.3.1.17 apply. + +"securityFeaturesRequest" + +If this element is present it indicates that the NAF requests information on the availability of security features. The element may contain a semicolon-separated list of security features that are available ordered by preference. Description in subclause 6.3.1.20 applies while the values are defined in Annex A. + +The NAF may use one or more "extension" elements to include additional data to the request, but the BSF may ignore the additional data. + +This SOAP message shall be sent to BSF, then the URI of the message shall contain the BSF address. + +In the case the NAF is in a visited network, the NAF contacts the subscriber's home BSF through a GBA-Proxy that is located in the same network as the NAF. The local BSF and the GBA-Proxy may be co-located. See 3GPP TS 33.220 [6]. + +### Step 2 + +The procedures for step 2 are the same as in step 2 in clause 5.4. + +If any of the error situations described in step 2 in clause 5.4 arises, the BSF shall respond with a requestGbaPushInfoFault message, as defined in Annex G. The "errorCode" element shall contain the corresponding Diameter error code (see clause 6.2.2). If the "errorText" is included, it shall contain a human-readable description of the error. + +### Step 3 + +After that, the "requestGbaPushInfoResponse" message is sent back to the NAF. The WSDL schema of this message is included in Annex G. + +Following elements are included into this message: + +- "impi" + +This element is optionally included according to BSF configuration. It is only returned if requested and public user identity was used in "requestGbaPushInfoRequest" message. Description for User-Name AVP from 3GPP TS 29.229 [3] applies. + +- "meKeyMaterial" + +It includes the mandatory common key material with the ME (Ks\_NAF or Ks\_ext\_NAF). Description in subclause 6.3.1.6 applies. + +- "uiccKeyMaterial" + +This element is the common key material with the UICC (Ks\_int\_NAF). It is optionally sent only if the "uiccType" tag in "bsfInfo" (received by BSF from the HSS over Zh) is set to "GBA\_U". Description in subclause 6.3.1.7 applies. + +- "keyExpiryTime" + +It contains the expiry time of the Bootstrapping information in the BSF according its configuration. If a special key lifetime value is given in the "lifeTime" tag inside the "bsfInfo" (received by BSF from the HSS over Zh) in bootstrapping procedure, it shall be used instead of the BSF default configuration value when the expiry time is calculated. Description in subclause 6.3.1.5 applies. + +- "bootstrappingInfoCreationTime" + +This element contains the bootstrapinfo creation time, i.e., creation time of the Bootstrapping information in the BSF. Description in subclause 6.3.1.9 applies. + +- "gbaType" + +This element indicates the type of used authentication in the bootstrapping procedure to the NAF in "gbaType" element. It shall be included if other than 3G GBA type has been performed. Description and values defined for the corresponding Diameter AVP in subclause 6.3.1.11 apply. + +- "ussList" + +This element is optionally included. The BSF shall select the appropriate User Security Settings (if any) into the "ussList" element from stored GAA-UserSecSettings in Bootstrapping information according "gsid" elements in the request message. The "ussList" element contains a standalone XML document whose root element shall be "ussList" element as specified in Annex A and which contains the User Security Settings selected by the BSF. Description in subclause 6.3.1.1 applies. + +- "gbaPushInfo" + +This element includes the GPI. Description in subclause 6.3.1.18 applies. + +- "securityFeaturesResponse" + +If the BSF supports the usage of securityFeature and the NAF has requested the securityFeatures from the BSF in the request, the BSF shall extract securityFeatures element from the "bsfInfo" element in subscriber's GUSS and add those security features to the securityFeaturesResponse element in the response which are common in the received "securityFeaturesRequest" from the NAF and the extracted information from the "bsfInfo" element. The common security features are added to the "SecurityFeaturesResponse" element in the order as they appear in the "bsfInfo" element. If "securityFeatures" element is not defined in the GUSS or there is no common "securityFeature", the BSF shall add empty string to the "securityFeaturesResponse" element in the response. Description in subclause 6.3.1.21 applies while the values are defined in Annex A. + +The BSF may use one or more "extension" elements to include additional data to the request, but the NAF may ignore the additional data. + +When the NAF receives the "requestGbaPushInfoResponse" message, the NAF shall check the value of the "gbaType" element if it is included in the message. If the NAF does not support the GBA type the NAF shall stop processing the message and should indicate an error via the O&M subsystem. The further procedure in the NAF when the "requestGbaPushInfoResponse" message is received is described in 3GPP TS 33.220 [5], 3GPP TS 33.222 [11] and optionally in GAA service type specific TSs. + +# 6 Diameter application for Zh, Zn and Zpn interfaces + +## 6.0 Introduction + +The Zh, Zn and Zpn interface protocols are defined as IETF vendor specific Diameter applications, where the vendor is 3GPP. The vendor identifier assigned by IANA to 3GPP () is 10415. + +The Diameter application identifier assigned to the Zh interface application is 16777221 (allocated by IANA). + +The Diameter application identifiers assigned to the Zn and Zpn interface application are 16777220 and 16777268 respectively (allocated by IANA). + +## 6.1 Command-Code values + +The Zn and Zpn interfaces assign new Command-Codes 310 and 312. + +The messages in Zh interface use the same Command-Code value 303 as Multimedia-Auth-Request/Answer messages defined in 3GPP TS 29.229 [3] for Cx interface. + +As the Diameter commands used over Zh, Zn and Zpn have been defined based on the former specification of the Diameter base protocol, the Vendor-Specific-Application-Id AVP is still listed as a required AVP (an AVP indicated as {AVP}) in the command code format specifications defined in this specification to avoid backward compatibility issues, even if the use of this AVP has been deprecated in the new specification of the Diameter base protocol (IETF RFC 6733 [33]). + +## 6.2 Result-Code AVP values + +This section defines new result code values that must be supported by all Diameter implementations that conform to this specification. When one of the result codes defined here is included in a response, it shall be inside an Experimental-Result AVP and Result-Code AVP shall be absent. + +### 6.2.1 Success + +Errors that fall within the Success category are used to inform a peer that a request has been successfully completed. + +The success category result codes defined in 3GPP TS 29.229 [3] for Cx interface are useless and therefore not required in Zh, Zn and Zpn interfaces. + +### 6.2.2 Permanent failures + +Errors that fall within the Permanent Failures category are used to inform the peer that the request failed, and should not be attempted again. + +The Permanent failure category result codes defined in 3GPP TS 29.229 [3] for Cx interface are useless and therefore not required in Zh, Zn and Zpn interfaces. + +#### 6.2.2.1 DIAMETER\_ERROR\_IDENTITY\_UNKNOWN (5401) + +A message was received by the HSS for an IMPI or IMPU that is unknown. + +#### 6.2.2.2 DIAMETER\_ERROR\_NOT\_AUTHORIZED (5402) + +A message was received by the BSF which the BSF can not authorize. In this case the NAF should indicate to the UE that the service is not allowed. In case of GBA push, the NAF should not contact the UE. + +#### 6.2.2.3 DIAMETER\_ERROR\_TRANSACTION\_IDENTIFIER\_INVALID (5403) + +A message was received by the BSF for an invalid (e.g. unknown or expired) Bootstrapping Transaction Identifier (B-TID). In this case the NAF should request the UE to bootstrap again. + +6.2.2.4 Void + +6.2.2.5 Void + +6.2.2.6 Void + +6.2.2.7 Void + +## 6.3 AVPs + +The AVPs defined in 3GPP TS 29.229 [3] for 3GPP IMS Cx interface Multimedia-Auth-Request/Answer messages are used as they are. + +The following table describes the additional new Diameter AVPs defined for the Zh, Zn and Zpn interface protocol, their AVP Code values, types, possible flag values and whether or not the AVP may be encrypted. The Vendor-Id header of all AVPs defined in this specification shall be set to 3GPP (10415). + +**Table 6.1: New Diameter Multimedia Application AVPs** + +| Attribute Name | AVP Code | Section defined | Value Type | AVP Flag rules | | | | | May Encr. | +|---------------------------|----------|-----------------|-------------|----------------|-----|------------|----------|--|-----------| +| | | | | Must | May | Should not | Must not | | | +| GBA-UserSecSettings | 400 | 6.3.1.1 | OctedString | M, V | | | | | No | +| Transaction-Identifier | 401 | 6.3.1.2 | OctetString | M, V | | | | | No | +| NAF-Id | 402 | 6.3.1.3 | OctetString | M, V | | | | | No | +| GAA-Service-Identifier | 403 | 6.3.1.4 | OctedString | M, V | | | | | No | +| Key-ExpiryTime | 404 | 6.3.1.5 | Time | M, V | | | | | No | +| ME-Key-Material | 405 | 6.3.1.6 | OctedString | M, V | | | | | No | +| UICC-Key-Material | 406 | 6.3.1.7 | OctedString | M, V | | | | | No | +| GBA_U-Awareness-Indicator | 407 | 6.3.1.8 | Enumerated | M, V | | | | | No | +| BootstrapInfoCreationTime | 408 | 6.3.1.9 | Time | M, V | | | | | No | +| GUSS-Timestamp | 409 | 6.3.1.10 | Time | V | | | M | | No | +| GBA-Type | 410 | 6.3.1.11 | Enumerated | M, V | | | | | No | +| UE-Id | 411 | 6.3.1.12 | OctetString | M, V | | | | | No | +| UE-Id-Type | 412 | 6.3.1.13 | Enumerated | M, V | | | | | No | +| UICC-App-Label | 413 | 6.3.1.14 | OctetString | M, V | | | | | No | +| UICC-ME | 414 | 6.3.1.15 | Enumerated | M, V | | | | | No | +| Requested-Key-Lifetime | 415 | 6.3.1.16 | Time | M, V | | | | | No | +| Private-Identity-Request | 416 | 6.3.1.17 | Enumerated | M, V | | | | | No | +| GBA-Push-Info | 417 | 6.3.1.18 | OctedString | M, V | | | | | No | +| NAF-SA-Identifier | 418 | 6.3.1.19 | OctedString | M, V | | | | | No | +| Security-Feature-Request | 419 | 6.3.1.20 | OctetString | M, V | | | | | No | +| Security-Feature-Response | 420 | 6.3.1.21 | OctetString | M, V | | | | | No | + +NOTE 1: The AVP header bit denoted as 'M', indicates whether support of the AVP is required. The AVP header bit denoted as 'V', indicates whether the optional Vendor-ID field is present in the AVP header. + +### 6.3.1 Common AVPs + +#### 6.3.1.1 GBA-UserSecSettings AVP + +The GBA-UserSecSettings AVP (AVP code 400) is of type OctetString. If transmitted on the Zh interface it contains GBA user security settings (GUSS). If transmitted on the Zn interface it contains the relevant USSs only. The content of GBA-UserSecSettings AVP is a XML document whose root element shall be the "guss" element for Zh interface and the "ussList" element for the Zn interface. The XML schema is defined in annex A. + +#### 6.3.1.2 Transaction-Identifier AVP + +The Transaction-Identifier AVP (AVP code 401) is of type OctetString. This AVP contains the Bootstrapping Transaction Identifier (B-TID). + +#### 6.3.1.3 NAF-Id + +The NAF-Id AVP (AVP code 402) is of type OctetString. This AVP contains the full qualified domain name (FQDN) of the NAF that the UE uses concatenated with the Ua security protocol identifier as specified in 3GPP TS 33.220 [5]. The FQDN of the NAF that is part of the NAF\_Id may be a different domain name that with which the BSF knows the NAF. + +#### 6.3.1.4 GAA-Service-Identifier AVP + +The GAA-Service-identifier AVP (AVP code 403) is of type OctetString. This AVP informs a BSF about the support of a GAA-service by the NAF. According this AVP the BSF can select the right service's user security settings. + +For 3GPP standardized services (e.g., PKI portal), the GAA-Service-Identifier (GSID) shall be in the range 0 to 999999, and the currently standardized values for GSID shall be the GAA Service Type Code of the particular service. The GAA Service Type Codes for 3GPP standardized services are defined in Annex B. + +NOTE: In the future, standardized GSID values that are different than the GAA Service Type Code may be standardised (e.g. to differentiate between the services "MBMS streaming" and "MBMS download") and then several different GSID can exist within one GAA Service Type Code. + +Examples: The GSID is "1" for all PKI-portals, and "4" for all MBMS services. + +#### 6.3.1.5 Key-ExpiryTime AVP + +The Key-ExpiryTime AVP (AVP code 404) is of type Time. This AVP informs the NAF about the expiry time of the key. + +#### 6.3.1.6 ME-Key-Material AVP + +The required ME-Key-Material AVP (AVP code 405) is of type OctetString. The NAF is sharing this key material (Ks\_NAF in the case of GBA\_ME or Ks\_ext\_NAF in the case of GBA\_U) with the Mobile Equipment (ME). + +#### 6.3.1.7 UICC-Key-Material AVP + +The conditional UICC-Key-Material AVP (AVP code 406) is of type OctetString. The NAF may share this key material (Ks\_int\_NAF in the case of GBA\_U) with a security element (e.g. USIM, ISIM, etc..) in the UICC. Only some GAA applications use this conditional AVP. + +#### 6.3.1.8 GBA\_U-Awareness-Indicator + +The conditional GBA\_U-Awareness-Indicator AVP (AVP code 407) is of type Enumerated. The following values are defined. + +NO (0) The sending node is not GBA\_U aware + +YES(1) The sending node is GBA\_U aware + +The default value is 0 i.e. absence of this AVP indicates that the sending node is not GBA\_U aware. + +#### 6.3.1.9 BootstrapInfoCreationTime AVP + +The BootstrapInfoCreationTime AVP (AVP code 408) is of type Time. This AVP informs the NAF about the bootstrap information creation time of the key. + +#### 6.3.1.10 GUSS-Timestamp AVP + +The GUSS-Timestamp AVP (AVP code 409) is of type Time. If transmitted this AVP informs the HSS about the timestamp of the GUSS stored in the BSF. + +#### 6.3.1.11 GBA-Type + +The GBA-Type AVP (AVP code 410) is of type Enumerated. The AVP informs the NAF about the authentication type that was used during bootstrapping procedure. + +The following values are defined: + +- 3G GBA (0) The 3G GBA has been performed as defined in TS 33.220 [5]. +- 2G GBA (1) The 2G GBA has been performed as defined in TS 33.220 [5] , Annex I. +- GBA Digest (2) The GBA Digest has been performed as defined in TS 33.220 [5], Annex M. + +The default value is 0 i.e. the absence of this AVP indicates 3G GBA. The value 2 is not applicable for Zpn. + +#### 6.3.1.12 UE-Id + +The UE-Id AVP (AVP code 411) is of type OctetString. The AVP informs the BSF the identity of the user. + +#### 6.3.1.13 UE-Id-Type + +The UE-Id-Type AVP (AVP code 412) is of type Enumerated. The AVP informs the BSF the type of the identity of the user. + +The following values are defined: + +- (0) Private user identity. +- (1) Public user identity. + +#### 6.3.1.14 UICC-App-Label + +The UICC-App-Label AVP (AVP code 413) is of type OctetString. The AVP informs the BSF the UICC application to be used for GBA push. + +#### 6.3.1.15 UICC-ME + +The UICC-ME AVP (AVP code 414) is of type Enumerated. The AVP informs the BSF whether GBA\_ME or GBA\_U is to be used for GBA push. + +The following values are defined: + +- GBA\_ME (0) GBA\_ME shall be run. +- GBA\_U (1) GBA\_U shall be run. + +#### 6.3.1.16 Requested-Key-Lifetime + +The Requested-Key-Lifetime AVP (AVP code 415) is of type Time. The AVP informs the BSF about the requested lifetime for the NAF keys. + +#### 6.3.1.17 Private-Identity-Request + +The Private-Identity-Request AVP (AVP code 416) is of type Enumerated. The AVP informs the BSF if the NAF requests the private identity of the user. + +The following values are defined: + +- Private identity requested (0) +- Private identity not requested (1) + +#### 6.3.1.18 GBA-Push-Info + +The GBA-Push-Info AVP (AVP code 417) is of type OctetString. The AVP includes the GBA-Push-Info as defined in 3GPP TS 33.223 [23]. + +#### 6.3.1.19 NAF-SA-Identifier + +The NAF-SA-Identifier AVP (AVP code 418) is of type OctetString. The AVP contains the NAF-SA-Identifier (P-TID). See 3GPP TS 33.223 [23]. + +#### 6.3.1.20 Security-Feature-Request + +The Security-Feature-Request AVP (AVP code 419) is of type OctetString. The AVP contains one or several of the security features requested by the NAF. The values are defined in Annex A. + +#### 6.3.1.21 Security-Feature-Response + +The Security-Feature-Response AVP (AVP code 420) is of type OctetString. The AVP contains one or several of the security features identified by the HSS. This information is conveyed to the BSF using the "securityFeatures" element in the "bsfElement" of GUSS (cf. Annex A), and the securityFeatures received in the request. The values are defined in Annex A. + +## 6.4 User identity to HSS resolution + +The User identity to HSS resolution mechanism enables the BSF to find the identity of the HSS that holds the subscriber data for a given subscriber when multiple and separately addressable HSSs have been deployed by the network operator. The resolution mechanism is not required in networks that utilise a single HSS or when a BSF is configured to use pre-defined HSS. + +The resolution mechanism is equivalent to the mechanism defined for the Cx/Dx interface described in 3GPP TS 23.228 [12] and shall use a Subscription Locator Function (SLF) or a Diameter Proxy Agent. + +The BSF accesses the SLF via the Dz interface. The Dz interface shall be always used in conjunction with the Zh interface. The Dz interface is based on Diameter base protocol as specified in IETF RFC 6733 [33]. The SLF functionality shall use the routing mechanism provided by an enhanced Diameter redirect agent, which is able to extract the Subscriber identity from the received requests. + +The SLF or the Diameter Proxy Agent shall be able to determine the HSS identity. + +To get the HSS identity the BSF shall send the Zh request normally destined to the HSS to a pre-configured Diameter identity. + +- If this Zh request is received by an SLF (acting as a Diameter redirect agent), the SLF shall determine the HSS identity and shall send to the BSF a notification of redirection towards the HSS identity, in response to the Zh request. Multiple HSS identities may be included in the response, as specified in IETF RFC 6733 [33]. In such a case, the BSF shall send the Zh Request to the first HSS identity in the ordered list received in the Zh Response from the SLF. If the BSF does not receive a successful response to the Zh Request, the BSF shall send a Zh Request to the next HSS identity in the ordered list. This procedure shall be repeated until a successful response from an HSS is received. +- If this Zh request is received by the Diameter Proxy Agent, the Diameter Proxy Agent shall determine the HSS identity and shall forward the Zh request directly to the HSS. The BSF shall determine the HSS identity from the response to the Zh request received from the HSS. + +After the user identity to HSS resolution, the BSF may store the HSS identity and, if stored, shall use it in further Zh requests associated to the same Subscriber. + +In networks where the use of the user identity to HSS resolution mechanism is required and the BSF is not configured to use predefined HSS, each BSF shall be configured with the address/name of the SLF or the Diameter Proxy Agent implementing this resolution mechanism. + +# --- 7 Use of namespaces + +This clause contains the namespaces that have either been created in this 3GPP specification, or in 3GPP specification 3GPP TS 29.229 [3] or the values assigned to existing namespaces managed by IANA. + +## 7.1 AVP codes + +This specification reserves the 3GPP vendor specific values 10415:400-499 and assigns values 10415:400-418 for the GAA from the 3GPP AVP Code namespace for 3GPP Diameter applications ([8]). The 3GPP vendor specific AVP code space is managed by 3GPP CT4. See section 6 for the assignment of the namespace in this specification. + +Besides the Diameter base protocol AVPs specified in IETF RFC 6733 [33], this specification reuses the following AVPs from 3GPP TS 29.229 [3]: + +Authentication-Session-State, User-Name, Public-User-Identity and SIP-Auth-Data-Item. + +## 7.2 Experimental-Result-Code AVP values + +This specification reserves Experimental-Result-Code AVP values 10415:2401-2409 and 10415:5401-5409. See section 6.2. + +## 7.3 Command Code values + +Only Command-Codes 310 and 303 from 3GPP TS 29.229 [3] is used in this specification. + +This specification reuses only the Command-Code value, not the content of the original specification. The AVPs, that are defined required in TS 29.229 [3], but are not needed in Zh, Zn or Zpn interfaces, are removed and are therefore not required in Zh, Zn or Zpn interface messages. All new AVPs for GAA are defined optional although they may be mandatory in GAA viewpoint. + +This specification does not assign new command codes to the 3GPP TS 29.229 [3]. + +# Annex A (normative): GBA-UserSecSettings XML definition + +This annex contains the XML schema definition for an XML document carrying the GBA User Security Settings inside GBA-UserSecSettings AVP in Zh,Zn and Zpn interface. + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +NOTE 1: The elements within the complex types ExtensionType allow for compatible standard extensions in future releases. The elements within the other complex types allow for compatible private extensions. + +The values are: + +- The value of the attribute "id" in the element "guss" is the same as user's IM Private Identity (IMPI) used in User-Name AVP. + +- The value of the element "timestamp" in the element "guss" is the same type as GUSS-Timestamp used in GUSS-Timestamp AVP and indicates the timestamp of the GUSS. Timestamp value shall be expressed in UTC form, indicated by a time zone designator "Z" immediately following the time portion of the value. +- The value of the attribute "id" in the element "uss" is the same as service identifier (GSID) used in GAA-Service-Identifier AVP. + +NOTE 2: In the case with currently standardized 3GPP applications (c. f. Annex B), the service identifier (GSID) is the same as the GAA Service Type Code i.e. the "id" and the "type" attribute would have the same value. For example, in the interoperator GAA where the requesting BM-SC (i.e. NAF) is different operator network than the answering BSF, the BM-SC (NAF) can request particular user's MBMS USS by using "4" for the GSID in the "id" attribute in the USS. If the BSF operator wishes to have different MBMS USSs for different BM-SCs (NAFs), it can use the nafGroup attribute to separate NAFs to specific groups, and each group would get a particular USSs: would be given to NAFs in group A, and would be given to NAFs in group B when they request it. NAF groups are operator specific, i.e., operator decides which USS is given to which NAF." + +- The value of the element "uiccType" in the element "bsfInfo" is: +GBA to indicate the basic case, or +GBA\_U to indicate that generation of Ks\_int\_NAF is also required in the BSF. +The default value is GBA. +- The value of the element "lifeTime" in the element "bsfInfo" indicates a user specific key lifetime (duration in seconds). If the lifeTime element is missing the default value in the BSF is used. +- The value of the optional element "securityFeatures" in the element "bsfInfo" indicates a user specific security feature list that the UE supports. If the securityFeature element is missing then the security features are not defined. If there is a list of several values, they are separated by ";". Defined values are: +- "GPL\_U": The UICC supports Generic Push Layer on the UICC as specified in 3GPP TS 33.224 [30]. +- The value of attribute "type" in the element "uss" is GAA service type code defined in annex B. +- The value of attribute "nafGroup" in the element "uss" is an operator internal group designator for a NAF group the USS is valid for. If this attribute is missing then only the attribute "id" is used for selection of this element. +- Values of the element "uid" are user's public authentication identities from the HSS. +- Values of element "flag" are user's authorization flag codes from the HSS for GAA service type indicated in the type attribute in the parent uss element. If an authorization flag exist the NAF have permission to give the corresponding service, otherwise not +- The value of the element "keyChoice" in the "Extension" element inside the "uss" element is "ME-based-key", i.e., Ks\_NAF or Ks\_ext\_NAF shall be used, or "UICC-based-key", i.e., Ks\_int\_NAF shall be used or "ME-UICC-based-keys", i.e., Ks\_ext\_NAF or Ks\_int\_NAF can be used. The value of this element indicates to the NAF, which key shall be used. If the keyChoice element is missing, then as a default the "ME-based-key" shall be used by the NAF unless a prior agreement exists that mandates to use "UICC-based-key" or "ME-UICC-based-keys". + +In the following illustrative examples the values are *italised and underlined*. The content of one User Security Setting tag is boxed. + +``` + + + 86400 + + + + + tel:358504836551 + lauri.laitinen@example.com + ... + + + +``` + +``` + + + + 1 + ... + + + ME-based-key + + + +``` + +``` + + ... + + + +``` + +The above GAA User Security Settings example for user "358500004836551@ ims.mnc050.mcc358.3gppnetwork.org" defines that for PKI-Portal (GAA service type code is 1) services are allowed for user identities "tel:358504836551" and "lauri.laitinen@example.com" and authentication is allowed (flag 1 exists) but non-repudiation is not allowed (flag 2 is missing) to NAFs that provide the GAA service identified by "1" GAA Service Identifier. This particular USS for PKI-Portal is intended to be used only with a NAF group that is labeled as "A" (NAF groupings and NAFs that belong to these groups are specified by the MNO). Additionally, the key choice for the PKI-Portal should use only ME based key (as key keyChoice is set to "ME-based-key"). The BSF shall not generate UICC-Ks, because uiccType is missing. A special key lifetime defines that the duration after which the key expires is 86400 seconds. + +``` + + + + + + tel:358504836551 + lauri.laitinen@example.com + + + 1 + + + ME-based-key + + + +]]> + +``` + +The above is an example how the value of "GAA-UserSecSettings" in Diameter based Zn reference point and "ussList" in Web Services based Zn reference point is populated. + +NOTE 3: The BSF has removed the "nafGroup" attribute from "uss" element. Also, the XML document has been surrounded by "" tags, so that the XML parser handling the outer message (i.e., in Web Services case) will not parse the ussList. The ussList will be parsed by the application itself handling the incoming message. + +Below is an example illustrating the usage of the flag for service authorization. The content of one User Security Setting tag is boxed. + +``` + + + + 86400 + + + +``` + +``` + + + + tel:358501234567 + pekka.mustermann@example.com + ... + + +``` + +``` + + 1 + ... + + + ME-based-key + ... + + +... + + +``` + +The above GAA User Security Settings example for user "358501234567@ims.mnc050.mcc358.3gppnetwork.org" defines that for ANDSF (GAA service type code is 8) services are allowed for user identities "tel:358501234567" and "pekka.mustermann@example.com" and authentication is allowed (flag 1 exists) i.e. the user is authorized to use the ANDSF service according to the policy stored in the ANDSF server. If the flag contains a 0 or is missing, the stated user identities would not be authorized to use the GAA service identified by "8" GAA Service Identifier. Additionally, the key choice for the ANDSF should use only ME based key (as key keyChoice is set to "ME-based-key"). + +Analogously, the authorization flag is used for OpenID GBA Interworking (GAA Service Type Code 11) the authentication is allowed (flag 1 exists) i.e. the user is authorized to use the OpenID-GBA Interworking service. If the flag contains a 0 or is missing, the stated user identities would not be authorized to use the GAA service identified by "11" GAA Service Identifier. Additionally, the key choice for the OpenID/GBA Interworking should use only ME based key if the keyChoice extension is set to "ME-based-key". + +# --- Annex B (normative): GAA Service Type Codes + +The GAA Service Type Code values are used in GAA to indicate interpretation, coding and usage of GAA service type specific data. + +For examples each GAA service type may have their own set of authorization flags. Meaning and coding of these flags are defined in Annex C. There may also be proprietary GAA service types with their own definitions in the future. + +Code values 0 – 999999 are reserved for standardized GAA service types. + +The following values are defined for standardized GAA service types with 3GPP specification: + +- 0 Unspecific service +- 1 PKI-Portal +- 2 Authentication Proxy +- 3 Presence +- 4 MBMS +- 5 Liberty Alliance Project (see [15]) +- 6 UICC - Terminal Key Establishment (see [17]) +- 7 Terminal – Remote Device Key Establishment (see [18]) +- 8 ANDSF (see [24]) +- 9. GBA Push (see [25]) +- 10 IMS based PSS MBMS (see [26]) +- 11 OpenID GBA Interworking (see [29]) +- 12 Generic Push Layer (see [30]) + +Default value is 0. An unspecific service may or may not have user security settings containing or not a list of public identities. An unspecific service cannot have specified authorization flags or other service type specific data. + +# --- Annex C (normative): GAA Authorization flag codes + +For GAA services which have a defined set of special authorization flag codes the following rule holds: The service specified by the GAA authorization flag codes is allowed for a user only if user's user security setting contains that flag. + +The following standardised GAA service types that are listed in previous annex B have the following special authorization flag codes: + +## **PKI-Portal (1)** + +- 1 Authentication allowed +- 2 Non-repudiation allowed + +## **ANDSF (8)** + +- 0 Not authorized +- 1 Authorized according to policy stored in ANDSF server + +## **OpenID Interworking (13)** + +- 0 Not authorized +- 1 Authorized + +# --- Annex D (normative): Web Services Defintion for Zn interface + +This annex contains the Web Services Defination Language (WSDL) [14] for Zn interface: + +``` + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +# Annex E (informative): Liberty authentication context definitions for GBA + +## E.1 Introduction + +This clause describes the GBA Authentication Context definition that the Liberty Identity Provider uses to describe GBA parameters to Liberty Service Provider. The Liberty 3GPP Security Interworking is further discussed in 3GPP TR 33.980 [15]. + +## E.2 GBA Authentication context statement data model + +A particular Liberty authentication context statement will capture the characteristics of the process, procedures, and mechanisms by which the authentication authority verified the subject before issuing an identity, protects the secrets on which subsequent authentications are based, and the mechanisms used for this authentication. These characteristics are categorized in the Liberty ID-FF Authentication Context Specification [16] as follows: + +- Identification - Characteristics that describe the processes and mechanism the authentication authority uses to initially create an association between a subject and the identity (or name) by which the subject will be known. +- Technical Protection - Characteristics that describe how the "secret" (the knowledge or possession of which allows the subject to authenticate to the authentication authority) is kept secure. +- Operational Protection - Characteristics that describe procedural security controls employed by the authentication authority (for example, security audits, records archival). +- Authentication Method - Characteristics that define the mechanisms by which the subject of the issued assertion authenticates to the authentication authority (for example, a password versus a smartcard). +- Governing Agreements - Characteristics that describe the legal framework (e.g. liability constraints and contractual obligations) underlying the authentication event and/or its associated technical authentication infrastructure. + +Compared to Liberty Authentication Context [16], the GBA Authentication Context statement data model adds a description to to which GBA mechanism was used during bootstrapping with the BSF, and how the corresponding shared secret was used with the Identity Provider (IdP) that functions as a NAF. + +The authentication contexts classes specific to mobile terminals specified by Liberty Alliance are called + +- MobileOneFactorUnregistered, +- MobileTwoFactorUnregistered, +- MobileOneFactorContract, and +- MobileTwoFactorContract classes. + +The GBA authentication context uses some of the elements in these classes and introduces a new element called "GBAMechanism", which can be used to describe GBA specific parameters of the authentication. The elements used in the GBA Authentication Context schemas are: + +- GBAMechanismType: describes the GBA bootstrapping mechanism (identifies the method used over Ub reference point); +- AuthenticatorTransportProtocolType: describes the authentication mechanism that was used authenticate the UE towards the Liberty Identity Provider (identifies the method used over Ua reference point); +- KeyActivationType: describes the mechanism to achieve two factor authentication (valid in \*TwoFactor\* authentication schemas). + +## E.3 GBA authentication context statement schema + +This section lists the complete GBA Authentication Context XML schema. It is based on Liberty Authentication Context XML Schema to which the addition is the additional description of how GBA procedures have been conducted, i.e., GBAMechanism element. + +``` + + + + + + + + + + This authentication context has been defined for the + 3GPP and 3GPP2 Generic Bootstrapping Architecture. It + defines new GBAMechanismType and its values, but reuses + the Liberty authentication context schema for other + values. The GBA authentication context is based on the + MobileOneFactor* and MobileTwoFactor* authentication + contexts with the exception that only shared secret + based authentication methods (i.e., symmetric) are used, + and private key (i.e., asymmetric) methods are not + used when authenticating the UE due to the nature of GBA. + + + + + + + + Legacy GBA where existing old authentication + frameworks are used for bootstrapping such + 2G GBA in 3GPP, and CDMA 1x and CDMA 1xEVDO + in 3GPP2. + + + + + + + + GBA using AKA as specified in 3GPP and 3GPP2. + The shared secret is derived in the mobile and + used in the mobile. + + + + +``` + +``` + + + + + + + + GBA_U using AKA as specified in 3GPP and 3GPP2. + The shared secret is derived in the UICC and used + in the mobile. + + + + + + + + GBA_U using AKA as specified in 3GPP and 3GPP2. + The shared secret is derived in the UICC and used + in the UICC. + + + + + + + + GBA mechanism used in the bootstrapping procedure. + + + + + + + + + + + + + + + +``` + +## E.4 GBA authentication context classes + +### E.4.1 GBAOneFactorUnregistered + +This class reflects that there were no mobile customer registration procedures and an authentication of the UE is done without requiring explicit end-user interaction. + +#### E.4.1.1 Associated 3GPP URI + + + +#### E.4.1.2 Class schema + +``` + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +### E.4.2 GBATwoFactorUnregistered + +This class reflects that there were no mobile customer registration procedures and a two-factor based authentication of the UE is done requiring an explicit end-user interaction during authentication procedure (e.g., a PIN needs to be typed). + +#### E.4.2.1 Associated 3GPP URI + + + +#### E.4.2.2 Class schema + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + +``` + +### E.4.3 GBAOneFactorContract + +This class reflects that mobile customer registration procedures have taken place and an authentication of the UE is done without requiring explicit end-user interaction. + +#### E.4.3.1 Associated 3GPP URI + + + +#### E.4.3.2 Class schema + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + +``` + +### E.4.4 GBATwoFactorContract + +This class reflects that mobile customer registration procedures have taken place and a two-factor based authentication of the UE is done requiring an explicit end-user interaction during authentication procedure (e.g., a PIN needs to be typed). + +#### E.4.4.1 Associated 3GPP URI + + + +#### E.4.4.2 Class schema + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +# Annex F (informative): SAML authentication context definitions for GBA + +## F.1 Introduction + +This clause describes the GBA Authentication Context definition that an Identity Provider (IdP) uses to describe GBA parameters to a Service Provider (SP). SAML authentication contexts are further discussed in the SAML Authentication Context specification [19]. + +## F.2 GBA authentication context declaration data model + +Similarly to Liberty (cf. Annex E), a SAML authentication context declaration captures characteristics of the processes, procedures, and mechanisms by which the authentication authority verified the subject before issuing an identity, protects the secrets on which subsequent authentications are based, and the mechanisms used for this authentication (identification, technical protection, operational protection, authentication method and governing agreements) OASIS Standard [22]. + +Compared to the SAML authentication context declaration data model OASIS Standard [22], the GBA authentication context declaration data model extends the SAML model by adding a description of which GBA mechanism was used during bootstrapping with the BSF, and at the same time restricts the SAML model in a number of respects specific to GBA (only shared secret as authenticator type, only HTTP or SSL as authenticator transport protocol, secret key activation by PIN, only mobile device or smartcard as key storage medium). + +The authentication contexts classes specific to mobile terminals specified by SAML are: + +- MobileOneFactorUnregistered, +- MobileTwoFactorUnregistered, +- MobileOneFactorContract, and +- MobileTwoFactorContract. + +The GBA authentication context classes introduced herein correspond to the above ones and are: + +- GBAOneFactorUnregistered, +- GBATwoFactorUnregistered, + +- GBAOneFactorContract, and +- GBATwoFactorContract. + +The GBA authentication context classes are derived from the corresponding SAML authentication context classes by means of the following patterns: + +- The GBA mechanism (corresponding to ME-based GBA, UICC-based GBA, 2G GBA, etc.) is added to the authentication method type for all the four classes. +- A set of GBA-specific restrictions (only shared secret as authenticator type, only HTTP or SSL as authenticator transport protocol, only mobile device or smartcard as key storage medium) is applied to all the four classes. +- For the “OneFactor” classes (GBAOneFactorUnregistered and GBAOneFactorContract), there is no more difference (compared to the corresponding SAML class) in addition to the two changes described above. +- For the “TwoFactor” classes (GBATwoFactorUnregistered and GBATwoFactorContract), the key activation by means of PIN is mandatory in secret key protection. + +Given the above patterns, the rest of this annex is expected to be understood without further detailed explanations. + +## F.3 GBA authentication context declaration types + +This section lists the type definitions common to all the four GBA authentication context declaration classes. It adds the GBA mechanism elements (and the necessary type definitions) to the SAML types. + +``` + + + + + These types are intended to be used in the definition of + the authentication context classes in 3GPP and 3GPP2 Generic + Bootstrapping Architecture (GBA). The new authentication + context classes are defined separately. + + + + + + + + + GBA mechanism used in the bootstrapping procedure. + + + + + + + Legacy GBA where existing old authentication + frameworks are used for bootstrapping such + 2G GBA in 3GPP, and CDMA 1x and CDMA 1xEvDo + in 3GPP2. + + + + + + + GBA using AKA as specified in 3GPP and 3GPP2. + The shared secret is derived in the mobile and + used in the mobile. + + + + + + + GBA_U using AKA as specified in 3GPP and 3GPP2. + The shared secret is derived in the UICC and used + in the mobile. + + + + +``` + +``` + + + + + + + + GBA_U using AKA as specified in 3GPP and 3GPP2. + The shared secret is derived in the UICC and used + in the UICC. + + + + + + + + + + + + + + + +``` + +## F.4 GBA authentication context declaration classes + +### F.4.1 GBAOneFactorUnregistered + +This class reflects that there were no mobile customer registration procedures and an authentication of the UE is done without requiring explicit end-user interaction. + +#### F.4.1.1 Associated 3GPP URI + +urn:3gpp:gba:ac:saml:2007-08:classes:GBAOneFactorUnregistered + +#### F.4.1.2 Class schema + +``` + + + + + + + The GBA authentication context class comparable to + the SAML MobileOneFactorUnregistered class. + Id: 3gpp-gba-saml-authn-context-gbaonefactor-unreg-1.0.xsd + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +### F.4.2 GBATwoFactorUnregistered + +This class reflects that there were no mobile customer registration procedures and a two-factor based authentication of the UE is done requiring an explicit end-user interaction during authentication procedure (e.g., a PIN needs to be typed). + +#### F.4.2.1 Associated 3GPP URI + +urn:3gpp:gba:ac:saml:2007-08:classes:GBATwoFactorUnregistered + +#### F.4.2.2 Class schema + +``` + + + + + + + The GBA authentication context class comparable to + the SAML MobileTwoFactorUnregistered class. + Id: 3gpp-gba-saml-authn-context-gbatwofactor-unreg-1.0.xsd + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +### F.4.3 GBAOneFactorContract + +This class reflects that mobile customer registration procedures have taken place and an authentication of the UE is done without requiring explicit end-user interaction. + +#### F.4.3.1 Associated 3GPP URI + +urn:3gpp:gba:ac:saml:2007-08:classes:GBAOneFactorContract + +#### F.4.3.2 Class schema + +``` + + + + + + The GBA authentication context class comparable to + the SAML MobileOneFactorContract class. + Id: 3gpp-gba-saml-authn-context-gbaonefactor-reg-1.0.xsd + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + +``` + +### F.4.4 GBATwoFactorContract + +This class reflects that mobile customer registration procedures have taken place and a two-factor based authentication of the UE is done requiring an explicit end-user interaction during authentication procedure (e.g., a PIN needs to be typed). + +#### F.4.4.1 Associated 3GPP URI + +urn:3gpp:gba:ac:saml:2007-08:classes:GBATwoFactorContract + +#### F.4.4.2 Class schema + +``` + + + + + + + The GBA authentication context class comparable to + the SAML MobileTwoFactorContract class. + Id: 3gpp-gba-saml-authn-context-mobiletwofactor-reg-1.0.xsd + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +# Annex G (normative): Web Services Definition for Zpn interface + +This annex contains the Web Services Definition Language (WSDL) [14] for Zpn interface: + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + +``` + +# Annex H (informative): Change history + +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | New | +|---------|-------|-----------|------|-----|-------------------------------------------------------------------------------|--------| +| 2004-09 | CN#25 | NP-040410 | | | Version 2.0.0 approved in CN#25 | 6.0.0 | +| 2004-12 | CN#26 | NP-040580 | 001 | | Authorization Flag Code Annex | 6.1.0 | +| 2004-12 | | | 002 | | Finalization of GAA Service Identifier | | +| 2004-12 | | | 003 | 1 | BSF control information (bsfInfo) tag to GUSS | | +| 2004-12 | | | 005 | | Structure to GAA Service Identifier | | +| 2004-12 | | | 006 | 1 | Finalisation of terminology | | +| 2004-12 | | | 008 | 1 | Command code 310 Zn messages | | +| 2004-12 | | | 009 | | Introduction of NAF groups | | +| 2005-01 | | | | | Fix Word problem | 6.1.1 | +| 2005-03 | CN#27 | NP-050041 | 010 | | GAA Error Codes | 6.2.0 | +| | | | 011 | | Only one AV from HSS to BSF | | +| | | | 012 | | Clarification of LifeTime/ExpiryTime terminology | | +| | | | 013 | 1 | Application identifiers to Z-interfaces | | +| | | | 014 | 1 | Modification of key lifetime material | | +| 2005-06 | CT#28 | CP-050090 | 0015 | | XML extensibility | 6.3.0 | +| | | | 0016 | 1 | Remove BSF from visited network | | +| 2005-09 | CT#29 | CP-050300 | 0017 | 1 | Correction for GBA with multiple HSS's | 6.4.0 | +| | | | 0021 | | Key naming alignment with TS 33.220 | | +| 2005-09 | CT#29 | CP-050317 | 0019 | 1 | Key indication in USS | 7.0.0 | +| | | | 0020 | 2 | Addition of GUSS timestamp to Zh reference point | | +| 2005-12 | CT#30 | CP-050613 | 0019 | 1 | XML syntax correction | 7.1.0 | +| | | CP-050624 | 0022 | 1 | 2G GBA implementation to Zh and Zn | | +| 2006-03 | CT#31 | CP-060071 | 0025 | 1 | Correction of NAF_ID | 7.2.0 | +| | | | 0026 | 1 | HTTP based Zn interface | | +| | | | 0027 | 1 | Liberty authentication context for GAA | | +| 2006-06 | CT#32 | CP-060318 | 0028 | 1 | Optionality of the HTTP based Zn interface for NAF | 7.3.0 | +| | | | 0029 | 1 | Replacement of "GAA-Application-Type-Code" with "GAA Service Type Code" | | +| 2006-09 | CT#33 | CP-060415 | 0030 | 1 | Inconsistent description about the proxy between BSF and visited NAF | 7.4.0 | +| | | | 0031 | | Only one instance of SIP-Auth-Data-Item sent in MAA | | +| 2006-12 | CT#34 | CP-060567 | 0032 | 1 | Zh MAR/MAA Diameter Application identifier | 7.5.0 | +| | | | 0033 | | Definition of GAA Service Type Code for Liberty Alliance Interworking | | +| | | | 0034 | | Corrections to GAA authentication context schema | | +| | | | 0035 | | WSDL definition enhancements for Zn interface | | +| 2007-06 | CT#36 | CP-070320 | 0037 | 1 | Addition of Service Type For Rel-7 | 7.6.0 | +| | | CP-070320 | 0038 | 1 | Bug fixes on Zn WSDL definition | | +| | | CP-070317 | 0040 | | GUSS schema fix | | +| 2007-09 | CT#37 | CP-070528 | 0036 | 4 | HLR support for BSF | 7.7.0 | +| | | | 0041 | 1 | Addition of SAML authentication context declaration classes | | +| 2007-12 | CT#38 | CP-070741 | 0042 | 1 | GUSS and USS handling corrections | 7.8.0 | +| 2008-03 | CT#39 | CP-080013 | 0045 | | GBA-UserSecSettings XML fix | 7.9.0 | +| 2008-06 | CT#40 | CP-080275 | 0047 | 2 | Key choice correction | 7.10.0 | +| 2008-12 | CT#42 | | | | Upgraded unchanged from Rel-7 | 8.0.0 | +| 2008-03 | CT#43 | CP-090033 | 0048 | | Introduction of GBA Push within TS 29.109 – Scope, References and Definitions | 8.1.0 | +| | | | 0049 | 2 | Introduction of GBA Push within TS 29.109 – Zpn Interface | | +| | | | 0050 | 1 | Introduction of GBA Push within TS 29.109 – Impacts on Zh Interface | | +| | | | 0051 | 3 | User identity to HSS Resolution mechanism using a Diameter Proxy | | +| | | | 0055 | 1 | Renaming of the reference point between BSF and HLR | | +| 2009-06 | CT#44 | CP-090486 | 0056 | 2 | ANDSF Service Authorization | 8.2.0 | +| 2009-09 | CT#45 | CP-090554 | 0057 | 1 | Additional GBA Service Codes | 8.3.0 | + +| | | | | | | | +|---------|--------|-----------|------|---|---------------------------------------------------------------------------------------|--------| +| | | | 0059 | 2 | MSISDN support in GBA | | +| 2009-09 | CT#45 | CP-090555 | 0058 | 1 | GBA Service Type Codes and Authorization Flag | 9.0.0 | +| 2009-12 | CT#46 | CP-091031 | 0068 | 2 | 2G GBA Option not supported in HSS | 9.1.0 | +| | | CP-091031 | 0069 | 2 | Synchronization Failure Recovery over Zh | | +| | | CP-091031 | 0070 | 2 | Zh and Zn Unable to Comply | | +| | | CP-090782 | 0071 | 1 | Zh identity unknown | | +| | | CP-090782 | 0072 | 2 | Only User-Name or Public-Identity AVP shall be present in a MAR request | | +| 2010-03 | CT#47 | CP-100036 | 0073 | 2 | GPL_U support in TS 29.109 | 9.2.0 | +| | | | 0074 | | Correction to WSDL schema of Zn/Zpn reference point | | +| 2011-03 | - | - | - | - | Update to Rel-10 version (MCC) | 10.0.0 | +| 2012-03 | CT#55 | CP-120043 | 0077 | 2 | SIP Digest over Zh | 11.0.0 | +| 2012-06 | CT#56 | CP-120225 | 0078 | 1 | GBA Digest over Zn | 11.1.0 | +| 2012-12 | CT#58 | CP-120712 | 0083 | - | Introduction of GBA Push within TS 29.109 – Zpn Interface | 11.2.0 | +| | | CP-120752 | 0079 | 1 | USS example | | +| 2013-01 | | | | | Annex numbering corrected | 11.2.1 | +| 2013-03 | CT#59 | CP-130011 | 0084 | 1 | Error codes in Zn and Zpn | 11.3.0 | +| 2013-12 | CT#62 | CP-130601 | 0092 | 1 | Lack of element definitions and wrong references for Zn and Zpn based on Web Services | 11.4.0 | +| 2014-03 | CT#63 | CP-140015 | 0096 | 1 | userIdType and uiccOrMe in requestGbaPushInfoRequest message | 11.5.0 | +| 2014-09 | - | - | - | - | Update to Rel-12 version (MCC) | 12.0.0 | +| 2015-03 | CT#67 | CP-150017 | 0098 | 1 | Authentication scheme Digest-AKA v1-MD5 in MAR | 12.1.0 | +| 2015-06 | CT#68 | CP-150244 | 0099 | 2 | Auth-Session-State in BIR/BIA | 12.2.0 | +| 2015-12 | - | - | - | - | Update to Rel-13 version (MCC) | 13.0.0 | +| 2017-03 | CT#75 | CP-170048 | 0106 | 1 | Update of reference for the Diameter base protocol | 14.0.0 | +| 2017-06 | CT#76 | CP-171041 | 0107 | 1 | Clarification of Zh Multimedia-Authentication-Request command | 15.0.0 | +| 2020-07 | CT#88e | - | - | - | Update to Rel-16 version (MCC) | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29116/1c94fd3cebf58af136144f14160d128e_img.jpg b/marked/Rel-16/29_series/29116/1c94fd3cebf58af136144f14160d128e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2d0c2a1b3d601d18f476e1b6f9c4a96c9a060289 --- /dev/null +++ b/marked/Rel-16/29_series/29116/1c94fd3cebf58af136144f14160d128e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:874d1470788e9cfdb69f60f83ab888e1edba320fc962ff7e157df0e5f5d0b00f +size 9355 diff --git a/marked/Rel-16/29_series/29116/9b1ec0090070bdf52ea28763b8d52477_img.jpg b/marked/Rel-16/29_series/29116/9b1ec0090070bdf52ea28763b8d52477_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3fca8597b1904d2e181e576f8a971a22d8c0fe25 --- /dev/null +++ b/marked/Rel-16/29_series/29116/9b1ec0090070bdf52ea28763b8d52477_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:99695c8db5c21eef83ad2ae75d920ae385a332ac733b98c2d002e0776211ee37 +size 234379 diff --git a/marked/Rel-16/29_series/29116/9e8ebf03cae78f4f81b697548c2d7250_img.jpg b/marked/Rel-16/29_series/29116/9e8ebf03cae78f4f81b697548c2d7250_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4ca93be73f037ab210dd6ed952a47b88b5af91f4 --- /dev/null +++ b/marked/Rel-16/29_series/29116/9e8ebf03cae78f4f81b697548c2d7250_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7ce841271ff3c21e6c2265170b7f82d9247b7e09b388b8f99ff4edf46a7a886e +size 225076 diff --git a/marked/Rel-16/29_series/29116/raw.md b/marked/Rel-16/29_series/29116/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..85a2eafa754f155d141a3ec519d86d9628c075cf --- /dev/null +++ b/marked/Rel-16/29_series/29116/raw.md @@ -0,0 +1,3320 @@ + + + + +Error! No +text of + +Error! No text of specified style in +document. + +# Contents + +| | | +|-----------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions, symbols and abbreviations..... | 7 | +| 3.1 Definitions..... | 7 | +| 3.2 Abbreviations ..... | 8 | +| 4 xMB reference point ..... | 8 | +| 4.1 Overview ..... | 8 | +| 4.2 Reference model..... | 8 | +| 4.3 Functional elements..... | 9 | +| 4.3.1 BM-SC..... | 9 | +| 4.3.2 Content Provider / Multicast Broadcast Source ..... | 9 | +| 4.4 Procedures over xMB reference point..... | 9 | +| 4.4.1 Introduction ..... | 9 | +| 4.4.2 Authentication Procedures..... | 9 | +| 4.4.3 Authorization Procedures ..... | 10 | +| 4.4.4 Service Management Procedures..... | 10 | +| 4.4.4.1 Create Service..... | 10 | +| 4.4.4.2 Get Service Properties ..... | 10 | +| 4.4.4.3 Update Service Properties..... | 10 | +| 4.4.4.4 Delete Service..... | 10 | +| 4.4.4.5 Service Notifications..... | 10 | +| 4.4.5 Session Management Procedures ..... | 10 | +| 4.4.5.1 Create Session..... | 10 | +| 4.4.5.2 Get Session Properties ..... | 10 | +| 4.4.5.3 Update Session Properties ..... | 10 | +| 4.4.5.4 Delete Session..... | 11 | +| 5 xMB API..... | 11 | +| 5.1 Overview ..... | 11 | +| 5.1.1 Supported Methods..... | 11 | +| 5.1.2 Error Handling ..... | 12 | +| 5.1.3 xMB Entry Point Discovery ..... | 12 | +| 5.1.4 Content type..... | 12 | +| 5.2 Resources ..... | 13 | +| 5.2.1 Services..... | 13 | +| 5.2.1.1 Properties ..... | 13 | +| 5.2.1.2 API Operations ..... | 15 | +| 5.2.1.2.1 Introduction ..... | 15 | +| 5.2.1.2.2 Service Creation ..... | 15 | +| 5.2.1.2.3 Service Modification..... | 15 | +| 5.2.1.2.4 Service Deletion ..... | 17 | +| 5.2.1.2.5 Service Retrieval ..... | 18 | +| 5.2.2 Sessions ..... | 20 | +| 5.2.2.1 Properties ..... | 20 | +| 5.2.2.2 API Operations ..... | 33 | +| 5.2.2.2.1 Introduction ..... | 33 | +| 5.2.2.2.2 Session Creation..... | 33 | +| 5.2.2.2.3 Session Modification..... | 34 | +| 5.2.2.2.4 Session Deletion..... | 36 | +| 5.2.2.2.5 Session Retrieval..... | 37 | +| 5.2.3 Reports..... | 39 | +| 5.2.3.1 Properties ..... | 39 | +| 5.2.3.2 API Operations ..... | 40 | +| 5.2.3.2.1 Introduction ..... | 40 | +| 5.2.3.2.2 Report Retrieval ..... | 40 | +| 5.2.4 Notifications ..... | 44 | + +| | | | +|-------------------------------|--------------------------------------------------------------------------------|-----------| +| 5.2.4.1 | Properties ..... | 44 | +| 5.2.4.2.1 | Introduction ..... | 46 | +| 5.2.4.2.2 | Notification Retrieval..... | 46 | +| 6 | User Plane Procedures ..... | 47 | +| 6.1 | Introduction ..... | 47 | +| 6.2 | File Session ..... | 47 | +| 6.2.1 | General ..... | 47 | +| 6.2.2 | Push Mode ..... | 47 | +| 6.2.3 | Pull Mode ..... | 48 | +| 6.3 | Application Session..... | 48 | +| 6.3.1 | General ..... | 48 | +| 6.3.2 | Push Mode ..... | 48 | +| 6.3.3 | Pull Mode ..... | 49 | +| 6.4 | RTP Streaming ..... | 49 | +| 6.5 | Transport ..... | 49 | +| 7 | Security ..... | 50 | +| 7.1 | Overview ..... | 50 | +| 7.2 | Authentication & Authorization..... | 50 | +| 8 | Notification Push to the Content Provider ..... | 50 | +| 8.1 | Introduction ..... | 50 | +| 8.2 | Notification Post..... | 50 | +| 9 | Feature negotiation..... | 51 | +| 9.1 | General ..... | 51 | +| 9.2 | HTTP custom headers ..... | 52 | +| 9.2.1 | 3gpp-Optional-Features ..... | 52 | +| 9.2.2 | 3gpp-Required-Features..... | 52 | +| 9.2.3 | 3gpp-Accepted-Features ..... | 53 | +| 10 | Using Common API Framework ..... | 53 | +| 10.1 | General ..... | 53 | +| 10.2 | Security..... | 53 | +| Annex A (informative): | Call Flows..... | 55 | +| A.1 | Introduction..... | 55 | +| A.2 | xMB Procedure example for Live DASH services (MBMS Broadcast only) ..... | 55 | +| A.3 | xMB Procedure example for Live DASH services (with Service Continuity)..... | 58 | +| A.4 | xMB Procedure example for File Delivery Services (without File Schedule) ..... | 58 | +| Annex B (normative): | JSON Schema ..... | 62 | +| Annex C (informative): | Change history..... | 81 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 1 Scope + +The present document describes the REST-based protocol for the xMB reference point between the Content Provider and the BM-SC. The xMB reference point and related stage 2 protocol procedures are defined in 3GPP TS 23.246 [2] and in 3GPP TS 26.346 [3]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.246: "Multimedia Broadcast/Multicast Service (MBMS) Architecture and Functional Description". +- [3] 3GPP TS 26.346: "Multimedia Broadcast/Multicast Service (MBMS); Protocols and Codecs". +- [4] IETF RFC 5246: "The Transport Layer Security (TLS) Protocol". +- [5] Void. +- [6] IETF RFC 7231: "Hypertext transfer protocol (HTTP/1.1): Semantics and Content". +- [7] 3GPP TS 33.210: "3G security; Network Domain Security (NDS); IP network layer security". +- [8] IETF RFC 7235: "Hypertext Transfer Protocol (HTTP/1.1): Authentication" +- [9] IETF RFC 4918, "HTTP Extensions for Web Distributed Authoring and Versioning (WebDAV)". +- [10] 3GPP TS 26.234, "Transparent end-to-end Packet-switched Streaming Service (PSS); Protocols and codecs". +- [11] IETF RFC 3711, "The Secure Real-time Transport Protocol (SRTP)". +- [12] IETF RFC 4347, "Datagram Transport Layer Security". +- [13] Void +- [14] Void. +- [15] Void. +- [16] Void. +- [17] Void. +- [18] 3GPP TS 26.247: "Transparent end-to-end Packet-switched Streaming Service (PSS); Progressive Download and Dynamic Adaptive Streaming over HTTP (3GP-DASH)". +- [19] IETF RFC 3926: "FLUTE - File Delivery over Unidirectional Transport". +- [20] 3GPP TS 29.061: "Interworking between the Public Land Mobile Network (PLMN) supporting packet based services and Packet Data Networks (PDN)". +- [21] 3GPP TS 26.347: "MBMS URLs and APIs". + +- [22] Open API Initiative, "OpenAPI 2.0 Specification", . +- [23] 3GPP TS 23.285: "Architecture Enhancements for V2X services". +- [24] 3GPP TS 33.246: "3G Security; Security of Multimedia Broadcast/Multicast Service (MBMS)". +- [25] 3GPP TS 24.116: "Stage 3 aspects of system architecture enhancements for TV services". +- [26] IETF RFC 2617: "HTTP Authentication: Basic and Digest Access Authentication". +- [27] IETF RFC 5795: "The Robust Header Compression (ROHC) Framework". +- [28] IETF RFC 3095, "Robust Header Compression (ROHC): Framework and four profiles: RTP, UDP, ESP, and uncompressed" +- [29] IETF RFC 6363: "Forward Error Correction (FEC) Framework,". +- [30] Void. +- [31] IETF RFC 1166: "Internet Numbers". +- [32] IETF RFC 5952: "A recommendation for IPv6 address text representation". +- [33] 3GPP TS 26.348, "Northbound Application Programming Interface (API) for Multimedia Broadcast/Multicast Service (MBMS) at the xMB reference point". +- [34] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format".[35] +IETF RFC 7396: "JSON Merge Patch". +- [36] 3GPP TS 23.280, "Common functional architecture to support mission critical services; Stage 2" +- [37] 3GPP TS 24.008: "Mobile radio interface layer 3 specification; Core Network protocols; Stage 3". +- [38] IETF RFC 7232: "Hypertext Transfer Protocol (HTTP/1.1): Conditional Requests". +- [39] 3GPP TS 23.222: "Common API Framework for 3GPP Northbound APIs; Stage 2". +- [40] 3GPP TS 29.222: "Common API Framework for 3GPP Northbound APIs; Stage 3". +- [41] 3GPP TS 33.122: "Security Aspects of Common API Framework for 3GPP Northbound APIs". +- [42] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +**Content Provider:** Entity/Entities which supplies/supply content in the form of streaming media or non-real-time (NRT) files to be delivered to UEs over the 3GPP network, via MBMS Bearer and/or unicast bearer services. Also referred to in this document as the Multicast Broadcast Source. The Content Provider may reside either inside or outside the operator's network. + +**Service:** One of the resource types exposed by the RESTful xMB API and operated on by a Content Provider using HTTP methods. It corresponds to a Content Provider's service offering for delivery over the MBMS network to UEs. Each service instance created over the xMB API maps to an MBMS User Service as specified by 3GPP TS 26.346 [3]. The delivery of the contents of a created service is performed during one or more sessions associated with that service. + +**Session:** One of the resource types exposed by the RESTful xMB API and operated on by a Content Provider using HTTP methods. It represents one or more time intervals during which the MBMS Bearer is active for the transmission of service contents from the BM-SC to the UE. Each session instance, besides the activity times, may contain various + +properties pertaining to transport, media and application level information (session type, session state, data rate, permitted delay, user plane ingestion mode, targeted delivery area, reporting parameters, identification of content components delivered during the session, etc.). + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|--------|-------------------------------------------------------------| +| ARP | Allocation and Retention Priority | +| API | Application Programming Interface | +| BM-SC | Broadcast Multicast Service Center | +| CAPIF | Common API Framework | +| CDN | Content Delivery Network | +| CP | Content Provider | +| DASH | Dynamic Adaptive Streaming over HTTP | +| FEC | Forward Error Correction | +| FLUTE | File Delivery over Unidirectional Transport | +| GBR | Guaranteed Bitrate | +| HTTP | HyperText Transfer Protocol | +| IS | Initialization Segment | +| JSON | JavaScript Object Notation | +| MPD | Media Presentation Description | +| MSA | MBMS Service Area | +| PKI | Public Key Infrastructure | +| PSK | Pre-Shared Key | +| REST | Representational State Transfer | +| ROHC | Robust Header Compression | +| QCI | QoS Class Identifier | +| QoS | Quality of Service | +| SACH | Service Announcement Channel | +| SAF | Service Announcement Function | +| SLA | Service Level Agreement | +| TLS | Transport Layer Security | +| TMGI | Temporarily Mobile Group Identity | +| TSI | Transport Session Identifier | +| URI | Universal Resource Identifier | +| WebDAV | Web Distributed Authoring and Versioning | +| V2X | Vehicle-to-Everything | + +# 4 xMB reference point + +## 4.1 Overview + +## 4.2 Reference model + +The xMB reference point resides between the BM-SC and the Content Provider as depicted in Figure 4.2.1. Control- and user-plane procedures are operated over the xMB-C and xMB-U reference points, respectively. The overall xMB reference model is depicted in subclause 4.1 of 3GPP TS 26.348 [33]. + +![Diagram of the xMB reference point showing the BM-SC and Content Provider/Multicast Broadcast Source connected by two reference points: xMB-C (control plane) and xMB-U (user plane).](1c94fd3cebf58af136144f14160d128e_img.jpg) + +``` + +graph LR + BM-SC[BM-SC] <--> |xMB-C| CP[Content Provider/ +Multicast Broadcast Source] + BM-SC <--> |xMB-U| CP + +``` + +Diagram of the xMB reference point showing the BM-SC and Content Provider/Multicast Broadcast Source connected by two reference points: xMB-C (control plane) and xMB-U (user plane). + +Figure 4.2.1 xMB reference point + +For the V2X Localized User Plane supported feature, the reference model in Annex B.3 of 3GPP TS 23.285 [23] applies. + +## 4.3 Functional elements + +### 4.3.1 BM-SC + +The complete functionality of the BM-SC is defined in 3GPP TS 26.346 [3]. In the context of the xMB reference point, the BM-SC represents the peer endpoint to the Content Provider in supporting all procedures on the xMB interface. + +In addition to the functions defined in 3GPP TS 26.346 [3], the BM-SC may support, for V2X services, the V2X Localized User Plane procedures as defined in 3GPP TS 23.285 [23] subclause 5.4.2.2 for receiving Local MBMS information from the Content Provider acting as a V2X Application Server. + +### 4.3.2 Content Provider / Multicast Broadcast Source + +The functional role of the Content Provider is defined in subclause 4.4.1a of 3GPP TS 26.346 [3]. Using the xMB reference point, a Content Provider/Multicast Broadcast Source may provide media, as well as service descriptions and control data, to the BM-SC to set up and manage MBMS User Service(s) from the BM-SC to MBMS clients (the latter is not depicted in Figure 4.2.1). + +In addition, the Content Provider which acts as a V2X Application Server may support V2X Localized User Plane procedures as defined in 3GPP TS 23.285 [23] subclause 5.4.2.2 for requesting the BM-SC to activate an MBMS bearer for Local MBMS based MBMS data delivery. + +The content provider may also be a mission critical service provider (3GPP TS 23.280 [36]) which is arranging MC Services to Mission Critical Organizations and may require additional control of the resource allocation (QoS, coverage area). + +## 4.4 Procedures over xMB reference point + +### 4.4.1 Introduction + +All procedures that operate across the xMB reference point, as specified in subclause 5 of 3GPP TS 26.348 [33], are summarized in the following subclauses. + +### 4.4.2 Authentication Procedures + +Authentication procedures shall be performed via (D)TLS as specified by 3GPP TS 33.246 [24]. The Content Provider shall act as the (D)TLS client and the BM-SC as the (D)TLS server when the Content Provider wants to provision new services or manage existing services. Similarly, the BM-SC shall act as the client when the BM-SC wishes to send reports and notifications to the Content Provider. All of the following procedures require the authentication procedure to be completed successfully. + +### 4.4.3 Authorization Procedures + +The authorization procedure of the Content Provider towards the BM-SC may be based on the (D)TLS connection established as part of the authentication procedure (see subclause 4.4.2). In that case, the BM-SC shall check if the Content Provider who sent a request over an authenticated (D)TLS connection is authorized to send that specific request. See subclause 7.2 for further details. + +The authorization procedure of the BM-SC towards the Content Provider to allow pushing notifications to the Content Provider may be based on the (D)TLS connection established as part of the authentication procedure (see subclause 4.4.2). In that case, the Content Provider shall check if the BM-SC who sent the notification over an authenticated (See subclause 7.2 for further details)(D)TLS connection is authorized to send that specific notification. + +### 4.4.4 Service Management Procedures + +#### 4.4.4.1 Create Service + +This procedure is used by the Content Provider to create a service at the BM-SC and negotiate the supported features for the created service. The Content Provider shall use HTTP POST for this purpose. A successfully created service is associated with a resource identifier which is used by the Content Provider to discover, update and delete the service. + +#### 4.4.4.2 Get Service Properties + +This procedure is used by the Content Provider to obtain the service properties from the BM-SC. The Content Provider shall use HTTP GET for this purpose. + +#### 4.4.4.3 Update Service Properties + +This procedure is used by the Content Provider for updating the service properties at the BM-SC. The Content Provider shall use HTTP PUT or HTTP PATCH, corresponding to complete or partial update of service properties, respectively, for this purpose. + +#### 4.4.4.4 Delete Service + +This procedure is used by the Content Provider to terminate the service at the BM-SC. The Content Provider shall use HTTP DELETE for this purpose. + +#### 4.4.4.5 Service Notifications + +This procedure is used by the BM-SC to send service related notifications to the Content Provider. + +### 4.4.5 Session Management Procedures + +#### 4.4.5.1 Create Session + +This procedure is used by the Content Provider to create a session for a previously created service at the BM-SC. The Content Provider shall use HTTP POST for this purpose. A successfully created session is associated with a resource identifier which is used by the Content Provider to discover, update and delete the session. + +#### 4.4.5.2 Get Session Properties + +This procedure is used by the Content Provider to obtain the session properties of a service from the BM-SC. The Content Provider shall use HTTP GET for this purpose. + +#### 4.4.5.3 Update Session Properties + +This procedure is used by the Content Provider for updating the session properties of a session at the BM-SC. The Content Provider shall use HTTP PUT or HTTP PATCH, corresponding to complete or partial update of session properties, respectively, for this purpose. + +If the V2X Localized User Plane feature is supported, the Content Provider may wish to update the session properties for Local MBMS based MBMS data delivery. If so, and the BM-SC decides to use the Local MBMS information, the BM-SC shall use the received BM-SC IP address and port for user plane data delivery. + +NOTE: The Local MBMS information is pre-configured in the Content Provider. At reception of such information, the BM-SC will further send the M1 interface information (e.g. MBMS eNB multicast address and GW source specific multicast address) to the MBMS-GW as specified in 3GPP TS 29.061 [20]. + +If the MCExtension feature is supported, the content provider acting as a mission critical service provider may include: + +- additional properties for resource allocation control (*mc-extension* in table 5.2.2.1-1); and +- specific semantic and syntax for the geographical area (subclause 5.4.7 of 3GPP TS 26.348 [33]). + +#### 4.4.5.4 Delete Session + +This procedure is used by the Content Provider to terminate a session of a service at the BM-SC. The Content Provider shall use HTTP DELETE for this purpose. + +# 5 xMB API + +## 5.1 Overview + +The xMB API is a RESTful API that allows Content Providers to provision broadcast services over 3GPP networks and subsequent ingestion of service content for distribution using eMBMS. The xMB API defines a set of resources and the related procedures for the creation and management of broadcast services and sessions are described in subclause 5.2. The corresponding JSON schema for the representation of the resources and operations defined by the xMB API is provided in its complete form in Annex B. The syntax follows the rules defined by the OpenAPI specification [22]. + +### 5.1.1 Supported Methods + +The xMB API follows the RESTful design principles. All operations SHALL be performed using HTTP 1.1 (IETF RFC 7231 [6]) over TLS (3GPP TS 33.246[24]). + +Table 5.1.1-1 gives a summary of the supported HTTP methods and their applicability on a per resource basis. + +**Table 5.1.1-1: Summary of supported HTTP methods of xMB API** + +| HTTP Method | CRUD | Resource | PATH | +|-------------|---------|--------------|--------------------------------------------------------------------------------------| +| POST | Create | Service | /xmb/v1.0/services | +| | | Session | /xmb/v1.0/services/{service-res-id}/sessions | +| GET | Read | Service | /xmb/v1.0/services/{service-res-id}/sessions/{session-res-id} | +| | | Session | /xmb/v1.0/services/{service-res-id}/sessions/{session-res-id} | +| | | Report | /xmb/v1.0/reports?query
or
/xmb/v1.0/reports/{report-res-id} | +| | | Notification | /xmb/v1.0/notifications?query
or
/xmb/v1.0/notifications/{notification-res-id} | +| PUT | Replace | Service | /xmb/v1.0/services/{service-res-id} | +| | | Session | /xmb/v1.0/services/{service-res-id}/sessions/{session-res-id} | +| PATCH | Modify | Service | /xmb/v1.0/services/{service-res-id} | +| | | Session | /xmb/v1.0/services/{service-res-id}/sessions/{session-res-id} | +| DELETE | Delete | Service | /xmb/v1.0/services/{service-res-id} | +| | | Session | /xmb/v1.0/services/{service-res-id}/sessions/{session-res-id} | + +### 5.1.2 Error Handling + +The xMB API shall use the HTTP status codes to indicate any errors that might occur in the processing of operations on xMB resources. Unless defined otherwise, the HTTP status codes shall be interpreted as specified in IETF RFC 7231 [6]. API operations that are not successfully handled shall not leave the resource at an undefined state. The response should provide sufficient information for a human operator to understand and locate the error. + +API operations that do not follow the security procedures defined in section 7 shall be rejected without any impact on the resources. + +Errors may also happen during the content ingestion and shall be notified to the Content Provider in a timely manner depending on the severity of the error. + +### 5.1.3 xMB Entry Point Discovery + +The Content Provider shall be able to discover the entry point to the xMB interface by one of the following methods: + +- It is provided with the URL that serves as the entry point for the xMB-C interface; +- It acquires that entry point URL from DNS resolution of the following Fully Qualified Domain Name (FQDN): + +.mcc.pub.3gppnetwork.org>, + +in which case the Content Provider shall build the following URL for the entry point of the xMB interface: + +.mcc.pub.3gppnetwork.org/xmb/v1.0/>. + +### 5.1.4 Content type + +The bodies of HTTP request and successful HTTP responses shall be encoded in JSON format (see IETF RFC 8259 [34]). + +The MIME media type that shall be used within the related Content-Type header field is "application/json", as defined in IETF RFC 8259 [34]. + +JSON object used in the HTTP PATCH request shall be encoded according to "JSON Merge Patch" (IETF RFC 7396 [35]) but within the related Content-Type header field the MIME media type shall be signalled as "application/json". + +NOTE: In this Release of the specification only MIME media type "application/json" is supported. + +## 5.2 Resources + +### 5.2.1 Services + +The Content Provider shall configure services at the BM-SC using the REST API methods over two resources managed at the BM-SC. + +Table 5.2.1-1 summarizes different resources for provisioning and managing services at the BM-SC. + +**Table 5.2.1-1: Resources for managing services at BM-SC** + +| Resource Name | Resource Type | Description | +|---------------|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| service | Instance resource | Represents a single service resource. The Content Provider can provision or modify a single service at the BM-SC by invoking REST API requests to this service resource at the BM-SC. | +| services | Collection Resource | Represents a collection of service resources. | + +#### 5.2.1.1 Properties + +Each service resource described in Table 5.2.1-1 has the set of properties described in Table 5.2.1.1-1. The Content Provider shall modify one or more of the properties of the service resource using the API operations described in subclause 5.2.1.2. + +Table 5.2.1.1-1 summarizes different service properties of a service resource. + +**Table 5.2.1.1-1: Properties of service resource** + +| Property Token | JSON Value Type | Defaults | | | Property Description | Applicability (NOTE) | +|-------------------------------------|-----------------|-----------------|-------|----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| | | Child Parameter | Units | Values | | | +| service-id | string | | None | N/A | Identifies the MBMS User Service as defined in subclause 11.2.1.1 of 3GPP TS 26.346 [3] | | +| service-class | string | | None | (operator defined default) | The service class that service belongs to. (see serviceClass element in subclause 11.2.1.2 of 3GPP TS 26.346 [3]). | | +| service-languages | array | | None | Empty list | List of language of the service content. (see serviceLanguage element in subclause 11.2.1.1 of 3GPP TS 26.346 [3]). | | +| service-names | array | | None | Empty list | List of Service Names. (see name element in subclause 11.2.1.1 of 3GPP TS 26.346 [3]) | | +| receive-only-mode | boolean | | None | False | When set to 'true', the Content Provider indicates that the service is a Receive Only Mode service. | | +| service-announcement-mode | string | | None | SACH |

Enumeration of Service Announcement Mode.

Additional service announcement modes may be added in the future.

  • - "SACH": BM-SC performs the service announcement for the current service using the SACH channel (cf. Annex L.2, L3 of 3GPP TS 26.346 [3]).
  • - "Content Provider": BM-SC provides the necessary service access information used by the Content Provider to create the service announcement information.
| | +| consumption-reporting-configuration | object | | | |

The Content Provider wishes to collect consumption reports for the service.

Reporting start and end time: The reporting period with start and end time.

Reporting interval: The interval for which the BM-SC is aggregate the statistics in seconds. (Data type: number; default value: 3600)

| | + +| | | | | | | | +|---------------------------------|--------|--|------|-----|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | | |

Sample percentage: Percentage of users to collect reports from (Data type: number; default value: 10)

The presence of this object indicates the enabling of consumption reporting; if not present, it indicates the disabling of the consumption reporting.

| | +| push-notification-url | string | | None | “” |

The Content Provider provides Notification URL over which it will receive notifications "pushed" by the BM-SC. The Notification procedure is described in subclause 5.3.6. of 3GPP TS 26.348 [33]

| | +| push-notification-configuration | string | | None | All |

If the Content Provider enables push delivery of notifications, then the Content Provider may provide notification filters

This parameter contains a comma separated list of Classes it wishes to receive among the following options: Critical, Warning, Information, Service, Session, or All to get all types of notification.

The notification message shall be sent immediately to the Content Provider upon its availability.

| | + +NOTE: Properties marked with a supported feature are applicable as described in subclause 9. + +The service instance resource with the properties defined above can be found in Annex B. + +#### 5.2.1.2 API Operations + +##### 5.2.1.2.1 Introduction + +Services can be created, updated, or deleted at the BM-SC by the Content Provider, or the properties of a previously created service at the BM-SC may be obtained by the Content Provider, by invoking HTTP methods on the "service" instance resource or the "services" collection resource. + +##### 5.2.1.2.2 Service Creation + +POST /xmb/v1.0/services + +To create a service, the Content Provider shall use the HTTP POST method on the "services" collection resource as follows: + +- the request URI with the "path" part is set to: "/xmb/v1.0/services". +- the Host field is set to the address of the BM-SC + +The Content Provider shall follow the procedures defined in subclause 9 to advertise support of any feature. + +The content body of the POST request shall be empty. Upon receipt of the HTTP POST request from the Content Provider to create a service, the BM-SC will check whether the Content Provider is authenticated and authorized to create services as described in clause 7. If the authorization fails, the BM-SC shall send a 401 message as described in Table 5.2.1.2.2-1. If the authorization is successful, the BM-SC shall create a service with default service property values as described in subclause 5.2.1.1. Upon successful creation of a service, the BM-SC shall respond to the Content Provider with a 201 message indicating that the service is successfully created along with the service resource identifier of the service resource. The service resource identifier is the identifier that uniquely identifies the service. When the Content Provider receives the service resource identifier, it shall use this identifier in subsequent requests to the BM-SC + +to refer to this service. Alternatively, if the creation of service failed, the BM-SC shall send a 403 message to the Content Provider. + +Both the Content Provider and BM-SC shall remember the negotiated features for the lifetime of the service. + +The possible response messages from the BM-SC, depending on whether the POST request is successful or unsuccessful, are shown in Table 5.2.1.2.2-1. + +**Table 5.2.1.2.2-1: Response status code, message, and contents for service creation** + +| Status Code | Message | Contents | +|-------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------|----------------------------------------------------------------------------------------------------------------------------| +| 201 Created | Service created successfully | The BM-SC shall send the service resource identifier of the created service. | +| 401 Unauthorized | Request requires user authentication | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | +| 403 Forbidden | Request cannot be fulfilled | The BM-SC may include optional text to indicate why the request could not be fulfilled | +| 412 Precondition Failed | Request cannot be fulfilled | The precondition given in one or more of the request-header fields evaluated to false when it was tested on the recipient. | +| Note: In addition to the above response codes, the BM-SC can also send appropriate response codes described in IETF RFC 7231 [6] as applicable. | | | + +##### 5.2.1.2.3 Service Modification + +###### 5.2.1.2.3.1 Partial Modification of Service Properties + +PATCH /xmb/v1.0/services/{service-res-id} + +Assuming that a service has been created using the service creation method described in subclause 5.2.1.2.2, partial updating of its properties can be performed by the Content Provider using the HTTP PATCH method on the "service" instance resource as follows: + +- the request URI with the "path" part is set to: "/xmb/v1.0/services/{service-res-id}" +- the Host field is set to the address of the BM-SC +- the Content-Type header field is set to "application/json" +- the body of the message is encoded in JSON format + +The {service-res-id} in the request URI is the service resource identifier of the service as allocated by the BM-SC during service creation. + +The content body of the service modification request shall contain updated partial representation of the service resource. The representation of the service is based on the JSON schema of the service resource as described in subclause 5.2.1.1. Further, one or more properties of the service listed in Table 5.2.1.1-1, with the exception that the value of the properties "id", "service-id", "pull-notification-url" and "receive-only-mode" cannot be modified. + +Upon receipt of the HTTP PATCH request from the Content Provider to update a service, the BM-SC will check whether the Content Provider is authenticated and authorized to update services as described in clause 7. If the authorization fails, the BM-SC shall send a 401 message. If the authorization is successful, the BM-SC shall update the requested service. Upon successful updating of the requested service, the BM-SC shall respond to the Content Provider with a 200 OK message indicating that the service is successfully updated along with the updated service resource. If the service was not found, the BM-SC shall send a 404 Not Found message. If the service cannot be updated, the BM-SC shall send a 403 Forbidden message to the Content Provider. + +The possible response messages from the BM-SC, depending on whether the PATCH request is successful or unsuccessful, are shown in Table 5.2.1.2.3.1-1. + +**Table 5.2.1.2.3.1-1: Response status code, message, and contents for service modification using HTTP PATCH** + +| Status Code | Message | Contents | +|-------------|---------------------------|------------------------------------------------------------| +| 200 OK | The request has succeeded | The BM-SC shall send the service resource that is modified | + +| | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------|-------------------------------------------------------------------------------------| +| 204 No Content | The request has succeeded | None | +| 401 Unauthorized | Request requires user authentication | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | +| 403 Forbidden | Request cannot be fulfilled | The BM-SC may include optional text to indicate why the request could not fulfilled | +| 404 Not Found | Requested resource not found | None | +| Note: In addition to the above response codes, the BM-SC can also send appropriate response codes described in IETF RFC 7231 [6] as applicable. | | | + +###### 5.2.1.2.3.2 Full Modification of Service Properties + +PUT /xmb/v1.0/services/{service-res-id} + +Assuming that a service has been created using the service creation method described in sub clause 5.2.1.2.2, full modification of its properties can be performed by the Content Provider using the HTTP PUT method on the "service" instance resource as follows: + +- the request URI with the "path" part is set to: "/xmb/v1.0/services/{service-res-id}". +- the Host field is set to the address of the BM-SC +- the Content-Type header field is set to "application/json" +- the body of the message is encoded in JSON format + +The {service-res-id} in the request URI is the service resource identifier of the service as allocated by the BM-SC during service creation. + +The content body of the service update request shall contain the updated representation of the service resource. The representation of the service is based on the JSON schema of the service resource as described in subclause 5.2.1.1. Furthermore, when HTTP PUT method is used for updating the service, the Content Provider shall specify the updated values of all the service properties with the exception that the value of the properties "id", "service-id", "pull-notification-url" and "receive-only-mode" cannot be modified. + +Upon receipt of the HTTP PUT request from the Content Provider to update a service, the BM-SC will check whether the Content Provider is authenticated and authorized to update services as described in clause 7. If the authorization fails, the BM-SC shall send a 401 message as described in Table 5.2.1.2.3.2-1. If the authorization is successful, the BM-SC update the requested service. While updating the service representation, the BM-SC shall overwrite the values of all properties of the service being updated with the values provided in the update request. Upon successful update of the requested service, the BM-SC shall respond to the Content Provider with a 200 OK success message indicating that the service is successfully updated along with the updated service resource. If the service was not found, the BM-SC shall send a 404 Not Found message. If the service cannot be updated, the BM-SC shall send a 403 Forbidden message to the Content Provider. + +The possible response messages from the BM-SC, depending on whether the PUT request is successful or unsuccessful, are shown in Table 5.2.1.2.3.2-1. + +**Table 5.2.1.2.3.2-1: Response status code, message, and contents for service modification using HTTP PUT** + +| Status Code | Message | Contents | +|------------------|--------------------------------------|-------------------------------------------------------------------------------------| +| 200 OK | The request has succeeded | The BM-SC shall send the service resource that is modified | +| 204 No Content | The request has succeeded | None | +| 401 Unauthorized | Request requires user authentication | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | + +| | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|----------------------------------------------------------------------------------------| +| 403
Forbidden | Request cannot be fulfilled | The BM-SC may include optional text to indicate why the request could not be fulfilled | +| 404 Not
Found | Requested resource not found | None | +| Note: In addition to the above response codes, the BM-SC can also send appropriate response codes described in IETF RFC 7231 [6] as applicable. | | | + +##### 5.2.1.2.4 Service Deletion + +DELETE /xmb/v1.0/services/{service-res-id} + +To delete a service, the Content Provider shall use the HTTP DELETE method on the "service" instance resource as follows: + +- the request URI with the "path" part is set to: "/xmb/v1.0/services/{service-res-id}" +- the Host field is set to the address of the BM-SC +- the Content-Type header field is set to "application/json" +- the body of the message is encoded in JSON format + +The {service-res-id} in the request URI is the service resource identifier of the service as allocated by the BM-SC during service creation. + +Upon receipt of the HTTP DELETE request from the Content Provider to delete a service, the BM-SC will check whether the Content Provider is authenticated and authorized to delete services as described in clause 7. If the authorization fails, the BM-SC shall send a 401 message as described in Table 5.2.1.2.4-1. If the authorization is successful, the BM-SC shall delete the requested service. Upon successful deletion of requested service, the BM-SC shall respond to the Content Provider with a 200 OK success message indicating that the service is successfully deleted along with the service resource identifier of the service that is deleted. If the service was not found, the BM-SC shall send a 404 Not Found message. If the service cannot be deleted, the BM-SC shall send 403 Forbidden message to the Content Provider. + +The possible response messages from the BM-SC, depending on whether the DELETE request is successful or unsuccessful, are shown in Table 5.2.1.2.4-1. + +**Table 5.2.1.2.4-1: Response status code, message, and contents for service deletion** + +| Status Code | Message | Contents | +|-------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------|----------------------------------------------------------------------------------------| +| 200 OK | The request has succeeded | The BM-SC shall send the service resource identifier of the service that is deleted | +| 204 No Content | The request has succeeded | None | +| 401 Unauthorized | Request requires user authentication | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | +| 403 Forbidden | Request cannot be fulfilled | The BM-SC may include optional text to indicate why the request could not be fulfilled | +| 404 Not Found | Requested resource not found | None | +| Note: In addition to the above response codes, the BM-SC can also send appropriate response codes described in IETF RFC 7231 [6] as applicable. | | | + +##### 5.2.1.2.5 Service Retrieval + +Services can be read when the Content Provider wishes to know the latest representation of the service resource at the BM-SC. + +Retrieval of a specific Service + +###### GET /xmb/v1.0/services/{service-res-id} + +The retrieval of a service shall be performed by the Content Provider using the HTTP GET method on the "service" instance resource as follows: + +- the request URI with the "path" part is set to: "/xmb/v1.0/services/{service-res-id}" +- the Host field is set to the address of the BM-SC + +The {service-res-id} in the request URI is the service resource identifier of the service as allocated by the BM-SC during service creation. + +Upon receipt of the HTTP GET request from the Content Provider, the BM-SC will check whether the Content Provider is authenticated and authorized to read services as described in clause 7. If the authorization fails, the BM-SC shall send a 401 message as described in table 5.2.1.2.5-1. If the authorization is successful, the BM-SC shall respond to the Content Provider with a 200 OK message along with the service information. The response from the BM-SC to the Content Provider shall contain the following: + +- the Content-Type header field is set to "application/json" +- the body of the message is encoded in JSON format + +The content body of this response message shall be the representation of the requested service based on the JSON schema of service resource as described in subclause 5.2.1.1. The properties "service-id", "service-class", and "service-announcement-mode" shall be included in the response to the Content Provider. All other properties of the service instance are optional to be returned to the Content Provider. + +Alternatively, if the service was not found, the BM-SC shall send a 404 Not Found message. If the request cannot be fulfilled, the BM-SC shall send a 403 Forbidden message to the Content Provider. + +The possible response messages from the BM-SC, depending on whether the GET request is successful or unsuccessful, are shown in Table 5.2.1.2.5-1. + +**Table 5.2.1.2.5-1: Response status code, message, and contents for service modification using HTTP GET** + +| Status Code | Message | Contents | +|---------------------|--------------------------------------|-------------------------------------------------------------------------------------------------| +| 200 OK | The request has succeeded | The BM-SC shall send the service representation of the service resource to the Content Provider | +| 401
Unauthorized | Request requires user authentication | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | +| 403
Forbidden | Request cannot be fulfilled | The BM-SC may include optional text to indicate why the request could not be fulfilled | +| 404 Not
Found | Requested resource not found | None | + +Note: In addition to the above response codes, the BM-SC can also send appropriate response codes described in IETF RFC 7231 [6] as applicable. + +###### Retrieval of all Services + +###### GET /xmb/v1.0/services + +The retrieval of all services shall be performed by the Content Provider using the HTTP GET method on the "services" instance resource as follows: + +- the request URI with the "path" part is set to: "/xmb/v1.0/services" +- the Host field is set to the address of the BM-SC + +Upon receipt of the HTTP GET request from the Content Provider, the BM-SC will check whether the Content Provider is authenticated and authorized to read services as described in clause 7. If the authorization fails, the BM-SC shall send a 401 message as described in table 5.2.1.2.5-2. If the authorization is successful, the BM-SC shall respond to the Content Provider with a 200 OK message along with information of all services configured at the BM-SC. The response from the BM-SC to the Content Provider shall contain the following: + +- the Content-Type header field set to "application/json" +- the body of the message encoded in JSON format + +The content body of this response message shall be the representation of the list of all services configured at the BM-SC where each service representation is based on the JSON schema of service resource as described in subclause 5.2.1.1. The properties "service-id", "service-class", and "service-announcement-mode" shall be included for each service representation in the response to the Content Provider. All other properties of the service instance are optional to be returned to the Content Provider. + +Alternatively, if there are no services configured at the BM-SC, the BM-SC shall send message content in the 200 OK message indicating to the Content Provider that there are no services configured at the BM-SC. If the request cannot be fulfilled, the BM-SC shall send a 403 Forbidden message to the Content Provider. + +The possible response messages from the BM-SC, depending on whether the GET request is successful or unsuccessful, are shown in Table 5.2.1.2.5-2. + +**Table 5.2.1.2.5-2: Response status code, message, and contents for service modification using HTTP GET** + +| Status Code | Message | Contents | +|------------------|--------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 200 OK | The request has succeeded | If there are services configured at the BM-SC, the BM-SC shall send the representations of all the configured services to the Content Provider. If there are no services configured at the BM-SC, the BM-SC shall send message content in this message that there are no services configured at the BM-SC | +| 401 Unauthorized | Request requires user authentication | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | +| 403 Forbidden | Request cannot be fulfilled | The BM-SC may include optional text to indicate why the request could not be fulfilled | + +Note: In addition to the above response codes, the BM-SC can also send appropriate response codes described in IETF RFC 7231 [6] as applicable. + +### 5.2.2 Sessions + +The Content Provider shall configure sessions at the BM-SC using the RESTful API methods over two resources managed at the BM-SC. + +Table 5.2.2-1 summarizes different resources for provisioning and managing sessions at the BM-SC. + +**Table 5.2.2-1: Resources for managing sessions at BM-SC** + +| Resource Name | Resource Type | Description | +|---------------|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Session | Instance resource | Represents a single session resource. The Content Provider can provision or modify a single session at the BM-SC by invoking REST API requests to this session resource at the BM-SC. | +| Sessions | Collection Resource | Represents a collection of session resources. | + +Since sessions are configured for each service, the session instance resource or the sessions collection resource are referenced through a particular service. + +#### 5.2.2.1 Properties + +Each session resource described in Table 5.2.2-1 has the set of properties described in Table 5.2.2.1-1. The Content Provider shall modify one or more of the properties of the session resource using the API operations described in subclause 5.2.2.2 + +Table 5.2.2.1-1 summarizes the different properties of a session resource. + +**Table 5.2.2.1-1: Properties of session resource** + +| Property Token | JSON Value Type | Defaults | | Parameter Description | Applicability (NOTE) | +|--------------------------------|---------------------|--------------------------------------------|----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| | | | | | | +| session-start | number | UTC Date timestamp (with second precision) | Session creation date + 1h | Time at which the MBMS Bearer become active. | | +| session-stop | number | UTC Date timestamp (with second precision) | Session start date + 1h | Time at which the MBMS bearer becomes inactive. | | +| max-ingest-bitrate | number | kbps | 0 | This requested bitrate by the Content Provider for content ingestion at the BM-SC, which excludes FEC overhead and transport overhead. The BM-SC calculates the MBMS Bearer bitrate from its value, considering overhead like FEC and other transport overheads. The session bitrate is always larger than or equal to the payload bitrate | | +| max-delay | number | ms | -1 | Specifies the maximum delay the MBMS System should add, i.e. from the time a packet is received by the BM-SC to the time when the packet should be received by the MBMS client. | | +| session-state | string | None | Idle | The BM-SC may automatically change the state of the session.

Possible states: "Session Idle", "Session Announced", "Session Active". | | +| service-announcement-starttime | number | UTC Date timestamp (with second precision) | None | When present, the wall-clock time at which the BM-SC shall start service announcement. If absent, the BM-SC may automatically start service announcement when it has all the data needed to perform such service announcement. | | +| geographical-area |
> string | None | Empty list | Geographical area to which the service is to be provided, via either unicast or MBMS bearers. The BM-SC derives the MBMS service area and the SAI list corresponding to the geographical area as provided by the Content Provider.

The Geographical Area contains list of string.

If the mc-extension property is present and the MCExtension feature is | | + +| | | | | | | +|-----------------------------|--------|------|-------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | |

supported, the content of each string follows the format specified by subclause 5.4.7 of 3GPP TS 26.348 [33].

Else, the content of each string item is left to the business agreement between the Content Provider and the Operator.

| | +| qoe-reporting-configuration | object | | |

The Content Provider wishes to collect QoE reports for the session. The Content Provider can supply a list of QoE metric configurations where each metric configuration shall contain:

Metric name: Name of QoE metric

Metric type: Type of metric

Reporting interval: The interval at which the BM-SC should periodically aggregate and report the statistics to the Content Provider.

Sample percentage: Percentage of users to collect reports from

Start time: Start time of report collection

End time: End time of report collection

If this configuration is included, the QoE reporting configuration shall be applied only for this session., and the Content Provider is requesting override of service level configuration for this session by this configuration.

Note: SA4 should define the list of parameters for qoe-reporting-configuration. SA4 shall also indicate if service level qoe-reporting configuration can be applied.

| | +| session-type | string | None | Files |

The Session Type represents the method used by the Content Provider in providing content to the BM-SC (via xMB-U). The BM-SC shall select the appropriate delivery method from the Session Type.

Valid values: "Streaming", "Files", "Application", "Transport-Mode"

When the Session Type is set to "Streaming", the BM-SC expects a Streaming type input (RTP), and the format shall compliant to MBMS streaming (as defined in 3GPP TS 26.346 [3]).

| | + +| | | | | | | +|--------------------|---------------------|------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------| +| | | | |

When the Session Type is set to "Files", the BM-SC expects generic files as input. The files can be provided either by on-request pull interactions or continuous push ingest.

When the Session Type is set to "Application", then the ingest method depends on the application service description.

When the Application Service Description corresponds to DASH, the BM-SC expects an MPD and optionally one or more Initialization Segments. The content is assumed to be 3GP-DASH compliant (as defined by 3GPP TS 26.247 [18]). The BM-SC may either pull the Media Segments from the Content Provider or the Content Provider will continuously push Media Segments to the BM-SC.

When the Session Type is set to "Transport-Mode", the BM-SC provides transport of data/TV content in a transparent manner. The Content Provider may provide some properties for the MBMS distribution.

The Session Type shall be extensible to include other session types.

| | +| max-cid | integer | none | none |

integer indicating the MAX_CID parameter for the compressor (see IETF RFC 5795 [27]). The value for the LARGE_CID parameter (usage of short CID representation or large CID representation) shall be deducted from MAX_CID as follows:

If MAX_CID > 15 then
LARGE_CIDS = TRUE else
LARGE_CIDS = FALSE.

When header compression applies, the "max-cid" property shall be provided together with "header-compression" property.

| ROHC | +| header-compression |
> object | none | none |

Requests the BM-SC to enable ROHC (see IETF RFC 5795 [27] and IETF RFC 3095 [28]) on the input flow. The object consists of:

  • - "ipv4addr": String identifying an IPv4 address formatted in the "dotted decimal" notation as defined in IETF RFC 1166 [31].
  • - "ipv6addr": String identifying an IPv6 address formatted according to clause 4 of IETF RFC 5952 [32]. The mixed
| ROHC | + +| | | | | | | +|----------------------|---------|------|-------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------| +| | | | |

IPv4 IPv6 notation according to clause 5 of IETF RFC 5952 shall not be used.

- "port": integer between 0 and 65535 identifying a UDP or TCP port

- "periodicity": a number denoting the target periodicity for ROHC full header packets in units of seconds

- "profile": integer denoting the applicable ROHC profile (see IETF RFC 5795 [27]). The value is restricted to the 0x0001 RTP/UDP/IP profile or the 0x0002 UDP/IP profile, 0x0001 profile applies if omitted.

Either "ipv4addr" or "ipv6addr" shall be included and "port" and "periodicity" may be included.

The BM-SC shall:

  1. 1. apply the procedures in IETF RFC 5795 [27] and in IETF RFC 3095 [28] to provide header compression to downlink IP packets and possibly higher protocol layers within the user plane data;
  2. 2. use the ROHC profile requested in the "profile" property for downlink packet which belongs to any of the flows listed in this property;
  3. 3. use the 0x0000 uncompressed profile for any downlink packet which does not belong to any of the flows listed in this property; and
  4. 4. use the ROHC unidirectional mode (see IETF RFC 3095 [28]) without ROHC segmentation (see IETF RFC 5795 [27]).
| | +| fec | string | none | none |

Requests the BM-SC to perform FEC (see IETF RFC 6363 [29]) protection of the input flow when transmitting over the MBMS channel. The string shall include an SDP description of FEC framework configuration information (see subclause 5.5 of IETF RFC 6363 [29]) formatted according to subclause 8A.5 of 3GPP TS 26.346 [3].

| FEC | +| resource-sharing-ind | boolean | none | false |

The resource sharing indication.

When present and set to "true", it implies the current transmission resources can be shared with other sessions.

| ResourceSharing | + +| | | | | | | +|------------------------------------------|--------|----------|-------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------| +| | | | | Note that other sessions will use the same Max Bitrate, Geographical Area and (in case of MC Services) QoS-Information. | | +| resource-sharing-url | string | none | none |

The resource sharing id.

When present in the session modification request, the value of the field identifies an existing xMB session resource URL (as specified in table 5.1.1-1) to share the transmission, where Max Bitrate, Geographical Area and (in case of MC Services) QoS-Information are re-used.

Note that the Max Bitrate, Geographical Area and (in case of MC Services) QoS-Information cannot be changed since the values from the original session will be used.

| ResourceSharing | +| session-announcement-mode | string | – None – | Other |

Represents the session announcement mode. The session announcement mode is either "Content Provider" or "SACH", with the following behavior:

"Content Provider": The BMSC generates the session parameters and provides those to the Content Provider.

"SACH": In this case, the session announcement is done by the MBMS system through the SACH. (see Annex L.2, L.3 of 3GPP TS 26.346 [3]).

Additional modes may be added in future releases.

Only applicable if the Session Type is set to "Transport-Mode"

| Transport | +| userplane-session-description-parameters | object | | |

This property provides information to the BM-SC on where and how to access the user plane content from the content provider, and comprises one or more of the following components:

Type: the type of the content associated with the target resource, for example the Internet Media Type of the resource as identified by an HTTP/S URL. An "embedded" type is defined, which indicates that the xMB-U user plane parameters are embedded in the User Plane Parameters object described below.

Access URL: A URL that enables the access to and possibly control of the ingest session. The URL may, for example, be an RTSP URL, a reference to an SDP that

| Transport | + +| | | | | | | +|--|--|--|--|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | |

describes a multicast stream, or an HTTP/S URL to retrieve an already-packaged MPEG2-TS stream.

User Plane Parameters: When the Type is set to "embedded", the Content Provider shall provide an object to the BM-SC which contains the session description.

If this property is set to Forward-only, the object may contain a ready-made Session Description and the indication of a single xMB-U reception UDP port. When a Session Description is present, the BM-SC shall use it for Service Announcement.

If this property is set to Proxy, the object shall contain a Session Description template and a list of the transmitted UDP flows to be forwarded on the established MBMS bearer for the session. For each list entry, the content provider shall indicate whether a) this UDP flow is directly associated with a media description entry in the Session Description Template – i.e., an "m=" line is present in the template and which contains a port field, or b) this UDP flow is related to a media description entry – e.g., it corresponds to an RTCP flow affiliated with the RTP flow as described by the RTP/AVP profile). If the flow is directly associated with a media description entry, then the BM-SC shall modify the port field of the media description entry in the Session Description Template. If the flow is related to a media description entry, then the BM-SC shall simply forward the flow onto a port whose value is equal to the port of the related media session plus an offset.

Note the BM-SC may get input on session properties from the content provider, e.g. bitrate, depending on the ingest session.

| | +|--|--|--|--|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| + +| | | | | | | +|-----------------------------------------|--------|----------|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------| +| userplane-delivery-mode-configuration | string | – None – | Forward-only |

This property defines how the session needs to be delivered to the application, i.e. it basically establishes the delivery mode.

Mode Enumeration: Specifies the delivery mode.

Forward-only: The BM-SC receives complete IP Multicast packets for to be forwarded. The Content Provider will create the IP multicast packets.

Proxy: The BM-SC proxies the incoming UDP payloads to the outgoing UDP payloads. The BM-SC will create the IP multicast packets.

Only applicable if the Session Type is set to "Transport-Mode".

| Transport | +| delivery-session-description-parameters | string | | |

The contents of this property depend on the setting of the Session Announcement Mode property. If Session Announcement Mode is set to "Content Provider", then at minimum the following session parameters shall be provided by the BM-SC:

TMGI of the MBMS Bearer

For Receive Only Mode service, the TMGI shall be allocated from the range specified in 3GPP TS 24.116 [25]. Note that additional session parameters may be provided, based on the configuration options of the delivery method set to "Transport-Mode".

Only applicable if the Session Type is set to "Transport-Mode".

| Transport | +| sdp-url | string | – None – | "" |

A URL to the SDP that describes the streaming session between the Content Provider and the BM-SC, which will be used for BM-SC ingestion of the streaming session via xMB-U. The SDP shall include the RTSP links for every media session as part of the "a=control" attribute to enable RTSP control of the session. The SDP shall also contain the required bitrate for each of the media sessions.

The content shall conform to the constraints of this specification.

Only applicable if the Session Type is set to "Streaming".

| RTPStreaming | + +| | | | | | | +|---------------------|--------|-----------|----------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------| +| time-shifting | number | second | 0 | Indicates if and for how long time shifting access to the content (using unicast) may be provided for this session.

If not set (so defaulted to 0), there shall be no time shifting access.

Only applicable if the Session Type is set to "Streaming". | RTPStreaming | +| application-service | string | MIME type | application/dash+xml | Internet Media Type of the Application Service

Only applicable if the Session Type is set to "Application". | ApplicationPush, ApplicationPull | +| ingest-mode | string | None | "Push" when Session Type is set to "Application"

"Pull" when Session Type is set to "Files" | The ingest mode enumerates how resources are ingested into the BM-SC via xMB-U.

When the Session Type is set to "Application":

Pull: The BM-SC pulls the resources as described by the application entry point document.

Push: The Content Provider pushes resources. The BM-SC needs to provide a push URL.

In case of DASH, resources are Media Segments:

Pull: The BM-SC pulls the Media Segments as described by the Segment availability start time from a DASH MPD.

Push: The Content Provider pushes Media Segments, so that the Media Segment is available on the BM-SC according to Segment availability start time. The BM-SC needs to provide a push URL.

When the Session Type is set to "Files":

Push: The Content Provider shall push the file to the BM-SC that will immediately process and deliver as soon as it is ready. The BM-SC may be configured to ignore all files that are pushed before session active time, or store them. In case of Push mode, the BM-SC shall provide back to the Content Provider the URL the Content Provider shall use to push the files. | ApplicationPush, ApplicationPull, FilePush, FilePull | + +| | | | | | | +|--------------------------------|---------|------|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------| +| | | | | Pull: In this case, the Content Provider provides the resource location from which the BM-SC will fetch the file. The Content Provider may tell the BM-SC when to start fetching the file. | | +| application-
entrypoint-url | string | None | "" |

The application entry point refers to an MPD when Application Service Description pertains to DASH.

When the Ingest Mode is set to Push, the MPD URL refers to a DASH MPD which should be fetched, optionally conditioned, and then inserted into Service Announcement.

When the Ingest Mode is set to Pull, then the BM-SC will fetch the Segments using unicast.

Note that if not set to a valid URL, the session will not be started.

| ApplicationPush,
ApplicationPull, | +| push-url | string | None | "" |

When the Session Type is set to "Application":

A resource locator for ingesting Media Segments using HTTP via xMB-U. The Content Provider may create additional sub-resources using WebDAV procedures.

This is a read-only property managed by the BM-SC and only present when Ingest Mode is set to Push

This property is mandatory if the Session type is set to "Application" and Ingest Mode is set to Push.

When the Session Type is set to Files:

A resource locator for ingesting content using HTTP via xMB-U.

This is a read-only property managed by the BM-SC and only present when Ingest Mode is set to Push.

| ApplicationPush,
FilePush | +| unicast-
delivery | boolean | None | False |

Indicator whether the content is also available for unicast retrieval.

Only applicable if the Session Type is set to "Application".

| ApplicationPush,
ApplicationPull, | +| Components | array | None | Empty list | List of components of the application, which are recommended to be made available on MBMS Bearers. | ApplicationPush,
ApplicationPull, | + +| | | | | | | +|-----------|-------|--|--|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------| +| | | | | In case of DASH, each component is identified by a representation identifier.

Only applicable if the Session Type is set to "Application". | | +| file-list | array | | |

List of files to be sent.

In the Push mode, the file list is not used since the BM-SC will monitor its push folder and send the files it receives on a first-come first-served basis.

In Pull mode, the file list contains the following information per file entry:

file URL: the URL to the file the BM-SC will use to fetch the content

file display URL: The URL to the file as seen by the UE

byte-range (optional): If present and set to "true", indicates that the HTTP(S) URL given in the file display URL parameter can be used for Byte-Range-Based file repair (subclause 9.3 of 3GPP TS 26.346 [3]) otherwise file display URL parameter should not be used for Byte-Range-Based file repair

e-tag (optional): represents the value of the ETag as defined in IETF RFC 7232 [38] which may also serve as the version identifier for the file in the Byte-Range-Based file repair requests. The ETag should only be supplied by the 3rd party content provider if it is expected that it is different from the one provided over xMB-U when fetching the file.

file earliest fetch time: The BM-SC shall fetch the file no sooner than this UTC timestamp. If absent, then the file shall be present on the Content Provider server and the BM-SC may fetch it at a time of its choosing.

file latest fetch time: The BM-SC shall fetch the file no later than this UTC timestamp. If absent, then the file shall be present on the Content Provider server and

| FilePull,

FileRepair (NOTE 2) | + +| | | | | | | +|--|--|--|--|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | |

the BM-SC may fetch it at a time of its choosing.

file size (optional): The Content Provider may provide the precise or a file size estimate as input. The BM-SC may update the file size once it has started to fetch the file.

file status: Enumeration stating the state of the file. Possible values are pending, fetched, prepared, transmitting, sent.

Target reception completion time (on the MBMS Client): hint on the deadline by which target time the file should be completely received by the UE. The BM-SC should schedule and order the transmission accordingly.

Keep Updated Interval: The BM-SC checks the file resources with the given interval for changes.

Unicast availability: Indication that the file is also available for unicast retrieval by the application at a Content Provider server whose location is given by the HTTP(S) URL corresponding to the value of "file display URL".

File repetition: The number of times the file shall be sent on the session (a value of 1 means the file shall be sent only once). This counter shall be decreased by one each time the file has been transmitted. When the counter reaches zero the file will cease to be delivered. The BM-SC may send FEC instead of source information.

Note that the expected behavior is that the BM-SC will first send all files in the order of the File List, then decrement the file repetition counter for each file, and subsequently retransmit the list again (only files with counter > 0 are transmitted). This is repeated until all repetitions are completed, or the session stop time has elapsed, whichever event occurring first.

Periodic update interval: When present, it is an indication that

| | +|--|--|--|--|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| + +| | | | | | | +|---------------------------------|--------|------|----|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | | | | this file of the list of files is expected to be periodically updated, and the value of this parameter represents the nominally expected time interval between successive updates of this file. This parameter is a signal to the BM-SC to deliver the file and its updates as a Datacasting service. From its value, the BM-SC will choose the delivery mode ('scheduled-and-periodic' or 'back-to-back'), and set the associated interval and @mode values in controlling the transmission of the Datacasting service. | | +| file-delivery-manifest-url | string | None | "" | Alternative to the file list for describing file properties and delivery requirements. The resource may additionally describe scheduling information for the file.

Only applicable if the Session Type is set to Files. | FilePush, FilePull | +| display-base-url | string | None | "" | When ingest mode is set to Push, the Base URL as seen by the UE. | FilePush | +| sa-file-url | string | None | "" | When the service announcement mode is set to "Content provider", the BM-SC returns the URL of the SA file announcing the session. The BM-SC shall follow the profile 1c (Annex L.3 of 3GPP TS 26.346 [3]) | SaProfile | +| local-mbms-delivery-information | object | | | The Content Provider may request the BM-SC to activate an MBMS bearer for local MBMS based MBMS data delivery. If so, the Content Provider shall provide:

MBMS eNB IPv4 multicast address:
Contains the M1 (transport) plane IPv4 destination multicast address used by MBMS-GW for IP multicast encapsulation of application IP multicast datagrams.

MBMS eNB IPv6 multicast address:
Contains the M1 (transport) plane IPv6 prefix of destination multicast address used by MBMS-GW for IP multicast encapsulation of application IP multicast datagrams.

MBMS GW IPv4 SSM address:
Contains the value of MBMS- | LocalMBMS | + +| | | | | | | +|--------------|--------|------|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| | | | |

GW's IPv4 address for Source Specific Multicasting.

MBMS GW IPv6 SSM address: Contains the value of MBMS-GW's IPv6 address for Source Specific Multicasting.

Common Tunnel Endpoint Identifier: Indicates the common tunnel endpoint identifier of MBMS GW for user plane.

BM-SC IPv4 address: Indicates the destination IPv4 address of the BM-SC for the reception of user plane data via the xMB-U interface.

BM-SC IPv6 address: Indicates the destination IPv6 address of the BM-SC for the reception of user plane data via the xMB-U interface.

BM-SC port: Indicates the destination UDP port of the BM-SC for the reception of user plane data via the xMB-U interface.

| | +| group-ids | array | None | Empty list |

This parameter contains a list of group identifiers, applicable if the service-announcement-mode is set to "SACH".

It is used by the BM-SC in the service announcement for identifying UE belonging to a group.

| GroupContentDelivery | +| mc-extension | object | | |

If the MCExtension feature is supported, the Content Provider may request the BM-SC to activate an MBMS bearer with a specific QoS. If so, the Content Provider shall provide the following QoS properties in the session modification operation, to be used by the BM-SC within the QoS-Information AVP during the MBMS Session start procedure (3GPP TS 29.061 [20]):

gbr: Guaranteed bitrate for the MBMS session in unit kbps. The BM-SC shall use this value for the Guaranteed-Bitrate-DL AVP. The difference between the max-ingest-bitrate and gbr can be used by the BM-SC as a budget for FEC.

qci: QoS Class identifier. The BM-SC shall use this value for the QoS-Class-Identifier AVP.

| MCExtension | + +| | | | | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--|--|--|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | |

arp-priority-level: the BM-SC shall use this value for the Priority-Level AVP within the Allocation-Retention-Priority AVP.

arp-pre-emption-capability: the BM-SC shall use this value for the Pre-emption-Capability AVP within the Allocation-Retention-Priority AVP.

arp-pre-emption-vulnerability: the BM-SC shall use this value for the Pre-emption-Vulnerability AVP within the Allocation-Retention-Priority AVP.

If the Content Provider includes the mc-extension property during the session modification operation, the BM-SC shall return the following property in the session retrieval operation:

tmgi: the TMGI of the MBMS session, as returned by the MBMS Session start procedure in 3GPP TS 29.061 [20], the encoding of TMGI is specified in 3GPP TS 24.008 [37], from octet 3 to 8.

| | +|

NOTE 1: Properties marked with a supported feature are applicable as described in subclause 9.
NOTE 2: FileRepair feature is only applicable for byte-range and e-tag properties.

| | | | | | + +The session instance resource with the properties defined above for each session can be found in Annex B. + +#### 5.2.2.2 API Operations + +##### 5.2.2.2.1 Introduction + +Sessions can be created, updated, or deleted at the BM-SC by the Content Provider, or the properties of a previously created session at the BM-SC, may be obtained by the Content Provider by invoking HTTP methods on the “session” instance resource or the “sessions” collection resource. + +##### 5.2.2.2.2 Session Creation + +POST /xmb/v1.0/services/{service-res-id}/sessions + +To create a session, the Content Provider shall use the HTTP POST method on the "sessions" collection resource as follows: + +- the request URI with the "path" part is set to: /xmb/v1.0/services/{service-res-id}/sessions. +- the Host field is set to the address of the BM-SC + +The {service-res-id} in the request URI is the service resource identifier of the service for which the session creation is sought. + +The content body of the session creation request shall be empty. + +Upon receipt of the HTTP POST request from the Content Provider to create a session, the BM-SC will check whether Content Provider is authenticated and authorized to create sessions as described in clause 7. If the authorization fails, the BM-SC shall send a 401 message. If authorization is successful, the BM-SC shall verify that the service already + +exists with the given service resource identifier. If the service with given service resource identifier exists at the BM-SC, the BM-SC shall create the requested session for that service with default session property values described in clause 5.2.2.1. Upon successful creation of requested session, the BM-SC shall respond to the Content Provider with a 201 success message indicating that the session is successfully created along with the session resource identifier of the created session. The session resource identifier is the identifier that uniquely identifies the session within that service. When the Content Provider receives the session resource identifier, it shall use this identifier in subsequent requests to the BM-SC to refer to this session. If the creation of session failed, the BM-SC shall send a 403 message. If the service was not found for which the session creation is sought, the BM-SC shall send a 404 message. + +The possible response messages from the BM-SC, depending on whether the POST request is successful or unsuccessful, are shown in Table 5.2.2.2.2-1. + +**Table 5.2.2.2.2-1: Response status code, message, and contents for session creation** + +| Status Code | Message | Contents | +|------------------|--------------------------------------|----------------------------------------------------------------------------------------| +| 201 Created | Session created successfully | The BM-SC shall send the session resource identifier of the created session. | +| 401 Unauthorized | Request requires user authentication | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | +| 403 Forbidden | Request cannot be fulfilled | The BM-SC may include optional text to indicate why the request could not be fulfilled | + +Note: In addition to the above response codes, the BM-SC can also send appropriate response codes described in IETF RFC 7231 [6] as applicable + +##### 5.2.2.2.3 Session Modification + +Sessions created using the session creation methods described in subclause 5.2.2.2.2 can be updated when the Content Provider wishes to modify the session properties. + +###### 5.2.2.2.3.1 Partial Modification of Session Properties + +PATCH /xmb/v1.0/services/{service-res-id}/sessions/{session-res-id} + +Assuming that a session has been created using the session creation method described in subclause 5.2.2.2.2, partial updating of its properties can be performed by the Content Provider by using the HTTP PATCH method on the “session” instance resource as follows: + +- the request URI with the "path" part is set to: /xmb/v1.0/services/{service-res-id}/sessions/{session-res-id} +- the Host field is set to the address of the BM-SC +- the Content-Type header field is set to "application/json" +- the body of the message is encoded in JSON format + +The {service-res-id} in the request URI is the service resource identifier of the service whose session is being modified. + +The {session-res-id} in the request URI is the session resource identifier of the session that is being modified. + +The content body of the session update request shall contain updated partial representation of the session resource. The representation of the session is based on the JSON schema of session resource as described in subclause 5.2.2.1. Furthermore, one or more properties of the session listed in table 5.2.2.1-1 with the exception that the session properties "id", "session-state", "qoe-report-url", "delivery-session-description-parameters" and "push-url" cannot be modified. + +Upon receipt of the HTTP PATCH request from the Content Provider to update a session, the BM-SC will check whether the Content Provider is authenticated and authorized to update sessions as described in clause 7. If the authorization fails, the BM-SC shall send a 401 message as described in table 5.2.2.2.3.1-1. If the authorization is successful, the BM-SC shall verify that the service already exists with the given service resource identifier, and a session already exists with the given session resource identifier. If both of them exist, BM-SC shall update the session as requested for that service. Upon successful update of the requested session, the BM-SC shall respond to the Content Provider with a 200 success message indicating that the session is successfully updated along with the updated session resource. As alternative to the 200 OK message, BM-SC may send a 204 No Content success message without any message content to the Content Provider. If the session cannot be updated, the BM-SC shall send a 403 message. If the + +session is not found or if the service was not found for which the session creation is sought, the BM-SC shall send a 404 message. + +The possible response messages from the BM-SC, depending on whether the PATCH request is successful or unsuccessful, are shown in Table 5.2.2.2.3.1-1. + +**Table 5.2.2.2.3.1-1: Response status code, message, and contents for session modification using HTTP PATCH** + +| Status Code | Message | Contents | +|------------------|--------------------------------------|----------------------------------------------------------------------------------------| +| 200 OK | The request has succeeded | The BM-SC shall send the session resource that is modified | +| 204 No Content | The request has succeeded | None | +| 401 Unauthorized | Request requires user authentication | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | +| 403 Forbidden | Request cannot be fulfilled | The BM-SC may include optional text to indicate why the request could not be fulfilled | +| 404 Not Found | Requested resource not found | None | + +Note: In addition to the above response codes, the BM-SC can also send appropriate response codes described in IETF RFC 7231 [6] as applicable. + +###### 5.2.2.2.3.2 Full Modification of Session Properties + +PUT /xmb/v1.0/services/{service-res-id}/sessions/{session-res-id} + +Assuming that a session has been created using the session creation method described in subclause 5.2.2.2.2, full update of its properties can be performed by the Content Provider using the HTTP PUT method on the "session" instance resource as follows: + +- the request URI with the "path" part is set to: /xmb/v1.0/services/{service-res-id}/sessions/{session-res-id} +- the Host field is set to the address of the BM-SC +- the Content-Type header field is set to "application/json" +- the body of the message is encoded in JSON format + +The {service-res-id} in the request URI is the service resource identifier of the service whose session is being modified. + +The {session-res-id} in the request URI is the session resource identifier of the session that is being modified. + +The content body of the session update request shall contain updated representation of the session resource. The representation of the session is based on the JSON schema of session resource as described in subclause 5.2.2.1. Furthermore, when the HTTP PUT method is used for updating the service, the Content Provider shall specify the updated values of all the session properties with the exception that the session properties "id", "session-state", "qoe-report-url", "delivery-session-description-parameters" and "push-url" cannot be modified. + +Upon receipt of the HTTP PUT request from the Content Provider to update a session, the BM-SC will check whether the Content Provider is authenticated and authorized to update sessions as described in clause 7. If the authorization is unsuccessful, the BM-SC shall send a 401 message as described in table 5.2.2.2.3.2-1. If the authorization is successful, the BM-SC shall verify that the service already exists with the given service resource identifier, and a session already exists with the given session resource identifier. If both of them exist, BM-SC shall update the session as requested for that service. While updating session representation, the BM-SC shall overwrite the values of all properties of the session being updated with the values from provided in the update request. Upon successful update of the requested session, the BM-SC shall respond to the Content Provider with a 200 success message indicating that the session is successfully updated along with the updated session resource. As an alternative to 200 OK success message, BM-SC may send a 204 No Content success message without any message content to the Content Provider. If the session cannot be updated, the BM-SC shall send a 403 message. If the session is not found or if the service was not found for which the session creation is sought, the BM-SC shall send a 404 message. + +The possible response messages from the BM-SC, depending on whether the PUT request is successful or unsuccessful, are shown in Table 5.2.2.2.3.2-1. + +**Table 5.2.2.2.3.2-1: Response status code, message, and contents for session modification using HTTP PUT** + +| Status Code | Message | Contents | +|------------------|--------------------------------------|----------------------------------------------------------------------------------------| +| 200 OK | The request has succeeded | The BM-SC shall send the session resource that is modified | +| 204 No Content | The request has succeeded | None | +| 401 Unauthorized | Request requires user authentication | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | +| 403 Forbidden | Request cannot be fulfilled | The BM-SC may include optional text to indicate why the request could not be fulfilled | +| 404 Not Found | Requested resource not found | None | + +Note: In addition to the above response codes, the BM-SC can also send appropriate response codes described in IETF RFC 7231 [6] as applicable. + +##### 5.2.2.2.4 Session Deletion + +DELETE /xmb/v1.0/services/{service-res-id}/sessions/{session-res-id} + +To delete a session, the Content Provider shall use the HTTP DELETE method on the "session" instance resource as follows: + +- the request URI with the "path" part is set to: /xmb/v1.0/services/{service-res-id}/sessions/{session-res-id} +- the Host field is set to the address of the BM-SC + +The {service-res-id} in the request URI is the service resource identifier of the service whose session is being deleted. + +The {session-res-id} in the request URI is the session resource identifier of the session that is being deleted. + +Upon receipt of the HTTP DELETE request from the Content Provider to delete a session, the BM-SC will check whether the Content Provider is authenticated and authorized to delete services as described in clause 7. If the authorization is unsuccessful, the BM-SC shall send a 401 message as described in table 5.2.2.2.4-1. If the authorization is successful, the BM-SC shall verify that the service already exists with the given service resource identifier and a session exists with the given session resource identifier. If both of them exist, BM-SC shall delete the requested session for the given service. Upon successful deletion of requested session, the BM-SC shall respond to the Content Provider with a 200 success message indicating that the session is successfully deleted along with the service resource identifier and the session resource identifier. As an alternative to the 200 OK success message, BM-SC may send a 204 No Content success message without any message content to the Content Provider. If the session cannot be deleted, the BM-SC shall send a 403 message. If the session is not found or if the service was not found for which the session creation is sought, the BM-SC shall send a 404 message. + +The possible response messages from the BM-SC, depending on whether the DELETE request is successful or unsuccessful, are shown in Table 5.2.2.2.4-1. + +**Table 5.2.2.2.4-1: Response status code, message, and contents for session deletion** + +| Status Code | Message | Contents | +|------------------|--------------------------------------|-------------------------------------------------------------------------------------| +| 200 OK | The request has succeeded | The BM-SC shall send the session resource identifier of the session that is deleted | +| 204 No Content | The request has succeeded | None | +| 401 Unauthorized | Request requires user authentication | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | + +| | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|----------------------------------------------------------------------------------------| +| 403
Forbidden | Request cannot be fulfilled | The BM-SC may include optional text to indicate why the request could not be fulfilled | +| 404 Not
Found | Requested resource not found | None | +| Note: In addition to the above response codes, the BM-SC can also send appropriate response codes described in IETF RFC 7231 [6] as applicable. | | | + +##### 5.2.2.2.5 Session Retrieval + +Sessions can be read when the Content Provider wishes to know the latest representation of the session resources at the BM-SC. + +Retrieval of a specific Session of a specific Service + +GET /xmb/v1.0/services/{service-res-id}/sessions/{session-res-id} + +The retrieval of a session shall be performed by the Content Provider using the HTTP GET method on the "session" instance resource as follows: + +- the request URI with the "path" part is set to: /xmb/v1.0/services/{service-res-id}/sessions/{session-res-id} +- the Host field is set to the address of the BM-SC + +The {service-res-id} in the request URI is the service resource identifier of the service as allocated by the BM-SC during service creation. + +The {session-res-id} in the request URI is the session resource identifier of the session that is being retrieved. + +Upon receipt of the HTTP GET request from the Content Provider, the BM-SC will check whether the Content Provider is authenticated and authorized to read services and sessions as described in clause 7. If the authorization fails, the BM-SC shall send a 401 message as described in table 5.2.2.2.5-1. If the authorization is successful, the BM-SC shall respond to the Content Provider with a 200 OK message and shall include the session resource representation of the session corresponding to the given service to the Content Provider. The response from the BM-SC to the Content Provider shall contain the following: + +- the Content-Type header field set to "application/json" +- the body of the message encoded in JSON format + +The content body of this response message shall be the representation of the session configured at the BM-SC for the given service where the session representation is based on the JSON schema of session resource as described in subclause 5.2.2.1. The properties "session-start", "session-stop", "max-ingest-bitrate", "session-state", "geographical-area", "session-type", "session-announcement-mode", "session-type", "userplane-delivery-mode-configuration", "sdp-url", "application-service-description", "ingest-mode", "application-entrypoint-url", and "unicast-delivery" shall be included in the response to the Content Provider. All other properties of the session instance are optional to be returned to the Content Provider. + +Alternatively, if the service was not found or if the session was not found, the BM-SC shall send a 404 Not Found message. If the request cannot be fulfilled, the BM-SC shall send 403 Forbidden message to the Content Provider. + +The possible response messages from the BM-SC, depending on whether the GET request is successful or unsuccessful, are shown in Table 5.2.2.2.5-1. + +**Table 5.2.2.2.5-1: Response status code, message, and contents for service modification using HTTP GET** + +| Status Code | Message | Contents | +|---------------------|--------------------------------------|-------------------------------------------------------------------------------------------------| +| 200 OK | The request has succeeded | The BM-SC shall send the session representation of the session resource to the Content Provider | +| 401
Unauthorized | Request requires user authentication | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | +| 403
Forbidden | Request cannot be fulfilled | The BM-SC may include optional text to indicate why the request could not be fulfilled | + +| | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|------| +| 404 Not Found | Requested resource not found | None | +| Note: In addition to the above response codes, the BM-SC can also send appropriate response codes described in IETF RFC 7231 [6] as applicable. | | | + +###### Retrieval of all Sessions of a Service + +###### GET /xmb/v1.0/services/{service-res-id}/sessions + +The retrieval of all sessions of a service shall be performed by the Content Provider using the HTTP GET method on the "sessions" instance resource as follows: + +- the request URI with the "path" part is set to: /xmb/v1.0/services/{service-res-id}/sessions +- the Host field is set to the address of the BM-SC + +The {service-res-id} in the request URI is the service resource identifier of the service as allocated by the BM-SC during service creation. + +Upon receipt of the HTTP GET request from the Content Provider, the BM-SC will check whether the Content Provider is authenticated and authorized to read services and sessions as described in clause 7. If the authorization fails, the BM-SC shall send a 401 message as described in table 5.2.2.2.5-2. If the authorization is successful, the BM-SC shall respond to the Content Provider with a 200 OK message. If there are sessions configured at the BM-SC for the corresponding service, the BM-SC shall send the representation of the list of all session resources configured at the BM-SC for that service along with the 200 OK message. If there are no sessions configured at the BM-SC for that service, the BM-SC shall send message content in the 200 OK message indicating to the Content Provider that there are no sessions configured at the BM-SC for that service. + +The response from the BM-SC to the Content Provider shall contain the following: + +- the Content-Type header field set to "application/json" +- the body of the message encoded in JSON format + +The content body of this response message shall be the representation of list of sessions configured at the BM-SC for the given service where each session representation is based on the JSON schema of session resource as described in subclause 5.2.2.1. The properties "session-start", "session-stop", "max-ingest-bitrate", "session-state", "geographical-area", "session-type", "session-announcement-mode", "session-type", "userplane-delivery-mode-configuration", "sdp-url", "application-service-description", "ingest-mode", "application-entrypoint-url", and "unicast-delivery" shall be included for each session representation in the response to the Content Provider. All other properties of the session instance are optional to be returned to the Content Provider. + +Alternatively, if the request cannot be fulfilled, the BM-SC shall send 403 Forbidden message to the Content Provider. If the service was not found, the BM-SC shall send a 404 Not Found message + +The possible response messages from the BM-SC, depending on whether the GET request is successful or unsuccessful, are shown in Table 5.2.2.2.5-2. + +**Table 5.2.2.2.5-2: Response status code, message, and contents for service modification using HTTP GET** + +| Status Code | Message | Contents | +|------------------|--------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 200 OK | The request has succeeded | If there are sessions configured at the BM-SC for that service, the BM-SC shall send the representations of all the configured sessions for that service to the Content Provider. If there are no sessions configured at the BM-SC for that service, the BM-SC shall send message content in this message indicating to the Content Provider that there are no sessions configured at the BM-SC for this service | +| 401 Unauthorized | Request requires user authentication | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | + +| | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|----------------------------------------------------------------------------------------| +| 403
Forbidden | Request cannot be fulfilled | The BM-SC may include optional text to indicate why the request could not be fulfilled | +| 404 Not
Found | Requested resource not found | None | +| Note: In addition to the above response codes, the BM-SC can also send appropriate response codes described in IETF RFC 7231 [6] as applicable. | | | + +### 5.2.3 Reports + +The BM-SC shall send reports to the Content Provider upon request by the Content Provider. Table 5.2.3-1 summarizes different report resources that the BM-SC manages for sending reports to the Content Provider. + +**Table 5.2.3-1: Resources for managing reports at BM-SC** + +| Resource Name | Resource Type | Description | +|---------------|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------| +| Report | Instance resource | Represents a single report resource. The BM-SC can send an individual report to the Content Provider using the report instance resource | +| Reports | Collection Resource | Represents a collection of report resources. | + +Reports can be generated separately for each service or for a session belonging to a particular service. Therefore, a report can be referenced with a given service resource identifier or for a combination of service resource identifier and session resource identifier. + +#### 5.2.3.1 Properties + +Each report resource described in Table 5.2.3-1 has the set of properties described in Table 5.2.3.1-1. The BM-SC shall deliver the reports as indicated by this structure using the API operations described in subclause 5.2.3.2 + +Table 5.2.3.1-1 summarizes different service properties of a service resource. + +**Table 5.2.3.1-1: Resources for managing services at BM-SC** + +| Property Token | JSON Value Type | Parameter Description | +|-----------------------------------------------------------------------------------------------------------------------------|-----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| report-res-id | string | Report resource identifier | +| report-starttime | string | Report collection start time | +| report-endtime | string | Report collection end time | +| report-type | string | Type of report. Three types of reports can be generated by the BM-SC to send to the Content Provider:

Consumption report: Report that provides service consumption information

QoE report: Report that provides detailed QoE information of the content received

File reception report: Report that provides detailed reception information for each file | +| report-url | string | Location of the report from where the Content Provider can retrieve the detailed report. | +| Report | string | Detailed report. This may not be included if report-url is included | +| Note: SA4 to clarify the report types and detail structure of a report that can be sent from BM-SC to the Content Provider. | | | + +The report instance resource with the properties defined above for each report can be found in Annex B. + +#### 5.2.3.2 API Operations + +##### 5.2.3.2.1 Introduction + +The Content Provider can request reports from the BM-SC for a given service or a session belonging to a given service. + +##### 5.2.3.2.2 Report Retrieval + +Reports can be retrieved by the Content Provider for a service or for a session of a given service using HTTP GET method. + +###### Report Retrieval for a Service + +GET /xmb/v1.0/services/{service-res-id}/reports + +The retrieval of reports of a service shall be performed by the Content Provider using the HTTP GET method on the "reports" collection resource as follows: + +- the request URI with the "path" part set to: "/xmb/v1.0/services/{service-res-id}/reports" +- the Host field is set to the address of the BM-SC + +QoE reports however are only available on session level. The {service-res-id} in the request URI is the service resource identifier of the service as allocated by the BM-SC during service creation. + +Upon receipt of a HTTP GET request from the Content Provider to retrieve all the reports of a service, the BM-SC will check whether the Content Provider is authenticated and authorized to request reports for services and sessions configured at the BM-SC as described in clause 7. If the authorization fails, the BM-SC shall send a 401 message as described in Table 5.2.3.2.2-1. If the authorization is successful, the BM-SC shall verify that the service with the given service resource identifier exists at the BM-SC. If the service exists at the BM-SC, the BM-SC shall respond to the Content Provider with a 200 success message along with the service resource identifier and the list of all reports for that service. The response from the BM-SC to the Content Provider shall contain the following: + +- the Content-Type header field set to "application/json" +- the body of the message encoded in JSON format + +The content body of this response message shall be the list of report for that service. Each report in this list shall be based on the JSON schema of report resource as described in subclause 5.2.3.1. + +Alternatively, if the report retrieval request cannot be fulfilled, the BM-SC shall send a 403 message to the Content Provider. If the service for which the report is sought could not be found, the BM-SC shall send a 404 message to the Content Provider. + +The possible response messages from the BM-SC, depending on whether the GET request is successful or unsuccessful, are shown in Table 5.2.3.2.2-1. + +**Table 5.2.3.2.2-1: Response status code, message, and contents for retrieval of all service reports** + +| Status Code | Message | Contents | +|------------------|--------------------------------------|------------------------------------------------------------------------------------------| +| 200 OK | The request has succeeded | The BM-SC shall send the service resource identifier and all the reports for the service | +| 401 Unauthorized | Request requires user authentication | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | +| 403 Forbidden | Request cannot be fulfilled | The BM-SC may include optional text to indicate why the request could not be fulfilled | +| 404 Not Found | Requested resource not found | None | + +Note: In addition to the above response codes, the BM-SC can also send appropriate response codes described in IETF RFC 7231 [6] as applicable. + +###### GET /xmb/v1.0/services/{service-res-id}/reports/{report-res-id} + +The Content Provider can request individual reports of a service if it is aware of the report resource identifiers of that service. A specific report for a service can be retrieved by the Content Provider using the HTTP GET method on the "report" instance resource as follows. + +- the request URI with the "path" part set to: "/xmb/v1.0/services/{service-res-id}/reports/{report-res-id}" +- the Host field is set to the address of the BM-SC + +The {service-res-id} in the request URI is the service resource identifier of the service whose reports are being sought. + +The {report-res-id} in the request URI is the report resource identifier of that service. + +It should be noted that QoE reports are only available on session level. Upon receipt of a HTTP GET request from the Content Provider to retrieve a specific report of a service with report resource identifier, the BM-SC will check whether the Content Provider is authenticated and authorized to request reports for services and sessions configured at the BM-SC as described in clause 7. If the authorization fails, the BM-SC shall send a 401 message as described in Table 5.2.3.2.2-2. If the authorization is successful, the BM-SC shall verify that the service with the given service resource identifier and a report with given report resource identifier exists for that service at the BM-SC. If such report exists at the BM-SC, the BM-SC shall respond to the Content Provider with a 200 success message along with the service resource identifier and the report to the Content Provider. The response from the BM-SC to the Content Provider shall contain the following: + +- the Content-Type header field set to "application/json" +- the body of the message encoded in JSON format + +The content body of this response message shall be the requested report resource for that service whose representation is based on the JSON schema of report resource as described in subclause 5.2.3.1. + +Alternatively, if the report retrieval request cannot be fulfilled, the BM-SC shall send a 403 message to the Content Provider. If the service for which the report is sought could not be found, the BM-SC shall send a 404 message to the Content Provider. + +The possible response messages from the BM-SC, depending on whether the GET request is successful or unsuccessful, are shown in Table 5.2.3.2.2-2. + +**Table 5.2.3.2.2-2: Response status code, message, and contents for retrieval of a specific report of a service** + +| Status Code | Message | Contents | +|------------------|--------------------------------------|----------------------------------------------------------------------------------------------| +| 200 OK | The request has succeeded | The BM-SC shall send the service resource identifier and the requested report of the service | +| 401 Unauthorized | Request requires user authentication | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | +| 403 Forbidden | Request cannot be fulfilled | The BM-SC may include optional text to indicate why the request could not be fulfilled | +| 404 Not Found | Requested resource not found | None | + +Note: In addition to the above response codes, the BM-SC can also send appropriate response codes described in IETF RFC 7231 [6] as applicable. + +###### Report Retrieval for a Session of a given Service + +###### GET /xmb/v1.0/services/{service-res-id}/sessions/{session-res-id}/reports + +The retrieval of all the reports of a session for a given service shall be performed by the Content Provider using the HTTP GET method on the "reports" collection resource as follows: + +- the request URI with the "path" part is set to: "/xmb/v1.0/services/{service-res-id}/sessions/{session-res-id}/reports" +- the Host field is set to the address of the BM-SC + +The {service-res-id} in the request URI is the service resource identifier of the service as allocated by the BM-SC during service creation. + +The {session-res-id} in the request URI is the session resource identifier of the session whose reports are being sought. + +Upon receipt of a HTTP GET request from the Content Provider to retrieve all the reports of a session of given service, the BM-SC will check whether the Content Provider is authenticated and authorized to request reports for services and sessions configured at the BM-SC as described in clause 7. If the authorization fails, the BM-SC shall send a 401 message as described in Table 5.2.3.2.2-3. If the authorization is successful, BM-SC shall verify that the service with the given service resource identifier and a corresponding session with the given session identifier exists at the BM-SC. If such a session exists at the BM-SC, the BM-SC shall respond to the Content Provider with a 200 success message along with the list of all reports for that session. If there are no reports for that session at the BM-SC, the BM-SC shall send a 200 OK message with message content indicating that there are no reports for the session at the BM-SC. The response from the BM-SC to the Content Provider shall contain the following: + +- the Content-Type header field set to "application/json" +- the body of the message encoded in JSON format + +The content body of this response message shall be the list of all reports for that session. Each report in this list of reports sent shall be based on the JSON schema of report resource as described in subclause 5.2.3.1. + +Alternatively, if the report retrieval request cannot be fulfilled, the BM-SC shall send a 403 message to the Content Provider. If the session for which the report is sought could not be found, or if the service corresponding to that session could not be found, the BM-SC shall send a 404 message to the Content Provider. + +The possible response messages from the BM-SC, depending on whether the GET request is successful or unsuccessful, are shown in Table 5.2.3.2.2-3. + +**Table 5.2.3.2.2-3: Response status code, message, and contents for retrieval of all reports for a session** + +| Status Code | Message | Contents | +|------------------|--------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 200 OK | The request has succeeded | The BM-SC shall send the service resource identifier, session resource identifier, and all the reports of that session. If there are no reports for that session at the BM-SC, the BM-SC shall include message content indicating that there are no reports for the requested session at the BM-SC. | +| 401 Unauthorized | Request requires user authentication | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | +| 403 Forbidden | Request cannot be fulfilled | The BM-SC may include optional text to indicate why the request could not be fulfilled | +| 404 Not Found | Requested resource not found | None | + +Note: In addition to the above response codes, the BM-SC can also send appropriate response codes described in IETF RFC 7231 [6] as applicable. + +**GET /xmb/v1.0/services/{service-res-id}/sessions/{session-res-id}/reports/{report-res-id}** + +The Content Provider can request individual reports of a given session of a service if it is aware of the report resource identifiers of that session for that service. A specific report for a session can be retrieved by the Content Provider using the HTTP GET method on the "report" instance resource as follows. + +- the request URI with the "path" part is set to: "/xmb/v1.0/services/{service-res-id}/sessions/{session-res-id}/reports/{report-res-id}" +- the Host field is set to the address of the BM-SC + +The {service-res-id} in the request URI is the service resource identifier of the service as allocated by the BM-SC during service creation. + +The {session-res-id} in the request URI is the session resource identifier of the session whose report is being sought. + +The {report-res-id} in the request URI is the report resource identifier that is being sought. + +Upon receipt of a HTTP GET request from the Content Provider to retrieve a specific report for a session of a service, the BM-SC will check whether the Content Provider is authenticated and authorized to request reports for services and sessions configured at the BM-SC as described in clause 7. If the authorization fails, the BM-SC shall send a 401 message as described in Table 5.2.3.2.2-4. If the authorization is successful, the BM-SC shall verify that a report with report resource identifier exists for a session with given session resource identifier whose service identifier is the given service resource identifier at the BM-SC. If such a report exists at the BM-SC, the BM-SC shall respond to the Content Provider with a 200 success message along with the requested report to the Content Provider. The response from the BM-SC to the Content Provider shall contain the following: + +- the Content-Type header field set to "application/json" +- the body of the message encoded in JSON format + +The content body of this response message shall be the requested report resource for that session for the given service and whose representation is based on the JSON schema of report resource as described in subclause 5.2.3.1. + +Alternatively, if the report retrieval request cannot be fulfilled, the BM-SC shall send a 403 message to the Content Provider. If the session for which the report is sought could not be found, or if the service corresponding to that session could not be found, or if the report is not found, the BM-SC shall send a 404 message to the Content Provider. + +The possible response messages from the BM-SC, depending on whether the GET request is successful or unsuccessful, are shown in Table 5.2.3.2.2-4. + +**Table 5.2.3.2.2-4: Response status code, message, and contents for retrieval of a specific report of a session** + +| Status Code | Message | Contents | +|------------------|--------------------------------------|-----------------------------------------------------------------------------------------------------------------------------| +| 200 OK | The request has succeeded | The BM-SC shall send the service resource identifier, session resource identifier, and the requested report for the service | +| 401 Unauthorized | Request requires user authentication | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | +| 403 Forbidden | Request cannot be fulfilled | The BM-SC may include optional text to indicate why the request could not be fulfilled | +| 404 Not Found | Requested resource not found | None | + +Note: In addition to the above response codes, the BM-SC can also send appropriate response codes described in IETF RFC 7231 [6] as applicable. + +### 5.2.4 Notifications + +Notifications can be exchanged via two alternative methods. In the first method, the Content Provider can "pull" the notifications from the BM-SC using HTTP GET method if and when the Content Provider wishes to acquire notification information as described in this subclause. The second method is that the notifications can be "pushed" from the BM-SC to the Content Provider via the push-notification-url as documented in clause 8. + +Table 5.2.4-1 summarizes different notification resources that the BM-SC manages for sending notifications to the Content Provider. + +**Table 5.2.4-1: Resources for managing services at BM-SC** + +| Resource Name | Resource Type | Description | +|---------------|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------| +| Notification | Instance resource | Represents a single notification resource. The BM-SC can send an individual notification to the Content Provider using the notification instance resource | +| Notifications | Collection Resource | Represents a collection of notification resources. | + +#### 5.2.4.1 Properties + +Each notification resource described in Table 5.2.4-1 has the set of properties described in Table 5.2.4.1-1. The BM-SC shall deliver the notifications as indicated by this structure using the API operations described in sub clause 5.2.4.2. + +Table 5.2.4.1-1 summarizes different properties of a notification resource. + +**Table 5.2.4.1-1: Resources for managing services at BM-SC** + +| Property Token | JSON Value Type | Parameter Description | +|---------------------|-----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notification-res-id | string | Notification resource identifier | +| message-class | string |

Enumeration with the following values (may be expanded in the future):
Critical, Warning, Information, Service, Session. The message classes bear the following meaning:

Critical: When some event drastically prevent the proper delivery of content

Warning: When the service can be partially delivered but quality is reduced

Information: When the service is properly delivered but some interesting event occurred

Session/Service: Information about Service/Session related parameters

Table 5.2.4.1-x shows the information that can be notified for each of the message classes.

| +| message-name | string |

Unique identifier of the message. Provides information about the message pertaining to the message-class of the notification

Table 5.2.4.1-2 shows the information that can be notified for each of the message classes and message names.

| +| Message-information | object |

A dictionary of key values containing informations linked to the notification.

Every message-information dictionary shall include the following two keys:

date: The value of this key contains the UTC timestamp (in ms) of the date of the event

source: The value of this key is hierarchical colon separated format of services and sessions with the format "service-resource-identifier session-resource-identifier". If the notification is for a service, only the service-resource-identifier shall be included in this value. An empty value for this key shall represent a system wide notification.

Table 5.2.4.1-x shows the additional key value pairs that can be included in the message-information for each of the message-class and message-name.

| + +Table 5.2.4.1-2 shows the notification details that can be sent for each of the message classes. + +**Table 5.2.4.1-2: Notification Details for different message classes** + +| Message Class | Possible Message Name | Additional Key Value Pairs in message-information dictionary | +|----------------------|------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Critical | network-is-down | None | +| | service-badly-configured | bad-or-missing-parameters: [ , ..] | +| | session-badly-configured | bad-or-missing-parameters: [ , ..] | +| Warning | incoming-bitrate-exceed-session-capacity | incoming-bit-rate: | +| | no-incoming-data | None | +| Information | qoe-report-available | None | +| | consumption-reports-available | None | +| | reception-reports-available | None | +| Service | service-announcement-change | None | +| Session | session-state-change | from-state:

to-state:

where the from state and to state have one of the values in the enumeration:
Session Idle

Session Announced

Session Active

Session Terminated | +| | file-ready-for-transmission | file-url:

file-size:

transmission-size: | +| | file-download-started | file-url: | +| | file-successfully-sent | file-url: | +| | file-fetch-error | file-url:

http-error-code: | + +Note 1: For the message-class "Service", the message-name service-announcement-change applies only when the session-state is in Session Announced or Session Active states. + +Note 2: For the message-class "Session", the message-name file-ready-for-transmission applies only when the session-type is "Files". + +Note 3: For the message-class "Session", the message-name file-download-started applies only when the session-type is "Files". + +Note 4: For the message-class "Session", the message-name file-successfully-sent applies only when the session-type is "Files". + +The notification instance resource with the properties defined in Table 5.2.4.1-1 can be found in Annex B.5.2.4.2 API Operations + +##### 5.2.4.2.1 Introduction + +The Content Provider can request individual service and session level notifications and system-wide notifications from the BM-SC. The notifications are configured by the Content Provider when it creates services and sessions at the BM-SC. Notifications can be retrieved by the Content Provider from the BM-SC at times of its choice and shall use techniques such as long polling to poll the BM-SC for available notifications. Notifications can be retrieved from the BM-SC using HTTP methods on the notifications collection resource. + +##### 5.2.4.2.2 Notification Retrieval + +###### Retrieval of All Notifications + +###### GET /xmb/v1.0/notifications + +The retrieval of all the notifications shall be performed by the Content Provider using the HTTP GET method on the "notifications" collection resource as follows: + +- the request URI with the "path" part is set to: /xmb/v1.0/notifications +- the Host field is set to the address of the BM-SC + +Upon receipt of a HTTP GET request from the Content Provider to retrieve all the notifications, the BM-SC will check whether the Content Provider is authenticated and authorized to request notifications as described in clause 7. If the authorization fails, the BM-SC shall send a 401 message as described in table 5.2.4.2.2-1. If the authorization is successful, the BM-SC shall respond to the Content Provider with a 200 success message along with the list of all notifications. If there are no available notifications at the BM-SC, the BM-SC shall send a 200 OK message with message content indicating that there are no available notifications. The response from the BM-SC to the Content Provider shall contain the following: + +- the Content-Type header field set to "application/json" +- the body of the message encoded in JSON format + +The content body of this response message shall be the list of notifications available at the BM-SC. Each notification in this list shall be based on the JSON schema of notification resource as described in subclause 5.2.4.1. + +Alternatively, if the notification retrieval request cannot be fulfilled, the BM-SC shall send a 403 message to the Content Provider. + +The possible response messages from the BM-SC, depending on whether the GET request is successful or unsuccessful, are shown in Table 5.2.4.2.2-1. + +**Table 5.2.4.2.2-1: Response status code, message, and contents for retrieval of all notifications of service** + +| Status Code | Message | Contents | +|-------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 200 OK | The request has succeeded | The BM-SC shall send all the notifications. If there are no notifications available at the BM-SC, the BM-SC shall include message content indicating that there are no notifications at the BM-SC. | +| 401 Unauthorized | Request requires user authentication | In accordance to conditions as described in IETF RFC 7235 [8] and IETF RFC 7231 [6]. | +| 403 Forbidden | Request cannot be fulfilled | The BM-SC may include optional text to indicate why the request could not fulfilled. | +| Note: In addition to the above response codes, the BM-SC can also send appropriate response codes described in IETF RFC 7231 [6] as applicable. | | | + +Individual notifications can be accessed using HTTP GET method by referencing the "notification-res-id". + +# 6 User Plane Procedures + +## 6.1 Introduction + +The xMB-U user plane procedures cover the transmission of service data between the Content Provider to the BM-SC. Only authorized and authenticated Content Provider sources shall be able to provide user plane data over xMB-U to the BM-SC. The following data transfer modes are supported: + +- File Push: the Content Provider uploads or transmits files to the BM-SC either as soon as they become available, or in advance. +- File Pull: the Content Provider makes files available prior to the session start and at least during the lifetime of a session. The BM-SC will retrieve the files when it needs to deliver them. +- RTP Streaming: the BM-SC establishes an RTSP session to the Content Provider and starts the streaming session to relay media streams. +- Transport: the BM-SC listens on one IP address and one port number to receive UDP packets. + +The details of these procedures are provided in the following subclauses. + +## 6.2 File Session + +### 6.2.1 General + +Provisioning files for file distribution shall use one of the two options in the following subclauses. + +### 6.2.2 Push Mode + +WebDAV as described in IETF RFC 4918 [9] or HTTP v1.1 shall be used over TLS. The Content Provider shall use the PUT method and place the file in the message body of the request associated with the push-url. The Content Provider shall ensure that each file is available at the BM-SC latest at its provided "file-earliest-fetch-time", or if that parameter is not provided, prior to the session start. Potential response codes and their interpretation is provided in Table 6.2.2-1. + +**Table 6.2.2-1: Response status code, message, and contents of File Push mode** + +| Status Code | Message | Contents | +|------------------|-------------------------------------|----------------------------------------------------------------------------------------------------------------------------| +| 201 Created | File pushed successfully | None | +| 401 Unauthorized | Request requires user authorization | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | +| 403 Forbidden | Request cannot be fulfilled | The Content Provider may include optional text to indicate why the request could not be fulfilled, e.g. incorrect URL used | + +### 6.2.3 Pull Mode + +HTTP v1.1 shall be used over TLS in Pull mode. The BM-SC shall use GET method to request each file as defined by the file-list or alternatively by the manifest received from the file-delivery-manifest-url. The BM-SC shall pull each file earliest at its provided "file-earliest-fetch-time", or if that parameter is not provided, prior to the session start. Upon a successful GET, the Content Provider shall provide the requested file in the response body. Potential response codes and their interpretation is provided in Table 6.2.3-1. + +**Table 6.2.3-1: Response status code, message, and contents of File Pull mode** + +| Status Code | Message | Contents | +|------------------|--------------------------------------|-------------------------------------------------------------------------------------| +| 200 OK | The request has succeeded | The Content Provider shall send the requested file in the response body. | +| 401 Unauthorized | Request requires user authentication | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | + +| | | | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|---------------------------------------------------------------------------------------------------| +| 403
Forbidden | Request cannot be fulfilled | The Content Provider may include optional text to indicate why the request could not be fulfilled | +| 404 Not
Found | Requested resource not found | None | +| Note: If "file-delivery-manifest-url" is used, and if there is any error code in response to the request to get the manifest from the provided URL, the session is not started. | | | + +## 6.3 Application Session + +### 6.3.1 General + +Application mode, including DASH service delivery shall use one of the two options in the following subclauses. + +### 6.3.2 Push Mode + +WebDAV as described in IETF RFC 4918 [9] or HTTP v1.1 shall be used over TLS. The Content Provider shall use PUT method with the resource (Application Session) or the Media Segment (DASH) in the message body, to place it at the push-url. The Content Provider shall ensure that each Segment is available at the BM-SC prior to its prescribed Segment availability start time in the MPD, or if that parameter is not provided, prior to the session start. Potential response codes and their interpretation is provided in Table 6.2.2-1. + +**Table 6.3.2-1: Response status code, message, and contents of Application (including DASH) Push mode** + +| Status Code | Message | Contents | +|------------------|-------------------------------------|--------------------------------------------------------------------------------------------------------------------------------| +| 201 Created | File pushed successfully | None | +| 401 Unauthorized | Request requires user authorization | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | +| 403 Forbidden | Request cannot be fulfilled | The Content Provider may include optional text to indicate why the request could not be fulfilled, e.g. incorrect URL was used | + +### 6.3.3 Pull Mode + +HTTP v1.1 shall be used over TLS in Pull mode. For DASH service, the BM-SC shall use the application-entry-point-url to retrieve the MPD. The BM-SC shall use GET method to request the resource, or for DASH, each Media Segment as defined by the MPD. Upon a successful GET, the Content Provider shall provide the requested resource or DASH Segment, respectively, in the response body. Potential response codes and their interpretation is provided in Table 6.2.3-1. + +**Table 6.3.3-1: Response status code, message, and contents of Application (including DASH) Pull mode** + +| Status Code | Message | Contents | +|------------------|--------------------------------------|---------------------------------------------------------------------------------------------------| +| 200 OK | The request has succeeded | The Content Provider shall send the requested resource or DASH Segment in the response body. | +| 401 Unauthorized | Request requires user authentication | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | +| 403 Forbidden | Request cannot be fulfilled | The Content Provider may include optional text to indicate why the request could not be fulfilled | +| 404 Not Found | Requested resource not found | None | + +The BM-SC shall ensure that each DASH Media Segment is fully received prior to its prescribed availability start time, or if not provided, prior to the session start. + +Note: If "application-entry-point-url" is used, and if there is any error code in response to the request to get the MPD from the provided URL, the session shall not be started. + +## 6.4 RTP Streaming + +The Content Provider shall support PSS server functionality according to PSS as described in clause 5.3 of 3GPP TS 26.234 [5]. The streaming session shall be accessible prior to the start of the session. A URL to the SDP file that describes the streaming session between the Content Provider and the BM-SC is provided via the sdp-url, which shall be used for ingesting the streaming session. The SDP shall include the RTSP links for every media session as part of the "a=control" attribute to enable RTSP control of the session. The SDP shall also contain the required bitrate for each of the media sessions. + +When the user plane data is provided via UDP, then SRTP over DTLS as described in 3GPP TS 33.246 [24] shall be used for user plane protection. Establishment of TCP based user plane sessions with PSS is not supported. + +If there is any error retrieving the SDP, the session shall not be started. + +## 6.5 Transport + +For Transport sessions, the BM-SC shall activate the receivers on the indicated IP address and port numbers and shall ensure that firewall and NAT traversal is enabled on these IP addresses and port numbers as defined in the SDP retrieved from the sdp-url. If there is any error retrieving the SDP, the session shall not be started. All traffic shall use DTLS as specified in 3GPP TS 33.246 [24] where both client and server certificates are verified. + +# --- 7 Security + +## 7.1 Overview + +All xMB-C and xMB-U traffic shall only be sent over secured transport channels that are established after successful authentication and authorization as described in subclauses 4.4.2, 4.4.3 and 7.2. + +## 7.2 Authentication & Authorization + +(D)TLS as defined in 3GPP TS 33.246 [24] shall be used to authenticate both ends of the connection. + +The BM-SC shall support at least one of the two following modes for authorization of the Content Provider: *domain-based* or *user-based*, as defined in 3GPP TS 26.348 [33]. Authorization shall be performed after the successful completion of (D)TLS authentication. Domain-based authorization, as defined in Annex O.2 of 3GPP TS 33.246 [24], corresponds to the granting of access rights for service and/or session resource management at a coarse-grained level of the Content Provider, as identified by its administrative domain name in the subject field of the Content Provider certificate. User-based authorization, as defined in Annex O.2 of 3GPP TS 33.246 [24], corresponds to the granting of access rights for service/session resource management at a finer-grain level of an individual representative of the Content Provider. User-based authorization, if performed, shall occur after successful domain based authorization, and is based on HTTP Digest authentication of username and password as specified in IETF RFC 2617 [26]. Detailed specification of the authorization procedure and affiliated mechanisms (for example, pre-establishment of agreement between the Content Provider and mobile operator on domain- and user-based access rights, management of username and password credentials, etc.) are outside the scope of this specification, in order to allow flexibility of implementations which conform to the mechanism described herein. + +Authorization of the BM-SC by the Content Provider shall be based on the same mechanisms as described above for BM-SC authorization of the Content Provider. + +## 7.3 Void + +# 8 Notification Push to the Content Provider + +## 8.1 Introduction + +The Content Provider configures the BM-SC with a push-notification-url and push-notification-configuration property as documented in subclause 5.2.1.1, where the BM-SC can post the notifications to the Content Provider. + +## 8.2 Notification Post + +To send a notification to the Content Provider, the BM-SC shall use HTTP POST as follows: + +- the request URI with the "path" part is set to: {push-notification-url} HTTP/1.1 +- the Host field is set to the address of the Content Provider +- the Content-Type header field is set to "application/json" +- the body of the message is encoded in JSON format + +The {push-notification-url} in the URI above is the push notification URL configured by the Content Provider when the Content Provider configures the service using procedures described in subclause 5.2.1.2. The URL shall be an HTTPS URL. + +The content body of the above POST request shall contain the notification that the BM-SC intends to send to the Content Provider. The representation of the notification is based on the JSON schema of notification resource as described in subclause 5.2.4.1. + +Upon receipt of HTTP POST from the BM-SC to notify the Content Provider about a notification, the Content Provider shall check whether the BM-SC is authenticated and authorized to send notifications to the Content Provider. If the authorization fails, the Content Provider shall send a 401 message to the BM-SC. If the authorization is successful, the Content Provider shall accept the notification request and respond to the BM-SC with a 200 OK message indicating that it has received the notification from the BM-SC. If the request cannot be fulfilled, the Content Provider shall send a 403 Forbidden message to the BM-SC. + +The possible response messages from the Content Provider, depending on whether the notification request is accepted or not, are shown in Table 8.2-1. + +**Table 8.2-1: Response status code, message, and contents for notification request using HTTP POST** + +| Status Code | Message | Contents | +|------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------|------------------------------------------------------------------------------------------------| +| 200 OK | The request has succeeded | None | +| 401
Unauthorized | Request requires user authentication | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | +| 403
Forbidden | Request cannot be fulfilled | The Content Provider may include optional text to indicate why the request could not fulfilled | +| Note: In addition to the above response codes, the Content Provider can also send appropriate response codes described in IETF RFC 7231 [6] as applicable. | | | + +# 9 Feature negotiation + +## 9.1 General + +The xMB API needs to provide a mechanism to advertise required and optional features supported by both the Content Provider and BM-SC for interoperability reasons as the functionality of the xMB interface is augmented. + +Feature negotiation shall take place during service creation procedure and applies for a given instance of service and its related session(s), and any optionally associated reports and/or notifications associated with that service until the service is terminated. The Content Provider shall include in the HTTP POST the set of supported features as follows: + +- if a feature is required for the proper operation of the service, its associated session management, and reporting and/or notification functionality, if applicable, it shall be included within the 3gpp-Required-Features header; +- if a feature is optional for the proper operation of the service, its associated session management, and reporting and/or notification functionality, if applicable, it shall be included within the 3gpp-Optional-Features header. + +The BM-SC shall include, within the 3gpp-Accepted-Features header in the response to the HTTP POST, the set of features it supports in common with the Content Provider. + +If the BM-SC does not support any of the required features advertised by the Content-Provider within the 3gpp-Required-Features header, the BM-SC shall reject the HTTP POST with an HTTP 412 Precondition Failed status code and shall include the commonly supported features with the Content Provider within the 3gpp-Accepted-Features. + +If the BM-SC requires certain features to be supported that are not advertised by the Content Provider, the BM-SC shall reject the HTTP POST with an HTTP 412 Precondition Failed status code and shall include the commonly supported features with the Content Provider within the 3gpp-Accepted-Features and the required features in the 3gpp-required-features. + +If the BM-SC and Content Provider successfully negotiate supported features, the list of commonly supported features shall be applicable for the created service, related session(s) and any optionally associated reports and/or notifications, until it is deleted. Features that are not advertised as supported shall not be used for that service. + +The sender may send information that is related to the supported features. Any unrecognized/supported information shall be ignored by the receiver. + +The table below defines the features applicable to the xMB interface. + +**Table 9.1-1: Features used in xMB Interface** + +| Feature | M/O | Description | +|----------------------|--------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------| +| LocalMBMS | O | The feature indicates the support of Local MBMS data delivery. | +| FilePush | O | The feature indicates the support of File Session Push Mode user plane procedures as specified in subclause 6.2.2 | +| FilePull | O | The feature indicates the support of File Session Pull Mode user plane procedures as specified in subclause 6.2.3 | +| ApplicationPush | O | The feature indicates the support of Application Push Mode user plane procedures as specified in subclause 6.3.2 | +| ApplicationPull | O | The feature indicates the support of Application Pull Mode user plane procedures as specified in subclause 6.3.3 | +| RTPStreaming | O | The feature indicates the support of RTPStreaming user plane procedures as specified in subclause 6.4 | +| Transport | O | The feature indicates the support of Transport user plane procedures as specified in subclause 6.5 | +| FEC | O | This feature indicates the support of applying FEC (see IETF RFC 6363 [29]) to downlink packet streams at the BM-SC. | +| ROHC | O | This feature indicates the support of applying ROHC (see IETF RFC 5795 [27] and IETF RFC 3095 [28]) to downlink packet streams at the BM-SC. | +| GroupContentDelivery | O | This feature indicates the support of delivering contents to a group of UEs. | +| MCExtension | O | This feature indicates the support of the xMB mission critical extension as specified in subclause 4.3.2 and subclause 5.2.2.1. | +| ResourceSharing | O | This feature indicates the support of sharing transmission resource for different MBMS services. | +| SaProfile | O | This feature indicates the support of BM-SC supplied Service Announcement profile. | +| FileRepair | O | This feature indicates the support of content provider supplied file repair function. | +| Feature: | A short name for the feature to which the M/O and description pertain. | | +| M/O: | Indication on whether the implementation of the feature is mandatory ("M") or optional ("O") in this 3GPP Release. | | +| Description: | Textual description of the feature. | | + +NOTE: The base functionality for the xMB interface is defined in the Release-14 version of this specification and a feature is an extension of that functionality. The negotiation of supported features allows interworking between the endpoints of the xMB interface whereby each entity may support all, some, or none of the features that the xMB application can support defined in this specification. Features are defined so that they are independent of each other. Any introduced feature is explicitly defined in this specification. + +## 9.2 HTTP custom headers + +This subclause defines any new HTTP custom headers introduced by this specification. + +### 9.2.1 3gpp-Optional-Features + +This header is used by the Content Provider to advertise the optional features that are supported by the Content Provider. + +The encoding of the header follows the ABNF as defined in IETF RFC 7231 [6]. + +`3gpp-Optional-Features = "3gpp-Optional-Features" ":" 1#token` + +n example is: `3gpp-Optional-Features: feature1, feature2` + +### 9.2.2 3gpp-Required-Features + +This header is used by the Content Provider to announce the mandatory features that must be supported in BM-SC. + +This header is also used by the BM-SC to indicate the missing features that must be supported in Content Provider. + +The encoding of the header follows the ABNF as defined in IETF RFC 7231 [6]. + +`3gpp-Required-Features = "3gpp-Required-Features" ":" 1#token` + +An example is: `3gpp-Required-Features: feature1, feature2` + +### 9.2.3 3gpp-Accepted-Features + +The header is used by the BM-SC to confirm the commonly supported set of features with the Content Provider. + +The encoding of the header follows the ABNF as defined in IETF RFC 7231 [6]. + +`3gpp-Accepted-Features = "3gpp-Accepted-Features" ":" 1#token` + +An example is: `3gpp-Accepted-Features: feature1, feature2` + +# --- 10 Using Common API Framework + +## 10.1 General + +When CAPIF is used with BM-SC, BM-SC shall support the following as defined in 3GPP TS 29.222 [40]: + +- the API exposing function and related APIs over CAPIF-2/2e and CAPIF-3 reference points; +- the API publishing function and related APIs over CAPIF-4 reference point; +- the API management function and related APIs over CAPIF-5 reference point; and +- at least one of the the security methods for authentication and authorization, and related security mechanisms. + +In a centralized deployment as defined in 3GPP TS 23.222 [39], where the CAPIF core function and API provider domain functions are co-located, the interactions between the CAPIF core function and API provider domain functions may be independent of CAPIF-3, CAPIF-4 and CAPIF-5 reference points. + +## 10.2 Security + +When CAPIF is used for external exposure, before invoking the API exposed by the BM-SC, the Content Provider as API invoker shall negotiate the security method (PKI, TLS-PSK or OAuth 2.0) with CAPIF core function and ensure the BM-SC has enough credential to authenticate the Content Provider (see 3GPP TS 29.222 [40], subclause 5.6.2.2 and subclause 6.2.2.2). + +If PKI or TLS-PSK is used as the selected security method between the Content Provider and the BM-SC, upon API invocation, the BM-SC shall retrieve the authorization information from the CAPIF core function as described in 3GPP TS 29.222 [40], subclause 5.6.2.4. + +As indicated in 3GPP TS 33.122 [41], the access to the xMB API may be authorized by means of the OAuth 2.0 protocol (see IETF RFC 6749 [42]), using the "Client Credentials" authorization grant, where the CAPIF core function (see 3GPP TS 29.222 [40]) plays the role of the authorization server. + +NOTE 1: In this release, only "Client Credentials" authorization grant is supported. + +If OAuth 2.0 is used as the selected security method between the Content Provider and the BM-SC, the Content Provider, prior to consuming services offered by the xMB API, shall obtain a "access token" from the authorization server, by invoking the Obtain\_Authorization service, as described in 3GPP TS 29.222 [40], subclause 5.6.2.3.2. + +The xMB API do not define any scopes for OAuth 2.0 authorization. It is the BM-SC responsibility to check whether the Content Provider is authorized to use an API based on the "token". Once the BM-SC verifies the "token", it shall check whether the BM-SC identifier in the "token" matches its own published identifier, and whether the API name in the "token" matches its own published API name. If those checks are passed, the Content Provider has full authority to access any resource or operation for the invoked API. + +NOTE 2: For aforementioned security methods, the BM-SC needs to apply admission control according to access control policies after performing the authorization checks. + +# --- Annex A (informative): Call Flows + +## A.1 Introduction + +The xMB-C procedures are used to create and control MBMS User Services from external sources. An MBMS User Service spans from the BM-SC to the UE and can contain one or more MBMS delivery methods. The provisioning procedure offer functions to create one or more delivery sessions (such as a MBMS Download Delivery session) and allows association of the delivery sessions to MBMS Bearer Services. As part of the xMB-C procedures for MBMS User Services, content ingestion for the user-plane data (i.e. xMB-U) are negotiated. As a result of the xMB-C procedures, the BM-SC can start service announcement and activates MBMS bearer services. + +The Content Provider can query its entitlements, for instance the list of broadcast areas it is authorized to use. + +The Content Provider can query the status of delivery sessions. + +The Content Provider can request reception statistics. + +## --- A.2 xMB Procedure example for Live DASH services (MBMS Broadcast only) + +This procedure example describes the xMB procedures for the delivery of a DASH Live service (see clause 11 of 3GPP TS 26.247 [18] for the specification of DASH Live services), to a single broadcast area. A push interface like WebDAV is used here as the ingestion method for the user-plane data (xMB-U). The push interface is identified by a unique URI. The source of the user plane data (CP Source) are the DASH Media Segments as produced by a Live Encoder / Segmenter and the source pushes each new Segment when it becomes available. The Media Presentation Description (MPD) URL and Initialization Segment (IS) for the Live DASH session is provided to BM-SC during Session creation or in a subsequent update request to the BM-SC. + +![Sequence diagram showing xMB-C and xMB-U procedures for a Live DASH Service. Lifelines: UE, MBMS-GW, BM-SC, CP Control, CP Source. The diagram includes steps for Service Level Agreement, session provisioning, service creation, session creation, service announcement, bearer activation, data delivery, bearer deactivation, and session stop.](9e8ebf03cae78f4f81b697548c2d7250_img.jpg) + +``` + +sequenceDiagram + participant UE + participant MBMS-GW + participant BM-SC + participant CP Control + participant CP Source + + Note over BM-SC: 2: BM-SC admin applies agreed ranges to BM-SC + Note over BM-SC: Provisioning a Live DASH Session + + Note over BM-SC: Creating a Service + BM-SC->>CP Control: 4: HTTP POST + CP Control-->>BM-SC: 5: HTTP 201 CREATED + BM-SC->>CP Control: 6: HTTP GET + CP Control-->>BM-SC: HTTP 200 OK + BM-SC->>CP Control: 7: HTTP PUT/PATCH + CP Control-->>BM-SC: HTTP 200 OK + + Note over BM-SC: Creating a Session + BM-SC->>CP Control: 8: HTTP POST + CP Control-->>BM-SC: 9: HTTP 201 CREATED + BM-SC->>CP Control: 10: HTTP GET + CP Control-->>BM-SC: HTTP 200 OK + BM-SC->>CP Control: 11: HTTP PUT/PATCH + CP Control-->>BM-SC: HTTP 200 OK + + BM-SC->>UE: 12: Do service announcement + Note right of MBMS-GW: (when all data present) + + Note over MBMS-GW: MBMS Bearer is activated + MBMS-GW->>BM-SC: 13: MBMS Session Start + BM-SC-->>MBMS-GW: Ok + BM-SC->>CP Control: 14: Notification + + Note over MBMS-GW: User Plane Data (DASH Segments) + MBMS-GW->>UE: 15: User Plane Data (DASH Segments) + + Note over MBMS-GW: MBMS Bearer is deactivated + MBMS-GW->>BM-SC: 16: MBMS Session Stop + BM-SC-->>MBMS-GW: Ok + BM-SC->>CP Control: 17: Notification + +``` + +Sequence diagram showing xMB-C and xMB-U procedures for a Live DASH Service. Lifelines: UE, MBMS-GW, BM-SC, CP Control, CP Source. The diagram includes steps for Service Level Agreement, session provisioning, service creation, session creation, service announcement, bearer activation, data delivery, bearer deactivation, and session stop. + + v5.4 + +Figure A.2-1: xMB-C and xMB-U Procedures for a Live DASH Service + +- 1: The operator and the Content Provider agree on a Service Level Agreement (SLA), which entitles the Content Provider to use the MBMS system (in accordance to some rules) for content delivery. For instance, the SLA can include day/time ranges, during which the Content Provider can distribute its content. The SLA can also include geographical areas in which the Content Provider is allowed to distribute its content. The SLA also includes target bitrates and likely definitions of tolerable losses per service. +- 2: The BM-SC administrators (operator) apply the agreed ranges. This can imply the provisioning of additional Service Areas, and other system related configurations. + +The following steps describe Content Provider provisioning of a single Live DASH session in a single broadcast area. + +- 3: The Content Provider authenticates itself as authorized user. The Content Provider can only see those configurations, sessions and services which belong to the Content Provider. +- 4: The Content Provider creates a new Service. Optionally, the Content Provider may provide properties for the service like service class, service languages, service names, notification configuration as well as consumption reporting configuration. The Content Provider can select whether the Content Provider or the operator distributes service announcement by providing a list of Service Announcement Channel (SACH, as defined in Annex L.2 / L.3 of 3GPP TS 26.346 [3]) services used for operator-driven service announcement. + +NOTE 1: BM-SC derives the required UE capabilities from the provided service and session properties. + +- 5: Upon successful service creation by the BM-SC, the BM-SC will provide a unique id for the service resource which is expected to be used by the Content Provider for subsequent requests. +- 6: The Content Provider retrieves the current service properties. The unique resource id of the service are provided by the Content Provider as input to the BM-SC. The BM-SC responds with the service properties. +- 7: The Content Provider updates service properties. The unique resource id of the service and some or all service properties are provided by the Content Provider as input to the BM-SC +- 8: The Content Provider creates a session for the previously created service. The unique resource id of the service are provided by the Content Provider as input to the BM-SC. Optionally, the Content Provider may provide common session properties such as maximum ingestion bitrate (excluding any FEC redundancy and transport overhead), scheduling information (start time, stop time), QoE Reporting configuration and session type (set to Application) as input. DASH specific session properties provided as input by the Content Provider include MIME-type of MPD fragment (here, set to application/dash+xml), Application Entry Point URL (here, the MPD URL), xMB-U ingest mode (push/pull), Unicast Delivery Indicator, etc. + +NOTE 2: BM-SC allocates the following parameters for the session description of the MBMS User Service: TMGI, FLUTE IP Multicast Address, UDP Port and TSI (see IETF RFC 3926 [19]). + +NOTE 3: BM-SC derives the SAI list for the MBMS Service Area from Geographical Area provided in Content Provider request and from PLMN id negotiated in step 1. FEC information (codec and ratio) and MBMS Bearer QoS (ARP, QCI) are also negotiated in step 1. + +NOTE 4: The Service Announcement start time can be provided in the request. If not, BM-SC is expected to start announcing the service as soon as all required service and session properties are provided by the Content Provider. + +NOTE 5: In the case of regionalized services, i.e. ones whose contents are region-specific, a session can be cloned so that all sessions of the user service share the same FLUTE parameters. + +- 9: A unique resource id of the session, which identifies the created session, is returned by the BM-SC to the Content Provider. Additionally, the push URL (whereby the required xMB-U ingest mode is set to push) and QoE Report URL are added to the response. +- 10: The Content Provider queries the session configuration by providing the resource ids of the session and service. The Content Provider needs the Push URL to configure the DASH segmenter. The BM-SC provides the information in the response, which includes all readable session properties. +- 11: The Content Provider updates the session by providing the DASH MPD URL (Application Entry Point URL). The BM-SC sends a response with update status. + +- 12: Once all information for service announcement is available, and if service announcement start time has elapsed, the BM-SC starts announcing the service automatically. Service announcement is automatically updated following subsequent session updates. + +The following steps pertain to the BM-SC activating automatically the MBMS Bearer at session start time. See 3GPP TS 26.346 [3] and 3GPP TS 29.061 [20] for further details. + +- 13: The BM-SC activates the MBMS bearer by providing the TMGI, the Flow ID, the MBMS Service Area (MSA), the GBR and other parameters to the MBMS-GW. +- 14: When the Content Provider has configured a Notification URL for the service, the BM-SC delivers service/session related notification messages to the Content Provider. +- 15: When the MBMS bearer is activated, the BM-SC will start forwarding the xMB-U user plane data (push interface here). Any xMB-U user plane data received before activation of the MBMS bearer can be discarded. +- 16: At session stop time, the MBMS bearer is terminated. +- 17: The BM-SC can notify the Content Provider about the termination of the MBMS Bearer. + +NOTE 6: The Content Provider terminates the service, when the service is not needed anymore. All sessions, which have been created or are active will be deleted automatically by BM-SC with the termination of the service. + +## --- A.3 xMB Procedure example for Live DASH services (with Service Continuity) + +This procedure example describes the xMB-C procedures for a Live DASH service with service continuity. See 3GPP TS 26.247 [18] for the specification of DASH services. Service continuity allows UEs to enter or leave the MBMS service areas while receiving a Live DASH service. UEs can switch to unicast as defined in subclause 7.6 of 3GPP TS 26.346 [3] when leaving the MBMS service area. + +In case of service continuity support, the system offers representations via unicast and via MBMS Bearers. A unified MPD (cf. subclause 7.6 of 3GPP TS 26.346 [3]) contains the corresponding retrieval information. When service continuity is supported, the Content Provider provides MPD and Initialization Segments for both unicast and MBMS bearer access and also the associated Media Segments. The Content Handler functions forwards the content to a DASH (unicast) Server. The DASH (unicast) server can use a Content Delivery Network (CDN) for unicast delivery. + +A push interface is used here as ingestion method for the xMB-U user-plane data. The source of the user plane data (Content Provider Source) are the DASH Media Segments as produced by a Live Encoder / Segmenter, which produces the content for unicast and MBMS bearer delivery. The Media Presentation Description and Initialization Segment for the Live DASH session are provided separately to the BM-SC. + +The Service Announcement Function (SAF) of the BM-SC creates the needed metadata fragments for the MBMS User Service. To support service continuity, the SAF adds base pattern elements to the *userServiceDescription* element. The MBMS Client in the UE matches the base pattern against a portion of the entire request URL. The SAF creates unified MPD by adding information specific elements to it. The SAF makes the service announcement information available via unicast and via MBMS. + +A content handler function of the BM-SC handles the separation of unicast and MBMS bearer content. The content handler function makes the content available in operators CDN for unicast access. + +## --- A.4 xMB Procedure example for File Delivery Services (without File Schedule) + +This procedure example describes the provisioning procedure for the delivery of a File Delivery service, to a single broadcast area, without the presence of the *fileSchedule* element in the Schedule Description fragment of MBMS User Service Announcement information. The *fileSchedule* element contains transmission timing information for each file by its file URL. Consequently, the file URLs must be present when creating service announcement information. + +This example assumes that the BM-SC automatically fetches the file using a pull method (xMB-U mode) and prepares the transmission. File URLs can be provided in the session creation request or any subsequent session update request. When file preparation ends after the session start time, the file is automatically added to user plane flow. It is up to Content Provider to ensure that session scheduling is large enough to allow files preparation and transmission according to bitrate between BM-SC and file location, and bitrate of user plane. + +![Sequence diagram showing interactions between UE, MBMS-GW, BM-SC, CP Control, and CP Source. The diagram includes steps for Service Level Agreement, File Delivery Session provisioning, Service creation, Session creation, MBMS Bearer activation, and MBMS Bearer deactivation.](9b1ec0090070bdf52ea28763b8d52477_img.jpg) + +``` + +sequenceDiagram + participant UE + participant MBMS-GW + participant BM-SC + participant CP Control + participant CP Source + + Note over all: 1: Operator and Content Provider agree Service Level Agreement + Note over BM-SC: 2: BM-SC admin applies agreed ranges to BM-SC + Note over all: Provisioning a File Delivery Session + BM-SC->>CP Control: 3: Authentication and Authorization + Note over BM-SC, CP Control: Creating a Service + BM-SC->>CP Control: 4: HTTP POST + CP Control-->>BM-SC: 5: HTTP 201 CREATED + BM-SC->>CP Control: 6: HTTP GET + CP Control-->>BM-SC: HTTP 200 OK + BM-SC->>CP Control: 7: HTTP PUT/PATCH + CP Control-->>BM-SC: HTTP 200 OK + Note over BM-SC, CP Control: Creating a Session + BM-SC->>CP Control: 8: HTTP POST + CP Control-->>BM-SC: 9: HTTP 201 CREATED + BM-SC->>MBMS-GW: 10: Do service announcement (when all data present) + Note over BM-SC, CP Control: MBMS Bearer is activated + BM-SC->>CP Control: 11: HTTP GET + CP Control-->>BM-SC: 12: HTTP 200 OK + BM-SC->>CP Control: 13: HTTP PUT/PATCH + CP Control-->>BM-SC: 14: HTTP 200 OK + Note over all: MBMS Bearer is activated + BM-SC->>MBMS-GW: 15: MBMS Session Start + MBMS-GW-->>BM-SC: Ok + BM-SC->>CP Control: Notification (Session Id start) + BM-SC->>MBMS-GW: 16: User Plane Data + BM-SC->>CP Control: Notification (File URL delivery) + Note over all: MBMS Bearer is deactivated + BM-SC->>MBMS-GW: 17: MBMS Session Stop + MBMS-GW-->>BM-SC: Ok + BM-SC->>CP Control: Notification (Session Id stop) + +``` + +Sequence diagram showing interactions between UE, MBMS-GW, BM-SC, CP Control, and CP Source. The diagram includes steps for Service Level Agreement, File Delivery Session provisioning, Service creation, Session creation, MBMS Bearer activation, and MBMS Bearer deactivation. + +###### Figure A.4-1: xMB-C and xMB-U Procedures for a File Delivery Service + +- 1: The operator and the Content Provider agree on a Service Level Agreement (SLA), which entitles the Content Provider to use the MBMS system (in accordance to some rules) for content delivery. For instance, the SLA can include day time ranges, during which the Content Provider can distribute its content. The SLA can also include geographical areas, in which the Content Provider is allowed to distribute content. The SLA also includes target bitrates and likely definitions of tolerable losses per service. +- 2: The BM-SC administrators (operator) apply the agreed ranges. This can imply to add additional Service Areas, the provisioning of and other system related configurations. + +The Content Provider provisioning a file delivery session in a single broadcast area. + +- 3: The Content Provider authenticates itself as authorized user. The Content Provider can only see those configurations, sessions and services, which belong to the Content Provider. +- 4: The Content Provider creates a new service. Optionally, the Content Provider may provide properties for the service like service class, service languages, service names, notification configuration as well as consumption reporting configuration. The Content Provider can select whether the Content Provider or the operator distributes service announcement by providing a list of Service Announcement Channel (SACH, as defined in Annex L.2 / L.3 of 3GPP TS 26.346 [3]) services used for operator-driven service announcement. + +NOTE 1: BM-SC derives the required UE capabilities from the provided service and session properties. + +- 5: Upon successful service creation by the BM-SC, the BM-SC shall provide a unique resource id of the service, that the Content Provider can use for subsequent requests. +- 6: The Content Provider retrieves the current service properties. The unique resource id of the service is provided by the Content Provider as input to the BM-SC. The BM-SC responds with the service properties. +- 7: The Content Provider updates service properties. The unique resource id of the service and some or all service properties are provided by the Content Provider as input to the BM-SC +- 8: The Content Provider creates a session for previously created service. The unique resource id of the service is provided by the Content Provider as input to the BM-SC. Optionally, the Content Provider may provide common session properties like max ingest bitrate (excluding any FEC redundancy and transport overhead), scheduling information (start time, stop time), Geographical Area and QoE Reporting configuration and session type (set to Files) as input. File specific session properties provided as input by Content Provider: xMB-U ingest mode (pull/push), file list if xMB-U pull mode. + +NOTE 2: BM-SC allocates following parameters for SDP of the MBMS User Service: TMGI, FLUTE IP Multicast Address, UDP Port and TSI (see 3GPP TS 26.346 [3]). + +NOTE 3: BM-SC derives the SAI list for the MBMS Service Area from Geographical Area provided in Content Provider request and from PLMN id negotiated in step 1. FEC information (codec and ratio) and MBMS Bearer QoS (ARP, QCI) are also negotiated in step 1. + +NOTE 4: In xMB-U pull ingest mode, file URLs can be provided now (i.e. at session resource creation) or at a later stage (e.g. while the session is active) through the Session Update xMB-C procedure. + +NOTE 5: Service Announcement start time can be provided in request. If not, BM-SC starts announcing service as soon as all required service and session properties are provided by Content Provider. + +NOTE 6: In the case of regional services, i.e. that deliver region specific content, a session can be cloned so that all Sessions of user service use same FLUTE parameters. + +- 9: A unique resource id of the session, which identifies the created Session, is responded. If xMB-U push ingest mode is used, BM-SC provides also the push URL the Content Provider shall use. + +NOTE 7: For file URLs provided in session creation request, the BM-SC starts automatically to fetch the file resource(s) from the content location when file earliest fetch time elapses and generates the FLUTE and FEC symbols (if any). The BM-SC can notify the Content Provider when the process is finalized. + +- 10: Once all information for service announcement is available, and if service announcement start time is elapsed, the BM-SC starts announcing the service automatically. Service announcement is automatically updated + +following subsequent Session updates. File schedule element can be present in Schedule fragment for files URLs provided in Session creation request. + +11: The Content Provider queries the Session configuration, providing the resource ids of the session and service. + +12: The BM-SC provides the information in response. + +13: The Content Provider updates session by providing additional File URLs. + +14: The BM-SC sends response with update status. + +NOTE 8: The BM-SC starts automatically to fetch the new file resource(s) from the content location when file earliest fetch time elapses and generates the FLUTE and FEC symbols (if any). The BM-SC can notify the Content Provider when the process is finalized. + +NOTE 9: Steps 9-12 can be executed at any time after Session is created and prior to the Session stop time. Any file URL added after Session start time will be automatically fetched, processed and sent on user plane. + +The BM-SC activates automatically the MBMS Bearer at session start time. + +15: The BM-SC activates the MBMS bearer by providing the TMGI, the Flow ID, the MBMS Service Area (MSA), the GBR and other parameters to the MBMS-GW. The BM-SC can notify the Content Provider about the activation of the MBMS Bearer. + +16: When the MBMS Broadcast bearer is activated, then the BM-SC starts sending the user plane data, according to target reception completion time. The BM-SC can notify Content Provider of file delivery start/end. + +17: At session stop time, the MBMS bearer is terminated. The BM-SC can notify the Content Provider about the termination of the MBMS Bearer. + +NOTE 10: The Content Provider terminates the service. All sessions, which are still created or active will be deleted automatically by BM-SC with the termination of the service. + +# Annex B (normative): JSON Schema + +``` +{ + "swagger": "2.0", + "info": { + "title": "BM-SC API", + "description": "BM-SC Content Provider ingestion API", + "version": "1.0.2" + }, + "host": "", + "schemes": [ + "https" + ], + "basePath": "/xmb/v1.0", + "produces": [ + "application/json" + ], + "paths": { + "/services": { + "get": { + "description": "Return all supported services", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "A list of services.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Service" + } + } + } + } + } + } + } +} +``` + +``` + "default":{ + "description":"Unexpected error", + "schema":{ + "$ref":"#/definitions/Error" + } + } + } + }, + "post":{ + "description":"Creates a service", + "produces":[ + "application/json" + ], + "responses":{ + "201":{ + "description":"Service successfully created..", + "schema":{ + "$ref":"#/definitions/services-response" + } + }, + "401":{ + "description":"Request requires user authentication" + }, + "403":{ + "description":"Request cannot be fulfilled" + } + } + } +}, +"/services/{service-id}":{ + "get":{ + "description":"Returns resource for a given service-id", + "produces":[ + "application/json" + ], + "parameters":[ + { + "name":"service-id", + "in":"path", + "description":"Service Id", + "required":true, + "type":"integer", + "format":"int32" + } + ], + "responses":{ + "200":{ + "description":"OK.", + "schema":{ + "$ref":"#/definitions/Service" + } + } + } + }, + "patch":{ + "description":"Update a service", + "produces":[ + "application/json" + ], + "parameters":[ + { + "name":"body", + "in":"body", + "required":true, + "description":"Service that needs to be created", + "schema":{ + "$ref":"#/definitions/Service" + } + }, + { + "name":"service-id", + "in":"path", + "description":"Service Id", + "required":true, + "type":"integer", + "format":"int32" + } + ] + } +}, +``` + +``` + "responses":{ + "200":{ + "description":"The request has succeeded", + "schema":{ + "$ref":"#/definitions/Service" + } + }, + "204":{ + "description":"The request has succeeded" + }, + "401":{ + "description":"Request requires user authentication" + }, + "403":{ + "description":"Request cannot be fulfilled" + }, + "404":{ + "description":"Request not found" + } + } + }, + "put":{ + "description":"Updates a service", + "produces":[ + "application/json" + ], + "parameters":[ + { + "name":"body", + "in":"body", + "required":true, + "description":"Service that needs to be created", + "schema":{ + "$ref":"#/definitions/Service" + } + }, + { + "name":"service-id", + "in":"path", + "description":"Service Id", + "required":true, + "type":"integer", + "format":"int32" + } + ], + "responses":{ + "200":{ + "description":"The request has succeeded", + "schema":{ + "$ref":"#/definitions/Service" + } + }, + "204":{ + "description":"The request has succeeded" + }, + "401":{ + "description":"Request requires user authentication" + }, + "403":{ + "description":"Request cannot be fulfilled" + }, + "404":{ + "description":"Request not found" + } + } + }, + "delete":{ + "description":"Delete a service", + "produces":[ + "application/json" + ], + "parameters":[ + { + "name":"service-id", + "in":"path", + "description":"Service Id", + "required":true, + "type":"integer", + "format":"int32" + } + ], + "responses":{ + "200":{ + "description":"The request has succeeded", + "schema":{ + "$ref":"#/definitions/Service" + } + }, + "204":{ + "description":"The request has succeeded" + }, + "401":{ + "description":"Request requires user authentication" + }, + "403":{ + "description":"Request cannot be fulfilled" + }, + "404":{ + "description":"Request not found" + } + } + } +} +``` + +``` + "format":"int32" + } +}, +"responses":{ + "200":{ + "description":"The request has succeeded", + "schema":{ + "$ref":"#/definitions/services-response" + } + }, + "204":{ + "description":"The request has succeeded" + }, + "401":{ + "description":"Request requires user authentication" + }, + "403":{ + "description":"Request cannot be fulfilled" + }, + "404":{ + "description":"Request not found" + } +} +} +}, +"/services/{service-id}/sessions":{ + "get":{ + "description":"Return all sessions of a given service", + "produces":[ + "application/json" + ], + "parameters":[ + { + "name":"service-id", + "in":"path", + "description":"Service Id", + "required":true, + "type":"integer", + "format":"int32" + } + ], + "responses":{ + "200":{ + "description":"A list of sessions.", + "schema":{ + "type":"array", + "items":{ + "$ref":"#/definitions/Session" + } + } + }, + "default":{ + "description":"Unexpected error", + "schema":{ + "$ref":"#/definitions/Error" + } + } + } + }, + "post":{ + "description":"Create a session for a given service", + "produces":[ + "application/json" + ], + "parameters":[ + { + "name":"service-id", + "in":"path", + "description":"Service Id", + "required":true, + "type":"integer", + "format":"int32" + } + ], + "responses":{ + "201":{ + "description":"Session successfully created..", + "schema":{ +``` + +``` + "$ref":"#/definitions/session-response" + } +}, +"401":{ + "description":"Request requires user authentication" +}, +"403":{ + "description":"Request cannot be fulfilled" +} +} +} +}, +"/services/{service-id}/sessions/{session-id}":{ + "get":{ + "description":"Return a session of a given service", + "produces":[ + "application/json" + ], + "parameters":[ + { + "name":"service-id", + "in":"path", + "description":"Service Id", + "required":true, + "type":"integer", + "format":"int32" + }, + { + "name":"session-id", + "in":"path", + "description":"Session Id", + "required":true, + "type":"integer", + "format":"int32" + } + ], + "responses":{ + "200":{ + "description":"OK.", + "schema":{ + "$ref":"#/definitions/Session" + } + } + } + }, + "patch":{ + "description":"Updates a session of a given service", + "produces":[ + "application/json" + ], + "parameters":[ + { + "name":"body", + "in":"body", + "required":true, + "description":"Session that needs to be created", + "schema":{ + "$ref":"#/definitions/Session" + } + }, + { + "name":"service-id", + "in":"path", + "description":"Service Id", + "required":true, + "type":"integer", + "format":"int32" + }, + { + "name":"session-id", + "in":"path", + "description":"Session Id", + "required":true, + "type":"integer", + "format":"int32" + } + ], + "responses":{ +``` + +``` + "200":{ + "description":"The request has succeeded", + "schema":{ + "$ref":"#/definitions/Session" + } + }, + "204":{ + "description":"The request has succeeded" + }, + "401":{ + "description":"Request requires user authentication" + }, + "403":{ + "description":"Request cannot be fulfilled" + }, + "404":{ + "description":"Request not found" + } + } +}, +"put":{ + "description":"Update a session of a given service", + "produces":[ + "application/json" + ], + "parameters":[ + { + "name":"body", + "in":"body", + "required":true, + "description":"Session that needs to be created", + "schema":{ + "$ref":"#/definitions/Session" + } + }, + { + "name":"service-id", + "in":"path", + "description":"Service Id", + "required":true, + "type":"integer", + "format":"int32" + }, + { + "name":"session-id", + "in":"path", + "description":"Session Id", + "required":true, + "type":"integer", + "format":"int32" + } + ], + "responses":{ + "200":{ + "description":"The request has succeeded", + "schema":{ + "$ref":"#/definitions/Session" + } + }, + "204":{ + "description":"The request has succeeded" + }, + "401":{ + "description":"Request requires user authentication" + }, + "403":{ + "description":"Request cannot be fulfilled" + }, + "404":{ + "description":"Request not found" + } + } +}, +"delete":{ + "description":"Delete a session of a given service", + "produces":[ + "application/json" + ], + +``` + +``` + "parameters": [ + { + "name": "service-id", + "in": "path", + "description": "Service Id", + "required": true, + "type": "integer", + "format": "int32" + }, + { + "name": "session-id", + "in": "path", + "description": "Session Id", + "required": true, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "The request has succeeded", + "schema": { + "$ref": "#/definitions/session-response" + } + }, + "204": { + "description": "The request has succeeded" + }, + "401": { + "description": "Request requires user authentication" + }, + "403": { + "description": "Request cannot be fulfilled" + }, + "404": { + "description": "Request not found" + } + } + } +}, +"/services/{service-id}/reports": { + "get": { + "description": "Returns all reports of a given service", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "service-id", + "in": "path", + "description": "Service Id", + "required": true, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "A list of reports.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Report" + } + } + }, + "401": { + "description": "Request requires user authentication" + }, + "403": { + "description": "Request cannot be fulfilled" + }, + "404": { + "description": "Request not found" + }, + "default": { + "description": "Unexpected error", + "schema": { +``` + +``` + "$ref":"#/definitions/Error" + } + } + } +}, +"/services/{service-id}/reports/{report-id}":{ + "get":{ + "description":"Returns all reports of a given service", + "produces":[ + "application/json" + ], + "parameters":[ + { + "name":"service-id", + "in":"path", + "description":"Service Id", + "required":true, + "type":"integer", + "format":"int32" + }, + { + "name":"report-id", + "in":"path", + "description":"Report Id", + "required":true, + "type":"integer", + "format":"int32" + } + ], + "responses":{ + "200":{ + "description":"A report with given report-id", + "schema":{ + "$ref":"#/definitions/Report" + } + }, + "401":{ + "description":"Request requires user authentication" + }, + "403":{ + "description":"Request cannot be fulfilled" + }, + "404":{ + "description":"Request not found" + }, + "default":{ + "description":"Unexpected error", + "schema":{ + "$ref":"#/definitions/Error" + } + } + } + } +}, +"/services/{service-id}/sessions/{session-id}/reports":{ + "get":{ + "description":"Return all reports of a given session of a given service", + "produces":[ + "application/json" + ], + "parameters":[ + { + "name":"service-id", + "in":"path", + "description":"Service Id", + "required":true, + "type":"integer", + "format":"int32" + }, + { + "name":"session-id", + "in":"path", + "description":"Session Id", + "required":true, + "type":"integer", + "format":"int32" + } + ] + } +} +``` + +``` + ], + "responses":{ + "200":{ + "description":"OK.", + "schema":{ + "$ref":"#/definitions/Report" + } + }, + "401":{ + "description":"Request requires user authentication" + }, + "403":{ + "description":"Request cannot be fulfilled" + }, + "404":{ + "description":"Request not found" + } + } + } +}, +"/services/{service-id}/sessions/{session-id}/reports/{report-id}":{ + "get":{ + "description":"Return all reports of a given session of a given service", + "produces":[ + "application/json" + ], + "parameters":[ + { + "name":"service-id", + "in":"path", + "description":"Service Id", + "required":true, + "type":"integer", + "format":"int32" + }, + { + "name":"session-id", + "in":"path", + "description":"Session Id", + "required":true, + "type":"integer", + "format":"int32" + }, + { + "name":"report-id", + "in":"path", + "description":"Report Id", + "required":true, + "type":"integer", + "format":"int32" + } + ], + "responses":{ + "200":{ + "description":"OK.", + "schema":{ + "$ref":"#/definitions/Report" + } + }, + "401":{ + "description":"Request requires user authentication" + }, + "403":{ + "description":"Request cannot be fulfilled" + }, + "404":{ + "description":"Request not found" + } + } + } +}, +"/notifications":{ + "get":{ + "description":"Returns all notifications.", + "produces":[ + "application/json" + ], + "responses":{ +``` + +``` + + "200":{ + "description":"A list of notifications.", + "schema":{ + "type":"array", + "items":{ + "$ref":"#/definitions/Notification" + } + } + }, + "401":{ + "description":"Request requires user authentication" + }, + "403":{ + "description":"Request cannot be fulfilled" + }, + "default":{ + "description":"Unexpected error", + "schema":{ + "$ref":"#/definitions/Error" + } + } + } +} +}, +"definitions":{ + "Service":{ + "type":"object", + "description":"Service Description", + "properties":{ + "id":{ + "type":"number", + "description":"Service Resource Identifier" + }, + "service-id":{ + "type":"string", + "description":"Identifies the MBMS User Service as defined in Clause 11.2.1.1 of TS +26.346." + }, + "service-class":{ + "description":"Service Class", + "type":"string" + }, + "service-languages":{ + "type":"array", + "description":"List of service languages", + "items":{ + "type":"string" + } + }, + "service-names":{ + "type":"array", + "description":"List of service names", + "items":{ + "type":"string" + } + }, + "receive-only-mode":{ + "description":" When set to true, the Content Provider indicates that the service is a Receive Only +Mode service.", + "type":"boolean" + }, + "service-announcement-mode":{ + "description":"Enumeration that the BM-SC creates according service announcement +fragments for the sessions and / or do service announcement on SACH. Additional service announcement +modes may be added in future", + "type":"string" + }, + "consumption-reporting-configuration":{ + "type":"object", + "description":"The Content Provider wishes to collect consumption reports (enabling +precision, i.e. combination of sample percentage and reporting interval)", + "properties":{ + "reporting-interval":{ + "type":"number", + "description":"The interval for which the BM-SC has to aggregate the statistics +for" + }, + } + }, + } + } +} + +``` + +``` + + "sample-percentage":{ + "type":"number", + "description":"Percentage of users to collect reports from" + }, + "start-time":{ + "type":"string", + "description":"Start time of consumption report collection" + }, + "end-time":{ + "type":"string", + "description":"End time of consumption report collection" + } + } + }, + "push-notification-url":{ + "type":"string", + "description":"The Content Provider provides Notification URL over which it will +receive notifications "pushed" by the BM-SC. The Notification procedure is described in Clause 5.3.6 +of 3GPP TS 26.348 [33]." + }, + "push-notification-configuration":{ + "type":"string", + "description":"If the Content Provider enables push delivery of notifications, then +the Content Provider may provide notification filters. This parameter contains a comma separated +list of Classes it wishes to receive among the following options: Critical, Warning, Information, +Service, Session, or All to get all types of notification. The notification message shall be sent +immediately to the Content Provider upon becoming available." + } + } +}, +"services-response": { + "required": [ + "service-res-id" + ], + "properties": { + "service-res-id": { + "type": "integer", + "format": "int32", + "description": "The resource identifier of the service." + } + } +}, +"Session":{ + "type":"object", + "description":"Session Description", + "properties":{ + "id":{ + "type":"string", + "description":"Session Resource Identifier" + }, + "session-start":{ + "description":"Start time when the MBMS Bearer is active", + "type":"number" + }, + "session-stop":{ + "description":"Stop time until the MBMS bearer is active", + "type":"number" + }, + "max-ingest-bitrate":{ + "description":"The requested bitrate excludes FEC overhead and transport overhead. +The BM-SC calculates the MBMS Bearer bitrate from it, considering overhead like FEC and other +transport overheads. The session bitrate is always larger or equal to the payload bitrate", + "type":"number", + "format":"float" + }, + "max-delay":{ + "description":"Specifies the maximum delay the MBMS System should add, i.e. from the +time the data is received to the time by when the data is released from the MBMS system", + "type":"number", + "format":"float" + }, + "session-state":{ + "description":"The BM-SC may automatically change the state of the session. Possible +states: Session Idle, Session Announced, Session Active", + "type":"string" + }, + "service-announcement-start-time":{ + +``` + +``` + + "description":"When present, this time at which the BM-SC shall start service +announcement", + "type":"number" + }, + "geographical-area":{ + "description":"Geographics Area, where the service is provided, either through +unicast or through MBMS Bearers. The BM-SC derives the MBMS Service Area and the SAI list for the +availability information from Geographical Area as provided by the Content Provider. The content of +each string item is left to the business agreement between the Content Provider and the Operator.", + "type":"array", + "items":{ + "type":"string" + } + }, + "qoe-reporting-configuration":{ + "type":"array", + "description":"The Content Provider wishes to collect QoE reports for this session. +If this configuration is included, the QoE reporting configuration shall be applied only for this +session. If this configuration is present, the Content Provider requests overriding of service level +configuration for this session with this configuration. The possible QoE metrics that the Content +Provider may request can be either found in or derived from subclauses 8.4.2 and 10 of 3GPP TS +26.347 [21], as well as the reception reporting information that is available in subclause 9.4.6 of +3GPP TS 26.346 [3]. The detailed or aggregated reports shall not contain information such as +clientId, which might pose privacy concerns, or networkResourceCellId, which would expose mobile +network information.", + "items":{ + "type":"object", + "description":"QoE metric configuration", + "properties":{ + "metric-name":{ + "type":"string", + "description":"Name of QoE metric" + }, + "metric-type":{ + "type":"string", + "description":"Type of metric" + }, + "reporting-interval":{ + "type":"number", + "description":"The interval for which the BM-SC has to aggregate the +statistics for" + }, + "sample-percentage":{ + "type":"number", + "description":"Percentage of users to collect reports from" + }, + "start-time":{ + "type":"string", + "description":"Start time of consumption report collection" + }, + "end-time":{ + "type":"string", + "description":"End time of consumption report collection" + } + } + } + }, + "session-type":{ + "description":"The session type is how the Content Provider is providing the content +to the BM-SC. The BM-SC is selecting the appropriate delivery methods from the session type. The +session type shall be extensible for further session types", + "type":"string", + "enum":{ + "Streaming: When the session type is set to Streaming, the BM-SC expects a +Streaming type input (RTP). When the method is set to streaming, then the format is compliant to +MBMS streaming (as defined in 3GPP TS 26.346 [3]).", + "Files: When the session type is set to Files, the BM-SC expects generic files as +input. The files can be provided either by on-request pull interactions or continuous push ingest", + "Application: When the session type is set to Application, then the ingest depends +on the application service description. When the Application Service Description is set to DASH, the +BM-SC expects an MPD and optionally one or more IS's. The content is assumed to be 3GP-DASH +compliant (as defined by 3GPP TS 26.247). The BM-SC may either pull the Media Segments from the +Content Provider or the Content Provider continuously pushes Segments into the BM-SC", + "Transport-Mode: When the session type is set to Transport-Mode, the BM-SC +provides transport of data/TV content in a transparent manner. The content provide may provide some +configuration parameters for the distributions" + } + }, +} + +``` + +``` + +"max-cid": { + "type": "integer", + "minimum": 0, + "maximum": 16383, + "description": "indicating the MAX CID parameter for the compressor (see IETF RFC 5795)." +}, +"header-compression":{ + "description":" Requests the BM-SC to enable ROHC on the input flows.", + "type":"array", + "items":{ + "type":"object", + "description":"Describes a single input flow where ROHC is to be applied. Either ipv4addr +or ipv6addr shall be included and port and periodicity may be included.", + "properties":{ + "ipv4addr":{ + "type":"string", + "description":"An IPv4 address formatted in the 'dotted decimal' notation as defined +in IETF RFC 1166 [31]" + }, + "ipv6addr":{ + "type":"string", + "description":" An IPv6 address formatted according to clause 4 of IETF RFC 5952 +[32]. The mixed IPv4 IPv6 notation according to clause 5 of IETF RFC 5952 [32] shall not be used." + }, + "port":{ + "type":"integer", + "description":"A UDP or TCP port between 0 and 65535 " + }, + "periodicity":{ + "type":"number", + "description":"the target periodicity for ROHC full header packets in units of seconds" + }, + "profile":{ + "type":"integer", + "description":"the applicable ROHC profile (see IETF RFC 5795 [27])" + } + } + } +}, +"fec":{ + "description":"Requests the BM-SC to perform FEC protection of the input flow when transmitting +over the MBMS channel. The string shall include an SDP description of FEC framework configuration +information (see subclause 5.5 of IETF RFC 6363 [29]) formatted according to subclause 8A.5 of +3GPP TS 26.346 [3].", + "type":"string" +}, +"resource-sharing-ind":{ + "type":"boolean", + "description": "The resource sharing indication." +}, +"resource-sharing-id":{ + "type":"string", + "description": "The resource sharing id. When present in the session modification +operation, the value of the field identifies an existing xMB session resource URL (as specified in +table 5.1.1-1) to share the transmission, where Max Bitrate, Geographical Area and (in case of MC +Services) QoS Information are re-used." +}, +"transport-mode-session":{ + "description":"Describes a transport mode session", + "type":"object", + "properties":{ + "session-announcement-mode":{ + "description":"The session announcement mode is either Content Provider or +MBMS", + "type":"string", + "enum":{ + " Content Provider: the BMSC generates the session parameters and provides +those to the Content Provider.", + "SACH: the session announcement is done by the MBMS system through the +SACH." + } + } + } +}, +"userplane-session-description-parameters":{ + "description":"The session description parameters for the user plane provide +the information on where and how the to access the session at the Content Provider. The parameters +Type and Access URL. Note the BM-SC may get input on session properties from the Content Provider, +e.g. bitrate, dependening on the ingest session.", + "type":"object", +} + +``` + +``` + + "properties":{ + "session-description-type":{ + "type":"string", + "description":"The type of the session that describes the session, +typically for proper interpretation of the target resource of the request, for example the Internet +Media Type of the document, of the URL in an HTTP URL. An "Embedded" type is defined which indicates +that the xMB-U user plane parameters are embedded in the User Plane Parameters object." + }, + "session-description-access-url":{ + "type":"string", + "description":"A URL that enables to access and possibly control the +ingest session. The URL may for example be an RTSP URL or a URL to an SDP that describes a multicast +stream or an HTTP URL to retrieve a ready packaged MPEG2-TS stream, etc." + }, + "user-plane-parameters": { + "type": "string", + "description": "When the Type is set to 'Embedded', the Content Provider +adds an object containing the session description. In case of Forward Only Mode, the object may +contain a ready-made Session Description and the indication of a single xMB-U reception UDP port. +When a Session Description is present, then the BM-SC uses it for Session Announcement. In case of +Proxy Mode, the object shall contain a Session Description template and a list of the UDP flows to +be forwarded on the established MBMS bearer for the session. For each list entry, the content +provider indicates whether this flow is directly associated with a media description entry in the +Session Description Template or whether it is related to a media description entry (e.g. RTCP flows, +which have a relation to a media description entry, but are not described in the Session +Description). If the flow is directly associated with a media description entry, the BM-SC shall +modify the port field of the media description entry in the Session Description Template. If the +flow is related to a media description entry, then the BM-SC just forwards the flow on a port that +is equal to the port of the related media session plus an offset; such a flow is only implicitly +described in the session description - for example corresponding to the RTCP flows per the RTP/AVP +profile." + } + } + }, + "userplane-delivery-mode-configuration":{ + "description":"This mode configures how the session needs to be delivered to +the application, i.e. it basically establishes the delivery mode", + "type":"string", + "enum":[ + "Forward-only: The BM-SC receives complete IP Multicast packets for to be +forwarded", + "Proxy: Proxy the incoming UDP payloads to the outgoing UDP payloads" + ] + }, + "delivery-session-description-parameters":{ + "description":"If the Service Announcement Mode is set to Content Provider, +then at least the following information is provided by the BM-SC: TMGI of the MBMS Bearer. Note that +additional parameters may be provided, based on the configuration options of the delivery method for +transport only.", + "type":"string" + } + } + }, + "streaming-session":{ + "description":"Describes a streaming session", + "type":"object", + "properties":{ + "sdp-url":{ + "description":"A URL to the SDP that describes the streaming session between +the Content Provider and the BM-SC, that will be used for ingesting the streaming session. The SDP +shall include the RTSP links for every media session as part of the "a=control" attribute to enable +RTSP control of the session. The SDP shall also contain the required bitrate for each of the media +sessions. The content shall conform to the constraints of this specification.", + "type":"string" + }, + "time-shifting":{ + "description":"Indicates if and for how long time shifting access to the +content (using unicast) may be provided for this session.", + "type":"number" + } + } + }, + "application-session":{ + "description":"Describes an application session", + "type":"object", + "properties":{ + "application-service":{ + "description":"Mimetype of the Application Service", + } + } + } +} + +``` + +``` + + "type":"string" + }, + "ingest-mode":{ + "description":"The ingest mode enumerates how resources are ingested into the +BM-SC", + "type":"string", + "enum":[ + "Pull: The BM-SC pulls the resources as described by the application entry +point document. If DASH resources are Media Segments, the BM-SC pulls the Media Segments as +described by the Segment availability start time from a DASH MPD.", + "Push: The Content Provider pushes resources. The BM-SC needs to provide a +push URL. If DASH resources are Media Segments, Content Provider pushes Media Segments, so that the +Media Segment is available on the BM-SC according to Segment availability start time. The BM-SC +needs to provide a push URL." + ] + }, + "application-entry-point-url":{ + "description":"The application entry point refers to an MPD when Application +Service Description is set to DASH. When the Ingest Mode is set to Push, then the MPD Url refers to +a DASH MPD which should be fetched, optionally conditioned and inserted into Service Announcement. +When the Ingest Mode is set to Pull, then the BM-SC starts fetching the Segments using unicast.", + "type":"string" + }, + "push-url":{ + "description":"If the Session Type is set to Application: A resource locator +for ingesting Media Segments using HTTP. The Content Provider may create additional sub-resources +using WebDAV procedures. This is a read-only parameter managed by the BM-SC and only present when +Ingest Mode is set to Push. If the Session Type is set to Files: This parameter contains the Push +URL the Content Provider shall use when using the Push ingestion mode. This is a read-only parameter +managed by the BM-SC and only present when Ingest Mode is set to Push. ", + "type":"string" + }, + "unicast-delivery":{ + "description":"Indicator whether the content is also available for unicast +retrieval", + "type":"boolean" + }, + "components":{ + "description":"List of Components of the application, which are recommended to +be made available on MBMS Bearers. In case of DASH, each component is identified by a representation +identifier. ", + "type":"array", + "items":{ + "type":"string" + } + } +}, +"files-session":{ + "description":"Describes a file session", + "type":"object", + "properties":{ + "ingest-mode":{ + "description":"The ingest mode enumerates how resources are ingested into the +BM-SC", + "type":"string", + "enum":[ + "Pull: The Content Provider adds files URLs that the BM-SC will fetch. The +Content Provider may tell the BM-SC when to start fetching the file", + "Push: The Content Provider shall push the file to the BM-SC that will +immediately process and deliver as soon as it is ready. The BM-SC may be configured to ignore all +files that are pushed before session active time, or stage them. The BM-SC shall provide back to the +Content Provider the URL the Content Provider shall use to push the files." + ] + }, + "push-url":{ + "description":"If the Session Type is set to Application: A resource locator +for ingesting Media Segments using HTTP. The Content Provider may create additional sub-resources +using WebDAV procedures. This is a read-only parameter managed by the BM-SC and only present when +Ingest Mode is set to Push. If the Session Type is set to Files: This parameter contains the Push +URL the Content Provider shall use when using the Push ingestion mode. This is a read-only parameter +managed by the BM-SC and only present when Ingest Mode is set to Push. ", + "type":"string" + }, + "file-list":{ + "type":"array", + +``` + +``` + + "description":"List of files to be sent. In the Push mode, the file list is not + used since the BM-SC will monitor its push folder and send the files it receives on a first-come + first-served basis. In Pull mode, the file list contains the following information per file entry:", + "items":{ + "type":"object", + "properties":{ + "file-url":{ + "type":"string", + "description":"the URL where the BM-SC will fetch the file content" + }, + "file-display-url":{ + "type":"string", + "description":"the file URL as seen by the UE" + }, + "file-earliest-fetch-time":{ + "type":"string", + "description":"The BM-SC shall fetch the file no sooner than this UTC +timestamp. If absent, then the file shall be present on the Content Provider server and the BM-SC +may fetch it when it wants", + "format":"date-time" + }, + "file-latest-fetch-time":{ + "type":"string", + "description":"The BM-SC shall fetch the file no later than this UTC +timestamp. If absent, then the file shall be present on the Content Provider server and the BM-SC +may fetch it at a time of its choosing.", + "format":"date-time" + }, + "file-size":{ + "type":"integer", + "format":"int32", + "description":"The Content Provider may provide the precise or an file +size estimate as input. The BM-SC may update the file size once it has started to fetch the file" + }, + "file-status":{ + "type":"string", + "description":"Enumeration stating the state of the file. Possible +values are pending, fetched, prepared, transmitting, sent", + "enum":{ + "pending", + "fetched", + "prepared", + "transmitting", + "sent" + } + }, + "target-reception-completion-time":{ + "type":"string", + "description":"(On the MBMS Client) hint on the due date, when the +file should be completely received by the UE. The BM-SC should schedule and order the transmission +etc accordingly", + "format":"date-time" + }, + "keep-update-interval":{ + "type":"number", + "description":"The BM-SC checks the file resources with the given +interval for changes" + }, + "unicast-availability":{ + "description":"Indication that the file is also available for unicast +retrieval by the application at a Content Provider server whose location is given by the HTTP(S) URL +corresponding to the value of file display URL", + "type":"boolean" + }, + "byte-range":{ + "type":"boolean", + "description": "indicates that the HTTP(S) URL given in the file +display URL parameter can be used for Byte-Range-Based file repair" + }, + "e-tag":{ + "type":"boolean", + "description": "value of the ETag used as version identifier for the +file in the Byte-Range-Based file repair requests" + }, + "file-repetition-duration":{ + "type":"integer", + "format":"int32", + } + } + } + +``` + +``` + + "description":"The number of times the file shall be sent on the +session (a value of 1 means the file shall be sent only once). This counter shall be decreased each +time the file has been transmitted. When equals to zero, no more file repeat is scheduled. The BM-SC +may send FEC instead of source information" + }, + "periodic-update-interval": { + "type": "number", + "description": "When present, it is an indication that this file of the +list of files is expected to be periodically updated, and the value of this parameter represents the +nominally expected time interval between successive updates of this file. This parameter is a signal +to the BM-SC to deliver the file and its updates as a Datacasting service. From its value, the BM-SC +will choose the delivery mode, and set the associated interval and mode values in controlling the +transmission of the Datacasting service." + } + } + } +}, +"file-delivery-manifest-url":{ + "description":"Alternative to the file list. The resource may describe +scheduling information for the file", + "type":"string" +}, +"display-base-url": { + "type": "string", + "description": "When ingest mode is set to Push, the Base URL is seen by the +UE." +}, +"sa-file-url":{ + "type":"string", + "description": "URL of the SA file announcing the download delivery session, +provided by the BM-SC when service-announcement-mode is set to 'Content Provider'." +} +} +}, +"local-mbms-delivery-information": { + "type": "object", + "description": "Local MBMS Delivery Information", + "properties": { + "mbms-enb-ipv4-multicast-address": { + "type": "string", + "format": "ipv4", + "description": "Contains the M1 (transport) plane IPv4 destination +multicast address used by MBMS-GW for IP multicast encapsulation of application IP multicast +datagrams." + }, + "mbms-enb-ipv6-multicast-address ": { + "type": "string", + "format": "ipv6", + "description": "Contains the M1 (transport) plane IPv6 prefix of +destination multicast address used by MBMS-GW for IP multicast encapsulation of application IP +multicast datagrams." + }, + "mbms-gw-ipv4-ssm-address": { + "type": "string", + "format": "ipv4", + "description": "Contains the value of MBMS-GW's IPv4 address for Source +Specific Multicasting." + }, + "mbms-gw-ipv6-ssm-address": { + "type": "string", + "format": "ipv6", + "description": " Contains the value of MBMS-GW's IPv6 address for Source +Specific Multicasting." + }, + "common-tunnel-endpoint-identifier": { + "type": "string", + "description": "Indicates the common tunnel endpoint identifier of MBMS +GW for user plane." + }, + "bm-sc-ipv4-address": { + "type": "string", + "format": "ipv4", + "description": "Indicates the destination IPv4 address of the BM SC for +the reception of user plane data via the xMB U interface." + }, + "bm-sc-ipv6-address": { + "type": "string", + "format": "ipv6", + +``` + +``` + + "description": "Indicates the destination IPv6 address of the BM SC for +the reception of user plane data via the xMB U interface." + }, + "bm-sc-port": { + "type": "integer", + "minimum": 0, + "maximum": 65535, + "description": "Indicates the destination UDP port of the BM SC for the +reception of user plane data via the xMB U interface." + } + } + }, + "group-ids": { + "type": "array", + "description": "List of group identifiers", + "items" : { + "type" : "string" + } + }, + "mc-extension": { + "type": "object", + "description": "Mission critical extension, allowing QoS control by the content +provider", + "properties": { + "gbr": { + "type": "number", + "format": "float", + "description": "Guaranteed bitrate for the MBMS bearer in unit kbps" + }, + "qci": { + "type": "integer", + "minimum": 0, + "maximum": 255, + "description": "QoS class identifier for the MBMS bearer" + }, + "arp-priority-level": { + "type": "integer", + "minimum": 1, + "maximum": 15, + "description": "ARP priority level", + }, + "arp-pre-emption-capability": { + "type": "boolean", + "description": "ARP preemption capability" + }, + "arp-pre-emption-vulnerability": { + "type": "boolean", + "description": "ARP preemption vulnerability" + }, + "tmgi": { + "type": "string", + "description": "TMGI of the MBMS bearer" + } + } + } +}, +"session-response": { + "required": [ + "session-res-id" + ], + "properties": { + "session-res-id": { + "type": "integer", + "format": "int32", + "description": "The resource identifier of the session." + } + } +}, +"Report":{ + "type": "object", + "description": "Report Description", + "properties":{ + "id":{ + "type": "string", + "description": "Report Resource Identifier" + }, + "report-type":{ + +``` + +``` + + "description":"Type of report", + "type":"string" + }, + "report-url":{ + "type":"string", + "description":"Location of the report from where the Content Provider can retrieve the detailed report" + }, + "report":{ + "type":"string", + "description":"Detailed report" + }, + "report-starttime":{ + "type":"string", + "description":"Report collection start time" + }, + "report-endtime":{ + "description":"Report collection end time", + "type":"string" + } + } + }, + "Notification": { + "type": "object", + "description": "Notification Description", + "properties": { + "id": { + "type": "string", + "description": "Notification Resource Identifier" + }, + "message-class": { + "type": "string", + "description": "Indicates the message class of the notification", + "enum" : ["Critical: When some event drastically prevent the proper delivery of content", "Warning: When the service can be partially delivered but quality is reduced", "Information: When the service is properly delivered but some interesting event occurred", "transmitting", "Session/Service: Information about Service/Session related parameters"] + }, + "message-name": { + "description": "Unique identifier of the message. Provides information about the message pertaining to the message-class of the notification", + "type": "string", + "enum" : ["network-is-down", "service-badly-configured", "session-badly-configured", "incoming-bitrate-exceed-session-capacity", "no-incoming-data", "qoe-report-available", "consumption-reports-available", "reception-reports-available", "service-announcement-change", "session-state-change", "file-ready-for-transmission", "file-download-started ", "file-successfully-sent", "file-fetch-error"] + }, + "message-information": { + "type": "object", + "description": "A dictionary of key values containing informations linked to the notification", + "additionalProperties": { + "type": "string" + } + } + } + }, + "Error":{ + "type":"object", + "properties":{ + "code":{ + "type":"integer", + "format":"int32" + }, + "message":{ + "type":"string" + } + } + } +} + +``` + +# Annex C (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|------------------------------------------------------------------------------------------------------------|--------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New | +| 01-2017 | | | | | | TS initial skeleton | 0.0.0 | +| 01-2017 | | | | | | C3A170064, C3A170066, C3A170069 agreed in Adhoc | 0.1.0 | +| 02-2017 | | | | | | Specification of the xMB user- and control-plane procedures, accompanied by the corresponding JSON schema. | 0.2.0 | +| 03-2017 | CT#75 | CP-170102 | | | | TS sent for approval to Plenary | 1.0.0 | +| 03-2017 | CT#75 | CP-170102 | | | | TS under change control | 14.0.0 | +| 06-2017 | CT#76 | CP-171115 | 0001 | 2 | F | Editorial Updates to TS 29.116 v14.0.0 | 14.1.0 | +| 06-2017 | CT#76 | CP-171115 | 0002 | 2 | F | Technical Corrections to TS 29.116 v14.0.0 | 14.1.0 | +| 06-2017 | CT#76 | CP-171115 | 0003 | 3 | F | Technical Corrections to TS 29.116 v14.0.0 | 14.1.0 | +| 06-2017 | CT#76 | CP-171115 | 0004 | 2 | F | Supported feature negotiation | 14.1.0 | +| 06-2017 | CT#76 | CP-171137 | 0005 | 2 | B | Local MBMS related MBMS data delivery for xMB interface | 14.1.0 | +| 06-2017 | CT#76 | CP-171115 | 0010 | 2 | F | xMB Stage-2 related updates | 14.1.0 | +| 06-2017 | CT#76 | CP-171140 | 0011 | 2 | F | Security in xMB | 14.1.0 | +| 09-2017 | CT#77 | CP-172037 | 0013 | - | F | Reference correction | 14.2.0 | +| 09-2017 | CT#77 | CP-172037 | 0014 | 1 | F | Fixes and editorial updates to TS 29.116 | 14.2.0 | +| 09-2017 | CT#77 | CP-172053 | 0016 | 1 | F | Alignment to TS 26.346 | 14.2.0 | +| 09-2017 | CT#77 | CP-172055 | 0017 | 1 | F | Modification of Text on xMB Security | 14.2.0 | +| 12-2017 | CT#78 | CP-173087 | 0018 | 1 | F | Correction of Reference | 14.3.0 | +| 06-2018 | CT#80 | CP-181024 | 0021 | 1 | B | FEC and ROHC for mission critical services over MBMS | 15.0.0 | +| 03-2019 | CT#83 | CP-190129 | 0024 | 2 | F | Moving xMB stage 2 to TS 26.348 | 16.0.0 | +| 06-2019 | CT#84 | CP-191086 | 0027 | - | A | Correct feature applicability | 16.1.0 | +| 06-2019 | CT#84 | CP-191108 | 0029 | 1 | A | UE group content delivery | 16.1.0 | +| 06-2019 | CT#84 | CP-191099 | 0031 | 1 | A | Correct ROHC usage in xMB | 16.1.0 | +| 09-2019 | CT#85 | CP-192158 | 0032 | | F | Removal of a duplicated openAPI definition | 16.2.0 | +| 12-2019 | CT#86 | CP-193199 | 0033 | | F | Add file display URI support | 16.3.0 | +| 12-2019 | CT#86 | CP-193199 | 0034 | | F | Clarify consumption report configuration | 16.3.0 | +| 12-2019 | CT#86 | CP-193199 | 0035 | 1 | F | Clarify PATCH usage | 16.3.0 | +| 12-2019 | CT#86 | CP-193204 | 0036 | 1 | B | Mission critical extension | 16.3.0 | +| 12-2019 | CT#86 | CP-193204 | 0037 | | B | MBMS resource sharing | 16.3.0 | +| 12-2019 | CT#86 | CP-193204 | 0038 | | B | SA file returned for the download delivery session | 16.3.0 | +| 12-2019 | CT#86 | CP-193204 | 0039 | | B | File Repair hosted by the content provider | 16.3.0 | +| 12-2019 | CT#86 | CP-193204 | 0040 | 1 | B | xMB adaptation for CAPIF | 16.3.0 | +| 12-2019 | CT#86 | CP-193129 | 0041 | | A | Format for FEC framework configuration information in xMB | 16.3.0 | +| 03-2020 | CT#87e | CP-200217 | 0042 | | F | Correct xMB adaptation for CAPIF | 16.4.0 | +| 03-2020 | CT#87e | CP-200213 | 0043 | 1 | F | Correct opeAPI error in Mission critical extension section | 16.4.0 | +| 06-2020 | CT#88e | CP-201246 | 0044 | | F | Corrected reference to xMB stage-2 spec | 16.5.0 | +| 06-2020 | CT#88e | CP-201246 | 0045 | 1 | D | Remove redundant annex content | 16.5.0 | +| 06-2020 | CT#88e | CP-201239 | 0046 | | F | Correct qci for Mission critical extension | 16.5.0 | +| 06-2020 | CT#88e | CP-201249 | 0047 | | F | Fix the missing push url in file session | 16.5.0 | +| 09-2020 | CT#89e | CP-202061 | 0050 | | A | Correct xMB update procedure | 16.6.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29118/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg b/marked/Rel-16/29_series/29118/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ce326f34f6e4116d14e752d480ccc03a6926175a --- /dev/null +++ b/marked/Rel-16/29_series/29118/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cad4272860500d88fbc62a13613b9d0161921229c3f84cf8c777c1c519a3b4b2 +size 88121 diff --git a/marked/Rel-16/29_series/29118/af6be343f0c0a8f155f965dcf337b8af_img.jpg b/marked/Rel-16/29_series/29118/af6be343f0c0a8f155f965dcf337b8af_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5bae3a8babbd5c6913e8d1a0c3ec1f5fdac0750b --- /dev/null +++ b/marked/Rel-16/29_series/29118/af6be343f0c0a8f155f965dcf337b8af_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bd7b3a77f3326cdeb3781728cf22f67ec05446971ca2c4e22c76fb88b3715cd0 +size 85448 diff --git a/marked/Rel-16/29_series/29118/raw.md b/marked/Rel-16/29_series/29118/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..90eaaf4136863541b3a76941d7eab48ebfd6bcd1 --- /dev/null +++ b/marked/Rel-16/29_series/29118/raw.md @@ -0,0 +1,3111 @@ + + + + + + +# Contents + +| | | +|-------------------------------------------------------------------------|----| +| Foreword ..... | 8 | +| 1 Scope..... | 9 | +| 2 References..... | 9 | +| 3 Definitions and abbreviations ..... | 10 | +| 3.1 Definitions..... | 10 | +| 3.2 Abbreviations ..... | 11 | +| 4 Description of the SGs association between a VLR and an MME ..... | 11 | +| 4.1 General ..... | 11 | +| 4.2 SGs association at the VLR..... | 11 | +| 4.2.1 General ..... | 11 | +| 4.2.2 States at the VLR..... | 12 | +| 4.3 SGs association at the MME..... | 12 | +| 4.3.1 General ..... | 12 | +| 4.3.2 MM context variables at the MME ..... | 13 | +| 4.3.3 States at the MME ..... | 13 | +| 4.3.4 State transitions in the MME without SGsAP signalling ..... | 14 | +| 4.3.5 State transitions in the VLR without SGsAP signalling..... | 14 | +| 5 Procedures for SGs..... | 15 | +| 5.1 Paging for non-EPS services procedure ..... | 15 | +| 5.1.1 General description..... | 15 | +| 5.1.2 Procedures in the VLR ..... | 15 | +| 5.1.2.1 General..... | 15 | +| 5.1.2.2 Paging Initiation..... | 15 | +| 5.1.2.3 Paging Response ..... | 16 | +| 5.1.2.4 Paging Failure ..... | 16 | +| 5.1.2.5 UE unreachable..... | 17 | +| 5.1.3 Procedures in the MME..... | 17 | +| 5.1.3.1 General..... | 17 | +| 5.1.3.2 Procedure when no NAS signalling connection exists ..... | 20 | +| 5.1.3.3 Procedure when a NAS signalling connection exists ..... | 21 | +| 5.2 Location update for non-EPS services procedure ..... | 21 | +| 5.2.1 General description..... | 21 | +| 5.2.2 Procedures in the MME..... | 22 | +| 5.2.2.1 General..... | 22 | +| 5.2.2.2 Location update initiation ..... | 22 | +| 5.2.2.2.1 General ..... | 22 | +| 5.2.2.2.2 VLR fails without restart..... | 24 | +| 5.2.2.3 Location update response..... | 25 | +| 5.2.2.4 Location update failure ..... | 25 | +| 5.2.2.5 Abnormal cases..... | 26 | +| 5.2.2.6 Additional MME procedure for UE supporting NB-S1 mode only..... | 26 | +| 5.2.3 Procedures in the VLR ..... | 27 | +| 5.2.3.1 General..... | 27 | +| 5.2.3.2 Location update response..... | 27 | +| 5.2.3.3 Location update failure ..... | 28 | +| 5.2.3.4 TMSI reallocation procedure ..... | 28 | +| 5.2.3.5 Abnormal cases..... | 28 | +| 5.3 Non-EPS alert procedure..... | 29 | +| 5.3.1 General description..... | 29 | +| 5.3.2 Procedures in the VLR ..... | 29 | +| 5.3.2.1 Alert Initiation..... | 29 | +| 5.3.2.2 Alert Response..... | 29 | +| 5.3.2.3 Alert Failure ..... | 30 | +| 5.3.2.4 Alert Indication ..... | 30 | +| 5.3.2.5 Abnormal cases..... | 30 | +| 5.3.3 Procedures in the MME..... | 30 | + +| | | | +|------------|--------------------------------------------------|----| +| 5.3.3.1 | Alert response ..... | 30 | +| 5.3.3.2 | Alert failure ..... | 30 | +| 5.3.3.3 | Alert indication ..... | 30 | +| 5.4 | Explicit IMSI detach from EPS services ..... | 31 | +| 5.4.1 | General description ..... | 31 | +| 5.4.2 | Procedures in the MME ..... | 31 | +| 5.4.2.1 | Explicit EPS detach initiation ..... | 31 | +| 5.4.2.2 | Explicit EPS detach response ..... | 32 | +| 5.4.2.3 | Abnormal cases ..... | 32 | +| 5.4.3 | Procedures in the VLR ..... | 32 | +| 5.5 | Explicit IMSI detach from non-EPS services ..... | 32 | +| 5.5.1 | General description ..... | 32 | +| 5.5.2 | Procedures in the MME ..... | 32 | +| 5.5.2.1 | Explicit IMSI detach initiation ..... | 32 | +| 5.5.2.2 | Explicit IMSI detach response ..... | 33 | +| 5.5.2.3 | Abnormal cases ..... | 33 | +| 5.5.3 | Procedures in the VLR ..... | 33 | +| 5.6 | Implicit IMSI detach from non-EPS services ..... | 33 | +| 5.6.1 | General description ..... | 33 | +| 5.6.2 | Procedures in the MME ..... | 34 | +| 5.6.3 | Procedures in the VLR ..... | 34 | +| 5.7 | VLR failure procedure ..... | 34 | +| 5.7.1 | General description ..... | 34 | +| 5.7.2 | Procedures in the VLR ..... | 34 | +| 5.7.2.1 | VLR Reset Initiation ..... | 34 | +| 5.7.2.2 | VLR Reset Response ..... | 34 | +| 5.7.2.3 | Abnormal cases ..... | 35 | +| 5.7.3 | Procedures in the MME ..... | 35 | +| 5.7.3.1 | VLR reset indication ..... | 35 | +| 5.7.3.2 | Void ..... | 35 | +| 5.8 | MME failure procedure ..... | 35 | +| 5.8.1 | General description ..... | 35 | +| 5.8.2 | Procedures in the MME ..... | 35 | +| 5.8.2.1 | MME Reset Initiation ..... | 35 | +| 5.8.2.2 | MME Reset Response ..... | 36 | +| 5.8.2.3 | Abnormal cases ..... | 36 | +| 5.8.3 | Procedures in the VLR ..... | 36 | +| 5.9 | HSS failure ..... | 36 | +| 5.9.1 | General description ..... | 36 | +| 5.9.2 | Procedures in the MME ..... | 36 | +| 5.10 | MM information procedure ..... | 37 | +| 5.10.1 | General description ..... | 37 | +| 5.10.2 | Procedures in the VLR ..... | 37 | +| 5.10.3 | Procedures in the MME ..... | 37 | +| 5.11 | Procedure for tunnelling of NAS messages ..... | 38 | +| 5.11.1 | General description ..... | 38 | +| 5.11.2 | Uplink unitdata procedure ..... | 38 | +| 5.11.2.1 | Procedures in the MME ..... | 38 | +| 5.11.2.2 | Procedures in the VLR ..... | 38 | +| 5.11.2.2.1 | General description ..... | 38 | +| 5.11.2.2.2 | Abnormal cases ..... | 38 | +| 5.11.2.3 | Void ..... | 39 | +| 5.11.3 | Downlink unitdata procedure ..... | 39 | +| 5.11.3.1 | Procedures in the VLR ..... | 39 | +| 5.11.3.2 | Procedures in the MME ..... | 39 | +| 5.11.3.2.1 | General description ..... | 39 | +| 5.11.3.2.2 | Abnormal cases ..... | 39 | +| 5.11.3.3 | Void ..... | 39 | +| 5.11.4 | Release procedure ..... | 39 | +| 5.12 | Service request procedure ..... | 40 | +| 5.12.1 | General description ..... | 40 | +| 5.12.2 | Procedures in the MME ..... | 40 | + +| | | | +|--------|-----------------------------------------------------------------|----| +| 5.12.3 | Procedures in the VLR ..... | 40 | +| 5.13 | Service abort procedure..... | 41 | +| 5.13.1 | General description..... | 41 | +| 5.13.2 | Procedures in the VLR ..... | 41 | +| 5.13.3 | Procedures in the MME..... | 41 | +| 5.14 | Implicit IMSI detach from EPS services..... | 41 | +| 5.14.1 | General description..... | 41 | +| 5.14.2 | Procedures in the MME..... | 42 | +| 5.14.3 | Procedures in the VLR ..... | 42 | +| 5.15 | UE fallback supervision procedure ..... | 42 | +| 5.15.0 | General description..... | 42 | +| 5.15.1 | Procedures in the VLR ..... | 42 | +| 5.16 | Procedure for MO CSFB indication..... | 43 | +| 5.16.1 | General description..... | 43 | +| 5.16.2 | Procedures in the MME..... | 43 | +| 5.16.3 | Procedures in the VLR ..... | 43 | +| 6 | SGs transport..... | 43 | +| 6.1 | General ..... | 43 | +| 6.2 | IP layer ..... | 43 | +| 6.3 | Transport layer ..... | 43 | +| 7 | Error handling ..... | 44 | +| 7.1 | General ..... | 44 | +| 7.2 | Message too short..... | 44 | +| 7.3 | Unknown or unforeseen message type..... | 44 | +| 7.4 | Missing mandatory information element ..... | 45 | +| 7.5 | Information elements unknown or unforeseen in the message ..... | 45 | +| 7.6 | Out of sequence information elements..... | 45 | +| 7.7 | Repeated information elements..... | 45 | +| 7.8 | Syntactically incorrect mandatory information element..... | 45 | +| 7.9 | Syntactically incorrect optional information elements..... | 45 | +| 7.10 | Conditional information element errors ..... | 45 | +| 7.11 | Information elements with semantically incorrect contents..... | 46 | +| 8 | Message functional definitions and contents ..... | 46 | +| 8.1 | SGsAP-ALERT-ACK message..... | 46 | +| 8.2 | SGsAP-ALERT-REJECT message..... | 46 | +| 8.3 | SGsAP-ALERT-REQUEST message..... | 46 | +| 8.4 | SGsAP-DOWNLINK-UNITDATA message ..... | 47 | +| 8.5 | SGsAP-EPS-DETACH-ACK message..... | 47 | +| 8.6 | SGsAP-EPS-DETACH-INDICATION message ..... | 47 | +| 8.7 | SGsAP-IMSI-DETACH-ACK message ..... | 48 | +| 8.8 | SGsAP-IMSI-DETACH-INDICATION message ..... | 48 | +| 8.9 | SGsAP-LOCATION-UPDATE-ACCEPT message ..... | 48 | +| 8.9.1 | Message definition..... | 48 | +| 8.9.2 | New TMSI, or IMSI ..... | 48 | +| 8.10 | SGsAP-LOCATION-UPDATE-REJECT message ..... | 49 | +| 8.10.1 | Message definition..... | 49 | +| 8.10.2 | Location area identifier..... | 49 | +| 8.11 | SGsAP-LOCATION-UPDATE-REQUEST message ..... | 50 | +| 8.11.1 | Message definition..... | 50 | +| 8.11.2 | Old location area identifier ..... | 50 | +| 8.11.3 | TMSI status ..... | 50 | +| 8.11.4 | IMEISV ..... | 50 | +| 8.11.5 | TAI ..... | 50 | +| 8.11.6 | E-CGI ..... | 50 | +| 8.11.7 | TMSI based NRI container..... | 51 | +| 8.11.8 | Selected CS domain operator ..... | 51 | +| 8.12 | SGsAP-MM-INFORMATION-REQUEST ..... | 51 | +| 8.13 | SGsAP-PAGING-REJECT message..... | 51 | +| 8.14 | SGsAP-PAGING-REQUEST message..... | 51 | +| 8.14.1 | Message definition..... | 51 | + +| | | | +|---------|------------------------------------------------|----| +| 8.14.2 | TMSI..... | 52 | +| 8.14.3 | CLI..... | 52 | +| 8.14.4 | Location area identifier..... | 52 | +| 8.14.5 | Global CN-Id ..... | 52 | +| 8.14.6 | SS code ..... | 52 | +| 8.14.7 | LCS indicator..... | 53 | +| 8.14.8 | LCS client identity ..... | 53 | +| 8.14.9 | Channel needed ..... | 53 | +| 8.14.10 | eMLPP priority ..... | 53 | +| 8.14.11 | Additional paging indicators ..... | 53 | +| 8.14.12 | SM Delivery Timer..... | 53 | +| 8.14.13 | SM Delivery Start Time ..... | 53 | +| 8.14.4 | Maximum Retransmission Time ..... | 53 | +| 8.15 | SGsAP-RESET-ACK message ..... | 53 | +| 8.15.1 | Message definition..... | 53 | +| 8.15.2 | MME name ..... | 54 | +| 8.15.3 | VLR name ..... | 54 | +| 8.16 | SGsAP-RESET-INDICATION message ..... | 54 | +| 8.16.1 | Message definition..... | 54 | +| 8.16.2 | MME name ..... | 54 | +| 8.16.3 | VLR name ..... | 54 | +| 8.17 | SGsAP-SERVICE-REQUEST message ..... | 55 | +| 8.17.1 | Message definition..... | 55 | +| 8.17.2 | IMEISV ..... | 55 | +| 8.17.3 | UE Time Zone ..... | 55 | +| 8.17.4 | Mobile Station Classmark 2 ..... | 55 | +| 8.17.5 | TAI ..... | 55 | +| 8.17.6 | E-CGI ..... | 55 | +| 8.17.7 | UE EMM Mode ..... | 55 | +| 8.18 | SGsAP-STATUS message ..... | 56 | +| 8.18.1 | Message definition..... | 56 | +| 8.18.2 | IMSI..... | 56 | +| 8.19 | SGsAP-TMSI-REALLOCATION-COMPLETE message ..... | 56 | +| 8.20 | SGsAP-UE-ACTIVITY-INDICATION message..... | 56 | +| 8.20.1 | Maximum UE Availability Time..... | 56 | +| 8.21 | SGsAP-UE-UNREACHABLE message..... | 57 | +| 8.21.1 | Requested Retransmission Time ..... | 57 | +| 8.21.2 | Additional UE Unreachable indicators..... | 57 | +| 8.22 | SGsAP-UPLINK-UNITDATA message..... | 57 | +| 8.22.1 | Message definition..... | 57 | +| 8.22.2 | IMEISV ..... | 58 | +| 8.22.3 | UE Time Zone ..... | 58 | +| 8.22.4 | Mobile Station Classmark 2 ..... | 58 | +| 8.22.5 | TAI ..... | 58 | +| 8.22.6 | E-CGI ..... | 58 | +| 8.23 | SGsAP-RELEASE-REQUEST message ..... | 58 | +| 8.23.1 | Message definition..... | 58 | +| 8.23.2 | SGs Cause..... | 58 | +| 8.24 | SGsAP-SERVICE-ABORT-REQUEST message ..... | 58 | +| 8.24.1 | Message definition..... | 58 | +| 8.25 | SGsAP-MO-CSFB-INDICATION message..... | 59 | +| 8.25.1 | Message definition..... | 59 | +| 8.25.2 | TAI ..... | 59 | +| 8.25.3 | E-CGI ..... | 59 | +| 9 | Information element coding..... | 59 | +| 9.1 | Overview ..... | 59 | +| 9.2 | Message type ..... | 60 | +| 9.3 | Information element identifiers ..... | 61 | +| 9.3a | Length indicator ..... | 61 | +| 9.4 | Information elements..... | 61 | +| 9.4.1 | CLI..... | 61 | + +| | | | +|------------------------|---------------------------------------------|----| +| 9.4.2 | EPS location update type ..... | 62 | +| 9.4.3 | Erroneous message ..... | 62 | +| 9.4.3a | E-UTRAN Cell Global Identity ..... | 62 | +| 9.4.4 | Global CN-Id ..... | 63 | +| 9.4.5 | IMEISV ..... | 63 | +| 9.4.6 | IMSI ..... | 63 | +| 9.4.7 | IMSI detach from EPS service type ..... | 63 | +| 9.4.8 | IMSI detach from non-EPS service type ..... | 63 | +| 9.4.9 | LCS client identity ..... | 64 | +| 9.4.10 | LCS indicator ..... | 64 | +| 9.4.11 | Location area identifier ..... | 64 | +| 9.4.12 | MM information ..... | 65 | +| 9.4.13 | MME name ..... | 65 | +| 9.4.14 | Mobile identity ..... | 65 | +| 9.4.14a | Mobile Station Classmark 2 ..... | 65 | +| 9.4.15 | NAS message container ..... | 65 | +| 9.4.16 | Reject cause ..... | 66 | +| 9.4.17 | Service indicator ..... | 66 | +| 9.4.18 | SGs cause ..... | 66 | +| 9.4.19 | SS code ..... | 67 | +| 9.4.20 | TMSI ..... | 67 | +| 9.4.21 | TMSI status ..... | 67 | +| 9.4.21a | Tracking Area Identity ..... | 67 | +| 9.4.21b | UE Time Zone ..... | 68 | +| 9.4.21c | UE EMM mode ..... | 68 | +| 9.4.22 | VLR name ..... | 68 | +| 9.4.23 | Channel needed ..... | 69 | +| 9.4.24 | eMLPP priority ..... | 69 | +| 9.4.25 | Additional paging indicators ..... | 69 | +| 9.4.26 | TMSI based NRI container ..... | 69 | +| 9.4.27 | Selected CS domain operator ..... | 69 | +| 9.4.28 | Maximum UE Availability Time ..... | 70 | +| 9.4.29 | SM Delivery Timer ..... | 70 | +| 9.4.30 | SM Delivery Start Time ..... | 70 | +| 9.4.31 | Additional UE Unreachable indicators ..... | 71 | +| 9.4.32 | Maximum Retransmission Time ..... | 71 | +| 9.4.33 | Requested Retransmission Time ..... | 72 | +| 10 | List of system variables ..... | 72 | +| 10.1 | Timers ..... | 72 | +| 10.2 | Retry counters ..... | 73 | +| Annex A (informative): | Change history ..... | 74 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 1 Scope + +CS Fallback in the Evolved Packet System (EPS) enables the provisioning of CS-domain services (e.g. voice call, Location Services (LCS) or supplementary services) by reuse of CS infrastructure when the UE is served by E-UTRAN. Additionally, SMS delivery via the CS core network is realized without CS fallback. + +The present document specifies the procedures and the SGs Application Part (SGsAP) messages used on the SGs interface between the Mobility Management Entity (MME) in the EPS and the Visitor Location Register (VLR), to allow location management coordination and to relay certain messages related to GSM circuit switched services over the EPS system. + +The present document also specifies the use of Stream Control Transmission Protocol (SCTP) for the transport of SGsAP messages. + +The present document is applicable to the MME in the EPS and to the VLR. The functional split between the MME and the VLR is defined in 3GPP TS 23.272 [7]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 22.101: "Service aspects; Service principles". +- [3] 3GPP TS 23.003: "Numbering, addressing and identification". +- [4] 3GPP TS 23.007: "Restoration procedures". +- [5] 3GPP TS 23.018: "Basic call handling; Technical realization". +- [5AA] 3GPP TS 23.078: "Customised Applications for Mobile network Enhanced Logic (CAMEL) Phase 4; Stage 2". +- [5A] 3GPP TS 23.081: "Line identification supplementary services". +- [5B] 3GPP TS 23.082: "Call Forwarding (CF) supplementary services". +- [6] Void. +- [6A] 3GPP TS 23.236: "Intra-domain connection of Radio Access Network (RAN) nodes to multiple Core Network (CN) nodes". +- [7] 3GPP TS 23.272: "Circuit Switched Fallback in Evolved Packet System; Stage 2". +- [7A] 3GPP TS 23.251: "Network Sharing; Architecture and Functional Description". +- [7B] 3GPP TS 23.401: "GPRS enhancements for E-UTRAN access". +- [8] 3GPP TS 24.008: "Mobile radio interface Layer 3 specification; Core network protocols; Stage 3". +- [9] 3GPP TS 24.010: "Supplementary services specification; General aspects". + +- [10] 3GPP TS 24.011: "Point-to-Point (PP) Short Message Service (SMS) support on mobile radio interface". +- [11] 3GPP TS 24.030: "Location Services (LCS); Supplementary service operations; Stage 3". +- [12] 3GPP TS 24.081: "Line Identification Supplementary Services - Stage 3". +- [13] 3GPP TS 24.082: "Call Forwarding (CF) supplementary services; Stage 3". +- [14] 3GPP TS 24.301: "Non-Access-Stratum (NAS) protocol for Evolved Packet System (EPS); Stage 3". +- [15] 3GPP TS 29.002: "Mobile Application Part (MAP) specification". +- [15A] 3GPP TS 29.011: "Signalling interworking for supplementary services". +- [16] 3GPP TS 29.018: "Serving GPRS Support Node (SGSN) - Visitors Location Register (VLR) Gs interface layer 3 specification". +- [16A] 3GPP TS 29.060: General Packet Radio Service (GPRS);GPRS Tunnelling Protocol (GTP) across the Gn and Gp interface. +- [17] 3GPP TS 29.272: "MME and SGSN Related Interfaces Based on Diameter Protocol". +- [17A] 3GPP TS 29.274: "3GPP Evolved Packet System (EPS); Evolved General Packet Radio Service (GPRS) Tunnelling Protocol for Control plane (GTPv2-C); Stage 3". +- [17B] 3GPP TS 32.250: "Telecommunication management; Charging management; Circuit Switched (CS) domain charging". +- [18] 3GPP TS 32.422: "Telecommunication management; Subscriber and equipment trace; Trace control and configuration management (CM)". +- [19] 3GPP TS 36.331: "Evolved Universal Terrestrial Radio Access (E-UTRA); Radio Resource Control (RRC) protocol specification". +- [20] IETF RFC 791 (September 1981): "Internet Protocol". +- [21] Void. +- [22] IETF RFC 2460 (December 1998): "Internet Protocol, Version 6 (IPv6) Specification". +- [23] IETF RFC 4960 (September 2007): "Stream Control Transmission Protocol". +- [24] 3GPP TS 22.067: "enhanced Multi Level Precedence and Pre-emption service (eMLPP); Stage 1". +- [25] 3GPP TS 23.067: "enhanced Multi-Level Precedence and Pre-emption service (eMLPP); Stage 2". +- [26] 3GPP TS 23.216: "Single Radio Voice Call Continuity (SRVCC); Stage 2". +- [27] Void. + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] apply. Additionally the following definitions of 3GPP TS 24.301 [14] apply: + +**Non-EPS services** +**SMS only** + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 23.272 [7] apply: + +**CS fallback** + +### **SMS over SGs** + +### **SMS in MME** + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 23.251 [7A] apply: + +### **Common PLMN** + +### **Gateway core network (GWCN)** + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 24.301 [14] apply: + +### **In NB-S1 mode** + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|-------|--------------------------------------| +| LCS | Location Services | +| MME | Mobility Management Entity | +| NEAF | Non-EPS Alert Flag | +| SCTP | Stream Control Transmission Protocol | +| SGsAP | SGs Application Part | +| SMS | Short Message Service | +| PSI | Provide Subscriber Information | + +# --- 4 Description of the SGs association between a VLR and an MME + +## 4.1 General + +CS fallback function and SMS delivery via the CS core network is realized by reusing Gs interface mechanisms as defined in 3GPP TS 29.018 [16] on the interface between the MME in the EPS and the VLR. This interface is called SGs interface. + +NOTE: Within this specification, the term VLR refers to MSC/VLR or MSC Server/VLR. + +The SGs interface connects the databases in the VLR and the MME. The procedures described in the present document are used to co-ordinate the location information of UEs that are IMSI attached to both EPS and non-EPS services. The SGs interface is also used to convey some circuit switched related procedures via the MME. + +The basis for the interworking between a VLR and an MME is the existence of a SGs association between those entities per UE. The SGs association is applicable to UEs which are configured to use CS fallback and SMS over SGs, or SMS over SGs only. The SGs association is not applicable if the subscriber data indicates that the subscription is for packet only. The SGs association is also not applicable if the MME is registered for SMS for the UE as specified in 3GPP TS 23.272 [7]. + +In NB-S1 mode, the SGs association is also applicable to UEs supports NB-S1 mode only to use SMS over SGs only. + +The behaviour of the VLR and the MME entities related to the SGs interface are defined by the state of the SGs association for a UE. Individual SGs association states are maintained at both the VLR and the MME for each UE. + +## 4.2 SGs association at the VLR + +### 4.2.1 General + +The states associated to the SGs interface in the VLR are specified in subclause 4.2.2 and the state diagram at the VLR is shown in figure 4.2.2.1. The state diagram does not include the message error handling specified in clause 7. + +### 4.2.2 States at the VLR + +#### SGs-NULL + +There is no SGs association with an MME for the UE and therefore the VLR considers that the UE is IMSI detached for EPS services. In this state no SGsAP-MM-INFORMATION-REQUEST messages are sent to the MME. The VLR may initiate paging on the SGs interface if the "Confirmed by Radio Contact" restoration indicator in the VLR is set to "false" (see 3GPP TS 23.007 [4]). Any message from the MME is ignored except SGsAP-LOCATION-UPDATE-REQUEST, SGsAP-IMSI-DETACH-INDICATION and SGsAP-EPS-DETACH-INDICATION. + +#### LA-UPDATE-PRESENT + +The VLR has received an SGsAP-LOCATION-UPDATE-REQUEST message from the MME. In this state, the VLR may be waiting for the outcome of the Update Location procedure from the HSS, if the IMSI is not known in the VLR. For UEs which are configured to use CS fallback and SMS over SGs, or SMS over SGs only, the VLR sends SGsAP-PAGING-REQUEST messages via the SGs interface. + +#### SGs-ASSOCIATED + +The VLR considers that the UE is attached to both EPS and non-EPS services. For UEs which are configured to use CS fallback and SMS over SGs, or SMS over SGs only, the VLR sends SGsAP-PAGING-REQUEST messages via the SGs interface. The VLR can perform the MM information procedure. + +![State diagram at the VLR showing three states: From one of the three states (at the VLR), SGs-NULL, LA-UPDATE-PRESENT, and SGs-ASSOCIATED. Transitions are triggered by various messages and events.](af6be343f0c0a8f155f965dcf337b8af_img.jpg) + +``` + +stateDiagram-v2 + [*] --> SGs-NULL + [*] --> LA-UPDATE-PRESENT + [*] --> SGs-ASSOCIATED + + SGs-NULL --> SGs-NULL : Reset received from the MME + SGs-NULL --> SGs-NULL : VLR failure + SGs-NULL --> SGs-NULL : Detach indication received from the MME or the UE + SGs-NULL --> SGs-NULL : Location Update Request received from the UE via the A interface or via the Iu interface, or from the SGSN via the Gs interface + SGs-NULL --> LA-UPDATE-PRESENT : Location Update Request received from the MME + LA-UPDATE-PRESENT --> SGs-NULL : Location Update Reject + LA-UPDATE-PRESENT --> SGs-ASSOCIATED : Location Update Request received from the MME + LA-UPDATE-PRESENT --> LA-UPDATE-PRESENT : Send paging + LA-UPDATE-PRESENT --> SGs-NULL : Paging Failure or Alert Failure received + SGs-ASSOCIATED --> SGs-NULL : SGsAP-UE-UNREACHABLE message received + SGs-ASSOCIATED --> SGs-NULL : TMSI Reallocation received + SGs-ASSOCIATED --> LA-UPDATE-PRESENT : Location Update Request received from the MME + SGs-ASSOCIATED --> SGs-ASSOCIATED : Send paging + +``` + +State diagram at the VLR showing three states: From one of the three states (at the VLR), SGs-NULL, LA-UPDATE-PRESENT, and SGs-ASSOCIATED. Transitions are triggered by various messages and events. + +NOTE: Receipt of an SGsAP-RESET-INDICATION message from the MME may change or not the state of the SGs interface of all the associations associated to the restarted MME, see subclause 5.8.3. + +Figure 4.2.2.1: State diagram at the VLR + +## 4.3 SGs association at the MME + +### 4.3.1 General + +The MM context variables associated to the SGs interface in the MME are specified in subclause 4.3.2 and states associated to the SGs interface in the MME are specified in subclause 4.3.3. The state diagram at the MME is shown in figure 4.3.3.1. The state diagram does not include the message error handling specified in clause 7. + +### 4.3.2 MM context variables at the MME + +#### VLR-Reliable: + +Boolean set to "false" when the MME has received a reset indication from the VLR. The MME may: + +- upon reception of a combined tracking area update request from a UE that is still attached for non-EPS services, perform immediately the location update for non-EPS services procedure; or +- upon reception of a periodic tracking area update request from a UE that is still attached for non-EPS services, dependent on network configuration and operator policy, + - perform a network initiated detach with detach type "IMSI detach" immediately after the completion of the periodic tracking area update procedure; or + - perform immediately the location update for non-EPS services procedure. + +#### MME-Reset: + +Boolean set to "true" when the MME restarts after a failure. The "MME-Reset" restoration indicator is unique within an MME and it applies to all the MM contexts stored in the MME. + +### 4.3.3 States at the MME + +#### SGs-NULL + +There is no SGs association with a VLR for the UE and therefore the MME considers that the UE is IMSI detached for non-EPS services. In this state the MME accepts SGsAP-PAGING-REQUEST messages to UEs only if: + +- the "MME-Reset" restoration indicator in the MME is set to "true"; or +- the MME supports the CS restoration indicator set in the Additional paging indicators information element in the SGs-PAGING-REQUEST message. + +#### LA-UPDATE-REQUESTED + +The MME has sent an SGsAP-LOCATION-UPDATE-REQUEST message to the VLR. In this state the MME waits for the outcome of the Update Location for non-EPS services procedure at the VLR before sending the response to the UE. In this state the MME accepts SGsAP-PAGING-REQUEST messages. + +#### SGs-ASSOCIATED + +The MME stores an SGs association for the UE. In this state the MME performs the location update for non-EPS services procedure towards the VLR, e.g. when the location area is changed. All conditions describing when to trigger the location update for non-EPS services procedure are listed in subclause 5.2.2.2. + +![State diagram at the MME showing transitions between SGs-NULL, SGs-ASSOCIATED, and LA-UPDATE-REQUESTED states.](a33da0f14e456f92539ce3e9b7d81f9a_img.jpg) + +``` + + stateDiagram-v2 + direction TB + + State1: From one of the three states (at the MME) + State2: SGs-NULL + State3: SGs-ASSOCIATED + State4: LA-UPDATE-REQUESTED + + State1 --> State2: MME failure + State1 --> State2: Send any detach indication to the VLR + + State2 --> State2: Paging received + State2 --> State4: Send Location Update Request to the VLR + + State4 --> State2: Location Update Reject received + State4 --> State3: Location Update Accept received + State4 --> State4: Paging received + + State3 --> State2: Normal tracking area update request received from the UE + State3 --> State2: Combined tracking area update request received from the UE with conditions listed in subclause 5.2.2.2. + State3 --> State2: Periodic tracking area update request received from the UE with conditions listed in subclause 5.2.2.2. + State3 --> State2: [Any other case] Combined tracking area update request or periodic tracking area update request received from the UE + + State3 --> State3: Paging received + State3 --> State3: Send SGsAP-UE-UNREACHABLE message + State3 --> State3: Send TMSI Reallocation + + State2 --> State3: Normal tracking area update request received from the UE + +``` + +State diagram at the MME showing transitions between SGs-NULL, SGs-ASSOCIATED, and LA-UPDATE-REQUESTED states. + +**Figure 4.3.3.1: State diagram at the MME** + +### 4.3.4 State transitions in the MME without SGsAP signalling + +During the tracking area update procedure or routing area update procedure (see 3GPP TS 23.401 [7B]) and if the SGs association is not SGs-NULL, the MME may change the state of the SGs association to SGs-NULL upon receipt of a SGSN Context Acknowledge (see 3GPP TS 29.060 [16A]) or Context Acknowledge message without ISR activation (see 3GPP TS 29.274 [17A]) from the target network. + +During the inter-system handover from S1 mode to A/Gb mode or Iu mode, or handover from S1 mode to S1 mode (see 3GPP TS 23.401 [7B]) and if the SGs association is not SGs-NULL, the MME may change the state of the SGs association to SGs-NULL upon receipt of a Forward Relocation Complete (see 3GPP TS 29.060 [16A]) or Forward Relocation Complete Notification message without ISR activation (see 3GPP TS 29.274 [17A]) from the target network. + +If the MME receives a normal attach request, attach request for emergency bearer services or a normal tracking area update request from the UE in state SGs-ASSOCIATED, the MME shall change the state of the SGs association to SGs-NULL. + +If it is required by network configuration or operator policy, the MME shall change the state of the SGs association to SGs-NULL if the following conditions are fulfilled: + +- the MME receives an EXTENDED SERVICE REQUEST message with service type set to "mobile originating CS fallback emergency call or 1xCS fallback emergency call"; +- the state of the SGs association is not SGs-NULL; and +- the MME determines that the UE is not available for PS services at the target RAT as described in 3GPP TS 23.272 [7]. + +### 4.3.5 State transitions in the VLR without SGsAP signalling + +Based on configuration, during PS to CS SRVCC from E-UTRAN (see 3GPP TS 23.216 [26]) and if the SGs association is not SGs-NULL, the VLR may change the state of the SGs association to SGs-NULL upon receipt of a Relocation Complete/Handover Complete message from target RNS/BSS. + +# --- 5 Procedures for SGs + +## 5.1 Paging for non-EPS services procedure + +### 5.1.1 General description + +This procedure is used by the VLR to send an SGsAP-PAGING-REQUEST message to a UE. This procedure applies to UEs that are simultaneously attached for EPS services and non-EPS services, or for EPS services and SMS only. + +### 5.1.2 Procedures in the VLR + +#### 5.1.2.1 General + +The VLR shall handle the timers, queuing and retransmission for sending the SGsAP-PAGING-REQUEST message on the SGs interface in the same way that it handles the sending of a PAGING message on the A or Iu interface. + +#### 5.1.2.2 Paging Initiation + +When a VLR has to page a UE, the VLR shall check whether the VLR has a SGs association for that UE. The VLR sends SGsAP-PAGING-REQUEST messages to the MME if the MME is in service and the state of the SGs association for the UE is in any of the following states: + +- SGs-ASSOCIATED; +- LA-UPDATE-PRESENT or +- SGs-NULL and the "Confirmed by Radio Contact" restoration indicator is set to "false". + +If the VLR detects that the MME serving the UE is no longer in service and the VLR supports MT CS services delivery via an alternative MME in the MME pool as defined in 3GPP TS 23.007 [4], the VLR shall send the SGs-PAGING-REQUEST message to one alternative MME in the same MME pool. The VLR shall set the CS restoration indicator in the Additional paging indicators information element. + +NOTE 1: The VLR can detect that an MME is no longer in service if there are no SCTP associations in service with that MME. + +The sending of the SGsAP-PAGING-REQUEST message does not change the state of the SGs association with the MME. + +If the "Confirmed by Radio Contact" restoration indicator is set to "true", the VLR shall include the Location area identifier information element into the SGsAP-PAGING-REQUEST message, otherwise (i.e. after a VLR failure), the VLR shall not include the Location area identifier information element. When sending the SGsAP-PAGING-REQUEST message, the VLR shall start timer Ts5. + +If the state of the SGs association is SGs-NULL and the "Confirmed by Radio Contact" restoration indicator is set to "false", the VLR shall also perform a search procedure as specified in 3GPP TS 23.018 [5]. + +In this message, the VLR includes the Service indicator information element which will be used to indicate the type of CS service. If the SGs paging request is sent as a result of reception of Provide Subscriber Information Request message, the VLR sets the Service indicator information element to either "SMS indicator" or "CS call indicator" as specified in subclause 7.2.3.5 of 3GPP TS 23.018 [5]. For SMS, SMS indicator is used. For all the other CS services, CS call indicator is used. + +If the network supports CSFB priority call handling (see 3GPP TS 23.272 [7]) and the call was received with an eMLPP priority level indication (see 3GPP TS 24.008 [8], 3GPP TS 22.067 [24] and 3GPP TS 23.067 [25]), the VLR shall include the value of the received priority level indication in the eMLPP priority information element in the SGsAP-PAGING-REQUEST message. + +The eMLPP priority information element may be used to derive the appropriate priority of a SCTP association for the SGsAP-PAGING-REQUEST message. + +If the Calling Line Identification of the service (see 3GPP TS 24.081 [12]) is available in the VLR, the VLR may include the CLI information element in the SGsAP-PAGING-REQUEST message. The conditions specified in 3GPP TS 23.081 [5A] and 3GPP TS 29.011 [15A] apply also here. + +If the paging is due to a NW-initiated Call Independent SS procedure as defined in 3GPP TS 24.010 [9], the VLR may include the SS code in the SGsAP-PAGING-REQUEST message as defined in 3GPP TS 29.002 [15]. + +NOTE 2: The SS code used by the VLR does not link to a specific supplementary service. The VLR can use any SS code defined in 3GPP TS 29.002 [15], in the SGsAP-PAGING-REQUEST message. + +If the paging is due to a Mobile Terminated Location Request as defined in 3GPP TS 24.030 [11], the VLR shall include LCS indicator in the SGsAP-PAGING-REQUEST message. Additionally, the VLR may include LCS client identity as defined in 3GPP TS 29.002 [15] in the SGsAP-PAGING-REQUEST message. + +For Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), if the paging was due to SMS and the SM Delivery Timer and SM Delivery Start Time IEs were received from the SMS-GMSC as defined in 3GPP TS 29.002 [15], the VLR may include these IEs in the SGsAP-PAGING-REQUEST message. + +For Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), if the paging was due to SMS and the Maximum Retransmission Time IE was received from the SMS-GMSC as defined in 3GPP TS 29.002 [15], the VLR may include the received Maximum Retransmission Time IE in the SGsAP-PAGING-REQUEST message. + +While domain specific access control of the PS domain is ongoing, the VLR shall be configured to send paging messages on both the SGs and the A/Iu interface. + +The VLR may apply implementation specific rules for sending the paging on the A/Iu interface. Dependent on network configuration or operator policy, if the UE does not respond to a first paging on SGs interface or the VLR considers UE fallback was failed as described in subclause 5.15.1, and A/Iu paging has not been initiated already, the VLR shall page on the A/Iu interface. + +#### 5.1.2.3 Paging Response + +The VLR stops the paging procedure towards the MME on expiry of timer Ts5 or on receipt of a SGsAP-SERVICE-REQUEST message from the MME. + +On receipt of an SCCP connection establishment containing the Initial L3 message from the UE via the A or Iu interface, the VLR shall stop the paging procedure. + +Upon receiving the SGsAP-SERVICE-REQUEST message with the UE EMM mode information element indicating "EMM-CONNECTED", if the Service indicator information element in the SGsAP-SERVICE-REQUEST message indicates "CS call indicator" and Call Forwarding on No Reply (CFNRy) is activated for the subscriber, the VLR shall start the CFNRy timer as specified in 3GPP TS 23.082 [5B]. + +If the paging response is received via the A or Iu interface from a location area which differs from the one stored in the VLR, the VLR shall move the SGs association to the SGs-NULL state after the UE has been authenticated successfully. + +NOTE 2: UE sends this paging response as a result of receiving paging request with IMSI and with CN domain indicator set to "CS" (see 3GPP TS 24.301 [14]). + +#### 5.1.2.4 Paging Failure + +On receipt of an SGsAP-PAGING-REJECT message before the timer Ts5 expires, the VLR stops timer Ts5. If the SGs cause information element in the SGsAP-PAGING-REJECT message does not indicate "Mobile terminating CS fallback call rejected by the user", the SGs association is moved to the SGs-NULL state and within this state the SGs association is marked with the contents of the SGs cause information element. If the SGs cause information element in the SGsAP-PAGING-REJECT message indicates "IMSI detached for EPS services" the VLR shall send the paging message on the A/Iu interface. If the SGs cause information element indicates "Mobile terminating CS fallback call rejected by the user", the SGs association state shall not be changed. + +When the VLR receives the SGsAP-PAGING-REJECT message with the SGs cause information element indicating "Mobile terminating CS fallback call rejected by the user", the VLR shall trigger User Determined User Busy (UDUB) as specified in 3GPP TS 24.082 [13]. + +#### 5.1.2.5 UE unreachable + +On receipt of an SGsAP-UE-UNREACHABLE message before the timer Ts5 expires, the VLR stops timer Ts5, and the paging procedure for that paging request towards the MME is stopped. The state of the SGs association at the VLR is unchanged. + +For Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), if the paging was due to SMS and the VLR included the SM-Delivery-Timer and SM-Delivery-Start-Time IEs in the SGsAP-PAGING-REQUEST, and if the SM Buffer Request Indicator bit is set in the Additional UE Unreachable indicators IE in the SGsAP\_UE\_UNREACHABLE message, the VLR may buffer the Short Message until the time indicated in the SGsAP-PAGING-REQUEST or until receipt of any earlier SGsAP message for the UE. + +For Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), if the Retransmission Time IE was included in the SGsAP-UE-UNREACHABLE message, the VLR may forward the received Requested Retransmission Time IE to the SMS-GMSC as defined in 3GPP TS 29.002 [15]. In this case, the VLR shall not set the MNRF flag. + +NOTE 1: A/Iu paging can be ongoing. + +NOTE 2: If the VLR considers the paging procedure completed, and no response from the UE has been received, and CFNRc has been configured and activated for the terminating UE, the VLR applies the equivalent handling as for Call Forwarding on Not Reachable, as specified in 3GPP TS 23.082 [5B] and 3GPP TS 29.011 [15A]. + +### 5.1.3 Procedures in the MME + +#### 5.1.3.1 General + +The MME accepts SGsAP-PAGING-REQUEST messages in any state of the SGs association. In the SGs-NULL state, the MME accepts SGsAP-PAGING-REQUEST messages only if: + +- the "MME-Reset" restoration indicator is set to "true"; or +- the MME supports MT CS services delivery via an alternative MME in the MME pool as defined in 3GPP TS 23.007 [4] and the CS restoration indicator is set in the Additional paging indicators information element in the SGs-PAGING-REQUEST message. + +When a MME receives a SGsAP-PAGING-REQUEST message from a VLR, the MME shall first check if the UE is known by the MME. The handling of the paging request depends on the state of the SGs association, the EMM context variables at the MME, and the Service indicator information element in the SGsAP-PAGING-REQUEST message. The MME shall process the paging request and subsequent SGs procedures related to this request preferentially compared to other normal procedures if the SGsAP-PAGING-REQUEST message includes the eMLPP priority information element and if the MME determines the CS call has high priority based on the received value in the eMLPP priority information element (see 3GPP TS 23.272 [7]). + +If the Service indicator information element in the SGsAP-PAGING-REQUEST message indicates "CS call indicator", the MME shall handle the paging request as follows: + +- If the UE is known: + - if the UE is considered to be IMSI attached for EPS services and "SMS only", the MME shall return an SGsAP-PAGING-REJECT message to the VLR indicating in the SGs cause information element "Mobile terminating CS fallback call rejected by the user"; + - if the UE is considered to be IMSI attached for EPS and non-EPS services (i.e. the SGs association is not in the state SGs-NULL), the MME shall page the UE based on the location information stored in the MME, i.e. in all tracking areas of the stored list. If the SGsAP-PAGING-REQUEST message does not include the Location area identifier information element, the MME may set the "VLR-Reliable" MM context variable to "false". If ISR is activated, and in addition the SGsAP-PAGING-REQUEST message does not include the Location area identifier or the "VLR-Reliable" MM context variable in the MME is set to "false", then the MME shall send Detach Notification (Local Detach) message to the associated SGSN; + - if the MME detects that the UE currently has an ongoing IMS emergency session as specified in subclause 4.6a, 3GPP TS 23.272 [7], the MME shall return an SGsAP-PAGING-REJECT message to the + +VLR indicating in the SGs cause information element "Mobile terminating CS fallback call rejected by the user"; + +- if the MME detects that the UE currently has an EPS bearer context with QCI=1 and the MME determines that SRVCC (as specified in 3GPP TS 23.216 [26]) is not supported in the network or it determines that the UE does not support SRVCC, MME shall return SGsAP-PAGING-REJECT message to that VLR with SGs cause information element "Mobile terminating CS fallback call rejected by the user"; + - if the UE is marked as IMSI detached for EPS services or IMSI (implicitly or explicitly) detached for non-EPS services (i.e. the state of the SGs association is SGs-NULL): + - if the UE is in the EMM-DEREGISTERED state (see 3GPP TS 24.301 [14]) and if the MME supports MT CS services delivery via an alternative MME in the MME pool and the CS restoration indicator is set in the SGsAP-PAGING-REQUEST message, the MME shall send the paging request with the location information provided by the VLR, regardless of the value of the "MME-Reset" indicator. If no such location information is provided, the MME may either page the UE in all the tracking areas served by that MME or in the tracking areas served by the MME and by the VLR, or reject the paging request per operator policy; + - otherwise, the MME shall return an SGsAP-PAGING-REJECT message to that VLR indicating in the SGs cause information element the detach circumstance ("IMSI detached for EPS services", "IMSI detached for non-EPS services" or "IMSI implicitly detached for non-EPS services"); + - if the UE is marked as unreachable, indicated by Paging Proceed Flag set to "false", and the ISR is not activated, the MME shall return an SGsAP-UE-UNREACHABLE message to that VLR indicating in the SGs cause information element "UE unreachable". The state of the SGs association does not change at the MME; or + - if the UE is marked as unreachable, indicated by Paging Proceed Flag set to "false", and the ISR is activated, the MME shall not return an SGsAP-UE-UNREACHABLE message to that VLR. If the SGsAP-PAGING-REQUEST message does not include the Location area identifier or the "VLR-Reliable" MM context variable in the MME is set to "false", then the MME shall send Detach Notification (Local Detach) message to the associated SGSN; Otherwise the MME shall forward the paging request to the associated SGSN, as described in 3GPP TS 29.274 [17A]. +- b) If the UE is not known and the "MME-Reset" restoration indicator at the MME is set to "false" and if: +- the MME does not support MT CS services delivery via an alternative MME in the MME pool; or + - the MME supports MT CS services delivery via an alternative MME in the MME pool and the CS restoration indicator is not set in the SGsAP-PAGING-REQUEST message; +- the MME shall handle the paging request as follows: +- the MME shall return an SGsAP-PAGING-REJECT message to that VLR indicating in the SGs cause information element "IMSI unknown". +- c) If the UE is not known and if: +- the "MME-Reset" restoration indicator at the MME is set to "true"; or + - the MME supports MT CS services delivery via an alternative MME in the MME pool and the CS restoration indicator is set in the SGsAP-PAGING-REQUEST message; +- the MME shall handle the paging request as follows: +- if the MME only supports "SMS only", the MME shall return an SGsAP-PAGING-REJECT message to the VLR indicating in the SGs cause information element "Mobile terminating CS fallback call rejected by the user"; + - if the SGsAP-PAGING-REQUEST message includes the Location area identifier information element, the MME shall page the UE in all the tracking areas served by the MME that can be mapped to the location area indicated in the Location area identifier information element; or + +- if the SGsAP-PAGING-REQUEST message does not include the Location area identifier information element, the MME may page in all the tracking areas served by the MME, or the tracking areas served by the MME and by the VLR or reject the paging request per operator policy. + +If the Service indicator information element in the SGsAP-PAGING-REQUEST message indicates "SMS indicator", the MME shall handle the paging request as follows: + +a) If the UE is known: + +- if the UE is considered to be IMSI attached for EPS and non-EPS services or IMSI attached for EPS services and "SMS only", the MME shall page the UE based on the location information stored in the MME. If the SGsAP-PAGING-REQUEST message does not include the Location area identifier information element, the MME may set the "VLR-Reliable" MM context variable to "false". If the UE is using eDRX, the MME may, subject to local operator policy, return an SGsAP-UE-UNREACHABLE message to the VLR indicating in the SGs cause information element "UE temporarily unreachable" while continuing to page the UE. If ISR is activated, and in addition the SGsAP-PAGING-REQUEST message does not include the Location area identifier or the "VLR-Reliable" MM context variable in the MME is set to "false", then the MME shall send Detach Notification (Local Detach) message to the associated SGSN; or + +NOTE 2: If location area identifier information element is included in the SGsAP-PAGING-REQUEST, it is not used in paging the UE. + +- for Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), if the UE is using eDRX, the SGsAP-PAGING-REQUEST message includes the SM Delivery Timer and SM Delivery Start Time IEs, and the UE is expected to be reachable before the time indicated by the SM-Delivery-Timer and SM-Delivery-Start-Time IEs, the MME may return an SGsAP-UE-UNREACHABLE message to the VLR indicating in the SGs cause information element "UE temporarily unreachable" and setting the SM Buffer Request Indicator bit in the Additional UE Unreachable indicators information element. The state of the SGs association does not change at the MME. The MME should then page the UE when the UE is expected to be reachable. +- for Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), if the UE is using eDRX and the SGsAP-PAGING-REQUEST message includes the Maximum Retransmission Time IEs, the MME may return an SGsAP-UE-UNREACHABLE message to that VLR indicating in the SGs cause information element "UE temporarily unreachable" and including the Requested Retransmission Time IE. In this case, the MME shall set the NEAF. The state of the SGs association does not change at the MME. + +NOTE 3: This mechanism does not cause additional signalling at the HLR to retransmit the Short Message. + +- if the UE is marked as IMSI detached for EPS services or IMSI (implicitly or explicitly) detached for non-EPS services, or as unreachable, the MME shall proceed as specified for the case when the service indicator indicates "CS call indicator". + +b) If the UE is not known and the "MME-Reset" restoration indicator at the MME is set to "false" and if: + +- the MME does not support MT CS services delivery via an alternative MME in the MME pool; or +- the MME supports MT CS services delivery via an alternative MME in the MME pool and the CS restoration indicator is not set in the SGsAP-PAGING-REQUEST message; + +the MME shall handle the paging request as follows: + +- the MME shall return an SGsAP-PAGING-REJECT message to that VLR indicating in the SGs cause information element "IMSI unknown". + +c) If the UE is not known and if: + +- the "MME-Reset" restoration indicator at the MME is set to "true"; or +- the MME supports MT CS services delivery via an alternative MME in the MME pool and the CS restoration indicator is set in the SGsAP-PAGING-REQUEST message; + +the MME shall handle the paging request as follows: + +- if the SGsAP-PAGING-REQUEST message includes the Location area identifier information element, the MME shall page the UE in all the tracking areas served by the MME that can be mapped to the location area indicated in the Location area identifier information element; or + +- if the SGsAP-PAGING-REQUEST message does not include the Location area identifier information element, the MME may page in all the tracking areas served by the MME, or the tracking areas served by the MME and by the VLR or reject the paging request per operator policy. + +#### 5.1.3.2 Procedure when no NAS signalling connection exists + +If the Service indicator information element in the SGsAP-PAGING-REQUEST message indicates "CS call indicator" and the MME accepts the paging request, the MME shall proceed as follows: + +- If the SGsAP-PAGING-REQUEST message includes the Location area identifier and the "VLR-Reliable" MM context variable in the MME is set to "true": +- if the UE is considered to be IMSI attached for EPS and non-EPS services, the MME pages the UE with CN domain indicator set to "CS". + +if + +- the SGsAP-PAGING-REQUEST message includes the IMSI without TMSI and the location area stored in the MME is the same as the one received in the SGsAP-PAGING-REQUEST message and S-TMSI can be retrieved, and the operator's policy allows the use of S-TMSI as paging address; or + +NOTE: The operator's policy is related to MSC pool in target RAT. + +- the SGsAP-PAGING-REQUEST message includes the TMSI and the location area stored in the MME is the same as the one received in the SGsAP-PAGING-REQUEST message; + +then the MME uses the S-TMSI as paging address at the radio interface; else the MME uses the IMSI; and + +- if the UE is not known, or is marked as IMSI detached for EPS services or IMSI (implicitly or explicitly) detached for non-EPS services, the MME pages the UE with IMSI and CN domain indicator set to "PS". +- If the SGsAP-PAGING-REQUEST message does not include the Location area identifier, or the "VLR-Reliable" MM context variable in the MME is set to "false": +- if the UE is considered to be IMSI attached for EPS and non-EPS services, the MME uses IMSI as a paging address at the radio interface and CN domain indicator set to "CS". When the MME receives the paging response from the UE, the MME requests the UE to re-attach for non-EPS services as described in 3GPP TS 24.301 [14]; and +- if the UE is not known, or is marked as IMSI detached for EPS services or IMSI (implicitly or explicitly) detached for non-EPS services, the MME pages the UE with IMSI with CN domain indicator set to "PS" to force the UE to re-attach to EPS and non-EPS services as described in 3GPP TS 24.301 [14]. + +If the Service indicator information element in the SGsAP-PAGING-REQUEST message indicates "SMS indicator" and the MME accepts the paging request, the MME shall proceed as follows: + +- If the SGsAP-PAGING-REQUEST message includes the Location area identifier and the "VLR-Reliable" MM context variable in the MME is set to "true": +- if the UE is considered to be IMSI attached for EPS and non-EPS services or IMSI attached for EPS services and "SMS only", the MME shall use the S-TMSI as paging address at the radio interface with CN domain indicator set to "PS". The MME takes action as described in 3GPP TS 24.301 [14], subclause 5.6.2.4; and +- if the UE is not known, or is marked as IMSI detached for EPS services or IMSI (implicitly or explicitly) detached for non-EPS services, the MME pages the UE with IMSI as paging address at the radio interface with CN domain indicator set to "PS". The MME takes action as described in 3GPP TS 24.301 [14], subclause 5.6.2.4. +- If the SGsAP-PAGING-REQUEST message does not include the Location area identifier information element or the "VLR-Reliable" MM context variable is set to "false": +- if the UE is considered to be IMSI attached for EPS and non-EPS services or IMSI attached for EPS services and for "SMS only", the MME uses S-TMSI as paging address at the radio interface with CN domain indicator set to "PS". When the MME receives the paging response from the UE, the MME requests the UE to re-attach for non-EPS services as specified in 3GPP TS 24.301 [14]; and + +- if the UE is not known, or is marked as IMSI detached for EPS services or IMSI (implicitly or explicitly) detached for non-EPS services, the MME pages the UE with IMSI with CN domain indicator set to "PS" to force the UE to re-attach to EPS and non-EPS services as described in 3GPP TS 24.301 [14]. + +Independent of the Service indicator information element, if the MME has activated Idle mode Signalling Reduction for the UE, the MME shall forward the paging request to the associated SGSN, as described in 3GPP TS 29.274 [17A]. + +Independent of the Service indicator information element, the MME shall not retransmit the paging message to the UE. Additionally, if the MME has activated Idle mode Signalling Reduction for the UE, the MME shall not retransmit the paging request to the associated SGSN. + +#### 5.1.3.3 Procedure when a NAS signalling connection exists + +If the Service indicator information element in the SGsAP-PAGING-REQUEST message indicates "CS call indicator" and the MME accepts the paging request, the MME shall proceed as follows: + +- The MME requests the UE to re-attach for non-EPS services as specified in 3GPP TS 24.301 [14] if the SGsAP-PAGING-REQUEST message does not include the Location area identifier, or the "VLR-Reliable" MM context variable in the MME is set to "false"; and +- otherwise, the MME sends the CS SERVICE NOTIFICATION message to the UE through the NAS signalling connection, including the CS service related parameters (CLI, SS code, LCS indicator and LCS client identity), received from the VLR. + +If the Service indicator information element in the SGsAP-PAGING-REQUEST message indicates "SMS indicator" and the MME accepts the paging request, the MME shall proceed as follows: + +- If the Location area identifier information element is not included in the SGsAP-PAGING-REQUEST message or the "VLR-Reliable" MM context variable is set to "false", the MME requests the UE to re-attach for non-EPS services as specified in 3GPP TS 24.301 [14]; and +- otherwise, the MME need not take any action towards the UE. + +## 5.2 Location update for non-EPS services procedure + +### 5.2.1 General description + +The location update for non-EPS services procedure is a general procedure used by UEs which are configured to use CS fallback and SMS over SGs, or SMS over SGs only. This procedure is not performed if: + +- the subscriber data indicates that the subscription is for packet only; or +- the MME is registered for SMS for the UE (see 3GPP TS 23.272 [7]). + +NOTE: For the cases specified above, the registration with a VLR is not required and the MME does not initiate the location update for non-EPS services procedure. + +This procedure allows UEs and the network to perform: + +- combined IMSI attach for EPS and non-EPS services or for SMS only; +- IMSI attach for non-EPS services or for SMS only if the UE is already IMSI attached for EPS services; +- normal location update procedure to the VLR if the UE is IMSI attached for both EPS and non-EPS services, or for SMS only; or +- allocation of new TMSI to an UE. + +The location update for non-EPS services procedure in the SGs interface is always started as a consequence of a direct action from the UE. The combined attach and tracking area update procedures are further specified in 3GPP TS 23.272 [7] and 3GPP TS 24.301 [14]. + +When a UE is IMSI attached for EPS and non-EPS services, the VLR shall stop any implicit detach timer. Instead the MME uses the "Paging Proceed Flag" to determine the likely availability of the UE to the network. Upon reception of the periodic Tracking Area Update message, the MME does not report to the VLR, and the MME shall not change the + +state of the SGs association. When the UE performs a detach only for EPS services or the MME performs an implicit detach for EPS services, and the VLR's implicit detach timer is not already running, the EPS detach indication to the VLR shall cause the VLR's implicit detach timer to be restarted from its initial value. + +If the MME performs an implicit detach for both EPS and non-EPS services, then the MME shall send to the VLR an SGsAP-IMSI-DETACH-INDICATION message with cause "Implicit network initiated IMSI detach from EPS and non-EPS services", as further described in subclause 5.6 (the implicit IMSI detach message indicates that the UE is unavailable for both EPS and non-EPS services). + +### 5.2.2 Procedures in the MME + +#### 5.2.2.1 General + +The location update for non-EPS services procedure is initiated with a combined attach or a combined tracking area update procedure. On receipt of an ATTACH REQUEST message or a TRACKING AREA UPDATE REQUEST message from the UE, the MME handles the EPS related request as specified in 3GPP TS 24.301 [14]. + +When the MME receives the Update Location Answer message containing subscription data from the HSS, the MME determines whether it needs to perform location update for non-EPS services procedure. For the cases identified below, if the MME is configured with ability not to perform registrations with a VLR for the UE, the MME sends response message to the UE without starting the location update for non-EPS services procedure: + +- if the Network Access Mode (NAM) subscription data indicates that the subscription is for packet only (see 3GPP TS 29.272 [17]); or +- if the Network Access Mode (NAM) subscription data indicates that the subscription is for packet and circuit (see 3GPP TS 29.272 [17]) and the MME is registered for SMS as specified in annex C of 3GPP TS 23.272 [7] for this UE. + +NOTE 1: When the MME supports both SMS in MME feature and SMS over SGs, depending on UE capability and/or network configuration and/or "PS and SMS only" subscription, it can be preferred to provide SMS services via SMS in MME to avoid the VLR registration. + +Otherwise, the MME shall start the location update for non-EPS services procedure and shall wait for the outcome of both location update procedures towards the VLR and the HSS before sending the response message to the UE. + +NOTE 2: When the combined attach or tracking area update procedure is for both EPS services and non-EPS services and the MME is not registered for SMS for the UE (see 3GPP TS 23.272 [7]) and the UE has "PS and SMS only" subscription, the MME starts the location update for non-EPS services procedure for SMS over SGs only. + +#### 5.2.2.2 Location update initiation + +##### 5.2.2.2.1 General + +If timer Ts6-1 is not running, the MME shall start the location update for non-EPS services procedure when it receives from the UE: + +- an attach request indicating combined EPS/IMSI attach; +- a combined tracking area update request indicating Combined TA/LA updating with IMSI attach; +- a combined tracking area update request and the MME detects that the LAI has changed; +- a combined tracking area update request and the state of the SGs association is SGs-NULL; or +- a combined tracking area update request and the MME serving the UE has changed. + +If timer Ts6-1 is not running, the MME may start the location update for non-EPS services procedure when it receives from the UE: + +- a combined tracking area update request or a periodic tracking area update , if the MM context variable "VLR-Reliable" for the UE is set to "false" (see subclause 5.7.3). + +If multiple PLMNs are available for the CS domain, the MME shall select a PLMN for CS domain as specified in 3GPP TS 23.272 [7]. If the MME cannot select any PLMN for CS domain for the UE, the MME informs the UE that the CS domain is not available. + +The MME shall determine the new location area identification as follows: + +- if the MME received a combined attach request or combined tracking area update request from the UE with an indication for "SMS only", or the network only supports "SMS only" or the network only has a few VLRs that support SGs interface, the MME may allocate a default location area identification specifically configured for that case; +- else the MME derives the location area identification from the current tracking area identity where the UE is located. For this the MME may take any access restrictions provided by the HSS into account, if the network is using separate location areas for GERAN and UTRAN cells. + +The MME shall derive the VLR name from the location area identification which was determined. For networks supporting the feature 'Intra Domain Connection of RAN Nodes to Multiple CN Nodes', the VLR name is derived as described in 3GPP TS 23.236 [6A]. The MME shall include the location area identification in the new location area identifier information element in the SGsAP-LOCATION-UPDATE-REQUEST message. + +NOTE 1: The selection of the VLR in the MME follows the same rule as the selection of the VLR in the SGSN, as defined in 3GPP TS 23.236 [6A]. + +In networks supporting the feature 'Intra Domain Connection of RAN Nodes to Multiple CN Nodes' (3GPP TS 23.236 [6A]), if the TMSI based NRI container is not received from the UE, and the MME determines that the serving VLR of the UE is changed, the MME shall include in the Old location area identifier a specific LAI value which is not broadcasted in the network and not associated with any VLR. + +NOTE 2: The MME determines that the serving VLR of the UE is changed when the SGs association changes from one serving VLR to a different one, or based on implementation dependent criteria. + +NOTE 3: When the VLR receives the SGsAP-LOCATION-UPDATE-REQUEST message with the specific LAI value, the VLR retrieves the MM context of the UE from the HLR. + +In networks supporting the feature "Intra Domain Connection of RAN Nodes to Multiple CN Nodes" as defined in 3GPP TS 23.236 [6A], the MME shall support load re-distribution of UEs to another VLR than the current one. When the MME receives a periodic tracking area update request or a combined tracking area update request, the MME shall check whether for this UE there is a SGs association to a VLR for which load re-distribution has been initiated in the MME by O&M. If this is the case and + +- if a combined tracking area update request is received, the MME shall derive the new VLR name as described in 3GPP TS 23.236 [6A] and then send the SGsAP-LOCATION-UPDATE-REQUEST message to the new selected VLR; or +- if a periodic tracking area update request is received, dependent on network configuration and operator policy, the MME shall take one of the following actions: + - perform a network initiated detach with detach type "IMSI detach" immediately after the completion of the periodic tracking area update procedure; or + - derive the new VLR name as described in 3GPP TS 23.236 [6A] and then send the SGsAP-LOCATION-UPDATE-REQUEST message to the new selected VLR. + +If the VLR is configured for gateway core network (GWCN), the MME shall select a CS domain operator as specified in 3GPP TS 23.272 [7] and proceed as follows: + +- If the preferred RAT of the selected CS domain operator is GERAN and the UE does not support GERAN network sharing (see 3GPP TS 24.008 [8], subclause 10.5.5.12), the MME shall include the selected CS domain operator in the selected CS domain operator information element, and the common PLMN in the new location area identifier information element in the SGsAP-LOCATION-UPDATE-REQUEST message; or +- If only common PLMN ID and no multiple PLMN IDs are provided in CS domain for selection by the UE (see 3GPP TS 23.251 [7A], subclause 4.2.3.1), the MME shall include the selected CS domain operator in the selected CS domain operator information element, and the common PLMN in the new location area identifier information element in the SGsAP-LOCATION-UPDATE-REQUEST message. + +If multiple PLMN IDs are provided in CS domain for selection by the UE and the UE supports GERAN network sharing (see 3GPP TS 24.008 [8], subclause 10.5.5.12), the MME shall include the selected PLMN for CS domain in the new location area identifier information element as specified in 3GPP TS 23.251 [7A]. + +The SGsAP-LOCATION-UPDATE-REQUEST message includes the type of location update performed by the UE in the EPS location update type information element. If the UE has performed a combined attach or a combined tracking area update indicating "combined TA/LA updating with IMSI attach", the MME indicates "IMSI attach", otherwise the MME indicates "Normal location update". + +The MME shall include the TMSI status in the SGsAP-LOCATION-UPDATE-REQUEST message if the UE indicates in the ATTACH REQUEST or the TRACKING AREA UPDATE REQUEST message that it has no valid TMSI available. The MME shall also include the old location area identifier in the SGsAP-LOCATION-UPDATE-REQUEST message if the UE included the old location area identification in the ATTACH REQUEST or TRACKING AREA UPDATE REQUEST message. + +The MME shall include the TMSI based NRI container in the SGsAP-LOCATION-UPDATE-REQUEST message if received from the UE. + +If the MME supports the "Automatic Device Detection" (see 3GPP TS 22.101 [2]) or the "Trace for Management Based Activation/Deactivation" (see 3GPP TS 32.422 [18]), the MME shall include the IMEISV in the SGsAP-LOCATION-UPDATE-REQUEST message. + +The MME shall add the UE's current TAI and E-CGI to the SGsAP-LOCATION-UPDATE-REQUEST message. + +When the MME sends the SGsAP-LOCATION-UPDATE-REQUEST, the MME shall start timer Ts6-1. + +If timer Ts6-1 is running and the MME receives from the UE: + +- an attach request indicating combined EPS/IMSI attach; or +- a combined tracking area update with or without IMSI attach. + +Then: + +- if the LAI determined by the MME is the same as in the outstanding request, the MME shall not process this new request and shall wait for the VLR response to the ongoing procedure; +- if the LAI determined by the MME is different but the VLR name is the same as for previous LAI, any response from the VLR to the outstanding request is ignored, the MME shall stop and reset timer Ts6-1 and the MME shall start the location update for non-EPS services procedure; or +- if the LAI determined by the MME is different and the VLR name is different as for previous LAI, any response from the previously addressed VLR to the outstanding request is ignored, the MME shall stop and reset timer Ts6-1, and the MME shall start the location update for non-EPS services procedure. + +When the MME receives from the UE a tracking area update request and the MME serving the UE has changed, the MME shall stop and reset timer Ts6-1. + +##### 5.2.2.2.2 VLR fails without restart + +If the MME supports restoration for CS services via an alternative VLR as defined in 3GPP TS 23.007 [4] and, upon reception of a combined tracking area update request or a periodic tracking area update request from the UE, the MME determines that the VLR serving the UE is no longer in service, the MME may: + +- if a combined tracking area update request is received, select an alternative VLR that is in service for the UE and immediately perform the location update for non-EPS services procedure towards the selected VLR as described in subclause 5.2; or +- if a periodic tracking area update request is received, dependent on network configuration and operator policy, + - perform a network initiated detach with detach type "IMSI detach" immediately after the completion of the periodic tracking area update procedure and then select an alternative VLR that is in service for the UE during the subsequent combined tracking area update procedure, before performing the location update for non-EPS services procedure towards the selected VLR as described in subclause 5.2; or + +- select an alternative VLR that is in service for the UE and immediately perform the location update for non-EPS services procedure towards the selected VLR as described in subclause 5.2. + +If the MME supports restoration for CS services via an alternative VLR as defined in 3GPP TS 23.007 [4] and, upon reception of an UPLINK NAS TRANSPORT message (see 3GPP TS 24.301 [14]) from the UE, the MME determines that the VLR serving the UE is no longer in service, the MME may: + +- request the UE to re-attach for non-EPS services as specified in 3GPP TS 24.301 [14] and then select an alternative VLR that is in service for the UE during the subsequent combined tracking area update procedure, before performing the location update for non-EPS services procedure towards the selected VLR as described in subclause 5.2. + +NOTE 1: How an MME detects a VLR is no longer in service and triggers selection of alternative VLR is implementation dependent. + +NOTE 2: To avoid large amounts of UEs initiating re-attach for non-EPS services simultaneously, the MME can ignore some MO-SMS. Selection of MO-SMS to ignore is implementation dependent. + +#### 5.2.2.3 Location update response + +If the MME receives an SGsAP-LOCATION-UPDATE-ACCEPT message from the VLR, the MME shall stop timer Ts6-1 and: + +- move the state of the SGs association to SGs-ASSOCIATED; +- set the MM context variable "VLR-Reliable" to "true"; and +- indicate to the UE the acceptance of the VLR to the location update procedure. The message sent to the UE includes the Location Area Identity (see 3GPP TS 24.301 [14]). + +The MME shall wait for the outcome of the location update for non-EPS services procedure towards the VLR before sending a response to location update procedure to the UE. When the MME receives an SGsAP-LOCATION-UPDATE-REJECT message from the VLR, it will map the reject cause received to the appropriate reject cause as specified in 3GPP TS 24.301 [14], and report this reject cause to the UE. + +If the VLR included the Mobile identity information element in the SGsAP-LOCATION-UPDATE-ACCEPT message, the MME shall relay the information received to the UE. If the Mobile identity information element contains a new TMSI, this will cause the UE to perform a TMSI reallocation procedure. In this case, the MME shall send to the VLR the SGsAP-TMSI-REALLOCATION-COMPLETE message when the MME receives the ATTACH COMPLETE or the TRACKING AREA UPDATE COMPLETE message from the UE. If the Mobile identity information element contains an IMSI, this will cause the UE to deallocate its TMSI. + +#### 5.2.2.4 Location update failure + +If the MME receives an SGsAP-LOCATION-UPDATE-REJECT message from the VLR, the MME + +- shall stop timer Ts6-1; +- shall move the state of the SGs association to SGs-NULL; and +- indicates to the UE the rejection of the Location Update procedure by the VLR as specified in 3GPP TS 24.301 [14]. The Reject cause value sent by the VLR shall be mapped to the appropriate reject cause as specified in 3GPP TS 24.301 [14], and the latter is forwarded to the UE. + +NOTE: Upon receiving an SGsAP-LOCATION-UPDATE-REJECT message with MM cause #11 or MM cause #13, if the MME is configured to know that the VPLMN has a suitable roaming agreement for E-UTRAN with the HPLMN of the UE, the MME can map the MM cause to EMM cause #18 as specified in 3GPP TS 24.301 [14]. + +#### 5.2.2.5 Abnormal cases + +If timer Ts6-1 expires, the MME shall abort the Location Update for non-EPS service procedure and indicate this to the UE with the Reject cause value 'MSC temporarily not reachable'. The state of the SGs association to the VLR shall be SGs-NULL. + +If the MME receives an SGsAP-LOCATION-UPDATE-ACCEPT message and timer Ts6-1 is not running then: + +- if timer Ts8 is running (see subclause 5.4), the message shall be ignored; +- if timer Ts9 is running (see subclause 5.5), the message shall be ignored; or +- if timers Ts8 and Ts9 are not running: + - if the state of the SGs association to the VLR is SGs-ASSOCIATED, the message shall be ignored; or + - if the state of the SGs association to the VLR is different than SGs-ASSOCIATED, the message shall be treated as a message incompatible with the protocol state of the MME (see subclause 7.3). + +#### 5.2.2.6 Additional MME procedure for UE supporting NB-S1 mode only + +This subclause applies when the UE supporting NB-S1 mode only requests SMS services via a normal attach request or tracking area update request. + +If the UE supporting NB-S1 mode only requests SMS services using normal attach request or tracking area update request, the location update for non-EPS services procedure can be initiated by the MME when SMS over SGs is used. + +If timer Ts6-1 is not running, the MME shall start the location update for non-EPS services procedure when it receives from the UE: + +- an attach request indicating EPS attach and "SMS only" in NB-S1 mode, SMS services via SMS in MME are not available and SMS over SGs is used for the UE; +- a tracking area update request indicating TA updating and "SMS only" in NB-S1 mode, SMS services via SMS in MME are not available, SMS over SGs is used for the UE and the MME detects that the LAI has changed; +- a tracking area update request indicating TA updating and "SMS only" in NB-S1 mode, SMS services via SMS in MME are not available, SMS over SGs is used for the UE and the state of the SGs association is SGs-NULL; or +- a tracking area update request indicating TA updating and "SMS only" in NB-S1 mode, SMS services via SMS in MME are not available, SMS over SGs is used for the UE and the MME detects that the MME serving the UE has changed. + +NOTE 1: When the MME supports both SMS in MME feature and SMS over SGs, depending on UE capability and/or network configuration and/or "PS and SMS only" subscription, it can be preferred to provide SMS services via SMS in MME to avoid the VLR registration. + +NOTE 2: The UE does not include the MS Classmark 2 IE in a normal attach request or normal tracking area update request, and the MME does not store this information or include it in subsequent messages to the VLR. Services that use information part of MS Classmark 2, e.g. CAMEL, can therefore fail when SMS over SGs is provided via normal procedures. + +If the MME has a stored TMSI for the UE, the MME may include this TMSI in the TMSI based NRI container IE in the SGsAP-LOCATION-UPDATE-REQUEST message. Otherwise the MME shall indicate "no valid TMSI available" in the TMSI status IE in the SGsAP-LOCATION-UPDATE-REQUEST message. + +If the MME received a normal attach request or normal tracking area update request from the UE with an indication for "SMS only", the MME may allocate a default location area identification specifically configured for that case. + +If the MME receives an SGsAP-LOCATION-UPDATE-ACCEPT message from the VLR, the MME shall: + +- stop timer Ts6-1 and move the state of the SGs association to SGs-ASSOCIATED; +- set the MM context variable "VLR-Reliable" to "true"; and +- indicate to the UE the acceptance of SMS services as specified in 3GPP TS 24.301 [14]. + +NOTE 3: The message sent to the UE does not include the Location Area Identity or the Mobile identity information element if received from the VLR. + +If the VLR included the Location area identifier or the Mobile identity information element in the SGsAP-LOCATION-UPDATE-ACCEPT message, the MME may store the received Location area identifier or the Mobile identity information element for the subsequent location update for non-EPS services procedure for the UE. If the Mobile identity information element contains a new TMSI, the MME may send to the VLR the SGsAP-TMSI-REALLOCATION-COMPLETE message when the MME indicates to the UE the acceptance of SMS services. If the Mobile identity information element contains an IMSI, the MME may delete any stored TMSI for the UE. + +If the MME receives an SGsAP-LOCATION-UPDATE-REJECT message from the VLR, the MME shall: + +- stop timer Ts6-1 and move the state of the SGs association to SGs-NULL; and +- indicate to the UE the rejection of SMS services as specified in 3GPP TS 24.301 [14]. The MME maps the location update reject cause received from the VLR to an appropriate value as specified in 3GPP TS 24.301 [14] and forwards to the UE. + +If timer Ts6-1 expires, the MME shall abort the Location Update for non-EPS service procedure. The MME indicates to the UE the rejection of SMS services by setting an appropriate value and shall as specified in 3GPP TS 24.301 [14] and forwards to the UE. The state of the SGs association to the VLR shall be SGs-NULL. + +### 5.2.3 Procedures in the VLR + +#### 5.2.3.1 General + +When a VLR receives an SGsAP-LOCATION-UPDATE-REQUEST message, the VLR checks whether the IMSI is known. If the IMSI is not known, the VLR retrieves the MM context of the UE from the HSS. + +In networks supporting the feature 'Intra Domain Connection of RAN Nodes to Multiple CN Nodes' (3GPP TS 23.236 [6A]), if the TMSI based NRI container is received in the SGsAP-LOCATION-UPDATE-REQUEST message, the VLR derives the NRI value. If the NRI value is not allocated by the VLR, the VLR retrieves the MM context of the UE from the HSS. + +When the VLR is configured for gateway core network (GWCN), the VLR shall select the serving CS domain operator as follows: + +- If the selected CS domain operator information element is received in the SGsAP-LOCATION-UPDATE-REQUEST message, the VLR shall select the serving CS domain operator as specified in the selected CS domain operator information element; +- If the selected CS domain operator information element is not received in the SGsAP-LOCATION-UPDATE-REQUEST message and the PLMN ID included in the new location area identifier information element identifies a CS domain operator, the VLR shall select the serving CS domain operator as specified in the new location area identifier information element; +- Otherwise, the VLR selects the serving CS domain operator based on local policies. + +#### 5.2.3.2 Location update response + +If the location update is accepted by the VLR and, if necessary, by the HSS, the VLR shall: + +- move the SGs association to the SGs-ASSOCIATED state; +- set the "Confirmed by Radio Contact" restoration indicator to "true"; +- update the SGs association by storing the MME address included in SGsAP-LOCATION-UPDATE-REQUEST message; and +- send an SGsAP-LOCATION-UPDATE-ACCEPT message to the sending MME. This message includes the location area identifier received in the New location area identifier information element in the previous SGsAP-LOCATION-UPDATE-REQUEST message. + +After the VLR has updated the SGs association, if Ts5 is still running for a MT service for this UE, the VLR shall repeat SGs Paging Request towards the updated SGs association. + +#### 5.2.3.3 Location update failure + +If the location update is rejected by the VLR, the VLR shall: + +- send an SGsAP-LOCATION-UPDATE-REJECT message to the MME with the appropriate reject cause as indicated in 3GPP TS 24.008 [8] and shall indicate to the MME the Location area identifier received in the corresponding SGsAP-LOCATION-UPDATE-REQUEST message; and +- move the SGs association to SGs-NULL. + +#### 5.2.3.4 TMSI reallocation procedure + +If the VLR decides to allocate a new TMSI to the UE, the VLR shall include the new TMSI in the SGsAP-LOCATION-UPDATE-ACCEPT message. After sending the SGsAP-LOCATION-UPDATE-ACCEPT message with a new TMSI the VLR shall start timer Ts6-2. If the VLR decides to deallocate the TMSI of the UE, the VLR shall include the IMSI of the UE in the SGsAP-LOCATION-UPDATE-ACCEPT message. + +Upon receipt of the SGsAP-TMSI-REALLOCATION-COMPLETE message, the VLR shall stop the timer Ts6-2 and consider the new TMSI as valid. + +If the IMSI was sent to the UE, the VLR considers the old TMSI if available, as deleted. + +If no SGsAP-TMSI-REALLOCATION-COMPLETE message is received by the VLR before the timer Ts6-2 expires, the VLR shall abort the TMSI reallocation procedure. The VLR shall consider the old TMSI if available, occupied until the new TMSI is used in a subsequent A/Iu message, or for an implementation dependent time. The outcome of the TMSI reallocation procedure does not change the state of the SGs association. The VLR uses the IMSI or a TMSI, either the new TMSI or the old TMSI if available, for paging. + +NOTE: Whether the new TMSI or old TMSI is used in the SGs paging request does not impact the paging procedure or UE response. + +#### 5.2.3.5 Abnormal cases + +The following abnormal cases can be identified: + +##### i) MM signalling via A or Iu interface + +If the VLR receives a Location Update request or an IMSI detach indication from the UE by the A or Iu interface when the state of the SGs association in the VLR is not SGs-NULL, the VLR shall move the state of the SGs association to SGs-NULL. + +##### ii) Additional Location Update Request + +If the state of the SGs association in the VLR is LA-UPDATE PRESENT and an SGsAP-LOCATION-UPDATE-REQUEST message is received, then: + +- if the message is from the same MME and indicates the same New location area identifier information element as the outstanding location update request, then the VLR shall ignore this additional SGsAP-LOCATION-UPDATE-REQUEST message; +- if the message is from the same MME but indicates a different New location area identifier information element to the outstanding location update request, then the VLR shall treat this additional SGsAP-LOCATION-UPDATE-REQUEST message and the VLR shall not send any response to the previous SGsAP-LOCATION-UPDATE-REQUEST message; or +- if the message is from a different MME (indicating either the same or different New location area identifier information element) to the outstanding location update request, then the VLR shall treat this additional SGsAP-LOCATION-UPDATE-REQUEST message and the VLR shall not send any response to the previous SGsAP-LOCATION-UPDATE-REQUEST message. + +##### iii) Detach signalling from the MME + +If the state of the SGs association in the VLR is LA-UPDATE PRESENT and either an SGsAP-EPS-DETACH-INDICATION or an SGsAP-IMSI-DETACH-INDICATION message is received, then the VLR shall abandon the Location Update for non-EPS services procedure (neither an SGsAP-LOCATION-UPDATE-ACCEPT nor + +an SGsAP-LOCATION-UPDATE-REJECT messages is sent) and the further actions described in subclauses 5.4 or 5.5 or 5.6 are followed. + +##### iv) Signalling via Gs interface + +If the VLR receives for a UE a BSSAP+-LOCATION-UPDATE-REQUEST message (as defined in 3GPP TS 29.018 [16]) from an SGSN when the state of the SGs association for this UE in the VLR is not SGs-NULL, the VLR shall move the state of the SGs association to SGs-NULL. + +##### v) New Location Update Request during TMSI reallocation procedure + +If the VLR receives an SGsAP-LOCATION-UPDATE-REQUEST message while Ts6-2 is running, the VLR shall stop timer Ts6-2, abort the TMSI reallocation procedure and proceed with the new location update for non-EPS services procedure. If the VLR needs to page the MS during the new location update for non-EPS services procedure, the VLR uses the IMSI or a TMSI, either the new TMSI from the aborted TMSI reallocation procedure or the old TMSI if available, for paging. + +NOTE: Whether the new TMSI or old TMSI is used in the SGs paging request does not impact the paging procedure or UE response. + +##### vi) Reset signalling from the MME + +If the state of the SGs association in the VLR is LA-UPDATE PRESENT and an SGsAP-RESET-INDICATION message is received from the MME, then the VLR shall abandon the Location Update for non-EPS services procedure (neither an SGsAP-LOCATION-UPDATE-ACCEPT nor an SGsAP-LOCATION-UPDATE-REJECT messages is sent) and the further actions described in subclause 5.8 are followed. + +##### vii) Collision between A or Iu paging and Location Update Request + +If the VLR receives Location Update Request when A or Iu paging is ongoing, then the VLR may abort paging procedure over A or Iu interface and may initiate paging procedure over SGs interface after location updating procedure has successfully completed. + +## 5.3 Non-EPS alert procedure + +### 5.3.1 General description + +This procedure is used by the VLR to request from an MME an indication when any signalling activity from the UE is detected. This procedure can be invoked at any time by the VLR. The MME shall acknowledge the SGsAP-ALERT-REQUEST message. + +### 5.3.2 Procedures in the VLR + +#### 5.3.2.1 Alert Initiation + +The VLR may start the Non-EPS alert procedure at any time. When the VLR wants to request from an MME that further activity from a UE is reported by the MME, the VLR shall send an SGsAP-ALERT-REQUEST message to that MME. The VLR starts timer Ts7 when the SGsAP-ALERT-REQUEST message is sent. + +### 5.3.2.2 Alert Response + +When an SGsAP-ALERT-ACK message is received, the VLR shall stop the timer Ts7. The state of the SGs association is not changed. + +#### 5.3.2.3 Alert Failure + +If an SGsAP-ALERT-REJECT message is received, the VLR shall stop the timer Ts7, move the state of the SGs association to SGs-NULL and within this state the SGs association is marked with the contents of the SGs cause information element. + +#### 5.3.2.4 Alert Indication + +The VLR shall not change the state of the SGs association upon reception of an SGsAP-UE-ACTIVITY-INDICATION message. + +For Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), if the SGsAP-UE-ACTIVITY-INDICATION message includes the Maximum UE Availability Time IE and the MNRF flag is set in the VLR, the VLR may forward the Maximum UE Availability Time IE to the HLR as defined in 3GPP TS 29.002 [15]. + +### 5.3.2.5 Abnormal cases + +If no SGsAP-ALERT-ACK message is received before the timer Ts7 expires, the VLR shall retransmit the SGsAP-ALERT-REQUEST message a maximum of Ns7 times. + +NOTE: If no SGsAP-ALERT-ACK message is received after that, a report is made to the O&M system. The state of the SGs association is not changed. + +## 5.3.3 Procedures in the MME + +### 5.3.3.1 Alert response + +The MME may receive an SGsAP-ALERT-REQUEST message in any state of the SGs association. Upon receipt of an SGsAP-ALERT-REQUEST message from the VLR and if the IMSI is known in the MME, the MME shall reply with an SGsAP-ALERT-ACK message and set the NEAF. If the MME has activated Idle mode Signaling Reduction for the UE, the MME shall send an Alert MME Notification message to the associated SGSN, as described in 3GPP TS 29.274 [17A], except for the conditions specified in subclause 8.2.5c of 3GPP TS 23.272 [7]. + +### 5.3.3.2 Alert failure + +If an SGsAP-ALERT-REQUEST message is received for an IMSI that is unknown at the MME, the MME shall return an SGsAP-ALERT-REJECT message to the VLR indicating the SGs cause information element value "IMSI unknown". + +### 5.3.3.3 Alert indication + +The MME shall report to the VLR upon detection of any activity in E-UTRAN (either signalling or, indirectly detected via S-GW, data transfer) from the UE if the NEAF is set. If the MME detects EPS signalling that leads to a procedure towards the VLR, the MME shall follow this procedure and reset the NEAF. If the MME detects activity that does not lead to any procedure towards the VLR, the MME shall send an SGsAP-UE-ACTIVITY-INDICATION message towards the VLR and reset the NEAF. Upon receipt of a UE Activity Notification message from the SGSN, the MME shall reply with a UE Activity Acknowledge message, send an SGsAP-UE-ACTIVITY-INDICATION message to the VLR and reset the NEAF flag. + +For Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), if the UE is using eDRX, the MME may include the Maximum UE Availability Time IE in the SGsAP-UE-ACTIVITY-INDICATION message. + +NOTE: This information can be used by the SMS Service Center to prioritize the retransmission of pending Mobile Terminated Short Messages to UEs using eDRX. + +## 5.4 Explicit IMSI detach from EPS services + +### 5.4.1 General description + +This procedure is used by the MME to indicate to the VLR that the UE has been detached from EPS services and therefore the SGs association between the MME and the VLR has to be deactivated. This procedure only applies to UEs which are not in the SGs-NULL state at the MME. The procedures specified in this subclause apply to EPS detach indication initiated by the UE or by the network as specified in 3GPP TS 24.301 [14]. + +The procedure is also used by the MME to indicate to the VLR when a combined tracking area update procedure has been rejected by the MME, except when the MME performs the NAS level mobility management congestion control as specified in 3GPP TS 24.301 [14], or the MME receives the Detach Notification from the SGSN, as described in 3GPP TS 29.274 [17A], when Idle mode Signalling Reduction is activated. + +The procedure is also used by the MME to indicate to the VLR when a periodic tracking area update procedure has been rejected by the MME, except when the MME performs the NAS level mobility management congestion control as specified in 3GPP TS 24.301 [14], for a UE for which an SGs association exists. + +The Explicit IMSI detach from EPS services procedure aborts any other ongoing procedure related to this UE on the SGs interface in the MME and in the VLR. + +## 5.4.2 Procedures in the MME + +### 5.4.2.1 Explicit EPS detach initiation + +The MME shall send an SGsAP-EPS-DETACH-INDICATION message to a VLR if: + +- the MME receives a detach for EPS from the UE; +- the MME performs network initiated EPS detach procedure; +- the combined tracking area update procedure is rejected by the MME, except when the MME performs the NAS level mobility management congestion control as specified in 3GPP TS 24.301 [14]; +- the periodic tracking area update procedure is rejected by the MME, except when the MME performs the NAS level mobility management congestion control as specified in 3GPP TS 24.301 [14], for a UE for which an SGs association exists; or +- the MME receives a Detach Notification from the SGSN with the Detach type indicating "PS Detach". + +If the MME receives a Detach Request from a UE or Detach Notification from an SGSN and the state of the SGs association to a VLR for that UE is not SGs-NULL, the MME shall check the detach type indicated in the Detach Request message or the detach type indicated in the Detach Notification message. If the UE has indicated EPS detach the MME shall send an SGsAP-EPS-DETACH-INDICATION message to the VLR indicating "UE initiated IMSI detach from EPS services". + +If the MME performs a network initiated detach procedure and the state of the SGs association to a VLR for that UE is not SGs-NULL, the MME shall send an SGsAP-EPS-DETACH-INDICATION message to the VLR indicating "Network initiated IMSI detach from EPS services". + +If the combined or periodic tracking area update procedure is rejected at the MME, except when the MME performs the NAS level mobility management congestion control as specified in 3GPP TS 24.301 [14], for a UE with an SGs association state different from SGs-NULL, the MME shall send an SGsAP-EPS-DETACH-INDICATION to the VLR indicating "EPS services not allowed". + +After sending of the SGsAP-EPS-DETACH-INDICATION message, the MME shall move the state of the SGs association to SGs-NULL. The MME shall start timer Ts8 upon transmission of the SGsAP-EPS-DETACH-INDICATION message and the MME shall stop and reset timer Ts6-1 if running. + +### 5.4.2.2 Explicit EPS detach response + +If the MME receives an SGsAP-EPS-DETACH-ACK message from the VLR, the MME shall stop timer Ts8. If a confirmation of the detach needs to be sent to the UE, the MME shall not wait for the reception of the SGsAP-EPS-DETACH-ACK message to send such confirmation. + +### 5.4.2.3 Abnormal cases + +If no SGsAP-EPS-DETACH-ACK message is received by the MME in response to a previous SGsAP-EPS-DETACH-INDICATION message before timer Ts8 expires, the MME shall repeat the SGsAP-EPS-DETACH-INDICATION message a maximum of Ns8 times. + +NOTE: If no SGsAP-EPS-DETACH-ACK message is received after that, a report is made to the O&M system. The state of the SGs association during the acknowledgement procedure remains SGs-NULL. + +## 5.4.3 Procedures in the VLR + +When a VLR receives an SGsAP-EPS-DETACH-INDICATION message, the VLR shall send an SGsAP-EPS-DETACH-ACK message to the sending MME. The VLR shall check the MME name indicated in the SGsAP-EPS-DETACH-INDICATION message. If the received MME name is not changed comparing to the MME name stored in the VLR, the VLR shall move the state of the SGs association for the UE from any state to SGs-NULL and marks the SGs association as "detached for EPS services". Otherwise, the VLR shall not change the state of the SGs association. + +If the VLR's implicit detach timer is not running then the VLR shall set and restart the implicit detach timer upon reception of an SGsAP-EPS-DETACH-INDICATION message. If the VLR's implicit detach timer is running (the state of the SGs association was already SGs-NULL) then the reception of an SGsAP-EPS-DETACH-INDICATION message shall not affect VLR's implicit detach timer. + +## 5.5 Explicit IMSI detach from non-EPS services + +### 5.5.1 General description + +This procedure is used by the MME to indicate to the VLR that the UE has performed IMSI detach from non-EPS services and therefore the SGs association between the MME and the VLR has to be deactivated. This procedure applies only to UEs for which there is a SGs association at the MME. The procedures specified in this subclause apply only to IMSI detach request, combined IMSI and EPS detach requests from the UE or Detach Notification message from an SGSN. + +The explicit IMSI detach from non-EPS services procedure aborts any other ongoing procedure related to this UE on the SGs interface in the MME and in the VLR. + +In order to ensure that the VLR and the UE are synchronized as to which paging channel to use for any of the subsequent paging events, the MME shall attempt to inform the VLR about the detach event by using a retry scheme if the initial delivery of the SGsAP-IMSI-DETACH-INDICATION message fails. + +### 5.5.2 Procedures in the MME + +#### 5.5.2.1 Explicit IMSI detach initiation + +When an MME receives a Detach Request from a UE for which an SGs association exists, the MME shall check the detach type indicated. If the UE is indicating IMSI detach or combined EPS/IMSI detach, the MME shall send an SGsAP-IMSI-DETACH-INDICATION message to the VLR indicating "Explicit UE initiated IMSI detach from non-EPS services" or "Combined UE initiated IMSI detach from EPS and non-EPS services". + +When an MME receives a Detach Notification message for a UE from an SGSN and an SGs association for the UE exists, the MME shall check the cause and detach type indicated. If the cause is indicating "IMSI Detach only", the MME shall send an SGsAP-IMSI-DETACH-INDICATION message to the VLR indicating "Explicit UE initiated IMSI detach from non-EPS services". If the cause is indicating "Complete Detach" and detach type is indicating "Combined PS/CS Detach" as specified in 3GPP TS 29.274 [17A], the MME shall send an SGsAP-IMSI-DETACH-INDICATION message to the VLR indicating "Combined UE initiated IMSI detach from EPS and non-EPS services". + +After the sending of the SGsAP-IMSI-DETACH-INDICATION message to the VLR, the MME shall move the state of the SGs association to SGs-NULL. The MME shall start timer Ts9 upon transmission of the SGsAP-IMSI-DETACH-INDICATION message and the MME shall stop and reset timer Ts6-1, if running. + +#### 5.5.2.2 Explicit IMSI detach response + +If the MME receives an SGsAP-IMSI-DETACH-ACK message from the VLR, the MME shall stop timer Ts9. If the detach type received from the UE indicated IMSI only detach or combined EPS/IMSI detach not due to switch off, the MME shall wait for the reception of the SGsAP-IMSI-DETACH-ACK message before sending the confirmation of the detach to the UE. + +#### 5.5.2.3 Abnormal cases + +The following abnormal cases can be identified: + +- i) no SGsAP-IMSI-DETACH-ACK received for a detach with switch off + +If the MME sent an SGsAP-IMSI-DETACH-INDICATION message for a combined IMSI and EPS detach due to switch off and timer Ts9 expires, the MME shall repeat the SGsAP-IMSI-DETACH-INDICATION message a maximum of Ns9 times. + +- ii) no SGsAP-IMSI-DETACH-ACK received for a detach with no switch off + +If the MME sent an SGsAP-IMSI-DETACH-INDICATION message for an IMSI only detach or a combined IMSI and EPS detach not due to switch off and timer Ts9 expires, the MME shall repeat the SGsAP-IMSI- + +DETACH-INDICATION message a maximum of Ns9 times. If no SGsAP-IMSI-DETACH-ACK is received after that the MME shall send the confirmation of the detach to the UE. + +### 5.5.3 Procedures in the VLR + +When a VLR receives an SGsAP-IMSI-DETACH-INDICATION message, the VLR shall send an SGsAP-IMSI-DETACH-ACK message to the sending MME. + +The VLR shall check the MME name indicated in the SGsAP-IMSI-DETACH-INDICATION message. If the received MME name is not changed comparing to the MME name stored in the VLR, the VLR shall move the state of the SGs association for the UE from any state to SGs-NULL. If the SGsAP-IMSI-DETACH-INDICATION message indicated "Explicit UE initiated IMSI detach from non-EPS services", the VLR marks the SGs association as "IMSI detached for non-EPS services". If the SGsAP-IMSI-DETACH-INDICATION message indicated "Combined UE initiated IMSI detach from EPS and non-EPS services", the VLR marks the SGs association as "IMSI detached for EPS and non-EPS services". The VLR shall mark the UE as detached. + +If the received MME name is different from the MME name stored in the VLR, the VLR shall not change the state of the SGs association. + +## 5.6 Implicit IMSI detach from non-EPS services + +### 5.6.1 General description + +This procedure is used by the MME to indicate when, based on the criteria for implicit detach as specified in 3GPP TS 23.401 [7B], the MME has decided to delete the EMM context of an UE or mark its EMM context as detached. This procedure only applies to UEs for which there is an SGs association at the MME. + +The implicit IMSI detach from non-EPS services procedure aborts any other ongoing procedure related to this UE on the SGs interface in the MME and in the VLR. + +In order to ensure that the VLR and the UE are synchronized as to which paging channel to use for any of the subsequent paging events the MME shall attempt to inform the VLR about the detach event by using a retry scheme if the initial delivery of the SGsAP-IMSI-DETACH-INDICATION message fails. + +### 5.6.2 Procedures in the MME + +When the implicit IMSI detach from non-EPS services procedure is started for a UE, the MME shall send an SGsAP-IMSI-DETACH-INDICATION message to the VLR indicating "Implicit network initiated IMSI detach from EPS and non-EPS services". + +After the sending of the SGsAP-IMSI-DETACH-INDICATION message, the MME shall move the state of the SGs association to SGs-NULL. The MME shall start timer Ts10 upon transmission of the SGsAP-IMSI-DETACH-INDICATION message. + +If the MME receives an SGsAP-IMSI-DETACH-ACK message from the VLR, the MME shall stop timer Ts10. + +If no SGsAP-IMSI-DETACH-ACK message is received by the MME to a previous SGsAP-IMSI-DETACH-INDICATION message before timer Ts10 expires, the MME shall repeat the SGsAP-IMSI-DETACH-INDICATION message a maximum of Ns10 times. The state of the SGs association during the acknowledgement procedure remains SGs-NULL. + +### 5.6.3 Procedures in the VLR + +When a VLR receives the SGsAP-IMSI-DETACH-INDICATION message, the VLR shall send an SGsAP-IMSI-DETACH-ACK message to the sending MME. + +The VLR shall check the MME name indicated in the SGsAP-IMSI-DETACH-INDICATION message. If the received MME name is not changed comparing to the MME name stored in the VLR and the state of the SGs association is not SGs-NULL, the VLR proceeds as follows: + +- The VLR shall move the state of the SGs association for the UE to SGs-NULL. If the VLR does not have a signalling connection for the UE, the VLR shall mark the UE as detached. Additionally, the VLR marks the SGs association as "IMSI implicitly detached for EPS and non-EPS services". + +If the received MME name is different from the MME name stored in the VLR, the VLR shall not change the state of the SGs association. + +## 5.7 VLR failure procedure + +### 5.7.1 General description + +This procedure is used by the VLR to inform the MMEs with an SGs association about the recovery from an internal failure that has affected the SGs association with the MMEs when the VLR fails with restart. + +NOTE: The VLR recovery procedure is handled in such a way that the signalling load on the VLR and MMEs does not create any overload problem. + +### 5.7.2 Procedures in the VLR + +#### 5.7.2.1 VLR Reset Initiation + +In the event of a failure at the VLR which has resulted in the loss of the SGs association information for some UEs, the VLR shall move from any state to the SGs-NULL state for these UEs. The VLR shall also set the "Confirmed by Radio Contact" restoration indicator to "false" (see 3GPP TS 23.007 [4]) for affected UEs. The VLR shall not send any SGsAP-MM-INFORMATION-REQUEST messages to UEs with the SGs association in the SGs-NULL state. + +When the VLR restarts, the VLR shall send an SGsAP-RESET-INDICATION message to all the MMEs connected to the VLR by the SGs interface. This message indicates to the MME that for the UEs with an SGs association to that VLR, the SGs association is no longer reliable. The VLR shall also start a separate timer Ts11 for each MME. + +#### 5.7.2.2 VLR Reset Response + +Upon receipt of an SGsAP-RESET-ACK message from an MME, the VLR shall stop the timer Ts11 for that MME. + +#### 5.7.2.3 Abnormal cases + +If the VLR does not receive an SGsAP-RESET-ACK message from that MME before the timer Ts11 expires, the VLR shall retransmit the SGsAP-RESET-INDICATION message. The retransmission is repeated a maximum of Ns11 times. + +NOTE: If no SGsAP-RESET-ACK is received after that a report is made to the O&M system. + +### 5.7.3 Procedures in the MME + +#### 5.7.3.1 VLR reset indication + +Upon receipt of an SGsAP-RESET-INDICATION message from the VLR, the MME is informed that all the SGs associations with that VLR for all the UEs registered in the MME are no longer reliable because the VLR has lost information about the state of the UEs and during the failure the VLR might have missed signalling messages. The MME shall set the "VLR-Reliable" MM context variable to "false". The detach procedures for deleting the SGs association are still applicable (see subclauses 5.4, 5.5 and 5.6). + +The MME sends an SGsAP-RESET-ACK message to the VLR. + +If the "VLR-Reliable" MM context variable is set to "false", upon reception of a combined tracking area update request or a periodic tracking area update request from the UE that is attached for non-EPS service, the MME may: + +- if a combined tracking area update request is received, immediately perform the location update for non-EPS services procedure towards the VLR as described in subclause 5.2; or +- if a periodic tracking area update request is received, dependent on network configuration and operator policy, + - perform a network initiated detach with detach type "IMSI detach" immediately after the completion of the periodic tracking area update procedure; or + - perform immediately the location update for non-EPS services procedure towards the VLR as described in subclause 5.2. + +### 5.7.3.2 Void + +## 5.8 MME failure procedure + +### 5.8.1 General description + +This procedure is used by the MME to inform the associated VLRs about the recovery from an internal failure that has affected the SGs association with the VLRs. + +NOTE: The MME recovery procedure is handled in such a way that the signalling load on the MME and VLRs does not create any overload problem. + +### 5.8.2 Procedures in the MME + +#### 5.8.2.1 MME Reset Initiation + +In the event of a failure at the MME which has resulted in the loss of the SGs association information on some UEs, the MME shall move from any state to the SGs-NULL state for these affected UEs. The MME shall also set the "MME-Reset" MM context variable to "true" and start the timer Ts12-1. When the timer Ts12-1 expires the "MME-Reset" MM context variable is set to "false". + +The MME may send an SGsAP-RESET-INDICATION message to all the VLRs connected to the MME by SGs interfaces. The SGsAP-RESET-INDICATION message indicates to the VLR that all the SGs associations with that particular MME for all the UEs registered in the VLR are no longer reliable. The normal procedures for updating the SGs association are still applicable (see subclauses 5.2, 5.4, 5.5 and 5.6). The MME shall also start a separate timer Ts12-2 for each VLR. + +If the MME does not send an SGsAP-RESET-INDICATION message, the MME shall move from any state to the SGs-NULL state only for the associations of the UEs affected by the loss of VLR association information. + +NOTE: The option to not send any SGsAP-RESET-INDICATION message to all the VLRs connected to the MME by SGs interfaces reduces subsequent paging signalling initiated by VLRs by avoiding a complete search of the UE on the entire VLR area. + +#### 5.8.2.2 MME Reset Response + +Upon receipt of an SGsAP-RESET-ACK message, the MME shall stop the timer Ts12-2 for that VLR. + +#### 5.8.2.3 Abnormal cases + +If the MME does not receive an SGsAP-RESET-ACK message from that VLR before the timer Ts12-2 expires, the MME shall retransmit the SGsAP-RESET-INDICATION message. The retransmission is repeated a maximum of Ns12 times. + +NOTE: If no SGsAP-RESET-ACK is received after that a report is made to the O&M system. + +### 5.8.3 Procedures in the VLR + +Upon receipt of an SGsAP-RESET-INDICATION message from the MME, the VLR is informed that all the SGs associations with that MME for all the UEs registered in the MME are no longer reliable because the MME has lost information about the state of the UEs for that VLR and during the failure the MME might have missed signalling messages. The VLR shall either: + +- set the "Confirmed by Radio Contact" restoration indicator to "false" in all the SGs associations containing the restarted MME and set the state of all the SGs associations containing the restarted MME to the SGs-NULL state; or +- keep the 'Confirmed by Radio Contact' restoration indication and the state of all the SGs associations containing the restarted MME unchanged. + +NOTE: The option to not set the 'Confirmed by Radio Contact' restoration indicator to 'false' in all the associations containing the restarted MME reduces subsequent paging signalling the VLR can initiate by avoiding a complete search of the UE on the entire VLR area. + +The VLR shall then send an SGsAP-RESET-ACK message to the MME. + +If the "Confirmed by Radio Contact" restoration indicator is "false" the VLR may send paging messages on both the SGs and the A/Iu interface. + +## 5.9 HSS failure + +### 5.9.1 General description + +This subclause describes the MME behaviour towards the VLR as a consequence of an HSS reset. + +In the case of an HSS failure, the HSS informs the associated MMEs about the recovery from an internal failure that has affected the SGs association with the MMEs according to the HSS reset procedure specified in 3GPP TS 29.272 [17]. + +This information is used in the MME to trigger the VLR to perform a location update towards the HSS in order to restore the HSS subscriber data. + +### 5.9.2 Procedures in the MME + +Upon receipt of a HSS reset indication from the HSS, the MME shall set the NEAF for all registered UEs in the MME for which a valid SGs association with a VLR exists. + +Upon detection of any signalling activity from the UE, the MME shall report to the VLR if the NEAF, as defined in subclause 5.3.3, is set for this UE. If the MME detects signalling that leads to a procedure towards the VLR, the MME shall follow this procedure and reset the NEAF. If the MME detects activity that does not lead to any procedure towards the VLR, the MME shall send an SGsAP-UE-ACTIVITY-INDICATION message towards the VLR and reset the NEAF. The MME may delay sending the activity indication for a maximum operator-configuration depending time period to avoid high signalling load. + +## 5.10 MM information procedure + +### 5.10.1 General description + +The MM information procedure is performed between the VLR and the MME via the SGs interface if the target UE for the MM information procedure is IMSI attached to both EPS and non-EPS services (i.e. the state of the SGs association is SGs-ASSOCIATED). The outcome of the MM Information procedure does not change the state of the SGs association at the VLR or MME. + +### 5.10.2 Procedures in the VLR + +If for the target UE for the MM information procedure the state of the SGs association in the VLR is SGs-ASSOCIATED, the VLR may initiate the MM information procedure by transferring an SGsAP-MM-INFORMATION-REQUEST message to the MME. + +### 5.10.3 Procedures in the MME + +If an SGsAP-MM-INFORMATION-REQUEST message is received for a UE for which there exists an SGs association at the MME, dependent on operator preference the MME shall either: + +- 1) check and update the contents of the received MM information information element. The MME then sends the resultant contents of the MM information information element to the UE indicated in the SGsAP-MM-INFORMATION-REQUEST message, using an EMM INFORMATION message as defined in 3GPP TS 24.301 [14]; or +- 2) discard the SGsAP-MM-INFORMATION-REQUEST message. In this case the MME can send an EMM INFORMATION message as defined in 3GPP TS 24.301 [14] to the UE, with contents generated locally by the MME. + +The MME should avoid sending both EMM INFORMATION messages according to option 1 and EMM INFORMATION messages according to option 2 to the same UE. + +NOTE 1: Sending messages according to option 1 and option 2 to the same UE can result in short-time changes of the network name or the local time displayed by the UE. + +For option 1) the MME checks and updates the contents of the MM information information element as follows: + +- a) If LSA Identity has been included in the MM information, the MME shall discard the LSA Identity; +- b) If the network spans more than one time zone, the MME shall handle the time-related parameters as follows: + - if Network Daylight Saving Time has been included in the MM information, then the MME shall discard the Network Daylight Saving Time; + - if Local Time Zone has been included in the MM information, then the MME shall replace the Local Time Zone with the Local Time Zone applicable for this UE. In addition, if the local time zone in the MME has been adjusted for daylight saving time, the MME shall indicate this by including the value used for adjustment in Network Daylight Saving Time IE in the MM information; + - if Universal time and local time zone has been included in the MM information, then the MME shall replace it with the Universal time and local time zone applicable for this UE. In addition, if the local time zone in the MME has been adjusted for daylight saving time, the MME shall indicate this by including the value used for adjustment in Network Daylight Saving Time IE in the MM information; + +NOTE 2: For the determination of the number of time zones, both CS and PS domain are taken into account. + +- c) If the network name, i.e. Full name for network or Short name for network or both, has been included by the VLR in the MM information information element, then dependent on operator preference and other information, e.g. the IMSI of the subscriber, the MME may + - replace the network name received from the VLR with a different network name; + - remove the network name from the MM information information element; or + - keep the network name received from the VLR unchanged. + +NOTE 3: The network name received from the VLR can be different from the network name provided by the MME, e.g. if multiple PLMNs are available for the CS domain. + +## 5.11 Procedure for tunnelling of NAS messages + +### 5.11.1 General description + +The tunnelling of NAS messages procedure is used to encapsulate the NAS messages exchanged between the UE and the VLR. This procedure can be used by either the VLR or the MME depending on the direction of the NAS message. The two procedures are identified as uplink unitdata, in the direction from the MME to the VLR, and downlink unitdata in the direction from the VLR to the MME. + +### 5.11.2 Uplink unitdata procedure + +#### 5.11.2.1 Procedures in the MME + +When the MME receives an Uplink NAS Transport message (see 3GPP TS 24.301 [14]) from a UE, the MME shall copy the value part of the NAS message container information element to the value part of the NAS message container information element of the SGsAP-UPLINK-UNITDATA message and send the SGsAP-UPLINK-UNITDATA message to the VLR if the "VLR-Reliable" MM context variable is not set to "false". If the "VLR-Reliable" MM context variable is set to "false", the MME requests the UE to re-attach for non-EPS services as specified in 3GPP TS 24.301 [14]. + +In order to permit the VLR to create an accurate charging record, the MME shall add the IMEISV, the UE Time Zone, the Mobile Station Classmark 2, and the UE's current TAI and E-CGI to the SGsAP-UPLINK-UNITDATA message. + +#### 5.11.2.2 Procedures in the VLR + +##### 5.11.2.2.1 General description + +Upon reception of an SGsAP-UPLINK-UNITDATA, the VLR shall extract the NAS message container information element and treat the value part of this information element according to the procedures defined in 3GPP TS 24.011 [10]. + +Other parameters in the message may be used as specified in 3GPP TS 32.250 [17B] and 3GPP TS 23.078 [5AA]. + +#### 5.11.2.2.2 Abnormal cases + +The following abnormal cases can be identified: + +- i) subscriber data does not exist or is not confirmed by HLR + +If the VLR receives an SGsAP-UPLINK-UNITDATA message from the MME for a UE for which subscriber data does not exist or is not confirmed by HLR, then the VLR shall ignore the received message, and return an SGsAP-RELEASE-REQUEST message to the MME with an SGs cause information element indicating "IMSI unknown". + +- ii) subscriber data exists, but there is no SGs association for the UE at the VLR + +If the VLR receives an SGsAP-UPLINK-UNITDATA message from the MME for a UE for which no SGs association exists, then the VLR shall ignore the received message, and return an SGsAP-RELEASE-REQUEST message to the MME with an SGs cause information element indicating "IMSI detached for non-EPS services". + +#### 5.11.2.3 Void + +### 5.11.3 Downlink unitdata procedure + +#### 5.11.3.1 Procedures in the VLR + +When the VLR needs to send a NAS message to the UE, the VLR shall first verify whether or not it has an SGs association for the UE. If the state of the SGs association for the UE is SGs-ASSOCIATED and LA-UPDATE-PRESENT, then the VLR continues with the procedure. The VLR shall build and encapsulate the NAS message into the value part of the NAS message container information element of an SGsAP-DOWNLINK-UNITDATA message and send the SGsAP-DOWNLINK-UNITDATA message to the MME. + +#### 5.11.3.2 Procedures in the MME + +##### 5.11.3.2.1 General description + +Upon reception of an SGsAP-DOWNLINK-UNITDATA message, the MME shall proceed as follows: + +- If the UE was in EMM-CONNECTED mode, the MME shall copy the value part of the NAS message container information element to the value part of the NAS message container information element of a Downlink NAS Transport message (see 3GPP TS 24.301 [14]) and shall send the Downlink NAS Transport message to the UE; or +- In Deployment Option 3 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), if the UE was in EMM-IDLE mode and temporarily unreachable for paging due to using eDRX (as specified in 3GPP TS 24.301 [14]), the MME behaves as specified in subclause 8.2.4a.3 of 3GPP TS 23.272 [7]. + +##### 5.11.3.2.2 Abnormal cases + +The following abnormal cases can be identified: + +- i) subscriber data does not exist or is not confirmed by HSS + +If the MME receives an SGsAP-DOWNLINK-UNITDATA message from the VLR for a UE for which subscriber data does not exist or is not confirmed by HSS, then the MME shall ignore the received message. + +- ii) subscriber data exists, but there is no SGs association for the UE at the MME + +If the MME receives an SGsAP-DOWNLINK-UNITDATA message from the VLR for a UE for which there is no SGs association, then the MME shall ignore the received message. + +### 5.11.3.3 Void + +## 5.11.4 Release procedure + +When the VLR determines that there are no more NAS messages to be exchanged between the VLR and the UE, or when a further exchange of NAS messages for the specified UE is not possible due to an error, the VLR shall send the SGsAP-RELEASE-REQUEST message to the MME, including the IMSI of the UE for which there are no more NAS messages to be tunnelled. + +NOTE: For the SMS transport, the VLR can send the SGsAP-RELEASE-REQUEST message when the SMS transaction is complete (reception of a CP-ACK message for the MO case, sending of a CP-ACK message for the MT case), upon reception of a CP-ERROR message, abort of SMS transaction by upper layers, or upon some error cases such as TC1 expiry, no SGs association for the UE or IMSI unknown. + +Upon receipt of an SGsAP-RELEASE-REQUEST message with an SGs cause information element indicating "IMSI unknown" or "IMSI detached for non-EPS services", the MME shall set the "VLR-Reliable" MM context variable to "false". In addition, the MME requests the UE to re-attach for non-EPS services as specified in 3GPP TS 24.301 [14]. + +## 5.12 Service request procedure + +### 5.12.1 General description + +After the reception of an SGsAP-PAGING-REQUEST message from the VLR, the MME will use this procedure to indicate to the VLR that a NAS signalling connection exists between the UE and the MME. + +The procedure can be invoked, by the MME as follows: + +- Upon reception of a Service Request message or Extended Service Request message from the UE; +- Directly after receiving the SGsAP-PAGING-REQUEST message from the VLR, based on the UE's EMM mode; or +- In Deployment Option 3 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), detecting the UE is temporarily unreachable for paging due to using eDRX (as specified in 3GPP TS 24.301 [14]) and the Service indicator information element in the SGsAP-PAGING-REQUEST message indicates "SMS indicator". + +### 5.12.2 Procedures in the MME + +When receiving the SGsAP-PAGING-REQUEST message, the MME shall first take action as described in subclause 5.1.3 and check whether the UE, for which the paging is sent, is in EMM-IDLE or EMM-CONNECTED mode. + +If the MME accepts the paging request, the MME shall proceed as follows: + +- If the UE was in EMM-CONNECTED mode, the MME creates and sends an SGsAP-SERVICE-REQUEST message to the VLR based on the conditions specified in 3GPP TS 23.272 [7]. If the UE subsequently rejects the CS fallback call, the MME shall send the SGsAP-PAGING-REJECT message to the VLR with the SGs cause information element indicating "Mobile terminating CS fallback call rejected by the user"; +- If the UE was in EMM-IDLE mode and the SGsAP-PAGING-REQUEST message was received with LAI, the MME shall send the SGsAP-SERVICE-REQUEST message to the VLR when the UE enters EMM-CONNECTED mode; +- If the UE was in EMM-IDLE mode and the SGsAP-PAGING-REQUEST message was received without LAI, the MME behaves as specified in subclause 4.8.1 of 3GPP TS 23.272 [7]; or +- In Deployment Option 3 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), if the UE was in EMM-IDLE mode and temporarily unreachable for paging due to using eDRX (as specified in 3GPP TS 24.301 [14]), and the Service indicator information element in the SGsAP-PAGING-REQUEST message indicates "SMS indicator", the MME behaves as specified in subclause 8.2.4a.3 of 3GPP TS 23.272 [7]. + +The MME shall set the service indicator in the SGsAP-SERVICE-REQUEST message equal to what was received in the SGsAP-PAGING-REQUEST message. Additionally, in order to permit the VLR to create an accurate charging + +record, the MME shall add the IMEISV, the UE Time Zone, the Mobile Station Classmark 2, and the UE's current TAI and E-CGI to the SGsAP-SERVICE-REQUEST message. + +### 5.12.3 Procedures in the VLR + +Upon reception of the SGsAP-SERVICE-REQUEST message, the VLR shall stop Timer Ts5 and consider the paging procedure as successful. If the paging procedure is for SMS, the VLR shall then start the delivery of the SMS message(s) according to the subclause 5.11.3.1. If the paging procedure with the Service indicator information element indicating "SMS Indicator" was triggered upon reception of a Provide Subscriber Information Request message, the VLR can return an SGsAP-RELEASE-REQUEST message to the MME as specified in subclause 7.2.3.5 of 3GPP TS 23.018 [5]. + +Other parameters in the message may be used as specified in 3GPP TS 32.250 [17B] and 3GPP TS 23.078 [5AA]. + +## 5.13 Service abort procedure + +### 5.13.1 General description + +This procedure can be invoked by the VLR to abort a mobile terminating CS fallback call during call establishment. The procedure applies to UEs that are simultaneously attached for EPS services and non-EPS services, but not to UEs attached for EPS services and SMS only. + +### 5.13.2 Procedures in the VLR + +If the VLR decides to abort a mobile terminating CS fallback call for which it has sent an SGsAP-PAGING-REQUEST message to the MME, and the VLR has not received an SCCP connection establishment containing the Initial L3 message from the UE via the A or Iu interface, the VLR shall send the SGsAP-SERVICE-ABORT-REQUEST message to the MME. The state of the SGs association is not changed. + +### 5.13.3 Procedures in the MME + +When the MME receives the SGsAP-SERVICE-ABORT-REQUEST message from the VLR, the MME shall set the Call Cancelled Flag to "true". + +If the MME receives an EXTENDED SERVICE REQUEST message from the UE with Service type set to "mobile terminating CS fallback or 1xCS fallback" and CSFB response set to "CS fallback accepted by the UE" and the Call Cancelled Flag is set to "true", the MME shall set the Call Cancelled Flag to "false" and will reject the CS fallback call as specified in 3GPP TS 24.301 [14]. + +If the Call Cancelled Flag is set to "true", the MME shall set the Call Cancelled Flag to "false": + +- upon reception of the EXTENDED SERVICE REQUEST message from the UE with Service type set to a value other than "mobile terminating CS fallback or 1xCS fallback" or CSFB response set to a value other than "CS fallback accepted by the UE"; or +- upon reception of a new SGsAP-PAGING-REQUEST message from the VLR. + +When the MME receives the SGsAP-SERVICE-ABORT-REQUEST message after the UE has accepted the CS fallback call, the MME shall discard the SGsAP-SERVICE-ABORT-REQUEST message. The state of the SGs association is not changed. + +## 5.14 Implicit IMSI detach from EPS services + +### 5.14.1 General description + +This procedure is used by the MME to indicate when, based on the criteria for implicit detach as specified in 3GPP TS 23.401 [7B], the MME has decided to delete the EMM context of an UE or mark its EMM context as detached. This procedure only applies to UEs for which there is an SGs association at the MME and the network operating in NMO I and supporting ISR. + +The implicit IMSI detach from EPS services procedure aborts any other ongoing procedure related to this UE on the SGs interface in the MME and in the VLR. + +In order to ensure that the VLR and the UE are synchronized as to which paging channel to use for any of the subsequent paging events the MME shall attempt to inform the VLR about the detach event by using a retry scheme if the initial delivery of the SGsAP-EPS-DETACH-INDICATION message fails. + +## 5.14.2 Procedures in the MME + +When the implicit IMSI detach from EPS services procedure is started for a UE, the MME shall send an SGsAP-EPS-DETACH-INDICATION message to the VLR indicating "Network initiated IMSI detach from EPS services". + +After the sending of the SGsAP-EPS-DETACH-INDICATION message, the MME shall move the state of the SGs association to SGs-NULL. The MME shall start timer Ts13 upon transmission of the SGsAP-EPS-DETACH-INDICATION message. + +If the MME receives an SGsAP-EPS-DETACH-ACK message from the VLR, the MME shall stop timer Ts13. + +If no SGsAP-EPS-DETACH-ACK message is received by the MME to a previous SGsAP-EPS-DETACH-INDICATION message before timer Ts13 expires, the MME shall repeat the SGsAP-EPS-DETACH-INDICATION message a maximum of Ns10 times. The state of the SGs association during the acknowledgement procedure remains SGs-NULL. + +## 5.14.3 Procedures in the VLR + +When a VLR receives an SGsAP-EPS-DETACH-INDICATION message, the VLR shall perform the procedures described in subclause 5.4.3. + +# 5.15 UE fallback supervision procedure + +## 5.15.0 General description + +This procedure is used by the VLR to monitor the status of the UE fallback procedure, after the VLR has sent an SGsAP-PAGING-REQUEST message to the MME. + +## 5.15.1 Procedures in the VLR + +Upon receipt of an SGsAP-SERVICE-REQUEST message from the MME, if the Service indicator information element in the SGsAP-SERVICE-REQUEST message indicates "CS call indicator", the VLR shall start timer Ts14 to supervise the success of UE fallback. + +The VLR shall stop timer Ts14 in the following cases: + +- upon receipt of an SCCP connection establishment containing the Initial L3 message from the UE via the A or Iu interface; +- upon receipt of an SGsAP-PAGING-REJECT message; or +- upon expiry of the CFNRy timer and if Call Forwarding on No Reply (CFNRy) has been configured and activated for the terminating UE. + +NOTE 1: Upon expiry of the CFNRy timer, the VLR triggers Call Forwarding on No Reply (CFNRy) as specified in 3GPP TS 23.082 [5B] and 3GPP TS 29.011 [15A]. + +If Call Forwarding on No Reply (CFNRy) is not activated for the terminating UE, upon expiry of timer Ts14, the VLR shall release the call as specified in 3GPP TS 24.008[8]. + +NOTE 2: Before releasing the call, the VLR needs to consider whether A/Iu paging is ongoing. In addition, if the VLR considers the paging procedure completed, and no response has been received from the UE via the A or Iu interface, and if CFNRc has been configured and activated for the terminating UE, the VLR applies the equivalent handling as for Call Forwarding on Not Reachable, as specified in 3GPP TS 23.082 [5B] and 3GPP TS 29.011 [15A]. + +## 5.16 Procedure for MO CSFB indication + +### 5.16.1 General description + +If the network is configured to support the return to the last used E-UTRAN PLMN after CS fallback as specified in 3GPP TS 23.272 [7], this procedure is used to indicate to the VLR that the UE initiated a service request for MO CS fallback. + +### 5.16.2 Procedures in the MME + +If the MME is configured to support the return to the last used E-UTRAN PLMN after CS fallback, upon reception of an EXTENDED SERVICE REQUEST message (see 3GPP TS 24.301 [14]) from the UE with Service type set to "mobile originating CS fallback or 1xCS fallback" or "mobile originating CS fallback emergency call or 1xCS fallback emergency call" from the UE, the MME shall send the SGsAP-MO-CSFB-INDICATION message to the VLR. + +### 5.16.3 Procedures in the VLR + +If the VLR is configured to support the return to the last used E-UTRAN PLMN after CS fallback, upon reception of an SGsAP-MO-CSFB-INDICATION, the VLR shall start timer Ts15 to supervise the success of the UE fallback. + +If an SCCP connection establishment containing the Initial L3 message is received from the UE via the A or Iu interface, the VLR shall stop timer Ts15 and apply specific handling related to the return to the last used E-UTRAN PLMN after CS fallback. + +Upon expiry of Ts15, the VLR considers the MO CSFB to have failed and does not apply specific handling related to support of the return to the last used E-UTRAN PLMN after CS fallback. + +--- + +## 6 SGs transport + +### 6.1 General + +This subclause specifies the standards for signalling transport to be used across SGs interface. SGs interface is a logical interface between the MME and the VLR. All the SGsAP messages described in the present document require an SCTP association between the MME and the VLR. + +### 6.2 IP layer + +The MME and the VLR shall support IPv6 (see IETF RFC 2460 [22]) and/or IPv4 (see IETF RFC 791 [20]). + +The IP layer of SGs only supports point-to-point transmission for delivering SGsAP messages. + +### 6.3 Transport layer + +SCTP (see IETF RFC 4960 [23]) shall be supported as the transport layer of SGsAP messages. + +Semi-permanent SCTP associations shall be established between the MME and VLR, i.e. the SCTP associations shall remain up under normal circumstances. The MME shall establish the SCTP association. + +Transport network redundancy can be achieved by SCTP multi-homing between two end-points, of which one or both is assigned with multiple IP addresses. SCTP end-points shall support a multi-homed remote SCTP end-point. + +NOTE 1: If the association initialization to an IP destination address of the VLR is unsuccessful and alternative destination IP address(es) are known, the MME reattempts initialization to an alternative IP address. + +For SCTP endpoint redundancy, an SCTP endpoint (in the MME or VLR) may send an INIT, at any time for an already established SCTP association, which the other SCTP endpoint shall handle as defined in IETF RFC 4960 [23]. + +MME and VLR shall support a configuration with a single SCTP association per MME/VLR pair. Configurations with multiple SCTP endpoints per MME/VLR pair may be supported. + +NOTE 2: If multiple SCTP endpoints are configured and several SCTP associations are established between the MME/VLR pair, whether the VLR and the MME send and receive SGsAP messages via same or different SCTP associations for a given UE is up to implementation. + +Within the SCTP association established between one MME and one VLR, both MME and VLR shall reserve several stream identifiers, based on the INIT message exchange for the sole use of SGsAP procedures. + +The registered port number for SGsAP is 29118. + +The payload protocol identifier to be used for SGsAP is 0. + +--- + +## 7 Error handling + +### 7.1 General + +This subclause specifies procedures for the handling of unknown, unforeseen, and erroneous protocol data by the receiving entity (i.e. the MME or the VLR). These procedures are called "error handling procedures", but in addition to providing recovery mechanisms for error situations, they define a compatibility mechanism for future extensions of the protocol. + +In this subclause, the following terminology is used: + +- an information element is defined to be syntactically incorrect in a message if it contains at least one value defined as "reserved", or if its value part violates coding rules. However, it is not a syntactical error that an information element indicates in its Length Indicator a greater length than defined in the relevant subclause; and +- a message is defined to have semantically incorrect contents if it contains information which, possibly dependant on the state of the receiver, is in contradiction to the resources of the receiver and/or to the procedural part of current specification. + +When a receiving entity detects the need to send an SGsAP-STATUS message (see errors detailed below), the entity shall copy the IMSI information element value (if included) of the incorrect message to the IMSI information element of the SGsAP-STATUS message. The message in error is also included in the SGsAP-STATUS message. Both the receiving and the sending entity shall abandon the procedure related to the incorrect message and return to the state from where the procedure related to the incorrect message was started. + +An SGsAP-STATUS message shall not be sent in response to a received SGsAP-STATUS message. + +Both the receiving and the sending entity shall inform the O&M entity upon sending or receiving an SGsAP-STATUS message. + +The next subclauses shall be applied in order of precedence. + +### 7.2 Message too short + +When the receiving entity receives a message that is too short to contain a complete message type information element, the receiving entity shall ignore that message. + +### 7.3 Unknown or unforeseen message type + +The entity receiving a message with a message type not defined or not implemented shall ignore the message. The receiving entity shall return an SGsAP-STATUS message with the SGs cause information element set to "message unknown" and the Erroneous message information element containing the received message. + +The entity receiving a message that is not compatible with the protocol state shall return an SGsAP-STATUS message with the SGs cause information element set to "message not compatible with the protocol state" and the erroneous message. + +The entity receiving a message that is not defined to be received by that entity (i.e. the message is sent in the wrong direction) shall treat the message as unknown message and shall ignore the message. The entity shall return an SGsAP-STATUS message with the SGs cause information element set to "message unknown" and the Erroneous message information element containing the received message. + +## 7.4 Missing mandatory information element + +When the receiving entity diagnoses a "missing mandatory information element" error, the receiving entity shall ignore the message and return an SGsAP-STATUS message with the SGs cause information element set to "missing mandatory information element" and shall return the Erroneous message information element containing the received message. + +## 7.5 Information elements unknown or unforeseen in the message + +The receiving entity shall ignore all information elements unknown or unforeseen in a message. + +## 7.6 Out of sequence information elements + +The receiving entity shall ignore all information elements that are out of sequence. + +## 7.7 Repeated information elements + +If an information element with format T, TV, or TLV is repeated in a message in which repetition of the information element is not specified, the receiving entity shall only handle the contents of the information element appearing first and shall ignore all subsequent repetitions of the information element. When repetition of information elements is specified, the receiving entity shall only handle the contents of specified repeated information elements. If the limit on repetition of information elements is exceeded, the receiving entity shall handle the contents of information elements appearing first up to the limit of repetitions and shall ignore all subsequent repetitions of the information element. + +## 7.8 Syntactically incorrect mandatory information element. + +On receipt of a message which contains a syntactically incorrect mandatory information element, the receiver shall ignore the message and return an SGsAP-STATUS message with the SGs cause information element set to "invalid mandatory information" and shall return the Erroneous message information element containing the received message. + +## 7.9 Syntactically incorrect optional information elements + +The receiving entity shall treat all optional information elements that are syntactically incorrect in a message as not present in the message. + +## 7.10 Conditional information element errors + +When the entity receiving a message diagnoses a "missing conditional information element" error or an "unexpected conditional information element" error or when it receives a message containing at least one syntactically incorrect conditional information element which is required to be present in the message, the receiving entity shall ignore the message and return an SGsAP-STATUS message with the SGs cause information element set to "conditional information element error" and shall return the Erroneous message information element containing the received message. + +When the entity receives a message containing a syntactically incorrect conditional information element which is not required to be present in the message, nor required to be absent in the message, then the receiving entity shall ignore that information element. + +## 7.11 Information elements with semantically incorrect contents + +When an information element with semantically incorrect contents is received, the foreseen reactions of the procedural part of the present specification are performed. + +If however no such reactions are specified, the receiving entity shall ignore that information element and treat the rest of the message. If, because this information element was ignored, the rest of the message can no longer be handled then the receiving entity shall return an SGsAP-STATUS message with the SGs cause information element set to "semantically incorrect message" and shall return the Erroneous message information element containing the received message. + +## 8 Message functional definitions and contents + +### 8.1 SGsAP-ALERT-ACK message + +This message is sent by the MME to the VLR to acknowledge a previous SGsAP-ALERT-REQUEST message. Table 8.1.1 shows the content of the SGsAP-ALERT-ACK message. + +**Table 8.1.1: SGsAP-ALERT-ACK message content** + +| Information element | Type/Reference | Presence | Format | Length | +|---------------------|---------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | + +### 8.2 SGsAP-ALERT-REJECT message + +This message is sent from the MME to the VLR to indicate that the MME could not identify the IMSI indicated in the SGsAP-ALERT-REQUEST message. Table 8.2.1 shows the content of the SGsAP-ALERT-REJECT message. + +**Table 8.2.1: SGsAP-ALERT-REJECT message content** + +| Information element | Type/Reference | Presence | Format | Length | +|---------------------|---------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | +| SGs Cause | SGs cause
9.4.18 | M | TLV | 3 | + +### 8.3 SGsAP-ALERT-REQUEST message + +This message is sent by the VLR to the MME to request an indication when the next activity of a UE is detected. Table 8.3.1 shows the content of the SGsAP-ALERT-REQUEST message. + +**Table 8.3.1: SGsAP-ALERT-REQUEST message content** + +| Information element | Type/Reference | Presence | Format | Length | +|---------------------|---------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | + +### 8.4 SGsAP-DOWNLINK-UNITDATA message + +This message is sent from the VLR to the MME to transparently relay a NAS message, from the VLR, to the UE. Table 8.4.1 shows the content of the SGsAP-DOWNLINK-UNITDATA message. + +**Table 8.4.1: SGsAP-DOWNLINK-UNITDATA message content** + +| Information element | Type/Reference | Presence | Format | Length | +|-----------------------|---------------------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | +| NAS message container | NAS message container
9.4.15 | M | TLV | 4-253 | + +## 8.5 SGsAP-EPS-DETACH-ACK message + +This message is sent by the VLR to the MME to acknowledge a previous SGsAP-EPS-DETACH-INDICATION message. Table 8.5.1 shows the content of the SGsAP-EPS-DETACH-ACK message. + +**Table 8.5.1: SGsAP-EPS-DETACH-ACK message content** + +| Information element | Type/Reference | Presence | Format | Length | +|---------------------|---------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | + +## 8.6 SGsAP-EPS-DETACH-INDICATION message + +This message is sent by the MME to the VLR to indicate an EPS detach performed from the UE or the MME. The type of detach is indicated in the IMSI detach from EPS service type information element. Table 8.6.1 shows the content of the SGsAP-EPS-DETACH-INDICATION message. + +**Table 8.6.1: SGsAP-EPS-DETACH-INDICATION message content** + +| Information element | Type/Reference | Presence | Format | Length | +|-----------------------------------|--------------------------------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | +| MME name | MME name
9.4.13 | M | TLV | 57 | +| IMSI detach from EPS service type | IMSI detach from EPS service type
9.4.7 | M | TLV | 3 | + +## 8.7 SGsAP-IMSI-DETACH-ACK message + +This message is sent by the VLR to the MME to acknowledge a previous SGsAP-IMSI-DETACH-INDICATION message. Table 8.7.1 shows the content of the SGsAP-IMSI-DETACH-ACK message. + +**Table 8.7.1: SGsAP-IMSI-DETACH-ACK message content** + +| Information element | Type/Reference | Presence | Format | Length | +|---------------------|---------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | + +## 8.8 SGsAP-IMSI-DETACH-INDICATION message + +This message is sent by the MME to the VLR to indicate an IMSI detach performed from the UE or the MME. The type of detach is indicated in the IMSI detach from non-EPS service type information element. Table 8.8.1 shows the content of the SGsAP-IMSI-DETACH-INDICATION message. + +**Table 8.8.1: SGsAP-IMSI-DETACH-INDICATION message content** + +| Information element | Type/Reference | Presence | Format | Length | +|---------------------------------------|------------------------------------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | +| MME name | MME name
9.4.13 | M | TLV | 57 | +| IMSI Detach from non-EPS service type | IMSI detach from non-EPS service type
9.4.8 | M | TLV | 3 | + +## 8.9 SGsAP-LOCATION-UPDATE-ACCEPT message + +### 8.9.1 Message definition + +This message is sent by the VLR to the MME to indicate that update or IMSI attach in the VLR has been completed. Table 8.9.1.1 shows the content of the SGsAP-LOCATION-UPDATE-ACCEPT message. + +**Table 8.9.1.1: SGsAP-LOCATION-UPDATE-ACCEPT message content** + +| Information element | Type/Reference | Presence | Format | Length | +|--------------------------|------------------------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | +| Location area identifier | Location area identifier
9.4.11 | M | TLV | 7 | +| New TMSI, or IMSI | Mobile identity
9.4.14 | O | TLV | 6-10 | + +### 8.9.2 New TMSI, or IMSI + +This information element represents the identity to be used for (and then by) the UE. + +If this information element is an IMSI, then the UE is not allocated any TMSI (and deletes any TMSI accordingly). If this information element is a TMSI, then the UE will use this TMSI as the new temporary identity (the UE deletes its old TMSI if available, and stores the new TMSI). If neither a TMSI nor an IMSI are included in this information element, the old TMSI, if any available, will be kept. + +## 8.10 SGsAP-LOCATION-UPDATE-REJECT message + +### 8.10.1 Message definition + +This message is sent by the VLR to the MME to indicate that location update or IMSI attach has failed. Table 8.10.1 shows the content of the SGsAP-LOCATION-UPDATE-REJECT message. + +**Table 8.10.1: SGsAP-LOCATION-UPDATE-REJECT message content** + +| Information element | Type/Reference | Presence | Format | Length | +|--------------------------|------------------------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | +| Reject cause | Reject cause
9.4.16 | M | TLV | 3 | +| Location area identifier | Location area identifier
9.4.11 | O | TLV | 7 | + +## 8.10.2 Location area identifier + +The VLR shall include this information element. + +# 8.11 SGsAP-LOCATION-UPDATE-REQUEST message + +## 8.11.1 Message definition + +This message is sent by the MME to the VLR either to request update of its location file (normal update) or to request IMSI attach. Table 8.11.1.1 shows the content of the SGsAP-LOCATION-UPDATE-REQUEST message. + +**Table 8.11.1.1: SGsAP-LOCATION-UPDATE-REQUEST message content** + +| Information element | Type/Reference | Presence | Format | Length | +|------------------------------|----------------------------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | +| MME name | MME name
9.4.13 | M | TLV | 57 | +| EPS location update type | EPS location update type
9.4.2 | M | TLV | 3 | +| New location area identifier | Location area identifier
9.4.11 | M | TLV | 7 | +| Old location area identifier | Location area identifier
9.4.11 | O | TLV | 7 | +| TMSI status | TMSI status
9.4.21 | O | TLV | 3 | +| IMEISV | IMEISV
9.4.5 | O | TLV | 10 | +| TAI | Tracking Area Identity
9.4.21a | O | TLV | 7 | +| E-CGI | E-UTRAN Cell Global Identity
9.4.3a | O | TLV | 9 | +| TMSI based NRI container | TMSI based NRI container
9.4.26 | O | TLV | 4 | +| Selected CS domain operator | Selected CS domain operator
9.4.27 | O | TLV | 5 | + +## 8.11.2 Old location area identifier + +The MME shall include this information element if the UE included the old location area information in the ATTACH REQUEST or TRACKING AREA UPDATE REQUEST message. + +## 8.11.3 TMSI status + +The MME shall include this information element if the TMSI status received in the ATTACH REQUEST or TRACKING AREA UPDATING REQUEST message from the UE indicates that no valid TMSI is available in the UE. + +## 8.11.4 IMEISV + +The MME shall include this information element if the IMEISV is available in the MME. + +## 8.11.5 TAI + +If the TAI is available in the MME, the MME shall include this information element. + +## 8.11.6 E-CGI + +If the E-CGI is available in the MME, the MME shall include this information element. + +### 8.11.7 TMSI based NRI container + +This information element shall be included if the TMSI based NRI container has been received in the ATTACH REQUEST or TRACKING AREA UPDATING REQUEST message from the UE. + +### 8.11.8 Selected CS domain operator + +This information element shall be included if the network is configured to support gateway core network (GWCN) for CS domain, the preferred RAT of the selected PLMN for CS fallback is GERAN, and the UE does not support GERAN network sharing. + +## 8.12 SGsAP-MM-INFORMATION-REQUEST + +This message is sent by the VLR to the MME to provide the UE with subscriber specific information. Table 8.12.1 shows the content of the SGsAP-MM-INFORMATION-REQUEST message. + +**Table 8.12.1: SGsAP-MM-INFORMATION-REQUEST message content** + +| Information element | Type/Reference | Presence | Format | Length | +|---------------------|--------------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | +| MM information | MM information
9.4.12 | M | TLV | 3-n | + +## 8.13 SGsAP-PAGING-REJECT message + +This message is sent from the MME to the VLR to indicate that the delivery of a previous SGsAP-PAGING-REQUEST message has failed. Table 8.13.1 shows the content of the SGsAP-PAGING-REJECT message. + +**Table 8.13.1: SGsAP-PAGING-REJECT message content** + +| Information element | Type/Reference | Presence | Format | Length | +|---------------------|---------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | +| SGs Cause | SGs Cause
9.4.18 | M | TLV | 3 | + +## 8.14 SGsAP-PAGING-REQUEST message + +### 8.14.1 Message definition + +This message is sent from the VLR to the MME and contains sufficient information to allow the paging message to be transmitted by the correct cells at the correct time. Table 8.14.1.1 shows the content of the SGsAP-PAGING-REQUEST message. + +**Table 8.14.1.1: SGsAP-PAGING-REQUEST message content** + +| Information element | Type/Reference | Presence | Format | Length | +|------------------------------|----------------------------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | +| VLR name | VLR name
9.4.22 | M | TLV | 3-n | +| Service indicator | Service indicator
9.4.17 | M | TLV | 3 | +| TMSI | TMSI
9.4.20 | O | TLV | 6 | +| CLI | CLI
9.4.1 | O | TLV | 3-14 | +| Location area identifier | Location area identifier
9.4.11 | O | TLV | 7 | +| Global CN-Id | Global CN-Id
9.4.4 | O | TLV | 7 | +| SS code | SS code
9.4.19 | O | TLV | 3 | +| LCS indicator | LCS indicator
9.4.10 | O | TLV | 3 | +| LCS client identity | LCS client identity
9.4.9 | O | TLV | 3-n | +| Channel needed | Channel needed
9.4.23 | O | TLV | 3 | +| eMLPP Priority | eMLPP Priority
9.4.24 | O | TLV | 3 | +| Additional paging indicators | Additional paging indicators
9.4.25 | O | TLV | 3 | +| SM Delivery Timer | SM Delivery Timer
9.4.29 | O | TLV | 4 | +| SM Delivery Start Time | SM Delivery Start Time
9.4.30 | O | TLV | 6 | +| Maximum Retransmission Time | Maximum Retransmission Time
9.4.32 | O | TLV | 6 | + +## 8.14.2 TMSI + +This element is omitted in the exceptional case where paging with IMSI is performed. + +## 8.14.3 CLI + +If the Calling Line Identification is available in the VLR, the VLR shall include this information element. + +## 8.14.4 Location area identifier + +The VLR shall include this information element if the "Confirmed by Radio Contact" restoration indicator is set to "true". + +## 8.14.5 Global CN-Id + +If the network supports the Intra Domain Connection of RAN Nodes to multiple CN Nodes functionality, the VLR shall include this information element when the VLR initiates paging by IMSI, via the SGs interface. + +## 8.14.6 SS code + +The VLR shall include this information element if paging is due to a NW-initiated Call Independent SS procedure (see 3GPP TS 24.010 [9]). + +## 8.14.7 LCS indicator + +The VLR shall include this information element if the paging is due to a Mobile Terminated Location Request (see 3GPP TS 24.030 [11]). + +## 8.14.8 LCS client identity + +The VLR may include this information element if the paging is due to a Mobile Terminated Location Request (see 3GPP TS 24.030 [11]). If the paging is due to emergency positioning, then VLR should include this information element. + +## 8.14.9 Channel needed + +This information element shall be included if the VLR intends to indicate which channel the UE should use. + +## 8.14.10 eMLPP priority + +This information element shall be included if the VLR supports CSFB priority call handling and the call was received with eMLPP priority level indication. + +The eMLPP priority IE may be used to determine the required priority of a SCTP association for the associated SGsAP message. + +## 8.14.11 Additional paging indicators + +This information element shall be included if additional paging information e.g. CS restoration indicator needs to be passed to the MME. + +## 8.14.12 SM Delivery Timer + +For Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), this information element may be included if the Service Indicator IE indicates "SMS indicator" and the SM Delivery Timer and SM Delivery Start Time IEs were received from the SMS-GMSC as defined in 3GPP TS 24.010 [9]. + +## 8.14.13 SM Delivery Start Time + +For Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), this information element may be included if the Service Indicator IE indicates "SMS indicator" and the SM Delivery Timer and SM Delivery Start Time IEs were received from the SMS-GMSC as defined in 3GPP TS 24.010 [9]. + +## 8.14.4 Maximum Retransmission Time + +For Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), this information element may be included if the Service Indicator IE indicates "SMS indicator" and if the Maximum Retransmission Time IE was received from the SMS-GMSC as defined in 3GPP TS 29.002 [15]. + +# 8.15 SGsAP-RESET-ACK message + +## 8.15.1 Message definition + +This message is sent from the MME or the VLR to acknowledge a previous SGsAP-RESET-INDICATION message. This message indicates that all the SGs associations to the VLR or the MME have been marked as invalid. + +The sending entity (either the MME or the VLR) includes its identity in the form of a name in the SGsAP-RESET-ACK message. Table 8.15.1.1 shows the content of the SGsAP-RESET-ACK message. + +**Table 8.15.1.1: SGsAP-RESET-ACK message content** + +| Information element | Type/Reference | Presence | Format | Length | +|---------------------|---------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| MME name | MME name
9.4.13 | C | TLV | 57 | +| VLR name | VLR name
9.4.22 | C | TLV | 3-n | + +## 8.15.2 MME name + +If the MME is the sending entity, then the MME shall indicate its identity by including its MME name information element. Otherwise (i.e. if the VLR is the sending entity), then the VLR shall not include the MME name information element. + +## 8.15.3 VLR name + +If the VLR is the sending entity, then the VLR shall indicate its identity by including its VLR name information element. Otherwise (i.e. if the MME is the sending entity), then MME shall not include the VLR name information element. + +# 8.16 SGsAP-RESET-INDICATION message + +## 8.16.1 Message definition + +This message is sent from the VLR to the MME to indicate that a failure in the VLR has occurred and all the SGs associations to the VLR are to be marked as invalid. + +This message is also sent from the MME to the VLR to indicate that a failure in the MME has occurred and all the SGs associations to the MME are to be marked as invalid. + +The sending entity (either the MME or the VLR) includes its identity in the SGsAP-RESET-INDICATION message. Table 8.16.1.1 shows the content of the SGsAP-RESET-INDICATION message. + +**Table 8.16.1.1: SGsAP-RESET-INDICATION message content** + +| Information element | Type/Reference | Presence | Format | Length | +|---------------------|---------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| MME name | MME name
9.4.13 | C | TLV | 57 | +| VLR name | VLR name
9.4.22 | C | TLV | 3-n | + +## 8.16.2 MME name + +If the MME is the sending entity, then the MME shall indicate its identity by including its MME name information element. Otherwise (i.e. if the VLR is the sending entity), then the VLR shall not include the MME name information element. + +## 8.16.3 VLR name + +If the VLR is the sending entity, then the VLR shall indicate its identity by including its VLR name information element. Otherwise (i.e. if the MME is the sending entity), then the MME shall not include the VLR name information element. + +## 8.17 SGsAP-SERVICE-REQUEST message + +### 8.17.1 Message definition + +This message is sent from the MME to the VLR as a response to a previously received SGsAP-PAGING-REQUEST message to indicate the existence of a NAS signalling connection between the UE and the MME or to indicate to the VLR that the NAS signalling connection has been established after the paging procedure. Table 8.17.1 shows the content of the SGsAP-SERVICE-REQUEST message. + +**Table 8.17.1: SGsAP-SERVICE-REQUEST message content** + +| Information element | Type/Reference | Presence | Format | Length | +|----------------------------|----------------------------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | +| Service indicator | Service indicator
9.4.17 | M | TLV | 3 | +| IMEISV | IMEISV
9.4.5 | O | TLV | 10 | +| UE Time Zone | UE Time Zone
9.4.21b | O | TLV | 3 | +| Mobile Station Classmark 2 | Mobile Station Classmark 2
9.4.14a | O | TLV | 5 | +| TAI | Tracking Area Identity
9.4.21a | O | TLV | 7 | +| E-CGI | E-UTRAN Cell Global Identity
9.4.3a | O | TLV | 9 | +| UE EMM Mode | UE EMM mode
9.4.21c | O | TLV | 3 | + +### 8.17.2 IMEISV + +If the IMEISV is available in the MME, the MME shall include this information element. + +### 8.17.3 UE Time Zone + +If the UE Time Zone is available in the MME, the MME shall include this information element. + +### 8.17.4 Mobile Station Classmark 2 + +If the Mobile Station Classmark 2 is available in the MME, the MME shall include this information element. + +### 8.17.5 TAI + +If the TAI is available in the MME, the MME shall include this information element. + +### 8.17.6 E-CGI + +If the E-CGI is available in the MME, the MME shall include this information element. + +### 8.17.7 UE EMM Mode + +The MME shall include this information element. This information element indicates the EMM mode of the UE when the SGsAP-PAGING-REQUEST message was received by the MME. + +## 8.18 SGsAP-STATUS message + +### 8.18.1 Message definition + +This message is sent by both the VLR and the MME to indicate an error. The contents of SGsAP-STATUS message are shown in table 8.18.1.1. + +**Table 8.18.1.1: SGsAP-STATUS message content** + +| Information element | Type/Reference | Presence | Format | Length | +|---------------------|----------------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | O | TLV | 6-10 | +| SGs cause | SGs cause
9.4.18 | M | TLV | 3 | +| Erroneous message | Erroneous message
9.4.3 | M | TLV | 3-n | + +## 8.18.2 IMSI + +The MME shall include this information element if the IMSI is present in the erroneous message. + +## 8.19 SGsAP-TMSI-REALLOCATION-COMPLETE message + +This message is sent by the MME to the VLR to indicate that TMSI reallocation on the UE has been successfully completed. Table 8.19.1 shows the content of the SGsAP-TMSI-REALLOCATION-COMPLETE message. + +**Table 8.19.1: SGsAP-TMSI-REALLOCATION-COMPLETE message content** + +| Information element | Type/Reference | Presence | Format | Length | +|---------------------|---------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | + +## 8.20 SGsAP-UE-ACTIVITY-INDICATION message + +This message is sent by the MME to the VLR to indicate that activity from a UE has been detected. Table 8.20.1 shows the content of the SGsAP-UE-ACTIVITY-INDICATION message. + +**Table 8.20.1: SGsAP-UE-ACTIVITY-INDICATION message content** + +| Information element | Type/Reference | Presence | Format | Length | +|------------------------------|----------------------------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | +| Maximum UE Availability Time | Maximum UE Availability Time
9.4.28 | O | TLV | 6 | + +### 8.20.1 Maximum UE Availability Time + +For Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), the MME may include this information element to indicate the time until the UE is available. + +## 8.21 SGsAP-UE-UNREACHABLE message + +This message is sent from the MME to the VLR to indicate that, for example, paging could not be performed because the UE is marked as unreachable at the MME. Table 8.21.1 shows the content of the SGsAP-UE-UNREACHABLE message. + +**Table 8.21.1: SGsAP-UE-UNREACHABLE message content** + +| Information element | Type/Reference | Presence | Format | Length | +|--------------------------------------|------------------------------------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | +| SGs cause | SGs cause
9.4.18 | M | TLV | 3 | +| Requested Retransmission Time | Requested Retransmission Time
9.4.33 | O | TLV | 6 | +| Additional UE Unreachable indicators | Additional UE Unreachable indicators
9.4.31 | O | TLV | 3 | + +### 8.21.1 Requested Retransmission Time + +For Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), this information element may be included if the SGsAP-PAGING-REQUEST message included the Maximum Retransmission Time IE. + +### 8.21.2 Additional UE Unreachable indicators + +For Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), this information element may be included if the SGsAP-PAGING-REQUEST message includes the SM Delivery Timer and SM Delivery Start Time IEs and the UE is expected to be reachable before the time indicated by the SM Delivery Timer and SM Delivery Start Time IEs received in the SGsAP-PAGING-REQUEST message. + +## 8.22 SGsAP-UPLINK-UNITDATA message + +### 8.22.1 Message definition + +This message is sent from the MME to the VLR to transparently convey a NAS message, from the UE, to the VLR. Table 8.22.1 shows the content of the SGsAP-UPLINK-UNITDATA message. + +**Table 8.22.1: SGsAP-UPLINK-UNITDATA message content** + +| Information element | Type/Reference | Presence | Format | Length | +|----------------------------|----------------------------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | +| NAS message container | NAS message container
9.4.15 | M | TLV | 4-253 | +| IMEISV | IMEISV
9.4.5 | O | TLV | 10 | +| UE Time Zone | UE Time Zone
9.4.21b | O | TLV | 3 | +| Mobile Station Classmark 2 | Mobile Station Classmark 2
9.4.14a | O | TLV | 5 | +| TAI | Tracking Area Identity
9.4.21a | O | TLV | 7 | +| E-CGI | E-UTRAN Cell Global Identity
9.4.3a | O | TLV | 9 | + +### 8.22.2 IMEISV + +If the IMEISV is available in the MME, the MME shall include this information element. + +### 8.22.3 UE Time Zone + +If the UE Time Zone is available in the MME, the MME shall include this information element. + +## 8.22.4 Mobile Station Classmark 2 + +If the Mobile Station Classmark 2 is available in the MME, the MME shall include this information element. + +## 8.22.5 TAI + +If the TAI is available in the MME, the MME shall include this information element. + +## 8.22.6 E-CGI + +If the E-CGI is available in the MME, the MME shall include this information element. + +# 8.23 SGsAP-RELEASE-REQUEST message + +## 8.23.1 Message definition + +This message is sent by the VLR to the MME when the VLR determines that there are no more NAS messages to be exchanged between the VLR and the UE, or when a further exchange of NAS messages for the specified UE is not possible due to an error. Table 8.23.1 shows the content of the SGsAP-RELEASE-REQUEST message. + +**Table 8.23.1: SGsAP-RELEASE-REQUEST message content** + +| Information element | Type/Reference | Presence | Format | Length | +|---------------------|---------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | +| SGs cause | SGs cause
9.4.18 | O | TLV | 3 | + +## 8.23.2 SGs Cause + +The VLR shall include the SGs Cause to indicate an error. + +# 8.24 SGsAP-SERVICE-ABORT-REQUEST message + +## 8.24.1 Message definition + +This message is sent from the VLR to the MME to abort a mobile terminating CS fallback call during call establishment. Table 8.24.1.1 shows the content of the SGsAP-SERVICE-ABORT-REQUEST message. + +**Table 8.24.1.1: SGsAP-SERVICE-ABORT-REQUEST message content** + +| Information element | Type/Reference | Presence | Format | Length | +|---------------------|---------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | + +# 8.25 SGsAP-MO-CSFB-INDICATION message + +## 8.25.1 Message definition + +If the network is configured to support the return to the last used E-UTRAN PLMN after CS fallback, this message is sent from the MME to the VLR to indicate to the VLR that the UE initiated a service request for MO CS fallback. Table 8.25.1 shows the content of the SGsAP-MO-CSFB-INDICATION message. + +**Table 8.25.1: SGsAP-MO-CSFB-INDICATION message content** + +| Information element | Type/Reference | Presence | Format | Length | +|---------------------|----------------------------------------|----------|--------|--------| +| Message type | Message type
9.1 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | +| TAI | Tracking Area Identity
9.4.21a | O | TLV | 7 | +| E-CGI | E-UTRAN Cell Global Identity
9.4.3a | O | TLV | 9 | + +## 8.25.2 TAI + +If the TAI is available in the MME, the MME shall include this information element. + +## 8.25.3 E-CGI + +If the E-CGI is available in the MME, the MME shall include this information element. + +# 9 Information element coding + +## 9.1 Overview + +This clause specifies the coding of the information elements used in by the SGsAP protocol. + +The spare bits in the coding of an information element shall be set to zero by the sender and shall be ignored by the receiver. + +All unassigned codes (whether omitted or explicitly *Unassigned* in the text) shall be treated as unknown (see clause 7). + +## 9.2 Message type + +Message type uniquely identifies the message being sent. It is a single octet information element, mandatory in all messages. Table 9.2.1 defines the value part of the Message type information element. + +**Table 9.2.1: Message type information element** + +| 8 7 6 5 4 3 2 1 | Message type | Reference | +|------------------------------------------|------------------------------------------------|------------------| +| 0 0 0 0 0 0 0 0 | Unassigned: treated as an unknown Message type | 7 | +| 0 0 0 0 0 0 0 1 | SGsAP-PAGING-REQUEST | 8.14 | +| 0 0 0 0 0 0 1 0 | SGsAP-PAGING-REJECT | 8.13 | +| 0 0 0 0 0 0 1 1
to
0 0 0 0 0 1 0 1 | Unassigned: treated as an unknown Message type | 7 | +| 0 0 0 0 0 1 1 0 | SGsAP-SERVICE-REQUEST | 8.17 | +| 0 0 0 0 0 1 1 1 | SGsAP-DOWNLINK-UNITDATA | 8.4 | +| 0 0 0 0 1 0 0 0 | SGsAP-UPLINK-UNITDATA | 8.22 | +| 0 0 0 0 1 0 0 1 | SGsAP-LOCATION-UPDATE-REQUEST | 8.11 | +| 0 0 0 0 1 0 1 0 | SGsAP-LOCATION-UPDATE-ACCEPT | 8.9 | +| 0 0 0 0 1 0 1 1 | SGsAP-LOCATION-UPDATE-REJECT | 8.10 | +| 0 0 0 0 1 1 0 0 | SGsAP-TMSI-REALLOCATION-COMPLETE | 8.19 | +| 0 0 0 0 1 1 0 1 | SGsAP-ALERT-REQUEST | 8.3 | +| 0 0 0 0 1 1 1 0 | SGsAP-ALERT-ACK | 8.1 | +| 0 0 0 0 1 1 1 1 | SGsAP-ALERT-REJECT | 8.2 | +| 0 0 0 1 0 0 0 0 | SGsAP-UE-ACTIVITY-INDICATION | 8.20 | +| 0 0 0 1 0 0 0 1 | SGsAP-EPS-DETACH-INDICATION | 8.6 | +| 0 0 0 1 0 0 1 0 | SGsAP-EPS-DETACH-ACK | 8.5 | +| 0 0 0 1 0 0 1 1 | SGsAP-IMSI-DETACH-INDICATION | 8.8 | +| 0 0 0 1 0 1 0 0 | SGsAP-IMSI-DETACH-ACK | 8.7 | +| 0 0 0 1 0 1 0 1 | SGsAP-RESET-INDICATION | 8.16 | +| 0 0 0 1 0 1 1 0 | SGsAP-RESET-ACK | 8.15 | +| 0 0 0 1 0 1 1 1 | SGsAP-SERVICE-ABORT-REQUEST | 8.24 | +| 0 0 0 1 1 0 0 0 | SGsAP-MO-CSFB-INDICATION | 8.25 | +| 0 0 0 1 1 0 0 1
to
0 0 0 1 1 0 0 1 | Unassigned: treated as an unknown Message type | 7 | +| 0 0 0 1 1 0 1 0 | SGsAP-MM-INFORMATION-REQUEST | 8.12 | +| 0 0 0 1 1 0 1 1 | SGsAP-RELEASE-REQUEST | 8.23 | +| 0 0 0 1 1 1 0 0 | Unassigned: treated as an unknown Message type | 7 | +| 0 0 0 1 1 1 0 1 | SGsAP-STATUS | 8.18 | +| 0 0 0 1 1 1 1 0 | Unassigned: treated as an unknown Message type | 7 | +| 0 0 0 1 1 1 1 1 | SGsAP-UE-UNREACHABLE | 8.21 | + +## 9.3 Information element identifiers + +The next list shows the coding of the information element identifiers used in the present document. Table 9.3.1 shows the values assigned for the information element identifiers. + +**Table 9.3.1: Information element identifier coding** + +| 8 7 6 5 4 3 2 1 | Information element | Reference | +|-----------------|---------------------------------------|-----------| +| 0 0 0 0 0 0 0 1 | IMSI | 9.4.6 | +| 0 0 0 0 0 0 1 0 | VLR name | 9.4.22 | +| 0 0 0 0 0 0 1 1 | TMSI | 9.4.20 | +| 0 0 0 0 0 1 0 0 | Location area identifier | 9.4.11 | +| 0 0 0 0 0 1 0 1 | Channel Needed | 9.4.23 | +| 0 0 0 0 0 1 1 0 | eMLPP Priority | 9.4.24 | +| 0 0 0 0 0 1 1 1 | TMSI status | 9.4.21 | +| 0 0 0 0 1 0 0 0 | SGs cause | 9.4.18 | +| 0 0 0 0 1 0 0 1 | MME name | 9.4.13 | +| 0 0 0 0 1 0 1 0 | EPS location update type | 9.4.2 | +| 0 0 0 0 1 0 1 1 | Global CN-Id | 9.4.4 | +| 0 0 0 0 1 1 1 0 | Mobile identity | 9.4.14 | +| 0 0 0 0 1 1 1 1 | Reject cause | 9.4.16 | +| 0 0 0 1 0 0 0 0 | IMSI detach from EPS service type | 9.4.7 | +| 0 0 0 1 0 0 0 1 | IMSI detach from non-EPS service type | 9.4.8 | +| 0 0 0 1 0 1 0 1 | IMEISV | 9.4.5 | +| 0 0 0 1 0 1 1 0 | NAS message container | 9.4.15 | +| 0 0 0 1 0 1 1 1 | MM information | 9.4.12 | +| 0 0 0 1 1 0 1 1 | Erroneous message | 9.4.3 | +| 0 0 0 1 1 1 0 0 | CLI | 9.4.1 | +| 0 0 0 1 1 1 0 1 | LCS client identity | 9.4.9 | +| 0 0 0 1 1 1 1 0 | LCS indicator | 9.4.10 | +| 0 0 0 1 1 1 1 1 | SS code | 9.4.19 | +| 0 0 1 0 0 0 0 0 | Service indicator | 9.4.17 | +| 0 0 1 0 0 0 0 1 | UE Time Zone | 9.4.21b | +| 0 0 1 0 0 0 1 0 | Mobile Station Classmark 2 | 9.4.14a | +| 0 0 1 0 0 0 1 1 | Tracking Area Identity | 9.4.21a | +| 0 0 1 0 0 1 0 0 | E-UTRAN Cell Global Identity | 9.4.3a | +| 0 0 1 0 0 1 0 1 | UE EMM mode | 9.4.21c | +| 0 0 1 0 0 1 1 0 | Additional paging indicators | 9.4.25 | +| 0 0 1 0 0 1 1 1 | TMSI based NRI container | 9.4.26 | +| 0 0 1 0 1 0 0 0 | Selected CS domain operator | 9.4.27 | +| 0 0 1 0 1 0 0 1 | Maximum UE Availability Time | 9.4.28 | +| 0 0 1 0 1 0 1 0 | SM Delivery Timer | 9.4.29 | +| 0 0 1 0 1 0 1 1 | SM Delivery Start Time | 9.4.30 | +| 0 0 1 0 1 1 0 0 | Additional UE Unreachable indicators | 9.4.31 | +| 0 0 1 0 1 1 0 1 | Maximum Retransmission Time | 9.4.32 | +| 0 0 1 0 1 1 1 0 | Requested Retransmission Time | 9.4.33 | + +### 9.3a Length indicator + +The length indicator of the information elements consists of one octet and contains the binary encoding of the number of octets of the value part in the information elements. + +## 9.4 Information elements + +### 9.4.1 CLI + +This information element is used to represent calling line identification for the terminating call received in the CS domain. The CLI information element is coded as shown in figure 9.4.1.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3
To
Octet 14 | Octets 3 to 14 contain the value part of the Calling party BCD number information element defined in subclause 10.5.4.9 of 3GPP TS 24.008 [8] (octets 3 to 14, i.e. not including 3GPP TS 24.008 IEI and 3GPP TS 24.008 length indicator) | | | | | | | | + +Figure 9.4.1.1: Calling Line Identification information element + +## 9.4.2 EPS location update type + +The purpose of the EPS location update type information element is to indicate to the VLR whether an IMSI attach or a normal location update has been performed by the UE. The EPS location update type information element is coded as shown in figure 9.4.2.1 and table 9.4.2.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|---------|--------------------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3 | EPS location update type value | | | | | | | | + +Figure 9.4.2.1: EPS location update type information element + +Table 9.4.2.1: EPS location update type information element value part + +| EPS location update type value (octet 3) | | +|------------------------------------------|-------------------------------------------------------------------------------------------------| +| Bits | | +| 8 7 6 5 4 3 2 1 | | +| 0 0 0 0 0 0 0 0 | Shall not be sent in this version of the protocol. If received, shall be treated as '000000010' | +| 0 0 0 0 0 0 0 1 | IMSI attach | +| 0 0 0 0 0 0 1 0 | Normal location update | +| 0 0 0 0 0 0 1 1 | to | +| 1 1 1 1 1 1 1 1 | | +| | Shall not be sent in this version of the protocol. If received, shall be treated as '000000010' | + +## 9.4.3 Erroneous message + +See subclause 18.4.5 in 3GPP TS 29.018 [16]. + +### 9.4.3a E-UTRAN Cell Global Identity + +The E-UTRAN Cell Global Identity information element indicates the UE's current E-UTRAN Cell Global Identity. The E-UTRAN Cell Global Identity information element is coded as shown in figure 9.4.3a.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|--------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3
- | The coding of the E-UTRAN Cell Global Identity value is according to ECGI field information element as specified in subclause 8.21.5 of 3GPP TS 29.274 [17A] | | | | | | | | +| Octet 9 | | | | | | | | | + +Figure 9.4.3a.1: E-UTRAN Cell Global Identity information element + +## 9.4.4 Global CN-Id + +See subclause 18.4.27 in 3GPP TS 29.018 [16]. + +## 9.4.5 IMEISV + +See subclause 18.4.9 in 3GPP TS 29.018 [16]. + +## 9.4.6 IMSI + +See subclause 18.4.10 in 3GPP TS 29.018 [16]. + +## 9.4.7 IMSI detach from EPS service type + +The IMSI detach from EPS service type information element indicates from MME to VLR the particular type of IMSI detach from EPS. The IMSI detach from EPS service type information element is coded as shown in figure 9.4.7.1 and table 9.4.7.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|---------|-----------------------------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3 | IMSI detach from EPS service type value | | | | | | | | + +Figure 9.4.7.1: IMSI detach from EPS service type information element + +Table 9.4.7.1: IMSI detach from EPS service type information element value + +| IMSI detach from EPS service type value (octet 3) | | | +|---------------------------------------------------|---|-----------------------------------------------------------------------| +| Bits | | | +| 8 | 7 | 6 5 4 3 2 1 | +| 0 | 0 | 0 0 0 0 0 0 0 Interpreted as reserved in this version of the protocol | +| 0 | 0 | 0 0 0 0 0 0 1 Network initiated IMSI detach from EPS services | +| 0 | 0 | 0 0 0 0 0 1 0 UE initiated IMSI detach from EPS services | +| 0 | 0 | 0 0 0 0 0 1 1 EPS services not allowed | +| 0 | 0 | 0 0 0 0 1 0 0 | +| to | | Interpreted as reserved in this version of the protocol | +| 1 | 1 | 1 1 1 1 1 1 1 | + +## 9.4.8 IMSI detach from non-EPS service type + +The IMSI detach from non-EPS service type information element indicates from MME to VLR the particular type of IMSI detach from non-EPS. The IMSI detach from non-EPS service type information element is coded as shown in figure 9.4.8.1 and table 9.4.8.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|---------|---------------------------------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3 | IMSI detach from non-EPS service type value | | | | | | | | + +Figure 9.4.8.1: IMSI detach from non-EPS service type information element + +**Table 9.4.8.1: IMSI detach from non-EPS service type information element value** + +| IMSI detach from non-EPS service type value (octet 3) | | +|-------------------------------------------------------|----------------------------------------------------------------------| +| Bits | | +| 8 7 6 5 4 3 2 1 | | +| 0 0 0 0 0 0 0 0 | Interpreted as reserved in this version of the protocol | +| 0 0 0 0 0 0 0 1 | Explicit UE initiated IMSI detach from non-EPS services | +| 0 0 0 0 0 1 0 | Combined UE initiated IMSI detach from EPS and non-EPS services | +| 0 0 0 0 0 1 1 | Implicit network initiated IMSI detach from EPS and non-EPS services | +| 0 0 0 0 1 0 0 | to | +| to | | +| 1 1 1 1 1 1 1 | Interpreted as reserved in this version of the protocol | + +## 9.4.9 LCS client identity + +The LCS client identity information element is a compound parameter and comprises information related to the client of a LCS request. The LCS client identity information element is coded as shown in figure 9.4.9.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|----------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3
to
Octet n | The coding of the LCS client identity value is according to LCS-ClientID as specified in subclause 17.7.13 of 3GPP TS 29.002 [15] | | | | | | | | + +**Figure 9.4.9.1: LCS client identity information element** + +## 9.4.10 LCS indicator + +The LCS indicator information element indicates that the origin of the message is due to a LCS request and the type of this request. The LCS indicator information element is coded as shown in figure 9.4.10.1 and table 9.4.10.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|----------------|---------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3 | LCS indicator value | | | | | | | | + +**Figure 9.4.10.1: LCS indicator information element****Table 9.4.10.1: LCS indicator value** + +| LCS indicator | | +|-----------------|------------------------------------------------------| +| Bits | | +| 8 7 6 5 4 3 2 1 | | +| 0 0 0 0 0 0 0 0 | Normal, unspecified in this version of the protocol. | +| 0 0 0 0 0 0 0 1 | MT-LR | +| 0 0 0 0 0 1 0 | to | +| to | | +| 1 1 1 1 1 1 1 | Normal, unspecified in this version of the protocol | + +## 9.4.11 Location area identifier + +This element uniquely identifies one Location Area. The Location area identifier information element is coded as shown in figure 9.4.11.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length Indicator | | | | | | | | +| Octet 3
-
Octet 7 | Octets 3 to 7 contain the value part of the Location area identification information element defined in 3GPP TS 24.008 [8] (starting with octet 2, i.e. not including 3GPP TS 24.008 IEI) | | | | | | | | + +Figure 9.4.11.1: Location area identifier information element + +## 9.4.12 MM information + +The MM information information element is a TLV information element that encapsulates the user information that the MME forwards to the UE. For the coding see subclause 18.4.16 in 3GPP TS 29.018 [16]. + +## 9.4.13 MME name + +The MME name information element specifies the MME name and is coded as shown in figure 9.4.13.1. Octets 3 through 57 contain MME node FQDN as specified in subclause 19.4.2.4 of 3GPP TS 23.003 [3]. The contents of octets 3 through 57 shall be coded as a fully qualified domain name (FQDN) as specified in subclause 19.4.2.1 of 3GPP TS 23.003 [3]. The value part of the MME name information element (not including IEI and length indicator) shall have a length of 55 octets. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|-----------|-------------------------------------------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length Indicator | | | | | | | | +| Octet 3 | Length field of the 1st label of the MME Name | | | | | | | | +| Octet 4 | Leftmost character of the 1st label of the MME name | | | | | | | | +| Octet 5 | - | | | | | | | | +| Octet m | Length field of the i-th label of the MME Name | | | | | | | | +| Octet m+1 | Leftmost character of the i-th label of the MME name | | | | | | | | +| Octet m+2 | - | | | | | | | | +| - | | | | | | | | | +| Octet 57 | Rightmost character of the last label of the MME Name | | | | | | | | + +Figure 9.4.13.1: MME name information element + +## 9.4.14 Mobile identity + +See subclause 18.4.17 in 3GPP TS 29.018 [16]. + +### 9.4.14a Mobile Station Classmark 2 + +With the exception of the IEI, the contents are specified in subclause 10.5.1.6 in 3GPP TS 24.008 [8]. + +## 9.4.15 NAS message container + +This information element is used to encapsulate the SMS messages transferred between the VLR and the MME. The NAS message container information element is coded as shown in figure 9.4.15.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|----------------------------|-------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3
to
Octet 253 | Octets 3 to 253 contain the SMS message (i.e. CP-DATA, CP-ACK or CP-ERROR) as defined in subclause 7.2 of 3GPP TS 24.011 [10] | | | | | | | | + +Figure 9.4.15.1: NAS message container information element + +## 9.4.16 Reject cause + +See subclause 18.4.21 in 3GPP TS 29.018 [16]. + +## 9.4.17 Service indicator + +This information element indicates the type of the CS service (e.g. voice call, Short Message Service). The Service indicator information element is coded as shown in figure 9.4.17.1 and table 9.4.17.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|---------|-------------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3 | Service indicator value | | | | | | | | + +Figure 9.4.17.1: Service indicator information element + +Table 9.4.17.1: Service indicator value + +| Service indicator | | +|-------------------|------------------------------------------------------------------------------------------------| +| Bits | | +| 8 7 6 5 4 3 2 1 | | +| 0 0 0 0 0 0 0 0 | Shall not be sent in this version of the protocol. If received, shall be treated as '00000001' | +| 0 0 0 0 0 0 0 1 | CS call indicator | +| 0 0 0 0 0 0 1 0 | SMS indicator | +| 0 0 0 0 0 0 1 1 | to | +| 1 1 1 1 1 1 1 1 | | +| | Shall not be sent in this version of the protocol. If received, shall be treated as '00000001' | + +## 9.4.18 SGs cause + +The purpose of the SGs cause information element is to indicate an error to the receiving entity. This could be a protocol data error, to indicate to the VLR the reason why a paging procedure could not be performed or to indicate to the VLR that the mobile terminating CS fallback call has been rejected by the user. The SGs cause information element is coded as shown in figure 9.4.18.1 and table 9.4.18.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|---------|------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3 | SGs cause value | | | | | | | | + +Figure 9.4.18.1: SGs cause information element + +**Table 9.4.18.1: SGs cause information element value part** + +| | | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----|----------------------------------------------------------| +| SGs cause value (octet 3) | | | +| Bits | | | +| 8 7 6 5 4 3 2 1 | | | +| 0 0 0 0 0 0 0 0 | | Normal, unspecified in this version of the protocol. | +| 0 0 0 0 0 0 0 1 | | IMSI detached for EPS services | +| 0 0 0 0 0 0 1 0 | | IMSI detached for EPS and non-EPS services | +| 0 0 0 0 0 0 1 1 | | IMSI unknown | +| 0 0 0 0 0 1 0 0 | | IMSI detached for non-EPS services | +| 0 0 0 0 0 1 0 1 | | IMSI implicitly detached for non-EPS services | +| 0 0 0 0 0 1 1 0 | | UE unreachable | +| 0 0 0 0 0 1 1 1 | | Message not compatible with the protocol state | +| 0 0 0 0 1 0 0 0 | | Missing mandatory information element | +| 0 0 0 0 1 0 0 1 | | Invalid mandatory information | +| 0 0 0 0 1 0 1 0 | | Conditional information element error | +| 0 0 0 0 1 0 1 1 | | Semantically incorrect message | +| 0 0 0 0 1 1 0 0 | | Message unknown | +| 0 0 0 0 1 1 0 1 | | Mobile terminating CS fallback call rejected by the user | +| 0 0 0 0 1 1 1 0 | | UE temporarily unreachable | +| 0 0 0 0 1 1 1 1 | to | Normal, unspecified in this version of the protocol | +| 1 1 1 1 1 1 1 1 | | | +| NOTE: "Normal, unspecified" has the same meaning than in 3GPP TS 24.008 [8], informative Annex H (UMTS specific cause values for call control). It is used to report a normal event, and should not be interpreted as syntactically incorrect nor unknown if received. | | | + +## 9.4.19 SS code + +The SS code information element is used to represent the code identifying a single supplementary service, a group of supplementary services, or all supplementary services. The SS code information element is coded as shown in figure 9.4.19.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|----------------|-----------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3 | The coding of the SS code value is according to SS-Code as specified in subclause 17.7.5 of 3GPP TS 29.002 [15] | | | | | | | | + +**Figure 9.4.19.1: SS code information element** + +## 9.4.20 TMSI + +See subclause 18.4.23 in 3GPP TS 29.018 [16]. + +## 9.4.21 TMSI status + +See subclause 18.4.24 in 3GPP TS 29.018 [16]. + +## 9.4.21a Tracking Area Identity + +This element uniquely identifies one Tracking Area. The Tracking Area Identity information element is coded as shown in figure 9.4.21a.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3 | Octets 3 to 7 contain the value part of the Tracking Area Identity information element defined in 3GPP TS 24.301 [14] (starting with octet 2, i.e. not including 3GPP TS 24.301 IEI) | | | | | | | | +| Octet 7 | | | | | | | | | + +**Figure 9.4.21a.1: Tracking Area Identity information element** + +## 9.4.21b UE Time Zone + +This element identifies the offset between universal time and local time in steps of 15 minutes. The UE Time Zone information element is coded as shown in figure 9.4.21b.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---|---| +| Octet 1 | E | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3 | The coding of the UE Time Zone value is according to value part of the Time Zone information element as specified in subclause 10.5.3.8 of 3GPP TS 24.008 [8] (i.e. not including 3GPP TS 24.008 E ) | | | | | | | | + +**Figure 9.4.21b.1: UE Time Zone information element** + +## 9.4.21c UE EMM mode + +The UE EMM mode information element is used by MME to indicate to the VLR the EMM mode of the UE upon reception of the SGsAP-PAGING-REQUEST message. The UE EMM mode information element is coded as shown in figure 9.4.21c.1 and table 9.4.21c.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|----------------|-------------------|---|---|---|---|---|---|---| +| Octet 1 | E | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3 | UE EMM mode value | | | | | | | | + +**Figure 9.4.21c.1: UE EMM mode information element****Table 9.4.21c.1: UE EMM mode value** + +| | | | +|-----------------------------|---|---------------------------------------------------------| +| UE EMM mode value (octet 3) | | | +| Bits | | | +| 8 | 7 | 6 5 4 3 2 1 | +| 0 | 0 | 0 0 0 0 0 0 0 EMM-IDLE | +| 0 | 0 | 0 0 0 0 0 0 1 EMM-CONNECTED | +| 0 | 0 | 0 0 0 0 0 1 0 | +| to | | Interpreted as reserved in this version of the protocol | +| 1 | 1 | 1 1 1 1 1 1 1 | + +## 9.4.22 VLR name + +The VLR name information element specifies the VLR name and is coded as shown in figure 9.4.22.1. The contents of octets 3 through n shall be coded as a fully qualified domain name (FQDN) as specified in 3GPP TS 23.003 [3]. + +NOTE: In earlier releases of this specification, the coding of VLR Name was not clear. Implementations based on earlier releases that encode VLR Name as a string with labels separated by dot can exist. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|-----------|-------------------------------------------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length Indicator | | | | | | | | +| Octet 3 | Length field of the 1st label of the VLR Name | | | | | | | | +| Octet 4 | Leftmost character of the 1st label of the VLR name | | | | | | | | +| Octet 5 | - | | | | | | | | +| Octet m | Length field of the i-th label of the VLR Name | | | | | | | | +| Octet m+1 | Leftmost character of the i-th label of the VLR name | | | | | | | | +| Octet m+2 | - | | | | | | | | +| - | | | | | | | | | +| Octet n | Rightmost character of the last label of the VLR Name | | | | | | | | + +Figure 9.4.22.1: VLR name information element + +## 9.4.23 Channel needed + +See subclause 18.4.2 in 3GPP TS 29.018 [16]. + +## 9.4.24 eMLPP priority + +See subclause 18.4.4 in 3GPP TS 29.018 [16]. + +## 9.4.25 Additional paging indicators + +The Additional paging indicators information element provides additional information during the paging procedure. The Additional paging indicators information element is coded as shown in figure 9.4.25.1 and table 9.4.25.1. + +The Additional paging indicators is a type 4 information element with a length of 3 octets. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|---------|------------------|---|---|---|---|---|---|------| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | CSRI | +| | Spare | | | | | | | | + +Figure 9.4.25.1: Additional paging indicators information element + +Table 9.4.25.1: Additional paging indicators value + +| | +|------------------------------------------------------------------| +| Additional paging indicators value (octet 3, bit 1) | +| Bits | +| 1 | +| 0 CS restoration indicator (CSRI) is not set | +| 1 CS restoration indicator (CSRI) is set | +| Bits 8 to 2 of octet 3 are spare and shall be all coded as zero. | + +## 9.4.26 TMSI based NRI container + +See subclause 18.4.28 in 3GPP TS 29.018 [16]. + +## 9.4.27 Selected CS domain operator + +The selected CS domain operator information element indicates the CS domain operator selected by the MME when CS domain is configured for gateway core network (GWCN), the preferred RAT of the selected PLMN for CS fallback is GERAN, and the UE does not support GERAN network sharing. The selected CS domain operator information element is coded as shown in figure 9.4.27.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|---------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3
-
Octet 5 | Coded as octets 2 to 4 of the Location Area Identification IE, defined in 3GPP TS 24.008 [8] (not including 3GPP TS 24.008 IEI and LAC). | | | | | | | | + +Figure 9.4.27.1: Selected CS domain operator information element + +## 9.4.28 Maximum UE Availability Time + +For Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), the Maximum UE Availability Time IE indicates the (UTC) time until which a UE using eDRX is expected to be reachable. The Maximum UE Availability Time IE is coded as shown in figure 9.4.28.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|----------------------------------------|--------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3
to
Octet 6 | Maximum UE Availability Time value, encoded as the Maximum UE Availability Time IE in subclause 12.4.2 of 3GPP TS 29.002 [15]. | | | | | | | | + +Figure 9.4.28.1: Maximum UE Availability Time information element + +## 9.4.29 SM Delivery Timer + +For Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), this IE identifies, together with the SM Delivery Start Time, the time until which the VLR buffers the Short Message. The SM Delivery Timer IE is coded as shown in figure 9.4.29.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|----------------------------------------|----------------------------------------------------------------------------------------------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3
to
Octet 4 | SM Delivery Timer value, encoded as the SM Delivery Timer IE in subclause 12.9.2 of 3GPP TS 29.002 [15]. | | | | | | | | + +Figure 9.4.29.1: SM Delivery Timer information element + +## 9.4.30 SM Delivery Start Time + +For Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), this IE identifies, together with the SM Delivery Timer, the time until which the VLR buffers the Short Message. The SM Delivery Start Time IE is coded as shown in figure 9.4.30.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|----------------------------------------|--------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3
to
Octet 6 | SM Delivery Start Time value, encoded as the SM Delivery Start Time IE in subclause 12.9.2 of 3GPP TS 29.002 [15]. | | | | | | | | + +Figure 9.4.30.1: SM Delivery Start Time information element + +### 9.4.31 Additional UE Unreachable indicators + +For Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), the Additional UE Unreachable indicators information element provides additional information during the paging for non-EPS services procedure. The Additional UE Unreachable indicators information element is coded as shown in figure 9.4.31.1 and table 9.4.31.1. + +The Additional UE Unreachable indicators is a type 4 information element with a length of 3 octets. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|----------------|------------------|---|---|---|---|---|---|-------| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | SMBRI | +| | Spare | | | | | | | | + +**Figure 9.4.31.1: Additional UE Unreachable indicators information element** + +**Table 9.4.31.1: Additional UE Unreachable indicators value** + +| | +|------------------------------------------------------------------| +| Additional paging indicators value (octet 3, bit 1) | +| Bits | +| 1 | +| 0 SM Buffer Request Indicator (SMBRI) is not set | +| 1 SM Buffer Request Indicator (SMBRI) is set | +| Bits 8 to 2 of octet 3 are spare and shall be all coded as zero. | + +### 9.4.32 Maximum Retransmission Time + +For Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), the Maximum Retransmission Time IE indicates the time until which the SMS-GMSC is capable to retransmit the Short Message. The Maximum Retransmission Time IE is coded as shown in figure 9.4.32.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|-----------------------------------|------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3
to
Octet 6
| Maximum Retransmission Time value, encoded as the Maximum Retransmission Time IE in subclause 12.9.2 of 3GPP TS 29.002 [15]. | | | | | | | | + +**Figure 9.4.32.1: Maximum Retransmission Time information element** + +### 9.4.33 Requested Retransmission Time + +For Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), the Requested Retransmission Time IE indicates the time at which the MME requests the SMS-GMSC to retransmit the Short Message. The Requested Retransmission Time IE is coded as shown in figure 9.4.33.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|-----------------------------------|----------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3
to
Octet 6
| Requested Retransmission Time value, encoded as the Requested Retransmission Time IE in subclause 12.9.2 of 3GPP TS 29.002 [15]. | | | | | | | | + +**Figure 9.4.33.1: Requested Retransmission Time information element** + +## 10 List of system variables + +### 10.1 Timers + +This subclause lists the management timers specified for the operation of the SGsAP protocol. All the implementation shall support the range of values specified in table 10.1.1 or table 10.1.2 as appropriate. The specific value of the timers is under the control of the operator. + +**Table 10.1.1: Management timers – MME side** + +| Timer name | Default value | Timer range | Granularity | Notes | Relation to other timers | +|------------|---------------|----------------|-------------|------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Ts6-1 | - | 10 s to 90 s | 1 s | Guards the Location Update procedure. | It is expected to take a value greater than 2 times the maximum transmission time in the SGs interface, plus the supervision timer of the Update Location procedure (as defined in 3GPP TS 29.002 [15]) | +| Ts8 | 4 s | 1s to 30 s | 1 s | Guards the Explicit IMSI detach from EPS services procedure. | None. | +| Ts9 | 4 s | 1-30 s | 1 s | Guards the Explicit IMSI detach from non-EPS services procedure. | None. | +| Ts10 | 4 s | 1-30 s | 1 s | Guards the Implicit IMSI detach from non-EPS services procedure. | None. | +| Ts12-1 | - | 8 - 60x384+8 s | 1 min | Controls the resetting of the 'MME-Reset' variable. | It is expected to take a value greater than the longest periodic tracking area update timer running on the MME, plus the transmission delay on the radio interface. | +| Ts12-2 | 4 s | 1-120 s | 1 s | Guards the MME reset procedure. There is one Ts12-2 timer per VLR for which the MME has a SGs association. | None. | +| Ts13 | 4 s | 1-30 s | 1 s | Guards the Implicit IMSI detach from EPS services procedure. | None. | + +NOTE: The Default value is the recommended value. + +**Table 10.1.2: Management timers – VLR side** + +| Timer name | Default value | Timer range | Granularity | Notes | Relation to other timers | +|------------|---------------|----------------------|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Ts5 | - | 2 s to 20 s | 100 ms | Guards the Paging procedure at the VLR. | Value is correlated to paging cycle. The default is set according to maximum paging cycle supported by the MME (operator choice) as defined in 3GPP TS 36.331 [19]. | +| Ts6-2 | 40 s | 5 s to 60 s | 1 s | Guards the TMSI reallocation procedure. | It is expected to take a value greater than 2 times the maximum transmission time in the SGs interface, plus 4 times T3450 (as defined in 3GPP TS 24.301 [14]). The T3450 value to use in the calculation is the value for cases without coverage enhancement. | +| Ts7 | 4 s | 1 s to 30 s | 1 s | Guards the Non-EPS alert procedure. | None. | +| Ts11 | 4 s | 1-120 s | 1 s | Guards the VLR reset procedure. There is one Ts11 timer per MME for which the VLR has a SGs association. | None. | +| Ts14 | - | 5 s to 20 s (NOTE 2) | 1 s | Guards the MT UE fallback procedure to UTRAN/GERAN | It is expected to take a value greater than T3417ext-mt. Otherwise, the UE can attempt to select GERAN/UTRAN although the call is already released. | +| Ts15 | - | 1 s to 20 s (NOTE 2) | 1 s | Guards the MO UE fallback procedure to UTRAN/GERAN when the network is configured to support the return to the last used E-UTRAN PLMN after CS fallback | None. | + +NOTE 1: The Default value is the recommended value. +NOTE 2: If a too small value is configured, the timer can expire before a successful fallback to UTRAN/GERAN occurs. + +## 10.2 Retry counters + +This subclause lists the management retry counters specified for the operation of the SGsAP protocol. The values in table 10.2.1 and table 10.2.2 are recommended values. + +**Table 10.2.1: Management retry counters – VLR side** + +| Retry counter name | Retry value | +|--------------------|-------------| +| Ns7 | 2 | +| Ns11 | 2 | + +**Table 10.2.2: Management retry counters – MME side** + +| Retry counter name | Retry value | +|--------------------|-------------| +| Ns8 | 2 | +| Ns9 | 2 | +| Ns10 | 2 | +| Ns12 | 2 | + +## Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|---------------|-----------|------|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|-------| +| Date | TSG # | TSG Doc. | CR | R
e
v | Subject/Comment | Old | New | +| 2008-06 | | | | | Draft skeleton provided by rapporteur. | - | 0.0.0 | +| 2008-06 | CT1#54 | | | | Includes the following contributions agreed by CT1:
C1-082435, C1-082710 | 0.0.0 | 0.1.0 | +| 2008-08 | CT1#55 | | | | Includes the following contributions agreed by CT1:
C1-083518, C1-083519, C1-083520, C1-083521, C1-083523, C1-083586 | 0.1.0 | 0.2.0 | +| 2008-09 | e-mail review | | | | Added newly assigned TS number and updated title and scope for correct definition of VLR acronym. | 0.2.0 | 0.2.1 | +| 2008-10 | CT1#55 bis | | | | Includes the following contributions agreed by CT1:
C1-083821, C1-083822, C1-083824, C1-084195, C1-084199, C1-084300, C1-084301, C1-084302, C1-084303, C1-084304, C1-084305, C1-084306, C1-084307, C1-084312, C1-084314, C1-084483, C1-084485, C1-084486, C1-084487, C1-084488 | 0.2.1 | 0.3.0 | +| 2008-11 | CT1#56 | | | | Includes the following contributions agreed by CT1:
C1-084709, C1-084719, C1-084722, C1-085182, C1-085194, C1-085195, C1-085196, C1-085197, C1-085301, C1-085302, C1-085303, C1-085311, C1-085522
Changes by the rapporteur:
- correction of title for 3GPP TS 22.101 and 3GPP TS 32.422 in references subclause
- information element identifiers for LCS client identity, LCS indicator, MM information and SS code added to table 9.3.1
- details for coding of LCS client identity moved to figure 9.4.9.1 and details for coding of SS code moved to figure 9.4.19.1
- editorial corrections to align with drafting rules | 0.3.0 | 0.4.0 | +| 2008-11 | | | | | Version 1.0.0 created for presentation to CT#42 for information and approval | 0.4.0 | 1.0.0 | +| 2008-12 | CT#42 | | | | Version 8.0.0 created after approval in CT#42 | 1.0.0 | 8.0.0 | +| 2009-03 | CT#43 | CP-090154 | 0001 | 2 | Handle of CSFB paging procedure when UE is in connected mode | 8.0.0 | 8.1.0 | +| 2009-03 | CT#43 | CP-090154 | 0002 | | SGs paging with access control in E-UTRAN | 8.0.0 | 8.1.0 | +| 2009-03 | CT#43 | CP-090154 | 0003 | 2 | Clarifications of paging procedure in MME | 8.0.0 | 8.1.0 | +| 2009-03 | CT#43 | CP-090154 | 0004 | 1 | Consistent usage of HSS | 8.0.0 | 8.1.0 | +| 2009-03 | CT#43 | CP-090154 | 0005 | | Location update for non-EPS services procedure: failure and abnormal cases | 8.0.0 | 8.1.0 | +| 2009-03 | CT#43 | CP-090154 | 0006 | 1 | Clarifications for MM information procedure | 8.0.0 | 8.1.0 | +| 2009-03 | CT#43 | CP-090154 | 0007 | 1 | VLR number derivation | 8.0.0 | 8.1.0 | +| 2009-03 | CT#43 | CP-090154 | 0008 | 3 | Abnormal conditions for UL and DL Unitdata procedures | 8.0.0 | 8.1.0 | +| 2009-03 | CT#43 | CP-090154 | 0009 | 1 | MME behaviour when receiving paging for SMS | 8.0.0 | 8.1.0 | +| 2009-03 | CT#43 | CP-090154 | 0010 | 1 | Adding IE details | 8.0.0 | 8.1.0 | +| 2009-03 | CT#43 | CP-090154 | 0011 | 2 | Corrections in state models for VLR/MME | 8.0.0 | 8.1.0 | +| 2009-03 | CT#43 | CP-090154 | 0012 | 2 | SS handling details in VLR | 8.0.0 | 8.1.0 | +| 2009-03 | CT#43 | CP-090154 | 0013 | 2 | IE of paging request | 8.0.0 | 8.1.0 | +| 2009-03 | CT#43 | CP-090154 | 0014 | 1 | Corrections and additions for procedures for SMS delivery over SGs | 8.0.0 | 8.1.0 | +| 2009-06 | CT#44 | CP-090421 | 0017 | | Removing Editor's note on EPS location update type | 8.1.0 | 8.2.0 | +| 2009-06 | CT#44 | CP-090421 | 0019 | 1 | Correction of the location update initiation | 8.1.0 | 8.2.0 | +| 2009-06 | CT#44 | CP-090421 | 0021 | 1 | Paging Procedure when MME restarts | 8.1.0 | 8.2.0 | +| 2009-06 | CT#44 | CP-090421 | 0022 | | Forward of CS paging to the SGSN when ISR is activated | 8.1.0 | 8.2.0 | +| 2009-09 | CT#45 | CP-090674 | 0023 | | Correction to the Location update for non-EPS services procedure in the MME | 8.2.0 | 8.3.0 | +| 2009-09 | CT#45 | CP-090674 | 0024 | 1 | Support multiple SCTP associations | 8.2.0 | 8.3.0 | +| 2009-09 | CT#45 | CP-090674 | 0025 | | Port number and payload protocol identifier for SGsAP | 8.2.0 | 8.3.0 | +| 2009-09 | CT#45 | CP-090674 | 0026 | | The usage of timer Ns12 | 8.2.0 | 8.3.0 | +| 2009-09 | CT#45 | CP-090674 | 0027 | | Corrections for the length of IE | 8.2.0 | 8.3.0 | +| 2009-09 | CT#45 | CP-090674 | 0028 | 2 | Clarification of Location Update | 8.2.0 | 8.3.0 | +| 2009-09 | CT#45 | CP-090675 | 0029 | 2 | Update for 'SMS-only' behaviour | 8.2.0 | 8.3.0 | +| 2009-09 | CT#45 | CP-090674 | 0031 | 2 | Clarify the condition for starting the location update for non-EPS services procedure | 8.2.0 | 8.3.0 | +| 2009-09 | CT#45 | CP-090675 | 0033 | 1 | SMS over SGs charging and authority enquiry parameters | 8.2.0 | 8.3.0 | +| 2009-09 | CT#46 | CP-090916 | 0036 | 1 | Paging procedure in MME for supporting SMS only | 8.3.0 | 8.4.0 | +| 2009-09 | CT#46 | CP-090916 | 0037 | 1 | Location update initiation for SMS over SGs only | 8.3.0 | 8.4.0 | +| 2009-09 | CT#46 | CP-090915 | 0038 | 6 | Corrections for SGs Service Request | 8.3.0 | 8.4.0 | +| 2009-09 | CT#46 | CP-090916 | 0039 | 2 | Correction for Online and offline charging parameters | 8.3.0 | 8.4.0 | +| 2009-09 | CT#46 | CP-090915 | 0040 | 1 | Correction of definition of MME name | 8.3.0 | 8.4.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|--------------------------------------------------------------------------------------------------------------|--------|--------| +| 2009-09 | CT#46 | CP-090915 | 0041 | 1 | Implicit detach procedure in VLR correction | 8.3.0 | 8.4.0 | +| 2009-09 | CT#46 | CP-090916 | 0042 | | Remove use case of UE not supporting combined attach for 'SMS only' | 8.3.0 | 8.4.0 | +| 2009-09 | CT#46 | CP-090915 | 0043 | 1 | Handling of EPS detach indication | 8.3.0 | 8.4.0 | +| 2009-09 | CT#46 | CP-090915 | 0044 | | Correction of reference to TS 23.195 | 8.3.0 | 8.4.0 | +| 2009-09 | CT#46 | CP-090915 | 0046 | | MME executing the HSS location updating procedure and location update procedure for non-EPS services | 8.3.0 | 8.4.0 | +| 2009-09 | CT#46 | CP-090915 | 0047 | 1 | Correction of values of IMSI detach from EPS service type IE and IMSI detach from non-EPS service type IE | 8.3.0 | 8.4.0 | +| 2009-09 | CT#46 | CP-090922 | 0034 | 1 | Paging signalling optimization after MME failure | 8.4.0 | 9.0.0 | +| 2009-09 | CT#46 | CP-090922 | 0035 | 2 | Paging clarifications | 8.4.0 | 9.0.0 | +| 2009-09 | CT#46 | CP-090922 | 0048 | 1 | Add UE EMM Mode IE in SGsAP-SERVICE-REQUEST message | 8.4.0 | 9.0.0 | +| 2010-03 | CT#47 | CP-100126 | 0049 | 2 | MME Name octet length correction | 9.0.0 | 9.1.0 | +| 2010-03 | CT#47 | CP-100126 | 0052 | | Alignment term "CSFB and SMS over SGs" with TS23.401 (Part III) | 9.0.0 | 9.1.0 | +| 2010-03 | CT#47 | CP-100134 | 0053 | 2 | Modification of the paging procedure | 9.0.0 | 9.1.0 | +| 2010-03 | CT#47 | CP-100126 | 0056 | | Clarification of paging procedure for SMS | 9.0.0 | 9.1.0 | +| 2010-03 | CT#47 | CP-100126 | 0058 | 1 | Paging for SMS on S3 and no paging retransmission in the MME | 9.0.0 | 9.1.0 | +| 2010-06 | CT#48 | CP-100348 | 0065 | 2 | Alert MME Notification / UE Activity Notification procedure on S3 interface | 9.1.0 | 9.2.0 | +| 2010-06 | CT#48 | CP-100348 | 0069 | 3 | Paging Procedures in the MME for SMS Service Type | 9.1.0 | 9.2.0 | +| 2010-06 | CT#48 | CP-100348 | 0072 | | Removal of reference to TS 23.195 | 9.1.0 | 9.2.0 | +| 2010-06 | CT#48 | CP-100354 | 0074 | 1 | New LAI derivation at MME | 9.1.0 | 9.2.0 | +| 2010-06 | CT#48 | CP-100370 | 0066 | 2 | Message Name and Miscellaneous Editorial changes | 9.2.0 | 10.0.0 | +| 2010-06 | CT#48 | CP-100370 | 0073 | | Update to service request procedure | 9.2.0 | 10.0.0 | +| 2010-09 | CT#49 | CP-100518 | 0076 | 1 | Location Update Retry on LAIs of other RATs | 10.0.0 | 10.1.0 | +| 2010-09 | CT#49 | CP-100520 | 0081 | 4 | Add Timezone IE in Location Update Request | 10.0.0 | 10.1.0 | +| 2010-09 | CT#49 | CP-100518 | 0083 | 1 | MME Name | 10.0.0 | 10.1.0 | +| 2010-09 | CT#49 | CP-100501 | 0086 | 2 | Correction to LAI derivation for default SGs scenario | 10.0.0 | 10.1.0 | +| 2010-09 | CT#49 | CP-100518 | 0088 | 3 | Call cancellation for CSFB MT | 10.0.0 | 10.1.0 | +| 2010-09 | CT#49 | CP-100495 | 0091 | 1 | IMSI detach from EPS and Non-EPS services | 10.0.0 | 10.1.0 | +| 2010-09 | CT#49 | CP-100518 | 0098 | 2 | MME State Diagram Correction | 10.0.0 | 10.1.0 | +| 2010-09 | CT#49 | CP-100518 | 0102 | 2 | VLR Abnormal Case Handling for SMS-MO Call | 10.0.0 | 10.1.0 | +| 2010-09 | CT#49 | CP-100518 | 0103 | 2 | Data Restoration and SGs Association Recovery | 10.0.0 | 10.1.0 | +| 2010-09 | CT#49 | CP-100518 | 0105 | | Where to page for the UE for a mobile terminated CS call when no NAS signalling connection exists | 10.0.0 | 10.1.0 | +| 2010-09 | CT#49 | CP-100518 | 0106 | | SGsAP-SERVICE-REQUEST message is not sent when UE is in EMM-IDLE mode | 10.0.0 | 10.1.0 | +| 2010-09 | CT#49 | CP-100518 | 0111 | | Behavior of the recipient upon receipt of an erroneous SGsAP-Status message | 10.0.0 | 10.1.0 | +| 2010-09 | CT#49 | CP-100518 | 0112 | | Corrections related to use of location area identifier IE at MME upon receiving SGsAP-PAGING-REQUEST message | 10.0.0 | 10.1.0 | +| 2010-12 | CT#50 | CP-100763 | 0099 | 2 | VLR Failure Handling | 10.1.0 | 10.2.0 | +| 2010-12 | CT#50 | CP-100763 | 0100 | 2 | MME Failure Handling | 10.1.0 | 10.2.0 | +| 2010-12 | CT#50 | CP-100763 | 0107 | 2 | VLR name is not configured locally in the MME for SGsAP-Paging-Request | 10.1.0 | 10.2.0 | +| 2010-12 | CT#50 | CP-100763 | 0112 | 1 | Correction of use of release procedure | 10.1.0 | 10.2.0 | +| 2010-12 | CT#50 | CP-100763 | 0114 | 3 | CS PLMN determination for CSFB | 10.1.0 | 10.2.0 | +| 2010-12 | CT#50 | CP-100763 | 0117 | 1 | CS domain access rights check in CSFB | 10.1.0 | 10.2.0 | +| 2010-12 | CT#50 | CP-100740 | 0122 | 1 | Paging failure on SGs | 10.1.0 | 10.2.0 | +| 2010-12 | CT#50 | CP-100763 | 0123 | | Length indicator in SGsAP information elements | 10.1.0 | 10.2.0 | +| 2010-12 | CT#50 | CP-100763 | 0124 | 2 | Adding location area identity to SGs location update reject message | 10.1.0 | 10.2.0 | +| 2010-12 | CT#50 | CP-100763 | 0127 | 3 | DST, Universal time and local time zone handling at the MME | 10.1.0 | 10.2.0 | +| 2010-12 | CT#50 | CP-100763 | 0128 | 1 | Call Forwarding on No Reply Triggering in EMM-CONNECTED Mode | 10.1.0 | 10.2.0 | +| 2010-12 | CT#50 | CP-100740 | 0136 | | Removal of VLR number derivation by the MME | 10.1.0 | 10.2.0 | +| 2010-12 | CT#50 | CP-100763 | 0137 | 1 | Additional MME Abnormal Cases | 10.1.0 | 10.2.0 | +| 2010-12 | CT#50 | CP-100763 | 0142 | 1 | Removing unused stored parameters in the VLR | 10.1.0 | 10.2.0 | +| 2011-03 | CT#51 | CP-110197 | 0143 | | Requirement for inclusion of LCS client identity IE in SGsAP-PAGING-REQUEST message | 10.2.0 | 10.3.0 | +| 2011-03 | CT#51 | CP-110197 | 0144 | | Correction of handling of call forwarding | 10.2.0 | 10.3.0 | +| 2011-03 | CT#51 | CP-110197 | 0145 | 3 | Implicit detach handling for EPS and non-EPS services | 10.2.0 | 10.3.0 | +| 2011-03 | CT#51 | CP-110197 | 0148 | 1 | Explicit IMSI detach from EPS services triggered by PTAU reject | 10.2.0 | 10.3.0 | +| 2011-03 | CT#51 | CP-110197 | 0149 | 2 | Discarding LSA identity in MM INFORMATION REQUEST message | 10.2.0 | 10.3.0 | +| 2011-03 | CT#51 | CP-110189 | 0150 | 2 | Clarification about usage of eMLPP priority IE in SGsAP-PAGING-REQUEST | 10.2.0 | 10.3.0 | +| 2011-03 | CT#51 | CP-110197 | 0151 | 1 | Implicit detach procedure in VLR when MME goes detached | 10.2.0 | 10.3.0 | +| 2011-03 | CT#51 | CP-110197 | 0153 | | Timer handling in detach response | 10.2.0 | 10.3.0 | +| 2011-03 | CT#51 | CP-110197 | 0154 | 1 | Location update trigger correction in SGs-ASSOCIATED state | 10.2.0 | 10.3.0 | +| 2011-03 | CT#51 | CP-110197 | 0155 | 1 | Paging accept in SGs NULL state at MME | 10.2.0 | 10.3.0 | +| 2011-03 | CT#51 | CP-110197 | 0156 | 2 | VLR behavior in SGs NULL state | 10.2.0 | 10.3.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|----------------------------------------------------------------------------------------------------------------------|--------|--------| +| 2011-06 | CT#52 | CP-110464 | 0158 | 2 | Correction on SGs UE unreachable handling | 10.3.0 | 10.4.0 | +| 2011-06 | CT#52 | CP-110464 | 0159 | 1 | UE Paging Initiation after SGs association has been established | 10.3.0 | 10.4.0 | +| 2011-06 | CT#52 | CP-110464 | 0160 | 1 | Detach handling for Implicit IMSI detach from non-EPS services | 10.3.0 | 10.4.0 | +| 2011-06 | CT#52 | CP-110457 | 0162 | 1 | Removal of CS PLMN reselection requirement for CSFB | 10.3.0 | 10.4.0 | +| 2011-06 | CT#52 | CP-110464 | 0163 | 1 | New Location Update Request during TMSI reallocation procedure | 10.3.0 | 10.4.0 | +| 2011-06 | CT#52 | CP-110464 | 0165 | 1 | Updating IMSI detach flag during explicit IMSI detach for non-EPS services | 10.3.0 | 10.4.0 | +| 2011-06 | CT#52 | CP-110464 | 0167 | 1 | SMS paging at MME failure | 10.3.0 | 10.4.0 | +| 2011-06 | CT#52 | CP-110464 | 0171 | | MME state diagram corrections | 10.3.0 | 10.4.0 | +| 2011-09 | CT#53 | CP-110682 | 0174 | 2 | MO SMS over SGs handling at VLR failure | 10.4.0 | 10.5.0 | +| 2011-09 | CT#53 | CP-110684 | 0175 | 2 | MT SMS over SGs handling at VLR failure | 10.4.0 | 10.5.0 | +| 2011-09 | CT#53 | CP-110682 | 0176 | 1 | Correction on detach in SGs-NULL state for non-EPS service | 10.4.0 | 10.5.0 | +| 2011-09 | CT#53 | CP-110694 | 0169 | 3 | Abnormal case for SGs location update procedure | 10.5.0 | 11.0.0 | +| 2011-09 | CT#53 | CP-110691 | 0179 | 1 | Inclusion of SS Code in SGs Paging for Network initiated CISS Procedure | 10.5.0 | 11.0.0 | +| 2011-09 | CT#53 | CP-110691 | 0182 | 2 | Overlapping with TS 24.301 scope | 10.5.0 | 11.0.0 | +| 2011-12 | CT#54 | CP-110886 | 0177 | 6 | Restoration of CS Services during long MME failure | 11.0.0 | 11.1.0 | +| 2011-12 | CT#54 | CP-110882 | 0180 | 4 | Asynchronous display of network name in CSFB deployment | 11.0.0 | 11.1.0 | +| 2011-12 | CT#54 | CP-110882 | 0181 | 1 | Correction to references | 11.0.0 | 11.1.0 | +| 2011-12 | CT#54 | CP-110888 | 0184 | 1 | Editorial corrections | 11.0.0 | 11.1.0 | +| 2011-12 | CT#54 | CP-110858 | 0193 | 1 | Inclusion of E-UTRAN location in SGs Location Update message | 11.0.0 | 11.1.0 | +| 2011-12 | CT#54 | CP-110874 | 0194 | 1 | Correction on trigger of EPS detach indication at the MME | 11.0.0 | 11.1.0 | +| 2011-12 | CT#54 | CP-110888 | 0198 | 2 | Correct the behaviors of the VLR during the implicit IMSI detach procedure | 11.0.0 | 11.1.0 | +| 2011-12 | CT#54 | CP-110942 | 0183 | 6 | Provide Subscriber Information handling for UE under LTE | 11.0.0 | 11.1.0 | +| 2012-03 | CT#55 | CP-120113 | 0186 | 6 | SGs paging handling in the VLR and the MME failure cases | 11.1.0 | 11.2.0 | +| 2012-06 | CT#56 | CP-120318 | 0203 | 3 | MME paging handling for "SMS Indicator" case | 11.2.0 | 11.3.0 | +| 2012-06 | CT#56 | CP-120293 | 0207 | 2 | Change to the detach message for implicit detach at MME | 11.2.0 | 11.3.0 | +| 2012-06 | CT#56 | CP-120293 | 0211 | 2 | Clarification of MME behaviour in receiving CS Paging when MRT has expired but IDT is running while ISR is activated | 11.2.0 | 11.3.0 | +| 2012-06 | CT#56 | CP-120309 | 0213 | 2 | SGs Support for MSC in Pool to avoid dual VLR registration | 11.2.0 | 11.3.0 | +| 2012-06 | CT#56 | CP-120318 | 0219 | 3 | Support of MAP signalling in the MME (via IWF) | 11.2.0 | 11.3.0 | +| 2012-06 | CT#56 | CP-120315 | 0201 | 6 | Support of SMS in MME for PS-only subscription | 11.2.0 | 11.3.0 | +| 2012-09 | CT#57 | CP-120572 | 0221 | 2 | Partial VLR failure or VLR restart with CSFB while ISR is activated | 11.3.0 | 11.4.0 | +| 2012-09 | CT#57 | CP-120594 | 0225 | 1 | Clarification of MME Name and VLR Name format | 11.3.0 | 11.4.0 | +| 2012-09 | CT#57 | CP-120594 | 0227 | 1 | Transitioning to SGs-NULL upon Attach | 11.3.0 | 11.4.0 | +| 2012-09 | CT#57 | CP-120584 | 0228 | 1 | Avoiding dual VLR registration for legacy UEs | 11.3.0 | 11.4.0 | +| 2012-09 | CT#57 | CP-120589 | 0222 | 2 | Additional condition for skipping VLR SGs registration | 11.3.0 | 11.4.0 | +| 2012-12 | CT#58 | CP-120807 | 0232 | 3 | Handling of VLR failure without restart | 11.4.0 | 11.5.0 | +| 2012-12 | CT#58 | CP-120803 | 0233 | 5 | SMS in MME registration indication from the HSS | 11.4.0 | 11.5.0 | +| 2012-12 | CT#58 | CP-120807 | 0234 | 2 | Configurations with multiple SCTP endpoints per MME/VLR pair | 11.4.0 | 11.5.0 | +| 2012-12 | CT#58 | CP-120807 | 0239 | 5 | FQDN coding in VLR name and MME name | 11.4.0 | 11.5.0 | +| 2012-12 | CT#58 | CP-120898 | 0230 | 7 | Selected PLMN in network sharing for CSFB | 11.4.0 | 11.5.0 | +| 2013-03 | CT#59 | CP-130108 | 0242 | | SGs Interface applicability in case of SMS in MME | 11.5.0 | 11.6.0 | +| 2013-03 | CT#59 | CP-130123 | 0246 | 2 | CS domain operator selection in GWCN | 11.5.0 | 11.6.0 | +| 2013-03 | CT#59 | CP-130134 | 0241 | 6 | MME handling of VLR Failure without restart | 11.6.0 | 12.0.0 | +| 2013-03 | CT#59 | CP-130125 | 0243 | 2 | Editorial change on reset indication | 11.6.0 | 12.0.0 | +| 2013-06 | CT#60 | CP-130255 | 0249 | 1 | Correction to Selected CS Domain Operator IE definition | 12.0.0 | 12.1.0 | +| 2013-06 | CT#60 | CP-130258 | 0256 | 1 | Clarification on the SGs-implicit IMSI detach | 12.0.0 | 12.1.0 | +| 2013-06 | CT#60 | CP-130239 | 0259 | 2 | Explicit IMSI detach trigger by the rejection of TAU procedure | 12.0.0 | 12.1.0 | +| 2013-06 | CT#60 | CP-130264 | 0264 | 3 | State transition in the MME without SGs signaling | 12.0.0 | 12.1.0 | +| 2013-06 | CT#60 | CP-130258 | 0265 | 3 | Paging response from GERAN/UTRAN during CSFB | 12.0.0 | 12.1.0 | +| 2013-06 | CT#60 | CP-130386 | 0266 | 3 | Implicit detach timer and implicit IMSI detach | 12.0.0 | 12.1.0 | +| 2013-06 | CT#60 | CP-130258 | 0267 | | Stop the timer Ts13 | 12.0.0 | 12.1.0 | +| 2013-06 | CT#60 | CP-130258 | 0268 | | Change VLR number to VLR name | 12.0.0 | 12.1.0 | +| 2013-06 | CT#60 | CP-130264 | 0269 | 4 | Cause Value Mapping Method for Contact without 2G/3G Roaming Agreement | 12.0.0 | 12.1.0 | +| 2013-06 | CT#60 | CP-130258 | 0270 | 3 | VLR handling when CSFB UE failing to access to UTRAN/GERAN | 12.0.0 | 12.1.0 | +| 2013-09 | CT#61 | CP-130505 | 0276 | | General description for UE fallback supervision procedure | 12.1.0 | 12.2.0 | +| 2013-09 | CT#61 | CP-130505 | 0277 | 2 | Re-paging for MT CSFB call at VLR | 12.1.0 | 12.2.0 | +| 2013-09 | CT#61 | CP-130505 | 0278 | 1 | MME handling when receiving paging at the SGs-NULL | 12.1.0 | 12.2.0 | +| 2013-09 | CT#61 | CP-130505 | 0279 | 2 | Handling the collision of call services | 12.1.0 | 12.2.0 | +| 2013-09 | CT#61 | CP-130505 | 0283 | 2 | CSFB supervision via timer Ts5/Ts14 and CFNRy/CRNRc handling | 12.1.0 | 12.2.0 | +| 2013-09 | CT#61 | CP-130510 | 0284 | 2 | Implicit IMSI detach triggering criteria | 12.1.0 | 12.2.0 | +| 2013-09 | CT#61 | CP-130498 | 0292 | 1 | Clarification on SS code used in the Paging message | 12.1.0 | 12.2.0 | +| 2013-09 | CT#61 | CP-130525 | 0296 | 2 | State of SGs association in the MME for emergency CSFB | 12.1.0 | 12.2.0 | +| 2013-09 | CT#61 | CP-130573 | 0290 | 4 | Handling of VLR failure without restart during MO-SMS procedure | 12.1.0 | 12.2.0 | +| 2013-12 | CT#62 | CP-130762 | 0301 | | Correction on reference of message type IE | 12.2.0 | 12.3.0 | +| 2013-12 | CT#62 | CP-130742 | 0303 | 5 | Addition of MO CSFB indication for return to last LTE PLMN | 12.2.0 | 12.3.0 | +| 2013-12 | CT#62 | CP-130754 | 0304 | 1 | Cleanup of SGs paging without LAI case | 12.2.0 | 12.3.0 | +| 2013-12 | CT#62 | CP-130745 | 0306 | 6 | UE paging after TMSI reallocation procedure abort | 12.2.0 | 12.3.0 | +| 2013-12 | CT#62 | CP-130739 | 0313 | 1 | Modification for paging with IMSI in MME for CSFB | 12.2.0 | 12.3.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|--------------------------------------------------------------------------------------------|--------|--------| +| 2013-12 | CT#62 | CP-130754 | 0315 | 2 | Paging identity usage after new Location Update Request during TMSI reallocation procedure | 12.2.0 | 12.3.0 | +| 2013-12 | CT#62 | CP-130754 | 0316 | | Trigger of the SGs service request procedure | 12.2.0 | 12.3.0 | +| 2014-03 | CT#63 | CP-140144 | 0314 | 3 | Collision of tracking area update and the MME initiated IMSI detach procedures | 12.3.0 | 12.4.0 | +| 2014-03 | CT#63 | CP-140141 | 0320 | | Clarification on Ts14 minimum value | 12.3.0 | 12.4.0 | +| 2014-03 | CT#63 | CP-140130 | 0326 | 1 | Response to SGs paging | 12.3.0 | 12.4.0 | +| 2014-06 | CT#64 | CP-140301 | 0329 | 1 | CSFB priority call handling in a network supporting Multimedia Priority Service | 12.4.0 | 12.5.0 | +| 2014-06 | CT#64 | CP-140309 | 0331 | | Return to last LTE PLMN indication for emergency calls | 12.4.0 | 12.5.0 | +| 2014-06 | CT#64 | CP-140331 | 0332 | 1 | Available old TMSI | 12.4.0 | 12.5.0 | +| 2014-06 | CT#64 | CP-140328 | 0336 | 2 | Release of SGs association in case of SRVCC | 12.4.0 | 12.5.0 | +| 2014-06 | CT#64 | CP-140304 | 0338 | 3 | Handling paging request for USSD when VoLTE call is ongoing | 12.4.0 | 12.5.0 | +| 2014-09 | CT#65 | CP-140661 | 0341 | 1 | Clarification on SCTP multi-homing support for SGsAP transport | 12.5.0 | 12.6.0 | +| 2014-12 | CT#66 | CP-140832 | 0343 | 3 | Service request in idle mode. | 12.6.0 | 12.7.0 | +| 2014-12 | CT#66 | CP-140832 | 0346 | 2 | SGs paging when NAS signalling connection is present | 12.6.0 | 12.7.0 | +| 2014-12 | CT#66 | CP-140832 | 0347 | | Removal of duplicated references TS 23.216 | 12.6.0 | 12.7.0 | +| 2014-12 | CT#66 | CP-140862 | 0342 | | Correction of faulty interface reference | 12.7.0 | 13.0.0 | +| 2014-12 | CT#66 | CP-140862 | 0344 | 1 | Correct MME's behaviour in VLR fails without restart | 12.7.0 | 13.0.0 | +| 2014-12 | CT#66 | CP-140858 | 0345 | 1 | Collision during paging procedure in A/lu mode | 12.7.0 | 13.0.0 | +| 2015-06 | CT#68 | CP-150329 | 0354 | | Correction on background color of text | 13.0.0 | 13.1.0 | +| 2015-09 | CT#69 | CP-150529 | 0355 | 3 | SGs state change without SGsAP signalling at the MME during PS HO | 13.1.0 | 13.2.0 | +| 2015-09 | CT#69 | CP-150529 | 0356 | | IMSI format correction | 13.1.0 | 13.2.0 | +| 2016-03 | CT#71 | CP-160072 | 0357 | 8 | UE temporarily unreachable due to eDRX | 13.2.0 | 13.3.0 | +| 2016-03 | CT#71 | CP-160082 | 0358 | | Alignment of paging for MT-SMS in case of ISR activated and VLR failure | 13.2.0 | 13.3.0 | + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|---------------------------------------------------------------------------------------------------|---------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2016-09 | CT#73 | CP-160492 | 0359 | 6 | B | Prioritized SM retransmission by the SMS SC when the UE becomes reachable | 13.4.0 | +| 2016-09 | CT#73 | CP-160492 | 0360 | 5 | B | MT SM transmission to a UE in eDRX within the SM-Delivery-Start-Time/Timer | 13.4.0 | +| 2016-09 | CT#73 | CP-160492 | 0361 | 5 | B | MT SM retransmission by the SMS GMSC to a UE in eDRX at the time requested in the Delivery Report | 13.4.0 | +| 2016-09 | CT#73 | CP-160492 | 0362 | 1 | F | Improve the MT SMS over SGs procedure in eDRX | 13.4.0 | +| 2016-12 | CT#74 | CP-160722 | 0363 | 3 | F | Enabling SMS over SGs for NB-IoT only UEs | 13.5.0 | +| 2017-03 | CT#75 | CP-170110 | 0365 | 3 | F | Failure case handling of SMS over SGs for NB-IoT only UEs | 13.6.0 | +| 2017-03 | CT#75 | CP-170111 | 0367 | | F | Correction on CR implementation for eDRX | 13.6.0 | +| 2017-03 | SA#75 | | | | | Upgrade to Rel-14 | 14.0.0 | +| 2017-06 | CT#76 | CP-171073 | 0369 | | F | MS Classmark 2 IE not provided at normal procedures | 14.1.0 | +| 2017-06 | CT#76 | CP-171073 | 0370 | 1 | F | Specification of TMSI handling in the MME at SMS via SGs using normal procedures | 14.1.0 | +| 2017-06 | CT#76 | CP-171073 | 0371 | | F | Extended NAS timer impact on TMSI reallocation supervision timer | 14.1.0 | +| 2017-09 | CT#77 | CP-172120 | 0372 | | C | Handling of timer expiry during extended service request procedure for MT CSFB | 15.0.0 | +| 2017-12 | CT#78 | CP-173054 | 0376 | | A | Missing IE Identifier coding assignments for eDRX | 15.1.0 | +| 2017-12 | CT#78 | CP-173079 | 0377 | 1 | B | Setting of priority transport value for priority services on the SGs Interface | 15.1.0 | +| 2018-03 | CT#79 | CP-180088 | 0378 | | F | IMEISV inclusion criteria correction for ICS | 15.2.0 | +| 2020-07 | SA#88e | - | - | - | | Update to Rel-16 version (MCC) | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29119/47e8c2042061e08a14e012472e9fdbaa_img.jpg b/marked/Rel-16/29_series/29119/47e8c2042061e08a14e012472e9fdbaa_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..bc783b25113d3ab38b0c7cdbe94bcdd08cf862d4 --- /dev/null +++ b/marked/Rel-16/29_series/29119/47e8c2042061e08a14e012472e9fdbaa_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:492b70eeb32c679e1e255391a3e7339c2c8c37c7c448f547ce44e251aea19a16 +size 49790 diff --git a/marked/Rel-16/29_series/29119/e1a0d046fbe7f28f5e93a47091851747_img.jpg b/marked/Rel-16/29_series/29119/e1a0d046fbe7f28f5e93a47091851747_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2a676c3be84c279e591dfc0f5dd11f9b5eefc2d3 --- /dev/null +++ b/marked/Rel-16/29_series/29119/e1a0d046fbe7f28f5e93a47091851747_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bd52192e2533189edc1569ccf9de7db5ddc11207f3a82d9a783e382d32b0142b +size 42293 diff --git a/marked/Rel-16/29_series/29119/raw.md b/marked/Rel-16/29_series/29119/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..d782174952606a5007dfa8d48b93e15253a2756a --- /dev/null +++ b/marked/Rel-16/29_series/29119/raw.md @@ -0,0 +1,312 @@ + + + + + + +# Contents + +Foreword .....4 + +1 Scope.....5 + +1.1 References .....5 + +2 Definitions and abbreviations .....5 + +2.1 Definitions.....5 + +2.2 Abbreviations .....6 + +3 General.....6 + +4 Transmission order and bit definitions.....7 + +5 GTP header .....7 + +6 GTP Message and Message Formats .....7 + +6.1 Signalling Message Formats .....7 + +6.2 Path Management messages.....8 + +6.3 Tunnel Management messages.....8 + +6.4 Location Management message .....9 + +6.5 Mobility Management messages.....9 + +6.6 Reliable delivery of signalling messages .....9 + +6.7 Information element .....10 + +7 Signalling Plane (GTP-C) .....10 + +8 GTP-U .....10 + +9 Path Protocol .....10 + +10 Error handling .....10 + +11 Inter-PLMN GTP communication over the Gp Interface .....10 + +12 IP, the networking technology used by GTP .....10 + +13 GTP parameters.....10 + +Annex A (informative): Change history.....11 + +# --- Foreword + +The present document has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 1 Scope + +The present document describes the signalling requirements and procedures used at network elements related to the GLR for GTP within the 3GPP system at the application level. + +The present document gives the description of the systems needed only in the network utilising GLR as the delta document against 3GPP TS 29.060. + +## 1.1 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. +- [1] 3GPP TS 23.060: "General Packet Radio Service (GPRS); Service description Stage2". +- [2] 3GPP TS 23.119: "Gateway Location Register (GLR) – stage2". +- [3] 3GPP TS 24.008: "Mobile radio interface layer 3 specification, Core Network Protocols – Stage 3". +- [4] 3GPP TS 29.002: "Mobile Application Part (MAP) specification". +- [5] 3GPP TS 29.060: "General Packet Radio Service (GPRS); GPRS Tunnelling Protocol (GTP) across the Gn and Gp Interface". + +# --- 2 Definitions and abbreviations + +## 2.1 Definitions + +For the purposes of the present document, the following terms and definitions apply. + +**Gateway Location Register:** this entity handles location management of roaming subscriber in visited network without involving HLR + +**Intermediate GSN:** this entity is used as serving GSN towards home network and relay some PDU notification messages between serving GSN and Gateway GSN + +**MM context:** information sets held in MS and GSNs for a GPRS subscriber related to mobility management (MM) + +**MM Context ID:** IMSI or equivalent for use in conjunction with Anonymous Access (please refer to section GTP Header) + +**Path:** UDP/IP path and TCP/IP path are examples of paths that may be used to multiplex GTP tunnels + +**Path Protocol:** path Protocol is the protocol(s) used as a bearer of GTP between GSNs + +**PDP:** packet Data Protocol (PDP) is a network protocol used by an external packet data network interfacing to GPRS + +**PDP Context:** information sets held in MS and GSNs for a PDP address + +- Signalling message:** GTP signalling messages are exchanged between GSN pairs in a path. The signalling messages are used to transfer GSN capability information between GSN pairs and to create, update and delete GTP tunnels +- T-PDU:** original packet, for example an IP datagram, from an MS or a network node in an external packet data network. A T-PDU is the payload that is tunnelled in the GTP tunnel +- Tunnel Endpoint Identifier (TEID):** this field unambiguously identifies a tunnel endpoint in the receiving GTP-U or GTP-C protocol entity. The receiving end side of a GTP tunnel locally assigns the TEID value the transmitting side has to use. The TEID values are exchanged between tunnel endpoints using GTP-C messages + +## 2.2 Abbreviations + +For the purposes of the present document, the following abbreviations apply: + +| | | +|--------|------------------------------| +| GGSN | Gateway GPRS support node | +| GLR | Gateway Location Register | +| GPRS | General Packet Radio Service | +| GTP | GPRS Tunnelling Protocol | +| IM_GSN | Intermediate GSN | +| IP | Internet Protocol | +| GLR | Gateway Location Register | +| SGSN | Serving GPRS support node | +| TEID | Tunnel Endpoint Identifier | +| UDP | User Datagram Protocol | + +# 3 General + +The present document defines the GPRS Tunnelling Protocol (GTP) specific to the network with the GLR, i.e. the protocol between IM\_GSN and other nodes (i.e. GGSN, SGSN and GTP-MAP protocol converting GSN). It includes only the GTP signalling but not data transfer procedures. + +The interface between IM\_GSN and GGSN is either intra-PLMN interface or inter-PLMN interface. + +![Figure 1: Logical Architecture for PS domain in the network with GLR. The diagram shows a network architecture with GLR, HLR, GTP-MAP Protocol Converting GSN, IM_GSN, SGSN, and GGSN. Solid lines represent Signalling and Data Transfer Interfaces, while dotted lines represent Signalling Interfaces.](47e8c2042061e08a14e012472e9fdbaa_img.jpg) + +``` + +graph TD + GLR[GLR] -.-> HLR[HLR] + GLR -.-> GTPMAP1[GTP-MAP Protocol Converting GSN] + GLR -.-> IM_GSN[IM_GSN] + HLR -.-> GTPMAP2[GTP-MAP Protocol Converting GSN] + HLR -.-> GGSN[GGSN] + GTPMAP1 -.-> IM_GSN + GTPMAP2 -.-> GGSN + IM_GSN --- SGSN[SGSN] + IM_GSN --- GGSN + SGSN --- GGSN + +``` + +Legend: + +- ..... Signalling Interface +- \_\_\_\_\_ Signalling and Data Transfer Interface + +Figure 1: Logical Architecture for PS domain in the network with GLR. The diagram shows a network architecture with GLR, HLR, GTP-MAP Protocol Converting GSN, IM\_GSN, SGSN, and GGSN. Solid lines represent Signalling and Data Transfer Interfaces, while dotted lines represent Signalling Interfaces. + +Figure 1: Logical Architecture for PS domain in the network with GLR + +The GTP protocol is implemented only by IM\_GSNs, SGSNs and GGSNs. No other systems need to be aware of GTP. GPRS MSs are connected to a SGSN without being aware of GTP. + +It is assumed that there will be a many-to-many relationship between IM\_GSNs, SGSNs and GGSNs. An IM\_GSN may provide service to many GGSNs. A SGSN may provide service to many IM\_GSNs and GGSNs. + +# 4 Transmission order and bit definitions + +Transmission order and bit definitions on the interface between the IM\_GSN and other nodes in the network with GLR are the same as that used in the network without the GLR, see 3GPP TS 29.060. + +# 5 GTP header + +The GTP header used on interface between the IM\_GSN and other nodes in the network with GLR is the same as that used in the network without the GLR, see 3GPP TS 29.060. + +# 6 GTP Message and Message Formats + +The only signalling plane exists between the IM\_GSN and other nodes (i.e. GGSN, SGSN and GTP-MAP protocol converting GSN). + +## 6.1 Signalling Message Formats + +GTP defines a set of signalling messages between two associated GSNs. The signalling messages to be used between the IM\_GSN and other nodes are defined in the table below. For the GTP signalling messages to be used on other interfaces see 3GPP TS 29.060. + +**Table 1: Signalling messages** + +| Message Type value (Decimal) | Signalling message | Reference | +|------------------------------|---------------------------------------------|--------------------------| +| 3 | Version Not Supported | 7.4.3 in 3GPP TS 29.060 | +| 27 | PDU Notification Request | 7.5.12 in 3GPP TS 29.060 | +| 28 | PDU Notification Response | 7.5.13 in 3GPP TS 29.060 | +| 29 | PDU Notification Reject Request | 7.5.14 in 3GPP TS 29.060 | +| 30 | PDU Notification Reject Response | 7.5.15 in 3GPP TS 29.060 | +| 32 | Send Routeing Information for GPRS Request | 7.6.1 in 3GPP TS 29.060 | +| 33 | Send Routeing Information for GPRS Response | 7.6.2 in 3GPP TS 29.060 | +| 34 | Failure Report Request | 7.6.3 in 3GPP TS 29.060 | +| 35 | Failure Report Response | 7.6.4 in 3GPP TS 29.060 | + +## 6.2 Path Management messages + +The messages, which are listed in following table, are used on the interface between the IM\_GSN and other nodes. For the definitions of these messages and other messages used on the other interfaces refer to the corresponding sections in 3GPP TS 29.060. + +| Messages | Sending node | Receiving node | +|-----------------------|--------------|----------------| +| Version Not Supported | IM_GSN | GGSN, SGSN | +| | GGSN, SGSN | IM_GSN | + +## 6.3 Tunnel Management messages + +In following table, only the messages used between the IM\_GSN and GGSN and between the IM\_GSN and SGSN are listed. For the definitions of these messages and other messages used on the other interfaces refer to the corresponding sections in 3GPP TS 29.060. + +| Messages | Sending node | Receiving node | +|----------------------------------|--------------|----------------| +| PDU Notification Request | GGSN | IM_GSN | +| | IM_GSN | SGSN | +| PDU Notification Response | SGSN | IM_GSN | +| | IM_GSN | GGSN | +| PDU Notification Reject Request | SGSN | IM_GSN | +| | IM_GSN | GGSN | +| PDU Notification Reject Response | GGSN | IM_GSN | +| | IM_GSN | SGSN | + +## 6.4 Location Management message + +In the network with the GLR, The optional Location Management messages are defined to support the case when Network-Requested PDP Context Activation procedures are used and an IM\_GSN does not have a SS7 MAP interface. GTP is then used to transfer signalling messages between the IM\_GSN and a GTP-MAP protocol-converting GSN in the GPRS backbone network. The GTP-MAP protocol-converting GSN converts the signalling messages described in this section between GTP and MAP. The MAP messages are sent to and received from the GLR. The GTP-MAP protocol-converting function is described in 3GPP TS 23.060. The MAP protocol describing the corresponding procedures and messages is described in 3GPP TS 29.002. This alternative method is illustrated in Figure 2. + +![Diagram illustrating IM_GSN - GLR Signalling via a GTP-MAP protocol-converter in a GSN. The diagram shows three main entities: IM_GSN, GSN (with GTP-MAP Interworking), and GLR. The IM_GSN has a protocol stack of GTP, UDP, IP, L2, and L1. The GSN has two stacks: one for GTP (GTP, UDP, IP, L2, L1) and one for MAP (MAP, TCAP, SCCP, MTP3, MTP2, L1). The GLR has a protocol stack of MAP, TCAP, SCCP, MTP3, MTP2, and L1. Arrows show the flow of messages from the IM_GSN through the GSN's GTP stack to its MAP stack, and then through the GLR's MAP stack.](e1a0d046fbe7f28f5e93a47091851747_img.jpg) + +The diagram illustrates the protocol stacks for IM\_GSN, GSN, and GLR. The IM\_GSN stack consists of GTP, UDP, IP, L2, and L1. The GSN is shown with two stacks: a GTP stack (GTP, UDP, IP, L2, L1) and a MAP stack (MAP, TCAP, SCCP, MTP3, MTP2, L1). The GLR stack consists of MAP, TCAP, SCCP, MTP3, MTP2, and L1. Arrows indicate the flow of signalling messages from the IM\_GSN through the GSN's GTP stack to its MAP stack, and then through the GLR's MAP stack. The GSN is labeled as 'GTP-MAP Interworking'. + +Diagram illustrating IM\_GSN - GLR Signalling via a GTP-MAP protocol-converter in a GSN. The diagram shows three main entities: IM\_GSN, GSN (with GTP-MAP Interworking), and GLR. The IM\_GSN has a protocol stack of GTP, UDP, IP, L2, and L1. The GSN has two stacks: one for GTP (GTP, UDP, IP, L2, L1) and one for MAP (MAP, TCAP, SCCP, MTP3, MTP2, L1). The GLR has a protocol stack of MAP, TCAP, SCCP, MTP3, MTP2, and L1. Arrows show the flow of messages from the IM\_GSN through the GSN's GTP stack to its MAP stack, and then through the GLR's MAP stack. + +Figure 2: IM\_GSN - GLR Signalling via a GTP-MAP protocol-converter in a GSN + +In following table, only the messages used between the IM\_GSN and The GTP-MAP protocol-converting GSN are listed. For the definitions of these messages and other messages used on the other interfaces refer to the corresponding sections in 3GPP TS 29.060. + +| Messages | Sending node | Receiving node | +|---------------------------------------------|-----------------------------|-----------------------------| +| Send Routeing Information for GPRS Request | IM_GSN | GTP-MAP protocol-converting | +| Send Routeing Information for GPRS Response | GTP-MAP protocol-converting | IM_GSN | +| Failure Report Request | IM_GSN | GTP-MAP protocol-converting | +| Failure Report Response | GTP-MAP protocol-converting | IM_GSN | + +## 6.5 Mobility Management messages + +The messages belonging to the mobility management messages are not used on the interface between the IM\_GSN and other nodes in the network with the GLR. + +## 6.6 Reliable delivery of signalling messages + +For the Reliability mechanism in the IM\_GSN, see section 7.8 in 3GPP TS 29.060. + +## 6.7 Information element + +The format of information elements in the message used on the interface between the IM\_GSN and other nodes in the network with GLR is the same as that in the network without the GLR. See 3GPP TS 29.060. + +# 7 Signalling Plane (GTP-C) + +The definition of signalling plane used in the network with the GLR is the same as that used in the network without the GLR, see in 3GPP TS 29.060. + +# 8 GTP-U + +GTP-U is not used on the interface between the IM\_GSN and other nodes. For the definition of GTP-U on the other interfaces, see in 3GPP TS 29.060. + +# 9 Path Protocol + +The Path Protocol on the interface between the IM\_GSN and other nodes in the network with the GLR is the same as that used in the network without the GLR. See 3GPP TS 29.060. + +# 10 Error handling + +The error handling on the interface between the IM\_GSN and other nodes is the same as that in the network without the GLR. See 3GPP TS 29.060. One exception is that the IM\_GSN doesn't have a Restart Counter because the IM\_GSN stores no PDP and MM context and therefore the synchronisation of the status of these with other GSNs is not needed. + +# --- 11 Inter-PLMN GTP communication over the Gp Interface + +Refer to the corresponding section in 3GPP TS 29.060. + +# --- 12 IP, the networking technology used by GTP + +Refer to the corresponding section in 3GPP TS 29.060. + +# --- 13 GTP parameters + +The definitions and directions for use of the parameters in GTP (inc. timer values or counter values and so on) on the interface between the IM\_GSN and other nodes is the same as that used in the network without the GLR. See 3GPP TS 29.060. + +# Annex A (informative): Change history + +| Document history | | | +|-------------------------|-----------|---------------------------------------------------------------------------------------------------------------------| +| V0.0.1 | Oct 1999 | The GTP protocol part is separated from MAP protocol part, and new specification related to GTP issue is generated. | +| V0.1.0 | Nov 1999 | For approval by N2#8 | +| V1.0.0 | Dec 1999 | For information and approval by TSG CN#6. | +| V1.0.1 | Jan 2000 | Only editorial modifications including some alignment with 29.060 | +| V2.0.0 | Mar 2000 | Submitted for approval to TSG CN#07 | +| V3.0.0 | Mar 2000 | Approved by TSG CN#07 | +| V4.0.0 | Mar 2001 | Approved by TSG CN#11 | +| V5.0.0 | Jun 2002 | Rel-5 created after CN#16 | +| V6.0.0 | Dec 2004 | Rel-6 created after CN#26 | +| V7.0.0 | June 2007 | Upgraded unchanged from Rel-6 after CT#36 | +| V8.0.0 | Dec 2008 | Upgraded unchanged from Rel-7 after CT#42 | +| V9.0.0 | Dec 2009 | Update to Rel-9 version (MCC) | +| V10.0.0 | Mar 2011 | Update to Rel-10 version (MCC) | +| V11.0.0 | Sep 2012 | Update to Rel-11 version (MCC) | +| V12.0.0 | Sep 2014 | Update to Rel-12 version (MCC) | +| V13.0.0 | Dec 2015 | Update to Rel-13 version (MCC) | +| V14.0.0 | Mar 2017 | Update to Rel-14 version (MCC) | +| V15.0.0 | Jun 2018 | Update to Rel-15 version (MCC) | +| V16.0.0 | July 2020 | Update to Rel-16 version (MCC) | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29120/00504fc688ebcf131ccbeff94dfc9939_img.jpg b/marked/Rel-16/29_series/29120/00504fc688ebcf131ccbeff94dfc9939_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9eebdb4a0ab2a9364b5dc2b06ad1eb9eb081568f --- /dev/null +++ b/marked/Rel-16/29_series/29120/00504fc688ebcf131ccbeff94dfc9939_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a4d7aed76c36e837e8a50eefdae7afeda569cf032c2158e0efe46e1e9d43279e +size 130135 diff --git a/marked/Rel-16/29_series/29120/036c200da9b64c3eb5aae2d67bb53e1f_img.jpg b/marked/Rel-16/29_series/29120/036c200da9b64c3eb5aae2d67bb53e1f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ae91fcce65531bba43c42d57eb33ba0e4f943b55 --- /dev/null +++ b/marked/Rel-16/29_series/29120/036c200da9b64c3eb5aae2d67bb53e1f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a915ae7ff5cc14385aae7af3d2717a34137afea42d25ad9a7f880e78f6ade067 +size 112096 diff --git a/marked/Rel-16/29_series/29120/05eb72d372e4bf78e3d6a64949d77bcc_img.jpg b/marked/Rel-16/29_series/29120/05eb72d372e4bf78e3d6a64949d77bcc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3027e6d88153b83ffe7847d325f6f1f921d7c57d --- /dev/null +++ b/marked/Rel-16/29_series/29120/05eb72d372e4bf78e3d6a64949d77bcc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:34baa9d10f52b97fa104d519801378bfea7fab8459f55d39da51a052eb561b91 +size 146654 diff --git a/marked/Rel-16/29_series/29120/0931f3e098bd4539041de11c50cec2d2_img.jpg b/marked/Rel-16/29_series/29120/0931f3e098bd4539041de11c50cec2d2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c4f79431ee2472bcafedd6bd7a62b2af0c1bfa6b --- /dev/null +++ b/marked/Rel-16/29_series/29120/0931f3e098bd4539041de11c50cec2d2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8d8fc6ce78e0838018b38987b873e31782061bc433a7be27f189bc38bbc95b70 +size 164897 diff --git a/marked/Rel-16/29_series/29120/0a73b03fba21af142d619a9a662e6490_img.jpg b/marked/Rel-16/29_series/29120/0a73b03fba21af142d619a9a662e6490_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..027329e2d20f5300844f66a5a0562e2f8016cf25 --- /dev/null +++ b/marked/Rel-16/29_series/29120/0a73b03fba21af142d619a9a662e6490_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:58f078ed0bb7771b2e9ecdff84e5eb1eeaa48e53e23fa0e005eb78ee41f8f3b4 +size 93354 diff --git a/marked/Rel-16/29_series/29120/0b998e3ad8f9d104768642612605cb35_img.jpg b/marked/Rel-16/29_series/29120/0b998e3ad8f9d104768642612605cb35_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..75ec750d5e661384cfcd28cfffb96619f9e352e0 --- /dev/null +++ b/marked/Rel-16/29_series/29120/0b998e3ad8f9d104768642612605cb35_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:134bd6984118e9ade6a1493db3be10f0e2e81006b9ec10ef7689ead4657b6f73 +size 129259 diff --git a/marked/Rel-16/29_series/29120/0f6e3cdce0f01d6ccceabcced508bb5b_img.jpg b/marked/Rel-16/29_series/29120/0f6e3cdce0f01d6ccceabcced508bb5b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d364c9a46aab3f9db6689bf623348fa6b4d2c86f --- /dev/null +++ b/marked/Rel-16/29_series/29120/0f6e3cdce0f01d6ccceabcced508bb5b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:869d0b1ca2dc7185dfdcf71bf6b31eb21e72e7cf998adf4b0b241ec5537f4823 +size 119975 diff --git a/marked/Rel-16/29_series/29120/11f18bf0233d812ad2604f88f3385d60_img.jpg b/marked/Rel-16/29_series/29120/11f18bf0233d812ad2604f88f3385d60_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..414e913dec8cb19cc1a0e5725ad7b2e761a37bf2 --- /dev/null +++ b/marked/Rel-16/29_series/29120/11f18bf0233d812ad2604f88f3385d60_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a95df66e18800adfd4fbb74f37519bf3aefa407933bada69dadfb50918a68723 +size 125487 diff --git a/marked/Rel-16/29_series/29120/17431d8b59408f09df7552d8bdbaa015_img.jpg b/marked/Rel-16/29_series/29120/17431d8b59408f09df7552d8bdbaa015_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..69c49aae82b59eb2faa9fe3a6d78662315da50e8 --- /dev/null +++ b/marked/Rel-16/29_series/29120/17431d8b59408f09df7552d8bdbaa015_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e0fb4a358ca7807811147fbc248782ff091c2ac0753b644299c89fdef2127405 +size 125596 diff --git a/marked/Rel-16/29_series/29120/18003425d0e8638dde4acc9c5c468c5c_img.jpg b/marked/Rel-16/29_series/29120/18003425d0e8638dde4acc9c5c468c5c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..64be219d4d75090b63a05098a8589768b2d2e86b --- /dev/null +++ b/marked/Rel-16/29_series/29120/18003425d0e8638dde4acc9c5c468c5c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f4dcea52cedf73dea7cef82e266b9de93e74e3a3682e2739007d8f673997caf4 +size 130088 diff --git a/marked/Rel-16/29_series/29120/18dbea0ac6b7ad13e47afda3ddd53b64_img.jpg b/marked/Rel-16/29_series/29120/18dbea0ac6b7ad13e47afda3ddd53b64_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..fbe19ac1e62044d52eedb6e25f475197213c045b --- /dev/null +++ b/marked/Rel-16/29_series/29120/18dbea0ac6b7ad13e47afda3ddd53b64_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2020cfd5279fe3a7efd4cd3ed14ccd724368a4838123a6ccce1e371c0af47b8c +size 51377 diff --git a/marked/Rel-16/29_series/29120/1cac1845cf99a3f64ae00cd2bb4f9ed7_img.jpg b/marked/Rel-16/29_series/29120/1cac1845cf99a3f64ae00cd2bb4f9ed7_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8f7e453f79b7dc956acd78c37bf956088839b771 --- /dev/null +++ b/marked/Rel-16/29_series/29120/1cac1845cf99a3f64ae00cd2bb4f9ed7_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:80cc65e99d570833671ddd365365ef69b4ca9a8121877501f6fe855388dae4fc +size 128874 diff --git a/marked/Rel-16/29_series/29120/1e5a58dcaf0936bf18dc3dd0d9cd43ff_img.jpg b/marked/Rel-16/29_series/29120/1e5a58dcaf0936bf18dc3dd0d9cd43ff_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4c9476050db5fe5476637dc9f2604fcd074d82cd --- /dev/null +++ b/marked/Rel-16/29_series/29120/1e5a58dcaf0936bf18dc3dd0d9cd43ff_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e68f6819ad731d9c7b7d994ed00871cc289776a2d3b9c8e6a5a8b3a55b9698bc +size 41673 diff --git a/marked/Rel-16/29_series/29120/223792b3652794024244c277cc46394b_img.jpg b/marked/Rel-16/29_series/29120/223792b3652794024244c277cc46394b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4d3a3aeef6ff62a9c924259dcb5a236682f2c9be --- /dev/null +++ b/marked/Rel-16/29_series/29120/223792b3652794024244c277cc46394b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d166f2bc5b25493d460dad3c0b58488b6dbfea7cdbe76217a1770b7eceb2025c +size 124724 diff --git a/marked/Rel-16/29_series/29120/245166735676c675f98f535bc4c6f0a1_img.jpg b/marked/Rel-16/29_series/29120/245166735676c675f98f535bc4c6f0a1_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ff45a68d5ce3abe5a3ccab9f856946b1f5901d19 --- /dev/null +++ b/marked/Rel-16/29_series/29120/245166735676c675f98f535bc4c6f0a1_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:32cbe9f0bc8ac54f40c724eb0b3cf1d21cb3dfc7cb0bea479d128191a38b5545 +size 157226 diff --git a/marked/Rel-16/29_series/29120/24ee23a8f3995ecfd3aae31a37a1d40c_img.jpg b/marked/Rel-16/29_series/29120/24ee23a8f3995ecfd3aae31a37a1d40c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..834d2c80adb21d383fd7e8d9eeab3b414ba569eb --- /dev/null +++ b/marked/Rel-16/29_series/29120/24ee23a8f3995ecfd3aae31a37a1d40c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8a0bfcd0e972f73bbeb91eac8d267954f16091a731b59a110802ccf4e253d307 +size 136861 diff --git a/marked/Rel-16/29_series/29120/28d75f39a24203712ee907b32cf0bbe5_img.jpg b/marked/Rel-16/29_series/29120/28d75f39a24203712ee907b32cf0bbe5_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d845c106c45fe5d5a7385fc088832be92aba681e --- /dev/null +++ b/marked/Rel-16/29_series/29120/28d75f39a24203712ee907b32cf0bbe5_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6c6f1a599d6f959448442f7001008ea534ff4afb28ad5badb9639d7cfbcbab33 +size 109279 diff --git a/marked/Rel-16/29_series/29120/2a476a0b3dbc3429436246db4784ff9f_img.jpg b/marked/Rel-16/29_series/29120/2a476a0b3dbc3429436246db4784ff9f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b5ff22befae5c2d7cd0e3d9f8ff0258eca6e9038 --- /dev/null +++ b/marked/Rel-16/29_series/29120/2a476a0b3dbc3429436246db4784ff9f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7ac7bbce4f46d9f6049ad231de208d4ddee311471c0dcecc692fb1110e5f1b5f +size 160571 diff --git a/marked/Rel-16/29_series/29120/329c96049bb432e9c2cbda4e224a0c9c_img.jpg b/marked/Rel-16/29_series/29120/329c96049bb432e9c2cbda4e224a0c9c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..38d280a98c3f3e580eb4c9a327788e9e1d9a77ae --- /dev/null +++ b/marked/Rel-16/29_series/29120/329c96049bb432e9c2cbda4e224a0c9c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:dc3171d7f94a711cb0bb8a290733f6078ffb7b2572ede752b84c942efe52b850 +size 140901 diff --git a/marked/Rel-16/29_series/29120/32ff77da4286b58c4778033acaa10836_img.jpg b/marked/Rel-16/29_series/29120/32ff77da4286b58c4778033acaa10836_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5518f8291018a88c3fba643068374d4c5dadd66a --- /dev/null +++ b/marked/Rel-16/29_series/29120/32ff77da4286b58c4778033acaa10836_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b82b208d860a81156ce3cd399570bc070c89bb94f9aedc0ff7c948d0a2ab6abc +size 137306 diff --git a/marked/Rel-16/29_series/29120/3334fcca5dac808f4fd3840aba35bc2e_img.jpg b/marked/Rel-16/29_series/29120/3334fcca5dac808f4fd3840aba35bc2e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ee17eb434a9fce700719ce65e29b5a1972cbce5d --- /dev/null +++ b/marked/Rel-16/29_series/29120/3334fcca5dac808f4fd3840aba35bc2e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8c4931bc5459221a9200f252608855aa6f3f1adc80e94ef9ce6c56346905a7ce +size 94326 diff --git a/marked/Rel-16/29_series/29120/3337af75dfee8af7687b4f49914d6c93_img.jpg b/marked/Rel-16/29_series/29120/3337af75dfee8af7687b4f49914d6c93_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..602527144f9bb48728df4291530908c7edf7e916 --- /dev/null +++ b/marked/Rel-16/29_series/29120/3337af75dfee8af7687b4f49914d6c93_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:200e7573d0acf2722b1ecb5b1b1c309ba74b4d2eb91f9ce07797ef96b7074f17 +size 107750 diff --git a/marked/Rel-16/29_series/29120/347010b7ac06d3ae97927fde0f784d7c_img.jpg b/marked/Rel-16/29_series/29120/347010b7ac06d3ae97927fde0f784d7c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a9dca1253e1486a62177f0e1395aab58926ac4c9 --- /dev/null +++ b/marked/Rel-16/29_series/29120/347010b7ac06d3ae97927fde0f784d7c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5c8eb24056e31ec43cc6beff9c764ea73abc1a0e4902761476908959de1db717 +size 116491 diff --git a/marked/Rel-16/29_series/29120/36fd537a1e39baa2471ecfaaf869751a_img.jpg b/marked/Rel-16/29_series/29120/36fd537a1e39baa2471ecfaaf869751a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a8a73bd773173286d2547124cc3355fa0f3d30ba --- /dev/null +++ b/marked/Rel-16/29_series/29120/36fd537a1e39baa2471ecfaaf869751a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cced0ff9e2e8caf5698c49b7a643b2c5a17635a4cf44e4fbb3a72d248e0abc19 +size 27778 diff --git a/marked/Rel-16/29_series/29120/3750b0149a6380885998ab3ca6a8787c_img.jpg b/marked/Rel-16/29_series/29120/3750b0149a6380885998ab3ca6a8787c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2f31e599155610cebee644b5faf65010a228a7cc --- /dev/null +++ b/marked/Rel-16/29_series/29120/3750b0149a6380885998ab3ca6a8787c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6c1f9949c66ffd95c5be63bc37444a7104270a487f9835bea0f7cdb21339d968 +size 39262 diff --git a/marked/Rel-16/29_series/29120/38d82ffe820e339811b396206f40a201_img.jpg b/marked/Rel-16/29_series/29120/38d82ffe820e339811b396206f40a201_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ca5d40641d6d95f6623ad422e82a1c2b03d350a3 --- /dev/null +++ b/marked/Rel-16/29_series/29120/38d82ffe820e339811b396206f40a201_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c11f5836acb3b1d29da401ecda008b53b61a6124bade14b4a8738f25413f8d2e +size 137097 diff --git a/marked/Rel-16/29_series/29120/3ec35c497a0765a1a885c85f214b1bef_img.jpg b/marked/Rel-16/29_series/29120/3ec35c497a0765a1a885c85f214b1bef_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1c8378d70ae24bf1abd8c0ff2b567d568b71f5b1 --- /dev/null +++ b/marked/Rel-16/29_series/29120/3ec35c497a0765a1a885c85f214b1bef_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e3467aec236fed04dc5a21e4cf84da8ea3d603f77230c3fd0ff6a3c2a866410f +size 157412 diff --git a/marked/Rel-16/29_series/29120/40b80ef077f6151a9fbb593b8ad4864d_img.jpg b/marked/Rel-16/29_series/29120/40b80ef077f6151a9fbb593b8ad4864d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e344837a74915bae0b6b9361a7d0403e06c8c546 --- /dev/null +++ b/marked/Rel-16/29_series/29120/40b80ef077f6151a9fbb593b8ad4864d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e3200ae06fba05d4890f28c84e93ebe43eae2e580668e38443912d15e75f20b6 +size 136640 diff --git a/marked/Rel-16/29_series/29120/4806f9f95fff13a30d6523bd6ffeac63_img.jpg b/marked/Rel-16/29_series/29120/4806f9f95fff13a30d6523bd6ffeac63_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..38bb5a789b34cc5eea364bea868d65865c16df9b --- /dev/null +++ b/marked/Rel-16/29_series/29120/4806f9f95fff13a30d6523bd6ffeac63_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9e6e49a06a2a26808ed80f34681c0b07cd57d8ecaba2bd789b51f917d47860e3 +size 132567 diff --git a/marked/Rel-16/29_series/29120/4847c98185bc52e8786b78738bc52b45_img.jpg b/marked/Rel-16/29_series/29120/4847c98185bc52e8786b78738bc52b45_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..04abdf142d6cefd3b2ba7a82d1a31f3d0d8c4ade --- /dev/null +++ b/marked/Rel-16/29_series/29120/4847c98185bc52e8786b78738bc52b45_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:64676a93de5a55a29afcc2759c980d78db715931783efde4d2827ac6e6d1b527 +size 99119 diff --git a/marked/Rel-16/29_series/29120/49fe8fe978c0f7e73112d231feb377eb_img.jpg b/marked/Rel-16/29_series/29120/49fe8fe978c0f7e73112d231feb377eb_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9d82c4ee2b074ab3d3769a8416e5324f3dbfc14c --- /dev/null +++ b/marked/Rel-16/29_series/29120/49fe8fe978c0f7e73112d231feb377eb_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2f75ea68133b3066a741d7c6bf943312739be25e5a0240af632a443ab78e3512 +size 129869 diff --git a/marked/Rel-16/29_series/29120/4b398c5e8c4fd656d5b7a61806400650_img.jpg b/marked/Rel-16/29_series/29120/4b398c5e8c4fd656d5b7a61806400650_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7c71460dfab62454eee64b96c598cad4b096b95d --- /dev/null +++ b/marked/Rel-16/29_series/29120/4b398c5e8c4fd656d5b7a61806400650_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:af6969a629b209cd3e22b3446bbc8adbc6d25d8c15bf37872eb27fdada0448a2 +size 151597 diff --git a/marked/Rel-16/29_series/29120/4c9ba399ca7df11cbe9b6322cd9aee0a_img.jpg b/marked/Rel-16/29_series/29120/4c9ba399ca7df11cbe9b6322cd9aee0a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..07492c3d82bc28992297da2006815c341486d287 --- /dev/null +++ b/marked/Rel-16/29_series/29120/4c9ba399ca7df11cbe9b6322cd9aee0a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3eac8d8a916d55ad40e991377f173f5b22b14f5f96b347ece0f23c546843b563 +size 42491 diff --git a/marked/Rel-16/29_series/29120/4ff00a489baaa34a0c01070de1d613db_img.jpg b/marked/Rel-16/29_series/29120/4ff00a489baaa34a0c01070de1d613db_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..be019540d4e0b99f356d2e9e545bcc2e5019a8c2 --- /dev/null +++ b/marked/Rel-16/29_series/29120/4ff00a489baaa34a0c01070de1d613db_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6907b5806658552b5e200d7e07306a379cef2cb3fbe5d99184c9a5c8b08c6335 +size 106712 diff --git a/marked/Rel-16/29_series/29120/50214d232017279410e9c9db8eb75119_img.jpg b/marked/Rel-16/29_series/29120/50214d232017279410e9c9db8eb75119_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4b1c0ffc9030dc42e9049db5649217cd6e8bafe6 --- /dev/null +++ b/marked/Rel-16/29_series/29120/50214d232017279410e9c9db8eb75119_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ac73305f409c1c13ce80542fddee862bad73ecf3429cbc94cbd887aa058400ed +size 42206 diff --git a/marked/Rel-16/29_series/29120/5478f70a6cef3e5672b2b22d28830cfb_img.jpg b/marked/Rel-16/29_series/29120/5478f70a6cef3e5672b2b22d28830cfb_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..cf12c9e47ae588f9414bc7b94db5864b23b12370 --- /dev/null +++ b/marked/Rel-16/29_series/29120/5478f70a6cef3e5672b2b22d28830cfb_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3f51055e743a705a54414038d1c7933f9b0012f33e91f6bd3adb000b2462096e +size 106426 diff --git a/marked/Rel-16/29_series/29120/56a5265d174ce056c1dbe5e7a60839fc_img.jpg b/marked/Rel-16/29_series/29120/56a5265d174ce056c1dbe5e7a60839fc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b72c95ea5aae5a7102bc9a58dc5f7294880079b8 --- /dev/null +++ b/marked/Rel-16/29_series/29120/56a5265d174ce056c1dbe5e7a60839fc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3d17097c3cf319611a951aef964b2f5883152b828f6b7c785e03af64b8c0d1e7 +size 133338 diff --git a/marked/Rel-16/29_series/29120/5801c19431e76330430e92a598cc7a16_img.jpg b/marked/Rel-16/29_series/29120/5801c19431e76330430e92a598cc7a16_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1265ec396bfc717c23dda8be2603ef33398df6d1 --- /dev/null +++ b/marked/Rel-16/29_series/29120/5801c19431e76330430e92a598cc7a16_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ea677e84e38b915de0bab9d6bf624d0f591b36b9e49dc3eda86bf2ced05998eb +size 115712 diff --git a/marked/Rel-16/29_series/29120/5cf80bac69830ea773ac17c87e0ae24d_img.jpg b/marked/Rel-16/29_series/29120/5cf80bac69830ea773ac17c87e0ae24d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b989561d95d8bac5112e806e86852f03fa1ed4b1 --- /dev/null +++ b/marked/Rel-16/29_series/29120/5cf80bac69830ea773ac17c87e0ae24d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3e9ea1783c156742c064c7130392ef8a6ae5f18c780067b88bba7864e401f172 +size 42160 diff --git a/marked/Rel-16/29_series/29120/5e9af8986a5845504f251d3079da8078_img.jpg b/marked/Rel-16/29_series/29120/5e9af8986a5845504f251d3079da8078_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..16cab59b17b918d6c691e5bf56b2c34a40bf4a09 --- /dev/null +++ b/marked/Rel-16/29_series/29120/5e9af8986a5845504f251d3079da8078_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0a1d34d319f935be3e73df6545344d603454395bf55b5123526cb3522dd3dfc9 +size 130879 diff --git a/marked/Rel-16/29_series/29120/61a7f401eb46fe99a71f27bc37493f04_img.jpg b/marked/Rel-16/29_series/29120/61a7f401eb46fe99a71f27bc37493f04_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..955a7b77cdbb0c67db75d6339d03df84d48967df --- /dev/null +++ b/marked/Rel-16/29_series/29120/61a7f401eb46fe99a71f27bc37493f04_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3097d74c6928eb066310aae3798fe19e140c67f1e3c72f0f9bf826b9f5d7bd6c +size 23493 diff --git a/marked/Rel-16/29_series/29120/61b2e15aedbb8a8dffc5426c0a284eb1_img.jpg b/marked/Rel-16/29_series/29120/61b2e15aedbb8a8dffc5426c0a284eb1_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..327a097734e309e0b63a245b4247fc538d994bf4 --- /dev/null +++ b/marked/Rel-16/29_series/29120/61b2e15aedbb8a8dffc5426c0a284eb1_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b22a9be417c4c83d83a1f16c5ad67f156b395855197cecddb3e37c68357737e3 +size 115713 diff --git a/marked/Rel-16/29_series/29120/6629e8a87e7552e2454b7c3e9f6d73a0_img.jpg b/marked/Rel-16/29_series/29120/6629e8a87e7552e2454b7c3e9f6d73a0_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6d04575888db6c8bb7bea093820c5732b0b9b1e1 --- /dev/null +++ b/marked/Rel-16/29_series/29120/6629e8a87e7552e2454b7c3e9f6d73a0_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:03bb68d922f9ac71ae7de302ffb6b2f7a4d40f66195f9c034584549e667fb8d3 +size 96479 diff --git a/marked/Rel-16/29_series/29120/67d03c9e89620d73e3786c869e559752_img.jpg b/marked/Rel-16/29_series/29120/67d03c9e89620d73e3786c869e559752_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6b4f2aa78711f94eef39737ad4daed709e806bf6 --- /dev/null +++ b/marked/Rel-16/29_series/29120/67d03c9e89620d73e3786c869e559752_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:deb614029f9e8cf45260631cfbfeb0b7c220a89c03ca59af8653da3be885ae90 +size 127169 diff --git a/marked/Rel-16/29_series/29120/684f7a2cd4ba3346bcaec1f7336f6aa3_img.jpg b/marked/Rel-16/29_series/29120/684f7a2cd4ba3346bcaec1f7336f6aa3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..afbfd705067e211119caac60ab4171f3be6b77e5 --- /dev/null +++ b/marked/Rel-16/29_series/29120/684f7a2cd4ba3346bcaec1f7336f6aa3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:921ab083ed28475145a1d58c971543db0d583b8122ba9a825317b7f8cc9e9280 +size 147127 diff --git a/marked/Rel-16/29_series/29120/68a5a1a1a761c652b4b4c56da7cf9914_img.jpg b/marked/Rel-16/29_series/29120/68a5a1a1a761c652b4b4c56da7cf9914_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8a2fbe0aa9243464c72ba692184a741718b6077d --- /dev/null +++ b/marked/Rel-16/29_series/29120/68a5a1a1a761c652b4b4c56da7cf9914_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c6648608f6848787a3826bd0776f267e1371e67c7708be523d06efa435224bb7 +size 102651 diff --git a/marked/Rel-16/29_series/29120/694df81535f89c7bfb9ef0df6f130dc0_img.jpg b/marked/Rel-16/29_series/29120/694df81535f89c7bfb9ef0df6f130dc0_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a9d20eeaabf908fa5301e5a209297291c748dfd1 --- /dev/null +++ b/marked/Rel-16/29_series/29120/694df81535f89c7bfb9ef0df6f130dc0_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9ff79f4d85a95324f07d6b6d14f2ba37894a5f465ff8e505710224c3e57502a6 +size 118115 diff --git a/marked/Rel-16/29_series/29120/69e5f1993021af230d08c08aac97d9df_img.jpg b/marked/Rel-16/29_series/29120/69e5f1993021af230d08c08aac97d9df_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3857de3a61ee31bab963a15122575f2f9405af7c --- /dev/null +++ b/marked/Rel-16/29_series/29120/69e5f1993021af230d08c08aac97d9df_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4927e8ef4aedb36367e073f4e6cbcf2d5f7fb0c07276829ce7c06f48bf9d0b94 +size 127352 diff --git a/marked/Rel-16/29_series/29120/6a993bfdf2e00cfad01c4d2188a75d86_img.jpg b/marked/Rel-16/29_series/29120/6a993bfdf2e00cfad01c4d2188a75d86_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..84bd2185178f155b925e09874497c3f9721e1180 --- /dev/null +++ b/marked/Rel-16/29_series/29120/6a993bfdf2e00cfad01c4d2188a75d86_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a5866c98cf2808cc38c348beccea6f9e6335ecba943010e76a1f006357be617b +size 121554 diff --git a/marked/Rel-16/29_series/29120/6e15fc9ea763541c5913d26f85072ae1_img.jpg b/marked/Rel-16/29_series/29120/6e15fc9ea763541c5913d26f85072ae1_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3e2e708622cce796530b6eac4d363a7e863f69c2 --- /dev/null +++ b/marked/Rel-16/29_series/29120/6e15fc9ea763541c5913d26f85072ae1_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c2ad8066fcf416b2ebe082348ce199bb1074cae3cc2c970f8060cdcd1d67f3a0 +size 172087 diff --git a/marked/Rel-16/29_series/29120/6e9d059430baba0c363e33749f68b107_img.jpg b/marked/Rel-16/29_series/29120/6e9d059430baba0c363e33749f68b107_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f10f630b0676eda6b41f1da3d13b20fa55ec0ae4 --- /dev/null +++ b/marked/Rel-16/29_series/29120/6e9d059430baba0c363e33749f68b107_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8645c3508eea86677644e43ece5c0d89018ed07b692e1086dd43d726a6a35a44 +size 136730 diff --git a/marked/Rel-16/29_series/29120/710ff83dc4a77abbe489fbf1a462845a_img.jpg b/marked/Rel-16/29_series/29120/710ff83dc4a77abbe489fbf1a462845a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a8635ba95e19f55098fd03376a1cb840317410b8 --- /dev/null +++ b/marked/Rel-16/29_series/29120/710ff83dc4a77abbe489fbf1a462845a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:531d0a6c6f6ccbd8f4dcb4df1c22cdb9b80c9c9bf3ce037caa8e8fc08c5f1252 +size 119298 diff --git a/marked/Rel-16/29_series/29120/719ef0f734259484038b2434e5dc3f24_img.jpg b/marked/Rel-16/29_series/29120/719ef0f734259484038b2434e5dc3f24_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3078bebfa5f82bf2044fad667d5cba537cc9e51e --- /dev/null +++ b/marked/Rel-16/29_series/29120/719ef0f734259484038b2434e5dc3f24_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3207684bd10a9aff09e9bdd0eae7df4b93fe2bfb5306ce923e38f6ca52491257 +size 122593 diff --git a/marked/Rel-16/29_series/29120/750b1652a4f4791b84c02aa755a1dedd_img.jpg b/marked/Rel-16/29_series/29120/750b1652a4f4791b84c02aa755a1dedd_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7ca71bed87db08d95aa4f29a1e29283d0ce4ce5c --- /dev/null +++ b/marked/Rel-16/29_series/29120/750b1652a4f4791b84c02aa755a1dedd_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f7b480c8cd636120a61c0570f109c9b6e67d9d5da2b1947cc71cc1e07e9dbc07 +size 137411 diff --git a/marked/Rel-16/29_series/29120/78ff716475b2f65bf01c3a4d02d89fc4_img.jpg b/marked/Rel-16/29_series/29120/78ff716475b2f65bf01c3a4d02d89fc4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c208c5d8e9a378f54c0b3ffaeefe8251e1559e94 --- /dev/null +++ b/marked/Rel-16/29_series/29120/78ff716475b2f65bf01c3a4d02d89fc4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:917f998ea3ed44df72db2b3581f182ef720cc8360cbeedc21ec9b697530cb2de +size 133379 diff --git a/marked/Rel-16/29_series/29120/7e61b2e2506cc7e5d6e16ce9c9df25bb_img.jpg b/marked/Rel-16/29_series/29120/7e61b2e2506cc7e5d6e16ce9c9df25bb_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..501360128c726a7cddb568dc3a193626caa18162 --- /dev/null +++ b/marked/Rel-16/29_series/29120/7e61b2e2506cc7e5d6e16ce9c9df25bb_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:774cb31ec925e13a3030e7783ac0ce20e5ef95528e2d200db6126fece170c517 +size 135774 diff --git a/marked/Rel-16/29_series/29120/7f16ae750ce9a533b0bd301dd986355e_img.jpg b/marked/Rel-16/29_series/29120/7f16ae750ce9a533b0bd301dd986355e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6b6140a1e8766cfd909d2e1cd341dec1b2eeab62 --- /dev/null +++ b/marked/Rel-16/29_series/29120/7f16ae750ce9a533b0bd301dd986355e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0be6dd91dba71b100937217e770bdc3daa77a83f5dc188750c99a2b258839642 +size 132542 diff --git a/marked/Rel-16/29_series/29120/8269648391c59363ea61243864a2adf7_img.jpg b/marked/Rel-16/29_series/29120/8269648391c59363ea61243864a2adf7_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..beabd49443c1fa0e57045a0ed3551ad5c045e71d --- /dev/null +++ b/marked/Rel-16/29_series/29120/8269648391c59363ea61243864a2adf7_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1322bd4f79f0db50ad822f44e1930bc034f3b350053352cc69bd51d52207cc53 +size 34835 diff --git a/marked/Rel-16/29_series/29120/85680f3dcbe15424dd54fa3fd9e1c90d_img.jpg b/marked/Rel-16/29_series/29120/85680f3dcbe15424dd54fa3fd9e1c90d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2f3a32e26f6c22cdedc66af46a412c58379838a2 --- /dev/null +++ b/marked/Rel-16/29_series/29120/85680f3dcbe15424dd54fa3fd9e1c90d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:14a735c929804329a6d13261daeb62fca6ad0532be64499023729bfd6909b433 +size 79140 diff --git a/marked/Rel-16/29_series/29120/884c44b6cb9fbe15347e0562a6085df2_img.jpg b/marked/Rel-16/29_series/29120/884c44b6cb9fbe15347e0562a6085df2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..718e2eb8296079b8f65bb9d51acbc932fd0b0e2e --- /dev/null +++ b/marked/Rel-16/29_series/29120/884c44b6cb9fbe15347e0562a6085df2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4ab5f6365703730244c30a773fb4cae36e84324a1cfb65b35ba2890b6d190c10 +size 122709 diff --git a/marked/Rel-16/29_series/29120/8aafdc3df2af4882f3c1b5e1e7e8dc8a_img.jpg b/marked/Rel-16/29_series/29120/8aafdc3df2af4882f3c1b5e1e7e8dc8a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0eb3e425431f54dda9eeda3cc5dee3f5b688ecb4 --- /dev/null +++ b/marked/Rel-16/29_series/29120/8aafdc3df2af4882f3c1b5e1e7e8dc8a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e14c21e0cd6336442ff01edfae12be7970ed93c01005cced296e0ee27c502449 +size 68980 diff --git a/marked/Rel-16/29_series/29120/8d66c9c295023a1380f9986d3663bb1e_img.jpg b/marked/Rel-16/29_series/29120/8d66c9c295023a1380f9986d3663bb1e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e9b74f2ab9dcaca81116c01b7d151ab6fd9e6229 --- /dev/null +++ b/marked/Rel-16/29_series/29120/8d66c9c295023a1380f9986d3663bb1e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a82a4ab59072f0a717b2001dfd00c6af1edd974e431626e25e4719fe79e2de60 +size 114472 diff --git a/marked/Rel-16/29_series/29120/8faeb7db381e28ab1ba06e9f48c19c6e_img.jpg b/marked/Rel-16/29_series/29120/8faeb7db381e28ab1ba06e9f48c19c6e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6cc4d91782e2e334244a345ed9060fba645e1a50 --- /dev/null +++ b/marked/Rel-16/29_series/29120/8faeb7db381e28ab1ba06e9f48c19c6e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:059683ade1bcb33cc92e14ca23d4cc76d9fb2e2561e3d3377e211b5b1b7a54c0 +size 134657 diff --git a/marked/Rel-16/29_series/29120/921f8fa0f7ce2c9956f20d33162c13a2_img.jpg b/marked/Rel-16/29_series/29120/921f8fa0f7ce2c9956f20d33162c13a2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4a052d177f5543cb00b9d6445f8d645809f37ba0 --- /dev/null +++ b/marked/Rel-16/29_series/29120/921f8fa0f7ce2c9956f20d33162c13a2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fa73a13435de89f70d4e90be28ff514d43d92d881925fab476a7fd0ef30d9010 +size 81450 diff --git a/marked/Rel-16/29_series/29120/92724c769da9d46b730fde1a6dccb023_img.jpg b/marked/Rel-16/29_series/29120/92724c769da9d46b730fde1a6dccb023_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7d70b8bebf7da5f31708a6544c0d9ecca9f8d09c --- /dev/null +++ b/marked/Rel-16/29_series/29120/92724c769da9d46b730fde1a6dccb023_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a1458ce16612c1c674401b67c1221051197f69d6cfe163a1edaafdd35acf319b +size 136516 diff --git a/marked/Rel-16/29_series/29120/93699fb71e95b4df5a3871fdcf818982_img.jpg b/marked/Rel-16/29_series/29120/93699fb71e95b4df5a3871fdcf818982_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..06a138ace49719580279af743ae63544c9e0305d --- /dev/null +++ b/marked/Rel-16/29_series/29120/93699fb71e95b4df5a3871fdcf818982_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0b450e26f25223b4d4923a5615208143e206d45e2a896f599ea553bd1034e30d +size 79537 diff --git a/marked/Rel-16/29_series/29120/93bd00a00fa28558486f0664550699b1_img.jpg b/marked/Rel-16/29_series/29120/93bd00a00fa28558486f0664550699b1_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a7be711bb83acb325fdeedcf481997b7f15b7f5e --- /dev/null +++ b/marked/Rel-16/29_series/29120/93bd00a00fa28558486f0664550699b1_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:088f4a4a73381652678626b31eebf484c79e3bc0456dc4ca51f5cde8a83f6a1e +size 125406 diff --git a/marked/Rel-16/29_series/29120/9b1ec0090070bdf52ea28763b8d52477_img.jpg b/marked/Rel-16/29_series/29120/9b1ec0090070bdf52ea28763b8d52477_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..eccc50207d9c1ee2fa35ce4a7dc57cc2f67b7ed8 --- /dev/null +++ b/marked/Rel-16/29_series/29120/9b1ec0090070bdf52ea28763b8d52477_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a44621ff251102929402b80e18a4aa76043f1b6a62ec9df879bb73b6539e7d66 +size 130896 diff --git a/marked/Rel-16/29_series/29120/9c45844d796e85ae05505870a54e4eb4_img.jpg b/marked/Rel-16/29_series/29120/9c45844d796e85ae05505870a54e4eb4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d229272dc0ae54294eab021f5b08836f4ca3f29b --- /dev/null +++ b/marked/Rel-16/29_series/29120/9c45844d796e85ae05505870a54e4eb4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bc69901c4b9a8af72b588e3ff82f20c336371e33876873fbf942e71c1f617e5f +size 139260 diff --git a/marked/Rel-16/29_series/29120/9cd6ff4a43174e4afe1cc5e4ea2fcae4_img.jpg b/marked/Rel-16/29_series/29120/9cd6ff4a43174e4afe1cc5e4ea2fcae4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2f6cfa28eb3baf63333012cac323b4808d16b471 --- /dev/null +++ b/marked/Rel-16/29_series/29120/9cd6ff4a43174e4afe1cc5e4ea2fcae4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:694b3cd81d6db739ccd52b13ab915c80994de4fe63c1b5828160976aa8c3892c +size 116761 diff --git a/marked/Rel-16/29_series/29120/a161a2bbb4d830e847ccb4f44b7e41a9_img.jpg b/marked/Rel-16/29_series/29120/a161a2bbb4d830e847ccb4f44b7e41a9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d990f88c6d0919686c83ed4b061adb32a7986cde --- /dev/null +++ b/marked/Rel-16/29_series/29120/a161a2bbb4d830e847ccb4f44b7e41a9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ef3f68d9c545781f86939fd3b9d2e0c855b8e0aadcd9ee123861864827c71ab2 +size 138095 diff --git a/marked/Rel-16/29_series/29120/a1b35c85c93d7a2e30d1feea2faac2e6_img.jpg b/marked/Rel-16/29_series/29120/a1b35c85c93d7a2e30d1feea2faac2e6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c925ec61c773c98da7e1400358bbef67325302b1 --- /dev/null +++ b/marked/Rel-16/29_series/29120/a1b35c85c93d7a2e30d1feea2faac2e6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7f2a57f73f5ac86eb58ae6ee46b5c9c095661a7fe6fff347049064017c967c2a +size 138186 diff --git a/marked/Rel-16/29_series/29120/a5404b7275b06497eecf9b5883604753_img.jpg b/marked/Rel-16/29_series/29120/a5404b7275b06497eecf9b5883604753_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a9105ce6b7f71dbacaf69b78e7d05fd3f5c2bb41 --- /dev/null +++ b/marked/Rel-16/29_series/29120/a5404b7275b06497eecf9b5883604753_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9a89a8e420b2d5a3776358f5a7b52593359614a2db3e7b38bc40f3ed97e219d3 +size 158860 diff --git a/marked/Rel-16/29_series/29120/a7450c80e88ad3f6ca1427ad84020998_img.jpg b/marked/Rel-16/29_series/29120/a7450c80e88ad3f6ca1427ad84020998_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..261102a3e6c95dcbf593306ead18411cdf5f0ef9 --- /dev/null +++ b/marked/Rel-16/29_series/29120/a7450c80e88ad3f6ca1427ad84020998_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b7664f20442b63c9a5c304de7da90210421c614fc04061aa21f28f4d97da8ca8 +size 111582 diff --git a/marked/Rel-16/29_series/29120/a963ca41bde1669b18a4b783616f228b_img.jpg b/marked/Rel-16/29_series/29120/a963ca41bde1669b18a4b783616f228b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..30493bff0f6ddbaec1c2ef7a8a970035128d9740 --- /dev/null +++ b/marked/Rel-16/29_series/29120/a963ca41bde1669b18a4b783616f228b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:dbab43ac7e8885155d790ac8aa0b9fcf0d53b8c3a9fac38712983d6d53c64566 +size 113115 diff --git a/marked/Rel-16/29_series/29120/ac42de838505beb048fb1267c46de428_img.jpg b/marked/Rel-16/29_series/29120/ac42de838505beb048fb1267c46de428_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..79c96766ba84b22f115be1343bd8cfbbe688082d --- /dev/null +++ b/marked/Rel-16/29_series/29120/ac42de838505beb048fb1267c46de428_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:59e1e2bd82fef86eb604fea6d731f9a97a7b2468cb15f3cc146f515d5de86fb2 +size 33093 diff --git a/marked/Rel-16/29_series/29120/aeb2a26a07219661191294dba528067a_img.jpg b/marked/Rel-16/29_series/29120/aeb2a26a07219661191294dba528067a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d32ff30acebe670705cab68cfb5e26c16604ba2b --- /dev/null +++ b/marked/Rel-16/29_series/29120/aeb2a26a07219661191294dba528067a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:366be45c5a7234111dea379c39af44fe95b71653c99da5a4391fdfe3acff2683 +size 133080 diff --git a/marked/Rel-16/29_series/29120/b0384c8e0ff826a8116ab2ff67dadc43_img.jpg b/marked/Rel-16/29_series/29120/b0384c8e0ff826a8116ab2ff67dadc43_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6248d5c6acb92829038702b6f7056dec09225438 --- /dev/null +++ b/marked/Rel-16/29_series/29120/b0384c8e0ff826a8116ab2ff67dadc43_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f0d1b5eda40e281c700470cb03ba5146dd2f58f0db39d61da441f3ea178bb117 +size 138391 diff --git a/marked/Rel-16/29_series/29120/b34c69e1ec326b01c3a485b27b1df5f6_img.jpg b/marked/Rel-16/29_series/29120/b34c69e1ec326b01c3a485b27b1df5f6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..35a0809dd993164d58b0d22c62c0940fd2508e89 --- /dev/null +++ b/marked/Rel-16/29_series/29120/b34c69e1ec326b01c3a485b27b1df5f6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7c27072f6f7d1ea2a90703784498568a506450af75772fa16c093eb728177d37 +size 97893 diff --git a/marked/Rel-16/29_series/29120/b55cd9b5721bd8aabc979c85316924e4_img.jpg b/marked/Rel-16/29_series/29120/b55cd9b5721bd8aabc979c85316924e4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ac573a68665029f974fb55cd359f8e9b8d76b89b --- /dev/null +++ b/marked/Rel-16/29_series/29120/b55cd9b5721bd8aabc979c85316924e4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d3972362a903fb0073a4be6587f3092f586081d3ae9692c00fc2926b8f8c8539 +size 129653 diff --git a/marked/Rel-16/29_series/29120/ba676d18b6a00f27c5bfaec9eeec20be_img.jpg b/marked/Rel-16/29_series/29120/ba676d18b6a00f27c5bfaec9eeec20be_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a238b7823da163d6166e1bf572e5480de9a85705 --- /dev/null +++ b/marked/Rel-16/29_series/29120/ba676d18b6a00f27c5bfaec9eeec20be_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d97aad669c5a61311d9d11fcf667e83d54e3495c46fb84d91218a039148e945d +size 136172 diff --git a/marked/Rel-16/29_series/29120/bdd96f20e71f079cad85240efb3d3f24_img.jpg b/marked/Rel-16/29_series/29120/bdd96f20e71f079cad85240efb3d3f24_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..63f1bb14b2e8ff9b8c806da5925cc2ddad4ca116 --- /dev/null +++ b/marked/Rel-16/29_series/29120/bdd96f20e71f079cad85240efb3d3f24_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d10af3a5cac9c8e4cfe10b66af34fe9de9b1f274f075893f31c510930fc7b2ae +size 20549 diff --git a/marked/Rel-16/29_series/29120/c21bad844b5cb6026c067a1f43ce67c3_img.jpg b/marked/Rel-16/29_series/29120/c21bad844b5cb6026c067a1f43ce67c3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..97c8493b34ac6f8eaa63251d16a948a614abe754 --- /dev/null +++ b/marked/Rel-16/29_series/29120/c21bad844b5cb6026c067a1f43ce67c3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a78ed0df13a595f351d91a2392608d0e128b7f4af2a6058bebc837838802552a +size 120272 diff --git a/marked/Rel-16/29_series/29120/c3fcdb9e14cb1f7e5e0232c5fe0c5198_img.jpg b/marked/Rel-16/29_series/29120/c3fcdb9e14cb1f7e5e0232c5fe0c5198_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5ffe955fc8d4c768a55814e1f8d1fa135b5e4620 --- /dev/null +++ b/marked/Rel-16/29_series/29120/c3fcdb9e14cb1f7e5e0232c5fe0c5198_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:16832c1389b248d4380f6e3d6c0a81c87a6e54d8f1c54aee565dadf159752216 +size 86184 diff --git a/marked/Rel-16/29_series/29120/c99bf3a0530a3e58f5f2d2790ba7441b_img.jpg b/marked/Rel-16/29_series/29120/c99bf3a0530a3e58f5f2d2790ba7441b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..090e4353412ad0e96f975e8858e0068ed8668ea2 --- /dev/null +++ b/marked/Rel-16/29_series/29120/c99bf3a0530a3e58f5f2d2790ba7441b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c5be62c1ff78000cac3c12703575bcc481312a49c6a8f0f349fbba58de770864 +size 164622 diff --git a/marked/Rel-16/29_series/29120/ca9fd3bd2fe73a46244dd1d017ffa3b5_img.jpg b/marked/Rel-16/29_series/29120/ca9fd3bd2fe73a46244dd1d017ffa3b5_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..20fb1779a31e6bbe27adcb2a9bfccd9d85e96c86 --- /dev/null +++ b/marked/Rel-16/29_series/29120/ca9fd3bd2fe73a46244dd1d017ffa3b5_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ce019bb11af30671a3fcd3bd1ae468e3e8b1779e6b4c6c6994c6d640de8836af +size 36737 diff --git a/marked/Rel-16/29_series/29120/d2417b04116c354deccb25d98a84a0fb_img.jpg b/marked/Rel-16/29_series/29120/d2417b04116c354deccb25d98a84a0fb_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..38f425574a3ee8743ff340ab85116071a7939b8c --- /dev/null +++ b/marked/Rel-16/29_series/29120/d2417b04116c354deccb25d98a84a0fb_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d54d0bd6dbf30279f7b6c3dbf632b29aa2432795e7386e7bf2a8da554ce26d4f +size 137649 diff --git a/marked/Rel-16/29_series/29120/da85343976fdbb19f866d9ddbdad0eae_img.jpg b/marked/Rel-16/29_series/29120/da85343976fdbb19f866d9ddbdad0eae_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..26117177e9ab72fe3f28e2d029d9b01e40b76a48 --- /dev/null +++ b/marked/Rel-16/29_series/29120/da85343976fdbb19f866d9ddbdad0eae_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4e6bd214df6b6846d329ec1fdcbcab5c5e6cb9482eafd3700916c38106af2e60 +size 116747 diff --git a/marked/Rel-16/29_series/29120/db39acbd11df5eb7e79ab84562fb8f74_img.jpg b/marked/Rel-16/29_series/29120/db39acbd11df5eb7e79ab84562fb8f74_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..904e39321f34670cf00184182fff4868f98a26e2 --- /dev/null +++ b/marked/Rel-16/29_series/29120/db39acbd11df5eb7e79ab84562fb8f74_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d9a8ccc9a71f5363eb3fd31ff755b54a177d1de2681c663d8460a942bacd0d80 +size 130199 diff --git a/marked/Rel-16/29_series/29120/dbd4bab54b57e8d1abf80e3de6471130_img.jpg b/marked/Rel-16/29_series/29120/dbd4bab54b57e8d1abf80e3de6471130_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a3fc555372699e1d29ffd5563b097bea37ca849e --- /dev/null +++ b/marked/Rel-16/29_series/29120/dbd4bab54b57e8d1abf80e3de6471130_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9fb56f9a07b90e7c909e57a127e6b596041a0746ee09b94722fd420f7145a03f +size 140183 diff --git a/marked/Rel-16/29_series/29120/dd5771673aececa53d42ece89218299d_img.jpg b/marked/Rel-16/29_series/29120/dd5771673aececa53d42ece89218299d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3e0a3110039c1ab0e5e7046246349fa14c9c4fe0 --- /dev/null +++ b/marked/Rel-16/29_series/29120/dd5771673aececa53d42ece89218299d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8c002ddbeaf84eef1240b7366b7d3bb8fa4395028c92b743cf4f7ac22a821e3a +size 128447 diff --git a/marked/Rel-16/29_series/29120/dd6c544ab685b25dd17f59456efcfbfc_img.jpg b/marked/Rel-16/29_series/29120/dd6c544ab685b25dd17f59456efcfbfc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..50d4d31cd8bc9ca06dc64b9833e025d5aa8287e3 --- /dev/null +++ b/marked/Rel-16/29_series/29120/dd6c544ab685b25dd17f59456efcfbfc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a4e61c1b02ceafb1fb848921b998ac1c97b84e589674f177d3d7452c274df6a7 +size 23918 diff --git a/marked/Rel-16/29_series/29120/e05b36c0d46549e681ce6581422c66b2_img.jpg b/marked/Rel-16/29_series/29120/e05b36c0d46549e681ce6581422c66b2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..cf96e7048d63e42a3138886d8e1254f324be737b --- /dev/null +++ b/marked/Rel-16/29_series/29120/e05b36c0d46549e681ce6581422c66b2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d900d38d8dfd41ded634213131e1f6f0b77ad2eb74a95faab1145a845d183cd1 +size 99545 diff --git a/marked/Rel-16/29_series/29120/e16bfa31d748f4d99ec4ae3d16656926_img.jpg b/marked/Rel-16/29_series/29120/e16bfa31d748f4d99ec4ae3d16656926_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5add40279febe4374c6fb5d72e458520be675c1d --- /dev/null +++ b/marked/Rel-16/29_series/29120/e16bfa31d748f4d99ec4ae3d16656926_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5c4afadf38dc4f20a5d3963e1840de611ce3bbcfbed8b17adf70e4d89adedb61 +size 158723 diff --git a/marked/Rel-16/29_series/29120/e180f2b5fcbe8001554a7c0677cd3f82_img.jpg b/marked/Rel-16/29_series/29120/e180f2b5fcbe8001554a7c0677cd3f82_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7053734bde3829535ea620ad9332024f6e39ddd2 --- /dev/null +++ b/marked/Rel-16/29_series/29120/e180f2b5fcbe8001554a7c0677cd3f82_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b4afee64f3ab93691030890b236908b51bd2d05ef1c1f0aa528cfe5dd9af953d +size 167778 diff --git a/marked/Rel-16/29_series/29120/e18841eb4a995df8354a793459e12fd0_img.jpg b/marked/Rel-16/29_series/29120/e18841eb4a995df8354a793459e12fd0_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e51d6ebe2da2fdc26af4bd252377d1f005a78f1b --- /dev/null +++ b/marked/Rel-16/29_series/29120/e18841eb4a995df8354a793459e12fd0_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3e20a58f37f0b3c1d7d074482df6591c8aefd94542d29cbb835b02b1f73d094d +size 118874 diff --git a/marked/Rel-16/29_series/29120/e2c120be98ede6deb60dd341f5a9803b_img.jpg b/marked/Rel-16/29_series/29120/e2c120be98ede6deb60dd341f5a9803b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..421ce86b4f7bceebba52311a60d208eded907ef3 --- /dev/null +++ b/marked/Rel-16/29_series/29120/e2c120be98ede6deb60dd341f5a9803b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:da809e34ce647b4ed60334e9c1ae306e22c0795d914380f46206fb59bfbdd3df +size 150660 diff --git a/marked/Rel-16/29_series/29120/e7010c66da16316c2935dfbbef5056b3_img.jpg b/marked/Rel-16/29_series/29120/e7010c66da16316c2935dfbbef5056b3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f741fb40fd41aaaef8e7da470d2dd0346eb796c4 --- /dev/null +++ b/marked/Rel-16/29_series/29120/e7010c66da16316c2935dfbbef5056b3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f1d91bf8dd1cacd17140d31eb25d417fd7b35550464691836533f8ac01c76dc3 +size 88325 diff --git a/marked/Rel-16/29_series/29120/e90987faabad6a6665cd8ed1151dc474_img.jpg b/marked/Rel-16/29_series/29120/e90987faabad6a6665cd8ed1151dc474_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..946c694c3719b3bcb2fdedc64e0bcafdf2c1be77 --- /dev/null +++ b/marked/Rel-16/29_series/29120/e90987faabad6a6665cd8ed1151dc474_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:798977f7c4f3a43a08e78e28a466c19c2bc30001b5378d7b820b588f5f4eb389 +size 141151 diff --git a/marked/Rel-16/29_series/29120/eabcb2f8b9acedb194571d5bc734b463_img.jpg b/marked/Rel-16/29_series/29120/eabcb2f8b9acedb194571d5bc734b463_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9266e4e51c3785cfa47edcd5522e89b018da510c --- /dev/null +++ b/marked/Rel-16/29_series/29120/eabcb2f8b9acedb194571d5bc734b463_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:52898721f2e188e73a4aa9c4cd2df4eccf05355a94c5cddf6e6f7fdfd23b0dcd +size 112550 diff --git a/marked/Rel-16/29_series/29120/eefcb3f73fb33cce57cd04109c81506f_img.jpg b/marked/Rel-16/29_series/29120/eefcb3f73fb33cce57cd04109c81506f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f16a2f60dd4648263c0c1ebafe7fbafe4cf60c93 --- /dev/null +++ b/marked/Rel-16/29_series/29120/eefcb3f73fb33cce57cd04109c81506f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1abeeeacf0a657044f8f70b889236eb9f7281c2a30d78826aaeb688d229c3dc8 +size 69136 diff --git a/marked/Rel-16/29_series/29120/ef45b00396c293be0b18d32b97118bf4_img.jpg b/marked/Rel-16/29_series/29120/ef45b00396c293be0b18d32b97118bf4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..67478a1fbd461e01c045edc841aad98a98d809b9 --- /dev/null +++ b/marked/Rel-16/29_series/29120/ef45b00396c293be0b18d32b97118bf4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a8c708a347d4c9df98c97d4b6cfdbd23f4a1af21ef8892d233cd424d043c084f +size 118901 diff --git a/marked/Rel-16/29_series/29120/f4e5a86da5c799372a7c1ea2397dedb7_img.jpg b/marked/Rel-16/29_series/29120/f4e5a86da5c799372a7c1ea2397dedb7_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3573d24c8d70383403718e8c8acaab0c12e28e7b --- /dev/null +++ b/marked/Rel-16/29_series/29120/f4e5a86da5c799372a7c1ea2397dedb7_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6117f9c60fc3c9534bbf16c7e16726700eab25107980654497890d2c14c5abc6 +size 129897 diff --git a/marked/Rel-16/29_series/29120/f61d0925551545b5938b3a4d1bbf63c3_img.jpg b/marked/Rel-16/29_series/29120/f61d0925551545b5938b3a4d1bbf63c3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2bb20bb2917ed50ade4021e7de0b45dc28a77a5c --- /dev/null +++ b/marked/Rel-16/29_series/29120/f61d0925551545b5938b3a4d1bbf63c3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:27852569af244cd842745d3487d91e525819d377d8aa3bf87a6fcf07534b1117 +size 126634 diff --git a/marked/Rel-16/29_series/29120/fc3e2b49a9f850951570e502393b697f_img.jpg b/marked/Rel-16/29_series/29120/fc3e2b49a9f850951570e502393b697f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..07614b3cc5899142309e03e55b532203a0a7f154 --- /dev/null +++ b/marked/Rel-16/29_series/29120/fc3e2b49a9f850951570e502393b697f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:21b19312d045aa3584cba5aa4ad60ff93f01107f23d5f401965dc5c122cf23c8 +size 116276 diff --git a/marked/Rel-16/29_series/29120/fd3cbb53e991f8209ba17b398f426e13_img.jpg b/marked/Rel-16/29_series/29120/fd3cbb53e991f8209ba17b398f426e13_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..dc5f5528e59cb1de4a40e7d2c1b578319a1d4d38 --- /dev/null +++ b/marked/Rel-16/29_series/29120/fd3cbb53e991f8209ba17b398f426e13_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5dac9d1bbc6f4d94a77d21c64c179871bc79e60ec490d783c979c25df41b6f47 +size 156081 diff --git a/marked/Rel-16/29_series/29120/fe7304192caf64cda93b580c5e7e5c06_img.jpg b/marked/Rel-16/29_series/29120/fe7304192caf64cda93b580c5e7e5c06_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4f814b8ddbec50a4ce5ddad7ec49d5c071bb6a9a --- /dev/null +++ b/marked/Rel-16/29_series/29120/fe7304192caf64cda93b580c5e7e5c06_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:745a461cae1d3f935a39c775787a6d433bdd0feac262758d468290cf0534db48 +size 85136 diff --git a/marked/Rel-16/29_series/29120/ffb6acd27b8e3a54392840948a75869f_img.jpg b/marked/Rel-16/29_series/29120/ffb6acd27b8e3a54392840948a75869f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2346c506f8885e5437741855ad33f3b03d650e3d --- /dev/null +++ b/marked/Rel-16/29_series/29120/ffb6acd27b8e3a54392840948a75869f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5cd9be571746fba6174e7c02960df18656db130c0db03d031f0d1566e6242d9a +size 21010 diff --git a/marked/Rel-16/29_series/29120/raw.md b/marked/Rel-16/29_series/29120/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..812f2f5a726c40fa7a3686fa7c29879318f34b95 --- /dev/null +++ b/marked/Rel-16/29_series/29120/raw.md @@ -0,0 +1,5796 @@ + + + + + + +# Contents + +| | | +|---------------------------------------------------------------------------------|----| +| Foreword ..... | 7 | +| 1 Scope..... | 8 | +| 2 References..... | 8 | +| 3 Abbreviations ..... | 8 | +| 4 The entities and interfaces within the mobile network utilising the GLR ..... | 9 | +| 4.1 The entities of the mobile system..... | 9 | +| 4.2 The Interfaces within the mobile services..... | 9 | +| 5 Overload and compatibility overview..... | 9 | +| 5.1 Overload control for MAP entities..... | 9 | +| 5.2 Compatibility..... | 9 | +| 6 Requirements concerning the use of SCCP and TC ..... | 10 | +| 6.1 Use of SCCP..... | 10 | +| 6.1.1 SCCP Class..... | 10 | +| 6.1.2 Sub-System Number (SSN)..... | 10 | +| 6.1.3 SCCP addressing ..... | 10 | +| 6.1.3.1 Introduction..... | 10 | +| 6.1.3.2 The Gateway Location Register (GLR) ..... | 10 | +| 6.1.3.2.1 Addressed by the VLR..... | 10 | +| 6.1.3.2.2 Addressed by the HLR..... | 10 | +| 6.1.3.2.3 Addressed by the GMSC..... | 11 | +| 6.1.3.2.4 Addressed by the IM-GSN..... | 11 | +| 6.1.3.3 The Intermediate MSC (IM_MSC)..... | 11 | +| 6.1.3.3.1 Addressed by the GMSC..... | 11 | +| 6.1.3.3.2 Addressed by the GMLC..... | 11 | +| 6.1.3.4 The Intermediate GSN (IM_GSN) ..... | 11 | +| 6.1.3.5 Summary table ..... | 11 | +| 6.2 Use of TC ..... | 12 | +| 7 General on MAP services ..... | 13 | +| 7.1 Common MAP services ..... | 13 | +| 7.1.1 MAP-U-ABORT service..... | 13 | +| 8 Mobility services..... | 14 | +| 8.1 General ..... | 14 | +| 8.2 Location Management services..... | 15 | +| 8.3 Authentication Management services ..... | 15 | +| 8.4 Subscriber management services ..... | 15 | +| 8.5 Fault recovery services..... | 16 | +| 8.6 Subscriber Information services..... | 16 | +| 9 Operation and maintenance services..... | 16 | +| 9.1 General ..... | 16 | +| 9.2 MAP_SEND_IMSI service ..... | 16 | +| 10 Call handling services ..... | 17 | +| 10.1 General ..... | 17 | +| 10.2 MAP_PROVIDE_ROAMING_NUMBER service ..... | 17 | +| 10.3 MAP_SET_REPORTING_STATE service..... | 17 | +| 10.4 MAP_STATUS_REPORT service ..... | 17 | +| 10.5 MAP_REMOTE_USER_FREE service ..... | 17 | +| 11 Supplementary services related services..... | 18 | +| 11.1 General ..... | 18 | +| 11.2 MAP_REGISTER_SS service ..... | 18 | +| 11.3 MAP_ERASE_SS service..... | 18 | +| 11.4 MAP_ACTIVATE_SS service ..... | 18 | +| 11.5 MAP_DEACTIVATE_SS service..... | 18 | + +| | | | +|----------|--------------------------------------------------------------|----| +| 11.6 | MAP_INTERROGATE_SS service ..... | 19 | +| 11.7 | MAP_REGISTER_PASSWORD service ..... | 19 | +| 11.8 | MAP_GET_PASSWORD service ..... | 19 | +| 11.9 | MAP_PROCESS_UNSTRUCTURED_SS_REQUEST service ..... | 19 | +| 11.10 | MAP_UNSTRUCTURED_SS_REQUEST service ..... | 20 | +| 11.11 | MAP_UNSTRUCTURED_SS_NOTIFY service ..... | 20 | +| 11.12 | MAP_REGISTER_CC_ENTRY service ..... | 20 | +| 11.13 | MAP_ERASE_CC_ENTRY service ..... | 20 | +| 12 | Short message service management services ..... | 20 | +| 12.1 | General ..... | 20 | +| 12.2 | MAP-READY-FOR-SM service ..... | 21 | +| 12.3 | MAP-MT-FORWARD-SHORT-MESSAGE service ..... | 21 | +| 13 | Network-Requested PDP Context Activation services ..... | 21 | +| 13.1 | General ..... | 21 | +| 13.2 | MAP_SEND_ROUTING_INFO_FOR_GPRS service ..... | 21 | +| 13.3 | MAP_FAILURE_REPORT service ..... | 22 | +| 14 | Void ..... | 22 | +| 15 | Element of procedure ..... | 22 | +| 15.1 | SDL descriptions ..... | 22 | +| 16 | Mapping onto TC services ..... | 23 | +| 17 | Abstract syntax of the MAP protocol ..... | 24 | +| 17.1 | General ..... | 24 | +| 17.2 | Packages specifications ..... | 24 | +| 17.3 | Application contexts ..... | 25 | +| 18 | General on MAP user procedure ..... | 26 | +| 19 | Mobility procedures ..... | 27 | +| 19.1 | Location management Procedures ..... | 27 | +| 19.1.1 | Location updating ..... | 29 | +| 19.1.1.1 | General ..... | 29 | +| 19.1.1.2 | Detailed procedure in the GLR ..... | 30 | +| 19.1.2 | Location Cancellation ..... | 43 | +| 19.1.2.1 | General ..... | 43 | +| 19.1.2.2 | Detailed procedure in the GLR ..... | 44 | +| 19.1.3 | Purge MS ..... | 49 | +| 19.1.3.1 | General ..... | 49 | +| 19.1.3.2 | Detailed procedure in GLR ..... | 49 | +| 19.2 | Fault recovery procedures ..... | 54 | +| 19.2.1 | RESET procedure ..... | 54 | +| 19.2.1.1 | HLR failure case ..... | 54 | +| 19.2.1.2 | GLR failure case ..... | 54 | +| 19.2.1.3 | Detailed procedure in GLR ..... | 54 | +| 19.2.2 | VLR restoration: the restore data procedure in the GLR ..... | 58 | +| 19.2.2.1 | General ..... | 58 | +| 19.2.2.2 | Detailed procedure in GLR ..... | 58 | +| 20 | Operations and maintenance procedures ..... | 65 | +| 20.1 | General ..... | 65 | +| 20.2 | Subscriber data management procedures ..... | 65 | +| 20.2.1 | General ..... | 65 | +| 20.2.2 | Procedures in the GLR ..... | 67 | +| 20.2.2.1 | Subscriber deletion procedure ..... | 67 | +| 20.2.2.2 | Subscriber data modification procedure ..... | 67 | +| 20.3 | Subscriber Identity procedure ..... | 77 | +| 20.3.1 | Subscriber identity procedure in the GLR ..... | 78 | +| 21 | Call handling procedures ..... | 81 | +| 21.1 | General ..... | 81 | + +| | | | +|---------|--------------------------------------------------------------------------|-----| +| 21.2 | Retrieval of routing information ..... | 82 | +| 21.2.1 | General ..... | 82 | +| 21.2.2 | Process in the GLR to provide a roaming number ..... | 83 | +| 21.2.3 | Process in the GLR to provide subscriber information ..... | 86 | +| 21.3 | Setting of Reporting State ..... | 89 | +| 21.3.1 | General ..... | 89 | +| 21.3.2 | Process in the GLR to set the reporting state ..... | 89 | +| 21.4 | Status Reporting ..... | 92 | +| 21.4.1 | General ..... | 92 | +| 21.4.2 | Process in the GLR for Status Reporting ..... | 92 | +| 21.5 | Remote User Free..... | 94 | +| 21.5.1 | General ..... | 94 | +| 21.5.2 | Process in the GLR for Remote User Free ..... | 95 | +| 22 | Supplementary services procedures..... | 98 | +| 22.1 | Functional supplementary service processes..... | 98 | +| 22.1.1 | Functional supplementary service process co-ordinator for GLR..... | 98 | +| 22.1.2 | Call completion supplementary service process co-ordinator for GLR ..... | 100 | +| 22.2 | Registration procedure ..... | 102 | +| 22.2.1 | General ..... | 102 | +| 22.2.2 | Procedures in the GLR ..... | 103 | +| 22.3 | Erasure procedure..... | 105 | +| 22.3.1 | General ..... | 105 | +| 22.3.2 | Procedures in the GLR ..... | 106 | +| 22.4 | Activation procedure..... | 106 | +| 22.4.1 | General ..... | 106 | +| 22.4.2 | Procedures in the GLR ..... | 106 | +| 22.5 | Deactivation procedure ..... | 108 | +| 22.5.1 | General ..... | 108 | +| 22.5.2 | Procedures in the GLR ..... | 109 | +| 22.6 | Interrogation procedure..... | 109 | +| 22.6.1 | General ..... | 109 | +| 22.6.2 | Procedures in the GLR ..... | 109 | +| 22.7 | Password registration procedure ..... | 109 | +| 22.7.1 | General ..... | 109 | +| 22.7.2 | Procedures in the GLR ..... | 109 | +| 22.8 | Mobile Initiated USSD procedure..... | 109 | +| 22.8.1 | Procedures in the GLR ..... | 109 | +| 22.9 | Network initiated USSD procedure..... | 112 | +| 22.9.1 | Procedure in the GLR..... | 112 | +| 22.10 | Common macros for clause 22..... | 116 | +| 22.10.1 | SS Password handling macros..... | 116 | +| 22.11 | Activation of a CCBS request..... | 118 | +| 22.11.1 | General ..... | 118 | +| 22.11.2 | Procedure in the GLR ..... | 118 | +| 22.12 | Deactivation of a CCBS request..... | 120 | +| 22.12.1 | General ..... | 120 | +| 22.12.2 | Procedure in the GLR..... | 121 | +| 23 | Short message service procedures..... | 124 | +| 23.1 | General ..... | 124 | +| 23.2 | The mobile terminated short message transfer procedure..... | 124 | +| 23.2.1 | Procedure in the Intermediate MSC ..... | 124 | +| 23.2.2 | Procedure in the GLR..... | 130 | +| 23.3 | The Short Message Alert procedure..... | 136 | +| 23.3.1 | Procedures in the GLR ..... | 137 | +| 24 | GPRS process description..... | 139 | +| 24.1 | General ..... | 139 | +| 24.2 | Send Routing Information procedure..... | 139 | +| 24.2.1 | Process in the GLR for Send Routing Information for GPRS..... | 139 | +| 24.2.2 | Process in the IM-GSN for Send Routing Information for GPRS ..... | 140 | +| 24.3 | Failure Report procedure..... | 143 | + +| | | | +|------------------------|----------------------------------------------------------------------------|-----| +| 24.3.1 | Process in the GLR for Failure Report ..... | 143 | +| 24.3.2 | Process in the IM-GSN for Failure Report..... | 144 | +| 25 | General macro description ..... | 147 | +| 25.1 | MAP open macros..... | 147 | +| 25.2 | Macros to check the content of indication and confirmation primitives..... | 147 | +| 25.3 | Authentication processes..... | 147 | +| 25.3.1 | Process Obtain_Authentication_Sets_GLR..... | 147 | +| 25.3.2 | Process Authentication_Failure_Report_GLR ..... | 149 | +| 25.4 | Short Message Alert procedures ..... | 151 | +| 25.4.1 | Subscriber_Present_GLR_AS_VLR process ..... | 151 | +| 25.4.2 | The Mobile Subscriber is present..... | 154 | +| Annex A (informative): | Change history..... | 156 | + +# --- Foreword + +This Technical Specification (TS) has been produced by the 3rd Generation Partnership Project (3GPP). + +The present document specifies the signalling requirements and procedures used at network elements related to the Gateway Location Register (GLR) for Mobile Application Part (MAP) within the 3GPP system. (i.e. the present document specifies the delta against 3GPP TS 29.002.) + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 1 Scope + +The present document describes the signalling requirements and procedures used at network elements related to the GLR for MAP within the 3GPP system at the application level. + +The present document gives the description of the systems needed only in the network utilising GLR as the delta document against 3GPP TS 29.002. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - For a non-specific reference, the latest version applies. +- [1] 3GPP TS 23.003: "Numbering, addressing and identification". +- [2] 3GPP TS 23.007: "Restoration procedures". +- [3] 3GPP TS 23.012: "Location registration procedures". +- [4] 3GPP TS 23.040: "Technical realization of the Short Message Service (SMS) Point to Point (PP)". +- [5] 3GPP TS 29.002: "Mobile Application Part (MAP) specification". +- [6] 3GPP TS 23.119: "Gateway Location Register (GLR) - stage2". + +# --- 3 Abbreviations + +For the purposes of the present document, the following abbreviations apply: + +| | | +|--------|---------------------------------------| +| CCBS | Completion of Call to Busy Subscriber | +| GLR | Gateway Location Register | +| GPRS | General Packet Radio Service | +| IM_GSN | Intermediate GSN | +| IM_MSC | Intermediate MSC | +| SGSN | Serving GPRS support node | +| GGSN | Gateway GPRS support node | + +# --- 4 The entities and interfaces within the mobile network utilising the GLR + +## 4.1 The entities of the mobile system + +The functional entities related to the GLR are described below. The description of each entity is detailed in 3GPP TS 23.119 (GLR stage2 specification). The other functional entities described in the present document (e.g. MSC, VLR, and HLR) are specified in 3GPP TS 29.002. + +- The Gateway location Register (GLR). +- The Intermediate MSC (IM-MSC). +- The Intermediate GSN (IM-GSN). + +## 4.2 The Interfaces within the mobile services + +The Interfaces related to the GLR are described below. The description of each interface is detailed in 3GPP TS 23.119 (GLR stage2 specification). + +- Interface between the HLR and the GLR. +- Interface between the VLR and the GLR. +- Interface between the MSC and the IM\_MSC. +- Interface between the SGSN and the GLR. +- Interface between the MSC and the GLR. +- Interface between the GLR and the IM\_GSN. + +# --- 5 Overload and compatibility overview + +## 5.1 Overload control for MAP entities + +The VLR and SGSN see the GLR as an HLR, and the HLR sees the GLR as a VLR or a SGSN. Therefore the GLR shall behave like mobile entity as which the GLR is regarded. If overload of the GLR is detected, the responder may ignore requests for certain MAP operations (see tables 5.1/1, 5.1/2 and 5.1/3 in 3GPP TS 29.002). The decision as to which MAP Operations may be ignored is made by the MAP service provider and is based upon the priority of the application context. + +## 5.2 Compatibility + +A version negotiation mechanism based on the use of an application-context-name is used to negotiate the protocol version used between two entities for supporting a MAP-user signalling procedure. The description of the version negotiation mechanism is detailed in 3GPP TS 29.002. + +# --- 6 Requirements concerning the use of SCCP and TC + +## 6.1 Use of SCCP + +The Mobile Application Part makes use of the services offered by the Signalling Connection Control Part of signalling System No. 7. CCITT Blue Book or ITU-T (03/93) Recommendations Q.711 to Q.716 should be consulted for the full specification of SCCP. In North America (World Zone 1) the national version of SCCP is used as specified in ANSI T1.112. + +### 6.1.1 SCCP Class + +MAP will only make use of the connectionless classes (0 or 1) of the SCCP. + +### 6.1.2 Sub-System Number (SSN) + +The Application Entities (AEs) defined for MAP consist of several Application Service Elements (ASEs) and are addressed by sub-system numbers (SSNs). The SSN for MAP are specified in 3GPP TS 23.003 [1]. The specific SSN is not needed for the GLR, IM\_MSC, and IM\_GSN. + +### 6.1.3 SCCP addressing + +#### 6.1.3.1 Introduction + +The format and coding of address parameters carried by SCCP are detailed in 3GPP TS 29.002. + +The following subclauses describe the method of SCCP addressing appropriate for each entity both for the simple intra-PLMN case and where an inter-PLMN communication is required. The following entities are considered for the GLR additionally: + +- the Gateway location Register (GLR); +- the Intermediate Mobile-services Switching Centre (IM\_MSC); +- the Intermediate GPRS Support Node (IM\_GSN). + +#### 6.1.3.2 The Gateway Location Register (GLR) + +##### 6.1.3.2.1 Addressed by the VLR + +In the network utilising the GLR, when an MS that belongs to other PLMN registers in a VLR/SGSN, the VLR/SGSN sees the GLR as the MS's HLR. When initiating the update location dialogues, the VLR is able to address the GLR based on the SPC of the GLR because of intra-PLMN signalling. And the VLR can address the GLR based on an E.214 Mobile Global Title originally derived by the VLR from the IMSI (when CCITT or ITU-T SCCP is used), or an E.212 number originally derived from IMSI (when ANSI SCCP is used, an IMSI). When answering with Global Title to the VLR, the GLR shall insert its E.164 address in the Calling Party Address of the SCCP message containing the first responding CONTINUE message. After that, the VLR can address the GLR based on an E.164 GLR address. + +##### 6.1.3.2.2 Addressed by the HLR + +When a location updating dialogue initiated by a GLR has been successfully completed, the HLR sees the GLR as the VLR. When initiating dialogues towards the VLR, the routing information used by the HLR is derived from the E.164 VLR number received as a parameter of the MAP message initiating the update location dialogue, but in reality the HLR addresses the GLR using the VLR number. + +##### 6.1.3.2.3 Addressed by the GMSC + +In the case that the MS is served by the SGSN in the network utilising the GLR, the GMSC sees the GLR as the SGSN. When the GMSC initiates dialogues towards the SGSN the SGSN (MAP) SSN (See 3GPP TS 23.003) shall be included in the called party address. The routing information used by the GMSC is derived from the E.164 SGSN number received as a parameter of the MAP message initiating the forward short message procedure. But in reality the GMSC addresses the GLR using the SGSN number. + +##### 6.1.3.2.4 Addressed by the IM-GSN + +In the network utilising the GLR, the IM-GSN initiates the GPRS location information retrieval to the GLR. The IM-GSN must have the value of the GLR address beforehand. + +#### 6.1.3.3 The Intermediate MSC (IM\_MSC) + +##### 6.1.3.3.1 Addressed by the GMSC + +When a short message for CS has to be routed to an MS, the GMSC addresses the MSC by an MSC identity received from the HLR that complies with E.164 rules. But in reality the GMSC addresses the IM-MSC in the network utilising the GLR. + +##### 6.1.3.3.2 Addressed by the GMLC + +When a location request for a particular MS needs to be sent to the MS's VMSC, the GMLC addresses the MSC using an E.164 address received from the MS's HLR. But in reality the GMLC addresses the IM-MSC in the network utilising the GLR. + +#### 6.1.3.4 The Intermediate GSN (IM\_GSN) + +The IM-GSN provides routing of the Network-Requested PDP Context activation. If a Network-Requested PDP Context activation fails, the GLR will alert the IM-GSN when the subscriber becomes reachable. The GLR will use the E.164 IM-GSN number received as parameter of the MAP message reporting the failure. + +#### 6.1.3.5 Summary table + +The following table summarises the SCCP address used for invoke operations. As a principle, within a PLMN either an SPC or a GT may be used (network operation option), whereas when addressing an entity outside the PLMN the GT must be used. The address type mentioned in the table (e.g. MSISDN) is used as GT or to derive the SPC. + +For a response, the originating address passed in the invoke message is used as SCCP Called Party Address. For extra-PLMN addressing the own E.164 entity address is used as SCCP Calling Party Address; for intra-PLMN addressing an SPC derived from the entity number may be used instead. When using an SPC, the SPC may be taken directly from MTP. + +Table 6.1.3/1 + +| to
from | fixed
net
work | HLR | VLR | MSC | SGSN | GGSN | GLR | IM-MSC | IM-
GSN | +|--------------------------------------------|----------------------|-----------------------------------------------------------------------------------------------|-------------------------------------|-----------------------------|--------------------------------------|-------|---------------------------------------------------------------------------------------------------------|-------------------------------------|------------| +| fixed
network | | | | | | | | | | +| home
location
register | | | | | | | I:SPC/GT
E:GT
T:VLR NUMBER | | | +| visitor
location
register | | | | | | | I:SPC/GT
E:GT
T:MGT
(outside World Zone
1)/MSISDN
(World Zone 1)/HLR
NUMBER
(note) | | | +| mobile-
services
switching
centre | | | | | | | E:GT
T:SGSN NUMBER | I:SPC/GT
E:GT
T:MSC
NUMBER | | +| Serving
GPRS
Support
Node | | | | | | | I:SPC/GT
T:MGT/MSISDN/HL
R NUMBER | | | +| Gateway
GPRS
Support
Node | | | | | | Note1 | | | | +| Gateway
Location
register | --- | E:GT
T:MGT
(outside
World
Zone1)/MSISDN(
World Zone1/)
HLR NUMBER
(note) | I:SPC/G
T
T:VLR
NUMBE
R | --- | I:SPC/G
T
T:SGSN
NUMBE
R | | | | | +| Intermedia
te-
MSC | --- | | | I:SPC/GT
T:MSC
NUMBER | | | | | | +| Intermedia
te-
GSN | --- | | | | | | I:SPC/GT
T:HLR
NUMBER | | | + +I: Intra-PLMN E: Extra (Inter)-PLMN T: Address Type + GT: Global Title MGT: E.214 Mobile Global Title SPC: Signalling Point Code + +NOTE 0: For initiating the location updating procedure and an authentication information retrieval from the HLR preceding it, the VLR has to derive the HLR address from the IMSI of the MS. The result can be an SPC or an E.214 Mobile Global Title if CCITT or ITU-T SCCP is used, or IMSI itself if ANSI SCCP is used (ANSI SCCP is used in World Zone 1). When continuing the established update location dialogue (as with any other dialogue) the VLR must derive the routing information towards the HLR from the Calling Party Address received with the first responding CONTINUE message until the dialogue terminating message is received. + +For transactions invoked by the VLR after update location completion, the VLR may derive the information for addressing the HLR from addresses received in the course of the update location procedure (MSISDN or HLR number) or from the IMSI. + +When invoking the Restore Data procedure and an authentication information retrieval from the HLR preceding it, the VLR must derive the information for addressing the HLR from the address information received in association with the roaming number request. This may be either the IMSI received as a parameter of the MAP message requesting the Roaming Number or the Calling Party Address associated with the MAP message requesting the Roaming Number. + +From VLR in, GLR as for T (address type) only HLR Number is used. VLR and HLR are because only the thing that is belonging to same PLMN is thought. + +NOTE1: The hatching part is the same part of 3GPP TS29.002. + +## 6.2 Use of TC + +Refer to the corresponding section in 3GPP TS 29.002. + +# 7 General on MAP services + +Refer to the corresponding section in 3GPP TS 29.002 with the exceptions described below. + +## 7.1 Common MAP services + +The following common services are used: + +- MAP-OPEN service; +- MAP-CLOSE service; +- MAP-DELIMITER service; +- MAP-U-ABORT service; +- MAP-P-ABORT service; +- MAP-NOTICE service; +- MAP-SECURE-TRANSPORT-CLASS-1 service; +- MAP-SECURE-TRANSPORT-CLASS-2 service; +- MAP-SECURE-TRANSPORT-CLASS-3 service; +- MAP-SECURE-TRANSPORT-CLASS-4 service. + +Replace the MAP-U-ABORT service as follows. + +### 7.1.1 MAP-U-ABORT service + +This service enables the service-user to request the MAP dialogue to be aborted. The service is an unconfirmed service with service-primitives as shown in table 7.1/1. MAP service-user in the GLR may set "application context not supported" as user reason. + +**Table 7.1/1: Service-primitives for the MAP-U-ABORT service** + +| Parameters | Request | Indication | +|------------------------|---------|------------| +| User reason | M | M(=) | +| Diagnostic information | U | C(=) | +| Specific information | U | C(=) | + +#### User reason: + +This parameter can take the following values: + +- resource limitation (congestion); +the requested user resource is unavailable due to congestion; +- resource unavailable; +the requested user resource is unavailable for reasons other than congestion; +- application procedure cancellation; +the procedure is cancelled for reason detailed in the diagnostic information parameter; +- application context not supported; +the requested application context is not supported; + +- procedure error; + +processing of the procedure is terminated for procedural reasons. + +#### Diagnostic information: + +This parameter may be used to give additional information for some of the values of the user-reason parameter: + +**Table 7.1/2: User reason and diagnostic information** + +| User reason | Diagnostic information | +|------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Resource limitation (congestion) | - | +| Resource unavailable | Short term/long term problem | +| Application procedure cancellation | Handover cancellation/
Radio Channel release/
Network path release/
Call release/
Associated procedure failure/
Tandem dialogue released/
Remote operations failure | +| Application context not supported | - | +| Procedure error | - | + +#### Specific information: + +This parameter may be used for passing any user specific information. Establishment and processing of the Specific information is not specified by GSM and shall be performed according to operator specific requirements. + +# 8 Mobility services + +## 8.1 General + +Regarding definition of each service, only the interval for adoption shall be considered for the GLR introduction. The interval for adoption for the GLR specification is described below. Service primitives and parameter definitions are as in 3GPP TS 29.002. + +## 8.2 Location Management services + +| Services | Interval for adoption | +|--------------------------|-----------------------| +| MAP_UPDATE_LOCATION | VLR – GLR | +| | GLR – HLR | +| MAP_CANCEL_LOCATION | HLR – GLR | +| | GLR – VLR | +| | GLR – SGSN | +| MAP_PURGE_MS | VLR – GLR | +| | SGSN – GLR | +| | GLR – HLR | +| MAP_UPDATE_GPRS_LOCATION | SGSN – GLR | +| | GLR – HLR | + +**Figure 8.2 /1** + +## 8.3 Authentication Management services + +| Services | Interval for adoption | +|---------------------------------------|-----------------------| +| MAP_SEND_AUTHENTICATION_IN
FO | VLR – GLR | +| | SGSN – GLR | +| | GLR – HLR | +| MAP_AUTHENTICATION_FAILURE
_REPORT | VLR – GLR | +| | SGSN – GLR | +| | GLR – HLR | + +Figure 8.3/1 + +## 8.4 Subscriber management services + +| Services | Interval for adoption | +|----------------------------|-----------------------| +| MAP_INSERT-SUBSCRIBER-DATA | HLR – GLR | +| | GLR – VLR | +| | GLR – SGSN | +| MAP-DELETE-SUBSCRIBER-DATA | HLR – GLR | +| | GLR – VLR | +| | GLR – SGSN | + +Figure 8.4/1 + +## 8.5 Fault recovery services + +| Services | Interval for adoption | +|-------------------------------------|-----------------------| +| MAP_RESET | HLR – GLR | +| | GLR – VLR | +| | GLR – SGSN | +| MAP_FORWARD_CHECK_SS_INDICA
TION | HLR – GLR | +| | GLR – VLR | +| MAP_RESTORE_DATA | VLR – GLR | + +Figure 8.5/1 + +## 8.6 Subscriber Information services + +| Services | Interval for adoption | +|-----------------------------|-----------------------| +| MAP-PROVIDE-SUBSCRIBER-Info | VLR – GLR | +| | GLR – HLR | + +Figure 8.6/1 + +# --- 9 Operation and maintenance services + +## 9.1 General + +Regarding definition of each service, only the interval for adoption shall be considered for the GLR introduction. The intervals for adoption for the GLR specification are described below. Service primitives and parameter definitions are as in 3GPP TS 29.002. + +## 9.2 MAP\_SEND\_IMSI service + +| Services | Interval for adoption | +|---------------|-----------------------| +| MAP_SEND_IMSI | HLR – GLR | +| | GLR – VLR | + +Figure 9.2/1 + +# --- 10 Call handling services + +## 10.1 General + +Regarding definition of each service, only the interval for adoption shall be considered for the GLR introduction. The intervals for adoption for the GLR specification are described below. Service primitives and parameter definitions are as in 3GPP TS 29.002. + +## 10.2 MAP\_PROVIDE\_ROAMING\_NUMBER service + +| Services | Interval for adoption | +|----------------------------|-----------------------| +| MAP_PROVIDE_ROAMING_NUMBER | HLR – GLR | +| | GLR – VLR | + +Figure 10.2/1 + +## 10.3 MAP\_SET\_REPORTING\_STATE service + +| Services | Interval for adoption | +|-------------------------|-----------------------| +| MAP_SET_REPORTING_STATE | HLR – GLR | +| | GLR – VLR | + +Figure 10.3/1 + +## 10.4 MAP\_STATUS\_REPORT service + +| Services | Interval for adoption | +|-------------------|-----------------------| +| MAP_STATUS_REPORT | VLR – GLR | +| | GLR – HLR | + +Figure 10.4/1 + +## 10.5 MAP\_REMOTE\_USER\_FREE service + +| Services | Interval for adoption | +|----------------------|-----------------------| +| MAP_REMOTE_USER_FREE | VLR – GLR | +| | GLR – HLR | + +Figure 10.5/1 + +# --- 11 Supplementary services related services + +## 11.1 General + +Regarding definition of each service, only the interval for adoption shall be considered for the GLR introduction. The intervals for adoption for the GLR specification are described below. Service primitives and parameter definitions are as in 3GPP TS 29.002. + +## 11.2 MAP\_REGISTER\_SS service + +| Services | Interval for adoption | +|-----------------|-----------------------| +| MAP_REGISTER_SS | VLR – GLR | +| | GLR – HLR | + +Figure 11.2/1 + +## 11.3 MAP\_ERASE\_SS service + +| Services | Interval for adoption | +|--------------|-----------------------| +| MAP_ERASE_SS | VLR – GLR | +| | GLR – HLR | + +Figure 11.3/1 + +## 11.4 MAP\_ACTIVATE\_SS service + +| Services | interval for adoption | +|-----------------|-----------------------| +| MAP_ACTIVATE_SS | VLR – GLR | +| | GLR – HLR | + +Figure 11.4/1 + +## 11.5 MAP\_DEACTIVATE\_SS service + +| Services | Interval for adoption | +|-------------------|-----------------------| +| MAP_DEACTIVATE_SS | VLR – GLR | +| | GLR – HLR | + +Figure 11.5/1 + +## 11.6 MAP\_INTERROGATE\_SS service + +| Services | Interval for adoption | +|--------------------|-----------------------| +| MAP_INTERROGATE_SS | VLR – GLR | +| | GLR – HLR | + +Figure 11.6/1 + +## 11.7 MAP\_REGISTER\_PASSWORD service + +| Services | Interval for adoption | +|-----------------------|-----------------------| +| MAP_REGISTER_PASSWORD | VLR – GLR | +| | GLR – HLR | + +Figure 11.7/1 + +## 11.8 MAP\_GET\_PASSWORD service + +| Services | Interval for adoption | +|------------------|-----------------------| +| MAP_GET_PASSWORD | HLR – GLR | +| | GLR – VLR | + +Figure 11.8/1 + +## 11.9 MAP\_PROCESS\_UNSTRUCTURED\_SS\_REQUEST service + +| Services | Interval for adoption | +|-------------------------------------|-----------------------| +| MAP_PROCESS_UNSTRUCTURED_SS_REQUEST | VLR – GLR | +| | GLR – HLR | + +Figure 11.9/1 + +## 11.10 MAP\_UNSTRUCTURED\_SS\_REQUEST service + +| Services | Interval for adoption | +|-----------------------------|-----------------------| +| MAP_UNSTRUCTURED_SS_REQUEST | HLR – GLR | +| | GLR – VLR | + +Figure 11.10/1 + +## 11.11 MAP\_UNSTRUCTURED\_SS\_NOTIFY service + +| Services | Interval for adoption | +|----------------------------|-----------------------| +| MAP_UNSTRUCTURED_SS_NOTIFY | HLR – GLR | +| | GLR – VLR | + +Figure 11.11/1 + +## 11.12 MAP\_REGISTER\_CC\_ENTRY service + +| Services | Interval for adoption | +|----------------------------|-----------------------| +| MAP_UNSTRUCTURED_SS_NOTIFY | VLR – GLR | +| | GLR – HLR | + +Figure 11.12/1 + +## 11.13 MAP\_ERASE\_CC\_ENTRY service + +| Services | Interval for adoption | +|---------------------|-----------------------| +| MAP_ERASE_CC_NOTIFY | VLR – GLR | +| | GLR – HLR | + +Figure 11.13/1 + +# --- 12 Short message service management services + +## 12.1 General + +Regarding definition of each service, only the interval for adoption shall be considered for the GLR introduction. The intervals for adoption for the GLR specification are described below. Service primitives and parameter definitions are as in 3GPP TS 29.002. + +## 12.2 MAP-READY-FOR-SM service + +| Services | interval for adoption | +|------------------|-----------------------| +| MAP-READY-FOR-SM | VLR – GLR | +| | SGSN – GLR | +| | GLR – HLR | + +Figure 12.2/1 + +## 12.3 MAP-MT-FORWARD-SHORT-MESSAGE service + +| Services | interval for adoption | +|------------------------------|-----------------------| +| MAP_MT_FORWARD_SHORT_MESSAGE | SMS-GMSC – IM-MSC | +| | IM-MSC – MSC | +| | SMS-GMSC – GLR | +| | GLR – SGSN | + +Figure 12.3/1 + +# --- 13 Network-Requested PDP Context Activation services + +## 13.1 General + +Regarding definition of each service, only the interval for adoption shall be considered for the GLR introduction. The intervals for adoption for the GLR specification are described below. Service primitives and parameter definitions are as in 3GPP TS 29.002. + +## 13.2 MAP\_SEND\_ROUTING\_INFO\_FOR\_GPRS service + +| Services | Interval for adoption | +|--------------------------------|-----------------------| +| MAP_SEND_ROUTING_INFO_FOR_GPRS | IM-GSN – GLR | + +Figure 13.2/1 + +## 13.3 MAP\_FAILURE\_REPORT service + +| Services | Interval for adoption | +|--------------------|-----------------------| +| MAP_FAILURE_REPORT | IM-GSN – GLR | + +Figure 13.3/1 + +# --- 14 Void + +# 15 Element of procedure + +The elements of procedures for the MAP protocol are referred to the corresponding section in 3GPP TS 29.002002 with the exceptions described below. + +## 15.1 SDL descriptions + +Replace the corresponding part of Process Secure\_MAP\_DSM as figure 15.1/1. + +![State transition diagram for Process Secure_MAP_DSM_GLR. The diagram shows transitions between states DIALOGUE_ACCEPTED, DIALOGUE_ESTABLISHED, and IDLE based on various MAP primitives and transport requirements.](e180f2b5fcbe8001554a7c0677cd3f82_img.jpg) + +Process Secure\_MAP\_DSM\_GLR 15.1.1(1) + +Process to manage a MAP dialogue + +``` + +stateDiagram-v2 + [*] --> DIALOGUE_ACCEPTED + DIALOGUE_ACCEPTED --> MAP_REQ + DIALOGUE_ACCEPTED --> MAP_rsp + DIALOGUE_ACCEPTED --> MAP_DELIMITER_req + MAP_REQ --> Secure_Transport_required + Secure_Transport_required --> Requesting_MAP_SSM : (TRUE) + Secure_Transport_required --> Service_Invoked_VIA_Intern2 : (FALSE) + Requesting_MAP_SSM --> Service_Invoked_VIA_Intern2 + Service_Invoked_VIA_Intern2 --> DIALOGUE_ESTABLISHED + MAP_rsp --> Secure_Transport_required + Secure_Transport_required --> Response_Issued_VIA_Intern1 : (TRUE) + Secure_Transport_required --> Response_Issued_VIA_Intern3 : (FALSE) + Response_Issued_VIA_Intern1 --> DIALOGUE_ACCEPTED + Response_Issued_VIA_Intern3 --> DIALOGUE_ACCEPTED + MAP_DELIMITER_req --> TC_CONTINUE_req_VIA_TC1 + TC_CONTINUE_req_VIA_TC1 --> DIALOGUE_ESTABLISHED + DIALOGUE_ESTABLISHED --> MAP_CLOSE_req + DIALOGUE_ESTABLISHED --> MAP_U_ABORT_req + MAP_CLOSE_req --> TC_END_req_VIA_TC1 + TC_END_req_VIA_TC1 --> Secure_Transport_required + Secure_Transport_required --> Terminated_VIA_Intern1 : (FALSE) + Secure_Transport_required --> Terminated_VIA_Intern2 : (TRUE) + Terminated_VIA_Intern1 --> To_all_active_PSSMs + Terminated_VIA_Intern2 --> To_all_active_RSSMs + To_all_active_PSSMs --> IDLE + To_all_active_RSSMs --> IDLE + MAP_U_ABORT_req --> User_reason=AC-not-supported + User_reason=AC-not-supported --> Abort_reason := User-specific + User_reason=AC-not-supported --> Abort_reason := AC-not-supported + Abort_reason := User-specific --> User_info := MAP_UserAbortInfo + User_info := MAP_UserAbortInfo --> TC_U_ABORT_req_VIA_TC1 + Abort_reason := AC-not-supported --> TC_U_ABORT_req_VIA_TC1 + TC_U_ABORT_req_VIA_TC1 --> Secure_Transport_required + Secure_Transport_required --> Terminated_VIA_Intern3 : (FALSE) + Secure_Transport_required --> Terminated_VIA_Intern4 : (TRUE) + Terminated_VIA_Intern3 --> To_all_active_SPSSMs + Terminated_VIA_Intern4 --> To_all_active_SRSSMs + To_all_active_SPSSMs --> IDLE + To_all_active_SRSSMs --> IDLE + +``` + +State transition diagram for Process Secure\_MAP\_DSM\_GLR. The diagram shows transitions between states DIALOGUE\_ACCEPTED, DIALOGUE\_ESTABLISHED, and IDLE based on various MAP primitives and transport requirements. + +Figure 15.1/1: Process Secure\_MAP\_DSM\_GLR + +# 16 Mapping onto TC services + +Dialogue control, Service specific procedures and SDL descriptions are referred to the corresponding section in 3GPP TS 29.002. + +# 17 Abstract syntax of the MAP protocol + +## 17.1 General + +Refer to the corresponding section in 3GPP TS 29.002 except Packages specifications and Application contexts. + +Regarding the operations which are initiated by the VLR or SGSN toward HLR via GLR, the timer value used in the operations should be configured enough long to guarantee the GLR specific fallback mechanism. + +## 17.2 Packages specifications + +Regarding Packages specifications, only the supplier and consumer definition shall be considered for the GLR introduction. The supplier and consumer definition for the GLR specification are derived Table 17.2/1. For the other definitions of the package specifications are as in 3GPP TS 29.002. + +**Table 17.2/1: supplier and consumer definition** + +| Operation Package | supplier | consumer | +|----------------------------------------|-------------|----------| +| LocationUpdatingPackage-v3 | HLR | GLR | +| | GLR | VLR | +| LocationCancellationPackage-v3 | VLR or SGSN | GLR | +| | GLR | HLR | +| RoamingNumberEnquiryPackage-v3 | VLR | GLR | +| | GLR | HLR | +| InfoRetrievalPackage-v2 | HLR | GLR | +| | GLR | VLR | +| | GLR | SGSN | +| InfoRetrievalPackage-v1 | HLR | GLR | +| | GLR | VLR | +| | GLR | SGSN | +| IMSIRetrievalPackage-v2 | HLR | GLR | +| | GLR | VLR | +| SubscriberDataMngtStandAlonePackage-v3 | VLR or SGSN | GLR | +| | GLR | HLR | +| SubscriberDataMngtPackage-v3 | VLR or SGSN | GLR | +| | GLR | HLR | +| ResetPackage-v2 | VLR or SGSN | GLR | +| | GLR | HLR | +| FunctionalSsPackage-v2 | HLR | GLR | +| | GLR | HLR | +| BindingPackage-v1 | HLR | GLR | +| | GLR | VLR | +| UnstructuredSsPackage-v2 | HLR | GLR | +| | GLR | VLR | +| UnstructuredSsPackage-v1 | HLR | GLR | +| | GLR | VLR | +| MTShortMsgRelayPackage-v3 | IM-MSC or | GMSC | +| | GLR | | +| | MSC | IM-MSC | +| | SGSN | GLR | +| MwdMngtPackage-v3 | HLR | GLR | +| | GLR | SGSN | +| | GLR | VLR | +| MwdMngtPackage-v1 | HLR | GLR | +| | GLR | VLR | +| DataRestorationPackage-v3 | GLR | VLR | +| PurgingPackage-v3 | HLR | GLR | +| | GLR | VLR | +| | GLR | SGSN | +| SubscriberInformationEnquiryPackage-v3 | VLR | GLR | +| | GLR | HLR | + +| Operation Package | supplier | consumer | +|---------------------------------------|----------------------------------------------------------------------------------------------------------------------------|-----------------| +| GprsLocationUpdatingPackage-v3 | HLR | GLR | +| | GLR | SGSN | +| FailureReportingPackage-v3 | GLR | IM-GSN | +| SetReportingStatePackage-v3 | VLR | GLR | +| | GLR | HLR | +| StatusReportPackage-v3 | HLR | GLR | +| | GLR | VLR | +| RemoteUserFreePackage-v3 | VLR | GLR | +| | GLR | HLR | +| CallCompletionPackage-v3 | HLR | GLR | +| | GLR | VLR | +| AuthenticationFailureReportPackage-v3 | HLR | GLR | +| | GLR | VLR | +| | GLR | SGSN | +| SecureTransportHandlingPackage-v3 | This operation package includes the operations required for the secure transport of MAP messages between any MAP entities. | | + +## 17.3 Application contexts + +Regarding Application contexts specifications, only the responder and initiator definition shall be considered for the GLR introduction. The responder and initiator definition for the GLR specification are derived Table 17.3/1. For the other definitions of the package specifications are as in 3GPP TS 29.002. + +**Table 17.3/1: supplier and consumer definition** + +| Application Context | Version | Initiator | Responder | +|------------------------------------|---------|-----------------------------------------------------------------------------------------------------|---------------| +| locationCancellationContext | v3 | HLR | GLR | +| | | GLR | VLR or SGSN | +| imsiRetrievalContext | v2 | VLR | GLR | +| | | GLR | HLR | +| infoRetrievalContext | v2 | VLR or SGSN | GLR | +| | | GLR | HLR | +| mwdMngtContext | v3 | VLR or SGSN | GLR | +| | | GLR | HLR | +| msPurgingContext | v3 | VLR or SGSN | GLR | +| | | GLR | HLR | +| resetContext | v2 | HLR | GLR | +| | | GLR | VLR or SGSN | +| networkUnstructuredSsContext | v2 | VLR | GLR | +| | | GLR | HLR | +| | | HLR | GLR | +| | | GLR | VLR | +| networkFunctionalSsContext | v2 | VLR | GLR | +| | | GLR | HLR | +| shortMsgMT-RelayContext | v3 | MSC | IM-MSC or GLR | +| | | IM-MSC | MSC | +| | | GLR | SGSN | +| networkLocUpContext | v3 | VLR | GLR | +| | | GLR | HLR | +| gprsLocationUpdateContext | v3 | SGSN | GLR | +| | | GLR | HLR | +| subscriberDataMngtContext | v3 | HLR | GLR | +| | | GLR | VLR or SGSN | +| roamingNumberEnquiryContext | v3 | HLR | GLR | +| | | GLR | VLR | +| gprsLocationInfoRetrievalContext | v3 | IM-GSN | GLR | +| failureReportContext | v3 | IM-GSN | GLR | +| subscriberInfoEnquiryContext | v3 | HLR | GLR | +| | | GLR | VLR | +| reportingContext | v3 | VLR | GLR | +| | | GLR | HLR | +| | | HLR | GLR | +| | | GLR | VLR | +| callCompletionContext | v3 | VLR | GLR | +| | | GLR | HLR | +| authenticationFailureReportContext | v3 | VLR or SGSN | GLR | +| | | GLR | HLR | +| SecureTransportHandlingContext | v3 | This application context is used for the secure transport of MAP messages between any MAP entities. | | + +# 18 General on MAP user procedure + +Refer to 3GPP TS 29.002 for general matters for procedure description such as notation convention, version handling at dialogue establishment and interaction between MAP provider and MAP users. + +# 19 Mobility procedures + +## 19.1 Location management Procedures + +For non-GPRS subscribers, this subclause comprises a number of processes to handle the mobile nature of the subscriber. The processes will be addressed by SCCP SSN (VLR or HLR) and the Application Context. The processes in the GLR interact with the processes in the VLR or HLR defined in 29.002. The followings show the relations between the protocol processes in the GLR and the processes in the other node. + +Process Update Location (VLR-GLR): + +- Initiator: Update\_Location\_Area\_VLR or Update\_Location\_HLR; +- Responder: Update\_Location\_GLR. + +Process Update Location (GLR-HLR): + +- Initiator: GLR\_Update\_Location\_HLR; +- Responder: Update\_Location\_HLR. + +Process Cancel Location (VLR-GLR): + +- Initiator: GLR\_Cancel\_Location\_VLR; +- Responder: Cancel\_Location\_VLR. + +Process Cancel Location (GLR-HLR): + +- Initiator: Cancel\_Location\_HLR; +- Responder: Cancel\_Location\_GLR. + +Process Purge MS (VLR-GLR): + +- Initiator: Purge\_MS\_VLR; +- Responder: Purge\_MS\_GLR. + +Process Purge MS (GLR-HLR): + +- Initiator: GLR\_Purge\_MS\_HLR; +- Responder: Purge\_MS\_HLR. + +A Location Management Co-ordinator in the GLR co-ordinates the two protocol processes "Update\_Location\_GLR" (subclause 19.1.2) and "RESTORE\_DATA\_GLR" (subclause 19.2) that are addressed by the same application context. + +On receipt of a dialogue request for the Location Management Application Context, the location Management\_Coordinator\_GLR will: + +- Terminate the process in case of parameter problems; or +- Revert to MAP version Vr protocol if the VLR requests version Vr protocol; or +- Continue as described in the following, if the dialogue is accepted. + +The protocol process is created depending on the first primitive received from the MAP service provider within this dialogue: + +- Update\_Location\_GLR if the primitive is a MAP\_UPDATE\_LOCATION indication. +- RESTORE\_DATA\_GLR if the primitive is a MAP\_RESTORE\_DATA indication. + +If a MAP\_NOTICE indication is received instead, the dialogue towards the VLR is terminated and the process returns to idle state. + +After creation of the protocol process the service primitive received from the MAP service-provider is passed to the protocol process. Henceforth, the co-ordinator will relay all service primitives from MAP service-provider to the MAP service-user and vice versa, until a request or indication for dialogue termination is received. This last primitive will be relayed, too, before the Co-ordinator process returns to idle state. + +![Flowchart of Process Location_Management_Coordinator_GLR. The process starts with an oval, leading to a 'NULL' state. It then receives an 'Open_Ind' primitive (Section 25.1). From here, three paths emerge: 'OK' leads to 'WAIT_FOR_SERVICE_PRIMITIVE'; 'Vr' leads to 'Perform_MAP_Vr_Dialogue' which ends in 'NULL'; 'Error' leads directly to 'NULL'. 'WAIT_FOR_SERVICE_PRIMITIVE' leads to three parallel processing paths: 1) 'MAP_UPDATE_LOCATION_Ind' -> 'Update_Location_GLR' -> 'MAP_UPDATE_LOCATION_Ind' (outward) -> 'RELAY_INFO'; 2) 'MAP_RESTORE_DATA_Ind' -> 'RESTORE_DATA_GLR' -> 'MAP_RESTORE_DATA_Ind' (outward) -> 'RELAY_INFO'; 3) 'MAP_NOTICE_Ind' -> 'MAP-CLOSE_Req' -> 'NULL'. All three 'RELAY_INFO' outputs converge to a central 'RELAY_INFO' block. From this block, four paths emerge: 1) 'from Provider' -> 'to OFFSPRING' -> 'RELAY_INFO'; 2) 'from OFFSPRING' -> 'to Provider' -> 'RELAY_INFO'; 3) 'MAP-U-ABORT_Req, MAP-CLOSE_Req from OFFSPRING' -> 'to Provider' -> 'NULL'; 4) 'MAP-P-ABORT_Ind, MAP-U-ABORT_Ind, MAP-CLOSE_Ind' -> 'to OFFSPRING' -> 'NULL'.](e90987faabad6a6665cd8ed1151dc474_img.jpg) + +**Process Location\_Management\_Coordinator\_GLR** 19.1.1.1(1) + +Location management coordination process in the GLR + +``` + +graph TD + Start([ ]) --> NULL1([NULL]) + NULL1 --> OpenInd[Receive_Open_Ind] + OpenInd --- Section251[Section 25.1] + OpenInd --> OK[OK] + OpenInd --> Vr[Vr] + OpenInd --> Error[Error] + OK --> WaitForServicePrimitive([WAIT_FOR_SERVICE_PRIMITIVE]) + Vr --> PerformVrDialogue[Perform_MAP_Vr_Dialogue] + PerformVrDialogue --> NULL2([NULL]) + Error --> NULL3([NULL]) + WaitForServicePrimitive --> UpdateInd[MAP_UPDATE_LOCATION_Ind] + WaitForServicePrimitive --> RestoreInd[MAP_RESTORE_DATA_Ind] + WaitForServicePrimitive --> NoticeInd[MAP_NOTICE_Ind] + UpdateInd --> UpdateGlr[Update_Location_GLR] + RestoreInd --> RestoreGlr[RESTORE_DATA_GLR] + NoticeInd --> CloseReq[MAP-CLOSE_Req] + UpdateGlr --> UpdateOut[MAP_UPDATE_LOCATION_Ind] + RestoreGlr --> RestoreOut[MAP_RESTORE_DATA_Ind] + CloseReq --> NULL4([NULL]) + UpdateOut --> RelayInfo1([RELAY_INFO]) + RestoreOut --> RelayInfo2([RELAY_INFO]) + RelayInfo1 --> FromProvider[from Provider] + RelayInfo2 --> FromOffspring[from OFFSPRING] + FromProvider --> ToOffspring1[to OFFSPRING] + ToOffspring1 --> RelayInfo3([RELAY_INFO]) + FromOffspring --> ToProvider1[to Provider] + ToProvider1 --> RelayInfo4([RELAY_INFO]) + FromOffspring --> AbortReq[MAP-U-ABORT_Req, MAP-CLOSE_Req from OFFSPRING] + AbortReq --> ToProvider2[to Provider] + ToProvider2 --> NULL5([NULL]) + FromOffspring --> AbortInd[MAP-P-ABORT_Ind, MAP-U-ABORT_Ind, MAP-CLOSE_Ind] + AbortInd --> ToOffspring2[to OFFSPRING] + ToOffspring2 --> NULL6([NULL]) + +``` + +Flowchart of Process Location\_Management\_Coordinator\_GLR. The process starts with an oval, leading to a 'NULL' state. It then receives an 'Open\_Ind' primitive (Section 25.1). From here, three paths emerge: 'OK' leads to 'WAIT\_FOR\_SERVICE\_PRIMITIVE'; 'Vr' leads to 'Perform\_MAP\_Vr\_Dialogue' which ends in 'NULL'; 'Error' leads directly to 'NULL'. 'WAIT\_FOR\_SERVICE\_PRIMITIVE' leads to three parallel processing paths: 1) 'MAP\_UPDATE\_LOCATION\_Ind' -> 'Update\_Location\_GLR' -> 'MAP\_UPDATE\_LOCATION\_Ind' (outward) -> 'RELAY\_INFO'; 2) 'MAP\_RESTORE\_DATA\_Ind' -> 'RESTORE\_DATA\_GLR' -> 'MAP\_RESTORE\_DATA\_Ind' (outward) -> 'RELAY\_INFO'; 3) 'MAP\_NOTICE\_Ind' -> 'MAP-CLOSE\_Req' -> 'NULL'. All three 'RELAY\_INFO' outputs converge to a central 'RELAY\_INFO' block. From this block, four paths emerge: 1) 'from Provider' -> 'to OFFSPRING' -> 'RELAY\_INFO'; 2) 'from OFFSPRING' -> 'to Provider' -> 'RELAY\_INFO'; 3) 'MAP-U-ABORT\_Req, MAP-CLOSE\_Req from OFFSPRING' -> 'to Provider' -> 'NULL'; 4) 'MAP-P-ABORT\_Ind, MAP-U-ABORT\_Ind, MAP-CLOSE\_Ind' -> 'to OFFSPRING' -> 'NULL'. + +**Figure 19.1.1/1: Process Location\_Management\_Coordinator\_GLR** + +For GPRS subscribers, this subclause comprises a number of other processes to handle the mobile nature of the subscriber. The processes will be addressed by SCCP Sub-System Number (SGSN or HLR) and the Application + +Context. The processes in the GLR interact with the processes in the VLR, SGSN or HLR defined in 29.002. The followings show the relations between the processes in the GLR and the processes in the other node: + +Process GPRS Update Location (VLR or SGSN-GLR): + +Initiator: GPRS\_Update\_Location\_Area\_VLR, or SGSN\_Update\_HLR. + +Responder: Update\_GPRS\_Location\_GLR. + +Process GPRS Update Location (GLR-HLR): + +Initiator: GLR\_Update\_GPRS\_Location\_HLR. + +Responder: Update\_GPRS\_Location\_HLR. + +Process Cancel Location (SGSN-GLR): + +Initiator: GLR\_Cancel\_Location\_SGSN. + +Responder: Cancel\_Location\_SGSN. + +Process Cancel Location (GLR-HLR): + +Initiator: Cancel\_GPRS\_Location\_HLR. + +Responder: Cancel\_GPRS\_Location\_GLR. + +Process Purge MS (SGSN-GLR): + +Initiator: Purge\_MS\_SGSN. + +Responder: Purge\_MS\_GLR\_for\_GPRS. + +Process Purge MS (GLR-HLR): + +Initiator: GLR\_Purge\_MS\_HLR\_for\_GPRS. + +Responder: Purge\_MS\_HLR. + +### 19.1.1 Location updating + +#### 19.1.1.1 General + +This location updating procedure is used to update the location information held in the network. + +If the GLR is located between the VLR and the HLR, the MAP\_UPDATE\_LOCATION service is invoked towards the GLR whose identity is contained in the VLR table. When the GLR receives a MAP\_UPDATE\_LOCATION indication, it determines whether it invokes the MAP\_UPDATE\_LOCATION service towards the HLR, and invokes it if necessary. + +If the GLR is located between the SGSN and the HLR, the MAP\_UPDATE\_GPRS\_LOCATION service is invoked towards the GLR whose identity is contained in the SGSN table. When the GLR receives a MAP\_UPDATE\_GPRS\_LOCATION indication, it determines whether it invokes the MAP\_UPDATE\_GPRS\_LOCATION service towards the HLR, and invokes it if necessary. + +![Sequence diagram showing network interfaces and services for location updating between VLR/SGSN, GLR, HLR, and PGLR/PVLR/PSGSN.](28d75f39a24203712ee907b32cf0bbe5_img.jpg) + +``` + +sequenceDiagram + participant VLR_SGSN as VLR/SGSN + participant GLR + participant HLR + participant PGLR_PVLR_PSGSN as PGLR/PVLR/PSGSN + + VLR_SGSN->>GLR: MAP UPDATE_LOCATION +or MAP UPDATE GPRS LOCATION + GLR->>HLR: MAP UPDATE_LOCATION +or MAP UPDATE GPRS LOCATION + HLR->>PGLR_PVLR_PSGSN: MAP_CANCEL_LOCATION + PGLR_PVLR_PSGSN-->>HLR: MAP_CANCEL_LOCATION ack + + HLR-->>GLR: MAP INSERT SUBSCRIBER DATA + GLR-->>VLR_SGSN: MAP INSERT SUBSCRIBER DATA + VLR_SGSN->>GLR: MAP INSERT SUBSCRIBER DATA ack + GLR->>HLR: MAP INSERT SUBSCRIBER DATA ack + + HLR-->>GLR: MAP CHECK SS INDICATION + GLR-->>VLR_SGSN: MAP CHECK SS INDICATION + + HLR-->>GLR: MAP UPDATE_LOCATION ack +or MAP UPDATE GPRS LOCATION ack + GLR-->>VLR_SGSN: MAP UPDATE_LOCATION ack +or MAP UPDATE GPRS LOCATION ack + +``` + +Sequence diagram showing network interfaces and services for location updating between VLR/SGSN, GLR, HLR, and PGLR/PVLR/PSGSN. + +**Figure 19.1.2/1: Interface and services for Location updating** + +#### 19.1.1.2 Detailed procedure in the GLR + +Figure 19.1.2/2 shows the Process Update\_Location\_GLR. This process is a GLR MAP protocol machine handling location updating and is a responder to the VLR. + +![State transition diagram for Process Update_Location_GLR. The diagram shows a sequence of states and transitions starting from an initial state, through WAIT_FOR_SERVICE_PRIMITIVE, MAP_Update_Location_ind, Update Location, and WAIT_FOR_APPLICATION_RESPONSE. From the final wait state, five transitions are possible: Update Location Ack, Update Location Negative Response, Insert Subscriber Data, Forward check SS indication, and Abort. Each transition leads to a specific action and output message set. Transitions 1, 2, and 3 lead to terminal states (marked with X). Transitions 4 and 5 lead to intermediate states with their own output message sets.](dd5771673aececa53d42ece89218299d_img.jpg) + +### Process Update\_Location\_GLR + +19.1.2.2\_1(3) + +GLR MAP protocol machine handling location updating and interfacing with VLR MAP protocol machine + +Left to VLR +Right to GLR application + +``` +stateDiagram-v2 + [*] --> WAIT_FOR_SERVICE_PRIMITIVE + WAIT_FOR_SERVICE_PRIMITIVE --> MAP_Update_Location_ind + MAP_Update_Location_ind --> Update Location + Update Location --> WAIT_FOR_APPLICATION_RESPONSE + WAIT_FOR_APPLICATION_RESPONSE --> Update Location Ack + WAIT_FOR_APPLICATION_RESPONSE --> Update Location Negative Response + WAIT_FOR_APPLICATION_RESPONSE --> Insert Subscriber Data + WAIT_FOR_APPLICATION_RESPONSE --> Forward check SS indication + WAIT_FOR_APPLICATION_RESPONSE --> Abort + + Update Location Ack --> Set result + Set result --> MAP_UPDATE_LOCATION_Rsp.MAP_CLOSE_Req + MAP_UPDATE_LOCATION_Rsp.MAP_CLOSE_Req --> [*] + + Update Location Negative Response --> Set Error + Set Error --> MAP_UPDATE_LOCATION_Rsp.MAP_CLOSE_Req + MAP_UPDATE_LOCATION_Rsp.MAP_CLOSE_Req --> [*] + + Insert Subscriber Data --> 1 + 1 --> [*] + + Forward check SS indication --> WAIT_FOR_APPLICATION_RESPONSE + WAIT_FOR_APPLICATION_RESPONSE --> MAP_FORWARD_CHECK_SS_INDICATION_req.MAP_DELIMITER_req + MAP_FORWARD_CHECK_SS_INDICATION_req.MAP_DELIMITER_req --> [*] + + Abort --> MAP_U_ABORT_req + MAP_U_ABORT_req --> [*] +``` + +State transition diagram for Process Update\_Location\_GLR. The diagram shows a sequence of states and transitions starting from an initial state, through WAIT\_FOR\_SERVICE\_PRIMITIVE, MAP\_Update\_Location\_ind, Update Location, and WAIT\_FOR\_APPLICATION\_RESPONSE. From the final wait state, five transitions are possible: Update Location Ack, Update Location Negative Response, Insert Subscriber Data, Forward check SS indication, and Abort. Each transition leads to a specific action and output message set. Transitions 1, 2, and 3 lead to terminal states (marked with X). Transitions 4 and 5 lead to intermediate states with their own output message sets. + +Figure 19.1.2/2 (sheet 1 of 3): Process Update\_Location\_GLR + +![State transition diagram for Process Update_Location_GLR. The process starts at state 1, receives MAP_Insert_Subscriber_Data_Req and MAP_Delimiter_Req, enters a wait state, then branches based on MAP_Insert_Subscriber_Cnf, MAP_U_ABORT_Ind/MAP_P_ABORT_Ind/MAP_CLOSE_Ind, or MAP_NOTICE_Ind. The diagram includes callouts for GLR MAP protocol machine handling and VLR/GLR application interactions, and references to Section 25.2.](00504fc688ebcf131ccbeff94dfc9939_img.jpg) + +### Process Update\_Location\_GLR + +19.1.2.2\_2(3) + +``` +stateDiagram-v2 + [*] --> 1 + 1 --> WAIT_FOR_ISD_Cnf_WAIT_FOR_SUBSEQUENT_APPLICATION_RESPONSE + WAIT_FOR_ISD_Cnf_WAIT_FOR_SUBSEQUENT_APPLICATION_RESPONSE --> MAP_INSERT_SUBSCRIBER_CNF: MAP_Insert_Subscriber_Cnf + WAIT_FOR_ISD_Cnf_WAIT_FOR_SUBSEQUENT_APPLICATION_RESPONSE --> MAP_U_ABORT_IND_MAP_P_ABORT_IND_MAP_CLOSE_IND: MAP_U_ABORT_Ind, MAP_P_ABORT_Ind, MAP_CLOSE_Ind + WAIT_FOR_ISD_Cnf_WAIT_FOR_SUBSEQUENT_APPLICATION_RESPONSE --> MAP_NOTICE_IND: MAP_NOTICE_Ind + MAP_INSERT_SUBSCRIBER_CNF --> CHECK_CONFIRMATION: Check Confirmation + CHECK_CONFIRMATION --> INSERT_SUBSCRIBER_CNF: OK + CHECK_CONFIRMATION --> SET_NEGATIVE_RESPONSE_SYSTEM_FAILURE: Provider error, Data error + CHECK_CONFIRMATION --> MAP_USER_ERROR_TO_NEGATIVE_RESPONSE: User error + MAP_U_ABORT_IND_MAP_P_ABORT_IND_MAP_CLOSE_IND --> ABORT: Abort + ABORT --> [*] + MAP_NOTICE_IND --> SET_NEGATIVE_RESULT_SYSTEM_FAILURE: Set Negative Result System Failure + SET_NEGATIVE_RESULT_SYSTEM_FAILURE --> ISD_NEGATIVE_RESPONSE_1: ISD Negative Response + ISD_NEGATIVE_RESPONSE_1 --> 2 + INSERT_SUBSCRIBER_CNF --> 2 + SET_NEGATIVE_RESPONSE_SYSTEM_FAILURE --> ISD_NEGATIVE_RESPONSE_2: ISD Negative Response + MAP_USER_ERROR_TO_NEGATIVE_RESPONSE --> ISD_NEGATIVE_RESPONSE_2 + ISD_NEGATIVE_RESPONSE_2 --> 2 +``` + +GLR MAP protocol machine handling location updating and interfacing with VLR MAP protocol machine + +Left to VLR +Right to GLR application + +MAP\_Insert\_Subscriber\_Data\_Req +MAP\_Delimiter\_Req + +WAIT\_FOR\_ISD\_Cnf +WAIT\_FOR\_SUBSEQUENT\_APPLICATION\_RESPONSE + +MAP\_Insert\_Subscriber\_Cnf + +MAP\_U\_ABORT\_Ind +MAP\_P\_ABORT\_Ind +MAP\_CLOSE\_Ind + +Abort + +MAP\_NOTICE\_Ind + +Set Negative Result System Failure + +ISD Negative Response + +2 + +Check Confirmation + +Section 25.2 + +OK + +Provider error +Data error + +User error + +Insert\_Subscriber\_Cnf + +Set Negative Response System Failure + +MAP User Error to Negative Response + +ISD Negative Response + +2 + +State transition diagram for Process Update\_Location\_GLR. The process starts at state 1, receives MAP\_Insert\_Subscriber\_Data\_Req and MAP\_Delimiter\_Req, enters a wait state, then branches based on MAP\_Insert\_Subscriber\_Cnf, MAP\_U\_ABORT\_Ind/MAP\_P\_ABORT\_Ind/MAP\_CLOSE\_Ind, or MAP\_NOTICE\_Ind. The diagram includes callouts for GLR MAP protocol machine handling and VLR/GLR application interactions, and references to Section 25.2. + +Figure 19.1.2/2 (sheet 2 of 3): Process Update\_Location\_GLR + +![SDL diagram for Process Update_Location_GLR showing state transitions from WAIT_FOR_ISD_Cnf and WAIT_FOR_SUBSEQUENT_APPLICATION_RESPONSE based on various inputs like Update Location Ack, Negative Response, Insert Subscriber Data, and Abort.](e05b36c0d46549e681ce6581422c66b2_img.jpg) + +### Process Update\_Location\_GLR + +19.1.2.2\_3(3) + +GLR MAP protocol machine handling location updating and interfaceing with VLR MAP protocol machine + +Left to VLR +Right to GLR application + +``` + +stateDiagram-v2 + state "WAIT_FOR_ISD_Cnf +WAIT_FOR_SUBSEQUENT_APPLICATION_RESPONSE" as WAIT + + [*] --> WAIT + + WAIT --> UpdateLocationAck : Update Location Ack + WAIT --> UpdateLocationNeg : Update Location Negative Response + WAIT --> InsertSubData : Insert Subscriber Data + WAIT --> Abort : Abort + + UpdateLocationAck --> SetResult : Set result + UpdateLocationNeg --> SetError : Set Error + + SetResult --> Output1 + SetError --> Output1 + + state "MAP_UPDATE_LOCATION_Rsp. +MAP_CLOSE_Req." as Output1 + Output1 --> [*] + + InsertSubData --> Connector1 : 1 + + Abort --> MAP_U_ABORT_Req : MAP_U_ABORT_Req. + MAP_U_ABORT_Req --> [*] + +``` + +SDL diagram for Process Update\_Location\_GLR showing state transitions from WAIT\_FOR\_ISD\_Cnf and WAIT\_FOR\_SUBSEQUENT\_APPLICATION\_RESPONSE based on various inputs like Update Location Ack, Negative Response, Insert Subscriber Data, and Abort. + +Figure 19.1.2/2 (sheet 3 of 3): Process Update\_Location\_GLR + +Figure 19.1.2/3 shows the Process GLR\_Update\_Location\_HLR. This process is a GLR MAP protocol machine handling location updating and is an initiator to the HLR. + +Sheet 1: If the Macro Open\_Receive\_Cnf results Vr, the process requests to perform MAP Vr. It causes a request for sending an abort message to Process Update\_Location\_GLR. + +![Flowchart for Process GLR_Update_Location_HLR. The process starts at an oval, goes to an IDLE state (oval), then an Update Location transition (chevron). It then enters a loop: a decision diamond (left side) leads to a box with MAP_OPEN_Req, MAP_UPDATE_LOCATION_Req, and MAP_DELIMITER_Req; this leads to a Receive Open Cnf state (double rectangle, linked to Section 25.1). From Receive Open Cnf, three paths emerge: OK leads to Wait_For_HLR_Response (oval); Vr leads to Perform MAP Vr (diamond); Error leads to Set error (rectangle) then Update Location Negative Response (chevron). Both Perform MAP Vr and Update Location Negative Response lead to end symbols (crossed lines).](5478f70a6cef3e5672b2b22d28830cfb_img.jpg) + +### Process GLR\_Update\_Location\_HLR + +19.1.2.3\_1(3) + +GLR MAP protocol machine handling Location Management and interfacing to HLR MAP protocol machine, handling Location Management. + +Signals to/from the left are to/from the GLR application. +Signals to/from the right are to/from the HLR MAP protocol machine. + +``` +graph TD; Start([ ]) --> IDLE([IDLE]); IDLE --> UpdateLocation{Update Location}; UpdateLocation --> Decision{ }; Decision --> Req["MAP_OPEN_Req
MAP_UPDATE_LOCATION_Req
MAP_DELIMITER_Req"]; Req --> ReceiveOpenCnf[Receive Open Cnf]; ReceiveOpenCnf --- Section251[Section 25.1]; ReceiveOpenCnf -- OK --> WaitForHLR[Wait_For_HLR_Response]; ReceiveOpenCnf -- Vr --> PerformMAPVr{Perform MAP Vr}; ReceiveOpenCnf -- Error --> SetError[Set error]; SetError --> UpdateLocationNeg[Update Location Negative Response]; PerformMAPVr --> End1[ ]; UpdateLocationNeg --> End2[ ] +``` + +Flowchart for Process GLR\_Update\_Location\_HLR. The process starts at an oval, goes to an IDLE state (oval), then an Update Location transition (chevron). It then enters a loop: a decision diamond (left side) leads to a box with MAP\_OPEN\_Req, MAP\_UPDATE\_LOCATION\_Req, and MAP\_DELIMITER\_Req; this leads to a Receive Open Cnf state (double rectangle, linked to Section 25.1). From Receive Open Cnf, three paths emerge: OK leads to Wait\_For\_HLR\_Response (oval); Vr leads to Perform MAP Vr (diamond); Error leads to Set error (rectangle) then Update Location Negative Response (chevron). Both Perform MAP Vr and Update Location Negative Response lead to end symbols (crossed lines). + +Figure 19.1.2/3 (Sheet 1 of 3): Process GLR\_Update\_Location\_HLR + +![SDL Diagram for Process GLR_Update_Location_HLR showing state transitions from Wait_For_HLR_Response based on various MAP signals leading to Idle or further wait states.](05eb72d372e4bf78e3d6a64949d77bcc_img.jpg) + +### Process GLR\_Update\_Location\_HLR + +19.1.2.3\_2(3) + +GLR MAP protocol machine handling Location Management and interfacing to HLR MAP protocol machine, handling Location Management. + +Signals to/from the left are to/from the GLR application. +Signals to/from the right are to/from the HLR MAP protocol machine. + +``` + +stateDiagram-v2 + state "Wait_For_HLR_Response" as WaitHLR + state "Wait_For_HLR_or_Application_Response" as WaitHLRApp + state "Idle" as Idle + + [*] --> WaitHLR + + WaitHLR --> MAP_FORWARD_Check_SS_ind + MAP_FORWARD_Check_SS_ind --> Forward_Check_SS_Indication + Forward_Check_SS_Indication --> WaitHLR + + WaitHLR --> MAP_INSERT_SUBSCRIBER_DATA_ind + MAP_INSERT_SUBSCRIBER_DATA_ind --> Insert_Subscriber_data + Insert_Subscriber_data --> WaitHLRApp + + WaitHLRApp --> MAP_Update_Location_cnf + MAP_Update_Location_cnf --> Check_Confirmation + state Check_Confirmation <> + Check_Confirmation --> Update_Location_ack : OK + Check_Confirmation --> Set_negative_response_1 : Provider Error, User Error, Data Error + Update_Location_ack --> Idle + Set_negative_response_1 --> Update_Location_negative_response_1 + Update_Location_negative_response_1 --> Idle + + WaitHLR --> MAP_Notice_Indication + MAP_Notice_Indication --> MAP_Close_request + MAP_Close_request --> Set_negative_response_2 + Set_negative_response_2 --> Update_Location_negative_response_2 + Update_Location_negative_response_2 --> Idle + + WaitHLR --> MAP_Abort_Signals + state "MAP_U_Abort_ind\nMAP_P_Abort_ind\nMAP_Close_ind" as MAP_Abort_Signals + MAP_Abort_Signals --> Abort + Abort --> Idle + +``` + +Section 25.2 + +SDL Diagram for Process GLR\_Update\_Location\_HLR showing state transitions from Wait\_For\_HLR\_Response based on various MAP signals leading to Idle or further wait states. + +**Figure 19.1.2/3 (Sheet 2 of 3): Process GLR\_Update\_Location\_HLR** + +![State transition diagram for Process GLR_Update_Location_HLR. The diagram shows two main sections. The top section handles 'MAP_INSERT_SUBSCRIBER_DATA_ind' from the application, leading to 'Insert Subscriber data' (GLR internal), then 'Insert Subscriber Data ack' (to HLR), and finally 'MAP_Insert Subscriber Data response' (to HLR). The bottom section handles 'MAP_Update_Location_cnf' from the HLR, leading to 'Check Confirmation' (GLR internal), then 'Update Location ack' (to application) or 'Set negative response' (to application), ending in 'Idle'. Other states include 'MAP_FORWARD_Check_SS_ind', 'MAP_U_Abort_ind', 'MAP_P_Abort_ind', and 'MAP_Close_ind' leading to 'Abort' and 'Idle'.](6e15fc9ea763541c5913d26f85072ae1_img.jpg) + +### Process GLR\_Update\_Location\_HLR + +19.1.2.3\_3(3) + +GLR MAP protocol machine handling Location Management and interfacing to HLR MAP protocol machine, handling Location Management. + +Signals to/from the left are to/from the GLR application. +Signals to/from the right are to/from the HLR MAP protocol machine. + +``` +stateDiagram-v2 + [*] --> Wait_For_HLR_or_Application_Response_1 : Wait_For_HLR_or_Application_Response + state "Wait_For_HLR_or_Application_Response" as Wait_For_HLR_or_Application_Response_1 + state "MAP_FORWARD_Check_SS_ind" as MAP_FORWARD_Check_SS_ind + state "MAP_INSERT_SUBSCRIBER_DATA_ind" as MAP_INSERT_SUBSCRIBER_DATA_ind + state "Forward Check SS Indication" as Forward_Check_SS_Indication + state "Insert Subscriber data" as Insert_Subscriber_data + state "Insert Subscriber Data ack" as Insert_Subscriber_Data_ack + state "Insert Subscriber Data negative response" as Insert_Subscriber_Data_negative_response + state "Set user error" as Set_user_error + state "MAP_Insert Subscriber Data response" as MAP_Insert_Subscriber_Data_response + state "MAP_Update_Location_cnf" as MAP_Update_Location_cnf + state "Check Confirmation" as Check_Confirmation + state "Update Location ack" as Update_Location_ack + state "Set negative response" as Set_negative_response_1 + state "Update Location negative response" as Update_Location_negative_response_1 + state "Abort" as Abort_1 + state "Map_U_Abort request" as Map_U_Abort_request + state "MAP_Notify_Indication" as MAP_Notify_Indication + state "MAP_Close_request" as MAP_Close_request + state "MAP_U_Abort_ind" as MAP_U_Abort_ind + state "MAP_P_Abort_ind" as MAP_P_Abort_ind + state "MAP_Close_ind" as MAP_Close_ind + state "Idle" as Idle_1 + state "Idle" as Idle_2 + + Wait_For_HLR_or_Application_Response_1 --> MAP_FORWARD_Check_SS_ind + Wait_For_HLR_or_Application_Response_1 --> MAP_INSERT_SUBSCRIBER_DATA_ind + MAP_FORWARD_Check_SS_ind --> Forward_Check_SS_Indication + Forward_Check_SS_Indication --> [*] + MAP_INSERT_SUBSCRIBER_DATA_ind --> Insert_Subscriber_data + Insert_Subscriber_data --> Insert_Subscriber_Data_ack + Insert_Subscriber_Data_ack --> [*] + Insert_Subscriber_Data_ack --> Insert_Subscriber_Data_negative_response + Insert_Subscriber_Data_negative_response --> Set_user_error + Set_user_error --> [*] + Insert_Subscriber_Data_ack --> MAP_Insert_Subscriber_Data_response + MAP_Insert_Subscriber_Data_response --> [*] + + [*] --> Wait_For_HLR_or_Application_Response_2 : Wait_For_HLR_or_Application_Response + state "Wait_For_HLR_or_Application_Response" as Wait_For_HLR_or_Application_Response_2 + Wait_For_HLR_or_Application_Response_2 --> MAP_Update_Location_cnf + Wait_For_HLR_or_Application_Response_2 --> Abort_1 + Wait_For_HLR_or_Application_Response_2 --> MAP_Notify_Indication + Wait_For_HLR_or_Application_Response_2 --> MAP_U_Abort_ind + Wait_For_HLR_or_Application_Response_2 --> MAP_P_Abort_ind + Wait_For_HLR_or_Application_Response_2 --> MAP_Close_ind + + MAP_Update_Location_cnf --> Check_Confirmation + Check_Confirmation --> Update_Location_ack : OK + Check_Confirmation --> Set_negative_response_1 : Provider Error, User Error, Data Error + Update_Location_ack --> Idle_1 + Set_negative_response_1 --> Update_Location_negative_response_1 + Update_Location_negative_response_1 --> Idle_1 + + Abort_1 --> Map_U_Abort_request + Map_U_Abort_request --> [*] + + MAP_Notify_Indication --> MAP_Close_request + MAP_Close_request --> Set_negative_response_2 : Set negative response + Set_negative_response_2 --> Update_Location_negative_response_2 : Update Location negative response + Update_Location_negative_response_2 --> Idle_2 + + MAP_U_Abort_ind --> Abort_2 : Abort + MAP_P_Abort_ind --> Abort_2 + MAP_Close_ind --> Abort_2 + Abort_2 --> Idle_2 +``` + +State transition diagram for Process GLR\_Update\_Location\_HLR. The diagram shows two main sections. The top section handles 'MAP\_INSERT\_SUBSCRIBER\_DATA\_ind' from the application, leading to 'Insert Subscriber data' (GLR internal), then 'Insert Subscriber Data ack' (to HLR), and finally 'MAP\_Insert Subscriber Data response' (to HLR). The bottom section handles 'MAP\_Update\_Location\_cnf' from the HLR, leading to 'Check Confirmation' (GLR internal), then 'Update Location ack' (to application) or 'Set negative response' (to application), ending in 'Idle'. Other states include 'MAP\_FORWARD\_Check\_SS\_ind', 'MAP\_U\_Abort\_ind', 'MAP\_P\_Abort\_ind', and 'MAP\_Close\_ind' leading to 'Abort' and 'Idle'. + +Figure 19.1.2/3 (Sheet 3 of 3): Process GLR\_Update\_Location\_HLR + +Figure 19.1.2/4 shows the Process Update\_GPRS\_Location\_GLR. This process is a GLR MAP protocol machine handling location updating and is a responder to the SGSN. + +![State transition diagram for Process Update_GPRS_Location_GLR. The process starts at an initial state, goes to NULL, then receives an Open Indication. From there, it branches based on version: V2 leads to Perform_MAP_Vr_Dialogue and then NULL; V1 Error leads to NULL; OK leads to WAIT_FOR_SERVICE_PRIMITIVE. From WAIT_FOR_SERVICE_PRIMITIVE, it sends a MAP_Update_GPRS_Location_ind to the application. The application responds with Update GPRS Location, which leads to connector 2. From connector 2, it goes to WAIT_FOR_APPLICATION_RESPONSE. From this wait state, it handles three possible responses: Update GPRS Location Ack (leading to Set result and then MAP_UPDATE_GPRS_LOCATION_Rsp. MAP_CLOSE_Req.), Update GPRS Location Negative Response (leading to Set error and then MAP_UPDATE_GPRS_LOCATION_Rsp. MAP_CLOSE_Req.), or Insert Subscriber Data (leading to connector 1). An Abort response leads to MAP_U_ABORT_req. Callouts indicate the process is a GLR MAP protocol machine interfacing with SGSN MAP and that messages go left to SGSN and right to GLR application.](1cac1845cf99a3f64ae00cd2bb4f9ed7_img.jpg) + +### Process Update\_GPRS\_Location\_GLR + +19.1.2.4\_1(3) + +``` +stateDiagram-v2 + [*] --> NULL1[NULL] + NULL1 --> Receive_Open_Ind[Receive Open Ind.] + Receive_Open_Ind --> WAIT_FOR_SERVICE_PRIMITIVE[WAIT_FOR_SERVICE_PRIMITIVE] + WAIT_FOR_SERVICE_PRIMITIVE --> MAP_Update_GPRS_Location_ind{MAP_Update_GPRS_Location_ind} + MAP_Update_GPRS_Location_ind --> Update_GPRS_Location[Update GPRS Location] + Update_GPRS_Location --> 2((2)) + 2 --> WAIT_FOR_APPLICATION_RESPONSE[WAIT_FOR APPLICATION RESPONSE] + WAIT_FOR_APPLICATION_RESPONSE --> Update_GPRS_Location_Ack[Update GPRS Location Ack] + WAIT_FOR_APPLICATION_RESPONSE --> Update_GPRS_Location_Negative_Response[Update GPRS Location Negative Response] + WAIT_FOR_APPLICATION_RESPONSE --> Insert_Subscriber_Data[Insert Subscriber Data] + WAIT_FOR_APPLICATION_RESPONSE --> Abort[Abort] + Update_GPRS_Location_Ack --> Set_result[Set result] + Set_result --> MAP_UPDATE_GPRS_LOCATION_Rsp_1{MAP_UPDATE_GPRS_LOCATION_Rsp. MAP_CLOSE_Req.} + Update_GPRS_Location_Negative_Response --> Set_error[Set error] + Set_error --> MAP_UPDATE_GPRS_LOCATION_Rsp_2{MAP_UPDATE_GPRS_LOCATION_Rsp. MAP_CLOSE_Req.} + Insert_Subscriber_Data --> 1((1)) + Abort --> MAP_U_ABORT_req{MAP_U_ABORT_req.} +``` + +GLR MAP protocol machine handling location updating and interfacing with SGSN MAP protocol machine + +Left to SGSN +Right to GLR application + +OK + +V2 + +V1 Error + +NULL + +NULL + +Perform\_MAP\_Vr\_Dialogue + +Receive Open Ind. + +WAIT\_FOR\_SERVICE\_PRIMITIVE + +MAP\_Update\_GPRS\_Location\_ind + +Update GPRS Location + +2 + +WAIT\_FOR\_APPLICATION\_RESPONSE + +Update GPRS Location Ack + +Set result + +MAP\_UPDATE\_GPRS\_LOCATION\_Rsp. MAP\_CLOSE\_Req. + +Update GPRS Location Negative Response + +Set error + +MAP\_UPDATE\_GPRS\_LOCATION\_Rsp. MAP\_CLOSE\_Req. + +Insert Subscriber Data + +1 + +Abort + +MAP\_U\_ABORT\_req. + +State transition diagram for Process Update\_GPRS\_Location\_GLR. The process starts at an initial state, goes to NULL, then receives an Open Indication. From there, it branches based on version: V2 leads to Perform\_MAP\_Vr\_Dialogue and then NULL; V1 Error leads to NULL; OK leads to WAIT\_FOR\_SERVICE\_PRIMITIVE. From WAIT\_FOR\_SERVICE\_PRIMITIVE, it sends a MAP\_Update\_GPRS\_Location\_ind to the application. The application responds with Update GPRS Location, which leads to connector 2. From connector 2, it goes to WAIT\_FOR\_APPLICATION\_RESPONSE. From this wait state, it handles three possible responses: Update GPRS Location Ack (leading to Set result and then MAP\_UPDATE\_GPRS\_LOCATION\_Rsp. MAP\_CLOSE\_Req.), Update GPRS Location Negative Response (leading to Set error and then MAP\_UPDATE\_GPRS\_LOCATION\_Rsp. MAP\_CLOSE\_Req.), or Insert Subscriber Data (leading to connector 1). An Abort response leads to MAP\_U\_ABORT\_req. Callouts indicate the process is a GLR MAP protocol machine interfacing with SGSN MAP and that messages go left to SGSN and right to GLR application. + +Figure 19.1.2/4 (sheet 1 of 3): Process Update\_GPRS\_Location\_GLR + +![State transition diagram for Process Update_GPRS_Location_GLR. The process starts at connector 1, moves to connector 3, and sends MAP_Insert_Subscriber_Data_Req and MAP_Delimiter_Req. It then enters a WAIT state. From WAIT, it can receive MAP_Insert_Subscriber_Cnf (leading to Check Confirmation), MAP_U_ABORT_Ind/MAP_P_ABORT_Ind/MAP_CLOSE_Ind (leading to Abort), or MAP_NOTICE_Ind (leading to Set Negative Result System Failure). Check Confirmation leads to OK (Insert_Subscriber_Data_Cnf to connector 2), Provider error Data error (Set Negative Response System Failure), or User error (MAP User Error to Negative Response). Both Set Negative Response System Failure and MAP User Error to Negative Response lead to ISD Negative Response to connector 2. MAP_NOTICE_Ind also leads to ISD Negative Response to connector 3.](78ff716475b2f65bf01c3a4d02d89fc4_img.jpg) + +### Process Update\_GPRS\_Location\_GLR + +19.1.2.4\_2(3) + +GLR MAP protocol machine handling location updating and interfacing with SGSN MAP protocol machine + +``` +stateDiagram-v2 + [*] --> 1 + 1 --> 3 + 3 --> Request + state "MAP_Insert_Subscriber_Data_Req
MAP_Delimiter_Req" as Request + Request --> WAIT + state "WAIT_FOR_ISD_Cnf
WAIT_FOR_SUBSEQUENT_APPLICATION_RESPONSE" as WAIT + WAIT --> Insert_Cnf + state "MAP_Insert_Subscriber_Cnf" as Insert_Cnf + WAIT --> Abort + state "MAP_U_ABORT_Ind
MAP_P_ABORT_Ind
MAP_CLOSE_Ind" as Abort + WAIT --> Notice_Ind + state "MAP_NOTICE_Ind" as Notice_Ind + Insert_Cnf --> Check + state "Check Confirmation" as Check + Check --> OK + Check --> Provider_Error + Check --> User_Error + OK --> Insert_Data_Cnf + state "Insert_Subscriber_Data_Cnf" as Insert_Data_Cnf + Insert_Data_Cnf --> 2 + Provider_Error --> Set_Neg_Resp + state "Set Negative Response System Failure" as Set_Neg_Resp + User_Error --> MAP_User_Error + state "MAP User Error to Negative Response" as MAP_User_Error + Set_Neg_Resp --> ISD_Neg_Resp_2 + state "ISD Negative Response" as ISD_Neg_Resp_2 + ISD_Neg_Resp_2 --> 2 + Notice_Ind --> Set_Neg_Resp_3 + state "Set Negative Result System Failure" as Set_Neg_Resp_3 + Set_Neg_Resp_3 --> ISD_Neg_Resp_3 + state "ISD Negative Response" as ISD_Neg_Resp_3 + ISD_Neg_Resp_3 --> 3 +``` + +Left to SGSN +Right to GLR application + +Section 25.2 + +State transition diagram for Process Update\_GPRS\_Location\_GLR. The process starts at connector 1, moves to connector 3, and sends MAP\_Insert\_Subscriber\_Data\_Req and MAP\_Delimiter\_Req. It then enters a WAIT state. From WAIT, it can receive MAP\_Insert\_Subscriber\_Cnf (leading to Check Confirmation), MAP\_U\_ABORT\_Ind/MAP\_P\_ABORT\_Ind/MAP\_CLOSE\_Ind (leading to Abort), or MAP\_NOTICE\_Ind (leading to Set Negative Result System Failure). Check Confirmation leads to OK (Insert\_Subscriber\_Data\_Cnf to connector 2), Provider error Data error (Set Negative Response System Failure), or User error (MAP User Error to Negative Response). Both Set Negative Response System Failure and MAP User Error to Negative Response lead to ISD Negative Response to connector 2. MAP\_NOTICE\_Ind also leads to ISD Negative Response to connector 3. + +Figure 19.1.2/4 (sheet 2 of 3): Process Update\_GPRS\_Location\_GLR + +![SDL Diagram for Process Update_GPRS_Location_GLR showing transitions from WAIT_FOR_ISD_Cnf and WAIT_FOR_SUBSEQUENT_APPLICATION_RESPONSE states based on inputs like Update Location Ack, Update GPRS Location Negative Response, Insert Subscriber Data, and Abort.](6629e8a87e7552e2454b7c3e9f6d73a0_img.jpg) + +### Process Update\_GPRS\_Location\_GLR + +19.1.2.4\_3(3) + +GLR MAP protocol machine handling location updating and interfacing with SGSN MAP protocol machine + +Left to SGSN +Right to GLR application + +``` + +stateDiagram-v2 + state "WAIT_FOR_ISD_Cnf\nWAIT_FOR_SUBSEQUENT_\nAPPLICATION_RESPONSE" as MainState + + MainState --> Update_Location_Ack + MainState --> Update_GPRS_Location_Negative_Response + MainState --> Insert_Subscriber_Data + MainState --> Abort + + Update_Location_Ack --> Set_result + Set_result --> MAP_UPDATE_LOCATION_Rsp + MAP_UPDATE_LOCATION_Rsp --> [*] + + Update_GPRS_Location_Negative_Response --> Set_Error + Set_Error --> MAP_UPDATE_LOCATION_Rsp + + Insert_Subscriber_Data --> Connector_1 : 1 + + Abort --> MAP_U_ABORT_req + MAP_U_ABORT_req --> [*] + +``` + +SDL Diagram for Process Update\_GPRS\_Location\_GLR showing transitions from WAIT\_FOR\_ISD\_Cnf and WAIT\_FOR\_SUBSEQUENT\_APPLICATION\_RESPONSE states based on inputs like Update Location Ack, Update GPRS Location Negative Response, Insert Subscriber Data, and Abort. + +**Figure 19.1.2/4 (sheet 3 of 3): Process Update\_GPRS\_Location\_GLR** + +Figure 19.1.2/5 shows the Process GLR\_Update\_GPRS\_Location\_HLR. This process is a GLR MAP protocol machine handling location updating and is an initiator to the HLR. + +Sheet 1: If the Macro Open\_Receive\_Cnf results Vr, the process requests to perform MAP Vr. It causes a request for sending an abort message to Process Update\_GPRS\_Location\_GLR. + +![SDL diagram for Process GLR_Update_GPRS_Location_HLR. The flow starts at IDLE, receives 'Update GPRS Location', sends MAP requests, calls 'Receive Open Cnf.', and branches into OK (Wait_For_HLR_Response), Vr (Perform MAP Vr), or Error (Set error and Negative Response).](4ff00a489baaa34a0c01070de1d613db_img.jpg) + +### Process GLR\_Update\_GPRS\_Location\_HLR 19.1.2.5\_1(3) + +GLR MAP protocol machine handling Location Management and interfacing to HLR MAP protocol machine, handling Location Management. + +Signals to/from the left are to/from the GLR application. +Signals to/from the right are to/from the HLR MAP protocol machine. + +``` + +stateDiagram-v2 + [*] --> IDLE + IDLE --> Update_GPRS_Location : Update GPRS Location + state Update_GPRS_Location { + direction LR + MAP_OPEN_Req + MAP_UPDATE_GPRS_LOCATION_Req + MAP_DELIMITER_Req + } + Update_GPRS_Location --> Receive_Open_Cnf + state "Receive Open Cnf. (Section 25.1)" as Receive_Open_Cnf + Receive_Open_Cnf --> Wait_For_HLR_Response : OK + Receive_Open_Cnf --> Perform_MAP_Vr : Vr + Receive_Open_Cnf --> Set_error : Error + + state "Wait_For_HLR_Response" as Wait_For_HLR_Response + + state Perform_MAP_Vr { + Perform_MAP_Vr_Signal : Perform MAP Vr + } + Perform_MAP_Vr --> [*] + + state Set_error { + Set_error_Task : Set error + Negative_Response : Update GPRS Location Negative Response + } + Set_error --> [*] + +``` + +SDL diagram for Process GLR\_Update\_GPRS\_Location\_HLR. The flow starts at IDLE, receives 'Update GPRS Location', sends MAP requests, calls 'Receive Open Cnf.', and branches into OK (Wait\_For\_HLR\_Response), Vr (Perform MAP Vr), or Error (Set error and Negative Response). + +Figure 19.1.2/5 (Sheet 1 of 3): Process GLR\_Update\_GPRS\_Location\_HLR + +![State transition diagram for Process GLR_Update_GPRS_Location_HLR. The diagram shows four main entry points from 'Wait_For_HLR_Response': 1) MAP_Update_GPRS_Location_cnf leads to 'Check Confirmation' (Section 25.2), which results in 'Update GPRS Location ack' (OK) or 'Set negative response' (Provider Error, User Error, Data Error), both leading to 'Idle'. 2) MAP_INSERT_SUBSCRIBER_DATA_ind leads to 'Insert Subscriber Data', which leads to 'Wait_For_HLR_or_Application_Response'. 3) MAP_Notice_Indication leads to 'MAP_Close_request', which leads to 'Set negative response', then 'Update GPRS Location negative response', and finally 'Idle'. 4) MAP_U_Abort_ind, MAP_P_Abort_ind, and MAP_Close_ind all lead to 'Abort', which leads to 'Idle'.](329c96049bb432e9c2cbda4e224a0c9c_img.jpg) + +### Process GLR\_Update\_GPRS\_Location\_HLR + +19.1.2.5\_2(3) + +GLR MAP protocol machine handling Location Management and interfacing to HLR MAP protocol machine, handling Location Management. + +Signals to/from the left are to/from the GLR application. +Signals to/from the right are to/from the HLR MAP protocol machine. + +``` +stateDiagram-v2 + [*] --> Wait_For_HLR_Response + state "Wait_For_HLR_Response" as Wait_For_HLR_Response + state "MAP_Update_GPRS_Location_cnf" as MAP_Update_GPRS_Location_cnf + state "MAP_INSERT_SUBSCRIBER_DATA_ind" as MAP_INSERT_SUBSCRIBER_DATA_ind + state "MAP_Notice_Indication" as MAP_Notice_Indication + state "MAP_U_Abort_ind, MAP_P_Abort_ind, MAP_Close_ind" as MAP_U_Abort_ind_MAP_P_Abort_ind_MAP_Close_ind + state "Check Confirmation" as CheckConfirmation["Check Confirmation (Section 25.2)"] + state "Insert Subscriber Data" as InsertSubscriberData + state "MAP_Close_request" as MAP_Close_request + state "Abort" as Abort + state "Update GPRS Location ack" as UpdateGPRSLocationAck + state "Set negative response" as SetNegativeResponse1[Set negative response] + state "Wait_For_HLR_or_Application_Response" as Wait_For_HLR_or_Application_Response + state "Set negative response" as SetNegativeResponse2[Set negative response] + state "Update GPRS Location negative response" as UpdateGPRSLocationNegativeResponse + state "Idle" as Idle + + Wait_For_HLR_Response --> MAP_Update_GPRS_Location_cnf + Wait_For_HLR_Response --> MAP_INSERT_SUBSCRIBER_DATA_ind + Wait_For_HLR_Response --> MAP_Notice_Indication + Wait_For_HLR_Response --> MAP_U_Abort_ind_MAP_P_Abort_ind_MAP_Close_ind + + MAP_Update_GPRS_Location_cnf --> CheckConfirmation + CheckConfirmation --> UpdateGPRSLocationAck : OK + CheckConfirmation --> SetNegativeResponse1 : Provider Error, User Error, Data Error + UpdateGPRSLocationAck --> Idle + SetNegativeResponse1 --> UpdateGPRSLocationNegativeResponse + UpdateGPRSLocationNegativeResponse --> Idle + + MAP_INSERT_SUBSCRIBER_DATA_ind --> InsertSubscriberData + InsertSubscriberData --> Wait_For_HLR_or_Application_Response + + MAP_Notice_Indication --> MAP_Close_request + MAP_Close_request --> SetNegativeResponse2 + SetNegativeResponse2 --> UpdateGPRSLocationNegativeResponse + UpdateGPRSLocationNegativeResponse --> Idle + + MAP_U_Abort_ind_MAP_P_Abort_ind_MAP_Close_ind --> Abort + Abort --> Idle +``` + +State transition diagram for Process GLR\_Update\_GPRS\_Location\_HLR. The diagram shows four main entry points from 'Wait\_For\_HLR\_Response': 1) MAP\_Update\_GPRS\_Location\_cnf leads to 'Check Confirmation' (Section 25.2), which results in 'Update GPRS Location ack' (OK) or 'Set negative response' (Provider Error, User Error, Data Error), both leading to 'Idle'. 2) MAP\_INSERT\_SUBSCRIBER\_DATA\_ind leads to 'Insert Subscriber Data', which leads to 'Wait\_For\_HLR\_or\_Application\_Response'. 3) MAP\_Notice\_Indication leads to 'MAP\_Close\_request', which leads to 'Set negative response', then 'Update GPRS Location negative response', and finally 'Idle'. 4) MAP\_U\_Abort\_ind, MAP\_P\_Abort\_ind, and MAP\_Close\_ind all lead to 'Abort', which leads to 'Idle'. + +Figure 19.1.2/5 (Sheet 2 of 3): Process GLR\_Update\_GPRS\_Location\_HLR + +![SDL Process Diagram for GLR_Update_GPRS_Location_HLR. The diagram illustrates the state transitions and signal handling for GPRS location updates. It includes states like 'Wait_For_HLR_or_Application_Response' and 'Idle', inputs like 'MAP_INSERT_SUBSCRIBER_DATA_ind', and various decision points and tasks leading to either successful acknowledgement or error handling and abortion of the process.](c99bf3a0530a3e58f5f2d2790ba7441b_img.jpg) + +**Process GLR\_Update\_GPRS\_Location\_HLR** 19.1.2.5\_3(3) + +GLR MAP protocol machine handling Location Management and interfacing to HLR MAP protocol machine, handling Location Management. + +Signals to/from the left are to/from the GLR application. + + Signals to/from the right are to/from the HLR MAP protocol machine. + +``` + + stateDiagram-v2 + state "Wait_For_HLR_or_Application_Response" as Wait1 + state "Wait_For_HLR_or_Application_Response" as Wait2 + state "Idle" as Idle1 + state "Idle" as Idle2 + + Wait1 --> MAP_INSERT_SUBSCRIBER_DATA_ind + MAP_INSERT_SUBSCRIBER_DATA_ind --> Insert_Subscriber_Data_Decision + + Insert_Subscriber_Data_Decision --> Insert_Subscriber_Data_ack + Insert_Subscriber_Data_Decision --> Insert_Subscriber_Data_negative_response + + Insert_Subscriber_Data_ack --> MAP_Insert_Subscriber_Data_response + Insert_Subscriber_Data_negative_response --> Set_user_error + Set_user_error --> MAP_Insert_Subscriber_Data_response + + MAP_Insert_Subscriber_Data_response --> Wait2 + + Wait2 --> MAP_Update_GPRS_Location_cnf + Wait2 --> Abort_Input + Wait2 --> MAP_Notice_Indication + Wait2 --> MAP_Abort_Ind_Group + + MAP_Update_GPRS_Location_cnf --> Check_Confirmation + Check_Confirmation --> OK_Path + Check_Confirmation --> Error_Path + + OK_Path --> Update_GPRS_Location_ack + Update_GPRS_Location_ack --> Idle1 + + Error_Path --> Set_negative_response_1 + Set_negative_response_1 --> Update_GPRS_Location_negative_response_1 + Update_GPRS_Location_negative_response_1 --> Idle1 + + Abort_Input --> Map_U_Abort_request + Map_U_Abort_request --> Idle2 + + MAP_Notice_Indication --> MAP_Close_request + MAP_Close_request --> Set_negative_response_2 + Set_negative_response_2 --> Update_GPRS_Location_negative_response_2 + Update_GPRS_Location_negative_response_2 --> Idle2 + + MAP_Abort_Ind_Group --> Abort_Task + Abort_Task --> Idle2 + +``` + +SDL Process Diagram for GLR\_Update\_GPRS\_Location\_HLR. The diagram illustrates the state transitions and signal handling for GPRS location updates. It includes states like 'Wait\_For\_HLR\_or\_Application\_Response' and 'Idle', inputs like 'MAP\_INSERT\_SUBSCRIBER\_DATA\_ind', and various decision points and tasks leading to either successful acknowledgement or error handling and abortion of the process. + +**Figure 19.1.2/5 (Sheet 3 of 3): Process GLR\_Update\_GPRS\_Location\_HLR** + +### 19.1.2 Location Cancellation + +#### 19.1.2.1 General + +The purpose of this process is to delete a subscriber's record from a previous GLR/VLR/SGSN after she has registered with a new GLR/VLR/SGSN. The procedure may also be used if the subscriber's record is to be deleted for other operator determined purposes. Location cancellation can be used to enforce location updating including updating of subscriber data in the VLR or in the SGSN at the next subscriber access. + +In all cases, the process is performed independently of the invoking process (e.g. Location Updating). + +If GLR is located between the VLR or the SGSN and the HLR, the MAP\_CANCEL\_LOCATION service is invoked towards the GLR whose identity is contained in the HLR table. + +![Sequence diagram for Figure 19.1.3/1: Interface and services for Location Cancellation. The diagram shows four entities: VLR/GLR, HLR, PGLR, and PVLR. The HLR is connected to each of the other three entities by dashed lines labeled 'D'. The sequence of messages is: 1. VLR/GLR sends a solid line 'MAP_UPDATE_LOCATION' to HLR. 2. HLR sends a dotted line 'MAP_CANCEL_LOCATION' to PGLR. 3. PGLR sends a dotted line 'MAP_CANCEL_LOCATION' to PVLR. 4. PGLR sends a solid line 'MAP_CANCEL_LOCATION' back to HLR. 5. HLR sends a solid line 'ack' back to PGLR. 6. PVLR sends a solid line 'MAP_CANCEL_LOCATION' back to PGLR. 7. PGLR sends a solid line 'ack' back to PVLR.](50214d232017279410e9c9db8eb75119_img.jpg) + +Sequence diagram for Figure 19.1.3/1: Interface and services for Location Cancellation. The diagram shows four entities: VLR/GLR, HLR, PGLR, and PVLR. The HLR is connected to each of the other three entities by dashed lines labeled 'D'. The sequence of messages is: 1. VLR/GLR sends a solid line 'MAP\_UPDATE\_LOCATION' to HLR. 2. HLR sends a dotted line 'MAP\_CANCEL\_LOCATION' to PGLR. 3. PGLR sends a dotted line 'MAP\_CANCEL\_LOCATION' to PVLR. 4. PGLR sends a solid line 'MAP\_CANCEL\_LOCATION' back to HLR. 5. HLR sends a solid line 'ack' back to PGLR. 6. PVLR sends a solid line 'MAP\_CANCEL\_LOCATION' back to PGLR. 7. PGLR sends a solid line 'ack' back to PVLR. + +NOTE: The service shown in dotted lines indicates the trigger provided by other MAP signalling. + +**Figure 19.1.3/1: Interface and services for Location Cancellation** + +![Sequence diagram for Figure 19.1.3/2: Interface and services for Location Cancellation in GPRS. The diagram shows four entities: SGSN/GLR, HLR, PGLR, and PSGSN. The HLR is connected to each of the other three entities by dashed lines labeled 'D'. The sequence of messages is: 1. SGSN/GLR sends a solid line 'MAP_UPDATE_GPRS_LOCATION' to HLR. 2. HLR sends a dotted line 'MAP_CANCEL_LOCATION' to PGLR. 3. PGLR sends a dotted line 'MAP_CANCEL_LOCATION' to PSGSN. 4. PGLR sends a solid line 'MAP_CANCEL_LOCATION' back to HLR. 5. HLR sends a solid line 'ack' back to PGLR. 6. PSGSN sends a solid line 'MAP_CANCEL_LOCATION' back to PGLR. 7. PGLR sends a solid line 'ack' back to PSGSN.](4c9ba399ca7df11cbe9b6322cd9aee0a_img.jpg) + +Sequence diagram for Figure 19.1.3/2: Interface and services for Location Cancellation in GPRS. The diagram shows four entities: SGSN/GLR, HLR, PGLR, and PSGSN. The HLR is connected to each of the other three entities by dashed lines labeled 'D'. The sequence of messages is: 1. SGSN/GLR sends a solid line 'MAP\_UPDATE\_GPRS\_LOCATION' to HLR. 2. HLR sends a dotted line 'MAP\_CANCEL\_LOCATION' to PGLR. 3. PGLR sends a dotted line 'MAP\_CANCEL\_LOCATION' to PSGSN. 4. PGLR sends a solid line 'MAP\_CANCEL\_LOCATION' back to HLR. 5. HLR sends a solid line 'ack' back to PGLR. 6. PSGSN sends a solid line 'MAP\_CANCEL\_LOCATION' back to PGLR. 7. PGLR sends a solid line 'ack' back to PSGSN. + +NOTE: The service shown in dotted lines indicates the trigger provided by other MAP signalling. + +**Figure 19.1.3/2: Interface and services for Location Cancellation in GPRS** + +Additionally, The MAP\_CANCEL\_LOCATION service is invoked when the GLR that stores the subscriber's record receives a MAP\_UPDATE\_LOCATION indication from a VLR other than that stored in its table for this subscriber. Also the MAP\_CANCEL\_LOCATION service is invoked when the GLR that stores the subscriber's record a MAP\_UPDATE\_GPRS\_LOCATION indication from a SGSN other than stored in its table for this subscriber. The MAP\_CANCEL\_LOCATION service is in any case invoked towards the VLR or the SGSN whose identity is contained in the HLR table. + +![Sequence diagram showing MAP UPDATE LOCATION, MAP_CANCEL_LOCATION, and MAP_CANCEL_LOCATION messages between VLR/SGSN, GLR, and PVL/PSGSN entities.](8269648391c59363ea61243864a2adf7_img.jpg) + +The diagram illustrates a sequence of messages between three entities: VLR/SGSN, GLR, and PVL/PSGSN. The entities are represented by boxes with dashed borders. The first entity (VLR/SGSN) sends a 'MAP\_UPDATE\_LOCATION or MAP\_UPDATE\_GPRS\_LOCATION' message to the second entity (GLR). The second entity (GLR) then sends a 'MAP\_CANCEL\_LOCATION' message to the third entity (PVL/PSGSN). Finally, the third entity (PVL/PSGSN) sends a 'MAP\_CANCEL\_LOCATION' message back to the second entity (GLR), which responds with an 'ack' (acknowledgment) message. + +``` +sequenceDiagram + participant VLR/SGSN + participant GLR + participant PVL/PSGSN + Note over VLR/SGSN, GLR: D + Note over GLR, PVL/PSGSN: D + VLR/SGSN->>GLR: MAP_UPDATE_LOCATION or MAP_UPDATE_GPRS_LOCATION + GLR->>PVL/PSGSN: MAP_CANCEL_LOCATION + PVL/PSGSN->>GLR: MAP_CANCEL_LOCATION + GLR-->>PVL/PSGSN: ack +``` + +Sequence diagram showing MAP UPDATE LOCATION, MAP\_CANCEL\_LOCATION, and MAP\_CANCEL\_LOCATION messages between VLR/SGSN, GLR, and PVL/PSGSN entities. + +**Figure 19.1.3/4: Interface and services for Location Cancellation in case that the GLR stores the subscriber's record** + +#### 19.1.2.2 Detailed procedure in the GLR + +Figure 19.1.3/5 shows the Process Cancel\_Location\_GLR. This process is a GLR MAP protocol machine handling location cancellation and is a responder to the HLR. + +![State transition diagram for Process Cancel_Location_GLR. It starts with an initial state leading to NULL, then Receive Open Ind. From there, it branches into WAIT_FOR_SERVICE_PRIMITIVE (OK), Perform_MAP_Vr_Dialogue (V2), and NULL (V1 Error). The main path goes through MAP_CANCEL_LOCATION_ind, Cancel Location, and WAIT_FOR_APPLICATION_RESPONSE to reach final NULL states via MAP_CANCEL_LOCATION_Rsp.MAP_CLOSE_Req. or MAP_U_ABORT_req.](32ff77da4286b58c4778033acaa10836_img.jpg) + +### Process Cancel\_Location\_GLR + +19.1.3.5(1) + +GLR MAP protocol machine handling Location cancelation and interfacing to HLR MAP protocol machine, handling Location Cancelation. + +Signals to/from the left are to/from the GLR Location cancellation application. + +Signals to/from the right are to/from the HLR MAP protocol machine, handling Location Cancellation. + +``` +stateDiagram-v2 + [*] --> NULL1[NULL] + NULL1 --> ReceiveOpenInd[Receive Open Ind.] + ReceiveOpenInd --> WAIT_FOR_SERVICE_PRIMITIVE[WAIT_FOR_SERVICE_PRIMITIVE] : OK + ReceiveOpenInd --> Perform_MAP_Vr_Dialogue[Perform_MAP_Vr_Dialogue] : V2 + ReceiveOpenInd --> NULL2[NULL] : V1 Error + WAIT_FOR_SERVICE_PRIMITIVE --> MAP_CANCEL_LOCATION_ind[MAP_CANCEL_LOCATION_ind] + WAIT_FOR_SERVICE_PRIMITIVE --> MAP_NOTICE_ind[MAP_NOTICE_ind] + MAP_NOTICE_ind --> MAP_CLOSE_req[MAP_CLOSE_req] + MAP_CLOSE_req --> NULL3[NULL] + MAP_CANCEL_LOCATION_ind --> CancelLocation{Cancel Location} + CancelLocation --> WAIT_FOR_APPLICATION_RESPONSE[WAIT_FOR_APPLICATION_RESPONSE] + WAIT_FOR_APPLICATION_RESPONSE --> CancelLocationAck{Cancel Location Ack} + WAIT_FOR_APPLICATION_RESPONSE --> CancelLocationNegativeResponse{Cancel Location Negative response} + WAIT_FOR_APPLICATION_RESPONSE --> Abort{Abort} + CancelLocationAck --> MAP_CANCEL_LOCATION_Rsp_MAP_CLOSE_Req[MAP_CANCEL_LOCATION_Rsp. MAP_CLOSE_Req.] + CancelLocationNegativeResponse --> MAP_CANCEL_LOCATION_Rsp_MAP_CLOSE_Req + MAP_CANCEL_LOCATION_Rsp_MAP_CLOSE_Req --> NULL4[NULL] + Abort --> MAP_U_ABORT_req[MAP_U_ABORT_req] + MAP_U_ABORT_req --> NULL5[NULL] +``` + +State transition diagram for Process Cancel\_Location\_GLR. It starts with an initial state leading to NULL, then Receive Open Ind. From there, it branches into WAIT\_FOR\_SERVICE\_PRIMITIVE (OK), Perform\_MAP\_Vr\_Dialogue (V2), and NULL (V1 Error). The main path goes through MAP\_CANCEL\_LOCATION\_ind, Cancel Location, and WAIT\_FOR\_APPLICATION\_RESPONSE to reach final NULL states via MAP\_CANCEL\_LOCATION\_Rsp.MAP\_CLOSE\_Req. or MAP\_U\_ABORT\_req. + +Figure 19.1.3/5: Process Cancel\_Location\_GLR + +Figure 19.1.3/6 shows the Process GLR\_Cancel\_Location\_VLR. This process is a GLR MAP protocol machine handling location cancellation and is an initiator to the VLR. + +Sheet 1: If the Macro Open\_Receive\_Cnf results Vr, the process requests to perform MAP Vr. It causes a request for sending an abort message to Process Cancel\_Location\_GLR. + +![State transition diagram for Process GLR_Cancel_Location_VLR. The process starts at an initial state leading to IDLE. From IDLE, a 'Cancel Location' request is sent. The next state is a decision point for 'Receive Open Cnf.' with three possible outcomes: 'OK' leading to 'WAIT_FOR_ACK', 'Vr' leading to 'Perform MAP_Vr', and 'Error' leading to 'Cancel Location Negative Response'. 'WAIT_FOR_ACK' leads to 'MAP_CANCEL_LOCATION_Cnf', which leads to 'Check Confirmation'. 'Check Confirmation' has two outcomes: 'OK' leading to 'Cancel Location Ack', and 'Error' leading to 'Cancel Location Negative Response'. 'Perform MAP_Vr' and 'Cancel Location Negative Response' both lead to terminal states (crossed out). 'MAP_CANCEL_LOCATION_Cnf' also leads to 'MAP_P_ABORT_Ind' and 'MAP_NOTICE_Ind'. 'MAP_P_ABORT_Ind' leads to 'Cancel Location Negative Response' (terminal). 'MAP_NOTICE_Ind' leads to 'MAP_CLOSE_Req', which leads to 'Cancel Location Negative Response' (terminal).](67d03c9e89620d73e3786c869e559752_img.jpg) + +**Process GLR\_Cancel\_Location\_VLR** 19.1.3.6(1) + +``` +graph TD; Start([ ]) --> IDLE[/IDLE/]; IDLE --> CL{Cancel Location}; CL --> ROCnf{Receive Open Cnf.}; ROCnf -- OK --> WFA[/WAIT_FOR_ACK/]; ROCnf -- Vr --> PMVr[/Perform MAP_Vr/]; ROCnf -- Error --> CLNR1[/Cancel Location Negative Response/]; WFA --> MCLCnf{MAP_CANCEL_LOCATION_Cnf}; MCLCnf --> CC[Check Confirmation]; CC -- OK --> CLA[/Cancel Location Ack/]; CC -- Error --> CLNR2[/Cancel Location Negative Response/]; PMVr --> X1((X)); CLNR1 --> X2((X)); MCLCnf --> MPAINd{MAP_P_ABORT_Ind}; MPAINd --> CLNR3[/Cancel Location Negative Response/]; CLNR3 --> X3((X)); MCLCnf --> MNInd{MAP_NOTICE_Ind}; MNInd --> MCReq{MAP_CLOSE_Req}; MCReq --> CLNR4[/Cancel Location Negative Response/]; CLNR4 --> X4((X)); +``` + +Notes: + +- GLR MAP protocol machine handling cancel location and interfacing with VLR MAP protocol machine +- VLR to the Left +GLR Application to the Right + +State transition diagram for Process GLR\_Cancel\_Location\_VLR. The process starts at an initial state leading to IDLE. From IDLE, a 'Cancel Location' request is sent. The next state is a decision point for 'Receive Open Cnf.' with three possible outcomes: 'OK' leading to 'WAIT\_FOR\_ACK', 'Vr' leading to 'Perform MAP\_Vr', and 'Error' leading to 'Cancel Location Negative Response'. 'WAIT\_FOR\_ACK' leads to 'MAP\_CANCEL\_LOCATION\_Cnf', which leads to 'Check Confirmation'. 'Check Confirmation' has two outcomes: 'OK' leading to 'Cancel Location Ack', and 'Error' leading to 'Cancel Location Negative Response'. 'Perform MAP\_Vr' and 'Cancel Location Negative Response' both lead to terminal states (crossed out). 'MAP\_CANCEL\_LOCATION\_Cnf' also leads to 'MAP\_P\_ABORT\_Ind' and 'MAP\_NOTICE\_Ind'. 'MAP\_P\_ABORT\_Ind' leads to 'Cancel Location Negative Response' (terminal). 'MAP\_NOTICE\_Ind' leads to 'MAP\_CLOSE\_Req', which leads to 'Cancel Location Negative Response' (terminal). + +Figure 19.1.3/6: Process GLR\_Cancel\_Location\_VLR + +Figure 19.1.3/7 shows the Process Cancel\_GPRS\_Location\_GLR. This process is a GLR MAP protocol machine handling location cancellation and is a responder to the HLR. + +![State transition diagram for Process Cancel_GPRS_Location_GLR. The process starts at an initial state leading to NULL, then receives an Open Indication. It then branches based on the response: OK leads to WAIT_FOR_SERVICE_PRIMITIVE; V2 leads to Perform_MAP_Vr_Dialogue; V1 Error leads to NULL. From WAIT_FOR_SERVICE_PRIMITIVE, it branches to MAP_CANCEL_LOCATION_ind (leading to Cancel Location) or MAP_NOTICE_ind (leading to MAP_CLOSE_req). Both lead to NULL. From Cancel Location, it goes to WAIT_FOR_APPLICATION_RESPONSE, which then branches to Cancel Location Ack (leading to MAP_CANCEL_LOCATION_Rsp. MAP_CLOSE_Req.) or Cancel Location Negative Response (leading to NULL). From Abort, it goes to MAP_U_ABORT_req. Both lead to NULL.](a161a2bbb4d830e847ccb4f44b7e41a9_img.jpg) + +### Process Cancel\_GPRS\_Location\_GLR + +19.1.3.7(1) + +GLR MAP protocol machine handling Location cancellation and interfacing to HLR MAP protocol machine, handling Location Cancellation. + +Signals to/from the right are to/from the GLR Location cancellation application. + +Signals to/from the left are to/from the HLR MAP protocol machine, handling Location Cancellation. + +``` +stateDiagram-v2 + [*] --> NULL1[NULL] + NULL1 --> Receive_Open_Ind[Receive Open Ind.] + Receive_Open_Ind --> OK + Receive_Open_Ind --> V2 + Receive_Open_Ind --> V1_Error[V1 Error] + OK --> WAIT_FOR_SERVICE_PRIMITIVE + V2 --> Perform_MAP_Vr_Dialogue + V1_Error --> NULL2[NULL] + Perform_MAP_Vr_Dialogue --> NULL3[NULL] + WAIT_FOR_SERVICE_PRIMITIVE --> MAP_CANCEL_LOCATION_ind + WAIT_FOR_SERVICE_PRIMITIVE --> MAP_NOTICE_ind + MAP_CANCEL_LOCATION_ind --> Cancel_Location + MAP_NOTICE_ind --> MAP_CLOSE_req + Cancel_Location --> WAIT_FOR_APPLICATION_RESPONSE + MAP_CLOSE_req --> NULL4[NULL] + WAIT_FOR_APPLICATION_RESPONSE --> Cancel_Location_Ack + WAIT_FOR_APPLICATION_RESPONSE --> Cancel_Location_Negative_Response + WAIT_FOR_APPLICATION_RESPONSE --> Abort + Cancel_Location_Ack --> MAP_CANCEL_LOCATION_Rsp_MAP_CLOSE_Req + Cancel_Location_Negative_Response --> NULL5[NULL] + Abort --> MAP_U_ABORT_req + MAP_CANCEL_LOCATION_Rsp_MAP_CLOSE_Req --> NULL6[NULL] + MAP_U_ABORT_req --> NULL7[NULL] +``` + +State transition diagram for Process Cancel\_GPRS\_Location\_GLR. The process starts at an initial state leading to NULL, then receives an Open Indication. It then branches based on the response: OK leads to WAIT\_FOR\_SERVICE\_PRIMITIVE; V2 leads to Perform\_MAP\_Vr\_Dialogue; V1 Error leads to NULL. From WAIT\_FOR\_SERVICE\_PRIMITIVE, it branches to MAP\_CANCEL\_LOCATION\_ind (leading to Cancel Location) or MAP\_NOTICE\_ind (leading to MAP\_CLOSE\_req). Both lead to NULL. From Cancel Location, it goes to WAIT\_FOR\_APPLICATION\_RESPONSE, which then branches to Cancel Location Ack (leading to MAP\_CANCEL\_LOCATION\_Rsp. MAP\_CLOSE\_Req.) or Cancel Location Negative Response (leading to NULL). From Abort, it goes to MAP\_U\_ABORT\_req. Both lead to NULL. + +Figure 19.1.3/7: Process Cancel\_GPRS\_Location\_GLR + +Figure 19.1.3/8 shows the Process GLR\_Cancel\_Location\_SGSN. This process is a GLR MAP protocol machine handling location cancellation and is an initiator to the SGSN. + +Sheet 1: If the Macro Open\_Receive\_Cnf results Vr, the process requests to perform MAP Vr. It causes a request for sending an abort message to Process Cancel\_GPRS\_Location\_GLR. + +![](69e5f1993021af230d08c08aac97d9df_img.jpg) + +**Process GLR\_Cancel\_Location\_SGSN** 19.1.3.8(1) + +GLR MAP protocol machine handling cancel location and interfacing with SGSN MAP protocol machine + +SGSN to the Left +GLR Application to the Right + +``` + +stateDiagram-v2 + [*] --> IDLE + IDLE --> Cancel_Location : Input from Right + Cancel_Location --> Send_Reqs + state Send_Reqs <> + note right of Send_Reqs + MAP_OPEN_Req + MAP_CANCEL_LOCATION_Req + MAP_DELIMITER_Req + end note + Send_Reqs --> Receive_Open_Cnf + state Receive_Open_Cnf { + OK --> WAIT_FOR_ACK + Vr --> Perform_MAP_Vr + Error --> Cancel_Location_Negative_Response_1 + } + Perform_MAP_Vr --> [*] + Cancel_Location_Negative_Response_1 --> [*] + + WAIT_FOR_ACK --> MAP_CANCEL_LOCATION_Cnf + WAIT_FOR_ACK --> MAP_P_ABORT_Ind + WAIT_FOR_ACK --> MAP_NOTICE_Ind + + MAP_CANCEL_LOCATION_Cnf --> Check_Confirmation + Check_Confirmation --> OK_2 : OK + Check_Confirmation --> Error_2 : Error + OK_2 --> Cancel_Location_Ack + Error_2 --> Cancel_Location_Negative_Response_2 + + MAP_P_ABORT_Ind --> Cancel_Location_Negative_Response_3 + + MAP_NOTICE_Ind --> MAP_CLOSE_Req + MAP_CLOSE_Req --> Cancel_Location_Negative_Response_4 + + Cancel_Location_Ack --> [*] + Cancel_Location_Negative_Response_2 --> [*] + Cancel_Location_Negative_Response_3 --> [*] + Cancel_Location_Negative_Response_4 --> [*] + +``` + +Figure 19.1.3/8: Process GLR\_Cancel\_Location\_SGSN + +### 19.1.3 Purge MS + +#### 19.1.3.1 General + +This Purge MS procedure is used to treat any request for routing information for a mobile terminated call or a mobile terminated short message as if the MS is not reachable. + +If GLR is located between the VLR or the SGSN and the HLR, the MAP\_PURGE\_MS service is invoked towards the GLR whose identity is contained in the VLR table or the SGSN table. + +When the GLR receives a MAP\_PURGE\_MS indication, the GLR determines whether it invokes the MAP\_PURGE\_MS service towards the HLR. + +![Sequence diagram showing the interface and services for Purge MS between VLR/SGSN, GLR, and HLR.](36fd537a1e39baa2471ecfaaf869751a_img.jpg) + +The diagram illustrates the interaction between three network elements: VLR/SGSN, GLR, and HLR. The sequence of messages is as follows: + +- The VLR/SGSN sends a **MAP\_PURGE\_MS** message to the GLR. +- The GLR then sends a **MAP\_PURGE\_MS** message to the HLR. +- The HLR responds with a **MAP\_PURGE\_MS ack** message to the GLR. +- Finally, the GLR sends a **MAP\_PURGE\_MS ack** message back to the VLR/SGSN. + +Sequence diagram showing the interface and services for Purge MS between VLR/SGSN, GLR, and HLR. + +**Figure 19.1.4/1: Interface and services for Purge MS** + +#### 19.1.3.2 Detailed procedure in GLR + +Figure 19.1.4/2 shows the Process Purge\_MS\_GLR. This process is a GLR MAP protocol machine handling purge MS and is a responder to the VLR. + +![State transition diagram for Process Purge_MS_GLR. The process starts at a NULL state, receives an Open Indication, and then branches based on OK, V2, or V1 Error. The main path involves performing a MAP Vr Dialogue, receiving a Purge MS indication, purging the MS, waiting for an application response, and then either sending a Purge MS Ack (leading to a response and back to NULL) or an Abort (leading to a MAP_U_ABORT_req and back to NULL).](8d66c9c295023a1380f9986d3663bb1e_img.jpg) + +### Process Purge\_MS\_GLR + +19.1.4.2(1) + +GLR MAP protocol machine handling purge MS + +VLR to the Left +GLR Application to the Right + +``` +stateDiagram-v2 + [*] --> NULL1[NULL] + NULL1 --> Receive_Open_Ind[Receive Open Ind.] + Receive_Open_Ind --> WAIT_FOR_SERVICE_PRIMITIVE: OK + Receive_Open_Ind --> Perform_MAP_Vr_Dialogue: V2 + Receive_Open_Ind --> NULL2[NULL]: V1 Error + WAIT_FOR_SERVICE_PRIMITIVE --> MAP_NOTICE_Ind{MAP_NOTICE_Ind} + Perform_MAP_Vr_Dialogue --> NULL3[NULL] + NULL3 --> MAP_PURGE_MS_Ind{MAP_PURGE_MS_Ind} + MAP_NOTICE_Ind --> MAP_CLOSE_Req{MAP_CLOSE_Req} + MAP_CLOSE_Req --> [*]: X + MAP_PURGE_MS_Ind --> Purge_MS{Purge MS} + Purge_MS --> WAIT_FOR_APPLICATION_RESPONSE{WAIT_FOR APPLICATION RESPONSE} + WAIT_FOR_APPLICATION_RESPONSE --> Purge_MS_Ack{Purge MS Ack} + WAIT_FOR_APPLICATION_RESPONSE --> Purge_MS_Negative_Response{Purge MS Negative Response} + WAIT_FOR_APPLICATION_RESPONSE --> Abort{Abort} + Purge_MS_Ack --> MAP_PURGE_MS_Rsp_MAP_CLOSE_Req{MAP_PURGE_MS_Rsp +MAP_CLOSE_Req} + Purge_MS_Negative_Response --> MAP_PURGE_MS_Rsp_MAP_CLOSE_Req + Purge_MS_Negative_Response --> MAP_U_ABORT_req{MAP_U_ABORT_req} + MAP_PURGE_MS_Rsp_MAP_CLOSE_Req --> NULL4[NULL] + MAP_U_ABORT_req --> NULL5[NULL] +``` + +State transition diagram for Process Purge\_MS\_GLR. The process starts at a NULL state, receives an Open Indication, and then branches based on OK, V2, or V1 Error. The main path involves performing a MAP Vr Dialogue, receiving a Purge MS indication, purging the MS, waiting for an application response, and then either sending a Purge MS Ack (leading to a response and back to NULL) or an Abort (leading to a MAP\_U\_ABORT\_req and back to NULL). + +Figure 19.1.4/2: Process Purge\_MS\_GLR + +Figure 19.1.4/3 shows the Process GLR\_Purge\_MS\_HLR. This process is a GLR MAP protocol machine handling purge MS and is an initiator to the HLR. + +![State transition diagram for Process GLR_Purge_MS_HLR. The process starts at a 'Null' state, transitions to 'Purge MS', then to a state where it sends 'MAP_OPEN_Req', 'MAP_PURGE_MS_Req', and 'MAP_DELIMITER_Req'. It then receives an 'Open Cnf' (Section 25.1). From there, it can either 'Perform MAP Vr' (leading to an error state with 'Set error' and 'Purge MS Negative Response') or 'Wait_For_HLR_Response' (labeled 'OK'). The 'Wait_For_HLR_Response' state leads to three possible outcomes: 'MAP_PURGE_MS_cnf' (leading to 'Check Confirmation' and then 'Purge MS ack' if 'OK'), 'MAP_Notice_Indication' (leading to 'MAP_Close_request'), and 'MAP_U_Abort_ind', 'MAP_P_Abort_ind', 'MAP_Close_ind' (all leading to 'Set negative response'). Both 'Check Confirmation' and 'Set negative response' lead to 'Purge MS negative response', which then returns to the 'Null' state. A 'Provider Error, User Error, Data Error' also leads to 'Set negative response'.](7e61b2e2506cc7e5d6e16ce9c9df25bb_img.jpg) + +### Process GLR\_Purge\_MS\_HLR + +19.1.4.3(1) + +GLR MAP protocol machine handling purge MS and interfacing to HLR MAP protocol machine, handling Purge MS. + +Signals to/from the left are to/from the GLR application. + +Signals to/from the right are to/from the HLR MAP protocol machine. + +``` +stateDiagram-v2 + [*] --> Null + Null --> Purge_MS: Purge MS + Purge_MS --> Send_Requests: MAP_OPEN_Req, MAP_PURGE_MS_Req, MAP_DELIMITER_Req + Send_Requests --> Receive_Open_Cnf: Section 25.1 + Receive_Open_Cnf --> Perform_MAP_Vr: Vr + Receive_Open_Cnf --> Wait_For_HLR_Response: OK + Perform_MAP_Vr --> Error: Error + Error --> Set_error: Set error + Set_error --> Purge_MS_Negative_Response: Purge MS Negative Response + Purge_MS_Negative_Response --> [*] + Wait_For_HLR_Response --> MAP_PURGE_MS_cnf: MAP_PURGE_MS_cnf + Wait_For_HLR_Response --> MAP_Notice_Indication: MAP_Notice_Indication + Wait_For_HLR_Response --> Abort_Indications: MAP_U_Abort_ind, MAP_P_Abort_ind, MAP_Close_ind + MAP_PURGE_MS_cnf --> Check_Confirmation: Check Confirmation + Check_Confirmation --> Purge_MS_ack: Purge MS ack + Purge_MS_ack --> Null + MAP_Notice_Indication --> MAP_Close_request: MAP_Close_request + MAP_Close_request --> [*] + Abort_Indications --> Set_negative_response: Set negative response + Set_negative_response --> Purge_MS_negative_response: Purge MS negative response + Purge_MS_negative_response --> Null + Provider_Error: Provider Error, User Error, Data Error --> Set_negative_response +``` + +State transition diagram for Process GLR\_Purge\_MS\_HLR. The process starts at a 'Null' state, transitions to 'Purge MS', then to a state where it sends 'MAP\_OPEN\_Req', 'MAP\_PURGE\_MS\_Req', and 'MAP\_DELIMITER\_Req'. It then receives an 'Open Cnf' (Section 25.1). From there, it can either 'Perform MAP Vr' (leading to an error state with 'Set error' and 'Purge MS Negative Response') or 'Wait\_For\_HLR\_Response' (labeled 'OK'). The 'Wait\_For\_HLR\_Response' state leads to three possible outcomes: 'MAP\_PURGE\_MS\_cnf' (leading to 'Check Confirmation' and then 'Purge MS ack' if 'OK'), 'MAP\_Notice\_Indication' (leading to 'MAP\_Close\_request'), and 'MAP\_U\_Abort\_ind', 'MAP\_P\_Abort\_ind', 'MAP\_Close\_ind' (all leading to 'Set negative response'). Both 'Check Confirmation' and 'Set negative response' lead to 'Purge MS negative response', which then returns to the 'Null' state. A 'Provider Error, User Error, Data Error' also leads to 'Set negative response'. + +Figure 19.1.4/3: Process GLR\_PURGE\_MS\_HLR + +Figure 19.1.4/4 shows the Process Purge\_MS\_GLR\_for\_GPRS. This process is a GLR MAP protocol machine handling purge MS and is a responder to the SGSN. + +Sheet 1: If the Macro Open\_Receive\_Cnf results Vr, the process requests to perform MAP Vr. It causes a request for sending an abort message to Process PURGE\_MS\_GLR. + +![State transition diagram for Process Purge_MS_GLR_for_GPRS. The process starts at a NULL state, receives an Open Indication, and then branches based on the result: OK leads to WAIT_FOR_SERVICE_PRIMITIVE, V2 leads to Perform_MAP_Vr_Dialogue, and V1 Error leads to NULL. From WAIT_FOR_SERVICE_PRIMITIVE, it can send a MAP_NOTICE_Ind or a MAP_PURGE_MS_Ind. The MAP_PURGE_MS_Ind path continues with Purge MS, WAIT_FOR_APPLICATION_RESPONSE, and then branches based on the response: Purge MS Ack, Purge MS Negative Response, or Abort. The Ack and Negative Response both lead to a state with MAP_PURGE_MS_Rsp and MAP_CLOSE_Req, which then leads to NULL. The Abort path leads to MAP_U_ABORT_req and then to NULL.](036c200da9b64c3eb5aae2d67bb53e1f_img.jpg) + +**Process Purge\_MS\_GLR\_for\_GPRS** 19.1.4.4(1) + +GLR MAP protocol machine handling purge MS + +SGSN to the Left +GLR Application to the Right + +``` +stateDiagram-v2 + [*] --> NULL1[NULL] + NULL1 --> Receive_Open_Ind[Receive Open Ind.] + Receive_Open_Ind --> OK: OK + Receive_Open_Ind --> V2: V2 + Receive_Open_Ind --> V1_Error: V1 Error + OK --> WAIT_FOR_SERVICE_PRIMITIVE[WAIT_FOR_SERVICE_PRIMITIVE] + V2 --> Perform_MAP_Vr_Dialogue[Perform_MAP_Vr_Dialogue] + V1_Error --> NULL2[NULL] + Perform_MAP_Vr_Dialogue --> NULL3[NULL] + WAIT_FOR_SERVICE_PRIMITIVE --> MAP_NOTICE_Ind{MAP_NOTICE_Ind} + WAIT_FOR_SERVICE_PRIMITIVE --> MAP_PURGE_MS_Ind{MAP_PURGE_MS_Ind} + MAP_NOTICE_Ind --> MAP_CLOSE_Req1[MAP_CLOSE_Req] + MAP_CLOSE_Req1 --> X[ ] + MAP_PURGE_MS_Ind --> Purge_MS{Purge MS} + Purge_MS --> WAIT_FOR_APPLICATION_RESPONSE[WAIT_FOR_APPLICATION_RESPONSE] + WAIT_FOR_APPLICATION_RESPONSE --> Purge_MS_Ack{Purge MS Ack} + WAIT_FOR_APPLICATION_RESPONSE --> Purge_MS_Negative_Response{Purge MS Negative Response} + WAIT_FOR_APPLICATION_RESPONSE --> Abort{Abort} + Purge_MS_Ack --> MAP_PURGE_MS_Rsp[MAP_PURGE_MS_Rsp] + Purge_MS_Negative_Response --> MAP_PURGE_MS_Rsp + MAP_PURGE_MS_Rsp --> MAP_CLOSE_Req2[MAP_CLOSE_Req] + MAP_CLOSE_Req2 --> NULL4[NULL] + Abort --> MAP_U_ABORT_req[MAP_U_ABORT_req] + MAP_U_ABORT_req --> NULL5[NULL] +``` + +State transition diagram for Process Purge\_MS\_GLR\_for\_GPRS. The process starts at a NULL state, receives an Open Indication, and then branches based on the result: OK leads to WAIT\_FOR\_SERVICE\_PRIMITIVE, V2 leads to Perform\_MAP\_Vr\_Dialogue, and V1 Error leads to NULL. From WAIT\_FOR\_SERVICE\_PRIMITIVE, it can send a MAP\_NOTICE\_Ind or a MAP\_PURGE\_MS\_Ind. The MAP\_PURGE\_MS\_Ind path continues with Purge MS, WAIT\_FOR\_APPLICATION\_RESPONSE, and then branches based on the response: Purge MS Ack, Purge MS Negative Response, or Abort. The Ack and Negative Response both lead to a state with MAP\_PURGE\_MS\_Rsp and MAP\_CLOSE\_Req, which then leads to NULL. The Abort path leads to MAP\_U\_ABORT\_req and then to NULL. + +Figure 19.1.4/4: Process Purge\_MS\_GLR\_for\_GPRS + +Figure 19.1.4/5 shows the Process GLR\_Purge\_MS\_HLR\_for\_GPRS. This process is a GLR MAP protocol machine handling purge MS and is an initiator to the HLR. + +Sheet 1: If the Macro Open\_Receive\_Cnf results Vr, the process requests to perform MAP Vr. It causes a request for sending an abort message to Process PURGE\_MS\_HLR\_for\_GPRS. + +![SDL diagram for Process GLR_Purge_MS_HLR_for_GPRS. The flow starts at a Null state, receives a Purge MS signal, sends MAP_OPEN_Req, MAP_PURGE_MS_Req, and MAP_DELIMITER_Req. It then waits for Open Cnf. Depending on the result (OK, Vr, or Error), it transitions to Wait_For_HLR_Response, performs MAP Vr, or sets an error. From Wait_For_HLR_Response, it handles confirmation, notice indications, or aborts, eventually returning to the Null state or terminating.](aeb2a26a07219661191294dba528067a_img.jpg) + +**Process GLR\_Purge\_MS\_HLR\_for\_GPRS** 19.1.4.5(1) + +GLR MAP protocol machine handling purge MS and interfacing to HLR MAP protocol machine, handling Purge MS. + +Signals to/from the left are to/from the GLR application. + Signals to/from the right are to/from the HLR MAP protocol machine. + +``` + +stateDiagram-v2 + [*] --> Null + Null --> Purge_MS_Input : Purge MS + state Purge_MS_Input <> + Purge_MS_Input --> Send_Signals + state Send_Signals { + direction lr + MAP_OPEN_Req + MAP_PURGE_MS_Req + MAP_DELIMITER_Req + } + Send_Signals --> Receive_Open_Cnf + state Receive_Open_Cnf { + Vr --> Perform_MAP_Vr + Perform_MAP_Vr --> Terminate1 : X + OK --> Wait_For_HLR_Response + Error --> Set_error + Set_error --> Purge_MS_Negative_Response + Purge_MS_Negative_Response --> Terminate2 : X + } + state Wait_For_HLR_Response { + MAP_PURGE_MS_cnf --> Check_Confirmation + Check_Confirmation --> OK_Result + OK_Result --> Purge_MS_ack + Purge_MS_ack --> Null + Check_Confirmation --> Error_Result + Error_Result --> Set_negative_response + Set_negative_response --> Purge_MS_negative_response_out + Purge_MS_negative_response_out --> Null + + MAP_Notice_Indication --> MAP_Close_request + MAP_Close_request --> Terminate3 : X + + Abort_Signals --> Set_negative_response_abort + state Abort_Signals { + MAP_U_Abort_ind + MAP_P_Abort_ind + MAP_Close_ind + } + Set_negative_response_abort --> Purge_MS_negative_response_abort + Purge_MS_negative_response_abort --> Terminate4 : X + } + +``` + +SDL diagram for Process GLR\_Purge\_MS\_HLR\_for\_GPRS. The flow starts at a Null state, receives a Purge MS signal, sends MAP\_OPEN\_Req, MAP\_PURGE\_MS\_Req, and MAP\_DELIMITER\_Req. It then waits for Open Cnf. Depending on the result (OK, Vr, or Error), it transitions to Wait\_For\_HLR\_Response, performs MAP Vr, or sets an error. From Wait\_For\_HLR\_Response, it handles confirmation, notice indications, or aborts, eventually returning to the Null state or terminating. + +Figure 19.1.4/5: Process GLR\_Purge\_MS\_HLR\_for\_GPRS + +## 19.2 Fault recovery procedures + +### 19.2.1 RESET procedure + +This procedure is used to notify VLR, SGSN and GLR of the failure of the node for restoration of the subscriber data. + +#### 19.2.1.1 HLR failure case + +In the case of HLR failure, the HLR invokes MAP\_RESET service towards the affected GLR, if GLR is located between the VLR and the HLR or between the SGSN and the HLR. When a GLR receives MAP\_RESET indication, it sends a MAP\_RESET message to the affected VLR and/or SGSN. + +#### 19.2.1.2 GLR failure case + +In the case of GLR failure, the GLR invokes MAP\_RESET service towards the affected VLR and/or SGSN. + +#### 19.2.1.3 Detailed procedure in GLR + +Figure 19.2.1/1 shows the Process RECEIVE\_RESET\_IN\_GLR. This process is a GLR MAP protocol machine handling reset message from HLR. + +![Flowchart for Process RECEIVE_RESET_IN_GLR](0a73b03fba21af142d619a9a662e6490_img.jpg) + +### Process RECEIVE\_RESET\_IN\_GLR 19.2.1.1(1) + +GLR MAP protocol machine handling reset message from HLR. + +Left to GLR application +Right to HLR + +``` +graph TD; Start([ ]) --> NULL1(NULL); NULL1 --> Receive[Receive Open Ind.]; Receive -- OK --> WAIT[WAIT_FOR_SERVICE_PRIMITIVE]; Receive -- Vr --> Perform[Perform MAP_Vr_Dialogue]; Receive -- Error --> NULL2(NULL); WAIT --> MAP_RESET[MAP_RESET_ind]; MAP_RESET --> MAP_CLOSE[MAP_CLOSE_req]; MAP_CLOSE -- "Release method: Prearenged end" --> Check[Check_Indication]; Check -- OK --> Reset{Reset}; Check -- Error --> NULL3(NULL); Reset --> NULL4(NULL); Perform --> NULL5(NULL); +``` + +The flowchart illustrates the process for handling a reset message. It begins with an entry point leading to a NULL state, followed by 'Receive Open Ind.'. From here, three paths emerge: 'OK' leads to 'WAIT\_FOR\_SERVICE\_PRIMITIVE', 'Vr' leads to 'Perform MAP\_Vr\_Dialogue' (ending in NULL), and 'Error' leads to NULL. The 'OK' path continues through 'MAP\_RESET\_ind', 'MAP\_CLOSE\_req' (with a note 'Release method: Prearenged end'), and 'Check\_Indication'. From 'Check\_Indication', an 'OK' result leads to a 'Reset' decision diamond, which then leads to a final NULL state, while an 'Error' result leads to NULL. The 'Perform MAP\_Vr\_Dialogue' path also ends in a NULL state. + +Flowchart for Process RECEIVE\_RESET\_IN\_GLR + +Figure 19.2.1/1: Process RECEIVE\_RESET\_IN\_GLR + +Figure 19.2.1/2 shows the Process SEND\_RESET\_TO\_VLR. This process is a GLR MAP protocol machine handling reset message to VLR. + +![Flowchart for Process SEND_RESET_TO_VLR. The process starts at an oval, goes to a 'Null' state, then a 'Reset' state. It then enters a loop waiting for 'MAP_OPEN_req', 'MAP_RESET_req', or 'MAP_DELIMITER_req'. Upon receiving one, it goes to 'Receive_Open_Cnf'. From there, an 'OK' response leads to 'MAP_CLOSE_req' (with 'Release method: Prearenged end'), an 'error' response leads to 'Aborted', and a 'Vr' response leads to 'Perform Vr dialogue'. All three paths converge to a final 'Null' state. A note on the left indicates 'Left to VLR' and 'Right to GLR application'.](fe7304192caf64cda93b580c5e7e5c06_img.jpg) + +**Process SEND\_RESET\_TO\_VLR** 19.2.1.2(1) + +GLR MAP protocol machine handling reset message to VLR. + +``` +graph TD; Start([ ]) --> Null1([Null]); Null1 --> Reset[/Reset/]; Reset --> Wait{MAP_OPEN_req +MAP_RESET_req +MAP_DELIMITER_req}; Wait --> Receive[Receive_Open_Cnf]; Receive -- OK --> Close{MAP_CLOSE_req}; Close -- "Release method: +Prearenged end" --> Null2([Null]); Receive -- error --> Aborted[/Aborted/]; Receive -- Vr --> Perform[Perform Vr dialogue]; Aborted --> Null2; Perform --> Null2; +``` + +Left to VLR +Right to GLR application + +Flowchart for Process SEND\_RESET\_TO\_VLR. The process starts at an oval, goes to a 'Null' state, then a 'Reset' state. It then enters a loop waiting for 'MAP\_OPEN\_req', 'MAP\_RESET\_req', or 'MAP\_DELIMITER\_req'. Upon receiving one, it goes to 'Receive\_Open\_Cnf'. From there, an 'OK' response leads to 'MAP\_CLOSE\_req' (with 'Release method: Prearenged end'), an 'error' response leads to 'Aborted', and a 'Vr' response leads to 'Perform Vr dialogue'. All three paths converge to a final 'Null' state. A note on the left indicates 'Left to VLR' and 'Right to GLR application'. + +Figure 19.2.1/2: Process SEND\_RESET\_TO\_VLR + +Figure 19.2.1/3 shows the Process SEND\_RESET\_TO\_SGSN. This process is a GLR MAP protocol machine handling reset message to SGSN. + +![Flowchart for Process SEND_RESET_TO_SGSN. The process starts at an oval, goes to a 'Null' state, then a 'Reset' state. It then enters a loop waiting for 'MAP_OPEN_req', 'MAP_RESET_req', or 'MAP_DELIMITER_req'. Upon receiving one, it goes to 'Receive_Open_Cnf'. From there, an 'OK' response leads to 'MAP_CLOSE_req' (with 'Release method: Prearenged end'), an 'error' response leads to 'Aborted', and a 'Vr' response leads to 'Perform Vr dialogue'. All three paths converge to a final 'Null' state.](c3fcdb9e14cb1f7e5e0232c5fe0c5198_img.jpg) + +**Process SEND\_RESET\_TO\_SGSN** 19.2.1.3(1) + +GLR MAP protocol machine handling reset message to SGSN. + +``` +graph TD; Start([ ]) --> Null1([Null]); Null1 --> Reset[Reset]; Reset --> Wait{MAP_OPEN_req +MAP_RESET_req +MAP_DELIMITER_req}; Wait --> Recv[Receive_Open_Cnf]; Recv -- OK --> Close{MAP_CLOSE_req}; Recv -- error --> Aborted{Aborted}; Recv -- Vr --> Perform[Perform Vr dialogue]; Close -- "Release method: +Prearenged end" --> Null2([Null]); Aborted --> Null2; Perform --> Null2; +``` + +Left to SGSN +Right to GLR application + +Flowchart for Process SEND\_RESET\_TO\_SGSN. The process starts at an oval, goes to a 'Null' state, then a 'Reset' state. It then enters a loop waiting for 'MAP\_OPEN\_req', 'MAP\_RESET\_req', or 'MAP\_DELIMITER\_req'. Upon receiving one, it goes to 'Receive\_Open\_Cnf'. From there, an 'OK' response leads to 'MAP\_CLOSE\_req' (with 'Release method: Prearenged end'), an 'error' response leads to 'Aborted', and a 'Vr' response leads to 'Perform Vr dialogue'. All three paths converge to a final 'Null' state. + +Figure 19.2.1/3: Process SEND\_RESET\_TO\_SGSN + +### 19.2.2 VLR restoration: the restore data procedure in the GLR + +#### 19.2.2.1 General + +This procedure is used to restore the subscriber data for an unidentified MS (i.e. IMSI unknown in VLR), or for a known MS whose IMSI record is marked as "Not Confirmed" by the indicator "Confirmed by HLR" in VLR. + +If GLR is located between the VLR and the HLR, the MAP\_RESTORE\_DATA service is invoked towards the GLR whose identity is contained in the VLR table. When the GLR receives a MAP\_RESTORE\_DATA indication, it determines whether it invokes the MAP\_RESTORE\_DATA service towards the HLR, and invokes it if necessary. + +#### 19.2.2.2 Detailed procedure in GLR + +Figure 19.2.2/1 shows the Process RESTORE\_DATA\_GLR. This process is a GLR MAP protocol machine handling VLR restoration and is a responder to the VLR. + +![State transition diagram for Process RESTORE_DATA_GLR. The process starts at an initial state, goes to WAIT_FOR_SERVICE_PRIMITIVE, then receives MAP_RESTORE_DATA_ind. It then performs 'Restore data' and enters WAIT_FOR_APPLICATION_RESPONSE. From there, it can send 'Restore data Ack' (leading to 'Set result' and MAP_RESTORE_DATA_Rsp. / MAP_CLOSE_Req.), 'Restore data Negative Response' (leading to 'Set error' and MAP_RESTORE_DATA_Rsp. / MAP_CLOSE_Req.), 'Insert Subscriber Data' (leading to connector 1), or 'Abort' (leading to MAP_U_ABORT_req). Connector 2 loops back from the 'Restore data' state to the entry point of WAIT_FOR_APPLICATION_RESPONSE.](3337af75dfee8af7687b4f49914d6c93_img.jpg) + +### Process RESTORE\_DATA\_GLR + +19.2.2.1\_1(3) + +GLR MAP protocol machine handling VLR restoration and interfacing with VLR MAP protocol machine + +Left to VLR +Right to GLR application + +``` +stateDiagram-v2 + [*] --> WAIT_FOR_SERVICE_PRIMITIVE + WAIT_FOR_SERVICE_PRIMITIVE --> MAP_RESTORE_DATA_ind + MAP_RESTORE_DATA_ind --> Restore_data + Restore_data --> 2 + 2 --> WAIT_FOR_APPLICATION_RESPONSE + WAIT_FOR_APPLICATION_RESPONSE --> Restore_data_Ack + WAIT_FOR_APPLICATION_RESPONSE --> Restore_data_Negative_Response + WAIT_FOR_APPLICATION_RESPONSE --> Insert_Subscriber_Data + WAIT_FOR_APPLICATION_RESPONSE --> Abort + Restore_data_Ack --> Set_result + Set_result --> MAP_RESTORE_DATA_Rsp_MAP_CLOSE_Req_1 + Restore_data_Negative_Response --> Set_error + Set_error --> MAP_RESTORE_DATA_Rsp_MAP_CLOSE_Req_2 + Insert_Subscriber_Data --> 1 + Abort --> MAP_U_ABORT_req +``` + +State Transitions: + +- Initial state → **WAIT\_FOR\_SERVICE\_PRIMITIVE** +- WAIT\_FOR\_SERVICE\_PRIMITIVE** → **MAP\_RESTORE\_DATA\_ind** +- MAP\_RESTORE\_DATA\_ind** → **Restore data** +- Restore data** → **2** (Connector) +- 2** → **WAIT\_FOR\_APPLICATION\_RESPONSE** +- WAIT\_FOR\_APPLICATION\_RESPONSE** → **Restore data Ack** +- WAIT\_FOR\_APPLICATION\_RESPONSE** → **Restore data Negative Response** +- WAIT\_FOR\_APPLICATION\_RESPONSE** → **Insert Subscriber Data** +- WAIT\_FOR\_APPLICATION\_RESPONSE** → **Abort** +- Restore data Ack** → **Set result** +- Set result** → **MAP\_RESTORE\_DATA\_Rsp. MAP\_CLOSE\_Req.** +- Restore data Negative Response** → **Set error** +- Set error** → **MAP\_RESTORE\_DATA\_Rsp. MAP\_CLOSE\_Req.** +- Insert Subscriber Data** → **1** (Connector) +- Abort** → **MAP\_U\_ABORT\_req** + +State transition diagram for Process RESTORE\_DATA\_GLR. The process starts at an initial state, goes to WAIT\_FOR\_SERVICE\_PRIMITIVE, then receives MAP\_RESTORE\_DATA\_ind. It then performs 'Restore data' and enters WAIT\_FOR\_APPLICATION\_RESPONSE. From there, it can send 'Restore data Ack' (leading to 'Set result' and MAP\_RESTORE\_DATA\_Rsp. / MAP\_CLOSE\_Req.), 'Restore data Negative Response' (leading to 'Set error' and MAP\_RESTORE\_DATA\_Rsp. / MAP\_CLOSE\_Req.), 'Insert Subscriber Data' (leading to connector 1), or 'Abort' (leading to MAP\_U\_ABORT\_req). Connector 2 loops back from the 'Restore data' state to the entry point of WAIT\_FOR\_APPLICATION\_RESPONSE. + +Figure 19.2.2/1 (Sheet 1 of 3): Process RESTORE\_DATA\_GLR + +![Flowchart for Process RESTORE_DATA_GLR. It starts at connector 1, leading to a decision diamond. The diamond has two outgoing paths: one for MAP_Insert_Subscriber_Data_Req and MAP_Delimiter_Req, and another leading to a wait state. The wait state is labeled 'WAIT_FOR_ISD_Cnf' and 'WAIT_FOR_SUBSEQUENT_APPLICATION_RESPONSE'. From the wait state, three paths emerge: 1) MAP_Insert_Subscriber_Data_Cnf, which leads to 'Check Confirmation'. 'Check Confirmation' has three outcomes: 'OK' leading to 'Insert_Subscriber_Data_Cnf' and connector 2; 'Provider error Data error' leading to 'Set Negative Response System Failure' and then 'ISD Negative Response' and connector 2; and 'User error' leading to 'MAP User Error to Negative Response' and then 'ISD Negative Response' and connector 2. 2) An unlabeled path leading to a decision diamond, which has an outgoing path for MAP_U_ABORT_Ind, MAP_P_ABORT_Ind, and MAP_CLOSE_Ind, and a downward path to 'Abort' and connector 2. 3) MAP_NOTICE_Ind, which leads to 'Set Negative Result System Failure' and then 'ISD Negative Response' and connector 2.](9b1ec0090070bdf52ea28763b8d52477_img.jpg) + +### Process RESTORE\_DATA\_GLR + +19.2.2.1\_2(3) + +GLR MAP protocol machine handling VLR restoration and interfacing with VLR MAP protocol machine + +Left to VLR +Right to GLR application + +``` +graph TD + 1((1)) --> D{ } + D -- "MAP_Insert_Subscriber_Data_Req +MAP_Delimiter_Req" --> D + D --> W["WAIT_FOR_ISD_Cnf +WAIT_FOR_SUBSEQUENT +APPLICATION_RESPONSE"] + W --> MISC[" "] + MISC --> ISC["MAP_Insert_Subscriber_Data_Cnf"] + MISC --> D2{ } + MISC --> MN["MAP_NOTICE_Ind"] + D2 --> ABORT_IND["MAP_U_ABORT_Ind +MAP_P_ABORT_Ind +MAP_CLOSE_Ind"] + D2 --> ABORT[Abort] + ABORT --> X[ ] + X --> 2a((2)) + ISC --> CC[Check Confirmation] + CC -- OK --> ISDC["Insert_Subscriber_Data_Cnf"] + ISDC --> 2b((2)) + CC -- "Provider error +Data error" --> SNR["Set Negative +Response +System Failure"] + SNR --> INR1["ISD +Negative Response"] + INR1 --> 2c((2)) + CC -- User error --> MUE["MAP User Error +to Negative +Response"] + MUE --> INR2["ISD +Negative Response"] + INR2 --> 2d((2)) + MN --> SNJ["Set Negative +Result +System Failure"] + SNJ --> INR3["ISD +Negative Response"] + INR3 --> 2e((2)) +``` + +Flowchart for Process RESTORE\_DATA\_GLR. It starts at connector 1, leading to a decision diamond. The diamond has two outgoing paths: one for MAP\_Insert\_Subscriber\_Data\_Req and MAP\_Delimiter\_Req, and another leading to a wait state. The wait state is labeled 'WAIT\_FOR\_ISD\_Cnf' and 'WAIT\_FOR\_SUBSEQUENT\_APPLICATION\_RESPONSE'. From the wait state, three paths emerge: 1) MAP\_Insert\_Subscriber\_Data\_Cnf, which leads to 'Check Confirmation'. 'Check Confirmation' has three outcomes: 'OK' leading to 'Insert\_Subscriber\_Data\_Cnf' and connector 2; 'Provider error Data error' leading to 'Set Negative Response System Failure' and then 'ISD Negative Response' and connector 2; and 'User error' leading to 'MAP User Error to Negative Response' and then 'ISD Negative Response' and connector 2. 2) An unlabeled path leading to a decision diamond, which has an outgoing path for MAP\_U\_ABORT\_Ind, MAP\_P\_ABORT\_Ind, and MAP\_CLOSE\_Ind, and a downward path to 'Abort' and connector 2. 3) MAP\_NOTICE\_Ind, which leads to 'Set Negative Result System Failure' and then 'ISD Negative Response' and connector 2. + +Figure 19.2.2/1 (Sheet 2 of 3): Process RESTORE\_DATA\_GLR + +![State transition diagram for Process RESTORE_DATA_GLR. The diagram shows four main paths originating from a central state labeled 'WAIT_FOR_ISD_Cnf' and 'WAIT_FOR_SUBSEQUENT_APPLICATION_RESPONSE'. Path 1: 'Restore_Data_Ack' (glide) leads to 'Set result' (action), which then leads to a merge point for 'MAP_RESTORE_DATA_Rsp.' and 'MAP_CLOSE_Req.' (glide), ending at a state exit (X). Path 2: 'Restore_Data_Negative_Response' (glide) leads to 'Set Error' (action), which also leads to the same merge point. Path 3: 'Insert_Subscriber_Data' (glide) leads to a connector circle labeled '1'. Path 4: 'Abort' (glide) leads to 'MAP_U_ABORT_req' (action), which ends at a state exit (X).](b34c69e1ec326b01c3a485b27b1df5f6_img.jpg) + +### Process RESTORE\_DATA\_GLR + +19.2.2.1\_3(3) + +GLR MAP protocol machine handling VLR restoration and interfacing with VLR MAP protocol machine + +Left to VLR +Right to GLR application + +``` +stateDiagram-v2 + [*] --> WAIT_FOR_ISD_Cnf + state "WAIT_FOR_ISD_Cnf
WAIT_FOR_SUBSEQUENT_APPLICATION_RESPONSE" as WAIT_FOR_ISD_Cnf + WAIT_FOR_ISD_Cnf --> Restore_Data_Ack : Restore_Data_Ack + WAIT_FOR_ISD_Cnf --> Restore_Data_Negative_Response : Restore_Data_Negative_Response + WAIT_FOR_ISD_Cnf --> Insert_Subscriber_Data : Insert_Subscriber_Data + WAIT_FOR_ISD_Cnf --> Abort : Abort + Restore_Data_Ack --> Set_result : Set result + Restore_Data_Negative_Response --> Set_Error : Set Error + Insert_Subscriber_Data --> 1 : 1 + Abort --> MAP_U_ABORT_req : MAP_U_ABORT_req + Set_result --> MergePoint + Set_Error --> MergePoint + MergePoint --> MAP_RESTORE_DATA_Rsp_MAP_CLOSE_Req : MAP_RESTORE_DATA_Rsp.
MAP_CLOSE_Req. + MAP_RESTORE_DATA_Rsp_MAP_CLOSE_Req --> [*] : X + MAP_U_ABORT_req --> [*] : X +``` + +State transition diagram for Process RESTORE\_DATA\_GLR. The diagram shows four main paths originating from a central state labeled 'WAIT\_FOR\_ISD\_Cnf' and 'WAIT\_FOR\_SUBSEQUENT\_APPLICATION\_RESPONSE'. Path 1: 'Restore\_Data\_Ack' (glide) leads to 'Set result' (action), which then leads to a merge point for 'MAP\_RESTORE\_DATA\_Rsp.' and 'MAP\_CLOSE\_Req.' (glide), ending at a state exit (X). Path 2: 'Restore\_Data\_Negative\_Response' (glide) leads to 'Set Error' (action), which also leads to the same merge point. Path 3: 'Insert\_Subscriber\_Data' (glide) leads to a connector circle labeled '1'. Path 4: 'Abort' (glide) leads to 'MAP\_U\_ABORT\_req' (action), which ends at a state exit (X). + +Figure 19.2.2/1 (Sheet 3 of 3): Process RESTORE\_DATA\_GLR + +Figure 19.2.2/2 shows the Process GLR\_RESTORE\_DATA\_HLR. This process is a GLR MAP protocol machine handling VLR restoration and is an initiator to the HLR. + +Sheet 1: If the Macro Open\_Receive\_Cnf results Vr, the process requests to perform MAP Vr. It causes a request for sending an abort message to Process RESTORE\_DATA\_GLR. + +![Flowchart for Process GLR_RESTORE_DATA_HLR. It starts with an oval, followed by an IDLE state. A 'restore data' input leads to a decision diamond. From the diamond, three outputs go to the right: MAP_OPEN_Req, MAP_RESTORE_DATA_Req, and MAP_DELIMITER_Req. The main path goes down to 'Receive Open Cnf', which is linked to 'Section 25.1'. From 'Receive Open Cnf', three paths emerge: 'OK' leads to 'Wait_For_HLR_Response'; 'Vr' leads to 'Perform MAP Vr'; 'Error' leads to 'Set error' and then 'Restore data Negative Response'. Both 'Perform MAP Vr' and 'Restore data Negative Response' lead to an 'X' symbol.](68a5a1a1a761c652b4b4c56da7cf9914_img.jpg) + +### Process GLR\_RESTORE\_DATA\_HLR 19.2.2.2\_1(3) + +GLR MAP protocol machine handling restore data and interfacing to HLR MAP protocol machine, handling restore data. + +Signals to/from the left are to/from the GLR application. +Signals to/from the right are to/from the HLR MAP protocol machine. + +``` +graph TD; Start([ ]) --> IDLE([IDLE]); IDLE --> RD[/restore data/]; RD --> Decision{ }; Decision -- "MAP_OPEN_Req +MAP_RESTORE_DATA_Req +MAP_DELIMITER_Req" --> Right1[ ]; Decision --> ROCnf[Receive Open Cnf]; ROCnf --- S251[Section 25.1]; ROCnf -- OK --> WFR[Wait_For_HLR_Response]; ROCnf -- Vr --> PMVr{Perform MAP Vr}; ROCnf -- Error --> SetError[Set error]; SetError --> RNR[/Restore data Negative Response/]; PMVr --> X1[X]; RNR --> X2[X]; +``` + +Flowchart for Process GLR\_RESTORE\_DATA\_HLR. It starts with an oval, followed by an IDLE state. A 'restore data' input leads to a decision diamond. From the diamond, three outputs go to the right: MAP\_OPEN\_Req, MAP\_RESTORE\_DATA\_Req, and MAP\_DELIMITER\_Req. The main path goes down to 'Receive Open Cnf', which is linked to 'Section 25.1'. From 'Receive Open Cnf', three paths emerge: 'OK' leads to 'Wait\_For\_HLR\_Response'; 'Vr' leads to 'Perform MAP Vr'; 'Error' leads to 'Set error' and then 'Restore data Negative Response'. Both 'Perform MAP Vr' and 'Restore data Negative Response' lead to an 'X' symbol. + +Figure 19.2.2/2 (Sheet 1 of 3): Process GLR\_RESTORE\_DATA\_HLR + +![State transition diagram for Process GLR_RESTORE_DATA_HLR. The diagram shows four main paths starting from a 'Wait_For_HLR_Response' state. Path 1: MAP_RESTORE_DATA_cnf -> Check Confirmation (Section 25.2) -> OK leads to Restore data ack -> Idle; Provider Error, User Error, Data Error leads to Set negative response -> Restore data negative response -> Idle. Path 2: MAP_INSERT_SUBSCRIBER_DATA_ind -> Insert Subscriber data -> Wait_For_HLR or Application_Response. Path 3: MAP_Notice_Indication -> MAP_Close_request -> Set negative response -> Restore data negative response -> Idle. Path 4: MAP_U_Abort_ind, MAP_P_Abort_ind, MAP_Close_ind -> Abort -> Idle.](56a5265d174ce056c1dbe5e7a60839fc_img.jpg) + +### Process GLR\_RESTORE\_DATA\_HLR + +19.2.2.2\_2(3) + +GLR MAP protocol machine handling restore data and interfacing to HLR MAP protocol machine, handling restore data. + +Signals to/from the left are to/from the GLR application. +Signals to/from the right are to/from the HLR MAP protocol machine. + +``` +stateDiagram-v2 + [*] --> Wait_For_HLR_Response + state "Wait_For_HLR_Response" as Wait_For_HLR_Response + state "MAP_RESTORE_DATA_cnf" as MAP_RESTORE_DATA_cnf + state "MAP_INSERT_SUBSCRIBER_DATA_ind" as MAP_INSERT_SUBSCRIBER_DATA_ind + state "MAP_Notice_Indication" as MAP_Notice_Indication + state "MAP_U_Abort_ind, MAP_P_Abort_ind, MAP_Close_ind" as MAP_U_Abort_ind, MAP_P_Abort_ind, MAP_Close_ind + + Wait_For_HLR_Response --> MAP_RESTORE_DATA_cnf + Wait_For_HLR_Response --> MAP_INSERT_SUBSCRIBER_DATA_ind + Wait_For_HLR_Response --> MAP_Notice_Indication + Wait_For_HLR_Response --> MAP_U_Abort_ind, MAP_P_Abort_ind, MAP_Close_ind + + state "Check Confirmation" as Check Confirmation + state "OK" as OK + state "Provider Error, User Error, Data Error" as Provider Error, User Error, Data Error + state "Restore data ack" as Restore data ack + state "Set negative response" as Set negative response + state "Restore data negative response" as Restore data negative response + state "Idle" as Idle + + MAP_RESTORE_DATA_cnf --> Check Confirmation + Check Confirmation --> OK + Check Confirmation --> Provider Error, User Error, Data Error + OK --> Restore data ack + Provider Error, User Error, Data Error --> Set negative response + Restore data ack --> Idle + Set negative response --> Restore data negative response + Restore data negative response --> Idle + + state "Insert Subscriber data" as Insert Subscriber data + state "Wait_For_HLR or Application_Response" as Wait_For_HLR or Application_Response + + MAP_INSERT_SUBSCRIBER_DATA_ind --> Insert Subscriber data + Insert Subscriber data --> Wait_For_HLR or Application_Response + + state "MAP_Close_request" as MAP_Close_request + state "Set negative response" as Set negative response + state "Restore data negative response" as Restore data negative response + state "Idle" as Idle + + MAP_Notice_Indication --> MAP_Close_request + MAP_Close_request --> Set negative response + Set negative response --> Restore data negative response + Restore data negative response --> Idle + + state "Abort" as Abort + state "Idle" as Idle + + MAP_U_Abort_ind, MAP_P_Abort_ind, MAP_Close_ind --> Abort + Abort --> Idle +``` + +State transition diagram for Process GLR\_RESTORE\_DATA\_HLR. The diagram shows four main paths starting from a 'Wait\_For\_HLR\_Response' state. Path 1: MAP\_RESTORE\_DATA\_cnf -> Check Confirmation (Section 25.2) -> OK leads to Restore data ack -> Idle; Provider Error, User Error, Data Error leads to Set negative response -> Restore data negative response -> Idle. Path 2: MAP\_INSERT\_SUBSCRIBER\_DATA\_ind -> Insert Subscriber data -> Wait\_For\_HLR or Application\_Response. Path 3: MAP\_Notice\_Indication -> MAP\_Close\_request -> Set negative response -> Restore data negative response -> Idle. Path 4: MAP\_U\_Abort\_ind, MAP\_P\_Abort\_ind, MAP\_Close\_ind -> Abort -> Idle. + +Figure 19.2.2/2 (Sheet 2 of 3): Process GLR\_RESTORE\_DATA\_HLR + +![State transition diagram for Process GLR_RESTORE_DATA_HLR. The diagram shows two main paths starting from 'Wait_For_HLR_or_Application_Response'. The left path handles 'MAP_RESTORE_DATA_cnf' with a 'Check Confirmation' (Section 25.2), leading to 'Restore data ack' (OK) or 'Set negative response' (Provider Error, User Error, Data Error), both ending at 'Idle'. The right path handles 'MAP_INSERT_SUBSCRIBER_DATA_ind', leading to 'Insert Subscriber data', 'Insert Subscriber Data ack', or 'Insert Subscriber Data negative response'. The negative response leads to 'Set user error' and then 'MAP_Insert Subscriber Data_response', which loops back to 'Wait_For_HLR_or_Application_Response'. The 'Insert Subscriber data' path leads to another 'Wait_For_HLR_or_Application_Response' state, which then branches into 'Abort' (leading to 'Map_U_Abort_request'), 'MAP_Notice_Indication' (leading to 'MAP_Close_request' -> 'Set negative response' -> 'Update Location negative response'), or 'MAP_U_Abort_ind / MAP_P_Abort_ind / MAP_Close_ind' (leading to 'Abort'). All three branches from the second wait state lead to 'Idle'.](fd3cbb53e991f8209ba17b398f426e13_img.jpg) + +**Process GLR\_RESTORE\_DATA\_HLR** 19.2.2.2\_3(3) + +GLR MAP protocol machine handling restore data and interfacing to HLR MAP protocol machine, handling restore data. + +Signals to/from the left are to/from the GLR application. + Signals to/from the right are to/from the HLR MAP protocol machine. + +``` + +stateDiagram-v2 + [*] --> Wait_For_HLR_or_Application_Response + state "Wait_For_HLR_or_Application_Response" as Wait_For_HLR_or_Application_Response + state "MAP_RESTORE_DATA_cnf" as MAP_RESTORE_DATA_cnf + state "Check Confirmation" as Check Confirmation + state "Restore data ack" as Restore data ack + state "Set negative response" as Set negative response + state "Restore data negative response" as Restore data negative response + state "Idle" as Idle + state "MAP_INSERT_SUBSCRIBER_DATA_ind" as MAP_INSERT_SUBSCRIBER_DATA_ind + state "Insert Subscriber data" as Insert Subscriber data + state "Insert Subscriber Data ack" as Insert Subscriber Data ack + state "Insert Subscriber Data negative response" as Insert Subscriber Data negative response + state "Set user error" as Set user error + state "MAP_Insert Subscriber Data_response" as MAP_Insert Subscriber Data_response + state "Abort" as Abort + state "MAP_Notice_Indication" as MAP_Notice_Indication + state "MAP_U_Abort_ind / MAP_P_Abort_ind / MAP_Close_ind" as MAP_U_Abort_ind / MAP_P_Abort_ind / MAP_Close_ind + state "Map_U_Abort_request" as Map_U_Abort_request + state "MAP_Close_request" as MAP_Close_request + state "Set negative response" as Set negative_response + state "Update Location negative response" as Update Location negative response + + Wait_For_HLR_or_Application_Response --> MAP_RESTORE_DATA_cnf + MAP_RESTORE_DATA_cnf --> Check Confirmation + Check Confirmation --> Restore data ack : OK + Check Confirmation --> Set negative_response : Provider Error, User Error, Data Error + Restore data ack --> Idle + Set negative_response --> Restore data negative_response + Restore data negative_response --> Idle + + Wait_For_HLR_or_Application_Response --> MAP_INSERT_SUBSCRIBER_DATA_ind + MAP_INSERT_SUBSCRIBER_DATA_ind --> Insert Subscriber data + Insert Subscriber data --> Insert Subscriber Data ack + Insert Subscriber data --> Insert Subscriber Data negative_response + Insert Subscriber Data negative_response --> Set user error + Set user error --> MAP_Insert Subscriber Data_response + MAP_Insert Subscriber Data_response --> Wait_For_HLR_or_Application_Response + + Wait_For_HLR_or_Application_Response --> Abort + Wait_For_HLR_or_Application_Response --> MAP_Notice_Indication + Wait_For_HLR_or_Application_Response --> MAP_U_Abort_ind / MAP_P_Abort_ind / MAP_Close_ind + + Abort --> Map_U_Abort_request + Map_U_Abort_request --> Idle + + MAP_Notice_Indication --> MAP_Close_request + MAP_Close_request --> Set negative_response + Set negative_response --> Update Location negative_response + Update Location negative_response --> Idle + + MAP_U_Abort_ind / MAP_P_Abort_ind / MAP_Close_ind --> Abort + Abort --> Idle + +``` + +State transition diagram for Process GLR\_RESTORE\_DATA\_HLR. The diagram shows two main paths starting from 'Wait\_For\_HLR\_or\_Application\_Response'. The left path handles 'MAP\_RESTORE\_DATA\_cnf' with a 'Check Confirmation' (Section 25.2), leading to 'Restore data ack' (OK) or 'Set negative response' (Provider Error, User Error, Data Error), both ending at 'Idle'. The right path handles 'MAP\_INSERT\_SUBSCRIBER\_DATA\_ind', leading to 'Insert Subscriber data', 'Insert Subscriber Data ack', or 'Insert Subscriber Data negative response'. The negative response leads to 'Set user error' and then 'MAP\_Insert Subscriber Data\_response', which loops back to 'Wait\_For\_HLR\_or\_Application\_Response'. The 'Insert Subscriber data' path leads to another 'Wait\_For\_HLR\_or\_Application\_Response' state, which then branches into 'Abort' (leading to 'Map\_U\_Abort\_request'), 'MAP\_Notice\_Indication' (leading to 'MAP\_Close\_request' -> 'Set negative response' -> 'Update Location negative response'), or 'MAP\_U\_Abort\_ind / MAP\_P\_Abort\_ind / MAP\_Close\_ind' (leading to 'Abort'). All three branches from the second wait state lead to 'Idle'. + +Figure 19.2.2/2 (Sheet 3 of 3): Process GLR\_RESTORE\_DATA\_HLR + +# 20 Operations and maintenance procedures + +## 20.1 General + +The Operations and Maintenance procedures are needed for operating and maintaining the UMTS PLMN network. + +The following procedures exist for operation and maintenance purposes: + +- i) Tracing procedures; +- ii) Subscriber Data Management procedures; +- iii) Subscriber Identity procedures. + +The following application contexts refer to complex MAP Users consisting of several processes: + +- subscriberDataManagementContext; +- tracingContext. + +These two application contexts need a co-ordinating process in the VLR or in the SGSN. Refer to the 3GPP TS 29.002 for detail procedures. + +The Subscriber Data Management procedures are only procedures that impact to the GLR. The following subclause describes the Subscriber Identity procedures in the GLR. + +## 20.2 Subscriber data management procedures + +### 20.2.1 General + +Two types of subscriber data management procedures exist in the Mobile Application Part + +- i) Subscriber Deletion; +- ii) Subscriber Data Modification. + +No requirements have been identified for the Subscriber creation and subscriber data interrogation procedures. + +The subscriber deletion and subscriber data modification procedures are initiated by the OMC (see figures 20.2.1/1, 20.2.1/2, 20.2.1/3 and 20.2.1/4). + +![Sequence diagram of the subscriber deletion procedure showing interactions between VLR, GLR, HLR, and OMC. 1. OMC to HLR: Delete Subscriber. 2. HLR to GLR and GLR to VLR: MAP_CANCEL_LOCATION. 3. VLR to GLR and GLR to HLR: MAP_CANCEL_LOCATION_ACK. 4. HLR to OMC: Subscriber Deleted.](ac42de838505beb048fb1267c46de428_img.jpg) + +``` +sequenceDiagram + participant VLR + participant GLR + participant HLR + participant OMC + Note over OMC,HLR: 1. Delete Subscriber + OMC->>HLR: + Note over HLR,GLR: 2. MAP_CANCEL_LOCATION + HLR->>GLR: + Note over GLR,VLR: 2. MAP_CANCEL_LOCATION + GLR->>VLR: + Note over VLR,GLR: 3. MAP_CANCEL_LOCATION_ACK + VLR-->>GLR: + Note over GLR,HLR: 3. MAP_CANCEL_LOCATION_ACK + GLR-->>HLR: + Note over HLR,OMC: 4. Subscriber Deleted + HLR-->>OMC: +``` + +- 1) Delete Subscriber. +- 2) MAP\_CANCEL\_LOCATION. +- 3) MAP\_CANCEL\_LOCATION\_ACK. +- 4) Subscriber Deleted. + +Sequence diagram of the subscriber deletion procedure showing interactions between VLR, GLR, HLR, and OMC. 1. OMC to HLR: Delete Subscriber. 2. HLR to GLR and GLR to VLR: MAP\_CANCEL\_LOCATION. 3. VLR to GLR and GLR to HLR: MAP\_CANCEL\_LOCATION\_ACK. 4. HLR to OMC: Subscriber Deleted. + +**Figure 20.2.1/1: Subscriber deletion procedure** + +In the subscriber deletion procedure the subscriber data should be removed from the VLR and from the HLR. The HLR uses the MAP\_CANCEL\_LOCATION service. + +![Sequence diagram for Figure 20.2.1/2: Subscriber deletion procedure for GPRS. Lifelines: SGSN, GLR, HLR, OMC. The sequence is: 1. HLR sends a message to OMC; 2. SGSN sends a message to GLR; 3. GLR sends a message to HLR; 4. OMC sends a message to HLR.](61a7f401eb46fe99a71f27bc37493f04_img.jpg) + +``` + +sequenceDiagram + participant SGSN + participant GLR + participant HLR + participant OMC + Note right of HLR: 1. + HLR-->>OMC: + Note left of GLR: 2. + SGSN-->>GLR: + Note right of GLR: 3. + GLR-->>HLR: + Note right of OMC: 4. + OMC-->>HLR: + +``` + +Sequence diagram for Figure 20.2.1/2: Subscriber deletion procedure for GPRS. Lifelines: SGSN, GLR, HLR, OMC. The sequence is: 1. HLR sends a message to OMC; 2. SGSN sends a message to GLR; 3. GLR sends a message to HLR; 4. OMC sends a message to HLR. + +- 1) Delete GPRS Subscriber. +- 2) MAP\_CANCEL\_LOCATION. +- 3) MAP\_CANCEL\_LOCATION\_ACK. +- 4) GPRS Subscriber Deleted. + +**Figure 20.2.1/2: Subscriber deletion procedure for GPRS** + +In the subscriber deletion procedure the subscriber data should be removed from the SGSN and from the HLR. The HLR uses the MAP\_CANCEL\_LOCATION service. + +![Sequence diagram for Figure 20.2.1/3: Subscriber data modification procedure. Lifelines: VLR, GLR, HLR, OMC. The sequence is: 1. HLR sends a message to OMC; 2. VLR sends a message to GLR; 3. GLR sends a message to HLR; 4. OMC sends a message to HLR.](dd6c544ab685b25dd17f59456efcfbfc_img.jpg) + +``` + +sequenceDiagram + participant VLR + participant GLR + participant HLR + participant OMC + Note right of HLR: 1. + HLR-->>OMC: + Note left of GLR: 2. + VLR-->>GLR: + Note right of GLR: 3. + GLR-->>HLR: + Note right of OMC: 4. + OMC-->>HLR: + +``` + +Sequence diagram for Figure 20.2.1/3: Subscriber data modification procedure. Lifelines: VLR, GLR, HLR, OMC. The sequence is: 1. HLR sends a message to OMC; 2. VLR sends a message to GLR; 3. GLR sends a message to HLR; 4. OMC sends a message to HLR. + +- 1) Modify Subscriber Data. +- 2) MAP\_CANCEL\_LOCATION, MAP\_INSERT\_SUBSCRIBER\_DATA or +MAP\_DELETE\_SUBSCRIBER\_DATA. +- 3) MAP\_CANCEL\_LOCATION\_ACK, MAP\_INSERT\_SUBSCRIBER\_DATA\_ACK or +MAP\_DELETE\_SUBSCRIBER\_DATA\_ACK. +- 4) Subscriber Data Modified. + +**Figure 20.2.1/3: Subscriber data modification procedure** + +![Sequence diagram for Figure 20.2.1/4: Subscriber data modification procedure for GPRS. Lifelines: SGSN, GLR, HLR, OMC. The sequence is: 1. HLR sends a message to OMC; 2. SGSN sends a message to GLR; 3. GLR sends a message to HLR; 4. OMC sends a message to HLR.](bdd96f20e71f079cad85240efb3d3f24_img.jpg) + +``` + +sequenceDiagram + participant SGSN + participant GLR + participant HLR + participant OMC + Note right of HLR: 1. + HLR-->>OMC: + Note left of GLR: 2. + SGSN-->>GLR: + Note right of GLR: 3. + GLR-->>HLR: + Note right of OMC: 4. + OMC-->>HLR: + +``` + +Sequence diagram for Figure 20.2.1/4: Subscriber data modification procedure for GPRS. Lifelines: SGSN, GLR, HLR, OMC. The sequence is: 1. HLR sends a message to OMC; 2. SGSN sends a message to GLR; 3. GLR sends a message to HLR; 4. OMC sends a message to HLR. + +- 1) Modify Subscriber Data. +- 2) MAP\_CANCEL\_LOCATION, MAP\_INSERT\_SUBSCRIBER\_DATA or +MAP\_DELETE\_SUBSCRIBER\_DATA. +- 3) MAP\_CANCEL\_LOCATION\_ACK, MAP\_INSERT\_SUBSCRIBER\_DATA\_ACK or +MAP\_DELETE\_SUBSCRIBER\_DATA\_ACK. +- 4) Subscriber Data Modified. + +**Figure 20.2.1/4: Subscriber data modification procedure for GPRS** + +In the subscriber data modification procedure the subscriber data is modified in the HLR and when necessary also in the VLR or in the SGSN. The HLR initiates either the MAP\_INSERT\_SUBSCRIBER\_DATA, MAP\_DELETE\_SUBSCRIBER\_DATA or MAP\_CANCEL\_LOCATION service depending on the modified data. + +### 20.2.2 Procedures in the GLR + +#### 20.2.2.1 Subscriber deletion procedure + +The subscriber deletion procedure in the GLR is described in the subclause 19. + +#### 20.2.2.2 Subscriber data modification procedure + +When receiving either the MAP\_INSERT\_SUBSCRIBER\_DATA indication or the MAP\_DELETE\_SUBSCRIBER\_DATA indication, the GLR checks the parameters and data in the primitive. Data errors are reported as an unexpected data value error or a data missing error depending on the nature of the error. + +After receiving the first MAP\_INSERT\_SUBSCRIBER\_DATA indication, the GLR will check the IMSI that is included in the primitive. If the IMSI is unknown, the error "Unidentified subscriber" is returned. + +If the GLR does not support received basic or supplementary services or the network feature Operator Determined Barring, or there is a problem with Regional Subscription Data then this is reported to the HLR. + +If the entire MSC area that covered the VLR wherein the subscriber is registered is restricted due to regional subscription, this is reported to the HLR. + +If the updating of the subscriber data is not possible, the GLR will initiate the MAP\_U\_ABORT request primitive. + +If the updating is successful in the GLR, the GLR will initiate the MAP\_INSERT\_SUBSCRIBER\_DATA request or the MAP\_DELETE\_SUBSCRIBER\_DATA request to the VLR or to the SGSN wherein the subscriber is registered. + +The subscriber data modification procedure in the GLR is shown in the figures 20.2.2.2/1, 20.2.2.2/2, 20.2.2.2/3, 20.2.2.2/4, 20.2.2.2/5 and 20.2.2.2/6. + +![Flowchart for Process INS_SUBS_DATA_GLR. It starts with NULL, receives an Open Indication, and then branches based on OK status. The main path involves waiting for indications (MAP_INSERT_SUBSCRIBER_DATA_ind, MAP_NOTICE_ind, MAP_CLOSE_req), checking parameters, and then checking if the IMSI is known. Depending on these checks, it either proceeds to the next step (1), sets the UE as unidentified, or sets an unexpected data value, both leading to a response message.](5801c19431e76330430e92a598cc7a16_img.jpg) + +### Process INS\_SUBS\_DATA\_GLR + +20.2.2.2.1\_1(3) + +Figure 20.2.2.2/1: The insert subscriber data process in the GLR + +Arrows to left are to VLR +Arrows to right are to HLR + +``` +graph TD; NULL1(NULL) --> Receive[Receive Open Ind]; Receive -- OK --> Wait[Wait_For_indication]; Receive -- "'V' 'Error'" --> NULL2(NULL); Wait --> MAP_INSERT[MAP_INSERT_SUBSCRIBER_DATA_ind]; Wait --> MAP_NOTICE[MAP_NOTICE_ind]; Wait --> MAP_ABORT[MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind]; MAP_NOTICE --> MAP_CLOSE_req[MAP_CLOSE_req]; MAP_INSERT --> Check[Check_Indication]; MAP_CLOSE_req --> X1((X)); Check -- Ok --> ParamOK{Parameter OK}; ParamOK -- Error --> SetUE1[Set UE= Unexpected Data value]; ParamOK -- No --> SetUE1; ParamOK -- Yes --> IMSIKnown{IMSI Known}; IMSIKnown -- No --> SetUE2[Set UE= Unidentified Subscriber]; IMSIKnown -- Yes --> 1((1)); SetUE1 --> Response[MAP_INSERT_SUBSCRIBER_DATA_rsp, MAP_CLOSE_Req]; SetUE2 --> Response; Response --> X2((X)); +``` + +Flowchart for Process INS\_SUBS\_DATA\_GLR. It starts with NULL, receives an Open Indication, and then branches based on OK status. The main path involves waiting for indications (MAP\_INSERT\_SUBSCRIBER\_DATA\_ind, MAP\_NOTICE\_ind, MAP\_CLOSE\_req), checking parameters, and then checking if the IMSI is known. Depending on these checks, it either proceeds to the next step (1), sets the UE as unidentified, or sets an unexpected data value, both leading to a response message. + +Figure 20.2.2.2/1 (Sheet 1 of 3): Process INS\_SUBS\_DATA\_GLR + +![Flowchart of Process INS_SUBS_DATA_GLR. It starts with a connector '1', followed by a decision diamond with MAP_OPEN_Req, MAP_INSERT_SUBSCRIBER_DATA_Req, and MAP_DELIMITER. A 'Receive Open Cnf' block follows. From there, an 'OK' path leads to a 'WF PRIMITIVE_OR_CLOSE' block, while a 'Vr, Error' path leads to a 'MAP U ABORT_req' block which ends in a cross. The 'WF PRIMITIVE_OR_CLOSE' block branches into three parallel paths. The first path has 'MAP_CLOSE_ind.' leading to 'MAP_CLOSE_req' (crossed out). The second path has 'MAP_NOTICE_ind' leading to 'MAP_CLOSE_req' leading to 'MAP_U_ABORT_ind' leading to 'Set Not Confirmed by HLR' (crossed out). The third path has 'MAP_U_ABORT_ind. MAP_P_ABORT_ind' leading to 'MAP_U_ABORT_ind' leading to 'Set Not Confirmed by HLR' leading to 'MAP U ABORT req' (crossed out). A second parallel set of paths follows, starting with 'MAP_CLOSE_ind.' leading to 'MAP_CLOSE_req' (crossed out). The next path has 'MAP_NOTICE_ind' leading to 'MAP_CLOSE_req' leading to 'Set Not Confirmed by HLR' leading to 'MAP U ABORT req' (crossed out). The final path has 'MAP_U_ABORT_ind. MAP_P_ABORT_ind' leading to 'Set Not Confirmed by HLR' leading to 'MAP U ABORT req' (crossed out).](db39acbd11df5eb7e79ab84562fb8f74_img.jpg) + +### Process INS\_SUBS\_DATA\_GLR + +20.2.2.2.1\_2(3) + +Figure 20.2.2.2/1: The insert subscriber data process in the GLR + +Arrows to left are to VLR +Arrows to right are to HLR + +``` +graph TD + 1((1)) --> D{MAP_OPEN_Req +MAP_INSERT_SUBSCRIBER_DATA_Req +MAP_DELIMITER} + D --> R[Receive Open Cnf] + R -- OK --> W((WF PRIMITIVE_OR_CLOSE)) + R -- Vr, Error --> UA1{MAP U ABORT_req} + UA1 --> X1((X)) + W --> MC1{MAP_CLOSE_ind.} + W --> MN1{MAP_NOTICE_ind} + W --> MU1{MAP_U_ABORT_ind. +MAP_P_ABORT_ind} + MC1 --> MCReq1{MAP_CLOSE_req} + MCReq1 --> X2((X)) + MN1 --> MCReq2{MAP_CLOSE_req} + MCReq2 --> MUInd1{MAP_U_ABORT_ind} + MUInd1 --> SNC1[Set Not Confirmed by HLR] + SNC1 --> X3((X)) + MU1 --> MUInd2{MAP_U_ABORT_ind} + MUInd2 --> SNC2[Set Not Confirmed by HLR] + SNC2 --> MUReq1{MAP U ABORT req} + MUReq1 --> X4((X)) + W --> MC2{MAP_CLOSE_ind.} + W --> MN2{MAP_NOTICE_ind} + W --> MU2{MAP_U_ABORT_ind. +MAP_P_ABORT_ind} + MC2 --> MCReq3{MAP_CLOSE_req} + MCReq3 --> X5((X)) + MN2 --> MCReq4{MAP_CLOSE_req} + MCReq4 --> SNC3[Set Not Confirmed by HLR] + SNC3 --> MUReq2{MAP U ABORT req} + MUReq2 --> X6((X)) + MU2 --> SNC4[Set Not Confirmed by HLR] + SNC4 --> MUReq3{MAP U ABORT req} + MUReq3 --> X7((X)) +``` + +Flowchart of Process INS\_SUBS\_DATA\_GLR. It starts with a connector '1', followed by a decision diamond with MAP\_OPEN\_Req, MAP\_INSERT\_SUBSCRIBER\_DATA\_Req, and MAP\_DELIMITER. A 'Receive Open Cnf' block follows. From there, an 'OK' path leads to a 'WF PRIMITIVE\_OR\_CLOSE' block, while a 'Vr, Error' path leads to a 'MAP U ABORT\_req' block which ends in a cross. The 'WF PRIMITIVE\_OR\_CLOSE' block branches into three parallel paths. The first path has 'MAP\_CLOSE\_ind.' leading to 'MAP\_CLOSE\_req' (crossed out). The second path has 'MAP\_NOTICE\_ind' leading to 'MAP\_CLOSE\_req' leading to 'MAP\_U\_ABORT\_ind' leading to 'Set Not Confirmed by HLR' (crossed out). The third path has 'MAP\_U\_ABORT\_ind. MAP\_P\_ABORT\_ind' leading to 'MAP\_U\_ABORT\_ind' leading to 'Set Not Confirmed by HLR' leading to 'MAP U ABORT req' (crossed out). A second parallel set of paths follows, starting with 'MAP\_CLOSE\_ind.' leading to 'MAP\_CLOSE\_req' (crossed out). The next path has 'MAP\_NOTICE\_ind' leading to 'MAP\_CLOSE\_req' leading to 'Set Not Confirmed by HLR' leading to 'MAP U ABORT req' (crossed out). The final path has 'MAP\_U\_ABORT\_ind. MAP\_P\_ABORT\_ind' leading to 'Set Not Confirmed by HLR' leading to 'MAP U ABORT req' (crossed out). + +Figure 20.2.2.2/1 (Sheet 2 of 3): Process INS\_SUBS\_DATA\_GLR + +![Flowchart of Process INS_SUBS_DATA_GLR. The process starts with a 'WF PRIMITIVE_OR_CLOSE' primitive, followed by 'MAP_INSERT_SUBSCRIBER_DATA_ind'. A decision 'Parameters OK' follows. If 'Yes', it sends 'MAP_INSERT_SUBSCRIBER_DATA_req' and 'MAP_DELIMITER_req' to the VLR, then receives 'MAP_INSERT_SUBSCRIBER_DATA_rsp' and 'MAP_DELIMITER_req' from the VLR, and finally calls 'WF PRIMITIVE_OR_CLOSE'. If 'No', it sends 'Set UE= Unexpected Data Value' to the HLR. The process then receives 'MAP_INSERT_SUBSCRIBER_DATA_cnf' from the HLR and performs 'Check Confirmation'. If 'OK', it checks 'Service unsupported in VLR?'. If 'Yes', it performs 'GLR internal action'. If 'No', it checks 'Roaming restriction due to unsupported feature or MSC are restricted received'. If 'Yes', it performs 'GLR internal action'. If 'No', it sends 'MAP_INSERT_SUBSCRIBER_DATA_rsp' and 'MAP_DELIMITER_req' to the VLR, saves subscriber data, and calls 'WF PRIMITIVE_OR_CLOSE'. If 'User error, Data error' or 'Provider error' occurs during 'Check Confirmation', it sends 'MAP_U_ABORT_req' to the HLR.](e2c120be98ede6deb60dd341f5a9803b_img.jpg) + +**Process INS\_SUBS\_DATA\_GLR** 20.2.2.2.1\_3(3) + +Figure 20.2.2.2/1: The insert subscriber data process in the GLR + +Arrows to left are to VLR +Arrows to right are to HLR + +``` + +graph TD + Start((WF PRIMITIVE_OR_CLOSE)) --> Ind{MAP_INSERT_SUBSCRIBER_DATA_ind} + Ind --> Params{Parameters OK} + Params -- Yes --> Req1[MAP_INSERT_SUBSCRIBER_DATA_req +MAP_DELIMITER_req] + Req1 --> Rsp1[MAP_INSERT_SUBSCRIBER_DATA_rsp +MAP_DELIMITER_req] + Rsp1 --> End((WF PRIMITIVE_OR_CLOSE)) + Params -- No --> UE[Set UE= Unexpected Data Value] + UE --> CNF{MAP_INSERT_SUBSCRIBER_DATA_cnf} + CNF --> Check[Check Confirmation] + Check -- OK --> Service{Service unsupported in VLR?} + Service -- Yes --> Action1[GLR internal action] + Service -- No --> Roaming{Roaming restriction due to unsupported feature or MSC are restricted received} + Roaming -- Yes --> Action2[GLR internal action] + Roaming -- No --> Req2[MAP_INSERT_SUBSCRIBER_DATA_rsp +MAP_DELIMITER_req] + Req2 --> Save[Save subscriber data] + Save --> End + Check -- "User error, Data error" --> Abort1{MAP_U_ABORT_req} + Abort1 --> HLR + Check -- "Provider error" --> Abort2{MAP_U_ABORT_req} + Abort2 --> HLR + +``` + +Flowchart of Process INS\_SUBS\_DATA\_GLR. The process starts with a 'WF PRIMITIVE\_OR\_CLOSE' primitive, followed by 'MAP\_INSERT\_SUBSCRIBER\_DATA\_ind'. A decision 'Parameters OK' follows. If 'Yes', it sends 'MAP\_INSERT\_SUBSCRIBER\_DATA\_req' and 'MAP\_DELIMITER\_req' to the VLR, then receives 'MAP\_INSERT\_SUBSCRIBER\_DATA\_rsp' and 'MAP\_DELIMITER\_req' from the VLR, and finally calls 'WF PRIMITIVE\_OR\_CLOSE'. If 'No', it sends 'Set UE= Unexpected Data Value' to the HLR. The process then receives 'MAP\_INSERT\_SUBSCRIBER\_DATA\_cnf' from the HLR and performs 'Check Confirmation'. If 'OK', it checks 'Service unsupported in VLR?'. If 'Yes', it performs 'GLR internal action'. If 'No', it checks 'Roaming restriction due to unsupported feature or MSC are restricted received'. If 'Yes', it performs 'GLR internal action'. If 'No', it sends 'MAP\_INSERT\_SUBSCRIBER\_DATA\_rsp' and 'MAP\_DELIMITER\_req' to the VLR, saves subscriber data, and calls 'WF PRIMITIVE\_OR\_CLOSE'. If 'User error, Data error' or 'Provider error' occurs during 'Check Confirmation', it sends 'MAP\_U\_ABORT\_req' to the HLR. + +Figure 20.2.2.2/1 (Sheet 3 of 3): Process INS\_SUBS\_DATA\_GLR + +![SDL Flowchart for Process INS_GPRS_SUBS_DATA_GLR. The process starts at a NULL state, receives an Open Indication, and transitions through various states like Wait_For_indication. It handles MAP messages (INSERT_SUBSCRIBER_DATA, NOTICE, ABORT, CLOSE) and includes decision points for Parameter OK and IMSI Known. Error paths lead to setting UE status to Unidentified Subscriber or Unexpected Data value before closing the MAP connection.](0f6e3cdce0f01d6ccceabcced508bb5b_img.jpg) + +### Process INS\_GPRS\_SUBS\_DATA\_GLR + +20.2.2.2.2\_1(3) + +Figure 20.2.2.2/2: The insert subscriber data +process in the GLR + +Arrows to left are to SGSN +Arrows to right are to HLR + +``` + +graph TD + Start([NULL]) --> RecvInd[Receive +Open Ind] + RecvInd -- OK --> WaitInd[Wait_For_ +indication] + RecvInd -- "'Vr' 'Error'" --> NullEnd([NULL]) + + WaitInd --> MapInsInd[/MAP_INSET_ +SUBSCRIBER_ +DATA ind/] + WaitInd --> MapNotInd[/MAP_ +NOTICE_ind/] + WaitInd --> MapAbortInd[/MAP_U_ABORT_ind. +MAP_P_ABORT_ind +MAP_CLOSE_ind/] + WaitInd --> CheckInd[Check_ +Indication] + + MapNotInd --> MapCloseReq[\MAP_CLOSE_ +req\] + MapCloseReq --> Term1((X)) + + CheckInd -- OK --> ParamOK{Parameter OK} + ParamOK -- Yes --> IMSIKnown{IMSI Known} + ParamOK -- Error --> SetUEUnexpected[Set UE= +Unexpected +Data value] + ParamOK -- No --> SetUEUnexpected + + IMSIKnown -- Yes --> Conn1((1)) + IMSIKnown -- No --> SetUEUnidentified[Set UE= +Unidentified +Subscriber] + + SetUEUnidentified --> MapResp[\MAP_INSERT_SUBSCRIBER_DATA_rsp +MAP_CLOSE_req\] + SetUEUnexpected --> MapResp + MapResp --> Term2((X)) + +``` + +SDL Flowchart for Process INS\_GPRS\_SUBS\_DATA\_GLR. The process starts at a NULL state, receives an Open Indication, and transitions through various states like Wait\_For\_indication. It handles MAP messages (INSERT\_SUBSCRIBER\_DATA, NOTICE, ABORT, CLOSE) and includes decision points for Parameter OK and IMSI Known. Error paths lead to setting UE status to Unidentified Subscriber or Unexpected Data value before closing the MAP connection. + +Figure 20.2.2.2/2 (Sheet 1 of 3): Process INS\_GPRS\_SUBS\_DATA\_GLR + +![Sequence diagram for Process INS_GPRS_SUBS_DATA_GLR. The diagram shows the interaction between a GLR and an HLR. It starts with a circle labeled '1'. The GLR sends MAP_OPEN_Req, MAP_INSERT_SUBSCRIBER_DATA_Req, and MAP_DELIMITER to the HLR. The HLR responds with 'Recieve Open conf'. From this point, two paths emerge: 'OK' and 'Vr, Error'. The 'OK' path leads to a 'WF PRIMITIVE_OR_CLOSE' block, which then branches into three parallel paths: 1) MAP_CLOSE_ind. to SGSN, followed by MAP_CLOSE_req. to HLR, ending with an 'X'. 2) MAP_NOTICE to SGSN, followed by MAP_CLOSE_req. to HLR, then MAP_U_ABORT_ind. to SGSN, then 'Set Not Confirmed by HLR', ending with an 'X'. 3) MAP_U_ABORT_ind. and MAP_P_ABORT_ind. to SGSN, followed by MAP_U_ABORT_ind. to HLR, then 'Set Not Confirmed by HLR', ending with an 'X'. The 'Vr, Error' path from 'Recieve Open conf' leads to MAP_U_ABORT_req. to HLR, ending with an 'X'. The 'WF PRIMITIVE_OR_CLOSE' block also has a rightward branch leading to another set of three parallel paths: 1) MAP_CLOSE_ind. to SGSN, followed by MAP_CLOSE_req. to HLR, ending with an 'X'. 2) MAP_NOTICE ind. to SGSN, followed by MAP_CLOSE_req. to HLR, then MAP_U_ABORT_ind. to SGSN, then 'Set Not Confirmed by HLR', ending with an 'X'. 3) MAP_U_ABORT_ind. and MAP_P_ABORT_ind. to SGSN, followed by 'Set Not Confirmed by HLR', then MAP_U_ABORT_req. to HLR, ending with an 'X'.](5e9af8986a5845504f251d3079da8078_img.jpg) + +### Process INS\_GPRS\_SUBS\_DATA\_GLR + +20.2.2.2.2\_2(3) + +Figure 20.2.2.2/2: The insert subscriber data process in the GLR + +Arrows to left are to SGSN +Arrows to right are to HLR + +``` +sequenceDiagram + participant GLR + participant HLR + Note left of GLR: 1 + GLR->>HLR: MAP_OPEN_Req, MAP_INSERT_SUBSCRIBER_DATA_Req, MAP_DELIMITER + HLR-->>GLR: Recieve Open conf + Note right of GLR: OK + Note right of GLR: Vr, Error + GLR->>HLR: WF PRIMITIVE_OR_CLOSE + Note left of GLR: MAP_CLOSE_ind. + Note left of GLR: MAP_NOTICE + Note left of GLR: MAP_U_ABORT_ind., MAP_P_ABORT_ind. + Note right of GLR: MAP_CLOSE_ind. + Note right of GLR: MAP_NOTICE ind. + Note right of GLR: MAP_U_ABORT_ind., MAP_P_ABORT_ind. + Note left of GLR: MAP_CLOSE_req. + Note left of GLR: MAP_CLOSE_req. + Note left of GLR: MAP_U_ABORT_ind. + Note right of GLR: MAP_CLOSE_req. + Note right of GLR: MAP_CLOSE_req. + Note right of GLR: MAP_U_ABORT_ind. + Note left of GLR: Set Not Confirmed by HLR + Note right of GLR: Set Not Confirmed by HLR + Note right of GLR: MAP_U_ABORT_req. + Note left of GLR: X + Note left of GLR: X + Note left of GLR: X + Note right of GLR: X + Note right of GLR: X + Note right of GLR: X +``` + +Sequence diagram for Process INS\_GPRS\_SUBS\_DATA\_GLR. The diagram shows the interaction between a GLR and an HLR. It starts with a circle labeled '1'. The GLR sends MAP\_OPEN\_Req, MAP\_INSERT\_SUBSCRIBER\_DATA\_Req, and MAP\_DELIMITER to the HLR. The HLR responds with 'Recieve Open conf'. From this point, two paths emerge: 'OK' and 'Vr, Error'. The 'OK' path leads to a 'WF PRIMITIVE\_OR\_CLOSE' block, which then branches into three parallel paths: 1) MAP\_CLOSE\_ind. to SGSN, followed by MAP\_CLOSE\_req. to HLR, ending with an 'X'. 2) MAP\_NOTICE to SGSN, followed by MAP\_CLOSE\_req. to HLR, then MAP\_U\_ABORT\_ind. to SGSN, then 'Set Not Confirmed by HLR', ending with an 'X'. 3) MAP\_U\_ABORT\_ind. and MAP\_P\_ABORT\_ind. to SGSN, followed by MAP\_U\_ABORT\_ind. to HLR, then 'Set Not Confirmed by HLR', ending with an 'X'. The 'Vr, Error' path from 'Recieve Open conf' leads to MAP\_U\_ABORT\_req. to HLR, ending with an 'X'. The 'WF PRIMITIVE\_OR\_CLOSE' block also has a rightward branch leading to another set of three parallel paths: 1) MAP\_CLOSE\_ind. to SGSN, followed by MAP\_CLOSE\_req. to HLR, ending with an 'X'. 2) MAP\_NOTICE ind. to SGSN, followed by MAP\_CLOSE\_req. to HLR, then MAP\_U\_ABORT\_ind. to SGSN, then 'Set Not Confirmed by HLR', ending with an 'X'. 3) MAP\_U\_ABORT\_ind. and MAP\_P\_ABORT\_ind. to SGSN, followed by 'Set Not Confirmed by HLR', then MAP\_U\_ABORT\_req. to HLR, ending with an 'X'. + +Figure 20.2.2.2/2 (Sheet 2 of 3): Process INS\_GPRS\_SUBS\_DATA\_GLR + +![Flowchart of Process INS_GPRS_SUBS_DATA_GLR. The process starts with a 'WF PRIMITIVE_OR_CLOSE' connector, leading to 'MAP_INSERT_SUBSCRIBER_DATA_ind'. A decision 'Parameters OK' follows. If 'No', it goes to 'Set UE= Unexpected Data Value' and then to an unlabeled connector. If 'Yes', it goes to 'MAP_INSERT_SUBSCRIBER_DATA_req' (with 'MAP_DELIMITER_req'), then to another unlabeled connector, then to 'MAP_INSERT_SUBSCRIBER_DATA_rsp' (with 'MAP_DELIMITER_req'). Both unlabeled connectors lead to a 'Roaming_restriction_due_to_unsupported_feature_or_MSC_are_restricted_received' decision. If 'Yes', it goes to 'GLR internal action'. If 'No', it goes to an unlabeled connector, then to 'MAP_INSERTt_SUBSCRIBER_DATA_rsp' (with 'MAP_DELIMITER_req'), then to 'Save subscriber data'. From 'Save subscriber data', the flow goes to 'MAP_INSERT_SUBSCRIBER_DATA_cnf', then to 'Check Confirmation'. From 'Check Confirmation', 'OK' leads to a 'Service unsupported in VLR?' decision. If 'Yes', it goes to 'GLR internal action'. If 'No', it leads to the unlabeled connector before 'Roaming_restriction...'. From 'Service unsupported in VLR?', 'User error, Data error' leads to 'MAP_U_ABORT_req' (to SGSN) and 'Provider error' leads to 'MAP_U_ABORT_req' (to HLR). Both 'MAP_U_ABORT_req' paths end at an 'X' symbol. The process ends at a 'WF PRIMITIVE_OR_CLOSE' connector.](4b398c5e8c4fd656d5b7a61806400650_img.jpg) + +**Process INS\_GPRS\_SUBS\_DATA\_GLR** 20.2.2.2.2\_3(3) + +Figure 20.2.2.2/2: The insert subscriber data process in the GLR + +Arrows to left are to SGSN +Arrows to right are to HLR + +``` + +graph TD + Start((WF PRIMITIVE_OR_CLOSE)) --> Ind{MAP_INSERT_SUBSCRIBER_DATA_ind} + Ind --> Params{Parameters OK} + Params -- No --> SetUE[Set UE= Unexpected Data Value] + Params -- Yes --> Req1[MAP_INSERT_SUBSCRIBER_DATA_req +MAP_DELIMITER_req] + SetUE --> Conn1{ } + Req1 --> Conn2{ } + Conn1 --> Roaming{Roaming_restriction_due_to_unsupported_feature_or_MSC_are_restricted_received} + Conn2 --> Roaming + Roaming -- Yes --> GLR1[GLR internal action] + Roaming -- No --> Conn3{ } + Conn3 --> Rsp1[MAP_INSERTt_SUBSCRIBER_DATA_rsp +MAP_DELIMITER_req] + Rsp1 --> Save[Save subscriber data] + Save --> Cnf{MAP_INSERT_SUBSCRIBER_DATA_cnf} + Cnf --> Check[Check Confirmation] + Check -- OK --> Service{Service unsupported in VLR?} + Service -- Yes --> GLR2[GLR internal action] + Service -- No --> Conn3 + Check -- "User error, Data error" --> Abort1{MAP_U_ABORT_req} + Check -- "Provider error" --> Abort2{MAP_U_ABORT_req} + Abort1 --> X1((X)) + Abort2 --> X2((X)) + Conn3 --> End((WF PRIMITIVE_OR_CLOSE)) + +``` + +Flowchart of Process INS\_GPRS\_SUBS\_DATA\_GLR. The process starts with a 'WF PRIMITIVE\_OR\_CLOSE' connector, leading to 'MAP\_INSERT\_SUBSCRIBER\_DATA\_ind'. A decision 'Parameters OK' follows. If 'No', it goes to 'Set UE= Unexpected Data Value' and then to an unlabeled connector. If 'Yes', it goes to 'MAP\_INSERT\_SUBSCRIBER\_DATA\_req' (with 'MAP\_DELIMITER\_req'), then to another unlabeled connector, then to 'MAP\_INSERT\_SUBSCRIBER\_DATA\_rsp' (with 'MAP\_DELIMITER\_req'). Both unlabeled connectors lead to a 'Roaming\_restriction\_due\_to\_unsupported\_feature\_or\_MSC\_are\_restricted\_received' decision. If 'Yes', it goes to 'GLR internal action'. If 'No', it goes to an unlabeled connector, then to 'MAP\_INSERTt\_SUBSCRIBER\_DATA\_rsp' (with 'MAP\_DELIMITER\_req'), then to 'Save subscriber data'. From 'Save subscriber data', the flow goes to 'MAP\_INSERT\_SUBSCRIBER\_DATA\_cnf', then to 'Check Confirmation'. From 'Check Confirmation', 'OK' leads to a 'Service unsupported in VLR?' decision. If 'Yes', it goes to 'GLR internal action'. If 'No', it leads to the unlabeled connector before 'Roaming\_restriction...'. From 'Service unsupported in VLR?', 'User error, Data error' leads to 'MAP\_U\_ABORT\_req' (to SGSN) and 'Provider error' leads to 'MAP\_U\_ABORT\_req' (to HLR). Both 'MAP\_U\_ABORT\_req' paths end at an 'X' symbol. The process ends at a 'WF PRIMITIVE\_OR\_CLOSE' connector. + +Figure 20.2.2.2/2 (Sheet 3 of 3): Process INS\_GPRS\_SUBS\_DATA\_GLR + +![Flowchart for Process Delete_Subscriber_Data_GLR. The process starts with NULL, receives an Open Indication, and checks if the subscriber is known. If not known, it sets the UE as an unidentified subscriber. If known, it checks if services are registered in a GLR. If not registered, it sets the subscriber as not confirmed by the HLR. If registered, it proceeds to delete subscriber data. The process ends with a response message to the HLR or NULL.](347010b7ac06d3ae97927fde0f784d7c_img.jpg) + +### Process Delete\_Subscriber\_Data\_GLR + +20.2.2.2.3(1) + +Figure 20.2.2.2/3: The delete subscriber data process in the GLR + +Arrows to left are to VLR +Arrows to right are to HLR + +``` +graph TD; NULL1(NULL) --> Rec[Receive Open Ind]; Rec -- OK --> Wait[Wait_For indication]; Rec -- "'Vr' 'Error'" --> NULL2(NULL); Wait --> MAP_DEL[MAP_DELETE_SUBSCRIBER_DATA ind]; MAP_DEL --> Check[Check Indication]; Check --> Know{Subscriber Know}; Know -- No --> SetUE[Set UE= Unidentified Subscriber]; Know -- Yes --> Services{Services registered in a GLR}; Services -- No --> SetNotConf[Set Not Confirmed by HLR]; Services -- Yes --> Delete[Delete Subs Data GLR]; Delete -- "Figure 20.2.2.2/5" --> DeleteSub[Delete Subscriber Data in the GLR]; DeleteSub -- OK --> NULL3(NULL); DeleteSub -- Error --> NULL4(NULL); SetUE --> Join(( )); SetNotConf --> Join; Join --> MAP_RSP[MAP_DELETE_SUBSCRIBER_DATA_rsp MAP_CLOSE_req]; MAP_RSP --> NULL5(NULL); +``` + +Flowchart for Process Delete\_Subscriber\_Data\_GLR. The process starts with NULL, receives an Open Indication, and checks if the subscriber is known. If not known, it sets the UE as an unidentified subscriber. If known, it checks if services are registered in a GLR. If not registered, it sets the subscriber as not confirmed by the HLR. If registered, it proceeds to delete subscriber data. The process ends with a response message to the HLR or NULL. + +Figure 20.2.2.2/3: Process Delete\_Subscriber\_Data\_GLR + +![Flowchart for Process Delete_GPRS_Subscriber_Data_GLR. The process starts with NULL, receives an Open Indication, and checks if the subscriber is known. If not known, it sets the UE as an unidentified subscriber. If known, it checks if services are registered in a GLR. If not registered, it sets the subscriber as not confirmed by HLR. If registered, it deletes GPRS subscriber data and sends a response. Arrows pointing left are to SGSN, and arrows pointing right are to HLR.](694df81535f89c7bfb9ef0df6f130dc0_img.jpg) + +### Process Delete\_GPRS\_Subscriber\_Data\_GLR + +20.2.2.2.4(1) + +Figure 20.2.2.2/4: The delete subscriber data process in the GLR + +Arrows to left are to SGSN +Arrows to right are to HLR + +``` +graph TD; NULL1([NULL]) --> RecInd[Receive Open Ind]; RecInd -- OK --> WaitFor[Wait_For indication]; RecInd -- "'Vr' 'Error'" --> NULL2([NULL]); WaitFor --> MAPDel[MAP_DELETE_SUBSCRIBER_DATA ind]; MAPDel --> CheckInd[Check Indication]; CheckInd --> SubKnow{Subscriber Know}; SubKnow -- Yes --> ServicesReg{Services registered in a GLR}; SubKnow -- No --> SetUE[Set UE= Unidentified Subscriber]; SubKnow -- Error --> SetNotConf[Set Not Confirmed by HLR]; ServicesReg -- Yes --> DeleteData[Delete GPRS Subs Data GLR]; ServicesReg -- No --> Join1(( )); SetUE --> Join1; SetNotConf --> Join1; DeleteData -- "OK" --> DeleteSubData[Delete Subscriber Data in the GLR]; DeleteData -- Error --> Join2(( )); DeleteSubData --> Join2; Join1 --> MAPRsp[MAP_DELETE_SUBSCRIBER_DATA_rsp MAP_CLOSE_req]; Join2 --> MAPRsp; MAPRsp --> Join3(( )); Join3 --> End1(( )); Join3 --> End2(( )); Join3 --> End3(( )); +``` + +Flowchart for Process Delete\_GPRS\_Subscriber\_Data\_GLR. The process starts with NULL, receives an Open Indication, and checks if the subscriber is known. If not known, it sets the UE as an unidentified subscriber. If known, it checks if services are registered in a GLR. If not registered, it sets the subscriber as not confirmed by HLR. If registered, it deletes GPRS subscriber data and sends a response. Arrows pointing left are to SGSN, and arrows pointing right are to HLR. + +Figure 20.2.2.2/4: Process Delete\_GPRS\_Subscriber\_Data\_GLR + +![Flowchart for Macro Delete_Subs_Data_GLR. The process starts with an entry point, followed by sending MAP_OPEN_req, MAP_DELETE_SUBSCRIBER_DATA_req, and MAP_DELIMITER. It then receives an 'Open cnf' and enters a 'Wait_For_Confirm' state. From there, it branches based on received indications: MAP_CLOSE_ind., MAP_NOTICE_ind, MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_DELETE_SUBSCRIBER_DATA.cnf, and another MAP_NOTICE_ind. The first three lead to MAP_CLOSE_req and then either MAP_CLOSE Req or MAP_U_ABORT_ind, both ending in Error. The fourth leads to an Error state. The fifth leads to a decision diamond 'MSC_Area_Restricted_received or Roaming_Restricted_Due_To_Unsupported_Feature'. If 'Yes', it sends MAP_U_ABORT req and ends in Error. If 'No', it checks 'MSC_Area_Restricted_Flag'. If 'not Restricted', it sends MAP_DELETE_SUBSCRIBER_DATA_Cnf and ends in Error. If 'Restricted', it sends MAP_DELETE_SUBSCRIBER_DATA_Cnf and ends in OK. The sixth indication leads to MAP_CLOSE_req and then to the right side of the Wait_For_Confirm loop. The seventh leads to the right side of the Wait_For_Confirm loop and ends in Vr,Error.](2a476a0b3dbc3429436246db4784ff9f_img.jpg) + +### Macrodefinition Delete\_Subs\_Data\_GLR 20.2.2.2.5(1) + +Figure 20.2.2.2/5: The delete subscriber data macro in the GLR + +Arrows to left are to VLR +Arrows to right are to HLR + +``` +graph TD + Start([ ]) --> Init["MAP_OPEN_req +MAP_DELETE_SUBSCRIBER_DATA_req +MAP_DELIMITER"] + Init --> RecvOpen["Receive Open cnf"] + RecvOpen -- Ok --> WaitForConfirm{Wait_For_Confirm} + WaitForConfirm --> Branch1[ ] + subgraph Branch1 + direction TB + B1[MAP_CLOSE_ind.] + B2[MAP_NOTICE_ind] + B3[MAP_U_ABORT_ind +MAP_P_ABORT_ind] + B4[MAP_DELETE_SUBSCRIBER_DATA.cnf] + B5[MAP_NOTICE_ind] + B6[MAP_U_ABORT_ind +MAP_P_ABORT_ind +MAP_CLOSE_ind] + end + B1 --> MAP_CLOSE_req1[MAP_CLOSE_req] + MAP_CLOSE_req1 --> MAP_CLOSE Req[MAP_CLOSE Req] + MAP_CLOSE Req --> Error1((Error)) + B2 --> MAP_CLOSE_req2[MAP_CLOSE_req] + MAP_CLOSE_req2 --> MAP_U_ABORT_ind2[MAP_U_ABORT_ind] + MAP_U_ABORT_ind2 --> Error2((Error)) + B3 --> Error3((Error)) + B4 --> Decision1{MSC_Area_Restricted_received or "Roaming_Restricted_Due_To_Unsupported_Feature"} + Decision1 -- Yes --> MAP_U_ABORT req[MAP_U_ABORT req] + MAP_U_ABORT req --> Error4((Error)) + Decision1 -- No --> Decision2{MSC_Area_Restricted_Flag} + Decision2 -- "not Restricted" --> MAP_DELETE_SUBSCRIBER_DATA_Cnf1[MAP_DELETE_SUBSCRIBER_DATA_Cnf] + MAP_DELETE_SUBSCRIBER_DATA_Cnf1 --> Error5((Error)) + Decision2 -- "Restricted" --> MAP_DELETE_SUBSCRIBER_DATA_Cnf2[MAP_DELETE_SUBSCRIBER_DATA_Cnf] + MAP_DELETE_SUBSCRIBER_DATA_Cnf2 --> OK((OK)) + B5 --> MAP_CLOSE_req3[MAP_CLOSE_req] + MAP_CLOSE_req3 --> WaitForConfirm + B6 --> VrError[Vr,Error] +``` + +Flowchart for Macro Delete\_Subs\_Data\_GLR. The process starts with an entry point, followed by sending MAP\_OPEN\_req, MAP\_DELETE\_SUBSCRIBER\_DATA\_req, and MAP\_DELIMITER. It then receives an 'Open cnf' and enters a 'Wait\_For\_Confirm' state. From there, it branches based on received indications: MAP\_CLOSE\_ind., MAP\_NOTICE\_ind, MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_DELETE\_SUBSCRIBER\_DATA.cnf, and another MAP\_NOTICE\_ind. The first three lead to MAP\_CLOSE\_req and then either MAP\_CLOSE Req or MAP\_U\_ABORT\_ind, both ending in Error. The fourth leads to an Error state. The fifth leads to a decision diamond 'MSC\_Area\_Restricted\_received or Roaming\_Restricted\_Due\_To\_Unsupported\_Feature'. If 'Yes', it sends MAP\_U\_ABORT req and ends in Error. If 'No', it checks 'MSC\_Area\_Restricted\_Flag'. If 'not Restricted', it sends MAP\_DELETE\_SUBSCRIBER\_DATA\_Cnf and ends in Error. If 'Restricted', it sends MAP\_DELETE\_SUBSCRIBER\_DATA\_Cnf and ends in OK. The sixth indication leads to MAP\_CLOSE\_req and then to the right side of the Wait\_For\_Confirm loop. The seventh leads to the right side of the Wait\_For\_Confirm loop and ends in Vr,Error. + +Figure 20.2.2.2/5: Macro Delete\_Subs\_Data\_GLR + +![SDL Diagram for Macro Delete_GPRS_Subs_Data_GLR showing the flow from initiation, sending requests to HLR, waiting for confirmation, handling various MAP indications, and reaching either an OK or Error state based on decision logic regarding SGSN Area Restricted flags.](0931f3e098bd4539041de11c50cec2d2_img.jpg) + +**Macrodefinition Delete\_GPRS\_Subs\_Data\_GLR** 20.2.2.2.6(1) + +Figure 20.2.2.2/6: The delete subscriber data macro in the GLR + +Arrows to left are to SGSN + Arrows to right are to HLR + + + +``` + + graph TD + Start([ ]) --> Out1[/ /] + Out1 --> Req1[MAP_OPEN_req +MAP_DELETE_SUBSCRIBER_DATA_req +MAP_DELIMITER] + Req1 --> In1[/Receive +Open Cnf/] + In1 -- Ok --> Wait[Wait_For_ +Confirm] + + Wait --> Ind1{MAP_CLOSE_ +ind.} + Wait --> Ind2{MAP_NOTICE +ind} + Wait --> Ind3{MAP_U_ABORT_ind +MAP_P_ABORT_ind} + Wait --> Ind4{MAP_DELETE_ +SUBSCRIBER_ +DATA Cnf} + Wait --> Ind5{MAP_NOTICE +ind} + Wait --> Ind6{MAP_U_ABORT_ind +MAP_P_ABORT_ind +MAP_CLOSE_ind} + Wait -- Vr,Error --> Exit1(( )) + + Ind1 --> CloseReq1[MAP_CLOSE_ +Req] + CloseReq1 --> Error1((Error)) + + Ind2 --> CloseReq2[MAP_CLOSE_req] + CloseReq2 --> UAbortInd[MAP_U_ABORT_ind.] + UAbortInd --> Error2((Error)) + + Ind3 --> Error2 + + Ind4 --> ErrorDec{Error} + ErrorDec -- Yes --> Error2 + ErrorDec -- No --> AreaDec{SGSN_Area_Restricted_received or +"Roaming_Restricted_Due_ +To_Unsupported_Feature"} + + AreaDec -- Yes --> AreaRestricted[SGSN_Area_ +Restricted_Flag +=Restricted] + AreaDec -- No --> AreaNotRestricted[SGSN_Area_ +Restricted_Flag +not Restricted] + + AreaRestricted --> DelCnf1[MAP_DELETE_ +SUBSCRIBER_ +DATA_Cnf] + AreaNotRestricted --> DelCnf2[MAP_DELETE_ +SUBSCRIBER_ +DATA_Cnf] + + DelCnf1 --> Error3((Error)) + DelCnf2 --> OK1((OK)) + + Ind5 --> CloseReq3[MAP_CLOSE_ +req] + CloseReq3 --> Exit1 + + Ind6 --> UAbortReq[MAP U ABORT req] + UAbortReq --> Error4((Error)) + +``` + +SDL Diagram for Macro Delete\_GPRS\_Subs\_Data\_GLR showing the flow from initiation, sending requests to HLR, waiting for confirmation, handling various MAP indications, and reaching either an OK or Error state based on decision logic regarding SGSN Area Restricted flags. + +Figure 20.2.2.2/6: Macro Delete\_GPRS\_Subs\_Data\_GLR + +## 20.3 Subscriber Identity procedure + +In the subscriber identity procedure the IMSI of the subscriber is retrieved from the HLR. The procedure is shown in figure 20.3/1. + +![Sequence diagram showing the subscriber identity procedure between OMC, VLR, GLR, and HLR. The sequence is: 1) Identity request from OMC to VLR; 2) MAP_SEND_IMSI from VLR to GLR and HLR; 3) MAP_SEND_IMSI_ACK from GLR and HLR to VLR; 4) Identity confirm from VLR to OMC.](ffb6acd27b8e3a54392840948a75869f_img.jpg) + +``` +sequenceDiagram + participant OMC + participant VLR + participant GLR + participant HLR + Note left of OMC: 1) Identity request. + OMC->>VLR: 1. + Note right of VLR: 2) MAP_SEND_IMSI. + VLR->>GLR: 2. + VLR->>HLR: 2. + Note right of GLR: 3) MAP_SEND_IMSI_ACK. + GLR->>VLR: 3. + HLR->>VLR: 3. + Note left of VLR: 4) Identity confirm. + VLR->>OMC: 4. +``` + +Sequence diagram showing the subscriber identity procedure between OMC, VLR, GLR, and HLR. The sequence is: 1) Identity request from OMC to VLR; 2) MAP\_SEND\_IMSI from VLR to GLR and HLR; 3) MAP\_SEND\_IMSI\_ACK from GLR and HLR to VLR; 4) Identity confirm from VLR to OMC. + +- 1) Identity request. +- 2) MAP\_SEND\_IMSI. +- 3) MAP\_SEND\_IMSI\_ACK. +- 4) Identity confirm. + +**Figure 20.3/1: The subscriber identity procedure** + +### 20.3.1 Subscriber identity procedure in the GLR + +The subscriber identity procedure in the GLR is shown in figure 20.3/2. + +![Flowchart of the Send_IMSI_GLR process. It starts at 'Idle', receives an 'Open_ind', and enters 'Wait For Response'. From there, it can send 'MAP_NOTICE_ind' or 'MAP_SEND_IMSI_ind' to the VLR (left), perform a 'Vr Dialogue' with the HLR (right), or encounter an 'Error'. The 'MAP_NOTICE_ind' path leads to 'MAP_CLOSE_req' and back to 'Idle'. The 'MAP_SEND_IMSI_ind' path leads to 'Check Indication', which checks if the 'Subscriber Known'. If 'Yes', it sends 'MAP_OPEN_req', 'MAP_SEND_IMSI_req', and 'MAP_SWLIMITER_req' to the HLR, receives 'Open_Cnf', and outputs 'WF_IDENTITY_RESULT' to the VLR. If 'No', it sets 'UE= Unknown Subscriber', receives 'MAP_SEND_IMSI_rsp' and 'MAP_CLOSE_req' from the HLR, and returns to 'Idle'. The 'Vr Dialogue' path leads to 'Idle' or an 'Error'. The 'Error' path from 'Wait For Response' also leads to 'Idle'. Finally, 'WF_IDENTITY_RESULT' leads to 'MAP_U_ABORT_req' (on 'Vr, Error') or back to 'Idle' (on 'Ok').](719ef0f734259484038b2434e5dc3f24_img.jpg) + +### Process Send\_IMSI\_GLR + +20.3.2\_1(2) + +Figure 20.3/2: The send IMSI process in the GLR + +Arrows to left are to VLR +Arrows to right are to HLR + +``` +graph TD; Idle1([Idle]) --> RecOpen[Receive Open_ind]; RecOpen --> WaitForResponse([Wait For Response]); WaitForResponse --> MAP_NOTICE_ind{MAP_NOTICE_ind}; WaitForResponse --> MAP_SEND_IMSI_ind{MAP_SEND_IMSI_ind}; WaitForResponse --> Vr[Perform Vr Dialogue]; WaitForResponse --> Error1[Error]; MAP_NOTICE_ind --> MAP_CLOSE_req{MAP_CLOSE_req}; MAP_CLOSE_req --> Idle2([Idle]); MAP_SEND_IMSI_ind --> CheckIndication[Check Indication]; CheckIndication --> SubKnown{OK Subscriber Known}; SubKnown -- Yes --> MAP_OPEN_req[MAP_OPEN_req +MAP_SEND_IMSI_req +MAP_SWLIMITER_req]; SubKnown -- No --> SetUE[Set UE= Unknown Subscriber]; SetUE --> MAP_SEND_IMSI_rsp[MAP_SEND_IMSI_rsp +MAP_CLOSE_req]; MAP_SEND_IMSI_rsp --> Idle3([Idle]); MAP_OPEN_req --> RecOpenCnf[Receive Open_Cnf]; RecOpenCnf -- Ok --> WF_IDENTITY_RESULT{WF_IDENTITY RESULT}; RecOpenCnf -- "Vr, Error" --> MAP_U_ABORT_req{MAP_U_ABORT_req}; WF_IDENTITY_RESULT --> Idle4([Idle]); MAP_U_ABORT_req --> Idle5([Idle]); +``` + +Flowchart of the Send\_IMSI\_GLR process. It starts at 'Idle', receives an 'Open\_ind', and enters 'Wait For Response'. From there, it can send 'MAP\_NOTICE\_ind' or 'MAP\_SEND\_IMSI\_ind' to the VLR (left), perform a 'Vr Dialogue' with the HLR (right), or encounter an 'Error'. The 'MAP\_NOTICE\_ind' path leads to 'MAP\_CLOSE\_req' and back to 'Idle'. The 'MAP\_SEND\_IMSI\_ind' path leads to 'Check Indication', which checks if the 'Subscriber Known'. If 'Yes', it sends 'MAP\_OPEN\_req', 'MAP\_SEND\_IMSI\_req', and 'MAP\_SWLIMITER\_req' to the HLR, receives 'Open\_Cnf', and outputs 'WF\_IDENTITY\_RESULT' to the VLR. If 'No', it sets 'UE= Unknown Subscriber', receives 'MAP\_SEND\_IMSI\_rsp' and 'MAP\_CLOSE\_req' from the HLR, and returns to 'Idle'. The 'Vr Dialogue' path leads to 'Idle' or an 'Error'. The 'Error' path from 'Wait For Response' also leads to 'Idle'. Finally, 'WF\_IDENTITY\_RESULT' leads to 'MAP\_U\_ABORT\_req' (on 'Vr, Error') or back to 'Idle' (on 'Ok'). + +Figure 20.3/2 (Sheet 1 of 2): Process Send\_IMSI\_GLR + +#### Process Send\_IMSI\_GLR + +20.3.2\_2(2) + +Figure 20.3/2: The send IMSI process in the GLR + +Arrows to left are to VLR +Arrows to right are to HLR + +![Flowchart of Process Send_IMSI_GLR showing interactions between VLR and HLR.](18dbea0ac6b7ad13e47afda3ddd53b64_img.jpg) + +``` +graph TD; Start([WF_IDENTITY_RESULT]) --> VLR[MAP_SEND_IMSI_cnf]; VLR --> Confirm[Check Confirmation]; Confirm -- OK --> End1([Idle]); Confirm -- Error --> SetError[Set error]; SetError --> End1; SetError --> VLR_rsp[MAP_SEND_IMSI_rsp +MAP_CLOSE_req]; VLR_rsp --> End1; Start --> HLR[MAP_NOTICE_ind]; HLR --> CloseReq[MAP_CLOSE_req]; CloseReq --> AbortReq{MAP_U_ABORT_req}; AbortReq --> End2([Idle]); AbortReq --> Indications[MAP_CLOSE_ind +MAP_U_ABORT_ind +MAP_P_ABORT_ind]; +``` + +The flowchart illustrates the 'Process Send\_IMSI\_GLR'. It begins with an entry point 'WF\_IDENTITY\_RESULT'. From here, a message 'MAP\_SEND\_IMSI\_cnf' is sent to the VLR (indicated by an arrow pointing left). The VLR performs a 'Check Confirmation'. If the result is 'OK', the process ends at an 'Idle' state. If the result is 'Error', it proceeds to 'Set error'. From 'Set error', the process can end at 'Idle' or send 'MAP\_SEND\_IMSI\_rsp' and 'MAP\_CLOSE\_req' back to the HLR (indicated by an arrow pointing right) before ending at 'Idle'. Another path from 'WF\_IDENTITY\_RESULT' sends 'MAP\_NOTICE\_ind' to the HLR. The HLR responds with 'MAP\_CLOSE\_req' to the VLR. The VLR then sends a 'MAP\_U\_ABORT\_req' (indicated by a diamond-shaped decision node). This request leads to an 'Idle' state and also triggers a set of indications: 'MAP\_CLOSE\_ind', 'MAP\_U\_ABORT\_ind', and 'MAP\_P\_ABORT\_ind'. + +Flowchart of Process Send\_IMSI\_GLR showing interactions between VLR and HLR. + +Figure 20.3/2 (Sheet 2 of 2): Process Send\_IMSI\_GLR + +# --- 21 Call handling procedures + +## 21.1 General + +The MAP call handling procedures are used: + +1. to retrieve routing information to handle a mobile terminating call; +2. to transfer control of a call back to the GMSC if the call is to be forwarded; +3. to retrieve and transfer information between anchor MSC and relay MSC for inter MSC group calls / broadcast calls; +4. to allocate resources in an SIWFS; +5. to handle the reporting of MS status for call completion services; +6. to handle the notification of remote user free for CCBS. + +Items 1, 5 and 6 are only procedures that have impact to the GLR. The following subclause describes the function of the GLR related to these procedures. + +## 21.2 Retrieval of routing information + +### 21.2.1 General + +The message flows for successful retrieval of routeing information for a mobile terminating call are shown in figure 21.2.1/1 (mobile terminating call which has not been optimally routed) and 21.2.1/2 (mobile-to-mobile call which has been optimally routed). + +![Sequence diagram showing message flow for retrieval of routing information (non-optimally routed call).](4847c98185bc52e8786b78738bc52b45_img.jpg) + +``` + +sequenceDiagram + participant Network + participant Gateway as Gateway MSC + participant HLR + participant GLR + participant VLR + + Network->>Gateway: I_IAM (note2) + Gateway->>HLR: MAP_SEND_ROUTING_INFO + Note right of HLR: (note 1) + HLR->>GLR: MAP_PROVIDE_SUBSCRIBER_INFO + GLR->>VLR: MAP_PROVIDE_SUBSCRIBER_INFO + VLR->>GLR: MAP_PROVIDE_SUBSCRIBER_INFO ack + GLR->>HLR: MAP_PROVIDE_SUBSCRIBER_INFO ack + HLR->>Gateway: MAP_SEND_ROUTING_INFO ack + Gateway->>HLR: MAP_SEND_ROUTING_INFO + HLR->>GLR: MAP_PROVIDE_ROAMING_NUMBER + GLR->>VLR: MAP_PROVIDE_ROAMING_NUMBER + VLR->>GLR: MAP_PROVIDE_ROAMING_NUMBER ack + GLR->>HLR: MAP_PROVIDE_ROAMING_NUMBER ack + HLR->>Gateway: MAP_SEND_ROUTING_INFO ack + Gateway->>Network: I_IAM + +``` + +The diagram illustrates the message flow for a non-optimally routed mobile terminating call. It involves five entities: Network, Gateway (MSC), HLR, GLR, and VLR. The process starts with the Network sending an I\_IAM message to the Gateway MSC. The Gateway then sends a MAP\_SEND\_ROUTING\_INFO message to the HLR. The HLR sends a MAP\_PROVIDE\_SUBSCRIBER\_INFO message to the GLR, which in turn sends it to the VLR. The VLR returns a MAP\_PROVIDE\_SUBSCRIBER\_INFO ack to the GLR, which returns it to the HLR. The HLR then sends a MAP\_SEND\_ROUTING\_INFO ack to the Gateway. The Gateway sends another MAP\_SEND\_ROUTING\_INFO message to the HLR. The HLR sends a MAP\_PROVIDE\_ROAMING\_NUMBER message to the GLR, which sends it to the VLR. The VLR returns a MAP\_PROVIDE\_ROAMING\_NUMBER ack to the GLR, which returns it to the HLR. The HLR then sends a MAP\_SEND\_ROUTING\_INFO ack to the Gateway. Finally, the Gateway sends an I\_IAM message back to the Network. + +Sequence diagram showing message flow for retrieval of routing information (non-optimally routed call). + +Notes: + +xxx = *Optional Procedure* + +NOTE 1: This service may also be used by an ISDN exchange for obtaining routing information from the HLR. + +NOTE 2: TUP or ISUP may be used in signalling between MSCs, depending on the network type between the MSCs. For further details on the TUP and ISUP procedures refer to the following ITU-T Recommendations and ETSI specification: + +Q.721-725 - Telephone User Part (TUP); + +ETS 300 356-1 - Integrated Services Digital Network (ISDN); Signalling System No.7; ISDN User Part (ISUP) version 2 for the international interface; Part 1: Basic services. + +NOTE 3: As a network operator option, the HLR sends MAP\_PROVIDE\_SUBSCRIBER\_INFORMATION to the VLR. For further details on the CAMEL procedures refer to GSM 3GPP TS 03.78. + +**Figure 21.2.1/1: Message flow for retrieval of routeing information (non-optimally routed call)** + +![Sequence diagram showing message flow for retrieval of routing information (optimally routed call).](e7010c66da16316c2935dfbbef5056b3_img.jpg) + +``` + +sequenceDiagram + participant Network + participant Gateway as Gateway + participant HLR + participant GLR + participant VLR + + Note left of Network: I_IAM (note) + Network->>Gateway: MAP_SEND_ROUTING +INFO + Gateway->>HLR: MAP_PROVIDE_SUB- +SCRIBER_INFO + HLR->>GLR: MAP_PROVIDE_SUB- +SCRIBER_INFO + GLR->>VLR: MAP_PROVIDE_SUB- +SCRIBER_INFO + VLR->>GLR: MAP_PROVIDE_SUB- +SCRIBER_INFO ack + GLR->>HLR: MAP_PROVIDE_SUB- +SCRIBER_INFO ack + Note right of GLR: OR + HLR->>GLR: MAP_PROVIDE_ROAMING +NUMBER + GLR->>VLR: MAP_PROVIDE_ROAMING +NUMBER + VLR->>GLR: MAP_PROVIDE_ROAMING +NUMBER ack + GLR->>HLR: MAP_PROVIDE_ROAMING +NUMBER ack + HLR->>Gateway: MAP_SEND_ROUTING +INFO ack + Gateway->>Network: I_IAM + +``` + +Sequence diagram showing message flow for retrieval of routing information (optimally routed call). + +**Figure 21.2.1/2: Message flow for retrieval of routing information (optimally routed call)** + +#### **Notes:** + +xxx = *Optional Procedure.* + +For Optimal Routing phase 1, only one of the information flows for Provide Subscriber Info and Provide Roaming Number is used. For later phases of Optimal Routing, the HLR may return a MAP\_SEND\_ROUTING\_INFORMATION ack after the Provide Subscriber Info information flow, and the GMSC may send a second MAP\_SEND\_ROUTING\_INFORMATION, which will trigger the Provide Roaming Number information flow. + +TUP or ISUP may be used in signalling between MSCs, depending on the network type between the MSCs. For further details on the TUP and ISUP procedures refer to the following CCITT. + +Recommendations & ETSI specification: + +Q.721-725 - Telephone User Part (TUP); + +ETS 300 356-1 - Integrated Services Digital Network (ISDN); Signalling System No.7; ISDN User Part (ISUP) version 2 for the international interface; Part 1: Basic services. + +### 21.2.2 Process in the GLR to provide a roaming number + +The MAP process in the GLR to provide a roaming number for a mobile terminating call is shown in figure 21.2.2/1 (Process PRN\_Receive\_GLR) and figure 21.2.2/2 (Process PRN\_Send\_GLR). The MAP process invokes a macro not defined in this subclause; the definition of this macro can be found as follows: + +- Receive\_Open\_Ind see subclause 25.1. +- Receive\_Open\_Cnf see subclause 25.1. +- Check\_Confirmation see subclause 25.2. + +![SDL Diagram for Process PRN_Receive_GLR showing state transitions and signal handling between HLR and GLR Call process.](dbd4bab54b57e8d1abf80e3de6471130_img.jpg) + +### Process PRN\_Receive\_GLR + +21.2.2.1(1) + +Figure 21.2.2/1: Process in the GLR to respond to a request routeing information + +Signals to/from the left are to/from the HLR; +signals to/from the right are to/from the GLR Call process + +``` + +graph TD + Start([ ]) --> Idle1([Idle]) + Idle1 --> RecOpen[Receive Open Ind] + RecOpen -- Vr --> PerfMAP[Perform MAP Vr Dialogue] + RecOpen -- OK --> WaitServ[Wait For Service Indication] + RecOpen -- Error --> IdleErr([Idle]) + + PerfMAP --> IdleVr([Idle]) + + WaitServ --> MAP_P_ABORT_ind{{MAP_P_ABORT_ind.}} + MAP_P_ABORT_ind --> IdleAbort([Idle]) + + WaitServ --> MAP_PRN_ind{{MAP_PROVIDE_ROAMING_NUMBER_ind.}} + MAP_PRN_ind --> ProvRoam[Provide Roaming Number To GLR Call process] + ProvRoam --> WaitResp([Wait For Response]) + + WaitServ --> MAP_NOT_ind{{MAP_NOTICE_ind.}} + MAP_NOT_ind --> MAP_CLOSE_req>MAP_CLOSE_req< + MAP_CLOSE_req --> IdleNot([Idle]) + + WaitResp --> PRN_ack{{Provide Roaming Number ack}} + WaitResp --> PRN_neg{{Provide Roaming Number negative response}} + WaitResp --> Abort{{Abort}} + + PRN_ack --> SetRes[Set result] + PRN_neg --> SetErr[Set error] + Abort --> MAP_U_ABORT_req>MAP_U_ABORT_req< + MAP_U_ABORT_req --> IdleUAbort([Idle]) + + SetRes --> MAP_PRN_rsp>MAP_PROVIDE_ROAMING_NUMBER_rsp.< + SetErr --> MAP_PRN_rsp + MAP_PRN_rsp --> IdleFinal([Idle]) + +``` + +SDL Diagram for Process PRN\_Receive\_GLR showing state transitions and signal handling between HLR and GLR Call process. + +**Figure 21.2.2/1: Process PRN\_Receive\_GLR** + +![State transition diagram for Process PRN_Send_GLR. The process starts at 'Idle', transitions to 'Provide Roaming Number', then to a state where it sends MAP_Open_req, MAP_PROVIDE_ROAMING_NUMBER_req, and MAP_DELIMITER_req. It then receives an 'Open cnf' and enters 'Wait For Response'. From there, it can receive 'MAP_PROVIDE_ROAMING_NUMBER_cnf' (OK), 'MAP_U_ABORT_ind'/'MAP_P_ABORT_ind' (Vr), or 'MAP_NOTICE_ind' (Error). The first leads to 'Check Confirmation' and then either 'Provide Roaming Number ack' (OK) or 'Provide Roaming Number negative response' (Error). The second and third lead to 'Abort'.](4806f9f95fff13a30d6523bd6ffeac63_img.jpg) + +### Process PRN\_Send\_GLR 21.2.2.2(1) + +Figure 21.2.2/2: Process in the GLR to respond to a request routing information + +Signals to/from the left are to/from the GLR Call; process signals to/from the right are to/from the VLR + +``` +stateDiagram-v2 + [*] --> Idle + Idle --> ProvideRoamingNumber: Provide Roaming Number + state " " as Outbound + ProvideRoamingNumber --> Outbound + Outbound --> ReceiveOpenCnf: MAP_Open_req, MAP_PROVIDE_ROAMING_NUMBER_req, MAP_DELIMITER_req + ReceiveOpenCnf --> WaitForResponse: Open cnf + state "Wait For Response" as WaitForResponse + WaitForResponse --> CheckConfirmation: MAP_PROVIDE_ROAMING_NUMBER_cnf (OK) + WaitForResponse --> PerformMAPVr: MAP_U_ABORT_ind, MAP_P_ABORT_ind (Vr) + WaitForResponse --> MAP_NOTICE_ind: MAP_NOTICE_ind (Error) + PerformMAPVr --> [*] + MAP_NOTICE_ind --> MAP_CLOSE_req + MAP_CLOSE_req --> Abort + Abort --> [*] + CheckConfirmation --> ProvideRoamingNumberAck: OK + CheckConfirmation --> ProvideRoamingNumberNegativeResponse: Error + ProvideRoamingNumberAck --> [*] + ProvideRoamingNumberNegativeResponse --> [*] +``` + +State transition diagram for Process PRN\_Send\_GLR. The process starts at 'Idle', transitions to 'Provide Roaming Number', then to a state where it sends MAP\_Open\_req, MAP\_PROVIDE\_ROAMING\_NUMBER\_req, and MAP\_DELIMITER\_req. It then receives an 'Open cnf' and enters 'Wait For Response'. From there, it can receive 'MAP\_PROVIDE\_ROAMING\_NUMBER\_cnf' (OK), 'MAP\_U\_ABORT\_ind'/'MAP\_P\_ABORT\_ind' (Vr), or 'MAP\_NOTICE\_ind' (Error). The first leads to 'Check Confirmation' and then either 'Provide Roaming Number ack' (OK) or 'Provide Roaming Number negative response' (Error). The second and third lead to 'Abort'. + +Figure 21.2.2/2: Process PRN\_Send\_GLR + +### 21.2.3 Process in the GLR to provide subscriber information + +The MAP process in the GLR to provide subscriber information for a mobile terminating call is shown in figure 21.2.3/1 (Process PSI Receive\_GLR) and figure 21.2.3/2 (Process PSI Send\_GLR). The MAP process invokes a macro not defined in this subclause; the definition of this macro can be found as follows: + +| | | +|--------------------|---------------------| +| Receive_Open_Ind | see subclause 25.1. | +| Receive_Open_Cnf | see subclause 25.1. | +| Check_Confirmation | see subclause 25.2. | + +![Flowchart for Process PSI_Receive_GLR. It starts at an Idle state, receives an Open Indication, and then branches based on OK, Error, or Vr signals. The main path involves waiting for a service indication, sending a MAP_PROVIDE_SUBSCRIBER_INFO_ind, waiting for a response, and then handling ack, negative response, or abort signals to either set a result, set an error, or send a MAP_U_ABORT_req before returning to Idle.](9c45844d796e85ae05505870a54e4eb4_img.jpg) + +### Process PSI\_Receive\_GLR + +21.2.3.1(1) + +Figure 21.2.3/1: Process in the GLR to respond to a request routing information + +Signals to/from the left are to/from the HLR; signals to/from the right are to/from the GLR Call process + +``` +graph TD; Start([Idle]) --> OpenInd[Receive Open Ind]; OpenInd --> Vr{Vr}; Vr -- OK --> WaitForService([Wait For Service Indication]); Vr -- Error --> Idle1([Idle]); Vr -- Vr --> PerformMAP[Perform MAP Vr Dialogue]; PerformMAP --> Idle2([Idle]); WaitForService --> MAP_P_ABORT_ind{MAP_P_ABORT_ind}; WaitForService --> MAP_PROVIDE_SUBSCRIBER_INFO_ind[MAP_PROVIDE_SUBSCRIBER_INFO_ind]; WaitForService --> MAP_NOTICE_ind{MAP_NOTICE_ind}; MAP_P_ABORT_ind --> Idle3([Idle]); MAP_PROVIDE_SUBSCRIBER_INFO_ind --> ProvideSubscriberInfo[Provide Subscriber Info To GLR Call process]; ProvideSubscriberInfo --> WaitForResponse([Wait For Response]); MAP_NOTICE_ind --> MAP_CLOSE_req{MAP_CLOSE_req}; MAP_CLOSE_req --> Idle4([Idle]); WaitForResponse --> ProvideSubscriberInfoAck{Provide Subscriber Info ack}; WaitForResponse --> ProvideSubscriberInfoNegativeResponse{Provide Subscriber Info negative response}; WaitForResponse --> Abort{Abort}; ProvideSubscriberInfoAck --> SetResult[Set result]; ProvideSubscriberInfoNegativeResponse --> SetError[Set error]; Abort --> MAP_U_ABORT_req[MAP_U_ABORT_req]; SetResult --> MAP_PROVIDE_SUBSCRIBER_INFO_rsp[MAP_PROVIDE_SUBSCRIBER_INFO_rsp]; SetError --> MAP_PROVIDE_SUBSCRIBER_INFO_rsp; MAP_PROVIDE_SUBSCRIBER_INFO_rsp --> Idle5([Idle]); +``` + +Flowchart for Process PSI\_Receive\_GLR. It starts at an Idle state, receives an Open Indication, and then branches based on OK, Error, or Vr signals. The main path involves waiting for a service indication, sending a MAP\_PROVIDE\_SUBSCRIBER\_INFO\_ind, waiting for a response, and then handling ack, negative response, or abort signals to either set a result, set an error, or send a MAP\_U\_ABORT\_req before returning to Idle. + +Figure 21.2.3/1 : Process PSI\_Receive\_GLR + +![State transition diagram for Process PSI_Send_GLR. The process starts at an initial state, goes to Idle, then Provide Subscriber Info. It sends MAP_Open_req, MAP_PROVIDE_SUBSCRIBER_INFO_req, and MAP_DELIMITER_req. It then receives an Open cnf. From there, it branches based on the response: OK leads to Wait For Response; Vr leads to Perform MAP Vr (which leads to an error state); Error leads to Provide Subscriber Info negative response (which also leads to an error state). From Wait For Response, it branches into three possible indications: MAP_PROVIDE_SUBSCRIBER_INFO_cnf, MAP_U_ABORT_ind/MAP_P_ABORT_ind, or MAP_NOTICE_ind. The first leads to Check Confirmation, which then branches into Provide Subscriber Info ack (OK) or Provide Subscriber Info negative response (Error), both leading to error states. The second and third lead directly to Abort, which also leads to an error state.](49fe8fe978c0f7e73112d231feb377eb_img.jpg) + +**Process PSI\_Send\_GLR** 21.2.3.2(1) + +Figure 21.2.3/2: Process in the GLR to respond to a request routing information + +Signals to/from the left are to/from the GLR Call; process signals to/from the right are to/from the VLR + +``` + +stateDiagram-v2 + [*] --> Idle + Idle --> ProvideSubscriberInfo: Provide Subscriber Info + ProvideSubscriberInfo --> Out: MAP_Open_req, MAP_PROVIDE_SUBSCRIBER_INFO_req, MAP_DELIMITER_req + Out --> ReceiveOpenCnf: Receive Open cnf + ReceiveOpenCnf --> WaitForResponse: OK + ReceiveOpenCnf --> PerformMAPVr: Vr + ReceiveOpenCnf --> ProvideSubscriberInfoNegativeResponse: Error + PerformMAPVr --> [*]: + ProvideSubscriberInfoNegativeResponse --> [*]: + WaitForResponse --> In: MAP_PROVIDE_SUBSCRIBER_INFO_cnf + WaitForResponse --> Abort1: MAP_U_ABORT_ind, MAP_P_ABORT_ind + WaitForResponse --> In2: MAP_NOTICE_ind + In --> CheckConfirmation: Check Confirmation + CheckConfirmation --> ProvideSubscriberInfoAck: OK + CheckConfirmation --> ProvideSubscriberInfoNegativeResponse2: Error + ProvideSubscriberInfoAck --> [*]: + ProvideSubscriberInfoNegativeResponse2 --> [*]: + Abort1 --> [*]: + In2 --> MAP_CLOSE_req: MAP_CLOSE_req + MAP_CLOSE_req --> Abort2: Abort + Abort2 --> [*]: + +``` + +State transition diagram for Process PSI\_Send\_GLR. The process starts at an initial state, goes to Idle, then Provide Subscriber Info. It sends MAP\_Open\_req, MAP\_PROVIDE\_SUBSCRIBER\_INFO\_req, and MAP\_DELIMITER\_req. It then receives an Open cnf. From there, it branches based on the response: OK leads to Wait For Response; Vr leads to Perform MAP Vr (which leads to an error state); Error leads to Provide Subscriber Info negative response (which also leads to an error state). From Wait For Response, it branches into three possible indications: MAP\_PROVIDE\_SUBSCRIBER\_INFO\_cnf, MAP\_U\_ABORT\_ind/MAP\_P\_ABORT\_ind, or MAP\_NOTICE\_ind. The first leads to Check Confirmation, which then branches into Provide Subscriber Info ack (OK) or Provide Subscriber Info negative response (Error), both leading to error states. The second and third lead directly to Abort, which also leads to an error state. + +Figure 21.2.3/2 : Process PSI\_Send\_GLR + +## 21.3 Setting of Reporting State + +### 21.3.1 General + +In case the HLR received the CCBS request message from the other HLR for CCSB monitoring, the message flow for setting the reporting state is shown in figure 21.3.1/1. The message flow shown in figure 21.3.1/1 shall also be applied in case for stop monitoring. The stage2 specification for the interaction with CCBS in a GLR is in 3GPP TS 23.119. + +![Sequence diagram showing message flow for setting the reporting state between VLR, GLR, and HLR.](5cf80bac69830ea773ac17c87e0ae24d_img.jpg) + +``` +sequenceDiagram + participant VLR + participant GLR + participant HLR + Note right of VLR: MAP_SET_REPORTING_STATE + VLR->>GLR: MAP_SET_REPORTING_STATE + Note left of GLR: MAP_SET_REPORTING_STATE + GLR->>HLR: MAP_SET_REPORTING_STATE + Note right of HLR: MAP_SET_REPORTING_STATE ack + HLR-->>GLR: MAP_SET_REPORTING_STATE ack + Note left of GLR: MAP_SET_REPORTING_STATE ack + GLR-->>VLR: MAP_SET_REPORTING_STATE ack +``` + +The diagram illustrates the message flow for setting the reporting state across three network elements: VLR, GLR, and HLR. The sequence begins with the VLR sending a **MAP\_SET\_REPORTING\_STATE** message to the GLR. Upon receiving this, the GLR sends a **MAP\_SET\_REPORTING\_STATE** message to the HLR. The HLR responds with a **MAP\_SET\_REPORTING\_STATE ack** message back to the GLR. Finally, the GLR sends its own **MAP\_SET\_REPORTING\_STATE ack** message back to the VLR. All messages are represented by dashed arrows indicating the direction of flow. + +Sequence diagram showing message flow for setting the reporting state between VLR, GLR, and HLR. + +**Figure 21.3.1/1: Message Flow for Setting the Reporting State** + +### 21.3.2 Process in the GLR to set the reporting state + +The MAP process in the GLR to set the reporting state is shown in figures 21.3.2/1 and 21.3.2/2. The MAP process invokes a macro not define in this subclause; the definition of this macro can be found as follows: + +| | | +|--------------------|---------------------| +| Receive_Open_Ind | see subclause 25.1. | +| Receive_Open_Cnf | see subclause 25.1. | +| Check_Confirmation | see subclause 25.2. | + +#### Set the reporting state + +When receiving the **MAP\_SET\_REPORTING\_STATE** indication, the MAP user in the GLR transfers the information to the VLR in the **MAP\_SET\_REPORTING\_STATE** request. + +The GLR then awaits the receipt of the **MAP\_SET\_REPORTING\_STATE** confirm from the VLR. The MAP user in the GLR shall transfer the information contained in this primitive to the HLR in the **MAP\_SET\_REPORTING\_STATE** response without checking its contents. + +![State transition diagram for Process Reporting_State_Receive_GLR. The process starts at Idle, receives an Open Indication, and then branches based on the response (OK, Error, or Vr). The OK path leads to waiting for a service indication, then either a MAP_P_ABORT_ind (returning to Idle), a MAP_SET_REPORTING_ind (leading to Set Reporting To GLR Call process and then Wait For Response), or a MAP_NOTICE_ind (leading to MAP_CLOSE_req and Idle). The Wait For Response path leads to Set Reporting ack (Set result, then MAP_SET_REPORTING_rsp, then Idle), Set Reporting negative response (Set error, then Idle), or Abort (MAP_U_ABORT_req, then Idle). The Error path returns to Idle. The Vr path leads to Perform MAP Vr Dialogue and then Idle.](750b1652a4f4791b84c02aa755a1dedd_img.jpg) + +**Process Reporting\_State\_Receive\_GLR** 21.3.2.1(1) + +Figure 21.3.2/1: Process in the GLR to respond to a request reporting state + +Signals to/from the left are to/from the HLR; signals to/from the right are to/from the GLR Call process + +``` +stateDiagram-v2 + [*] --> Idle + Idle --> Receive_Open_Ind : Open Ind + state "Receive Open Ind" as Receive_Open_Ind + Receive_Open_Ind --> Idle : Error + Receive_Open_Ind --> Wait_For_Service_Indication : OK + state "Wait For Service Indication" as Wait_For_Service_Indication + Receive_Open_Ind --> Perform_MAP_Vr_Dialogue : Vr + state "Perform MAP Vr Dialogue" as Perform_MAP_Vr_Dialogue + Perform_MAP_Vr_Dialogue --> Idle + Wait_For_Service_Indication --> MAP_P_ABORT_ind : MAP_P_ABORT_ind + state "MAP_P_ABORT_ind" as MAP_P_ABORT_ind + MAP_P_ABORT_ind --> Idle + Wait_For_Service_Indication --> MAP_SET_REPORTING_ind : MAP_SET_REPORTING_ind + state "MAP_SET_REPORTING_ind" as MAP_SET_REPORTING_ind + MAP_SET_REPORTING_ind --> Set_Reporting_To_GLR_Call_process : Set Reporting To GLR Call process + state "Set Reporting To GLR Call process" as Set_Reporting_To_GLR_Call_process + Set_Reporting_To_GLR_Call_process --> Wait_For_Response + state "Wait For Response" as Wait_For_Response + Wait_For_Response --> Set_Reporting_ack : Set Reporting ack + state "Set Reporting ack" as Set_Reporting_ack + Set_Reporting_ack --> Set_result : Set result + state "Set result" as Set_result + Set_result --> MAP_SET_REPORTING_rsp : MAP_SET_REPORTING_rsp + state "MAP_SET_REPORTING_rsp" as MAP_SET_REPORTING_rsp + MAP_SET_REPORTING_rsp --> Idle + Wait_For_Response --> Set_Reporting_negative_response : Set Reporting negative response + state "Set Reporting negative response" as Set_Reporting_negative_response + Set_Reporting_negative_response --> Set_error : Set error + state "Set error" as Set_error + Set_error --> Idle + Wait_For_Response --> Abort : Abort + state "Abort" as Abort + Abort --> MAP_U_ABORT_req : MAP_U_ABORT_req + state "MAP_U_ABORT_req" as MAP_U_ABORT_req + MAP_U_ABORT_req --> Idle + Wait_For_Service_Indication --> MAP_NOTICE_ind : MAP_NOTICE_ind + state "MAP_NOTICE_ind" as MAP_NOTICE_ind + MAP_NOTICE_ind --> MAP_CLOSE_req : MAP_CLOSE_req + state "MAP_CLOSE_req" as MAP_CLOSE_req + MAP_CLOSE_req --> Idle +``` + +State transition diagram for Process Reporting\_State\_Receive\_GLR. The process starts at Idle, receives an Open Indication, and then branches based on the response (OK, Error, or Vr). The OK path leads to waiting for a service indication, then either a MAP\_P\_ABORT\_ind (returning to Idle), a MAP\_SET\_REPORTING\_ind (leading to Set Reporting To GLR Call process and then Wait For Response), or a MAP\_NOTICE\_ind (leading to MAP\_CLOSE\_req and Idle). The Wait For Response path leads to Set Reporting ack (Set result, then MAP\_SET\_REPORTING\_rsp, then Idle), Set Reporting negative response (Set error, then Idle), or Abort (MAP\_U\_ABORT\_req, then Idle). The Error path returns to Idle. The Vr path leads to Perform MAP Vr Dialogue and then Idle. + +**Figure 21.3.2/1: Process Reporting\_State\_Receive\_GLR** + +![State transition diagram for Process Reporting_State_Send_GLR. The process starts at Idle, transitions to Set Reporting, then receives an Open confirmation. It then branches based on the response: OK leads to Wait For Response, which then branches into three paths: MAP_SET_REPORTING_cnf (leading to Check Confirmation and then Set Reporting ack or negative response), MAP_U_ABORT_ind/MAP_P_ABORT_ind (leading to Abort), and MAP_NOTICE_ind (leading to MAP_CLOSE_req and then Abort). The initial Set Reporting step also sends MAP_Open_req, MAP_SET_REPORTING_req, and MAP_DELIMITER_req. The Wait For Response state also has transitions for Vr (Perform MAP Vr) and Error (Set Reporting negative response), both leading to terminal states.](f61d0925551545b5938b3a4d1bbf63c3_img.jpg) + +**Process Reporting\_State\_Send\_GLR** 21.3.2.2(1) + +Figure 21.3.2/2: Process in the GLR to respond to a request reporting state + +Signals to/from the left are to/from the GLR Call; process signals to/from the right are to/from the VLR + +``` + +stateDiagram-v2 + [*] --> Idle + Idle --> Set_Reporting: Set Reporting + Set_Reporting --> Open_cnf: MAP_Open_req, MAP_SET_REPORTING_req, MAP_DELIMITER_req + Open_cnf --> Wait_For_Response: OK + Open_cnf --> Perform_MAP_Vr: Vr + Open_cnf --> Set_Reporting_negative_response_1: Error + Wait_For_Response --> Set_Reporting_ack: MAP_SET_REPORTING_cnf + Wait_For_Response --> Abort_1: MAP_U_ABORT_ind, MAP_P_ABORT_ind + Wait_For_Response --> Abort_2: MAP_NOTICE_ind + Set_Reporting_ack --> Check_Confirmation: Check Confirmation + Check_Confirmation --> Set_Reporting_ack: OK + Check_Confirmation --> Set_Reporting_negative_response_2: Error + Perform_MAP_Vr --> [*] + Set_Reporting_negative_response_1 --> [*] + Abort_1 --> [*] + Abort_2 --> [*] + Set_Reporting_ack --> [*] + Set_Reporting_negative_response_2 --> [*] + +``` + +State transition diagram for Process Reporting\_State\_Send\_GLR. The process starts at Idle, transitions to Set Reporting, then receives an Open confirmation. It then branches based on the response: OK leads to Wait For Response, which then branches into three paths: MAP\_SET\_REPORTING\_cnf (leading to Check Confirmation and then Set Reporting ack or negative response), MAP\_U\_ABORT\_ind/MAP\_P\_ABORT\_ind (leading to Abort), and MAP\_NOTICE\_ind (leading to MAP\_CLOSE\_req and then Abort). The initial Set Reporting step also sends MAP\_Open\_req, MAP\_SET\_REPORTING\_req, and MAP\_DELIMITER\_req. The Wait For Response state also has transitions for Vr (Perform MAP Vr) and Error (Set Reporting negative response), both leading to terminal states. + +Figure 21.3.2/2: Process Reporting\_State\_Send\_GLR + +## 21.4 Status Reporting + +### 21.4.1 General + +In case that the monitored subscriber becomes to the idle state, the message flow for reporting subscriber's state to the HLR is shown in figure 21.4.1/1. The stage2 specification for the interaction with CCBS in a GLR is in 3GPP TS 23.119. + +![Sequence diagram showing message flow between VLR, GLR, and HLR for status reporting. The VLR sends a MAP_STATUS_REPORT to the GLR, which receives an acknowledgment. The GLR then sends a MAP_STATUS_REPORT to the HLR, which also receives an acknowledgment.](3750b0149a6380885998ab3ca6a8787c_img.jpg) + +``` +sequenceDiagram + participant VLR + participant GLR + participant HLR + Note right of VLR: MAP_STATUS_REPORT + VLR->>GLR: MAP_STATUS_REPORT + Note right of GLR: MAP_STATUS_REPORT ack + GLR-->>VLR: MAP_STATUS_REPORT ack + Note right of GLR: MAP_STATUS_REPORT + GLR->>HLR: MAP_STATUS_REPORT + Note right of HLR: MAP_STATUS_REPORT ack + HLR-->>GLR: MAP_STATUS_REPORT ack +``` + +Sequence diagram showing message flow between VLR, GLR, and HLR for status reporting. The VLR sends a MAP\_STATUS\_REPORT to the GLR, which receives an acknowledgment. The GLR then sends a MAP\_STATUS\_REPORT to the HLR, which also receives an acknowledgment. + +Figure 21.4.1/1: Message Flow for Status Reporting + +### 21.4.2 Process in the GLR for Status Reporting + +The MAP process in the GLR to send the status report to the HLR is shown in figures 21.4.1/1 and 21.4.2/2. + +#### Send Status report + +When receiving the MAP\_STATUS\_REPORT indication, the MAP user in the GLR transfers the information to the HLR in the MAP\_STATUS\_REPORT request. + +The GLR then awaits the receipt of the MAP\_STATUS\_REPORT confirm from the HLR. The MAP user in the GLR shall transfer the information contained in this primitive to the VLR in the MAP\_STATUS\_REPORT response without checking its contents. + +![State transition diagram for Process Status_Report_Receive_GLR. The process starts at Idle, receives an Open Indication, and then branches based on OK, Error, or Vr signals. The OK path leads to Wait For Service Indication, then to MAP_STATUS_REPORT_ind, Status Report To GLR Call process, Wait For Response, and finally to Idle via MAP_STATUS_REPORT_rsp. The Error path leads to Idle via MAP_NOTICE_ind and MAP_CLOSE_req. The Vr path leads to Perform MAP Vr Dialogue and then to Idle. Negative responses lead to Set error and then to Idle via MAP_U_ABORT_req.](38d82ffe820e339811b396206f40a201_img.jpg) + +### Process Status\_Report\_Receive\_GLR + +21.4.2.1(1) + +Figure 21.4.2/1: Process in the GLR to respond to a request status report + +Signals to/from the left are to/from the HLR; signals to/from the right are to/from the GLR Call process + +``` +stateDiagram-v2 + [*] --> Idle + Idle --> Receive_Open_Ind : Open Ind + Receive_Open_Ind --> Wait_For_Service_Indication : OK + Receive_Open_Ind --> Idle : Error + Receive_Open_Ind --> Perform_MAP_Vr_Dialogue : Vr + Wait_For_Service_Indication --> MAP_P_ABORT_ind + Wait_For_Service_Indication --> MAP_STATUS_REPORT_ind + Wait_For_Service_Indication --> MAP_NOTICE_ind + MAP_P_ABORT_ind --> Idle + MAP_STATUS_REPORT_ind --> Status_Report_To_GLR_Call_process : Status Report To GLR Call process + Status_Report_To_GLR_Call_process --> Wait_For_Response + Wait_For_Response --> Status_Report_ack + Wait_For_Response --> Status_Report_negative_response + Wait_For_Response --> Abort + Status_Report_ack --> Set_result + Status_Report_negative_response --> Set_error + Set_result --> MAP_STATUS_REPORT_rsp + Set_error --> MAP_U_ABORT_req + MAP_STATUS_REPORT_rsp --> Idle + MAP_U_ABORT_req --> Idle + MAP_NOTICE_ind --> MAP_CLOSE_req + MAP_CLOSE_req --> Idle +``` + +State transition diagram for Process Status\_Report\_Receive\_GLR. The process starts at Idle, receives an Open Indication, and then branches based on OK, Error, or Vr signals. The OK path leads to Wait For Service Indication, then to MAP\_STATUS\_REPORT\_ind, Status Report To GLR Call process, Wait For Response, and finally to Idle via MAP\_STATUS\_REPORT\_rsp. The Error path leads to Idle via MAP\_NOTICE\_ind and MAP\_CLOSE\_req. The Vr path leads to Perform MAP Vr Dialogue and then to Idle. Negative responses lead to Set error and then to Idle via MAP\_U\_ABORT\_req. + +Figure 21.4.2/1: Process Status\_Report\_Receive\_GLR + +![State transition diagram for Process Status_Report_Send_GLR. The process starts at 'Idle', receives a 'Status Report', sends 'MAP_Open_req', 'MAP_STATUS_REPORT_req', and 'MAP_DELIMITER_req', receives 'Open cnf', and then enters 'Wait For Response'. From 'Wait For Response', it can receive 'MAP_STATUS_REPORT_cnf' (leading to 'Check Confirmation' and then 'Status Report ack' or 'Status Report negative response'), 'MAP_U_ABORT_ind'/'MAP_P_ABORT_ind' (leading to 'Abort'), or 'MAP_NOTICE_ind' (leading to 'MAP_CLOSE_req' and then 'Abort'). Transitions to 'Abort' and 'Status Report negative response' from 'Wait For Response' are also labeled 'Vr' and 'Error'.](11f18bf0233d812ad2604f88f3385d60_img.jpg) + +### Process Status\_Report\_Send\_GLR 21.4.2.2(1) + +Figure 21.4.2/2: Process in the GLR to respond to a request status report + +Signals to/from the left are to/from the GLR Call; process signals to/from the right are to/from the HLR + +``` +stateDiagram-v2 + [*] --> Idle + Idle --> Status_Report + Status_Report --> Open_Req + Open_Req --> Open_Cnf + Open_Cnf --> Wait_For_Response + state "Wait For Response" as Wait_For_Response + state "Status Report" as Status_Report + state "Open cnf" as Open_Cnf + state "Check Confirmation" as Check_Confirmation + state "Status Report ack" as Status_Report_ack + state "Status Report negative response" as Status_Report_negative_response + state "Abort" as Abort + state "MAP_NOTICE_ind" as MAP_NOTICE_ind + state "MAP_CLOSE_req" as MAP_CLOSE_req + + Note right of Open_Req: MAP_Open_req +MAP_STATUS_REPORT_req +MAP_DELIMITER_req + Note left of Open_Cnf: Open cnf + Note right of MAP_NOTICE_ind: MAP_CLOSE_req + Note right of Check_Confirmation: OK / Error + + Wait_For_Response --> Status_Report_ack + Wait_For_Response --> Abort + Wait_For_Response --> MAP_NOTICE_ind + Status_Report --> Abort : Vr + Status_Report --> Status_Report_negative_response : Error + + Status_Report_ack --> [*] + Status_Report_negative_response --> [*] + Abort --> [*] + MAP_CLOSE_req --> Abort + Abort --> [*] +``` + +State transition diagram for Process Status\_Report\_Send\_GLR. The process starts at 'Idle', receives a 'Status Report', sends 'MAP\_Open\_req', 'MAP\_STATUS\_REPORT\_req', and 'MAP\_DELIMITER\_req', receives 'Open cnf', and then enters 'Wait For Response'. From 'Wait For Response', it can receive 'MAP\_STATUS\_REPORT\_cnf' (leading to 'Check Confirmation' and then 'Status Report ack' or 'Status Report negative response'), 'MAP\_U\_ABORT\_ind'/'MAP\_P\_ABORT\_ind' (leading to 'Abort'), or 'MAP\_NOTICE\_ind' (leading to 'MAP\_CLOSE\_req' and then 'Abort'). Transitions to 'Abort' and 'Status Report negative response' from 'Wait For Response' are also labeled 'Vr' and 'Error'. + +Figure 21.4.2/2: Process Status\_Report\_Send\_GLR + +## 21.5 Remote User Free + +### 21.5.1 General + +The message flow for handling remote user free is shown in figure 21.5.1/1. + +![Sequence diagram showing message flow between VLR, GLR, and HLR for Remote User Free. The diagram shows three vertical lifelines: VLR, GLR, and HLR. The sequence of messages is: 1. GLR sends MAP_REMOTE_USER_FREE to VLR (dashed arrow). 2. VLR sends MAP_REMOTE_USER_FREE ack to GLR (dashed arrow). 3. HLR sends MAP_REMOTE_USER_FREE to GLR (dashed arrow). 4. GLR sends a return message to HLR (dashed arrow with '->').](1e5a58dcaf0936bf18dc3dd0d9cd43ff_img.jpg) + +``` +sequenceDiagram + participant VLR + participant GLR + participant HLR + Note right of GLR: MAP_REMOTE_USER_FREE + GLR-->>VLR: MAP_REMOTE_USER_FREE + Note left of VLR: MAP_REMOTE_USER_FREE ack + VLR-->>GLR: MAP_REMOTE_USER_FREE ack + Note right of HLR: MAP_REMOTE_USER_FREE + HLR-->>GLR: MAP_REMOTE_USER_FREE + Note right of GLR: -- + Note right of GLR: MAP_REMOTE_USER_FREE ack + GLR-->>HLR: MAP_REMOTE_USER_FREE ack + Note right of GLR: -> +``` + +Sequence diagram showing message flow between VLR, GLR, and HLR for Remote User Free. The diagram shows three vertical lifelines: VLR, GLR, and HLR. The sequence of messages is: 1. GLR sends MAP\_REMOTE\_USER\_FREE to VLR (dashed arrow). 2. VLR sends MAP\_REMOTE\_USER\_FREE ack to GLR (dashed arrow). 3. HLR sends MAP\_REMOTE\_USER\_FREE to GLR (dashed arrow). 4. GLR sends a return message to HLR (dashed arrow with '->'). + +Figure 21.5.1/1: Message Flow for Remote User Free + +### 21.5.2 Process in the GLR for Remote User Free + +The MAP process in the GLR to handling Remote User Free is shown in figures 21.5.2/1 and 21.5.2/2. + +#### Remote User Free + +When receiving the MAP\_REMOTE\_USER\_FREE indication, the MAP user in the GLR transfers the information to the VLR in the MAP\_REMOTE\_USER\_FREE request. + +The GLR then awaits the receipt of the MAP\_REMOTE\_USER\_FREE confirm from the VLR. The MAP user in the GLR shall transfer the information contained in this primitive to the HLR in the MAP\_REMOTE\_USER\_FREE response without checking its contents. + +![State transition diagram for Process Remote_User_Free_Receive_GLR. It starts at Idle, receives an Open Indication, and then branches based on OK, Vr, or Error signals. The OK path leads to waiting for a service indication, then sending a MAP_REMOTE_USER_FREE_ind to the GLR Call process, waiting for a response, and finally sending a MAP_REMOTE_USER_FREE_rsp. The Vr path leads to performing a MAP Vr Dialogue. The Error path leads to Idle. Other branches include MAP_P_ABORT_ind, MAP_NOTICE_ind, and MAP_CLOSE_req, all leading to Idle states.](d2417b04116c354deccb25d98a84a0fb_img.jpg) + +### Process Remote\_User\_Free\_Receive\_GLR + +21.5.2.1(1) + +Figure 21.5.2/1: Process in the GLR to respond to a request remote user free + +Signals to/from the left are to/from the HLR; signals to/from the right are to/from the GLR Call process + +``` +stateDiagram-v2 + [*] --> Idle + Idle --> Receive_Open_Ind + Receive_Open_Ind --> OK + OK --> Wait_For_Service_Indication + Wait_For_Service_Indication --> MAP_REMOTE_USER_FREE_ind + MAP_REMOTE_USER_FREE_ind --> Remote_User_Free_To_GLR_Call_process + Remote_User_Free_To_GLR_Call_process --> Wait_For_Response + Wait_For_Response --> Remote_User_Free_ack + Wait_For_Response --> Remote_User_Free_negative_response + Wait_For_Response --> Abort + Remote_User_Free_ack --> Set_result + Remote_User_Free_negative_response --> Set_error + Set_result --> MAP_REMOTE_USER_FREE_rsp + Set_error --> MAP_REMOTE_USER_FREE_rsp + MAP_REMOTE_USER_FREE_rsp --> Idle + Abort --> MAP_U_ABORT_req + MAP_U_ABORT_req --> Idle + Receive_Open_Ind --> Vr + Vr --> Perform_MAP_Vr_Dialogue + Perform_MAP_Vr_Dialogue --> Idle + Receive_Open_Ind --> Error + Error --> Idle + Wait_For_Service_Indication --> MAP_P_ABORT_ind + MAP_P_ABORT_ind --> Idle + Wait_For_Service_Indication --> MAP_NOTICE_ind + MAP_NOTICE_ind --> MAP_CLOSE_req + MAP_CLOSE_req --> Idle +``` + +State transition diagram for Process Remote\_User\_Free\_Receive\_GLR. It starts at Idle, receives an Open Indication, and then branches based on OK, Vr, or Error signals. The OK path leads to waiting for a service indication, then sending a MAP\_REMOTE\_USER\_FREE\_ind to the GLR Call process, waiting for a response, and finally sending a MAP\_REMOTE\_USER\_FREE\_rsp. The Vr path leads to performing a MAP Vr Dialogue. The Error path leads to Idle. Other branches include MAP\_P\_ABORT\_ind, MAP\_NOTICE\_ind, and MAP\_CLOSE\_req, all leading to Idle states. + +Figure 21.5.2/1: Process Remote\_User\_Free\_Receive\_GLR + +![State transition diagram for Process Remote_User_Free_Send_GLR. The process starts at 'Idle', receives 'Remote User Free', sends 'MAP_Open_req', 'MAP_REMOTE_USER_FREE_req', and 'MAP_DELIMITER_req', then receives 'Open cnf'. From 'Receive Open cnf', an 'OK' path leads to 'Wait For Response', while 'Vr' and 'Error' paths lead to 'Perform MAP Vr' and 'Remote User Free negative response' respectively, both of which are terminated. From 'Wait For Response', three paths emerge: 'MAP_REMOTE_USER_FREE_cnf' leads to 'Check Confirmation', 'MAP_U_ABORT_ind' / 'MAP_P_ABORT_ind' leads to 'Abort', and 'MAP_NOTICE_ind' leads to 'MAP_CLOSE_req' and then 'Abort'. From 'Check Confirmation', 'OK' leads to 'Remote User Free ack' and 'Error' leads to 'Remote User Free negative response', both terminated. All terminal states are marked with an 'X'.](18003425d0e8638dde4acc9c5c468c5c_img.jpg) + +### Process Remote\_User\_Free\_Send\_GLR 21.5.2.2(1) + +Figure 21.5.2/2: Process in the GLR to respond to a request remote user free + +Signals to/from the left are to/from the GLR Call; process signals to/from the right are to/from the VLR + +``` +stateDiagram-v2 + [*] --> Idle + Idle --> Remote_User_Free + Remote_User_Free --> Send_Requests + state "Send_Requests" as Send_Requests + Send_Requests --> Receive_Open_cnf + Receive_Open_cnf --> Wait_For_Response : OK + Receive_Open_cnf --> Perform_MAP_Vr : Vr + Receive_Open_cnf --> Remote_User_Free_negative_response_1 : Error + Perform_MAP_Vr --> [*] + Remote_User_Free_negative_response_1 --> [*] + Wait_For_Response --> Check_Confirmation : MAP_REMOTE_USER_FREE_cnf + Wait_For_Response --> Abort_1 : MAP_U_ABORT_ind / MAP_P_ABORT_ind + Wait_For_Response --> MAP_NOTICE_ind + Check_Confirmation --> Remote_User_Free_ack : OK + Check_Confirmation --> Remote_User_Free_negative_response_2 : Error + Remote_User_Free_ack --> [*] + Remote_User_Free_negative_response_2 --> [*] + MAP_NOTICE_ind --> MAP_CLOSE_req + MAP_CLOSE_req --> Abort_2 + Abort_1 --> [*] + Abort_2 --> [*] +``` + +State transition diagram for Process Remote\_User\_Free\_Send\_GLR. The process starts at 'Idle', receives 'Remote User Free', sends 'MAP\_Open\_req', 'MAP\_REMOTE\_USER\_FREE\_req', and 'MAP\_DELIMITER\_req', then receives 'Open cnf'. From 'Receive Open cnf', an 'OK' path leads to 'Wait For Response', while 'Vr' and 'Error' paths lead to 'Perform MAP Vr' and 'Remote User Free negative response' respectively, both of which are terminated. From 'Wait For Response', three paths emerge: 'MAP\_REMOTE\_USER\_FREE\_cnf' leads to 'Check Confirmation', 'MAP\_U\_ABORT\_ind' / 'MAP\_P\_ABORT\_ind' leads to 'Abort', and 'MAP\_NOTICE\_ind' leads to 'MAP\_CLOSE\_req' and then 'Abort'. From 'Check Confirmation', 'OK' leads to 'Remote User Free ack' and 'Error' leads to 'Remote User Free negative response', both terminated. All terminal states are marked with an 'X'. + +Figure 21.5.2/2: Process Remote\_User\_Free\_Send\_GLR + +# 22 Supplementary services procedures + +## 22.1 Functional supplementary service processes + +### 22.1.1 Functional supplementary service process co-ordinator for GLR + +Any functional SS process in the GLR starts by the GLR receiving a MAP-OPEN service indication. If that service is successful, the GLR can handle supplementary service indications from the VLR. Table 21.1/1 shows the co-ordinating process' reaction on receipt of specific SS service indications from the VLR. After the relevant process is invoked, the received service indication is sent to that process, and the co-ordinating process terminates. + +**Table 21.1/1: Relationship between received service indication and invoked process in the GLR** + +| Service indication received | Process invoked | +|------------------------------------|------------------------| +| MAP_REGISTER_SS_ind | REGISTER_SS_GLR | +| MAP_ERASE_SS_ind | ERASE_SS_GLR | +| MAP_ACTIVATE_SS_ind | ACTIVATE_SS_GLR | +| MAP_DEACTIVATE_SS_ind | DEACTIVATE_SS_GLR | +| MAP_INTERROGATE_SS_ind | INTERROGATE_SS_GLR | +| MAP_REGISTER_PASSWORD | REGISTER_PASSWORD_GLR | + +Figure 22.1/1 shows the co-ordinating process in the GLR. + +#### Process SS\_Coordinator\_GLR + +22.1.1\_1(2) + +Figure 22.1/1: Supplementary Service Coordination process in the GLR, to identify which functional supplementary service process be invoked. + +![Flowchart for Process SS_Coordinator_GLR. It starts with an oval, followed by a NULL terminal, then a 'Receive_Open_ind' block. An 'Error' path leads to 'Perform_MAP_V1_Dialogue' and another NULL terminal. The main path goes to 'Wait_for_service_ind', which then branches into six parallel MAP service paths: REGISTER, ERASE, ACTIVATE, DEACTIVATE, INTERROGATE, and REGISTER PASSWORD. Each path has a corresponding GLR process block and a return signal block. All six return signals converge to a 'Relay_Info' block. From 'Relay_Info', the flow goes to 'MAP_NOTICE_ind', then 'MAP_CLOSE_ind', and finally a NULL terminal. A note on the right explains signal directions: 'Signals to/from the left are to/from the VLR via the MAP provider; signals to/from the right are to/from the child process'.](7f16ae750ce9a533b0bd301dd986355e_img.jpg) + +``` +graph TD; Start([ ]) --> NULL1(NULL); NULL1 --> Receive_Open_ind[Receive_Open_ind]; Receive_Open_ind --> Wait_for_service_ind((Wait_for_service_ind)); Receive_Open_ind -- Error --> Perform_MAP_V1_Dialogue[Perform_MAP_V1_Dialogue]; Perform_MAP_V1_Dialogue --> NULL2(NULL); Wait_for_service_ind --> MAP_REGISTER_ind{MAP_REGISTER_
SS_ind}; Wait_for_service_ind --> MAP_ERASE_ind{MAP_ERASE_
SS_ind}; Wait_for_service_ind --> MAP_ACTIVATE_ind{MAP_ACTIVATE_
SS_ind}; Wait_for_service_ind --> MAP_DEACTIVATE_ind{MAP_DEACTIVATE_
SS_ind}; Wait_for_service_ind --> MAP_INTERROGATE_ind{MAP_INTERROGATE_
SS_ind}; Wait_for_service_ind --> MAP_REGISTER_PASSWORD_ind{MAP_REGISTER_
PASSWORD_
SS_ind}; MAP_REGISTER_ind --> Register_SS_GLR[Register_
SS_GLR]; Register_SS_GLR --> MAP_REGISTER_ind_return{MAP_REGISTER_
SS_ind}; MAP_ERASE_ind --> Erase_SS_GLR[Erase_
SS_GLR]; Erase_SS_GLR --> MAP_ERASE_ind_return{MAP_ERASE_
SS_ind}; MAP_ACTIVATE_ind --> Activate_SS_GLR[Activate_
SS_GLR]; Activate_SS_GLR --> MAP_ACTIVATE_ind_return{MAP_ACTIVATE_
SS_ind}; MAP_DEACTIVATE_ind --> Deactivate_SS_GLR[Deactivate_
SS_GLR]; Deactivate_SS_GLR --> MAP_DEACTIVATE_ind_return{MAP_DEACTIVATE_
SS_ind}; MAP_INTERROGATE_ind --> Interrogate_SS_GLR[Interrogate_
SS_GLR]; Interrogate_SS_GLR --> MAP_INTERROGATE_ind_return{MAP_INTERROGATE_
SS_ind}; MAP_REGISTER_PASSWORD_ind --> Register_Password_SS_GLR[Register_
Password_
SS_GLR]; Register_Password_SS_GLR --> MAP_REGISTER_PASSWORD_ind_return{MAP_REGISTER_
PASSWORD_
SS_ind}; MAP_REGISTER_ind_return --> Relay_Info((Relay_Info)); MAP_ERASE_ind_return --> Relay_Info; MAP_ACTIVATE_ind_return --> Relay_Info; MAP_DEACTIVATE_ind_return --> Relay_Info; MAP_INTERROGATE_ind_return --> Relay_Info; MAP_REGISTER_PASSWORD_ind_return --> Relay_Info; Relay_Info --> MAP_NOTICE_ind{MAP_NOTICE_
ind}; MAP_NOTICE_ind --> MAP_CLOSE_ind{MAP_CLOSE_
ind}; MAP_CLOSE_ind --> NULL3(NULL); +``` + +Signals to/from the left are to/from the VLR via the MAP provider; signals to/from the right are to/from the child process + +Flowchart for Process SS\_Coordinator\_GLR. It starts with an oval, followed by a NULL terminal, then a 'Receive\_Open\_ind' block. An 'Error' path leads to 'Perform\_MAP\_V1\_Dialogue' and another NULL terminal. The main path goes to 'Wait\_for\_service\_ind', which then branches into six parallel MAP service paths: REGISTER, ERASE, ACTIVATE, DEACTIVATE, INTERROGATE, and REGISTER PASSWORD. Each path has a corresponding GLR process block and a return signal block. All six return signals converge to a 'Relay\_Info' block. From 'Relay\_Info', the flow goes to 'MAP\_NOTICE\_ind', then 'MAP\_CLOSE\_ind', and finally a NULL terminal. A note on the right explains signal directions: 'Signals to/from the left are to/from the VLR via the MAP provider; signals to/from the right are to/from the child process'. + +Figure 22.1/1 (sheet 1 of 2): Process SS\_Coordinator\_GLR + +![State transition diagram for Process SS_Coordinator_GLR. The diagram shows four main paths originating from a central 'Relay_Info' state. Path 1: *FROM PROVIDER -> *TO OFFSPRING -> Relay_Info. Path 2: *FROM PROVIDER -> *TO OFFSPRING -> NULL. Path 3: *FROM OFFSPRING -> *TO PROVIDER -> Relay_Info. Path 4: *FROM OFFSPRING -> *TO PROVIDER -> NULL. Transitions from PROVIDER and OFFSPRING include specific MAP indications: MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind for the left side, and MAP_U_ABORT_ind, MAP_CLOSE_ind for the right side.](a963ca41bde1669b18a4b783616f228b_img.jpg) + +**Process SS\_Coordinator\_GLR** 22.1.1\_2(2) + +Figure 22.1/1: Supplementary Service Coordination process in the GLR, to identify which functional supplementary service process be invoked. + +Signals to/from the left are to/from the VLR via the MAP provider; signals to/from the right are to/from the child process + +``` + +stateDiagram-v2 + [*] --> Relay_Info + state "Relay_Info" as Relay_Info + state "*FROM PROVIDER" as FROM_PROVIDER + state "*FROM OFFSPRING" as FROM_OFFSPRING + state "*TO OFFSPRING" as TO_OFFSPRING + state "*TO PROVIDER" as TO_PROVIDER + state "NULL" as NULL + + FROM_PROVIDER --> TO_OFFSPRING + FROM_OFFSPRING --> TO_PROVIDER + + TO_OFFSPRING --> Relay_Info + TO_OFFSPRING --> NULL + + TO_PROVIDER --> Relay_Info + TO_PROVIDER --> NULL + + FROM_PROVIDER --> MAP_U_ABORT_ind + FROM_PROVIDER --> MAP_P_ABORT_ind + FROM_PROVIDER --> MAP_CLOSE_ind + + FROM_OFFSPRING --> MAP_U_ABORT_ind + FROM_OFFSPRING --> MAP_CLOSE_ind + +``` + +State transition diagram for Process SS\_Coordinator\_GLR. The diagram shows four main paths originating from a central 'Relay\_Info' state. Path 1: \*FROM PROVIDER -> \*TO OFFSPRING -> Relay\_Info. Path 2: \*FROM PROVIDER -> \*TO OFFSPRING -> NULL. Path 3: \*FROM OFFSPRING -> \*TO PROVIDER -> Relay\_Info. Path 4: \*FROM OFFSPRING -> \*TO PROVIDER -> NULL. Transitions from PROVIDER and OFFSPRING include specific MAP indications: MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_CLOSE\_ind for the left side, and MAP\_U\_ABORT\_ind, MAP\_CLOSE\_ind for the right side. + +**Figure 22.1/1 (sheet 2 of 2): Process SS\_Coordinator\_GLR** + +### 22.1.2 Call completion supplementary service process co-ordinator for GLR + +The MAP co-ordinating process in the GLR to handle a dialogue opened with the call Completion application context is shown in figure 22.1/2. The MAP process invokes a macro not defined in this subclause; the definition of this macro can be found as follows: + +Receive\_Open\_Ind            see subclause 25.1. + +Any call completion SS process in the GLR starts by the GLR receiving a MAP-OPEN service indication. If that service is successful, the GLR can handle call completion supplementary service indications from the VLR. Table 22.1/2 shows the co-ordinating process' reaction on receipt of specific call completion SS service indications from the VLR. After the relevant process is invoked, the received service indication is sent to that process. + +**Table 22.1/2: Relationship between received service indication and invoked process in the GLR** + +| Service indication received | Process invoked | +|------------------------------------|------------------------| +| MAP_REGISTER_CC_ENTRY_ind | REGISTER_CC_ENTRY_GLR | +| MAP_ERASE_CC_ENTRY_ind | ERASE_CC_ENTRY_GLR | + +After creation of the user process the Co-ordinator relays the messages between the MAP\_PM and the invoked process until a request or an indication for dialogue termination is received. + +The Call\_Completion Co-ordinator is shown in figure 22.1/2. + +![Flowchart for Process CC_Coord_GLR. The process starts at an oval, goes to an 'Idle' state (oval). It receives an 'Open_ind' (rectangle) from the left, labeled 'Section 25.1'. From 'Open_ind', an 'OK' path leads to 'Wait_for_service_ind' (oval) and a 'Vr, Error' path leads to another 'Idle' state (oval). From 'Wait_for_service_ind', three paths lead to 'MAP_REGISTER_CC_ENTRY_ind' (parallelogram), 'MAP_ERASE_CC_ENTRY_ind' (parallelogram), and 'MAP_NOTICE_ind' (parallelogram). 'MAP_REGISTER_CC_ENTRY_ind' leads to 'Register_CC_RNTRY_GLR' (rectangle), which leads to 'MAP_REGISTER_CC_ENTRY_ind' (parallelogram). 'MAP_ERASE_CC_ENTRY_ind' leads to 'Erase_CC_ENTRY_GLR' (rectangle), which leads to 'MAP_ERASE_CC_ENTRY_ind' (parallelogram). 'MAP_NOTICE_ind' leads to 'MAP_CLOSE_ind' (diamond), which leads to an 'Idle' state (oval). Both 'MAP_REGISTER_CC_ENTRY_ind' and 'MAP_ERASE_CC_ENTRY_ind' lead to 'Relay_Info' (oval). From 'Relay_Info', the flow splits into two main branches. The left branch has a 'FROM PROVIDER' parallelogram leading to a 'TO OFFSPRING' parallelogram, which leads to 'Relay_Info' (oval). The right branch has a 'FROM OFFSPRING' parallelogram leading to a 'TO PROVIDER' parallelogram, which leads to 'Relay_Info' (oval). There are also 'NULL' states (oval) and 'MAP_U_ABORT_ind', 'MAP_P_ABORT_ind', 'MAP_CLOSE_ind' (rectangle) associated with these branches.](e16bfa31d748f4d99ec4ae3d16656926_img.jpg) + +**Process CC\_Coord\_GLR** 22.1.2(1) + +Figure 22.1/2: Coordinating process in the GLR to handle dialogue opened with the AC Call Completion Context + +Signals to/from the left are to/from the VLR via the MAP provider; signals to/from the right are to/from the child process + +``` + +graph TD + Start([ ]) --> Idle1([Idle]) + Idle1 -- "Receive_Open_ind" --> Wait[Wait_for_service_ind] + Wait -- OK --> Wait + Wait -- "Vr, Error" --> Idle2([Idle]) + Wait --> MR[MAP_REGISTER_CC_ENTRY_ind] + Wait --> ME[MAP_ERASE_CC_ENTRY_ind] + Wait --> MN[MAP_NOTICE_ind] + MR --> RCN[Register_CC_RNTRY_GLR] + RCN --> MR + ME --> ECN[Erase_CC_ENTRY_GLR] + ECN --> ME + MN --> MC[MAP_CLOSE_ind] + MC --> Idle3([Idle]) + MR --> RI1([Relay_Info]) + ME --> RI1 + RI1 --> FP[FROM PROVIDER] + RI1 --> FO[FROM OFFSPRING] + FP --> TOOFF1[TO OFFSPRING] + TOOFF1 --> RI2([Relay_Info]) + FO --> TOP1[TO PROVIDER] + TOP1 --> RI3([Relay_Info]) + FP --> NULL1([NULL]) + FO --> NULL2([NULL]) + FP --- MAPU[MAP_U_ABORT_ind +MAP_P_ABORT_ind +MAP_CLOSE_ind] + FO --- MAPU2[MAP_U_ABORT_ind +MAP_CLOSE_ind] + +``` + +Flowchart for Process CC\_Coord\_GLR. The process starts at an oval, goes to an 'Idle' state (oval). It receives an 'Open\_ind' (rectangle) from the left, labeled 'Section 25.1'. From 'Open\_ind', an 'OK' path leads to 'Wait\_for\_service\_ind' (oval) and a 'Vr, Error' path leads to another 'Idle' state (oval). From 'Wait\_for\_service\_ind', three paths lead to 'MAP\_REGISTER\_CC\_ENTRY\_ind' (parallelogram), 'MAP\_ERASE\_CC\_ENTRY\_ind' (parallelogram), and 'MAP\_NOTICE\_ind' (parallelogram). 'MAP\_REGISTER\_CC\_ENTRY\_ind' leads to 'Register\_CC\_RNTRY\_GLR' (rectangle), which leads to 'MAP\_REGISTER\_CC\_ENTRY\_ind' (parallelogram). 'MAP\_ERASE\_CC\_ENTRY\_ind' leads to 'Erase\_CC\_ENTRY\_GLR' (rectangle), which leads to 'MAP\_ERASE\_CC\_ENTRY\_ind' (parallelogram). 'MAP\_NOTICE\_ind' leads to 'MAP\_CLOSE\_ind' (diamond), which leads to an 'Idle' state (oval). Both 'MAP\_REGISTER\_CC\_ENTRY\_ind' and 'MAP\_ERASE\_CC\_ENTRY\_ind' lead to 'Relay\_Info' (oval). From 'Relay\_Info', the flow splits into two main branches. The left branch has a 'FROM PROVIDER' parallelogram leading to a 'TO OFFSPRING' parallelogram, which leads to 'Relay\_Info' (oval). The right branch has a 'FROM OFFSPRING' parallelogram leading to a 'TO PROVIDER' parallelogram, which leads to 'Relay\_Info' (oval). There are also 'NULL' states (oval) and 'MAP\_U\_ABORT\_ind', 'MAP\_P\_ABORT\_ind', 'MAP\_CLOSE\_ind' (rectangle) associated with these branches. + +Figure 22.1/2: Process\_CC\_Coord\_GLR + +## 22.2 Registration procedure + +### 22.2.1 General + +The registration procedure is used to register data related to a supplementary service in the HLR. The registration procedure is a fully transparent communication between the MS and the HLR. + +### 22.2.2 Procedures in the GLR + +#### Supplementary service registration + +When receiving the MAP\_REGISTER\_SS indication from VLR, the MAP user in the GLR transfers the information to the HLR in the MAP\_REGISTER\_SS request without checking the contents of the service indication. + +The GLR then awaits the receipt of the MAP\_REGISTER\_SS confirm from the HLR. The MAP user in the GLR shall transfer the information contained in this primitive to the VLR in the MAP\_REGISTER\_SS response without checking its contents. + +#### Error handling + +If at any time during this procedure a MAP\_P\_ABORT, MAP\_U\_ABORT, MAP\_NOTICE or unexpected MAP\_CLOSE indication is received from the VLR concerning the process, a MAP\_U\_ABORT request indicating application procedure cancellation is sent to the HLR (if a connection exists). If a MAP\_NOTICE indication was received from the VLR, that dialogue must be closed by sending a MAP\_CLOSE request towards the VLR. The process is terminated. + +If a MAP\_P\_ABORT, MAP\_U\_ABORT or MAP\_CLOSE indication is received from the HLR, a MAP\_U\_ABORT request shall be sent to the VLR terminating the process. If a MAP\_NOTICE indication was received from the HLR, that dialogue must be closed by sending a MAP\_CLOSE request towards the HLR. The process terminates. + +The registration procedure in the GLR is shown in figure 22.2/1. + +![Sequence diagram for Process SS_REGISTER_GLR showing the interaction between a mobile station and the network (VLR/HLR). The process starts with NULL, followed by MAP_REGISTER_SS_ind, MAP_OPEN_req (with Destination reference = subscriber's IMSI and Originating reference = GLR number), MAP_REGISTER_req, MAP_DELIMITER_req, and Receive_Open_Confirm (Section 25.1). From Receive_Open_Confirm, an 'OK' path leads to Wait_for_ss_cnf and a 'Vr, Error' path leads to MAP_U_ABORT_req. There is also a MAP_NOTICE_ind and MAP_CLOSE_req sequence with a cross-out. A box on the right lists MAP_U_ABORT_ind, MAP_P_ABORT_ind, and MAP_CLOSE_ind. A connector '1' is shown.](fc3e2b49a9f850951570e502393b697f_img.jpg) + +### Process SS\_REGISTER\_GLR + +22.2.1\_1(2) + +Figure 22.2/1: Mobile Initiated registration of supplementary service in the GLR + +Signals to/from the left are to/from the VLR +signals to/from the right are to/from the HLR +unless otherwise stated + +``` +sequenceDiagram + participant MS as Mobile Station + participant VLR as VLR + participant HLR as HLR + + Note left of MS: NULL + MS->>VLR: MAP_REGISTER_SS_ind + VLR->>HLR: MAP_OPEN_req + Note right of MAP_OPEN_req: Including +- Destination reference = subscriber's IMSI +- Originating reference = GLR number + VLR->>MS: MAP_REGISTER_req + VLR->>MS: MAP_DELIMITER_req + MS->>VLR: Receive_Open_Confirm + Note right of Receive_Open_Confirm: Section 25.1 + MS->>VLR: OK + VLR->>MS: Wait_for_ss_cnf + MS->>VLR: Vr, Error + VLR->>MS: MAP_U_ABORT_req + Note right of VLR: MAP_NOTICE_ind + VLR->>HLR: MAP_CLOSE_req + Note right of MAP_CLOSE_req: [Crossed out] + Note right of HLR: MAP_U_ABORT_ind +MAP_P_ABORT_ind +MAP_CLOSE_ind + Note right of MS: 1 +``` + +Sequence diagram for Process SS\_REGISTER\_GLR showing the interaction between a mobile station and the network (VLR/HLR). The process starts with NULL, followed by MAP\_REGISTER\_SS\_ind, MAP\_OPEN\_req (with Destination reference = subscriber's IMSI and Originating reference = GLR number), MAP\_REGISTER\_req, MAP\_DELIMITER\_req, and Receive\_Open\_Confirm (Section 25.1). From Receive\_Open\_Confirm, an 'OK' path leads to Wait\_for\_ss\_cnf and a 'Vr, Error' path leads to MAP\_U\_ABORT\_req. There is also a MAP\_NOTICE\_ind and MAP\_CLOSE\_req sequence with a cross-out. A box on the right lists MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, and MAP\_CLOSE\_ind. A connector '1' is shown. + +Figure 22.2/1 (sheet 1 of 2): Procedure SS\_Register\_GLR + +![SDL diagram for Process SS_REGISTER_GLR showing state transitions and signal exchanges between VLR, GLR, and HLR.](6a993bfdf2e00cfad01c4d2188a75d86_img.jpg) + +Process SS\_REGISTER\_GLR 22.2.1\_2(2) + +Figure 22.2/1: Mobile Initiated registration of supplementary service in the GLR + +Signals to/from the left are to/from the VLR +signals to/from the right are to/from the HLR +unless otherwise stated + +``` + +graph TD + Start([Wait_for_ss_cnf]) --> Input1[/MAP_REGISTER_ss_cnf/] + Input1 --> Decision1{MAP_P_ERROR} + Decision1 --|yes| Conn1((1)) + Decision1 --|no| Output1[/MAP_REGISTER_ss_rsp/] + Output1 --> Output2[/MAP_CLOSE_req/] + Output2 --> End1(X) + + Input1 --> Input2[\MAP_U_ABORT_ind +MAP_P_ABORT_ind/] + Input2 --> Output3[/MAP_CLOSE_req/] + Output3 --> Output4[/MAP_U_ABORT_req/] + Output4 --> End2(X) + + Input1 --> Input3[\MAP_NOTICE_ind/] + Input3 --> Output5[/MAP_CLOSE_req/] + Output5 --> Output6[/MAP_U_ABORT_req/] + Output6 --> End3(X) + + Input1 --> Input4[\MAP_NOTICE_ind/] + Input4 --> Output7[/MAP_CLOSE_req/] + Output7 --> Output8[/MAP_U_ABORT_req/] + Output8 --> End4(X) + + Input1 --> Input5[\MAP_U_ABORT_ind +MAP_P_ABORT_ind +MAP_CLOSE_ind/] + Input5 --> End5(X) + +``` + +The SDL diagram depicts the 'Wait\_for\_ss\_cnf' state. Upon receiving 'MAP\_REGISTER\_ss\_cnf', several paths are possible. One path checks for 'MAP\_P\_ERROR'; if yes, it goes to connector 1; if no, it sends 'MAP\_REGISTER\_ss\_rsp' and 'MAP\_CLOSE\_req' to the VLR. Other paths handle abort and notice indications from the HLR ('MAP\_U\_ABORT\_ind', 'MAP\_P\_ABORT\_ind', 'MAP\_NOTICE\_ind', 'MAP\_CLOSE\_ind'), resulting in 'MAP\_CLOSE\_req' and 'MAP\_U\_ABORT\_req' being sent to the VLR or HLR as appropriate, followed by process termination (X). + +SDL diagram for Process SS\_REGISTER\_GLR showing state transitions and signal exchanges between VLR, GLR, and HLR. + +**Figure 22.2/1 (sheet 2 of 2): Procedure SS\_Register\_GLR** + +## 22.3 Erasure procedure + +### 22.3.1 General + +The erasure procedure is used to erase data related to a supplementary service in the HLR. The erasure procedure is a fully transparent communication between the MS and the HLR. + +### 22.3.2 Procedures in the GLR + +The GLR procedures for erasure are identical to those specified for registration in subclause 22.2. The text and diagrams in subclause 22.2 apply with all references to registration changed to erasure. + +## 22.4 Activation procedure + +### 22.4.1 General + +The activation procedure is used to activate a supplementary service in the HLR. The activation procedure is a fully transparent communication between the MS and the HLR. + +### 22.4.2 Procedures in the GLR + +#### Supplementary service activation + +When receiving the MAP\_ACTIVATE\_SS indication, the MAP user in the GLR transfers the information to the HLR in the MAP\_ACTIVATE\_SS request without checking the contents of the service indication. + +The GLR may then receive the MAP\_GET\_PASSWORD indication. This information is transferred to the VLR in the MAP\_GET\_PASSWORD request. If a MAP\_GET\_PASSWORD confirm primitive is received from the VLR, the VLR initiates the MAP\_GET\_PASSWORD response towards the HLR. + +The GLR will receive the MAP\_ACTIVATE\_SS confirm from the HLR. The MAP user in the GLR shall transfer the information contained in this primitive to the VLR in the MAP\_ACTIVATE\_SS response without checking its contents. + +#### Error handling + +The handling of MAP\_P\_ABORT, MAP\_U\_ABORT, MAP\_NOTICE and unexpected MAP\_CLOSE in this procedure is identical to the handling in the Registration procedure in the GLR, see subclause 22.2 of the present document. + +The activation procedure in the GLR is shown in figure 22.4/1. + +![Flowchart for Process SS_ACTIVATE_GLR. The process starts with an oval, followed by a 'NULL' block. It then branches into two parallel paths. The left path consists of 'MAP_ACTIVATE_SS_ind', 'MAP_OPEN_req' (with a note: To HLR, Including - Destination reference = subscriber's IMSI, - Originating reference = GLR number), 'MAP_ACTIVATE_req', 'MAP_DELIMITER_req', and 'Receive_Open_Confirm' (linked to Section 25.1). From 'Receive_Open_Confirm', an 'OK' path leads to 'Wait_for_ss_cnf' and a 'Vr,Error' path leads to a circle labeled '1'. The circle '1' leads to 'MAP_U_ABORT_req', which ends with a crossed-out line. The right path consists of 'MAP_NOTICE_ind', 'MAP_CLOSE_req', and a box containing 'MAP_U_ABORT_ind', 'MAP_P_ABORT_ind', and 'MAP_CLOSE_ind'. 'MAP_CLOSE_req' also ends with a crossed-out line.](e18841eb4a995df8354a793459e12fd0_img.jpg) + +### Process SS\_ACTIVATE\_GLR + +22.4.1\_1(2) + +Figure 22.4/1: Activation of supplementary service procedure in the GLR + +Signals to/from the left are to/from the VLR via the MAP provider; signals to/from the right are to/from the child process + +``` +graph TD; Start([ ]) --> NULL[NULL]; NULL --> MAP_ACTIVATE_SS_ind{MAP_ACTIVATE_SS_ind}; MAP_ACTIVATE_SS_ind --> MAP_OPEN_req{MAP_OPEN_req}; MAP_OPEN_req --> To_HLR["To HLR, Including
- Destination reference = subscriber's IMSI
- Originating reference = GLR number"]; To_HLR --> MAP_ACTIVATE_req{MAP_ACTIVATE_req}; MAP_ACTIVATE_req --> MAP_DELIMITER_req{MAP_DELIMITER_req}; MAP_DELIMITER_req --> Receive_Open_Confirm[Receive_Open_Confirm]; Receive_Open_Confirm --> Section_25_1[Section 25.1]; Receive_Open_Confirm -- OK --> Wait_for_ss_cnf[Wait_for_ss_cnf]; Receive_Open_Confirm -- Vr,Error --> Circle_1((1)); Circle_1 --> MAP_U_ABORT_req{MAP_U_ABORT_req}; MAP_U_ABORT_req --> End_X1[ ]; MAP_ACTIVATE_SS_ind --> MAP_NOTICE_ind{MAP_NOTICE_ind}; MAP_NOTICE_ind --> MAP_CLOSE_req{MAP_CLOSE_req}; MAP_CLOSE_req --> End_X2[ ]; MAP_NOTICE_ind --> MAP_U_ABORT_ind["MAP_U_ABORT_ind
MAP_P_ABORT_ind
MAP_CLOSE_ind"]; +``` + +Flowchart for Process SS\_ACTIVATE\_GLR. The process starts with an oval, followed by a 'NULL' block. It then branches into two parallel paths. The left path consists of 'MAP\_ACTIVATE\_SS\_ind', 'MAP\_OPEN\_req' (with a note: To HLR, Including - Destination reference = subscriber's IMSI, - Originating reference = GLR number), 'MAP\_ACTIVATE\_req', 'MAP\_DELIMITER\_req', and 'Receive\_Open\_Confirm' (linked to Section 25.1). From 'Receive\_Open\_Confirm', an 'OK' path leads to 'Wait\_for\_ss\_cnf' and a 'Vr,Error' path leads to a circle labeled '1'. The circle '1' leads to 'MAP\_U\_ABORT\_req', which ends with a crossed-out line. The right path consists of 'MAP\_NOTICE\_ind', 'MAP\_CLOSE\_req', and a box containing 'MAP\_U\_ABORT\_ind', 'MAP\_P\_ABORT\_ind', and 'MAP\_CLOSE\_ind'. 'MAP\_CLOSE\_req' also ends with a crossed-out line. + +Figure 22.4/1 (sheet 1 of 2): Procedure Activate\_SS\_GLR + +![Flowchart for Process SS_ACTIVATE_GLR. The process starts with 'Wait_for_ss_cnf'. It then sends 'MAP_REGISTER_SS_cnf' to the left. A decision 'MAP_P_ERROR' follows. If 'yes', it goes to connector '1'. If 'no', it receives 'MAP_REGISTER_SS_rsp' from the left, then sends 'MAP_CLOSE_req' to the left, which ends with a crossed-out symbol. If 'MAP_P_ERROR' is 'no', it also receives 'MAP_NOTICE_ind' from the right, then sends 'MAP_CLOSE_req' to the right, which ends with a crossed-out symbol. A return path from connector '1' leads to a box with 'MAP_U_ABORT_ind' and 'MAP_P_ABORT_ind'. From this box, the flow goes to 'MAP_NOTICE_ind' on the right, then 'MAP_CLOSE_req' on the right, which ends with a crossed-out symbol. Another path from the box leads to 'GET_PASSWORD_GLR' on the right, which is linked to 'Section 22.10'. 'GET_PASSWORD_GLR' has two outputs: 'OK' leads to 'Wait_for_ss_cnf', and 'NULL' ends with a crossed-out symbol.](0b998e3ad8f9d104768642612605cb35_img.jpg) + +**Process SS\_ACTIVATE\_GLR** 22.4.1\_2(2) + +Figure 22.4/1: Activation of supplementary service procedure in the GLR + +Signals to/from the left are to/from the VLR via the MAP provider; signals to/from the right are to/from the child process + +``` + +graph TD + Start([Wait_for_ss_cnf]) --> RegisterLeft[MAP_REGISTER_SS_cnf] + RegisterLeft --> PError{MAP_P_ERROR} + PError -- yes --> Connector1((1)) + PError -- no --> RegisterRight[MAP_REGISTER_SS_rsp] + RegisterRight --> CloseLeft[MAP_CLOSE_req] + CloseLeft --> EndLeft[✗] + Connector1 --> AbortInd[MAP_U_ABORT_ind +MAP_P_ABORT_ind] + AbortInd --> NoticeRight[MAP_NOTICE_ind] + NoticeRight --> CloseRight[MAP_CLOSE_req] + CloseRight --> EndRight[✗] + AbortInd --> GetPassword[GET_PASSWORD_GLR] + GetPassword --> Section22_10[Section 22.10] + GetPassword -- OK --> WaitRight([Wait_for_ss_cnf]) + GetPassword -- NULL --> EndRight2[✗] + +``` + +Flowchart for Process SS\_ACTIVATE\_GLR. The process starts with 'Wait\_for\_ss\_cnf'. It then sends 'MAP\_REGISTER\_SS\_cnf' to the left. A decision 'MAP\_P\_ERROR' follows. If 'yes', it goes to connector '1'. If 'no', it receives 'MAP\_REGISTER\_SS\_rsp' from the left, then sends 'MAP\_CLOSE\_req' to the left, which ends with a crossed-out symbol. If 'MAP\_P\_ERROR' is 'no', it also receives 'MAP\_NOTICE\_ind' from the right, then sends 'MAP\_CLOSE\_req' to the right, which ends with a crossed-out symbol. A return path from connector '1' leads to a box with 'MAP\_U\_ABORT\_ind' and 'MAP\_P\_ABORT\_ind'. From this box, the flow goes to 'MAP\_NOTICE\_ind' on the right, then 'MAP\_CLOSE\_req' on the right, which ends with a crossed-out symbol. Another path from the box leads to 'GET\_PASSWORD\_GLR' on the right, which is linked to 'Section 22.10'. 'GET\_PASSWORD\_GLR' has two outputs: 'OK' leads to 'Wait\_for\_ss\_cnf', and 'NULL' ends with a crossed-out symbol. + +Figure 22.4/1 (sheet 2 of 2): Procedure SS\_Activate\_GLR + +## 22.5 Deactivation procedure + +### 22.5.1 General + +The deactivation procedure is used to deactivate a supplementary service in the HLR. The deactivation procedure is a fully transparent communication between the MS and the HLR. + +### 22.5.2 Procedures in the GLR + +The GLR procedures for deactivation are identical to those specified for activation in subclause 22.4. The text and diagrams in subclause 22.4 apply with all references to activation changed to deactivation. + +## 22.6 Interrogation procedure + +### 22.6.1 General + +The interrogation procedure is used to retrieve information related to a supplementary service from the VLR or the HLR. The interrogation procedure in the GLR is a fully transparent communication between the VLR and the HLR. + +### 22.6.2 Procedures in the GLR + +The GLR procedures for interrogation are identical to those specified for registration in subclause 22.2. The text and diagrams in subclause 22.2 apply with all references to registration changed to interrogation. + +## 22.7 Password registration procedure + +### 22.7.1 General + +The password registration procedure is used to register a password in the HLR. The password registration procedure is a fully transparent communication between the MS and the HLR. + +### 22.7.2 Procedures in the GLR + +The password registration procedure in the GLR is identical to that for activation specified in subclause 22.4. All the text and diagrams in subclause 22.4 apply with all references to activation changed to password registration. + +## 22.8 Mobile Initiated USSD procedure + +### 22.8.1 Procedures in the GLR + +The initiation of the process is shown in subclause 22.1. + +In the case that a GLR is located between the VLR and the HLR, the Mobile Initiated USSD procedure in the GLR is a fully transparent communication between the VLR and the HLR. + +When receiving the MAP\_PROCESS\_UNSTRUCTURED\_SS\_REQUEST indication from VLR, the MAP user in the GLR transfers the information to the HLR in the MAP\_PROCESS\_UNSTRUCTURED\_SS\_REQUEST request without checking the contents of the service indication. + +The GLR may subsequently receive one or more MAP\_UNSTRUCTURED\_SS\_REQUEST or MAP\_UNSTRUCTURED\_SS\_NOTIFY indications from the HLR. These shall be sent transparently to the VLR. When a confirmation is received from the VLR this shall be returned to the HLR. + +When the GLR receives a MAP\_PROCESS\_UNSTRUCTURED\_SS\_REQUEST confirmation from the HLR then it shall pass this to the VLR and closes the MAP provider service. + +#### Error Handling + +Both the VLR and the HLR may initiate release of the MAP service at any time. This is handled as shown in the diagrams. + +The procedure in the HLR is shown in figure 22.8/1. + +![Flowchart for Process MS_INIT_USSD_GLR. The process starts with NULL, followed by Receive_Open_ind (Section25.1). It then branches based on OK (Wait_for_service_ind) or Vr, Error (NULL). The main path involves MAP_PROCESS_UNSTD_SS_REQUEST_ind, MAP_OPEN_req (with Destination reference = subscriber's IMSI and Originating reference = GLR number), MAP_PROCESS_UNSTD_SS_REQUEST_req, MAP_DELIMITER_req, and Receive_Open_cnf (Section25.1). From Receive_Open_cnf, it branches based on OK (Wait_for_pussd_cnf), Vr (MAP_U_ABORT_req), or Error (Set UE= System Failure). The Error path leads to MAP_PROCESS_UNSTD_SS_REQUEST_rsp and NULL. There is also a branch for MAP_NOTICE_ind, MAP_CLOSE_ind, and signals MAP_U_ABORT_ind, MAP_P_ABORT_ind, and MAP_CLOSE_ind.](ba676d18b6a00f27c5bfaec9eeec20be_img.jpg) + +### Process MS\_INIT\_USSD\_GLR + +22.8.1\_1(2) + +Figure 22.8/1: Handling of mobile initiated USSD at GLR. + +Signals to/from the left are to/from the VLR +signals to/from the right are to/from the HLR +unless otherwise stated + +``` +graph TD; NULL1(NULL) --> RO1[Receive_Open_ind]; RO1 --- S25_1_1[Section25.1]; RO1 -- OK --> WS[Wait_for_service_ind]; RO1 -- "Vr, Error" --> NULL2(NULL); WS --> MPRI{MAP_PROCESS_UNSTD_SS_REQUEST_ind}; MPRI --> MR{MAP_NOTICE_ind}; MR --> MC{MAP_CLOSE_ind}; MC --> MA[MAP_U_ABORT_ind +MAP_P_ABORT_ind +MAP_CLOSE_ind]; MPRI --> MO{MAP_OPEN_req}; MO --- MO_info["-Destination reference = subscriber's IMSI +-Originating reference = GLR number"]; MO --> MPQR{MAP_PROCESS_UNSTD_SS_REQUEST_req}; MPQR --> MD{MAP_DELIMITER_req}; MD --> RO2[Receive_Open_cnf]; RO2 --- S25_1_2[Section25.1]; RO2 -- OK --> WP[Wait_for_pussd_cnf]; RO2 -- Vr --> MUAR{MAP_U_ABORT_req}; RO2 -- Error --> SU["Set UE= System Failure"]; SU --> MPRESP{MAP_PROCESS_UNSTD_SS_REQUEST_rsp}; MPRESP --> NULL3(NULL); +``` + +Flowchart for Process MS\_INIT\_USSD\_GLR. The process starts with NULL, followed by Receive\_Open\_ind (Section25.1). It then branches based on OK (Wait\_for\_service\_ind) or Vr, Error (NULL). The main path involves MAP\_PROCESS\_UNSTD\_SS\_REQUEST\_ind, MAP\_OPEN\_req (with Destination reference = subscriber's IMSI and Originating reference = GLR number), MAP\_PROCESS\_UNSTD\_SS\_REQUEST\_req, MAP\_DELIMITER\_req, and Receive\_Open\_cnf (Section25.1). From Receive\_Open\_cnf, it branches based on OK (Wait\_for\_pussd\_cnf), Vr (MAP\_U\_ABORT\_req), or Error (Set UE= System Failure). The Error path leads to MAP\_PROCESS\_UNSTD\_SS\_REQUEST\_rsp and NULL. There is also a branch for MAP\_NOTICE\_ind, MAP\_CLOSE\_ind, and signals MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, and MAP\_CLOSE\_ind. + +Figure 22.8/1 (sheet 1 of 2): Procedure MI\_USSD\_GLR + +![Flowchart for Process MS_INIT_USSD_GLR showing four main signal paths: MAP_PROCESS_UNSTD_SS_REQUEST_cnf, MAP_UNSTD_SS_NOTIFY_ind, MAP_UNSTD_SS_REQUEST_ind, and MS_Receive_Error_at_GLR. Each path leads to various processing steps including error handling, delimiter processing, and waiting for confirmations.](a5404b7275b06497eecf9b5883604753_img.jpg) + +**Process MS\_INIT\_USSD\_GLR** 22.8.1\_2(2) + +Figure 22.8/1: Handling of mobile initiated USSD at GLR. + +Signals to/from the left are to/from the VLR +signals to/from the right are to/from the HLR +unless otherwise stated + +``` + +graph TD + Start([Wait_for_pussd_cnf]) --> P1[MAP_PROCESS_UNSTD_SS_REQUEST_cnf] + Start --> P2[MAP_UNSTD_SS_NOTIFY_ind] + Start --> P3[MAP_UNSTD_SS_REQUEST_ind] + Start --> P4[MS_Receive_Error_at_GLR] + + P1 --> D1{MAP_P_ERROR} + D1 -- no --> P1R[MAP_PROCESS_UNSTD_SS_REQUEST_rsp] + D1 -- yes --> U1[MAP_U_ABORT_req] + P1R --> C1[MAP_CLOSE_req] + U1 --> U2[MAP_U_ABORT_req] + C1 --> NULL1([NULL]) + + P2 --> D2{MAP_UNSTD_SS_NOTIFY_req} + D2 --> DEL2[MAP_DELIMITER_req] + DEL2 --> W2([Wait_for_ussdn_cnf]) + W2 --> N2[MAP_UNSTD_SS_NOTIFY_cnf] + N2 --> R2[MAP_UNSTD_SS_NOTIFY_rsp] + R2 --> DEL3[MAP_DELIMITER_req] + DEL3 --> W3([Wait_for_pussd_cnf]) + + P3 --> D3{MAP_UNSTD_SS_REQUEST_req} + D3 --> DEL4[MAP_DELIMITER_req] + DEL4 --> W4([Wait_for_ussdn_cnf]) + W4 --> N3[MAP_UNSTD_SS_REQUEST_cnf] + N3 --> R3[MAP_UNSTD_SS_REQUEST_rsp] + R3 --> DEL5[MAP_DELIMITER_req] + DEL5 --> W5([Wait_for_pussd_cnf]) + + P4 --> NULL2([NULL]) + +``` + +Flowchart for Process MS\_INIT\_USSD\_GLR showing four main signal paths: MAP\_PROCESS\_UNSTD\_SS\_REQUEST\_cnf, MAP\_UNSTD\_SS\_NOTIFY\_ind, MAP\_UNSTD\_SS\_REQUEST\_ind, and MS\_Receive\_Error\_at\_GLR. Each path leads to various processing steps including error handling, delimiter processing, and waiting for confirmations. + +Figure 22.8/1 (sheet 2 of 2): Procedure MI\_USSD\_GLR + +![SDL diagram for Macro MS_Receive_Error_at_GLR showing signal handling between VLR and HLR.](a7450c80e88ad3f6ca1427ad84020998_img.jpg) + +### Macrodefinition MS\_Receive\_Error\_at\_GLR + +22.8.2(1) + +Figure 22.8/2: Handling of error at GLR for MS initiated USSD + +Signals to/from the left +are to/from the VLR +signals to/from the right +are to/from the HLR +unless otherwise stated + +``` + +stateDiagram-v2 + [*] --> Wait_for_cnf + state "Wait_for_cnf" as Wait_for_cnf + + %% Path 1: MAP_CLOSE_ind from HLR + Wait_for_cnf --> MAP_CLOSE_ind_HLR : MAP_CLOSE_ind (from right) + state "MAP_CLOSE_ind" as MAP_CLOSE_ind_HLR + MAP_CLOSE_ind_HLR --> MAP_CLOSE_req_VLR : MAP_CLOSE_req (to left) + state "MAP_CLOSE_req" as MAP_CLOSE_req_VLR + MAP_CLOSE_req_VLR --> End1 + state " " as End1 + + %% Path 2: Abort from HLR + Wait_for_cnf --> Abort_HLR : MAP_U_ABORT_ind / MAP_P_ABORT_ind (from right) + state "MAP_U_ABORT_ind\nMAP_P_ABORT_ind" as Abort_HLR + Abort_HLR --> MAP_NOTICE_ind_VLR : MAP_NOTICE_ind (to left) + state "MAP_NOTICE_ind" as MAP_NOTICE_ind_VLR + MAP_NOTICE_ind_VLR --> MAP_CLOSE_req_HLR : MAP_CLOSE_req (to right) + state "MAP_CLOSE_req" as MAP_CLOSE_req_HLR + MAP_CLOSE_req_HLR --> MAP_U_ABORT_req_VLR : MAP_U_ABORT_req (to left) + state "MAP_U_ABORT_req" as MAP_U_ABORT_req_VLR + MAP_U_ABORT_req_VLR --> End2 + state " " as End2 + + %% Path 3: MAP_NOTICE_ind from HLR + Wait_for_cnf --> MAP_NOTICE_ind_HLR : MAP_NOTICE_ind (from right) + state "MAP_NOTICE_ind" as MAP_NOTICE_ind_HLR + MAP_NOTICE_ind_HLR --> MAP_CLOSE_req_HLR2 : MAP_CLOSE_req (to right) + state "MAP_CLOSE_req" as MAP_CLOSE_req_HLR2 + MAP_CLOSE_req_HLR2 --> MAP_U_ABORT_req_VLR2 : MAP_U_ABORT_req (to left) + state "MAP_U_ABORT_req" as MAP_U_ABORT_req_VLR2 + MAP_U_ABORT_req_VLR2 --> End3 + state " " as End3 + + %% Path 4: Signals from VLR + Wait_for_cnf --> Signals_VLR : MAP_U_ABORT_ind / MAP_P_ABORT_ind / MAP_CLOSE_ind (from left) + state "MAP_U_ABORT_ind\nMAP_P_ABORT_ind\nMAP_CLOSE_ind\nFrom VLR" as Signals_VLR + Signals_VLR --> End4 + state " " as End4 + +``` + +SDL diagram for Macro MS\_Receive\_Error\_at\_GLR showing signal handling between VLR and HLR. + +**Figure 22.8/2: Macro MS\_Receive\_ERROR\_at\_GLR** + +## 22.9 Network initiated USSD procedure + +### 22.9.1 Procedure in the GLR + +In the case that a GLR is located between the VLR and the HLR, the Network initiated USSD procedure in the GLR is a fully transparent communication between the VLR and the HLR. + +The procedure may be invoked by the HLR. It may start by using either the MAP\_UNSTRUCTURED\_SS\_REQUEST or MAP\_UNSTRUCTURED\_SS\_NOTIFY service. + +The GLR may subsequently receive one or more MAP\_UNSTRUCTURED\_SS\_REQUEST\_ind or MAP\_UNSTRUCTURED\_SS\_NOTIFY\_ind indications from the VLR. These shall be sent transparently to the HLR. When a confirmation is received from the HLR this shall be returned to the VLR. + +When the GLR receives a MAP\_CLOSE\_ind from the HLR then it shall pass this to the VLR and close the MAP dialogue. + +#### **Error Handling** + +Both the VLR and the HLR may initiate release of the MAP service at any time. This is handled as shown in the diagrams. + +The Network initiated USSD procedure in the GLR is shown in figure 22.9/1. + +![Flowchart for Process NW_INIT_USSD_GLR. The process starts with NULL, followed by Receive_Open_ind (Section 25.1). It then enters a Wait_for_service_ind state. From there, it branches based on OK (leading to MAP_UNSTD_SS_NOTIFY_req) or Vr, Error (leading to NULL). The MAP_UNSTD_SS_NOTIFY_req leads to MAP_OPEN_req, which leads to MAP_UNSTD_SS_NOTIFY_req. The MAP_UNSTD_SS_NOTIFY_req leads to MAP_DELIMITER_req, which leads to Receive_Open_cnf (Section 25.1). From Receive_Open_cnf, it branches based on OK (leading to Wait_for_ussdn_cnf) or Vr, Error (leading to MAP_U_ABORT_req). Both Wait_for_ussdn_cnf and MAP_U_ABORT_req lead to NULL. There is also a branch from Wait_for_service_ind to MAP_UNSTD_SS_REQUEST_ind, which leads to MAP_OPEN_req, which leads to MAP_UNSTD_SS_REQUEST_req. The MAP_UNSTD_SS_REQUEST_req leads to a junction point. From this junction point, it branches to MAP_CLOSE_req (which leads to NULL) and to a box containing MAP_U_ABORT_ind, MAP_P_ABORT_ind, and MAP_CLOSE_ind. The MAP_CLOSE_req also leads to the junction point.](17431d8b59408f09df7552d8bdbaa015_img.jpg) + +### Process NW\_INIT\_USSD\_GLR + +22.9.1\_1(2) + +Figure 22.9/1: Handling of network initiated USSD at GLR. + +Signals to/from the left are to/from the VLR +signals to/from the right are to/from the HLR +unless otherwise stated + +``` +graph TD + NULL1(NULL) --> Receive_Open_ind[Receive_Open_ind] + Receive_Open_ind --- Section25_1_1[Section 25.1] + Receive_Open_ind --> Wait_for_service_ind((Wait_for_service_ind)) + Wait_for_service_ind -- OK --> MAP_UNSTD_SS_NOTIFY_req{MAP_UNSTD_SS_NOTIFY_req} + Wait_for_service_ind -- Vr, Error --> NULL2(NULL) + MAP_UNSTD_SS_NOTIFY_req --> MAP_OPEN_req1{MAP_OPEN_req} + MAP_UNSTD_SS_NOTIFY_req --> MAP_UNSTD_SS_REQUEST_ind{MAP_UNSTD_SS_REQUEST_ind} + MAP_UNSTD_SS_REQUEST_ind --> MAP_OPEN_req2{MAP_OPEN_req} + MAP_OPEN_req1 --> MAP_UNSTD_SS_NOTIFY_req + MAP_OPEN_req2 --> MAP_UNSTD_SS_REQUEST_req{MAP_UNSTD_SS_REQUEST_req} + MAP_UNSTD_SS_REQUEST_req --> Junction(( )) + Junction --> MAP_CLOSE_req{MAP_CLOSE_req} + Junction --> AbortCloseBox[MAP_U_ABORT_ind +MAP_P_ABORT_ind +MAP_CLOSE_ind] + MAP_CLOSE_req --> NULL3(NULL) + MAP_CLOSE_req --> Junction + MAP_UNSTD_SS_NOTIFY_req --> MAP_DELIMITER_req{MAP_DELIMITER_req} + MAP_DELIMITER_req --> Receive_Open_cnf[Receive_Open_cnf] + Receive_Open_cnf --- Section25_1_2[Section 25.1] + Receive_Open_cnf -- OK --> Wait_for_ussdn_cnf((Wait_for_ussdn_cnf)) + Receive_Open_cnf -- Vr, Error --> MAP_U_ABORT_req{MAP_U_ABORT_req} + Wait_for_ussdn_cnf --> NULL4(NULL) + MAP_U_ABORT_req --> NULL4 +``` + +Flowchart for Process NW\_INIT\_USSD\_GLR. The process starts with NULL, followed by Receive\_Open\_ind (Section 25.1). It then enters a Wait\_for\_service\_ind state. From there, it branches based on OK (leading to MAP\_UNSTD\_SS\_NOTIFY\_req) or Vr, Error (leading to NULL). The MAP\_UNSTD\_SS\_NOTIFY\_req leads to MAP\_OPEN\_req, which leads to MAP\_UNSTD\_SS\_NOTIFY\_req. The MAP\_UNSTD\_SS\_NOTIFY\_req leads to MAP\_DELIMITER\_req, which leads to Receive\_Open\_cnf (Section 25.1). From Receive\_Open\_cnf, it branches based on OK (leading to Wait\_for\_ussdn\_cnf) or Vr, Error (leading to MAP\_U\_ABORT\_req). Both Wait\_for\_ussdn\_cnf and MAP\_U\_ABORT\_req lead to NULL. There is also a branch from Wait\_for\_service\_ind to MAP\_UNSTD\_SS\_REQUEST\_ind, which leads to MAP\_OPEN\_req, which leads to MAP\_UNSTD\_SS\_REQUEST\_req. The MAP\_UNSTD\_SS\_REQUEST\_req leads to a junction point. From this junction point, it branches to MAP\_CLOSE\_req (which leads to NULL) and to a box containing MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, and MAP\_CLOSE\_ind. The MAP\_CLOSE\_req also leads to the junction point. + +Figure 22.9/1 (sheet 1 of 2): Procedure NI\_USSD\_GLR + +![Flowchart for Process NW_INIT_USSD_GLR. It starts with 'Wait_for_pussd_cnf' and branches into three main paths based on incoming signals: MAP_UNSTD_SS_NOTIFY_ind, MAP_UNSTD_SS_REQUEST_ind, and NW_Receive_Error_at_GLR. The first path involves MAP_UNSTD_SS_NOTIFY_req, MAP_DELIMITER_req, and Wait_for_ussdn_cnf, leading to a decision on MAP_UNSTD_SS_NOTIFY_cnf. The second path involves MAP_UNSTD_SS_REQUEST_req, MAP_DELIMITER_req, and Wait_for_ussdn_cnf, leading to a decision on MAP_UNSTD_SS_REQUEST_cnf. The third path leads to NULL. Both decision points have 'NULL' error paths.](6e9d059430baba0c363e33749f68b107_img.jpg) + +### Process NW\_INIT\_USSD\_GLR + +22.9.1\_2(2) + +Figure 22.9/1: Handling of network initiated USSD at GLR. + +Signals to/from the left are to/from the VLR +signals to/from the right are to/from the HLR +unless otherwise stated + +``` +graph TD; Start([Wait_for_pussd_cnf]) --> Ind1{MAP_UNSTD_SS_NOTIFY_ind}; Start --> Ind2{MAP_UNSTD_SS_REQUEST_ind}; Start --> Error1[NW_Receive_Error_at_GLR]; Ind1 --> Req1{MAP_UNSTD_SS_NOTIFY_req}; Req1 --> Delim1{MAP_DELIMITER_req}; Delim1 --> Wait1([Wait_for_ussdn_cnf]); Wait1 --> Cnf1{MAP_UNSTD_SS_NOTIFY_cnf}; Cnf1 --> Rsp1{MAP_UNSTD_SS_NOTIFY_rsp}; Rsp1 --> Delim2{MAP_DELIMITER_req}; Delim2 --> Wait2([Wait_for_pussd_cnf]); Ind2 --> Req2{MAP_UNSTD_SS_REQUEST_req}; Req2 --> Delim3{MAP_DELIMITER_req}; Delim3 --> Wait3([Wait_for_ussdn_cnf]); Wait3 --> Cnf2{MAP_UNSTD_SS_REQUEST_cnf}; Cnf2 --> Rsp2{MAP_UNSTD_SS_REQUEST_rsp}; Rsp2 --> Delim4{MAP_DELIMITER_req}; Delim4 --> Wait4([Wait_for_pussd_cnf]); Error1 --> NULL1([NULL]); Cnf1 --> Error2[NW_Receive_Error_at_GLR]; Error2 --> NULL2([NULL]); Cnf2 --> Error3[NW_Receive_Error_at_GLR]; Error3 --> NULL3([NULL]); +``` + +Flowchart for Process NW\_INIT\_USSD\_GLR. It starts with 'Wait\_for\_pussd\_cnf' and branches into three main paths based on incoming signals: MAP\_UNSTD\_SS\_NOTIFY\_ind, MAP\_UNSTD\_SS\_REQUEST\_ind, and NW\_Receive\_Error\_at\_GLR. The first path involves MAP\_UNSTD\_SS\_NOTIFY\_req, MAP\_DELIMITER\_req, and Wait\_for\_ussdn\_cnf, leading to a decision on MAP\_UNSTD\_SS\_NOTIFY\_cnf. The second path involves MAP\_UNSTD\_SS\_REQUEST\_req, MAP\_DELIMITER\_req, and Wait\_for\_ussdn\_cnf, leading to a decision on MAP\_UNSTD\_SS\_REQUEST\_cnf. The third path leads to NULL. Both decision points have 'NULL' error paths. + +Figure 22.9/1 (sheet 2 of 2): Procedure NI\_USSD\_GLR + +![State transition diagram for Macrodefinition NW_Receive_Error_at_GLR. The diagram shows two main paths. The left path starts with a start symbol, followed by 'Wait_for_cnf', then 'MAP_CLOSE_ind', 'MAP_CLOSE_req', and an end symbol. The right path starts from the 'Wait_for_cnf' state, goes through a merge point, then 'MAP_U_ABORT_ind' and 'MAP_P_ABORT_ind' (from the right), then 'MAP_NOTICE_ind', 'MAP_CLOSE_req', 'MAP_U_ABORT_req', and an end symbol. A second part of the diagram shows 'MAP_NOTICE_ind' (from the right), a merge point, 'MAP_U_ABORT_ind', 'MAP_P_ABORT_ind', and 'MAP_CLOSE_ind' (all from the VLR), then 'MAP_CLOSE_req', 'MAP_U_ABORT_req', and an end symbol.](eabcb2f8b9acedb194571d5bc734b463_img.jpg) + +### Macrodefinition NW\_Receive\_Error\_at\_GLR + +22.9.2(1) + +Figure 22.9/2: Handling of error at GLR for NW initiated USSD + +Signals to/from the left are to/from the VLR +signals to/from the right are to/from the HLR +unless otherwise stated + +``` +stateDiagram-v2 + [*] --> Wait_for_cnf + state "Wait_for_cnf" as Wait_for_cnf + state "MAP_CLOSE_ind" as MAP_CLOSE_ind + state "MAP_CLOSE_req" as MAP_CLOSE_req + state "MAP_U_ABORT_ind" as MAP_U_ABORT_ind + state "MAP_P_ABORT_ind" as MAP_P_ABORT_ind + state "MAP_NOTICE_ind" as MAP_NOTICE_ind + state "MAP_CLOSE_req" as MAP_CLOSE_req + state "MAP_U_ABORT_req" as MAP_U_ABORT_req + state "MAP_NOTICE_ind (From VLR)" as MAP_NOTICE_ind + state "MAP_U_ABORT_ind (From VLR)" as MAP_U_ABORT_ind + state "MAP_P_ABORT_ind (From VLR)" as MAP_P_ABORT_ind + state "MAP_CLOSE_ind (From VLR)" as MAP_CLOSE_ind + state "MAP_CLOSE_req (From VLR)" as MAP_CLOSE_req + state "MAP_U_ABORT_req (From VLR)" as MAP_U_ABORT_req + + Wait_for_cnf --> MAP_CLOSE_ind + MAP_CLOSE_ind --> MAP_CLOSE_req + MAP_CLOSE_req --> [*] + + Wait_for_cnf --> Merge1 + state "Merge1" as Merge1 + Merge1 --> MAP_U_ABORT_ind + Merge1 --> MAP_P_ABORT_ind + MAP_U_ABORT_ind --> MAP_NOTICE_ind + MAP_P_ABORT_ind --> MAP_NOTICE_ind + MAP_NOTICE_ind --> MAP_CLOSE_req + MAP_CLOSE_req --> MAP_U_ABORT_req + MAP_U_ABORT_req --> [*] + + Merge2 --> MAP_NOTICE_ind + state "Merge2" as Merge2 + MAP_NOTICE_ind --> MAP_CLOSE_req + MAP_CLOSE_req --> MAP_U_ABORT_req + MAP_U_ABORT_req --> [*] + + Note right of MAP_U_ABORT_ind: MAP_U_ABORT_ind +MAP_P_ABORT_ind +MAP_CLOSE_ind +From VLR +``` + +State transition diagram for Macrodefinition NW\_Receive\_Error\_at\_GLR. The diagram shows two main paths. The left path starts with a start symbol, followed by 'Wait\_for\_cnf', then 'MAP\_CLOSE\_ind', 'MAP\_CLOSE\_req', and an end symbol. The right path starts from the 'Wait\_for\_cnf' state, goes through a merge point, then 'MAP\_U\_ABORT\_ind' and 'MAP\_P\_ABORT\_ind' (from the right), then 'MAP\_NOTICE\_ind', 'MAP\_CLOSE\_req', 'MAP\_U\_ABORT\_req', and an end symbol. A second part of the diagram shows 'MAP\_NOTICE\_ind' (from the right), a merge point, 'MAP\_U\_ABORT\_ind', 'MAP\_P\_ABORT\_ind', and 'MAP\_CLOSE\_ind' (all from the VLR), then 'MAP\_CLOSE\_req', 'MAP\_U\_ABORT\_req', and an end symbol. + +Figure 22.9/2: Marco NW\_Receive\_Rrror\_at\_GLR + +## 22.10 Common macros for clause 22 + +### 22.10.1 SS Password handling macros + +Macro Get\_Password\_GLR + +This macro is used by the GLR to relay a request for password from the HLR to the VLR, and to relay a response from the VLR back to the HLR. The macro is described in figure 22.10/1. + +![Flowchart for Macro GET_PASSWORD_GLR. The process starts with an oval connector, followed by MAP_GET_PASSWORD_ind (VLR to GLR), MAP_GET_PASSWORD_req (GLR to VLR), and MAP_DELIMITER_req (GLR to VLR). A 'Wait_for_password' state follows. A loop then begins: MAP_GET_PASSWORD_cnf (VLR to GLR) leads to MAP_GET_PASSWORD_rsp (GLR to VLR), which leads to MAP_DELIMITER_req (GLR to VLR), ending at an 'OK' connector. From the loop entry point, two other paths exist: one leading to a box with MAP_U_ABORT_ind and MAP_P_ABORT_ind, which then leads to a 'NULL' connector; the other leading to MAP_NOTICE_ind (VLR to GLR), then MAP_CLOSE_req (GLR to VLR), then MAP_U_ABORT_req (GLR to VLR), ending at a 'NULL' connector. From the 'NULL' connector, a path leads to a box with MAP_U_ABORT_ind, MAP_P_ABORT_ind, and MAP_CLOSE_ind, which then leads to MAP_NOTICE_ind (VLR to GLR), then MAP_CLOSE_req (GLR to VLR), then MAP_U_ABORT_req (GLR to VLR), ending at another 'NULL' connector.](40b80ef077f6151a9fbb593b8ad4864d_img.jpg) + +**Macrodefinition GET\_PASSWORD\_GLR** 22.10.1(1) + +Figure 22.10/1: Macro which relay a GET Password request from the HLR to the VLR and relay a GET Password response from the VLR to the HLR + +Signals to/from the left are to/from the VLR +signals to/from the right are to/from the HLR +unless otherwise stated + +``` + +graph TD + Start([ ]) --> MAP_GET_PASSWORD_ind[MAP_GET_PASSWORD_ind] + MAP_GET_PASSWORD_ind --> MAP_GET_PASSWORD_req{MAP_GET_PASSWORD_req} + MAP_GET_PASSWORD_req --> MAP_DELIMITER_req1{MAP_DELIMITER_req} + MAP_DELIMITER_req1 --> Wait[Wait_for_password] + Wait --> Entry(( )) + Entry --> MAP_GET_PASSWORD_cnf[MAP_GET_PASSWORD_cnf] + Entry --> AbortInd[MAP_U_ABORT_ind +MAP_P_ABORT_ind] + Entry --> NoticeInd[MAP_NOTICE_ind] + MAP_GET_PASSWORD_cnf --> MAP_GET_PASSWORD_rsp[MAP_GET_PASSWORD_rsp] + MAP_GET_PASSWORD_rsp --> MAP_DELIMITER_req2{MAP_DELIMITER_req} + MAP_DELIMITER_req2 --> OK([OK]) + AbortInd --> NULL1((NULL)) + NoticeInd --> MAP_CLOSE_req1{MAP_CLOSE_req} + MAP_CLOSE_req1 --> MAP_U_ABORT_req1{MAP_U_ABORT_req} + MAP_U_ABORT_req1 --> NULL2((NULL)) + NULL2 --> FinalInd[MAP_U_ABORT_ind +MAP_P_ABORT_ind +MAP_CLOSE_ind] + FinalInd --> NoticeInd2[MAP_NOTICE_ind] + NoticeInd2 --> MAP_CLOSE_req2{MAP_CLOSE_req} + MAP_CLOSE_req2 --> MAP_U_ABORT_req2{MAP_U_ABORT_req} + MAP_U_ABORT_req2 --> NULL3((NULL)) + +``` + +Flowchart for Macro GET\_PASSWORD\_GLR. The process starts with an oval connector, followed by MAP\_GET\_PASSWORD\_ind (VLR to GLR), MAP\_GET\_PASSWORD\_req (GLR to VLR), and MAP\_DELIMITER\_req (GLR to VLR). A 'Wait\_for\_password' state follows. A loop then begins: MAP\_GET\_PASSWORD\_cnf (VLR to GLR) leads to MAP\_GET\_PASSWORD\_rsp (GLR to VLR), which leads to MAP\_DELIMITER\_req (GLR to VLR), ending at an 'OK' connector. From the loop entry point, two other paths exist: one leading to a box with MAP\_U\_ABORT\_ind and MAP\_P\_ABORT\_ind, which then leads to a 'NULL' connector; the other leading to MAP\_NOTICE\_ind (VLR to GLR), then MAP\_CLOSE\_req (GLR to VLR), then MAP\_U\_ABORT\_req (GLR to VLR), ending at a 'NULL' connector. From the 'NULL' connector, a path leads to a box with MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, and MAP\_CLOSE\_ind, which then leads to MAP\_NOTICE\_ind (VLR to GLR), then MAP\_CLOSE\_req (GLR to VLR), then MAP\_U\_ABORT\_req (GLR to VLR), ending at another 'NULL' connector. + +Figure 22.10/1: Macro Get\_PW\_GLR + +## 22.11 Activation of a CCBS request + +### 22.11.1 General + +The Activation of a CCBS request procedure in the GLR is a fully transparent communication between the VLR and the HLR. + +### 22.11.2 Procedure in the GLR + +When receiving the MAP\_REGISTER\_CC\_ENTRY indication from VLR, the MAP user in the GLR transfers the information to the HLR in the MAP\_REGISTER\_CC\_ENTRY request without checking the contents of the service indication. + +When the GLR receives a MAP\_REGISTER\_CC\_ENTRY confirmation from the HLR then it shall pass this to the VLR and closes the MAP provider service. + +The activation of a CCBS request procedure in the GLR is shown in figure 22.11/1. + +![Sequence diagram for Process Register_CC_Entry_GLR](ef45b00396c293be0b18d32b97118bf4_img.jpg) + +### Process Register\_CC\_Entry\_GLR + +22.11.1\_1(2) + +Figure 22.11/1: Handling of Register\_CC\_Entry at GLR + +Signals to/from the left are to/from the VLR +signals to/from the right are to/from the HLR +unless otherwise stated + +``` +sequenceDiagram + participant Start(( )) + participant NULL[NULL] + participant MAP_REGISTER_CC_ENTRY_ind{MAP REGISTER_CC_ENTRY_ind} + participant MAP_OPEN_req{MAP OPEN_req} + participant HLR[HLR] + participant MAP_REGISTER_CC_ENTRY_req{MAP REGISTER_CC_ENTRY_req} + participant MAP_DELIMITER_req{MAP DELIMITER_req} + participant Receive_Open_Confirm[Receive_Open_Confirm] + participant Wait_for_cnf{Wait_for_cnf} + participant MAP_U_ABORT_req{MAP U_ABORT_req} + participant End(( )) + Note right of HLR: To HLR, Including +- Destination reference = subscriber's IMSI +- Originating reference = GLR number + Note right of Receive_Open_Confirm: Section 25.1 + Note right of Wait_for_cnf: 1 + + Start->>NULL: + NULL->>MAP_REGISTER_CC_ENTRY_ind: + MAP_REGISTER_CC_ENTRY_ind->>MAP_OPEN_req: + MAP_OPEN_req->>HLR: + HLR-->>MAP_REGISTER_CC_ENTRY_req: + MAP_REGISTER_CC_ENTRY_req->>MAP_DELIMITER_req: + MAP_DELIMITER_req->>Receive_Open_Confirm: + Receive_Open_Confirm-->>Wait_for_cnf: OK + Note right of Wait_for_cnf: 1 + Note right of Wait_for_cnf: Vr, Error + Wait_for_cnf->>MAP_U_ABORT_req: + MAP_U_ABORT_req->>End: +``` + +The sequence diagram illustrates the interaction for processing a Register\_CC\_Entry at the GLR. It begins with an initial node leading to a NULL state. The process then enters a loop waiting for a MAP\_REGISTER\_CC\_ENTRY\_ind signal. Upon receiving it, a MAP\_OPEN\_req is sent to the HLR, which includes the destination reference (subscriber's IMSI) and the originating reference (GLR number). The HLR responds with a MAP\_REGISTER\_CC\_ENTRY\_req, which is followed by a MAP\_DELIMITER\_req. The GLR then receives a confirmation (Receive\_Open\_Confirm) from the HLR. If the response is 'OK', the process moves to a 'Wait\_for\_cnf' state. If the response is 'Vr, Error', the process moves to a 'MAP\_U\_ABORT\_req' state. A callout 'Section 25.1' is associated with the 'Receive\_Open\_Confirm' step. A callout '1' is associated with the 'Wait\_for\_cnf' state. A callout box on the right indicates that signals to/from the left are to/from the VLR, and signals to/from the right are to/from the HLR, unless otherwise stated. A list of possible signals (MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_CLOSE\_ind) is shown on the right side of the diagram. + +Sequence diagram for Process Register\_CC\_Entry\_GLR + +Figure 22.11/1 (sheet 1 of 2): Process Register\_CC\_Entry\_GLR + +![Sequence diagram for Process Register_CC_Entry_GLR. The process starts with 'Wait_for_cnf' and sends 'MAP_REGISTER_CC_ENTRY_cnf' to the VLR. The VLR responds with 'MAP_P_ERROR' (yes leads to connector 1, no leads to 'MAP_REGISTER_CC_ENTRY_rsp'). The GLR then sends 'MAP_CLOSE_req' to the VLR. Simultaneously, the HLR sends 'MAP_U_ABORT_ind' and 'MAP_P_ABORT_ind' to the GLR. The GLR then sends 'MAP_NOTICE_ind' and 'MAP_CLOSE_req' to the VLR. Finally, the HLR sends 'MAP_U_ABORT_ind', 'MAP_P_ABORT_ind', and 'MAP_CLOSE_ind' to the GLR, which then sends 'MAP_NOTICE_ind', 'MAP_CLOSE_req', and 'MAP_U_ABORT_req' to the VLR. The process ends with an 'X' mark.](9cd6ff4a43174e4afe1cc5e4ea2fcae4_img.jpg) + +**Process Register\_CC\_Entry\_GLR** 22.11.1\_2(2) + +Figure 22.11/1: Handling of Register\_CC\_Entry at GLR + +Signals to/from the left are to/from the VLR +signals to/from the right are to/from the HLR +unless otherwise stated + +``` + +sequenceDiagram + participant VLR + participant GLR + Note left of GLR: Wait_for_cnf + GLR->>VLR: MAP_REGISTER_CC_ENTRY_cnf + VLR-->>GLR: MAP_P_ERROR + alt yes: Connector 1 + alt no: + GLR->>VLR: MAP_REGISTER_CC_ENTRY_rsp + GLR->>VLR: MAP_CLOSE_req + Note right of GLR: HLR signals + HLR->>GLR: MAP_U_ABORT_ind + HLR->>GLR: MAP_P_ABORT_ind + GLR->>VLR: MAP_NOTICE_ind + GLR->>VLR: MAP_CLOSE_req + Note right of GLR: HLR signals + HLR->>GLR: MAP_U_ABORT_ind + HLR->>GLR: MAP_P_ABORT_ind + HLR->>GLR: MAP_CLOSE_ind + GLR->>VLR: MAP_NOTICE_ind + GLR->>VLR: MAP_CLOSE_req + GLR->>VLR: MAP_U_ABORT_req + Note right of GLR: End + +``` + +Sequence diagram for Process Register\_CC\_Entry\_GLR. The process starts with 'Wait\_for\_cnf' and sends 'MAP\_REGISTER\_CC\_ENTRY\_cnf' to the VLR. The VLR responds with 'MAP\_P\_ERROR' (yes leads to connector 1, no leads to 'MAP\_REGISTER\_CC\_ENTRY\_rsp'). The GLR then sends 'MAP\_CLOSE\_req' to the VLR. Simultaneously, the HLR sends 'MAP\_U\_ABORT\_ind' and 'MAP\_P\_ABORT\_ind' to the GLR. The GLR then sends 'MAP\_NOTICE\_ind' and 'MAP\_CLOSE\_req' to the VLR. Finally, the HLR sends 'MAP\_U\_ABORT\_ind', 'MAP\_P\_ABORT\_ind', and 'MAP\_CLOSE\_ind' to the GLR, which then sends 'MAP\_NOTICE\_ind', 'MAP\_CLOSE\_req', and 'MAP\_U\_ABORT\_req' to the VLR. The process ends with an 'X' mark. + +Figure 22.11/1 (sheet 2 of 2): Process Register\_CC\_Entry\_GLR + +## 22.12 Deactivation of a CCBS request + +### 22.12.1 General + +The Deactivation of a CCBS request procedure in the GLR is a fully transparent communication between the VLR and the HLR. + +### 22.12.2 Procedure in the GLR + +When receiving the MAP\_ERASE\_CC\_ENTRY indication from VLR, the MAP user in the GLR transfers the information to the HLR in the MAP\_ERASE\_CC\_ENTRY request without checking the contents of the service indication. + +When the GLR receives a MAP\_ERASE\_CC\_ENTRY confirmation from the HLR then it shall pass this to the VLR and closes the MAP provider service. + +The deactivation of a CCBS request procedure in the GLR is shown in figure 22.12/1. + +![Sequence diagram for Process Erase_CC_Entry_GLR. The process starts with NULL, followed by MAP_ERASE_CC_ENTRY_ind. It then sends MAP_OPEN_req (with Destination reference = subscriber's IMSI and Originating reference = GLR number), MAP_ERASE_CC_ENTRY_req, and MAP_DELIMITER_req. It receives a Confirm (Section 25.1). From the Confirm, an OK path leads to Wait_for_cnf, and a Vr, Error path leads to MAP_U_ABORT_req (marked with an X). The MAP_ERASE_CC_ENTRY_ind also leads to MAP_NOTICE_ind, which leads to MAP_CLOSE_req (marked with an X). A box on the right lists MAP_U_ABORT_ind, MAP_P_ABORT_ind, and MAP_CLOSE_ind. A connector '1' is shown near the error path.](da85343976fdbb19f866d9ddbdad0eae_img.jpg) + +### Process Erase\_CC\_Entry\_GLR + +22.12.1\_1(2) + +Figure 22.12/1: Handling of Erase\_CC\_Entry at GLR + +Signals to/from the left are to/from the VLR +signals to/from the right are to/from the HLR +unless otherwise stated + +``` +sequenceDiagram + participant NULL + participant GLR + participant VLR + participant HLR + + Note right of HLR: Signals to/from the left are to/from the VLR +signals to/from the right are to/from the HLR +unless otherwise stated + + NULL-->>GLR: NULL + GLR->>VLR: MAP_ERASE_CC_ENTRY_ind + GLR->>HLR: MAP_OPEN_req + Note right of HLR: Including +- Destination reference = subscriber's IMSI +- Originating reference = GLR number + GLR->>VLR: MAP_ERASE_CC_ENTRY_req + GLR->>VLR: MAP_DELIMITER_req + GLR->>GLR: Receive_Open_Confirm + Note right of GLR: Section 25.1 + GLR-->>VLR: OK + GLR-->>GLR: Wait_for_cnf + GLR-->>VLR: Vr, Error + Note right of VLR: 1 + GLR->>HLR: MAP_NOTICE_ind + GLR->>GLR: MAP_CLOSE_req + Note right of GLR: X + Note right of HLR: MAP_U_ABORT_ind +MAP_P_ABORT_ind +MAP_CLOSE_ind +``` + +Sequence diagram for Process Erase\_CC\_Entry\_GLR. The process starts with NULL, followed by MAP\_ERASE\_CC\_ENTRY\_ind. It then sends MAP\_OPEN\_req (with Destination reference = subscriber's IMSI and Originating reference = GLR number), MAP\_ERASE\_CC\_ENTRY\_req, and MAP\_DELIMITER\_req. It receives a Confirm (Section 25.1). From the Confirm, an OK path leads to Wait\_for\_cnf, and a Vr, Error path leads to MAP\_U\_ABORT\_req (marked with an X). The MAP\_ERASE\_CC\_ENTRY\_ind also leads to MAP\_NOTICE\_ind, which leads to MAP\_CLOSE\_req (marked with an X). A box on the right lists MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, and MAP\_CLOSE\_ind. A connector '1' is shown near the error path. + +Figure 22.12/1 (sheet 1 of 2): Process Erase\_CC\_Entry\_GLR + +![SDL Diagram for Process Erase_CC_Entry_GLR](c21bad844b5cb6026c067a1f43ce67c3_img.jpg) + +Process Erase\_CC\_Entry\_GLR + +22.12.1\_2(2) + +Figure 22.12/1: Handling of Erase\_CC\_Entry at GLR + +Signals to/from the left +are to/from the VLR +signals to/from the right +are to/from the HLR +unless otherwise stated + +``` + +graph TD + Start([Wait_for_cnf]) --> Input1[MAP_REGISTER_CC_ENTRY_cnf] + Input1 --> Decision1{MAP_P_ERROR} + Decision1 -- yes --> Connector1((1)) + Decision1 -- no --> Output1[MAP_REGISTER_CC_ENTRY_rsp] + Output1 --> Output2[MAP_CLOSE_req] + Output2 --> End1[X] + + Start --> Input2[MAP_U_ABORT_ind +MAP_P_ABORT_ind] + Input2 --> Output3[MAP_CLOSE_req] + Output3 --> Output4[MAP_U_ABORT_req] + Output4 --> End2[X] + + Start --> Input3[MAP_NOTICE_ind] + Input3 --> Output3 + + Start --> Input4[MAP_NOTICE_ind] + Input4 --> Output5[MAP_CLOSE_req] + Output5 --> Output6[MAP_U_ABORT_req] + Output6 --> End3[X] + + Start --> Input5[MAP_U_ABORT_ind +MAP_P_ABORT_ind +MAP_CLOSE_ind] + Input5 --> End3 + +``` + +SDL Diagram for Process Erase\_CC\_Entry\_GLR + +Figure 22.12/1 (sheet 2 of 2): Process Erase\_CC\_Entry\_GLR + +# 23 Short message service procedures + +## 23.1 General + +The short message service procedures are used to control both mobile originated and mobile terminated short message transfer. + +Four procedures exist for short message services (see 29.002) but only the following two procedures are involved in the GLR and the IM-MSC: + +- mobile terminated short message service transfer; +- short message alert procedure. + +## 23.2 The mobile terminated short message transfer procedure + +The mobile terminated short message transfer procedure is used for forwarding a short message or several short messages from a Service Centre to a mobile subscriber. This subclause includes the description of the procedures in the IM-MSC and the GLR. The procedures in the other existing entities are entirely the same as in the network without the GLR and are described in 29.002. + +### 23.2.1 Procedure in the Intermediate MSC + +When initiating the dialogue with the IM-MSC, the SMS Gateway MSC must provide the IMSI of the subscriber to whom the short message is directed. + +The IMSI can be included either in the Destination Reference of the MAP\_OPEN indication received from the SMS Gateway MSC or in the sm-RP-DA information field of the MAP\_MT\_FORWARD\_SHORT\_MESSAGE indication. + +When receiving a MAP\_OPEN indication primitive that is not associated with any MAP service indication primitive and if the dialogue is accepted, the MAP service-user in the IM-MSC issues a MAP\_DELIMITER request primitive in order to trigger the local MAP service-provider to confirm the dialogue. + +When receiving the first MAP\_MT\_FORWARD\_SHORT\_MESSAGE indication from the gateway MSC, the IM-MSC retrieves the E.164 Number of the servicing MSC from the GLR if the MAP service primitive is accepted. + +The MAP\_MT\_FORWARD\_SHORT\_MESSAGE indication primitive is checked by the macro "Check\_Indication". If the received MAP service primitive contains errors, the service is aborted and an unexpected data value error or data missing error is returned to the GMSC. + +The subscriber identity information that may be included in the MAP\_OPEN indication primitive and in the MAP service indication primitive is checked by the macro "Check\_Subscr\_Identity\_For\_MT\_SMS" as follows. + +If a Destination Reference has been received in the MAP\_OPEN indication, an LMSI must be present in the sm-RP-DA information field of the MAP\_MT\_FORWARD\_SHORT\_MESSAGE indication. The LMSI shall be key information for retrieving the MSC Number in the GLR. + +Otherwise, if the IMSI is included in the sm-RP-DA information field of the MAP\_MT\_FORWARD\_SHORT\_MESSAGE indication, it is used to retrieve the MSC Number in the GLR. + +If: + +a Destination Reference has been received in the IM-MSC and the sm-RP-DA information field of the MAP\_MT\_FORWARD\_SHORT\_MESSAGE indication does not include an LMSI, or + +no Destination Reference has been received and the sm-RP-DA information field does not cover an IMSI; + +the service is aborted in the IM-MSC and the error "Unexpected Data Value" is returned to the SMS GMSC. + +The interaction between the IM- MSC and the GLR for the MSC Number retrieval is described in 3GPP TS 23.119 GLR-stage2. + +If the IM- MSC is successfully retrieves the MSC Number it initiates the forward short message procedure to the servicing MSC. The presence of the Destination Reference in the MAP\_OPEN request and the LMSI or IMSI in the first MAP\_MT\_FORWARD\_SHORT\_MESSAGE request follows the message received from the GMSC. The More Messages To Send flag is set to TRUE or FALSE depending on the information received from the GMSC. + +If the grouping of MAP\_OPEN request and MAP\_MT\_FORWARD\_SHORT\_MESSAGE request together would need segmenting, these primitives must not be grouped together. The MAP\_OPEN request primitive is sent first without any associated MAP service request primitive and the dialogue confirmation must be received before the MAP\_MT\_FORWARD\_SHORT\_MESSAGE request is sent. + +As a response to the procedure, the IM- MSC will receive the MAP\_MT\_FORWARD\_SHORT\_MESSAGE confirmation indicating: + +- a successful forwarding of the short message. This indication is passed to the GMSC; +- unsuccessful forwarding of the short message. This indication is passed to the GMSC. + +The IM- MSC informs the delivery failure to the GLR, if an absent subscriber\_SM, an unidentified subscriber or SM delivery failure with error cause MS memory capacity exceeded indication is received from the servicing MSC. That enables the GLR set the MNRF. The interaction between the IM- MSC and the GLR regarding the procedure is described in 3GPP TS 23.119 GLR-stage2. + +Unexpected data value, system failure errors and other errors are simply passed to the GMSC. + +If the More Messages To Send flag was TRUE in the MAP\_MT\_FORWARD\_SHORT\_MESSAGE request and the previous short message transfer succeeded, then the IM- MSC awaits the next short message. + +When receiving the next short message from the GMSC, the IM- MSC sets the More Messages To Send flag according to the information received and starts the service MAP\_MT\_FORWARD\_SHORT\_MESSAGE again. + +If the More Messages To Send flag was FALSE or the service MAP\_MT\_FORWARD\_SHORT\_MESSAGE ends unsuccessfully, the transaction to the gateway MSC is terminated. + +The mobile terminated short message transfer procedure in the IM- MSC is shown in figure 23.2/1 and 23.2/2. + +![Flowchart for Process MT_SM_Transfer_IMMSC. The process starts with an oval, leading to a 'NULL' state, then 'Receive_Open_ind' (linked to Section 25.1). A decision 'Dest_Ref_received' follows: 'OK' leads to 'Store_Destination_Reference' then 'WAIT_FOR_SERVICE_PRIMITIVE'; 'no' leads to 'NULL'; 'Error' leads to 'NULL'. From 'WAIT_FOR_SERVICE_PRIMITIVE', four paths emerge: 1) 'MAP_DELIMITER_ind' -> 'MAP_DELIMITER_req' -> 'WAIT_FOR_SERVICE_PRIMITIVE'; 2) 'MAP_MT_FORWARD_SHORT_MESSAGE_ind' -> 'Check_Indication' (linked to Section 25.2) -> 'MT_SM_IM-MSC' (linked to Figure 23.2/2) -> 'More_msg_to_sent' decision; 3) A group of 'MAP_U_ABORT_ind', 'MAP_P_ABORT_ind', and 'MAP_CLOSE_ind' -> 'NULL'; 4) 'MAP_NOTICE_ind' -> 'MAP_CLOSE_ind' -> 'NULL'. From 'More_msg_to_sent': 'yes' leads to an unlabeled box -> 'MAP_MT_FORWARD_SHORT_MESSAGE_rsp' / 'MAP_DELIMITER_req' -> 'WAIT_FOR_MORE_MESSAGES'; 'no' leads to an unlabeled box -> 'MAP_MT_FORWARD_SHORT_MESSAGE_rsp' / 'MAP_CLOSE_req' -> 'NULL'. 'error' paths from 'MT_SM_IM-MSC' and 'More_msg_to_sent' lead to the unlabeled box before the final 'NULL' state.](3ec35c497a0765a1a885c85f214b1bef_img.jpg) + +### Process MT\_SM\_Transfer\_IMMSC + +23.2.1\_1(3) + +Figure 23.2/1: The mobile terminated short message service in the IM-MSC + +Signals to/from the left are to/from the SMS-GMSC; signals to/from the right are to/from the MSC + +``` +graph TD; Start([ ]) --> NULL1(NULL); NULL1 --> Receive_Open_ind[Receive_Open_ind]; Receive_Open_ind --- Section_25_1[Section 25.1]; Receive_Open_ind -- OK --> Dest_Ref_received{Dest_Ref_received}; Dest_Ref_received -- no --> NULL2(NULL); Dest_Ref_received -- yes --> Store_Destination_Reference[Store_Destination_Reference]; Store_Destination_Reference --> WAIT_FOR_SERVICE_PRIMITIVE1(WAIT_FOR_SERVICE_PRIMITIVE); Dest_Ref_received -- Error --> NULL3(NULL); WAIT_FOR_SERVICE_PRIMITIVE1 --> MAP_DELIMITER_ind1[MAP_DELIMITER_ind]; WAIT_FOR_SERVICE_PRIMITIVE1 --> MAP_MT_FORWARD_SHORT_MESSAGE_ind[MAP_MT_FORWARD_SHORT_MESSAGE_ind]; WAIT_FOR_SERVICE_PRIMITIVE1 --> MAP_U_ABORT_ind[MAP_U_ABORT_ind]; WAIT_FOR_SERVICE_PRIMITIVE1 --> MAP_P_ABORT_ind[MAP_P_ABORT_ind]; WAIT_FOR_SERVICE_PRIMITIVE1 --> MAP_CLOSE_ind[MAP_CLOSE_ind]; WAIT_FOR_SERVICE_PRIMITIVE1 --> MAP_NOTICE_ind[MAP_NOTICE_ind]; MAP_DELIMITER_ind1 --> MAP_DELIMITER_req[MAP_DELIMITER_req]; MAP_DELIMITER_req --> WAIT_FOR_SERVICE_PRIMITIVE2(WAIT_FOR_SERVICE_PRIMITIVE); MAP_MT_FORWARD_SHORT_MESSAGE_ind --> Check_Indication[Check_Indication]; Check_Indication --- Section_25_2[Section 25.2]; Check_Indication -- ok --> MT_SM_IM-MSC[MT_SM_IM-MSC]; MT_SM_IM-MSC --- Figure_23_2_2[Figure 23.2/2]; MT_SM_IM-MSC -- error --> UnlabeledBox1[ ]; MT_SM_IM-MSC -- ok --> More_msg_to_sent{More_msg_to_sent}; More_msg_to_sent -- yes --> UnlabeledBox2[ ]; More_msg_to_sent -- no --> UnlabeledBox3[ ]; More_msg_to_sent -- error --> UnlabeledBox1; UnlabeledBox2 --> MAP_MT_FORWARD_SHORT_MESSAGE_rsp1[MAP_MT_FORWARD_SHORT_MESSAGE_rsp]; UnlabeledBox2 --> MAP_DELIMITER_req2[MAP_DELIMITER_req]; MAP_DELIMITER_req2 --> WAIT_FOR_MORE_MESSAGES(WAIT_FOR_MORE_MESSAGES); UnlabeledBox3 --> MAP_MT_FORWARD_SHORT_MESSAGE_rsp2[MAP_MT_FORWARD_SHORT_MESSAGE_rsp]; UnlabeledBox3 --> MAP_CLOSE_req[MAP_CLOSE_req]; MAP_CLOSE_req --> NULL4(NULL); MAP_U_ABORT_ind --> NULL5(NULL); MAP_P_ABORT_ind --> NULL5; MAP_CLOSE_ind --> NULL5; MAP_NOTICE_ind --> MAP_CLOSE_ind2[MAP_CLOSE_ind]; MAP_CLOSE_ind2 --> NULL6(NULL); +``` + +Flowchart for Process MT\_SM\_Transfer\_IMMSC. The process starts with an oval, leading to a 'NULL' state, then 'Receive\_Open\_ind' (linked to Section 25.1). A decision 'Dest\_Ref\_received' follows: 'OK' leads to 'Store\_Destination\_Reference' then 'WAIT\_FOR\_SERVICE\_PRIMITIVE'; 'no' leads to 'NULL'; 'Error' leads to 'NULL'. From 'WAIT\_FOR\_SERVICE\_PRIMITIVE', four paths emerge: 1) 'MAP\_DELIMITER\_ind' -> 'MAP\_DELIMITER\_req' -> 'WAIT\_FOR\_SERVICE\_PRIMITIVE'; 2) 'MAP\_MT\_FORWARD\_SHORT\_MESSAGE\_ind' -> 'Check\_Indication' (linked to Section 25.2) -> 'MT\_SM\_IM-MSC' (linked to Figure 23.2/2) -> 'More\_msg\_to\_sent' decision; 3) A group of 'MAP\_U\_ABORT\_ind', 'MAP\_P\_ABORT\_ind', and 'MAP\_CLOSE\_ind' -> 'NULL'; 4) 'MAP\_NOTICE\_ind' -> 'MAP\_CLOSE\_ind' -> 'NULL'. From 'More\_msg\_to\_sent': 'yes' leads to an unlabeled box -> 'MAP\_MT\_FORWARD\_SHORT\_MESSAGE\_rsp' / 'MAP\_DELIMITER\_req' -> 'WAIT\_FOR\_MORE\_MESSAGES'; 'no' leads to an unlabeled box -> 'MAP\_MT\_FORWARD\_SHORT\_MESSAGE\_rsp' / 'MAP\_CLOSE\_req' -> 'NULL'. 'error' paths from 'MT\_SM\_IM-MSC' and 'More\_msg\_to\_sent' lead to the unlabeled box before the final 'NULL' state. + +Figure 23.2/1 (sheet1 of 3): Procedure\_MT\_SM\_Transfer\_IM-MSC + +![Flowchart for Process MT_SM_Transfer_IMMSC. The process starts with 'WAIT_FOR_MORE_MESSAGES', followed by 'MAP_MT_FORWARD_SHORT_MESSAGE_ind'. It then checks the indication (Section 25.2). If 'ok', it sends 'MAP_MT_FORWARD_SHORT_MESSAGE_req' and 'MAP_DELIMITER_req', then waits for 'MT_SMS_CONFIRM'. Upon receiving 'MAP_MT_FORWARD_SHORT_MESSAGE_cnf', it checks the confirmation (Section 25.2). From the confirmation check, if 'ok', it checks 'More msg to_sent'. If 'yes', it loops back to 'WAIT_FOR_MORE_MESSAGES'. If 'no', it sends 'MAP_MT_FORWARD_SHORT_MESSAGE_rsp' and 'MAP_DELIMITER_req'. If 'Data error' or 'User error' (specifically 'Absent Subscriber?'), it sends 'Inform SM Delivery Failure' to the GLR Application Process in TS23.119. Finally, it sends 'MAP_MT_FORWARD_SHORT_MESSAGE_rsp' and 'MAP_CLOSE_req' to reach a 'NULL' state.](24ee23a8f3995ecfd3aae31a37a1d40c_img.jpg) + +### Process MT\_SM\_Transfer\_IMMSC + +23.2.1\_2(3) + +Figure 23.2/1: The mobile terminated short message service in the IM-MSC + +``` +graph TD; Start([WAIT_FOR_MORE_MESSAGES]) --> Ind{MAP_MT_FORWARD_SHORT_MESSAGE_ind}; Ind --> CheckInd[Check Indication]; CheckInd -- Section 25.2; CheckInd -- ok --> Req[MAP_MT_FORWARD_SHORT_MESSAGE_req
MAP_DELIMITER_req]; Req --> WaitConfirm([WAIT_FOR_MT_SMS_CONFIRM]); WaitConfirm --> Cnf{MAP_MT_FORWARD_SHORT_MESSAGE_cnf}; Cnf --> CheckCnf[Check Confirmation]; CheckCnf -- Section 25.2; CheckCnf -- ok --> MoreMsg{More msg to_sent}; MoreMsg -- yes --> Start; MoreMsg -- no --> Rsp1[MAP_MT_FORWARD_SHORT_MESSAGE_rsp
MAP_DELIMITER_req]; CheckCnf -- Data error --> Failure{Inform SM Delivery Failure}; CheckCnf -- User error --> Absent{Absent Subscriber?}; Absent -- yes --> Failure; Failure -- to GLR Application Process in TS23.119; Failure --> Rsp2[MAP_MT_FORWARD_SHORT_MESSAGE_rsp
MAP_CLOSE_req]; Rsp1 --> End([NULL]); Rsp2 --> End; +``` + +Flowchart for Process MT\_SM\_Transfer\_IMMSC. The process starts with 'WAIT\_FOR\_MORE\_MESSAGES', followed by 'MAP\_MT\_FORWARD\_SHORT\_MESSAGE\_ind'. It then checks the indication (Section 25.2). If 'ok', it sends 'MAP\_MT\_FORWARD\_SHORT\_MESSAGE\_req' and 'MAP\_DELIMITER\_req', then waits for 'MT\_SMS\_CONFIRM'. Upon receiving 'MAP\_MT\_FORWARD\_SHORT\_MESSAGE\_cnf', it checks the confirmation (Section 25.2). From the confirmation check, if 'ok', it checks 'More msg to\_sent'. If 'yes', it loops back to 'WAIT\_FOR\_MORE\_MESSAGES'. If 'no', it sends 'MAP\_MT\_FORWARD\_SHORT\_MESSAGE\_rsp' and 'MAP\_DELIMITER\_req'. If 'Data error' or 'User error' (specifically 'Absent Subscriber?'), it sends 'Inform SM Delivery Failure' to the GLR Application Process in TS23.119. Finally, it sends 'MAP\_MT\_FORWARD\_SHORT\_MESSAGE\_rsp' and 'MAP\_CLOSE\_req' to reach a 'NULL' state. + +Figure 23.2/1 (sheet 2 of 3): Procedure MT\_SM\_Transfer\_IM-MSC + +#### Process MT\_SM\_Transfer\_IMMSC + +23.2.1\_3(3) + +Figure 23.2/1: The mobile terminated short message service in the IM-MSC + +![Sequence diagram for Process MT_SM_Transfer_IMMSC showing interactions between IM-MSC, SMS-GMSC, and VMSC.](85680f3dcbe15424dd54fa3fd9e1c90d_img.jpg) + +The sequence diagram illustrates the 'Process MT\_SM\_Transfer\_IMMSC' procedure. It begins with an initial state (oval) leading to a wait state containing 'WAIT\_FOR\_MORE\_MESSAGES' and 'WAIT\_FOR\_MT\_SMS\_CONFIRM'. The process then enters a loop. First, it checks for incoming messages from the SMS-GMSC. If 'MAP\_U\_ABORT\_ind' or 'MAP\_P\_ABORT\_ind' is received, it sends a 'MAP\_U\_ABORT\_req' to the VMSC and ends (cross). If 'MAP\_NOTICE\_ind' is received from the SMS-GMSC, it sends a 'MAP\_CLOSE\_req' to the SMS-GMSC. The diagram then shows a transition to interactions with the VMSC. It receives 'MAP\_NOTICE\_ind' from the VMSC and sends a 'MAP\_CLOSE\_req' to the VMSC. Simultaneously, it receives 'MAP\_U\_ABORT\_ind', 'MAP\_P\_ABORT\_ind', and 'fMAP\_CLOSE\_ind' from the VMSC. Finally, it sends a 'MAP\_U\_ABORT\_req' to the SMS-GMSC and ends (cross). + +``` +sequenceDiagram + participant IM-MSC + participant SMS-GMSC + participant VMSC + + Note right of IM-MSC: WAIT_FOR_MORE_MESSAGES +WAIT_FOR_MT_SMS_CONFIRM + Note left of IM-MSC: MAP_U_ABORT_ind +MAP_P_ABORT_ind +from SMS-GMSC + Note right of IM-MSC: MAP_NOTICE_ind +from SMS-GMSC + Note right of IM-MSC: MAP_CLOSE_req +to SMS-GMSC + Note right of IM-MSC: MAP_U_ABORT_req +to VMSC + Note left of IM-MSC: MAP_NOTICE_ind +from VMSC + Note right of IM-MSC: MAP_CLOSE_req +to VMSC + Note right of IM-MSC: MAP_U_ABORT_ind +MAP_P_ABORT_ind +fMAP_CLOSE_ind +from VMSC + Note right of IM-MSC: MAP_U_ABORT_req +to SMS-GMSC +``` + +Sequence diagram for Process MT\_SM\_Transfer\_IMMSC showing interactions between IM-MSC, SMS-GMSC, and VMSC. + +Figure 23.2/1 (sheet 3 of 3): Procedure MT\_SM\_Transfer\_IM-MSC + +![Flowchart for Macro MT_SM_IMMSC. The process starts with a connector, followed by 'Obtain MSC Number' (to GLR Application Process in TS23.119), 'WAIT_FOR_RESPONSE', and 'RESPONSE' (from GLR Application Process in TS23.119). A decision 'MSC Number Obtained?' follows. If 'no', it goes to 'User Error = Unidentified User' and then 'ERR OR'. If 'yes', it goes to 'Message segmenting needed?'. If 'no', it goes to a merge point and then 'MAP_OPEN_req', 'MAP_MT_FORWARD_SHORT_MESSAGE_req', 'MAP_DELIMITER_req', 'Receive_Open_Cnf', and 'WAIT_FOR_MT_SMS_CONFIRM'. If 'yes', it goes to 'MAP_OPEN_req', 'MAP_DELIMITER_req', 'Receive_Open_Cnf', a merge point, 'MAP_MT_FORWARD_SHORT_MESSAGE_req', 'MAP_DELIMITER_req', 'WAIT_FOR_MT_SMS_CONFIRM'. Both 'WAIT_FOR_MT_SMS_CONFIRM' paths lead to a merge point, then 'MAP_MT_FORWARD_SHORT_MESSAGE_Cnf', and finally '1 page2'.](684f7a2cd4ba3346bcaec1f7336f6aa3_img.jpg) + +### Macrodefinition MT\_SM\_IMMSC + +23.2.2\_1(2) + +Figure 23.2/2: Macro which transfer short message PDUs to VMSC in the IM-MSC + +Signals to/from the right are to/from the MSC + +``` +graph TD; Start([ ]) --> Obtain[Obtain MSC Number]; Obtain --> GLR[to GLR Application Process in TS23.119]; Obtain --> Wait[WAIT_FOR_RESPONSE]; Wait --> Response[RESPONSE]; Response --> GLR_R[from GLR Application Process in TS23.119]; Response --> Obtained{MSC Number Obtained?}; Obtained -- no --> UserError[User Error = Unidentified User]; UserError --> ERR1((ERR OR)); Obtained -- yes --> Segmenting{Message segmenting needed?}; Segmenting -- no --> Merge1(( )); Merge1 --> OpenReq1[MAP_OPEN_req +MAP_MT_FORWARD_SHORT_MESSAGE_req +MAP_DELIMITER_req]; OpenReq1 --> OpenCnf1[Receive_Open_Cnf]; OpenCnf1 -- ok --> WaitConfirm1[WAIT_FOR_MT_SMS_CONFIRM]; OpenCnf1 -- error --> SystemFailure[Error = System Failure]; SystemFailure --> ERR2((ERR OR)); Segmenting -- yes --> OpenReq2[MAP_OPEN_req +MAP_DELIMITER_req]; OpenReq2 --> OpenCnf2[Receive_Open_Cnf]; OpenCnf2 -- ok --> Merge2(( )); OpenCnf2 -- error --> SystemFailure; Merge2 --> OpenReq3[MAP_MT_FORWARD_SHORT_MESSAGE_req +MAP_DELIMITER_req]; OpenReq3 --> WaitConfirm2[WAIT_FOR_MT_SMS_CONFIRM]; WaitConfirm1 --> Merge3(( )); WaitConfirm2 --> Merge3; Merge3 --> Cnf[MAP_MT_FORWARD_SHORT_MESSAGE_Cnf]; Cnf --> Page2((1 page2)); +``` + +Flowchart for Macro MT\_SM\_IMMSC. The process starts with a connector, followed by 'Obtain MSC Number' (to GLR Application Process in TS23.119), 'WAIT\_FOR\_RESPONSE', and 'RESPONSE' (from GLR Application Process in TS23.119). A decision 'MSC Number Obtained?' follows. If 'no', it goes to 'User Error = Unidentified User' and then 'ERR OR'. If 'yes', it goes to 'Message segmenting needed?'. If 'no', it goes to a merge point and then 'MAP\_OPEN\_req', 'MAP\_MT\_FORWARD\_SHORT\_MESSAGE\_req', 'MAP\_DELIMITER\_req', 'Receive\_Open\_Cnf', and 'WAIT\_FOR\_MT\_SMS\_CONFIRM'. If 'yes', it goes to 'MAP\_OPEN\_req', 'MAP\_DELIMITER\_req', 'Receive\_Open\_Cnf', a merge point, 'MAP\_MT\_FORWARD\_SHORT\_MESSAGE\_req', 'MAP\_DELIMITER\_req', 'WAIT\_FOR\_MT\_SMS\_CONFIRM'. Both 'WAIT\_FOR\_MT\_SMS\_CONFIRM' paths lead to a merge point, then 'MAP\_MT\_FORWARD\_SHORT\_MESSAGE\_Cnf', and finally '1 page2'. + +Figure 23.2/2 (sheet1 of 2): Macro MT\_SM\_IM-MSC + +![Flowchart for Macro MT_SM_IMMSC. It starts at connector '1 page1', goes to 'Check Confirmation' (linked to Section 25.2). From there, three paths emerge: 'ok' leads to 'OK' connector; 'User Error' leads to 'Absent Subscriber?' decision; 'Provider Error Data Error' leads to 'ERR OR' connector. From 'Absent Subscriber?', 'yes' leads to 'Inform SM Delivery Failure' (linked to 'to GLR Application Process in TS 23.119'), which then leads to 'ERR OR'; 'no' leads directly to 'ERR OR'.](921f8fa0f7ce2c9956f20d33162c13a2_img.jpg) + +**Macrodefinition MT\_SM\_IMMSC** **23.2.2\_2(2)** + +Figure 23.2/2: Macro which transfer short message PDUs to VMSC in the IM-MSC + +``` +graph TD; Start((1 page1)) --> Check[Check Confirmation]; Check --- Section[Section 25.2]; Check -- ok --> OK((OK)); Check -- User Error --> Absent{Absent Subscriber?}; Check -- "Provider Error Data Error" --> ERR[ERR OR]; Absent -- yes --> Inform[Inform SM Delivery Failure]; Inform --- GLR[to GLR Application Process in TS 23.119]; Inform --> ERR; Absent -- no --> ERR; +``` + +Flowchart for Macro MT\_SM\_IMMSC. It starts at connector '1 page1', goes to 'Check Confirmation' (linked to Section 25.2). From there, three paths emerge: 'ok' leads to 'OK' connector; 'User Error' leads to 'Absent Subscriber?' decision; 'Provider Error Data Error' leads to 'ERR OR' connector. From 'Absent Subscriber?', 'yes' leads to 'Inform SM Delivery Failure' (linked to 'to GLR Application Process in TS 23.119'), which then leads to 'ERR OR'; 'no' leads directly to 'ERR OR'. + +**Figure 23.2/2 (sheet2 of 2): Macro MT\_SM\_IM-MSC** + +### 23.2.2 Procedure in the GLR + +When initiating the dialogue with the GLR, the SMS Gateway MSC must provide the IMSI of the subscriber to whom the short message is directed. + +The IMSI is included in the sm-RP-DA information field of the MAP\_MT\_FORWARD\_SHORT\_MESSAGE indication. + +When receiving a MAP\_OPEN indication primitive that is not associated with any MAP service indication primitive and if the dialogue is accepted, the MAP service-user in the GLR issues a MAP\_DELIMITER request primitive in order to trigger the local MAP service-provider to confirm the dialogue. + +When receiving the first MAP\_MT\_FORWARD\_SHORT\_MESSAGE indication from the gateway MSC, the GLR performs some subscriber data checks, if the MAP service primitive is accepted. + +The MAP\_MT\_FORWARD\_SHORT\_MESSAGE indication primitive is checked by the macro "Check\_Indication". If the received MAP service primitive contains errors, the service is aborted and an unexpected data value error or data missing error is returned to the GMSC. + +The subscriber identity information that is included in the MAP service indication primitive is checked by the macro "Check\_Subscr\_Identity\_For\_MT\_SMS" as follows: + +If the IMSI is included in the sm-RP-DA information field of the MAP\_MT\_FORWARD\_SHORT\_MESSAGE indication, the MAP\_OPEN indication received from the gateway MSC shall not include a Destination Reference. + +If no Destination Reference has been received and the sm-RP-DA information field does not cover an IMSI the service is aborted in the GLR and the error "Unexpected Data Value" is returned to the GMSC. + +The following outcomes from the subscriber data checks can occur in GLR: + +- if the mobile subscriber is unknown, the unidentified subscriber error is forwarded to the GMSC; +- if the "Confirmed by HLR" indicator is set to "Not Confirmed", the unidentified subscriber error is forwarded to the GMSC. + +If the mobile subscriber is known and "Confirmed by HLR" indicator is set to "Confirmed", the GLR shall successfully retrieves the SGSN Number. + +If the GLR is successfully retrieves the SGSN Number it initiates the forward short message procedure to the SGSN. The IMSI is included in the sm-RP-DA information field of the MAP\_MT\_FORWARD\_SHORT\_MESSAGE request. More Messages To Send flag is set to TRUE or FALSE depending on the information received from the GMSC. + +If the grouping of MAP\_OPEN request and MAP\_MT\_FORWARD\_SHORT\_MESSAGE request together would need segmenting, these primitives must not be grouped together. The MAP\_OPEN request primitive is sent first without any associated MAP service request primitive and the dialogue confirmation must be received before the MAP\_MT\_FORWARD\_SHORT\_MESSAGE request is sent. + +As a response to the procedure, the GLR will receive the MAP\_MT\_FORWARD\_SHORT\_MESSAGE confirmation indicating: + +- a successful forwarding of the short message. This indication is passed to the GMSC; +- unsuccessful forwarding of the short message. This indication is passed to the GMSC. + +The GLR sets MNRG, if an absent subscriber\_SM (except for the case that absent subscriber reason is PurgedMS), an unidentified subscriber or SM delivery failure with error cause MS memory capacity exceeded indication is received from the SGSN. + +If the GLR receives an absent subscriber\_SM and absent subscriber reason is PurgedMS, the GLR deletes the subscriber data for the user. + +Unexpected data value, system failure errors and other errors are simply passed to the GMSC. + +If the More Messages To Send flag was TRUE in the MAP\_MT\_FORWARD\_SHORT\_MESSAGE request and the previous short message transfer succeeded, then the GLR awaits the next short message. + +When receiving the next short message from the GMSC, the GLR sets the More Messages To Send flag according to the information received and starts the service MAP\_MT\_FORWARD\_SHORT\_MESSAGE again. + +If the More Messages To Send flag was FALSE or the service MAP\_MT\_FORWARD\_SHORT\_MESSAGE ends unsuccessfully, the transaction to the gateway MSC is terminated. + +The mobile terminated short message transfer procedure in the GLR is shown in figure 23.2/3 and 23.2/4. + +![Flowchart for Process MT_SM_Transfer_GLR. The process starts with an oval, leading to a 'NULL' state. It then enters a 'Receive_Open_ind' block (Section 25.1). From here, an 'Error' path leads to another 'NULL' state. An 'OK' path leads to a 'Dest_Ref_received' decision. If 'no', it goes to 'NULL'. If 'yes', it goes to 'Store_Destination_Reference', then 'WAIT_FOR_SERVICE_PRIMITIVE'. From 'WAIT_FOR_SERVICE_PRIMITIVE', four paths emerge: 1) 'MAP_DELIMITER_ind' leads to 'MAP_DELIMITER_req' then 'WAIT_FOR_SERVICE_PRIMITIVE'. 2) 'MAP_MT_FORWARD_SHORT_MESSAGE_ind' leads to 'Check_Indication' (Section 25.2). From 'Check_Indication', an 'ok' path leads to 'MT_SM_GLR' (Figure 23.2/4), and an 'error' path leads to a junction. 3) A junction receives 'MAP_U_ABORT_ind', 'MAP_P_ABORT_ind', and 'MAP_CLOSE_ind'. 4) 'MAP_NOTICE_ind' leads to 'MAP_CLOSE_ind'. From 'MAP_CLOSE_ind', the path leads to 'NULL'. From the junction, an 'error' path leads to 'NULL', and a 'no' path leads to a junction. From this junction, two paths emerge: 1) 'MAP_MT_FORWARD_SHORT_MESSAGE_rsp' and 'MAP_DELIMITER_req' lead to 'WAIT_FOR_MORE_MESSAGES'. 2) 'MAP_MT_FORWARD_SHORT_MESSAGE_rsp' and 'MAP_CLOSE_req' lead to 'NULL'. A 'More_msg_to_sent' decision follows 'MT_SM_GLR'. If 'yes', it leads to a junction. If 'ok', it leads to the junction. If 'no', it leads to the junction. The junction also receives an 'error' path from 'MT_SM_GLR'.](245166735676c675f98f535bc4c6f0a1_img.jpg) + +### Process MT\_SM\_Transfer\_GLR + +23.2.3\_1(3) + +Figure 23.2/3: The mobile terminated short message service in the GLR + +Signals to/from the left are to/from the SMS-GMSC; +signals to/from the right are to/from the SGSN + +Flowchart for Process MT\_SM\_Transfer\_GLR. The process starts with an oval, leading to a 'NULL' state. It then enters a 'Receive\_Open\_ind' block (Section 25.1). From here, an 'Error' path leads to another 'NULL' state. An 'OK' path leads to a 'Dest\_Ref\_received' decision. If 'no', it goes to 'NULL'. If 'yes', it goes to 'Store\_Destination\_Reference', then 'WAIT\_FOR\_SERVICE\_PRIMITIVE'. From 'WAIT\_FOR\_SERVICE\_PRIMITIVE', four paths emerge: 1) 'MAP\_DELIMITER\_ind' leads to 'MAP\_DELIMITER\_req' then 'WAIT\_FOR\_SERVICE\_PRIMITIVE'. 2) 'MAP\_MT\_FORWARD\_SHORT\_MESSAGE\_ind' leads to 'Check\_Indication' (Section 25.2). From 'Check\_Indication', an 'ok' path leads to 'MT\_SM\_GLR' (Figure 23.2/4), and an 'error' path leads to a junction. 3) A junction receives 'MAP\_U\_ABORT\_ind', 'MAP\_P\_ABORT\_ind', and 'MAP\_CLOSE\_ind'. 4) 'MAP\_NOTICE\_ind' leads to 'MAP\_CLOSE\_ind'. From 'MAP\_CLOSE\_ind', the path leads to 'NULL'. From the junction, an 'error' path leads to 'NULL', and a 'no' path leads to a junction. From this junction, two paths emerge: 1) 'MAP\_MT\_FORWARD\_SHORT\_MESSAGE\_rsp' and 'MAP\_DELIMITER\_req' lead to 'WAIT\_FOR\_MORE\_MESSAGES'. 2) 'MAP\_MT\_FORWARD\_SHORT\_MESSAGE\_rsp' and 'MAP\_CLOSE\_req' lead to 'NULL'. A 'More\_msg\_to\_sent' decision follows 'MT\_SM\_GLR'. If 'yes', it leads to a junction. If 'ok', it leads to the junction. If 'no', it leads to the junction. The junction also receives an 'error' path from 'MT\_SM\_GLR'. + +Figure 23.2/3 (sheet 1 of 3): Procedure MT\_SM\_Transfer\_GLR + +![Flowchart for Process MT_SM_Transfer_GLR. It starts with 'WAIT FOR MORE MESSAGES', followed by 'MAP_MT_FORWARD_SHORT_MESSAGE_ind', 'Check Indication' (Section 25.2), 'MAP_MT_FORWARD_SHORT_MESSAGE_req', 'MAP_DELIMITER_req', 'WAIT_FOR_MT_SMS_CONFIRM', 'MAP_MT_FORWARD_SHORT_MESSAGE_cnf', 'Check Confirmation' (Section 25.2). A decision diamond 'Absent Subscriber?' has 'yes' leading to 'set MNRG' then 'Check Absent SubscriberSM In_GLR' (See TS 23.119), and 'no' leading to 'MAP_MT_FORWARD_SHORT_MESSAGE_rsp' and 'MAP_CLOSE_req'. Another decision diamond 'More msg to_sent' has 'yes' leading to 'WAIT FOR MORE MESSAGES' and 'no' leading to 'MAP_MT_FORWARD_SHORT_MESSAGE_rsp' and 'MAP_DELIMITER_req'. Both paths lead to 'NULL'.](92724c769da9d46b730fde1a6dccb023_img.jpg) + +### Process MT\_SM\_Transfer\_GLR + +23.2.3\_2(3) + +Figure 23.2/3: The mobile terminated short message service in the GLR + +``` +graph TD; Start([WAIT FOR MORE MESSAGES]) --> Ind{MAP_MT_FORWARD_SHORT_MESSAGE_ind}; Ind --> CheckInd[Check Indication]; CheckInd -- Section 25.2; CheckInd -- ok --> Req[MAP_MT_FORWARD_SHORT_MESSAGE_req]; Req -- MAP_DELIMITER_req --> Confirm([WAIT_FOR_MT_SMS_CONFIRM]); Confirm --> Cnf{MAP_MT_FORWARD_SHORT_MESSAGE_cnf}; Cnf --> CheckConf[Check Confirmation]; CheckConf -- Section 25.2; CheckConf -- ok --> MoreMsg{More msg to_sent}; CheckConf -- "User error" --> Absent{Absent Subscriber?}; Absent -- yes --> setMNRG[set MNRG]; setMNRG --> CheckAbsent[Check Absent SubscriberSM In_GLR]; CheckAbsent -- See TS 23.119; Absent -- no --> Rsp1[MAP_MT_FORWARD_SHORT_MESSAGE_rsp]; Rsp1 -- MAP_CLOSE_req --> NULL1([NULL]); MoreMsg -- yes --> MoreMsgWait([WAIT FOR MORE MESSAGES]); MoreMsg -- no --> Rsp2[MAP_MT_FORWARD_SHORT_MESSAGE_rsp]; Rsp2 -- MAP_DELIMITER_req --> NULL2([NULL]); NULL1 --> NULL2; NULL2 --> NULL3([NULL]); +``` + +Flowchart for Process MT\_SM\_Transfer\_GLR. It starts with 'WAIT FOR MORE MESSAGES', followed by 'MAP\_MT\_FORWARD\_SHORT\_MESSAGE\_ind', 'Check Indication' (Section 25.2), 'MAP\_MT\_FORWARD\_SHORT\_MESSAGE\_req', 'MAP\_DELIMITER\_req', 'WAIT\_FOR\_MT\_SMS\_CONFIRM', 'MAP\_MT\_FORWARD\_SHORT\_MESSAGE\_cnf', 'Check Confirmation' (Section 25.2). A decision diamond 'Absent Subscriber?' has 'yes' leading to 'set MNRG' then 'Check Absent SubscriberSM In\_GLR' (See TS 23.119), and 'no' leading to 'MAP\_MT\_FORWARD\_SHORT\_MESSAGE\_rsp' and 'MAP\_CLOSE\_req'. Another decision diamond 'More msg to\_sent' has 'yes' leading to 'WAIT FOR MORE MESSAGES' and 'no' leading to 'MAP\_MT\_FORWARD\_SHORT\_MESSAGE\_rsp' and 'MAP\_DELIMITER\_req'. Both paths lead to 'NULL'. + +Figure 23.2/3 (sheet 2 of 3): Procedure MT\_SM\_Transfer\_GLR + +#### Process MT\_SM\_Transfer\_GLR + +23.2.3\_3(3) + +Figure 23.2/3: The mobile terminated short message service in the GLR + +![Sequence diagram for Process MT_SM_Transfer_GLR showing interactions between a GLR and an SGSN.](93699fb71e95b4df5a3871fdcf818982_img.jpg) + +The sequence diagram illustrates the 'Process MT\_SM\_Transfer\_GLR' procedure. It begins with an initial state labeled 'WAIT\_FOR\_MORE\_MESSAGES' and 'WAIT\_FOR\_MT\_SMS\_CONFIRM'. The process then enters a loop. In the first part of the loop, the GLR receives 'MAP\_U\_ABORT\_ind' and 'MAP\_P\_ABORT\_ind' from the SMS-GMSC, sends a 'MAP\_NOTICE\_ind' to the SMS-GMSC, a 'MAP\_CLOSE\_req' to the SMS-GMSC, and a 'MAP\_U\_ABORT\_req' to the SGSN. This part of the loop ends with an 'X' mark. The second part of the loop involves the GLR receiving a 'MAP\_NOTICE\_ind' from the SGSN, sending a 'MAP\_CLOSE\_req' to the SGSN, and then sending 'MAP\_U\_ABORT\_ind', 'MAP\_P\_ABORT\_ind', and 'fMAP\_CLOSE\_ind' to the SGSN. This is followed by a 'MAP\_U\_ABORT\_req' to the SMS-GMSC, which also ends with an 'X' mark. The diagram uses standard UML notation: ovals for initial states, rectangles for message exchanges, diamonds for decision points, and 'X' marks for loop exits. + +Sequence diagram for Process MT\_SM\_Transfer\_GLR showing interactions between a GLR and an SGSN. + +Figure 23.2/3 (sheet 3 of 3): Procedure MT\_SM\_Transfer\_GLR + +![Flowchart for Macro MT_SM_GLR. It starts with an oval connector, followed by 'Subscriber known?' (yes/no). 'no' leads to 'User Error = Unidentified User' and an 'ERR OR' circle. 'yes' leads to 'Confirmed by HLR?' (yes/no). 'no' leads to an arrow pointing right. 'yes' leads to 'Retrieve and set SGSN Number'. Then 'Message segmenting needed?' (yes/no). 'no' leads to a process block with MAP_OPEN_req, MAP_MT_FORWARD_SHORT_MESSAGE_req, and MAP_DELIMITER_req, then 'Receive_Open_Cnf', then 'WAIT_FOR_MT_SMS_CONFIRM' (ok/error). 'error' leads to 'Error = System Failure' and 'ERR OR'. 'ok' leads to a process block with MAP_MT_FORWARD_SHORT_MESSAGE_req and MAP_DELIMITER_req, then 'WAIT_FOR_MT_SMS_CONFIRM' (ok/error). Both 'ok' paths lead to a process block with MAP_MT_FORWARD_SHORT_MESSAGE_Cnf, which then leads to a circle labeled '1 page2'.](8faeb7db381e28ab1ba06e9f48c19c6e_img.jpg) + +### Macrodefinition MT\_SM\_GLR + +23.2.4\_1(2) + +Figure 23.2/4: Macro which transfer short message PDUs to SGSN in the GLR + +Signals to/from the right are to/from the SGSN + +``` +graph TD; Start([ ]) --> Sub{Subscriber known?}; Sub -- no --> UE[User Error = Unidentified User]; UE --> ERR1((ERR OR)); Sub -- yes --> Conf{Confirmed by HLR?}; Conf -- no --> Right(( )); Conf -- yes --> SGSN[Retrieve and set SGSN Number]; SGSN --> Seg{Message segmenting needed?}; Seg -- no --> P1[MAP_OPEN_req
MAP_MT_FORWARD_SHORT_MESSAGE_req
MAP_DELIMITER_req]; P1 --> ROCnf1[Receive_Open_Cnf]; ROCnf1 -- ok --> W1((WAIT_FOR_MT_SMS_CONFIRM)); ROCnf1 -- error --> SF[Error = System Failure]; SF --> ERR2((ERR OR)); Seg -- yes --> P2[MAP_OPEN_req
MAP_DELIMITER_req]; P2 --> ROCnf2[Receive_Open_Cnf]; ROCnf2 -- ok --> P3[MAP_MT_FORWARD_SHORT_MESSAGE_req
MAP_DELIMITER_req]; P3 --> W2((WAIT_FOR_MT_SMS_CONFIRM)); W1 -- ok --> CNF[MAP_MT_FORWARD_SHORT_MESSAGE_Cnf]; W2 -- ok --> CNF; CNF --> End((1 page2)); +``` + +Flowchart for Macro MT\_SM\_GLR. It starts with an oval connector, followed by 'Subscriber known?' (yes/no). 'no' leads to 'User Error = Unidentified User' and an 'ERR OR' circle. 'yes' leads to 'Confirmed by HLR?' (yes/no). 'no' leads to an arrow pointing right. 'yes' leads to 'Retrieve and set SGSN Number'. Then 'Message segmenting needed?' (yes/no). 'no' leads to a process block with MAP\_OPEN\_req, MAP\_MT\_FORWARD\_SHORT\_MESSAGE\_req, and MAP\_DELIMITER\_req, then 'Receive\_Open\_Cnf', then 'WAIT\_FOR\_MT\_SMS\_CONFIRM' (ok/error). 'error' leads to 'Error = System Failure' and 'ERR OR'. 'ok' leads to a process block with MAP\_MT\_FORWARD\_SHORT\_MESSAGE\_req and MAP\_DELIMITER\_req, then 'WAIT\_FOR\_MT\_SMS\_CONFIRM' (ok/error). Both 'ok' paths lead to a process block with MAP\_MT\_FORWARD\_SHORT\_MESSAGE\_Cnf, which then leads to a circle labeled '1 page2'. + +Figure 23.2/4 (sheet1 of 2): Macro MT\_SM\_GLR + +##### Macrodefinition MT\_SM\_GLR + +23.2.4\_2(2) + +Figure 23.2/4: Macro which transfer short message PDUs to SGSN in the GLR + +![Flowchart for Macro MT_SM_GLR. It starts with '1 page1', followed by 'Check Confirmation' (linked to Section 25.2). A decision diamond 'Absent Subscriber?' follows. 'yes' leads to 'set MNRG' then 'Check_Absent SubscriberSM_in_GLR' (linked to See TS 23.119). 'no' leads to 'ERR OR'. 'ok' from 'Check Confirmation' leads to 'OK'. 'User Error' from 'Check Confirmation' leads to 'ERR OR'. 'Provider Error Data Error' from 'set MNRG' leads to 'ERR OR'.](ca9fd3bd2fe73a46244dd1d017ffa3b5_img.jpg) + +Flowchart for Macro MT\_SM\_GLR. It starts with '1 page1', followed by 'Check Confirmation' (linked to Section 25.2). A decision diamond 'Absent Subscriber?' follows. 'yes' leads to 'set MNRG' then 'Check\_Absent SubscriberSM\_in\_GLR' (linked to See TS 23.119). 'no' leads to 'ERR OR'. 'ok' from 'Check Confirmation' leads to 'OK'. 'User Error' from 'Check Confirmation' leads to 'ERR OR'. 'Provider Error Data Error' from 'set MNRG' leads to 'ERR OR'. + +Figure 23.2/4 (sheet2 of 2): Macro MT\_SM\_GLR + +## 23.3 The Short Message Alert procedure + +The Short Message Alert procedure is used for alerting the Service Centre when the mobile subscriber is active after a short message transfer has failed because the mobile subscriber is not reachable or when the MS has indicated that it has memory capacity to accept a short message. + +### 23.3.1 Procedures in the GLR + +When the GLR receives MAP\_READY\_FOR\_SM indication from the VLR or the SGSN and it has MNRF or MNRG, it sends MAP\_READY\_FOR\_SM request to the HLR. + +If the outcome is successful, the MNRF or MNRG is cleared. + +The short message alert procedure in the GLR is shown in figure 23.3/1. + +![Flowchart of Process SM_Alert_GLR. The process starts with NULL, then receives an Open indication (Section 25.1). If ok, it enters WAIT_FOR_SERVICE_PRIMITIVE. From there, it checks for MAP_READY_FOR_SM_ind (Section 25.2). If ok, it checks if the subscriber is known. If yes, it sends MAP_OPEN_req, MAP_READY_FOR_SM_req, and MAP_DELIMITER_req to the HLR, receives an Open Confirmation (Section 25.1), and if ok, sets UE to system failure and ends at 1 page 2. If no, it sets UE to UNKNOWN SUBSCRIBWR and ends at NULL. If error, it ends at NULL. If MAP_NOTICE_ind is received, it sends a MAP_CLOSE_req to the HLR and ends at NULL. If MAP_U_ABORT_ind, MAP_P_ABORT_ind, or MAP_CLOSE_ind is received, it ends at NULL.](a1b35c85c93d7a2e30d1feea2faac2e6_img.jpg) + +**Process SM\_Alert\_GLR** 23.3.1\_1(2) + +Figure 23.3/1: The short message alert process in the GLR + +Signals to/from the left are to/from the VLR/SGSN; signals to/from the right are to/from the HLR + +``` + +graph TD + Start([NULL]) --> RecOpen[Receive_Open_ind] + RecOpen --- Sec25_1_1[Section 25.1] + RecOpen -- ok --> WaitService((WAIT_FOR_SERVICE_PRIMITIVE_)) + RecOpen -- Error --> NULL1([NULL]) + WaitService --> MapReadyInd{MAP_READY_FOR_SM_ind} + MapReadyInd --- Sec25_2[Section 25.2] + MapReadyInd -- ok --> SubKnown{Subscriber known?} + SubKnown -- yes --> SendOpenReq[MAP_OPEN_req +MAP_READY_FOR_SM_req +MAP_DELIMITER_req] + SubKnown -- no --> SetUnknown[SET UE = UNKNOWN SUBSCRIBWR] + SubKnown -- error --> NULL2([NULL]) + SendOpenReq --> RecOpenCnf[Receive_Open_Cnf] + RecOpenCnf --- Sec25_1_2[Section 25.1] + RecOpenCnf -- ok --> SetFailure[SET UE = system failure] + RecOpenCnf -- error --> NULL3([NULL]) + SetFailure --> End1((1 page 2)) + SetUnknown --> NULL4([NULL]) + MapNoticeInd{MAP_NOTICE_ind} --> MapCloseReq[MAP_CLOSE_req] + MapCloseReq --> NULL5([NULL]) + MapUAbortInd[MAP_U_ABORT_ind +MAP_P_ABORT_ind +MAP_CLOSE_ind] --> NULL6([NULL]) + +``` + +Flowchart of Process SM\_Alert\_GLR. The process starts with NULL, then receives an Open indication (Section 25.1). If ok, it enters WAIT\_FOR\_SERVICE\_PRIMITIVE. From there, it checks for MAP\_READY\_FOR\_SM\_ind (Section 25.2). If ok, it checks if the subscriber is known. If yes, it sends MAP\_OPEN\_req, MAP\_READY\_FOR\_SM\_req, and MAP\_DELIMITER\_req to the HLR, receives an Open Confirmation (Section 25.1), and if ok, sets UE to system failure and ends at 1 page 2. If no, it sets UE to UNKNOWN SUBSCRIBWR and ends at NULL. If error, it ends at NULL. If MAP\_NOTICE\_ind is received, it sends a MAP\_CLOSE\_req to the HLR and ends at NULL. If MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, or MAP\_CLOSE\_ind is received, it ends at NULL. + +Figure 23.3/1 (sheet 1 of 2): Process SM\_Alert\_GLR + +![Flowchart of Process SM_Alert_GLR](3334fcca5dac808f4fd3840aba35bc2e_img.jpg) + +**Process SM\_Alert\_GLR** 23.3.1\_2(2) + +Figure 23.3/1: The short message alert process in the GLR + +``` +graph TD; Start((1 page1)) --> WF_RESULT([WF_RESULT]); WF_RESULT --> MAP_READY_FOR_SM_Cnf[MAP_READY_FOR_SM_Cnf]; MAP_READY_FOR_SM_Cnf --> CheckConfirmation[Check Confirmation]; CheckConfirmation --> MNRF_MNRG_Set{MNRF or MNRG set?}; CheckConfirmation -- error --> SET_USER_ERROR[SET USER ERROR]; MNRF_MNRG_Set -- ok --> REASON{REASON}; REASON -- no --> NULL[NULL]; REASON -- yes --> REASON_SUB{ }; REASON_SUB -- non-GPRS --> ClearMNRF[Clear MNRF]; REASON_SUB -- GPRS --> ClearMNRG[Clear MNRG]; ClearMNRF --> NULL; ClearMNRG --> NULL; SET_USER_ERROR --> NULL; +``` + +The flowchart illustrates the short message alert process in the GLR. It begins with a connector '1 page1', leading to a 'WF\_RESULT' symbol, followed by a 'MAP\_READY\_FOR\_SM\_Cnf' symbol. A 'Check Confirmation' block follows, with a reference to 'Section 25.2'. A decision diamond 'MNRF or MNRG set?' evaluates the confirmation. If 'ok', it proceeds to a 'REASON' decision diamond. If 'error', it goes to 'SET USER ERROR'. From 'REASON', if 'no', it ends at 'NULL'. If 'yes', it branches based on 'non-GPRS' (leading to 'Clear MNRF') or 'GPRS' (leading to 'Clear MNRG'). Both 'Clear MNRF' and 'Clear MNRG' lead to a merge point before the final output symbols 'MAP\_READY\_FOR\_SM\_rsp' and 'MAP\_CLOSE\_req', which then lead to the 'NULL' end symbol. + +Flowchart of Process SM\_Alert\_GLR + +Figure 23.3/1 (sheet 2 of 2): Process SM\_Alert\_GLR + +# 24 GPRS process description + +## 24.1 General + +The MAP GPRS procedures are used for the Network Requested PDP-Context Activation procedures. + +The stage 2 specification for Packet Switched Service involving GLR is in 3GPP TS 23.119. + +## 24.2 Send Routing Information procedure + +### 24.2.1 Process in the GLR for Send Routing Information for GPRS + +The MAP process in the GLR to provide routing information for a network-requested PDP context activation is shown in figure 24.2/1. The MAP process invokes a macro not defined in this subclause; the definition of this macro can be found as follows: + +- Receive\_Open\_Ind see subclause 25.1; +- Check\_Indication see subclause 25.2. + +#### Successful outcome + +When the MAP process receives a MAP\_OPEN indication with the application context gprsLocationInfoRetrieval, it checks it by invoking the macro Receive\_Open\_Ind. + +If the macro takes the OK exit, the MAP process waits for a service indication. + +If a MAP\_SEND\_ROUTING\_INFO\_FOR\_GPRS service indication is received, the GLR sends a Send Routing Info For Gprs request to the GPRS application process in the GLR, and wait for a response. The Send Routing Info For Gprs request contains the parameter received in the MAP\_SEND\_ROUTING\_INFO\_FOR\_GPRS service indication. + +If the GPRS application process in the GLR returns a positive response containing the routing information, the MAP process constructs a MAP\_SEND\_ROUTING\_INFO\_FOR\_GPRS service response containing the routing info, constructs a MAP\_CLOSE service request, sends them to the IM-GSN and returns to the idle state. + +#### Negative response from GLR GPRS application process + +If the GPRS application process in the GLR returns a negative response, the MAP process constructs a MAP\_SEND\_ROUTING\_INFO\_FOR\_GPRS service response containing the appropriate error, constructs a MAP\_CLOSE service request, sends them to the IM-GSN and returns to the idle state. + +#### Failure of dialogue opening with the IM-GSN + +If the macro Receive\_Open\_Ind takes the Vr exit or the Error exit, the MAP process returns to the idle state. + +If the MAP provider sends a MAP\_P\_ABORT while the MAP process is waiting for a service indication, the MAP process returns to the idle state. + +If the MAP provider sends a MAP\_NOTICE while the MAP process is waiting for a service indication, the MAP process sends a MAP\_CLOSE request to terminate the dialogue and returns to the idle state. + +![SDL Diagram for Process Send_Routing_Info_For_Gprs_GLR. The flow starts at an entry point leading to an Idle state. From Idle, it receives Open_Ind (referencing Section 25.1). If OK, it moves to Wait_For_Service_Indication. If Vr, Error, it returns to Idle. From Wait_For_Service_Indication, four branches exist: 1) MAP_P_ABORT_ind leads to Idle. 2) MAP_SEND_ROUTING_INFO_FOR_GPRS_ind leads to Set Routing Info. 3) MAP_NOTICE_ind leads to MAP_CLOSE_req and then Idle. 4) An internal signal 'Send Routing Info For Gprs' leads to Wait For Routing Info. From Wait For Routing Info, two responses are possible: a negative response (Set UE) or an ack (Set Routing Info). Both lead to a final state where MAP_SEND_ROUTING_INFO_FOR_GPRS_rsp and MAP_CLOSE_req are sent before returning to Idle.](93bd00a00fa28558486f0664550699b1_img.jpg) + +### Process Send\_Routing\_Info\_For\_Gprs\_GLR + +24.2.1(1) + +Figure 24.2/1: The Send Routing Info For Gprs process in the GLR + +Signals to/from the right are to/from the GPRS application process + + + +``` + + graph TD + Start([ ]) --> Idle1([Idle]) + Idle1 --> RecOpen[/Receive Open_Ind/] + RecOpen --- Sec251[Section 25.1] + RecOpen -- OK --> WaitSvc([Wait_For_Service_Indication]) + RecOpen -- "Vr, Error" --> Idle2([Idle]) + + WaitSvc --> AbortInd[/MAP_P_ABORT_ind/] + WaitSvc --> SendRInfoInd[/MAP_SEND_ROUTING_INFO_FOR_GPRS_ind/] + WaitSvc --> NoticeInd[/MAP_NOTICE_ind/] + WaitSvc --> SendRInfoInt{{Send Routing Info For Gprs}} + + AbortInd --> Idle3([Idle]) + + SendRInfoInt --> WaitRInfo([Wait For Routing Info]) + + NoticeInd --> CloseReq1[MAP_CLOSE_req] + CloseReq1 --> Idle4([Idle]) + + WaitRInfo --> NegResp[/Send Routing Info For Gprs negative response/] + WaitRInfo --> Ack[/Send Routing Info For Gprs ack/] + + NegResp --> SetUE[Set UE] + Ack --> SetRInfo[Set Routing Info] + SendRInfoInd --> SetRInfo + + SetUE --> FinalMerge{ } + SetRInfo --> FinalMerge + + FinalMerge --> Rsp[MAP_SEND_ROUTING_INFO_FOR_GPRS_rsp] + FinalMerge --> CloseReq2[MAP_CLOSE_req] + Rsp --> Idle5([Idle]) + CloseReq2 --> Idle5 + +``` + +SDL Diagram for Process Send\_Routing\_Info\_For\_Gprs\_GLR. The flow starts at an entry point leading to an Idle state. From Idle, it receives Open\_Ind (referencing Section 25.1). If OK, it moves to Wait\_For\_Service\_Indication. If Vr, Error, it returns to Idle. From Wait\_For\_Service\_Indication, four branches exist: 1) MAP\_P\_ABORT\_ind leads to Idle. 2) MAP\_SEND\_ROUTING\_INFO\_FOR\_GPRS\_ind leads to Set Routing Info. 3) MAP\_NOTICE\_ind leads to MAP\_CLOSE\_req and then Idle. 4) An internal signal 'Send Routing Info For Gprs' leads to Wait For Routing Info. From Wait For Routing Info, two responses are possible: a negative response (Set UE) or an ack (Set Routing Info). Both lead to a final state where MAP\_SEND\_ROUTING\_INFO\_FOR\_GPRS\_rsp and MAP\_CLOSE\_req are sent before returning to Idle. + +**Figure 24.2/1: Process Send Routing Info For Gprs\_GLR** + +### 24.2.2 Process in the IM-GSN for Send Routing Information for GPRS + +Successful Outcome + +When the MAP process receives a Send Routing Info For Gprs request from the GPRS application process in the IM-GSN, it: + +- requests a dialogue with the GLR whose identity is contained in the Send Routing Info For Gprs request by sending a MAP\_OPEN service request; +- requests routing information using a MAP\_SEND\_ROUTING\_INFO\_FOR\_GPRS service request, and +- invokes the macro Receive\_Open\_Cnf to wait for the response to the dialogue opening request. + +If the dialogue opening is successful, the MAP process waits for a response from the GLR. + +If the MAP process receives a MAP\_SEND\_ROUTING\_INFO\_FOR\_GPRS service confirm from the GLR, the MAP process invokes the macro Check\_Confirmation to check the content of the confirmation. + +If the macro Check\_Confirmation takes the OK exit, the MAP process sends a Send Routing Info For Gprs ack containing the routing information received from the GLR to the GPRS application process in the IM-GSN and returns to the idle state. + +#### **Failure of dialogue opening with the GLR** + +If the macro Receive\_Open\_Cnf takes the Vr exit or the Error exit, the MAP process sends a negative response to the GPRS application process in the IM-GSN and returns to the idle state. + +#### **Error in MAP\_SEND\_ROUTING\_INFO\_FOR\_GPRS confirm** + +If the MAP\_SEND\_ROUTING\_INFO\_FOR\_GPRS service confirm contains a user error or a provider error, or the macro Check\_Confirmation indicates that there is a data error, the MAP process sends a Send Routing Info For Gprs negative response to the GPRS application process in the IM-GSN and returns to the idle state. + +#### **Abort of GLR dialogue** + +After the dialogue with the GLR has been established, the MAP service provider may abort the dialogue by issuing a MAP\_P\_ABORT or a MAP\_U\_ABORT indication. In this case, the MAP process sends a Send Routing Info For Gprs negative response to the GPRS application process in the IM-GSN and returns to the idle state. + +If the MAP provider indicates a protocol problem by sending a MAP\_NOTICE indication, the MAP process closes the dialogue with the GLR, sends a Send Routing Info For Gprs negative response indicating system failure to the GPRS application process in the IM-GSN and returns to the idle state. + +![State transition diagram for Process Send_Routing_Info_For_Gprs_IMGSN. The process starts at Idle, transitions to Send Routing Info For Gprs, then to a state where it waits for MAP_OPEN_req, MAP_SEND_ROUTING_INFO_FOR_GPRS_req, or MAP_DELIMITER_req. It then receives Open_cnf (Section 25.1). From Open_cnf, an OK leads to Wait_For_Ack, while Vr, Error leads to Send Routing Info For Gprs negative response and back to Idle. From Wait_For_Ack, three paths emerge: MAP_SEND_ROUTING_INFO_FOR_GPRS_cnf (leading to Check_Confirmation, Section 25.2), MAP_P_ABORT_ind / MAP_U_ABORT_ind, and MAP_NOTICE_ind. Check_Confirmation leads to Send Routing Info For Gprs ack (OK) and back to Idle. The other two paths lead to Send Routing Info For Gprs negative response (Provider User Error, Data Error) and back to Idle. MAP_NOTICE_ind also leads to MAP_CLOSE_req.](f4e5a86da5c799372a7c1ea2397dedb7_img.jpg) + +### Process Send\_Routing\_Info\_For\_Gprs\_IMGSN 24.2.2(1) + +Figure 24.2/2: The Send Routing Info For Gprs process in the IMGSN + +Signals to/from the right are to/from the GPRS application process + +``` +stateDiagram-v2 + [*] --> Idle + Idle --> Send_Routing_Info_For_Gprs + Send_Routing_Info_For_Gprs --> Wait_For_Open + state "MAP_OPEN_req
MAP_SEND_ROUTING_INFO_FOR_GPRS_req
MAP_DELIMITER_req" as Wait_For_Open + Wait_For_Open --> Receive_Open_cnf + Receive_Open_cnf --> Wait_For_Ack : OK + Receive_Open_cnf --> Send_Routing_Info_For_Gprs_negative_response : Vr, Error + Send_Routing_Info_For_Gprs_negative_response --> Idle + Wait_For_Ack --> Check_Confirmation : MAP_SEND_ROUTING_INFO_FOR_GPRS_cnf + Check_Confirmation --> Send_Routing_Info_For_Gprs_ack : OK + Send_Routing_Info_For_Gprs_ack --> Idle + Wait_For_Ack --> Send_Routing_Info_For_Gprs_negative_response : MAP_P_ABORT_ind / MAP_U_ABORT_ind + Send_Routing_Info_For_Gprs_negative_response --> Idle + Wait_For_Ack --> MAP_NOTICE_ind + MAP_NOTICE_ind --> MAP_CLOSE_req + Note right of Check_Confirmation : Section 25.2 + Note right of Receive_Open_cnf : Section 25.1 +``` + +State transition diagram for Process Send\_Routing\_Info\_For\_Gprs\_IMGSN. The process starts at Idle, transitions to Send Routing Info For Gprs, then to a state where it waits for MAP\_OPEN\_req, MAP\_SEND\_ROUTING\_INFO\_FOR\_GPRS\_req, or MAP\_DELIMITER\_req. It then receives Open\_cnf (Section 25.1). From Open\_cnf, an OK leads to Wait\_For\_Ack, while Vr, Error leads to Send Routing Info For Gprs negative response and back to Idle. From Wait\_For\_Ack, three paths emerge: MAP\_SEND\_ROUTING\_INFO\_FOR\_GPRS\_cnf (leading to Check\_Confirmation, Section 25.2), MAP\_P\_ABORT\_ind / MAP\_U\_ABORT\_ind, and MAP\_NOTICE\_ind. Check\_Confirmation leads to Send Routing Info For Gprs ack (OK) and back to Idle. The other two paths lead to Send Routing Info For Gprs negative response (Provider User Error, Data Error) and back to Idle. MAP\_NOTICE\_ind also leads to MAP\_CLOSE\_req. + +Figure 24.2/2: Process Send\_Routing\_Info\_For\_Gprs\_IM-GSN + +## 24.3 Failure Report procedure + +### 24.3.1 Process in the GLR for Failure Report + +The MAP process in the GLR to set the MNRG (Mobile station Not Reachable for GPRS) flag for the subscriber is shown in figure 24.3/1. The MAP process invokes a macro not defined in this subclause; the definition of this macro can be found as follows: + +- Receive\_Open\_Ind see subclause 25.1; +- Check Indication see subclause 25.2. + +#### Successful outcome + +When the MAP process receives a MAP\_OPEN indication with the application context failureReport, it checks it by invoking the macro Receive\_Open\_Ind. + +If the macro takes the OK exit, the MAP process waits for a service indication. + +If a MAP\_FAILURE\_REPORT service indication is received, the GLR sends a Failure Report request to the GPRS application process in the GLR, and wait for a response. The Failure Report request contains the parameter received in the MAP\_FAILURE\_REPORT service indication. + +If a positive response is received, the MAP process constructs a MAP\_FAILURE\_REPORT service response, constructs a MAP\_CLOSE service request, sends them to the IM-GSN and returns to the idle state. + +#### Negative response from GLR GPRS application process + +If the GPRS application process in the GLR returns a negative response, the MAP process constructs a MAP\_FAILURE\_REPORT service response containing the appropriate error, constructs a MAP\_CLOSE service request, sends them to the IM-GSN and returns to the idle state. + +#### Failure of dialogue opening with the IM-GSN + +If the macro Receive\_Open\_Ind takes the Vr exit or the Error exit, the MAP process returns to the idle state. + +If the MAP provider sends a MAP\_P\_ABORT while the MAP process is waiting for a service indication, the MAP process returns to the idle state. + +If the MAP provider sends a MAP\_NOTICE while the MAP process is waiting for a service indication, the MAP process sends a MAP\_CLOSE request to terminate the dialogue and returns to the idle state. + +![Flowchart of Process Failure_Report_GLR](61b2e15aedbb8a8dffc5426c0a284eb1_img.jpg) + +### Process Failure\_Report\_GLR + +24.3.1(1) + +Figure 24.3/1: The Failure Report process in the GLR + +Signals to/from the right are to/from the application process + +``` +graph TD; Start([ ]) --> Idle1([Idle]); Idle1 --> RecOpen[Receive Open_Ind]; RecOpen --> WaitFor[Wait_For_Service_Indication]; RecOpen --> VrError[Idle]; VrError --> VrError; WaitFor --> MAP_P_ABORT[MAP_P_ABORT_ind]; WaitFor --> MAP_FAILURE_REPORT[MAP_FAILURE_REPORT_ind]; WaitFor --> MAP_NOTICE[MAP_NOTICE_ind]; MAP_P_ABORT --> Idle2([Idle]); MAP_FAILURE_REPORT --> FailureReport[Failure Report]; FailureReport --> WaitForResponse[Wait For Response]; MAP_NOTICE --> MAP_CLOSE_req1[MAP_CLOSE_req]; MAP_CLOSE_req1 --> Idle3([Idle]); WaitForResponse --> NegResponse[Failure Report negative response]; WaitForResponse --> Ack[Failure Report ack]; NegResponse --> SetUE[Set UE]; Ack --> MAP_FAILURE_REPORT_rsp[MAP_FAILURE_REPORT_rsp]; SetUE --> MAP_FAILURE_REPORT_rsp; MAP_FAILURE_REPORT_rsp --> MAP_CLOSE_req2[MAP_CLOSE_req]; MAP_FAILURE_REPORT_rsp --> Idle4([Idle]); +``` + +The flowchart illustrates the 'Process Failure\_Report\_GLR'. It begins with an initial state leading to an 'Idle' state. Upon receiving an 'Open\_Ind' signal (referenced to Section 25.1), the process enters a 'Wait\_For\_Service\_Indication' state. From here, three outcomes are possible: an 'OK' response leads to another 'Idle' state; a 'Vr, Error' response also leads to an 'Idle' state; and a successful indication leads to three parallel paths. The first path involves 'MAP\_P\_ABORT\_ind', leading to 'Idle'. The second path involves 'MAP\_FAILURE\_REPORT\_ind', leading to a 'Failure Report' state, then 'Wait For Response'. From 'Wait For Response', a 'Failure Report negative response' leads to 'Set UE', and a 'Failure Report ack' leads to the final 'MAP\_FAILURE\_REPORT\_rsp' state. The third path involves 'MAP\_NOTICE\_ind', leading to 'MAP\_CLOSE\_req', which then leads to 'Idle'. Both 'Set UE' and 'MAP\_FAILURE\_REPORT\_rsp' lead to a final 'MAP\_FAILURE\_REPORT\_rsp' state, which also includes a 'MAP\_CLOSE\_req' signal and leads to a final 'Idle' state. A note indicates that signals to/from the right are to/from the application process. + +Flowchart of Process Failure\_Report\_GLR + +Figure 24.3/1: Process Failure\_Report\_GLR + +### 24.3.2 Process in the IM-GSN for Failure Report + +Successful Outcome + +When the MAP process receives a Failure Report request from the GPRS application process in the IM-GSN, it requests a dialogue with the GLR whose identity is contained in the Failure Report request by sending a MAP\_OPEN service request, sending failure information using a MAP\_FAILURE\_REPORT service request and invokes the macro Receive\_Open\_Cnf to wait for the response to the dialogue opening request. If the dialogue opening is successful, the MAP process waits for a response from the GLR. + +If the MAP process receives a MAP\_FAILURE\_REPORT service confirm from the GLR, the MAP process invokes the macro Check\_Confirmation to check the content of the confirmation. + +If the macro Check\_Confirmation takes the OK exit, the MAP process sends a Failure Report ack containing the information received from the GLR to the GPRS application process in the IM-GSN and returns to the idle state. + +#### **Failure of dialogue opening with the GLR** + +If the macro Receive\_Open\_Cnf takes the Vr exit or the Error exit, the MAP process sends a negative response to the GPRS application process in the IM-GSN and returns to the idle state. + +#### **Error in MAP\_FAILURE\_REPORT confirm** + +If the MAP\_FAILURE\_REPORT service confirm contains a user error or a provider error, or the macro Check\_Confirmation indicates that there is a data error, the MAP process sends a Failure Report negative response to the GPRS application process in the IM-GSN and returns to the idle state. + +#### **Abort of GLR dialogue** + +After the dialogue with the GLR has been established, the MAP service provider may abort the dialogue by issuing a MAP\_P\_ABORT or a MAP\_U\_ABORT indication. In this case, the MAP process sends a Failure Report negative response to the GPRS application process in the IM-GSN and returns to the idle state. + +If the MAP provider indicates a protocol problem by sending a MAP\_NOTICE indication, the MAP process closes the dialogue with the GLR, sends a Failure Report negative response indicating system failure to the GPRS application process in the IM-GSN and returns to the idle state. + +![Flowchart of the Failure Report process in the IMGSN. The process starts at an Idle state, receives a Failure Report, sends MAP_OPEN_req, MAP_FAILURE_REPORT_req, and MAP_DELIMITER_req, receives an Open confirmation, and then either waits for an acknowledgment or sends a negative response. It then checks for confirmations or notices, and finally sends an acknowledgment or negative response to return to the Idle state.](710ff83dc4a77abbe489fbf1a462845a_img.jpg) + +### Process Failure\_Report\_IMGSN + +24.3.2(1) + +Figure 24.3/2: The Failure Report process in the IMGSN + +Signals to/from the right are to/from the GPRS application process + +``` +graph TD; Start([ ]) --> Idle1([Idle]); Idle1 --> FailureReport[/Failure Report/]; FailureReport --> OpenReq{ }; OpenReq --- OpenReqList["MAP_OPEN_req +MAP_FAILURE_REPORT_req +MAP_DELIMITER_req"]; OpenReq --> ReceiveOpenCnf[Receive Open_cnf]; ReceiveOpenCnf --- Section251[Section 25.1]; ReceiveOpenCnf --> WaitForAck([Wait_For_Ack]); WaitForAck -- OK --> CheckConfirmation[Check Confirmation]; WaitForAck -- "Vr, Error" --> FailureReportNeg[Failure Report negative response]; FailureReportNeg --> Idle2([Idle]); CheckConfirmation --- Section252[Section 25.2]; CheckConfirmation -- OK --> FailureReportAck[/Failure Report ack/]; CheckConfirmation -- "Provider User Error, Data Error" --> FailureReportNeg2[Failure Report negative response]; FailureReportAck --> Idle3([Idle]); FailureReportNeg2 --> Idle3; MAP_FAILURE_REPORT_cnf[MAP_FAILURE_REPORT_cnf] --> CheckConfirmation; MAP_P_ABORT_ind[MAP_P_ABORT_ind +MAP_U_ABORT_ind] --> FailureReportNeg2; MAP_NOTICE_ind[MAP_NOTICE_ind] --> MAP_CLOSE_req{ }; MAP_CLOSE_req --> FailureReportNeg2; +``` + +Flowchart of the Failure Report process in the IMGSN. The process starts at an Idle state, receives a Failure Report, sends MAP\_OPEN\_req, MAP\_FAILURE\_REPORT\_req, and MAP\_DELIMITER\_req, receives an Open confirmation, and then either waits for an acknowledgment or sends a negative response. It then checks for confirmations or notices, and finally sends an acknowledgment or negative response to return to the Idle state. + +Figure 24.3/2: Process Failure\_Report\_IM-GSN + +# --- 25 General macro description + +## 25.1 MAP open macros + +This subclause refers 3GPP TS 29.002. + +## 25.2 Macros to check the content of indication and confirmation primitives + +This subclause refers 3GPP TS 29.002. + +## 25.3 Authentication processes + +### 25.3.1 Process Obtain\_Authentication\_Sets\_GLR + +This process is initiated by the GLR to fetch authentication vectors from a subscriber's HLR to the VLR. The process is described in figure 25.3/1. + +![Flowchart for Process Obtain_Authent_Sets_GLR. The process starts with an oval connector, leading to a 'NULL' state. It then enters a 'Receive_Open_ind' block (Section 25.1). From here, an 'OK' path leads to 'Wait_For_Service_Primitive', which then branches into three parallel paths: one leading to a 'NULL' state via 'MAP_P_ABORT_ind', 'MAP_U_ABORT_ind', and 'MAP_CLOSE_ind'; another leading to a request block ('MAP_OPEN_req', 'MAP_SEND_AUTHENTICATION_INFO_req', 'MAP_DELIMITER_req') which then leads to 'Receive_Open_cnf' (Section 25.1); and a third leading to 'NULL' via 'MAP_NOTICE_ind' and 'MAP_CLOSE_req'. From 'Receive_Open_cnf', an 'OK' path leads to 'WAIT_FOR_AUTHENTICATION_INFO', while a 'Vr, Error' path leads to 'MAP_U_ABORT_req' and then to a 'NULL' state.](884c44b6cb9fbe15347e0562a6085df2_img.jpg) + +### Process Obtain\_Authent\_Sets\_GLR + +25.3.1\_1(2) + +Figure 25.3/1: The Process to obtain authentication sets from the HLR to the VLR via the GLR + +Left from/to VLR +Right from/to HLR + +``` +graph TD; Start([ ]) --> NULL1(NULL); NULL1 --> Receive_Open_ind[Receive_Open_ind]; subgraph Section_25_1_1 [Section 25.1]; Receive_Open_ind; end; Receive_Open_ind -- OK --> Wait_For_Service_Primitive((Wait_For_Service_Primitive)); Receive_Open_ind -- "Vr, Error" --> NULL2(NULL); Wait_For_Service_Primitive --> MAP_P_ABORT_ind[MAP_P_ABORT_ind +MAP_U_ABORT_ind +MAP_CLOSE_ind]; Wait_For_Service_Primitive --> MAP_SEND_AUTHENTICATION_INFO_ind[MAP_SEND_AUTHENTICATION_INFO_ind]; Wait_For_Service_Primitive --> MAP_NOTICE_ind[MAP_NOTICE_ind]; MAP_P_ABORT_ind --> NULL3(NULL); MAP_SEND_AUTHENTICATION_INFO_ind --> Request[MAP_OPEN_req +MAP_SEND_AUTHENTICATION_INFO_req +MAP_DELIMITER_req]; Request --> Receive_Open_cnf[Receive_Open_cnf]; subgraph Section_25_1_2 [Section 25.1]; Receive_Open_cnf; end; Receive_Open_cnf -- OK --> WAIT_FOR_AUTHENTICATION_INFO((WAIT_FOR_AUTHENTICATION_INFO)); Receive_Open_cnf -- "Vr, Error" --> MAP_U_ABORT_req{MAP_U_ABORT_req}; MAP_U_ABORT_req --> NULL4(NULL); MAP_NOTICE_ind --> MAP_CLOSE_req{MAP_CLOSE_req}; MAP_CLOSE_req --> NULL5(NULL); +``` + +Flowchart for Process Obtain\_Authent\_Sets\_GLR. The process starts with an oval connector, leading to a 'NULL' state. It then enters a 'Receive\_Open\_ind' block (Section 25.1). From here, an 'OK' path leads to 'Wait\_For\_Service\_Primitive', which then branches into three parallel paths: one leading to a 'NULL' state via 'MAP\_P\_ABORT\_ind', 'MAP\_U\_ABORT\_ind', and 'MAP\_CLOSE\_ind'; another leading to a request block ('MAP\_OPEN\_req', 'MAP\_SEND\_AUTHENTICATION\_INFO\_req', 'MAP\_DELIMITER\_req') which then leads to 'Receive\_Open\_cnf' (Section 25.1); and a third leading to 'NULL' via 'MAP\_NOTICE\_ind' and 'MAP\_CLOSE\_req'. From 'Receive\_Open\_cnf', an 'OK' path leads to 'WAIT\_FOR\_AUTHENTICATION\_INFO', while a 'Vr, Error' path leads to 'MAP\_U\_ABORT\_req' and then to a 'NULL' state. + +Figure 25.3.1/1 (sheet 1 of 2): Process Obtain\_Authentication\_Sets\_GLR + +![State transition diagram for Process Obtain_Authent_Sets_GLR. The diagram shows two main sections of state transitions. The top section starts with 'WAIT FOR AUTHENTICATION_INFO' and branches into four paths: 1) MAP SEND AUTHENTICATION_INFO_req leads to MAP SEND AUTHENTICATION_INFO_ind, which leads to MAP SEND AUTHENTICATION_INFO_cnf, which leads to 'WAIT FOR AUTHENTICATION_INFO'. 2) MAP SEND AUTHENTICATION_INFO_cnf leads to MAP SEND AUTHENTICATION_INFO_req, which leads to 'NULL'. 3) MAP CLOSE_ind leads to MAP CLOSE_req, which leads to 'NULL'. 4) MAP CLOSE_ind leads to MAP CLOSE_req, which loops back to 'WAIT FOR AUTHENTICATION_INFO'. The bottom section starts with 'WAIT FOR AUTHENTICATION_INFO' and branches into four paths: 1) MAP_NOTICE_ind leads to MAP_CLOSE_req, which leads to MAP_U_ABORT_req, which leads to 'NULL'. 2) MAP_NOTICE_ind leads to MAP_CLOSE_req, which loops back to 'WAIT FOR AUTHENTICATION_INFO'. 3) MAP_P_ABORT_ind / MAP_U_ABORT_ind leads to MAP_U_ABORT_req, which leads to 'NULL'. 4) MAP_P_ABORT_ind / MAP_U_ABORT_ind leads to MAP_U_ABORT_req, which loops back to 'WAIT FOR AUTHENTICATION_INFO'.](b0384c8e0ff826a8116ab2ff67dadc43_img.jpg) + +**Process Obtain\_Authent\_Sets\_GLR** 25.3.1\_2(2) + +Figure 25.3/1: The Process to obtain authentication sets from the HLR to the VLR via the GLR + +Left from/to VLR +Right from/to HLR + +``` + +stateDiagram-v2 + [*] --> WAIT_FOR_AUTHENTICATION_INFO + state "WAIT FOR AUTHENTICATION_INFO" as WAIT_FOR_AUTHENTICATION_INFO + state "MAP SEND AUTHENTICATION_INFO_req" as MAP_SEND_AUTHENTICATION_INFO_req + state "MAP SEND AUTHENTICATION_INFO_ind" as MAP_SEND_AUTHENTICATION_INFO_ind + state "MAP SEND AUTHENTICATION_INFO_cnf" as MAP_SEND_AUTHENTICATION_INFO_cnf + state "MAP CLOSE_ind" as MAP_CLOSE_ind + state "MAP CLOSE_req" as MAP_CLOSE_req + state "NULL" as NULL + state "MAP_NOTICE_ind" as MAP_NOTICE_ind + state "MAP_CLOSE_req" as MAP_CLOSE_req + state "MAP_U_ABORT_req" as MAP_U_ABORT_req + state "MAP_P_ABORT_ind / MAP_U_ABORT_ind" as MAP_P_ABORT_ind_MAP_U_ABORT_ind + + WAIT_FOR_AUTHENTICATION_INFO --> MAP_SEND_AUTHENTICATION_INFO_req + MAP_SEND_AUTHENTICATION_INFO_req --> MAP_SEND_AUTHENTICATION_INFO_ind + MAP_SEND_AUTHENTICATION_INFO_ind --> MAP_SEND_AUTHENTICATION_INFO_cnf + MAP_SEND_AUTHENTICATION_INFO_cnf --> WAIT_FOR_AUTHENTICATION_INFO + MAP_SEND_AUTHENTICATION_INFO_cnf --> MAP_SEND_AUTHENTICATION_INFO_req + MAP_SEND_AUTHENTICATION_INFO_req --> NULL + MAP_CLOSE_ind --> MAP_CLOSE_req + MAP_CLOSE_req --> NULL + MAP_CLOSE_ind --> MAP_CLOSE_req + MAP_CLOSE_req --> WAIT_FOR_AUTHENTICATION_INFO + + WAIT_FOR_AUTHENTICATION_INFO --> MAP_NOTICE_ind + MAP_NOTICE_ind --> MAP_CLOSE_req + MAP_CLOSE_req --> MAP_U_ABORT_req + MAP_U_ABORT_req --> NULL + MAP_NOTICE_ind --> MAP_CLOSE_req + MAP_CLOSE_req --> WAIT_FOR_AUTHENTICATION_INFO + MAP_P_ABORT_ind_MAP_U_ABORT_ind --> MAP_U_ABORT_req + MAP_U_ABORT_req --> NULL + MAP_P_ABORT_ind_MAP_U_ABORT_ind --> MAP_U_ABORT_req + MAP_U_ABORT_req --> WAIT_FOR_AUTHENTICATION_INFO + +``` + +State transition diagram for Process Obtain\_Authent\_Sets\_GLR. The diagram shows two main sections of state transitions. The top section starts with 'WAIT FOR AUTHENTICATION\_INFO' and branches into four paths: 1) MAP SEND AUTHENTICATION\_INFO\_req leads to MAP SEND AUTHENTICATION\_INFO\_ind, which leads to MAP SEND AUTHENTICATION\_INFO\_cnf, which leads to 'WAIT FOR AUTHENTICATION\_INFO'. 2) MAP SEND AUTHENTICATION\_INFO\_cnf leads to MAP SEND AUTHENTICATION\_INFO\_req, which leads to 'NULL'. 3) MAP CLOSE\_ind leads to MAP CLOSE\_req, which leads to 'NULL'. 4) MAP CLOSE\_ind leads to MAP CLOSE\_req, which loops back to 'WAIT FOR AUTHENTICATION\_INFO'. The bottom section starts with 'WAIT FOR AUTHENTICATION\_INFO' and branches into four paths: 1) MAP\_NOTICE\_ind leads to MAP\_CLOSE\_req, which leads to MAP\_U\_ABORT\_req, which leads to 'NULL'. 2) MAP\_NOTICE\_ind leads to MAP\_CLOSE\_req, which loops back to 'WAIT FOR AUTHENTICATION\_INFO'. 3) MAP\_P\_ABORT\_ind / MAP\_U\_ABORT\_ind leads to MAP\_U\_ABORT\_req, which leads to 'NULL'. 4) MAP\_P\_ABORT\_ind / MAP\_U\_ABORT\_ind leads to MAP\_U\_ABORT\_req, which loops back to 'WAIT FOR AUTHENTICATION\_INFO'. + +Figure 25.3.1/2 (sheet 2 of 2): Process Obtain\_Authentication\_Sets\_GLR + +### 25.3.2 Process Authentication\_Failure\_Report\_GLR + +This process is initiated by the GLR to notify a subscriber's HLR about the occurrence of an authentication failure in the VLR or SGSN. The process is described in figure 25.3/2. + +![Flowchart for Process Authentication_Failure_Report_GLR. The process starts with a NULL state, followed by 'Receive_Open_ind' (Section 25.1). From here, an 'OK' path leads to 'Wait_For_Service_Primitive', which then leads to a decision point. A 'Vr, Error' path from 'Receive_Open_ind' leads to a NULL state. From the decision point, a 'MAP_AUTHENTICATION_FAILURE_REPORT_ind' leads to 'MAP_NOTICE_ind', which then leads to 'MAP_CLOSE_req' and a NULL state. Another path from the decision point leads to a box with 'MAP_P_ABORT_ind', 'MAP_U_ABORT_ind', and 'MAP_CLOSE_ind', which leads to a NULL state. A third path from the decision point leads to a box with 'MAP_OPEN_req', 'MAP_AUTHENTICATION_FAILURE_REPORT_req', and 'MAP_DELIMITER_req', which leads to 'Receive_Open_cnf' (Section 25.1). From 'Receive_Open_cnf', an 'OK' path leads to 'WAIT_FOR_RESPONSE', and a 'Vr, Error' path leads to 'MAP_U_ABORT_req' and a NULL state.](223792b3652794024244c277cc46394b_img.jpg) + +### Process Authentication\_Failure\_Report\_GLR + +25.3.2\_1(2) + +Figure 25.3.2/1: The Process to notify authentication failure report from the VLR/SGSN to the HLR via the GLR + +Left from/to VLR or SGSN +Right from/to HLR + +``` +graph TD; Start([ ]) --> NULL1([NULL]); NULL1 --> Receive_Open_ind[Receive_Open_ind]; Receive_Open_ind --- Section25_1_1[Section 25.1]; Receive_Open_ind -- OK --> Wait_For_Service_Primitive([Wait_For_Service_Primitive]); Receive_Open_ind -- "Vr, Error" --> NULL2([NULL]); Wait_For_Service_Primitive --> Decision1{ }; Decision1 -- "MAP_AUTHENTICATION_FAILURE_REPORT_ind" --> MAP_NOTICE_ind[MAP_NOTICE_ind]; MAP_NOTICE_ind --> MAP_CLOSE_req{MAP_CLOSE_req}; MAP_CLOSE_req --> NULL3([NULL]); Decision1 --> MAP_P_ABORT_ind[MAP_P_ABORT_ind +MAP_U_ABORT_ind +MAP_CLOSE_ind]; MAP_P_ABORT_ind --> NULL4([NULL]); Decision1 --> MAP_OPEN_req[MAP_OPEN_req +MAP_AUTHENTICATION_FAILURE_REPORT_req +MAP_DELIMITER_req]; MAP_OPEN_req --> Receive_Open_cnf[Receive_Open_cnf]; Receive_Open_cnf --- Section25_1_2[Section 25.1]; Receive_Open_cnf -- OK --> WAIT_FOR_RESPONSE([WAIT_FOR_RESPONSE]); Receive_Open_cnf -- "Vr, Error" --> MAP_U_ABORT_req{MAP_U_ABORT_req}; MAP_U_ABORT_req --> NULL5([NULL]); +``` + +Flowchart for Process Authentication\_Failure\_Report\_GLR. The process starts with a NULL state, followed by 'Receive\_Open\_ind' (Section 25.1). From here, an 'OK' path leads to 'Wait\_For\_Service\_Primitive', which then leads to a decision point. A 'Vr, Error' path from 'Receive\_Open\_ind' leads to a NULL state. From the decision point, a 'MAP\_AUTHENTICATION\_FAILURE\_REPORT\_ind' leads to 'MAP\_NOTICE\_ind', which then leads to 'MAP\_CLOSE\_req' and a NULL state. Another path from the decision point leads to a box with 'MAP\_P\_ABORT\_ind', 'MAP\_U\_ABORT\_ind', and 'MAP\_CLOSE\_ind', which leads to a NULL state. A third path from the decision point leads to a box with 'MAP\_OPEN\_req', 'MAP\_AUTHENTICATION\_FAILURE\_REPORT\_req', and 'MAP\_DELIMITER\_req', which leads to 'Receive\_Open\_cnf' (Section 25.1). From 'Receive\_Open\_cnf', an 'OK' path leads to 'WAIT\_FOR\_RESPONSE', and a 'Vr, Error' path leads to 'MAP\_U\_ABORT\_req' and a NULL state. + +Figure 25.3.2/1 (sheet 1 of 2): Process Authentication\_Failure\_Report\_GLR + +![State transition diagram for Process Authentication_Failure_Report_GLR. The diagram shows two main sections of state transitions. The top section starts with a 'WAIT_FOR_RESPONSE' state, leading to a horizontal transition line. Below this line are three boxes: 'MAP_AUTHENTICATION_FAILURE_REPORT_cnf' (left), 'MAP_CLOSE_ind' (middle), and 'MAP_CLOSE_ind' (right). Below the left box is a 'MAP_AUTHENTICATION_FAILURE_REPORT_cnf' state. Below the middle and right boxes are 'MAP_CLOSE_req' states. All three states lead to a 'NULL' state. The bottom section starts with a horizontal transition line. Below it are four boxes: 'MAP_NOTICE_ind' (leftmost), 'MAP_NOTICE_ind' (second from left), 'MAP_P_ABORT_ind / MAP_U_ABORT_ind' (third from left), and 'MAP_P_ABORT_ind / MAP_U_ABORT_ind' (rightmost). Below the leftmost box is a 'MAP_CLOSE_req' state, which leads to a 'MAP_U_ABORT_req' state. Below the second box is a 'MAP_CLOSE_req' state, which leads to a 'MAP_U_ABORT_req' state. Below the third box is a 'MAP_U_ABORT_req' state. Below the rightmost box is a 'MAP_U_ABORT_req' state. All four 'MAP_U_ABORT_req' states lead to a 'NULL' state.](b55cd9b5721bd8aabc979c85316924e4_img.jpg) + +**Process Authentication\_Failure\_Report\_GLR** 25.3.2\_2(2) + +Figure 25.3.2/1: The Process to notify authentication failure report from the VLR/SGSN to the HLR via the GLR + +Left from/to VLR or SGSN +Right from/to HLR + +State transition diagram for Process Authentication\_Failure\_Report\_GLR. The diagram shows two main sections of state transitions. The top section starts with a 'WAIT\_FOR\_RESPONSE' state, leading to a horizontal transition line. Below this line are three boxes: 'MAP\_AUTHENTICATION\_FAILURE\_REPORT\_cnf' (left), 'MAP\_CLOSE\_ind' (middle), and 'MAP\_CLOSE\_ind' (right). Below the left box is a 'MAP\_AUTHENTICATION\_FAILURE\_REPORT\_cnf' state. Below the middle and right boxes are 'MAP\_CLOSE\_req' states. All three states lead to a 'NULL' state. The bottom section starts with a horizontal transition line. Below it are four boxes: 'MAP\_NOTICE\_ind' (leftmost), 'MAP\_NOTICE\_ind' (second from left), 'MAP\_P\_ABORT\_ind / MAP\_U\_ABORT\_ind' (third from left), and 'MAP\_P\_ABORT\_ind / MAP\_U\_ABORT\_ind' (rightmost). Below the leftmost box is a 'MAP\_CLOSE\_req' state, which leads to a 'MAP\_U\_ABORT\_req' state. Below the second box is a 'MAP\_CLOSE\_req' state, which leads to a 'MAP\_U\_ABORT\_req' state. Below the third box is a 'MAP\_U\_ABORT\_req' state. Below the rightmost box is a 'MAP\_U\_ABORT\_req' state. All four 'MAP\_U\_ABORT\_req' states lead to a 'NULL' state. + +**Figure 25.3.2/2 (sheet 2 of 2): Process Authentication\_Failure\_Report\_GLR** + +## 25.4 Short Message Alert procedures + +### 25.4.1 Subscriber\_Present\_GLR\_AS\_VLR process + +The Subscriber\_Present\_GLR\_AS\_VLR process is invoked by the GLR, when GLR receives Update Location from VLR and the MNRF flag is set. The general description of the short message alert procedures is in the subclause 23.3. + +The GLR sends the MAP\_READY\_FOR\_SM request to the HLR and waits for the HLR to answer. When receiving the answer, the GLR will act as follows: + +- the MNRF flag is cleared if the procedure is successful; +- the MNRF flag is not cleared if the procedure is not successful. + +The Subscriber\_Present\_GLR\_AS\_VLR process is shown in the figure 25.4/1. + +#### Process Subscriber\_Present\_GLR\_AS\_VLR + +25.4.1(1) + +Figure 25.4/1: The short message alert process in the GLR for mobile present situation + +![Flowchart for Process Subscriber_Present_GLR_AS_VLR. It starts with a decision 'MNRF set'. If 'No', it goes to an 'Error' state. If 'Yes', it sends 'MAP_OPEN_req', 'MAP_READY_FOR_SM_req', and 'MAP_DELIMITER_req', then receives 'Open_cnf' (Section 25.1). It then checks 'WF RESPONSE'. If 'OK', it sends 'MAP_READY_FOR_SM_rsp' and 'MAP_P_ABORT_ind', 'MAP_U_ABORT_ind', 'MAP_CLOSE_ind', then checks for 'Error'. If 'Error' is 'Yes', it goes to 'Error'; if 'No', it 'Clear MNRF' and goes to 'V1'. If 'WF RESPONSE' is 'Error', it goes to 'Error'. If 'Error' is 'Yes', it goes to 'Error'; if 'No', it 'Clear MNRF' and goes to 'V1'.](eefcb3f73fb33cce57cd04109c81506f_img.jpg) + +``` +graph TD; Start([ ]) --> MNRF{MNRF set}; MNRF -- No --> Error1[Error]; MNRF -- Yes --> Req["MAP_OPEN_req
MAP_READY_FOR_SM_req
MAP_DELIMITER_req"]; Req --> OpenCnf["Receive_Open_cnf
Section 25.1"]; OpenCnf --> WF{WF RESPONSE}; WF -- OK --> Rsp["MAP_READY_FOR_SM_rsp"]; Rsp --> Ind["MAP_P_ABORT_ind
MAP_U_ABORT_ind
MAP_CLOSE_ind"]; Ind --> Error2{Error}; Error2 -- Yes --> Error3[Error]; Error2 -- No --> ClearMNRF[Clear MNRF]; ClearMNRF --> V1[V1]; WF -- Error --> Error4[Error]; Error4 -- Yes --> Error5[Error]; Error4 -- No --> ClearMNRF2[Clear MNRF]; ClearMNRF2 --> V2[V1]; +``` + +Flowchart for Process Subscriber\_Present\_GLR\_AS\_VLR. It starts with a decision 'MNRF set'. If 'No', it goes to an 'Error' state. If 'Yes', it sends 'MAP\_OPEN\_req', 'MAP\_READY\_FOR\_SM\_req', and 'MAP\_DELIMITER\_req', then receives 'Open\_cnf' (Section 25.1). It then checks 'WF RESPONSE'. If 'OK', it sends 'MAP\_READY\_FOR\_SM\_rsp' and 'MAP\_P\_ABORT\_ind', 'MAP\_U\_ABORT\_ind', 'MAP\_CLOSE\_ind', then checks for 'Error'. If 'Error' is 'Yes', it goes to 'Error'; if 'No', it 'Clear MNRF' and goes to 'V1'. If 'WF RESPONSE' is 'Error', it goes to 'Error'. If 'Error' is 'Yes', it goes to 'Error'; if 'No', it 'Clear MNRF' and goes to 'V1'. + +Figure 25.4/1: Process Subscriber\_Present\_GLR\_AS\_VLR + +### 25.4.2 The Mobile Subscriber is present + +When GLR receives Update GPRS Location from SGSN, while the MS not reachable for GPRS (MNRG) flag is set, the GLR will send the MAP\_READY\_FOR\_SM request towards the HLR. The Alert Reason is set to indicate that the mobile subscriber is present for GPRS. + +When receiving the answer, the GLR will act as follows: + +- MNRG is cleared if the procedure is successful. +- MNRG is not cleared if the procedure is not successful. + +The Subscriber\_Present\_GLR\_AS\_SGSN process is shown in the figure 25.4/2. + +#### Process Subscriber\_Present\_GLR\_AS\_SGSN + +25.4.2(1) + +Figure 25.4/2: The short message alert process in the GLR for mobile present situation + +![Flowchart for Process Subscriber_Present_GLR_AS_SGSN. It starts with a decision 'MNRG set'. If 'No', it ends. If 'Yes', it sends 'MAP_OPEN_req', 'MAP_READY_FOR_SM_req', and 'MAP_DELIMITER_req', then receives 'Open_cnf' (Section 25.1). It then checks 'WF RESPONSE'. If 'Error', it ends. If 'V1', it performs 'MAP_V1_Dialogue' and ends. If 'OK', it receives 'MAP_READY_FOR_SM_rsp'. It then checks 'Error'. If 'Yes', it ends. If 'No', it performs 'Clear MNRG' and ends. There is also a branch for 'MAP_P_ABORT_ind', 'MAP_U_ABORT_ind', and 'MAP_CLOSE_ind'.](8aafdc3df2af4882f3c1b5e1e7e8dc8a_img.jpg) + +``` +graph TD; Start([ ]) --> MNRG_set{MNRG set}; MNRG_set -- No --> End1(( )); MNRG_set -- Yes --> SendReq[MAP_OPEN_req +MAP_READY_FOR_SM_req +MAP_DELIMITER_req]; SendReq --> ReceiveOpenCnf[Receive Open_cnf]; ReceiveOpenCnf -- Section 25.1 --> WF_RESPONSE{WF RESPONSE}; WF_RESPONSE -- Error --> End2(( )); WF_RESPONSE -- V1 --> PerformMAPV1[Perform MAP_V1_Dialogue]; PerformMAPV1 --> End3(( )); WF_RESPONSE -- OK --> ReceiveReadyRsp[MAP_READY_FOR_SM_rsp]; ReceiveReadyRsp --> ErrorDecision{Error}; ErrorDecision -- Yes --> End4(( )); ErrorDecision -- No --> ClearMNRG[Clear MNRG]; ClearMNRG --> End5(( )); ClearMNRG --> SendInd[MAP_P_ABORT_ind +MAP_U_ABORT_ind +MAP_CLOSE_ind]; SendInd --> End6(( )); +``` + +Flowchart for Process Subscriber\_Present\_GLR\_AS\_SGSN. It starts with a decision 'MNRG set'. If 'No', it ends. If 'Yes', it sends 'MAP\_OPEN\_req', 'MAP\_READY\_FOR\_SM\_req', and 'MAP\_DELIMITER\_req', then receives 'Open\_cnf' (Section 25.1). It then checks 'WF RESPONSE'. If 'Error', it ends. If 'V1', it performs 'MAP\_V1\_Dialogue' and ends. If 'OK', it receives 'MAP\_READY\_FOR\_SM\_rsp'. It then checks 'Error'. If 'Yes', it ends. If 'No', it performs 'Clear MNRG' and ends. There is also a branch for 'MAP\_P\_ABORT\_ind', 'MAP\_U\_ABORT\_ind', and 'MAP\_CLOSE\_ind'. + +Figure 25.4/2: Process Subscriber\_Present\_GLR\_AS\_SGSN + +# Annex A (informative): Change history + +| TSG CN# | Spec | CR | | New Version | Subject/Comment | +|---------|--------|-------|---------|-------------|----------------------------------------------------------| +| CN#07 | 29.120 | | R99 | 3.0.0 | Approved at TSGN#07 | +| CN#09 | 29.120 | 001r1 | R99 | 3.1.0 | Changes to support Authentication Failure Report for GLR | +| CN#09 | 29.120 | 002 | Rel-4 | 4.0.0 | Changes to support secure transport MAP for GLR | +| CN#16 | 29.120 | | Rel-5 | 5.0.0 | Rel-5 created after CN#16 | +| CN#26 | 29.120 | | Rel-6 | 6.0.0 | Rel-6 created after CN#26 | +| CT#36 | 29.120 | | Rel-7 | 7.0.0 | Upgraded unchanged from Rel-6 | +| CT#42 | 29.120 | | Rel-8 | 8.0.0 | Upgraded unchanged from Rel-7 | +| 2009-12 | 29.120 | - | Rel-9 | 9.0.0 | Update to Rel-9 version (MCC) | +| 2011-03 | 29.120 | - | Rel-10 | 10.0.0 | Update to Rel-10 version (MCC) | +| 2012-09 | 29.120 | - | Rel-11 | 11.0.0 | Update to Rel-11 version (MCC) | +| 2014-09 | 29.120 | - | Rel-12 | 12.0.0 | Update to Rel-12 version (MCC) | +| 2015-12 | 29.120 | - | Rel-13 | 13.0.0 | Update to Rel-13 version (MCC) | +| 2017-03 | 29.120 | - | Rel-14 | 14.0.0 | Update to Rel-14 version (MCC) | +| 2018-06 | 29.120 | - | Rel-15 | 15.0.0 | Update to Rel-15 version (MCC) | +| 2020-07 | 29.120 | - | Rel-16 | 16.0.0 | Update to Rel-16 version (MCC) | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29128/5a4e62bead259c258d069fd3663ea670_img.jpg b/marked/Rel-16/29_series/29128/5a4e62bead259c258d069fd3663ea670_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8bcc2df56d7db4480301a652111a85a1cee11349 --- /dev/null +++ b/marked/Rel-16/29_series/29128/5a4e62bead259c258d069fd3663ea670_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8e1e807fc4d0e5af55e43b6d94e9764517fbbe3293e9def25caf33979fe628cd +size 37191 diff --git a/marked/Rel-16/29_series/29128/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-16/29_series/29128/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2ddebc8ee86d963a4c98d53d85b99b5cddd680c4 --- /dev/null +++ b/marked/Rel-16/29_series/29128/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:647a5d0604f30cb4786b39f10f4a9d564d3a92a2bd253cfcee5ebee57fae242c +size 9476 diff --git a/marked/Rel-16/29_series/29128/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-16/29_series/29128/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..61c375b32f50760002da25c15934846f359a8e51 --- /dev/null +++ b/marked/Rel-16/29_series/29128/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8a7bc24d9833bf425a174100f0293fd3e8400b94d8f0296abfe515c23b79615e +size 6220 diff --git a/marked/Rel-16/29_series/29128/raw.md b/marked/Rel-16/29_series/29128/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..13b42173e169351274a8609277ec4b2a7e9088ba --- /dev/null +++ b/marked/Rel-16/29_series/29128/raw.md @@ -0,0 +1,2116 @@ + + +# 3GPP TS 29.128 V16.6.0 (2022-12) + +*Technical Specification* + +**3rd Generation Partnership Project; +Technical Specification Group Core Network and Terminals; +Mobility Management Entity (MME) and Serving GPRS Support +Node (SGSN) interfaces for interworking with packet data +networks and applications +(Release 16)** + +![LTE Advanced Pro logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for LTE Advanced Pro. It features the word "lte" in a bold, lowercase font. Above the "e" is a green signal icon with three bars. To the right of the signal icon, the words "Advanced" and "Pro" are stacked vertically in a smaller font. A small "TM" trademark symbol is located at the bottom right of the "lte" text. + +LTE Advanced Pro logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo. It consists of the letters "3GPP" in a stylized, bold font. The "3" and "G" are connected at the top. Below the "P" is a red signal icon with three bars. Below the logo, the text "A GLOBAL INITIATIVE" is written in a smaller, all-caps font. A small "TM" trademark symbol is located at the bottom right of the "P" in "3GPP". + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +# **3GPP** + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + +--- + + + +# --- ***Copyright Notification*** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|-------------------------------------------------------|----| +| Foreword ..... | 6 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions and abbreviations ..... | 9 | +| 3.1 Definitions..... | 9 | +| 3.2 Abbreviations ..... | 9 | +| 4 General Description ..... | 9 | +| 4.1 Introduction ..... | 9 | +| 5 Procedures Description ..... | 11 | +| 5.1 Introduction ..... | 11 | +| 5.2 Report Procedures ..... | 11 | +| 5.2.1 General ..... | 11 | +| 5.2.2 Detailed Behaviour of the MME/SGSN ..... | 12 | +| 5.2.2.0 General..... | 12 | +| 5.2.2.1 UE Loss of Connectivity..... | 12 | +| 5.2.2.2 UE Reachability..... | 13 | +| 5.2.2.3 Location Reporting ..... | 13 | +| 5.2.2.4 Communication Failure ..... | 13 | +| 5.2.2.5 Availability after DDN failure..... | 13 | +| 5.2.2.6 Idle Status Indication ..... | 13 | +| 5.2.2.7 PDN Connectivity Status ..... | 14 | +| 5.2.3 Detailed Behaviour of the SCEF ..... | 14 | +| 5.2.4 Detailed Behaviour of the IWK-SCEF ..... | 14 | +| 5.3 Event Configuration Procedure ..... | 14 | +| 5.3.1 General ..... | 14 | +| 5.3.2 Detailed Behaviour of the MME/SGSN ..... | 15 | +| 5.3.3 Detailed Behaviour of the IWK-SCEF ..... | 16 | +| 5.4 Event Configuration Procedure for Roaming..... | 16 | +| 5.4.1 General ..... | 16 | +| 5.4.2 Detailed Behaviour of the IWK-SCEF ..... | 17 | +| 5.4.3 Detailed Behaviour of the MME/SGSN ..... | 17 | +| 5.5 MO-Data Procedure ..... | 18 | +| 5.5.1 General ..... | 18 | +| 5.5.2 Detailed Behaviour of the MME/SGSN ..... | 19 | +| 5.5.3 Detailed Behaviour of the SCEF ..... | 19 | +| 5.5.4 Detailed Behaviour of the IWK-SCEF ..... | 20 | +| 5.6 MT Data Procedure ..... | 20 | +| 5.6.1 General ..... | 20 | +| 5.6.2 Detailed Behaviour of the SCEF ..... | 21 | +| 5.6.3 Detailed Behaviour of the MME/SGSN ..... | 21 | +| 5.6.4 Detailed Behaviour of the IWK-SCEF ..... | 22 | +| 5.7 Connection Management by MME/SGSN Procedure. .... | 22 | +| 5.7.1 General ..... | 22 | +| 5.7.2 Detailed Behaviour of the MME/SGSN ..... | 24 | +| 5.7.3 Detailed Behaviour of the SCEF ..... | 25 | +| 5.7.4 Detailed Behaviour of the IWK-SCEF ..... | 26 | +| 5.8 Connection Management by SCEF Procedure..... | 26 | +| 5.8.1 General..... | 26 | +| 5.8.2 Detailed Behaviour of the SCEF ..... | 27 | +| 5.8.3 Detailed Behaviour of the MME/SGSN ..... | 27 | +| 5.8.4 Detailed Behaviour of the IWK-SCEF ..... | 28 | +| 6 Protocol Specification and Implementation..... | 28 | +| 6.1 Introduction ..... | 28 | + +| | | | +|----------|---------------------------------------------------------------------------|----| +| 6.1.1 | Use of Diameter Base Protocol ..... | 28 | +| 6.1.2 | Securing Diameter Messages ..... | 28 | +| 6.1.3 | Accounting Functionality ..... | 28 | +| 6.1.4 | Use of Sessions ..... | 28 | +| 6.1.5 | Transport Protocol ..... | 29 | +| 6.1.6 | Routing Considerations ..... | 29 | +| 6.1.6.1 | Routing Considerations for Monitoring Event related Requests ..... | 29 | +| 6.1.6.2 | Routing Considerations for Non-IP Data Related Requests ..... | 29 | +| 6.1.6.3 | Handling of the Vendor-Specific-Application-Id AVP ..... | 30 | +| 6.1.7 | Advertising Application Support ..... | 30 | +| 6.1.8 | Diameter Application Identifier ..... | 30 | +| 6.1.9 | Use of the Supported-Features AVP ..... | 30 | +| 6.2 | Commands ..... | 31 | +| 6.2.1 | Introduction ..... | 31 | +| 6.2.2 | Command-Code values ..... | 31 | +| 6.2.3 | Configuration Information Request (CIR) Command ..... | 31 | +| 6.2.4 | Configuration-Information-Answer (CIA) Command ..... | 32 | +| 6.2.5 | Reporting-Information-Request (RIR) Command ..... | 32 | +| 6.2.6 | Reporting-Information-Answer (RIA) Command ..... | 33 | +| 6.2.7 | Connection-Management-Request (CMR) Command ..... | 34 | +| 6.2.8 | Connection-Management-Answer (CMA) Command ..... | 34 | +| 6.2.9 | MO-Data-Request (ODR) Command ..... | 35 | +| 6.2.10 | MO-Data-Answer (ODA) Command ..... | 35 | +| 6.2.11 | MT-Data-Request (TDR) Command ..... | 36 | +| 6.2.12 | MT-Data-Answer (TDA) Command ..... | 36 | +| 6.3 | Result-Code AVP and Experimental-Result AVP Values ..... | 37 | +| 6.3.1 | General ..... | 37 | +| 6.3.2 | Success ..... | 37 | +| 6.3.3 | Permanent Failures ..... | 37 | +| 6.3.3.1 | DIAMETER_ERROR_UNAUTHORIZED_REQUESTING_ENTITY (5510) ..... | 37 | +| 6.3.3.2 | DIAMETER_ERROR_UNAUTHORIZED_SERVICE (5511) ..... | 37 | +| 6.3.3.3 | DIAMETER_ERROR_CONFIGURATION_EVENT_STORAGE_NOT_SUCCESSFUL
(5513) ..... | 37 | +| 6.3.3.4 | DIAMETER_ERROR_CONFIGURATION_EVENT_NON_EXISTANT (5514) ..... | 38 | +| 6.3.3.5 | DIAMETER_ERROR_REQUESTED_LOCATION_NOT_SERVED (5650) ..... | 38 | +| 6.3.3.6 | DIAMETER_ERROR_USER_UNKNOWN (5001) ..... | 38 | +| 6.3.3.7 | DIAMETER_ERROR_OPERATION_NOT_ALLOWED (5101) ..... | 38 | +| 6.3.3.8 | DIAMETER_ERROR_INVALID_EPS_BEARER (5651) ..... | 38 | +| 6.3.3.9 | DIAMETER_ERROR_NIDD_CONFIGURATION_NOT_AVAILABLE (5652) ..... | 38 | +| 6.3.3.10 | DIAMETER_ERROR_SCEF_REFERENCE_ID_UNKNOWN (5515) ..... | 38 | +| 6.3.3.11 | DIAMETER_ERROR_USER_TEMPORARILY_UNREACHABLE (5653) ..... | 38 | +| 6.3.3.12 | DIAMETER_ERROR_UNREACHABLE_USER (4221) ..... | 38 | +| 6.4 | AVPs ..... | 38 | +| 6.4.1 | General ..... | 38 | +| 6.4.2 | Monitoring-Event-Configuration ..... | 42 | +| 6.4.3 | Monitoring-Event-Report ..... | 42 | +| 6.4.4 | Communication-Failure-Information ..... | 43 | +| 6.4.5 | Cause-Type ..... | 43 | +| 6.4.6 | SIAP-Cause ..... | 44 | +| 6.4.7 | RANAP-Cause ..... | 44 | +| 6.4.8 | BSSGP-Cause ..... | 44 | +| 6.4.9 | GMM-Cause ..... | 44 | +| 6.4.10 | SM-Cause ..... | 44 | +| 6.4.11 | Number-Of-UE-Per-Location-Configuration ..... | 44 | +| 6.4.12 | Number-Of-UE-Per-Location-Report ..... | 44 | +| 6.4.13 | UE-Count ..... | 45 | +| 6.4.14 | Feature-List AVP ..... | 45 | +| 6.4.14.1 | Feature-List AVP for the T6a/T6b application ..... | 45 | +| 6.4.15 | DRMP ..... | 45 | +| 6.4.16 | User-Identifier ..... | 46 | +| 6.4.17 | Bearer-Identifier ..... | 46 | +| 6.4.18 | Connection-Action ..... | 46 | + +| | | | +|-------------------------------|--------------------------------------------------|-----------| +| 6.4.19 | Non-IP-Data ..... | 46 | +| 6.4.20 | Service-Selection ..... | 46 | +| 6.4.21 | Serving-PLMN-Rate-Control ..... | 46 | +| 6.4.22 | Downlink-Rate-Limit ..... | 47 | +| 6.4.23 | Uplink-Rate-Limit ..... | 47 | +| 6.4.24 | SCEF-Wait-Time ..... | 47 | +| 6.4.25 | CMR-Flags ..... | 47 | +| 6.4.26 | Extended-PCO ..... | 47 | +| 6.4.27 | RRC-Cause-Counter ..... | 47 | +| 6.4.28 | Counter-Value ..... | 47 | +| 6.4.29 | RRC-Counter-Timestamp ..... | 48 | +| 6.4.30 | Terminal-Information ..... | 48 | +| 6.4.31 | TDA-Flags ..... | 48 | +| 6.4.32 | Idle-Status-Indication ..... | 48 | +| 6.4.33 | Idle-Status-Timestamp ..... | 49 | +| 6.4.34 | Active-Time ..... | 49 | +| 6.4.35 | Reachability-Cause ..... | 49 | +| 6.4.36 | APN-Rate-Control-Status ..... | 50 | +| 6.4.37 | Uplink-Number-Of-Packets-Allowed ..... | 50 | +| 6.4.38 | Number-Of-Additional-Exception-Reports ..... | 50 | +| 6.4.39 | Downlink-Number-Of-Packets-Allowed ..... | 50 | +| 6.4.40 | APN-Rate-Control-Status-Validity-Time ..... | 50 | +| A.1 | T6a/b and T7 interfaces ..... | 50 | +| A.1.1 | General ..... | 50 | +| A.1.2 | SCEF behaviour ..... | 50 | +| A.1.3 | MME/SGSN behaviour ..... | 51 | +| A.1.4 | IWK-SCEF behaviour ..... | 51 | +| Annex B (normative): | Diameter message priority mechanism ..... | 51 | +| B.1 | General ..... | 51 | +| B.2 | T6a, T6ai, T6b, T6bi, T7 interfaces ..... | 51 | +| Annex C (normative): | Diameter load control mechanism ..... | 52 | +| C.1 | General ..... | 52 | +| C.2 | SCEF behaviour ..... | 52 | +| C.3 | MME/SGSN behaviour ..... | 53 | +| C.4 | IWK-SCEF behaviour ..... | 53 | +| Annex D (informative): | Change history ..... | 54 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document describes the Diameter-based interfaces between the SCEF/IWK-SCEF and other network entities such as MME/SGSN for the Architecture enhancements to facilitate communications with packet data networks and applications. + +In particular, this document specifies the T6a interface between the MME and the SCEF, the T6ai interface between the MME and the IWK-SCEF, the T6b interface between the SGSN and the SCEF, the T6bi interface between the SGSN and the SCEF and the T7 interface between the SCEF and the IWK-SCEF. The procedures over those interfaces are defined in 3GPP TS 23.682 [2]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.682: "Architecture enhancements to facilitate communications with packet data networks and applications ". +- [3] Void. +- [4] 3GPP TS 29.229: "Cx and Dx interfaces based on the Diameter protocol; protocol details ". +- [5] 3GPP TS 29.336: "Home Subscriber Server (HSS) diameter interfaces for interworking with packet data networks and applications". +- [6] 3GPP TS 29.228: "IP multimedia (IM) Subsystem Cx Interface; Signalling flows and Message Elements". +- [7] IETF RFC 4960: "Stream Control Transport Protocol". +- [8] IETF RFC 5234: "Augmented BNF for Syntax Specifications: ABNF". +- [9] IETF RFC 7683: "Diameter Overload Indication Conveyance". +- [10] 3GPP TS 29.212: "Policy and Charging Control (PCC); Reference points". +- [11] 3GPP TS 25.413: "UTRAN Iu interface Radio Access Network Application Part (RANAP) signalling". + +- [12] 3GPP TS 24.008: "Mobile Radio Interface Layer 3 specification; Core Network Protocols; Stage 3". +- [13] 3GPP TS 36.413: "Evolved Universal Terrestrial Radio Access Network (E-UTRAN); S1 Application Protocol (S1AP)". +- [14] 3GPP TS 48.018: "General Packet Radio Service (GPRS); Base Station System (BSS) - Serving GPRS Support Node (SGSN); BSS GPRS protocol (BSSGP)". +- [15] IETF RFC 7944: "Diameter Routing Message Priority". +- [16] 3GPP TS 29.272: "Mobility Management Entity (MME) and Serving GPRS Support Node (SGSN) related interfaces based on Diameter protocol". +- [17] 3GPP TS 29.329: "Sh Interface based on the Diameter protocol; Protocol details". +- [18] Void. +- [19] 3GPP TS 23.007: "Restoration procedures". +- [20] 3GPP TS 32.299: "Telecommunication management; Charging management; Diameter charging applications". +- [21] IETF RFC 5778: "Diameter Mobile IPv6: Support for Home Agent to Diameter Server Interaction". +- [22] 3GPP TS 32.299: "Telecommunication management; Charging management; Diameter charging applications". +- [23] 3GPP TS 32.253: "Telecommunication management; Charging management; Control Plane (CP) data transfer domain charging". +- [24] 3GPP TS 23.003: "Numbering, addressing and identification". +- [25] 3GPP TS 23.401: "GPRS enhancements for E-UTRAN access". +- [26] 3GPP TS 29.172: "Location Services (LCS); Evolved Packet Core (EPC) LCS Protocol (ELP) between the Gateway Mobile Location Centre (GMLC) and the Mobile Management Entity (MME); SLg interface". +- [27] 3GPP TS 29.338: "Diameter based protocols to support SMS capable MMEs". +- [28] 3GPP TS 24.301: "Non-Access-Stratum (NAS) protocol for Evolved Packet System (EPS); Stage 3". +- [29] 3GPP TS 29.061: "Interworking between the Public Land Mobile Network (PLMN) supporting packet based services and Packet Data Networks (PDN)". +- [30] 3GPP TS 32.298: "Telecommunication Management; Charging Management; Charging Data Record (CDR) parameter description". +- [31] IETF RFC 8583: "Diameter Load Information Conveyance". +- [32] IETF RFC 6733: "Diameter Base Protocol". +- [33] 3GPP TS 29.274: " Evolved General Packet Radio Service (GPRS) Tunnelling Protocol for Control plane (GTPv2-C)". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|----------|--------------------------------------| +| DRMP | Diameter Routing Message Priority | +| DSCP | Differentiated Services Code Point | +| SCEF | Service Capability Exposure Function | +| IWK-SCEF | Interworking - SCEF | + +# --- 4 General Description + +## 4.1 Introduction + +The T6a/b reference point between the MME/SGSN and the SCEF, the T6ai/bi reference point between the MME/SGSN in the VPLMN and the IWK-SCEF and the T7 reference point between the IWK-SCEF and the SCEF are defined in the 3GPP TS 23.682 [2]. + +This document describes the Diameter-based T6a/b, T6ai/bi and T7 related procedures, message parameters and protocol specification. + +An excerpt of the 3GPP Architecture for the enhancements to facilitate communications with packet data networks and applications, as defined in 3GPP TS 23.682 [2] is shown in Figure 4.1-1, where the relevant interfaces towards the SCEF/IWK-SCEF are highlighted. + +![Diagram of 3GPP Architecture for enhancements to facilitate communications with packet data networks and applications. The diagram shows two network domains: HPLMN (Home PLMN) and VPLMN (Visited PLMN), separated by a dashed orange line. In the HPLMN, there is an HSS at the top, an MME/SGSN on the left, and an SCEF on the right. In the VPLMN, there is an MME/SGSN on the left and an IWK-SCEF on the right. Interfaces are labeled: S6a/d (between HSS and MME/SGSN in HPLMN), S6t (between HSS and SCEF in HPLMN), T6a/b (between MME/SGSN and SCEF in HPLMN), T6ai/T6bi (between MME/SGSN in VPLMN and IWK-SCEF in VPLMN), and T7 (between SCEF in HPLMN and IWK-SCEF in VPLMN).](5a4e62bead259c258d069fd3663ea670_img.jpg) + +Diagram of 3GPP Architecture for enhancements to facilitate communications with packet data networks and applications. The diagram shows two network domains: HPLMN (Home PLMN) and VPLMN (Visited PLMN), separated by a dashed orange line. In the HPLMN, there is an HSS at the top, an MME/SGSN on the left, and an SCEF on the right. In the VPLMN, there is an MME/SGSN on the left and an IWK-SCEF on the right. Interfaces are labeled: S6a/d (between HSS and MME/SGSN in HPLMN), S6t (between HSS and SCEF in HPLMN), T6a/b (between MME/SGSN and SCEF in HPLMN), T6ai/T6bi (between MME/SGSN in VPLMN and IWK-SCEF in VPLMN), and T7 (between SCEF in HPLMN and IWK-SCEF in VPLMN). + +**Figure 4.1-1: 3GPP Architecture for the enhancements to facilitate communications with packet data networks and applications** + +In this architecture, the T6a/b reference point connects the MME/SGSN with the SCEF. + +The T6a/b interface shall allow the SCEF: + +- to receive reports of the monitoring events from the MME/SGSN configured via an HSS; +- to configure the monitoring events at an MME/SGSN which are not UE related in the non roaming cases; +- to manage a connection between the MME and the SCEF on T6a; +- to send MT data on T6a; +- to receive MO data on T6a. + +The T6ai/bi reference point connects the MME/SGSN with the IWK-SCEF in the visited network, if the IWK-SCEF is deployed. + +The T6ai/bi interface shall allow the IWK-SCEF to: + +- to receive configuration of the monitoring events from the MME or the SGSN and perform a filtering of the services which are allowed for this subscriber in this visited network based on roaming policies; +- to receive reports of the monitoring events from the MME/SGSN that are configured via an HSS, perform a filtering and forward them to the SCEF (in the home network which has configured the event) via the T7 reference point; +- to receive MO data on T6ai/bi and forward them to the SCEF; +- to receive MT data and forward them to the MME on T6ai/bi; +- to manage a connection between MME/SGSN and IWK-SCEF on T6ai/bi and forward connection management commands to the SCEF. + +The T7 reference point connects the IWK-SCEF in the visited network with the SCEF in the home network. + +The T7 interface shall allow the IWK-SCEF to: + +- to forward reports received on T6ai/bi to the SCEF indicated in the event report received on T6ai/T6bi; +- to receive MO data on T6ai/bi and forward them to the SCEF on T7; +- to receive MT data on T7 and forward them to the MME/SGSN; +- to manage connection between the SCEF and the IWK-SCEF on T7 and forward connection management commands to the MME/SGSN. + +# --- 5 Procedures Description + +## 5.1 Introduction + +This clause describes the Diameter-based T6a, T6b, T6ai, T6bi and T7 interface related procedures and the Information elements exchanged between the functional entities. + +In the tables that describe the Information Elements transported by each Diameter command, each Information Element is marked as (M) Mandatory, (C) Conditional or (O) Optional in the "Cat." column. For the correct handling of the Information Element according to the category type, see the description detailed in clause 6 of the 3GPP TS 29.228 [6]. + +## 5.2 Report Procedures + +### 5.2.1 General + +This procedure is used between the MME/SGSN and the SCEF, between the MME/SGSN and the IWK-SCEF and between the IWK-SCEF and the SCEF. + +When the procedure is invoked by the MME or the SGSN, it is used for reporting: + +- UE Loss of Connectivity; +- UE Reachability; +- Location of the UE and change in location of the UE; +- Communication Failure; +- Availability after DNN failure; +- Idle Status Indication; +- PDN Connectivity Status. + +When the procedure is invoked by the IWK-SCEF, it is used for conveying the monitoring event reported by the MME or the SGSN to the SCEF, after applying the roaming policies configured at the IWK-SCEF. + +This procedure is mapped to the commands Reporting-Information-Request/Answer in the Diameter application specified in clause 6. The tables 5.2.1-1 and 5.2.1-2 detail the involved information elements. + +**Table 5.2.1-1: Reporting Information Request** + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------------------------|-------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| User Identity
(See 6.4.16) | User-Identifier | C | If present, this information element shall contain the identity of the UE. This is a grouped AVP containing the MSISDN or the External-Identifier. | +| Monitoring Event Report
(see 3GPP TS 29.336 [5] clause 8.4.3) | Monitoring-Event-Report | C | If the Reporting-Information-Request is sent for reporting the monitoring events, the MME/SGSN and the IWK-SCEF shall include the monitoring event(s) reported towards the SCEF. | +| Supported Features
(See 3GPP TS 29.229 [4]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | + +**Table 5.2.1-2: Reporting Information Answer** + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|-----------------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result
(See 6.3) | Result-Code / Experimental-Result | M | Result of the request.
Result-Code AVP shall be used for errors defined in the Diameter Base Protocol.
Experimental-Result AVP shall be used for T6a/b errors. This is a grouped AVP, which contains the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | +| Supported Features
(See 3GPP TS 29.229 [4]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Monitoring Event Report Status | Monitoring-Event-Report-Status | O | If present, this information element shall contain the status of each individual monitoring event report received by the SCEF from the MME/SGSN. | + +### 5.2.2 Detailed Behaviour of the MME/SGSN + +#### 5.2.2.0 General + +The MME/SGSN shall fill the Monitoring-Event-Report AVP according to the event reported as specified below. For all monitoring events, the SCEF-ID, the SCEF-Reference-ID/SCEF-Reference-ID-Ext and the Monitoring-Type AVPs shall be included. In addition, the event specific AVPs as listed below shall be included based on the type of event reported. + +The MME/SGSN shall include the External-Identifier or the MSISDN if present in the subscription data received from the HSS. + +If the MME/SGSN receives an Experimental-Result-Code set to DIAMETER\_ERROR\_SCEF\_REFERENCE\_ID\_UNKNOWN within an RIA command, it shall delete the event stored for the indicated SCEF-ID and SCEF-Reference-ID/SCEF-Reference-ID-Ext (see 3GPP TS 23.007 [19]). + +#### 5.2.2.1 UE Loss of Connectivity + +The following AVPs shall be present within the Monitoring-Event-Report AVP when the UE Loss of Connectivity event is reported: + +- Monitoring-Type set to LOSS\_OF\_CONNECTIVITY (0) + +The following AVPs may be present within the Monitoring-Event-Report AVP when the UE Loss of Connectivity event is reported: + +- Loss-Of-Connectivity-Reason set to one of the values defined in 3GPP TS 29.336 [5] + +#### 5.2.2.2 UE Reachability + +The following AVPs shall be present within the Monitoring-Event-Report AVP when the UE Reachability event is reported: + +- Monitoring-Type set to either UE\_REACHABILITY (1) or UE\_REACHABILITY\_AND\_IDLE\_STATUS\_INDICATION (8), as received in the configuration request. +- Reachability-Information set to REACHABLE\_FOR\_DATA(1) + +The following AVPs may be present within the Monitoring-Event-Report AVP when the UE Reachability event is reported: + +- Maximum-UE-Availability-Time +- Reachability-Cause + +NOTE: When the Monitoring-Type is UE\_REACHABILITY\_AND\_IDLE\_STATUS\_INDICATION (8), absence of the Idle-Status-Indication AVP from the Monitoring-Event-Report AVP indicates that UE reachability is reported. + +#### 5.2.2.3 Location Reporting + +The following AVPs shall be present within the Monitoring-Event-Report AVP when the location event is reported: + +- Monitoring-Type set to LOCATION\_REPORTING (2) +- EPS-Location-Information + +#### 5.2.2.4 Communication Failure + +The following AVPs shall be present within the Monitoring-Event-Report AVP when the Communication Failure event is reported + +- Monitoring-Type set to COMMUNICATION\_FAILURE (5) +- Communication-Failure-Information (see clause 6.4.3) + +#### 5.2.2.5 Availability after DDN failure + +The following AVPs shall be present within the Monitoring-Event-Report AVP when the Availability after DDN failure event is reported: + +- Monitoring-Type set to either AVAILABILITY\_AFTER\_DDN\_FAILURE (6) or AVAILABILITY\_AFTER\_DNN\_FAILURE\_AND\_IDLE\_STATUS\_INDICATION (9), as received in the configuration request. + +NOTE: When the Monitoring-Type is AVAILABILITY\_AFTER\_DNN\_FAILURE\_AND\_IDLE\_STATUS\_INDICATION (9), absence of the Idle-Status-Indication AVP from the Monitoring-Event-Report AVP indicates that Availability after DNN failure is reported. + +#### 5.2.2.6 Idle Status Indication + +The following AVPs shall be present within the Monitoring-Event-Report AVP when the Idle Status Indication event is reported: + +- Monitoring-Type set to UE\_REACHABILITY\_AND\_IDLE\_STATUS\_INDICATION (8) or to AVAILABILITY\_AFTER\_DDN\_FAILURE\_AND\_IDLE\_STATUS\_INDICATION (9), depending on the Monitoring-Type of the corresponding event configuration. + +- Idle-Status-Indication + +#### 5.2.2.7 PDN Connectivity Status + +The following AVPs shall be present within the Monitoring-Event-Report AVP when the PDN Connectivity Status event is reported: + +- Monitoring-Type set to PDN\_CONNECTIVITY\_STATUS (8) +- PDN-Connectivity-Status-Report + +### 5.2.3 Detailed Behaviour of the SCEF + +When the SCEF receives a Reporting Information Request from the MME/SGSN or the IWK-SCEF and at least one of the Monitoring Event Report AVPs has a SCEF-Reference-ID/SCEF-Reference-ID-Ext not known by the SCEF, it shall reply with Experimental-Result-Code set to DIAMETER\_ERROR\_SCEF\_REFERENCE\_ID\_UNKNOWN (see 3GPP TS 23.007 [19]). In that case, if the HSS had included multiple Monitoring Event Reports in the RIR command, the SCEF shall include in the Reporting Information Answer command a list of Monitoring-Event-Report-Status AVPs where the status of multiple monitoring event reports is detailed. In that AVP list, the AVPs corresponding to event reports with a successful status may be omitted by the SCEF, for efficiency. + +Otherwise when the SCEF receives a Reporting-Information-Request command from the MME/SGSN or the IWK-SCEF, the SCEF shall set Result-Code to DIAMETER\_SUCCESS in the Reporting-Information-Answer and shall handle it according to the procedures defined in 3GPP TS 23.682 [2]. + +### 5.2.4 Detailed Behaviour of the IWK-SCEF + +When the IWK-SCEF receives a Reporting-Information-Request command from the MME/SGSN it shall deliver the request to the SCEF after applying the roaming policies configured at the IWK-SCEF, as specified in 3GPP TS 23.682 [2]. + +## 5.3 Event Configuration Procedure + +### 5.3.1 General + +This procedure is used between the SCEF and the MME and between the SCEF and the SGSN to configure the monitoring events directly at the MME/SGSN through the T6a/b interface. + +When the procedure is invoked by the SCEF, it is used for configuring the event(s): + +- the number of UEs at a given geographic location. + +This procedure is mapped to the commands Configuration-Information-Request/Answer in the Diameter application specified in clause 6. The tables 5.3.1-1 and 5.3.1-2 detail the involved information elements. + +**Table 5.3.1-1: Configuration Information Request** + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|---------------------------------------------------|--------------------------------|------|-------------------------------------------------------------------------------------------------------| +| Monitoring Event Configuration (see clause 6.4.2) | Monitoring-Event-Configuration | C | If present, this Information Element shall contain the details of the Monitoring event(s) configured. | +| Supported Features (See 3GPP TS 29.229 [4]) | Supported-Features | O | If present, this Information Element shall contain the list of features supported by the origin host. | + +**Table 5.3.1-2: Configuration Information Answer** + +| Information Element Name | Mapping to Diameter AVP | Cat | Description | +|---------------------------------------------------------------------------------|--------------------------------------|-----|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result
(See 6.3) | Result-Code /
Experimental-Result | M | Result of the request.
Result-Code AVP shall be used for errors defined in the Diameter Base Protocol.
Experimental-Result AVP shall be used for T6a/T6b errors.
This is a grouped AVP which contains the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | +| Supported Features
(See 3GPP TS 29.229 [4]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Monitoring Event Report
(see 3GPP TS 29.336 [5] clause 8.4.3) | Monitoring-Event-Report | C | If an immediate report is available this information element shall contain the requested data available in the MME/SGSN. | +| Monitoring Event-Configuration Status
(see 3GPP TS 29.336 [5] clause 8.4.24) | Monitoring-Event-Config-Status | O | If present it shall contain the status of each monitoring event configuration identified by an SCEF-Reference-ID/SCEF-Reference-ID-Ext. | + +### 5.3.2 Detailed Behaviour of the MME/SGSN + +Monitoring Events configuration and deletion directly at the MME/SGSN for roaming scenarios is not supported. For the non roaming cases, when the Configuration-Information-Request is received from the SCEF, the MME/SGSN shall, in the following order: + +1. Check whether the requesting SCEF is authorized to request the specified service (e.g: number of UEs at a given geographic location). If not, Experimental-Result-Code shall be set to DIAMETER\_ERROR\_UNAUTHORIZED\_REQUESTING\_ENTITY (5510) in the Configuration-Information-Answer. +2. If the TA / RA / ECGI location requested by the SCEF is not served by the MME/SGSN, then the MME/SGSN shall set the Experimental-Result AVP to DIAMETER\_ERROR\_REQUESTED\_LOCATION\_NOT\_SERVED (5650) in the Configuration-Information-Answer. + +If there is an error in any of the above steps then the MME/SGSN shall stop processing and shall return the error code specified in the respective step. + +If the MME/SGSN cannot fulfil the received request for reasons not stated above, it shall stop processing the request and set Result-Code to DIAMETER\_UNABLE\_TO\_COMPLY. + +If CIR message includes multiple SCEF Reference IDs (either in SCEF-Reference-ID or in SCEF-Reference-ID-Ext AVPs) and for a SCEF Reference ID the monitoring events cannot be handled, the MME/SGSN shall report the failed SCEF Reference ID to the SCEF with an appropriate status in the Monitoring-Event-Config-Status AVP. + +For the number of UEs in a geographic location monitoring event, for each SCEF-Reference-ID that the MME/SGSN is able to successfully process, the MME/SGSN shall + +- if filtering is not requested (i.e. IMSI-Group-Id was not present in the request) or not supported: +include in the Configuration-Information-Answer, the exact count of the number of UEs that are known to be at the requested location. +- if filtering is requested and (i.e. IMSI-Group-Id was present in the request) and supported: +include in the Configuration-Information-Answer, the exact count of the number of UEs belonging to the provided IMSI Group that are known to be at the requested location. + +If the requested location type is current location, then the MME/SGSN may activate the paging and RAN location reporting procedures (if required) before providing the response in the Configuration-Information-Answer. + +If the monitoring event configuration is for a continuous monitoring (i.e. Monitoring-Duration and/or Maximum-Number-Of-Reports are set) and the deletion criteria are met (i.e. Monitoring-Duration time expired and/or Maximum-Number-Of-Reports are sent) the MME/SGSN shall locally delete the Monitoring event. + +### 5.3.3 Detailed Behaviour of the IWK-SCEF + +Monitoring Events configuration and deletion directly at the MME/SGSN for roaming scenarios is not supported. Consequently the IWK-SCEF is not impacted for Monitoring Events configuration and deletion directly at the MME/SGSN from the SCEF.5.3.4 Detailed Behaviour of the SCEF + +When the SCEF receives Monitoring Event Report AVP from the MME/SGSN or the IWK-SCEF in the CIA command, it shall handle it according to the procedures defined in 3GPP TS 23.682 [2]. + +When the SCEF receives a Monitoring Event Report AVP from the MME/SGSN with a SCEF-Reference-ID/SCEF-Reference-ID-Ext not known by the SCEF, it should discard the Monitoring Event Report received in CIA command. + +## 5.4 Event Configuration Procedure for Roaming + +### 5.4.1 General + +The MME/SGSN shall send the monitoring event configuration information to the IWK-SCEF in roaming scenarios, when the MME/SGSN receives the monitoring event configuration from the HSS. The monitoring event configuration information shall be locally consumed at the IWK-SCEF and the IWK-SCEF shall not route such requests beyond it. + +This procedure is mapped to the commands Configuration-Information-Request/Answer in the Diameter application specified in clause 6. The tables 5.4.1-1 and 5.4.1-2 detail the involved information elements. + +**Table 5.4.1-1: Configuration-Information-Request** + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|---------------------------------------------|--------------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Monitoring Event Configuration (see 8.4.2) | Monitoring-Event-Configuration | C | If present, this Information Element shall contain the details of Monitoring event(s). | +| Monitoring Event Report (see 8.4.3) | Monitoring-Event-Report | C | If an immediate report is available this information element shall contain the event reported by the MME/SGSN. The IWK-SCEF may normalize the event report and return it in the Configuration-Information-Answer. | +| Supported Features (See 3GPP TS 29.229 [7]) | Supported-Features | O | If present, this Information Element shall contain the list of features supported by the origin host. | + +**Table 5.4.1-2: Configuration-Information-Answer** + +| Information Element Name | Mapping to Diameter AVP | Cat | Description | +|-------------------------------------------------------------------------------------|------------------------------------------|-----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result
(See 6.3) | Result-Code /
Experimental-
Result | M | Result of the request.
Result-Code AVP shall be used for errors defined in the Diameter Base Protocol.
Experimental-Result AVP shall be used for T6a/b errors. This is a grouped AVP which contains the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | +| Supported Features
(See 3GPP TS 29.229 [7]) | Supported-
Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Monitoring Event-
Configuration Status
(see 3GPP TS 29.336 [5] clause 8.4.24) | Monitoring-Event-
Config-Status | O | If present it shall contain the status of each monitoring event configuration identified by an SCEF-Reference-ID/SCEF-Reference-ID-Ext. | + +### 5.4.2 Detailed Behaviour of the IWK-SCEF + +When the Configuration-Information-Request is received from the MME/SGSN, the IWK-SCEF shall, in the following order: + +1. Check whether the requesting SCEF, identified by the SCEF-ID is authorized to request the specified service at the VPLMN. If not, Experimental-Result shall be set to DIAMETER\_ERROR\_UNAUTHORIZED\_REQUESTING\_ENTITY (5510) in the Configuration-Information-Answer. +2. Check whether the chargeable party for the monitoring event is authorized to be charged at the VPLMN. If not, Experimental-Result shall be set to DIAMETER\_ERROR\_UNAUTHORIZED\_REQUESTING\_ENTITY (5510) in the Configuration-Information-Answer. + +If the monitoring event configuration also carries the monitoring event report, the IWK-SCEF checks if the immediate events reported by the MME/SGSN needs to be normalized. If yes, the IWK-SCEF shall normalize the event report as per local policies. The IWK-SCEF shall then send the normalized monitoring event report towards the SCEF as a separate Reporting-Information-Request message. + +If the monitoring event configuration is for a continuous monitoring (i.e. Monitoring-Duration and/or Maximum-Number-Of-Reports are set), then the IWK-SCEF shall temporarily store the monitoring event configuration until the deletion criteria for the monitoring event configuration is met. If the deletion criteria are met, the IWK-SCEF shall delete the Monitoring event locally. The stored monitoring event configuration information shall be used during subsequent monitoring event report procedure, to generate the charging records towards the right chargeable party. + +If the received SCEF Reference ID for Deletion (either in SCEF-Reference-ID-for-Deletion or in SCEF-Reference-ID-for-Deletion-Ext AVPs) does not exist, the IWK-SCEF shall set the Experimental-Result-Code to DIAMETER\_ERROR\_CONFIGURATION\_EVENT\_NON\_EXISTANT (5514). + +If the SCEF Reference ID (either in SCEF-Reference-ID or in SCEF-Reference-ID-Ext) exists and the old configuration data could not be replaced by new Configuration event data, the HSS shall set the Experimental-Result-Code to DIAMETER\_ERROR\_CONFIGURATION\_EVENT\_STORAGE\_NOT\_SUCCESSFUL (5513). + +If the IWK-SCEF cannot fulfil the received request for reasons not stated in the above, it shall stop processing the request and set Result-Code to DIAMETER\_UNABLE\_TO\_COMPLY. + +The details how to handle expiring of Monitoring events is described in 3GPP TS 23.682 [2] + +### 5.4.3 Detailed Behaviour of the MME/SGSN + +When the MME/SGSN receives the Configuration-Information-Answer from the IWK-SCEF, it shall handle it as follows: For the monitoring event configurations for which the configuration status have changed since last informed to + +the HSS, the MME/SGSN shall report the status to the HSS through a Notify-Request command as specified in clause 5.2.5 of 3GPP TS 29.272 [16]. + +## 5.5 MO-Data Procedure + +### 5.5.1 General + +This procedure shall be used between the MME/SGSN and the SCEF, between the MME/SGSN and the IWK-SCEF and between the IWK-SCEF and the SCEF. + +When the procedure is invoked by the MME or SGSN, it is used to forward mobile originated Non-IP data of a mobile user from the MME or SGSN to the SCEF. The procedure is also invoked by the MME on reception of RRC cause "MO Exception data". + +This procedure is used according to 3GPP TS 23.682 [2] clause 5.13.4. + +The IWK-SCEF may be in the path between the MME/SGSN and the SCEF for roaming cases when the IWK-SCEF is deployed by the operator of the visited PLMN. + +When the procedure is invoked by the IWK-SCEF, it is used to forward mobile originated Non-IP data received from the MME or SGSN to the SCEF. + +This procedure is mapped to the commands MO-Data-Request/Answer (ODR/ODA) in the Diameter application specified in clause 6. + +The tables 5.5.1-1 and 5.5.1-2 detail the involved information elements. + +**Table 5.5.1-1: MO Data Request** + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|-------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| User Identity
(See 6.4.16) | User-Identifier | M | This Information Element shall be present and shall contain the identity of the UE. This is a grouped AVP which shall contain the IMSI. | +| EPS Bearer Identity
(See 6.4.17) | Bearer-Identifier | M | This information element shall be present and shall contain either the identity of the EPS bearer identifying the T6a connection, or the NSAPI of the PDP context identifying the T6b connection, for the Non-IP data delivery. | +| Non IP data
(See 6.4.19) | Non-IP-Data | C | This information element shall contain the Non-IP data to be delivered to the SCEF.
This Information Element shall be present when the request conveys Non-IP data. | +| Supported Features
(See 3GPP TS 29.229 [4]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| MO Exception Data Counter
(see 6.4.27) | RR-Cause-Counter | C | The MME shall include this Information Element when MME needs to send a non-zero counter value for the MO Exception Data Counter. The timestamp in the counter shall be set with the time at which the counter value increased from 0 to 1. | + +**Table 5.5.1-2: MO Data Answer** + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|--------------------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result
(See 6.3) | Result-Code /
Experimental-Result | M | Result of the request.
Result-Code AVP shall be used for errors defined in the Diameter Base Protocol.
Experimental-Result AVP shall be used for T6a/b errors. This is a grouped AVP, which contains the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | +| Supported Features
(See 3GPP TS 29.229 [4]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | + +### 5.5.2 Detailed Behaviour of the MME/SGSN + +The MME shall make use of this procedure over a T6a connection identified by its EPS bearer identity and previously established with the SCEF to forward the Non-IP data received from the UE to the SCEF or to an IWK-SCEF when deployed for a roaming case. + +The SGSN shall make use of this procedure over a T6b connection identified by the NSAPI of the PDP context, and previously established with the SCEF, to forward the Non-IP data received from the UE to the SCEF or to an IWK-SCEF when deployed for a roaming case. + +The MME shall increment the "MO Exception data counter" by one each time the MME has received the RRC cause "MO Exception data". The MME may defer sending a MO Data command message to report a non-zero value for the MO Exception Data Counter based on local configuration. + +If the MME has sent the RRC-Cause-Counter for RRC Cause "MO Exception data" in the MO Data Request command the MME shall reset the RRC-Cause-Counter when receiving MO Data Answer command. + +When receiving a Permanent Failure Result-Code/Experimental-Result, the MME or SGSN shall initiate a PDN disconnection procedure or Detach procedure towards the UE and if the permanent failure is different from DIAMETER\_ERROR\_INVALID\_EPS\_BEARER and different from DIAMETER\_ERROR\_USER\_UNKNOWN, the MME or SGSN shall make use of the "Connection Management by MME/SGSN" Procedure (see clause 5.7) to release the T6a/b connection between the MME/SGSN and the SCEF. + +### 5.5.3 Detailed Behaviour of the SCEF + +When the SCEF receives a MO Data Request from the MME/SGSN or the IWK-SCEF, the SCEF shall, in the following order: + +- Check that the User Identity exists in the SCEF. If not, Experimental-Result shall be set to DIAMETER\_ERROR\_USER\_UNKNOWN in the MO Data Answer; +- Check if, for this user, a bearer context exists. If not, Experimental-Result shall be set to DIAMETER\_ERROR\_INVALID\_EPS\_BEARER in the MO Data Answer; +- Process the delivery of the data (if available) to the SCS/AS and/or process the RRC Cause Counter (if available). If the processing of either of them is not successful, return an appropriate Diameter error code, otherwise return a Result code set to DIAMETER\_SUCCESS to the MME/SGSN or IWK-SCEF. If the data delivery to the SCS/AS has failed due to there being no NIDD configuration context with an SCS/AS, set the Experimental-Result to DIAMETER\_ERROR\_NIDD\_CONFIGURATION\_NOT\_AVAILABLE in the MO Data Answer. + +NOTE: The Diameter Result-Code / Experimental-Result returned by the SCEF can depend on the error returned by the SCS/AS to the SCEF. The interface between the SCEF and the SCS/AS is out of scope of 3GPP. + +### 5.5.4 Detailed Behaviour of the IWK-SCEF + +When the IWK-SCEF receives a MO Data Request from the MME or SGSN, it shall forward the request to the SCEF. + +When the IWK-SCEF receives a MO Data Answer from the SCEF, it shall forward the answer to the MME or SGSN. + +## 5.6 MT Data Procedure + +### 5.6.1 General + +This procedure shall be used between the SCEF and the MME or SGSN, between the SCEF and the IWK-SCEF and between the IWK-SCEF and the MME or SGSN. + +When the procedure is invoked by the SCEF, it is used to forward mobile terminated Non-IP data of a mobile user from the SCEF to the MME or SGSN. + +This procedure is used according to 3GPP TS 23.682 [2] clause 5.13.3. + +The IWK-SCEF may be in the path between the SCEF and the MME/SGSN for roaming cases when the IWK-SCEF is deployed by the operator of the visited PLMN. + +When the procedure is invoked by the IWK-SCEF, it is used to forward mobile terminated Non-IP data received from the SCEF to the MME or SGSN. + +This procedure is mapped to the commands MT-Data-Request/Answer (TDR/TDA) in the Diameter application specified in clause 6. + +The tables 5.6.1-1 and 5.6.1-2 detail the involved information elements. + +NOTE: The corresponding message name in 3GPP TS 23.682 [2] is "NIDD Submit Request". + +**Table 5.6.1-1: MT Data Request** + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|----------------------------------------------------------|-----------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| User Identity
(See 6.4.16) | User-Identifier | M | This Information Element shall be present and shall contain the identity of the UE. This is a grouped AVP which shall contain the IMSI. | +| EPS Bearer Identity
(See 6.4.17) | Bearer-Identifier | M | This information element shall be present and shall contain either the identity of the EPS bearer identifying the T6a connection, or the NSAPI of the PDP context identifying the T6b connection, for the Non-IP data delivery. | +| Non-IP Data
(See 6.4.19) | Non-IP-Data | C | This information element shall contain the Non-IP data to be delivered to the MME or SGSN.
This Information Element shall be present when the request conveys Non-IP data. | +| SCEF Wait Time
(See 6.4.24) | SCEF-Wait-Time | O | This information element, when present, shall indicate the timestamp (in UTC) until which the SCEF expects a response. | +| Maximum Retransmission Time
(See 3GPP TS 29.338 [27]) | Maximum-Retransmission-Time | O | This information element, when present, shall indicate the maximum retransmission time (in UTC) until which the SCEF is capable to retransmit the MT Non-IP Data. | +| Supported Features
(See 3GPP TS 29.229 [4]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | + +**Table 5.6.1-2: MT Data Answer** + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------------------|--------------------------------------|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result
(See 6.3) | Result-Code /
Experimental-Result | M | This information element shall contain the Result of the request. The Result-Code AVP shall be used to indicate success or errors as defined in the Diameter Base Protocol. The Experimental-Result AVP shall be used for T6a/b errors. This is a grouped AVP, which contains the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | +| Requested Retransmission Time
(See 3GPP TS 29.338 [27]) | Requested-Retransmission-Time | O | This information element may be present if the Experimental-Result-Code is set to DIAMETER_ERROR_USER_TEMPORARILY_UNREACHABLE and the Maximum Retransmission Time information element is present in the MT Data Request. It may be included if the UE is using a power saving mechanism (such as extended idle mode DRX) and the UE is currently not reachable.

When present, this shall indicate the retransmission time (in UTC) at which the SCEF is requested to retransmit the MT Non-IP Data. The Requested Retransmission Time shall not exceed the Maximum Retransmission Time received from the SCEF. | +| Supported Features
(See 3GPP TS 29.229 [4]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| TDA Flags
(See 6.4.31) | TDA-Flags | O | This Information Element contains a bit mask. See clause 6.4.31 for the meaning of the bits and the condition for each bit to be set or not. | + +### 5.6.2 Detailed Behaviour of the SCEF + +The SCEF shall make use of this procedure over a T6a connection identified by its EPS Bearer Identity, and previously established with the MME, to forward the Non-IP data received from the SCS/AS to the MME or to an IWK-SCEF when deployed for a roaming case. + +The SCEF shall make use of this procedure over a T6b connection identified by the NSAPI of the PDP context, and previously established with the SGSN, to forward the Non-IP data received from the SCS/AS to the SGSN or to an IWK-SCEF when deployed for a roaming case. + +The SCEF shall check if a bearer context exists for the user before sending the request. + +The SCEF may include the Maximum-Retransmission-Time AVP in the MT Data Request to indicate the maximum retransmission time for when it is capable to retransmit the Non-IP Data. + +If the MT Data Answer includes the Requested-Retransmission-Time AVP, the SCEF shall retransmit the MT Non-IP Data at the requested retransmission time. + +### 5.6.3 Detailed Behaviour of the MME/SGSN + +When the MME or SGSN receives a MT Data Request from the SCEF or the IWK-SCEF, the MME or SGSN shall, in the following order: + +- Check that the User Identity exists in the MME or SGSN. If not, Experimental-Result shall be set to DIAMETER\_ERROR\_USER\_UNKNOWN in the MT Data Answer; +- Check whether, for this user, a bearer context exists. If not, Experimental-Result shall be set to DIAMETER\_ERROR\_INVALID\_EPS\_BEARER in the MT Data Answer. +- Process the data delivery to the UE and: + +- if it is successful, return a Result code set to DIAMETER\_SUCCESS to the SCEF or IWK-SCEF; in addition, if the successful delivery was acknowledged by the eNodeB, the MME/SGSN shall set the "Success Acknowledged Delivery" bit within the TDA-Flags AVP. +- return an Experimental-Result set to DIAMETER\_ERROR\_USER\_TEMPORARILY\_UNREACHABLE, if the UE is using a power saving function (e.g. extended idle mode DRX or UE Power Saving Mode as defined in 3GPP TS 23.682 [27]) and the UE is expected to not be reachable shortly or, based on MME or SGSN implementation, within the time indicated by the SCEF-Wait-Time; + +The MME or SGSN shall set the Not Reachable for NIDD flag and store the SCEF Host and Realm for which this flag is set; + +If the MT Data Request includes the Maximum-Retransmission-Time AVP, the MME or SGSN may additionally include the Requested-Retransmission-Time AVP requesting the SCEF to retransmit the Non-IP Data at a later time prior to the Maximum Retransmission Time; + +The MME or SGSN shall then update the SCEF, as specified in clause 5.7, when it detects that the UE is reachable or about to become reachable and the Not Reachable for NIDD flag is set. If the MME or SGSN included the Requested-Retransmission-Time AVP in the MT Data Answer, the MME or SGSN shall do so only if the UE becomes reachable before the Requested Retransmission Time, i.e. the MME or SGSN shall reset the Not Reachable for NIDD flag when the Requested-Retransmission-Time expires if the UE has not become reachable beforehand; + +- return an Experimental-Result set to DIAMETER\_ERROR\_UNREACHABLE\_USER, if the UE is not reachable; +- otherwise return an appropriate Diameter error code. + +### 5.6.4 Detailed Behaviour of the IWK-SCEF + +When the IWK-SCEF receives a MT Data Request from the SCEF, it shall forward the request to the MME or SGSN. + +When the IWK-SCEF receives a MT Data Answer from the MME or SGSN, it shall forward the answer to the SCEF. + +## 5.7 Connection Management by MME/SGSN Procedure. + +### 5.7.1 General + +This procedure shall be used between the MME/SGSN and the SCEF, between the MME/SGSN and the IWK-SCEF and between the IWK-SCEF and the SCEF. + +When the procedure is invoked by the MME or SGSN, it is used: + +- to establish a T6a/b connection between the MME/SGSN and the SCEF; +- to update the parameters (e.g. RAT-Type) for a T6a/b connection between the MME/SGSN and the SCEF; +- to update the status of a T6a/b connection between the MME/SGSN and the SCEF, e.g. to indicate to the SCEF that the UE has become or is about to become reachable when MT non-IP data is pending at the SCEF for a UE using a power saving function; + +This procedure is used according to 3GPP TS 23.682 [2] clause 5.13.1 and 5.13.5 and 5.13.6. The IWK-SCEF may be in the path between the MME/SGSN and the SCEF for roaming cases when the IWK-SCEF is deployed by the operator of the visited PLMN. + +When the procedure is invoked by the IWK-SCEF, it is used to forward the Connection Management Request received from the MME or SGSN to the SCEF. + +This procedure is mapped to the commands Connection-Management-Request/Answer (CMR/CMA) in the Diameter application specified in clause 6. + +The tables 5.7.1-1 and 5.7.1-2 detail the involved information elements. + +**Table 5.7.1-1: Connection Management Request** + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------------------|-------------------------------|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| User Identity
(See 6.4.16) | User-Identifier | M | This Information Element shall be present and shall contain the identity of the UE. This is a grouped AVP which shall contain the IMSI. | +| EPS Bearer Identity
(See 6.4.17) | Bearer-Identifier | M | This Information Element shall be present and shall contain either the identity of the EPS bearer identifying the T6a connection, or the NSAPI of the PDP context of the T6b connection, to which the request applies. | +| T6a/b Connection Action
(See 6.4.18) | Connection-Action | M | This Information element shall be present and shall contain a T6a/b connection management action indicating a T6a/b connection establishment or a T6a/b connection release or a T6a/b connection update. | +| APN
(See 6.4.20) | Service-Selection | C | This Information element shall contain the APN the user wants to connect to.
It shall be present if the request is for a T6a/b connection establishment. | +| Serving PLMN Rate Control
(See 6.4.21) | Serving-PLMN-Rate-Control | O | If present, this information element shall contain the Serving PLMN rate control set by the MME. | +| CMR Flags
(See 6.4.25) | CMR-Flags | O | This Information Element contains a bit mask. See clause 6.4.25 for the meaning of the bits and the condition for each bit to be set or not. | +| Maximum UE Availability Time
(See 3GPP TS 29.338 [27]) | Maximum-UE-Availability-Time | O | This information element may be included, if available, if the Connection-Action AVP indicates a T6a/b connection update and the UE-Reachable-Indicator is set in the CMR-Flags AVP.

When present, it shall indicate the timestamp (in UTC) until which a UE using a power saving mechanism (such as extended idle mode DRX) is expected to be reachable for MT Non-IP Data Delivery.
This information may be used by the SCEF to prioritize the retransmission of MT Non-IP Data to UEs using a power saving mechanism. | +| Extended PCO | Extended-PCO | C | This Information Element shall be present, if the MME or SGSN receives Extended PCO information from the UE. | +| 3GPP Charging Characteristics
(See 3GPP TS 32.298 [30]) | 3GPP-Charging-Characteristics | C | This Information element shall contain the PDN Connection Charging Characteristics data for an APN Configuration with SCEF-based NIDD mechanism.
It shall be present if the request is for a T6a/b connection establishment and may be present if the request is for a T6a/b connection update. | +| RAT-Type
(See 3GPP TS 29.212 [10]) | RAT-Type | C | This Information Element shall contain the used RAT Type.
It shall be present if the request is for a T6a/b connection establishment or for a T6a/b connection update. | +| Supported Features
(See 3GPP TS 29.229 [4]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Terminal Information
(See 3GPP TS 29.272 [16]) | Terminal-Information | C | This Information Element shall contain the identity of the UE.
It shall be present if available. | +| Visited PLMN ID
(See 3GPP TS 29.272 [16]) | Visited-PLMN-Id | C | This Information Element shall contain the identity (MCC and MNC) of serving PLMN.
It shall be present if the request is for a T6a/b connection establishment or for a T6a/b connection update. | +| APN Rate Control Status
(see 6.4.36) | APN-Rate-Control-Status | O | May be present if the request is for a T6a/b connection establishment. | + +**Table 5.7.1-2: Connection Management Answer** + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|-------------------------------------------------------|--------------------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result
(See 6.3) | Result-Code /
Experimental-Result | M | Result of the request.
Result-Code AVP shall be used for errors defined in the Diameter Base Protocol.
Experimental-Result AVP shall be used for T6a/b errors. This is a grouped AVP, which contains the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | +| NIDD Charging Identifier
(See 3GPP TS 32.299 [22]) | PDN-Connection-Charging-Id | C | This Information element is defined in 3GPP TS 32.253 [23] and shall be present if the answer is for a T6a/b connection establishment. | +| Extended PCO | Extended-PCO | C | This Information Element shall be present, if the SCEF needs to send Extended PCO information to the UE. | +| Supported Features
(See 3GPP TS 29.229 [4]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| APN Rate Control Status (see 6.4.36) | APN-Rate-Control-Status | O | May be present if the response is for a T6a/b connection release. | + +### 5.7.2 Detailed Behaviour of the MME/SGSN + +The MME or SGSN shall make use of this procedure to request one of the following T6a/b connection management actions: + +- for a T6a/b connection establishment, the MME shall: + - include the user's IMSI. + - fill the EPS Bearer Identity information element with either the identity of the EPS bearer that MME allocated to the Non-IP PDN connection, or the NSAPI of the PDP context used by the SGSN for the Non-IP connection, as described in 3GPP TS 23.682 [2]; + - if Serving PLMN Rate Control is configured, the MME shall include the Serving PLMN Rate Control information as described in 3GPP TS 23.401 [25]; +- for a T6a/b connection release, the MME or SGSN shall: + - fill the EPS Bearer Identity information element with the identity of the EPS bearer of the T6a connection, or the NSAPI of the PDP context of the T6b connection, which is released as described in 3GPP TS 23.682 [2]; + - upon getting the Connection Management Answer from the SCEF, delete the T6a/b connection context; +- for a T6a/b connection update, the MME or SGSN shall: + - fill the EPS Bearer Identity information element with the identity of the EPS bearer of the T6a connection, or the NSAPI of the PDP context of the T6b connection, that needs to be updated; + - set the UE-Reachable-Indicator in the CMR-Flags AVP if the UE has become or is about to become reachable. The MME or SGSN may additionally include the Maximum UE Availability Time AVP, if available, to indicate the timestamp (in UTC) until which a UE using a power saving mechanism (such as extended idle mode DRX) is expected to be reachable for MT Non-IP Data Delivery; + - upon getting the Connection Management Answer from the SCEF, reset the Not Reachable for NIDD flag if this flag was set and if the UE-Reachable-Indicator was set in the CMR-Flags AVP in the Connection Management Request; + - if Serving PLMN Rate Control needs to be added or updated, the MME shall include Serving PLMN Rate Control information as described in 3GPP TS 23.401 [25]. + +NOTE: If the UE has several T6a/b connections to the same SCEF, for which Non-IP data is pending, the MME or SGSN initiates a T6a/b connection update for only one of the T6a/b connections towards this SCEF; the UE can have either T6a or T6b connections, but not both simultaneously. + +If the MME or SGSN receives the Extended-PCO AVP in the Connection Management Answer from the SCEF, the MME or SGSN shall forward the Extended-PCO to the UE transparently, as specified in 3GPP TS 24.301 [28]. + +### 5.7.3 Detailed Behaviour of the SCEF + +When the SCEF receives a Connection Management Request from the MME or SGSN the SCEF shall, in the following order: + +- check that the User Identity exists in the SCEF. If not, Experimental-Result shall be set to DIAMETER\_ERROR\_USER\_UNKNOWN in the Connection Management Answer; +- check that the T6a/b connection action indicates a T6a/b connection establishment, a T6a/b connection release or a T6a/b connection update. If not, the Experimental-Result shall be set to DIAMETER\_ERROR\_OPERATION\_NOT\_ALLOWED in the Connection Management Answer; +- if the T6a/b connection action indicates a T6a/b connection establishment: + - check whether a valid NIDD configuration exists for the UE at the SCEF; + +If not, the SCEF shall: + +- reject the Connection Management Request, with Experimental-Result set to DIAMETER\_ERROR\_NIDD\_CONFIGURATION\_NOT\_AVAILABLE in the Connection Management Answer, or +- accept the Connection Management Request, and initiate a NIDD Configuration procedure with a default SCS/AS configured in the SCEF and the MSISDN or an external ID obtained from the HSS, as specified in 3GPP TS 29.336 [5] clause 7.2.3.2. If such NIDD Configuration procedure fails, the SCEF shall reject the Connection Management Request, with Experimental-Result set to DIAMETER\_ERROR\_NIDD\_CONFIGURATION\_NOT\_AVAILABLE in the Connection Management Answer; +- create an EPS bearer context; +- store the MME or SGSN Identity identified by the Origin-Host AVP of the T6a/b Connection Management Request, and the MME or SGSN realm identified by the Origin-Realm AVP of the T6a/b Connection Management Request in the EPS bearer context; +- include the Extended-PCO AVP in the Connection Management Answer, if the Extended PCO information (e.g. APN Rate Control information) needs to be provided to the UE; +- if Serving PLMN Rate Control is provided by the MME, restrict the number of messages for the downlink to not exceed the values provided in Serving PLMN Rate Control. If it is not provided and Serving PLMN Rate Control is active, then continue using the previously provided values; +- If successful, Result shall be set to DIAMETER\_SUCCESS in the Connection Management Answer; +- if the T6a/b connection action indicates a T6a/b connection release: + - check whether, for this user and the received EPS bearer ID, a T6a connection context exists. If not, Experimental-Result shall be set to DIAMETER\_ERROR\_INVALID\_EPS\_BEARER in the Connection Management Answer; + - include the Extended-PCO AVP in the Connection Management Answer, if the Extended PCO information needs to be provided to the UE; + - delete the T6a/b connection context at the SCEF. If successful, Result code shall be set to DIAMETER\_SUCCESS in the Connection Management Answer; +- if the T6a/b connection action indicates a T6a connection update: + +- check whether, for this user and the received EPS Bearer Identity, a T6a/b connection context exists. If not, Experimental-Result shall be set to DIAMETER\_ERROR\_INVALID\_EPS\_BEARER in the Connection Management Answer; +- if successful: + - if Serving PLMN Rate Control is provided by the MME, restrict the number of messages for the downlink to not exceed the values provided in Serving PLMN Rate Control. If it is not provided and Serving PLMN Rate Control is active, then continue using the previously provided values; + - include the Extended-PCO AVP in the Connection Management Answer, if the Extended PCO information (e.g. APN Rate Control information) needs to be provided to the UE; + - store the MME or SGSN Identity identified by the Origin-Host AVP of the T6a/b Connection Management Request and the MME or SGSN realm identified by the Origin-Realm AVP of the T6a/b Connection Management Request, if the MME or SGSN identity has changed, in the bearer context, and the Result shall be set to DIAMETER\_SUCCESS in the Connection Management Answer; + - if the UE-Reachable-Indicator was set in the CMR-Flags AVP, forward any MT Non-IP data pending for any T6a/b connection for this UE, to the MME or SGSN. + +If the Serving-PLMN-Rate-Control AVP is included in the Connection Management Request message from the MME, the SCEF shall enforce the Serving PLMN Rate Control as specified in 3GPP TS 23.401 [12] clause 4.7.7.2. + +### 5.7.4 Detailed Behaviour of the IWK-SCEF + +When the IWK-SCEF receives a Connection Management Request from the MME or SGSN, it shall forward the request to the SCEF. + +When the IWK-SCEF receives a Connection Management Answer from the SCEF, it shall forward the answer to the MME or SGSN. + +## 5.8 Connection Management by SCEF Procedure + +### 5.8.1 General + +This procedure shall be used between the SCEF and the MME/SGSN, and between the SCEF and the MME/SGSN via the IWK-SCEF acting as a Diameter proxy agent for roaming cases. + +When the procedure is invoked by the SCEF, it is used + +- to update the parameters (e.g. Extended PCO information) associated to a T6a/b connection between the MME/SGSN and the SCEF; +- to release a T6a/b connection between MME/SGSN and SCEF. + +This procedure is used according to 3GPP TS 23.682 [2]. The IWK-SCEF may be in the path between the MME/SGSN and the SCEF for roaming cases when the IWK-SCEF is deployed by the operator of the visited PLMN. + +This procedure is mapped to the commands Connection-Management-Request/Answer (CMR/CMA) in the Diameter application specified in clause 6. + +The tables 5.8.1-1 and 5.8.1-2 detail the involved information elements. + +**Table 5.8.1-1: Connection Management SCEF Request** + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|-------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| User Identity
(See 6.4.16) | User-Identifier | M | This Information Element shall be present and shall contain the identity of the UE. This is a grouped AVP containing the IMSI. | +| EPS Bearer Identity
(See 6.4.17) | Bearer-Identifier | M | This Information Element shall be present and shall contain either the identity of the EPS bearer identifying the T6a connection, or the NSAPI of the PDP context identifying the T6b connection, to which the request applies. | +| T6a/b Connection Action
(See 6.4.18) | Connection-Action | M | This Information element shall be present and shall contain a T6a/b connection management action indicating a T6a/b connection update. | +| Extended PCO
(see 6.4.26) | Extended-PCO | C | This Information Element shall be present if the SCEF needs to send updated Extended PCO information (e.g. APN Rate Control information) to the UE. | +| Supported Features
(See 3GPP TS 29.229 [4]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | + +**Table 5.8.1-2: Connection Management SCEF Answer** + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|-----------------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result
(See 6.3) | Result-Code / Experimental-Result | M | Result of the request.
Result-Code AVP shall be used for errors defined in the Diameter Base Protocol.
Experimental-Result AVP shall be used for T6a/b errors. This is a grouped AVP, which contains the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | +| Supported Features
(See 3GPP TS 29.229 [4]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | + +### 5.8.2 Detailed Behaviour of the SCEF + +The SCEF shall make use of this procedure to send the updated Extended PCO information (e.g. APN Rate Control information) to the UE during T6a/b connection update, if needed. If APN Rate Control information is included in the Extended-PCO AVP within the Connection Management SCEF Request message from the SCEF, the SCEF shall enforce the APN Rate Control as specified in 3GPP TS 23.401 [12] clause 4.7.7.3. + +The SCEF shall make use of this procedure to request the release of the T6a/b connection. + +### 5.8.3 Detailed Behaviour of the MME/SGSN + +When the MME or SGSN receives a Connection Management SCEF Request from the SCEF or the IWK-SCEF, the MME or SGSN shall, in the following order: + +- check that the User Identity exists in the MME or SGSN. If not, Experimental-Result shall be set to DIAMETER\_ERROR\_USER\_UNKNOWN in the Connection Management SCEF Answer; +- check that the T6a/b connection action indicates a T6a/b connection update or T6a/b connection release. If not, the Experimental-Result shall be set to DIAMETER\_ERROR\_OPERATION\_NOT\_ALLOWED in the Connection Management SCEF Answer; + +- check whether, for this user and the received EPS Bearer Identity, a T6a/b connection context exists. If not, Experimental-Result shall be set to DIAMETER\_ERROR\_INVALID\_EPS\_BEARER in the Connection Management SCEF Answer; +- if the T6a/b connection action indicates a T6a/b connection update: + - if the Extended-PCO AVP is received, forward the Extended-PCO to the UE, as specified in 3GPP TS 24.301[28]. If successful, the Result code shall be set to DIAMETER\_SUCCESS in the Connection Management SCEF Answer. +- if the T6a/b connection action indicates T6a/b connection release, delete the T6a/b connection context at the MME/SGSN. If successful, the Result code shall be set to DIAMETER\_SUCCESS in the Connection Management SCEF Answer. + +### 5.8.4 Detailed Behaviour of the IWK-SCEF + +When the IWK-SCEF receives a Connection Management SCEF Request from the SCEF, it shall forward the request to the MME or SGSN. + +When the IWK-SCEF receives a Connection Management SCEF Answer from the MME or SGSN, it shall forward the answer to the SCEF. + +# --- 6 Protocol Specification and Implementation + +## 6.1 Introduction + +### 6.1.1 Use of Diameter Base Protocol + +The Diameter base protocol as specified in IETF RFC 6733 [32] shall apply except as modified by the defined support of the methods and the defined support of the commands and AVPs, result and error codes as specified in this specification. Unless otherwise specified, the procedures (including error handling and unrecognised information handling) shall be used unmodified. + +### 6.1.2 Securing Diameter Messages + +For secure transport of Diameter messages, see 3GPP TS 33.210 [4]. + +### 6.1.3 Accounting Functionality + +Accounting functionality (Accounting Session State Machine, related command codes and AVPs) shall not be used on the T6a/T6b interface, T6ai/T6bi interface and the T7 interface. + +### 6.1.4 Use of Sessions + +Diameter sessions shall be implicitly terminated between: + +- the MME/SGSN and the SCEF, for the T6a/T6b interface; +- the MME/SGSN and the IWK-SCEF, for the T6ai/T6bi interface and +- the IWK-SCEF and the SCEF for the T7 interface. + +An implicitly terminated session is one for which the server does not maintain state information. The client shall not send any re-authorization or session termination requests to the server. + +The Diameter base protocol includes the Auth-Session-State AVP as the mechanism for the implementation of implicitly terminated sessions. + +The client (server) shall include in its requests (responses) the Auth-Session-State AVP set to the value NO\_STATE\_MAINTAINED (1), as described in IETF RFC 6733 [32]. As a consequence, the server shall not maintain any state information about this session and the client shall not send any session termination request. Neither the Authorization-Lifetime AVP nor the Session-Timeout AVP shall be present in requests or responses. + +### 6.1.5 Transport Protocol + +Diameter messages over the T6a/T6b, T6ai/T6bi and T7 interface shall make use of SCTP IETF RFC 4960 [7] as transport protocol. + +### 6.1.6 Routing Considerations + +#### 6.1.6.1 Routing Considerations for Monitoring Event related Requests + +This clause specifies the use of the Diameter routing AVPs Destination-Realm and Destination-Host for Monitoring Event related requests. + +The MME/SGSN shall use the SCEF-ID and the SCEF realm previously received over S6a/b for a monitoring event configuration as the Destination-Host AVP and the Destination-Realm AVP in the Reporting-Information-Request for the monitoring event reports sent over the T6a/T6b or T6ai/bi interface. + +The MME/SGSN shall use the pre-configured IWK-SCEF identify and the pre-configured IWK-SCEF realm as the Destination-Host AVP and the Destination Realm AVP in the Configuration-Information-Request for the monitoring event configuration sent over the T6ai/bi interface. + +The IWK-SCEF behaves as a Diameter Proxy agent according to IETF RFC 6733 [32] for the Reporting-Information-Request received from the MME/SGSN over the T6ai/bi interface and shall forward these requests to the SCEF over the T7 interface by keeping unchanged the Destination Realm and Destination Host AVPs. + +For monitoring events directly configured at the MME/SGSN by the SCEF, if the SCEF knows the address/name of the MME/SGSN, both the Destination-Realm AVP and the Destination-Host AVP shall be present in the request. Otherwise, only the Destination-Realm AVP shall be present and the command shall be routed to the next Diameter node. Consequently, the Destination-Host AVP is declared as optional in the ABNF for all Monitoring Event related requests initiated by the SCEF. + +The Destination-Realm AVP is declared as mandatory in the ABNF for all Monitoring Event related requests. The Destination-Host AVP is declared as optional in the ABNF description of the Reporting-Information-Request and of the Configuration Information-Request. + +#### 6.1.6.2 Routing Considerations for Non-IP Data Related Requests + +This clause specifies the use of the Diameter routing AVPs Destination-Realm and Destination-Host for Non-IP Data related requests. + +The MME or SGSN shall use the SCEF-ID and the SCEF realm that it received in the subscribed APN associated to the T6a/b connection at its establishment as the Destination-Host AVP and the Destination realm AVP in the Non-IP data related request commands sent over the T6a/b and T6ai/bi interfaces. + +The Destination-Host AVP is declared as optional and the Destination realm AVP as mandatory in the ABNF description of the Non-IP data related requests initiated by the MME or SGSN. + +NOTE 1: For roaming cases, the routing of MME or SGSN initiated request commands to the IWK-SCEF relies on the Destination Realm AVP as according to the Diameter base protocol. + +NOTE 2: The Diameter implicitly terminated sessions and their Session ID for the Non-IP data related traffic are end to end between the MME/SGSN and the SCEF. + +The IWK-SCEF behaves as a Diameter Proxy agent according to IETF RFC 6733 [32] for the Non-IP related requests received from the MME or SGSN over the T6ai/bi interfaces and shall forward these requests to the SCEF over the T7 interface by keeping unchanged the Destination Realm and Destination Host AVPs. + +The SCEF obtains the Destination-Host AVP and the Destination-Realm AVP to use in the Non-IP data related requests towards an MME or SGSN from the Origin-Host AVP and the Origin-Realm AVP received in previous Non-IP Data related requests from the MME or SGSN. The Origin-Realm AVP in the requests received by the SCEF in roaming cases should contain the domain name of the network to which the MME or SGSN belongs, encoded as specified in clause 19.2 of 3GPP TS 23.003 [24]. + +The Destination-Host AVP is declared as optional and the Destination realm AVP as mandatory in the ABNF for the Non-IP Data related requests initiated by the SCEF. + +The IWK-SCEF behaves as a Diameter Proxy agent according to IETF RFC 3588 [3] for the Non-IP related requests received from the SCEF over the T7 interface and shall forward these requests to the MME or SGSN over the T6ai/bi interfaces by keeping unchanged the Destination Realm and Destination Host AVPs. + +#### 6.1.6.3 Handling of the Vendor-Specific-Application-Id AVP + +If the Vendor-Specific-Application-ID AVP is received in any of the commands defined in this specification, it shall be ignored by the receiving node, and it shall not be used for routing purposes. + +### 6.1.7 Advertising Application Support + +The SCEF, MME, SGSN and the IWK-SCEF shall advertise support of the Diameter T6a/T6b Application by including the value of the application identifier in the Auth-Application-Id AVP within the Vendor-Specific-Application-Id grouped AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands. + +NOTE: Even though the reference point between the MME/SGSN and the IWK-SCEF is called T6ai/T6bi respectively and the reference point between the IWK-SCEF and the SCEF is called T7, all these reference points use the same Diameter Application ID. + +The vendor identifier value of 3GPP (10415) shall be included in the Supported-Vendor-Id AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands, and in the Vendor-Id AVP within the Vendor-Specific-Application-Id grouped AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands. + +The Vendor-Id AVP included in Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands that is not included in the Vendor-Specific-Application-Id AVPs as described above shall indicate the manufacturer of the Diameter node as per IETF RFC 6733 [32]. + +### 6.1.8 Diameter Application Identifier + +The T6a/T6b interface protocol shall be defined as an IETF vendor specific Diameter application, where the vendor is 3GPP. The vendor identifier assigned by IANA to 3GPP () is 10415. + +The Diameter application identifier assigned to the T6a/T6b interface application is 16777346. + +The T6ai/T6bi and the T7 interface protocol shall use the same Diameter application identifier as the T6a/T6b interface. + +### 6.1.9 Use of the Supported-Features AVP + +When new functionality is introduced on the T6a/T6b application, it should be defined as optional. If backwards incompatible changes cannot be avoided, the new functionality shall be introduced as a new feature and support advertised with the Supported-Features AVP. The usage of the Supported-Features AVP on the T6a/T6b application is consistent with the procedures for the dynamic discovery of supported features as defined in clause 7.2 of 3GPP TS 29.229 [4]. + +When extending the application by adding new AVPs for a feature, the new AVPs shall have the M bit cleared and the AVP shall not be defined mandatory in the command ABNF. + +As defined in 3GPP TS 29.229 [4], the Supported-Features AVP is of type grouped and contains the Vendor-Id, Feature-List-ID and Feature-List AVPs. On the all reference points as specified in this specification, the Supported-Features AVP is used to identify features that have been defined by 3GPP and hence, for features defined in this + +document, the Vendor-Id AVP shall contain the vendor ID of 3GPP (10415). If there are multiple feature lists defined for the reference point, the Feature-List-ID AVP shall differentiate those lists from one another. + +## 6.2 Commands + +### 6.2.1 Introduction + +This clause defines the Command code values and related ABNF for each command described in this specification. The ABNF for the commands on T6a/T6b, T6ai/T6bi and T7 are the same if not specified explicitly different. + +### 6.2.2 Command-Code values + +This clause defines Command-Code values for the T6a/T6b interface application as allocated by IANA. + +Every command is defined by means of the ABNF syntax IETF RFC 5234 [8], according to the Command Code Format (CCF) specification defined in IETF RFC 6733 [32]. When the definition and use of an AVP is not specified in this document, the guidelines in IETF RFC 6733 [32] shall apply. + +The Vendor-Specific-Application-Id AVP shall not be included in any command sent by Diameter nodes supporting applications defined in this specification. If the Vendor-Specific-Application-Id AVP is received in any of the commands defined in this specification, it shall be ignored by the receiving node. + +NOTE: The Vendor-Specific-Application-Id is included as an optional AVP in all Command Code Format specifications defined in this specification in order to overcome potential interoperability issues with intermediate Diameter agents non-compliant with IETF RFC 6733 [32]. + +The following Command Codes are defined in this specification for T6a/T6b: + +**Table 6.2.2-1: Command-Code values for T6a/T6b** + +| Command-Name | Abbreviation | Code | Clause | +|-----------------------------------|--------------|---------|--------------------------------------------------------| +| Configuration-Information-Request | CIR | 8388718 | 3GPP TS 29.336 [5] clause 8.2.3 and clause 6.2.3 below | +| Configuration-Information-Answer | CIA | 8388718 | 3GPP TS 29.336 [5] clause 8.2.4 and clause 6.2.4 below | +| Reporting-Information-Request | RIR | 8388719 | 3GPP TS 29.336 [5] clause 8.2.5 and clause 6.2.5 below | +| Reporting-Information-Answer | RIA | 8388719 | 3GPP TS 29.336 [5] clause 8.2.6 and clause 6.2.6 below | +| Connection-Management-Request | CMR | 8388732 | 6.2.7 | +| Connection-Management-Answer | CMA | 8388732 | 6.2.8 | +| MO-Data-Request | ODR | 8388733 | 6.2.9 | +| MO-Data-Answer | ODA | 8388733 | 6.2.10 | +| MT-Data-Request | TDR | 8388734 | 6.2.11 | +| MT-Data-Answer | TDA | 8388734 | 6.2.12 | + +For these commands, the Application-ID field shall be set to 16777346 (application identifier of the T6a/T6b interface application, allocated by IANA). + +### 6.2.3 Configuration Information Request (CIR) Command + +The Configuration Information Request (CIR) command, indicated by the Command-Code field set to 8388718 and the "R" bit set in the Command Flags field, is sent from: + +- the SCEF to the MME/SGSN; +- the SCEF to the IWK-SCEF and +- the MME/SGSN to the IWK-SCEF + +This command is originally defined in 3GPP TS 29.336 [5]. + +For the T6a/T6b interface, the Configuration-Information-Request command format is specified as following: + +Message Format: + +``` +< Configuration-Information-Request > ::= < Diameter Header: 8388718, REQ, PXY, 16777346 > + < Session-Id > + [ DRMP ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ Destination-Host ] + { Destination-Realm } + *[ Supported-Features ] + *[ Monitoring-Event-Configuration ] + *[ Proxy-Info ] + *[ Route-Record ] + *[AVP] +``` + +### 6.2.4 Configuration-Information-Answer (CIA) Command + +The Configuration-Information-Answer (CIA) command, indicated by the Command-Code field set to 8388718 and the "R" bit cleared in the Command Flags field, is sent from: + +- the MME/SGSN to the SCEF; +- the IWK-SCEF to the SCEF and +- the IWK-SCEF to the MME/SGSN + +This command is originally defined in 3GPP TS 29.336 [5]. + +For the T6a/T6b interface, the Configuration-Information-Answer command format is specified as following: + +Message Format: + +``` +< Configuration-Information-Answer > ::= < Diameter Header: 8388718, PXY, 16777346 > + < Session-Id > + [ DRMP ] + [ Result-Code ] + [ Experimental-Result ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + *[ Supported-Features ] + *[ Monitoring-Event-Report ] + *[ Monitoring-Event-Config-Status ] + [ Failed-AVP ] + *[ Proxy-Info ] + *[ Route-Record ] + *[AVP] +``` + +### 6.2.5 Reporting-Information-Request (RIR) Command + +The Reporting-Information-Request (RIR) command, indicated by the Command-Code field set to 8388719 and the "R" bit set in the Command Flags field, is sent from: + +- the MME/SGSN to the SCEF; +- the MME/SGSN to the IWK-SCEF and + +- the IWK-SCEF to the SCEF. + +This command is originally defined in 3GPP TS 29.336 [5]. + +For the T6a/T6b interface, the Reporting-Information-Request command format is specified as following: + +Message Format: + +``` +< Reporting-Information-Request > ::= < Diameter Header: 8388719, REQ, PXY, 16777346 > + < Session-Id > + [ DRMP ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ Destination-Host ] + { Destination-Realm } + [ OC-Supported-Features ] + *[ Supported-Features ] + [ User-Identifier ] + *[ Monitoring-Event-Report ] + ** [ Proxy-Info ] + * [ Route-Record ] + *[AVP] +``` + +### 6.2.6 Reporting-Information-Answer (RIA) Command + +The Reporting-Information-Answer (RIA) command, indicated by the Command-Code field set to 8388719 and the "R" bit cleared in the Command Flags field, is sent from: + +- the SCEF to the MME/SGSN; +- the SCEF to the IWK-SCEF and +- the IWK-SCEF to the MME/SGSN. + +This command is originally defined in 3GPP TS 29.336 [5]. + +For the T6a/T6b interface, the Reporting-Information-Answer command format is specified as following: + +Message Format: + +``` +< Reporting-Information-Answer > ::= < Diameter Header: 8388719, PXY, 16777346 > + < Session-Id > + [ DRMP ] + [ Result-Code ] + [ Experimental-Result ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ OC-Supported-Features ] + [ OC-OLR ] + *[ Load ] + *[ Supported-Features ] + *[ Monitoring-Event-Report-Status ] + [ Failed-AVP ] + * [ Proxy-Info ] + * [ Route-Record ] + *[AVP] +``` + +### 6.2.7 Connection-Management-Request (CMR) Command + +The Connection-Management-Request (CMR) command, indicated by the Command-Code field set to 8388732 and the "R" bit set in the Command Flags field, is sent from: + +- the MME or SGSN to the SCEF; +- the MME or SGSN to the SCEF via the IWK-SCEF for roaming cases; +- the SCEF to the MME or SGSN; +- the SCEF to the MME or SGSN via the IWK-SCEF for roaming cases. + +For the T6a/b, T6ai/bi, T7 interfaces, the Connection-Management-Request command format is specified as following: + +Message Format: + +``` +< Connection-Management-Request > ::= < Diameter Header: 8388732, REQ, PXY, 16777346 > + < Session-Id > + < User-Identifier > + < Bearer-Identifier > + [ DRMP ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ Destination-Host ] + { Destination-Realm } + [ OC-Supported-Features ] + [ CMR-Flags ] + [ Maximum-UE-Availability-Time ] + *[ Supported-Features ] + [ Connection-Action ] + [ Service-Selection ] + [ Serving-PLMN-Rate-Control ] + [ Extended-PCO ] + [ 3GPP-Charging-Characteristics ] + [ RAT-Type ] + [ Terminal-Information ] + [ Visited-PLMN-Id ] + [ APN-Rate-Control-Status ] + *[ Proxy-Info ] + *[ Route-Record ] + *[AVP] +``` + +### 6.2.8 Connection-Management-Answer (CMA) Command + +The Connection-Management-Answer (CMA) command, indicated by the Command-Code field set to 8388732 and the "R" bit cleared in the Command Flags field, is sent from: + +- the SCEF to the MME or SGSN; +- the SCEF to the MME or SGSN via the IWK-SCEF for roaming cases; +- the MME or SGSN to the SCEF; +- the MME or SGSN to the SCEF via the IWK-SCEF for roaming cases. + +For the T6a/b, T6ai/bi and T7 interfaces, the Connection-Management-Answer command format is specified as following: + +Message Format: + +``` +< Connection-Management-Answer > ::= < Diameter Header: 8388732, PXY, 16777346 > + < Session-Id > +``` + +``` + +[ DRMP ] +[ Result-Code ] +[ Experimental-Result ] +{ Auth-Session-State } +{ Origin-Host } +{ Origin-Realm } +[ OC-Supported-Features ] +[ OC-OLR ] +*[ Load ] +*[ Supported-Features ] +[ PDN-Connection-Charging-Id ] +[ Extended-PCO ] +[ APN-Rate-Control-Status ] +[ Failed-AVP ] +*[ Proxy-Info ] +*[ Route-Record ] +*[AVP] + +``` + +### 6.2.9 MO-Data-Request (ODR) Command + +The MO-Data-Request (ODR) command, indicated by the Command-Code field set to 8388733 and the "R" bit set in the Command Flags field, is sent from: + +- the MME or SGSN to the SCEF; +- the MME or SGSN to the IWK-SCEF and +- the IWK-SCEF to the SCEF. + +For the T6a/b, T6ai/bi, T7 interfaces, the MO-Data-Request command format is specified as following: + +Message Format: + +``` + +< MO-Data-Request > ::= < Diameter Header: 8388733, REQ, PXY, 16777346 > + < Session-Id > + < User-Identifier > + < Bearer-Identifier > + [ DRMP ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ Destination-Host ] + { Destination-Realm } + [ OC-Supported-Features ] + *[ Supported-Features ] + [ Non-IP-Data ] + *[ Proxy-Info ] + *[ Route-Record ] + [ RRC-Cause-Counter ] + *[AVP] + +``` + +### 6.2.10 MO-Data-Answer (ODA) Command + +The MO-Data-Answer (ODA) command, indicated by the Command-Code field set to 8388733 and the "R" bit cleared in the Command Flags field, is sent from: + +- the SCEF to the MME or SGSN; +- the SCEF to the IWK-SCEF and +- the IWK-SCEF to the MME or SGSN. + +For the T6a/b, T6ai/bi and T7 interfaces, the MO-Data-Answer command format is specified as following: + +Message Format: + +``` + +< MO-Data-Answer > ::= < Diameter Header: 8388733, PXY, 16777346 > + < Session-Id > + [ DRMP ] + [ Result-Code ] + [ Experimental-Result ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ OC-Supported-Features ] + [ OC-OLR ] + *[ Load ] + *[ Supported-Features ] + [ Failed-AVP ] + *[ Proxy-Info ] + *[ Route-Record ] + *[AVP] + +``` + +### 6.2.11 MT-Data-Request (TDR) Command + +The MT-Data-Request (TDR) command, indicated by the Command-Code field set to 8388734 and the "R" bit set in the Command Flags field, is sent from: + +- the SCEF to the MME or SGSN; +- the SCEF to the IWK-SCEF and +- the IWK-SCEF to the MME or SGSN. + +For the T6a/b, T6ai/bi, T7 interfaces, the MT-Data-Request command format is specified as following: + +Message Format: + +``` + +< MT-Data-Request > ::= < Diameter Header: 8388734, REQ, PXY, 16777346 > + < Session-Id > + < User-Identifier > + < Bearer-Identifier > + [ DRMP ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ Destination-Host ] + { Destination-Realm } + [ OC-Supported-Features ] + *[ Supported-Features ] + [ Non-IP-Data ] + [ SCEF-Wait-Time ] + [ Maximum-Retransmission-Time ] + *[ Proxy-Info ] + *[ Route-Record ] + *[AVP] + +``` + +### 6.2.12 MT-Data-Answer (TDA) Command + +The MT-Data-Answer (TDA) command, indicated by the Command-Code field set to 8388734 and the "R" bit cleared in the Command Flags field, is sent from: + +- the MME or SGSN to the SCEF; +- the MME or SGSN to the IWK-SCEF and +- the IWK-SCEF to the SCEF. + +For the T6a/b, T6ai/bi and T7 interfaces, the MT-Data-Answer command format is specified as following: + +Message Format: + +``` + +< MT-Data-Answer > ::= < Diameter Header: 8388734, PXY, 16777346 > + < Session-Id > + [ DRMP ] + [ Result-Code ] + [ Experimental-Result ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ OC-Supported-Features ] + [ OC-OLR ] + *[ Load ] + [ Requested-Retransmission-Time ] + *[ Supported-Features ] + [ Failed-AVP ] + *[ Proxy-Info ] + *[ Route-Record ] + [ TDA-Flags ] + *[AVP] + +``` + +## 6.3 Result-Code AVP and Experimental-Result AVP Values + +### 6.3.1 General + +This clause defines result code values that shall be supported by all Diameter implementations that conform to this specification. + +### 6.3.2 Success + +Result codes that fall within the Success category shall be used to inform a peer that a request has been successfully completed. The Result-Code AVP values defined in the Diameter base protocol specified in IETF RFC 6733 [32] shall be applied. + +### 6.3.3 Permanent Failures + +Errors that fall within the Permanent Failures category shall be used to inform the peer that the request has failed, and should not be attempted again. The Result-Code AVP values defined in the Diameter base protocol specified IETF RFC 6733 [32] shall be applied. When one of the result codes defined here is included in a response, it shall be inside an Experimental-Result AVP and the Result-Code AVP shall be absent. + +#### 6.3.3.1 DIAMETER\_ERROR\_UNAUTHORIZED\_REQUESTING\_ENTITY (5510) + +This result code shall be sent by the MME/SGSN or the IWK-SCEF to indicate that the SCEF is not allowed to request Monitoring services. This error code is defined in 3GPP TS 29.336 [5]. + +#### 6.3.3.2 DIAMETER\_ERROR\_UNAUTHORIZED\_SERVICE (5511) + +This result code shall be sent by the MME/SGSN or the IWK-SCEF to indicate that the specific service requested by the SCEF is not allowed as per local policies. This error code is defined in 3GPP TS 29.336 [5]. + +#### 6.3.3.3 DIAMETER\_ERROR\_CONFIGURATION\_EVENT\_STORAGE\_NOT\_SUCCESSFUL (5513) + +This result code shall be sent by the MME/SGSN to indicate that the specific service requested by the SCEF could not be stored. This error code is defined in 3GPP TS 29.336 [5]. + +#### 6.3.3.4 DIAMETER\_ERROR\_CONFIGURATION\_EVENT\_NON\_EXISTANT (5514) + +This result code shall be sent by the IWK-SCEF to indicate that the requested deletion by the MME/SGSN could not be performed because the event does not exist. This error code is defined in 3GPP TS 29.336 [5]. + +#### 6.3.3.5 DIAMETER\_ERROR\_REQUESTED\_LOCATION\_NOT\_SERVED (5650) + +This result code shall be sent by the MME/SGSN to indicate that the location for which a related monitoring event is configured (e.g. Number of UEs at a given geographical location) by the SCEF, is not served by the MME/SGSN. + +#### 6.3.3.6 DIAMETER\_ERROR\_USER\_UNKNOWN (5001) + +This result code shall be sent by the SCEF or the MME/SGSN to indicate that the user identified by the IMSI is unknown. This error code is defined in 3GPP TS 29.229 [4]. + +#### 6.3.3.7 DIAMETER\_ERROR\_OPERATION\_NOT\_ALLOWED (5101) + +This result code shall be sent by the SCEF to indicate that the operation is not allowed when an EPS bearer context exists for the user. This error code is defined in 3GPP TS 29.329 [17]. + +This result code shall be sent by the SCEF or the MME/SGSN to indicate that the requested T6a/b connection action is not allowed. + +#### 6.3.3.8 DIAMETER\_ERROR\_INVALID\_EPS\_BEARER (5651) + +This result code shall be sent by the SCEF or the MME/SGSN to indicate that there is no bearer context for the user. + +#### 6.3.3.9 DIAMETER\_ERROR\_NIDD\_CONFIGURATION\_NOT\_AVAILABLE (5652) + +This result code shall be sent by the SCEF to indicate that there is no valid NIDD configuration available. + +#### 6.3.3.10 DIAMETER\_ERROR\_SCEF\_REFERENCE\_ID\_UNKNOWN (5515) + +This result code shall be sent by the SCEF to indicate that the SCEF reference ID is not known by the SCEF. + +#### 6.3.3.11 DIAMETER\_ERROR\_USER\_TEMPORARILY\_UNREACHABLE (5653) + +This result code shall be sent by the MME or SGSN to indicate that the UE is temporarily not reachable due to a power saving function, and that the MME or SGSN will update the SCEF when it detects that the UE is reachable or about to become reachable as specified in clause 5.6.3. + +#### 6.3.3.12 DIAMETER\_ERROR\_UNREACHABLE\_USER (4221) + +This result code shall be sent by the MME to indicate that the UE is not reachable. This error code is defined in 3GPP TS 29.172 [26]. + +## 6.4 AVPs + +### 6.4.1 General + +The following table specifies the Diameter AVPs defined for the T6a/T6b interface protocol, their AVP Code values, types, possible flag values and whether or not the AVP may be encrypted. The Vendor-ID header of all AVPs defined in this specification shall be set to 3GPP (10415). + +For all AVPs which contain bit masks and are of the type Unsigned32, bit 0 shall be the least significant bit. For example, to get the value of bit 0, a bit mask of 0x00000001 should be used. + +Table 6.4.1-1: T6a/T6b specific Diameter AVPs + +| | | | | AVP Flag rules | | | | | +|-----------------------------------------|----------|----------------|--------------|----------------|-----|------------|----------|-----------| +| Attribute Name | AVP Code | Clause defined | Value Type | Must | May | Should not | Must not | May Encr. | +| Communication-Failure-Information | 4300 | 6.4.4 | Grouped | M,V | | | | No | +| Cause-Type | 4301 | 6.4.5 | Unsigned32 | M,V | | | | No | +| S1AP-Cause | 4302 | 6.4.6 | Unsigned32 | M,V | | | | No | +| RANAP-Cause | 4303 | 6.4.7 | Unsigned32 | M,V | | | | No | +| BSSGP-Cause | 4309 | 6.4.8 | Unsigned32 | M,V | | | | No | +| GMM-Cause | 4304 | 6.4.9 | Unsigned32 | M,V | | | | No | +| SM-Cause | 4305 | 6.4.10 | Unsigned32 | M,V | | | | No | +| Number-Of-UE-Per-Location-Configuration | 4306 | 6.4.11 | Grouped | M,V | | | | No | +| Number-Of-UE-Per-Location-Report | 4307 | 6.4.12 | Grouped | M,V | | | | No | +| UE-Count | 4308 | 6.4.13 | Unsigned32 | M,V | | | | No | +| Connection-Action | 4314 | 6.4.18 | Unsigned32 | M,V | | | | No | +| Non-IP-Data | 4315 | 6.4.19 | OctetSstring | M,V | | | | No | +| Serving-PLMN-Rate-Control | 4310 | 6.4.21 | Grouped | M,V | | | | No | +| Uplink-Rate-Limit | 4311 | 6.4.23 | Unsigned32 | M,V | | | | No | +| Downlink-Rate-Limit | 4312 | 6.4.22 | Unsigned32 | M,V | | | | No | +| Extended-PCO | 4313 | 6.4.26 | OctetString | M,V | | | | No | +| SCEF-Wait-Time | 4316 | 6.4.24 | Time | M,V | | | | No | +| CMR-Flags | 4317 | 6.4.25 | Unsigned32 | M,V | | | | No | +| RR-Cause-Counter | 4318 | 6.4.27 | Grouped | M,V | | | | No | +| Counter-Value | 4319 | 6.4.28 | Unsigned32 | M,V | | | | No | +| RR-Counter-Timestamp | 4320 | 6.4.29 | Time | M,V | | | | No | +| TDA-Flags | 4321 | 6.4.31 | Unsigned32 | V | | | M | No | +| Idle-Status-Indication | 4322 | 6.4.32 | Grouped | V | | | M | No | +| Idle-Status-Timestamp | 4323 | 6.4.33 | Time | V | | | M | No | +| Active-Time | 4324 | 6.4.34 | Unsigned32 | V | | | M | No | +| Reachability-Cause | 4325 | 6.4.35 | Unsigned32 | V | | | M | No | +| APN-Rate-Control-Status | 4326 | 6.4.36 | Grouped | V | | | M | No | +| Uplink-Number-Of-Packets-Allowed | 4327 | 6.4.37 | Unsigned32 | V | | | M | No | +| Number-Of-Additional-Exception-Reports | 4328 | 6.4.38 | Unsigned32 | V | | | M | No | +| Downlink-Number-Of-Packets-Allowed | 4329 | 6.4.39 | Unsigned32 | V | | | M | No | +| APN-Rate-Control-Status-Validity-Time | 4330 | 6.4.40 | Unsigned64 | V | | | M | No | + +NOTE 1: The AVP header bit denoted as "M" indicates whether support of the AVP is required. The AVP header bit denoted as "V" indicates whether the optional Vendor-ID field is present in the AVP header. For further details, see IETF RFC 6733 [32]. + +NOTE 2: If the M-bit is set for an AVP and the receiver does not understand the AVP, it shall return a rejection. If the M-bit is not set for an AVP, the receiver shall not return a rejection, whether or not it understands the AVP. If the receiver understands the AVP but the M-bit value does not match with the definition in this table, the receiver shall ignore the M-bit. + +The following table specifies the Diameter AVPs re-used by the T6a/T6b interface protocol from existing Diameter Applications, including a reference to their respective specifications and when needed, a short description of their use within T6a/T6b. + +Any other AVPs from existing Diameter Applications, except for the AVPs from Diameter Base Protocol, do not need to be supported. The AVPs from Diameter Base Protocol are not included in table 6.4.1-2, but they may be re-used for the T6a/T6b protocol. + +**Table 6.4.1-2: T6a/T6b re-used Diameter AVPs** + +| Attribute Name | Reference | Comments | +|-------------------------------------|---------------------|-----------------------------------------------------------------------------------------------------------------------------| +| Monitoring-Event-Configuration | 3GPP TS 29.336 [5] | This AVP shall contain the monitoring event to be configured at the MME/SGSN or the IWK-SCEF. See 6.4.2. | +| Monitoring-Event-Report | 3GPP TS 29.336 [5] | This AVP shall contain the monitoring event reported by the MME/SGSN or the IWK-SCEF. See 6.4.3. | +| SCEF-Reference-ID | 3GPP TS 29.336 [5] | | +| SCEF-ID | 3GPP TS 29.336 [5] | | +| SCEF-Reference-ID-for-Deletion | 3GPP TS 29.336 [5] | | +| Supported-Features | 3GPP TS 29.229 [4] | | +| Feature-List-ID | 3GPP TS 29.229 [4] | | +| Feature-List | 3GPP TS 29.229 [4] | See 6.4.14 | +| OC-Supported-Features | IETF RFC 7683 [9] | | +| OC-OLR | IETF RFC 7683 [9] | | +| Monitoring-Event-Config-Status | 3GPP TS 29.336 [5] | This AVP shall contain the status of configuration of each monitoring event identified by an SCEF-ID and SCEF-Reference-ID. | +| DRMP | IETF RFC 7944 [15] | see 6.4.15 | +| User-Identifier | 3GPP TS 29.336 [5] | See 6.4.16 | +| Bearer-Identity | 3GPP TS 29.212 [10] | See 6.4.17 | +| Monitoring-Type | 3GPP TS 29.336 [5] | | +| Loss-Of-Connectivity-Reason | 3GPP TS 29.336 [5] | | +| Maximum-Number-of-Reports | 3GPP TS 29.336 [5] | | +| Monitoring-Duration | 3GPP TS 29.336 [5] | | +| Charged-Party | 3GPP TS 32.299 [20] | | +| UE-Reachability-Configuration | 3GPP TS 29.336 [5] | | +| Location-Information-Configuration | 3GPP TS 29.336 [5] | | +| Reachability-Information | 3GPP TS 29.336 [5] | | +| EPS-Location-Information | 3GPP TS 29.272 [16] | | +| Service-Selection | IETF RFC 5778 [21] | See 6.4.20 | +| PDN-Connection-Charging-Id | 3GPP TS 32.299 [22] | | +| Maximum-Retransmission-Time | 3GPP TS 29.338 [27] | | +| Requested-Retransmission-Time | 3GPP TS 29.338 [27] | | +| Maximum-UE-Availability-Time | 3GPP TS 29.338 [27] | | +| 3GPP-Charging-Characteristics | 3GPP TS 29.061 [29] | | +| RAT-Type | 3GPP TS 29.212 [10] | | +| Terminal-Information | 3GPP TS 29.272 [16] | See 6.4.30 | +| Visited-PLMN-Id | 3GPP TS 29.272 [16] | | +| Load | IETF RFC 8583 [31] | | +| Subscribed-Periodic-RAU-TAU-Timer | 3GPP TS 29.272 [16] | | +| Monitoring-Event-Report-Status | 3GPP TS 29.336 [5] | | +| IMSI-Group-Id | 3GPP TS 29.272 [16] | | +| Reporting-Time-Stamp | 3GPP TS 29.336 [5] | | +| eDRX-Cycle-Length | 3GPP TS 29.272 [16] | | +| DL-Buffering-Suggested-Packet-Count | 3GPP TS 29.272 [16] | | +| PDN-Connectivity-Status-Report | 3GPP TS 29.336 [5] | | +| SCEF-Reference-ID-Ext | 3GPP TS 29.336 [5] | | +| SCEF-Reference-ID-for-Deletion-Ext | 3GPP TS 29.336 [5] | | + +### 6.4.2 Monitoring-Event-Configuration + +The Monitoring-Event-Configuration AVP is of type Grouped. It shall contain the Monitoring event configuration related data. It is originally defined in 3GPP TS 29.336 [5]. + +For the T6a/T6b interface, the Monitoring-Event-Configuration AVP format is specified as following: + +AVP format: + +``` +Monitoring-Event-Configuration ::= + [ SCEF-Reference-ID ] + [ SCEF-Reference-ID-Ext ] + { SCEF-ID } + { Monitoring-Type } + *[ SCEF-Reference-ID-for-Deletion ] + *[ SCEF-Reference-ID-for-Deletion-Ext ] + [ Maximum-Number-of-Reports ] + [ Monitoring-Duration ] + [ Charged-Party ] + [ UE-Reachability-Configuration ] + [ Location-Information-Configuration ] + *[ Number-Of-UE-Per-Location-Configuration ] + *[AVP] +``` + +When the "Extended Reference IDs" feature is supported by the SCEF and MME/SGSN, the SCEF-Reference-ID-Ext and SCEF-Reference-ID-for-Deletion-Ext AVPs shall be used instead of SCEF-Reference-ID and SCEF-Reference-ID-for-Deletion respectively. + +### 6.4.3 Monitoring-Event-Report + +The Monitoring-Event-Report AVP is of type Grouped. It shall contain the Monitoring event report data. It is originally defined in 3GPP TS 29.336 [5]. + +For the T6a/T6b interface, the Monitoring-Event-Report AVP format is specified as following: + +AVP format: + +``` +Monitoring-Event-Report ::= + { SCEF-Reference-ID } + [ SCEF-Reference-ID-Ext ] + [ SCEF-ID ] + [ Monitoring-Type ] + [ Reachability-Information ] + [ EPS-Location-Information ] + [ Communication-Failure-Information ] +``` + +\*[ Number-Of-UE-Per-Location-Report ] +[ Loss-Of-Connectivity-Reason ] +[ Visited-PLMN-Id ] +[ Idle-Status-Indication ] +[ Reporting-Time-Stamp ] +[ Maximum-UE-Availability-Time ] +\*[ PDN-Connectivity-Status-Report ] +[ Reachability-Cause ] +\*[AVP] + +The AVPs applicable for each Monitoring-Type reported by the MME/SGSN are specified under clause 5.2.2. + +When the "Extended Reference IDs" feature is supported by the SCEF and MME/SGSN, the SCEF-Reference-ID-Ext AVP shall be used insted of SCEF-Reference-ID; in such case, the required AVP "SCEF-Reference-ID" shall be included in the grouped AVP by the sender, but its content shall be discarded by the receiver. + +### 6.4.4 Communication-Failure-Information + +The Communication-Failure-Information AVP is of type Grouped. It shall contain the reason for communication failure. + +AVP format: + +Communication-Failure-Information ::= + +[ Cause-Type ] +[ SIAP-Cause ] +[ RANAP-Cause ] +[ BSSGP-Cause ] +[ GMM-Cause ] +[ SM-Cause ] +\*[AVP] + +### 6.4.5 Cause-Type + +The Cause-Type AVP is of type Unsigned32 and it shall identify the type of the SIAP-Cause. The following values are defined: + +RADIO\_NETWORK\_LAYER (0) + +TRANSPORT\_LAYER (1) + +NAS (2) + +PROTOCOL (3) + +MISCELLANEOUS (4) + +### 6.4.6 S1AP-Cause + +The S1AP-Cause AVP is of type Unsigned32. It shall contain a non-transparent copy of the S1AP cause code as specified clause 9.2.1.3 of 3GPP TS 36.413 [13]. The RAN cause sub-category of the S1AP-Cause as specified in 3GPP TS 36.413 [13] shall be encoded in the Cause-Type AVP as specified in clause 6.4.5 above. + +### 6.4.7 RANAP-Cause + +The RANAP-Cause AVP is of type Unsigned32. It shall contain the non-transparent copy of the cause value of the RANAP cause code as specified in clause 9.2.1.4 of 3GPP TS 25.413 [11]. + +### 6.4.8 BSSGP-Cause + +The BSSGP-Cause AVP is of type Unsigned32. It shall contain the non-transparent copy of the cause value of the BSSGP "Cause" as specified in clause 11.3.8 in 3GPP TS 48.018 [14]. + +### 6.4.9 GMM-Cause + +The GMM-Cause AVP is of type Unsigned32. It shall contain the GMM cause code as specified in clause 10.5.5.14 of 3GPP TS 24.008 [12]. + +### 6.4.10 SM-Cause + +The SM-Cause AVP is of type Unsigned32. It shall contain the SM cause code as specified in clause 10.5.6.6 and 10.5.6.6A of 3GPP TS 24.008 [12]. + +### 6.4.11 Number-Of-UE-Per-Location-Configuration + +The Number-Of-UE-Per-Location-Configuration AVP is of type Grouped. It shall contain the location information for which the number of UEs needs to be reported by the MME/SGSN. + +AVP format: + +``` +Number-of-UE-Per-Location-Configuration ::= + { EPS-Location-Information } + [ IMSI-Group-Id ] + *[AVP] +``` + +### 6.4.12 Number-Of-UE-Per-Location-Report + +The Number-Of-UE-Per-Location-Report AVP is of type Grouped. It shall contain the location information along with the number of UEs found at that location by the MME/SGSN. + +AVP format: + +``` +Number-of-UE-Per-Location-Report ::= + { EPS-Location-Information } + { UE-Count } + [ IMSI-Group-Id ] + *[AVP] +``` + +### 6.4.13 UE-Count + +The UE-Count AVP is of type Unsigned32. It shall contain the number of UEs counted against a given criteria (say location information). + +### 6.4.14 Feature-List AVP + +#### 6.4.14.1 Feature-List AVP for the T6a/T6b application + +The syntax of this AVP is defined in 3GPP TS 29.229 [4]. + +For the T6a/b application, the meaning of the bits shall be as defined in table 6.4.14.1-1 for the Feature-List-ID. + +**Table 6.4.14.1-1: Features of Feature-List-ID used in T6a/b** + +| Feature bit | Feature | M/O | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------|-----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | MONTE | O |

Configuration and reporting of monitoring events

This feature is applicable to from an SCEF with CIR/CIA command pair and the reporting of events to the SCEF with RIR/RIA command pair.

If the MME/SGSN does not support this feature, the SCEF shall not send monitoring event configurations to the HSS within CIR.

| +| 1 | NIDD | O |

Support of Non-IP Data service over T6a/b

This feature is applicable to CMR/CMA, ODR/ODA and TDR/TDA command pairs.

If the SCEF does not indicate support of this feature in an CMA, the MME or SGSN may store this information and not send any further CMR commands to that SCEF.

| +| 2 | Filtering | O |

Filtering Number of UEs present at given location by IMSI-Group

This feature is applicable to the CIR/CIA command pair.

If the MME/SGSN does not support this feature, the SCEF shall interpret the reported number of UEs per location as not being filtered by the provided IMSI-Group-Id.

| +| 3 | Extended Reference IDs | O |

Extended Reference IDs

This feature is applicable for the CIR/CIA and RIR/RIA command pairs.

If the SCEF detects that the MME/SGSN does not support this feature, it shall refrain from sending CIR commands containing 64-bit long SCEF Reference IDs.

If the MME/SGSN detects that the SCEF does not support this feature, it shall refrain from sending RIR commands containing 64-bit long SCEF Reference IDs.

| +|

Feature bit: The order number of the bit within the Supported-Features AVP, e.g. "1".
Feature: A short name that can be used to refer to the bit and to the feature, e.g. "MONTE".
M/O: Defines if the implementation of the feature is mandatory ("M") or optional ("O").
Description: A clear textual description of the feature.

| | | | + +### 6.4.15 DRMP + +The DRMP AVP is of type Enumerated and it is defined in IETF RFC 7944 [15]. This AVP allows the MME, the SGSN, the SCEF and the IWK-SCEF to indicate the relative priority of Diameter messages. The DRMP AVP may be used to set the DSCP marking for transport of the associated Diameter message. + +### 6.4.16 User-Identifier + +The User-Identifier AVP is of type Grouped and it contains the different identifiers used by the UE. + +It is defined in 3GPP TS 29.336 [5] + +### 6.4.17 Bearer-Identifier + +The Bearer-Identifier AVP contains either the identity of the EPS bearer used to identify the T6a connection between the MME and the SCEF or the NSAPI of the PDP context identifying the T6b connection between the SGSN and the SCEF. It is defined in 3GPP TS 29.212 [10]. + +### 6.4.18 Connection-Action + +The Connection-Action AVP is of type Unsigned32 and it shall identify the action to be performed on the T6a/b connection. The following values are defined: + +#### CONNECTION\_ESTABLISHMENT (0) + +This value shall be used if the T6a/b Connection-Management-Request applies to a T6a/b connection establishment. + +#### CONNECTION\_RELEASE (1) + +This value shall be used if the T6a/b Connection-Management-Request applies to a T6a/b connection release. + +#### CONNECTION\_UPDATE (2) + +This value shall be used if the T6a/b Connection-Management-Request applies to updating the properties of a T6a/b connection. + +### 6.4.19 Non-IP-Data + +The Non-IP-Data AVP is of type OctetString and it contains the Non-IP data conveyed between the MME or SGSN and the SCEF. + +### 6.4.20 Service-Selection + +The Service-Selection AVP is of type of UTF8String. This AVP shall contain the APN Network Identifier as specified in 3GPP TS 23.003 [24] clause 9.1. + +The contents of the Service-Selection AVP shall be formatted as a character string composed of one or more labels separated by dots ("."). + +This AVP is originally defined in IETF RFC 5778[21]. + +### 6.4.21 Serving-PLMN-Rate-Control + +The Serving-PLMN-Rate-Control AVP is of type Grouped and shall contain. + +The AVP format shall conform to: + +Serving-PLMN-Rate-Control::= + +[ Uplink-Rate-Limit ] + +[ Downlink-Rate-Limit ] + +\*[AVP] + +A Downlink-Rate-Limit set to 0 shall be interpreted that the Serving PLMN Rate Control for downlink messages is deactivated in the MME. If the Serving PLMN Rate Control is activated, the value of Downlink-Rate-Limit shall not be less than 10, see 3GPP TS 23.401 [25]. + +An Uplink-Rate-Limit set at 0 shall be interpreted that the Serving PLMN Rate Control for uplink messages is deactivated in the MME. If Serving PLMN Rate Control is activated, the value of Uplink-Rate-Limit shall not be less than 10, see 3GPP TS 23.401 [25]. + +### 6.4.22 Downlink-Rate-Limit + +The Downlink-Rate-Limit AVP is of type type Unsigned32 and shall contain the maximum number of NAS Data PDUs per deci hour for this UE for downlink. + +### 6.4.23 Uplink-Rate-Limit + +The Uplink-Rate-Limit AVP is of type Unsigned32 and shall contain the maximum number of NAS Data PDUs per deci hour for this UE for uplink. + +### 6.4.24 SCEF-Wait-Time + +The SCEF-Wait-Time is of type Time and it shall contain the timestamp (in UTC) until which the SCEF expects a response. + +### 6.4.25 CMR-Flags + +The CMR-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 6.4.25/1: + +**Table 6.4.25/1: CMR-Flags** + +| Bit | Name | Description | +|----------------------------------------------------------------------------------------------------------------------|------------------------|-----------------------------------------------------------------------------------| +| 0 | UE-Reachable-Indicator | This bit if set indicates that the UE has become or is about to become reachable. | +| NOTE 1: Bits not defined in this table shall be cleared by the sending entity and discarded by the receiving entity. | | | + +### 6.4.26 Extended-PCO + +The Extended-PCO AVP is of type OctetString. The Extended-PCO AVP shall contain the value part of the ePCO IE, starting from octet 4, as specified in clause 9.9.4.26 of 3GPP TS 24.301[28]. + +### 6.4.27 RRC-Cause-Counter + +The RRC-Cause-Counter AVP is of type Grouped and shall contain the number of receptions of "MO Exception data" and the time when the cause " MO Exception Data" is received for the first time. + +The AVP format shall conform to: + +``` + +RRC-Cause-Counter ::= + [ Counter-Value ] + [ RRC-Counter-Timestamp ] + *[AVP] + +``` + +### 6.4.28 Counter-Value + +The Counter-Value AVP is of type type Unsigned32 and shall contain the number of occurrences of reception of RRC cause "MO Exception data". + +### 6.4.29 RRC-Counter-Timestamp + +The RRC-Counter-Timestamp AVP is of type Time and shall contain a timestamp. + +### 6.4.30 Terminal-Information + +The Terminal-Information AVP is of type Grouped. This AVP shall contain the information about the user's terminal. It is originally defined in 3GPP TS 29.272 [16]. + +AVP format + +Terminal-Information ::= + +[ IMEI ] + +[ Software-Version ] + +\*[ AVP ] + +### 6.4.31 TDA-Flags + +The TDA-Flags AVP is of type Unsigned32 and it shall contain a bit map. The meaning of the bits shall be as defined in table 6.4.31-1: + +**Table 6.4.31-1: TDA-Flags** + +| Bit | Name | Description | +|------|--------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------| +| 0 | Acknowledged Delivery | This bit when set indicates that eNodeB has acknowledged the successful downlink NIDD delivery. | +| NOTE | Bits not defined in this table shall be cleared by the sending entity and discarded by the receiving entity. | | + +### 6.4.32 Idle-Status-Indication + +The Idle-Status-Indication AVP is of type Grouped, and it shall contain the details when the UE transitions into idle mode. + +AVP format: + +Idle-Status-Indication ::= + +[ Idle-Status-Timestamp ] + +[ Active-Time ] + +[ Subscribed-Periodic-RAU-TAU-Timer ] + +[ eDRX-Cycle-Length ] + +[ DL-Buffering-Suggested-Packet-Count ] + +\*[AVP] + +The Subscribed-Periodic-RAU-TAU-Timer AVP shall contain the periodic TAU/RAU time granted to the UE by the MME/SGSN. + +The eDRX-Cycle-Length AVP shall contain the eDRX cycle length granted to the UE by the MME/SGSN. + +The DL-Buffering-Suggested-Packet-Count AVP shall contain the suggested number of downlink packets sent to the S-GW by the MME/SGSN. + +### 6.4.33 Idle-Status-Timestamp + +The Idle-Status-Timestamp AVP is of type Time and shall contain a timestamp (the time at which the UE transitioned into idle mode). + +### 6.4.34 Active-Time + +Active-Time AVP is of type Unsigned32 and shall provide the active time granted to the UE in seconds. + +### 6.4.35 Reachability-Cause + +The Reachability-Cause AVP is of type Unsigned32. The following values are defined: + +CHANGE\_TO\_CONNECTED\_MODE (0) + +REACHABLE\_FOR\_PAGING (1) + +Annex A (normative): +Diameter overload control mechanism + +### 6.4.36 APN-Rate-Control-Status + +The APN-Rate-Control-Status AVP is of type Grouped. It shall contain APN Rate Control Status Information as specified in figure 8.38-10 of 3GPP TS 29.274 [33]. + +### 6.4.37 Uplink-Number-Of-Packets-Allowed + +The Uplink-Number-Of-Packets-Allowed AVP is of type Unsigned32. It shall contain information of octets k+1 to k+4 as specified in figure 8.38-10 of 3GPP TS 29.274 [33]. + +### 6.4.38 Number-Of-Additional-Exception-Reports + +The Number-Of-Additional-Exception-Reports AVP is of type Unsigned32. It shall contain information of octets k+5 to k+8 as specified in figure 8.38-10 of 3GPP TS 29.274 [33]. + +### 6.4.39 Downlink-Number-Of-Packets-Allowed + +The Downlink-Number-Of-Packets-Allowed AVP is of type Unsigned32. It shall contain information of octets k+9 to k+12 as specified in figure 8.38-10 of 3GPP TS 29.274 [33]. + +### 6.4.40 APN-Rate-Control-Status-Validity-Time + +The APN-Rate-Control-Status-Validity-Time AVP is of type Unsigned64. It shall contain information of octets k+13 to k+20 as specified in figure 8.38-10 of 3GPP TS 29.274 [33]. + +## --- A.1 T6a/b and T7 interfaces + +### A.1.1 General + +The Diameter overload control mechanism is an optional feature over the T6a/b and T7 interface, which may be applied to the traffic of requests commands sent to the SCEF and/or to the traffic of request commands sent to the MME or SGSN. + +It is recommended to make use of the IETF RFC 7683 [9] on the T6a/b and T7 interface where: + +- when applied to the traffic of request commands sent to the SCEF, the SCEF shall behave as a reporting node while the MME/SGSN, and as an alternative the IWK-SCEF shall behave as a reacting node; +- when applied to the traffic of request commands sent to the MME or SGSN, the MME or SGSN shall behave as a reporting node while the SCEF, and as an alternative the IWK-SCEF, shall behave as a reacting node. + +### A.1.2 SCEF behaviour + +The SCEF requests traffic reduction from the MME/SGSN and the IWK-SCEF when it is in an overload situation, by including OC-OLR AVP in answer commands as described in IETF RFC 7683 [9]. + +The SCEF identifies that it is in an overload situation by implementation specific means. For example, the SCEF may take into account the traffic over the T6a/b interfaces or other interfaces, the level of usage of internal resources (CPU, memory), the access to external resources etc. + +The SCEF determines the specific contents of the OC-OLR AVP in overload reports and the SCEF decides when to send OC-OLR AVPs by implementation specific means. + +The SCEF may decide to deactivate Monitoring events to reduce the number of Reporting-Information-Requests sent for reporting monitoring events. + +The SCEF shall apply required traffic reduction according to the OC-OLR AVPs received in answer commands from the MME to subsequent applicable requests, as per IETF RFC 7683 [9]. + +Requested traffic reduction is achieved by the SCEF by implementation specific means. It may in particular implement throttling of MT non-IP data messages. + +### A.1.3 MME/SGSN behaviour + +The MME or SGSN requests traffic reduction from the SCEF when it is in an overload situation, by including OC-OLR AVP in answer commands as described in IETF RFC 7683 [9]. + +The MME or SGSN identifies that it is in an overload situation by implementation specific means. + +The MME or SGSN shall apply required traffic reduction according to the OC-OLR AVPs received in answer commands from the SCEF to subsequent applicable requests, as per IETF RFC 7683 [9]. + +Requested traffic reduction is achieved by the MME or SGSN by implementation-specific means. It may in particular implement: + +- throttling of monitoring event reports or stop reporting with prioritization (e.g. prioritisation on the type of events, or that one-time reporting takes priority over continuous reporting, ...); +- throttling of new T6a/b connection establishment messages; +- throttling of MO non-IP data messages. + +### A.1.4 IWK-SCEF behaviour + +The IWK-SCEF, when acting as a reacting node towards the SCEF shall apply required traffic reduction received in answer commands from the SCEF to subsequent applicable requests received from the MME or SGSN, as per IETF RFC 7683 [9]. In this case the IWK-SCEF does not forward OC-OLR AVPs to the MME or SGSN. + +The IWK-SCEF, when acting as a reacting node towards the MME or SGSN, shall apply required traffic reduction received in answer commands from the MME or SGSN to subsequent applicable requests received from the SCEF, as per IETF RFC 7683 [9]. In this case the IWK-SCEF does not forward OC-OLR AVPs to the SCEF. + +Requested traffic reduction is achieved by the IWK-SCEF by implementation specific means. For example, it may implement throttling of monitoring event report with prioritization, throttling of MO data or MT data messages. + +# --- Annex B (normative): Diameter message priority mechanism + +## B.1 General + +IETF RFC 7944 [15] specifies a Diameter routing message priority mechanism that allows Diameter nodes to indicate the relative priority of Diameter messages. With this information, other Diameter nodes may leverage the relative priority of Diameter messages into routing, resource allocation, set the DSCP marking for transport of the associated Diameter message, and also abatement decisions when overload control is applied. + +## --- B.2 T6a, T6ai, T6b, T6bi, T7 interfaces + +The Diameter message priority mechanism is an optional feature which may apply on one or several of the T6a, T6ai, T6b, T6bi, T7 interfaces. + +It is recommended to make use of IETF RFC 7944 [15] over the T6a, T6ai, T6b, T6bi, T7 interfaces of an operator network when the overload control defined in Annex A is applied on these interfaces. + +A 3GPP functional entity supporting the Diameter message priority mechanism over one or several of the T6a, T6ai, T6b, T6bi, T7 interfaces shall comply with IETF RFC 7944 [15]. + +A 3GPP functional entity sending a request shall determine the required priority according to its policies. When priority is required, it shall include the DRMP AVP indicating the required priority level in the request it sends, and shall prioritise the request according to the required priority level. + +When the 3GPP functional element receives the corresponding response, it shall prioritise the received response according to the priority level received within the DRMP AVP if present in the response, otherwise according to the priority level of the corresponding request. + +When a 3GPP functional entity receives a request, it shall handle the request according to the received DRMP AVP priority level. For the response, it may modify the priority level received in the DRMP AVP according to its policies and shall handle the response according to the required priority level. If the required priority level is different from the priority level received in the request, it shall include the DRMP AVP in the response. + +If: + +- a 3GPP functional entity supports using the Diameter message priority mechanism for DSCP marking purposes, +- the transport network utilizes DSCP marking, and +- message-dependant DSCP marking is possible for the protocol stack transporting Diameter, + +then the 3GPP functional entity shall set the DSCP marking for transport of the request or response according to the required priority level. + +The decisions of the 3GPP functional entity for a required priority and for the priority level value are implementation specific. + +Diameter requests related to high priority traffic shall contain a DRMP AVP with a high priority of which the level value is operator dependent. + +# --- Annex C (normative): Diameter load control mechanism + +## C.1 General + +The Diameter load control mechanism is an optional feature over the T6a/b and T7 interface, which may be applied to the traffic of request commands sent to the SCEF and/or to the traffic of request commands sent to the MME/SGSN. + +It is recommended to make use of the IETF RFC 8583 [31] on the T6a/b and T7 interface where: + +- when applied to the traffic of request commands sent to the SCEF, the MME/SGSN, and as an alternative the IWK-SCEF shall behave as a reacting node; +- when applied to the traffic of request commands sent to the MME/SGSN, the SCEF, and as an alternative the IWK-SCEF, shall behave as a reacting node. + +## --- C.2 SCEF behaviour + +When performing next hop Diameter Agent selection for requests that are routed based on realm, the SCEF may take into account load values from Load AVPs of type PEER received from candidate next hop Diameter nodes, as per IETF RFC 8583 [31]. + +## --- C.3 MME/SGSN behaviour + +When performing next hop Diameter Agent selection for requests that are routed based on realm, the MME/SGSN may take into account load values from Load AVPs of type PEER received from candidate next hop Diameter nodes, as per IETF RFC 8583 [31]. + +## --- C.4 IWK-SCEF behaviour + +When performing next hop Diameter Agent selection for requests that are routed based on realm, the IWK-SCEF may take into account load values from Load AVPs of type PEER received from candidate next hop Diameter nodes, as per IETF RFC 8583 [31]. + +# --- Annex D (informative): Change history + +| Date | TSG # | TSG Doc. | CR | Rev | Cat | Subject/Comment | New | +|---------|-------|-----------|------|-----|-----|----------------------------------------------------------------------------------------------------|--------| +| 2015-05 | | | | | | Skeleton of the TS after CT4#69 | 0.0.0 | +| 2015-11 | | | | | | TS after CT4#71 | 0.1.0 | +| 2015-12 | CT#70 | CP-150625 | | | | Presented for information | 1.0.0 | +| 2016-02 | | | | | | TS after CT4#72 | 1.1.0 | +| 2016-03 | CT#71 | CP-160119 | | | | Presented for approval | 2.0.0 | +| 2016-03 | CT#71 | | | | | Cersion 13.0.0. created after CT#71 | 13.0.0 | +| 2016-06 | CT#72 | CP-160225 | 0001 | 1 | | Correction on Table 6.4.1-2 | 13.1.0 | +| 2016-06 | CT#72 | CP-160225 | 0002 | 2 | | Correction on error handling for SCEF reference ID unknown | 13.1.0 | +| 2016-06 | CT#72 | CP-160225 | 0004 | 1 | | Removing the direct configuration of MONTE events at MME via IWK-SCEF by the SCEF for roaming case | 13.1.0 | +| 2016-06 | CT#72 | CP-160225 | 0008 | 3 | | Overload control update for C IoT | 13.1.0 | +| 2016-06 | CT#72 | CP-160225 | 0011 | 1 | | Corrections on styles | 13.1.0 | +| 2016-06 | CT#72 | CP-160228 | 0003 | - | | Assignment of command codes for C IoT | 13.1.0 | +| 2016-06 | CT#72 | CP-160228 | 0005 | 4 | | Signaling the change of MME to the SCEF for a T6a connection used for SCEF PDN | 13.1.0 | +| 2016-06 | CT#72 | CP-160228 | 0006 | 4 | | Procedures updates and new AVPs over T6a for C IoT | 13.1.0 | +| 2016-06 | CT#72 | CP-160228 | 0007 | 5 | | Connection Action check for CMR | 13.1.0 | +| 2016-06 | CT#72 | CP-160228 | 0009 | 4 | | Routing considerations for C IoT | 13.1.0 | +| 2016-06 | CT#72 | CP-160228 | 0012 | 2 | | Serving PLMN Rate Control | 13.1.0 | +| 2016-06 | CT#72 | CP-160228 | 0013 | 2 | | C IoT support in introduction clause | 13.1.0 | +| 2016-06 | CT#72 | CP-160228 | 0014 | 2 | | MT Non-IP Data Delivery for UEs using a power saving function | 13.1.0 | +| 2016-06 | CT#72 | CP-160228 | 0015 | 2 | | Accept T6 Connection Establishment | 13.1.0 | +| 2016-06 | CT#72 | CP-160228 | 0016 | 4 | | Support for APN Rate Control | 13.1.0 | +| 2016-06 | CT#72 | CP-160228 | 0017 | 1 | | Charging Characteristics | 13.1.0 | +| 2016-06 | CT#72 | CP-160228 | 0018 | 2 | | Corrections in clause 5.6.3 of "Detailed Behaviour of the MME" | 13.1.0 | +| 2016-09 | CT#73 | CP-160427 | 0020 | - | | Adding missing result code | 13.2.0 | +| 2016-09 | CT#73 | CP-160423 | 0021 | 1 | | Correction of Reference for ePCO | 13.2.0 | +| 2016-09 | CT#73 | CP-160423 | 0023 | - | | MT-Data-Request command | 13.2.0 | +| 2016-09 | CT#73 | CP-160424 | 0022 | 3 | | Handling of Exception Reports in the Core Network | 13.2.0 | +| 2016-09 | CT#73 | CP-160424 | 0024 | 1 | | Sending of ePCO during the T6a connection release procedure | 13.2.0 | +| 2016-09 | CT#73 | CP-160424 | 0025 | 1 | | Missing AVP codes and Experimental-Result codes for T6a | 13.2.0 | +| 2016-09 | CT#73 | CP-160424 | 0027 | 1 | | SCEF Behaviour of Rate Control Handling | 13.2.0 | +| 2016-09 | CT#73 | CP-160573 | 0028 | 2 | | Not Able to Deliver MO Non-IP Data | 13.2.0 | +| 2016-09 | CT#73 | CP-160424 | 0029 | 1 | | T6a Connection Release after MO Data Answer with permanent error | 13.2.0 | +| 2016-09 | CT#73 | CP-160424 | 0030 | 2 | | Addition of Serving PLMN ID and IMEISV to CMR | 13.2.0 | +| 2016-09 | CT#73 | CP-160435 | 0031 | 1 | | T6b reference point for NonIP-GPRS | 14.0.0 | +| 2016-12 | CT#74 | CP-160660 | 0033 | 1 | | AVAILABILITY AFTER DDN FAILURE reporting | 14.1.0 | +| 2016-12 | CT#74 | CP-160657 | 0035 | 1 | | Reference Correction | 14.1.0 | +| 2016-12 | CT#74 | CP-160657 | 0038 | 1 | | Missing RRC-Cause-Counter AVP in the MO-Data-Request Command | 14.1.0 | +| 2016-12 | CT#74 | CP-160681 | 0039 | 1 | | Load Control | 14.1.0 | +| 2016-12 | CT#74 | CP-160680 | 0036 | 1 | | Updates to T6b for Non-IP GPRS | 14.1.0 | +| 2016-12 | CT#74 | CP-160664 | 0041 | - | | Correction to change IETF drmp draft version to official RFC 7944 | 14.1.0 | +| 2017-03 | CT#75 | CP-170036 | 0042 | 1 | | Loss Of Connectivity Reason | 14.2.0 | +| 2017-03 | CT#75 | CP-170036 | 0045 | - | | Failed-AVP AVP in Request Commands | 14.2.0 | +| 2017-03 | CT#75 | CP-170036 | 0046 | 1 | | Bit ordering in Diameter AVPs used as bit-masks | 14.2.0 | +| 2017-03 | CT#75 | CP-170039 | 0043 | 1 | | RAT-Type Change | 14.2.0 | +| 2017-03 | CT#75 | CP-170039 | 0044 | 1 | | SCEF Initiated T6 Release | 14.2.0 | +| 2017-03 | CT#75 | CP-170029 | 0048 | 1 | | Maximum UE Availability Time | 14.2.0 | +| 2017-03 | CT#75 | CP-170048 | 0049 | 1 | | Update of reference for the Diameter base protocol | 14.2.0 | +| 2017-03 | CT#75 | CP-170048 | 0050 | - | | Handling of the Vendor-Specific-Application-Id AVP | 14.2.0 | +| 2017-03 | CT#75 | CP-170048 | 0051 | - | | Cardinality of the Failed-AVP AVP in answer | 14.2.0 | +| 2017-03 | CT#75 | CP-170047 | 0052 | - | | Removal of Editor's Note on ePCO | 14.2.0 | +| 2017-06 | CT#76 | CP-171029 | 0053 | 2 | | User Identify in RIR | 14.3.0 | +| 2017-06 | CT#76 | CP-171018 | 0055 | 1 | | Support for signaling transport level packet marking | 14.3.0 | +| 2017-09 | CT#77 | CP-172018 | 0056 | 1 | | Reliable Data Service Success cause | 14.4.0 | +| 2017-09 | CT#77 | CP-172013 | 0060 | - | | Correction of DRMP Procedures | 14.4.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-------------------------------------------------------------|--------| +| 2017-09 | CT#77 | CP-172026 | 0057 | 2 | | Enhancements for NAPS on Idle Status Indication | 15.0.0 | +| 2017-09 | CT#77 | CP-172026 | 0061 | - | | Enhancements for NAPS on Accuracy | 15.0.0 | +| 2017-12 | CT#78 | CP-173017 | 0065 | 1 | | Fixing the R Bit in T6a Requests | 15.1.0 | +| 2017-12 | CT#78 | CP-173028 | 0062 | 2 | | Monitoring Event Report Status | 15.1.0 | +| 2018-03 | CT#79 | CP-180025 | 0066 | 1 | | Filtering the Report for Number of UEs in a Geographic Area | 15.2.0 | +| 2018-06 | CT#80 | CP-181130 | 0067 | 1 | | Local deletion of Monitoring events | 15.3.0 | +| 2018-12 | CT#82 | CP-183095 | 0068 | 3 | | Monitoring event report | 15.4.0 | +| 2018-12 | CT#82 | CP-183098 | 0069 | - | | Missing parameters in IdleStatusIndication | 15.4.0 | +| 2019-03 | CT#83 | CP-190038 | 0070 | - | | Missing Maximum-UE-Availability-Time AVP | 15.5.0 | +| 2019-09 | CT#85 | CP-192094 | 0074 | 2 | | draft-ietf-dime-load published as RFC 8583 | 15.6.0 | +| 2019-09 | CT#85 | CP-192122 | 0072 | 1 | | Event type PDN Connectivity Status | 16.0.0 | +| 2020-03 | CT#87e | CP-200050 | 0075 | - | | Reachability Cause | 16.1.0 | +| 2020-12 | CT#90e | CP-203032 | 0076 | - | | Extended Reference ID | 16.2.0 | +| 2021-06 | CT#92e | CP-211072 | 0077 | 1 | | Idle Status Indication | 16.3.0 | +| 2021-09 | CT#93e | CP-212073 | 0078 | 1 | F | APN Rate Control Status | 16.4.0 | +| 2021-09 | CT#93e | CP-212077 | 0079 | - | F | Correction on NIDD Feature | 16.4.0 | +| 2021-12 | | | | | | History table fixed | 16.4.1 | +| 2022-03 | CT#95e | CP-220077 | 0080 | - | F | Correction to wrong CR implementation | 16.5.0 | +| 2022-12 | CT#98e | CP-223071 | 0081 | - | F | Idle Status Indication | 16.6.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29139/1d27fed9c01eb99f6535283f35fe3bbf_img.jpg b/marked/Rel-16/29_series/29139/1d27fed9c01eb99f6535283f35fe3bbf_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b95ab17704d6b63d76d4198f02665d1badbed996 --- /dev/null +++ b/marked/Rel-16/29_series/29139/1d27fed9c01eb99f6535283f35fe3bbf_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d9dbde56316da893929275126866dff2efe95d96158fd0382421bb3b860eca94 +size 38726 diff --git a/marked/Rel-16/29_series/29139/43fec6623ab9cb223a9ff74e2d2a4402_img.jpg b/marked/Rel-16/29_series/29139/43fec6623ab9cb223a9ff74e2d2a4402_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..49a0adf277c9177d21f57fbcf4120d1f776b4418 --- /dev/null +++ b/marked/Rel-16/29_series/29139/43fec6623ab9cb223a9ff74e2d2a4402_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:68dc959bf2ee8e603c84ce4f6c2a59cabbf7f76172776f4ff483f6f8bbd02254 +size 28973 diff --git a/marked/Rel-16/29_series/29139/49ee89a1d5852ab005dbbab6de09a8a6_img.jpg b/marked/Rel-16/29_series/29139/49ee89a1d5852ab005dbbab6de09a8a6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3767ea40983cb164b8dc0e6801e4156ac983f302 --- /dev/null +++ b/marked/Rel-16/29_series/29139/49ee89a1d5852ab005dbbab6de09a8a6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:372126e7ca5e9fec6ab5d6bd7fce06ba8415e3959fc1d01feff16fd8f673eb41 +size 46582 diff --git a/marked/Rel-16/29_series/29139/9791722d75115ddcc599b07d7bc35d73_img.jpg b/marked/Rel-16/29_series/29139/9791722d75115ddcc599b07d7bc35d73_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..24d9db8a321427f4b0aeedefab3c1f0328a6d85d --- /dev/null +++ b/marked/Rel-16/29_series/29139/9791722d75115ddcc599b07d7bc35d73_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c78700beb8966b61cd51a9d76c07a3a278a76a5b0878935cd6d332f6a6e8640b +size 28339 diff --git a/marked/Rel-16/29_series/29139/raw.md b/marked/Rel-16/29_series/29139/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..d3ad1a43a50d65a9f0d77f0c80f80f1cd1fc80f6 --- /dev/null +++ b/marked/Rel-16/29_series/29139/raw.md @@ -0,0 +1,332 @@ + + + + +Error! No +text of + +Error! No text of specified style in +document. + +# Contents + +| | | +|----------------------------------------------------------------------|----| +| Foreword ..... | 4 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Definitions and abbreviations ..... | 5 | +| 3.1 Definitions..... | 5 | +| 3.2 Abbreviations ..... | 6 | +| 4 General..... | 6 | +| 4.1 Protocol Stack ..... | 6 | +| 4.1.1 Control Plane for H(e)NB – SeGW ..... | 6 | +| 4.1.2 User Plane for H(e)NB – SeGW ..... | 7 | +| 5 Supporting QoS..... | 8 | +| 5.1 General ..... | 8 | +| 5.2 H(e)NB procedures ..... | 8 | +| 5.2.1 General ..... | 8 | +| 5.2.2 QCI mapping ..... | 8 | +| 5.2.3 Reflective QoS..... | 8 | +| 5.3 SeGW procedures..... | 8 | +| 6 Tunnel Management ..... | 8 | +| 6.1 General ..... | 8 | +| 6.2 H(e)NB procedures ..... | 9 | +| 6.2.1 Tunnel establishment..... | 9 | +| 6.2.1.1 IP address allocation ..... | 9 | +| 6.2.1.2 NAT Traversal..... | 9 | +| 6.2.1.3 H(e)NB NATed Tunnel-IP address discovery..... | 9 | +| 6.2.2 Tunnel modification ..... | 9 | +| 6.2.3 Tunnel disconnection..... | 9 | +| 6.3 SeGW procedures..... | 9 | +| 6.3.1 Tunnel establishment..... | 9 | +| 6.3.1.1 IP address allocation ..... | 9 | +| 6.3.1.2 NAT Traversal..... | 10 | +| 6.3.1.3 H(e)NB NATed Tunnel-IP address discovery..... | 10 | +| 6.3.2 Tunnel modification ..... | 10 | +| 6.3.3 Tunnel disconnection..... | 10 | +| 7 PDUs and parameters specific to the present document ..... | 10 | +| 7.1 IETF RFC coding information defined within present document..... | 10 | +| 7.1.1 IKEv2 Configuration Payloads attributes..... | 10 | +| 7.1.1.1 EXTERNAL_SOURCE_IP4_NAT_INFO attribute ..... | 10 | +| Annex A (informative): Change history..... | 12 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 1 Scope + +The present document specifies the H(e)NB – SeGW interface. The interface is used for the interworking between a 3GPP system and a Fixed Broadband Access network defined by Broadband Forum. The interworking procedure provides the IP connectivity to a 3GPP UE using a H(e)NB connected to a Fixed Broadband Access network as specified in 3GPP TS 23.139 [2]. + +The specification covers the QoS aspects and Tunnel management procedures. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.139: "3GPP System-Fixed Broadband Access Network Interworking; Stage 2". +- [3] 3GPP TS 24.139: "3GPP System-Fixed Broadband Access Network Interworking; Stage 3". +- [4] IETF RFC 2474 (December 1998): "Definition of the Differentiated Services Field (DS Field) in the IPv4 and IPv6 Headers". +- [5] IETF RFC 5996: "Internet Key Exchange Protocol Version 2 (IKEv2)". +- [6] IETF RFC 3948: "UDP Encapsulation of IPsec ESP Packets". +- [7] 3GPP TS 33.320: "Security of Home Node B (HNB) / Home evolved Node B (HeNB)". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in TR 21.905 [1]. + +**H(e)NB Reflective QoS function:** H(e)NB Reflective QoS function is a H(e)NB function in order to support QoS for uplink traffic over a Fixed Broadband Access network as specified in 3GPP TS 23.139 [2]. + +**H(e)NB local IP address Info:** H(e)NB local IP address Info is defined as either the public IPv4 address or IPv6 address assigned to the H(e)NB by the Fixed Broadband Access Network domain, or the public IPv4 address and the UDP port number used by the NATed RG that is used for this H(e)NB. The public IPv4 address used by the NATed RG is assigned by the Fixed Broadband Access Network domain. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in TR 21.905 [1]. + +| | | +|--------|------------------------------------| +| DSCP | Differentiated Services Code Point | +| H(e)NB | Home (e)NodeB | + +| | | +|-------|-----------------------------| +| NAT | Network Address Translation | +| NAT-T | NAT Traversal | +| SeGW | Security Gateway | + +# 4 General + +## 4.1 Protocol Stack + +### 4.1.1 Control Plane for H(e)NB – SeGW + +![Diagram of control plane protocol stack for IPv4 transport network. It shows H(e)NB and SeGW stacks with IKEv2, UDP, IPv4, L2, and L1 layers. A NAT box in the middle contains two UDP and IPv4 layers.](1d27fed9c01eb99f6535283f35fe3bbf_img.jpg) + +The diagram illustrates the control plane protocol stack for an IPv4 transport network. On the left, the H(e)NB stack consists of five layers: IKEv2, UDP, IPv4, L2, and L1. On the right, the SeGW stack also consists of five layers: IKEv2, UDP, IPv4, L2, and L1. In the center, a NAT (Network Address Translation) box is shown, which contains two columns of layers: UDP, IPv4, L2, and L1. Lines connect the H(e)NB layers to the NAT box and the NAT box to the SeGW layers, showing the flow of traffic through the NAT device. + +Diagram of control plane protocol stack for IPv4 transport network. It shows H(e)NB and SeGW stacks with IKEv2, UDP, IPv4, L2, and L1 layers. A NAT box in the middle contains two UDP and IPv4 layers. + +#### **Legend:** + +- **IKEv2 Protocol:** This protocol is used to between H(e)NB and SeGW. The IKEv2 protocol is defined in IETF RFC 5996 [5]. + +**Figure 4.1.1-1: Control Plane for H(e)NB - SeGW Interface over IPv4 transport network** + +![Diagram of control plane protocol stack for IPv6 transport network. It shows H(e)NB and SeGW stacks with IKEv2, UDP, IPv6, L2, and L1 layers. No NAT box is present.](43fec6623ab9cb223a9ff74e2d2a4402_img.jpg) + +The diagram illustrates the control plane protocol stack for an IPv6 transport network. On the left, the H(e)NB stack consists of five layers: IKEv2, UDP, IPv6, L2, and L1. On the right, the SeGW stack also consists of five layers: IKEv2, UDP, IPv6, L2, and L1. Direct lines connect the H(e)NB layers to the SeGW layers, indicating a direct connection without a NAT device in the control plane path. + +Diagram of control plane protocol stack for IPv6 transport network. It shows H(e)NB and SeGW stacks with IKEv2, UDP, IPv6, L2, and L1 layers. No NAT box is present. + +#### **Legend:** + +- **IKEv2 Protocol:** This protocol is used to between H(e)NB and SeGW. The IKEv2 protocol is defined in RFC 5996 [5]. + +**Figure 4.1.1-2: Control Plane for H(e)NB - SeGW Interface over IPv6 transport network** + +### 4.1.2 User Plane for H(e)NB – SeGW + +![Diagram of User Plane for H(e)NB - SeGW Interface over IPv4 transport network with NAT](49ee89a1d5852ab005dbbab6de09a8a6_img.jpg) + +The diagram illustrates the user plane protocol stack for H(e)NB and SeGW over an IPv4 transport network with NAT. The stack layers are shown in a table format: + +| | | | | +|---------|------|------|---------| +| Payload | | | Payload | +| IPsec | | | IPsec | +| UDP | UDP | UDP | UDP | +| IPv4 | IPv4 | IPv4 | IPv4 | +| L2 | L2 | L2 | L2 | +| L1 | L1 | L1 | L1 | + +The H(e)NB and SeGW stacks are connected via a NAT box (dashed line) that contains two parallel paths for UDP and IPv4. The NAT box is labeled "NAT" and is positioned between the H(e)NB and SeGW. + +Diagram of User Plane for H(e)NB - SeGW Interface over IPv4 transport network with NAT + +#### **Legend:** + +- **UDP:** UDP encapsulation is used if NAT is detected between the H(e)NB and the SeGW. + +**Figure 4.1.2-1: User Plane for H(e)NB - SeGW Interface over IPv4 transport network** + +![Diagram of User Plane for H(e)NB - SeGW Interface over IPv6 transport network](9791722d75115ddcc599b07d7bc35d73_img.jpg) + +The diagram illustrates the user plane protocol stack for H(e)NB and SeGW over an IPv6 transport network. The stack layers are shown in a table format: + +| | | | +|---------|--|---------| +| Payload | | Payload | +| IPsec | | IPsec | +| IPv6 | | IPv6 | +| L2 | | L2 | +| L1 | | L1 | + +The H(e)NB and SeGW stacks are connected directly without a NAT box. The H(e)NB is on the left and the SeGW is on the right. + +Diagram of User Plane for H(e)NB - SeGW Interface over IPv6 transport network + +**Figure 4.1.2-2: User Plane for H(e)NB - SeGW Interface over IPv6 transport network** + +# 5 Supporting QoS + +## 5.1 General + +At interworking with a Fixed Broadband Access network, QoS is provided by DSCP marking as specified in IETF RFC 2474 [4]. + +## 5.2 H(e)NB procedures + +### 5.2.1 General + +The H(e)NB shall support DSCP marking on the IPsec header when forwarding the UE uplink traffic. + +Based on H(e)NB configuration either the QCI mapping or the Reflective QoS may be used. + +### 5.2.2 QCI mapping + +The QCI mapping table contains a one-to-one mapping from QCI value to DSCP marking value. The QCI mapping table is configured in the H(e)NB by the operator. + +When forwarding an uplink IP packet, the H(e)NB shall perform a lookup in the QCI mapping table based on the QCI value of the EPS bearer/PDP context before the IPsec tunnel encapsulation. The H(e)NB shall set the DSCP marking value of the IPsec header according to the matched QCI mapping table entry. + +### 5.2.3 Reflective QoS + +To support the H(e)NB Reflective QoS function for uplink traffic, the H(e)NB shall create and maintain the uplink DSCP marking rules for each active PDN connection as specified for UE Reflective QoS function in 3GPP TS 24.139 [3]. + +When forwarding an uplink IP packet, the H(e)NB shall perform a lookup in the DSCP marking table based on the n-tuple of the IP header before the IPsec tunnel encapsulation. If a matching entry is found, the H(e)NB shall set the DSCP marking value of the IPsec header according to the matched DSCP marking rule. If no matching entry is found, the H(e)NB shall copy the DSCP field of the outer IP header into the IPsec header before forwarding to the SeGW. + +## 5.3 SeGW procedures + +When receiving a downlink data packet, the SeGW shall copy the DSCP marking value from the outer IP header into the IPsec header before forwarding to the H(e)NB using the IPsec tunnel, as specified in 3GPP TR 23.139 [2]. + +# --- 6 Tunnel Management + +## 6.1 General + +The tunnel is an IPsec tunnel established via an IKEv2 protocol exchange IETF RFC 5996 [5] between the H(e)NB and the SeGW which is through the Fixed Broadband Access Network. + +In an IPv4 Fixed Broadband Access Network, NAT can be deployed between the H(e)NB and the SeGW, e.g. in a Residence Gateway. A H(e)NB behind the NAT shall invoke the NAT traversal procedure for IKEv2. The IPsec tunnel is encapsulated over UDP in the Tunnel-Mode as specified in IETF RFC 5996 [5]. + +## 6.2 H(e)NB procedures + +### 6.2.1 Tunnel establishment + +#### 6.2.1.1 IP address allocation + +The SeGW shall provide the IP address to the H(e)NB for the communication with the EPC network. + +For dynamic IP address allocation, the H(e)NB shall include the requested IP address type (IPv4 address or IPv6 address) that needs to be configured in an IKEv2 CFG\_REQUEST Configuration Payload in the IKE\_AUTH request message as defined in IETF RFC 5996 [5] after reception of the IKE\_SA\_INIT response from the SeGW. + +#### 6.2.1.2 NAT Traversal + +NAT can be deployed in an IPv4 Fixed Broadband Access Network. IKEv2 NAT Traversal specified in section 2.23 of IETF RFC 5996 [5] shall be supported by H(e)NB. + +If NAT is detected between the H(e)NB and SeGW, the following procedures shall be performed: + +- UDP-Encapsulated ESP as defined in IETF RFC 5996 [5]; +- sending the NAT-keepalive packet to keep NAT mapping alive if no other packet to the SeGW has been sent in M seconds as defined in the IETF RFC 3948 [6]; + +NOTE: M is a locally configurable parameter with a default value of 20 seconds as defined in the IETF RFC 3948 [6]. + +#### 6.2.1.3 H(e)NB NATed Tunnel-IP address discovery + +If NAT is detected between the H(e)NB and SeGW, the H(e)NB shall request the SeGW to return the H(e)NB local IP address information by including the EXTERNAL\_SOURCE\_IP4\_NAT\_INFO attribute as defined in subclause 7.1.1.1 + +in the CFG\_REQUEST Configuration Payload within the IKE\_AUTH request message. The length field of the attribute shall be set to zero. The NATed IPv4 Address field and UDP Port number field shall be absent. + +If the H(e)NB subsequently receives the EXTERNAL\_SOURCE\_IP4\_NAT\_INFO attribute in the CFG\_REPLY configuration payload from the SeGW, the H(e)NB shall report the IP address received in EXTERNAL\_SOURCE\_IP4\_NAT\_INFO attribute as the H(e)NB local IP address to the MME/SGSN. + +### 6.2.2 Tunnel modification + +NAT mappings can change when the UDP port number is reassigned by the NAT, and/or H(e)NB local IP address is reallocated due to NAT restart. + +Upon NAT remapping, the SeGW initiates the tunnel disconnection procedure as specified in subclause 6.3.3. Then the H(e)NB shall re-initiate the tunnel establishment procedure as specified in sub-clause 6.2.1. + +### 6.2.3 Tunnel disconnection + +The H(e)NB shall use the procedures defined in IETF RFC 5996 [5] to disconnect an IPsec tunnel to the SeGW. + +## 6.3 SeGW procedures + +### 6.3.1 Tunnel establishment + +#### 6.3.1.1 IP address allocation + +For dynamic IP address allocation, upon receipt of an IKE\_AUTH request message from the H(e)NB requesting the IP address, the SeGW shall include the remote IP address information in the IKEv2 Configuration Payload (CFG\_REPLY) of the final IKE\_AUTH response message to the H(e)NB. The SeGW shall assign either an IPv4 or an IPv6 address to the H(e)NB via a single CFG\_REPLY Configuration Payload. + +#### 6.3.1.2 NAT Traversal + +NAT can be deployed in an IPv4 Fixed Broadband Access Network. IKEv2 NAT Traversal specified in section 2.23 of IETF RFC 5996 [5] shall be supported by SeGW. + +If NAT is detected between the H(e)NB and SeGW, the SeGW shall use UDP-Encapsulated ESP as defined in IETF RFC 5996 [5]. + +#### 6.3.1.3 H(e)NB NATed Tunnel-IP address discovery + +If the SeGW receives the EXTERNAL\_SOURCE\_IP4\_NAT\_INFO attribute as defined in subclause 7.1.1.1 in the CFG\_REQUEST configuration payload within IKE\_AUTH request message, the SeGW shall provide the H(e)NB local IP address information (i.e. NATed IPv4 address and UDP port number) to the H(e)NB by including the EXTERNAL\_SOURCE\_IP4\_NAT\_INFO attribute in the CFG\_REPLY configuration payload within the IKE\_AUTH response message. + +### 6.3.2 Tunnel modification + +NAT mappings can change when the UDP port number is reassigned by the NAT, and/or H(e)NB local IP address is reallocated due to NAT restart. + +If NAT remapping is detected by the SeGW, the SeGW shall initiate the tunnel disconnection procedure (see subclause 6.3.3). + +NOTE: No procedures are defined in current release of specification to enable the SeGW to send the modified H(e)NB local IP address information to the H(e)NB during the lifetime of IKEv2 security association. + +### 6.3.3 Tunnel disconnection + +The SeGW shall use the procedures defined in IETF RFC 5996 [5] to disconnect an IPsec tunnel to the H(e)NB. + +# 7 PDUs and parameters specific to the present document + +## 7.1 IETF RFC coding information defined within present document + +### 7.1.1 IKEv2 Configuration Payloads attributes + +#### 7.1.1.1 EXTERNAL\_SOURCE\_IP4\_NAT\_INFO attribute + +The format of the EXTERNAL\_SOURCE\_IP4\_NAT\_INFO attribute follows the definition of Configuration Attributes as specified in IETF RFC 5996 [5], section 3.15.1. The format is shown in figure 7.1.1.1-1 as below. The length of the EXTERNAL\_SOURCE\_IP4\_NAT\_INFO attribute is 0 or 6 bytes. + +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | Octets | | | | | | | | +|--------------------|----------------|---|---|---|---|---|---|--------|--|--|--|--|--|--|--| +| R | Attribute Type | | | | | | | 1 | | | | | | | | +| Attribute Type | | | | | | | | 2 | | | | | | | | +| Length | | | | | | | | 3, 4 | | | | | | | | +| NATed IPv4 Address | | | | | | | | 5 - 8 | | | | | | | | +| UDP Port number | | | | | | | | 9 - 10 | | | | | | | | + +Figure 7.1.1.1-1: EXTERNAL\_SOURCE\_IP4\_NAT\_INFO attribute + +The R bit in the first octet is as defined in IETF RFC 5996 [5]. + +The Attribute Type indicating EXTERNAL\_SOURCE\_IP4\_NAT\_INFO is of the value 23. + +# Annex A (informative): Change history + +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | New | +|---------|--------|-----------|------|-----|------------------------------------------------------------------------------------------------|--------| +| 2012-12 | CT#58 | CP-120895 | | | V2.0.0 presented for approval | 11.0.0 | +| 2012-12 | CT#58 | CP-120697 | 0001 | - | Removal of invalid reference and editor's note | 11.1.0 | +| 2014-09 | - | - | - | - | Update to Rel-12 version (MCC) | 12.0.0 | +| 2015-12 | - | - | - | - | Update to Rel-13 version (MCC) | 13.0.0 | +| 2016-03 | CT#71 | CP-160019 | 0004 | 1 | Complete the EXTERNAL_SOURCE_IP4_NAT_INFO attribute information according to IANA registration | 13.1.0 | +| 2017-03 | CT#75 | - | - | - | Update to Rel-14 version (MCC) | 14.0.0 | +| 2018-06 | CT#80 | - | - | - | Update to Rel-15 version (MCC) | 15.0.0 | +| 2020-07 | CT#88e | - | - | - | Update to Rel-16 version (MCC) | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29153/1a827b10290f33d4fec04d0e8ef7a897_img.jpg b/marked/Rel-16/29_series/29153/1a827b10290f33d4fec04d0e8ef7a897_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e6539a591baa6f961cc30a59bd8490b83f42348b --- /dev/null +++ b/marked/Rel-16/29_series/29153/1a827b10290f33d4fec04d0e8ef7a897_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:afa944e6c79ec180d44b81d26ca832fd45912431b7c31303016e8729d32d751e +size 15083 diff --git a/marked/Rel-16/29_series/29153/7efae06af3af43ffe5d4b956a679cf54_img.jpg b/marked/Rel-16/29_series/29153/7efae06af3af43ffe5d4b956a679cf54_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2fe03272132ba9587168d8688dfd5642f780186e --- /dev/null +++ b/marked/Rel-16/29_series/29153/7efae06af3af43ffe5d4b956a679cf54_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6c509ccc86e9a766f22a442a14e2257412cab18b6c431f836b62357abe60a38a +size 15299 diff --git a/marked/Rel-16/29_series/29153/c67d21fb3d9042e88cdc669f071b4e7c_img.jpg b/marked/Rel-16/29_series/29153/c67d21fb3d9042e88cdc669f071b4e7c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0507bd7d349104800696c4182dbb4a865d305a12 --- /dev/null +++ b/marked/Rel-16/29_series/29153/c67d21fb3d9042e88cdc669f071b4e7c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d5d39a2bd34f88bbf03810c5515bf2c235cfad89562f7b6d2532e47bba3c4f8e +size 15124 diff --git a/marked/Rel-16/29_series/29153/cfbf0f2ddbc35370b0b8c6d043f25eb2_img.jpg b/marked/Rel-16/29_series/29153/cfbf0f2ddbc35370b0b8c6d043f25eb2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..64a8d628c3df84953adc05945c9beec7f771b56d --- /dev/null +++ b/marked/Rel-16/29_series/29153/cfbf0f2ddbc35370b0b8c6d043f25eb2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:50c7c405b7c6f8fb4a3de4c6c5cb5061a18ba5b4efcc2cb5019c8bcc94083c8b +size 6969 diff --git a/marked/Rel-16/29_series/29153/raw.md b/marked/Rel-16/29_series/29153/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..f579b56f713102594bcb85dcccd68d61b4f1046a --- /dev/null +++ b/marked/Rel-16/29_series/29153/raw.md @@ -0,0 +1,617 @@ + + + + +Error! No +text of + +Error! No text of specified style in +document. + +# Contents + +| | | +|--------------------------------------------------------------------------------|-----------| +| Foreword ..... | 4 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Definitions and abbreviations ..... | 6 | +| 3.1 Definitions..... | 6 | +| 3.2 Abbreviations ..... | 6 | +| 4 Architectural Overview..... | 6 | +| 4.0 Overview ..... | 6 | +| 4.1 Reference Model ..... | 6 | +| 4.2 Functional elements..... | 7 | +| 4.2.1 RCAF..... | 7 | +| 4.2.2 SCEF..... | 7 | +| 4.3 Procedures over the Ns reference point..... | 7 | +| 4.3.1 Network status reporting procedures..... | 7 | +| 4.3.1.1 General..... | 7 | +| 4.3.1.2 Request of one-time or continuous reporting of network status..... | 7 | +| 4.3.1.3 Continuous reporting of network status..... | 8 | +| 4.3.1.4 Cancellation of continuous reporting of network status ..... | 8 | +| 4.3.2 RCAF selection ..... | 9 | +| 5 Ns protocol..... | 9 | +| 5.1 Protocol support ..... | 9 | +| 5.2 Initialization, maintenance and termination of connection and session..... | 9 | +| 5.3 Ns specific AVPs ..... | 9 | +| 5.3.1 General ..... | 9 | +| 5.3.2 Network-Congestion-Area-Report AVP ..... | 10 | +| 5.3.3 Ns-Request-Type AVP..... | 10 | +| 5.4 Ns re-used AVPs..... | 10 | +| 5.4.1 General ..... | 10 | +| 5.4.2 Use of the Supported-Features AVP on the Ns reference point..... | 11 | +| 5.5 Ns specific Experimental-Result-Code AVP values..... | 12 | +| 5.5.1 General ..... | 12 | +| 5.5.2 Success ..... | 12 | +| 5.5.3 Permanent Failures ..... | 12 | +| 5.5.4 Transient Failures ..... | 12 | +| 5.6 Ns messages ..... | 12 | +| 5.6.1 Command-Code Values..... | 12 | +| 5.6.2 Network-Status-Request (NSR) command..... | 13 | +| 5.6.3 Network-Status-Answer (NSA) command..... | 13 | +| 5.6.4 Network-Status-Continuous-Report-Request (NCR) command..... | 14 | +| 5.6.5 Network-Status-Continuous-Report-Answer (NCA) command ..... | 14 | +| Annex A (informative): Call Flows over Ns..... | 14 | +| A.1 Request of one time or continuous reporting of network status ..... | 14 | +| A.2 Continuous reporting of network status..... | 15 | +| A.3 Cancellation of continuous reporting of network status ..... | 15 | +| Annex B (informative): Change history..... | 17 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 1 Scope + +This document defines the protocol for Ns reference point between the Service Capability Exposure Function (SCEF) and RAN Congestion Awareness Function (RCAF). + +The Ns reference point and related stage 2 procedures are defined in 3GPP TS 23.682 [2]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.682: "Architecture enhancements to facilitate communications with packet data networks and applications ". +- [3] IETF RFC 3588: "Diameter Base Protocol". +- [4] 3GPP TS 29.217: "Congestion reporting over Np reference point". +- [5] IETF RFC 7683: "Diameter Overload Indication Conveyance". +- [6] 3GPP TS 29.229: "Cx and Dx interfaces based on Diameter protocol; Protocol details". +- [7] 3GPP TS 29.336: "Home Subscriber Server (HSS) diameter interfaces for interworking with packet data networks and applications Diameter Base Protocol". +- [8] 3GPP TS 29.154: "Service Capability Exposure Functionality over Nt reference point". +- [9] 3GPP TS 29.274: "3GPP Evolved Packet System. Evolved GPRS Tunnelling Protocol for EPS (GTPv2)". +- [10] IETF RFC 5719: "Updated IANA Considerations for Diameter Command Code Allocations". +- [11] IETF RFC 2234: "Augmented BNF for syntax specifications". +- [12] 3GPP TS 29.213: "Policy and charging control signalling flows and Quality of Service (QoS) parameter mapping". +- [13] IETF RFC 7944: "Diameter Routing Message Priority". +- [14] IETF RFC 8583: "Diameter Load Information Conveyance". +- [15] IETF RFC 6733: "Diameter Base Protocol". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in TR 21.905 [1]. + +| | | +|------|------------------------------------------| +| AS | Application Server | +| DRMP | Diameter Routing Message Priority | +| NCA | Network Status Continuous Report Answer | +| NCR | Network Status Continuous Report Request | +| NSA | Network Status Answer | +| NSR | Network Status Request | +| RCAF | RAN Congestion Awareness Function | +| SCEF | Service Capability Exposure Function | +| SCS | Service Capability Server | + +# 4 Architectural Overview + +## 4.0 Overview + +The Ns reference point is located between the RCAF and SCEF. The Ns reference point is used for network status reporting. + +The stage 2 level requirements for the Ns reference point are defined in 3GPP TS 23.682 [2]. + +Refer to Annex G of 3GPP TS 29.213 [12] for Diameter overload control procedures over the Ns reference point. + +Refer to Annex J of 3GPP TS 29.213 [12] for Diameter message priority mechanism procedures over the Ns interface. + +Refer to Annex K of 3GPP TS 29.213 [12] for Diameter load control procedures over the Ns reference point. + +## 4.1 Reference Model + +The Ns reference point is defined between the RCAF and the SCEF to transfer the network status. The relationship between the two functional entities is depicted in figure 4.1.1. The complete 3GPP architecture for service capability exposure is defined in 3GPP TS 23.682 [2]. + +![Diagram of the Ns reference model showing RCAF and SCEF connected by the Ns reference point.](cfbf0f2ddbc35370b0b8c6d043f25eb2_img.jpg) + +The diagram shows two light green rectangular boxes, labeled 'RCAF' and 'SCEF', connected by a horizontal line. Above the line, between the boxes, is the label 'Ns'. A small vertical tick mark is present on the line directly below the 'Ns' label. + +Diagram of the Ns reference model showing RCAF and SCEF connected by the Ns reference point. + +Figure 4.1.1: Ns reference model + +## 4.2 Functional elements + +### 4.2.1 RCAF + +The RCAF is a functional element which reports network status to the SCEF to enable the SCEF to take the RAN user plane congestion status into account. The network status includes the following information; + +- Congestion level or an indication of the "no congestion" state; +- ECGI, or eNB-ID, or SAI for which the congestion level is being provided. + +### 4.2.2 SCEF + +The SCEF is a functional element which provides a means to securely expose the services and capabilities provided by 3GPP network interfaces. + +Based on the geographical area provided by the SCS/AS and the configuration data, the SCEF determines from which RCAF(s) to request congestion reporting. + +**NOTE:** The procedures in 3GPP TS 23.682 [2], subclause 5.8, describe the interaction between the SCEF and SCS/AS and the information elements exchanged in the relevant steps of each procedure. When the SCEF receives the network status information from one or more RCAF(s) in both the one-time or continuous reporting cases, it determines the Network Status Indication (NSI) of the geographical area based on the Congestion-Level-Value AVP in the Network-Congestion-Area-Report AVP it receives from the RCAF(s). The NSI value (e.g. High, Medium, Low, No-Congestion) is determined per Service Provider policies. + +## 4.3 Procedures over the Ns reference point + +### 4.3.1 Network status reporting procedures + +#### 4.3.1.1 General + +This clause contains the detailed procedures for: + +- Requesting one-time or continuous network status report ; +- Continuous reporting of network status; +- Cancellation of continuous reporting of network status. + +#### 4.3.1.2 Request of one-time or continuous reporting of network status + +This procedure shall be used by the SCEF to request one-time or continuous network status report. + +This procedure is mapped to Network-Status-Request /Answer commands specified in subclause 5.6. + +After the SCEF authorized a SCS/AS request for notification about the network status, the SCEF shall assign an SCEF Reference ID and identify the RCAF(s) responsible for requesting of the network status report. The identity of the RCAF is found by the SCEF based on the RCAF selection procedure defined in subclause 4.3.2. If multiple RCAF(s) have been found, the procedure shall be invoked multiple times, for each RCAF responsible for the network status report. + +The SCEF shall send a Network-Status-Request (NSR) command to the targeted RCAF. The NSR shall include the Ns-Request-Type AVP with the value 0 (initial request), the SCEF reference ID within SCEF-Reference-ID AVP and the location area in the Network-Area-Info-List AVP, the location area is either a 3GPP location area (e.g. list of TA/RAs, list of cell(s), list of eNBs etc) according to operator configuration or a 3GPP location area (e.g. list of TA/RAs, list of cell(s), list of eNBs etc) as provided by the SCS/AS. + +The SCEF may also include duration in the Monitoring-Duration AVP and the threshold value(s) in Congestion-Level-Range AVP if the SCS/AS requested reporting for specific threshold(s). The duration indicates the time for which a continuous reporting is requested. + +The SCEF, based on operator policies, may choose a different threshold value than the one received from the SCS/AS. The SCEF shall not include the Congestion-Level-Range AVP in the request to the RCAF if no threshold was requested by the SCS/AS. + +**NOTE:** The SCS/AS can be notified when the SCEF changes the threshold provided by the SCS/AS. + +If the continuous reporting is requested, the SCEF shall include the SCEF Id in the SCEF-ID AVP in the NSR command. + +Upon reception of a Network-Status-Request (NSR) command including the Ns-Request-Type AVP with the value 0 (initial request), the RCAF shall send the Network-Status-Answer (NSA) command to the SCEF including the SCEF-Reference-ID AVP and one or more congestion status(es) within Network-Congestion-Area-Report AVP(s). If the Monitoring-Duration AVP is present in the NSR, the RCAF shall store the SCEF Id and the SCEF instruction, and then start to monitor the location area for a change in the congestion status. + +When receiving NSA from the RCAF, the SCEF shall store the report if the SCS/AS request identified via the SCEF reference ID is valid and active. + +#### 4.3.1.3 Continuous reporting of network status + +This procedure shall be used by the RCAF to continuously notify the SCEF of the congestion status list for the location area requested by the SCEF when at least one of the following conditions applies: + +- a threshold is not provided by the SCEF and the congestion level(s) is changed; +- one or more thresholds are provided by the SCEF and the congestion level(s) is changed which corresponds to the threshold(s) provided. + +This procedure is mapped to Network-Status-Continuous-Report-Request/Answer commands specified in subclause 5.6. + +If one or more thresholds was provided to the RCAF by the SCEF, and when the RCAF detects a change in the congestion level(s) and this congestion level(s) corresponds to congestion threshold(s) for the location area (e.g. set of cells or eNodeBs) requested by the SCEF, the RCAF shall send Network-Status-Continuous-Report-Request (NCR) command to report this to the SCEF. + +The NCR command shall include SCEF reference ID within the SCEF-Reference-ID AVP and congestion status within one or more Network-Congestion-Area-Report AVP(s). + +If no threshold was provided to the RCAF by the SCEF, see subclause 4.3.1.2, and when the RCAF detects a change in the congestion level(s) for the location area (e.g. set of cells or eNodeBs) requested by the SCEF, the RCAF shall report the change of congestion level value(s) to the SCEF by sending a NCR command including SCEF reference ID within SCEF-Reference-ID AVP and one or more congestion level value(s) within Network-Congestion-Area-Report AVP(s). + +The RCAF shall include one Network-Congestion-Area-Report AVP per congestion level value reported. Within the Network-Congestion-Area-Report AVP the congestion level value shall be included in the Congestion-Level-Value AVP and the affected location area in the Network-Area-Info-List AVP. + +The RCAF shall send an NCR command to the destination SCEF by including the SCEF id within the Destination-Host AVP. + +The SCEF shall acknowledge the NCR command by sending Network-Status-Continuous-Report-Answer (NCA) command. + +#### 4.3.1.4 Cancellation of continuous reporting of network status + +This procedure shall be used by the SCEF to request the cancellation of the continuous network status report. + +This procedure is mapped to Network-Status-Request (NSR)/Network-Status-Answer (NSA) commands specified in subclause 5.6. + +When the SCEF detects that the duration for ongoing continuous reporting of network status is over or is requested to terminate ongoing continuous reporting of network status by the SCS/AS, the SCEF shall identify the RCAF(s) involved in the continuous reporting represented by the SCEF reference ID and send a Network-Status-Request (NSR) command to the identified RCAF(s) including the SCEF reference ID in SCEF-Reference-ID AVP and the Ns-Request-Type AVP with the value 1 (cancellation request). + +Upon reception of a NSR command including the Ns-Request-Type AVP with the value 1 (cancellation request), the RCAF shall remove the related SCEF instructions associated with the SCEF reference ID such that the RCAF will no longer notify the SCEF of the change of the network status and send a Network-Status-Answer (NSA) command including the corresponding SCEF reference ID in the SCEF-Reference-ID AVP to acknowledge the cancellation. + +### 4.3.2 RCAF selection + +To discover the RCAF(s) responsible for reporting of network status, the SCEF may use the following information: + +- Geographical area provided by SCS/AS; +- Pre-configured RCAF address for the geographical area the RCAF is responsible for; + +# 5 Ns protocol + +## 5.1 Protocol support + +The Ns application is defined as a vendor specific Diameter application, where the vendor is 3GPP and the Application-ID for the Ns Application in the present release is 16777347. The vendor identifier assigned by IANA to 3GPP () is 10415. + +NOTE: A route entry can have a different destination based on the application identification AVP of the message. Therefore, Diameter agents (relay, proxy, redirection, translation agents) must be configured appropriately to identify the 3GPP Ns application within the Auth-Application-Id AVP in order to create suitable routing tables. + +With regard to the Diameter protocol defined over the Ns interface, the RCAF acts as a Diameter server, in the sense that it is the network element that handles network status reporting requests for a particular location. The SCEF acts as the Diameter client, in the sense that is the network element requesting reporting of network status. + +## 5.2 Initialization, maintenance and termination of connection and session + +The initialization and maintenance of the connection between each SCEF and RCAF pair is defined by the underlying protocol. Establishment and maintenance of connections between Diameter nodes is described in IETF RFC 6733 [15]. + +After establishing the transport connection, the SCEF and the RCAF shall advertise the support of the Ns specific Application by including the value of the application identifier in the Auth-Application-Id AVP and the value of the 3GPP (10415) in the Vendor-Id AVP of the Vendor-Specific-Application-Id AVP contained in the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands. The Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands are specified in the Diameter Base Protocol (IETF RFC 6733 [15]). + +The Ns Diameter session shall consist of a single request and answer pair. The Ns Diameter session is terminated after each request and answer pair interaction. In order to indicate that the session state is not to be maintained, the Diameter client and server shall include the Auth-Session-State AVP with the value set to NO\_STATE\_MAINTAINED (1), in the request and in the answer messages (see IETF RFC 6733 [15]). + +## 5.3 Ns specific AVPs + +### 5.3.1 General + +Table 5.3.1.1 describes the Diameter AVPs defined for the Ns reference point, their AVP Code values, types, possible flag values, whether or not the AVP may be encrypted and which supported features the AVP is applicable to. The Vendor-Id header of all AVPs defined in the present document shall be set to 3GPP (10415). + +**Table 5.3.1.1: Ns specific Diameter AVPs** + +| Attribute Name | AVP Code | Clause defined | Value Type (NOTE 2) | AVP Flag rules (NOTE 1) | | | | May Encr. | Applicability (NOTE 3) | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|----------------|---------------------|-------------------------|-----|------------|----------|-----------|------------------------| +| | | | | Must | May | Should not | Must not | | | +| Network-Congestion-Area-Report | 4101 | 5.3.2 | Grouped | M,V | P | | | Y | | +| Ns-Request-Type | 4102 | 5.3.3 | Unsigned32 | M,V | P | | | Y | | +| NOTE 1: The AVP header bit denoted as 'M', indicates whether support of the AVP is required. The AVP header bit denoted as 'V', indicates whether the optional Vendor-ID field is present in the AVP header. For further details, see IETF RFC 6733 [15]. | | | | | | | | | | +| NOTE 2: The value types are defined in IETF RFC 6733 [15]. | | | | | | | | | | +| NOTE 3: AVPs marked with a supported feature are applicable as described in subclause 5.4.1. | | | | | | | | | | + +### 5.3.2 Network-Congestion-Area-Report AVP + +The Network-Congestion-Area-Report AVP (AVP code 4101) is of type Grouped, and includes the Network-Area-Info-List AVP and the Congestion-Level-Value-AVP. + +AVP Format: + +``` +Network-Congestion-Area-Report ::= < AVP Header: 4101 > + { Network-Area-Info-List } + [ Congestion-Level-Value ] + *[ AVP ] +``` + +### 5.3.3 Ns-Request-Type AVP + +The Ns-Request-Type AVP (AVP code 4102) is of type Unsigned32, and contains the reason for sending a request message. + +The following values are defined: + +0 (initial request) + +An initial request is used to initiate a one time or continuous reporting and contains information that is relevant to initiation. + +1 (cancellation request) + +A cancellation request is used to cancel an ongoing continuous reporting. + +## 5.4 Ns re-used AVPs + +### 5.4.1 General + +Table 5.4.1.1 lists the Diameter AVPs re-used by the Ns reference point from other existing Diameter Applications, reference to their respective specifications, short description of their usage within the Ns reference point and which supported features the AVP is applicable to. AVPs from existing Diameter Applications, except for the AVPs from Diameter base protocol, do not need to be supported. Unless otherwise stated, re-used AVPs shall maintain their 'M', 'P' and 'V' flag settings. + +**Table 5.4.1.1: Ns re-used Diameter AVPs** + +| Attribute Name | Reference | Description | Applicability (NOTE ) | +|--------------------------------------------------------------------------------------------|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------| +| Congestion-Level-Range | 3GPP TS 29.217 [4] | It indicates the list of congestion level(s). | | +| Congestion-Level-Value | 3GPP TS 29.217 [4] | Indicates the congestion level of a location. | | +| DRMP | IETF RFC 7944 [13] | Allows Diameter endpoints to indicate the relative priority of Diameter transactions. | | +| Load | IETF RFC 8583 [14] | The AVP used to convey load information between Diameter nodes.
This AVP and all AVPs within this grouped AVP shall have the 'M' bit cleared. | | +| Monitoring-Duration | 3GPP TS 29.336 [7] | It shall contain the number of seconds for which network status reporting shall be performed. | | +| Network-Area-Info-List | 3GPP TS 29.154 [8] | It contains the network area information which is coded as specified in 3GPP TS 29.274 [9] in Presence Reporting Area Action IE, starting from octet 9. | | +| OC-OLR | IETF RFC 7683 [5] | Contains the necessary information to convey an overload report. | | +| OC-Supported-Features | IETF RFC 7683 [5] | Defines the support for the Diameter overload indication conveyance by the sending node. | | +| SCEF-ID | 3GPP TS 29.336 [7] | It shall contain the identity of the SCEF which has requested the network status reporting. | | +| SCEF-Reference-ID | 3GPP TS 29.336 [7] | It contains the identifier provided by the SCEF. | | +| Supported-Features | 3GPP TS 29.229 [6] | If present, this AVP informs the destination host about the features that the origin host requires to successfully complete this command exchange. | | +| NOTE: AVPs marked with a supported feature are applicable as described in subclause 5.4.2. | | | | + +### 5.4.2 Use of the Supported-Features AVP on the Ns reference point + +When new functionality is introduced on the Ns reference point, it should be defined as optional. If backwards incompatible changes cannot be avoided, the new functionality shall be introduced as a new feature and support advertised with the Supported-Features AVP. Unless otherwise stated, the use of the Supported-Features AVP on the Ns reference point shall be compliant to the usage of the Supported-Features AVP on the Cx reference point and consistent with the procedures for the dynamic discovery of supported features as defined in subclause 7.2 of 3GPP TS 29.229 [6]. + +When extending the application by adding new AVPs for a feature, the new AVPs shall have the M bit cleared and the AVP shall not be defined mandatory in the command ABNF. + +As defined in 3GPP TS 29.229 [6], the Supported-Features AVP is of type grouped and contains the Vendor-Id, Feature-List-ID and Feature-List AVPs. On the all reference points as specified in this specification, the Supported-Features AVP is used to identify features that have been defined by 3GPP and hence, for features defined in this document, the Vendor-Id AVP shall contain the vendor ID of 3GPP (10415). If there are multiple feature lists defined for the reference point, the Feature-List-ID AVP shall differentiate those lists from one another. + +The Supported-Features AVP shall be included in every NSR and NSA command if supported by the RCAF and SCEF respectively. + +The Table 5.4.2.1 defines the features applicable to the Ns reference point for the feature list with a Feature-List-ID of 1. + +**Table 5.4.2.1: Features of Feature-List-ID 1 used in Ns** + +| Feature bit | Feature | M/O | Description | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|-----|-------------| +| Feature bit: The order number of the bit within the Feature-List AVP where the least significant bit is assigned number "0".
Feature: A short name that can be used to refer to the bit and to the feature, e.g. "EPS".
M/O: Defines if the implementation of the feature is mandatory ("M") or optional ("O") in this 3GPP Release.
Description: A clear textual description of the feature. | | | | + +NOTE: This table is a placeholder for when any supported features are added to Ns. There are no supported features in this release. + +## 5.5 Ns specific Experimental-Result-Code AVP values + +### 5.5.1 General + +This clause defines result code values that shall be supported by Diameter implementations that conform to this specification. + +### 5.5.2 Success + +Result Codes that fall into the Success category are used to inform a peer that a request has been successfully completed. The Result-Code AVP values defined in Diameter BASE Protocol IETF RFC 6733 [15] are applied. + +### 5.5.3 Permanent Failures + +Errors that fall into the Permanent Failures category shall be used to inform the peer that the request has failed. The Result-Code AVP values defined in Diameter Base Protocol IETF RFC 6733 [15] are applied. + +### 5.5.4 Transient Failures + +Errors that fall within the Transient failures category are used to inform a peer that the request could not be satisfied at the time it was received, but may be able to satisfy the request in the future. + +The Result-Code AVP values defined in Diameter Base Protocol IETF RFC 6733 [15] are applicable. + +## 5.6 Ns messages + +### 5.6.1 Command-Code Values + +This clause defines the Command-Code values for the Ns interface application as allocated by IANA from the vendor-specific namespace defined in IETF RFC 5719 [10]. Every command is defined by means of the ABNF syntax in IETF RFC 2234 [11], and according to the rules in IETF RFC 6733 [15]. + +NOTE: As the commands in the present specification have originally been defined based on the former specification of the Diameter Base Protocol (IETF RFC 3588 [3]), the Vendor-Specific-Application-Id AVP is still assumed as a required AVP (an AVP indicated as {AVP}) in the command code format to avoid backward compatibility issues, even if the use of this AVP has been deprecated in the new specification of the Diameter Base Protocol (IETF RFC 6733 [15]). + +The following Command Codes are defined in this specification: + +**Table 5.6.1: Command-Code values for Ns** + +| Command-Name | Abbreviation | Code | Section | +|------------------------------------------|--------------|---------|---------| +| Network-Status-Request | NSR | 8388724 | 5.6.2 | +| Network-Status-Answer | NSA | 8388724 | 5.6.3 | +| Network-Status-Continuous-Report-Request | NCR | 8388725 | 5.6.4 | +| Network- Status-Continuous-Report-Answer | NCA | 8388725 | 5.6.5 | + +### 5.6.2 Network-Status-Request (NSR) command + +The NSR command, indicated by the Command-Code field set to 8388724 and the 'R' bit set in the Command Flags field, is sent by the SCEF to the RCAF as part of the one time or continuous network status reporting procedure and as part of the cancellation of continuous reporting of network status procedure. + +Message Format: + +``` + ::= + < Session-Id > + [ DRMP ] + { Vendor-Specific-Application-Id } + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + [ Destination-Host ] + [ Origin-State-Id ] + [ OC-Supported-Features ] + { Ns-Request-Type } + [ SCEF-ID ] + [ SCEF-Reference-ID ] + [ Network-Area-Info-List ] + [ Congestion-Level-Range ] + [ Monitoring-Duration ] + *[ Proxy-Info ] + *[ Route-Record ] + *[ Supported-Features ] + *[ AVP ] +``` + +### 5.6.3 Network-Status-Answer (NSA) command + +The NSA command, indicated by the Command-Code field set to 8388724 and the 'R' bit cleared in the Command Flags field, is sent by the RCAF to the SCEF as part of the one time or continuous network status reporting request procedure and as part of the cancellation of continuous reporting of network status procedure. + +Message Format: + +``` + ::= < Diameter Header: 8388724, PXY > + < Session-Id > + [ DRMP ] + { Vendor-Specific-Application-Id } + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ Result-Code ] + [ Experimental-Result ] + [ Error-Message ] + [ Error-Reporting-Host ] + [ Failed-AVP ] + [ OC-Supported-Features ] + [ OC-OLR ] + [ SCEF-Reference-ID ] + [ Origin-State-Id ] + *[ Network-Congestion-Area-Report ] + *[ Redirect-Host ] + [ Redirect-Host-Usage ] + [ Redirect-Max-Cache-Time ] + *[ Proxy-Info ] + *[ Supported-Features ] + *[ Load ] + *[ AVP ] +``` + +### 5.6.4 Network-Status-Continuous-Report-Request (NCR) command + +The NCR command, indicated by the Command-Code field set to 8388725 and the 'R' bit set in the Command Flags field, is sent by the RCAF to the SCEF as part of the continuous network status reporting procedure. + +Message Format: + +``` + ::= + < Session-Id > + [ DRMP ] +``` + +``` + + { Vendor-Specific-Application-Id } + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + { Destination-Host } + [ Origin-State-Id ] + [ OC-Supported-Features ] + [ SCEF-Reference-ID ] + * [ Network-Congestion-Area-Report ] + * [ Proxy-Info ] + * [ Route-Record ] + * [ Supported-Features ] + * [ AVP ] + +``` + +### 5.6.5 Network-Status-Continuous-Report-Answer (NCA) command + +The NCA command, indicated by the Command-Code field set to 8388725 and the 'R' bit cleared in the Command Flags field, is sent by the SCEF to the RCAF as part of the continuous network status reporting procedure. + +Message Format: + +``` + + ::= < Diameter Header: 8388725, PXY > + < Session-Id > + [ DRMP ] + { Vendor-Specific-Application-Id } + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ Result-Code ] + [ Experimental-Result ] + [ Error-Message ] + [ Error-Reporting-Host ] + [ Failed-AVP ] + [ OC-Supported-Features ] + [ OC-OLR ] + * [ Redirect-Host ] + [ Redirect-Host-Usage ] + [ Redirect-Max-Cache-Time ] + * [ Proxy-Info ] + * [ Supported-Features ] + * [ AVP ] + +``` + +# --- Annex A (informative): Call Flows over Ns + +## A.1 Request of one time or continuous reporting of network status + +This signalling flow is used by SCEF to request one time or continuous reporting of network status. + +![Sequence diagram for Figure A.1.1: Request of one time or continuous reporting of network status. The diagram shows two lifelines: RCAF and SCEF. Step 1: SCEF sends a '1. Diameter NSR' message to RCAF. Step 2: RCAF sends a '2. Diameter NSA' message to SCEF.](7efae06af3af43ffe5d4b956a679cf54_img.jpg) + +``` +sequenceDiagram + participant SCEF + participant RCAF + Note right of SCEF: 1. Diameter NSR + SCEF->>RCAF: 1. Diameter NSR + Note left of RCAF: 2. Diameter NSA + RCAF->>SCEF: 2. Diameter NSA +``` + +Sequence diagram for Figure A.1.1: Request of one time or continuous reporting of network status. The diagram shows two lifelines: RCAF and SCEF. Step 1: SCEF sends a '1. Diameter NSR' message to RCAF. Step 2: RCAF sends a '2. Diameter NSA' message to SCEF. + +**Figure A.1.1: Request of one time or continuous reporting of network status** + +1. After the SCEF authorized a SCS/AS request for notification about the network status, the SCEF sends a Diameter NSR command to the selected RCAF(s) including the parameters as defined in subclause 4.3.1.2. +2. The RCAF sends a NSA command to the SCEF including the parameters as defined in subclause 4.3.1.2. + +## A.2 Continuous reporting of network status + +This signalling flow is used by RCAF to continuously notify the SCEF of the network status. + +![Sequence diagram for Figure A.2.1: Continuous reporting of network status. The diagram shows two lifelines: RCAF and SCEF. Step 1: RCAF sends a '1. Diameter NCR' message to SCEF. Step 2: SCEF sends a '2. Diameter NCA' message to RCAF.](c67d21fb3d9042e88cdc669f071b4e7c_img.jpg) + +``` +sequenceDiagram + participant RCAF + participant SCEF + Note left of RCAF: 1. Diameter NCR + RCAF->>SCEF: 1. Diameter NCR + Note right of SCEF: 2. Diameter NCA + SCEF->>RCAF: 2. Diameter NCA +``` + +Sequence diagram for Figure A.2.1: Continuous reporting of network status. The diagram shows two lifelines: RCAF and SCEF. Step 1: RCAF sends a '1. Diameter NCR' message to SCEF. Step 2: SCEF sends a '2. Diameter NCA' message to RCAF. + +**Figure A.2.1: Continuous reporting of network status** + +1. When the congestion level(s) is changed or the congestion level(s) is changed which corresponds to a threshold(s) provided, the RCAF sends a Diameter NCR command including the parameters as defined in subclause 4.3.1.3. +2. The SCEF acknowledges the NCR command by sending a NCA command to the RCAF. + +## A.3 Cancellation of continuous reporting of network status + +This signalling flow is used by SCEF to request the cancellation of continuous reporting of network status. + +![Sequence diagram showing the cancellation of continuous reporting of network status between RCAF and SCEF.](1a827b10290f33d4fec04d0e8ef7a897_img.jpg) + +``` +sequenceDiagram + participant SCEF + participant RCAF + Note right of SCEF: 1. Diameter NSR + SCEF->>RCAF: 1. Diameter NSR + Note left of RCAF: 2. Diameter NSA + RCAF->>SCEF: 2. Diameter NSA +``` + +The diagram illustrates a sequence of two messages between the SCEF and the RCAF. The SCEF sends a 'Diameter NSR' message to the RCAF, and the RCAF responds with a 'Diameter NSA' message. The messages are numbered 1 and 2 respectively. + +Sequence diagram showing the cancellation of continuous reporting of network status between RCAF and SCEF. + +**Figure A.3.1: Cancellation of continuous reporting of network status** + +1. When the SCEF detects that the duration for ongoing continuous reporting of network status is over or is requested to terminate ongoing continuous reporting of network status by the SCS/AS, the SCEF sends a Diameter NSR command to the identified RCAF(s) including the parameters as defined in subclause 4.3.1.4. +2. The RCAF removes the continuous reporting of network status related instructions meaning that the RCAF will no longer notify the SCEF of the change of the network status, and sends a NSA command to the SCEF. + +# Annex B (informative): Change history + +| Change history | | | | | | | | | +|----------------|------------|-----------|------|-----|-----|-----------------------------------------------------------------------------------------------------------------------|-------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | | Subject/Comment | Old | New | +| 2015-08 | | | | | | Editor's Initial Draft | | 0.0.0 | +| 2015-08-25 | CT3#82 | C3-153466 | | | | Initial version includes agreed documents: C3-153407, C3-153431, C3-153433 | 0.0.0 | 0.1.0 | +| 2015-10-21 | CT3#82 bis | | | | | Initial version includes agreed documents: C3-154183, C3-154298, C3-154332, C3-154333, C3-154318, C3-154334, C-154347 | 0.1.0 | 0.2.0 | +| 2015-11-24 | CT3#83 | C3-155416 | | | | Initial version includes agreed documents: C3-155240, C3-155241, C3-155331, C3-155347, C3-155364 | 0.2.0 | 1.0.0 | +| 2015-11-30 | CT#70 | CP-150822 | | | | TS 29.153 sent to plenary CT#70 for information and approval | 1.0.0 | 1.0.1 | +| 2015-12 | CT#70 | CP-150822 | | | | TS 29.153 upgraded to 13.0.0 after approval | 1.0.1 | 13.0.0 | +| Change history | | | | | | | | | +| Date | TSG # | TSG Doc. | CR | Rev | Cat | Subject/Comment | | New | +| 2016-03 | CT#71 | CP-160095 | 0001 | 1 | F | Add the missing abbreviations | | 13.1.0 | +| 2016-03 | CT#71 | CP-160095 | 0002 | - | F | Removal of the Editor's Note | | 13.1.0 | +| 2016-03 | CT#71 | CP-160095 | 0003 | - | F | Add command codes and AVP numbers for Ns protocol | | 13.1.0 | +| 2016-03 | CT#71 | CP-160095 | 0004 | 2 | F | Signalling flows over Ns reference point | | 13.1.0 | +| 2016-03 | CT#71 | CP-160093 | 0005 | - | B | Diameter Message Priority over Ns interface | | 13.1.0 | +| 2016-06 | CT#72 | CP-160251 | 0006 | - | F | Multiple instances of Network-Congestion-Area-Report AVP | | 13.2.0 | +| 2016-06 | CT#72 | CP-160251 | 0007 | 3 | F | Correction of network status reporting procedures | | 13.2.0 | +| 2016-09 | CT#73 | CP-160444 | 0008 | - | F | Correction of the NCR command | | 13.3.0 | +| 2016-09 | CT#73 | CP-160444 | 0009 | 1 | F | Correction to the continuous congestion reporting | | 13.3.0 | +| 2016-12 | CT#74 | CP-160614 | 0011 | - | F | Change IETF drmp draft version to official RFC 7944 | | 13.4.0 | +| 2016-12 | CT#74 | CP-160615 | 0010 | 1 | B | Diameter Load Control Mechanism | | 14.0.0 | +| 2016-12 | CT#74 | CP-160616 | 0012 | 1 | F | Diameter base protocol specification update | | 14.0.0 | +| 2017-03 | CT#75 | CP-170076 | 0013 | - | F | Update instance number for the Failed-AVP in answer commands | | 14.1.0 | +| 2017-06 | CT#76 | CP-171119 | 0014 | 1 | F | Reference update for draft-ietf-dime-load | | 14.2.0 | +| 2017-06 | CT#76 | CP-171136 | 0019 | 1 | F | Vendor-Specific-Application-Id AVP handling | | 14.2.0 | +| 2018-06 | SA#80 | - | - | - | | Update to Rel-15 version (MCC) | | 15.0.0 | +| 2019-09 | CT#85 | CP-192154 | 0021 | 1 | A | draft-ietf-dime-load published as RFC 8583 | | 15.1.0 | +| 2020-07 | SA#88e | - | - | - | | Update to Rel-16 version (MCC) | | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29154/c0e88e4bd3a209b66ee7cb67e1cec2be_img.jpg b/marked/Rel-16/29_series/29154/c0e88e4bd3a209b66ee7cb67e1cec2be_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2681207239b0ab8ab0fa5337430a8dfc083f4496 --- /dev/null +++ b/marked/Rel-16/29_series/29154/c0e88e4bd3a209b66ee7cb67e1cec2be_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f83935df6b1cd817609deaa12d3981b6478201e12d5fc7fa7a091fa75db7ed67 +size 7390 diff --git a/marked/Rel-16/29_series/29154/e4c6fa93821e3546ee9fcae897ae2771_img.jpg b/marked/Rel-16/29_series/29154/e4c6fa93821e3546ee9fcae897ae2771_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8c250ccdc77025c1713cb0bebfb804e2b31f3498 --- /dev/null +++ b/marked/Rel-16/29_series/29154/e4c6fa93821e3546ee9fcae897ae2771_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:811e05959706bcf63d98089df06b549f051b2d78db68141b145daee8009aa75b +size 7432 diff --git a/marked/Rel-16/29_series/29154/raw.md b/marked/Rel-16/29_series/29154/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..b11fc561c1535cc270b460a653b4d9fc89102fdf --- /dev/null +++ b/marked/Rel-16/29_series/29154/raw.md @@ -0,0 +1,1000 @@ + + + + +Error! No +text of + +Error! No text of specified style in +document. + +# Contents + +Foreword ..... 5 + +1 Scope..... 6 + +2 References..... 6 + +3 Definitions and abbreviations ..... 7 + +3.1 Definitions..... 7 + +3.2 Abbreviations ..... 7 + +4 Nt application..... 7 + +4.1 Overview ..... 7 + +4.2 Nt Reference Model ..... 8 + +4.3 Functional elements..... 8 + +4.3.1 PCRF ..... 8 + +4.3.2 SCEF..... 8 + +4.4 Procedures over the Nt reference point..... 8 + +4.4.1 Negotiation for future background data transfer ..... 8 + +4.5 PCRF selection..... 9 + +5 Nt protocol ..... 9 + +5.1 Protocol support ..... 9 + +5.2 Initialization, maintenance and termination of connection and session..... 10 + +5.3 Nt specific AVPs..... 10 + +5.3.1 General ..... 10 + +5.3.2 Network-Area-Info-List AVP ..... 10 + +5.3.3 Reference-Id AVP ..... 10 + +5.3.4 Transfer-Request-Type AVP..... 11 + +5.3.5 Time-Window AVP..... 11 + +5.3.6 Transfer-End-Time AVP ..... 11 + +5.3.7 Transfer-Start-Time AVP ..... 11 + +5.3.8 Transfer-Policy AVP ..... 11 + +5.3.9 Transfer-Policy-Id AVP ..... 11 + +5.3.10 Number-Of-UEs AVP ..... 11 + +5.4 Nt re-used AVPs..... 11 + +5.4.1 General ..... 11 + +5.4.2 Use of the Supported-Features AVP for the Nt application ..... 12 + +5.5 Nt specific Experimental-Result-Code AVP values ..... 13 + +5.5.1 General ..... 13 + +5.5.2 Success ..... 13 + +5.5.3 Permanent Failures ..... 13 + +5.5.4 Transient Failures ..... 13 + +5.6 Nt messages..... 14 + +5.6.1 Command-Code Values..... 14 + +5.6.2 Background-Data-Transfer-Request (BTR) command ..... 14 + +5.6.3 Background-Data-Transfer-Answer (BTA) command..... 14 + +**Annex A (normative): ..... Nta** + +**application ..... 15** + +A.1 Overview..... 15 + +A.2 Reference Model..... 15 + +A.3 Functional elements ..... 16 + +A.3.1 PCRF ..... 16 + +A.3.2 SCEF ..... 16 + +A.4 Procedures over the Nta application ..... 16 + +A.4.1 Event Monitoring Configuration..... 16 + +A.4.2 Event Monitoring Reporting ..... 17 + +A.5 PCRF selection..... 17 + +A.6 Nta protocol..... 17 + +    A.6.1 Protocol support ..... 17 + +    A.6.2 Initialization, maintenance and termination of connection and session..... 17 + +    A.6.3 Nta specific AVPs ..... 18 + +        A.6.3.1 General ..... 18 + +        A.6.3.2 Access-Network-Reports AVP..... 18 + +        A.6.3.3 Event-Configuration ..... 18 + +        A.6.3.4 Event-Configuration-State AVP..... 18 + +        A.6.3.5 Event-Configuration-Status AVP..... 19 + +        A.6.3.6 Event-Reporting-Results AVP ..... 19 + +        A.6.3.7 Event-Reports AVP ..... 19 + +        A.6.3.8 Extended-SCEF-Reference-ID ..... 19 + +    A.6.4 Nta re-used AVPs..... 19 + +        A.6.4.1 General ..... 19 + +        A.6.4.2 Use of the Supported-Features AVP for the Nt application ..... 21 + +    A.6.5 Nta specific Experimental-Result-Code AVP values..... 21 + +    A.6.6 Nta messages ..... 21 + +        A.6.6.1 Command-Code Values..... 21 + +        A.6.6.2 Event-Configuration-Request (ECR) command..... 22 + +        A.6.6.3 Event-Configuration-Answer (ECA) command..... 22 + +        A.6.6.4 Event-Reporting-Request (ERR) command ..... 22 + +        A.6.6.5 Event-Reporting-Answer (ERA) command ..... 23 + +Annex B (informative): Change history..... 24 + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# 1 Scope + +This document defines the protocol for Nt reference point. The Nt reference point includes Nt application and Nta application. + +The functional requirements and the stage 2 specifications of the Nt application are contained in 3GPP TS 23.203 [2]. The Nt application of Nt reference point lies between Service Capability Exposure Function (SCEF) and Policy and Charging Rules Function (PCRF), it supports the negotiation of background data transfer policy and is documented in the main body of this document. + +The functional requirements and the stage 2 specifications of the Nta application are contained in subclause 5.6.4.1a of 3GPP TS 23.682 [x5]. The Nta application of Nt reference point lies between SCEF and PCRF, it supports the event monitoring configuration for a group of UEs and the corresponding event reporting. The Nta application is documented in Annex A. + +NOTE: Nta is a stage 3 name of Diameter Application due to extensibility rule mentioned in IETF RFC 6733 [15]. + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.203: "Policy and charging control architecture". +- [3] IETF RFC 3588: "Diameter Base Protocol". +- [4] IETF RFC 4006: "Diameter Credit Control Application". +- [5] 3GPP TS 29.214: "Policy and Charging Control over Rx reference point". +- [6] 3GPP TS 29.274: "3GPP Evolved Packet System. Evolved GPRS Tunnelling Protocol for EPS (GTPv2)". +- [7] IETF RFC 5719: "Updated IANA Considerations for Diameter Command Code Allocations". +- [8] IETF RFC 2234: "Augmented BNF for syntax specifications". +- [9] 3GPP TS 29.213: "Policy and charging control signalling flows and Quality of Service (QoS) parameter mapping". +- [10] IETF RFC 7683: "Diameter Overload Indication Conveyance". +- [11] 3GPP TS 29.229: "Cx and Dx interfaces based on Diameter protocol; Protocol details". +- [12] IETF RFC 7944: "Diameter Routing Message Priority". +- [13] 3GPP TS 29.215: "Policy and Charging Control (PCC) over S9 reference point; Stage 3". +- [14] IETF RFC 8583: "Diameter Load Information Conveyance". +- [15] IETF RFC 6733: "Diameter Base Protocol". + +- [16] 3GPP TS 29.329: "Sh Interface based on the Diameter protocol". +- [17] 3GPP TS 29.336: "Home Subscriber Server (HSS) diameter interfaces for interworking with packet data networks and applications". +- [18] 3GPP TS 29.061: "Interworking between the Public Land Mobile Network (PLMN) supporting packet based services and Packet Data Networks (PDN)". +- [19] 3GPP TS 29.212: "Policy and Charging Control (PCC); Reference points". +- [20] 3GPP TS 23.682: "Architecture enhancements to facilitate communications with packet data networks and applications". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|-------|---------------------------------------------| +| ASP | Application Service Provider | +| BBERF | Bearer Binding and Event Reporting Function | +| BTA | Background Data Transfer Answer | +| BTR | Background Data Transfer Request | +| ECA | Event Configuration Answer | +| ECR | Event Configuration Request | +| ERA | Event Reporting Answer | +| ERR | Event Reporting Request | +| DRA | Diameter Routing Agent | +| DRMP | Diameter Routing Message Priority | +| PCEF | Policy and Charging Enforcement Function | +| PCRF | Policy and Charging Rules Function | +| SCEF | Service Capability Exposure Function | +| SPR | Subscription Profile Repository | + +# --- 4 Nt application + +## 4.1 Overview + +The Nt application of Nt reference point is located between the PCRF and the SCEF. It is used for reporting the transfer policies from the PCRF to the SCEF. + +The stage 2 requirements for Nt application are defined in TS 23.203 [2]. + +Refer to Annex G of 3GPP TS 29.213 [9] for Diameter overload control procedures for the Nt application. + +Refer to Annex J of 3GPP TS 29.213 [9] for Diameter message priority mechanism procedures for the Nt application. + +Refer to Annex K of 3GPP TS 29.213 [9] for Diameter load control procedures for the Nt application. + +## 4.2 Nt Reference Model + +The Nt application of Nt reference point resides between the SCEF and PCRF. The relationship between the two functional entities is depicted in figure 4.2-1. The overall PCC architecture is depicted in subclause 3a of 3GPP TS 29.213 [9]. + +![Diagram showing the Nt application interface between PCRF and SCEF. Two green rectangular boxes, labeled 'PCRF' and 'SCEF', are connected by a horizontal line. The line has a small vertical tick mark in the middle, and the text 'Nt application' is written above the line between the two boxes.](c0e88e4bd3a209b66ee7cb67e1cec2be_img.jpg) + +Diagram showing the Nt application interface between PCRF and SCEF. Two green rectangular boxes, labeled 'PCRF' and 'SCEF', are connected by a horizontal line. The line has a small vertical tick mark in the middle, and the text 'Nt application' is written above the line between the two boxes. + +**Figure 4.2-1: Reference model for Nt application of Nt interface** + +NOTE: For roaming case, the SCEF is always in the H-PLMN and always contact the H-PCRF. + +## 4.3 Functional elements + +### 4.3.1 PCRF + +The PCRF is a functional element that encompasses policy control decision and flow based charging control functionalities. + +The PCRF uses the information received from SCEF and other available information to determine one or more transfer policies for background data to the application service provider. The PCRF provides the selected transfer policies with a reference ID to the SPR for storage. + +### 4.3.2 SCEF + +The SCEF is a functional element which provides a means to securely expose the services and capabilities provided by 3GPP network interfaces. + +The SCEF is triggered by an SCS/AS which requests for the negotiation with the PCRF for providing necessary policy to transfer background data. + +## 4.4 Procedures over the Nt reference point + +### 4.4.1 Negotiation for future background data transfer + +Based on the SCS/AS request, the SCEF shall send the Background-Data-Transfer-Request (BTR) command to the PCRF including the Transfer-Request-Type AVP with the value TRANSFER\_POLICY\_REQUEST(0), it shall also include the ASP identifier within the Application-Service-Provider-Identity AVP, volume of data per UE within the CC-Output-Octets AVP for downlink volume and/or the CC-Input-Octets AVP for uplink volume, or the CC-Total-Octets AVP for total volume regardless direction, expected number of UEs within the Number-Of-UEs AVP and desired time window within the Time-Window AVP. + +The Time-Window AVP shall include desired start time within the Transfer-Start-Time AVP and desired end time within the Transfer-End-Time AVP. + +The SCEF may also provide network area information within Network-Area-Info-List AVP. + +Once the PCRF receives the BTR command, the PCRF shall retrieve all existing transfer policies stored for any ASP from the SPR. + +When all existing transfer policies are retrieved, the PCRF shall determine one or more transfer policies based on the information received from the SCEF and other available information (e.g. network policy, congestion level (if available), load status estimation for the required time window and network area, existing transfer policies) and respond with a Background-Data-Transfer-Answer (BTA) command including the possible transfer policies within Transfer-Policy AVP(s) and a reference ID within Reference-Id AVP. + +The Transfer-Policy AVP(s) shall include the Transfer-Policy-Id AVP, the Time-Window AVP, the Rating-Group AVP, and may also include an Max-Requested-Bandwidth-DL AVP and/or an Max-Requested-Bandwidth-UL AVP. + +If more than one transfer policies are included in the BTA command, the PCRF shall also include the PCRF Id within the PCRF-Address AVP in the BTA command. + +NOTE 1: If only one Transfer-Policy AVP is included in the BTA command, the PCRF sends a request to the SPR to store the reference ID together with the transfer policy and corresponding network area information (if available). + +If there is more than one Transfer-Policy AVP included in the BTA command, the PCRF waits for the transfer policy selected by the SCS/AS before communicating with the SPR. + +If there is more than one transfer policy provided from the PCRF to the SCEF in the BTA command, when the SCEF receives the selected transfer policy from the SCS/AS, the SCEF shall send Background-Data-Transfer-Request (BTR) command to the PCRF including the Transfer-Request-Type AVP set to the value TRANSFER\_POLICY\_NOTIFICATION (1). The SCEF shall also include the reference ID in the Reference-Id AVP, the identity of the selected transfer policy within the Transfer-Policy-Id AVP and the destination PCRF Id within the Destination-Host AVP. + +NOTE 2: When receiving the BTA command from the PCRF, if there is only one transfer policy included, the SCEF forwards the transfer policy to SCS/AS. + +If there is more than one transfer policy included, the SCEF forwards these transfer policies to the SCS/AS and waits for the answer including the identity of the transfer policy selected by the SCS/AS. + +The PCRF shall acknowledge the BTR command by sending Background-Data-Transfer-Answer (BTA) command. + +NOTE 3: The PCRF sends a request to the SPR to store the reference ID together with the transfer policy and corresponding network area information (if available). + +## 4.5 PCRF selection + +The SCEF or DRA (if deployed) may select a PCRF in the HPLMN based on operator policy (e.g. pre-configured PCRF identities or routing strategy, etc). + +# --- 5 Nt protocol + +## 5.1 Protocol support + +The Diameter Base Protocol as specified in IETF RFC 6733 [15] shall apply except as modified by the defined support of the methods and the defined support of the commands and AVPs, result and error codes as specified in this specification. Unless otherwise specified, the procedures specified in IETF RFC 6733 [15] (including error handling and unrecognised information handling) shall be used unmodified. + +The Nt application is defined as vendor specific Diameter application, where the vendor is 3GPP and the Application-ID for the Nt application in the present release is 16777348. The vendor identifier assigned by IANA to 3GPP () is 10415. + +With regard to the Diameter protocol defined for the Nt application, the PCRF acts as a Diameter server, in the sense that it is the network element that handles background data transfer request. The SCEF acts as the Diameter client, in the sense that it is the network element requesting background data transfer. + +## 5.2 Initialization, maintenance and termination of connection and session + +The initialization and maintenance of the connection between each SCEF and PCRF pair is defined by the underlying protocol. Establishment and maintenance of connections between Diameter nodes is described in IETF RFC 6733 [15]. After establishing the transport connection, the SCEF and the PCRF shall advertise the support of the Nt specific Application by including the value of the application identifier in the Auth-Application-Id AVP and the value of the 3GPP (10415) in the Vendor-Id AVP of the Vendor-Specific-Application-Id AVP contained in the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands. The Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands are specified in the Diameter Base Protocol (IETF RFC 6733 [15]). + +An Nt Diameter session shall consist of a single request and answer pair. The Nt Diameter session is terminated after each request and answer pair interaction. In order to indicate that the session state is not to be maintained, the Diameter + +client and server shall include the Auth-Session-State AVP with the value set to NO\_STATE\_MAINTAINED (1), in the request and in the answer messages (see IETF RFC 6733 [15]). + +## 5.3 Nt specific AVPs + +### 5.3.1 General + +Table 5.3.1.1 describes the Diameter AVPs defined for the Nt application, their AVP Code values, types, possible flag values, whether or not the AVP may be encrypted and which supported features the AVP is applicable to. The Vendor-Id header of all AVPs defined in the present document shall be set to 3GPP (10415). + +**Table 5.3.1.1: Nt specific Diameter AVPs** + +| Attribute Name | AVP Code | Clause defined | Value Type (Note 2) | AVP Flag rules (Note 1) | | | | Applicability | +|------------------------|----------|----------------|---------------------|-------------------------|-----|------------|----------|---------------| +| | | | | Must | May | Should not | Must not | | +| Network-Area-Info-List | 4201 | 5.3.2 | OctetString | M,V | P | | | | +| Number-Of-UEs | 4209 | 5.3.10 | Unsigned32 | M,V | P | | | | +| Reference-Id | 4202 | 5.3.3 | OctetString | M,V | P | | | | +| Transfer-Request-Type | 4203 | 5.3.4 | Unsigned32 | M,V | P | | | | +| Time-Window | 4204 | 5.3.5 | Grouped | M,V | P | | | | +| Transfer-End-Time | 4205 | 5.3.6 | Time | M,V | P | | | | +| Transfer-Policy | 4207 | 5.3.8 | Grouped | M,V | P | | | | +| Transfer-Policy-Id | 4208 | 5.3.9 | Unsigned32 | M,V | P | | | | +| Transfer-Start-Time | 4206 | 5.3.7 | Time | M,V | P | | | | + +NOTE 1: The AVP header bit denoted as 'M', indicates whether support of the AVP is required. The AVP header bit denoted as 'V', indicates whether the optional Vendor-ID field is present in the AVP header. For further details, see IETF RFC 6733 [15]. + +NOTE 2: The value types are defined in IETF RFC 6733 [15]. + +### 5.3.2 Network-Area-Info-List AVP + +The Network-Area-Info-List AVP (AVP code 4201) is of type OctetString, it contains the network area information which is coded as specified in 3GPP TS 29.274 [6] in Presence Reporting Area Action IE, starting from octet 9. + +### 5.3.3 Reference-Id AVP + +The Reference-Id AVP (AVP code 4202) is of type OctetString. It is used by the PCRF to correlate an SCS/AS request with the transfer policy retrieved from the SPR. It is assigned by the PCRF and shall be globally unique per PLMN. + +NOTE: To guarantee the uniqueness of the Reference Id, the Reference Id can follow the definition of Session Id in IETF RFC 6733 [15]. + +### 5.3.4 Transfer-Request-Type AVP + +The Transfer-Request-Type AVP (AVP code 4203) is of type Unsigned32, it contains the reason for sending the BT-Request message. + +The following values are defined: + +0 (TRANSFER\_POLICY\_REQUEST) + +The BT-Request message is sent to initiate a transfer policy request procedure. + +1 (TRANSFER\_POLICY\_NOTIFICATION) + +The BT-Request message is sent to initiate a transfer policy notification procedure. + +### 5.3.5 Time-Window AVP + +The Time-Window AVP (AVP code 4204) is of type Grouped. It contains a Transfer-Start-Time and a Transfer-End-Time. It describes the time interval during which the SCS/AS may realize the background data transfer. + +``` +Time-window ::= < AVP Header: 4204 > + { Transfer-Start-Time } + { Transfer-End-Time } + *[ AVP ] +``` + +### 5.3.6 Transfer-End-Time AVP + +The Transfer-End-Time AVP (AVP code 4205) is of type Time. It indicates the NTP time at which the SCS/AS shall stop the background data transfer. + +### 5.3.7 Transfer-Start-Time AVP + +The Transfer-Start-Time AVP (AVP code 4206) is of type Time. It indicates the NTP time when the SCS/AS may start the background data transfer. + +### 5.3.8 Transfer-Policy AVP + +The Transfer-Policy AVP (AVP code 4207) is of type Grouped. It indicates the transfer policy determined by the PCRF. + +``` +Transfer-Policy ::= < AVP Header: 4207 > + { Transfer-Policy-Id } + [ Time-Window ] + [ Rating-Group ] + [ Max-Requested-Bandwidth-DL ] + [ Max-Requested-Bandwidth-UL ] + *[ AVP ] +``` + +### 5.3.9 Transfer-Policy-Id AVP + +The Transfer-Policy-Id AVP (AVP code 4208) is of type Unsigned32. It indicates the identity of the transfer policy. It is assigned by the PCRF and is unique per Reference-Id. + +### 5.3.10 Number-Of-UEs AVP + +The Number-Of-UEs AVP (AVP code 4209) is of type Unsigned32. It indicates the expected number of UEs. + +## 5.4 Nt re-used AVPs + +### 5.4.1 General + +Table 5.4.1 lists the Diameter AVPs re-used by the Nt application from other existing Diameter Applications, reference to their respective specifications, short description of their usage within the Nt application. Other AVPs from existing Diameter Applications, except for the AVPs from Diameter base protocol, do not need to be supported. The AVPs from Diameter base protocol are not included in table 5.4.1, but they are re-used for the Nt application. Unless otherwise stated, re-used AVPs shall maintain their 'M', 'P' and 'V' flag settings. + +**Table 5.4.1: Nt re-used Diameter AVPs** + +| Attribute Name | Reference | Description | Applicability (NOTE) | +|---------------------------------------|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| Application-Service-Provider-Identity | 3GPP TS 29.214 [5] | The identity of the application service provider that is delivering a service to an end user. | | +| CC-Output-Octets | IETF RFC 4006 [4] | It contains the number of requested, octets that may be sent to involved users. | | +| CC-Input-Octets | IETF RFC 4006 [4] | It contains the number of requested octets that may be received from the involved users. | | +| CC-Total-Octets | IETF RFC 4006 [4] | It contains the total number of requested octets regardless of the direction (sent or received). | | +| DRMP | IETF RFC 7944 [12] | Allows Diameter endpoints to indicate the relative priority of Diameter transactions. | | +| Load | IETF RFC 8583 [14] | The AVP used to convey load information between Diameter nodes. This AVP and all AVPs within this grouped AVP shall have the 'M' bit cleared. | | +| Max-Requested-Bandwidth-DL | 3GPP TS 29.214 [5] | Defines the maximum aggregated authorized bandwidth for downlink by the PCRF. | | +| Max-Requested-Bandwidth-UL | 3GPP TS 29.214 [5] | Defines the maximum aggregated authorized bandwidth for uplink by the PCRF. | | +| OC-OLR | IETF RFC 7683 [10] | Contains the necessary information to convey an overload report. | | +| OC-Supported-Features | IETF RFC 7683 [10] | Defines the support for the Diameter overload indication conveyance by the sending node. | | +| PCRF-Address | 3GPP TS 29.215 [13] | The identity, which indicates the destination PCRF. | | +| Rating-Group | IETF RFC 4006 [4] | The charging key for the aggregated traffic of all involved UEs used for rating purpose. | | +| Supported-Features | 3GPP TS 29.229 [11] | If present, this AVP informs the destination host about the features that the origin host requires to successfully complete this command exchange. | | + +NOTE: AVPs marked with a supported feature are applicable as described in subclause 5.4.2. + +### 5.4.2 Use of the Supported-Features AVP for the Nt application + +When new functionality is introduced for the Nt application, it should be defined as optional. If backwards incompatible changes cannot be avoided, the new functionality shall be introduced as a new feature and support advertised with the Supported-Features AVP. Unless otherwise stated, the use of the Supported-Features AVP for the Nt application shall be compliant to the usage of the Supported-Features AVP on the Cx reference point and consistent with the procedures for the dynamic discovery of supported features as defined in subclause 7.2 of 3GPP TS 29.229 [11]. + +The base functionality for the Nt application is the 3GPP Rel-13 standard and a feature is an extension to that functionality. If the origin host does not support any features beyond the base functionality, the Supported-Features AVP may be absent from the Nt commands. + +As defined in subclause 7.1.1 of 3GPP TS 29.229 [11], when extending the application by adding new AVPs for a feature, the new AVPs shall have the M bit cleared and the AVP shall not be defined mandatory in the command ABNF. + +As defined in 3GPP TS 29.229 [11], the Supported-Features AVP is of type grouped and contains the Vendor-Id, Feature-List-ID and Feature-List AVPs. On the all reference points as specified in this specification, the Supported-Features AVP is used to identify features that have been defined by 3GPP and hence, for features defined in this document, the Vendor-Id AVP shall contain the vendor ID of 3GPP (10415). If there are multiple feature lists defined for the reference point, the Feature-List-ID AVP shall differentiate those lists from one another. + +The Supported-Features AVP shall be included in every BTR and BTA commands if supported by the SCEF and PCRF respectively. + +The table 5.4.2.1 defines the features applicable to the Nt application for the feature list with a Feature-List-ID of 1. + +**Table 5.4.2.1: Features of Feature-List-ID 1 used in Nt** + +| Feature bit | Feature | M/O | Description | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|-----|-------------| +| Feature bit: The order number of the bit within the Feature-List AVP where the least significant bit is assigned number "0".
Feature: A short name that can be used to refer to the bit and to the feature, e.g. "EPS".
M/O: Defines if the implementation of the feature is mandatory ("M") or optional ("O") in this 3GPP Release.
Description: A clear textual description of the feature. | | | | + +NOTE: This table is a placeholder for when any supported features are added to Nt. There are no supported features in this release. + +## 5.5 Nt specific Experimental-Result-Code AVP values + +### 5.5.1 General + +This subclause defines result code values that shall be supported by Diameter implementations that conform to this specification. + +### 5.5.2 Success + +Result Codes that fall into the Success category are used to inform a peer that a request has been successfully completed. The Result-Code AVP values defined in Diameter base protocol IETF RFC 6733 [15] are applied. + +### 5.5.3 Permanent Failures + +Errors that fall into the Permanent Failures category shall be used to inform the peer that the request has failed, and should not be attempted again. + +The Result-Code AVP values defined in Diameter base protocol IETF RFC 6733 [15] are applied. + +### 5.5.4 Transient Failures + +Errors that fall within the Transient Failures category are used to inform a peer that the request could not be satisfied at the time it was received, but may be able to satisfy the request in the future. + +The Result-Code AVP values defined in Diameter base protocol IETF RFC 6733 [15] are applied. + +## 5.6 Nt messages + +### 5.6.1 Command-Code Values + +This subclause defines the Command-Code values for the Nt application as allocated by IANA from the vendor-specific namespace defined in IETF RFC 5719 [7]. Every command is defined by means of the ABNF syntax in IETF RFC 2234 [8], and according to the rules in IETF RFC 6733 [15]. + +NOTE: As the commands in the present specification have originally been defined based on the former specification of the Diameter Base Protocol (IETF RFC 3588 [3]), the Vendor-Specific-Application-Id AVP is still assumed as a required AVP (an AVP indicated as {AVP}) in the command code format to avoid backward compatibility issues, even if the use of this AVP has been deprecated in the new specification of the Diameter Base Protocol (IETF RFC 6733 [15]). + +The Nt application identifier shall be included in the Auth-Application-Id AVP within the Vendor-Specific-Application-Id grouped AVP contained in the BT-Request/Answer commands. + +The following Command Codes are defined in this specification: + +**Table 5.6.1: Command-Code values for Nt** + +| Command-Name | Abbreviation | Code | Section | +|----------------------------------|--------------|---------|---------| +| Background-Data-Transfer-Request | BTR | 8388723 | 5.6.2 | +| Background-Data-Transfer-Answer | BTA | 8388723 | 5.6.3 | + +### 5.6.2 Background-Data-Transfer-Request (BTR) command + +The BTR command, indicated by the Command-Code field set to 8388723 and the 'R' bit set in the Command Flags field, is sent by the SCEF to the PCRF as part of Negotiation for future background data transfer procedure. + +Message Format: + +``` + ::= + < Session-Id > + [ DRMP ] + { Vendor-Specific-Application-Id } + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + { Transfer-Request-Type } + [ Destination-Host ] + [ OC-Supported-Features ] + [ Application-Service-Provider-Identity ] + [ CC-Output-Octets ] + [ CC-Input-Octets ] + [ CC-Total-Octets ] + [ Number-Of-UEs ] + [ Time-Window ] + [ Network-Area-Info-List ] + [ Reference-Id ] + [ Transfer-Policy-Id ] + *[ Proxy-Info ] + *[ Route-Record ] + *[ Supported-Features ] + *[ AVP ] +``` + +### 5.6.3 Background-Data-Transfer-Answer (BTA) command + +The BTA command, indicated by the Command-Code field set to 8388723 and the 'R' bit cleared in the Command Flags field, is sent by the PCRF to the SCEF as part of Negotiation for future background data transfer procedure. + +Message Format: + +``` + ::= + < Session-Id > + [ DRMP ] + { Vendor-Specific-Application-Id } + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ Result-Code ] + [ Experimental-Result ] + [ Error-Message ] + [ Error-Reporting-Host ] + [ Failed-AVP ] + *[ Redirect-Host ] + [ Redirect-Host-Usage ] + [ Redirect-Max-Cache-Time ] + [ Reference-Id ] + [ OC-Supported-Features ] + [ OC-OLR ] + *[ Transfer-Policy ] + [ PCRF-Address ] + *[ Proxy-Info ] + *[ Route-Record ] + *[ Supported-Features ] +``` + +\*[ Load ] +\*[ AVP ] + +# --- Annex A (normative): Nta application + +## A.1 Overview + +The Nta application of Nt reference point is located between the PCRF and the SCEF. It is used for configuring event monitoring for a group of UEs and reporting the event. + +The stage 2 requirements for Nta application are defined in TS 23.682 [x5]. + +Refer to Annex G of 3GPP TS 29.213 [9] for Diameter overload control procedures for the Nta application. + +Refer to Annex J of 3GPP TS 29.213 [9] for Diameter message priority mechanism procedures for the Nta application. + +Refer to Annex K of 3GPP TS 29.213 [9] for Diameter load control procedures for the Nta application. + +## --- A.2 Reference Model + +The Nta application of Nt reference point resides between the SCEF and PCRF. The relationship between the two functional entities is depicted in figure A.2-1. The overall PCC architecture is depicted in subclause 3a of 3GPP TS 29.213 [9]. + +![Reference model for Nta application of Nt interface diagram](e4c6fa93821e3546ee9fcae897ae2771_img.jpg) + +The diagram shows two green rectangular boxes, labeled 'PCRF' on the left and 'SCEF' on the right. A horizontal line connects the two boxes. Above this line, the text 'Nta application' is written. A small vertical tick mark is present on the horizontal line between the two boxes. + +Reference model for Nta application of Nt interface diagram + +**Figure A.2-1: Reference model for Nta application of Nt interface** + +NOTE: For roaming case, the SCEF is always in the H-PLMN and always contact the H-PCRF. + +## --- A.3 Functional elements + +### A.3.1 PCRF + +The PCRF is a functional element that encompasses policy control decision and flow based charging control functionalities. + +The PCRF receives event monitoring configuration (e.g. location request) from the SCEF and applies corresponding procedure over IP-CAN session. The PCRF reports the subscribed event to the SCEF after receiving report of the IP-CAN session. + +### A.3.2 SCEF + +The SCEF is a functional element which provides a means to securely expose the services and capabilities provided by 3GPP network interfaces. + +The SCEF receives event monitoring configuration from an SCS/AS which requests for the information (e.g. location) for a group of UEs, and reports such information to the SCS/AS. + +## A.4 Procedures over the Nta application + +### A.4.1 Event Monitoring Configuration + +Based on the SCS/AS request to retrieve the location information for a group of UEs, the SCEF shall send an Event-Configuration-Request (ECR) command to the PCRF including the Event-Configuration AVP and the External-Group-Identifier AVP. The Event-Configuration AVP shall include Monitoring-Type AVP with the value LOCATION\_REPORTING (2), SCEF-ID AVP, Extended-SCEF-Reference-ID AVP and MONTE-Location-Type AVP within Location-Information-Configuration AVP. The SCEF may also send the Group-Reporting-Guard-Timer AVP to indicate how often the event monitoring report shall be sent. + +Once the PCRF receives the ECR command, the PCRF shall retrieve UE identities (MSISDN and optionally UE external identifier) for all UEs in the group associated with the External-Group-Identifier AVP from the SPR and respond with an Event-Configuration-Answer (ECA) command including the Event-Configuration-Status AVP. If the PCRF has at least one active IP-CAN session for received UE identities and for such IP-CAN session the PCEF/BBERF supports the NetLoc feature as defined in subclause 5.4.1 of 3GPP TS 29.212 [aa], the Event-Configuration-State AVP within the Event-Configuration-Status AVP shall indicate this is not a final report with bit 0 not set. For those UEs having active IP-CAN sessions but without the support of the NetLoc feature in the PCEF/BBERF, the PCRF shall also send Event-Reports AVP with NetLoc-Access-Support AVP set to the value NETLOC\_ACCESS\_NOT\_SUPPORTED (0). + +NOTE 1: The details associated with the Sp reference point are not specified in this Release. The SPR's relation to existing subscriber databases is not specified in this Release. + +For location reporting, the PCRF shall trigger an IP-CAN session modification procedure including the Access Network information report request as defined in 3GPP TS 29.212 [aa] for each UE having active IP-CAN session(s). + +If a UE has multiple IP-CAN sessions established in the PCRF, only one IP-CAN session shall be selected to trigger a PCRF initiated IP-CAN session modification. + +NOTE 2: If a UE has multiple IP-CAN sessions over both 3GPP and non-3GPP access, the PCRF can prioritize multi access IP-CAN session(s) or 3GPP access IP-CAN session(s) in the selection among multiple IP-CAN sessions. Then how the PCRF selects the final IP-CAN session is implementation specific and not standardized in this specification. + +After receiving the ECA command, if the result indicates that it is a final report, the SCEF does not need to wait for further reporting from such PCRF. + +### A.4.2 Event Monitoring Reporting + +For location reporting, the PCRF may wait and aggregate (according to Group-Reporting-Guard-Timer AVP received in the ECR command) the access network information reported from the PCEF/BBERF for UE(s) that were requested previously, the PCRF shall send an Event-Reporting-Request (ERR) command to the SCEF including Event-Reports AVP. The Event-Reports AVP shall include Extended-SCEF-Reference-ID AVP and the following information for each UE: MSISDN AVP or External-Identifier AVP (if available and local policy allows it) and Access-Network-Reports AVP (if available). The PCRF may send the User-Location-Info-Time AVP within the Access-Network-Reports AVP to indicate that it is the last known location for a UE. If the PCRF receives NetLoc-Access-Support AVP with the value NETLOC\_ACCESS\_NOT\_SUPPORTED (0) from the PCEF/BBERF, it shall relay such AVP to the SCEF within the Access-Network-Reports AVP. The PCRF shall also indicate whether it is a final reporting for the group within the Event-Reporting-Results AVP within the Event-Reports AVP. + +After receiving the ERR command, the SCEF shall respond with an Event-Reporting-Answer (ERA) command. If the SCEF receives the Event-Reports AVP from the PCRF with an Extended-SCEF-Reference-ID not known by the SCEF, it shall reply with DIAMETER\_ERROR\_SCEF\_REFERENCE\_ID\_UNKNOWN (5515). + +## A.5 PCRF selection + +For location reporting, the SCEF shall select all PCRFs and send ECR command to each PCRF in the same PLMN. + +## A.6 Nta protocol + +### A.6.1 Protocol support + +The Diameter Base Protocol as specified in IETF RFC 6733 [15] shall apply except as modified by the defined support of the methods and the defined support of the commands and AVPs, result and error codes as specified in this specification. Unless otherwise specified, the procedures specified in IETF RFC 6733 [15] (including error handling and unrecognised information handling) shall be used unmodified. + +The Nta application is defined as vendor specific Diameter application, where the vendor is 3GPP and the Application-ID for the Nta application in the present release is 16777358. The vendor identifier assigned by IANA to 3GPP () is 10415. + +With regard to the Diameter protocol defined for the Nta application, the PCRF acts as a Diameter server, in the sense that it is the network element that handles event monitoring request. The SCEF acts as the Diameter client, in the sense that it is the network element requesting event monitoring report. + +### A.6.2 Initialization, maintenance and termination of connection and session + +The initialization and maintenance of the connection between each SCEF and PCRF pair is defined by the underlying protocol. Establishment and maintenance of connections between Diameter nodes is described in IETF RFC 6733 [15]. After establishing the transport connection, the SCEF and the PCRF shall advertise the support of the Nta specific Application by including the value of the application identifier in the Auth-Application-Id AVP and the value of the 3GPP (10415) in the Vendor-Id AVP of the Vendor-Specific-Application-Id AVP contained in the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands. The Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands are specified in the Diameter Base Protocol (IETF RFC 6733 [15]). + +An Nta Diameter session shall consist of a single request and answer pair. The Nta Diameter session is terminated after each request and answer pair interaction. In order to indicate that the session state is not to be maintained, the Diameter client and server shall include the Auth-Session-State AVP with the value set to NO\_STATE\_MAINTAINED (1), in the request and in the answer messages (see IETF RFC 6733 [15]). + +### A.6.3 Nta specific AVPs + +#### A.6.3.1 General + +Table A.6.3.1-1 describes the Diameter AVPs defined for the Nta application, their AVP Code values, types, possible flag values, whether or not the AVP may be encrypted and which supported features the AVP is applicable to. The Vendor-Id header of all AVPs defined in the present document shall be set to 3GPP (10415). + +**Table A.6.3.1-1: Nta specific Diameter AVPs** + +| Attribute Name | AVP Code | Clause defined | Value Type (Note 2) | AVP Flag rules (Note 1) | | | | Applicability | +|----------------------------|----------|----------------|---------------------|-------------------------|-----|------------|----------|---------------| +| | | | | Must | May | Should not | Must not | | +| Access-Network-Reports | 4210 | A.6.3.2 | Grouped | M,V | P | | | | +| Event-Configuration | 4211 | A.6.3.3 | Grouped | M,V | P | | | | +| Event-Configuration-State | 4212 | A.6.3.4 | Unsigned32 | M,V | P | | | | +| Event-Configuration-Status | 4213 | A.6.3.5 | Grouped | M,V | P | | | | +| Event-Reporting-Results | 4214 | A.6.3.6 | Unsigned32 | M,V | P | | | | +| Event-Reports | 4215 | A.6.3.7 | Grouped | M,V | P | | | | +| Extended-SCEF-Reference-ID | 4216 | A.6.3.8 | Unsigned64 | M,V | P | | | | + +NOTE 1: The AVP header bit denoted as 'M', indicates whether support of the AVP is required. The AVP header bit denoted as 'V', indicates whether the optional Vendor-ID field is present in the AVP header. For further details, see IETF RFC 6733 [15]. + +NOTE 2: The value types are defined in IETF RFC 6733 [15]. + +#### A.6.3.2 Access-Network-Reports AVP + +The Access-Network-Reports AVP (AVP code 4210) is of type Grouped. It indicates the access network information for a UE. + +``` +Access-Network-Reports ::= < AVP Header: 4210 > + [ MSISDN ] + [ External-Identifier ] + [ 3GPP-User-Location-Info ] + [ User-Location-Info-Time ] + [ 3GPP-SGSN-MCC-MNC ] + [ 3GPP-MS-TimeZone ] + [ UE-Local-IP-Address ] + [ TCP-Source-Port ] + [ UDP-Source-Port ] + [ NetLoc-Access-Support ] + *[ AVP ] +``` + +#### A.6.3.3 Event-Configuration + +The Event-Configuration AVP (AVP code 4211) is of type Grouped, and it contains the details of the monitoring event configuration from the SCEF. + +``` +Event-Configuration ::= < AVP Header: 4211 > + { Extended-SCEF-Reference-ID } + { SCEF-ID } + { Monitoring-Type } + { Location-Information-Configuration } + *[ AVP ] +``` + +#### A.6.3.4 Event-Configuration-State AVP + +The Event-Configuration-State AVP (AVP code 4212) is of type Unsigned32, it shall contain a bit mask. The bit 0 shall be the least significant bit. For example, to get the value of bit 0, a bit mask of 0x0001 should be used. The meaning of the bits shall be as defined below: + +**Table A.6.3.4-1: Event-Configuration-State** + +| Bit | Name | Description | +|-----|--------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | Final report | This bit, when set, indicates that this is the final report for the UE group; when not set, indicates that there are more reports pending for the UE group. | + +#### A.6.3.5 Event-Configuration-Status AVP + +The Event-Configuration-Status AVP (AVP code 4213) is of type Grouped. It indicates the status for the monitoring event configuration. + +``` +Event-Configuration-Status ::= < AVP Header: 4213 > + { Event-Configuration-State } + { Extended-SCEF-Reference-ID } + *[ AVP ] +``` + +#### A.6.3.6 Event-Reporting-Results AVP + +The Event-Reporting-Results AVP (AVP code 4214) is of type Unsigned32, it shall contain a bit mask. The bit 0 shall be the least significant bit. For example, to get the value of bit 0, a bit mask of 0x0001 should be used. The meaning of the bits shall be as defined below: + +**Table A.6.3.6-1: Event-Reporting-Results** + +| Bit | Name | Description | +|-----|--------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | Final report | This bit, when set, indicates that this is the final report for the UE group; when not set, indicates that there are more reports pending for the UE group. | + +#### A.6.3.7 Event-Reports AVP + +The Event-Reports AVP (AVP code 4215) is of type Grouped. It indicates the event reports for a UE group. + +``` +Event-Reports ::= < AVP Header: 4215 > + { Event-Reporting-Results } + { Extended-SCEF-Reference-ID } + *[ Access-Network-Reports ] + *[ AVP ] +``` + +#### A.6.3.8 Extended-SCEF-Reference-ID + +The Extended-SCEF-Reference-ID AVP (AVP code 4216) is of type Unsigned64 and it shall contain the identifier provided by the SCEF. + +### A.6.4 Nta re-used AVPs + +#### A.6.4.1 General + +Table A.6.4.1-1 lists the Diameter AVPs re-used by the Nta application from other existing Diameter Applications, reference to their respective specifications, short description of their usage within the Nta application. Other AVPs from existing Diameter Applications, except for the AVPs from Diameter base protocol, do not need to be supported. The AVPs from Diameter base protocol are not included in table A.6.4.1-1, but they are re-used for the Nta application. Unless otherwise stated, re-used AVPs shall maintain their 'M', 'P' and 'V' flag settings. + +**Table A.6.4.1-1: Nta re-used Diameter AVPs** + +| Attribute Name | Reference | Description | Applicability (NOTE) | +|------------------------------------|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| 3GPP-MS-TimeZone | 3GPP TS 29.061 [18] | Indicate the offset between universal time and local time in steps of 15 minutes of where the MS currently resides. | | +| 3GPP-SGSN-MCC-MNC | 3GPP TS 29.061 [18] | For GPRS the MCC and the MNC of the SGSN.
For 3GPP/non-3GPP accesses the MCC and the MNC provided by the serving gateway (SGW, or AGW or TWAG). | | +| 3GPP-User-Location-Info | 3GPP TS 29.061 [18] | Indicates details of where the UE is currently located (e.g. SAI, CGI or eNodeB ID) | | +| DRMP | IETF RFC 7944 [12] | Allows Diameter endpoints to indicate the relative priority of Diameter transactions. | | +| External-Identifier | 3GPP TS 29.336 [17] | External Identifier of the UE | | +| Group-Reporting-Guard-Timer | 3GPP TS 29.336 [17] | It is used by the PCRF to aggregate the reports. | | +| Load | IETF RFC 8583 [14] | The AVP used to convey load information between Diameter nodes. This AVP and all AVPs within this grouped AVP shall have the 'M' bit cleared. | | +| Location-Information-Configuration | 3GPP TS 29.336 [17] | Only MONTE-Location-Type AVP is applicable for the Nta application. | | +| Monitoring-Type | 3GPP TS 29.336 [17] | Only LOCATION_REPORTING (2) is applicable for the Nta application. | | +| MONTE-Location-Type | 3GPP TS 29.336 [17] | Indicates the current location or the last known location. | | +| MSISDN | 3GPP TS 29.329 [16] | MSISDN of the UE | | +| NetLoc-Access-Support | 3GPP TS 29.212 [19] | Indicates the level of support for NetLoc procedures provided by the current access network. | | +| OC-OLR | IETF RFC 7683 [10] | Contains the necessary information to convey an overload report. | | +| OC-Supported-Features | IETF RFC 7683 [10] | Defines the support for the Diameter overload indication conveyance by the sending node. | | +| SCEF-ID | 3GPP TS 29.336 [17] | The diameter identifier provided by the SCEF which has originated the request towards the PCRF. | | +| Supported-Features | 3GPP TS 29.229 [11] | If present, this AVP informs the destination host about the features that the origin host requires to successfully complete this command exchange. | | +| TCP-Source-Port | 3GPP TS 29.212 [19] | TCP source port number | | +| UDP-Source-Port | 3GPP TS 29.212 [19] | UDP source port number | | +| UE-Local-IP-Address | 3GPP TS 29.212 [19] | Contains the UE local IP address. | | +| User-Location-Info-Time | 3GPP TS 29.212 [19] | The time at which the UE was last known to be in the location. | | + +NOTE: AVPs marked with a supported feature are applicable as described in subclause A.6.4.2. + +#### A.6.4.2 Use of the Supported-Features AVP for the Nt application + +When new functionality is introduced for the Nt application, it should be defined as optional. If backwards incompatible changes cannot be avoided, the new functionality shall be introduced as a new feature and support advertised with the Supported-Features AVP. Unless otherwise stated, the use of the Supported-Features AVP for the Nt application shall be compliant to the usage of the Supported-Features AVP on the Cx reference point and consistent with the procedures for the dynamic discovery of supported features as defined in subclause 7.2 of 3GPP TS 29.229 [11]. + +The base functionality for the Nta application is the 3GPP Rel-15 standard and a feature is an extension to that functionality. If the origin host does not support any features beyond the base functionality, the Supported-Features AVP may be absent from the Nta commands. + +As defined in subclause 7.1.1 of 3GPP TS 29.229 [11], when extending the application by adding new AVPs for a feature, the new AVPs shall have the M bit cleared and the AVP shall not be defined mandatory in the command ABNF. + +As defined in 3GPP TS 29.229 [11], the Supported-Features AVP is of type grouped and contains the Vendor-Id, Feature-List-ID and Feature-List AVPs. On the all reference points as specified in this specification, the Supported-Features AVP is used to identify features that have been defined by 3GPP and hence, for features defined in this document, the Vendor-Id AVP shall contain the vendor ID of 3GPP (10415). If there are multiple feature lists defined for the reference point, the Feature-List-ID AVP shall differentiate those lists from one another. + +The Supported-Features AVP shall be included in every ECR and ECA commands if supported by the SCEF and PCRF respectively. + +The table A.6.4.2-1 defines the features applicable to the Nta application for the feature list with a Feature-List-ID of 1. + +**Table A.6.4.2-1: Features of Feature-List-ID 1 used in Nta** + +| Feature bit | Feature | M/O | Description | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|-----|-------------| +| Feature bit: The order number of the bit within the Feature-List AVP where the least significant bit is assigned number "0".
Feature: A short name that can be used to refer to the bit and to the feature, e.g. "EPS".
M/O: Defines if the implementation of the feature is mandatory ("M") or optional ("O") in this 3GPP Release.
Description: A clear textual description of the feature. | | | | + +NOTE: This table is a placeholder for when any supported features are added to Nta. There are no supported features in this release. + +### A.6.5 Nta specific Experimental-Result-Code AVP values + +Subclause 5.5 is applicable for Nta specific Experimental-Result-Code AVP values. + +### A.6.6 Nta messages + +#### A.6.6.1 Command-Code Values + +This subclause defines the Command-Code values for the Nta application as allocated by IANA from the vendor-specific namespace defined in IETF RFC 5719 [7]. Every command is defined by means of the ABNF syntax in IETF RFC 2234 [8], and according to the rules in IETF RFC 6733 [15]. + +The Vendor-Specific-Application-Id AVP shall not be included in any command sent by Diameter nodes supporting applications defined in this specification. If the Vendor-Specific-Application-Id AVP is received in any of the commands defined in this specification, it shall be ignored by the receiving node. + +NOTE: The Vendor-Specific-Application-Id is included as an optional AVP in all Command Code Format specifications defined in this specification in order to overcome potential interoperability issues with intermediate Diameter agents non-compliant with the IETF RFC 6733 [15]. + +The following Command Codes are defined in this specification: + +**Table A.6.6-1: Command-Code values for Nta** + +| Command-Name | Abbreviation | Code | Section | +|-----------------------------|---------------------|-------------|----------------| +| Event-Configuration-Request | ECR | 8388735 | A.6.6.2 | +| Event-Configuration-Answer | ECA | 8388735 | A.6.6.3 | +| Event-Reporting-Request | ERR | 8388736 | A.6.6.4 | +| Event-Reporting-Answer | ERA | 8388736 | A.6.6.5 | + +#### A.6.6.2 Event-Configuration-Request (ECR) command + +The ECR command, indicated by the Command-Code field set to 8388735 and the 'R' bit set in the Command Flags field, is sent by the SCEF to the PCRF as part of event monitoring configuration procedure. + +Message Format: + +``` + ::= + < Session-Id > + [ DRMP ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + { Destination-Host } + [ OC-Supported-Features ] + { External-Group-Identifier } + [ Event-Configuration ] + [ Group-Reporting-Guard-Timer ] + *[ Proxy-Info ] + *[ Route-Record ] + *[ Supported-Features ] + *[ AVP ] +``` + +#### A.6.6.3 Event-Configuration-Answer (ECA) command + +The ECA command, indicated by the Command-Code field set to 8388735 and the 'R' bit cleared in the Command Flags field, is sent by the PCRF to the SCEF as part of event monitoring configuration procedure. + +Message Format: + +``` + ::= + < Session-Id > + [ DRMP ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ Result-Code ] + [ Experimental-Result ] + [ Error-Message ] + [ Error-Reporting-Host ] + [ Failed-AVP ] + *[ Redirect-Host ] + [ Redirect-Host-Usage ] + [ Redirect-Max-Cache-Time ] + [ OC-Supported-Features ] + [ OC-OLR ] + [ Event-Reports ] + [ Event-Configuration-Status ] + *[ Proxy-Info ] + *[ Route-Record ] + *[ Supported-Features ] + *[ Load ] + *[ AVP ] +``` + +#### A.6.6.4 Event-Reporting-Request (ERR) command + +The ERR command, indicated by the Command-Code field set to 8388736 and the 'R' bit set in the Command Flags field, is sent by the PCRF to the SCEF as part of event monitoring report procedure. + +Message Format: + +``` + ::= + < Session-Id > +``` + +``` + [ DRMP ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + { Destination-Host } + [ OC-Supported-Features ] + [ Event-Reports ] + *[ Proxy-Info ] + *[ Route-Record ] + *[ AVP ] +``` + +#### A.6.6.5 Event-Reporting-Answer (ERA) command + +The ERA command, indicated by the Command-Code field set to 8388736 and the 'R' bit cleared in the Command Flags field, is sent by the SCEF to the PCRF as part of event monitoring report procedure + +Message Format: + +``` + ::= + < Session-Id > + [ DRMP ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ Result-Code ] + [ Experimental-Result ] + [ Error-Message ] + [ Error-Reporting-Host ] + [ Failed-AVP ] + *[ Redirect-Host ] + [ Redirect-Host-Usage ] + [ Redirect-Max-Cache-Time ] + [ OC-Supported-Features ] + [ OC-OLR ] + *[ Proxy-Info ] + *[ Route-Record ] + *[ Load ] + *[ AVP ] +``` + +# Annex B (informative): Change history + +| Change history | | | | | | | | | +|----------------|------------|-----------|------|-----|-----|------------------------------------------------------------------------------------------------------------------------------------|-------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | | Subject/Comment | Old | New | +| 2015-08 | | | | | | Editor's Initial Draft | | 0.0.0 | +| 2015-08 | CT3#82 | C3-153468 | | | | Initial version includes agreed documents: C3-153405, C3-153406, C3-153408, | 0.0.0 | 0.1.0 | +| 2015-10 | CT3#82 bis | | | | | Initial version includes agreed documents: C3-154100, C3-154293, C3-154180, C3-154317, C3-154295, C3-154330 | 0.1.0 | 0.2.0 | +| 2015-11 | CT3#83 | C3-155418 | | | | Initial version includes agreed documents: C3-155110, C3-155150, C3-155277, C3-155279, C3-155281, C3-155282, C3-155332, C3-155356. | 0.2.0 | 1.0.0 | +| 2015-11 | CT#70 | CP-150823 | | | | TS presented to plenary for information and approval | 1.0.0 | 1.0.1 | +| 2015-12 | CT#70 | CP-150823 | | | | TS 29.154 upgraded tp 13.0.0 after approval | 1.0.1 | 13.0.0 | +| Change history | | | | | | | | | +| Date | TSG # | TSG Doc. | CR | Rev | Cat | Subject/Comment | | New | +| 2016-03 | CT#71 | CP-160095 | 0001 | 1 | F | Add command codes and AVP numbers for Nt protocol | | 13.1.0 | +| 2016-03 | CT#71 | CP-160095 | 0002 | 2 | F | Missed Transfer-Request-Type AVP in the BTR/BTA commands | | 13.1.0 | +| 2016-03 | CT#71 | CP-160095 | 0003 | 2 | F | Some corrections for Nt protocol | | 13.1.0 | +| 2016-03 | CT#71 | CP-160093 | 0004 | 2 | B | Diameter Message Priority over Nt interface | | 13.1.0 | +| 2016-06 | CT#72 | CP-160251 | 0005 | 2 | F | Some corrections to 29.154 | | 13.2.0 | +| 2016-06 | CT#72 | CP-160251 | 0006 | - | F | Correction of future background data transfer procedure | | 13.2.0 | +| 2016-06 | CT#72 | CP-160251 | 0007 | - | F | Define Diameter application identifier for Nt reference point | | 13.2.0 | +| 2016-09 | CT#73 | CP-160444 | 0008 | 2 | F | Correction of the inconsistent terminology | | 13.3.0 | +| 2016-09 | CT#73 | CP-160444 | 0009 | 2 | F | Correction to PCRF addressing of transfer policy negotiation | | 13.3.0 | +| 2016-12 | CT#74 | CP-160614 | 0011 | - | F | Change IETF drmp draft version to official RFC 7944 | | 13.4.0 | +| 2016-12 | CT#74 | CP-160615 | 0010 | 1 | B | Diameter Load Control Mechanism | | 14.0.0 | +| 2016-12 | CT#74 | CP-160616 | 0012 | 1 | F | Diameter base protocol specification update | | 14.0.0 | +| 2017-03 | CT#75 | CP-170076 | 0013 | - | F | Update instance number for the Failed-AVP in answer commands | | 14.1.0 | +| 2017-06 | CT#76 | CP-171119 | 0019 | 1 | F | Reference update for draft-ietf-dime-load | | 14.2.0 | +| 2017-06 | CT#76 | CP-171136 | 0020 | 1 | F | Vendor-Specific-Application-Id AVP handling | | 14.2.0 | +| 2017-06 | CT#76 | CP-171136 | 0016 | 2 | F | Correction for Nt interface | | 15.0.0 | +| 2018-06 | CT#80 | CP-181023 | 0022 | 1 | B | Support for group based event configuration and reporting | | 15.1.0 | +| 2018-09 | CT#81 | CP-182026 | 0023 | - | F | Missing re-used AVP for Nta | | 15.2.0 | +| 2018-09 | CT#81 | CP-182026 | 0024 | 1 | F | IANA codes for Nta application | | 15.2.0 | +| 2019-09 | CT#85 | CP-192154 | 0026 | 1 | A | draft-ietf-dime-load published as RFC 8583 | | 15.3.0 | +| 2020-07 | SA#88e | - | - | - | | Update to Rel-16 version (MCC) | | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29162/00504fc688ebcf131ccbeff94dfc9939_img.jpg b/marked/Rel-16/29_series/29162/00504fc688ebcf131ccbeff94dfc9939_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..33543078a7b8457e9017b7364ed61fff4a05d0c8 --- /dev/null +++ b/marked/Rel-16/29_series/29162/00504fc688ebcf131ccbeff94dfc9939_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9f3cafdfa45ca1b58dd2763278fb9408830d0f8366176ec6bfef894ae7f22089 +size 147614 diff --git a/marked/Rel-16/29_series/29162/030c758fd425016b03290c8f11bef69d_img.jpg b/marked/Rel-16/29_series/29162/030c758fd425016b03290c8f11bef69d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..25a289fbc587455c0e59cb86570240ee30f4d114 --- /dev/null +++ b/marked/Rel-16/29_series/29162/030c758fd425016b03290c8f11bef69d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0671664da4eee181b960a11b9d3fe663c37df0c1f45cd9aa1ceba9aa44b0c8cb +size 33880 diff --git a/marked/Rel-16/29_series/29162/0a73b03fba21af142d619a9a662e6490_img.jpg b/marked/Rel-16/29_series/29162/0a73b03fba21af142d619a9a662e6490_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..018f1f17ab99251ba5741eac5982866335a694ee --- /dev/null +++ b/marked/Rel-16/29_series/29162/0a73b03fba21af142d619a9a662e6490_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9e2efe32627928476745794e6fe0a93cbc684df2e5cbfb34d721548cf5923a17 +size 117959 diff --git a/marked/Rel-16/29_series/29162/0c80c383f76034e117adf5e5eaadaaf3_img.jpg b/marked/Rel-16/29_series/29162/0c80c383f76034e117adf5e5eaadaaf3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c954586b93e52a0e51b651d70e110d45ce497282 --- /dev/null +++ b/marked/Rel-16/29_series/29162/0c80c383f76034e117adf5e5eaadaaf3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5a76a78f68cae1c6e39420334c879a6228ea94c3b1379f8027ca1128b2949803 +size 31043 diff --git a/marked/Rel-16/29_series/29162/187d05bf7ead21e1394b61320d8b3632_img.jpg b/marked/Rel-16/29_series/29162/187d05bf7ead21e1394b61320d8b3632_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2440678d6b304055cf3fa7c6c922e83b41e85aea --- /dev/null +++ b/marked/Rel-16/29_series/29162/187d05bf7ead21e1394b61320d8b3632_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:dd4bda294abd1251ce64f0e28a78c99b87bca8973a26730da48dbca58e120e6a +size 67651 diff --git a/marked/Rel-16/29_series/29162/28d75f39a24203712ee907b32cf0bbe5_img.jpg b/marked/Rel-16/29_series/29162/28d75f39a24203712ee907b32cf0bbe5_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ac9a04ef8c4da654af14f9a1b2c65b32a8170d21 --- /dev/null +++ b/marked/Rel-16/29_series/29162/28d75f39a24203712ee907b32cf0bbe5_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:729356d71dc2f3337ea07745e66db19a4053a81c8e2b614a49eecba105c3b0f5 +size 153430 diff --git a/marked/Rel-16/29_series/29162/36fd537a1e39baa2471ecfaaf869751a_img.jpg b/marked/Rel-16/29_series/29162/36fd537a1e39baa2471ecfaaf869751a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..92d84dce992ac79a166fdd0e102fdc7ca1a4977b --- /dev/null +++ b/marked/Rel-16/29_series/29162/36fd537a1e39baa2471ecfaaf869751a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6b31ec7115ca62d21a0253b407733365ca4564817d13d03bddb159e9d36e61d4 +size 91908 diff --git a/marked/Rel-16/29_series/29162/421fc75480c21e7ebb25756826652367_img.jpg b/marked/Rel-16/29_series/29162/421fc75480c21e7ebb25756826652367_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..63612f1e7f6554adbcdedbc9de0599fdb093ffec --- /dev/null +++ b/marked/Rel-16/29_series/29162/421fc75480c21e7ebb25756826652367_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0edae0797dc5e1af634f4a68782e6074294f7d698dcd04eb4f2ca7acf8ac8485 +size 17595 diff --git a/marked/Rel-16/29_series/29162/4e85fe330de2c4f5eea6de4b2a53c77f_img.jpg b/marked/Rel-16/29_series/29162/4e85fe330de2c4f5eea6de4b2a53c77f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1aae9a28720585507a3348c99569f59d9016d8fb --- /dev/null +++ b/marked/Rel-16/29_series/29162/4e85fe330de2c4f5eea6de4b2a53c77f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e7139f2b31cfd0d5098c4a7bff4cdca395a05b7ee039ac6cfaa0c2c0bc82e13a +size 65881 diff --git a/marked/Rel-16/29_series/29162/5879500ca01e1a2521654beff6c289a4_img.jpg b/marked/Rel-16/29_series/29162/5879500ca01e1a2521654beff6c289a4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c84bd90ef760cb3dbe12aaffa3a860e2936925e1 --- /dev/null +++ b/marked/Rel-16/29_series/29162/5879500ca01e1a2521654beff6c289a4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:08a028c32e812980a8c57e4f2e05a8d792a0f4fa3ccb17cc81ec2872d39dc464 +size 36257 diff --git a/marked/Rel-16/29_series/29162/69e5f1993021af230d08c08aac97d9df_img.jpg b/marked/Rel-16/29_series/29162/69e5f1993021af230d08c08aac97d9df_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1cb6e1b32f2d8e9f76bf44cfed1560d3284602cc --- /dev/null +++ b/marked/Rel-16/29_series/29162/69e5f1993021af230d08c08aac97d9df_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:22ac90972ec652b3fdd96efd12b0ff7421f90fb2632c652aecba59b961d94c73 +size 42462 diff --git a/marked/Rel-16/29_series/29162/7c6d9bfe9c31ce872722d60b73d20df1_img.jpg b/marked/Rel-16/29_series/29162/7c6d9bfe9c31ce872722d60b73d20df1_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c516534067f6eefb582126198e243dc29e390f0b --- /dev/null +++ b/marked/Rel-16/29_series/29162/7c6d9bfe9c31ce872722d60b73d20df1_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:48ad216f4428d8c86ebde2b183617239176bf72ec99595e2f52d0f256275f17b +size 53690 diff --git a/marked/Rel-16/29_series/29162/9dc9f41d7d76c1add4b190d348cb1533_img.jpg b/marked/Rel-16/29_series/29162/9dc9f41d7d76c1add4b190d348cb1533_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f8ef62064da1e2ed17fdd8f0fcb06a402b17b8cd --- /dev/null +++ b/marked/Rel-16/29_series/29162/9dc9f41d7d76c1add4b190d348cb1533_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:07e291d726aa737fbf74f8457846cffc9a06b6e8d911d36ceab518d4c6d0b298 +size 41361 diff --git a/marked/Rel-16/29_series/29162/a0739aaf13fa5a632d4faa830f6b2708_img.jpg b/marked/Rel-16/29_series/29162/a0739aaf13fa5a632d4faa830f6b2708_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..797828cc61cf979c422bae32d72250a5cb4d88de --- /dev/null +++ b/marked/Rel-16/29_series/29162/a0739aaf13fa5a632d4faa830f6b2708_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:27528e5749fc1a5317754b25eb4d7f9d7b565454ba578b63e96e3d879052917a +size 41213 diff --git a/marked/Rel-16/29_series/29162/a548c5381cebd2650c5edb725b19f795_img.jpg b/marked/Rel-16/29_series/29162/a548c5381cebd2650c5edb725b19f795_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e114dffc3bc2d230dbb0a72a9356e21bc1f29aff --- /dev/null +++ b/marked/Rel-16/29_series/29162/a548c5381cebd2650c5edb725b19f795_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:53abd2a52adf066b32e6f9f535d0ca3c05dade4d0abcb4b96c3c4681716b7ea0 +size 104120 diff --git a/marked/Rel-16/29_series/29162/b5335262987c819d7f71ce40f99cb71b_img.jpg b/marked/Rel-16/29_series/29162/b5335262987c819d7f71ce40f99cb71b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4eb4b1fef49b5d48e4c9824a09d5106852a0b9c8 --- /dev/null +++ b/marked/Rel-16/29_series/29162/b5335262987c819d7f71ce40f99cb71b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4fe622e250d34b45eb944e28a72daff698b801f177074da51e939d3cb730c271 +size 145100 diff --git a/marked/Rel-16/29_series/29162/cb8dd5eca74bbf15a81e37c23263c9a8_img.jpg b/marked/Rel-16/29_series/29162/cb8dd5eca74bbf15a81e37c23263c9a8_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d383c55a8933861175f185a51c239915b7d78fe3 --- /dev/null +++ b/marked/Rel-16/29_series/29162/cb8dd5eca74bbf15a81e37c23263c9a8_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5dd15828a18d5866d44b3636ff68fccdba9d1737a04b8d2ab3aaa4283525b98a +size 16854 diff --git a/marked/Rel-16/29_series/29162/df1966d80c74bc127f159a48f38b13ee_img.jpg b/marked/Rel-16/29_series/29162/df1966d80c74bc127f159a48f38b13ee_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ba9f5d8e3bd433cad890b5ae66c92adb59756309 --- /dev/null +++ b/marked/Rel-16/29_series/29162/df1966d80c74bc127f159a48f38b13ee_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ded303c7203226359232fcdf91d15467b0c816e4e8d404a194a62de7cd075b41 +size 126734 diff --git a/marked/Rel-16/29_series/29162/df65c22a46ec3e7285e44de67d3a59cf_img.jpg b/marked/Rel-16/29_series/29162/df65c22a46ec3e7285e44de67d3a59cf_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..05e663ee405cf6f3f02bdf07ea1388dad257ea8b --- /dev/null +++ b/marked/Rel-16/29_series/29162/df65c22a46ec3e7285e44de67d3a59cf_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b99fc4f65d7451f3658a6f65124f847857682d3bccf03b9dc085da5259634b7e +size 21035 diff --git a/marked/Rel-16/29_series/29162/eb03559a4d92ea9ebd63ea9be663c50a_img.jpg b/marked/Rel-16/29_series/29162/eb03559a4d92ea9ebd63ea9be663c50a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..def5dfac14c99d6d4b8ffd61ebccaaa66b51e0ef --- /dev/null +++ b/marked/Rel-16/29_series/29162/eb03559a4d92ea9ebd63ea9be663c50a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:35a62980ba479c6efe91eac7cb74b0841c57a1dace9776d05fb735459abda442 +size 134961 diff --git a/marked/Rel-16/29_series/29162/ff0952ef692c9d960ce5f6708bcc9711_img.jpg b/marked/Rel-16/29_series/29162/ff0952ef692c9d960ce5f6708bcc9711_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7e7f9b35b14dc67da482ceb98913c6571941b0e8 --- /dev/null +++ b/marked/Rel-16/29_series/29162/ff0952ef692c9d960ce5f6708bcc9711_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2df4922ea610a2821477de3a0787774c49d43ff2ceb1fc9d0615600c9820f316 +size 92424 diff --git a/marked/Rel-16/29_series/29162/raw.md b/marked/Rel-16/29_series/29162/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..c77c97fe81caf060b23d15a063bd7e104fd11bbc --- /dev/null +++ b/marked/Rel-16/29_series/29162/raw.md @@ -0,0 +1,2485 @@ + + + + + + +# Contents + +| | | +|-------------------------------------------------------------------------------------------------|----| +| Foreword ..... | 6 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions, symbols and abbreviations ..... | 9 | +| 3.1 Definitions..... | 9 | +| 3.2 Symbols..... | 10 | +| 3.3 Abbreviations ..... | 10 | +| 4 General..... | 11 | +| 4.1 General interworking overview..... | 11 | +| 4.2 Interworking scenarios ..... | 12 | +| 4.2.1 UE with 3GPP SIP profile capability connecting to an external SIP device..... | 12 | +| 5 Network characteristics..... | 12 | +| 5.1 Key characteristics of IP Multimedia Networks ..... | 12 | +| 5.2 Key characteristics of UMTS IM CN Subsystem..... | 12 | +| 6 Interworking Reference Model for control plane interworking and user plane interworking ..... | 12 | +| 6.0 Reference Model ..... | 12 | +| 6.1 Interworking Functional Entities..... | 14 | +| 6.1.1 IBCF ..... | 14 | +| 6.1.2 IMS-ALG ..... | 14 | +| 6.1.3 TrGW..... | 14 | +| 6.1.4 Acces Transfer Control Function ..... | 14 | +| 6.1.5 Acces Transfer GateWay..... | 14 | +| 7 Control plane interworking..... | 14 | +| 7.1 SIP with 3GPP Profile to Standard SIP Interworking..... | 14 | +| 7.2 Additional interworking of protocols associated with services ..... | 15 | +| 8 User Plane Interworking ..... | 15 | +| 8.1 Overview ..... | 15 | +| 8.2 Void..... | 15 | +| 8.3 Void..... | 15 | +| 9 IMS-ALG and TrGW functionality for NAPT and IP Version Interworking ..... | 15 | +| 9.1 Control plane interworking ..... | 15 | +| 9.1.1 Session Set-up ..... | 15 | +| 9.1.1.0 General..... | 15 | +| 9.1.1.1 Receipt of the first SDP offer ..... | 15 | +| 9.1.1.2 Receipt of the first SDP answer..... | 16 | +| 9.1.2 Void..... | 16 | +| 9.1.3 Change of connection information ..... | 16 | +| 9.1.4 Interworking of SIP messages..... | 16 | +| 9.1.5 Modification of SDP bandwidth information for IP version interworking ..... | 17 | +| 9.2 User plane transport ..... | 17 | +| 9.2.1 Payload transport..... | 17 | +| 9.2.2 IP header interworking ..... | 18 | +| 9.2.2.1 IPv4 to IPv6 ..... | 18 | +| 9.2.2.2 Abnormal cases..... | 19 | +| 9.2.2.3 IPv6 to IPv4 ..... | 20 | +| 9.2.2.4 Abnormal cases..... | 21 | +| 9.2.3 Fragmentation..... | 21 | +| 9.2.4 Abnormal cases ..... | 22 | +| 10 IBCF – TrGW Interactions ..... | 22 | +| 10.1 Overview ..... | 22 | +| 10.1.1 General ..... | 22 | +| 10.1.2 Network model ..... | 22 | + +| | | | +|-------------|------------------------------------------------------------------------------------|----| +| 10.1.3 | Example Call Flow ..... | 22 | +| 10.1.3.1 | Basic Procedures..... | 22 | +| 10.1.3.1.1 | Call Establishment..... | 22 | +| 10.1.3.1.2 | Call Release..... | 25 | +| 10.2 | Main Functions supported at the Ix Interface..... | 25 | +| 10.2.0 | Introduction ..... | 25 | +| 10.2.1 | NAPT and IP version interworking..... | 26 | +| 10.2.2 | Gate Management..... | 26 | +| 10.2.3 | RTCP Handling ..... | 26 | +| 10.2.4 | IP Realm Indication..... | 27 | +| 10.2.5 | Media Control..... | 27 | +| 10.2.5.1 | General..... | 27 | +| 10.2.5.2 | Handling of common codec parameters ..... | 34 | +| 10.2.5.3 | EVS speech codec parameters handling ..... | 34 | +| 10.2.5.4 | Rate adaptation for media endpoints ..... | 34 | +| 10.2.6 | Media Inactivity Detection..... | 35 | +| 10.2.7 | QoS Packet Marking (differentiated services)..... | 35 | +| 10.2.8 | Hanging Termination Detection..... | 36 | +| 10.2.9 | Bandwidth Policing ..... | 36 | +| 10.2.10 | IMS end-to-end media plane security..... | 36 | +| 10.2.10.1 | End-to-end security for RTP based media..... | 36 | +| 10.2.10.2 | End-to-end security for TCP based media using TLS ..... | 36 | +| 10.2.11 | Through-Connection..... | 37 | +| 10.2.11.1 | General..... | 37 | +| 10.2.11.2 | Through-connect control procedures considering the P-Early-Media header field..... | 37 | +| 10.2.12 | Emergency Call ..... | 39 | +| 10.2.13 | Explicit Congestion Notification support..... | 39 | +| 10.2.13.1 | General..... | 39 | +| 10.2.13.2 | Incoming SDP offer with ECN..... | 39 | +| 10.2.13.3 | Incoming SDP offer without ECN..... | 40 | +| 10.2.13.3a | Detection of ECN failures by TrGW ..... | 41 | +| 10.2.13.4 | Interworking with non-3GPP ECN IP terminal..... | 41 | +| 10.2.13.4.1 | Support for additional ECN parameters ..... | 41 | +| 10.2.13.4.2 | Incoming SDP offer from external IP network with ECN ..... | 41 | +| 10.2.13.4.3 | Incoming SDP offer from the IMS with ECN..... | 41 | +| 10.2.13.5 | Message sequence chart..... | 43 | +| 10.2.13.5.1 | ECN support requested (ECN endpoint)..... | 43 | +| 10.2.13.5.2 | ECN Active Indicated (ECN transparent)..... | 43 | +| 10.2.13.5.3 | ECN Failure Indication (ECN endpoint)..... | 44 | +| 10.2.14 | Optimal Media Routeing ..... | 44 | +| 10.2.15 | IP Realm Availability ..... | 44 | +| 10.2.16 | Access Transfer procedures with media anchored in ATGW ..... | 44 | +| 10.2.17 | Multimedia Priority Service (MPS) Support ..... | 45 | +| 10.2.17.1 | General..... | 45 | +| 10.2.17.2 | TrGW Resource Congestion in ADD response, request is queued ..... | 45 | +| 10.2.17.3 | TrGW Resource Congestion in ADD response, IBCF seizes new TrGW..... | 46 | +| 10.2.17.4 | TrGW Priority Resource Allocation..... | 46 | +| 10.2.17.5 | TrGW Priority User Data marking ..... | 47 | +| 10.2.17.6 | TrGW Priority Modification..... | 47 | +| 10.2.18 | Coordination of Video Orientation..... | 47 | +| 10.2.18.1 | General..... | 47 | +| 10.2.18.2 | Message sequence chart..... | 48 | +| 10.2.19 | Generic image attributes..... | 49 | +| 10.2.19.1 | General..... | 49 | +| 10.2.19.2 | Indication of generic image attributes ..... | 50 | +| 10.2.20 | Interactive Connectivity Establishment (ICE)..... | 51 | +| 10.2.21 | MSRP handling ..... | 51 | +| 10.2.22 | Alternative connection (ALTC) addresses management..... | 51 | +| 10.2.23 | Video Region-of-Interest (ROI) ..... | 52 | +| 10.2.23.1 | General..... | 52 | +| 10.2.23.2 | "Far End Camera Control" mode ..... | 52 | +| 10.2.23.2.1 | General ..... | 52 | + +| | | | +|-------------------------------|-----------------------------------------------------|-----------| +| 10.2.23.2.2 | Message sequence chart ..... | 52 | +| 10.2.23.3 | "Predefined ROI" mode ..... | 53 | +| 10.2.23.3.1 | General ..... | 53 | +| 10.2.23.3.2 | Message sequence chart ..... | 53 | +| 10.2.23.4 | "Arbitrary ROI" mode..... | 53 | +| 10.2.23.4.1 | General ..... | 53 | +| 10.2.23.4.2 | Message sequence chart ..... | 54 | +| 10.2.24 | SDP Capability Negotiation (SDPCapNeg) ..... | 54 | +| 10.2.24.1 | General..... | 54 | +| 10.2.24.2 | Message sequence chart..... | 55 | +| 10.2.24.2.1 | Audit SDPCapNeg Supported Capabilities..... | 55 | +| 10.2.25 | WebRTC Media Plane Optimization..... | 56 | +| 10.2.25.1 | General..... | 56 | +| 10.2.25.2 | SDP offer handling ..... | 56 | +| 10.2.25.3 | SDP answer handling..... | 56 | +| 10.2.26 | RTP-level pause and resume ..... | 56 | +| 10.2.27 | RTCP Codec Control Commands and Indications ..... | 56 | +| 10.2.28 | Delay Budget Information (DBI) ..... | 57 | +| 10.3 | Void..... | 57 | +| 10.4 | Procedures ..... | 57 | +| 10.4.1 | Call related Procedures..... | 57 | +| 10.4.1.1 | Reserve TrGW Connection Point ..... | 57 | +| 10.4.1.2 | Configure TrGW Connection Point ..... | 61 | +| 10.4.1.3 | Reserve and Configure TrGW Connection Point ..... | 65 | +| 10.4.1.4 | Release TrGW Termination..... | 70 | +| 10.4.1.5 | IP Bearer Released..... | 70 | +| 10.4.1.6 | Media Inactivity Detection ..... | 71 | +| 10.4.1.7 | Termination heartbeat indication ..... | 71 | +| 10.4.1.8 | Change Through-Connection..... | 72 | +| 10.4.1.9 | ECN Failure Indication ..... | 72 | +| 10.4.1.10 | Change Flow Direction ..... | 73 | +| 10.4.1.11 | ICE Connectivity Check Result Notification..... | 73 | +| 10.4.1.12 | ICE New Peer Reflexive Candidate Notification ..... | 74 | +| 10.4.2 | Non Call related Procedures ..... | 74 | +| Annex A (informative): | Void..... | 75 | +| Annex B (informative): | Change history..... | 76 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 1 Scope + +The IM CN subsystem interworks with the external IP networks through the Mb reference point. + +This document details the interworking between the IM CN subsystem and external IP networks for IM service support. It addresses the issues of control plane interworking and, user plane interworking for specific interworking use cases. Clause 10 describes the IMS-Ix interface requirements in the form of Use Cases which require H.248 protocol procedures. Subclause 10.4 then details the additional Information Elements required to perform the specific procedures. + +The IP version Interworking, between IP version 4 (IETF RFC 791 [9] ) and IP version 6 (IETF RFC 2460 [10] ) detailed in terms of the processes and protocol mappings required in order to support both IMS originated and terminated calls. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TS 24.229: "Internet Protocol (IP) multimedia call control protocol based on Session Initiation Protocol (SIP) and Session Description Protocol (SDP); Stage 3". +- [2] IETF RFC 3261: "SIP: Session Initiation Protocol". +- [3] 3GPP TS 23.221: "Architectural requirements". +- [4] 3GPP TS 29.061: "Interworking between the Public Land Mobile Network (PLMN) supporting packet based services and Packet Data Networks (PDN)". +- [5] 3GPP TS 23.002: "Network architecture". +- [6] Void. +- [7] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [8] 3GPP TS 23.228: "IP Multimedia Subsystem (IMS); Stage 2". +- [9] IETF RFC 791: "Internet Protocol". +- [10] IETF RFC 2460: "Internet Protocol, Version 6 (IPv6) Specification". +- [11] IETF RFC 2766: "Network Address Translation - Protocol Translation (NAT-PT)". +- [12] IETF RFC 2663: "IP Network Address Translator (NAT) Terminology and Considerations". +- [13] 3GPP TR 29.962 version 6.1.0: "Signalling interworking between the 3GPP profile of the Session Initiation Protocol (SIP) and non-3GPP SIP usage". +- [14] Void. +- [15] Void. +- [16] Void. +- [17] Void. + +- [18] IETF RFC 792: "Internet Control Message Protocol". +- [19] IETF RFC 2463: "Internet Control Message Protocol (ICMPv6) for the Internet Protocol Version 6". +- [20] Void. +- [21] Void. +- [22] Void. +- [23] Void. +- [24] Void. +- [25] 3GPP TS 29.238: "Interconnection Border Control Functions – Transition Gateway; H.248 Profile; Stage 3". +- [26] ITU-T Recommendation H.248.1 (05): "Gateway Control Protocol: Version 3". +- [27] Void. +- [28] 3GPP TS 23.205: "Bearer-independent circuit-switched core network; Stage 2". +- [29] 3GPP TS 29.235: "Interworking between SIP-I based circuit-switched core network and other networks". +- [30] Void. +- [31] IETF RFC 2474: "Definition of the Differentiated Services Field (DS Field) in the IPv4 and IPv6 Headers". +- [32] 3GPP TS 33.328: "IMS Media Plane Security". +- [33] IETF RFC 4568: "Session Description Protocol (SDP) Security Descriptions for Media Streams". +- [34] IETF RFC 3711: "The Secure Real-time Transport Protocol (SRTP)". +- [35] IETF RFC 5124: "Extended Secure RTP Profile for Real-time Transport Control Protocol (RTCP)-Based Feedback (RTP/SAVPF)". +- [36] 3GPP TS 26.114: "IP Multimedia Subsystem (IMS); Multimedia Telephony; Media handling and interaction". +- [37] IETF RFC 3168: "The Addition of Explicit Congestion Notification (ECN) to IP". +- [38] IETF RFC 6679: "Explicit Congestion Notification (ECN) for RTP over UDP". +- [39] 3GPP TS 29.079: "Optimal Media Routeing within the IP Multimedia Subsystem; Stage 3". +- [40] 3GPP TS 29.165: "Inter-IMS Network to Network Interface (NNI)". +- [41] 3GPP TS 23.237: "IP Multimedia subsystem (IMS) Service Continuity; Stage 2". +- [42] 3GPP TS 24.237: "IP Multimedia subsystem (IMS) Service Continuity; Stage 3". +- [43] 3GPP TS 23.334: "IP Multimedia Subsystem (IMS) Application Level Gateway (IMS-ALG) – IMS Access Gateway (IMS-AGW) interface: Procedures descriptions". +- [44] 3GPP TS 22.153: "Multimedia Priority Service". +- [45] IETF RFC 5285: "A General Mechanism for RTP Header Extensions". +- [46] IETF RFC 6236: "Negotiation of Generic Image Attributes in the Session Description Protocol (SDP)". +- [47] IETF RFC 4975: "The Message Session Relay Protocol (MSRP)". + +- [48] IETF RFC 6714: "Connection Establishment for Media Anchoring (CEMA) for the Message Session Relay Protocol (MSRP)". +- [49] IETF RFC 4583: "Session Description Protocol (SDP) Format for Binary Floor Control Protocol (BFCP) Streams". +- [50] IETF RFC 5245: "Interactive Connectivity Establishment (ICE): A Protocol for Network Address Translator (NAT) Traversal for Offer/Answer Protocols". +- [51] IETF RFC 6947: "The Session Description Protocol (SDP) Alternate Connectivity (ALTC) Attribute". +- [52] 3GPP TS 26.441: "Codec for Enhanced Voice Services (EVS); General Overview". +- [53] 3GPP TS 26.445: "Codec for Enhanced Voice Services (EVS); Detailed Algorithmic Description". +- [54] IETF RFC 4573: "MIME Type Registration for RTP Payload Format for H.224". +- [55] ITU-T Recommendation H.224 (01/2005): "A real time control protocol for simplex applications using the H.221 LSD/HSD/MLP channels". +- [56] ITU-T Recommendation H.281 (11/1994): "A far end camera control protocol for videoconferences using H.224". +- [57] IETF RFC 5939: "Session Description Protocol (SDP) Capability Negotiation". +- [58] IETF RFC 5009: "Private Header (P-Header) Extension to the Session Initiation Protocol (SIP) for Authorization of Early Media". +- [59] IETF RFC 7728: "RTP Stream Pause and Resume". +- [60] IETF RFC 4585: "Extended RTP Profile for Real-time Transport Control Protocol (RTCP)-Based Feedback (RTP/AVPF)". +- [61] IETF RFC 5104: "Codec Control Messages in the RTP Audio-Visual Profile with Feedback (AVPF)". + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [7] and the following apply: + +**End-to-end security:** media protection between two IMS UEs without being terminated by any intermediary node. + +**ICE lite:** The lite implementation of the Interactive Connectivity Establishment (ICE) specified in IETF RFC 5245 [50]. + +**Full ICE:** The full implementation of the Interactive Connectivity Establishment (ICE) specified in IETF RFC 5245 [50]. + +**IM CN subsystem:** (IP Multimedia CN subsystem) comprises of all CN elements for the provision of IP multimedia applications over IP multimedia sessions + +**IP multimedia session:** set of multimedia senders and receivers and the data streams flowing from senders to receivers IP multimedia sessions are supported by the IP multimedia CN Subsystem and are enabled by IP connectivity bearers (e.g. GPRS as a bearer). A user may invoke concurrent IP multimedia sessions. + +**MSC Server enhanced for ICS:** An MSC Server that supports the network based ICS functionality. + +**MSC Server enhanced for SRVCC:** An MSC Server that supports the network based SRVCC functionality. + +## 3.2 Symbols + +For the purposes of the present document, the following symbols apply: + +| | | +|----|---------------------------------------------------------------------------------------------------------| +| Mm | Reference Point between a CSCF/BGCF/IMS-ALG and an IP multimedia network. | +| Mx | Reference Point between a CSCF/BGCF/MSC Server enhanced for ICS/MSC Server enhanced for SRVCC and IBCF. | +| Mb | Reference Point defined in 3GPP TS 23.002 [5] and is IP based. | +| Ix | Reference Point between IBCF and TrGW or CS-IBCF and CS-TrGW. | + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [7] and the following apply: An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [7]. + +| | | +|-------------|----------------------------------------------------------------------------------| +| ALTC | ALTerative Connection | +| APP | APplication-defined RTCP packet | +| ATCF | Access Transfer Control Function | +| ATGW | Access Transfer Gateway | +| B2BUA | Back-to-Back User Agent | +| BFCP | Binary Floor Control Protocol | +| BGCF | Breakout Gateway Control Function | +| CCM | Codec Control Messages | +| CS-TrGW | CS (domain) TrGW | +| CVO | Coordination of Video Orientation | +| DBI | Delay Budget Information | +| DRVCC | Dual Radio Voice Call Continuity | +| ECN | Explicit Congestion Notification | +| ECN-CE | ECN Congestion Experienced | +| EVS | Enhanced Voice Services | +| FECC | Far End Camera Control | +| FIR | Full Intra Request | +| IBCF | Interconnect Border Control Function | +| ICE | Interactive Connectivity Establishment | +| ICS | IMS Centralized Services | +| I-CSCF | Interrogating CSCF | +| IMS-ALG | IMS - Application Level Gateway | +| ITU-T | International Telecommunication Union – Telecommunication Standardization Sector | +| MboIP | Mb over IP | +| MPS | Multimedia Priority Service | +| MRFP | Multimedia Resource Function Processor | +| MSRP | Message Session Relay Protocol | +| MTSI | Multimedia Telephony Service for IMS | +| NAT/NAPT | Network Address Translation / Network Address and Port Translation | +| NA (P) T-PT | Network Address (and Port) Translation - Protocol Translation | +| OMR | Optimal Media Routeing | +| P-CSCF | Proxy CSCF | +| ROI | Region of Interest | +| RTCP | Real Time Control Protocol | +| SCTP | Stream Control Transmission Protocol | +| SDPCapNeg | SDP Capability Negotiation | +| SIP UA | SIP User Agent | +| STUN | Session Traversal Utilities for NAT | +| THIG | Topology Hiding Internetwork Gateway | +| TLS | Transport Layer Security | +| TMMBN | Temporary Maximum Media Stream Bit Rate Notification | +| TMMBR | Temporary Maximum Media Stream Bit Rate Request | +| TRF | Transit and Roaming Function | +| TrGW | Transition GateWay | +| UAC | User Agent Client | +| UAS | User Agent Server | + +| | | +|-----|-----------------------| +| URN | Uniform Resource Name | +| WAN | Wide Area Network | + +# 4 General + +## 4.1 General interworking overview + +The IM CN Subsystem interworks with SIP (IETF RFC 3261 [2]) based IP Multimedia networks. These IP Multimedia networks include: + +- SIP User Agents (SIP UAs); and +- SIP Servers. + +As such, the IM CN Subsystem has to be able to interwork to all of these above functional entities in the IP multimedia network, as there is a possibility that they all may be involved in an IM session. The general interworking model is shown in figure 1. The SIP based Multimedia networks may use IP version 4 (IETF RFC 791 [9]) or IP version 6 (IETF RFC 2460 [10]). + +![Figure 1: Interworking Model for IM CN Subsystem to IP Multimedia Network. The diagram shows the IM CN subsystem network on the left and the IP multimedia network on the right, separated by a dashed vertical line. On the left, P/I/S/E-CSCF, BGCF, and Transit function (containing TRF) are connected to the IBCF via Mx (signalling) interfaces. The IBCF is connected to the TrGW via an Ix (bearer) interface. The MSC Server enhanced for ICS, for SRVCC or for DRVCC is also connected to the TrGW via an Mx (signalling) interface. The TrGW is connected to the IP multimedia network via an IPv4 or IPv6 interface. Inside the IP multimedia network (shaded oval), there is a SIP Proxy and a SIP UA. A legend at the bottom left indicates that dashed lines represent Signalling and solid lines represent Bearer.](7c6d9bfe9c31ce872722d60b73d20df1_img.jpg) + +Figure 1: Interworking Model for IM CN Subsystem to IP Multimedia Network. The diagram shows the IM CN subsystem network on the left and the IP multimedia network on the right, separated by a dashed vertical line. On the left, P/I/S/E-CSCF, BGCF, and Transit function (containing TRF) are connected to the IBCF via Mx (signalling) interfaces. The IBCF is connected to the TrGW via an Ix (bearer) interface. The MSC Server enhanced for ICS, for SRVCC or for DRVCC is also connected to the TrGW via an Mx (signalling) interface. The TrGW is connected to the IP multimedia network via an IPv4 or IPv6 interface. Inside the IP multimedia network (shaded oval), there is a SIP Proxy and a SIP UA. A legend at the bottom left indicates that dashed lines represent Signalling and solid lines represent Bearer. + +**Figure 1: Interworking Model for IM CN Subsystem to IP Multimedia Network** + +The PS UE uses the CSCF in order to communicate with the external IP multimedia network entities. + +The CS UE uses a MSC Server to communicate with external IP multimedia network entities. + +If no IP version interworking or no NAT/NAPT between different realms is required, the CSCF and the MSC Server can communicate with SIP UAs in an external IP multimedia network directly. + +If no IP version interworking or no NAT/NAPT between different realms is required, the CSCF and the MSC Server can also communicate with SIP proxies in an external IP multimedia network directly, which in turn can then communicate with SIP UAs. + +To provide the IP version interworking or NAT/NAPT between different realms the functions of an IMS-ALG and a TrGW may be inserted between the CSCF or the MSC Server and the external IP Multimedia Network by configuration. The IMS-ALG and the TrGW may be implemented as a part of other physical entities in the IMS. + +NOTE: Other methods to provide IP version interworking are outside the scope of this release. + +## 4.2 Interworking scenarios + +3GPP specifications design the IM CN subsystem elements and interfaces to exclusively support IPv6. + +3GPP TS 23.221 [3] details the interoperability scenarios that an UE may experience when interworking with an external PDN. All of these IP transport layer interworking scenarios can apply to the application layer interworking scenarios detailed in subclause 4.2.1. + +### 4.2.1 UE with 3GPP SIP profile capability connecting to an external SIP device + +The procedures used by an UE with 3GPP SIP profile to connect to an external SIP device, which may lack 3GPP SIP profile capabilities, have been analysed in Release 6 within 3GPP TR 29.962 [13] and are specified in 3GPP TS 24.229 [1]. + +# --- 5 Network characteristics + +## 5.1 Key characteristics of IP Multimedia Networks + +The Internet is a conglomeration of networks utilising a common set of protocols. IP protocols are defined in the relevant IETF RFCs. The networks topologies may be based on LANs (e.g. Ethernet), Point-to-Point leased lines, PSTN, ISDN, X.25 or WANs using switched technology (e.g. SMDS, ATM). + +IP multimedia networks provide the ability for users to invoke IP multimedia applications in order to send and receive (where applicable) voice and data communications. One protocol used to manage IP multimedia sessions is the Session Initiation Protocol (SIP) (IETF RFC 3261 [2]). + +## 5.2 Key characteristics of UMTS IM CN Subsystem + +The UMTS IM CN subsystem uses the SIP protocol to manage IP multimedia sessions, and uses IP as the transport mechanism for both SIP session signalling and media transport. + +The UMTS IM CN subsystem shall support interworking with existing fixed and mobile voice and IP data networks, including PSTN, ISDN, Mobile and Internet. + +# --- 6 Interworking Reference Model for control plane interworking and user plane interworking + +## 6.0 Reference Model + +Figure 2 details the reference architecture required to support interworking between the IM CN subsystem and IP networks for IM services. Figure 3 details the reference architecture required to support interworking between the IMS and IP SIP networks supporting IP version 4. + +![Diagram of IM CN Subsystem to IP network interworking reference Architecture without IP version interworking. It shows a CSCF box on the left connected to a Multimedia IP network (represented by an oval) on the right via two interfaces: Mm (dashed line) and Mb (solid line).](cb8dd5eca74bbf15a81e37c23263c9a8_img.jpg) + +The diagram illustrates the interworking reference architecture. On the left, a rectangular box labeled 'CSCF' is shown. To its right, a dashed horizontal line labeled 'Mm' connects to a large oval on the right labeled 'Multimedia IP network'. Below the 'Mm' interface, a solid horizontal line labeled 'Mb' also connects the 'CSCF' box to the 'Multimedia IP network' oval. + +Diagram of IM CN Subsystem to IP network interworking reference Architecture without IP version interworking. It shows a CSCF box on the left connected to a Multimedia IP network (represented by an oval) on the right via two interfaces: Mm (dashed line) and Mb (solid line). + +NOTE: Multimedia IP networks may be connected via the Mb interface to various network entities, such as an UE (via an GTP Tunnel reaching to the GGSN), an MRFP, or an application server. + +**Figure 2: IM CN Subsystem to IP network interworking Reference Architecture without IP version interworking** + +![Figure 3: Border Control Functions. A network diagram showing the IMS network architecture. On the left, a UE connects to an IP-CAN, which connects to a P-CSCF. The P-CSCF connects to an E-CSCF, which connects to an S-CSCF. The S-CSCF connects to an I-CSCF, which connects to a BGCF. The I-CSCF connects to an IBCF (containing IMS-ALG and THIG). The IBCF connects to a TrGW. The TrGW connects to an 'Other IMS/SIP network'. The IBCF also connects to an MSC server enhanced for ICS or SRVCC. The MSC server connects to the TrGW. The TrGW is part of the 'Border Control Functions'. The diagram also shows DNS and HSS entities. Reference points are labeled: Mm (between CSCF and external network), Mx (between CSCF and IBCF), Mb (between UE and TrGW), and Ix (between IBCF and TrGW).](ff0952ef692c9d960ce5f6708bcc9711_img.jpg) + +Figure 3: Border Control Functions. A network diagram showing the IMS network architecture. On the left, a UE connects to an IP-CAN, which connects to a P-CSCF. The P-CSCF connects to an E-CSCF, which connects to an S-CSCF. The S-CSCF connects to an I-CSCF, which connects to a BGCF. The I-CSCF connects to an IBCF (containing IMS-ALG and THIG). The IBCF connects to a TrGW. The TrGW connects to an 'Other IMS/SIP network'. The IBCF also connects to an MSC server enhanced for ICS or SRVCC. The MSC server connects to the TrGW. The TrGW is part of the 'Border Control Functions'. The diagram also shows DNS and HSS entities. Reference points are labeled: Mm (between CSCF and external network), Mx (between CSCF and IBCF), Mb (between UE and TrGW), and Ix (between IBCF and TrGW). + +Figure 3: Border Control Functions + +**Mm reference point:** The call control protocol applied to the Mm interface between CSCF and external IP networks is SIP, IETF RFC 3261 [2], as detailed in 3GPP TS 24.229 [1]. SIP extension packages mandated by 3GPP are possibly not supported. + +**Mb reference point:** This interface is defined in 3GPP TS 23.002 [5] and is IP based. Further information is provided in 3GPP TS 29.061 [4] and 3GPP TS 26.114 [36]. + +**Mx reference point:** The protocol applied at the Mx reference point is specified in 3GPP TS 24.229 [1]. + +**Ix reference point:** The protocol applied at the Ix reference point is specified in 3GPP TS 29.238 [25]. + +## 6.1 Interworking Functional Entities + +### 6.1.1 IBCF + +This entity provides control plane functionality to connect entities following the 3GPP profile of SIP, 3GPP TS 24.229 [1], and external SIP entities following IETF RFC 3261 [2]. + +### 6.1.2 IMS-ALG + +IMS-ALG functionality resides in IBCF. An IMS-ALG provides the application level translation function for SIP and SDP in order to communicate between IPv6 and IPv4 SIP applications or, based on operator policies between different realms using the same IP version. The IBCF acts as a SIP B2BUA when IBCF performs IMS-ALG functionality. + +### 6.1.3 TrGW + +The TrGW is a NAT-PT/NAPT-PT, which uses a pool of globally unique IPv4 addresses for assignment to IPv6 nodes on a dynamic basis as sessions are initiated across the IP version boundaries. NAT-PT binds addresses in IPv6 network with addresses in IPv4 network and vice versa to provide transparent routing between the two IP domain without requiring any changes to end points. NAPT-PT provides additional translation of transport identifier (TCP, SCTP and UDP port numbers). More detailed information on the NAT-PT/NAPT-PT is given in IETF RFC 2766 [11] and IETF RFC 2663 [12]. + +The TrGW may provide the NAT/NAPT functionality between two disparate address realms. + +### 6.1.4 Acces Transfer Control Function + +The ATCF may reside within the IBCF to support "SRVCC enhanced with ATCF" procedures as described in 3GPP TS 23.237 [41] and 3GPP TS 24.237 [42]. In this case, the Ix reference point is used for IMS sessions that the ATCF decides to anchor at the ATGW to provide the following functions: + +- reservation and configuration of ATGW resources for media anchoring during PS session origination or termination; +- reconfiguration of ATGW resources during access transfer to the CS domain; +- release of ATGW resources upon completion of the access transfer or release of the session; +- media transcoding if the media that was used prior to the access transfer is not supported by the MSC server; +- IP version interworking if different IP versions are used between the access and the remote legs; and +- indication of IP realm during allocation of transport addresses/resources (the PS and CS accesses may be reachable via different IP realms). + +### 6.1.5 Acces Transfer GateWay + +The ATGW may reside within the TrGW to support "SRVCC enhanced with ATCF" procedures as described in 3GPP TS 23.237 [41] and 3GPP TS 24.237 [42]. If the IBCF supports the ATCF functionality (see subclause 6.1.4), the IBCF shall select a TRGW which supports the ATGW functionality. + +# --- 7 Control plane interworking + +## 7.1 SIP with 3GPP Profile to Standard SIP Interworking + +3GPP TS 24.229 [1] defines the procedures, which allow a 3GPP-IMS UE to connect to a standard SIP terminal. + +## 7.2 Additional interworking of protocols associated with services + +There is no impact beyond that specified in subclause 7.1 provided the necessary SIP extensions are supported on both sides of the interworking point. + +Based on operator policy and/or service level agreements the interworking of services may be restricted. + +Additional information related to interworking with services is provided in 3GPP TS 29.165 [40]. + +# --- 8 User Plane Interworking + +## 8.1 Overview + +The present specification addresses user plane interworking between codec types used for either speech or video. Codecs used for conversational services in the PS domain are as defined in 3GPP TS 26.114 [36]. + +## 8.2 Void + +## 8.3 Void + +# --- 9 IMS-ALG and TrGW functionality for NAPT and IP Version Interworking + +## 9.1 Control plane interworking + +### 9.1.1 Session Set-up + +#### 9.1.1.0 General + +The procedure described in subclause 9.1.1 applies both for an SDP offer received from the external network and received from the IMS. + +If different IP versions are used in the external network and the IMS, the TrGW shall provide IP version interworking of the user plane. Otherwise, the TrGW provides NAPT functionality. + +#### 9.1.1.1 Receipt of the first SDP offer + +At the receipt of the first SDP offer from an offering network A the IMS-ALG shall: + +- Request the TrGW to allocate a termination towards an answering network B and provide IP address(es) and port number(s) from its pool for this termination. + +When the IMS-ALG has received the requested information from the TrGW, the IMS-ALG shall include the address(es) and port number(s) in a new offer, and sent this offer toward the network B. The IMS-ALG shall create a SIP message in accordance with the rules for the IMS-ALG described in subclause 9.1.4 with the following clarification: + +- The IP address(es) and port number(s) received from the TrGW for the termination towards network B shall replace the IP address(es) and port number(s) in the SDP. + +#### 9.1.1.2 Receipt of the first SDP answer + +At the receipt of the first SDP answer from network B the IMS-ALG shall: + +- Provide to the TrGW the address(es) and port number(s) as received in the c-line(s) and m-line(s) in the SDP answer as destinations for the termination towards answering network B; +- Request the TrGW to allocate a termination towards the offering network A and provide IP address(es) and port number(s) from its pool for this termination, and provide the IP address and port number received in the first SDP offer from network A as destination for this termination, unless this step has already been executed earlier, e.g. at the receipt of the SDP offer; and +- Requests the TrGW to bind the termination towards network A and the the termination towards network B to enable the routing of user plane traffic towards the IPv4 SIP network through the TrGW. + +NOTE: The binding request will be combined with the request to create terminations in the H.248 protocol + +When the IMS-ALG has received the requested information, the IMS-ALG shall send an SDP answer to the network A. The IMS-ALG shall create the SIP message in accordance with the rules for the IMS-ALG described in subclause 9.1.4 with the following clarification: + +- The IP address(es) and port number(s) received from the TrGW for the termination towards network A shall replace the received IP address(es) and port number(s) in the SDP. + +### 9.1.2 Void + +### 9.1.3 Change of connection information + +After the dialog is established it is possible for both ends of the session to change the connection data for the session. When the IMS-ALG/TrGW receives a SDP offer/answer where port number(s) or IP address(es) is included., there are four different possibilities: + +- 1) IP address(es) or/and port number(s) have been added. In this case additional binding(s) shall be provided by the IMS-ALG/TrGW as detailed for the first SDP offer in the subclauses above; +- 2) IP address(es) or/and port number(s) have been deleted. In this case binding(s) shall be made free by the IMS-ALG/TrGW; +- 3) IP address(es) and port number(s) have been reassigned of the users. In this case the binding(s) shall reflect the reassignment; and +- 4) No change has been made to the IP address(es) and port number(s). In this case no change shall be made to the existing binding(s). + +### 9.1.4 Interworking of SIP messages + +The IMS-ALG behaves as a SIP B2BUA when interworking SIP messages. The IMS-ALG shall forward all SIP messages transparently with respect to all methods, result codes, headers and attachments except as follows: + +- The IMS-ALG modifies SDP according to subclause 9.1.1, subclause 9.1.3, subclause 9.1.5 and clause 10. + +NOTE: SDP not described in subclause 9.1.1, subclause 9.1.3 or clause 10 can be handled according to 3GPP TS 24.229 [1] clause A.3. + +- When forwarding an incoming SIP request, the IMS-ALG should perform UAC procedures towards the intended target according to IETF RFC 3261 [2], by modifying those headers necessary to ensure that all transactions within the dialog pass through the IMS-ALG. +- When forwarding an incoming SIP response, the IMS-ALG should perform UAS procedures towards the originator of the corresponding request according to IETF RFC 3261 [2], by modifying those headers necessary to ensure that all transactions within the dialog pass through the IMS-ALG. +- The IMS-ALG may perform any appropriate error recovery procedures in the event that an incoming message contains errors inconsistent with the forwarding procedures above. +- The IBCF can perform screening of SIP request and SIP responses based on local policy as described in subclause 5.10.6 of 3GPP TS 24.229 [1]. + +At the receipt of a SIP BYE request, SIP CANCEL request or non-200 SIP final response, the IMS-ALG shall release the session and request the TrGW to release the bindings established for the session. + +### 9.1.5 Modification of SDP bandwidth information for IP version interworking + +When the IMS ALG performs IP version interworking and passes an SDP offer or answer, it should adjust any SDP b=AS bandwidth modifiers contained in the SDP. + +NOTE 1: 3GPP TS 26.114 [36] annex K and annex Q contain information about bandwidths for speech media transported over IPv4 and IPv6. 3GPP TS 26.114 [36] subclause 12.7.5 contains information how to convert b=AS for video media. + +NOTE 2: If the b=AS bandwidth modifiers are not adjusted, this can negatively impact the end-to-end media negotiation (e.g. the selection of a speech codec mode) and lead to an inaccurate resource reservation. + +The IMS-ALG may support the enhanced bandwidth negotiation mechanism defined in 3GPP TS 26.114 [36]. The enhanced bandwidth negotiation mechanism is based on the "a=bw-info" SDP attribute (defined in clause 19 of 3GPP TS 26.114 [36]) to negotiate the additional bandwidth properties end-to-end. + +If the IMS-ALG receives an SDP body containing the "a=bw-info" SDP attribute(s) and if: + +- the IMS-AGW interconnects call legs in IP domains where different IP versions (IPv4 or IPv6) are used; and +- the received "a=bw-info" SDP attribute lines related to the same payload type and the same direction do not contain bandwidth properties for both IPv4 and IPv6; + +the IMS-ALG shall, before forwarding the SDP body: + +- re-calculate the received bandwidth properties (the maximum supported bandwidth, the maximum desired bandwidth, the minimum desired bandwidth and the minimum supported bandwidth for sending and/or receiving direction); +- include in the modified "a=bw-info" SDP attribute lines the IP version used for the re-calculation of the bandwidth properties; + +NOTE 3: If no IP version is included for any of the "a=bw-info" SDP attribute lines related to a certain payload type and direction then IPv6 is assumed for all bandwidth properties related to the same direction and payload type, on all of the related "a=bw-info" SDP attribute lines, see clause 19 of 3GPP TS 26.114 [36]. + +- include the maximum packet rate assumed when re-calculating the maximum supported bandwidth, the maximum desired bandwidth and the minimum desired bandwidth properties; and +- include the minimum packet rate assumed when re-calculating the minimum supported bandwidth. + +Otherwise, if the received SDP body contains bandwidth properties for both IPv4 and IPv6 and if the IMS-ALG does not support or does not apply the transcoding procedure defined in subclause 10.2.5, the IMS-ALG shall forward the SDP body with unmodified "a=bw-info" SDP attribute lines. + +## 9.2 User plane transport + +### 9.2.1 Payload transport + +The TrGW shall use the established bindings described in subclause 9.1 to transport the messages between the network A and the network B in the following way. + +At the receipt of a payload message the TrGW shall: + +- replace the received destination IP address(es) and port number(s) in the payload message with the corresponding IP address(es) and port number(s) that have been signalled by the IBCF; and +- replace the received source IP address(es) and port number(s) in the payload message with the corresponding IP address(es) and port number(s) the TrGW allocated at its own terminations. + +### 9.2.2 IP header interworking + +#### 9.2.2.1 IPv4 to IPv6 + +When the TrGW receives an IPv4 message the following codings shall be set in the IPv6 headers of the message sent to the IPv6 network. + +- If the DF bit is set and the packet is not a fragment (i.e., the MF flag is not set and the Fragment Offset is zero) The IPv6 headers shall be set as described in table 1; +- If the DF bit is not set or the packet is a fragment the IPv6 headers shall be set as described in table 2. + +**Table 1: Derivation of IPv6 Header from IPv4 header (no fragmentation)** + +| IPv6 field | Value | +|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Version | 6 | +| Traffic Class: | The default behaviour is that the value of the IPv6 field Traffic Class field is the value of the IPv4 Type Of Service field (all 8 bits are copied). An implementation of a TrGW should also provide the ability to ignore the value of the IPv4 Type of Service and always set the IPv6 traffic class field to zero. | +| Flow label | The IPv6 Flow Label Field is set to 0 (all zero bits). | +| Payload Length | The IPv6 Payload Length field value is the IPv4 Total length field value minus the size of the IPv4 header and IPv4 options field length, if present. | +| Next Header | The IPv6 Next Header value is copied from IPv4 Protocol field | +| HopLimit: | The IPv6 Hop Limit value is The value of IPv4 field Time To Live minus 1. | +| Source Address | Shall be handled as the addresses of the payload message as described in subclause 9.2.1. | +| Destination Address | Shall be handled as the addresses of the payload message as described in subclause 9.2.1. | + +**Table 2: Derivation of IPv6 Header from IPv4 Header (fragmentation)** + +| IPv6 field | Value | +|--------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Version | 6 | +| Traffic Class: | The default behaviour is that the value of the IPv6 field Traffic Class field is the value of the IPv4 Type Of Service field (all 8 bits are copied). An implementation of a TrGW should also provide the ability to ignore the value of the IPv4 Type of Service and always set the IPv6 traffic class field to zero. | +| Flow label | The IPv6 Flow Label Field is set to 0 (all zero bits). | +| Payload Length | The IPv6 Payload Length field value is the IPv4 Total length field value plus 8 for the fragment header minus the size of the IPv4 header and IPv4 options field length, if present. | +| Next Header | The IPv6 Next header field is set to Fragment header (44). | +| Hop Limit: | The IPv6 Hop Limit value is The value of IPv4 field Time To Live minus 1. | +| Source Address | Shall be handled as the addresses of the payload message as described in subclause 9.2.1. | +| Destination Address | Shall be handled as the addresses of the payload message as described in subclause 9.2.1. | +| Fragments headers
a) next header
b) fragment Offset
c) More fragment bit
d) Identification | Copied from IPv4 Protocol field.
Copied from the IPv4 Fragment offset field.
Copied from the value of the more fragment bit in the IPv4 flags field.
The value of this field should be mapped from the triple of the source address, destination address and IPv4 identification field of the incoming packet/fragments to a unique value for the source and destination address of the outgoing IPv6 packet/fragments. | + +#### 9.2.2.2 Abnormal cases + +If IPv4 options are present in the IPv4 packet, they should be ignored i.e., there is no attempt to translate them. However, if an unexpired source route option is present then the packet shall instead be discarded, and an ICMPv4 "destination unreachable/source route failed" Type 3/Code 5 error message shall be returned to the sender as defined in IETF RFC 792 [18]. + +When a translator receives the first fragment of a fragmented UDP IPv4 packet and the checksum field is zero the translator should drop the packet and generate a system management event specifying at least the IP addresses and port numbers in the packet. When the translator receives fragments other than the first it should silently drop the packet since there is no port information to log. + +When a translator receives an unfragmented UDP IPv4 packet and the checksum field is zero the translator shall compute the missing UDP checksum as part of translating the packet. Also, the translator should maintain a counter of how many UDP checksums are generated in this manner. + +#### 9.2.2.3 IPv6 to IPv4 + +When the TrGW receives an IPv6 message the following codings shall be set in the IPv4 headers of the message sent to the IPv4 network. + +- If there is no IPv6 fragment header, the IPv4 header fields shall be set as described in Table 3; +- if there is an IPv6 fragment header, the IPv4 header fields shall be set as described in Table 4. + +**Table 3: Derivation of IPv4 Header from IPv6 Header (no fragmentation)** + +| IPv4 field | Value | +|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Version | 4 | +| Internet header length | 5 (No IPv4 options) | +| Type of Service | The default behaviour is that the value of the IPv4 field Type of service field is the value of the IPv6 Traffic class field (all 8 bits are copied). An implementation of a TrGW should also provide the ability to ignore the value of the IPv6 Traffic Class and always set the IPv4 Type of Service field to zero. | +| Total length | The IPv4 Total Length field value is the IPv6 Payload length value plus the size of the IPv4 headers. | +| Identification | All bits are set to zero. | +| Flags | The more fragment flag is set to zero. The Don't fragment flag is set to one. | +| Fragment offset | Set to zero. | +| Time to live (TTL) | The value of the field shall be set to the received IPv6 Hop Limit field value minus 1. | +| Protocol | The IPv4 field Protocol shall be set to the value of IPv6 field The next header value. | +| Header checksum | Computed once the IPv4 header has been created. | +| Source Address | Shall be handled as the addresses of the payload message as described in subclause 9.2.1. | +| Destination Address | Shall be handled as the addresses of the payload message as described in subclause 9.2.1. | + +**Table 4: Derivation of IPv4 Header from IPv6 Header (fragmentation)** + +| IPv4 field | Value | +|---------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Version | 4 | +| Internet header length | 5 (No IPv4 options) | +| Type of Service and Precedence: | The default behaviour is that the value of the IPv4 field Type of service field is the value of the IPv6 Traffic class field (all 8 bits are copied). An implementation of a TrGW should also provide the ability to ignore the value of the IPv6 Traffic Class and always set the IPv4 Type of Service field to zero. | +| Total length | The IPv4 Total Length field value is the IPv6 Payload length value plus the size of the IPv4 headers minus 8 for the Fragment header. | +| Identification | The value of this field should be mapped from the triple of the source address, destination address and IPv6 fragmentation header field "identification" of the incoming packet/fragments to a unique value for the source and destination address of the outgoing IPv4 packet/fragments. | +| Flags | The IPv4 More Fragments flag is copied from the IPv6 M flag in the IPv6 Fragment header the IPv4. The Don't Fragments flag is set to zero allowing this packet to be fragmented by IPv4 routers. | +| Time to live (TTL) | The value of the field shall be set to the received IPv6 Hop Limit field value minus 1. | +| Protocol | The IPv4 field Protocol shall be set to the value of IPv6 field The next header value. | +| Header checksum | Computed once the IPv4 header has been created. | +| Source Address | Shall be handled as the addresses of the payload message as described in subclause 9.2.1. | +| Destination Address | Shall be handled as the addresses of the payload message as described in subclause 9.2.1. | + +#### 9.2.2.4 Abnormal cases + +If any of an IPv6 hop-by-hop options header, destination options header, or routing header with the Segments Left field equal to zero are present in the IPv6 packet, they are ignored i.e., there is no attempt to translate them. However, the Total Length field and the Protocol field shall be adjusted to "skip" these extension headers. + +If a routing header with a non-zero Segments Left field is present then the packet shall be translated, and an ICMPv6 "parameter problem/ erroneous header field encountered" Type 4/Code 0 error message as defined in IETF RFC 2463 [19], with the Pointer field indicating the first byte of the Segments Left field should be returned to the sender. + +### 9.2.3 Fragmentation + +If the DF flag is not set and the IPv4 packet will result in an IPv6 packet larger than 1280 bytes the TrGW shall prior to transferring it in the IPv6 network: + +- Add the fragment header to the message; and + +- fragment the IPv4 packets so that their length, excluding the IPv4 header, is at most 1232 bytes (1280 minus 40 for the IPv6 header and 8 for the Fragment header). + +### 9.2.4 Abnormal cases + +As a part of decrementing the Time To Live /Hop Limit value and the TrGW discovers that the zero value is reached the TrGW shall send an ICMPv4/ICMPv6 message with the error "time to live exceeded in transit" type 11 code 0 as defined in IETF RFC 792 [18] and "hop limit exceeded in transit" type 3 code 0 as defined in IETF RFC 2463 [19]. + +# 10 IBCF – TrGW Interactions + +## 10.1 Overview + +### 10.1.1 General + +The present specification describes Ix signalling procedures and their interaction with SIP signalling in the control plane, and with user plane procedures. Each scenario or "use case" is described in a separate subclause within subclause 10.2. 3GPP TS 29.238 [25] maps these signalling procedures to H.248 messages and defines the required H.248 profile (which provides details of used packages and parameters). + +### 10.1.2 Network model + +Figure 10.1.2.1 shows the network model. The broken line represents the call control signalling. The dotted line represents the user plane. The IBCF uses one context with two terminations in the TrGW. + +![Figure 10.1.2.1: Network model diagram showing IBCF and TrGW components and their connections.](421fc75480c21e7ebb25756826652367_img.jpg) + +The diagram illustrates the network model. At the top, a box labeled 'IBCF' has two internal connection points. A horizontal green dashed line (representing call control signalling) passes through the IBCF. Below the IBCF, a solid blue vertical line connects it to a second box labeled 'TrGW'. The TrGW box contains two internal connection points labeled 'T1' and 'T2', with a switch-like symbol between them. A horizontal red dotted line (representing the user plane) passes through the TrGW, connecting to T1 and T2. + +Figure 10.1.2.1: Network model diagram showing IBCF and TrGW components and their connections. + +Figure 10.1.2.1: Network model + +### 10.1.3 Example Call Flow + +#### 10.1.3.1 Basic Procedures + +##### 10.1.3.1.1 Call Establishment + +Figure 10.1.3.1.1.1 depicts the signalling flow for a call setup either from or toward an external network. + +![Sequence diagram showing the interaction between TrGW and IBCF for TrGW functionality detection and resource reservation. The diagram includes 16 steps: 1. IBCF receives SDP offer; 2. Use case X detected; 3. IBCF sends H.248 ADD req to TrGW; 4. TrGW creates outgoing termination T1; 5. TrGW sends H.248 ADD resp; 6. IBCF modifies SDP offer; 7. IBCF sends SDP offer to network; 8. IBCF receives SDP answer; 9. IBCF sends H.248 MOD req to TrGW; 10. TrGW configures outgoing termination T1; 11. TrGW sends H.248 MOD Resp; 12. IBCF sends H.248 ADD req for incoming termination; 13. TrGW creates incoming termination T2; 14. TrGW sends H.248 ADD Resp; 15. IBCF modifies SDP answer; 16. IBCF sends SDP answer to network. Brackets on the right indicate phases for 'Reserve TrGW Connection Point', 'Configure TrGW Connection Point', and 'Reserve And Configure TrGW Connection Point'.](eb03559a4d92ea9ebd63ea9be663c50a_img.jpg) + +``` + +sequenceDiagram + participant IBCF + participant TrGW + Note right of IBCF: 1. SDP offer (IP2o, P2o) + IBCF->>IBCF: 2. Use case X detected that needs TrGW functionality + IBCF->>TrGW: 3. H.248 ADD req (C= ?, T= ?, LAddr=?, LPort=?) + Note right of TrGW: 4. Create outgoing termination T1 + TrGW->>IBCF: 5. H.248 ADD resp. (C=C1, T=T1, LAddr=IP1o, LPort=P1o) + Note right of IBCF: 6. Modify SDP offer + IBCF->>Network: 7. SDP offer (IP1o, P1o) + Network-->>IBCF: 8. SDP answer (IP1a, P1a) + IBCF->>TrGW: 9. H.248 MOD req (C= C1, T= T1, RAddr=IP1a, RPort=P1a) + Note right of TrGW: 10. Configure Outgoing Termination T1 + TrGW->>IBCF: 11. H.248 MOD Resp (C= C1, T= T1) + IBCF->>TrGW: 12. H.248 ADD req (C= C1, T= ?, LAddr=?, LPort=?, RAddr=IP2o, RPort=P2o) + Note right of TrGW: 13. Create incoming Termination T2 + TrGW->>IBCF: 14. H.248 ADD Resp (C= C1, T= T2, LAddr=IP2a, LPort=P2a, RAddr=IP1a, RPort=P1a) + Note right of IBCF: 15. Modify SDP answer + IBCF->>Network: 16. SDP answer(IP2a, P2a) + +``` + +Reserve TrGW Connection Point (, Change Through-Connection) + +Configure TrGW Connection Point (, Change Through-Connection) + +Reserve And Configure TrGW Connection Point (, Change Through-Connection) + +Sequence diagram showing the interaction between TrGW and IBCF for TrGW functionality detection and resource reservation. The diagram includes 16 steps: 1. IBCF receives SDP offer; 2. Use case X detected; 3. IBCF sends H.248 ADD req to TrGW; 4. TrGW creates outgoing termination T1; 5. TrGW sends H.248 ADD resp; 6. IBCF modifies SDP offer; 7. IBCF sends SDP offer to network; 8. IBCF receives SDP answer; 9. IBCF sends H.248 MOD req to TrGW; 10. TrGW configures outgoing termination T1; 11. TrGW sends H.248 MOD Resp; 12. IBCF sends H.248 ADD req for incoming termination; 13. TrGW creates incoming termination T2; 14. TrGW sends H.248 ADD Resp; 15. IBCF modifies SDP answer; 16. IBCF sends SDP answer to network. Brackets on the right indicate phases for 'Reserve TrGW Connection Point', 'Configure TrGW Connection Point', and 'Reserve And Configure TrGW Connection Point'. + +1. The IBCF receives an SDP offer in SIP signalling. +2. The IBCF detects that one of the CS-TrGW functions is required, e.g. NAPT/NAT. +3. The IBCF sends a H.248 ADD command to create the outgoing termination and to request resources to execute TrGW function. +4. The TrGW creates the outgoing termination. +5. The TrGW replies to IBCF with a H.248 Add reply command and provides the local address and port of the outgoing termination. +6. The IBCF replaces the IP address inside the SDP using the information coming from TrGW. +7. SDP offer is sent to the network at the outgoing side. +8. SDP answer is received by IBCF. + +9. The IBCF sends a H.248 MOD command to configure the outgoing termination with address and port information received in the SDP answer. + 10. The TrGW configures the outgoing termination. + 11. The TrGW replies to IBCF with a H.248 MOD reply command. + 12. The IBCF sends a H.248 ADD command to create the incoming termination and to request resources to execute TrGW function. + 13. The TrGW creates the incoming termination. + 14. The TrGW replies to the IBCF with a H.248 Add reply command and provides the local address and port of the incoming termination. +- NOTE 1: Steps 12 to 14 may also be executed after step 2. +15. The IBCF replaces the IP address inside the SDP using the information coming from TrGW. + 16. SDP answer is sent to the network at the incoming side. + +###### **Figure 10.1.3.1.1.1: IBCF and TrGW interaction at Call establishment.** + +When creating the termination towards the IMS network or towards external networks, the IBCF may also indicate that the IP Interface Type is "MboIP". + +NOTE : Other values may be indicated by a CS-IBCF, as detailed in 3GPP TS 29.235 [29]. + +The IP Interface Type allows the TrGW to collect statistics per interface type associated with the RTP bearer termination. The provision of these statistics is outside of the scope of this specification. + +##### 10.1.3.1.2 Call Release + +Figure 10.1.3.1.2.1 depicts the signalling flow for a call release. + +![Sequence diagram showing the interaction between TrGW and IBCF for call release. The process starts with an event causing release at the IBCF. The IBCF sends an H.248 SUB request (C=C1, T=T1) to the TrGW. The TrGW destroys the outgoing termination T1 and responds with an H.248 SUB response (C=C1, T=T1). Next, the IBCF sends an H.248 SUB request (C=C1, T=T2) to the TrGW. The TrGW destroys the incoming termination T2 and responds with an H.248 SUB response (C=C1, T=T2). Brackets on the right indicate that steps 2-4 are 'Release TrGW Termination' and steps 5-7 are 'Release TrGW Termination'.](a0739aaf13fa5a632d4faa830f6b2708_img.jpg) + +``` + +sequenceDiagram + participant IBCF + participant TrGW + Note right of IBCF: 1. Event causing release + IBCF->>TrGW: 2. H.248 SUB req (C=C1, T=T1) + Note left of TrGW: 3. Destroy outgoing termination T1 + TrGW-->>IBCF: 4. H.248 SUB resp. (C=C1, T=T1) + IBCF->>TrGW: 5. H.248 SUB req (C=C1, T=T2) + Note left of TrGW: 6. Destroy incoming termination T2 + TrGW-->>IBCF: 7. H.248 SUB resp. (C=C1, T=T2) + +``` + +Sequence diagram showing the interaction between TrGW and IBCF for call release. The process starts with an event causing release at the IBCF. The IBCF sends an H.248 SUB request (C=C1, T=T1) to the TrGW. The TrGW destroys the outgoing termination T1 and responds with an H.248 SUB response (C=C1, T=T1). Next, the IBCF sends an H.248 SUB request (C=C1, T=T2) to the TrGW. The TrGW destroys the incoming termination T2 and responds with an H.248 SUB response (C=C1, T=T2). Brackets on the right indicate that steps 2-4 are 'Release TrGW Termination' and steps 5-7 are 'Release TrGW Termination'. + +1. The IBCF identifies that the call is to be release. Typically this will be by the receipt of a SIP BYE request. +2. The IBCF sends a H.248 SUB command to release the outgoing termination. +3. The TrGW destroys the outgoing termination. +4. The TrGW replies to IBCF with a H.248 SUB reply command. +5. The IBCF sends a H.248 SUB command to release the incoming termination. +6. The TrGW destroys the incoming termination. +7. The TrGW replies to IBCF with a H.248 SUB reply command. + +NOTE 1: Steps 5 to 7 may also be executed before steps 2 to 4 or in parallel with steps 2 to 4. + +NOTE 2: Rather than releasing the two terminations separately, the IBCF may request the TrGW to release both terminations in a single request. + +**Figure 10.1.3.1.2.1: IBCF and TrGW interaction at Call release** + +## 10.2 Main Functions supported at the Ix Interface + +## 10.2.0 Introduction + +The following functions shall be supported by the TrGW: + +- Gate Management including: + - Opening/closing of gates; + - Remote source address filtering; and + - Remote source port filtering; + +- QoS packet marking (differentiated services); +- NAPT and IP Version Interworking; +- Bandwidth policing; +- Hanging termination detection; +- IP Realm Indication; +- Media Control; and +- Through-Connection. + +Additionally, the following functions may be supported by the TrGW: + +- Resource allocation per flow; +- Media Inactivity Detection; +- IP Realm Availability; +- Optimal Media Routeing; +- Explicit Congestion Notification support; +- Emergency Call; +- IMS end-to-end media plane security; +- Access Transfer procedures with media anchored in ATGW; +- Multimedia Priority Service; +- RTP Header extension to signal Coordination of Video Orientation; + - Generic image attribute; +- Interactive Connectivity Establishment; +- Video Region of Interest (ROI) ; +- RTP-level pause and resume functionality ; and +- "RTCP Codec Control Commands and Indications" + +### 10.2.1 NAPT and IP version interworking + +NAPT and IP version interworking is documented in clause 9. + +The IP Address and port conversion is configured by the standard Ix interactions at call setup depicted in figure 10.1.3.1.1.1. + +IP address and port conversion is mandatory every time a TrGW is inserted into the path for any reason to guarantee that all IP packets are routed through this entity. + +### 10.2.2 Gate Management + +The procedures in subclause A.7.1.2.2.3 of 3GPP TS 29.235 [29] are applicable. + +### 10.2.3 RTCP Handling + +The procedures in subclause A.7.1.2.2.7 of 3GPP TS 29.235 [29] are applicable. + +### 10.2.4 IP Realm Indication + +Whenever requesting a new IP media-path (i.e. creation of IP bearer terminations), the TrGW may indicate the correspondent IP realm/domain to the TrGW. The TrGW shall assign the IP termination in the IP realm indicated. The same IP realm shall be applied to all media streams associated with the termination. The IP realm identifier shall not be changed after the initial assignment. + +A default IP realm may be configured such that if the TrGW has not received the IP realm identifier and the TrGW supports multiple IP realms then the default IP realm shall be used. + +### 10.2.5 Media Control + +#### 10.2.5.1 General + +The transcoding functionality, where the TrGW processes and possibly converts application / media data (like e.g. RTP payload) is optional for the TrGW and IBCF to support. + +The IBCF shall determine the TrGW transcoding capability through provisioning and MGW selection, outside the scope of this specification. + +IBCF procedures to offer transcoding in SIP/SDP signalling are described in 3GPP TS 23.228 [8] and in 3GPP TS 24.229 [1]. The IBCF shall only apply those transcoding procedures if an attached TrGW supports transcoding. For media with "RTP/SAVP" (see IETF RFC 3711 [34]) or "RTP/SAVPF" (see IETF RFC 5124 [35]) as transport protocol, the IBCF shall not offer or apply transcoding. + +If the IBCF and available TrGW support transcoding, the IBCF may add codecs to a SDP offer within a SIP request. + +If the IBCF and available TrGW do not support transcoding, or if the IBCF chooses not to offer transcoding, the IBCF shall pass SDP offers without adding codecs to the SDP offer and the IBCF shall pass SDP answers without modification to the contained codecs. + +If the IBCF does not offer or apply transcoding procedures (as described above) but inserts the TrGW for any other reason, the IBCF shall either not signal media related information to the TrGW, or it shall signal the same media related information for all interconnected terminations (i.e. identical media configurations for the two connected H.248 stream endpoints). + +If the IBCF does not offer or apply transcoding but signals media attributes to a TrGW that does not support transcoding without having seized the peer termination (see figure 10.2.5.3, Step 3) the TrGW shall accept this request even though it cannot reserve any transcoding resources related to this media. When the peer termination is seized and configured it shall be configured with the same media related sub-fields in the media descriptor as for the first termination. If the selected codec is not the same as the codec configured at the first termination then this termination shall be modified before the peer termination is seized. + +NOTE 1: The signalling of such codec related information by an IBCF to a TrGW not supporting transcoding is an implementation decision. + +NOTE 2: A TrGW not supporting transcoding can use such codec related information to learn that RTCP ports need to be reserved, and to derive information about packet size and frequency useful for internal resource reservation. + +If the IBCF and available TrGW support transcoding and the IBCF includes in a SDP offer additional codecs, the following procedures apply: + +- The IBCF may seize a termination towards the terminating user, using the "Reserve TrGW Connection Point" procedure before sending an SDP offer with added codecs to the terminating user. The IBCF may signal media related information to the TrGW or omit media when adding the IP termination at this stage. + +NOTE 3: The signalling of media related information to a MGW requires that it reserve the indicated resources before returning a positive response to the H.248 command, by omitting media related information the TrGW does not need to reserve any associated resources at this stage. + +- When the IBCF receives the SDP answer from the terminating user, the IBCF shall check if any of the codecs offered by the originating side are contained in the answer. + +- If only the codecs inserted by the IBCF are contained in the answer, the IBCF shall configure the TrGW to transcode. If it previously performed a "Reserve TrGW Connection Point" procedure it shall configure the TrGW using the "Configure TrGW Connection Point" procedure towards the termination on the terminating user side by supplying the media returned in the answer from the terminating user, otherwise it shall perform a "Reserve and Configure TrGW Connection Point" procedure. Within those procedures, the IBCF shall supply the media returned in the answer from the terminating user. If the IBCF seized the termination only at this point in time, it shall send the IP address and port information received from the TrGW in the acknowledgment to the "Reserve and Configure TrGW Connection Point" procedure towards the terminating user in a new SDP offer. The IBCF shall perform the "Reserve and Configure TrGW Connection Point" procedure towards the termination on the originating user side, supplying the preferred media offered by the originating side. +- If the returned SDP contains media offered by the originating user no transcoding at the TrGW is required. If the IBCF previously performed the "Reserve TrGW Connection Point" procedure the IBCF shall configure the TrGW accordingly by either either supplying the same media related information for all interconnected terminations or by omitting the media related information. + +Some basic use cases are depicted in figures 10.2.5.1, 10.2.5.2, and 10.2.5.3. + +![Sequence diagram showing the interaction between TrGW and IBCF for media resource reservation and configuration.](28d75f39a24203712ee907b32cf0bbe5_img.jpg) + +``` + +sequenceDiagram + participant IBCF + participant TrGW + + Note right of IBCF: 1. SDP offer (IP2o, P2o, codec1, codec2) + Note right of IBCF: 2. IBCF supports transcoding and supports additional codecs, the IBCF inserts additional codecs in the SDP offer + IBCF->>TrGW: 3. H.248 ADD req (C= ?, T= ?, LAddr=?, LPort=?, Local Resources="-" or codec1 or codec 2 or codec3) + Note right of TrGW: Reserve TrGW Connection Point + TrGW->>TrGW: 4. Create outgoing termination T1 + TrGW->>IBCF: 5. H.248 ADD resp. (C=C1, T=T1, LAddr=IP1o, LPort=P1o) + Note right of IBCF: 6. Modify SDP offer + IBCF->>TrGW: SDP offer (IP1o, P1o, codec 1, codec2, codec3) + TrGW->>IBCF: 8. SDP answer (IP1a, P1a, codec 1) + Note right of IBCF: Configure TrGW Connection Point + IBCF->>TrGW: 9. H.248 MOD req (C= C1, T= T1, RAddr=IP1a, RPort=P1a, Local Resources="-" or codec1, Remote Resources="-" or codec1) + TrGW->>TrGW: 10. Configure Outgoing Termination T1 + TrGW->>IBCF: 11. H.248 MOD Resp (C= C1, T= T1) + Note right of IBCF: Reserve And Configure TrGW Connection Point + IBCF->>TrGW: 12. H.248 ADD req (C= C1, T= ?, LAddr=?, LPort=?, RAddr=IP2o, RPort=P2o, Local Resources="-" or codec1, Remote Resources="-" or codec1) + TrGW->>TrGW: 13. Create incoming Termination T2 + TrGW->>IBCF: 14. H.248 ADD Resp (C= C1, T= T2, LAddr=IP2a, LPort=P2a, RAddr=IP2o, RPort=P2o) + Note right of IBCF: 15. Modify SDP answer + IBCF->>TrGW: 16. SDP answer(IP2a, P2a, codec 1) + +``` + +Sequence diagram showing the interaction between TrGW and IBCF for media resource reservation and configuration. + +1. The IBCF receives an SDP offer in SIP signalling. +2. The IBCF adds additional codecs to the subsequent SDP offer, giving priority to those offered by the preceding node/network. +3. In this example the IBCF seizes a TrGW prior to sending the new SDP offer; as this scenario is preparing for a possible transcoding in the TrGW then a TrGW supporting media shall be seized. The IBCF sends a H.248 ADD request command to create the outgoing termination and to request IP resources to execute TrGW function. As no media transcoding is yet known to be needed this may be indicated by omitting media related sub-fields in the media descriptor (i.e. signalling "-"). Alternatively the preferred codec (e.g. codec 1) may be signalled in order to reserve this resource in the event that transcoding was required. +4. The TrGW creates the outgoing termination. + +5. The TrGW replies to IBCF with a H.248 ADD reply command and provides the local address and port of the outgoing termination. +6. The IBCF replaces the IP address inside the SDP offer using the information coming from TrGW +7. The IBCF forwards the new SDP offer to the succeeding node. +8. The SDP answer is received by IBCF. In this example the codec1 received in the original SDP offer in step1 has been selected by the succeeding network/terminating UE and the IBCF determines that transcoding is not required. +9. The IBCF sends a H.248 MOD request command to configure the outgoing termination with address and port information received in the SDP answer. As no media transcoding is needed this may be indicated by omitting media related sub-fields in the media descriptor (i.e. signalling "-"). Alternatively the selected codec (codec 1) may be signalled. +10. The TrGW configures the outgoing termination. +11. The TrGW replies to IBCF with a H.248 MOD reply command. +12. The IBCF sends a H.248 ADD request command to create the incoming termination to configure this termination with remote address and port information and to request resources to execute TrGW function. As no media transcoding is needed this may be indicated by omitting media related sub-fields in the media descriptor (i.e. signalling "-"). Alternatively the selected codec received in step 8 (Codec 1) may be signalled. +13. The TrGW creates the incoming termination. +14. The TrGW replies to the IBCF with a H.248 ADD reply command and provides the local address and port of the incoming termination. +15. The IBCF replaces the IP address inside the SDP using the information coming from TrGW. +16. The SDP answer is sent to the network at the incoming side. + +**Figure 10.2.5.1: IBCF and TrGW interaction when the IBCF offers additional codecs but no transcoding is required, and the TrGW is seized in advance.** + +![Sequence diagram showing the interaction between TrGW and IBCF for media resource reservation and configuration. The diagram consists of 16 steps. 1. IBCF receives an SDP offer from an external source. 2. IBCF adds supported codecs to the offer. 3. IBCF sends an H.248 ADD request to TrGW to reserve resources and create an outgoing termination T1. 4. TrGW creates the outgoing termination. 5. TrGW sends an H.248 ADD response. 6. IBCF modifies the SDP offer. 7. IBCF sends the modified SDP offer to the external source. 8. External source sends an SDP answer. 9. IBCF sends an H.248 MOD request to TrGW to configure the outgoing termination. 10. TrGW configures the outgoing termination. 11. TrGW sends an H.248 MOD response. 12. IBCF sends an H.248 ADD request to TrGW to reserve and configure an incoming termination T2. 13. TrGW creates the incoming termination. 14. TrGW sends an H.248 ADD response. 15. IBCF modifies the SDP answer. 16. IBCF sends the final SDP answer to the external source. Brackets on the right indicate phases: 'Reserve TrGW Connection Point' (steps 3-5), 'Configure TrGW Connection Point' (steps 9-11), and 'Reserve And Configure TrGW Connection Point' (steps 12-14).](00504fc688ebcf131ccbeff94dfc9939_img.jpg) + +``` + +sequenceDiagram + participant External + participant IBCF + participant TrGW + + External-->>IBCF: 1. SDP offer (IP2o, P2o, codec1, codec2) + Note over IBCF: 2. IBCF supports transcoding +and supports additional +codecs + Note right of IBCF: Reserve TrGW Connection Point + IBCF->>TrGW: 3. H.248 ADD req +(C= ?, T= ?, LAddr=?, LPort=?, +Local Resources="-" or codec1 or codec 2 or codec 3) + Note left of TrGW: 4. Create outgoing termination T1 + TrGW-->>IBCF: 5. H.248 ADD resp. +(C=C1, T=T1, +LAddr=IP1o, LPort=P1o) + Note over IBCF: 6. Modify SDP offer + IBCF->>External: 7. SDP offer (IP1o, P1o, codec 1, codec 2, codec 3) + External-->>IBCF: 8. SDP answer (IP1a, P1a, codec 3) + Note right of IBCF: Configure TrGW Connection Point + IBCF->>TrGW: 9. H.248 MOD req +(C= C1, T= T1, +RAddr=IP1a, RPort=P1a, +Local Resources= codec3 +Remote Resources= codec3) + Note left of TrGW: 10. Configure Outgoing Termination T1 + TrGW-->>IBCF: 11. H.248 MOD Resp +(C= C1, T= T1) + Note right of IBCF: Reserve And Configure TrGW Connection Point + IBCF->>TrGW: 12. H.248 ADD req +(C= C1, T= ?, LAddr=?, LPort=?, +RAddr=IP2o, RPort=P2o, +Local Resources=codec1 or codec2, +Remote Resources=codec1 or codec2) + Note left of TrGW: 13. Create incoming Termination T2 + TrGW-->>IBCF: 14. H.248 ADD Resp +(C= C1, T= T2, +LAddr=IP2a, LPort=P2a, +RAddr=IP2o, RPort=P2o) + Note over IBCF: 15. Modify SDP answer + IBCF->>External: 16. SDP answer(Ip2a, P2a, +codec1 or codec2) + +``` + +Sequence diagram showing the interaction between TrGW and IBCF for media resource reservation and configuration. The diagram consists of 16 steps. 1. IBCF receives an SDP offer from an external source. 2. IBCF adds supported codecs to the offer. 3. IBCF sends an H.248 ADD request to TrGW to reserve resources and create an outgoing termination T1. 4. TrGW creates the outgoing termination. 5. TrGW sends an H.248 ADD response. 6. IBCF modifies the SDP offer. 7. IBCF sends the modified SDP offer to the external source. 8. External source sends an SDP answer. 9. IBCF sends an H.248 MOD request to TrGW to configure the outgoing termination. 10. TrGW configures the outgoing termination. 11. TrGW sends an H.248 MOD response. 12. IBCF sends an H.248 ADD request to TrGW to reserve and configure an incoming termination T2. 13. TrGW creates the incoming termination. 14. TrGW sends an H.248 ADD response. 15. IBCF modifies the SDP answer. 16. IBCF sends the final SDP answer to the external source. Brackets on the right indicate phases: 'Reserve TrGW Connection Point' (steps 3-5), 'Configure TrGW Connection Point' (steps 9-11), and 'Reserve And Configure TrGW Connection Point' (steps 12-14). + +1. The IBCF receives an SDP offer in SIP signalling. +2. The IBCF adds additional codecs to the subsequent SDP offer, giving priority to those offered by the preceding node/network. +3. In this example the IBCF seizes a TrGW prior to sending the new SDP offer; as this scenario is preparing for a possible transcoding in the TrGW then a TrGW supporting media shall be seized. The IBCF sends a H.248 ADD request command to create the outgoing termination and to request IP resources to execute TrGW function. As no media transcoding is yet known to be needed this may be indicated by omitting media related sub-fields in the media descriptor (i.e. signalling "-"). Alternatively the preferred codec (e.g. Codec 1) may be signalled in order to reserve this resource in the event that transcoding was required. +4. The TrGW creates the outgoing termination. + +5. The TrGW replies to IBCF with a H.248 ADD reply command and provides the local address and port of the outgoing termination. +6. The IBCF replaces the IP address inside the SDP offer using the information coming from TrGW. +7. The IBCF forwards the new SDP offer to the succeeding node. +8. The SDP answer is received by IBCF. In this example the codec 3 added by the IBCF to the SDP offer has been selected. Transcoding is therefore required. +9. The IBCF sends a H.248 MOD request command to configure the outgoing termination with address and port information received in the SDP answer and the selected media attributes (codec 3). +10. The TrGW configures the outgoing termination. +11. The TrGW replies to IBCF with a H.248 MOD reply command. +12. The IBCF sends a H.248 ADD request command to create the incoming termination to configure this termination with remote address and port information and to request resources to execute TrGW function. As media transcoding is required it indicates this explicitly with a codec selected by the IBCF for the incoming termination from the offered codec(s) received in step1. +13. The TrGW creates the incoming termination. +14. The TrGW replies to the IBCF with a H.248 ADD reply command and provides the local address and port of the incoming termination. +15. The IBCF replaces the IP address inside the SDP using the information coming from TrGW and replaces the codec with the codec it selected for the incoming termination. +16. The SDP answer is sent to the network at the incoming side. + +**Figure 10.2.5.2: IBCF and TrGW interaction when IBCF offers additional codecs and transcoding is required, and the TrGW is seized in advance.** + +![Sequence diagram showing the interaction between TrGW and IBCF for resource reservation and configuration. The diagram consists of 16 steps. 1. IBCF receives an SDP offer. 2. IBCF detects a use case needing TrGW. 3. IBCF sends an H.248 ADD req to TrGW. 4. TrGW creates an outgoing termination T1. 5. TrGW sends an H.248 ADD resp. 6. IBCF modifies the SDP offer. 7. IBCF sends the SDP offer to the caller. 8. IBCF receives the SDP answer. 9. IBCF sends an H.248 MOD req to TrGW. 10. TrGW configures the outgoing termination T1. 11. TrGW sends an H.248 MOD Resp. 12. IBCF sends an H.248 ADD req to TrGW. 13. TrGW creates an incoming termination T2. 14. TrGW sends an H.248 ADD Resp. 15. IBCF modifies the SDP answer. 16. IBCF sends the SDP answer to the caller. Brackets on the right indicate phases: 'Reserve TrGW Connection Point' (steps 3-5), 'Configure TrGW Connection Point' (steps 9-11), and 'Reserve And Configure TrGW Connection Point' (steps 12-14).](b5335262987c819d7f71ce40f99cb71b_img.jpg) + +``` + +sequenceDiagram + participant TrGW + participant IBCF + Note right of IBCF: 1. SDP offer (IP2o, P2o, codec1, codec2) + Note right of IBCF: 2. Use case X detected that needs TrGW functionality + IBCF->>TrGW: 3. H.248 ADD req (C= ?, T= ?, LAddr=?, LPort=?, Local Resources="-" or codec1 or codec2) + Note left of TrGW: 4. Create outgoing termination T1 + TrGW->>IBCF: 5. H.248 ADD resp. (C=C1, T=T1, LAddr=IP1o, LPort=P1o) + Note right of IBCF: 6. Modify SDP offer + IBCF-->>External: 7. SDP offer (IP1o, P1o, codec1, codec2) + External-->>IBCF: 8. SDP answer (IP1a, P1a, codec1) + IBCF->>TrGW: 9. H.248 MOD req (C= C1, T= T1, RAddr=IP1a, RPort=P1a, Local Resources="-" or codec1, Remote Resources="-" or codec1) + Note left of TrGW: 10. Configure Outgoing Termination T1 + TrGW->>IBCF: 11. H.248 MOD Resp (C= C1, T= T1) + IBCF->>TrGW: 12. H.248 ADD req (C= C1, T= ?, LAddr=?, LPort=?, RAddr=IP2o, RPort=P2o, Local Resources="-" or codec1, Remote Resources="-" or codec1) + Note left of TrGW: 13. Create incoming Termination T2 + TrGW->>IBCF: 14. H.248 ADD Resp (C= C1, T= T2, LAddr=IP2a, LPort=P2a, RAddr=IP2o, RPort=P2o) + Note right of IBCF: 15. Modify SDP answer + IBCF-->>External: 16. SDP answer (IP2a, P2a, codec 1) + +``` + +Reserve +TrGW +Connection +Point + +Configure +TrGW +Connection +Point + +Reserve +And +Configure +TrGW +Connection +Point + +Sequence diagram showing the interaction between TrGW and IBCF for resource reservation and configuration. The diagram consists of 16 steps. 1. IBCF receives an SDP offer. 2. IBCF detects a use case needing TrGW. 3. IBCF sends an H.248 ADD req to TrGW. 4. TrGW creates an outgoing termination T1. 5. TrGW sends an H.248 ADD resp. 6. IBCF modifies the SDP offer. 7. IBCF sends the SDP offer to the caller. 8. IBCF receives the SDP answer. 9. IBCF sends an H.248 MOD req to TrGW. 10. TrGW configures the outgoing termination T1. 11. TrGW sends an H.248 MOD Resp. 12. IBCF sends an H.248 ADD req to TrGW. 13. TrGW creates an incoming termination T2. 14. TrGW sends an H.248 ADD Resp. 15. IBCF modifies the SDP answer. 16. IBCF sends the SDP answer to the caller. Brackets on the right indicate phases: 'Reserve TrGW Connection Point' (steps 3-5), 'Configure TrGW Connection Point' (steps 9-11), and 'Reserve And Configure TrGW Connection Point' (steps 12-14). + +1. The IBCF receives an SDP offer in SIP signalling. +2. The IBCF requires a TrGW for another use case but does not offer transcoding. +3. The IBCF sends a H.248 ADD request command to create the outgoing termination and to request IP resources to execute TrGW function. As no media transcoding is required this may be indicated by signalling "-". Alternatively any codec (e.g. codec 1) can be signalled. If the IBCF selects a TrGW that does not support transcoding, the IBCF may signal media related sub-fields in the media descriptor to the TrGW if the TrGW supports media encoding. The TrGW shall accept the ADD request even though it cannot reserve any transcoding resources for the indicated media. +4. The TrGW creates the outgoing termination. + +5. The TrGW replies to IBCF with a H.248 ADD reply command and provides the local address and port of the outgoing termination. +6. The IBCF replaces the IP address inside the SDP using the information coming from TrGW. +7. The IBCF forwards the new offer to the succeeding node. +8. The SDP answer is received by IBCF. In this example the codec 1 received in the original SDP offer in step 1 has been selected. +9. The IBCF sends a H.248 MOD request command to configure the outgoing termination with address and port information. As no media transcoding is needed this may be indicated by signalling "-" .Alternatively the selected codec (codec 1) can be signalled. +10. The TrGW configures the outgoing termination. +11. The TrGW replies to IBCF with a H.248 MOD reply command. +12. The IBCF sends a H.248 ADD command to create the incoming termination to configure this termination with remote address and port information and to request resources to execute TrGW function. As no media transcoding is needed this may be indicated by signalling "-" .Alternatively media related sub-fields in the media descriptor for the codec indicated to the incoming termination may be signalled (e.g. the selected codec received in step 8 (codec 1)). +13. The TrGW creates the incoming termination. +14. The TrGW replies to the IBCF with a H.248 ADD reply command and provides the local address and port of the incoming termination. +15. The IBCF replaces the IP address inside the SDP answer using the information coming from TrGW. +16. The SDP answer is sent to the network at the incoming side. + +**Figure 10.2.5.3: IBCF and TrGW interaction when IBCF does not offer transcoding** + +#### 10.2.5.2 Handling of common codec parameters + +The requirements as described in subclause 5.13.2 of 3GPP TS 23.334 [43] for the IMS-ALG and the IMS-AGW, apply to the IBCF and the TrGW. + +#### 10.2.5.3 EVS speech codec parameters handling + +The Enhanced Voice Services (EVS) speech codec is defined in 3GPP TS 26.441 [52]. Its RTP payload type is defined in 3GPP TS 26.445 [53], and procedures for its usage as IMS Multimedia Telephony speech codec are defined in 3GPP TS 26.114 [36]. + +The IBCF and the TrGW may support transcoding to and from the EVS speech codec. If they do so, the requirements as described in subclause 5.13.3 of 3GPP TS 23.334 [43] for the IMS-ALG and the IMS-AGW, apply to the IBCF and the TrGW. + +#### 10.2.5.4 Rate adaptation for media endpoints + +If the IBCF and the TrGW support rate adaptation for media endpoints using the enhanced bandwidth negotiation mechanism defined in 3GPP TS 26.114 [36] the requirements and procedures in the present subclause apply. + +If the IBCF receives an SDP offer and if the IBCF and the TrGW apply the transcoding procedure, defined in subclause 10.2.5.1, then the following additional actions may be performed: + +- if the received SDP offer (figure 10.2.5.2, step 1) contained the SDP "a=bw-info" attribute(s), defined in clause 19 of 3GPP TS 26.114 [36] for payload type(s) that the IBCF retains in the forwarded SDP offer, the IBCF: + - a) if the IP version interworking is required and the received "a=bw-info" SDP attribute lines do not contain bandwidth properties for both IPv4 and IPv6, should adjust the bandwidth properties in accordance with subclause 9.1.5; or + - b) otherwise (if the IP version interworking is not required or the received "a=bw-info" SDP attribute lines contain bandwidth properties for both IPv4 and IPv6), should forward the SDP offer with unmodified related SDP "a=bw-info" attribute(s); and + +NOTE 1: The IBCF can modify the related SDP "a=bw-info" attribute(s) according to operator policies as specified in 3GPP TS 26.114 [36]. + +- for the each added codec in the SDP offer (figure 10.2.5.2, step 6) the IBCF shall include appropriate bandwidth information in new or existing "a=bw-info" attribute lines(s). + +If the IBCF then receives an SDP answer (figure 10.2.5.2, step 8) and if only the codecs inserted by the IBCF with the corresponding SDP "a=bw-info" attribute(s) are contained in the SDP answer the IBCF: + +- when requesting the TrGW to configure resources towards the succeeding node (figure 10.2.5.2, step 9), shall include for the selected codec the "Additional Bandwidth Properties" information element containing "a=bw-info" SDP attribute(s) providing information for the selected codec in the remote descriptor about bandwidths that will be used for the selected codec in the sending direction towards the succeeding node; + +NOTE 2: The included information corresponds to "a=bw-info" SDP attribute(s) from the received SDP answer for the "recv" or "sendrecv" direction. + +- shall select a codec from the ones in the previously received SDP offer from the preceding node; +- if the received SDP offer contained the SDP "a=bw-info" attribute(s) for the selected codec: + - a) shall construct appropriate SDP "a=bw-info" attribute(s) for the selected codec according to the rules in 3GPP TS 26.114 [36]; and + +NOTE 3: The offer/answer negotiation is performed for each "a=bw-info" SDP attribute line, payload type, direction and bandwidth property individually. + +- b) shall include the "Additional Bandwidth Properties" information element containing "a=bw-info" SDP attribute(s) in the remote descriptor describing bandwidths that will be used for the selected codec in the sending direction towards the preceding node when requesting the TrGW to reserve resources towards the preceding node (figure 10.2.5.2, step 12); and + +NOTE 4: The included information corresponds to "a=bw-info" SDP attribute(s) in the sent SDP answer for the "send" or "sendrecv" direction. + +- include the selected codec with the corresponding SDP "a=bw-info" attribute(s) in the modified SDP answer (figure 10.2.5.2, step 15) that will be sent towards the preceding node. + +If the received SDP answer contains codecs received in the SDP offer no transcoding at the TrGW is required and the IBCF shall: + +- not include the "Additional Bandwidth Properties" information element containing the "a=bw-info" SDP attribute(s) when requesting the TrGW to configure resources towards the succeeding node (figure 10.2.5.2, step 9); +- not include the "Additional Bandwidth Properties" information element containing the "a=bw-info" SDP attribute(s) when requesting the TrGW to configure resources towards the preceding node (figure 10.2.5.2, step 12); and +- if the received SDP answer (figure 10.2.5.2, step 8) contained the SDP "a=bw-info" attribute(s), the IBCF shall check: + - a) if the IP version interworking is required and the received "a=bw-info" SDP attribute lines do not contain bandwidth properties for both IPv4 and IPv6, the IBCF may adjust the bandwidth properties in accordance with subclause 9.1.5; + - b) otherwise (if the IP version interworking is not required or the received "a=bw-info" SDP attribute lines contain bandwidth properties for both IPv4 and IPv6), the IBCF shall forward the SDP answer with unmodified SDP "a=bw-info" attribute(s). + +The TrGW may use the "Additional Bandwidth Properties" information element indicating media bandwidth range for rate adaption (i.e. to select an appropriate encoding and redundancy) when transcoding media streams. + +### 10.2.6 Media Inactivity Detection + +The procedures in subclause A.7.1.2.2.6 of 3GPP TS 29.235 [29] are applicable. + +### 10.2.7 QoS Packet Marking (differentiated services) + +The procedures in subclause A.7.1.2.2.4 of 3GPP TS 29.235 [29] are applicable. + +Those procedures relate to Diffserv code point marking as described in IETF RFC 2474 [31] + +### 10.2.8 Hanging Termination Detection + +The procedures in subclause A.7.1.2.2.2 of 3GPP TS 29.235 [29] are applicable. + +### 10.2.9 Bandwidth Policing + +The procedures in subclause A.7.1.2.2.8 of 3GPP TS 29.235 [29] are applicable. + +NOTE 1: In order to support services that generate media with variable bitrate (e.g. video), the policing function needs to provide sufficient buffer space. The derivation of the correspondent token bucket size can be based on the estimated traffic volume over the expected maximum burst length (supposed time interval of the burst). For example, for MTSI media, 3GPP TS 26.114 [36] subclause 7.5.5 recommends a default period of 2 seconds for the derivation of average bitrates and provides further considerations regarding suitable time periods for speech and video. + +NOTE 2: The IBCF can derive the sustainable data rate from bandwidth parameters if it receives them within an SDP media description. The IBCF can: + +- use the "b=AS" bandwidth modifier if received within an SDP body; or +- if the IBCF supports the enhanced bandwidth negotiation mechanism, use the "maximum supported bandwidth for the receiving direction" property value from the "a=bw-info" SDP attribute received within an SDP answer. + +If the value of the "maximum supported bandwidth for the receiving direction" for the selected RTP payload type differs from the value of the "b=AS" bandwidth modifier, then the IBCF can use "maximum supported bandwidth for the receiving direction" property value from the "a=bw-info" SDP attribute to determine the sustainable data rate for the selected RTP payload. + +### 10.2.10 IMS end-to-end media plane security + +#### 10.2.10.1 End-to-end security for RTP based media + +An IBCF and a TrGW may support the end-to-end IMS media plane security for RTP based media as specified in 3GPP TS 33.328 [32]. If supported, the IBCF shall use the following procedures. + +If the IBCF receives SDP containing media lines with "RTP/SAVP" (see IETF RFC 3711 [34]) or "RTP/SAVPF" (see IETF RFC 5124 [35]) as transport protocol, the IBCF shall: + +- forward the SDP with unmodified transport protocol for those media lines; +- apply the procedures to not offer or apply transcoding defined in subclause 10.2.5; and +- provide "RTP/SAVP" or "RTP/SAVPF", as received in the SDP, to the TrGW as transport protocol for all related terminations, and not provide media related information to these terminations, to configure the TrGW to pass media and possibly associated RTCP control flows and not to reserve any resources. + +NOTE: RTP/SAVP or SAVPF are provided to the TrGW even though it does not reserve any resources for this as such, but this is needed in order to allocate dual ports to support RTCP flows. These are also controlled as described in subclause 10.2.3. For "RTP/SAVP" or "RTP/SAVPF", RTCP will be encrypted and can not be interpreted by the TrGW. Media information is also meaningless as encryption will modify the properties of the media streams. + +If the IBCF receives SDP containing SDES SDP attribute(s) according to IETF RFC 4568 [33], IBCF shall forward the SDP with unmodified SDES SDP attribute(s), but shall not provide the SDES SDP attribute(s) to the TrGW. + +#### 10.2.10.2 End-to-end security for TCP based media using TLS + +An IBCF may support the end-to-end IMS media plane security for TCP based media using TLS as specified in 3GPP TS 33.328 [32]. If supported, the IBCF shall use the following procedures. + +NOTE: End-to-end IMS media plane security for TCP based media using TLS does not impact the TrGW. + +End-to-end protection of MSRP (used in IMS session-based messaging) and BFCP (used in IMS conferencing) media is based on TLS, according to the TLS profile specified in Annex M of 3GPP TS 33.328 [32]. + +If the IBCF receives SDP containing media lines with "TCP/TLS/MSRP" (see IETF RFC 4975 [47]) and IETF RFC 6714 [48]) and/or "TCP/TLS/BFCP" (see IETF RFC 4583 [49]) as transport protocol, the IBCF shall: + +- forward the SDP with unmodified transport protocol for those media lines and unmodified TLS related SDP attribute(s); and +- indicate "TCP" to the TrGW as transport protocol for all related terminations, and provide no media related information to these terminations, to configure the TrGW to pass media transparently. + +### 10.2.11 Through-Connection + +#### 10.2.11.1 General + +The procedures in subclause A.7.1.2.2.9 of 3GPP TS 29.235 [29] are applicable. + +In addition, prior to the completion of the SIP session set-up, i.e. until a 2xx response to the initial INVITE request is received, the IBCF may enable or disable media stream(s), thus allowing or forbidding early media in forward and/or backward direction. + +If there is: + +- 1) no SIP early dialog and the IBCF receives an 18x provisional response including an SDP answer; or +- 2) only one SIP early dialog, and the IBCF receives a SIP message with an SDP answer on that SIP early dialog, + +then; + +- 1) the IBCF shall save the received SDP answer; and +- 2) based on the operator policy, the IBCF may: + - set the value of the Through-Connection information element based on the value of the direction attribute in the received SDP answer; or + - set the value of the Through-Connection information element considering the em-param(s) of the P-Early-Media header field (defined in IETF RFC 5009 [58]) according to subclause 10.2.11.2; or + - set the value of the Through-Connection information element based on the value of the direction attribute in the received SDP answer downgraded according to the configuration provisioned in the IBCF. + +Upon reception of the 2xx response to the initial INVITE request, the IBCF shall enable the media stream by setting the value of the Through-Connection information element based on the value of the direction attribute in the last received SDP answer on the established SIP dialog, if the IBCF has not already set the value of the Through-Connection information element based on the same value of the direction attribute in the last received SDP answer on the corresponding SIP early dialog. + +NOTE: The setting of StreamMode property by through-connection control does not impact a "control flow" component (i.e. an RTCP control component) as described in ITU-T Recommendation H.248.1 [26]. + +After the session establishment (i.e. after the 2xx response to the INVITE request is received and media session is established), if the IBCF receives an SDP answer indicating a different media stream direction than the current setting of the StreamMode property of the termination(s), the IBCF shall set the value of the Through-Connection information element based on the received SDP answer. + +#### 10.2.11.2 Through-connect control procedures considering the P-Early-Media header field + +If the IBCF uses the em-param(s) of the P-Early-Media header field for the through-connect control of early media, the IBCF shall perform the procedures described in this subclause. + +When a SIP 18x provisional response to an initial INVITE request with the P-Early-Media header field is received from the functional entity within the trust domain, then: + +- the IBCF may decide not to perform the through-connect control of early media if the P-Early-Media header field includes the "gated" parameter and the IBCF shall not block early media in both directions on both terminations; and + - if the P-Early-Media header field includes the "gated" parameter and the IBCF decides to perform the through-connection control, or if the P-Early-Media header field does not include the "gated" parameter then the IBCF shall perform the procedures in the subsequent bullet 1), or the procedures in the subsequent bullet 2), or both of those procedures. If the IBCF does not perform the procedures in the bullets 1) or 2), the IBCF shall not block early media in both directions on the termination for which the IBCF does not perform the procedures in the bullet 1) or 2). +- 1) For the termination which resides on the side receiving the 18x provisional response: + - a) if the received em-param(s) in the P-Early-Media header field is set to "sendrecv", the IBCF shall set the Through-Connection information element to "sendrecv"; + - b) if the received em-param(s) in the P-Early-Media header field is set to "recvonly", the IBCF shall set the Through-Connection information element to "sendonly"; + - c) if the received em-param(s) in the P-Early-Media header field is set to "sendonly", the IBCF shall set the Through-Connection information element to "recvonly"; and + - d) if the received em-param(s) in the P-Early-Media header field is set to "inactive", the IBCF shall set the Through-Connection information element to "inactive". + - 2) For the termination which resides on the side forwarding the 18x provisional response: + - a) if the received em-param(s) in the P-Early-Media header field is set to "sendrecv", the IBCF shall set the Through-Connection information element to "sendrecv"; + - b) if the received em-param(s) in the P-Early-Media header field is set to "sendonly", the IBCF shall set the Through-Connection information element to "sendonly"; + - c) if the received em-param(s) in the P-Early-Media header field is set to "recvonly", the IBCF shall set the Through-Connection information element to "recvonly"; and + - d) if the received em-param(s) in the P-Early-Media header field is set to "inactive", the IBCF shall set the Through-Connection information element to "inactive". + +NOTE 1: According to IETF RFC 5009 [58], the non-direction parameter "gated" can be included after the direction parameter (e.g. "sendrecv") in the parameter list. The proxy performing gating of early media can add the parameter before forwarding the response. + +NOTE 2: It is regarded as an error case if the direction authorized by the P-Early-Media header field is not enabled in the received SDP direction attribute. As indicated in IETF RFC 5009 [58] the applicable preconditions need to be met in order to allow early media in a particular direction, but the related handling is left to the implementation. + +When an 18x provisional response to an initial INVITE request without the P-Early-Media header field is received from the functional entity within the trust domain and no previous 18x provisional response to the initial INVITE request with the P-Early-Media header field has been received, then the IBCF may: + +- 1) set the Through-Connection information element to "inactive"; or +- 2) set the Through-Connection information element to the value of the direction attribute in the last received SDP answer (received in the 18x provisional response or in a previous SIP message); or +- 3) set the value of the Through-Connection information element based on the value of the direction attribute in the received SDP answer (received in the 18x provisional response or in a previous SIP message) downgraded according to the configuration provisioned in the IBCF. + +When an 18x provisional response to an initial INVITE request with the P-Early-Media header field is received from the functional entity other than the functional entity within the trust domain, then the IBCF shall not use the received em-param(s) in the P-Early-Media header field and the IBCF shall: + +- 1) set the Through-Connection information element to "inactive"; or + +- 2) set the Through-Connection information element based on the value of the direction attribute in the last received SDP answer(received in the 18x provisional response or in a previous SIP message); or +- 3) set the value of the Through-Connection information element based on the value of the direction attribute in the received SDP answer (received in the 18x provisional response or in a previous SIP message) downgraded according to the configuration provisioned in the IBCF. + +NOTE 3: The IBCF will remove or modify the P-Early-Media header field in the above case. + +### 10.2.12 Emergency Call + +The procedures in subclause A.7.1.2.2.10 of 3GPP TS 29.235 [29] are applicable. + +### 10.2.13 Explicit Congestion Notification support + +#### 10.2.13.1 General + +An IBCF and TrGW may support Multimedia Telephony using Explicit Congestion Notification (ECN) according to IETF RFC 3168 [37], and may act as an ECN endpoint to enable ECN with a local ECN-capable terminal within a local network that properly handles ECN-marked packets. + +#### 10.2.13.2 Incoming SDP offer with ECN + +If the IBCF receives an SDP offer containing the "a=ecn-capable-rtp" attribute (see IETF RFC 6679 [38]), then if all of the following statements are true: + +- a) the IBCF supports ECN according to 3GPP TS 26.114 [36]; +- b) the TrGW supports ECN according to 3GPP TS 26.114 [36]; +- c) the IBCF knows (via configuration) that the succeeding network supports ECN according to 3GPP TS 26.114 [36]; and +- d) the IBCF does not insert any transcoding; + +then the IBCF shall: + +- if the "ecn-capable-rtp" attribute includes both the "ice" initiation method and other initiation methods, remove the "ice" initiation method from the "ecn-capable-rtp" attribute and forward the attribute with this modification in the outgoing SDP offer; +- if the "ecn-capable-rtp" attribute only includes the "ice" initiation method, remove the "ecn-capable-rtp" attribute, any "rtcp-fb" attribute with the "nack" feedback parameter and the "ecn" feedback parameter value, and any "ecn-sum" parameter within a "rtcp-xr" attribute from the outgoing SDP offer; +- if the "ecn-capable-rtp" attribute did not include the "ice" initialisation method, forward the unmodified "ecn-capable-rtp" attribute within the outgoing SDP offer; and +- if the IBCF includes the "ecn-capable-rtp" attribute within the outgoing SDP offer, forward the SDP offer containing ECN parameters to the succeeding network. + +Otherwise the IBCF shall remove the "ecn-capable-rtp" attribute, any "rtcp-fb" attribute with the "nack" feedback parameter and the "ecn" feedback parameter value, and any "ecn-sum" parameter within an "rtcp-xr" attribute from the outgoing SDP offer. + +If the IBCF forwarded the SDP offer containing the "a=ecn-capable-rtp" attribute and receives an SDP answer also containing the "a=ecn-capable-rtp" attribute (the reception of the attribute indicates a successful ECN negotiation) then the IBCF shall forward the SDP answer to its preceding node and shall indicate to the TrGW that it shall transfer ECN bits in IP header transparently. + +If the IBCF forwarded the SDP offer containing the "a=ecn-capable-rtp" attribute and receives an SDP answer without the "a=ecn-capable-rtp" attribute and the TrGW supports at least some of the initialisation methods within the "a=ecn-capable-rtp" attribute in the previously received SDP offer, + +NOTE 1: Only the "leap" initialisation method is supported over the Ix interface in this release. + +the IBCF shall: + +- act as an end point for ECN; +- select an initialisation method supported by the TrGW; +- determine if application specific feedback or ECN feedback messages shall be used, taking into account whether the TrGW supports ECN feedback messages, and the negotiation procedures in 3GPP TS 26.114 [36]; +- determine if ECN XR summary reports can be used, taking into account whether they are supported at the TrGW, and the negotiation procedures in 3GPP TS 26.114 [36]; +- send the SDP answer according to 3GPP TS 26.114 [36] and the capabilities of the TrGW, containing the ECN attribute "a=ecn-capable-rtp"; and +- indicate to the TrGW that it shall apply the ECN procedures (according to 3GPP TS 26.114 [36]) and act as an ECT endpoint. + +If the IBCF receives an SDP offer containing the "a=ecn-capable-rtp" attribute and bullets a) and b) above are satisfied but if bullet c) or d) or both are not met then the IBCF shall remove ECN related attributes before forwarding the SDP offer. If the TrGW supports at least some of the initialisation methods offered within the "a=ecn-capable-rtp" attribute, + +NOTE 2: Only the "leap" initialisation method is supported over the Ix interface in this release. + +the IBCF shall: + +- act as an end point for ECN; +- select an initialisation method supported by the TrGW; +- determine if application specific feedback or ECN feedback messages shall be used, taking into account whether the TrGW supports ECN feedback messages, and the negotiation procedures in 3GPP TS 26.114 [36]; +- determine if ECN XR summary reports can be used, taking into account whether they are supported at the TrGW and the negotiation procedures in 3GPP TS 26.114 [36]; +- send an SDP answer according to 3GPP TS 26.114 [36] and the capabilities of the TrGW, containing the "a=ecn-capable-rtp" attribute; and +- indicate to the TrGW that it shall apply the ECN procedures (according to 3GPP TS 26.114 [36]) and act as an ECT endpoint. + +The TrGW should not send RTCP XR ECN summary reports. + +#### 10.2.13.3 Incoming SDP offer without ECN + +If the IBCF receives an SDP offer without the "a=ecn-capable-rtp" attribute then if all of the following statements are true: + +- a) the IBCF supports ECN according to 3GPP TS 26.114 [36]; +- b) the TrGW supports ECN according to 3GPP TS 26.114 [36]; and +- c) the IBCF knows (via configuration) that the succeeding network supports ECN according to 3GPP TS 26.114 [36]; + +the IBCF may include the "a=ecn-capable-rtp" attribute in the SDP offer it forwards towards the succeeding node, indicating the related capabilities of the TrGW. + +NOTE: ECN XR summary reports and RTCP AVPF ECN feedback message are not supported in this release towards IMS terminations. + +If the IBCF inserted ECN attributes in the SDP offer and receives an SDP answer containing the "a=ecn-capable-rtp" attribute the IBCF shall act as an endpoint and shall return the SDP answer to the preceding node removing the "a=ecn-capable-rtp" attribute, any "rtcp-fb" attribute with the "nack" feedback parameter and the "ecn" feedback parameter value, and any "ecn-sum" parameter within a "rtcp-xr" attribute, and shall indicate to the TrGW that it shall apply the + +ECN procedures according to 3GPP TS 26.114 [36] and act as an ECT endpoint. The TrGW should not send RTCP XR ECN summary reports. + +If the IBCF inserted the "a=ecn-capable-rtp" attribute in the SDP offer and receives an SDP answer without the "a=ecn-capable-rtp" attribute the IBCF shall continue the call without any ECN active. + +#### 10.2.13.3a Detection of ECN failures by TrGW + +If the TrGW acts as ECN endpoint and detects an ECN-related error case, for example non-ECT in the received packets when ECT(0) was expected or detecting a very high packet loss rate when ECN is used, the TrGW shall notify the IBCF. The IBCF should then initiate a session re-negotiation to disable ECN. + +#### 10.2.13.4 Interworking with non-3GPP ECN IP terminal + +##### 10.2.13.4.1 Support for additional ECN parameters + +An IBCF and TrGW may support additional ECN parameter settings than defined in subclause 10.2.13.2. The following sub-clauses describe the optional behaviour if the IBCF and TrGW support these additional values. + +##### 10.2.13.4.2 Incoming SDP offer from external IP network with ECN + +If the IBCF receives an incoming SDP offer from the external IP network containing values in the incoming SDP offer not supported by MTSI then it shall configure the SDP offer as defined in subclause 10.2.13.2 when forwarding the SDP offer to the IMS. + +When receiving the SDP answer from the IMS the IBCF may configure the SDP answer to the external IP network with alternative settings depending on what is received from the IMS and what was offered by the external IP network. The permitted alternatives are listed in table 10.2.13.4.1; the supported alternatives are implementation options which need to be derived through configuration or package auditing. + +##### 10.2.13.4.3 Incoming SDP offer from the IMS with ECN + +If the IBCF receives an incoming SDP offer from the IMS and it supports additional ECN parameter settings than those defined in subclause 10.2.13.2 the IBCF may add these to the SDP offer forwarded to the external IP network. + +When receiving an SDP answer from the external IP network the IBCF shall respond to the IMS in accordance with subclause 10.2.13.2. If the IBCF modifies any ECN-related parameters in the forwarded SDP answer compared to the received SDP answer, the IBCF shall configure its TrGW as an ECN endpoint. The permitted alternatives are listed in table 10.2.13.4.1; the supported alternatives are implementation options which need to be derived through configuration or package auditing. + +**Table 10.2.13.4.1: Possible configurations when interworking with non-3GPP ECN IP terminal** + +| ECN SDP Attribute and required TrGW Action | | | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| IMS side | External IP Network | TrGW Action | +| Initiation | | | +| "leap" | "rtp"
NOTE 3 | Act as an Endpoint and trigger explicit initiation using RTP and RTCP as described in IETF RFC 6679 [38] toward the external IP network. When initial ECT marked packets are received from the external IP network these are forwarded to the IMS (all packets shall be marked) and early feedback and XR Summary reports are sent back to the external IP network. If ECT marked packets are received from the IMS before any initiation is completed with the external IP network then ECT marking should be removed and only a fraction of the packets should be marked until feedback is received from the external IP network. | +| | "ice" | This initiation method is not supported in the present release. | +| Mode | | | +| "setread" | "readonly" | Act as ECN transparent unless required to act as an Endpoint for other reasons but mark packets toward the IMS with ECT(0). If ECN-CE is received from the IMS then this shall be handled by the IMS termination as currently specified for the non-interworking case and not forwarded to the external IP network. | +| | "setonly" | Act as ECN transparent (unless required to act as ECN Endpoint for other reasons) - ECN-CE marked packets will not be received from external IP network, ECN-CE marked packets from the IMS will be passed to the external IP network. | +| ECT | | | +| "ect(0)" | "ect(1)" | Act as ECN transparent unless required to act as an Endpoint for other reasons but mark packets toward the IMS with ECT(0) and mark packets toward external network with ECT(1). | +| | "random" | Act as ECN transparent unless required to act as an Endpoint for other reasons but mark packets toward IMS with ECT(0). Packets received from the IMS are left as ECT(0). | +| RTCP feedback | | | +| no "rtcp-fb:* nack ecn"
(received driven congestion control) | "rtcp-fb:* nack ecn" (sender driven congestion control) | For AMR, the handling of an AVPF feedback message received from the external IP the handling is not defined.

For video related AVFP feedback messages received from the external IP network the TrGW shall generate the appropriate TMBR request towards the IMS. If a TMBR request is received from the IMS the TrGW shall generate an appropriate AVPF feedback message to the external IP network. | +| "rtcp-fb:* nack ecn"
(sender driven congestion control) | "rtcp-fb:* nack ecn" (sender driven congestion control) | An AVPF feedback message received from the external IP network shall be forwarded via the IMS termination. | +| RTCP XR ECN summary report | | | +| - | "rtcp-xr:ecn-sum" | RTCP XR is not bi-directions and each end-point indicates whatever XR feedback it supports. Hence, if the SDP offer does not contain rtcp-xr with "ecn-sum" then it can still be added in the SDP answer.

The TrGW shall include XR ECN Summary reports towards the external IP network and receive reports from the external IP network. (NOTE 4) | +| NOTE 1: The settings for IMS side may be supported on the External IP Network side in which case no interworking is specified. | | | +| NOTE 2: Each parameter is described separately as each parameter may or may not need to be interworked. Unless stated otherwise the assumption is that each parameter can be treated independently. | | | +| NOTE 3: RTCP feedback messages need to be supported and negotiated for the "rtp" initialisation method. | | | +| NOTE 4: The contents of the XR reports will be limited to data received from the external IP network. | | | + +#### 10.2.13.5 Message sequence chart + +##### 10.2.13.5.1 ECN support requested (ECN endpoint) + +Figure 10.2.13.5.1.1 shows the message sequence chart example for requesting ECN. + +![Sequence diagram for Figure 10.2.13.5.1.1: Procedure to Request ECN. The diagram shows two lifelines: IBCF and TrGW. The IBCF sends a Context(Cx) message to the TrGW containing an H.248:ADD.req with Termination X, Transport = RTP/AVPF, ECN_enable=True, and {Notify_ECN_Error}. The TrGW responds with a Context(Cx) message containing an H.248:ADD.resp[Termination X]. The TrGW also performs internal actions: Reserve IMS Connection Point and Configure Remote Resources.](030c758fd425016b03290c8f11bef69d_img.jpg) + +``` +sequenceDiagram + participant IBCF + participant TrGW + Note right of TrGW: Reserve IMS Connection Point and Configure Remote Resources + IBCF->>TrGW: Context(Cx) [H.248:ADD.req[ Termination X, Transport = RTP/AVPF, ECN_enable=True, {Notify_ECN_Error}]] + TrGW-->>IBCF: Context(Cx) [H.248:ADD.resp[Termination X]] +``` + +Sequence diagram for Figure 10.2.13.5.1.1: Procedure to Request ECN. The diagram shows two lifelines: IBCF and TrGW. The IBCF sends a Context(Cx) message to the TrGW containing an H.248:ADD.req with Termination X, Transport = RTP/AVPF, ECN\_enable=True, and {Notify\_ECN\_Error}. The TrGW responds with a Context(Cx) message containing an H.248:ADD.resp[Termination X]. The TrGW also performs internal actions: Reserve IMS Connection Point and Configure Remote Resources. + +**Figure 10.2.13.5.1.1: Procedure to Request ECN** + +Upon receipt of a request to apply ECN the TrGW shall set the ECN field of the IP header in accordance with 3GPP TS 26.114 [36] when sending any data packets. + +Upon receipt of any IP headers indicating ECN Congestion Experienced (ECN-CE) the TrGW shall trigger rate adaptation in accordance with 3GPP TS 26.114 [36]. + +NOTE: ECN requires the IBCF to configure the TrGW with all media attributes to allow rate adaptation even if no transcoding is required/supported in the TrGW. + +##### 10.2.13.5.2 ECN Active Indicated (ECN transparent) + +Figure 10.2.13.5.2.1 shows the message sequence chart example for indicating ECN transparent. + +![Sequence diagram for Figure 10.2.13.5.2.1: Procedure to indicate ECN transparent negotiated. The diagram shows two lifelines: IBCF and TrGW. The IBCF sends a Context(Cx) message to the TrGW containing an H.248:ADD.req with Termination X, Transport = RTP/AVPF, ECN_enable = True, and Initialisation_Method = Inactive. The TrGW responds with a Context(Cx) message containing an H.248:ADD.resp[Termination X]. The TrGW also performs internal actions: Reserve IMS Connection Point and Configure Remote Resources.](5879500ca01e1a2521654beff6c289a4_img.jpg) + +``` +sequenceDiagram + participant IBCF + participant TrGW + Note right of TrGW: Reserve IMS Connection Point and Configure Remote Resources + IBCF->>TrGW: Context(Cx) [H.248:ADD.req[ Termination X, Transport = RTP/AVPF, ECN_enable = True, Initialisation_Method = Inactive]] + TrGW-->>IBCF: Context(Cx) [H.248:ADD.resp[Termination X]] +``` + +Sequence diagram for Figure 10.2.13.5.2.1: Procedure to indicate ECN transparent negotiated. The diagram shows two lifelines: IBCF and TrGW. The IBCF sends a Context(Cx) message to the TrGW containing an H.248:ADD.req with Termination X, Transport = RTP/AVPF, ECN\_enable = True, and Initialisation\_Method = Inactive. The TrGW responds with a Context(Cx) message containing an H.248:ADD.resp[Termination X]. The TrGW also performs internal actions: Reserve IMS Connection Point and Configure Remote Resources. + +**Figure 10.2.13.5.2.1: Procedure to indicate ECN transparent negotiated** + +Upon receipt of the indication that ECN transparent has been negotiated the TrGW shall forward IP packets with ECN bits set unmodified. + +##### 10.2.13.5.3 ECN Failure Indication (ECN endpoint) + +Figure 10.2.13.5.3.1 shows the message sequence chart example for an ECN Failure Event. + +![Sequence diagram showing the procedure to report ECN failure between IBCF and TrGW. The IBCF sends an H.248:NOTIFY.req(ECN Failure) message to the TrGW. The TrGW responds with an H.248:NOTIFY.resp(ECN Failure) message. The IBCF then reports the ECN failure to the Context(Cx).](0c80c383f76034e117adf5e5eaadaaf3_img.jpg) + +``` + +sequenceDiagram + participant IBCF + participant TrGW + Note left of IBCF: Context(Cx) + IBCF->>TrGW: H.248:NOTIFY.req(ECN Failure) +[Termination =x, cause=ecn_cause] + TrGW-->>IBCF: H.248:NOTIFY.resp(ECN Failure) +[Termination x] + Note right of TrGW: Report ECN Failure + Note left of IBCF: Context(Cx) + +``` + +Sequence diagram showing the procedure to report ECN failure between IBCF and TrGW. The IBCF sends an H.248:NOTIFY.req(ECN Failure) message to the TrGW. The TrGW responds with an H.248:NOTIFY.resp(ECN Failure) message. The IBCF then reports the ECN failure to the Context(Cx). + +**Figure 10.2.13.5.3.1: Procedure to Report ECN Failure** + +When the IBCF receives a Notification indicating that a failure has occurred, the MGCF may trigger a new SDP offer to disable ECN. + +### 10.2.14 Optimal Media Routeing + +An IBCF may support optimal media routeing (OMR) procedures, as defined in 3GPP TS 29.079 [39]. + +3GPP TS 29.079 [39] specifies that "secondary media resources" may be allocated in addition to "primary media resources". If controlled by an IBCF, such primary or secondary media resources are TrGWs controlled over the Ix interface with procedures specified in the present specification. + +If the IBCF applies OMR procedures, the following modifications to the procedures within the present specification are applicable: + +- Under conditions specified in 3GPP TS 29.079 [39], the IBCF uses information from OMR related SDP attributes as remote connection and port information that is provided towards the TrGW within the call establishment procedures in subclause 10.1.3.1.1. +- Under conditions specified in 3GPP TS 29.079 [39], the IBCF encapsulates local address and port information, as received from the TrGW within the call establishment procedures in subclause 10.1.3.1.1, in OMR related SDP attributes. +- Under conditions specified in 3GPP TS 29.079 [39], the IBCF uses information from OMR related SDP attributes as codec information that is provided towards the TrGW within the media control procedures in clause 10.2.5. +- 3GPP TS 29.079 [39] specifies OMR-specific events that trigger the call release procedures in subclause 10.1.3.1.2. + +### 10.2.15 IP Realm Availability + +The procedures in subclause A.7.1.2.2.5 of 3GPP TS 29.235 [29] are applicable. + +### 10.2.16 Access Transfer procedures with media anchored in ATGW + +The procedures in the present clause are optional to be supported for both IBCF and TrGW when supporting the ATCF and ATGW functionality (see subclause 6.1.4). + +The procedures in subclause 6.2.14 of 3GPP TS 23.334 [43] are applicable, except that where the Iq interface is mentioned in those procedures, the Ix interface is applicable. + +### 10.2.17 Multimedia Priority Service (MPS) Support + +#### 10.2.17.1 General + +The Multimedia Priority Service (MPS) is specified in 3GPP TS 22.153 [44]. The IBCF/TrGW may support the priority treatment of a call/session identified as an MPS call/session. If MPS is supported then upon receipt of the MPS priority information in the call control signalling: + +- The IBCF shall recognise the call/session as having priority. +- The IBCF shall send the Priority information for a context to the TrGW to enable the priority treatment described below related to the TrGW. +- The IBCF shall apply priority handling to H.248 transactions related to priority calls/sessions when network resources are congested, e.g., preferential treatment in any queues or buffers. +- The IBCF may send the updated priority information and, if DiffServ is used, provision a suitable DSCP marking for the updated MPS priority level to the TrGW if it needs to change the priority information previously communicated to the TrGW for an MPS call/session. +- If the H.248 control association utilises a transport with the possibility for prioritisation, the IBCF may apply priority using the appropriate prioritisation procedures. +- If the MPS Priority service requires a specific MPS DSCP setting, the IBCF shall configure the TrGW to apply a specific MPS DSCP marking to the user data transport packets to indicate that the packets are of a higher priority than those for normal calls. +- If the TrGW receives an indication to apply a specific MPS DSCP marking to the user data transport packets, it shall apply this DSCP marking to the IP headers. + +NOTE 1: Support of Diffserv procedures by the TrGW assumes an operator uses Diffserv for prioritising user plane traffic related to an MPS call/session. + +- When the IBCF marks a Context with Priority information, the TrGW may use the Priority information for selecting resources for the media and signaling transport with priority. The following actions may be taken by the TrGW if it has reached a congested state: + - i) seize priority reserved resources; or + - ii) if resources are completely congested, indicate that in a Command Response error code. + +NOTE 2: The Priority information can be used to derive Layer 2 QoS marking and trigger priority identification and priority treatment for other QoS technologies than Diffserv. + +This clause describes the Ix signalling procedures and their interactions with SIP signalling in the control plane and with user plane procedures to support the requirements for MPS. These Ix signalling procedures may or may not apply depending on the network configuration (e.g. whether the TrGW is shared by multiple IBCFs or whether the IBCF controls multiple TrGWs for a given route – Media Gateway Group). + +The IBCF can receive a SIP INVITE with MPS priority information (see 3GPP TS 23.228 [8], subclause 5.21). + +#### 10.2.17.2 TrGW Resource Congestion in ADD response, request is queued + +If the IBCF requests a resource via the Reserve and Configure TrGW Connection Point procedure or Reserve TrGW Connection Point procedure and receives an error indicating that the requested resource could not be seized (e.g. H.248 error code #510 "insufficient resources") and the IBCF does not have an alternative TrGW through which it can route the call/session, the IBCF queues the priority call/session and gives it priority over any further Reserve and Configure TrGW Connection Point or Reserve TrGW Connection Point procedures for lower priority calls/sessions towards this TrGW until the requested resource for this queued call/session is successfully seized. The example sequence is shown in Figure 10.2.17.2.1. + +![Sequence diagram showing the request to reserve MPS priority call resources when TrGW is congested. The diagram involves two main entities: IBCF and TrGW. The sequence starts with an INVITE [MPS priority indication] to the IBCF. The IBCF then sends an H.248 ADD Req to the TrGW. The TrGW responds with an H.248 ADD Reject [Error = #510] due to congestion. The IBCF then queues the MPS request. After some time, the IBCF sends another H.248 ADD Req to the TrGW, which now successfully seizes the required resources and responds with an H.248 ADD Resp.](4e85fe330de2c4f5eea6de4b2a53c77f_img.jpg) + +``` + +sequenceDiagram + participant IBCF + participant TrGW + Note left of IBCF: 1. INVITE [MPS priority indication] + Note left of IBCF: Reserve TrGW Connection Point + IBCF->>TrGW: 2. H.248 ADD Req [C=?, T=?, Laddr=?, Lport=?, Local Resources, Priority] + TrGW-->>IBCF: 3. H.248 ADD Reject [Error = #510] + Note right of TrGW: TrGW is congested + Note left of IBCF: 4. IBCF queues MPS request + Note left of IBCF: Reserve TrGW Connection Point + IBCF->>TrGW: 5. H.248 ADD Req [C=?, T=?, Laddr=?, Lport=?, Local Resources, Priority] + TrGW-->>IBCF: 6. H.248 ADD Resp [C=C1, T=T2, Laddr=IP2o, LPort=P2o] + Note right of TrGW: TrGW successfully seizes required resources + +``` + +Sequence diagram showing the request to reserve MPS priority call resources when TrGW is congested. The diagram involves two main entities: IBCF and TrGW. The sequence starts with an INVITE [MPS priority indication] to the IBCF. The IBCF then sends an H.248 ADD Req to the TrGW. The TrGW responds with an H.248 ADD Reject [Error = #510] due to congestion. The IBCF then queues the MPS request. After some time, the IBCF sends another H.248 ADD Req to the TrGW, which now successfully seizes the required resources and responds with an H.248 ADD Resp. + +**Figure 10.2.17.2.1: Request to Reserve MPS priority call resources when TrGW is congested** + +#### 10.2.17.3 TrGW Resource Congestion in ADD response, IBCF seizes new TrGW + +If the IBCF requests a resource via the Reserve and Configure TrGW Connection Point procedure or Reserve TrGW Connection Point procedure and receives an error indicating that the requested resources could not be seized due to congestion (e.g. H.248 error code #510 "insufficient resources") and Media Gateway Groups are implemented the IBCF seizes a new TrGW from the same Media Gateway Group before resorting to any queuing of the priority call/session (as described in subclause 10.2.17.2) to enable the MPS call/session to proceed as early as possible. + +#### 10.2.17.4 TrGW Priority Resource Allocation + +If the TrGW supports the Priority information (e.g. determined through provisioning or package profile), the IBCF requests a resource via the Reserve and Configure TrGW Connection Point procedure or Reserve TrGW Connection Point procedure and includes the Priority information. The TrGW may then provide priority allocation of resources once a congestion threshold is reached. The example sequence is shown in figure 10.2.17.4.1. If the TrGW is completely congested it shall indicate this to the IBCF as described in subclause 10.2.17.2. + +![Sequence diagram showing the request to reserve MPS priority call resources when TrGW is congested, but priority resources are allocated. The diagram involves two main entities: IBCF and TrGW. The sequence starts with an INVITE [MPS priority indication] to the IBCF. The IBCF then sends an H.248 ADD Req to the TrGW. The TrGW responds with an H.248 ADD Resp [C=C1, T=T2, Laddr=IP2o, LPort=P2o] because it is in a congested state but allocates priority resources to this call.](9dc9f41d7d76c1add4b190d348cb1533_img.jpg) + +``` + +sequenceDiagram + participant IBCF + participant TrGW + Note left of IBCF: 1. INVITE [MPS priority indication] + Note left of IBCF: Reserve TrGW Connection Point + IBCF->>TrGW: 2. H.248 ADD Req [C=?, T=?, Laddr=?, Lport=?, Local Resources, Priority] + TrGW-->>IBCF: 3. H.248 ADD Resp [C=C1, T=T2, Laddr=IP2o, LPort=P2o] + Note right of TrGW: TrGW is in a congested state but allocates priority resources to this call. + +``` + +Sequence diagram showing the request to reserve MPS priority call resources when TrGW is congested, but priority resources are allocated. The diagram involves two main entities: IBCF and TrGW. The sequence starts with an INVITE [MPS priority indication] to the IBCF. The IBCF then sends an H.248 ADD Req to the TrGW. The TrGW responds with an H.248 ADD Resp [C=C1, T=T2, Laddr=IP2o, LPort=P2o] because it is in a congested state but allocates priority resources to this call. + +**Figure 10.2.17.4.1: Request to reserve MPS priority call resources when TrGW is congested, priority resources are allocated** + +The TrGW may also provide priority allocation for resources requested via a subsequent Configure TrGW Connection Point procedure not including Priority information if the related context has been marked with priority information during the Reserve TrGW Connection Point or Reserve and Configure TrGW Connection Point procedure. + +#### 10.2.17.5 TrGW Priority User Data marking + +The IBCF may request the streams associated to an MPS call/session to be marked with certain priority code point as described in subclause 10.2.7. The TrGW shall then mark each IP packet header accordingly. The example sequence is shown in figure 10.2.17.5.1. + +![Sequence diagram showing the request to reserve IMS resources and apply DSCP marking for MPS between IBCF and TrGW.](69e5f1993021af230d08c08aac97d9df_img.jpg) + +``` + +sequenceDiagram + participant Ext as External + participant IBCF + participant TrGW + Ext->>IBCF: 1. INVITE [MPS priority indication] + Note over IBCF, TrGW: Reserve TrGW Connection Point + IBCF->>TrGW: 2. H.248 ADD Req [C=?, T= ?, Laddr = ?, Lport = ?, Local Resources, Diffserv Mark = DSCP1, Priority] + Note right of TrGW: TrGW is requested to apply DSCP value in IP header of user data packets. + TrGW-->>IBCF: 3. H.248 ADD Resp [C=C1, T=T2, Laddr=IP2o, LPort=P2o] + +``` + +The diagram illustrates a sequence of messages between an IBCF and a TrGW. It starts with an external INVITE message (1) with an MPS priority indication entering the IBCF. A bracket on the IBCF side labeled 'Reserve TrGW Connection Point' encompasses the subsequent H.248 messages. The IBCF sends a request (2) 'H.248 ADD Req [C=?, T= ?, Laddr = ?, Lport = ?, Local Resources, Diffserv Mark = DSCP1, Priority]' to the TrGW. A note on the TrGW side indicates that it is requested to apply the DSCP value in the IP header of user data packets. The TrGW responds (3) with 'H.248 ADD Resp [C=C1, T=T2, Laddr=IP2o, LPort=P2o]'. + +Sequence diagram showing the request to reserve IMS resources and apply DSCP marking for MPS between IBCF and TrGW. + +**Figure 10.2.17.5.1: Request to reserve IMS resources and apply DSCP marking for MPS** + +#### 10.2.17.6 TrGW Priority Modification + +If the IBCF seized an IP termination for a priority call/session with a default priority and subsequently needs to modify the priority information previously communicated to the TrGW (e.g. subject to subsequent authorisation by an authorisation point, see 3GPP TS 24.229 [1] subclause 4.11), the IBCF may modify the existing IP termination for the MPS call/session with the actual priority and, if DiffServ is used, provision a suitable DSCP marking for the updated MPS priority level to the TrGW via the Configure TrGW Connection Point Procedure. + +NOTE: The specific Ix related call sequence which details the handling to support the requirements defined in 3GPP TS 24.229 [1] subclause 4.11 and 3GPP TS 23.228 [8], subclause 5.21 is not specified and therefore implementations might exist which fulfil these requirements but do not require modification of the priority information across the Ix interface. + +### 10.2.18 Coordination of Video Orientation + +#### 10.2.18.1 General + +The IBCF and the TrGW may support the Coordination of Video Orientation (CVO) as defined in 3GPP TS 26.114 [36]. + +If the IBCF receives an SDP body containing the RTP header extension attribute(s) "a=extmap", as defined in IETF RFC 5285 [45], and if "a=extmap" attribute indicates a CVO URN(s) (i.e. the CVO URN for a 2 bit granularity of rotation and/or the CVO URN for a higher granularity of rotation) as defined in 3GPP TS 26.114 [36], then: + +- a) if the IBCF and the TrGW support the CVO feature: + - the IBCF shall include an "extended RTP header for CVO" information element when seizing resources in the TrGW to indicate to the TrGW that it shall allow the RTP header extension for CVO to pass; and + - the IBCF shall forward within SIP signalling the SDP body received from the preceding node to the succeeding node with unmodified "a=extmap" attribute(s); or +- b) if the TrGW does not support the CVO feature the IBCF shall forward within SIP signalling, the SDP body received from the preceding node to the succeeding node without any "a=extmap" attributes. + +If the TrGW supports the CVO feature and has been instructed as described above to pass on the extended RTP header for CVO for both incoming and outgoing terminations then: + +- if the TrGW does not apply video transcoding, it shall pass any received RTP CVO header extension to succeeding RTP streams; or + +- if the TrGW applies video transcoding, it shall keep the video orientation unchanged during the transcoding and copy the received RTP CVO header extension to the succeeding outgoing RTP stream(s) after transcoding the associated group of packets. + +NOTE 1: IETF RFC 5285 [45] provides a framework for header extensions and can also be used for non-CVO related purposes. It is an implementation decision of the TrGW if it only passes CVO related RTP header extensions, or if it passes any RTP header extension when being instructed with the "extended RTP header for CVO" information element. + +NOTE 2: The behaviour of the TrGW when being instructed with the "extended RTP header for CVO" information element only at one termination is an implementation decision. + +#### 10.2.18.2 Message sequence chart + +Figure 10.2.18.2.1 shows the message sequence chart example for indicating extended RTP header for Coordination of Video Orientation. + +![Sequence diagram showing the procedure to indicate RTP extension header for CVO between IBCF and TrGW.](36fd537a1e39baa2471ecfaaf869751a_img.jpg) + +``` +sequenceDiagram + participant IBCF + participant TrGW + Note left of IBCF: INVITE with SDP offer ["a=extmap: URN=CVO"] + IBCF->>TrGW: H.248: ADD req. [C=?, T= ?, Laddr = ?, Lport = ?, Local Resources, Extended RTP header(CVO)] + Note right of TrGW: Reserve TrGW Connection Point + TrGW-->>IBCF: H.248: ADD resp. [Termination T2...] + Note left of IBCF: INVITE with SDP offer ["a=extmap: URN=CVO"] + IBCF->>TrGW: SIP msg with SDP answer ["a=extmap: URN=CVO"] + Note left of IBCF: H.248: ADD req. [C=C, T= ?, Laddr = ?, Lport = ?, Local Resources, Extended RTP header(CVO)] + Note right of TrGW: Reserve and Configure TrW Connection Point + TrGW-->>IBCF: H.248: ADD resp. [Termination T1...] + Note left of IBCF: SIP msg with SDP answer ["a=extmap: URN=CVO"] + IBCF-->>TrGW: +``` + +The sequence diagram illustrates the interaction between an IBCF (Initiating Border Controller Function) and a TrGW (Traffic Gateway) to indicate the use of an extended RTP header for CVO (Coordination of Video Orientation). The process begins with an external INVITE with SDP offer containing the 'a=extmap: URN=CVO' attribute. The IBCF sends an H.248: ADD request to the TrGW, specifying the CVO header extension. The TrGW reserves a connection point and responds with H.248: ADD resp. [Termination T2...]. The IBCF then sends another INVITE with SDP offer with the CVO attribute and a SIP msg with SDP answer. The IBCF sends a second H.248: ADD request to the TrGW, this time with 'C=C' (indicating it is the selected connection). The TrGW reserves and configures the connection point and responds with H.248: ADD resp. [Termination T1...]. Finally, the IBCF sends a SIP msg with SDP answer with the CVO attribute. + +Sequence diagram showing the procedure to indicate RTP extension header for CVO between IBCF and TrGW. + +**Figure 10.2.18.2.1: Procedure to indicate RTP extension header for CVO** + +The IBCF shall send the "extended RTP header for CVO" information element only with supported CVO URN(s) to the TrGW. If the TrGW does not support the CVO feature, the IBCF shall not send the "extended RTP header for CVO" information element to the TrGW. + +NOTE: If the IBCF receives an SDP answer which includes the "a=extmap" attribute with a CVO URN with a granularity that the TrGW has not included in its response, or if the SDP answer does not include any "a=extmap" CVO related attribute, it is not necessary to modify the TrGW for this reason alone. Doing that would only add unnecessary signalling without requiring any action or changes in the TrGW. However if the IBCF needs to modify the media attributes for other purposes, in particular due to transcoding then the TrGW is updated in accordance with the received SDP answer, that is, either with the "extended RTP header for CVO" information element containing the received CVO URN if the CVO related "a=extmap" attribute has been included in the received SDP answer or without the "extended RTP header for CVO" information element if the CVO related "a=extmap" attribute has not been included in the received SDP answer (thus removing the requirement for sending the received RTP header extension with CVO bits for the transcoded stream). + +### 10.2.19 Generic image attributes + +#### 10.2.19.1 General + +The IBCF and TrGW may support a media-level SDP image attribute "a=imageattr" defined in IETF RFC 6236 [46] to negotiate the image size for sending and receiving video as required by 3GPP TS 26.114 [36]. + +NOTE 1: The image attribute may be used within the SDP capability negotiation framework and its use is then specified using the "a=acap" parameter. + +If the IBCF: + +- supports the negotiation of the image size; +- receives an SDP body containing the image attribute(s) "imageattr" defined in IETF RFC 6236 [46]; and +- does not offer or does not apply transcoding procedures defined in subclause 10.2.5; + +the IBCF shall forward the SDP body with unmodified image attribute(s). + +If the IBCF applies transcoding procedures defined in subclause 10.2.5 then the following additional actions may be performed if the negotiation of the image size is supported by the IBCF and the TrGW. + +- a) Upon receipt of an SDP offer containing the image attribute(s) from the preceding node (figure 10.2.5.2, step 1) and if the received image sizes are supported by the TrGW: + - 1) if the IBCF seizes an outgoing IP termination with the media related information before sending the SDP offer the IBCF may send the generic image attribute parameter to the TrGW (figure 10.2.5.2, step 3). + - 2) the IBCF shall include the SDP image attribute(s) "a=imageattr" indicating the supported image sizes in the modified SDP offer (figure 10.2.5.2, step 6). +- b) Upon receipt of an SDP answer from the succeeding node (figure 10.2.5.2, step 8) and if the returned SDP answer: + - 1) does not contain the image attribute(s) and contains media offered by the preceding node (i.e. no transcoding at the TrGW is required) then the IBCF shall send to the preceding node the SDP answer without image attribute; + - 2) does not contain the image attribute(s) and if the IBCF is an endpoint for the video stream (transcoding) then the IBCF: + - may send the generic image attribute parameter to the TrGW when seizing or modifying resources (figure 10.2.5.2, step 12); and + - shall include the SDP image attribute(s) "a=imageattr" indicating the supported image sizes in the modified SDP answer (figure 10.2.5.2, step 15); + - 3) contains the image attribute(s) and the media offered by the preceding node (i.e. no transcoding at the TrGW is required) then the IBCF shall send to the preceding node the SDP answer containing the received image attribute(s); or + +- 4) contains the image attribute(s) and if the IBCF is an endpoint for the video stream (transcoding) and if the received image sizes are supported by the TrGW then the IBCF: + - may send the generic image attribute parameters for the send and receive directions to the TrGW when seizing or modifying resources (figure 10.2.5.2, step 9 and step 12); and + - shall include the SDP image attribute(s) "a=imageattr" indicating the supported image sizes in the modified SDP answer (figure 10.2.5.2, step 15) + +NOTE 2: The IBCF not supporting the negotiation of generic image attributes will ignore the SDP image attribute received in the SDP offer and will return the SDP answer without any associated SDP image attribute. + +When sending the SDP body with image attribute(s) on the Mx interface the IBCF shall include in the "a=imageattr": + +- "recv" keyword and corresponding image sizes which the TrGW supports in the receiving direction; and +- "send" keyword and corresponding image sizes which the TrGW supports in the sending direction. + +If the TrGW is configured with different image sizes on the receive direction of one termination and the send direction of another interconnected termination, then it shall adjust the frame sizes accordingly when forwarding video media streams and use the image size as described in 3GPP TS 26.114 [36] when sending media. + +NOTE 3: The relation between the negotiated image sizes and CVO are specified in 3GPP TS 26.114 [36]. + +NOTE 4: The generic image attribute includes information related to the send and receive capabilities of a single termination, and the adjustment of image sizes is typically based on the setting of two connected terminations in a single context. + +#### 10.2.19.2 Indication of generic image attributes + +The IBCF may include the generic image attributes to the TrGW. The example sequence is shown in figure 10.2.19.2.1. + +The list of image sizes per payload type supported by the TrGW shall be preconfigured in the IBCF. If the image sizes received within an SDP body on the Mx interface are not all supported by the TrGW then the IBCF shall only send the list of corresponding TrGW supported image sizes to the TrGW. If no image size is supported by the TrGW, the IBCF shall not send the generic image attribute parameter to the TrGW. + +![Sequence diagram showing the request to reserve TrGW connection point with generic image attribute. The diagram involves two main entities: IBCF and TrGW. The sequence starts with an external SIP msg with SDP offer1 (containing 'imageattr: ...') sent to the IBCF. The IBCF then sends an internal SIP msg with SDP offer2 (containing 'imageattr: ...') to the TrGW. The TrGW responds with a SIP msg with SDP answer2 (containing 'imageattr: ...'). A NOTE is present between the SIP messages. The IBCF then sends a 'Reserve and Configure TrGW connection point' message to the TrGW. The TrGW receives a generic image attribute for transcoding video. Finally, the IBCF sends an H.248: ADD Req (with various parameters like C=?, T=?, Laddr = ?, Lport = ?, Local Resources, Generic Image Attribute) to the TrGW, and the TrGW responds with an H.248: ADD Resp (Termination X ...). The IBCF then sends a SIP msg with SDP answer1 (containing 'imageattr: ...') back to the external source.](187d05bf7ead21e1394b61320d8b3632_img.jpg) + +``` + +sequenceDiagram + participant External + participant IBCF + participant TrGW + Note right of IBCF: NOTE + External->>IBCF: SIP msg with SDP offer1 ["imageattr: ..."] + IBCF->>TrGW: SIP msg with SDP offer2 ["imageattr: ..."] + TrGW-->>IBCF: SIP msg with SDP answer2 ["imageattr: ..."] + IBCF->>TrGW: Reserve and Configure TrGW connection point + Note right of TrGW: TrGW receives generic image attribute to be used when transcoding video. + IBCF->>TrGW: H.248: ADD Req [C=?, T=?, Laddr = ?, Lport = ?, Local Resources, Generic Image Attribute] + TrGW-->>IBCF: H.248: ADD Resp [Termination X ...] + IBCF->>External: SIP msg with SDP answer1 ["imageattr: ..."] + +``` + +Sequence diagram showing the request to reserve TrGW connection point with generic image attribute. The diagram involves two main entities: IBCF and TrGW. The sequence starts with an external SIP msg with SDP offer1 (containing 'imageattr: ...') sent to the IBCF. The IBCF then sends an internal SIP msg with SDP offer2 (containing 'imageattr: ...') to the TrGW. The TrGW responds with a SIP msg with SDP answer2 (containing 'imageattr: ...'). A NOTE is present between the SIP messages. The IBCF then sends a 'Reserve and Configure TrGW connection point' message to the TrGW. The TrGW receives a generic image attribute for transcoding video. Finally, the IBCF sends an H.248: ADD Req (with various parameters like C=?, T=?, Laddr = ?, Lport = ?, Local Resources, Generic Image Attribute) to the TrGW, and the TrGW responds with an H.248: ADD Resp (Termination X ...). The IBCF then sends a SIP msg with SDP answer1 (containing 'imageattr: ...') back to the external source. + +NOTE: shown sequence applies to the creation of the incoming termination T2 from the figure 10.2.5.2 and when both, the IBCF and the TrGW support the generic image attribute. The outgoing termination T1 may be created in advance (i.e. before sending SDP offer2) as shown in the figure 10.2.5.2 or upon receipt of the SDP answer2. Even if the IBCF reserves the resources in advance the media information may be omitted at this stage (as described in subclause 10.2.5) and thus the generic image attribute will not be sent to the TrGW if the media information is omitted. + +**Figure 10.2.19.2.1: Request to reserve TrGW connection point with generic image attribute** + +### 10.2.20 Interactive Connectivity Establishment (ICE) + +The IBCF and the TrGW may support ICE functionality as specified in IETF RFC 5245 [50] and 3GPP TS 24.229 [1] to support a UE residing behind a remote NAT. + +Support of full ICE functionality is optional, but if ICE is supported, the IBCF and the TrGW shall at least support ICE lite as specified in IETF RFC 5245 [50]. + +The requirements for the IMS-ALG and the IMS-AGW as specified in subclause 5.17 of 3GPP TS 23.334 [43], apply to the IBCF and the TrGW when the ICE procedures are supported. + +### 10.2.21 MSRP handling + +The IBCF and TrGW may support the handling of the Message Session Relay Protocol (MSRP), IETF RFC 4975 [47]. If they support MSRP handling, they shall apply the procedures as specified in the subclause 5.19 and subclause 6.2.19 of 3GPP TS 23.334 [43]. + +### 10.2.22 Alternative connection (ALTC) addresses management + +An IBCF may support the ALTC functionality as specified in IETF RFC 6947 [51] and 3GPP TS 24.229 [1] to advertise alternative IP addresses (IPv4 and IPv6 address types) to the terminating side. + +The requirements for the IMS-ALG as specified in subclause 5.21 of 3GPP TS 23.334 [43], apply to the IBCF when the procedures related to ALTC are supported. + +The ALTC procedures as described specified in subclause 6.2.20 of 3GPP TS 23.334 [43] are then applicable, except that where the Iq interface is mentioned in those procedures, the Ix interface is applicable. + +### 10.2.23 Video Region-of-Interest (ROI) + +#### 10.2.23.1 General + +The IBCF and the TrGW may support the video Region-of-Interest (ROI) as defined in 3GPP TS 26.114 [36]. Three modes are specified for supporting ROI, including "Far End Camera Control (FECC)", "Arbitrary ROI" and "Pre-defined ROI". The IBCF and the TrGW may independently support any of these modes. + +#### 10.2.23.2 "Far End Camera Control" mode + +##### 10.2.23.2.1 General + +The procedures in subclause 5.22.2 of 3GPP TS 23.334 [43] are applicable. + +##### 10.2.23.2.2 Message sequence chart + +Figure 10.2.23.2.2.1 shows the message sequence chart example for indicating Video Region-of-Interest (ROI) using FECC. + +![Sequence diagram showing the procedure to indicate Video ROI using FECC between an IBCF and a TrGW.](a548c5381cebd2650c5edb725b19f795_img.jpg) + +``` + +sequenceDiagram + participant External + participant IBCF + participant TrGW + + Note left of IBCF: INVITE with SDP offer +["m=application port RTP/AVP x" +"a=rtpmap:x h224/4800" +"a=sendrecv"] + External->>IBCF: INVITE with SDP offer + IBCF->>TrGW: H.248:ADD.req[C=?, T= ?, Laddr = ?, Lport = ?, Local Resources] + Note right of TrGW: Reserve TrGW Connection Point + TrGW-->>IBCF: H.248:ADD.resp[Termination T2...] + Note right of IBCF: INVITE with SDP offer +["m=application port RTP/AVP x" +"a=rtpmap:x h224/4800" "a=sendrecv"] + IBCF->>TrGW: INVITE with SDP offer + Note right of TrGW: SDP answer +["m=application port RTP/AVP x" +"a=rtpmap:x h224/4800" "a=sendrecv"] + TrGW-->>IBCF: SDP answer + Note right of IBCF: H.248:ADD.req[C=C, T= ?, Laddr = ?, Lport = ?] + IBCF->>TrGW: H.248:ADD.req + Note right of TrGW: Reserve and Configure TrGW Connection Point + TrGW-->>IBCF: H.248:ADD.resp[Termination T1...] + Note left of IBCF: SDP answer +["m=application port RTP/AVP x" +"a=rtpmap:x h224/4800" +"a=sendrecv"] + IBCF-->>External: SDP answer + +``` + +The sequence diagram illustrates the interaction between an IBCF and a TrGW to indicate Video ROI using FECC. The process begins with an external INVITE with SDP offer to the IBCF. The IBCF sends an H.248:ADD.req to the TrGW, which reserves a connection point and responds. The IBCF then sends another INVITE with SDP offer to the TrGW, which provides an SDP answer. Finally, the IBCF sends a second H.248:ADD.req to the TrGW, which reserves and configures the connection point and responds. The IBCF then sends the final SDP answer back to the external entity. + +Sequence diagram showing the procedure to indicate Video ROI using FECC between an IBCF and a TrGW. + +Figure 10.2.23.2.2.1: Procedure to indicate Video ROI using FECC + +#### 10.2.23.3 "Predefined ROI" mode + +##### 10.2.23.3.1 General + +The procedures in subclause 5.22.3 of 3GPP TS 23.334 [43] are applicable. + +##### 10.2.23.3.2 Message sequence chart + +Figure 10.2.23.3.2.1 shows the message sequence chart example for indicating Predefined ROI mode. + +![Sequence diagram for Predefined ROI mode between IBCF and TrGW.](df1966d80c74bc127f159a48f38b13ee_img.jpg) + +``` + +sequenceDiagram + participant IBCF + participant TrGW + Note left of IBCF: INVITE with SDP offer +["a=rtcp-fb: 3gpp-roi-predefined" +"a=extmap: URN=Predefined +ROI" "a=predefined_ROI"] + IBCF->>TrGW: H.248:ADD.req[C=?, T= ?, Laddr = ?, Lport = ?, +Local Resources, RTCP Feedback(Predefined +ROI), Extended RTP header(Predefined ROI)] + Note right of TrGW: Reserve TrGW +Connection Point + TrGW-->>IBCF: H.248:ADD.resp[Termination T2...] + Note left of IBCF: INVITE with SDP offer +["a=rtcp-fb:3gpp-roi-predefined" "a=extmap: +URN=Predefined ROI" "a=predefined_ROI"] + IBCF->>TrGW: SDP answer +["a=rtcp-fb:3gpp-roi-predefined" "a=extmap: +URN=Predefined ROI" "a=predefined_ROI"] + Note right of TrGW: Reserve and +Configure TrGW +Connection Point + TrGW-->>IBCF: H.248:ADD.resp[Termination T1...] + Note left of IBCF: SDP answer +["a=rtcp-fb:3gpp-roi- +predefined" "a=extmap: +URN=Predefined ROI" +"a=predefined_ROI"] + +``` + +The sequence diagram illustrates the interaction between an IBCF (Initiation Border Control Function) and a TrGW (Traffic Gateway) for Predefined ROI mode. The process starts with an external INVITE with SDP offer to the IBCF. The IBCF sends an H.248:ADD.req message to the TrGW, which reserves a connection point. The TrGW responds with H.248:ADD.resp. The IBCF then sends another INVITE with SDP offer to the TrGW, which reserves and configures the connection point. The TrGW responds with H.248:ADD.resp. Finally, the IBCF sends an SDP answer back to the external caller. + +Sequence diagram for Predefined ROI mode between IBCF and TrGW. + +**Figure 10.2.23.3.2.1: Procedure to indicate Predefined ROI mode** + +According to this procedure, the IBCF shall send to the TrGW the information element on the RTCP feedback message capability for "Predefined ROI" type expressed by the parameter "3gpp-roi-predefined" as described in 3GPP TS 26.114 [36], and the RTP Header Extension capability for carriage of predefined ROI information as defined in IETF RFC 5285 [45] and 3GPP TS 26.114 [36]. In addition, the IBCF shall send to the TrGW the media-level SDP predefined ROI attribute "a=predefined\_ROI" defined in 3GPP TS 26.114 [36]. + +#### 10.2.23.4 "Arbitrary ROI" mode + +##### 10.2.23.4.1 General + +The procedures in subclause 5.22.4 of 3GPP TS 23.334 [43] are applicable. + +##### 10.2.23.4.2 Message sequence chart + +Figure 10.2.23.4.2.1 shows the message sequence chart example for indicating Arbitrary ROI mode. + +![Sequence diagram showing the procedure to indicate Arbitrary ROI mode between IBCF and TrGW.](0a73b03fba21af142d619a9a662e6490_img.jpg) + +``` + +sequenceDiagram + participant IBCF + participant TrGW + Note left of IBCF: INVITE with SDP offer +["a=rtcp-fb: 3gpp-roi-arbitrary" +"a=extmap: URN=Arbitrary +ROI"] + IBCF->>TrGW: H.248:ADD.req[C=?, T= ?, Laddr = ?, Lport = ?, +Local Resources, RTCP Feedback(Arbitrary ROI), +Extended RTP header(Arbitrary ROI)] + Note right of TrGW: Reserve TrGW +Connection Point + TrGW-->>IBCF: H.248:ADD.resp[Termination T2...] + Note left of IBCF: INVITE with SDP offer +["a=rtcp-fb: 3gpp-roi-arbitrary" +"a=extmap: URN=Arbitrary ROI"] + IBCF->>TrGW: SDP answer +["a=rtcp-fb: 3gpp-roi-arbitrary" +"a=extmap: URN=Arbitrary ROI"] + Note right of TrGW: Reserve and +Configure TrGW +Connection Point + TrGW-->>IBCF: H.248:ADD.req[C=C, T= ?, Laddr = ?, Lport = ?, +Local Resources, RTCP Feedback(Arbitrary ROI), +Extended RTP header(Arbitrary ROI)] + TrGW-->>IBCF: H.248:ADD.resp[Termination T1...] + Note left of IBCF: SDP answer +["a=rtcp-fb: 3gpp-roi-arbitrary" +"a=extmap: URN=Arbitrary +ROI"] + IBCF-->>TrGW: + +``` + +The diagram illustrates the interaction between an IBCF (Initiation Border Control Function) and a TrGW (Traffic Gateway) to indicate Arbitrary ROI mode. The sequence starts with an INVITE with SDP offer from an external source to the IBCF. The IBCF then sends an H.248:ADD.req message to the TrGW, which reserves a connection point. The TrGW responds with H.248:ADD.resp. The IBCF then sends another INVITE with SDP offer to the TrGW, which reserves and configures the connection point. The TrGW responds with H.248:ADD.req, and the IBCF sends an SDP answer back to the external source. + +Sequence diagram showing the procedure to indicate Arbitrary ROI mode between IBCF and TrGW. + +**Figure 10.2.23.4.2.1: Procedure to indicate Arbitrary ROI mode** + +According to this procedure, the IBCF shall send to the TrGW the information element on the RTCP feedback message capability for "Arbitrary ROI" type expressed by the parameter "3gpp-roi-arbitrary" as described in 3GPP TS 26.114 [36], and the RTP Header Extension capability for carriage of arbitrary ROI information as defined in IETF RFC 5285 [45] and 3GPP TS 26.114 [36]. + +### 10.2.24 SDP Capability Negotiation (SDPCapNeg) + +#### 10.2.24.1 General + +The SDP Capability Negotiation (SDPCapNeg) as specified in IETF RFC 5939 [57] is adopted as an optional functionality to negotiate capabilities and the associated configurations according to 3GPP TS 24.229 [1]. + +Upon receipt of an incoming SDP offer containing the attributes of SDP capability negotiation, e.g. offer AVPF and AVP together for the RTP profile negotiation using the "a=tcap", "a=pcfg" and "a=acfg" attributes, the IBCF shall: + +- request the TrGW to reserve resources only for the default configuration without SDPCapNeg, and make the decision on support of the alternative configurations based on the IBCF/TrGW capability as provisioned before forwarding the SDP offer, i.e. handling SDPCapNeg at the controller level; or +- request the TrGW to reserve resources for all of these configurations by signalling SDPCapNeg to the TrGW, and update the SDP offer based on the response from the TrGW before forwarding. + +NOTE: The additional benefit of signalling SDPCapNeg between the IBCF and the TrGW is to check the resource availability for the corresponding configurations and to avoid the further session failure in case of inadequate resources for the configuration changes in the final confirmation. However, due to the extra resources reserved only during the call establishment phase, there is increased risk of call establishment failures. + +In case the IBCF decides to request the TrGW to reserve resources for all of those configurations, the IBCF shall: + +- use legacy SDP attributes as specified in IETF RFC 4566 [53] to do the mapping of actual and potential configurations with the H.248 ReserveGroup concept; or +- use SDP extensions for SDP capability negotiation as specified in IETF RFC 5939 [57], if supported by the TrGW. + +Before using SDP extensions for SDP capability negotiation as specified in IETF RFC 5939 [57] towards the TrGW, the IBCF shall perform the necessary checks (i.e. through auditing or via prior provisioning) to ensure that the TrGW supports the syntax and capabilities requested. For an auditing the procedure in subclause 6.1.8.1 is used with the "SDPCapNeg Supported Capabilities" as the object. + +When receiving a request from the IBCF with information element "SDPCapNeg configuration" indicating the potential use of multiple configurations, the TrGW shall reserve resources for all of those configurations that it supports and shall send indicate the configurations for which it reserved resources in an "SDPCapNeg configuration" information element in the response. The IBCF shall update the SDP offer with SDPCapNeg configurations in the response from the TrGW and shall forward the SDP offer to the next hop. + +The IBCF may also provide SDP configurations to the TrGW with no dependency on the incoming SDP offer, e.g. the IBCF may wildcard the supported configurations in order to construct or update an SDP offer with the addition of alternative configurations via SDPCapNeg attributes. + +On receipt of an SDP answer with SDPCapNeg, the IBCF shall request the TrGW to configure the resources for the selected configuration. If the TrGW previously reserved any temporary resources for configurations that were not selected, the IBCF shall also request the TrGW to release those resources. + +#### 10.2.24.2 Message sequence chart + +##### 10.2.24.2.1 Audit SDPCapNeg Supported Capabilities + +The IBCF may request the TrGW to report the current values assigned to distinct objects, here as the "SDPCapNeg Supported Capabilities" in the TrGW. This procedure may be used when the IBCF is unsure of the applicability for SDPCapNeg of the TrGW. + +Figure 10.2.24.2.1.1 shows the message sequence chart example for the auditing. + +![Sequence diagram showing the Audit Value of the TrGW. The IBCF sends an 'Audit Value (Object(s))' message to the TrGW, and the TrGW responds with an 'Audit Value Ack (values per requested object)' message.](df65c22a46ec3e7285e44de67d3a59cf_img.jpg) + +``` +sequenceDiagram + participant IBCF + participant TrGW + Note left of IBCF: IBCF + Note right of TrGW: TrGW + IBCF->>TrGW: Audit Value (Object(s)) + TrGW-->>IBCF: Audit Value Ack (values per requested object) +``` + +Sequence diagram showing the Audit Value of the TrGW. The IBCF sends an 'Audit Value (Object(s))' message to the TrGW, and the TrGW responds with an 'Audit Value Ack (values per requested object)' message. + +Figure 10.2.24.2.1.1: Audit Value of the TrGW + +### 10.2.25 WebRTC Media Plane Optimization + +#### 10.2.25.1 General + +The IBCF and the TrGW may support the WebRTC media plane optimization as defined in 3GPP TS 23.228 [8], annex U.2.4, and 3GPP TS 24.229 [1], subclause 6.7.1.5. + +The purpose of WebRTC media plane optimization procedures is to convey media between WebRTC clients without bearer level protocol conversion. When both ends are WebRTC IMS clients (WIC), the TrGW remain allocated but media plane interworking is disabled. + +The SDP attributes associated with WebRTC media plane optimization procedures "tra-contact", "tra-m-line", "tra-att", "tra-SCTP-association", "tra-media-line-number" and "tra-bw" are defined in 3GPP TS 24.229 [1], subclause 7.5.4. + +#### 10.2.25.2 SDP offer handling + +If the IBCF receives an SDP offer that contains any "tra-contact" SDP attribute, and the IBCF decides to include a TrGW in the media path, the IBCF shall: + +- 1) reserve resources at the TrGW that are suitable for the media described in the SDP offer outside the "tra-m-line", "tra-att" and "tra-bw" SDP attributes. +- 2) include the address information as received from the TrGW in that contact line and also encapsulate the address information into each received "tra-contact" attribute, replacing previous information; and +- 3) transparently pass (in the forwarded SDP offer) all received "tra-m-line", "tra-att", "tra-SCTP-association", "tra-media-line-number" and "tra-bw" SDP attributes. + +#### 10.2.25.3 SDP answer handling + +If the IBCF receives an SDP answer and the SDP answer includes "tra-m-line" media level SDP attributes, the IBCF shall: + +- 1) configure the TrGW to transparently pass the media described in the received "tra-m-line", "tra-att", "tra-SCTP-association", and "tra-bw" SDP attributes; and +- 2) transparently pass all received "tra-m-line", "tra-att", "tra-SCTP-association" and "tra-bw" SDP attributes. + +NOTE: If interconnected H.248 Stream endpoints or terminations at the TrGW are configured with transport "UDP", they will pass the payload within UDP without modifications, known as UDP transparent forwarding. For WebRTC media plane optimization, the UDP payload will be either DTLS encapsulating SCTP and data channel(s), DTLS-SRTP encapsulating key management information, or SRTP encapsulating audio or video media. + +### 10.2.26 RTP-level pause and resume + +The IBCF and the TrGW may support the "RTP-level pause and resume" signalling as defined in 3GPP TS 26.114 [36] and IETF RFC 7728 [59]. + +If the IBCF and the TrGW support the "RTP-level pause and resume" signalling, they shall apply the requirements and procedures specified in 3GPP TS 23.334 [43] subclause 5.2.4 and subclause 6.2.23. + +### 10.2.27 RTCP Codec Control Commands and Indications + +The IBCF and the TrGW may support signalling of "RTCP Codec Control Commands and Indications", as defined in 3GPP TS 26.114 [36] and IETF RFC 5104 [60]. + +NOTE 1: 3GPP TS 26.114 [36] specifies support of the following RTCP feedback codec control messages (CCM): "Full Intra Request (FIR)", "Temporary Maximum Media Stream Bit Rate Request (TMMBR)" and "Temporary Maximum Media Stream Bit Rate Notification (TMMBN)". + +The RTCP feedback FIR message can be used both by point-to-point video calls, and by conference participants supporting Multi-stream Multiparty Conferencing Media Handling feature, as specified in 3GPP TS 26.114 [36] annex S, to request the media sender to send a decoder refresh point. + +The RTCP TMMBR and TMMBN feedback messages can also be used in reaction to the Explicit Congestion Notification, as specified in subclause 10.2.13. + +Usage of the RTCP feedback "CCM" messages is negotiated via SDP offer/answer exchange through an extension (defined in IETF RFC 5104 [60]) of the RTCP feedback capability attribute "a=rtcp-fb" (defined in IETF RFC 4585 [61]). + +NOTE 2: The SDP offer/answer negotiation is performed with a separate "a=rtcp-fb" attribute line for each CCM message type. + +If the IBCF and the TrGW support the "RTCP Codec Control Commands and Indications" signalling, they shall apply the requirements and procedures specified in 3GPP TS 23.334 [43] subclause 5.25 and subclause 6.2.24. + +### 10.2.28 Delay Budget Information (DBI) + +The IBCF and the TrGW may support the "DBI" signalling as defined in 3GPP TS 26.114 [36]. + +RTCP feedback messages to report or request additional delay budget for voice and video media streams (as defined in 3GPP TS 26.114 [36] subclause 7.3.8) can be used both by participants in a point-to-point MTSI session, and by conference participants. + +Usage of the RTCP feedback messages for "DBI" signalling is negotiated via SDP offer/answer exchange through an extension defined in 3GPP TS 26.114 [36] of the RTCP feedback capability attribute "a=rtcp-fb" as defined in IETF RFC 4585 [61]. + +If the IBCF and the TrGW support the "DBI" signalling, they shall apply the requirements and procedures specified in 3GPP TS 23.334 [43] subclause 5.26 and subclause 6.2.25. + +## 10.3 Void + +## 10.4 Procedures + +### 10.4.1 Call related Procedures + +#### 10.4.1.1 Reserve TrGW Connection Point + +This procedure is used to reserve an termination at the TrGW. + +###### **Table 10.4.1.1.1: Reserve TrGW Connection Point Procedure** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|-------------------------------|-----------|----------------------------------|------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Reserve TrGW Connection Point | IBCF | Context/Context Request | M | This information element indicates the existing context or requests a new context for the bearer termination. | +| | | Emergency Call Indicator | O | This information element identifies the call as emergency call that requires a preferential handling. | +| | | Priority information | O | This information element requests the TrGW to apply priority treatment for the terminations and bearer connections in the specified context. | +| | | Termination Request | M | This information element requests a new termination for the bearer to be established. | +| | | IP Interface | O | This information element specifies the type of external interface to be used for the IP termination (e.g. MbolfP). | +| | | Local IP Resources | O | This information element indicates the resource(s) (e.g. codec, auxiliary payload types) for which the TrGW shall be prepared to receive user data. May be excluded (i.e. "-" is used in SDP m-line) if no transcoding or other media related functions are required. | +| | | ReserveValue | C | This information element indicates if multiple local resources are to be reserved.
This information element shall be included if a speech codec and auxiliary payload types are configured. | +| | | Local Connection Address Request | M | This information element requests an IP address and port number on the TrGW that the remote end can send user plane data to. | +| | | Remote Source Address Filtering | O | This information element indicates that remote source address filtering is required. | +| | | Remote Source Address Mask | C | This information element provides information on the valid remote source addresses. This may be included if remote source address filtering is included. It shall not be included if remote source address filtering is not included. | +| | | Remote Source Port Filtering | O | This information element indicates that remote source port filtering is required. | +| | | Remote Source Port | C | This information element identifies the valid remote source port. This may be included if remote source port filtering is included. It shall not be included if remote source port filtering is not included. (NOTE 1) | +| | | Remote Source Port Range | C | This information element identifies a range of valid remote source ports. This may be included if remote source port filtering is included. It shall not be included if remote source port filtering is not included. (NOTE 1) | +| | | RTCP handling | O | Indicates whether or not the TrGW shall reserve a port for an RTCP flow. | +| | | Notify termination heartbeat | M | This information element requests termination heartbeat indications. | +| | | Notify Released Bearer | O | This information element requests a notification of a released bearer. | + +| | | | | +|--|-------------------------------------|---|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | DiffServ Code Point | O | This information element indicates a specific DiffServ code point to be used in the IP header in packets sent on the IP termination. | +| | DiffServ Tagging Behaviour | O | This information element indicates whether the Diffserv code point in the IP header in packets sent on the IP termination should be copied from the received value or set to a specific value. | +| | IP Realm Identifier | O | This information element indicates the IP realm of the IP termination. | +| | Traffic Policing Required | O | This information element indicates that policing of the media flow is required. | +| | Peak Data Rate | O | This information element may be present if Policing is required and specifies the permissible peak data rate for a media stream. (NOTE 2) | +| | Sustainable Data Rate | O | This information element may be present if Policing is required and specifies the permissible sustainable data rate for a media stream. (NOTE 2) | +| | Delay Variation Tolerance | O | This information element may be present if Policing on Peak Data Rate is required and specifies the maximum expected delay variation tolerance for the corresponding media stream. | +| | Maximum Burst Size | C | This information element shall be present if Policing on Sustainable Data Rate is required and specifies the maximum expected burst size for the corresponding media stream. | +| | Media Inactivity Detection Required | O | This information element indicates that detection of inactive media flows is required. | +| | Inactivity Detection Time | C | This information element may be present if Inactive Media Detection is required and specifies the Inactivity Detection time. | +| | Inactivity Detection Direction | C | This information element may be present if Inactive Media Detection is required and specifies the Inactivity Detection direction. | +| | ECN Enable | O | This information element requests the TrGW to apply ECN procedures | +| | ECN Initiation Method | C | This information element specifies the ECN Initiation method and requests the TrGW to perform IP header settings as an ECN endpoint, or indicates that ECN bits shall be passed transparently. It may be included only if ECN is enabled. | +| | Congestion Response Method | C | This information element specifies the ECN Congestion Response Method; receiver driven or sender driven. The default is "received driven congestion control". It may be included only if ECN is enabled and the TrGW acts as ECN endpoint. (NOTE 3) | +| | ECN ECT Marking | C | This information element specifies the ECN ECT Marking. It may be included only if ECN is enabled and the TrGW acts as ECN endpoint. (NOTE 3) | +| | ECN Mode | C | This information element specifies the ECN Mode. It may be included only if ECN is enabled and the TrGW acts as ECN endpoint. (NOTE 3) | +| | RTCP Feedback | C | This information element specifies the RTCP Feedback support. (NOTE 3) | + +| | | | | | +|-----------------------------------|------|---------------------------------------------|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | XR Summary Report | C | This information element specifies the support of XR Summary Reporting. | +| | | Notify ECN Failure Event | C | This information element requests a notification if a ECN failure occurs. It may only be supplied if ECN is enabled and the TrGW acts as ECN endpoint. | +| | | Extended RTP Header for CVO | O | This information element requests the TrGW to pass on the CVO extended RTP header as defined by IETF RFC 5285 [45]. | +| | | Generic Image Attributes | O | This information element indicates image attributes (e.g. image size) as defined by IETF RFC 6236 [46]. | +| | | ICE password request | O | This information element is present if IBCF requests an ICE password. | +| | | ICE Ufrag request | O | This information element is present if IBCF requests an ICE ufrag. | +| | | ICE host candidate request | O | This information element is present if IBCF requests an ICE host candidate. | +| | | STUN server request | O | This information element is present if IBCF requests the TrGW to answer STUN connectivity checks for ICE. | +| | | Application-aware MSRP interworking request | O | This information element is present if IBCF requests the TrGW to perform application-aware MSRP Interworking. | +| | | Extended RTP Header for Sent ROI | O | This information element requests the TrGW to pass on the ROI extended RTP header for carriage of predefined and/or arbitrary ROI information as defined by IETF RFC 5285 [45] and 3GPP TS 26.114 [36]. | +| | | Predefined ROI | O | This information element requests the TrGW to support the RTCP feedback message capability for "Predefined ROI" type expressed by the parameter "3gpp-roi-predefined", as described in 3GPP TS 26.114 [36]. | +| | | Arbitrary ROI | O | This information element requests the TrGW to support the RTCP feedback message capability for "Arbitrary ROI" type expressed by the parameter "3gpp-roi-arbitrary", as described in 3GPP TS 26.114 [36]. | +| | | SDPCapNeg configuration | O | This information element provides SDPCapNeg configuration(s) using as "a=acap", "a=tcap", "a=pcfg" and "a=acfg" SDP attributes. | +| Reserve TrGW Connection Point Ack | TrGW | Context | M | This information element indicates the context where the command was executed. | +| | | Termination | M | This information element indicates the termination where the command was executed. | +| | | Local IP Resources | C | This information element indicates the resources that the TrGW has reserved to receive the user plane data from the remote peer. This information element shall be present if it was contained in the request. If the information element was not contained in the request, it may be present in the reply. | +| | | Local Connection Address | M | This information element indicates the IP address and port on the TrGW that shall receive user plane data from the remote peer. | + +| | | | | | +|-----------------------------------------------------------------------------------------------|--|-------------------------|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | ICE password | C | This information element shall be present only if it was contained in the request. It indicates the ICE password assigned by the TrGW. | +| | | ICE Ufrag | C | This information element shall be present only if it was contained in the request. It indicates the ICE Ufrag assigned by the TrGW. | +| | | ICE host candidate | C | This information element shall be present only if it was contained in the request. It indicates the ICE host candidate assigned by the TrGW. | +| | | ICE lite indication | C | This information element shall be present only if an ICE host candidate request was contained in the request, and the IBCF supports ICE lite, but not full ICE. It indicates that the TrGW only supports ICE lite. | +| | | SDPCapNeg configuration | C | This information element shall be present only if it was contained in the request. It provides SDPCapNeg configuration(s) using as "a=acap", "a=tcap", "a=pcfg" and "a=acfg" SDP attributes. | +| NOTE 1: Remote Source Port and Remote Source Port Range are mutually exclusive. | | | | | +| NOTE 2: At least one of these information elementshall be present when policing is required. | | | | | +| NOTE 3: This parameter does not need to be signalled if support is for 3GPP defined ECN only. | | | | | + +#### 10.4.1.2 Configure TrGW Connection Point + +This procedure is used to configure or reconfigure an termination at the TrGW. + +###### **Table 10.4.1.2.1: Configure TrGW Connection Point Procedure** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|---------------------------------|-----------|---------------------------------|------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Configure TrGW Connection Point | IBCF | Context | M | This information element indicates the existing context. | +| | | Priority information | O | This information element shall be present if the priority information needs to be modified, it may be present otherwise. | +| | | Termination | M | This information element indicates the existing bearer termination. | +| | | IP Interface | O | This information element specifies the type of external interface to be used for the IP termination (e.g. MboIP). | +| | | Local IP Resources | O | This information element indicates the resources (e.g. codec, auxiliary payload types) that the TrGW may use on the reception of user plane data.
If Local Connection Address is supplied may be excluded (i.e. "-" is used in SDP m-line) if no transcoding or other media related functions are required. | +| | | Remote IP Resources | O | This information element indicates the resources (e.g. codec, auxiliary payload types) that the TrGW may send user plane data to.
If Remote Connection Address is supplied may be excluded (i.e. "-" is used in SDP m-line) if no transcoding or other media related functions are required. | +| | | Local Connection Address | O | This information element indicates the IP address and port on the TrGW that the remote peer can send user plane data to. | +| | | Remote Connection Address | O | This information element indicates the IP address and port that the TrGW can send user plane data to. | +| | | Reserve Value | C | This information element indicates if multiple resources are to be reserved. This information element shall be included if a speech codec and auxiliary payload types are configured. | +| | | Remote Source Address Filtering | O | This information element indicates that remote source address filtering is required. | +| | | Remote Source Address Mask | C | This information element provides information on the valid remote source addresses. This may be included if remote source address filtering is included. It shall not be included if remote source address filtering is not included. | +| | | Remote Source Port Filtering | O | This information element indicates that remote source port filtering is required. | +| | | Remote Source Port | C | This information element identifies the valid remote source port. This may be included if remote source port filtering is included. It shall not be included if remote source port filtering is not included. (NOTE 1) | +| | | Remote Source Port Range | C | This information element identifies a range of valid remote source ports. This may be included if remote source port filtering is included. It shall not be included if remote source port filtering is not included. (NOTE 1) | +| | | RTCP handling | O | Indicates whether or not the TrGW shall reserve a port for an RTCP flow | + +| | | | +|-------------------------------------|---|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Traffic Policing Required | O | This information element indicates that policing of the media flow is required. | +| Peak Data Rate | O | This information element may be present if Policing is required and specifies the permissible peak data rate for a media stream. (NOTE 2) | +| Sustainable Data Rate | O | This information element may be present if Policing is required and specifies the permissible sustainable data rate for a media stream. (NOTE 2) | +| Delay Variation Tolerance | O | This information element may be present if Policing on Peak Data Rate is required and specifies the maximum expected delay variation tolerance for the corresponding media stream. | +| Maximum Burst Size | C | This information element shall be present if Policing on Sustainable Data Rate is required and specifies the maximum expected burst size for the corresponding media stream. | +| DiffServ Code Point | O | This information element indicates a specific DiffServ code point to be used in the IP header in packets sent on the IP termination. | +| DiffServ Tagging Behaviour | O | This information element indicates whether the Diffserv code point in the IP header in packets sent on the IP termination should be copied from the received value or set to a specific value. | +| Media Inactivity Detection Required | O | This information element indicates that detection of inactive media flows is required. | +| Inactivity Detection Time | C | This information element may be present if Inactive Media Detection is required and specifies the Inactivity Detection time. | +| Inactivity Detection Direction | C | This information element may be present if Inactive Media Detection is required and specifies the Inactivity Detection direction. | +| ECN Enable | O | This information element requests the TrGW to apply ECN procedures. | +| ECN Initiation Method | C | This information element specifies the ECN Initiation method and requests the TrGW to perform IP header settings as an ECN endpoint, or indicates that ECN bits shall be passed transparently. It may be included only if ECN is enabled. | +| Congestion Response Method | C | This information element specifies the ECN Congestion Response Method; receiver driven or sender driven. The default is "received driven congestion control". It may be included only if ECN is enabled and the TrGW acts as ECN endpoint. (NOTE 3) | +| ECN ECT Marking | C | This information element specifies the ECN ECT Marking. It may be included only if ECN is enabled and the TrGW acts as ECN endpoint. (NOTE 3) | +| ECN Mode | C | This information element specifies the ECN Mode. It may be included only if ECN is enabled and the TrGW acts as ECN endpoint. (NOTE 3) | +| RTCP Feedback | C | This information element specifies the RTCP Feedback support. (NOTE 3) | +| XR Summary Report | C | This information element specifies the support of XR Summary Reporting. | + +| | | | | +|--|--------------------------------------|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | Notify ECN Failure Event | C | This information element requests a notification if a ECN failure occurs. It may only be supplied if ECN is enabled and the TrGW acts as ECN endpoint. | +| | Extended RTP Header for CVO | O | This information element requests the TrGW to pass on the CVO extended RTP header as defined by IETF RFC 5285 [45]. | +| | Generic Image Attributes | O | This information element indicates image attributes (e.g. image size) as defined by IETF RFC 6236 [46]. | +| | ICE Connectivity Check | C | This information element requests the TrGW to perform ICE connectivity check as defined by IETF RFC 5245 [50]. It is only applicable for full ICE. | +| | Notify ICE Connectivity Check Result | C | This information element requests a notification of ICE connectivity check result. It is only applicable for full ICE. | +| | Notify New Peer Reflexive Candidate | C | This information element requests a notification of new peer reflexive candidate was discovered during a connectivity check. It is only applicable for full ICE. | +| | Additional ICE Connectivity Check | C | This information element requests the TrGW to perform additional ICE connectivity check as defined by IETF RFC 5245 [50]. It is only applicable for full ICE. | +| | ICE received candidate | O | This information element is present if IBCF indicates a received candidate for ICE. | +| | ICE received password | O | This information element is present if IBCF indicates a received password for ICE. | +| | ICE received Ufrag | O | This information element is present if IBCF indicates a received Ufrag for ICE. | +| | MSRP Path | O | This information element is present for application-aware MSRP Interworking. It provides the path information that the TrGW shall insert in the MSRP layer "To-Path" Information element. | +| | Allowed RTCP APP message types | O | This information element is present if the IBCF allows the TrGW to send RTCP APP packets of the indicated types. The TrGW shall not send other RTCP APP packets. If the parameter is not supplied, the TrGW shall not send any RTCP APP packets. | +| | Extended RTP Header for Sent ROI | O | This information element requests the TrGW to pass on the ROI extended RTP header for carriage of predefined and/or arbitrary ROI information as defined by IETF RFC 5285 [45] and 3GPP TS 26.114 [36]. | +| | Predefined ROI | O | This information element requests the TrGW to support the RTCP feedback message capability for "Predefined ROI" type expressed by the parameter "3gpp-roi-predefined", as described in 3GPP TS 26.114 [36]. | +| | Arbitrary ROI | O | This information element requests the TrGW to support the RTCP feedback message capability for "Arbitrary ROI" type expressed by the parameter "3gpp-roi-arbitrary", as described in 3GPP TS 26.114 [36]. | + +| | | | | | +|-------------------------------------|------|---------------------------------|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | SDPCapNeg configuration | O | This information element provides SDPCapNeg configuration(s) using as "a=acap", "a=tcap", "a=pcfg" and "a=acfg" SDP attributes. | +| | | Additional Bandwidth Properties | O | This information element indicates additional bandwidth properties using "a=bw-info" SDP attribute(s) as defined by 3GPP TS 26.114 [36]. | +| | | CCM BASE | O | This information element indicates that the TrGW shall be prepared to receive and is allowed to send, respectively, the RTCP feedback "CCM FIR" and/or "CCM TMMBR" messages (defined in IETF RFC 5104 [60]). | +| | | CCM pause-resume | O | This information element indicates to the TrGW that RTCP feedback "CCM PAUSE-RESUME" messages shall be passed transparently. | +| | | DBI | O | This information element indicates to the TrGW that RTCP feedback messages for "DBI" signalling (as defined in 3GPP TS 26.114 [36] subclause 7.3.8) shall be passed transparently. | +| Configure TrGW Connection Point Ack | TrGW | Context | M | This information element indicates the context where the command was executed. | +| | | Termination | M | This information element indicates the termination where the command was executed. | +| | | Local IP Resources | O | This information element indicates the resources that the TrGW has reserved to receive the user plane data from the far end. | +| | | Remote IP Resources | O | This information element indicates the resource (i.e. codec) that the TrGW shall use to send user data to. May be present only if corresponding information element is present in the request. | +| | | Local Connection Address | O | This information element indicates the IP address and port on the TrGW that the remote end can send user plane data to. | +| | | Remote Connection Address | O | This information element indicates the IP address and port that the TrGW can send user plane data to. May be present only if corresponding information element is present in the request. | + +NOTE 1: Remote Source Port and Remote Source Port Range are mutually exclusive. + +NOTE 2: At least one of these information elements shall be present when policing is required. + +NOTE 3: This parameter does not need to be signalled if support is for 3GPP defined ECN only. + +#### 10.4.1.3 Reserve and Configure TrGW Connection Point + +This procedure is used to reserve and configure multimedia-processing resources for a termination at the TrGW. + +###### **Table 10.4.1.3.1: Reserve and Configure TrGW Connection Point Procedure** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|---------------------------------------------|-----------|----------------------------------|------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Reserve and Configure TrGW Connection Point | IBCF | Context/Context Request | M | This information element indicates the existing context or requests a new context for the bearer termination. | +| | | Emergency Call Indicator | O | This information element identifies the call as emergency call that requires a preferential handling. | +| | | Priority information | O | This information element requests the TrGW to apply priority treatment for the terminations and bearer connections in the specified context. | +| | | Termination/ Termination Request | M | This information element indicates the existing bearer termination or requests a new termination for the bearer to be established. | +| | | IP Interface | O | This information element specifies the used interface type for the IP termination (e.g. MboIP). | +| | | Local IP Resources | C | This information element indicates the resource(s) (e.g. codec, auxiliary payload types) for which the TrGW shall be prepared to receive user data. May be excluded (i.e. "-" is used in SDP m-line) if no transcoding or other media related functions are required. | +| | | Remote IP Resources | C | This information element indicates the resources (e.g. codec, auxiliary payload types) that the TrGW shall use to send user data. May be excluded (i.e. "-" is used in SDP m-line) if no transcoding or other media related functions are required. | +| | | Reserve Value | C | This information element indicates if multiple IP resources are to be reserved. This information element shall be included if a speech codec and auxiliary payload types are configured. | +| | | Local Connection Address request | M | This information element requests an IP address and a port number on the TrGW that the remote end can send user plane data to. | +| | | Remote Connection Address | M | This information element indicates the IP address and ports of the remote party that the TrGW can send user plane data to. | +| | | Remote Source Address Filtering | O | This information element indicates that remote source address filtering is required. | +| | | Remote Source Address Mask | C | This information element provides information on the valid remote source addresses. This may be included if remote source address filtering is included. It shall not be included if remote source address filtering is not included. | +| | | Remote Source Port Filtering | O | This information element indicates that remote source port filtering is required. | +| | | Remote Source Port | C | This information element identifies the valid remote source port. This may be included if remote source port filtering is included. It shall not be included if remote source port filtering is not included. (NOTE 1) | +| | | Remote Source Port Range | C | This information element identifies a range of valid remote source ports. This may be included if remote source port filtering is included. It shall not be included if remote source port filtering is not included. (NOTE 1) | + +| | | | | +|--|-------------------------------------|---|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | RTCP handling | O | This information element indicates whether or not the TrGW shall reserve a port for an RTCP flow. | +| | Notify termination heartbeat | M | This information element requests termination heartbeat indications. | +| | Notify Released Bearer | O | This information element requests a notification of a released bearer. | +| | IP Realm Identifier | O | This information element indicates the IP realm of the IP termination. | +| | Traffic Policing Required | O | This information element indicates that policing of the media flow is required. | +| | Peak Data Rate | O | This information element may be present if Policing is required and specifies the permissible peak data rate for a media stream. (NOTE 2) | +| | Sustainable Data Rate | O | This information element may be present if Policing is required and specifies the permissible sustainable data rate for a media stream. (NOTE 2) | +| | Delay Variation Tolerance | O | This information element may be present if Policing on Peak Data Rate is required and specifies the maximum expected delay variation tolerance for the corresponding media stream. | +| | Maximum Burst Size | C | This information element shall be present if Policing on Sustainable Data Rate is required and specifies the maximum expected burst size for the corresponding media stream. | +| | DiffServ Code Point | O | This information element indicates a specific DiffServ code point to be used in the IP header in packets sent on the IP termination. | +| | DiffServ Tagging Behaviour | O | This information element indicates whether the Diffserv code point in the IP header in packets sent on the IP termination should be copied from the received value or set to a specific value. | +| | Media Inactivity Detection Required | O | This information element indicates that detection of inactive media flows is required. | +| | Inactivity Detection Time | C | This information element may be present if Inactive Media Detection is required and specifies the Inactivity Detection time. | +| | Inactivity Detection Direction | C | This information element may be present if Inactive Media Detection is required and specifies the Inactivity Detection direction. | +| | ECN Enable | O | This information element requests the TrGW to apply ECN procedures. | +| | ECN Initiation Method | C | This information element specifies the ECN Initiation method and requests the TrGW to perform IP header settings as an ECN endpoint, or indicates that ECN bits shall be passed transparently. It may be included only if ECN is enabled. | +| | Congestion Response Method | C | This information element specifies the ECN Congestion Response Method; receiver driven or sender driven. The default is "received driven congestion control". It may be included only if ECN is enabled and the TrGW acts as ECN endpoint. (NOTE 3) | +| | ECN ECT Marking | C | This information element specifies the ECN ECT Marking. It may be included only if ECN is enabled and the TrGW acts as ECN endpoint. (NOTE 3) | + +| | | | | | +|--|--|---------------------------------------------|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | ECN Mode | C | This information element specifies the ECN Mode. It may be included only if ECN is enabled and the TrGW acts as ECN endpoint. (NOTE 3) | +| | | RTCP Feedback | C | This information element specifies the RTCP Feedback support. (NOTE 3) | +| | | XR Summary Report | C | This information element specifies the support of XR Summary Reporting. | +| | | Notify ECN FailureEvent | C | This information element requests a notification if a ECN failure occurs due to ECN. It may only be supplied if ECN is enabled and the TrGW acts as ECN endpoint. | +| | | Extended RTP Header for CVO | O | This information element requests the TrGW to pass on the CVO extended RTP header as defined by IETF RFC 5285 [45]. | +| | | Generic Image Attributes | O | This information element indicates image attributes (e.g. image size) as defined by IETF RFC 6236 [46]. | +| | | STUN server request | O | This information element is present if IBCF requests the TrGW to answer STUN connectivity checks for ICE. | +| | | ICE Connectivity Check | C | This information element requests the TrGW to perform ICE connectivity check as defined by IETF RFC 5245 [50]. It is only applicable for full ICE. | +| | | Notify ICE Connectivity Check Result | C | This information element requests a notification of ICE connectivity check result. It is only applicable for full ICE. | +| | | Notify New Peer Reflexive Candidate | C | This information element requests a notification of new peer reflexive candidate was discovered during a connectivity check. It is only applicable for full ICE. | +| | | ICE password request | O | This information element is present if IBCF requests an ICE password. | +| | | ICE Ufrag request | O | This information element is present if IBCF requests an ICE ufrag. | +| | | ICE host candidate request | O | This information element is present if IBCF requests an ICE host candidate. | +| | | ICE received candidate | O | This information element is present if IBCF indicates a received candidate for ICE. | +| | | ICE received password | O | This information element is present if IBCF indicates a received password for ICE. | +| | | ICE received Ufrag | O | This information element is present if IBCF indicates a received Ufrag for ICE. | +| | | MSRP Path | O | This information element is present for application-aware MSRP Interworking. It provides the path information that the TrGW shall insert in the MSRP layer "To-Path" Information element. | +| | | Application-aware MSRP interworking request | O | This information element is present if IBCF requests the TrGW to perform application-aware MSRP Interworking. | +| | | Allowed RTCP APP message types | O | This information element is present if the IBCF allows the TrGW to send RTCP APP packets of the indicated types. The TrGW shall not send other RTCP APP packets. If the parameter is not supplied, the TrGW shall not send any RTCP APP packets. | +| | | Extended RTP Header for Sent ROI | O | This information element requests the TrGW to pass on the ROI extended RTP header for carriage of predefined and/or arbitrary ROI information as defined by IETF RFC 5285 [45] and 3GPP TS 26.114 [36]. | + +| | | | | | +|-------------------------------------------------|------|---------------------------------|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | Predefined ROI | O | This information element requests the TrGW to support the RTCP feedback message capability for "Predefined ROI" type expressed by the parameter "3gpp-roI-predefined", as described in 3GPP TS 26.114 [36]. | +| | | Arbitrary ROI | O | This information element requests the TrGW to support the RTCP feedback message capability for "Arbitrary ROI" type expressed by the parameter "3gpp-roI-arbitrary", as described in 3GPP TS 26.114 [36]. | +| | | SDPCapNeg configuration | O | This information element provides SDPCapNeg configuration(s) using as "a=acap", "a=tcap", "a=pcfg" and "a=acfg" SDP attributes. | +| | | Additional Bandwidth Properties | O | This information element indicates additional bandwidth properties using "a=bw-info" SDP attribute(s) as defined by 3GPP TS 26.114 [36]. | +| | | CCM BASE | O | This information element indicates that the TrGW shall be prepared to receive and is allowed to send, respectively, the RTCP feedback "CCM FIR" and/or "CCM TMMBR" messages (defined in IETF RFC 5104 [60]). | +| | | CCM pause-resume | O | This information element indicates to the TrGW that RTCP feedback "CCM PAUSE-RESUME" messages shall be passed transparently. | +| | | DBI | O | This information element indicates to the TrGW that RTCP feedback messages for "DBI" signalling (as defined in 3GPP TS 26.114 [36] subclause 7.3.8) shall be passed transparently. | +| Reserve and Configure TrGW Connection Point Ack | TrGW | Context | M | This information element indicates the context where the command was executed. | +| | | Termination | M | This information element indicates the termination where the command was executed. | +| | | Local IP Resources | C | This information element indicates the resources that the TrGW has reserved to receive the user plane data from the remote side. This information element shall be present if it was contained in the request. If the information element was not contained in the request, it may be present in the reply. | +| | | Remote IP Resources | O | This information element indicates the resource (i.e. codec) that the TrGW shall use to send user data. | +| | | Local Connection Addresses | M | This information element indicates the IP address and port on the TrGW that shall receive user plane data. | +| | | Remote Connection Address | O | This information element indicates the IP address and port that the TrGW can send user plane data to. | +| | | ICE password | C | This information element shall be present only if it was contained in the request. It indicates the ICE password assigned by the TrGW. | +| | | ICE Ufrag | C | This information element shall be present only if it was contained in the request. It indicates the ICE Ufrag assigned by the TrGW. | +| | | ICE host candidate | C | This information element shall be present only if it was contained in the request. It indicates the ICE host candidate assigned by the TrGW. | + +| | | | | | | +|------------------------------------------------------------------------------------------------|--|-------------------------|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | ICE lite indication | C | This information element shall be present only if an ICE host candidate request was contained in the request, and the TrGW supports ICE lite, but not full ICE. It indicates that the TrGW only supports ICE lite. | | +| | | SDPCapNeg configuration | C | This information element shall be present only if it was contained in the request. It provides SDPCapNeg configuration(s) using as "a=acap", "a=tcap", "a=pcfg" and "a=acfg" SDP attributes. | | +| NOTE 1: Remote Source Port and Remote Source Port Range are mutually exclusive. | | | | | | +| NOTE 2: At least one of these information elements shall be present when policing is required. | | | | | | +| NOTE 3: This parameter does not need to be signalled if support is for 3GPP defined ECN only. | | | | | | + +#### 10.4.1.4 Release TrGW Termination + +This procedure is used to release multimedia-processing resources for a termination at the TrGW. + +**Table 10.4.1.4.1: Release TrGW Termination** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|------------------------------|-----------|--------------------------|------------------------------|------------------------------------------------------------------------------------| +| Release TrGW Termination | IBCF | Context | M | This information element indicates the existing context. | +| | | Termination | M | This information element indicates the existing bearer termination to be released. | +| Release TrGW Termination Ack | TrGW | Context | M | This information element indicates the context where the command was executed. | +| | | Termination | M | This information element indicates the termination where the command was executed. | + +NOTE: No requirement for statistics in the Release TrGW Termination Ack has been justified by a use case. + +#### 10.4.1.5 IP Bearer Released + +**Table 10.4.1.5.1: IP Bearer Released** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|------------------------|-----------|--------------------------|------------------------------|-----------------------------------------------------------------------------------------------| +| IP Bearer Released | TrGW | Context | M | This information element indicates the context for the bearer termination. | +| | | Termination | M | This information element indicates the bearer termination where the bearer was released. | +| | | Bearer Released | M | This information element notifies a bearer release. | +| | | Release Cause | M | This information element indicates the cause of a bearer release. | +| IP Bearer Released Ack | IBCF | Context | M | This information element indicates all context are where the command was executed. | +| | | Termination | M | This information element indicates that Bearer termination is where the command was executed. | + +#### 10.4.1.6 Media Inactivity Detection + +This command is used to notify the IBCF of media inactivity on the TrGW. + +**Table 10.4.1.6.1: Media Inactivity Notification** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|-----------------------------------|-----------|--------------------------|------------------------------|-------------------------------------------------------------------------------------------------------------------| +| Media Inactivity Notification | TrGW | Context | M | This information element indicates the existing context for the bearer termination. | +| | | Termination | M | This information element indicates that bearer termination is where the media inactivity detection was activated. | +| | | Media Inactivity | M | This information element notifies the IBCF of Media inactivity detection on the bearer termination. | +| Media Inactivity Notification Ack | IBCF | Context | M | This information element indicates the context where the command was executed. | +| | | Termination | M | This information element indicates the bearer termination where the command was executed. | + +#### 10.4.1.7 Termination heartbeat indication + +This command is used by the TrGW to periodically notify the IBCF of a termination heartbeat. + +**Table 10.4.1.7.1: Termination heartbeat indication** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|--------------------------------------|-----------|--------------------------|------------------------------|------------------------------------------------------------------------------------------------------------| +| Termination heartbeat indication | TrGW | Context | M | This information element indicates the context for the bearer termination. | +| | | Bearer Termination | M | This information element indicates the bearer termination for which the termination heartbeat is reported. | +| | | Termination heartbeat | M | Hanging Termination event. | +| Termination heartbeat indication Ack | IBCF | Context | M | This information element indicates the context where the command was executed. | +| | | Bearer Termination | M | This information element indicates the bearer termination where the command was executed. | + +#### 10.4.1.8 Change Through-Connection + +This procedure is used to change the Through-connection in the bearer termination. + +**Table 10.4.1.8.1: Change Through-Connection** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|-------------------------------|-----------|-----------------------------------------------|------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------| +| Change Through-Connection | IBCF | Context/Context Request | M | This information element indicates the existing context or requests a new context for the bearer termination. | +| | | Bearer Termination/Bearer Termination Request | M | This information element indicates the existing bearer termination or requests a new Bearer termination where the through connection is changed. | +| | | Through-Connection | M | This information element indicates the through-connection of the bearer termination. | +| Change Through-Connection Ack | TrGW | Context | M | This information element indicates the context where the command was executed. | +| | | Bearer Termination | M | This information element indicates the bearer termination where the command was executed. | + +NOTE: This procedure may be combined with Reserve and Configure TrGW Connection Point, Reserve TrGW Connection Point or Configure TrGW Connection Point procedure. This list of procedures is not exhaustive. + +#### 10.4.1.9 ECN Failure Indication + +This procedure is used to report ECN related failures (see clause 10.2.13.3a). + +**Table 10.4.1.9.1: Procedures toward the IM Subsystem: ECN Failure Indication** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|--------------------------|-----------|--------------------------|------------------------------|--------------------------------------------------------------------------------------------------| +| ECN Error Indication | TrGW | Context | M | This information element indicates the context for the bearer termination. | +| | | Bearer Termination | M | This information element indicates the bearer termination for which the ECN failure is reported. | +| | | ECN Error Indication | M | This information element indicates an ECN failure event. | +| ECN Error Indication Ack | IBCF | Context | M | This information element indicates the context where the command was executed. | +| | | Bearer Termination | M | This information element indicates the bearer termination where the command was executed. | + +#### 10.4.1.10 Change Flow Direction + +This procedure may be used to change the flow direction between bearer terminations within a context for access transfer procedures (see subclause 10.2.15). + +**Table 10.4.1.10.1: Procedures toward the IM Subsystem: Change Flow Direction** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|---------------------------|------------|----------------------------------------------------|------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------| +| Change Flow Direction | IBCF(ATCF) | Context/Context Request | M | This information element indicates the existing context or a new context where the flow direction is changed. | +| | | Bearer Termination 1/ Bearer Termination 1 Request | M | This information element indicates the existing bearer termination or a new bearer termination from where the new flow direction is applied. | +| | | Bearer Termination 2/ Bearer Termination 2 Request | M | This information element indicates the existing bearer termination where the new flow direction is applied. | +| | | Flow Direction | M | This information element indicates the flow direction from the bearer termination 1 to bearer termination 2 within the context. | +| Change Flow Direction Ack | TrGW(ATGW) | Context | M | This information element indicates the context where the command was executed. | + +#### 10.4.1.11 ICE Connectivity Check Result Notification + +This procedure is used to report ICE connectivity check result for Full ICE. + +**Table 10.4.1.11.1: Procedures toward the IM Subsystem: ICE Connectivity Check Result Notification** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|------------------------------------------------|-----------|------------------------------------------|------------------------------|--------------------------------------------------------------------------------------------------------------------| +| ICE Connectivity Check Result Notification | TrGW | Context | M | This information element indicates the context for the bearer termination. | +| | | Bearer Termination | M | This information element indicates the bearer termination for which the ICE Connectivity Check Result is reported. | +| | | ICE Connectivity Check Result Indication | M | This information element indicates an ICE Connectivity Check Result event. | +| ICE Connectivity Check Result Notification Ack | IBCF | Context | M | This information element indicates the context where the command was executed. | +| | | Bearer Termination | M | This information element indicates the bearer termination where the command was executed. | + +#### 10.4.1.12 ICE New Peer Reflexive Candidate Notification + +This procedure is used to report ICE New Peer Reflexive Candidate for Full ICE. + +**Table 10.4.1.12.1: Procedures toward the IM Subsystem: ICE New Peer Reflexive Candidate Notification** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|---------------------------------------------------|-----------|---------------------------------------------|------------------------------|-----------------------------------------------------------------------------------------------------------------------| +| ICE New Peer Reflexive Candidate Notification | TrGW | Context | M | This information element indicates the context for the bearer termination. | +| | | Bearer Termination | M | This information element indicates the bearer termination for which the ICE New Peer Reflexive Candidate is reported. | +| | | ICE New Peer Reflexive Candidate Indication | M | This information element indicates an ICE New Peer Reflexive Candidate event. | +| ICE New Peer Reflexive Candidate Notification Ack | IBCF | Context | M | This information element indicates the context where the command was executed. | +| | | Bearer Termination | M | This information element indicates the bearer termination where the command was executed. | + +### 10.4.2 Non Call related Procedures + +The procedures in table 10.4.2.1 shall be applied between the IBCF and TrGW. + +**Table 10.4.2.1: Non-call related procedures** + +| Stage 3 Procedure (for information) defined in 3GPP TS 29.238 [25] | Corresponding Stage 2 Procedure defined in 3GPP TS 23.205 [28] | Remarks | +|--------------------------------------------------------------------|----------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------| +| TrGW Out of service | MGW Out of Service | | +| TrGW Communication Up | MGW Communication Up | | +| TrGW Restoration | MGW Restoration | | +| TrGW Register | MGW Register | | +| TrGW Re-register | MGW Re-register | | +| CS-IBCF Ordered Re-register | (G)MSC Server Ordered Re-register | | +| CS-IBCF Restoration | (G)MSC Server Restoration | | +| CS-IBCF Out of Service | (G)MSC Server Out of Service | | +| Termination Out-of-Service | Termination Out-of-Service | The "Termination Out-of-Service procedure" is also used as a call-related H.248 command | +| Audit Value | Audit Value | The "Audit Value" procedure may be used to determine the support of SDPCapNeg in response to non-call-related H.248 commands. | +| Command Rejected | Command Rejected | The "Command Rejected" procedure may be used in response both to call-related and non-call-related H.248 commands. | +| TrGW Capability Change | Capability Update | | +| TrGW Resource Congestion Handling – Activate | MGW Resource Congestion Handling – Activate | | +| TrGW Resource Congestion Handling – Indication | MGW Resource Congestion Handling – Indication | | +| Inactivity timeout activation | Inactivity timeout activation | | +| Inactivity timeout indication | Inactivity timeout indication | | +| Realm Availability Change Activation | | See 3GPP TS 29.235 [29] subclause A.7.2 | + +| | | | +|--------------------------------------|--|-----------------------------------------| +| Realm Availability Change Indication | | See 3GPP TS 29.235 [29] subclause A.7.2 | +|--------------------------------------|--|-----------------------------------------| + +--- + +Annex A (informative): +Void. + +# Annex B (informative): Change history + +| Change history | | | | | | | | | +|-----------------------|--------------|-----------------|-----------|------------|------------|-----------------------------------------------------------------------------------------------------|------------|------------| +| Date | TSG # | TSG Doc. | CR | Rev | Cat | Subject/Comment | Old | New | +| 06-2015 | CT-68 | CP-150351 | 0139 | - | | Bearer Termination in Acknowledgements | 12.6.0 | 12.7.0 | +| 09-2015 | CT-69 | CP-150483 | 0141 | 2 | B | Support for Video Enhancements by Region-of-Interest Information Signalling | 12.7.0 | 13.0.0 | +| 12-2015 | CT-70 | CP-150667 | 0142 | 11 | B | Support of SDP capability negotiation | 13.0.0 | 13.1.0 | +| 12-2015 | CT-70 | CP-150665 | 0144 | 4 | B | Support for Video Enhancements by Region-of-Interest Information Signalling | 13.0.0 | 13.1.0 | +| Change history | | | | | | | | | +| Date | TSG # | TSG Doc. | CR | Rev | Cat | Subject/Comment | New | | +| 03-2016 | CT#71 | CP-160105 | 0149 | - | F | Bandwidth adjustment for EVS codec | 13.2.0 | | +| 03-2016 | CT#71 | CP-160102 | 0150 | 2 | B | Support of enhanced bandwidth negotiation mechanism for MTSI sessions | 13.2.0 | | +| 03-2016 | CT#71 | CP-160105 | 0151 | - | F | Removal of references to TS 26.235 | 13.2.0 | | +| 03-2016 | CT#71 | CP-160097 | 0152 | 4 | B | WebRTC media plane optimization procedure | 13.2.0 | | +| 06-2016 | CT#72 | CP-160269 | 0153 | - | F | Clarifications related to the enhanced bandwidth negotiation mechanism | 13.3.0 | | +| 09-2016 | CT#73 | CP-160451 | 0154 | 3 | B | Clarification of the gate control procedure between SIP and H.248 for early media over Ix interface | 14.0.0 | | +| 12-2016 | CT#74 | CP-160625 | 0155 | 1 | B | Support of RTP-level pause and resume functionality | 14.1.0 | | +| 03-2017 | CT#75 | CP-170082 | 0156 | - | F | Correcting references for "RTP-level pause and resume" signalling | 14.2.0 | | +| 03-2017 | CT#75 | CP-170082 | 0157 | 1 | B | RTCP Codec Control Commands and Indications | 14.2.0 | | +| 09-2018 | CT#81 | | | | | Automatic upgrade to Rel-15 | 15.0.0 | | +| 06-2019 | CT#84 | CP-191107 | 0159 | 3 | B | Update IBCF and TrGW interworking requirements for DBI support | 16.0.0 | | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29163/00504fc688ebcf131ccbeff94dfc9939_img.jpg b/marked/Rel-16/29_series/29163/00504fc688ebcf131ccbeff94dfc9939_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..287df08b65d52f9ef64b431831124ee29b2784ef --- /dev/null +++ b/marked/Rel-16/29_series/29163/00504fc688ebcf131ccbeff94dfc9939_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a117820fbfa474a2f010a37f1ab9203b972ef6d290c773b462f0a4a8b5c84f6d +size 68146 diff --git a/marked/Rel-16/29_series/29163/01465752f3ac36c403672804f406a676_img.jpg b/marked/Rel-16/29_series/29163/01465752f3ac36c403672804f406a676_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7212599750d6f0d8c2620698963225306c4e4b92 --- /dev/null +++ b/marked/Rel-16/29_series/29163/01465752f3ac36c403672804f406a676_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:56f69d7704d5960ce754e610eb5714c3539b32caf6bce00901a2f8e48e1611c6 +size 43311 diff --git a/marked/Rel-16/29_series/29163/02e16c8e8e61c2706b5c0129674884a8_img.jpg b/marked/Rel-16/29_series/29163/02e16c8e8e61c2706b5c0129674884a8_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6fc996e5a4da650fed9b90d2f8daac2333236a63 --- /dev/null +++ b/marked/Rel-16/29_series/29163/02e16c8e8e61c2706b5c0129674884a8_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c5308a96b2aacd8e4c5e7375109a303151a2556a5c749e7724faf52d9161de1e +size 21586 diff --git a/marked/Rel-16/29_series/29163/04dc3838022e96d8d5548bb1b777b38c_img.jpg b/marked/Rel-16/29_series/29163/04dc3838022e96d8d5548bb1b777b38c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..25c8fa47291ee71a0f9e14ad5babe53cee88de60 --- /dev/null +++ b/marked/Rel-16/29_series/29163/04dc3838022e96d8d5548bb1b777b38c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c19525bcb871f0d1145f363bd24c25ba460c5f79ca9ef9df81b300a6d19fa2ba +size 46415 diff --git a/marked/Rel-16/29_series/29163/0726a03ffb4e106eb90cd4f9283a6347_img.jpg b/marked/Rel-16/29_series/29163/0726a03ffb4e106eb90cd4f9283a6347_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..26e04ab262f9c867bf040479bc4058d4e935b2b1 --- /dev/null +++ b/marked/Rel-16/29_series/29163/0726a03ffb4e106eb90cd4f9283a6347_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:be2f99a647ecf78aee322de008a0c5ab8bd7013c6120a975fdb3f98d71eaaae1 +size 14284 diff --git a/marked/Rel-16/29_series/29163/09036266c6dba47efb2613ceaebe2b19_img.jpg b/marked/Rel-16/29_series/29163/09036266c6dba47efb2613ceaebe2b19_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b57b44e95b00feb38b444d4adf44b0ee69554631 --- /dev/null +++ b/marked/Rel-16/29_series/29163/09036266c6dba47efb2613ceaebe2b19_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a2754ce8f8983b02f21a6bc79e8c3f07b610a9594c99b1d5e6a92405f66665b6 +size 13944 diff --git a/marked/Rel-16/29_series/29163/0943af69f1915094819054eb36d77807_img.jpg b/marked/Rel-16/29_series/29163/0943af69f1915094819054eb36d77807_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ca6aa8c17cfdcc878f934d594708eeba134496ee --- /dev/null +++ b/marked/Rel-16/29_series/29163/0943af69f1915094819054eb36d77807_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ade94ef3cdab2dee517edf8e581418370f6acd4c88d3dbf6227c4ad4d3d2fae5 +size 12630 diff --git a/marked/Rel-16/29_series/29163/09955ff8214ffb6947951fc0f60eb6ab_img.jpg b/marked/Rel-16/29_series/29163/09955ff8214ffb6947951fc0f60eb6ab_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..48a6a063cd1f249bc8eedaf4b4da9466db783845 --- /dev/null +++ b/marked/Rel-16/29_series/29163/09955ff8214ffb6947951fc0f60eb6ab_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:542e8e4fb74627f60d9f96efcab153fa3633284021ab4928f62ad7b6f3884213 +size 29614 diff --git a/marked/Rel-16/29_series/29163/0b3d9fe35da3ee0c88f1420bb9ed7a03_img.jpg b/marked/Rel-16/29_series/29163/0b3d9fe35da3ee0c88f1420bb9ed7a03_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..175141123b95ccf9dce88031042278515cb8cced --- /dev/null +++ b/marked/Rel-16/29_series/29163/0b3d9fe35da3ee0c88f1420bb9ed7a03_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f43eeab55323250ddad3a3799a3d3ee05e42f486522fc9119d2af5d2562352f4 +size 57808 diff --git a/marked/Rel-16/29_series/29163/0b87abe67b21a93777287649c33e755d_img.jpg b/marked/Rel-16/29_series/29163/0b87abe67b21a93777287649c33e755d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..77fbf8365f0030e3a6a14c73e783660253974f12 --- /dev/null +++ b/marked/Rel-16/29_series/29163/0b87abe67b21a93777287649c33e755d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e9f54cfb4afff5dff2620c0bc9a25a276db50dc6524bdc74c495730cc0b0a963 +size 27697 diff --git a/marked/Rel-16/29_series/29163/0db3cccd1279034258e5ad5b6fdcff01_img.jpg b/marked/Rel-16/29_series/29163/0db3cccd1279034258e5ad5b6fdcff01_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..af49e3d608cd619b21fb8382154e529265f46dc3 --- /dev/null +++ b/marked/Rel-16/29_series/29163/0db3cccd1279034258e5ad5b6fdcff01_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8ca3a13a623ff5eae30d06ca4faceec6e70657091f2ceac0cb0876c05283093b +size 7334 diff --git a/marked/Rel-16/29_series/29163/0dfdff10c725fe9c332b07ade9d23a5e_img.jpg b/marked/Rel-16/29_series/29163/0dfdff10c725fe9c332b07ade9d23a5e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2a4328270474b1be1025100f7430aa56df36e689 --- /dev/null +++ b/marked/Rel-16/29_series/29163/0dfdff10c725fe9c332b07ade9d23a5e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e262dcc585159cdb2c1397926a5f2499e0b4ec01a464ec85466ea2d3b4c0b1d1 +size 15702 diff --git a/marked/Rel-16/29_series/29163/1381593e48739f603c81fa60e6b98a6c_img.jpg b/marked/Rel-16/29_series/29163/1381593e48739f603c81fa60e6b98a6c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a7fad50cea452542bfa025a0913b876486168109 --- /dev/null +++ b/marked/Rel-16/29_series/29163/1381593e48739f603c81fa60e6b98a6c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:964423023d6ebff15edbf3d04ac1e3497d6cc099c8d20f06db362e4cb5ca6684 +size 37741 diff --git a/marked/Rel-16/29_series/29163/1399c76ef88f22b70d05ed3f781d3c48_img.jpg b/marked/Rel-16/29_series/29163/1399c76ef88f22b70d05ed3f781d3c48_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0f57fc78d559f78fcbc791a60fc44d60e331bdaf --- /dev/null +++ b/marked/Rel-16/29_series/29163/1399c76ef88f22b70d05ed3f781d3c48_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:43eae90c9c6a063413e8320371f82fc42e858bddc49c722c11c23f7f6a611ed4 +size 11845 diff --git a/marked/Rel-16/29_series/29163/17431d8b59408f09df7552d8bdbaa015_img.jpg b/marked/Rel-16/29_series/29163/17431d8b59408f09df7552d8bdbaa015_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f7504cb6e58814d7ac9fa9a7884a1d712e9edecb --- /dev/null +++ b/marked/Rel-16/29_series/29163/17431d8b59408f09df7552d8bdbaa015_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:38ac5255e1ef460222b28e011d0e814989b873b7ffc61492544af4aa5af890fc +size 51620 diff --git a/marked/Rel-16/29_series/29163/187d05bf7ead21e1394b61320d8b3632_img.jpg b/marked/Rel-16/29_series/29163/187d05bf7ead21e1394b61320d8b3632_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c1745d8c90b5c4cc44a80d5633a546685b332168 --- /dev/null +++ b/marked/Rel-16/29_series/29163/187d05bf7ead21e1394b61320d8b3632_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e8ea6a2eba0e2fc3bc1c3fac5f343bb18846be3572285e548042c9340720611b +size 126681 diff --git a/marked/Rel-16/29_series/29163/19499072f755b22d0a231123f75fa477_img.jpg b/marked/Rel-16/29_series/29163/19499072f755b22d0a231123f75fa477_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8eb89d8c0d1c0c03a8271f0cbf36c17b54dab3ff --- /dev/null +++ b/marked/Rel-16/29_series/29163/19499072f755b22d0a231123f75fa477_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d8248318c31a22c2008016aebfc66693abcb1da729b56bc3121b53a7300d5e5f +size 11493 diff --git a/marked/Rel-16/29_series/29163/1a827b10290f33d4fec04d0e8ef7a897_img.jpg b/marked/Rel-16/29_series/29163/1a827b10290f33d4fec04d0e8ef7a897_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b6457bbc7b7478e7b9b9f9476d47c8e6d2a7439e --- /dev/null +++ b/marked/Rel-16/29_series/29163/1a827b10290f33d4fec04d0e8ef7a897_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b62d1e9cbad1d78c4a64a667847559bf21828ce16d5aeedb9872628523616cef +size 45706 diff --git a/marked/Rel-16/29_series/29163/1cac1845cf99a3f64ae00cd2bb4f9ed7_img.jpg b/marked/Rel-16/29_series/29163/1cac1845cf99a3f64ae00cd2bb4f9ed7_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e1c6906bb842a3fc0a73ac5bdb3e3fc73225a9b4 --- /dev/null +++ b/marked/Rel-16/29_series/29163/1cac1845cf99a3f64ae00cd2bb4f9ed7_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:602e4fde66722d07b3c53941953b3be4261e96cee058772cbf10c9835eeb14c2 +size 84283 diff --git a/marked/Rel-16/29_series/29163/20e1585db1a707a774877194c689de82_img.jpg b/marked/Rel-16/29_series/29163/20e1585db1a707a774877194c689de82_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ad070f1568d5119b092dc00d92f680007bbbc1d0 --- /dev/null +++ b/marked/Rel-16/29_series/29163/20e1585db1a707a774877194c689de82_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:79db3c2efc3756f28179f55ace107eeae1746e0b55fd1c4454f31ae47ea72bea +size 23461 diff --git a/marked/Rel-16/29_series/29163/257c8341b41f1f4a287f27d33227974c_img.jpg b/marked/Rel-16/29_series/29163/257c8341b41f1f4a287f27d33227974c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..fb71238c2fa0ecae6cb060615c4986fdf9e2993b --- /dev/null +++ b/marked/Rel-16/29_series/29163/257c8341b41f1f4a287f27d33227974c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7cbf467b73ce54093578fb08b1153b4129c46fc915528a7120761ea4552f99e9 +size 61818 diff --git a/marked/Rel-16/29_series/29163/28085f681b9fff76a53c5b8b32338ee1_img.jpg b/marked/Rel-16/29_series/29163/28085f681b9fff76a53c5b8b32338ee1_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f02c36ee1174b1d5e02bd2cabeb1e00efdc00ed1 --- /dev/null +++ b/marked/Rel-16/29_series/29163/28085f681b9fff76a53c5b8b32338ee1_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1419abafd8a45fa97cb06768fe6def2636ad3e0721986420086985e71c3fedcb +size 93741 diff --git a/marked/Rel-16/29_series/29163/2837ffdadcdb1e5bababa56b564e56ed_img.jpg b/marked/Rel-16/29_series/29163/2837ffdadcdb1e5bababa56b564e56ed_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..fa1451c3f2eb2f33667b9e8c6f9820930da430e9 --- /dev/null +++ b/marked/Rel-16/29_series/29163/2837ffdadcdb1e5bababa56b564e56ed_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:86ee99cd379ac6a30527da380a4bb1d7d7430518d8c53e86d7c2bc65a57f21f5 +size 135866 diff --git a/marked/Rel-16/29_series/29163/2ae3eae1bd80a90f192f568ae246a9a6_img.jpg b/marked/Rel-16/29_series/29163/2ae3eae1bd80a90f192f568ae246a9a6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ae00e343d6ebc653329a451378a70b46f4b700ed --- /dev/null +++ b/marked/Rel-16/29_series/29163/2ae3eae1bd80a90f192f568ae246a9a6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e6743eee39008385db4b769c1e98821caaabd24ca00404befe7a14fd319c60e0 +size 58243 diff --git a/marked/Rel-16/29_series/29163/2cf3896394a2342a2b46c504ab9a8830_img.jpg b/marked/Rel-16/29_series/29163/2cf3896394a2342a2b46c504ab9a8830_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4d001666e3e0e4e91ec08959eec63d52d861cf44 --- /dev/null +++ b/marked/Rel-16/29_series/29163/2cf3896394a2342a2b46c504ab9a8830_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:69711a404c50fa494c2b68d3dbc60e55ac24e1e2a92b1baf2f291ee97db58a20 +size 17594 diff --git a/marked/Rel-16/29_series/29163/2e787cedee89518fd6c63f3cce1f913c_img.jpg b/marked/Rel-16/29_series/29163/2e787cedee89518fd6c63f3cce1f913c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..922287904aa87d1a4d2145a2f937f180f3545173 --- /dev/null +++ b/marked/Rel-16/29_series/29163/2e787cedee89518fd6c63f3cce1f913c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7cdbc0a005c4561fc88aac84eb1fe3f271051cd1905403ff1c659f641bb37640 +size 23561 diff --git a/marked/Rel-16/29_series/29163/30fe9e9487585118063341332e802e98_img.jpg b/marked/Rel-16/29_series/29163/30fe9e9487585118063341332e802e98_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2132db134eea167ced318841f46b15b61810b819 --- /dev/null +++ b/marked/Rel-16/29_series/29163/30fe9e9487585118063341332e802e98_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1e61aaabc751573cac0b502eb1db06bd21abd240b28c6d068324dc2d3f7abe8e +size 39985 diff --git a/marked/Rel-16/29_series/29163/31ef15d175af5babdbf4d2fbac884c1b_img.jpg b/marked/Rel-16/29_series/29163/31ef15d175af5babdbf4d2fbac884c1b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..58f69fc5aa177b73ca86ef1801480aaa0212aee6 --- /dev/null +++ b/marked/Rel-16/29_series/29163/31ef15d175af5babdbf4d2fbac884c1b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:92067ad12ab18c32528a6b425d81001af5f3eeee4999415ccd3cacf6725d02ce +size 10166 diff --git a/marked/Rel-16/29_series/29163/33a8f3f01dfa8bce75d23017855a13c5_img.jpg b/marked/Rel-16/29_series/29163/33a8f3f01dfa8bce75d23017855a13c5_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8b880ea7950ef618038e8b7d947b6647ea160e9a --- /dev/null +++ b/marked/Rel-16/29_series/29163/33a8f3f01dfa8bce75d23017855a13c5_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f00995c151a7ad005c14c9006f290de4d1f27e6ebd972a471e1a2870991e4e66 +size 24905 diff --git a/marked/Rel-16/29_series/29163/4356776ca004ecba5d599667a155d7d4_img.jpg b/marked/Rel-16/29_series/29163/4356776ca004ecba5d599667a155d7d4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..bd9633b97efed910f3e14eb8086a712d8713b65d --- /dev/null +++ b/marked/Rel-16/29_series/29163/4356776ca004ecba5d599667a155d7d4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3b1d2a35d1d382f59cdb18bc3c838d6122f58241a4c217096c56002e2da652e5 +size 68494 diff --git a/marked/Rel-16/29_series/29163/474a819357587e34949a3e110ff19b30_img.jpg b/marked/Rel-16/29_series/29163/474a819357587e34949a3e110ff19b30_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1fa03df794effd3191107c67b6a94a8830dbc9de --- /dev/null +++ b/marked/Rel-16/29_series/29163/474a819357587e34949a3e110ff19b30_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:faeb9457b9a0bbc97c304328fdb0cfcb2b46c3c12c2f2227c354d0cb530e4fec +size 157808 diff --git a/marked/Rel-16/29_series/29163/4cd9eeaee1deb05bf88a8abf02ff7d7f_img.jpg b/marked/Rel-16/29_series/29163/4cd9eeaee1deb05bf88a8abf02ff7d7f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a4ad5e64f12d05ee34239c4d1b5096b20f24ba35 --- /dev/null +++ b/marked/Rel-16/29_series/29163/4cd9eeaee1deb05bf88a8abf02ff7d7f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3ce6c17f65017f7803a04767b432f6f23ae44130dd315b6d40291ca72b3f46b2 +size 29726 diff --git a/marked/Rel-16/29_series/29163/4e85fe330de2c4f5eea6de4b2a53c77f_img.jpg b/marked/Rel-16/29_series/29163/4e85fe330de2c4f5eea6de4b2a53c77f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..035694abb1e0464939510a26d3297f2adfa35bf4 --- /dev/null +++ b/marked/Rel-16/29_series/29163/4e85fe330de2c4f5eea6de4b2a53c77f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0b1d6602c38272ddbfefe7b0647a222a335add9212395ffe32409fc2d942e4b8 +size 100255 diff --git a/marked/Rel-16/29_series/29163/5043b1d06ff3f78c43f3432a4bae436d_img.jpg b/marked/Rel-16/29_series/29163/5043b1d06ff3f78c43f3432a4bae436d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5a8dd6d76a012ed29d891113fe2c60df5169ffd2 --- /dev/null +++ b/marked/Rel-16/29_series/29163/5043b1d06ff3f78c43f3432a4bae436d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:74d933eb72bdad6ab65f951a1b2afbcebea1337715c5e33c09f897326a3254e5 +size 21458 diff --git a/marked/Rel-16/29_series/29163/53e80f05e45f132bf76a96442a5507e9_img.jpg b/marked/Rel-16/29_series/29163/53e80f05e45f132bf76a96442a5507e9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a718ce03e0313265124c6120c50362a94c63420b --- /dev/null +++ b/marked/Rel-16/29_series/29163/53e80f05e45f132bf76a96442a5507e9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c6efd7059e772e2de3cfd852ef45bbc54b401fee83978fdcfdda06251e2fd7b8 +size 46945 diff --git a/marked/Rel-16/29_series/29163/53f1f7d17b3e7aae62169c41d2a88a77_img.jpg b/marked/Rel-16/29_series/29163/53f1f7d17b3e7aae62169c41d2a88a77_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..087ab4b2affbe449b79ed1a9c36bad29eab98940 --- /dev/null +++ b/marked/Rel-16/29_series/29163/53f1f7d17b3e7aae62169c41d2a88a77_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b5c7d3cb70a070f01369c8e6e0ddef69d51fac4b7004fd1556aa224b16fa8099 +size 24723 diff --git a/marked/Rel-16/29_series/29163/55136bc716146672fc680fa05989f1d2_img.jpg b/marked/Rel-16/29_series/29163/55136bc716146672fc680fa05989f1d2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b7457545e5747238007714da425f1c7a4410d042 --- /dev/null +++ b/marked/Rel-16/29_series/29163/55136bc716146672fc680fa05989f1d2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a82574356465d91d4529ae9547c84e32673ba595061fd1a25f3366eb3c31f7d2 +size 38442 diff --git a/marked/Rel-16/29_series/29163/5bba23cc120ad806779f82df1c01bebf_img.jpg b/marked/Rel-16/29_series/29163/5bba23cc120ad806779f82df1c01bebf_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5e12c83fa8a154aa54ebdf63d5f0e4d31e1ebfba --- /dev/null +++ b/marked/Rel-16/29_series/29163/5bba23cc120ad806779f82df1c01bebf_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7331ad2be06a2955d0559c7ba49e7c61e5aae538e9248351994afa4be2a4e503 +size 9992 diff --git a/marked/Rel-16/29_series/29163/5d5ec4f1999e7c46d426dddc16ba1e08_img.jpg b/marked/Rel-16/29_series/29163/5d5ec4f1999e7c46d426dddc16ba1e08_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..347b5108397acd42cdf94bbcccbba82a4b3f9fca --- /dev/null +++ b/marked/Rel-16/29_series/29163/5d5ec4f1999e7c46d426dddc16ba1e08_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:16ff6e65353e07a258109defd585f33d7f04ec792253b1bad246ea2f8116d917 +size 80493 diff --git a/marked/Rel-16/29_series/29163/5d782eeb9d1e5871d7f09e0ccdd4cdf1_img.jpg b/marked/Rel-16/29_series/29163/5d782eeb9d1e5871d7f09e0ccdd4cdf1_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ae22e24a99b2655b29b25498f9369295b2b3094b --- /dev/null +++ b/marked/Rel-16/29_series/29163/5d782eeb9d1e5871d7f09e0ccdd4cdf1_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cfd8bd93e0db07ed2430b49fae1e43b0f4818817fddd4b289a45e7270ac6da80 +size 53121 diff --git a/marked/Rel-16/29_series/29163/608f1b5ef8f3dc0723f2b4ea1fb72be2_img.jpg b/marked/Rel-16/29_series/29163/608f1b5ef8f3dc0723f2b4ea1fb72be2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..df9d49fd1ac2e557daba021b3b224afa35029637 --- /dev/null +++ b/marked/Rel-16/29_series/29163/608f1b5ef8f3dc0723f2b4ea1fb72be2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6f0d48f638ac5b903c28e7b213ecc034cda49e14bb0ec40846ab2cd76d5dbb93 +size 29808 diff --git a/marked/Rel-16/29_series/29163/61a49f3179b455e4d35242fc3d187a29_img.jpg b/marked/Rel-16/29_series/29163/61a49f3179b455e4d35242fc3d187a29_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..beb51ea38765108798e51cc9e2064306b40b7708 --- /dev/null +++ b/marked/Rel-16/29_series/29163/61a49f3179b455e4d35242fc3d187a29_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:afaa805333793d82debb0aa511a4e55116491d5678499b2220c5c4f29f12b113 +size 21804 diff --git a/marked/Rel-16/29_series/29163/61d000f6a2a1ff2f0da0b51fb732fafb_img.jpg b/marked/Rel-16/29_series/29163/61d000f6a2a1ff2f0da0b51fb732fafb_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f19af624ea1df4cd46174d1069d75d107eb7f944 --- /dev/null +++ b/marked/Rel-16/29_series/29163/61d000f6a2a1ff2f0da0b51fb732fafb_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:40943d84741d231ef15930188d4f6f12ee843dd940934e87346199e78ca3b15c +size 16050 diff --git a/marked/Rel-16/29_series/29163/6361dfaef83c9ffc3b147e1627ba76a1_img.jpg b/marked/Rel-16/29_series/29163/6361dfaef83c9ffc3b147e1627ba76a1_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..404231eadb4c1fdab418acf83744101e190f8d57 --- /dev/null +++ b/marked/Rel-16/29_series/29163/6361dfaef83c9ffc3b147e1627ba76a1_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9c13eed53f90c6b7c76cc5acce325dc8ca6b34fc66efee49ea375eea11c4d072 +size 39371 diff --git a/marked/Rel-16/29_series/29163/68d50e85fb8de4fae0e0eafaf20e63c0_img.jpg b/marked/Rel-16/29_series/29163/68d50e85fb8de4fae0e0eafaf20e63c0_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..57077833c515c3e4b35bf215dcdf48399acb8bb1 --- /dev/null +++ b/marked/Rel-16/29_series/29163/68d50e85fb8de4fae0e0eafaf20e63c0_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9a4b50f842d26ba2cfb85b53a8ccbb370005c41c42afc2532215ae99d3f59e69 +size 150295 diff --git a/marked/Rel-16/29_series/29163/69733eeb3ef32197543f66f22a431771_img.jpg b/marked/Rel-16/29_series/29163/69733eeb3ef32197543f66f22a431771_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9b5ef1d0736a5dd368fda9fd51598f339cc92d0d --- /dev/null +++ b/marked/Rel-16/29_series/29163/69733eeb3ef32197543f66f22a431771_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7b752bbe13575623bcf8fd3517353188e2e37feefa21f6b3ad7a34fec1cf3ed8 +size 29465 diff --git a/marked/Rel-16/29_series/29163/69edc2887e907309499ac95b47ab6905_img.jpg b/marked/Rel-16/29_series/29163/69edc2887e907309499ac95b47ab6905_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4b2648a180dbe647c6a1ce4669d35526260a6942 --- /dev/null +++ b/marked/Rel-16/29_series/29163/69edc2887e907309499ac95b47ab6905_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4197191aa48090248ee5f6628e30461230f44e71b5b29633972ed8114e711b35 +size 152187 diff --git a/marked/Rel-16/29_series/29163/6d67eee81b97a14e06a6fe57a95aff36_img.jpg b/marked/Rel-16/29_series/29163/6d67eee81b97a14e06a6fe57a95aff36_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..08991a413b8a21d3da31a203b32b2934a3e4b9ff --- /dev/null +++ b/marked/Rel-16/29_series/29163/6d67eee81b97a14e06a6fe57a95aff36_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5f750d7fd8fd673a7dfbcd23ac750d914d17af7d7b72cae0dfd4037202b2207a +size 43309 diff --git a/marked/Rel-16/29_series/29163/6e15fc9ea763541c5913d26f85072ae1_img.jpg b/marked/Rel-16/29_series/29163/6e15fc9ea763541c5913d26f85072ae1_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a916745daca6928d3e7466a0590fce5ac9b7ab2a --- /dev/null +++ b/marked/Rel-16/29_series/29163/6e15fc9ea763541c5913d26f85072ae1_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c71f863aaf7f204c2e04b0faa6ca8ee467d668037eb28599c31b73545324a78a +size 167699 diff --git a/marked/Rel-16/29_series/29163/735e3bc9f8e35ffd7d0a9f37d8da6afb_img.jpg b/marked/Rel-16/29_series/29163/735e3bc9f8e35ffd7d0a9f37d8da6afb_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f3ab6f33b89d59601935e77ba755576ab53e76f9 --- /dev/null +++ b/marked/Rel-16/29_series/29163/735e3bc9f8e35ffd7d0a9f37d8da6afb_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ec25eec6fd70be988f8eb7d47f37bd6270da80afb0fe1a729dc565441ac4afb2 +size 804 diff --git a/marked/Rel-16/29_series/29163/74d23510f27b21403a7be84820821863_img.jpg b/marked/Rel-16/29_series/29163/74d23510f27b21403a7be84820821863_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f02c3ad3a4339c7c5f8ab856063093965c737c3b --- /dev/null +++ b/marked/Rel-16/29_series/29163/74d23510f27b21403a7be84820821863_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:183e0b740abedf4057b80ee8b7dd7f8973c49b59cdc9c2bc4e4ebc399700d3f4 +size 155352 diff --git a/marked/Rel-16/29_series/29163/74e409e1548dd2606c4de9bdfe9806e4_img.jpg b/marked/Rel-16/29_series/29163/74e409e1548dd2606c4de9bdfe9806e4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3c6eb57b7f3c7c55514ef5b51730ee3ef6bed53d --- /dev/null +++ b/marked/Rel-16/29_series/29163/74e409e1548dd2606c4de9bdfe9806e4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c39e3fee7fe379aa2e850ddea4d8b1f0dd447d1be44e79e7ebb9526b442563c9 +size 8748 diff --git a/marked/Rel-16/29_series/29163/7913c315e0db8233cb1ac2455e4a0a81_img.jpg b/marked/Rel-16/29_series/29163/7913c315e0db8233cb1ac2455e4a0a81_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9da10b03c7af185c7b5079ad5ceda344d0941421 --- /dev/null +++ b/marked/Rel-16/29_series/29163/7913c315e0db8233cb1ac2455e4a0a81_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9f8f37e790b3e74ed28a0466e681e001c0cb098fab49e8a17e975ab6f8f2a45d +size 14440 diff --git a/marked/Rel-16/29_series/29163/7fe5741e83bc9702d1b1d7585ddf66bd_img.jpg b/marked/Rel-16/29_series/29163/7fe5741e83bc9702d1b1d7585ddf66bd_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4be5f90225051629fa7b35b5ee193b6c593c10d0 --- /dev/null +++ b/marked/Rel-16/29_series/29163/7fe5741e83bc9702d1b1d7585ddf66bd_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8cebbc546c741ae935af589a918b32b2a3cbd3059bf6676147c0566f9e3d4055 +size 42275 diff --git a/marked/Rel-16/29_series/29163/80d994053160f3b1d88b075564af9e57_img.jpg b/marked/Rel-16/29_series/29163/80d994053160f3b1d88b075564af9e57_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ac6eb822383effac5b6c99cab3d4f0c4546b3bdb --- /dev/null +++ b/marked/Rel-16/29_series/29163/80d994053160f3b1d88b075564af9e57_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9709174887654604e7b8ca19a574b69f379b055fb5f09d91aa0a0d9907522791 +size 42419 diff --git a/marked/Rel-16/29_series/29163/81a4cbf0b3c4cbc065efdf8f800dadde_img.jpg b/marked/Rel-16/29_series/29163/81a4cbf0b3c4cbc065efdf8f800dadde_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..370766f54fadaf29708ebc792baa7b0deb946023 --- /dev/null +++ b/marked/Rel-16/29_series/29163/81a4cbf0b3c4cbc065efdf8f800dadde_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:11f9e76808b931545e94fb95e8c2d90f1debd09a00a79b32f881e6157b143859 +size 67238 diff --git a/marked/Rel-16/29_series/29163/8269648391c59363ea61243864a2adf7_img.jpg b/marked/Rel-16/29_series/29163/8269648391c59363ea61243864a2adf7_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..527212876ac9175f3f324807c60f4f643ae6def0 --- /dev/null +++ b/marked/Rel-16/29_series/29163/8269648391c59363ea61243864a2adf7_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0c1369005187aac1dfbc4f6a87f60495e888b478a7e741a43191ca61d6e7e6e9 +size 92323 diff --git a/marked/Rel-16/29_series/29163/8277ec2f29c84d97cbe70bc413a42cd1_img.jpg b/marked/Rel-16/29_series/29163/8277ec2f29c84d97cbe70bc413a42cd1_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5cc684fa4aba92b0f7f628fea19b7de3eafd6645 --- /dev/null +++ b/marked/Rel-16/29_series/29163/8277ec2f29c84d97cbe70bc413a42cd1_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c7ea60a1602c592fb3652943096f8115f523ba27642e251283fbbef609205b73 +size 9099 diff --git a/marked/Rel-16/29_series/29163/848073118eebfdbfdb9a60e3923fe0b3_img.jpg b/marked/Rel-16/29_series/29163/848073118eebfdbfdb9a60e3923fe0b3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..939588a61a4efffbd2f9553957d92ff9b804af3d --- /dev/null +++ b/marked/Rel-16/29_series/29163/848073118eebfdbfdb9a60e3923fe0b3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1f417aa8fe2134995d1a4f777c0d5f4e3c14183cdb1cb6bbb327c0f101c82cbe +size 55903 diff --git a/marked/Rel-16/29_series/29163/88b0f3f4393228e9ea4d6542aef7c399_img.jpg b/marked/Rel-16/29_series/29163/88b0f3f4393228e9ea4d6542aef7c399_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6e9357fb89df53046573fb047c8fc8aa3d0f4b10 --- /dev/null +++ b/marked/Rel-16/29_series/29163/88b0f3f4393228e9ea4d6542aef7c399_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:41eadb8e9a38dc6c4318b1f2da428f0a05db8dba2a7fd8eeaa54b35ffef2d477 +size 80042 diff --git a/marked/Rel-16/29_series/29163/8edfc370769207831f060f44d2281084_img.jpg b/marked/Rel-16/29_series/29163/8edfc370769207831f060f44d2281084_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..78acb2b5baca087b66e64d2d2578dfaf53e7a649 --- /dev/null +++ b/marked/Rel-16/29_series/29163/8edfc370769207831f060f44d2281084_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:26a71cae1dccb5a3983a43371a2e60c3a2a95f4fc735cd1e6da086c796a14e28 +size 39908 diff --git a/marked/Rel-16/29_series/29163/8fa679f79a1bb1f527cba9f29e784e89_img.jpg b/marked/Rel-16/29_series/29163/8fa679f79a1bb1f527cba9f29e784e89_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2274d2ee1b11fc1cff40436cb475b837c0232ef6 --- /dev/null +++ b/marked/Rel-16/29_series/29163/8fa679f79a1bb1f527cba9f29e784e89_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a217979947a8761788be0bdbfc99d9a85bf3f64ef01107bff2b8db85921a646b +size 46750 diff --git a/marked/Rel-16/29_series/29163/8fecf981da2650d0a2832e4b9ac5c934_img.jpg b/marked/Rel-16/29_series/29163/8fecf981da2650d0a2832e4b9ac5c934_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..db3b580c58ab06c5af0b7afb20679b9e821bc626 --- /dev/null +++ b/marked/Rel-16/29_series/29163/8fecf981da2650d0a2832e4b9ac5c934_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:942b930ae1ab0c633e98c139e72e013549ae2cc5ac281e981112595725b53755 +size 15206 diff --git a/marked/Rel-16/29_series/29163/90ddb84c323b956e2d50a54d3f870566_img.jpg b/marked/Rel-16/29_series/29163/90ddb84c323b956e2d50a54d3f870566_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8bd7a49d95e11ba0917c9bfb95cc5a244049a827 --- /dev/null +++ b/marked/Rel-16/29_series/29163/90ddb84c323b956e2d50a54d3f870566_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a0e75d9a524cca878d32e0bb832370ff891af4ca4308f90aa0506fa573975613 +size 137665 diff --git a/marked/Rel-16/29_series/29163/9252ccfbbe9e34cb108f0060f2b563f1_img.jpg b/marked/Rel-16/29_series/29163/9252ccfbbe9e34cb108f0060f2b563f1_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..98241998572b41c174aff8a8f6b59797ef07ceca --- /dev/null +++ b/marked/Rel-16/29_series/29163/9252ccfbbe9e34cb108f0060f2b563f1_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4007de4abbf4f20bf1808c6eeb9fc46a2316350d278dadbf2823620b0466d693 +size 57660 diff --git a/marked/Rel-16/29_series/29163/977811d1c73b74f801be9f4c376694ca_img.jpg b/marked/Rel-16/29_series/29163/977811d1c73b74f801be9f4c376694ca_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..32d795d76d8b492c6f8922fb43f0e635f7c94d67 --- /dev/null +++ b/marked/Rel-16/29_series/29163/977811d1c73b74f801be9f4c376694ca_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f040ec5a14cfd9430de0f5912b7641d9850e674bebb0b6e359cddc6fd4df625f +size 161800 diff --git a/marked/Rel-16/29_series/29163/9870bf462aa0d916a16d14b5a100c60a_img.jpg b/marked/Rel-16/29_series/29163/9870bf462aa0d916a16d14b5a100c60a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5cd2b31629461e3ee248ae983e578c3c3db66505 --- /dev/null +++ b/marked/Rel-16/29_series/29163/9870bf462aa0d916a16d14b5a100c60a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2f91f0db38a0e4b687f86444ebe2138e6da7beebd14d6c8f00c17904e271dca2 +size 48189 diff --git a/marked/Rel-16/29_series/29163/9ae17964ddd9b814c7d905b1af2fddf2_img.jpg b/marked/Rel-16/29_series/29163/9ae17964ddd9b814c7d905b1af2fddf2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4737e1c7542af17a45c3c8a4740262ac3555746b --- /dev/null +++ b/marked/Rel-16/29_series/29163/9ae17964ddd9b814c7d905b1af2fddf2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a2f9e4f9570a33d0459eed4c5c34e6d5bee5b9320e67fe1ff4b3b7a830d87da9 +size 33142 diff --git a/marked/Rel-16/29_series/29163/9e4f582a5d5f6742d1372956db0f8f0b_img.jpg b/marked/Rel-16/29_series/29163/9e4f582a5d5f6742d1372956db0f8f0b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5abda095e9de8eda960f77d06e3d63301a87a7a2 --- /dev/null +++ b/marked/Rel-16/29_series/29163/9e4f582a5d5f6742d1372956db0f8f0b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0044f7765090cac58a959b3a1bffd858fa3f66cbe92152d7fce6ae4d685fea58 +size 13474 diff --git a/marked/Rel-16/29_series/29163/9e8ebf03cae78f4f81b697548c2d7250_img.jpg b/marked/Rel-16/29_series/29163/9e8ebf03cae78f4f81b697548c2d7250_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c035084ce737c4b36dfa844a70c755ad5f00058b --- /dev/null +++ b/marked/Rel-16/29_series/29163/9e8ebf03cae78f4f81b697548c2d7250_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b85a3917aa21152dce00d34cf46dbc9731e9f0bd84adfb6683893ffd7ecf0139 +size 14499 diff --git a/marked/Rel-16/29_series/29163/9f6dec4d4e9fde40bce018861ef1278e_img.jpg b/marked/Rel-16/29_series/29163/9f6dec4d4e9fde40bce018861ef1278e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b66158da95e77f3ea9efde4857b70b3214af45a1 --- /dev/null +++ b/marked/Rel-16/29_series/29163/9f6dec4d4e9fde40bce018861ef1278e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:feee8b81954592d62a34e0727698130f8877400894bf1452ea6617f6ab6706ef +size 49403 diff --git a/marked/Rel-16/29_series/29163/9f862801bce82634d3b5a1e0a195a799_img.jpg b/marked/Rel-16/29_series/29163/9f862801bce82634d3b5a1e0a195a799_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c60cc9ac8f692fa4d2c187799d7f94d1fa1e34a0 --- /dev/null +++ b/marked/Rel-16/29_series/29163/9f862801bce82634d3b5a1e0a195a799_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e940b7243edc50508f1778cfc4c26d0e671929e52b7d25a4a39c56cba3124d9d +size 78603 diff --git a/marked/Rel-16/29_series/29163/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg b/marked/Rel-16/29_series/29163/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5162db0e4eb1195d062d29957873a9d071d8d69c --- /dev/null +++ b/marked/Rel-16/29_series/29163/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:44a64e418ab2c336a8d6e0d4ea8d7349ab8e42ce0e1f4f6aa1790a3edbcc7eb0 +size 33020 diff --git a/marked/Rel-16/29_series/29163/a4b868a176f7e0448ee72483727e9f6f_img.jpg b/marked/Rel-16/29_series/29163/a4b868a176f7e0448ee72483727e9f6f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..15b3983c5281d3e9cd67d6e83ae007ae91bd2c8d --- /dev/null +++ b/marked/Rel-16/29_series/29163/a4b868a176f7e0448ee72483727e9f6f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b46e0e6e36f72ea6cd00c779b7907f0911d26d6e3111dcf14f414479303ed600 +size 8912 diff --git a/marked/Rel-16/29_series/29163/a5184899f915014fa38608754efcc9c7_img.jpg b/marked/Rel-16/29_series/29163/a5184899f915014fa38608754efcc9c7_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..55fcd9e9b19b04ef321fa1336686995c7825ab0e --- /dev/null +++ b/marked/Rel-16/29_series/29163/a5184899f915014fa38608754efcc9c7_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f998cf1d816d7261474946a076d0dd783621e30191f95cd3d9012917c05a7d91 +size 113853 diff --git a/marked/Rel-16/29_series/29163/a66383962afcd0f0458f0d45c101fabf_img.jpg b/marked/Rel-16/29_series/29163/a66383962afcd0f0458f0d45c101fabf_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3e6a3e94b7c23212aa913cf6332f5c015ad2000f --- /dev/null +++ b/marked/Rel-16/29_series/29163/a66383962afcd0f0458f0d45c101fabf_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:dbf15daa87f17a5844c53a389bbfb9de9db24c9979942b52f54d8bc4a786dfa5 +size 9071 diff --git a/marked/Rel-16/29_series/29163/a8f498be9c286684f48a3eb211ce4cea_img.jpg b/marked/Rel-16/29_series/29163/a8f498be9c286684f48a3eb211ce4cea_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9fd98ab95744388aa873269048a4027c0404c498 --- /dev/null +++ b/marked/Rel-16/29_series/29163/a8f498be9c286684f48a3eb211ce4cea_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5f89ef9d151b7bb7292ae8ba62e2b0075ce588c0fb31e3eb1b21edb1263a2072 +size 9749 diff --git a/marked/Rel-16/29_series/29163/aa73c8651865e31f7a2f7b8a9c068461_img.jpg b/marked/Rel-16/29_series/29163/aa73c8651865e31f7a2f7b8a9c068461_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..64642cb917ea32b0abebce7e89c95432f120f022 --- /dev/null +++ b/marked/Rel-16/29_series/29163/aa73c8651865e31f7a2f7b8a9c068461_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cb537506fbd8f2dc6543572266c341cfe874a25d7e3a755fa6fb5a81e6ab98fa +size 25386 diff --git a/marked/Rel-16/29_series/29163/ae53f90bb87d6d09e2d6b5278d7c338f_img.jpg b/marked/Rel-16/29_series/29163/ae53f90bb87d6d09e2d6b5278d7c338f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..08c4c24964c664e6525211ac29ce6bcb0de739a1 --- /dev/null +++ b/marked/Rel-16/29_series/29163/ae53f90bb87d6d09e2d6b5278d7c338f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3f814e79623e9bb8d487d6ba4334cbe90474722b8c104847b3cf35192491c07e +size 167685 diff --git a/marked/Rel-16/29_series/29163/b0384c8e0ff826a8116ab2ff67dadc43_img.jpg b/marked/Rel-16/29_series/29163/b0384c8e0ff826a8116ab2ff67dadc43_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ef0b5250b6cf2f961d31324fa70315f9b2c54f32 --- /dev/null +++ b/marked/Rel-16/29_series/29163/b0384c8e0ff826a8116ab2ff67dadc43_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1a7cb1c58b95d66b9f3a808fd8e1151c2e58118af611de6dae3dcbbb3ce77961 +size 39596 diff --git a/marked/Rel-16/29_series/29163/b34c69e1ec326b01c3a485b27b1df5f6_img.jpg b/marked/Rel-16/29_series/29163/b34c69e1ec326b01c3a485b27b1df5f6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d8f5d0869c422b81f7d07343d47119296ac16676 --- /dev/null +++ b/marked/Rel-16/29_series/29163/b34c69e1ec326b01c3a485b27b1df5f6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:03db1ea3887dd6c0982d0894ee310f638f2320fa7baf3e6da84b3f5053edc325 +size 21181 diff --git a/marked/Rel-16/29_series/29163/b50f38be091844d58b11e3d47bc71e73_img.jpg b/marked/Rel-16/29_series/29163/b50f38be091844d58b11e3d47bc71e73_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c1706ad5b3bc6654a2e76a5294ad6e3d14e8eae9 --- /dev/null +++ b/marked/Rel-16/29_series/29163/b50f38be091844d58b11e3d47bc71e73_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8e82e1524f3a6163be067fddd993f9f218c71914d1beeace9a96607528fe0eb7 +size 67414 diff --git a/marked/Rel-16/29_series/29163/b51423b6c049f5b5fcde42e50b58f18b_img.jpg b/marked/Rel-16/29_series/29163/b51423b6c049f5b5fcde42e50b58f18b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b79c275fc9dfa58df8cb59f913fee7dfa484d968 --- /dev/null +++ b/marked/Rel-16/29_series/29163/b51423b6c049f5b5fcde42e50b58f18b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3adf0b29f4f3e7d50565f69834ede2bbd2e598c93e8cf108431c91d3ae4f5155 +size 48144 diff --git a/marked/Rel-16/29_series/29163/b5987d63203a5fa601921039922ac520_img.jpg b/marked/Rel-16/29_series/29163/b5987d63203a5fa601921039922ac520_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..955f2a0272c84a394ff9daddb6e1311102b135a4 --- /dev/null +++ b/marked/Rel-16/29_series/29163/b5987d63203a5fa601921039922ac520_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e10578220044c3110221bdb341be5754c075812369a11bb678e9a0f4ec842858 +size 78835 diff --git a/marked/Rel-16/29_series/29163/b8efedb73292a798b3f2050f9335cae6_img.jpg b/marked/Rel-16/29_series/29163/b8efedb73292a798b3f2050f9335cae6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..398229b7e1a90d87bc49fe76b6fd7f7b4b4b12fa --- /dev/null +++ b/marked/Rel-16/29_series/29163/b8efedb73292a798b3f2050f9335cae6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:21fa4fb98f59c04c58820718acbd8c455f3d8101a13b29455a9b6bd7a31f3c56 +size 21570 diff --git a/marked/Rel-16/29_series/29163/be3e5fe8be7cc5a74f67a4b8ac93193d_img.jpg b/marked/Rel-16/29_series/29163/be3e5fe8be7cc5a74f67a4b8ac93193d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c7721d62cdfcdec29f82c946732aa99c60a31724 --- /dev/null +++ b/marked/Rel-16/29_series/29163/be3e5fe8be7cc5a74f67a4b8ac93193d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d67104f9a8268df795decb62e1e7449471cf5c0ac0abfb29554e9efd1109ccde +size 133650 diff --git a/marked/Rel-16/29_series/29163/bf32ff2a1af507083217ccc56c515a50_img.jpg b/marked/Rel-16/29_series/29163/bf32ff2a1af507083217ccc56c515a50_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8e68caf545181abafc314079c3a4e01d93de84c1 --- /dev/null +++ b/marked/Rel-16/29_series/29163/bf32ff2a1af507083217ccc56c515a50_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e9dbbfb5fa337c0f1ab1be06760598ac1e2ec100f05b31d862153a33137fcc25 +size 8112 diff --git a/marked/Rel-16/29_series/29163/c036e2540a94b31357ceb0002f0cacab_img.jpg b/marked/Rel-16/29_series/29163/c036e2540a94b31357ceb0002f0cacab_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b6fbf1be70bca0aca67657b077e831a21341c631 --- /dev/null +++ b/marked/Rel-16/29_series/29163/c036e2540a94b31357ceb0002f0cacab_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4c1b6bb8b8c991ac70e7c39d350fe92ade4849d366ed8c3bb77eff5224ca62b6 +size 38341 diff --git a/marked/Rel-16/29_series/29163/c0ca823603794512478906b302176bca_img.jpg b/marked/Rel-16/29_series/29163/c0ca823603794512478906b302176bca_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..908cf0f421f4cb39dc0529a61aa02100cb2eae2f --- /dev/null +++ b/marked/Rel-16/29_series/29163/c0ca823603794512478906b302176bca_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f42bcb12d0d9677e089c2c2e59f0b596780a494baf190d358cfb82e585102a3d +size 18693 diff --git a/marked/Rel-16/29_series/29163/c21bad844b5cb6026c067a1f43ce67c3_img.jpg b/marked/Rel-16/29_series/29163/c21bad844b5cb6026c067a1f43ce67c3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3a737b24b80fd098c8b0f65a8156e3996b5f5334 --- /dev/null +++ b/marked/Rel-16/29_series/29163/c21bad844b5cb6026c067a1f43ce67c3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d191e3aa73514a8032d8231d8fe213af319cee06bf6981983d4a636355f902f5 +size 163229 diff --git a/marked/Rel-16/29_series/29163/c6005b2627c6ca10f6b0e94cdb34858d_img.jpg b/marked/Rel-16/29_series/29163/c6005b2627c6ca10f6b0e94cdb34858d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e8c2c67f4ae24e22fec792b4c97c2c40ae5dde6d --- /dev/null +++ b/marked/Rel-16/29_series/29163/c6005b2627c6ca10f6b0e94cdb34858d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:53e73d57523a4db5d76c95368ad457e8da8d06f95850256218243b798e36f958 +size 24850 diff --git a/marked/Rel-16/29_series/29163/c686c005fef31702c109f5d9dd975413_img.jpg b/marked/Rel-16/29_series/29163/c686c005fef31702c109f5d9dd975413_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..bfe959ae2d94cc327b6970308257b513520888e9 --- /dev/null +++ b/marked/Rel-16/29_series/29163/c686c005fef31702c109f5d9dd975413_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4963935f02bf81a3cbed66380382100e6ca6d942ba0de9c0ce6b4ffb28ae1996 +size 7410 diff --git a/marked/Rel-16/29_series/29163/c99bf3a0530a3e58f5f2d2790ba7441b_img.jpg b/marked/Rel-16/29_series/29163/c99bf3a0530a3e58f5f2d2790ba7441b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..25451f761593cc66b2a1be7bd8abfb955689e213 --- /dev/null +++ b/marked/Rel-16/29_series/29163/c99bf3a0530a3e58f5f2d2790ba7441b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5b044df14dc12cefeda973662ed5f2ff49bdc442a77994f3a8a4c40456008a0a +size 81755 diff --git a/marked/Rel-16/29_series/29163/ca5dc5fde2061d0ca2051ef7840fc842_img.jpg b/marked/Rel-16/29_series/29163/ca5dc5fde2061d0ca2051ef7840fc842_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6b076a93f999702e7ea0cae7a7d24b47f1f130bf --- /dev/null +++ b/marked/Rel-16/29_series/29163/ca5dc5fde2061d0ca2051ef7840fc842_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:91fa58838e3f6bb63f1c5089cd7c5f1174ce1cc16c8e438fb180fed965165c87 +size 53014 diff --git a/marked/Rel-16/29_series/29163/cb698d64c91df5a86b05bbddc202c144_img.jpg b/marked/Rel-16/29_series/29163/cb698d64c91df5a86b05bbddc202c144_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..058ff8e1f7dd0b49d990a656a6a23e0b04f55e61 --- /dev/null +++ b/marked/Rel-16/29_series/29163/cb698d64c91df5a86b05bbddc202c144_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:778f5b442baf73bdcfdbb1ee005e27a4bd2134a0583d2b6b8d7bc37b49055695 +size 18951 diff --git a/marked/Rel-16/29_series/29163/ccf6853c7291703cb04568057fef5849_img.jpg b/marked/Rel-16/29_series/29163/ccf6853c7291703cb04568057fef5849_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4a2aa1bccd4adcd677491570cf22594760053f95 --- /dev/null +++ b/marked/Rel-16/29_series/29163/ccf6853c7291703cb04568057fef5849_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:de3ea810dcc0c462b13c39ca0b450947f90381778dfd47b921b3fc7d90811036 +size 32897 diff --git a/marked/Rel-16/29_series/29163/d0abac95583b52a3b35f74a215567334_img.jpg b/marked/Rel-16/29_series/29163/d0abac95583b52a3b35f74a215567334_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..76e8ba39ae37aeb2c72c590edc719a1e9c5d74ec --- /dev/null +++ b/marked/Rel-16/29_series/29163/d0abac95583b52a3b35f74a215567334_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:614cf72778b04a02655505853d9d71bc73a0e804e415eadccf8423647daab679 +size 61578 diff --git a/marked/Rel-16/29_series/29163/d2517ac00a9e8064ae23cb653e651d1b_img.jpg b/marked/Rel-16/29_series/29163/d2517ac00a9e8064ae23cb653e651d1b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5d2b4e6e13158ff6bfb40aca90e0434e7496d7a4 --- /dev/null +++ b/marked/Rel-16/29_series/29163/d2517ac00a9e8064ae23cb653e651d1b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:523e8185936beebb35d410fd3b273a44e05986e576571a447bf86a5cdb9fd369 +size 905 diff --git a/marked/Rel-16/29_series/29163/d31e6cf9a987586abee2f530b7812041_img.jpg b/marked/Rel-16/29_series/29163/d31e6cf9a987586abee2f530b7812041_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1c1af61a7b17567e23c1f7a0d345b8352a3b0e5e --- /dev/null +++ b/marked/Rel-16/29_series/29163/d31e6cf9a987586abee2f530b7812041_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7d19f5b05e5e5d570a39d02e4a2bddbd5cdb1a65386e3cf3b601786105cf65bd +size 7350 diff --git a/marked/Rel-16/29_series/29163/dc37a040cf9e2add7488c7c37cbf3687_img.jpg b/marked/Rel-16/29_series/29163/dc37a040cf9e2add7488c7c37cbf3687_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7fbc008f759224b786b04bf78a231098629db945 --- /dev/null +++ b/marked/Rel-16/29_series/29163/dc37a040cf9e2add7488c7c37cbf3687_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b3c03f66b2f660e3c2bba2b034ecd6e792fbf4bcea172417a1a51009c8d38c66 +size 16935 diff --git a/marked/Rel-16/29_series/29163/dd5771673aececa53d42ece89218299d_img.jpg b/marked/Rel-16/29_series/29163/dd5771673aececa53d42ece89218299d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9c57a93662409a5d23116e67d0e894d27316e27c --- /dev/null +++ b/marked/Rel-16/29_series/29163/dd5771673aececa53d42ece89218299d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:60cd6354965b5c99dcb39c9b7fff66a4ae25d647d2af2ebc7a8643d66de51f9f +size 132459 diff --git a/marked/Rel-16/29_series/29163/ddb58f51e65a3ae8ebc5911df26e18e0_img.jpg b/marked/Rel-16/29_series/29163/ddb58f51e65a3ae8ebc5911df26e18e0_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4ce1d3a554e12323eb141a4ac8ebe34ccfb45d63 --- /dev/null +++ b/marked/Rel-16/29_series/29163/ddb58f51e65a3ae8ebc5911df26e18e0_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fdfb8e04394a304feb9b2080858d7c9bd7728a9381c98b268845e6fa3ed9d24f +size 80449 diff --git a/marked/Rel-16/29_series/29163/e05c1a13b44ab41505609d82b00cf4df_img.jpg b/marked/Rel-16/29_series/29163/e05c1a13b44ab41505609d82b00cf4df_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..62a4a728d442c079c73cee835200fc2d3f42d9c6 --- /dev/null +++ b/marked/Rel-16/29_series/29163/e05c1a13b44ab41505609d82b00cf4df_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:54e5c956746688ddd55276fb58794be1a1a27c6c39a24f2e2b3c8a84880591d2 +size 107982 diff --git a/marked/Rel-16/29_series/29163/e16bfa31d748f4d99ec4ae3d16656926_img.jpg b/marked/Rel-16/29_series/29163/e16bfa31d748f4d99ec4ae3d16656926_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d15a33960dca01fbca79e9aa5d097dd21bf2fd3a --- /dev/null +++ b/marked/Rel-16/29_series/29163/e16bfa31d748f4d99ec4ae3d16656926_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6e550aee988c3f427dbd7ed08318bafe5342b8b6772d36811d97fb04656860df +size 23022 diff --git a/marked/Rel-16/29_series/29163/e180f2b5fcbe8001554a7c0677cd3f82_img.jpg b/marked/Rel-16/29_series/29163/e180f2b5fcbe8001554a7c0677cd3f82_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..356be10d14c3814ae533f050558ff19c03a9310a --- /dev/null +++ b/marked/Rel-16/29_series/29163/e180f2b5fcbe8001554a7c0677cd3f82_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:443dc257bb967e6ab2a82e0ec242a89b19ae9da06c7cd6a72b2360055e09e0be +size 125416 diff --git a/marked/Rel-16/29_series/29163/e26bb66586e464339df27951d5c9355e_img.jpg b/marked/Rel-16/29_series/29163/e26bb66586e464339df27951d5c9355e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f46dc1b6ecaea93246f5e80d1edadf048d9d8e24 --- /dev/null +++ b/marked/Rel-16/29_series/29163/e26bb66586e464339df27951d5c9355e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c5de98eebe5932b395eeb10d1497edd64d649fbb174500b0e56c281c6358ed2c +size 66861 diff --git a/marked/Rel-16/29_series/29163/e35f25e0b66752d4179a4cb108a3fb5a_img.jpg b/marked/Rel-16/29_series/29163/e35f25e0b66752d4179a4cb108a3fb5a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6c32f108694b87233a0f313c3f9f725320183d8a --- /dev/null +++ b/marked/Rel-16/29_series/29163/e35f25e0b66752d4179a4cb108a3fb5a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b683105e136427f8dca26eadb5f9196051b120e7e599c7020de8deb2665d5163 +size 28590 diff --git a/marked/Rel-16/29_series/29163/e534e903e6dae8a582643bfd9f89254c_img.jpg b/marked/Rel-16/29_series/29163/e534e903e6dae8a582643bfd9f89254c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b1b8f6d125e3acfe2aedabaf6b6fd1bb171fb560 --- /dev/null +++ b/marked/Rel-16/29_series/29163/e534e903e6dae8a582643bfd9f89254c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1ab9e5c8ad00bd01f327a89a2226f4b53da8d495c83bada2e3fe43cb51f8811e +size 12488 diff --git a/marked/Rel-16/29_series/29163/e64106d52dee350a3439ff0d396d26fc_img.jpg b/marked/Rel-16/29_series/29163/e64106d52dee350a3439ff0d396d26fc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..15afd6ebab94449ed419d610e4fdbadf277e6399 --- /dev/null +++ b/marked/Rel-16/29_series/29163/e64106d52dee350a3439ff0d396d26fc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a030209f091d210d571b0f829a7732944bc733b67e26215f0f9889620c0aa1bf +size 13426 diff --git a/marked/Rel-16/29_series/29163/f5e131a3fffe09aa98db055df84e4378_img.jpg b/marked/Rel-16/29_series/29163/f5e131a3fffe09aa98db055df84e4378_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9d4f7c94a01508c8498801c14c3efa0b95aefc7c --- /dev/null +++ b/marked/Rel-16/29_series/29163/f5e131a3fffe09aa98db055df84e4378_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1deffa94f74c4aaa1836455910ea6ab8c5ec17043015eeff9918a6b6d0bc9b64 +size 26599 diff --git a/marked/Rel-16/29_series/29163/fc0cdcafc5389b99674ba116c9787ffd_img.jpg b/marked/Rel-16/29_series/29163/fc0cdcafc5389b99674ba116c9787ffd_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..16b7f16aa1db4d051a6f9ee9aa977134f3091f1d --- /dev/null +++ b/marked/Rel-16/29_series/29163/fc0cdcafc5389b99674ba116c9787ffd_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a9e3cec9f965949c6289c3aeab3f5f544c0af777b238ef4eea1f63cdc7279f70 +size 15741 diff --git a/marked/Rel-16/29_series/29163/fe7304192caf64cda93b580c5e7e5c06_img.jpg b/marked/Rel-16/29_series/29163/fe7304192caf64cda93b580c5e7e5c06_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a91c8d52cc6966bbc3ab2dbe3bf9c3ee1b1aac41 --- /dev/null +++ b/marked/Rel-16/29_series/29163/fe7304192caf64cda93b580c5e7e5c06_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:003378b34ac9edf94504ac71dd3227511bc2516a4426b8d9a3c22ced012a996a +size 30975 diff --git a/marked/Rel-16/29_series/29163/ff0952ef692c9d960ce5f6708bcc9711_img.jpg b/marked/Rel-16/29_series/29163/ff0952ef692c9d960ce5f6708bcc9711_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f6bcc55018db042a0d8b130c40aea08e8a2e4d6c --- /dev/null +++ b/marked/Rel-16/29_series/29163/ff0952ef692c9d960ce5f6708bcc9711_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6e97d5c172c665357e96083c2368bcf8b9da40c36e7fa7c24c4d659099520c16 +size 66294 diff --git a/marked/Rel-16/29_series/29163/ffefa4f6eab4ce450aa5ecd3d3fd70bb_img.jpg b/marked/Rel-16/29_series/29163/ffefa4f6eab4ce450aa5ecd3d3fd70bb_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..bdf1709de556c84cfdf311b3660f20e748733f32 --- /dev/null +++ b/marked/Rel-16/29_series/29163/ffefa4f6eab4ce450aa5ecd3d3fd70bb_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f30c391e48560259a52deed953a734c05a4b2ddede6e01c4c4adc0abad3b079b +size 27532 diff --git a/marked/Rel-16/29_series/29163/raw.md b/marked/Rel-16/29_series/29163/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..2562d218a4e69dcbe17fc4764e4bf3227c6da599 --- /dev/null +++ b/marked/Rel-16/29_series/29163/raw.md @@ -0,0 +1,12585 @@ +Error: + +2 + +Error: Reference source not found + +# Contents + +| | | +|-----------------------------------------------------------------------------------|----| +| Foreword..... | 18 | +| 1 Scope..... | 19 | +| 2 References..... | 19 | +| 3 Definitions and abbreviations..... | 25 | +| 3.1 Definitions..... | 25 | +| 3.2 Abbreviations..... | 26 | +| 4 General..... | 28 | +| 4.1 General interworking overview..... | 28 | +| 5 Network characteristics..... | 28 | +| 5.1 Key characteristics of ISUP/BICC based CS networks..... | 28 | +| 5.2 Key characteristics of IM CN subsystem..... | 29 | +| 6 Interworking with CS networks..... | 29 | +| 6.1 Interworking reference model..... | 29 | +| 6.1.1 Interworking reference points and interfaces..... | 29 | +| 6.1.2 Interworking functional entities..... | 30 | +| 6.1.2.1 Signalling Gateway Function (SGW)..... | 30 | +| 6.1.2.2 Media Gateway Control Function (MGCF)..... | 30 | +| 6.1.2.3 IP Multimedia - Media Gateway Function (IM-MGW)..... | 30 | +| 6.2 Control plane interworking model..... | 30 | +| 6.3 User plane interworking model..... | 30 | +| 7 Control plane interworking..... | 30 | +| 7.1 General..... | 31 | +| 7.2 Interworking between CS networks supporting ISUP and the IM CN subsystem..... | 31 | +| 7.2.1 Services performed by network entities in the control plane..... | 32 | +| 7.2.1.1 Services performed by the SS7 signalling function..... | 32 | +| 7.2.1.2 Services of the SGW..... | 32 | +| 7.2.1.3 Services of the MGCF..... | 32 | +| 7.2.1.4 Services of the SIP signalling function..... | 32 | +| 7.2.2 Signalling interactions between network entities in the control plane..... | 32 | +| 7.2.2.1 Signalling between the SS7 signalling function and MGCF..... | 32 | +| 7.2.2.1.1 Signalling from MGCF to SS7 signalling function..... | 32 | +| 7.2.2.1.2 Signalling from SS7 signalling function to MGCF..... | 33 | +| 7.2.2.1.3 Services offered by SCTP and M3UA..... | 33 | +| 7.2.2.1.3.1 Services offered by SCTP..... | 33 | +| 7.2.2.1.3.2 Services offered by M3UA..... | 33 | +| 7.2.2.2 Signalling between the MGCF and SIP signalling function..... | 33 | +| 7.2.3 SIP-ISUP protocol interworking..... | 33 | +| 7.2.3.1 Incoming call interworking from SIP to ISUP at I-MGCF..... | 33 | +| 7.2.3.1.1 Sending of IAM..... | 33 | +| 7.2.3.1.2 Coding of the IAM..... | 35 | +| 7.2.3.1.2.0 General..... | 35 | +| 7.2.3.1.2.1 Called party number..... | 35 | +| 7.2.3.1.2.2 Nature of connection indicators..... | 36 | +| 7.2.3.1.2.3 Forward call indicators..... | 37 | +| 7.2.3.1.2.4 Calling party's category..... | 38 | +| 7.2.3.1.2.4A Originating Line Information..... | 38 | +| 7.2.3.1.2.5 Transmission medium requirement..... | 38 | +| 7.2.3.1.2.5a Transmission medium requirement prime and USI prime (optional)..... | 40 | +| 7.2.3.1.2.6 Calling party number..... | 42 | +| 7.2.3.1.2.7 Generic number..... | 46 | +| 7.2.3.1.2.8 User service information..... | 46 | +| 7.2.3.1.2.9 Hop Counter (National option)..... | 47 | + +| | | | +|-----------------|------------------------------------------------------------------------------------------|----| +| 7.2.3.1.2.10 | Progress Indicator..... | 47 | +| 7.2.3.1.2.11 | Location Number..... | 47 | +| 7.2.3.1.2.12 | Support of ICS call..... | 49 | +| 7.2.3.1.2.13 | UID capability indicators (National option)..... | 49 | +| 7.2.3.1.2.14 | Called IN number and original called IN number (optional)..... | 50 | +| 7.2.3.1.2.A | Coding of the IAM when Number Portability is supported..... | 50 | +| 7.2.3.1.2.A.1 | Coding of the IAM when a Number Portability Routing Number is available..... | 50 | +| 7.2.3.1.2.A.1.1 | Separate Directory Number Addressing Method..... | 51 | +| 7.2.3.1.2.A.1.2 | Concatenated Addressing Method..... | 52 | +| 7.2.3.1.2.A.1.3 | Separate Network Routing Number Addressing Method..... | 52 | +| 7.2.3.1.2.A.2 | Number Portability Forward Information..... | 53 | +| 7.2.3.1.2.B | Coding of the IAM for Carrier Routeing..... | 53 | +| 7.2.3.1.2.B.1 | Coding of the IAM when a Carrier Identification Code (CIC) is present..... | 53 | +| 7.2.3.1.2.B.2 | Void..... | 53 | +| 7.2.3.1.3 | Sending of COT..... | 53 | +| 7.2.3.1.3.A | Sending of SAM..... | 54 | +| 7.2.3.1.3.A.1 | General..... | 54 | +| 7.2.3.1.3.A.2 | Additional digits received in in-dialog SIP INFO requests..... | 54 | +| 7.2.3.1.3.A.3 | Additional digits received in SIP INVITE requests..... | 54 | +| 7.2.3.1.4 | Sending of 180 ringing..... | 55 | +| 7.2.3.1.4.0 | General..... | 55 | +| 7.2.3.1.4.0a | PSTN XML body..... | 56 | +| 7.2.3.1.4.0b | Fallback by I-MGCF..... | 57 | +| 7.2.3.1.4.1 | Fallback in a succeeding network: Transmission Medium Used parameter (TMU) received..... | 58 | +| 7.2.3.1.4.A | Sending of 183 Session Progress for early media scenarios..... | 58 | +| 7.2.3.1.4.B | Sending of 181Call is being forwarded..... | 61 | +| 7.2.3.1.4.C | Sending of 183 Session Progress for overlap signalling using the in-dialog method..... | 62 | +| 7.2.3.1.4.D | Sending of 183 Session Progress to carry ISUP Cause..... | 62 | +| 7.2.3.1.4.E | Sending of 183 Session Progress for ICS call..... | 62 | +| 7.2.3.1.5 | Sending of the 200 OK (INVITE)..... | 63 | +| 7.2.3.1.6 | Sending of the Release message (REL)..... | 65 | +| 7.2.3.1.7 | Coding of the REL..... | 65 | +| 7.2.3.1.8 | Receipt of the Release Message..... | 67 | +| 7.2.3.1.9 | Receipt of RSC, GRS or CGB (H/W oriented)..... | 70 | +| 7.2.3.1.9a | Receipt of REFER..... | 70 | +| 7.2.3.1.10 | Autonomous Release at I-MGCF..... | 71 | +| 7.2.3.1.11 | Internal through connection of the bearer path..... | 71 | +| 7.2.3.2 | Outgoing Call Interworking from ISUP to SIP at O-MGCF..... | 71 | +| 7.2.3.2.1 | Sending of INVITE..... | 71 | +| 7.2.3.2.1.1 | General..... | 71 | +| 7.2.3.2.1.2 | Interaction with continuity check..... | 72 | +| 7.2.3.2.1.3 | IAM without calling party number..... | 72 | +| 7.2.3.2.1.4 | Terminating overlap signalling at MGCF..... | 73 | +| 7.2.3.2.1.5 | Fallback (optional)..... | 73 | +| 7.2.3.2.1a | Sending of INVITE without determining the end of address signalling..... | 74 | +| 7.2.3.2.1a.1 | General..... | 74 | +| 7.2.3.2.1a.2 | Additional digits sent with in-dialog overlap method..... | 74 | +| 7.2.3.2.1a.3 | Additional digits sent using the multiple INVITEs overlap method..... | 75 | +| 7.2.3.2.2 | Coding of the INVITE..... | 76 | +| 7.2.3.2.2.0 | Overview..... | 76 | +| 7.2.3.2.2.1 | Request-URI and To header field..... | 76 | +| 7.2.3.2.2.2 | SDP Media Description..... | 77 | +| 7.2.3.2.2.3 | P-Asserted-Identity, From and Privacy header fields..... | 80 | +| 7.2.3.2.2.3.A | "cpc" URI Parameter in P-Asserted-Identity Header..... | 85 | +| 7.2.3.2.2.3.B | "oli" URI Parameter in P-Asserted-Identity Header..... | 85 | +| 7.2.3.2.2.4 | Max Forwards header..... | 86 | +| 7.2.3.2.2.5 | IMS Communication Service Identifier..... | 86 | +| 7.2.3.2.2.6 | P-Early-Media header field..... | 86 | + +| | | | +|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------|-----| +| 7.2.3.2.2.7 | PSTN XML elements..... | 86 | +| 7.2.3.2.2.8 | Progress indicator..... | 87 | +| 7.2.3.2.2.9 | P-Access-Network-Info..... | 88 | +| 7.2.3.2.2.A | Coding of the INVITE when Number Portability is supported..... | 88 | +| 7.2.3.2.2.A.1 | Request-URI and To header field..... | 88 | +| 7.2.3.2.2.A.1.1 | Separate Directory Number Addressing Method..... | 89 | +| 7.2.3.2.2.A.1.2 | Concatenated Addressing Method..... | 89 | +| 7.2.3.2.2.A.1.3 | Separate Network Routing Number Addressing Method..... | 90 | +| 7.2.3.2.2.B | Coding of the INVITE for Carrier Routeing..... | 90 | +| 7.2.3.2.2.B.1 | Mapping of "cic" in Request-URI..... | 90 | +| 7.2.3.2.2.B.2 | Void..... | 90 | +| 7.2.3.2.2.C | Coding of INVITE with instance-id in form of IMEI URN..... | 90 | +| 7.2.3.2.2.10 | PSAP Call-back indication..... | 91 | +| 7.2.3.2.2.11 | History-Info header field (optional)..... | 91 | +| 7.2.3.2.3 | Receipt of CONTINUITY..... | 91 | +| 7.2.3.2.4 | Sending of ACM and awaiting answer indication..... | 92 | +| 7.2.3.2.5 | Coding of the ACM..... | 94 | +| 7.2.3.2.5.0 | General..... | 94 | +| 7.2.3.2.5.1 | Backward call indicators..... | 95 | +| 7.2.3.2.5.2 | Optional Backward call indicators..... | 96 | +| 7.2.3.2.5.3 | Access Transport Parameter, Transmission medium used parameter..... | 96 | +| 7.2.3.2.5.4 | Progress indicator..... | 97 | +| 7.2.3.2.5.5 | Cause Value..... | 97 | +| 7.2.3.2.6 | Sending of the Call Progress message (CPG)..... | 97 | +| 7.2.3.2.6.0 | General..... | 97 | +| 7.2.3.2.6.1 | Handling of the progress indicator..... | 99 | +| 7.2.3.2.7 | Coding of the CPG..... | 99 | +| 7.2.3.2.7.0 | General..... | 99 | +| 7.2.3.2.7.1 | Event information..... | 100 | +| 7.2.3.2.7.2 | Access Transport Parameter..... | 100 | +| 7.2.3.2.7.3 | Void..... | 100 | +| 7.2.3.2.7.4 | Handling of Backward Call indicators..... | 100 | +| 7.2.3.2.7.5 | Optional Backward call indicators..... | 100 | +| 7.2.3.2.7.6 | Cause Value..... | 100 | +| 7.2.3.2.7.a | Receipt of 200 OK(INVITE)..... | 101 | +| 7.2.3.2.7.b | Internal through connection of the bearer path..... | 101 | +| 7.2.3.2.8 | Sending of the Answer Message (ANM)..... | 101 | +| 7.2.3.2.9 | Coding of the ANM..... | 101 | +| 7.2.3.2.9.1 | Backwards Call Indicators..... | 101 | +| 7.2.3.2.9.2 | Access Transport Parameter..... | 101 | +| 7.2.3.2.9.3 | Transmission Medium Used parameter (TMU)..... | 102 | +| 7.2.3.2.10 | Sending of the Connect message (CON)..... | 103 | +| 7.2.3.2.11 | Coding of the CON..... | 103 | +| 7.2.3.2.11.0 | General..... | 103 | +| 7.2.3.2.11.1 | Backward call indicators..... | 103 | +| 7.2.3.2.11.2 | Access Transport Parameter..... | 103 | +| 7.2.3.2.11.3 | Transmission medium used parameter..... | 103 | +| 7.2.3.2.11.A | Receipt of a reINVITE request..... | 103 | +| 7.2.3.2.12 | Receipt of Status Codes 4xx, 5xx or 6xx..... | 103 | +| 7.2.3.2.12.1 | Special handling of 404 Not Found and 484 Address Incomplete responses after sending of INVITE without determining the end of address signalling..... | 106 | +| 7.2.3.2.13 | Receipt of a BYE..... | 106 | +| 7.2.3.2.14 | Receipt of the Release Message..... | 106 | +| 7.2.3.2.15 | Receipt of RSC, GRS or CGB (H/W oriented)..... | 107 | +| 7.2.3.2.16 | Autonomous Release at O-MGCF..... | 107 | +| 7.2.3.2.17 | Special handling of 580 precondition failure received in response to either an INVITE or UPDATE..... | 107 | +| 7.2.3.2.17.1 | 580 Precondition failure response to an INVITE..... | 107 | +| 7.2.3.2.17.2 | 580 Precondition failure response to an UPDATE within an early dialog..... | 107 | + +| | | | +|--------------|----------------------------------------------------------------------------------------|-----| +| 7.2.3.2.18 | Sending of CANCEL..... | 108 | +| 7.2.3.2.19 | Receipt of SIP redirect (3xx) response..... | 108 | +| 7.2.3.2.20 | Sending of INFO for overlap signalling using the in-dialog method..... | 108 | +| 7.2.3.2.20.1 | General..... | 108 | +| 7.2.3.2.20.2 | Encoding of the INFO..... | 108 | +| 7.2.3.3 | Timers..... | 109 | +| 7.3 | Interworking between CS networks supporting BICC and the IM CN subsystem..... | 109 | +| 7.3.1 | Services performed by network entities in the control plane..... | 110 | +| 7.3.2 | Signalling interactions between network entities in the control plane..... | 110 | +| 7.3.2.1 | Signalling between the SS7 signalling function and MGCF..... | 110 | +| 7.3.2.1.1 | Signalling from MGCF to SS7 signalling function..... | 110 | +| 7.3.2.1.2 | Signalling from SS7 signalling function to MGCF..... | 110 | +| 7.3.2.1.3 | Services offered by STC, SCTP and M3UA..... | 111 | +| 7.3.2.1.3.1 | Services offer by SCTP..... | 111 | +| 7.3.2.1.3.2 | Services offered by M3UA..... | 111 | +| 7.3.2.1.3.3 | Services offered by STC..... | 111 | +| 7.3.2.2 | Signalling between the MGCF and SIP signalling function..... | 111 | +| 7.3.3 | SIP-BICC protocol interworking..... | 111 | +| 7.3.3.1 | Incoming call interworking from SIP to BICC at I-MGCF..... | 111 | +| 7.3.3.1.1 | Sending of IAM..... | 111 | +| 7.3.3.1.2 | Coding of IAM..... | 111 | +| 7.3.3.1.2.1 | Called party number..... | 111 | +| 7.3.3.1.2.2 | Nature of connection indicators..... | 111 | +| 7.3.3.1.2.3 | Forward call indicators..... | 112 | +| 7.3.3.1.2.4 | Calling party's category..... | 112 | +| 7.3.3.1.2.4A | Originating Line Information..... | 112 | +| 7.3.3.1.2.5 | Transmission medium requirement..... | 112 | +| 7.3.3.1.2.6 | Calling party number..... | 112 | +| 7.3.3.1.2.7 | Generic number..... | 112 | +| 7.3.3.1.2.8 | User service information..... | 112 | +| 7.3.3.1.2.9 | Hop counter (National option)..... | 112 | +| 7.3.3.1.2.10 | Location Number..... | 112 | +| 7.3.3.1.2.11 | Support of ICS call..... | 112 | +| 7.3.3.1.2.12 | UID capability indicators (National option)..... | 112 | +| 7.3.3.1.2.A | Coding of the IAM when Number Portability is supported..... | 112 | +| 7.3.3.1.2.B | Coding of the IAM for Carrier Routeing..... | 112 | +| 7.3.3.1.2.13 | Called IN number and original called IN number (optional)..... | 112 | +| 7.3.3.1.3 | Sending of COT..... | 113 | +| 7.3.3.1.3.A | Sending of SAM..... | 113 | +| 7.3.3.1.4 | Sending of 180 Ringing..... | 113 | +| 7.3.3.1.4.A | Sending of 183 Session Progress for early media scenarios..... | 113 | +| 7.3.3.1.4.B | Sending of 181 Call is being forwarded..... | 113 | +| 7.3.3.1.4.C | Sending of 183 Session Progress for overlap signalling using the in-dialog method..... | 113 | +| 7.3.3.1.4.D | Sending of 183 Session Progress to carry ISUP Cause..... | 113 | +| 7.3.3.1.4.E | Sending of 183 Session Progress for ICS call..... | 113 | +| 7.3.3.1.5 | Sending of the 200 OK (INVITE)..... | 114 | +| 7.3.3.1.6 | Sending of the Release message (REL)..... | 114 | +| 7.3.3.1.7 | Coding of the REL..... | 114 | +| 7.3.3.1.8 | Receipt of the Release Message..... | 114 | +| 7.3.3.1.9 | Receipt of RSC, GRS or CGB (H/W oriented)..... | 114 | +| 7.3.3.1.9a | Receipt of REFER..... | 114 | +| 7.3.3.1.9b | Autonomous Release at I-MGCF..... | 114 | +| 7.3.3.1.10 | Internal through connection of the bearer path..... | 114 | +| 7.3.3.1.11 | Out of Band DTMF..... | 114 | +| 7.3.3.2 | Outgoing Call Interworking from BICC to SIP at O-MGCF..... | 114 | +| 7.3.3.2.1 | Sending of INVITE..... | 114 | +| 7.3.3.2.1a | Sending of INVITE without determining the end of address signalling..... | 115 | +| 7.3.3.2.2 | Coding of the INVITE..... | 115 | +| 7.3.3.2.2.1 | Request-URI and To header field..... | 115 | + +| | | | +|--------------|-------------------------------------------------------------------------------------------------------------------------------|-----| +| 7.3.3.2.2.2 | SDP Media Description..... | 115 | +| 7.3.3.2.2.3 | P-Asserted-Identity and privacy header fields..... | 115 | +| 7.3.3.2.2.3A | "cpc" URI Parameter in P-Asserted-Identity Header..... | 115 | +| 7.3.3.2.2.3B | "oli" URI Parameter in P-Asserted-Identity Header..... | 115 | +| 7.3.3.2.2.4 | Max Forwards header..... | 115 | +| 7.3.3.2.2.5 | IMS Communication Service Identifier..... | 116 | +| 7.3.3.2.2.6 | P-Access-Network-Info..... | 116 | +| 7.3.3.2.2.A | Coding of the INVITE when number portability is supported..... | 116 | +| 7.3.3.2.2.B | Coding of the INVITE for Carrier Routeing..... | 116 | +| 7.3.3.2.2.C | Coding of INVITE with instance-id in form of IMEI URN..... | 116 | +| 7.3.3.2.2.7 | PSAP Call-back indication..... | 116 | +| 7.3.3.2.2.8 | History-Info header field (optional)..... | 116 | +| 7.3.3.2.3 | Sending of UPDATE..... | 116 | +| 7.3.3.2.4 | Sending of ACM and Awaiting Answer indication..... | 117 | +| 7.3.3.2.5 | Coding of the ACM..... | 117 | +| 7.3.3.2.5.1 | Backward call indicators..... | 117 | +| 7.3.3.2.6 | Sending of the Call Progress message (CPG)..... | 117 | +| 7.3.3.2.7 | Coding of the CPG..... | 117 | +| 7.3.3.2.7.1 | Event information..... | 117 | +| 7.3.3.2.7.2 | Optional Backward call indicators..... | 117 | +| 7.3.3.2.7a | Receipt of 200 OK (INVITE)..... | 117 | +| 7.3.3.2.7b | Internal through connection of the bearer path..... | 117 | +| 7.3.3.2.8 | Sending of the Answer Message (ANM)..... | 117 | +| 7.3.3.2.9 | Coding of the ANM..... | 117 | +| 7.3.3.2.10 | Sending of the Connect message (CON)..... | 117 | +| 7.3.3.2.11 | Coding of the CON..... | 118 | +| 7.3.3.2.11.1 | Void..... | 118 | +| 7.3.3.2.11A | Receipt of re-INVITE requests..... | 118 | +| 7.3.3.2.12 | Receipt of Status Codes 4xx, 5xx or 6xx..... | 118 | +| 7.3.3.2.13 | Receipt of a BYE..... | 118 | +| 7.3.3.2.14 | Receipt of the Release Message..... | 118 | +| 7.3.3.2.15 | Receipt of RSC, GRS or CGB (H/W oriented)..... | 118 | +| 7.3.3.2.16 | Out of Band DTMF..... | 118 | +| 7.3.3.2.17 | Sending of CANCEL..... | 118 | +| 7.3.3.2.18 | Autonomous Release at O-MGCF..... | 118 | +| 7.3.3.2.19 | Special handling of 580 precondition failure received in response to either an INVITE or UPDATE..... | 118 | +| 7.3.3.2.20 | Receipt of SIP redirect (3xx) response..... | 119 | +| 7.3.3.2.21 | Sending of INFO for overlap signalling using the in-dialog method..... | 119 | +| 7.3.3.3 | Timers..... | 119 | +| 7.4 | Supplementary Services..... | 119 | +| 7.4.1 | Calling line identification presentation/restriction (CLIP/CLIR)..... | 119 | +| 7.4.2 | Connected line presentation and restriction (COLP/COLR)..... | 119 | +| 7.4.2.0 | General..... | 119 | +| 7.4.2.1 | Incoming Call Interworking from SIP to BICC/ISUP at the I-MGCF..... | 119 | +| 7.4.2.1.1 | INVITE to IAM interworking (SIP to ISUP/BICC calls)..... | 119 | +| 7.4.2.1.2 | ANM/CON to 200 OK (INVITE)..... | 120 | +| 7.4.2.2 | Outgoing Call Interworking from BICC/ISUP to SIP at O-MGCF..... | 120 | +| 7.4.2.2.1 | IAM to INVITE interworking (ISUP to SIP calls)..... | 120 | +| 7.4.2.2.2 | 1XX to ANM or CON interworking..... | 121 | +| 7.4.2.2.3 | 200 OK (INVITE) to ANM/CON interworking..... | 121 | +| 7.4.3 | Direct Dialling In (DDI)..... | 122 | +| 7.4.4 | Malicious call identification..... | 122 | +| 7.4.5 | Subaddressing (SUB)..... | 122 | +| 7.4.5.1 | General..... | 122 | +| 7.4.5.2 | Interworking at I-MGCF..... | 123 | +| 7.4.5.3 | Interworking at O-MGCF..... | 124 | +| 7.4.6 | Call Forwarding Busy (CFB)/ Call Forwarding No Reply (CFNR) / Call Forwarding Unconditional (CFU) / Call Deflection (CD)..... | 126 | + +| | | | +|------------|-----------------------------------------------------------------------------------------------------|-----| +| 7.4.6.1 | General..... | 126 | +| 7.4.6.2 | Interworking at the O-MGCF..... | 127 | +| 7.4.6.2.1 | General..... | 127 | +| 7.4.6.2.2 | Interworking SIP to ISUP..... | 127 | +| 7.4.6.2.3 | Interworking ISUP to SIP..... | 131 | +| 7.4.6.3 | Interworking at the I-MGCF..... | 133 | +| 7.4.6.3.1 | General..... | 133 | +| 7.4.6.3.2 | Interworking from SIP to ISUP..... | 134 | +| 7.4.6.3.3 | Interworking from ISUP to SIP..... | 136 | +| 7.4.7 | Void..... | 141 | +| 7.4.8 | Explicit Call Transfer (ECT)..... | 141 | +| 7.4.9 | Call Waiting..... | 141 | +| 7.4.10 | Call Hold..... | 141 | +| 7.4.10.1 | Session hold initiated from the IM CN subsystem side..... | 141 | +| 7.4.10.2 | Session hold initiated from the CS network side..... | 143 | +| 7.4.11 | Call Completion on busy subscriber..... | 145 | +| 7.4.12 | Completion of Calls on No Reply (CCNR)..... | 145 | +| 7.4.13 | Terminal Portability (TP)..... | 145 | +| 7.4.14 | Conference calling (CONF) / Three-Party Service (3PTY)..... | 145 | +| 7.4.15 | Void..... | 146 | +| 7.4.16 | Closed User Group (CUG)..... | 146 | +| 7.4.17 | Multi-Level Precedence and Pre-emption (MLPP)..... | 146 | +| 7.4.18 | Global Virtual Network Service (GVNS)..... | 146 | +| 7.4.19 | International telecommunication charge card (ITCC)..... | 146 | +| 7.4.20 | Reverse charging (REV)..... | 146 | +| 7.4.21 | User-to-User Signalling (UUS)..... | 146 | +| 7.4.21.0 | General..... | 146 | +| 7.4.21.1 | User-to-User Signalling (UUS) service 1 (implicit)..... | 146 | +| 7.4.21.1.0 | General..... | 146 | +| 7.4.21.1.1 | Void..... | 147 | +| 7.4.21.1.2 | User-to-user information Interworking from SIP to ISUP..... | 147 | +| 7.4.21.1.3 | User-to-user information Interworking from ISUP to SIP..... | 147 | +| 7.4.21.2 | User-to-User Signalling (UUS) service 1 (explicit)..... | 147 | +| 7.4.21.3 | User-to-User Signalling (UUS) service 2 (explicit)..... | 147 | +| 7.4.21.4 | User-to-User Signalling (UUS) service 3 (explicit)..... | 147 | +| 7.4.22 | Multiple Subscriber Number (MSN)..... | 148 | +| 7.4.23 | Anonymous Call rejection..... | 148 | +| 7.4.23.0 | General..... | 148 | +| 7.4.23.1 | ISUP-SIP protocol interworking at the I-MGCF..... | 148 | +| 7.4.23.2 | SIP-ISUP protocol interworking at the O-MGCF..... | 148 | +| 7.4.24 | Customized Alerting Tones (CAT) in the 3GPP CS domain..... | 148 | +| 7.5 | IMS Supplementary Services..... | 148 | +| 7.5.1 | Originating Identification Presentation (OIP) and Originating Identification Restriction (OIR)..... | 148 | +| 7.5.2 | Terminating Identification Presentation (TIP) and Terminating Identification Restriction (TIR)..... | 148 | +| 7.5.2.1 | General..... | 148 | +| 7.5.2.2 | Interworking at the O-MGCF..... | 149 | +| 7.5.2.3 | Interworking at the I-MGCF..... | 150 | +| 7.5.2.4 | Timer..... | 151 | +| 7.5.3 | void..... | 151 | +| 7.5.4 | Communication Diversion (CDIV)..... | 151 | +| 7.5.4.1 | General..... | 151 | +| 7.5.4.2 | Interworking at the O-MGCF..... | 152 | +| 7.5.4.2.1 | General..... | 152 | +| 7.5.4.2.2 | Call Diversion within the ISUP Network appeared..... | 157 | +| 7.5.4.3 | Interworking at the I-MGCF..... | 160 | +| 7.5.5 | Communication Hold (HOLD)..... | 168 | +| 7.5.6 | Conference call (CONF)..... | 168 | +| 7.5.6.1 | General..... | 168 | +| 7.5.6.2 | Subscribing for the conference event package..... | 168 | + +| | | | +|--------------|----------------------------------------------------------------------------------------------------------------------------------------------------|-----| +| 7.5.6.3 | Interworking the notification..... | 169 | +| 7.5.7 | Anonymous Communication Rejection (ACR) and Communication Barring (CB)..... | 170 | +| 7.5.8 | Message Waiting Indication (MWI)..... | 170 | +| 7.5.9 | Malicious Communication Identification (MCID)..... | 170 | +| 7.5.9.0 | General..... | 170 | +| 7.5.9.1 | Interworking at the O-MGCF..... | 170 | +| 7.5.9.1.0 | General..... | 170 | +| 7.5.9.1.1 | Interworking of the MCID XML Request schema with the ISUP MCID request indicators..... | 170 | +| 7.5.9.1.2 | Interworking of the ISUP MCID response indicators with the MCID XML Response schema.... | 171 | +| 7.5.9.1.3 | Interworking of the ISUP Calling Party Number in an Identification Response with the
OrigPartyIdentity within the MCID XML Response schema..... | 171 | +| 7.5.9.1.4 | Interworking of the ISUP Generic Number in an Identification Response with the
GenericNumber within the MCID XML Response schema..... | 171 | +| 7.5.9.2 | Interworking at the I-MGCF..... | 172 | +| 7.5.9.2.1 | General..... | 172 | +| 7.5.9.2.2 | Interworking of identification Request..... | 172 | +| 7.5.9.2.3 | Interworking of identification Response..... | 172 | +| 7.5.10 | Closed User Group (CUG)..... | 172 | +| 7.5.10.0 | General..... | 172 | +| 7.5.10.1 | Interworking at the I-MGCF..... | 172 | +| 7.5.10.2 | Interworking at the O-MGCF..... | 173 | +| 7.5.11 | CCBS/CCNR..... | 174 | +| 7.5.11.0 | General..... | 174 | +| 7.5.11.1 | Interworking at the I-MGCF..... | 174 | +| 7.5.11.2 | Interworking at the O-MGCF..... | 177 | +| 7.5.12 | Communication Waiting (CW)..... | 179 | +| 7.5.12.0 | General..... | 179 | +| 7.5.12.1 | Interworking at the I-MGCF..... | 179 | +| 7.5.12.2 | Interworking at the O-MGCF..... | 179 | +| 7.5.13 | Customized Alerting Tones (CAT)..... | 179 | +| 7.5.13.1 | General..... | 179 | +| 7.5.13.2 | Early session model..... | 179 | +| 7.5.13.2.1 | Interworking at the O-MGCF..... | 179 | +| 7.5.13.2.2 | MGCF - IM-MGW Interaction for CAT service..... | 180 | +| 7.5.13.2.2.1 | General..... | 180 | +| 7.5.13.2.2.2 | IM CN subsystem side Early Session establishment..... | 180 | +| 7.5.13.2.2.3 | IM CN subsystem side normal Session establishment..... | 180 | +| 7.5.13.2.2.4 | Called party alerting..... | 181 | +| 7.5.13.2.2.5 | Message sequence chart..... | 181 | +| 7.5.13.3 | Forging model..... | 184 | +| 7.5.13.4 | Gateway model..... | 184 | +| 8 | User plane interworking..... | 184 | +| 8.1 | Interworking between IM CN subsystem and bearer independent CS network..... | 184 | +| 8.1.1 | Transcoder-less Mb to Nb Interworking..... | 185 | +| 8.1.1.1 | Initialisation..... | 185 | +| 8.1.1.2 | Time alignment..... | 185 | +| 8.1.1.3 | Rate control..... | 185 | +| 8.1.1.3.1 | General..... | 185 | +| 8.1.1.3.2 | Rate control for AMR and AMR-WB codecs..... | 185 | +| 8.1.1.3.3 | Rate and Mode control for the EVS codec..... | 186 | +| 8.1.1.3.4 | Interworking of rate control between compatible AMR-WB and EVS codec configurations..... | 187 | +| 8.1.1.3.5 | Interworking between rate control and RTCP-APP-CMR messages for MTSI..... | 187 | +| 8.1.1.4 | Frame quality indication..... | 188 | +| 8.1.1.5 | Framing..... | 188 | +| 8.1.1.6 | Transcoding..... | 188 | +| 8.1.1.7 | Discontinuous transmission..... | 188 | +| 8.1.1.8 | Timing and sequence information..... | 189 | +| 8.2 | Interworking between IM CN subsystem and TDM-based CS network..... | 189 | +| 8.3 | Transcoding requirements..... | 189 | + +| | | | +|------------|---------------------------------------------------|-----| +| 8.4 | Diffserv code point requirements..... | 189 | +| 8.5 | DTMF handling..... | 190 | +| 9 | MGCF - IM-MGW Interaction..... | 190 | +| 9.1 | Overview..... | 190 | +| 9.2 | Mn signalling interactions..... | 190 | +| 9.2.1 | Network model..... | 190 | +| 9.2.2 | Basic IM CN subsystem originated session..... | 191 | +| 9.2.2.1 | BICC forward bearer establishment..... | 191 | +| 9.2.2.1.1 | IM-MGW selection..... | 191 | +| 9.2.2.1.2 | CS network side bearer establishment..... | 191 | +| 9.2.2.1.3 | IM CN subsystem side termination reservation..... | 191 | +| 9.2.2.1.4 | IM CN subsystem side session establishment..... | 192 | +| 9.2.2.1.5 | Through-connection..... | 192 | +| 9.2.2.1.6 | Codec handling..... | 192 | +| 9.2.2.1.7 | Failure handling in MGCF..... | 193 | +| 9.2.2.1.8 | Message sequence chart..... | 193 | +| 9.2.2.2 | BICC backward bearer establishment..... | 194 | +| 9.2.2.2.1 | IM-MGW selection..... | 194 | +| 9.2.2.2.2 | IM CN subsystem side termination reservation..... | 195 | +| 9.2.2.2.3 | IM CN subsystem side session establishment..... | 195 | +| 9.2.2.2.4 | CS network side bearer establishment..... | 195 | +| 9.2.2.2.5 | Through-connection..... | 196 | +| 9.2.2.2.6 | Codec handling..... | 196 | +| 9.2.2.2.7 | Failure handling in MGCF..... | 196 | +| 9.2.2.2.8 | Message sequence chart..... | 196 | +| 9.2.2.3 | ISUP..... | 197 | +| 9.2.2.3.1 | IM-MGW selection..... | 197 | +| 9.2.2.3.2 | IM CN subsystem side termination reservation..... | 197 | +| 9.2.2.3.3 | IM CN subsystem side session establishment..... | 198 | +| 9.2.2.3.4 | CS network side circuit reservation..... | 198 | +| 9.2.2.3.5 | Through-connection..... | 198 | +| 9.2.2.3.6 | Continuity check..... | 199 | +| 9.2.2.3.7 | Codec handling..... | 199 | +| 9.2.2.3.8 | Voice processing function..... | 199 | +| 9.2.2.3.9 | Failure handling in MGCF..... | 199 | +| 9.2.2.3.10 | Message sequence chart..... | 199 | +| 9.2.3 | Basic CS network originated session..... | 201 | +| 9.2.3.1 | BICC forward bearer establishment..... | 201 | +| 9.2.3.1.1 | IM-MGW selection..... | 201 | +| 9.2.3.1.2 | IM CN subsystem side termination reservation..... | 201 | +| 9.2.3.1.3 | IM CN subsystem side session establishment..... | 201 | +| 9.2.3.1.4 | CS network side bearer establishment..... | 201 | +| 9.2.3.1.5 | Called party alerting..... | 202 | +| 9.2.3.1.6 | Called party answer..... | 202 | +| 9.2.3.1.7 | Through-Connection..... | 202 | +| 9.2.3.1.8 | Codec handling..... | 202 | +| 9.2.3.1.9 | Failure handling in MGCF..... | 202 | +| 9.2.3.1.10 | Message sequence chart..... | 202 | +| 9.2.3.2 | BICC Backward bearer establishment..... | 204 | +| 9.2.3.2.1 | IM-MGW selection..... | 204 | +| 9.2.3.2.2 | CS network side bearer establishment..... | 204 | +| 9.2.3.2.3 | IM CN subsystem side termination reservation..... | 204 | +| 9.2.3.2.4 | IM CN subsystem side session establishment..... | 205 | +| 9.2.3.2.5 | Called party alerting..... | 205 | +| 9.2.3.2.6 | Called party answer..... | 205 | +| 9.2.3.2.7 | Through-Connection..... | 205 | +| 9.2.3.2.8 | Codec handling..... | 205 | +| 9.2.3.2.9 | Failure handling in MGCF..... | 206 | +| 9.2.3.2.10 | Message sequence chart..... | 206 | + +| | | | +|------------|----------------------------------------------------------------------------|-----| +| 9.2.3.3 | ISUP..... | 208 | +| 9.2.3.3.1 | IM-MGW selection..... | 208 | +| 9.2.3.3.2 | CS network side circuit reservation..... | 208 | +| 9.2.3.3.3 | IM CN subsystem side termination reservation..... | 208 | +| 9.2.3.3.4 | IM CN subsystem side session establishment..... | 208 | +| 9.2.3.3.5 | Called party alerting..... | 209 | +| 9.2.3.3.6 | Called party answer..... | 209 | +| 9.2.3.3.7 | Through-Connection..... | 209 | +| 9.2.3.3.8 | Continuity Check..... | 209 | +| 9.2.3.3.9 | Codec handling..... | 209 | +| 9.2.3.3.10 | Voice Processing function..... | 210 | +| 9.2.3.3.11 | Failure handling in MGCF..... | 210 | +| 9.2.3.3.12 | Message sequence chart..... | 210 | +| 9.2.3.4 | Handling of Forking..... | 212 | +| 9.2.3.4.1 | Detection of Forking..... | 212 | +| 9.2.3.4.2 | IM CN subsystem side session establishment..... | 212 | +| 9.2.3.4.3 | IM CN subsystem side session establishment completion..... | 214 | +| 9.2.3.4.4 | Message sequence chart..... | 215 | +| 9.2.4 | Session release initiated from IM CN subsystem side..... | 218 | +| 9.2.4.1 | BICC..... | 218 | +| 9.2.4.1.1 | Session release in the IM CN subsystem side..... | 218 | +| 9.2.4.1.2 | Session release in the CS network side..... | 218 | +| 9.2.4.1.3 | Message sequence chart..... | 218 | +| 9.2.4.2 | ISUP..... | 219 | +| 9.2.4.2.1 | Session release in the IM CN subsystem side..... | 219 | +| 9.2.4.2.2 | Session release in the CS network side..... | 219 | +| 9.2.4.2.3 | Message sequence chart..... | 219 | +| 9.2.5 | Session release initiated from CS network side..... | 219 | +| 9.2.5.1 | BICC..... | 219 | +| 9.2.5.1.1 | Session release in the CS network side..... | 219 | +| 9.2.5.1.2 | Session release in the IM CN subsystem side..... | 220 | +| 9.2.5.1.3 | Message sequence chart..... | 220 | +| 9.2.5.2 | ISUP..... | 220 | +| 9.2.5.2.1 | Session release in the CS network side..... | 220 | +| 9.2.5.2.2 | Session release in the IM CN subsystem side..... | 221 | +| 9.2.5.2.3 | Message sequence chart..... | 221 | +| 9.2.6 | Session release initiated by MGCF..... | 221 | +| 9.2.6.1 | BICC..... | 221 | +| 9.2.6.1.1 | Session release in the CS network side..... | 221 | +| 9.2.6.1.2 | Session release in the IM CN subsystem side..... | 221 | +| 9.2.6.1.3 | Message sequence chart..... | 222 | +| 9.2.6.2 | ISUP..... | 222 | +| 9.2.6.2.1 | Session release in the CS network side..... | 222 | +| 9.2.6.2.2 | Session release in the IM CN subsystem side..... | 222 | +| 9.2.6.2.3 | Message sequence chart..... | 222 | +| 9.2.7 | Session release initiated by IM-MGW..... | 223 | +| 9.2.7.1 | BICC..... | 223 | +| 9.2.7.1.1 | Session release in the CS network side..... | 223 | +| 9.2.7.1.2 | Session release in the IM CN subsystem side..... | 223 | +| 9.2.7.1.3 | Message sequence chart..... | 223 | +| 9.2.7.2 | ISUP..... | 224 | +| 9.2.7.2.1 | Session release in the CS network side..... | 224 | +| 9.2.7.2.2 | Session release in the IM CN subsystem side..... | 224 | +| 9.2.7.2.3 | Message sequence chart..... | 225 | +| 9.2.8 | Handling of RTP telephone events..... | 225 | +| 9.2.8.1 | Sending DTMF digits out-of-band to CS CN (BICC)..... | 226 | +| 9.2.8.2 | Sending and receiving DTMF digits inband to/from CS CN (ISUP or BICC)..... | 228 | +| 9.2.8.3 | Receiving DTMF digits out-of-band from CS CN (BICC)..... | 229 | +| 9.2.9 | Session hold initiated from IM CN subsystem..... | 230 | + +| | | | +|------------|---------------------------------------------------------------------------------------|-----| +| 9.2.10 | Session hold initiated from CS network..... | 232 | +| 9.2.11 | Explicit Congestion Notification Support..... | 234 | +| 9.2.11.1 | General..... | 234 | +| 9.2.11.1a | Incoming Call Interworking from SIP to ISUP/BICC at I-MGCF..... | 234 | +| 9.2.11.1b | Outgoing Call Interworking from ISUP/BICC to SIP at O-MGCF..... | 235 | +| 9.2.11.1c | Detection of ECN failures by IM-MGW..... | 235 | +| 9.2.11.2 | Message sequence chart..... | 235 | +| 9.2.12 | Interactive Connectivity Establishment Support..... | 236 | +| 9.2.12.1 | General..... | 236 | +| 9.2.12.2 | ICE lite..... | 236 | +| 9.2.12.3 | Full ICE..... | 237 | +| 9.2.12.4 | Procedures for Interactive Connectivity Establishment (ICE)..... | 239 | +| 9.2.12.4.1 | ICE lite..... | 239 | +| 9.2.12.4.2 | Full ICE..... | 240 | +| 9.2.12.4.3 | Connectivity check result notification (full ICE)..... | 241 | +| 9.2.12.4.4 | New peer reflexive candidate notification (full ICE)..... | 241 | +| 9.2.13 | Codec Parameters Handling..... | 242 | +| 9.2.13.1 | Handling of common codec parameters..... | 242 | +| 9.2.13.2 | Handling of EVS speech codec parameters when interworking with a different codec..... | 243 | +| 9.2.13.3 | Handling of EVS speech codec parameters when the EVS codec is used end-to-end..... | 252 | +| 9.2.14 | SDP Capability Negotiation (SDPCapNeg)..... | 260 | +| 9.2.15 | Rate adaptation for media endpoints..... | 260 | +| 9.3 | Mn Signalling procedures..... | 261 | +| 9.3.1 | Procedures related to terminations towards the IM CN Subsystem..... | 261 | +| 9.3.1.1 | Reserve IMS connection point..... | 262 | +| 9.3.1.2 | Configure IMS resources..... | 264 | +| 9.3.1.3 | Reserve IMS Connection point and configure remote resources..... | 265 | +| 9.3.1.4 | Release IMS termination..... | 267 | +| 9.3.1.5 | Detect IMS RTP Tel event..... | 268 | +| 9.3.1.6 | Notify IMS RTP Tel event..... | 268 | +| 9.3.1.7 | Void..... | 268 | +| 9.3.1.8 | Send IMS RTP Tel event..... | 268 | +| 9.3.1.9 | Stop IMS RTP Tel event..... | 268 | +| 9.3.1.10 | Termination heartbeat indication..... | 269 | +| 9.3.1.11 | IMS Bearer Released..... | 269 | +| 9.3.1.12 | End IMS RTP Tel event..... | 269 | +| 9.3.1.13 | IMS Send Tone..... | 269 | +| 9.3.1.14 | IMS Stop Tone..... | 269 | +| 9.3.1.15 | IMS Tone Completed..... | 269 | +| 9.3.1.16 | ECN Failure Indication..... | 270 | +| 9.3.1.17 | ICE Connectivity Check Result Notification..... | 270 | +| 9.3.1.18 | ICE New Peer Reflexive Candidate Notification..... | 271 | +| 9.3.2 | Procedures related to a termination towards an ISUP network..... | 271 | +| 9.3.2.1 | Reserve TDM circuit..... | 271 | +| 9.3.2.2 | Change TDM through-connection..... | 272 | +| 9.3.2.3 | Activate TDM voice-processing function..... | 272 | +| 9.3.2.4 | Send TDM tone..... | 272 | +| 9.3.2.5 | Stop TDM tone..... | 272 | +| 9.3.2.6 | Play TDM announcement..... | 272 | +| 9.3.2.7 | TDM announcement completed..... | 272 | +| 9.3.2.8 | Stop TDM announcement..... | 272 | +| 9.3.2.9 | Continuity check..... | 272 | +| 9.3.2.10 | Continuity check verify..... | 273 | +| 9.3.2.11 | Continuity check response..... | 273 | +| 9.3.2.12 | Release TDM termination..... | 274 | +| 9.3.2.13 | Termination Out-of-Service..... | 274 | +| 9.3.2.14 | Termination heartbeat indication..... | 274 | +| 9.3.2.15 | Bearer Released..... | 274 | +| 9.3.2.16 | TDM tone completed..... | 274 | + +| | | | +|-------|-------------------------------------------------------------------------|-----| +| 9.3.3 | Procedures related to a termination towards a BICC network..... | 275 | +| 9.3.4 | Non-call related procedures..... | 275 | +| 9.3.5 | Multiple IP Realms..... | 276 | +| 9.4 | Multimedia Priority Service (MPS) Support..... | 277 | +| 9.4.1 | General..... | 277 | +| 9.4.2 | IM-MGW Resource Congestion in ADD response, request is queued..... | 277 | +| 9.4.3 | IM-MGW Resource Congestion in ADD response, MGCF seizes new IM-MGW..... | 278 | +| 9.4.4 | IM-MGW Priority Resource Allocation..... | 278 | +| 9.4.5 | IM-MGW Priority User Data marking..... | 279 | + +| | | | +|-------------------------------|------------------|------------| +| Annex A (informative): | Void..... | 280 | +|-------------------------------|------------------|------------| + +| | | | +|-----------------------------|---------------------------------------------------------------------------------|------------| +| Annex B (normative): | Codec Negotiation between a BICC CS network and the IM CN subsystem..... | 281 | +|-----------------------------|---------------------------------------------------------------------------------|------------| + +| | | | +|------------|----------------------------------------------------------------------------------|-----| +| B.1 | Introduction..... | 281 | +| B.2 | Control plane interworking..... | 281 | +| B.2.1 | Incoming call interworking from SIP to BICC at I-MGCF..... | 281 | +| B.2.1.1 | Sending of IAM..... | 281 | +| B.2.1.2 | Sending of SDP answer..... | 281 | +| B.2.2 | Outgoing call interworking from BICC to SIP at O-MGCF..... | 282 | +| B.2.2.1 | Sending of INVITE..... | 282 | +| B.2.2.2 | Responding to serving node initiating codec negotiation..... | 282 | +| B.2.3 | Mid-call interworking from SIP to BICC at I-MGCF or O-MGCF..... | 282 | +| B.2.3.1 | Receipt of SDP offer..... | 282 | +| B.2.3.2 | Generating SDP answer..... | 283 | +| B.2.4 | Mid-call interworking from BICC to SIP at I-MGCF or O-MGCF..... | 283 | +| B.2.4.1 | Receipt of mid-call codec negotiation request..... | 283 | +| B.2.4.2 | Responding to serving node initiating mid-call codec negotiation..... | 283 | +| B.2.4.3 | Receipt of codec modification request..... | 284 | +| B.2.5 | Codec parameter translation between BICC CS network and the IM CN subsystem..... | 284 | +| B.2.5.1 | Codec parameters for 3GPP AMR-NB codecs..... | 285 | +| B.2.5.2 | Codec parameters for 3GPP AMR-WB codecs..... | 287 | +| B.2.5.3 | Codec parameters for 3GPP non-AMR codecs..... | 288 | +| B.2.5.4 | Codec parameters for ITU-T codecs..... | 288 | +| B.2.5.5 | Codec parameters for 3GPP EVS codec..... | 289 | +| B.3 | MGCF - IM-MGW interaction during interworking of codec negotiation..... | 291 | +| B.3.1 | Basic IM CN subsystem originated session..... | 291 | +| B.3.1.1 | BICC forward bearer establishment..... | 292 | +| B.3.1.1.1 | IM-MGW selection..... | 292 | +| B.3.1.1.2 | CS network side bearer establishment..... | 292 | +| B.3.1.1.3 | IM CN subsystem side session establishment..... | 292 | +| B.3.1.1.4 | Through-connection..... | 292 | +| B.3.1.1.5 | Codec handling..... | 293 | +| B.3.1.1.6 | Failure handling in MGCF..... | 293 | +| B.3.1.1.7 | Message sequence chart..... | 293 | +| B.3.2 | Basic CS network originated session..... | 295 | +| B.3.2.1 | BICC forward bearer establishment..... | 295 | +| B.3.2.1.1 | IM-MGW selection..... | 295 | +| B.3.2.1.2 | IM CN subsystem side termination reservation..... | 295 | +| B.3.2.1.3 | IM CN subsystem side session establishment..... | 295 | +| B.3.2.1.4 | CS network side bearer establishment..... | 295 | +| B.3.2.1.5 | Called party alerting..... | 296 | +| B.3.2.1.6 | Called party answer..... | 296 | +| B.3.2.1.7 | Through-Connection..... | 296 | +| B.3.2.1.8 | Codec handling..... | 296 | +| B.3.2.1.9 | Failure handling in MGCF..... | 296 | +| B.3.2.1.10 | Message sequence chart..... | 296 | +| B.3.3 | CS network initiated mid-call codec negotiation..... | 299 | + +| | | | +|-------------------------------|------------------------------------------------------------------------------------------------------------------------------------|------------| +| B.3.4 | IM CN subsystem initiated mid-call codec negotiation..... | 300 | +| Annex C (normative): | Interworking of CPC parameter..... | 301 | +| C.1 | Interworking SIP to ISUP..... | 301 | +| C.2 | Interworking ISUP to SIP..... | 302 | +| Annex D (informative): | Void..... | 303 | +| Annex E (normative): | Multimedia interworking between the IP Multimedia Core Network (CN) Subsystem (IMS) and Circuit Switched (CS) networks..... | 304 | +| E.1 | Basic Multimedia calls interworking between the IMS and CS Networks scenarios..... | 304 | +| E.2 | Control plane interworking..... | 305 | +| E.2.1 | General..... | 305 | +| E.2.2 | Functionalities required in the MGCF for multimedia calls support..... | 305 | +| E.2.3 | IM CN subsystem originated session..... | 305 | +| E.2.3.1 | Preconditions used at IMS side..... | 305 | +| E.2.3.1.1 | Interactions between H.245 or MONA and SIP/SDP..... | 305 | +| E.2.3.2 | Preconditions not used at IMS side..... | 307 | +| E.2.3.2.1 | Interactions between H.245 or MONA and SIP/SDP..... | 307 | +| E.2.3.3 | Fallback to speech at session establishment..... | 309 | +| E.2.4 | CS network originated session..... | 309 | +| E.2.4.1 | Interactions between SIP/SDP and H.245 or MONA..... | 309 | +| E.2.4.1.1 | Normal Call setup..... | 309 | +| E.2.4.1.2 | Call setup if multimedia call can not be recognized in an unambiguous manner..... | 311 | +| E.2.4.1.3 | Fallback to speech during call setup..... | 311 | +| E.2.4.2 | CS originated - IM CN transit - CS terminated..... | 312 | +| E.2.5 | Service change..... | 313 | +| E.2.5.2.1 | SCUDIF..... | 313 | +| E.2.5.2.1.0 | General..... | 313 | +| E.2.5.2.1.1 | IM CN subsystem originated change..... | 313 | +| E.2.5.2.1.1.1 | Change from multimedia to speech..... | 313 | +| E.2.5.2.1.1.2 | Change from speech to multimedia..... | 314 | +| E.2.5.2.1.2 | CS network originated change..... | 315 | +| E.2.5.2.1.2.1 | Change from multimedia to speech..... | 315 | +| E.2.5.2.1.2.2 | Change from speech to multimedia..... | 316 | +| E.2.5.2.2 | Non-SCUDIF case (ISUP or BICC without SCUDIF)..... | 316 | +| E.2.5.2.2.1 | Change from multimedia to audio..... | 316 | +| E.2.5.2.2.2 | Change from speech to multimedia..... | 317 | +| E.2.6 | Call release..... | 318 | +| E.2.6.1 | Call release initiated from the IM CN subsystem side..... | 318 | +| E.2.6.2 | Call release initiated from the CS network side..... | 319 | +| E.2.6.3 | Call release initiated from the interworking node..... | 319 | +| E.3 | User plane interworking..... | 320 | +| E.3.1 | Functionalities required in the IM-MGW for multimedia calls support..... | 320 | +| E.4 | MGCF and IM-MGW interactions..... | 320 | +| E.4.1 | Introduction..... | 320 | +| E.4.2 | Mn signalling interactions..... | 321 | +| E.4.2.1 | Introduction..... | 321 | +| E.4.2.2 | H.248 Context Model..... | 321 | +| E.4.2.3 | Transport of H.245 messages between the MGCF and IM-MGW..... | 321 | +| E.4.2.3.1 | General..... | 321 | +| E.4.2.3.2 | Transport from MGCF to IM-MGW..... | 322 | +| E.4.2.3.3 | Transport from IM-MGW to MGCF..... | 322 | +| E.4.2.4 | Call establishment procedure..... | 322 | +| E.4.2.5 | Handling of H.245 indication message..... | 325 | +| E.4.2.5.1 | Overview..... | 325 | + +| | | | +|-------------|-----------------------------------------------------------------------------------------------|-----| +| E.4.2.5.2 | Function Not Understood / Function Not Supported message..... | 325 | +| E.4.2.5.3 | User Input Indication message..... | 326 | +| E.4.2.6 | Handling of H.245 Command message..... | 326 | +| E.4.2.6.1 | Overview..... | 326 | +| E.4.2.6.2 | Flow control command..... | 326 | +| E.4.2.6.3 | End Session Command..... | 327 | +| E.4.2.6.4 | videoFastUpdatePicture..... | 327 | +| E.4.2.7 | Mn Signalling Interactions to support the Media Oriented Negotiation Acceleration (MONA)..... | 328 | +| E.4.2.7.1 | Overview..... | 328 | +| E.4.2.7.2 | Mn Interactions for MONA preference messages..... | 330 | +| E.4.2.7.3 | Mn Interactions for MONA MPCs..... | 332 | +| E.4.2.7.4 | Mn Interactions for MONA SPCs..... | 334 | +| E.4.2.7.4.1 | General..... | 334 | +| E.4.2.7.4.2 | Transport from MGCF to IM-MGW..... | 334 | +| E.4.2.7.4.3 | Transport from IM-MGW to MGCF..... | 335 | +| E.4.2.7.4.4 | Termination of SPC procedure..... | 336 | +| E.4.2.7.5 | Mn Interactions for fallback from MONA procedures to standard H.324 setup..... | 337 | +| E.4.2.8 | Interworking between RTCP messages and H.245 messages..... | 338 | +| E.4.2.8.1 | Overview..... | 338 | +| E.4.2.8.2 | IM CN subsystem originated RTCP messages..... | 338 | +| E.4.2.8.3 | CS network originated H.245 messages..... | 339 | +| E.4.3 | Mn Signalling procedures..... | 340 | +| E.4.3.1 | Overview..... | 340 | +| E.4.3.2 | Add Multiplex Termination..... | 341 | +| E.4.3.3 | Configure Multiplex Termination..... | 342 | +| E.4.3.4 | Signal H245 Message..... | 343 | +| E.4.3.5 | Notify H245 Message..... | 343 | +| E.4.3.6 | Notify MONA Preference Reception..... | 344 | +| E.4.3.7 | Notify MONA Preference Completed..... | 344 | +| E.4.3.8 | Signal SPC..... | 345 | +| E.4.3.9 | Notify SPC..... | 345 | +| E.4.3.10 | Notify MPC..... | 346 | +| E.4.3.11 | Notify Detection of Legacy Interworking..... | 346 | +| E.4.3.12 | Request RTCP-Interworking..... | 347 | +| E.4.3.13 | Notify RTCP-Interworking..... | 347 | +| E.4.3.14 | Signal-H.245-Interworking..... | 348 | +| E.4.3.15 | Stop MPC..... | 348 | +| E.4.3.16 | Stop SPC..... | 349 | +| E.4.3.17 | Stop MONA Negotiation..... | 350 | + +| | | | +|-------------------------------|---------------------------------------------------------------------------------------------------------------------------------|------------| +| Annex F (normative): | PSTN XML Scheme..... | 350 | +| F.1 | Scope..... | 350 | +| F.2 | MIME type..... | 351 | +| F.3 | XML Schema definition..... | 351 | +| F.4 | IANA registration template..... | 356 | +| Annex G (informative): | Void..... | 358 | +| Annex H (normative): | Interworking of Originating Line Information (OLI) parameter
(network option).....
| 358 | +| H.1 | Interworking SIP to ISUP..... | 358 | +| H.2 | Interworking ISUP to SIP..... | 358 | +| Annex I (normative): | GTT interworking between the IP Multimedia Core Network (CN)
Subsystem (IMS) and Circuit Switched (CS) networks.....
| 359 | +| I.1 | Overview of GTT interworking between the IMS and Circuit Switched (CS) networks..... | 359 | +| I.2 | Control plane interworking..... | 360 | +| I.2.1 | General..... | 360 | +| I.2.2 | Functionalities required in the MGCF for GTT calls support..... | 360 | +| I.2.3 | IM CN subsystem originated session..... | 360 | +| I.2.3.1 | Initial INVITE with an SDP offer including a text media line..... | 360 | +| I.2.4 | CS network originated session..... | 361 | +| I.2.4.1 | General..... | 361 | +| I.2.4.2 | Initial INVITE with an SDP offer including audio only..... | 361 | +| I.2.5 | Subsequent SDP offer/answer exchange adding text to an audio session..... | 362 | +| I.3 | User plane interworking..... | 362 | +| I.3.1 | Functionalities required in the IM-MGW for GTT support..... | 362 | +| I.3.2 | Monitoring of text/modem signals on the CS side..... | 362 | +| I.3.3 | Multiplexing between the CS and IMS streams..... | 363 | +| I.3.4 | Conversion between text/modem and Real-Time Text over RTP..... | 363 | +| I.4 | MGCF and IM-MGW interactions..... | 363 | +| I.4.1 | Introduction..... | 363 | +| I.4.2 | Mn signalling interactions..... | 364 | +| I.4.2.1 | Introduction..... | 364 | +| I.4.2.2 | H.248 Context Model..... | 364 | +| I.4.2.3 | Specific Mn signalling for GTT..... | 364 | +| I.4.2.4 | IM CN subsystem originated session between the MGCF and IM-MGW..... | 365 | +| I.4.2.4.1 | Initial INVITE with an SDP offer including Real-Time Text..... | 365 | +| I.4.2.5 | CS network originated session..... | 367 | +| I.4.2.5.1 | Initial INVITE with an SDP offer only including audio..... | 367 | +| I.4.3 | Mn Signalling procedures..... | 368 | +| I.4.3.1 | Overview..... | 368 | +| Annex J (informative): | Call Flow for Customized Alerting Tone (CAT) interworking
between CS network and IMS.....
| 369 | +| J.1 | Introduction..... | 369 | +| J.2 | IMS CAT provided by the terminating IMS user using gateway model towards user served in CS
networks..... | 369 | +| J.2.1 | Callflow without using precondition mechanism..... | 370 | + +**Annex K (normative): T.38 interworking between the IP Multimedia Core Network (CN) Subsystem (IMS) and Circuit Switched (CS) networks.....372** + +K.1 General.....372 + +K.2 Recommend T.38 configuration.....372 + +K.3 Handling T.38 SDP attributes at the I-MGCF.....373 + +K.4 Handling T.38 SDP attributes at the O-MGCF.....374 + +K.5 Applicable T.38 SDP attributes at the Mn Interface.....375 + +**Annex L (normative): Interworking of called IN number and original called IN number parameters.....376** + +L.0 General.....376 + +L.1 Interworking SIP to ISUP.....376 + +L.2 Interworking ISUP to SIP.....377 + +Annex M (informative): Change history.....381 + +--- + +## Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- Y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +--- + +# 1 Scope + +The present document specifies the principles of interworking between the 3GPP IM CN subsystem and BICC/ISUP based legacy CS networks, in order to support IM basic voice, data and multimedia calls. + +The present document addresses the areas of control and user plane interworking between the IM CN subsystem and CS networks through the network functions, which include the MGCF and IM-MGW. For the specification of control plane interworking, areas such as the interworking between SIP and BICC or ISUP are detailed in terms of the processes and protocol mappings required for the support of both IM originated and terminated voice and multimedia calls. + +Other areas addressed encompass the transport protocol and signalling issues for negotiation and mapping of bearer capabilities and QoS information. + +The present document specifies the interworking between 3GPP profile of SIP (as detailed according to 3GPP TS 24.229 [9]) and BICC or ISUP, as specified in ITU-T Recommendations Q.1902.1 to Q.1902.6 [30] and ITU-T Q761 to Q764 [4] respectively. + +The present document also specifies the interworking between circuit switched multimedia telephony service, as described in 3GPP TS 26.110 [78] 3GPP TS 26.111 [79], and ITU-T Recommendation H.324 [81] and packet switched multimedia services, as described in 3GPP TS 26.114 [104], in particular and the interworking between the 3GPP profile of SIP and the inband control protocols for multimedia communication as specified in ITU-T Recommendations H.245 [82] and H.324 Annex K [81]. + +The present document addresses two interworking scenarios with respect to the properties of the CS network: + +- The CS network does not use any 3GPP specific additions. +- The CS network uses 3GPP specific additions. + +--- + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] ITU-T Recommendation G.711 (11/88): "Pulse Code Modulation (PCM) of voice frequencies". +- [2] ITU-T Recommendation H.248.1 (05/02): "Gateway control protocol: Version 2". +- [3] ITU-T Recommendation Q.701 (03/93), Q.702 (11/88), Q.703 (07/96), Q.704 (07/96), Q.705 (03/93), Q.706 (03/93), Q.707 (11/88), Q.708 (03/99), Q.709 (03/93): "Functional description of the message transfer part (MTP) of Signalling System No. 7". +- [4] ITU-T Recommendations Q.761 to Q.764 (12/99): "Specifications of Signalling System No.7 ISDN User Part (ISUP)". +- [5] Void. +- [6] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [7] Void. +- [8] 3GPP TS 24.228: "Signalling flows for the IP multimedia call control based on SIP and SDP". + +- [9] 3GPP TS 24.229: "IP Multimedia Call Control Protocol based on SIP and SDP". +- [10] 3GPP TS 23.002: "Network Architecture". +- [11] 3GPP TS 22.228: "Service requirements for the IP Multimedia Core Network Subsystem". +- [12] 3GPP TS 23.228: "IP Multimedia subsystem (IMS)". +- [13] Void. +- [14] 3GPP TS 29.205: "Application of Q.1900 series to Bearer Independent CS Network architecture; Stage 3". +- [15] 3GPP TS 29.332: "Media Gateway Control Function (MGCF) - IM-Media Gateway (IM-MGW) interface, Stage 3". +- [16] IETF RFC 791: "Internet Protocol". +- [17] IETF RFC 768: "User Datagram Protocol". +- [18] IETF RFC 2960: "Stream Control Transmission Protocol". +- [19] IETF RFC 3261: "SIP: Session Initiation Protocol". +- [20] 3GPP TS 29.202: "Signalling System No. 7 (SS7) signalling transport in core network; Stage 3". +- [21] IETF RFC 2474: "Definition of the Differentiated Services Field (DS Field) in the Ipv4 and Ipv6 Headers". +- [22] IETF RFC 2475: "An Architecture for Differentiated Services". +- [23] IETF RFC 4867 : "RTP Payload Format and File Storage Format for the Adaptive Multi-Rate (AMR) and Adaptive Multi-Rate Wideband (AMR-WB) Audio Codecs". +- [24] IETF RFC 793: "Transmission Control Protocol". +- [25] 3GPP TS 29.414: "Core network Nb data transport and transport signalling". +- [26] 3GPP TS 29.415: "Core network Nb interface user plane protocols". +- [27] 3GPP TS 23.205: "Bearer-independent circuit-switched core network; Stage 2". +- [28] Void. +- [29] ITU-T Recommendation Q.2150.1: "Signalling transport converter on MTP3 and MTP3b". +- [30] ITU-T Recommendations Q.1902.1 to Q.1902.6 (07/01): "Bearer Independent Call Control". +- [31] Void. +- [32] Void. +- [33] Void. +- [34] Void. +- [35] ITU-T Recommendation Q.765.5: "Signalling system No. 7 - Application transport mechanism: Bearer Independent Call Control (BICC)". +- [36] IETF RFC 3264: "An Offer/Answer Model with the Session Description Protocol (SDP)". +- [37] IETF RFC 3312: "Integration of Resource Management and Session Initiation Protocol (SIP)". +- [38] ITU-T Recommendation Q.850 (05/1998) including Amendment 1 (07/2001): "Usage of cause and location in the Digital Subscriber Signalling System No. 1 and the Signalling System No. 7 ISDN User Part". + +- [39] IETF RFC 2460: "Internet Protocol, Version 6 (Ipv6) Specification". +- [40] IETF RFC 3323: "A Privacy Mechanism for the Session Initiation Protocol (SIP)". +- [41] IETF RFC 3325: "Private Extensions to the Session Initiation Protocol (SIP) for Asserted Identity within Trusted Networks". +- [42] ITU-T Recommendation Q.730 (12/99), Q.731.1 (07/96), Q.731.3 (03/93), Q.731.4 (03/93), Q.731.5 (03/93), Q.731.6 (03/93), Q.731.7 (06/97), Q.731.8 (02/92), Q.732.2-5 (12/99), Q.732.7 (07/96), Q.733.1 (02/92), Q.733.2 (03/93), Q.733.3 (06/97), Q.733.4 (03/93), Q.733.5 (12/99), Q.734.1 (03/93), Q.734.2 (07/96), Q.735.1 (03/93), Q.735.3 (03/93), Q.735.6 (07/93), Q.736.1 (10/95), Q.736.3 (10/95), Q.737.1 (06/97): "ISDN user part supplementary services". +- [43] ITU-T Recommendation I.363.5 (1996): "B-ISDN ATM Adaptation Layer specification: Type 5 AAL". +- [44] ITU-T Recommendation Q.2110 (1994): "B-ISDN ATM adaptation layer - Service Specific Connection Oriented Protocol (SSCOP)". +- [45] ITU-T Recommendation Q.2140 (1995): "B-ISDN ATM adaptation layer - Service specific coordination function for signalling at the network node interface (SSCF AT NNI)". +- [46] ITU-T Recommendation Q.2210 (1996): "Message transfer part level 3 functions and messages using the services of ITU-T Recommendation Q.2140". +- [47] 3GPP TS 23.221: "Architectural requirements". +- [48] ITU-T Recommendation E.164 (05/1997): "The international public telecommunication numbering plan". +- [49] ITU-T Recommendation Q.1912.5 (03/04): "Interworking between Session Initiation Protocol (SIP) and Bearer Independent Call Control Protocol or ISDN User Part". +- [50] 3GPP TS 26.102: "Adaptive Multi-Rate (AMR) speech codec; Interface to Iu and Uu". +- [51] IETF RFC 3550: "RTP: A Transport Protocol for Real-Time Applications". +- [52] IETF RFC 3551: "RTP Profile for Audio and Video Conferences with Minimal Control". +- [53] IETF RFC 3555: "MIME Type Registration of RTP Payload Formats". +- [54] IETF RFC 3262: "Reliability of provisional responses". +- [55] IETF RFC 3311: "SIP UPDATE method". +- [56] IETF RFC 4566: "SDP: Session Description Protocol". +- [57] 3GPP TS 26.103: "Speech Codec List for GSM and UMTS". +- [58] 3GPP TS 28.062: "Inband Tandem Free Operation (TFO) of speech codecs". +- [59] IETF RFC 3556: "Session Description Protocol (SDP) Bandwidth Modifiers for RTP Control Protocol (RTCP) bandwidth". +- [60] 3GPP TS 24.604: "Communication Diversion (CDIV) using IP Multimedia (IM) Core Network (CN) subsystem; Protocol specification". +- [61] 3GPP TS 24.605: "Conference (CONF) using IP Multimedia (IM) Core Network (CN) subsystem; Protocol specification". +- [62] 3GPP TS 24.606: "Message Waiting Indication (MWI) using IP Multimedia (IM) Core Network (CN) subsystem; Protocol specification". + +- [63] 3GPP TS 24.607: "Originating Identification Presentation (OIP) and Originating Identification Restriction (OIR) using IP Multimedia (IM) Core Network (CN) subsystem; Protocol specification". +- [64] 3GPP TS 24.608: "Terminating Identification Presentation (TIP) and Terminating Identification Restriction (TIR) using IP Multimedia (IM) Core Network (CN) subsystem; Protocol specification". +- [65] 3GPP TS 24.610: "Communication HOLD (HOLD) using IP Multimedia (IM) Core Network (CN) subsystem; Protocol specification". +- [66] Void. +- [67] 3GPP TS 24.611: "Anonymous Communication Rejection (ACR) and Communication Barring (CB) using IP Multimedia (IM) Core Network (CN) subsystem; Protocol specification". +- [68] Void. +- [69] IETF RFC 4040: "RTP Payload Format for a 64 kbit/s Transparent Call". +- [70] ETSI EN 300 356-1 (V4.2.1): "Integrated Services Digital Network (ISDN); Signalling System No.7 (SS7); ISDN User Part (ISUP) version 4 for the international interface; Part 1: Basic services [ITU-T Recommendations Q.761 to Q.764 (1999) modified]". +- [71] ETSI EN 300 356-21 (V4.2.1): "Integrated Services Digital Network (ISDN); Signalling System No.7 (SS7); ISDN User Part (ISUP) version 4 for the international interface; Part 21: Anonymous Call Rejection (ACR) supplementary service". +- [72] ITU-T Recommendation T.38 (09/2010): "Procedures for real-time Group 3 facsimile communication over IP networks". +- [73] IETF RFC 3362: "Real-time Facsimile (T.38) - image/t38 MIME Sub-type Registration". +- [74] 3GPP TS 23.003: "Numbering, addressing and identification". +- [75] IETF RFC 3515: "The Session Initiation Protocol (SIP) REFER method". +- [76] Void. +- [77] IETF RFC 5079: "Rejecting Anonymous Requests in the Session Initiation Protocol (SIP)". +- [78] 3GPP TS 26.110: "Codec for circuit switched multimedia telephony service; General description". +- [79] 3GPP TS 26.111: "Codec for Circuit switched Multimedia Telephony Service; Modifications to H.324". +- [80] Void. +- [81] ITU-T Recommendation H.324 (04/09): "Terminal for low bitrate multimedia communication". +- [82] ITU-T Recommendation H.245: "Control protocol for multimedia communication". +- [83] ITU-T Recommendation H.261 (03/93): "Video codec for audiovisual services at p x 64 kbit/s". +- [84] ITU-T Recommendation H.263 (01/05): "Video coding for low bitrate communication". +- [85] Void. +- [86] Void. +- [87] Void. +- [88] 3GPP TS 24.173: "IMS Multimedia Telephony Communication Service and Supplementary Services, stage 3". + +- [89] IETF RFC 5009: "Private Header (P-Header) Extension to the Session Initiation Protocol (SIP) for Authorization of Early Media". +- [90] IETF RFC 2663: "IP Network Address Translator (NAT) Terminology and Considerations". +- [91] IETF RFC 7044: "An extension to the Session Initiation Protocol (SIP) for Request History Information". +- [92] ITU-T Recommendation Q.769.1 (12/99): "Signalling system No. 7 - ISDN user part enhancements for the support of number portability". +- [93] IETF RFC 4694: "Number portability parameters for the "tel" URI". +- [94] Void. +- [95] Void. +- [96] ETSI EN 300 403-1 (V1.3.2): "Integrated Services Digital Network (ISDN); Digital Subscriber Signalling System No. one (DSS1) protocol; Signalling network layer for circuit-mode basic call control; Part 1: Protocol specification [ITU-T Recommendation Q.931 (1993), modified]". +- [97] IETF RFC 3966: "The tel URI for Telephone Numbers". +- [98] Void. +- [99] IETF RFC 7433: "A Mechanism for Transporting User-to-User Call Control Information in SIP". +- [99A] IETF RFC 7434: "Interworking ISDN Call Control User Information with SIP". +- [100] IETF RFC 4575: "A Session Initiation Protocol (SIP) Event Package for Conference State". +- [101] 3GPP TS 24.654: "Closed User Group (CUG) using IP Multimedia (IM) Core Network (CN) subsystem, Protocol Specification". +- [102] 3GPP TS 24.616: "Malicious Communication Identification (MCID) using IP Multimedia (IM) Core Network (CN) subsystem; Protocol specification". +- [103] 3GPP TS 23.014: "Technical Specification Group Core Network; Support of Dual Tone Multi-Frequency (DTMF) signalling". +- [104] 3GPP TS 26.114: "IP Multimedia Subsystem (IMS); Multimedia Telephony; Media handling and interaction". +- [105] IETF RFC 4733: "RTP Payload for DTMF Digits, Telephony Tones and Telephony Signals". +- [106] IETF RFC 6910: "Completion of Calls for the Session Initiation Protocol (SIP)". +- [107] IETF RFC 7462: "URNs for the Alert-Info Header Field of the Session Initiation Protocol (SIP)". +- [108] IETF RFC 4715: "The Integrated Services Digital Network (ISDN) Subaddress Encoding Type for tel URI". +- [109] IETF RFC 4585: "Extended RTP Profile for Real-time Transport Control Protocol (RTCP)-Based Feedback (RTP/AVPF)". +- [110] IETF RFC 5104: "Codec Control Messages in the RTP Audio-Visual Profile with Feedback (AVPF)". +- [111] 3GPP TS 24.615: "Communication Waiting (CW) using IP Multimedia (IM) Core Network (CN) subsystem, Protocol Specification". +- [112] 3GPP TS 24.642: "Completion of Communications to Busy Subscriber (CCBS) Completion of Communications by No Reply (CCNR) using IP Multimedia (IM) Core Network (CN) subsystem; Protocol specification". + +- [113] IETF RFC 4458: "Session Initiation Protocol (SIP) URIs for Applications such as Voicemail and Interactive Voice Response (IVR)". +- [114] IETF RFC 5993: "RTP Payload format for Global System for Mobile Communications Half Rate (GSM-HR)". +- [115] IETF RFC 6432: "Carrying Q.850 Codes in Reason Header Fields in SIP (Session Initiation Protocol) Responses". +- [116] IETF RFC 3326: "The Reason Header Field for the Session Initiation Protocol (SIP)". +- [117] ANSI Standard ATIS-1000113.2005(R2010) (07/2005): "Signalling System No. 7 (SS7) - Integrated Services Digital Network (ISDN) User Part". +- [118] 3GPP TS 23.237: "IP Multimedia subsystem (IMS) Service Continuity; Stage 2". +- [119] IETF RFC 5626: "Managing Client Initiated Connections in the Session Initiation Protocol (SIP)". +- [120] IETF RFC 7254: "A Uniform Resource Name Namespace for the Global System for Mobile Communications Association (GSMA) and the International Mobile station Equipment Identity (IMEI)". +- [121] 3GPP TS 23.172: "Technical realization of Circuit Switched (CS) multimedia service UDI/RDI fallback and service modification; Stage 2". +- [122] 3GPP TS 23.226: "Global Text Telephony (GTT); stage 2". +- [123] ITU-T Recommendation T.140 (02/98): "Text conversation presentation protocol". +- [124] IETF RFC 4103: "RTP Payload for Text Conversation". +- [125] ITU-T Recommendation V.18 (11/00): "Operational and interworking requirements for DCEs operating in the text telephone mode" including V.18 (2000) Amendment 1 (11/02): "Harmonization with ANSI TIA/EIA-825 (2000) text phones". +- [126] 3GPP TS 26.226: "Cellular text telephone modem; General description". +- [127] Void. +- [128] Void. +- [129] IETF RFC 3168: "The Addition of Explicit Congestion Notification (ECN) to IP". +- [130] IETF RFC 6679: "Explicit Congestion Notification (ECN) for RTP over UDP". +- [131] IETF RFC 3959: "The Early Session Disposition Type for the Session Initiation Protocol (SIP)". +- [132] 3GPP TS 24.182: "IP Multimedia Subsystem (IMS) Customized Alerting Tones (CAT); Protocol specification". +- [133] IETF RFC 6086: "Session Initiation Protocol (SIP) INFO Method and Package Framework". +- [134] 3GPP TS 23.088: "Call Barring (CB) Supplementary Services; Stage 2". +- [135] IETF RFC 3840: "Indicating User Agent Capabilities in the Session Initiation Protocol (SIP)". +- [136] 3GPP TS 22.153: "Multimedia Priority Service". +- [137] IETF RFC 3023: "XML Media Types". +- [138] IETF RFC 6665: "SIP-Specific Event Notification". +- [139] IETF RFC 7090: "Public Safety Answering Point (PSAP) Callback". + +- [141] 3GPP TS 24.292: "IP Multimedia (IM) Core Network (CN) subsystem Centralized Services (ICS); Stage 3". +- [142] IETF RFC 6809: "Mechanism to Indicate Support of Features and Capabilities in the Session Initiation Protocol (SIP)". +- [143] IETF RFC 5245: "Interactive Connectivity Establishment (ICE): A Protocol for Network Address Translator (NAT) Traversal for Offer/Answer Protocols". +- [144] IETF RFC 5389: "Session Traversal Utilities for NAT (STUN)". +- [145] 3GPP TS 23.334: "IMS Application Level Gateway (IMS-ALG) - IMS Access Gateway (IMS-AGW) interface: Procedures Descriptions". +- [146] 3GPP TS 26.441: "Codec for Enhanced Voice Services (EVS); General Overview". +- [147] 3GPP TS 26.445: "Codec for Enhanced Voice Services (EVS); Detailed Algorithmic Description". +- [148] IETF RFC 8119: "SIP "cause" URI Parameter for Service Number Translation". +- [149] ITU-T Recommendation Q.931 (05/98): "ISDN user-network interface layer 3 specification for basic call control". +- [150] IETF RFC 5939: "Session Description Protocol (SDP) Capability Negotiation". +- [151] 3GPP TS 23.333: "Multimedia Resource Function Controller (MRFC) - Multimedia Resource Function Processor (MRFP) Mp interface: Procedures Descriptions". +- [152] 3GPP TS 26.453: "Codec for Enhanced Voice Services (EVS); Speech codec frame structure". +- [153] IETF RFC 8224: "Authenticated Identity Management in the Session Initiation Protocol (SIP)". +- [154] IETF RFC 8197: "A SIP Response Code for Unwanted Calls". +- [155] IETF RFC 8606: "ISDN User Part (ISUP) Cause Location Parameter for the SIP Reason Header Field". + +--- + +## 3 Definitions and abbreviations + +### 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in TR 21.905 [6], ITU-T Recommendation E.164 [48] and the following apply: + +**Carrier textphone mode:** a mode for text communication, where continuous signals (i.e. a carrier tone) are present on the connection irrespective of whether text is being exchanged or not. + +**Carrierless textphone mode:** a mode for text communication, where signals are only present on the connection when text is being exchanged. E.g.: Baudot + +**SS7 signalling function:** function in the CS network, which has the capabilities to transport the SS7 MTP-User parts ISUP and BICC+STCmtp + +**SIP signalling function:** function in the IM CN subsystem, which has the capabilities to transport SIP + +**Incoming or Outgoing:** used in the present document to indicate the direction of a call (not signalling information) with respect to a reference point. + +**Incoming MGCF (I-MGCF):** entity that terminates incoming SIP calls from the IMS side and originates outgoing calls towards the CS side using the BICC or ISUP protocols. + +**Outgoing Interworking Unit (O-MGCF)**: entity that terminates incoming BICC or ISUP calls from the CS side and originates outgoing calls towards the IMS using SIP. + +**Root Termination**: refers to Media Gateway as an entity in itself, rather than a Termination within it. A special TerminationID, "Root" is reserved for this purpose. See ITU-T Recommendation H.248.1. [2] + +**Signalling Transport Converter (STC)**: function that converts the services provided by a particular Signalling Transport to the services required by the Generic Signalling Transport Service. + +**STCmtp**: Signalling Transport Converter on MTP. See ITU-T Recommendation Q.2150.1 [29]. + +**BICC+STCmtp**: this terminology means that BICC signalling always needs to be used on top of STCmtp sublayer. + +**diverting URI**: the URI of the node by which the existing communication was last diverted/forwarded. + +**diverted-to URI**: the URI to which the existing communication is diverted/forwarded to. + +**ICE lite**: The lite implementation of the Interactive Connectivity Establishment (ICE) specified in IETF RFC 5245 [143]. + +**Full ICE**: The full implementation of the Interactive Connectivity Establishment (ICE) specified in IETF RFC 5245 [143]. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations as defined in TR 21.905 [6] and the following apply: + +| | | +|-----------|-------------------------------------------------------------------------------| +| 3PTY | Three Party | +| AAL1 | ATM Adaptation Layer type 1 | +| ACR | Anonymous Call Rejection | +| AMR | Adaptive Multi-Rate | +| AMR-WB | Adaptive Multi-Rate - WideBand | +| AMR-WB IO | Adaptive Multi-Rate - WideBand Inter-operable Mode, included in the EVS codec | +| ANM | Answer Message | +| APM | Application Transport Message | +| APP | APplication-defined RTCP packet | +| APRI | Address Presentation Restriction Indicator | +| ATP | Access Transport Parameter | +| BC | Bearer Capability | +| BCI | Backward Call Indicators | +| BGCF | Breakout Gateway Control Function | +| BICC | Bearer Independent Call Control | +| CAT | Customized Alerting Tones | +| CB | Communication Barring | +| CCNR | Call Completion on No Reply | +| CCSS | Call Completion Service Set-up | +| Cda | Call Deflection Alerting | +| Cdi | Call Deflection Immediate | +| CDIV | Communication Diversion | +| CdPN | Called Party Number | +| CFB | Call Forwarding Busy | +| CFNR | Call Forwarding No Reply | +| CGB | Circuit Group Blocking | +| CgPN | Calling Party Number | +| CIC | Carrier Identification Code | +| CMR | Codec Mode Request | +| CON | Connect | +| CONF | Conference | +| COT | Continuity | +| CPC | Calling Party's Category | +| CPG | Call ProGress message | + +| | | +|-----------|----------------------------------------------------------------------------------| +| CSI | Carrier Selection Information | +| DSCP | DiffServ Code Point | +| DTX | Discontinuous Transmission | +| ECN | Explicit Congestion Notification | +| ECN-CE | ECN Congestion Experienced | +| EVS | Enhanced Voice Services | +| EVS-CMR | Codec Mode Request for EVS | +| FAC | Facility | +| FQC | Frame Quality Classification | +| GN | Generic Number | +| GRS | Group Reset | +| GVNS | Global Virtual Network Service | +| H/W | Hardware | +| ICE | Interactive Connectivity Establishment | +| ICS | IMS Centralized Services | +| IDR | Identification Request | +| IEPS | International Emergency Preference Scheme | +| I-MGCF | Incoming MGCF | +| IM-MGW | IP Multimedia Media Gateway Function | +| INF | Information | +| INR | Information Request | +| IRS | Identification Response | +| ITCC | International Telecommunication Charge Card | +| ITU-T | International Telecommunication Union - Telecommunication Standardization Sector | +| MCID | Malicious Communication Identification | +| M3UA | MTP-L3 User Adaptation layer | +| MLPP | Multi-Level Precedence and Pre-emption | +| MONA | Media Orientation Negotiation Acceleration | +| MPC | Media Preconfigured Channel | +| MPS | Multimedia Priority Service | +| MRFP | Media Resource Function Processor | +| MSN | Multiple Subscriber Number | +| MSU | Message Signalling Unit | +| MWI | Message Waiting Indication | +| NOA | Nature Of Address indicator | +| NPDI | Number Portability Database Dip Indicator | +| OIP | Originating Identification Presentation | +| OIR | Originating Identification Restriction | +| OLI | Originating Line Information | +| O-MGCF | Outgoing MGCF | +| PI | Progress Indicator | +| PIDF | Presence Information Data Format | +| PSAP | Public Safety Answering Point | +| REV | Reverse Charging | +| RLC | Release Complete | +| RSC | Reset Circuit | +| RTCP | RTP Control Protocol | +| RTP | Real-time Transport Protocol | +| SAM | Subsequent Address Message | +| SCTP | Stream Control Transmission Protocol | +| SDPCapNeg | SDP Capability Negotiation | +| SGW | Signalling Gateway | +| SPC | Signalling Preconfigured Channel | +| ST | Sending Terminated | +| STUN | Session Traversal Utilities for NAT | +| TCAP | Transaction Capabilities Application Part | +| TDM | Time Division Multiplex | +| TIP | Terminating Identification Presentation | +| TIR | Terminating Identification Restriction | + +| | | +|--------|-----------------------------------------------------------| +| TMR | Transmission Medium Requirement | +| TMU | Transmission Medium Used | +| TNL | Transport Network Layer | +| TNS | Transit Network Selection | +| TP | Terminal Portability | +| UA | User Agent | +| UAC | User Agent Client | +| UDI | Unrestricted Digital Information | +| UDI-TA | Unrestricted Digital Information with Tones/Announcements | +| UID | User Interactive Dialog | +| URI | Uniform Resource Identifier | +| USI | User Service Information | +| UUS | User-to-User Signalling | +| XML | eXtensible Markup Language | + +--- + +## 4 General + +### 4.1 General interworking overview + +The IM CN subsystem shall interwork with BICC and ISUP based legacy CS networks, e.g. PSTN, ISDN, CS PLMNs, in order to provide the ability to support basic voice calls (see 3GPP TS 22.228 [11]), between a UE located in the IM CN subsystem and user equipment located in a CS network. + +For the ability to support the delivery of basic voice calls between the IM CN subsystem and CS networks, basic protocol interworking between SIP (as specified in 3GPP TS 24.229 [9]) and BICC or ISUP (as specified in ITU-T Recommendations Q.1902.1-6 [30] and ITU-T Recommendations Q.761 to Q.764 [4] respectively) has to occur at a control plane level, in order that call setup, call maintenance and call release procedures can be supported. The MGCF shall provide this protocol mapping functionality within the IM CN subsystem. + +User plane interworking between the IM CN subsystem and CS network bearers (e.g. 64k TDM, ATM/AAL2 circuit or IP bearer) are supported by the functions within the IM-MGW. The IM-MGW resides in the IM CN subsystem and shall provide the bearer channel interconnection. The MGCF shall provide the call control to bearer setup association. + +The IM CN subsystem shall interwork, at the control and user plane, with BICC and ISUP based legacy CS networks. The support of supplementary services shall be as defined in 3GPP TS 22.228 [11]. The MGCF and IM-MGW shall support the interworking of the IM CN subsystem to an external ISUP based CS network. They may also support interworking to a BICC based CS network where no 3GPP specific extension is applied. The MGCF and the IM-MGW may also support interworking to a BICC based CS network where 3GPP specific extensions in accordance with 3GPP TS 29.205 [14] are applied. + +--- + +## 5 Network characteristics + +### 5.1 Key characteristics of ISUP/BICC based CS networks + +This signalling interface to a PSTN is either based on BICC Capability Set 2 as specified in ITU-T Recommendations Q.1902.1 to Q.1902.6 [30], or on ISUP (see ITU-T Recommendations Q.761 to Q.764 [4]). + +The interface towards a CS-PLMN may either be one of the interfaces mentioned in the paragraph above or a signalling interface based on BICC with 3GPP specific extensions, as specified for the 3GPP Nc interface in 3GPP TS 29.205 [14], and the IM-MGW may support the 3GPP Nb interface, as specified in 3GPP TS 29.414 [25] and 3GPP TS 29.415 [26]. If the 3GPP Nc interface is applied as signalling interface, the 3GPP Nb interface is used as user plane interface and the Nb UP Framing protocol is applied. + +### 5.2 Key characteristics of IM CN subsystem + +The IM CN subsystem uses SIP to manage IP multimedia sessions in a 3GPP environment, it also uses Ipv6, as defined in RFC 2460 [39], as the transport mechanism for both SIP session signalling and media transport. The 3GPP profile of + +SIP defining the usage of SIP within the IM CN subsystem is specified in 3GPP TS 24.229 [9]. Example callflows are provided in 3GPP TS 24.228 [8]. + +## 6 Interworking with CS networks + +### 6.1 Interworking reference model + +Figure 1 details the reference model required to support interworking between the 3GPP IM CN subsystem and CS networks for IM basic voice calls. + +![Figure 1: IM CN subsystem to CS network logical interworking reference model. The diagram shows the logical interworking between the IM CN subsystem and a CS network. On the left, BGCF and CSCF are connected to MGCF via reference points Mj and Mg respectively. MGCF is connected to SGW via BICC/ISUP over SCTP/IP. SGW is connected to the CS network via BICC/ISUP over MTP. MGCF is also connected to IM-MGW via reference point Mn. IM-MGW is connected to the CS network via CS channels (e.g., PCM) and to other network entities (Note 3) via reference point Mb. A legend indicates that solid lines represent the User Plane and dotted lines represent the Control Plane.](55136bc716146672fc680fa05989f1d2_img.jpg) + +Figure 1: IM CN subsystem to CS network logical interworking reference model. The diagram shows the logical interworking between the IM CN subsystem and a CS network. On the left, BGCF and CSCF are connected to MGCF via reference points Mj and Mg respectively. MGCF is connected to SGW via BICC/ISUP over SCTP/IP. SGW is connected to the CS network via BICC/ISUP over MTP. MGCF is also connected to IM-MGW via reference point Mn. IM-MGW is connected to the CS network via CS channels (e.g., PCM) and to other network entities (Note 3) via reference point Mb. A legend indicates that solid lines represent the User Plane and dotted lines represent the Control Plane. + +- NOTE 1: The logical split of the signalling and bearer path between the CS network and the IM CN subsystem is as shown, however the signalling and bearer may be logically directly connected to the IM-MGW. +- NOTE 2: The SGW may be implemented as a stand-alone entity or it may be located in another entity either in the CS network or the IM-MGW. The implementation options are not discussed in the present document. +- NOTE 3: The IM-MGW may be connected via the Mb to various network entities, such as a UE (via a GTP Tunnel to a GGSN), an MRFP, or an application server. +- NOTE 4: A SGW function is not required for certain signalling transports, where M3UA+SCTP+IP is used in CS network and IM-MGCF. + +**Figure 1: IM CN subsystem to CS network logical interworking reference model** + +#### 6.1.1 Interworking reference points and interfaces + +The reference points and network interfaces shown in figure 1 are as described: + +Protocol for Mg reference point: The single call control protocol applied across the Mg reference point (i.e. between CSCF and MGCF) will be based on the 3GPP profile of SIP as defined in accordance with 3GPP TS 24.229 [9]. + +Protocol for Mn reference point: The Mn reference point describes the interfaces between the MGCF and IM-MGW, and has the properties as detailed in 3GPP TS 29.332 [15]. + +Protocol for Mj reference point: The single call control protocol applied across the Mj reference point (i.e. between BGCF and MGCF) will be based on the 3GPP profile of SIP as defined in accordance with 3GPP TS 24.229 [9]. + +Protocol for Mb reference point: The Mb reference point is defined in accordance with 3GPP TS 23.002 [10] and is IPv6 based. + +#### 6.1.2 Interworking functional entities + +##### 6.1.2.1 Signalling Gateway Function (SGW) + +This component performs the call related signalling conversion to or from BICC/ISUP based MTP transport networks to BICC/ISUP based SCTP/IP transport networks, and forwards the converted signalling to or from the MGCF. The functionality within SGW shall be in accordance with 3GPP TS 23.002 [10]. + +### 6.1.2.2 Media Gateway Control Function (MGCF) + +This is the component within the IM CN subsystem, which controls the IM-MGW, and also performs SIP to BICC or SIP to ISUP call related signalling interworking. + +The functionality defined within MGCF shall be defined in accordance with 3GPP TS 23.002 [10]. + +### 6.1.2.3 IP Multimedia - Media Gateway Function (IM-MGW) + +This is the component within the IM CN subsystem, which provides the interface between the PS domain and the CS domain, and it shall support the functions as defined in accordance with 3GPP TS 23.002 [10]. + +## 6.2 Control plane interworking model + +Within the IM CN subsystem, the 3GPP profile of SIP is used to originate and terminate IM sessions to and from the UE. + +External CS networks use BICC or ISUP to originate and terminate voice calls to and from the IM CN subsystem. + +Therefore, in order to provide the required interworking to enable inter network session control, the control plane protocols shall be interworked within the IM CN subsystem. This function is performed within the MGCF (see clause 6.1.2). + +## 6.3 User plane interworking model + +Within the IM CN subsystem, IPv6, and framing protocols such as RTP, are used to transport media packets to and from the IM CN subsystem entity like UE or MRFP. + +External legacy CS networks use circuit switched bearer channels like TDM circuits (e.g. 64 kbits PCM), ATM/AAL2 circuit or IP bearers to carry encoded voice frames, to and from the IM CN subsystem. + +Other CN networks use ATM/AAL 1 or AAL 2 or IP as a backbone, with different framing protocols. + +Therefore, in order to provide the required interworking to enable media data exchange, the user plane protocols shall be translated within the IM CN subsystem. This function is performed within the IM-MGW (see clause 6.1.2). + +--- + +# 7 Control plane interworking + +Signalling from CS networks to or from IM CN subsystem, where the associated supported signalling protocols are SS7/M3UA+ SCTP+IP and M3UA+SCTP+IP respectively, requires a level of interworking between the nodes across the Control Plane, i.e. the SS7 signalling function, SGW (if applicable), MGCF and SIP signalling function. This interworking is required in order to provide a seamless support of a user part, i.e. SIP and BICC+STCmtp or SIP and ISUP. + +The transport of SS7 signalling protocol messages of any protocol layer that is identified by MTP level 3, in SS7 terms, as a user part (MTP3-user) shall be accomplished in accordance with the protocol architecture defined in the following clauses. For the present document these protocol layers include, but are not limited to, Bearer Independent Call Control (BICC)+STCmtp and ISDN User Part (ISUP). + +## 7.1 General + +The following clauses define the signalling interworking between the Bearer Independent Call Control (BICC) or ISDN User Part (ISUP) protocols and Session Initiation Protocol (SIP) with its associated Session Description Protocol (SDP) at a MGCF. The MGCF shall act as a Type A exchange (ITU-T Recommendation Q.764 [4]) for the purposes of ISUP and BICC Compatibility procedures. The services that can be supported through the use of the signalling interworking are limited to the services that are supported by BICC or ISUP and SIP based network domains. + +BICC is the call control protocol used between Nodes in a network that incorporates separate call and bearer control. The BICC/ISUP capabilities or signalling information defined for national use is outside the scope of the present document. It does not imply interworking for national-specific capabilities is not feasible. + +The capabilities of SIP and SDP that are interworked with BICC or ISUP are defined in 3GPP TS 24.229 [9]. + +Services that are common in SIP and BICC or ISUP network domains will seamlessly interwork by using the function of the MGCF. The MGCF will originate and/or terminate services or capabilities that do not interwork seamlessly across domains according to the relevant protocol recommendation or specification. + +How to create a SIP component which is not mapped from BICC or ISUP parameter(s) (e.g., the SIP domain name in the SIP URI) is outside the scope of this specification. + +Table 1 lists the services seamlessly interworked and therefore within the scope of the present document. + +**Table 1: Interworking Capabilities between BICC/ISUP and SIP profile for 3GPP** + +| Service | +|------------------------------------------------------------------| +| Speech/3.1 kHz audio | +| CS data Calls (optional) | +| En bloc address signalling | +| Overlap address signalling from the CS side towards the IMS | +| Out of band transport of DTMF tones and information. (BICC only) | +| Inband transport of DTMF tones and information. (BICC and ISUP) | +| Direct-Dialling-In (DDI) | +| Multiple Subscriber Number (MSN) | +| Calling Line Identification Presentation (CLIP) | +| Calling Line Identification Restriction (CLIR) | +| Connected line presentation (COLP) | +| Connected line restriction (COLR) | +| Carrier routeing | + +## 7.2 Interworking between CS networks supporting ISUP and the IM CN subsystem + +The control plane between CS networks supporting ISUP and the IM CN subsystem supporting SIP, where the underlying network is SS7 and IP respectively is as shown in figure 2. + +![Figure 2: Control plane interworking between CS networks supporting ISUP and the IM CN subsystem. The diagram shows four main components: SS7 signalling function, Signalling gateway function, Media gateway control function, and SIP signalling function. The SS7 signalling function contains ISUP, MTP3, MTP2, and L1 layers. The Signalling gateway function contains MTP3, MTP2, L1, M3UA, SCTP, and IP layers. The Media gateway control function contains ISUP, SIP, M3UA, SCTP, and IP layers. The SIP signalling function contains SIP, TCP/UDP/SCTP, and IP layers. Arrows indicate the flow of ISUP, SS7, IP, and SIP signals between these functions.](ca5dc5fde2061d0ca2051ef7840fc842_img.jpg) + +The diagram illustrates the control plane interworking between CS networks and the IM CN subsystem. It consists of four main functional blocks connected in a chain: + +- SS7 signalling function:** Contains layers ISUP, MTP3, MTP2, and L1. It connects to the Signalling gateway function via an SS7 link at the L1 layer. +- Signalling gateway function:** Contains layers MTP3, MTP2, L1, M3UA, SCTP, and IP. It receives SS7 from the SS7 signalling function and forwards ISUP (via M3UA) and IP (via SCTP) to the Media gateway control function. +- Media gateway control function:** Contains layers ISUP, SIP, M3UA, SCTP, and IP. It receives ISUP and IP from the Signalling gateway function and forwards SIP and IP to the SIP signalling function. +- SIP signalling function:** Contains layers SIP, TCP/UDP/SCTP, and IP. It receives SIP and IP from the Media gateway control function. + +Key connections: + +- An **ISUP** signal flows from the SS7 signalling function (ISUP layer) through the Signalling gateway function (M3UA layer) to the Media gateway control function (ISUP layer). +- An **SS7** signal flows from the SS7 signalling function (L1 layer) to the Signalling gateway function (L1 layer). +- An **IP** signal flows from the Signalling gateway function (IP layer) to the Media gateway control function (IP layer). +- A **SIP** signal flows from the Media gateway control function (SIP layer) to the SIP signalling function (SIP layer). +- An **IP** signal flows from the Media gateway control function (IP layer) to the SIP signalling function (IP layer). + +Figure 2: Control plane interworking between CS networks supporting ISUP and the IM CN subsystem. The diagram shows four main components: SS7 signalling function, Signalling gateway function, Media gateway control function, and SIP signalling function. The SS7 signalling function contains ISUP, MTP3, MTP2, and L1 layers. The Signalling gateway function contains MTP3, MTP2, L1, M3UA, SCTP, and IP layers. The Media gateway control function contains ISUP, SIP, M3UA, SCTP, and IP layers. The SIP signalling function contains SIP, TCP/UDP/SCTP, and IP layers. Arrows indicate the flow of ISUP, SS7, IP, and SIP signals between these functions. + +**Figure 2: Control plane interworking between CS networks supporting ISUP and the IM CN subsystem** + +## 7.2.1 Services performed by network entities in the control plane + +### 7.2.1.1 Services performed by the SS7 signalling function + +The SS7 signalling function provides the capabilities to deliver or receive SS7 MTP3-User information (e.g. ISUP or BICC+STCmtp) across the SS7 signalling network. The functional interface of the MTP, the MTP User parts and the signalling network are as detailed in ITU-T Recommendations Q.701 to Q.709 [3]. + +### 7.2.1.2 Services of the SGW + +The SGW shall perform the functions as described in 3GPP TS 23.002 [10]. + +In order to support the seamless operation of the MTP3-User part information between networks incorporating SS7 and IP (either IPv4, see RFC 791 [16], or IPv6, see RFC 2460 [39]), the SGW shall support the services of MTP as well as the services of the M3UA (see 3GPP TS 29.202 [20]) and SCTP (see RFC 2960 [18]). + +### 7.2.1.3 Services of the MGCF + +The session handling and session control of the MGCF shall be as detailed in 3GPP TS 24.229 [9]. + +The MGCF shall provide the interaction, through the use of its interworking function, between the SS7 MTP3-User part information, e.g. ISUP, and SIP. The MGCF interworking function shall also provide the translation between the SS7 MTP3-User part information and SIP, where the interworking of SIP to ISUP and BICC+STCmtp are detailed below. + +### 7.2.1.4 Services of the SIP signalling function + +The SIP signalling function is a logical entity that provides the capabilities to deliver or receive multimedia session information across the IM CN subsystem signalling system. + +## 7.2.2 Signalling interactions between network entities in the control plane + +### 7.2.2.1 Signalling between the SS7 signalling function and MGCF + +The SGW shall enable the signalling interaction between the SS7 signalling function and the MGCF. + +#### 7.2.2.1.1 Signalling from MGCF to SS7 signalling function + +For signalling from the MGCF to the SS7 signalling function, the SGW shall terminate the SCTP and M3UA protocol layers and deliver the MTP3-User protocol messages, e.g. ISUP messages, towards the SS7 signalling function. The SGW transmits and receives SS7 Message Signalling Units (MSUs) to and from the SS7 signalling function over standard SS7 network interfaces, using MTP to provide reliable transport of the messages. + +#### 7.2.2.1.2 Signalling from SS7 signalling function to MGCF + +For signalling from the SS7 signalling function to the MGCF, the SGW shall terminate SS7 MTP2 and MTP3 protocol layers and deliver MTP3-User part information messages, e.g. ISUP, towards the MGCF. In order to direct messages received from the SS7 MTP3 network to the appropriate IP destination, e.g. MGCF, the SGW shall perform a message distribution function using the information received from the MTP3-User message. Message distribution at the SGW shall be performed in accordance with 3GPP TS 29.202 [20]. + +#### 7.2.2.1.3 Services offered by SCTP and M3UA + +The SGW internal protocol mapping and transportation between BICC or ISUP messages and IP encapsulated BICC or ISUP messages respectively is supported by the services of the M3UA adaptation layer and the underlying SCTP layer. The SGW shall allow for the transfer of MTP3-User signalling messages, e.g. BICC or ISUP, to and from an MGCF, where the peer MTP3-User protocol exists. + +##### 7.2.2.1.3.1 Services offered by SCTP + +SCTP offers the ability to reliably transfer the SCTP User applications, e.g. M3UA, between the SCTP User application peers. The initialization procedure used for an association between two SCTP end-to-end peers, and the initialization to the SCTP User applications shall be performed as detailed in RFC 2960 [18]. + +#### 7.2.2.1.3.2 Services offered by M3UA + +When an association between two SCTP peers has been established, the use of M3UA shall provide the transport service in accordance with MTP (see ITU-T Recommendations Q.701 to Q.709 [3]) to the MTP3-User, e.g. ISUP. + +#### 7.2.2.2 Signalling between the MGCF and SIP signalling function + +Signalling between the SIP signalling function and the MGCF uses the services of IP (RFC 2460 [39]), and transport protocol such as TCP (RFC 793 [24]) or UDP (RFC 768 [17]) or SCTP (RFC 2960 [18]) (see 3GPP TS 24.229 [9]), and SIP. + +The naming and addressing concepts between the MGCF and SIP signalling function shall be detailed in accordance with 3GPP TS 23.228 [12]. The issues of general IP address management are discussed in 3GPP TS 23.221 [47]. + +### 7.2.3 SIP-ISUP protocol interworking + +When a coding of a parameter value is omitted it implies that it is not affected by the interworking and the values are assigned by normal protocol procedures. + +#### 7.2.3.1 Incoming call interworking from SIP to ISUP at I-MGCF + +##### 7.2.3.1.1 Sending of IAM + +On reception of a SIP INVITE requesting a session, the I-MGCF shall send an IAM message. The allowed sessions are given in clause 7.2.3.1.2.5. + +An I-MGCF shall support both incoming INVITE requests containing SIP preconditions and 100rel extensions in the SIP Supported or Require header fields, and INVITE requests not containing these extensions, unless the Note below applies. + +NOTE: If the I-MGCF is deployed in an IMS network that by local configuration serves no user requiring preconditions, the MGCF may not support incoming requests requiring preconditions. + +The I-MGCF shall interwork forked INVITE requests with different request URIs. + +If the SIP precondition extension is not included in the Supported or Require header field, the I-MGCF shall send an IAM immediately after the reception of the INVITE, as shown in figure 3. The I-MGCF shall set the continuity indicators to "Continuity check not required". + +If a Continuity Check procedure is supported in the ISUP network and SIP precondition extension are included in the SIP Supported or Require header field, the I-MGCF shall send the IAM immediately after the reception of the INVITE, as shown in figure 3. If the received SDP indicates that precondition is fulfilled the I-MGCF shall set the continuity indicators to "continuity check is not required". If the received SDP indicates that precondition is not fulfilled the I-MGCF shall set the continuity indicators to "continuity check performed on a previous circuit". The procedure in figure 3 applies when the value of the continuity indicator is either set to "continuity check required", "continuity check performed on a previous circuit" or "continuity check not required". If the continuity indicator is set to "continuity check required" the corresponding procedures at the Mn interface described in clause 9.2.2.3 also apply. + +![Diagram showing the receipt of an INVITE request and the subsequent sending of an IAM message at the I-MGCF. An arrow labeled 'INVITE' points to a vertical line representing the I-MGCF. From the I-MGCF, an arrow labeled 'IAM' points to the right.](bf32ff2a1af507083217ccc56c515a50_img.jpg) + +``` +graph LR; INVITE[INVITE] --> I-MGCF[I-MGCF]; I-MGCF --> IAM[IAM]; +``` + +Diagram showing the receipt of an INVITE request and the subsequent sending of an IAM message at the I-MGCF. An arrow labeled 'INVITE' points to a vertical line representing the I-MGCF. From the I-MGCF, an arrow labeled 'IAM' points to the right. + +**Figure 3: Receipt of an INVITE request (continuity procedure supported in the ISUP network)** + +If Continuity Check procedure is not supported in the ISUP network, and the SDP in the received INVITE request contains preconditions not met, the I-MGCF shall delay sending the IAM until the SIP preconditions are met and set the continuity indicators in the resulting IAM to "Continuity check not required". + +![Diagram showing the receipt of an INVITE request by an I-MGCF. An INVITE message is received from the left. A box labeled 'SDP indicating pre-conditions met' is shown below the INVITE message, with an arrow pointing from it to the I-MGCF. The I-MGCF then sends an IAM message to the right.](b51423b6c049f5b5fcde42e50b58f18b_img.jpg) + +``` + +graph LR + INVITE[INVITE] --> I-MGCF[I-MGCF] + subgraph Box [SDP indicating pre-conditions met] + SDP[SDP indicating pre-conditions met] + end + SDP --> I-MGCF + I-MGCF --> IAM[IAM] + +``` + +Diagram showing the receipt of an INVITE request by an I-MGCF. An INVITE message is received from the left. A box labeled 'SDP indicating pre-conditions met' is shown below the INVITE message, with an arrow pointing from it to the I-MGCF. The I-MGCF then sends an IAM message to the right. + +**Figure 4: Receipt of an INVITE request (continuity procedure not supported in the ISUP network)** + +The I-MGCF shall reject an INVITE request for a session only containing unsupported media types by sending a status code 488 "Not Acceptable Here". If several media streams are contained in a single INVITE request, and if the I-MGCF does not support multimedia interworking according to Annex E, then the I-MGCF shall select one of the supported media streams, reserve the codec(s) for that media stream, and reject the other media streams and unselected codecs in the SDP answer, as detailed in IETF RFC 3264 [36]. If supported audio media stream(s) and supported non-audio media stream(s) are contained in a single INVITE request, an audio stream should be selected. + +The I-MGCF shall include a To tag in the first backward non-100 provisional response, in order to establish an early dialog as described in IETF RFC 3261 [19]. + +If an MGCF discovers an emergency call it shall, depending on national requirements, map that to appropriate indication in ISUP. + +According to IETF RFC 3261 [19] and IETF RFC 3264 [36], if an INVITE message is received without an SDP offer, then the I-MGCF sends an SDP offer in the first reliable non-failure message. + +### 7.2.3.1.2 Coding of the IAM + +#### 7.2.3.1.2.0 General + +The following ISDN user part parameters description can be found in ITU-T Recommendation Q.763 [4]. + +##### 7.2.3.1.2.1 Called party number + +The E.164 address encoded in the Request-URI shall be mapped to the called party number parameter of the IAM message. + +**Table 2: Coding of the called party number** + +| INVITE→ | IAM→ | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| Request-URI | Called Party Number | | | +| E.164 address
(format +CC
NDC SN)
(e.g. as User info
portion of a SIP
URI with
user=phone, or
as tel URI) | Address Signal:
Analyse the information contained in received E.164 address.
If CC is country code of the network in which the next hop terminates, then remove "+CC"
and use the remaining digits to fill the Address signals.
If CC is not the country code of the network in which the next hop terminates, then remove
"+" and use the remaining digits to fill the Address signals.
(NOTE 2) | | | +| | Odd/even indicator: set as required | | | +| | Nature of address indicator:
Analyse the information contained in received E.164 address.
If CC is country code of the network in which the next hop terminates, then set Nature of
Address indicator to "National (significant) number".
If CC is not the country code of the network in which the next hop terminates, then set
Nature of Address indicator to "International number".
(NOTE 1) | | | +| | Internal Network Number Indicator:
1 routing to internal network number not allowed | | | +| | Numbering plan Indicator:
001 ISDN (Telephony) numbering plan (Rec. E.164) | | | +| national operator
option for service
numbers:

Non E.164
numbers
(as a local-
number with a
phone-context in
the User Info
portion in a SIP
URI with
user=phone, or
as a local
number with a
phone-context in
a tel URI) | (NOTE 3) | Address Signal:
use received non E.164 number to fill the Address signals with national
significant number. | | +| | | Odd/even indicator: set as required | | +| | | Nature of address indicator:
"National (significant) number". (NOTE 1) | | +| | | Internal Network Number Indicator:
1 routing to internal network number not allowed | | +| | | Numbering plan Indicator:
001 ISDN (Telephony) numbering plan (Rec. E.164) | | +| (NOTE 3) | | Address Signal:
Use received non E.164 number to fill the Address signals. | | +| | | Odd/even indicator: set as required | | +| | | Nature of address indicator:
set Nature of Address indicator to "network-specific number" or to "reserved
for national use". | | +| | | Internal Network Number Indicator:
1 routing to internal network number not allowed | | +| | | Numbering plan Indicator:
Based on operator policy other numbering plan indicators than "001 ISDN
(Telephony) numbering plan (Rec. E.164)" can be used e.g. depending on
phone context value. | | +| NOTE 1: The usage of "nature of address indicator" value "unknown" is allowed but the mapping is not specified in the present specification. | | | | +| NOTE 2: If PSTN XML and ISUP Sending Terminated (ST) signal are supported as a network option, then the PSTN XML sendingCompleteIndication, if present, is mapped to the sending terminated digit (hexadecimal digit F) in the address signals field of the Called Party Number parameter. | | | | +| NOTE 3: Depending on configuration, network-specific numbers (identified by phone context according to operator policy) should be translated into "ISDN (Telephony) numbering plan numbers (Rec. E.164)" unless such a mapping is not possible and local operator's policy requires keeping them in local format. | | | | + +#### 7.2.3.1.2.2 Nature of connection indicators + +bits BA Satellite indicator + +0 0 *no satellite circuit in the connection* + +bits DC Continuity check indicator + +- 0 0 *continuity check not required*, if the continuity check procedure is not supported in the succeeding network (figure 4). + - 0 1 *continuity check required*, if a continuity check shall be carried out on the succeeding circuit. (figure 3) + - 1 0 *continuity check performed on a previous circuit otherwise*, if the continuity check procedure is supported in the succeeding network, but shall not be carried out on the succeeding circuit otherwise. (figure 3) +- bit E Echo control device indicator +- 1 *outgoing echo control device included*, for speech calls, e.g., TMR is "3.1KHz audio". + - 0 *outgoing echo control device not included*, for known data calls, e.g., TMR "64 kBit/s unrestricted" or HLC "Facsimile Group 2/3". + +#### 7.2.3.1.2.3 Forward call indicators + +- bits CB End-to-end method indicator +- 0 0 *no end-to-end method available (only link-by-link method available)* +- bit D Interworking indicator +- 1 *interworking encountered* + +As a network operator option, the value D = 0 "No interworking encountered" is used if the TMR = 64 kBit/s unrestricted is used. + +NOTE: This avoids sending of a progress indicator with progress information 0 0 0 0 0 0 1 "Call is not end-to-end ISDN; further call progress information may be available in-band", so the call will not be released for that reason by an ISDN terminal. + +- bit E End-to-end information indicator (national use) +- 0 *no end-to-end information available* +- bit F ISDN user part/BICC indicator +- 0 *ISDN user part/BICC not used all the way* + +As a network operator option, the value F = 1 "ISDN user part/BICC used all the way" is used if the TMR = 64 kBit/s unrestricted is used. + +NOTE: This avoids sending of a progress indicator with progress information 0 0 0 0 0 0 1 "Call is not end-to-end ISDN; further call progress information may be available in-band", so the call will not be released for that reason by an ISDN terminal. + +- bits HG ISDN user part/BICC preference indicator +- if any used supplementary service requires ISUP or BICC all the way, depending on operator policy: +- 0 0 *ISDN user part/BICC preferred all the way*, or + - 1 0 *ISDN user part/BICC required all the way*; +- Otherwise: +- 0 1 *ISDN user part/BICC not required all the way* +- bit I ISDN access indicator +- 0 *originating access non-ISDN* + +As a network operator option, the value I = 1 "originating access ISDN" is used if the TMR = 64 kBit/s unrestricted is used. + +NOTE: This avoids sending of a progress indicator with progress information 0 0 0 0 1 1 "Originating access is non-ISDN", so the call will not be released for that reason by an ISDN terminal. + +bits KJ SCCP method indicator + +0 0 *no indication* + +If the PSTN XML is supported as a network option, the Forward Call indicators derived as shown in Table 02a shall take precedence. + +**Table 02a: Mapping of PSTN XML elements to Forward call indicators parameter** + +| INVITE →
PSTN XML | IAM →
Forward call indicators parameter | | +|--------------------------------------------------------------------------------------------------------------|--------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| PSTN XML with Progress indicator with Progress Description value 6 (Meaning: originating access ISDN) | bit D
0
bit F
1
bit I
1 | Interworking Indicator
"no interworking encountered (No. 7 signalling all the way)"
ISDN User Part indicator
"ISDN User Part used all the way"
ISDN access indicator
"originating access ISDN" | +| NOTE: Progress Indicator with Progress Description value "6" shall not be included in an ATP within the IAM. | | | + +#### 7.2.3.1.2.4 Calling party's category + +See ANNEX C for the normative interworking of the CPC parameter. + +##### 7.2.3.1.2.4A Originating Line Information + +The ISUP Originating Line Information parameter is defined by ANSI Standard ATIS-1000113 [117], Chapter 3. + +See Annex H for the normative interworking of the OLI parameter as a network option. + +##### 7.2.3.1.2.5 Transmission medium requirement + +The I-MGCF may either transcode the selected codec(s) to the codec on the PSTN side or it may attempt to interwork the media without transcoding. If the I-MGCF transcodes, it shall select the TMR parameter to "3.1 kHz audio". If the I-MGCF does not transcode, it should map the TMR, USI and Access Transport parameters from the selected codec according to Table 2a. However, if the I-MGCF supports the PSTN XML body as a network option, and if a PSTN XML body is received in the INVITE request and the I-MGCF selects media encoded in any of the formats in table 2a (G.711, Clearmode or t38) among the offered media, the I-MGCF shall derive these parameters from the XML body instead, as detailed in table 2b. The I-MGCF should only apply the mapping in table 2b if the TMR and USI values derived from the selected codec according to table 2a are equivalent with the values within the first Bearer Capability element in the PSTN XML, and otherwise the I-MGCF should apply the mapping according to table 2a. + +The support of any of the media listed in table 2a is optional. + +If no SDP is received from the remote peer (as described in clause 7.2.3.1.1), then the TMR parameter should be set to "3.1 kHz audio". Transcoding shall be applied as required. + +**Table 2a: Coding of TMR/USI/HLC from SDP: SIP to ISUP** + +| | m= line | | b= line (NOTE 4) | a= line | TMR parameter | USI parameter (optional) (NOTE 1) | | HLC IE in the ATP parameter (optional) | +|---------|-------------|------------|----------------------------------------------------|-------------------------------------------------------------------------------|---------------------------------------------------------------------|------------------------------------------------|---------------------------------------------|-------------------------------------------| +| | | | :
(NOTE 5) | rtpmap:

[] | TMR codes | Information Transfer Capability | User Information Layer 1 Protocol Indicator | High Layer Characteristics Identification | +| audio | RTP/AVP | 0 | N/A or AS: up to (64 kbit/s + RTP/UDP/IP overhead) | N/A | "3.1KHz audio" | | | (NOTE 3) | +| audio | RTP/AVP | Dynamic PT | N/A or AS: up to (64 kbit/s + RTP/UDP/IP overhead) | rtpmap:
PCMU/8000 | "3.1KHz audio" | | | (NOTE 3) | +| audio | RTP/AVP | 8 | N/A or AS: up to (64 kbit/s + RTP/UDP/IP overhead) | N/A | "3.1KHz audio" | | | (NOTE 3) | +| audio | RTP/AVP | Dynamic PT | N/A or AS: up to (64 kbit/s + RTP/UDP/IP overhead) | rtpmap:
PCMA/8000 | "3.1KHz audio" | | | (NOTE 3) | +| audio | RTP/AVP | Dynamic PT | AS: (64 kbit/s + RTP/UDP/IP overhead) | rtpmap:
CLEARMODE/8000
(NOTE 2) | "64 kbit/s unrestricted"
or
"64 kbit/s preferred"
(NOTE 7) | "Unrestricted digital information"
(NOTE 6) | | | +| image | Udptl [73] | t38 [73] | N/A or AS: up to (64 kbit/s + UDP/IP overhead) | Based on ITU-T T.38 [72] (NOTE 8) | "3.1 KHz audio" | "3.1 KHz audio" | | "Facsimile Group 2/3" | +| image | tcp | t38 [73] | N/A or AS: up to (64 kbit/s + TCP/IP overhead) | Based on ITU-T T.38 [72] | "3.1 KHz audio" | "3.1 KHz audio" | | "Facsimile Group 2/3" | + +NOTE 1: In this table the codec G.711 is used only as an example. Other codecs are possible. + +NOTE 2: CLEARMODE is specified in RFC4040 [69]. + +NOTE 3: HLC is normally absent in this case. It is possible for HLC to be present with the value "Telephony", although 6.3.1/Q.939 indicates that this would normally be accompanied by a value of "Speech" for the Information Transfer Capability element. + +NOTE 4: The MGCF should return an b:AS bandwidth modifier with a bandwidth of 64kbit/s + RTP/UDP/IP overhead in the SDP answer to request that the peer does not send with a higher bandwidth. If the received b=line indicates a bandwidth greater than 64kbit/s + RTP/UDP/IP overhead, the MGCF should also accept the incoming call. + +NOTE 5: for of AS is in units of kbit/s. + +NOTE 6: In the case where the Clearmode codec appears together with speech codecs in the same m-line, the value "Unrestricted digital inf. w/tones/ann" is applicable but is mapped into the USI prime parameter (see clause 7.2.3.1.2.5a). + +NOTE 7: The value "64 k/bits preferred" should only be used if the Clearmode codec appears together with speech codecs in the same m-line and two PSTN XML Bearer Capability elements appear in the initial INVITE request as described in the clause 7.2.3.1.2.5a. + +NOTE 8: Annex K describes recommended values. + +**Table 2b: Mapping of PSTN XML elements into ISUP Parameters** + +| INVITE ⌂ | | IAM ⌂ | | +|-----------------------------------------------------------------|-----------------------------------------------------------|----------------------------|-----------------------------------| +| PSTN XML | Value | ISUP Parameter | Content | +| HighLayerCompatibility | | Access Transport Parameter | High layer compatibility (NOTE 1) | +| LowLayerCompatibility | | | Low layer compatibility | +| BearerCapability (NOTE 2) | | User Service Information | | +| HighLayerCompatibility | | User Tele Service | High layer compatibility | +| BearerCapability
(InformationTransferCapability)
(NOTE 2) | Speech | TMR | Speech | +| | 3.1 kHz audio | | 3.1 kHz audio | +| | Unrestricted digital information | | 64 kbit/s unrestricted | +| | Unrestricted digital information with tones/announcements | | 64 kbit/s unrestricted | + +NOTE 1: If two high layer compatibility information elements are received, they shall be transferred in the same order as received in the PSTN XML body in the INVITE message. +NOTE 2: If there are two BCs present, see clause 7.2.3.1.2.5a. +NOTE 3: The above mapping assumes that there is only a single BearerCapability present. + +#### 7.2.3.1.2.5a Transmission medium requirement prime and USI prime (optional) + +The procedures to support UDI-TA Fallback mechanism described in the present clause shall only apply if two PSTN XML Bearer Capability elements appear within the INVITE Request and the MGCF supports the PSTN XML body as a network option. + +When all the following conditions apply: + +- The INVITE request includes SDP with one m-line with at least two formats, and with the coding of the first two formats appearing in table 2a; +- the TMR and USI prime values derived from the first format in the m-line according to table 2a are equivalent with the values within the second Bearer Capability element in the PSTN XML; +- the TMR prime and USI values derived from the second format in the m-line according to table 2a are equivalent with the values within the first Bearer Capability element in the PSTN XML; and +- the I-MGCF supports forwarding fallback signalling. + +Then the I-MGCF shall + +- if TMR "64 kBit/s preferred" is supported at the succeeding trunk: + - map the first XML Bearer Capability element into the "USI" within the IAM; + - map the the first PSTN XML BearerCapability (InformationTransferCapability) into the "TMR prime" within the IAM, applying the same mapping rules as specified for the mapping into the "TMR" in table 2b; + - map the second XML Bearer Capability element (InformationTransferCapability) into the USI prime within the IAM; + - set the TMR within the IAM to "64 kBit/s preferred"; + - configure the IM-MGW; and + - store those values; +- if TMR "64 kBit/s preferred" is not supported at the succeeding trunk: + - apply the procedures as described within clause 7.2.3.1.2.5, using the first Bearer Capability element in the PSTN XML and the second format in the m-line; + +discard the second Bearer Capability element in the PSTN XML; + +- select the second format in the m-line within the SDP answer; and +- configure the IM-MGW. + +Otherwise (i.e. if some Bearer Capability element in the PSTN XML did not match the SDP), the I-MGCF shall: + +- discard the XML Bearer Capability elements; +- if the I-MGCF received at least two formats within the m-line, select one of those formats, except for the CLEARMODE codec, within the SDP answer; +- apply the mapping for the selected format according to table 2a; and +- configure the IM-MGW accordingly + +#### 7.2.3.1.2.6 Calling party number + +The SIP "Privacy" header is defined within IETF RFC 3323 [40]. The SIP "P-Asserted-Identity" header is defined in IETF RFC 3325 [41]. + +**Table 3: Mapping of SIP From/P-Asserted-Identity/Privacy headers to CLI parameters** + +| Has a "P-Asserted-Identity" header field (NOTE 2, NOTE 5, NOTE 6) been received? | Has a "From" header field (NOTE 3) containing a URI that encodes an E.164 address been received (NOTE 6)? | Calling Party Number parameter Address signals | Calling Party Number parameter APRI | Generic Number (additional calling party number) address signals | Generic Number parameter APRI | +|----------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------| +| No | No | Network option to either include a network provided E.164 number (See table 4) or omit the Address signals. | Network option to set APRI to "presentation restricted" or "presentation allowed" (NOTE 4) (See table 5)
As a network option the APRI "presentation restricted by network" (NOTE 7) can be used instead of the APRI "presentation restricted" | Parameter not included | Not applicable | +| No | Yes | Network option to either include a network provided E.164 number (See table 4) or omit the Address signals. | Network option to set APRI to "presentation restricted" or "presentation allowed" (NOTE 4) (See table 5)
As a network option the APRI "presentation restricted by network" (NOTE 7) can be used instead of the APRI "presentation restricted" | Network option to either omit the parameter (if CgPN has been omitted) or derive from the "From" header (NOTE 1) (See table 6) | APRI = "presentation restricted" or "presentation allowed" depending on SIP Privacy header. (See table 6) | +| Yes | No | Derived from P-Asserted-Identity (See table 5) | APRI = "presentation restricted" or "presentation allowed" depending on SIP Privacy header. (See table 5) | Not included | Not applicable | +| Yes | Yes | Derived from P-Asserted-Identity (See table 5) | APRI = "presentation restricted" or "presentation allowed" depending on SIP Privacy header. (See table 5) | Network option to either omit the parameter or derive from the "From" header (NOTE 1) (See table 6) | APRI = "presentation restricted" or "presentation allowed" depending on SIP Privacy header. (see table 6) | + +| Has a "P-Asserted-Identity" header field (NOTE 2, NOTE 5, NOTE 6) been received? | Has a "From" header field (NOTE 3) containing a URI that encodes an E.164 address been received (NOTE 6)? | Calling Party Number parameter Address signals | Calling Party Number parameter APRI | Generic Number (additional calling party number) address signals | Generic Number parameter APRI | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------|------------------------------------------------|-------------------------------------|------------------------------------------------------------------|-------------------------------| +|

NOTE 1: This mapping effectively gives the equivalent of Special Arrangement to all SIP UAC with access to the I-MGCF.

NOTE 2: It is possible that the P-Asserted-Identity header field includes both a tel URI and a SIP URI. In this case, either the tel URI or the SIP URI with user="phone" and a specific host portion, as selected by operator policy, may be used.

NOTE 3: The "From" header may contain an "Anonymous User Identity". An "Anonymous User Identity" includes information that does not point to the calling party. IETF RFC 3261 recommends that the display-name component contain "Anonymous". That the Anonymous User Identity will take the form defined in TS 23.003 [74]. The Anonymous User Identity indicates that the calling party desired anonymity. The From header may also contain an Unavailable User Identity as defined in TS 23.003 [74], that indicates that the calling party is unknown.

NOTE 4: A national option exists to set the APRI to "Address not available".

NOTE 5: TS 24.229 [9] guarantees that the received number is an E.164 number formatted as an international number, with a "+" sign as prefix.

NOTE 6: The E.164 numbers considered within the present document are composed by a Country Code (CC), followed by a National Destination Code (NDC), followed by a Subscriber Number (SN). On the IMS side, the numbers are international public telecommunication numbers ("CC"+"NDC"+"SN") and are prefixed by a "+" sign. On the CS side, it is a network option to omit the CC.

NOTE 7: This is an ETSI specific value described within ETSI EN 300 356-1 [70].

| | | | | | + +**Table 4: Setting of the network-provided BICC/ISUP calling party number parameter with a CLI (network option)** + +| BICC/ISUP CgPN Parameter field | Value | +|------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Screening Indicator | " network provided " | +| Number Incomplete Indicator | " complete " | +| Number Plan Indicator | ISDN/Telephony (E.164) | +| Address Presentation Restricted Indicator | Presentation allowed/restricted
As a network option the APRI value "presentation restricted by network" (NOTE) can be used instead of the APRI value "presentation restricted" | +| Nature of Address Indicator | If next BICC/ISUP node is located in the same country set to " National (Significant) number " else set to " International number " | +| Address signals | If NOA is " national (significant) number " no country code should be included. If NOA is " international number ", then the country code of the network-provided number should be included. | +| NOTE: This is an ETSI specific value described within ETSI EN 300 356-1 [70] | | + +**Table 5: Mapping of P-Asserted-Identity and privacy headers to the ISUP/BICC calling party number parameter** + +| SIP Component | Value | BICC/ISUP Parameter / field | Value | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| P-Asserted-Identity header field (NOTE 1) | E.164 number | Calling Party Number | | +| | | Number incomplete indicator | "Complete" | +| | | Numbering Plan Indicator | "ISDN/Telephony (E.164)" | +| | | Nature of Address Indicator | If CC encoded in the URI is equal to the CC of the country where MGCF is located AND the next BICC/ISUP node is located in the same country then set to " national (significant) number " else set to " international number " | +| | | Screening indicator (NOTE 2) | Network Provided | +| Addr-spec | "CC" "NDC" "SN" from the URI | Address signal | If NOA is " national (significant) number " then set to "NDC" + "SN"
If NOA is " international number " then set to "CC"+"NDC"+"SN" | +| Privacy header field is not present | | APRI | " presentation allowed " | +| Privacy header field (IETF RFC 3323 [40]) | priv-value | APRI | If the Privacy header field contains the values " id " (see IETF RFC 3325 [41]) and/or " header ", the APRI shall be set to " presentation restricted ". Otherwise, the APRI shall be set to " presentation allowed ". | +| NOTE 1: It is possible that a P-Asserted –Identity header field includes both a tel URI and a SIP URI. In this case, either the tel URI or the SIP URI with user="phone" and a specific host portion, as selected by operator policy, may be used. | | | | +| NOTE 2: As a network option, the MGCF may support "Calling number verification using signature verification and attestation information " feature as described in IETF RFC 8224 [153] and 3GPP TS 24.229 [9]. If the I-MGCF received a "verstat" tel URI parameter (defined in 3GPP TS 24.229 [9] clause 7.2A.20) in the P-Asserted-Identity header filed the I-MGCF may map the "verstat" tel URI parameter to the Screening Indicator field as follows:
- the value "No-TN-Validation" to the value "user provided, not verified";
- the value "TN-Validation-Passed" to the value "user provided, verified and passed"; and
- the value "TN-Validation-Failed" to the value "user provided, verified and failed". | | | | + +## 7.2.3.1.2.7 Generic number + +**Table 6: Mapping of SIP from header field to BICC/ISUP generic number (additional calling party number) parameter (network option)** + +| SIP component | Value | BICC/ISUP parameter / field | Value | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| From header field | name-addr or addr-spec | Generic number
Number Qualifier Indicator | " additional calling party number " | +| | | Nature of Address Indicator | If CC encoded in the URI is equal to the CC of the country where MGCF is located AND the next BICC/ISUP node is located in the same country then set to " national (significant) number " else set to " international number " | +| | | National operator option for local numbers (NOTE 2):
Nature of Address Indicator | Based on the received local number and phone-context set to " subscriber number " or " unknown ". (NOTE 3) | +| | | Number incomplete indicator | " Complete " | +| | | Numbering Plan Indicator | " ISDN/Telephony (E.164) " | +| | | Screening indicator (NOTE 1) | " user provided not verified " | +| Addr-spec | E.164 address (format "+" "CC" "NDC" "SN") from the URI | Address signal | If NOA is "national (significant) number" then set to "NDC" + "SN"
If NOA is "international number" then set to "CC"+"NDC"+"SN" | +| | National operator option for local numbers (NOTE 2):
non E.164 address (NOTE 4) | | Use received non E.164 number to fill the Address signals. | +| Privacy header field is not present | | APRI | " presentation allowed " | +| Privacy header field (IETF RFC 3323 [40]) | priv-value | APRI | If the Privacy header field contains the value "user", the APRI shall be set to " presentation restricted ". Otherwise, the APRI shall be set to " presentation allowed ". | +| NOTE 1: As a network option, the MGCF may support "Calling number verification using signature verification and attestation information" feature as described in IETF RFC 8224 [153] and 3GPP TS 24.229 [9]. If the I-MGCF received a "verstat" tel URI parameter (defined in 3GPP TS 24.229 [9] clause 7.2.A.20) in the From header field the I-MGCF may map the "verstat" tel URI parameter to the Screening Indicator field as follows:
- the value "No-TN-Validation" to the value "user provided, not verified";
- the value "TN-Validation-Passed" to the value "user provided, verified and passed"; and
- the value "TN-Validation-Failed" to the value "user provided, verified and failed". | | | | +| NOTE 2: Local numbers can e.g. be national service numbers, business trunking numbers, or private numbers. | | | | +| NOTE 3: Mapping between phone-context values and "Nature of Address Indicator" values is provisioned in the MGCF. Setting the values of "Nature of Address Indicator" is dependent on local operator's policies. | | | | +| NOTE 4: A non E.164 address can either be present as a local number with a phone-context parameter in the user portion of a SIP URI with "user=phone" or as a local number with a phone-context parameter in a tel URI. | | | | + +## 7.2.3.1.2.8 User service information + +For coding of the USI see 7.2.3.1.2.5. + +#### 7.2.3.1.2.9 Hop Counter (National option) + +The I-MGCF shall perform the following interworking procedure if the Hop Counter procedure is supported in the CS network. + +At the I-MGCF the Max-Forwards SIP header shall be used to derive the Hop Counter parameter if applicable. Due to the different default values (that are based on network demands/provisions) of the SIP Max-Forwards header and the Hop Counter, a factor shall be used to adapt the Max Forwards to the Hop Counter at the I-MGCF. For example, the following guidelines could be applied: + +- 1) Max-Forwards for a given message should be monotone decreasing with each successive visit to a SIP entity, regardless of intervening interworking, and similarly for Hop Counter. +- 2) The initial and successively mapped values of Max-Forwards should be large enough to accommodate the maximum number of hops that may be expected of a validly routed call. + +Table 7 shows the principle of the mapping: + +**Table 7: Max forwards - hop counter** + +| | | | | +|----------------------------------------------------------------------------------------------------|-----|-------------|----------------------------------| +| Max-Forwards | = X | Hop Counter | = INTEGER part of (X /Factor) =Y | +| NOTE: The Mapping of value X to Y should be done with the used (implemented) adaptation mechanism. | | | | + +The Principle of adoption could be implemented on a basis of the network provision, trust domain rules and bilateral agreement. + +#### 7.2.3.1.2.10 Progress Indicator + +If the I-MGCF supports the PSTN XML body as a network option and an INVITE containing a PSTN XML body is received, an available "ProgressIndicator" element in the PSTN XML body shall be mapped into a Progress Indicator in the Access Transport Parameter of the sent IAM as shown in table 7.2.3.1.2.10.1. + +**Table 7.2.3.1.2.10.1: Contents of the Access Transport Parameter** + +| INVITE → | IAM→ | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------| +| PSTN XML | Access Transport Parameter | +| Progress indicator | Progress indicator (NOTE) | +| NOTE: A ProgressIndicator with Progress Description value 6 shall not be included into the ISUP ATP, and is mapped instead to Forward call indicators parameter according to table 02a. | | + +#### 7.2.3.1.2.11 Location Number + +Location Number is defined in clause 3.30 of ITU-T Q.763 [4]. + +If the received INVITE message contains: + +- 1) only one P-Access-Network-Info header field and the P-Access-Network-Info header contains only one access network specific component then: + - a) if an access-type field with the value "GSTN" is received: + - i) if an access-info field with the value "gstn-location" is present and the value "operator-specific-GI" is not present, the I-MGCF shall include an ISUP Location Number parameter in the outgoing IAM set as shown in table 7.2.3.1.2.11.1; or + - ii) as a network option: + - if an access-info field with the value "operator-specific-GI" is present and the value "gstn-location" is not present, the I-MGCF shall include an ISUP Location Number parameter in the outgoing IAM set as shown in table 7.2.3.1.2.11.3; or + +- if both values "gstn-location" and "operator-specific-GI" are present, the I-MGCF shall include an ISUP Location Number parameter in the outgoing IAM set as shown in table 7.2.3.1.2.11.1 or table 7.2.3.1.2.11.3, based on local policy; or + - b) as a network option, if an access-type field with a value different from "GSTN" and an access-info field with the value "operator-specific-GI" are received, the I-MGCF shall include an ISUP Location Number parameter in the outgoing IAM as shown in table 7.2.3.1.2.11.3; or +- 2) more P-Access-Network-Info header fields or the P-Access-Network-Info header field contains more access network specific components then the I-MGCF shall select the access network specific component which contains a "network-provided" parameter and shall perform the mapping to an ISUP Location Number parameter as described in bullet 1). + +NOTE 1: According to 3GPP TS 24.229 [9] two P-Access-Network-Info header fields (or one P-Access-Network-Info header field with two access network specific components) can be received but only one access network specific component can contain the "network-provided" parameter. + +NOTE 2: A UE will not create the P-Access-Network-Info header field with the access-type field value "GSTN" and the "gstn-location" parameter, as specified in subclause 7.2A.4.2 of 3GPP TS 24.229 [9]. However the access-type field value "GSTN" without the "network-provided" parameter can be received in interworking cases when the IMS network is used between two CS networks and the P-Access-Network-Info header field was created by the O-MGCF in accordance to subclause 7.2.3.2.2.9. Based on local policy, the I-MGCF can select the P-Access-Network-Info header field with the access-type field value "GSTN" and without the "network-provided" parameter. + +**Table 7.2.3.1.2.11.1: Contents of the location number parameter** + +| INVITE → | IAM→ | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------| +| | Location Number parameter | +| P-Access-Network-Info with access-type="GSTN" and gstn-location parameter | Binary value derived from the gstn-location parameter of the P-Access-Network-Info | +| NOTE: The binary value shall be obtained by removing the quotes and converting each pair of consecutive character strings into an octet that has the equivalent hexadecimal representation | | + +**Table 7.2.3.1.2.11.2: Mapping of P-Access-Network-Info to Location Number** + +| INVITE→ | IAM→ | +|-------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| P-Access-Network-Info | Location Number | +| access type="GSTN"
gstn-location=value | Address Signal:
Copied from octet 3 to n of the binary representation of the gstn-location field
Odd/even indicator:
Copied from bit 8 octet 1 of the binary representation of the gstn-location field
Nature of address indicator:
Copied from bit 7 to 1 of octet 1 of the binary representation of the gstn-location field
Internal Network Number Indicator:
Copied from bit 8 of octet 2 of the binary representation of the gstn-location field
Numbering plan Indicator:
Copied from bit 7 to 5 of octet 2 of the binary representation of the gstn-location field
Address presentation restricted indicator:
If the SIP Privacy header field = header, APRI is set to "01 (presentation restricted)" otherwise APRI is copied from bit 4 and 3 of octet 2 of the binary representation of the gstn-location field
Screening indicator:
If the "network-provided" parameter is present in the P-Access-Network-Info header field, set to "11 (network provided)" otherwise set from bit 2 and 1 of octet 2 of the binary representation of the gstn-location field | + +**Table 7.2.3.1.2.11.3: Mapping of P-Access-Network-Info operator-specific-GI to Location Number** + +| INVITE → | IAM→ | +|------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | Location Number parameter | +| P-Access-Network-Info with
access-info="operator-specific-GI"
and operator-specific-GI parameter | | +| P-Access-Network-Info | Location Number | +| access-info="operator-specific-GI"
operator-specific-GI=value | Address Signal :
Copy the digits set by 2 digits per byte. In case of an odd number of address signals, the filler code 0000 is inserted after the last address signal.
Odd/even indicator:
Set as required
Nature of address indicator:
Set from an operator-configured value
Internal Network Number Indicator:
1 routing to internal network number not allowed
Numbering plan Indicator:
Set from an operator-configured value
Address presentation restricted indicator:
If the SIP Privacy header field = header, APRI is set to "01 (presentation restricted)"
Screening indicator:
If the "network-provided" parameter is present in the P-Access-Network-Info header field, set to "11 (network provided)" | +| NOTE: This mapping is only possible if the operator-specific-GI field of the P-Access-Network-Info header field contains a sequence of digits. | | + +#### 7.2.3.1.2.12 Support of ICS call + +If the received initial INVITE request contains a Feature Caps header field, defined in IETF RFC 6809 [142] with a "+g.3gpp.ics" header field parameter as specified in clause B.4 of 3GPP TS 24.292 [141] then according to operator policy the I-MGCF may mark a call as an "ICS call". + +For the call marked as the "ICS call" the I-MGCF shall include in the outgoing IAM message a redirection information parameter field set as shown in table 7.2.3.1.2.12.1. + +**Table 7.2.3.1.2.12.1: Contents of the redirection information parameter field** + +| INVITE → | IAM→ | | +|-------------------------------------------------------------------------------------------------|-----------------------------------------|--------------------------------------------------------------------| +| Feature-Caps header field with
g.3gpp.ics feature-capability indicator | Redirection information parameter field | | +| | Redirecting indicator | Call diverted, all redirection info presentation restricted | +| | Original redirection reason | Unknown/not available | +| | Redirecting reason | Unknown/not available | +| | Redirection counter | set to maximum value
(NOTE) | +| NOTE: For instance, in ISUP ITU-T Q.763 [4], the Redirection counter parameter cannot exceed 5. | | | + +#### 7.2.3.1.2.13 UID capability indicators (National option) + +UID capability indicators parameter is defined in ITU-T Recommendation Q.763 [4]. + +When a both-way media path is available, then it is possible to support user interactive dialogs prior to answer through the use of the P-Early-Media header field authorizing both-way media. + +If the received initial INVITE request contains a P-Early-Media header field with the "supported" value and either the SDP in the INVITE request allows a send/receive media path or the INVITE request does not contain an SDP body then the UID capability indicators parameter in the outgoing IAM message may be set as shown in table 7.2.3.1.2.13.1. + +**Table 7.2.3.1.2.13.1: Contents of the UID capability indicators parameter** + +| INVITE → | IAM→ | | +|--------------------------------------------------------------------------------------------------------------|--------------------------------------------|-------------------------------------------------------| +| P-Early-Media with "supported" and either SDP with "sendrecv" (explicit or implied) or no SDP present | UID capability indicators parameter | | +| | Through-connection indicator | 1 " through-connection modification possible " | +| | T9 timer indicator | 0 " no indication " | + +#### 7.2.3.1.2.14 Called IN number and original called IN number (optional) + +See Annex L for the normative interworking of the called IN number and original called IN number parameters. + +#### 7.2.3.1.2A Coding of the IAM when Number Portability is supported + +This clause describes optional coding procedures when Number Portability is supported. + +##### 7.2.3.1.2A.1 Coding of the IAM when a Number Portability Routing Number is available + +ITU-T Q.769.1 [92] describes three possible addressing methods for signalling of the Called Party E.164 address and Number Portability Routing Number (ITU-T Q.769.1 [92] uses the terms directory number and network routing number respectively). The choice of these methods is based on network operator and national requirements. + +The following clauses describe how the IAM is populated, based on these methods, when a Number Portability Routing Number is available in the Request URI in the form of a Tel URI "rn=" parameter. + +When the optional Number Portability Routing Number is available and supported, these procedures take precedence over procedures for coding of the Called Party Number described in clause 7.2.3.1.2.1. + +If the Number Portability Database Dip Indicator is present within the Request-URI the procedures described in clause 7.2.3.1.2A.2 apply. When a Number Portability Routing Number is not available, the Called Party Number parameter is populated as described in clause 7.2.3.1.2.1. + +## 7.2.3.1.2.A.1.1 Separate Directory Number Addressing Method + +**Table 7a.0a: Coding of the called party number and called directory number with Number Portability +Separate Directory Number Addressing Method** + +| INVITE→ | IAM→ | | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------| +| Request-URI | Called Party Number | Called Directory Number | +| Called Party E.164 address (format +CC NDC SN) (e.g. as User info in SIP URI with user=phone, or as tel URL) plus Number Portability Routing Number (format +CC NDC SN) (e.g. as Tel URI rn= parameter) plus Number Portability Database Dip Indicator as defined in IETF RFC 4694 [93] (e.g. as Tel URI npdi parameter) | Address Signal:
Analyse the information contained in received Number Portability Routing Number. If the Number Portability Routing number contains an E.164 address, then remove "+CC" and use the remaining digits to fill the Address signal. Otherwise, use the digits of the Number Portability Routing number to fill the Address signal.
(NOTE) | Address Signal:
Remove "+CC" from the Called Party E.164 address and use the remaining digits to fill the Address signals. | +| | Odd/even indicator: set as required | Odd/even indicator: set as required | +| | Nature of address indicator:
Set Nature of Address indicator to "Network routing number in national (significant) number 51isali". "National (significant) number" and "Network routing number in network specific number format" may alternately be chosen as described in ITU-T Q.769.1 [92] | Nature of address indicator:
Set Nature of Address indicator to "National (significant) number". | +| | Internal Network Number Indicator:
1 routing to internal network number not allowed | Internal Network Number Indicator:
1 routing to internal network number not allowed | +| | Numbering plan Indicator:
001 ISDN (Telephony) numbering plan (Rec. E.164) | Numbering plan Indicator:
001 ISDN (Telephony) numbering plan (Rec. E.164) | + +NOTE: If PSTN XML and ISUP Sending Terminated (ST) signal are supported as a network option, then the PSTN XML sendingCompleteIndication, if present, is mapped to the sending terminated digit (hexadecimal digit F) in the address signals field of the Called Party Number parameter. + +## 7.2.3.1.2.A.1.2 Concatenated Addressing Method + +**Table 7a.0b: Coding of the called party number with Number Portability Concatenated Addressing Method** + +| INVITE→ | IAM→ | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Request-URI | Called Party Number | +| Called Party E.164 address (format +CC NDC SN) (e.g. as User info in SIP URI with user=phone, or as tel URL) plus Number Portability Routing Number (format +CC NDC SN) (e.g. as Tel URI rn= parameter) plus Number Portability Database Dip Indicator as defined in IETF RFC 4694 [93] (e.g. as Tel URI npdi parameter) | Address Signal:
Analyse the information contained in received Number Portability Routing Number. If the Number Portability Routing number contains an E.164 address, then remove "+CC" and use the remaining digits to fill the Address signal. Otherwise, use the digits of the Number Portability Routing number to fill the Address signal.

Remove the "+CC" from the Called Party E.164 address and append the remaining digits to the Address signal.
(NOTE) | +| | Odd/even indicator: set as required | +| | Nature of address indicator:
set Nature of Address indicator to "Network routing number concatenated with called directory number" or "National (significant) number" as described in ITU-T Q.769.1 [92] | +| | Internal Network Number Indicator:
1 routing to internal network number not allowed | +| | Numbering plan Indicator:
001 ISDN (Telephony) numbering plan (Rec. E.164) | +| NOTE: If PSTN XML and ISUP Sending Terminated (ST) signal are supported as a network option, then the PSTN XML sendingCompleteIndication, if present, is mapped to the sending terminated digit (hexadecimal digit F) in the address signals field of the Called Party Number parameter. | | + +## 7.2.3.1.2.A.1.3 Separate Network Routing Number Addressing Method + +**Table 7a.0c: Coding of the network routing number and called party number with Number Portability Separate Network Routing Number Addressing Method** + +| INVITE→ | IAM→ | | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------| +| Request-URI | Network Routing Number | Called Party Number | +| Called Party E.164 address (format +CC NDC SN) (e.g. as User info in SIP URI with user=phone, or as tel URL) plus Number Portability Routing Number (format +CC NDC SN) (e.g. as Tel URI rn= parameter) plus Number Portability Database Dip Indicator as defined in IETF RFC 4694 [93] (e.g. as Tel URI npdi parameter) | Address Signal:
Analyse the information contained in received Number Portability Routing Number. If the Number Portability Routing number contains an E.164 address, then remove "+CC" and use the remaining digits to fill the Address signal. Otherwise, use the digits of the Number Portability Routing number to fill the Address signal. | Address Signal:
Remove "+CC" from the Called Party E.164 address and use the remaining digits to fill the Address signals.
(NOTE) | +| | Odd/even indicator: set as required | Odd/even indicator: set as required | +| | Nature of address indicator:
Set Nature of Address indicator to "Network routing number in national (significant) number format".
"Network routing number in network specific number format" may alternately be chosen as described in ITU-T Q.769.1 [92] | Nature of address indicator:
Set Nature of Address indicator to "National (significant) number". | +| | Numbering plan Indicator:
001 ISDN (Telephony) numbering plan (Rec. E.164) | Internal Network Number Indicator:
1 routing to internal network number not allowed | +| | | Numbering plan Indicator:
001 ISDN (Telephony) numbering plan (Rec. E.164) | +| NOTE: If PSTN XML and ISUP Sending Terminated (ST) signal are supported as a network option, then the PSTN XML sendingCompleteIndication, if present, is mapped to the sending terminated digit (hexadecimal digit F) in the address signals field of the Called Party Number parameter. | | | + +### 7.2.3.1.2A.2 Number Portability Forward Information + +Network Operator or National policy may allow forward transfer of number portability status information, as described in ITU-T Q.769.1 [92]. In this case, the following coding applies. + +**Table 7a.0d: Coding of the number portability forward information** + +| INVITE→
Request-URI | IAM→
Number Portability Forward Information | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Called Party E.164 address
(format +CC NDC SN)
(e.g. as User info in SIP URI with user=phone, or as tel URL) plus Number Portability Routing Number
(format +CC NDC SN) (e.g. as Tel URI rn= parameter) plus Number Portability Database Dip Indicator as defined in IETF RFC 4694 [93] (e.g. as Tel URI npdi parameter) |

If the Number Portability Database Dip Indicator is present, and there is no Number Portability Routing Number, set to "number portability query done for called number, non-ported called subscriber".

If the Number Portability Database Dip Indicator is present, and a Number Portability Routing Number is present, set to "number portability query done for called number, ported called subscriber".

If there is no Number Portability Database Dip Indicator, set to "number portability query not done for called number"

| + +### 7.2.3.1.2B Coding of the IAM for Carrier Routeing + +This clause describes optional coding procedures for carrier-based routeing. The interworking of the CIC parameter is defined. + +#### 7.2.3.1.2B.1 Coding of the IAM when a Carrier Identification Code (CIC) is present + +The procedures followed in clause 7.2.3.1.2.1 apply with the following addition. + +Based on network configuration, if the tel-URI parameter in a tel-URI or the userinfo part of a SIP URI with user=phone in the Request-URI of an initial INVITE request, contains a "cic=" parameter, as defined in IETF RFC 4694 [93], the I-MGCF may extract the carrier identification code from the "cic=" field for routeing the call. If the outgoing IAM message contains the Transit Network Selection (TNS) parameter, as defined in ITU-T Q.763 [4], based on network configuration the TNS may be populated using the carrier identification code from the "cic=" field. The format of the "cic" parameter (e.g. global-cic and local-cic) shall be compliant to IETF RFC 4694 [93]. + +#### 7.2.3.1.2B.2 Void + +### 7.2.3.1.3 Sending of COT + +![Sequence diagram showing the sending of COT. A box on the left contains 'SDP indicating preconditions met and/or active media'. An arrow points from this box to a vertical line labeled 'I-MGCF'. From the I-MGCF line, an arrow points to a box labeled 'COT'.](fc0cdcafc5389b99674ba116c9787ffd_img.jpg) + +``` + +sequenceDiagram + participant Client + participant I-MGCF + Note left of Client: SDP indicating preconditions met and/or active media + Client->>I-MGCF: + I-MGCF->>COT: + +``` + +Sequence diagram showing the sending of COT. A box on the left contains 'SDP indicating preconditions met and/or active media'. An arrow points from this box to a vertical line labeled 'I-MGCF'. From the I-MGCF line, an arrow points to a box labeled 'COT'. + +**Figure 5: Sending of COT** + +If the IAM has already been sent, the Continuity message shall be sent indicating "continuity check successful", when all of the following conditions have been met: + +- The requested remote preconditions (if any) in the IMS network have been met. +- The media stream previously set to inactive mode is set to active (as specified in IETF RFC 4566 [56]). + +- Local preconditions have been fulfilled. +- A possible outstanding continuity check procedure is successfully performed on the outgoing circuit. + +### 7.2.3.1.3A Sending of SAM + +#### 7.2.3.1.3A.1 General + +The procedures in the present clause are only applicable if the I-MGCF supports the network option of overlap signalling, using either the in-dialog method or the multiple INVITEs method. Within one IMS only a single of those methods shall be used. + +After the ISUP IAM message has been sent the I-MGCF can receive additional digits. The additional digits may either, as a network option, be received in: + +- in-dialog SIP INFO requests ("legacy" mode of usage of the INFO method as defined in IETF RFC 6086 [133]), in-dialog method as specified in clause 7.2.3.1.3A.2 or +- in additional SIP INVITE requests, multiple INVITEs method as specified in 7.2.3.1.3A.3. + +![Diagram illustrating the sending of SAM. A box labeled 'SIP message carrying additional digits' has an arrow pointing to a vertical line representing the I-MGCF. From the I-MGCF, an arrow points to a box labeled 'SAM', which then has an arrow pointing to the right.](9e4f582a5d5f6742d1372956db0f8f0b_img.jpg) + +``` + +graph LR + A[SIP message carrying additional digits] --> I-MGCF + I-MGCF --> SAM + SAM --> B[ ] + style B fill:none,stroke:none + +``` + +Diagram illustrating the sending of SAM. A box labeled 'SIP message carrying additional digits' has an arrow pointing to a vertical line representing the I-MGCF. From the I-MGCF, an arrow points to a box labeled 'SAM', which then has an arrow pointing to the right. + +**Figure 5a: Sending of SAM** + +#### 7.2.3.1.3A.2 Additional digits received in in-dialog SIP INFO requests + +If interworking of overlap signalling using the in-dialog method is supported by the I-MGCF, the ISUP IAM message has already been sent, but no ISUP ACM or REL message has been received, and a SIP INFO request carrying additional digits is received, then the I-MGCF shall generate a SAM and pass it to outgoing BICC/ISUP procedures. The SAM shall contain in its Subsequent Number parameter only the additional digits received in this SIP INFO request. + +#### 7.2.3.1.3A.3 Additional digits received in SIP INVITE requests + +If interworking of overlap signalling using the multiple INVITEs method is supported by the I-MGCF, the ISUP IAM message has already been sent, but no ISUP ACM or REL message has been received, and the I-MGCF receives an INVITE with the same Call-ID and From tag as a previous INVITE which was associated with a BICC/ISUP call/bearer control instance currently existing on the BICC/ISUP side, then: + +- If the number of digits in the Request-URI is greater than the number of digits already received for the communication, the I-MGCF shall generate a SAM and pass it to outgoing BICC/ISUP procedures. The SAM shall contain in its Subsequent Number parameter only the additional digits received in this Request-URI compared with the digits already received for the communication. The I-MGCF shall reply to any earlier INVITE with a 484 Address Incomplete response if this has not already been done. +- If the number of digits in the Request-URI is equal or less than the number of digits already received for the communication, then the I-MGCF shall immediately send a 484 Address Incomplete response for this INVITE. In this case, no SAM shall be sent to BICC/ISUP procedures. + +![Sequence diagram for Figure 5b showing multiple overlapping INVITE messages. A box at the top represents the caller. Below it are three stacked black rectangles representing the callee's processing. Arrows point from the caller to each of the three rectangles, indicating multiple INVITE requests. Arrows also point from each rectangle back towards the caller, representing responses or processing steps.](9e8ebf03cae78f4f81b697548c2d7250_img.jpg) + +Sequence diagram for Figure 5b showing multiple overlapping INVITE messages. A box at the top represents the caller. Below it are three stacked black rectangles representing the callee's processing. Arrows point from the caller to each of the three rectangles, indicating multiple INVITE requests. Arrows also point from each rectangle back towards the caller, representing responses or processing steps. + +**Figure 5b: Receipt of subsequent INVITE for multiple INVITEs method overlap signalling** + +On sending of a 484 Address Incomplete message for an INVITE transaction, the I-MGCF considers any offer/answer exchange initiated by the INVITE to be terminated. The new INVITE initiates a new offer/answer exchange. However, if resources have already been reserved and they can be reused within the new offer/answer exchange, the precondition signalling shall reflect the current status of the affected preconditions. + +**7.2.3.1.4 Sending of 180 ringing** + +**7.2.3.1.4.0 General** + +The I-MGCF shall send the SIP 180 Ringing response when receiving any of the following messages: + +- ACM with Called party's status indicator set to subscriber free. + +![Sequence diagram for Figure 6 showing the receipt of ACM. A vertical line represents the I-MGCF. An arrow labeled 'ACM (Subscriber Free)' points from the right towards the I-MGCF line. From the I-MGCF line, two arrows point to the left: a solid arrow labeled '180 Ringing' and a dashed arrow labeled 'P-Early-Media (1)'. Below these, another dashed arrow points left, labeled 'Ring tone'.](dc37a040cf9e2add7488c7c37cbf3687_img.jpg) + +Sequence diagram for Figure 6 showing the receipt of ACM. A vertical line represents the I-MGCF. An arrow labeled 'ACM (Subscriber Free)' points from the right towards the I-MGCF line. From the I-MGCF line, two arrows point to the left: a solid arrow labeled '180 Ringing' and a dashed arrow labeled 'P-Early-Media (1)'. Below these, another dashed arrow points left, labeled 'Ring tone'. + +**Figure 6: The receipt of ACM** + +**NOTE:** Whether the P-Early-Media header field is included depends on whether the received INVITE contains a P-Early-Media header field with the "supported" parameter as described in IETF RFC 5009 [89] or based on local policy. + +- CPG with Event indicator set to alerting + +![Diagram showing the receipt of CPG (Alerting) by the I-MGCF. A vertical line represents the I-MGCF. To the left, '180 Ringing' and 'P-Early-Media (1)' are shown with a solid arrow pointing left. To the right, 'CPG (Alerting)' is shown with a solid arrow pointing left towards the I-MGCF. Below the I-MGCF line, a dashed line extends to the left, labeled 'Ring tone'.](2cf3896394a2342a2b46c504ab9a8830_img.jpg) + +I-MGCF + +Diagram showing the receipt of CPG (Alerting) by the I-MGCF. A vertical line represents the I-MGCF. To the left, '180 Ringing' and 'P-Early-Media (1)' are shown with a solid arrow pointing left. To the right, 'CPG (Alerting)' is shown with a solid arrow pointing left towards the I-MGCF. Below the I-MGCF line, a dashed line extends to the left, labeled 'Ring tone'. + +NOTE: Whether the P-Early-Media header field is included depends on whether the received INVITE contains a P-Early-Media header field with the "supported" parameter as described in IETF RFC 5009 [89] or based on local policy. + +**Figure 7: Receipt of CPG (Alerting)** + +For a speech call that is not identified as an "ICS call" as specified in clause 7.2.3.1.2.12, if the INVITE request includes the P-Early-Media header field, the I-MGCF shall include in the SIP 180 Ringing response a P-Early-Media header field authorizing backward early media, except when + +- the I-MGCF has already sent a reliable provisional response (see IETF RFC 3262 [54]) including a P-Early-Media header, as defined in IETF RFC 5009 [89], and +- the most recently sent P-Early-Media header field authorized backward early media. + +NOTE: If the I-MGCF signals the P-Early-Media header field authorizing backward early media, then the IMS can expect tones or announcements to the calling party to flow from the CS network via an MGW controlled by the I-MGCF. In particular, once the I-MGCF sends the 180 Ringing response, ringback is expected in media from the CS network. + +If the INVITE request doesn't include the P-Early-Media header field with the "supported" parameter and if the speech call is not identified as the "ICS call" as specified in clause 7.2.3.1.2.12, then as a network option the I-MGCF may include in the SIP 180 Ringing response a P-Early-Media header field authorizing backward early media. + +As a network option, an I-MGCF may generate a Call-Info header field, or an Alert-Info header field according to rules and procedures of IETF RFC 3261 [19] to provide media instead of the in-band media received from the PSTN. + +For the speech call identified as the "ICS call" as specified in clause 7.2.3.1.2.12, if the I-MGCF has received the P-Early-Media header field in the initial INVITE request, the I-MGCF shall include in the SIP 180 Ringing response the P-Early-Media header field indicating the backward early media is not authorised, except when: + +- the I-MGCF has already sent a reliable provisional response (see IETF RFC 3262 [54]) including a P-Early-Media header, as defined in IETF RFC 5009 [89]; and +- the most recently sent P-Early-Media header field did not authorize the backward early media. + +If the P-Early-Media header field with the "supported" parameter was not included in the initial INVITE request, then as a network option the I-MGCF may include in the SIP 180 Ringing response the P-Early-Media header field indicating the backward early media is not authorised for the "ICS call". + +#### 7.2.3.1.4.0a PSTN XML body + +The procedures in the present clause apply only if the I-MGCF supports the PSTN XML body as a network option. The I-MGCF shall map the Access Transport parameter received in the CPG or ACM into PSTN XML elements as shown in table 7a.0f and include this PSTN XML body in the 180 Ringing. + +**Table 7a.0f: Mapping of ISUP ATP Parameter into PSTN XML elements** + +| 18x | CPG or ACM | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------|--------------------------| +| PSTN XML | ISUP Parameter | Content | +| ProgressIndicator | Access Transport Parameter | Progress indicator | +| HighLayerCompatibility (NOTE 2) | | High layer compatibility | +| LowLayerCompatibility (NOTE 2) | | Low layer compatibility | +| BearerCapability (NOTE 1, NOTE 2) | | Bearer Capability | +| BearerCapability (NOTE 1, NOTE 2) | Transmission medium used parameter (NOTE 1) | | +| NOTE 1: see clause 7.2.3.1.4.1 Transmission Medium Used parameter (TMU) | | | +| NOTE 2: The I-MGCF shall only provide this IE if it interworks media encoded in any of the formats in table 2a (G.711, Clearmode, or t38) without transcoding. If both TMU and a BC in the ATP have been received, the BC in the ATP shall be mapped. | | | + +The I-MGCF shall map a possibly available "ProgressIndicator" element in the ATP parameter within the ACM or CPG into a Progress Indicator in the PSTN XML body of the 180 Ringing. In addition, the I-MGCF shall map the Backward call indicators parameter and the Optional backward call indicators parameter (if present) within the ACM or CPG into other ProgressIndicator(s) in the PSTN XML body of the 180 Ringing as shown in table 7a.0g. + +NOTE: The order of ProgressIndicators within the same PSTN XML body is irrelevant. + +**Table 7a.0g: Mapping of ISUP BCI and optional BCI parameters into PSTN XML ProgressIndicator** + +| ← 180 Ringing | ←ACM or CPG | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| PSTN XML body with ProgressIndicator with "Progress Description" value No (Value of PI) | Backward call indicators parameter
Optional backward call indicators parameter | +| No. 1
("Call is not end-to-end ISDN: further call progress information may be available in-band") | Backward call indicators parameter
ISDN User Part indicator
0 "ISDN User Part not used all the way" | +| No. 2
("Destination address is non-ISDN") | Backward call indicators parameter
ISDN User Part indicator
1 "ISDN User Part used all the way"
ISDN access indicator
0 "Terminating access non-ISDN" | +| No. 7
("Terminating access ISDN") | Backward call indicators parameter
ISDN User Part indicator
1 "ISDN User Part used all the way"
ISDN access indicator
1 "Terminating access ISDN" | +| No. 8
("In-band information or an appropriate pattern is now available") | Optional backward call indicators parameter
In-band information indicator
"in-band information or an appropriate pattern is now available" | +| NOTE: The ProgressIndicator "Coding Standard" parameter shall be set to "00 (ITU-T standardized coding)". The default value for the ProgressIndicator "Location" parameter is "0011 (Transit Network)". | | + +#### 7.2.3.1.4.0b Fallback by I-MGCF + +If the I-MGCF supports the PSTN XML body as a network option and the I-MGCF received two PSTN XML Bearer Capability elements within the INVITE Request, but the succeeding trunk does not support TMR "64 kBit/s preferred" (as described in clause 7.2.3.1.2.5a), and if no corresponding elements were received in the Access Transport Parameter (see table 7a.0f), then the I-MGCF shall create a PSTN XML body containing the following elements, and include it in the 18x Response : + +- a BearerCapability element, which shall be copied from the first BearerCapability element received in the PSTN XML in the INVITE; +- if two HighLayerCompatibility elements were present in the PSTN XML body in the INVITE, then a HighLayerCompatibility element, which shall be copied from the first HighLayerCompatibility element received in the PSTN XML in the INVITE; and + +- a ProgressIndicator element with "Progress Description" value 5 ("Interworking has occurred and has resulted in a telecommunication service change"), "Coding Standard" value "00 (ITU-T standardized coding)", and default value "0011 (Transit Network)" for the "Location" parameter. + +#### 7.2.3.1.4.1 Fallback in a succeeding network: Transmission Medium Used parameter (TMU) received + +The procedures in the present clause apply only if the I-MGCF supports the PSTN XML body as a network option and receives a Transmission Medium Used parameter (TMU). + +NOTE: The I-MGCF will only receive a TMU parameter if it has applied the Fallback related procedures in clause 7.2.3.1.2.5a, including both a TMR and TMR Prime in the IAM, and fallback to the bearer capability identified in TMR Prime and USI occurred in a succeeding network. + +If the I-MGCF receives a Transmission Medium Used parameter (TMU) , the I-MGCF shall: + +- If an BC is not available in the ATP in the Address Complete Message (ACM) or Call Progress Message (CPG), map the TMU value (Speech or 3.1 kHz audio) to the PSTN XML BearerCapability; +- If an BC is available in the ATP in the Address Complete Message (ACM) or Call Progress Message (CPG), include the received BC value in the PSTN XML BearerCapability; +- configure the IM-MGW to use the second format in the m-line in the SDP that has been received in the INVITE as codec at the IMS termination; and +- send SDP selecting the second format in the m-line of the SDP that has been received in the INVITE as soon as allowed according to SIP rules. + +**Table 7.2.3.1.4.1.1: Sending of BC fallback indication** + +| ← 180 Ringing or 183 Session Progress | ←ACM/CPG | | +|--------------------------------------------------------------------------------|------------|---------------------------------------------------------------| +| PSTN XML BearerCapability = "Speech" | TMU
ATP | "Speech"
No BC | +| PSTN XML BearerCapability = "3.1 kHz audio" | TMU
ATP | "3.1 kHz audio"
No BC | +| PSTN XML BearerCapability received in the ATP
("speech" or "3.1 kHz audio") | TMU
ATP | "Speech or 3.1 kHz audio"
BC ("speech" or "3.1 kHz audio") | + +#### 7.2.3.1.4A Sending of 183 Session Progress for early media scenarios + +If SIP preconditions are used, the first 183 Session Progress will be sent after the reception of the INVITE request, before any ISUP message has been received from the CS network. The I-MGCF shall not include the P-Early-Media header field in any SIP message before it receives an ISUP ACM. + +For a speech call, which is not identified as an "ICS call" as specified in clause 7.2.3.1.2.12, upon receipt of one of the following messages and if the I-MGCF has received the P-Early-Media header field in the INVITE request, and has not already sent a provisional response including a P-Early-Media header field with parameters indicating authorization of early media with the same directionality as determined by table 7.2.3.1.4A.1 or table 7.2.3.1.4A.2, then the I-MGCF shall send the 183 Session Progress response with a P-Early-Media header field authorizing early media as indicated: + +- ACM with the value of the called party's status indicator "no indication" and one of the options described in table 7.2.3.1.4A.1 If the I-MGCF supports the PSTN XML body as a network option, the I-MGCF shall map parameters within the ACM into the PSTN XML body within the 183 as indicated in table 7.2.3.1.4A.1. Based on local configuration, the I-MGCF may also send a 183 Session Progress response with a P-Early-Media header field authorizing early media if it receives an ACM with other parameters than described in table 7.2.3.1.4A.1. + +![Diagram showing the receipt of an ACM 'No indication' message. A vertical line represents the I-MGCF. To the left, '183 Progress' and 'P-Early-Media' are shown with a solid arrow pointing left. To the right, 'ACM (No indication)' is shown with a solid arrow pointing left towards the I-MGCF. Below the I-MGCF, a dashed arrow points left, labeled 'appropriate announcement'.](9b1ec0090070bdf52ea28763b8d52477_img.jpg) + +I-MGCF + +Diagram showing the receipt of an ACM 'No indication' message. A vertical line represents the I-MGCF. To the left, '183 Progress' and 'P-Early-Media' are shown with a solid arrow pointing left. To the right, 'ACM (No indication)' is shown with a solid arrow pointing left towards the I-MGCF. Below the I-MGCF, a dashed arrow points left, labeled 'appropriate announcement'. + +**Figure 7c: Receipt of ACM "No indication"** + +**Table 7.2.3.1.4A.1: ACM Parameters that trigger the 183 Session Progress response** + +| ← 183 Session Progress | ← ACM | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| P-Early-Media header field authorizing backward early media, if not already sent (NOTE 2)

PSTN XML with ProgressIndicator with "Progress Description" value No. 8 ("In-band information or appropriate pattern is now available") (NOTE 1) | Optional backward call indicators parameter

In-band information indicator
1 "In-band info or an appropriate pattern is now available" | +| PSTN XML with ProgressIndicator with "Progress Description" value No. 1 ("Call is not end-to-end ISDN: further call progress information may be available in-band") (NOTE 1) | Backward call indicators parameter

ISDN User Part indicator
0 "ISDN User Part not used all the way" | +| PSTN XML with ProgressIndicator with "Progress Description" value No. 2 ("Destination address is non-ISDN") (NOTE 1) | Backward call indicators parameter

ISDN User Part indicator
1 "ISDN User Part used all the way"

ISDN access indicator
0 "Terminating access non-ISDN" | +| PSTN XML with ProgressIndicator with "Progress Description" value No. 7 ("Terminating access ISDN") (NOTE 1) | Backward call indicators parameter
ISDN User Part indicator
1 "ISDN User Part used all the way"

ISDN access indicator
1 "Terminating access ISDN" | +| P-Early-Media header field authorizing both-way early media, if not already sent (NOTE 2) | UID action indicators parameter

Through-connection instruction indicator
1 "through-connect in both directions" | +| NOTE 1: The ProgressIndicator "Coding Standard" parameter shall be set to "00 (ITU-T standardized coding)". The default value for the ProgressIndicator "Location" parameter is "0011 (Transit Network)". | | +| NOTE 2: Setting of the P-Early-Media header field based on the UID action indicators parameter value of "through-connect in both directions" takes precedence over setting based on the Optional backward call indicators parameter value of "In-band info or an appropriate pattern is now available". | | + +NOTE 1: As a network option the I-MGCF can also map ACM into 183 in other cases than those described in table 7.2.3.1.4A.1. + +- CPG message, when: + +1. Event indicator is set to "in-band information or an appropriate pattern is now available", or +2. Event indicator is set to "Progress" and one of the options described in table 7.2.3.1.4A.2. + +![Diagram showing the receipt of CPG (in-band information available) by the I-MGCF. A solid arrow labeled '183 Progress P-Early-Media' points left from the I-MGCF. A solid arrow labeled 'CPG (in-band information available)' points right towards the I-MGCF. A dashed arrow labeled 'appropriate announcement' points left from the I-MGCF.](b34c69e1ec326b01c3a485b27b1df5f6_img.jpg) + +I-MGCF + +Diagram showing the receipt of CPG (in-band information available) by the I-MGCF. A solid arrow labeled '183 Progress P-Early-Media' points left from the I-MGCF. A solid arrow labeled 'CPG (in-band information available)' points right towards the I-MGCF. A dashed arrow labeled 'appropriate announcement' points left from the I-MGCF. + +**Figure 7d: Receipt of CPG (in-band information available)** + +**Table 7.2.3.1.4A.2: CPG Parameters that trigger the 183 Session Progress response** + +| ←183 Session Progress | ←CPG | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| P-Early-Media header field authorizing backward early media, if not already sent (NOTE 4)

PSTN XML with ProgressIndicator with "Progress Description" value No. 8 ("In-band information or appropriate pattern is now available") (NOTE 3) | Event indicator
000 0010 (progress)

Optional backward call indicators parameter
In-band information indicator
1 "In-band info or an appropriate pattern is now available" | +| PSTN XML with ProgressIndicator with "Progress Description" value No. 1 (Call is not end-to-end ISDN: further progress information may be available in-band") (NOTE 3) | Event indicator
000 0010 (progress)

Backward call indicators parameter
ISDN User Part indicator
0 "ISDN User Part not used all the way" | +| PSTN XML with ProgressIndicator with "Progress Description" value No. 2 ("Destination address is non-ISDN") (NOTE 3) | Backward call indicators parameter
ISDN User Part indicator
1 "ISDN User Part used all the way"

ISDN access indicator
0 "Terminating access non-ISDN" | +| PSTN XML with ProgressIndicator with "Progress Description" value No. 7 ("Terminating access ISDN") (NOTE 3) | Backward call indicators parameter
ISDN User Part indicator
1 "ISDN User Part used all the way"

ISDN access indicator
1 "Terminating access ISDN" | +| P-Early-Media header field authorizing both-way early media, if not already sent (NOTE 4) | UID action indicators parameter
Through-connection instruction indicator
1 "through-connect in both directions" | + +NOTE 1: The mapping of the contents in the CPG message is only relevant if the information received in the message is different compared to earlier received information, e.g., in the ACM message or a CPG message received prior to this message. + +NOTE 2: 183 Session Progress message including a P-Early-Media header authorizing early media may only be sent for a speech call. + +NOTE 3: The ProgressIndicator "Coding Standard" parameter shall be set to "00 (ITU-T standardized coding)". The default value for the ProgressIndicator "Location" parameter is "0011 (Transit Network)". + +NOTE 4: Setting of the P-Early-Media header field based on the UID action indicators parameter value of "through-connect in both directions" takes precedence over setting based on the Optional backward call indicators parameter value of "In-band info or an appropriate pattern is now available". + +NOTE 2: As a network option the I-MGCF can also map CPG into 183 in other cases than those described in table 7.2.3.1.4A.1. + +If the INVITE request doesn't include the P-Early-Media header field with the "supported" parameter, then as a network option the I-MGCF may include in the SIP 180 Ringing response a P-Early-Media header field authorizing early media. + +If the I-MGCF supports the PSTN XML body as a network option, the I-MGCF shall map the Access Transport Parameter received in the CPG or ACM into PSTN XML elements as shown in table 7a.0f and include this XML body + +in the 183 Session Progress. The I-MGCF shall include both a ProgressIndicator mapped from possibly received Progress indicator element in the Access Transport Parameter and ProgressIndicators derived according to table 7.2.3.1.4A.1 or table 7.2.3.1.4A.2 in the PSTN XML body. + +NOTE 3: The order of ProgressIndicators within the same PSTN XML body is irrelevant. + +If the I-MGCF has applied UDI-TA fallback related procedures in clause 7.2.3.1.2.5a, the I-MGCF shall also apply the procedures in clauses 7.2.3.1.4.0b and 7.2.3.1.4.1, including the PSTN XML body in the 183 Session Progress. + +As a network option, an I-MGCF may generate a Call-Info header field, or an Alert-Info header field according to rules and procedures of IETF RFC 3261 [19] to provide media instead of the in-band media received from the PSTN. + +If the ACM or CPG contains an ISUP Cause, the MGCF may add a Reason header field containing the received Cause Value to the SIP 183 Session Progress provisional response as a network option. The mapping of the Cause Indicators parameter to the Reason header as shown in table 9a shall be applied. IETF RFC 6432 [115] describes the use of the Reason header field in responses. The Reason header field itself is described in IETF RFC 3326 [116]. + +#### 7.2.3.1.4B Sending of 181Call is being forwarded + +The I-MGCF shall send the SIP 181 Call is being forwarded when receiving any of the following messages: + +- ACM with call diversion information not indicating that presentation is not allowed and optional backward call indicators indicate that in-band information is available. + +![Diagram of Figure 7c: The receipt of ACM (call diversion information). The diagram shows the I-MGCF at the top. On the left, '181 Call is being forwarded' and 'P-Early-Media (1)' are shown. A solid arrow points from the I-MGCF to the left for 'ACM( call diversion information)'. A dashed arrow points from the I-MGCF to the left for 'Audio'.](cb698d64c91df5a86b05bbddc202c144_img.jpg) + +Diagram of Figure 7c: The receipt of ACM (call diversion information). The diagram shows the I-MGCF at the top. On the left, '181 Call is being forwarded' and 'P-Early-Media (1)' are shown. A solid arrow points from the I-MGCF to the left for 'ACM( call diversion information)'. A dashed arrow points from the I-MGCF to the left for 'Audio'. + +NOTE 1: Whether the P-Early-Media header field is included depends on whether the received INVITE contains a P-Early-Media header field with the "supported" parameter as described in IETF RFC 5009 [89] or based on local policy. + +**Figure 7c: The receipt of ACM (call diversion information)** + +- CPG with call diversion information not indicating that presentation is not allowed and optional backward call indicators indicate that in-band information is available. + +![Diagram of Figure 7d: Receipt of CPG (Call diversion information). The diagram shows the I-MGCF at the top. On the left, '181 Call is being forwarded' and 'P-Early-Media (1)' are shown. A solid arrow points from the I-MGCF to the left for 'CPG(Call diversion information)'. A dashed arrow points from the I-MGCF to the left for 'Audio'.](5043b1d06ff3f78c43f3432a4bae436d_img.jpg) + +Diagram of Figure 7d: Receipt of CPG (Call diversion information). The diagram shows the I-MGCF at the top. On the left, '181 Call is being forwarded' and 'P-Early-Media (1)' are shown. A solid arrow points from the I-MGCF to the left for 'CPG(Call diversion information)'. A dashed arrow points from the I-MGCF to the left for 'Audio'. + +NOTE 1: Whether the P-Early-Media header field is included if the received INVITE contains a P-Early-Media header field with the "supported" parameter as described in IETF RFC 5009 [89] or based on local policy. + +**Figure 7d: Receipt of CPG (Call diversion information)** + +For a speech call, and if the INVITE request includes the P-Early-Media header, the I-MGCF shall include in the SIP 181 Call is being forwarded response a P-Early-Media header authorizing early media, except when + +- the I-MGCF has already sent a reliable provisional response including a P-Early-Media header field, as defined in IETF RFC 5009 [89], or a 180 Ringing response; and +- the most recently sent P-Early-Media header field authorized early media. + +NOTE: If the I-MGCF signals the P-Early-Media header field authorizing early media, then the IMS can expect tones or announcements to the calling party to flow from the CS network via an MGW controlled by the I-MGCF. + +If the INVITE request doesn't include the P-Early-Media header field with the "supported" parameter, then as a network option the I-MGCF may include in the SIP 180 Ringing response a P-Early-Media header field authorizing early media. + +#### 7.2.3.1.4C Sending of 183 Session Progress for overlap signalling using the in-dialog method + +If the I-MGCF supports the network option of overlap signalling using the in-dialog method, and the SIP INVITE request contained an indication that the 100rel extension is supported or required, the I-MGCF shall send a reliable 183 (Session Progress) response immediately after the reception of an INVITE request. + +NOTE: If the INVITE request does not contain an indication that the 100rel extension is supported or required, it is assumed that overlap is not used, and that no further digits will be received. + +#### 7.2.3.1.4D Sending of 183 Session Progress to carry ISUP Cause + +If the I-MGCF receives an ACM or CPG message containing an ISUP Cause, and if the I-MGCF does not send any SIP provisional response due to interworking procedures described in clauses 7.2.3.1.4A, for the ACM or CPG message, the I-MGCF may send a SIP 183 Session Progress with a Reason header field containing the received Cause Value as a network option. The mapping of the Cause Indicators parameter to the Reason header as shown in table 9a shall be applied. IETF RFC 6432 [115] describes the use of the Reason header field in responses. The Reason header field itself is described in IETF RFC 3326 [116]. + +![Diagram illustrating the receipt of ACM or CPG with ISUP Cause. A vertical line represents the I-MGCF. To the right of the line, 'ACM or CPG (Cause=xxx)' is shown. An arrow points from this text, across the line, to the left. To the left of the line, '183 Session Progress (Reason(Cause=xxx))' is shown, indicating the response sent by the I-MGCF.](7913c315e0db8233cb1ac2455e4a0a81_img.jpg) + +Diagram illustrating the receipt of ACM or CPG with ISUP Cause. A vertical line represents the I-MGCF. To the right of the line, 'ACM or CPG (Cause=xxx)' is shown. An arrow points from this text, across the line, to the left. To the left of the line, '183 Session Progress (Reason(Cause=xxx))' is shown, indicating the response sent by the I-MGCF. + +**Figure 7.2.3.1.4D.1: The receipt of ACM or CPG with ISUP Cause** + +#### 7.2.3.1.4E Sending of 183 Session Progress for ICS call + +For a speech call identified as an "ICS call" as specified in clause 7.2.3.1.12 if the I-MGCF has received: + +- ACM message with the value of the called party's status indicator "*no indication*" and the optional backward call indicators parameter field with the in-band information indicator set to "*in-band information or an appropriate pattern is now available*"; or +- CPG message with the event indicator of the event information parameter field set to: + - 1 "*in-band information or an appropriate pattern is now available*"; or + - 2 "*progress*" and the optional backward call indicators parameter field with the in-band information indicator set to "*in-band information or an appropriate pattern is now available*"; and +- if the received ACM or CPG message does not contain the cause indicators parameter field then: + - a) if the I-MGCF has received a P-Early-Media header field in the initial INVITE request; and + - b) the I-MGCF has not already sent a provisional response including the P-Early-Media header field with parameters indicating that a backward early media is not authorised; + +the I-MGCF shall send the 183 Session Progress response with the P-Early-Media header field indicating the backward early media is not authorised. If the I-MGCF supports a PSTN XML body as a network option, the I-MGCF shall map parameters within the ACM or CPG message into the PSTN XML body within the 183 Session Progress response as indicated in clause 7.2.3.1.4A; or + +- otherwise if the received ACM or CPG message contains the cause indicators parameter field the I-MGCF shall send a final response to the initial INVITE request according to table 9 in clause 7.2.3.1.8 with a Reason header field containing the received (Q.850) cause value. The mapping of the cause indicators parameter field to the Reason header field as shown in table 9a shall be applied. IETF RFC 6432 [115] describes the use of the Reason header field in responses. The Reason header field itself is described in IETF RFC3326 [116]. + +#### 7.2.3.1.5 Sending of the 200 OK (INVITE) + +The following cases are possible trigger conditions for sending the 200 OK (INVITE): + +- The reception of the ANM. + +![Sequence diagram showing the receipt of ANM by I-MGCF and the subsequent sending of 200 OK (INVITE).](31ef15d175af5babdbf4d2fbac884c1b_img.jpg) + +A sequence diagram illustrating the interaction for Figure 8. A vertical line represents the I-MGCF. An arrow labeled 'ANM' points from the right towards the I-MGCF line. From the I-MGCF line, an arrow labeled '200 OK (INVITE)' points to the left. + +Sequence diagram showing the receipt of ANM by I-MGCF and the subsequent sending of 200 OK (INVITE). + +**Figure 8: Receipt of ANM** + +- The reception of the CON message. + +![Sequence diagram showing the receipt of CON by I-MGCF and the subsequent sending of 200 OK (INVITE).](a4b868a176f7e0448ee72483727e9f6f_img.jpg) + +A sequence diagram illustrating the interaction for Figure 9. A vertical line represents the I-MGCF. An arrow labeled 'CON' points from the right towards the I-MGCF line. From the I-MGCF line, an arrow labeled '200 OK (INVITE)' points to the left. + +Sequence diagram showing the receipt of CON by I-MGCF and the subsequent sending of 200 OK (INVITE). + +**Figure 9: Receipt of CON** + +If the I-MGCF supports the PSTN XML body as a network option, the I-MGCF shall map the Access Transport Parameter received in the ANM or CON into PSTN XML elements as shown in table 7.2.3.1.5.1 and include this PSTN XML body in the 200 OK (INVITE). + +On receipt of an ANM/CON message containing the ATP including the Bearer Capability set to "unrestricted digital information with tones/announcement" without TMU parameter the 200 OK message shall contain the PSTN XML Bearer Capability "unrestricted digital information with tones/announcement". + +If the I-MGCF supports the PSTN XML body as a network option, the I-MGCF shall map an available BCI element in the ANM or CON into a ProgressIndicator in the PSTN XML body as shown in table 7.2.3.1.5.2; the I-MGCF shall include both a ProgressIndicator mapped from possibly received Progress indicator element in the Access Transport Parameter and ProgressIndicators derived according to table 7.2.3.1.5.2 in the PSTN XML. + +NOTE 1: The order of ProgressIndicators within the same PSTN XML body is irrelevant. + +**Table 7.2.3.1.5.1: Mapping of ISUP ATP Parameter into PSTN XML elements** + +| 200 OK | ANM or CON | | +|-----------------------------------|---------------------------------------------|--------------------------| +| PSTN XML | ISUP Parameter | Content | +| ProgressIndicator | Access Transport Parameter | Progress indicator | +| HighLayerCompatibility (NOTE 2) | | High layer compatibility | +| LowLayerCompatibility (NOTE 2) | | Low layer compatibility | +| BearerCapability (NOTE 1, NOTE 2) | | Bearer Capability | +| BearerCapability (NOTE 1, NOTE 2) | Transmission medium used parameter (NOTE 1) | | + +NOTE 1: see clause 7.2.3.1.4.1 Transmission Medium Used parameter (TMU) +NOTE 2: The I-MGCF shall only provide this IE if it interworks media encoded in any of the formats in table 2a (G.711, Clearmode, or t38) without transcoding. If both TMU and a BC in the ATP have been received, the BC in the ATP shall be mapped. + +**Table 7.2.3.1.5.2: Mapping of ISUP BCI and optional BCI parameters into PSTN XML +ProgressIndicator** + +| ← 200 OK | ←ANM or CON | +|------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| PSTN XML body with ProgressIndicator with "Progress Description" value No (Value of PI) (NOTE) | Content
Backward call indicators parameter
Optional backward call indicators parameter | +| No. 1
("Call is not end-to-end ISDN: further call progress information may be available in-band") | Backward call indicators parameter
ISDN User Part indicator
0 "ISDN User Part not used all the way" | +| No. 2
("Destination address is non-ISDN") | Backward call indicators parameter
ISDN User Part indicator
1 "ISDN User Part used all the way"
ISDN access indicator
0 "Terminating access non-ISDN" | +| No. 7
("Terminating access ISDN") | Backward call indicators parameter
ISDN User Part indicator
1 "ISDN User Part used all the way"
ISDN access indicator
1 "Terminating access ISDN" | +| No. 8
("In-band information or an appropriate pattern is now available") | Optional backward call indicators parameter
In-band information indicator
1 "in-band information or an appropriate pattern is now available" | + +NOTE: The ProgressIndicator "Coding Standard" parameter shall be set to "00 (ITU-T standardized coding)". The default value for the ProgressIndicator "Location" parameter is "0011 (Transit Network)". + +If the I-MGCF supports the PSTN XML body and receives a Transmission Medium Used (TMU) parameter, + +NOTE 2: The I-MGCF will only receive a TMU parameter if it has applied the Fallback related procedures in clause 7.2.3.1.2.5a, including both a USI and TMR Prime parameter in the IAM, and fallback to the bearer capability identified in USI and TMR Prime occurred at the terminating side. + +Then the I-MGCF shall: + +- if a BC is not available in the ATP in the ANM or CON, map the TMU value (Speech or 3.1 kHz audio) to the PSTN XML BearerCapability element; +- if a BC is available in the ATP in the ANM or CON, include the received BC in the PSTN XML BearerCapability element; +- configure the IM-MGW to use the second format in the m-line in the SDP that has been received in the INVITE as codec at the IMS termination; and +- send SDP selecting the second format in the m-line of the SDP that has been received in the INVITE as soon as allowed according to SIP rules. + +If the I-MGCF supports the PSTN XML body, has applied the Fallback related procedures in clause 7.2.3.1.2.5a, including both a TMR and TMR Prime in the IAM, and did not receive TMU in the ANM, CON, or any previous ISUP message, + +NOTE 3: Fallback to the bearer capability identified in TMR did not occur at the terminating side. + +Then the I-MGCF shall: + +- configure the IM-MGW to use the first format in the m-line in the SDP offer that has been received in the INVITE as codec at the IMS termination; and +- send SDP selecting the first format in the m-line in the SDP offer at the first possibility according to SIP rules. + +#### 7.2.3.1.6 Sending of the Release message (REL) + +The following are possible triggers for sending the Release message: + +- Receipt of the BYE method + +![Diagram illustrating the receipt of the BYE method. An arrow labeled 'BYE' points from the left to a vertical line representing the I-MGCF. From the I-MGCF, an arrow labeled 'REL' points to the right.](bdd96f20e71f079cad85240efb3d3f24_img.jpg) + +``` + +graph LR + BYE[BYE] --> I-MGCF[I-MGCF] + I-MGCF --> REL[REL] + +``` + +Diagram illustrating the receipt of the BYE method. An arrow labeled 'BYE' points from the left to a vertical line representing the I-MGCF. From the I-MGCF, an arrow labeled 'REL' points to the right. + +**Figure 10: Receipt of the Bye method** + +- Receipt of the CANCEL method + +![Diagram illustrating the receipt of the CANCEL method. An arrow labeled 'CANCEL' points from the left to a vertical line representing the I-MGCF. From the I-MGCF, an arrow labeled 'REL' points to the right.](0db3cccd1279034258e5ad5b6fdcff01_img.jpg) + +``` + +graph LR + CANCEL[CANCEL] --> I-MGCF[I-MGCF] + I-MGCF --> REL[REL] + +``` + +Diagram illustrating the receipt of the CANCEL method. An arrow labeled 'CANCEL' points from the left to a vertical line representing the I-MGCF. From the I-MGCF, an arrow labeled 'REL' points to the right. + +**Figure 11: Receipt of Cancel method** + +Additional triggers are contained in table 10. + +#### 7.2.3.1.7 Coding of the REL + +Coding of the REL message depends on the Reason header field (specified in IETF RFC 3326 [116]) contained in the BYE or CANCEL request. + +If the Reason header field is missing or does not contain a cause parameter then the ISUP Cause Value in the REL message shall be coded as shown in table 8. + +If the Reason header field contains a protocol header field parameter set to "Q.850" then the ISUP Cause Value shall be coded as shown in table 8a. + +If the Reason header field contains a protocol header field parameter set to "SIP" then, as a network option, the ISUP Cause Value may be coded as shown in table 8aa. + +The Location Field shall be set to "*network beyond interworking point*". If, as a network option, the I-MGCF supports the location header field parameter as described in IETF RFC 8606 [155], the I-MGCF shall instead derive the ISUP cause location from the location parameter in the SIP Reason header field as shown in table 8c. + +**Table 8: Coding of REL** + +| SIP Message | REL | +|--------------------|-------------------------------------------| +| Request | cause indicators parameter | +| BYE | Cause value No. 16 (Normal call clearing) | +| CANCEL | Cause value No. 16 (Normal call clearing) | + +**Table 8a: Mapping of SIP Reason header field into Cause Indicators parameter – Q.850 protocol case** + +| Component of SIP Reason header field | Component value | BICC/ISUP Parameter field | Value | +|---------------------------------------------|------------------------|----------------------------------|-------------------------------------| +| Protocol | "Q.850" | Cause Indicators parameter | - | +| protocol-cause | "cause = XX" (NOTE 1) | Cause Value | "XX" (NOTE 1) | +| - | - | Location | "network beyond interworking point" | + +NOTE: "XX" is the Cause Value as defined in ITU-T Recommendation Q.850 [38]. + +**Table 8aa: Mapping of SIP Reason header field into Cause Indicators parameter - SIP protocol case** + +| Component of SIP Reason header field | Component value | BICC/ISUP Parameter field | Value (NOTE 2) | +|---------------------------------------------|------------------------|----------------------------------|-------------------------------------| +| Protocol | "SIP" | Cause Indicators parameter | - | +| protocol-cause | "cause = 200" (NOTE 1) | Cause Value | "13" (Call completed elsewhere) | +| - | - | Location | "network beyond interworking point" | + +NOTE 1: The usage of SIP response codes such as "200" is specified in 3GPP TS 24.229 [9]. +NOTE 2: The ISUP Cause Value in the REL message shall be coded as shown in table 8 if the connected CS network is other operator's network, except when a bilateral agreement for use of the cause value(s) exists between the operators. + +NOTE: The mapping of reason headers towards the ISDN can be misused due to possible user creation of the reason header since there is no screening in IMS. + +If the I-MGCF supports this PSTN XML body as a network option and the I-MGCF interworks media encoded in any of the formats in table 2a (G.711, Clearmode or t38) without transcoding, and if a PSTN XML body is received in the BYE or CANCEL request, the I-MGCF shall derive the Access Transport Parameter in the REL message from the PSTN XML body as shown in table 8b. + +**Table 8b: Mapping of PSTN XML elements into ISUP Parameters** + +| BYE or CANCEL | REL | | +|------------------------|----------------------------|--------------------------| +| PSTN XML | ISUP Parameter | Content | +| HighLayerCompatibility | Access Transport Parameter | High layer compatibility | +| LowLayerCompatibility | | Low layer compatibility | + +**Table 8c: Mapping of SIP Reason header field location parameter into Cause Indicator Location parameter** + +| Component of SIP Reason header field | Component value | BICC/ISUP Parameter field | Value | +|--------------------------------------|-----------------|---------------------------|-----------------------------------------| +| location | U | Location | user | +| | LPN | | private network serving the local user | +| | LN | | public network serving the local user | +| | TN | | transit network | +| | RLN | | public network serving the remote user | +| | RPN | | private network serving the remote user | +| | LOC-6 | | network beyond interworking point | +| | INTL | | international network | +| | LOC-8 | | network beyond interworking point | +| | LOC-9 | | network beyond interworking point | +| | BI | | network beyond interworking point | +| | LOC-11 | | network beyond interworking point | +| | LOC-12 | | network beyond interworking point | +| | LOC-13 | | network beyond interworking point | +| | LOC-14 | | network beyond interworking point | +| | LOC-15 | | network beyond interworking point | + +NOTE: The interworking of the location value as described in this table is a network option. + +#### 7.2.3.1.8 Receipt of the Release Message + +If the REL message is received and a final response (i.e. 200 OK (INVITE)) has already been sent, the I-MGCF shall send a BYE message. + +NOTE: According to SIP procedures, in the case that the REL message is received and a final response (e.g. 200 OK (INVITE)) has already been sent (but no ACK request has been received) on the incoming side of the I-MGCF then the I-MGCF does not send a 487 Request terminated response and instead waits until the ACK request is received before sending a BYE message. + +If the REL message is received and the final response (i.e. 200 OK (INVITE)) has not already been sent, the I-MGCF shall send a Status-Code 4xx (Client Error), 5xx (Server Error) or 6xx (Global Failure) response. The Status code to be sent is determined by examining the Cause value received in the REL message. Table 9 specifies the mapping of the cause values, as defined in ITU-T Recommendation Q.850 [38], to SIP response status codes. Cause values not appearing in the table shall have the same mapping as the appropriate class defaults according to ITU-T Recommendation Q.850 [38]. + +**Table 9: Receipt of the Release message (REL)** + +| ← SIP Message | ← REL | +|-------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------| +| Status code | Cause indicators parameter | +| 404 Not Found | Cause value No 1 (Unallocated (unassigned) number) | +| 604 Does not exist anywhere | Cause value No 2 (No route to specified transit network) | +| 604 Does not exist anywhere | Cause value No 3 (No route to destination) | +| 500 Server Internal error | Cause value No 4 (Send special information tone) | +| 404 Not Found | Cause value No 5 (Misdialed trunk prefix) | +| 486 Busy Here | Cause value No 17 (User busy) | +| 408 Request Timeout IF "ICS call"
(NOTE 4)
ELSE 480 Temporarily unavailable | Cause value No 18 (No user responding) | +| 480 Temporarily unavailable | Cause value No 19 (No answer from user (user alerted)) | +| 408 Request Timeout IF "ICS call"
(NOTE 4)
ELSE 480 Temporarily unavailable | Cause value No 20 (Subscriber absent) | +| 603 Decline IF location field is set to user
ELSE 403 Forbidden | Cause value No 21 (Call rejected) | +| 410 Gone | Cause value No 22 (Number changed) | +| 410 Gone | Cause value No 23 (Redirection to new destination) | +| 433 Anonymity Disallowed (NOTE 1) | Cause value No 24 (Call rejected due to feature at the destination) | +| 483 Too Many Hops | Cause value No 25 (Exchange routing error) | +| 480 Temporarily unavailable | Cause value No 26 (Non-selected user clearing) | +| 502 Bad Gateway | Cause value No 27 (Destination out of order) | +| 484 Address Incomplete | Cause value No 28 (Invalid number format (address incomplete)) | +| 501 Not Implemented | Cause value No 29 (Facility rejected) | +| 480 Temporarily unavailable | Cause value No 31 (Normal, unspecified)
(class default) (NOTE 2) | +| 486 Busy here if Diagnostics indicator
includes the (CCBS indicator = CCBS
possible)
else 503 Service Unavailable (NOTE 3) | Cause value No 34 (No circuit/channel available) | +| 500 Server Internal error | Cause value No 38 (Network out of order) | +| 503 Service Unavailable (NOTE 3) | Cause value No 41 (Temporary failure) | +| 503 Service Unavailable (NOTE 3) | Cause value No 42 (Switching equipment congestion) | +| 500 Server Internal error | Cause value No 43 (Access information discarded) | +| 503 Service Unavailable (NOTE 3) | Cause value No 44 (Requested channel not available) | +| 500 Server Internal error | Cause value No 46 (Precedence call blocked) | +| 503 Service Unavailable (NOTE 3) | Cause value No 47 (Resource unavailable, unspecified)
(class default) | +| 488 Not acceptable here | Cause value No 50 (Requested facility not subscribed) | +| 603 Decline | Cause value No 55 (Incoming class barred within Closed User Group
(CUG)) | +| 603 Decline | Cause value No 57 (Bearer capability not authorised) | +| 503 Service Unavailable (NOTE 3) | Cause value No 58 (Bearer capability not presently available) | +| 501 Not Implemented | Cause value No 63 (Service option not available, unspecified)
(class default) | +| 500 Server Internal error | Cause value No 65 (Bearer capability not implemented) | +| 501 Not Implemented | Cause value No 69 (Requested facility not implemented) | +| 501 Not Implemented | Cause value No 70 (Only restricted digital information capability is
available) | +| 501 Not Implemented | Cause value No 79 (Service or option not implemented, unspecified)
(class default) | +| 403 Forbidden | Cause value No 87 (User not member of Closed User Group (CUG)) | +| 606 Not Acceptable | Cause value No 88 (Incompatible destination) | +| 403 Forbidden | Cause value No 90 (Non existing Closed User Group (CUG)) | +| 500 Server Internal error | Cause value No 91 (Invalid transit network selection) | +| 513 Message too large | Cause value No 95 (Invalid message, unspecified)
(class default) | +| 501 Not Implemented | Cause value No 97 (Message type non-existent or not implemented) | +| 501 Not Implemented | Cause value No 98 (Message not compatible with call state or
message type non-existent or not implemented) | +| 501 Not Implemented | Cause value No 99 (Information element/parameter non-existent or
not implemented) | +| 504 Server timeout | Cause value No 102 (Recovery on timer expiry) | + +| ←SIP Message | ← REL | +|---------------------------|---------------------------------------------------------------------------| +| Status code | Cause indicators parameter | +| 501 Not Implemented | Cause value No 103 (Parameter non-existent or not implemented, passed on) | +| 501 Not Implemented | Cause value No 110 (Message with unrecognised parameter, discarded) | +| 400 Bad Request | Cause value No 111 (Protocol error, unspecified) (class default) | +| 500 Server Internal error | Cause value No 127 (Interworking, unspecified) (class default) | + +NOTE 1: Anonymity Disallowed, IETF RFC 5079 [77] refers +NOTE 2: Class 0 and class 1 have the same default value. +NOTE 3: No Retry-After header field shall be included. +NOTE 4: The I-MGCF identifies a call as an "ICS call" as specified in clause 7.2.3.1.2.12. + +A Reason header field containing the received (Q.850) Cause Value of the REL shall be added to the SIP final response or BYE request sent as a result of this subclause. The mapping of the Cause Indicators parameter to the Reason header is shown in table 9a. IETF RFC 6432 [115] describes the use of the Reason header field in responses. The Reason header field itself is described in IETF RFC 3326 [116]. If, as a network option, the I-MGCF supports the location header field parameter as described in IETF RFC 8606 [155], the I-MGCF shall map the ISUP cause location to the location parameter in the SIP Reason header field as shown in table 9a. + +**Table 9a: Mapping of Cause Indicators parameter into SIP Reason header fields** + +| Cause indicators parameter field | Value of parameter field | component of SIP Reason header field | component value | +|----------------------------------|-----------------------------------------|--------------------------------------|--------------------------------------------------------------------------------------------------| +| - | - | protocol | "Q.850" | +| Cause Value | "XX" (NOTE 1) | protocol-cause | "cause = XX" (NOTE 1) | +| - | - | reason-text | Should be filled with the definition text as stated in ITU-T Recommendation Q.850 [38]. (NOTE 2) | +| Location (NOTE 3) | user | location | U | +| | private network serving the local user | | LPN | +| | public network serving the local user | | LN | +| | transit network | | TN | +| | public network serving the remote user | | RLN | +| | private network serving the remote user | | RPN | +| | international network | | INTL | +| | network beyond interworking point | | BI | +| | | | | + +NOTE 1: "XX" is the Cause Value as defined in ITU-T Recommendation Q.850 [38]. +NOTE 2: Due to the fact that the Cause Indicators parameter does not include the definition text as defined in table 1/Q.850 [38], this is based on provisioning in the I-MGCF. +NOTE 3: The mapping of the cause location is a network option. + +As a network option, an I-MGCF may generate an Error-Info header field according to rules and procedures of IETF RFC 3261 [19] to provide media instead of the in-band media received from the PSTN. + +If the I-MGCF supports the PSTN XML body as a network option, the I-MGCF shall map the Access Transport Parameter received in the REL into PSTN XML elements as shown in table 9aa and include this PSTN XML body in the SIP final response or BYE. + +**Table 9aa: Mapping of ISUP Parameters into PSTN XML elements** + +| 4xx,5xx,6xx or BYE | REL | | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------|--------------------------| +| PSTN XML | ISUP Parameter | Content | +| ProgressIndicator | Access Transport Parameter | Progress indicator | +| HighLayerCompatibility (NOTE) | | High layer compatibility | +| LowLayerCompatibility (NOTE) | | Low layer compatibility | +| NOTE: The I-MGCF shall only provide this IE if it interworks media encoded in any of the formats in table 2a (G.711, Clearmode, or t38) without transcoding, | | | + +### 7.2.3.1.9 Receipt of RSC, GRS or CGB (H/W oriented) + +Upon receipt of a RSC, GRS or CGB (H/W oriented) message the following applies independently for each affected circuit: + +- NOTE: For the RSC message, the circuit identified by the CIC is affected. + For the GRS message, the affected circuits are identified by the CIC and the Range subfield of the Range and Status parameter. + For the CGB message, the affected circuits are identified by the CIC and the Range and Status parameter. + +If an initial address message has been sent for the affected circuit and after at least one backward message relating to that call has been received then: + +- If the final response (i.e. 200 OK (INVITE)) has already been sent, the I-MGCF shall send a BYE message. +- If the final response (i.e. 200 OK (INVITE)) has not already been sent, the I-MGCF shall send a SIP response with Status-Code 480 Temporarily Unavailable. + +A Reason header field containing the (Q.850) Cause Value of the REL message generated by the ISUP procedures shall be added to the SIP message (BYE or 480 response) to be sent by the SIP side of the I-MGCF. + +### 7.2.3.1.9a Receipt of REFER + +![Diagram illustrating the receipt of REFER method. It shows a vertical timeline with a horizontal arrow pointing left towards it from the right side. Above the timeline is a black rectangular block with a white horizontal bar at the top.](02e16c8e8e61c2706b5c0129674884a8_img.jpg) + +The diagram shows a vertical line representing a timeline. A horizontal arrow points from the right towards this line. Above the timeline is a black rectangular block with a white horizontal bar at the top, likely representing a SIP message or a call state. + +Diagram illustrating the receipt of REFER method. It shows a vertical timeline with a horizontal arrow pointing left towards it from the right side. Above the timeline is a black rectangular block with a white horizontal bar at the top. + +**Figure 11a: Receipt of REFER method** + +Upon receipt of a REFER request at the MGCF, the default behaviour of the I-MGCF is to reject the REFER request with a 403 Forbidden response. + +NOTE: The I-MGCF may also decide for example to execute the REFER request as specified in IETF RFC 3515 [75] as an operator option, but such handling is outside of the scope of the present document. + +#### 7.2.3.1.10 Autonomous Release at I-MGCF + +Table 10 shows the trigger events at the MGCF and the release initiated by the MGCF when the call is traversing from SIP to ISUP/BICC. + +A Reason header field containing the (Q.850) Cause Value of the REL message sent by the I-MGCF shall be added to the SIP Message (BYE request or final response) sent by the SIP side of the I-MGCF. + +**Table 10: Autonomous Release at I-MGCF** + +| SIP Response | Trigger event | REL cause parameter | +|------------------------------|------------------------------------------------------------------|------------------------------------| +| 484 Address Incomplete | Determination that insufficient digits received. | Not sent. | +| 480 Temporarily Unavailable | Congestion at the MGCF/Call is not routable. | Not sent. | +| BYE | ISUP/BICC procedures result in release after answer | According to ISUP/BICC procedures. | +| BYE | SIP procedures result in release after answer. | 127 (Interworking unspecified) | +| 500 Server Internal error | Call release due to the ISUP/BICC compatibility procedure (NOTE) | According to ISUP/BICC procedures. | +| 484 Address Incomplete | Call release due to expiry of T7 within the ISUP/BICC procedures | According to ISUP/BICC procedures. | +| 480 Temporarily Unavailable | Call release due to expiry of T9 within the BICC/ISUP procedures | According to BICC/ISUP procedures. | +| 480 Temporarily Unavailable. | Other BICC/ISUP procedures result in release before answer. | According to BICC/ISUP procedures. | + +NOTE: MGCF receives unrecognized ISUP or BICC signalling information and determines that the call needs to be released based on the coding of the compatibility indicators, refer to ITU-T Recommendation Q.764 [4] and ITU-T Q.1902.4 [30]. + +#### 7.2.3.1.11 Internal through connection of the bearer path + +The through connection procedure is described in clause 9.2.2.3.5. + +### 7.2.3.2 Outgoing Call Interworking from ISUP to SIP at O-MGCF + +#### 7.2.3.2.1 Sending of INVITE + +##### 7.2.3.2.1.1 General + +![Diagram showing the receipt of an IAM message by the O-MGCF and the subsequent sending of an INVITE message.](d31e6cf9a987586abee2f530b7812041_img.jpg) + +The diagram illustrates the flow of signaling messages at an O-MGCF. An arrow labeled 'IAM' points from the left towards a vertical line representing the O-MGCF. Above the vertical line is the label 'O-MGCF'. From the right side of the vertical line, an arrow labeled 'INVITE' points to the right. + +Diagram showing the receipt of an IAM message by the O-MGCF and the subsequent sending of an INVITE message. + +**Figure 11b: Receipt of an IAM** + +Upon reception of an IAM message, the O-MGCF shall send a SIP INVITE request, as further detailed in the clauses below. + +An O-MGCF shall support both the SIP preconditions and 100 rel extensions and indicate the support of the SIP preconditions and 100rel extensions in the INVITE request, unless the Note below applies. + +NOTE: If the O-MGCF is deployed in an IMS network that by local configuration serves no user requiring preconditions, it may send the INVITE request without indicating support of preconditions. + +#### 7.2.3.2.1.2 Interaction with continuity check + +If the Continuity Check indicator in the Nature of Connection Indicators parameter in the incoming IAM is set to indicate either "*continuity check required on this circuit*" or "*continuity check performed on previous circuit*", the O-MGCF should defer sending the INVITE request until receiving a COT message. + +NOTE: If the Continuity Check indicator in the Nature of Connection Indicators parameter in the incoming IAM is set to indicate either "*continuity check required on this circuit*" or "*continuity check performed on previous circuit*" and the O-MGCF sends the INVITE request before receiving a COT message, the following considerations apply: If the receiving terminal is not supporting the SIP precondition and the SIP UPDATE method, clipping may occur. Furthermore, if the MGCF sets the SDP "inactive" attribute in the initial INVITE request and the receiving terminal is not supporting the SIP precondition, the interworking procedures within the present specification do not describe all necessary signalling interactions required to set up a call, in particular with respect to the sending of the re-INVITE that may also cause additional delay in the call setup. In addition, the interworking of the ringing indication might not be possible if the peer sends the ringing indication only as response to a re-INVITE. + +![Sequence diagram for Figure 12: Receipt of an IAM (Waiting for the COT message).](1399c76ef88f22b70d05ed3f781d3c48_img.jpg) + +The diagram shows a sequence of messages received by an O-MGCF. A solid horizontal arrow labeled 'IAM' points to a vertical line representing the O-MGCF. Below it, a dashed horizontal arrow labeled 'COT (NOTE)' also points to the same vertical line. After the COT message is received, a solid horizontal arrow labeled 'INVITE' points away from the O-MGCF to the right. + +Sequence diagram for Figure 12: Receipt of an IAM (Waiting for the COT message). + +NOTE: Waiting for the COT is recommended, if the Continuity Check indicator in the Nature of Connection Indicators parameter in the incoming IAM is set to indicate either "*continuity check required on this circuit*" or "*continuity check performed on previous circuit*" + +**Figure 12: Receipt of an IAM (Waiting for the COT message)** + +#### 7.2.3.2.1.3 IAM without calling party number + +If no calling party number is received in the incoming IAM message, as a network option, the O-MGCF may send an INR message to request the calling party number and not send the INVITE request until receiving an INF message with calling party number. If no calling party number is received in the INF message, O-MGCF may reject or continue the call based on local configuration. + +![Sequence diagram for Figure 12a: Receipt of an IAM (Request for calling party number).](e534e903e6dae8a582643bfd9f89254c_img.jpg) + +The diagram shows a sequence of messages received by an O-MGCF. A solid horizontal arrow labeled 'IAM' points to a vertical line representing the O-MGCF. From the O-MGCF, a solid horizontal arrow labeled 'INR' points back to the left. A solid horizontal arrow labeled 'INF' points to the O-MGCF from the left. After the INF message is received, a solid horizontal arrow labeled 'INVITE' points away from the O-MGCF to the right. + +Sequence diagram for Figure 12a: Receipt of an IAM (Request for calling party number). + +**Figure 12a: Receipt of an IAM (Request for calling party number)** + +#### 7.2.3.2.1.4 Terminating overlap signalling at MGCF + +![Sequence diagram showing the receipt of IAM and SAM messages by the O-MGCF, followed by the sending of an INVITE message.](5bba23cc120ad806779f82df1c01bebf_img.jpg) + +``` + +sequenceDiagram + participant CS Network + participant O-MGCF + Note right of CS Network: IAM + CS Network->>O-MGCF: IAM + Note right of CS Network: SAM + CS Network->>O-MGCF: SAM + Note left of O-MGCF: INVITE + O-MGCF->>CS Network: INVITE + +``` + +Sequence diagram showing the receipt of IAM and SAM messages by the O-MGCF, followed by the sending of an INVITE message. + +**Figure 13: Receipt of an IAM (Overlap signalling in CS network)** + +After initiating the normal incoming BICC/ISUP call establishment procedures, determining the end of address signalling and selecting to route the call to the IMS domain, the O-MGCF shall send the initial INVITE. + +The end of address signalling shall be determined by the earlier of the following criteria: + +- by receipt of an end-of-pulsing (ST) signal; or +- by receipt of the maximum number of digits used in the national numbering plan; or +- by analysis of the called party number to indicate that a sufficient number of digits has been received to route the call to the called party; or +- by observing that timer Ti/w1 has expired after the receipt of the latest address message and the minimum number of digits required for routing the call have been received. + +If the end of the address signalling is determined in accordance with criteria a) b) or c), the timer Ti/w2 is started when INVITE is sent. Also, if the PSTN XML body is supported as a network option, the O-MGCF shall insert the PSTN XML sendingCompleteIndication. + +#### 7.2.3.2.1.5 Fallback (optional) + +The Fallback mechanism described in the present clause shall only apply if the O-MGCF supports the PSTN XML body as a network option, and propagates UDI-TA fallback signalling into the IMS as a network option. + +NOTE: If the Fallback related signalling is not forwarded according to the procedures in the present subclause by the O-MGCF, the O-MGCF will apply the ISUP Fallback procedures when the IAM includes a TMR and a TMR prime parameter and a USI and USI Prime parameter. + +When the IAM includes a TMR and a TMR prime parameter and a USI and USI Prime parameter then the O-MGCF shall: + +- map the "USI Prime" into the "InformationTransferCapability" of the second BearerCapability element in the PSTN XML body; +- include SDP with one m-line of "audio" media type in the INVITE; +- map the "TMR" and "USI Prime" into a first offerered format in the SDP m-line according to table 10b; +- map the "USI" into the first Bearer Capability element in the PSTN XML body; +- map the "TMR prime" into the "InformationTransferCapability" of the first BearerCapability element in the PSTN XML body; and +- map the TMR prime and USI into a second offerered format in the SDP m-line according to table 10b. + +### 7.2.3.2.1a Sending of INVITE without determining the end of address signalling + +#### 7.2.3.2.1a.1 General + +As a network option, the O-MGCF is not required to determine the end of address signalling. In this case the O-MGCF shall send an initial INVITE when a preconfigured number of digits has been reached. + +When the MGCF receives ISUP SAM messages the additional digits received in the SAMs may either be sent using the in-dialog overlap method as specified in clause 7.2.3.2.1a.2 or using the multiple INVITEs overlap method as specified in 7.2.3.2.1a.3. It depends on the network configuration which of these methods is applied. However, within one IMS only a single method shall be used. + +#### 7.2.3.2.1a.2 Additional digits sent with in-dialog overlap method + +![Sequence diagram illustrating overlap signalling using in-dialog INFO messages. The diagram shows the interaction between an external network and the O-MGCF. The sequence is: 1. IAM is received by the O-MGCF. 2. The O-MGCF sends an INVITE. 3. The O-MGCF receives a 404/484 response. 4. A SAM is received by the O-MGCF. 5. The O-MGCF sends another INVITE. 6. The O-MGCF receives an 18x provisional response. 7. Another SAM is received by the O-MGCF. 8. The O-MGCF sends an INFO message. 9. The O-MGCF receives a 200 (INFO) response.](aa73c8651865e31f7a2f7b8a9c068461_img.jpg) + +``` + +sequenceDiagram + participant External + participant O-MGCF + Note right of O-MGCF: O-MGCF + External->>O-MGCF: IAM + O-MGCF->>External: INVITE + External-->>O-MGCF: 404/484 + External->>O-MGCF: SAM + O-MGCF->>External: INVITE + External-->>O-MGCF: 18x + External->>O-MGCF: SAM + O-MGCF->>External: INFO + External-->>O-MGCF: 200 (INFO) + +``` + +Sequence diagram illustrating overlap signalling using in-dialog INFO messages. The diagram shows the interaction between an external network and the O-MGCF. The sequence is: 1. IAM is received by the O-MGCF. 2. The O-MGCF sends an INVITE. 3. The O-MGCF receives a 404/484 response. 4. A SAM is received by the O-MGCF. 5. The O-MGCF sends another INVITE. 6. The O-MGCF receives an 18x provisional response. 7. Another SAM is received by the O-MGCF. 8. The O-MGCF sends an INFO message. 9. The O-MGCF receives a 200 (INFO) response. + +**Figure 14: Overlap signalling using in-dialog INFOs in CS an IMS network** + +If the O-MGCF sends an initial SIP INVITE request before the end of address signalling is determined, the O-MGCF shall: + +- use the SIP precondition extension within the SIP INVITE request; +- start timer Ti/w2; +- be prepared to process SAM as described below; +- be prepared to handle incoming SIP 18x provisional responses, establishing early dialogs; and +- be prepared to handle incoming SIP 404 or 484 error responses as detailed in clause 7.2.3.2.12.1. + +NOTE 1: A SIP INVITE request with incomplete address information can be rejected with a SIP 404 or 484 error response. + +On receipt of a SAM from the BICC/ISUP side, unless the O-MGCF has received a SIP 180 (Ringing) response for the call, the following O-MGCF procedures apply: + +- The O-MGCF shall stop timer Ti/w3 (if it is running). +- If no response has been received for the previous INVITE request of the same call, the O-MGCF shall wait for the response and then apply the procedures in the next bullets to transfer the digits received in the SAM. If additional SAMs are received while the O-MGCF is waiting for the response for the previous SIP INVITE request, the digits within shall be combined with the digits of the previous SAMs. + +- If an early dialog has not been established, and a SIP 404 or 484 error response has been received for the last previous SIP INVITE request for the same call, the O-MGCF shall send a SIP INVITE request complying to the following: + - The SIP INVITE request shall use the SIP preconditions extension. + - The SIP INVITE request shall include all digits received so far for this call in the Request-URI. + - The SIP INVITE request shall include the same Call-ID and From tag as the previous SIP INVITE request for the call. +- If an early dialog has been established, and a response has been received for any previously sent SIP INFO request ("legacy" mode of usage of the INFO method as defined in IETF RFC 6086 [133]), the O-MGCF shall send an in-dialog SIP INFO request complying the following: + - The SIP INFO request shall only include the digits received since the previous SIP request with digits was sent (see Note). +- If no response has been received for the previous SIP INFO request, the O-MGCF shall wait for the response and then apply the procedures in the previous bullet to transfer digits received in the SAM. If additional SAMs are received while the O-MGCF is waiting for the response for the previous SIP INFO request, the digits within shall be combined with the digits of the previous SAMs. +- Restart Ti/w2. + +If timer Ti/w2 has expired, or the O-MGCF has received a SIP 180 (Ringing) response for the call, the O-MGCF shall ignore subsequent SAMs received. + +NOTE 2: The encoding of the digits within the SIP INFO request is described in clause 7.2.3.2.20.2. + +#### 7.2.3.2.1a.3 Additional digits sent using the multiple INVITEs overlap method + +![Sequence diagram showing overlap signalling using multiple INVITEs in CS and IMS network. The O-MGCF receives IAM and SAM messages from the left and sends INVITE messages to the right. It receives 404/484 responses from the right and sends subsequent INVITE messages as more SAMs are received.](b8efedb73292a798b3f2050f9335cae6_img.jpg) + +O-MGCF + +``` + +sequenceDiagram + participant CS + participant O-MGCF + participant IMS + Note over O-MGCF: O-MGCF + CS->>O-MGCF: IAM + O-MGCF->>IMS: INVITE + IMS-->>O-MGCF: 404/484 + CS->>O-MGCF: SAM + O-MGCF->>IMS: INVITE + IMS-->>O-MGCF: 404/484 + CS->>O-MGCF: SAM + O-MGCF->>IMS: INVITE + +``` + +Sequence diagram showing overlap signalling using multiple INVITEs in CS and IMS network. The O-MGCF receives IAM and SAM messages from the left and sends INVITE messages to the right. It receives 404/484 responses from the right and sends subsequent INVITE messages as more SAMs are received. + +**Figure 14a: Overlap signalling using multiple INVITEs in CS and IMS network** + +If the O-MGCF sends an SIP INVITE request before the end of address signalling is determined, the O-MGCF shall: + +- use the SIP precondition extension within the SIP INVITE request; +- start timer Ti/w2; and +- be prepared to process SAM as described below; and +- be prepared to handle incoming SIP 404 or 484 error responses as detailed in clause 7.2.3.2.12.1. + +NOTE: An SIP INVITE request with incomplete address information will be rejected with a SIP 404 or 484 error response. + +On receipt of a SAM from the BICC/ISUP side, unless the O-MGCF has received a SIP 180 (Ringing) response for the call, the O-MGCF shall: + +- stop timer Ti/w3 (if it is running); +- send an INVITE request complying to the following: + - The SIP INVITE request shall use the SIP preconditions extension. + - The SIP INVITE request shall include all digits received so far for this call in the Request-URI. + - The SIP INVITE request shall include the same Call-ID and From tag as the previous SIP INVITE request for the call. +- restart Ti/w2; + +If timer Ti/w2 has expired, or the O-MGCF has received a SIP 180 (Ringing) response for the call, the O-MGCF shall ignore subsequent SAMs received. + +### 7.2.3.2.2 Coding of the INVITE + +#### 7.2.3.2.2.0 Overview + +Table 10aa provides a summary of how the header fields within the outgoing INVITE message are populated. + +**Table 10aa: Interworked contents of the INVITE message** + +| IAM→ | INVITE→ | +|-------------------------------------------------------------|------------------------------------------------------------------------------| +| Called Party Number | Request-URI
To
History-Info | +| Calling Party Number | P-Asserted-Identity
Privacy
From
Attestation-Info
Origination-Id | +| Generic Number ( "additional calling party number" ) | From
Privacy
Attestation-Info
Origination-Id | +| Called IN number | History-Info | +| Original called IN number | History-Info | +| Hop Counter | Max-Forwards | +| TMR/USI | Message Body (application/SDP) | +| Location Number | P-Access-Network-Info | + +#### 7.2.3.2.2.1 Request-URI and To header field + +The called party number parameter of the IAM message is used to derive Request-URI of the INVITE request. The Request-URI is a tel URI or SIP URI with "user=phone" and shall contain: + +- an E.164 International public telecommunication number prefixed by a "+" sign (e.g. tel:+4911231234567) , or +- a non E.164 number (national operator option for service numbers), expressed as a local number as per IETF RFC 3966 [97]. + +**Table 10a: Mapping ISUP Called Party Number to SIP Request-URI and To header field** + +| IAM | | INVITE | | +|-----------------------------------------------|----------------------------------------------------------------------------|---------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| BICC/ISUP Parameter / field | Value | SIP component | Value | +| Called Party Number (NOTE 3) | | Request-URI and To header field | display-name (optional) and addr-spec derived from Called Party Number parameter address signals | +| Nature of Address Indicator (NOTE 2) (NOTE 6) | " national (significant) number " | Tel URI or SIP URI | Insert "+CC" before the Address signals (NOTE 1) | +| | " international number " | | Insert "+" before the Address signals | +| | " Network-specific number " or " reserved for national use " | | according to local policies should either be:
- a global number (+CC), if the called party number may be converted into an E.164 address
OR, depending on operator's requirements may be converted into
- local number (with a phone-context parameter) (NOTE 4) (NOTE 5) | + +NOTE 1: CC = Country Code of the network in which the O-MGCF is located. +NOTE 2: The usage of "Nature of address indicator" value "unknown" is allowed but the mapping is not specified in the present specification. +NOTE 3: If the address signals received in the ISUP Called Party Number contain a sending terminated signal (hexadecimal digit F), then this shall be discarded or if the O-MGCF supports the PSTN XML body as a network option then the PSTN XML sendingCompleteIndication shall be set. +NOTE 4: Mapping between nature of address indicator values and phone-context values is provisioned in the MGCF. Setting of value of phone-context is depending on local operator's policies. +NOTE 5: Network-specific number or reserved for national use shall be translated into E.164 format numbers except if local operator's policy requires keeping in local format (e.g. for national reasons E.164 numbers cannot be used for such purpose). In the later case the mapping shall be done as indicated in the table. +NOTE 6: The values "Network routing number in national (significant) number format", "Network routing number in network specific number format" or "Network routing number concatenated with called directory number" are used when number portability is supported. For the mapping see clause 7.2.3.2.2A. + +#### 7.2.3.2.2.2 SDP Media Description + +If the O-MGCF indicates support of the SIP preconditions in the initial INVITE request and local preconditions have not been met, the SDP media description shall contain precondition information as per 3GPP TS 24.229 [9]. Depending on the coding of the continuity indicators different precondition information (IETF RFC 3312 [37]) is included. If the continuity indicator indicates "continuity performed on a previous circuit" or "continuity required on this circuit", and the INVITE is sent before receiving a COT, message (which is not recommended according to clause 7.2.3.2.1.1), then the O-MGCF shall indicate that the preconditions are not met. Otherwise the O-MGCF shall indicate whether the preconditions are met, dependent on the status of the local resource reservation. + +If the O-MGCF determines that a speech call is incoming, the O-MGCF shall include the AMR codec transported according to IETF RFC 4867 [23] with the options listed in clause 12.3.1 of 3GPP TS 26.114 [104] in the SDP offer, unless the Note below applies. Within the SDP offer, the O-MGCF should also provide SDP RR and RS bandwidth modifiers specified in IETF RFC 3556 [59] as detailed in clause 7.3.1 of 3GPP TS 26.114 [104]. The O-MGCF may include other codecs according to operator policy. + +NOTE: If the O-MGCF is deployed in an IMS network that by local configuration serves no user equipment that implements the AMR codec, then the AMR codec may be excluded from the SDP offer. + +To avoid transcoding or to support non-speech services, the O-MGCF may add media derived from the incoming ISUP information according to table 10b. The support of the media listed in table 10b is optional. If the O-MGCF supports the PSTN XML body as a network option and adds media derived from the incoming ISUP information according to table 10b, the O-MGCF shall also map the media related ISUP information into the XML body as shown in table 7.2.3.2.2.7.1. + +**Table 10b: Coding of SDP media description lines from TMR/USI: ISUP to SIP** + +| TMR parameter | USI parameter (Optional) | | HLC IE in ATP (Optional) | m= line | | | b= line | a= line | +|--------------------------|------------------------------------|---------------------------------------------|-------------------------------------------|----------------|--------------|--------------------------------------------------------|----------------------------------|------------------------------------------------------------------------------------------------------------| +| | | | | | | | | | +| TMR codes | Information Transfer-Capability | User Information Layer 1 Protocol Indicator | High Layer Characteristics Identification | | | | :
| rtpmap: // | +| "speech" | "Speech" | "G.711 μ-law" | Ignore | audio | RTP/AVP | 0 (and possibly 8) (NOTE 1) | AS: (64 + RTP/UDP/IP overhead) | rtpmap:0 PCMU/8000 (and possibly rtpmap:8 PCMA/8000) (NOTE 1) | +| "speech" | "Speech" | "G.711 μ-law" | Ignore | audio | RTP/AVP | Dynamic PT (and possibly a second Dynamic PT) (NOTE 1) | AS: (64 + RTP/UDP/IP overhead) | rtpmap: PCMU/8000 (and possibly rtpmap: PCMA/8000) (NOTE 1) | +| "speech" | "Speech" | "G.711 A-law" | Ignore | audio | RTP/AVP | 8 | AS: (64 + RTP/UDP/IP overhead) | rtpmap:8 PCMA/8000 | +| "speech" | "Speech" | "G.711 A-law" | Ignore | audio | RTP/AVP | Dynamic PT | AS: (64 + RTP/UDP/IP overhead) | rtpmap: PCMA/8000 | +| "3.1 KHz audio" | USI Absent | | Ignore | audio | RTP/AVP | 8 | AS: (64 + RTP/UDP/IP overhead) | rtpmap:8 PCMA/8000 | +| "3.1 KHz audio" | "3.1 KHz audio" | "G.711 μ-law" | (NOTE 3) | audio | RTP/AVP | 0 (and possibly 8) (NOTE 1) | AS: (64 + RTP/UDP/IP overhead) | rtpmap:0 PCMU/8000 (and possibly rtpmap:8 PCMA/8000) (NOTE 1) | +| "3.1 KHz audio" | "3.1 KHz audio" | "G.711 A-law" | (NOTE 3) | audio | RTP/AVP | 8 | AS: (64 + RTP/UDP/IP overhead) | rtpmap:8 PCMA/8000 | +| "3.1 KHz audio" | "3.1 KHz audio" | | "Facsimile Group 2/3" | image (NOTE 9) | Udptl [73] | t38[73] | AS: (64 + UDP/IP overhead) | Based on ITU-T T.38 [72]. (NOTE 8) | +| "3.1 KHz audio" | "3.1 KHz audio" | | "Facsimile Group 2/3" | image (NOTE 9) | Tcp (NOTE 7) | t38[73] | AS: (64 + TCP/IP overhead) | Based on ITU-T T.38 [72]. (NOTE 8) | +| "3.1 KHz audio" | "3.1 KHz audio" | | "Facsimile Group 2/3" | Audio (NOTE 9) | RTP/AVP | 0, 8, or | AS: (64 + RTP/UDP/IP overhead) | rtpmap:0 PCMA/8000 or rtpmap:8 PCMU/8000 or rtpmap: PCMA/8000 or rtpmap: PCMU/8000 | +| "64 kbit/s preferred" | "Speech/ 3.1KHz audio" (NOTE 6) | N/A | Ignore | audio | RTP/AVP | Dynamic PT | AS: (64 + RTP/UDP/IP overhead) | rtpmap: CLEARMODE/8000 (NOTE 2)(NOTE 4) | +| "64 kbit/s unrestricted" | "Unrestricted digital information" | N/A | Ignore | audio | RTP/AVP | Dynamic PT | AS: (64 + RTP/UDP/IP overhead) | rtpmap: CLEARMODE/8000 (NOTE 2)(NOTE 5) | + +| TMR parameter | USI parameter (Optional) | | HLC IE in ATP (Optional) | m= line | | | b= line | a= line | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------|---------------------------------------------|-------------------------------------------|---------|-------------|------------|----------------------------------|------------------------------------------------------------------------| +| | Information Transfer-Capability | User Information Layer 1 Protocol Indicator | | | | | :
| rtpmap: // | +| TMR codes | | | High Layer Characteristics Identification | | | | | | +| NOTE 1: Both PCMA and PCMU could be required. | | | | | | | | | +| NOTE 2: CLEARMODE is specified in IETF RFC 4040 [69]. | | | | | | | | | +| NOTE 3: HLC is normally absent in this case. It is possible for HLC to be present with the value "Telephony", although 6.3.1/ITU-T Q.939 indicates that this would normally be accompanied by a value of "Speech" for the Information Transfer Capability element. | | | | | | | | | +| NOTE 4: After the CLEARMODE codec, additional speech codecs such as AMR and/or G.722 and/or G.711 available via transcoding or reframing should be offered in the same m-line. | | | | | | | | | +| NOTE 5: As alternative or in addition to the m-line containing the CLEARMODE codec, an MGCF supporting the multimedia interworking detailed in Annex E may add an m-line for speech codecs and an m-line for video codecs as detailed in this Annex. | | | | | | | | | +| NOTE 6: In this case, the USI prime parameter will also be present and will indicate "Unrestricted Digital Information with tones/announcements". | | | | | | | | | +| NOTE 7: This value is not recommended in a network supporting MTSI clients as it is not supported by an MTSI client (see TS 24.173 [88]). | | | | | | | | | +| NOTE 8: Annex K describes recommended values. | | | | | | | | | +| NOTE 9: FAX can either be transported according to ITU-T recommendation T.38 [72] using the "image" media type or as inband Voice band data over IP using the "audio" media type. | | | | | | | | | + +7.2.3.2.2.3 P-Asserted-Identity, From and Privacy header fields + +**Table 12: Mapping BICC/ISUP CLI parameters to SIP header fields** + +| Has a Calling Party Number parameter with complete E.164 number, and with Screening Indicator = UPVP or NP (NOTE 1) been received? | Calling Party Number APRI | Has a Generic Number (AcgPN) with a complete E.164 number and with Screening Indicator = UPNV been received? | Generic Number APRI | P-Asserted-Identity header field | From header field | Privacy header field | +|------------------------------------------------------------------------------------------------------------------------------------|---------------------------|--------------------------------------------------------------------------------------------------------------|---------------------------|--------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------| +| N | - | N | - | Header field not included or if included SIP URI with addr-spec of Unavailable User Identity (NOTE 11) | SIP URI with addr-spec of Unavailable User Identity (NOTE 2) (NOTE 6) (NOTE 12) | Header field not included (NOTE 11) | +| N | - | Y (NOTE 3) | "presentation allowed" | Header field not included or if included SIP URI with addr-spec of Unavailable User Identity (NOTE 11) | addr-spec derived from Generic Number (AcgPN) address signals or network provided value (NOTE 6) | Header field not included (NOTE 11) | +| N | - | Y (NOTE 3) | "presentation restricted" | Header field not included or if included SIP URI with addr-spec of Unavailable User Identity (NOTE 11) | SIP URI with addr-spec of Unavailable User Identity (NOTE 2) (NOTE 6) | Header field not included (NOTE 11) | +| | | | | | Derived from the Generic Number parameter address signals (see table 13) (NOTE 6) (NOTE 8) | priv-value =: "user" (See table 16). | +| Y | "presentation allowed" | N | - | Derived from Calling Party Number parameter address signals (See table 14) | Tel URI or SIP URI derived from Calling Party Number parameter address signals (See table 15) (NOTE 6) (NOTE 12) | Privacy header is not included or if included, "id" and "header" are not included (See table 16) | +| Y | "presentation allowed" | Y | "presentation allowed" | Derived from Calling Party Number parameter address signals (See table 14) | Derived from Generic Number (AcgPN) address signals (See table 13) (NOTE 6) | Privacy header is not included or if included, "id", "header" and "user" are not included (See table 16). | +| Y | "presentation allowed" | Y | "presentation restricted" | Derived from Calling Party Number parameter address signals (See table 14) | Tel URI or SIP URI derived from Calling Party Number parameter address signals (See table 15) (NOTE 6) (NOTE 9) | Privacy header is not included or if included, "id" and "header" are not included (See table 16). | +| | | | | | SIP URI with addr-spec of Anonymous URI (NOTE 6) (NOTE 7) (NOTE 10) | Privacy header is not included or if included, "id" and "header" are not included (See table 16). | + +| Has a Calling Party Number parameter with complete E.164 number, and with Screening Indicator = UPVP or NP (NOTE 1) been received? | Calling Party Number APRI | Has a Generic Number (AcgPN) with a complete E.164 number and with Screening Indicator = UPNV been received? | Generic Number APRI | P-Asserted-Identity header field | From header field | Privacy header field | +|------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------|--------------------------------------------------------------------------------------------------------------|---------------------------|----------------------------------------------------------------------------|--------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------| +| | | | | | Derived from the Generic Number parameter address signals (see table 13) (NOTE 6) (NOTE 8) | priv-value =: "user".
"id" and "header" are not included
(See table 16). | +| Y | "presentation restricted" | N | - | Derived from Calling Party Number parameter address signals (See table 14) | SIP URI with addr-spec of Unavailable User Identity (NOTE 2) (NOTE 6) (NOTE 12) | priv-value =: "id". (See table 16) | +| Y | "presentation restricted" | Y | "presentation allowed" | Derived from Calling Party Number parameter address signals (See table 14) | Derived from Generic Number (AcgPN) address signals (See table 13) (NOTE 6) | priv-value =: "id". | +| Y | "presentation restricted" | Y | "presentation restricted" | Derived from Calling Party Number parameter address signals (See table 14) | SIP URI with addr-spec of Anonymous URI (NOTE 6) (NOTE 7) (NOTE 10) | priv-value =: "id" | +| | | | | | Derived from the Generic Number parameter address signals (see table 13) (NOTE 6) (NOTE 8) | priv-value =: "id", "user".
(See table 16). | +| Y | "presentation restricted by network" (NOTE 4) | N | - | Header field not included. | Addr-spec is set to "unavailable@hostportion" (NOTE 5) (NOTE 6) (NOTE 12) | Privacy header is not included or if included, "id" and "header" are not included (See table 16) | +| Y | "presentation restricted by network" | Y | "presentation allowed" | Header field not included. | Derived from Generic Number (AcgPN) address signals (See table 13) (NOTE 6) | Privacy header is not included or if included, "id", "header" and "user" are not included (See table 16). | +| Y | "presentation restricted by network" | Y | "presentation restricted" | Header field not included. | Addr-spec is set to Anonymous URI (NOTE 6) (NOTE 7) | Privacy header is not included or if included, "id" and "header" are not included (See table 16). | + +| Has a Calling Party Number parameter with complete E.164 number, and with Screening Indicator = UPVP or NP (NOTE 1) been received? | Calling Party Number APRI | Has a Generic Number (AcgPN) with a complete E.164 number and with Screening Indicator = UPNV been received? | Generic Number APRI | P-Asserted-Identity header field | From header field | Privacy header field | +|------------------------------------------------------------------------------------------------------------------------------------|---------------------------|--------------------------------------------------------------------------------------------------------------|---------------------|----------------------------------|--------------------------------------------------------------------------------------------|--------------------------------------------------------------------------| +| | | | | | Derived from the Generic Number parameter address signals (see table 13) (NOTE 6) (NOTE 8) | priv-value =: "user". "id" and "header" are not included (See table 16). | + +NOTE 1: A Network Provided CLI in the CgPN parameter may occur on a call to IMS. Therefore in order to allow the "display" of this Network Provided CLI at a SIP UAS it shall be mapped into the SIP From header. It is also considered suitable to map into the P-Asserted-Identity header since in this context it is a fully authenticated CLI related exclusively to the calling line, and therefore as valid as a User Provided Verified and Passed CLI for this purpose. + +NOTE 2: The "From" header may contain an "Unavailable User Identity". An "Unavailable User Identity" includes information that does not point to the calling party and indicates that the caller's identity is unknown. The encoding of the "Unavailable User Identity" shall be as defined in 3GPP TS 23.003 [74]. + +NOTE 3: This combination of CgPN and AcgPN is an error case but is shown here to ensure consistent mapping across different implementations. + +NOTE 4: This is an ETSI specific value described within ETSI EN 300 356-1 [70]. + +NOTE 5: The setting of the hostportion is according to operator policy. + +NOTE 6: In accordance with IETF RFC 3261 [19] procedures, a tag shall be added to the "From" header. + +NOTE 7: The "From" header may contain an "Anonymous User Identity". An "Anonymous User Identity" includes information that does not point to the calling party and indicates that the caller has withheld their identity. The encoding of the "Anonymous User Identity" shall be as defined in 3GPP TS 23.003 [74]. + +NOTE 8: As a network option, the "From" header may be derived from the Generic Number parameter address signals (see table 13). This option is only recommended to use within a trusted domain where an entity such as a TAS is configured to be inserted into the call path that is able to change the "From" Header content to an anonymous user identity (NOTE 7). + +NOTE 9: As a network option, the "From" header may be derived from the Calling Party Number parameter address signals (see table 15). This option is only recommended to use within a trusted domain where an entity such as a TAS is configured to be inserted into the call path that is able to change the "From" Header content to an anonymous user identity (NOTE 7). + +NOTE 10: Network option. + +NOTE 11: As a network option, the P-Asserted-Identity header field may be included. The URI of the P-Asserted-Identity header field is "Unavailable User Identity" defined in 3GPP TS 23.003 [74]. When populating the P-Asserted-Identity header field containing the "Unavailable User Identity" into a SIP request, the MGCF may populate the Privacy header field set to "id" into the SIP request in order to avoid this identity to be displayed to user. + +NOTE 12: As a network option, for calls where a Generic Number (ACgPN) with the "Nature of Address Indicator" values "subscriber number" or "unknown" is received, the nature of address indicator and address signals may instead be mapped into the SIP From header field as specified in Table 13. + +**Table 13: Mapping of generic number (additional calling party number) to SIP From header field** + +| BICC/ISUP parameter / field | Value | SIP component | Value | +|-------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------|-----------------------------------------------------------------------------------------------------------------------------------| +| Generic Number
Number Qualifier
Indicator | " additional calling party number " | From header field | display-name (optional) and addr-spec | +| Nature of Address
Indicator | " national (significant) number " | Tel URI or SIP URI | Add CC (of the country where the MGCF is located) to GN address signals to construct E.164 number in URI. Prefix number with "+". | +| | " international number " | | Map complete GN address signals to E.164 number in URI. Prefix number with "+". | +| | " subscriber number " or " unknown " (NOTE 1) | | Map complete GN address signals. Add phone-context URI parameter (NOTE 2) | +| Address signal | if NOA is " national (significant) number " then the format of the address signals is:
NDC+ SN
If NOA is " international number " then the format of the address signals is:
CC + NDC + SN | Tel URI or SIP URI | | +| | If NOA is " subscriber number " (NOTE 1), then the format of the address signals is:
SN | | CC+NDC+SN as E.164 number in URI. Prefix number with "+". | +| | If NOA is " unknown " (NOTE 1), then the format of the address signals is determined by the operator. | | Map subscriber number as local number with a phone-context URI parameter (NOTE 2) | +| | | | Map address signals with a phone-context URI parameter (NOTE 2) | +| | | | | +| | If NOA is " subscriber number " (NOTE 1), then the format of the address signals is:
SN | | Map subscriber number as local number with a phone-context URI parameter (NOTE 2) | +| | If NOA is " unknown " (NOTE 1), then the format of the address signals is determined by the operator. | | Map address signals with a phone-context URI parameter (NOTE 2) | + +NOTE 1: The usage and the interworking of the "Nature of Address Indicator" values "subscriber number" and "unknown" is a national operator option. +NOTE 2: Mapping between "Nature of Address Indicator" values and phone-context values is provisioned in the MGCF. Setting the values of phone-context is dependent on local operator's policies. + +**Table 14: Mapping of calling party number parameter to SIP P-Asserted-Identity header fields** + +| BICC/ISUP Parameter / field | Value | SIP component | Value | +|------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------|-------------------------------------------------------------------------------------------------------------------------------------| +| Calling Party Number | | P-Asserted-Identity header field | addr-spec and optionally display-name (NOTE 1) | +| Nature of Address Indicator | " national (significant) number " | Tel URI or SIP URI (NOTE 2) | Add CC (of the country where the MGCF is located) to CgPN address signals to construct E.164 number in URI. Prefix number with "+". | +| | " international number " | | Map complete CgPN address signals to E.164 number in URI. Prefix number with "+". | +| Address signal | If NOA is " national (significant) number " then the format of the address signals is:
NDC + SN
If NOA is " international number " then the format of the address signals is:
CC + NDC + SN | Tel URI or SIP URI (NOTE 2) | CC+NDC+SN as E.164 number in URI. Prefix number with "+" | + +NOTE 1: The display-name may be mapped from the corresponding telephone number if possible and allowed by network operator policies. + +NOTE 2: A tel URI or a SIP URI with "user=phone" is used according to operator policy. + +**Table 15: Mapping of BICC/ISUP Calling Party Number parameter to SIP From header field** + +| BICC/ISUP parameter / field | Value | SIP component | Value | +|------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------|----------------------------------------------------------------------------------------------------------------------------------------------| +| Calling Party Number | | From header field | | +| Nature of Address Indicator | " national (significant) number " | Tel URI or SIP URI (NOTE) | Add CC (of the country where the MGCF is located) to CgPN address signals then map to construct E.164 number in URI. Prefix number with "+". | +| | " international number " | | Map complete CgPN address signals to construct E.164 number in URI. Prefix number with "+". | +| Address signal | If NOA is " national (significant) number " then the format of the address signals is:
NDC + SN
If NOA is " international number " then the format of the address signals is:
CC + NDC + SN | Tel URI or SIP URI (NOTE) | CC+NDC+SN as E.164 number in URI. Prefix number with "+". | + +NOTE: A tel URI or a SIP URI with "user=phone" is used according to operator policy. + +**Table 16: Mapping of BICC/ISUP APRIs into SIP Privacy header fields** + +| BICC/ISUP parameter / field | Value | SIP component | Value | +|-------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------|----------------------|----------------------------------------------------------------------------------------------------| +| Calling Party Number | | Privacy header field | priv-value | +| APRI | " presentation restricted " | Priv-value | "id"
("id" included only if the P-Asserted-Identity header is included in the SIP INVITE) | +| | " presentation allowed " or " presentation restricted by network " | Priv-value | omit Privacy header or Privacy header without "id" and "header" if other privacy service is needed | +| Generic Number (ACgPN) | | Privacy header field | priv-value | +| APRI (NOTE) | " presentation restricted " | Priv-value | "user" | +| | " presentation allowed " | Priv-value | omit Privacy header or Privacy header without "user" if other privacy service is needed | +| NOTE: Mapping of Generic Number APRI is only applicable, if the Generic Number is mapped to the "From" header field (see table 12). | | | | + +If, as a network option, the MGCF supports "Calling number verification using signature verification and attestation information" feature as described in IETF RFC 8224 [153] and 3GPP TS 24.229 [9], the MGCF shall: + +- include in the initial INVITE request: + - a) attestation level in the Attestation-Info header field defined in 3GPP TS 24.229 [9]; and + - b) the origination identifier in the Origination-Id header field defined in 3GPP TS 24.229 [9]; and +- if the MGCF performed mapping of Calling party number parameter to the P-Asserted-Identity header field as defined in table 14 and the MGCF received the Calling party number with the Screening indicator set to value "*user provided, verified and passed*": + - a) set the value of the Attestation-Info header field to "B" (Partial Attestation) as described in 3GPP TS 24.229 [9]; and + - b) use own address or identifier for creation of the Origination-Id header field as described in 3GPP TS 24.229 [9]; or +- otherwise, for all other mapping cases defined in table 12: + - a) set the value of the Attestation-Info header field to "C" (Gateway Attestation) as described in 3GPP TS 24.229 [9]; and + - b) use the received Circuit identification field (i.e. Circuit identification code) for creation of the Origination-Id header field as described in 3GPP TS 24.229 [9]. + +#### 7.2.3.2.2.3A "cpc" URI Parameter in P-Asserted-Identity Header + +See Annex C for normative interworking of a Calling party's category to a "cpc" URI parameter within P-Asserted-Identity header field. + +#### 7.2.3.2.2.3B "oli" URI Parameter in P-Asserted-Identity Header + +See Annex H for normative interworking of the "oli" URI parameter as a network option. + +#### 7.2.3.2.2.4 Max Forwards header + +If the Hop Counter procedure is supported in the CS network, the O-MGCF shall use the Hop Counter parameter to derive the Max-Forwards SIP header. Due to the different default values (that are based on network + +demands/provisions) of the SIP Max-Forwards header and the Hop Counter, an adaptation mechanism shall be used to adopt the Hop Counter to the Max Forwards at the O-MGCF. For example, the following guidelines could be applied. + +- a) Max-Forwards for a given message should be monotone decreasing with each successive visit to a SIP entity, regardless of intervening interworking, and similarly for Hop Counter. +- b) The initial and successively mapped values of Max-Forwards should be large enough to accommodate the maximum number of hops that may be expected of a validly routed call. + +The table 17 shows the principle of the mapping: + +**Table 17: Hop counter-Max forwards** + +| | | | | +|----------------------------------------------------------------------------------------------------|-----|--------------|------------------------------------| +| Hop Counter | = X | Max-Forwards | = Y = Integer part of (X * Factor) | +| NOTE: The Mapping of value X to Y should be done with the used (implemented) adaptation mechanism. | | | | + +The factor used to map from Hop Counter to Max-Forwards for a given call will depend on call origin, and will be provisioned at the O-MGCF based on network topology, trust domain rules, and bilateral agreement. + +The Principle of adaptation could be implemented on a basis of the network provision, trust domain rules and bilateral agreement. + +#### 7.2.3.2.2.5 IMS Communication Service Identifier + +For speech and video calls, the O-MGCF shall insert an IMS Communication Service Identifier, indicating the IMS Multimedia Telephony Communication Service. + +The IMS Communication Service Identifier for the IMS Multimedia Telephony Communication Service is defined in 3GPP TS 24.173 [88]. + +#### 7.2.3.2.2.6 P-Early-Media header field + +For a speech call the O-MGCF may include the P-Early-Media header field with the "supported" parameter as described in IETF RFC 5009 [89] in each outgoing INVITE request. + +NOTE: The P-Early-Media header with the "supported" parameter can be ignored by terminating devices when not supporting the procedures described in IETF RFC 5009 [89]. + +#### 7.2.3.2.2.7 PSTN XML elements + +If the O-MGCF supports the PSTN XML body as a network option, the O-MGCF shall map ISUP information into the XML body as shown in table 7.2.3.2.2.7.1 and 7.2.3.2.2.8.1. + +**Table 7.2.3.2.2.7.1: Mapping of ISUP Parameters with PSTN XML elements** + +| IAM | | INVITE | +|------------------------------|-------------------------------------------------|-------------------------------------------------| +| ISUP Parameter | Content | PSTN XML | +| Access Transport Parameter | High layer compatibility | HighLayerCompatibility (NOTE 1, NOTE 2, NOTE 3) | +| | Low layer compatibility | LowLayerCompatibility (NOTE 3) | +| User Service Information | | Bearer Capability (NOTE 3, NOTE 4) | +| User Teleservice Information | High layer compatibility | HighLayerCompatibility (NOTE 2, NOTE 3) | +| Called Party Number | Sending terminated signal (hexadecimal digit F) | sendingCompleteIndication | + +NOTE 1: If two high layer compatibility information elements are received in the ATP of the IAM, they shall be transferred in the same order as received into the PSTN XML body within the INVITE. + +NOTE 2: In the normal case, the High layer compatibility information in the ATP is equal to the High layer compatibility in the User Teleservice Information parameter. In the PSTN XML body, no two identical High layer compatibility information shall be present. If an HLC is available both in the ATP and in the User Teleservice information, the HLC from the ATP should be mapped. + +NOTE 3: The O-MGCF shall only map this information element if the O-MGCF offers media formats which can be transferred by the IM-MGW without transcoding and are derived from the incoming ISUP information according to table 10b. + +NOTE 4: See clause 7.2.3.2.1.5. + +#### 7.2.3.2.2.8 Progress indicator + +If the O-MGCF supports the PSTN XML body as a network option, the Forward call indicators parameter and an available "Progress indicator" element in the IAM shall be mapped into a ProgressIndicator in the PSTN XML body of the INVITE as shown in table 7.2.3.2.2.8. + +**Table 7.2.3.2.2.8: Coding of PSTN XML ProgressIndicator** + +| IAM→ | | | INVITE → | +|----------------------------------------------|----------------------------------------|--------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Forward call indicators parameter | | Access transport parameter | PSTN XML body with ProgressIndicator with "Progress Description" value No. (Value of PI) | +| ISDN User Part indicator | ISDN access indicator | | | +| 0
("ISDN User Part not used all the way") | Value non-significant | Value non-significant | No. 1 (NOTE 1) | +| 1
("ISDN User Part used all the way") | 0
("originating access non - ISDN") | Value non-significant | No. 3 (NOTE 1) | +| 1
("ISDN User Part used all the way") | 1
("originating access ISDN") | Progress indicator No. (Value of PI) | ProgressIndicator mapped from Progress indicator received in the ATP (NOTE 2) and additional ProgressIndicator with "Progress Description" value No.6 (NOTE 1, NOTE 3) | +| 1
("ISDN User Part used all the way") | 1
("originating access ISDN") | Not present | No. 6 (NOTE 1) | + +NOTE 1: The ProgressIndicator "Coding Standard" parameter shall be set to "00 (ITU-T standardized coding)". The default value for the ProgressIndicator "Location" parameter is "0011 (Transit Network)". + +NOTE 2: The entire Progress indicator, including the "Progress Description", "Coding Standard" and "Location" parameters shall be copied. + +NOTE 3: The order of ProgressIndicators within PSTN XML body is irrelevant. + +#### 7.2.3.2.2.9 P-Access-Network-Info + +If the IAM message includes a location number ISDN user part parameter, the O-MGCF shall include a P-Access-Network-Info header. The P-Access-Network-Info shall be populated as shown in table 7.2.3.2.2.9.1. + +**Table 7.2.3.2.2.9.1: Coding of the P-Access-Network-Info header fields** + +| BICC/ISUP parameter / field | SIP component | Value | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------|-------------------------------------| +| Location Number | access-type | "GSTN" | +| | gstn-location (NOTE) | value of Location Number, in quotes | +| NOTE: Alternatively, as a network option, the value of the Location Number can populate the operator-specific-GI parameter. In this case, the operator-specific-GI is set to the text string between quotes with the sequence of digits found in octet 3 to N (except the filler) starting with the 1 st digit. The access-info parameter is set to "operator-specific-GI" | | | + +**Table 7.2.3.2.2.9.2: Mapping ISUP Location Number to SIP P-Access-Network-Info** + +| IAM | INVITE | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------| +| Location Number | P-Access-Network-Info | +| Parameter name | not mapped | +| Parameter length | not mapped | +| Parameter content | gstn-location set to the hexadecimal representation of the ISUP parameter content, encoded as a text string between quotes | +| NOTE 1: As specified in ITU-T Q.763 [4], the parameter content includes both the header fields (octets 1 and 2) and the address signals. | | +| NOTE 2: The parameter content includes the address presentation restricted indicator. This field is not mapped to the Privacy header field. It is upon network operator responsibility to remove the P-Access-Network-Info header field when leaving the trust domain, as specified in 3GPP TS 24.229 [9]. | | +| NOTE 3: If the screening indicator is set to network provided, a "network-provided" parameter is added to the P-Access-Network-Info header field value. | | + +#### 7.2.3.2.2A Coding of the INVITE when Number Portability is supported + +This clause describes optional coding procedures when Number Portability is supported. + +##### 7.2.3.2.2A.1 Request-URI and To header field + +When Number Portability is supported, the method used for signalling of the Called Party E.164 address and the Number Portability Routing Number determines the parameters of the IAM message used to derive the Request-URI of the INVITE request. + +The number portability information (rn and npdi) shall not be mapped into the To header field. + +ITU-T Q.769.1 [92] describes three possible addressing methods for signalling of the Called Party E.164 address and Number Portability Routing Number (ITU-T Q.769.1 [92] uses the terms directory number and network routing number respectively). The choice of these methods is based on network operator and national requirements. + +The following clauses describe how the Request-URI and To header field are populated, based on these methods, when a Number Portability Routing Number is available in the IAM. + +When the optional Number Portability Routing Number is available and supported, these procedures take precedence over procedures for coding of the Request-URI and To header field described in clause 7.2.3.2.2.1. + +When a Number Portability Routing Number is not available, the Request-URI and To header field are populated as described in clause 7.2.3.2.2.1, with the following addition: If a Number Portability Forward Information parameter is present in the IAM, containing a value of "number portability query done for called number, non-ported called subscriber", a tel URI npdi parameter [93] is added. + +For the following clauses, the Request-URI is a tel URI or SIP URI with "user=phone" and shall contain an E.164 International public telecommunication number prefixed by a "+" sign (e.g. ). + +## 7.2.3.2.2A.1.1 Separate Directory Number Addressing Method + +**Table 17a: Mapping ISUP to SIP Request-URI and To header field with Number Portability Separate Directory Number Addressing Method** + +| IAM→ | | INVITE | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Called Party Number | Called Directory Number | Request-URI and To Header Field | +| Address Signal:
Nature of address indicator:
"Network routing number in national (significant) number format" or "National (significant) number" or "Network routing number in network specific number format" as described in ITU-T Q.769.1 [92]
(NOTE 2) | Address Signal:
Nature of address indicator:
"National (significant) number". | The "telephone-subscriber" is populated from the Called Directory Number as follows:
Insert "+CC" before the Address signals (NOTE 1)

The Tel URI rn= parameter is populated from the Called Party Number as follows:
Insert "+CC" before the Address signals (NOTE 1) and is added only to the Request-URI.

Use of the local form of the rn= parameter is out of the scope of the present specification.

Tel URI npdi parameter as defined in IETF RFC 4694 [93] is added only to the Request-URI. | + +NOTE 1: CC = Country Code of the network in which the O-MGCF is located. +NOTE 2: If the address signals received in the ISUP Called Party Number contain a sending terminated signal (hexadecimal digit F), then this shall be discarded or if the PSTN XML is supported then the sendingCompleteIndication shall be included. + +## 7.2.3.2.2A.1.2 Concatenated Addressing Method + +**Table 17b: Mapping ISUP to SIP Request-URI and To header field with Number Portability Concatenated Number Addressing Method** + +| IAM→ | | INVITE | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Called Party Number | | Request-URI and To Header Field | +| Address Signal:
Nature of address indicator:
"Network routing number concatenated with called directory number" or "National (significant) number" as described in ITU-T Q.769.1 [92]
(NOTE 2) | | The "telephone-subscriber" is populated from the Called Party Number as follows:
Remove the prefix representing the Number Portability Routing Number
or the prefix prior to the directory number (NOTE3).

Insert "+CC" before the Address signals (NOTE 1).

The Tel URI rn= parameter is populated from the Called Party Number as follows and is added only to the Request-URI:
Use all address digits contained within the Called Party Number or remove the digits that follow the prefix representing the Number Portability Routing Number

Insert "+CC" before the Address signals (NOTE 1)

Use of the local form of the rn= parameter is out of the scope of the present specification.

Tel URI npdi parameter as defined in IETF RFC 4694 [93] is added only to the Request-URI. | + +NOTE 1: CC = Country Code of the network in which the O-MGCF is located. +NOTE 2: If the address signals received in the ISUP Called Party Number contain a sending terminated signal (hexadecimal digit F), then this shall be discarded or if the PSTN XML is supported then the sendingCompleteIndication shall be included. +NOTE 3: Based on national policy the whole Number Portability Routing number includes the Called Party Number and a prefix. In such cases only the Prefix has to be removed. Normally the Nature of address indicator indicates if the Number Portability Routing Number contains a Called Party Number and a prefix. + +### 7.2.3.2.2A.1.3 Separate Network Routing Number Addressing Method + +**Table 17c: Mapping ISUP to SIP Request-URI and To header field with Number Portability Separate Network Routing Number Addressing Method** + +| IAM→ | | INVITE | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Network Routing Number | Called Party Number | Request-URI and To Header Field | +| Address Signal:
Nature of address indicator:
"Network routing number in national (significant) number format" or
"Network routing number in network specific number format" as described in ITU-T Q.769.1 [92]
(NOTE 2) | Address Signal:
Nature of address indicator:
"National (significant) number". | The "telephone-subscriber" is populated from the Called Party Number as follows:
Insert "+CC" before the Address signals (NOTE 1)

The Tel URI rn= parameter is populated from the Network Routing Number as follows and is added only to the Request-URI:
Insert "+CC" before the Address signals (NOTE 1)

Use of the local form of the rn= parameter is out of the scope of the present specification.

Tel URI npdi parameter as defined in IETF RFC 4694 [93] is added only to the Request-URI. | + +NOTE 1: CC = Country Code of the network in which the O-MGCF is located. +NOTE 2: If the address signals received in the ISUP Called Party Number contain a sending terminated signal (hexadecimal digit F), then this shall be discarded or if the PSTN XML is supported then the sendingCompleteIndication shall be included. + +### 7.2.3.2.2B Coding of the INVITE for Carrier Routeing + +This clause describes optional coding procedures for carrier-based routeing. + +#### 7.2.3.2.2B.1 Mapping of "cic" in Request-URI + +The procedures followed in clause 7.2.3.2.2.1 apply with the following addition. + +If the Transit Network Selection parameter, defined according to ITU-T Q.761 [4], is included in the IAM message the O-MGCF, based on network configuration, may send the transit network selection information to the SIP network. In such a case the "cic=" parameter as defined in IETF RFC 4694 [93] is included in the Request-URI and configured according to the table below. + +**Table 17d: Mapping of ISUP "Transit Network Selection" (TNS) to SIP "Carrier Identification Code" (CIC)** + +| ISUP parameter/field | Value | SIP Component | Value | +|---------------------------|--------|--------------------------------------------|--------------------------------------------------------| +| Transit Network Selection | Digits | Carrier id code in Userinfo of Request-URI | "cic=carrier ID code" as defined in IETF RFC 4694 [93] | + +#### 7.2.3.2.2B.2 Void + +### 7.2.3.2.2C Coding of INVITE with instance-id in form of IMEI URN + +An Emergency Access Transfer Function (EATF) that provides IMS-based mechanisms for enabling service continuity of IMS emergency sessions is described in 3GPP TS 23.237 [118]. A correlation of the call legs at the EATF is based on the equipment identifier. + +A Mobile Equipment Identifier (MEI) parameter of the Mobile Service Transport (MST) Application Transport Parameter is defined in 3GPP TS 29.205 [14]. + +An instance-id is a SIP Contact header field parameter defined in IETF RFC 5626 [119]. When an IMEI is available, the instance-id shall take the form of an International Mobile station Equipment Identity (IMEI) URN as specified in IETF RFC 7254 [120]. + +When an O-MGCF receives the Mobile Service Transport (MST) Application Transport Parameter containing the Mobile Equipment Identifier (MEI) parameter within the IAM the O-MGCF shall perform the mapping to the "+sip.instance" Contact header field parameter according to table 7.2.3.2.2C.1. + +**Table 7.2.3.2.2C.1: Mapping of ISUP/BICC to SIP** + +| IAM | | INVITE | | +|-------------------------------------|-------------------------------------|-----------------------------------------------------------------------------|------------------------------------------------------| +| ISUP Parameter | Value | SIP Component | Value | +| MST Application Transport Parameter | Mobile Equipment Identifier: IMEI | Contact header containing "+sip.instance" parameter in the form of IMEI URN | gmsa urn set to "imei" namespace
NOTE 1
NOTE 2 | +| | Mobile Equipment Identifier: IMEISV | | | + +NOTE 1: The gsma-specifier "imei" is generated as: +urn:gsma:imei:tac-snr-spare +where +"tac" represents 8 digits type allocation code (TAC), "snr" represents 4 digits serial number (SNR), and "spare" represents spare decimal digit as specified in TS 23.003 [74]. + +NOTE 2: The Software Version Number is not interworked and thus the "svn" parameter is not included within the gsma urn. + +#### 7.2.3.2.2.10 PSAP Call-back indication + +If the O-MGCF based on the operator policy has determined that the received IAM message is a for the purpose of a PSAP call-back, then the O-MGCF shall include in the initial INVITE request a Priority header field with a "psap-callback" header field value as specified in IETF RFC 7090 [139]. The operator policy decision may be based the PSAP call-back indication in the received IAM message and/or any other information made available at O-MGCF. + +NOTE: The PSAP call-back indication in the received IAM message depends on the national regulatory requirements applicable for the emergency services (e.g. calling party's category parameter indicating priority/emergency call, pre-defined prefix in front of the called party number) and is outside the scope of this specification. + +#### 7.2.3.2.2.11 History-Info header field (optional) + +See Annex L for the normative interworking of the History-Info header field into the called IN number and original called IN number parameters. + +### 7.2.3.2.3 Receipt of CONTINUITY + +This clause only applies if the O-MGCF has sent the INVITE request without waiting for an outstanding COT message (see clause 7.2.3.2.1). + +![Sequence diagram showing the receipt of COT (success) by the O-MGCF. A horizontal arrow labeled 'COT(success)' points to a vertical line representing the O-MGCF. From the O-MGCF line, another horizontal arrow points to the right, labeled 'SDP indicating pre-conditions met'.](e64106d52dee350a3439ff0d396d26fc_img.jpg) + +``` + +sequenceDiagram + participant External + participant O-MGCF + Note right of O-MGCF: O-MGCF + External->>O-MGCF: COT(success) + Note right of O-MGCF: SDP indicating pre-conditions met + O-MGCF-->>External: + +``` + +Sequence diagram showing the receipt of COT (success) by the O-MGCF. A horizontal arrow labeled 'COT(success)' points to a vertical line representing the O-MGCF. From the O-MGCF line, another horizontal arrow points to the right, labeled 'SDP indicating pre-conditions met'. + +**Figure 14a: Receipt of COT (success)** + +When the requested local preconditions (if any) have been met and if possible outstanding continuity procedures have successfully been completed (COT with the Continuity Indicators parameter set to "continuity check successful" is received), a SDP offer (e.g. a SIP UPDATE request, as defined in IETF RFC 3311 [55]) shall be sent for each early SIP + +dialogue for which the received provisional response indicated support of preconditions confirming that all the required local preconditions have been met. + +NOTE: This procedure applies regardless of whether the early SIP dialog existed prior to the preconditions being fulfilled or is subsequently created. + +#### 7.2.3.2.4 Sending of ACM and awaiting answer indication + +If the Address Complete Message (ACM) has not yet been sent, the following cases are possible trigger conditions that shall lead to the sending the address complete message (ACM): + +- the detection of end of address signalling by the expiry of Timer T i/w1 or, + +![Sequence diagram for Figure 15: Sending of ACM T i/w1 elapses. The diagram shows an O-MGCF entity. It receives IAM, then SAM, then another SAM. Brackets on the right indicate that Timer T i/w1 is running after each SAM. When the timer expires after the second SAM, an ACM (no indication) is sent to the left, and an INVITE is sent to the right.](61a49f3179b455e4d35242fc3d187a29_img.jpg) + +Sequence diagram for Figure 15: Sending of ACM T i/w1 elapses. The diagram shows an O-MGCF entity. It receives IAM, then SAM, then another SAM. Brackets on the right indicate that Timer T i/w1 is running after each SAM. When the timer expires after the second SAM, an ACM (no indication) is sent to the left, and an INVITE is sent to the right. + +**Figure 15: Sending of ACM T i/w1 elapses** + +- the reception of the first 180 Ringing. An O-MGCF initiates the sending of an awaiting answer indication only if according to IETF RFC 5009 [89] backward early media is not authorized (the most recently received P-Early-Media header field is received does not authorize the backward early media or the P-Early-Media header field has not yet been received). + +![Sequence diagram for Figure 16: Sending of ACM (Receipt of first 180 Ringing and backward early media is not authorized). The diagram shows an O-MGCF entity. It receives a 180 Ringing message from the right. In response, it sends an ACM (Subscriber Free) message to the left and a Ring tone (indicated by a dashed line) to the left.](0726a03ffb4e106eb90cd4f9283a6347_img.jpg) + +Sequence diagram for Figure 16: Sending of ACM (Receipt of first 180 Ringing and backward early media is not authorized). The diagram shows an O-MGCF entity. It receives a 180 Ringing message from the right. In response, it sends an ACM (Subscriber Free) message to the left and a Ring tone (indicated by a dashed line) to the left. + +**Figure 16: Sending of ACM (Receipt of first 180 Ringing and backward early media is not authorized)** + +Based on local knowledge that the call is transited to a PSTN network, the O-MGCF may decide not to generate the awaiting answer indication when receiving the 180 Ringing message and backward early media is not authorized according to IETF RFC 5009 [89]. + +![Sequence diagram for Figure 16a: Sending of ACM (Receipt of first 180 Ringing and backward early media is authorized). The diagram shows an O-MGCF entity. It receives a 180 Ringing message from the right that includes a P-Early-Media header indicating backward early media is authorized. In response, it sends an ACM (Subscriber Free) message to the left. A Ring tone (indicated by a dashed line) is shown being generated but not sent to the left.](2e787cedee89518fd6c63f3cce1f913c_img.jpg) + +Sequence diagram for Figure 16a: Sending of ACM (Receipt of first 180 Ringing and backward early media is authorized). The diagram shows an O-MGCF entity. It receives a 180 Ringing message from the right that includes a P-Early-Media header indicating backward early media is authorized. In response, it sends an ACM (Subscriber Free) message to the left. A Ring tone (indicated by a dashed line) is shown being generated but not sent to the left. + +**Figure 16a: Sending of ACM (Receipt of first 180 Ringing and backward early media is authorized)** + +- the reception of the first 181 Call is Being Forwarded. + +![Sequence diagram for Figure 16b showing the O-MGCF sending an ACM message with call diversion information after receiving a 181 Call is Being Forwarded message. No audio is sent.](61d000f6a2a1ff2f0da0b51fb732fafb_img.jpg) + +This sequence diagram illustrates the interaction at an O-MGCF. A vertical line represents the O-MGCF. An incoming message labeled "181 Call is Being Forwarded" is received from the right. In response, an outgoing message labeled "ACM (Call Diversion information)" is sent to the left. No audio path is established. + +Sequence diagram for Figure 16b showing the O-MGCF sending an ACM message with call diversion information after receiving a 181 Call is Being Forwarded message. No audio is sent. + +**Figure 16b: Sending of ACM (Receipt of first 181 Call is Being Forwarded and backward early media is not authorized)** + +![Sequence diagram for Figure 16c showing the O-MGCF sending an ACM message with call diversion and OBCI information after receiving a 181 Call is Being Forwarded message that authorizes early media. Audio is then sent.](97b3ed12d7f6c65cf3f7187326728409_img.jpg) + +This sequence diagram shows the O-MGCF receiving a "181 Call is Being Forwarded" message that includes a "P-Early-Media header: backward early media authorized". The O-MGCF responds with an "ACM (Call Diversion information, OBCI: in-band info available)" message. Following this, an "Audio" path is established, indicated by a dashed line extending to the left. + +Sequence diagram for Figure 16c showing the O-MGCF sending an ACM message with call diversion and OBCI information after receiving a 181 Call is Being Forwarded message that authorizes early media. Audio is then sent. + +**Figure 16c: Sending of ACM (Receipt of first 181 Call is Being Forwarded that includes authorization of early media)** + +- At an O-MGCF once all the following sub-conditions have been met: {1} the reception of the first 183 Session Progress that includes a P-Early-Media header field authorizing backward early media, and {2} SDP preconditions are not used, or applicable SDP preconditions have been met. + +![Sequence diagram for Figure 16d showing the O-MGCF sending an ACM message with no indication after receiving a 183 Session Progress message that authorizes early media. An appropriate announcement is then sent.](69733eeb3ef32197543f66f22a431771_img.jpg) + +This sequence diagram depicts the O-MGCF receiving an "183 Session Progress" message with a "P-Early-Media header: backward early media authorized". The O-MGCF sends back an "ACM (No indication, OBCI: in-band info available)" message. Subsequently, an "Appropriate announcement" is sent, indicated by a dashed line extending to the left. + +Sequence diagram for Figure 16d showing the O-MGCF sending an ACM message with no indication after receiving a 183 Session Progress message that authorizes early media. An appropriate announcement is then sent. + +**Figure 16d: Sending of ACM (Receipt of first 183 Session Progress that includes authorization of early media)** + +- As a network option, reception of 183 containing a SIP reason header with an Q.850 Cause Value. + +![Sequence diagram showing the sending of ACM (Alerting Call Message) in response to a 183 Session Progress message. The diagram features a vertical line for the O-MGCF. To the left of the line, 'ACM (No indication Cause=xxx)' is shown with an arrow pointing left. To the right of the line, '183 Session Progress (Reason(Cause=xxx))' is shown with an arrow pointing right towards the O-MGCF line.](0dfdff10c725fe9c332b07ade9d23a5e_img.jpg) + +Sequence diagram showing the sending of ACM (Alerting Call Message) in response to a 183 Session Progress message. The diagram features a vertical line for the O-MGCF. To the left of the line, 'ACM (No indication Cause=xxx)' is shown with an arrow pointing left. To the right of the line, '183 Session Progress (Reason(Cause=xxx))' is shown with an arrow pointing right towards the O-MGCF line. + +**Figure 16e: Sending of ACM (Receipt of 183 Session Progress containing SIP Reason header)** + +- Ti/w 2 expires after the initial INVITE is sent. + +![Sequence diagram showing the sending of ACM after Ti/w 2 expires. A vertical line represents the O-MGCF. An 'IAM' message is shown with an arrow pointing right towards the O-MGCF. An 'INVITE' message is shown with an arrow pointing right from the O-MGCF. A bracket labeled 'T i/w 2' spans the time between the INVITE and the ACM. The 'ACM (no indication)' message is shown with an arrow pointing left from the O-MGCF.](09036266c6dba47efb2613ceaebe2b19_img.jpg) + +Sequence diagram showing the sending of ACM after Ti/w 2 expires. A vertical line represents the O-MGCF. An 'IAM' message is shown with an arrow pointing right towards the O-MGCF. An 'INVITE' message is shown with an arrow pointing right from the O-MGCF. A bracket labeled 'T i/w 2' spans the time between the INVITE and the ACM. The 'ACM (no indication)' message is shown with an arrow pointing left from the O-MGCF. + +**Figure 17: Sending of ACM (Ti/w2 elapses)** + +The sending of an awaiting answer indication is described in clause 9.2.3.3. + +When a 180 (Ringing) response is received with the Alert-Info header field at an O-MGCF supporting capabilities associated with the Alert-Info header field an O-MGCF may instruct the IM-MGW to play out early media available at the associated URL to the PSTN leg of the communication. + +If the O-MGCF receives a 18x response with a P-Early-Media header field that changes the authorization of early media, the O-MGCF terminates the sending of the awaiting answer indication if the header field authorizes backward early media, and initiates the sending of the awaiting answer indication if the header field removes authorization of backward early media and if the O-MGCF has received the 180 Ringing response. + +### 7.2.3.2.5 Coding of the ACM + +#### 7.2.3.2.5.0 General + +The description of the following ISDN user part parameters can be found in ITU-T Recommendation Q.763 [4]. + +##### 7.2.3.2.5.1 Backward call indicators + +| | | | +|------|-----------|--------------------------------------------------------------| +| bits | AB | Charge indicator Contributors | +| | 1 0 | charge | +| bits | DC | Called party's status indicator | +| | 01 | subscriber free if the 180 Ringing has been received. | +| | 00 | no indication otherwise | +| bits | FE | Called party's category indicator | +| | 0 0 | no indication | +| bits | HG | End-to-end method indicator | +| | 0 0 | no end-to-end method available | +| bit | I | Interworking indicator | +| | 1 | interworking encountered | + +As a network operator option, the value I = 0 "no interworking encountered" is used for TMR = 64 kBit/s unrestricted + +NOTE: This avoids sending of a progress indicator with Progress information 0 0 0 0 0 0 1 "Call is not end-to-end ISDN; further call progress information may be available in-band", so the call will not be released for that reason by an ISDN terminal. + +bit J End-to-end information indicator +0 no end-to-end information available +bit K ISDN user part/BICC indicator +0 ISDN user part not used all the way + +As a network operator option, the value K = 1 "ISDN user part/BICC used all the way" is used for TMR = 64 kBit/s unrestricted + +NOTE: This avoids sending of a progress indicator with progress information 0 0 0 0 0 0 1 "Call is not end-to-end ISDN; further call progress information may be available in-band", so the call will not be released for that reason by an ISDN terminal. + +bit L Holding indicator (national use) +0 *holding not requested* +bit M ISDN access indicator +0 *terminating access non-ISDN* + +As a network operator option, the value M = 1 "terminating access ISDN" is used for TMR = 64 kBit/s unrestricted. + +NOTE: This avoids sending of a progress indicator with progress information 0 0 0 0 0 1 0 "Destination access is non-ISDN", so the call will not be released for that reason by an ISDN terminal. + +bit N Echo control device indicator +1 *incoming echo control device included*, for speech calls, e.g., TMR is "3.1KHz audio". +0 *incoming echo control device not included*, for known data calls, e.g., TMR "64 kBit/s unrestricted" or HLC "Facsimile Group 2/3". + +If the PSTN XML body is supported as a network option, the Backward Call indicators parameters derived as shown in table 7.2.3.2.5.1.1 shall take precedence over the above Backward Call indicators parameter setting. + +**Table 7.2.3.2.5.1.1: Derivation of Backward Call Indicators from PSTN XML body** + +| ←ACM | ← 180 Ringing or 183 Session Progress | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Backward call indicators parameter
Optional backward call indicators parameter | PSTN XML body with Progress indicator with "Coding Standard" value "00 (ITU-T standardized coding)" and with "Progress Description" No (Value of PI) | +| Backward call indicators parameter
ISDN User Part indicator
0 "ISDN User Part not used all the way" | No. 1
("Call is not end-to-end ISDN: further call progress information may be available in-band") | +| Backward call indicators parameter
ISDN User Part indicator
1 "ISDN User Part used all the way"
ISDN access indicator
0 "Terminating access non-ISDN" | No. 2
("Destination address is non-ISDN") | +| Backward call indicators parameter
Interworking indicator
0 "no interworking encountered"
ISDN User Part indicator
1 "ISDN User Part used all the way"
ISDN access indicator
1 "Terminating access ISDN" | No. 7
("Terminating user ISDN") | +| Optional backward call indicators parameter
In-band information indicator
1 "in-band information or an appropriate pattern is now available" | No. 8
("In-band information or an appropriate pattern is now available") | + +#### 7.2.3.2.5.2 Optional Backward call indicators + +Bit A 1 "in-band information or an appropriate pattern is now available" shall be set if 183 Session Progress or 181 Call is Being Forwarded response is received and according to IETF RFC 5009 [89] backward early media is authorized. + +**Table 7a0.4: Sending criteria of Optional backward call indicators parameter** + +| ←ACM | ← 183 Session Progress or 181 Call is Being Forwarded | +|------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------| +| Optional backward call indicators parameter
In-band information indicator
in-band information or an appropriate pattern is now available | P-Early-Media header authorizing backward early media | + +#### 7.2.3.2.5.3 Access Transport Parameter, Transmission medium used parameter + +If the O-MGCF supports the PSTN XML body as a network option and if a PSTN XML body is received within the 180 ringing or 183 session progress, the O-MGCF shall store the received PSTN XML elements, replacing any previously stored PSTN XML elements on that dialog. + +NOTE: Multiple 18x responses can be received, both within a single dialog and in multiple dialogs. The PSTN XML bodies are stored on a per-dialog basis to be mapped to the ATP/TMU parameters on receipt of the 200 OK (see clause 7.2.3.2.9.2). + +**Table 7.2.3.2.5.3.1: Void** + +#### 7.2.3.2.5.4 Progress indicator + +If the O-MGCF supports the PSTN XML body as a network option and receives it in the 180 or 183, the O-MGCF shall store a "ProgressIndicator" element from the PSTN XML body on a per dialog basis and shall additionally map it into a Progress Indicator in the ACM as shown in table 7.2.3.2.5.4.1. + +**Table 7.2.3.2.5.4.1: Handling of the progress indicator** + +| ←ACM | ←180/183 | +|-----------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Access transport parameter | PSTN XML body with Progress indicator with "Coding Standard" value "00 (ITU-T standardized coding)" and with "Progress Description" No. (Value of PI) | +| Progress indicator (NOTE) | Progress indicator No. 1 / 2 | +| Progress indicator (NOTE) | Progress indicator No. 8 | +| NOTE: The entire Progress Indicator, including the "Progress Description", "Coding Standard" and "Location" parameters shall be copied. | | + +**Table 7.2.3.2.5.4.2: Void** + +#### 7.2.3.2.5.5 Cause Value + +If the O-MGCF sends the ACM upon reception of a SIP 183 provisional response containing a SIP reason header with a Q.850 Cause value, the O-MGCF may include the received Cause value within the ACM as a network option. The mapping of the Cause Indicators parameter to the Reason header as shown in table 8a shall be applied. IETF RFC 6432 [115] describes the use of the Reason header field in responses. The Reason header field itself is described in IETF RFC 3326 [116]. + +If, as a network option, the O-MGCF supports the location header field parameter as described in IETF RFC 8606 [155], the O-MGCF shall derive the ISUP cause location from the location parameter in the SIP Reason header field as shown in table 8c (see subclause 7.2.3.1.7). + +### 7.2.3.2.6 Sending of the Call Progress message (CPG) + +#### 7.2.3.2.6.0 General + +If the Address Complete Message (ACM) has already been sent, the O-MGCF shall send the Call Progress message (CPG) in the following cases: + +- Upon receipt of the SIP 180 Ringing provisional response. An O-MGCF should initiate the sending of an awaiting answer indication only if according to IETF RFC 5009 [89] backward early media is not authorized (the most recently received P-Early-Media header field does not authorize the backward early media or the P-Early-Media header field has not yet been received). + +![Sequence diagram showing the O-MGCF receiving a 180 Ringing response and sending a CPG (Alerting) message. The diagram shows a vertical line for the O-MGCF. An arrow labeled '180 Ringing' points to the O-MGCF from the right. From the O-MGCF, an arrow labeled 'CPG (Alerting)' points to the left. Below the CPG (Alerting) arrow, a dashed arrow labeled 'Ring tone' also points to the left.](0943af69f1915094819054eb36d77807_img.jpg) + +``` + +sequenceDiagram + participant O-MGCF + Note right of O-MGCF: 180 Ringing + O-MGCF->>Left: CPG (Alerting) + Note left of O-MGCF: Ring tone + +``` + +Sequence diagram showing the O-MGCF receiving a 180 Ringing response and sending a CPG (Alerting) message. The diagram shows a vertical line for the O-MGCF. An arrow labeled '180 Ringing' points to the O-MGCF from the right. From the O-MGCF, an arrow labeled 'CPG (Alerting)' points to the left. Below the CPG (Alerting) arrow, a dashed arrow labeled 'Ring tone' also points to the left. + +**Figure 18: Sending of CPG(Alerting) (Receipt of 180 Ringing response and backward early media is not authorized)** + +![Sequence diagram for Figure 18a: Sending of CPG(Alerting) (Receipt of 180 Ringing response with authorization of early media).](e16bfa31d748f4d99ec4ae3d16656926_img.jpg) + +This sequence diagram illustrates the interaction between an O-MGCF and a CPG (Alerting) entity. The O-MGCF receives a '180 Ringing' response containing a 'P-Early-Media header: backward early media authorized'. In response, the O-MGCF sends a 'CPG (Alerting)' message to the CPG entity. The CPG entity then generates a 'Ring tone'. A dashed line at the bottom indicates the continuation of the sequence. + +Sequence diagram for Figure 18a: Sending of CPG(Alerting) (Receipt of 180 Ringing response with authorization of early media). + +**Figure 18a: Sending of CPG(Alerting) (Receipt of 180 Ringing response with authorization of early media)** + +Based on local knowledge that the call is transited to a PSTN network, the O-MGCF may decide not to generate the awaiting answer indication when receiving the 180 Ringing message and backward early media is not authorized according to IETF RFC 5009 [89]. + +- At an O-MGCF upon receipt of a 183 Session Progress that includes the first P-Early-Media header field authorizing backward early media. + +![Sequence diagram for Figure 18b: Sending of CPG(in-band information available).](e35f25e0b66752d4179a4cb108a3fb5a_img.jpg) + +This sequence diagram shows the O-MGCF receiving a '183 Session Progress' message with a 'P-Early-Media header: backward early media authorized'. The O-MGCF then sends a 'CPG (In-band information available)' message to the CPG entity. Following this, an 'Appropriate announcement' is generated. A dashed line at the bottom indicates the continuation of the sequence. + +Sequence diagram for Figure 18b: Sending of CPG(in-band information available). + +**Figure 18b: Sending of CPG(in-band information available)** + +- Upon receipt of the 181 Call is Being Forwarded provisional response. + +![Sequence diagram for Figure 18c: Sending of CPG(Progress).](ffefa4f6eab4ce450aa5ecd3d3fd70bb_img.jpg) + +This sequence diagram depicts the O-MGCF receiving a '181 Call is Being Forwarded' provisional response with a 'P-Early-Media header: backward early media authorized'. The O-MGCF sends a 'CPG (Progress, OBCI: in-band info available)' message to the CPG entity. Subsequently, 'Audio' is generated. A dashed line at the bottom indicates the continuation of the sequence. + +Sequence diagram for Figure 18c: Sending of CPG(Progress). + +**Figure 18c: Sending of CPG(Progress)** + +- As a network option, reception of 183 containing a SIP reason header with a Q.850 Cause Value. + +![Diagram showing the sending of CPG (Receipt of 183 Session Progress containing SIP Reason header) from O-MGCF to CPG (in-band information available Cause=xxx).](c0ca823603794512478906b302176bca_img.jpg) + +The diagram illustrates a message flow between two entities: O-MGCF and CPG (in-band information available Cause=xxx). A horizontal line represents the timeline. On the right, the O-MGCF sends a message labeled "183 Session Progress (Reason(Cause=xxx))". An arrow points from this message to the left, towards the CPG entity. The CPG entity is labeled "CPG (in-band information available Cause=xxx)". + +Diagram showing the sending of CPG (Receipt of 183 Session Progress containing SIP Reason header) from O-MGCF to CPG (in-band information available Cause=xxx). + +**Figure 18d: Sending of CPG (Receipt of 183 Session Progress containing SIP Reason header)** + +If the O-MGCF receives a 18x response with P-Early-Media header that changes the authorization of early media, the O-MGCF terminates the sending of the awaiting answer indication if the header authorizes backward early media and initiates the sending of the awaiting answer indication if the header removes authorization of backward early media and if the O-MGCF has received the 180 Ringing response. + +#### 7.2.3.2.6.1 Handling of the progress indicator + +If the O-MGCF supports the PSTN XML body as a network option and receives it in the 180 or 183, any "ProgressIndicator" element in the PSTN XML body shall be stored on a per-dialog basis as well as mapped as shown in tables 7.2.3.2.6.1.1 and 7.2.3.2.6.1.3. + +**Table 7.2.3.2.6.1.1: Mapping of progress indicator in PSTN XML body into ATP** + +| ←CPG | ←180/183 | +|-------------------------------------------|-----------------------------------------| +| Access transport parameter | PSTN XML body with Progress indicator X | +| Progress indicator (NOTE 1, NOTE 3) | Progress indicator No. 1 / 2 | +| Progress indicator (NOTE 2, NOTE 3) | Progress indicator No. 4 | +| Progress indicator No. 4 (NOTE 2, NOTE 4) | Progress indicator No. 7 | + +NOTE 1: Values 1 ("call is not end-to-end ISDN: further call progress information may be available in-band") or 2 ("destination address is non-ISDN") shall be sent if Value 4 ("Call has returned to the ISDN") has been sent since value 1 or 2 was previously sent or if no value 1 or 2 was previously sent. + +NOTE 2: Value 4 ("Call has returned to the ISDN") shall be sent if value 1 ("call is not end-to-end ISDN: further call progress information may be available in-band") or 2 ("destination address is non-ISDN") was sent previously and no value 4 has been signalled since. + +NOTE 3: The entire Progress Indicator, including the "Progress Description", "Coding Standard" and "Location" parameters shall be copied. + +NOTE 4: The Progress Indicator "Coding Standard" parameter shall be set to "00 (ITU-T standardized coding)". The default value for the Progress Indicator "Location" parameter is "0100 (Public Network serving remote user)". + +**Table 7.2.3.2.6.1.2: Void** + +**Table 7.2.3.2.6.1.3: Mapping of progress indicator in PSTN XML body into Event Indicator** + +| ←CPG | ←180/183 | +|---------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------| +| Event indicator | PSTN XML body with Progress indicator with "Coding Standard" value "00 (ITU-T standardized coding)" and with Progress Description" value No. X | +| "In-band information or appropriate pattern is now available" | No. 8
"In-band information or appropriate pattern is now available" | + +#### 7.2.3.2.7 Coding of the CPG + +##### 7.2.3.2.7.0 General + +The description of the following ISDN user part parameters can be found in ITU-T Recommendation Q.763 [4]. + +##### 7.2.3.2.7.1 Event information + +bits G-A Event indicator + +0 0 0 0 0 0 1 *alerting* if 180 Ringing response received + +0 0 0 0 0 1 0 *progress*, if 181 Call is Being Forwarded response received + +0 0 0 0 0 1 1 *in-band information or an appropriate pattern is now available*, if the received 183 Session Progress response and most recently received P-Early-Media header authorizes backward early media + +NOTE: In national networks other values of the Event indicator may be used. + +If the O-MGCF supports the PSTN XML body as a network option and receives in the 180 or 183 a "ProgressIndicator" element in the PSTN XML body with a "Coding Standard" value "00 (ITU-T standardized coding)" and with Progress Description" value No. 8, instead of the mapping above, the O-MGCF shall map this "Progress Indicator" into the "Event Indicator" within the CPG as shown in table 7.2.3.2.6.1.3. + +#### 7.2.3.2.7.2 Access Transport Parameter + +If the O-MGCF supports the PSTN XML body as a network option and if a PSTN XML body is received within the 180 ringing or 183 session progress, the O-MGCF shall store the contained information as described in clause 7.2.3.2.5.3, and additionally shall map this "Progress Indicator" into the ATP within the CPG as shown in table 7.2.3.2.6.1.1. + +NOTE: Multiple 18x responses can be received, both within a single dialog and in multiple dialogs. The PSTN XML bodies are stored on a per-dialog basis to be mapped to the ATP parameter on receipt of the 200 OK (see clause 7.2.3.2.9.2). + +#### 7.2.3.2.7.3 Void + +**Table 17h: Void** + +**Table 17j: Void** + +#### 7.2.3.2.7.4 Handling of Backward Call indicators + +The Backward Call indicator shall be derived as shown in clause 7.2.3.2.5.1. The Backward Call Indicators parameter is optional in the CPG message and shall only be included if any indicators have changed from those previously sent. + +#### 7.2.3.2.7.5 Optional Backward call indicators + +Bit A 1 "in-band information or an appropriate pattern is now available" shall be set if 181 Call is Being Forwarded response is received and according to IETF RFC 5009 [89] the backward early media is authorized. + +**Table 17k: Sending criteria of Optional backward call indicators parameter** + +| ←CPG | ← 181 Call is Being Forwarded | +|------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------| +| Optional backward call indicators parameter
In-band information indicator
in-band information or an appropriate pattern is now available | P-Early-Media header authorizing backward early media | + +#### 7.2.3.2.7.6 Cause Value + +If the O-MGCF sends the CPG upon reception of a SIP 183 provisional response containing a SIP reason header with a Q.850 Cause value, the O-MGCF may include the received Cause value within the ACM as a network option. The mapping of the Cause Indicators parameter to the Reason header as shown in table 8a shall be applied. IETF RFC 6432 [115] describes the use of the Reason header field in responses. The Reason header field itself is described in IETF RFC 3326 [116]. + +If, as a network option, the O-MGCF supports the location header field parameter as described in IETF RFC 8606 [155], the O-MGCF shall derive the ISUP cause location from the location parameter in the SIP Reason header field as shown in table 8c (see subclause 7.2.3.1.7). + +#### 7.2.3.2.7a Receipt of 200 OK(INVITE) + +Upon receipt of the first 200 OK (INVITE), the O-MGCF shall send an Answer Message (ANM) or Connect message (CON) as described in clauses 7.2.3.2.8 to 7.2.3.2.11. + +The O-MGCF shall not progress any further early dialogues to established dialogues. Therefore, upon the reception of a subsequent final 200 (OK) response for any further dialogue for an INVITE request (e.g., due to forking), the O-MGCF shall: + +- 1) acknowledge the response with an ACK request; and +- 2) send a BYE request to this dialog in order to terminate it. + +If the received 200 OK (INVITE) response contains a Feature-Caps header field, defined in IETF RFC 6809 [142] with a "+g.3gpp.ics" header field parameter as specified in clause B.4 of 3GPP TS 24.292 [141] then according to operator policy the O-MGCF may mark a call as an "ICS call". + +#### 7.2.3.2.7b Internal through connection of the bearer path + +The through connection procedure is described in clause 9.2.3.3.7. + +#### 7.2.3.2.8 Sending of the Answer Message (ANM) + +Upon receipt of the first 200 OK (INVITE), if the Address Complete Message (ACM) has already been sent, the O-MGCF shall send the Answer Message (ANM) to the preceding exchange. + +NOTE: Through connection and the stop of awaiting answer indication are described in clause 9.2.3.3 + +![Diagram illustrating the sending of the Answer Message (ANM) by the O-MGCF. A vertical line represents the O-MGCF. An arrow labeled '200 OK (INVITE)' points from the right towards the O-MGCF line. An arrow labeled 'ANM' points from the O-MGCF line towards the left.](8277ec2f29c84d97cbe70bc413a42cd1_img.jpg) + +``` +graph LR; subgraph O-MGCF; direction TB; ANM[ANM] --> Left[ ]; Right[ ] --> ANM; end; Right -- "200 OK (INVITE)" --> Right; ANM --> Left; +``` + +Diagram illustrating the sending of the Answer Message (ANM) by the O-MGCF. A vertical line represents the O-MGCF. An arrow labeled '200 OK (INVITE)' points from the right towards the O-MGCF line. An arrow labeled 'ANM' points from the O-MGCF line towards the left. + +**Figure 19: Sending of ANM** + +#### 7.2.3.2.9 Coding of the ANM + +##### 7.2.3.2.9.1 Backwards Call Indicators + +If Backwards Call Indicators are included in the ANM, then the coding of these parameters shall be as described in clause 7.2.3.2.5.1. The Backward Call Indicators parameter is optional in the ANM message and shall only be included if any indicators have changed from those previously sent. + +##### 7.2.3.2.9.2 Access Transport Parameter + +If the O-MGCF supports the PSTN XML body as a network option and if a PSTN XML body is received within the 200 OK(INVITE) or has been previously stored from a 18x message, the O-MGCF shall map the most recently received information for the established dialog (i.e. the dialog for which the first 200 OK has been received) into the ANM as shown in table 7.2.3.2.9.2.1 except Progress Indicator value No. 3 or No. 8. + +**Table 7.2.3.2.9.2.1: Mapping of PSTN XML elements into ISUP Parameters** + +| ANM | | 200 OK / stored information from previous 18x | +|----------------------------|-------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------| +| ISUP Parameter | Content | PSTN XML (NOTE 9) | +| Access Transport Parameter | Progress indicator (NOTE 5, NOTE 8) | ProgressIndicator with "Coding Standard" value "00 (ITU-T standardized coding)" and with "Progress Description" value No. 1 / 2 | +| | Progress indicator with "Progress Description" value No. 4 (NOTE 4, NOTE 6, NOTE 9) | ProgressIndicator with "Coding Standard" value "00 (ITU-T standardized coding)" and with "Progress Description" value No. 7 | +| | Progress indicator (NOTE 6, NOTE 8) | ProgressIndicator with "Coding Standard" value "00 (ITU-T standardized coding)" and with "Progress Description" value No. 4 | +| | Progress indicator (NOTE 7, NOTE 8) | ProgressIndicator with "Coding Standard" value "00 (ITU-T standardized coding)" and with "Progress Description" value No. 5 | +| | High layer compatibility (NOTE 1) | HighLayerCompatibility | +| | Bearer Capability | BearerCapability (NOTE 2) | +| | Bearer Capability ("UDI-TA") | BearerCapability ("UDI-TA") (NOTE 3) | + +NOTE 1: This information element shall only be mapped if the O-MGCF transfers media types listed in table 10b without transcoding. + +NOTE 2: Applicable if the O-MGCF has not propagated UDI fallback signalling according to clause 7.2.3.2.1.5. + +NOTE 3: Applicable if the O-MGCF has propagated UDI fallback signalling according to clause 7.2.3.2.1.5. Only the value "UDI-TA" within the PSTN XML BC shall be mapped. Other values within the PSTN XML BC are mapped to TMU as described in clause 7.2.3.2.9.3. + +NOTE 4: ProgressIndicator No. 7 is not mapped into the ISUP ATP. However, it may be mapped into PI=4. + +NOTE 5: Values 1 ("call is not end-to-end ISDN: further call progress information may be available in-band") or 2 ("destination address is non-ISDN") shall be sent if Value 4 ("Call has returned to the ISDN") has been sent since value 1 or 2 was previously sent or if no value 1 or 2 was previously sent. + +NOTE 6: Value 4 ("Call has returned to the ISDN") shall be sent if value 1 ("call is not end-to-end ISDN: further call progress information may be available in-band") or 2 ("destination address is non-ISDN") was sent previously and no value 4 has been signalled since. + +NOTE 7: This value indicates a bearer service change and is present with an associated BearerCapability and indicates that fallback has occurred (i.e. TMR and TMR Prime present in IAM and the destination ISDN user has accepted the BearerCapability equating to TMR Prime). + +NOTE 8: The entire Progress Indicator, including the "Progress Description", "Coding Standard" and "Location" parameters shall be copied. + +NOTE 9: The Progress Indicator "Coding Standard" parameter shall be set to "00 (ITU-T standardized coding)". The default value for the Progress Indicator "Location" parameter is "0100 (Public Network serving remote user)". + +### 7.2.3.2.9.3 Transmission Medium Used parameter (TMU) + +The procedures in the present clause shall only apply if the O-MGCF supports the PSTN XML body, and has propagated UDI-TA fallback signalling according to clause 7.2.3.2.1.5. + +If a Bearer Capability element within a PSTN XML body is received within the first 200 OK(INVITE) or has been previously stored from a 18x message relating to the now established dialog (i.e. the dialogue for which the first 200 OK has been received), the O-MGCF shall map the most recently received information (if any) into a TMU within the ANM as shown in table 7.2.3.2.9.3.1. If the most recently received PSTN XML BearerCapability is "UDI-TA", it shall be mapped into an ISUP Access Transport Parameter Bearer Capability (see clause 7.2.3.2.9.2). + +NOTE: The TMU is only included if both the TMR and TMR Prime were received in the ISUP IAM and fallback has occurred. + +**Table 7.2.3.2.9.3.1 - Mapping to TMU parameter** + +| ANM | 200 OK / stored information from previous 18x | +|----------------------------------------|-----------------------------------------------| +| TMU | PSTN XML BearerCapability | +| TMU = "Speech" | PSTN XML BearerCapability = "Speech" | +| TMU= "3.1 kHz audio" | PSTN XML BearerCapability = "3.1 kHz audio" | +| No mapping (fallback has not occurred) | PSTN XML BearerCapability = "UDI-TA" | +| TMU = "3.1 kHz audio" | PSTN XML BearerCapability not present | + +### 7.2.3.2.10 Sending of the Connect message (CON) + +Upon receipt of the first 200 OK (INVITE), if the Address Complete Message (ACM) has not yet been sent, the O-MGCF shall send the Connect message (CON) to the preceding exchange. + +![Diagram showing the O-MGCF sending a CON message after receiving a 200 OK (INVITE).](6ba310120ebcd99661c4ee1c58a1586c_img.jpg) + +The diagram illustrates the sequence of messages for sending a Connect message (CON). A vertical line represents the O-MGCF. An arrow labeled "200 OK (INVITE)" points from the right towards the O-MGCF line. From the O-MGCF line, an arrow labeled "CON" points to the left. + +Diagram showing the O-MGCF sending a CON message after receiving a 200 OK (INVITE). + +**Figure 20: Sending of CON** + +### 7.2.3.2.11 Coding of the CON + +#### 7.2.3.2.11.0 General + +The description of the following ISDN user part parameters can be found in ITU-T Recommendation Q.763 [4]. + +#### 7.2.3.2.11.1 Backward call indicators + +The Called Party's status indicator (Bit DC) of BCI parameter shall be set to "no indication". The other BCI indicators shall be set as described in clause 7.2.3.2.5.1 + +#### 7.2.3.2.11.2 Access Transport Parameter + +The O-MGCF shall apply the same procedure as described for the ANM in clause 7.2.3.2.9.2. + +#### 7.2.3.2.11.3 Transmission medium used parameter + +The O-MGCF shall apply the same procedure as described for the ANM in clause 7.2.3.2.9.3. + +### 7.2.3.2.11A Receipt of a reINVITE request + +When a reINVITE request is received from the network containing a Call-Info header field the MGCF may instruct the IM-MGW to send media available at the associated URL to the PSTN leg of the communication. + +### 7.2.3.2.12 Receipt of Status Codes 4xx, 5xx or 6xx + +![Diagram showing the O-MGCF receiving a Status Code (4xx, 5xx or 6xx) and sending a REL message.](a8f498be9c286684f48a3eb211ce4cea_img.jpg) + +The diagram illustrates the sequence of messages for receiving status codes. A vertical line represents the O-MGCF. A box on the right contains the text "Status Code 4xx, 5xx or 6xx". An arrow points from this box to the O-MGCF line. From the O-MGCF line, an arrow labeled "REL" points to the left. + +Diagram showing the O-MGCF receiving a Status Code (4xx, 5xx or 6xx) and sending a REL message. + +**Figure 21: Receipt of Status codes 4xx, 5xx or 6xx** + +If a Reason header as described in IETF RFC 6432 [115] is included in a 4xx, 5xx, 6xx response, then the Cause Value of the Reason header shall be mapped to the ISUP Cause Value field in the ISUP REL message. The Reason header field itself is described in IETF RFC 3326 [116]. The mapping of the Reason header to the Cause Indicators parameter is shown in table 8a (see clause 7.2.3.1.7). Otherwise coding of the Cause value field in the REL message is derived + +from the SIP Status code received according to table 18. The Cause Indicators Parameter Values are defined in ITU-T Recommendation Q.850 [38]. + +If, as a network option, the O-MGCF supports the location header field parameter as described in IETF RFC 8606 [155], the O-MGCF shall derive the ISUP cause location from the location parameter in the SIP Reason header field as shown in table 8c (see subclause 7.2.3.1.7). + +In all cases where SIP itself specifies additional SIP side behaviour related to the receipt of a particular INVITE response these procedures should be followed in preference to the immediate sending of a REL message to BICC/ISUP. + +If there are no SIP side procedures associated with this response, the REL shall be sent immediately. + +**NOTE** Depending upon the SIP side procedures applied at the O-MGCF it is possible that receipt of certain 4xx/5xx/6xx responses to an INVITE may in some cases not result in any REL message being sent to the BICC/ISUP network. For example, if a 401 Unauthorized response is received and the O-MGCF successfully initiates a new INVITE containing the correct credentials, the call will proceed. + +When the O-MGCF receives a 415 Unsupported Media Type response, as a result from a multipart MIME body in an initial INVITE request not being accepted, and when the handling of all the MIME bodies in the initial INVITE request except for the SDP MIME body are optional (Content-Disposition header parameter "handling" is set to optional), the O-MGCF shall send an ACK request and send a new initial INVITE request with SDP as only MIME body in accordance with clause 8.1.3.5 of IETF RFC 3261 [19]. + +**Table 18: 4xx/5xx/6xx Received on SIP side of O-MGCF** + +| ←REL (cause value) | ←4xx/5xx/6xx SIP Message | +|-----------------------------------------------------------------------------|--------------------------------------| +| Cause value No 111 (Protocol error, unspecified) | 400 Bad Request | +| Cause value No 127 (Interworking, unspecified) | 401 Unauthorized | +| Cause value No 127 (Interworking, unspecified) | 402 Payment Required | +| Cause value No 79 (Service or option not implemented, unspecified) | 403 Forbidden | +| Cause value No 1 (Unallocated (unassigned) number) | 404 Not Found | +| Cause value No 127 (Interworking, unspecified) | 405 Method Not Allowed | +| Cause value No 127 (Interworking, unspecified) | 406 Not Acceptable | +| Cause value No 127 (Interworking, unspecified) | 407 Proxy authentication required | +| Cause value No 102 (Recovery on timer expiry) | 408 Request Timeout | +| Cause value No 22 (Number changed) | 410 Gone | +| Cause value No 127 (Interworking, unspecified) | 413 Request Entity too long | +| Cause value No 111 (Protocol error, unspecified) | 414 Request-URI too long | +| Cause value No 127 (Interworking, unspecified) | 415 Unsupported Media type | +| Cause value No 111 (Protocol error, unspecified) | 416 Unsupported URI scheme | +| Cause value No 79 (Service or option not implemented, unspecified) | 417 Unknown Resource-Priority | +| Cause value No 111 (Protocol error, unspecified) | 420 Bad Extension | +| Cause value No 111 (Protocol error, unspecified) | 421 Extension required | +| Cause value No 31 (Normal, unspecified) | 422 Session Interval Too Small | +| Cause value No 127 (Interworking, unspecified) | 423 Interval Too Brief | +| Cause value No 127 (Interworking, unspecified) | 428 Use Identity Header (NOTE 5) | +| Cause value No 24 (Call rejected due to feature at the destination) | 433 Anonymity Disallowed (NOTE 1) | +| Cause value No 127 (Interworking, unspecified) | 436 Bad Identity Info (NOTE 5) | +| Cause value No 127 (Interworking, unspecified) | 437 Unsupported Credential (NOTE 5) | +| Cause value No 127 (Interworking, unspecified) | 438 Invalid Identity Header (NOTE 5) | +| Cause value No 127 (Interworking, unspecified) | 440 Max-Breadth Exceeded | +| Cause value No 20 (Subscriber absent) | 480 Temporarily Unavailable | +| Cause value No 127 (Interworking, unspecified) | 481 Call/Transaction does not exist | +| Cause value No 127 (Interworking, unspecified) | 482 Loop detected | +| Cause value No 25 (Exchange routing error) | 483 Too many hops | +| Cause value No 28 (Invalid number format (address incomplete)) | 484 Address Incomplete | +| Cause value No 1 (Unallocated (unassigned) number) | 485 Ambiguous | +| Cause value No 17 (User busy) | 486 Busy Here | +| Cause value No 127 (Interworking, unspecified) or not interworked. (NOTE 2) | 487 Request terminated | +| Cause value No 50 (Requested facility not subscribed) | 488 Not acceptable here | +| Cause value No 127 (Interworking, unspecified) | 493 Undecipherable | +| Cause value No 127 (Interworking, unspecified) | 500 Server Internal error | +| Cause value No 79 (Service or option not implemented, unspecified) | 501 Not implemented | +| Cause value No 27 (Destination out of order) | 502 Bad Gateway | +| Cause value No 41 (Temporary failure) | 503 Service Unavailable | +| Cause value No 102 (Recovery on timer expiry) | 504 Server timeout | +| Cause value No 127 (Interworking, unspecified) | 505 Version not supported | +| Cause value No 95 (Invalid message, unspecified) | 513 Message too large | +| Cause value No 127 (Interworking, unspecified) | 580 Precondition failure | +| Cause value No 17 (User busy) | 600 Busy Everywhere | +| Cause value No 21 (Call rejected) | 603 Decline | +| Cause value No 2 (No route to specified transit network) | 604 Does not exist anywhere | +| Cause value No 88 (Incompatible destination) | 606 Not Acceptable | +| Cause value No 21 (Call rejected) | 607 Unwanted (NOTE 4) | + +NOTE 1: Anonymity Disallowed, IETF RFC 5079 [77] refers. +NOTE 2: No interworking if the O-MGCF previously issued a CANCEL request for the INVITE. +NOTE 3: The 4xx/5xx/6xx SIP responses that are not covered in this table are not interworked. +NOTE 4: The "607 Unwanted" SIP response code is defined in IETF RFC 8197 [154]. +NOTE 5: The 428, 436, 437 and 438 SIP response codes are defined in IETF RFC 8224 [153]. + +If the O-MGCF supports the PSTN XML body as a network option and if a PSTN XML body is received within the 4xx/5xx/6xx, the O-MGCF shall map the contained information into the Access Transport Parameter of the REL as shown in clause 7.2.3.2.9.2. + +When a 4xx, 5xx or 6xx SIP response to an INVITE request is received from the network containing an Error-Info header field, the O-MGCF, supporting the capabilities associated with the Error-Info header field, may instruct the IM-MGW to play out media available at the associated URL towards PSTN. + +#### 7.2.3.2.12.1 Special handling of 404 Not Found and 484 Address Incomplete responses after sending of INVITE without determining the end of address signalling + +This clause is only applicable when the network option of Sending of INVITE without determining the end of address signalling is being used (see clause 7.2.3.2.1.a). + +On receipt of a 404 Not Found or 484 Address Incomplete response while Ti/w2 is running, the O-MGCF shall start timer Ti/w3, if there are no other pending INVITE transactions for the corresponding call. + +At the receipt of a SAM, a SIP 1xx provisional response or a SIP 200 OK (INVITE), the O-MGCF shall stop Ti/w2 and Ti/w3. + +The O-MGCF shall send a REL message with Cause Value 28 towards the BICC/ISUP network if Ti/w3 expires. + +#### 7.2.3.2.13 Receipt of a BYE + +![Diagram illustrating the receipt of a BYE method. A vertical line represents the O-MGCF. An arrow labeled 'BYE' points from the right towards the O-MGCF. An arrow labeled 'REL' points from the O-MGCF towards the left.](c686c005fef31702c109f5d9dd975413_img.jpg) + +``` + +graph LR + subgraph O-MGCF + direction TB + BYE[BYE] --> REL[REL] + end + O-MGCF -- REL --> Left[ ] + Right[ ] -- BYE --> O-MGCF + style Left fill:none,stroke:none + style Right fill:none,stroke:none + +``` + +Diagram illustrating the receipt of a BYE method. A vertical line represents the O-MGCF. An arrow labeled 'BYE' points from the right towards the O-MGCF. An arrow labeled 'REL' points from the O-MGCF towards the left. + +**Figure 22: Receipt of BYE method** + +If a Reason header field with Q.850 Cause Value is included in the BYE request, then the Cause Value shall be mapped to the ISUP Cause Value field in the ISUP REL as shown in table 8a (see clause 7.2.3.1.7). Otherwise, the O-MGCF sends a REL message with Cause Code value 16 (Normal Call Clearing). + +If, as a network option, the O-MGCF supports the location header field parameter as described in IETF RFC 8606 [155], the O-MGCF shall derive the ISUP cause location from the location parameter in the SIP Reason header field as shown in table 8c (see subclause 7.2.3.1.7). + +If the O-MGCF supports the PSTN XML body as a network option and if a PSTN XML body is received within the BYE, the O-MGCF shall map the contained information into the Access Transport Parameter of the REL as shown in clause 7.2.3.2.9.2. + +If a Reason header field with SIP status code "607 (Unwanted)" (defined in IETF RFC 8197 [154]) is included in the BYE request, then the O-MGCF shall send a REL message with the Cause Code value "21 (Call rejected)". + +#### 7.2.3.2.14 Receipt of the Release Message + +In the case that the REL message is received and a final response (i.e. 200 OK (INVITE)) has already been received the O-MGCF shall send a BYE request. If the final response (i.e. 200 OK (INVITE)) has not already been received the O-MGCF shall send a CANCEL method. + +A Reason header field containing the received (Q.850) Cause Value of the REL message shall be added to the CANCEL or BYE request. The mapping of the Cause Indicators parameter to the Reason header is shown in table 9a (see clause 7.2.3.1.8). + +If the O-MGCF supports the PSTN XML body as a network option, the O-MGCF shall map the contained information into a PSTN XML body within the BYE or CANCEL as shown in table 9aa. + +#### 7.2.3.2.15 Receipt of RSC, GRS or CGB (H/W oriented) + +Upon receipt of a RSC, GRS or CGB (H/W oriented) message the following applies independently for each affected circuit: + +NOTE: For the RSC message, the circuit identified by the CIC is affected. + For the GRS message, the affected circuits are identified by the CIC and the Range subfield of the Range and Status parameter. + For the CGB message, the affected circuits are identified by the CIC and the Range and Status parameter. + +If a final response (i.e. 200 OK (INVITE)) has already been received, the O-MGCF shall send a BYE method. If a final response (i.e. 200 OK (INVITE)) has not already been received, the O-MGCF shall send a CANCEL method. + +A Reason header field containing the (Q.850) Cause Value of the REL message generated by the ISUP procedures shall be added to the SIP message (BYE or CANCEL request) to be sent by the SIP side of the O-MGCF. + +#### 7.2.3.2.16 Autonomous Release at O-MGCF + +If the O-MGCF determines due to internal procedures that the call shall be released then the MGCF shall send + +- A BYE method if the ACK has been sent. +- A CANCEL method before 200 OK (INVITE) has been received. + +NOTE: The MGCF shall send the ACK method before it sends the BYE, if 200 OK (INVITE) is received. + +A Reason header field containing the (Q.850) Cause Value of the REL message sent by the O-IWU shall be added to the SIP Message (BYE or CANCEL request) to be sent by the SIP side of the O-IWU. + +**Table 18a: Autonomous Release at O-MGCF** + +| REL REL symbol
Cause parameter | Trigger event | SIP symbol SIP | +|---------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------| +| As determined by BICC/ISUP procedure. | COT received with the Continuity Indicators parameter set to " continuity check failed " (ISUP only) or the BICC/ISUP timer T8 expires. | CANCEL or BYE according to the rules described in this subclause. | +| REL with cause value 47 (resource unavailable, unspecified). | Internal resource reservation unsuccessful | As determined by SIP procedure | +| As determined by BICC/ISUP procedure. | BICC/ISUP procedures result in generation of autonomous REL on BICC/ISUP side. | CANCEL or BYE according to the rules described in this subclause. | +| Depending on the SIP release reason. | SIP procedures result in a decision to release the call. | As determined by SIP procedure. | + +#### 7.2.3.2.17 Special handling of 580 precondition failure received in response to either an INVITE or UPDATE + +A 580 Precondition failure response may be received as a response either to an INVITE or to an UPDATE request. + +##### 7.2.3.2.17.1 580 Precondition failure response to an INVITE + +Release with cause code as indicated in table 18 is sent immediately to the BICC/ISUP network. + +##### 7.2.3.2.17.2 580 Precondition failure response to an UPDATE within an early dialog + +A BYE request is sent for the early dialog within which the UPDATE was sent. + +If all the early dialogs that were generated from the INVITE request have answered the respective UPDATE request with 580 Precondition failure response then the O-MGCF shall send the Release message with Cause Code '127 Interworking' to the ISUP network. + +### 7.2.3.2.18 Sending of CANCEL + +![Diagram showing the receipt of a COT (failure) message by the O-MGCF and the subsequent sending of a CANCEL message.](a66383962afcd0f0458f0d45c101fabf_img.jpg) + +The diagram illustrates the O-MGCF's response to a failure. A horizontal arrow labeled "COT (failure)" points from the left towards a vertical line representing the O-MGCF. From the O-MGCF, a horizontal arrow labeled "CANCEL" points to the right. + +Diagram showing the receipt of a COT (failure) message by the O-MGCF and the subsequent sending of a CANCEL message. + +**Figure 23: Receipt of COT (failure)** + +CANCEL shall be sent if the Continuity message is received with the Continuity Indicators parameter set to "*continuity check failed*" or the ISUP (or BICC) timer T8 expires. + +A Reason header field containing the (Q.850) Cause Value 41 Temporary Failure shall be added to the CANCEL request to be sent by the SIP side of the O-MGCF. + +### 7.2.3.2.19 Receipt of SIP redirect (3xx) response + +![Diagram showing the receipt of a SIP response code 3xx by the O-MGCF and the subsequent sending of a REL (Cause value 127) message.](19499072f755b22d0a231123f75fa477_img.jpg) + +The diagram illustrates the O-MGCF's response to a SIP redirect. A horizontal arrow points from a box labeled "SIP response code 3xx" towards a vertical line representing the O-MGCF. From the O-MGCF, a horizontal arrow labeled "REL (Cause value 127)" points to the left. + +Diagram showing the receipt of a SIP response code 3xx by the O-MGCF and the subsequent sending of a REL (Cause value 127) message. + +**Figure 24: Receipt of SIP response code 3xx** + +When receiving a SIP response with a response code 3xx, the default behaviour of the O-MGCF is to release the call with a cause code value 127 (Interworking unspecified). + +NOTE: The O-MGCF may also decide for example to redirect the call towards the URIs in the Contact header field of the response as an operator option, but such handling is outside of the scope of the present document. + +### 7.2.3.2.20 Sending of INFO for overlap signalling using the in-dialog method + +#### 7.2.3.2.20.1 General + +SIP INFO request ("legacy" mode of usage of the INFO method as defined in IETF RFC 6086 [133]) is used to carry additional digits when overlap signalling is sent using the in-dialog method as described in clause 7.2.3.2.1a.2, which is a network option. Clause 7.2.3.2.1a.2 also describes when the O-MGCF sends a SIP INFO request. + +#### 7.2.3.2.20.2 Encoding of the INFO + +Table 18b provides a summary of how the header fields within the outgoing INFO messages are populated when in-dialog SIP INFO requests are used for overlap dialling. + +**Table 18b: Interworked contents of the INFO message** + +| SAM→ | INFO→ | +|--------|-----------------------------------| +| Digits | See TS 24.229 [9] clause 7.12.1.2 | + +### 7.2.3.3 Timers + +**Table 19: Timers for interworking** + +| Symbol | Time-out value | Cause for initiation | Normal termination | At expiry | Reference | +|--------|---------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------|-----------------------------------------| +| Ti/w1 | 4 s to 6 s
(default of 4 s) | When last address message is received and the minimum number of digits required for routing the call have been received. | At the receipt of fresh address information. | Send INVITE, send the address complete message | 7.2.3.2.1
7.2.3.2.4
(NOTE 1) | +| Ti/w2 | 4 s to 20 s
(default of 4 s) | When INVITE is sent unless the ACM has already been sent. | On reception of 180 Ringing , or 183 Session Progress and P-Early-Media header authorizing backward early media, or 181 Call is Being Forwarded, or 404 Not Found or 484 Address Incomplete for an INVITE transaction for which Ti/w3 is running, or 200 OK (INVITE). | Send ACM (no indication) | 7.2.3.2.4
7.2.3.2.1
(NOTE 2) | +| Ti/w3 | 4-6 seconds
(default of 4 seconds) | On receipt of 404 Not Found or 484 Address Incomplete if there are no other pending INVITE transactions for the corresponding call. | At the receipt of SAM | Send REL with Cause Value 28 to the BICC/ISUP side. | 7.2.3.2.1A,
7.2.3.2.12.1
(NOTE 3) | + +NOTE 1: This timer is used when overlap signalling is received from BICC/ISUP network and converted to en-block signalling at the MGCF. + +NOTE 2: This timer is used to send an early ACM if a delay is encountered in receiving a response from the subsequent SIP network. + +NOTE 3: This timer is known as the "SIP dialog protection timer". This timer is only used where the O-MGCF is configured to send INVITE before end of address signalling is determined. + +## 7.3 Interworking between CS networks supporting BICC and the IM CN subsystem + +The control plane between CS networks supporting BICC and the IM CN subsystem supporting SIP, where the underlying network is SS7 and IP respectively is as shown in figures 25, 26 and 27. + +![Diagram of Control Plane interworking between CS networks supporting BICC over MTP3 and the IM CN subsystem. The diagram shows four main functional blocks: SS7 signalling function, Signalling gateway function, Media gateway control function, and SIP signalling function. The SS7 signalling function contains layers BICC, STC, MTP3, MTP2, and L1. It connects via an SS7 link to the Signalling gateway function, which contains layers MTP3, MTP2, L1, M3UA, SCTP, and IP. The Signalling gateway function connects via an IP link to the Media gateway control function, which contains layers BICC, STC, M3UA, SCTP, IP, SIP, TCP/UDP/SCTP, and IP. The Media gateway control function connects via a SIP link to the SIP signalling function, which contains layers SIP, TCP/UDP/SCTP, and IP. Arrows indicate the flow of signalling: BICC over MTP3 from the SS7 function to the Media gateway control function, and SIP from the Media gateway control function to the SIP signalling function.](53e80f05e45f132bf76a96442a5507e9_img.jpg) + +Diagram of Control Plane interworking between CS networks supporting BICC over MTP3 and the IM CN subsystem. The diagram shows four main functional blocks: SS7 signalling function, Signalling gateway function, Media gateway control function, and SIP signalling function. The SS7 signalling function contains layers BICC, STC, MTP3, MTP2, and L1. It connects via an SS7 link to the Signalling gateway function, which contains layers MTP3, MTP2, L1, M3UA, SCTP, and IP. The Signalling gateway function connects via an IP link to the Media gateway control function, which contains layers BICC, STC, M3UA, SCTP, IP, SIP, TCP/UDP/SCTP, and IP. The Media gateway control function connects via a SIP link to the SIP signalling function, which contains layers SIP, TCP/UDP/SCTP, and IP. Arrows indicate the flow of signalling: BICC over MTP3 from the SS7 function to the Media gateway control function, and SIP from the Media gateway control function to the SIP signalling function. + +**Figure 25: Control Plane interworking between CS networks supporting BICC over MTP3 and the IM CN subsystem** + +![Figure 26: Control Plane interworking between CS networks supporting BICC over MTP3B over AAL5 and the IM CN subsystem. The diagram shows four main entities: SS7 signalling function, Signalling gateway function, Media gateway control function, and SIP signalling function. The SS7 signalling function contains layers BICC, STC, MTP3B, SSCF, SSCOP, and AAL5. The Signalling gateway function contains layers MTP3B, M3UA, SSCF, SCTP, SSCOP, IP, and AAL5. The Media gateway control function contains layers BICC, STC, M3UA, SCTP, IP, and SIP. The SIP signalling function contains layers SIP, TCP/UDP/SCTP, and IP. Connections are: BICC between SS7 and MGCF; AAL5 between SS7 and SGW; IP between SGW and MGCF; SIP between MGCF and SIP SF; and IP between MGCF and SIP SF.](17431d8b59408f09df7552d8bdbaa015_img.jpg) + +Figure 26: Control Plane interworking between CS networks supporting BICC over MTP3B over AAL5 and the IM CN subsystem. The diagram shows four main entities: SS7 signalling function, Signalling gateway function, Media gateway control function, and SIP signalling function. The SS7 signalling function contains layers BICC, STC, MTP3B, SSCF, SSCOP, and AAL5. The Signalling gateway function contains layers MTP3B, M3UA, SSCF, SCTP, SSCOP, IP, and AAL5. The Media gateway control function contains layers BICC, STC, M3UA, SCTP, IP, and SIP. The SIP signalling function contains layers SIP, TCP/UDP/SCTP, and IP. Connections are: BICC between SS7 and MGCF; AAL5 between SS7 and SGW; IP between SGW and MGCF; SIP between MGCF and SIP SF; and IP between MGCF and SIP SF. + +**Figure 26: Control Plane interworking between CS networks supporting BICC over MTP3B over AAL5 and the IM CN subsystem** + +![Figure 27: Control Plane interworking between CS networks supporting BICC over STC and M3UA and the IM CN subsystem. The diagram shows three main entities: SS7 signalling function, Media gateway control function, and SIP signalling function. The SS7 signalling function contains layers BICC, STCMTP, M3UA, SCTP, and IP. The Media gateway control function contains layers BICC, STCMTP, M3UA, SCTP, IP, and SIP. The SIP signalling function contains layers SIP, TCP/UDP/SCTP, and IP. Connections are: BICC between SS7 and MGCF; IP between SS7 and MGCF; SIP between MGCF and SIP SF; and IP between MGCF and SIP SF.](8edfc370769207831f060f44d2281084_img.jpg) + +Figure 27: Control Plane interworking between CS networks supporting BICC over STC and M3UA and the IM CN subsystem. The diagram shows three main entities: SS7 signalling function, Media gateway control function, and SIP signalling function. The SS7 signalling function contains layers BICC, STCMTP, M3UA, SCTP, and IP. The Media gateway control function contains layers BICC, STCMTP, M3UA, SCTP, IP, and SIP. The SIP signalling function contains layers SIP, TCP/UDP/SCTP, and IP. Connections are: BICC between SS7 and MGCF; IP between SS7 and MGCF; SIP between MGCF and SIP SF; and IP between MGCF and SIP SF. + +**Figure 27: Control Plane interworking between CS networks supporting BICC over STC and M3UA and the IM CN subsystem** + +### 7.3.1 Services performed by network entities in the control plane + +Services offered by the network entities in the control plane are as detailed in clause 7.2.1. + +If ATM transport is applied between the SS7 Signalling function and the Signalling Gateway Function, they shall apply MTP3B (ITU-T Recommendation Q.2210 [46]) over SSCF (ITU-T Recommendation Q.2140 [45]) over SSCOP (ITU-T Recommendation Q.2110 [44]) over AAL5 (ITU-T Recommendation I.363.5 [43]) as depicted in figure 26. + +If IP transport is applied between the SS7 Signalling function and the MGCF, they shall support and apply M3UA, SCTP and IP (either IPv4, see RFC 791 [16], or IPv6, see RFC 2460 [39]), as depicted in figure 27. + +### 7.3.2 Signalling interactions between network entities in the control plane + +#### 7.3.2.1 Signalling between the SS7 signalling function and MGCF + +See clause 7.2.2.1. + +##### 7.3.2.1.1 Signalling from MGCF to SS7 signalling function + +See clause 7.2.2.1.1. + +##### 7.3.2.1.2 Signalling from SS7 signalling function to MGCF + +See clause 7.2.2.1.2. + +### 7.3.2.1.3 Services offered by STC, SCTP and M3UA + +See clause 7.2.2.1.3. + +#### 7.3.2.1.3.1 Services offer by SCTP + +See clause 7.2.2.1.3.1. + +#### 7.3.2.1.3.2 Services offered by M3UA + +See clause 7.2.2.1.3.2. + +#### 7.3.2.1.3.3 Services offered by STC + +STC provides the services for the transparent transfer of STC user information, e.g. BICC, between STC users, i.e. the SS7 signalling function and the MGCF (see 3GPP TS 29.205 [14]). + +STC performs the functions of data transfer service availability reporting and congestion reporting to the STC user and User part availability control. See ITU-T Recommendation Q.2150.1 [29]. + +### 7.3.2.2 Signalling between the MGCF and SIP signalling function + +See clause 7.2.2.2. + +## 7.3.3 SIP-BICC protocol interworking + +### 7.3.3.1 Incoming call interworking from SIP to BICC at I-MGCF + +#### 7.3.3.1.1 Sending of IAM + +Clause 7.2.3.1.1 is applicable with the clarification that the Continuity Check procedure applies. + +#### Figure 28: Void + +#### 7.3.3.1.2 Coding of IAM + +The description of the following ISDN user part parameters can be found in ITU-T Recommendation Q.763 [4]. + +##### 7.3.3.1.2.1 Called party number + +See clause 7.2.3.1.2.1. + +##### 7.3.3.1.2.2 Nature of connection indicators + +| | | | +|------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| bits | BA | Satellite indicator | +| | 0 0 | no satellite circuit in the connection | +| bits | DC | Continuity indicator (BICC) | +| | 0 0 | no COT to be expected , if the received SDP does not contain precondition information or indicates that all preconditions are fulfilled, and all local resource reservation is completed. | +| | 1 0 | COT to be expected , if the received SDP indicates that precondition is not fulfilled or any local resource reservation is not completed. | +| Bit | E | Echo control device indicator | +| | 1 | outgoing echo control device included | + +##### 7.3.3.1.2.3 Forward call indicators + +See clause 7.2.3.1.2.3. + +7.3.3.1.2.4 Calling party's category + +See clause 7.2.3.1.2.4. + +7.3.3.1.2.4A Originating Line Information + +See clause 7.2.3.1.2.4A + +7.3.3.1.2.5 Transmission medium requirement + +See clause 7.2.3.1.2.5. + +7.3.3.1.2.6 Calling party number + +See clause 7.2.3.1.2.6. + +7.3.3.1.2.7 Generic number + +See clause 7.2.3.1.2.7. + +7.3.3.1.2.8 User service information + +See clause 7.2.3.1.2.8. + +7.3.3.1.2.9 Hop counter (National option) + +See clause 7.2.3.1.2.9. + +7.3.3.1.2.10 Location Number + +See clause 7.2.3.1.2.11. + +7.3.3.1.2.11 Support of ICS call + +See clause 7.2.3.1.2.12. + +7.3.3.1.2.12 UID capability indicators (National option) + +See clause 7.2.3.1.2.13. + +7.3.3.1.2A Coding of the IAM when Number Portability is supported + +See clause 7.2.3.1.2A. + +7.3.3.1.2B Coding of the IAM for Carrier Routeing + +See clause 7.2.3.1.2B. + +7.3.3.1.2.13 Called IN number and original called IN number (optional) + +See clause 7.2.3.1.2.14. + +7.3.3.1.3 Sending of COT + +![Sequence diagram showing the sending of COT from an I-MGCF. An arrow from the left points to a vertical line labeled I-MGCF, with a box above it containing 'SDP indicating preconditions met and/or active media'. From the I-MGCF line, another arrow points to the right with a box above it containing 'COT'.](8fecf981da2650d0a2832e4b9ac5c934_img.jpg) + +The diagram illustrates the 'Sending of COT' process. It features a vertical line representing the I-MGCF. On the left, an arrow points towards this line, accompanied by a box containing the text 'SDP indicating preconditions met and/or active media'. On the right, an arrow points away from the I-MGCF line, accompanied by a box containing the text 'COT'. + +Sequence diagram showing the sending of COT from an I-MGCF. An arrow from the left points to a vertical line labeled I-MGCF, with a box above it containing 'SDP indicating preconditions met and/or active media'. From the I-MGCF line, another arrow points to the right with a box above it containing 'COT'. + +Figure 29: Sending of COT + +If the IAM has already been sent, then the Continuity message shall be sent indicating "continuity check successful", when all of the following conditions have been met. + +- When the requested remote preconditions (if any) in the IMS have been met. +- The media stream previously set to inactive mode is set to active (as specified in IETF RFC 4566 [56]). +- Local preconditions have been fulfilled. + +#### 7.3.3.1.3A Sending of SAM + +See clause 7.2.3.1.3A. + +#### 7.3.3.1.4 Sending of 180 Ringing + +See clause 7.2.3.1.4. + +#### 7.3.3.1.4A Sending of 183 Session Progress for early media scenarios + +See clause 7.2.3.1.4A. + +#### 7.3.3.1.4B Sending of 181 Call is being forwarded + +See clause 7.2.3.1.4B. + +#### 7.3.3.1.4C Sending of 183 Session Progress for overlap signalling using the in-dialog method + +See clause 7.2.3.1.4C. + +NOTE: If the network option of overlap signalling using the in-dialog method is applied at the I-MGCF in combination with the optional codec negotiation interworking with BICC in clause B.2., in order to meet the requirement in clause B.2.1 that the I-MGCF suspends the SDP answer procedure until it receives backward codec information from BICC, the 183 session progress response will not contain the SDP answer. + +#### 7.3.3.1.4D Sending of 183 Session Progress to carry ISUP Cause + +See clause 7.2.3.1.4D. + +#### 7.3.3.1.4E Sending of 183 Session Progress for ICS call + +See clause 7.2.3.1.4E. + +#### 7.3.3.1.5 Sending of the 200 OK (INVITE) + +See clause 7.2.3.1.5. + +#### 7.3.3.1.6 Sending of the Release message (REL) + +See clause 7.2.3.1.6. + +#### 7.3.3.1.7 Coding of the REL + +See clause 7.2.3.1.7. + +#### 7.3.3.1.8 Receipt of the Release Message + +See clause 7.2.3.1.8. + +#### 7.3.3.1.9 Receipt of RSC, GRS or CGB (H/W oriented) + +See clause 7.2.3.1.9. + +#### 7.3.3.1.9a Receipt of REFER + +See clause 7.2.3.1.9a. + +#### 7.3.3.1.9b Autonomous Release at I-MGCF + +See clause 7.2.3.1.10. + +#### 7.3.3.1.10 Internal through connection of the bearer path + +The through connection procedure is described in clauses 9.2.2.1.5 and 9.2.2.2.5. + +#### 7.3.3.1.11 Out of Band DTMF + +If a SIP UA sends DTMF tones to the IM-MGW, the IM-MGW may report this information via the Mn interface to the MGCF. The MGCF shall send to the BICC network the APM message with the following values for the different parameters: + +- Action indicator in accordance with the requested DTMF transport function; +- Signal in accordance with which DTMF digit to send; +- Duration in accordance with the required duration of the DTMF digit. + +If the BICC network sends an APM message with DTMF signal, duration and action indicator to the MGCF, the MGCF may send this information to the IM-MGW via the Mn interface. The IM-MGW shall send the corresponding DTMF signal and duration information on the user plane of the IM CN subsystem according to RFC 4733 [105]. + +The interactions with the IM-MGW are shown in clause 9.2.8. + +### 7.3.3.2 Outgoing Call Interworking from BICC to SIP at O-MGCF + +#### 7.3.3.2.1 Sending of INVITE + +The following particularities apply for a BICC IAM received case, with regard to the already specified in clause 7.2.3.2.1. + +The O-MGCF should defer sending the INVITE request until the BICC bearer setup and any local resource reservation is completed. + +- NOTE: If the O-MGCF sends the INVITE request before the BICC bearer setup and any local resource reservation is completed, the following considerations apply: If the receiving terminal is not supporting the SIP precondition, clipping may occur. Furthermore, if the MGCF sets the SDP "inactive" attribute in the initial INVITE request and the receiving terminal is not supporting the SIP precondition and the SIP UPDATE method, the interworking procedures within the present specification do not describe all necessary signalling interactions required to set up a call, in particular with respect to the sending of the re-INVITE that may also cause additional delay in the call setup. In addition, the interworking of the ringing indication might not be possible if the peer sends the ringing indication only as response to a re-INVITE. + +The BICC bearer setup is completed when one of the following conditions is met: + +- The event Bearer Set-up indication - for the forward bearer set-up case where the incoming Connect Type is "notification not required", which indicate successful completion of bearer set-up, is received by the Incoming bearer set-up procedure (ITU-T Recommendation Q.1902.4 [30] clause 7.5); +- Bearer Set-up Connect indication for the backward call set-up case, which indicate successful completion of bearer set-up, is received by the Incoming bearer set-up procedure (ITU-T Recommendation Q.1902.4 [30] clause 7.5); +- BNC set-up success indication for cases using bearer control tunnelling which indicate successful completion of bearer set-up, is received by the Incoming bearer set-up procedure (ITU-T Recommendation Q.1902.4 [30] clause 7.5). + +#### 7.3.3.2.1a Sending of INVITE without determining the end of address signalling + +See clause 7.2.3.2.1a. + +#### 7.3.3.2.2 Coding of the INVITE + +##### 7.3.3.2.2.1 Request-URI and To header field + +See clause 7.2.3.2.2.1 + +##### 7.3.3.2.2.2 SDP Media Description + +If the O-MGCF sends the INVITE request without waiting for the BICC bearer setup and any local resource reservation to complete, (which is not recommended according to clause 7.3.3.2.1) it shall indicate that SIP preconditions are not met when the initial INVITE request indicates support of the SIP preconditions. + +The O-MGCF shall include the AMR codec transported according to IETF RFC 4867 [23] with the options listed in clause 12.3.1 of 3GPP TS 26.114 [104] in the SDP offer. Within the SDP offer, the O-MGCF should also provide SDP RR and RS bandwidth modifiers specified in IETF RFC 3556 [59] as detailed in clause 7.3.1 of 3GPP TS 26.114 [104]. + +##### 7.3.3.2.2.3 P-Asserted-Identity and privacy header fields + +See clause 7.2.3.2.2.3 + +###### 7.3.3.2.2.3A "cpc" URI Parameter in P-Asserted-Identity Header + +See clause 7.2.3.2.2.3A. + +###### 7.3.3.2.2.3B "oli" URI Parameter in P-Asserted-Identity Header + +See clause 7.2.3.2.2.3B. + +##### 7.3.3.2.2.4 Max Forwards header + +See clause 7.2.3.2.2.4 + +##### 7.3.3.2.2.5 IMS Communication Service Identifier + +For speech and video calls, the O-MGCF shall insert an IMS Communication Service Identifier, indicating the IMS Multimedia Telephony Communication Service. + +The IMS Communication Service Identifier for the IMS Multimedia Telephony Communication Service is defined in 3GPP TS 24.173 [88]. + +##### 7.3.3.2.2.6 P-Access-Network-Info + +See clause 7.2.3.2.2.9. + +#### 7.3.3.2.2A Coding of the INVITE when number portability is supported + +See clause 7.2.3.2.2A. + +#### 7.3.3.2.2B Coding of the INVITE for Carrier Routeing + +See clause 7.2.3.2.2B. + +#### 7.3.3.2.2C Coding of INVITE with instance-id in form of IMEI URN + +See clause 7.2.3.2.2C. + +##### 7.3.3.2.2.7 PSAP Call-back indication + +See clause 7.2.3.2.2.10. + +#### 7.3.3.2.2.8 History-Info header field (optional) + +See clause 7.2.3.2.2.11. + +#### 7.3.3.2.3 Sending of UPDATE + +This clause only applies if the O-MGCF sends the INVITE request before SIP preconditions are met (see clause 7.3.3.2.1). + +![Sequence diagram showing the receipt of COT (success) and the subsequent sending of an UPDATE message by the O-MGCF.](74e409e1548dd2606c4de9bdfe9806e4_img.jpg) + +The diagram illustrates a sequence of events for the O-MGCF. A horizontal arrow labeled "COT (success)" points to a vertical line representing the O-MGCF. From this vertical line, another horizontal arrow labeled "UPDATE" points to the right, indicating the sending of the UPDATE message. + +Sequence diagram showing the receipt of COT (success) and the subsequent sending of an UPDATE message by the O-MGCF. + +**Figure 30: Receipt of COT (success)** + +The UPDATE request with a new SDP offer shall be sent for each early SIP dialogue for which the received provisional response indicated support of preconditions confirming that all the required local preconditions have been met when all the following conditions are met. + +1. A Continuity message, with the Continuity Indicators parameter set to "continuity check successful" shall be received. +2. The reservation of requested local resources has been completed. + +In addition, depending on which bearer set-up procedure used for the call one of the following condition shall be met: + +- The event Bearer Set-up indication - for the forward bearer set-up case where the incoming Connect Type is "notification not required", which indicate successful completion of bearer set-up, is received by the Incoming bearer set-up procedure (ITU-T Recommendation Q.1902.4 [30] clause 7.5); +- Bearer Set-up Connect indication for the backward call set-up case, which indicate successful completion of bearer set-up, is received by the Incoming bearer set-up procedure (ITU-T Recommendation Q.1902.4 [30] clause 7.5); +- BNC set-up success indication for cases using bearer control tunnelling which indicate successful completion of bearer set-up, is received by the Incoming bearer set-up procedure, (ITU-T Recommendation Q.1902.4 [30] clause 7.5). + +NOTE: This procedure applies regardless of whether the early SIP dialog existed prior to the preconditions being fulfilled or is subsequently created. + +#### 7.3.3.2.4 Sending of ACM and Awaiting Answer indication + +See clause 7.2.3.2.4 + +The sending of an awaiting answer indication is described in clause 9.2.3.1. and clause 9.2.3.2. + +#### 7.3.3.2.5 Coding of the ACM + +##### 7.3.3.2.5.1 Backward call indicators + +See clause 7.2.3.2.5.1 + +#### 7.3.3.2.6 Sending of the Call Progress message (CPG) + +See clause 7.2.3.2.6. + +### 7.3.3.2.7 Coding of the CPG + +#### 7.3.3.2.7.1 Event information + +See clause 7.2.3.2.7.1. + +#### 7.3.3.2.7.2 Optional Backward call indicators + +See clause 7.2.3.2.7.5. + +#### 7.3.3.2.7a Receipt of 200 OK (INVITE) + +See clause 7.2.3.2.7a. + +#### 7.3.3.2.7b Internal through connection of the bearer path + +The through connection procedure is described in clauses 9.2.3.1.7 and 9.2.3.2.7. + +### 7.3.3.2.8 Sending of the Answer Message (ANM) + +See clause 7.2.3.2.8. + +### 7.3.3.2.9 Coding of the ANM + +See clause 7.2.3.2.9. + +### 7.3.3.2.10 Sending of the Connect message (CON) + +See clause 7.2.3.2.10. + +### 7.3.3.2.11 Coding of the CON + +See clause 7.2.3.2.11. + +#### 7.3.3.2.11.1 Void + +#### 7.3.3.2.11A Receipt of re-INVITE requests + +See clause 7.2.3.2.11A. + +### 7.3.3.2.12 Receipt of Status Codes 4xx, 5xx or 6xx + +See clause 7.2.3.2.12. + +### 7.3.3.2.13 Receipt of a BYE + +See clause 7.2.3.2.13. + +### 7.3.3.2.14 Receipt of the Release Message + +See clause 7.2.3.2.14. + +### 7.3.3.2.15 Receipt of RSC, GRS or CGB (H/W oriented) + +See clause 7.2.3.2.15. + +### 7.3.3.2.16 Out of Band DTMF + +If a SIP UA sends DTMF tones to the IM-MGW, the IM-MGW may report this information via the Mn interface to the MGCF. The MGCF shall send to the BICC network the APM message with the following values for the different parameters: + +- Action indicator in accordance with the requested DTMF transport function; +- Signal in accordance with which DTMF digit to send; + +- Duration in accordance with the required duration of the DTMF digit. + +If the BICC network sends an APM message with DTMF signal, duration and action indicator to the MGCF, the MGCF may send this information to the IM-MGW via the Mn interface. The IM-MGW shall send the corresponding DTMF signal and duration information on the user plane of the IM CN subsystem according to 4733 [105]. + +The interaction with the IM-MGW is shown in clause 9.2.8. + +#### 7.3.3.2.17 Sending of CANCEL + +See clause 7.2.3.2.18. + +#### 7.3.3.2.18 Autonomous Release at O-MGCF + +See clause 7.2.3.2.16. + +#### 7.3.3.2.19 Special handling of 580 precondition failure received in response to either an INVITE or UPDATE + +See clause 7.2.3.2.17. + +#### 7.3.3.2.20 Receipt of SIP redirect (3xx) response + +See clause 7.2.3.2.19. + +#### 7.3.3.2.21 Sending of INFO for overlap signalling using the in-dialog method + +See clause 7.2.3.2.20. + +### 7.3.3.3 Timers + +See clause 7.2.3.3. + +## 7.4 Supplementary Services + +The following clauses describe the MGCF behaviour related to supplementary services as defined in ITU-T Recommendations Q.730 to ITU-T Q.737 [42] when interworking with an IMS which does not use a Multimedia Telephony Application Server (MTAS) providing supplementary services according to 3GPP according to 3GPP TS 24.173 [88]. The support of these supplementary services is optional. If the supplementary services are supported, the procedures described within this clause shall be applied. + +### 7.4.1 Calling line identification presentation/restriction (CLIP/CLIR) + +The inter working between the Calling Party Number parameter and the P-Asserted-ID header and vice versa used for the CLIP-CLIR service is defined in the clauses 7.2.3.1.2.6 and 7.2.3.2.2.3. This inter working is essentially the same as for basic call and differs only in that if the CLIR service is invoked the "Address Presentation Restriction Indicator (APRI)" (in the case of ISUP to SIP calls) or the "priv value" of the "calling" Privacy header field (in the case of SIP to ISUP calls) is set to the appropriate "restriction/privacy" value. + +In the specific case of ISUP originated calls, use of the CLIP service additionally requires the ability to determine whether the number was network provided or provided by the access signalling system. Due to the possible SIP indication of the P-Asserted-Identity the Screening indicator is set to network provided as default. For the CLIP-CLIR service the mapping of the APRI from privacy header at the O-MGCF is described within table 16 in clause 7.2.3.2.2.3. + +At the O-MGCF the presentation restricted indication shall be mapped to the Privacy header field values "id" and "header". This is described in table 12 in clause 7.2.3.2.2.3. + +## 7.4.2 Connected line presentation and restriction (COLP/COLR) + +### 7.4.2.0 General + +The COLP/COLR services are only to be interworked between trusted nodes - that is before passing any COLP/COLR information over the SIP-BICC/ISUP boundary the MGCF shall satisfy itself that the nodes on the BICC/ISUP side to which the information is to be passed are trusted. + +The procedure within clause 7.5.2 for the generic number ("additional connected number") mapping shall apply. + +### 7.4.2.1 Incoming Call Interworking from SIP to BICC/ISUP at the I-MGCF + +#### 7.4.2.1.1 INVITE to IAM interworking (SIP to ISUP/BICC calls) + +In the case of SIP to ISUP/BICC calls the I-MGCF may invoke the COLP service as an operator option by setting the "Connected Line Identity Request indicator" field of the "Optional forward call indicators" parameter of the IAM to "requested". + +NOTE: This implies that all outgoing calls will invoke the COLP service. + +#### 7.4.2.1.2 ANM/CON to 200 OK (INVITE) + +Tables 20 and 21 specify the interworking required in the case when the COLP has been automatically requested on behalf of the originating SIP node. The table also indicates the inter workings required if the COLP service has been invoked and the called party has or has not invoked the COLR service. + +**Table 20: Mapping to P-Asserted-Identity and Privacy Header Fields** + +| SIP Component | Setting | +|---------------------|--------------| +| P-Asserted-Identity | See table 21 | +| Privacy | See table 22 | + +**Table 21: Mapping of connected number parameter to SIP P-Asserted-Identity header fields** + +| BICC/ISUP parameter / field | Value | SIP component | Value | +|----------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------| +| Connected Number | | P-Asserted-Identity header field | | +| Nature of Address Indicator | " national (significant) number " | Tel URI or SIP URI (NOTE 1) | Add CC (of the country where the MGCF is located) to Connected PN address signals to construct E.164 number in URI. Prefix number with "+". | +| | " international number " | | Map complete Connected address signals to construct E.164 number in URI. Prefix number with "+". | +| Address signal | If NOA is " national (significant) number " then the format of the address signals is:
NDC + SN
If NOA is " international number " then the format of the address signals is:
CC + NDC + SN | Tel URI or SIP URI (NOTE 1) | CC+NDC+SN as E.164 number in URI. Prefix number with "+". | +| NOTE 1: A tel URI or a SIP URI with "user=phone" is used according to operator policy. | | | | + +**Table 22: Mapping of BICC/ISUP APRIs into SIP privacy header fields** + +| BICC/ISUP parameter / field | Value | SIP component | Value | +|---------------------------------------------------------------|----------------------------------|----------------------|----------------------------------------------------------------------------------------------------| +| Connected Number | | Privacy header field | priv-value | +| APRI
(See to determine which APRI to use for this mapping) | "presentation restricted" | Priv-value | "id"
("id" included only if the P-Asserted-Identity header is included in the SIP INVITE) | +| | "presentation allowed" | Priv-value | omit Privacy header or Privacy header without "id" and "header" if other privacy service is needed | + +## 7.4.2.2 Outgoing Call Interworking from BICC/ISUP to SIP at O-MGCF + +### 7.4.2.2.1 IAM to INVITE interworking (ISUP to SIP calls) + +The O-MGCF determines that the COLP service has been requested by the calling party by parsing the "Optional Forward Call Indicators" field of the incoming IAM. If the "Connected Line Identity Request indicator" is set to "requested" then the BICC/ISUP to SIP interworking node shall ensure that any backwards "connected party" information is interworked to the appropriate parameters of the ISUP ANM or CON message sent backwards to the calling party as detailed within this subclause. + +The O-MGCF has to store the status of the "Connected Line Identity Request indicator". + +### 7.4.2.2.2 1XX to ANM or CON interworking + +If the P-Asserted-Identity header field is included within a 1XX SIP response, the identity shall be stored within the O-MGCF together with information about the SIP dialogue of the 1XX SIP response and shall be included within the ANM or CON message if required by the procedures described in clause 7.4.2.2.3. In accordance with ISUP procedures, a connected number shall not be included within the ACM message. The mapping of the of the P-Asserted-Identity and Privacy header fields is shown in tables 23 and 24. + +### 7.4.2.2.3 200 OK (INVITE) to ANM/CON interworking + +Tables 23 and 24 specify the interworking required in the case when the calling party has invoked the COLP service. The tables also indicate the interworking procedures required if the calling party has invoked the COLP service and the called party has or has not invoked the COLR service. + +If no P-Asserted-Identity header field is provided within the 200 OK (INVITE) message, the stored information previously received in the last provisional 1xx response of the same SIP dialogue shall be used. + +NOTE: Due to forking, other P-Asserted-Identities might have been received in different SIP dialogues. + +If the Calling Party has requested the COLP service (as indicated by the stored request status) but the 200 OK (INVITE) and previous 1XX provisional responses do not include a P-Asserted-Identity header field, the O-MGCF shall set up a network provided Connected Number with an Address not Available indication. + +If the P-Asserted-Identity is available then the Connected number has to be setup with the screening indication network provided. The mapping of the P-Asserted-Identity and Privacy (if available) is shown in table 24. + +**Table 23: Connected number parameter mapping** + +| ANM/CON | 200 OK INVITE | +|-------------------------------------------|----------------------| +| Connected Number (Network Provided) | P-Asserted-ID | +| Address Presentation Restricted Indicator | Privacy Value Field | + +**Table 24: Mapping of P-Asserted-Identity and privacy headers to the ISUP/BICC connected number parameter** + +| SIP component | Value | BICC/ISUP parameter / field | Value | +|-----------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| P-Asserted-Identity header field (NOTE) | E.164 number | Connected Number | | +| | | Number incomplete indicator | "Complete" | +| | | Numbering Plan Indicator | "ISDN/Telephony (E.164)" | +| | | Nature of Address Indicator | If CC encoded in the URI is equal to the CC of the country where MGCF is located AND the next BICC/ISUP node is located in the same country then set to "national (significant) number" else set to "international number" | +| | | Address Presentation Restricted Indicator (APRI) | Depends on priv-value in Privacy header. | +| | | Screening indicator | Network Provided | +| Addr-spec | "CC" "NDC" "SN" from the URI | Address signal | if NOA is "national (significant) number" then set to "NDC" + "SN".
If NOA is "international number" then set to "CC"+"NDC"+"SN". | +| Privacy header field is not present | | APRI | Presentation allowed | +| Privacy header field | priv-value | APRI | "Address Presentation Restricted Indicator" | +| priv-value | "header" | APRI | Presentation restricted | +| | "user" | APRI | Presentation restricted | +| | "none" | APRI | Presentation allowed | +| | "id" | APRI | Presentation restricted | +| NOTE: | It is possible that a P-Asserted-Identity header field includes both a tel URI and a SIP URI. In this case, either the tel URI or the SIP URI with user="phone" and a specific host portion, as selected by operator policy, may be used. | | | + +### 7.4.3 Direct Dialling In (DDI) + +A direct dialling in call is a basic call and no additional treatment is required by the MGCF. + +### 7.4.4 Malicious call identification + +The actions of the MGCF at the ISUP/BICC side are described in ITU-T Recommendation Q.731.7 [42] under the clause "Interactions with other networks". + +### 7.4.5 Subaddressing (SUB) + +#### 7.4.5.1 General + +The ISDN subaddress information in ISUP is transported within the Access Transport Parameter. The coding of the subaddress parameter within the Access Transport Parameter is described within ETSI EN 300 403-1 [96]. The isdn-subaddress parameter "isub" carried within a tel or SIP URI is defined within IETF RFC 3966 [97]. The isdn-subaddress encoding type parameter "isub-encoding" carried within a tel or SIP URI is defined within IETF RFC 4715 [108] and extended within 3GPP TS 24.229 [9]. + +#### 7.4.5.2 Interworking at I-MGCF + +The mapping in table 24ba of the isdn-subaddress parameter received within a tel or SIP URI of the initial INVITE request to the ISUP Access Transport Parameter encapsulating the subaddress information (calling party subaddress and/or called party subaddress information elements) to be sent within the IAM message shall be applied. + +The mapping in table 24bb of the subaddress information (connected subaddress information element) received within an ANM message or a CON message containing the ISUP Access Transport Parameter to the isdn-subaddress parameters "isub" and "isub-encoding" of a tel or SIP URI to be sent within a 200 OK (INVITE) shall be applied. + +**Table 24ba: Mapping of the isdn-subaddress received in an initial INVITE to the subaddress information sent in the IAM** + +| SIP Message INVITE | | | ISUP Message IAM | | | +|----------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------|----------------------------|----------------------------------|------------------------------------------------------| +| Source SIP header field and component | Source component value | | ISUP Parameter field | Derived value of parameter field | | +| To header field including the isdn-subaddress (NOTE 1) | "isub=" 1*uric

"uric" containing the subaddress digits | isub-encoding not present | Access Transport Parameter | called party subaddress | Type of subaddress = "NSAP" (000) | +| | | "isub-encoding=nsap-ia5" | | | Type of subaddress = "NSAP" (000) | +| | | "isub-encoding=nsap-bcd" | | | Type of subaddress = "NSAP" (000) | +| | | "isub-encoding=nsap" | | | Type of subaddress = "user specified" (010) (NOTE 2) | +| | "isub=" 1*uric ("uric" containing the subaddress digits) and isub-encoding does not contain "nsap-ia5" or "nsap-bcd" or "nsap" or "user-specified" value (NOTE 2) | | No mapping | | | +| P-Asserted-Identity header Field including the isdn-subaddress | ";isub=" 1*uric

"uric" containing the subaddress digits | isub-encoding not present | Access Transport Parameter | calling party subaddress | Type of subaddress = "NSAP" (000) | +| | | "isub-encoding=nsap-ia5" | | | Type of subaddress = "NSAP" (000) | +| | | "isub-encoding=nsap-bcd" | | | Type of subaddress = "NSAP" (000) | +| | | "isub-encoding=nsap" | | | Type of subaddress = "user specified" (010) (NOTE 2) | +| | "isub=" 1*uric ("uric" containing the subaddress digits) and isub-encoding does not contain "nsap-ia5" or "nsap-bcd" or "nsap" or "user-specified" value (NOTE 2) | | No mapping | | | + +NOTE 1: As an operator option, an isdn-subaddress within the Request-URI may also be mapped into the ISUP Access Transport parameter. +NOTE 2: The interworking between "user-specified" encoding-type parameter and "user-specified" type of subaddress is an operator option. + +**Table 24bb: Mapping of the subaddress information received in an ANM or CON to the isdn subaddress sent in the 200 OK (INVITE)** + +| ISUP Message ANM or CON | | SIP Message 200 (OK) | | +|----------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------|---------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ISUP Parameter field | Source component value | Source SIP header field and component | Derived value of parameter field | +| Access Transport Parameter | connected subaddress and Type of subaddress = "NSAP" (000) | P-Asserted-Identity including the isdn-subaddress | ";isub=" 1*uric and "isub-encoding=nsap-ia5"
The subaddress digits included into the "uric" shall be derived from the Access Transport Parameter. | +| | connected subaddress and Type of subaddress = "user specified" (010) (NOTE) | | ";isub=" 1*uric and "isub-encoding=user-specified"
The subaddress digits included into the "uric" shall be derived from the Access Transport Parameter. (NOTE) | +| | connected subaddress and Type of subaddress ≠ "NSAP" (000) or "user specified" (010) (NOTE) | No mapping | | +| NOTE: The interworking between "user-specified" encoding-type parameter and "user-specified" type of subaddress is an operator option. | | | | + +### 7.4.5.3 Interworking at O-MGCF + +The mapping in table 24bc of the subaddress information received in the Access Transport Parameter (calling party subaddress and/or called party subaddress information elements) of the IAM message to the isdn-subaddress parameters "isub" and "isub-encoding" of a tel or SIP URI to be sent within the initial INVITE request shall be applied. + +The mapping in table 24bd of the isdn-subaddress information received within a tel or SIP URI of a 200 OK (INVITE) to the subaddress information of the ISUP Access Transport Parameter (connected subaddress information element) to be sent within the ANM or CON message shall be applied. + +**Table 24bc: Mapping of the subaddress information received in an IAM to the isdn-subaddress sent in the INVITE** + +| ISUP IAM Message | | SIP INVITE Message | | +|----------------------------|-------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ISUP Parameter field | Source component value | Source SIP header field and component | Derived value of parameter field | +| Access Transport Parameter | called party subaddress and Type of subaddress = "NSAP" (000) | To header field including the isdn-subaddress, and, as an operator option, Request URI | ";isub=" 1*uric and "isub-encoding=nsap-ia5"
The subaddress digits included into the "uric" shall be derived from the Access Transport Parameter. | +| | called party subaddress and Type of subaddress = "user specified" (010) (NOTE) | | ";isub=" 1*uric and "isub-encoding=user-specified"
The subaddress digits included into the "uric" shall be derived from the Access Transport Parameter. (NOTE) | +| | called party subaddress and Type of subaddress ≠ "NSAP" (000) OR "user specified" (010) (NOTE) | No mapping | | +| | calling party subaddress and Type of subaddress = "NSAP" (000) | P-Asserted-Identity header field including the isdn-subaddress | ";isub=" 1*uric and "isub-encoding=nsap-ia5"
The subaddress digits included into the "uric" shall be derived from the Access Transport Parameter. | +| | calling party subaddress and Type of subaddress = "user specified" (010) (NOTE) | | ";isub=" 1*uric and "isub-encoding=user-specified"
The subaddress digits included into the "uric" shall be derived from the Access Transport Parameter. (NOTE) | +| | calling party Subaddress and Type of Subaddress ≠ "NSAP" (000) or "user specified" (010) (NOTE) | No mapping | | + +NOTE: The interworking between "user-specified" encoding-type parameter and "user-specified" type of subaddress is an operator option. + +**Table 24bd: Mapping of the isdn subaddress received in a 200OK to the subaddress information sent in the ANM or CON** + +| SIP Message 200 (OK) | | | ISUP Message ANM or CON | | | +|----------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------|----------------------------|----------------------------------|----------------------------------------------------| +| Source SIP header field and component | Source component value | | ISUP Parameter field | Derived value of parameter field | | +| P-Asserted-Identity header Field including the isdn-subaddress | "isub=" 1*uric

"uric" containing the subaddress digits | isub-encoding not present | Access Transport Parameter | connected subaddress | Type of subaddress = "NSAP" (000) | +| | | "isub-encoding=nsap-ia5" | | | Type of subaddress = "NSAP" (000) | +| | | "isub-encoding=nsap-bcd" | | | Type of subaddress = "NSAP" (000) | +| | | "isub-encoding=nsap" | | | Type of subaddress = "user-specified" (010) (NOTE) | +| | "isub=" 1*uric ("uric" containing the subaddress digits) and isub-encoding does not contain "nsap-ia5" or "nsap-bcd" or "nsap" or "user-specified" value (NOTE) | | No mapping | | | + +NOTE: The interworking between "user-specified" encoding-type parameter and "user-specified" type of subaddress is an operator option. + +## 7.4.6 Call Forwarding Busy (CFB)/ Call Forwarding No Reply (CFNR) / Call Forwarding Unconditional (CFU) / Call Deflection (CD) + +### 7.4.6.1 General + +A MGCF within an IMS network applying the Communication Diversion service uses the procedures defined in clause 7.5.4. + +This clause describes additional interworking of call forwarding service information between a PSTN/PLMN network and an IMS network. This can also be used when interworking between SIP networks (e.g., IMS network interworking with enterprise networks making use of the History-Info header field with an escaped Reason header field as described in IETF RFC 7044 [91]). The procedures support the interworking of the diversion reason within the History-Info header field using an escaped Reason header field defined by IETF RFC 3326 [116] as described in IETF RFC 7044 [91] and also support the diversion cause using the "cause" URI parameter as described by IETF RFC 4458 [113]. + +If the MGCF is supporting the interworking of Call Forwarding and also applying the Communication Diversion services as defined by 3GPP TS 24.604 [60], it uses both IETF RFC 7044 [91] and IETF RFC 4458 [113] to signal the diversion reason. An IMS network supporting the interworking of Call Forwarding and not applying the IMS Communication Diversion supplementary service according to 3GPP TS 24.604 [60] uses IETF RFC 7044 [91] and can also use IETF RFC 4458 [113] based on network option. + +When interworking the SIP History-Info header field to ISUP, and both the diversion reason based on IETF RFC 7044 [91] and IETF RFC 4458 [113] are present for the same diversion instance, the MGCF should use the "cause" URI parameter per IETF RFC 4458 [113] for deriving the ISUP. When the "cause" URI parameter per IETF RFC 4458 [113] is used, the corresponding interworking as described in clause 7.5.4 shall be applied for that diversion instance. Otherwise, the interworking as defined in the present clause should be applied. + +When interworking from ISUP to the History-Info header field, to signal the diversion reason the MGCF should use the escaped Reason header field from IETF RFC 7044 [91] and apply the interworking procedures in the present subclause. The MGCF should also apply the interworking procedures described in clause 7.5.4 to use the "cause" URI parameter from IETF RFC 4458 [113] to signal the diversion reason. + +In the event that the interworking procedures described in this clause as well as the interworking procedures in clause 7.5.4 are not applied, the actions of the MGCF at the ISUP/BICC side as described in ITU-T Recommendation Q.732.2-5 [42] under the clause "Interactions with networks not providing any call diversion information" may be applied as a network option. + +## 7.4.6.2 Interworking at the O-MGCF + +### 7.4.6.2.1 General + +This clause describes the optional mapping of Call Forwarding information at the O-MGCF to the protocol-cause specified in IETF RFC 3326 [116]. + +### 7.4.6.2.2 Interworking SIP to ISUP + +**Table 7.4.6.2.2.1: Mapping of SIP messages to ISUP messages** + +| ←Message sent to ISUP | ←Message Received from SIP | | +|-------------------------------------------|----------------------------------------------------------------------------------------------------------------|------------------------| +| ACM indicating call forwarding | 181 (Call Is Being Forwarded) response | See table 7.4.6.2.2.6 | +| CPG indicating call forwarding (see NOTE) | 181 (Call Is Being Forwarded) response | See table 7.4.6.2.2.7 | +| ACM indicating ringing | 180 (Ringing) response | See table 7.4.6.2.2.8 | +| CPG indicating alerting (see NOTE) | 180 (Ringing) response | See table 7.4.6.2.2.9 | +| ANM | 200 (OK) response | See table 7.4.6.2.2.10 | +| CON | 200 (OK) response (Neither a 181 (Call Is Being Forwarded) response nor a 180 (Ringing) response was received) | See table 7.4.6.2.2.10 | + +NOTE: A CPG will be sent if an ACM was already sent. + +**Table 7.4.6.2.2.2: Mapping of History-Info header field to ISUP Redirection number** + +| Source SIP header field and component | Source Component value | Redirection number | Derived value of parameter field | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------|-----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| hi-targeted-to-uri of the hi-entry following the last hi-entry containing a Reason "headers" component as defined in IETF RFC 7044 [91] with cause value as listed in table 7.4.6.2.2.4. Appropriate global number portion of the hi-targeted-to-uri, assumed to be in form "+" CC + NDC + SN. (NOTE) | CC | Nature of address indicator | If CC is equal to the country code of the country where O-MGCF is located AND the next ISUP node is located in the same country, then set to " national (significant) number " else set to " international number ". | +| | CC, NDC, SN | Address signals | If NOA is " national (significant) number " then set to NDC + SN.
If NOA is " international number " then set to CC + NDC + SN. | +| NOTE: If the SIP URI doesn't contain " user=phone ", mapping to redirection number is impossible, therefore no need to generate Redirection number and Redirection number restriction parameter (per table 7.4.6.2.2.3), Notification subscription options can't be set as " presentation allowed with redirection number ". | | | | + +**Table 7.4.6.2.2.3: Mapping of History-Info header field to ISUP Redirection number restriction** + +| Source SIP header field and component | Source Component value | Redirection number restriction | Derived value of parameter field | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------|-----------------------------------|-------------------------------------------| +| Privacy header field, or/and Privacy "headers" component of the hi-entry following the last hi-entry containing a Reason "headers" component as defined in IETF RFC 7044 [91] with cause value as listed in table 7.4.6.2.2.4 | " history " or " session " or " header " | Presentation restricted indicator | " Presentation restricted " | +| | Privacy "headers" component of the hi-targeted-to-uri and Privacy header field absent or " none " | | " Presentation allowed " or absent | + +**Table 7.4.6.2.2.4: Mapping of hi-targeted-to-uri to ISUP Call Diversion Information** + +| Source SIP header field and component | Source Component value | Call Diversion Information | Derived value of parameter field | +|------------------------------------------------------------------------------------------------------|------------------------------|-----------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Privacy "headers" component of the hi-targeted-to-uri or/and Privacy header field | | Notification subscription options |

If the priv-value "history" or "session" or "header" is received within the Privacy header field or the priv-value "history" is received within the "headers" component of the hi-targeted-to-uri representing the diverting URI(s) and within the hi-targeted-to-uri representing diverted-to URI then "presentation not allowed" shall be set.

Otherwise, if the priv-value "history" is received only within the "headers" component of the hi-targeted-to-uri representing the diverted-to URI then "presentation allowed without redirection number" shall be set. (NOTE 1, NOTE 2)

Otherwise, "presentation allowed with redirection number" shall be set.

| +| hi-targeted-to-uri; Reason "headers" component as defined in IETF RFC 7044 [91] with cause parameter | Cause parameter value | Redirecting reason | | +| | 302 | | Deflection immediate response | +| | 486 | | User busy | +| | 408 | | No reply | +| | 503 | | Mobile subscriber not reachable | +| | all other cause values | | Unknown | + +NOTE 1: diverting URI corresponds to the hi-targeted-to-uri of the hi-entry containing a hi-index value that match the "mp" header field parameter value of the diverted-to URI. If the diverted-to URI does not contain the "mp" header field parameter, the diverting URI corresponds to the hi-targeted-to-uri of the last hi-entry containing a Reason "headers" component with cause parameter. + +NOTE 2: diverted-to URI corresponds to the hi-targeted-to-uri of the hi-entry following the last hi-entry containing a Reason "headers" component with cause parameter and is mapped to the Redirection number, see table 7.4.6.2.2.2. + +Table 7.4.6.2.2.5: Void + +Table 7.4.6.2.2.6: Mapping of 181 (Call Is Being Forwarded) © ACM when ACM was not previously sent + +| Source SIP header field and component | Source Component value | ISUP Parameter | Derived value of parameter field | +|------------------------------------------------------------------------------------------------------|------------------------|------------------------------------------------------------------------|----------------------------------| +| 181 (Call Is Being Forwarded) | | ACM | | +| | | Generic notification indicator
Notification indicator | Call is diverting | +| History-Info header field | See table 7.4.6.2.2.2 | Redirection number | See table 7.4.6.2.2.2 | +| Privacy "headers" component of the hi-targeted-to-uri or/and Privacy header field | See table 7.4.6.2.2.3 | Redirection number restriction | See table 7.4.6.2.2.3 | +| Privacy "headers" component of the hi-targeted-to-uri or/and Privacy header field | See table 7.4.6.2.2.4 | Call diversion information
Notification subscription options | See table 7.4.6.2.2.4 | +| hi-targeted-to-uri; Reason "headers" component as defined in IETF RFC 7044 [91] with cause parameter | See table 7.4.6.2.2.4 | Call diversion information
Redirecting reason | See table 7.4.6.2.2.4 | + +Table 7.4.6.2.2.7: Mapping of 181 (Call Is Being Forwarded) © CPG if ACM was already sent + +| Source SIP header field and component | Source Component value | ISUP Parameter | Derived value of parameter field | +|------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------|----------------------------------| +| 181 (Call Is Being Forwarded) response | | CPG | | +| | | Generic notification indicator
Notification indicator | Call is diverting | +| hi-targeted-to-uri; Reason "headers" component as defined in IETF RFC 7044 [91] with cause parameter | 486 | Event information | CFB (national use) | +| | 408 (see NOTE) | Event indicator | CFNR (national use) | +| | all other values, or if appropriate "national use" value (CFB, CFNR or CFU) is not used in a network, or if no hi-targeted-to-uri "cause" URI parameter is contained in the SIP 181 (Call Is Being Forwarded) response. | | Progress | +| History-Info header field | See table 7.4.6.2.2.2 | Redirection number | See table 7.4.6.2.2.2 | +| Privacy "headers" component of the hi-targeted-to-uri or/and Privacy header field | See table 7.4.6.2.2.3 | Redirection number restriction | See table 7.4.6.2.2.3 | +| Privacy "headers" component of the hi-targeted-to-uri or/and Privacy header field | See table 7.4.6.2.2.4 | Call diversion information
Notification subscription options | See table 7.4.6.2.2.4 | +| hi-targeted-to-uri; Reason "headers" component as defined in IETF RFC 7044 [91] with cause parameter | See table 7.4.6.2.2.4 | Call diversion information
Redirecting reason | See table 7.4.6.2.2.4 | +| NOTE: This appears in the cases of CFNR. | | | | + +**Table 7.4.6.2.2.8: Mapping of 180 (Ringing) $\Leftarrow$ ACM when ACM was not previously sent** + +| Source SIP header field and component | Source Component value | ISUP Parameter | Derived value of parameter field | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------|----------------------------------| +| 180 (Ringing) response | | ACM | | +| History-Info header field | If hi-targeted-to-uri of at least one History-Info hi-entry contains a Reason "headers" component as defined in IETF RFC 7044 [91]. | Generic notification indicator
Notification indicator | Call is diverting | +| History-Info header field | See table 7.4.6.2.2.2 | Redirection number (NOTE) | See table 7.4.6.2.2.2 | +| Privacy "headers" component of the hi-targeted-to-uri or/and Privacy header field | See table 7.4.6.2.2.3 | Redirection number restriction (NOTE) | See table 7.4.6.2.2.3 | +| Privacy "headers" component of the hi-targeted-to-uri or/and Privacy header field | See table 7.4.6.2.2.4 | Call diversion information
Notification subscription options (NOTE) | See table 7.4.6.2.2.4 | +| hi-targeted-to-uri; Reason "headers" component as defined in IETF RFC 7044 [91] with cause parameter | See table 7.4.6.2.2.4 | Call diversion information
Redirecting reason (NOTE) | See table 7.4.6.2.2.4 | +| NOTE: Parameter shall only be supplied if hi-targeted-to-uri contains a Reason "headers" component, as defined in IETF RFC 7044 [91] with cause value as listed in table 7.4.6.2.2.4. | | | | + +The mapping described within table 7.4.6.2.2.8 can only appear if the communication has already undergone a Communications diversion in the IMS and the 180 (Ringing) is the first provisional response sent in backward direction. + +The O-MGCF can indicate the call diversion information in the mapping of 180 (Ringing) provisional response to a CPG message in fact if the response before was a 181 (Call Is Being Forwarded). + +**Table 7.4.6.2.2.9: Mapping of 180 (Ringing) $\Leftarrow$ CPG if ACM was already sent** + +| Source SIP header field and component | Source Component value | ISUP Parameter | Derived value of parameter field | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------|-------------------------------------------------------------------------------|----------------------------------| +| 180 (Ringing) response | | CPG | | +| | | Generic notification indicator
Notification indicator | Call is diverting | +| History-Info header field | | Event information
Event indicator | ALERTING | +| History-Info header field | See table 7.4.6.2.2.2 | Redirection number (NOTE) | See table 7.4.6.2.2.2 | +| Privacy "headers" component of the hi-targeted-to-uri or/and Privacy header field | See table 7.4.6.2.2.3 | Redirection number restriction (NOTE) | See table 7.4.6.2.2.3 | +| Privacy "headers" component of the hi-targeted-to-uri or/and Privacy header field | See table 7.4.6.2.2.4 | Call diversion information
Notification subscription options (NOTE) | See table 7.4.6.2.2.4 | +| hi-targeted-to-uri; Reason "headers" component as defined in IETF RFC 7044 [91] with cause parameter | See table 7.4.6.2.2.4 | Call diversion information
Redirecting reason (NOTE) | See table 7.4.6.2.2.4 | +| NOTE: Parameter shall only be supplied if hi-targeted-to-uri contains a Reason "headers" component, as defined in IETF RFC 7044 [91] with cause value as listed in table 7.4.6.2.2.4. | | | | + +The mapping in table 7.4.6.2.2.9 appears when a 181 (Call Is Being Forwarded) provisional response previously was mapped to an ACM. Therefore the state machine of the O-MGCF knows that a CDIV is in progress. + +**Table 7.4.6.2.2.10: Mapping of 200 (OK) response** + +| Source SIP header field and component | Source Component value | ISUP Parameter | Derived value of parameter field | +|-----------------------------------------------------------------------------------------------|------------------------|--------------------------------|----------------------------------| +| 200 (OK) response | | ANM/CON (NOTE) | | +| History-Info header field | See table 7.4.6.2.2.2 | Redirection number | See table 7.4.6.2.2.2 | +| Privacy "headers" component of the hi-targeted-to-uri or/and Privacy header field | See table 7.4.6.2.2.3 | Redirection number restriction | See table 7.4.6.2.2.3 | +| NOTE:Redirection number shall only be supplied if 200 (OK) response is mapped to ANM message. | | | | + +### 7.4.6.2.3 Interworking ISUP to SIP + +For the interworking of 180 (Ringing) response and 200 (OK) response (to the INVITE request) to the regarding ISUP messages and parameters no additional procedures beyond the basic call procedures are needed. + +To interwork the redirecting number at the O-MGCF it can be needed to create placeholder History-Info hi-entries. Such a History-Info hi-entry shall contain a hi-targeted-to-uri set to an "Unknown User Identity" (value "sip:unknown@unknown.invalid" as defined in 3GPP TS 23.003 [74]), a Reason "headers" component with a cause parameter, a hi-index and an "mp" header field parameter as described within table 7.4.6.2.3.1. + +**Table 7.4.6.2.3.1: Mapping of IAM to SIP INVITE request** + +| ISUP Parameter or IE | Derived value of parameter field | SIP component | Value | +|------------------------------|------------------------------------------|---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| IAM | | INVITE request | | +| Redirecting number | | History-Info header field | IF Redirection counter exceeds 1
hi-targeted-to-uri of the penultimate created hi-entry (NOTE 9)
IF Redirecting number is available
set to the value of the Redirecting number
ELSE
set to the Unknown User Identity (NOTE 10)
ELSE
no mapping (NOTE 8) | +| Nature of address indicator: | " national (significant) number " | hi-targeted-to-uri | Add CC (of the country where the MGCF is located) to Redirecting number Address Signals to construct E.164 number in URI. | +| | " international number " | | Map complete Redirecting number Address Signals to E.164 number in URI. | + +| ISUP Parameter or IE | Derived value of parameter field | SIP component | Value | +|-------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Address Signals | If NOA is " national (significant) number " then the format of the Address Signals is:
NDC + SN
If NOA is " international number " then the format of the Address Signals is:
CC + NDC + SN | hi-targeted-to-uri | Addr-spec
"+" CC NDC SN mapped to userinfo portion of SIP URI.
(NOTE 5)
Add "user=phone". | +| Redirecting number | APRI | Privacy "headers" component of the penultimate hi-targeted-to-uri entry in the History-Info header | Priv-value | +| | " presentation restricted " | | " history " | +| | " presentation allowed " | | Privacy header field absent or " none " (NOTE 3) | +| Redirection Information | Redirecting indicator | Privacy "headers" component of the penultimate hi-targeted-to-uri entry in the History-Info header | Priv-value | +| | Call diverted | | Privacy header field absent or " none " (NOTE 4) | +| | Call diverted, all redirection information presentation restricted | | " history " | +| Redirection Information | Redirection counter
1 | hi-index and "mp" header field parameter (NOTE 7) | Number of diversions is shown to the number of levels in hi-index.
Index for Original called number = 1
Index for Called party number = 1.1 and addition of "mp=1" | +| | 2 | | Index for Original called number = 1
Index for Redirecting number = 1.1 and addition of "mp=1"
Index for Called party number = 1.1.1 and addition of "mp=1.1" | +| | N | | Index for Original called number = 1
Placeholder History-Info hi-entry with Index = 1.1 and addition of "mp=1"
...
Fill up
...
Index for Redirecting number = 1.[[(N-1)* ".1"]] and addition of "mp" set to the hi-index value of the hi-targeted-to-uri that precede.
Index for Called party number = 1.N* ".1" (e.g. N=3 ( 1.1.1.1) and addition of "mp=1.[[(N-1)* ".1"]] | +| Redirection Information | Redirecting Reason and Original Redirection Reason (NOTE 1) | hi-targeted-to-uri; Reason "headers" component as defined in IETF RFC 7044 [91] with cause parameter.
For a placeholder History-Info hi-entry the value "404" shall be taken (NOTE 2). | Cause parameter value | +| | unknown/not available | | 404 | +| | unconditional | | 302 | +| | User Busy | | 486 | +| | No reply | | 408 | +| | Deflection during alerting | | 302 | + +| ISUP Parameter or IE | Derived value of parameter field | SIP component | Value | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | Deflection immediate response | Cause parameter for redirecting reason will be put in the entry of redirecting number, and cause parameter for original redirection reason will be put in the entry of original called number. | 302 | | +| | Mobile subscriber not reachable | | 503 | | +| Called Party Number | See Redirecting number
Nature of address indicator and Address signal | History-Info header field see hi-targeted-to-uri | URI of the last hi-targeted-to-uri entry of History-Info header field (NOTE 6) | | +| Original called number | See Redirecting number
Nature of address indicator and Address signal | History-Info header field see hi-targeted-to-uri | URI of first hi-targeted-to-uri entry of History-Info header field (NOTE 5, NOTE 9)
IF the Original called number is available:
set to the value of the Original called number
ELSE
IF the Redirection counter equals 1 AND the Redirecting number is available,
set to the value of the Redirecting number
ELSE
set to the Unknown User Identity (NOTE 10) | | +| Original called number | APRI | Privacy "headers" component of the first hi-targeted-to-uri entry of History-Info header | Priv-value | | +| | "presentation restricted" | | "history" | | +| | "presentation allowed" | | Privacy header field absent or "none" | | +| NOTE 1: Original Redirection Reason contains only the "unknown/not available" parameter | | | | | +| NOTE 2: For all History-Info hi-entries except the last one a cause parameter in Reason "headers" component as defined in IETF RFC 7044 [91] has to be included. | | | | | +| NOTE 3: If the Redirecting indicator has the value "Call diverted, all redirection information presentation restricted", the privacy value "history" shall be set. | | | | | +| NOTE 4: If the redirecting number APRI has the value "presentation restricted", the privacy value "history" shall be set. | | | | | +| NOTE 5: Used URI scheme shall be SIP URI. The Reason "headers" component with a cause parameter cannot be added if hi-targeted-to-uri is a tel URI. | | | | | +| NOTE 6: The used URI scheme can be tel or SIP since the last hi-targeted-to-uri entry of the History-Info header field does not contain the Reason "headers" component with a cause parameter. | | | | | +| NOTE 7: The hi-target-param defined in IETF RFC 7044 [91] defines the mp-param "mp" as a header field parameter that contains the value of the hi-index in the hi-entry with an hi-targeted-to-uri that reflects the Request-URI that was retargeted, thus identifying the "mapped from" target. Since the hi-entries are created based on the redirection counter to reflect the diverting/diverted-to entries, the hi-target-param "mp" shall be present in each entry except the first one. | | | | | +| NOTE 8: If the Original called number parameter is not available and if the value of the Redirecting counter is equal to one, the Redirecting number parameter is used for the first hi-targeted-to-uri entry of the History-Info header field. | | | | | +| NOTE 9: If a further SIP to ISUP interworking occurs, parameters not present in the original message can then be included. | | | | | +| NOTE 10: The "History-Info" header field may contain an "Unknown User Identity". An "Unknown User Identity" includes information that does not point to the served user and indicates that the user's identity is unknown. The encoding of the "Unknown User Identity" shall be as defined in 3GPP TS 23.003 [74]. | | | | | + +### 7.4.6.3 Interworking at the I-MGCF + +#### 7.4.6.3.1 General + +This clause describes the interworking of the Call Forwarding information at the I-MGCF. + +#### 7.4.6.3.2 Interworking from SIP to ISUP + +**Table 7.4.6.3.2.1: Mapping of SIP to ISUP messages** + +| Message received from SIP | Message send to BICC/ISUP | +|---------------------------|---------------------------| +| INVITE request | IAM | + +**Table 7.4.6.3.2.2: Mapping of History-Info header field to ISUP Redirecting number** + +| Source SIP header field and component | Source Component value | Redirecting number | Derived value of parameter field | +|-----------------------------------------------------------------------------------------------------------------------------------------------|------------------------|-----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| latest History-Info header field entry containing a Reason "headers" component as defined in IETF RFC 7044 [91] with cause parameter (NOTE 1) | | Redirecting number | | +| hi-targeted-to-uri appropriate global number portion of the URI, assumed to be in form "+" CC + NDC + SN | CC | Nature of address indicator | If CC is equal to the country code of the country where MGCF is located AND the next ISUP node is located in the same country, then set to " national (significant) number " else set to " international number " | +| | CC, NDC, SN | Address signals | If NOA is " national (significant) number " then set to NDC + SN.
If NOA is " international number " then set to CC + NDC + SN | +| Privacy header field or/and Privacy "headers" component of the hi-entry in History-Info header field as specified in this table (NOTE 2) | | APRI | If the priv-value " history " or " session " or " header " is received within the Privacy header field or if the priv-value " history " is received within the "headers" component of the hi-targeted-to-uri in the latest hi-entry containing a Reason "headers" component as defined in IETF RFC 7044 [91] with cause parameter, then " presentation restricted " shall be set.

Otherwise, " presentation allowed " shall be set. | + +NOTE 1: If the SIP URI doesn't contain "*user=phone*", mapping to redirecting number is impossible, therefore no need to generate Redirecting number. +NOTE 2: It is possible that an entry of the History-Info header field itself is marked as restricted or the whole History-Info header. + +**Table 7.4.6.3.2.3: Mapping of History-Info header to ISUP Redirection Information** + +| Source SIP header field and component | Source Component value | Redirection Information | Derived value of parameter field | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------|-----------------------------|----------------------------------------------------------------------------------------------------------------------| +| Privacy header field, and in History-Info header field in the Privacy "headers" component of the last hi-targeted-to-uri containing a Reason "headers" component as defined in IETF RFC 7044 [91] with cause parameter value as listed in the cause parameter row in this table | "history" or "session" or "header" for the Privacy SIP header or for the hi-targeted-to-uri entry | Redirecting indicator | Call diverted, all redirection information presentation restricted | +| | Privacy header field and the privacy component of the hi-targeted-to-uri entry either absent or set to "none" | | Call diverted | +| | | Original redirection reason | Unknown/not available | +| Cause parameter in the last hi-targeted-to-uri containing a Reason "headers" component as defined in IETF RFC 7044 [91] | Cause parameter value | Redirecting Reason | | +| | 302 | | Deflection immediate response | +| | 486 | | User busy | +| | 408 | | No reply | +| | 503 | | Mobile subscriber not reachable | +| | All other values | | unknown | +| History-Info header field | | Redirection counter | number of History-Info hi-entry(ies) containing a Reason "headers" component with a cause parameter (NOTE 1, NOTE 2) | + +NOTE 1: If the determined number of redirection in SIP exceeds the ISUP maximum parameter value, the MGCF shall set the Redirection counter to its maximum value. For instance, in ISUP ITU-T Q.763 [4], the Redirection counter parameter cannot exceed 5. + +NOTE 2: The Redirection counter value will be incremented regardless of the SIP URI format. + +**Table 7.4.6.3.2.4: Mapping of History-Info header field to ISUP Original Called number** + +| Source SIP header field and component | Source Component value | Original called number | Derived value of parameter field | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------|-----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | Numbering Plan Indicator | "ISDN (Telephony) numbering plan (Recommendation E.164)" | +| hi-targeted-to-uri of 1 st hi-targeted-to-uri containing a Reason "headers" component as defined in IETF RFC 7044 [91] with cause parameter; appropriate global number portion of the URI, assumed to be in form "+" CC + NDC + SN (NOTE 1) | CC | Nature of address indicator | If CC is equal to the country code of the country where MGCF is located AND the next ISUP node is located in the same country, then set to "national (significant) number" else set to "international number" | +| | CC, NDC, SN | Address signals | If NOA is "national (significant) number" then set to NDC + SN.
If NOA is "international number" then set to CC + NDC + SN | +| Privacy "headers" component in History-Info header field of the History-Info header field entry as defined above in this table (NOTE 2) | "history" or "session" or "header" | APRI | "presentation restricted" | +| | Privacy header field absent or "none" | | "presentation allowed" | + +NOTE 1: If it is SIP URI and doesn't contain "user=phone", mapping to Original Called number is impossible, therefore no need to generate Original Called number. + +NOTE 2: It is possible that an entry of the History-Info header field itself is marked as restricted or the whole History-Info header. + +**Table 7.4.6.3.2.5: Mapping of INVITE to IAM** + +| INVITE | | IAM | | +|---------------------------|-----------------------|-------------------------|-----------------------| +| History-Info header field | See table 7.4.6.3.2.2 | Redirecting number | See table 7.4.6.3.2.2 | +| History-Info header field | See table 7.4.6.3.2.3 | Redirection Information | See table 7.4.6.3.2.3 | +| History-Info header field | See table 7.4.6.3.2.4 | Original Called Number | See table 7.4.6.3.2.4 | + +## 7.4.6.3.3 Interworking from ISUP to SIP + +**Table 7.4.6.3.3.1: Mapping of ISUP to SIP Messages** + +| ←Message sent to SIP | ←Message Received from BICC/ISUP | | +|-------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------| +| 181 (Call Is Being Forwarded) | ACM no indication with Redirection number and Call diversion information parameters (CFU, CFB, Cdi) | See table 7.4.6.3.3.3 | +| 180 (Ringing) | ACM indicating ringing, OBCI: "Call diversion may occur" (CFNR, Cda) | See clause 7.2.3.1.4 | +| 181 (Call Is Being Forwarded) | CPG indicating progress or subsequent diversion indicated in the CPG with Redirection number and Call diversion information parameters (CFNR, Cda) | See table 7.4.6.3.3.4 | +| 180 (Ringing) | CPG indicating ringing and Redirection number restriction parameter | See table 7.4.6.3.3.5 | +| 200 (OK) | ANM and Redirection number restriction parameter | See table 7.4.6.3.3.6 | + +**Table 7.4.6.3.3.2: Mapping of ISUP Redirection Number Restriction to History-Info header field** + +| Redirection Number Restriction | Derived value of parameter field | SIP component | Value | +|---------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------|------------------------------------------------| +| Presentation restricted indicator | " Presentation restricted " | Privacy "headers" component of the hi-targeted-to-uri | " History " | +| | " Presentation allowed " or absent AND a previously received notification subscription options was NOT " presentation not allowed " OR was NOT " presentation allowed without redirection number " | | Privacy header field absent or " none " | + +**Table 7.4.6.3.3.3: Mapping of ACM 181 (Call Is Being Forwarded) response** + +| ISUP Parameter | Derived value of parameter field | SIP component | Value | +|-----------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------| +| Generic notification indicator
Notification indicator | Call is diverting | | | +| | | 1 st hi-entry of History-info header having an index = 1 (NOTE 1) | Unknown User Identity (NOTE 4) | +| Redirection number | | 2 nd hi-entry of History-Info header field having an index 1.1 | hi-targeted-to-uri: | +| Nature of address indicator: | " national (significant) number " | hi-targeted-to-uri | Add CC (of the country where the MGCF is located) to Redirection number Address Signals to construct E.164 number in URI. | +| | " international number " | | Map complete Redirection number Address Signals to E.164 number in URI. | +| Address Signals | If NOA is " national (significant) number " then the format of the Address Signals is:
NDC + SN
If NOA is " international number " then the format of the Address Signals is:
CC + NDC + SN | hi-targeted-to-uri | Addr-spec
"+" CC NDC SN mapped to userinfo portion of SIP URI (NOTE 3)
Add "user=phone". | +| Call diversion information | Redirecting Reason | Reason "headers" component as defined in IETF RFC 7044 [91] with cause parameter in the penultimate hi-entry (NOTE 2) | Cause parameter value | +| | Unknown | | 404 | +| | Unconditional | | 302 | +| | User busy | | 486 | +| | No reply | | 408 | +| | Deflection immediate response | | 302 | +| | Deflection during alerting | | 302 | +| | Mobile subscriber not reachable | | 503 | +| | Notification subscription options | Privacy "headers" component associated with Redirection number hi-targeted-to-uri (NOTE 2) | | +| | unknown | | Escaped Privacy value is set according to the rules of TS 24.604 [60] clause 4.5.2.6.4 item c | +| | presentation not allowed | | A 181 (Call Is Being Forwarded) shall not be sent | +| | presentation allowed with redirection number | | Escaped Privacy value is set according to the rules of TS 24.604 [60] clause 4.5.2.6.4 item c | +| | presentation allowed without redirection number | | Escaped Privacy value is set according to the rules of TS 24.604 [60] clause 4.5.2.6.4 item c | + +NOTE 1: It is necessary to create two History-Info header entries to carry both Redirection number and Call diversion information. Since the original called number is not available from the ISUP message a hi-targeted-to-uri set to an "Unknown User Identity" is included in the first entry. Only two entries are provided because the number of diversions is not available. + +NOTE 2: Needs to be stored for a possible inclusion into subsequent messages. + +NOTE 3: Used URI scheme shall be SIP URI. The Reason "headers" component with a cause parameter cannot be added if hi-targeted-to-uri is a tel URI. + +NOTE 4: The "History-Info" header field may contain an "Unknown User Identity". An "Unknown User Identity" includes information that does not point to the served user and indicates that the user's identity is unknown. The encoding of the "Unknown User Identity" shall be as defined in 3GPP TS 23.003 [74]. + +**Table 7.4.6.3.3.4: Mapping of CPG 181 (Call Is Being Forwarded) response** + +| ISUP Parameter | Derived value of parameter field | SIP component | Value | +|-----------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------| +| Event information
Event Indicator | Progress | | | +| Generic notification indicator
Notification indicator | Call is diverting | | | +| | | 1 st hi-entry of History-Info header having an index = 1 (NOTE 1) | Unknown User Identity (NOTE 4) | +| Redirection number | | 2 nd hi-entry of History-Info header field having an index = 1.1 | hi-targeted-to-uri: | +| Nature of address indicator | " national (significant) number " | hi-targeted-to-uri | Add CC (of the country where the MGCF is located) to Redirection number Address Signals to construct E.164 number in URI. | +| | " international number " | hi-targeted-to-uri | Map complete Redirection number Address Signals to E.164 number in URI. | +| Address Signals | If NOA is " national (significant) number " then the format of the Address Signals is:
NDC + SN
If NOA is " international number " then the format of the Address Signals is:
CC + NDC + SN | hi-targeted-to-uri | Addr-spec
"+" CC NDC SN mapped to userinfo portion of SIP URI (NOTE 3)
Add "user=phone". | +| Call diversion information | Redirecting Reason | Reason "headers" component as defined in IETF RFC 7044 [91] with cause parameter in the penultimate hi-entry (NOTE 2) | Cause parameter value | +| | Unknown | | 404 | +| | Unconditional | | 302 | +| | User busy | | 486 | +| | No reply | | 408 | +| | Deflection immediate response | | 302 | +| | Deflection during alerting | | 302 | +| | Mobile subscriber not reachable | | 503 | +| | Notification subscription options | Privacy "headers" component associated with Redirection number hi-targeted-to-uri (NOTE 2) | | +| | unknown | | Escaped Privacy value is set according to the rules of TS 24.604 [60] clause 4.5.2.6.4 item c | +| | presentation not allowed | | A 181 Call is Being Forwarded shall not be sent | +| | presentation allowed with redirection number | | Escaped Privacy value is set according to the rules of TS 24.604 [60] clause 4.5.2.6.4 item c | +| | presentation allowed without redirection number | | Escaped Privacy value is set according to the rules of TS 24.604 [60] clause 4.5.2.6.4 item c | + +NOTE 1: It is necessary to create two History-Info header entries to carry both Redirection number and Call diversion information. Since the original called number is not available from the ISUP message a hi-targeted-to-uri set to an "Unknown User Identity" is included in the first entry. Only two entries are provided because the number of diversions is not available. + +NOTE 2: Needs to be stored for a possible inclusion into subsequent messages. + +NOTE 3: Used URI scheme shall be SIP URI. The Reason "headers" component with a cause parameter cannot be added if hi-targeted-to-uri is a tel URI. + +NOTE 4: The "History-Info" header field may contain an "Unknown User Identity". An "Unknown User Identity" includes information that does not point to the served user and indicates that the user's identity is unknown. The + +| | +|-------------------------------------------------------------------------------------| +| encoding of the "Unknown User Identity" shall be as defined in 3GPP TS 23.003 [74]. | +|-------------------------------------------------------------------------------------| + +Table 7.4.6.3.3.5 addresses two separate conditions: the CPG message is received from the diverting exchange in which case the Call diversion information parameter is included; and the CPG message is received from the diverted-to exchange in which case the Call diversion information parameter is not included. Interworking for both conditions is shown. + +**Table 7.4.6.3.3.5: Mapping of CPG 180 (Ringing) response** + +| ISUP Parameter | Derived value of parameter field | SIP component | Value | +|-------------------------------------------------------|--------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------| +| Event information
Event Indicator | Alerting | | | +| | | 1 st hi-entry of History-Info header having an index = 1 (NOTE 1) | Unknown User Identity (NOTE 3) | +| Call diversion information | Redirecting Reason | Reason "headers" component as defined in IETF RFC 7044 [91] with cause parameter in the penultimate hi-entry (NOTE 2) | Cause parameter value | +| | Unknown | | 404 | +| | Unconditional | | 302 | +| | User busy | | 486 | +| | No reply | | 408 | +| | Deflection immediate response | | 302 | +| | Deflection during alerting | | 302 | +| | Mobile subscriber not reachable | | 503 | +| | Notification subscription options | Privacy "headers" component associated with Redirection number hi-targeted-to-uri (NOTE 2) | | +| | unknown | | Escaped Privacy value is set according to the rules of TS 24.604 [60] clause 4.5.2.6.4 item c | +| | presentation not allowed | | The 180 (Ringing) response shall be sent without the the History-Info header field included | +| | presentation allowed with redirection number | | Escaped Privacy value is set according to the rules of TS 24.604 [60] clause 4.5.2.6.4 item c | +| | presentation allowed without redirection number | | Escaped Privacy value is set according to the rules of TS 24.604 [60] clause 4.5.2.6.4 item c | +| Redirection number | | 2 nd hi-entry of History-Info header field having an index = 1.1 | See table 7.4.6.3.3.3 | +| If no Call diversion information parameter is present | | Reason "headers" component as defined in IETF RFC 7044 [91] with cause parameter in the penultimate hi-entry | Value stored from a previous received ACM or CPG. See tables 7.4.6.3.3.3 and 7.4.6.3.3.4 | +| | | Privacy "headers" component associated with Redirection number hi-targeted-to-uri | Value stored from a previous received ACM or CPG. See tables 7.4.6.3.3.3 and 7.4.6.3.3.4 | +| Redirection number restriction | | | See table 7.4.6.3.3.2 | + +NOTE 1: It is necessary to create two History-Info header entries to carry both Redirection number and Redirecting reason. Since the original called number is not available from the ISUP message a hi-targeted-to-uri set to an "Unknown User Identity" is included in the first entry. Only two entries are provided because the number of diversions is not available. + +NOTE 2: Needs to be stored for a possible inclusion into subsequent messages. + +NOTE 3: The "History-Info" header field may contain an "Unknown User Identity". An "Unknown User Identity" includes information that does not point to the served user and indicates that the user's identity is unknown. The encoding of the "Unknown User Identity" shall be as defined in 3GPP TS 23.003 [74]. + +**Table 7.4.6.3.3.6: Mapping of ANM & 200 (OK) response (to INVITE request)** + +| ISUP Parameter | Derived value of parameter field | SIP component | Value | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------|--------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------| +| | | 1 st hi-entry of History-Info header having an index = 1 (NOTE 1) | Unknown User Identity (NOTE 2) | +| Redirection number | | 2 nd hi-entry of History-Info header field having an index = 1.1 | See table 7.4.6.3.3.3 | +| | | Reason "headers" component as defined in IETF RFC 7044 [91] with cause parameter in the penultimate hi-entry | Value stored from a previously received ACM or CPG. See tables 7.4.6.3.3.3 and 7.4.6.3.3.4 | +| Redirection number restriction | | | See table 7.4.6.3.3.2 | +| NOTE 1: It is necessary to create two hi-entries of History-Info header field to carry both Redirection number and Redirecting reason. Since the original called number is not available from the ISUP message a hi-targeted-to-uri set to an "Unknown User Identity" is included in the first entry. Only two entries are provided because the number of diversions is not available. | | | | +| NOTE 2: The "History-Info" header field may contain an "Unknown User Identity". An "Unknown User Identity" includes information that does not point to the served user and indicates that the user's identity is unknown. The encoding of the "Unknown User Identity" shall be as defined in 3GPP TS 23.003 [74]. | | | | + +## 7.4.7 Void + +## 7.4.8 Explicit Call Transfer (ECT) + +When the MGCF receives a FAC message with Generic notification indicator coded as "Call transfer active" or "call transfer alerting" and a CPG with Generic notification indicator coded as "Remote hold" was received previously for the current communication, the action described in table 24be applies. In all other cases the actions of the MGCF at the ISUP/BICC side are described in ITU-T Recommendation Q.732.7 [42] under the clause "Interactions with other networks". + +**Table 24be: Mapping between ISUP and SIP for the Explicit Communication Transfer supplementary service** + +| ISUP message | Mapping | +|------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------| +| FAC with a "call transfer, active" or "call transfer, alerting" Generic notification indicator | As described for CPG message with a "remote retrieval" Generic notification indicator in Clause 7.4.10.2 | + +## 7.4.9 Call Waiting + +The actions of the MGCF at the ISUP/BICC side are described in ITU-T Q.733.1 [42] under the clause "Interactions with other networks". + +## 7.4.10 Call Hold + +The service is interworked as indicated in 3GPP TS 23.228 [12]. + +### 7.4.10.1 Session hold initiated from the IM CN subsystem side + +The IMS network makes a hold request by sending an UPDATE or re-INVITE request containing an SDP offer with: + +- an "*a=inactive*" SDP attribute if the stream was a "*recvonly*" media stream; or +- an "*a=sendonly*" SDP attribute if the stream was a "*sendrecv*" media stream. + +Upon receipt of the hold request from the IMS network, the MGCF shall send a CPG message to the CS side with a "remote hold" *Generic notification indicator*. Towards the IMS network the MGCF shall send a 200 OK final response containing an SDP answer with: + +- an "a=*inactive*" SDP attribute if the received SDP offer contained an "a=*inactive*" SDP attribute; or +- an "a=*recvonly*" SDP attribute if the received SDP offer contained an "a=*sendonly*" SDP attribute. + +To resume the session, the IMS network sends an UPDATE or re-INVITE request containing an SDP offer with: + +- an "a=*recvonly*" SDP attribute if the stream was an "*inactive*" media stream; or +- an "a=*sendrecv*" SDP attribute or without any direction SDP attribute ("a=*sendrecv*", "a=*recvonly*", "a=*sendonly*", "a=*inactive*") if the stream was a "*sendonly*" media stream. + +Upon receipt of the resume request from the IMS network, the MGCF shall send a CPG message to the CS side with a "remove retrieval" *Generic notification indicator*. Towards the IMS network the MGCF shall send a 200 OK final response containing an SDP answer with: + +- an "a=*sendonly*" SDP attribute if the received SDP offer contained an "a=*recvonly*" SDP attribute; or +- an "a=*sendrecv*" SDP attribute or without any direction SDP attribute ("a=*sendrecv*", "a=*recvonly*", "a=*sendonly*", "a=*inactive*") if the received SDP offer contained an "a=*sendrecv*" SDP attribute. + +However, the I-MGCF shall not send a CPG message upon reception of SDP offer containing "a=*inactive*" SDP attribute within an initial INVITE request establishing a new SIP dialogue and upon reception of the first subsequent SDP offer activating those media. + +The user plane interworking of the hold/resume request is described in the clause 9.2.9. + +![Sequence diagram showing session hold and resume initiated from the IM CN subsystem side. The diagram involves an MGCF and an external network. The hold sequence (steps 1-3) shows an UPDATE request with a=sendonly/inactive, a CPG (Hold) message to the CS side, and a 200 OK response. The resume sequence (steps 4-6) shows an UPDATE request with a=sendrecv/recvonly, a CPG (Retrieve) message to the CS side, and a 200 OK response.](b5680c2ca3226cafc7d42bb17bc07f8d_img.jpg) + +``` + +sequenceDiagram + participant IMS as IMS Network + participant MGCF as MGCF + participant CS as CS Network + + Note over IMS, MGCF: Hold Sequence + IMS->>MGCF: 1. SIP: UPDATE [SDP, a=sendonly/inactive] + MGCF->>CS: 2. BICC/ISUP: CPG (Hold) + MGCF->>IMS: 3. SIP: 200 OK [SDP] + + Note over IMS, MGCF: Resume Sequence + IMS->>MGCF: 4. SIP: UPDATE [SDP, a=sendrecv/recvonly] + MGCF->>CS: 5. BICC/ISUP: CPG (Retrieve) + MGCF->>IMS: 6. SIP: 200 OK [SDP] + +``` + +Sequence diagram showing session hold and resume initiated from the IM CN subsystem side. The diagram involves an MGCF and an external network. The hold sequence (steps 1-3) shows an UPDATE request with a=sendonly/inactive, a CPG (Hold) message to the CS side, and a 200 OK response. The resume sequence (steps 4-6) shows an UPDATE request with a=sendrecv/recvonly, a CPG (Retrieve) message to the CS side, and a 200 OK response. + +**Figure 30a: Session hold/resume initiated from the IM CN subsystem side** + +### 7.4.10.2 Session hold initiated from the CS network side + +If an MGCF receives a CPG message with a "remote hold" *Generic notification indicator* and there is no dialog established towards the IMS UE the MGCF shall send, when the first dialog is established, an UPDATE or re-INVITE request containing an SDP offer with: + +- an "*a=sendonly*" SDP attribute if the stream on this dialog was a "*sendrecv*" media stream; or +- an "*a=inactive*" SDP attribute if the stream on this dialog was a "*recvonly*" media stream, + +NOTE 1: If a media stream directionality towards the IMS UE was "*sendonly*" or "*inactive*" a call hold request is not interworked. + +as described in IETF RFC 3264 [36]. For an early dialog an UPDATE request shall be used. + +When an MGCF receives a CPG message with a "*remote hold*" *Generic notification indicator* and the media on the IMS side are "*sendrecv*" or "*recvonly*", the MGCF shall forward the hold request by sending an UPDATE request on the early dialog which was last established containing an SDP offer with: + +- an "*a=sendonly*" SDP attribute if the stream on this dialog was a "*sendrecv*" media stream;" or +- an "*a=inactive*" SDP attribute" if the stream on this dialog was a "*recvonly*" media stream, + +NOTE 2: If a media stream directionality towards the IMS UE was "*sendonly*" or "*inactive*" a call hold request is not interworked. + +as described in IETF RFC 3264 [36]. + +If an additional early dialog is established during the "*remote hold*" condition the MGCF shall send on this new dialog an UPDATE request containing an SDP offer with an "*a=sendonly*" or an "*a=inactive*" SDP attribute, depending on media stream directionality on this dialog, as described above. + +If an UPDATE request with an SDP offer is received on one of the early dialogs for a call in the "*remote hold*" condition the MGCF shall send an appropriate SDP answer. If the MGCF had not invoked a call hold service towards the IMS on that dialog before, the MGCF shall then send a new UPDATE request including an SDP offer with an "*a=sendonly*" or an "*a=inactive*" SDP attribute, depending on media stream directionality on this dialog, as described above. + +If an MGCF receives a 200 OK (INVITE) response on an early dialog for the call in a "*remote hold*" condition and if the MGCF on the dialog where 200 OK (INVITE) response was received had not invoked a call hold service before, the MGCF shall send an UPDATE or re-INVITE request (according to implementation option) containing an SDP offer with an "*a=sendonly*" or an "*a=inactive*" SDP attribute, depending on media stream directionality on this dialog, as described above. If the Contact header field of the received 200 OK (INVITE) response contained an "*isfocus*" media feature tag, defined in IETF RFC 3840 [135], the MGCF shall order the IM-MGW to disconnect the media towards the IMS. + +If the MGCF receives a CPG with *Generic Notification Indicator* "*remote hold*" and there is a confirmed dialog on IMS side then the MGCF shall send a SIP re-INVITE or UPDATE request (according to implementation option) containing an SDP offer with an "*a=sendonly*" or an "*a=inactive*" SDP attribute, depending on media stream directionality on this dialog, as described above. + +If the MGCF receives a CPG with a *Generic Notification Indicator* "*remote retrieval*" and there is an early dialog on IMS side then a SIP UPDATE request containing an SDP offer with: + +- an "*a=recvonly*" SDP attribute if the stream was an "*inactive*" media stream; or +- an "*a=sendrecv*" SDP attribute or without any direction SDP attribute ("*a=sendrecv*", "*a=recvonly*", "*a=sendonly*", "*a=inactive*") if the stream was a "*sendonly*" media stream, + +shall be sent if the call hold service had been invoked on this early dialog before. For each subsequent early dialog for which the MGCF receives an 18x response or an UPDATE request with an SDP offer, the MGCF shall send a SIP UPDATE request with the SDP offer indicating call retrieval (as described above) after a possible SDP answer to the SDP offer, if that dialog had received a call hold indication before. + +If the MGCF receives a CPG with *Generic Notification Indicator* "*remote retrieval*" and there is a confirmed dialog on IMS side then a SIP re-INVITE or UPDATE request (according to implementation option) containing an SDP offer with: + +- an "*a=recvonly*" SDP attribute if the stream was an "*inactive*" media stream; or + +- an "*a=sendrecv*" SDP attribute if the stream was a "*sendonly*" media stream, + +shall be sent for this dialog only if the call hold service had been invoked for this dialog before. + +If link aliveness information is required at the IM-MGW while the media are on hold, and RTCP was previously disabled the MGCF should provide modified SDP RR and RS bandwidth modifiers specified in IETF RFC 3556 [59] within the UPDATE or re-INVITE request holding and retrieving the media to temporarily enable RTCP while the media are on hold, as detailed in clause 7.3.1 of 3GPP TS 26.114 [104]. If no link aliveness information is required at the IM-MGW or RTCP was previously enabled, the MGCF should provide the SDP RR and RS bandwidth modifiers previously used. + +The interworking does not impact the user plane with the following exceptions: + +- the MGCF provides modified SDP RR and RS bandwidth modifiers within the UPDATE or re-INVITE request; +- the Contact header of the IMS remote party contains the "*isfocus*" media feature tag; or +- the MGCF has identified a speech call as an "ICS call" as specified in clause 7.2.3.1.2.12 or in clause 7.2.3.2.7a. + +If the MGCF provides modified SDP RR and RS bandwidth modifiers to the IMS side, the MGCF shall also provide modified SDP RR and RS bandwidths to the IM-MGW, as described in the clause 9.2.10. + +If there is a confirmed dialog on the IMS side for which the MGCF received the Contact header of the IMS remote party (in the initial INVITE request or in the 200 OK (INVITE) response) with the "*isfocus*" media feature tag, defined in IETF RFC 3840 [135], then upon reception of the CPG message with: + +- a "*remote hold*" *Generic notification indicator* the MGCF shall request the IM-MGW to suspend sending media towards the IMS side; or +- a "*remote retrieval*" *Generic notification indicator* the MGCF shall request the IM-MGW to re-establish communication towards the IMS network if the MGCF requested the IM-MGW to suspend sending media on the "*remote hold*" request, + +prior to sending of the UPDATE or re-INVITE request to the IMS side. + +NOTE 3: If a participant of a conference invokes a hold request, it is not desirable to provide an announcement to the conference. + +For a speech call that is identified as the "ICS call", upon reception of the CPG message with: + +- a "*remote hold*" *Generic notification indicator* the MGCF shall request the IM-MGW to suspend sending media towards the IMS side; or +- a "*remote retrieval*" *Generic notification indicator* the MGCF shall request the IM-MGW to re-establish communication towards the IMS network if the MGCF requested the IM-MGW to suspend sending media on the "*remote hold*" request, + +prior to sending of the UPDATE or re-INVITE request to the IMS side. + +![Sequence diagram for Figure 30b: Session hold/resume initiated from the CS network side. The diagram shows two parts: a hold session and a resume session. In the hold session, a BICC/ISUP CPG (Hold) message is received by the MGCF, which then sends a SIP UPDATE [SDP, a=sendonly/inactive] to the remote party, receiving a SIP 200 OK [SDP] in response. In the resume session, a BICC/ISUP CPG (Retrieve) message is received by the MGCF, which then sends a SIP UPDATE [SDP, a=sendrecv/recvonly] to the remote party, receiving a SIP 200 OK [SDP] in response.](b0384c8e0ff826a8116ab2ff67dadc43_img.jpg) + +``` + +sequenceDiagram + participant CS as CS Network Side + participant MGCF + participant Remote + + Note left of MGCF: Hold Session + CS->>MGCF: 1. BICC/ISUP: CPG (Hold) + MGCF->>Remote: 2. SIP: UPDATE [SDP, a=sendonly/inactive] + Remote-->>MGCF: 3. SIP: 200 OK [SDP] + + Note left of MGCF: Resume Session + CS->>MGCF: 4. BICC/ISUP: CPG (Retrieve) + MGCF->>Remote: 5. SIP: UPDATE [SDP, a=sendrecv/recvonly] + Remote-->>MGCF: 6. SIP: 200 OK [SDP] + +``` + +Sequence diagram for Figure 30b: Session hold/resume initiated from the CS network side. The diagram shows two parts: a hold session and a resume session. In the hold session, a BICC/ISUP CPG (Hold) message is received by the MGCF, which then sends a SIP UPDATE [SDP, a=sendonly/inactive] to the remote party, receiving a SIP 200 OK [SDP] in response. In the resume session, a BICC/ISUP CPG (Retrieve) message is received by the MGCF, which then sends a SIP UPDATE [SDP, a=sendrecv/recvonly] to the remote party, receiving a SIP 200 OK [SDP] in response. + +**Figure 30b: Session hold/resume initiated from the CS network side** + +#### 7.4.11 Call Completion on busy subscriber + +The actions of the MGCF at the ISUP/BICC side are described in ITU-T Recommendation Q.733.3 [42] under the clause "Interactions with other networks". + +#### 7.4.12 Completion of Calls on No Reply (CCNR) + +The actions of the MGCF at the ISUP/BICC side are described in ITU-T Recommendation Q.733.5 [42] under the clause "Interactions with other networks". + +#### 7.4.13 Terminal Portability (TP) + +Terminal Portability is defined as an ISUP supplementary service within ITU-T Rec. Q.733.4. [42]. + +A Suspend message containing the Suspend/Resume indicators set to "ISDN subscriber initiated" shall be treated like a CPG with "remote hold" in Clause 7.4.10. Resume message containing the Suspend/Resume indicators set to "ISDN subscriber initiated" shall be treated like a CPG with "remote retrieval" in Clause 7.4.10. + +#### 7.4.14 Conference calling (CONF) / Three-Party Service (3PTY) + +The default behaviour of the MGCF at the ISUP/BICC side is described in ITU-T Recommendation Q.734.1[42] under the clause "Interactions with other networks". In addition, the MGCF may apply the interworking from ISUP to SIP described in Table 24aa. + +Alternatively, the MGCF may apply the interworking to the Conference supplementary service described in clause 7.5.6. + +**Table 24aa: Mapping between ISUP and SIP for the Conference Calling (CONF) and Three-Party Service (3PTY) supplementary service** + +| ISUP message | Mapping | +|---------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------| +| CPG with a "Conference established" Generic notification indicator | As described for CPG message with a "remote retrieval" Generic notification indicator in Clause 7.4.10.2 | +| CPG with a "Conference disconnected" Generic notification indicator | As described for CPG message with a "remote retrieval" Generic notification indicator in Clause 7.4.10.2 | +| CPG with an "isolated" Generic notification indicator | As described for CPG message with a "remote hold" Generic notification indicator in Clause 7.4.10.2 | +| CPG with a "reattached" Generic notification indicator | As described for CPG message with a "remote retrieval" Generic notification indicator in Clause 7.4.10.2 | + +## 7.4.15 Void + +## 7.4.16 Closed User Group (CUG) + +The actions of the MGCF at the ISUP/BICC side are described in ITU-T Recommendation Q.735.1[42] under the clause 1.5.2.4.2 "Exceptional procedures". + +## 7.4.17 Multi-Level Precedence and Pre-emption (MLPP) + +The actions of the MGCF at the ISUP/BICC side are described in ITU-T Recommendation Q.735.3 [42] under the clause "Interactions with other networks". + +## 7.4.18 Global Virtual Network Service (GVNS) + +The actions of the MGCF at the ISUP/BICC side are described in ITU-T Recommendation Q.735.6 [42] under the clause "Interactions with other networks". + +## 7.4.19 International telecommunication charge card (ITCC) + +An International Telecommunication charge card call is a basic call and no additional treatment is required by the MGCF. + +## 7.4.20 Reverse charging (REV) + +The actions of the MGCF at the ISUP/BICC side are described in ITU-T Recommendation Q.736.3 [42] under the clause "Interactions with other networks". + +## 7.4.21 User-to-User Signalling (UUS) + +### 7.4.21.0 General + +Procedures for the ISDN supplementary service "User-to-user signalling" are specified in ITU-T Recommendation Q.737.1 [42]. + +### 7.4.21.1 User-to-User Signalling (UUS) service 1 (implicit) + +#### 7.4.21.1.0 General + +The coding of the User-user information element is described within ITU-T Recommendation Q.931 [149]. The User-user information element is carried within the ISDN user part parameter user-to-user information, as defined in ITU-T Recommendation Q.763 [4]. The User-to-User header field is defined within IETF RFC 7433 [99]. A package for interworking user-to-user information with the ISDN is defined by IETF RFC 7434 [99A]. + +#### 7.4.21.1.1 Void + +#### 7.4.21.1.2 User-to-user information Interworking from SIP to ISUP + +On the receipt of a User-to-User header field with the "*purpose*" header field parameter set to "*isdn-uui*", or a User-to-User header field without a "*purpose*" parameter, with "*encoding*" header field parameter set to "*hex*" or without an "*encoding*" parameter, with "*content*" header field parameter set to "*isdn-uui*" or without a "*content*" parameter, that is valid as defined by IETF RFC 7434 [99A], the MGCF shall map the content of the "*uui-data*" field to the "*protocol discriminator*" and "*user information*" parameters of the User-user information element. + +The "*length of user-user contents*" parameter shall be set by the MGCF according to the normal procedures. + +The MGCF maps the messages transporting the user-to-user information according to the normal interworking procedures (see table 24ab). + +**Table 24ab: Mapping of the User-to-User header field to the ISUP user-to-user information parameter** + +| SIP parameter | | ISUP parameter | | +|------------------|------------------------|---------------------|---------------------------------------------| +| SIP header field | Source component value | ISUP parameter name | ISUP parameter field | +| User-to-User | uui-data | User-to-user | Protocol discriminator and user information | + +#### 7.4.21.1.3 User-to-user information Interworking from ISUP to SIP + +On the receipt of the user-to-user information parameter the MGCF shall map the protocol discriminator and user information parameter fields to the uui-data field of the User-to-User header field (see table 24ac). + +If sent, the "*purpose*", "*content*" and "*encoding*" header field parameters are not mapped and are set in accordance with IETF RFC 7434 [99A] + +The MGCF maps the messages transporting the user-to-user information parameters according to the normal interworking procedures. + +**Table 24ac: Mapping of the ISUP user-to-user information parameter to the User-to-User header field** + +| ISUP parameter | | SIP parameter | | +|--------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------|------------------|------------------------| +| ISUP parameter name | ISUP parameter field | SIP header field | Source component value | +| User-to-user | Protocol discriminator and user information | User-to-User | uui-data (NOTE) | +| NOTE: The MGCF shall always send uui-data as a token (see IETF RFC 7433 [99]). The letters used for the hex digits shall always be capital form. | | | | + +#### 7.4.21.2 User-to-User Signalling (UUS) service 1 (explicit) + +The actions of the MGCF at the ISUP/BICC side are described in ITU-T Recommendation Q.737.1 [42] under the clause "Interaction with other networks". + +#### 7.4.21.3 User-to-User Signalling (UUS) service 2 (explicit) + +The actions of the MGCF at the ISUP/BICC side are described in ITU-T Recommendation Q.737.1 [42] under the clause "Interaction with other networks". + +#### 7.4.21.4 User-to-User Signalling (UUS) service 3 (explicit) + +The actions of the MGCF at the ISUP/BICC side are described in ITU-T Recommendation Q.737.1 [42] under the clause "Interaction with other networks". + +### 7.4.22 Multiple Subscriber Number (MSN) + +A MSN call is a basic call and no additional treatment is required by the MGCF. + +## 7.4.23 Anonymous Call rejection + +### 7.4.23.0 General + +The Anonymous Call rejection (ACR) supplementary service in the CS domain is described within 3GPP TS 23.088 [134]. The ETSI ACR service is described within ETSI EN 300 356-21 [71]. + +### 7.4.23.1 ISUP-SIP protocol interworking at the I-MGCF + +If ISUP Cause Value field in the ISUP REL includes Cause Value 24 *"call rejected due to feature at the destination"* the I-MGCF shall map this to a 433 (Anonymity Disallowed) SIP response code as described in RFC 5079 [77]. + +### 7.4.23.2 SIP-ISUP protocol interworking at the O-MGCF + +SIP response code 433 (Anonymity Disallowed) shall be mapped to the ISUP Cause Value field 24 *"call rejected due to feature at the destination"* in the ISUP REL. + +## 7.4.24 Customized Alerting Tones (CAT) in the 3GPP CS domain + +The Customized Alerting Tones (CAT) in the 3GPP CS domain service is described in 3GPP TS 23.205 [27]. + +To pass CAT early media from the CS network towards the IM CN subsystem, no special interworking procedures beyond basic call at the I-MGCF are required. The procedure to supply the "P-Early-Media" header field is described in clause 7.2.3.1.4, clause 7.2.3.1.4A and clause 7.2.3.1.4B. + +## 7.5 IMS Supplementary Services + +The following clauses describe the MGCF behaviour related to supplementary services as defined in ITU-T Recommendations Q.730 to ITU-T Q.737 [42] when interworking with an IMS which uses a Multimedia Telephony Application Server (MTAS) providing supplementary services according to 3GPP TS 24.173 [88]. The support of the related procedures is optional. + +### 7.5.1 Originating Identification Presentation (OIP) and Originating Identification Restriction (OIR) + +The mapping of Originating Identification Presentation (OIP) and Originating Identification Restriction (OIR); supplementary service with the CLIP/CLIR PSTN/ISDN Supplementary Service is the same mapping as described in clause 7.4.1. The Service itself is described within 3GPP TS 24.607 [63]. + +### 7.5.2 Terminating Identification Presentation (TIP) and Terminating Identification Restriction (TIR) + +#### 7.5.2.1 General + +The protocol specification of the Terminating Identification Presentation and Terminating Identification Restriction supplementary services is described in 3GPP TS 24.608 [64]. + +The procedures for mapping of the connected number described within clause 7.4.2 shall apply. + +#### 7.5.2.2 Interworking at the O-MGCF + +For the mapping of IAM to the INVITE request: + +If an Optional forward call indicators parameter in the IAM is received where the bit H Connected line identity request indicator is set to "requested", then the option tag "from-change" shall be add to the Supported header field. See table 7.5.2.2.1. + +**Table 7.5.2.2.1: Mapping of ISUP IAM to SIP INVITE request** + +| ISUP Parameter | Derived value of parameter field | Source SIP header field and component | Source Component value | +|---------------------------------|------------------------------------------------------------------------|---------------------------------------|------------------------| +| Optional forward call indicator | Connected line identity request indicator is set to "requested" | Supported | "from-change" | + +NOTE: The presence of "from-change" enables the reception of Generic Number with Number qualifier parameter field set to additional connected, if available. As per 3GPP TS 24.608 [64] the presence of "from-change" tag is not a criterion for TIP service. + +If a provisional or final response including the option tag "from-change" is received, then the O-MGCF shall: + +- if a 200 (OK) response to the INVITE request is received, start timer $T_{TIR1}$ ; and +- store the 200 (OK) response, without interworking it. + +Otherwise the 200 (OK) response (to the INVITE request) shall be mapped as described in clause 7.2.3.2.7a. + +If an UPDATE request is received containing a changed From header field before the timer $T_{TIR1}$ expired, then the O-MGCF shall: + +- stop timer $T_{TIR1}$ ; +- map the From header field received in the UPDATE request to the Generic number in the ANM as shown in table 7.5.2.2.2 and table 7.5.2.2.3; +- if the UPDATE request includes a P-Asserted-Identity header field that is different from the one within the stored 200 (OK) response, the latest received P-Asserted-Identity header field shall be mapped to the connected number as described table 24; and +- map the parameters needed to be mapped of the stored 200 (OK) response to an ANM as described in clause 7.4.2.2.3, modified by the changed mapping steps of the From and P-Asserted-Identity header fields. + +When $T_{TIR1}$ expires, then the stored 200 (OK) response (to the INVITE request) response shall be mapped as described in clause 7.4.2.2.3. + +**Table 7.5.2.2.2: Mapping of SIP UPDATE request to ISUP ANM/CON** + +| ANM/CON | UPDATE | +|----------------|-------------------| +| Generic number | From header field | + +**Table 7.5.2.2.3: Mapping of SIP From header field to ISUP Generic Number ("additional connected number") parameter** + +| Source SIP header field and component | Source component value | Generic Number parameter field | Derived value of parameter field | +|-------------------------------------------------------------------------|-----------------------------|--------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| - | - | Number Qualifier Indicator | "additional connected number" | +| From, userinfo component of URI assumed to be in form "+" CC + NDC + SN | CC | Nature of Address Indicator | If CC is equal to the country code of the country where I-MGCF is located AND the next ISUP node is located in the same country, then set to "national (significant) number" else set to "international number" | +| - | - | Number Incomplete Indicator | "complete" | +| - | - | Numbering Plan Indicator | "ISDN (Telephony) numbering plan (Recommendation E.164)" | +| Privacy, priv-value component | Privacy header field absent | Address Presentation Restricted Indicator (APRI) | "presentation allowed" | +| | "none" | | "presentation allowed" | +| | "header" | | "presentation allowed" | +| | "user" | | "presentation restricted" | +| | "id" | | "presentation allowed" | +| - | - | Screening Indicator | "user provided, not verified" | +| From, userinfo component assumed to be in form "+" CC + NDC + SN | CC, NDC, SN | Address Signals | If NOA is "national (significant) number" then set to NDC + SN.
If NOA is "international number" then set to CC + NDC + SN | + +### 7.5.2.3 Interworking at the I-MGCF + +For the mapping of INVITE request to IAM: + +- the bit H *Connected line identity request indicator* of the Optional forward call indicators parameter in the IAM shall be set to "requested". + +**Table 7.5.2.3.1: Void** + +If a received ISUP ANM includes an ISUP Generic Number ("additional connected number") parameter, then the I-MGCF shall send a 200 (OK) response (to the INVITE request) including an option tag "from-change" If the initial INVITE was received and the Supported header field contains the "from-change" tag, the 200 (OK) response is followed by an UPDATE request, containing the "additional connected number" copied into the From header field as shown in table 7.5.2.3.2. + +The To header field of the UPDATE request is derived from the P-Asserted-Identity header field received within the initial INVITE request. + +**Table 7.5.2.3.2: Mapping of ANM Generic Number ("additional connected number") to SIP From header field in a SIP UPDATE request** + +| ISUP Parameter/field | Value | SIP component | Value | +|---------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|------------------------------------------------------------------------------------------------------------------------------------| +| Generic Number Number Qualifier Indicator | " additional connected number " | From header field | display-name (optional) and addr-spec | +| Nature of Address Indicator | " national (significant) number " | Addr-spec | Add "+" CC (of the country where the IWU is located) to Generic Number Address Signals then map to user portion of URI scheme used | +| | " international number " | | Map complete Generic Number Address Signals used prefixed with a "+" to user portion of URI scheme used | +| Address Presentation restriction indicator (APRI) | " presentation allowed " | | No Privacy header field or not " user " | +| | " presentation restricted " | | " user " | +| Address Signals | if NOA is " national (significant) number " then the format of the address signals is:
NDC + SN
If NOA is " international number " then the format of the address signals is:
CC + NDC + SN | Display-name (optional) | display-name shall be mapped from Address Signals, if network policy allows it | +| | | Addr-spec | "+" CC NDC SN mapped to user portion of URI scheme used | + +A received connected number in an ANM shall be mapped to the P-Asserted-Identity header field as shown in table 21 of the UPDATE request. + +## 7.5.2.4 Timer + +**Table 7.5.2.4.1 TIR timer definition** + +| Symbol | Timeout value | Cause for initiation | Normal termination | At expiry | +|-------------------|----------------------------------------------------|------------------------------------------------------------------------------------|-----------------------------|----------------------------------| +| T TIR1 | 100 - 2000 milliseconds (default 100 milliseconds) | On receipt of provisional or final response including the option tag "from-change" | At the receipt of an UPDATE | map the received 200OK to an ANM | + +## 7.5.3 void + +## 7.5.4 Communication Diversion (CDIV) + +### 7.5.4.1 General + +The protocol specification of the Communication Diversion supplementary service is described in 3GPP TS 24.604 [60]. The mapping of Communication Diversion supplementary service with Call Diversion services PSTN/ISDN supplementary service including the mapping of the optional History-Info header field as defined in IETF RFC 7044 [91] is described. + +The hi-target-param "mp" header field parameter as defined in IETF RFC 7044 [91] indicates that the target of the Request-URI was changed. + +In case of interworking with networks which do not provide any notification of the communication diversion or communication redirection information (e.g. redirection counter) in the signalling system, the communication continues according to the basic call procedures. + +In case of interworking with networks not supporting IETF RFC 7044 [91] the "mp" header field parameter may not appear. + +## 7.5.4.2 Interworking at the O-MGCF + +### 7.5.4.2.1 General + +For the mapping of IAM to the INVITE request no additional procedures beyond the basic call and interworking procedures are needed unless Call Diversion services within the ISUP Network appeared as described in clause 7.5.4.2.2. + +With regard to the backward messages the following mapping is valid. + +**Table 7.5.4.2.1.1: Mapping of SIP messages to ISUP messages** + +| ←Message sent to ISUP | ←Message Received from SIP | | +|-------------------------------------------|----------------------------------------------------------------------------------------------------------------|------------------------| +| ACM indicating call forwarding | 181 (Call Is Being Forwarded) response | See table 7.5.4.2.1.6 | +| CPG indicating call forwarding (see NOTE) | 181 (Call Is Being Forwarded) response | See table 7.5.4.2.1.7 | +| ACM indicating ringing | 180 (Ringing) response | See table 7.5.4.2.1.8 | +| CPG indicating alerting (see NOTE) | 180 (Ringing) response | See table 7.5.4.2.1.9 | +| ANM | 200 (OK) response | See table 7.5.4.2.1.10 | +| CON | 200 (OK) response (Neither a 181 (Call Is Being Forwarded) response nor a 180 (Ringing) response was received) | See table 7.5.4.2.1.10 | + +NOTE: A CPG will be sent if an ACM was already sent. + +**Table 7.5.4.2.1.2: Mapping of History-Info header field to ISUP Redirection number** + +| Source SIP header field and component | Source Component value | Redirection number | Derived value of parameter field | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------|-----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| hi-targeted-to-uri of the last History-Info hi-entry containing a "cause" URI parameter, as defined in IETF RFC 4458 [113].
(NOTE 2) | CC | Nature of address indicator | If CC is equal to the country code of the country where O-MGCF is located AND the next ISUP node is located in the same country, then set to " national (significant) number " else set to " international number ". | +| The global number portion of the hi-targeted-to-uri is assumed to be in form "+" CC + NDC + SN.
(NOTE 1) | CC, NDC, SN | Address signals | If NOA is " national (significant) number " then set to NDC + SN.
If NOA is " international number " then set to CC + NDC + SN. | +| NOTE 1: If the SIP URI doesn't contain " user=phone ", mapping to redirection number is impossible, therefore no need to generate Redirection number and Redirection number restriction parameter (per table 7.5.4.2.1.3), Notification subscription options can't be set as "presentation allowed with redirection number". | | | | +| NOTE 2: The hi-target-param parameter set to "mp" as defined in IETF RFC 7044 [91] indicates that the target of the Request-URI was changed and appears in this hi-targeted-to-uri. In case of interworking with networks not supporting IETF RFC 7044 [91] the "mp" header field parameter may not appear. | | | | + +**Table 7.5.4.2.1.3: Mapping of History-Info header field to ISUP Redirection number restriction** + +| Source SIP header field and component | Source Component value | Redirection number restriction | Derived value of parameter field | +|-----------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------|-----------------------------------|-------------------------------------------| +| Privacy "headers" component of the hi-targeted-to-uri or/and Privacy header field | " history " or " session " or " header " | Presentation restricted indicator | " Presentation restricted " | +| | Privacy "headers" component of the hi-targeted-to-uri and Privacy header field absent or " none " | | " Presentation allowed " or absent | + +**Table 7.5.4.2.1.4: Mapping of hi-targeted-to-uri to ISUP Call diversion information** + +| Source SIP header field and component | Source Component value | Call diversion information | Derived value of parameter field | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------|-----------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| Privacy "headers" component of the hi-targeted-to-uri or/and Privacy header field | | Notification subscription options |

If the priv-value "history" or "session" or "header" is received within the Privacy header field or the priv-value "history" is received within the "headers" component of the hi-targeted-to-uri representing the diverting URI(s) and within the hi-targeted-to-uri representing diverted-to URI then "presentation not allowed" shall be set.

Otherwise, if the priv-value "history" is received only within the "headers" component of the hi-targeted-to-uri representing the diverted-to URI then "presentation allowed without redirection number" shall be set. (NOTE 1, NOTE 2)

Otherwise, "presentation allowed with redirection number" shall be set.

| | +| "cause" URI parameter, as defined in IETF RFC 4458 [113] of the last History-Info hi-entry containing hi-targeted-to-uri with "cause" URI parameter. (NOTE 3) | Cause value | Redirecting reason | | | +| | 404 | | Unknown | | +| | 302 | | Unconditional | | +| | 486 | | User busy | | +| | 408 | | No reply | | +| | 480 | | Deflection immediate response | | +| | 503 | | Mobile subscriber not reachable | | +| | 487 | | Deflection during alerting | | +| NOTE 1: diverting URI corresponds to the hi-targeted-to-uri of the hi-entry containing a hi-index value that match the "mp" header field parameter value of the diverted-to URI. If the diverted-to URI does not contain the "mp" header field parameter, the diverting URI corresponds to the hi-targeted-to-uri of the hi-entry before the last hi-entry containing "cause" URI parameter. | | | | | +| NOTE 2: diverted-to URI corresponds to the hi-targeted-to-uri of the last hi-entry containing "cause" URI parameter and is mapped to the Redirection number, see table 7.5.4.2.1.2. | | | | | +| NOTE 3: The hi-target-param parameter set to "mp" as defined in IETF RFC 7044 [91] indicates that the target of the Request-URI was changed and appears in this hi-targeted-to-uri. In case of interworking with networks not supporting IETF RFC 7044 [91] the "mp" header field parameter may not appear. | | | | | + +Table 7.5.4.2.1.5: Void + +Table 7.5.4.2.1.6: Mapping of 181 (Call Is Being Forwarded) $\leftarrow$ ACM if no ACM was sent before + +| Source SIP header field and component | Source Component value | ISUP Parameter | Derived value of parameter field | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------|------------------------------------------------------------------------|----------------------------------| +| 181 (Call Is Being Forwarded) | | ACM | | +| | | Generic notification indicator
Notification indicator | Call is diverting | +| History-Info header field | See table 7.5.4.2.1.2 | Redirection number | See table 7.5.4.2.1.2 | +| Privacy "headers" component of the hi-targeted-to-uri or/and Privacy header field | See table 7.5.4.2.1.3 | Redirection number restriction | See table 7.5.4.2.1.3 | +| Privacy "headers" component of the hi-targeted-to-uri or/and Privacy header field | See table 7.5.4.2.1.4 | Call diversion information
Notification subscription options | See table 7.5.4.2.1.4 | +| hi-targeted-to-uri; "cause" URI parameter as defined in IETF RFC 4458 [113] of the last History-Info hi-entry containing such "cause" URI parameter. (NOTE) | See table 7.5.4.2.1.4 | Call diversion information
Redirecting reason | See table 7.5.4.2.1.4 | +| NOTE: The hi-target-param parameter set to "mp" as defined in IETF RFC 7044 [91] indicates that the target of the Request-URI was changed and appears in this hi-targeted-to-uri. In case of interworking with networks not supporting IETF RFC 7044 [91] the "mp" header field parameter may not appear. | | | | + +**Table 7.5.4.2.1.7: Mapping of 181 (Call Is Being Forwarded) © CPG if ACM was already sent** + +| Source SIP header field and component | Source Component value | ISUP Parameter | Derived value of parameter field | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------|----------------------------------| +| 181 (Call Is Being Forwarded) response | | CPG | | +| | | Generic notification indicator
Notification indicator | Call is diverting | +| "cause" URI parameter, as defined in IETF RFC 4458 [113] of the last History-Info hi-entry containing hi-targeted-to-uri with "cause" URI parameter. (NOTE 2) | 486 | Event information
Event indicator | CFB (national use) | +| | 408 (see NOTE 1) | | CFNR (national use) | +| | 302 | | CFU (national use) | +| | Any other value, or if appropriate "national use" value (CFB, CFNR or CFU) is not used in a network. or if no agreement exists between operators to use these values, or if no hi-targeted-to-uri with "cause" URI parameter is contained in the SIP 181. | | PROGRESS | +| History-Info header field | See table 7.5.4.2.1.2 | Redirection number | See table 7.5.4.2.1.2 | +| Privacy "headers" component of the hi-targeted-to-uri or/and Privacy header field | See table 7.5.4.2.1.3 | Redirection number restriction | See table 7.5.4.2.1.3 | +| Privacy "headers" component of the hi-targeted-to-uri or/and Privacy header field | See table 7.5.4.2.1.4 | Call diversion information
Notification subscription options | See table 7.5.4.2.1.4 | +| hi-targeted-to-uri; "cause" URI parameter, as defined in IETF RFC 4458 [113] of the last History-Info hi-entry containing such "cause" URI parameter. (NOTE 2) | See table 7.5.4.2.1.4 | Call diversion information
Redirecting reason | See table 7.5.4.2.1.4 | + +NOTE 1: This appears in the cases of CFNR. +NOTE 2: The hi-target-param parameter set to "mp" as defined in IETF RFC 7044 [91] indicates that the target of the Request-URI was changed and appears in this hi-targeted-to-uri. In case of interworking with networks not supporting IETF RFC 7044 [91] the "mp" header field parameter may not appear. + +**Table 7.5.4.2.1.8: Mapping of 180 (Ringing) & ACM if no ACM was sent before** + +| Source SIP header field and component | Source Component value | ISUP Parameter | Derived value of parameter field | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------|----------------------------------| +| 180 (Ringing) response | | ACM | | +| History-Info header field | If hi-targeted-to-uri of at least one History-Info hi-entry contains a "cause" URI parameter, as defined in IETF RFC 4458 [113]. | Generic notification indicator
Notification indicator | Call is diverting | +| History-Info header field | See table 7.5.4.2.1.2 | Redirection number
(NOTE 1) | See table 7.5.4.2.1.2 | +| Privacy "headers" component of the hi-targeted-to-uri or/and Privacy header field | See table 7.5.4.2.1.3 | Redirection number restriction (NOTE 1) | See table 7.5.4.2.1.3 | +| Privacy "headers" component of the hi-targeted-to-uri or/and Privacy header field | See table 7.5.4.2.1.4 | Call diversion information
Notification subscription options (NOTE 1) | See table 7.5.4.2.1.4 | +| hi-targeted-to-uri; "cause" URI parameter, as defined in IETF RFC 4458 [113] of the last History-Info hi-entry containing such "cause" URI parameter. (NOTE 2) | See table 7.5.4.2.1.4 | Call diversion information
Redirecting reason (NOTE 1) | See table 7.5.4.2.1.4 | +| NOTE 1: Parameter shall only be supplied if hi-targeted-to-uri of at least one History-Info hi-entry contains a "cause" URI parameter, as defined in IETF RFC 4458 [113]. | | | | +| NOTE 2: The hi-target-param parameter set to "mp" as defined in IETF RFC 7044 [91] indicates that the target of the Request-URI was changed and appears in this hi-targeted-to-uri. In case of interworking with networks not supporting IETF RFC 7044 [91] the "mp" header field parameter may not appear. | | | | + +The mapping described within table 7.5.4.2.1.8 can only appear if the communication has already undergone a Communications diversion in the IMS and the 180 (Ringing) is the first provisional response sent in backward direction. + +The O-MGCF can indicate the call diversion information in the mapping of the 180 (Ringing) provisional response to a CPG message in fact if the response before was a 181 (Call Is Being Forwarded). + +**Table 7.5.4.2.1.9: Mapping of 180 (Ringing) & CPG if ACM was already sent** + +| Source SIP header field and component | Source Component value | ISUP Parameter | Derived value of parameter field | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------|----------------------------------| +| 180 (Ringing) response | | CPG | | +| History-Info header field | If hi-targeted-to-uri of at least one History-Info hi-entry contains a "cause" URI parameter, as defined in IETF RFC 4458 [113]. | Generic notification indicator
Notification indicator | Call is diverting | +| | | Event information
Event indicator | ALERTING | +| History-Info header field | See table 7.5.4.2.1.2 | Redirection number
(NOTE 1) | See table 7.5.4.2.1.2 | +| Privacy "headers" component of the hi-targeted-to-uri or/and Privacy header field | See table 7.5.4.2.1.3 | Redirection number restriction (NOTE 1) | See table 7.5.4.2.1.3 | +| Privacy "headers" component of the hi-targeted-to-uri or/and Privacy header field | See table 7.5.4.2.1.4 | Call diversion information
Notification subscription options (NOTE 1) | See table 7.5.4.2.1.4 | +| hi-targeted-to-uri; "cause" URI parameter, as defined in IETF RFC 4458 [113] of the last History-Info hi-entry containing such "cause" URI parameter. (NOTE 2) | See table 7.5.4.2.1.4 | Call diversion information
Redirecting reason (NOTE 1) | See table 7.5.4.2.1.4 | +| NOTE 1: Parameter shall only be supplied if hi-targeted-to-uri of at least one History-Info hi-entry contains a "cause" URI parameter, as defined in IETF RFC 4458 [113]. | | | | +| NOTE 2: The hi-target-param parameter set to "mp" as defined in IETF RFC 7044 [91] indicates that the target of the Request-URI was changed and appears in this hi-targeted-to-uri. In case of interworking with networks not supporting IETF RFC 7044 [91] the "mp" header field parameter may not appear. | | | | + +The mapping in table 7.5.4.2.1.9 appears when a 181 (Call Is Being Forwarded) provisional response previously was mapped to an ACM. Therefore the state machine of the O-MGCF knows that a CDIV is in progress. + +**Table 7.5.4.2.1.10: Mapping of 200 (OK) response** + +| Source SIP header field and component | Source Component value | ISUP Parameter | Derived value of parameter field | +|------------------------------------------------------------------------------------------------|------------------------|--------------------------------|----------------------------------| +| 200 (OK) response | | ANM/CON | | +| History-Info header field | See table 7.5.4.2.1.2 | Redirection number(NOTE) | See table 7.5.4.2.1.2 | +| Privacy "headers" component of the hi-targeted-to-uri or/and Privacy header field | See table 7.5.4.2.1.3 | Redirection number restriction | See table 7.5.4.2.1.3 | +| NOTE: Redirection number shall only be supplied if 200 (OK) response is mapped to ANM message. | | | | + +## 7.5.4.2.2 Call Diversion within the ISUP Network appeared + +The following scenario shows if a Call Diversion service appears in the ISUP/PSTN and the diverted-to number is within the SIP network. Table 7.5.4.2.2.1 should be seen as an example. + +For the mapping of 180 (Ringing) response and 200 (OK) response (to the INVITE request) to the regarding ISUP messages and parameters no additional procedures beyond the basic call procedures are needed. + +To interwork the redirecting number at the O-MGCF it can be needed to create placeholder History-Info hi-entries. Such a History-Info hi-entry shall contain a hi-targeted-to-uri set to an "Unknown User Identity" (value "sip:unknown@unknown.invalid" as defined in 3GPP TS 23.003 [74]), a "cause" URI parameter, a hi-index and an "mp" header field parameter as described within table 7.5.4.2.2.1. + +Table 7.5.4.2.2.1: Mapping of IAM to SIP INVITE request + +| ISUP Parameter or IE | Derived value of parameter field | SIP component | Value | +|-----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| IAM | | INVITE request | | +| Redirecting number | | History-Info header field | IF Redirection counter exceeds 1
hi-targeted-to-uri of the
penultimate created hi-entry
(NOTE 9)
IF Redirecting number is
available
set to the value of the
Redirecting number
ELSE
set to the Unknown User
Identity (NOTE 10)
ELSE
no mapping (NOTE 8) | +| Nature of address indicator | " national (significant) number " | hi-targeted-to-uri | Add CC (of the country where the MGCF is located) to Redirecting number Address Signals to construct E.164 number in URI. | +| | " international number " | | Map complete Redirecting number Address Signals to E.164 number in URI. | +| Address Signals | If NOA is " national (significant) number " then the format of the Address Signals is:
NDC + SN
If NOA is " international number " then the format of the Address Signals is:
CC + NDC + SN | hi-targeted-to-uri | Addr-spec
"+" CC NDC SN mapped to userinfo portion of SIP URI. (NOTE 5)
Add "user=phone". | +| Redirecting number | APRI | Privacy header field that corresponds to the penultimate hi-targeted-to-uri entry in the History-Info header | Priv-value | +| | " presentation restricted " | | " history " | +| | " presentation allowed " | | Privacy header field absent or " none " (NOTE 3) | +| Redirection information | Redirecting indicator | Privacy header field that corresponds to the penultimate hi-targeted-to-uri entry in the History-Info header | Priv-value | +| | Call diverted | | Privacy header field absent or " none " (NOTE 4) | +| | Call diverted, all redirection information presentation restricted | | " history " | +| Redirection information | Redirection counter
1 | hi-index and "mp" header field parameter (NOTE 7) | Number of diversions is shown to the number of levels in hi-index
Index for Original called number = 1
Index for Called party number = 1.1 and addition "mp=1" | +| | 2 | | Index for Original called number = 1
Index for Redirecting number = 1.1 and addition of "mp=1"
Index for Called party number = 1.1.1 and addition of "mp=1.1" | +| | N | | Index for Original called number = 1
Placeholder History entry with Index = 1.1 and addition of "mp=1"
...
Fill up
...
Index for Redirecting number = 1.
[(N-1)* ".1"] and addition of "mp"
header field parameter set to the hi-index value of the hi-targeted-to-uri | + +| ISUP Parameter or IE | Derived value of parameter field | SIP component | Value | +|-------------------------|--------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | that precede.
Index for Called party number = 1.N* ".1" (e.g. N=3 → 1.1.1.1) and addition of mp=1.[(N-1)*].1 | +| Redirection information | Redirecting reason and Original redirection reason (NOTE 1) | hi-targeted-to-uri; "cause" URI parameter, as defined in IETF RFC 4458 [113].
The Redirecting reason shall be mapped to the last hi-targeted-to-uri.
If the redirection counter is 2 or higher, the Original redirection Reason shall be mapped to the second hi-targeted-to-uri.
If the redirection counter is 3 or higher, for each hi-targeted-to-uri following a placeholder History-Info hi-entry the value "404" shall be taken (NOTE 2) | cause value | +| | unknown/not available | | 404 | +| | unconditional | | 302 | +| | User Busy | | 486 | +| | No reply | | 408 | +| | Deflection during alerting | | 487 | +| | Deflection immediate response | | 480 | +| | Mobile subscriber not reachable | | 503 | +| Called party number | See Redirecting number
Nature of address indicator and Address signal | History-Info header field see hi-targeted-to-uri | URI of the last hi-targeted-to-uri entry of History-Info header field | +| Original called number | See Redirecting number
Nature of address indicator and Address signal | History-Info header field see hi-targeted-to-uri | URI of first hi-targeted-to-uri entry of History-Info header field (NOTE 6, NOTE 9)
IF the Original called number is available:
set to the value of the Original called number
ELSE
IF the Redirection counter equals 1 AND the Redirecting number is available,
set to the value of the Redirecting number
ELSE
set to the Unknown User Identity (NOTE 10) | +| Original called number | APRI | Privacy header field of the first hi-targeted-to-uri entry of History-Info header | Priv-value | +| | "presentation restricted" | | "history" | +| | "presentation allowed" | | Privacy header field absent or "none" | + +| ISUP Parameter or IE | Derived value of parameter field | SIP component | Value | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------|---------------|-------| +| NOTE 1: Original redirection reason contains only the "unknown/not available" value.
NOTE 2: For all History-Info hi-entries except the first one a "cause" URI parameter as defined in IETF RFC 4458 [113] has to be included.
NOTE 3: If the Redirecting indicator has the value " Call diverted, all redirection information presentation restricted ", the privacy value " history " shall be set.
NOTE 4: If the Redirecting number APRI has the value " presentation restricted ", the privacy value " history " shall be set.
NOTE 5: Used URI scheme shall be SIP URI. The "cause" URI parameter cannot be added if hi-targeted-to-uri is a tel URI.
NOTE 6: The used URI scheme can be tel URI or SIP URI since the first hi-targeted-to-uri entry of the History-Info header field does not contain the "cause" URI parameter.
NOTE 7: The hi-target-param defined in IETF RFC 7044 [91] defines the "mp" as a header field parameter that contains the value of the hi-index in the hi-entry with an hi-targeted-to-uri that reflects the Request-URI that was retargeted, thus identifying the "mapped from" target. Since the hi-entries are created based on the redirection counter to reflect the diverting/diverted-to entries, the hi-target-param "mp" header field parameter shall be present in each entry except the first one.
NOTE 8: If the Original called number parameter is not available and if the value of the Redirecting counter is equal to one, the Redirecting number parameter is used for the first hi-targeted-to-uri entry of the History-Info header field.
NOTE 9: If a further SIP to ISUP interworking occurs, parameters not present in the original message can then be included.
NOTE 10: The "History-Info" header field may contain an "Unknown User Identity". An "Unknown User Identity" includes information that does not point to the served user and indicates that the user's identity is unknown. The encoding of the "Unknown User Identity" shall be as defined in 3GPP TS 23.003 [74]. | | | | + +### 7.5.4.3 Interworking at the I-MGCF + +**Table 7.5.4.3.1: Mapping of SIP to ISUP messages** + +| Message received from SIP | Message send to BICC/ISUP | +|---------------------------|---------------------------| +| INVITE request | IAM | + +**Table 7.5.4.3.2: Mapping of History-Info header field to ISUP Redirecting number** + +| Source SIP header field and component | Source Component value | Redirecting number | Derived value of parameter field | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------|-----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| In History-Info SIP header field, hi-targeted-to-uri in hi-entry having a hi-index that match the "mp" header field parameter value of the last hi-entry containing an "mp" header field parameter and a "cause" URI parameter, as defined in IETF RFC 4458 [113]. (NOTE 1) (NOTE 3) | | Redirecting number | | +| hi-targeted-to-uri appropriate global number portion of the URI, assumed to be in form "+" CC + NDC + SN | CC | Nature of address indicator | If CC is equal to the country code of the country where MGCF is located AND the next ISUP node is located in the same country, then set to " national (significant) number " else set to " international number " | +| | CC, NDC, SN | Address signals | If NOA is " national (significant) number " then set to NDC + SN.
If NOA is " international number " then set to CC + NDC + SN | +| Privacy header field or/and priv-value component of the hi-entry in History-Info header field (NOTE 2) | | APRI | If the priv-value " history " or " session " or " header " is received within the Privacy header field or if the priv-value " history " is received within the "headers" component of the hi-targeted-to-uri in hi-entry before last hi-entry containing a "cause" URI parameter then " presentation restricted " shall be set.

Otherwise, " presentation allowed " shall be set. | + +NOTE 1: If the SIP URI doesn't contain "*user=phone*", mapping to redirecting number is impossible, therefore no need to generate Redirecting number. + +NOTE 2: It is possible that an entry of the History-Info header field itself is marked as restricted or the whole History-Info header. + +NOTE 3: The hi-target-param parameter set to "mp" as defined in IETF RFC 7044 [91] indicates that the target of the Request-URI was changed and appears in the hi-targeted-to-uri. In case of interworking with networks not supporting IETF RFC 7044 [91] the "mp" header field parameter may not appear. If the "mp" header field parameter is missing in the last hi-entry containing a "cause" URI parameter as defined in IETF RFC 4458 [113], the hi-entry to use is the entry just before. + +**Table 7.5.4.3.3: Mapping of History-Info header to ISUP Redirection information** + +| Source SIP header field and component | Source Component value | Redirection information | Derived value of parameter field | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------|-----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------| +| Privacy header field and priv-value of hi-entry having a hi-index that match the "mp" header field parameter value of the last hi-entry containing an "mp" header field parameter and a "cause" URI parameter as defined in IETF RFC 4458 [113] of the History-Info header field. (NOTE 3) | "history" or "session" or "header" for the Privacy header field or for the hi-targeted-to-uri entry | Redirecting indicator | Call diverted, all redirection information presentation restricted | +| | Privacy header field and the privacy component of the hi-targeted-to-uri entry either absent or "none" | | Call diverted | +| | | Original redirection reason | Unknown/not available | +| Cause value in the last hi-targeted-to-uri containing a "cause" URI parameter as defined in IETF RFC 4458 [113] (NOTE 3) | Cause parameter value | Redirecting reason | Redirecting reason | +| | 404 | | Unknown/not available | +| | 302 | | Unconditional | +| | 486 | | User busy | +| | 408 | | No reply | +| | 480 | | Deflection immediate response | +| | 487 | | Deflection during alerting | +| | 503 | | Mobile subscriber not reachable | +| History-Info header field | | Redirection counter | number of History-Info hi-entry(ies) containing a "cause" URI parameter with value as listed as cause parameter value in this table (NOTE 1, NOTE 2) | + +NOTE 1: If the determined number of redirection in SIP exceeds the ISUP maximum parameter value, the MGCF shall set the Redirection counter to its maximum value. For instance, in ISUP ITU-T Q.763 [4], the Redirection counter parameter cannot exceed 5. + +NOTE 2: The Redirection counter value will be incremented regardless of the SIP URI format. + +NOTE 3: The hi-target-param parameter set to "mp" as defined in IETF RFC 7044 [91] indicates that the target of the Request-URI was changed and appears in the hi-targeted-to-uri. In case of interworking with networks not supporting IETF RFC 7044 [91] the "mp" header field parameter may not appear. If the "mp" header field parameter is missing in the last hi-entry containing a "cause" URI parameter as defined in IETF RFC 4458 [113], the hi-entry to use is the entry just before. + +**Table 7.5.4.3.4: Mapping of History-Info header field to ISUP Original called number** + +| Source SIP header field and component | Source Component value | Original called number | Derived value of parameter field | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------|-----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | Numbering Plan Indicator | "ISDN (Telephony) numbering plan (Recommendation E.164)" | +| hi-targeted-to-uri of hi-entry having a hi-index that match the "mp" header field parameter value of the first hi-targeted-to-uri containing an "mp" header field parameter and a "cause" URI parameter, as defined in IETF RFC 4458 [113]; the global number portion of the URI, is assumed to be in form "+" CC + NDC + SN (NOTE 1) (NOTE 3) | CC | Nature of address indicator | If CC is equal to the country code of the country where MGCF is located AND the next ISUP node is located in the same country, then set to " national (significant) number " else set to " international number " | +| | CC, NDC, SN | Address signals | If NOA is " national (significant) number " then set to NDC + SN.
If NOA is " international number " then set to CC + NDC + SN | +| priv-value component in History-Info header field of the History-Info header field entry as defined above in this table (NOTE 2) | " history " or " session " or " header " | APRI | " presentation restricted " | +| | Privacy header field absent or " none " | | " presentation allowed " | + +NOTE 1: If it is SIP URI and doesn't contain "*user=phone*", mapping to Original called number is impossible, therefore no need to generate Original called number. + +NOTE 2: It is possible that an entry of the History-Info header field itself is marked as restricted or the whole History-Info header. + +NOTE 3: The hi-target-param parameter set to "*mp*" as defined in IETF RFC 7044 [91] indicates that the target of the Request-URI was changed and appears in the hi-targeted-to-uri. In case of interworking with networks not supporting IETF RFC 7044 [91] the "*mp*" header field parameter may not appear. If the "*mp*" header field parameter is missing in the first hi-entry containing a "*cause*" URI parameter as defined in IETF RFC 4458 [113], the hi-entry to use is the hi-entry preceding the first hi-entry containing the "*cause*" URI parameter. + +**Table 7.5.4.3.5: Mapping of INVITE to IAM** + +| INVITE | | IAM | | +|---------------------------|---------------------|-------------------------|---------------------| +| History-Info header field | See table 7.5.4.3.2 | Redirecting number | See table 7.5.4.3.2 | +| History-Info header field | See table 7.5.4.3.3 | Redirection information | See table 7.5.4.3.3 | +| History-Info header field | See table 7.5.4.3.4 | Original called number | See table 7.5.4.3.4 | + +**Table 7.5.4.3.6: Mapping of ISUP to SIP Messages** + +| ←Message sent to SIP | ←Message Received from BICC/ISUP | | +|-----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| 181 (Being forwarded) | ACM no indication with Redirection number and Call diversion information parameters (CFU, CFB, Cdi) | See table 7.5.4.3.8 | +| 180 (Ringing) | ACM indicating ringing, oBCi: " Call diversion may occur " (CFNR, Cda) | See subclause 7.2.3.1.4 | +| 181 (Being forwarded) | CPG indicating progress or subsequent diversion indicated in the CPG with Redirection number and Call diversion information parameters (CFNR, Cda) | See table 7.5.4.3.9 | +| 180 (Ringing) | CPG indicating ringing and Redirection number restriction parameter | See table 7.5.4.3.10 | +| 200 (OK) | ANM and Redirection number restriction parameter | See table 7.5.4.3.11 | + +**Table 7.5.4.3.7: Mapping of ISUP Redirection number restriction to History-Info header field** + +| Redirection number restriction | Derived value of parameter field | SIP component | Value | +|-----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------|------------------------------------------------| +| Presentation restricted indicator | " Presentation restricted " | privacy "headers" component of the hi-targeted-to-uri | " history " | +| | " presentation allowed " or absent AND any previously received notification subscription options was NOT " presentation not allowed " AND was NOT " presentation allowed without redirection number " | | Privacy header field absent or " none " | + +**Table 7.5.4.3.8: Mapping of ACM (Call Is Being Forwarded) response** + +| ISUP Parameter | Derived value of parameter field | SIP component | Value | +|-----------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------| +| Generic notification indicator
Notification indicator | Call is diverting | | | +| Redirection number | | History-Info header field with one hi-entry and the hi-target-param "mp" header field parameter | hi-targeted-to-uri: | +| Nature of address indicator: | " national (significant) number " | hi-targeted-to-uri | Add CC (of the country where the MGCF is located) to Redirection number Address Signals to construct E.164 number in URI. | +| | " international number " | | Map complete Redirection number Address Signals to E.164 number in URI. | +| Address Signals | If NOA is " national (significant) number " then the format of the Address Signals is:
NDC + SN
If NOA is " international number " then the format of the Address Signals is:
CC + NDC + SN | hi-targeted-to-uri | Addr-spec
"+" CC NDC SN mapped to userinfo portion of SIP URI. (NOTE 2)
Add "user=phone". | +| Call diversion information | Redirecting reason | IETF RFC 4458 [113] | cause value | +| | Unknown | "cause" URI parameter in the hi-targeted-to-uri (NOTE 1) | 404 | +| | Unconditional | | 302 | +| | User busy | | 486 | +| | No reply | | 408 | +| | Deflection immediate response | | 480 | +| | Deflection during alerting | | 487 | +| | Mobile subscriber not reachable | | 503 | +| | Notification subscription options | privacy "headers" component of the hi-targeted-to-uri (NOTE 1) | | +| | unknown | | Escaped Privacy value is set according to the rules of 3GPP TS 24.604 [60] subclause 4.5.2.6.4 item c | +| | presentation not allowed | | A 181 Being Forwarded shall not be sent | +| | presentation allowed with redirection number | | Escaped Privacy value is set according to the rules of 3GPP TS 24.604 [60] subclause 4.5.2.6.4 item c | +| | presentation allowed without redirection number | | Escaped Privacy value is set according to the rules of 3GPP TS 24.604 [60] subclause 4.5.2.6.4 item c | + +NOTE 1: Needs to be stored for a possible inclusion into subsequent messages. + +NOTE 2: Used URI scheme shall be SIP URI. The "cause" URI parameter cannot be added if hi-targeted-to-uri is a tel URI. + +Table 7.5.4.3.9: Mapping of CPG & 181 (Call Is Being Forwarded) response + +| ISUP Parameter | Derived value of parameter field | SIP component | Value | +|-----------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------| +| Event information
Event Indicator | PROGRESS | | | +| Generic notification indicator
Notification indicator | Call is diverting | | | +| Redirection number | | History-Info header field with one hi-entry and the hi-target-param "mp" header field parameter | hi-targeted-to-uri: | +| Nature of address indicator | " national (significant) number " | hi-targeted-to-uri | Add CC (of the country where the MGCF is located) to Redirection number Address Signals to construct E.164 number in URI. | +| | " international number " | hi-targeted-to-uri | Map complete Redirection number Address Signals to E.164 number in URI. | +| Address Signals | If NOA is " national (significant) number " then the format of the Address Signals is:
NDC + SN
If NOA is " international number " then the format of the Address Signals is:
CC + NDC + SN | hi-targeted-to-uri | Addr-spec
"+" CC NDC SN mapped to userinfo portion of SIP URI.
(NOTE 2)
Add "user=phone". | +| Call diversion information | Redirecting reason | IETF RFC 4458 [113] | cause value | +| | Unknown | "cause" URI parameter in the hi-targeted-to-uri (NOTE 1) | 404 | +| | Unconditional | | 302 | +| | User busy | | 486 | +| | No reply | | 408 | +| | Deflection immediate response | | 480 | +| | Deflection during alerting | | 487 | +| | Mobile subscriber not reachable | | 503 | +| | Notification subscription options | privacy "headers" component of the hi-targeted-to-uri (NOTE 1) | | +| | unknown | | Escaped Privacy value is set according to the rules of 3GPP TS 24.604 [60] subclause 4.5.2.6.4 items c | +| | presentation not allowed | | A 181 Being Forwarded shall not be sent | +| | presentation allowed with redirection number | | Escaped Privacy value is set according to the rules of 3GPP TS 24.604 [60] subclause 4.5.2.6.4 items c | +| | presentation allowed without redirection number | | Escaped Privacy value is set according to the rules of 3GPP TS 24.604 [60] subclause 4.5.2.6.4 items c | + +NOTE 1: Needs to be stored for a possible inclusion into subsequent messages. + +NOTE 2: Used URI scheme shall be SIP URI. The "cause" URI parameter cannot be added if hi-targeted-to-uri is a tel URI. + +Table 7.5.4.3.10 addresses two separate conditions: the CPG is received from the diverting exchange in which case the Call diversion information parameter is included; and the CPG is received from the diverted-to exchange in which case the Call diversion information parameter is not included. Interworking for both conditions is shown. + +Table 7.5.4.3.10: Mapping of CPG < 180 (Ringing) response + +| ISUP Parameter | Derived value of parameter field | SIP component | Value | +|-------------------------------------------------------|--------------------------------------------------------|-------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------| +| Event information
Event Indicator | ALERTING | | | +| Redirection number | | History-Info header field with one hi-entry and the hi-target-param "mp" header field parameter | See table 7.5.4.3.8 | +| Call diversion information | Redirecting reason | IETF RFC 4458 [113]
"cause" URI parameter in the hi-targeted-to-uri (NOTE 1) | cause value | +| | Unknown | | 404 | +| | Unconditional | | 302 | +| | User busy | | 486 | +| | No reply | | 408 | +| | Deflection immediate response | | 480 | +| | Deflection during alerting | | 487 | +| | Mobile subscriber not reachable | | 503 | +| | Notification subscription options | | | +| | unknown | | Escaped Privacy value is set according to the rules of 3GPP TS 24.604 [60] subclause 4.5.2.6.4 item c | +| | presentation not allowed | privacy "headers" component of the hi-targeted-to-uri (NOTE 1) | The 180 Ringing response shall be sent without the History-Info header field included | +| | presentation allowed with redirection number | | Escaped Privacy value is set according to the rules of 3GPP TS 24.604 [60] subclause 4.5.2.6.4 item c | +| | presentation allowed without redirection number | | Escaped Privacy value is set according to the rules of 3GPP TS 24.604 [60] subclause 4.5.2.6.4 item c | +| If no Call diversion information parameter is present | | IETF RFC 4458 [113]
"cause" URI parameter in the hi-targeted-to-uri | Value stored from a previously received ACM or CPG. See tables 7.5.4.3.8 and 7.5.4.3.9. | +| | | privacy "headers" component of the hi-targeted-to-uri | Value stored from a previously received ACM or CPG. See tables 7.5.4.3.8 and 7.5.4.3.9. | +| Redirection number restriction (NOTE 2) | | | See table 7.5.4.3.7 | + +NOTE 1: Needs to be stored for a possible inclusion into subsequent messages. + +NOTE 2: This parameter may appear without call diversion information parameter and redirection number. In such cases, the O-MGCF shall send the previously sent and stored History-Info header field and set the priv-value in the History-Info header field as described in table 7.5.4.3.7. + +**Table 7.5.4.3.11: Mapping of ANM & 200 (OK) response (to INVITE request)** + +| ISUP Parameter | Derived value of parameter field | SIP component | Value | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------|-------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------| +| Redirection number | | History-Info header field with one hi-entry and the hi-target-param "mp" header field parameter | See table 7.5.4.3.8 | +| | | IETF RFC 4458 [113] "cause" URI parameter in the hi-targeted-to-uri | Value stored from a previous received ACM or CPG. See tables 7.5.4.3.8 and 7.5.4.3.9. | +| Redirection number restriction (NOTE) | | | See table 7.5.4.3.7 | +| NOTE: This parameter may appear without Call diversion information parameter and Redirection number. In such cases, the O-MGCF shall send the previously sent and stored History-Info header field and set the priv-value in the History-Info header field as described in table 7.5.4.3.7. | | | | + +## 7.5.5 Communication Hold (HOLD) + +The mapping of Communication Hold supplementary service with Call Hold PSTN/ISDN Supplementary Service is the same mapping as described in clause 7.4.10. The Service itself is described within 3GPP TS 24.610 [65]. + +## 7.5.6 Conference call (CONF) + +### 7.5.6.1 General + +The protocol description of the CONF supplementary service is described in 3GPP TS 24.605 [61]. In this clause the interworking from the conference event package in accordance with IETF RFC 4575 [100] to the messages of the PSTN/ISDN CONF supplementary service is described. Note that an interworking from the PSTN/ISDN to the IMS is out of scope. + +### 7.5.6.2 Subscribing for the conference event package + +Based on local policy, the MGCF may subscribe for the conference event package on behalf of the PSTN/ISDN participant after the participant joins or is added to a conference. + +When the conference event package option is implemented, and one of the following events occurs at the MGCF: + +- a 200 (OK) response is received as a response to an initial INVITE request originated by the MGCF, where the Contact header field contains an "isfocus" parameter; or +- an ACK message is received which acknowledges a 200 (OK) response to the initial INVITE request, and the initial INVITE request is originated by the conferencing AS and contains an "isfocus" parameter in the Contact header field; + +then the following steps shall be performed: + +- 1) a SUBSCRIBE request shall be created according to IETF RFC 4575 [100], using the updated procedures from IETF RFC 6665 [138]; +- 2) the Request URI is set to the Contact address of the conferencing AS; +- 3) the P-Asserted-Identity header field, the From header field and the Privacy header field are set with the same value as: + - the P-Asserted-Identity header field, the From header field and the Privacy header field in the initial INVITE request originated by the MGCF; or + - the P-Asserted-Identity header field, the To header field and the Privacy header field in a 1xx or 2xx response sent by the MGCF to the initial INVITE request from the conferencing AS. + +### 7.5.6.3 Interworking the notification + +NOTE: There is a need to differentiate between the procedures of interworking for a full and a partial type of notification. + +When a full type of notification is received a check is made of the content. If the changes with respect a previous version of the notification have not been sent on to the PSTN/ISDN for this session, the MGCF shall perform an ISUP interaction towards the PSTN/ISDN. If the changes with respect a previous version of the notification have been sent to the PSTN/ISDN for this session, the MGCF shall not perform an ISUP interaction towards the PSTN/ISDN. + +When a partial notification is received then it is assumed that a value of a received notification has changed, so the MGCF performs an ISUP interaction towards the PSTN/ISDN, as follows: + +- Conference established: + +Upon the receipt of a conference information document with the element *active* is set to "true", the MGCF shall send a CPG message to the PSTN/ISDN with a notification "*conference established*". + +- Participant added: + +Upon the receipt of a conference information document with the and the element *status of endpoint-status-type* is set to "connected" and it was not set to "on-hold" before and the Contact URI in the element *entity* is not the address of the served PSTN/ISDN participant, the MGCF shall send a CPG message to the PSTN/ISDN with a notification "*other party added*". + +- Served PSTN/ISDN participant isolated: + +Upon the receipt of a conference information document with the and the element *status of endpoint-status-type* is set to "on-hold" and it was set to "connected" before and the Contact URI in the element *entity* is the address of the served PSTN/ISDN participant, the MGCF shall send a CPG message to the PSTN/ISDN with a notification "*isolated*". + +- Other participant isolated: + +Upon the receipt of a conference information document with the and the element *status of endpoint-status-type* is set to "on-hold" and it was set to "connected" before and the Contact URI in the element *entity* is not the address of the served PSTN/ISDN participant, the MGCF shall send a CPG message to the PSTN/ISDN with a notification "*other party isolated*". + +- Served PSTN/ISDN participant reattached: + +Upon the receipt of a conference information document with the and the element *status of endpoint-status-type* is set to "connected" and it was set to "on-hold" before and the Contact URI in the element *entity* is the address of the served PSTN/ISDN participant, the MGCF shall send a CPG message to the PSTN/ISDN with a notification "*reattached*". + +- Other participant reattached: + +Upon the receipt of a conference information document with the and the element *status of endpoint-status-type* is set to "connected" and it was set to "on-hold" before and the Contact URI in the element *entity* is not the address of the served PSTN/ISDN participant, the MGCF shall send a CPG message to the PSTN/ISDN with a notification "*other party reattached*". + +- Other party disconnected: + +Upon the receipt of a conference information document with the and the element *status of endpoint-status-type* is set to "disconnected" and the element *joining-method of joining-type* is not set to "focus-owner", the MGCF shall send a CPG message to the PSTN/ISDN with a notification "*other party disconnected*". + +## 7.5.7 Anonymous Communication Rejection (ACR) and Communication Barring (CB) + +The Anonymous Communication rejection (ACR) and Communication Barring (CB) services are described within 3GPP TS 24.611 [67]. + +The mapping of Anonymus Communication Rejection supplementary service with Anonymus Call Rejection PSTN/ISDN Supplementary Service is described in clause 7.4.23. + +The mapping for Communication Barring is in accordance with the basic call procedures as described in clauses 7.2.3.1.8 and 7.2.3.2.12. + +## 7.5.8 Message Waiting Indication (MWI) + +The Message Waiting Indication supplementary service is described within 3GPP TS 24.606 [62]. + +## 7.5.9 Malicious Communication Identification (MCID) + +### 7.5.9.0 General + +The protocol specification of the Malicious Communication Identification supplementary service is described in 3GPP TS 24.616 [102]. The XML MCID body used in related SIP messages is also specified in 3GPP TS 24.616 [102]. + +### 7.5.9.1 Interworking at the O-MGCF + +#### 7.5.9.1.0 General + +If the MGCF supports the interworking of the MCID service the O-MGCF shall map a SIP INFO request ("legacy" mode of usage of the INFO method as defined in IETF RFC 6086 [133]) containing a XML mcid body with MCID XML Request schema to an Identification Request (IDR) message and an Identification response (IRS) message to a SIP INFO request containing a XML mcid body with MCID XML Response schema in accordance with table 7.5.9.1.1. + +The IDR message shall be generated upon reception of the SIP INFO request containing a XML mcid body with MCID XML Request schema. + +The SIP INFO request containing a XML mcid body with MCID XML Response schema shall be generated upon reception of the IRS message. + +**Table 7.5.9.1.1 Mapping between ISUP IDR and IRS and SIP messages** + +| ISUP Message | SIP Message | +|--------------|---------------------------------------------------------------| +| IDR | INFO containing a XML mcid body with MCID XML Request schema | +| IRS | INFO containing a XML mcid body with MCID XML Response schema | + +#### 7.5.9.1.1 Interworking of the MCID XML Request schema with the ISUP MCID request indicators + +If the MGCF supports the interworking of the MCID service O-MGCF shall map the codes in the MCID XML elements to MCID request indicator and holding indicator parameter fields in accordance with table 7.5.9.1.1.1. + +**Table 7.5.9.1.1.1 Mapping between ISUP MCID request and holding indicators and MCID XML elements** + +| ISUP Parameter | | XML Element | +|----------------|----------------------------------|----------------------| +| bit A: | MCID request indicator | McidRequestIndicator | +| 0 | MCID not requested | type=0 | +| 1 | MCID requested | type=1 | +| bit B: | Holding indicator (national use) | HoldingIndicator | +| 0 | holding not requested | type=0 | +| 1 | holding requested | type=1 | + +### 7.5.9.1.2 Interworking of the ISUP MCID response indicators with the MCID XML Response schema + +If the MGCF supports the interworking of the MCID service the O-MGCF shall map the codes in the MCID response indicator and hold provided indicator parameter field to the MCID XML elements in accordance with table 7.5.9.1.2.1. + +**Table 7.5.9.1.2.1 Mapping between ISUP MCID response and hold provided indicators and MCID XML elements** + +| ISUP Parameter | | XML Element | +|----------------|-----------------------------------------------|--------------------------| +| bit A: | MCID response indicator | McidResponseIndicator | +| 0 | MCID not included | type=0 | +| 1 | MCID included | type=1 | +| bit B: | Hold provided indicator (national use) | HoldingProvidedIndicator | +| 0 | holding not provided | type=0 | +| 1 | holding provided | type=1 | + +### 7.5.9.1.3 Interworking of the ISUP Calling Party Number in an Identification Response with the OrigPartyIdentity within the MCID XML Response schema + +If the O-MGCF supports the interworking of the MCID service and receives an ISUP Identification Response containing a Calling Party Number with the screening indicator set to "*user provided, verified and passed*" or "*network provided*", the O-MGCF shall map the Calling Party Number to the MCID XML Response schema OrigPartyIdentity element applying the same mapping procedures as described in table 14 for the mapping into the SIP P-Asserted-Identity header and shall map the Calling Party Number APRI to the MCID XML Response schema OrigPartyPresentationRestriction element. If the Calling Party Number APRI has a value of "*presentation allowed*" then the MCID XML Response schema OrigPartyPresentationRestriction element shall be set to "*false*", otherwise it shall be set to "*true*". + +### 7.5.9.1.4 Interworking of the ISUP Generic Number in an Identification Response with the GenericNumber within the MCID XML Response schema + +If the O-MGCF supports the interworking of the MCID service and receives an ISUP Identification Response containing a Generic Number with the screening indicator set to "*user provided, verified and passed*", or "*user provided, not verified*", or "*network provided*", the O-MGCF shall map the Generic Number to the MCID XML Response schema GenericNumber element applying the same mapping procedures as described in table 13 for the mapping into the SIP From header and shall map the Generic Number APRI to the MCID XML Response schema GenericNumberPresentationRestriction element. If the Generic Number APRI has a value of "*presentation allowed*" then the MCID XML Response schema GenericNumberPresentationRestriction element shall be set to "*false*", otherwise it shall be set to "*true*". + +## 7.5.9.2 Interworking at the I-MGCF + +### 7.5.9.2.1 General + +If the MGCF supports the interworking of the MCID service the I-MGCF shall map an Identification Request (IDR) message to a SIP INFO request ("*legacy*" mode of usage of the INFO method as defined in IETF RFC 6086 [133]) containing a XML mcid body with MCID XML Request schema and a SIP INFO request containing a XML mcid body with MCID XML Response schema to an Identification response (IRS) message in accordance with table 7.5.9.1.1. + +### 7.5.9.2.2 Interworking of identification Request + +The SIP INFO request containing a XML mcid body with MCID XML Request schema shall be generated upon reception of the IDR message. The I-MGCF shall map the codes in the MCID request indicator and holding indicator parameter fields to the MCID XML elements in accordance with table 7.5.9.1.1.1. + +### 7.5.9.2.3 Interworking of identification Response + +The IRS message shall be generated upon reception of the SIP INFO request containing a XML mcid body with MCID XML Response schema. The I-MGCF shall map the codes in the MCID XML elements to the MCID response indicator and hold provided indicator parameter fields in accordance with table 7.5.9.1.2.1. + +If the received MCID XML Response schema contains an OrigPartyIdentity element, the I-MGCF shall map the OrigPartyIdentity to the Calling Party Number within the IRS applying the same mapping procedure as described in table 5 for the mapping from the SIP P-Asserted-Identity header, with the exception that the I-MGCF shall map the MCID XML Response schema OrigPartyPresentationRestriction element to the Calling Party Number APRI. If the MCID XML Response schema OrigPartyPresentationRestriction element has the value "true", the Calling Party Number APRI shall be set to "presentation restricted", and otherwise the Calling Party Number APRI shall be set to "presentation allowed". + +If the received MCID XML Response schema contains a GenericNumber element, the I-MGCF shall map the GenericNumber to the Generic Number within the IRS applying the same mapping procedure as described in table 6 for the mapping from the From header, with the exception that the I-MGCF shall map the MCID XML Response schema GenericNumber PresentationRestriction element to the Generic Number APRI. If the MCID XML Response schema GenericNumberPresentationRestriction element has the value "true", the Generic Number APRI shall be set to "presentation restricted", and otherwise the Generic Number APRI shall be set to "presentation allowed". + +## 7.5.10 Closed User Group (CUG) + +### 7.5.10.0 General + +The protocol specification of the Closed User Group supplementary service is described in 3GPP TS 24.654 [101]. + +### 7.5.10.1 Interworking at the I-MGCF + +If the I-MGCF supports the interworking of CUG supplementary service, the I-MGCF shall map between the SIP and ISUP messages in accordance with table 7.5.10.1.1. + +**Table 7.5.10.1.1: Mapping of SIP messages to ISUP messages** + +| SIP Message | ISUP Message | +|--------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------| +| INVITE request containing a XML cug body with CUG XML schema | IAM containing the Closed user group interlock code Parameter and the closed user group call indicator of the Optional Forward Call Indicator Parameter | + +If the MGCF supports the interworking of CUG supplementary service, the I-MGCF shall interwork the CUG XML schema with the ISUP Closed user group interlock code parameter and the *Closed user group call indicator* of the optional forward call indicator parameter in accordance with tables 7.5.10.1.2 and 7.5.10.1.3. + +**Table 7.5.10.1.2: Mapping of the SIP XML CUG Element to the ISUP closed usergroup interlock code parameter** + +| CUG XML Element | Source component value | ISUP Closed user group interlock code Parameter | derived value of parameter field | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------|-------------------------------------------------|-------------------------------------------------------------------------------------| +| networkIndicator | networkIdentityType = 4 hexbinary coded digits (NOTE) | "Network Identity" | Octet 1 & Octet 2 including 4 binary coded digits derived from XML Network Identity | +| cugInterlockBinaryCode | sixteenbitType = 16 bit coded value | "Binary Code" | Octet 3 & Octet 4 including a 16 bit Binary Code derived from the XML Binary Code | +| NOTE: ISUP Closed user group interlock code Parameter Octet 1 contains "Network Identity" (NI) digits 1 & 2 and Octet 2 contains "Network Identity" digits 3 & 4. The networkIdentityType is filled with "Octet1 & Octet 2" = "NI digit 1, NI digit 2, NI digit 3, NI digit 4". Example: Digit 1=0, Digit 2=4, Digit 3=9, Digit 4=0 so the networkIdentityType is encoded with "0490". | | | | + +**Table 7.5.10.1.3: Mapping of the SIP XML CUG Element to the ISUP closed user group call indicator included in the optional Forward Call Indicator Parameter** + +| CUG XML Element | Source component value | ISUP "Optional Forward Call Indicator" Parameter | derived value of parameter field | +|---------------------------|------------------------|--------------------------------------------------|-----------------------------------------------------| +| cugCommunicationIndicator | Type=00 | "closed user group call" indicator | non-CUG call | +| | Type=01 | | spare | +| | Type=10 | | closed user group call, outgoing access allowed | +| | Type=11 | | closed user group call, outgoing access not allowed | + +If the I-MGCF supports the interworking of CUG supplementary service, then if an INVITE request with the MIME including a cug XML element is received and the terminating network is not supporting CUG, the I-MGCF shall behave as shown in table 7.5.10.1.4. + +**Table 7.5.10.1.4: Action at the I-MGCF with a PSTN/ISDN network without CUG capability** + +| cugCommunicationIndicator in INVITE request | Action at the I-MGCF | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------| +| Type=11 (CUG without outgoing access) | Release the communication with 403 | +| Type=10 (CUG with outgoing access) | Treat the communication as an ordinary call (NOTE) | +| Non-CUG | Treat the communication as an ordinary call | +| NOTE: The cugCommunicationIndicator shall not be mapped or if appropriate the CUG call indicator of the optional forward call indicator shall be set to non-CUG call. | | + +## 7.5.10.2 Interworking at the O-MGCF + +If the MGCF supports the interworking of CUG supplementary service, the O-MGCF shall map between the SIP and ISUP messages in accordance with table 7.5.10.2.1 + +**Table 7.5.10.2.1: Mapping of ISUP messages to SIP messages** + +| ISUP Message | SIP Message | +|---------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------| +| IAM containing the Closed user group interlock code Parameter and the closed user group call indicator of the Optional Forward Call Indicator Parameter | INVITE request containing a XML cug body with CUG XML schema | + +If the MGCF supports the interworking of CUG supplementary service, the MGCF shall interwork the CUG XML schema with the ISUP Closed user group interlock code parameter and the *Closed user group call indicator* of the optional forward call indicator parameter in accordance with tables 7.5.10.2.2 and table 7.5.10.2.3. + +**Table 7.5.10.2.2: Mapping of the ISUP closed usergroup interlockcode to SIP XML CUG element** + +| ISUP Closed user group interlock code Parameter | Source component value | CUG XML Element | derived value of parameter field | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------|------------------------|-------------------------------------------------------------------------------------| +| "Network Identity" | Octet 1 & Octet 2 including 4 binary coded digits | networkIndicator | networkIdentityType = 4 hexbinary coded digits derived from Network Identity (NOTE) | +| "Binary Code" | Octet 3 & Octet 4 including a 16 bit Binary Code | cugInterlockBinaryCode | sixteenbitType = 16 bit coded value derived from Binary Code | +| NOTE: ISUP Closed user group interlock code Parameter Octet 1 contains "Network Identity" (NI) digits 1 & 2 and Octet 2 contains "Network Identity" digits 3 & 4. The networkIdentityType shall be filled with "Octet1 & Octet 2" = "NI digit 1, NI digit 2, NI digit 3, NI digit 4". Example: Digit 1=0, Digit 2=4, Digit 3=9, Digit 4=0 so the networkIdentityType is encoded with "0490". | | | | + +**Table 7.5.10.2.3: Mapping of the ISUP Closed user group call indicator to SIP XML CUG element** + +| ISUP Optional Forward Call Indicator Parameter | Source component value | CUG XML Element | derived value of parameter field | +|------------------------------------------------|-----------------------------------------------------|---------------------------|----------------------------------| +| closed user group call indicator | non-CUG call | cugCommunicationIndicator | Type=00 | +| | spare | | Type=01 | +| | closed user group call, outgoing access allowed | | Type=10 | +| | closed user group call, outgoing access not allowed | | Type=11 | + +If the MGCF supports the interworking of CUG supplementary service, but the IMS is not supporting CUG, the procedures described in ITU Q.735.1 [42] shall apply if an INVITE request with the MIME body including a cug XML element is sent and the O-MGCF supports CUG supplementary service. + +## 7.5.11 CCBS/CCNR + +### 7.5.11.0 General + +The protocol specification of the Completion of Communications to Busy Subscriber and Completion of Communications by No Reply supplementary services is described in 3GPP TS 24.642 [112]. + +SIP SUBSCRIBE and NOTIFY methods shall be used in accordance with the procedures defined in IETF RFC 6665 [138]. + +### 7.5.11.1 Interworking at the I-MGCF + +If the I-MGCF supports the interworking of CCBS/CCNR supplementary services, the I-MGCF shall map between the SIP and ISUP messages in accordance with table 7.5.11.1.1. + +**Table 7.5.11.1.1: Mapping of ISUP and SIP messages** + +| SIP Message | Parameter | ISUP Message | Parameter | +|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------|----------------------------------------------------------------------------------------------------------------------| +| ← 180 Ringing | Call-Info header field with purpose header field parameter set to "call-completion" and "m" header field parameter set to "NR" (no reply) (NOTE 1) | ← ACM | Called party's status indicator set to "Subscriber free" and CCNR possible indicator set to "CCNR possible" (NOTE 2) | +| ← 180 Ringing | Call-Info header field with purpose header field parameter set to "call-completion" and "m" header field parameter set to "NR" (no reply) (NOTE 1) | ← CPG | Event indicator set to "Alerting" and CCNR possible indicator set to "CCNR possible" (NOTE 2) | +| ← 486 Busy here | Call-Info header field with purpose header field parameter set to "call-completion" and "m" header field parameter set to "BS" (busy subscriber) (NOTE 1) | ← REL | Cause Indicator cause #17 with Diagnostic (CCBS indicator set to "CCBS possible") (NOTE 3) | +| → INVITE | Request-URI contains "m" SIP URI parameter or Call-Info header field contains "purpose" header field parameter set to "call-completion" and "m" header field parameter. (NOTE 1) | → IAM | CCSS parameter set to "CCSS call" (NOTE 2) (NOTE 4) | + +NOTE 1: The coding shall be in accordance with IETF RFC 6910 [106]. +NOTE 2: The coding shall be in accordance with ITU-T recommendation Q.763 [4]. +NOTE 3: The coding shall be in accordance with ITU-T recommendation Q.850 [38]. +NOTE 4: CCSS parameter set to the value "CCSS call" is included in the IAM if Request-URI contains the SIP URI parameter "m" i.e. creation of the CCSS parameter does not depend on the received value of the SIP URI parameter "m". + +If the I-MGCF supports the interworking of CCBS/CCNR supplementary services, the I-MGCF shall map between the SIP and TCAP messages in accordance with table 7.5.11.1.2 and table 7.5.11.1.3. + +**Table 7.5.11.1.2: Mapping of SIP messages to TCAP messages** + +| SIP Message | Parameter | TCAP Message | Parameter | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------|--------------------------------|-----------------------------| +| SUBSCRIBE with m-parameter in Request-URI set to "BS" or containing Call-Info header field with "purpose" parameter set to "call-completion" and m-parameter set to "BS" (NOTE 1) | Request-URI (NOTE 5) | TC-Begin CCBS REQUEST (invoke) | CalledPartyNumber (NOTE 3) | +| | P-Asserted-Identity | | CallingPartyNumber (NOTE 4) | +| | | | RetainSupported (NOTE 2) | +| SUBSCRIBE with m-parameter in Request-URI set to "NR" or containing Call-Info header field with "purpose" parameter set to "call-completion" and m-parameter set to "NR" (NOTE 1) | Request-URI (NOTE 5) | TC-Begin CCNR REQUEST (invoke) | CalledPartyNumber (NOTE 3) | +| | P-Asserted-Identity | | CallingPartyNumber (NOTE 4) | +| | | | RetainSupported (NOTE 2) | +| PUBLISH with m-parameter in Request-URI or m-parameter in Call-Info header field set to "BS" and body containing PIDF basic status set to "closed". | | TC-Cont CCBS SUSPEND | | +| PUBLISH with m-parameter in Request-URI or m-parameter in Call-Info header field set to "BS" and body containing PIDF basic status set to "open". | | TC-Cont CCBS RESUME | | +| PUBLISH with m-parameter in Request-URI or m-parameter in Call-Info header field set to "NR" and body containing PIDF basic status set to "closed". | | TC-Cont CCBS SUSPEND | | +| PUBLISH with m-parameter in Request-URI or m-parameter in Call-Info header field set to "NR" and body containing PIDF basic status set to "open". | | TC-Cont CCBS RESUME | | +| SUBSCRIBE with m-parameter in Request-URI or m-parameter in Call-Info header field set to "BS" and with Expires header set to "zero". | | TC-End CCBS CANCEL | | +| SUBSCRIBE with m-parameter in Request-URI or m-parameter in Call-Info header field set to "NR" and with Expires header set to "zero". | | TC-End CCBS CANCEL | | + +NOTE 1: Expires header defines subscription duration / CC service duration timer (CC-T3). +NOTE 2: Parameter is set by default, as retention option is supported in IMS by default. +NOTE 3: Mapping of the Request-URI to the CalledPartyNumber is done according to table 2 in clause 7.2.3.1.2.1. +NOTE 4: Mapping of the P-Asserted-Identity header field to the CallingPartyNumber is done according to table 5 in clause 7.2.3.1.2.6. +NOTE 5: If URI of the MGCF was returned in the Call-Info header field in the 180 Ringing or 486 Busy Here messages described in table 7.5.11.1.1, then the MGCF needs to remember the Request-URI of the original INVITE for mapping to the CalledPartyNumber. + +**Table 7.5.11.1.3: Mapping of TCAP messages to SIP messages** + +| TCAP Message | Parameter | SIP Message | Parameter | +|-----------------------------------------|-----------------|----------------------------------------------------------------------------------------|----------------------| +| TC-Cont CCBS REQUEST (return result) | RetainSupported | NOTIFY with cc-state parameter set to "queued" | cc-service-retention | +| TC-End CCBS/CCNR REQUEST (error result) | ShortTermDenial | 480 Temporarily Unavailable | | +| TC-End CCBS/CCNR REQUEST (error result) | LongTermDenial | 403 Forbidden | | +| TC-End CCBS CANCEL | | NOTIFY with the "reason" Subscription-State header field parameter set to "noresource" | | +| TC-Cont REMOTE USER FREE | | NOTIFY with cc-state set to "ready" (NOTE) | | + +NOTE: This does not terminate the subscription AS-AS. + +## 7.5.11.2 Interworking at the O-MGCF + +If the O-MGCF supports the interworking of CCBS/CCNR supplementary services, the O-MGCF shall map between the ISUP and SIP messages in accordance with table 7.5.11.2.1. + +**Table 7.5.11.2.1: Mapping of SIP and ISUP messages** + +| ISUP Message | Parameter | SIP Message | Parameter | +|--------------|----------------------------------------------------------------------------------------------------------------------|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ← ACM | Called party's status indicator set to "Subscriber free" and CCNR possible indicator set to "CCNR possible" (NOTE 2) | ← 180 Ringing | Call-Info header field with purpose header field parameter set to "call-completion" (NOTE 1) | +| ← CPG | Event indicator set to "Alerting" and CCNR possible indicator set to "CCNR possible" (NOTE 2) (NOTE 4) | | | +| ← REL | Cause Indicator cause #17 or #34 with Diagnostic (CCBS indicator set to "CCBS possible") (NOTE 3) | ← 486 Busy here | Call-Info header field with purpose header field parameter set to "call-completion" (NOTE 1) | +| → IAM | CCSS parameter set to "CCSS call" (NOTE 2) | → INVITE | Request URI contains m-parameter and a Call-Info header field field, with purpose header field parameter set to "call-completion", and an m-parameter (NOTE 1) (NOTE 5) | + +NOTE 1: The coding shall be in accordance with IETF RFC 6910 [106]. +NOTE 2: The coding shall be in accordance with ITU-T recommendation Q. 763 [4]. +NOTE 3: The coding shall be in accordance with ITU-T recommendation Q. 850 [38]. +NOTE 4: A CPG will be sent if an ACM was already sent. +NOTE 5: Based on the operator policy the "m" SIP URI parameter in the Request-URI and m-parameter in Call-Info header field is set to the value "BS" or "NR". + +If the O-MGCF supports the interworking of CCBS/CCNR supplementary services, the O-MGCF shall map between the TCAP and SIP messages in accordance with table 7.5.11.2.2 and table 7.5.11.2.3. + +**Table 7.5.11.2.2: Mapping of TCAP messages to SIP messages** + +| TCAP Message | Parameter | SIP Message | Parameter | +|--------------------------------|--------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------| +| TC-Begin CCBS REQUEST (invoke) | CalledPartyNumber | SUBSCRIBE with m-parameter in Request URI and m-parameter in Call-Info header field set to "BS" (NOTE 1) | To header (NOTE 2) | +| | CallingPartyNumber | | Request-URI (NOTE 2) | +| TC-Begin CCNR REQUEST (invoke) | CalledPartyNumber | SUBSCRIBE with m-parameter in Request URI and m-parameter in Call-Info header field set to "NR" (NOTE 1) | From header (NOTE 3) | +| | CallingPartyNumber | | P-Asserted-Identity (NOTE 4) | +| TC-Cont CCBS SUSPEND | | PUBLISH with m-parameter in Request URI and m-parameter in Call-Info header field set to "BS" and body containing PIDF basic status set to "closed". | To header (NOTE 2) | +| | | PUBLISH with m-parameter in Request URI and m-parameter in Call-Info header field set to "NR" and body containing PIDF basic status set to "closed". | Request-URI (NOTE 2) | +| TC-Cont CCBS RESUME | | PUBLISH with m-parameter in Request URI and m-parameter in Call-Info header field set to "BS" and body containing PIDF basic status set to "open". | From header (NOTE 3) | +| | | PUBLISH with m-parameter in Request URI and m-parameter in Call-Info header field set to "NR" and body containing PIDF basic status set to "open". | P-Asserted-Identity (NOTE 4) | +| TC-End CCBS CANCEL | | SUBSCRIBE with m-parameter in Request URI and m-parameter in Call-Info header field set to "BS" and with Expires header set to "0" | | +| | | SUBSCRIBE with m-parameter in Request URI and m-parameter in Call-Info header field set to "NR" and with Expires header set to "0" | | + +NOTE 1: Expires header defines subscription duration / CC service duration timer (CC-T3). +NOTE 2: For the mapping of the CalledPartyNumber to the To header and Request-URI see table 10a in clause 7.2.3.2.2.1. +NOTE 3: For the mapping of the CallingPartyNumber to the From header see table 15 in clause 7.2.3.2.2.3. If no CallingPartyNumber is available, the From header shall be set to a SIP URI with addr-spec of Unavailable User Identity as defined in TS 23.003 [74]. +NOTE 4: For the mapping of the CallingPartyNumber to the P-Asserted-Identity header see table 14 in clause 7.2.3.2.2.3. If no CallingPartyNumber is available, a P-Asserted-Identity header shall not be inserted. + +**Table 7.5.11.2.3: Mapping of SIP messages to TCAP messages** + +| SIP Message | Parameter | TCAP Message | Parameter | +|--------------------------------------------------------------------------------------------------------------------|----------------------|-------------------------------------------|-----------------| +| NOTIFY with cc-state parameter set to "queued" | cc-service-retention | TC Cont CCBS/CCNR REQUEST (return result) | RetainSupported | +| 480 Temporarily unavailable | | TC-End CCBS/CCNR REQUEST (error result) | ShortTermDenial | +| 403 Forbidden | | TC-End CCBS/CCNR REQUEST (error result) | LongTermDenial | +| NOTIFY with the Subscription-State header field set to "terminated" and the "reason" parameter set to "noresource" | | TC-End CCBS CANCEL | | +| NOTIFY with cc-state set to "ready" (NOTE) | | TC-Cont REMOTE USER FREE | | + +NOTE: This does not terminate the subscription AS-AS. + +## 7.5.12 Communication Waiting (CW) + +### 7.5.12.0 General + +The protocol specification of the Communication Waiting supplementary service is described in 3GPP TS 24.615 [111]. + +### 7.5.12.1 Interworking at the I-MGCF + +With regard to the backward messages of the Call Waiting PSTN/ISDN supplementary service, the following mapping is valid: + +**Table 7.5.12.1: Mapping of ISUP messages to SIP Messages** + +| Message Received from BICC/ISUP | Message sent to SIP | +|-----------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------| +| ACM or CPG with generic notification indicator "Call is a waiting call" (NOTE 1). | 180 Ringing with an Alert-Info header field set to "urn:alert:service:call-waiting" (NOTE 2). | +| NOTE 1: The coding shall be in accordance with ITU-T recommendation Q.733 [42]. | | +| NOTE 2: The coding shall be in accordance with IETF RFC 7462 [107]. | | + +### 7.5.12.2 Interworking at the O-MGCF + +With regard to the backward messages of the Communication Waiting service, the following mapping is valid: + +**Table 7.5.12.2: Mapping of SIP messages to ISUP messages** + +| Message sent to ISUP | Message Received from SIP | +|-----------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------| +| ACM or CPG with generic notification indicator "Call is a waiting call" (NOTE 1). | 180 Ringing with an Alert-Info header field set to "urn:alert:service:call-waiting" (NOTE 2). | +| NOTE 1: The coding shall be in accordance with ITU-T recommendation Q.733 [42]. | | +| NOTE 2: The coding shall be in accordance with IETF RFC 7462 [107]. | | + +## 7.5.13 Customized Alerting Tones (CAT) + +### 7.5.13.1 General + +The Customized Alerting Tones supplementary service is described in 3GPP TS 24.182 [132]. + +The interworking procedures in this clause enable the transport of customized alerting tones provided by an AS in the IM CN subsystem towards a caller in a CS network. + +Based on operator options, one of three different models described in 3GPP TS 24.182 [132] is used in an IM CN subsystem to provide the CAT service. The CAT interworking procedures at the O-MGCF differ between these models and are described in alignment for each model in the subsequent clauses. Support of the interworking procedures for each of those models is optional. + +I-MGCF procedures are not affected. + +### 7.5.13.2 Early session model + +#### 7.5.13.2.1 Interworking at the O-MGCF + +When CAT service is provided by using early session model as specified in 3GPP TS 24.182 [132], and if the O-MGCF supports early-session as a network option, then it shall include the option tag "early-session", as defined in IETF RFC 3959 [131], in Supported header field in each outgoing initial SIP INVITE request. + +After receiving the first SIP 18x response including an early-session SDP, then the O-MGCF shall send the address complete message (ACM) or Call Progress message (CPG) with the Optional backward call indicators parameter set to "in-band information or an appropriate pattern is now available". If the SIP 18x response is the SIP 180 Ringing response, then additionally the Called party's status indicator in the ACM message shall be set to "subscriber free" or the Event information in the CPG message shall be set to "ALERTING". + +If the O-MGCF applies codec interworking procedures according to Annex B, it shall interwork the "session" disposition SDP (rather than the "early session" disposition SDP). + +## 7.5.13.2.2 MGCF - IM-MGW Interaction for CAT service + +### 7.5.13.2.2.1 General + +When the IMS CAT is provided by using early session model as described in 3GPP TS 24.182 [132], the procedures described in clauses 9.2.3.1 to 9.2.3.3 shall be applied with the following additions. + +### 7.5.13.2.2.2 IM CN subsystem side Early Session establishment + +If the MGCF supports early-session as a network option, upon receipt of a SIP 18x response with an early-session SDP, the MGCF shall use the Configure IMS Resources procedure (signals 10 and 11 in figure 7.5.13.2.2.5-1, signals 7 and 8 in figure 7.5.13.2.2.5-2) to provide configuration data (derived from early session SDP received in signal 8 in figure 7.5.13.2.2.5-1 and local configuration data) to the IM-MGW as detailed below: + +- The MGCF shall indicate the remote IP address and UDP port, i.e. the destination IP address and UDP port for data sent in the user plane towards the IM CN subsystem, +- The MGCF shall indicate the remote codec(s), i.e. the speech codec(s) for data sent in the user plane towards the IM CN subsystem. +- The MGCF should select the same codec(s) for early-session SDP with the codec(s) used for normal session SDP. +- The MGCF may indicate the local codec(s) and the local IP address and UDP port. The MGCF shall indicate the local codec(s) if a change is required. +- The MGCF may indicate that IP interface type is for MboIP. + +The IM-MGW shall reply with the selected remote codec(s) and reserve resources for these codec(s). If local codec(s) were received, the IM-MGW shall also reply with the selected local codec(s) and reserve the corresponding resources. + +The MGCF shall send the local codec(s), UDP port and IP address in the early-session SDP to the IMS in the PRACK messages (signal 12 in figure 7.5.13.2.2.5-1 and 7.5.13.2.2.5-2). + +### 7.5.13.2.2.3 IM CN subsystem side normal Session establishment + +When the MGCF receives a SIP 200(OK) response to the SIP INVITE request (signal 14 in figure 7.5.13.2.2.5-1, signal 15 in figure 7.5.13.2.2.5-2), it shall request the IM-MGW use the Configure IMS Resources procedure for normal session SDP (signals 15 and 16 in figure 7.5.13.2.2.5-1, signal 16 and 17 in figure 7.5.13.2.2.5-2) to provide configuration data (derived from SDP received in signal 8 in figure 7.5.13.2.2.5-1 and local configuration data) to the IM-MGW as detailed below: + +- The MGCF shall indicate the remote IP address and UDP port, i.e. the destination IP address and UDP port for data sent in the user plane towards the IM CN subsystem, +- The MGCF shall indicate the remote codec(s), i.e. the speech codec(s) for data sent in the user plane towards the IM CN subsystem. +- The MGCF may indicate the local codec(s) and the local IP address and UDP port. The MGCF shall indicate the local codec(s) if a change is required. +- The MGCF may indicate that IP interface type is for MboIP. + +The IM-MGW shall reply with the selected remote codec(s) and reserve resources for these codec(s). If local codec(s) were received, the IM-MGW shall also reply with the selected local codec(s) and reserve the corresponding resources. + +### 7.5.13.2.2.4 Called party alerting + +If the MGCF supports early-session as a network option, upon receipt of a SIP 18x provisional response with an early-session SDP, the MGCF shall not request the IM-MGW to provide an awaiting answer indication (ringing tone) to the calling party. + +##### 7.5.13.2.2.5 Message sequence chart + +Figure 7.5.13.2.2.5-1 shows an example message sequence chart for an CS network originating Session Setup with ISUP, where IMS CAT is provided by early session model. + +![Sequence diagram showing the message flow between IM-MGW and MGCF for a CS network originating session with early session SDP. The diagram includes 18 numbered messages and annotations for resource reservation and configuration steps.](68d50e85fb8de4fae0e0eafaf20e63c0_img.jpg) + +The sequence diagram illustrates the interaction between the IM-MGW and the MGCF for a CS network originating session. The sequence of messages is as follows: + +- 1. ISUP: IAM**: Sent from the calling party to the MGCF. +- 2. H.248: ADD.req [Context ID = ?, Termination ID = ?]**: Sent from the MGCF to the IM-MGW. *Annotation: Reserve TDM Circuit, Change Through-Connection = both* +- 3. H.248: ADD.resp [Context ID = C1, Termination ID = T2]**: Sent from the IM-MGW to the MGCF. +- 4. H.248: ADD.req [Context ID = C1, Termination ID=?]**: Sent from the MGCF to the IM-MGW. *Annotation: Reserve IMS Connection Point, Change IMS Through-Connection = backward* +- 5. H.248: ADD.resp [Context ID = C1, Termination ID = T1, IP1,p1]**: Sent from the IM-MGW to the MGCF. +- 6. SIP: INVITE (Session SDP(IP1,p1))**: Sent from the MGCF to the called party. +- 7. SIP: 100 Trying**: Sent from the called party to the MGCF. +- 8. SIP: 180 Ringing (Session SDP and Early Session SDP)**: Sent from the called party to the MGCF. +- 9. ISUP: ACM**: Sent from the MGCF to the calling party. +- 10. H.248: MOD.req [Context ID = C1, Termination ID = T1], Early session SDP**: Sent from the MGCF to the IM-MGW. *Annotation: Configure IMS Resources* +- 11. H.248: MOD.resp [Context ID = C1, Termination ID = T1]**: Sent from the IM-MGW to the MGCF. +- 12. SIP: PRACK (Early Session SDP(IP1,p1))**: Sent from the MGCF to the called party. +- 13. SIP: 200 OK (PRACK)**: Sent from the called party to the MGCF. +- 14. SIP: 200 OK (INVITE)**: Sent from the called party to the MGCF. +- 15. H.248: MOD.req [Context ID=C1, Termination ID = T1, session SDP]**: Sent from the MGCF to the IM-MGW. *Annotation: Configure IMS Resources, Change IMS Through-Connection = both* +- 16. H.248: MOD.resp [Context ID = C1, Termination ID = T1]**: Sent from the IM-MGW to the MGCF. +- 17. ISUP: ANM**: Sent from the MGCF to the calling party. +- 18. SIP: ACK**: Sent from the MGCF to the called party. + +A horizontal double-headed arrow at the bottom, spanning from the MGCF to the IM-MGW and then to the calling party, is labeled **CALL IN ACTIVE STATE**. + +Sequence diagram showing the message flow between IM-MGW and MGCF for a CS network originating session with early session SDP. The diagram includes 18 numbered messages and annotations for resource reservation and configuration steps. + +Figure 7.5.13.2.2.5-1: CS Network Originating Session with Early Session SDP, ISUP (message sequence chart) + +Figure 7.5.13.2.2.5-2 shows an example message sequence chart for an CS network originating Session Setup with BICC, where IMS CAT is provided by early session model. + +![Sequence chart for CS Network Originating Session with Early Session SDP, BICC. The chart shows interactions between IM-MGW and MGCF. The process starts with BICC: IAM from IM-MGW to MGCF. MGCF responds with H.248: ADD.req, then H.248: ADD.resp. MGCF sends SIP: INVITE to an external entity, which responds with SIP: 100 Trying and SIP: 180 Ring. MGCF sends H.248: MOD.req to IM-MGW (Configure IMS Resources), which responds with H.248: MOD.resp. MGCF sends H.248: ADD.req, then H.248: ADD.resp (Prepare Bearer, Change Through-Connection= both). IM-MGW sends BICC: APM to an external entity. MGCF sends SIP: PRACK, which is responded to with SIP: 200 OK (PRACK). IM-MGW sends BICC: ACM to an external entity. A 'START CAT MEDIA' phase occurs. MGCF sends SIP: 200 OK (INVITE) to an external entity. MGCF sends H.248: MOD.req to IM-MGW (Configure IMS Resources, Change IMS Through-Connection = both), which responds with H.248: MOD.resp. IM-MGW sends BICC: ANM to an external entity. MGCF sends SIP: ACK to an external entity. A 'CALL IN ACTIVE STATE' phase occurs.](69edc2887e907309499ac95b47ab6905_img.jpg) + +Sequence chart illustrating the CS Network Originating Session with Early Session SDP, BICC (message sequence chart). + +The interaction involves two main entities: IM-MGW and MGCF. + +**Sequence of Messages:** + +1. BICC: IAM (IM-MGW to MGCF) +2. H.248: ADD.req [Context ID = ?, Termination ID=?] (MGCF to IM-MGW) +3. H.248: ADD.resp [Context ID = C1, Termination ID = T1] (IM-MGW to MGCF) +4. SIP: INVITE (Session SDP offer) (MGCF to External Entity) +5. SIP: 100 Trying (External Entity to MGCF) +6. SIP: 180 Ring (Session SDP answer and Early Session SDP offer) (External Entity to MGCF) +7. H.248: MOD.req Context ID = C1, Termination ID = T1] (MGCF to IM-MGW) - Configure IMS Resources +8. H.248: MOD.resp [Context ID = C1, Termination ID = T1] (IM-MGW to MGCF) +9. H.248: ADD.req [Context ID = C1, Termination ID = ?] (MGCF to IM-MGW) +10. H.248: ADD.resp [Context ID = C1, Termination ID = T2] (IM-MGW to MGCF) - Prepare Bearer, Change Through-Connection= both +11. BICC: APM (IM-MGW to External Entity) +12. SIP: PRACK (Early Session SDP answer) (MGCF to External Entity) +13. SIP: 200 OK (PRACK) (External Entity to MGCF) +14. BICC: ACM (IM-MGW to External Entity) +- START CAT MEDIA** (Phase transition) +15. SIP: 200 OK (INVITE) (MGCF to External Entity) +16. H.248: MOD.req [Context ID=C1, Termination ID = T1] (MGCF to IM-MGW) - Configure IMS Resources, Change IMS Through-Connection = both +17. H.248: MOD.resp [Context ID = C1, Termination ID = T1] (IM-MGW to MGCF) +18. BICC: ANM (IM-MGW to External Entity) +19. SIP: ACK (MGCF to External Entity) +- CALL IN ACTIVE STATE** (Phase transition) + +Sequence chart for CS Network Originating Session with Early Session SDP, BICC. The chart shows interactions between IM-MGW and MGCF. The process starts with BICC: IAM from IM-MGW to MGCF. MGCF responds with H.248: ADD.req, then H.248: ADD.resp. MGCF sends SIP: INVITE to an external entity, which responds with SIP: 100 Trying and SIP: 180 Ring. MGCF sends H.248: MOD.req to IM-MGW (Configure IMS Resources), which responds with H.248: MOD.resp. MGCF sends H.248: ADD.req, then H.248: ADD.resp (Prepare Bearer, Change Through-Connection= both). IM-MGW sends BICC: APM to an external entity. MGCF sends SIP: PRACK, which is responded to with SIP: 200 OK (PRACK). IM-MGW sends BICC: ACM to an external entity. A 'START CAT MEDIA' phase occurs. MGCF sends SIP: 200 OK (INVITE) to an external entity. MGCF sends H.248: MOD.req to IM-MGW (Configure IMS Resources, Change IMS Through-Connection = both), which responds with H.248: MOD.resp. IM-MGW sends BICC: ANM to an external entity. MGCF sends SIP: ACK to an external entity. A 'CALL IN ACTIVE STATE' phase occurs. + +Figure 7.5.13.2.2.5-2: CS Network Originating Session with Early Session SDP, BICC (message sequence chart) + +#### 7.5.13.3 Forking model + +Interworking at O-MGCF follows the basic call interworking procedures using the P-Early-Media header field and related procedures as described in clause 7.2.3.2.1, 7.2.3.2.2, 7.2.3.2.4, 7.2.3.2.5, 7.2.3.2.6, 7.2.3.2.7, 7.2.3.2.8, and 7.2.3.2.9. + +The O-MGCF shall apply the procedures in clause 9.2.3.4 and shall use the P-Early-Media header field that authorizes early media as trigger to configure the IM-MGW as described in Clause 9.2.3.4.2. + +#### 7.5.13.4 Gateway model + +Interworking at O-MGCF follow the basic call interworking procedures using the P-Early-Media header field and related procedures as described in clause 7.2.3.2.1, 7.2.3.2.2, 7.2.3.2.4, 7.2.3.2.5, 7.2.3.2.6, 7.2.3.2.7, 7.2.3.2.8, and 7.2.3.2.9. + +Example callflows are shown in annex J + +# 8 User plane interworking + +## 8.1 Interworking between IM CN subsystem and bearer independent CS network + +When the IM CN subsystem interworks with the bearer independent CS networks (e.g. CS domain of a PLMN, 3GPP TS 29.414 [25], 3GPP TS 29.415 [26], 3GPP TS 23.205 [27]), then the Transport Network Layer (TNL) of the bearer independent CS network can be based e.g. on IP/UDP/RTP, or IP/UDP/RTP/IuFP, or ATM/AAL2/ framing protocol (e.g. Iu framing) transport techniques. Figure 31 shows the user plane protocol stacks for the IM CS subsystem and bearer independent CS network interworking. If the same or TrFO-compatible codec configuration(s) is/are used on the CS network side and on the IMS side, then transcoding is not required. However, there is still a need to interwork between RTP/UDP/IP/L2/L1 to TNL/L1. + +![Interworking arrow](f5e131a3fffe09aa98db055df84e4378_img.jpg) + +Interworking + +| | | +|------------------|------------------| +| voice
codec 1 | voice
codec 2 | +| RTP | TNL | +| UDP | | +| IP | | +| L2 | | +| L1 | L1 | + +| Mb +IM-MGW +Nb | + +Interworking arrow + +**Figure 31/1: IM CN subsystem to bearer independent CS network user plane protocol stack** + +### 8.1.1 Transcoder-less Mb to Nb Interworking + +![Diagram of the IM CN subsystem to bearer independent CS network user plane protocol stack. The diagram shows a stack of protocols between the Mb and Nb interfaces, with an IM-MGW at the bottom. The stack consists of five layers: L1, L2, IP, UDP, and RTP. The top layer is labeled 'Transcoder-less user plane interworking'. The layers are grouped into two columns: the left column contains RTP, UDP, IP, L2, and L1; the right column contains Nb FP, L3, L2, and L1. The IM-MGW is shown as a box below the L1 layer, connected to both the Mb and Nb interfaces.](53f1f7d17b3e7aae62169c41d2a88a77_img.jpg) + +| | | +|-----------------------------------------|-------| +| Transcoder-less user plane interworking | | +| RTP | Nb FP | +| UDP | | +| IP | L3 | +| L2 | L2 | +| L1 | L1 | + +Mb      IM-MGW      Nb + +Diagram of the IM CN subsystem to bearer independent CS network user plane protocol stack. The diagram shows a stack of protocols between the Mb and Nb interfaces, with an IM-MGW at the bottom. The stack consists of five layers: L1, L2, IP, UDP, and RTP. The top layer is labeled 'Transcoder-less user plane interworking'. The layers are grouped into two columns: the left column contains RTP, UDP, IP, L2, and L1; the right column contains Nb FP, L3, L2, and L1. The IM-MGW is shown as a box below the L1 layer, connected to both the Mb and Nb interfaces. + +**Figure 31/2: IM CN subsystem to bearer independent CS network user plane protocol stack (optional in the event the codecs on both sides are the same)** + +If no transcoder is inserted, the IM-MGW shall interwork the following procedures between the Nb and Mb interfaces. + +#### 8.1.1.1 Initialisation + +There is no need to interwork initialisation procedures between Nb and Mb interfaces see 3GPP TS 29.415 [26]. + +#### 8.1.1.2 Time alignment + +The purpose of the time alignment procedure on the Nb interface is to minimise the buffer delay in the RNC for downlink transmissions by adjusting the vocoder time reference within the network. No such procedure exists on the Mb interface, so the IM-MGW shall return NACK indication time alignment not supported according to 3GPP TS 29.415 [26]. + +#### 8.1.1.3 Rate control + +##### 8.1.1.3.1 General + +The rate control procedure signals to the peer entity the maximum rate among the currently allowed rates at which it can receive codec frames. Rate control only applies to AMR, AMR-WB and EVS codec configurations with multiple active modes. For the EVS codec, the rate control procedure also signals to the peer entity the maximum mode among the currently allowed modes at which it can receive codec frames. + +##### 8.1.1.3.2 Rate control for AMR and AMR-WB codecs + +For AMR and AMR-WB codecs: + +- On the Nb interface, IuFP provides for rate control via the exchange of RATE CONTROL and RATE CONTROL ACK PDUs +- On the Mb interface, IETF RFC 4867 [23] provides for in-band rate control via the Codec Mode Request (CMR) field of every codec frame (Speech or SID) and CMR-Only frames. +- Interworking of rate control procedures at an IM-MGW between an Mb interface and a corresponding Nb interface only applies when the IM-MGW bridges compatible codec configurations between the interfaces without applying a transcoding function. +- An IM-MGW receiving a CMR from an Mb interface shall initiate the IuFP rate control procedure on the corresponding Nb interface. + +- An IM-MGW receiving a rate control request on an Nb interface shall adjust the CMR field of outgoing speech frames on the corresponding Mb interface. + +##### 8.1.1.3.3 Rate and Mode control for the EVS codec + +For the EVS codec: + +- On the Nb interface, CMR for EVS (EVS-CMR) as specified in 3GPP TS 26.453 [152] subclause 4.5 provides for in-band rate and mode control via the Codec Mode Request (CMR) field of every codec frame (Speech or SID) and CMR-Only frame. +- On the Mb interface, EVS-CMR as specified in 3GPP TS 26.445 [147] subclause A.2.2.1.1 provides for in-band rate and mode control via the Codec Mode Request (CMR) field of the codec frame in RTP. Alternatively RTCP-APP packets may be used with corresponding control commands as specified in 3GPP TS 26.114 [104]. The rate and mode control on the Mb interface depends on the SDP offer/answer procedure. It may also be disabled, in which case transcoding is mandatory. +- Interworking of rate control procedures at an IM-MGW between an Mb interface and a corresponding Nb interface only applies when the IM-MGW bridges compatible codec configurations between the interfaces without applying a transcoding function. +- An IM-MGW receiving an EVS-CMR from an Nb interface may filter and modify the EVS-CMR contents based on configured policies and shall perform one of the following alternatives: + - 1) if CMR in RTP is required in every RTP packets on the Mb interface (cmr=1), include the resulting contents into the EVS-CMR field of the corresponding outgoing frame or CMR-Only frame on the Mb interface; + - 2) if CMR in RTP is enabled "on demand" on the Mb interface (cmr=0 or omitted), include the resulting contents into the EVS-CMR field of the outgoing codec frame or CMR-Only frame on the corresponding Mb interface only if it is different from the previously sent EVS-CMR value, and send the new EVS-CMR value at least 3 times within the next 100 ms to provide a minimum of error robustness, if necessary using also additional CMR-Only frames in speech pauses; + - 3) if CMR in RTP is disabled on the Mb interface (cmr=-1) and if RTCP-APP is enabled on the Mb interface, translate the resulting contents into a corresponding RTCP-APP command and send it at least 3 times within the next 100 ms to provide a minimum of error robustness, if the resulting RTCP-APP command is different from the previously sent RTCP-APP command; or + - 4) if CMR in RTP is disabled on the Mb interface (cmr=-1) and if RTCP-APP is disabled on the Mb interface, applying a transcoding function. In this case the rate and mode control on the Nb interface is terminated in the IM-MGW. +- An IM-MGW receiving an EVS-CMR on an Mb interface may filter and modify the EVS-CMR contents based on configured policies and shall include the resulting contents into the EVS-CMR field of the outgoing codec frame or CMR-Only frame on the corresponding Nb interface. +- The rules by which the IM-MGW may filter and modify the EVS-CMR contents consist of the following: + - 1) The IM-MGW shall not modify the EVS-CMR to increase the maximum bit rate; + - 2) If the IM-MGW observes the incoming stream of speech frames or packets and determines that a lower EVS mode is more appropriate, the IM-MGW may modify the EVS-CMRs sent in the opposite direction of the observed speech flow; + - 3) If the IM-MGW modifies the EVS-CMR to decrease the maximum bit rate and the resulting maximum bit rate no longer support the originally requested maximum audio bandwidth, then the maximum audio bandwidth may be reduced by the IM-MGW to the next lower one that fits to the reduced maximum bit rate; + - 4) The IM-MGW shall not modify the EVS-CMR in a way that results in a change of the major operation mode (EVS primary mode or EVS AMR-WB IO mode); + +NOTE: The IM-MGW can be forced to change the major operation mode of an incoming EVS-CMR when interworking between EVS and AMR-WB, during handover or after handover. + +- 5) When channel-aware mode is used, if the IM-MGW observes the incoming stream of speech frames or packets and determines that other channel-aware mode parameters are more appropriate, the IM-MGW may modify the EVS-CMRs, flowing in the opposite direction of the observed speech flow to change the received channel-aware offset to a bigger one (e.g. from 2 to 3) and the received channel-aware depth to a lower, more robust one; +- 6) When channel-aware mode is used, the IM-MGW shall not reduce the received channel-aware offset or modify the received channel-aware depth a less robust one; +- 7) The IM-MGW should not block the channel-aware mode; +- 8) The IM-MGW may modify the EVS primary mode in the received EVS-CMR to the EVS Variable Bit Rate mode. + +##### 8.1.1.3.4 Interworking of rate control between compatible AMR-WB and EVS codec configurations + +The EVS codec includes the EVS AMR-WB IO major operation mode and is therefore TrFO-compatible to the AMR-WB codec, if the mode-set and mode-change-period parameters are TrFO-compatible. For example, AMR-WB on one IM-MGW termination and EVS on the other IM-MGW termination are TrFO-compatible codecs, if the mode-set parameters are TrFO-compatible and mode-change-period=2 on both sides. + +If the IM-MGW bridges compatible EVS codec configurations and AMR-WB codec configurations: + +- If the codec of the incoming termination is EVS and the codec of the outgoing termination is AMR-WB, then the rate control procedure for AMR-WB shall apply at the outgoing termination, with the maximum rate equal to or lower than the maximum rate received in the EVS-CMR. The IM-MGW shall map received EVS-CMRs to the selected mode-set of the outgoing AMR-WB termination. +- If the codec of the incoming termination is AMR-WB and the codec of the outgoing termination is EVS, then the rate control procedure for AMR-WB shall apply on the incoming termination and shall determine the maximum rate included in the EVS-CMR sent by the IM-MGW. The IM-MGW shall request the EVS AMR-WB IO major operation mode in the outgoing EVS-CMR. +- The IM-MGW may filter and modify the CMR contents according to the following rules: + - 1) The IM-MGW shall not modify the EVS-CMR to increase the maximum bit rate; + - 2) If the IM-MGW observes the incoming stream of speech frames or packets and determines that a lower EVS mode is more appropriate, the IM-MGW may modify the EVS-CMRs sent in the opposite direction of the observed speech flow. + +If the IM-MGW bridges EVS codec configurations and AMR-WB codec configurations which are not compatible, the IM-MGW shall apply transcoding and shall handle the independent rate and mode control procedures towards the incoming and the outgoing networks. + +##### 8.1.1.3.5 Interworking between rate control and RTCP-APP-CMR messages for MTSI + +An IM-MGW may support the MTSI service defined in 3GPP TS 24.173 [88] and may then support codecs according to 3GPP TS 26.114 [104]. + +NOTE 1: Alternative codec specifications for the MTSI service are listed in 3GPP TS 24.173 [88]. + +If the IM-MGW supports the MTSI service with the codecs according to 3GPP TS 26.114 [104] the IM-MGW should support reception of RTCP-APP-CMR messages as specified in the clause 10.2.1 of 3GPP TS 26.114 [104] which can be sent by a MTSI client in the terminal. If the IM-MGW is in TrFO then RTCP-APP-CMR messages should be translated to the appropriate rate control method on the CS side (e.g. IuFP rate control or RTP based CMR) in the same way as for an RTP based CMR, described in the preceding subclauses. + +NOTE 2: When the IM-MGW is transcoding at the Mb interface then any RTCP-APP-CMR requests received from the MTSI client in the terminal when the IM-MGW is transcoding will result in a change to DL codec mode towards the MTSI client terminal. + +#### 8.1.1.4 Frame quality indication + +The Nb interface signals frame quality with the Frame Quality Classification (FQC) field of each speech frame PDU. See 3GPP TS 26.102 [50] and 3GPP TS 29.415 [26] for details. The FQC may have possible values: 0=frame\_good; 1=frame\_bad; 2=frame\_bad\_due\_to\_radio; and 3=spare. The Mb interface signals frame quality with the Q bit (frame quality indicator) field of each speech frame, as defined in IETF RFC 4867 [23]. The Q bit may have values: 1=speech\_good; and 0=speech\_bad or sid\_bad. + +Tables 24a and 24b provide the mapping between Mb and Nb interfaces. + +**Table 24a: Mapping of Mb (Q bit) onto Nb (FQC)** + +| Mb - Qbit | Mb - FT | Nb - FQC | +|-----------|---------|----------| +| 1 | X | 0 | +| 0 | X | 1 | + +**Table 24b: Mapping Nb onto Mb** + +| Nb - FQC | Mb - Qbit | Mb - FT | +|----------|-----------|---------| +| 0 | 1 | NC | +| 1 | 0 | NO DATA | +| 2 | 0 | NC | + +#### 8.1.1.5 Framing + +Even when the IM-MGW bridges compatible codec configurations between the Nb and Mb interfaces, the IM-MGW shall perform translation between the frame formats defined for the two interfaces, since all codec configurations have different framing procedures for the two interfaces. The framing details for Nb are defined in 3GPP TS 26.102 [50] and 3GPP TS 29.415 [26], although they do not describe the framing for ITU-T codecs other than G.711. The framing details for Mb are defined in IETF RFC 4867 [23], IETF RFC 3550 [51], IETF RFC 3551 [52] and IETF RFC 3555 [53]. + +#### 8.1.1.6 Transcoding + +Transcoding at the IM-MGW is avoided when the IM-MGW bridges compatible codec configurations between the Nb and Mb interfaces. Otherwise transcoding is necessary, which eliminates the need to interwork other user plane procedures between the interfaces. + +#### 8.1.1.7 Discontinuous transmission + +When the IM-MGW bridges compatible codec configurations between the Nb and Mb interfaces, the DTX procedures are normally interworked transparently by translating between the framing formats on the interfaces. All the ITU-T, AMR, AMR-WB and EVS codecs have configurations that are compatible between the Mb and Nb interfaces. + +For the AMR, AMR-WB and EVS codecs, DTX is always enabled on the CS radio Interface in the uplink direction and the transport channel for DTX in the downlink is always provided. + +If the IMS side requires interworking without DTX in its media-receive direction, then the IM-MGW shall insert transcoding in this direction. The IMS side may apply in its media-sending direction DTX or not, the CS side is prepared for both alternatives without transcoding. + +#### 8.1.1.8 Timing and sequence information + +The IM-MGW shall always correct out-of-sequence delivery between Nb and Mb interfaces, either by re-ordering frames, or by dropping frames that are out of sequence. + +When the IuFP frame numbers are based on time and if the IM-MGW bridges compatible codec configurations between the Nb and Mb interfaces, it shall either correct jitter before forwarding PDUs or interwork the RTP timestamp (see RFC 3550 [51]) with the IuFP Frame Number (see 3GPP TS 29.415 [26]) so that both the RTP timestamp and IuFP frame number similarly reflect the nominal sampling instant of the user data in the packet. + +NOTE: Correcting jitter may cause additional delay. + +The RTP sequence number (see RFC 3550 [51]) is handled independently on Mb, i.e. it is not interworked with the IuFP Frame Number (see 3GPP TS 29.415 [26]). + +## 8.2 Interworking between IM CN subsystem and TDM-based CS network + +It shall be possible for the IM CN subsystem to interwork with the TDM based CS networks (e.g. PSTN, ISDN or CS domain of a PLMN). Figure 32 describes the user plane protocol stack to provide the particular interworking. + +![Figure 32: IM CN subsystem to TDM-based CS network user plane protocol stack. The diagram shows a protocol stack for the IM-MGW. On the left side, the stack consists of AMR, RTP, UDP, IP, L2, and L1 layers. On the right side, the stack consists of G.711 PCM Coding, TDM CS Bearer Channel, and L1 layers. A 'Transcoding' label with a double-headed arrow is positioned above the AMR and G.711 PCM Coding layers, indicating the conversion between them. The bottom L1 layer is connected to the Mb interface on the left and the IM-MGW box on the right.](0b87abe67b21a93777287649c33e755d_img.jpg) + +Figure 32: IM CN subsystem to TDM-based CS network user plane protocol stack. The diagram shows a protocol stack for the IM-MGW. On the left side, the stack consists of AMR, RTP, UDP, IP, L2, and L1 layers. On the right side, the stack consists of G.711 PCM Coding, TDM CS Bearer Channel, and L1 layers. A 'Transcoding' label with a double-headed arrow is positioned above the AMR and G.711 PCM Coding layers, indicating the conversion between them. The bottom L1 layer is connected to the Mb interface on the left and the IM-MGW box on the right. + +Figure 32: IM CN subsystem to TDM-based CS network user plane protocol stack + +## 8.3 Transcoding requirements + +The IM CN subsystem supports the AMR codec as the native codec for basic voice services. For IM CN subsystem terminations, the IM MGW shall support the transport of AMR over RTP according to IETF RFC 4867 [23]. The MGCF shall support the options of IETF RFC 4867 [23] listed within subclause 12.3.1 of 3GPP TS 26.114 [104]. + +It shall be possible for the IM CN subsystem to interwork with the CS networks (e.g. PSTN, ISDN or a CS domain of a PLMN) by supporting AMR to G.711 transcoding (see ITU-T Recommendation G.711 [1]) in the IM-MGW. The IM-MGW may also perform transcoding between AMR and other codec types supported by CS networks. + +## 8.4 Diffserv code point requirements + +The IM-MGW shall perform DiffServ Code Point (DSCP) markings (see RFC 2474 [21]) on the IP packets sent towards the IM CN subsystem entity like UE or MRFP across the Mb interface to allow DiffServ compliant routers and GGSNs to schedule the traffic accordingly. + +The IETF Differentiated Services architecture (see RFC 2475 [22]) shall be used to provide QoS for the external bearer service. + +The DSCP shall be operator configurable. + +## 8.5 DTMF handling + +When sending DTMF inband towards the CS network, the MGW shall comply with the encoding requirements in 3GPP TS 23.014 [103]; in particular the requirements for the minimum length of a tone and for the minimum gap between two subsequent tones shall be ensured. + +When detecting DTMF digits arriving from the CS side, the MGW shall comply with 3GPP TS 23.014 [103] (by checking that a valid digit with minimum duration and minimum gap has been received) before initiating an RTP Telephony Event to the IMS interface. + +When sending DTMF towards the IMS side according to the IETF RFC 4733 [105] RTP Payload format, the MGW shall comply with the DTMF encoding requirements of Annex G.2 of 3GPP TS 26.114 [104], in particular the minimum duration of 65ms shall be ensured. It is optional if the RTP Telephony Event is sent as a number of "RTP Events" with interim durations (e.g. every 20ms or 40ms in line with the speech packetisation time) or as a single "RTP Event" with the at least 65ms duration. + +# 9 MGCF - IM-MGW Interaction + +## 9.1 Overview + +The MGCF shall control the functions of the IM-MGW, which are used to provide the connection between media streams of an IP based transport network and bearer channels from a CS network. + +The MGCF shall interact with the IM-MGW across the Mn reference point. The MGCF shall terminate the signalling across the Mn interface towards the IM-MGW and the IM-MGW shall terminate the signalling from the MGCF. + +The signalling interface across the Mn reference point shall be defined in accordance with ITU-T Recommendation H.248.1 [2] and shall conform to 3GPP specific extensions as detailed in 3GPP TS 29.332 [15]. + +The present specification describes Mn signalling procedures and their interaction with BICC/ISUP and SIP signalling in the control plane, and with user plane procedures. 3GPP TS 29.332 [15] maps these signalling procedures to H.248 messages and defines the required packages and parameters. + +## 9.2 Mn signalling interactions + +The following paragraphs describe the Mn interface procedures triggered by SIP and BICC signalling relayed in MGCF. + +The SIP signalling occurring at the MGCF is described in 3GPP TS 24.229 [9]. + +All message sequence charts in this clause are examples. + +### 9.2.1 Network model + +Figure 33 shows the network model, applicable to BICC and ISUP cases. The broken line represents the call control signalling. The dotted line represents the bearer control signalling (if applicable) and the user plane. The MGCF uses one context with two terminations in the IM-MGW. The termination T1 is used towards the IM CN subsystem entity and the bearer termination T2 is used for the bearer towards the succeeding CS network element. + +![Figure 33: Network model diagram showing MGCF and IM-MGW connected to a CS NETWORK.](c6005b2627c6ca10f6b0e94cdb34858d_img.jpg) + +The diagram illustrates the network model. On the left, there are two stacked boxes. The top box is labeled 'MGCF' and contains two curved arrows pointing towards each other. The bottom box is labeled 'IM-MGW' and contains two curved arrows pointing towards each other, with 'T1' and 'T2' labels above them respectively. A solid blue vertical line connects the MGCF box to the IM-MGW box. To the right is a large box labeled 'CS NETWORK'. A green dashed line connects the MGCF box to the CS NETWORK box. A red dotted line connects the IM-MGW box to the CS NETWORK box. The red dotted line passes through the IM-MGW box, specifically through the 'T1' and 'T2' terminations. + +Figure 33: Network model diagram showing MGCF and IM-MGW connected to a CS NETWORK. + +Figure 33: Network model + +### 9.2.2 Basic IM CN subsystem originated session + +#### 9.2.2.1 BICC forward bearer establishment + +##### 9.2.2.1.1 IM-MGW selection + +The MGCF shall select an IM-MGW for the bearer connection before it performs the CS network side bearer establishment. This may happen either before sending the IAM or after receiving the APM message (signal 5 or signal 6 in figure 34). In the latter case, the IM-MGW selection may be based on a possibly received MGW-id from the succeeding node. + +##### 9.2.2.1.2 CS network side bearer establishment + +The MGCF shall either select bearer characteristics or request the IM-MGW to select and provide the bearer characteristics for the CS network side bearer connection before sending the IAM. In the latter case the MGCF shall use the Prepare Bearer procedure, not shown in figure 34, to request the IM-MGW to select the bearer characteristics. After the succeeding node has provided a bearer address and a binding reference in the APM, the MGCF shall use the Establish Bearer procedure to request the IM-MGW to establish a bearer towards the destination CS-MGW. The MGCF shall provide the IM-MGW with the bearer address, the binding reference and the bearer characteristics (signal 7 in figure 34). + +##### 9.2.2.1.3 IM CN subsystem side termination reservation + +On receipt of an initial INVITE (signal 1 in figure 34) the MGCF shall initiate the Reserve IMS Connection Point and Configure Remote Resources procedure (signal 3 and 4 in figure 34). From the received SDP and local configuration data the MGCF: + +- Shall send the appropriate remote codec(s), the remote UDP port and the remote IP address to the IM-MGW. The remote UDP port and IP address refer to the destination of user plane data sent towards the IM CN subsystem. The remote codec(s) are the codec(s) the IM-MGW may select for user plane data sent towards the IM CN subsystem. +- Shall indicate to the IM-MGW the appropriate local codec(s) and request a local IP address and UDP port. The local IP address and UDP port are used by the IM-MGW to receive user plane data from the IM CN subsystem. The local codec(s) are the codec(s) the IM-MGW may select to receive user plane data from the IM CN subsystem. +- If DTMF support together with speech support is required, the reserve value indicator shall be set to "true". +- May indicate that IP interface type is for MboIP. + +The IM-MGW + +- Shall reply to the MGCF with the selected local codec(s) and the selected remote codec(s) and the selected local UDP port and IP address. +- Shall reserve resources for those codec(s). + +The MGCF shall send the local codec(s), UDP port and IP address to the IMS in the Session Progress (signal 9 in figure 34). + +##### 9.2.2.1.4 IM CN subsystem side session establishment + +Dependent on what the MGCF receives in the PRACK message (signal 10 in figure 34), the MGCF may initiate the Configure IMS Resources procedure. If no SDP is received, or if the received SDP does not contain relevant changes compared to the previous SDP sent to the IMS in signal 9 in figure 34, the procedure is not invoked. Otherwise the MGCF shall use the Configure IMS Resources procedure to provide to the IM-MGW: + +- The appropriate remote codec(s), the remote UDP port and the remote IP address. +- Optionally the appropriate local codec(s), UDP port and IP address. +- If DTMF support together with speech support is required, the reserve value indicator shall be set to "true". + +- May indicate that IP interface type is for MboIP. + +The IM-MGW shall: + +- Reply to the MGCF with the selected remote codec(s), +- Reply to the MGCF with the selected local codec(s) if the MGCF supplied local codec(s), +- Update the codec reservation and remote IP address and remote UDP port in accordance with the received information. + +The MGCF shall include the selected codec(s) and UDP port and IP address in a 200 OK (PRACK) (signal 11 in figure 34) sent back to the IMS. + +##### 9.2.2.1.5 Through-connection + +During the Prepare Bearer and Establish Bearer procedures, the MGCF shall either use the Change Through-Connection procedure to request the IM-MGW to backward through-connect the BICC terminations, or the MGCF shall use this procedure to both-way through-connect the BICC termination already on this stage (signal 7 in figure 34). During the Reserve IMS Connection Point procedure: + +- if the MGCF has been identified a call as an "ICS call" as specified in clause 7.3.3.1.2.12 the MGCF shall request the IM MGW to suspend sending media towards the IMS side by setting the through-connection of the IM CN subsystem side termination to "not through-connected" using the Change IMS Through Connection procedure (signal 3 in figure 34); and +- otherwise the MGCF shall use the Change IMS Through-Connection procedure to request the IM-MGW to backward through-connect the IMS termination (signal 3 in figure 34). + +When the MGCF receives a BICC ACM or CPG message with an UID action indicators parameter with the through-connection instruction indicator set to "*through-connect in both directions*" the MGCF shall request the IM-MGW to both-way through-connect the terminations using the Change IMS Through-Connection or Change Through-Connection procedures (signal 18 in figure 34), unless those terminations are already both-way through-connected. + +When the MGCF receives the BICC:ANM answer indication, it shall request the IM-MGW to both-way through-connect the termination using the Change Through-Connection or Change IMS Through-Connection procedures (signal 24 in figure 34), unless those terminations are already both-way through-connected. + +##### 9.2.2.1.6 Codec handling + +The IM-MGW may include a speech transcoder based upon the speech coding information provided to each termination. + +##### 9.2.2.1.7 Failure handling in MGCF + +If any procedure between the MGCF and the IM-MGW is not completed successfully the default action by the MGCF is to release the session, as described in clause 9.2.6. If the MGCF receives a Bearer Released procedure from the IM-MGW the default action by the MGCF is to release the session as described in clause 9.2.7. + +- NOTE: As an implementation option the MGCF may also decide for example to only release the resources in the IM-MGW that caused the failure, possibly select a new IM-MGW for the connection and continue the call establishment using new resources in the selected IM-MGW but such handling is outside of the scope of the present document. + +##### 9.2.2.1.8 Message sequence chart + +Figure 34 shows the message sequence chart for the IM CN subsystem originating session with BICC forward bearer establishment where the selection of IM-MGW is done before the sending of the IAM. In the chart the MGCF requests the seizure of an IM CN subsystem side termination. When the APM is received from the succeeding node, the MGCF requests the seizure of a CS network side bearer termination and the establishment of the bearer. When the MGCF receives an answer indication, it requests the IM-MGW to both-way through-connect the terminations. Dashed lines represent optional or conditional messages. + +![Sequence diagram for Basic IM CN Subsystem originating session, BICC forward bearer establishment. Lifelines: MGCF and IM-MGW. The diagram shows the interaction between MGCF and IM-MGW for session establishment, including SIP INVITE, H.248 ADD.req/resp, and BICC IAM/APM messages. Annotations describe conditions like 'if SIP 100 rel is used', 'Only if SIP Preconditions are used', and 'Change IMS Through-Connection = both'. A 'CALL IN ACTIVE STATE' bar is shown at the bottom.](ff0952ef692c9d960ce5f6708bcc9711_img.jpg) + +``` + +sequenceDiagram + participant MGCF + participant IM-MGW + + Note left of MGCF: Reserve IMS Connection Point and Configure Remote Resource, Change IMS Through-Connection = backward + MGCF->>MGCF: 1. SIP: INVITE + MGCF-->>MGCF: 2. SIP: 100 Trying + MGCF->>IM-MGW: 3. H.248: ADD.req [Context ID = ?, Termination ID=?] + IM-MGW-->>MGCF: 4. H.248: ADD.resp [Context ID = C1, Termination ID = T1] + + Note left of MGCF: if SIP 100 rel is used + MGCF-->>MGCF: 9. SIP: 183 Session Progress + MGCF->>IM-MGW: 5. BICC: IAM + IM-MGW-->>MGCF: 6. BICC: APM + + Note left of MGCF: Establish Bearer, Change Through-Connection = both + MGCF->>IM-MGW: 7. H.248: ADD.req [Context ID = C1, Termination ID = ?] + IM-MGW-->>MGCF: 8. H.248: ADD.resp [Context ID = C1, Termination ID = T2] + Note right of IM-MGW: Bearer Establishment + + Note left of MGCF: if SIP 100 rel is used + MGCF-->>MGCF: 10. SIP: PRACK + MGCF-->>MGCF: 11. SIP: 200 OK (PRACK) + MGCF->>IM-MGW: 12. H.248: MOD.req [Context ID = C1, Termination ID = T1] + IM-MGW-->>MGCF: 13. H.248: MOD.resp [Context ID = C1, Termination ID = T1] + Note right of IM-MGW: Configure IMS Resources + + Note left of MGCF: Only if SIP Preconditions are used + MGCF-->>MGCF: 14. SIP: UPDATE + MGCF-->>MGCF: 15. SIP: 200 OK (UPDATE) + MGCF->>IM-MGW: 16. BICC: COT + IM-MGW-->>MGCF: 17. BICC: ACM + Note right of IM-MGW: Only if BICC continuity check and/or SIP Preconditions are used + + Note left of MGCF: Change IMS Through-Connection = both + MGCF->>IM-MGW: 18. H.248: MOD.req [Context ID=C1, Termination ID = T1] + IM-MGW-->>MGCF: 19. H.248: MOD.resp [Context ID = C1, Termination ID = T1] + Note right of IM-MGW: Only if BICC UID action indicates through-connect both directions Optional + + MGCF-->>MGCF: 20. SIP: 180 Ringing + MGCF-->>MGCF: 21. SIP: PRACK + MGCF-->>MGCF: 22. SIP: 200 OK (PRACK) + MGCF->>IM-MGW: 23. BICC: ANM + Note right of IM-MGW: Change IMS Through-Connection = both + MGCF->>IM-MGW: 24. H.248: MOD.req [Context ID=C1, Termination ID = T1] + IM-MGW-->>MGCF: 25. H.248: MOD.resp [Context ID = C1, Termination ID = T1] + + MGCF-->>MGCF: 26. SIP: 200 OK (INVITE) + MGCF->>MGCF: 27. SIP: ACK + + Note right of MGCF: CALL IN ACTIVE STATE + +``` + +Sequence diagram for Basic IM CN Subsystem originating session, BICC forward bearer establishment. Lifelines: MGCF and IM-MGW. The diagram shows the interaction between MGCF and IM-MGW for session establishment, including SIP INVITE, H.248 ADD.req/resp, and BICC IAM/APM messages. Annotations describe conditions like 'if SIP 100 rel is used', 'Only if SIP Preconditions are used', and 'Change IMS Through-Connection = both'. A 'CALL IN ACTIVE STATE' bar is shown at the bottom. + +Figure 34: Basic IM CN Subsystem originating session, BICC forward bearer establishment (message sequence chart) + +#### 9.2.2.2 BICC backward bearer establishment + +##### 9.2.2.2.1 IM-MGW selection + +The MGCF shall select an IM-MGW for the bearer connection before it performs the IM CN subsystem session establishment or the CS network side bearer establishment, and before it sends the IAM (signal 8 in figure 35). + +##### 9.2.2.2.2 IM CN subsystem side termination reservation + +On receipt of an initial INVITE (signal 1 in figure 35) the MGCF shall initiate the Reserve IMS Connection Point and Configure Remote Resources procedure (signal 3 and 4 in figure 35). From the received SDP and local configuration data the MGCF: + +- Shall send the appropriate remote codec(s), the remote UDP port and the remote IP address to the IM-MGW. The remote UDP port and IP address refer to the destination of user plane data sent towards the IM CN subsystem. The remote codec(s) are the codec(s) the IM-MGW may select for user plane data sent towards the IM CN subsystem. +- Shall indicate to the IM-MGW the appropriate local codec(s) and request a local IP address and UDP port. The local UDP port and IP address are used by the IM-MGW to receive user plane data from the IM CN subsystem. The local codec(s) are the codec(s) the IM-MGW may select to receive user plane data from the IM CN subsystem. +- If DTMF support together with speech support is required, the reserve value indicator shall be set to "true". +- May indicate that IP interface type is for MboIP. + +The IM-MGW shall + +- Reply to the MGCF with the selected local codec(s) and the selected remote codec(s) and the selected local UDP port and IP address. +- Reserve resources for those codec(s). + +The MGCF shall send the local codec(s), UDP port and IP address to the IMS in the Session Progress (signal 5 in figure 35). + +##### 9.2.2.2.3 IM CN subsystem side session establishment + +Dependent on what the MGCF receives in the PRACK message (signal 9 in figure 35) the MGCF may initiate the Select Configure IMS Resources procedure (signals 10 and 11 in figure 35). If no SDP is received, or if the received SDP does not contain relevant changes compared to the previous SDP the procedure is not invoked. Otherwise the MGCF shall use the Configure IMS Resources procedure to provide to the IM-MGW: + +- the appropriate remote codec(s), the remote UDP port and the remote IP address. +- optionally if DTMF support together with speech support is required, the reserve value indicator shall be set to "true". +- May indicate that IP interface type is for MboIP. + +The IM-MGW shall: + +- Reply to the MGCF with the selected remote codec(s). +- Reply to the MGCF with the selected local codec(s), if the MGCF supplied local codec(s). +- Update the codec reservation and remote IP address and remote UDP port in accordance with the received information. + +The MGCF shall include the selected codec(s), IP address and UDP port in an 200 OK (PRACK) (signal 12 in figure 35) sent back to the IMS + +##### 9.2.2.2.4 CS network side bearer establishment + +The MGCF shall request the IM-MGW to prepare for the CS network side bearer establishment using the Prepare Bearer procedure before sending the IAM to the succeeding node. Within this procedure, the MGCF shall request the IM-MGW to provide a bearer address and a binding reference, and the MGCF shall either provide the IM-MGW with the preferred bearer characteristics or it shall request the IM-MGW to select and provide the bearer characteristics (signal 6 in figure 35). After the IM-MGW has replied with the bearer address, the binding reference and the bearer characteristics (if requested), the MGCF sends the IAM to the succeeding node (signal 8 in figure 35). + +##### 9.2.2.2.5 Through-connection + +During the Prepare Bearer procedure, the MGCF shall either use the Change Through-Connection procedure to request the IM-MGW to backward through-connect the BICC termination, or the MGCF shall use this procedure to both-way through-connect the BICC termination already on this stage (signal 6 in figure 35). During the Reserve IMS Connection Point procedure: + +- if the MGCF has been identified a call as an "ICS call" as specified in clause 7.3.3.1.2.12 the MGCF shall request the IM-MGW to suspend sending media towards the IMS side by setting the through-connection of the IM CN subsystem side termination to "not through-connected" using the Change IMS Through-Connection procedure (signal 3 in figure 35); and +- otherwise the MGCF shall use the Change IMS Through-Connection procedure to request the IM-MGW to backward through-connect the IMS termination (signal 3 in figure 35). + +When the MGCF receives an BICC ACM or CPG message with an UID action indicators parameter with the through-connection instruction indicator set to "*through-connect in both directions*" the MGCF shall request the IM-MGW to both-way through-connect the terminations using the Change IMS Through-Connection or Change Through-Connection procedures (signal 17 in figure 35), unless those terminations are already both-way through-connected. + +When the MGCF receives the BICC:ANM answer indication, it shall request the IM-MGW to both-way through-connect the terminations using the Change Through-Connection or Change IMS Through-Connection procedures (signal 23 in figure 35), unless those terminations are already both-way through-connected. + +##### 9.2.2.2.6 Codec handling + +The IM-MGW may include a speech transcoder based upon the speech coding information provided to each termination. + +##### 9.2.2.2.7 Failure handling in MGCF + +If any procedure between the MGCF and the IM-MGW is not completed successfully the default action by the MGCF is to release the session as described in clause 9.2.6. If the MGCF receives a Bearer Released procedure from the IM-MGW the default action by the MGCF is to release the session, as described in clause 9.2.7. + +NOTE: As an implementation option the MGCF may also decide for example to only release the resources in the IM-MGW that caused the failure, possibly select a new IM-MGW for the connection and continue the call establishment using new resources in the selected IM-MGW but such handling is outside of the scope of the present document. + +##### 9.2.2.2.8 Message sequence chart + +Figure 35 shows the message sequence chart for the IM CN subsystem originating session with BICC backward bearer establishment. In the chart the MGCF requests the seizure of an IM CN subsystem side termination and a CS network side bearer termination. When the MGCF receives an answer indication, it requests the IM-MGW to both-way through-connect the terminations. Dashed lines represent optional or conditional messages. + +![Sequence diagram for Basic IM CN Subsystem originating session, BICC backward bearer establishment. The diagram shows interactions between MGCF and IM-MGW. The process starts with SIP INVITE and ends with SIP ACK. Key steps include H.248 ADD.req/resp for resource reservation, BICC IAM for bearer establishment, H.248 MOD.req/resp for resource configuration, BICC COT/ACM for continuity check, and H.248 MOD.req/resp for bearer change. The final state is 'CALL IN ACTIVE STATE'.](1a827b10290f33d4fec04d0e8ef7a897_img.jpg) + +The sequence diagram illustrates the message exchange between the MGCF and the IM-MGW for a Basic IM CN Subsystem originating session. The sequence of messages is as follows: + +1. **SIP: INVITE** (MGCF to IM-MGW) +2. **SIP: 100 Trying** (IM-MGW to MGCF) +3. **H.248: ADD.req** [Context ID = ?, Termination ID=?] (MGCF to IM-MGW) - *Reserve IMS Connection Point and Configure Remote Resources, Change IMS Through -Connection = backward* +4. **H.248: ADD.resp** [Context ID = C1, Termination ID = T1] (IM-MGW to MGCF) +5. **SIP: 183 Session Progress** (MGCF to IM-MGW) - *if SIP 100 rel is used* +6. **H.248: ADD.req** [Context ID = C1, Termination ID = ?] (MGCF to IM-MGW) - *Prepare Bearer, Change Through-Connection = both* +7. **H.248: ADD.resp** [Context ID = C1, Termination ID = T2] (IM-MGW to MGCF) +8. **BICC: IAM** (MGCF to IM-MGW) - *Bearer Establishment* +9. **SIP: PRACK** (MGCF to IM-MGW) - *if SIP 100 rel is used* +10. **H.248: MOD.req** [Context ID = C1, Termination ID = T1] (MGCF to IM-MGW) - *Configure IMS Resources* +11. **H.248: MOD.resp** [Context ID = C1, Termination ID = T1] (IM-MGW to MGCF) +12. **SIP: 200 OK (PRACK)** (MGCF to IM-MGW) +13. **SIP: UPDATE** (MGCF to IM-MGW) - *Only if SIP Preconditions are used* +14. **SIP: 200 OK (UPDATE)** (IM-MGW to MGCF) +15. **BICC: COT** (MGCF to IM-MGW) - *Only if BICC continuity check and/or SIP Preconditions are used* +16. **BICC: ACM** (MGCF to IM-MGW) +17. **H.248: MOD.req** [Context ID=C1, Termination ID = T1] (MGCF to IM-MGW) - *Only if BICC UID action indicates through-connection in both direction* +18. **H.248: MOD.resp** [Context ID = C1, Termination ID = T1] (IM-MGW to MGCF) +19. **SIP: 180 Ringing** (MGCF to IM-MGW) - *Change IMS Through-Connection = both* +20. **SIP: PRACK** (MGCF to IM-MGW) +21. **SIP: 200 OK (PRACK)** (MGCF to IM-MGW) +22. **BICC: ANM** (MGCF to IM-MGW) +23. **H.248: MOD.req** [Context ID=C1, Termination ID = T1] (MGCF to IM-MGW) - *Change IMS Through-Connection = both* +24. **H.248: MOD.resp** [Context ID = C1, Termination ID = T1] (IM-MGW to MGCF) +25. **SIP: 200 OK (INVITE)** (MGCF to IM-MGW) +26. **SIP: ACK** (IM-MGW to MGCF) + +At the bottom, a double-headed arrow spans from the MGCF to the IM-MGW, labeled **CALL IN ACTIVE STATE**. + +Sequence diagram for Basic IM CN Subsystem originating session, BICC backward bearer establishment. The diagram shows interactions between MGCF and IM-MGW. The process starts with SIP INVITE and ends with SIP ACK. Key steps include H.248 ADD.req/resp for resource reservation, BICC IAM for bearer establishment, H.248 MOD.req/resp for resource configuration, BICC COT/ACM for continuity check, and H.248 MOD.req/resp for bearer change. The final state is 'CALL IN ACTIVE STATE'. + +**Figure 35: Basic IM CN Subsystem originating session, BICC backward bearer establishment (message sequence chart)** + +#### 9.2.2.3 ISUP + +##### 9.2.2.3.1 IM-MGW selection + +The MGCF shall select an IM-MGW with circuits to the given destination in the CS domain before it performs the IM CN subsystem session establishment and before it sends the IAM (signal 8 in figure 36). + +##### 9.2.2.3.2 IM CN subsystem side termination reservation + +On receipt of an initial INVITE (signal 1 in figure 36) the MGCF shall initiate the Reserve IMS Connection Point and Configure Remote Resources procedure (signal 3 and 4 in figure 36). From the received SDP and local configuration data the MGCF: + +- shall send the appropriate remote codec(s), the remote UDP port and the remote IP address to the IM-MGW. The remote UDP port and IP address refer to the destination of user plane data sent towards the IM CN subsystem. + +The remote codec(s) are the codec(s) the IM-MGW may select for user plane data sent towards the IM CN subsystem. + +- shall indicate to the IM-MGW the appropriate local codec(s) and request a local IP address and UDP port. The local IP address and UDP port are used by the IM-MGW to receive user plane data from the IM CN subsystem. The local codec(s) are the codec(s) the IM-MGW may select to receive user plane data from the IM CN subsystem. +- If DTMF support together with speech support is required, the reserve value indicator shall be set to "true". +- May indicate that IP interface type is for MboIP. + +The IM-MGW shall + +- reply to the MGCF with the selected local codec(s) and the selected remote codec(s) and the selected local UDP port and IP address. +- reserve resources for those codec(s). + +The MGCF shall send selected local codec(s) and the selected remote codec and the selected local UDP port and IP address to the IMS in the Session Progress (signal 5 in figure 36) + +##### 9.2.2.3.3 IM CN subsystem side session establishment + +Dependent on what the MGCF receives in the PRACK message (signal 9 in figure 35) the MGCF may initiate the Configure IMS Resources procedure. If no SDP is received, or if the received SDP does not contain relevant changes compared to the previous SDP, the procedure is not invoked. Otherwise the MGCF shall use the Configure IMS Resources procedure to provide to the IM-MGW: + +- the appropriate remote codec(s), the remote UDP port and the remote IP address. +- optionally the appropriate local codec(s), UDP port and IP address. +- If DTMF support together with speech support is required, the reserve value indicator shall be set to "true". +- May indicate that IP interface type is for MboIP. + +The IM-MGW shall: + +- reply to the MGCF with the selected remote codec. +- reply to the MGCF with the selected local codec(s), if the MGCF supplied local codec(s). +- update the codec reservation and remote IP address and UDP port in accordance with the received information. + +The MGCF shall include the selected codec(s) UDP port and IP address in 200 OK (PRACK) (signal 12 in figure 36) sent back to the IMS. + +##### 9.2.2.3.4 CS network side circuit reservation + +The MGCF shall request the IM-MGW to reserve a circuit using the Reserve TDM Circuit procedure. The MGCF sends the IAM to the succeeding node including the reserved circuit identity. + +##### 9.2.2.3.5 Through-connection + +During the Reserve TDM Circuit and Reserve IMS Connection Point procedures, the MGCF shall either use the Change TDM Through-Connection procedure to request the IM-MGW to backward through-connect the termination, or the MGCF shall use this procedure to both-way through-connect the TDM termination already on this stage (signal 6 in figure 36). During the Reserve IMS connection Point procedure: + +- if the MGCF has been identified a call as an "ICS call" as specified in clause 7.2.3.1.12 the MGCF shall request the IM-MGW to suspend sending media towards the IMS side by setting the through-connection of the IM CN subsystem side termination to "not through-connected" using the Change IMS Through-Connection procedure (signal 3 in figure 36); and + +- otherwise the MGCF shall use the Change IMS through-connection procedure to request the IM-MGW to backward through-connect the IMS termination (signal 3 in figure 36). + +When the MGCF receives an ISUP ACM or CPG message with an UID action indicators parameter with the through-connection instruction indicator set to "*through-connect in both directions*" the MGCF shall request the IM-MGW to both-way through-connect the terminations using the Change IMS Through-Connection or Change TDM Through-Connection procedures (signal 17 in figure 36), unless those terminations are already both-way through-connected. + +When the MGCF receives the ISUP:ANM answer indication, it shall request the IM-MGW to both-way through-connect the terminations using the Change IMS Through-Connection or Change TDM Through-Connection procedures (signal 23 in figure 36), unless those terminations are already both-way through-connected. + +##### 9.2.2.3.6 Continuity check + +The MGCF may request a continuity check on the connection towards the CS network within the IAM message. In this case, the MGCF shall use the Continuity Check procedure towards the IM-MGW to request the generation of a continuity check tone on the TDM termination. The IM-MGW shall then use the Continuity Check Verify procedure to notify the MGCF of an incoming continuity check tone on the corresponding circuit. In addition to other conditions detailed in Clause 7, the MGCF shall wait until receiving this notification before sending the COT. (Not depicted in figure 36) + +##### 9.2.2.3.7 Codec handling + +The IM-MGW may include a speech transcoder based upon the speech coding information provided to each termination. + +##### 9.2.2.3.8 Voice processing function + +A voice processing function located on the IM-MGW may be used to achieve desired acoustic quality on the terminations. If the voice processing function is used, the MGCF shall request the activation of it in the termination towards the CS network using the Activate TDM Voice Processing Function procedure (signal 23 in figure 36). + +##### 9.2.2.3.9 Failure handling in MGCF + +If any procedure between the MGCF and the IM-MGW is not completed successfully session shall be released as described in clause 9.2.6. If the MGCF receives a Bearer Released procedure from the IM-MGW the default action by the MGCF is to release the session as described in clause 9.2.7. + +##### 9.2.2.3.10 Message sequence chart + +Figure 36 shows the message sequence chart for the IM CN subsystem originating session. In the chart the MGCF requests the seizure of an IM CN subsystem side termination and a CS network side bearer termination. When the MGCF receives an answer indication, it requests the IM-MGW to both-way through-connect the terminations. The MGCF requests the possible activation of the voice processing functions for the bearer terminations. Dashed lines represent optional or conditional messages. + +![Sequence diagram for Basic IM CN Subsystem originating session, ISUP. The diagram shows the interaction between MGCF and IM-MGW. The sequence starts with SIP INVITE and ends with SIP ACK, with a 'CALL IN ACTIVE STATE' indicated at the bottom. Various SIP, H.248, and ISUP messages are exchanged, with conditional blocks for SIP 100 rel, SIP Preconditions, and ISUP actions.](8fa679f79a1bb1f527cba9f29e784e89_img.jpg) + +``` + +sequenceDiagram + participant User + participant MGCF + participant IM-MGW + + Note left of MGCF: if SIP 100 rel is used + User->>MGCF: 1. SIP: INVITE + MGCF-->>User: 2. SIP: 100 Trying + MGCF->>IM-MGW: 3. H.248: ADD.req [Context ID = ?, Termination ID=?] + IM-MGW-->>MGCF: 4. H.248: ADD.resp [Context ID = C1, Termination ID = T1] + Note right of IM-MGW: Reserve IMS Connection Point, and Configure Remote Resources +Change IMSThrough-Connection = backward + MGCF-->>User: 5. SIP: 183 Session Progress + MGCF->>IM-MGW: 6. H.248: ADD.req [Context ID = C1, Termination ID = T2] + IM-MGW-->>MGCF: 7. H.248: ADD.resp [Context ID = C1, Termination ID = T2] + Note right of IM-MGW: Reserve TDM Circuit, Change TDM Through-Connection= both + MGCF->>IM-MGW: 8. ISUP: IAM + Note left of MGCF: if SIP 100 rel is used + MGCF-->>User: 9. SIP: PRACK + MGCF->>IM-MGW: 10. H.248: MOD.req [Context ID = C1, Termination ID = T1] + IM-MGW-->>MGCF: 11. H.248: MOD.resp [Context ID = C1, Termination ID = T1] + Note right of IM-MGW: Configure IMS Resources + MGCF-->>User: 12. SIP: 200 OK (PRACK) + Note left of MGCF: Only if SIP Preconditions are used + MGCF-->>User: 13. SIP: UPDATE + MGCF-->>User: 14. SIP: 200 OK (UPDATE) + MGCF-->>IM-MGW: 15. ISUP: COT + Note right of IM-MGW: Only if ISUP continuity check and/or SIP Preconditions are used + MGCF-->>IM-MGW: 16. ISUP: ACM + Note left of MGCF: Change IMS Through-Connection = both + MGCF->>IM-MGW: 17. H.248: MOD.req [Context ID=C1, Termination ID = T1] + IM-MGW-->>MGCF: 18. H.248: MOD.resp [Context ID = C1, Termination ID = T1] + Note right of IM-MGW: Only if ISUP UID action indicates through connection in both directions +Optional + MGCF-->>User: 19. SIP: 180 Ringing + MGCF-->>User: 20. SIP: PRACK + MGCF-->>User: 21. SIP: 200 OK (PRACK) + MGCF->>IM-MGW: 22. ISUP: ANM + MGCF->>IM-MGW: 23. H.248: MOD.req [Context ID=C1, Termination ID = T1] + IM-MGW-->>MGCF: 24. H.248: MOD.resp [Context ID = C1, Termination ID = T1] + Note right of IM-MGW: Change IMS Through-Connection = both + MGCF->>IM-MGW: 25. H.248: MOD.req [Context ID=C1, Termination ID = T2] + IM-MGW-->>MGCF: 26. H.248: MOD.resp [Context ID = C1, Termination ID = T2] + Note right of IM-MGW: Activate TDM Voice Processing Function + MGCF-->>User: 27. SIP: 200 OK (INVITE) + MGCF->>User: 28. SIP: ACK + Note bottom: CALL IN ACTIVE STATE + +``` + +Sequence diagram for Basic IM CN Subsystem originating session, ISUP. The diagram shows the interaction between MGCF and IM-MGW. The sequence starts with SIP INVITE and ends with SIP ACK, with a 'CALL IN ACTIVE STATE' indicated at the bottom. Various SIP, H.248, and ISUP messages are exchanged, with conditional blocks for SIP 100 rel, SIP Preconditions, and ISUP actions. + +Figure 36: Basic IM CN Subsystem originating session, ISUP (message sequence chart) + +### 9.2.3 Basic CS network originated session + +#### 9.2.3.1 BICC forward bearer establishment + +##### 9.2.3.1.1 IM-MGW selection + +The MGCF shall select an IM-MGW for the bearer connection before it performs the IM CN subsystem session establishment or the CS network side bearer establishment. + +##### 9.2.3.1.2 IM CN subsystem side termination reservation + +The MGCF shall derive from configuration data one or several appropriate local codec(s) the IM-MGW may use to receive user plane data from the IM CN subsystem. The MGCF shall use the Reserve IMS Connection Point procedure (signals 2 and 3 in figure 37). Within this procedure, the MGCF shall indicate the local codec(s) and request a local IP address and UDP port from the IM-MGW. The local IP address and UDP port are used by the IM-MGW to receive user plane data from the IM CN subsystem. If DTMF support together with speech support is required, or if the resources for multiple speech codecs shall be reserved at this stage, the reserve value indicator shall be set to "true". + +The MGCF may also indicate that the IP interface type is for MboIP. + +The IM-MGW shall reply to the MGCF with the selected local codec(s) and the selected local IP address and UDP port. + +The MGCF shall send this information in the INVITE (signal 4 in figure 37) to the IM CN subsystem. + +##### 9.2.3.1.3 IM CN subsystem side session establishment + +The MGCF shall use the Configure IMS Resources procedure (signals 7 and 8 or 23a and 23b in figure 37) to provide configuration data (derived from SDP received in signal 6 in figure 37 and local configuration data) to the IM-MGW as detailed below: + +- The MGCF shall indicate the remote IP address and UDP port, i.e. the destination IP address and UDP port for data sent in the user plane towards the IM CN subsystem, +- The MGCF shall indicate the remote codec(s), i.e. the speech codec(s) for data sent in the user plane towards the IM CN subsystem. +- The MGCF may indicate the local codec(s) and the local IP address and UDP port. The MGCF shall indicate the local codec(s) if a change is required. +- IF DTMF support together with speech support is required, the reserve value indicator shall be set to "true". +- The MGCF may indicate that IP interface type is for MboIP. + +The IM-MGW shall reply with the selected remote codec(s) and reserve resources for these codec(s). If local codec(s) were received, the IM-MGW shall also reply with the selected local codec(s) and reserve the corresponding resources. + +If the selected local codec(s) differ from the codec(s) received in the SDP of signal 6 in figure 37 (if any), the MGCF shall send the local reserved codec(s), and the local IP address and UDP port in the PRACK (signal 9 in figure 37) to the IMS. + +If the selected local codec(s) differ from the codec(s) received in the SDP of signal 23 in figure 37 (if any), the MGCF shall send the local reserved codec(s), and the local IP address and UDP port in an re-INVITE or UPDATE (not depicted in figure 37) to the IMS. + +##### 9.2.3.1.4 CS network side bearer establishment + +The MGCF shall request the IM-MGW to prepare for the CS network side bearer establishment using the Prepare Bearer procedure (signals 11 and 12 in figure 37). Within this procedure, the MGCF shall request the IM-MGW to provide a bearer address, a binding reference and optionally notify when the bearer is established. The MGCF shall also provide the IM-MGW with the bearer characteristics that was received from the preceding node in the IAM. After the IM-MGW has replied with the bearer address and the binding reference, the MGCF provides the APM message (signals 13 in figure 37) to the preceding node. The MGCF may also provide the IM-MGW-id in the APM message. + +##### 9.2.3.1.5 Called party alerting + +The MGCF shall request the IM-MGW to provide an awaiting answer indication (ringing tone) to the calling party using the Send Tone procedure (signals 20 and 21 in figure 37) , when the following condition is satisfied: + +- the MGCF receives the first 180 Ringing message, unless this message or some previous SIP provisional response contained a P-Early-Media header field that authorizes early media. + +##### 9.2.3.1.6 Called party answer + +When the MGCF receives a 200 OK message (signal 23 in figure 34), it shall request the IM-MGW to stop providing the ringing tone to the calling party using the Stop Tone procedure (signals 26 and 27 in figure 37). + +##### 9.2.3.1.7 Through-Connection + +During the Prepare Bearer procedure, the MGCF shall either use the Change Through-Connection procedure to request the IM-MGW to backward through-connect the BICC termination, or the MGCF shall use this procedure to both-way through-connect the BICC termination already on this stage (signals 11 and 12 in figure 37). During the Reserve IMS Connection Point procedure, the MGCF shall use the Change IMS Through-Connection procedure to request the IM-MGW to backward through-connect the IMS termination (signals 2 and 3 in figure 37). + +When the MGCF receives the SIP 200 OK(INVITE) (signal 23 in figure 37), it requests the IM-MGW to both-way through-connect the terminations using the Change IMS Through-Connection or Change Through-Connection procedures (signals 28 and 29 in figure 37), unless those terminations are already both-way through-connected. + +##### 9.2.3.1.8 Codec handling + +The IM-MGW may include a speech transcoder based upon the speech coding information provided to each termination. + +##### 9.2.3.1.9 Failure handling in MGCF + +If any procedure between the MGCF and the IM-MGW is not completed successfully, the default action by the MGCF is to release the session as described in clause 9.2.6. If the MGCF receives a Bearer Released procedure from the IM-MGW the default action by the MGCF is to release the session, as described in clause 9.2.7. + +- NOTE: As an implementation option the MGCF may also decide for example to only release the resources in the IM-MGW that caused the failure, possibly select a new IM-MGW for the connection and continue the call establishment using new resources in the selected IM-MGW but such handling is outside of the scope of the present document. + +##### 9.2.3.1.10 Message sequence chart + +Figure 37 shows the message sequence chart for the CS network originating session with BICC forward bearer establishment. In the chart the MGCF requests the seizure of the IM CN subsystem side termination and CS network side bearer termination. When the MGCF receives an answer indication, it requests the IM-MGW to both-way through-connect the terminations. Dashed lines represent optional or conditional messages. + +![Sequence chart showing Basic CS Network Originating Session, Forward Bearer Establishment between IM-MGW and MGCF. The chart includes messages like BICC: IAM, H.248: ADD.req, SIP: INVITE, and H.248: MOD.req. Annotations include 'Configure IMS Resources', 'Bearer Establishment', and 'Send Tone'.](e180f2b5fcbe8001554a7c0677cd3f82_img.jpg) + +The sequence chart illustrates the interaction between IM-MGW and MGCF for a Basic CS Network Originating Session. The process begins with the IM-MGW sending a **1. BICC: IAM** to the MGCF. The MGCF responds with **2. H.248: ADD.req** [Context ID = ?, Termination ID=?], which includes the action: "Reserve IMS Connection Point, Change IMS Through-Connection = backward". The IM-MGW replies with **3. H.248: ADD.resp** [Context ID = C1, Termination ID = T1]. + +Next, the MGCF sends a **4. SIP: INVITE** to the user agent, receiving a **5. SIP: 100 Trying** response. The MGCF then sends a **6. SIP: 183 Session Progress**. The IM-MGW sends a **7. H.248: MOD.req** [Context ID = C1, Termination ID = T1] to the MGCF, with the annotation "Configure IMS Resources". The MGCF responds with **8. H.248: MOD.resp** [Context ID = C1, Termination ID = T1]. + +The MGCF then sends a **9. SIP: PRACK** (if SIP Preconditions and/or 100 rel are used) and a **10. SIP: 200 OK (PRACK)**. The IM-MGW sends a **11. H.248: ADD.req** [Context ID = C1, Termination ID = ?] to the MGCF, with the action: "Prepare Bearer, Change Through-Connection= both". The MGCF responds with **12. H.248: ADD.resp** [Context ID = C1, Termination ID = T2]. + +The IM-MGW then sends a **13. BICC: APM** to the MGCF. A dashed box labeled "Bearer Establishment" encompasses the next steps. The IM-MGW sends a **14. BICC: COT** to the MGCF, with the annotation "if continuity check is used". The MGCF responds with **15. SIP: UPDATE** (if SIP Preconditions and/or 100 rel are used) and **16. SIP: 200 OK (UPDATE)**. + +The MGCF then sends a **17. SIP: 180 Ringing** and an **18. SIP: PRACK** (Optional). The IM-MGW sends a **19. BICC: ACM** to the MGCF. The MGCF sends a **20. H.248: MOD.req** [Context ID = C1, Termination ID = T2] to the IM-MGW, with the annotation "Send Tone". The IM-MGW responds with **21. H.248: MOD.resp** [Context ID = C1, Termination ID = T2]. Finally, the MGCF sends a **22. SIP: 200 OK (PRACK)**. + +Sequence chart showing Basic CS Network Originating Session, Forward Bearer Establishment between IM-MGW and MGCF. The chart includes messages like BICC: IAM, H.248: ADD.req, SIP: INVITE, and H.248: MOD.req. Annotations include 'Configure IMS Resources', 'Bearer Establishment', and 'Send Tone'. + +Figure 37/1: Basic CS Network Originating Session, Forward Bearer Establishment (message sequence chart) + +![Sequence diagram showing the Basic CS Network Originating Session, Forward Bearer Establishment. The diagram involves two main entities: IM-MGW and MGCF. The sequence starts with signal 23. SIP: 200 OK (INVITE) from MGCF to IM-MGW. This is followed by a series of H.248 messages: 23a. MOD.req, 23b. MOD.resp, 24. MOD.req, 25. MOD.resp, 26. MOD.req, and 27. MOD.resp. These are accompanied by annotations: 'Configure IMS Resources' (if SIP Preconditions and 100 rel are not used), 'Stop Tone' (if tone was inserted), and 'Change IMS Through-Connection = both'. Signal 28. BICC: ANM is sent from IM-MGW to the left. Signal 29. SIP: ACK is sent from MGCF to the right. A bracket at the bottom indicates the 'CALL IN ACTIVE STATE'.](eb03559a4d92ea9ebd63ea9be663c50a_img.jpg) + +``` + +sequenceDiagram + participant IM-MGW + participant MGCF + Note right of MGCF: 23. SIP: 200 OK (INVITE) + MGCF->>IM-MGW: 23a. H.248: MOD.req [Context ID = C1, Termination ID = T1] + Note right of MGCF: Configure IMS Resources +if SIP Preconditions and 100 rel are not used + IM-MGW-->>MGCF: 23b. H.248: MOD.resp [Context ID = C1, Termination ID = T1] + MGCF->>IM-MGW: 24. H.248: MOD.req [Context ID=C1, Termination ID = T2] + IM-MGW-->>MGCF: 25. H.248: MOD.resp [Context ID = C1, Termination ID = T2] + Note right of MGCF: Stop Tone +if tone was inserted + MGCF->>IM-MGW: 26. H.248: MOD.req [Context ID=C1, Termination ID = T1] + IM-MGW-->>MGCF: 27. H.248: MOD.resp [Context ID = C1, Termination ID = T1] + Note right of MGCF: Change IMS Through-Connection = both + IM-MGW->>IM-MGW: 28. BICC: ANM + MGCF->>MGCF: 29. SIP: ACK + Note bottom: CALL IN ACTIVE STATE + +``` + +Sequence diagram showing the Basic CS Network Originating Session, Forward Bearer Establishment. The diagram involves two main entities: IM-MGW and MGCF. The sequence starts with signal 23. SIP: 200 OK (INVITE) from MGCF to IM-MGW. This is followed by a series of H.248 messages: 23a. MOD.req, 23b. MOD.resp, 24. MOD.req, 25. MOD.resp, 26. MOD.req, and 27. MOD.resp. These are accompanied by annotations: 'Configure IMS Resources' (if SIP Preconditions and 100 rel are not used), 'Stop Tone' (if tone was inserted), and 'Change IMS Through-Connection = both'. Signal 28. BICC: ANM is sent from IM-MGW to the left. Signal 29. SIP: ACK is sent from MGCF to the right. A bracket at the bottom indicates the 'CALL IN ACTIVE STATE'. + +**Figure 37/2: Basic CS Network Originating Session, Forward Bearer Establishment (message sequence chart continue)** + +#### 9.2.3.2 BICC Backward bearer establishment + +##### 9.2.3.2.1 IM-MGW selection + +The MGCF shall select an IM-MGW for the bearer connection before it performs the IM CN subsystem session establishment or the CS network side bearer establishment. + +##### 9.2.3.2.2 CS network side bearer establishment + +The MGCF shall request the IM-MGW to establish a bearer using the Establish Bearer procedure (signals 2 and 3 in figure 38). The MGCF provides the IM-MGW with the bearer address, the binding reference and the bearer characteristics that were received from the preceding node in the IAM (signal 1 in figure 38). + +##### 9.2.3.2.3 IM CN subsystem side termination reservation + +The MGCF shall derive from configuration data one or several appropriate local codec(s) the IM-MGW may use to receive user plane data from the IM CN subsystem. The MGCF shall use the Reserve IMS Connection Point procedure (signals 2 and 3 in figure 38). Within this procedure, the MGCF shall indicate the local codec(s) and request a local IP address and UDP port from the IM-MGW. The local IP address and UDP port are used by the IM-MGW to receive user plane data from the IM CN subsystem. If DTMF support together with speech support is required, or if the resources for multiple speech codecs shall be reserved at this stage, the reserve value indicator shall be set to "true". + +The MGCF may also indicate that the IP interface type is for MboIP. + +The IM-MGW shall reply to the MGCF with the selected local codec(s) and the selected local IP address and UDP port. + +The MGCF shall send this information in the INVITE (signal 6 in figure 38) to the IM CN subsystem. + +##### 9.2.3.2.4 IM CN subsystem side session establishment + +The MGCF shall use the Configure IMS Resources procedure (signals 9 and 10 or 22a and 22b in figure 38) to provide configuration data (derived from SDP received in signal 8 in figure 38 and local configuration data) to the IM-MGW as detailed below: + +- The MGCF shall indicate the remote IP address and UDP port, i.e. the destination IP address and UDP port for data sent in the user plane towards the IM CN subsystem +- The MGCF shall indicate the remote codec(s), i.e. the speech codec(s) for data sent in the user plane towards the IM CN subsystem. +- The MGCF may indicate the local codec(s) and the local IP address and UDP port. The MGCF shall indicate the local codec(s) if a change is required. +- If DTMF support together with speech support is required, the reserve value indicator shall be set to "true". +- The MGCF may indicate that IP interface type is for MboIP. + +The IM-MGW shall reply with the selected remote codec(s) and reserve resources for this codec. If local codec(s) were received, the IM-MGW shall also reply with the selected local codec(s) and reserve the corresponding resources. + +If the selected local codec(s) differ from the codec(s) received in the SDP of signal 8 in figure 38 (if any), the MGCF shall send the reserved speech codec(s), and the local IP address and UDP port in the PRACK (signal 11 in figure 38) to the IMS. + +If the selected local codec(s) differ from the codec(s) received in the SDP of signal 22 in figure 38 (if any), the MGCF shall send the local reserved codec(s), and the local IP address and UDP port in an re-INVITE or UPDATE (not depicted in figure 38) to the IMS. + +##### 9.2.3.2.5 Called party alerting + +The MGCF shall request the IM-MGW to provide an awaiting answer indication (ringing tone) to the calling party using the Send Tone procedure (signals 19 and 20 in figure 38) , when the following conditions is satisfied: + +- the MGCF receives the first 180 Ringing message, unless this message or some previous SIP provisional response contained a P-Early-Media header field that authorizes early media. + +##### 9.2.3.2.6 Called party answer + +When the MGCF receives a 200 OK message (signal 22 in figure 38), it shall request the IM-MGW to stop providing the ringing tone to the calling party using the Stop Tone procedure (signals 23 and 24 in figure 38). + +##### 9.2.3.2.7 Through-Connection + +During the Establish Bearer procedure, the MGCF shall either use the Change Through-Connection procedure to request the IM-MGW to backward through-connect the BICC termination, or the MGCF shall use this procedure to both-way through-connect the BICC termination already on this stage (signals 2 and 3 in figure 38). During the Reserve IMS Connection Point procedure, the MGCF shall use the Change IMS Through-Connection procedure to request the IM-MGW to backward through-connect the IMS termination (signals 4 and 5 in figure 38). + +When the MGCF receives the SIP 200 OK(INVITE) (signal 22 in figure 38), it shall request the IM-MGW to both-way through-connect the bearer using the Change IMS Through-Connection or Change Through-Connection procedure (signals 25 and 26 in figure 38), unless those terminations are already both-way through-connected. + +##### 9.2.3.2.8 Codec handling + +The IM-MGW may include a speech transcoder based upon the speech coding information provided to each termination. + +##### 9.2.3.2.9 Failure handling in MGCF + +If any procedure between the MGCF and the IM-MGW is not completed successfully, the default action by the MGCF is to release the session as described in clause 9.2.6. If the MGCF receives a Bearer Released procedure from the IM-MGW the default action by the MGCF is to release the session as described in clause 9.2.7. + +NOTE: As an implementation option the MGCF may also decide for example to only release the resources in the IM-MGW that caused the failure, possibly select a new IM-MGW for the connection and continue the call establishment using new resources in the selected IM-MGW but such handling is outside of the scope of the present document. + +##### 9.2.3.2.10 Message sequence chart + +Figure 38 shows the message sequence chart for the CS network originating session with BICC backward bearer establishment. In the chart the MGCF requests seizure of the IM CN subsystem side termination and CS network side bearer termination. When the MGCF receives an answer indication, it requests the IM-MGW to both-way through-connect the terminations. Dashed lines represent optional or conditional messages. + +![Sequence chart for Basic CS Network Originating Session, BICC Backward Bearer Establishment. Lifelines: IM-MGW and MGCF. The process involves BICC IAM, H.248 ADD.req/resp, SIP INVITE/100 Trying/183 Session Progress, H.248 MOD.req/resp, SIP PRACK/200 OK, BICC COT, SIP UPDATE/200 OK/180 Ringing, BICC ACM, and optional H.248 MOD.req/resp and SIP 200 OK.](90ddb84c323b956e2d50a54d3f870566_img.jpg) + +``` + +sequenceDiagram + participant IM-MGW + participant MGCF + + Note left of IM-MGW: Bearer Establishment + IM-MGW->>MGCF: 1. BICC: IAM + MGCF-->>IM-MGW: 2. H.248: ADD.req [Context ID = ?, Termination ID = ?] + IM-MGW-->>MGCF: 3. H.248: ADD.resp [Context ID = C1, Termination ID = T2] + Note right of MGCF: Establish Bearer, Change Through-Connection = both + Note left of IM-MGW: Configure IMS Resources + MGCF-->>IM-MGW: 4. H.248: ADD.req [Context ID = C1, Termination ID=?] + IM-MGW-->>MGCF: 5. H.248: ADD.resp [Context ID = C1, Termination ID = T1] + Note right of MGCF: Reserve IMS Connection Point, Change IMSThrough-Connection = backward + MGCF->>IM-MGW: 6. SIP: INVITE + IM-MGW-->>MGCF: 7. SIP: 100 Trying + MGCF-->>IM-MGW: 8. SIP: 183 Session Progress + IM-MGW-->>MGCF: 9. H.248: MOD.req [Context ID = C1, Termination ID = T1] + MGCF-->>IM-MGW: 10. H.248: MOD.resp [Context ID = C1, Termination ID = T1] + Note right of MGCF: if SIP Preconditions and/or 100 rel are used + MGCF->>IM-MGW: 11. SIP: PRACK + IM-MGW-->>MGCF: 12. SIP: 200 OK (PRACK) + Note left of IM-MGW: if continuity check is used + IM-MGW-->>MGCF: 13. BICC: COT + MGCF-->>IM-MGW: 14. SIP: UPDATE + Note right of MGCF: if SIP Preconditions and/or 100 rel are used + MGCF->>IM-MGW: 15. SIP: 200 OK (UPDATE) + IM-MGW-->>MGCF: 16. SIP: 180 Ringing + MGCF-->>IM-MGW: 17. SIP: PRACK + IM-MGW-->>MGCF: 18. BICC: ACM + Note right of MGCF: Optional + MGCF-->>IM-MGW: 19. H.248: MOD.req [Context ID = C1, Termination ID = T2] + IM-MGW-->>MGCF: 20. H.248: MOD.resp [Context ID = C1, Termination ID = T2] + Note right of MGCF: Send Tone + MGCF-->>IM-MGW: 21. SIP: 200 OK (PRACK) + +``` + +Sequence chart for Basic CS Network Originating Session, BICC Backward Bearer Establishment. Lifelines: IM-MGW and MGCF. The process involves BICC IAM, H.248 ADD.req/resp, SIP INVITE/100 Trying/183 Session Progress, H.248 MOD.req/resp, SIP PRACK/200 OK, BICC COT, SIP UPDATE/200 OK/180 Ringing, BICC ACM, and optional H.248 MOD.req/resp and SIP 200 OK. + +Figure 38/1: Basic CS Network Originating Session, BICC Backward Bearer Establishment (message sequence chart) + +![Sequence diagram for Basic CS Network Originating Session, BICC Backward Bearer Establishment. The diagram shows interactions between IM-MGW and MGCF. The MGCF sends a SIP:200 OK (INVITE) to an external entity. The MGCF then sends H.248 MOD.req (Context ID = C1, Termination ID = T1) to the IM-MGW. The IM-MGW responds with H.248 MOD.resp (Context ID = C1, Termination ID = T1). The MGCF then sends H.248 MOD.req (Context ID = C1, Termination ID = T2) to the IM-MGW. The IM-MGW responds with H.248 MOD.resp (Context ID = C1, Termination ID = T2). The MGCF then sends H.248 MOD.req (Context ID = C1, Termination ID = T1) to the IM-MGW. The IM-MGW responds with H.248 MOD.resp (Context ID = C1, Termination ID = T1). The MGCF then sends BICC: ANM to the IM-MGW. The MGCF then sends SIP: ACK to the external entity. A bracket at the bottom indicates the 'CALL IN ACTIVE STATE' between the MGCF and the external entity.](2ae3eae1bd80a90f192f568ae246a9a6_img.jpg) + +``` + +sequenceDiagram + participant External + participant MGCF + participant IM-MGW + + Note right of MGCF: if SIP Pre-conditions and 100 rel are not used + Note right of MGCF: Stop Tone If tone was inserted + Note right of MGCF: Change IMS Through-Connection = both + + External->>MGCF: 22. SIP:200 OK (INVITE) + MGCF->>IM-MGW: 22a. H.248: MOD.req [Context ID = C1, Termination ID = T1] + IM-MGW-->>MGCF: 22b. H.248: MOD.resp [Context ID = C1, Termination ID = T1] + MGCF->>IM-MGW: 23. H.248: MOD.req [Context ID = C1, Termination ID = T2] + IM-MGW-->>MGCF: 24. H.248: MOD.resp [Context ID = C1, Termination ID = T2] + MGCF->>IM-MGW: 25. H.248: MOD.req [Context ID = C1, Termination ID = T1] + IM-MGW-->>MGCF: 26. H.248: MOD.resp [Context ID = C1, Termination ID = T1] + MGCF->>IM-MGW: 27. BICC: ANM + MGCF->>External: 28. SIP: ACK + +``` + +Sequence diagram for Basic CS Network Originating Session, BICC Backward Bearer Establishment. The diagram shows interactions between IM-MGW and MGCF. The MGCF sends a SIP:200 OK (INVITE) to an external entity. The MGCF then sends H.248 MOD.req (Context ID = C1, Termination ID = T1) to the IM-MGW. The IM-MGW responds with H.248 MOD.resp (Context ID = C1, Termination ID = T1). The MGCF then sends H.248 MOD.req (Context ID = C1, Termination ID = T2) to the IM-MGW. The IM-MGW responds with H.248 MOD.resp (Context ID = C1, Termination ID = T2). The MGCF then sends H.248 MOD.req (Context ID = C1, Termination ID = T1) to the IM-MGW. The IM-MGW responds with H.248 MOD.resp (Context ID = C1, Termination ID = T1). The MGCF then sends BICC: ANM to the IM-MGW. The MGCF then sends SIP: ACK to the external entity. A bracket at the bottom indicates the 'CALL IN ACTIVE STATE' between the MGCF and the external entity. + +**Figure 38/2: Basic CS Network Originating Session, BICC Backward Bearer Establishment (message sequence chart continue)** + +#### 9.2.3.3 ISUP + +##### 9.2.3.3.1 IM-MGW selection + +The MGCF selects the IM-MGW based on the received circuit identity in the IAM. + +##### 9.2.3.3.2 CS network side circuit reservation + +The MGCF shall request the IM-MGW to reserve a circuit using the Reserve TDM Circuit procedure. + +##### 9.2.3.3.3 IM CN subsystem side termination reservation + +The MGCF shall derive from configuration data one or several appropriate local codec(s) the IM-MGW may use to receive user plane data from the IM CN subsystem. The MGCF shall use the Reserve IMS Connection Point procedure (signals 2 and 3 in figure 39). Within this procedure, the MGCF shall indicate the local codec(s) and request a local IP address and UDP port from the IM-MGW. The local IP address and UDP port are used by the IM-MGW to receive user plane data from the IM CN subsystem. If DTMF support together with speech support is required, or if the resources for multiple speech codecs shall be reserved at this stage, the reserve value indicator shall be set to "true". + +The MGCF may also indicate that the IP interface type is for MboIP. + +The IM-MGW shall reply to the MGCF with the selected local codec(s) and the selected local IP address and UDP port. + +The MGCF shall send this information in the INVITE (signal 6 in figure 39) to the IM CN subsystem. + +##### 9.2.3.3.4 IM CN subsystem side session establishment + +The MGCF shall use the Configure IMS Resources procedure (signals 9 and 10 or 22a and 22b in figure 39) to provide configuration data (derived from SDP received in signal 8 in figure 39 and local configuration data) as detailed below: + +- The MGCF shall indicate the remote IP address and UDP port, i.e. the destination IP address and UDP port for data sent in the user plane towards the IM CN subsystem. + +- The MGCF shall indicate the remote codec(s), i.e. the speech codec(s) for data sent in the user plane towards the IM CN subsystem. +- The MGCF may indicate the local codec(s) and the local IP address and UDP port. The MGCF shall indicate the local codec(s) if a change is required. +- If DTMF support together with speech support is required, the reserve value indicator shall be set to "true". +- The MGCF may indicate that IP interface type is for MboIP. + +The IM-MGW shall reply with the selected remote codec(s) and reserve resources for these codec(s). If local codec(s) were received, the IM-MGW shall also reply with the selected local codec(s) and reserve the corresponding resources. + +If the selected local codec(s) differ from the codec(s) received in the SDP of signal 8 in figure 39 (if any), the MGCF shall send the reserved speech codec(s), and the local IP address and UDP port in the PRACK (signal 11 in figure 39) to the IMS. + +If the selected local codec(s) differ from the codec(s) received in the SDP of signal 22 in figure 39 (if any), the MGCF shall send the local reserved codec(s), and the local IP address and UDP port in an re-INVITE or UPDATE (not depicted in figure 39) to the IMS. + +##### 9.2.3.3.5 Called party alerting + +The MGCF shall request the IM-MGW to provide an awaiting answer indication (ringing tone) to the calling party using the Send TDM Tone procedure (signals 19 and 20 in figure 39), when the following condition is satisfied: + +- the MGCF receives the first 180 Ringing message, unless this message or some previous SIP provisional response contained a P-Early-Media header field that authorizes early media. + +##### 9.2.3.3.6 Called party answer + +When the MGCF receives a 200 OK message (signal 22 in figure 39), it shall request the IM-MGW to stop providing the ringing tone to the calling party using the Stop TDM Tone procedure (signals 23 and 24 in figure 39). + +##### 9.2.3.3.7 Through-Connection + +Within the Reserve TDM Circuit procedure, the MGCF shall either use the Change TDM Through-Connection procedure to request the IM-MGW to backward through-connect the TDM termination, or the MGCF shall use this procedure to both-way through-connect the TDM termination already on this stage (signals 2 and 3 in figure 39). During the Reserve IMS Connection Point procedure, the MGCF shall use the Change IMS Through-Connection procedure to request the IM-MGW to backward through-connect the IMS termination (signals 4 and 5 in figure 39). + +When the MGCF receives the SIP 200 OK(INVITE) message, it shall request the IM-MGW to both-way through-connect the terminations using the Change IMS Through-Connection or Change TDM Through-Connection procedure (signals 25 and 26 in figure 39), unless those terminations are already both-way through-connected. + +##### 9.2.3.3.8 Continuity Check + +If a continuity check on the connection towards the CS network is requested in the IAM message, the MGCF shall use the Continuity Check Response procedure towards the IM-MGW to request loop-back of a received continuity check tone on the TDM circuit. Upon reception of the COT message, the MGCF shall use the Continuity Check Response procedure towards the IM-MGW to request the removal of the loop-back. (Not depicted in figure 39) + +##### 9.2.3.3.9 Codec handling + +The IM-MGW may include a speech transcoder based upon the speech coding information provided to each termination. + +##### 9.2.3.3.10 Voice Processing function + +A voice processing function located on the IM-MGW may be used to achieve desired acoustic quality on the terminations. If the voice processing function is used, the MGCF shall request the activation of it in the termination towards the CS network using the Activate TDM Voice Processing Function procedure (signal 23 in figure 39). + +##### 9.2.3.3.11 Failure handling in MGCF + +If any procedure between the MGCF and the IM-MGW is not completed successfully, the session shall be released as described in clause 9.2.6. If the MGCF receives a Bearer Released procedure from the IM-MGW the default action by the MGCF is to release the session as described in clause 9.2.7. + +##### 9.2.3.3.12 Message sequence chart + +Figure 39 shows the message sequence chart for the CS network originating Session with ISUP. In the chart the MGCF requests seizure of the IM CN subsystem side termination and CS network side bearer termination. When the MGCF receives an answer indication, it requests the IM-MGW to both-way through-connect the terminations. The MGCF may request the possible activation of the voice processing functions for the terminations. Dashed lines represent optional or conditional messages. + +![Sequence diagram for Basic CS Network Originating Session, ISUP. Lifelines: IM-MGW and MGCF. The diagram shows the interaction between the IM-MGW and MGCF for session setup, including ISUP IAM, H.248 ADD/MOD messages, and SIP INVITE/UPDATE/ACK messages. Annotations include 'Configure IMS Resources', 'if continuity check is used', and 'Send TDM Tone Optional'.](dd5771673aececa53d42ece89218299d_img.jpg) + +``` + +sequenceDiagram + participant IM-MGW + participant MGCF + + Note left of IM-MGW: Configure IMS Resources + IM-MGW->>MGCF: 1. ISUP: IAM + MGCF-->>IM-MGW: 2. H.248: ADD.req [Context ID = ?, Termination ID = ?] + Note right of MGCF: Reserve TDM Circuit, Change Through-Connection = both + MGCF->>IM-MGW: 3. H.248: ADD.resp [Context ID = C1, Termination ID = T2] + MGCF-->>IM-MGW: 4. H.248: ADD.req [Context ID = C1, Termination ID=?] + Note right of MGCF: Reserve IMS Connection Point, Change IMS Through-Connection = backward + MGCF->>IM-MGW: 5. H.248: ADD.resp [Context ID = C1, Termination ID = T1] + MGCF->>IM-MGW: 6. SIP: INVITE + MGCF-->>IM-MGW: 7. SIP: 100 Trying + MGCF-->>IM-MGW: 8. SIP: 183 Session Progress + Note right of MGCF: if SIP Preconditions and/or 100 rel are used + MGCF-->>IM-MGW: 9. H.248: MOD.req [Context ID = C1, Termination ID = T1] + MGCF-->>IM-MGW: 10. H.248: MOD.resp [Context ID = C1, Termination ID = T1] + MGCF->>IM-MGW: 11. SIP: PRACK + MGCF-->>IM-MGW: 12. SIP: 200 OK (PRACK) + Note left of IM-MGW: if continuity check is used + IM-MGW-->>MGCF: 13. ISUP: COT + MGCF->>IM-MGW: 14. SIP: UPDATE + Note right of MGCF: if SIP Preconditions and/or 100 rel are used + MGCF-->>IM-MGW: 15. SIP: 200 OK (UPDATE) + MGCF-->>IM-MGW: 16. SIP: 180 Ringing + MGCF->>IM-MGW: 17. SIP: PRACK + IM-MGW-->>IM-MGW: 18. ISUP: ACM + MGCF-->>IM-MGW: 19. H.248: MOD.req [Context ID = C1, Termination ID = T2] + MGCF->>IM-MGW: 20. H.248: MOD.resp [Context ID = C1, Termination ID = T2] + Note right of MGCF: Send TDM Tone Optional + MGCF-->>IM-MGW: 21. SIP: 200 OK (PRACK) + +``` + +Sequence diagram for Basic CS Network Originating Session, ISUP. Lifelines: IM-MGW and MGCF. The diagram shows the interaction between the IM-MGW and MGCF for session setup, including ISUP IAM, H.248 ADD/MOD messages, and SIP INVITE/UPDATE/ACK messages. Annotations include 'Configure IMS Resources', 'if continuity check is used', and 'Send TDM Tone Optional'. + +Figure 39/1: Basic CS Network Originating Session, ISUP (message sequence chart) + +![Sequence diagram for Basic CS Network Originating Session, ISUP (message sequence chart continue). The diagram shows interactions between IM-MGW and MGCF. The sequence starts with MGCF sending a 22. SIP :200 OK (INVITE) to IM-MGW. IM-MGW responds with 22a. H.248: MOD.req [Context ID = C1, Termination ID = T1]. MGCF replies with 22b. H.248: MOD.resp [Context ID = C1, Termination ID = T1]. IM-MGW then sends 23. H.248: MOD.req [Context ID=C1, Termination ID = T2]. MGCF replies with 24. H.248: MOD.resp [Context ID = C1, Termination ID = T2]. IM-MGW sends 25. H.248: MOD.req [Context ID=C1, Termination ID = T1]. MGCF replies with 26. H.248: MOD.resp [Context ID = C1, Termination ID = T1]. IM-MGW sends 27. ISUP: ANN. MGCF replies with 28. SIP: ACK. A bracket at the bottom indicates the 'CALL IN ACTIVE STATE' from signal 27 onwards. Annotations on the right side of the MGCF lifeline describe the actions taken: 'Configure IMS Resources' (if SIP Preconditions and 100 rel are not used), 'Stop TDM Tone, Activate TDM Voice Processing Function' (if tone was inserted or for voice processing), and 'Change IMS Through-Connection = both'.](00504fc688ebcf131ccbeff94dfc9939_img.jpg) + +Sequence diagram for Basic CS Network Originating Session, ISUP (message sequence chart continue). The diagram shows interactions between IM-MGW and MGCF. The sequence starts with MGCF sending a 22. SIP :200 OK (INVITE) to IM-MGW. IM-MGW responds with 22a. H.248: MOD.req [Context ID = C1, Termination ID = T1]. MGCF replies with 22b. H.248: MOD.resp [Context ID = C1, Termination ID = T1]. IM-MGW then sends 23. H.248: MOD.req [Context ID=C1, Termination ID = T2]. MGCF replies with 24. H.248: MOD.resp [Context ID = C1, Termination ID = T2]. IM-MGW sends 25. H.248: MOD.req [Context ID=C1, Termination ID = T1]. MGCF replies with 26. H.248: MOD.resp [Context ID = C1, Termination ID = T1]. IM-MGW sends 27. ISUP: ANN. MGCF replies with 28. SIP: ACK. A bracket at the bottom indicates the 'CALL IN ACTIVE STATE' from signal 27 onwards. Annotations on the right side of the MGCF lifeline describe the actions taken: 'Configure IMS Resources' (if SIP Preconditions and 100 rel are not used), 'Stop TDM Tone, Activate TDM Voice Processing Function' (if tone was inserted or for voice processing), and 'Change IMS Through-Connection = both'. + +**Figure 39/2: Basic CS Network Originating Session, ISUP (message sequence chart continue)** + +#### 9.2.3.4 Handling of Forking + +The procedures described in clauses 9.2.3.1 to 9.2.3.3 shall be applied with the following additions. + +##### 9.2.3.4.1 Detection of Forking + +According to SIP procedures, the O-MGCF inspects the tags in the "to" SIP header fields of provisional and final responses to identify the SIP dialogue the response belongs to. If responses belonging to different dialogues are received (signals 8 and 13 in figure 39a), the INVITE request (signal 6 in figure 39a) has been forked. + +##### 9.2.3.4.2 IM CN subsystem side session establishment + +If one or more SIP early dialog exists and: + +- a) if the O-MGCF has not already received a P-Early-Media header field that authorizes backward early media (the received em-param(s) in the P-Early-Media header field includes "sendrecv" or "sendonly") on any of existing SIP early dialog, then upon reception of a provisional 18x response with an SDP answer creating a new early dialog (signal 13 in figure 39a/1) and: + - 1) with the P-Early-Media header field that authorizes backward early media (the received em-param(s) in the P-Early-Media header field includes "sendrecv" or "sendonly"), the O-MGCF shall use the Configure IMS Resources procedure (signals 14 and 15 in figure 39a/1) and shall provide to the IM-MGW: + - the remote IP address and UDP port, and the remote codec selected from the received SDP answer. + +The IM-MGW may be configured to use the remote IP address and port information as source filter for incoming packets to prevent that backward early media from other early SIP dialogs interfere. The O-MGCF may also provide an IP address and port source filter that disallows backward early media from other early dialogs without an early media authorization in order to prevent that such unauthorized backward early media interfere with the authorized backward early media. (NOTE 1); and + - local configuration data, corresponding to the SIP early dialog of the SIP provisional response containing a P-Early-Media header field that authorizes backward early media; or +- 2) without the P-Early-Media header field or with the P-Early-Media header field that does not authorize backward early media (the received em-param(s) in the P-Early-Media header field includes "inactive" or "recvonly"), the O-MGCF may either: + - refrain from reconfiguring the IM-MGW; or + +- use the Configure IMS Resources procedure (signals 14 and 15 in figure 39a/1) as detailed below: + - i) the O-MGCF may compare the selected local codecs of the different dialogs (which the O-MGCF selects due to the received SDP answer and local configuration data). If different local codecs are selected for the different dialogs, the O-MGCF may include all these codecs in the "local IMS resources", and set the "reserve value" to indicate that resources for all these codecs shall be reserved. Alternatively, the O-MGCF may only include the codecs received in the last received SDP in the "local IMS resources"; and + - ii) the O-MGCF may update the "remote IMS resources" with the information received in the latest SDP answer. The MGCF should provide the remote IP address and UDP port, and the remote codec selected from the received SDP answer and local configuration data. (NOTE 2); or +- b) if the O-MGCF has already received a P-Early-Media header field that authorizes backward early media (the received em-param(s) in the P-Early-Media header field includes "sendrecv" or "sendonly") on any of existing early dialog, then upon reception of a provisional 18x response with an SDP answer creating a new early dialog (signal 13 in figure 39a/1) and: + - 1) with the P-Early-Media header field that authorizes backward early media (the received em-param(s) in the P-Early-Media header field includes "sendrecv" or "sendonly"), the O-MGCF may either: + - refrain from reconfiguring the IM-MGW; or + - use the Configure IMS Resources procedure (signals 14 and 15 in figure 39a/1) to provide to the IM-MGW the remote IP address and UDP port, and the remote codec selected from the received SDP answer and local configuration data, corresponding to the SIP early dialog of the SIP provisional response containing the P-Early-Media header field that authorizes backward early media. The IM-MGW may be configured to use the remote IP address and port information as source filter for incoming packets to prevent that backward early media from another early SIP dialog interfere. The O-MGCF may also provide an IP address and port source filter that disallows backward early media from other early dialogs without an early media authorization in order to prevent that such unauthorized backward early media interfere with the authorized backward early media. (NOTE 1, NOTE 2); or + - 2) without the P-Early-Media header field or with the P-Early-Media header field that does not authorize backward early media (the received em-param(s) in the P-Early-Media header field includes "inactive" or "recvonly"), the O-MGCF shall store the received SDP answer and shall refrain from reconfiguring the IM-MGW. + +NOTE 1: The O-MGCF can use the P-Early-Media header field (IETF RFC 5009 [89]) to determine whether the media associated with a forked dialog is authorized and thus eligible for a through connection. In the presence of backward early media for multiple dialogs due to forking, if the IM-MGW is able to identify the media associated with a dialog (i.e., if symmetric RTP is used by the peer and the IM-MGW can use the remote SDP information to determine the source of the media), then the O-MGCF/IM-MGW can selectively establish a through-connection for an authorized backward early media flow. + +NOTE 2: This behaviour is beneficial if forking is applied in a sequential manner. + +If the O-MGCF has not already received a P-Early-Media header field that authorizes backward early media (the received em-param(s) in the P-Early-Media header field includes "sendrecv" or "sendonly") on any of existing SIP early dialog, then: + +- a) upon reception of a SIP message with the P-Early-Media header field that authorizes backward early media (the received em-param(s) in the P-Early-Media header field includes "sendrecv" or "sendonly") on existing early dialog; and + +NOTE 3: For the existing early dialog the P-Early-Media header field can be received within the UPDATE requests, 2xx responses to the PRACK and the UPDATE requests, and in the subsequent 18x provisional responses (as specified in IETF RFC 5009 [89]). Subsequent 18x provisional response is every 18x provisional response except the first 18x provisional response, received within the one early dialog. Reception of the first 18x provisional response which creates a new early dialog is described in at the beginning of this subclause). + +- b) if the O-MGCF has received an SDP body on the early dialog on which the SIP message with the P-Early-Media header field that authorizes backward early media was received, + +the O-MGCF shall provide to the IM-MGW the remote IP address and UDP port, and the remote codec selected from the latest received SDP body corresponding to the early dialog on which the SIP message with the P-Early-Media header field that authorizes backward early media was received. + +Upon reception of: + +- a) a SIP message with the P-Early-Media header field that removes authorization of backward early media (the received em-param(s) in the P-Early-Media header field includes "inactive" or "recvonly") on the early dialog for which: + - 1) the P-Early-Media header field authorizing backward early media was previously received (the received em-param(s) in the P-Early-Media header field includes "sendrecv" or "sendonly"); and + - 2) the O-MGCF provided to the IM-MGW the remote IP address and UDP port, and the remote codec selected from the latest received SDP body corresponding to this early dialog and this remote IP address and UDP port, are the most recently sent the remote IP address and UDP port to the IM-MGW; or +- b) a 199 Early Dialog Terminated provisional response corresponding to the SIP early dialog for which: + - 1) the P-Early-Media header field authorizing backward early media was previously received (the received em-param(s) in the P-Early-Media header field includes "sendrecv" or "sendonly"); and + - 2) the O-MGCF provided to the IM-MGW the remote IP address and UDP port, and the remote codec selected from the latest received SDP body corresponding to this early dialog and this remote IP address and UDP port, are the most recently sent the remote IP address and UDP port to the IM-MGW, + +the O-MGCF shall check if the P-Early-Media header field that authorizes backward early media (the received em-param(s) in the P-Early-Media header field includes "sendrecv" or "sendonly") was received on any other early dialog and that the authorization of backward early media on that early dialog has not changed. If such early dialog: + +- a) exists the O-MGCF shall provide to the IM-MGW using the Configure IMS Resources procedure, the remote IP address and UDP port, and the remote codec selected from the latest received SDP body on that early dialog. If there is more than one such early dialog, the O-MGCF shall select the early dialog where the P-Early-Media header field was most recently received; or +- b) does not exist and if: + - 1) the O-MGCF has already received the 180 Ringing provisional response on any of existing SIP early dialog; or + - 2) the received SIP message is the 180 Ringing provisional response, + +the O-MGCF shall request the IM-MGW to provide an awaiting answer indication (ringing tone) to the calling party using the Send Tone procedure (signals 27 and 28 in figure 39a/2). + +##### 9.2.3.4.3 IM CN subsystem side session establishment completion + +Upon reception of the first final 2xx response (signal 32 in figure 39a), the MGCF shall use the Configure IMS Resources procedure (signals 35 and 36 in figure 39a) as detailed below unless the IM-MGW is already configured accordingly: + +- If the remote IMS resources configured at the IM-MGW do not match the remote resources selected for the established dialogue of the final response, the MGCF shall provide the remote IP address and UDP port from the latest received SDP of this established dialogue, and the remote codec selected from the latest received SDP of this established dialogue and local configuration data within the "remote IMS resources". +- If the local IMS resources configured at the IM-MGW contain more codecs than selected for the established dialogue of the final response, the MGCF should update the "local IMS resources" with the selected local codec derived from the latest SDP of this established dialogue and local configuration data. The "reserve value" may be cleared unless it is required for DTMF. + +- The IM-MGW may be configured to use the remote IP address and port information as source filter for incoming packages to prevent that early media from other early SIP dialogues interfere with the media of the established dialogue. The MGCF may also provide an IP address and port source filter that disallows early media from other early dialogues in order to prevent that such early media interfere with the media of the established dialogue. If the MGCF has provided a source filter selecting media of another SIP early dialogue, it shall remove or update this source filter. + +##### 9.2.3.4.4 Message sequence chart + +Figure 39a shows an example message sequence chart for a CS network originating Session Setup with ISUP, where forking occurs. + +![Sequence diagram for CS Network Originating Session with forking, ISUP. Lifelines: IM-MGW and MGCF. The diagram shows a series of messages between the two entities, with annotations for actions like 'Reserve TDM Circuit', 'Configure IMS Resources', and 'Reserve IMS Connection Point'.](6e15fc9ea763541c5913d26f85072ae1_img.jpg) + +``` + +sequenceDiagram + participant IM-MGW + participant MGCF + + Note left of IM-MGW: Reserve TDM Circuit, +Change Through- +Connection = both + IM-MGW->>MGCF: 1. ISUP: IAM + MGCF-->>IM-MGW: 2. H.248: ADD.req [Context ID = ?, Termination ID = ?] + IM-MGW-->>MGCF: 3. H.248: ADD.resp [Context ID = C1, Termination ID = T2] + Note left of IM-MGW: Reserve IMS Connection Point, +Change IMS Through- +Connection = backward + IM-MGW->>MGCF: 4. H.248: ADD.req [Context ID = C1, Termination ID=?] + MGCF-->>IM-MGW: 5. H.248: ADD.resp [Context ID = C1, Termination ID = T1] + MGCF->>X: 6. SIP: INVITE + X-->>MGCF: 7. SIP: 100 Trying + X-->>MGCF: 8. SIP: 183 Session Progress (to:xxx, tagA) + Note left of IM-MGW: Configure IMS Resources + IM-MGW->>MGCF: 9. H.248: MOD.req [Context ID = C1, Termination ID = T1] + MGCF-->>IM-MGW: 10. H.248: MOD.resp [Context ID = C1, Termination ID = T1] + MGCF->>X: 11. SIP: PRACK (to:xxx, tagA) + X-->>MGCF: 12. SIP: 200 OK (PRACK) (to:xxx, tagA) + X-->>MGCF: 13. SIP: 183 Session Progress (to:xxx, tagB) + Note left of IM-MGW: Configure IMS Resources + IM-MGW->>MGCF: 14. H.248: MOD.req [Context ID = C1, Termination ID = T1] + MGCF-->>IM-MGW: 15. H.248: MOD.resp [Context ID = C1, Termination ID = T1] + MGCF->>X: 16. SIP: PRACK (to:xxx, tagB) + X-->>MGCF: 17. SIP: 200 OK (PRACK) (to:xxx, tagB) + IM-MGW->>MGCF: 18. ISUP: COT + MGCF->>X: 19. SIP: UPDATE (to:xxx, tagA) + X-->>MGCF: 20. SIP: UPDATE (to:xxx, tagB) + X-->>MGCF: 21. SIP: 200 OK (UPDATE) (to: xxx, tagA) + X-->>MGCF: 22. SIP: 200 OK (UPDATE) (to: xxx, tagB) + +``` + +Sequence diagram for CS Network Originating Session with forking, ISUP. Lifelines: IM-MGW and MGCF. The diagram shows a series of messages between the two entities, with annotations for actions like 'Reserve TDM Circuit', 'Configure IMS Resources', and 'Reserve IMS Connection Point'. + +Figure 39a/1: CS Network Originating Session with forking, ISUP (message sequence chart) + +![Sequence diagram for CS Network Originating Session with forking. Lifelines: IM-MGW and MGCF. The diagram shows a series of messages between the MGCF and external entities, and between the MGCF and IM-MGW. The MGCF receives SIP 180 Ringing, PRACK, and 200 OK (PRACK) from an external source. The MGCF then sends ISUP ACM to the IM-MGW. The MGCF sends H.248 MOD.req to the IM-MGW, which responds with H.248 MOD.resp. The MGCF then sends another SIP 180 Ringing, PRACK, and 200 OK (PRACK) to another external source. The MGCF sends H.248 MOD.req to the IM-MGW, which responds with H.248 MOD.resp. The MGCF then sends H.248 MOD.req to the IM-MGW, which responds with H.248 MOD.resp. The MGCF sends ISUP ANM to the IM-MGW. Finally, the MGCF sends SIP ACK to the external source. A bracket at the bottom indicates the 'CALL IN ACTIVE STATE' from the first H.248 MOD.req to the ISUP ANM.](2837ffdadcdb1e5bababa56b564e56ed_img.jpg) + +Sequence diagram illustrating the CS Network Originating Session with forking, ISUP (message sequence chart continue). + +The diagram shows interactions between the IM-MGW and the MGCF. + +External SIP messages received by the MGCF: + +- 23. **SIP** :180 Ringing (to:xxx, tagB) +- 24. **SIP** : PRACK (to:xxx, tagB) +- 25. **SIP** :200 OK (PRACK) (to:xxx, tagB) + +ISUP message sent from the MGCF to the IM-MGW: + +- 26. **ISUP** : ACM + +H.248 messages exchanged between the MGCF and the IM-MGW: + +- 27. **H.248** : MOD.req [Context ID = C1, Termination ID = T2] (MGCF to IM-MGW) +- 28. **H.248** : MOD.resp [Context ID = C1, Termination ID = T2] (IM-MGW to MGCF) +- 33. **H.248** : MOD.req [Context ID=C1, Termination ID = T2] (MGCF to IM-MGW) +- 34. **H.248** : MOD.resp [Context ID = C1, Termination ID = T2] (IM-MGW to MGCF) +- 35. **H.248** : MOD.req [Context ID=C1, Termination ID = T1] (MGCF to IM-MGW) +- 36. **H.248** : MOD.resp [Context ID = C1, Termination ID = T1] (IM-MGW to MGCF) + +Additional SIP messages received by the MGCF: + +- 29. **SIP** :180 Ringing (to:xxx, tagA) +- 30. **SIP** : PRACK (to:xxx, tagA) +- 31. **SIP** :200 OK (PRACK) (to:xxx, tagA) +- 32. **SIP** :200 OK (INVITE) (to:xxx, tagA) + +IM-MGW actions: + +- Send TDM Tone (triggered by message 27) +- Stop TDM Tone , Activate TDM Voice Processing Function (triggered by message 33) +- Configure IMS Resources, Change IMS Through-Connection = both (triggered by message 35) + +ISUP message sent from the MGCF to the IM-MGW: + +- 37. **ISUP** : ANM + +External SIP message sent from the MGCF: + +- 38. **SIP** : ACK + +The period from message 27 to message 37 is labeled as **CALL IN ACTIVE STATE**. + +Sequence diagram for CS Network Originating Session with forking. Lifelines: IM-MGW and MGCF. The diagram shows a series of messages between the MGCF and external entities, and between the MGCF and IM-MGW. The MGCF receives SIP 180 Ringing, PRACK, and 200 OK (PRACK) from an external source. The MGCF then sends ISUP ACM to the IM-MGW. The MGCF sends H.248 MOD.req to the IM-MGW, which responds with H.248 MOD.resp. The MGCF then sends another SIP 180 Ringing, PRACK, and 200 OK (PRACK) to another external source. The MGCF sends H.248 MOD.req to the IM-MGW, which responds with H.248 MOD.resp. The MGCF then sends H.248 MOD.req to the IM-MGW, which responds with H.248 MOD.resp. The MGCF sends ISUP ANM to the IM-MGW. Finally, the MGCF sends SIP ACK to the external source. A bracket at the bottom indicates the 'CALL IN ACTIVE STATE' from the first H.248 MOD.req to the ISUP ANM. + +Figure 39a/2: CS Network Originating Session with forking, ISUP (message sequence chart continue) + +### 9.2.4 Session release initiated from IM CN subsystem side + +#### 9.2.4.1 BICC + +##### 9.2.4.1.1 Session release in the IM CN subsystem side + +When the MGCF has received a BYE message from the IM CN subsystem side, the MGCF shall release resources in the IM-MGW serving the relevant Mb interface connection by using the "Release IMS Termination" procedure (signals 5 and 6 in figure 40). After receiving the BYE message, the MGCF shall also send a 200 OK [BYE] message towards the IM CN subsystem (signal 2 in figure 40). + +##### 9.2.4.1.2 Session release in the CS network side + +When the MGCF has received a BYE message from the IM CN subsystem side, the MGCF shall send a REL message to the succeeding node (signal 3 in figure 40). Once the succeeding node has responded with the RLC message (signal 6 in figure 40), the MGCF shall release the resources for the CS network side in the IM-MGW. If any resources were seized in the IM-MGW, the MGCF shall use the "Release Bearer", "Change Through-Connection" and "Release Termination" procedures (signals 7 to 10 in figure 40) to indicate to the IM-MGW that the CS network side bearer termination shall be removed and the bearer shall be released towards the succeeding MGW. + +##### 9.2.4.1.3 Message sequence chart + +Figure 40 shows the message sequence chart for the session release initiated from the IM CN subsystem side. + +![Figure 40: Session release from IM CN subsystem side for BICC (message sequence chart). The diagram shows a sequence of messages between the MGCF and the IM-MGW. The sequence starts with a SIP: BYE from the IM CN subsystem to the MGCF, followed by a SIP: 200 OK [BYE] from the MGCF back to the IM CN subsystem. Then, the MGCF sends a BICC: REL to the succeeding node, which responds with a BICC: RLC. The MGCF then initiates the 'Release IMS Termination' procedure with H.248: SUB.req and H.248: SUB.resp messages. Next, the 'Release Bearer, Change Through-Connection = backward' procedure is initiated with H.248: MOD.req and H.248: MOD.resp messages. Finally, the 'Release Termination' procedure is initiated with H.248: SUB.req and H.248: SUB.resp messages.](e38206fcefa2045af01d494b2956775a_img.jpg) + +``` + +sequenceDiagram + participant IM_CN as IM CN subsystem + participant MGCF + participant IM_MGW as IM-MGW + Note right of MGCF: Release IMS Termination + Note right of MGCF: Release Bearer, Change Through-Connection = backward + Note right of MGCF: Release Termination + + IM_CN->>MGCF: 1. SIP: BYE + MGCF-->>IM_CN: 2. SIP: 200 OK [BYE] + MGCF->>IM_MGW: 3. BICC: REL + IM_MGW-->>MGCF: 4. BICC: RLC + MGCF->>IM_MGW: 5. H.248: SUB.req [Context ID = C1, Termination ID = T1] + IM_MGW-->>MGCF: 6. H.248: SUB.resp [Context ID = C1, Termination ID = T1] + MGCF->>IM_MGW: 7. H.248: MOD.req [Context ID = C1, Termination ID = T2] + IM_MGW-->>MGCF: 8. H.248: MOD.resp [Context ID = C1, Termination ID = T2] + MGCF->>IM_MGW: 9. H.248: SUB.req [Context ID = C1, Termination ID = T2] + IM_MGW-->>MGCF: 10. H.248: SUB.resp [Context ID = C1, Termination ID = T2] + +``` + +Figure 40: Session release from IM CN subsystem side for BICC (message sequence chart). The diagram shows a sequence of messages between the MGCF and the IM-MGW. The sequence starts with a SIP: BYE from the IM CN subsystem to the MGCF, followed by a SIP: 200 OK [BYE] from the MGCF back to the IM CN subsystem. Then, the MGCF sends a BICC: REL to the succeeding node, which responds with a BICC: RLC. The MGCF then initiates the 'Release IMS Termination' procedure with H.248: SUB.req and H.248: SUB.resp messages. Next, the 'Release Bearer, Change Through-Connection = backward' procedure is initiated with H.248: MOD.req and H.248: MOD.resp messages. Finally, the 'Release Termination' procedure is initiated with H.248: SUB.req and H.248: SUB.resp messages. + +Figure 40: Session release from IM CN subsystem side for BICC (message sequence chart) + +#### 9.2.4.2 ISUP + +##### 9.2.4.2.1 Session release in the IM CN subsystem side + +When the MGCF has received a BYE message from the IM CN subsystem side, the MGCF shall release resources in the IM-MGW serving the relevant Mb interface connection by using the "Release IMS Termination" procedure (signals 4 and 5 in figure 41). After receiving the BYE message, the MGCF shall also send a 200 OK [BYE] message towards the IM CN subsystem (signal 2 in figure 41). + +##### 9.2.4.2.2 Session release in the CS network side + +When the MGCF has received a BYE message from the IM CN subsystem side, the MGCF shall send a REL message to the succeeding node (signal 3 in figure 41). After sending the REL message, the MGCF shall expect a RLC message (signal 8 in figure 41) from the succeeding node. The MGCF shall also release the resources for the CS network side in the IM-MGW. If any resources were seized in the IM-MGW, the MGCF shall use the "Release TDM Termination" procedure (signals 6 to 7 in figure 41) to indicate to the IM-MGW that the CS network side bearer termination can be released. + +##### 9.2.4.2.3 Message sequence chart + +Figure 41 shows the message sequence chart for the session release initiated from the IM CN subsystem side. + +![Figure 41: Session release from IM CN subsystem side for ISUP (message sequence chart). The diagram shows a sequence of messages between the MGCF and the IM-MGW. The sequence starts with a SIP: BYE from the IM CN subsystem to the MGCF. The MGCF responds with a SIP: 200 OK [BYE] to the IM CN subsystem. The MGCF then sends an ISUP: REL message to the IM-MGW. The MGCF then initiates the 'Release IMS Termination' procedure with the IM-MGW via H.248 SUB.req and SUB.resp messages. The MGCF then initiates the 'Release TDM Termination' procedure with the IM-MGW via H.248 SUB.req and SUB.resp messages. Finally, the MGCF receives an ISUP: RLC message from the IM-MGW.](257c8341b41f1f4a287f27d33227974c_img.jpg) + +``` +sequenceDiagram + participant IM_CN as IM CN subsystem + participant MGCF + participant IM-MGW + Note left of MGCF: Release IMS Termination + Note left of MGCF: Release TDM Termination + IM_CN->>MGCF: 1. SIP: BYE + MGCF-->>IM_CN: 2. SIP: 200 OK [BYE] + MGCF->>IM-MGW: 3. ISUP: REL + MGCF->>IM-MGW: 4. H.248: SUB.req [Context ID = C1, Termination ID = T1] + IM-MGW-->>MGCF: 5. H.248: SUB.resp [Context ID = C1, Termination ID = T1] + MGCF->>IM-MGW: 6. H.248: SUB.req [Context ID = C1, Termination ID = T2] + IM-MGW-->>MGCF: 7. H.248: SUB.resp [Context ID = C1, Termination ID = T2] + IM-MGW->>MGCF: 8. ISUP: RLC +``` + +Figure 41: Session release from IM CN subsystem side for ISUP (message sequence chart). The diagram shows a sequence of messages between the MGCF and the IM-MGW. The sequence starts with a SIP: BYE from the IM CN subsystem to the MGCF. The MGCF responds with a SIP: 200 OK [BYE] to the IM CN subsystem. The MGCF then sends an ISUP: REL message to the IM-MGW. The MGCF then initiates the 'Release IMS Termination' procedure with the IM-MGW via H.248 SUB.req and SUB.resp messages. The MGCF then initiates the 'Release TDM Termination' procedure with the IM-MGW via H.248 SUB.req and SUB.resp messages. Finally, the MGCF receives an ISUP: RLC message from the IM-MGW. + +Figure 41: Session release from IM CN subsystem side for ISUP (message sequence chart) + +### 9.2.5 Session release initiated from CS network side + +#### 9.2.5.1 BICC + +##### 9.2.5.1.1 Session release in the CS network side + +When the MGCF receives a REL message from the preceding node (signal 1 in figure 42), the MGCF shall release resources for the CS network side in the IM-MGW. If any resources were seized in the IM-MGW, the MGCF shall use the "Release Bearer", "Change Through-Connection" and "Release Termination" procedures to indicate to the IM-MGW that the CS network side bearer termination shall be removed and the bearer shall be released towards the preceding MGW (signal 3 to 6 in figure 42). After completion of resource release, the MGCF shall send a RLC message towards the preceding node. + +##### 9.2.5.1.2 Session release in the IM CN subsystem side + +When the MGCF receives a REL message from the preceding node (signal 1 in figure 42), the MGCF shall send a BYE message to the IM CN subsystem (signal 2 in figure 42) and the MGCF shall release the resources in the IM-MGW serving the relevant Mb interface connection by using the "Release IMS Termination" procedure (signals 7 and 8 in figure 42). The MGCF shall also expect to receive a 200 OK [BYE] message from the IM CN subsystem side (signal 10 in figure 42). + +##### 9.2.5.1.3 Message sequence chart + +Figure 42 shows the message sequence chart for the session release initiated from the CS network side. + +![Figure 42: Session release from CS network side for BICC (message sequence chart). The diagram shows a sequence of messages between an IM-MGW and an MGCF. The sequence starts with a BICC REL message from the IM-MGW to the MGCF. The MGCF then sends a SIP BYE message to the right. Next, the MGCF sends an H.248 MOD.req message to the IM-MGW, which is labeled 'Release Bearer, Change Through-Connection = backward'. The IM-MGW responds with an H.248 MOD.resp. Then, the MGCF sends an H.248 SUB.req message, labeled 'Release Termination', which the IM-MGW responds to with an H.248 SUB.resp. Next, the MGCF sends another H.248 SUB.req message, labeled 'Release IMS Termination', which the IM-MGW responds to with an H.248 SUB.resp. Finally, the MGCF sends a BICC RLC message to the left, and the IM-MGW responds with a SIP 200 OK [BYE] message to the MGCF.](9f862801bce82634d3b5a1e0a195a799_img.jpg) + +``` + +sequenceDiagram + participant IM-MGW + participant MGCF + Note left of IM-MGW: Release Bearer, Change Through-Connection = backward + IM-MGW->>MGCF: 1. BICC: REL + MGCF->>right: 2. SIP: BYE + MGCF->>IM-MGW: 3. H.248: MOD.req [Context ID = C1, Termination ID = T2] + IM-MGW-->>MGCF: 4. H.248: MOD.resp [Context ID = C1, Termination ID = T2] + Note left of IM-MGW: Release Termination + MGCF->>IM-MGW: 5. H.248: SUB.req [Context ID = C1, Termination ID = T2] + IM-MGW-->>MGCF: 6. H.248: SUB.resp [Context ID = C1, Termination ID = T2] + Note left of IM-MGW: Release IMS Termination + MGCF->>IM-MGW: 7. H.248: SUB.req [Context ID = C1, Termination ID = T1] + IM-MGW-->>MGCF: 8. H.248: SUB.resp [Context ID = C1, Termination ID = T1] + MGCF->>left: 9. BICC: RLC + IM-MGW-->>MGCF: 10. SIP: 200 OK [BYE] + +``` + +Figure 42: Session release from CS network side for BICC (message sequence chart). The diagram shows a sequence of messages between an IM-MGW and an MGCF. The sequence starts with a BICC REL message from the IM-MGW to the MGCF. The MGCF then sends a SIP BYE message to the right. Next, the MGCF sends an H.248 MOD.req message to the IM-MGW, which is labeled 'Release Bearer, Change Through-Connection = backward'. The IM-MGW responds with an H.248 MOD.resp. Then, the MGCF sends an H.248 SUB.req message, labeled 'Release Termination', which the IM-MGW responds to with an H.248 SUB.resp. Next, the MGCF sends another H.248 SUB.req message, labeled 'Release IMS Termination', which the IM-MGW responds to with an H.248 SUB.resp. Finally, the MGCF sends a BICC RLC message to the left, and the IM-MGW responds with a SIP 200 OK [BYE] message to the MGCF. + +Figure 42: Session release from CS network side for BICC (message sequence chart) + +#### 9.2.5.2 ISUP + +##### 9.2.5.2.1 Session release in the CS network side + +When the MGCF receives a REL message from the preceding node (signal 1 in figure 43), the MGCF shall release resources for the CS network side in the IM-MGW. If any resources were seized in the IM-MGW, the MGCF shall use the "Release TDM Termination procedures" to indicate to the IM-MGW that the CS network side bearer termination can be released (signal 3 to 4 in figure 43). After completion of resource release, the MGCF shall send a RLC message towards the preceding node. + +##### 9.2.5.2.2 Session release in the IM CN subsystem side + +When the MGCF receives a REL message from the preceding node (signal 1 in figure 43), the MGCF shall send a BYE message to the IM CN subsystem (signal 2 in figure 43) and the MGCF shall release the resources in the IM-MGW serving the relevant Mb interface connection by using the "Release IMS Termination" procedure (signal 5 to 6 in figure 43). The MGCF shall also expect to receive a 200 OK [BYE] message from the IM CN subsystem side (signal 8 in figure 43). + +##### 9.2.5.2.3 Message sequence chart + +Figure 43 shows the message sequence chart for the session release initiated from the CS network side. + +![Figure 43: Session release from CS network side for ISUP (message sequence chart). The diagram shows a sequence of messages between an IM-MGW and an MGCF. The sequence starts with the IM-MGW sending a 1. ISUP: REL message to the MGCF. The MGCF responds with a 2. SIP: BYE message. The IM-MGW then sends a 3. H.248: SUB.req [Context ID = C1, Termination ID = T2] message to the MGCF. The MGCF responds with a 4. H.248: SUB.resp [Context ID = C1, Termination ID = T2] message. The IM-MGW then sends a 5. H.248: SUB.req [Context ID = C1, Termination ID = T1] message to the MGCF. The MGCF responds with a 6. H.248: SUB.resp [Context ID = C1, Termination ID = T1] message. The IM-MGW then sends a 7. ISUP: RLC message to the MGCF. The MGCF responds with a 8. SIP: 200 OK [BYE] message. The diagram also includes labels for 'Release TDM Termination' and 'Release IMS Termination'.](0b3d9fe35da3ee0c88f1420bb9ed7a03_img.jpg) + +``` + +sequenceDiagram + participant IM-MGW + participant MGCF + Note left of IM-MGW: Release TDM Termination + IM-MGW->>MGCF: 1. ISUP: REL + MGCF->>External: 2. SIP: BYE + MGCF->>IM-MGW: 3. H.248: SUB.req [Context ID = C1, Termination ID = T2] + IM-MGW->>MGCF: 4. H.248: SUB.resp [Context ID = C1, Termination ID = T2] + Note left of IM-MGW: Release IMS Termination + IM-MGW->>MGCF: 5. H.248: SUB.req [Context ID = C1, Termination ID = T1] + MGCF->>IM-MGW: 6. H.248: SUB.resp [Context ID = C1, Termination ID = T1] + IM-MGW->>External: 7. ISUP: RLC + MGCF->>External: 8. SIP: 200 OK [BYE] + +``` + +Figure 43: Session release from CS network side for ISUP (message sequence chart). The diagram shows a sequence of messages between an IM-MGW and an MGCF. The sequence starts with the IM-MGW sending a 1. ISUP: REL message to the MGCF. The MGCF responds with a 2. SIP: BYE message. The IM-MGW then sends a 3. H.248: SUB.req [Context ID = C1, Termination ID = T2] message to the MGCF. The MGCF responds with a 4. H.248: SUB.resp [Context ID = C1, Termination ID = T2] message. The IM-MGW then sends a 5. H.248: SUB.req [Context ID = C1, Termination ID = T1] message to the MGCF. The MGCF responds with a 6. H.248: SUB.resp [Context ID = C1, Termination ID = T1] message. The IM-MGW then sends a 7. ISUP: RLC message to the MGCF. The MGCF responds with a 8. SIP: 200 OK [BYE] message. The diagram also includes labels for 'Release TDM Termination' and 'Release IMS Termination'. + +Figure 43: Session release from CS network side for ISUP (message sequence chart) + +### 9.2.6 Session release initiated by MGCF + +#### 9.2.6.1 BICC + +##### 9.2.6.1.1 Session release in the CS network side + +The MGCF shall send a REL message to the succeeding node on the CS network side (signal 1 in figure 44). Once the succeeding node has responded with the RLC message (signal 3 in figure 44), the MGCF shall release the resources for the CS network side in the IM-MGW. If any resources were seized in the IM-MGW, the MGCF shall use the "Release Bearer", "Change Through-Connection" and "Release Termination" procedures to indicate to the IM-MGW that the CS network side bearer termination shall be removed and the bearer shall be released towards the succeeding MGW (signal 4 to 7 in figure 44). + +##### 9.2.6.1.2 Session release in the IM CN subsystem side + +The MGCF shall send a BYE message to the IM CN subsystem side (signal 2 in figure 44) and the MGCF shall release the resources in the IM-MGW serving the relevant Mb interface connection by using the "Release IMS Termination" procedure (signals 8 and 9 in figure 44). The MGCF shall also expect to receive a 200 OK [BYE] message is received from the IM CN subsystem side (signal 10 in figure 44). + +##### 9.2.6.1.3 Message sequence chart + +Figure 44 shows the message sequence chart for the session release initiated by the MGCF. + +![Figure 44: Session release initiated by MGCF for BICC (message sequence chart). The diagram shows a sequence of messages between MGCF and IM-MGW. The sequence starts with MGCF sending a BICC: REL message to IM-MGW (1). MGCF then sends a SIP: BYE message to an external entity (2). IM-MGW responds with a BICC: RLC message (3). MGCF then sends a series of H.248 messages to IM-MGW: MOD.req [Context ID = C1, Termination ID = T2] (4), MOD.resp [Context ID = C1, Termination ID = T2] (5), SUB.req [Context ID = C1, Termination ID = T2] (6), SUB.resp [Context ID = C1, Termination ID = T2] (7), SUB.req [Context ID = C1, Termination ID = T1] (8), and SUB.resp [Context ID = C1, Termination ID = T1] (9). Finally, MGCF receives a SIP: 200 OK [BYE] message (10). Annotations on the left indicate 'Release Bearer, Change Through-Connection = backward' for messages 4-5, 'Release Termination' for messages 6-7, and 'Release IMS Termination' for messages 8-9.](c99bf3a0530a3e58f5f2d2790ba7441b_img.jpg) + +``` + +sequenceDiagram + participant MGCF + participant IM-MGW + Note left of MGCF: Release Bearer, Change Through-Connection = backward + MGCF->>IM-MGW: 1. BICC: REL + MGCF->>External: 2. SIP: BYE + IM-MGW->>MGCF: 3. BICC: RLC + MGCF->>IM-MGW: 4. H.248: MOD.req [Context ID = C1, Termination ID = T2] + IM-MGW->>MGCF: 5. H.248: MOD.resp [Context ID = C1, Termination ID = T2] + Note left of MGCF: Release Termination + MGCF->>IM-MGW: 6. H.248: SUB.req [Context ID = C1, Termination ID = T2] + IM-MGW->>MGCF: 7. H.248: SUB.resp [Context ID = C1, Termination ID = T2] + Note left of MGCF: Release IMS Termination + MGCF->>IM-MGW: 8. H.248: SUB.req [Context ID = C1, Termination ID = T1] + IM-MGW->>MGCF: 9. H.248: SUB.resp [Context ID = C1, Termination ID = T1] + External->>MGCF: 10. SIP: 200 OK [BYE] + +``` + +Figure 44: Session release initiated by MGCF for BICC (message sequence chart). The diagram shows a sequence of messages between MGCF and IM-MGW. The sequence starts with MGCF sending a BICC: REL message to IM-MGW (1). MGCF then sends a SIP: BYE message to an external entity (2). IM-MGW responds with a BICC: RLC message (3). MGCF then sends a series of H.248 messages to IM-MGW: MOD.req [Context ID = C1, Termination ID = T2] (4), MOD.resp [Context ID = C1, Termination ID = T2] (5), SUB.req [Context ID = C1, Termination ID = T2] (6), SUB.resp [Context ID = C1, Termination ID = T2] (7), SUB.req [Context ID = C1, Termination ID = T1] (8), and SUB.resp [Context ID = C1, Termination ID = T1] (9). Finally, MGCF receives a SIP: 200 OK [BYE] message (10). Annotations on the left indicate 'Release Bearer, Change Through-Connection = backward' for messages 4-5, 'Release Termination' for messages 6-7, and 'Release IMS Termination' for messages 8-9. + +Figure 44: Session release initiated by MGCF for BICC (message sequence chart) + +#### 9.2.6.2 ISUP + +##### 9.2.6.2.1 Session release in the CS network side + +The MGCF shall send a REL message to the succeeding node on the CS network side (signal 2 in figure 45) and the MGCF shall release the resources for the CS network side in the IM-MGW. If any resources were seized in the IM-MGW, the MGCF shall use the "Release TDM Termination" procedure to indicate to the IM-MGW that the CS network side termination shall be released (signal 5 to 6 in figure 45). The MGCF shall also expect to receive a RLC message from the succeeding node on the CS network side (signal 7 in figure 45). + +##### 9.2.6.2.2 Session release in the IM CN subsystem side + +The MGCF shall send a BYE message to the IM CN subsystem side (signal 1 in figure 45) and the MGCF shall release the resources in the IM-MGW serving the relevant Mb interface connection by using the "Release IMS Termination" procedure (signal 5 to 6 in figure 45). The MGCF shall also expect to receive a 200 OK [BYE] message from the IM CN subsystem side (signal 8 in figure 45). + +##### 9.2.6.2.3 Message sequence chart + +Figure 45 shows the message sequence chart for the session release initiated by the MGCF. + +![Figure 45: Session release initiated by MGCF for ISUP (message sequence chart). The diagram shows a sequence of messages between an MGCF and an IM-MGW. The sequence starts with the MGCF sending a SIP: BYE message to an external entity. The IM-MGW responds with an ISUP: REL message. The MGCF then sends an H.248: SUB.req message to the IM-MGW, which responds with an H.248: SUB.resp. The MGCF then sends another H.248: SUB.req message to the IM-MGW, which responds with an H.248: SUB.resp. The MGCF then sends an ISUP: RLC message to the IM-MGW. Finally, the MGCF receives a SIP: 200 OK [BYE] message from the external entity. The diagram also includes labels for 'Release IMS Termination' and 'Release TDM Termination'.](9252ccfbbe9e34cb108f0060f2b563f1_img.jpg) + +``` + +sequenceDiagram + participant MGCF + participant IM-MGW + Note left of MGCF: Release IMS Termination + MGCF->>External: 1. SIP: BYE + IM-MGW->>External: 2. ISUP: REL + MGCF->>IM-MGW: 3. H.248: SUB.req [Context ID = C1, Termination ID = T1] + IM-MGW-->>MGCF: 4. H.248: SUB.resp [Context ID = C1, Termination ID = T1] + Note left of MGCF: Release TDM Termination + MGCF->>IM-MGW: 5. H.248: SUB.req [Context ID = C1, Termination ID = T2] + IM-MGW-->>MGCF: 6. H.248: SUB.resp [Context ID = C1, Termination ID = T2] + IM-MGW->>External: 7. ISUP: RLC + External->>MGCF: 8. SIP: 200 OK [BYE] + +``` + +Figure 45: Session release initiated by MGCF for ISUP (message sequence chart). The diagram shows a sequence of messages between an MGCF and an IM-MGW. The sequence starts with the MGCF sending a SIP: BYE message to an external entity. The IM-MGW responds with an ISUP: REL message. The MGCF then sends an H.248: SUB.req message to the IM-MGW, which responds with an H.248: SUB.resp. The MGCF then sends another H.248: SUB.req message to the IM-MGW, which responds with an H.248: SUB.resp. The MGCF then sends an ISUP: RLC message to the IM-MGW. Finally, the MGCF receives a SIP: 200 OK [BYE] message from the external entity. The diagram also includes labels for 'Release IMS Termination' and 'Release TDM Termination'. + +Figure 45: Session release initiated by MGCF for ISUP (message sequence chart) + +### 9.2.7 Session release initiated by IM-MGW + +#### 9.2.7.1 BICC + +##### 9.2.7.1.1 Session release in the CS network side + +Upon receiving from the IM-MGW a "Bearer Released" procedure (signal 1a and 2a in figure 46) or "IMS Bearer Released" procedure (signal 1b and 2b in figure 46) or a "MGW Out-of-Service" procedure indicating an immediate release (H248 ServiceChangeMethod="Forced") (not depicted in figure 46), the MGCF shall send a REL message to the succeeding node on the CS network side (signal 3 in figure 46). Once the succeeding node has responded with the RLC message (signal 5 in figure 46), the MGCF shall release the resources for the CS network side in the IM-MGW, unless the "MGW Out-of-Service" procedure was received. If any resources were seized in the IM-MGW, the MGCF shall use the "Release Termination" procedure to indicate to the IM-MGW that the CS network side bearer termination shall be removed (signals 6 and 7 in figure 46). + +NOTE: Other actions related to MGW Out-Of-Service procedure is defined in 3GPP TS 23.205 [27]. + +##### 9.2.7.1.2 Session release in the IM CN subsystem side + +Upon receiving from the IM-MGW a "Bearer Released" procedure (signals 1a and 2a in figure 46) or "IMS Bearer Released" procedure (signal 1b and 2b in figure 46) or a "MGW Out-of-Service" procedure indicating an immediate release (H248 ServiceChangeMethod="Forced") (not depicted in figure 46), the MGCF shall send a BYE/CANCEL message to the IM CN subsystem side (signal 4 in figure 46). Upon receiving from the IM-MGW a "Bearer Released" procedure or "IMS Bearer Released" procedure, the MGCF shall also release the resources in the IM-MGW serving the relevant Mb interface connection by using the "Release IMS Termination" procedure (signals 8 and 9 in figure 46). The MGCF shall also expect to receive a 200 OK [BYE] message from the IM CN subsystem side (signal 10 in figure 46). + +NOTE: Other actions related to MGW-Out-Of-Service procedure is defined in 3GPP TS 23.205 [27] + +##### 9.2.7.1.3 Message sequence chart + +Figure 46 shows the message sequence chart for the session release initiated by the IM-MGW. + +![Figure 46: Session release initiated by the IM-MGW for BICC (message sequence chart). The diagram shows the interaction between MGCF and IM-MGW for session release. It includes two main paths: 'Bearer Released' (signals 1a, 2a, 3, 4, 5) and 'IMS Bearer Released' (signals 1b, 2b, 3, 4, 5). The 'Release Termination' path (signals 6, 7, 8, 9, 10) shows the MGCF sending SUB.req and receiving SUB.resp, followed by a SIP 200 OK [BYE] message.](8269648391c59363ea61243864a2adf7_img.jpg) + +``` + +sequenceDiagram + participant MGCF + participant IM-MGW + Note left of MGCF: Bearer Released + MGCF->>IM-MGW: 1a. H.248: Notify.req [Context ID = C1, Termination ID = T2] + IM-MGW-->>MGCF: 2a. H.248: Notify.resp [Context ID = C1, Termination ID = T2] + Note left of MGCF: or + Note left of MGCF: IMS Bearer Released + MGCF->>IM-MGW: 1b. H.248: Notify.req [Context ID = C1, Termination ID = T1] + IM-MGW-->>MGCF: 2b. H.248: Notify.resp [Context ID = C1, Termination ID = T1] + MGCF->>IM-MGW: 3. BICC: REL + MGCF->>IM-MGW: 4. SIP: BYE + IM-MGW-->>MGCF: 5. BICC: RLC + Note left of MGCF: Release Termination + MGCF->>IM-MGW: 6. H.248: SUB.req [Context ID = C1, Termination ID = T2] + IM-MGW-->>MGCF: 7. H.248: SUB.resp [Context ID = C1, Termination ID = T2] + Note left of MGCF: Release IMS Termination + MGCF->>IM-MGW: 8. H.248: SUB.req [Context ID = C1, Termination ID = T1] + IM-MGW-->>MGCF: 9. H.248: SUB.resp [Context ID = C1, Termination ID = T1] + MGCF->>IM-MGW: 10. SIP: 200 OK [BYE] + +``` + +Figure 46: Session release initiated by the IM-MGW for BICC (message sequence chart). The diagram shows the interaction between MGCF and IM-MGW for session release. It includes two main paths: 'Bearer Released' (signals 1a, 2a, 3, 4, 5) and 'IMS Bearer Released' (signals 1b, 2b, 3, 4, 5). The 'Release Termination' path (signals 6, 7, 8, 9, 10) shows the MGCF sending SUB.req and receiving SUB.resp, followed by a SIP 200 OK [BYE] message. + +Figure 46: Session release initiated by the IM-MGW for BICC (message sequence chart) + +#### 9.2.7.2 ISUP + +##### 9.2.7.2.1 Session release in the CS network side + +Upon receiving from the IM-MGW a "Termination Out-of-Service" procedure indicating an immediate release (signals 1a and 2a in figure 47), a "Bearer Released" procedure (signals 1b and 2b in figure 47), a "IMS Bearer Released" procedure (signals 1c and 2c in figure 47) or a "MGW Out-of-Service procedure" (not depicted in figure 47) indicating an immediate release (H248 ServiceChangeMethod="Forced") the MGCF shall send a REL message to the succeeding node (signal 3 in figure 47). Upon receiving from the IM-MGW a "Termination Out-of-Service" message procedure indicating an immediate release or a "Bearer Released" procedure, the MGCF shall also release the resources for the corresponding CS network side termination(s) in the IM-MGW. If any resources were seized in the IM-MGW, the MGCF shall use the "Release TDM Termination" procedure to indicate to the IM-MGW that the CS network side bearer termination can be removed (signals 7 and 8 in figure 47). The MGCF also expects to receive a RLC message on the CS network side (signal 9 in figure 47) before the circuit is reselectable. + +NOTE: Other actions related to "MGW-Out-Of-Service" procedure are defined in 3GPP TS 23.205 [27]. + +##### 9.2.7.2.2 Session release in the IM CN subsystem side + +Upon receiving from the IM-MGW a "Termination Out-of-Service" procedure indicating an immediate release (signals 1a and 2a in figure 47) on the CS termination in the context, a "Bearer Released" procedure (signals 1b and 2b in figure 47), an "IMS Bearer Released" procedure (signals 1c and 2c in figure 47) or a "MGW Out-of-Service procedure" (not depicted in figure 47) indicating an immediate release, (H248 ServiceChangeMethod="Forced") the MGCF shall send a BYE/CANCEL message to the IM CN subsystem side (signal 4 in figure 47). Upon receiving from the IM-MGW a "Termination Out-of-Service" procedure indicating an immediate release on the CS termination in the context, a "Bearer Released" procedure or an "IMS Bearer Released" procedure, the MGCF shall also release the resources in the IM-MGW for the corresponding terminations towards the IM CN subsystem using the "Release IMS Termination" procedure (signals 5 and 6 in figure 47). The MGCF also expects to receive a 200 OK [BYE] message from the IM CN subsystem side (signal 10 in figure 47). + +NOTE: Other actions related to "MGW-Out-Of-Service" procedure are defined in 3GPP TS 23.205 [27]. + +##### 9.2.7.2.3 Message sequence chart + +Figure 47 shows the message sequence chart for the session release initiated by the IM-MGW. + +![Figure 47: Session release initiated by the IM-MGW for ISUP (message sequence chart). The diagram shows a sequence of messages between MGCF and IM-MGW. The sequence starts with IM-MGW sending a ServiceChange.req to MGCF. MGCF responds with ServiceChange.resp. Then, IM-MGW sends Notify.req to MGCF, which responds with Notify.resp. This is followed by another Notify.req and Notify.resp. Then, IM-MGW sends a REL message to MGCF. MGCF responds with a BYE message. IM-MGW then sends SUB.req to MGCF, which responds with SUB.resp. This is followed by another SUB.req and SUB.resp. Finally, IM-MGW sends a RLC message to MGCF, which responds with a 200 OK [BYE] message.](a5184899f915014fa38608754efcc9c7_img.jpg) + +``` + +sequenceDiagram + participant MGCF + participant IM-MGW + Note left of MGCF: Termination Out-of-Service +or +Bearer Released +or +IMS Bearer Released + IM-MGW->>MGCF: 1a. H.248: ServiceChange.req [Context ID = C1, Termination ID = T2] + MGCF-->>IM-MGW: 2a. H.248: ServiceChange.resp [Context ID = C1, Termination ID = T2] + IM-MGW->>MGCF: 1b. H.248: Notify.req [Context ID = C1, Termination ID = T2] + MGCF-->>IM-MGW: 2b. H.248: Notify.resp [Context ID = C1, Termination ID = T2] + IM-MGW->>MGCF: 1c. H.248: Notify.req [Context ID = C1, Termination ID = T1] + MGCF-->>IM-MGW: 2c. H.248: Notify.resp [Context ID = C1, Termination ID = T1] + IM-MGW->>MGCF: 3. ISUP: REL + MGCF-->>External: 4. SIP: BYE + Note left of MGCF: Release IMS Termination +or +Release TDM Termination + IM-MGW->>MGCF: 5. H.248: SUB.req [Context ID = C1, Termination ID = T1] + MGCF-->>IM-MGW: 6. H.248: SUB.resp [Context ID = C1, Termination ID = T1] + IM-MGW->>MGCF: 7. H.248: SUB.req [Context ID = C1, Termination ID = T2] + MGCF-->>IM-MGW: 8. H.248: SUB.resp [Context ID = C1, Termination ID = T2] + IM-MGW->>MGCF: 9. ISUP: RLC + MGCF-->>External: 10. SIP: 200 OK [BYE] + +``` + +Figure 47: Session release initiated by the IM-MGW for ISUP (message sequence chart). The diagram shows a sequence of messages between MGCF and IM-MGW. The sequence starts with IM-MGW sending a ServiceChange.req to MGCF. MGCF responds with ServiceChange.resp. Then, IM-MGW sends Notify.req to MGCF, which responds with Notify.resp. This is followed by another Notify.req and Notify.resp. Then, IM-MGW sends a REL message to MGCF. MGCF responds with a BYE message. IM-MGW then sends SUB.req to MGCF, which responds with SUB.resp. This is followed by another SUB.req and SUB.resp. Finally, IM-MGW sends a RLC message to MGCF, which responds with a 200 OK [BYE] message. + +Figure 47: Session release initiated by the IM-MGW for ISUP (message sequence chart) + +### 9.2.8 Handling of RTP telephone events + +DTMF digits, telephony tones and signals (telephone events) can be transferred using different mechanisms. For the IM CN Subsystem, 3GPP TS 24.229 [9] defines the usage of the RTP payload format defined for DTMF Digits, Telephony Tones and Telephony Signals in RFC 4733 [105]. When BICC signalling is used in the CS network, telephony signals may be sent either inband or out-of-band as defined in ITU-T Recommendation Q.1902.4 [30] and in ITU-T Recommendation Q.765.5 [35]. If ISUP signalling is used the DTMF tones are sent inband. The following paragraphs describe the Mn interface procedures to transfer DTMF between RTP format defined in RFC 4733 [105] and the CS CN. + +Before the actual usage of the telephony signals can occur the sending/receiving of telephone events need to be agreed with the SDP offer-answer mechanism defined in RFC 3264 [36]. The outcome of the negotiation can be e.g. that no telephone events are sent in RTP payload, telephone events are sent only in one direction or in both directions. If the outcome of the negotiation is that RTP payload telephone-events are sent in both directions, the IM-MGW may nevertheless be configured to interwork only mobile originated telephone-events. + +When the offer-answer mechanism based session parameters negotiation results in an agreement that telephone events are sent in the RTP payload and the needed preconditions are fulfilled, telephone events can be sent in RTP payload. This negotiation can be done at call control signalling phase or during an ongoing call. + +If the MGCF and IM-MGW support the reception and/or transmission of the RTP MIME type "telephone event" (as defined in RFC 4733 [105]) with the IMS, the following applies: + +- For CS Network Originating Sessions, the MGCF shall include the MIME type "telephone events" with default events in the first SDP offer. After the usage of telephone events is agreed in the subsequent offer-answer + +parameter exchanges and the needed preconditions defined in RFC 3312 [37] are fulfilled, telephone events can be sent as RTP payload. + +- In case of IM CN Subsystem Originating Sessions, the MGCF shall accept the MIME type "telephone events" with default events in any SDP answer when it received such an offer. + +#### 9.2.8.1 Sending DTMF digits out-of-band to CS CN (BICC) + +For the IM CN subsystem terminated session, the MGCF shall use the "Configure IMS Resources" procedure as described in clause 9.2.3. For the IM CN subsystem originating session, the MGCF shall use the "Reserve IMS Connection Point and Configure Remote Resources" procedure as described in clause 9.2.2. If DTMF is supported, the MGCF shall include "telephone event" along with the selected speech codecs within the "local IMS resources" Parameter of these procedures. The same termination shall be used to receive and transmit DTMF and speech of the same call. + +Furthermore, the MGCF shall use the "Detect IMS RTP Tel Signal" procedure to request the MGW to detect incoming telephone events from the IMS and notify the MGCF about the detected events. The MGW shall use the "Notify IMS RTP Tel Event" procedure for this notification. The termination used to receive DTMF shall be placed in the same context used for the speech of the same call. The MGCF shall request to be notified when the MGW detects the end of a digit and may also request to be notified when the MGW detects the start of a digit. An IM-MGW not supporting the notification about the detection of the start of a digit may ignore the request to provide this notification. If the IM-MGW received a "Detect IMS RTP Tel Event" procedure for a termination, the IM-MGW shall not forward inband to the CS network any DTMF received at this termination. + +Figure 48 shows an example message sequence chart when a DTMF digit is received from the IM CN subsystem in the RTP payload and the MGCF has requested to be notified only about the detection of the end of a digit. Figure 48a shows an example message sequence chart when a DTMF digit is received from the IM CN subsystem in the RTP payload and the MGCF has requested to be notified about the detection of the start and the end of a digit. + +![Sequence diagram showing the activation of notification of DTMF digits received in RTP and examples of sending the digits out-of-band to CS CN. Lifelines: IM-MGW and MGCF. The diagram includes messages 1, 2, 8, 9, 10, 11, 12, and 13. A bracket on the right side groups messages 8 and 9 as '1 Digit'.](4e85fe330de2c4f5eea6de4b2a53c77f_img.jpg) + +Sequence diagram illustrating the activation of notification of DTMF digits received in RTP and examples of sending the digits out-of-band to CS CN. The diagram shows interactions between IM-MGW and MGCF. + +**IM-MGW** (left lifeline) and **MGCF** (right lifeline). + +**Sequence of messages:** + +- 1. H.248 Add/Mod.req** [Context ID = C1, Termination ID = T1, Codec = "telephone event, AMR", Notify IMS RTP Tel Event ("End tone detected") ] +- 2. H.248 Add/Mod.resp** [Context ID = C1, Termination ID = T1] +- 8. RTP** encoded new DTMF event (tone-event, end=0, duration=x) +- 9. RTP** encoded continued DTMF event (tone-event, end=1, duration= Duration) +- 10. H.248 Notify.ind** [Context ID = C1, Termination ID = T1, Tone-ID, Event="End tone detected", Duration] +- 11. H.248 Notify.resp** [Context ID = C1, Termination ID = T1] +- 12. BICC APM** (ActInd= Start signal notify, signal-type, duration) +- 13. BICC APM** (ActInd=Start signal ack) + +**Notes:** + +- Configure IMS Resources or Reserve IMS Connection Point and configure Remote Resources, Detect\_IMS\_RTP\_Tel\_Event +- Notify\_IMS\_RTP\_Tel\_Event +- A bracket on the right side groups messages 8 and 9 as **1 Digit**. + +Sequence diagram showing the activation of notification of DTMF digits received in RTP and examples of sending the digits out-of-band to CS CN. Lifelines: IM-MGW and MGCF. The diagram includes messages 1, 2, 8, 9, 10, 11, 12, and 13. A bracket on the right side groups messages 8 and 9 as '1 Digit'. + +Figure 48: Activation of notification of DTMF digits received in RTP and examples of sending the digits out-of-band to CS CN, a whole digit received by IM-MGW before sending further (message sequence chart) + +![Sequence diagram showing the activation of notification of DTMF digits received in RTP. The diagram involves two main participants: IM-MGW and MGCF. The process starts with the MGCF sending an H.248 Add/Mod.req to the IM-MGW. The IM-MGW responds with H.248 Add/Mod.resp. The MGCF then sends an RTP encoded new DTMF event. The IM-MGW detects the event and sends an H.248 Notify.ind to the MGCF. The MGCF responds with H.248 Notify.resp. The IM-MGW then sends BICC APM (ActInd=Start signal notify) and BICC APM (ActInd=Start signal ack) messages. The MGCF sends another RTP encoded new DTMF event. The IM-MGW detects the event and sends an H.248 Notify.ind to the MGCF. The MGCF responds with H.248 Notify.resp. The IM-MGW then sends BICC APM (ActInd=Stop signal notify) and BICC APM (ActInd=Stop signal ack) messages. A bracket on the right side of the diagram groups the RTP events and H.248 notifications as '1 Digit'.](be3e5fe8be7cc5a74f67a4b8ac93193d_img.jpg) + +Sequence Diagram: Activation of notification of DTMF digits received in RTP + +Participants: IM-MGW, MGCF + +Sequence of messages: + +1. H.248 Add/Mod.req [Context ID = C1, Termination ID = T1, Codec = "telephone event, AMR", Notify IMS RTP Tel Event ("Start tone detected", "End tone detected") ] +2. H.248 Add/Mod.resp [Context ID = C1, Termination ID = T1] +3. RTP encoded new DTMF event (tone-event, end=0, duration=x) +4. H.248 Notify.ind [Context ID = C1, Termination ID = T1, Tone\_ID, Event="Start tone detected"] +5. H.248 Notify.resp [Context ID = C1, Termination ID = T1] +6. BICC APM (ActInd=Start signal notify, signal-type) +7. BICC APM (ActInd=Start signal ack) +8. RTP encoded new DTMF event (tone-event, end=0, duration=y) +9. RTP encoded continued DTMF event (tone-event, end=1, duration=Duration) +10. H.248 Notify.ind [Context ID = C1, Termination ID = T1, Tone-ID, Event="End tone detected", Duration] +11. H.248 Notify.resp [Context ID = C1, Termination ID = T1] +12. BICC APM (ActInd=Stop signal notify) +13. BICC APM (ActInd=Stop signal ack) + +External events and notifications: + +- Configure IMS Resources or Reserve IMS Connection Point and configure Remote Resources, Detect IMS RTP Tel Event (on IM-MGW side) +- Notify IMS RTP Tel Event (on IM-MGW side) +- 1 Digit (grouping RTP events and H.248 notifications) + +Sequence diagram showing the activation of notification of DTMF digits received in RTP. The diagram involves two main participants: IM-MGW and MGCF. The process starts with the MGCF sending an H.248 Add/Mod.req to the IM-MGW. The IM-MGW responds with H.248 Add/Mod.resp. The MGCF then sends an RTP encoded new DTMF event. The IM-MGW detects the event and sends an H.248 Notify.ind to the MGCF. The MGCF responds with H.248 Notify.resp. The IM-MGW then sends BICC APM (ActInd=Start signal notify) and BICC APM (ActInd=Start signal ack) messages. The MGCF sends another RTP encoded new DTMF event. The IM-MGW detects the event and sends an H.248 Notify.ind to the MGCF. The MGCF responds with H.248 Notify.resp. The IM-MGW then sends BICC APM (ActInd=Stop signal notify) and BICC APM (ActInd=Stop signal ack) messages. A bracket on the right side of the diagram groups the RTP events and H.248 notifications as '1 Digit'. + +**Figure 48a: Activation of notification of DTMF digits received in RTP and examples of sending the digits out-of-band to CS CN, IM-MGW starts sending the digit further when the start of the digit is recognized (message sequence chart)** + +#### 9.2.8.2 Sending and receiving DTMF digits inband to/from CS CN (ISUP or BICC) + +For the IM CN subsystem terminated session, the MGCF shall use the "Configure IMS Resources" procedure as described in clause 9.2.3. For the IM CN subsystem originating session, the MGCF shall use the "Reserve IMS Connection Point and Configure Remote Resources" procedure as described in clause 9.2.2. If DTMF is supported and the MGCF wants to configure the IM-MGW to send and receive DTMF to/from the CS network side, the MGCF shall include "telephone event" along with the selected speech codecs within the "local IMS resources" parameter of these procedures to request the MGW to detect incoming telephone events and transform them into speech signals on the CS side and shall not apply the "Detect IMS RTP Tel Event" procedure. When receiving this configuration, an MGW supporting DTMF shall detect DTMF encoded according as RTP Tel Event and transform this into DTMF tones encoded within the speech codec used at the CS CN network and may in addition optionally detect incoming telephone events received inband from the CS CN network and transform them into telephone events on the IMS side. The same termination shall be used to receive and transmit DTMF and speech of the same call. + +Figure 49 shows the message sequence chart to configure the IM-MGW to receive DTMF detection on the IMS side and transfer the DTMF inband on the CS side. When receiving this configuration, the IM-MGW may in addition optionally detect DTMF inband on the CS side and transmit DTMF on the IMS side. + +![Sequence diagram showing the activation of DTMF processing between IM-MGW and MGCF.](7fe5741e83bc9702d1b1d7585ddf66bd_img.jpg) + +``` +sequenceDiagram + participant IM-MGW + participant MGCF + Note left of IM-MGW: Configure IMS Resources +Or +Reserve IMS Connection Point +and configure Remote Resources + MGCF->>IM-MGW: 1. H.248 Add/Mod.req +[Context ID = C1, Termination ID = T1, +Codec = "telephone event, AMR",] + IM-MGW-->>MGCF: 2. H.248 Add/Mod.resp [Context ID = C1, Termination ID = T1] +``` + +The diagram illustrates a message sequence between the IM-MGW and the MGCF. On the left, a text block indicates the actions to be performed: "Configure IMS Resources Or Reserve IMS Connection Point and configure Remote Resources". The sequence starts with the MGCF sending a message "1. H.248 Add/Mod.req" to the IM-MGW. This message includes parameters: Context ID = C1, Termination ID = T1, and Codec = "telephone event, AMR". The IM-MGW responds with "2. H.248 Add/Mod.resp" containing Context ID = C1 and Termination ID = T1. + +Sequence diagram showing the activation of DTMF processing between IM-MGW and MGCF. + +**Figure 49: Activation of processing of DTMF digits received in RTP for sending the digits inband to CS CN (message sequence chart)** + +#### 9.2.8.3 Receiving DTMF digits out-of-band from CS CN (BICC) + +For the IM CN subsystem terminated session, the MGCF shall use the "Configure IMS Resources" procedure as described in clause 9.2.3. For the IM CN subsystem originating session, the MGCF shall use the "Reserve IMS Connection Point and Configure Remote Resources" procedure as described in clause 9.2.2. If DTMF is supported, the MGCF shall include "telephone event" along with the selected speech codecs within the "local IMS resources" Parameter of these procedures. The same termination shall be used to receive and transmit DTMF and speech of the same call. + +Furthermore, the MGCF shall use the "Send IMS RTP Tel Event" and may use the "Stop IMS RTP Tel Event" procedures to request the MGW to play out DTMF to the IM CN subsystem whenever it receives out-of-band DTMF indications from the BICC network. + +Figure 49a shows an example message sequence chart when DTMF digits are transmitted to the IM CN subsystem in the RTP payload. For the first digit, the received APM message contains all information including the duration and only a single notification is received. For the second digit, the start and the end of the DTMF digit are notified separately. + +![Sequence diagram showing the interaction between IM-MGW and MGCF for receiving DTMF digits out-of-band from the CS CN and transmitting them in RTP. The diagram includes two digits, Digit 1 and Digit 2, with various H.248, BICC, and RTP messages exchanged between the entities.](8d66c9c295023a1380f9986d3663bb1e_img.jpg) + +The sequence diagram illustrates the interaction between the IM-MGW and the MGCF for receiving DTMF digits out-of-band from the CS CN and transmitting them in RTP. The sequence of messages is as follows: + +- Configure IMS Resources or Reserve IMS Connection Point and configure Remote Resources, Detect IMS RTP Tel\_Event**: The IM-MGW sends an **1. H.248 Add/Mod.req** to the MGCF. The message includes Context ID = C1, Termination ID = T1, Codec = "telephone event, AMR", and Notify IMS RTP Tel Event ("Start tone detected", "End tone detected"). +- The MGCF responds with **2. H.248 Add/Mod.resp** [Context ID = C1, Termination ID = T1]. +- The MGCF sends **3. BICC APM** (ActInd=Start signal notify, signal-type, duration) to the IM-MGW. +- The IM-MGW responds with **4. BICC APM** (ActInd=Start signal ack). +- The MGCF sends **5. H.248 Mod.ind** [Context ID = C1, Termination ID = T1, Tone-Id, SignalType=Timeout, Duration] to the IM-MGW. +- The MGCF sends **6. H.248 Mod.resp** [Context ID = C1, Termination ID = T1] to the IM-MGW. +- Send IMS RTP Tel\_Event**: The MGCF sends **7. RTP** encoded new DTMF event (tone-event, end=0, duration=x) to the IM-MGW. This is followed by another **7. RTP** encoded new DTMF event (tone-event, end=1, duration=x) to the IM-MGW. The IM-MGW then sends **8. BICC APM** (ActInd=Start signal notify, signal-type) to the MGCF, which responds with **9. BICC APM** (ActInd=Start signal ack). +- The MGCF sends **10. H.248 Mod.ind** [Context ID = C1, Termination ID = T1, Tone\_ID, SignalType=On/Off] to the IM-MGW. +- Send IMS RTP Tel\_Event**: The MGCF sends **11. H.248 Mod.resp** [Context ID = C1, Termination ID = T1] to the IM-MGW. The IM-MGW then sends **12. RTP** encoded new DTMF event (tone-event, end=0, duration=x) to the MGCF, followed by **13. RTP** encoded new DTMF event (tone-event, end=0, duration=y) to the MGCF. The MGCF then sends **14. BICC APM** (ActInd=Stop signal notify) to the IM-MGW, which responds with **15. BICC APM** (ActInd=Stop signal ack). +- The MGCF sends **16. H.248 Mod.ind** [Context ID = C1, Termination ID = T1] to the IM-MGW. +- Stop IMS RTP Tel\_Event**: The MGCF sends **17. H.248 Mod.resp** [Context ID = C1, Termination ID = T1] to the IM-MGW. The IM-MGW then sends **18. RTP** encoded continued DTMF event (tone-event, end=1, duration) to the MGCF. + +Brackets on the right side of the diagram group the messages for **Digit 1** (steps 3-6) and **Digit 2** (steps 7-17). Ellipses indicate additional messages between the digits. + +Sequence diagram showing the interaction between IM-MGW and MGCF for receiving DTMF digits out-of-band from the CS CN and transmitting them in RTP. The diagram includes two digits, Digit 1 and Digit 2, with various H.248, BICC, and RTP messages exchanged between the entities. + +Figure 49a: Examples of receiving DTMF digits out-of-band from the CS CN and transmitting them in RTP (message sequence chart) + +### 9.2.9 Session hold initiated from IM CN subsystem + +The network model in the clause 9.2.1 shall apply here. + +#### Hold request + +When the IMS network makes a hold request by sending an UPDATE or re-INVITE message (signal 1 of figure 50), the MGCF shall request the IM-MGW to suspend sending media towards the IMS side by changing the through-connection of the IM CN subsystem side termination to "not through-connected" (signal 2 of figure 50). If the IMS side provides modified SDP RR or RS bandwidth modifiers, as specified in IETF RFC 3556 [59], within the hold request, the MGCF shall use the Configure IMS Resources Mn procedure to forward this information to the IM-MGW (not depicted in figure 50, but may be combined with signal 2). The MGCF shall send a CPG (Hold) message to the succeeding CS network node to indicate that the session is on hold (signal 4 of figure 50). Simultaneously a SIP message acknowledging the Hold request is sent to the IMS side (signal 7 of figure 50, acknowledged by signal 7.a if the INVITE method is used). + +If the MGCF has identified a speech call as an "ICS call" as specified in clause 7.2.3.1.2.12 or in clause 7.2.3.2.7a the MGCF shall not apply an announcement to the party on hold. Otherwise, an announcement may be applied to the party on hold, depending on the held party's status, using the Play Announcement procedure (for BICC) or the Play TDM Announcement procedure (for ISUP, signal 5 in figure 50). The hold operation shall not block RTCP flows. + +#### Resume request + +When the IMS network makes a request to retrieve the session on hold by sending an UPDATE or re-INVITE message (signal 8 of figure 50), the MGCF shall request the IM-MGW to re-establish communication towards the IMS network by changing the through-connection of the IM CN subsystem side termination to both-way through-connected (signal 11 of figure 50). If the IMS side provides modified SDP RR or RS bandwidth modifiers, as specified in IETF RFC 3556 [59], within the retrieve request, the MGCF shall use the Configure IMS Resources Mn procedure to forward this information to the IM-MGW (not depicted in figure 50, but may be combined with signal 11). Possible announcements to the party on hold shall be stopped using the Stop Announcement procedure (for BICC) or the Stop TDM Announcement procedure (for ISUP, signal 9 in figure 50). The MGCF shall send a CPG (Retrieve) message to the succeeding CS network node to indicate that the session is retrieved (signal 13 of figure 50). + +#### Message sequence chart + +Figure 50 shows the message sequence chart for the call hold and retrieval procedures. + +![Sequence diagram showing session hold and resume from IM CN subsystem between MGCF and IM-MGW.](187d05bf7ead21e1394b61320d8b3632_img.jpg) + +``` + +sequenceDiagram + participant External + participant MGCF + participant IM-MGW + + Note left of MGCF: Change Through-Connection=Inactive + External->>MGCF: 1. SIP: UPDATE/INVITE [SDP, a=sendonly/inactive] + MGCF->>IM-MGW: 2. H.248: MOD.req [Context ID = C1, Termination ID = T1] + IM-MGW-->>MGCF: 3. H.248: MOD.resp [Context ID = C1, Termination ID = T1] + MGCF->>External: 4. BICC/ISUP: CPG (Hold) + Note left of MGCF: Play TDM Announcement + MGCF->>IM-MGW: 5. H.248: MOD.req [Context ID = C1, Termination ID = T2] + IM-MGW-->>MGCF: 6. H.248: MOD.resp [Context ID = C1, Termination ID = T2] + MGCF-->>External: 7. SIP: 200 OK [SDP] + Note left of MGCF: + External-->>MGCF: 7.a SIP: ACK (if INVITE is used) + Note left of MGCF: Stop TDM Announcement + External->>MGCF: 8. SIP: UPDATE/INVITE [SDP, a=sendrecv/recvonly] + MGCF->>IM-MGW: 9. H.248: MOD.req [Context ID = C1, Termination ID = T2] + IM-MGW-->>MGCF: 10. H.248: MOD.resp [Context ID = C1, Termination ID = T2] + MGCF->>IM-MGW: 11. H.248: MOD.req [Context ID = C1, Termination ID = T1] + IM-MGW-->>MGCF: 12. H.248: MOD.resp [Context ID = C1, Termination ID = T1] + Note left of MGCF: Change Through-Connection=Both + MGCF->>External: 13. BICC/ISUP: CPG (Retrieve) + MGCF-->>External: 14. SIP: 200 OK [SDP] + Note left of MGCF: + External-->>MGCF: 14.a SIP: ACK (if INVITE is used) + +``` + +Sequence diagram showing session hold and resume from IM CN subsystem between MGCF and IM-MGW. + +NOTE: For an "ICS call" signals 5, 6, 9 and 10 will not be sent since the MGCF will not request an announcement from the IM-MGW. + +**Figure 50: Session hold/resume from IM CN subsystem** + +### 9.2.10 Session hold initiated from CS network + +When an MGCF receives a CPG message with a "*remote hold*" Generic notification indicator (signal 1 of figure 51), the MGCF forwards the hold request by sending an UPDATE or re-INVITE message containing SDP with "*sendonly*" or "*inactive*" media (signal 4 of figure 51). + +When an MGCF receives a CPG message with a "*remote retrieval*" Generic notification indicator (signal 6 of figure 51), the MGCF forwards the resume request by sending an UPDATE or re-INVITE message containing SDP with "*sendrecv*" or "*recvonly*" media (signal 9 of figure 51). + +If the MGCF receives a CPG with "*remote hold*" or "*remote retrieval*" before answer, it shall forward the request using an UPDATE message. If the MGCF receives a CPG with "*remote hold*" or "*remote retrieval*" after answer, it should forward the request using re-INVITE but may use UPDATE. + +If link aliveness information is required at the IM-MGW while the media are on hold, and RTCP was previously disabled the MGCF should provide to the modified SDP RR and RS bandwidth modifiers specified in + +IETF RFC 3556 [59] within the SDP offers in the UPDATE or re-INVITE messages holding and retrieving the media as detailed in clause 7.3.1 of 3GPP TS 26.114 [104]. If no link aliveness information is required at the IM-MGW or RTCP was previously enabled, the MGCF should provide the SDP RR and RS bandwidth modifiers previously used. + +The interworking does not impact the user plane, unless the MGCF: + +- provides modified SDP RR and RS bandwidth modifiers in the UPDATE or re-INVITE messages. If the MGCF provides modified SDP RR and RS bandwidth modifiers in the UPDATE or re-INVITE messages, the MGCF shall also provide modified SDP RR and RS bandwidths to the IM-MGW using the Configure IMS Resources procedures (signals 2-3 and 7-8 of figure 51); or +- has identified a speech call as an "ICS call" as specified in clause 7.2.3.1.2.12 or in clause 7.2.3.2.7a. When the MGCF receives from the CS network: + - a) a hold request the MGCF shall request the IM-MGW to suspend sending media towards the IMS side by changing the through-connection of the IM CN subsystem side termination to "not through-connected" (not depicted in figure 51, but may be combined with signal 2) prior to sending of the UPDATE or re-INVITE message containing the SDP offer with "*sendonly*" or "*inactive*" media; + - b) a request to retrieve the session on hold and if the MGCF requested the IM-MGW to suspend sending media on the hold request the MGCF shall request the IM-MGW to re-establish communication towards the IMS network by changing the through-connection of the IM CN subsystem side termination to "both-way through-connected" (not depicted in figure 51, but may be combined with signal 7) prior to sending of the UPDATE or re-INVITE message containing the SDP offer with "*sendrecv*" or "*recvonly*" media; or +- has received for a confirmed dialog towards IMS side the Contact header (in the initial INVITE request or in the 200 OK (INVITE) response) with the "*isfocus*" media feature tag, defined in IETF RFC 3840 [135]. When the MGCF receives from the CS network: + - a) a hold request the MGCF shall request the IM-MGW to suspend sending media towards the IMS side by changing the through-connection of the IM CN subsystem side termination to "not through-connected" (not depicted in figure 51, but may be combined with signal 2) prior to sending of the UPDATE or re-INVITE message containing the SDP offer with "*sendonly*" or "*inactive*" media; or + - b) a request to retrieve the session on hold and if the MGCF requested the IM-MGW to suspend sending media on the hold request the MGCF shall request the IM-MGW to re-establish communication towards the IMS network by changing the through-connection of the IM CN subsystem side termination to "both-way through-connected" (not depicted in figure 51, but may be combined with signal 7) prior to sending of the UPDATE or re-INVITE message containing the SDP offer with "*sendrecv*" or "*recvonly*" media. + +#### Message sequence chart + +Figure 51 shows the message sequence chart for the call hold and retrieval procedures. + +![Sequence diagram for Session hold/resume from CS network. The diagram shows interactions between an external source, MGCF, and IM-MGW. The process involves holding a session (steps 1-5) and resuming it (steps 6-10).](a0e8fe7862a6d7341faf5dac275277cc_img.jpg) + +``` + +sequenceDiagram + participant External + participant MGCF + participant IM-MGW + + Note left of MGCF: Configure IMS Resources (optional) + External->>MGCF: 1. BICC/ISUP: CPG (Hold) + MGCF->>IM-MGW: 2. H.248: MOD.req [Context ID = C1, Termination ID = T1] + IM-MGW-->>MGCF: 3. H.248: MOD.resp [Context ID = C1, Termination ID = T1] + MGCF->>External: 4. SIP: UPDATE/INVITE [SDP, a=sendonly/inactive] + External-->>MGCF: 5. SIP: 200 OK [SDP] + IM-MGW-->>External: 5.a SIP: ACK (if INVITE is used) + + Note left of MGCF: Configure IMS Resources (optional) + External->>MGCF: 6. BICC/ISUP: CPG (Retrieve) + MGCF->>IM-MGW: 7. H.248: MOD.req [Context ID = C1, Termination ID = T1] + IM-MGW-->>MGCF: 8. H.248: MOD.resp [Context ID = C1, Termination ID = T1] + MGCF->>External: 9. SIP: UPDATE/INVITE [SDP, a=sendrecv/reconly] + External-->>MGCF: 10. SIP: 200 OK [SDP] + IM-MGW-->>External: 10.a SIP: ACK (if INVITE is used) + +``` + +Sequence diagram for Session hold/resume from CS network. The diagram shows interactions between an external source, MGCF, and IM-MGW. The process involves holding a session (steps 1-5) and resuming it (steps 6-10). + +Figure 51: Session hold/resume from CS network + +### 9.2.11 Explicit Congestion Notification Support + +#### 9.2.11.1 General + +A MGCF and IM-MGW may support Multimedia Telephony using Explicit Congestion Notification (see IETF RFC 3168 [129], IETF RFC 6679 [130], and 3GPP TS 26.114 [104]), and may then act as an ECN endpoint to enable ECN with a local ECN-capable terminal within a local network that properly handles ECN-marked packets. + +##### 9.2.11.1a Incoming Call Interworking from SIP to ISUP/BICC at I-MGCF + +If the MGCF receives a SDP Offer containing ECN negotiation, see IETF RFC 6679 [130], and if all of the following statements are true: + +- the MGCF supports ECN according to 3GPP TS 26.114 [104]; +- the IM-MGW supports ECN according to 3GPP TS 26.114 [104]; +- the IM-MGW knows (via configuration) that the preceding (IMS) network supports ECN according to 3GPP TS 26.114 [104]; and +- the IM-MGW supports at least some of the initialisation methods offered within the "a=ecn-capable-rtp", + +NOTE 1: Only the "leap" initialisation method is supported over the Mn interface in this release. + +The MGCF shall: + +- act as an end point for ECN; +- select an initialisation method supported by the IM-MGW; + +- determine if application specific feedback or ECN feedback messages shall be used, taking into account whether the IM-MGW supports ECN feedback messages, and the negotiation procedures in 3GPP TS 26.114 [104]; +- determine if ECN XR summary reports can be used, taking into account whether they are supported at the IM-MGW and the negotiation procedures in 3GPP TS 26.114 [104]; +- return an SDP Answer according to 3GPP TS 26.114 [104] and the capabilities of the IM-MGW, containing the "a=ecn-capable-rtp" attribute; and + +NOTE 2: ECN XR summary reports and RTCP AVPF ECN feedback message are not supported in this release. + +- indicate to the IM-MGW that it shall apply the ECN procedures (according to 3GPP TS 26.114 [104]) and act as an ECT endpoint. + +The IM-MGW should not send RTCP XR ECN summary reports. + +##### 9.2.11.1b Outgoing Call Interworking from ISUP/BICC to SIP at O-MGCF + +When creating the SDP Offer the MGCF may initiate ECN negotiation (in accordance with 3GPP TS 26.114 [104]), indicating the capabilities of the IM-MGW (e.g. supported initialisation methods, support of ECN feedback message, and support of ECN XR summary reports). + +NOTE: ECN XR summary reports and RTCP AVPF ECN feedback message are not supported in this release. + +If the MGCF receives the SDP Answer also containing ECN attributes (indicating successful ECN negotiation) then it shall indicate to the IM-MGW that it shall apply the ECN procedures (according to 3GPP TS 26.114 [104]) and act as an ECT endpoint. + +The IM-MGW should not send RTCP XR ECN summary reports. + +##### 9.2.11.1c Detection of ECN failures by IM-MGW + +If the IM-MGW detects an ECN-related error case, for example non-ECT in the received packets when ECT(0) was expected or detecting a very high packet loss rate when ECN is used, the IM-MGW shall notify the MGCF. The MGCF should then initiate a session re-negotiation to disable ECN. + +#### 9.2.11.2 Message sequence chart + +Figure 9.2.11.2.1 shows the message sequence chart example for requesting Explicit Congestion Notification. + +![Sequence diagram showing the procedure to request ECN between MGCF and IM-MGW. The MGCF sends a Context(Cx) message to the IM-MGW with H.248:ADD.req parameters including Termination X, Transport = RTP/AVPF, ECN_enable=True, and {Notify_ECN_Error}. The IM-MGW responds with Context(Cx) and H.248:ADD.resp[Termination X]. The IM-MGW also performs internal actions: Reserve IMS Connection Point and Configure Remote Resources.](1381593e48739f603c81fa60e6b98a6c_img.jpg) + +``` + +sequenceDiagram + participant MGCF + participant IM-MGW + Note right of IM-MGW: Reserve IMS Connection Point and Configure Remote Resources + MGCF->>IM-MGW: Context(Cx) H.248:ADD.req[ Termination X, Transport = RTP/AVPF, ECN_enable=True, {Notify_ECN_Error} ] + IM-MGW-->>MGCF: Context(Cx) H.248:ADD.resp[Termination X] + +``` + +Sequence diagram showing the procedure to request ECN between MGCF and IM-MGW. The MGCF sends a Context(Cx) message to the IM-MGW with H.248:ADD.req parameters including Termination X, Transport = RTP/AVPF, ECN\_enable=True, and {Notify\_ECN\_Error}. The IM-MGW responds with Context(Cx) and H.248:ADD.resp[Termination X]. The IM-MGW also performs internal actions: Reserve IMS Connection Point and Configure Remote Resources. + +**Figure 9.2.11.2.1: Procedure to Request ECN** + +Upon receipt of a request to apply Explicit Congestion Notification the IM-MGW shall set the ECN field of the IP header in accordance with 3GPP TS 26.114 [104] when sending any data packets. + +Upon receipt of any IP headers indicating ECN Congestion Experienced (ECN-CE) the IM-MGW shall trigger rate adaptation in accordance with 3GPP TS 26.114 [104]. + +Figure 9.2.11.2.2 shows the message sequence chart example for an ECN Failure Event. + +![Sequence diagram showing the procedure to report an ECN failure between an MGCF and an IM-MGW. The MGCF sends an H.248:NOTIFY.req(ECN Failure) message to the IM-MGW. The IM-MGW responds with an H.248:NOTIFY.resp(ECN Failure) message. The MGCF then reports the ECN failure to the IM-MGW.](fe7304192caf64cda93b580c5e7e5c06_img.jpg) + +``` + +sequenceDiagram + participant MGCF + participant IM-MGW + Note right of IM-MGW: Report ECN Failure + IM-MGW->>MGCF: H.248:NOTIFY.req(ECN Failure) +[Termination =>x, cause=ecn_cause] + Note left of MGCF: Context(Cx) + MGCF->>IM-MGW: H.248:NOTIFY.resp(ECN Failure) +[Termination x] + Note right of IM-MGW: Context(Cx) + +``` + +Sequence diagram showing the procedure to report an ECN failure between an MGCF and an IM-MGW. The MGCF sends an H.248:NOTIFY.req(ECN Failure) message to the IM-MGW. The IM-MGW responds with an H.248:NOTIFY.resp(ECN Failure) message. The MGCF then reports the ECN failure to the IM-MGW. + +**Figure 9.2.11.2.2: Procedure to Report ECN Failure** + +When the MGCF receives a Notification indicating that a failure has occurred, the MGCF may trigger a new SDP offer to 241salig ECN. + +### 9.2.12 Interactive Connectivity Establishment Support + +#### 9.2.12.1 General + +The MGCF and the IM-MGW may support ICE functionality as specified in IETF RFC 5245 [143] and 3GPP TS 24.229 [9] to support a UE residing behind a remote NAT. The present clause describes the requirements for MGCF and IM-MGW when the ICE procedures are supported. + +Support of full ICE functionality is optional, but if ICE is supported, the MGCF and IM-MGW shall at least support ICE lite as specified in IETF RFC 5245 [143]. + +The MGCF and IM-MGW shall only use host candidates as local ICE candidates. + +NOTE 1: MGCF and IM-MGW are not located behind a NAT (from perspective of the ICE deployment model according to Figure 1 in RFC 5245 [143]). + +When the MGCF detects no ICE parameters in the received SDP, it shall not configure the IM-MGW to apply any ICE and STUN related procedures (see IETF RFC 5389 [144]) toward the call leg from where the SDP has been received. + +Any IM-MGW supporting ICE shall advertise its support of incoming STUN continuity check procedures. An IM-MGW supporting full ICE procedures shall in addition advertise its support for originating STUN connectivity check procedures. + +If the IM-MGW does not indicate the support of STUN procedures, or if the MGCF is configured not to apply ICE toward a call leg, the MGCF shall not configure the IM-MGW to apply STUN procedures. + +#### 9.2.12.2 ICE lite + +If the MGCF is configured to use ICE lite, or supports only ICE lite, or controls an IM-MGW that only support ICE lite, the procedures in the present clause apply. + +If the MGCF receives an initial SDP offer with ICE candidate information but no "a=ice-lite" attribute, the MGCF: + +- shall request the IM-MGW for each media line where it decides to use ICE to reserve an ICE host candidate and provide its address information and a related ICE user name fragment and password; + +NOTE 1: Requesting only one host candidate per m-line prevents that the MGCF will receive "a=remote-candidates" SDP attributes in a subsequent SDP. Requesting separate ufrag and password for each media line simplifies H.248 encoding. + +- shall configure the IM-MGW to act as STUN server at the host candidate address, i.e. to answer STUN connectivity checks; +- may provide received remote ICE candidates and the received related ICE user name fragment and password to the IM-MGW; +- shall include the host candidate and related ICE user name fragment and password received from the IM-MGW in the SDP answer it sends; and +- shall include the "a=ice-lite" attribute in the SDP answer it sends. + +If the MGCF receives SDP offer with ICE candidate information and an "a=ice-lite" attribute, the MGCF shall not apply ICE and shall not include any ICE related SDP attributes in the SDP answer. + +NOTE 2: This avoids that the ICE lite peer needs to send extra SDP offers to complete ICE procedures. + +If the MGCF sends an SDP offer and ICE is to be applied, the MGCF: + +- shall request the IM-MGW to reserve a host candidate for each media line where it decides to use ICE and provide its address information, user name fragment and password; +- shall configure the IM-MGW to act as STUN server at the host candidate address, i.e. to answer STUN connectivity checks; +- shall include the host candidate provided by the IM-MGW and related ICE user name fragment and password in the SDP offer it forwards; and +- shall include the "a=ice-lite" attribute in the SDP offer. + +If the MGCF then receives an SDP answer with candidate information from the call leg where ICE is to be applied, the MGCF may provide received remote ICE candidates and the received related ICE user name fragment and password to the IM-MGW. + +After the initial SDP offer-answer exchange, the MGCF can receive a new offer from the peer that includes updated address and port information in the SDP "c=" line, "m=" line, or "a=rtpc" line SDP attributes. If the ICE user name fragment and password in the SDP offer differ from the ones received in the previous SDP (i.e. the peer restarts ICE), the MGCF shall apply the same procedures as for the initial SDP offer. + +When receiving a request for a host candidate for a media line, the IM-MGW shall allocate one host candidate for that media line and send it to the MGCF within the reply. The IP address and port shall be the same as indicated separately as Local IP Resources. The IM-MGW shall also indicate that it supports ICE lite in the reply. + +When receiving a request for an ICE user name fragment and password, the IM-MGW shall generate an ICE user name fragment and password and send it to the MGCF within the reply. The IM-MGW shall store the password and user name fragment to be able to authenticate incoming STUN binding request according to clause 7.2 of IETF RFC 5245 [143]. + +When receiving a request to act as STUN server, the IM-MGW shall be prepared to answer STUN binding request according to clause 7.2 of IETF RFC 5245 [143]. Once a STUN binding request with the "USE-CANDIDATE" flag has been received, the IM-MGW may send media towards the source of the binding request. + +#### 9.2.12.3 Full ICE + +If the MGCF supports and is configured to use full ICE, and controls an IM-MGW that supports full ICE, the procedures in the present clause apply. + +If the MGCF receives an initial SDP offer with ICE candidate information, the MGCF: + +- shall request the IM-MGW for each media line where it decides to use ICE to reserve an ICE host candidate and provide its address information and a related ICE user name fragment and password; + +NOTE 1: Requesting only one host candidate per m-line prevents that the MGCF will receive "a=remote-candidates" SDP attributes in a subsequent SDP. Requesting separate ufrag and password for each media line simplifies H.248 encoding. + +- shall configure the IM-MGW to act as STUN server at the host candidate address, i.e. to answer STUN connectivity checks; +- shall provide received remote ICE candidates and the received related ICE user name fragment and password to the IM-MGW; +- shall include the host candidate and related ICE user name fragment and password received from the IM-MGW in the SDP answer it sends; +- shall determine the role of MGCF in ICE (controlling or controlled) according to clause 5.2 of IETF RFC 5245 [143]; +- shall configure the IM-MGW to perform connectivity checks in accordance with the determined ICE role; +- shall configure the IM-MGW to report connectivity check results; and +- shall configure the IM-MGW to report a new peer reflexive candidate if discovered during the connectivity check. + +If the MGCF sends an SDP offer and ICE is to be applied, the MGCF: + +- shall request the IM-MGW to reserve a host candidate for each media line where it decides to use ICE and provide its address information, ICE user name fragment and password; +- shall configure the IM-MGW to act as STUN server at the host candidate address, i.e. to answer STUN connectivity checks; and +- shall include the host candidate provided by the IM-MGW and related ICE user name fragment and password in the SDP offer it sends. + +If the MGCF then receives an SDP answer with candidate information from the call leg where ICE is to be applied, the MGCF: + +- shall provide received remote ICE candidates and the received related ICE user name fragment and password to the IM-MGW; +- shall determine the role of MGCF in ICE (controlling or controlled) according to clause 5.2 of IETF RFC 5245 [143]; +- shall configure the IM-MGW to perform connectivity checks in accordance with the determined ICE role; +- shall configure the IM-MGW to report connectivity check results; and +- shall configure the IM-MGW to report a new peer reflexive candidate if discovered during the connectivity check. + +When the MGCF is informed by the IM-MGW about new peer reflexive candidate(s) discovered by the connectivity checks, the MGCF shall configure the IM-MGW to perform additional connectivity checks for those candidates, + +When the MGCF is informed by the IM-MGW about successful candidate pairs determined by the connectivity checks, the MGCF shall send a new SDP offer to its peer with contents according to clause 9.2.2.2 of IETF RFC 5245 [143] if it has the controlling role and the highest-priority candidate pair differs from the default candidates in previous SDP. + +After the initial SDP offer-answer exchange, the MGCF can receive a new offer from the peer that includes updated address and port information in the SDP "c=" line, "m=" line, or "a=rtpc" line SDP attributes. If the ICE user name fragment and password in the SDP offer are the same as received in the previous SDP, the MGCF shall then configure the IM-MGW to send media towards the address and port in the SDP "c=" line, "m=" line. If the STUN user name and password in the SDP offer differ from the ones received in the previous SDP (i.e. the peer restarts ICE), the MGCF shall apply the same procedures as for the initial SDP offer. + +When receiving a request for a host candidate for a media line, the IM-MGW shall allocate one host candidate for that media line and send it to the MGCF within the reply. The IP address and port shall be the same as indicated separately as Local IP Resources. + +When receiving a request for an ICE user name fragment and password, the IM-MGW shall generate an ICE user name fragment and password and send it to the MGCF within the reply. The IM-MGW shall store the password and user name fragment to be able to authenticate incoming STUN binding request according to clause 7.2 of IETF RFC 5245 [143]. + +When receiving a request to act as STUN server, the IM-MGW shall be prepared to answer STUN binding request according to clause 7.2 of IETF RFC 5245 [143]. Once a STUN binding request with the "USE-CANDIDATE" flag has been received, the IM-MGW may send media towards the source of the binding request. + +When receiving a request to perform connectivity checks and to report connectivity check results, the IM-MGW: + +- shall compute ICE candidate pairs according to clause 5.7 of IETF RFC 5245 [143]; +- shall schedule checks for the ICE candidate pairs according to clause 5.8 of IETF RFC 5245 [143]; +- shall send STUN connectivity checks for the scheduled checks according to clause 7.1 of IETF RFC 5245 [143]; +- shall inform the MGCF about successful candidate pairs determined by the connectivity checks; +- shall inform the MGCF about new peer reflexive candidate(s) discovered by the connectivity checks; and +- should send media using the highest priority candidate pair for which connectivity checks have been completed. + +#### 9.2.12.4 Procedures for Interactive Connectivity Establishment (ICE) + +##### 9.2.12.4.1 ICE lite + +Figure 9.2.12.4.1.1 shows a message sequence chart example for performing the ICE lite procedure towards the offerer. + +![Sequence diagram showing the procedure for interactive connectivity establishment using ICE lite towards the offerer. The diagram involves two main participants: MGCF and IM-MGW. The process starts with an INVITE/SDP offer from an external source to the MGCF. The MGCF sends an H.248:ADD.req to the IM-MGW. The IM-MGW responds with H.248:ADD.resp and reserves an IMS Connection Point. The MGCF then sends an INVITE/SDP offer to the IM-MGW, which responds with an SDP Answer. The MGCF sends an H.248:MOD.req to the IM-MGW, which configures the IMS Connection Point and responds with H.248:MOD.resp. The MGCF then sends an H.248:ADD.req to the IM-MGW, which reserves and configures the IMS Connection Point and responds with H.248:ADD.req. Finally, the MGCF sends an SDP Answer to the external source.](17439b945bd5156395c7ba15bf04f8fb_img.jpg) + +``` + +sequenceDiagram + participant External + participant MGCF + participant IM-MGW + + Note left of MGCF: INVITE/SDP offer +["a=candidate rc, +a=ice-pwd rpw, +a=ice-uf rag ruf"] + External->>MGCF: INVITE/SDP offer + MGCF->>IM-MGW: H.248:ADD.req[C=?, T=?, Laddr = ?, Lport = ?, Local Resources] + IM-MGW-->>MGCF: H.248:ADD.resp[C=C1, T=T2] + Note right of IM-MGW: Reserve IMS Connection Point + MGCF->>IM-MGW: INVITE/SDP offer [ ] + IM-MGW-->>MGCF: SDP Answer [ ] + MGCF->>IM-MGW: H.248:MOD.req[C=C1, T=T2] + IM-MGW-->>MGCF: H.248:MOD.resp[C=C1, T=T2] + Note right of IM-MGW: Configure IMS Connection Point + MGCF->>IM-MGW: H.248:ADD.req[C=C1, T=?, STUN server request, Local Resources (Laddr = ?, Lport = ?, ice-pwd=?, ice-uf rag=?; candidate host=?), Remote Resources (candidate rc, ice-pwd rpw, ice-uf rag ruf)] + IM-MGW-->>MGCF: H.248:ADD.req[C=C1, T=T1, Local Resources (Laddr = l1, Lport = p1, ice-pwd=lpw, ice-uf rag=luf; candidate=lc, ice-lite)] + Note right of IM-MGW: Reserve and Configure IMS Connection Point + MGCF->>External: SDP Answer +[a=ice-pwd lpw, +a=ice-uf rag luf, +a=candidate lc, +a=ice-lite] + +``` + +Sequence diagram showing the procedure for interactive connectivity establishment using ICE lite towards the offerer. The diagram involves two main participants: MGCF and IM-MGW. The process starts with an INVITE/SDP offer from an external source to the MGCF. The MGCF sends an H.248:ADD.req to the IM-MGW. The IM-MGW responds with H.248:ADD.resp and reserves an IMS Connection Point. The MGCF then sends an INVITE/SDP offer to the IM-MGW, which responds with an SDP Answer. The MGCF sends an H.248:MOD.req to the IM-MGW, which configures the IMS Connection Point and responds with H.248:MOD.resp. The MGCF then sends an H.248:ADD.req to the IM-MGW, which reserves and configures the IMS Connection Point and responds with H.248:ADD.req. Finally, the MGCF sends an SDP Answer to the external source. + +**Figure 9.2.12.4.1.1: Procedure for interactive connectivity establishment using ICE lite towards the offerer** + +##### 9.2.12.4.2 Full ICE + +Figure 9.2.12.4.2.1 shows a message sequence chart example for performing the full ICE procedure towards the offerer. + +![Sequence diagram for Figure 9.2.12.4.2.1: Procedure for interactive connectivity establishment using full ICE towards the offerer. The diagram shows interactions between an external entity, MGCF, and IM-MGW.](28085f681b9fff76a53c5b8b32338ee1_img.jpg) + +``` + +sequenceDiagram + participant External + participant MGCF + participant IM-MGW + + Note right of IM-MGW: Reserve IMS Connection Point + External->>MGCF: INVITE/SDP offer +["a=candidate rc, +a=ice-pwd rpw, +a=ice-uf rag ruf"] + MGCF->>IM-MGW: H.248:ADD.req[C=?, T=?, Laddr=?, Lport=?, Local Resources] + IM-MGW-->>MGCF: H.248:ADD.resp[C=C1, T=T2] + MGCF->>External: INVITE/SDP offer [] + External-->>MGCF: SDP Answer [] + MGCF->>IM-MGW: H.248:MOD.req[C=C1, T=T2] + IM-MGW-->>MGCF: H.248:MOD.resp[C=C1, T=T2] + Note right of IM-MGW: Configure IMS Connection Point + MGCF->>IM-MGW: H.248:ADD.req[C=C1, T=?, STUN server request, ICE connectivity check {Notify connectivity check result, Notify new peer reflexive candidate}, Local Resources (Laddr=?, Lport=?, ice-pwd=?, ice-uf rag=?, candidate host=?), Remote Resources (candidate rc, ice-pwd rpw, ice-uf rag ruf)] + Note right of IM-MGW: Reserve and Configure IMS Connection Point + MGCF->>IM-MGW: H.248:ADD.req[C=C1, T=T1, Local Resources (Laddr=l1, Lport=p1, ice-pwd=lpw, ice-uf rag=luf; candidate=lc)] + IM-MGW-->>MGCF: + MGCF-->>External: SDP Answer +[a=ice-pwd lpw, +a=ice-uf rag luf, +a=candidate lc,] + +``` + +Sequence diagram for Figure 9.2.12.4.2.1: Procedure for interactive connectivity establishment using full ICE towards the offerer. The diagram shows interactions between an external entity, MGCF, and IM-MGW. + +**Figure 9.2.12.4.2.1: Procedure for interactive connectivity establishment using full ICE towards the offerer** + +##### 9.2.12.4.3 Connectivity check result notification (full ICE) + +Figure 9.2.12.4.3.1 shows the message sequence chart example for an ICE connectivity check result Event. + +![Sequence diagram for Figure 9.2.12.4.3.1: Procedure to report ICE connectivity check result. The diagram shows interactions between Context(Cx), MGCF, and IM-MGW.](30fe9e9487585118063341332e802e98_img.jpg) + +``` + +sequenceDiagram + participant ContextCx1 as Context(Cx) + participant MGCF + participant IM-MGW + participant ContextCx2 as Context(Cx) + + Note right of IM-MGW: ICE Connectivity Check Result Notification + IM-MGW->>ContextCx1: H.248:NOTIFY.Req (ICE connectivity check result) [Termination =x, Candidate/Transport pair] + ContextCx2->>IM-MGW: H.248:NOTIFY.resp (ICE connectivity check result) [Termination x] + +``` + +Sequence diagram for Figure 9.2.12.4.3.1: Procedure to report ICE connectivity check result. The diagram shows interactions between Context(Cx), MGCF, and IM-MGW. + +**Figure 9.2.12.4.3.1: Procedure to report ICE connectivity check result** + +##### 9.2.12.4.4 New peer reflexive candidate notification (full ICE) + +Figure 9.2.12.4.4.1 shows the message sequence chart example for additional connectivity check when new peer reflexive candidate is discovered in full ICE. + +![Sequence diagram showing the procedure to perform additional connectivity check upon the report of new peer reflexive candidate between MGCF and IM-MGW.](848073118eebfdbfdb9a60e3923fe0b3_img.jpg) + +``` + +sequenceDiagram + participant MGCF + participant IM-MGW + Note right of IM-MGW: Additional connectivity check based on new peer reflexive candidate notification + IM-MGW->>MGCF: H.248:NOTIFY.Req (New peer reflexive candidate) [C=Cx, T=Tx, Candidate] + MGCF-->>IM-MGW: H.248:NOTIFY.resp (New peer reflexive candidate) [C=Cx, T=Tx] + MGCF->>IM-MGW: H.248:MODIFY.Req [C=Cx, T=Tx, Additional connectivity check] + IM-MGW-->>MGCF: H.248:MODIFY.resp [C=Cx, T=Tx] + +``` + +Sequence diagram showing the procedure to perform additional connectivity check upon the report of new peer reflexive candidate between MGCF and IM-MGW. + +Figure 9.2.12.4.4.1: Procedure to perform additional connectivity check upon the report of new peer reflexive candidate + +### 9.2.13 Codec Parameters Handling + +#### 9.2.13.1 Handling of common codec parameters + +Table 9.2.13.1.1 describes the MGCF handling of codec related parameters applicable to multiple codecs when the MGCF sends an SDP offer. + +Table 9.2.13.1.1: MGCF handling of common codec parameters when the MGCF acts as SDP offerer + +| Parameter | Handling of common codec parameter in the sent SDP offer | Handling of common codec parameter in the received SDP answer | +|-----------------|----------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ptime (NOTE) | The MGCF may add the parameter with a value according to configured preferences to the SDP offer. | If a ptime parameter is included in the received SDP answer, the MGCF shall supply the parameter to the IM-MGW for the termination towards the answerer in the remote descriptor. | +| maxptime (NOTE) | The MGCF may add the parameter with a value according to the IM-MGW capabilities to the SDP offer. | If a maxptime parameter is included in the received SDP answer, the MGCF shall supply the parameter to the IM-MGW for the termination towards the answerer in the remote descriptor. | + +NOTE 2: This SDP attribute is defined in IETF RFC 4566 [56]. It applies to all codecs offered in an SDP media line. + +When receiving an SDP offer, the MGCF shall handle the codec related parameters applicable to multiple codecs as described in table 9.2.13.1.2. + +**Table 9.2.13.1.2: MGCF handling of common codec parameters when the MGCF acts as SDP answerer** + +| Parameter | Handling of common codec parameter in the received SDP offer | Handling of common codec parameter in the sent SDP answer | +|-------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------| +| ptime (NOTE) | If a ptime parameter is included in the received SDP offer, the MGCF shall supply the parameter to the IM-MGW for the termination towards the offerer in the remote descriptor. | The MGCF may add the parameter with a value according to configured preferences to the SDP answer. | +| maxptime (NOTE) | If a maxptime parameter is included in the received SDP offer, the MGCF shall supply the parameter to the IM-MGW for the termination towards the offerer in the remote descriptor. | The MGCF may add the parameter with a value according to the IM-MGW capabilities to the SDP answer. | +| NOTE: This SDP attribute is defined in IETF RFC 4566 [56]. It applies to all codecs offered in an SDP media line. | | | + +IM-MGW handling of codec related parameters applicable to multiple codecs shall follow table 5.13.1.2 in 3GPP TS 23.334 [145]. + +#### 9.2.13.2 Handling of EVS speech codec parameters when interworking with a different codec + +The Enhanced Voice Services (EVS) speech codec is defined in 3GPP TS 26.441 [146]. Its RTP payload type is defined in 3GPP TS 26.445 [147], and procedures for its usage as IMS Multimedia Telephony speech codec are defined in 3GPP TS 26.114 [104]. + +The MGCF and the IM-MGW may support transcoding to and from the EVS speech codec. If they do so, the procedures in the present clause apply. + +Table 9.2.13.2.1 describes the MGCF handling of EVS codec parameters when the MGCF sends an SDP offer for an EVS payload type, and that EVS payload type is selected in the answer. In addition, rules for the parameter handling in 3GPP TS 26.445 [147] shall apply. + +**Table 9.2.13.2.1: MGCF handling of EVS related SDP parameters when the MGCF adds the EVS payload type to the SDP offer it sends out** + +| Parameter | Handling for EVS payload type added to an SDP offer | Handling if offered EVS payload type is accepted in the SDP answer | +|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| evs-mode-switch (NOTE 1) | If the MGCF expects that interworking between AMR-WB and EVS is required, it shall include the evs-mode-switch with value 1. Otherwise the MGCF shall not include the evs-mode-switch. | If an evs-mode-switch parameter is contained in the SDP answer, the MGCF shall forward this parameter to the IM-MGW for the termination towards the answerer in the remote descriptor. | +| hf-only (NOTE 1) | If the MGCF is configured to negotiate using only the header-full EVS RTP payload format, the MGCF shall include the hf-only parameter with a value 1. | If an hf-only parameter is contained in the SDP answer, the MGCF shall forward this parameter to the IM-MGW in the remote descriptor. | +| dtx (NOTE 1) | If the usage of DTX is not desired in the sending and receiving direction (e.g. due to DTX capabilities of expected codecs to transcode with), the MGCF shall include the dtx parameter with a value 0. | If a dtx parameter is contained in the SDP answer, the MGCF shall forward this parameter to the IM-MGW in the remote descriptor. | +| dtx-recv (NOTE 1) | If receiving DTX is not desired and the dtx parameter is not included, the MGCF shall include the dtx-recv parameter with a value 0.
If both the dtx and dtx-recv parameters are included, those parameters shall have the same value; however, inclusion of the dtx-recv parameter is not required if the dtx parameter is included. | If a dtx-recv parameter is contained in the SDP answer, the MGCF shall forward this parameter to the IM-MGW in the remote descriptor. | +| br (NOTE 1) | If the MGCF desires the same bit rate range for the send and receive direction in EVS primary mode, and wants to restrict the bit rate range to match IM-MGW capabilities and possible configured policies, it shall supply the br parameter in the SDP offer it sends. Otherwise the MGCF shall not include this parameter in the SDP offer.
If the MGCF also supplies the bw, bw-send or bw-recv parameter, the value of the br parameter shall be compatible with the values of those parameters. | If a br parameter is contained in the SDP answer, the MGCF shall forward this parameter to the IM-MGW in the remote descriptor. | +| br-send (NOTE 1) | If the MGCF desires a different bit rate (range) for the send and receive direction in EVS primary mode, and wants to restrict the bit rate range for the send direction to match IM-MGW capabilities and possible configured policies, it shall supply the br-send parameter in the SDP offer it sends. Otherwise the MGCF shall not include this parameter in the SDP offer.
If the MGCF also supplies the bw or bw-send parameter, the value of the br-send parameter shall be compatible with the values of those parameters. | If a br-send parameter is contained in the SDP answer, the MGCF shall forward this parameter to the IM-MGW in the remote descriptor. | +| br-recv (NOTE 1) | If the MGCF desires a different bit rate (range) for the send and receive direction in EVS primary mode, and wants to restrict the bit rate range for the receive direction to match IM-MGW capabilities and possible configured policies, it shall supply the br-recv parameter in the SDP offer it sends. Otherwise the MGCF shall not include this parameter in the SDP offer.
If the MGCF also supplies the bw or bw-recv parameter, the value of the br-recv parameter shall be compatible with the values of those parameters. | If a br-recv parameter is contained in the SDP answer, the MGCF shall forward this parameter to the IM-MGW in the remote descriptor. | + +| | | | +|-----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| bw (NOTE 1) | If the MGCF desires the same sampling bandwidth(s) for the send and receive direction in EVS primary mode, and wants to restrict the sampling bandwidths to match IM-MGW capabilities, sampling bandwidths of expected codecs EVS will be transcoded to, and possible configured policies, it shall supply the bw parameter in the SDP offer it sends. Otherwise the MGCF shall not include this parameter in the SDP offer. | If a bw parameter is contained in the SDP answer, the MGCF shall forward this parameter to the IM-MGW in the remote descriptor. | +| bw-send (NOTE 1) | If the MGCF desires different sampling bandwidths for the send and receive direction in EVS primary mode, and wants to restrict the sampling bandwidths in the send direction to match IM-MGW capabilities, sampling bandwidths of expected codecs EVS will be transcoded to and possible configured policies, it shall supply the bw-send parameter in the SDP offer it sends. Otherwise the MGCF shall not include this parameter in the SDP offer. | If a bw-send parameter is contained in the SDP answer, the MGCF shall forward this parameter to the IM-MGW in the remote descriptor. | +| bw-recv (NOTE 1) | If the MGCF desires different sampling bandwidths for the send and receive direction in EVS primary mode, and wants to restrict the sampling bandwidths in the receive direction to match IM-MGW capabilities, sampling bandwidths of expected codecs EVS will be transcoded to, and possible configured policies, it shall supply the bw-recv parameter in the SDP offer it sends. Otherwise the MGCF shall not include this parameter in the SDP offer. | If a bw-recv parameter is contained in the SDP answer, the MGCF shall forward this parameter to the IM-MGW in the remote descriptor. | +| cmr (NOTE 1) | If the MGCF desires to disable codec mode requests within the RTP payload of the EVS primary mode (due to the IM-MGW capabilities or policies), it shall include the cmr parameter with value -1 in the SDP offer it sends. | If a cmr parameter is contained in the SDP answer, the MGCF shall forward this parameter to the IM-MGW in the remote descriptor. | +| ch-aw-recv (NOTE 1) | The MGCF shall include the ch-aw-recv parameter in the SDP offer if it desires to control the channel-aware-mode of EVS in the receive direction, e.g. to disable it with value -1. The MGCF shall consider the capabilities of the IM-MGW when it chooses an appropriate value. | If a ch-aw-recv parameter is contained in the SDP answer, the MGCF shall forward this parameter to the IM-MGW in the remote descriptor. | +| number of channels (NOTE 2) | The MGCF shall only include the "number of channels" parameter in the SDP offer if it desires to send or receive multiple channels. If the desired number of channels in the send and receive direction differs, the MGCF shall include the higher value. The MGCF should consider the number of channels of expected codecs EVS will be transcoded to. | If a "number of channels" parameter is contained in the SDP answer, the MGCF shall forward this parameter to the IM-MGW in the remote descriptor. | +| ch-send (NOTE 1) | The MGCF shall only include the ch-send parameter in the SDP offer if it desires to send multiple channels, with different numbers of channels in the send and receive direction. The MGCF should consider the number of channels of expected codecs EVS will be interworked with. | If a ch-send parameter is contained in the SDP answer, the MGCF shall forward this parameter to the IM-MGW in the remote descriptor. | + +| | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| ch-recv (NOTE 1) | The MGCF shall only include the ch-recv parameter in the SDP offer if it desires to receive multiple channels, with different numbers of channels in the send and receive direction. The MGCF should consider the number of channels of expected codecs EVS will be interworked with.. | If a ch-recv parameter is contained in the SDP answer, the MGCF shall forward this parameter to the IM-MGW in the remote descriptor. | +| mode-set (NOTE 4) | The MGCF shall only include the mode-set parameter in the SDP offer if it desires to restrict the mode-set of AMR-WB IO mode. The MGCF should only restrict the mode-set if the expected codec EVS will be interworked with is AMR-WB and has a restricted mode set. | If a mode-set parameter is contained in the SDP answer, the MGCF shall forward this parameter to the IM-MGW in the remote descriptor. | +| mode-change-period (NOTE 3) | The MGCF shall only include the mode-change-period parameter with value 2 in the SDP offer if it desires to restrict the mode change period of received packets in AMR-WB IO mode. The MGCF should only restrict the mode-change-period if the expected codec EVS will be interworked with is AMR-WB and has such a restriction. | If a mode-change-period parameter is contained in the SDP answer, the MGCF shall forward this parameter to the IM-MGW in the remote descriptor. | +| mode-change-capability (NOTE 3) | The MGCF shall include the mode-change-capability parameter with value 2 or omit it in the SDP offer. | If a mode-change-capability parameter is contained in the SDP answer, the MGCF may forward this parameter to the IM-MGW in the remote descriptor. | +| mode-change-neighbor (NOTE 3) | The MGCF shall only include the mode-change-neighbor parameter in the SDP offer if it desires to restrict the mode change within received packets of AMR-WB IO mode to neighboring modes. The MGCF should consider the mode-change-neighbor parameter of the expected codec EVS will be interworked with if this is AMR-WB. | If a mode-change-neighbor parameter is contained in the SDP answer, the MGCF shall forward this parameter to the IM-MGW in the remote descriptor. | +| max-red (NOTE 5) | The MGCF shall only include the max-red parameter in the SDP offer if it desires to restrict the maximum redundancy of received packets. MGCF shall consider the capabilities of the IM-MGW, and should consider a max-red parameter of the expected codec EVS will be interworked with if this is AMR-WB. | If a max-red parameter is contained in the SDP answer, the MGCF shall forward this parameter to the IM-MGW in the remote descriptor. | +| 3gpp_mtsi_app_adapt (NOTE 4) | If the IM-MGW supports RTCP APP based adaptation messages defined in TS 26.114 [104], and the MGCF has a policy to negotiate the usage of those messages, the MGCF shall include the 3gpp_mtsi_app_adapt SDP attribute indicating the supported APP messages in the SDP offer. | If a 3gpp_mtsi_app_adapt attribute is contained in the SDP answer, the MGCF shall forward this parameter to the IM-MGW in the remote descriptor. | +| NOTE 1: This MIME parameter of the EVS RTP payload type is defined in TS 26.445 [147]. It is encapsulated within the SDP "a=fmtp" attribute defined IETF RFC 4566 [56]. | | | +| NOTE 2: This number of channels are encoded as "encoding parameters" of the SDP "a=rtpmap" attribute defined in IETF RFC 4566 [56]. | | | +| NOTE 3: This MIME parameter of the EVS RTP payload type relates to AMR-WB IO mode and is defined in IETF RFC 4867 [23]. It is encapsulated within the SDP "a=fmtp" attribute defined IETF RFC 4566 [56]. | | | +| NOTE 4: This SDP attribute is defined in TS 26.114 [104]. It applies to all codecs offered in an SDP media line. However, some values are specific to EVS. | | | +| NOTE 5: This MIME parameter of the EVS RTP payload type is defined in IETF RFC 4867 [23]. It is encapsulated within the SDP "a=fmtp" attribute defined IETF RFC 4566 [56]. | | | + +When receiving an SDP offer that contains an EVS codec payload type, the MGCF shall handle the EVS codec parameters as described in table 9.2.13.2.2. In addition, rules for the parameter handling in 3GPP TS 26.445 [147] shall apply. + +**Table 9.2.13.2.2: MGCF handling of EVS related SDP parameters when the MGCF receives the EVS payload type in an SDP offer** + +| Parameter | Handling of EVS payload type parameter received in the SDP offer | EVS payload type supplied in the SDP answer | +|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| evs-mode-switch (NOTE 1) | If an evs-mode-switch parameter is contained in the SDP offer and the MGCF select the EVS payload type, the MGCF shall forward this parameter to the IM-MGW for the termination towards the offerer in the remote descriptor. | If an evs-mode-switch parameter is contained in the SDP offer, the MGCF shall include the evs-mode-switch parameter with unmodified value in the SDP answer. Otherwise, if the MGCF decides to interwork between AMR-WB and EVS, it shall include the evs-mode-switch with value 1. Otherwise the MGCF shall not include the evs-mode-switch. If the MGCF supplies the evs-mode-switch in the SDP answer, it shall also supply it to the IM-MGW in the local descriptor for the termination towards the offerer with the same value. | +| hf-only (NOTE 1) | If an hf-only parameter is contained in the SDP offer and the MGCF select the EVS payload type, the MGCF shall forward this parameter to the IM-MGW for the termination towards the offerer in the remote descriptor. | If an hf-only parameter is contained in the SDP offer, the MGCF shall include the hf-only parameter with unmodified value in the SDP answer. Otherwise, if the MGCF is configured to negotiate using only the header-full EVS RTP payload format, the MGCF shall include the hf-only parameter with a value 1. If the MGCF supplies the hf-only parameter in the SDP answer, it shall also supply it to the IM-MGW in the local descriptor for the termination towards the offerer with the same value. | +| dtx (NOTE 1) | If a dtx parameter is contained in the SDP offer and the MGCF select the EVS payload type, the MGCF shall forward this parameter to the IM-MGW for the termination towards the offerer in the remote descriptor. | If a dtx parameter is contained in the SDP offer, the MGCF shall include the dtx parameter with unmodified value in the SDP answer. If the dtx parameter is not contained in the SDP offer and if a dtx-recv parameter is contained in the SDP offer, the MGCF may include the dtx parameter in the SDP answer , and the value of the dtx parameter shall then be identical to that of the dtx-recv parameter in the SDP offer (e.g, if that value matches DTX capabilities of expected codecs to transcode with). If the dtx parameter is not contained in the SDP offer and if the dtx-recv parameter is not contained in the SDP offer, and if the usage of DTX is not desired (e.g. due to DTX capabilities of expected codecs to transcode with), the MGCF shall include in the SDP answer the dtx parameter with a value 0. If the MGCF supplies the dtx parameter in the SDP answer, it shall also supply it to the IM-MGW in the local descriptor for the termination towards the offerer with the same value. | + +| | | | +|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| dtx-recv (NOTE 1) |

If a dtx-recv parameter is contained in the SDP offer and the MGCF select the EVS payload type, the MGCF shall forward this parameter to the IM-MGW for the termination towards the offerer in the remote descriptor.

|

If no dtx parameter is included in the SDP answer and if the reception of DTX is not desired, the MGCF shall include in the SDP answer the dtx-recv parameter with a value 0.

If both the dtx and dtx-recv parameters are included, those parameters shall have the same value; however, inclusion of the dtx-recv parameter is not required if the dtx parameter is included.

If the MGCF supplies the dtx-recv parameter in the SDP answer, it should also supply it to the IM-MGW in the local descriptor for the termination towards the offerer with the same value.

| +| br (NOTE 1) |

If a br parameter is contained in the SDP offer, the MGCF shall check if the IM-MGW supports the indicated bit rates, or a subset of them, in EVS primary mode in the send and receive direction. If the indicated bit rates, and even each subset of them, are not supported, the MGCF shall not select the EVS payload type. If the MGCF selects the EVS payload type, it shall forward this parameter to the IM-MGW for the termination towards the offerer in the remote descriptor.

|

If a br parameter is contained in the SDP offer, the MGCF shall select a bit rate value, which is either the received br value or a subset of it, based on IM-MGW capabilities and possible configured policies, and shall include the br parameter with the selected value that is also supplied towards the IM-MGW in the SDP answer. Otherwise, if the MGCF desires the same bit rate range for the send and receive direction in EVS primary mode, and wants to restrict the bit rate range to match IM-MGW capabilities and possible configured policies, the MGCF shall supply the br parameter in the SDP answer it sends. Otherwise the MGCF shall not include this parameter in the SDP answer.

If the MGCF also supplies the bw, bw-send or bw-recv parameter, the value of the br parameter shall be compatible with the values of those parameters.

If the MGCF supplies the br parameter in the SDP answer, it shall also supply to the IM-MGW the br parameter in the local descriptor for the termination towards the offerer with the same value.

| + +| | | | +|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| br-send (NOTE 1) |

If a br-send parameter is contained in the SDP offer, the MGCF shall check if the IM-MGW supports the indicated bit rates, or a subset of them, in EVS primary mode in the receive direction. If the indicated bit rates, and even each subset of them, are not supported, the MGCF shall not select the EVS payload type. If the MGCF selects the EVS payload type, it shall forward this parameter to the IM-MGW for the termination towards the offerer in the remote descriptor.

|

If a br-recv parameter is contained in the SDP offer, the MGCF shall select a bit rate value, which is either the received br-recv value or a subset of it, based on IM-MGW capabilities and possible configured policies, and the MGCF shall include the br-send parameter with the selected value that is also supplied towards the IM-MGW in the SDP answer.

Otherwise, if the MGCF desires a different bit rate (range) for the send and receive direction in EVS primary mode, and wants to restrict the bit rate range for the send direction to match IM-MGW capabilities and possible configured policies, it shall supply the br-send parameter in the SDP answer it sends.

Otherwise the MGCF shall not include the br-send parameter in the SDP answer.

If the MGCF also supplies the bw or bw-send parameter, the value of the br-send parameter shall be compatible with the values of those parameters.

If the MGCF supplies the br-send parameter in the SDP answer, it shall also supply to the IM-MGW the br-send parameter in the local descriptor for the termination towards the offerer with the same value.

| +| br-recv (NOTE 1) |

If a br-recv parameter is contained in the SDP offer, the MGCF shall check if the IM-MGW supports the indicated bit rates, or a subset of them, in EVS primary mode in the send direction. If the indicated bit rates, and even each subset of them, are not supported, the MGCF shall not select the EVS payload type. If the MGCF selects the EVS payload type, it shall forward this parameter to the IM-MGW for the termination towards the offerer in the remote descriptor.

|

If a br-send parameter is contained in the SDP offer, the MGCF shall select a bit rate value, which is either the received br-send value or a subset of it, based on IM-MGW capabilities and possible configured policies, and the MGCF shall include the br-recv parameter with the selected value that is also supplied towards the IM-MGW in the SDP answer.

Otherwise, if the MGCF desires a different bit rate (range) for the send and receive direction in EVS primary mode, and wants to restrict the bit rate range for the receive direction to match IM-MGW capabilities and possible configured policies, it shall supply the br-recv parameter in the SDP answer it sends.

Otherwise the MGCF shall not include the br-recv parameter in the answer.

If the MGCF also supplies the bw or bw-recv parameter, the value of the br-recv parameter shall be compatible with the values of those parameters.

If the MGCF supplies the br-recv parameter in the SDP answer, it shall also supply to the IM-MGW the br-recv parameter in the local descriptor for the termination towards the offerer with the same value.

| + +| | | | +|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| bw (NOTE 1) |

If a bw parameter is contained in the SDP offer, the MGCF shall check if the IM-MGW supports the indicated sampling bandwidth(s), or a subset of them, in EVS primary mode in the send and receive direction. If the indicated sampling bandwidth(s), and even each subset of them, are not supported, the MGCF shall not select the EVS payload type. If the MGCF selects the EVS payload type, it shall forward this parameter to the IM-MGW for the termination towards the offerer in the remote descriptor.

|

If a bw parameter is contained in the SDP offer, the MGCF shall select a sampling bandwidth value, which is either the received bw value or a subset of it, based on IM-MGW capabilities, possible configured policies, and the bw range of other codecs to transcode with, and the MGCF shall include the bw parameter with the selected value that is also supplied towards the IM-MGW in the SDP answer. Otherwise, if the MGCF desires the same sampling bandwidth(s) for the send and receive direction in EVS primary mode, and wants to restrict the sampling bandwidth(s) to match IM-MGW capabilities, possible configured policies, and the bw range of other codecs to transcode with, the MGCF shall supply the bw parameter in the SDP answer it sends. Otherwise the MGCF shall not include this parameter in the answer. If the MGCF also supplies the br, br-send or br-recv parameter, the value of the bw parameter shall be compatible with the values of those parameters. If the MGCF supplies the bw parameter in the SDP answer, it shall also supply to the IM-MGW the bw parameter in the local descriptor for the termination towards the offerer with the same value.

| +| bw-send (NOTE 1) |

If a bw-send parameter is contained in the SDP offer, the MGCF shall check if the IM-MGW supports the indicated sampling bandwidths, or a subset of them, in EVS primary mode in the receive direction. If the indicated sampling bandwidths, and even each subset of them, are not supported, the MGCF shall not select the EVS payload type. If the MGCF selects the EVS payload type, it shall forward this parameter to the IM-MGW for the termination towards the offerer in the remote descriptor.

|

If a bw-recv parameter is contained in the SDP offer, the MGCF shall select a sampling bandwidths value, which is either the received bw-recv value or a subset of it, based on IM-MGW capabilities, possible configured policies, and the bw range of other codecs to transcode with, and the MGCF shall include the bw-send parameter with the selected value in the SDP answer. Otherwise, if the MGCF desires a different sampling bandwidths for the send and receive direction in EVS primary mode, and wants to restrict the sampling bandwidths for the send direction to match IM-MGW capabilities, possible configured policies, and the bw range of other codecs to transcode with, the MGCF shall supply the bw-send parameter in the SDP answer it sends. Otherwise the MGCF shall not include the br-send parameter in the SDP answer. If the MGCF also supplies the bw or bw-send parameter, the value of the br-send parameter shall be compatible with the values of those parameters. If the MGCF supplies the bw-send parameter in the SDP answer, it shall also supply to the IM-MGW the bw-send parameter in the local descriptor for the termination towards the offerer with the same value.

| + +| | | | +|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| bw-recv (NOTE 1) |

If a br-recv parameter is contained in the SDP offer, the MGCF shall check if the IM-MGW supports the indicated sampling bandwidths, or a subset of them, in EVS primary mode in the send direction. If the indicated sampling bandwidths, and even each subset of them, are not supported, the MGCF shall not select the EVS payload type. If the MGCF selects the EVS payload type, it shall forward the bw-recv parameter to the IM-MGW for the termination towards the offerer in the remote descriptor.

|

If a bw-send parameter is contained in the SDP offer, the MGCF shall select a sampling bandwidths value, which is either the received bw-send value or a subset of it, based on IM-MGW capabilities, possible configured policies, and the bw range of other codecs to transcode with, and the MGCF shall include the bw-recv parameter with the selected value in the SDP answer. Otherwise, if the MGCF desires a different sampling bandwidths for the send and receive direction in EVS primary mode, and wants to restrict the sampling bandwidths for the receive direction to match IM-MGW capabilities, possible configured policies, and the bw range of other codecs to transcode with, the MGCF shall supply the bw-recv parameter in the SDP answer it sends. Otherwise the MGCF shall not include the bw-recv parameter in the SDP answer. If the MGCF also supplies the br or br-recv parameter, the value of the bw-recv parameter shall be compatible with the values of those parameters. If the MGCF supplies the bw-send parameter in the SDP answer, it shall also supply it to the IM-MGW in the local descriptor for the termination towards the offerer with the same value.

| +| cmr (NOTE 1) |

If a cmr parameter is contained in the SDP offer and the MGCF select the EVS payload type, the MGCF shall forward this parameter to the IM-MGW for the termination towards the offerer in the remote descriptor.

|

If a cmr parameter is contained in the SDP offer, the MGCF shall include the cmr parameter with unmodified value in the SDP answer. Otherwise, if the IM-MGW desires to disable codec mode requests within the RTP payload of the EVS primary mode (due to the IM-MGW capabilities and possible configured policies), it shall include the cmr parameter with value -1 in the SDP answer it sends. If the MGCF supplies the cmr parameter in the SDP answer, it shall also supply it to the IM-MGW in the local descriptor for the termination towards the offerer with the same value.

| +| ch-aw-recv (NOTE 1) |

If a ch-aw-recv parameter is contained in the SDP offer the MGCF shall check if the IM-MGW supports the indicated mode in the send direction. If the indicated mode is not supported, the MGCF shall not select the EVS payload type. If the MGCF selects the EVS payload type, the MGCF shall forward this parameter to the IM-MGW for the termination towards the offerer in the remote descriptor.

|

If the MGCF it desires to control the channel-aware mode of EVS in the receive direction, e.g. to disable it with value -1, it shall include the ch-aw-recv parameter in the SDP offer and shall also supply the ch-aw-recv parameter to the IM-MGW in the local descriptor for the termination towards the offerer with the same value. The MGCF shall consider the capabilities of the IM-MGW when it chooses an appropriate value.

| + +| | | | +|---------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| number of channels (NOTE 2) | If a "number of channels" parameter is contained in the SDP offer the MGCF shall check if the IM-MGW supports the indicated number of channels. If the indicated number of channels is not supported, the MGCF shall not select the EVS payload type. If the MGCF selects the EVS payload type, the MGCF shall forward this parameter to the IM-MGW for the termination towards the offerer in the remote descriptor. | If a "number of channels" parameter is contained in the SDP offer, the MGCF shall include the "number of channels" parameter with unmodified value in the SDP answer and shall also supply it to the IM-MGW in the local descriptor for the termination towards the offerer with the same value. | +| ch-send (NOTE 1) | If a ch-send parameter is contained in the SDP offer the MGCF shall check if the IM-MGW supports the indicated number of channels in the receive direction. If the indicated number of channels is not supported, the MGCF shall not select the EVS payload type. If the MGCF selects the EVS payload type, the MGCF shall forward the ch-send parameter to the IM-MGW for the termination towards the offerer in the remote descriptor. | If a ch-recv parameter is contained in the SDP offer, the MGCF shall include the ch-send parameter with unmodified value in the SDP answer and shall also supply the ch-send parameter to the IM-MGW in the local descriptor for the termination towards the offerer with the same value. | +| ch-recv (NOTE 1) | If a ch-recv parameter is contained in the SDP offer the MGCF shall check if the IM-MGW supports the indicated number of channels in the send direction. If the indicated number of channels is not supported, the MGCF shall not select the EVS payload type. If the MGCF selects the EVS payload type for transcoding, the MGCF shall forward the ch-recv parameter to the IM-MGW for the termination towards the offerer in the remote descriptor. | If a ch-send parameter is contained in the SDP offer, the MGCF shall include the ch-recv parameter with unmodified value in the SDP answer and shall also supply the ch-recv parameter to the IM-MGW in the local descriptor for the termination towards the offerer with the same value. | +| mode-set (NOTE 3) | If a mode-set parameter is contained in the SDP offer and the MGCF select the EVS payload type, the MGCF shall forward this parameter to the IM-MGW for the termination towards the offerer in the remote descriptor. | If a mode-set parameter is contained in the SDP offer, the MGCF shall include the mode-set parameter with unmodified value in the SDP answer.
Otherwise, if AMR-WB is used to interwork with, the MGCF should include the mode-set parameter with a value indicating the mode that was negotiated for AMR-WB (or omit it if no restrictions applied before).
If the MGCF supplies the mode-set parameter in the SDP answer, it shall also supply it to the IM-MGW in the local descriptor for the termination towards the offerer with the same value. | +| mode-change-period (NOTE 3) | If a mode-change-period parameter is contained in the SDP offer and the MGCF select the EVS payload type, the MGCF shall forward this parameter to the IM-MGW for the termination towards the offerer in the remote descriptor. | If AMR-WB is used to interwork with, the MGCF should include the mode-change-period parameter with a value indicating the mode that was negotiated for AMR-WB (or omit it if no restrictions applied before) in the SDP answer.
If the MGCF supplies the mode-change-period parameter in the SDP answer, it shall also supply it to the IM-MGW in the local descriptor for the termination towards the offerer with the same value. | +| mode-change-capability (NOTE 3) | If a mode-change-capability (Note 4) parameter is contained in the SDP offer and the MGCF select the EVS payload type, the MGCF may forward this parameter to the IM-MGW for the termination towards the offerer in the remote descriptor. | If the MGCF selects the EVS payload type, the MGCF shall include the mode-change-capability parameter with value 2 or omit it in the SDP answer.
If the MGCF supplies the mode-change-capability parameter in the SDP answer, it may also supply it to the IM-MGW in the local descriptor for the termination towards the offerer with the same value. | + +| | | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| mode-change-neighbor (NOTE 3) | If a mode-change-neighbor parameter is contained in the SDP offer and the MGCF select the EVS payload type, the MGCF shall forward this parameter to the IM-MGW for the termination towards the offerer in the remote descriptor. | If AMR-WB is used to interwork with, the MGCF should include the mode-change-neighbor parameter with a value indicating the mode that was negotiated for AMR-WB (or omit it if no restrictions applied before) in the SDP answer.
If the MGCF supplies the mode-change-neighbor parameter in the SDP answer, it shall also supply it to the IM-MGW in the local descriptor for the termination towards the offerer with the same value. | +| max-red (NOTE 5) | If a max-red parameter is contained in the SDP offer and the MGCF select the EVS payload type, the MGCF shall forward this parameter to the IM-MGW for the termination towards the offerer in the remote descriptor. | The MGCF shall only include the max-red parameter in the SDP answer if it desires to restrict the maximum redundancy of received packets. When selecting the value of the max-red parameter, the MGCF shall consider the capabilities of the IM-MGW.
If the MGCF supplies the max-red parameter in the SDP answer, it shall also supply it to the IM-MGW in the local descriptor for the termination towards the offerer with the same value. | +| 3gpp_mtsi_app_adapt (NOTE 4) | If a 3gpp_mtsi_app_adapt SDP attribute is contained in the SDP answer, and the MGCF select the EVS payload type, the MGCF shall forward this parameter to the IM-MGW the MGCF shall forward this parameter to the IM-MGW in the remote descriptor. | If the IM-MGW supports RTCP APP based adaptation messages defined in TS 26.114 [104], and the MGCF has a policy to negotiate the usage of those messages, the MGCF shall include the 3gpp_mtsi_app_adapt SDP attribute indicating the allowed APP messages in the SDP answer. | +| NOTE 1: This MIME parameter of the EVS RTP payload type is defined in TS 26.445 [147]. It is encapsulated within the SDP "a=fmtp" attribute defined IETF RFC 4566 [56].
NOTE 2: This number of channels are encoded as "encoding parameters" of the SDP "a=rtpmap" attribute defined in IETF RFC 4566 [56].
NOTE 3: This MIME parameter of the EVS RTP payload type relates to AMR-WB IO mode and is defined in IETF RFC 4867 [23]. It is encapsulated within the SDP "a=fmtp" attribute defined IETF RFC 4566 [56].
NOTE 4: This SDP attribute is defined in TS 26.114 [104]. It applies to all codecs offered in an SDP media line. However, some values are specific to EVS.
NOTE 5: This MIME parameter of the EVS RTP payload type is defined in IETF RFC 4867 [23]. It is encapsulated within the SDP "a=fmtp" attribute defined IETF RFC 4566 [56]. | | | + +IM-MGW handling of EVS codec parameters shall follow table 5.13.2.3 in 3GPP TS 23.334 [145]. The IM-MGW should support transcoding of EVS with bandwidths (sampling rates) which are supported by codec the IM-MGW is capable to transcode EVS to/from (e.g. NB for AMR, and WB for AMR-WB). + +#### 9.2.13.3 Handling of EVS speech codec parameters when the EVS codec is used end-to-end + +The procedures in the present clause apply when the EVS speech codec is used in both IMS and the CS domain. + +The four allowed EVS codec configurations for the CS domain are specified in 3GPP TS 26.103 [57]. + +Table 9.2.13.3.1 describes the MGCF handling of EVS codec parameters when the MGCF sends an SDP offer for an EVS payload type, which is supported in the CS network, and that EVS payload type is selected in the SDP answer. In addition, rules for the parameter handling in 3GPP TS 26.445 [147] shall apply. + +**Table 9.2.13.3.1: MGCF handling of EVS related SDP parameters when the MGCF acts as SDP offerer** + +| Parameter | Handling of EVS codec parameter in the sent SDP offer | Handling of EVS codec parameter in the received SDP answer | +|--------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| evs-mode-switch (NOTE 1) | The MGCF shall not include the evs-mode-switch parameter in the SDP offer. | If an evs-mode-switch parameter is contained in the SDP answer, the MGCF shall forward this parameter to the IM-MGW for the termination towards the answerer in the remote descriptor. | +| hf-only (NOTE 1) | If the MGCF is configured to negotiate using only the header-full EVS RTP payload format, the MGCF shall include the hf-only parameter with a value of 1 in the SDP offer.
Using only the header-full EVS RTP payload format is recommended. | If an hf-only parameter is contained in the SDP answer, the MGCF shall forward this parameter to the IM-MGW in the remote descriptor. | +| dtx (NOTE 1) | The MGCF shall include the dtx parameter in the SDP offer and shall set it to 1 i.e. DTX enabled. | If a dtx parameter is contained in the SDP answer, the MGCF shall forward this parameter to the IM-MGW in the remote descriptor. | +| dtx-recv (NOTE 1) | The MGCF shall include the dtx-recv parameter in the SDP offer and shall set it to 1 i.e. DTX enabled. | If a dtx-recv parameter is contained in the SDP answer, the MGCF shall forward this parameter to the IM-MGW in the remote descriptor. | +| br (NOTE 1) | The MGCF shall include the br parameter in the SDP offer and shall set it to a range corresponding to the CS configuration received in the Single Codec IE (see subclause B.2.5.5). | If a br parameter is contained in the SDP answer, the MGCF shall forward this parameter to the IM-MGW in the remote descriptor. | +| br-send (NOTE 1) | The MGCF shall not include the br-send parameter in the SDP Offer. | If a br-send parameter is contained in the SDP answer, the MGCF shall forward this parameter to the IM-MGW in the remote descriptor. | +| br-recv (NOTE 1) | The MGCF shall not include the br-recv parameter in the SDP Offer. | If a br-recv parameter is contained in the SDP answer, the MGCF shall forward this parameter to the IM-MGW in the remote descriptor. | +| bw (NOTE 1) | The MGCF shall include the bw parameter in the SDP offer and shall set it to a range corresponding to the CS configuration received in the Single Codec IE (see subclause B.2.5.5). | If a bw parameter is contained in the SDP answer, the MGCF shall forward this parameter to the IM-MGW in the remote descriptor. | +| bw-send (NOTE 1) | The MGCF shall not include the bw-send parameter in the SDP Offer. | If a bw-send parameter is contained in the SDP answer, the MGCF shall forward this parameter to the IM-MGW in the remote descriptor. | +| bw-recv (NOTE 1) | The MGCF shall not include the bw-recv parameter in the SDP Offer. | If a bw-recv parameter is contained in the SDP answer, the MGCF shall forward this parameter to the IM-MGW in the remote descriptor. | +| cmr (NOTE 1) | If the MGCF desires to disable codec mode requests on Mb within the RTP payload of the EVS primary mode (due to the IM-MGW capabilities or policies) and desires to use RTCP-APP instead for codec mode request, then it shall include the cmr parameter with a value of -1 in the SDP offer.
Otherwise, the MGCF shall include the cmr parameter with a value of 1 in the SDP offer in order to request EVS-CMR in every RTP packet.
The use of code mode requests on Mb within the RTP payload of the EVS primary mode is recommended. | If a cmr parameter is contained in the SDP answer, the MGCF shall forward this parameter to the IM-MGW in the remote descriptor. | + +| | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| ch-aw-recv (NOTE 1) | The MGCF shall include the ch-aw-recv parameter in the SDP offer and shall set it to an allowed value for the CS configuration received in the Single Codec IE (see subclause B.2.5.5). | If a ch-aw-recv parameter is contained in the SDP answer, the MGCF shall forward this parameter to the IM-MGW in the remote descriptor. | +| number of channels (NOTE 2) | The MGCF shall include the number of channels parameter with a value of 1 in the SDP offer. | If a "number of channels" parameter is contained in the SDP answer, the MGCF shall forward this parameter to the IM-MGW in the remote descriptor. | +| ch-send (NOTE 1) | The MGCF shall not include the ch-send parameter in the SDP offer. | If a ch-send parameter is contained in the SDP answer, the MGCF shall forward this parameter to the IM-MGW in the remote descriptor. | +| ch-recv (NOTE 1) | The MGCF shall not include the ch-recv parameter in the SDP offer. | If a ch-recv parameter is contained in the SDP answer, the MGCF shall forward this parameter to the IM-MGW in the remote descriptor. | +| mode-set (NOTE 4) | The MGCF shall include the mode-set parameter in the SDP offer and shall set it as per the received Single Codec IE (see subclause B.2.5.5). | If a mode-set parameter is contained in the SDP answer, the MGCF shall forward this parameter to the IM-MGW in the remote descriptor. | +| mode-change-period (NOTE 3) | The MGCF shall include the mode-change-period parameter in the SDP offer and shall set it to 2. | If a mode-change-period parameter is contained in the SDP answer, the MGCF shall forward this parameter to the IM-MGW in the remote descriptor. | +| mode-change-capability (NOTE 3) | The MGCF shall either include the mode-change-capability parameter with a value of 2 or omit it in the SDP offer. | If a mode-change-capability parameter is contained in the SDP answer, the MGCF may forward this parameter to the IM-MGW in the remote descriptor. | +| mode-change-neighbor (NOTE 3) | The MGCF shall include the mode-change-neighbor parameter in the SDP offer and shall set it to 1. | If a mode-change-neighbor parameter is contained in the SDP answer, the MGCF shall forward this parameter to the IM-MGW in the remote descriptor. | +| max-red (NOTE 5) | The MGCF shall not include the max-red parameter in the SDP offer. | If a max-red parameter is contained in the SDP answer, the MGCF shall forward this parameter to the IM-MGW in the remote descriptor. (NOTE 6) | +| 3gpp_mtsi_app_adapt (NOTE 4) | If the IM-MGW supports RTCP APP based adaptation messages defined in TS 26.114 [104], and the MGCF has a policy to negotiate the usage of those messages, the MGCF shall include the 3gpp_mtsi_app_adapt SDP attribute indicating the supported APP messages in the SDP offer. | If a 3gpp_mtsi_app_adapt attribute is contained in the SDP answer, the MGCF shall forward this parameter to the IM-MGW in the remote descriptor. | +| NOTE 1: This MIME parameter of the EVS RTP payload type is defined in TS 26.445 [147]. It is encapsulated within the SDP "a=fmtp" attribute defined IETF RFC 4566 [56]. | | | +| NOTE 2: This number of channels is encoded as "encoding parameters" of the SDP "a=rtpmap" attribute defined in IETF RFC 4566 [56]. | | | +| NOTE 3: This MIME parameter of the EVS RTP payload type relates to the EVS AMR-WB IO major operation mode and is defined in IETF RFC 4867 [23]. It is encapsulated within the SDP "a=fmtp" attribute defined IETF RFC 4566 [56]. | | | +| NOTE 4: This SDP attribute is defined in TS 26.114 [104]. It applies to all codecs offered in an SDP media line. However, some values are specific to EVS. | | | +| NOTE 5: This MIME parameter of the EVS RTP payload type is defined in IETF RFC 4867 [23]. It is encapsulated within the SDP "a=fmtp" attribute defined IETF RFC 4566 [56]. | | | +| NOTE 6: RTP redundancy is only applicable on the Mb interface. In such a case, the IM-MGW performs repacking. Transcoding is not required. | | | + +When receiving an SDP offer that contains an EVS codec payload type, the MGCF shall handle the EVS codec parameters as described in table 9.2.13.3.2. In addition, rules for the parameter handling in 3GPP TS 26.445 [147] shall apply. + +**Table 9.2.13.3.2: MGCF handling of EVS codec SDP parameters when the MGCF acts as SDP answerer** + +| Parameter | Handling of EVS codec parameter in the received SDP offer | Handling of EVS codec parameter in the sent SDP answer | +|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| evs-mode-switch (NOTE 1) | If an evs-mode-switch parameter is contained in the SDP offer and the MGCF select the EVS payload type, the MGCF shall forward this parameter to the IM-MGW for the termination towards the offerer in the remote descriptor. (NOTE 6) | If an evs-mode-switch parameter is contained in the SDP offer, the MGCF shall include the evs-mode-switch parameter with unmodified value in the SDP answer. Otherwise the MGCF shall not include the evs-mode-switch parameter. | +| hf-only (NOTE 1) | If an hf-only parameter is contained in the SDP offer, the MGCF shall forward this parameter to the IM-MGW for the termination towards the offerer in the remote descriptor. | If an hf-only parameter is contained in the SDP offer, the MGCF shall include the hf-only parameter with unmodified value in the SDP answer. Otherwise, if the hf-only parameter is not contained in the SDP offer and if the MGCF is configured to negotiate using only the header-full EVS RTP payload format, then the MGCF shall include the hf-only parameter with a value of 1. If the MGCF supplies the hf-only parameter in the SDP answer, it shall also supply it to the IM-MGW in the local descriptor for the termination towards the offerer. | +| dtx (NOTE 1) | If a dtx parameter is contained in the SDP offer and the MGCF select the EVS payload type, the MGCF shall forward this parameter to the IM-MGW for the termination towards the offerer in the remote descriptor. | If a dtx parameter is not contained in the SDP offer and a dtx-recv parameter is not contained in the SDP offer, the MGCF shall include the dtx parameter with a value of 1 in the SDP answer. If a dtx parameter is not contained in the SDP offer and a dtx-recv parameter is contained in the SDP offer with a value of 1, the MGCF shall include the dtx parameter in the SDP answer with a value identical to that of the dtx-recv parameter in the SDP offer. If a dtx parameter is contained in the SDP offer, the MGCF shall include the dtx parameter with unmodified value in the SDP answer. The MGCF shall also supply the dtx parameter to the IM-MGW in the local descriptor for the termination towards the offerer with the same value. | +| dtx-recv (NOTE 1) | If a dtx-recv parameter is contained in the SDP offer and the MGCF select the EVS payload type, the MGCF shall forward this parameter to the IM-MGW for the termination towards the offerer in the remote descriptor. | If no dtx parameter is included in the SDP answer, the MGCF may include the dtx-recv parameter with a value of 1 in the SDP answer. The MGCF should also supply the dtx-recv parameter to the IM-MGW in the local descriptor for the termination towards the offerer with the same value. | + +| | | | +|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| br (NOTE 1) |

If a br parameter is contained in the SDP offer, the MGCF shall check if the IM-MGW supports the indicated bit rates, or a subset of them, in EVS primary mode in the send and receive direction. If the indicated bit rates, and even each subset of them, are not supported, the MGCF shall not select the EVS payload type. If the MGCF selects the EVS payload type, it shall forward this parameter to the IM-MGW for the termination towards the offerer in the remote descriptor.

|

If a br parameter is contained in the SDP offer, the MGCF shall select a bit rate value, which is either the received br value or a subset of it, based on IM-MGW capabilities, possible configured policies and the CS configuration received Single Codec IE (see subclause B.2.5.5), and shall include the br parameter with the selected value that is also supplied towards the IM-MGW in the SDP answer. Otherwise, the MGCF shall include the br parameter in the SDP answer and shall set it to a range corresponding to the CS configuration received in the Single Codec IE (see subclause B.2.5.5). If the MGCF also supplies the bw, bw-send or bw-recv parameter, the value of the br parameter shall be compatible with the values of those parameters. The MGCF shall also supply the br parameter to the IM-MGW in the local descriptor for the termination towards the offerer with the same value.

| +| br-send (NOTE 1) |

If a br-send parameter is contained in the SDP offer, the MGCF shall check if the IM-MGW supports the indicated bit rates, or a subset of them, in EVS primary mode in the receive direction. If the indicated bit rates, and even each subset of them, are not supported, the MGCF shall not select the EVS payload type. If the MGCF selects the EVS payload type, it shall forward this parameter to the IM-MGW for the termination towards the offerer in the remote descriptor.

|

If a br-recv parameter is contained in the SDP offer, the MGCF shall select a bit rate value, which is either the received br-recv value or a subset of it, based on IM-MGW capabilities, possible configured policies and the br parameter value included in the SDP answer, and the MGCF shall include the br-send parameter with the selected value that is also supplied towards the IM-MGW in the SDP answer. Otherwise the MGCF shall not include the br-send parameter in the SDP answer. If the MGCF also supplies the bw or bw-send parameter, the value of the br-send parameter shall be compatible with the values of those parameters.

| +| br-recv (NOTE 1) |

If a br-recv parameter is contained in the SDP offer, the MGCF shall check if the IM-MGW supports the indicated bit rates, or a subset of them, in EVS primary mode in the send direction. If the indicated bit rates, and even each subset of them, are not supported, the MGCF shall not select the EVS payload type. If the MGCF selects the EVS payload type, it shall forward this parameter to the IM-MGW for the termination towards the offerer in the remote descriptor.

|

If a br-send parameter is contained in the SDP offer, the MGCF shall select a bit rate value, which is either the received br-send value or a subset of it, based on IM-MGW capabilities, possible configured policies and the br parameter value included in the SDP answer, and the MGCF shall include the br-recv parameter with the selected value that is also supplied towards the IM-MGW in the SDP answer. Otherwise the MGCF shall not include the br-recv parameter in the answer. If the MGCF also supplies the bw or bw-recv parameter, the value of the br-recv parameter shall be compatible with the values of those parameters. If the MGCF supplies the br-recv parameter in the SDP answer, it shall also supply to the IM-MGW the br-recv parameter in the local descriptor for the termination towards the offerer with the same value.

| + +| | | | +|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| bw (NOTE 1) | If a bw parameter is contained in the SDP offer, the MGCF shall check if the IM-MGW supports the indicated sampling bandwidth(s), or a subset of them, in EVS primary mode in the send and receive direction. If the indicated sampling bandwidth(s), and even each subset of them, are not supported, the MGCF shall not select the EVS payload type. If the MGCF selects the EVS payload type, it shall forward this parameter to the IM-MGW for the termination towards the offerer in the remote descriptor. | If a bw parameter is contained in the SDP offer, the MGCF shall select a sampling bandwidth value, which is either the received bw value or a subset of it, based on IM-MGW capabilities, possible configured policies and the CS configuration received in the Single Codec IE (see subclause B.2.5.5), and the MGCF shall include the bw parameter with the selected value that is also supplied towards the IM-MGW in the SDP answer. Otherwise the MGCF shall include the bw parameter in the SDP answer and shall set it to a range corresponding to the CS configuration received in the Single Codec IE (see subclause B.2.5.5). If the MGCF also supplies the br, br-send or br-recv parameter, the value of the bw parameter shall be compatible with the values of those parameters. The MGCF shall also supply the bw parameter to the IM-MGW in the local descriptor for the termination towards the offerer with the same value. | +| bw-send (NOTE 1) | If a bw-send parameter is contained in the SDP offer, the MGCF shall check if the IM-MGW supports the indicated sampling bandwidths, or a subset of them, in EVS primary mode in the receive direction. If the indicated sampling bandwidths, and even each subset of them, are not supported, the MGCF shall not select the EVS payload type. If the MGCF selects the EVS payload type, it shall forward this parameter to the IM-MGW for the termination towards the offerer in the remote descriptor. | If a bw-recv parameter is contained in the SDP offer, the MGCF shall select a sampling bandwidths value, which is either the received bw-recv value or a subset of it, based on IM-MGW capabilities, possible configured policies and the bw parameter value included in the SDP answer, and the MGCF shall include the bw-send parameter with the selected value in the SDP answer. Otherwise the MGCF shall not include the br-send parameter in the SDP answer. If the MGCF also supplies the bw or bw-send parameter, the value of the br-send parameter shall be compatible with the values of those parameters. If the MGCF supplies the bw-send parameter in the SDP answer, it shall also supply to the IM-MGW the bw-send parameter in the local descriptor for the termination towards the offerer with the same value. | +| bw-recv (NOTE 1) | If a br-recv parameter is contained in the SDP offer, the MGCF shall check if the IM-MGW supports the indicated sampling bandwidths, or a subset of them, in EVS primary mode in the send direction. If the indicated sampling bandwidths, and even each subset of them, are not supported, the MGCF shall not select the EVS payload type. If the MGCF selects the EVS payload type, it shall forward the bw-recv parameter to the IM-MGW for the termination towards the offerer in the remote descriptor. | If a bw-send parameter is contained in the SDP offer, the MGCF shall select a sampling bandwidths value, which is either the received bw-send value or a subset of it, based on IM-MGW capabilities, possible configured policies and the bw parameter value included in the SDP answer, and the MGCF shall include the bw-recv parameter with the selected value in the SDP answer. Otherwise the MGCF shall not include the bw-recv parameter in the SDP answer. If the MGCF also supplies the br or br-recv parameter, the value of the bw-recv parameter shall be compatible with the values of those parameters. If the MGCF supplies the bw-send parameter in the SDP answer, it shall also supply it to the IM-MGW in the local descriptor for the termination towards the offerer with the same value. | + +| | | | +|-----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| cmr (NOTE 1) | If a cmr parameter is contained in the SDP offer, the MGCF shall forward this parameter to the IM-MGW for the termination towards the offerer in the remote descriptor. |

If a cmr parameter is contained in the SDP offer, the MGCF shall include the cmr parameter with unmodified value in the SDP answer.

Otherwise, if the IM-MGW desires to disable codec mode requests within the RTP payload of the EVS primary mode (due to the IM-MGW capabilities and possible configured policies), it shall include the cmr parameter with value -1 in the SDP answer.

Otherwise the MGCF shall include the cmr parameter with a value of 1 in the SDP answer.

The MGCF shall also supply the cmr parameter to the IM-MGW in the local descriptor for the termination towards the offerer.

| +| ch-aw-recv (NOTE 1) | If a ch-aw-recv parameter is contained in the SDP offer the MGCF shall check if the CS side supports the indicated mode. If the indicated mode is not supported, the MGCF shall set this parameter to -1 and forward it to the IM-MGW for the termination towards the offerer in the remote descriptor. | If the MGCF desires to control the channel-aware mode of EVS in the receive direction, e.g. to disable it with value -1, it shall include the ch-aw-recv parameter in the SDP offer and shall also supply the ch-aw-recv parameter to the IM-MGW in the local descriptor for the termination towards the offerer with the same value. The MGCF shall consider the capabilities of the IM-MGW when it chooses an appropriate value. | +| number of channels (NOTE 2) | If a "number of channels" parameter is contained in the SDP offer the MGCF shall check if the IM-MGW supports the indicated number of channels. If the indicated number of channels is not supported, the MGCF shall not select the EVS payload type. If the MGCF selects the EVS payload type, the MGCF shall forward this parameter to the IM-MGW for the termination towards the offerer in the remote descriptor. | The MGCF shall include the "number of channels" parameter with a value of 1 in the SDP answer and shall also supply it to the IM-MGW in the local descriptor for the termination towards the offerer with the same value. | +| ch-send (NOTE 1) | If a ch-send parameter is contained in the SDP offer the MGCF shall check if the IM-MGW supports the indicated number of channels in the receive direction. If the indicated number of channels is not supported, the MGCF shall not select the EVS payload type. If the MGCF selects the EVS payload type, the MGCF shall forward the ch-send parameter to the IM-MGW for the termination towards the offerer in the remote descriptor. | If a ch-recv parameter is contained in the SDP offer, the MGCF shall include the ch-send parameter with a value of 1 in the SDP answer and shall also supply the ch-send parameter to the IM-MGW in the local descriptor for the termination towards the offerer with the same value. | +| ch-recv (NOTE 1) | If a ch-recv parameter is contained in the SDP offer the MGCF shall check if the IM-MGW supports the indicated number of channels in the send direction. If the indicated number of channels is not supported, the MGCF shall not select the EVS payload type. If the MGCF selects the EVS payload type, the MGCF shall forward the ch-recv parameter to the IM-MGW for the termination towards the offerer in the remote descriptor. | If a ch-send parameter is contained in the SDP offer, the MGCF shall include the ch-recv parameter with a value of 1 value in the SDP answer and shall also supply the ch-recv parameter to the IM-MGW in the local descriptor for the termination towards the offerer with the same value. | + +| | | | +|---------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| mode-set (NOTE 3) | If a mode-set parameter is contained in the SDP offer and the mode-set parameter does not include mode set 0, the MGCF shall not select the EVS payload type. Otherwise, if a mode-set parameter is contained in the SDP offer, the mode-set parameter includes mode set 0 and the MGCF select the EVS payload type, the MGCF shall forward this parameter to the IM-MGW for the termination towards the offerer in the remote descriptor. | If a mode-set parameter is contained in the SDP offer, the MGCF shall include the mode-set parameter with a value which is either the received mode-set parameter value or a subset of it, based on the CS configuration received in the Single Codec IE (see subclause B.2.5.5), in the SDP answer. Otherwise, the MGCF shall include the mode-set parameter in the SDP answer and shall set it to the range corresponding to the CS configuration received in the Single Codec IE (see subclause B.2.5.5). The MGCF shall also supply the mode-set parameter to the IM-MGW in the local descriptor for the termination towards the offerer. | +| mode-change-period (NOTE 3) | If a mode-change-period parameter is contained in the SDP offer and the MGCF select the EVS payload type, the MGCF shall forward this parameter to the IM-MGW for the termination towards the offerer in the remote descriptor. | The MGCF shall include the mode-change-period parameter in the SDP answer and shall set it as per the received Single Codec IE (see subclause B.2.5.5). The MGCF shall also supply the mode-change-period parameter to the IM-MGW in the local descriptor for the termination towards the offerer. | +| mode-change-capability (NOTE 3) | If a mode-change-capability (NOTE 4) parameter is contained in the SDP offer and the MGCF select the EVS payload type, the MGCF may forward this parameter to the IM-MGW for the termination towards the offerer in the remote descriptor. | The MGCF shall either include the mode-change-capability parameter with a value of 2 or omit it in the SDP answer. The MGCF may also supply the mode-change-capability parameter to the IM-MGW in the local descriptor for the termination towards the offerer. | +| mode-change-neighbor (NOTE 3) | If a mode-change-neighbor parameter is contained in the SDP offer and the MGCF select the EVS payload type, the MGCF shall forward this parameter to the IM-MGW for the termination towards the offerer in the remote descriptor. | The MGCF shall include the mode-change-neighbor parameter in the SDP answer and shall set it as per the received Single Codec IE (see subclause B.2.5.5). The MGCF shall also supply the mode-change-neighbor to the IM-MGW in the local descriptor for the termination towards the offerer. | +| max-red (NOTE 5) | If a max-red parameter is contained in the SDP offer and the MGCF select the EVS payload type, the MGCF shall forward this parameter to the IM-MGW for the termination towards the offerer in the remote descriptor. | The MGCF shall only include the max-red parameter in the SDP answer if it desires to restrict the maximum redundancy of received packets. When selecting the value of the max-red parameter, the MGCF shall consider the capabilities of the IM-MGW. If the MGCF supplies the max-red parameter in the SDP answer, it shall also supply it to the IM-MGW in the local descriptor for the termination towards the offerer with the same value. | +| 3gpp_mtsi_app_adapt (NOTE 4) | If a 3gpp_mtsi_app_adapt SDP attribute is contained in the SDP answer, the MGCF shall forward this parameter to the IM-MGW in the remote descriptor. | If the IM-MGW supports RTCP APP based adaptation messages defined in TS 26.114 [104], and the MGCF has a policy to negotiate the usage of those messages, the MGCF shall include the 3gpp_mtsi_app_adapt SDP attribute indicating the allowed APP messages in the SDP answer. | + +- | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NOTE 1: This MIME parameter of the EVS RTP payload type is defined in TS 26.445 [147]. It is encapsulated within the SDP "a=fmtp" attribute defined IETF RFC 4566 [56]. | +| NOTE 2: This number of channels are encoded as "encoding parameters" of the SDP "a=rtpmap" attribute defined in IETF RFC 4566 [56]. | +| NOTE 3: This MIME parameter of the EVS RTP payload type relates to EVS AMR-WB IO major operation mode and is defined in IETF RFC 4867 [23]. It is encapsulated within the SDP "a=fmtp" attribute defined IETF RFC 4566 [56]. | +| NOTE 4: This SDP attribute is defined in TS 26.114 [104]. It applies to all codecs offered in an SDP media line. However, some values are specific to EVS. | +| NOTE 5: This MIME parameter of the EVS RTP payload type is defined in IETF RFC 4867 [23]. It is encapsulated within the SDP "a=fmtp" attribute defined IETF RFC 4566 [56]. | +| NOTE 6: The received evs-mode-switch parameter has no influence on the Config-EVS-Code. | + +### 9.2.14 SDP Capability Negotiation (SDPCapNeg) + +The SDP Capability Negotiation (SDPCapNeg) as specified in IETF RFC 5939 [150] is adopted as an optional functionality to negotiate capabilities and their associated configurations according to 3GPP TS 24.229 [9]. + +The requirements and procedures as described in subclause 5.2.3 of 3GPP TS 23.333 [151] for MRFC and MRFP, apply to the MGCF and the IM-MGW when SDPCapNeg is used. + +### 9.2.15 Rate adaptation for media endpoints + +The MGCF and the IM-MGW may support rate adaptation for media endpoints using the enhanced bandwidth negotiation mechanism defined in 3GPP TS 26.114 [104]. + +The requirements and procedures as described in subclause 5.2.5 of 3GPP TS 23.333 [151] for the MRFC and the MRFP, apply to the MGCF and the IM-MGW if the MGCF and the IM-MGW perform media transcoding. + +## 9.3 Mn Signalling procedures + +This clause describes of logical signalling procedures (i.e. message identifiers are not part of the protocol) between the MGCF and IM-MGW. The procedures within this clause are intended to be implemented using the standard H.248 procedure as defined in ITU recommendation H.248.1 [2] with appropriate parameter combinations. + +### 9.3.1 Procedures related to terminations towards the IM CN Subsystem + +A mapping of the procedures defined here to H.248 procedures and parameters is provided in 3GPP TS 29.332 [15]. + +#### 9.3.1.1 Reserve IMS connection point + +This procedure is used to reserve local connection addresses and local resources. + +**Table 25: Procedures toward the IM Subsystem: Reserve IMS connection point** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|----------------------------------|-----------|------------------------------------|------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Reserve IMS Connection Point | MGCF | Context/Context Request | M | This information element indicates the existing context or requests a new context for the bearer termination. | +| | | Priority information | O | This information element requests the IM-MGW to apply priority treatment for the terminations and bearer connections in the specified context. | +| | | IMS Termination Request | M | This information element requests a new IMS termination for the bearer to be established. | +| | | Local IMS Resources/ | M | This information element indicates the resource(s) (i.e. codecs) for which the IM-MGW shall be prepared to receive user data, | +| | | IP Interface Type | O | This information element indicates the used interface type | +| | | ReserveValue | O | This information element indicates if multiple local IMS resources are to be reserved. | +| | | Local Connection Addresses Request | M | This information element requests an IP address and port number on the IM-MGW that the remote end can send user plane data to. | +| | | Notify termination heartbeat | M | This information element requests termination heartbeat indications. | +| | | Notify Released Bearer | O | This information element requests a notification of a released bearer. | +| | | IP Realm Identifier | O | This information element indicates the IP realm of the IP termination. | +| | | ECN Enable | O | This information element requests the IM-MGW to apply ECN procedures | +| | | ECN Initiation Method | C | This information element specifies the ECN Initiation method and requests the IM-MGW to perform IP header settings as an ECN endpoint. It may be included only if ECN is enabled. | +| | | Notify ECN Failure Event | C | This information element requests a notification if an ECN failure occurs. It may only be supplied if ECN is enabled. | +| | | Diffserv Code Point | O | This information element requests the IM-MGW to apply a specific Diffserv Code Point to the IP headers. | +| | | ICE password request | O | This information element is present if MGCF requests an ICE password. | +| | | ICE Ufrag request | O | This information element is present if MGCF requests an ICE ufrag. | +| | | ICE host candidate request | O | This information element is present if MGCF requests an ICE host candidate. | +| | | STUN server request | O | This information element is present if MGCF requests the IM-MGW to answer STUN connectivity checks for ICE. | +| | | SDPCapNeg configuration | O | This information element provides SDPCapNeg configuration(s) using as "a=acap", "a=tcap", "a=pcfg" and "a=acfg" SDP attributes. | +| Reserve IMS Connection Point Ack | IM-MGW | Context | M | This information element indicates the context where the command was executed. | +| | | IMS Termination | M | This information element indicates the IMS termination where the command was executed. | + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|-----------|-----------|----------------------------|------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | Local IMS Resources | M | This information element indicates the resources that the IM-MGW has reserved to receive the user plane data from the IMS. | +| | | Local Connection Addresses | M | This information element indicates the IP address and port on the IM-MGW that shall receive user plane data from IMS. | +| | | ICE password | C | This information element shall be present only if it was contained in the request. It indicates the ICE password assigned by the IM-MGW. | +| | | ICE Ufrag | C | This information element shall be present only if it was contained in the request. It indicates the ICE Ufrag assigned by the IM-MGW. | +| | | ICE host candidate | C | This information element shall be present only if it was contained in the request. It indicates the ICE host candidate assigned by the IM-MGW. | +| | | ICE lite indication | C | This information element shall be present only if an ICE host candidate request was contained in the request, and the IM-MGW supports ICE lite, but not full ICE. It indicates that the IM-MGW only supports ICE lite. | +| | | SDPCapNeg configuration | C | This information element shall be present only if it was contained in the request. It provides SDPCapNeg configuration(s) using as "a=acap", "a=tcap", "a=pcfg" and "a=acfg" SDP attributes. | + +#### 9.3.1.2 Configure IMS resources + +This procedure is used to select multimedia-processing resources for an Mb interface connection. + +**Table 26: Procedures toward the IM Subsystem: Select Local, +Select Remote IMS Processing Resource** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|-------------------------|-----------|-------------------------------------------|------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Configure IMS Resources | MGCF | Context | M | This information element indicates the existing context. | +| | | IMS Termination | M | This information element indicates the existing bearer termination. | +| | | Local IMS Resources | O | This information element indicates the resources (i.e. codec) that the IM-MGW may use on the reception of user plane data. | +| | | Remote IMS Resources | M | This information element indicates the resources (i.e. codec) that the IM-MGW may send user plane data to. | +| | | Local Connection Addresses | O | This information element indicates the IP address and port on the IM-MGW that the IMS user can send user plane data to. | +| | | Remote Connection Addresses | M | This information element indicates the IP address and port that the IM-MGW can send user plane data to. | +| | | IP Interface Type | O | This information element indicates the used interface type | +| | | Reserve Value | O | This information element indicates if multiple IMS resources are to be reserved. | +| | | Remote Connection Addresses Source Filter | O | This information element indicates an optional source filter restricting the IP addresses and ports that the IM-MGW shall accept as source for incoming user plane data. If this information element is set, the IM-MGW shall silently discard incoming user plane data from disallowed sources. | +| | | ECN Enable | O | This information element requests the IM-MGW to apply ECN procedures. | +| | | ECN Initiation Method | C | This information element specifies the ECN Initiation method and requests the IM-MGW to perform IP header settings as an ECN endpoint. It may be included only if ECN is enabled. | +| | | Notify ECN Failure Event | C | This information element requests a notification if an ECN failure occurs. It may only be supplied if ECN is enabled. | +| | | ICE Connectivity Check | C | This information element requests the IM-MGW to perform ICE connectivity check as defined by IETF RFC 5245 [143]. It is only applicable for full ICE. | +| | | Notify ICE Connectivity Check Result | C | This information element requests a notification of ICE connectivity check result. It is only applicable for full ICE. | +| | | Notify New Peer Reflexive Candidate | C | This information element requests a notification of new peer reflexive candidate was discovered during a connectivity check. It is only applicable for full ICE. | +| | | Additional ICE Connectivity Check | C | This information element requests the IM-MGW to perform additional ICE connectivity check as defined by IETF RFC 5245 [143]. It is only applicable for full ICE. | +| | | ICE received candidate | O | This information element is present if MGCF indicates a received candidate for ICE. | +| | | ICE received password | O | This information element is present if MGCF indicates a received password for ICE. | + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|-----------------------------|-----------|---------------------------------|------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | Allowed RTCP APP message types | O | This information element is present if the MGCF allows the IM-MGW to send RTCP APP packets of the indicated types. The IM-MGW shall not send other RTCP APP packets. If the parameter is not supplied, the IM-MGW shall not send any RTCP APP packets. | +| | | SDPCapNeg configuration | O | This information element provides SDPCapNeg configuration(s) using as "a=acap", "a=tcap", "a=pcfg" and "a=acfg" SDP attributes. | +| | | Additional Bandwidth Properties | O | This information element indicates additional bandwidth properties using "a=bw-info" SDP attribute(s) as defined by 3GPP TS 26.114 [104]. | +| Configure IMS Resources Ack | IM-MGW | Context | M | This information element indicates the context where the command was executed. | +| | | IMS Termination | M | This information element indicates the IMS termination where the command was executed. | +| | | Local IMS Resource | O | This information element indicates the resources that the IM-MGW has reserved to receive the user plane data from the far end. | +| | | Remote IMS Resource | M | This information element indicates the resource (i.e. codec) that the IM-MGW shall use to send user data to. | +| | | Local Connection Address | O | This information element indicates the IP address and port on the IM-MGW that the remote end can send user plane data to. | +| | | Remote Connection Address | M | This information element indicates the IP address and port that the IM-MGW can send user plane data to. | + +#### 9.3.1.3 Reserve IMS Connection point and configure remote resources + +This procedure is used to reserve multimedia-processing resources for an Mb interface connection. + +**Table 27: Procedures toward the IM Subsystem: reserve local, reserve remote IMS connection point** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|-------------------------------------------------------------|-----------|-----------------------------------------|------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Reserve IMS Connection Point and Configure Remote Resources | MGCF | Context/Context Request | M | This information element indicates the existing context or requests a new context for the bearer termination. | +| | | Priority information | O | This information element requests the IM-MGW to apply priority treatment for the terminations and bearer connections in the specified context. | +| | | IMS Termination/IMS Termination Request | M | This information element indicates the existing bearer termination or requests a new IMS termination for the bearer to be established. | +| | | Local IMS Resources | M | This information element indicates the resource(s) (i.e. codecs) for which the IM-MGW shall be prepared to receive user data. | +| | | Remote IMS Resources | M | This information element indicates the resources (i.e. codec) that the IM-MGW shall use to send user data in the IMS. | +| | | IP Interface Type | O | This information element indicates the used interface type | +| | | Reserve Value | O | This information element indicates if multiple IMS resources are to be reserved. | +| | | Local Connection Address request | M | This information element requests an IP address and a port number on the IM-MGW that the remote end can send user plane data to. | +| | | Remote Connection Addresses | M | This information element indicates the IP address and ports at an IMS user that the IM-MGW can send user plane data to. | +| | | Notify termination heartbeat | M | This information element requests termination heartbeat indications. | +| | | Notify Released Bearer | O | This information element requests a notification of a released bearer. | +| | | IP Realm Identifier | O | This information element indicates the IP realm of the IP termination. | +| | | ECN Enable | O | This information element requests the IM-MGW to apply ECN procedures and IP header settings as an ECN endpoint. | +| | | ECN Initiation Method | C | This information element specifies the ECN Initiation method and requests the IM-MGW to perform IP header settings as an ECN endpoint. It may be included only if ECN is enabled. | +| | | Notify ECN Failure Event | C | This information element requests a notification if an ECN failure occurs. It may only be supplied if ECN is enabled. | +| | | Diffserv Code Point | O | This information element requests the IM-MGW to apply a specific Diffserv Code Point to the IP headers. | +| | | STUN server request | O | This information element is present if MGCF requests the IM-MGW to answer STUN connectivity checks for ICE. | +| | | ICE Connectivity Check | C | This information element requests the IM-MGW to perform ICE connectivity check as defined by IETF RFC 5245 [143]. It is only applicable for full ICE. | +| | | Notify ICE Connectivity Check Result | C | This information element requests a notification of ICE connectivity check result. It is only applicable for full ICE. | + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|-----------------------------------------------------------------|-----------|-------------------------------------|------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | Notify New Peer Reflexive Candidate | C | This information element requests a notification of new peer reflexive candidate was discovered during a connectivity check. It is only applicable for full ICE. | +| | | ICE password request | O | This information element is present if MGCF requests an ICE password. | +| | | ICE Ufrag request | O | This information element is present if MGCF requests an ICE ufrag. | +| | | ICE host candidate request | O | This information element is present if MGCF requests an ICE host candidate. | +| | | ICE received candidate | O | This information element is present if MGCF indicates a received candidate for ICE. | +| | | ICE received password | O | This information element is present if MGCF indicates a received password for ICE. | +| | | ICE received Ufrag | O | This information element is present if MGCF indicates a received Ufrag for ICE. | +| | | Allowed RTCP APP message types | O | This information element is present if the MGCF allows the IM-MGW to send RTCP APP packets of the indicated types. The IM-MGW shall not send other RTCP APP packets. If the parameter is not supplied, the IM-MGW shall not send any RTCP APP packets. | +| | | SDPCapNeg configuration | O | This information element provides SDPCapNeg configuration(s) using as "a=acap", "a=tcap", "a=pcfg" and "a=acfg" SDP attributes. | +| | | Additional Bandwidth Properties | O | This information element indicates additional bandwidth properties using "a=bw-info" SDP attribute(s) as defined by 3GPP TS 26.114 [104]. | +| Reserve IMS Connection Point and Configure Remote Resources Ack | IM-MGW | Context | M | This information element indicates the context where the command was executed. | +| | | IMS Termination | M | This information element indicates the IMS termination where the command was executed. | +| | | Local IMS Resources | M | This information element indicates the resources that the IM-MGW has reserved to receive the user plane data from IMS. | +| | | Remote IMS Resources | M | This information element indicates the resource (i.e. codec) that the IM-MGW shall use to send user data. | +| | | Local Connection Addresses | M | This information element indicates the IP address on the IM-MGW that shall receive user plane data from the IMS. | +| | | ICE password | C | This information element shall be present only if it was contained in the request. It indicates the ICE password assigned by the IM-MGW. | +| | | ICE Ufrag | C | This information element shall be present only if it was contained in the request. It indicates the ICE Ufrag assigned by the IM-MGW. | +| | | ICE host candidate | C | This information element shall be present only if it was contained in the request. It indicates the ICE host candidate assigned by the IM-MGW. | +| | | ICE lite indication | C | This information element shall be present only if an ICE host candidate request was contained in the request, and the IM-MGW supports ICE lite, but not full ICE. It indicates that the IM-MGW only supports ICE lite. | + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|-----------|-----------|--------------------------|------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | SDPCapNeg configuration | C | This information element shall be present only if it was contained in the request. It provides SDPCapNeg configuration(s) using as "a=acap", "a=tcap", "a=pcfg" and "a=acfg" SDP attributes. | + +#### 9.3.1.4 Release IMS termination + +This procedure is used by the MGCF to release a termination towards the IMS and free all related resources. + +**Table 28: Release IMS termination** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|-----------------------------|-----------|--------------------------|------------------------------|-------------------------------------------------------------------------------------------| +| Release IMS Termination | MGCF | Context | M | This information element indicates the context for the bearer termination. | +| | | Bearer Termination | M | This information element indicates the bearer termination to be released. | +| Release IMS Termination Ack | IM-MGW | Context | M | This information element indicates the context where the command was executed. | +| | | Bearer Termination | M | This information element indicates the bearer termination where the command was executed. | + +#### 9.3.1.5 Detect IMS RTP Tel event + +This procedure is used by the MGCF to request from the MGW the detection of telephony events signalled within RTP according to RFC 4733 [105] and the notification of received telephony events. This procedure is the same as that is defined in the clause "Detect DTMF" in 3GPP TS 23.205 [27]. + +**Table 29: VOID** + +#### 9.3.1.6 Notify IMS RTP Tel event + +This procedure is used by the MGW to notify the MGCF about the detection of telephony events signalled within RTP according to RFC 4733 [105]. This procedure is the same as that defined in the clause "Report DTMF" in 3GPP TS 23.205 [27]. + +**Table 30: VOID** + +#### 9.3.1.7 Void + +#### 9.3.1.8 Send IMS RTP Tel event + +This procedure is used by the MGCF to request from the MGW to signal a telephone event within RTP according to RFC 4733 [105]. This procedure is the same as that defined in the clause "Send DTMF" in 3GPP TS 23.205 [27]. + +#### 9.3.1.9 Stop IMS RTP Tel event + +This procedure is used by the MGW to request from the MGW to stop signalling a telephone event within RTP according to RFC 4733 [105]. This procedure is the same as that defined in the clause "Stop DTMF" in 3GPP TS 23.205 [27]. + +#### 9.3.1.10 Termination heartbeat indication + +This procedure is used to report indication of hanging termination. + +**Table 30a: Procedures between (G)MSC server and MGW: Hanging termination indication** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|--------------------------------------|-----------|--------------------------|------------------------------|------------------------------------------------------------------------------------------------------------| +| Termination heartbeat indication | MGW | Context | M | This information element indicates the context for the bearer termination. | +| | | Bearer Termination | M | This information element indicates the bearer termination for which the termination heartbeat is reported. | +| | | Termination heartbeat | M | Hanging Termination event, as defined in TS 29.332 [15]. | +| Termination heartbeat indication Ack | (G)MSC-S | Context | M | This information element indicates the context where the command was executed. | + +#### 9.3.1.11 IMS Bearer Released + +This procedure is used by the IM-MGW to indicate towards the MGCF that an error occurred on an IMS termination which requires the release of the termination. This procedure is the same as that defined in the clause "Bearer Released" in 3GPP TS 23.205 [27]. + +#### 9.3.1.12 End IMS RTP Tel event + +This procedure is used by the MGCF to indicate to the IM-MGW to stop detection of telephony events signalled within RTP according to IETF RFC 4733 [105]. This procedure is the same as that is defined in the clause "Stop Detect DTMF" in 3GPP TS 23.205 [27]. + +#### 9.3.1.13 IMS Send Tone + +This procedure is used by the MGCF to order the IM-MGW to generate a tone at termination towards IMS. This procedure is the same as that defined in the clause "Send Tone" in 3GPP TS 23.205 [27]. + +#### 9.3.1.14 IMS Stop Tone + +This procedure is used by the MGCF to order the IM-MGW to stop generating a tone at a termination towards IMS. This procedure is the same as that defined in the clause "Stop Tone" in 3GPP TS 23.205 [27]. + +#### 9.3.1.15 IMS Tone Completed + +This procedure is used by the IM-MGW to indicate to the MGCF that a tone has finished being generated at a termination. This procedure is the same as that defined in the clause "Tone Completed" in 3GPP TS 23.205 [27]. + +#### 9.3.1.16 ECN Failure Indication + +This procedure is used to report ECN related errors (see clause 9.2.11.1c). + +**Table 9.3.1.16.1: Procedures toward the IM Subsystem: ECN Failure Indication** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|----------------------------|-----------|--------------------------|------------------------------|--------------------------------------------------------------------------------------------------| +| ECN Failure Indication | IM-MGW | Context | M | This information element indicates the context for the bearer termination. | +| | | Bearer Termination | M | This information element indicates the bearer termination for which the ECN failure is reported. | +| | | ECN Failure Indication | M | This IE indicates an ECN failure event. | +| ECN Failure Indication Ack | MGCF | Context | M | This information element indicates the context where the command was executed. | +| | | Bearer Termination | M | This information element indicates the bearer termination where the command was executed | + +#### 9.3.1.17 ICE Connectivity Check Result Notification + +This procedure is used to report ICE connectivity check result for Full ICE. + +**Table 9.3.1.17.1: Procedures between MGCF and IM-MGW: ICE Connectivity Check Result Notification** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|------------------------------------------------|-----------|-------------------------------|------------------------------|--------------------------------------------------------------------------------------------------------------------| +| ICE Connectivity Check Result Notification | IM-MGW | Context | M | This information element indicates the context for the bearer termination. | +| | | Bearer Termination | M | This information element indicates the bearer termination for which the ICE Connectivity Check Result is reported. | +| | | ICE Connectivity Check Result | M | This information element indicates an ICE Connectivity Check Result event. | +| ICE Connectivity Check Result Notification Ack | MGCF | Context | M | This information element indicates the context where the command was executed. | +| | | Bearer Termination | M | This information element indicates the bearer termination where the command was executed. | + +#### 9.3.1.18 ICE New Peer Reflexive Candidate Notification + +This procedure is used to report ICE new peer reflexive candidate for Full ICE. + +**Table 9.3.1.18.1: Procedures between MGCF and IM-MGW: ICE New Peer Reflexive Candidate Notification** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|---------------------------------------------------|-----------|----------------------------------|------------------------------|-----------------------------------------------------------------------------------------------------------------------| +| ICE New Peer Reflexive Candidate Notification | IM-MGW | Context | M | This information element indicates the context for the bearer termination. | +| | | Bearer Termination | M | This information element indicates the bearer termination for which the ICE New Peer Reflexive Candidate is reported. | +| | | ICE New Peer Reflexive Candidate | M | This information element indicates an ICE New Peer Reflexive Candidate event. | +| ICE New Peer Reflexive Candidate Notification Ack | MGCF | Context | M | This information element indicates the context where the command was executed. | +| | | Bearer Termination | M | This information element indicates the bearer termination where the command was executed. | + +### 9.3.2 Procedures related to a termination towards an ISUP network + +A mapping of the procedures defined here to H.248 procedures and parameters is provided in 3GPP TS 29.332 [15]. + +#### 9.3.2.1 Reserve TDM circuit + +This procedure is used by the MGCF to reserve a TDM circuit in the IM-MGW towards the preceding/succeeding CS network element. + +**Table 31: Reserve TDM circuit procedure** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|---------------------|-----------|--------------------------------|------------------------------|---------------------------------------------------------------------------------------------------------------| +| Reserve TDM Circuit | MGCF | Context/Context Request | M | This information element indicates the existing context or requests a new context for the bearer termination. | +| | | Bearer Termination | M | This information element indicates the physical bearer termination for the TDM circuit. | +| | | Bearer Service Characteristics | M | This information element indicates the bearer service requested by the user. | +| | | Notify termination heartbeat | O | This information element requests termination heartbeat indications. | +| | | Notify Released Bearer | O | This information element requests a notification of a released bearer | +| Reserve Circuit Ack | IM-MGW | Context | M | This information element indicates the context where the command was executed. | + +#### 9.3.2.2 Change TDM through-connection + +This procedure is used by the MGCF to modify the through-connection (forward, backward, both-way, inactive) of a TDM termination at the IM-MGW towards the PSTN. + +This procedure is the same as Change Through Connection in 3GPP TS 23.205 [27]. + +#### 9.3.2.3 Activate TDM voice-processing function + +This procedure is used by the MGCF to activate or de-activate a voice processing function of a TDM termination at the IM-MGW towards the PSTN. This voice processing function may include a cancellation for electronic echoes. + +This procedure is the same as Activate Voice Processing Function in 3GPP TS 23.205 [27]. + +#### 9.3.2.4 Send TDM tone + +This procedure is used by the MGCF to order the IM-MGW to generate a tone at a TDM termination towards the PSTN. + +This procedure is the same as Send Tone in 3GPP TS 23.205 [27]. + +#### 9.3.2.5 Stop TDM tone + +This procedure is used by the MGCF to order the IM-MGW to stop generating a tone at a TDM termination towards the PSTN. + +This procedure is the same as Stop tone in 3GPP TS 23.205 [27]. + +#### 9.3.2.6 Play TDM announcement + +This procedure is used by the MGCF to order the IM-MGW to generate an announcement at a TDM termination towards the PSTN. The MGCF may request a notification that the announcement is completed. This procedure is the same as Play Announcement in 3GPP TS 23.205 [27]. This procedure is optional. + +#### 9.3.2.7 TDM announcement completed + +This procedure is used by the IM-MGW to notify the MGCF that an announcement at a TDM termination towards the PSTN is completed. This procedure is the same as Announcement Completed in 3GPP TS 23.205 [27]. This procedure is optional. + +#### 9.3.2.8 Stop TDM announcement + +This procedure is the same as Stop Announcement 3GPP TS 23.205 [27]. This procedure is used by the MGCF to order the IM-MGW to stop generating an announcement at a TDM termination towards the PSTN. This procedure is optional. + +#### 9.3.2.9 Continuity check + +This procedure is used by the MGCF to order the IM-MGW to generate a continuity check tone at a TDM termination towards the PSTN and to inform the MGCF about the result of the continuity check as soon as the continuity check tone is received or a time-out occurs. This procedure is optional. + +**Table 32: Continuity check procedure** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|------------------|-----------|---------------------------------------------|------------------------------|---------------------------------------------------------------------------------------------------------------| +| Continuity check | MGCF | Context/Context Request | M | This information element indicates the existing context or requests a new context for the bearer termination. | +| | | TDM Termination | M | This information element indicates the existing bearer termination | +| | | Request for continuity tone sending | M | This information request the IM-MGW to apply the continuity check procedure on the indicated TDM termination | +| | | Request for continuity check tone detection | M | This information request the IM-MGW to inform e continuity check procedure on the indicated TDM termination | + +#### 9.3.2.10 Continuity check verify + +This procedure is used by the IM-MGW to indicate towards the MGCF that the continuity check at a TDM termination towards the PSTN has been completed and to return the result of the check: success or failure. This procedure is optional. + +**Table 33: Continuity check verify procedure** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|-------------------------|-----------|---------------------------------|------------------------------|--------------------------------------------------------------------------------------------------| +| Continuity check Verify | IM-MGW | Context/t | M | This information element indicates the context where the command was executed. | +| | | TDM Termination | M | This information element indicates the TDM termination involved in the procedure | +| | | Outcome of the continuity check | M | This information element indicates the outcome of the continuity check (successful/unsuccessful) | + +#### 9.3.2.11 Continuity check response + +This procedure is used by the MGCF to order the IM-MGW to loop back an incoming continuity check tone at a TDM termination towards the PSTN. This procedure is optional. + +**Table 34: Continuity check response procedure** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|---------------------------|-----------|----------------------------------------------|------------------------------|---------------------------------------------------------------------------------------------------------------| +| Continuity check response | MGCF | Context/Context Request | M | This information element indicates the existing context or requests a new context for the bearer termination. | +| | | TDM Termination | M | This information element indicates the existing bearer termination | +| | | Request for loop back of the continuity tone | M | This information request the IM-MGW to loop back the continuity check tone on the indicated TDM termination | + +#### 9.3.2.12 Release TDM termination + +This procedure is used by the MGCF to release a TDM termination at the IM-MGW towards the PSTN and free all related resources. + +**Table 35: Release TDM termination procedure** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|-----------------------------|-----------|--------------------------|------------------------------|-------------------------------------------------------------------------------------------| +| Release TDM Termination | MGCF | Context | M | This information element indicates the context for the bearer termination. | +| | | Bearer Termination | M | This information element indicates the bearer termination to be released. | +| Release TDM Termination Ack | IM-MGW | Context | M | This information element indicates the context where the command was executed. | +| | | Bearer Termination | M | This information element indicates the bearer termination where the command was executed. | + +#### 9.3.2.13 Termination Out-of-Service + +This procedure is used by the IM-MGW to indicate towards the MGCF that one or several physical termination(s) will go out of service. This procedure is the same as Termination Out-of-Service in 3GPP TS 23.205 [27]. + +#### 9.3.2.14 Termination heartbeat indication + +This procedure is used to report indication of hanging termination. + +**Table 35a: Procedures between (G)MSC server and MGW: Hanging termination indication** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|--------------------------------------|-----------|--------------------------|------------------------------|------------------------------------------------------------------------------------------------------------| +| Termination heartbeat indication | MGW | Context | M | This information element indicates the context for the bearer termination. | +| | | Bearer Termination | M | This information element indicates the bearer termination for which the termination heartbeat is reported. | +| | | Termination heartbeat | M | Hanging termination event, as defined in TS 29.332 [15]. | +| Termination heartbeat indication Ack | (G)MSC-S | Context | M | This information element indicates the context where the command was executed. | + +#### 9.3.2.15 Bearer Released + +This procedure is used by the IM-MGW to indicate towards the MGCF that an error occurred on a physical termination which requires the release of the termination. This procedure is the same as Bearer Released in 3GPP TS 23.205 [27]. + +#### 9.3.2.16 TDM tone completed + +This procedure is used by the IM-MGW to MGCF to indicate that a tone has finished being generated at a TDM termination. + +This procedure is the same as Tone Completed in 3GPP TS 23.205 [27]. + +### 9.3.3 Procedures related to a termination towards a BICC network + +The call related procedures detailed in table 36 shall be supported. Those procedures are defined in 3GPP TS 29.332 [15]. + +**Table 36: Required procedures defined in TS 29.332 [15]** + +| Procedure defined in TS 29.332 [15] | Remarks | +|--------------------------------------------|---------------------------------------------------| +| Establish Bearer | | +| Prepare Bearer | | +| Change Through-Connection | | +| Release Bearer | | +| Release Termination | | +| Bearer Established | | +| Bearer Released | | +| Send Tone | | +| Stop Tone | | +| Tone completed | | +| Play Announcement | Optional | +| Stop Announcement | Optional | +| Announcement Completed | Optional | +| Confirm Char | Optional | +| Modify Bearer Characteristics | Optional | +| Reserve Char | Optional | +| Bearer Modified | Optional | +| Activate Voice Processing Function | Optional | +| Tunnel Information Down | Conditional: For IP Transport at BICC termination | +| Tunnel Information Up | Conditional: For IP Transport at BICC termination | +| Termination Out-of-Service | | +| Termination heartbeat indication | | + +### 9.3.4 Non-call related procedures + +The procedures from 3GPP TS 23.205 [27] detailed in table 37 shall be applied for the IM-MGW handling component of the Mn interface. + +**Table 37: Non-call related procedures** + +| Procedure defined in TS 29.332 [15] | Corresponding Procedure defined in TS 23.205 [27] | Remarks | +|--------------------------------------------------|---------------------------------------------------|--------------------------------------------------------------------------------------------------------------------| +| IM-MGW Out of service | MGW Out of Service | | +| IM-MGW Communication Up | MGW Communication Up | | +| IM-MGW Restoration | MGW Restoration | | +| IM-MGW Register | MGW Register | | +| IM-MGW Re-register | MGW Re-register | | +| MGCF Ordered Re-register | (G)MSC Server Ordered Re-register | | +| MGCF Restoration | (G)MSC Server Restoration | | +| MGCF Out of Service | (G)MSC Server Out of Service | | +| Termination Out-of-Service | Termination Out-of-Service | The "Termination Out-of-Service procedure" is used as call-related H.248 command as well | +| Termination Restoration | Termination Restoration | | +| Audit Value | Audit Value | | +| Audit Capability | Audit Capability | | +| Command Rejected | Command Rejected | The "Command Rejected" procedure may be used in response both to call-related and non-call-related H.248 Commands. | +| IM-MGW Capability Change | Capability Update | | +| IM-MGW Resource Congestion Handling - Activate | MGW Resource Congestion Handling - Activate | | +| IM-MGW Resource Congestion Handling - Indication | MGW Resource Congestion Handling - Indication | | +| Control association monitoring | Control association monitoring | | +| Inactivity timeout activation | Inactivity timeout activation | | +| Inactivity timeout indication | Inactivity timeout indication | | +| Hanging termination detection | Hanging termination detection | | +| Hanging termination detection | Hanging termination detection | | + +### 9.3.5 Multiple IP Realms + +The procedures to support multiple IP realms in the present clause are optional. + +Figure 9.3.5.1 shows a scenario where multiple IP realms are applied. + +![Diagram of Multiple IP realms scenario showing IM CN1 connected to Termination 1 and CS CN1 connected to Termination 2 of an IM-MGW.](20e1585db1a707a774877194c689de82_img.jpg) + +The diagram illustrates a central box labeled "IM-MGW". Inside this box, there are two sub-boxes labeled "Termination 1" and "Termination 2". To the left of the "IM-MGW" box is a cloud-shaped icon labeled "IM CN1", connected to the "Termination 1" box by a line with a small circle at the connection point. To the right of the "IM-MGW" box is another cloud-shaped icon labeled "CS CN1", connected to the "Termination 2" box by a line with a small circle at the connection point. + +Diagram of Multiple IP realms scenario showing IM CN1 connected to Termination 1 and CS CN1 connected to Termination 2 of an IM-MGW. + +**Figure 9.3.5.1 Multiple IP realms scenario** + +Shown in figure 9.3.5, the IM CN1 and CS CN1 represent separate IP realms. The definition of IP realm is specified in IETF RFC 2663[90]. + +The termination1 and termination2 are connected with different IP realms in the IM-MGW separately. + +For establishing session when multiple IP realms are used in the IM-MGW, the MGCF may indicate the IP realm identifier to the IM-MGW. The IM-MGW shall assign the IP termination with the indicated IP realm. + +A default IP realm may be configured in IM-MGW such that if the IM-MGW has not received the IP realm identifier and the IM-MGW supports multiple IP realms then the default IP realm shall be used. + +If the IM-MGW does not support the option to indicate an IP realm then it is free to select any IP port. + +## 9.4 Multimedia Priority Service (MPS) Support + +### 9.4.1 General + +The Multimedia Priority Service (MPS) is specified in 3GPP TS 22.153 [136]. The MGCF/IM-MGW may support the priority treatment of a call/session identified as an MPS call/session. If MPS is supported then upon receipt of the MPS priority information in the call control signalling: + +- The MGCF shall recognise the call/session as having priority. +- The MGCF shall send the Priority information for a context to the IM-MGW to enable the priority treatment described below related to the IM-MGW. +- The MGCF shall apply priority handling to H.248 transactions related to priority calls/sessions when network resources are congested, e.g., preferential treatment in any queues or buffers. +- If the H.248 control association utilises a transport with the possibility for prioritisation, the MGCF may apply priority using the appropriate prioritisation procedures. +- If the MPS Priority service requires a specific MPS DSCP setting, the MGCF shall configure the IM-MGW to apply a specific MPS DSCP marking to the user data transport packets to indicate that the packets are of a higher priority than those for normal calls. +- If the IM-MGW receives an indication to apply a specific MPS DSCP marking to the user data transport packets, it shall apply this DSCP marking to the IP headers. + +NOTE 1: Support of Diffserv procedures by the IMS-MGW assumes an operator uses Diffserv for prioritising user plane traffic related to an MPS call/session. + +- When the MGCF marks a Context with Priority information, the IM-MGW may use the Priority information for selecting resources for the media and 294isalignme transport with priority. The following actions may be taken by the IM-MGW if it has reached a congested state: + - i) seize priority reserved resources; or + - ii) if resources are completely congested, indicate that in a Command Response error code. + +NOTE 2: The Priority information can be used to derive Layer 2 QoS marking and trigger priority identification and priority treatment for other QoS technologies than Diffserv. + +This clause describes the Mn signalling procedures and their interactions with SIP signalling in the control plane and with user plane procedures to support the requirements for MPS. These Mn signalling procedures may or may not apply depending on the network configuration (e.g. whether the IM-MGW is shared by multiple MGCFs or whether the MGCF controls multiple IM-MGWs for a given route - Media Gateway Group). + +The MGCF can receive a SIP INVITE with MPS priority information (see 3GPP TS 23.228 [12], clause 5.21). + +### 9.4.2 IM-MGW Resource Congestion in ADD response, request is queued + +If the MGCF requests a resource via the Reserve IMS Connection Point and configure remote resources procedure or Reserve IMS Connection Point procedure and receives an error indicating that the requested resource could not be seized (e.g. H.248 error code #510 "insufficient resources") and the MGCF does not have an alternative IM-MGW through which it can route the call/session, the MGCF queues the priority call/session and gives it priority over any further Reserve IMS Connection Point and configure remote resources or Reserve IMS Connection Point procedures for + +lower priority calls/sessions towards this IM-MGW until the requested resource for this queued call/session is successfully seized. The example sequence is shown in Figure 9.4.2.1. + +![Sequence diagram for Figure 9.4.2.1: Request to Reserve MPS priority call resources when IM-MGW is congested. The diagram shows the interaction between an MGCF and an IM-MGW. The MGCF sends an INVITE with MPS priority indication. It then attempts to reserve an IMS Connection Point, which triggers an H.248 ADD Req to the IM-MGW. The IM-MGW responds with an H.248 ADD Reject (Error #510) because it is congested. The MGCF then queues the MPS request. After queuing, it attempts to reserve the IMS Connection Point again, which triggers another H.248 ADD Req to the IM-MGW. The IM-MGW then successfully seizes the required resources and responds with an H.248 ADD Resp.](e26bb66586e464339df27951d5c9355e_img.jpg) + +``` + +sequenceDiagram + participant External + participant MGCF + participant IM-MGW + Note right of IM-MGW: IM-MGW is Congested + External->>MGCF: 1. INVITE [MPS priority indication] + Note left of MGCF: Reserve IMS Connection Point + MGCF->>IM-MGW: 2. H.248 ADD Req [C=?, T=?, Laddr=?, Lport=?, Local Resources, Priority] + IM-MGW-->>MGCF: 3. H.248 ADD Reject [Error = #510] + Note left of MGCF: 4. MGCF queues MPS request + Note left of MGCF: Reserve IMS Connection Point + MGCF->>IM-MGW: 5. H.248 ADD Req [C=?, T=?, Laddr=?, Lport=?, Local Resources, Priority] + Note right of IM-MGW: IM-MGW successfully seizes required resources + IM-MGW-->>MGCF: 6. H.248 ADD Resp [C=C1, T=T2, Laddr=IP2o, LPort=P2o] + +``` + +Sequence diagram for Figure 9.4.2.1: Request to Reserve MPS priority call resources when IM-MGW is congested. The diagram shows the interaction between an MGCF and an IM-MGW. The MGCF sends an INVITE with MPS priority indication. It then attempts to reserve an IMS Connection Point, which triggers an H.248 ADD Req to the IM-MGW. The IM-MGW responds with an H.248 ADD Reject (Error #510) because it is congested. The MGCF then queues the MPS request. After queuing, it attempts to reserve the IMS Connection Point again, which triggers another H.248 ADD Req to the IM-MGW. The IM-MGW then successfully seizes the required resources and responds with an H.248 ADD Resp. + +Figure 9.4.2.1: Request to Reserve MPS priority call resources when IM-MGW is congested + +### 9.4.3 IM-MGW Resource Congestion in ADD response, MGCF seizes new IM-MGW + +If the MGCF requests a resource via the Reserve IMS Connection Point and configure remote resources procedure or Reserve IMS Connection Point procedure and receives an error indicating that the requested resources could not be seized due to congestion (e.g. H.248 error code #510 "insufficient resources") and Media Gateway Groups are implemented the MGCF seizes a new IM-MGW from the same Media Gateway Group before resorting to any queuing of the priority call/session (as described in clause 9.4.2) to enable the MPS call/session to proceed as early as possible. + +### 9.4.4 IM-MGW Priority Resource Allocation + +If the IM-MGW supports the Priority information (e.g. determined through provisioning or package profile), the MGCF requests a resource via the Reserve IMS Connection Point and configure remote resources procedure or Reserve IMS Connection Point procedure and includes the Priority information. The IM-MGW may then provide priority allocation of resources once a congestion threshold is reached. The example sequence is shown in Figure 9.4.4.1. If the IM-MGW is completely congested it shall indicate this to the MGCF as described in clause 9.4.2. + +![Sequence diagram for Figure 9.4.4.1: Request to reserve MPS priority call resources when IM-MGW is congested, priority resources are allocated. The diagram shows the interaction between an MGCF and an IM-MGW. The MGCF sends an INVITE with MPS priority indication. It then attempts to reserve an IMS Connection Point, which triggers an H.248 ADD Req to the IM-MGW. The IM-MGW responds with an H.248 ADD Resp, indicating that it is in a congested state but has allocated priority resources to this call.](80d994053160f3b1d88b075564af9e57_img.jpg) + +``` + +sequenceDiagram + participant External + participant MGCF + participant IM-MGW + Note right of IM-MGW: IM-MGW is in a congested state but allocates priority resources to this call. + External->>MGCF: 1. INVITE [MPS priority indication] + Note left of MGCF: Reserve IMS Connection Point + MGCF->>IM-MGW: 2. H.248 ADD Req [C=?, T=?, Laddr=?, Lport=?, Local Resources, Priority] + IM-MGW-->>MGCF: 3. H.248 ADD Resp [C=C1, T=T2, Laddr=IP2o, LPort=P2o] + +``` + +Sequence diagram for Figure 9.4.4.1: Request to reserve MPS priority call resources when IM-MGW is congested, priority resources are allocated. The diagram shows the interaction between an MGCF and an IM-MGW. The MGCF sends an INVITE with MPS priority indication. It then attempts to reserve an IMS Connection Point, which triggers an H.248 ADD Req to the IM-MGW. The IM-MGW responds with an H.248 ADD Resp, indicating that it is in a congested state but has allocated priority resources to this call. + +Figure 9.4.4.1: Request to reserve MPS priority call resources when IM-MGW is congested, priority resources are allocated + +The IM-MGW may also provide priority allocation for resources requested via a subsequent Configure IMS resources procedure not including Priority information if the related context has been marked with priority information during the Reserve IMS Connection Point procedure or Reserve IMS Connection point and configure remote resources procedure. + +### 9.4.5 IM-MGW Priority User Data marking + +The MGCF may request the streams associated to an MPS call/session to be marked with a certain priority code point as described in clause 8.4. The IM-MGW shall then mark each IP packet header accordingly. The example sequence is shown in Figure 9.4.5.1. + +![Sequence diagram showing the request to reserve IMS resources and apply DSCP marking for MPS between MGCF and IM-MGW.](6d67eee81b97a14e06a6fe57a95aff36_img.jpg) + +``` +sequenceDiagram + participant External + participant MGCF + participant IM-MGW + Note left of MGCF: Reserve IMS Connection Point + External->>MGCF: 1. INVITE [MPS priority indication] + MGCF->>IM-MGW: 2. H.248 ADD Req [C=?, T= ?, Laddr = ?, Lport = ?, Local Resources, Diffserv Mark = DSCP1, Priority] + IM-MGW-->>MGCF: 3. H.248 ADD Resp [C=C1, T=T2, Laddr=IP2o, LPort=P2o] + Note right of IM-MGW: IM-MGW is requested to apply DSCP value in IP header of user data packets. +``` + +The diagram illustrates a sequence of interactions between an MGCF and an IM-MGW. It begins with an external INVITE message containing an MPS priority indication. The MGCF then sends an H.248 ADD Request to the IM-MGW, specifying parameters like C, T, Laddr, Lport, Local Resources, Diffserv Mark (DSCP1), and Priority. The IM-MGW responds with an H.248 ADD Response containing updated parameters like C=C1, T=T2, Laddr=IP2o, and LPort=P2o. A note on the right indicates that the IM-MGW is requested to apply the DSCP value in the IP header of user data packets. A bracket on the left side of the MGCF lifeline groups the INVITE and the subsequent H.248 messages under the label 'Reserve IMS Connection Point'. + +Sequence diagram showing the request to reserve IMS resources and apply DSCP marking for MPS between MGCF and IM-MGW. + +**Figure 9.4.5.1: Request to reserve IMS resources and apply DSCP marking for MPS** + +# --- Annex A (informative): Void + +# --- Annex B (normative): Codec Negotiation between a BICC CS network and the IM CN subsystem + +## B.1 Introduction + +This annex describes optional procedures for interworking of codec negotiation between a BICC CS network and the IM CN subsystem. + +## --- B.2 Control plane interworking + +The following optional procedures apply in addition to the procedures of clause 7.3 when both the BICC CS network and the IM CN subsystem support codec negotiation. All five variations of the bearer set-up procedures defined in clauses 7.4 and 7.5 of ITU-T Q.1902.4 [30] are supported. The codec negotiation procedures are also independent of the procedures for interworking between continuity procedures and SDP preconditions. + +### B.2.1 Incoming call interworking from SIP to BICC at I-MGCF + +#### B.2.1.1 Sending of IAM + +When the I-MGCF receives an INVITE with SDP offer, the I-MGCF shall follow the procedures of clause B.2.5 to convert the list of codecs in the SDP offer into a Supported Codec List for transmission in the outgoing IAM, according to clause 8.3.1 of ITU-T Q.1902.4 [30], and deleting those codecs not supported at the IM-MGW. When generating the Supported Codec List, the I-MGCF should add to the SDP offer all codec configurations for which it can provide transcoding. The I-MGCF shall allocate any IM-MGW resources as necessary to support the chosen bearer set-up procedures towards the BICC CS network. + +When the I-MGCF receives an INVITE without SDP offer, the I-MGCF shall continue call establishment without interworking of codec negotiation procedures. The mid-call interworking procedures of clause B.2.3 and clause B.2.4 may still apply. + +#### B.2.1.2 Sending of SDP answer + +The I-MGCF shall suspend the SDP answer procedure until it receives backward codec information from the BICC serving node terminating codec negotiation. When the I-MGCF receives the backward codec information, it shall select a codec configuration for use on the bearer interface to the IM CN subsystem from the codecs in the SDP offer, format an SDP answer based on this selected codec, send the SDP answer to the offerer in the appropriate SIP message (e.g., a reliable 18x response), and complete bearer establishment procedures. To avoid allocating a transcoder at the IM-MGW, the I-MGCF should preferably select a codec for the IM CN subsystem by converting the Selected Codec from the BICC CS network into an SDP answer according to the procedures of clause B.2.5, if allowed by the SDP offer/answer rules. Otherwise the I-MGCF should select the highest priority codec from the codecs in the received SDP offer supported by the IM-MGW for insertion in the SDP answer. Note that the I-MGCF stores the Available Codec List and does not send it to the offerer in the SDP answer. Codec negotiation is complete so it is not necessary for the offerer to begin a second phase offer/answer exchange using the PRACK request. + +### B.2.2 Outgoing call interworking from BICC to SIP at O-MGCF + +#### B.2.2.1 Sending of INVITE + +When the O-MGCF receives an IAM, the O-MGCF shall follow the procedures of clause B.2.5 to convert the Supported Codec List from the IAM into an SDP offer for transmission in the outgoing INVITE request, according to RFC 3264, deleting those codecs not supported at the IM-MGW. When generating the SDP offer, the O-MGCF should include all codec configurations for which it can provide transcoding in addition to those converted from the Supported Codec List. The O-MGCF shall include at least one AMR codec configuration in the SDP offer. The O-MGCF shall allocate any IM-MGW resources as necessary to support the inclusion of session address information in the SDP offer towards the IM CN subsystem. + +#### B.2.2.2 Responding to serving node initiating codec negotiation + +The O-MGCF shall suspend the incoming bearer set-up procedure while waiting for receipt of the SDP answer from the IM CN subsystem. When the O-MGCF receives the SDP answer while suspending the incoming bearer set-up procedure, it shall select a codec configuration for use on the bearer interface to the IM CN subsystem from the codecs in the SDP answer, construct the Available Codec List for the BICC CS network from the list of codecs received in the Supported Codec List by removing codecs not supported at the IM-MGW, choose the Selected Codec for the BICC CS network from the codecs in the Available Codec List, initiate the second SDP offer/answer exchange with the IM CN subsystem using the codec selected for the IM CN subsystem, if necessary, and resume the incoming bearer set-up procedure in the BICC CS network. The O-MGCF should select codecs for the bearer interfaces to the BICC CS network and IM CN subsystem in such a way as to avoid transcoding at the IM-MGW and minimize speech degradation, if possible, according to clause B.2.5. Otherwise the O-MGCF should choose the highest priority codec from the Available Codec List as the Selected Codec for the BICC CS network, and the highest priority codec from the codecs in the SDP answer as the codec for the IM CN subsystem. If the SDP answer only included a single voice codec, then there is no need for a second SDP offer/answer exchange, and the codec selected for the IM CN subsystem is the codec in the SDP answer. + +Certain BICC timers or events can force completion of the incoming bearer set-up procedure before the O-MGCF receives the SDP answer from the IM CN subsystem. In this case, the O-MGCF shall perform the terminating codec negotiation procedure according to clause 8.3.3 of ITU-T Q.1902.4 [30], including all supported codecs in the Available Codec List, and shall resume the incoming bearer set-up procedure without waiting any longer for the SDP answer. + +When an SDP answer arrives from the IM CN subsystem in response to the SDP offer in an INVITE request after the BICC incoming bearer set-up procedure has started, the O-MGCF shall select a codec configuration for use on the bearer interface to the IM CN subsystem from the codecs in the SDP answer, choose a new Selected Codec for the BICC CS network from the codecs in the Available Codec List constructed during incoming bearer set-up, and initiate the second SDP offer/answer exchange with the IM CN subsystem using the codec selected for the IM CN subsystem, if necessary. The O-MGCF should select codecs for the bearer interfaces to the BICC CS network and IM CN subsystem in such a way as to avoid transcoding at the IM-MGW and minimize speech degradation, if possible, according to clause B.2.5. Otherwise the O-MGCF should select the highest priority codecs from the available options for the two bearer interfaces. If the SDP answer only included a single voice codec, then there is no need for a second SDP offer/answer exchange, and the codec selected for the IM CN subsystem is the codec in the SDP answer. When the call in the BICC CS network enters a state capable of supporting codec modification, if the new Selected Codec is different from the Selected Codec chosen during the incoming bearer set-up procedure for the BICC CS network, the O-MGCF should initiate the codec modification procedure towards the BICC CS network using the new Selected Codec, according to clause 10.4.1 of ITU-T Q.1902.4 [30]. + +### B.2.3 Mid-call interworking from SIP to BICC at I-MGCF or O-MGCF + +#### B.2.3.1 Receipt of SDP offer + +When the MGCF receives a SIP message (e.g. UPDATE request or re-INVITE request) with an SDP offer that is not associated with incoming call bearer establishment or preconditions, if the call is in a state capable of supporting BICC codec negotiation, the MGCF shall follow the procedures of clause B.2.5 to convert the list of codecs in the SDP offer into a Supported Codec List, delete those codecs in the Supported Codec List not supported at the IM-MGW, and initiate the mid-call codec negotiation procedure according to clause 10.4.4 of ITU-T Q.1902.4 [30], by sending an APM with the Supported Codec List and an Action indicator set to "mid-call codec negotiation". When generating the Supported Codec List, the MGCF should add to the SDP offer all codec configurations for which it can provide transcoding. + +When the MGCF receives a SIP message with an SDP offer that is not associated with incoming call bearer establishment or preconditions, if the call is not in a state capable of supporting BICC codec negotiation, the MGCF shall respond to the SDP offer with existing procedures for the IM CN subsystem. When the call is in a state capable of supporting BICC codec negotiation, the MGCF may send a re-INVITE request without SDP towards the IM CN subsystem, soliciting a response with an SDP offer, thereby restarting the codec negotiation interworking procedure. + +#### B.2.3.2 Generating SDP answer + +After initiating a BICC codec negotiation procedure towards the BICC CS network in response to receipt of a SIP message with an SDP offer from the IM CN subsystem, the MGCF shall suspend the SDP answer procedure until it receives codec information from the succeeding BICC serving node. If the succeeding serving node returns a successful response, the MGCF shall select a codec configuration for use on the bearer interface to the IM CN subsystem from the codecs in the SDP offer, format an SDP answer based on this selected codec, send the SDP answer to the offerer in the appropriate SIP message (e.g. 200 OK (UPDATE) or 200 OK (INVITE)), send an APM to the succeeding serving node with an Action indicator set to "successful codec modification", and complete bearer establishment procedures. To avoid allocating a transcoder at the IM-MGW, the MGCF should preferably select a codec for the IM CN subsystem by converting the Selected Codec from the BICC CS network into an SDP answer according to the procedures of clause B.2.5, if allowed by the SDP offer/answer rules. Otherwise the MGCF should select the highest priority codec from the codecs in the received SDP offer supported by the IM-MGW for insertion in the SDP answer. Note that the MGCF stores the Available Codec List and does not send it to the offerer in the SDP answer. + +If the succeeding serving node returns an Action indicator set to "mid-call codec negotiation failure", the MGCF either should send a 488 response to the SDP offerer indicating rejection of the initial SDP offer, or should select the highest priority codec from the codecs in the received SDP offer supported by the IM-MGW, format an SDP answer based on this selected codec, and send the SDP answer to the offerer in the appropriate SIP message. If the MGCF sends a 488 response to the SDP offerer, it should continue the call with the bearer configuration in place before initiating this codec negotiation procedure. + +### B.2.4 Mid-call interworking from BICC to SIP at I-MGCF or O-MGCF + +#### B.2.4.1 Receipt of mid-call codec negotiation request + +When the MGCF receives an APM with an Action indicator set to "mid-call codec negotiation", the MGCF shall follow the procedures of clause B.2.5 to convert the Supported Codec List from the APM into an SDP offer for transmission in an appropriate SIP message (e.g. re-INVITE request) towards the IM CN subsystem, according to RFC 3264 [36], deleting those codecs not supported at the IM-MGW. When generating the SDP offer, the MGCF should include all codec configurations for which it can provide transcoding in addition to those converted from the Supported Codec List. The MGCF shall include at least one AMR codec configuration in the SDP offer. + +#### B.2.4.2 Responding to serving node initiating mid-call codec negotiation + +The MGCF shall delay responding to the mid-call codec negotiation from the BICC CS network until it receives a response to the SDP offer from the IM CN subsystem. If the MGCF receives an SDP answer, it shall construct the Available Codec List for the BICC CS network from the list of codecs received in the Supported Codec List by removing codecs not supported at the IM-MGW, choose the Selected Codec for the BICC CS network from the codecs in the Available Codec List, and complete the mid-call codec negotiation procedure towards the preceding serving node according to clause 10.4.5 of ITU-T Q.1902.4 [30]. The MGCF should choose the Selected Codec for the BICC CS network in such a way as to avoid transcoding at the IM-MGW and minimize speech degradation, if possible, according to clause B.2.5. Otherwise the MGCF should choose the highest priority codec from the Available Codec List for the Selected Codec for the BICC CS network. If the MGCF receives an APM from the preceding serving node with an Action indicator set to "codec modification failure", then the MGCF may initiate a new SDP offer/answer exchange towards the IM CN subsystem in an attempt to recreate the bearer configuration in place before this codec negotiation procedure began. + +If the MGCF receives a 488 response or other failure response (e.g. 3xx-6xx) to the SDP offer, either it should reject the mid-call codec negotiation from the BICC CS network by sending an APM with an Action indicator set to "mid-call codec negotiation failure" towards the preceding serving node, or it should continue as if it received an SDP answer with no change in codec selected for the IM CN subsystem. If the MGCF sends an APM with an Action indicator set to "mid-call codec negotiation failure", it should continue the call with the bearer configuration in place before initiating this codec negotiation procedure. + +#### B.2.4.3 Receipt of codec modification request + +If the MGCF receives an APM from a BICC CS network that includes an Action indicator set to "modify codec" with no change in the selected codec, it shall act as a serving node terminating codec modification, according to clause 10.4.2 of ITU-T Q.1902.4 [30], without interworking the procedure with the IM CN subsystem. + +If the MGCF receives an APM from a BICC CS network that includes an Action indicator set to "modify codec" and the new selected codec in the message is different from the Selected Codec at the IM-MGW bearer interface to the BICC CS network, the MGCF either may act as a serving node terminating codec modification, according to clause 10.4.2 of ITU-T Q.1902.4 [30], without interworking the procedure with the IM CN subsystem, or may follow the procedures of clause B.2.5 to convert the new Available Codec List (with new priority order) from the APM into an SDP offer for transmission in an appropriate SIP message (e.g. re-INVITE request) towards the IM CN subsystem, according to RFC 3264 [36], deleting those codecs not supported at the IM-MGW. When generating the SDP offer, the MGCF should include all codec configurations for which it can provide transcoding in addition to those converted from the new Available Codec List. The MGCF shall include at least one AMR codec configuration in the SDP offer. + +If the MGCF sends a SIP message with an SDP offer towards the IM CN subsystem in response to receipt of a BICC codec modification request, then it shall delay responding to the BICC codec modification request until it receives a response to the SDP offer from the IM CN subsystem. When the MGCF receives either an SDP answer or a rejection of the SDP offer within the appropriate SIP message (e.g. 200 OK (INVITE)) from the IM CN subsystem, it shall decide whether to accept or reject the BICC codec modification procedure and complete the procedure for a BICC serving node terminating codec modification, according to clause 10.4.2 of ITU-T Q.1902.4 [30]. + +If the MGCF sends an APM with an Action indicator set to "codec modification failure" in response to receipt of a codec modification request, the preceding BICC serving node may retry the request with a mid-call codec negotiation using an APM including an Action indicator set to "mid-call negotiation" and a Supported Codec List with a new priority order encouraging selection of a new codec. + +### B.2.5 Codec parameter translation between BICC CS network and the IM CN subsystem + +The IM CN subsystem uses the Session Description Protocol (SDP, defined in IETF RFC 4566 [56]) to select and potentially re-negotiate the codec type and configuration and associated bearer format attributes to be used in the user plane. IETF RFC 3550 [51] defines the Real Time Protocol (RTP) for framing of all codecs in the user plane, IETF RFC 3551 [52] and IETF RFC 3555 [53] define the framing details for many of the ITU-T codecs, and IETF RFC 4867 [23] defines framing details for the AMR family of codecs. This clause will focus only on codec-specific SDP parameters]. The signalling plane of the IM CN subsystem uses SDP offer/answer procedures defined in IETF RFC 3264 [36] to select the desired codec type and configuration for the user plane from a prioritized list of codec types and configurations and to re-negotiate the user plane attributes as necessary. + +The bearer independent CS network uses the Single Codec and Codec List information elements of the Application Transport Mechanism (APM) defined in ITU-T Recommendation Q.765.5 [35] to negotiate (offer and select) and potentially re-negotiate the codec type and configuration and associated bearer format attributes to be used in the user plane. 3GPP TS 29.414 [25] and 3GPP TS 29.415 [26] define the IuFP framing protocol for all codecs in the user plane for both ATM and IP transport, and 3GPP TS 26.102 [50] provides the framing details for AMR and PCM family codecs. The Codec List information element of the APM comprises multiple instances of the Single Codec information element in priority order, as shown in figure 13 of ITU-T Recommendation Q.765.5 [35]. Figure 14 of ITU-T Recommendation Q.765.5 [35] defines the Single Codec information element. Clause 11.1.7.2 of ITU-T Recommendation Q.765.5 [35] defines the encoding of the Single Codec information element for the ITU-T codecs. 3GPP TS 26.103 [57] defines the encoding of the Single Codec information element for the 3GPP codecs, and table 7.11.3.1.3-2 of 3GPP TS 28.062 [58] defines the preferred configurations of the narrowband AMR codecs (Config-NB-Code) for interoperation with TFO. The signalling plane of the bearer independent CS network uses the APM to negotiate the desired codec type and configuration for the user plane from the prioritized list of codec types and to re-negotiate the user plane attributes as necessary. + +The following clauses define the translations between the SDP payload format parameters of the IM CN subsystem and the corresponding subfields of the Single Codec information element of the bearer independent CS network for certain 3GPP and ITU-T codecs. Following these translation rules will in many cases allow the IM-MGW to perform interworking between the framing protocols on the bearer interfaces to the BICC CS network and the IM CN subsystem without transcoding. Implementations may signal other codec types not listed herein or other codec configurations of + +codec types listed herein. Implementations may also choose to perform transcoding between codec configurations signalled separately for the bearer interfaces to the networks, if necessary, but voice quality may suffer. + +#### B.2.5.1 Codec parameters for 3GPP AMR-NB codecs + +Table B.1 shows the correspondence between the codec format parameters in the Single Codec information element (3GPP TS 26.103 [57]) and the SDP for the 3GPP narrowband AMR codecs (IETF RFC 4867 [23]). + +**Table B.1: Mapping between Single Codec subfields and SDP parameters for 3GPP AMR-NB codecs** + +| Single Codec information element | | SDP payload format parameters | | | +|----------------------------------|-----------------------------------------------------------------------------|-------------------------------|---------------|----------------------------------------------------------------------------------| +| Codec Identification | ACS, SCS, OM, MACS | Payload Type number | Encoding name | Other Parameters (NOTE 1) (NOTE 2) | +| FR_AMR or OHR_AMR or HR_AMR | OM=0 or Selected Codec Type | dynamic | AMR | mode-set=values corresponding to ACS (NOTE 3) | +| FR_AMR or OHR_AMR or HR_AMR | (OM=1 or OM not present) and (Supported Codec List or Available Codec List) | dynamic | AMR | mode-set=select from values corresponding to ACS, SCS and MACS (NOTE 3) | +| UMTS_AMR | OM=0 or Selected Codec Type | dynamic | AMR | mode-set=values corresponding to ACS | +| UMTS_AMR | (OM=1 or OM not present) and (Supported Codec List or Available Codec List) | dynamic | AMR | mode-set=select from values corresponding to ACS, SCS and MACS (NOTE 4) | +| UMTS_AMR_2 | OM=0 or Selected Codec Type | dynamic | AMR | mode-set=values corresponding to ACS (NOTE 5) | +| UMTS_AMR_2 | (OM=1 or OM not present) and (Supported Codec List or Available Codec List) | dynamic | AMR | mode-set=select from values corresponding to ACS, SCS and MACS (NOTE 3) (NOTE 5) | + +NOTE 1: Table 1 of IETF RFC 4867 [23] provides the correspondence between codec rates and AMR modes for use when generating the "mode-set" parameter. When all modes are selected for use, the "mode-set" parameter shall not be included in SDP. + +NOTE 2: SDP payload format configurations in this table with only one value in the "mode-set" parameter shall not include the "mode-change-period" and "mode-change-neighbor" parameters. + +NOTE 3: Payload types for FR\_AMR, OHR\_AMR and HR\_AMR with more than one value in the "mode-set" parameter shall include the "mode-change-period=2", "mode-change-capability=2" parameters and should include the "mode-change-neighbor=1" parameter. + +NOTE 4: IETF RFC 4867 [23] does not currently provide a mechanism to signal the SCS, MACS or OM parameters in SDP, nor does it distinguish between the different AMR-NB codec types. Each AMR-NB codec type in the Supported Codec List or the Available Codec List with OM=1 should be translated into a list of SDP payload formats in priority order, where each includes a "mode-set" parameter with a unique value derived from the ACS, SCS and MACS. Each "mode-set" should correspond to a codec configuration that is compatible with the given codec type according to the compatibility rules defined in clauses 11 and 12 of TS 28.062 [58]. + +NOTE 5: Payload types for UMTS\_AMR\_2 should include the "mode-change-period=2", "mode-change-capability=2" and "mode-change-neighbor=1" parameters, normally used for signalling GSM AMR codecs, to assure end-to-end interoperability with OoBTC and TFO. Its actual capabilities would otherwise be signalled without these parameters. + +##### Definitions: + +**Supported Codec List:** contains the offered Codec Types and Configuration-possibilities of the node initiating codec negotiation in BICC (see also 3GPP TS 23.153). The Supported Codec List is sent from the initiating node forward to the terminating node. The Supported Codec List corresponds to an SDP offer during codec negotiation. + +**Available Codec List:** contains the offered Codec Types and Configuration-possibilities of the contiguous portion of the connection between initiating and terminating BICC nodes, including all intermediate nodes through the BICC network(s). The Available Codec List is sent from the BICC node terminating codec negotiation backward to the initiating node. The Available Codec List corresponds to information sometimes available in a first-round SDP answer. The Available Codec List might not represent an end-to-end view of the available Codec Types and Configuration-possibilities when traversing both BICC and SIP networks. + +**Selected Codec Type:** is determined by the node terminating codec negotiation. It specifies exactly the Codec Type and one unique Codec Configuration for the call. The Selected Codec Type corresponds to the final SDP answer. + +When translating from a Single Codec information element to the equivalent SDP payload format parameters, where either OM=0 (in the Supported or Available Codec List) or the information element is the Selected Codec Type, the SDP shall include a single payload type and any associated parameters from the corresponding row in table B.1. When translating from a Single Codec information element to the equivalent SDP payload format parameters, where OM=1 in the Supported or Available Codec List, the SDP shall only include payload formats corresponding to Codec Configurations compatible with the offered ACS, SCS and MACS, according to table B.1. Since the number of compatible payload formats can be large, implementations should select a reasonable subset of the higher-priority payload formats for inclusion in the SDP. When translating a list of Single Codec information elements into SDP, duplicate payload types (matching on all parameters) shall be removed. + +The following guidelines shall apply when translating from an SDP payload format specification to a Single Codec information element: + +- If there is no "mode-set" parameter for a payload format in the SDP and the SDP is to be translated into a Supported or Available Codec List, then the corresponding Single Codec subfields shall be OM=1, MACS=8, all SCS modes offered, and ACS modes offered. Alternatively it is sufficient to specify only the Codec Type (see below) and omit the other parameters. +- If there is no "mode-set" parameter for a payload format in an SDP answer that is to be translated into a Selected Codec Type, then the corresponding Single Codec subfields shall be derived from the payload type in the SDP offer (to which the SDP answer was sent in response). +- If there is a "mode-set" parameter for a payload format in the SDP, then the corresponding Single Codec subfields shall be OM=0 and ACS modes selected according to the value of "mode-set". The SCS shall be set identical to the ACS and MACS shall be set to the number of modes in the ACS. If this "mode-set" does not represent a valid configuration for the Codec Type (determined by OoBTC procedures), then the payload format shall not be translated. +- If a payload format in an SDP offer that is to be translated into a Supported Codec List includes "mode-change-period=2" parameter or includes "mode-change-capability=2" parameter, then the Codec Identification value for the corresponding Single Codec shall be FR\_AMR. +- If a payload format in an SDP answer that is to be translated into a Selected Codec Type or Available Codec List includes "mode-change-period=2", then the Codec Identification value for the corresponding Single Codec shall be one of FR\_AMR, HR\_AMR, OHR\_AMR or UMTS\_AMR\_2, if offered in the Supported Codec List. +- If a payload format in an SDP offer that is to be translated into a Supported Codec List does not include "mode-change-period=2" parameter and does not include "mode-change-capability=2" parameter, then the Codec Identification value for the corresponding Single Codec shall be UMTS\_AMR. +- If a payload format in an SDP answer that is to be translated into a Selected Codec Type or Available Codec List does not include "mode-change-period=2" parameter and does not include "mode-change-capability=2" parameter, then the Codec Identification value for the corresponding Single Codec shall be one of UMTS\_AMR\_2, FR\_AMR, HR\_AMR, OHR\_AMR or UMTS\_AMR, if offered in the Supported Codec List. + +#### B.2.5.2 Codec parameters for 3GPP AMR-WB codecs + +Table B.2 shows the correspondence between the codec format parameters in the Single Codec information element (3GPP TS 26.103 [57]) and the SDP for the 3GPP wideband AMR codecs (IETF RFC 4867 [23]). + +**Table B.2: Mapping between Single Codec subfields and SDP parameters for 3GPP AMR-WB codecs** + +| Single Codec information element | | SDP payload format parameters | | | +|----------------------------------|----------------|-------------------------------|----------------------------|--------------------------------------------------------------------| +| Codec Identification | Config-WB-Code | Payload Type number | Encoding name | Other Parameters
(NOTE 1) | +| FR_AMR-WB or
OHR_AMR-WB | 0 | dynamic | AMR-WB | mode-set=0,1,2 | +| OFR_AMR-WB or
UMTS_AMR-WB | 0 | dynamic | AMR-WB | mode-set=0,1,2
(NOTE 2) | +| OFR_AMR-WB or
UMTS_AMR-WB | 1 | dynamic
dynamic
dynamic | AMR-WB
AMR-WB
AMR-WB | mode-set=0,1,2
mode-set=0,1,2,8
mode-set=0,1,2,4
(NOTE 2) | +| OFR_AMR-WB or
UMTS_AMR-WB | 2 | dynamic | AMR-WB | mode-set=0,1,2,4
(NOTE 2) | +| OFR_AMR-WB or
UMTS_AMR-WB | 3 | dynamic
dynamic
dynamic | AMR-WB
AMR-WB
AMR-WB | mode-set=0,1,2,4
mode-set=0,1,2,8
mode-set=0,1,2
(NOTE 2) | +| OFR_AMR-WB or
UMTS_AMR-WB | 4 | dynamic | AMR-WB | mode-set=0,1,2,8
(NOTE 2) | +| OFR_AMR-WB or
UMTS_AMR-WB | 5 | dynamic
dynamic
dynamic | AMR-WB
AMR-WB
AMR-WB | mode-set=0,1,2,8
mode-set=0,1,2,4
mode-set=0,1,2
(NOTE 2) | + +NOTE 1: Payload types for FR\_AMR-WB, OHR\_AMR-WB and OFR\_AMR-WB shall include the "mode-change-period=2" and "mode-change-capability=2" parameters and should include the "mode-change-neighbor=1" parameter. + +NOTE 2: Payload types for UMTS\_AMR-WB should include the "mode-change-period=2", "mode-change-capability=2" and "mode-change-neighbor=1" parameters, normally used for signalling GSM AMR-WB codecs, to assure end-to-end interoperability with OoBTC and TFO. Its actual capabilities would otherwise be signalled without these parameters. + +When translating from a Single Codec information element to the equivalent SDP payload format parameters, the SDP shall include a distinct payload type and any associated parameters for each row in the table that matches the Config-WB-Code parameter. For example, OFR\_AMR-WB with Config-WB-Code=3 can generate three SDP payload types for AMR-WB, each including the "mode-change-period=2" parameter, the "mode-change-neighbor=1" parameter, and the "mode-set" parameter with value sets "0,1,2,4", "0,1,2,8", and "0,1,2", respectively. When translating a list of Single Codec information elements into SDP, duplicate payload types (matching on all parameters) shall be removed. + +The following guidelines shall apply when translating from one or more SDP payload format specifications to a Single Codec information element: + +- Payload formats that match except for different values of "mode-set" shall be represented with the fewest values of Config-WB-Code, while retaining the priority represented by the order of the payload formats in the SDP. For example, three SDP payload types for AMR-WB, each including the "mode-change-period=2" parameter, the "mode-change-neighbor=1" parameter, and the "mode-set" parameter with value sets "0,1,2,4", "0,1,2,8", and "0,1,2", respectively, will generate Config-WB-Code=3. +- If there is no "mode-set" parameter for a payload format in the SDP and the SDP is to be translated into a Supported or Available Codec List, then the corresponding Single Codec shall have a Config-WB-Code value of 1. +- If there is no "mode-set" parameter for a payload format in an SDP answer that is to be translated into a Selected Codec Type, then the corresponding Config-WB-Code value shall be derived from the payload type in the SDP offer (to which the SDP answer was sent in response). +- If a payload format in an SDP offer that is to be translated into a Supported Codec List includes "mode-change-period=2" parameter or includes "mode-change-capability=2" parameter, then the Codec Identification value for the corresponding Single Codec shall be OFR\_AMR-WB. + +- If a payload format in an SDP answer is to be translated into a Selected Codec Type or Available Codec List, then the Codec Identification value for the corresponding Single Codec shall be one of OFR\_AMR-WB, FR\_AMR-WB, OHR\_AMR-WB or UMTS\_AMR-WB, if offered in the Supported Codec List. +- If a payload format in an SDP offer that is to be translated into a Supported Codec List does not include "mode-change-period=2" parameter and does not include "mode-change-capability=2" parameter, then the payload format shall not be translated. + +#### B.2.5.3 Codec parameters for 3GPP non-AMR codecs + +Table B.3 shows the correspondence between the codec format parameters in the Single Codec information element (3GPP TS 26.103 [57]) and the SDP for the 3GPP non-AMR codecs (IETF RFC 4867 [23], IETF RFC 3551 [52], IETF RFC 3555 [53] and IETF RFC 5993 [114]). + +**Table B.3: Mapping between Single Codec subfields and SDP parameters for 3GPP non-AMR codecs** + +| Single Codec information element
Codec Identification | SDP payload format parameters | | | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------|---------------|------------------| +| | Payload Type number | Encoding name | Other Parameters | +| GSM FR | 3 | GSM | | +| GSM HR | dynamic | GSM-HR-08 | | +| GSM EFR (NOTE 1) | dynamic | GSM-EFR | | +| GSM EFR (NOTE 2) | dynamic | AMR | mode-set=7 | +| TDMA EFR (NOTE 2) | dynamic | AMR | mode-set=4 | +| PDC EFR (NOTE 2) | dynamic | AMR | mode-set=3 | +| NOTE 1: This translation for GSM EFR (GSM-EFR) is preferred to the alternative (AMR mode-set=7) if it is supported by the IM-MGW.
NOTE 2: AMR DTX is not compatible with the DTX schemes for any of the codecs in this list. The IM-MGW may support these configurations without transcoding by providing interworking between the DTX procedures and frame encodings on the bearer interfaces to the BICC CS network and the IM CN subsystem. | | | | + +#### B.2.5.4 Codec parameters for ITU-T codecs + +Table B.4 shows the correspondence between the codec format parameters in the Single Codec information element (Clause 11.1.7 of ITU-T Q.765.5 [35]) and the SDP for the ITU-T codecs (Table 4 of RFC 3551 [52], and RFC 3555 [53]). + +**Table B.4: Mapping between Single Codec subfields and SDP parameters for ITU-T codecs** + +| Single Codec information element | | | SDP payload format parameters | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------|-------------------------------------------------|------------------------------------------|------------------------------------------|-------------------------------------| +| Codec Type subfield | Codec Name | Codec Configuration subfield (dcba) | Payload Type number | Encoding name | Other Parameters | +| 00000001 | G.711 64 kbit/s A-law | N/A | 8 | PCMA | | +| 00000010 | G.711 64 kbit/s μ-law | N/A | 0 | PCMU | | +| 00000011 | G.711 56 kbit/s A-law | N/A | N/A | N/A | | +| 00000100 | G.711 56 kbit/s μ-law | N/A | N/A | N/A | | +| 00000101 | G.722 (SB-ADPCM) | N/A | 9 | G722 | | +| 00000110 | G.723.1 | N/A | 4 | G723 | annexa=no | +| 00000111 | G.723.1 Annex A (silence suppression) | N/A | 4 | G723 | | +| 00001000 | G.726 (ADPCM) | xxx1
xx1x
x1xx
1xxx | dynamic
dynamic
dynamic
dynamic | G726-16
G726-24
G726-32
G726-40 | | +| 00001001 | G.727 (Embedded ADPCM) | xxxx | N/A | N/A | | +| 00001010 | G.728 | 111
(subsets of defined rates not supported) | 15 | G728 | | +| 00001011 | G.729 (CS-ACELP) | xx1
x1x
1xx | dynamic
18
dynamic | G729D
G729
G729E | annexb=no
annexb=no
annexb=no | +| 00001100 | G.729 Annex B (silence suppression) | xx1
x1x
1xx | dynamic
18
dynamic | G729D
G729
G72"E" | | +| NOTE: An "x" in a bit position of the Codec Configuration subfield indicates a "don't care" value. The SDP payload description for each listed codec includes a clock rate of 8000 Hz. TS 26.102 [50] only describes the BICC CS network framing for the PCM codecs. | | | | | | + +When translating from a Single Codec information element to the equivalent SDP payload format parameters, the SDP shall include a distinct payload type and any associated parameters for each matching instance of the Codec Configuration subfield. For example, G.726 (ADPCM) with Codec Configuration subfield "0101" shall generate SDP payload types for G726-32 and G726-16. + +When translating from an SDP payload format specification to the Single Codec information element, each SDP payload type should be represented by one matching Single Codec information element. For example, SDP payload types for G729 and G729E may generate one Single Codec information element for "G.729 Annex B" with Codec Configuration subfield "110". The G729 and G729E codecs may alternately be represented by two Single Codec information elements for "G.729 Annex B" with Codec Configuration subfields "100" and "010", respectively, if it is necessary to indicate preference between them. + +#### B.2.5.5 Codec parameters for 3GPP EVS codec + +Table B.2.5.5.1 and table B.2.5.5.2 show the correspondence between the codec format parameters in the Single Codec information element (3GPP TS 26.103 [57]) and the SDP for the 3GPP EVS codec (3GPP TS 26.445 [147]). + +**Table B.2.5.5.1: Mapping from Single Codec subfields UMTS\_EVS (Config-EVS-Code / Config-EVS-Code 2) to SDP parameters for 3GPP EVS codec** + +| Single Codec information element | | SDP payload format parameters | | | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------|--------------------------------------|-------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Codec Type | Config-EVS-Code / Config-EVS-Code 2 (NOTE 2) | Payload Type number | Encoding name
clock rate
encoding parameters
| Other Parameters
(NOTE 1)
| +| UMTS_EVS | 0 | Dynamic | EVS
16000
1 | br=5.9-8
bw=nb-wb
mode-set=0
mode-change-period=2
[mode-change-capability=2]
mode-change-neighbor=1
[dtx-recv=1]
[dtx=1]
cmr=1
ch-aw-recv=-1 | +| UMTS_EVS | 1 | Dynamic | EVS
16000
1 | br=5.9-13.2
bw=nb-swb
mode-set=0, 1, 2
mode-change-period=2
[mode-change-capability=2]
mode-change-neighbor=1
[dtx-recv=1]
[dtx=1]
cmr=1
ch-aw-recv={-1;0} | +| UMTS_EVS | 2 | Dynamic | EVS
16000
1 | br=5.9-24.4
bw=nb-fb
mode-set=0, 1, 2
mode-change-period=2
[mode-change-capability=2]
mode-change-neighbor=1
[dtx-recv=1]
[dtx=1]
cmr=1
ch-aw-recv={-1;0} | +| UMTS_EVS | 3 (NOTE 3) | Dynamic | EVS
16000
1 | br=9.6-13.2
bw=swb
mode-set=0, 1, 2
mode-change-period=2
[mode-change-capability=2]
mode-change-neighbor=1
[dtx-recv=1]
[dtx=1]
cmr=1
ch-aw-recv={-1;0} | +| NOTE 1: Square brackets "[ ]" indicate that the enclosed parameters may be omitted. Curved brackets "{ }" indicate a list of alternative values, separated by ";".
NOTE 2: If both Config-EVS-Code and Config-EVS-Code 2 subfields are included in the Single Codec information element, the SDP includes a distinct payload and any associated parameter for each subfield.
NOTE 3: This value is not applicable to Config-EVS-Code 2 subfield. | | | | | + +When translating a list of Single Codec information elements into SDP, duplicate payload types (matching on all parameters) shall be removed. + +NOTE: the number of Codecs included in the BICC-Offer is limited to 8. It is therefore not always possible to include more than one EVS Single Codec information element in a BICC-Offer. The EVS Single Codec information element can contain up to 2 EVS configurations in a BICC-Offer. + +**Table B.2.5.5.2: Mapping from SDP parameters for 3GPP EVS to Single Codec subfields UMTS\_EVS (Config-EVS-Code / Config-EVS-Code 2)** + +| SDP payload format parameters | | | Single Codec Information Element | | +|-------------------------------|----------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------|---------------------------------------------------------------------------------------------| +| Payload Type number | encoding name
clock rate
encoding parameters
(NOTE 1) | Other Parameters (NOTE 1) | Codec Type | Config-EVS-Code/
Config-EVS-Code 2
(NOTE 3) | +| Dynamic | EVS
16000
[1] | br=5.9[-br2]; br2 = {8; ... 128}
bw=nb[-bw2]; bw2 = {wb;swb;fb}
[dtx=1]
[mode-set={0; 0,1,2}]
[mode-change-period=2]
[mode-change-capability=2]
[mode-change-neighbor=1]
[cmr={0,1}] NOTE 2 | UMTS_EVS | 0 if no br2;
0 if br2=8;
1 if
br2=13.2;
2 if
br2=24.4;
2 if br2 >
24.4 | +| Dynamic | EVS
16000
[1] | br=9.6[-br2]; br2 = {13.2; ... 128}
bw=swb
[dtx=1]
[mode-set={0; 0,1,2}]
[mode-change-period=2]
[mode-change-capability=2]
[mode-change-neighbor=1]
[cmr={0,1}] NOTE 2 | UMTS_EVS | 3 (NOTE 4) | + +NOTE 1: Square brackets "[ ]" indicate that the enclosed parameters may be omitted. Curved brackets "{ }" indicate a list of alternative values, separated by ";". + +NOTE 2: This mapping also applies if a cmr parameter with a value "-1" is received in the SDP body and if the IM-MGW supports RTCP-APP-CMR message as described in subclause 8.1.1.3.5. + +NOTE 3: If the Single Codec Information Element is included in a Selected Codec (BICC), only Config-EVS-Code is included. + +NOTE 4: This value is not applicable to Config-EVS-Code 2 subfield. + +The IM-MGW can handle the call without transcoding only if the received SDP offer or SDP answer is compliant with one of the entries in table B.2.5.5.2. + +The following guidelines shall apply when translating from one or more SDP payload format specifications to a Single Codec information element: + +- Payload formats that match except for different values of "mode-set" shall be represented with the fewest values of Config-EVS-Code 1 and optionally Config-EVS-Code 2, while retaining the priority represented by the order of the payload formats in the SDP. + +## B.3 MGCF - IM-MGW interaction during interworking of codec negotiation + +### B.3.1 Basic IM CN subsystem originated session + +This clause shows an example of the interworking of codec negotiation between an IM CN subsystem and a BICC CS network during session establishment for an IM CN subsystem originated session. The example applies to BICC forward bearer establishment. Similar procedures apply to the other four versions of bearer establishment procedure applicable to the BICC CS network. The exchange of codec information is identical in all five cases, but there are differences in the sequence of operations associated with bearer establishment within the BICC CS network. + +#### B.3.1.1 BICC forward bearer establishment + +##### B.3.1.1.1 IM-MGW selection + +The MGCF shall select an IM-MGW for the bearer connection before it performs the CS network side bearer establishment. This may happen either before sending the IAM or after receiving the APM message (signal 3 or signal 4 + +in figure B.1). In the latter case, the IM-MGW selection may be based on a possibly received MGW-id from the succeeding node. + +##### B.3.1.1.2 CS network side bearer establishment + +The MGCF shall either select bearer characteristics or request the IM-MGW to select and provide the bearer characteristics for the CS network side bearer connection before sending the IAM. In the latter case the MGCF shall use the Prepare Bearer procedure, not shown in figure B.1, to request the IM-MGW to select the bearer characteristics. After the succeeding node has provided a bearer address and a binding reference in the APM, the MGCF shall use the Establish Bearer procedure to request the IM-MGW to establish a bearer towards the destination CS-MGW. The MGCF shall provide the IM-MGW with the bearer address, the binding reference and the bearer characteristics (signal 5 in figure B.1). + +##### B.3.1.1.3 IM CN subsystem side session establishment + +When the MGCF receives the Selected Codec from the succeeding serving node in the CS network (signal 4 in figure B.1) and selects a codec for use in the IM CN subsystem, the MGCF shall initiate the Reserve IMS Connection Point and Configure Remote Resources procedure (signal 7 and 8 in figure B.1). From the received SDP and selected configuration data the MGCF: + +- Shall send the appropriate remote codec(s), the remote UDP port and the remote IP address to the IM-MGW. The remote UDP port and IP address refer to the destination of user plane data sent towards the IM CN subsystem. The remote codec(s) are the codec(s) the IM-MGW may select for user plane data sent towards the IM CN subsystem. +- Shall indicate to the IM-MGW the appropriate local codec(s) and request a local IP address and UDP port. The local IP address and UDP port are used by the IM-MGW to receive user plane data from the IM CN subsystem. The local codec(s) are the codec(s) the IM-MGW may select to receive user plane data from the IM CN subsystem. +- If DTMF support together with speech support is required, the reserve value indicator shall be set to "true". + +The IM-MGW: + +- Shall reply to the MGCF with the selected local codec(s) and the selected remote codec(s) and the selected local UDP port and IP address. +- Shall reserve resources for those codec(s). + +The MGCF shall send the local codec(s), UDP port and IP address to the IMS in the Session Progress (signal 9 in figure B.1). + +##### B.3.1.1.4 Through-connection + +During the Prepare Bearer and Establish Bearer procedures, the MGCF shall either use the Change Through-Connection procedure to request the IM-MGW to backward through-connect the BICC terminations, or the MGCF shall use this procedure to both-way through-connect the BICC termination already on this stage (signal 5 in figure B.1). During the Reserve IMS Connection Point procedure: + +- if the MGCF has been identified a call as an "ICS call" as specified in clause 7.3.3.1.2.n the MGCF shall request the IM-MGW to suspend sending media towards the IMS side by setting the through-connection of the IM CN subsystem side termination to "not through-connected" using the Change IMS Through-Connection procedure (signal 7 in figure B.1); and +- otherwise the MGCF shall use the Change IMS Through-Connection procedure to request the IM-MGW to backward through-connect the IMS termination (signal 7 in figure B.1). + +When the MGCF receives the BICC:ANM answer indication, it shall request the IM-MGW to both-way through-connect the termination using the Change Through-Connection or Change IMS Through-Connection procedures (signal 20 in figure B.1), unless those terminations are already both-way through-connected. + +##### B.3.1.1.5 Codec handling + +The IM-MGW may include a speech transcoder based upon the speech coding information provided to each termination. + +##### B.3.1.1.6 Failure handling in MGCF + +If any procedure between the MGCF and the IM-MGW is not completed successfully the default action by the MGCF is to release the session, as described in clause 9.2.6. If the MGCF receives a Bearer Released procedure from the IM-MGW the default action by the MGCF is to release the session as described in clause 9.2.7. + +NOTE: As an implementation option the MGCF may also decide for example to only release the resources in the IM-MGW that caused the failure, possibly select a new IM-MGW for the connection and continue the call establishment using new resources in the selected IM-MGW but such handling is outside of the scope of the present document. + +##### B.3.1.1.7 Message sequence chart + +Figure B.1 shows the message sequence chart for the IM CN subsystem originating session with BICC forward bearer establishment where the selection of IM-MGW is done after receipt of the APM. The MGCF then requests the seizure of a CS network side bearer termination and the establishment of the bearer. When the MGCF receives an answer indication, it requests the IM-MGW to both-way through-connect the terminations. + +![Sequence diagram showing Basic IM CN Subsystem originating session, BICC forward bearer establishment between MGCF and IM-MGW.](9cd6ff4a43174e4afe1cc5e4ea2fcae4_img.jpg) + +``` + +sequenceDiagram + participant Client + participant MGCF + participant IM-MGW + Note left of Client: Establish Bearer, Change Through-Connection = both + Note left of Client: Reserve IMS Connection Point and Configure Remote Resources, Change IMS Through-Connection = backward + Note right of IM-MGW: Bearer Establishment + Note right of IM-MGW: Change IMS Through-Connection = both + + Client->>MGCF: 1. SIP: INVITE [supported codec list 1] + MGCF-->>Client: 2. SIP: 100 Trying + MGCF->>IM-MGW: 3. BICC: IAM [supported codec list 2] + IM-MGW-->>MGCF: 4. BICC: APM [selected codec 2] + MGCF->>IM-MGW: 5. H.248: ADD.req [Context ID = ?, Termination ID=?] + IM-MGW-->>MGCF: 6. H.248: ADD.resp [Context ID = C1, Termination ID = T2] + MGCF->>IM-MGW: 7. H.248: ADD.req [Context ID = C1, Termination ID = ?] + IM-MGW-->>MGCF: 8. H.248: ADD.resp [Context ID = C1, Termination ID = T1] + MGCF-->>Client: 9. SIP: 183 [selected codec 1] + Client->>MGCF: 10. SIP: PRACK + MGCF-->>Client: 11. SIP: 200 OK (PRACK) + MGCF-->>Client: 12. SIP: UPDATE + MGCF->>IM-MGW: 14. BICC: COT + IM-MGW-->>MGCF: 15. BICC: ACM + MGCF-->>Client: 16. SIP: 180 Ringing + Client->>MGCF: 17. SIP: PRACK + MGCF-->>Client: 18. SIP: 200 OK (PRACK) + MGCF->>IM-MGW: 19. BICC: ANM + MGCF->>IM-MGW: 20. H.248: MOD.req [Context ID=C1, Termination ID = T1] + IM-MGW-->>MGCF: 21. H.248: MOD.resp [Context ID = C1, Termination ID = T1] + MGCF-->>Client: 22. SIP: 200 OK (INVITE) + Client->>MGCF: 23. SIP: ACK + + Note over MGCF, IM-MGW: CALL IN ACTIVE STATE + +``` + +The sequence diagram illustrates the interaction between a Client, MGCF, and IM-MGW for a Basic IM CN Subsystem originating session. The process involves SIP signaling for call setup and BICC/H.248 signaling for bearer establishment and resource configuration. The MGCF acts as a bridge between the SIP client and the IM-MGW. The IM-MGW performs bearer establishment and IMS connection point configuration. The diagram is divided into two main phases: initial setup and bearer establishment/modification. A 'CALL IN ACTIVE STATE' is indicated at the bottom, spanning from the first H.248 ADD.req to the final SIP ACK. + +Sequence diagram showing Basic IM CN Subsystem originating session, BICC forward bearer establishment between MGCF and IM-MGW. + +Figure B.1: Basic IM CN Subsystem originating session, BICC forward bearer establishment (message sequence chart) + +### B.3.2 Basic CS network originated session + +This clause shows an example of the interworking of codec negotiation between a BICC CS network and an IM CN subsystem during session establishment for a BICC CS network originated session. The example applies to BICC forward bearer establishment. Similar procedures apply to the other four versions of bearer establishment procedure applicable to the BICC CS network. The exchange of codec information is identical in all five cases, but there are differences in the sequence of operations associated with bearer establishment within the BICC CS network. + +#### B.3.2.1 BICC forward bearer establishment + +##### B.3.2.1.1 IM-MGW selection + +The MGCF shall select an IM-MGW for the bearer connection before it performs the IM CN subsystem session establishment or the CS network side bearer establishment. + +##### B.3.2.1.2 IM CN subsystem side termination reservation + +The MGCF shall derive from the codec negotiation procedure one or several appropriate local codec(s) the IM-MGW may use to receive user plane data from the IM CN subsystem. The MGCF shall use the Reserve IMS Connection Point procedure (signals 2 and 3 in figure B.2/1). Within this procedure, the MGCF shall indicate the local codec(s) and request a local IP address and UDP port from the IM-MGW. The local IP address and UDP port are used by the IM-MGW to receive user plane data from the IM CN subsystem. If DTMF support together with speech support is required, or if the resources for multiple speech codecs shall be reserved at this stage, the reserve value indicator shall be set to "true". + +The IM-MGW shall reply to the MGCF with the selected local codec(s) and the selected local IP address and UDP port. + +The MGCF shall send this information in the INVITE (signal 4 in figure B.2/1) to the IM CN subsystem. + +##### B.3.2.1.3 IM CN subsystem side session establishment + +The MGCF shall use the Configure IMS Resources procedure (signals 7 and 8 in figure B.2/1) to provide configuration data (derived from SDP received in signal 6 in figure B.2/1 and the codec negotiation procedure) to the IM-MGW as detailed below: + +- The MGCF shall indicate the remote IP address and UDP port, i.e. the destination IP address and UDP port for data sent in the user plane towards the IM CN subsystem, +- The MGCF shall indicate the remote codec(s), i.e. the speech codec(s) for data sent in the user plane towards the IM CN subsystem. +- The MGCF may indicate the local codec(s) and the local IP address and UDP port. The MGCF shall indicate the local codec(s) if a change is required. +- IF DTMF support together with speech support is required, the reserve value indicator shall be set to "true". + +The IM-MGW shall reply with the selected remote codec(s) and reserve resources for these codec(s). If local codec(s) were received, the IM-MGW shall also reply with the selected local codec(s) and reserve the corresponding resources. + +If the selected local codec(s) differ from the codec(s) received in the SDP of signal 6 in figure B.2/1, the MGCF shall send the local reserved codec(s), and the local IP address and UDP port in the PRACK (signal 9 in figure B.2/1) to the IMS. + +##### B.3.2.1.4 CS network side bearer establishment + +The MGCF shall request the IM-MGW to prepare for the CS network side bearer establishment using the Prepare Bearer procedure (signals 11 and 12 in figure B.2/1). Within this procedure, the MGCF shall request the IM-MGW to provide a bearer address, a binding reference and optionally notify when the bearer is established. The MGCF shall also provide the IM-MGW with the bearer characteristics determined by the codec negotiation procedure. After the IM-MGW has replied with the bearer address and the binding reference, the MGCF provides the APM message (signal 13 in figure B.2/1) to the preceding node. The MGCF may also provide the IM-MGW-id in the APM message. + +##### B.3.2.1.5 Called party alerting + +The MGCF shall request the IM-MGW to provide an awaiting answer indication (ringing tone) to the calling party using the Send Tone procedure (signals 21 and 22 in figure B.2/1), when the following condition is satisfied: + +- the MGCF receives the first 180 Ringing message + +##### B.3.2.1.6 Called party answer + +When the MGCF receives a 200 OK message (signal 23 in figure B.2/2), it shall request the IM-MGW to stop providing the ringing tone to the calling party using the Stop Tone procedure (signals 26 and 27 in figure B.2/2). + +##### B.3.2.1.7 Through-Connection + +During the Prepare Bearer procedure, the MGCF shall either use the Change Through-Connection procedure to request the IM-MGW to backward through-connect the BICC termination, or the MGCF shall use this procedure to both-way through-connect the BICC termination already on this stage (signals 11 and 12 in figure B.2/1). During the Reserve IMS Connection Point procedure, the MGCF shall use the Change IMS Through-Connection procedure to request the IM-MGW to backward through-connect the IMS termination (signals 2 and 3 in figure B.2/1). + +When the MGCF receives the SIP 200 OK(INVITE) (signal 23 in figure B.2/2), it requests the IM-MGW to both-way through-connect the terminations using the Change IMS Through-Connection or Change Through-Connection procedures (signals 28 and 29 in figure B.2/2), unless those terminations are already both-way through-connected. + +##### B.3.2.1.8 Codec handling + +The IM-MGW may include a speech transcoder based upon the speech coding information provided to each termination. + +##### B.3.2.1.9 Failure handling in MGCF + +If any procedure between the MGCF and the IM-MGW is not completed successfully, the default action by the MGCF is to release the session as described in clause 9.2.6. If the MGCF receives a Bearer Released procedure from the IM-MGW the default action by the MGCF is to release the session, as described in clause 9.2.7. + +NOTE: As an implementation option the MGCF may also decide for example to only release the resources in the IM-MGW that caused the failure, possibly select a new IM-MGW for the connection and continue the call establishment using new resources in the selected IM-MGW but such handling is outside of the scope of the present document. + +##### B.3.2.1.10 Message sequence chart + +Figures B.2/1 and B.2/2 show the message sequence chart for the CS network originating session with BICC forward bearer establishment. + +![Sequence diagram showing Basic CS Network Originating Session, BICC forward bearer establishment between IM-MGW and MGCF.](c21bad844b5cb6026c067a1f43ce67c3_img.jpg) + +``` + +sequenceDiagram + participant IM-MGW + participant MGCF + Note left of IM-MGW: Configure IMS Resources + IM-MGW->>MGCF: 1. BICC: IAM [supported codec list 1] + MGCF-->>IM-MGW: 2. H.248: ADD.req [Context ID = ?, Termination ID=?] + Note right of MGCF: Reserve IMS Connection Point, Change IMS Through-Connection = backward + IM-MGW->>MGCF: 3. H.248: ADD.resp [Context ID = C1, Termination ID = T1] + MGCF->>External: 4. SIP: INVITE [supported codec list 2] + External-->>MGCF: 5. SIP: 100 Trying + MGCF-->>External: 6. SIP: 183 [available codec list 2] + IM-MGW->>MGCF: 7. H.248: MOD.req Context ID = C1, Termination ID = T1] + IM-MGW->>MGCF: 8. H.248: MOD.resp [Context ID = C1, Termination ID = T1 ] + MGCF-->>External: 9. SIP: PRACK [selected codec 2] + External-->>MGCF: 10. SIP :200 OK (PRACK) [selected codec 2] + IM-MGW->>MGCF: 11. H.248: ADD.req [Context ID = C1, Termination ID = ?] + Note right of MGCF: Prepare Bearer, Change Through-Connection= both + IM-MGW->>MGCF: 12. H.248: ADD.resp [Context ID = C1, Termination ID = T2] + IM-MGW->>External: 13. BICC: APM [selected codec 1, available codec list 1] + Note left of IM-MGW: Bearer Establishment + IM-MGW->>MGCF: 14. BICC: COT + MGCF-->>External: 15. SIP: UPDATE + External-->>MGCF: 16. SIP :200 OK (UPDATE) + MGCF-->>External: 17. SIP :180 Ringing + MGCF-->>External: 18. SIP: PRACK + External-->>MGCF: 19. SIP :200 OK (PRACK) + IM-MGW->>External: 20. BICC: ACM + IM-MGW->>MGCF: 21. H.248: MOD.req [Context ID = C1, Termination ID = T2] + Note right of MGCF: Send Tone + IM-MGW->>MGCF: 22. H.248: MOD.resp [Context ID = C1, Termination ID = T2] + +``` + +The sequence diagram illustrates the interaction between the IM-MGW and the MGCF for a Basic CS Network Originating Session. The process begins with the IM-MGW sending a BICC: IAM message to the MGCF. The MGCF responds with an H.248: ADD.req, and the IM-MGW replies with an H.248: ADD.resp. The MGCF then sends a SIP: INVITE to an external entity, which responds with a 100 Trying and a 183 (available codec list 2). The MGCF sends a H.248: MOD.req to the IM-MGW, which responds with an H.248: MOD.resp. The MGCF sends a SIP: PRACK to the external entity, which responds with a 200 OK (PRACK). The IM-MGW sends a H.248: ADD.req to the MGCF, which responds with an H.248: ADD.resp. The IM-MGW then sends a BICC: APM message to the external entity. The IM-MGW sends a BICC: COT message to the MGCF, which responds with a SIP: UPDATE, which is acknowledged by a 200 OK (UPDATE). The MGCF sends a SIP: 180 Ringing to the external entity, which responds with a SIP: PRACK, which is acknowledged by a 200 OK (PRACK). The IM-MGW sends a BICC: ACM message to the external entity. The IM-MGW sends a H.248: MOD.req to the MGCF, which responds with an H.248: MOD.resp. The MGCF sends a tone to the external entity. + +Sequence diagram showing Basic CS Network Originating Session, BICC forward bearer establishment between IM-MGW and MGCF. + +Figure B.2/1: Basic CS Network Originating Session, BICC forward bearer establishment (message sequence chart) + +![Sequence diagram showing message exchanges between IM-MGW and MGCF. The diagram includes steps 23 through 29, with annotations like 'Stop Tone' and 'Change IMS Through-Connection = both'. A bracket at the bottom indicates 'CALL IN ACTIVE STATE'.](b50f38be091844d58b11e3d47bc71e73_img.jpg) + +The sequence diagram illustrates the interaction between an IM-MGW and an MGCF. The sequence of messages is as follows: + +- 23. **SIP**: 200 OK (INVITE) - Received by MGCF from an external source. +- 24. **H.248**: MOD.req [Context ID=C1, Termination ID = T2] - Sent from MGCF to IM-MGW. An annotation "Stop Tone" is present next to this message. +- 25. **H.248**: MOD.resp [Context ID = C1, Termination ID = T2] - Sent from IM-MGW to MGCF. +- 26. **H.248**: MOD.req [Context ID=C1, Termination ID = T1] - Sent from MGCF to IM-MGW. +- 27. **H.248**: MOD.resp [Context ID = C1, Termination ID = T1] - Sent from IM-MGW to MGCF. An annotation "Change IMS Through-Connection = both" is present next to this message. +- 28. **BICC**: ANM - Sent from MGCF to an external destination (indicated by a leftward arrow). +- 29. **SIP**: ACK - Sent from MGCF to an external destination (indicated by a rightward arrow). + +A horizontal double-headed arrow at the bottom of the diagram, spanning the time between steps 24 and 28, is labeled "CALL IN ACTIVE STATE". + +Sequence diagram showing message exchanges between IM-MGW and MGCF. The diagram includes steps 23 through 29, with annotations like 'Stop Tone' and 'Change IMS Through-Connection = both'. A bracket at the bottom indicates 'CALL IN ACTIVE STATE'. + +Figure B.2/2: Basic CS Network Originating Session, BICC forward bearer establishment (message sequence chart continued) + +### B.3.3 CS network initiated mid-call codec negotiation + +Figure B.3 shows the CS network initiated mid-call codec negotiation procedure interworking with the IM CN subsystem. When the MGCF selects the codecs for the CS network and the IM CN subsystem (after signal 3 in figure B.3), the MGCF shall modify the CS network termination and the IM CN subsystem termination on the IM-MGW to conform to the newly selected configuration data on the two interfaces. The MGCF may perform bearer operations (not shown) at the IM-MGW before interworking the initial codec modification request (signal 2 in figure B.3) to determine new connection information, if necessary, or to verify resource availability. + +![Sequence diagram for CS network initiated mid-call codec negotiation between IM-MGW and MGCF.](5d5ec4f1999e7c46d426dddc16ba1e08_img.jpg) + +``` +sequenceDiagram + participant IM-MGW + participant MGCF + Note left of IM-MGW: Configure IMS Resources + IM-MGW->>MGCF: 1. BICC: APM [supported codec list 1] + MGCF->>IM-MGW: 2. SIP: re-INVITE [supported codec list 2] + MGCF-->>IM-MGW: 3. SIP: 200 OK (INVITE) [selected codec 2] + Note left of IM-MGW: Modify Bearer Characteristics + IM-MGW->>MGCF: 4. H.248: MOD.req Context ID = C1, Termination ID = T1] + MGCF->>IM-MGW: 5. H.248: MOD.resp [Context ID = C1, Termination ID = T1 ] + IM-MGW->>MGCF: 6. H.248: MOD.req [Context ID = C1, Termination ID = T2] + MGCF->>IM-MGW: 7. H.248: MOD.resp [Context ID = C1, Termination ID = T2] + MGCF-->>IM-MGW: 8. SIP: ACK + IM-MGW->>MGCF: 9. BICC: APM [selected codec 1] + MGCF->>IM-MGW: 10. BICC: APM [action = successful codec modification] +``` + +The sequence diagram illustrates the interaction between the IM-MGW and the MGCF for mid-call codec negotiation. The process begins with the IM-MGW sending a BICC: APM message with a supported codec list to the MGCF. The MGCF responds with a SIP: re-INVITE containing a supported codec list. The MGCF then sends a SIP: 200 OK (INVITE) with the selected codec. The IM-MGW then sends an H.248: MOD.req for Context ID = C1, Termination ID = T1. The MGCF responds with an H.248: MOD.resp. The IM-MGW then sends an H.248: MOD.req for Context ID = C1, Termination ID = T2. The MGCF responds with an H.248: MOD.resp. The MGCF then sends a SIP: ACK. The IM-MGW sends a BICC: APM with the selected codec to the MGCF. Finally, the MGCF sends a BICC: APM with the action = successful codec modification to the IM-MGW. + +Sequence diagram for CS network initiated mid-call codec negotiation between IM-MGW and MGCF. + +Figure B.3: CS network initiated mid-call codec negotiation +(message sequence chart) + +### B.3.4 IM CN subsystem initiated mid-call codec negotiation + +Figure B.4 shows the IM CN subsystem initiated mid-call codec negotiation procedure interworking with a BICC CS network. When the MGCF selects the codecs for the CS network and the IM CN subsystem (after signal 3 in figure B.4), the MGCF shall modify the CS network termination and the IM CN subsystem termination on the IM-MGW to conform to the newly selected configuration data on the two interfaces. The MGCF may perform bearer operations (not shown) at the IM-MGW before interworking the initial codec modification request (signal 2 in figure B.3) to determine new connection information, if necessary, or to verify resource availability. The MGCF may also perform bearer operations (not shown) at the IM-MGW after sending the final APM (signal 8 in figure B.4) to modify transport bandwidth, if necessary. + +![Sequence diagram for IM CN subsystem initiated mid-call codec negotiation between IM-MGW and MGCF.](ddb58f51e65a3ae8ebc5911df26e18e0_img.jpg) + +``` +sequenceDiagram + participant IM-MGW + participant MGCF + Note right of MGCF: 1. SIP: re-INVITE [supported codec list 1] + MGCF->>IM-MGW: 2. BICC: APM [supported codec list 2] + IM-MGW->>MGCF: 3. BICC: APM [supported codec list 2] + Note left of IM-MGW: Configure IMS Resources + MGCF->>IM-MGW: 4. H.248: MOD.req [Context ID = C1, Termination ID = T1] + IM-MGW->>MGCF: 5. H.248: MOD.resp [Context ID = C1, Termination ID = T1] + Note left of IM-MGW: Modify Bearer Characteristics + MGCF->>IM-MGW: 6. H.248: MOD.req [Context ID = C1, Termination ID = T2] + IM-MGW->>MGCF: 7. H.248: MOD.resp [Context ID = C1, Termination ID = T2] + IM-MGW->>MGCF: 8. BICC: APM [action = successful codec modification] + Note right of MGCF: 9. SIP: 200 OK (INVITE) [selected codec 1] + MGCF->>IM-MGW: 10. SIP: ACK +``` + +The sequence diagram illustrates the mid-call codec negotiation process. It begins with the MGCF sending a SIP re-INVITE message (1) to an external entity. The MGCF then sends a BICC APM message with a supported codec list (2) to the IM-MGW. The IM-MGW responds with its own supported codec list (3). Next, the MGCF initiates resource configuration for the IMS (4, 5) and bearer characteristics modification (6, 7) using H.248 messages. The IM-MGW confirms the successful modification with a BICC APM message (8). Finally, the MGCF sends a SIP 200 OK (INVITE) with the selected codec (9) and receives an ACK (10) from the external entity. + +Sequence diagram for IM CN subsystem initiated mid-call codec negotiation between IM-MGW and MGCF. + +Figure B.4: IM CN subsystem initiated mid-call codec negotiation +(message sequence chart) + +# --- Annex C (normative): Interworking of CPC parameter + +The CPC extension to tel-URI Parameter is defined in clause 7.2A.12 of 3GPP TS 24.229 [9]. The SIP "Accept-Language" header is defined in IETF RFC 3261 [19]. + +## C.1 Interworking SIP to ISUP + +Table C.1.1 shows the mapping of a "cpc" URI parameter received within tel URI or the userinfo part of SIP URI with user="phone" in a P-Asserted-Identity header in the initial INVITE request to the Calling party's category parameter in the ISUP IAM. When the "cpc" URI parameter value "operator" is received the I-MGCF shall use an Accept-Language header field to determine the value of the Calling party's category parameter. + +**Table C.1.1: Mapping of the CPC parameter to the ISUP Calling party's category parameter** + +| SIP Parameters | | ISUP Parameters | +|-----------------------------------------------------|-----------------|---------------------------------------------------------------------------| +| "cpc" URI parameter in P-Asserted-Identity (NOTE 2) | Accept-Language | Calling party's category | +| operator | fr | operator, language French | +| operator | en | operator, language English | +| operator | de | operator, language German | +| operator | ru | operator, language Russian | +| operator | es | operator, language Spanish | +| ordinary | | ordinary calling subscriber | +| test | | test call | +| payphone | | payphone | +| unknown | | calling party's category unknown at this time (national use) | +| mobile-hplmn | | mobile terminal located in the home PLMN | +| mobile-vplmn | | mobile terminal located in a visited PLMN | +| emergency | | emergency service call per ANSI Standard ATIS-1000113.2005 [117] (NOTE 1) | + +NOTE 1: This is a national/regional specific value. Interworking shall only occur when interconnecting with indicated national network. +NOTE 2: In case the "cpc" URI parameter is absent or contains values that are not mapped per this table then the ISUP shall contain the default CPC value "ordinary calling subscriber". + +In case the Accept-Language header field is not received or contains values that are not in this table then based on operator policy the Calling party's category parameter shall contain the CPC value "operator, language X" (where X is one of the following languages: French, English, German, Russian or Spanish) or national/regional specific value. + +## C.2 Interworking ISUP to SIP + +Table C.2.1 shows the mapping of a Calling party's category received in an ISUP IAM to a "cpc" URI parameter within tel URI or the userinfo part of SIP URI with user="phone" in the P-Asserted-Identity header. When the Calling party's category parameter value "operator, language x" is received the O-MGCF shall generate an Accept-Language header field with the value that corresponds to language x. + +**Table C.2.1: Mapping of the ISUP Calling party's category parameter to the CPC parameter** + +| ISUP Parameter | SIP Parameters | | +|---------------------------------------------------------------------------|--------------------------------------------|-----------------| +| calling party's category | "cpc" URI parameter in P-Asserted-Identity | Accept-Language | +| operator, language French | operator | fr | +| operator, language English | operator | en | +| operator, language German | operator | de | +| operator, language Russian | operator | ru | +| operator, language Spanish | operator | es | +| ordinary calling subscriber | ordinary | - | +| test call | test | | +| payphone | payphone | | +| calling party's category unknown at this time (national use) | unknown | | +| mobile terminal located in the home PLMN | mobile-hplmn | | +| mobile terminal located in a visited PLMN | mobile-vplmn | | +| emergency service call per ANSI Standard ATIS-1000113.2005 [117] (NOTE 1) | emergency | | + +NOTE 1: This is a national/regional specific value. Interworking shall only occur when interconnecting with indicated national network. + +NOTE 2: In case the calling party's category contains values that are not in this table then based on operator policy the "cpc" URI parameter may be omitted or may contain national/regional specific value. + +--- + +Annex D (informative): +Void + +# Annex E (normative): + +# Multimedia interworking between the IP Multimedia Core Network (CN) Subsystem (IMS) and Circuit Switched (CS) networks + +## E.1 Basic Multimedia calls interworking between the IMS and CS Networks scenarios + +The Interworking between Circuit switched multimedia telephony service, as described in 3GPP TS 26.110 [78] and 3GPP TS 26.111 [79], and packet switched multimedia services, as described in 3GPP TS 26.114 [104] is addressed. + +NOTE: Examples in the present Annex assume that the ITU-T H.263 [84] video codec is used at the CS side. However, in the present release of 3GPP TS 26.114 [104], the H.263 video codec is no longer recommended (although it has been mandated in previous releases). + +![Figure E.1.1.1 Overview of relevant CS-Domain Protocols (from TS 26.110 [78]). The diagram shows the flow of multimedia data and control signals between various components and the 3GPP Network. A dashed box labeled '3GPP TS 26.111' encloses the Video Codec, Speech Codec, Data Protocols, H.245, CCSRL, NSRP, and an Optional Receive Path Delay. The System Control is connected to the H.245 block and the Call Set-up block. The Call Set-up block is connected to the 3GPP Network. The 3GPP Network is connected to the Optional Multilink H.324 Annex H block, which is in turn connected to the Multiplex/Demultiplex block. The Multiplex/Demultiplex block is connected to the Video Codec, Speech Codec, and Data Protocols. The Video I/O Equipment is connected to the Video Codec. The Audio I/O Equipment is connected to the Speech Codec. The User Data Applications are connected to the Data Protocols.](6324b252294c0f5d4e34dad4a1202075_img.jpg) + +The diagram illustrates the architecture for multimedia interworking between the IP Multimedia Core Network (CN) Subsystem (IMS) and Circuit Switched (CS) networks. It shows the flow of data and control signals through various protocols and equipment. + +- Video I/O Equipment** is connected to a **Video Codec** (H.263, [MPEG-4, H.261 ...]). +- Audio I/O Equipment** is connected to a **Speech Codec** (3GPP-AMR, [G.723.1 ...]). +- User Data Applications** ([T.120, ...]) are connected to **Data Protocols** ([V.14, LAPM, ...]). +- The **System Control** is connected to **H.245** and the **Call Set-up** block. +- The **Call Set-up** block is connected to the **3GPP Network**. +- The **3GPP Network** is connected to the **Optional Multilink H.324 Annex H** block. +- The **Optional Multilink H.324 Annex H** block is connected to the **Multiplex/Demultiplex** block. +- The **Multiplex/Demultiplex** block (H.223, H.223 Annex A, H.223 Annex B, [H.223 Annex C, H.223 Annex D]) is connected to the **Video Codec**, **Speech Codec**, and **Data Protocols**. +- An **Optional Receive Path Delay** block is connected between the **Speech Codec** and the **Multiplex/Demultiplex** block. +- The **H.245** block is connected to **CCSRL**, which is connected to **NSRP[LAP M/V.42]**, which is connected to the **Multiplex/Demultiplex** block. +- All the above components (Video Codec, Speech Codec, Data Protocols, H.245, CCSRL, NSRP, and Optional Receive Path Delay) are enclosed in a dashed box labeled **3GPP TS 26.111**. + +Figure E.1.1.1 Overview of relevant CS-Domain Protocols (from TS 26.110 [78]). The diagram shows the flow of multimedia data and control signals between various components and the 3GPP Network. A dashed box labeled '3GPP TS 26.111' encloses the Video Codec, Speech Codec, Data Protocols, H.245, CCSRL, NSRP, and an Optional Receive Path Delay. The System Control is connected to the H.245 block and the Call Set-up block. The Call Set-up block is connected to the 3GPP Network. The 3GPP Network is connected to the Optional Multilink H.324 Annex H block, which is in turn connected to the Multiplex/Demultiplex block. The Multiplex/Demultiplex block is connected to the Video Codec, Speech Codec, and Data Protocols. The Video I/O Equipment is connected to the Video Codec. The Audio I/O Equipment is connected to the Speech Codec. The User Data Applications are connected to the Data Protocols. + +Figure E.1.1.1 Overview of relevant CS-Domain Protocols (from TS 26.110 [78]) + +## E.2 Control plane interworking + +### E.2.1 General + +In addition to the control plane Interworking between SIP and ISUP or BICC, interactions between the H.245 signalling at the CS side and SIP/SDP signalling are described. + +The establishment of the H.223 multiplexing protocol and the subsequent H.245 signalling procedures take place after the set-up and both-way through-connection of the CS bearer. + +### E.2.2 Functionalities required in the MGCF for multimedia calls support + +In addition to the control plane Interworking between SIP and ISUP or BICC, the MGCF needs to mediate interactions between the H.245 signalling or MONA (Media Oriented Negotiation Acceleration) procedures at the CS side and SIP/SDP signalling at the IMS side. The interactions between H.245 signalling or MONA procedures and SIP/SDP signalling should aim at avoiding media transcoding by selecting the same codec for the CS side and the PS side. + +NOTE: Detailed procedures for the mapping between SDP parameters and H.245 parameters are not specified in the present release. + +### E.2.3 IM CN subsystem originated session + +#### E.2.3.1 Preconditions used at IMS side + +##### E.2.3.1.1 Interactions between H.245 or MONA and SIP/SDP + +Figure E.2.3.1.1.1 shows examples of interactions between H.245 or MONA procedures and SIP/SDP for IM CN subsystem originated session. Most SIP and ISUP or BICC messages are intentionally omitted, since the SDP may be embedded in various SIP messages and since the in-band H.245 Messages are not tightly coupled with out-of-band ISUP or BICC messages. + +Figure E.2.3.1.1.1 assumes that the IMS peer uses the SIP precondition extension to indicate that preconditions have not yet been met. + +![Sequence diagram showing interactions between IMS, Interworking Node (MGCF+ IM MGW), and CS Network for an IM CN subsystem originated session. The diagram illustrates the flow of SIP and H.245 messages, including INVITE, IAM, ANM, and various H.245 capability sets and channel negotiations. A 'CALL IN ACTIVE STATE' is indicated at the bottom.](88b0f3f4393228e9ea4d6542aef7c399_img.jpg) + +``` + +sequenceDiagram + participant IMS + participant IWNode as Interworking Node (MGCF+ IM MGW) + participant CSNetwork as CS Network + + Note left of IMS: 1. SIP: INVITE +[SDP offer: +m = H.263, MP4V-ES, H.261; +m= AMR, +Preconditions not met] + IMS->>IWNode: 1. SIP: INVITE + IWNode->>CSNetwork: 2. IAM + Note right of IWNode: 4. Bearer Establishment + IWNode->>CSNetwork: 5. ANM + Note right of IWNode: 6. H.223 Bearer Setup including possible MONA Channel establishment method negotiation + Note right of IWNode: Alternative to 7-9: MONA messages + Note right of IWNode: 7. H.245: Terminal Capability Set +[H.263, MP4V-ES; H.261 AMR] + IWNode->>CSNetwork: 7. H.245: Terminal Capability Set + Note right of IWNode: 8. H.245: Terminal Capability Set +[H.261, MP4V-ES; +AMR, G.711] + IWNode->>CSNetwork: 8. H.245: Terminal Capability Set + Note right of IWNode: 9. H.245: Open Logical Channels +[MP4V-ES, AMR] + IWNode->>CSNetwork: 9. H.245: Open Logical Channels + Note left of IWNode: 10. SIP: 200 OK (INVITE) + IWNode->>IMS: 10. SIP: 200 OK (INVITE) + Note left of IWNode: 11. SIP: +[SDP offer; m =: MP4V-ES; a= +3gpp_MaxRecvSDUSize 600; m= AMR ] + IWNode->>IMS: 11. SIP + Note left of IWNode: 12. SIP: +[SDP answer; m = MP4V-ES, m= AMR] + IMS->>IWNode: 12. SIP + Note right of IWNode: CALL IN ACTIVE STATE + IWNode->>CSNetwork: CALL IN ACTIVE STATE + +``` + +Sequence diagram showing interactions between IMS, Interworking Node (MGCF+ IM MGW), and CS Network for an IM CN subsystem originated session. The diagram illustrates the flow of SIP and H.245 messages, including INVITE, IAM, ANM, and various H.245 capability sets and channel negotiations. A 'CALL IN ACTIVE STATE' is indicated at the bottom. + +**Figure E.2.3.1.1.1: Interactions between H.245 and SIP/SDP for IM CN subsystem originated session +IMS peer indicates unmet local preconditions** + +Upon receipt of a SIP INVITE request containing speech and video Codecs (signal 1 in figure E.2.3.1.1.1) the Interworking Node (consisting of MGCF and IM-MGW) starts the call set-up for multimedia call at the CS side by sending an IAM requesting an UDI bearer (signal 2 in figure E.2.3.1.1.1). + +If SDP local preconditions, which are not yet met, are contained in signal 1, the Interworking node should immediately send an SDP answer to allow for the IMS-side bearer set-up to progress. The Interworking node selects codecs supported by the IM-MGW and likely to be supported within the CS network and communicates the selected codecs towards the IMS side within an SDP answer message (signal 3 in figure E.2.3.1.1.1). If these codecs are contained in the SDP offer, the Interworking Node should select the H.263 codec and may select other codec from the SDP offer in addition. The interworking node should include a b:AS bandwidth modifier with a bandwidth suitable for the selected codec(s), but not higher than 64kbit/s plus RTP/UDP/IP overhead, in the SDP answer to request that the peer does not send media with a higher bandwidth. + +The Interworking Node shall engage in an H.223 bearer setup (step 6 in figure E.2.3.1.1.1). If the interworking Node supports MONA (Media Oriented Negotiation Acceleration), it shall first attempt a MONA Channel establishment method negotiation according to Annex K of ITU-T Recommendation H.324 [81]. If the interworking node does not support MONA, it shall use the multiplexing level negotiation procedures of Annex C of H.324 [81]. If the + +Interworking Node supports MONA, but the remote peer does not do so, a fallback to the multiplexing level negotiation procedures of Annex C of H.324 [81] will occur. + +If both the Interworking Node and the remote CS terminal support MONA procedures, the MONA procedures as per ITU-T Recommendation H.324 Annex K [81] may be used to replace the H.245 negotiation (signals 7 - 9) as shown in figure E.2.3.1.1.1. + +If MONA procedures are not used, the following applies: + +- After the completion of the H.223 bearer setup at the CS side, the Interworking Node shall send a Terminal Capability Set message describing its own capabilities (signal 7 in figure E.2.3.1.1.1). Unless the Interworking Node supports transcoding, the Interworking Node shall only send codecs that have been offered at the IM CN subsystem side (as received in signal 1 in figure E.2.3.1.1.1) within this message. +- The Interworking Node will receive an H.245 Terminal Capability Set message describing the supported Codecs at the peer's side (signal 8 in figure E.2.3.1.1.1). +- The codecs contained both in the sent and received terminal capability set messages may be selected at the CS side. The final decision of the selected codecs at the CS side is taken when the H.245 open logical Channels message (signal 9 in figure E.2.3.1.1.1) is sent or received. The direction of this message is determined by the H.245 master-slave determination procedure. + +If the Interworking Node does not transcode, it should indicate the codecs selected within the H.245 negotiation (signal 11 in figure E.2.3.1.1.1) or within the MONA procedures and enable any media that have previously been put on hold at the IMS side after the completion of the H.245 negotiation or MONA procedures. + +The interworking node should include in step 11 of figure E.2.3.1.1.1 the SDP "a" attribute "3gpp\_MaxRecvSDUSize" indicating the maximum SDU size of the application data that can be transmitted to the receiver without segmentation, as specified in clause 12.2.4.6 of 3GPP TS 26.114 [104]. + +#### E.2.3.2 Preconditions not used at IMS side + +##### E.2.3.2.1 Interactions between H.245 or MONA and SIP/SDP + +Figure E.2.3.2.1.1 shows examples of interactions between H.245 or MONA procedures and SIP/SDP for IM CN subsystem originated session. Most SIP and ISUP or BICC messages are intentionally omitted, since the SDP may be embedded in various SIP messages and since the in-band H.245 Messages are not tightly coupled with out-of-band ISUP or BICC messages. + +Figure E.2.3.2.1.1 assumes that the IMS peer does not use the SIP precondition extension. + +![Sequence diagram showing interactions between IMS, Interworking Node (MGCF+ IM MGW), and CS Network for an IM CN subsystem originated session. The diagram illustrates the flow of SIP and H.245 messages for call setup.](d0abac95583b52a3b35f74a215567334_img.jpg) + +``` + +sequenceDiagram + participant IMS + participant IWNode as Interworking Node (MGCF+ IM MGW) + participant CSNetwork as CS Network + + Note left of IMS: 1. SIP: INVITE +[SDP offer: +m = H.263, MP4V-ES, H.261; +m= AMR] + IMS->>IWNode: 1. SIP: INVITE + IWNode->>CSNetwork: 2. IAM + Note right of IWNode: 3. Bearer Establishment + CSNetwork->>IWNode: 4. ANM + Note right of IWNode: 5. H.223 Bearer Setup including possible +MONA Channel establishment method negotiation + Note right of IWNode: Alternative to 6-8: MONA messages + Note right of IWNode: 6. H.245: Terminal Capability Set +[MP4V-ES; AMR] + IWNode->>CSNetwork: 6. H.245: Terminal Capability Set + Note right of IWNode: 7. H.245: Terminal Capability Set +[H.261, MP4V-ES; +AMR, G.711] + IWNode->>CSNetwork: 7. H.245: Terminal Capability Set + Note right of IWNode: 8. H.245: Open Logical Channels +[MP4V-ES, AMR] + IWNode->>CSNetwork: 8. H.245: Open Logical Channels + Note left of IMS: 9. SIP: 200OK (INVITE) +[SDP answer: +m = MP4V-ES; a= 3gpp_MaxRecvSDUSize 600; +m= AMR] + IWNode->>IMS: 9. SIP: 200OK (INVITE) + Note bottom: CALL IN ACTIVE STATE + +``` + +Sequence diagram showing interactions between IMS, Interworking Node (MGCF+ IM MGW), and CS Network for an IM CN subsystem originated session. The diagram illustrates the flow of SIP and H.245 messages for call setup. + +**Figure E.2.3.2.1.1 Interactions between H.245 and SIP/SDP for IM CN subsystem originated session +IMS peer does not use SIP preconditions** + +Upon receipt of a SIP INVITE request containing speech and video Codecs (signal 1 in figure E.2.3.2.1.1) the Interworking Node (consisting of MGCF and IM-MGW) starts the call set-up for multimedia call at the CS side by sending an IAM requesting an UDI bearer (signal 2 in figure E.2.3.2.1.1). + +If no unmet local SDP preconditions are contained in signal 1, the Interworking node should defer sending an SDP answer until the H.245 negotiation or MONA procedures is/are completed. + +The Interworking Node shall engage in an H.223 bearer setup (step 5 in figure E.2.3.2.1.1). If the interworking Node supports MONA (Media Oriented Negotiation Acceleration), it shall first attempt a MONA Channel establishment method negotiation according to Annex K of ITU-T Recommendation H.324 [81]. If the interworking node does not support MONA, it shall use the multiplexing level negotiation procedures of Annex C of H.324 [81]. If the Interworking Node supports MONA, but the remote peer does not do so, a fallback to the multiplexing level negotiation procedures of Annex C of H.324 [81] will occur. + +If both the Interworking Node and the remote CS terminal support MONA procedures, the MONA procedures as per ITU-T Recommendation H.324 [81] Annex K may be used to replace the H.245 negotiation (signals 6 - 8) as shown in figure E.2.3.2.1.1. + +If MONA procedures are not used, the following applies: + +- After the completion of the H.223 bearer setup at the CS side, the Interworking Node shall send a Terminal Capability Set message describing its own capabilities (signal 6 in figure E.2.3.2.1.1). Unless the Interworking Node supports transcoding, the Interworking Node shall only send codecs that have been offered at the IM CN subsystem side (as received in signal 1 in figure E.2.3.2.1.1) within this message. +- The Interworking Node will receive an H.245 Terminal Capability Set message describing the supported Codecs at the peer's side (signal 7 in figure E.2.3.2.1.1). +- The codecs contained both in the sent and received terminal capability set message may be selected at the CS side. The final decision of the selected codecs at the CS side is taken when the H.245 open logical Channels message (signal 8 in figure E.2.3.2.1.1) is sent or received. The direction of this message is determined by the H.245 master-slave determination procedure. + +If the Interworking Node does not transcode, it shall send an SDP answer (signal 9 in figure E.2.3.2.1.1) indicating the codecs selected within the H.245 negotiation or within the MONA procedures after the completion of the H.245 negotiation or MONA procedures. The interworking node should include a b:AS bandwidth modifier with a bandwidth suitable for the selected codec(s), but not higher than 64kbit/s plus RTP/UDP/IP overhead, in the SDP answer to request that the peer does not send media with a higher bandwidth. + +The interworking node should include in Step 9 of figure E.2.3.2.1.1 the SDP "a" attribute "3gpp\_MaxRecvSDUSize" indicating the maximum SDU size of the application data that can be transmitted to the receiver without segmentation, as specified in clause 12.2.4.6 of 3GPP TS 26.114 [104]. + +#### E.2.3.3 Fallback to speech at session establishment + +If SCUDIF Fallback (see 3GPP TS 23.172 [121]) occurs on the CS side, the APM message contains a speech codec as "Selected Codec". The MGCF shall then disable the video "m-line" in the first SDP answer, if not yet sent, and complete the call-setup in the same way as for a normal speech call. If the SDP answer was already sent (precondition used), the MGCF shall update the SIP session to speech by sending a SIP UPDATE message with a relevant SDP. + +If in a non-SCUDIF case (ISUP or BICC without SCUDIF) the called CS terminal or network rejects the video call setup by sending a REL message to the MGCF, the MGCF releases the CS video call being established, re-establishes the CS call in a speech only mode sending a new IAM with a speech BCIE to the CS network and updates the IM CN leg codecs to a speech only codec. Then the call/session continues as in a speech only case. If the interworking node does not support the fallback, it shall release the session. + +### E.2.4 CS network originated session + +#### E.2.4.1 Interactions between SIP/SDP and H.245 or MONA + +##### E.2.4.1.1 Normal Call setup + +Figure E.2.4.1.1 shows examples of interactions between H.245 or MONA and SIP/SDP for the CS network originated session. Most SIP and ISUP or BICC messages are intentionally omitted, since the SDP may be embedded in various SIP messages and since the in-band H.245 Messages are not tightly coupled with out-of-band ISUP or BICC messages. + +![Sequence diagram showing interactions between CS Network, Interworking Node (MGCF+ IM MGW), and IMS for a CS network originated session. The diagram illustrates the flow of signaling messages (IAM, INVITE, ANM, H.245) and the establishment of bearers and logical channels.](e6df2733626a85205c1db682e6259c46_img.jpg) + +``` + +sequenceDiagram + participant CS Network + participant Interworking Node (MGCF+ IM MGW) + participant IMS + + Note left of CS Network: 4. Bearer Establishment + Note left of CS Network: 7. H.223 Bearer Setup including possible MONA Channel establishment method negotiation + Note left of CS Network: Alternative to 8-12: MONA messages + + CS Network->>Interworking Node: 1. IAM + Interworking Node->>IMS: 2. SIP: INVITE [SDP offer; m = H.263, MP4V-ES; m= AMR] + IMS->>Interworking Node: 3. SIP: [SDP answer: m = H.263, MP4V-ES; m= AMR] + IMS->>Interworking Node: 5. SIP: 200OK (INVITE) + Interworking Node->>CS Network: 6. ANM + CS Network->>Interworking Node: 8. H.245: Terminal Capability Set [H.263, H.261 AMR, G.711] + Interworking Node->>IMS: 9. SIP: [SDP offer m = H.263, H.261; m= AMR] + IMS->>Interworking Node: 10. SIP: [SDP answer m = H.263, H.261; m= AMR] + Interworking Node->>CS Network: 11. H.245: Terminal Capability Set [H.263, H.261 AMR] + CS Network->>Interworking Node: 12. H.245: Open Logical Channels [H.263, AMR] + Interworking Node->>IMS: 13. SIP: [SDP offer m = H.263; a= 3gpp_MaxRecvSDUSize 600; m= AMR] + IMS->>Interworking Node: 14. SIP: [SDP answer m = H.263; m= AMR] + + Note right of CS Network: CALL IN ACTIVE STATE + +``` + +Sequence diagram showing interactions between CS Network, Interworking Node (MGCF+ IM MGW), and IMS for a CS network originated session. The diagram illustrates the flow of signaling messages (IAM, INVITE, ANM, H.245) and the establishment of bearers and logical channels. + +NOTE: Messages 3 and 5 may be combined in some scenarios. + +**Figure E.2.4.1.1: Interactions between H.245 and SIP/SDP for CS network originated session** + +Upon receipt of an IAM request for a multimedia Call (signal 1 in figure E.2.4.1.1) the Interworking Node (consisting of MGCF and IM-MGW) starts the call set-up for multimedia call at the IM CN subsystem side by sending an INVITE request (signal 2 in figure E.2.4.1.1). For the INVITE request, the Interworking Node selects codecs supported by the IM-MGW and likely to be supported within the CS Network. The Interworking Node should select the H.263 codec and may select other codec in addition. The interworking node should add a b:AS bandwidth modifier with a bandwidth suitable for the selected codec(s), but not higher than 64kbit/s plus RTP/UDP/IP overhead, in the SDP offer to request that the peer does not send media with a higher bandwidth. + +NOTE: The SDP coding to express that either a combined voice and video call, or a voice call, or a Clearmode codec, or some other data call is desired is not defined in the present release. + +The Interworking Node shall engage in an H.223 bearer setup (step 7 in figure E.2.4.1.1). If the interworking Node supports MONA (Media Oriented Negotiation Acceleration), it shall first attempt a MONA Channel establishment method negotiation according to Annex K of ITU-T Recommendation H.324 [81]. If the interworking node does not support MONA, it shall use the multiplexing level negotiation procedures of Annex C of H.324 [81]. If the Interworking Node supports MONA, but the remote peer does not do so, a fallback to the multiplexing level negotiation procedures of Annex C of H.324 [81] will occur. + +If both the Interworking Node and the remote CS terminal support MONA procedures, the MONA procedures as per ITU-T Recommendation H.324 [81] Annex K may be used to replace the H.245 negotiation (signals 8, 11 and 12) as shown in figure E.2.4.1.1. Furthermore, the SIP codec renegotiation in signals 9 and 10 is then also not applicable. + +If MONA procedures are not used, the following applies: + +- After the completion of the H.223 bearer setup at the CS side the Interworking Node will receive a H.245 Terminal Capability Set message describing the supported Codecs at the peer's side (signal 8 in figure E.2.4.1.1). +- Due to information received in a Terminal Capability Set message (signal 8 in figure E.2.4.1.1), the Interworking node may send an SDP offer at the IMS side (signal 9 in figure E.2.4.1.1), to offer additional codecs supported at the CS side but not contained in the first SDP offer (signal 2 in figure E.2.4.1.1), or to restrict the selected codecs at the IMS side to codecs which are available at the CS side. + +NOTE: It is not clear if the addition of codecs not included in previous SDP exchange has any impacts on IMS procedures, e.g. resource reservation related procedures. + +- The Interworking Node shall send a Terminal Capability Set message describing its own capabilities (signal 11 in figure E.2.4.1.1). Unless the Interworking Node supports transcoding, the Interworking node shall only send codecs that are also negotiated at the IM CN subsystem side (as received in signal 3 in figure E.2.4.1.1) within this message. The Interworking Node may defer sending the Terminal Capability Set message for some time to attempt to receive the peer's Terminal Capability set message and perform a possible IMS-side codec renegotiation. However, to avoid blocking situations, the Interworking Node shall not defer sending the Terminal Capability Set message for an excessive period of time. +- The codecs contained both in the sent and received Terminal Capability Set message may be selected at the CS side. The final decision of the selected codecs at the CS side is taken when the H.245 open logical Channels message (signal 12 in figure E.2.4.1.1) is sent or received. The direction of this message is determined by the H.245 master-slave determination procedure. + +If the Interworking Node does not transcode, it should indicate the codecs selected within the H.245 negotiation or within MONA procedures after the completion of the H.245 negotiation (signal 13 in figure E.2.4.1.1) or MONA procedures. + +The interworking node should include in Step 11 of figure E.2.4.1.1 the SDP "a" attribute "3gpp\_MaxRecvSDUSize" indicating the maximum SDU size of the application data that can be transmitted to the receiver without segmentation, as specified in clause 12.2.4.6 of 3GPP TS 26.114 [104]. + +##### E.2.4.1.2 Call setup if multimedia call can not be recognized in an unambiguous manner + +If the Interworking Node is not able to determine from the information within the IAM request whether a multimedia call or some other type of data call is requested (for example, if only TMR=UDI but no BC IE is contained in the IAM), the Interworking Node may also include appropriate codecs for other possible types of data call it supports in the INVITE request. If video and audio codecs are contained in the first SDP answer (signal 3), the Interworking Node should continue to attempt to set up a multimedia call as described in clause E.2.4.1.1. Otherwise, calls are set up as described in clause 7.2.3.2. + +##### E.2.4.1.3 Fallback to speech during call setup + +The called party can reject the video component in the SDP offer (signal 2 in figure E.2.4.1.1) by returning an SDP answer where the video related m-line is disabled (in signal 3 in figure E.2.4.1.1). + +If the MGCF receives an SDP answer during call setup where the video related m-line is disabled, it shall react as follows: + +- If the MGCF has received a SCUDIF call setup from the CS side (MuMe and speech codecs in IAM message, see 3GPP TS 23.172 [121]), the MGCF shall apply a SCUDIF fallback to speech on the CS side. The MGCF shall use a speech codec as Selected Codec and exclude the MuMe codec from the available codec list. +- If the MGCF has received a multimedia call setup without SCUDIF from the CS side, and the CS network supports CS fallback, the MGCF should terminate the call. + +NOTE 1: A call termination can trigger the caller's device to set up a new speech call. + +NOTE 2: Other procedures to maintain the CS call, e.g. disabling the video component on the CS side or providing a suitable video announcement and discarding received video media from the CS side, are FFS. + +#### E.2.4.2 CS originated - IM CN transit - CS terminated + +Figure E.2.4.2.1 describes ISUP and SIP/SDP interactions in a CS originated - IM CN transit - CS terminated case with a clear channel through the IM CN. An interworking node A receives an IAM message with a UDI H.223 & H.245 video call request (message 1). If the interworking node A supports both CS/IMS video interworking and a clearmode codec / clear channel, it may send both audio and video codecs and a clearmode codec and a UDI & H.223 & H.245 video indication in the INVITE message towards the IMS (message 2). The message is received by an interworking node B. The interworking node B sends an IAM message with a UDI & H.223 & H.245 video call request to the terminating CS network (message 3). If the interworking node B supports a clearmode codec / clear channel, it may send a SIP response with a clearmode codec towards the calling side to indicate that a clear channel can be established between the IMS interworking nodes (message 5). After the called party answers, the interworking node B sends a SIP 200 OK (Invite) with the clearmode codec to the calling node to indicate that a clear channel can be established (message 11). After the called party has answered the call, either MONA procedures are performed and the H.223 bearer is established or the H.223 bearer is established and the H.245 signalling is performed (step 14 in figure E.2.4.2.1). + +If the interworking node A does not support CS-IMS video interworking, but supports a clearmode codec / clear channel, it sends the INVITE message with a clearmode codec and UDI & H.223 & H.245 indication, but without a video codec, to allow the establishment of a CS video call through a clear channel. The interworking node A may also send an audio codec (alone or with a clearmode codec) to allow a fallback to speech. The interworking node B either accepts the clearmode and sends the corresponding IAM message with a UDI & H.223 & H.245 request (message 3) and SIP response with a clearmode codec (message 5 or 11), or accepts the speech mode and sends the corresponding IAM message with a speech request (message 3) and SIP response with a speech codec (messages 5, 11), or rejects the INVITE message if the requested codec(s) cannot be supported. + +The format of the indication of UDI & H.223 & H.245 from interworking node A to interworking node B is defined in Annex F "PSTN XML Scheme". UDI & H.223 & H.245 indication is conveyed in PSTN XML body within "BearerCapability" ("InformationTransferCapability" and "UserInfoLayerProtocol") and "LowLayerCompatibility" elements. Elements are defined in ETSI EN 300 403-1 (V1.3.2) [96] clause 4.5.5 and in ISUP transported in the ATP is in Q.761-Q.764 [4] clause 3.5. + +![Sequence diagram showing ISUP and SIP/SDP interactions in a CS originated - IM CN transit - CS terminated case with a clear channel through the IM CN. The diagram involves two CS Networks and an IMS. The sequence starts with an IAM message from the left CS Network to Interworking node A (MGCF+ IM MGW) in the IMS. Node A sends a SIP INVITE to Interworking node B (MGCF+ IM MGW) in the right CS Network. Node B sends an IAM message to the right CS Network. The right CS Network performs TDM circuit reservation and sends an ACM message to node B. Node B sends a SIP Response to node A. Node A performs TDM circuit reservation and sends an ACM message to the left CS Network. The right CS Network sends an ANM message to node B. Node B sends a SIP :200 OK(INVITE) to node A. Node A sends a SIP ACK to node B. Finally, a 'Clear channel' message is sent between the two nodes, and the call enters an active state.](ff0952ef692c9d960ce5f6708bcc9711_img.jpg) + +``` + +sequenceDiagram + participant CS_Network_L as CS Network + participant Node_A as Interworking node A (MGCF+ IM MGW) + participant IMS + participant Node_B as Interworking node B (MGCF+ IM MGW) + participant CS_Network_R as CS Network + + Note left of CS_Network_L: 4. TDM circuit reservation + CS_Network_L->>Node_A: 1. IAM [UDI, H.223 & H.245] + Node_A->>Node_B: 2. SIP: INVITE [m = H.263, m= AMR; m=clearmode] [PSTN XML body] + Node_B->>CS_Network_R: 3. IAM [UDI, H.223 & H.245] + Note right of CS_Network_R: 6. TDM circuit reservation + CS_Network_R->>Node_B: 7. ACM + Node_B->>Node_A: 5. SIP : Response [m=audio, a=clearmode] + Node_A->>CS_Network_L: 9. ACM + CS_Network_R->>Node_B: 10. ANM + Node_B->>Node_A: 8. SIP :180 Ringing + Node_A->>CS_Network_L: 12. ANM + Node_B->>Node_A: 11. SIP:200 OK(INVITE) + Node_A->>Node_B: 13. SIP: ACK + Note over Node_A, Node_B: 14. Clear channel. Either MONA messages + H.223 bearer setup or H.223 bearer setup and H.245 signaling between CS terminals + Note over Node_A, Node_B: CALL IN ACTIVE STATE + +``` + +Sequence diagram showing ISUP and SIP/SDP interactions in a CS originated - IM CN transit - CS terminated case with a clear channel through the IM CN. The diagram involves two CS Networks and an IMS. The sequence starts with an IAM message from the left CS Network to Interworking node A (MGCF+ IM MGW) in the IMS. Node A sends a SIP INVITE to Interworking node B (MGCF+ IM MGW) in the right CS Network. Node B sends an IAM message to the right CS Network. The right CS Network performs TDM circuit reservation and sends an ACM message to node B. Node B sends a SIP Response to node A. Node A performs TDM circuit reservation and sends an ACM message to the left CS Network. The right CS Network sends an ANM message to node B. Node B sends a SIP :200 OK(INVITE) to node A. Node A sends a SIP ACK to node B. Finally, a 'Clear channel' message is sent between the two nodes, and the call enters an active state. + +Figure E.2.4.2.1: ISUP and SIP/SDP interactions in a CS originated - IM CN transit - CS terminated case with a clear channel through the IM CN + +### E.2.5 Service change + +##### E.2.5.2.1 SCUDIF + +##### E.2.5.2.1.0 General + +SCUDIF is standardised in 3GPPP 3GPP TS 23.172 [121]. + +###### E.2.5.2.1.1 IM CN subsystem originated change + +###### E.2.5.2.1.1.1 Change from multimedia to speech + +Figure E.2.5.2.1.1.1.1 shows an IM CN subsystem originated modification from multimedia to speech during an ongoing session when the CS leg supports BICC. The interworking node receives an INVITE message that indicates the dropping of the video media from the session, message 1. The interworking node can only accept the dropping of the media component and sends a corresponding codec modification request to the BICC network, message 2, and acknowledges the INVITE with a 200 OK message. The BICC network indicates a successful codec modification, message 5. + +![Sequence diagram for Figure E.2.5.2.1.1.1.1: IM CN subsystem originated modification from multimedia to speech when the CS leg supports BICC. The diagram shows the IMS and CS Network interacting via an Interworking Node (MGCF+ IM MGW). The session starts with Audio + Video. The IMS sends a SIP: INVITE [m= AMR] to the Interworking Node. The Interworking Node sends a Modify Codec (Selected Codec=AMR) to the CS Network. The CS Network responds with a Successful Codec Modification. The Interworking Node sends a SIP: 200 OK (INVITE) [m= AMR] to the IMS. The IMS responds with a SIP: ACK. The session ends with Speech.](a33da0f14e456f92539ce3e9b7d81f9a_img.jpg) + +``` + +sequenceDiagram + participant IMS + participant IN as Interworking Node (MGCF+ IM MGW) + participant CS_Network as CS Network + Note over IMS, CS_Network: Audio + Video + IMS->>IN: 1. SIP: INVITE [m= AMR] + IN->>CS_Network: 2. Modify Codec (Selected Codec=AMR) + CS_Network-->>IN: 5. Successful Codec Modification + IN-->>IMS: 3. SIP: 200 OK (INVITE) [m= AMR] + IMS->>IN: 4. SIP: ACK + Note over IMS, CS_Network: Speech + +``` + +Sequence diagram for Figure E.2.5.2.1.1.1.1: IM CN subsystem originated modification from multimedia to speech when the CS leg supports BICC. The diagram shows the IMS and CS Network interacting via an Interworking Node (MGCF+ IM MGW). The session starts with Audio + Video. The IMS sends a SIP: INVITE [m= AMR] to the Interworking Node. The Interworking Node sends a Modify Codec (Selected Codec=AMR) to the CS Network. The CS Network responds with a Successful Codec Modification. The Interworking Node sends a SIP: 200 OK (INVITE) [m= AMR] to the IMS. The IMS responds with a SIP: ACK. The session ends with Speech. + +**Figure E.2.5.2.1.1.1.1: IM CN subsystem originated modification from multimedia to speech when the CS leg supports BICC** + +NOTE: Handling of a case, where a codec is received in BICC negotiation but not included in the available codec list negotiated previously, is not defined in the present release. + +###### E.2.5.2.1.1.2 Change from speech to multimedia + +Figure E.2.5.2.1.1.2.1 shows an IM CN subsystem originated modification from speech to multimedia during an ongoing session when the CS leg supports BICC. The interworking node receives an INVITE message that offers the adding of a video media to the ongoing speech session, message 1. The interworking node accepts the offer and sends a corresponding codec modification request to the BICC network, message 2. The BICC network indicates a successful codec modification, message 3. The interworking node acknowledges the INVITE with a 200 OK message after the MONA or H.245 in-band negotiation in step 4 is completed. + +If the codec modification is not successful in the BICC network, the interworking node responds to the INVITE message with the speech codec in the 200 OK message to retain the speech only session. + +![Sequence diagram for Figure E.2.5.2.1.1.2.1: IM CN subsystem originated modification from speech to multimedia when the CS leg supports BICC. The diagram shows the IMS and CS Network interacting via an Interworking Node (MGCF+ IM MGW). The session starts with Speech. The IMS sends a SIP: INVITE [m= AMR; m=H.263] to the Interworking Node. The Interworking Node sends a Modify Codec (Selected Codec=MuMe) to the CS Network. The CS Network responds with a Successful Codec Modification. The Interworking Node then performs MONA or H.245 inband negotiation with the CS Network. After negotiation, the Interworking Node sends a SIP: 200 OK (INVITE) [m= AMR; m=H.263] to the IMS. The IMS responds with a SIP: ACK. The session ends with Audio + Video.](c036e2540a94b31357ceb0002f0cacab_img.jpg) + +``` + +sequenceDiagram + participant IMS + participant IN as Interworking Node (MGCF+ IM MGW) + participant CS_Network as CS Network + Note over IMS, CS_Network: Speech + IMS->>IN: 1. SIP: INVITE [m= AMR; m=H.263] + IN->>CS_Network: 2. Modify Codec (Selected Codec=MuMe) + CS_Network-->>IN: 3. Successful Codec Modification + Note over CS_Network: 4. MONA or H.245 inband negotiation + IN-->>IMS: 5. SIP: 200 OK (INVITE) [m= AMR; m=H.263] + IMS->>IN: 6. SIP: ACK + Note over IMS, CS_Network: Audio + Video + +``` + +Sequence diagram for Figure E.2.5.2.1.1.2.1: IM CN subsystem originated modification from speech to multimedia when the CS leg supports BICC. The diagram shows the IMS and CS Network interacting via an Interworking Node (MGCF+ IM MGW). The session starts with Speech. The IMS sends a SIP: INVITE [m= AMR; m=H.263] to the Interworking Node. The Interworking Node sends a Modify Codec (Selected Codec=MuMe) to the CS Network. The CS Network responds with a Successful Codec Modification. The Interworking Node then performs MONA or H.245 inband negotiation with the CS Network. After negotiation, the Interworking Node sends a SIP: 200 OK (INVITE) [m= AMR; m=H.263] to the IMS. The IMS responds with a SIP: ACK. The session ends with Audio + Video. + +**Figure E.2.5.2.1.1.2.1: IM CN subsystem originated modification from speech to multimedia when the CS leg supports BICC** + +##### E.2.5.2.1.2 CS network originated change + +###### E.2.5.2.1.2.1 Change from multimedia to speech + +Figure E.2.5.2.1.2.1.1 shows a CS network originated modification from multimedia to speech during an ongoing session when the CS leg supports BICC. The interworking node receives a Modify Codec message that indicates the dropping of the video media from the session, message 1. The interworking node accepts the dropping of the video component and sends a corresponding INVITE message to the IM CN subsystem, message 2, and acknowledges the code modification request to the BICC network, message 3. The IM CN subsystem acknowledges the INVITE dropping the video media with a 200 OK, message 4. The IM CN subsystem acknowledges the code modification request to the BICC network, message 5. + +![Sequence diagram showing the modification from multimedia to speech.](9ae17964ddd9b814c7d905b1af2fddf2_img.jpg) + +The diagram illustrates the interaction between the IMS and the CS Network via an Interworking Node (MGCF+ IM MGW). The sequence of messages is as follows: + +- 1. **Modify Codec (Selected Codec=AMR)**: A message from the CS Network to the Interworking Node. +- 2. **SIP: INVITE [m= AMR]**: A message from the Interworking Node to the IMS. +- 3. **Successful Codec Modification**: A message from the Interworking Node to the CS Network. +- 4. **SIP: 200 OK (INVITE) [m= AMR]**: A message from the IMS to the Interworking Node. +- 5. **SIP: ACK**: A message from the Interworking Node to the IMS. + +At the top, a double-headed arrow labeled "Audio + Video" spans across the IMS and CS Network. At the bottom, a double-headed arrow labeled "Speech" spans across the IMS and CS Network, indicating the change in media type. + +Sequence diagram showing the modification from multimedia to speech. + +**Figure E.2.5.2.1.2.1.1: CS network originated modification from multimedia to speech when the CS leg supports BICC** + +###### E.2.5.2.1.2.2 Change from speech to multimedia + +Figure E.2.5.2.1.2.2.1 shows a CS network originated modification from speech to multimedia during an ongoing session when the CS leg supports BICC. The interworking node receives a Modify Codec message that indicates the adding of a video media to the ongoing speech session, message 1. The interworking node accepts the offer and sends a corresponding INVITE message to the IM CN subsystem, message 2. The IM CN subsystem acknowledges the INVITE adding the video media with a 200 OK, message 3, and acknowledges the code modification request to the BICC network, message 4. The interworking node may have to update the codecs, messages 7 and 8, after the MONA or H.245 in-band negotiation in step 6. + +If the IM CN subsystem does not accept the addition of the video media to the session, the interworking node rejects the modify codec request to retain the speech only session. + +![Sequence diagram showing CS network originated modification from speech to multimedia. The diagram involves IMS, an Interworking Node (MGCF+ IM MGW), and CS Network. It shows SIP messages (INVITE, 200 OK, ACK) and media flow changes from Speech to Audio + Video.](1a827b10290f33d4fec04d0e8ef7a897_img.jpg) + +``` + + sequenceDiagram + participant IMS + participant IW as Interworking Node (MGCF+ IM MGW) + participant CS as CS Network + Note over IMS, CS: Speech + CS->>IW: 1. Modify Codec (Selected Codec=MuMe) + IW->>IMS: 2. SIP: INVITE [m= AMR; m=H.263] + IMS->>IW: 3. SIP: 200 OK (INVITE) [m= AMR; m=H.263] + IW->>CS: 4. Successful Codec Modification + IMS->>IW: 5. SIP: ACK + CS->>IW: 6. MONA or H.245 inband negotiation + IW->>IMS: 7. SIP: INVITE [m= AMR; m=H.263] + IMS->>IW: 8. SIP: 200 OK (INVITE) [m= AMR; m=H.263] + Note over IMS, CS: Audio + Video + +``` + +Sequence diagram showing CS network originated modification from speech to multimedia. The diagram involves IMS, an Interworking Node (MGCF+ IM MGW), and CS Network. It shows SIP messages (INVITE, 200 OK, ACK) and media flow changes from Speech to Audio + Video. + +**Figure E.2.5.2.1.2.2.1: CS network originated modification from speech to multimedia when the CS leg supports BICC** + +#### E.2.5.2.2 Non-SCUDIF case (ISUP or BICC without SCUDIF) + +###### E.2.5.2.2.1 Change from multimedia to audio + +Figure E.2.5.2.2.1.1 shows an IM CN subsystem originated modification from multimedia to audio during an ongoing session when the CS leg supports ISUP or BICC without SCUDIF. The interworking node receives an INVITE message that indicates the dropping of the video media from the session, message 1. The interworking node can only accept the dropping of the media component and acknowledges the INVITE with a 200 OK, message 2. There are three alternative ways to handle the issue: + +- The video component stays on in the CS leg. The interworking node may use the video component to send an announcement to the CS terminal to inform the user about the change of the end-to-end connection to audio only. Refer to figure E.2.5.2.2.1.1. +- The interworking node initiates an H.245 in-band negotiation to close the video channel. +- The interworking node terminates the session. + +![Sequence diagram showing IM CN subsystem originated modification from multimedia to speech. The diagram involves IMS, an Interworking Node (MGCF+ IM MGW), and CS Network. It shows SIP messages (INVITE, 200 OK, ACK) and media flow changes from Audio + Video to Audio, with a video announcement being sent.](6f341f415ee0f8c724e5d6daeb1e9b4a_img.jpg) + +``` + + sequenceDiagram + participant IMS + participant IW as Interworking Node (MGCF+ IM MGW) + participant CS as CS Network + Note over IMS, CS: Audio + Video + IMS->>IW: 1. SIP: INVITE [m= AMR] + IW->>IMS: 2. SIP: 200 OK (INVITE) [m= AMR] + IMS->>IW: 3. SIP: ACK + IW->>CS: Video announcement + Note over IMS, IW: Audio + Note over IW, CS: Audio + Note over IW, CS: Video + +``` + +Sequence diagram showing IM CN subsystem originated modification from multimedia to speech. The diagram involves IMS, an Interworking Node (MGCF+ IM MGW), and CS Network. It shows SIP messages (INVITE, 200 OK, ACK) and media flow changes from Audio + Video to Audio, with a video announcement being sent. + +**Figure E.2.5.2.2.1.1: IM CN subsystem originated modification from multimedia to speech when the CS leg supports ISUP or BICC without SCUDIF** + +###### E.2.5.2.2.2 Change from speech to multimedia + +Figure E.2.5.2.2.2.1 shows an IM CN subsystem originated attempt to change from speech to multimedia during an ongoing session when the CS leg supports ISUP or BICC without SCUDIF. The interworking node receives an INVITE message that offers the adding of a video media to the ongoing speech session, message 1. The interworking node turns down the offer and responds to the INVITE message with the speech codec in the 200 OK message to retain the speech only session, message 2. + +![Sequence diagram showing the interaction between IMS and CS Network via an Interworking Node (MGCF+ IM MGW) for a speech to multimedia modification attempt.](33a8f3f01dfa8bce75d23017855a13c5_img.jpg) + +The diagram illustrates a sequence of messages between the IMS and the CS Network, mediated by an Interworking Node (MGCF+ IM MGW). The sequence is as follows: + +- A horizontal double-headed arrow labeled "Speech" spans the top of the diagram, indicating an ongoing session. +- Message 1: A solid arrow points from the IMS to the Interworking Node, labeled "1. **SIP**: INVITE [m= AMR; m=H.263]". +- Message 2: A solid arrow points from the Interworking Node to the IMS, labeled "2. **SIP**: 200 OK (INVITE) [m= AMR]". +- Message 3: A solid arrow points from the IMS to the Interworking Node, labeled "3. **SIP**: ACK". +- A horizontal double-headed arrow labeled "Speech" spans the bottom of the diagram, indicating the session remains a speech-only session. + +Sequence diagram showing the interaction between IMS and CS Network via an Interworking Node (MGCF+ IM MGW) for a speech to multimedia modification attempt. + +**Figure E.2.5.2.2.2.1: IM CN subsystem originated modification from speech to multimedia when the CS leg supports ISUP or BICC without SCUDIF** + +### E.2.6 Call release + +#### E.2.6.1 Call release initiated from the IM CN subsystem side + +When the MGCF has received a BYE message (signal 1 in figure E.2.6.1.1) from the IM CN subsystem side, the MGCF may end the H.245 session between the IM-MGW and the CS network side (signal 3 in figure E.2.6.1.1) firstly. + +**NOTE:** A call release using only ISUP/BICC signalling at the CS side proceeds faster. H.324 terminals can handle situations where they do not receive H.245 call release signalling (see clause 7.5.2 of ITU-T Recommendation H.324 [81]), and this scenario also occurs e.g. at loss of coverage or when a node transporting H.223 transparently releases the call. + +The procedure of ending the H.245 session is defined in the clause E.4. After receiving the BYE message, the MGCF shall also send a 200 OK [BYE] message (signal 2 in figure E.2.6.1.1) towards the IM CN subsystem. + +After ending the H.245 session, the MGCF shall send a REL message (signal 4 in figure E.2.6.1.1) to the succeeding node. If the IM CN subsystem interworks with ISUP based CS network, the interworking node shall release the resources for the IMS side and the CS network side (signal 6 in figure E.2.6.1.1) after sending the REL message. If the IM CN subsystem interworks with BICC based CS network, the interworking node shall release the resources for the IMS side and the CS network side (signal 6 in figure E.2.6.1.1) upon receiving the RLC message (signal 5 in figure E.2.6.1.1) from the CS network side. The procedures of releasing the resources for the IMS side and the CS network side are specified in the present 3GPP TS in clause 7. + +Figure E.2.6.1.1 shows the message sequence chart for the multimedia call release initiated from the IM CN subsystem side. + +![Sequence diagram showing call release initiated from the IM CN subsystem side. The diagram involves three main entities: IMS, Interworking node (MGCF+ IM-MGW), and CS Network. The sequence of messages is: 1. IMS sends SIP: BYE to the Interworking node; 2. Interworking node responds with SIP: 200 OK [BYE]; 3. A dashed box indicates H.245 Signalling to end the H.245 session between the IM-MGW and the CS network side; 4. The Interworking node sends BICC or ISUP: REL to the CS Network; 5. A dashed arrow indicates BICC: RLC from the CS Network back to the Interworking node; 6. A box indicates the release of resources for both the IMS and CS network sides; 7. A dashed arrow indicates ISUP: RLC from the CS Network back to the Interworking node.](4356776ca004ecba5d599667a155d7d4_img.jpg) + +``` +sequenceDiagram + participant IMS + participant IN as Interworking node (MGCF+ IM-MGW) + participant CS as CS Network + + Note right of IN: 3. H.245 Signalling to end the H.245 session between the IM-MGW and the CS network side + Note right of IN: 6. Release the resources for the IMS side and the CS network side + + IMS->>IN: 1. SIP: BYE + IN-->>IMS: 2. SIP: 200 OK [BYE] + Note right of IN: 3. H.245 Signalling to end the H.245 session between the IM-MGW and the CS network side + IN->>CS: 4. BICC or ISUP: REL + CS-->>IN: 5. BICC: RLC + Note right of IN: 6. Release the resources for the IMS side and the CS network side + CS-->>IN: 7. ISUP: RLC +``` + +Sequence diagram showing call release initiated from the IM CN subsystem side. The diagram involves three main entities: IMS, Interworking node (MGCF+ IM-MGW), and CS Network. The sequence of messages is: 1. IMS sends SIP: BYE to the Interworking node; 2. Interworking node responds with SIP: 200 OK [BYE]; 3. A dashed box indicates H.245 Signalling to end the H.245 session between the IM-MGW and the CS network side; 4. The Interworking node sends BICC or ISUP: REL to the CS Network; 5. A dashed arrow indicates BICC: RLC from the CS Network back to the Interworking node; 6. A box indicates the release of resources for both the IMS and CS network sides; 7. A dashed arrow indicates ISUP: RLC from the CS Network back to the Interworking node. + +NOTE: Signal 7 is omitted when IM CN subsystem interworks with BICC based CS network and Signal 5 is omitted when IM CN subsystem interworks with ISUP based CS network. + +**Figure E.2.6.1.1: Call release initiated from the IM CN subsystem side** + +#### E.2.6.2 Call release initiated from the CS network side + +If the CS network side initiates the call release, it possibly ends the H.245 session with explicit signalling (signal 1 in figure E.2.6.2.1). The CS network side sends a REL message (signal 2 in figure E.2.6.2.1) towards the IM CN subsystem. The procedure of ending the H.245 session is defined in the clause E.4. + +When the MGCF receives a REL message (signal 2 in figure E.2.6.2.1) from the preceding node, the MGCF sends a BYE message (signal 3 in figure E.2.6.2.1) to the IM CN subsystem. After receiving the REL message, the interworking node also releases the resources for the IMS side and the CS network side (signal 4 in figure E.2.6.2.1). The procedure of the releasing the resources for the IMS side and the CS network side are specified in the present 3GPP TS in clause 7. After completion of resource release, the MGCF sends a RLC message (signal 5 in figure E.2.6.2.1) towards the preceding node. Figure E.2.6.2.1 shows the message sequence chart for the multimedia call release initiated from the CS network side. + +![Sequence diagram for call release initiated from the CS network side. The diagram shows the interaction between the IMS and the CS Network via an Interworking node (MGCF+ IM-MGW). The sequence of messages is: 1. H.245 Signalling to end the H.245 session (optional) from the Interworking node to the CS Network; 2. BICC or ISUP: REL from the CS Network to the Interworking node; 3. SIP: BYE from the Interworking node to the IMS; 4. Release the resources for the IMS side and the CS network side (action within the Interworking node); 5. BICC or ISUP: RLC from the Interworking node to the CS Network; 6. SIP: 200 OK [BYE] from the IMS to the Interworking node.](8fa679f79a1bb1f527cba9f29e784e89_img.jpg) + +``` + +sequenceDiagram + participant IMS + participant IN as Interworking node (MGCF+ IM-MGW) + participant CS as CS Network + + Note right of IN: 1. H.245 Signalling to end the H.245 session (optional) + CS->>IN: 2. BICC or ISUP: REL + IN->>IMS: 3. SIP: BYE + Note right of IN: 4. Release the resources for the IMS side and the CS network side + IN->>CS: 5. BICC or ISUP: RLC + IMS->>IN: 6. SIP: 200 OK [BYE] + +``` + +Sequence diagram for call release initiated from the CS network side. The diagram shows the interaction between the IMS and the CS Network via an Interworking node (MGCF+ IM-MGW). The sequence of messages is: 1. H.245 Signalling to end the H.245 session (optional) from the Interworking node to the CS Network; 2. BICC or ISUP: REL from the CS Network to the Interworking node; 3. SIP: BYE from the Interworking node to the IMS; 4. Release the resources for the IMS side and the CS network side (action within the Interworking node); 5. BICC or ISUP: RLC from the Interworking node to the CS Network; 6. SIP: 200 OK [BYE] from the IMS to the Interworking node. + +Figure E.2.6.2.1: Call release initiated from the CS network side + +#### E.2.6.3 Call release initiated from the interworking node + +The interworking node may end the H.245 session between the IM-MGW and the CS network side (signal 1 in figure E.2.6.3.1) firstly. The procedure of ending the H.245 session is defined in the clause E.4. + +NOTE: A Call Release using only SIP and ISUP/BICC signalling may proceed faster. H.324 terminals can handle situations where they do not receive H.245 call release signalling (see clause 7.5.2 of ITU-T Recommendation H.324 [81]), and this scenario also occurs e.g. at loss of coverage or when a node transporting H.223 transparently releases the call. + +To release the call, the MGCF shall send a REL message (signal 2 in figure E.2.6.3.1) to the succeeding node on the CS network side. The MGCF shall also send a BYE message (signal 3 in figure E.2.6.3.1) to the IM CN subsystem side. + +If the IM CN subsystem interworks with ISUP based CS network, the interworking node shall release the resources for the IMS side and the CS network side (signal 5 in figure E.2.6.3.1) after sending the REL message. If the IM CN subsystem interworks with BICC based CS network, the interworking node shall release the resources for the IMS side and the CS network side upon receiving the RLC message (signal 4 in figure E.2.6.3.1) from the CS network side. The procedures of releasing the resources for the IMS side and the CS network side are specified in the present 3GPP TS in clause 7. Figure E.2.6.3.1 shows the message sequence chart for the multimedia call release initiated from the interworking node. + +![Sequence diagram showing call release initiated from the interworking node between IMS and CS Network.](81a4cbf0b3c4cbc065efdf8f800dadde_img.jpg) + +The diagram illustrates the sequence of messages for call release initiated from the interworking node (MGCF+ IM-MGW) between the IMS and the CS Network. The sequence is as follows: + +- The Interworking node (MGCF+ IM-MGW) sends H.245 Signalling to end the H.245 session between the IM-MGW and the CS network side (indicated by a dashed box). +- The Interworking node (MGCF+ IM-MGW) sends **2. BICC or ISUP: REL** to the CS Network. +- The Interworking node (MGCF+ IM-MGW) sends **3. SIP: BYE** to the IMS. +- The CS Network sends **4. BICC: RLC** to the Interworking node (MGCF+ IM-MGW) (indicated by a dashed line). +- The Interworking node (MGCF+ IM-MGW) releases the resources for the IMS side and the CS network side (indicated by a solid box). +- The CS Network sends **6. ISUP: RLC** to the Interworking node (MGCF+ IM-MGW) (indicated by a dashed line). +- The IMS sends **7. SIP: 200 OK [BYE]** to the Interworking node (MGCF+ IM-MGW). + +Sequence diagram showing call release initiated from the interworking node between IMS and CS Network. + +NOTE: Signal 6 is omitted when IM CN subsystem interworks with BICC based CS network and Signal 4 is omitted when IM CN subsystem interworks with ISUP based CS network. + +Figure E.2.6.3.1: Call release initiated from the interworking node + +## E.3 User plane interworking + +### E.3.1 Functionalities required in the IM-MGW for multimedia calls support + +To enable a multimedia Interworking, the IM-MGW needs to support the reframing of the H.263 video codec and the AMR audio codec between CS transport and PS transport as a minimum. The IM-MGW may also support the reframing of other codecs and the transcoding of audio and/or video codecs. + +At the CS side, the IM-MGW needs to terminate the H.223 protocol and multiplex / de-multiplex audio, video and H.245 signalling. How H.245 related information (e.g. H.245 messages or extracted information) is communicated between the MGCF and the IM-MGW is described in clause E.4. + +## E.4 MGCF and IM-MGW interactions + +### E.4.1 Introduction + +This clause describes requirements for extensions to the Mn interface protocol in 3GPP TS 29.332 [15] needed to support the Interworking of multimedia calls. ITU-T Recommendation H.248.1 [2] is used at the Mn interface. + +The H.245 signalling shall be handled by the MGCF. Upon reception of the H.245 messages from the CS side at the IM-MGW, the IM-MGW shall forward those H.245 messages as binary data within H.248 messages over the Mn interface towards the MGCF. Upon reception of encapsulated binary H.245 messages within H.248 messages, the IM-MGW shall forward those H.245 messages towards the CS side. + +NOTE: Procedures to support MONA (see Annex K of ITU-T Recommendation H.324 [81]) over the Mn interface are not defined in the present Release. Furthermore, the signalling flows in clause E.2 may not show MONA related signalling in sufficient detail for MONA related Mn interface interactions. + +### E.4.2 Mn signalling interactions + +#### E.4.2.1 Introduction + +The following Clauses describe the Mn interface procedures triggered by H.245 signalling received in the IM-MGW and SIP and RTCP and BICC or ISUP signalling received in the MGCF. + +All message sequence charts in these Clauses are examples. + +#### E.4.2.2 H.248 Context Model + +The H.248 context model depicted in figure E.4.2.2.1 shall be applied for Multimedia Interworking. + +![Diagram of the H.248 Context Model for Multimedia Interworking. It shows a large oval labeled 'Context C1' spanning across two domains: 'CS-Domain' on the left and 'IMS' on the right. Inside the oval, there are three terminations: 'Termination T1' (a small circle), 'Termination T2' (a small circle), and 'Termination T3' (a vertical oval). Stream 1 is a horizontal double-headed arrow between T1 and T2. Stream 2 is a horizontal double-headed arrow between T2 and T3. Stream 3 is a diagonal double-headed arrow between T2 and T3. Arrows point from T1 to the left (CS-Domain) and from T3 to the right (IMS).](608f1b5ef8f3dc0723f2b4ea1fb72be2_img.jpg) + +Diagram of the H.248 Context Model for Multimedia Interworking. It shows a large oval labeled 'Context C1' spanning across two domains: 'CS-Domain' on the left and 'IMS' on the right. Inside the oval, there are three terminations: 'Termination T1' (a small circle), 'Termination T2' (a small circle), and 'Termination T3' (a vertical oval). Stream 1 is a horizontal double-headed arrow between T1 and T2. Stream 2 is a horizontal double-headed arrow between T2 and T3. Stream 3 is a diagonal double-headed arrow between T2 and T3. Arrows point from T1 to the left (CS-Domain) and from T3 to the right (IMS). + +##### Termination: + +T1 CS-Domain (CS-Bearer (BS30) for H.245 control, Speech, Video) + +T2 Multiplexing (H.245 control, Speech, Video) + +T3 Video (own RTP-stream) + Speech (own RTP-stream) + +##### Stream: + +Stream1 (between T1 and T2) data (H.245 control, speech, Video) + +Stream2 (between T2 and T3) Video + +Stream3 (between T2 and T3) Speech + +**Figure E.4.2.2.1: H.248 Context Model for Multimedia Interworking** + +#### E.4.2.3 Transport of H.245 messages between the MGCF and IM-MGW + +##### E.4.2.3.1 General + +H.245 messages shall be transported between the IM-MGW and MGCF over the Mn interface using H.248 Events (from the IM-MGW towards the MGCF) and H.248 Signals (from the MGCF towards the IM-MGW). The Events/Signals shall contain the following information: + +- H.245 message (binary). + +##### E.4.2.3.2 Transport from MGCF to IM-MGW + +![Sequence diagram showing Mn signalling interactions for sending H.245 message from MGCF to IM-MGW.](09955ff8214ffb6947951fc0f60eb6ab_img.jpg) + +``` + +sequenceDiagram + participant MGCF + participant IM_MGW as IM MGW + Note right of MGCF: Signal H245 Message + MGCF->>IM_MGW: 1. H.248 MOD.req +[C=C1,T=T2 +signal=H245msgout +{h245mc=XXXX} ] + IM_MGW-->>MGCF: 2. H.248 MOD.resp + Note left of IM_MGW: 3. send H.245 message XXXX in H.223 stream + IM_MGW->>IM_MGW: 3. send H.245 message XXXX in H.223 stream + +``` + +Sequence diagram showing Mn signalling interactions for sending H.245 message from MGCF to IM-MGW. + +Figure E.4.2.3.2.1: Mn signalling interactions for sending H.245 message + +In Signal 1, the MGCF requests the IM-MGW to send an H.245 message to the CS side. To request the IM-MGW to send a H.245 message to the CS side, the MGCF shall send an H.248 signal to the IM-MGW with the complete H.245 message content. + +NOTE: In order for this command to succeed, Termination T1 towards the CS side needs to be configured. If a sending of an H.245 message and a removal of termination T1 is desired, the MGCF needs to apply signal 1 before removing T1. + +Upon reception of this signal, the IM-MGW shall send the encapsulated H.245 message within the H.248 signal, through the H.245 control channel to the CS side (signal 3). + +##### E.4.2.3.3 Transport from IM-MGW to MGCF + +![Sequence diagram showing Mn signalling interactions for receiving H.245 message from IM-MGW to MGCF.](04dc3838022e96d8d5548bb1b777b38c_img.jpg) + +``` + +sequenceDiagram + participant MGCF + participant IM_MGW as IM MGW + Note right of MGCF: Add Multiplex Termination + MGCF->>IM_MGW: 1. H.248 ADD.req +[C=C1,T=? ... ,Event=H245msgin] + IM_MGW-->>MGCF: 2. H.248 ADD.resp + Note left of IM_MGW: 3. receive H.245 message XXXX in H.223 + IM_MGW->>IM_MGW: 3. receive H.245 message XXXX in H.223 + Note right of MGCF: Notify H245 Message + IM_MGW->>MGCF: 4. H.248 : Notify.req +[C=C1,T=T2 +Event=H245msgin +{h245mc=XXXX}] + MGCF-->>IM_MGW: 5. H.248 : Notify.resp + +``` + +Sequence diagram showing Mn signalling interactions for receiving H.245 message from IM-MGW to MGCF. + +Figure E.4.2.3.3.1: Mn signalling interactions for receiving H.245 message + +In signal 1, the MGCF requests the IM-MGW to detect received H.245 message from the CS side and forward them to the MGCF. To request the IM-MGW to detect and forward a H.245 message to the CS side, the MGCF shall send a suitable H.248 event to the IM-MGW. The event may be indicated through an H.248 ADD command. + +In signal 3, the IM-MGW receives an H.245 message from the CS side. Upon reception of an H.245 message from the CS side, the IM-MGW shall de-multiplex the H.245 message from the H.223 stream and forward the H.245 message to the MGCF within an H.248 Notify command (signal 4). + +#### E.4.2.4 Call establishment procedure + +The following information shall be provided from the MGCF towards the IM-MGW: + +- Properties to start H.223 Negotiation. +- Request for events for Notification of H.245 message received by the IM-MGW. +- Signals to provide H.245 messages that the IM-MGW shall send towards the CS side. + +- Properties to provide incoming and outgoing H.223 multiplex table. +- Properties to provide H.223 logical channel parameters. +- Property to provide remote H.223 capabilities. + +The Highest Multiplexing Level shall be predefined in the IM-MGW. + +![Sequence diagram showing Mn signalling interactions for H.245 termination at the MGCF. The diagram involves three entities: IM MGW, MGCF, and CS (implied by the Bearer Establishment box). The sequence of messages is as follows: 1. H.248 ADD.req from MGCF to IM MGW; 2. H.248 ADD.resp from IM MGW to MGCF; 3. H.248 ADD.req from MGCF to IM MGW; 4. H.248 ADD.resp from IM MGW to MGCF; 5. Bearer Establishment (internal to CS); 6. H.248 ADD.req from MGCF to IM MGW; 7. H.248 ADD.resp from IM MGW to MGCF; 8. H.223 Multiplexing Level Negotiation between CS and IM MGW; 9. H.245 Terminal Capability Set from IM MGW to MGCF; 10. H.245 Terminal Capability Set Ack from MGCF to IM MGW; 11. H.245 Terminal Capability Set from IM MGW to MGCF; 12. H.245 Terminal Capability Set Ack from MGCF to IM MGW; 13. H.245 Open Logical Channel from IM MGW to MGCF; 14. H.245 Open Logical Channel Ack from MGCF to IM MGW; 15. H.245 Open Logical Channel from IM MGW to MGCF; 16. H.245 Open Logical Channel Ack from MGCF to IM MGW; 17. H.245 Multiplex Entry Send from IM MGW to MGCF; 18. H.245 Multiplex Entry Send Ack from MGCF to IM MGW; 19. H.245 Multiplex Entry Send from IM MGW to MGCF; 20. H.245 Multiplex Entry Send Ack from MGCF to IM MGW; 21. H.248 MOD.req from MGCF to IM MGW; 22. H.248 MOD.resp from IM MGW to MGCF; 23. H.248 MOD.req from MGCF to IM MGW; 24. H.248 MOD.resp from IM MGW to MGCF. Annotations on the right describe the actions performed by the MGCF at each step.](ae53f90bb87d6d09e2d6b5278d7c338f_img.jpg) + +Sequence diagram illustrating Mn signalling interactions for H.245 termination at the MGCF. The diagram shows interactions between the IM MGW and the MGCF, with a Bearer Establishment box indicating a side interaction. + +The sequence of messages is as follows: + +1. H.248: ADD.req [C=?, T=?, stream=1] (MGCF to IM MGW) +2. H.248: ADD.resp [C=C1, T=T1] (IM MGW to MGCF) - *Prepare Bearer or Establish Bearer or Reserve TDM Circuit* +3. H.248: ADD.req [C=C1, T=?, stream=2{Codec=H.263}, stream=3{Codec=AMR}] (MGCF to IM MGW) +4. H.248: ADD.resp [C=C1, T=T3] (IM MGW to MGCF) - *Reserve IMS Connection Point or Reserve IMS Connection Point and Configure Remote Resources* +5. Bearer Establishment (Internal to CS) +6. H.248: ADD.req [C=C1, T=?, Mux=H223 T1, LocalControl{muxlv=2} Event=H245msgin] (MGCF to IM MGW) +7. H.248: ADD.resp [C=C1, T=T2] (IM MGW to MGCF) - *Add Multiplex Termination* +8. H.223: Multiplexing Level Negotiation [level=2] (CS to IM MGW) +9. H.245: Terminal Capability Set, [AMR,MP4V-ES,H263] Master-Slave Determination (IM MGW to MGCF) +10. H.245: Terminal Capability Set Ack, Master-Slave Determination Ack (MGCF to IM MGW) +11. H.245: Terminal Capability Set, [H.261,H.263,AMR] Master-Slave Determination (IM MGW to MGCF) +12. H.245: Terminal Capability Set Ack, Master-Slave Determination Ack (MGCF to IM MGW) +13. H.245: Open Logical Channel [H245 logical Channel = LC1] (IM MGW to MGCF) +14. H.245: Open Logical Channel Ack (MGCF to IM MGW) +15. H.245: Open Logical Channel [H245 logical Channel = LC2] (IM MGW to MGCF) +16. H.245: Open Logical Channel Ack (MGCF to IM MGW) +17. H.245: Multiplex Entry Send (IM MGW to MGCF) +18. H.245: Multiplex Entry Send Ack (MGCF to IM MGW) +19. H.245: Multiplex Entry Send (IM MGW to MGCF) +20. H.245: Multiplex Entry Send Ack (MGCF to IM MGW) +21. H.248: MOD.req [C=C1, T=T2, Stream=1{LocalCont{h223capr,muxtbl\_in,muxtbl\_out}}, stream=2{LCN=LC1, Codec=H263}, stream=3{LCN=LC2, Codec=AMR}] (MGCF to IM MGW) +22. H.248: MOD.resp (IM MGW to MGCF) - *Configure Multiplex Termination* +23. H.248: MOD.req [C=C1, T=T3, stream=2{Codec=H263}, stream=3{Codec=AMR}] (MGCF to IM MGW) +24. H.248: MOD.resp [C=C1, T=T3] (IM MGW to MGCF) - *Configure IMS Ressources* + +Sequence diagram showing Mn signalling interactions for H.245 termination at the MGCF. The diagram involves three entities: IM MGW, MGCF, and CS (implied by the Bearer Establishment box). The sequence of messages is as follows: 1. H.248 ADD.req from MGCF to IM MGW; 2. H.248 ADD.resp from IM MGW to MGCF; 3. H.248 ADD.req from MGCF to IM MGW; 4. H.248 ADD.resp from IM MGW to MGCF; 5. Bearer Establishment (internal to CS); 6. H.248 ADD.req from MGCF to IM MGW; 7. H.248 ADD.resp from IM MGW to MGCF; 8. H.223 Multiplexing Level Negotiation between CS and IM MGW; 9. H.245 Terminal Capability Set from IM MGW to MGCF; 10. H.245 Terminal Capability Set Ack from MGCF to IM MGW; 11. H.245 Terminal Capability Set from IM MGW to MGCF; 12. H.245 Terminal Capability Set Ack from MGCF to IM MGW; 13. H.245 Open Logical Channel from IM MGW to MGCF; 14. H.245 Open Logical Channel Ack from MGCF to IM MGW; 15. H.245 Open Logical Channel from IM MGW to MGCF; 16. H.245 Open Logical Channel Ack from MGCF to IM MGW; 17. H.245 Multiplex Entry Send from IM MGW to MGCF; 18. H.245 Multiplex Entry Send Ack from MGCF to IM MGW; 19. H.245 Multiplex Entry Send from IM MGW to MGCF; 20. H.245 Multiplex Entry Send Ack from MGCF to IM MGW; 21. H.248 MOD.req from MGCF to IM MGW; 22. H.248 MOD.resp from IM MGW to MGCF; 23. H.248 MOD.req from MGCF to IM MGW; 24. H.248 MOD.resp from IM MGW to MGCF. Annotations on the right describe the actions performed by the MGCF at each step. + +NOTE 1: All H.245 messages (from Signal 9 to Signal 18) are transported through the IM-MGW between the MGCF and the CS side, using the procedures described in clause E.4.2.3 + +NOTE 2: Signals 21 and 22 are omitted if the same codec information has already been provisioned in signal 3. + +**Figure E.4.2.4.1: Mn signalling interactions for H.245 termination at the MGCF** + +The MGCF shall request terminations towards the CS network (Signal 1 and 2) and towards the IMS (Signal 3 and 4). For the terminations towards the IMS, the MGCF provides an estimate about the applicable codecs in the required information elements "Local IMS Resources" (for both "Reserve IMS Connection Point" procedure and "Reserve IMS + +Connection Point and Configure Remote Resources" procedure) and possibly "Remote IMS Resources" (only for "Reserve IMS Connection Point and Configure Remote Resources" procedure). + +The MGCF shall request that the H.223 stream is (de-)multiplexed at the MUX termination T2, and that the H.245 control in H.223 Logical channel 0 is separated (signal 6). Furthermore, the MGCF shall request that the H.223 negotiation is started, and shall request to be notified about all H.245 messages received by the IM-MGW. + +The IM-MGW shall start the H.223 Multiplexing Level Negotiation after receipt of the corresponding request from the MGCF and CS bearer establishment (Signal 8). + +Upon reception of a H.245 Terminal Capability Set message (Signal 9), the MGCF sends a H.245 Acknowledgment message (Signal 10). + +The MGCF shall know the H.324 related capabilities of the IM-MGW before starting the H.245 capability negotiation with the CS side, e.g. through configuration. The H.245 Terminal Capability Set message sent by the MGCF (Signal 11) should include the codecs which are supported by both the IMS side and the IM-MGW, and the codecs which could be transcoded by the IM-MGW from the codecs supported by the IMS side. + +The MGCF may defer sending the Terminal Capability Set message (Signal 11) for some time to wait for codec information from the CS peer's Terminal Capability Set message and perform a possible IMS-side codec re-negotiation. To avoid blocking situations, the MGCF shall not defer sending the signal for an excessive period of time. + +To avoid the CS side selecting the codecs that need to be transcoded at the IM-MGW, the MGCF should aim to be the master in the H.245 master-slave determination procedure (Signals 9 to 12). The MGCF shall set the Terminal Type parameter as a number larger than 128 in the H.245 Master Slave Determination message. The H.245 master-slave determination procedure could be combined with the messages used for the H.245 capability exchange. + +The codecs contained both in the sent and received terminal capability set message may be selected at the CS side. The final decision of the selected codecs at the CS side is taken with the H.245 open logical channel procedure (Signals 13 to 16). + +After the completion of the H.245 multiplex table exchange procedure (Signals 17 to 20), the MGCF shall configure the multiplexing termination T2 by indicating to the IM-MGW the contents of the incoming and outgoing multiplex tables (Signal 21). + +If codec information needs to be changed compared to what has been provisioned in signal 3, the MGCF shall also configure T3 with the appropriate video and/or speech codec(s) (signal 23). + +The call is in the active state. + +#### E.4.2.5 Handling of H.245 indication message + +##### E.4.2.5.1 Overview + +The MGCF shall support the following H.245 indication messages: Function Not Understood Indication / Function Not Supported Indication, Jitter Indication. The MGCF may support the H.245 User Input Indication message. All these H.245 messages are conveyed between the MGCF and the CS side through the IM-MGW, as described in clause E.4.2.3. + +##### E.4.2.5.2 Function Not Understood / Function Not Supported message + +This indication message is used to return requests, responses and commands that are not understood back to the transmitter. + +If the MGCF receives a Function Not Understood or Function Not Supported message from the CS side, the MGCF may choose to attempt simpler H.245 interaction than the previous H.245 interaction that caused this indication. If this is not possible, the MGCF may release the call. + +If the MGCF receives a H.245 request, response or command that can not be understood, the MGCF shall send H.245 Function Not Supported indication message to the CS side. + +##### E.4.2.5.3 User Input Indication message + +The User-Input-Indication message is used e.g. to transport the in-band DTMF information in the H.324 system. + +The MGCF and IM-MGW may support transporting the DTMF information both from the CS side to the IMS side, and from the IMS side to the CS side. + +Upon Receipt of a H.245 User-Input-Indication message, the MGCF may apply the procedures in clause 9.2.8.3 to request the IM-MGW to send corresponding RTP telephone-event(s) towards the IMS side. + +Upon receipt of RTP telephone events from the IMS, the MGCF will be notified by the IM-MGW using the procedures in clause 9.2.8.1, if the MGCF has previously configured the IM-MGW as also described in this subclause. Upon receipt of the notification, the MGCF may send a H.245 User-Input-Indication message to the CS side. + +#### E.4.2.6 Handling of H.245 Command message + +##### E.4.2.6.1 Overview + +The MGCF shall support the End Session command message. The MGCF may support the Flow Control command message and the videoFastUpdatePicture message. All these H.245 messages are conveyed between the MGCF and the CS side by the IM-MGW, as described in clause E.4.2.3. + +##### E.4.2.6.2 Flow control command + +The flow control command is used to restrict the upper limit of bit rate of either a single logical channel or the whole multiplex stream. The MGCF may support the flow control command received from the CS side. + +NOTE: It is very unlikely that the MGCF will receive a Flow control command, as the capability of controlling the video bit rate during a video call was neither implemented nor tested for UEs offering 3G-324M since R99, due to the lack of such a necessity in WCDMA where a fixed 64 kbps bearer is maintained to continuously transport 3G-324M PDUs. + +![Sequence diagram illustrating the Mn procedure of Flow control command between IM MGW and MGCF.](e05c1a13b44ab41505609d82b00cf4df_img.jpg) + +``` + +sequenceDiagram + participant IM MGW + participant MGCF + Note over IM MGW, MGCF: Call In Active State + MGCF->>IM MGW: 1. H.245: Flow Control Command + IM MGW->>MGCF: 2. H.248: Modify.req +C=C1,T=T2,stream{LCN}, stream mode=Recieve Only + MGCF->>IM MGW: 3. H.248: Modify.rsp + IM MGW->>MGCF: 4. H.245: Close Logical Channel{Old LCN} +Open Logical Channel {New LCN} + MGCF->>IM MGW: 5. H.245: Close Logical Channel ACK{Old LCN} +Open Logical Channel ACK{New LCN} + IM MGW->>MGCF: 6. H.248: Modify.req +C=C1,T=T2,stream{New LCN, codec}, stream mode = sendreceive + MGCF->>IM MGW: 7. H.248: Modify.rsp + IM MGW->>MGCF: 8. H.245: Flow Control indication + Note right of MGCF: 9. SIP:reINVITE +10. SIP:200 OK + MGCF->>IM MGW: 11. H.248: Modify.req +C=C1,T=T3,stream{codec} + IM MGW->>MGCF: 12. H.248: Modify.rsp + +``` + +Sequence diagram illustrating the Mn procedure of Flow control command between IM MGW and MGCF. + +**Figure E.4.2.6.2.1: Mn procedure of Flow control command** + +In Signal 1, the MGCF receives the Flow Control Command from the CS side. + +If the minimum bitrate of the current codec is larger than the bitrate requested by the H.245 Flow Control Command message, the MGCF indicates the IM-MGW to stop the transmission of the media stream over the logical channel (signal 2). Then the MGCF may select another codec that can satisfy the requested bitrate limit. In signal 4, the MGCF closes the old logical channel and opens a new logical channel with new codec to satisfy the bitrate limit in the CS side. In signal 6, the MGCF indicates the IM-MGW to modify the LCN, codec and stream mode of the multiplexing termination. In signal 8, the MGCF sends flow control indication message to CS side with the current maximum bitrate. If the MGCF chooses to change the CS-side codec, the MGCF may also adjust the codec at the IMS side accordingly. To do so, the MGCF may need to re-negotiate the codec at the IMS side using a SIP re-INVITE message (signals 9 and 10). In addition, the MGCF may modify the codec of IMS termination accordingly (signal 11). + +The MGCF may also apply interworking procedure towards RTCP at the IMS side as described in clause E.4.2.8 when receiving a H.245 Flow Control Command. + +##### E.4.2.6.3 End Session Command + +The end session command is used to close the H.245 control channel after all the logical channels have been closed. + +The MGCF may send an end session command to the CS side through the IM-MGW to release a call. + +If the MGCF receives an end session command from the CS side, it shall release the call if the call is in the active state. + +##### E.4.2.6.4 videoFastUpdatePicture + +The MGCF may apply interworking procedure towards RTCP as described in clause E.4.2.8 when receiving a H.245 videoFastUpdatePicture message. The MGCF may also be triggered by the procedures in clause E.4.2.8 to send a H.245 videoFastUpdatePicture message. + +When receiving frequent H.245 videoFastUpdatePicture messages for a SCUDIF call (see 3GPP TS 23.172 [121]), an MGCF should initiate a service-change from multimedia to speech and remove the IMS MTSI video component with SIP/SDP signalling. When receiving frequent H.245 videoFastUpdatePicture messages for a non-SCUDIF call, an MGCF should disable the CS video and remove the IMS MTSI video component with SIP/SDP signalling. + +**NOTE:** In a congestion situation at the IMS side, frequent packet losses might occur and dropping the video component may serve as a counter-measure to reduce the packet loss frequency. However, CS terminals might not be able to initiate such a switch-over to voice, but might rather react with repeated H.245 videoFastUpdatePicture message. + +#### E.4.2.7 Mn Signalling Interactions to support the Media Oriented Negotiation Acceleration (MONA) + +##### E.4.2.7.1 Overview + +Media Oriented Negotiation Acceleration (MONA), as specified in ITU-T H.324 [81] provides simplified procedures that allow for a faster call set-up of a H.324 Multimedia call than standard H.324 procedures, and also allow for a fallback to standard H.324 procedures if either party does not support the enhanced procedures. + +The support of MONA is optional for an IM-MGW and MGCF supporting multimedia interworking, as no call failure but only a fallback to standard H.324 setup procedures will occur if the procedures are not supported. + +MONA "preference message" signalling is used instead of H.324 Multiplexing level negotiation. Should standard H.324 Multiplexing level stuffing flags be received, a fallback to standard H.324 procedures is triggered. The sending of MONA preference messages is repeated by each MONA capable H.324 terminal until a reception is acknowledged by the peer. During this phase, two PDU types may optionally be attached by MONA terminals to these preference messages: + +- Media Preconfigured Channel (MPC) PDUs: MONA defines a small number of preconfigured H.223 channels for the most widespread audio and video codecs (AMR, AMR-WB, H.264 MPEG4 and H.263). Media PDUs for these codecs may be attached to the MONA "preference message" during the call setup. +- Signalling Preconfigured Channel (SPC) PDUs: These PDUs are H.245 generic request messages with special parameters defined by MONA. These PDUs may also be attached to MONA preference messages. + +According to MONA, each MONA capable terminal shall support at least one of these PDU types. The MONA capability of the IM-MGW can be audited by the MGCF. + +The MONA preference message exchange in combination with attached MPC or SPC PDUs may result in the establishment of the desired media channels without further H.245 signalling. Otherwise, H.245 will be used after the MONA preference message exchange is acknowledged to negotiate media channels, but MONA defines some accelerated H.245 procedures (ACP) to speed up these H.245 procedures. + +The design of Mn procedures to support MONA is guided by the following considerations: + +- The H.245 handling should be performed in the MGCF to keep procedures aligned as far as possible with standard Mn procedures to support H.324 interworking. +- The MGCF should also control MONA preference message exchange procedures in order to maintain the agreed architectural work split between MGCF and IM-MGW in analogy to the H.245 handling. +- However, the IM-MGW needs to understand the MONA preference messages at least to a sufficient degree to de-encapsulate the possibly attached MPC and SBC PDUs. +- Furthermore, the frequent retransmissions of MONA preference messages required by MONA procedures are to be performed by the IM-MGW autonomously to avoid unnecessary load at the Mn interface and the MGCF. +- Furthermore, for resource reservation at the IM-MGW, it is assumed that the IM-MGW has knowledge about supported predefined Media Preconfigured Channel configurations as specified in clause K.9.2 of H.324 [81] in order to limit the amount of information transferred in the Mn interface when establishing MPC channels. The offered channel resources are reserved by the IM-MGW. +- In order to avoid increasing call establishment time when interworking with legacy terminals and at the same time avoid unnecessary load at the Mn interface, the MGCF may initiate both MONA and legacy H.245 procedures simultaneously in parallel. The MGCF shall in this case arm a legacy detection event with an embedded signal descriptor including the initial legacy H.245 message. The IM-MGW will only send the signal in case a fallback condition to legacy is detected. + +##### E.4.2.7.2 Mn Interactions for MONA preference messages + +![Sequence diagram showing Mn interactions for MONA preference messages between IM MGW and MGCF.](474a819357587e34949a3e110ff19b30_img.jpg) + +``` + +sequenceDiagram + participant IM MGW + participant MGCF + + MGCF->>IM MGW: 1. H.248: ADD.req [C=?, T=?, stream=1] + Note right of MGCF: Prepare Bearer or +Establish Bearer or +Reserve TDM Circuit + IM MGW-->>MGCF: 2. H.248: ADD.resp [C=C1, T=T1] + + MGCF->>IM MGW: 3. H.248: ADD.req [C=C1, T=?, stream=2{Codec=H.263}, stream=3{Codec=AMR}] + Note right of MGCF: Reserve IMS +Connection Point or +Reserve IMS +Connection Point +and Configure +Remote Resources + IM MGW-->>MGCF: 4. H.248: ADD.resp [C=C1, T=T3] + + Note left of IM MGW: 5. Bearer Establishment + + MGCF->>IM MGW: 6. H.248: ADD.req [C=C1, T=?, Mux=H223, T1, LocalControl{MONA preferences, muxlv=2}, Event=legacyDetected(h245msgout{octet string}), MONA-preference-reception, MONA-preference-completed, H245msgin, [MPC-reception, SBC-reception]] + Note right of MGCF: Add +Multiplex +Termination + IM MGW-->>MGCF: 7. H.248: ADD.resp [C=C1, T=T2] + + IM MGW->>IM MGW: 8. MONA preferences [ack=00] + IM MGW->>IM MGW: 8. MONA preferences [ack=00] + IM MGW->>IM MGW: 9. MONA preferences [ack=00] + IM MGW->>IM MGW: 10. MONA preferences [ack=01] + + MGCF->>IM MGW: 11. H.248: Notify.req [C=C1, T=T2, Event=MONA-preference-reception {MONA preferences}] + Note right of MGCF: Notify +MONA +prefrence +reception + IM MGW-->>MGCF: 12. H.248: Notify.resp + + IM MGW->>IM MGW: 9. MONA preferences [ack=00] + IM MGW->>IM MGW: 10. MONA preferences [ack=01] + IM MGW->>IM MGW: 13. MONA preferences [ack=01] + IM MGW->>IM MGW: 14. MONA preferences [ack=10] + + Note over IM MGW, MGCF: Optional Procedures for reception of SPC PDU, sending of SPC PDU, reception of MPC PDU, sending of MPC PDU + + IM MGW->>IM MGW: 13. MONA preferences [ack=01] + IM MGW->>IM MGW: 14. MONA preferences [ack=10] + IM MGW->>IM MGW: 15. MONA preferences [ack=10] + + MGCF->>IM MGW: 16. H.248: Notify.req [C=C1, T=T2, Event=MONA-preference-completed] + Note right of MGCF: Notify +MONA +prefrence +completed + IM MGW-->>MGCF: 17. H.248: Notify.resp + + Note over IM MGW, MGCF: 18. Accelerated H.245 call setup procedures + + MGCF->>IM MGW: 19. H.248: MOD.req [C=C1, T=T2, Stream=1{LocalControl{h223capr, muxtbl_in, muxtbl_out}}, stream=2{LCN=LC1, Codec=H263}, stream=3{LCN=LC2, Codec=AMR}] + Note right of MGCF: Configure +Multiplex +Termination + IM MGW-->>MGCF: 20. H.248: MOD.resp + + MGCF->>IM MGW: 21. H.248: MOD.req [C=C1, T=3, stream=2{Codec=H263}, stream=3{Codec=AMR}] + Note right of MGCF: Configure IMS +Ressources + IM MGW-->>MGCF: 22. H.248: MOD.resp [C=C1, T=T3] + +``` + +Sequence diagram showing Mn interactions for MONA preference messages between IM MGW and MGCF. + +NOTE 1: MONA preference messages are repeated several times. One repetition is shown for each such message, with the same signal number as the first message. + +NOTE 2: The Context model in figure E.4.2.2.1 is assumed in this call flow. + +**Figure E.4.2.7.2.1: Mn signalling interactions for MONA preference messages** + +The MGCF shall request terminations towards the CS network (Signal 1 and 2) and towards the IMS (Signal 3 and 4). For the terminations towards the IMS, the MGCF provides an estimate about the applicable codecs in the required information elements "Local IMS Resources" (for both "Reserve IMS Connection Point" procedure and "Reserve IMS + +Connection Point and Configure Remote Resources" procedure) and possibly "Remote IMS Resources" (only for "Reserve IMS Connection Point and Configure Remote Resources" procedure). + +The MGCF shall request that the H.223 stream is (de-)multiplexed at the MUX termination T2 (signal 6). Furthermore, the MGCF shall request that MONA preferences negotiation is started, and shall provision the MONA preferences to be indicated by the IM-MGW. The MGCF shall encode the MONA preferences as described in clause K.6 of ITU-T H.324 [81]. The MGCF shall take the H.324 related capabilities of the IM-MGW into account in the MONA preferences. The MGCF can know these capabilities by configuration. The IM-MGW will only support symmetric codec usage. If several codec alternatives are offered for MPC, it is the responsibility of the MGCF to ensure that symmetric codecs are established by not selecting transmit codec until the receive channel has been opened by MPC media. The MGCF shall also request to be notified about the reception of the remote MONA preferences and about the completion of the MONA preference exchange, or an H.245 message on the H.223 control channel. The MGCF may also initiate standard H.245 signalling in parallel in order to minimize the time for a legacy interworking fallback. This is done by arming a legacy detection event including an embedded signal descriptor. The embedded signal is the initial H.245 message out signal (including H.245 TCS+MSD) to send in case fallback to legacy interworking is detected. The IM-MGW will only send the embedded signal in case it detects H.223 related indications of a legacy interworking as specified in clause K.7.1.2 in H.324 [81]. Upon receiving the legacy detected event, the MGCF continues with standard H.245 call setup procedures waiting for the reception of a remote H.245 TCS as well as acknowledgements on the sent H.245 TCS+MSD. If the MGCF indicates the capability to receive SPC PDUs within the MONA preferences, it shall also request to be notified about incoming SPC PDUs, as detailed in clause E.4.2.7.4. If the MGCF indicates the capability to receive any MPC PDUs within the MONA preferences, it shall also request to be notified about incoming MPC PDUs, as detailed in clause E.4.2.7.3. + +The IM-MGW shall start sending MONA preference messages after receipt of the corresponding request from the MGCF and CS bearer establishment (Signal 8). The IM-MGW shall repeat sending those messages and increment the acknowledgment bits of sent MONA preference messages when receiving incoming MONA preference messages according to MONA procedures (signals 8, 10, 14). + +After sending at least 10 MONA preference messages, while the IM-MGW continues to send and receive MONA preference messages, it shall attach MPC or SPC PDUs if requested to do so by the MGCF as described in clauses E.4.2.7.3 and E.4.2.7.4, respectively. If the IM-MGW receives preference messages with an attachment, it shall inspect the first octet of that attachment that will contain a MUX code according to table K.15 of ITU-T H.324 [81] that identifies the attached PDU as either a MPC PDU of one of the predefined channels or a SPC PDU. The IM-MGW shall handle the attached MPC or SPC PDUs as described in clause E.4.2.7.3 and E.4.2.7.4, respectively. + +After sending at least 10 MONA preference messages, the IM-MGW should insert stuffing flags indicating the multiplexing level received from the MGCF between MONA preference messages as described in clause K.7.1.1 of ITU-T H.324 [81]. + +The IM-MGW shall notify the MGCF when receiving the first incoming MONA preference message (Signals 11 and 12) and forward the received information. Subsequent incoming MONA preference message will be identical apart from possible increments in the acknowledgement bits. The IM-MGW shall not notify the MGCF about these messages. Upon reception of the notification of a MONA preference message, the MGCF shall compare the received MONA preferences message with the preferences message it sent and react as described in clause 7.1 of ITU-T H.324 [81]. + +When receiving an incoming MONA preference message with acknowledgment bits 10 or receiving the first non-empty H.223 MUX PDU, the IM-MGW shall notify the MGCF about the completion of the MONA preference exchange procedure (signals 16 and 17). The notification shall be only triggered by the one of the two events which occurs first. If the IM-MGW is not configured to send and detect SPCs, the IM-MGW shall then stop sending MONA preference messages and, if a MONA preference message with acknowledgment bits 10 has been received, it shall also stop receiving MONA preference messages. If the IM-MGW is configured to send and detect SPCs, the IM-MGW shall continue sending and receiving MONA Preference messages encapsulating the SPC/MOS messages until the MGCF configures the IM-MGW stop sending and detecting SPCs. + +NOTE: In the unlikely case that a first non-empty H.223 MUX-PDU is received before the first MONA Preference Message has been received, the IM-MGW will continue the detection of incoming MONA Preference Messages and will apply the Notify-MONA-preference-Reception-procedure after the Notify-MONA-preference-completed procedure. + +After receiving the notification about the completion of the MONA preference exchange procedure, and a completion of the possible subsequent accelerated H.245 setup procedures, the MGCF shall configure the multiplexing termination T2 + +by indicating to the IM-MGW the contents of the incoming and outgoing multiplex tables (Signal 19), and may modify the selected codecs at both the MUX and the IMS side (signal 21). + +##### E.4.2.7.3 Mn Interactions for MONA MPCs + +![Sequence diagram showing Mn interactions for MONA MPCs between IM MGW and MGCF. The diagram includes 16 numbered messages and associated actions like 'Add Multiplex Termination', 'Notify MONA preference reception', 'Configure Multiplex Termination', and 'Notify MPC'.](3cc095fb84e92690c9d49d3e17c0f1dc_img.jpg) + +``` + +sequenceDiagram + participant IM MGW + participant MGCF + Note left of IM MGW: 3 MONA preference message, Mux Code + Note left of IM MGW: 4 MONA preference message, Mux Code, MPC PDU + Note left of IM MGW: 5 MONA preference message, Mux Code + Note left of IM MGW: 10 PDU in MPC + Note left of IM MGW: 11 MONA preference message, Mux Code + Note left of IM MGW: 12 MONA preference message, Mux Code, MPC PDU + + MGCF->>IM MGW: 1. H.248 ADD.req [C=C1,T=? ... ,Event=MPC-reception, Signal =MPC MUX Code] + Note right of MGCF: Add Multiplex Termination + IM MGW-->>MGCF: 2. H.248 ADD.resp + IM MGW->>MGCF: 6. H.248 : Notify.req [C=C1,T=T2 Event=MONA-preference-reception {MONA preferences},] + Note right of MGCF: Notify MONA preference reception, + MGCF-->>IM MGW: 7. H.248 : Notify.resp + IM MGW->>MGCF: 8. H.248: MOD.req [C=C1, T=T2, Stream=1{LocalCont{.muxtbl_out}}] + Note right of MGCF: Configure Multiplex Termination + MGCF-->>IM MGW: 9. H.248: MOD.resp + IM MGW->>MGCF: 13. H.248 : Notify.req [C=C1,T=T2 Event=MPCin {muxcode=Mux Code}] + Note right of MGCF: Notify MPC + MGCF-->>IM MGW: 14. H.248 : Notify.resp + IM MGW->>MGCF: 15. H.248: MOD.req [C=C1, T=T2, Stream=1{LocalCont{.muxtbl_in}}] + Note right of MGCF: Configure Multiplex Termination + MGCF-->>IM MGW: 16. H.248: MOD.resp + +``` + +Sequence diagram showing Mn interactions for MONA MPCs between IM MGW and MGCF. The diagram includes 16 numbered messages and associated actions like 'Add Multiplex Termination', 'Notify MONA preference reception', 'Configure Multiplex Termination', and 'Notify MPC'. + +NOTE 1: MONA preference messages are repeated several times. One repetition is shown for each such message, with the same signal number as the first message. + +NOTE 2: The Context model in figure E.4.2.2.1 is assumed in this call flow. + +**Figure E.4.2.7.3.1: Mn interactions for MONA MPCs** + +If the MGCF indicates the ability to receive any predefined MPCs channel types in the MONA preferences messages, the MGCF shall request the IM-MGW to report the channel type of received MPC PDUs (Signal 1 in figure E.4.2.7.3.1, Event "MPC Reception"). + +If the MGCF intends to use MPCs for sending media during the MONA setup, the MGCF shall request the IM-MGW to send available media encoded according to the media predefined channel types defined by MONA (signal 1 in figure E.4.2.7.3.1, Signal "MPC MUX Code") while the MONA preference exchange described in clause E.4.2.7.2 is ongoing. The MGCF should select channel types for codecs which are supported by both the IMS side and the IM-MGW, and/or for codecs which could be transcoded by the IM-MGW from the codecs supported by the IMS side. The MGCF shall only include one channel type per each desired media type (audio, video) in the "MPC MUX Code" signal. The MGCF may also configure the MGW to receive these channels at the same time by supplying the Incoming Multiplex Table IE in the Add Multiplex Termination Procedure. + +Upon reception of this request, the IM-MGW shall forward any media received from the IMS side in MPC PDUs of the corresponding predefined channel type attached to MONA preference messages, transcoding the media if required (Signal 4). + +According to the procedures in clause E.4.2.7.2, the IM-MGW will notify the MGCF (signal 6) when receiving the first incoming MONA preference message (Signals 5). The MGCF shall then analyse the Media Preconfigured Channel Receive bits within the MONA preference message and configure the MGW accordingly: + +- If MPC(s) that the MGCF has previously configured within the "MPC MUX Code" signal are supported according to these bits, the MGCF shall configure the IM-MGW to send these MPC using the predefined channels (signal 10) by supplying the corresponding Outgoing Multiplex Table in the Configure Multiplex Termination procedure (signal 8). +- If some of the MPC(s) that the MGCF has previously configured within the "MPC MUX Code" signal are not supported according to these bits, the MGCF shall configure the IM-MGW to terminate the media on those MPC(s) by modifying the MPC Mux Code signal using the Configure Multiplex Termination procedure. In addition, the MGCF may configure the IM-MGW to send media on other supported MPC(s) by supplying the corresponding Outgoing Multiplex Table in the Configure Multiplex Termination procedure (not shown in figure E.4.2.7.3.1). +- If all of the MPC(s) that the MGCF has previously configured within the "MPC MUX Code" signal are not supported according to these bits, the MGCF shall configure the IM-MGW to terminate MPC operations in those unsupported channels. The MGCF shall either remove the MPC Mux Code signal using the Stop MPC procedure or configure the IM-MGW to send media on other supported MPC(s) by supplying the corresponding Outgoing Multiplex Table in the Configure Multiplex Termination procedure (not shown in figure E.4.2.7.3.1). + +When the MGCF provides an Outgoing Multiplex Table, the IM-MGW shall terminate sending any MPC PDUs as attachments to MONA preference message. + +NOTE: Any previously provisioned "MPC MUX Code" signal becomes irrelevant. + +When being notified about the receipt of the first incoming MONA preference message, the MGCF may also analyse the Media Preconfigured Channel Receive bits within the MONA preference message and configure the MGW with a suitable Incoming Multiplex Table using the Configure Multiplex Termination procedure (not shown in figure E.4.2.7.3.1). + +If the IM-MGW receives the first MONA preference message with attached MPC PDU of a given predefined channel type (signal 12), or if the IM-MGW receives the first non-empty H.223 MUX PDU of a given predefined channel type which has been configured with the Incoming Multiplex Table, and the MGCF has requested a notification about such an event, the IM-MGW shall notify the MGCF about the received channel type (signal 13). The IM-MGW shall not notify the MGCF about subsequent receptions of MPC PDUs of the same channel type. + +Upon reception of such a notification, if the IM-MGW supports the indicated channel type and has not yet been configured to receive media of that channel type, and if the MGCF has previously indicated the capability to receive MPCs of that channel type within MONA preference messages, the MGCF shall configure the IM-MGW to receive media of that channel type and forward them to the IMS side by supplying the Incoming Multiplex Table IE in the Configure Multiplex Termination procedure (Signal 15). + +If the MGCF determines (e.g. after receipt of signal 5 or signal 12) that some desired media channels can not be established using the MPC procedures, the MGCF should use accelerated H.245 procedures as defined by MONA to set up media channels. Corresponding H.245 messages shall be transported transparently between the IM-MGW and the MGCF using the "Signal H.245 message" and "Notify H.245 message" procedures. + +The MGCF can receive a forwarded MONA preference message from the IM-MGW when the MGCF has already configured the IM-MGW to send media on an MPC. If the processing of this message in the MGCF leads to the conclusion that MPC procedures need to be aborted because SPC preferred (SPP) is determined, the MGCF shall configure the IM-MGW to terminate MPC operations by removing the MPC related event MPC-reception and MPC Mux Code signal using the Stop MPC procedure. + +##### E.4.2.7.4 Mn Interactions for MONA SPCs + +###### E.4.2.7.4.1 General + +H.245 PDUs for SPC shall be transported between the IM-MGW and MGCF over the Mn interface using H.248 Events (from the IM-MGW towards the MGCF) and H.248 Signals (from the MGCF towards the IM-MGW). The Events/Signals shall contain the following information: + +- H.245 message (binary). + +The related procedures are distinct from the procedures in clause E.4.2.3, since the PDUs are received or sent by the IM-MGW using the SPC, i.e. as attachment to MONA preference messages. + +If the MGCF supports SPCs, it shall comply with the SPC procedures in clause K.8 of ITU-T H.324 [81]. The repetition of sending the same SPCs will be handled by the IM-MGW. When the MGCF receives an acknowledgement from the CS side it shall request the IM-MGW to stop the repetition sending of the SPCs, + +Within the sent SPC PDUs, the MGCF should include the codecs which are supported by both the IMS side and the IM-MGW, and the codecs which could be transcoded by the IM-MGW from the codecs supported by the IMS side. + +###### E.4.2.7.4.2 Transport from MGCF to IM-MGW + +![Sequence diagram showing Mn interactions for sending MONA SPCs between IM-MGW and MGCF.](6361dfaef83c9ffc3b147e1627ba76a1_img.jpg) + +``` + +sequenceDiagram + participant MGCF + participant IM-MGW + Note right of MGCF: Signal SPC + MGCF->>IM-MGW: 1. H.248 MOD.req [C=C1,T=T2, signal=SPCout {h245mc=XXXX} ] + IM-MGW-->>MGCF: 2. H.248 MOD.resp + Note left of IM-MGW: 3. send H.245 message XXXX attached to MONA preference request + IM-MGW->>CS: 3. send H.245 message XXXX attached to MONA preference request + Note left of IM-MGW: 3. send H.245 message XXXX attached to MONA preference request + IM-MGW->>CS: 3. send H.245 message XXXX attached to MONA preference request + +``` + +The diagram illustrates the interaction between the MGCF and the IM-MGW for sending MONA SPCs. The MGCF sends an H.248 MOD.req signal (Signal 1) to the IM-MGW, containing context and signal information. The IM-MGW responds with an H.248 MOD.resp signal (Signal 2). The IM-MGW then sends an H.245 message attached to a MONA preference request (Signal 3) to the CS side. The diagram shows two repetitions of Signal 3, indicating that the message is repeated several times. + +Sequence diagram showing Mn interactions for sending MONA SPCs between IM-MGW and MGCF. + +NOTE 1: MONA preference messages are repeated several times. One repetition is shown for each such message, with the same signal number as the first message. + +NOTE 2: The Context model in figure E.4.2.2.1 is assumed in this call flow. + +**Figure E.4.2.7.4.2.1: Mn interactions for sending MONA SPCs** + +In Signal 1, the MGCF requests the IM-MGW to send an H.245 message to the CS side. To request the IM-MGW to send a H.245 message to the CS side, the MGCF shall send an H.248 signal to the IM-MGW with the complete H.245 message content. + +Upon reception of this signal, the IM-MGW shall send the encapsulated H.245 message within the H.248 signal, as attachment to a MONA preference message as described in clause K.9.4 of ITU-T H.324 [81] (signal 3). It should repeat sending this H.245 message as attachment to subsequent MONA preference messages. + +###### E.4.2.7.4.3 Transport from IM-MGW to MGCF + +![Sequence diagram showing interactions between IM MGW and MGCF for receiving MONA SPCs. The diagram shows five messages: 1. H.248 ADD.req from MGCF to IM MGW; 2. H.248 ADD.resp from IM MGW to MGCF; 3. receive H.245 message attached to MONA preference message from an external source to IM MGW; 4. H.248 Notify.req from IM MGW to MGCF; 5. H.248 Notify.resp from MGCF to IM MGW. Annotations on the right indicate 'Add Multiplex Termination' for message 2 and 'Notify SPC' for message 4.](b51423b6c049f5b5fcde42e50b58f18b_img.jpg) + +``` + +sequenceDiagram + participant External + participant IM_MGW as IM MGW + participant MGCF + Note right of MGCF: Add Multiplex Termination + MGCF->>IM_MGW: 1. H.248 ADD.req [C=C1,T=? ... ,Event=SPC-reception] + IM_MGW-->>MGCF: 2. H.248 ADD.resp + External->>IM_MGW: 3. receive H.245 message attached to MONA preference message + Note right of MGCF: Notify SPC + IM_MGW->>MGCF: 4. H.248 Notify.req [C=C1,T=T2 Event=SPCin {h245mc=XXXX}] + MGCF-->>IM_MGW: 5. H.248 Notify.resp + +``` + +Sequence diagram showing interactions between IM MGW and MGCF for receiving MONA SPCs. The diagram shows five messages: 1. H.248 ADD.req from MGCF to IM MGW; 2. H.248 ADD.resp from IM MGW to MGCF; 3. receive H.245 message attached to MONA preference message from an external source to IM MGW; 4. H.248 Notify.req from IM MGW to MGCF; 5. H.248 Notify.resp from MGCF to IM MGW. Annotations on the right indicate 'Add Multiplex Termination' for message 2 and 'Notify SPC' for message 4. + +NOTE 1: MONA preference messages are repeated several times. One repetition is shown for each such message, with the same signal number as the first message. + +NOTE 2: The Context model in figure E.4.2.2.1 is assumed in this call flow. + +**Figure E.4.2.7.4.3.1: Mn interactions for receiving MONA SPCs** + +In signal 1, the MGCF requests the IM-MGW to detect received H.245 message from the CS side in SPC PDUs attached to MONA preference messages and forward them to the MGCF. To request the IM-MGW to detect and forward these H.245 message, the MGCF shall send a suitable H.248 event to the IM-MGW. The event may be indicated through an H.248 ADD command. + +In signal 3, the IM-MGW receives an H.245 message from the CS side attached as SPC PDU to a MONA preference message. Upon reception of such an H.245 message from the CS side, the IM-MGW may check, based on bitwise comparison of the previously received H.245 message, if it has already forwarded the same H.245 message to the MGCF, in which case the IM-MGW may choose not to forward the same H.245 message to the MGCF. Otherwise the IM-MGW shall forward the H.245 message to the MGCF within an H.248 Notify command (signal 4). + +NOTE: According to H.324 [81] a MOS request Ack message shall be sent to every received MOS request. If the IM-MGW chooses, based on the bitwise comparison, not to forward the received H.245 message to the MGCF, no MOS request Ack message will be generated. However, the MGCF will request the IM-MGW to automatically retransmit the MOS request Ack message generated by the MGCF itself. + +If the IM-MGW does not support forwarding SPC PDUs or has not been requested by the MGCF to forward these PDUs, it shall discard received SPC PDUs. + +###### E.4.2.7.4.4 Termination of SPC procedure + +![Sequence diagram showing the termination of SPC procedure between IM MGW and MGCF.](9870bf462aa0d916a16d14b5a100c60a_img.jpg) + +``` +sequenceDiagram + participant IM MGW + participant MGCF + Note left of IM MGW: 1 receive final H.245 message attached to MONA preference message + IM MGW->>MGCF: 2 H.248 : Notify.req [C=C1,T=T2 Event=SPCin {h245mc=XXXX}] + Note right of MGCF: Notify SPC + MGCF-->>IM MGW: 3 H.248 : Notify.resp + MGCF->>IM MGW: 4 H.248 MOD.req [C=C1,T=T2 Remove Signal-SPC+ SPC-reception] + Note right of MGCF: Stop SPC + IM MGW-->>MGCF: 5 H.248 MOD.resp +``` + +The diagram illustrates the interaction between the IM MGW and the MGCF for terminating the SPC procedure. It consists of five numbered messages: 1. An external message received by the IM MGW; 2. A Notify.req message from IM MGW to MGCF; 3. A Notify.resp message from MGCF to IM MGW; 4. A MOD.req message from MGCF to IM MGW; 5. A MOD.resp message from IM MGW to MGCF. Annotations on the right side indicate the actions 'Notify SPC' and 'Stop SPC' associated with the MGCF's messages. + +Sequence diagram showing the termination of SPC procedure between IM MGW and MGCF. + +NOTE 2: The Context model in figure E.4.2.2.1 is assumed in this call flow. + +**Figure E.4.2.7.4.4.1: Mn interactions for terminating SPC procedure** + +If the processing of an incoming MONA Preference Message in the MGCF leads to the conclusion that SPC procedures need to be aborted as a result of the test of the SPC bits, the MGCF shall configure the IM-MGW to terminate SPC operations by removing the SPC related event SPC-reception and SPCout signal using the Stop SPC procedure. In this case, H.245 signalling may be started simultaneously. + +If the MGCF determines the completion of the SPC procedures according to clause K.8 of ITU-T H.324 [81] (based on incoming signal 1 in figure E.4.2.7.4.4.1), the MGCF shall configure the IM-MGW to stop sending and detecting SPCs (signal 4 in figure E.4.2.7.4.4.1). + +##### E.4.2.7.5 Mn Interactions for fallback from MONA procedures to standard H.324 setup + +![Sequence diagram showing Mn signalling interactions for fallback from MONA procedures to standard H.324 setup between IM MGW and MGCF.](1cac1845cf99a3f64ae00cd2bb4f9ed7_img.jpg) + +``` + +sequenceDiagram + participant IM MGW + participant MGCF + Note right of MGCF: Prepare Bearer or Establish Bearer or Reserve TDM Circuit + IM MGW->>MGCF: 1. H.248: ADD.req [C=?, T=?, stream=1] + MGCF-->>IM MGW: 2. H.248: ADD.resp [C=C1, T=T1] + Note right of MGCF: Reserve IMS Connection Point or Reserve IMS Connection Point and Configure Remote Resources + IM MGW->>MGCF: 3. H.248: ADD.req [C=C1, T=?, stream=2(Codec=H.263), stream=3(Codec=AMR)] + MGCF-->>IM MGW: 4. H.248: ADD.resp [C=C1, T=T3] + Note left of IM MGW: 5. Bearer Establishment + Note right of MGCF: Add Multiplex Termination + IM MGW->>MGCF: 6. H.248: ADD.req [C=C1, T=?, Mux=H223.T1, LocalControl(MONA preferences, muxlv=2), Event=legacyDetected(h245msgout{octet string}), MONA-preference-reception, MONA-preference-completed, H245msgin, MPC-reception, SBCin] + MGCF-->>IM MGW: 7. H.248: ADD.resp [C=C1, T=T2] + IM MGW->>IM MGW: 8. MONA preferences [ack=00] + IM MGW->>IM MGW: 8. MONA preferences [ack=00] + IM MGW->>MGCF: 9. Legacy interworking condition + MGCF-->>IM MGW: 10. octet string (H.245 TCS+MSD) + Note right of MGCF: Notify detection of legacy interworking + IM MGW->>MGCF: 11. H.248 : Notify.req [C=C1,T=T2] + MGCF-->>IM MGW: Event=legacyDetected + IM MGW->>MGCF: 12. H.248 : Notify.resp + Note left of IM MGW: 13. standard H.245 call setup procedures continuation, Figure E.4.2.4.1 starting with step 9 + +``` + +Sequence diagram showing Mn signalling interactions for fallback from MONA procedures to standard H.324 setup between IM MGW and MGCF. + +NOTE 1: MONA preference messages are repeated several times. One repetition is shown for each such message, with the same signal number as the first message. + +NOTE 2: The Context model in figure E.4.2.2.1 is assumed in this call flow. + +**Figure E.4.2.7.5.1: Mn signalling interactions for fallback from MONA procedures to standard H.324 setup** + +When the MGCF requests that the MONA preferences negotiation is started, the MGCF may also initiate standard H.245 signalling towards the IM-MGW that shall only be sent in case the IM-MGW detects legacy interworking. The MGCF arms an event to detect legacy interworking with an embedded signal descriptor including an H.245 message out signal. The embedded H.245 signal is the initial H.245 TCS+MSD signal to send in case fallback to legacy interworking is detected. The MGCF shall also request to be notified about an H.245 message on the H.223 control channel. The MGCF shall also provision a multiplexing level which will be advertised by the IM-MGW (Signal 6). + +If the IM-MGW detects a legacy interworking condition (signal 9), it shall stop sending MONA preference messages, including those MONA messages used to encapsulate MPC or SPC. The IM-MGW shall engage in normal H.324 multiplexing level negotiations. In case the MGCF armed a legacy detection event, the embedded H.245 signal shall be sent by the IM-MGW (signal 10). The legacy detection event is sent to the MGCF (signal 11). + +The MGCF shall upon detection of legacy interworking stop MONA procedures and continue with standard H.245 call set up procedures, as depicted in figure E.4.2.4.1 starting with step 9. + +If the IM-MGW receives a normal H.245 message (not depicted), it shall also forward this message to the MGCF. If the MGCF receives such a H.245 message during the MONA call setup, and this H.245 message is a normal Terminal Capability Set message, the MGCF shall also stop MONA procedures and continue with standard H.245 call set up procedures, as depicted in figure E.4.2.4.1 starting with step 9. + +To stop MONA related procedures at the IM-MGW, the MGCF shall remove the MONA related signals that were active (MONA Preferences, SPCout, MPC Mux Code; note that MONA Preference and SPCout causes the MGW to send the MONA Preference message or the contained H.245 message several times) and events (MonaPreferenceReception, MonaPreferenceCompleted, SPC-reception and MPC-reception, using the Stop MONA Negotiation procedure). + +#### E.4.2.8 Interworking between RTCP messages and H.245 messages + +##### E.4.2.8.1 Overview + +The following clauses describe the interworking procedures between the RTCP messages listed in table E.4.2.8.1.1, which are used to enhance the quality of the media distribution by MTSI terminals at the IMS side, and the corresponding H.245 messages in 3G-324M at the CS side listed in table E.4.2.8.1.1. + +As the H.245 protocol is terminated at the MGCF and RTCP is received at the IM-MGW, Mn procedures to support the transfer of RTCP related information are defined in the following Clauses to support this interworking. + +**Table E.4.2.8.1.1: RTCP and H.245 messages that may be interworked** + +| RTCP Messages | H.245 messages | Remarks | +|-----------------------------------------------------------------|-----------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Picture Loss Indication (PLI) ([109]) | VideoFastUpdatePicture | | +| Temporary Maximum Media Stream Bit Rate Request (TMMBR) ([110]) | Flow Control Command/ Flow Control Indication | This interworking procedure is not recommended.
The reception of TMMBR at the IMS side is expected to be more frequent than the reception of Flow Control Command at the CS side. | + +NOTE 1: It is very unlikely that the MGCF will receive a Flow control command, as the capability of controlling the video bit rate during a video call was neither implemented nor tested for Ues offering 3G-324M since R99, due to the lack of such a necessity in WCDMA where a fixed 64 kbps bearer is maintained to continuously transport 3G-324M PDUs. + +NOTE 2: Terminals are expected to support receiving the FlowControlCommand, as this is a mandatory feature in clause 6.4.3 in H.324. But most terminals would not really follow the received FlowControlCommand, but rather ignore it. However, for older 3G-324M terminal lock-up or system crash was not uncommon during IOTs. Therefore safe handling of this command is not guaranteed absolutely + +The interworking shown in table E.4.2.8.1.1 is only applicable if video is relayed without transcoding. + +If transcoding is applied, the IM-MGW should adopt its transcoder accordingly if receiving the RTCP messages listed in table E.4.2.8.1.1, and the MGCF should configure the transcoder in the IM-MGW accordingly if it receives the H.245 messages in table E.4.2.8.1.1. + +For an MGCF and IM-MGW that support video interworking as specified in the present Annex E, the support of the procedures in the present clause E.4.2.8.2 and E.4.2.8.3 is optional. + +##### E.4.2.8.2 IM CN subsystem originated RTCP messages + +The MGCF may configure the IM-MGW to detect specific received RTCP packets and forward information derived from it by providing a bit pattern(s) for bits 3-15 of incoming RTCP packets as filter criterion in an event descriptor of event "RTCP-interworking". Bits 3-7 in the RTCP packet represent the Feedback message type (FMT), and bits 8-15 in the RTCP packet represent the Payload type (PT) RTCP header fields, see IETF RFC 4585 [109]. For instance, to request that an AVPF Picture Loss Indication (PLI) packet is detected for interworking, the MGCF needs to configure a combination of PT=206 (Payload-specific FB message) and FMT=1 (see IETF RFC 4585 [109]). To request that a AVPF Temporary Maximum Media Bit-rate Request (TMMBR) packet is detected for interworking, the MGCF needs to configure a combination of PT=205 (transport layer feedback message) and FMT=3 (see IETF RFC 5104 [110]). + +A IM-MGW configured in this way shall check after receiving an incoming RTCP Packet if it is of a desired type, as expressed by a bit pattern received from the MGCF. An incoming RTCP message can be of compound format and contain several RTCP packets. The IM-MGW shall then perform the check separately for each packet. If the IM-MGW determines that the received RTCP packet is of a desired type, the IM-MGW shall send information derived from the RTCP message as ObservedEventsDescriptor Parameter(s) of event "RTCP-interworking" in an H.248 "Notify" message to the MGCF. + +The information derived from the RTCP message to be sent to the MGCF is listed in table E.4.2.8.2.1. Information elements in table E.4.2.8.2.1 shall only be sent if the corresponding RTCP message has been received. + +Table E.4.2.8.2.1: RTCP information elements to be notified over Mn + +| RTCP message | Information elements transported over Mn interface | Remarks | +|-----------------------------------------------------------------|----------------------------------------------------|--------------------------------------------------------------------------------------------| +| Picture Loss Indication (PLI) ([109]) | UpdatePicture | | +| Temporary Maximum Media Stream Bit Rate Request (TMMBR) ([110]) | MaxBitRate | This information indicates the maximum media stream bit rate as received within the TMMBR. | + +Figure E.4.2.8.2.2.1 shows examples of interactions between RTCP and H.245 for IM CN subsystem originated feedback on the quality of the media distribution. + +![Sequence diagram showing interactions between IMS, IM MGW, MGCF, and CS Network for RTCP feedback. The diagram illustrates a call in an active state with various signaling messages exchanged between the components.](5d782eeb9d1e5871d7f09e0ccdd4cdf1_img.jpg) + +``` + +sequenceDiagram + participant IMS + participant IM_MGW as IM MGW + participant MGCF + participant CS_Network as CS Network + + Note over IM_MGW, MGCF: CALL IN ACTIVE STATE + + MGCF->>IM_MGW: 1. H.248: MOD.req [C=C1, T=T1..., Event=RTCP-Interworking] + IM_MGW-->>MGCF: 2. H.248: MOD.resp + IMS->>IM_MGW: 3. receive RTCP feedback messages + IM_MGW-->>IMS: 4. send RTCP feedback Ack messages + IM_MGW->>MGCF: 5. H.248: Notify.req [C=C1, T=T1, Event=RTCP-Interworking] + MGCF-->>IM_MGW: 6. H.248: Notify.resp + MGCF->>CS_Network: 7. send H.245 message + CS_Network-->>MGCF: 8. receive H.245 message response + +``` + +Sequence diagram showing interactions between IMS, IM MGW, MGCF, and CS Network for RTCP feedback. The diagram illustrates a call in an active state with various signaling messages exchanged between the components. + +Figure E.4.2.8.2.2.1: Interactions between RTCP and H.245 for IM CN subsystem originated RTCP feedback on the quality of the media distribution + +In signal 1, the MGCF requests the IM-MGW to detect received RTCP feedback message from the IMS side and notify the feedback information elements to the MGCF when the interworking is required. To request the IM-MGW to detect and notify these feedback information elements, the MGCF shall send the "RTCP-interworking" H.248 event to the IM-MGW. The event may be indicated through an H.248 MOD command. + +In signal 3, the IM-MGW receives a RTCP feedback message from the IMS side. + +In signal 5, the IM-MGW notifies the feedback information elements from RTCP message to the MGCF. + +In signal 7, the MGCF send the corresponding H.245 message to the CS side to request for the media adaption. + +##### E.4.2.8.3 CS network originated H.245 messages + +Figure E.4.2.8.3.2.1 shows examples of interactions between H.245 and RTCP for CS network originated feedback on the quality of the media distribution. + +![Sequence diagram showing interactions between IMS, IM MGW, MGCF, and CS Network for H.245 feedback. The diagram starts with a 'CALL IN ACTIVE STATE' message from CS Network to IM MGW. Then, MGCF receives an H.245 feedback message from CS Network (1), sends a response (2), and requests an RTCP message from IM MGW (3). IM MGW responds (4), sends the RTCP feedback message to IMS (5), and receives an RTCP feedback Ack message from IMS (6).](9f6dec4d4e9fde40bce018861ef1278e_img.jpg) + +``` + +sequenceDiagram + participant IMS + participant IM MGW + participant MGCF + participant CS Network + + Note left of IM MGW: CALL IN ACTIVE STATE + CS Network->>MGCF: 1. receive H.245 message to feedback on the quality of the data distribution + MGCF-->>CS Network: 2. send H.245 message response + MGCF->>IM MGW: 3. H.248: MOD.req [C=C1, T=T1..., signal=H.245-Interworking] + IM MGW-->>MGCF: 4. H.248: MOD.resp + IM MGW->>IMS: 5. send RTCP feedback message + IMS-->>IM MGW: 6. receive RTCP feedback Ack message + +``` + +Sequence diagram showing interactions between IMS, IM MGW, MGCF, and CS Network for H.245 feedback. The diagram starts with a 'CALL IN ACTIVE STATE' message from CS Network to IM MGW. Then, MGCF receives an H.245 feedback message from CS Network (1), sends a response (2), and requests an RTCP message from IM MGW (3). IM MGW responds (4), sends the RTCP feedback message to IMS (5), and receives an RTCP feedback Ack message from IMS (6). + +**Figure E.4.2.8.3.2.1: Interactions between H.245 and RTCP for CS network originated H.245 feedback on the quality of the media distribution** + +In signal 1, the MGCF receives an H.245 feedback message from the CS side. + +In signal 3, the MGCF requests the IM\_MGW to send an RTCP message provisioning the signal "H.245 interworking" with parameters identifying information to be transported within this RTCP message. + +In signal 5, the IM-MGW send the corresponding RTCP message to the IMS side to request for the media adaption. + +To request the IM-MGW to send an RTCP message, the MGCF shall send the corresponding information elements listed in table E.4.2.8.3.2.1 as parameters of the "H.245-interworking signal" over the Mn interface. + +**Table E.4.2.8.3.2.1: Feedback information elements to be indicated** + +| RTCP message | Information elements transported over Mn interface | Remarks | +|-----------------------------------------------------------------|----------------------------------------------------|-------------------------------------------------------------------------------------------| +| Picture Loss Indication (PLI) ([109]) | UpdatePicture | | +| Temporary Maximum Media Stream Bit Rate Request (TMMBR) ([110]) | MaxBitRate | This information indicates the maximum media stream bit rate to be sent within the TMMBR. | + +### E.4.3 Mn Signalling procedures + +#### E.4.3.1 Overview + +This clause describes the logical signalling procedures (i.e. message identifiers are not part of the protocol) between the MGCF and IM-MGW. The procedures within this clause are intended to be implemented using the standard H.248 procedure as defined in ITU recommendation H.248.1 [2] with appropriate parameter combinations. + +#### E.4.3.2 Add Multiplex Termination + +This procedure is used to add a termination to multiplex/demultiplex H.223. This procedure containing the MuxDescriptor with H.223 value enables the IM-MGW to start the H.324 Multiplexing Level Negotiation. + +**Table E.4.3.2.1: Add Multiplex Termination Procedure** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|-------------------------------|-----------|---------------------------------------------|------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Add Multiplex Termination | MGCF | Context | M | This information element indicates the existing context. | +| | | Termination | M | This information element requests a new termination | +| | | MuxDescriptor | M | This information element indicates that data multiplexed according to H.223 shall be received, and from which termination. | +| | | Notify Termination Heartbeat | M | This information element requests termination heartbeat indications | +| | | Notify Released Bearer | O | This information element requests a notification of a released bearer. | +| | | Incoming H.245 message Notification Request | M | This Event shall indicate that a Notification about H.245 messages received by the IM-MGW is requested by the MGCF | +| | | MONA Preferences | O | This information element requests the MGW to start a MONA negotiation and provisions MONA preferences to be indicated by the IM-MGW, encoded as described in clause K.6 of ITU-T H.324 [81] | +| | | MONA Preference Reception | O | This information element requests a notification of the reception of the first MONA preference message. | +| | | MONA Preference Completed | O | This information element requests a notification of the reception of the first MONA preference message with indication that the MONA preference negotiation is completed. | +| | | Legacy Detected | O | This information element requests a notification of a legacy interworking condition. The Event Descriptor also embeds a signal descriptor including an H.245 message out signal which shall be send when legacy interworking is detected | +| | | MPC Reception | O | This information element requests a notification of the reception of the first MONA preference message with attached MPC. | +| | | SPC Reception | O | This information element requests a notification of the reception of a MONA preference message with attached SPC. | +| | | Incoming Multiplex Table | O | This information element indicates the value of the H.245 MultiplexEntrySend message and allows the MGW to identify incoming H.223 MUX PDUs of the channel types given in the table. | +| | | MPC Mux Code | O | This information element requests the MGW to send available media in MPCs and indicates the channel type to use for sending media. | +| Add Multiplex Termination Ack | IM-MGW | Context | M | This information element indicates the context where the command was executed. | +| | | Termination | M | This information element indicates the new termination where the command was executed. | + +#### E.4.3.3 Configure Multiplex Termination + +This procedure is used to configure a termination to multiplex/demultiplex H.223. It is also used to exclude some of the outgoing MPC channel types due to the MONA Preference received from the peer. + +**Table E.4.3.3.1: Configure Multiplex Termination Procedure** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|-------------------------------------|-----------|--------------------------|------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Configure Multiplex Termination | MGCF | Context | M | This information element indicates the existing context. | +| | | Termination | M | This information element indicates the termination | +| | | Remote H223 Capability | O | This information element indicates the remote H223 capabilities, as received by the MGCF. The element shall not be included if the MPC Mux Code IE is included. | +| | | Incoming Multiplex Table | O | This information element indicates the value of the H245 MultiplexEntrySend message, as received by the MGCF from the remote H.245 peer. Either this element or the MPC Mux Code IE shall be included. | +| | | Outgoing Multiplex Table | O | This information element indicates the value of the H245 MultiplexEntrySend message, as sent by the MGCF towards the remote H.245 peer. Either this element or the MPC Mux Code IE shall be included. | +| | | MPC Mux Code | O | This information element requests the MGW to continue sending available media in MPC and indicates the channel type to use for sending media. It is used in this procedure only to restrict the list of channel types indicated previously in the Add Multiplex Termination procedure. Either this element or the Incoming and Outgoing Multiplex Table elements shall be included. | +| Configure Multiplex Termination Ack | IM-MGW | Context | M | This information element indicates the context where the command was executed. | +| | | Termination | M | This information element indicates the termination where the command was executed. | + +#### E.4.3.4 Signal H245 Message + +This procedure is used to send a H245 message to the IM-MGW that the IM-MGW shall forward towards the CS side within H.223. + +**Table E.4.3.4.1: Signal H245 Message Procedure** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|-------------------------|-----------|--------------------------|------------------------------|------------------------------------------------------------------------------------------------------------------------| +| Signal H245 Message | MGCF | Context | M | This information element indicates the existing context. | +| | | Termination | M | This information element indicates the termination | +| | | Signal | M | This information element indicates the signal to request forwarding of a H245 message towards the CS side within H.223 | +| | | H.245 message | M | This information element indicates the H.245 message to be forwarded | +| Signal H245 Message Ack | IM-MGW | Context | M | This information element indicates the context where the command was executed. | +| | | Termination | M | This information element indicates the termination where the command was executed. | + +#### E.4.3.5 Notify H245 Message + +This procedure is used by the IM-MGW to notify the MGCF that the IM-MGW has received a H245 message from the CS side within H.223. + +**Table E.4.3.5.1: Notify H245 Message Procedure** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|-------------------------|-----------|--------------------------|------------------------------|------------------------------------------------------------------------------------------------------------------------------| +| Notify H245 Message | IM-MGW | Context | M | This information element indicates the existing context. | +| | | Termination | M | This information element indicates the termination | +| | | Event | M | This information element indicates the event to indicate that a H245 message has been received from the CS side within H.223 | +| | | H.245 message | M | information element indicates the received H.245 message | +| Notify H245 Message Ack | MGCF | Context | M | This information element indicates the context where the command was executed. | +| | | Termination | M | This information element indicates the termination where the command was executed. | + +#### E.4.3.6 Notify MONA Preference Reception + +This procedure is used by the IM-MGW to notify the MGCF that the IM-MGW has received the first MONA preference Message from the CS side. + +**Table E.4.3.6.1: Notify MONA Preference Reception Procedure** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|-------------------------|-----------|--------------------------|------------------------------|-----------------------------------------------------------------------------------------------------------| +| Notify H245 Message | IM-MGW | Context | M | This information element indicates the existing context. | +| | | Termination | M | This information element indicates the termination | +| | | Event | M | This information element indicates the event to indicate that a MONA Preference Message has been received | +| | | MONA Preferences | M | This information element indicates the received MONA preference message | +| Notify H245 Message Ack | MGCF | Context | M | This information element indicates the context where the command was executed. | +| | | Termination | M | This information element indicates the termination where the command was executed. | + +#### E.4.3.7 Notify MONA Preference Completed + +This procedure is used by the IM-MGW to notify the MGCF that the IM-MGW has received the first MONA preference Message with indication that the MONA preference negotiation is completed. + +**Table E.4.3.7.1: Notify MONA Preference Completed Procedure** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|-------------------------|-----------|--------------------------|------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Notify H245 Message | IM-MGW | Context | M | This information element indicates the existing context. | +| | | Termination | M | This information element indicates the termination | +| | | Event | M | This information element indicates the event to indicate that the first MONA preference Message with indication that the MONA preference negotiation is completed received | +| Notify H245 Message Ack | MGCF | Context | M | This information element indicates the context where the command was executed. | +| | | Termination | M | This information element indicates the termination where the command was executed. | + +#### E.4.3.8 Signal SPC + +This procedure is used to send a H245 message to the IM-MGW that the IM-MGW shall forward towards the CS side using the SPC, i.e. as attachment to MONA preference messages. + +**Table E.4.3.8.1: Signal SPC Procedure** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|-------------------------|-----------|--------------------------|------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Signal H245 Message | MGCF | Context | M | This information element indicates the existing context. | +| | | Termination | M | This information element indicates the termination | +| | | Signal | M | This information element indicates the signal to request forwarding of a H245 message towards the CS side using the SPC, i.e. as attachment to MONA preference messages | +| | | H.245 message | M | This information element indicates the H.245 message to be forwarded | +| Signal H245 Message Ack | IM-MGW | Context | M | This information element indicates the context where the command was executed. | +| | | Termination | M | This information element indicates the termination where the command was executed. | + +#### E.4.3.9 Notify SPC + +This procedure is used by the IM-MGW to notify the MGCF that the IM-MGW has received a H245 message from the CS side in SPC PDUs attached to MONA preference messages. + +**Table E.4.3.9.1: Notify SPC Procedure** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|-------------------------|-----------|--------------------------|------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Notify H245 Message | IM-MGW | Context | M | This information element indicates the existing context. | +| | | Termination | M | This information element indicates the termination | +| | | Event | M | This information element indicates the event to indicate that a H245 message has been received from the CS side in SPC PDUs attached to MONA preference messages | +| | | H.245 message | M | information element indicates the received H.245 message | +| Notify H245 Message Ack | MGCF | Context | M | This information element indicates the context where the command was executed. | +| | | Termination | M | This information element indicates the termination where the command was executed. | + +#### E.4.3.10 Notify MPC + +This procedure is used by the IM-MGW to notify the MGCF that the IM-MGW has received the first MONA preference message with attached MPC from the CS side. + +**Table E.4.3.10.1: Notify MPC Procedure** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|-------------------------|-----------|--------------------------|------------------------------|--------------------------------------------------------------------------------------------------------------------------------------| +| Notify H245 Message | IM-MGW | Context | M | This information element indicates the existing context. | +| | | Termination | M | This information element indicates the termination | +| | | Event | M | This information element indicates the event to indicate that the first MONA preference message with attached MPC has been received. | +| | | MuxCode | M | information element that indicates the received Channel Type | +| Notify H245 Message Ack | MGCF | Context | M | This information element indicates the context where the command was executed. | +| | | Termination | M | This information element indicates the termination where the command was executed. | + +#### E.4.3.11 Notify Detection of Legacy Interworking + +This procedure is used by the IM-MGW to notify the MGCF that the IM-MGW detects a legacy interworking condition that causes it to abort MONA procedures. + +**Table E.4.3.11.1: Notify Detection of Legacy Interworking Procedure** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|-------------------------|-----------|--------------------------|------------------------------|------------------------------------------------------------------------------------------------------------------| +| Notify H245 Message | IM-MGW | Context | M | This information element indicates the existing context. | +| | | Termination | M | This information element indicates the termination | +| | | Event | M | This information element indicates the event to indicate that a legacy interworking condition has been detected. | +| Notify H245 Message Ack | MGCF | Context | M | This information element indicates the context where the command was executed. | +| | | Termination | M | This information element indicates the termination where the command was executed. | + +#### E.4.3.12 Request RTCP-Interworking + +This procedure is used by the MGCF to request the IM-MGW to detect the RTCP feedback message on the quality of the media distribution requiring interworking. + +**Table E.4.3.12.1: Request RTCP-Interworking** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|-------------------------------|-----------|--------------------------|------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Request RTCP-Interworking | MGCF | Context | M | This information element indicates the existing context. | +| | | Termination | M | This information element indicates an existing | +| | | RTCPfilter | M | This information element provides one or several bit pattern(s) for bits 3-15 of an RTCP packet. Information from RTCP packets that match those patterns shall be notified to the MGCF. | +| | | RTCP-Interworking | M | This information element requests a notification about information derived from the incoming RTCP packet types denoted by RTCPfilter. | +| Request RTCP-Interworking Ack | IM-MGW | Context | M | This information element indicates the context where the command was executed. | +| | | Termination | M | This information element indicates the new termination where the command was executed. | + +#### E.4.3.13 Notify RTCP-Interworking + +This procedure is used by the IM-MGW to notify the MGCF the feedback information elements when the IM-MGW detects a RTCP feedback message on the quality of the media distribution requiring interworking. + +**Table E.4.3.13.1: Notify of RTCP-Interworking** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|------------------------------|-----------|--------------------------|------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Notify RTCP-Interworking | IM-MGW | Context | M | This information element indicates the existing context. | +| | | Termination | M | This information element indicates the termination | +| | | UpdatePicture | C | This information element shall be included upon reception of a RTCP PLI message. It indicates the request of sending of full intra-pictures. | +| | | MaxBitRate | C | This information element shall be included upon reception of a RTCP TMMBR message. It shall contain the bandwidth as indicated in the RTCP TMMBR message excluding the overhead indicated in the RTCP TMMBR message. | +| Notify RTCP-Interworking Ack | MGCF | Context | M | This information element indicates the context where the command was executed. | +| | | Termination | M | This information element indicates the termination where the command was executed. | + +#### E.4.3.14 Signal-H.245-Interworking + +This procedure is used by the MGCF to indicate the IM-MGW the feedback information elements when a H.245 feedback message on the quality of the media distribution requiring interworking is received. + +**Table E.4.3.14.1: Signal H.245-Interworking** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|-------------------------------|-----------|--------------------------|------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Signal H.245-Interworking | MGCF | Context | M | This information element indicates the existing context. | +| | | Termination | M | This information element indicates the termination | +| | | UpdatePicture | C | This information element indicates the request to send a RTCP PLI message. | +| | | MaxBitRate | C | This information element indicates the request to send a RTCP TMBR message. It shall contain the bandwidth as indicated in the RTCP TMMBR message excluding the overhead indicated in the RTCP TMMBR message. | +| Signal H.245-Interworking Ack | IM-MGW | Context | M | This information element indicates the context where the command was executed. | +| | | Termination | M | This information element indicates the termination where the command was executed. | + +#### E.4.3.15 Stop MPC + +This procedure is used by the MGC to indicate to the MG that it is no longer allowed to send MPC media encapsulated in MONA Preference messages and that it shall stop MPC detection. + +**Table E.4.3.15.1: Stop MPC** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|--------------|-----------|--------------------------|------------------------------|-------------------------------------------------------------------------------------------------------------------------| +| Stop MPC | MGCF | Context | M | This information element indicates the existing context. | +| | | Termination | M | This information element indicates the termination | +| | | Stop MPC Reception | M | This information element indicates that the reception of MPC encapsulated in MONA Preference Messages shall be stopped. | +| | | Stop MPC Sending | M | This information element requests that the sending of the MPC shall be stopped. | +| Stop MPC Ack | IM-MGW | Context | M | This information element indicates the context where the command was executed. | +| | | Termination | M | This information element indicates the termination where the command was executed. | + +#### E.4.3.16 Stop SPC + +This procedure is used by the MGC to indicate to the MG that it is no longer allowed to send MPC media encapsulated in MONA Preference messages and that it shall stop SPC detection. + +**Table E.4.3.16.1: Stop MPC** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|--------------|-----------|--------------------------|------------------------------|--------------------------------------------------------------------------------------------------------------------------------| +| Stop SPC | MGCF | Context | M | This information element indicates the existing context. | +| | | Termination | M | This information element indicates the termination | +| | | Stop SPC Sending | M | This information element requests that the sending of SPC encapsulated in MONA Preference messages shall be stopped. | +| | | Stop SPC Detection | M | This information element requests that the detection of received SPC encapsulated in MONA Preference Message shall be stopped. | +| Stop SPC Ack | IM-MGW | Context | M | This information element indicates the context where the command was executed. | +| | | Termination | M | This information element indicates the termination where the command was executed. | + +#### E.4.3.17 Stop MONA Negotiation + +This procedure is used by the MGC to request the MG to stop all MONA negotiation related procedures. + +**Table E.4.3.17.1: Stop MONA Negotiation** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|---------------------------|-----------|--------------------------------------|------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Stop MONA Negotiation | MGCF | Context | M | This information element indicates the existing context. | +| | | Termination | M | This information element indicates the termination | +| | | Stop MONA Preference Message Sending | M | This information element requests that the sending of MONA Preference messages be stopped. | +| | | Stop MONA Detection | M | This information element requests that the detection of first MONA Preference Message and of the MONA negotiation completion be stopped. | +| | | Stop SPC Sending | C | This information element requests that the sending of SPC encapsulated in MONA Preference messages be stopped. Required only if SPC sending was previously configured. | +| | | Stop SPC Detection | C | This information element requests that the detection of received SPC encapsulated in MONA Preference Message be stopped. Required only if SPC reception was previously configured. | +| | | Stop MPC Reception | C | This information element indicates that the reception of MPC encapsulated in MONA Preference Messages shall be stopped. Required only if MPC reception was previously configured. | +| | | Stop MPC Sending | C | This information element requests that the sending of the MPC shall be stopped. Required only if MPC sending was previously configured. | +| Stop MONA Negotiation Ack | IM-MGW | Context | M | This information element indicates the context where the command was executed. | +| | | Termination | M | This information element indicates the termination where the command was executed. | + +# Annex F (normative): PSTN XML Scheme + +## F.1 Scope + +This clause defines the PSTN XML Schema to be used for providing the BearerCapability, Low Layer Compatibility, High Layer Compatibility and Progress indicator embedded as body in SIP messages. + +The support of this PSTN XML Schema is a network option. + +## F.2 MIME type + +The XML schema defined in the present Annex is registered at IANA as "application/vnd.etsi.pstn+xml" MIME type. + +If the XML scheme is embedded in SIP messages as body, the Content-Type header shall be set to "application/vnd.etsi.pstn+xml" and the Content-Disposition shall be set to "signal" with the "handling" parameter set to "optional". + +## F.3 XML Schema definition + +``` + + + + XML Schema definition for mapping of some PSTN into SIP MIME Bodies + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +## F.4 IANA registration template + +Within the present subclause, information required for an IANA registration at is provided. + +### 1. Media Type Name + +Application + +### 2. Subtype name + +"vnd.etsi.pstn+xml" (Vendor Tree) + +### 3. Required parameters + +none + +### 4. Optional parameters + +none + +### 5. Encoding considerations + +binary + +### 6. Security considerations + +The security considerations for XML in RFC 3023 apply. + +Modifications of the MIME body by a man-in-the-middle can have severe consequences: + +The information derived from ISUP that can be transported with this MIME body influence the call handling of the SIP session that is being setup. + +However, this MIME body is used only attached to SIP messages, and modifications of other parts of the SIP signalling will lead to comparable consequences. Protection of the SIP signalling will also protect the present MIME body. The SIP signalling should be protected as described in RFC 3261. + +### 7. Interoperability considerations + +None + +### 8. Published specification + +3GPP TS 29.163 + +### 9. Applications which use this media type + +This MIME type is used as a message body within SIP messages. + +It is used for sending information derived from ISUP or DSS1 signalling with no SIP equivalent. + +### 10. Additional information + +Magic number(s): none (see RFC 3023) + +File extension(s): ".xml" (see RFC 3023) + +Macintosh File Type Code(s): "Text" (see RFC 3023) + +Object Identifier(s) or OID(s): none + +### 11. Intended usage + +Limited Use + +### 12. Other Information/General Comment + +The content of this MIME type is UTF-8 encoded. The charset parameter is not used. + +# --- Annex G (informative): Void + +NOTE: The former contents of this annex are now contained in 3GPP TS 24.229 [9]. + +# --- Annex H (normative): Interworking of Originating Line Information (OLI) parameter (network option) + +## --- H.1 Interworking SIP to ISUP + +The "oli" URI parameter received within tel URI or the userinfo part of SIP URI with user="phone" (as defined in clause 7.2A.12 of 3GPP TS 24.229 [9]) received in a P-Asserted-Identity header in the initial INVITE request shall be used to set the ISUP IAM OLI parameter. In case the P-Asserted-Identity URI "oli" parameter is absent then the ISUP IAM OLI parameter shall be omitted. + +## --- H.2 Interworking ISUP to SIP + +The ISUP IAM OLI parameter shall be used to set the "oli" URI parameter within tel URI or the userinfo part of SIP URI with user="phone" parameter (as defined in clause 7.2A.12 of 3GPP TS 24.229 [9]) of a P-Asserted-Identity header in the initial INVITE request. In case the ISUP IAM OLI parameter is absent then the P-Asserted-Identity URI "oli" parameter shall be omitted from the initial INVITE request. + +# Annex I (normative): + +# GTT interworking between the IP Multimedia Core Network (CN) Subsystem (IMS) and Circuit Switched (CS) networks + +## I.1 Overview of GTT interworking between the IMS and Circuit Switched (CS) networks + +The support of Global Text Telephony (GTT) is optional, but may be required by national regulatory requirements. If GTT is supported, the procedures described within this Annex shall be applied. + +Global Text Telephony (GTT) offers real time conversation in text, optionally combined with voice. GTT is mainly used for distant conversation with hearing or speech impaired users. + +GTT is supported in IMS via the Real-Time Text protocol over RTP, using IETF SIP/SDP for the negotiation of the text media and IETF RFC 4103 [124] RTP-text for transport, with text coded according to ITU-T Recommendation T.140 [123]. See 3GPP TS 23.226 [122] and 3GPP TS 26.114 [104]. + +In PSTN, different specified systems for text telephony exist and are used in different regions, e.g. Baudot (in US), EDT, V.21, Bell1103, Minitel and V.18. They all use different modem technologies within PCM and different character coding for the transmission of text. They are described in the annexes of ITU-T Recommendation V.18 [125]. ITU-T Recommendation V.18 [125] is an international text telephone modem standard with an automoding mechanism that enables communication with all the different kinds of PSTN text telephone systems. Any party of a GTT call may at any time initiate text or send voice. Speech and text may be used in an alternating manner during a conversation on the PSTN. It is also possible that speech is transferred in one direction and text in the opposite direction. However, speech and text can not be used in the same direction at the same time in most sub-modes of V.18. + +In the 3GPP CS radio interface, a dedicated CTM modem is used (see 3GPP TS 26.226 [126]), which is terminated within the CS domain and interworked to PTSN inband text telephony format. + +Interworking between Real-Time Text over RTP within IMS and PSTN text telephony is provided at the MGCF / IM-MGW by the MGCF triggering the insertion of an Interworking (conversion) function within the IM-MGW which then behaves in accordance with ITU-T Recommendation V.18 [125] or any of its specific sub-modes. + +The support of this Interworking function between IP-based Real-Time Text over RTP and modem based transmission of real-time text is optional both at the MGCF and IM-MGW, but can be required by national regulatory bodies. If this Interworking function is supported, the procedures described within this Annex shall be applied. + +The Interworking function in the IM-MGW shall support the detection of text modem signals on the CS side and the conversion between text/modem signals and Real-Time Text over RTP. + +The IM\_MGW shall support at least one of the sub-modes listed in ITU-T Recommendation V.18 [125] (e.g. Baudot). The support of any of the sub-modes is optional. + +The procedures to detect and convert text/modem involve expensive MGW resources. The present GTT interworking procedures intend to allow cost effective implementations by avoiding additional load or resources in MGW for calls not using text telephony (which represent most of the calls). + +It is assumed that IMS terminals supporting text media will not automatically offer text media, but that this will be instead governed by terminal configuration options and user interactions to suit the communication preferences and abilities of the user. However, an IMS terminal desiring to set up a GTT call will offer Real-Time Text media, possibly in parallel to voice media. The IMS-MGW shall then provide the conversion between Real-Time Text over RTP and text/modem signals. On the contrary, if the mobile does not request Real-Time Text support, no Interworking function is necessary. An IMS Multimedia terminal configured to use Real-Time Text Telephony but receiving an SDP offer for voice-only media will accept this offer and then send an own subsequent SDP offer adding text media. When receiving such a subsequent offer for text media, the IMS-MGW shall provide the conversion between Real-Time Text over RTP and text/modem signals at the CS interface. On the contrary, if the mobile does not offer Real-Time Text, no Interworking function is necessary. + +## 1.2 Control plane interworking + +### 1.2.1 General + +Before text conversation can begin, a call shall first be established, from PSTN to IMS or vice-versa. The ISUP or BICC signalling to/from the PSTN indicates a "speech" call, without any GTT indication. + +The IMS user may request a text connection from the beginning of a call, or add request for Real-Time Text media at a later stage in a call that was originally established with audio only. + +### 1.2.2 Functionalities required in the MGCF for GTT calls support + +In addition to the control plane interworking between SIP and ISUP or BICC (see clause 7), the MGCF shall support the negotiation of the Real-Time Text payload type (T.140 Text Conversation MIME media type as specified by IETF RFC 4103 [124]) in a distinct SDP m-line. + +### 1.2.3 IM CN subsystem originated session + +#### 1.2.3.1 Initial INVITE with an SDP offer including a text media line + +Figure I.2.3.1.1 shows an example call flow where the IMS terminal requests Real-Time Text telephony by sending an SDP offer including one audio line and one text media line within an initial INVITE message. + +![Sequence diagram showing the initial INVITE call flow between IMS and CS Network via an Interworking Node (MGCF).](ccf6853c7291703cb04568057fef5849_img.jpg) + +``` +sequenceDiagram + participant IMS + participant MGCF as Interworking Node (MGCF) + participant CS_Network as CS Network + + Note left of IMS: IMS terminal requests Real-Time Text telephony + IMS->>MGCF: 1. SIP: INVITE [SDP offer: Audio + Text] + MGCF->>CS_Network: 2. IAM (speech) + CS_Network-->>MGCF: 3. SIP: 18x or 200 OK [SDP answer: Audio + Text] + MGCF-->>IMS: + Note right of MGCF: Audio / Text + IMS-->>CS_Network: Audio / Text +``` + +The diagram illustrates the call flow for an IM CN subsystem originated session. It involves three main components: IMS, Interworking Node (MGCF), and CS Network. The sequence of messages is as follows: 1. The IMS sends a SIP INVITE message with an SDP offer containing Audio + Text to the MGCF. 2. The MGCF sends an IAM (speech) message to the CS Network. 3. The CS Network returns a SIP 18x or 200 OK message with an SDP answer containing Audio + Text to the MGCF. The MGCF then forwards this response back to the IMS. A double-headed arrow at the bottom indicates the Audio / Text media stream flowing between the IMS and the CS Network through the MGCF. + +Sequence diagram showing the initial INVITE call flow between IMS and CS Network via an Interworking Node (MGCF). + +**Figure I.2.3.1.1: IM CN subsystem originated session - Initial INVITE offering audio and text** + +Upon receipt of a SIP INVITE request offering text media (possibly combined with audio media) (signal 1 in figure I.2.3.1.1) the Interworking Node (MGCF) starts the call set-up at the CS side by sending an IAM requesting a speech with G.711 codec only or 3.1 KHz bearer (signal 2 in figure I.2.3.1.1), and completes the call setup on IMS and CS side using the procedures specified in clause 7, but returning an SDP answer including Real-Time Text media (possibly combined with audio media if audio media has been offered) (signal 3 in figure I.2.3.1.1). + +The MGCF triggers the insertion an Interworking function in the IM-MGW for the duration of the call if a Real-Time Text media stream is established. + +The MGCF reserves corresponding Real-Time Text media resources in the IM-MGW and activate the Interworking function, and if resources were available, return an SDP answer with audio and Real-Time Text. + +### 1.2.4 CS network originated session + +#### 1.2.4.1 General + +When starting the session setup signalling from a CS based network towards the IMS, the MGCF has no knowledge whether the CS side terminal supports and will accept to use text telephony. + +#### 1.2.4.2 Initial INVITE with an SDP offer including audio only + +The MGCF offers only audio media when setting up a call towards the IMS and waits for IMS terminals desiring Real-Time Text media to send a new offer adding Real-Time Text media attribute prior to inserting an Interworking function in the IM-MGW. If the MGCF receives a new offer adding Real-Time Text media and applies signalling with OoBTC on the CS CN, the MGCF shall apply appropriate OoBTC procedures to only select G.711 audio codec on the CS call leg. + +Figure I.2.4.2.1 shows an example call flow. + +![Sequence diagram showing the call flow for a CS originated session. The diagram involves three main entities: CS Network, Interworking Node (MGCF), and IMS. The sequence starts with the CS Network sending an IAM (speech) to the MGCF. The MGCF then sends a SIP INVITE with an SDP offer for Audio to the IMS. The IMS responds with a SIP 183 Session Progress with an SDP answer for Audio. The MGCF then sends a SIP PRACK to the IMS. The IMS responds with a SIP 200 OK (PRACK). The MGCF then sends a SIP UPDATE with an SDP offer for Audio + Text to the IMS. The IMS responds with a SIP 200 UPDATE with an SDP answer for Audio + Text. The MGCF then sends a SIP 180 Ringing to the IMS. The IMS responds with a SIP PRACK to the MGCF. The MGCF then sends a SIP 200 OK (PRACK) to the IMS. The IMS then sends a SIP 200 OK (INVITE) to the MGCF. The MGCF then sends an ACM to the CS Network. Finally, the MGCF sends an ANM to the CS Network. A double-headed arrow at the bottom indicates the Audio / Text media flow between the CS Network and the IMS.](b5987d63203a5fa601921039922ac520_img.jpg) + +``` + +sequenceDiagram + participant CS Network + participant MGCF as Interworking Node (MGCF) + participant IMS + + Note left of MGCF: Bearer Establishment + CS Network->>MGCF: 1. IAM (speech) + MGCF->>IMS: 2. SIP: INVITE [SDP offer: Audio] + IMS->>MGCF: 3. SIP: 183 Session Progress [SDP answer: Audio] + MGCF->>IMS: 4. SIP: PRACK + IMS->>MGCF: 5. SIP: 200 OK (PRACK) + MGCF->>IMS: 6. SIP: UPDATE [SDP offer: Audio + Text] + IMS->>MGCF: 7. SIP: 200 UPDATE [SDP answer: Audio + Text] + MGCF->>IMS: 8. SIP: 180 Ringing + IMS->>MGCF: 9. ACM + MGCF->>IMS: 10. SIP: PRACK + IMS->>MGCF: 11. SIP: 200 OK (PRACK) + IMS->>MGCF: 12. SIP: 200 OK (INVITE) + MGCF->>CS Network: 13. ANM + Note right of MGCF: Audio / Text + +``` + +Sequence diagram showing the call flow for a CS originated session. The diagram involves three main entities: CS Network, Interworking Node (MGCF), and IMS. The sequence starts with the CS Network sending an IAM (speech) to the MGCF. The MGCF then sends a SIP INVITE with an SDP offer for Audio to the IMS. The IMS responds with a SIP 183 Session Progress with an SDP answer for Audio. The MGCF then sends a SIP PRACK to the IMS. The IMS responds with a SIP 200 OK (PRACK). The MGCF then sends a SIP UPDATE with an SDP offer for Audio + Text to the IMS. The IMS responds with a SIP 200 UPDATE with an SDP answer for Audio + Text. The MGCF then sends a SIP 180 Ringing to the IMS. The IMS responds with a SIP PRACK to the MGCF. The MGCF then sends a SIP 200 OK (PRACK) to the IMS. The IMS then sends a SIP 200 OK (INVITE) to the MGCF. The MGCF then sends an ACM to the CS Network. Finally, the MGCF sends an ANM to the CS Network. A double-headed arrow at the bottom indicates the Audio / Text media flow between the CS Network and the IMS. + +Figure I.2.4.2.1: CS originated session - Initial INVITE offering audio only + +Upon receipt of an IAM request for a speech or 3.1 KHz audio call (signal 1 in figure I.2.4.2.1) the Interworking Node (MGCF) starts the call set-up at the IM CN subsystem side by sending an INVITE request (signal 2 in figure I.2.4.2.1) offering audio media applying the interworking procedures in Clause 7. + +IMS terminals supporting GTT and configured to use it will send a new SDP offer including an audio and a Real-Time Text media line within a subsequent UPDATE or re-INVITE request. + +When GTT interworking between IMS and CS networks is required, the MGCF shall reserve corresponding Real-Time Text media resources in the IM-MGW and thereby request the insertion of the Interworking function, and if resources were available, return an SDP answer with audio and Real-Time Text media attributes. + +### 1.2.5 Subsequent SDP offer/answer exchange adding text to an audio session + +If only audio media has been offered in the initial SDP offer, the IMS terminal can also request GTT support by sending a new SDP offer including audio and Real-Time Text when a SIP dialogue (early or confirmed) has already been established. + +The MGCF shall then trigger the insertion of an Interworking function in the IM-MGW following the same principles as those specified in clause 1.2.3.14. However, if OoBTC signalling is supported and a codec other than PCM (default G.711) has been selected at the CS network, then a codec modification is required to G.711. Otherwise No additional ISUP or BICC signalling towards the CS network is required. + +## --- 1.3 User plane interworking + +### 1.3.1 Functionalities required in the IM-MGW for GTT support + +An IM-MGW supporting GTT interworking between IMS and CS network shall support: + +- Real-Time Text as specified in 3GPP TS 26.114 [104] for a Multimedia Telephony Service Indicator (MTSI) compliant IM-MGW; this includes: + - requirement to support ITU-T Recommendation T.140 [123] Text Conversation MIME media type and RTP-text transport as specified by IETF RFC 4103 [124] and ITU-T Recommendation T.140 [123] Text Conversation presentation coding; + - recommended support of redundancy coding variant specified in IETF RFC 4103 [124] for error resilience; +- PSTN based text telephony using ITU-T Recommendation V.18 [4] or any of its specific sub-modes. + +NOTE: One specific text telephone protocol of the ITU-T Recommendation V.18 standard, called "*Baudot Code*" (Baudot modulation at 45.45 baud), is particularly important for support of emergency calls in US. + +### 1.3.2 Monitoring of text/modem signals on the CS side + +When the IMS session is setup with text media (possibly combined with audio media), the MGCF thereby requests the IM-MGW to monitor the CS termination for possible receipt of text telephone signals, in order to detect whether the CS user wishes to transit from voice to text during a voice call. The IM-MGW shall be provisioned with the text telephone mode(s) for which the termination should be monitored. The presence of the text media in the IMS session is an explicit indication that monitoring of text telephone signals is required. + +When monitoring for text telephony signals the IM-MGW should listen on the CS side voice line for text telephone signals, and shall not transmit modem tones from the CS side termination to IMS side termination until one of the following occurs: + +- 1) If the PSTN terminal is a carrier-based device and transmits answer tone. The IM-MGW shall then resolve the text telephone mode according to V.18 procedures and then operate in that mode; +- 2) If the PSTN terminal is a carrier-less device, the end user starts sending characters such that these may be detected by the IM-MGW. The IM-MGW shall then detect the text telephone mode and then operate in that mode. + +If the IMS terminal transmits text characters first the IM-MGW shall initiate a text connection toward the CS network and resolve the textphone type, so that communication can continue in text mode. + +See ITU-T Recommendation V.18 [125] for a detailed description of those procedures. + +### 1.3.3 Multiplexing between the CS and IMS streams + +The IM-MGW should remain in speech mode until such time that text is detected from either user. The IM-MGW shall detect modem signals on the CS termination and decide based on this detection if the media received from the CS side is interworked to the speech or the text media stream on the IMS side. In the media direction towards the CS network, the IM-MGW needs to multiplex both media streams into the PCM signal. + +The following procedures provide further information on the procedures to be followed by the IM-MGW, for normative behaviour the ITU-T Recommendation V.18 [125] shall be followed. + +- Carrier text phone: + +- After a carrier mode text connection is established, loss of carrier can be taken as the indication that the audio stream on the IMS termination shall be connected with the (PCM) interface of the line on the CS termination. +- When the text carrier reappears on the CS termination, or text is received from the text media stream on the IMS termination, the IM-MGW connects the text stream on the IMS termination with the (PCM) interface of the line on the CS termination. + +- Carrierless text phone: + +- When the V.18 modem detects text, the textphone CS termination stops feeding the audio stream of the IMS termination, and instead inserts the detected and T.140 converted characters into the text stream of the IMS termination. This mode is continued as long as characters keep coming from the PSTN textphone. When no more characters arrive, and no textphone signal is received within 1 second, the audio channel is again fed to the audio stream of the IMS termination. If new text comes from the V.18 side, the process is repeated. +- If text is received from the text stream of the IMS termination when V.18 is not actively receiving text, no media shall be applied to the IMS audio stream, and the characters are sent to the V.18 modem for transmission. When all text is transmitted and no more is received for two seconds, the audio channels are enabled again. Since the carrierless systems are one-way alternate transmission systems, transmission of characters is possible only in one direction at a time. Once started, reception is given priority. Characters received from text stream of the IMS termination while V.18 is busy receiving should be buffered (up to a reasonable limit). + +### 1.3.4 Conversion between text/modem and Real-Time Text over RTP + +The legacy PSTN textphone modes have limited character sets. For all legacy modes, the text received through the V.18 modem shall be converted if necessary in the RTP/T.140 format for the text stream on the IMS termination, according to the rules in ITU-T Recommendation. T.140 [123] and IETF RFC 4103 [124], and vice-versa. + +Redundancy may be used as specified in IETF RFC 4103 [124]. Use or not of redundancy is derived from the text media description configured on the IMS termination (RTP/RED/T.140). + +## --- 1.4 MGCF and IM-MGW interactions + +### 1.4.1 Introduction + +This clause describes requirements for extensions to the Mn interface protocol in 3GPP TS 29.332 [15] needed to support the Interworking of Real-Time Text Telephony media in IMS with text/modem calls in CS domain. + +### 1.4.2 Mn signalling interactions + +#### 1.4.2.1 Introduction + +The following clauses describe the Mn interface procedures. + +All message sequence charts in these clauses are examples. + +#### I.4.2.2 H.248 Context Model + +The H.248 context model depicted in figure I.4.2.2.1 shall be applied for interworking Real-Time Text media in IMS to text/modem in CS. + +![Diagram of the H.248 Context Model for GTT support. It shows a context labeled 'Context C1' containing two terminations: 'Termination T1' on the IMS side and 'Termination T2' on the CS network side. T1 is connected to the IMS and has two streams: 'Audio/RTP stream' and 'Real-Time Text/RTP stream'. T2 is connected to the CS network and has one stream: '(audio + V.18) stream'. A dashed double-headed arrow labeled '2-way topology' connects T1 and T2.](4cd9eeaee1deb05bf88a8abf02ff7d7f_img.jpg) + +The diagram illustrates the H.248 context model for GTT support. It features an oval labeled "Context C1". Inside this context, there are two terminations: "Termination T1" on the left and "Termination T2" on the right. Termination T1 is connected to the "IMS" and has two incoming streams: "Audio/RTP stream" and "Real-Time Text/RTP stream". Termination T2 is connected to the "CS network" and has one outgoing stream: "(audio + V.18) stream". A dashed double-headed arrow labeled "2-way topology" connects Termination T1 and Termination T2. + +Diagram of the H.248 Context Model for GTT support. It shows a context labeled 'Context C1' containing two terminations: 'Termination T1' on the IMS side and 'Termination T2' on the CS network side. T1 is connected to the IMS and has two streams: 'Audio/RTP stream' and 'Real-Time Text/RTP stream'. T2 is connected to the CS network and has one stream: '(audio + V.18) stream'. A dashed double-headed arrow labeled '2-way topology' connects T1 and T2. + +**Figure I.4.2.2.1: H.248 Context Model for GTT support** + +The H.248 context contains one IP termination (IMS side) with two streams (one stream for Real-Time Text/RTP, another stream for audio/RTP), plus a TDM, AAL2 or IP termination (CS side) with one single stream carrying both voice via PCM and V.18 text telephony. + +#### I.4.2.3 Specific Mn signalling for GTT + +The following information shall be provided from the MGCF towards the IM-MGW: + +- SDP with audio and Real-Time Text m-lines for the IMS termination; +- PCM (G.711) codec for the CS side termination. + +This shall trigger the IM-MGW to insert an IWF to support RTT to PSTN text telephony conversion. If the topology is incoming (or bothway) from the CS network the IM-MGW shall monitor for text telephony and convert to RTT towards the IMS network. If the topology is outgoing (or bothway) to the CS network the IM-MGW shall multiplex RTT payload into the PCM stream. + +#### I.4.2.4 IM CN subsystem originated session between the MGCF and IM-MGW + +##### I.4.2.4.1 Initial INVITE with an SDP offer including Real-Time Text + +![Sequence diagram showing Mn signalling interactions for IMS originated session with audio and text. The diagram involves four main entities: IMS, MGCF, IM-MGW, and CS Network. The sequence starts with an INVITE from IMS to MGCF, followed by a 100 Trying response. The MGCF then sends H.248 ADD.req messages to the IM-MGW to reserve resources and configure connections. The IM-MGW responds with H.248 ADD.resp messages. The MGCF then sends an ISUP IAM message to the CS Network. A box indicates the next steps of basic call establishment. The MGCF then sends an ISUP ANM message to the CS Network. The MGCF sends H.248 MOD.req messages to the IM-MGW to change connections and activate processing functions. The IM-MGW responds with H.248 MOD.resp messages. The MGCF then sends a 200 OK (INVITE) response to the IMS, which is followed by an ACK. A 'CALL IN ACTIVE STATE' bar indicates the start of the active call. Finally, Text/modem and Text/RTP messages are shown being exchanged between the IM-MGW and the IMS.](977811d1c73b74f801be9f4c376694ca_img.jpg) + +``` + +sequenceDiagram + participant IMS + participant MGCF + participant IM-MGW + participant CS_Network as CS Network + + Note left of IMS: INVITE [SDP offer: audio + Real-Time Text] + IMS->>MGCF: 1. INVITE [SDP offer: audio + Real-Time Text] + MGCF-->>IMS: 2. SIP: 100 Trying + MGCF->>IM-MGW: 3. H.248: ADD.req [Context ID = ?, Termination ID=?, stream=1{audio media}, stream=2{Real-Time Text media,}] + Note right of IM-MGW: Reserve IMS Connection Point, and Configure Remote Resources +Change IMSThrough-Connection = backward + IM-MGW-->>MGCF: 4. H.248: ADD.resp [Context ID = C1, Termination ID = T1] + MGCF->>IM-MGW: 5. H.248: ADD.req [Context ID = C1, Termination ID = T2] + Note right of IM-MGW: Reserve TDM Circuit, Change TDM Through-Connection= both, Monitor Text Call + IM-MGW-->>MGCF: 6. H.248: ADD.resp [Context ID = C1, Termination ID = T2] + MGCF->>CS_Network: 7. ISUP: IAM + Note over MGCF, IM-MGW: Next steps of basic call establishment (as specified in subclause 9.2.2.3), returning an SDP Answer with audio + text + MGCF->>CS_Network: 8. ISUP: ANM + MGCF->>IM-MGW: 9. H.248: MOD.req [Context ID=C1, Termination ID = T1] + Note right of IM-MGW: Change IMS Through-Connection = both + IM-MGW-->>MGCF: 10. H.248: MOD.resp [Context ID = C1, Termination ID = T1] + MGCF->>IM-MGW: 11. H.248: MOD.req [Context ID=C1, Termination ID = T2] + Note right of IM-MGW: Activate TDM Voice Processing Function + IM-MGW-->>MGCF: 12. H.248: MOD.resp [Context ID = C1, Termination ID = T2] + MGCF-->>IMS: 13. SIP: 200 OK (INVITE) + IMS->>MGCF: 14. SIP: ACK + Note over MGCF, IM-MGW: CALL IN ACTIVE STATE + Note right of IM-MGW: 15. Text/modem + Note left of MGCF: 16. Text/RTP + +``` + +Sequence diagram showing Mn signalling interactions for IMS originated session with audio and text. The diagram involves four main entities: IMS, MGCF, IM-MGW, and CS Network. The sequence starts with an INVITE from IMS to MGCF, followed by a 100 Trying response. The MGCF then sends H.248 ADD.req messages to the IM-MGW to reserve resources and configure connections. The IM-MGW responds with H.248 ADD.resp messages. The MGCF then sends an ISUP IAM message to the CS Network. A box indicates the next steps of basic call establishment. The MGCF then sends an ISUP ANM message to the CS Network. The MGCF sends H.248 MOD.req messages to the IM-MGW to change connections and activate processing functions. The IM-MGW responds with H.248 MOD.resp messages. The MGCF then sends a 200 OK (INVITE) response to the IMS, which is followed by an ACK. A 'CALL IN ACTIVE STATE' bar indicates the start of the active call. Finally, Text/modem and Text/RTP messages are shown being exchanged between the IM-MGW and the IMS. + +Figure I.4.2.4.1.1: Example Mn signalling interactions for IMS originated session with audio and text + +The Mn signalling interactions specified in clause 9.2.2.3 shall apply, with the following differences. + +When reserving the IMS termination, the MGCF shall configure two streams; one for the audio and one for the Real-Time Text media line, with their respective media description (signal 3 in figure I.4.2.4.1.1). Monitoring of text + +telephony at the CS side termination is indicated by the inclusion of Real-Time Text media at the IMS side termination and by the topology being bothway or incoming from the CS side. + +The text telephone mode(s) for which the CS side termination is monitored shall be provisioned in the IM-MGW. + +#### I.4.2.5 CS network originated session + +##### I.4.2.5.1 Initial INVITE with an SDP offer only including audio + +![Sequence diagram showing Mn signalling interactions for CS originated session between CS Network, IM-MGW, MGCF, and IMS.](74d23510f27b21403a7be84820821863_img.jpg) + +``` + +sequenceDiagram + participant CS as CS Network + participant MGW as IM-MGW + participant MGCF as MGCF + participant IMS as IMS + + CS->>MGCF: 1. ISUP: IAM + MGCF->>MGW: 2. H.248: ADD.req [Context ID = ?, Termination ID = ?] + MGW-->>MGCF: 3. H.248: ADD.resp [Context ID = C1, Termination ID = T2] + Note right of MGCF: Reserve TDM Circuit, +Change TDM Through- +Connection= both + MGCF->>MGW: 4. H.248: ADD.req [Context ID = C1, Termination ID=?, +stream=1{audio media}] + MGW-->>MGCF: 5. H.248: ADD.resp [Context ID = C1, Termination ID = T1] + Note right of MGCF: Reserve IMS Connection Point, +Change IMS Through- +Connection = backward + MGCF->>IMS: 6. SIP: INVITE [SDP offer: Audio] + IMS-->>MGCF: 7. SIP: 183 Session Progress [SDP answer: Audio] + MGCF->>MGW: 8. H.248: MOD.req [Context ID = C1, Termination ID = T1] + MGW-->>MGCF: 9. H.248: MOD.resp [Context ID = C1, Termination ID = T1] + IMS->>MGCF: 10. SIP: PRACK + MGCF->>IMS: 11. SIP: 200 OK (PRACK) + IMS->>MGCF: 12. SIP: UPDATE [SDP offer: Audio + Real-Time Text] + MGCF->>MGW: 13. H.248: MOD.req [Context ID = C1, Termination ID = T1, +stream=1{audio media}, stream=2{Real-Time Text media}] + MGW-->>MGCF: 14. H.248: MOD.resp [Context ID = C1, Termination ID = T1] + MGCF->>IMS: 15. SIP: 200 UPDATE [SDP answer: Audio + Real-Time Text] + + Note over CS, IMS: Next steps of basic call establishment (as specified in subclause 9.2.3.3) + Note over CS, IMS: CALL IN ACTIVE STATE + + CS-->>MGW: 16. Text/modem + MGW-->>IMS: 17. Real-Time Text/RTP + +``` + +The diagram illustrates the signaling sequence for a CS originated session. It begins with an **ISUP: IAM** message from the CS Network to the MGCF. The MGCF then sends a series of **H.248** messages to the IM-MGW: **ADD.req** (Context ID = ?, Termination ID = ?), **ADD.resp** (Context ID = C1, Termination ID = T2), **ADD.req** (Context ID = C1, Termination ID = ?, stream=1{audio media}), and **ADD.resp** (Context ID = C1, Termination ID = T1). The MGCF also performs internal actions: **Reserve TDM Circuit, Change TDM Through-Connection= both** and **Reserve IMS Connection Point, Change IMS Through-Connection = backward**. The MGCF sends a **SIP: INVITE** [SDP offer: Audio] to the IMS, which responds with **SIP: 183 Session Progress** [SDP answer: Audio]. The MGCF then sends **MOD.req** (Context ID = C1, Termination ID = T1) and **MOD.resp** (Context ID = C1, Termination ID = T1) to the IM-MGW. The IMS sends **SIP: PRACK**, **SIP: 200 OK (PRACK)**, **SIP: UPDATE** [SDP offer: Audio + Real-Time Text], and **SIP: 200 UPDATE** [SDP answer: Audio + Real-Time Text]. The IM-MGW sends **MOD.req** (Context ID = C1, Termination ID = T1, stream=1{audio media}, stream=2{Real-Time Text media}) and **MOD.resp** (Context ID = C1, Termination ID = T1) to the MGCF. Annotations on the left indicate **Configure IMS Resources** (steps 8-9) and **Configure IMS Resources Monitor Text Call** (steps 13-14). A box indicates **Next steps of basic call establishment (as specified in subclause 9.2.3.3)**. A double-headed arrow labeled **CALL IN ACTIVE STATE** spans from step 15 to the end. Final media flows are **16. Text/modem** (dashed line) and **17. Real-Time Text/RTP** (dashed line). + +Sequence diagram showing Mn signalling interactions for CS originated session between CS Network, IM-MGW, MGCF, and IMS. + +**Figure I.4.2.5.1.1: Mn signalling interactions for CS originated session - Initial INVITE with audio only** + +The Mn signalling interactions specified in clause 9.2.3.3 shall apply, with the following differences. + +Upon receipt of a subsequent SDP offer from the IMS terminal including the audio and Real-Time Text media lines, the MGCF shall add an additional text stream to the IMS termination and configure it with the remote media description (signal 13 in figure I.4.2.5.1.1). + +### I.4.3 Mn Signalling procedures + +#### I.4.3.1 Overview + +This clause describes the logical signalling procedures (i.e. message identifiers are not part of the protocol) between the MGCF and IM-MGW. The procedures within this clause are intended to be implemented using the standard H.248 procedure as defined in ITU recommendation H.248.1 [2] with appropriate parameter combinations. + +The procedures "Reserve IMS connection point" and "Configure IMS resources" and "Reserve IMS Connection point and configure remote resources" shall allow the configuration of two media streams; one for audio and one for Real-Time Text on the IMS termination. See clause 9.3.1. + +# --- Annex J (informative): Call Flow for Customized Alerting Tone (CAT) interworking between CS network and IMS + +## J.1 Introduction + +This annex describes procedures for interworking Customized Alerting Tone (CAT) between the IMS and CS Networks. + +## --- J.2 IMS CAT provided by the terminating IMS user using gateway model towards user served in CS networks + +Callflows for providing IMS CAT provided by the terminating IMS user towards user served in CS networks are based on procedures specified in 3GPP TS 24.182 [132], with procedures for MGCF as shown in the following clauses. + +### J.2.1 Callflow without using precondition mechanism + +The following callflow shows the case when precondition mechanism is not used, and 100rel extension is used. + +![Sequence diagram showing the callflow for CAT gateway model without using precondition mechanism. The diagram involves an MGCF and a remote party. The sequence of messages is: 1. IAM from the left to MGCF; 2. INVITE (SDP_O) from MGCF to the right; 3. 183 (Session Progress) (SDP_A_cat) from the right to MGCF; 4. ACM from MGCF to the left; 5. PRACK from MGCF to the right; 6. 200 (OK) (PRACK) from the right to MGCF; 7. UPDATE (SDP_O_Regular) from the right to MGCF; 8. 200 (OK) (UPDATE) (SDP_A) from MGCF to the right; 9. 200 (OK) (INVITE) from the right to MGCF; 10. ANM from MGCF to the left; 11. ACK from MGCF to the right.](01465752f3ac36c403672804f406a676_img.jpg) + +``` +sequenceDiagram + participant Left + participant MGCF + participant Right + Note over MGCF: MGCF + Left->>MGCF: 1. IAM + MGCF->>Right: 2. INVITE (SDP_O) + Right-->>MGCF: 3. 183 (Session Progress) (SDP_A_cat) + MGCF->>Left: 4. ACM + MGCF->>Right: 5. PRACK + Right-->>MGCF: 6. 200 (OK) (PRACK) + Right-->>MGCF: 7. UPDATE (SDP_O_Regular) + MGCF->>Right: 8. 200 (OK) (UPDATE) (SDP_A) + Right-->>MGCF: 9. 200 (OK) (INVITE) + MGCF->>Left: 10. ANM + MGCF->>Right: 11. ACK +``` + +Sequence diagram showing the callflow for CAT gateway model without using precondition mechanism. The diagram involves an MGCF and a remote party. The sequence of messages is: 1. IAM from the left to MGCF; 2. INVITE (SDP\_O) from MGCF to the right; 3. 183 (Session Progress) (SDP\_A\_cat) from the right to MGCF; 4. ACM from MGCF to the left; 5. PRACK from MGCF to the right; 6. 200 (OK) (PRACK) from the right to MGCF; 7. UPDATE (SDP\_O\_Regular) from the right to MGCF; 8. 200 (OK) (UPDATE) (SDP\_A) from MGCF to the right; 9. 200 (OK) (INVITE) from the right to MGCF; 10. ANM from MGCF to the left; 11. ACK from MGCF to the right. + +**Figure J.2.1: CAT gateway model callflow without using precondition mechanism** + +The content of the SDP message body described in figure J.2.1 is meant to be as follows: + +- SDP\_O in step 2 indicates the SDP offer inserted by the MGCF; +- SDP\_A\_cat in step 3 indicates the SDP answer received by the MGCF, which in general is the SDP answer generated by the CAT AS based on the content for CAT media; +- SDP\_O\_Regular in step 7 indicates the SDP offer received by the MGCF, which in general is the SDP offer sent by the CAT AS based on the SDP answer received by the terminating UE; and +- SDP\_A in step 8 indicates the SDP answer generated by the MGCF. + +Upon receiving IAM (see figure J.2.1 step 1), MGCF sends SIP INVITE request containing the SDP offer to terminating IMS (see figure J.2.1 step 2). + +Upon receiving 183 (Session Progress) response to the SIP INVITE request containing SDP answer (see figure J.2.1 step 3), MGCF sends ACM to the originating CS network (see figure J.2.1 step 4). Also, MGCF sends a PRACK request towards terminating IMS (see figure J.2.1 step 5). A 200 (OK) response will be received later as a result of the PRACK request (see figure J.2.1 step 6). + +Upon receiving SIP UPDATE request from terminating IMS with a SDP offer (see figure J.2.1 step 7), MGCF sends a 200 (OK) response to the terminating IMS with an SDP answer (see figure J.2.1 step 8). + +Upon receiving 200 (OK) response to the INVITE request sent in figure J.2.1 step 2 (see figure J.2.1 step 9), MGCF sends an ANM to the originating CS network (see figure J.2.1 step 10). + +# Annex K (normative): + +## T.38 interworking between the IP Multimedia Core Network (CN) Subsystem (IMS) and Circuit Switched (CS) networks + +## K.1 General + +This annex provides optional interworking procedures to support facsimile transported according to ITU-T Recommendation T.38 [72] transported according to IETF RFC 3362 [73] in the "UDPTL" transport format. Related Mn Signalling Procedures are also described. + +To enhance interoperability, recommendations for an MGCF T.38 configuration are also provided. + +NOTE: Alternatively, facsimile can also be transported as inband voice band data over IP. + +## K.2 Recommend T.38 configuration + +UDPTL is recommended as T.38 transport. + +NOTE: MTSI client use UDPTL as transport (see 3GPP TS 24.173 [88]). + +Table X.2.1 lists values for the T.38 SDP attributes that are recommended to be supported. + +**Table K.2.1: Recommended configuration for T.38 SDP attribute values** + +| | | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------| +| T38FaxVersion | Version 2 or higher. (NOTE 1) | +| T38MaxBitRate | 14 400 | +| T38FaxFillBitRemoval | FALSE | +| T38FaxTranscodingMMR | FALSE | +| T38FaxTranscodingJBIG | FALSE | +| T38FaxRateManagement | 'transferredTCF' | +| T38FaxMaxBuffer | 1800 | +| T38FaxMaxDatagram | At least 150 | +| T38FaxMaxIFP | 40 (NOTE 2) | +| T38FaxUdpEC | 't38UDPRedundancy' | +| T38FaxUdpECDepth | Minred: 1; Maxred: 2 (NOTE 2) | +| T38FaxUdpFECMaxSpan | 3 (NOTE 2) | +| T38ModemType | 't38G3FaxOnly' (NOTE 2) | +| NOTE 1: Version 0 is the default value that applies if the T38FaxVersion SDP attribute is not signalled. No SDP attributes are defined in this T.38 version 0. With version 4, default values for the SDP attributes apply if the attributes are omitted. | | +| NOTE 2: Only applicable for T.38 version 4. | | + +## K.3 Handling T.38 SDP attributes at the I-MGCF + +Table K.3.1: Action at I-MGCF depending on SDP T.38 attribute values in SDP offer + +| | Handling of received SDP offer | Value provided in sent SDP answer | +|------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| T38FaxVersion | Accept any value. Provide to the IM-MGW the received value or the maximum supported value at the IM-MGW (whatever is lower). | If I-MGCF supports received version, reply with that version. Otherwise reply with highest supported version. Provide value sent in the answer also to the IM-MGW. | +| T38MaxBitRate | Accept any value in the offer. Provide to the IM-MGW the received value or the maximum supported value at the IM-MGW (whatever is lower). | Supply value according to IM-MGW capabilities in the answer. | +| T38FaxFillBitRemoval | Accept offer with or without this attribute. | Do not include parameter in the answer. (NOTE 2). | +| T38FaxTranscodingMMR | Accept offer with or without this attribute. | Do not include parameter in the answer. (NOTE 2) | +| T38FaxTranscodingJBIG | Accept offer with or without this attribute. | Do not include parameter in the answer. (NOTE 2) | +| T38FaxRateManagement | Only accept calls with "transferredTCF" in the offer for T38FaxVersion 2 or higher. Otherwise reject offer (NOTE 3). | Supply "transferredTCF" value in the answer | +| T38FaxMaxBuffer | Accept any value in the offer. Provide to the IM-MGW the received value or the maximum supported value at the IM-MGW (whatever is lower). | Supply value according to IM-MGW capabilities in the answer. | +| T38FaxMaxDatagram | Accept any value in the offer. Provide to the IM-MGW the received value or the maximum supported value at the IM-MGW (whatever is lower). | Supply value according to IM-MGW capabilities in the answer. | +| T38FaxMaxIFP | Accept any value in the offer. If T.38 version 4 is supported by the MGW, provide to the IM-MGW the received value or the maximum supported value at the IM-MGW (whatever is lower). | If T.38 version 4 is indicated in the answer, supply value according to IM-MGW capabilities in the answer. Otherwise omit the SDP attribute from the answer. | +| T38FaxUdpEC | Accept value in the offer according to IM-MGW capabilities and provide it to the IM-MGW. Otherwise reject offer (NOTE 3). | Supply value according to IM-MGW capabilities in the answer. | +| T38FaxUdpECDepth | Accept any value in the offer. If T.38 version 4 is supported by the IM-MGW, provide to the IM-MGW the received value. | If T.38 version 4 is indicated in the answer, supply value according to IM-MGW capabilities in the answer. Otherwise omit the SDP attribute. | +| T38FaxUdpFECMaxSpan | Accept any value in the offer. If T.38 version 4 is supported by the IM-MGW, provide to the IM-MGW the received value. | If T.38 version 4 is indicated in the answer, supply value according to IM-MGW capabilities in the answer. Otherwise omit the SDP attribute. | +| T38ModemType | Accept any value in the offer. If T.38 version 4 is supported by the IM-MGW, provide to the IM-MGW the received value. | Do not include parameter in the answer. (NOTE 2) | +| T38VendorInfo | Accept any value in the offer. | Do not include parameter in the answer. | + +NOTE 1: With Version 4, default values for the SDP attributes apply if the attributes are omitted. +NOTE 2: In the Mn H.248 profile the IM-MGW does not modify the T.30 bit stream encapsulated within T.38 when passing it to or from the CS network. +NOTE 3: If other offered media lines are acceptable, set port in media line to zero. Otherwise reject offer in INVITE request by sending the SIP status code 488 "Not Acceptable Here". +NOTE 4: "Any value" means any valid value that conforms to ITU-T Recommendation T.38 [72]. + +## K.4 Handling T.38 SDP attributes at the O-MGCF + +Table K.4.1: T.38 SDP attributes values supplied by the O-MGCF and actions at O-MGCF depending on SDP attribute values in SDP answer + +| | Value provided in sent SDP offer | Handling of received SDP answer | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| +| T38FaxVersion | Supply highest version supported at MGCF and IM-MGW, maximum 3 (NOTE 1). | Accept any value. Provide to the IM-MGW the received value or the maximum supported value at the IM-MGW (whatever is lower). | +| T38MaxBitRate | Supply value according to IM-MGW capabilities. | Accept any value and provide it to the IM-MGW. | +| T38FaxFillBitRemoval | Do not include parameter (NOTE 2). | Accept offer with value "FALSE" or parameter omitted. (NOTE 3) | +| T38FaxTranscodingMMR | Do not include parameter (NOTE 2). | Accept offer with value "FALSE" or parameter omitted. (NOTE 3) | +| T38FaxTranscodingJBIG | Do not include parameter (NOTE 2). | Accept offer with value "FALSE" or parameter omitted. (NOTE 3) | +| T38FaxRateManagement | Supply "transferredTCF" value. | Only accept calls with "transferredTCF" in the answer for T38FaxVersion 2 or higher. (NOTE 3) | +| T38FaxMaxBuffer | Supply value according to IM-MGW capabilities. | Accept any value and provide it to the IM-MGW. | +| T38FaxMaxDatagram | Supply value according to IM-MGW capabilities | Accept any value and provide it to the IM-MGW. | +| T38FaxMaxIFP | If T.38 version 4 is indicated in the offer, supply value according to IM-MGW capabilities. Otherwise omit the parameter. | Accept any value. If T.38 version 4 is supported by the IM-MGW, provide it to the IM-MGW. | +| T38FaxUdpEC | Supply value according to IM-MGW capabilities. | Accept value according to MGW capabilities and provide it to the IM-MGW. (NOTE 3) | +| T38FaxUdpECDepth | If T.38 version 4 is indicated in the offer, supply value according to IM-MGW capabilities. Otherwise omit the parameter. | Accept any value. If T.38 version 4 is supported by the IM-MGW, provide it to the IM-MGW. | +| T38FaxUdpFECMaxSpan | If T.38 version 4 is indicated in the offer, supply value according to IM-MGW capabilities. Otherwise omit the parameter. | Accept any value. If T.38 version 4 is supported by the IM-MGW, provide it to the IM-MGW. | +| T38ModemType | Do not include parameter (NOTE 2). | Accept any value. If T.38 version 4 is supported by the IM-MGW, provide it to the IM-MGW. | +| T38VendorInfo | Do not include parameter. | Accept any value. | +| NOTE 1: With Version 4, default values for the SDP attributes apply if the attributes are omitted. | | | +| NOTE 2: In the Mn H.248 profile the IM-MGW does not modify the T.30 bit stream encapsulated within T.38 when passing it to or from the CS network. | | | +| NOTE 3: Due to SDP offer-answer procedures for this attribute, an unacceptable value in the SDP answer is due to a protocol error. The error handling at the O-MGCF is left unspecified. | | | +| NOTE 4: "Any value" means any valid value that conforms to ITU-T Recommendation T.38 [72]. | | | + +## K.5 Applicable T.38 SDP attributes at the Mn Interface + +This clause lists T.38 related SDP attributes that can be signalled towards the IM-MGW as part of the codec information within the "Local IMS Resources" and "Remote IMS Resources" parameters within the "Reserve IMS + +connection point", "Configure IMS resources" and "Reserve IMS Connection point and configure remote resources" procedures described in clause 9. + +**Table K.5.1: Applicable T.38 SDP attributes at the Mn Interface** + +| Attribute | Remarks | +|----------------------------|-------------------------------------------------------------------------------------------------------------------| +| T38FaxVersion | T.38 SDP attributes shall only be provisioned for Version 2 or higher. Version 0 applies if attribute is omitted. | +| T38MaxBitRate | | +| T38FaxMaxBuffer | | +| T38FaxMaxDatagram | | +| T38FaxMaxIFP | Only if T.38 version 4 is supported by the IM-MGW | +| T38FaxUdpEC | | +| T38FaxUdpECDepth | Only if T.38 version 4 is supported by the IM-MGW | +| T38FaxUdpFECMaxSpan | Only if T.38 version 4 is supported by the IM-MGW | +| T38ModemType | Only if T.38 version 4 is supported by the IM-MGW | + +# Annex L (normative): Interworking of called IN number and original called IN number parameters + +## L.0 General + +The called IN number and original called IN number are optional parameters defined in ITU-T Recommendation Q.763 [4]. + +The SIP History-Info header field (including the mp-param parameter) is defined in IETF RFC 7044 [91], the cause-param URI parameter is defined in IETF RFC 4458 [113] and the cause-param value "380" is defined in IETF RFC 8119 [148]. + +## L.1 Interworking SIP to ISUP + +The I-MGCF may perform the following procedure based on the operator policy, if the called IN number and original called IN number parameters are supported in the CS network. + +When receiving the History-Info header field in the incoming initial INVITE request, the I-MGCF may include a called IN number and an original called IN number parameters in the outgoing IAM as shown in table L.1.1 and table L.1.2. + +**Table L.1.1: Mapping of History-Info header field to called IN number** + +| Source SIP header field and component | Source Component value | called IN number | Derived value of parameter field | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------|-----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | Numbering plan indicator | "ISDN (Telephony) numbering plan (Recommendation E.164)" | +| hi-targeted-to-uri of the hi-entry with a hi-index that matches the last hi-entry with cause-param URI parameter with the value "380" defined in IETF RFC 8119 [148] and a mp-param header field parameter (NOTE 3); the global number portion of the hi-targeted-to-uri is assumed to be in form "+" CC + NDC + SN (NOTE 1). | CC | Nature of address indicator | If CC is equal to the country code of the country where I-MGCF is located AND the next ISUP node is located in the same country, then set to "national (significant) number" else set to "international number". | +| | CC, NDC, SN | Address signals | If NOA is "national (significant) number" then set to NDC + SN.
If NOA is "international number" then set to CC + NDC + SN. | +| Privacy header field, or Privacy header field escaped in the hi-entry above identified. (NOTE 2). | "history" or "session" or "header" | APRI | "presentation restricted" | +| | Privacy header field absent or "none" | | "presentation allowed" | + +NOTE 1: If the hi-targeted-to-uri is a SIP URI and does not contain "user=phone", then mapping to called IN number is impossible; therefore, there is no need to generate called IN number. + +NOTE 2: It is possible that an entry of the History-Info header field itself is marked as restricted or the whole History-Info header field. + +NOTE 3: The hi-target-param parameter set to "mp" as defined in IETF RFC 7044 [91] indicates that the target of the Request-URI was changed and shall appear in this hi-targeted-to-uri. Due to backward compatibility rules the hi-target-param may not appear in each concerned hi-entry; so that the identification of the hi-entry shall rely on the cause-param value. + +**Table L.1.2: Mapping of History-Info header field to original called IN number** + +| Source SIP header field and component | Source Component value | original called IN number | Derived value of parameter field | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------|-----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | Numbering plan indicator | "ISDN (Telephony) numbering plan (Recommendation E.164)" | +| hi-targeted-to-uri of the hi-entry with a hi-index that matches the first hi-entry with a cause-param URI parameter with the value "380" defined in IETF RFC 8119 [148] and a mp-param header field parameter (NOTE 4); the global number portion of the hi-targeted-to-uri is assumed to be in form "+" CC + NDC + SN (NOTE 2). | CC | Nature of address indicator | If CC is equal to the country code of the country where I-MGCF is located AND the next ISUP node is located in the same country, then set to "national (significant) number" else set to "international number" | +| | CC, NDC, SN | Address signals | If NOA is "national (significant) number" then set to NDC + SN.
If NOA is "international number" then set to CC + NDC + SN | +| Privacy header field, or Privacy header field escaped in the hi-entry above identified (NOTE 3). | "history" or "session" or "header" | APRI | "presentation restricted" | +| | Privacy header field absent or "none" | | "presentation allowed" | +| NOTE 1: The original called IN number is generated only when there are more than two hi-entries having a cause URI parameter set to the value defined in IETF RFC 8119 [148]. | | | | +| NOTE 2: If the hi-targeted-to-uri is a SIP URI and does not contain "user=phone", then mapping to original called IN number is impossible; therefore, there is no need to generate original called IN number. | | | | +| NOTE 3: It is possible that an entry of the History-Info header field itself is marked as restricted or the whole History-Info header field. | | | | +| NOTE 4: The hi-target-param parameter set to "mp" as defined in IETF RFC 7044 [91] indicates that the target of the Request-URI was changed and shall appear in this hi-targeted-to-uri. Due to backward compatibility rules the hi-target-param may not appear in each concerned hi-entry; so that the identification of the hi-entry shall rely on the cause-param value. | | | | + +## L.2 Interworking ISUP to SIP + +The O-MGCF may perform the following procedure based on the operator policy, if the History-Info header field is supported in the IMS network. + +When receiving the called IN number parameter (and the original called IN number parameter) in the incoming IAM, the O-MGCF may include the History-Info header field in the outgoing initial INVITE request as shown in table L.2.1, table L.2.2 and table L.2.3. + +The O-MGCF should first create hi-entries for the original called IN number and the called IN number and then those for the original called number and the redirecting number. + +NOTE: It is operator specific.if an IN number is used as a first dialled number and call diversions are at the later position (it is often forbidden to have a call diversion towards an IN service number) or the contrary. + +Table L.2.1: Mapping of original called IN number to History-Info header field + +| ISUP Parameter | Derived value of parameter field | SIP component | Value | +|-----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| IAM | | Initial INVITE request | | +| Original called IN number | | History-Info header field | hi-targeted-to-uri of the first created hi-entry. | +| Nature of address indicator | "national (significant) number" | hi-targeted-to-uri | Add CC (of the country where the O-MGCF is located) to address signals of original called IN number, then map to user portion of URI scheme used.
Addr-spec
"+" CC NDC SN mapped to user portion of URI scheme used. | +| | "international number" | | Map complete address signals of original called IN number to user portion of URI scheme used. | +| Address signals | If NOA is "national (significant) number" then the format of the address signals is NDC + SN.
If NOA is "international number" then the format of the address signals is CC + NDC + SN. | hi-targeted-to-uri | "+" CC NDC SN mapped to user portion of URI scheme used. | +| APRI | "presentation restricted" | Privacy header field escaped in hi-targeted-to-uri corresponding to original called IN number | "history" | +| | "presentation allowed" | | Privacy header field absent or "none" | +| | | hi-index | "index=1" | + +Table L.2.2: Mapping of called IN number to History-Info header field + +| ISUP Parameter | Derived value of parameter field | SIP component | Value | +|-----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| IAM | | Initial INVITE request | | +| Called IN number | | History-Info header field | If mapping of original called IN number is performed, then hi-targeted-to-uri of the second created hi-entry.
Otherwise, hi-targeted-to-uri of the first created hi-entry. | +| Nature of address indicator | "national (significant) number" | hi-targeted-to-uri | Add CC (of the country where the O-MGCF is located) to address signals of called IN number, then map to user portion of URI scheme used.
Addr-spec
"+" CC NDC SN mapped to user portion of URI scheme used. | +| | "international number" | | Map complete address signals of called IN number to user portion of URI scheme used. | +| Address signals | If NOA is "national (significant) number" then the format of the address signals is NDC + SN.
If NOA is "international number" then the format of the address signals is CC + NDC + SN. | hi-targeted-to-uri | "+" CC NDC SN mapped to user portion of URI scheme used. | +| APRI | "presentation restricted" | Privacy header field escaped in hi-targeted-to-uri corresponding to called IN number | "history" | +| | "presentation allowed" | | Privacy header field absent or "none" | +| | | hi-targeted-to-uri; cause-param URI parameter, as defined in IETF RFC 8119 [148]. | If mapping of original called IN number is performed, then set to "380".
Otherwise, no mapping is performed. | +| | | hi-index and hi-target-param | If mapping of original called IN number is performed, then set to "index=1.1" and "mp=1".
Otherwise, set to "index=1" and no mp-param is created. | + +Table L.2.3: Mapping of called party number to History-Info header field + +| ISUP Parameter | Derived value of parameter field | SIP component | Value | +|-----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| IAM | | Initial INVITE request | | +| Called party number | | History-Info header field | If mapping of original called IN number is performed, then hi-targeted-to-uri of the third created hi-entry.
Otherwise, hi-targeted-to-uri of the second created hi-entry. | +| Nature of address indicator | "national (significant) number" | hi-targeted-to-uri | Add CC (of the country where the MGCF is located) to address signals of called party number, then map to user portion of URI scheme used.
Addr-spec
"+" CC NDC SN mapped to user portion of URI scheme used. | +| | "international number" | | Map complete address signals of called party number to user portion of URI scheme used. | +| Address signals | If NOA is "national (significant) number" then the format of the address signals is NDC + SN.
If NOA is "international number" then the format of the address signals is CC + NDC + SN. | hi-targeted-to-uri | "+" CC NDC SN mapped to user portion of URI scheme used. | +| | | hi-targeted-to-uri; cause-param URI parameter, as defined in IETF RFC 8119 [148]. | "380" | +| | | hi-index and hi-target-param | If both original called IN number and called IN number are mapped to hi-entries, then set to "index=1.1.1" and "mp=1.1".
If original called IN number is not mapped, but called IN number is mapped to hi-entry, then set to "index=1.1" and "mp=1". | + +# --- Annex M (informative): Change history + +| Change history | | | | | | | | +|-----------------------|--------------|-----------------|-----------|------------|--------------------------------------------------------------------------|------------------------|------------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 2014-12 | CT-66 | CP-140923 | 0830 | 2 | Interworking of Called IN number and original Called IN number | 12.5.0 | 13.0.0 | +| 2015-03 | CT-67 | CP-150130 | 0842 | | ICS call: reference correction | 13.0.0 | 13.1.0 | +| 2015-03 | CT-67 | CP-150130 | 0843 | | Announcement suppression for IMS hold request | 13.0.0 | 13.1.0 | +| 2015-03 | CT-67 | CP-150130 | 0845 | | Note 4 in Table 3 for mapping to CLI parameter | 13.0.0 | 13.1.0 | +| 2015-03 | CT-67 | CP-150130 | 0846 | | Appearance of Redirection Number Restriction parameter | 13.0.0 | 13.1.0 | +| 2015-03 | CT-67 | CP-150130 | 0861 | 1 | Reference update for UUSIW | 13.0.0 | 13.1.0 | +| 2015-03 | CT-67 | CP-150097 | 0855 | 2 | Correction of APRI Mapping for Generic Number | 13.0.0 | 13.1.0 | +| 2015-03 | CT-67 | CP-150097 | 0849 | 1 | Correction to attribute "a=inactive" in initial INVITE | 13.0.0 | 13.1.0 | +| 2015-03 | CT-67 | CP-150130 | 0847 | | Inclusion of RFC7044 | 13.0.0 | 13.1.0 | +| 2015-03 | CT-67 | CP-150129 | 0850 | 2 | Reference update: draft-mohali-dispatch-cause-for-service-number | 13.0.0 | 13.1.0 | +| 2015-03 | CT-67 | CP-150121 | 0864 | 2 | Adding support for EVS codec | 13.0.0 | 13.1.0 | +| 2015-06 | CT-68 | CP-150336 | 0873 | - | Reference Update: RFC7462 (alert-info urns) | 13.1.0 | 13.2.0 | +| 2015-06 | CT-68 | CP-150334 | 0879 | 4 | Handling of 415 response for multipart MIME | 13.1.0 | 13.2.0 | +| 2015-06 | CT-68 | CP-150358 | 0880 | 1 | Reference update: draft-mohali-dispatch-cause-for-service-number | 13.1.0 | 13.2.0 | +| 2015-06 | CT-68 | CP-150335 | 0886 | 2 | User-to-user information interworking | 13.1.0 | 13.2.0 | +| 2015-06 | CT-68 | CP-150364 | 0887 | 1 | Hold/Resume request indication | 13.1.0 | 13.2.0 | +| 2015-06 | CT-68 | CP-150359 | 0888 | 1 | Adding support for the EVS codec over UMTS CS | 13.1.0 | 13.2.0 | +| 2015-06 | CT-68 | CP-150338 | 0893 | 1 | APRI Mapping for multiple Privacy header values | 13.1.0 | 13.2.0 | +| 2015-06 | CT-68 | CP-150351 | 0895 | - | Bearer Termination in Acknowledgements | 13.1.0 | 13.2.0 | +| 2015-06 | CT-68 | CP-150334 | 0901 | 3 | URI scheme in History-Info header field | 13.1.0 | 13.2.0 | +| 2015-06 | CT-68 | CP-150364 | 0902 | - | CDIV - miscellaneous corrections | 13.1.0 | 13.2.0 | +| 2015-06 | CT-68 | CP-150353 | 0904 | 1 | EVS corrections | 13.1.0 | 13.2.0 | +| 2015-09 | CT-69 | CP-150470 | 0912 | 1 | Indication of "no backward early media" for ICS call | 13.2.0 | 13.3.0 | +| 2015-09 | CT-69 | CP-150479 | 0913 | 1 | Reference update: draft-mohali-dispatch-cause-for-service-number | 13.2.0 | 13.3.0 | +| 2015-09 | CT-69 | CP-150462 | 0920 | 2 | Sending of IAM at I-MGCF for SIP-BICC-interworking | 13.2.0 | 13.3.0 | +| 2015-12 | CT-70 | CP-150667 | 0914 | 8 | Stage 2 Mn supporting SDP capability negotiation | 13.3.0 | 13.4.0 | +| 2015-12 | CT-70 | CP-150656 | 0923 | - | HOLD request from CS side: suspending media to the conference | 13.3.0 | 13.4.0 | +| 2015-12 | CT-70 | CP-150657 | 0924 | 2 | Reference update: draft-mohali-dispatch-cause-for-service-number | 13.3.0 | 13.4.0 | +| 2015-12 | CT-70 | CP-150648 | 0925 | 3 | Updates to MGCF and IM-MGW to support EVS over UMTS CS | 13.3.0 | 13.4.0 | +| 2015-12 | CT-70 | CP-150670 | 0931 | 2 | URI scheme in History-Info header field | 13.3.0 | 13.4.0 | +| 2015-12 | CT-70 | CP-150655 | 0933 | 1 | ICS call: removal of non-interworking requirement | 13.3.0 | 13.4.0 | +| 2015-12 | CT-70 | CP-150796 | 0940 | 2 | Correcting the clause title and the NOTE for interworking of Request-URI | 13.3.0 | 13.4.0 | +| 2015-12 | CT-70 | CP-150670 | 0946 | 1 | Removal for the unsupported SIPS URI scheme | 13.3.0 | 13.4.0 | +| Change history | | | | | | | | +| Date | TSG # | TSG Doc. | CR | Rev | Cat | Subject/Comment | New | + +| | | | | | | | | +|---------|-------|-----------|------|---|---|---------------------------------------------------------------------------------------------------------------|--------| +| 2016-03 | CT#71 | CP-160102 | 0954 | 2 | B | Support of enhanced bandwidth negotiation mechanism for MTSI sessions | 13.5.0 | +| 2016-03 | CT#71 | CP-160112 | 0955 | 1 | B | Resolution of Editor's notes on EVS over UMTS CS | 13.5.0 | +| 2016-03 | CT#71 | CP-160105 | 0961 | 1 | F | Correction for the SIP-ISUP interworking parameter | 13.5.0 | +| 2016-03 | CT#71 | CP-160105 | 0967 | 2 | F | Clarification on the setting of the SIP message components | 13.5.0 | +| 2016-03 | CT#71 | CP-160105 | 0968 | - | F | Removal of references to TS 26.235 and TS 26.236 | 13.5.0 | +| 2016-03 | CT#71 | CP-160111 | 0970 | 2 | A | Corrections to EVS AMR-WB IO mode-change-capability MIME parameter handling | 13.5.0 | +| 2016-06 | CT#72 | CP-160257 | 0953 | 5 | A | Interworking of History-Info Header Field when Original Called Number is not present | 13.6.0 | +| 2016-06 | CT#72 | CP-160256 | 0974 | - | A | Mapping P-Access-Network-Info header to Location Number, clarifications | 13.6.0 | +| 2016-06 | CT#72 | CP-160272 | 0976 | 3 | F | Clarification on counting diverting entries | 13.6.0 | +| 2016-06 | CT#72 | CP-160261 | 0977 | - | F | Update ref to draft-mohali-dispatch-cause-for-service-number-06 | 13.6.0 | +| 2016-06 | CT#72 | CP-160260 | 0975 | - | F | Correcting name of "network-provided" parameter | 14.0.0 | +| 2016-09 | CT#73 | CP-160451 | 0978 | 1 | F | Correction for the SIP-ISUP interworking regarding redirection counter | 14.1.0 | +| 2016-09 | CT#73 | CP-160450 | 0980 | 1 | A | Correction on mapping from 3GPP EVS to UMTS EVS codec | 14.1.0 | +| 2016-09 | CT#73 | CP-160451 | 0981 | 1 | F | Clarification on handling of P-Early-Media header | 14.1.0 | +| 2016-09 | CT#73 | CP-160449 | 0983 | 1 | A | Updated ref to draft-mohali-dispatch-cause-for-service-number-07 | 14.1.0 | +| 2016-12 | CT#74 | CP-160635 | 0990 | 1 | F | Unknown User Identity for Call Diversion | 14.2.0 | +| 2016-12 | CT#74 | CP-160631 | 0991 | 2 | D | Correction of Calculation of Redirection Counter | 14.2.0 | +| 2016-12 | CT#74 | CP-160624 | 0993 | 1 | A | Updated ref to draft-mohali-dispatch-cause-for-service-number-09 | 14.2.0 | +| 2016-12 | CT#74 | CP-160617 | 0995 | 2 | A | Updates to EVS over CS aspects | 14.2.0 | +| 2016-12 | CT#74 | CP-160631 | 0996 | 1 | F | Correction of Calculation of Redirection Counter | 14.2.0 | +| 2016-12 | CT#74 | CP-160618 | 0999 | 1 | A | Handling of dtx and dtx-recv MIME parameters in SDP offer/answer | 14.2.0 | +| 2016-12 | CT#74 | CP-160631 | 1000 | - | D | Update of subclause 9.2.3.4.2 | 14.2.0 | +| 2017-03 | CT#75 | CP-170080 | 1005 | 1 | A | Update ref to draft-mohali-dispatch-cause-for-service-number | 14.3.0 | +| 2017-03 | CT#75 | CP-170085 | 1006 | - | B | Support of "Calling number verification" | 14.3.0 | +| 2017-06 | CT#76 | CP-171130 | 1007 | 1 | B | Addition of the location parameter | 14.4.0 | +| 2017-06 | CT#76 | CP-171131 | 1009 | - | F | Mapping of additional 4xx response codes for SPECTRE | 14.4.0 | +| 2017-06 | CT#76 | CP-171124 | 1011 | 1 | A | Reference Update RFC8119" | 14.4.0 | +| 2017-06 | CT#76 | CP-171131 | 1012 | 1 | F | Reference update: draft-ietf-sipcore-status-unwanted | 14.4.0 | +| 2017-06 | CT#76 | CP-171131 | 1013 | - | F | Reference update: draft-ietf-stir-rfc4474bis | 14.4.0 | +| 2017-09 | CT#77 | CP-172045 | 1014 | 1 | F | Reference Update for the ISUP location parameter | 14.5.0 | +| 2017-09 | CT#77 | CP-172049 | 1015 | - | F | Reference update from draft-ietf-sipcore-status-unwanted-06 to RFC 8197 | 14.5.0 | +| 2017-09 | CT#77 | CP-172050 | 1016 | 1 | F | "user=phone" URI parameter for SIP URIs in the SIP P-Asserted-Identity header field | 15.0.0 | +| 2017-12 | CT#78 | CP-173099 | 1018 | 1 | A | Reference Update for the ISUP location parameter | 15.1.0 | +| 2017-12 | CT#78 | CP-173099 | 1020 | - | A | Reference Update for the ISUP location parameter | 15.1.0 | +| 2018-03 | CT#79 | CP-180041 | 1021 | 2 | B | Interworking of Subaddress for user specified type | 15.2.0 | +| 2018-03 | CT#79 | CP-180042 | 1023 | - | A | Reference Update for the ISUP location parameter | 15.2.0 | +| 2018-03 | CT#79 | CP-180044 | 1025 | - | A | Reference update: RFC 8224 | 15.2.0 | +| 2018-06 | CT#80 | CP-181022 | 1026 | - | F | Interwork of Connected subaddress IE carried in ISUP CON message | 15.3.0 | +| 2018-06 | CT#80 | CP-181018 | 1031 | - | A | Correction of the Backward call indicators parameter interworking | 15.3.0 | +| 2018-06 | CT#80 | CP-181016 | 1040 | 1 | B | Providing attestation information | 15.3.0 | +| 2018-09 | CT#81 | CP-182028 | 1042 | 2 | F | Correction of the Interworking of the Redirecting Number | 15.4.0 | +| 2018-09 | CT#81 | CP-182024 | 1044 | - | A | Reference Update for the ISUP Q.850 location parameter | 15.4.0 | +| 2018-12 | CT#82 | CP-183112 | 1053 | - | A | Resolution of Editor's Notes in TS 29.163 | 15.5.0 | +| 2018-12 | CT#82 | CP-183115 | 1045 | 2 | B | New Q850 cause for Call completed elsewhere | 16.0.0 | +| 2019-03 | CT#83 | CP-190122 | 1054 | 1 | F | Correction for the encoding of the INFO message for overlap signalling using the in-dialog method | 16.1.0 | +| 2019-03 | CT#83 | CP-190126 | 1057 | 2 | A | Reference Update for the ISUP Cause Location Parameter Draft | 16.1.0 | +| 2019-06 | CT#84 | CP-191094 | 1061 | - | A | Reference Update for the ISUP Cause Location Parameter Draft | 16.2.0 | +| 2019-09 | CT#85 | CP-192174 | 1058 | 4 | F | Modification on the setting of P-Asserted-Identity header field when a calling party number is not available. | 16.3.0 | +| 2019-09 | CT#85 | CP-192166 | 1064 | 1 | A | Reference Update RFC8606 | 16.3.0 | +| 2019-09 | CT#85 | CP-192161 | 1069 | 1 | A | Mapping of History-Info header field to ISUP Original called number | 16.3.0 | +| 2019-12 | CT#86 | CP-193218 | 1070 | 4 | B | Interworking of Local Number Format in Generic Number | 16.4.0 | +| 2019-12 | CT#86 | CP-193218 | 1071 | - | F | Modification on the condition of setting of the Privacy header field when the call is diverted | 16.4.0 | +| 2019-12 | CT#86 | CP-193218 | 1072 | 1 | B | Interworking of Local Number Format in From Header Field | 16.4.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29165/421fc75480c21e7ebb25756826652367_img.jpg b/marked/Rel-16/29_series/29165/421fc75480c21e7ebb25756826652367_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b058640d94790558855159576ed75d7eb0af808d --- /dev/null +++ b/marked/Rel-16/29_series/29165/421fc75480c21e7ebb25756826652367_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b93050cb1d5f5b37ede0febd7acf612035e437a1b519453c780de25a321cf768 +size 89690 diff --git a/marked/Rel-16/29_series/29165/4cc7cdce3d498d8b0ba033a9be24ade5_img.jpg b/marked/Rel-16/29_series/29165/4cc7cdce3d498d8b0ba033a9be24ade5_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c9e9000a0390b8b0b570cdb3d352ace9e1612e00 --- /dev/null +++ b/marked/Rel-16/29_series/29165/4cc7cdce3d498d8b0ba033a9be24ade5_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1ffa2a7463bf7bd50936a69115bd878d9a26742c986e0f5fb8cdede63a683d09 +size 49061 diff --git a/marked/Rel-16/29_series/29165/79e1709a7317ead45379cbb8ff3ba802_img.jpg b/marked/Rel-16/29_series/29165/79e1709a7317ead45379cbb8ff3ba802_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0e5fcbafb4f48a1002979a86d8ab4738ff57018a --- /dev/null +++ b/marked/Rel-16/29_series/29165/79e1709a7317ead45379cbb8ff3ba802_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:df97d4088ebacdc7dde5b68c3cb0839e6965996e518043e8544a7518223814b0 +size 51055 diff --git a/marked/Rel-16/29_series/29165/d79d33da852cb7bca3e87b400a15c3e8_img.jpg b/marked/Rel-16/29_series/29165/d79d33da852cb7bca3e87b400a15c3e8_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..28dd8f1e64dd7c1848c086744979c3df51ec4a66 --- /dev/null +++ b/marked/Rel-16/29_series/29165/d79d33da852cb7bca3e87b400a15c3e8_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:90dd503267d3e5471a100cfb2e31a60c4a30d56ade3608edeb63f8ce4f25255e +size 17829 diff --git a/marked/Rel-16/29_series/29165/e180f2b5fcbe8001554a7c0677cd3f82_img.jpg b/marked/Rel-16/29_series/29165/e180f2b5fcbe8001554a7c0677cd3f82_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4ebece03f57b733b55a72a8e58c54568f368d4c0 --- /dev/null +++ b/marked/Rel-16/29_series/29165/e180f2b5fcbe8001554a7c0677cd3f82_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ba3ac90aa63fb729cdaa64a828d3082135749e6e751fe6f812a68fb0d530fb40 +size 22380 diff --git a/marked/Rel-16/29_series/29165/raw.md b/marked/Rel-16/29_series/29165/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..0cb3d837f58697e97b7567b9e93b6b4321313e78 --- /dev/null +++ b/marked/Rel-16/29_series/29165/raw.md @@ -0,0 +1,6009 @@ + + + + +Error: + +2 + +Error: Reference source not found + +# Contents + +| | | +|---------------------------------------------------------------------------------------------------|----| +| Foreword..... | 8 | +| 1 Scope..... | 9 | +| 2 References..... | 9 | +| 3 Definitions, symbols and abbreviations..... | 17 | +| 3.1 Definitions..... | 17 | +| 3.2 Symbols..... | 18 | +| 3.3 Abbreviations..... | 18 | +| 4 Overview..... | 20 | +| 5 Reference model for interconnection between IM CN subsystems..... | 22 | +| 5.1 General..... | 22 | +| 5.2 Functionalities performed by entities at the edge of the network..... | 23 | +| 5.2.1 Interconnection Border Control Function (IBCF)..... | 23 | +| 5.2.2 Transition Gateway (TrGW)..... | 24 | +| 5.3 Identifying II-NNI traversal scenario..... | 24 | +| 5.3.1 General..... | 24 | +| 5.3.2 Mapping of the "iotl" SIP URI parameter to II-NNI traversal scenario..... | 24 | +| 6 Control plane interconnection..... | 25 | +| 6.1 Definition of Inter-IMS Network to Network Interconnection..... | 25 | +| 6.1.1 SIP methods and header fields..... | 25 | +| 6.1.1.1 General..... | 25 | +| 6.1.1.2 SIP methods..... | 25 | +| 6.1.1.3 SIP header fields..... | 26 | +| 6.1.1.3.0 General..... | 26 | +| 6.1.1.3.1 Trust and no trust relationship..... | 26 | +| 6.1.1.3.2 Derivation of applicable SIP header fields from 3GPP TS 24.229 [5]..... | 28 | +| 6.1.1.3.3 Applicability of SIP header fields on a roaming II-NNI..... | 28 | +| 6.1.1.3.4 Applicability of SIP header fields on a non-roaming II-NNI..... | 29 | +| 6.1.1.4 Notations of the codes..... | 29 | +| 6.1.1.5 Modes of signalling..... | 30 | +| 6.1.2 SDP protocol..... | 30 | +| 6.1.2.1 General..... | 30 | +| 6.1.3 Major capabilities..... | 30 | +| 6.1.4 SIP message bodies..... | 36 | +| 6.2 Control Plane Transport..... | 39 | +| 6.2.1 General..... | 39 | +| 6.3 SIP timers..... | 39 | +| 7 User plane Interconnection..... | 41 | +| 7.1 Media and Codec..... | 41 | +| 7.2 User Plane Transport..... | 41 | +| 8 Numbering, Naming and Addressing..... | 42 | +| 8.1 Numbering, Naming and Addressing for SIP message..... | 42 | +| 8.2 Numbering, Naming and Addressing for SDP..... | 43 | +| 9 IP Version..... | 43 | +| 10 Security..... | 43 | +| 11 Charging..... | 43 | +| 11.1 General..... | 43 | +| 11.2 Inter-operator accounting..... | 44 | +| 11.3 Transfer of IP multimedia service tariff information..... | 44 | +| 12 Supplementary services associated with the IMS multimedia telephony communication service..... | 45 | +| 12.1 General..... | 45 | +| 12.2 Malicious Communication IDentification (MCID)..... | 45 | + +| | | | +|---------|----------------------------------------------------------------------------------------------------------|----| +| 12.3 | Originating Identification Presentation (OIP) and Originating Identification Restriction (OIR)..... | 46 | +| 12.4 | Terminating Identification Presentation (TIP) and Terminating Identification Restriction (TIR)..... | 46 | +| 12.5 | Anonymous Communication Rejection (ACR)..... | 46 | +| 12.6 | Communication DIVersion (CDIV)..... | 47 | +| 12.7 | Communication Waiting (CW)..... | 47 | +| 12.8 | Communication HOLD (HOLD)..... | 47 | +| 12.9 | Message Waiting Indication (MWI)..... | 47 | +| 12.10 | Communication Barring (CB)..... | 48 | +| 12.10.1 | Incoming Communication Barring (ICB)..... | 48 | +| 12.10.2 | Outgoing Communication Barring (OCB)..... | 48 | +| 12.11 | Completion of Communications to Busy Subscriber (CCBS)..... | 48 | +| 12.12 | Completion of Communications by No Reply (CCNR)..... | 49 | +| 12.13 | Explicit Communication Transfer (ECT)..... | 49 | +| 12.13.1 | Consultative and blind transfer..... | 49 | +| 12.13.2 | Assured transfer..... | 50 | +| 12.14 | Customized Alerting Tone (CAT)..... | 50 | +| 12.15 | Customized Ringing Signal (CRS)..... | 50 | +| 12.16 | Closed User Group (CUG)..... | 51 | +| 12.17 | Personal Network Management (PNM)..... | 51 | +| 12.18 | Three-Party (3PTY)..... | 51 | +| 12.19 | Conference (CONF)..... | 52 | +| 12.20 | Flexible Alerting (FA)..... | 52 | +| 12.21 | Announcements..... | 53 | +| 12.21.1 | General..... | 53 | +| 12.21.2 | Providing announcements during the establishment of a communication session..... | 53 | +| 12.21.3 | Providing announcements during an established communication session..... | 53 | +| 12.21.4 | Providing announcements when communication request is rejected..... | 53 | +| 12.22 | Advice Of Charge (AOC)..... | 54 | +| 12.23 | Completion of Communications on Not Logged-in (CCNL)..... | 54 | +| 12.24 | Unstructured Supplementary Service Data (USSD)..... | 55 | +| 12.25 | Enhanced Calling Name (eCNAM)..... | 55 | +| 12.26 | Multi-Device and Multi-Identity (MuD and MiD)..... | 55 | +| 12.26.1 | Multi-Device (MuD)..... | 55 | +| 12.26.2 | Multi-Identity (MiD)..... | 55 | +| 13 | Interoperability of IMS Centralized Services (ICS) over II-NNI..... | 56 | +| 13.1 | General..... | 56 | +| 13.2 | IMS Centralized Services (ICS)..... | 56 | +| 14 | Interoperability of IMS Service Continuity over II-NNI..... | 57 | +| 14.1 | General..... | 57 | +| 14.2 | PS to CS Single Radio Voice Call Continuity (SRVCC) and Single Radio Video Call Continuity (vSRVCC)..... | 57 | +| 14.2.1 | Basic PS to CS SRVCC..... | 57 | +| 14.2.2 | PS to CS SRVCC for calls in alerting phase..... | 57 | +| 14.2.3 | Using the ATCF based architecture..... | 58 | +| 14.2.4 | PS to CS SRVCC for originating calls in pre-alerting phase..... | 58 | +| 14.2.5 | PS to CS SRVCC with the MSC server assisted mid-call feature..... | 58 | +| 14.2.6 | PS to CS SRVCC for terminating calls in pre-alerting phase..... | 58 | +| 14.3 | Inter UE Transfer (IUT)..... | 58 | +| 14.4 | MSC server assisted mid-call feature..... | 59 | +| 14.5 | CS to PS Single Radio Voice Call Continuity (SRVCC)..... | 60 | +| 14.5.1 | Basic CS to PS SRVCC..... | 60 | +| 14.5.2 | CS to PS SRVCC for calls in alerting phase..... | 60 | +| 14.5.3 | CS to PS SRVCC with the assisted mid-call feature..... | 60 | +| 14.6 | PS to CS dual radio voice call continuity (DRVCC)..... | 60 | +| 14.6.1 | Basic PS to CS DRVCC..... | 60 | +| 14.6.2 | PS to CS DRVCC with the assisted mid-call feature..... | 61 | +| 14.6.3 | PS to CS DRVCC for calls in alerting phase..... | 61 | +| 14.6.4 | PS to CS DRVCC for originating calls in pre-alerting phase..... | 61 | +| 14.7 | CS to PS Dual Radio Voice Call Continuity (DRVCC)..... | 61 | +| 14.7.1 | Basic CS to PS DRVCC..... | 61 | + +| | | | +|--------|--------------------------------------------------------------------------------|----| +| 14.7.2 | CS to PS DRVCC with the assisted mid-call feature..... | 62 | +| 14.7.3 | CS to PS DRVCC for calls in alerting phase..... | 62 | +| 14.7.4 | CS to PS DRVCC for originating calls in pre-alerting phase..... | 62 | +| 14.8 | PS to PS access transfer..... | 62 | +| 15 | Presence service..... | 63 | +| 15.0 | General..... | 63 | +| 15.1 | Subscription of presence information..... | 63 | +| 15.2 | Watcher subscribing to Presence List..... | 63 | +| 15.3 | Subscription to Watcher Information..... | 64 | +| 15.4 | Subscription to state changes in XML documents..... | 64 | +| 15.5 | Presence enhancements specified in Open Mobile Alliance (OMA) Release 1.1..... | 64 | +| 15.5.1 | General..... | 64 | +| 15.5.2 | OMA subscription of presence information..... | 64 | +| 15.5.3 | OMA watcher subscribing to Presence List..... | 64 | +| 15.5.4 | OMA subscription to Watcher Information..... | 65 | +| 15.6 | Presence enhancements specified in Open Mobile Alliance (OMA) Release 2.0..... | 65 | +| 15.6.1 | General..... | 65 | +| 15.6.2 | OMA subscription of presence information..... | 65 | +| 15.6.3 | OMA watcher subscribing to Presence List..... | 65 | +| 15.6.4 | OMA subscription to Watcher Information..... | 66 | +| 15.6.5 | Subscription to state changes in XML documents..... | 66 | +| 15.6.6 | Void..... | 66 | +| 15.6.7 | Void..... | 66 | +| 16 | Messaging service..... | 66 | +| 16.1 | General..... | 66 | +| 16.2 | Page-mode messaging..... | 67 | +| 16.4 | Session-mode messaging..... | 67 | +| 16.5 | Session-mode messaging conferences..... | 67 | +| 17 | Optimal Media Routeing..... | 68 | +| 17.1 | General..... | 68 | +| 17.2 | OMR related SDP attributes..... | 68 | +| 17.3 | IP realm names..... | 68 | +| 18 | Inter-UE transfer (IUT)..... | 68 | +| 18.1 | General..... | 68 | +| 18.2 | IUT without establishment of a collaborative session..... | 68 | +| 18.3 | IUT using a collaborative session..... | 69 | +| 18.3.1 | Collaborative session of participants of the same subscription..... | 69 | +| 18.3.2 | Establishment of a collaborative session during session setup..... | 69 | +| 18.3.3 | Assignment and transfer of control of a collaborative session..... | 70 | +| 18.3.4 | Collaborative session of participants of different subscriptions..... | 70 | +| 18.4 | Session replication / media replication..... | 70 | +| 18.4.1 | Pull mode..... | 70 | +| 18.4.2 | Push mode..... | 70 | +| 19 | Roaming Architecture for Voice over IMS with Local Breakout..... | 71 | +| 20 | Delivery of Media Resource Broker address information..... | 71 | +| 21 | Overload control..... | 71 | +| 21.1 | General..... | 71 | +| 21.2 | Feedback based mechanism..... | 72 | +| 21.3 | The load filter mechanism..... | 72 | +| 22 | Delivery of original destination identity..... | 72 | +| 23 | Telepresence using IMS..... | 72 | +| 24 | Barring of premium rate numbers..... | 73 | +| 25 | P-CSCF restoration..... | 73 | +| 25.1 | General..... | 73 | +| 25.2 | PCRF or PCF based P-CSCF restoration..... | 73 | + +| | | | +|----------|-------------------------------------------------------------------------------------------|----| +| 25.3 | HSS or UDM/HSS based P-CSCF restoration..... | 73 | +| 26 | Resource sharing..... | 73 | +| 27 | Service access number translation..... | 74 | +| 28 | Mission critical services..... | 74 | +| 28.1 | General..... | 74 | +| 28.2 | Interoperability of mission critical services for communication over II-NNI..... | 75 | +| 28.2.1 | Mission Critical services session establishment..... | 75 | +| 28.2.2 | MBMS transmission usage and location procedures..... | 76 | +| 28.2.3 | Affiliation procedure..... | 77 | +| 28.2.3.1 | General..... | 77 | +| 28.2.3.2 | Mandatory mode..... | 77 | +| 28.2.3.3 | Negotiated mode..... | 78 | +| 28.2.4 | Conference event package subscription..... | 78 | +| 28.2.5 | Mission critical services settings..... | 78 | +| 28.2.6 | Registration procedures..... | 79 | +| 28.2.7 | Group regrouping..... | 79 | +| 28.2.8 | Signalling plane messages for mission critical data..... | 80 | +| 28.2.9 | Functional alias management procedure..... | 80 | +| 29 | Calling number verification using signature verification and attestation information..... | 80 | +| 30 | IMS emergency service..... | 81 | +| 30.1 | IMS emergency registration..... | 81 | +| 30.2 | IMS emergency session..... | 81 | +| 30.3 | Next-Generation Pan-European eCall emergency service..... | 81 | + +| | | | +|-------------------------------|----------------------------------------------------------------------------------------------|------------| +| 31 | Restricted Local Operator Services (RLOS)..... | 81 | +| 32 | 3GPP PS data off extension..... | 82 | +| 33 | MTSI Data channel..... | 82 | +| Annex A (informative): | Summary of SIP header fields..... | 82 | +| Annex B (informative): | Dynamic view of SIP header fields within SIP messages..... | 86 | +| B.1 | Scope..... | 86 | +| B.2 | Methodology..... | 86 | +| B.3 | ACK method..... | 88 | +| B.4 | BYE method..... | 89 | +| B.5 | CANCEL method..... | 92 | +| B.6 | INFO method..... | 93 | +| B.7 | INVITE method..... | 97 | +| B.8 | MESSAGE method..... | 103 | +| B.9 | NOTIFY method..... | 106 | +| B.10 | OPTIONS method..... | 109 | +| B.11 | PRACK method..... | 113 | +| B.12 | PUBLISH method..... | 115 | +| B.13 | REFER method..... | 119 | +| B.14 | REGISTER method..... | 123 | +| B.15 | SUBSCRIBE method..... | 125 | +| B.16 | UPDATE method..... | 129 | +| Annex C (informative): | The list of option items for II-NNI..... | 133 | +| C.1 | Scope..... | 133 | +| C.2 | Format of option item table..... | 133 | +| C.3 | Option item table..... | 133 | +| C.3.0 | Supported II-NNI traversal scenarios..... | 133 | +| C.3.1 | Option item table common to roaming, non-roaming II-NNI and loopback traversal scenario..... | 134 | +| C.3.2 | Option item table specific to roaming II-NNI..... | 143 | +| C.3.3 | Option item table specific to non-roaming II-NNI and loopback traversal scenario..... | 146 | +| Annex D (informative): | Change history..... | 150 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 1 Scope + +The objective of this document is to address the Inter-IMS Network to Network Interface (II-NNI) consisting of Ici and Izi reference points between IMS networks in order to support end-to-end service interoperability. + +The present document addresses the issues related to control plane signalling (3GPP usage of SIP and SDP protocols, required SIP header fields) as well as other interconnecting aspects like security, numbering/naming/addressing and user plane issues as transport protocol, media and codecs actually covered in a widespread set of 3GPP specifications. A profiling of the Inter-IMS Network to Network Interface (II-NNI) is also provided. + +Charging aspects are addressed as far as SIP signalling is concerned. + +IMS emergency session establishment between IMS networks is addressed as far as SIP signalling is concerned. + +SIP signalling traversing the NNI between a CSCF and MRB, e.g. for media control or Voice Interworking with Enterprise IP-PBX, and SIP signalling traversing the NNI on the Mr interface between the CSCF and the MRFC, or on the Mr' interface between the AS and MRFC, or on the Rc interface between AS and MRB is not considered in the present release of this specification. + +SIP signalling traversing the NNI between an application server and the remaining IMS functional entities (e.g. for MCPTT interface SIP-2 in figure 7.3.1-2 in 3GPP TS 23.280 [200]) is not considered in the present release of this specification. + +SIP signalling traversing the NNI between an ISC gateway and an AS in an enterprise network, e.g. for media control and voice interworking with enterprise IP-PBX, on the ISC interface between the ISC gateway and the enterprise network is not considered in the present release of this specification. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document in the same Release as the present document. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] IETF RFC 791: "Internet Protocol". +- [3] 3GPP TS 23.002: "Network architecture". +- [4] 3GPP TS 23.228: "IP Multimedia Subsystem (IMS); Stage 2". +- [5] 3GPP TS 24.229: "Internet Protocol (IP) multimedia call control protocol based on Session Initiation Protocol (SIP) and Session Description Protocol (SDP); Stage 3". +- [6] 3GPP TR 24.930: "Signalling flows for the session setup in the IP Multimedia core network Subsystem (IMS) based on Session Initiation Protocol (SIP) and Session Description Protocol (SDP); Stage 3". +- [7] IETF RFC 2460: "Internet Protocol, Version 6 (IPv6) Specification". +- [8] 3GPP TS 29.162: "Interworking between the IM CN subsystem and IP networks". +- [9] 3GPP TS 22.228: "Service requirements for the IP multimedia core network subsystem". +- [10] 3GPP TS 33.210: "3G security; Network Domain Security (NDS); IP network layer security". + +- [11] 3GPP TS 26.114: "IP Multimedia Subsystem (IMS); Multimedia Telephony; Media handling and interaction". +- [12] ETSI TS 181 005 V1.1.1: "Telecommunications and Internet converged Services and Protocols for Advanced Networking (TISPAN); Services and Capabilities Requirements". +- [13] IETF RFC 3261: "SIP: Session Initiation Protocol". +- [14] IETF RFC 3966: "The tel URI for Telephone Numbers". +- [15] IETF RFC 3860: "Common Profile for Instant Messaging (CPIM)". +- [16] IETF RFC 3859: "Common Profile for Presence (CPP)". +- [17] IETF RFC 4975: "The Message Session Relay Protocol (MSRP)". +- [18] IETF RFC 3262: "Reliability of provisional responses in Session Initiation Protocol (SIP)". +- [19] IETF RFC 3428: "Session Initiation Protocol (SIP) Extension for Instant Messaging". +- [20] IETF RFC 6665: "SIP-Specific Event Notification". + +NOTE: In earlier releases of this document the predecessor IETF RFC 3265 is used. + +- [21] IETF RFC 3903: "An Event State Publication Extension to the Session Initiation Protocol (SIP)". +- [22] IETF RFC 3515: "The Session Initiation Protocol (SIP) REFER method". +- [23] IETF RFC 3311: "The Session Initiation Protocol (SIP) UPDATE method". +- [24] IETF RFC 7315: "Private Header (P-Header) Extensions to the Session Initiation Protocol (SIP) for the 3GPP". +- [24A] IETF RFC 7976: "Updates to Private Header (P-Header) Extension Usage in Session Initiation Protocol (SIP) Requests and Responses". +- [24B] IETF RFC 7913: "P-Access-Network-Info ABNF Update". +- [25] IETF RFC 7044: "An Extension to the Session Initiation Protocol (SIP) for Request History Information". +- [26] IETF RFC 6050: "A Session Initiation Protocol (SIP) Extension for the Identification of Services". +- [27] IETF RFC 4168: "The Stream Control Transmission Protocol (SCTP) as a Transport for the Session Initiation Protocol (SIP)". +- [28] Void. +- [29] 3GPP TS 32.260: "Telecommunication management; Charging management; IP Multimedia Subsystem (IMS) charging". +- [30] 3GPP TS 22.173: "IP Multimedia Core Network Subsystem (IMS); Multimedia Telephony Service and supplementary services; Stage 1". +- [31] 3GPP TS 24.173: "IMS multimedia telephony communication service and supplementary services; Stage 3". +- [32] 3GPP TS 24.607: "Originating Identification Presentation (OIP) and Originating Identification Restriction (OIR) using IP Multimedia (IM); Core Network (CN) subsystem". +- [33] 3GPP TS 24.616: "Malicious Communication Identification (MCID) using IP Multimedia (IM) Core Network (CN) subsystem". +- [34] IETF RFC 3323: "A Privacy Mechanism for the Session Initiation Protocol (SIP)". +- [35] 3GPP TS 23.003: "Numbering, addressing and identification". + +- [36] 3GPP TS 24.610: "Communication HOLD (HOLD) using IP Multimedia (IM) Core Network (CN) subsystem". +- [37] 3GPP TS 24.615: "Communication Waiting (CW) using IP Multimedia (IM) Core Network (CN) subsystem". +- [38] 3GPP TS 24.628: "Common Basic Communication procedures using IP Multimedia (IM) Core Network (CN) subsystem". +- [39] IETF RFC 6086: "Session Initiation Protocol (SIP) INFO Method and Package Framework". +- [40] IETF RFC 3312: "Integration of resource management and Session Initiation Protocol (SIP)". +- [41] IETF RFC 4032: "Update to the Session Initiation Protocol (SIP) Preconditions Framework". +- [42] IETF RFC 3313: "Private Session Initiation Protocol (SIP) Extensions for Media Authorization". +- [43] IETF RFC 3327: "Session Initiation Protocol Extension Header Field for Registering Non-Adjacent Contacts". +- [44] IETF RFC 3325: "Private Extensions to the Session Initiation Protocol (SIP) for Network Asserted Identity within Trusted Networks". +- [45] IETF RFC 3608: "Session Initiation Protocol (SIP) Extension Header Field for Service Route Discovery During Registration". +- [46] IETF RFC 3486: "Compressing the Session Initiation Protocol (SIP)". +- [47] IETF RFC 3329: "Security Mechanism Agreement for the Session Initiation Protocol (SIP)". +- [48] IETF RFC 3326: "The Reason Header Field for the Session Initiation Protocol (SIP)". +- [49] IETF RFC 6432: "Carrying Q.850 Codes in Reason Header Fields in SIP (Session Initiation Protocol) Responses". +- [50] IETF RFC 3581: "An Extension to the Session Initiation Protocol (SIP) for Symmetric Response Routing". +- [51] IETF RFC 3841: "Caller Preferences for the Session Initiation Protocol (SIP)". +- [52] IETF RFC 4028: "Session Timers in the Session Initiation Protocol (SIP)". +- [53] IETF RFC 3892: "The Session Initiation Protocol (SIP) Referred-By Mechanism". +- [54] IETF RFC 3891: "The Session Initiation Protocol (SIP) 'Replaces' Header". +- [55] IETF RFC 3911: "The Session Initiation Protocol (SIP) 'Join' Header". +- [56] IETF RFC 3840: "Indicating User Agent Capabilities in the Session Initiation Protocol (SIP)". +- [57] IETF RFC 5079: "Rejecting Anonymous Requests in the Session Initiation Protocol (SIP)". +- [58] IETF RFC 4458: "Session Initiation Protocol (SIP) URIs for Applications such as Voicemail and Interactive Voice Response (IVR)". +- [59] IETF RFC 4320: "Actions Addressing Identified Issues with the Session Initiation Protocol's (SIP) Non-INVITE Transaction". +- [60] IETF RFC 4457: "The Session Initiation Protocol (SIP) P-User-Database Private-Header (P-header)". +- [61] IETF RFC 5031: "A Uniform Resource Name (URN) for Emergency and Other Well-Known Services". +- [62] IETF RFC 5627: "Obtaining and Using Globally Routable User Agent (UA) URIs (GRUU) in the Session Initiation Protocol (SIP)". + +- [63] Void. +- [64] IETF RFC 5002: "The Session Initiation Protocol (SIP) P-Profile-Key Private Header (P-Header)". +- [65] IETF RFC 5626: "Managing Client-Initiated Connections in the Session Initiation Protocol (SIP)". +- [66] IETF RFC 5768: "Indicating Support for Interactive Connectivity Establishment (ICE) in the Session Initiation Protocol (SIP)". +- [67] IETF RFC 5365: "Multiple-Recipient MESSAGE Requests in the Session Initiation Protocol (SIP)". +- [68] IETF RFC 6442: "Location Conveyance for the Session Initiation Protocol". +- [69] IETF RFC 5368: "Referring to Multiple Resources in the Session Initiation Protocol (SIP)". +- [70] IETF RFC 5366: "Conference Establishment Using Request-Contained Lists in the Session Initiation Protocol (SIP)". +- [71] IETF RFC 5367: "Subscriptions to Request-Contained Resource Lists in the Session Initiation Protocol (SIP)". +- [72] IETF RFC 4967: "Dial String Parameter for the Session Initiation Protocol Uniform Resource Identifier". +- [73] IETF RFC 4964: "The P-Answer-State Header Extension to the Session Initiation Protocol for the Open Mobile Alliance Push to Talk over Cellular". +- [74] IETF RFC 5009: "Private Header (P-Header) Extension to the Session Initiation Protocol (SIP) for Authorization of Early Media". +- [75] IETF RFC 4694: "Number Portability Parameters for the 'tel' URI". +- [76] Void. +- [77] IETF RFC 4411: "Extending the Session Initiation Protocol (SIP) Reason Header for Preemption Events". +- [78] IETF RFC 4412: "Communications Resource Priority for the Session Initiation Protocol (SIP)". +- [79] IETF RFC 5393: "Addressing an Amplification Vulnerability in Session Initiation Protocol (SIP) Forking Proxies". +- [80] IETF RFC 5049: "Applying Signaling Compression (SigComp) to the Session Initiation Protocol (SIP)". +- [81] IETF RFC 5688: "A Session Initiation Protocol (SIP) Media Feature Tag for MIME Application Sub-Types". +- [82] IETF RFC 5360: "A Framework for Consent-Based Communications in the Session Initiation Protocol (SIP)". +- [83] IETF RFC 7433: "A Mechanism for Transporting User-to-User Call Control Information in SIP". +- [83A] IETF RFC 7434: "Interworking ISDN Call Control User Information with SIP". +- [84] IETF RFC 7316: "The Session Initiation Protocol (SIP) P-Private-Network-Indication Private Header (P-Header)". +- [85] IETF RFC 5502: "The SIP P-Served-User Private-Header (P-Header) for the 3GPP IP Multimedia (IM) Core Network (CN) Subsystem". +- [86] Void. +- [87] IETF RFC 8497: "Marking SIP Messages to Be Logged". +- [88] IETF RFC 6228: "Response Code for Indication of Terminated Dialog". + +- [89] IETF RFC 5621: "Message Body Handling in the Session Initiation Protocol (SIP)". +- [90] IETF RFC 6223: "Indication of support for keep-alive". +- [91] IETF RFC 5552: "SIP Interface to VoiceXML Media Services". +- [92] IETF RFC 3862: "Common Presence and Instant Messaging (CPIM): Message Format". +- [93] IETF RFC 5438: "Instant Message Disposition Notification". +- [94] IETF RFC 5373: "Requesting Answering Modes for the Session Initiation Protocol (SIP)". +- [95] Void. +- [96] IETF RFC 3959: "The Early Session Disposition Type for the Session Initiation Protocol (SIP)". +- [97] Void. +- [98] 3GPP TS 24.183: "Customized Ringing Signal (CRS) using IP Multimedia (IM) Core Network (CN) subsystem". +- [99] 3GPP TS 24.259: "Personal Network Management (PNM) using IP Multimedia (IM) Core Network (CN) subsystem". +- [100] 3GPP TS 24.238: "Session Initiation Protocol (SIP) based user configuration". +- [101] 3GPP TS 24.239: "Flexible Alerting (FA) using IP Multimedia (IM) Core Network (CN) subsystem". +- [102] Void. +- [103] 3GPP TS 24.654: "Closed User Group (CUG) using IP Multimedia (IM) Core Network (CN) subsystem". +- [104] Void. +- [105] 3GPP TS 24.605: "Conference (CONF) using IP Multimedia (IM) Core Network (CN) subsystem". +- [106] 3GPP TS 24.147: "Conferencing using the IP Multimedia (IM) Core Network (CN) subsystem". +- [107] Void. +- [108] Void. +- [109] 3GPP TS 24.642: "Completion of Communications to Busy Subscriber (CCBS) Completion of Communications by No Reply (CCNR) using IP Multimedia (IM) Core Network (CN) subsystem". +- [110] Void. +- [111] Void. +- [112] 3GPP TS 24.606: "Message Waiting Indication (MWI) using IP Multimedia (IM) Core Network (CN) subsystem". +- [113] 3GPP TS 24.608: "Terminating Identification Presentation (TIP) and Terminating Identification Restriction (TIR) using IP Multimedia (IM); Core Network (CN) subsystem". +- [114] 3GPP TS 24.611: "Communication Barring (CB) using IP Multimedia (IM); Core Network (CN) subsystem". +- [115] Void. +- [116] 3GPP TS 24.629: "Explicit Communication Transfer (ECT) using IP Multimedia (IM) Core Network (CN) subsystem". + +- [117] 3GPP TS 24.604: "Communication DIVersion (CDIV) using IP Multimedia (IM) Core Network (CN) subsystem". +- [118] Void. +- [119] Void. +- [120] 3GPP TS 23.292: "IP Multimedia Subsystem (IMS) Centralized Services; Stage 2". +- [121] 3GPP TS 24.292: "IP Multimedia Core Network subsystem Centralized Services (ICS); Stage 3". +- [122] 3GPP TS 24.647: "Advice Of Charge (AOC) using IP Multimedia (IM) Core Network (CN) subsystem". +- [123] Void. +- [124] IETF RFC 7989: "End-to-End Session Identification in IP-Based Multimedia Communication Networks". +- [125] IETF RFC 6026: "Correct Transaction Handling for 2xx Responses to Session Initiation Protocol (SIP) INVITE Requests". +- [126] IETF RFC 5658: "Addressing Record-Route issues in the Session Initiation Protocol (SIP)". +- [127] IETF RFC 5954: "Essential correction for IPv6 ABNF and URI comparison in RFC3261". +- [128] Void. +- [129] 3GPP TS 24.182: "IP Multimedia Subsystem (IMS) Customized Alerting Tones (CAT)". +- [130] 3GPP TS 29.292: "Interworking between the IP Multimedia (IM) Core Network (CN) subsystem and MSC Server for IMS Centralized Services (ICS)". +- [131] 3GPP TS 24.237: "IP Multimedia (IM) Core Network (CN) subsystem; IP Multimedia Subsystem (IMS) Service Continuity". +- [132] 3GPP TS 24.141: "Presence service using the IP Multimedia (IM) Core Network (CN) subsystem". +- [133] IETF RFC 6794: "A Framework for Session Initiation Protocol (SIP) Session Policies". +- [134] IETF RFC 5875: "An Extensible Markup Language (XML) Configuration Access Protocol (XCAP) Diff Event Package". +- [135] IETF RFC 4488: "Suppression of Session Initiation Protocol (SIP) REFER Method Implicit Subscription". +- [136] IETF RFC 7462: "URNs for the Alert-Info Header Field of the Session Initiation Protocol (SIP)". +- [137] Void. +- [138] OMA-TS-Presence\_SIMPLE-V2\_0-20120710-A: "Presence SIMPLE Specification". +- [139] 3GPP TS 24.247: "Messaging service using the IP Multimedia (IM) Core Network (CN) subsystem". +- [140] IETF RFC 4538: "Request Authorization through Dialog Identification in the Session Initiation Protocol (SIP)". +- [141] IETF RFC 5318: "The Session Initiation Protocol (SIP) P-Refused-URI-List Private-Header (P-Header)". +- [142] OMA-TS-Presence\_SIMPLE-V1\_1\_1-20100225-A: "Presence SIMPLE Specification". +- [143] IETF RFC 6809: "Mechanism to Indicate Support of Features and Capabilities in the Session Initiation Protocol (SIP)". + +- [144] IETF RFC 5839: "An Extension to Session Initiation Protocol (SIP) Events for Conditional Event Notification". +- [145] Void. +- [146] IETF RFC 3264: "An Offer/Answer Model with the Session Description Protocol (SDP)". +- [147] IETF RFC 4566: "SDP: Session Description Protocol". +- [148] 3GPP TS 29.079: "Optimal Media Routeing within the IP Multimedia Subsystem; Stage 3". +- [149] 3GPP TS 24.337: "IP Multimedia Subsystem (IMS) inter-UE transfer". +- [150] IETF RFC 3960: "Early Media and Ringing Tone Generation in the Session Initiation Protocol (SIP)". +- [151] IETF RFC 3550: "RTP: A Transport Protocol for Real-Time Applications". +- [152] IETF RFC 768: "User Datagram Protocol". +- [153] IETF RFC 3551: "RTP Profile for Audio and Video Conferences with Minimal Control". +- [154] IETF RFC 3556: "Session Description Protocol (SDP) Bandwidth Modifiers for RTP Control Protocol (RTCP) Bandwidth". +- [155] IETF RFC 4585: "Extended RTP Profile for Real-time Transport Control Protocol (RTCP)-Based Feedback (RTP/AVPF)". +- [156] IETF RFC 793: "Transmission Control Protocol". +- [157] IETF RFC 4733: "RTP Payload for DTMF Digits, Telephony Tones, and Telephony Signals". +- [158] IETF RFC 4916: "Connected Identity in the Session Initiation Protocol (SIP)". +- [159] 3GPP TS 23.237: "IP Multimedia Subsystem (IMS) Service Continuity". +- [160] IETF RFC 6140: "Registration for Multiple Phone Numbers in the Session Initiation Protocol (SIP)". +- [161] IETF RFC 6230: "Media Control Channel Framework". +- [162] IETF RFC 4145: "TCP-Based Media Transport in the Session Description Protocol (SDP)". +- [163] 3GPP TS 24.390: "Unstructured Supplementary Service Data (USSD)". +- [164] IETF RFC 6357: "Design Considerations for Session Initiation Protocol (SIP) Overload Control". +- [165] IETF RFC 7339: "Session Initiation Protocol (SIP) Overload Control". +- [166] IETF RFC 7415: "Session Initiation Protocol (SIP) Rate Control". +- [167] IETF RFC 7200: "A Session Initiation Protocol (SIP) Load-Control Event Package". +- [168] 3GPP TS 29.163: "Interworking between the IP Multimedia (IM) Core Network (CN) subsystem and Circuit Switched (CS) networks". +- [169] IETF RFC 2046: "Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types". +- [170] IETF RFC 2387: "The MIME Multipart/Related Content-type". +- [171] IETF RFC 3420: "Internet Media Type message/sipfrag". +- [172] IETF RFC 3842: "A Message Summary and Message Waiting Indication Event Package for the Session Initiation Protocol (SIP)". +- [173] IETF RFC 3858: "An Extensible Markup Language (XML) Based Format for Watcher Information". + +- [174] IETF RFC 3863: "Presence Information Data Format (PIDF)". +- [175] IETF RFC 3994: "Indication of Message Composition for Instant Messaging". +- [176] IETF RFC 4661: "An Extensible Markup Language (XML) Based Format for Event Notification Filtering". +- [177] IETF RFC 4662: "A Session Initiation Protocol (SIP) Event Notification Extension for Resource Lists". +- [178] IETF RFC 4826: "Extensible Markup Language (XML) Formats for Representing Resource Lists". +- [179] IETF RFC 5262: "Presence Information Data Format (PIDF) Extension for Partial Presence". +- [180] IETF RFC 5874: "An Extensible Markup Language (XML) Document Format for Indicating a Change in XML Configuration Access Protocol (XCAP) Resources". +- [181] Void. +- [182] OMA-SUP-XSD\_prs\_suppnotFilter-V1\_0-20120710-A: "Presence - Event notification suppression filter". +- [183] 3GPP TS 32.240: "Telecommunication management; Charging management; Charging architecture and principles". +- [184] IETF RFC 7090: "Public Safety Answering Point (PSAP) Callback". +- [185] IETF RFC 8055: "Session Initiation Protocol (SIP) Via Header Field Parameter to Indicate Received Realm". +- [186] 3GPP TS 29.658: "SIP Transfer of IP Multimedia Service Tariff Information". +- [187] 3GPP TS 22.153: "Multimedia priority service". +- [188] IETF RFC 7549: "3GPP SIP URI Inter Operator Traffic Leg parameter". +- [189] 3GPP TS 24.103: "Telepresence using the IP Multimedia (IM) Core Network (CN) Subsystem (IMS); Stage 3". +- [190] IETF RFC 8841: "Session Description Protocol (SDP) Offer/Answer Procedures for Stream Control Transmission Protocol (SCTP) over Datagram Transport Layer Security (DTLS) Transport". +- [191] 3GPP TS 24.315: "IP Multimedia Subsystem (IMS) Operator Determined Barring (ODB)". +- [192] 3GPP TR 29.949: "Study on Technical aspects on Roaming End-to-end scenarios with VoLTE IMS and other networks". +- [193] IETF RFC 8119: "SIP "cause" URI Parameter for Service Number Translation". +- [194] IETF RFC 7647: "Clarifications for the Use of REFER with RFC6665". +- [195] IETF RFC 7614: "Explicit Subscriptions for the REFER Method". +- [196] IETF RFC 7621: "A Clarification on the Use of Globally Routable User Agent URIs (GRUUs) in the Session Initiation Protocol SIP Event Notification Framework". +- [197] IETF RFC 2646: "The Text/Plain Format Parameter". +- [198] IETF RFC 1866: "Hypertext Markup Language - 2.0". +- [199] 3GPP TS 22.179: "Mission Critical Push To Talk (MCPTT); Stage 1". +- [200] 3GPP TS 23.280: "Common functional architecture to support mission critical services; Stage 2". +- [201] 3GPP TS 24.379: "Mission Critical Push To Talk (MCPTT) call control Protocol specification". + +- [202] 3GPP TS 24.380: "Mission Critical Push To Talk (MCPTT) floor control Protocol specification". +- [203] IETF RFC 8498: "A P-Served-User Header Field Parameter for an Originating Call Diversion (CDIV) Session Case in the Session Initiation Protocol (SIP)". +- [204] IETF RFC 4575: "A Session Initiation Protocol (SIP) Event Package for Conference State". +- [205] IETF RFC 4354: "A Session Initiation Protocol (SIP) Event Package and Data Format for Various Settings in Support for the Push-to-Talk over Cellular (PoC) Service". +- [206] IETF RFC 8224: "Authenticated Identity Management in the Session Initiation Protocol (SIP)". +- [207] IETF RFC 8197: "A SIP Response Code for Unwanted Calls". +- [208] IETF RFC 6910: "Completion of Calls for the Session Initiation Protocol (SIP)". +- [209] 3GPP TS 22.280: "Mission Critical Services Common Requirements". +- [210] 3GPP TS 24.281: "Mission Critical Video (MCVideo) signalling control; Protocol specification". +- [211] 3GPP TS 24.282: "Mission Critical Data (MCData) signalling control; Protocol specification". +- [212] 3GPP TS 24.581: "Mission Critical Video (MCVideo) media plane control; Protocol specification". +- [213] 3GPP TS 24.582: "Mission Critical Data (MCData) media plane control; Protocol specification". +- [214] IETF RFC 8606: "ISDN User Part (ISUP) Cause Location Parameter for the SIP Reason Header Field". +- [215] 3GPP TS 23.167: "IP Multimedia Subsystem (IMS) emergency sessions". +- [216] IETF RFC 8262: "Content-ID Header Field in the Session Initiation Protocol (SIP)". +- [217] 3GPP TS 24.196: "Technical Specification Group Core Network and Terminals; Enhanced Calling Name". +- [218] 3GPP TS 24.174: "Support of Multi-Device and Multi-Identity in IMS; Stage 3". +- [219] 3GPP TS 23.218: "IP Multimedia (IM) Session Handling; IM call model". + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +**example:** text used to clarify abstract rules by applying them literally. + +**IM CN subsystem:** (IP Multimedia CN subsystem) comprises of all CN elements for the provision of IP multimedia applications over IP multimedia sessions, as specified in 3GPP TS 22.228 [9]. + +**IP multimedia session:** as specified in 3GPP TS 22.228 [9] an IP multimedia session is a set of multimedia senders and receivers and the data streams flowing from senders to receivers. IP multimedia sessions are supported by the IP multimedia CN Subsystem and are enabled by IP connectivity bearers (e.g. GPRS as a bearer). A user can invoke concurrent IP multimedia sessions. + +**non-roaming II-NNI:** the II-NNI between IMS home networks, or, if the Roaming Architecture for Voice over IMS with Local Breakout is used, alternatively the II-NNI between the caller's visited network and the callee's home network. + +**roaming II-NNI:** the II-NNI between a visited IMS network and the IMS home network; for the Roaming Architecture for Voice over IMS with Local Breakout, the loopback traversal scenario is excluded. + +**loopback traversal scenario:** for the Roaming Architecture for Voice over IMS with Local Breakout, the scenario where the II-NNI between the caller's home network and the caller's visited network is being traversed by an initial INVITE request from the caller's home network to the caller's visited network or any subsequent SIP message within the same dialogue on the same call leg. + +**home-to-visited request on roaming II-NNI:** SIP request being sent from the callee's home network to the callee's visited network. + +**home routeing:** the scenario when the caller's home network routes a dialog creating SIP request directly to the callee's home network without using the loopback traversal scenario. + +**visited-to-home request on roaming II-NNI:** SIP request being sent from the caller's visited network to the caller's home network. + +**home-to-visited response on roaming II-NNI:** SIP response being sent from the caller's home network to the caller's visited network. + +**visited-to-home response on roaming II-NNI:** SIP response being sent from the callee's visited network to the callee's home network. + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 23.292 [120] apply: + +### **MSC Server enhanced for ICS** + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 23.237 [159] apply: + +### **MSC server enhanced for SRVCC** + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 24.237 [131] apply: + +### **MSC server enhanced for dual radio** + +For the purposes of the present document, the following term and definition given in 3GPP TS 23.218 [219] apply: + +### **Standalone transaction** + +## **3.2 Symbols** + +For the purposes of the present document, the following symbols apply: + +| | | +|-----|----------------------------------------------------------------------------------------------------------------------------------------------| +| I2 | Reference point between the MSC Server enhanced for ICS and the home IMS | +| Ici | Reference Point between an IBCF and another IBCF belonging to a different IM CN subsystem network | +| Izi | Reference Point between a TrGW and another TrGW or media handling node belonging to a different IM CN subsystem network | +| Mi | Reference Point between a BGCF and CSCF | +| Mm | Reference Point between a CSCF/BGCF/IMS ALG and an IP multimedia network | +| Mw | Reference Point between a CSCF and another CSCF | +| Mx | Reference Point between a CSCF/BGCF/MSC Server enhanced for ICS/ MSC Server enhanced for SRVCC / MSC server enhanced for dual radio and IBCF | + +## **3.3 Abbreviations** + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|------|------------------------------------------------| +| 18x | A SIP status-code in the range 180 through 189 | +| 2xx | A SIP status-code in the range 200 through 299 | +| 3PTY | Three-Party | +| 3xx | A SIP status-code in the range 300 through 399 | +| 4xx | A SIP status-code in the range 400 through 499 | +| 5GS | 5G System | + +| | | +|-----------|----------------------------------------------------------------------| +| 5xx | A SIP status-code in the range 500 through 599 | +| 6xx | A SIP status-code in the range 600 through 699 | +| ACR | Anonymous Communication Rejection | +| AOC | Advice Of Charge | +| AS | Application Server | +| ATCF | Access Transfer Control Function | +| B2BUA | Back 2 Back User Agent | +| BGCF | Breakout Gateway Control Function | +| CAT | Customized Alerting Tone | +| CB | Communication Barring | +| CCBS | Completion of Communications to Busy Subscriber | +| CCNL | Completion of Communications on Not Logged-in | +| CCNR | Communication Completion on No Reply | +| CDIV | Communication Diversion | +| CONF | Conference | +| CRS | Customized Ringing Signal | +| CSCF | Call Session Control Function | +| CW | Communication Waiting | +| DRVCC | Dual Radio Voice Call Continuity | +| eCNAM | Enhanced Calling Name | +| E-CSCF | Emergency CSCF | +| ECT | Explicit Communication Transfer | +| FA | Flexible Alerting | +| GRUU | Globally Routable User agent URIs | +| HOLD | Communication HOLD | +| IBCF | Interconnection Border Control Function | +| ICB | Incoming Communication Barring | +| ICID | IMS Charging Identifier | +| ICS | IMS Centralized Services | +| I-CSCF | Interrogating CSCF | +| II-NNI | Inter-IMS Network to Network Interface | +| IM | Instant Messaging | +| IMS-ALG | IMS Application Level Gateway | +| IOI | Inter Operator Identifier | +| IUT | Inter UE Transfer | +| MBMS | Multimedia Broadcast Multicast Service | +| MCDData | Mission Critical Data | +| MCID | Malicious Communication Identification | +| MCPTT | Mission Critical Push-To-Talk | +| MCVideo | Mission Critical Video | +| MiD | Multi-iDentity | +| MMTEL | Multimedia Telephony | +| MPS | Multimedia Priority Service | +| MRB | Media Resource Broker | +| MRFC | Media Resource Function Controller | +| MRFP | Multimedia Resource Function Processor | +| MSD | Minimum Set of Data | +| MSRP | Message Session Relay Protocol | +| MTSI | Multimedia Telephony Service for IMS | +| MuD | Multi-Device | +| MWI | Message Waiting Indication | +| NA(P)T-PT | Network Address (Port-Multiplexing) Translation-Protocol Translation | +| NNI | Network to Network Interface | +| OCB | Outgoing Communication Barring | +| OIP | Originating Identification Presentation | +| OIR | Originating Identification Restriction | +| OMA | Open Mobile Alliance | +| OMR | Optimal Media Routeing | +| P-CSCF | Proxy CSCF | +| PCF | Policy Control Function | +| PCRF | Policy and Charging Rules Function | + +| | | +|--------|-----------------------------------------| +| PNM | Personal Network Management | +| PRES | Presence | +| PSAP | Public Safety Answering Point | +| PSI | Public Service Identity | +| RLOS | Restricted Local Operator Services | +| RTT | Round-trip Time | +| S-CSCF | Serving CSCF | +| SRVCC | Single Radio Voice Call Continuity | +| STN | Session Transfer Number | +| TIP | Terminating Identification Presentation | +| TIR | Terminating Identification Restriction | +| TRF | Transit and Roaming Function | +| TrGW | Transition Gateway | +| UDM | Unified Data Management | +| vSRVCC | Single Radio Video Call Continuity | + +# 4 Overview + +Interconnection between two different IM CN subsystems shall be guaranteed in order to support end-to-end service interoperability. For this purpose, Inter-IMS Network to Network Interface (II-NNI) between two IM CN subsystem networks is adopted, according to the assumptions coming from 3GPP TS 23.002 [3] and 3GPP TS 23.228 [4]. + +NOTE: The end-to-end service interoperability within one IM CN subsystem over the Mi, Mm, Mw and I2 reference points not passing over the Mx reference point as defined in 3GPP TS 23.228 [4] is outside the scope of this document. + +Aiming to support the delivery of IMS services between two separated IM CN subsystems, protocol interconnection has to occur: + +- at a control plane level, in order that IMS procedures can be supported. In this case the adopted reference point is the Ici; and +- at a user plane level, where media streams are exchanged over the Izi reference point. + +IP multimedia sessions are managed by SIP. The transport mechanism for both SIP session signalling and media transport is IPv4 (IETF RFC 791 [2]) or IPv6 (IETF RFC 2460 [7]). The 3GPP profile of SIP defining the usage of SIP within the IM CN subsystem is specified in 3GPP TS 24.229 [5]. Example call flows are provided in 3GPP TR 24.930 [6]. + +The general interconnection model is shown in figure 4.1. + +![Diagram showing the interconnection model for two IM CN Subsystems connected via an II-NNI interface.](d79d33da852cb7bca3e87b400a15c3e8_img.jpg) + +``` + +graph LR + A((IM CN Subsystem)) --- B[II-NNI] + B --- C((IM CN Subsystem)) + +``` + +The diagram illustrates two grey oval shapes, each containing a white rectangular box with the text "IM CN Subsystem". These two ovals are connected by a horizontal line. In the center of this line, there is a vertical tick mark. Below the horizontal line, centered between the two ovals, is a white rectangular box containing the text "II-NNI". + +Diagram showing the interconnection model for two IM CN Subsystems connected via an II-NNI interface. + +**Figure 4.1: Interconnection Model for IM CN subsystems** + +The II-NNI traversal scenarios in this document are covered in figure 4.2, figure 4.3 and figure 4.4. + +![Diagram of II-NNI traversal scenarios with home routing.](79e1709a7317ead45379cbb8ff3ba802_img.jpg) + +This diagram illustrates II-NNI traversal scenarios when home routing is used. It features four nodes: IMS home network A, IMS home network B, IMS visited network X, and IMS visited network Y. IMS home network A and IMS home network B are connected by a horizontal line labeled 'non-roaming II-NNI'. Above this connection, an arrow points from A to B with the text 'request on non-roaming II-NNI (home routing)'. IMS visited network X is connected to IMS home network A by a vertical line labeled 'roaming II-NNI'. An arrow points from X to A with the text 'visited-to-home request on roaming II-NNI'. IMS visited network Y is connected to IMS home network B by a vertical line labeled 'roaming II-NNI'. An arrow points from B to Y with the text 'home-to-visited request on roaming II-NNI'. + +Diagram of II-NNI traversal scenarios with home routing. + +- NOTE 1: Any II-NNI can contain intermediate transit network(s). The intermediate transit network can either be an IMS transit network with or without a transit function as specified in 3GPP TS 24.229 [5] or a non-IMS transit network using standards outside the scope of 3GPP. +- NOTE 2: IMS home network A and IMS home network B represent the IMS home network on originating side and terminating side respectively. +- NOTE 3: IMS visited network X and IMS visited network Y represent the IMS visited network on originating side and terminating side respectively. + +**Figure 4.2: II-NNI traversal scenarios when P-CSCF is located in visited network and when home routing is used** + +![Diagram of II-NNI traversal scenarios with local breakout.](4cc7cdce3d498d8b0ba033a9be24ade5_img.jpg) + +This diagram illustrates II-NNI traversal scenarios when the roaming architecture for voice over IMS with local breakout is used. It features four nodes: IMS home network A, IMS home network B, IMS visited network X, and IMS visited network Y. IMS home network A and IMS home network B are connected by a horizontal line. Above this connection, an arrow points from A to B with the text 'request on non-roaming II-NNI (roaming architecture for voice over IMS with local breakout)'. IMS visited network X is connected to IMS home network A by a vertical line. An arrow points from X to A with the text 'visited-to-home request on roaming II-NNI'. Another arrow points from X to B with the text 'loopback traversal scenario'. IMS visited network Y is connected to IMS home network B by a vertical line. An arrow points from B to Y with the text 'home-to-visited request on roaming II-NNI'. + +Diagram of II-NNI traversal scenarios with local breakout. + +- NOTE 1: Any II-NNI can contain intermediate transit network(s). The intermediate transit network can either be an IMS transit network with or without a transit function as specified in 3GPP TS 24.229 [5] or a non-IMS transit network using standards outside the scope of 3GPP. +- NOTE 2: IMS home network A and IMS home network B represent the IMS home network on originating side and terminating side respectively. +- NOTE 3: IMS visited network X and IMS visited network Y represent the IMS visited network on originating side and terminating side respectively. + +**Figure 4.3: II-NNI traversal scenarios when P-CSCF is located in visited network and when the roaming architecture for voice over IMS with local breakout is used** + +![Figure 4.4: IMS emergency session traversal scenario on non-roaming II-NNI. The diagram shows an 'Originating IMS network O' connected to a 'Terminating IMS network T' via a thick horizontal line representing the II-NNI. A curved arrow above the line points from O to T, labeled 'IMS emergency session traversal scenario on non-roaming II-NNI'.](e180f2b5fcbe8001554a7c0677cd3f82_img.jpg) + +Figure 4.4: IMS emergency session traversal scenario on non-roaming II-NNI. The diagram shows an 'Originating IMS network O' connected to a 'Terminating IMS network T' via a thick horizontal line representing the II-NNI. A curved arrow above the line points from O to T, labeled 'IMS emergency session traversal scenario on non-roaming II-NNI'. + +- NOTE 1: Originating IMS network O represents the IMS network to which the originating UE is attached to, and terminating IMS network T represents the IMS network which accomodates a PSAP. +- NOTE 2: Originating IMS network O can be a visited IMS network or a home IMS network. +- NOTE 3: The E-CSCF is located in the originating IMS network O. +- NOTE 4: Any II-NNI between originating IMS network O and terminating IMS network T does not use any specific capabilities for roaming II-NNI, and is treated as non-roaming II-NNI. + +**Figure 4.4: IMS emergency session traversal scenario on non-roaming II-NNI** + +The possible functional entities involved in the signalling plane interconnection (IBCF, I-CSCF, P-CSCF, ATCF, S-CSCF, E-CSCF, BGCF, MSC Server enhanced for ICS, MSC server enhanced for SRVCC, MSC server enhanced for dual radio and TRF) and in the user plane interconnection (TrGW) are specified in 3GPP TS 24.229 [5], in 3GPP TS 24.292 [121], 3GPP TS 29.292 [130], 3GPP TS 29.162 [8] and in 3GPP TS 24.237 [131]. + +IP Version interworking is described within 3GPP TS 29.162 [8]. + +Examples of usage of the Inter-IMS Network to Network Interface (II-NNI) for roaming scenarios are described in 3GPP TR 29.949 [192]. + +# 5 Reference model for interconnection between IM CN subsystems + +## 5.1 General + +Figure 5.1.1 illustrates the architecture diagram given in 3GPP TS 23.228 [4] showing the Inter-IMS Network to Network Interface (II-NNI) between two IM CN subsystem networks. + +![Figure 5.1.1: Inter-IMS Network to Network Interface between two IM CN subsystem networks. The diagram shows two networks, 'IM CN subsystem network A' and 'IM CN subsystem network B', separated by a vertical dashed line labeled 'II-NNI'. Network A contains functional entities: P-CSCF, S-CSCF, I-CSCF, BGCF, IBCF, ATCF, MSC Server enhanced for ICS, SRVCC or dual radio, TrGW, TRF, TF, and AS. Network B contains the same entities. The IBCF in Network A is connected to the IBCF in Network B via the 'Ici' reference point. The TrGW in Network A is connected to the TrGW in Network B via the 'Izi' reference point. Various other reference points like 'Mx', 'Ix', and 'Lx' are shown between internal entities. A legend at the bottom left indicates that dashed lines represent 'Signalling' and solid lines represent 'Bearer'.](421fc75480c21e7ebb25756826652367_img.jpg) + +Figure 5.1.1: Inter-IMS Network to Network Interface between two IM CN subsystem networks. The diagram shows two networks, 'IM CN subsystem network A' and 'IM CN subsystem network B', separated by a vertical dashed line labeled 'II-NNI'. Network A contains functional entities: P-CSCF, S-CSCF, I-CSCF, BGCF, IBCF, ATCF, MSC Server enhanced for ICS, SRVCC or dual radio, TrGW, TRF, TF, and AS. Network B contains the same entities. The IBCF in Network A is connected to the IBCF in Network B via the 'Ici' reference point. The TrGW in Network A is connected to the TrGW in Network B via the 'Izi' reference point. Various other reference points like 'Mx', 'Ix', and 'Lx' are shown between internal entities. A legend at the bottom left indicates that dashed lines represent 'Signalling' and solid lines represent 'Bearer'. + +NOTE: The TRF can reside in a stand-alone entity or can be combined with another functional entity. + +**Figure 5.1.1: Inter-IMS Network to Network Interface between two IM CN subsystem networks** + +The protocols over the two reference points Ici and Izi make up the Inter-IMS Network to Network Interface. + +The Ici reference point allows IBCFs to communicate with each other in order to provide the communication and forwarding of SIP signalling messaging between IM CN subsystem networks. The Izi reference point allows TrGWs to forward media streams between IM CN subsystem networks. + +IMS roaming performed by using II-NNI is considered, when the IBCFs are inserted at the network borders. The applicability of roaming scenario by using II-NNI is based on agreement between the operators. + +Whenever the Inter-IMS Network to Network Interface is used to interconnect two IM CN subsystem networks belonging to different security domains, security procedures apply as described in 3GPP TS 33.210 [10]. + +When an IMS transit network is providing application services and interconnecting two IM CN subsystem networks, as described in 3GPP TS 23.228 [4], interfaces on both sides of the IMS transit network are within the scope of this document. + +When two IM CN subsystem networks are interconnected for IMS emergency session establishment as described in 3GPP TS 23.167 [215], the interface between these IM CN subsystem networks is within the scope of this document. + +**NOTE:** Implementations of functional entities at the IMS network edge might include functions that are not described in this Release of the specification, for example fault management that sends SIP OPTIONS requests between the two IBCFs over the Ici. IBCF originated SIP OPTIONS standalone transactions and any other features not described in the main body of this specification are out of scope. + +## 5.2 Functionalities performed by entities at the edge of the network + +### 5.2.1 Interconnection Border Control Function (IBCF) + +An IBCF provides application specific functions at the SIP/SDP protocol layer in order to perform interconnection between IM CN subsystem networks by using Ici reference point. According to 3GPP TS 23.228 [4], IBCF can act both as an entry point and as an exit point for the IM CN subsystem network. + +The functionalities of IBCF are indicated in the 3GPP TS 23.228 [4] and specified in 3GPP TS 24.229 [5]. They include: + +- network topology hiding; +- application level gateway (for instance enabling communication between IPv6 and IPv4 SIP applications, or between a SIP application in a private IP address space and a SIP application outside this address space); +- controlling transport plane functions; +- controlling media plane adaptations; +- screening of SIP signalling information; +- selecting the appropriate signalling interconnect; +- generation of charging data records; +- privacy protection; +- additional routing functionality; and +- inclusion of a transit IOI in requests when acting as an entry point for a transit network and in responses when acting as an exit point for a transit network. + +Based on local configuration, the IBCF performs transit routing functions as specified in 3GPP TS 24.229 [5] clause I.2. + +The IBCF acts as a B2BUA when it performs IMS-ALG functionality. + +### 5.2.2 Transition Gateway (TrGW) + +According to 3GPP TS 23.002 [3], the TrGW is located at the network borders within the media path and is controlled by an IBCF. Forwarding of media streams between IM CN subsystem networks is applied over Izi reference point. + +The TrGW provides functions like network address/port translation and IPv4/IPv6 protocol translation. NAT-PT binds addresses in IPv6 network with addresses in IPv4 network and vice versa to provide transparent routing between the two IP domains without requiring any changes to end points. NA(P)T-PT provides additional translation of transport identifier (TCP and UDP port numbers). The approach is similar to that one described also in 3GPP TS 29.162 [8]. + +Further details are described in 3GPP TS 23.228 [4]. + +## 5.3 Identifying II-NNI traversal scenario + +### 5.3.1 General + +The procedures for identifying the II-NNI traversal scenario using the "iotl" SIP URI parameter defined in IETF RFC 7549 [188] is specified in 3GPP TS 24.229 [5]. + +This specification uses the following II-NNI traversal scenarios when describing requirements at II-NNI: + +- the non-roaming II-NNI traversal scenario; +- the roaming II-NNI traversal scenario; and +- the loopback II-NNI traversal scenario. + +When a requirement at II-NNI is dependent on direction the roaming II-NNI traversal scenario is further divided into: + +- the home-to-visited II-NNI traversal scenario; and +- the visited-to-home II-NNI traversal scenario. + +See figure 4.2 and figure 4.3 for information on how the II-NNI traversal scenarios above are applied between networks. + +### 5.3.2 Mapping of the "iotl" SIP URI parameter to II-NNI traversal scenario + +Table 5.3.2.1 describes how the "iotl" SIP URI parameter shall be used to identify the II-NNI traversal scenario. The table 5.3.2.1 contains the following items: + +- the first column, named "II-NNI traversal scenario", shows the II-NNI traversal scenarios within the scope of this specification; and +- the second column, named "Value of the "iotl" parameter", shows the value of the "iotl" SIP URI parameter as specified in IETF RFC 7549 [188]. + +**Table 5.3.2.1: Mapping of the "iotl" SIP URI parameter to II-NNI traversal scenario** + +| II-NNI traversal scenario | Value of the "iotl" parameter | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------| +| Non-roaming II-NNI traversal scenario (NOTE 1) | "homeA-homeB" or "visitedA-homeB" | +| Loopback traversal scenario | "homeA-visitedA" | +| Roaming II-NNI traversal scenario | "visitedA-homeA" or "homeB-visitedB" (NOTE 2) | +| Home-to-visited traversal scenario | "homeB-visitedB" | +| Visited-to-home traversal scenario | "visitedA-homeA" | +| NOTE 1: This is the default II-NNI traversal scenario, if the "iotl" SIP URI parameter is not present in the Request-URI or in any of the Route header fields in the SIP request and if an implementation dependent method of identifying the II-NNI traversal scenario is not used. | | +| NOTE 2: When the requirement at II-NNI is independent on direction any of the "visitedA-homeA" or "homeB-visitedB" can be used to identify the roaming II-NNI traversal scenario. | | + +# 6 Control plane interconnection + +## 6.1 Definition of Inter-IMS Network to Network Interconnection + +### 6.1.1 SIP methods and header fields + +#### 6.1.1.1 General + +The functional entity closest to the border of an II-NNI (see reference model in clause 5) shall provide the capabilities specified for that network element in clause A.2 of 3GPP TS 24.229 [5] with modifications as described in the following clauses. + +#### 6.1.1.2 SIP methods + +3GPP TS 24.229 [5] defines the methods allowing an IBCF to interconnect to an IBCF placed in another IM CN subsystem. + +The following SIP methods are supported on the II-NNI as defined in table 6.1. + +The following table is based on table A.5 and table A.163 of 3GPP TS 24.229 [5] and endorsed for this document: + +**Table 6.1: Supported SIP methods** + +| Item | Method | Ref. | II-NNI | | +|-------|---------------------------------------------------------------------------------|--------------------|---------|-----------| +| | | | Sending | Receiving | +| 1 | ACK request | IETF RFC 3261 [13] | m | m | +| 2 | BYE request | IETF RFC 3261 [13] | m | m | +| 3 | BYE response | IETF RFC 3261 [13] | m | m | +| 4 | CANCEL request | IETF RFC 3261 [13] | m | m | +| 5 | CANCEL response | IETF RFC 3261 [13] | m | m | +| 5A | INFO request | IETF RFC 6086 [39] | o | o | +| 5B | INFO response | IETF RFC 6086 [39] | o | o | +| 8 | INVITE request | IETF RFC 3261 [13] | m | m | +| 9 | INVITE response | IETF RFC 3261 [13] | m | m | +| 9A | MESSAGE request | IETF RFC 3428 [19] | o | o | +| 9B | MESSAGE response | IETF RFC 3428 [19] | o | o | +| 10 | NOTIFY request | IETF RFC 6665 [20] | c1 | c1 | +| 11 | NOTIFY response | IETF RFC 6665 [20] | c1 | c1 | +| 12 | OPTIONS request | IETF RFC 3261 [13] | m | m | +| 13 | OPTIONS response | IETF RFC 3261 [13] | m | m | +| 14 | PRACK request | IETF RFC 3262 [18] | m | m | +| 15 | PRACK response | IETF RFC 3262 [18] | m | m | +| 15A | PUBLISH request | IETF RFC 3903 [21] | c1 | c1 | +| 15B | PUBLISH response | IETF RFC 3903 [21] | c1 | c1 | +| 16 | REFER request | IETF RFC 3515 [22] | o | o | +| 17 | REFER response | IETF RFC 3515 [22] | o | o | +| 18 | REGISTER request | IETF RFC 3261 [13] | c2 | c2 | +| 19 | REGISTER response | IETF RFC 3261 [13] | c2 | c2 | +| 20 | SUBSCRIBE request | IETF RFC 6665 [20] | c1 | c1 | +| 21 | SUBSCRIBE response | IETF RFC 6665 [20] | c1 | c1 | +| 22 | UPDATE request | IETF RFC 3311 [23] | m | m | +| 23 | UPDATE response | IETF RFC 3311 [23] | m | m | +| c1: | In case of roaming II-NNI, the support of the method is m, else o. | | | | +| c2: | In case of roaming II-NNI, the support of the method is m, else n/a. | | | | +| NOTE: | In the above table, m, o and c and n/a have the meanings indicated in table 6.3 | | | | + +#### 6.1.1.3 SIP header fields + +##### 6.1.1.3.0 General + +The IBCF shall provide the capabilities to manage and modify SIP header fields according to clause 5.10 and annex A of 3GPP TS 24.229 [5] with modifications as described in the following clauses. + +##### 6.1.1.3.1 Trust and no trust relationship + +The IBCF acting as exit point applies the procedures described in clause 5.10.2 of 3GPP TS 24.229 [5] before forwarding the SIP signalling to the IBCF acting as entry point. The IBCF acting as entry point applies the procedures described in clause 5.10.3 of 3GPP TS 24.229 [5]. + +Additionally, in case there is no trust relationship between the two IM CN subsystems connected by II-NNI, the IBCF applies the procedures described in clause 4.4 of 3GPP TS 24.229 [5], before forwarding the SIP signalling. + +These procedures may be utilized on a per header field basis to realize overall trust as well as per service level screening of header fields. Trust relationships and trust domains may be defined by inter-operator agreements for individual services and/or individual SIP header fields. + +The management of the SIP header fields (if present) over II-NNI in case of a presence or not of a trust relationship between the two interconnected IM CN subsystems is wrapped up in the following table. + +**Table 6.2: Management of SIP header fields and parameters over II-NNI in presence or not of a trust relationship** + +| Item | Header field or parameter | Reference | Trust relationship | Not trust relationship | +|------|----------------------------------------|-----------------------------------|---------------------------------------------------------|--------------------------------------------------------------------------------------| +| 1 | P-Asserted-Identity | IETF RFC 3325 [44] | As specified in 3GPP TS 24.229 [5], clause 4.4 | As specified in 3GPP TS 24.229 [5], clause 4.4 | +| 2 | P-Access-Network-Info | IETF RFC 7315 [24] | As specified in 3GPP TS 24.229 [5], clause 4.4 | As specified in 3GPP TS 24.229 [5], clause 4.4 | +| 3 | Resource-Priority | IETF RFC 4412 [78] | As specified in 3GPP TS 24.229 [5], clause 4.4 | As specified in 3GPP TS 24.229 [5], clause 4.4 | +| 4 | History-Info | IETF RFC 7044 [25] | As specified in 3GPP TS 24.229 [5], clause 4.4 | As specified in clause 7 of IETF RFC 7044 [25] and in 3GPP TS 24.229 [5], clause 4.4 | +| 5 | P-Asserted-Service | IETF RFC 6050 [26] | As specified in 3GPP TS 24.229 [5], clause 4.4 (NOTE 3) | As specified in 3GPP TS 24.229 [5], clause 4.4 (NOTE 3) | +| 6 | P-Charging-Vector | IETF RFC 7315 [24] | As specified in 3GPP TS 24.229 [5], clause 5.10 | As specified in 3GPP TS 24.229 [5], clause 5.10 | +| 7 | P-Charging-Function-Addresses (NOTE 4) | IETF RFC 7315 [24] | As specified in 3GPP TS 24.229 [5], clause 5.10 | As specified in 3GPP TS 24.229 [5], clause 5.10 | +| 8 | P-Profile-Key (NOTE 2) | IETF RFC 5002 [64] | As specified in 3GPP TS 24.229 [5], clause 4.4 | As specified in 3GPP TS 24.229 [5], clause 4.4 | +| 9 | P-Private-Network-Indication | IETF RFC 7316 [84] | As specified in 3GPP TS 24.229 [5], clause 4.4 | As specified in 3GPP TS 24.229 [5], clause 4.4 | +| 10 | P-Served-User (NOTE 1, NOTE 2) | IETF RFC 5502 [85] | As specified in 3GPP TS 24.229 [5], clause 4.4 | As specified in 3GPP TS 24.229 [5], clause 4.4 | +| 11 | Reason (in a response) | IETF RFC 6432 [49] | As specified in 3GPP TS 24.229 [5], clause 4.4 | As specified in 3GPP TS 24.229 [5], clause 4.4 | +| 12 | P-Early-Media | IETF RFC 5009 [74] | As specified in 3GPP TS 24.229 [5], clause 4.4 | As specified in 3GPP TS 24.229 [5], clause 4.4 | +| 13 | Feature-Caps | IETF RFC 6809 [143] | As specified in 3GPP TS 24.229 [5], clause 4.4 | As specified in 3GPP TS 24.229 [5], clause 4.4 | +| 14 | Priority (NOTE 6) | IETF RFC 7090 [184] | As specified in 3GPP TS 24.229 [5], clause 4.4 | As specified in 3GPP TS 24.229 [5], clause 4.4 | +| 15 | "iotl" SIP URI parameter (NOTE 7) | IETF RFC 7549 [188] | As specified in 3GPP TS 24.229 [5], clause 4.4 | As specified in 3GPP TS 24.229 [5], clause 4.4 | +| 16 | "cpc" tel URI parameter (NOTE 5) | 3GPP TS 24.229 [5] clause 7.2A.12 | As specified in 3GPP TS 24.229 [5], clause 4.4 | As specified in 3GPP TS 24.229 [5], clause 4.4 | +| 17 | "oli" tel URI parameter (NOTE 5) | 3GPP TS 24.229 [5] clause 7.2A.12 | As specified in 3GPP TS 24.229 [5], clause 4.4 | As specified in 3GPP TS 24.229 [5], clause 4.4 | +| 18 | Restoration-Info (NOTE 2) | 3GPP TS 24.229 [5] clause 7.2.11 | As specified in 3GPP TS 24.229 [5], clause 4.4 | As specified in 3GPP TS 24.229 [5], clause 4.4 | +| 19 | Relayed-Charge (NOTE 4) | 3GPP TS 24.229 [5] clause 7.2.12 | As specified in 3GPP TS 24.229 [5], clause 4.4 | As specified in 3GPP TS 24.229 [5], clause 4.4 | +| 20 | Service-Interact-Info | 3GPP TS 24.229 [5] clause 7.2.14 | As specified in 3GPP TS 24.229 [5], clause 4.4 | As specified in 3GPP TS 24.229 [5], clause 4.4 | +| 21 | Cellular-Network-Info | 3GPP TS 24.229 [5] clause 7.2.15 | As specified in 3GPP TS 24.229 [5], clause 4.4 | As specified in 3GPP TS 24.229 [5], clause 4.4 | + +| | | | | | +|----|------------------------------|-------------------------------------|------------------------------------------------------|------------------------------------------------------| +| 22 | Response-Source | 3GPP TS 24.229 [5]
clause 7.2.17 | As specified in
3GPP TS 24.229 [5],
clause 4.4 | As specified in
3GPP TS 24.229 [5],
clause 4.4 | +| 23 | Attestation-Info
(NOTE 8) | 3GPP TS 24.229 [5]
clause 7.2.18 | As specified in
3GPP TS 24.229 [5],
clause 4.4 | As specified in
3GPP TS 24.229 [5],
clause 4.4 | +| 24 | Origination-Id
(NOTE 8) | 3GPP TS 24.229 [5]
clause 7.2.19 | As specified in
3GPP TS 24.229 [5],
clause 4.4 | As specified in
3GPP TS 24.229 [5],
clause 4.4 | +| 25 | Additional-Identity | 3GPP TS 24.229 [5]
clause 7.2.20 | As specified in
3GPP TS 24.229 [5],
clause 4.4 | As specified in
3GPP TS 24.229 [5],
clause 4.4 | + +NOTE 1: For a roaming II-NNI, a trust relationship with respect to this header field is required. +NOTE 2: This header field is only applicable on a roaming II-NNI. +NOTE 3: In addition, value-dependent operator policies may be applied. +NOTE 4: This header field is not applicable at II-NNI. +NOTE 5: The tel URI parameters "cpc" and "oli" can be included in the URI in the P-Asserted-Identity header field. +NOTE 6: Only the "psap-callback" value is part of the trust domain. +NOTE 7: The "iotl" SIP URI parameter can be transported in the Request-URI, Route header field, Path header field, Service-Route header field, "+g.3gpp.trf" header field parameter, "+g.3gpp.atcf-mgmt-uri" header field parameter and in the "ATU-STI" parameter in the "application/vnd.3gpp.srvcc-info+xml" MIME body. +NOTE 8: This header field is only applicable on non-roaming II-NNI. + +##### 6.1.1.3.2 Derivation of applicable SIP header fields from 3GPP TS 24.229 [5] + +For any method in table 6.1, the SIP header fields applicable on the II-NNI are detailed in the corresponding method tables for the UA role and proxy role sending behaviour in annex A of 3GPP TS 24.229 [5]. Unless other information is specified in the normative part of the present specification, the applicability of header fields at the II-NNI can be derived for each method from the corresponding tables in annex A of 3GPP TS 24.229 [5] as follows: + +- All header fields not present in the corresponding tables in annex A of 3GPP TS 24.229 [5] or marked as "n/a" in both the "RFC status" and "profile status" columns for the UA role and proxy role sending behaviour of that tables are not applicable at the II-NNI. + +NOTE 1: Operators could choose to apply header fields for other SIP extensions on an II-NNI based on bilateral agreements, but this is outside the scope of the present specification. + +- All header fields which are marked as "o" in at least one of the "RFC status" or the "profile status" profile columns for the sending behaviour in the corresponding UA role and proxy role tables in annex A of 3GPP TS 24.229 [5] and as "n/a" or "o" in the other such columns are applicable at II-NNI based on bilateral agreement between operators. +- All header fields which are marked as "m" in at least one of the "RFC status" or the "profile status" columns for the sending behaviour in the corresponding UA role or proxy role table in annex A of 3GPP TS 24.229 [5] and as "n/a", "o", or "m" in the other such columns are applicable at the II-NNI. +- If conditions are specified, they are also applicable at the II-NNI and the above rules are applicable to the "n/a", "o" and "m" values within the conditions. + +NOTE 2: In the above rules, the RFC profile columns are taken into account in order to enable interworking with non-3GPP networks. + +An informative summary of SIP header fields to be used over the II-NNI is proposed in annex A. + +##### 6.1.1.3.3 Applicability of SIP header fields on a roaming II-NNI + +The following SIP header fields are applicable on a roaming II-NNI but not on a non-roaming II-NNI: + +- Authentication-Info +- Authorization +- P-Associated-URI +- P-Called-Party-ID + +- P-Preferred-Service +- P-Profile-Key +- P-Served-User +- P-Visited-Network-ID +- Path +- Priority-Share +- Proxy-Authenticate +- Proxy-Authorization +- Resource-Share +- Restoration-Info +- Service-Route +- WWW-Authenticate + +##### 6.1.1.3.4 Applicability of SIP header fields on a non-roaming II-NNI + +The following SIP header fields are only applicable on a non-roaming II-NNI: + +- P-Refused-URI-List; +- Identity; +- Attestation-Info; and +- Origination-Id. + +#### 6.1.1.4 Notations of the codes + +In the table 6.1 the status codes "m", "o", "c" and "n/a" have the following meanings: + +**Table 6.3: Key to notation codes for SIP messages** + +| Notation code | Notation name | Sending side | Receiving side | +|----------------|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| m | mandatory | The message shall be supported at II-NNI.
Supporting sending a SIP message at the II-NNI means that this message shall be sent over the II-NNI if received from the serving network. It does not imply that network elements inside the serving network or user equipment connected to this network shall support this message. | Supporting receiving a SIP message at the II-NNI means that this message shall be forwarded to the serving network unless the operator's policy is applied as defined in clause 5.10.1 of 3GPP TS 24.229 [5]. It does not imply that network elements inside the serving network or user equipment connected to this network are supporting this message. | +| o | optional | The message may or may not be supported at II-NNI. The support of the message is provided based on bilateral agreement between the operators. | Same as for sending side. | +| n/a | not applicable | It is impossible to use/support the message. | It is impossible to use/support the message. This message will be discarded by the IBCF. | +| c
| conditional | The requirement on the message ("m", "o" or "n/a") depends on the support of other optional or conditional items.
is the identifier of the conditional expression. | Same as for sending side. | + +#### 6.1.1.5 Modes of signalling + +Overlap signalling may be used if agreement exists between operators to use overlap and which method to be used, otherwise enbloc shall be used at the II-NNI. + +### 6.1.2 SDP protocol + +#### 6.1.2.1 General + +The functional entity closest to the border of an II-NNI (see reference model in clause 5) shall provide the capabilities specified for that network element in clause A.3 of 3GPP TS 24.229 [5]. + +The "application/sdp" MIME bodies shall be encoded as described in IETF RFC 3261 [13] and in IETF RFC 4566 [147]. + +The offer/answer model with the SDP as defined in IETF RFC 3264 [146] shall be applied. + +The procedures and the SDP rules as defined in IETF RFC 4145 [162] may be applied if media streams with TCP is used. + +### 6.1.3 Major capabilities + +This clause contains the major capabilities to be supported over the II-NNI. + +The table 6.1.3.1 specifies which capabilities are applicable for II-NNI. The profile status codes within table 6.1.3.1 are defined in table 6.1.3.2. + +For the "Basic SIP" capabilities part of table 6.1.3.1, the last column "Profile status over II-NNI" specifies the general status of applicability of the IETF RFC 3261 [13] main mechanisms described in the 2nd column "Capability over the Ici". + +For the "Extensions to basic SIP" capabilities part, the last column "Profile status over II-NNI" specifies the general status of applicability of the RFC referenced in the 2nd column "Capability over the Ici". + +If necessary, the applicability of RFCs at the II-NNI level is further detailed in the present Technical Specification. + +The columns "Reference item in 3GPP TS 24.229 [5] for the profile status" provide informative references for comparison purposes into the UA and Proxy role major capabilities tables in 3GPP TS 24.229 [5], where the capabilities are defined via additional references. + +**Table 6.1.3.1: Major capabilities over II-NNI** + +| Item | Capability over the Ici | Reference item in
3GPP TS 24.229 [5] for
the profile status
| Profile
status over
II-NNI
| +|-------------|--------------------------------|----------------------------------------------------------------------------|-------------------------------------------| +|-------------|--------------------------------|----------------------------------------------------------------------------|-------------------------------------------| + +| | | UA Role
(NOTE 1) | Proxy role
(NOTE 2) | | +|-----|------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------|--------------------------------------------|-----| +| | Basic SIP (IETF RFC 3261 [13]) | | | | +| 1 | registrations | 1, 2, 2A | - | c2 | +| 2 | initiating a session | 2B, 3, 4 | - | m | +| 3 | terminating a session | 5 | 3 | m | +| 4 | General proxy behaviour | - | 4, 5, 14, 15 | n/a | +| 5 | Managing several responses due to forking | 9,10 | 6 | m | +| 6 | support of indication of TLS connections in the Record-Route header | - | 7, 8 | n/a | +| 7 | Support of authentication | 7, 8, 8A | 8A | c2 | +| 8 | Timestamped requests (Timestamp header field) | 6 | - | m | +| 9 | Presence of date in requests and responses (Date header field) | 11 | 9 | m | +| 10 | Presence of alerting information data (Alert-info header field) | 12 | 10 | o | +| 11 | Support and handling of the Require header field for REGISTER and other requests or responses for methods other than REGISTER | - | 11, 12, 13 | m | +| 12 | Support and reading of the Supported and Unsupported header fields | - | 16, 17, 18 | m | +| 13 | Support of the Error-Info header field in 3xx - 6xx responses | - | 19 | o | +| 14 | Support and handling of the Organization header field | - | 19A, 19B | m | +| 15 | Support and handling of the Call-Info header field | - | 19C, 19D | m | +| 16 | Support of the Contact header field in 3xx response | - | 19E | m | +| 16A | Proxy reading the contents of a body or including a body in a request or response | - | 19F | n/a | +| | Extensions to basic SIP | | | | +| 16B | 3GPP TS 24.237 [131]: proxy modifying the content of a body | - | 19G | n/a | +| 17 | IETF RFC 6086 [39]: SIP INFO method and package framework | 13 | 20 | o | +| 17A | IETF RFC 6086 [39]: legacy INFO usage | 13A | 20A | o | +| 18 | IETF RFC 3262 [18]: reliability of provisional responses in SIP (PRACK method) | 14 | 21 | m | +| 19 | IETF RFC 3515 [22]: the SIP REFER method | 15 | 22 | o | +| 19A | IETF RFC 7647 [194]: Clarifications for the Use of REFER with RFC6665 | 15A | 22A | n/a | +| 19B | IETF RFC 7614 [195]: Explicit Subscriptions for the REFER Method | 15B | 22B | o | +| 20 | IETF RFC 3312 [40] and IETF RFC 4032 [41]: integration of resource management and SIP (Preconditions framework) | 2C, 16 | 23 | o | +| 21 | IETF RFC 3311 [23]: the SIP UPDATE method | 17 | 24 | m | +| 22 | IETF RFC 3313 [42]: SIP extensions for media authorization (P-Media-Authorization header field) | 19 | 26 | n/a | +| 23 | IETF RFC 6665 [20]: SIP specific event notification (SUBSCRIBE/NOTIFY methods) | 20, 22, 23 | 27 | c1 | +| 23A | IETF RFC 7621 [196]: A Clarification on the Use of Globally Routable User Agent URIs (GRUUs) in the Session Initiation Protocol SIP Event Notification Framework | 22A | 28 | n/a | +| 24 | IETF RFC 3327 [43]: session initiation protocol extension header field for registering non-adjacent contacts (Path header field) | 24 | 29 | c2 | +| 25 | IETF RFC 3325 [44]: private extensions to the Session Initiation Protocol (SIP) for network asserted identity within trusted networks | 25 | 30 | c4 | +| 26 | IETF RFC 3325 [44]: the P-Preferred-Identity header field extension | - | - | n/a | +| 27 | IETF RFC 3325 [44]: the P-Asserted-Identity header field extension | - | - | c4 | +| 28 | IETF RFC 3323 [34], IETF RFC 3325 [44] and IETF RFC 7044 [25]: a privacy mechanism for the Session Initiation Protocol (SIP) (Privacy header field) | 26, 26A, 26B, 26C, 26D, 26E, 26F, 26G, 26H | 31, 31A, 31B, 31C, 31D, 31E, 31F, 31G, 31H | m | +| 29 | IETF RFC 3428 [19]: a messaging mechanism for the Session Initiation Protocol (SIP) (MESSAGE method) | 27 | 33 | o | + +| | | | | | +|-----|-----------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------|----------------------------------|-----| +| 30 | IETF RFC 3608 [45]: session initiation protocol extension header field for service route discovery during registration (Service-Route header field) | 28 | 32 | c2 | +| 31 | IETF RFC 3486 [46]: compressing the session initiation protocol | 29 | 34 | n/a | +| 32 | IETF RFC 7315 [24]: private header extensions to the session initiation protocol for the 3 rd -Generation Partnership Project (3GPP) | 30 | 35 | o | +| 32A | IETF RFC 3325 [44]: act as first entity within the trust domain for asserted identity | 30A | 30A | n/a | +| 32B | IETF RFC 3325 [44]: act as entity within trust network that can route outside the trust network | 30B | 30B | n/a | +| 32C | IETF RFC 3325 [44]: act as entity passing on identity transparently independent of trust domain | 30C | 30C | n/a | +| 33 | IETF RFC 7315 [24] and IETF RFC 7976 [24A]: the P-Associated-URI header field extension | 31 | 36 | c2 | +| 34 | IETF RFC 7315 [24] and IETF RFC 7976 [24A]: the P-Called-Party-ID header field extension | 32 | 37 | c2 | +| 35 | IETF RFC 7315 [24] and IETF RFC 7976 [24A]: the P-Visited-Network-ID header field extension | 33 | 38, 39 | c2 | +| 36 | IETF RFC 7315 [24], IETF RFC 7976 [24A] and IETF RFC 7913 [24B]: the P-Access-Network-Info header field extension | 34 | 41, 42, 43 | c4 | +| 37 | IETF RFC 7315 [24] and IETF RFC 7976 [24A]: the P-Charging-Function-Addresses header field extension | 35 | 44, 44A | n/a | +| 38 | IETF RFC 7315 [24] and IETF RFC 7976 [24A]: the P-Charging-Vector header field extension | 36 | 45, 46 | c1 | +| 39 | IETF RFC 3329 [47]: security mechanism agreement for the session initiation protocol | 37 | 47 | n/a | +| 39A | 3GPP TS 24.229 [5] clause 7.2.A.7: Capability Exchange for Media Plane Security | 37A | 47A | n/a | +| 40 | IETF RFC 3326 [48]: the Reason header field for the session initiation protocol | 38 | 48 | o | +| 41 | IETF RFC 6432 [49]: carrying Q.850 codes in reason header fields in SIP (Session Initiation Protocol) responses | 38A | 48A | c4 | +| 41A | IETF RFC 8606 [214]: the Location Parameter for the SIP Reason Header Field | 38B | 48B | o | +| 42 | IETF RFC 3581 [50]: an extension to the session initiation protocol for symmetric response routing | 39 | 49 | o | +| 43 | IETF RFC 3841 [51]: caller preferences for the session initiation protocol (Accept-Contact, Reject-Contact and Request-Disposition header fields) | 40, 40A, 40B, 40C, 40D, 40E, 40F | 50, 50A, 50B, 50C, 50D, 50E, 50F | m | +| 44 | IETF RFC 3903 [21]: an event state publication extension to the session initiation protocol (PUBLISH method) | 41 | 51 | c1 | +| 45 | IETF RFC 4028 [52]: SIP session timer (Session-Expires and Min-SE headers) | 42 | 52 | m | +| 46 | IETF RFC 3892 [53]: the SIP Referred-By mechanism | 43 | 53 | m | +| 47 | IETF RFC 3891 [54]: the Session Initiation Protocol (SIP) "Replaces" header | 44 | 54 | o | +| 48 | IETF RFC 3911 [55]: the Session Initiation Protocol (SIP) "Join" header | 45 | 55 | o | +| 49 | IETF RFC 3840 [56]: the callee capabilities | 46 | 56 | o | +| 50 | IETF RFC 7044 [25]: an extension to the session initiation protocol for request history information (History-Info header field) | 47 | 57 | o | +| 50A | IETF RFC 7044 [25]: the "mp" header field parameter | 47A | 57A | o | +| 50B | IETF RFC 7044 [25]: the "rc" header field parameter | 47B | 57B | o | +| 50C | IETF RFC 7044 [25]: the "np" header field parameter | 47C | 57C | o | +| 51 | IETF RFC 5079 [57]: Rejecting anonymous requests in the session initiation protocol | 48 | 58 | o | +| 52 | IETF RFC 4458 [58]: session initiation protocol URIs for applications such as voicemail and interactive voice response (NOTE 3) | 49 | 59 | o | +| 52A | IETF RFC 8119 [193]: Session Initiation Protocol (SIP) Cause URI parameter for Service Number translation | 49A | 59A | o | +| 53 | IETF RFC 4320 [59]: Session Initiation Protocol's (SIP) non- | 50 | 61 | m | + +| | | | | | +|--|---------------------|--|--|--| +| | INVITE transactions | | | | +|--|---------------------|--|--|--| + +| | | | | | +|-----|----------------------------------------------------------------------------------------------------------------------------------------------------|--------------|--------------|-------------------| +| 54 | IETF RFC 4457 [60]: the P-User-Database private header field extension | 51 | 60 | n/a | +| 55 | IETF RFC 5031 [61]: A Uniform Resource Name (URN) for Emergency and Other Well-Known Services | 52 | 62 | c7 | +| 56 | IETF RFC 5627 [62]: obtaining and using GRUUs in the Session Initiation Protocol (SIP) | 53 | 63 | c1 | +| 57 | Void | | | | +| 58 | IETF RFC 4168 [27]: the Stream Control Transmission Protocol (SCTP) as a Transport for the Session Initiation Protocol (SIP) | 55 | 65 | o | +| 59 | IETF RFC 5002 [64]: the SIP P-Profile-Key private header field extension | 56 | 66, 66A, 66B | c3 | +| 60 | IETF RFC 5626 [65]: managing client initiated connections in SIP | 57 | 67 | c1 | +| 61 | IETF RFC 5768 [66]: indicating support for interactive connectivity establishment in SIP | 58 | 68 | n/a | +| 62 | IETF RFC 5365 [67]: multiple-recipient MESSAGE requests in the session initiation protocol | 59 | 69 | o if 29, else n/a | +| 63 | IETF RFC 6442 [68]: Location conveyance for the Session Initiation Protocol | 60 | 70, 70A, 70B | m | +| 64 | IETF RFC 5368 [69]: referring to multiple resources in the session initiation protocol | 61 | 71 | o if 19, else n/a | +| 65 | IETF RFC 5366 [70]: conference establishment using request-contained lists in the session initiation protocol | 62 | 72 | o | +| 66 | IETF RFC 5367 [71]: subscriptions to request-contained resource lists in the session initiation protocol | 63 | 73 | o if 23, else n/a | +| 67 | IETF RFC 4967 [72]: dialstring parameter for the session initiation protocol uniform resource identifier | 64 | 74 | c2 | +| 68 | IETF RFC 4964 [73]: the P-Answer-State header extension to the session initiation protocol for the open mobile alliance push to talk over cellular | 65 | 75 | o | +| 69 | IETF RFC 5009 [74]: the SIP P-Early-Media private header field extension for authorization of early media | 66 | 76 | c4 | +| 70 | IETF RFC 4694 [75]: number portability parameters for the 'tel' URI | 67, 67A, 67B | 77, 77A, 77B | o | +| 71 | Void | | | | +| 72 | IETF RFC 4411 [77]: extending the session initiation protocol Reason header for preemption events | 69 | 79 | o | +| 73 | IETF RFC 4412 [78]: communications resource priority for the session initiation protocol (Resource-Priority header field) | 70, 70A, 70B | 80, 80A, 80B | o | +| 74 | IETF RFC 5393 [79]: addressing an amplification vulnerability in session initiation protocol forking proxies | 71 | 81 | m | +| 75 | IETF RFC 5049 [80]: the remote application identification of applying signalling compression to SIP | 72 | 82 | n/a | +| 76 | IETF RFC 5688 [81]: a session initiation protocol media feature tag for MIME application sub-types | 73 | 83 | c1 | +| 77 | IETF RFC 6050 [26]: Identification of communication services in the session initiation protocol | 74 | 84, 84A | o | +| 78 | IETF RFC 5360 [82]: a framework for consent-based communications in SIP | 75, 75A, 75B | 85 | o | +| 79 | IETF RFC 7433 [83]: a mechanism for transporting user-to-user call control information in SIP | 76 | 86 | c1 | +| 79A | IETF RFC 7434 [83A]: interworking ISDN call control user information with SIP | 76A | - | c1 | +| 80 | IETF RFC 7316 [84]: The SIP P-Private-Network-Indication private header (P-Header) | 77 | 87 | c1 | +| 81 | IETF RFC 5502 [85]: the SIP P-Served-User private header | 78 | 88 | c2 | +| 82 | IETF 8498 [203]: the SIP P-Served-User header extension for Originating CDIV session case | 79 | 89 | n/a | +| 83 | IETF RFC 8497 [87]: marking SIP messages to be logged | 80 | 90 | o | +| 84 | IETF RFC 6228 [88]: the 199 (Early Dialog Terminated) response code | 81 | 91 | m | +| 85 | IETF RFC 5621 [89]: message body handling in SIP | 82 | 92 | m | +| 86 | IETF RFC 6223 [90]: indication of support for keep-alive | 83 | 93 | o | +| 87 | IETF RFC 5552 [91]: SIP Interface to VoiceXML Media Services | 84 | 94 | n/a | +| 88 | IETF RFC 3862 [92]: common presence and instant | 85 | 95 | o | + +| | | | | | +|--|----------------------------------|--|--|--| +| | messaging (CPIM): message format | | | | +|--|----------------------------------|--|--|--| + +| | | | | | +|------|------------------------------------------------------------------------------------------------------------------------------------------|------|---------|-------------------| +| 89 | IETF RFC 5438 [93]: instant message disposition notification | 86 | 96 | o | +| 90 | IETF RFC 5373 [94]: requesting answering modes for SIP (Answer-Mode and Priv-Answer-Mode header fields) | 87 | 97, 97A | o | +| 91 | Void | | | | +| 92 | IETF RFC 3959 [96]: the early session disposition type for SIP | 89 | 99 | o | +| 93 | Void | | | | +| 94 | IETF RFC 7989 [124]: End-to-End Session Identification in IP-Based Multimedia Communication Networks | 91 | 101 | o | +| 95 | IETF RFC 6026 [125]: correct transaction handling for 200 responses to Session Initiation Protocol INVITE requests | 92 | 102 | m | +| 96 | IETF RFC 5658 [126]: addressing Record-Route issues in the Session Initiation Protocol (SIP) | 93 | 103 | o | +| 97 | IETF RFC 5954 [127]: essential correction for IPv6 ABNF and URI comparison in IETF RFC 3261 [13] | 94 | 104 | m | +| 98 | IETF RFC 4488 [135]: suppression of session initiation protocol REFER method implicit subscription | 95 | 105 | m if 19, else n/a | +| 99 | IETF RFC 7462 [136]: Alert-Info URNs for the Session Initiation Protocol | 96 | 106 | o | +| 100 | 3GPP TS 24.229 [5] clause 3.1: multiple registrations | 97 | 107 | c2 | +| 101 | IETF RFC 5318 [141]: the SIP P-Refused-URI-List private-header | 98 | 108 | c5 | +| 102 | IETF RFC 4538 [140]: request authorization through dialog identification in the session initiation protocol (Target-Dialog header field) | 99 | 109 | o | +| 103 | IETF RFC 6809 [143]: Mechanism to indicate support of features and capabilities in the Session Initiation Protocol (SIP) | 100 | 110 | o | +| 104 | IETF RFC 6140 [160]: registration of bulk number contacts | 101 | 111 | c3 | +| 105 | IETF RFC 6230 [161]: media control channel framework | 102 | 112 | o | +| 105A | 3GPP TS 24.229 [5] clause 4.14: S-CSCF restoration procedures | 103 | 113 | c3 | +| 106 | IETF RFC 6357 [164]: SIP overload control | 104 | 114 | o | +| 107 | IETF RFC 7339 [165]: feedback control | 104A | 114A | o | +| 108 | IETF RFC 7200 [167]: distribution of load filters | 104B | 114B | o | +| 109 | 3GPP TS 24.229 [5] clauses 5.1.2A.1.1, 5.1.3.1, 5.1.6.8, and 5.2.10: Handling of a 380 (Alternative service) response | 105 | 115 | n/a | +| 110 | IETF RFC 7090 [184]: Public Safety Answering Point (PSAP) Callback | 107 | 117 | o | +| 111 | IETF RFC 8055 [185]: Via header field parameter to indicate received realm | 106 | 116 | n/a | +| 112 | IETF RFC 7549 [188]: SIP URI parameter to indicate traffic leg | 108 | 118 | o
(NOTE 4) | +| 113 | 3GPP TS 24.229 [5] clause 4.14: PCF or PCRF based P-CSCF restoration | 109 | 119 | c3 | +| 114 | 3GPP TS 24.229 [5] clause 4.14: UDM/HSS or HSS based P-CSCF restoration | 110 | 120 | c3 | +| 115 | 3GPP TS 24.229 [5] clause 7.2.12: the Relayed-Charge header extension | 111 | 121 | n/a | +| 116 | 3GPP TS 24.229 [5]: resource sharing | 112 | 122 | c3 | +| 117 | 3GPP TS 24.229 [5] clause 7.2.15: the Cellular-Network-Info header extension | 113 | 123 | c4 | +| 118 | 3GPP TS 24.229 [5] clause 7.2.16: the Priority-Share header field | 114 | 124 | c3 | +| 119 | IETF RFC 8224 [206]: Authenticated Identity Management in the Session Initiation Protocol (SIP) | 116 | 126 | c5 | +| 120 | IETF RFC 8197 [207]: A SIP Response Code for Unwanted Calls | 117 | 127 | o | +| 121 | 3GPP TS 24.229 [5] clause 7.2.17: the Response-Source header extension | 115 | 125 | c6 | +| 121A | 3GPP TS 24.229 [5]: the 3GPP PS data off extension | 118 | - | c3 | +| 121B | 3GPP TS 24.229 [5]: Next-Generation Pan-European eCall emergency service | 120 | - | c8 | +| 122 | IETF RFC 8262 [216]: Content-ID Header Field in the Session Initiation Protocol (SIP) | 119 | - | o | +| 123 | 3GPP TS 24.229 [5] clause 7.2.18: the Attestation-Info header field | 121 | 128 | c5 | + +| | | | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------|-----|-----|----| +| 124 | 3GPP TS 24.229 [5] clause 7.2.19: the Origination-Id | 122 | 129 | c5 | +| 125 | 3GPP TS 24.229 [5] clause 4.18: Dynamic services interactions | 123 | 130 | c6 | +| 126 | 3GPP TS 24.229 [5] clause 7.2.20: the Additional-Identity | 124 | 131 | c6 | +| 127 | 3GPP TS 24.229 [5] clause 4.19: RLOS | 125 | 132 | c3 | +| c1: m in case of roaming II-NNI, else o
c2: m in case of roaming II-NNI, else n/a
c3: o in case of roaming II-NNI, else n/a
c4: m in case of trust relationship between the interconnected networks, else n/a
c5: o in case of non-roaming II-NNI and loopback traversal scenario, else n/a
c6: o in case of trust relationship between the interconnected networks, else n/a
c7: m in case of IMS emergency session traversal scenario on non-roaming II-NNI, else n/a
c8: o in case of IMS emergency session traversal scenario on non-roaming II-NNI, else n/a | | | | | +| NOTE 1: The item numbering corresponds to the one provided in table A.4 in 3GPP TS 24.229 [5]. | | | | | +| NOTE 2: The item numbering corresponds to the one provided in table A.162 in 3GPP TS 24.229 [5]. | | | | | +| NOTE 3: A common URI namespace is required to apply this feature on the II-NNI. | | | | | +| NOTE 4: For the roaming II-NNI the support of this major capability is recommended. | | | | | + +**Table 6.1.3.2: Key to notation codes for major capabilities** + +| Notation code | Notation name | Explanation | +|----------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| m | mandatory | The capability shall be supported at II-NNI.
SIP message relating to this capability shall be sent over the II-NNI if received from the serving network, unless they also make use of other unsupported capabilities.
SIP headers or other information elements relating to this capability shall be passed over the II-NNI if received from the sending side.
This does not imply that network elements inside the serving network or served network or user equipment connected to these networks shall support this capability. | +| o | optional | The capability may or may not be supported at II-NNI. The support of the capability is provided based on bilateral agreement between the operators. | +| n/a | not applicable | It is impossible to use/support the capability at the II-NNI. | +| c
| conditional | The support of the capability ("m", "o" or "n/a") depends on the support of other optional or conditional items. is the identifier of the conditional expression. | + +### 6.1.4 SIP message bodies + +The MIME type "application/sdp" and multipart message bodies (multipart/mixed, multipart/related and multipart/alternative) shall be supported according to IETF RFC 5621 [89] over the II-NNI. Other MIME types may be supported over the II-NNI based on agreement between operators. + +The SDP message bodies contained in the INVITE request shall not be encrypted over the II-NNI. + +NOTE 1: Some MIME types in SIP requests and responses are listed in annex A of 3GPP TS 24.229 [5]. + +NOTE 2: The multipart message bodies are used for carrying two or more message body types as described in IETF RFC 5621 [89]. + +NOTE 3: The IBCF can provide the capabilities to examine the length of a SIP message body and take an appropriate action (e.g. reject the request, remove the body) as specified in clause 5.10.6.3 of 3GPP TS 24.229 [5]. + +NOTE 4: In the INVITE request, the SDP message body is present over the II-NNI, except when the INVITE request without SDP message body is required to provide services (e.g. 3rd party call control). + +###### **Table 6.1.4.1: List of MIME bodies** + +| Item | MIME body name | II-NNI requirements in ref (NOTE 1) | Defined in ref (NOTE 2) | +|------|-------------------------------------------------|-----------------------------------------------------------------------------------------------------|------------------------------------------| +| 1 | application/3gpp-ims+xml | - | 3GPP TS 24.229 [5], clause 7.6 | +| 3 | message/cpim | - | IETF RFC 3862 [92] | +| 4 | message/imdn+xml | - | IETF RFC 5438 [93] | +| 5 | application/im-iscomposing+xml | clause 16.2 | IETF RFC 3994 [175] | +| 6 | multipart/mixed | clause 15.1,
clause 15.4,
clause 15.6.2,
clause 15.6.3,
clause 15.6.4,
clause 18.3.3 | IETF RFC 2046 [169] | +| 7 | multipart/related | clause 15.1,
clause 15.2,
clause 15.6.5 | IETF RFC 2387 [170] | +| 8 | multipart/alternative | - | IETF RFC 2046 [169] | +| 9 | application/pidf+xml | clause 15.1,
clause 28.2.3.2,
clause 28.2.9 | IETF RFC 3863 [174] | +| 10 | application/pidf-diff+xml | clause 15.1 | IETF RFC 5262 [179] | +| 11 | application/resource-lists+xml | clause 12.19,
clause 15.1,
clause 15.6.3,
clause 16.5,
clause 28.2.1,
clause 28.2.7 | IETF RFC 4826 [178] | +| 12 | application/rlmi+xml | clause 15.2,
clause 15.6.5 | IETF RFC 4662 [177] | +| 13 | application/sdp | - | IETF RFC 4566 [147] | +| 14 | application/simple-filter+xml | clause 15.1,
clause 15.6.4,
clause 28.2.3.2 | IETF RFC 4661 [176] | +| 15 | application/simple-message-summary+xml | clause 12.9 | IETF RFC 3842 [172] | +| 16 | message/sipfrag | clause 12.13,
clause 18.2,
clause 18.3.1 | IETF RFC 3420 [171] | +| 17 | application/vnd.3gpp.access-transfer-events+xml | clause 14.5.3 | 3GPP TS 24.237 [131], clause D.5.4 | +| 18 | application/vnd.3gpp.cw+xml | clause 12.7 | 3GPP TS 24.615 [37], clause C.1.1 | +| 19 | application/vnd.3gpp.iut+xml | clause 18.3.2,
clause 18.3.3 | 3GPP TS 24.337 [149], clause C.2.3 | +| 20 | application/vnd.3gpp.mid-call+xml | clause 14.4 | 3GPP TS 24.237 [131], clause D.1.3 | +| 21 | application/vnd.3gpp.replication+xml | clause 18.4.1,
clause 18.4.2 | 3GPP TS 24.337 [149], clause C.1.3 | +| 22 | application/vnd.3gpp.sms | - | | +| 23 | application/vnd.3gpp.srvcc-ext+xml | clause 14.5.1 | 3GPP TS 24.237 [131], clause D.4.4 | +| 24 | application/vnd.3gpp.srvcc-info+xml | clause 14.2.3 | 3GPP TS 24.237 [131], clause D.3.4 | +| 25 | application/vnd.3gpp.state-and-event-info+xml | clause 14.2.2,
clause 14.4 | 3GPP TS 24.237 [131], clause D.2.4 | +| 26 | application/vnd.3gpp.ussd | clause 12.24 | 3GPP TS 24.390 [163], clause 5.1.3 | +| 27 | application/vnd.etsi.aoc+xml | clause 12.22 | 3GPP TS 24.647 [122], clause E.1.1 | +| 28 | application/vnd.etsi.cug+xml | clause 12.16 | 3GPP TS 24.654 [103], clause 4.4.1 | +| 29 | application/vnd.etsi.mcid+xml | clause 12.2 | 3GPP TS 24.616 [33], clause 4.4 | +| 30 | application/vnd.etsi.pstn+xml | - | 3GPP TS 29.163 [168], clause F.2 | +| 31 | application/vnd.oma.suppnot+xml | clause 15.6.2,
clause 15.6.3 | OMA-SUP-XSD_prs_suppnotFilter-V1_0 [182] | +| 32 | application/watcherinfo+xml | clause 15.3 | IETF RFC 3858 [173] | +| 33 | application/xcap-diff+xml | clause 15.4,
clause 15.6.5 | IETF RFC 5874 [180] | +| 34 | application/session-info | - | 3GPP TS 29.163 [168], clause G.2 | +| 35 | application/load-control+xml | clause 21 | IETF RFC 7200 [167] | +| 36 | application/vnd.etsi.sci+xml | clause 11.3 | 3GPP TS 29.658 [186] | + +| | | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------| +| 37 | text/plain | - | IETF RFC 2646 [197] | +| 38 | application/x-www-form-urlencoded | - | IETF RFC 1866 [198], clause 8.2.1 (NOTE 3) | +| 39 | application/vnd.3gpp.crs+xml | clause 12.15 | 3GPP TS 24.183 [98], clause D.1 | +| 40 | message/sip | - | IETF RFC 3261 [13] | +| 41 | application/vnd.3gpp.mcptt-info+xml | clause 28.2.1,
clause 28.2.3.2,
clause 28.2.3.3,
clause 28.2.4,
clause 28.2.5,
clause 28.2.6,
clause 28.2.7,
clause 28.2.9 | 3GPP TS 24.379 [201], clause F.1 | +| 42 | application/vnd.3gpp.mcptt-mbms-usage-info+xml | clause 28.2.2 | 3GPP TS 24.379 [201], clause F.2 | +| 42A | application/vnd.3gpp.mcvideo-mbms-usage-info+xml | clause 28.2.2 | 3GPP TS 24.281 [210], clause F.2 | +| 43 | application/vnd.3gpp.mcptt-location-info+xml | clause 28.2.2 | 3GPP TS 24.379 [201], clause F.3 | +| 43A | application/vnd.3gpp.mcvideo-location-info+xml | clause 28.2.2 | 3GPP TS 24.281 [210], clause F.3 | +| 44 | application/conference-info+xml | clause 12.19,
clause 28.2.4,
clause 16.5 | IETF RFC 4575 [204] | +| 45 | application/poc-settings+xml | clause 28.2.5 | IETF RFC 4354 [205] | +| 46 | application/vnd.3gpp.mcptt-floor-request+xml | clause 28.2.7 | 3GPP TS 24.379 [201], clause F.5 | +| 47 | application/vnd.3gpp.mcptt-affiliation-command+xml | clause 28.2.3.3 | 3GPP TS 24.379 [201], clause F.4 | +| 47A | application/vnd.3gpp.mcptt-signed+xml | clause 28.2.5,
clause 28.2.6 | 3GPP TS 24.379 [201], clause F.6 | +| 48 | application/call-completion | clause 12.11,
clause 12.12,
clause 12.23 | IETF RFC 6910 [208] | +| 49 | application/vnd.3gpp.mcvideo-info+xml | clause 28.2.1
clause 28.2.3.2,
clause 28.2.3.3,
clause 28.2.5,
clause 28.2.4,
clause 28.2.6, | 3GPP TS 24.281 [210], clause F.1 | +| 50 | application/vnd.3gpp.mcvideo-affiliation-command+xml | clause 28.2.3.3 | 3GPP TS 24.281 [210], clause F.4 | +| 51 | application/vnd.3gpp.mcdata-signalling | clause 28.2.1,
clause 28.2.8 | 3GPP TS 24.282 [211], clause E.1 | +| 52 | application/vnd.3gpp.mcdata-payload | clause 28.2.8 | 3GPP TS 24.282 [211], clause E.2 | +| 53 | application/vnd.3gpp.mcdata-info+xml | clause 28.2.1
clause 28.2.3.2,
clause 28.2.3.3,
clause 28.2.5,
clause 28.2.6,
clause 28.2.8 | 3GPP TS 24.282 [211], clause D.1.4 | +| 54 | application/vnd.3gpp.mcdata-affiliation-command+xml | clause 28.2.3.3 | 3GPP TS 24.282 [211], clause D.3.4 | +| NOTE 1: When no specific II-NNI requirements are defined, the II-NNI requirements may be derived from the additional information about MIME types in SIP requests and responses in annex A of 3GPP TS 24.229 [5]. | | | | +| NOTE 2: This column references the definition of the MIME body for informative purpose only, the usage is defined in other specifications not listed here. | | | | +| NOTE 3 The MIME body contains a string that is coded as described in the IETF RFC 1866 [198]. | | | | + +Applicable characteristics of the SIP message body MIMEs (i.e. the value(s) of Content-Disposition header field and Content-Language header field) over the II-NNI may be a subject of operator agreements. + +## 6.2 Control Plane Transport + +### 6.2.1 General + +The control plane transport of the II-NNI shall comply with clause 4.2A of 3GPP TS 24.229 [5]. + +Support of SCTP as specified in IETF RFC 4168 [27] is optional for an IBCF connected by II-NNI. Nevertheless this option is favourable if the operators would like to improve reliability over the Ici. + +## 6.3 SIP timers + +Table 6.3.1 shows values of SIP timers that should be supported at II-NNI. It contains the following items: + +- the first column, titled "SIP Timer", shows the timer names as defined in IETF RFC 3261 [13] or IETF RFC 6026 [125]; +- the second column reflects the timer meaning as defined in IETF RFC 3261 [13]; +- the third column reflects the reference to the proper clause in the IETF RFC 3261 [13] and in 3GPP TS 24.229 [5] and +- the final column lists the values recommended for the functional entities closest to the border of an II-NNI (see reference model in clause 5). + +Table 6.3.1 reports information from 3GPP TS 24.229 [5], table 7.7.1. Values between IM CN subsystem elements shown in the second column in 3GPP TS 24.229 [5], table 7.7.1 are applicable for the II-NNI and are reported in the fourth column of table 6.3.1. If there are any differences between table 6.3.1 and 3GPP TS 24.229 [5], table 7.7.1, the information within 3GPP TS 24.229 [5], table 7.7.1 is applicable. + +**Table 6.3.1: SIP timers at II-NNI** + +| SIP Timer | Meaning | Reference | Recommended values | +|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------|----------------------------------| +| T1 | RTT estimate | [13] clause 17.1.1.1
[5] table 7.7.1 | 500ms default
(see NOTE) | +| T2 | The maximum retransmit interval for non-INVITE requests and INVITE responses | [13] clause 17.1.2.2
[5] table 7.7.1 | 4s
(see NOTE) | +| T4 | Maximum duration a message will remain in the network | [13] clause 17.1.2.2
[5] table 7.7.1 | 5s
(see NOTE) | +| Timer A | INVITE request retransmit interval, for UDP only | [13] clause 17.1.1.2
[5] table 7.7.1 | initially T1 | +| Timer B | INVITE transaction timeout timer | [13] clause 17.1.1.2
[5] table 7.7.1 | 64*T1 | +| Timer C | proxy INVITE transaction timeout | [13] clause 16.6
[5] table 7.7.1 | > 3min | +| Timer D | Wait time for response retransmits | [13] clause 17.1.1.2
[5] table 7.7.1
[13] clause 17.1.1.2
[5] table 7.7.1 | > 32s for UDP
0s for TCP/SCTP | +| Timer E | non-INVITE request retransmit interval, UDP only | [13] clause 17.1.2.2
[5] table 7.7.1 | initially T1 | +| Timer F | non-INVITE transaction timeout timer | [13] clause 17.1.2.2
[5] table 7.7.1 | 64*T1 | +| Timer G | INVITE response retransmit interval | [13] clause 17.2.1
[5] table 7.7.1 | initially T1 | +| Timer H | Wait time for ACK receipt. | [13] clause 17.2.1
[5] table 7.7.1 | 64*T1 | +| Timer I | Wait time for ACK retransmits | [13] clause 17.2.1
[5] table 7.7.1
[13] clause 17.2.1
[5] table 7.7.1 | T4 for UDP
0s for TCP/SCTP | +| Timer J | Wait time for non-INVITE request retransmits | [13] clause 17.2.2
[5] table 7.7.1
[13] clause 17.2.2
[5] table 7.7.1 | 64*T1 for UDP
0s for TCP/SCTP | +| Timer K | Wait time for response retransmits | [13] clause 17.1.2.2
[5] table 7.7.1
[13] clause 17.1.2.2
[5] table 7.7.1 | T4 for UDP
0s for TCP/SCTP | +| Timer L | Wait time for accepted INVITE request retransmits | [125] clause 8.11
[5] table 7.7.1 | 64*T1 | +| Timer M | Wait time for retransmission of 2xx to INVITE or additional 2xx from other branches of a forked INVITE | [125] clause 8.11
[5] table 7.7.1 | 64*T1 | +| Timer N | Wait time for receipt of a NOTIFY request upon sending SUBSCRIBE | [20] clause 4.1.2
[5] table 7.7.1 | 64*T1 | +| NOTE: | As a network option, SIP T1 Timer's value can be extended, along with the necessary modifications of SIP T2 and SIP T4 Timer values, to take into account the specificities of the supported services when the MRFC and the controlling AS are under the control of the same operator and the controlling AS knows, based on local configuration, that the MRFC implements a longer value of SIP T1 Timer. | | | + +# 7 User plane Interconnection + +## 7.1 Media and Codec + +For "end-to-end" media session involving the II-NNI, the SIP/SDP codec negotiation procedure can be applied between IM CN subsystems using different media codecs. It is possible that the end-to-end codec negotiation could fail because no common codec could be supported by the UEs, in particular for voice services. + +To enhance interoperability, the IBCF, the MRFC, or other IMS network entities can interfere with the end-to-end codec negotiation to offer additional codec(s) available via transcoding, or to remove codecs. The IBCF can configure an attached TrGW to transcode, and the MRFC can configure an attached MRFP to transcode. + +Codecs applicable at the II-NNI may be a subject of interworking agreements. + +NOTE 1: Possible codecs which could be used at the II-NNI are described in 3GPP TS 26.114 [11] and ETSI TS 181 005 [12]. + +NOTE 2: As described in 3GPP TS 24.229 [5], the IETF RFC 4733 [157] is used to encode DTMF events and a payload type number associated with the MIME subtype "telephone-event" is included in a SDP message. + +However, to avoid that transcoding is performed several times, applicable codecs at the II-NNI should be restricted as little as possible in the inter-operator agreements. It is not recommended to set only codecs which are not agreed to use by the inter-operator agreement into the SDP of the SIP message at the II-NNI. Whether it is allowed to offer codecs which are not included in the applicable codec list made by inter-operator agreements over the II-NNI is also determined by the inter-operator agreement if necessary. + +NOTE 3: Transcoding can be performed in an IMS network serving an SDP offerer or in an IMS network serving an SDP answerer. To avoid that transcoding is performed multiple times, inter-operator agreements can clarify if it is preferred that IMS network serving an SDP offerer (with respect to the initial offer-answer exchange) or IMS network serving an SDP answerer (with respect to the initial offer-answer exchange) modify an SDP offer to offer transcoding. Furthermore, if transcoding is ongoing then subsequent SDP negotiation should avoid adding transcoding steps as specified in 3GPP TS 24.229 [5] Annex T.2 steps G), H), and I). + +If the IBCF performs media transcoding control, the IBCF shall apply the related procedures in 3GPP TS 24.229 [5]. + +## 7.2 User Plane Transport + +The user plane transport of the II-NNI may use the protocols listed in table 7.2.1. Protocols that use UDP, RTP, SCTP or TCP as the underlying transport protocol may be used based on agreements between operators. The used protocols to transport media are negotiated by means of the SDP offer/answer procedure specified in IETF RFC 3264 [146]. + +**Table 7.2.1: Supported transport-level RFCs to be described in SIP/SDP messages** + +| Item | RFC | Title | Support | +|------|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| 1 | IETF RFC 3550 [151] | RTP: A Transport Protocol for Real-Time Applications | Mandatory | +| 2 | IETF RFC 768 [152] | User Datagram Protocol | Mandatory | +| 3 | IETF RFC 3551 [153] | RTP Profile for Audio and Video Conferences with Minimal Control | Mandatory | +| 4 | IETF RFC 3556 [154] | Session Description Protocol (SDP) Bandwidth Modifiers for RTP Control Protocol (RTCP) Bandwidth | Mandatory | +| 5 | IETF RFC 4585 [155] | Extended RTP Profile for Real-time Transport Control Protocol (RTCP) - Based Feedback (RTP/AVPF) | Optional (NOTE 1) | +| 6 | IETF RFC 793 [156] | Transmission Control Protocol | Optional (NOTE 2) | +| 7 | IETF RFC 8841 [190] | Session Description Protocol (SDP) Offer/Answer Procedures for Stream Control Transmission Protocol (SCTP) over Datagram Transport Layer Security (DTLS) Transport | Optional (NOTE 3) | + +NOTE 1: Used by MTSI, as indicated in 3GPP TS 26.114 [11]. +NOTE 2: Used for MSRP service. +NOTE 3: Used for data channel in telepresence using IMS, as indicated in 3GPP TS 24.103 [189]. + +# 8 Numbering, Naming and Addressing + +## 8.1 Numbering, Naming and Addressing for SIP message + +The following URI formats in SIP messages may be applied at the Icf as standardized in 3GPP TS 24.229 [5]: + +- SIP URI defined in IETF RFC 3261 [13]; +- tel URI defined in IETF RFC 3966 [14]; +- IM URI defined in IETF RFC 3860 [15]; and +- PRES URI defined in IETF RFC 3859 [16]. + +According to 3GPP TS 24.229 [5], the IBCF acting as an exit or entry point in the IMS network supports these URI formats. These URI formats shall be supported at the roaming II-NNI. The SIP URI format shall be supported at the non-roaming II-NNI. For the loopback traversal scenario both the SIP URI and the tel URI shall be supported. The tel URI, IM URI and PRES URI formats may be supported at the non-roaming II-NNI based on agreement between operators. For the loopback traversal scenario the IM URI and PRES URI may be supported based on agreement between operators. Other URI formats may be supported over the II-NNI depending on the operator agreements. + +A global number as defined in IETF RFC 3966 [14] shall be used in a tel URI or in the user portion of a SIP URI with the user=phone parameter when conveyed via a non-roaming II-NNI or for the loopback traversal scenario in the Request-URI and in the P-Asserted-Identity header field, except when agreement exists between the operators to also allow other kinds of numbers. + +NOTE 1: In a SIP URI the user portion of the Request-URI represents a telephone number only if the SIP URI includes the user=phone parameter. + +NOTE 2: Agreements can exist between operators to allow local number (e.g. national service numbers, business trunking numbers, or private numbers) at a non-roaming II-NNI or for the loopback traversal scenario. A SIP URI with such a number, a user=phone parameter, and a phone-context parameter agreed between the operators can then be used. + +NOTE 3: 3GPP TS 24.229 [5] allows to restrict the number within a SIP Request-URI with user=phone parameter at a non-roaming II-NNI or for the loopback traversal scenario to be a global number (i.e. E.164 in international format) via an appropriate Application Server. Suitable configuration by the operator is needed to achieve the desired modification of the format. + +NOTE 4: The allowed phone number formats in the P-Asserted-Identity header field of a served user are configured by the operator. According to 3GPP TS 23.003 [35], international E.164 format is used within a P-Asserted-Identity header field. + +NOTE 5: The global number format usage within a SIP Request-URI with the user=phone parameter at a non-roaming II-NNI or for the loopback traversal scenario allows the terminating network to find the called subscriber, via HSS interrogation, without any further number translation and thus improves the success of the interconnection between IMS operators. + +NOTE 6: According to 3GPP TS 23.003 [35] and 3GPP TS 24.229 [5], public user identity takes the form of either SIP URI or tel URI. + +NOTE 7: Agreements can exist between operators to allow the "Unavailable User Identity" as defined in 3GPP TS 23.003 [35] in the P-Asserted-Identity header field at a non-roaming II-NNI or for the loopback traversal scenario. + +The optional "oli" and "cpc" tel URI parameters associated with a tel URI or a SIP URI with user=phone are described in 3GPP TS 24.229 [5] clause 7.2A.12 and can be part of the P-Asserted-Identity header field. Depending on operator agreements, those URI parameters may be supported at the non-roaming II-NNI or for the loopback traversal scenario. + +The "sos" SIP URI parameter associated with a URI in the Contact header field of a REGISTER request or a 200 (OK) response to REGISTER request is described in 3GPP TS 24.229 [5]. The "sos" SIP URI parameter shall be supported at the roaming II-NNI. + +The "sos" SIP URI parameter associated with the Request-URI for all dialogs and standalone SIP requests described in clause 5.2.10.3 of 3GPP TS 24.229 [5] and shall be supported at the roaming II-NNI. + +The "rn" and "npdi" number portability parameters for the tel URI and the SIP URI with user=phone as described within IETF RFC 4694 [75] can be part of the Request-URI. Depending on operator agreements these parameters may be exchanged over the non-roaming II-NNI or for the loopback traversal scenario. + +NOTE 7: The "rn" and "npdi" parameters can be used to address the entry point of the terminating operator depending on national rules for number portability. + +The "isub" tel URI parameter for the tel URI and the SIP URI with user=phone as described within IETF RFC 3966 [14] can be part of the Request-URI, To header field and P-Asserted-Identity header field. Depending on operator agreements, this URI parameter may be exchanged over the II-NNI. + +The "premium-rate" tel URI parameter for the tel URI and the SIP URI with user=phone as described within 3GPP TS 24.229 [5] clause 7.2A.17 can be part of the Request-URI. Depending on operator agreements, this URI parameter may be exchanged at the roaming II-NNI. + +The public service identity (PSI) that takes a form of a SIP URI without including a port number as described in clause 13.5 of 3GPP TS 23.003 [35] may be exchanged over the II-NNI depending on operator agreements. + +## 8.2 Numbering, Naming and Addressing for SDP + +The following URI format in the SDP exchange may be applied at the Ici as standardized in 3GPP TS 24.229 [5]: + +- MSRP URI for a session of instant messages defined in IETF RFC 4975 [17]. + +This URI format shall be supported at the roaming II-NNI and may be supported at the non-roaming II-NNI and for the loopback traversal scenario based on agreement between operators. Other URI formats may be supported over the II-NNI depending on the operator's agreements. + +# --- 9 IP Version + +The network elements interconnected by means of the II-NNI may support IPv4 only, IPv6 only or both. + +The support of one or both of the IP versions is an operator option and should be based on bilateral agreement. + +In case IPv4 and IPv6 networks are interconnected, the involved IBCFs and TrGWs shall apply the IP version interworking procedures as indicated in 3GPP TS 29.162 [8]. + +# --- 10 Security + +The supported security mechanisms for IP signalling transport over II-NNI interfaces are described in 3GPP TS 33.210 [10]. + +# --- 11 Charging + +## 11.1 General + +The accounting information to be supported over the Ici is described in 3GPP TS 32.260 [29] and 3GPP TS 32.240 [183]. It shall be configurable by the operator to use or not the accounting mechanisms provided by the IBCF. + +## 11.2 Inter-operator accounting + +For inter-operator accounting, the procedures related to the P-Charging-Vector header field specified in 3GPP TS 24.229 [5] shall be supported over the II-NNI as further specified below. + +NOTE 1: The "icid-value" header field parameter identifying a dialog or a transaction outside a dialog is included in the P-Charging-Vector header field as specified in 3GPP TS 24.229 [5]. The "icid-value" header field parameter value of a SIP response to a SIP request is identical to the "icid-value" of the SIP request. + +For the roaming II-NNI: + +- the P-Charging-Vector header field in the REGISTER requests, initial SIP requests and stand-alone SIP requests, containing the type 1 "orig-ioi" with the entry which identifies the visited network; and +- the P-Charging-Vector header field in the REGISTER responses (except the 100 (Trying) response), SIP responses (except the 100 (Trying) response) to initial SIP requests and SIP stand-alone requests, containing type 1 "orig-ioi" and type 1 "term-ioi" header field parameters with the entries which identify the visited network and the home network respectively; + +shall be supported. + +NOTE 2: Operator network identifiers populated in the type 1 "orig-ioi" and type 1 "term-ioi" header field parameters need to be exchanged by inter-operator agreements in advance. + +For the II-NNI between IMS home networks: + +- the P-Charging-Vector header field in the SIP requests containing the type 2 "orig-ioi" with the entry which identifies the home originating network; and +- the P-Charging-Vector header field in the SIP responses (except the 100 (Trying) response) containing the type 2 "orig-ioi" and type 2 "term-ioi" header field parameters with the entries which identify the home originating network and the home terminating network respectively; + +may be supported based on inter-operator agreements. + +If the roaming architecture for voice over IMS with local breakout is used, for the II-NNI between the caller's visited network and the callee's home network except for the roaming II-NNI: + +- the P-Charging-Vector header field in the SIP requests containing the type 2 "orig-ioi" with the entry which identifies the visited originating network; and +- the P-Charging-Vector header field in the SIP responses (except the 100 (Trying) response) containing the type 2 "orig-ioi" and type 2 "term-ioi" header field parameters with the entries which identify the visited originating network and the home terminating network respectively; + +may be supported based on inter-operator agreements. + +NOTE 3: Operator network identifiers populated in the type 2 "orig-ioi" and type 2 "term-ioi" header field parameters need to be exchanged by inter-operator agreements in advance. + +For the II-NNI for the transit scenario: + +- the P-Charging-Vector header field in the SIP requests and responses (except the 100 (Trying) response) containing the "transit-ioi" header field parameter with the entry(ies) which identify the transit network(s); + +may be supported based on inter-operator agreements. + +NOTE 4: Operator network identifiers populated in the value(s) of "transit-ioi" header field parameter need to be exchanged by inter-operator agreements in advance. + +## 11.3 Transfer of IP multimedia service tariff information + +In order to assure the end-to-end service interoperability through the Inter-IMS Network to Network Interface (II-NNI), transfer of IP multimedia service tariff information as specified in 3GPP TS 29.658 [186] may be supported on the II-NNI between two IMS networks. The support of transfer of IP multimedia service tariff information is based on agreement between operators. + +If transfer of IP multimedia service tariff information is supported, the "application/vnd.etsi.sci+xml" MIME body with the Content-Disposition header field set to either "render" with the "handling" parameter set to "optional" or to "signal" + +with the "handling" parameter set to "required" or "optional" based on operator agreement in 18x responses to the INVITE request and in the INFO request shall be supported at the II-NNI. + +# --- 12 Supplementary services associated with the IMS multimedia telephony communication service + +## 12.1 General + +In order to assure the end-to-end service interoperability through the Inter-IMS Network to Network Interface (II-NNI), the associated supplementary services of the multimedia telephony communication service may be supported on the II-NNI between the two IMS networks. + +The MMTEL communication service is identified by means of the "urn:urn-7:3gpp-service.ims.icsi.mmtel" URN. The "urn:urn-7:3gpp-service.ims.icsi.mmtel" can appear in: + +- the media feature tag "g.3gpp.icsi-ref" (specified in 3GPP TS 24.229 [5] clause 7.2A.8) in the Contact header field and the Accept-Contact header field; +- the feature-capability indicator "g.3gpp.icsi-ref" (specified in 3GPP TS 24.229 [5] clause 7.9A.2) in the Feature-Caps header field; and +- the P-Asserted-Service header field. + +The support of each associated supplementary service is based on agreement between operators. + +If a supplementary service is supported, the related procedures from the 3GPP TS 22.173 [30], the protocol details from the 3GPP TS 24.173 [31] and specifications referenced in the 3GPP TS 24.173 [31] shall be applied with the requirements in the relevant clause below due to the crossing of the II-NNI. + +A classification of the importance of supplementary services applicable over the II-NNI is available in the informative annex Db of 3GPP TS 22.173 [30]. + +NOTE: Agreeing on interworking of entire class of services according to this classification can simplify the cooperation between interconnecting networks but remains optional. + +## 12.2 Malicious Communication Identification (MCID) + +Service specific requirements in accordance with 3GPP TS 24.616 [33] shall be supported over the II-NNI. + +The P-Asserted-Identity header field shall be supported at the II-NNI. + +The INFO request and the 200 (OK) response to the INFO request containing the "application/vnd.etsi.mcid+xml" MIME body defined in 3GPP TS 24.616 [33] may be supported at the II-NNI. + +If a network terminating the dialog supports MCID, the terminating network shall only deliver the MCID request in the "application/vnd.etsi.mcid+xml" MIME body, as specified in the 3GPP TS 24.616 [33], if an agreement to use the MCID supplementary service according to the 3GPP TS 24.616 [33] exists with the network originating the dialog and if the INVITE request received by the terminating network does not contain the information of the originating party. + +NOTE: The IBCF and the AS in the terminating network interact to deliver the MCID request only if an agreement to use the MCID supplementary service exists, as specified in 3GPP TS 24.616 [33] and 3GPP TS 24.229 [5]. + +The originating network and the terminating network shall have a bilateral agreement to support transportation of the minimum information specified in clause 4.5.2.5.0 of the 3GPP TS 24.616 [33] between the networks. + +## 12.3 Originating Identification Presentation (OIP) and Originating Identification Restriction (OIR) + +Service specific requirements in accordance with 3GPP TS 24.607 [32] and 3GPP TS 24.229 [5] shall be supported over the II-NNI. + +The P-Asserted-Identity header field and the Privacy header field with values "id", "user", "none", "header" and "critical" shall be supported at the II-NNI. + +- NOTE 1: P-Asserted-Identity header fields are intended for end-to-end operation. Removal of such header fields will impact the intended end-to-end operation between the end users. Where a trust relationship exists on the P-Asserted-Identity header field between the two IMS networks, this header field cannot be altered when passing through the II-NNI according to 3GPP TS 24.229 [5]. Where no trust relationship exists on the P-Asserted-Identity header field between the two IMS networks, the IBCF determines whether to remove the P-Asserted-Identity header field according to procedures described in 3GPP TS 24.229 [5] clause 4.4.2 referencing IETF RFC 3325 [44] and local policy rules for using additional screening capabilities as defined in 3GPP TS 24.229 [5] clause 5.10.6. +- NOTE 2: Where a trust relationship exists with the remote domain the From header field will be passed transparently by the IBCF. If a SIP request is received by the terminating network and the application of the OIR service is required with the value "user" for the Privacy header field then the From header field will be anonymised in accordance with IETF RFC 3323 [34] by the terminating network. Where no trust relationship exists with the remote domain, the From header field can be, based on local policy rules, anonymised by the IBCF of the originating network prior passing through the II-NNI using screening capabilities defined in 3GPP TS 24.229 [5] clause 5.10.6 and clause 5.10.8. +- NOTE 3: The privacy level "session" and "critical" are not used in the OIP/OIR service as described in 3GPP TS 24.607 [32]. + +SIP based user configuration as described in 3GPP TS 24.238 [100] shall be supported at the roaming II-NNI. + +## 12.4 Terminating Identification Presentation (TIP) and Terminating Identification Restriction (TIR) + +Service specific requirements in accordance with 3GPP TS 24.608 [113] shall be supported over the II-NNI. + +The P-Asserted-Identity header field and the Privacy header field with values "id", "user", "none", "header" and "critical" shall be supported at the II-NNI. + +- NOTE: P-Asserted-Identity header fields are intended for end-to-end operation. Removal of such header fields will impact the intended end-to-end operation between the end users. Where a trust relationship exists on the P-Asserted-Identity header field between the two IMS networks, this header field will be passed transparently through the II-NNI according to 3GPP TS 24.229 [5]. Where no trust relationship exists on the P-Asserted-Identity header field between the two IMS networks, the IBCF determines whether to remove the P-Asserted-Identity header field according to procedures described in 3GPP TS 24.229 [5] clause 4.4.2, referencing IETF RFC 3325 [44] and local policy rules for using additional screening capabilities as defined in 3GPP TS 24.229 [5] clause 5.10.6. + +The option tag "from-change" defined in IETF RFC 4916 [158], in the Supported header field should be supported at II-NNI. + +## 12.5 Anonymous Communication Rejection (ACR) + +Service specific requirements in accordance with 3GPP TS 24.611 [114] shall be supported over the II-NNI. + +The P-Asserted-Identity header field and the Privacy header field shall be supported at the II-NNI. + +Procedures as described in clause 12.21.4 are used to provide announcements. + +The response code 433 (Anonymity Disallowed) shall be supported at the II-NNI. + +SIP based user configuration as described in 3GPP TS 24.238 [100] shall be supported at the roaming II-NNI. + +## 12.6 Communication Diversion (CDIV) + +Service specific requirements in accordance with 3GPP TS 24.604 [117] shall be supported over the II-NNI. + +- NOTE 1: The support of the Diversion header field not adopted in 3GPP TS 24.604 [117] requires bilateral agreement between the operators. + +Procedures as described in clause 12.21.2 are used to provide announcements. + +The Privacy header field with a priv-value set to "history" included in the hi-targeted-to-uri or as a standalone header field shall be supported at the II-NNI. + +The History-Info header field as described by 3GPP TS 24.604 [117] containing an "mp" header field parameter as defined by IETF RFC 7044 [25] and a "cause" SIP URI parameter with cause values as defined by the IETF RFC 4458 [58] shall be supported over the II-NNI. + +NOTE 2: The networks can have an internal limit in the number of allowed diversions, as described in 3GPP TS 24.604 [117], clause 4.5.2.6.1. To ensure efficiency of this control operators can indicate in their bilateral agreements their own number of allowed communication diversions, the parameter that is used for counting, and the network behavior when the internal limit is reached. + +The response code 181 (Call Is Being Forwarded) shall be supported at the II-NNI. + +The MESSAGE request procedure for indication of communication diversion to the diverting user as specified in 3GPP TS 24.604 [117] and 3GPP TS 24.229 [5] should be supported at the roaming II-NNI. + +NOTE 3: The content of the MESSAGE request is operator specific. + +SIP based user configuration as described in 3GPP TS 24.238 [100] shall be supported at the roaming II-NNI. + +## 12.7 Communication Waiting (CW) + +Service specific requirements in accordance with 3GPP TS 24.615 [37] shall be supported over the II-NNI. + +The "application/vnd.3gpp.cw+xml" MIME body defined in 3GPP TS 24.615 [37] in the INVITE request shall be supported at the roaming II-NNI. + +The Alert-Info header field set to "urn:alert:service:call-waiting" in a 180 (Ringing) response shall be supported at the II-NNI. + +As a network option, in case of expiry of the CW timer, the response code 480 (Temporarily Unavailable) including a Reason header field containing the protocol value "Q.850" and the "cause" header field parameter set to "19" shall be supported at the non-roaming II-NNI and for the loopback traversal scenario. + +Procedures as described in clause 12.21.2 are used to provide announcements. + +## 12.8 Communication HOLD (HOLD) + +Service specific requirements in accordance with 3GPP TS 24.610 [36] shall be supported over the II-NNI. + +NOTE: The support of an alternative method not adopted in 3GPP TS 24.610 [36] requires bilateral agreement between the operators and is outside the scope of the present document. + +Procedures as described in clause 12.21.3 are used to provide announcements. + +## 12.9 Message Waiting Indication (MWI) + +Service specific requirements in accordance with 3GPP TS 24.606 [112] shall be supported over the II-NNI. + +The event package name "message-summary" in the Event header field according to IETF RFC 6665 [20] and 3GPP TS 24.229 [5] in the SUBSCRIBE request shall be supported at the roaming II-NNI. + +The "application/simple-message-summary" MIME body described in 3GPP TS 24.606 [112] in the NOTIFY request shall be supported at the roaming II-NNI. + +## 12.10 Communication Barring (CB) + +### 12.10.1 Incoming Communication Barring (ICB) + +Service specific requirements in accordance with 3GPP TS 24.611 [114] shall be supported over the II-NNI. + +Procedures as described in clause 12.21.4 are used to provide announcements. + +The response code 603 (Decline) including a Reason header field containing the protocol value set to "SIP" and the "cause" header field parameter set to value "603" as described in 3GPP TS 24.611 [114] shall be supported at the II-NNI. + +A Reason header field containing the protocol value set to "SIP" and the "cause" header field parameter set to value "603" as described in 3GPP TS 24.611 [114] included in the BYE request shall be supported at the II-NNI. + +SIP based user configuration as described in 3GPP TS 24.238 [100] shall be supported at the roaming II-NNI. + +If the option IIFC (Inhibition of Incoming Forwarded Calls) is supported the transparency of information related to communication diversion (see clause 12.6) shall be supported at II-NNI. + +### 12.10.2 Outgoing Communication Barring (OCB) + +Service specific requirements in accordance with 3GPP TS 24.611 [114] shall be supported over the II-NNI. + +Procedures as described in clause 12.21.4 are used to provide announcements. + +The response code 603 (Decline) including a Reason header field containing the protocol value set to "SIP" and the "cause" header field parameter set to "603" as described in 3GPP TS 24.611 [114] shall be supported at the roaming II-NNI. + +SIP based user configuration as described in 3GPP TS 24.238 [100] shall be supported at the roaming II-NNI. + +## 12.11 Completion of Communications to Busy Subscriber (CCBS) + +Service specific requirements in accordance with 3GPP TS 24.642 [109] shall be supported over the II-NNI. + +The response code 486 (Busy Here) containing a Call-Info header field with a "purpose" header field parameter set to "call-completion" and the "m" parameter set to "BS" shall be supported at the non-roaming II-NNI and for the loopback traversal scenario. + +For invoking and revoking of the CCBS supplementary service, announcement procedures shall be used to provide announcements and inband-interaction procedures as described in clause 12.21.3 and clause 12.21.4 shall be supported at the roaming II-NNI. + +The response code 199 (Early Dialog Terminated) shall be supported at the roaming II-NNI. + +Basic call procedures and in case of a call-completion recall initiated by a REFER request, normal REFER method handling procedures according to 3GPP TS 24.229 [5] shall be supported at the roaming II-NNI. + +As a network option the special REFER request handling procedures according to 3GPP TS 24.628 [38] should be supported at the roaming II-NNI. + +NOTE 1: 3rd party call control procedures can be used when the REFER request is not supported at the II-NNI. + +NOTE 2: A REFER request can be rejected by IBCF based on operator policy as specified by 3GPP TS 24.229 [5]. + +The SUBSCRIBE and NOTIFY methods according to IETF RFC 6665 [20] and 3GPP TS 24.229 [5] containing the event package name "call-completion" in the Event header field and the Call-Info header field with a purpose parameter set to 'call-completion' and the m parameter set to "BS" shall be supported at the non-roaming II-NNI and for the loopback traversal scenario. + +The NOTIFY request containing the "application/call-completion" MIME body as defined in IETF RFC 6910 [208] shall be supported at the non-roaming II-NNI. + +The Request-URI with the "m" SIP URI parameter with a value set to "BS" and the Call-Info header field with a purpose parameter set to 'call-completion' and the "m" parameter set to "BS" in the INVITE method shall be supported at the non-roaming II-NNI and for the loopback traversal scenario. + +The Date header field in the 486 (Busy Here) response to the INVITE request shall be supported at the roaming II-NNI. + +SIP based user configuration as described in 3GPP TS 24.238 [100] shall be supported at the roaming II-NNI. + +## 12.12 Completion of Communications by No Reply (CCNR) + +Service specific requirements in accordance with 3GPP TS 24.642 [109] shall be supported over the II-NNI. + +The response code 180 (Ringing) containing a Call-Info header field with a purpose parameter set to 'call-completion' and the "m" parameter set to "NR" shall be supported at the non-roaming II-NNI and for the loopback traversal scenario. + +For invoking and revoking of the CCNR supplementary service, announcement procedures shall be used to provide announcements and inband-interaction procedures as described in clause 12.21.3 and clause 12.21.4 shall be supported at the roaming II-NNI. + +The response code 199 (Early Dialog Terminated) shall be supported at the roaming II-NNI. + +Basic call procedures and in case of a call-completion recall initiated by a REFER request, normal REFER method handling procedures according to 3GPP TS 24.229 [5] shall be supported at the roaming II-NNI. + +As a network option the special REFER request handling procedures according to 3GPP TS 24.628 [38] should be supported at the roaming II-NNI. + +NOTE 1: 3rd party call control procedures can be used when the REFER request is not supported at the II-NNI. + +NOTE 2: A REFER request can be rejected by IBCF based on operator policy as specified by 3GPP TS 24.229 [5]. + +The SUBSCRIBE and NOTIFY methods according to IETF RFC 6665 [20] and 3GPP TS 24.229 [5] containing the event package name "call-completion" in the Event header field and the Call-Info header field with a purpose parameter set to 'call-completion' and the m parameter set to "NR" shall be supported at the non-roaming II-NNI and for the loopback traversal scenario. + +The NOTIFY request containing the "application/call-completion" MIME body as defined in IETF RFC 6910 [208] shall be supported at the non-roaming II-NNI. + +The Request-URI with the "m" SIP URI parameter with a value set to "NR" and the Call-Info header field with a purpose parameter set to 'call-completion' and the "m" parameter set to "NR" in the INVITE method shall be supported at the non-roaming II-NNI and for the loopback traversal scenario. + +The Date header field in the 480 (Temporarily Unavailable) response to the INVITE request shall be supported at the roaming II-NNI. + +SIP based user configuration as described in 3GPP TS 24.238 [100] shall be supported at the roaming II-NNI. + +## 12.13 Explicit Communication Transfer (ECT) + +### 12.13.1 Consultative and blind transfer + +Service specific requirements in accordance with 3GPP TS 24.629 [116] shall be supported over the II-NNI. + +The REFER method, the Referred-By header field and the Replaces header field as specified in 3GPP TS 24.629 [116] and the NOTIFY method containing an "application/sipfrag" MIME body shall be supported at the II-NNI for call transfer without third party call control. + +The REFER method, the Referred-By header field and the Replaces header field as specified in 3GPP TS 24.629 [116] and the NOTIFY method containing an "application/sipfrag" MIME body shall be supported at the roaming II-NNI for call transfer with third party call control. + +The Refer-To URI header parameter in the REFER request containing the Require header field set to "replaces" shall be supported at the roaming II-NNI. + +The Replaces header field in the INVITE request shall be supported at the non-roaming II-NNI and for the loopback traversal scenario. + +### 12.13.2 Assured transfer + +The requirements for the assured transfer are the same as in clause 12.13.1 with the additional requirements in this subclause. + +An Expires header field parameter in the Refer-To URI of the REFER Request shall be supported at the II-NNI for call transfer without third party call control. + +An Expires header field parameter in the Refer-To URI of the REFER Request shall be supported at the roaming II-NNI for call transfer with third party call control. + +The Refer-To header field in the REFER request containing the method parameter set to "CANCEL" shall be supported at the II-NNI for call transfer without third party call control. + +The Refer-To header field in the REFER request containing the method parameter set to "CANCEL" shall be supported at the roaming II-NNI with third party call control. + +## 12.14 Customized Alerting Tone (CAT) + +Service specific requirements in accordance with 3GPP TS 24.182 [129] shall be supported over the II-NNI. + +The P-Early-Media header field as described in 3GPP TS 24.182 [129] shall be supported at the II-NNI. + +The response code 180 (Ringing) and the response code 183 (Session Progress) including a P-Early-Media header field shall be supported over the II-NNI. + +The response code 199 (Early Dialog Terminated) shall be supported over the II-NNI. + +The Supported header field and the Require header field with "early-session" option-tag shall be supported at the II-NNI, if the early session model is supported. + +An "application/sdp" MIME body with the Content-Disposition header field set to "early-session" as specified in IETF RFC 3959 [96] shall be supported at II-NNI, if the early session model is supported. + +A SDP "a=content" attribute with a "g.3gpp.cat" value in the 18x responses shall be supported at the II-NNI. + +The SIP INFO mechanism for DTMF transport, as defined in 3GPP TS 24.229 [5] may be supported at the roaming II-NNI. + +NOTE 1: For telephone-event based DTMF transport, the DTMF digits are sent as media and not visible in the control plane. + +NOTE 2: Multiple methods for DTMF transport are defined in 3GPP TS 24.182 [129]. + +SIP based user configuration as described in 3GPP TS 24.238 [100] shall be supported at the roaming II-NNI. + +## 12.15 Customized Ringing Signal (CRS) + +Service specific requirements in accordance with 3GPP TS 24.183 [98] shall be supported over the II-NNI. + +An Alert-Info header field in the initial INVITE request containing an URI followed by a URN "urn:alert:service:crs" shall be supported at the II-NNI. + +An "application/vnd.3gpp.crs+xml" MIME body in the initial INVITE request shall be supported at the II-NNI. + +A SDP "a=content" attribute with a "g.3gpp.crs" value in the PRACK request or the re-INVITE request may be supported at the II-NNI. + +The Supported header field and the Require header field with "early-session" option-tag may be supported at the II-NNI. + +An "application/sdp" MIME body with the Content-Disposition header field set to "early-session" as specified in IETF RFC 3959 [96] may be supported at II-NNI. + +The SIP INFO mechanism for DTMF transport, as defined in 3GPP TS 24.229 [5] may be supported at the II-NNI. + +NOTE: For telephone-event based DTMF transport, the DTMF digits are sent as media and not visible in the control plane. + +SIP based user configuration as described in 3GPP TS 24.238 [100] shall be supported at the roaming II-NNI. + +## 12.16 Closed User Group (CUG) + +Service specific requirements in accordance with 3GPP TS 24.654 [103] shall be supported over the II-NNI. + +The "application/vnd.etsi.cug+xml" MIME body as specified 3GPP TS 24.654 [103] shall be supported in INVITE requests at the II-NNI. + +NOTE: If no agreement between the originating network and the terminating network exists to support the CUG supplementary service the INVITE request is rejected as described in IETF RFC 5621 [89] when the "handling" parameter in the Content-Disposition header field of the " application/vnd.etsi.cug+xml" MIME body is set to "required". + +The 403 (Forbidden) response, the 603 (Decline) response and the 500 (Server Internal Error) response shall be supported at II-NNI. + +SIP based user configuration as described in 3GPP TS 24.238 [100] shall be supported at the roaming II-NNI. + +## 12.17 Personal Network Management (PNM) + +Service specific requirements in accordance with 3GPP TS 24.259 [99] shall be supported over the II-NNI. + +A "g.3gpp.iari\_ref" feature tag with the value "urn:urn-7:3gpp-application.ims.iari.pnm-controller" in the Contact header field of the REGISTER request shall be supported at the roaming II-NNI. + +A "g.3gpp.iari\_ref" feature tag with the value "urn:urn-7:3gpp-application.ims.iari.pnm-controller" in the Accept-Contact header field shall be supported at the II-NNI. + +The History-Info header field shall be supported at II-NNI. + +A "histinfo" option tag as described by 3GPP TS 24.259 [99] in the Supported header field shall be supported at II-NNI. + +## 12.18 Three-Party (3PTY) + +Service specific requirements in accordance with 3GPP TS 24.605 [105] shall be supported over the II-NNI. + +NOTE 1: The requirements below can be relaxed by bilateral agreements between operators. + +The requirements for the 3PTY supplementary service are the same as for the CONF supplementary service specified in clause 12.19 with the following additional requirement: + +- If a REFER request is supported at the II-NNI, a Replaces header field in the header portion of the SIP URI of the Refer-to header field of the REFER request shall also be supported at II-NNI. + +NOTE 2: Clause 12.19 describes the conditions for the support of the REFER request. + +## 12.19 Conference (CONF) + +Service specific requirements in accordance with 3GPP TS 24.605 [105] and 3GPP TS 24.147 [106] shall be supported over the II-NNI. + +NOTE 1: The requirements below can be relaxed by bilateral agreements between operators. + +The REFER request shall be supported at the roaming II-NNI in the direction from visited to home network. Based on inter-operator agreement, the REFER request may be supported at the non-roaming II-NNI, for the loopback traversal scenario, and at the roaming II-NNI in the direction from home network to visited network. + +NOTE 2: If the REFER request is not supported at the non-roaming II-NNI, for the loopback traversal scenario, or at the roaming II-NNI in the direction from home network to visited network, an attempt of an UE to send the REFER directly to peers to invite them to a conference without involvement of the conference focus can fail over such an II-NNI. However such failures can also occur if a peer is located in a circuit switched network, or if a peer does not support the REFER method. An operator can avoid such failures by configuring an AS to convert the REFER to an INVITE, as detailed in 3GPP TS 24.628 [38]. Information on security risks associated with the REFER request is provided within the "security consideration" of IETF RFC 3515 [22]. + +NOTE 3: A REFER request can be rejected by IBCF based on operator policy as specified by 3GPP TS 24.229 [5]. + +The "application/resource-lists+xml" MIME body in the INVITE request shall be supported at the roaming II-NNI. + +The Referred-By header field in the INVITE request shall be supported at the II-NNI. + +The "isfocus" feature parameter indicated in Contact header field of the INVITE request and in the 200 (OK) response shall be supported at the II-NNI. + +The SUBSCRIBE request including the "conference" event package name in the Event header field and the Accept header field containing an "application/conference-info+xml" MIME type shall be supported at the II-NNI. + +The NOTIFY request including an "application/conference-info+xml" MIME body shall be supported at the II-NNI. + +NOTE 4: The subscription to "conference event" package does not apply at the roaming II-NNI between the MSC Server enhanced for ICS/MSC Server enhanced for SRVCC/MSC server enhanced for dual radio and the IMS network where the communication is anchored. + +The Allow-Events header field in the INVITE request with the value "conference" shall be supported at the roaming II-NNI and may be supported at the non-roaming II-NNI and for the loopback traversal scenario. + +## 12.20 Flexible Alerting (FA) + +Service specific requirements in accordance with 3GPP TS 24.239 [101] shall be supported over the II-NNI. + +The 486 (Busy Here) response code shall be supported at the II-NNI. + +SIP based user configuration as described in 3GPP TS 24.238 [100] shall be supported at the roaming II-NNI. + +## 12.21 Announcements + +### 12.21.1 General + +Announcements may be provided during the establishment of a communication session, during an established communication session or when a communication request is rejected. All of them shall be managed over the II-NNI. + +### 12.21.2 Providing announcements during the establishment of a communication session + +Procedures as described in 3GPP TS 24.628 [38] are used to provide announcements during the establishment of a communication session. + +There are two methods defined in 3GPP TS 24.628 [38] to provide the announcement: + +- 1) sending an announcement as an early media; and + +NOTE 1: There are two methods to use early media for sending the announcement in-band. First method is the gateway model defined by IETF RFC 3960 [150] and 3GPP TS 24.628 [38] annex G, second method is described in 3GPP TS 24.628 [38] annex D. + +- 2) sending an Alert-Info header field in 180 (Ringing) response to the INVITE request. + +The P-Early-Media header field authorizing early media as defined in IETF RFC 5009 [74] during the establishment of a communication shall be supported at the II-NNI. + +The Alert-Info header field in the 180 (Ringing) response to the INVITE request during the establishment of a communication, should be supported at the II-NNI. + +NOTE 2: The IBCF can decide to remove the Alert-Info header field if required by local policy. + +### 12.21.3 Providing announcements during an established communication session + +Procedures as described in 3GPP TS 24.628 [38] are used to provide announcements during an established communication session. + +In case of provision of an announcement to a user over the II-NNI during an established communication, the Call-Info header field in a re-INVITE request should be supported at the II-NNI. + +NOTE 1: An alternative method to provide announcements is to use the existing media stream. + +NOTE 2: The IBCF can decide to remove the Call-Info header field if required by local policy. + +### 12.21.4 Providing announcements when communication request is rejected + +Procedures as described in 3GPP TS 24.628 [38] are used to provide announcements when a communication request is rejected. + +There are three methods defined in 3GPP TS 24.628 [38] to provide the announcement: + +- 1) sending an announcement as an early media; + +NOTE 1: There are two methods to use early media for sending the announcement in-band. First method is the gateway model defined by IETF RFC 3960 [150] and 3GPP TS 24.628 [38] annex G, second method is described in 3GPP TS 24.628 [38] annex D. + +- 2) sending an Error-Info header field in the 3xx, 4xx, 5xx or 6xx response to the INVITE request; and + +- 3) accept the communication request and then provide the announcement. + +NOTE 2: The II-NNI requirements for accepting the communication request and then provide the announcement is not within the scope of this subclause. + +The P-Early-Media header field authorizing early media as defined in IETF RFC 5009 [74] and the Reason header field with the proper cause value shall be supported at the II-NNI. + +The Error-Info header field in the 3xx, 4xx, 5xx or 6xx response to the INVITE request when rejecting the communication request, should be supported at the II-NNI. + +NOTE 3: The IBCF can decide to remove the Error-Info header field if required by local policy. + +## 12.22 Advice Of Charge (AOC) + +Service specific requirements in accordance with 3GPP TS 24.647 [122] shall be supported over the II-NNI. + +The Accept header field with "application/vnd.etsi.aoc+xml" shall be supported at the roaming II-NNI. + +The INVITE method containing an "application/vnd.etsi.aoc+xml" MIME body shall be supported at the roaming II-NNI. + +Non-100 provisional responses and the 200 (OK) response to the initial INVITE request containing an "application/vnd.etsi.aoc+xml" MIME body shall be supported at the roaming II-NNI. + +The INFO method containing an "application/vnd.etsi.aoc+xml" MIME body shall be supported at the roaming II-NNI. + +The response code 504 (Server Time-out) shall be supported at the II-NNI. + +A Reason header field containing the protocol value set to "SIP" and the "cause" header field parameter set to "504" or containing the protocol value set to "Q.850" and the "cause" header field parameter set to "31" in the BYE method shall be supported at the II-NNI. + +An "application/vnd.etsi.aoc+xml" MIME body in the BYE request or the final response to the BYE request shall be supported over the roaming II-NNI. + +## 12.23 Completion of Communications on Not Logged-in (CCNL) + +Service specific requirements in accordance with 3GPP TS 24.642 [109] shall be supported over the II-NNI. + +The response code 480 (Temporarily unavailable) containing a Call-Info header field with a purpose parameter set to 'call-completion' and the "m" parameter set to "NL" shall be supported at the non-roaming II-NNI and for the loopback traversal scenario. + +For invoking and revoking of the CCNL supplementary service, announcement procedures shall be used to provide announcements and inband-interaction procedures as described in clause 12.21.3 and clause 12.21.4 shall be supported at the roaming II-NNI. + +The response code 199 (Early Dialog Terminated) shall be supported at the roaming II-NNI. + +Basic call procedures and in case of a call-completion recall initiated by a REFER request, normal REFER method handling procedures according to 3GPP TS 24.229 [5] shall be supported at the roaming II-NNI. + +As a network option the special REFER request handling procedures according to 3GPP TS 24.628 [38] should be supported at the roaming II-NNI. + +NOTE: 3rd party call control procedures can be used when the REFER request is not supported at the II-NNI. + +The SUBSCRIBE and NOTIFY methods according to IETF RFC 6665 [20] and 3GPP TS 24.229 [5] containing the event package name "call-completion" in the Event header field and the Call-Info header field with a purpose parameter set to 'call-completion' and the "m" parameter set to "NL" shall be supported at the non-roaming II-NNI and for the loopback traversal scenario. + +The NOTIFY request containing the "application/call-completion" MIME body as defined in IETF RFC 6910 [208] shall be supported at the non-roaming II-NNI. + +The Request-URI with the "m" SIP URI parameter with a value set to "NL" and the Call-Info header field with a purpose parameter set to 'call-completion' and the "m" parameter set to "NL" in the INVITE method shall be supported at the non-roaming II-NNI and for the loopback traversal scenario. + +The Date header field in the 480 (Temporarily Unavailable) response to the INVITE request shall be supported at the roaming II-NNI. + +SIP based user configuration as described in 3GPP TS 24.238 [100] shall be supported at the roaming II-NNI. + +## 12.24 Unstructured Supplementary Service Data (USSD) + +Service specific requirements in accordance with 3GPP TS 24.390 [163] shall be supported over the II-NNI. + +The Recv-Info header field containing the "g.3gpp.ussd" info package name and the "application/vnd.3gpp.ussd" MIME body as described in annex B of 3GPP TS 24.390 [163] in the INVITE request shall be supported at the roaming II-NNI. + +The Recv-Info header field containing the "g.3gpp.ussd" info package name in the 200 (OK) response to the INVITE request shall be supported at the roaming II-NNI. + +The INFO request containing "application/vnd.3gpp.ussd" MIME body and the Info-Package header field containing the "g.3gpp.ussd" info package name shall be supported at the roaming II-NNI. + +The "application/vnd.3gpp.ussd" MIME body in the BYE request shall be supported at the roaming II-NNI. + +## 12.25 Enhanced Calling Name (eCNAM) + +Service specific requirements in accordance with 3GPP TS 24.196 [217] shall be supported over the II-NNI. + +An initial INVITE request with: + +- a display-name in a From header field; + +- a display-name in a P-Asserted-Identity header field; and +- Call-Info header field(s), + +shall be supported at the roaming II-NNI in the direction from home to visited network. + +## 12.26 Multi-Device and Multi-Identity (MuD and MiD) + +### 12.26.1 Multi-Device (MuD) + +Service specific requirements in accordance with 3GPP TS 24.174 [218] shall be supported over the II-NNI. + +NOTE: No specific SIP signalling requirements exist for MuD over the II-NNI. + +### 12.26.2 Multi-Identity (MiD) + +Service specific requirements in accordance with 3GPP TS 24.174 [218] shall be supported over the II-NNI. + +An initial INVITE request, a REFER request and a MESSAGE request with an Additional-Identity header field (as defined in 3GPP TS 24.229 [5] subclause 7.2.20) shall be supported over the roaming II-NNI. + +# --- 13 Interoperability of IMS Centralized Services (ICS) over II-NNI + +## 13.1 General + +In order to assure the end-to-end service interoperability through the Inter-IMS Network to Network Interface (II-NNI), the associated service of the IMS Centralized Services (ICS) may be supported on the II-NNI between two IMS networks. The support of ICS is based on agreement between operators. + +If ICS is supported, the related procedures from the 3GPP TS 24.292 [121] and 3GPP TS 29.292 [130] shall be applied with the requirements in the clause 13.2 due to the crossing of the II-NNI. + +## 13.2 IMS Centralized Services (ICS) + +Service specific requirements in accordance with 3GPP TS 24.292 [121] and 3GPP TS 29.292 [130] shall be supported over the II-NNI. + +The "g.3gpp.ics" media feature tag in the Contact header field as specified in annex B of 3GPP TS 24.292 [121] shall be supported at the roaming II-NNI. + +The "g.3gpp.accesstype" media feature tag in the Contact header field as specified in annex B of 3GPP TS 24.292 [121] shall be supported at the roaming II-NNI. + +The "g.3gpp.icsi-ref" media feature tag as specified in 3GPP TS 24.229 [5] the value for the IMS Multimedia Telephony Communication Service as specified in 3GPP TS 24.173 [31] shall be supported at the roaming II-NNI. + +An Accept-Contact header field and a Reject-Contact header field including the media feature tag "g.3gpp.accesstype" and the media feature tag "g.3gpp.ics" in any combination in the INVITE request shall be supported at the roaming II-NNI. + +The Target-Dialog header field in the INVITE request shall be supported at the roaming II-NNI. + +The P-Early-Media header field in the INVITE request and in non-100 provisional responses to the INVITE request shall be supported on the roaming II-NNI. + +The Reason header field containing the protocol value "Q.850" and the header field parameter "cause" with a various set of values in the CANCEL request, the BYE request and in 4xx responses and 6xx responses to the INVITE request shall be supported at the roaming II-NNI. + +The REFER request with the "method" SIP URI parameter set to the value "BYE" or "INVITE" or without the "method" SIP URI parameter in the Refer-To header field as specified in 3GPP TS 24.292 [121] shall be supported at the roaming II-NNI. + +The Event header field containing the event package name "conference" and the Accept header field with "application/conference-info+xml" in a SUBSCRIBE request shall be supported at the roaming II-NNI. + +The Allow-Event header field with "application/conference-info+xml" in an INVITE request shall be supported at the roaming II-NNI. + +The "application/conference-info+xml" MIME body and the Event header field containing the event package name "conference" in a NOTIFY request shall be supported at the roaming II-NNI. + +NOTE: Supplementary services as specified in clause 12 can be supported based on agreement between operators. + +# --- 14 Interoperability of IMS Service Continuity over II-NNI + +## 14.1 General + +In order to assure the end-to-end service interoperability through the Inter-IMS Network to Network Interface (II-NNI), the associated services of the IMS Service Continuity may be supported on the II-NNI between two IMS networks. The support of each service is based on agreement between operators. + +If a service is supported, the related procedures from the 3GPP TS 24.237 [131] shall be applied with the requirements in the relevant clause below due to the crossing of the II-NNI. + +## 14.2 PS to CS Single Radio Voice Call Continuity (SRVCC) and Single Radio Video Call Continuity (vSRVCC) + +### 14.2.1 Basic PS to CS SRVCC + +Service specific requirements in accordance with 3GPP TS 24.237 [131] shall be supported over the roaming II-NNI. + +Media type "video" in SDP m-lines may be supported at the roaming II-NNI. Related SDP can appear in SDP offer answer exchanges within INVITE dialogues at the roaming II-NNI, and in responses to OPTIONS requests at the roaming II-NNI. If media type "video" is supported within INVITE dialogues at the roaming II-NNI, it shall also be supported within responses to OPTIONS requests at the roaming II-NNI. + +The "+g.3gpp.srvcc" header field parameter (specified in 3GPP TS 24.237 [131] annex C) in the Feature-Caps header field of the INVITE request and in non-100 provisional responses or the 2xx response should be supported at the roaming II-NNI. + +The Reason header field containing the protocol value set to "SIP" and "cause" header field parameter set to "487" in the re-INVITE request shall be supported at the roaming II-NNI. + +The Reason header field containing the protocol value set to "SIP" and "cause" header field parameter set to "503" in the BYE request shall be supported at the roaming II-NNI. + +Procedures as described in clause 14.4 are used to provide MSC server assisted mid-call features. + +### 14.2.2 PS to CS SRVCC for calls in alerting phase + +The requirements for the PS to CS transfer for alerting calls are the same as in clause 14.2.1 with the following additional requirements: + +The "g.3gpp.srvcc-alerting" media feature tag (described in 3GPP TS 24.237 [131] annex C) in a Contact header field of the INVITE request and in non-100 provisional responses and the 2xx response to the INVITE request shall be supported at the roaming II-NNI. + +The "+g.3gpp.srvcc-alerting" header field parameter (described in 3GPP TS 24.237 [131] annex C) included in a Feature-Caps header field as described in IETF RFC 6809 [143] in an INVITE request and in non-100 provisional + +responses and the 2xx response to the INVITE request or in the UPDATE request and in the 2xx response to the UPDATE request shall be supported at the roaming II-NNI. + +The Target-Dialog header field in the INVITE request shall be supported at the roaming II-NNI. + +An INFO request containing the Info-Package header field as specified in IETF RFC 6086 [39] with "3gpp.state-and-event" info package name and an "application/vnd.3gpp.state-and-event-info+xml" XML body shall be supported at the roaming II-NNI. + +### 14.2.3 Using the ATCF based architecture + +The requirements for the ATCF based architecture is the same as in clause 14.2.1 with the following additional requirements: + +The "+g.3gpp.atcf", the "+g.3gpp.atcf-mgmt-uri" and the "+g.3gpp.atcf-path" header field parameters (specified in 3GPP TS 24.237 [131] annex C) in the Feature-Caps header field of the REGISTER request as described in IETF RFC 6809 [143] shall be supported at the roaming II-NNI. + +A MESSAGE request containing the "application/vnd.3gpp.srvcc-info+xml" MIME body as defined in annex D of 3GPP TS 24.237 [131] shall be supported at the roaming II-NNI. + +The URIs of SCC ASs authorised to provide PS to CS SRVCC information in the MESSAGE request need to be specified in the roaming agreement. + +The Target-Dialog header field in the INVITE request shall be supported at the roaming II-NNI. + +### 14.2.4 PS to CS SRVCC for originating calls in pre-alerting phase + +The requirements for the PS to CS transfer for originating calls in pre-alerting phase are the same as in clause 14.2.1 and in clause 14.2.2 with the additional requirements in this subclause. + +NOTE: If PS to CS transfer for originating calls in pre-alerting phase is supported also PS to CS SRVCC for calls in alerting phase specified in clause 14.2.2 is supported. + +The "g.3gpp.ps2cs-srvcc-orig-pre-alerting" media feature tag described in 3GPP TS 24.237 [131] annex C in a Contact header field of the REGISTER request and in the INVITE request shall be supported at the roaming II-NNI. + +The "g.3gpp.ps2cs-srvcc-orig-pre-alerting" feature-capability indicator as described in 3GPP TS 24.237 [131] annex C in the Feature-Caps header field as described in IETF RFC 6809 [143] in non-100 provisional responses and the 2xx response to the INVITE request and in any target refresh request and in non-100 provisional responses or the 2xx response to target refresh request shall be supported at the roaming II-NNI. + +### 14.2.5 PS to CS SRVCC with the MSC server assisted mid-call feature + +The requirements for the PS to CS SRVCC with the assisted mid-call feature are the same as in clause 14.2.1 and in clause 14.4. + +### 14.2.6 PS to CS SRVCC for terminating calls in pre-alerting phase + +The requirements for the PS to CS transfer for terminating calls in pre-alerting phase are the same as in subclause 14.2.1 and in subclause 14.2.2 with the additional requirements in this subclause. + +NOTE: If PS to CS transfer for terminating calls in pre-alerting phase is supported also PS to CS SRVCC for calls in alerting phase specified in subclause 14.2.2 is supported. + +The "g.3gpp.ps2cs-srvcc-term-pre-alerting" media feature tag described in 3GPP TS 24.237 [131] annex C in a Contact header field of the REGISTER request and in the INVITE request shall be supported at the roaming II-NNI. + +The g.3gpp.ps2cs-srvcc-term-pre-alerting feature-capability indicator as described in 3GPP TS 24.237 [131] annex C in the Feature-Caps header field as described in IETF RFC 6809 [143] in non-100 provisional responses and the 2xx response to the INVITE request and in any target refresh request and in non-100 provisional responses or the 2xx response to target refresh request shall be supported at the roaming II-NNI. + +## 14.3 Inter UE Transfer (IUT) + +IUT is described in clause 18. + +## 14.4 MSC server assisted mid-call feature + +Service specific requirements in accordance with 3GPP TS 24.237 [131] shall be supported over the roaming II-NNI. + +The Contact header field of the REGISTER request and the 200 (OK) response containing "g.3gpp.mid-call" media feature tag as described in annex C of 3GPP TS 24.237 [131] shall be supported at the roaming II-NNI. + +The Feature-Cap header field of the REGISTER request and the 200 (OK) response containing "+g.3gpp.mid-call" header field parameter specified in annex C of 3GPP TS 24.237 [131] shall be supported at the roaming II-NNI. + +The media feature tag "g.3gpp.accesstype" in the Contact header field of the REGISTER request shall be supported at roaming II-NNI. + +A Contact header field of the INVITE request and the 200 (OK) response containing the "g.3gpp.mid-call" media feature tag as described in annex C of 3GPP TS 24.237 [131] shall be supported at the roaming II-NNI. + +The "g.3gpp.mid-call" feature-capability indicator according to 3GPP TS 24.237 [131] annex C included in the Feature-Caps header field of the INVITE request, in responses to the INVITE request and in any target refresh request and in non-100 provisional responses or the 2xx response to target refresh request shall be supported at the roaming II-NNI. + +The Recv-Info header field containing the "g.3gpp.mid-call" package name in the INVITE request as specified in annex D of 3GPP TS 24.237 [131] shall be supported at the roaming II-NNI. + +An Accept header field in the INVITE request containing the MIME type "application/vnd.3gpp.mid-call+xml" as specified in clause D.1 of 3GPP TS 24.237 [131] shall be supported at the roaming II-NNI. + +The "application/vnd.3gpp.mid-call+xml" MIME body described in clause D.1.3 of 3GPP TS 24.237 [131] in the INVITE request shall be supported at the roaming II-NNI. + +The SUBSCRIBE request containing a "g.3gpp.mid-call" media feature tag in the Contact header field shall be supported at the roaming II-NNI. + +NOTE: The "g.3gpp.mid-call" media feature tag in the Contact header field of the SUBSCRIBE request may appear if the CONF supplementary service is supported at roaming II-NNI as described in clause 12.9. + +An INFO request containing the Info-Package header field as specified in IETF RFC 6086 [39] with "3gpp.state-and-event" info package name and an "application/vnd.3gpp.state-and-event-info+xml" XML body shall be supported at the roaming II-NNI. + +A REFER request sent inside an existing SIP dialog containing the "application/vnd.3gpp.mid-call+xml" MIME body specified in the clause D.1.3 of 3GPP TS 24.237 [131] shall be supported at the roaming II-NNI. + +The Contact header field of the REFER request and the 2xx response to the request containing "g.3gpp.mid-call" media feature tag as described in annex C of 3GPP TS 24.237 [131] shall be supported at the roaming II-NNI. + +The Target-Dialog header field in the INVITE request shall be supported at the roaming II-NNI. + +The communication HOLD supplementary service as specified in clause 12.8 for the roaming II-NNI shall be supported. + +The Allow-Event header field with "application/conference-info+xml" in an INVITE request shall be supported at the roaming II-NNI. + +The Event header field containing the event package name "conference" and the Accept header field with "application/conference-info+xml" in a SUBSCRIBE request shall be supported at the roaming II-NNI. + +The "application/conference-info+xml" MIME body and the Event header field containing the event package name "conference" in a NOTIFY request shall be supported at the roaming II-NNI. + +The REFER request with the "method" header field parameter set to the value "BYE" sent in the Refer-To header field shall be supported at the roaming II-NNI. + +## 14.5 CS to PS Single Radio Voice Call Continuity (SRVCC) + +### 14.5.1 Basic CS to PS SRVCC + +Service specific requirements in accordance with 3GPP TS 24.237 [131] shall be supported over the roaming II-NNI. + +Requirements for the ATCF based architecture at II-NNI as described in clause 14.2.3 shall be supported at the roaming II-NNI. + +Requirements for IMS Centralized Services (ICS) at II-NNI as described in clause 13 shall be supported at the roaming II-NNI. + +The "g.3gpp.cs2ps-srvcc" and "g.3gpp.path" media feature tags in the Contact header field of the REGISTER request shall be supported at the roaming II-NNI. + +The Feature-Caps header field with the "g.3gpp.cs2ps-srvcc" feature-capability indicator in the REGISTER request shall be supported at the roaming II-NNI. + +The MESSAGE request containing the Accept-Contact header field with the "g.3gpp.path" media feature tag and the "application/vnd.3gpp.srvcc-ext+xml" MIME body shall be supported at the roaming II-NNI. + +The URIs of SCC ASs authorised to provide CS to PS SRVCC information in the MESSAGE request need to be specified in the roaming agreement. + +### 14.5.2 CS to PS SRVCC for calls in alerting phase + +The requirements for the CS to PS SRVCC for calls in alerting phase are the same as in clause 14.5.1 with the following additional requirement: + +The "g.3gpp.cs2ps-srvcc-alerting" media feature tag in the Contact header field of the REGISTER request shall be supported at the roaming II-NNI. + +The REFER request sent inside an existing SIP dialog with the Refer-Sub header field and the "application/vnd.3gpp.state-and-event-info+xml" MIME body shall be supported at the roaming II-NNI. + +The INFO request with the Info-Package header field containing the "g.3gpp.state-and-event" package name and the "application/vnd.3gpp.state-and-event-info+xml" MIME body shall be supported at the roaming II-NNI. + +### 14.5.3 CS to PS SRVCC with the assisted mid-call feature + +The requirements for the CS to PS SRVCC with the assisted mid-call feature are the same as in clause 14.5.1 with the following additional requirement: + +The "application/vnd.3gpp.access-transfer-events+xml" MIME body in the REFER request shall be supported at the roaming II-NNI. + +## 14.6 PS to CS dual radio voice call continuity (DRVCC) + +### 14.6.1 Basic PS to CS DRVCC + +Service specific requirements in accordance with 3GPP TS 24.237 [131] shall be supported over the roaming II-NNI. + +The "g.3gpp.dynamic-stn" media feature tag according to 3GPP TS 24.237 [131] annex C included in the Contact header field of the INVITE request and in responses to the INVITE request shall be supported at the roaming II-NNI. + +The "g.3gpp.dynamic-stn" feature-capability indicator according to 3GPP TS 24.237 [131] annex C included in the Feature-Caps header field of the INVITE request, in responses to the INVITE request and in any target refresh request and in non-100 provisional responses or the 2xx response to target refresh request shall be supported at the roaming II-NNI. + +NOTE 1: The g.3gpp.dynamic-stn feature capability indicator from the home network contains an STN. The STN is a tel URI that the UE will use when establishing the call in CS. If the STN is known by the visited network the STN can also be used to identify that a call from a UE is a PS to CS dual radio access transfer allowing the visited network to suppress services and announcement that otherwise is executed during the CS call setup. The value of the tel URI STN needs to be communicated between operators when DRVCC is supported. + +The requirements for providing IMS Centralized Services (ICS) as described in clause 13.2 should be supported at the roaming II-NNI. + +NOTE 2: The support of IMS Centralized Services (ICS) as described in clause 13.2 is only needed if MSC servers in the visited network are enhanced for ICS. + +### 14.6.2 PS to CS DRVCC with the assisted mid-call feature + +The requirements for the PS to CS DRVCC with the assisted mid-call feature are the same as in clause 14.6.1 and in clause 14.4. + +NOTE: Transfer of an additional call requires the use of IMS Centralized Services (ICS). + +### 14.6.3 PS to CS DRVCC for calls in alerting phase + +The requirements for the PS to CS DRVCC for calls in alerting phase are the same as in clause 14.6.1 with the additional requirements in this subclause. + +The "g.3gpp.drvcc-alerting" media feature tag according to 3GPP TS 24.237 [131] annex C and IETF RFC 3840 [56] included in the Contact header field of the INVITE request and in responses to the INVITE request shall be supported at the roaming II-NNI. + +The "g.3gpp.drvcc-alerting" feature-capability indicator according to 3GPP TS 24.237 [131] annex C included in the Feature-Caps header field of the INVITE request, in responses to the INVITE request and in any target refresh request and in non-100 provisional responses or the 2xx response to target refresh request shall be supported at the roaming II-NNI. + +A 488 (Not Acceptable Here) response to the INVITE request without an SDP body shall be supported at the roaming II-NNI. + +### 14.6.4 PS to CS DRVCC for originating calls in pre-alerting phase + +The requirements for the PS to CS DRVCC for originating calls in pre-alerting phase are the same as in clause 14.6.1 and in clause 14.6.3 with the additional requirements in this subclause. + +The "g.3gpp.ps2cs-drvcc-orig-pre-alerting" media feature tag according to 3GPP TS 24.237 [131] annex C and IETF RFC 3840 [56] in the Contact header field of the INVITE request shall be supported at the roaming II-NNI. + +The "g.3gpp.ps2cs-drvcc-orig-pre-alerting" feature-capability indicator according to 3GPP TS 24.237 [131] annex C included in the Feature-Caps header field of the INVITE request, in responses to the INVITE request and in any target refresh request and in non-100 provisional responses or the 2xx response to target refresh request shall be supported at the roaming II-NNI. + +## 14.7 CS to PS Dual Radio Voice Call Continuity (DRVCC) + +### 14.7.1 Basic CS to PS DRVCC + +Service specific requirements in accordance with 3GPP TS 24.237 [131] shall be supported over the roaming II-NNI. + +The requirements for providing IMS Centralized Services (ICS) as described in clause 13.2 should be supported at the roaming II-NNI. + +NOTE: The support of IMS Centralized Services (ICS) as described in clause 13.2 is only needed if MSC servers in the visited network are enhanced for ICS. + +### 14.7.2 CS to PS DRVCC with the assisted mid-call feature + +The requirements for the PS to CS DRVCC with the assisted mid-call feature are the same as in clause 14.7.1 and in clause 14.4. + +### 14.7.3 CS to PS DRVCC for calls in alerting phase + +The requirements for the CS to PS DRVCC for calls in alerting phase are the same as in clause 14.7.1 with the additional requirements in this subclause. + +The "g.3gpp.cs2ps-drvcc-alerting" media feature tag as described included in the Contact header field of the INVITE request and in responses to the INVITE request shall be supported at the roaming II-NNI. + +The "g.3gpp.cs2ps-drvcc-alerting" feature-capability indicator according to 3GPP TS 24.237 [131] annex C included in the Feature-Caps header field of the INVITE request, in responses to the INVITE request and in any target refresh request and in non-100 provisional responses or the 2xx response to target refresh request shall be supported at the roaming II-NNI. + +A 488 (Not Acceptable Here) response to the INVITE request without an SDP body shall be supported at the roaming II-NNI. + +### 14.7.4 CS to PS DRVCC for originating calls in pre-alerting phase + +The requirements for the CS to PS DRVCC for originating calls in pre-alerting phase are the same as in clause 14.7.1 and in clause 14.7.3 with the following additional requirements: + +The "g.3gpp.cs2ps-drvcc-orig-pre-alerting" media feature tag according to 3GPP TS 24.237 [131] annex C and IETF RFC 3840 [56] in the Contact header field of the INVITE request shall be supported at the roaming II-NNI. + +The "g.3gpp.cs2ps-drvcc-orig-pre-alerting" feature-capability indicator according to 3GPP TS 24.237 [131] annex C included in the Feature-Caps header field of the INVITE request, in responses to the INVITE request and in any target refresh request and in non-100 provisional responses or the 2xx response to target refresh request shall be supported at the roaming II-NNI. + +## 14.8 PS to PS access transfer + +Service specific requirements in accordance with 3GPP TS 24.237 [131] clause 10 shall be supported over the roaming II-NNI. + +The "g.3gpp.pstops-sti" media feature tag in the Contact header field of the REGISTER request shall be supported at the roaming II-NNI. + +The INVITE request containing: + +- a) the "g.3gpp.ics" media feature tag; and +- b) either: + - the Replaces header field and the option tag value "replaces" in the Require header field; or + - the Target-Dialog header field and the option tag value "tdialog" in the Require header field, + +shall be supported at the roaming II-NNI. + +A Recv-Info header field containing the "g.3gpp.state-and-event" info package name in the 183 (Session Progress) response shall be supported at the roaming II-NNI. + +The INFO request containing the Info-Package header field as specified in IETF RFC 6086 [39] with the "g.3gpp.state-and-event" info package name and the "application/vnd.3gpp.state-and-event-info+xml" XML body shall be supported at the roaming II-NNI. + +# 15 Presence service + +## 15.0 General + +In order to assure the end-to-end service interoperability through the Inter-IMS Network to Network Interface (II-NNI), the associated functions of the Presence service may be supported on the II-NNI between two IMS networks. The support of each function is based on agreement between operators. + +If a function is supported, the related procedures from the 3GPP TS 24.141 [132] shall be applied with the requirements in the relevant clause below due to the crossing of the II-NNI. + +## 15.1 Subscription of presence information + +Service specific requirements in accordance with 3GPP TS 24.141 [132] shall be supported over the II-NNI. + +A PUBLISH request identifying the presentity using a SIP URI, a tel URI or a PRES URI and the Event header field with the value "presence" and containing an "application/pidf+xml" MIME body shall be supported at the roaming II-NNI. + +Additionally to the above and in any combination, a Content-Type header field with the value "multipart/related" and an "application/pidf-diff+xml" MIME body can be included in the PUBLISH request and shall be supported at the roaming II-NNI. + +A SUBSCRIBE request with a Request-URI containing a SIP URI, a tel URI or a pres URI, the Event header field set to "presence" and Accept header fields with values "application/pidf+xml" and "multipart/related" shall be supported at the II-NNI. + +Additionally to the above an "application/simple-filter+xml" MIME body can appear in the SUBSCRIBE request and shall be supported at the II-NNI. + +Additionally to the above and in any combination a Content-Type header field with the value "multipart/mixed" and an "application/resource-lists" MIME body can appear in the SUBSCRIBE request and shall be supported at the roaming II-NNI. + +A NOTIFY request including an Event header field with the value "presence" and an "application/pidf" MIME body shall be supported at the II-NNI. + +NOTE: The NOTIFY request can contain substantial amount of data and TCP is expected to be used as the transport protocol. + +The Allow-Events header field with the value "presence" shall be supported at the roaming II-NNI and may be supported at the non-roaming II-NNI. + +## 15.2 Watcher subscribing to Presence List + +Service specific requirements in accordance with 3GPP TS 24.141 [132] shall be supported over the II-NNI. + +The requirements for the watcher subscribing to the Presence List are the same as subscribing to presence information as specified in clause 15.1 with the following additional requirement: + +- The SUBSCRIBE request containing a Supported header field with the value "eventlist" shall also be supported at the roaming II-NNI; +- The SUBSCRIBE request containing a Accept header field with the value "application/rlmi+xml" shall be supported at the roaming II-NNI; +- A response code 200 (OK) to the SUBSCRIBE request containing the Require header field with the value "eventlist" shall be supported at the roaming II-NNI; and +- A NOTIFY message containing the "multipart/related" content type and an "application/rlmi+xml" MIME body shall be supported at the roaming II-NNI. + +NOTE: The NOTIFY request can contain substantial amount of data and TCP is expected to be used as the transport protocol. + +## 15.3 Subscription to Watcher Information + +Service specific requirements in accordance with 3GPP TS 24.141 [132] shall be supported over the II-NNI. + +A SUBSCRIBE request containing an Event header field with the value "presence.wininfo" and an Accept header field with value "application/watcherinfo+xml" shall be supported at the roaming II-NNI. + +A NOTIFY request containing the Event header field with the value "presence.wininfo" and an "application/watcherinfo+xml" MIME body shall be supported at the roaming II-NNI. + +NOTE: The NOTIFY request can contain substantial amount of data and TCP is expected to be used as the transport protocol. + +The Allow-Events header field with the value "presence.wininfo" shall be supported at the roaming II-NNI and may be supported at the non-roaming II-NNI. + +## 15.4 Subscription to state changes in XML documents + +Service specific requirements in accordance with 3GPP TS 24.141 [132] shall be supported over the II-NNI. + +A SUBSCRIBE request containing the Event header field with the value "xcap-diff" and parameters specified in IETF RFC 5875 [134], using the updated procedures from IETF RFC 6665 [20], shall be supported at the roaming II-NNI. + +A NOTIFY request containing the Event header field with the value "xcap-diff", the Content-Type header field with the value "multipart/mixed" and any MIME body shall be supported at the roaming II-NNI. + +NOTE: The NOTIFY request can contain substantial amount of data and TCP is expected to be the transport protocol. + +The Allow-Events header field with the value "xcap-diff" shall be supported at the roaming II-NNI and may be supported at the non-roaming II-NNI. + +For backward compatible reasons the Event header field with the value "ua-profile" should be supported at the roaming II-NNI. + +## 15.5 Presence enhancements specified in Open Mobile Alliance (OMA) Release 1.1 + +### 15.5.1 General + +In order to assure the end-to-end service interoperability through the Inter-IMS Network to Network Interface (II-NNI), the associated functions of the OMA Presence service may be supported on the II-NNI between two IMS networks. The support of each function is based on agreement between operators. + +If a function of the OMA Presence Release 1.1 is supported, the related procedures from the OMA-TS-Presence\_SIMPLE-V1\_1\_1 [142] shall be applied with the requirements in the relevant clause below due to the crossing of the II-NNI. + +### 15.5.2 OMA subscription of presence information + +The requirements for the OMA subscription of presence information are the same as clause 15.1. + +### 15.5.3 OMA watcher subscribing to Presence List + +The requirements for the OMA watcher subscribing to Presence List are the same as clause 15.2. + +### 15.5.4 OMA subscription to Watcher Information + +The requirements for the OMA subscription to Watcher Information are the same as clause 15.3. + +## 15.6 Presence enhancements specified in Open Mobile Alliance (OMA) Release 2.0 + +### 15.6.1 General + +In order to assure the end-to-end service interoperability through the Inter-IMS Network to Network Interface (II-NNI), the associated functions of the OMA Presence service may be supported on the II-NNI between two IMS networks. The support of each function is based on agreement between operators. + +If a function of the OMA Presence Release 2.0 is supported, the related procedures from the OMA-TS-Presence\_SIMPLE-V2\_0 [138] shall be applied with the requirements in the relevant clause below due to the crossing of the II-NNI. + +### 15.6.2 OMA subscription of presence information + +The requirements for the OMA subscription of presence information are the same as clause 15.5.2 with the following additional requirement: + +- An Allow header field containing the value "REFER" in a PUBLISH request shall be supported at the II-NNI. +- A Policy-Contact header field defined in IETF RFC 6794 [133] in a 488 (Not Acceptable Here) response to a PUBLISH request shall be supported at the II-NNI. + +NOTE: Conveyance of this header field in a 488 response to a PUBLISH request is not supported by IETF RFC 6794 [133] but is required to support Presence services according to OMA specifications OMA-TS-Presence\_SIMPLE-V2\_0 [138]. + +- A Suppress-If- Match header field in a SUBSCRIBE request shall be supported at the II-NNI. +- An Accept-Encoding header field containing the value "gzip" in a SUBSCRIBE request shall be supported at the II-NNI. +- An "application/vnd.oma.suppnot+xml" MIME body in a SUBSCRIBE request shall be supported at the II-NNI. +- A Content-Encoding header field containing the value "gzip" in a NOTIFY request shall be supported at the II-NNI. +- A Content-Type header field with the value "multipart/mixed" in a SUBSCRIBE request shall be supported at the II-NNI. +- A Refer-To header field with the value "method=PUBLISH?event=presence", a Refer-Sub header field and a SIP-If-Match header field in a REFER request shall be supported at the II-NNI. + +### 15.6.3 OMA watcher subscribing to Presence List + +The requirements for the OMA watcher subscribing to Presence List are the same as clause 15.5.3 with the following additional requirements: + +- A Suppress-If-Match header field in a SUBSCRIBE request shall be supported at the II-NNI. +- An Accept-Encoding header field containing the value "gzip" in a SUBSCRIBE request shall be supported at the II-NNI. +- An "application/vnd.oma.suppnot+xml" MIME body in a SUBSCRIBE request shall be supported at the II-NNI. +- An "application/resource-lists+xml" MIME body in a SUBSCRIBE request shall be supported at the II-NNI. +- A Content-Type header field with the value "multipart/mixed" in a SUBSCRIBE request shall be supported at the II-NNI. + +- A NOTIFY request with a Content-Encoding header field containing the value "gzip" shall be supported at the II-NNI. + +### 15.6.4 OMA subscription to Watcher Information + +The requirements for the OMA subscription to Watcher Information are the same as clause 15.5.4 with the following additional requirements: + +- Indicating support for "multipart/mixed" and "application/simple-filter+xml" in the Accept header field of the SUBSCRIBE request shall be supported at the II-NNI. +- Multiple "application/simple-filter+xml" MIME bodies in the NOTIFY request shall be supported at the II-NNI. +- A Suppress-If-Match header field in a SUBSCRIBE request shall be supported at the II-NNI. +- An Accept-Encoding header field containing the value "gzip" in the SUBSCRIBE request shall be supported at the II-NNI. +- A Content-Type header field with the value "multipart/mixed" in a NOTIFY request shall be supported at the II-NNI. +- A Content-Encoding header field with the value "gzip" in a NOTIFY request shall be supported at the II-NNI. +- A Refer-To header field with the value "method=SUBSCRIBE?Event=presence.wininfo" and a Refer-Sub header field in a REFER request sent to a Watcher Information Subscriber shall be supported at the II-NNI. + +### 15.6.5 Subscription to state changes in XML documents + +The requirements for the OMA watcher subscribing to Presence List are the same as clause 15.4 with the following additional requirements: + +- An Accept header field indicating the support for "application/xcap-diff+xml", "application/rlmi+xml" and "multipart/related" in a SUBSCRIBE request shall be supported at the II-NNI. +- An Accept-Encoding header field with the value "gzip" in a SUBSCRIBE request shall be supported at the II-NNI. +- A Content-Encoding header field containing the value "gzip" in a NOTIFY request shall be supported at the II-NNI. +- Multiple "multipart/related" MIME bodies in a NOTIFY request shall be supported at the II-NNI. +- An "application/rlmi+xml" MIME bodies in a NOTIFY request shall be supported at the II-NNI. + +### 15.6.6 Void + +### 15.6.7 Void + +# --- 16 Messaging service + +## 16.1 General + +In order to assure the end-to-end service interoperability through the Inter-IMS Network to Network Interface (II-NNI), the associated function of the messaging service may be supported on the II-NNI between two IMS networks. + +If a function is supported, the related procedures from the 3GPP TS 24.247 [139] shall be applied with the requirements in the relevant clause below due to the crossing of the II-NNI. + +## 16.2 Page-mode messaging + +Service specific requirements in accordance with clause 5 of 3GPP TS 24.247 [139] shall be supported over the II-NNI. + +A MESSAGE request containing the "application/recipient-list" MIME body specified in IETF RFC 5365 [67], a Required header field with the 'recipient-list-message' option-tag; and a body carrying payload shall be supported at the roaming II-NNI. + +A MESSAGE request containing: + +- a body that carrying payload; or +- the "application/im-iscomposing+xml" MIME body, + +shall be supported at the II-NNI. + +The response code 415 (Unsupported Media Type) and the response code 202 (Accepted) shall be supported at the II-NNI. + +## 16.4 Session-mode messaging + +Service specific requirements in accordance with clause 6 of 3GPP TS 24.247 [139] shall be supported over the II-NNI. + +No restrictions at the II-NNI identified. + +## 16.5 Session-mode messaging conferences + +Service specific requirements in accordance with clause 7 of 3GPP TS 24.247 [139] and 3GPP TS 24.147 [106] shall be supported over the II-NNI. + +The "application/resource-lists+xml" MIME body included in the INVITE request shall be supported at the roaming II-NNI. + +The media feature tag "isfocus" in the Contact header field of the INVITE request and responses to the INVITE request shall be supported at the II-NNI. + +The SUBSCRIBE request including the "conference" event package name in the Event header field and the Accept header field containing an "application/conference-info+xml" MIME type shall be supported at the II-NNI. + +The NOTIFY request including an "application/conference-info+xml" MIME body shall be supported at the II-NNI. + +The REFER request containing a Referred-By header field and NOTIFY requests procedures shall be supported at the II-NNI. + +The REFER request containing the BYE method URI parameter in the Refer-To header field shall be supported at the II-NNI. + +The Referred-By header field in the INVITE request shall be supported at the II-NNI. + +The Allow-Events header field in the INVITE request with the value "conference" shall be supported at the roaming II-NNI and may be supported at the non-roaming II-NNI. + +# --- 17 Optimal Media Routeing + +## 17.1 General + +Based on inter-operator agreement, the Optimal Media Routeing (OMR) procedures may be supported over the II-NNI. + +If OMR procedures are supported, the procedures in 3GPP TS 29.079 [148] shall be applied and the capabilities below shall be provided at the II-NNI. + +## 17.2 OMR related SDP attributes + +The "visited-realm", "secondary-realm", "omr-codecs", "omr-m-att", "omr-s-att", "omr-m-bw", "omr-s-bw", "omr-s-cksum", and "omr-m-cksum" SDP attributes defined in 3GPP TS 24.229 [5] shall be supported at the II-NNI. + +## 17.3 IP realm names + +Operators need to agree on unique names for IP realms (as defined in 3GPP TS 29.079 [148]) used in their own and interconnecting networks to avoid a collision of IP realm names. Operators may choose to share an IP realm, and shall then also assign a single unique name to that realm. As defined in 3GPP TS 24.229 [5], a public IPv4 or IPv6 address reachable from the open internet is associated with the special realm "IN". + +# --- 18 Inter-UE transfer (IUT) + +## 18.1 General + +Inter-UE transfer may be supported over the II-NNI. The IUT consist of several functional blocks, as described in the clauses below. The support of each of these functional blocks is based on agreement between operators. + +If a function is supported, the related procedures from the 3GPP TS 24.337 [149] shall be applied with the requirements in the relevant clause below. + +## 18.2 IUT without establishment of a collaborative session + +Service specific requirements in accordance with 3GPP TS 24.337 [149] shall be supported over the II-NNI. + +The REFER request shall be supported at the roaming II-NNI. + +The Refer-To header field containing a body parameter including a Replaces header field and the Require header field set to "replaces" shall be supported at the roaming II-NNI. + +The Refer-To header field containing a body parameter including a Target-Dialog header field and the Require header field set to "tdialog" shall be supported at the roaming II-NNI. + +The Refer-To header field containing a body parameter including an Accept-Contact header field with the "g.3gpp.icsi-ref" media feature tag and a P-Preferred-Service header field set to the IMS communication service identifier shall be supported at the roaming II-NNI. + +The Contact header field of the REFER request containing a public GRUU or temporary GRUU as specified in 3GPP TS 24.229 [5] shall be supported at the roaming II-NNI. + +The "g.3gpp.icsi-ref" media feature tag in the Accept-Contact header field of the REFER request shall be supported at the roaming II-NNI. + +NOTIFY requests containing a "sipfrag" MIME body as specified in IETF RFC 3515 [22], using the updated procedures from IETF RFC 6665 [20], shall be supported at the roaming II-NNI. + +## 18.3 IUT using a collaborative session + +### 18.3.1 Collaborative session of participants of the same subscription + +This clause describes the requirements at the II-NNI for an ongoing session. Service specific requirements in accordance with 3GPP TS 24.337 [149] shall be supported over the II-NNI. + +The "g.3gpp.iut-controller" media feature tag in the Accept-Contact header field in the REGISTER request shall be supported. + +A REFER request sent outside an existing dialog shall be supported at the roaming II-NNI with the following additional requirements: + +- The Refer-To header field containing a body parameter including a MIME sdp body and no method parameter, the method parameter set to "INVITE" or "BYE" shall be supported at the roaming II-NNI. +- The Accept header field containing the MIME type "message/sipfrag" in the REFER request shall be supported at the roaming II-NNI. +- The Target-Dialog header field in the REFER request shall be supported at the roaming II-NNI. + +- The Contact header field in the REFER request containing the "g.3gpp.iut-controller" media feature tag as described in annex B of 3GPP TS 24.337 [149] shall be supported at the roaming II-NNI. +- The Contact header field in the REFER request containing the "g.3gpp.current-iut-controller" media feature tag as described in annex B of 3GPP TS 24.337 [149] shall be supported at the roaming II-NNI. +- The "g.3gpp.iut-controller" media feature tag in the Accept-Contact header field shall be supported at the roaming II-NNI. +- The Referred-By header field shall be supported at the roaming II-NNI at the roaming II-NNI. + +The NOTIFY request containing a "sipfrag" MIME body as specified in IETF RFC 3515 [22], using the updated procedures from IETF RFC 6665 [20], shall be supported at the roaming II-NNI. + +Initial INVITE requests and re-INVITE requests as follows: + +- The Referred-By header field included in initial INVITE requests and re-INVITE requests shall be supported at the roaming II-NNI; +- The "g.3gpp.iut-controller" media feature tag as described in annex B of 3GPP TS 24.337 [149] in the Contact header field shall be supported at the roaming II-NNI. + +The "g.3gpp.iut-controller" media feature tag in responses to the INVITE request shall be supported at the roaming II-NNI. + +The SUBSCRIBE request including the Event header field with the "dialog" event package; and including the Accept-Contact header field with the "g.3gpp.iut-focus" media feature shall be supported at the roaming II-NNI. + +The "dialog-info+xml" MIME body in NOTIFY requests shall be supported at the roaming II-NNI. + +### 18.3.2 Establishment of a collaborative session during session setup + +Service specific requirements in accordance with 3GPP TS 24.337 [149] shall be supported over the II-NNI. + +The Accept header field containing the MIME type "application/vnd.3gpp.iut+xml" in initial INVITE requests shall be supported at the roaming II-NNI. + +A Content-Type header field containing the MIME type "application/vnd.3gpp.iut+xml" and an "application/vnd.3gpp.iut+xml" MIME body in the 300 (Multiple Choices) response shall be supported at the roaming II-NNI. + +### 18.3.3 Assignment and transfer of control of a collaborative session + +Service specific requirements in accordance with 3GPP TS 24.337 [149] shall be supported over the II-NNI. + +The "g.3gpp.current-iut-controller" media feature tag in the Contact header field of the 200 (OK) response to INVITE request shall be supported at the roaming II-NNI. + +A "multipart/mixed" MIME body containing the "application/vnd.3gpp.iut+xml" and the "application/sdp" MIME bodies in the INVITE request shall be supported at the roaming II-NNI. + +### 18.3.4 Collaborative session of participants of different subscriptions + +Service specific requirements in accordance with 3GPP TS 24.337 [149] shall be supported over the II-NNI. + +In addition to the requirements in clause 18.3.1, 18.3.2 or 18.3.3 the following applies: + +- The "g.3gpp.iut-focus" media feature tag (specified in 3GPP TS 24.337 [149] annex B) in the Contact header field shall be supported at the non-roaming II-NNI and for the loopback traversal scenario. +- The "+g.3gpp.iut-focus" header field parameter (specified in 3GPP TS 24.337 [149] annex B) in the Feature-Caps header field as described in IETF RFC 6809 [143] shall be supported at the non-roaming II-NNI and for the loopback traversal scenario. + +## 18.4 Session replication / media replication + +### 18.4.1 Pull mode + +Service specific requirements in accordance with 3GPP TS 24.337 [149] shall be supported over the II-NNI. + +The Target-Dialog header field and the Accept-Contact header field containing the "g.3gpp.iut-focus" media feature tag of the INVITE request shall be supported at the roaming II-NNI. + +A REFER request including: + +- the method parameter set to "MESSAGE" in the Refer-To header field; +- the In-Reply-To header field; +- the Target-Dialog header field; +- the Require header field populated with the option tag value "tdialog"; and +- the "application/vnd.3gpp.replication+xml" MIME body, + +shall be supported at the roaming II-NNI. + +A MESSAGE request including the In-Reply-To header field and the "application/vnd.3gpp.replication+xml" MIME body shall be supported at the roaming II-NNI. + +### 18.4.2 Push mode + +Service specific requirements in accordance with 3GPP TS 24.337 [149] shall be supported over the II-NNI. + +A REFER request including: + +- the Accept-Contact header field containing the "g.3gpp.iut-focus" media feature tag with explicit and require tags; +- the Target-Dialog header field; and +- the Refer-To header field containing the Accept-Contact header field, the P-Preferred-Service header field and the "application/sdp" MIME body, + +shall be supported at the roaming II-NNI. + +The "application/vnd.3gpp.replication+xml" MIME body of the REFER request shall be supported at the roaming II-NNI. + +# --- 19 Roaming Architecture for Voice over IMS with Local Breakout + +Based on inter-operator agreement, the roaming architecture for voice over IMS with local breakout procedure may be supported over the II-NNI. + +If the roaming architecture for voice over IMS with local breakout procedure is supported, the procedures in 3GPP TS 24.229 [5] shall be applied and the capabilities below shall be provided at the II-NNI. + +The "+g.3gpp.trf" header field parameter (defined in 3GPP TS 24.229 [5] clause 7.9A.3) with a TRF address included in a Feature-Caps header field as described in IETF RFC 6809 [143] in the INVITE request or in the UPDATE request and in the 2xx response to the UPDATE request shall be supported at the roaming II-NNI. + +The "+g.3gpp.loopback" header field parameter (defined in 3GPP TS 24.229 [5] clause 7.9A.4) with the identity of the caller's home network included in the Feature-Caps header field as described in IETF RFC 6809 [143] in the INVITE request or in the UPDATE request and in the 2xx response to the UPDATE request shall be supported for the loopback traversal scenario. + +The "loopback-indication" header field parameter (defined in 3GPP TS 24.229 [5] subclause 7.2A.5) included the P-Charging-Vector header field in 18x and 2xx responses to the INVITE request , in subsequent requests and in responses to subsequent requests shall be supported for the loopback traversal scenario and at the roaming II-NNI. + +The procedures in clause 17 shall be supported at the II-NNI. + +# --- 20 Delivery of Media Resource Broker address information + +Based on inter-operator agreement, the procedure to deliver MRB address information may be supported over the roaming II-NNI. + +NOTE: Subsequent interaction between home network MRB and visited network MRB is outside the scope of this document. + +If the procedure to enable optimised allocation of media resources is supported, the procedures in 3GPP TS 24.229 [5] shall be applied and the capabilities below shall be provided at the roaming II-NNI. + +The "g.3gpp.mrb" feature-capability indicator (defined in 3GPP TS 24.229 [5] clause 7.9A.6) with the MRB address included in the Feature-Caps header field as described in IETF RFC 6809 [143] in the INVITE request or in the UPDATE request and in the 2xx response to the UPDATE request shall be supported at the roaming II-NNI. + +# --- 21 Overload control + +## 21.1 General + +Based on inter-operator agreement, overload control may be supported over the II-NNI. + +The overload control defines two optional mechanisms: + +- a feedback based mechanism; +- and a load filter mechanism. + +The support of either one of the mechanism is based on operator agreements. + +If a mechanism is supported, the related procedures from the 3GPP TS 24.229 [5] shall be applied with the requirements in the relevant clause below. + +Based on regional/national requirements and inter-operator agreement, Multimedia Priority Service (MPS), as specified in 3GPP TS 22.153 [187], shall be exempted from SIP overload controls across II-NNI up to the point where further exemption would cause network instability. + +## 21.2 Feedback based mechanism + +The procedures in 3GPP TS 24.229 [5] shall be applied and the capabilities below shall be provided at the II-NNI. + +The feedback based mechanism, defined in IETF RFC 7339 [165], requires no additional support at the II-NNI as it is supported using header field parameters within existing header fields supported at the II-NNI. + +NOTE: An algorithm will need to be selected. The IETF RFC 7339 [165] also defines the default algorithm for usage of the feedback based mechanism in the IM CN subsystem. Additional algorithms are either already defined, e.g. the rate-based scheme defined in IETF RFC 7415 [166], or can also be defined in the future. + +## 21.3 The load filter mechanism + +The procedures in 3GPP TS 24.229 [5] shall be applied and the capabilities below shall be provided at the II-NNI. + +A SUBSCRIBE request containing the Event header field "load-control" and, optionally, an Accept header field containing the "application/load-control+xml" MIME type as defined in IETF RFC 7200 [167] shall be supported on the II-NNI. + +NOTE: The addresses to targets that can be supervised need to form part of the service level agreement. + +A NOTIFY request containing the "application/load-control+xml" MIME body defined in IETF RFC 7200 [167] shall be supported on the II-NNI. + +# --- 22 Delivery of original destination identity + +Based on inter-operator agreement, the procedure to deliver original identity may be supported over the II-NNI. + +NOTE: Service requirement related to the procedure is available in 3GPP TS 22.228 [9]. + +If the procedure to enable delivery of original destination identity is supported, the procedures in 3GPP TS 24.229 [5] shall be supported as further specified below. + +The "mp" header field parameter in the History-Info header field of the initial INVITE request, as defined in IETF RFC 7044 [25], shall be supported over the II-NNI. + +# --- 23 Telepresence using IMS + +Based on inter-operator agreement, the procedure to support telepresence using IMS may be supported over the II-NNI. + +NOTE: Service requirement related to the procedure is available in clause 7.10.2.2 of 3GPP TS 22.228 [9]. + +If the telepresence using IMS is supported, the procedures in 3GPP TS 24.103 [189] shall be applied and the capabilities below shall be provided at the II-NNI. + +The "+sip.clue" header field parameter included in a Contact header field as described in 3GPP TS 24.103 [189] in the INVITE request or in the UPDATE request and in the 2xx response to the UPDATE request shall be supported at the II-NNI. + +# --- 24 Barring of premium rate numbers + +Based on inter-operator agreement, barring of premium rate numbers as described in 3GPP TS 24.315 [191] may be supported over the II-NNI. + +If barring of premium rate numbers is supported, the "premium-rate" tel URI parameter defined in 3GPP TS 24.229 [5] clause 7.2A.17 shall be supported at the roaming II-NNI. + +# --- 25 P-CSCF restoration + +## 25.1 General + +Based on inter-operator agreement, P-CSCF restoration may be supported over the II-NNI. + +The P-CSCF restoration defines two optional mechanisms: + +- a PCRF or PCF based mechanism; and + +NOTE 1: In 5GS the mechanism is called "PCF based P-CSCF restoration" since the PCF takes the role of the PCRF. + +- an HSS or UDM/HSS based mechanism. + +NOTE 2: In 5GS the mechanism is called "UDM/HSS based P-CSCF restoration" since the UDM participates in the procedure. + +The support of either one of the mechanisms is based on operator agreements. + +If a mechanism is supported, the related procedures from the 3GPP TS 24.229 [5] shall be applied with the requirements in the relevant clause below. + +## 25.2 PCRF or PCF based P-CSCF restoration + +The procedures in 3GPP TS 24.229 [5] shall be applied and the capabilities below shall be provided at the II-NNI. + +The Restoration-Info header field containing IMSI information defined in 3GPP TS 24.229 [5] in the home-to-visited initial INVITE request shall be supported on the roaming II-NNI. + +## 25.3 HSS or UDM/HSS based P-CSCF restoration + +The procedures in 3GPP TS 24.229 [5] shall be applied and the capabilities below shall be provided at the II-NNI. + +The Restoration-Info header field containing information about failed node defined in 3GPP TS 24.229 [5] in the 408 (Request Timeout) response to the home-to-visited initial INVITE request and in the 504 (Server Time-out) response to the MESSAGE request, NOTIFY request, OPTIONS request, PUBLISH request, REFER request and the SUBSCRIBE request shall be supported on the roaming II-NNI. + +# --- 26 Resource sharing + +Based on inter-operator agreement, resource sharing may be supported over the II-NNI. + +If resource sharing is supported, the related procedures from the 3GPP TS 24.229 [5] shall be applied with the requirements in this clause. + +The Resource-Share header field shall be supported on the roaming II-NNI in the following SIP requests and SIP responses: + +- the ACK request, the INVITE request, the PRACK request, the REGISTER and UPDATE; +- 18x responses to the INVITE request; and +- 2xx responses to the PRACK request, INVITE request and the UPDATE request. + +# --- 27 Service access number translation + +Based on inter-operator agreement, service access number translation may be supported over the II-NNI. + +If service access number translation is supported, the related procedures in 3GPP TS 24.229 [5] shall be applied with the requirements in this clause. + +The Request-URI containing a "cause" SIP URI parameter, defined in IETF RFC 4458 [58], set to the value "380" defined in IETF RFC 8119 [193] shall be supported at the II-NNI. + +The History-Info header field containing a "cause" SIP URI parameter, defined in IETF RFC 4458 [58], set to the value "380" defined in IETF RFC 8119 [193] shall be supported at the II-NNI. + +# --- 28 Mission critical services + +## 28.1 General + +In order to assure the end-to-end service interoperability through the II-NNI, the associated services of the Mission Critical communication may be supported on the II-NNI. The support of mission critical services is based on the business relationships defined in 3GPP TS 23.280 [200] clause 6. + +II-NNI requirements for SIP signalling related to mission critical services interface SIP-1 and SIP-3 (see figure 7.3.1-2 in 3GPP TS 23.280 [200]) are addressed in the present specification as follows: + +- Apart from differences specified in the present clause 28, the SIP-1 interface is identical to the roaming II-NNI. +- Apart from differences specified in the present clause 28, the SIP-3 interface is identical to the non-roaming II-NNI. + +SIP signalling traversing the NNI between an mission critical services server and a SIP core (interface SIP-2 in figure 7.3.1-2 in 3GPP TS 23.280 [200]) is not considered in the present release of this specification. + +The mission critical services are identified by means of the following IMS Communication Service Identifiers: + +- 1) for MCPTT, the "urn:urn-7:3gpp-service.ims.icsi.mcptt" URN (defined in annex E of 3GPP TS 24.379 [201]) ; +- 2) for mission critical video communications, the "urn:urn-7:3gpp-service.ims.icsi.mcvideo" URN (defined in annex E of 3GPP TS 24.281 [210]); and +- 3) for mission critical data communications, the "urn:urn-7:3gpp-service.ims.icsi.mcdata" URN (defined in annex C of 3GPP TS 24.282 [211]) and additionally: + - for Short Data Service (SDS), the "urn:urn-7:3gpp-service.ims.icsi.mcdata.sds" URN (defined in annex C of 3GPP TS 24.282 [211]); and + - for File Distribution (FD), the "urn:urn-7:3gpp-service.ims.icsi.mcdata.fd" URN (defined in annex C of 3GPP TS 24.282 [211]). + +The IMS Communication Service Identifiers listed above can appear in: + +- the media feature tag "g.3gpp.icsi-ref" (specified in 3GPP TS 24.229 [5] subclause 7.9.2) in the Contact header field and the Accept-Contact header field; +- the P-Asserted-Service header field; and +- the P-Preferred-Service header field. + +If the mission critical services are supported, the related procedures from 3GPP TS 24.379 [201], 3GPP TS 24.380 [202], 3GPP TS 24.281 [210], 3GPP TS 24.581 [212], 3GPP TS 24.282 [211] and 3GPP TS 24.582 [213] shall be applied with the requirements in the clauses below due to the crossing of the II-NNI. + +## 28.2 Interoperability of mission critical services for communication over II-NNI + +### 28.2.1 Mission Critical services session establishment + +Service specific requirements in accordance with 3GPP TS 22.179 [199], 3GPP TS 22.280 [209], 3GPP TS 24.379 [201], 3GPP TS 24.281 [210] and 3GPP TS 24.282 [211] shall be supported over the II-NNI. + +The INVITE request including: + +A) For MCPTT: + +- 1) the "g.3gpp.mcptt" media feature tag (defined in annex C of 3GPP TS 24.379 [201]) in the Contact header field; +- 2) the media feature tag "isfocus" (defined in IETF RFC 3840 [56]) in the Contact header field; +- 3) the Content-Type header field with the value "multipart/mixed"; and +- 4) the "application/vnd.3gpp.mcptt-info+xml" MIME body; + +B) For MCVideio: + +- 1) the "g.3gpp.mcvideo" media feature tag (defined in annex D of 3GPP TS 24.281 [210]) in the Contact header field; +- 2) the media feature tag "isfocus" (defined in IETF RFC 3840 [56]) in the Contact header field; +- 3) the Content-Type header field with the value "multipart/mixed"; and + +4) the "application/vnd.3gpp.mcvideo-info+xml" MIME body; + +C) For MCData: + +1) the: + +a) "g.3gpp.mcdata.sds" media feature tag; or + +b) "g.3gpp.mcdata.fd" media feature tag, + +(defined in annex B of 3GPP TS 24.282 [211]) in the Contact header field; + +2) the media feature tag "isfocus" (defined in IETF RFC 3840 [56]) in the Contact header field; + +3) the Content-Type header field with the value "multipart/mixed"; + +4) the "application/vnd.3gpp.mcdata-info+xml" MIME body; and + +5) the "application/vnd.3gpp.mcdata-signalling" MIME body; + +shall be supported at the II-NNI. + +Responses to the INVITE request including: + +1) the: + +a) "g.3gpp.mcptt"; + +b) "g.3gpp.mcvideo"; + +c) "g.3gpp.mcdata.sds"; or + +d) "g.3gpp.mcdata.fd" + +media feature tag in the Contact header field; + +2) the media feature tag "isfocus" in the Contact header field; + +3) the Content-Type header field with the value "multipart/mixed"; + +4) the "application/vnd.3gpp.mcptt-info+xml" for MCPTT or "application/vnd.3gpp.mcvideo-info+xml" for MCVide or "application/vnd.3gpp.mcdata-info+xml" for MCData MIME body; and + +5) the Warning header field with the warn-code set to "399" and with the warn-text set to a quoted-string as specified in 3GPP TS 24.379 [201] clause 4.4.2 and 3GPP TS 24.281 [210] clause 4.4.2 and 3GPP TS 24.282 [211] clause 4.9; + +shall be supported at the II-NNI. + +The initial INVITE request including the Priority-Share header field (defined in 3GPP TS 24.229 [5]), the Resource-Share header field (defined in 3GPP TS 24.229 [5]) and the "application/resource-lists+xml" MIME body shall be supported at the roaming II-NNI. + +The Resource-Share header field and the Priority-Share header field in 18x and 2xx responses to the INVITE request shall be supported at the roaming II-NNI. + +The Resource-Share header field and the Priority-Share header field in the PRACK requests, the UPDATE requests, the ACK requests and in 2xx responses to the PRACK requests and the UPDATE requests shall be supported at the roaming II-NNI. + +The REFER request containing an "application/vnd.3gpp.mcptt-info+xml" MIME body in the headers portion in the Refer-To header field shall be supported at the roaming II-NNI. + +NOTE: How the "application/vnd.3gpp.mcptt-info+xml" MIME body is included in the headers portion is described in IETF RFC 3261 [13] section 19.1.1. + +The "m=" line set to "application UDP MCPTT" and associated parameters in the "a=fmpt:MCPTT" media line attribute shall be supported at the II-NNI. + +An "i=" line set to "speech" in the audio media definition in the SDP offer and SDP answer shall be supported at the II-NNI. + +### 28.2.2 MBMS transmission usage and location procedures + +For MCPTT: + +- a) Service specific requirements in accordance with 3GPP TS 24.379 [201] clauses 13 and 14 shall be supported over the II-NNI. +- b) The MESSAGE request containing the "application/vnd.3gpp.mcptt-info+xml" MIME body shall be supported over the roaming II-NNI. +- c) The MESSAGE request containing the "application/vnd.3gpp.mcptt-location-info+xml" MIME body shall be supported over the roaming II-NNI. +- d) The MESSAGE request containing the "application/vnd.3gpp.mcptt-mbms-usage-info+xml" MIME body shall be supported over the roaming II-NNI. +- e) The P-Preferred-Service header field with the value "urn:urn-7:3gpp-service.ims.icsi.mcptt" of the MESSAGE request shall be supported at the roaming II-NNI. +- f) The "g.3gpp.mcptt" media feature tag in the Accept-Contact header field of the MESSAGE request from the home network to the visited network shall be supported at the roaming II-NNI. +- g) The "g.3gpp.icsi-ref" media feature tag with the value "urn:urn-7:3gpp-service.ims.icsi.mcptt" in the Accept-Contact header field of the MESSAGE request shall be supported at the roaming II-NNI. + +For MCVideo: + +- a) Service specific requirements in accordance with 3GPP TS 24.281 [210] clauses 16 shall be supported over the II-NNI. +- b) The MESSAGE request containing the "application/vnd.3gpp.mcvideo-info+xml" MIME body shall be supported over the roaming II-NNI. +- c) The MESSAGE request containing the "application/vnd.3gpp.mcvideo-location-info+xml" MIME body shall be supported over the roaming II-NNI. +- d) The MESSAGE request containing the "application/vnd.3gpp.mcvideo-mbms-usage-info+xml" MIME body shall be supported over the roaming II-NNI. +- e) The P-Preferred-Service header field with the value "urn:urn-7:3gpp-service.ims.icsi.mcvideo" of the MESSAGE request shall be supported at the roaming II-NNI. +- f) The "g.3gpp.mcvideo" media feature tag in the Accept-Contact header field of the MESSAGE request from the home network to the visited network shall be supported at the roaming II-NNI. +- g) The "g.3gpp.icsi-ref" media feature tag with the value "urn:urn-7:3gpp-service.ims.icsi.mcvideo" in the Accept-Contact header field of the MESSAGE request shall be supported at the roaming II-NNI. + +### 28.2.3 Affiliation procedure + +#### 28.2.3.1 General + +The affiliation consists of two procedures. One mandatory mode procedure and one negotiated mode procedure. + +Both procedures shall be supported over the II-NNI. + +#### 28.2.3.2 Mandatory mode + +Service specific requirements in accordance with 3GPP TS 24.379 [201] clause 9, 3GPP TS 24.281 [210] clause 8 and 3GPP TS 24.282 [211] clause 8 shall be supported over the II-NNI. + +The SIP PUBLISH request including: + +- 1) an Event header field set to the value "presence"; +- 2) an "application/vnd.3gpp.mcptt-info+xml" for MCPTT, "application/vnd.3gpp.mcvideo-info+xml" for MCVideo or "application/vnd.3gpp.mcdata-info+xml" for MCData MIME body; and +- 3) an "application/pidf+xml" MIME body; + +shall be supported at the II-NNI. + +A SUBSCRIBE request including: + +- 1) an Event header field set to the value "presence"; +- 2) an "application/vnd.3gpp.mcptt-info+xml" for MCPTT or "application/vnd.3gpp.mcvideo-info+xml" for MCVideo or "application/vnd.3gpp.mcdata-info+xml" for MCData MIME body; +- 3) an Accept header field containing the "application/pidf+xml" MIME type; and +- 4) an "application/simple-filter+xml" MIME body according to IETF RFC 4661 [176]; + +shall be supported at the II-NNI. + +An NOTIFY request including: + +- 1) an Event header field set to the value "presence"; and +- 2) an "application/pidf+xml" MIME body + +shall be supported at the II-NNI. + +#### 28.2.3.3 Negotiated mode + +Service specific requirements in accordance with 3GPP TS 24.379 [201] clause 9, 3GPP TS 24.281 [210] clause 8 and 3GPP TS 24.282 [211] clause 8 shall be supported over the II-NNI. + +A MESSAGE request including: + +- 1) an "application/vnd.3gpp.mcptt-info+xml" for MCPTT, "application/vnd.3gpp.mcvideo-info+xml" for MCVideo or "application/vnd.3gpp.mcdata-info+xml" for MCData MIME body; and +- 2) an "application/vnd.3gpp.mcptt-affiliation-command+xml" for MCPTT, "application/vnd.3gpp.mcvideo-affiliation-command+xml" for MCVideo or "application/vnd.3gpp.mcdata-affiliation-command+xml" for MCData MIME body; + +shall be supported at the II-NNI. + +### 28.2.4 Conference event package subscription + +Service specific requirements in accordance with 3GPP TS 24.379 [201] clause 10.1.3 shall be supported over the II-NNI. + +The SUBSCRIBE request including: + +- 1) a "conference" event package name in the Event header field; +- 2) an Accept header field containing the "application/conference-info+xml" MIME type; and +- 3) an "application/vnd.3gpp.mcptt-info+xml" for MCPTT or "application/vnd.3gpp.mcvideo-info+xml" for MCVideo MIME body; + +shall be supported at the II-NNI. + +The NOTIFY request including: + +- 1) the "conference" event package name in the Event header field; +- 2) the Content-Type header field with the value "multipart/mixed"; + +- 3) an "application/vnd.3gpp.mcptt-info+xml" for MCPTT or "application/vnd.3gpp.mcvideo-info+xml" for MCVideo MIME body; and +- 4) an "application/conference-info+xml" MIME body; + +shall be supported at the II-NNI. + +### 28.2.5 Mission critical services settings + +Service specific requirements in accordance with 3GPP TS 24.379 [201] clause 7, 3GPP TS 24.281 [210] clause 7 and 3GPP TS 24.282 [211] clause 7 shall be supported over the roaming II-NNI. + +A PUBLISH request including: + +- 1) an Event header field set to the "poc-settings" value; +- 2) one of the following sets of MIME bodies: + - an "application/vnd.3gpp.mcptt-info+xml" for MCPTT; + - an "application/vnd.3gpp.mcvideo-info+xml" MIME body and an "application/vnd.3gpp.mcptt-signed+xml" for MCVideo MIME body; or + - an "application/vnd.3gpp.mcdata-info+xml" MIME body and an "application/vnd.3gpp.mcptt-signed+xml" MIME body for MCData; and +- 3) an "application/poc-settings+xml" MIME body according to IETF RFC 4354 [205]; + +shall be supported at the roaming II-NNI. + +### 28.2.6 Registration procedures + +Service specific requirements in accordance with 3GPP TS 24.379 [201] clause 7 shall be supported over the roaming II-NNI. + +The REGISTER request including: + +- 1) the: + - a) "g.3gpp.mcptt"; + - b) "g.3gpp.mcvideo"; + - c) "g.3gpp.mcdata.sds"; or + - d) "g.3gpp.mcdata.fd"media feature tag in the Contact header field; +- 2) the Content-Type header field with the value "multipart/mixed"; +- 3) the application/mikey MIME body; +- 4) one of the following sets of MIME bodies: + - an "application/vnd.3gpp.mcptt-info+xml" for MCPTT; + - an "application/vnd.3gpp.mcvideo-info+xml" MIME body and an "application/vnd.3gpp.mcptt-signed+xml" for MCVideo MIME body; or + - an "application/vnd.3gpp.mcdata-info+xml" MIME body and an "application/vnd.3gpp.mcptt-signed+xml" MIME body for MCData; +- 5) the Resource-Share header field (defined in 3GPP TS 24.229 [5]); and +- 6) the "g.3gpp.priority-share" feature-capability indicator (defined in 3GPP TS 24.229 [5] clause 7.9A.10) in the Feature-Caps header field; + +shall be supported at the roaming II-NNI. + +### 28.2.7 Group regrouping + +Service specific requirements in accordance with 3GPP TS 24.379 [201] clause 10 shall be supported over the non-roaming II-NNI. + +In addition to the requirements in subclause 28.2.1 the 403 (Forbidden) response to the INVITE request including a P-Refused-URI-List header field and an "application/resource-lists+xml" MIME body shall be supported at the non-roaming II-NNI. + +The MESSAGE request including: + +- 1) a Content-Type header field with the value "multipart/mixed"; +- 2) an "application/vnd.3gpp.mcptt-info+xml" MIME body; and +- 3) an "application/vnd.3gpp.mcptt-floor-request+xml" MIME body; + +shall be supported at the non-roaming II-NNI. + +### 28.2.8 Signalling plane messages for mission critical data + +Service specific requirements in accordance with 3GPP TS 24.282 [211] subclause 9.2.2 shall be supported over the II-NNI. + +A MESSAGE request including: + +- 1) an "application/vnd.3gpp.mcdata-info+xml" MIME body; and +- 2) an "application/vnd.3gpp.mcdata-signalling" MIME body or an "application/vnd.3gpp.mcdata-payload" MIME body or both; + +shall be supported at the II-NNI. + +### 28.2.9 Functional alias management procedure + +Service specific requirements in accordance with 3GPP TS 24.379 [201] clause 9A shall be supported over the II-NNI. + +A SIP PUBLISH request including: + +- 1) an Event header field set to the value "presence"; +- 2) an "application/vnd.3gpp.mcptt-info+xml" MIME body for MCPTT; and +- 3) an "application/pidf+xml" MIME body; + +shall be supported at the II-NNI. + +A SIP SUBSCRIBE request including: + +- 1) an Event header field set to the value "presence"; +- 2) an "application/vnd.3gpp.mcptt-info+xml" MIME body; and +- 3) an Accept header field containing the "application/pidf+xml" MIME body; + +shall be supported at the II-NNI. + +A SIP NOTIFY request including: + +- 1) an Event header field set to the value "presence"; and +- 2) an "application/pidf+xml" MIME body. + +shall be supported at the II-NNI. + +# --- 29 Calling number verification using signature verification and attestation information + +Based on inter-operator agreement, "Calling number verification using signature verification and attestation information" functionality, as described in IETF RFC 8224 [206] and 3GPP TS 24.229 [5], may be supported over the II-NNI. + +If the "Calling number verification using signature verification and attestation information" is supported, the related procedures in 3GPP TS 24.229 [5] shall be applied with the requirements in this clause. + +A 200 (OK) response to a REGISTER request including a "g.3gpp.verstat" feature-capability indicator (defined in 3GPP TS 24.229 [5] clause 7.9A.11) and a "sip.607" feature-capability indicator (defined in IETF RFC 8197 [207]) in a Feature-Caps header field shall be supported at the roaming II-NNI. + +An initial INVITE request and a MESSAGE request containing a P-Asserted-Identity header field and a From header field with a "verstat" tel URI parameter (defined in 3GPP TS 24.229 [5] clause 7.2A.20) in a tel URI or in a SIP URI with a "user=phone" parameter shall be supported at the roaming II-NNI. + +An initial INVITE request and a MESSAGE request containing: + +- an Identity header field (defined in IETF RFC 8224 [206]); +- an Attestation-Info header field (defined in 3GPP TS 24.229 [5] clause 7.2.18); and +- an Origination-id header field (defined in 3GPP TS 24.229 [5] clause 7.2.19), + +shall be supported at the non-roaming II-NNI. + +A 607 (Unwanted) response (defined in IETF RFC 8197 [207]) to an initial INVITE request and a MESSAGE request shall be supported at the II-NNI. + +A Reason header field with a protocol value set to "SIP" and a "cause" header field parameter set to "607" in a BYE request shall be supported at the II-NNI. + +# --- 30 IMS emergency service + +## 30.1 IMS emergency registration + +See subclause 8.1 for the signalling requirements of IMS emergency registration regarding the "sos" URI parameter on the roaming II-NNI. + +## 30.2 IMS emergency session + +Based on inter-operator agreements or national requirements, IMS emergency session may be supported over the non-roaming II-NNI. + +NOTE 1: The details of the SIP signalling requirements for IMS emergency session on the non-roaming II-NNI can be defined by inter-operator agreements or national requirements. + +If the IMS emergency session is supported, the related procedures in 3GPP TS 24.229 [5] shall be applied with the requirements in this clause. + +The Request-URI containing a uniform resource name (URN) for emergency services, defined in IETF RFC 5031 [61] and 3GPP TS 24.229 [5], shall be supported for the IMS emergency session traversal scenario on the non-roaming II-NNI. + +NOTE 2: The emergency service URN(s) to use can be defined by inter-operator agreements or national requirements. + +## 30.3 Next-Generation Pan-European eCall emergency service + +Based on inter-operator agreements or national requirements, Next-Generation Pan-European eCall emergency service may be supported over the non-roaming II-NNI. + +If Next-Generation Pan-European eCall emergency service is supported, the related procedures in 3GPP TS 24.229 [5] shall be applied with the requirements in this clause. + +The MSD in an INVITE and INFO request shall be supported over the non-roaming II-NNI as described in 3GPP TS 24.229 [5]. + +# --- 31 Restricted Local Operator Services (RLOS) + +Based on inter-operator agreement, RLOS as described in 3GPP TS 24.229 [5] may be supported over the roaming II-NNI. + +If RLOS is supported, a REGISTER request with a "+g.3gpp.rlos" Contact header field parameter, as defined in 3GPP TS 24.229 [5] subclause 7.9.9 shall be supported at the roaming II-NNI. + +An initial request for a dialog or a request for a standalone transaction with the Request-URI containing the dummy MSISDN value as defined in 3GPP TS 23.003 [35] or a RLOS service specific dial string and a P-Preferred-Service header field set to "urn:urn-7:3gpp-service.ims.icsi.rlos", as defined in 3GPP TS 24.229 [5] subclause 7.11.2 shall be supported at the roaming II-NNI. + +# --- 32 3GPP PS data off extension + +Based on inter-operator agreement, 3GPP PS data off extension as described in 3GPP TS 24.229 [5] may be supported over the roaming II-NNI. + +If the 3GPP PS data off extension is supported, "+g.3gpp.ps-data-off" media feature tag in the Contact header field parameter of the REGISTER request shall be supported at the roaming II-NNI. + +# --- 33 MTSI Data channel + +Based on inter-operator agreement, data channel as described in 3GPP TS 26.114 [11] may be supported at the II-NNI. + +If MTSI data channel is supported, the procedures specified in 3GPP TS 26.114 [11] shall be applied and the capabilities below shall be provided at the II-NNI. + +The "+sip.app-subtype" media feature tag with a value of "webrtc-datachannel" in the Contact header field parameter of the REGISTER request shall be supported at the roaming II-NNI. + +The "+sip.app-subtype" media feature tag with a value of "webrtc-datachannel" in the Contact header field parameter of INVITE and UPDATE requests and in 18x and 2xx responses to INVITE and UPDATE requests shall be supported at the II-NNI. + +The "m=" line set to "application UDP/DTLS/SCTP webrtc-datachannel" and associated parameters in the media line attributes "a=dcmap" and "a=3GPP-qos-hint" of the SDP body shall be supported at the II-NNI. For the "bootstrap" data channel as defined in table 6.2.10.1-2 of 3GPP TS 26.114 [11] only stream ID 100 and stream ID 110 shall be supported at the II-NNI. + +NOTE: Stream ID 0 and stream ID 10 "bootstrap" data channels are strictly local between the UE and its local network. + +# --- Annex A (informative): Summary of SIP header fields + +A summary of the SIP header fields to be used in case of interconnection by using II-NNI is proposed in table A.1. + +The starting point is the sending behaviour described for proxy and UA roles in annex A of 3GPP TS 24.229 [5]: + +- In case of misalignment between table A.1 and the behaviour described in 3GPP TS 24.229 [5], the behaviour in 3GPP TS 24.229 [5] has the precedence. +- In case a header field is not described in table A.1 and it is described in 3GPP TS 24.229 [5], the description in 3GPP TS 24.229 [5] is applicable over II-NNI. +- If a header field is not described in 3GPP TS 24.229 [5], the description in table A.1 is applicable over II-NNI. + +The definition of the notation codes used in table A.1 is provided in table A.2. + +## **Table A.1: Supported header fields** + +| Item | Header field | Ref. | II-NNI | +|------|--------------------------|---------------------------------------------------------------------|---------------------------------------------------------------------------------| +| 1 | Accept | [5] | m | +| 2 | Accept-Contact | [5] | m | +| 3 | Accept-Encoding | [5] | m | +| 4 | Accept-Language | [5] | m | +| 4a | Accept-Resource-Priority | [5] | o | +| 4b | Additional-Identity | [5], clause 6.1.1.3.1
(table 6.2, item 25)
and clause 12.26.2 | o in case of a trust relationship between the interconnected networks, else n/a | +| 5 | Alert-Info | [5] | o | +| 6 | Allow | [5] | m | +| 7 | Allow-Events | [5] | m on roaming II-NNI, else o | +| 7a | Attestation-Info | [5], clause 6.1.1.3.1
(table 6.2, item 23)
and clause 29 | o on non-roaming II-NNI, else n/a | +| 8 | Authentication-Info | [5] | m on roaming II-NNI, else n/a | +| 9 | Authorization | [5] | m on roaming II-NNI, else n/a | +| 9a | Answer-Mode | [5] | o | +| 10 | Call-ID | [5] | m | +| 11 | Call-Info | [5] | m | +| 11a | Cellular-Network-Info | clause 6.1.1.3.1
(table 6.2, item 21) | o | +| 12 | Contact | [5] | m | +| 13 | Content-Disposition | [5] | m | +| 14 | Content-Encoding | [5] | m | +| 14a | Content-ID | [5] | o | +| 15 | Content-Language | [5] | m | +| 16 | Content-Length | [5] | m | +| 17 | Content-Type | [5] | m | +| 18 | CSeq | [5] | m | +| 19 | Date | [5] | m | +| 20 | Error-Info | [5] | o | +| 21 | Expires | [5] | m | +| 21a | Flow-Timer | [5] | m on roaming II-NNI, else o | +| 21b | Feature-Caps | clause 6.1.1.3.1
(table 6.2, item 13) | o | +| 22 | Event | [5] | m | +| 23 | From | [5] | m | +| 24 | Geolocation | [5] | m | +| 24a | Geolocation-Error | [5] | m | +| 24b | Geolocation-Routing | [5] | m | +| 25 | History-Info | clause 6.1.1.3.1
(table 6.2, item 4) | o | +| 25b | Identity | [206] and clause 29 | o on non-roaming II-NNI, else n/a | +| 25a | Info-Package | [5] | o | +| 26 | In-Reply-To | [5] | o | +| 27 | Join | [5] | o | +| 27a | Max-Breadth | [5] | m | +| 28 | Max-Forwards | [5] | m | +| 29 | Min-Expires | [5] | m | +| 30 | MIME-Version | [5] | m | +| 31 | Min-SE | [5] | m | +| 32 | Organization | [5] | m | +| 32a | Origination-Id | [5], clause 6.1.1.3.1
(table 6.2, item 24)
and clause 29 | o on non-roaming II-NNI, else n/a | +| 33 | P-Access-Network-Info | clause 6.1.1.3.1
(table 6.2, item 2) | m in case of a trust relationship between the interconnected networks, else n/a | +| 33a | P-Answer-state | [5] | o | +| 34 | P-Asserted-Identity | clause 6.1.1.3.1
(table 6.2, item 1) | m in case of a trust relationship between the interconnected networks, else n/a | +| 35 | P-Asserted-Service | clause 6.1.1.3.1
(table 6.2, item 5) | o | +| 35a | P-Associated-URI | [5] | m on roaming II-NNI, else n/a | +| 36 | P-Called-Party-ID | [5] | m on roaming II-NNI, else n/a | + +| Item | Header field | Ref. | II-NNI | +|------|-------------------------------|-----------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------| +| 37 | P-Charging-Function-Addresses | clause 6.1.1.3.1
(table 6.2, item 7) | n/a | +| 38 | P-Charging-Vector | clause 6.1.1.3.1
(table 6.2, item 6) | m on roaming II-NNI, else o | +| 39 | P-Early-Media | clause 6.1.1.3.1
(table 6.2, item 12) | m in case of a trust relationship between the interconnected networks, else n/a | +| 40 | P-Media-Authorization | [5] | n/a | +| 41 | P-Preferred-Identity | [5] | n/a | +| 42 | P-Preferred-Service | [5] | m on roaming II-NNI, else n/a | +| 43 | P-Private-Network-Indication | clause 6.1.1.3.1
(table 6.2, item 9) | m on roaming II-NNI, else o | +| 44 | P-Profile-Key | clause 6.1.1.3.1
(table 6.2, item 8) | o on roaming II-NNI, else n/a | +| 44a | P-Refused-URI-List | [5] | o on non-roaming II-NNI, else n/a | +| 45 | P-Served-User | clause 6.1.1.3.1
(table 6.2, item 10) | m on roaming II-NNI, else n/a | +| 46 | P-User-Database | [5] | n/a | +| 47 | P-Visited-Network-ID | [5] | m on roaming II-NNI, else n/a | +| 47a | Path | [5] | m on roaming II-NNI, else n/a | +| 47b | Permission-Missing | [5] | o | +| 47c | Policy-Contact | [133] and
clause 15.6.2 | o | +| 48 | Priority | clause 6.1.1.3.1
(table 6.2, item 14) | o | +| 48b | Priority-Share | [5] clause 7.2.16 | o on roaming II-NNI, else n/a | +| 48a | Priv-Answer-Mode | [5] | o | +| 49 | Privacy | [5] | m | +| 50 | Proxy-Authenticate | [5] | m on roaming II-NNI, else n/a | +| 51 | Proxy-Authorization | [5] | m on roaming II-NNI, else n/a | +| 52 | Proxy-Require | [5] | m | +| 52a | RAck | [5] | m | +| 53 | Reason | [5] and
clause 6.1.1.3.1
(table 6.2, item 11) | o when in a request.
When in a response, m in case of a trust relationship between the interconnected networks, else n/a | +| 54 | Record-Route | [5] | m | +| 54a | Recv-Info | [5] | o | +| 55 | Referred-By | [5] | m | +| 55a | Refer-Sub | [5] | m in the case the REFER request is supported, else n/a | +| 55b | Refer-To | [5] | m in the case the REFER request is supported, else n/a | +| 56 | Reject-Contact | [5] | m | +| 56a | Relayed-Charge | clause 6.1.1.3.1
(table 6.2, item 19) | n/a | +| 57 | Replaces | [5] | o | +| 58 | Reply-To | [5] | o | +| 59 | Request-Disposition | [5] | m | +| 60 | Require | [5] | m | +| 61 | Resource-Priority | clause 6.1.1.3.1
(table 6.2, item 3) | o | +| 61c | Resource-Share | [5] clause 7.2.13 | o on roaming II-NNI, else n/a | +| 61d | Response-Source | [5] | o in case of a trust relationship between the interconnected networks, else n/a | +| 61b | Restoration-Info | clause 6.1.1.3.1
(table 6.2, item 18) | o on roaming II-NNI, else n/a | +| 61a | Retry-After | [5] | o | +| 62 | Route | [5] | m | +| 62a | RSeq | [5] | m | +| 63 | Security-Client | [5] | n/a | +| 63a | Security-Server | [5] | n/a | +| 64 | Security-Verify | [5] | n/a | +| 65 | Server | [5] | o | +| 65c | Service-Interact-Info | [5] and | o in case of a trust relationship between the | + +| Item | Header field | Ref. | II-NNI | +|------|--------------------|------------------------------------------|----------------------------------------------------------| +| | | clause 6.1.1.3.1
(table 6.2, item 20) | interconnected networks, else n/a | +| 65a | Service-Route | [5] | m on roaming II-NNI, else n/a | +| 65b | Session-ID | [5] | o | +| 66 | Session-Expires | [5] | m | +| 66a | SIP-ETag | [5] | m in the case the PUBLISH request is supported, else n/a | +| 66b | SIP-If-Match | [5] | m in the case the PUBLISH request is supported, else n/a | +| 67 | Subject | [5] | o | +| 67a | Subscription-State | [5] | m in the case the NOTIFY request is supported, else n/a | +| 67b | Suppress-If-Match | [144] and
clause 15.6.4 | o | +| 68 | Supported | [5] | m | +| 68a | Target-Dialog | [5] | o | +| 69 | Timestamp | [5] | m | +| 70 | To | [5] | m | +| 71 | Trigger-Consent | [5] | m | +| 71a | Unsupported | [5] | m | +| 72 | User-Agent | [5] | m | +| 73 | User-to-User | [5] | o | +| 74 | Via | [5] | m | +| 75 | Warning | [5] | o | +| 76 | WWW-Authenticate | [5] | m on roaming II-NNI, else n/a | + +**Table A.2: Key to notation codes for SIP header fields** + +| Notation code | Meaning | +|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| m | The SIP header field is applicable at II-NNI. Supporting a SIP header field at the II-NNI means that this header field is passed through the IBCF. It does not imply that network elements inside the serving and served networks or user equipment connected to these networks shall support this header field, where 3GPP TS 24.229 [5] is applied. If specified in 3GPP TS 24.229 [5], the IBCF modifies the SIP header field. | +| o | The applicability of SIP header field at II-NNI depends on bilateral agreement between the operators. | +| n/a | It is impossible to use the SIP header field at the II-NNI. This header field could be discarded by the IBCF. | + +# Annex B (informative): Dynamic view of SIP header fields within SIP messages + +## B.1 Scope + +This annex provides the applicability of SIP header fields in SIP messages over II-NNI by using the methodology of a so-called "dynamic view", as used in IETF RFC 3261 [13] and other SIP related RFCs. This methodology documents the presence of SIP header fields in SIP messages over the II-NNI and also takes into account dynamic conditions, for instance the presence of a SIP header field in a SIP request message as condition for the SIP header field in the corresponding SIP response message. + +Specific information about the applicability of SIP header fields in SIP messages in a dynamic view is also provided for cases where an MMTEL supplementary service is supported over the II-NNI between operators. + +The applicability of SIP header fields described in this annex is based on the procedures described in 3GPP TS 24.229 [5] and the list of SIP header fields in annex A of 3GPP TS 24.229 [5]. + +## B.2 Methodology + +The meaning of the notation codes used in the tables in subsequent clauses is as follows: + +In the "RFC status" column, the notation codes defined in IETF RFC 3261 [13] clause 20 are applied. + +In the "II-NNI condition" column the notation codes defined in table B.2.1 are used. If a capability of a SIP header field is specified as either optional or conditional in table 6.1.3.1, then "II-NNI condition" of the SIP header field is described with conditional expression. + +In each request-related table, the order of SIP header fields inherits that of clause A.2.2 of 3GPP TS 24.229 [5]. + +In each response-related table, the SIP status code for which the header field is applicable is described in the "SIP status code" column. The notation codes for the "where" column as defined in IETF RFC 3261 [13] clause 20 are applied. The notation code "r" in "SIP status code" column corresponds to any SIP status code which is described in annex A of 3GPP TS 24.229 [5] for the corresponding method. Any SIP header field not listed in a table is not applicable for the corresponding SIP message. + +**Table B.2.1: Key to notation codes for SIP header fields in dynamic view for II-NNI** + +| Notation code
(NOTE 1) | Meaning | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| dc | The SIP header field is required to be present in a SIP message over II-NNI according to the procedures specified in other specifications e.g. 3GPP TS 24.229 [5]. | +| dm | The SIP header field shall be always present in a SIP message over II-NNI, and if received, it must be handled according to 3GPP TS 24.229 [5]. | +| dm* | The SIP header field should be present in a SIP message over II-NNI, but the IMS network need to be prepared to receive a SIP message without that header field. | +| do | The SIP header field can be present in a SIP message over II-NNI, and if received, it must be handled according to 3GPP TS 24.229 [5]. (NOTE 2) | +| dt | The header field should be present in a SIP message over II-NNI, but the IMS network need to be prepared to receive a SIP message without that header field.
If TCP is used as a transport, then the header field must be present in a SIP message. | +| d* | The SIP header field is required to be present in a SIP message if the message body is not empty. | +| dn/a | The SIP header field is shall not be present in a SIP message over II-NNI. (NOTE 3) | +| dc | The condition for the presence of the SIP header field. is the identifier of the condition. This notation code is applied only in each request-related or response-related table. | +| NOTE 1: The meaning of the notation codes is same as in IETF RFC 3261 [13] clause 20 and "d" is used to emphasise the dynamic view. | | +| NOTE 2: If specified by local policy rules, the IBCF acting as entry point may omit or modify any received SIP header fields prior to forwarding SIP messages as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | +| NOTE 3: The SIP header field can be removed at the IBCF acting as exit point by using screening functionality defined in 3GPP TS 24.229 [5] clause 5.10.6.2. | | + +## B.3 ACK method + +The table B.3.1 lists the supported header fields within the ACK request. + +**Table B.3.1: Supported header fields within the ACK request** + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|------|-----------------------|--------------------|------------|----------------------------------------------------------------------------------------------------------------------------------| +| 1 | Accept-Contact | [51] | o | do | +| 2 | Allow-Events | [20] | o | IF table 6.1.3.1/23 THEN do (NOTE) | +| 3 | Authorization | [13] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 4 | Call-ID | [13] | m | dm | +| 5 | Cellular-Network-Info | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE) | +| 6 | Content-Disposition | [13] | o | do | +| 7 | Content-Encoding | [13] | o | do | +| 8 | Content-ID | [216] | o | IF table 6.1.3.1/122 THEN do | +| 9 | Content-Language | [13] | o | do | +| 10 | Content-Length | [13] | t | dt | +| 11 | Content-Type | [13] | * | d* | +| 12 | CSeq | [13] | m | dm | +| 13 | Date | [13] | o | do | +| 14 | From | [13] | m | dm | +| 15 | Max-Breadth | [79] | o | do | +| 16 | Max-Forwards | [13] | m | dm | +| 17 | MIME-Version | [13] | o | do | +| 18 | P-Access-Network-Info | [24], [24A], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE) | +| 19 | Priority-Share | [5] | n/a | IF home-to-visited request on roaming II-NNI AND table 6.1.3.1/118 THEN do (NOTE) | +| 20 | Privacy | [34] | o | do | +| 21 | P-Charging-Vector | [24], [24A] | o | IF table 6.1.3.1/38 THEN do (NOTE) | +| 22 | Proxy-Authorization | [13] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 23 | Proxy-Require | [13] | n/a | dn/a | +| 24 | Reason | [48] | o | IF table 6.1.3.1/40 THEN do (NOTE) | +| 25 | Record-Route | [13] | o | do | +| 26 | Recv-Info | [39] | n/a | dn/a | +| 27 | Reject-Contact | [51] | o | do | +| 28 | Relayed-Charge | [5] | n/a | dn/a | +| 29 | Request-Disposition | [51] | o | do | +| 30 | Require | [13] | n/a | dn/a | +| 31 | Resource-Priority | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE) | +| 32 | Resource-Share | [5] | n/a | IF (home-to-visited request on roaming II-NNI OR visited-to-home request on roaming II-NNI) AND table 6.1.3.1/116 THEN do (NOTE) | +| 33 | Route | [13] | c | dc | +| 34 | Session-ID | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE) | +| 35 | Timestamp | [13] | o | do | +| 36 | To | [13] | m | dm | +| 37 | User-Agent | [13] | o | do | +| 38 | Via | [13] | m | dm | + +NOTE: If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. + +## B.4 BYE method + +The table B.4.1 lists the supported header fields within the BYE request. + +**Table B.4.1: Supported header fields within the BYE request** + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|-------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|------------|------------------------------------------------------------------------------| +| 1 | Accept | [13] | o | IF dc1 (AOC: clause 12.22) THEN dm ELSE do | +| 2 | Accept-Contact | [51] | o | do | +| 3 | Accept-Encoding | [13] | o | do | +| 4 | Accept-Language | [13] | o | do | +| 5 | Allow | [13] | o | do | +| 6 | Allow-Events | [20] | o | IF table 6.1.3.1/23 THEN do (NOTE) | +| 7 | Authorization | [13] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 8 | Call-ID | [13] | m | dm | +| 9 | Cellular-Network-Info | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE) | +| 10 | Content-Disposition | [13] | o | IF dc2 (AOC: clause 12.22) THEN dm ELSE do | +| 11 | Content-Encoding | [13] | o | do | +| 12 | Content-ID | [216] | o | IF table 6.1.3.1/122 THEN do | +| 13 | Content-Language | [13] | o | do | +| 14 | Content-Length | [13] | t | dt | +| 15 | Content-Type | [13] | * | d* | +| 16 | CSeq | [13] | m | dm | +| 17 | Date | [13] | o | do | +| 18 | From | [13] | m | dm | +| 19 | Geolocation | [68] | o | do | +| 20 | Geolocation-Routing | [68] | o | do | +| 21 | Max-Breadth | [79] | o | do | +| 22 | Max-Forwards | [13] | m | dm | +| 23 | MIME-Version | [13] | o | do | +| 24 | P-Access-Network-Info | [24], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE) | +| 25 | P-Asserted-Identity | [44] | o | IF table 6.1.3.1/27 THEN do (NOTE) | +| 26 | P-Charging-Function-Addresses | [24] | o | dn/a | +| 27 | P-Charging-Vector | [24] | o | IF table 6.1.3.1/38 THEN do (NOTE) | +| 28 | P-Preferred-Identity | [44] | o | dn/a | +| 29 | Privacy | [34] | o | do | +| 30 | Proxy-Authorization | [13] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 31 | Proxy-Require | [13] | o | do | +| 32 | Reason | [48] | o | IF dc3 (ICB: clause 12.10.1) THEN dm ELSE IF table 6.1.3.1/40 THEN do (NOTE) | +| 33 | Record-Route | [13] | o | do | +| 34 | Referred-By | [53] | o | do | +| 35 | Reject-Contact | [51] | o | do | +| 36 | Relayed-Charge | [5] | n/a | dn/a | +| 37 | Request-Disposition | [51] | o | do | +| 38 | Require | [13] | c | dc | +| 39 | Resource-Priority | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE) | +| 40 | Route | [13] | c | dc | +| 41 | Security-Client | [47] | o | dn/a | +| 42 | Security-Verify | [47] | o | dn/a | +| 43 | Session-ID | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE) | +| 44 | Supported | [13] | o | do | +| 45 | Timestamp | [13] | o | do | +| 46 | To | [13] | m | dm | +| 47 | User-Agent | [13] | o | do | +| 48 | User-to-User | [83] | o | IF table 6.1.3.1/79 THEN do (NOTE) | +| 49 | Via | [13] | m | dm | +| dc1: | request invoked due to AOC AND visited-to-home request on roaming II-NNI | | | | +| dc2: | request invoked due to AOC AND home-to-visited request on roaming II-NNI | | | | +| dc3: | request invoked due to "dynamic ICB" on a confirmed status | | | | +| NOTE: | If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | | | + +The table B.4.2 lists the supported header fields within the BYE response. + +**Table B.4.2: Supported header fields within the BYE response** + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|----------------------------------------|----------------------|------------|--------------------------------------------| +| 1 | Accept | 415 | [13] | c | dc | +| 2 | Accept-Encoding | 415 | [13] | c | dc | +| 3 | Accept-Language | 415 | [13] | c | dc | +| 4 | Accept-Resource-Priority | 2xx
417 | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE 2) | +| 5 | Allow | 405 | [13] | m | dm | +| | | others | | o | do | +| 6 | Allow-Events | 2xx | [20] | o | IF table 6.1.3.1/23 THEN do (NOTE 2) | +| 7 | Authentication-Info | 2xx | [13] | o | IF table 6.1.3.1/7 THEN do (NOTE 2) | +| 8 | Call-ID | 100 | [13] | m | dm | +| | | others | | | | +| 9 | Cellular-Network-Info | r | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE 2) | +| 10 | Contact | 3xx
485 | [13] | o | do | +| 11 | Content-Disposition | r | [13] | o | IF dc1 (AOC: clause 12.22) THEN dm ELSE do | +| 12 | Content-Encoding | r | [13] | o | do | +| 13 | Content-ID | r | [216] | o | IF table 6.1.3.1/122 THEN do | +| 14 | Content-Language | r | [13] | o | do | +| 15 | Content-Length | 100 | [13] | t | dt | +| | | others | | | | +| 16 | Content-Type | r | [13] | * | d* | +| 17 | CSeq | 100 | [13] | m | dm | +| | | others | | | | +| 18 | Date | 100 | [13] | o | do | +| | | others | | | | +| 19 | Error-Info | 3xx-6xx | [13] | o | IF table 6.1.3.1/13 THEN do (NOTE 2) | +| 20 | From | 100 | [13] | m | dm | +| | | others | | | | +| 21 | Geolocation-Error | 424 | [68] | m | dm | +| | | others | | o | do | +| 22 | MIME-version | r | [13] | o | do | +| 23 | P-Access-Network-Info | r | [24], [2 4A], [2 4B] | o | IF table 6.1.3.1/36 THEN do (NOTE 2) | +| 24 | P-Asserted-Identity | r | [44] | o | IF table 6.1.3.1/27 THEN do (NOTE 2) | +| 25 | P-Charging-Function-Addresses | r | [24], [2 4A] | o | dn/a | +| 26 | P-Charging-Vector | 100 | [24], [2 4A] | o | dn/a | +| | | others | | o | IF table 6.1.3.1/38 THEN do (NOTE 2) | +| 27 | P-Preferred-Identity | r | [44] | o | dn/a | +| 28 | Privacy | r | [34] | o | do | +| 29 | Proxy-Authenticate | 401 (NOTE 1) | [13] | o | do | +| | | 407 (NOTE 1) | | m | dm | +| 30 | Record-Route | 2xx | [13] | o | do | +| 31 | Relayed-Charge | r | [5] | n/a | dn/a | +| 32 | Require | r | [13] | c | dc | +| 33 | Response-Source | 3xx-6xx | [5] | n/a | IF table 6.1.3.1/121 THEN do (NOTE 2) | +| 34 | Retry-After | 404
413
480
486
500
503 | [13] | o | do | + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | | +|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|-------|------------|-----------------------------------------|--| +| | | 600
603 | | | | | +| 35 | Security-Server | 421
494 | [47] | o | dn/a | | +| 36 | Server | r | [13] | o | do | | +| 37 | Session-ID | r | [124] | m | IF table 6.1.3.1/94 THEN dm
(NOTE 2) | | +| 38 | Supported | 2xx | [13] | o | do | | +| 39 | Timestamp | r | [13] | o | do | | +| 40 | To | 100
others | [13] | m | dm | | +| 41 | Unsupported | 420 | [13] | m | dm | | +| 42 | User-Agent | r | [13] | o | do | | +| 43 | User-to-User | r | [83] | o | IF table 6.1.3.1/79 THEN do
(NOTE 2) | | +| 44 | Via | 100
others | [13] | m | dm | | +| 45 | Warning | r | [13] | o | do | | +| 46 | WWW-Authenticate | 401
(NOTE 1) | [13] | m | dm | | +| | | 407
(NOTE 1) | | o | do | | +| dc1: | 200 (OK) response invoked due to AOC AND home-to-visited response on roaming II-NNI | | | | | | +| NOTE 1: | The SIP status code is only applicable over the roaming II-NNI. | | | | | | +| NOTE 2: | If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | | | | | + +## B.5 CANCEL method + +The table B.5.1 lists the supported header fields within the CANCEL request. + +**Table B.5.1: Supported header fields within the CANCEL request** + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|-------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|------------|--------------------------------------------------------------------------| +| 1 | Accept-Contact | [51] | o | do | +| 2 | Authorization | [13] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 3 | Call-ID | [13] | m | dm | +| 4 | Content-Length | [13] | t | dt | +| 5 | Content-Type | [13] | * | IF table 6.1.3.1/20 THEN do (NOTE) | +| 6 | CSeq | [13] | m | dm | +| 7 | Date | [13] | o | do | +| 8 | From | [13] | m | dm | +| 9 | Max-Breadth | [79] | o | do | +| 10 | Max-Forwards | [13] | m | dm | +| 11 | Privacy | [34] | o | do | +| 12 | Reason | [48] | o | IF dc1 (CW: clause 12.7) THEN dm ELSE IF table 6.1.3.1/40 THEN do (NOTE) | +| 13 | Record-Route | [13] | o | do | +| 14 | Reject-Contact | [51] | o | do | +| 15 | Request-Disposition | [51] | o | do | +| 16 | Resource-Priority | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE) | +| 17 | Route | [13] | c | dc | +| 18 | Session-ID | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE) | +| 19 | Supported | [13] | o | do | +| 20 | Timestamp | [13] | o | do | +| 21 | To | [13] | m | dm | +| 22 | User-Agent | [13] | o | do | +| 23 | Via | [13] | m | dm | +| dc1: | request invoked due to CW at the expiry of the "CW timer" | | | | +| NOTE: | If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | | | + +The table B.5.2 lists the supported header fields within the CANCEL response. + +**Table B.5.2: Supported header fields within the CANCEL response** + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|------|--------------------------|------------------------------------------------------|-------|------------|-------------------------------------| +| 1 | Accept-Resource-Priority | 2xx
417 | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE) | +| 2 | Call-ID | r | [13] | m | dm | +| 3 | Content-Length | r | [13] | t | dt | +| 4 | CSeq | r | [13] | m | dm | +| 5 | Date | r | [13] | o | do | +| 6 | Error-Info | 3xx-6xx | [13] | o | IF table 6.1.3.1/13 THEN do (NOTE) | +| 7 | From | r | [13] | m | dm | +| 8 | Privacy | r | [34] | o | do | +| 9 | Record-Route | 2xx | [13] | o | do | +| 10 | Response-Source | 3xx-6xx | [5] | n/a | IF table 6.1.3.1/121 THEN do (NOTE) | +| 11 | Retry-After | 404
413
480
486
500
503
600
603 | [13] | o | do | +| 12 | Session-ID | r | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE) | +| 13 | Supported | 2xx | [13] | o | do | +| 14 | Timestamp | r | [13] | o | do | +| 15 | To | r | [13] | m | dm | +| 16 | User-Agent | r | [13] | o | do | +| 17 | Via | r | [13] | m | dm | +| 18 | Warning | r | [13] | o | do | + +NOTE: If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. + +## B.6 INFO method + +As described in table 6.1, the support of INFO method over the II-NNI is based on bilateral agreement between the operators. + +The table B.6.1 lists the supported header fields within the INFO request. + +**Table B.6.1: Supported header fields within the INFO request** + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|-------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|------------|--------------------------------------------| +| 1 | Accept | [13], [39] | o | do | +| 2 | Accept-Encoding | [13], [39] | o | do | +| 3 | Accept-Language | [13], [39] | o | do | +| 4 | Allow | [13], [39] | o | do | +| 5 | Allow-Events | [20] | o | IF table 6.1.3.1/23 THEN do (NOTE) | +| 6 | Authorization | [13], [39] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 7 | Call-ID | [13], [39] | m | dm | +| 8 | Call-Info | [13], [39] | o | do | +| 9 | Cellular-Network-Info | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE) | +| 10 | Content-Disposition | [13], [39] | o | IF dc1 (AOC: clause 12.22) THEN dm ELSE do | +| 11 | Content-Encoding | [13], [39] | o | do | +| 12 | Content-ID | [216] | o | IF table 6.1.3.1/122 THEN do | +| 13 | Content-Language | [13], [39] | o | do | +| 14 | Content-Length | [13], [39] | o | do | +| 15 | Content-Type | [13], [39] | * | d* | +| 16 | CSeq | [13], [39] | m | dm | +| 17 | Date | [13], [39] | o | do | +| 18 | From | [13], [39] | m | dm | +| 19 | Geolocation | [68] | o | do | +| 20 | Geolocation-Routing | [68] | o | do | +| 21 | Info-Package | [39] | m* | IF table 6.1.3.1/17 THEN do (NOTE) | +| 22 | Max-Breadth | [79], [39] | n/a | dn/a | +| 23 | Max-Forwards | [13], [39] | o | do | +| 24 | MIME-Version | [13], [39] | o | do | +| 25 | P-Access-Network-Info | [24], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE) | +| 26 | P-Charging-Function-Addresses | [24] | o | dn/a | +| 27 | P-Charging-Vector | [24] | o | IF table 6.1.3.1/38 THEN do (NOTE) | +| 28 | Privacy | [34], [39] | o | do | +| 29 | Proxy-Authorization | [13], [39] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 30 | Proxy-Require | [13], [39] | o | do | +| 31 | Reason | [48], [39] | o | IF table 6.1.3.1/40 THEN do (NOTE) | +| 32 | Record-Route | [13], [39] | o | do | +| 33 | Referred-By | [53], [39] | o | do | +| 34 | Relayed-Charge | [5] | n/a | dn/a | +| 35 | Request-Disposition | [51], [39] | o | do | +| 36 | Require | [13], [39] | o | do | +| 37 | Resource-Priority | [78], [39] | o | IF table 6.1.3.1/73 THEN do (NOTE) | +| 38 | Route | [13], [39] | o | do | +| 39 | Security-Client | [47], [39] | o | dn/a | +| 40 | Security-Verify | [47], [39] | o | dn/a | +| 41 | Session-ID | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE) | +| 42 | Subject | [13], [39] | o | do | +| 43 | Supported | [13], [39] | o | do | +| 44 | Timestamp | [13], [39] | o | do | +| 45 | To | [13], [39] | m | dm | +| 46 | User-Agent | [13], [39] | o | do | +| 47 | Via | [13], [39] | m | dm | +| dc1: | request invoked due to AOC AND home-to-visited request on roaming II-NNI | | | | +| NOTE: | If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | | | + +The table B.6.2 lists the supported header fields within the INFO response. + +###### **Table B.6.2: Supported header fields within the INFO response** + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|---------------------------------|--------------------|------------|---------------------------------------| +| 1 | Accept | 2xx
415 | [13], [39] | o | do | +| 2 | Accept-Encoding | 2xx | [13], [39] | o | do | +| | | 415 | | c | dc | +| 3 | Accept-Language | 2xx
415 | [13], [39] | o | do | +| 4 | Accept-Resource-Priority | 2xx
417 | [78], [39] | o | IF table 6.1.3.1/73 THEN do (NOTE 2) | +| 5 | Allow | 405 | [13], [39] | m | dm | +| | | others | | o | do | +| 6 | Allow-Events | 2xx | [20] | o | IF table 6.1.3.1/23 THEN do (NOTE 2) | +| 7 | Authentication-Info | 2xx | [13], [39] | o | IF table 6.1.3.1/7 THEN do (NOTE 2) | +| 8 | Call-ID | 100 | [13], [39] | m | dm | +| | | others | | | | +| 9 | Call-Info | r | [13], [39] | o | do | +| 10 | Cellular-Network-Info | r | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE 2) | +| 11 | Content-Disposition | r | [13], [39] | o | do | +| 12 | Content-Encoding | r | [13], [39] | o | do | +| 13 | Content-ID | r | [216] | o | IF table 6.1.3.1/122 THEN do | +| 14 | Content-Language | r | [13], [39] | o | do | +| 15 | Content-Length | 100 | [13], [39] | o | do | +| | | others | | | | +| 16 | Content-Type | r | [13], [39] | * | d* | +| 17 | CSeq | 100 | [13], [39] | m | dm | +| | | others | | | | +| 18 | Date | 100 | [13], [39] | o | do | +| | | others | | | | +| 19 | Error-Info | 3xx-6xx | [13], [39] | o | IF table 6.1.3.1/13 THEN do (NOTE 2) | +| 20 | From | 100 | [13], [39] | m | dm | +| | | others | | | | +| 21 | Geolocation-Error | 424 | [68], [39] | m | dm | +| | | others | | o | do | +| 22 | MIME-version | r | [13], [39] | o | do | +| 23 | Organization | r | [13], [39] | n/a | dn/a | +| 24 | P-Access-Network-Info | r | [24], [24A], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE 2) | +| 25 | P-Charging-Function-Addresses | r | [24], [24A] | o | dn/a | +| 26 | P-Charging-Vector | 100 | [24], [24A] | o | dn/a | +| | | others | | o | IF table 6.1.3.1/38 THEN do (NOTE 2) | +| 27 | Privacy | r | [34], [39] | o | do | +| 28 | Proxy-Authenticate | 401
(NOTE 1) | [13], [39] | o | do | +| 29 | Record-Route | 2xx | [13], [39] | o | do | +| 30 | Relayed-Charge | r | [5] | n/a | dn/a | +| 31 | Require | r | [13], [39] | o | do | +| 32 | Response-Source | 3xx-6xx | [5] | n/a | IF table 6.1.3.1/121 THEN do (NOTE 2) | +| 33 | Retry-After | 404
413
480
486
500 | [13], [39] | o | do | + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|------|------------------|-------------------|------------|------------|-----------------------------------------| +| | | 503
600
603 | | | | +| 34 | Security-Server | 421
494 | [47], [39] | o | dn/a | +| 35 | Server | r | [13], [39] | o | do | +| 36 | Session-ID | r | [124] | m | IF table 6.1.3.1/94 THEN dm
(NOTE 2) | +| 37 | Supported | 2xx | [13], [39] | o | do | +| 38 | Timestamp | r | [13], [39] | o | do | +| 39 | To | 100
others | [13], [39] | m | dm | +| 40 | Unsupported | 420 | [13], [39] | o | do | +| 41 | User-Agent | r | [13], [39] | o | do | +| 42 | Via | 100
others | [13], [39] | m | dm | +| 43 | Warning | r | [13], [39] | o | do | +| 44 | WWW-Authenticate | 401
(NOTE 1) | [13], [39] | m | dm | + +NOTE 1: The SIP status code is only applicable over the roaming II-NNI. + +NOTE 2: If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. + +## --- B.7 INVITE method + +The table B.7.1 lists the supported header fields within the INVITE request. + +**Table B.7.1: Supported header fields within the INVITE request** + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|-------------|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Accept | [13] | o | IF dc1 (AOC: clause 12.22) THEN dm ELSE do | +| 2 | Accept-Contact | [51] | o | IF dc2 (PNM: clause 12.17) THEN dm ELSE do | +| 3 | Accept-Encoding | [13] | o | do | +| 4 | Accept-Language | [13] | o | do | +| 5 | Additional-Identity | [5] | n/a | IF table 6.1.3.1/126 THEN do (NOTE 3) | +| 6 | Alert-Info | [13] | o | IF dc3 (CRS: clause 12.15) THEN dm ELSE IF table 6.1.3.1/10 THEN do (NOTE 3) | +| 7 | Allow | [13] | o | do | +| 8 | Allow-Events | [20] | o | IF table 6.1.3.1/23 THEN do (NOTE 3) | +| 9 | Answer-Mode | [94] | o | IF table 6.1.3.1/90 THEN do (NOTE 3) | +| 10 | Authorization | [13] | o | IF table 6.1.3.1/7 THEN do (NOTE 3) | +| 11 | Attestation-Info | [5] | n/a | IF (non-roaming II-NNI OR loopback traversal scenario) AND table 6.1.3.1/123 THEN do (NOTE 3) | +| 12 | Call-ID | [13] | m | dm | +| 13 | Call-Info | [13] | o | IF dc4 (CCBS/CCNR/CCNL: clause 12.11/12.12/12.23) OR dc5 (announcements: clause 12.21) OR dc13 (eCNAM: clause 12.25) THEN dm ELSE do | +| 14 | Cellular-Network-Info | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE 3) | +| 15 | Contact | [13] | m | dm | +| 16 | Content-Disposition | [13] | o | IF dc6 (AOC: clause 12.22) THEN dm ELSE do | +| 17 | Content-Encoding | [13] | o | do | +| 18 | Content-ID | [216] | o | IF table 6.1.3.1/122 THEN do | +| 19 | Content-Language | [13] | o | do | +| 20 | Content-Length | [13] | t | dt | +| 21 | Content-Type | [13] | * | d* | +| 22 | CSeq | [13] | m | dm | +| 23 | Date | [13] | o | do | +| 24 | Expires | [13] | o | do | +| 25 | Feature-Caps | [143] | o | IF table 6.1.3.1/103 THEN do (NOTE 3) | +| 26 | From | [13] | m | dm | +| 27 | Geolocation | [68] | o | do | +| 28 | Geolocation-Routing | [68] | o | do | +| 29 | History-Info | [25] | o | IF dc7 (CDIV: clause 12.6) OR dc2 (PNM: clause 12.17) THEN dm ELSE IF table 6.1.3.1/50 AND initial request THEN do (NOTE 1, NOTE 3) | +| 30 | Identity | [206] | o | IF (non-roaming II-NNI OR loopback traversal scenario) AND table 6.1.3.1/119 THEN do (NOTE 3) | +| 31 | In-Reply-To | [13] | o | do | +| 32 | Join | [55] | o | IF table 6.1.3.1/48 THEN do (NOTE 3) | +| 33 | Max-Breadth | [79] | o | do | +| 34 | Max-Forwards | [13] | m | dm | +| 35 | MIME-Version | [13] | o | do | +| 36 | Min-SE | [52] | o | do | +| 37 | Organization | [13] | o | do | +| 38 | Origination-Id | [5] | n/a | IF (non-roaming II-NNI OR loopback traversal scenario) AND table 6.1.3.1/124 THEN do (NOTE 3) | +| 39 | P-Access-Network-Info | [24], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE 3) | +| 40 | P-Asserted-Identity | [44] | o | IF table 6.1.3.1/27 AND initial request THEN dm (NOTE 2, NOTE 3) | +| 41 | P-Asserted-Service | [26] | o | IF (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited request on roaming II-NNI) AND table 6.1.3.1/77 AND initial request THEN do (NOTE 3) | +| 42 | P-Called-Party-ID | [24] | o | IF home-to-visited request on roaming II-NNI AND table 6.1.3.1/34 THEN do (NOTE 3) | +| 43 | P-Charging-Function-Addresses | [24] | o | dn/a | +| 44 | P-Charging-Vector | [24] | o | IF table 6.1.3.1/38 AND initial request THEN dm (NOTE 3) | + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|------------|------------------------------------------------------------------------------------------------------------------------------------| +| 45 | P-Early-Media | [74] | o | IF table 6.1.3.1/69 THEN do (NOTE 3) | +| 46 | P-Media-Authorization | [42] | o | dn/a | +| 47 | P-Preferred-Identity | [44] | o | dn/a | +| 48 | P-Preferred-Service | [26] | o | IF visited-to-home request on roaming II-NNI AND table 6.1.3.1/77 AND initial request THEN do (NOTE 3) | +| 49 | P-Private-Network-Indication | [84] | o | IF table 6.1.3.1/80 AND initial request THEN do (NOTE 3) | +| 50 | P-Profile-Key | [64] | o | IF table 6.1.3.1/59 AND initial request THEN do (NOTE 3) | +| 51 | P-Served-User | [85] | o | IF visited-to-home request on roaming II-NNI AND initial request being sent from "privileged sender" THEN dm (NOTE 3) | +| 52 | P-User-Database | [60] | o | dn/a | +| 53 | P-Visited-Network-ID | [24] | o | dn/a | +| 54 | Priority | [13] | o | do | +| 55 | Priority-Share | [5] | n/a | IF home-to-visited request on roaming II-NNI AND table 6.1.3.1/118 THEN do (NOTE 3) | +| 56 | Privacy | [34] | o | IF dc8 (OIP/OIR: clause 12.3) THEN dm ELSE do | +| 57 | Priv-Answer-Mode | [94] | o | IF table 6.1.3.1/90 THEN do (NOTE 3) | +| 58 | Proxy-Authorization | [13] | o | IF table 6.1.3.1/7 THEN do (NOTE 3) | +| 59 | Proxy-Require | [13] | o | do | +| 60 | Reason | [48] | o | IF table 6.1.3.1/40 AND subsequent request THEN do (NOTE 3) | +| 61 | Record-Route | [13] | o | do | +| 62 | Recv-Info | [39] | m | IF table 6.1.3.1/17 THEN dm (NOTE 3) | +| 63 | Referred-By | [53] | o | IF dc9 (ECT: clause 12.13) OR dc10 (CONF: clause 12.19) THEN dm ELSE do | +| 64 | Reject-Contact | [51] | o | do | +| 65 | Relayed-Charge | [5] | n/a | dn/a | +| 66 | Replaces | [54] | o | IF dc11 (ECT: clause 12.13) OR dc12 (CONF: clause 12.19) THEN dm ELSE IF table 6.1.3.1/47 THEN do (NOTE 3) | +| 67 | Reply-To | [13] | o | do | +| 68 | Request-Disposition | [51] | o | do | +| 69 | Require | [13] | c | IF dc11 (ECT: clause 12.13) THEN dm ELSE dc | +| 70 | Resource-Priority | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE 3) | +| 71 | Resource-Share | [5] | n/a | IF (home-to-visited request on roaming II-NNI OR visited-to-home request on roaming II-NNI) AND table 6.1.3.1/116 THEN do (NOTE 3) | +| 72 | Restoration-Info | [5] | n/a | IF home-to-visited request on roaming II-NNI AND initial request AND table 6.1.3.1/113 THEN do (NOTE 3) | +| 73 | Route | [13] | c | dc | +| 74 | Security-Client | [47] | o | dn/a | +| 75 | Security-Verify | [47] | o | dn/a | +| 76 | Service-Interact-Info | [5] | n/a | IF table 6.1.3.1/125 AND initial request THEN do (NOTE 3) | +| 77 | Session-Expires | [52] | o | do | +| 78 | Session-ID | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE 3) | +| 79 | Subject | [13] | o | do | +| 80 | Supported | [13] | m* | IF dc2 (PNM: clause 12.17) THEN dm ELSE dm* | +| 81 | Target-Dialog | [140] | o | IF table 6.1.3.1/102 THEN do (NOTE 3) | +| 82 | Timestamp | [13] | o | do | +| 83 | To | [13] | m | dm | +| 84 | Trigger-Consent | [82] | o | IF table 6.1.3.1/78 THEN do (NOTE 3) | +| 85 | User-Agent | [13] | o | do | +| 86 | User-to-User | [83] | o | IF table 6.1.3.1/79 THEN do (NOTE 3) | +| 87 | Via | [13] | m | dm | +| dc1: | request invoked due to AOC AND visited-to-home request on roaming II-NNI | | | | +| dc2: | initial request invoked due to PNM in case of ("PN UE redirection" OR "PN access control") AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited request on roaming II-NNI) | | | | + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------|------------|------------------| +| dc3: | initial request invoked due to CRS AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited request on roaming II-NNI) | | | | +| dc4: | initial request invoked due to CCBS/CCNR/CCNL AND "CC call" request AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited request on roaming II-NNI) | | | | +| dc5: | subsequent request invoked due to announcements using the Call-info header field AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited request on roaming II-NNI) | | | | +| dc6: | request invoked due to AOC AND home-to-visited request on roaming II-NNI | | | | +| dc7: | initial request towards the network serving "the diverted-to user" AND CFU/CFB/CFNR/CFNRc/CD/CFNL AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited request on roaming II-NNI) | | | | +| dc8: | (initial request invoked due to OIP/OIR AND "override the default setting" in temporary mode AND visited-to-home request on roaming II-NNI) OR (initial request invoked due to OIP/OIR AND "presentation of the public user identity is restricted" AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited request on roaming II-NNI)) | | | | +| dc9: | initial request invoked due to ECT AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited request on roaming II-NNI) | | | | +| dc10: | (initial request from "conference participant" receiving REFER request with Referred-By header field AND (visited-to-home request on roaming II-NNI OR non-roaming II-NNI OR loopback traversal scenario)) OR (initial request from "conference focus" receiving REFER request AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited request on roaming II-NNI)) | | | | +| dc11: | "Consultative transfer" due to ECT AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited request on roaming II-NNI) | | | | +| dc12: | initial request from "conference focus" receiving REFER request with Replaces header field escaped in Refer-To header field AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited request on roaming II-NNI) | | | | +| dc13: | initial request AND home-to-visited request on roaming II-NNI | | | | +| NOTE 1: | The Privacy header field can be escaped in the header field for CDIV. | | | | +| NOTE 2: | The header field is not included in some exceptional cases. (e.g. when an incoming call from a circuit-switched network has not included the required information to be mapped into the header field) | | | | +| NOTE 3: | If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | | | + +The table B.7.2 lists the supported header fields within the INVITE response. + +**Table B.7.2: Supported header fields within the INVITE response** + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|------|--------------------------|-----------------|-------------|------------|-----------------------------------------------------------------------------------------------------------------| +| 1 | Accept | 2xx | [13] | o | do | +| | | 415 | | c | dc | +| 2 | Accept-Encoding | 2xx | [13] | o | do | +| | | 415 | | c | dc | +| 3 | Accept-Language | 2xx | [13] | o | do | +| | | 415 | | c | dc | +| 4 | Accept-Resource-Priority | 2xx
417 | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE 3) | +| 5 | Alert-Info | 180 | [13] | o | IF dc1 (CW: clause 12.7) OR dc2 (announcements: clause 12.21) THEN dm ELSE IF table 6.1.3.1/10 THEN do (NOTE 3) | +| 6 | Allow | 2xx | [13] | m* | dm* | +| | | 405 | | m | dm | +| | | others | | o | do | +| 7 | Allow-Events | 2xx | [20] | o | IF table 6.1.3.1/23 THEN do (NOTE 3) | +| 8 | Answer-Mode | 2xx | [94] | o | IF table 6.1.3.1/90 THEN do (NOTE 3) | +| 9 | Authentication-Info | 2xx | [13] | o | IF table 6.1.3.1/7 THEN do (NOTE 3) | +| 10 | Call-ID | 100 | [13] | m | dm | +| | | others | | | | +| 11 | Call-Info | r | [13] | o | IF dc3 (CCBS: clause 12.11) OR dc4 (CCNR: clause 12.12) OR dc5 (CCNL: clause 12.23) THEN dm ELSE do | +| 12 | Cellular-Network-Info | r | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE 3) | +| 13 | Contact | 18x | [13]
[5] | o | dm | +| | | 199 | | | | +| | | 2xx | | m | dm | +| | | 3xx
485 | | o | do | +| 14 | Content-Disposition | r | [13] | o | IF dc6 (AOC: clause 12.22) THEN dm ELSE do | +| 15 | Content-Encoding | r | [13] | o | do | +| 16 | Content-ID | r | [216] | o | IF table 6.1.3.1/122 THEN do | +| 17 | Content-Language | r | [13] | o | do | +| 18 | Content-Length | 100 | [13] | t | dt | +| | | others | | | | +| 19 | Content-Type | r | [13] | * | IF dc7 (CCBS: clause 12.11) OR dc8 (CCNR/CCNL: clause 12.12/12.23) THEN dm ELSE d* | +| 20 | CSeq | 100 | [13] | m | dm | +| | | others | | | | +| 21 | Date | 100 | [13] | o | IF dc7 (CCBS: clause 12.11) OR dc8 (CCNR/CCNL: clause 12.12/12.23) THEN dm ELSE do | +| | | others | | | | +| 22 | Error-Info | 3xx-6xx | [13] | o | IF dc9 (announcements: clause 12.21) THEN dm ELSE IF table 6.1.3.1/13 THEN do (NOTE 3) | +| 23 | Expires | r | [13] | o | do | +| 24 | Feature-Caps | 18x | [143] | o | IF table 6.1.3.1/103 THEN do (NOTE 3) | +| | | 2xx | | | | +| 25 | From | 100 | [13] | m | dm | +| | | others | | | | +| 26 | Geolocation-Error | 424 | [68] | m | dm | +| | | others | | o | do | +| 27 | History-Info | r | [25] | o | IF dc10 (CDIV: clause 12.6) THEN dm ELSE IF table 6.1.3.1/50 AND response to initial request THEN do | + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|-----------------|--------------------|------------|---------------------------------------------------------------------------------------------------------------------| +| | | | | | (NOTE 2, NOTE 3) | +| 28 | MIME-version | r | [13] | o | do | +| 29 | Min-SE | 422 | [52] | m | dm | +| 30 | Organization | r | [13] | o | do | +| 31 | P-Access-Network-Info | r | [24], [24A], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE 3) | +| 32 | P-Answer-State | 18x
2xx | [73] | o | IF table 6.1.3.1/68 THEN do (NOTE 3) | +| 33 | P-Asserted-Identity | r | [44] | o | IF dc11 (TIP/TIR: clause 12.4) THEN dm ELSE IF table 6.1.3.1/27 AND response to initial request THEN do (NOTE 3) | +| 34 | P-Charging-Function-Addresses | r | [24], [24A] | o | dn/a | +| 35 | P-Charging-Vector | 100 | [24], [24A] | o | dn/a | +| | | 18x, 2xx | | o | IF (table 6.1.3.1/38 AND response to initial request) OR dc 12(CONF: clause 12.19) THEN dm (NOTE 3) | +| | | 3xx-6xx | | o | do (NOTE 3) | +| 36 | P-Early-Media | 18x | [74] | o | IF dc13 (CAT: clause 12.14) OR dc14 (announcements: clause 12.21) THEN dm ELSE IF table 6.1.3.1/69 THEN do (NOTE 3) | +| 37 | P-Media-Authorization | 18x
2xx | [42] | o | dn/a | +| 38 | P-Preferred-Identity | r | [44] | o | dn/a | +| 39 | P-Refused-URI-List | 403 | [141] | o | IF (non-roaming II-NNI OR loopback traversal scenario) AND table 6.1.3.1/101 THEN do (NOTE 3) | +| 40 | Permission-Missing | 470 | [82] | o | IF table 6.1.3.1/78 THEN do (NOTE 3) | +| 41 | Priority-Share | 18x
2xx | [5] | n/a | IF home-to-visited response on roaming II-NNI AND table 6.1.3.1/118 THEN do (NOTE 3) | +| 42 | Privacy | r | [34] | o | IF dc15 (TIP/TIR: clause 12.4) THEN dm ELSE do | +| 43 | Priv-Answer-Mode | 2xx | [94] | o | IF table 6.1.3.1/90 THEN do (NOTE 3) | +| 44 | Proxy-Authenticate | 401
(NOTE 1) | [13] | o | do | + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|------|-----------------------|------------------------------------------------------|-------|------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | 407
(NOTE 1) | | m | dm | +| 45 | Reason | 18x
199
3xx-6xx | [48] | o | IF dc16 (CW: clause 12.7) OR
dc17 (ICB: clause 12.10.1) OR
dc18 (announcements: clause 12.21)
THEN dm ELSE IF table 6.1.3.1/40
THEN do (NOTE 3) | +| 46 | Record-Route | 18x
199
2xx | [13] | o | do | +| 47 | Recv-Info | 18x
199
2xx | [39] | c | IF table 6.1.3.1/17 THEN dc
(NOTE 3) | +| 48 | Relayed-Charge | r | [5] | n/a | dn/a | +| 49 | Reply-To | r | [13] | o | do | +| 50 | Require | r | [13] | c | IF dc19 (CAT: clause 12.14) THEN
dm ELSE dc | +| 51 | Resource-Share | 18x
2xx | [5] | n/a | IF (home-to-visited response on
roaming II-NNI OR visited-to-home
response on roaming II-NNI) AND
table 6.1.3.1/116 THEN do (NOTE 3) | +| 52 | Response-Source | 3xx-6xx | [5] | n/a | IF table 6.1.3.1/121 THEN do
(NOTE 3) | +| 53 | Restoration-Info | 408 | [5] | n/a | IF table 6.1.3.1/114 AND response to
initial request AND visited-to-home
response on roaming II-NNI THEN do
(NOTE 3) | +| 54 | Retry-After | 404
413
480
486
500
503
600
603 | [13] | o | do | +| 55 | RSeq | 18x
199 | [18] | o | do | +| 56 | Security-Server | 421
494 | [47] | o | dn/a | +| 57 | Server | r | [13] | o | do | +| 58 | Service-Interact-Info | 18x
2xx | [5] | n/a | IF table 6.1.3.1/125 AND response to
initial request THEN do (NOTE 3) | +| 59 | Session-Expires | 2xx | [52] | o | do | +| 60 | Session-ID | r | [124] | m | IF table 6.1.3.1/94 THEN dm
(NOTE 3) | +| 61 | Supported | 2xx | [13] | m* | dm* | +| 62 | Timestamp | r | [13] | o | do | +| 63 | To | 100
others | [13] | m | dm | +| 64 | Unsupported | 420 | [13] | m | dm | +| 65 | User-Agent | r | [13] | o | do | +| 66 | User-to-User | r | [83] | o | IF table 6.1.3.1/79 THEN do
(NOTE 3) | +| 67 | Via | 100
others | [13] | m | dm | +| 68 | Warning | r | [13] | o | IF dc20 (CDIV: clause 12.6) THEN
dm ELSE do | +| 69 | WWW-Authenticate | 401
(NOTE 1) | [13] | m | dm | + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|------|------------|------------------| +| | | 407
(NOTE 1) | | o | do | +| dc1: | response invoked due to CW AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited response on roaming II-NNI) | | | | | +| dc2: | response to initial request invoked due to announcements using the Alert-Info header field AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited response on roaming II-NNI) | | | | | +| dc3: | 486 (Busy Here) response invoked due to CCBS AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited response on roaming II-NNI) | | | | | +| dc4: | 180 (Ringing) response invoked due to CCNR AND (non-roaming II-NNI OR loopback traversal scenario) | | | | | +| dc5: | 480 (Temporarily Unavailable) response invoked due to CCNL AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited response on roaming II-NNI) | | | | | +| dc6: | non-100 provisional response /200 (OK) response invoked due to AOC AND home-to-visited response on roaming II-NNI | | | | | +| dc7: | 486 (Busy Here) response invoked due to CCBS AND home-to-visited response on roaming II-NNI | | | | | +| dc8: | 480 (Temporarily Unavailable) response invoked due to CCNR/CCNL AND home-to-visited response on roaming II-NNI | | | | | +| dc9: | response to initial request invoked due to announcements using the Error-Info header field AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited response on roaming II-NNI) | | | | | +| dc10: | 180 (Ringing)/181 (Call Is Being Forwarded)/200 (OK) response to initial request AND CFU/CFB/CFNR/CFNRc/CD/CFNL AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited response on roaming II-NNI) | | | | | +| dc11: | (TIP/TIR AND 2xx response to initial request AND (visited-to-home response on roaming II-NNI OR non-roaming II-NNI OR loopback traversal scenario)) OR (TIP/TIR AND response to initial request AND "presentation is allowed" AND home-to-visited response on roaming II-NNI) | | | | | +| dc12: | first response from "conference focus" to initial request AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited response on roaming II-NNI) | | | | | +| dc13: | reliable 18x response to initial request invoked due to CAT using ("forking model" OR "gateway model") AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited response on roaming II-NNI) | | | | | +| dc14: | 18x response to initial request invoked due to announcements authorizing early media AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited response on roaming II-NNI) | | | | | +| dc15: | (TIP/TIR AND non-100 response to initial request AND "override the default setting" in temporary mode AND visited-to-home response on roaming II-NNI) OR (TIP/TIR AND 2xx response to initial request AND "presentation of the network asserted identity is restricted" AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited response on roaming II-NNI)) | | | | | +| dc16: | 480 (Temporarily Unavailable) response invoked due to CW at the expiry of the "CW timer" | | | | | +| dc17: | 603 (Decline) response invoked due to "dynamic ICB" on an early dialog | | | | | +| dc18: | 183 (Session Progress) response to initial request invoked due to announcements authorizing early media when rejecting a communication request AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited response on roaming II-NNI) | | | | | +| dc19: | first 18x response to initial request invoked due to CAT using "early session model" AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited response on roaming II-NNI) | | | | | +| dc20: | 480 (Temporarily Unavailable)/486 (Busy Here) response to initial request AND CFU/CFB/CFNR/CFNRc/CD/CFNL in case "maximum number of diversions" exceeds AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited response on roaming II-NNI) | | | | | +| NOTE 1: | The SIP status code is only applicable over the roaming II-NNI. | | | | | +| NOTE 2: | The Privacy header field can be escaped in the header field for CDIV. | | | | | +| NOTE 3: | If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | | | | + +## --- B.8 MESSAGE method + +As described in table 6.1, the support of MESSAGE method over the II-NNI is based on bilateral agreement between the operators. + +The table B.8.1 lists the supported header fields within the MESSAGE request. + +**Table B.8.1: Supported header fields within the MESSAGE request** + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|-------------|------------|-------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Accept-Contact | [51] | o | IF dc1 (PNM: clause 12.17) THEN dm ELSE do | +| 2 | Additional-Identity | [5] | n/a | IF table 6.1.3.1/126 THEN do (NOTE) | +| 3 | Allow | [13], [19] | o | do | +| 4 | Allow-Events | [20] | o | IF table 6.1.3.1/23 THEN do (NOTE) | +| 5 | Attestation-Info | [5] | n/a | IF (non-roaming II-NNI OR loopback traversal scenario) AND table 6.1.3.1/123 THEN do (NOTE) | +| 6 | Authorization | [13], [19] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 7 | Call-ID | [13], [19] | m | dm | +| 8 | Call-Info | [13], [19] | o | do | +| 9 | Cellular-Network-Info | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE) | +| 10 | Content-Disposition | [13], [19] | o | do | +| 11 | Content-Encoding | [13], [19] | o | do | +| 12 | Content-ID | [216] | o | IF table 6.1.3.1/122 THEN do | +| 13 | Content-Language | [13], [19] | o | do | +| 14 | Content-Length | [13], [19] | t | dt | +| 15 | Content-Type | [13], [19] | * | d* | +| 16 | CSeq | [13], [19] | m | dm | +| 17 | Date | [13], [19] | o | do | +| 18 | Expires | [13], [19] | o | do | +| 19 | Feature-Caps | [143] | o | IF table 6.1.3.1/103 AND request outside an existing dialog THEN do (NOTE) | +| 20 | From | [13], [19] | m | dm | +| 21 | Geolocation | [68] | o | do | +| 22 | Geolocation-Routing | [68] | o | do | +| 23 | History-Info | [25] | o | IF dc1 (PNM: clause 12.17) THEN dm ELSE IF table 6.1.3.1/50 AND request outside an existing dialog THEN do (NOTE) | +| 24 | Identity | [206] | o | IF (non-roaming II-NNI OR loopback traversal scenario) AND table 6.1.3.1/119 THEN do (NOTE) | +| 25 | In-Reply-To | [13], [19] | o | do | +| 26 | Max-Breadth | [79] | o | do | +| 27 | Max-Forwards | [13], [19] | m | dm | +| 28 | MIME-Version | [13] | o | do | +| 29 | Organization | [13], [19] | o | do | +| 30 | Origination-Id | [5] | n/a | IF (non-roaming II-NNI OR loopback traversal scenario) AND table 6.1.3.1/124 THEN do (NOTE) | +| 31 | P-Access-Network-Info | [24], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE) | +| 32 | P-Asserted-Identity | [44] | o | IF table 6.1.3.1/27 AND request outside an existing dialog THEN dm (NOTE) | +| 33 | P-Asserted-Service | [26] | o | IF (non-roaming II-NNI OR home-to-visited request on roaming II-NNI) AND table 6.1.3.1/77 AND request outside an existing dialog THEN do (NOTE) | +| 34 | P-Called-Party-ID | [24] | o | IF home-to-visited request on roaming II-NNI AND table 6.1.3.1/34 THEN do (NOTE) | +| 35 | P-Charging-Function-Addresses | [24] | o | dn/a | +| 36 | P-Charging-Vector | [24] | o | IF table 6.1.3.1/38 AND request outside an existing dialog THEN dm (NOTE) | +| 37 | P-Preferred-Identity | [44] | o | dn/a | +| 38 | P-Preferred-Service | [26] | o | IF visited-to-home request on roaming II-NNI AND table 6.1.3.1/77 AND request outside an existing dialog THEN do (NOTE) | +| 39 | P-Private-Network-Indication | [84] | o | IF table 6.1.3.1/80 AND request outside an existing dialog THEN do (NOTE) | +| 40 | P-Profile-Key | [64] | o | IF table 6.1.3.1/59 AND request outside an existing dialog THEN do (NOTE) | +| 41 | P-Served-User | [85] | o | IF visited-to-home request on roaming II-NNI AND request outside an existing dialog being sent from "privileged sender" THEN dm (NOTE) | +| 42 | P-User-Database | [60] | o | dn/a | +| 43 | P-Visited-Network-ID | [24] | o | dn/a | + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|-------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|------------|----------------------------------------------------------------------------| +| 44 | Priority | [13], [19] | o | do | +| 45 | Privacy | [34] | o | IF dc2 (OIP/OIR: clause 12.3) THEN dm ELSE do | +| 46 | Proxy-Authorization | [13], [19] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 47 | Proxy-Require | [13], [19] | o | do | +| 48 | Reason | [48] | o | IF table 6.1.3.1/40 AND request inside an existing dialog THEN do (NOTE) | +| 49 | Referred-By | [53] | o | do | +| 50 | Reject-Contact | [51] | o | do | +| 51 | Relayed-Charge | [5] | n/a | dn/a | +| 52 | Reply-To | [13], [19] | o | do | +| 53 | Request-Disposition | [51] | o | do | +| 54 | Require | [13], [19] | c | dc | +| 55 | Resource-Priority | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE) | +| 56 | Route | [13], [19] | c | dc | +| 57 | Security-Client | [47] | o | dn/a | +| 58 | Security-Verify | [47] | o | dn/a | +| 59 | Service-Interact-Info | [5] | n/a | IF table 6.1.3.1/125 AND request outside an existing dialog THEN do (NOTE) | +| 60 | Session-ID | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE) | +| 61 | Subject | [13], [19] | o | do | +| 62 | Supported | [13] | o | IF dc1 (PNM: clause 12.17) THEN dm ELSE do | +| 63 | Timestamp | [13], [19] | o | do | +| 64 | To | [13], [19] | m | dm | +| 65 | Trigger-Consent | [82] | o | IF table 6.1.3.1/78 THEN do (NOTE) | +| 66 | User-Agent | [13], [19] | o | do | +| 67 | Via | [13], [19] | m | dm | +| dc1: | request outside an existing dialog invoked due to PNM in case of ("PN UE redirection" OR "PN access control") AND (non-roaming II-NNI OR home-to-visited request on roaming II-NNI) | | | | +| dc2: | (request outside an existing dialog invoked due to OIP/OIR AND "override the default setting" in temporary mode AND visited-to-home request on roaming II-NNI) OR (request outside an existing dialog invoked due to OIP/OIR AND "presentation of the public user identity is restricted" AND (non-roaming II-NNI OR home-to-visited request on roaming II-NNI)) | | | | +| NOTE: | If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | | | + +The table B.8.2 lists the supported header fields within the MESSAGE response. + +###### **Table B.8.2: Supported header fields within the MESSAGE response** + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|----------------------------|--------------------|-------------|------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Accept | 415 | [13], [19] | m* | dm* | +| 2 | Accept-Encoding | 415 | [13], [19] | m* | dm* | +| 3 | Accept-Language | 415 | [13], [19] | m* | dm* | +| 4 | Accept-Resource-Priority | 2xx
417 | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE 2) | +| 5 | Allow | 405 | [13], [19] | m | dm | +| | | others | | o | do | +| 6 | Allow-Events | 2xx | [20] | o | IF table 6.1.3.1/23 THEN do (NOTE 2) | +| 7 | Authentication-Info | 2xx | [13], [19] | o | IF table 6.1.3.1/7 THEN do (NOTE 2) | +| 8 | Call-ID | 100
others | [13], [19] | m | dm | +| 9 | Call-Info | r | [13], [19] | o | do | +| 10 | Cellular-Network-Info | r | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE 2) | +| 11 | Contact | 3xx
485 | [13], [19] | o | do | +| 12 | Content-Disposition | r | [13], [19] | o | do | +| 13 | Content-Encoding | r | [13], [19] | o | do | +| 14 | Content-ID | r | [216] | o | IF table 6.1.3.1/122 THEN do | +| 15 | Content-Language | r | [13], [19] | o | do | +| 16 | Content-Length | 100
others | [13], [19] | t | dt | +| 17 | Content-Type | r | [13], [19] | * | d* | +| 18 | CSeq | 100
others | [13], [19] | m | dm | +| 19 | Date | 100
others | [13], [19] | o | do | +| 20 | Error-Info | 3xx-6xx | [13], [19] | o | IF table 6.1.3.1/13 THEN do (NOTE 2) | +| 21 | Expires | r | [13], [19] | o | do | +| 22 | Feature-Caps | 2xx | [143] | o | IF table 6.1.3.1/103 AND response to request outside an existing dialog THEN do (NOTE 2) | +| 23 | From | 100
others | [13], [19] | m | dm | +| 24 | Geolocation-Error | 424
others | [68] | m
o | dm
do | +| 25 | History-Info | r | [25] | o | IF table 6.1.3.1/50 AND response to request outside an existing dialog THEN do (NOTE 2) | +| 26 | MIME-version | r | [13] | o | do | +| 27 | Organization | r | [13], [19] | o | do | +| 28 | P-Access-Network-Info | r | [24], [24A], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE 2) | +| 29 | P-Asserted-Identity | r | [44] | o | IF dc1 (TIP/TIR: clause 12.4) THEN dm ELSE IF table 6.1.3.1/27 AND response to request outside an existing dialog THEN do (NOTE 2) | +| 30 | P-Charging-Function-Addresses | r | [24], [24A], [24B] | o | dn/a | +| 31 | P-Charging-Vector | 100
18x, 2xx
3xx-6xx | [24], [24A] | o
o
o | dn/a
IF table 6.1.3.1/38 AND response to request outside an existing dialog THEN dm (NOTE 2)
do (NOTE 3) | +| 32 | P-Preferred-Identity | r | [44] | o | dn/a | +| 33 | Permission-Missing | 470 | [82] | o | IF table 6.1.3.1/78 THEN do (NOTE 2) | +| 34 | Privacy | r | [34] | o | IF dc2(TIP/TIR: clause 12.4) THEN dm ELSE do | +| 35 | Proxy-Authenticate | 401 | [13], [19] | o | do | + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|------------|------------|------------------------------------------------------------------------------------------| +| | | (NOTE 1) | | | | +| | | 407
(NOTE 1) | | m | dm | +| 36 | Relayed-Charge | r | [5] | n/a | dn/a | +| 37 | Reply-To | r | [13], [19] | o | do | +| 38 | Require | r | [13], [19] | c | dc | +| 39 | Response-Source | 3xx-6xx | [5] | n/a | IF table 6.1.3.1/121 THEN do
(NOTE 2) | +| 40 | Restoration-Info | 504 | [5] | n/a | IF table 6.1.3.1/114 AND visited-to-home response on roaming II-NNI THEN do (NOTE 2) | +| 41 | Retry-After | 404
413
480
486
500
503
600
603 | [13], [19] | o | do | +| 42 | Security-Server | 421
494 | [47] | o | dn/a | +| 43 | Server | r | [13], [19] | o | do | +| 44 | Service-Interact-Info | 18x
2xx | [5] | n/a | IF table 6.1.3.1/125 AND response to request outside an existing dialog THEN do (NOTE 2) | +| 45 | Session-ID | r | [124] | m | IF table 6.1.3.1/94 THEN dm
(NOTE 2) | +| 46 | Supported | 2xx | [13] | o | do | +| 47 | Timestamp | r | [13], [19] | o | do | +| 48 | To | 100
others | [13], [19] | m | dm | +| 49 | Unsupported | 420 | [13], [19] | o | do | +| 50 | User-Agent | r | [13], [19] | o | do | +| 51 | Via | 100
others | [13], [19] | m | dm | +| 52 | Warning | r | [13], [19] | o | do | +| 53 | WWW-Authenticate | 401
(NOTE 1) | [13], [19] | m | dm | +| | | 407
(NOTE 1) | | o | do | +| dc1: | (TIP/TIR AND 2xx response to request outside an existing dialog AND (visited-to-home response on roaming II-NNI OR non-roaming II-NNI)) OR (TIP/TIR AND response to request outside an existing dialog AND "presentation is allowed" AND home-to-visited response on roaming II-NNI) | | | | | +| dc2: | (TIP/TIR AND non-100 response to request outside an existing dialog AND "override the default setting" in temporary mode AND visited-to-home response on roaming II-NNI) OR (TIP/TIR AND 2xx response to request outside an existing dialog AND "presentation of the network asserted identity is restricted" AND (non-roaming II-NNI OR home-to-visited response on roaming II-NNI)) | | | | | +| NOTE 1: | The SIP status code is only applicable over the roaming II-NNI. | | | | | +| NOTE 2: | If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | | | | + +## --- B.9 NOTIFY method + +As described in table 6.1, the support of NOTIFY method over the non-roaming II-NNI is based on bilateral agreement between the operators. + +The table B.9.1 lists the supported header fields within the NOTIFY request. + +**Table B.9.1: Supported header fields within the NOTIFY request** + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|-------------|------------|-------------------------------------| +| 1 | Accept | [13], [20] | o | do | +| 2 | Accept-Contact | [51] | o | do | +| 3 | Accept-Encoding | [13], [20] | o | do | +| 4 | Accept-Language | [13], [20] | o | do | +| 5 | Allow | [13], [20] | o | do | +| 6 | Allow-Events | [20] | o | do | +| 7 | Authorization | [13], [20] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 8 | Call-ID | [13], [20] | m | dm | +| 9 | Call-Info | [13] | o | do | +| 10 | Cellular-Network-Info | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE) | +| 11 | Contact | [13], [20] | m | dm | +| 12 | Content-Disposition | [13], [20] | o | do | +| 13 | Content-Encoding | [13], [20] | o | do | +| 14 | Content-ID | [216] | o | IF table 6.1.3.1/122 THEN do | +| 15 | Content-Language | [13], [20] | o | do | +| 16 | Content-Length | [13], [20] | t | dt | +| 17 | Content-Type | [13], [20] | * | d* | +| 18 | CSeq | [13], [20] | m | dm | +| 19 | Date | [13], [20] | o | do | +| 20 | Event | [20] | m | dm | +| 21 | Feature-Caps | [143] | o | IF table 6.1.3.1/103 THEN do (NOTE) | +| 22 | From | [13], [20] | m | dm | +| 23 | Geolocation | [68] | o | do | +| 24 | Geolocation-Routing | [68] | o | do | +| 25 | History-Info | [25] | o | IF table 6.1.3.1/50 THEN do (NOTE) | +| 26 | Max-Breadth | [79] | o | do | +| 27 | Max-Forwards | [13], [20] | m | dm | +| 28 | MIME-Version | [13], [20] | o | do | +| 29 | P-Access-Network-Info | [24], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE) | +| 30 | P-Asserted-Identity | [44] | o | IF table 6.1.3.1/27 THEN do (NOTE) | +| 31 | P-Charging-Function-Addresses | [24] | o | dn/a | +| 32 | P-Charging-Vector | [24] | o | IF table 6.1.3.1/38 THEN dm (NOTE) | +| 33 | P-Preferred-Identity | [44] | o | dn/a | +| 34 | Privacy | [34] | o | do | +| 35 | Proxy-Authorization | [13], [20] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 36 | Proxy-Require | [13], [20] | o | do | +| 37 | Reason | [48] | o | IF table 6.1.3.1/40 THEN do (NOTE) | +| 38 | Record-Route | [13], [20] | o | do | +| 39 | Referred-By | [53] | o | do | +| 40 | Reject-Contact | [51] | o | do | +| 41 | Relayed-Charge | [5] | n/a | dn/a | +| 42 | Request-Disposition | [51] | o | do | +| 43 | Require | [13], [20] | o | do | +| 44 | Resource-Priority | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE) | +| 45 | Route | [13], [20] | c | dc | +| 46 | Security-Client | [47] | o | dn/a | +| 47 | Security-Verify | [47] | o | dn/a | +| 48 | Session-ID | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE) | +| 49 | Subscription-State | [20] | m | dm | +| 50 | Supported | [13], [20] | o | do | +| 51 | Timestamp | [13], [20] | o | do | +| 52 | To | [13], [20] | m | dm | +| 53 | User-Agent | [13], [20] | o | do | +| 54 | Via | [13], [20] | m | dm | +| 55 | Warning | [13], [20] | o | do | + +NOTE: If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. + +The table B.9.2 lists the supported header fields within the NOTIFY response. + +###### **Table B.9.2: Supported header fields within the NOTIFY response** + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|------------------------------|--------------------|-------------|--------------------------------------------------------------------------------------| +| 1 | Accept | 415 | [13], [20] | o | do | +| 2 | Accept-Encoding | 415 | [13], [20] | o | do | +| 3 | Accept-Language | 415 | [13], [20] | o | do | +| 4 | Accept-Resource-Priority | 2xx
417 | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE 2) | +| 5 | Allow | 405
others | [13], [20] | m
o | dm
do | +| 6 | Allow-Events | 2xx
489 | [20] | o
m | do
dm | +| 7 | Authentication-Info | 2xx | [13], [20] | o | IF table 6.1.3.1/7 THEN do (NOTE 2) | +| 8 | Call-ID | 100
others | [13], [20] | m | dm | +| 9 | Cellular-Network-Info | r | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE 2) | +| 10 | Contact | 2xx
3xx
485 | [13], [20] | o
m
o | do
dm
do | +| 11 | Content-Disposition | r | [13], [20] | o | do | +| 12 | Content-Encoding | r | [13], [20] | o | do | +| 13 | Content-ID | r | [216] | o | IF table 6.1.3.1/122 THEN do | +| 14 | Content-Language | r | [13], [20] | o | do | +| 15 | Content-Length | 100
others | [13], [20] | t | dt | +| 16 | Content-Type | r | [13], [20] | * | d* | +| 17 | CSeq | 100
others | [13], [20] | m | dm | +| 18 | Date | 100
others | [13], [20] | o | do | +| 19 | Error-Info | 3xx-6xx | [13], [20] | o | IF table 6.1.3.1/13 THEN do (NOTE 2) | +| 20 | Feature-Caps | 2xx | [143] | o | IF table 6.1.3.1/103 THEN do (NOTE 2) | +| 21 | From | 100
others | [13], [20] | m | dm | +| 22 | Geolocation-Error | 424
others | [68] | m
o | dm
do | +| 23 | MIME-version | r | [13], [20] | o | do | +| 24 | P-Access-Network-Info | r | [24], [24A], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE 2) | +| 25 | P-Asserted-Identity | r | [44] | o | IF table 6.1.3.1/27 THEN do (NOTE 2) | +| 26 | P-Charging-Function-Addresses | r | [24], [24A] | o | dn/a | +| 27 | P-Charging-Vector | 100
18x, 2xx
3xx-6xx | [24], [24A] | o
o
o | dn/a
IF table 6.1.3.1/38 THEN dm (NOTE 2)
do (NOTE 3) | +| 28 | P-Preferred-Identity | r | [44] | o | dn/a | +| 29 | Privacy | r | [34] | o | do | +| 30 | Proxy-Authenticate | 401 (NOTE 1)
407 (NOTE 1) | [13], [20] | o
m | do
dm | +| 31 | Record-Route | 2xx | [13], [20] | o | do | +| 32 | Relayed-Charge | r | [5] | n/a | dn/a | +| 33 | Require | r | [13], [20] | o | do | +| 34 | Response-Source | 3xx-6xx | [5] | n/a | IF table 6.1.3.1/121 THEN do (NOTE 2) | +| 35 | Restoration-Info | 504 | [5] | n/a | IF table 6.1.3.1/114 AND visited-to-home response on roaming II-NNI THEN do (NOTE 2) | +| 36 | Retry-After | 404
413 | [13], [20] | o | do | + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|------|------------------|----------------------------------------|------------|------------|-----------------------------------------| +| | | 480
486
500
503
600
603 | | | | +| 37 | Security-Server | 421
494 | [47] | o | dn/a | +| 38 | Server | r | [13], [20] | o | do | +| 39 | Session-ID | r | [124] | m | IF table 6.1.3.1/94 THEN dm
(NOTE 2) | +| 40 | Supported | 2xx | [13], [20] | o | do | +| 41 | Timestamp | r | [13], [20] | o | do | +| 42 | To | 100
others | [13], [20] | m | dm | +| 43 | Unsupported | 420 | [13], [20] | o | do | +| 44 | User-Agent | r | [13], [20] | o | do | +| 45 | Via | 100
others | [13], [20] | m | dm | +| 46 | Warning | r | [13], [20] | o | do | +| 47 | WWW-Authenticate | 401
(NOTE 1) | [13], [20] | m | dm | +| | | 407
(NOTE 1) | | o | do | + +NOTE 1: The SIP status code is only applicable over the roaming II-NNI. + +NOTE 2: If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. + +## --- B.10 OPTIONS method + +The table B.10.1 lists the supported header fields within the OPTIONS request. + +**Table B.10.1: Supported header fields within the OPTIONS request** + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|-------------|------------|-------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Accept | [13] | m* | dm* | +| 2 | Accept-Contact | [51] | o | IF dc1 (PNM: clause 12.17) THEN dm ELSE do | +| 3 | Accept-Encoding | [13] | o | do | +| 4 | Accept-Language | [13] | o | do | +| 5 | Allow | [13] | o | do | +| 6 | Allow-Events | [20] | o | IF table 6.1.3.1/23 THEN do (NOTE) | +| 7 | Authorization | [13] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 8 | Call-ID | [13] | m | dm | +| 9 | Call-Info | [13] | o | do | +| 10 | Cellular-Network-Info | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE) | +| 11 | Contact | [13] | o | do | +| 12 | Content-Disposition | [13] | o | do | +| 13 | Content-Encoding | [13] | o | do | +| 14 | Content-ID | [216] | o | IF table 6.1.3.1/122 THEN do | +| 15 | Content-Language | [13] | o | do | +| 16 | Content-Length | [13] | t | dt | +| 17 | Content-Type | [13] | * | d* | +| 18 | CSeq | [13] | m | dm | +| 19 | Date | [13] | o | do | +| 20 | Feature-Caps | [143] | o | IF table 6.1.3.1/103 AND request outside an existing dialog THEN do (NOTE) | +| 21 | From | [13] | m | dm | +| 22 | Geolocation | [68] | o | do | +| 23 | Geolocation-Routing | [68] | o | do | +| 24 | History-Info | [25] | o | IF (dc1 (PNM: clause 12.17) THEN dm ELSE IF table 6.1.3.1/50 AND request outside an existing dialog THEN do (NOTE) | +| 25 | Max-Breadth | [79] | o | do | +| 26 | Max-Forwards | [13] | m | dm | +| 27 | MIME-Version | [13] | o | do | +| 28 | Organization | [13] | o | do | +| 29 | P-Access-Network-Info | [24], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE) | +| 30 | P-Asserted-Identity | [44] | o | IF table 6.1.3.1/27 AND request outside an existing dialog THEN dm (NOTE) | +| 31 | P-Asserted-Service | [26] | o | IF (non-roaming II-NNI OR home-to-visited request on roaming II-NNI) AND table 6.1.3.1/77 AND request outside an existing dialog THEN do (NOTE) | +| 32 | P-Called-Party-ID | [24] | o | IF home-to-visited request on roaming II-NNI AND table 6.1.3.1/34 THEN do (NOTE) | +| 33 | P-Charging-Function-Addresses | [24] | o | dn/a | +| 34 | P-Charging-Vector | [24] | o | IF table 6.1.3.1/38 AND request outside an existing dialog THEN dm (NOTE) | +| 35 | P-Preferred-Identity | [44] | o | dn/a | +| 36 | P-Preferred-Service | [26] | o | IF visited-to-home request on roaming II-NNI AND table 6.1.3.1/77 AND request outside an existing dialog THEN do (NOTE) | +| 37 | P-Private-Network-Indication | [84] | o | IF table 6.1.3.1/80 AND request outside an existing dialog THEN do (NOTE) | +| 38 | P-Profile-Key | [64] | o | IF table 6.1.3.1/59 AND request outside an existing dialog THEN do (NOTE) | +| 39 | P-Served-User | [85] | o | IF visited-to-home request on roaming II-NNI AND request outside an existing dialog being sent from "privileged sender" THEN dm (NOTE) | +| 40 | P-User-Database | [60] | o | dn/a | +| 41 | P-Visited-Network-ID | [24] | o | dn/a | +| 42 | Privacy | [34] | o | IF dc2 (OIP/OIR: clause 12.3) THEN dm ELSE do | +| 43 | Proxy-Authorization | [13] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 44 | Proxy-Require | [13] | o | do | +| 45 | Reason | [48] | o | IF table 6.1.3.1/40 AND request inside an existing dialog THEN do (NOTE) | +| 46 | Record-Route | [13] | o | do | +| 47 | Recv-Info | [39] | n/a | dn/a | + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|-------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|------------|--------------------------------------------| +| 48 | Referred-By | [53] | o | do | +| 49 | Reject-Contact | [51] | o | do | +| 50 | Relayed-Charge | [5] | n/a | dn/a | +| 51 | Request-Disposition | [51] | o | do | +| 52 | Require | [13] | c | dc | +| 53 | Resource-Priority | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE) | +| 54 | Route | [13] | c | dc | +| 55 | Security-Client | [47] | o | dn/a | +| 56 | Security-Verify | [47] | o | dn/a | +| 57 | Session-ID | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE) | +| 58 | Supported | [13] | o | IF dc1 (PNM: clause 12.17) THEN dm ELSE do | +| 59 | Timestamp | [13] | o | do | +| 60 | To | [13] | m | dm | +| 61 | User-Agent | [13] | o | do | +| 62 | Via | [13] | m | dm | +| dc1: | request outside an existing dialog invoked due to PNM in case of ("PN UE redirection" OR "PN access control") AND (non-roaming II-NNI OR home-to-visited request on roaming II-NNI) | | | | +| dc2: | (request outside an existing dialog invoked due to OIP/OIR AND "override the default setting" in temporary mode AND visited-to-home request on roaming II-NNI) OR (request outside an existing dialog invoked due to OIP/OIR AND "presentation of the public user identity is restricted" AND (non-roaming II-NNI OR home-to-visited request on roaming II-NNI)) | | | | +| NOTE: | If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | | | + +The table B.10.2 lists the supported header fields within the OPTIONS response. + +**Table B.10.2: Supported header fields within the OPTIONS response** + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|-------------------|--------------------|------------|------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Accept | 2xx | [13] | m* | dm* | +| | | 415 | | c | dc | +| 2 | Accept-Encoding | 2xx | [13] | m* | dm* | +| | | 415 | | c | dc | +| 3 | Accept-Language | 2xx | [13] | m* | dm* | +| | | 415 | | c | dc | +| 4 | Accept-Resource-Priority | 2xx
417 | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE 2) | +| 5 | Allow | 2xx | [13] | m* | dm* | +| | | 405 | | m | dm | +| | | others | | o | do | +| 6 | Allow-Events | 2xx | [20] | o | IF table 6.1.3.1/23 THEN do (NOTE 2) | +| 7 | Authentication-Info | 2xx | [13] | o | IF table 6.1.3.1/7 THEN do (NOTE 2) | +| 8 | Call-ID | 100 | [13] | m | dm | +| | | others | | | | +| 9 | Call-Info | r | [13] | o | do | +| 10 | Cellular-Network-Info | r | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE 2) | +| 11 | Contact | 2xx
3xx
485 | [13] | o | do | +| 12 | Content-Disposition | r | [13] | o | do | +| 13 | Content-Encoding | r | [13] | o | do | +| 14 | Content-ID | r | [216] | o | IF table 6.1.3.1/122 THEN do | +| 15 | Content-Language | r | [13] | o | do | +| 16 | Content-Length | 100 | [13] | t | dt | +| | | others | | | | +| 17 | Content-Type | r | [13] | * | d* | +| 18 | CSeq | 100 | [13] | m | dm | +| | | others | | | | +| 19 | Date | 100 | [13] | o | do | +| | | others | | | | +| 20 | Error-Info | 3xx-6xx | [13] | o | IF table 6.1.3.1/13 THEN do (NOTE 2) | +| 21 | Feature-Caps | 2xx | [143] | o | IF table 6.1.3.1/103 AND response to request outside an existing dialog THEN do (NOTE 2) | +| 22 | From | 100 | [13] | m | dm | +| | | others | | | | +| 23 | Geolocation-Error | 424 | [68] | m | dm | +| | | others | | o | do | +| 24 | History-Info | r | [25] | o | IF table 6.1.3.1/50 AND response to request outside an existing dialog THEN do (NOTE 2) | +| 25 | MIME-version | r | [13] | o | do | +| 26 | Organization | r | [13] | o | do | +| 27 | P-Access-Network-Info | r | [24], [24A], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE 2) | +| 28 | P-Asserted-Identity | r | [44] | o | IF dc1 (TIP/TIR: clause 12.4) THEN dm ELSE IF table 6.1.3.1/27 AND response to request outside an existing dialog THEN do (NOTE 2) | +| 29 | P-Charging-Function-Addresses | r | [24], [24A] | o | dn/a | +| 30 | P-Charging-Vector | 100 | [24], | o | dn/a | + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | | +|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|-------|------------|-----------------------------------------------------------------------------------------|--| +| | | 18x, 2xx | [24A] | o | IF table 6.1.3.1/38 AND response to request outside an existing dialog THEN dm (NOTE 2) | | +| | | 3xx-6xx | | o | do (NOTE 2) | | +| 31 | P-Preferred-Identity | r | [44] | o | dn/a | | +| 32 | Privacy | r | [34] | o | IF dc2 (TIP/TIR: clause 12.4) THEN dm ELSE do | | +| 33 | Proxy-Authenticate | 401 (NOTE 1) | [13] | o | do | | +| | | 407 (NOTE 1) | | m | dm | | +| 34 | Record-Route | 2xx | [13] | o | do | | +| 35 | Recv-Info | 2xx
others | [39] | n/a | dn/a | | +| 36 | Relayed-Charge | r | [5] | n/a | dn/a | | +| 37 | Require | r | [13] | c | dc | | +| 38 | Response-Source | 3xx-6xx | [5] | n/a | IF table 6.1.3.1/121 THEN do (NOTE 2) | | +| 39 | Restoration-Info | 504 | [5] | n/a | IF table 6.1.3.1/114 AND visited-to-home response on roaming II-NNI THEN do (NOTE 2) | | +| 40 | Retry-After | 404
413
480
486
500
503
600
603 | [13] | o | do | | +| 41 | Security-Server | 421
494 | [47] | o | dn/a | | +| 42 | Server | r | [13] | o | do | | +| 43 | Session-ID | r | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE 2) | | +| 44 | Supported | 2xx | [13] | m* | dm* | | +| 45 | Timestamp | r | [13] | o | do | | +| 46 | To | 100
others | [13] | m | dm | | +| 47 | Unsupported | 420 | [13] | m | dm | | +| 48 | User-Agent | r | [13] | o | do | | +| 49 | Via | 100
others | [13] | m | dm | | +| 50 | Warning | r | [13] | o | do | | +| 51 | WWW-Authenticate | 401 (NOTE 1) | [13] | m | dm | | +| | | 407 (NOTE 1) | | o | do | | +| dc1: | (TIP/TIR AND 2xx response to request outside an existing dialog AND (visited-to-home response on roaming II-NNI OR non-roaming II-NNI)) OR (TIP/TIR AND response to request outside an existing dialog AND "presentation is allowed" AND home-to-visited response on roaming II-NNI) | | | | | | +| dc2: | (TIP/TIR AND non-100 response to request outside an existing dialog AND "override the default setting" in temporary mode AND visited-to-home response on roaming II-NNI) OR (TIP/TIR AND 2xx response to request outside an existing dialog AND "presentation of the network asserted identity is restricted" AND (non-roaming II-NNI OR home-to-visited response on roaming II-NNI)) | | | | | | +| NOTE 1: | The SIP status code is only applicable over the roaming II-NNI. | | | | | | +| NOTE 2: | If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | | | | | + +## --- B.11 PRACK method + +The table B.11.1 lists the supported header fields within the PRACK request. + +**Table B.11.1: Supported header fields within the PRACK request** + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|-------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|------------|----------------------------------------------------------------------------------------------------------------------------------| +| 1 | Accept | [13], [18] | o | do | +| 2 | Accept-Contact | [51] | o | do | +| 3 | Accept-Encoding | [13], [18] | o | do | +| 4 | Accept-Language | [13], [18] | o | do | +| 5 | Allow | [13], [18] | o | do | +| 6 | Allow-Events | [20] | o | IF table 6.1.3.1/23 THEN do (NOTE) | +| 7 | Authorization | [13], [18] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 8 | Call-ID | [13], [18] | m | dm | +| 9 | Cellular-Network-Info | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE) | +| 10 | Content-Disposition | [13], [18] | o | do | +| 11 | Content-Encoding | [13], [18] | o | do | +| 12 | Content-ID | [216] | o | IF table 6.1.3.1/122 THEN do | +| 13 | Content-Language | [13], [18] | o | do | +| 14 | Content-Length | [13], [18] | t | dt | +| 15 | Content-Type | [13], [18] | * | d* | +| 16 | CSeq | [13], [18] | m | dm | +| 17 | Date | [13], [18] | o | do | +| 18 | From | [13], [18] | m | dm | +| 19 | Max-Breadth | [79] | o | do | +| 20 | Max-Forwards | [13], [18] | m | dm | +| 21 | MIME-Version | [13], [18] | o | do | +| 22 | P-Access-Network-Info | [24], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE) | +| 23 | P-Charging-Function-Addresses | [24] | o | dn/a | +| 24 | P-Charging-Vector | [24] | o | IF table 6.1.3.1/38 THEN do (NOTE) | +| 25 | P-Early-Media | [74] | o | IF dc1 (CAT: clause 12.14) THEN dm ELSE IF table 6.1.3.1/69 THEN do (NOTE) | +| 26 | Priority-Share | [5] | n/a | IF home-to-visited request on roaming II-NNI AND table 6.1.3.1/118 THEN do (NOTE) | +| 27 | Privacy | [34] | o | do | +| 28 | Proxy-Authorization | [13], [18] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 29 | Proxy-Require | [13], [18] | o | do | +| 30 | RAck | [18] | m | dm | +| 31 | Reason | [48] | o | IF table 6.1.3.1/40 THEN do (NOTE) | +| 32 | Record-Route | [13], [18] | o | do | +| 33 | Recv-Info | [39] | o | IF table 6.1.3.1/17 THEN do (NOTE) | +| 34 | Referred-By | [53] | o | do | +| 35 | Reject-Contact | [51] | o | do | +| 36 | Relayed-Charge | [5] | n/a | dn/a | +| 37 | Request-Disposition | [51] | o | do | +| 38 | Require | [13], [18] | c | dc | +| 39 | Resource-Priority | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE) | +| 40 | Resource-Share | [5] | n/a | IF (home-to-visited request on roaming II-NNI OR visited-to-home request on roaming II-NNI) AND table 6.1.3.1/116 THEN do (NOTE) | +| 41 | Route | [13], [18] | c | dc | +| 42 | Session-ID | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE) | +| 43 | Supported | [13], [18] | o | do | +| 44 | Timestamp | [13], [18] | o | do | +| 45 | To | [13], [18] | m | dm | +| 46 | User-Agent | [13], [18] | o | do | +| 47 | Via | [13], [18] | m | dm | +| dc1: | request invoked due to CAT to first 18x response with P-Early-Media header field cancelling "CAT service" provided by terminating AS AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited request on roaming II-NNI) | | | | +| NOTE: | If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | | | + +The table B.11.2 lists the supported header fields within the PRACK response. + +**Table B.11.2: Supported header fields within the PRACK response** + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|------------------------------------|--------------------|------------|--------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Accept | 415 | [13], [18] | c | dc | +| 2 | Accept-Encoding | 415 | [13], [18] | c | dc | +| 3 | Accept-Language | 415 | [13], [18] | c | dc | +| 4 | Accept-Resource-Priority | 2xx
417 | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE 2) | +| 5 | Allow | 405 | [13], [18] | m | dm | +| | | others | | o | do | +| 6 | Allow-Events | 2xx | [20] | o | IF table 6.1.3.1/23 THEN do (NOTE 2) | +| 7 | Authentication-Info | 2xx | [13], [18] | o | IF table 6.1.3.1/7 THEN do (NOTE 2) | +| 8 | Call-ID | 100
r | [13], [18] | m | dm | +| 9 | Cellular-Network-Info | r | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE 2) | +| 10 | Contact | 3xx
485 | [13], [18] | o | do | +| 11 | Content-Disposition | r | [13], [18] | o | do | +| 12 | Content-Encoding | r | [13], [18] | o | do | +| 13 | Content-ID | r | [216] | o | IF table 6.1.3.1/122 THEN do | +| 14 | Content-Language | r | [13], [18] | o | do | +| 15 | Content-Length | 100
others | [13], [18] | t | dt | +| 16 | Content-Type | r | [13], [18] | * | d* | +| 17 | CSeq | 100
others | [13], [18] | m | dm | +| 18 | Date | 100
others | [13], [18] | o | do | +| 19 | Error-Info | 3xx-6xx | [13], [18] | o | IF table 6.1.3.1/13 THEN do (NOTE 2) | +| 20 | From | 100
others | [13], [18] | m | dm | +| 21 | MIME-version | r | [13], [18] | o | do | +| 22 | P-Access-Network-Info | r | [24], [24A], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE 2) | +| 23 | P-Charging-Function-Addresses | r | [24], [24A] | o | dn/a | +| 24 | P-Charging-Vector | 100
others | [24], [24A] | o
o | dn/a
IF table 6.1.3.1/38 THEN do (NOTE 2) | +| 25 | P-Early-Media | 2xx | [74] | o | IF table 6.1.3.1/69 THEN do (NOTE 2) | +| 26 | Priority-Share | 2xx | [5] | n/a | IF home-to-visited response on roaming II-NNI AND table 6.1.3.1/118 THEN do (NOTE 2) | +| 27 | Privacy | r | [34] | o | do | +| 28 | Proxy-Authenticate | 401
(NOTE 1)
407
(NOTE 1) | [13], [18] | o
m | do
dm | +| 29 | Record-Route | 2xx | [13], [18] | o | do | +| 30 | Recv-Info | 2xx
others | [39] | c
o | IF table 6.1.3.1/17 THEN dc (NOTE 2)
IF table 6.1.3.1/17 THEN do (NOTE 2) | +| 31 | Relayed-Charge | r | [5] | n/a | dn/a | +| 32 | Require | r | [13], [18] | c | dc | +| 33 | Resource-Share | 2xx | [5] | n/a | IF (home-to-visited response on roaming II-NNI OR visited-to-home response on roaming II-NNI) AND table 6.1.3.1/116 THEN do (NOTE 2) | +| 34 | Response-Source | 3xx-6xx | [5] | n/a | IF table 6.1.3.1/121 THEN do | + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|------|------------------|------------------------------------------------------|------------|------------|-----------------------------------------| +| | | | | | (NOTE 2) | +| 35 | Retry-After | 404
413
480
486
500
503
600
603 | [13], [18] | o | do | +| 36 | Security-Server | 421
494 | [47] | n/a | dn/a | +| 37 | Server | r | [13], [18] | o | do | +| 38 | Session-ID | r | [124] | m | IF table 6.1.3.1/94 THEN dm
(NOTE 2) | +| 39 | Supported | 2xx | [13], [18] | o | do | +| 40 | Timestamp | r | [13], [18] | o | do | +| 41 | To | 100
others | [13], [18] | m | dm | +| 42 | Unsupported | 420 | [13], [18] | m | dm | +| 43 | User-Agent | r | [13], [18] | o | do | +| 44 | Via | 100
others | [13], [18] | m | dm | +| 45 | Warning | r | [13], [18] | o | do | +| 46 | WWW-Authenticate | 401
(NOTE 1) | [13], [18] | m | dm | +| | | 407
(NOTE 1) | | o | do | + +NOTE 1: The SIP status code is only applicable over the roaming II-NNI. + +NOTE 2: If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. + +## --- B.12 PUBLISH method + +As described in table 6.1, the support of PUBLISH method over the non-roaming II-NNI is based on bilateral agreement between the operators. + +The table B.12.1 lists the supported header fields within the PUBLISH request. + +**Table B.12.1: Supported header fields within the PUBLISH request** + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|-------------|------------|-------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Accept-Contact | [51] | o | IF dc1 (PNM: clause 12.17) THEN dm ELSE do | +| 2 | Allow | [13], [21] | o | do | +| 3 | Allow-Events | [20] | o | IF table 6.1.3.1/23 THEN do (NOTE) | +| 4 | Authorization | [13], [21] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 5 | Call-ID | [13], [21] | m | dm | +| 6 | Call-Info | [13], [21] | o | IF dc2 (CCBS/CCNR/CCNL: clause 12.11/12.12/12.23) THEN dm ELSE do | +| 7 | Cellular-Network-Info | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE) | +| 8 | Contact | [13], [21] | n/a | dn/a | +| 9 | Content-Disposition | [13], [21] | o | do | +| 10 | Content-Encoding | [13], [21] | o | do | +| 11 | Content-ID | [216] | o | IF table 6.1.3.1/122 THEN do | +| 12 | Content-Language | [13], [21] | o | do | +| 13 | Content-Length | [13], [21] | t | dt | +| 14 | Content-Type | [13], [21] | * | d* | +| 15 | CSeq | [13], [21] | m | dm | +| 16 | Date | [13], [21] | o | do | +| 17 | Event | [20] | m | dm | +| 18 | Expires | [13], [21] | o | IF dc2 (CCBS/CCNR/CCNL: clause 12.11/12.12/12.23) THEN dm ELSE do | +| 19 | Feature-Caps | [143] | o | IF table 6.1.3.1/103 AND request outside an existing dialog THEN do | +| 20 | From | [13], [21] | m | dm | +| 21 | Geolocation | [68] | o | do | +| 22 | Geolocation-Routing | [68] | o | do | +| 23 | History-Info | [25] | o | IF dc1 (PNM: clause 12.17) THEN dm ELSE IF table 6.1.3.1/50 AND request outside an existing dialog THEN do (NOTE) | +| 24 | In-Reply-To | [13], [21] | n/a | dn/a | +| 25 | Max-Breadth | [79] | o | do | +| 26 | Max-Forwards | [13], [21] | m | dm | +| 27 | MIME-Version | [13], [21] | o | do | +| 28 | Organization | [13], [21] | o | do | +| 29 | P-Access-Network-Info | [24], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE) | +| 30 | P-Asserted-Identity | [44] | o | IF dc2 (CCBS/CCNR/CCNL: clause 12.11/12.12/12.23) OR table 6.1.3.1/27 AND request outside an existing dialog THEN dm (NOTE) | +| 31 | P-Asserted-Service | [26] | o | IF (non-roaming II-NNI OR home-to-visited request on roaming II-NNI) AND table 6.1.3.1/77 AND request outside an existing dialog THEN do (NOTE) | +| 32 | P-Called-Party-ID | [24] | o | IF home-to-visited request on roaming II-NNI AND table 6.1.3.1/34 THEN do (NOTE) | +| 33 | P-Charging-Function-Addresses | [24] | o | dn/a | +| 34 | P-Charging-Vector | [24] | o | IF table 6.1.3.1/38 AND request outside an existing dialog THEN dm (NOTE) | +| 35 | P-Preferred-Identity | [44] | o | dn/a | +| 36 | P-Preferred-Service | [26] | o | IF visited-to-home request on roaming II-NNI AND table 6.1.3.1/77 AND request outside an existing dialog THEN do (NOTE) | +| 37 | P-Private-Network-Indication | [84] | o | IF table 6.1.3.1/80 AND request outside an existing dialog THEN do (NOTE) | +| 38 | P-Profile-Key | [64] | o | IF table 6.1.3.1/59 AND request outside an existing dialog THEN do (NOTE) | +| 39 | P-Served-User | [85] | o | IF visited-to-home request on roaming II-NNI AND request outside an existing dialog being sent from "privileged sender" THEN dm (NOTE) | +| 40 | P-User-Database | [60] | o | dn/a | +| 41 | P-Visited-Network-ID | [24] | o | dn/a | +| 42 | Priority | [13], [21] | o | do | +| 43 | Privacy | [34] | o | IF dc3 (OIP/OIR: clause 12.3) THEN dm ELSE do | +| 44 | Proxy-Authorization | [13], [21] | o | IF table 6.1.3.1/7 THEN do (NOTE) | + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|-------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|------------|--------------------------------------------------------------------------| +| 45 | Proxy-Require | [13], [21] | o | do | +| 46 | Reason | [48] | o | IF table 6.1.3.1/40 AND request inside an existing dialog THEN do (NOTE) | +| 47 | Referred-By | [53] | o | do | +| 48 | Reject-Contact | [51] | o | do | +| 49 | Relayed-Charge | [5] | n/a | dn/a | +| 50 | Reply-To | [13], [21] | n/a | dn/a | +| 51 | Request-Disposition | [51] | o | do | +| 52 | Require | [13], [21] | o | do | +| 53 | Resource-Priority | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE) | +| 54 | Route | [13], [21] | c | dc | +| 55 | Security-Client | [47] | o | dn/a | +| 56 | Security-Verify | [47] | o | dn/a | +| 57 | Session-ID | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE) | +| 58 | SIP-If-Match | [21] | o | do | +| 59 | Subject | [13], [21] | o | do | +| 60 | Supported | [13], [21] | o | IF dc1 (PNM: clause 12.17) THEN dm ELSE do | +| 61 | Timestamp | [13], [21] | o | do | +| 62 | To | [13], [21] | m | dm | +| 63 | User-Agent | [13], [21] | o | do | +| 64 | Via | [13], [21] | m | dm | +| dc1: | request outside an existing dialog invoked due to PNM in case of ("PN UE redirection" OR "PN access control") AND (non-roaming II-NNI OR home-to-visited request on roaming II-NNI) | | | | +| dc2: | (request inside an existing dialog invoked due to CCBS/CCNR/CCNL suspending the "CC request" AND (non-roaming II-NNI OR loopback traversal scenario) OR (request inside an existing dialog invoked due to CCBS/CCNR/CCNL resuming the "CC request" AND (non-roaming II-NNI OR loopback traversal scenario))) | | | | +| dc3: | (request outside an existing dialog invoked due to OIP/OIR AND "override the default setting" in temporary mode AND visited-to-home request on roaming II-NNI) OR (request outside an existing dialog invoked due to OIP/OIR AND "presentation of the public user identity is restricted" AND (non-roaming II-NNI OR home-to-visited request on roaming II-NNI)) | | | | +| NOTE: | If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | | | + +The table B.12.2 lists the supported header fields within the PUBLISH response. + +###### **Table B.12.2: Supported header fields within the PUBLISH response** + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|-----------------------------|--------------------|-------------|------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Accept | 415 | [13], [21] | m* | dm* | +| 2 | Accept-Encoding | 415 | [13], [21] | m* | dm* | +| 3 | Accept-Language | 415 | [13], [21] | m* | dm* | +| 4 | Accept-Resource-Priority | 200
417 | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE 2) | +| 5 | Allow | 405
others | [13], [21] | m
o | dm
do | +| 6 | Allow-Events | 489 | [20] | m | dm | +| 7 | Authentication-Info | 2xx | [13], [21] | o | IF table 6.1.3.1/7 THEN do (NOTE 2) | +| 8 | Call-ID | 100
others | [13], [21] | m | dm | +| 9 | Call-Info | r | [13], [21] | o | do | +| 10 | Cellular-Network-Info | r | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE 2) | +| 11 | Contact | 3xx
485 | [13], [21] | o | do | +| 12 | Content-Disposition | r | [13], [21] | o | do | +| 13 | Content-Encoding | r | [13], [21] | o | do | +| 14 | Content-ID | r | [216] | o | IF table 6.1.3.1/122 THEN do | +| 15 | Content-Language | r | [13], [21] | o | do | +| 16 | Content-Length | 100
others | [13], [21] | t | dt | +| 17 | Content-Type | r | [13], [21] | * | d* | +| 18 | CSeq | 100
others | [13], [21] | m | dm | +| 19 | Date | 100
others | [13], [21] | o | do | +| 20 | Error-Info | 3xx-6xx | [13], [21] | o | IF table 6.1.3.1/13 THEN do (NOTE 2) | +| 21 | Expires | 2xx
others | [13], [21] | m
o | dm
do | +| 22 | Feature-Caps | 2xx | [143] | o | IF table 6.1.3.1/103 AND response to request outside an existing dialog THEN do | +| 23 | From | 100
others | [13], [21] | m | dm | +| 24 | Geolocation-Error | 424
others | [68] | m
o | dm
do | +| 25 | History-Info | r | [25] | o | IF table 6.1.3.1/50 AND response to request outside an existing dialog THEN do (NOTE 2) | +| 26 | MIME-version | r | [13], [21] | o | do | +| 27 | Min-Expires | 423 | [13], [21] | m | dm | +| 28 | Organization | r | [13], [21] | o | do | +| 29 | P-Access-Network-Info | r | [24], [24A], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE 2) | +| 30 | P-Asserted-Identity | r | [44] | o | IF dc1 (TIP/TIR: clause 12.4) THEN dm ELSE IF table 6.1.3.1/27 AND response to request outside an existing dialog THEN do (NOTE 2) | +| 31 | P-Charging-Function-Addresses | r | [24], [24A], [24B] | o | dn/a | +| 32 | P-Charging-Vector | 100
18xx, 2xx
3xx-6xx | [24], [24A] | o
o
o | dn/a
IF table 6.1.3.1/38 AND response to request outside an existing dialog THEN dm (NOTE 2)
do (NOTE 2) | +| 33 | P-Preferred-Identity | r | [44] | o | dn/a | +| 34 | Privacy | r | [34] | o | IF dc2 (TIP/TIR: clause 12.4) THEN dm ELSE do | +| 35 | Proxy-Authenticate | 401 | [13], [21] | o | do | + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | | +|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|------------|------------|--------------------------------------------------------------------------------------|--| +| | | (NOTE 1) | | | | | +| | | 407
(NOTE 1) | | m | dm | | +| 36 | Relayed-Charge | r | [5] | n/a | dn/a | | +| 37 | Require | r | [13], [21] | o | do | | +| 38 | Response-Source | 3xx-6xx | [5] | n/a | IF table 6.1.3.1/121 THEN do
(NOTE 2) | | +| 39 | Restoration-Info | 504 | [5] | n/a | IF table 6.1.3.1/114 AND visited-to-home response on roaming II-NNI THEN do (NOTE 2) | | +| 40 | Retry-After | 404
413
480
486
500
503
600
603 | [13], [21] | o | do | | +| 41 | Security-Server | 421
494 | [47] | o | dn/a | | +| 42 | Server | r | [13], [21] | o | do | | +| 43 | Session-ID | r | [124] | m | IF table 6.1.3.1/94 THEN dm
(NOTE 2) | | +| 44 | SIP-Etag | 2xx | [21] | m | dm | | +| 45 | Supported | 2xx | [13], [21] | o | do | | +| 46 | Timestamp | r | [13], [21] | o | do | | +| 47 | To | 100
others | [13], [21] | m | dm | | +| 48 | Unsupported | 420 | [13], [21] | o | do | | +| 49 | User-Agent | r | [13], [21] | o | do | | +| 50 | Via | 100
others | [13], [21] | m | dm | | +| 51 | Warning | r | [13], [21] | o | do | | +| 52 | WWW-Authenticate | 401
(NOTE 1) | [13], [21] | m | dm | | +| | | 407
(NOTE 1) | | o | do | | +| dc1: | (TIP/TIR AND 2xx response to request outside an existing dialog AND (visited-to-home response on roaming II-NNI OR non-roaming II-NNI)) OR (TIP/TIR AND response to request outside an existing dialog AND "presentation is allowed" AND home-to-visited response on roaming II-NNI) | | | | | | +| dc2: | (TIP/TIR AND non-100 response to request outside an existing dialog AND "override the default setting" in temporary mode AND visited-to-home response on roaming II-NNI) OR (TIP/TIR AND 2xx response to request outside an existing dialog AND "presentation of the network asserted identity is restricted" AND (non-roaming II-NNI OR home-to-visited response on roaming II-NNI)) | | | | | | +| NOTE 1: | The SIP status code is only applicable over the roaming II-NNI. | | | | | | +| NOTE 2: | If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | | | | | + +## --- B.13 REFER method + +As described in table 6.1, the support of REFER method over the II-NNI is based on bilateral agreement between the operators. + +The table B.13.1 lists the supported header fields within the REFER request. + +**Table B.13.1: Supported header fields within the REFER request** + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|-------------|------------|-------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Accept | [13], [22] | o | do | +| 2 | Accept-Contact | [51] | o | IF dc1 (PNM: clause 12.17) THEN dm ELSE do | +| 3 | Accept-Encoding | [13], [22] | o | do | +| 4 | Accept-Language | [13], [22] | o | do | +| 5 | Additional-Identity | [5] | n/a | IF table 6.1.3.1/126 THEN do (NOTE) | +| 6 | Allow | [13], [22] | o | do | +| 7 | Allow-Events | [20] | o | IF table 6.1.3.1/23 THEN do (NOTE) | +| 8 | Authorization | [13], [22] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 9 | Call-ID | [13], [22] | m | dm | +| 10 | Cellular-Network-Info | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE) | +| 11 | Contact | [13], [22] | m | dm | +| 12 | Content-Disposition | [13], [22] | o | do | +| 13 | Content-Encoding | [13], [22] | o | do | +| 14 | Content-ID | [216] | o | IF table 6.1.3.1/122 THEN do | +| 15 | Content-Language | [13], [22] | o | do | +| 16 | Content-Length | [13], [22] | o | do | +| 17 | Content-Type | [13], [22] | * | d* | +| 18 | CSeq | [13], [22] | m | dm | +| 19 | Date | [13], [22] | o | do | +| 20 | Expires | [13], [22] | o | do | +| 21 | Feature-Caps | [143] | o | IF table 6.1.3.1/103 AND request outside an existing dialog THEN do (NOTE) | +| 22 | From | [13], [22] | m | dm | +| 23 | Geolocation | [68] | o | do | +| 24 | Geolocation-Routing | [68] | o | do | +| 25 | History-Info | [25] | o | IF dc1 (PNM: clause 12.17) THEN dm ELSE IF table 6.1.3.1/50 AND request outside an existing dialog THEN do (NOTE) | +| 26 | Max-Breadth | [79] | o | do | +| 27 | Max-Forwards | [13], [22] | m | dm | +| 28 | MIME-Version | [13], [22] | o | do | +| 29 | Organization | [13], [22] | o | do | +| 30 | P-Access-Network-Info | [24], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE) | +| 31 | P-Asserted-Identity | [44] | o | IF table 6.1.3.1/27 AND request outside an existing dialog THEN dm (NOTE) | +| 32 | P-Asserted-Service | [26] | o | IF (non-roaming II-NNI OR home-to-visited request on roaming II-NNI) AND table 6.1.3.1/77 AND request outside an existing dialog THEN do (NOTE) | +| 33 | P-Called-Party-ID | [24], [24A] | o | IF home-to-visited request on roaming II-NNI AND table 6.1.3.1/34 THEN do (NOTE) | +| 34 | P-Charging-Function-Addresses | [24] | o | dn/a | +| 35 | P-Charging-Vector | [24] | o | IF table 6.1.3.1/38 AND request outside an existing dialog THEN dm (NOTE) | +| 36 | P-Preferred-Identity | [44] | o | dn/a | +| 37 | P-Preferred-Service | [26] | o | IF visited-to-home request on roaming II-NNI AND table 6.1.3.1/77 AND request outside an existing dialog THEN do (NOTE) | +| 38 | P-Private-Network-Indication | [84] | o | IF table 6.1.3.1/80 AND request outside an existing dialog THEN do (NOTE) | +| 39 | P-Profile-Key | [64] | o | IF table 6.1.3.1/59 AND request outside an existing dialog THEN do (NOTE) | +| 40 | P-Served-User | [85] | o | IF visited-to-home request on roaming II-NNI AND request outside an existing dialog being sent from "privileged sender" THEN dm (NOTE) | +| 41 | P-User-Database | [60] | o | dn/a | +| 42 | P-Visited-Network-ID | [24] | o | dn/a | +| 43 | Privacy | [34] | o | IF dc2 (OIP/OIR: clause 12.3) OR dc3 (ECT: clause 12.13) THEN dm ELSE do | +| 44 | Proxy-Authorization | [13], [22] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 45 | Proxy-Require | [13], [22] | o | do | +| 46 | Reason | [48] | o | IF table 6.1.3.1/40 AND request inside an existing dialog THEN do (NOTE) | +| 47 | Record-Route | [13], [22] | o | do | + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|-------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|------------|--------------------------------------------| +| 48 | Refer-Sub | [135] | o | do | +| 49 | Refer-To | [22] | dm | dm | +| 50 | Referred-By | [53] | o | IF dc4 (ECT: clause 12.13) THEN dm ELSE do | +| 51 | Reject-Contact | [51] | o | do | +| 52 | Relayed-Charge | [5] | n/a | dn/a | +| 53 | Request-Disposition | [51] | o | do | +| 54 | Require | [13], [22] | c | dc | +| 55 | Resource-Priority | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE) | +| 56 | Route | [13], [22] | c | dc | +| 57 | Security-Client | [47] | o | dn/a | +| 58 | Security-Verify | [47] | o | dn/a | +| 59 | Session-ID | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE) | +| 60 | Supported | [13], [22] | o | IF dc1 (PNM: clause 12.17) THEN dm ELSE do | +| 61 | Target-Dialog | [140] | o | IF table 6.1.3.1/102 THEN do (NOTE) | +| 62 | Timestamp | [13], [22] | o | do | +| 63 | To | [13], [22] | m | dm | +| 64 | Trigger-Consent | [82] | o | IF table 6.1.3.1/78 THEN do (NOTE) | +| 65 | User-Agent | [13], [22] | o | do | +| 66 | Via | [13], [22] | m | dm | +| dc1: | request outside an existing dialog invoked due to PNM in case of ("PN UE redirection" OR "PN access control") AND (non-roaming II-NNI OR home-to-visited request on roaming II-NNI) | | | | +| dc2: | (request outside an existing dialog invoked due to OIP/OIR AND "override the default setting" in temporary mode AND visited-to-home request on roaming II-NNI) OR (request outside an existing dialog invoked due to OIP/OIR AND "presentation of the public user identity is restricted" AND (non-roaming II-NNI OR home-to-visited request on roaming II-NNI)) | | | | +| dc3: | request inside an existing dialog invoked due to ECT including Referred-By header field with privacy requested in the "original communication" | | | | +| dc4: | request inside an existing dialog invoked due to ECT AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited request on roaming II-NNI) | | | | +| NOTE: | If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | | | + +The table B.13.2 lists the supported header fields within the REFER response. + +###### **Table B.13.2: Supported header fields within the REFER response** + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|----------------------------|--------------------|-------------|----------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Accept | 415 | [13], [22] | c | dc | +| 2 | Accept-Encoding | 415 | [13], [22] | c | dc | +| 3 | Accept-Language | 415 | [13], [22] | c | dc | +| 4 | Accept-Resource-Priority | 2xx
417 | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE 2) | +| 5 | Allow | 405
others | [13], [22] | m
o | dm
do | +| 6 | Allow-Events | 2xx | [20] | o | IF table 6.1.3.1/23 THEN do (NOTE 2) | +| 7 | Authentication-Info | 2xx | [13], [22] | o | IF table 6.1.3.1/7 THEN do (NOTE 2) | +| 8 | Call-ID | 100
others | [13], [22] | m | dm | +| 9 | Cellular-Network-Info | r | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE 2) | +| 10 | Contact | 2xx
3xx-6xx | [13], [22] | m
o | dm
do | +| 11 | Content-Disposition | r | [13], [22] | o | do | +| 12 | Content-Encoding | r | [13], [22] | o | do | +| 13 | Content-ID | r | [216] | o | IF table 6.1.3.1/122 THEN do | +| 14 | Content-Language | r | [13], [22] | o | do | +| 15 | Content-Length | 100
others | [13], [22] | t | dt | +| 16 | Content-Type | r | [13], [22] | * | d* | +| 17 | CSeq | 100
others | [13], [22] | m | dm | +| 18 | Date | 100
others | [13], [22] | o | do | +| 19 | Error-Info | 3xx-6xx | [13], [22] | o | IF table 6.1.3.1/13 THEN do (NOTE 2) | +| 20 | Feature-Caps | 2xx | [143] | o | IF table 6.1.3.1/103 AND response to request outside an existing dialog THEN do (NOTE 2) | +| 21 | From | 100
others | [13], [22] | m | dm | +| 22 | Geolocation-Error | 424
others | [68] | m
o | dm
do | +| 23 | History-Info | r | [25] | o | IF table 6.1.3.1/50 AND response to request outside an existing dialog THEN do (NOTE 2) | +| 24 | MIME-version | r | [13], [22] | o | do | +| 25 | Organization | r | [13], [22] | o | do | +| 26 | P-Access-Network-Info | r | [24], [24A], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE 2) | +| 27 | P-Asserted-Identity | r | [44] | o | IF dc1 (TIP/TIR: clause 12.4) THEN dm ELSE IF table 6.1.3.1/27 AND response to request outside an existing dialog THEN do (NOTE 2) | +| 28 | P-Charging-Function-Addresses | r | [24], [24A] | o | dn/a | +| 29 | P-Charging-Vector | 100
18x, 2xx
3xx-6xx | [24], [24A] | o
o
o | dn/a
IF dc2 (CONF: clause 12.19) OR (table 6.1.3.1/38 AND response to request outside an existing dialog) THEN dm (NOTE 2)
do (NOTE 2) | +| 30 | P-Preferred-Identity | r | [44] | o | dn/a | +| 31 | Permission-Missing | 470 | [82] | o | IF table 6.1.3.1/78 THEN do (NOTE 2) | +| 32 | Privacy | r | [34] | o | IF dc3 (TIP/TIR: clause 12.4) THEN dm ELSE do | +| 33 | Proxy-Authenticate | 401
(NOTE 1)
407 | [13], [22] | o
m | do
dm | + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | | | | | | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|------------|------------|--------------------------------------------------------------------------------------|--|--|--|--|--| +| | | (NOTE 1) | | | | | | | | | +| 34 | Record-Route | 2xx | [13], [22] | o | do | | | | | | +| 35 | Refer-Sub | 2xx | [135] | o | IF table 6.1.3.1/98 THEN do (NOTE 2) | | | | | | +| 36 | Relayed-Charge | r | [5] | n/a | dn/a | | | | | | +| 37 | Require | r | [13], [22] | c | dc | | | | | | +| 38 | Response-Source | 3xx-6xx | [5] | n/a | IF table 6.1.3.1/121 THEN do (NOTE 2) | | | | | | +| 39 | Restoration-Info | 504 | [5] | n/a | IF table 6.1.3.1/114 AND visited-to-home response on roaming II-NNI THEN do (NOTE 2) | | | | | | +| 40 | Retry-After | 404
413
480
486
500
503
600
603 | [13], [22] | o | do | | | | | | +| 41 | Security-Server | 421
494 | [47] | o | dn/a | | | | | | +| 42 | Server | r | [13], [22] | o | do | | | | | | +| 43 | Session-ID | r | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE 2) | | | | | | +| 44 | Supported | 2xx | [13], [22] | o | do | | | | | | +| 45 | Timestamp | r | [13], [22] | o | do | | | | | | +| 46 | To | 100
others | [13], [22] | m | dm | | | | | | +| 47 | Unsupported | 420 | [13], [22] | o | do | | | | | | +| 48 | User-Agent | r | [13], [22] | o | do | | | | | | +| 49 | Via | 100
others | [13], [22] | m | dm | | | | | | +| 50 | Warning | r | [13], [22] | o | do | | | | | | +| 51 | WWW-Authenticate | 401
(NOTE 1) | [13], [22] | m | dm | | | | | | +| | | 407
(NOTE 1) | | o | do | | | | | | +| dc1: | (TIP/TIR AND 2xx response to request outside an existing dialog AND (visited-to-home response on roaming II-NNI OR non-roaming II-NNI)) OR (TIP/TIR AND response to request outside an existing dialog AND "presentation is allowed" AND home-to-visited response on roaming II-NNI) | | | | | | | | | | +| dc2: | first response from "conference focus" to request outside an existing dialog AND (non-roaming II-NNI OR home-to-visited response on roaming II-NNI) | | | | | | | | | | +| dc3: | (TIP/TIR AND non-100 response to request outside an existing dialog AND "override the default setting" in temporary mode AND visited-to-home response on roaming II-NNI) OR (TIP/TIR AND 2xx response to request outside an existing dialog AND "presentation of the network asserted identity is restricted" AND (non-roaming II-NNI OR home-to-visited response on roaming II-NNI)) | | | | | | | | | | +| NOTE 1: The SIP status code is only applicable over the roaming II-NNI. | | | | | | | | | | | +| NOTE 2: If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | | | | | | | | | | + +## --- B.14 REGISTER method + +As described in table 6.1, the REGISTER method is supported only over the roaming II-NNI. + +The table B.14.1 lists the supported header fields within the REGISTER request. + +**Table B.14.1: Supported header fields within the REGISTER request** + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|-------------|------------|-----------------------------------------------------------------------------------| +| 1 | Accept | [13] | o | do | +| 2 | Accept-Encoding | [13] | o | do | +| 3 | Accept-Language | [13] | o | do | +| 4 | Allow | [13] | o | do | +| 5 | Allow-Events | [20] | o | IF table 6.1.3.1/23 THEN do (NOTE) | +| 6 | Authorization | [13] | o | IF using IMS AKA OR using SIP digest THEN dm ELSE do | +| 7 | Call-ID | [13] | m | dm | +| 8 | Call-Info | [13] | o | do | +| 9 | Cellular-Network-Info | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE) | +| 10 | Contact | [13] | o | dm | +| 11 | Content-Disposition | [13] | o | do | +| 12 | Content-Encoding | [13] | o | do | +| 13 | Content-ID | [216] | o | IF table 6.1.3.1/122 THEN do | +| 14 | Content-Language | [13] | o | do | +| 15 | Content-Length | [13] | t | dt | +| 16 | Content-Type | [13] | * | d* | +| 17 | CSeq | [13] | m | dm | +| 18 | Date | [13] | o | do | +| 19 | Expires | [13] | o | do | +| 20 | Feature-Caps | [143] | o | IF table 6.1.3.1/103 THEN do (NOTE) | +| 21 | From | [13] | m | dm | +| 22 | Geolocation | [68] | o | do | +| 23 | Geolocation-Routing | [68] | o | do | +| 24 | History-Info | [25] | o | IF table 6.1.3.1/50 AND request outside an existing dialog THEN do (NOTE) | +| 25 | Max-Breadth | [79] | o | do | +| 26 | Max-Forwards | [13] | m | dm | +| 27 | MIME-Version | [13] | o | do | +| 28 | Organization | [13] | o | do | +| 29 | P-Access-Network-Info | [24] | o | IF table 6.1.3.1/36 THEN do (NOTE) | +| 30 | P-Charging-Function-Addresses | [24], [24B] | o | dn/a | +| 31 | P-Charging-Vector | [24] | o | dm | +| 32 | P-User-Database | [60] | o | dn/a | +| 33 | P-Visited-Network-ID | [24] | o | dm | +| 34 | Path | [43] | o | dm | +| 35 | Privacy | [34] | o | dn/a | +| 36 | Proxy-Authorization | [13] | o | do | +| 37 | Proxy-Require | [13] | o | do | +| 38 | Reason | [48] | o | IF table 6.1.3.1/40 THEN do (NOTE) | +| 39 | Recv-Info | [39] | o | IF table 6.1.3.1/17 THEN do (NOTE) | +| 40 | Referred-By | [53] | o | do | +| 41 | Relayed-Charge | [5] | n/a | dn/a | +| 42 | Request-Disposition | [51] | o | do | +| 43 | Require | [13] | c | dm | +| 44 | Resource-Priority | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE) | +| 45 | Resource-Share | [5] | n/a | IF visited-to-home request on roaming II-NNI AND table 6.1.3.1/116 THEN do (NOTE) | +| 46 | Route | [13] | c | dn/a | +| 47 | Security-Client | [47] | o | dn/a | +| 48 | Security-Verify | [47] | o | dn/a | +| 49 | Session-ID | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE) | +| 50 | Supported | [13] | o | dm | +| 51 | Timestamp | [13] | o | do | +| 52 | To | [13] | m | dm | +| 53 | User-Agent | [13] | o | do | +| 54 | Via | [13] | m | dm | + +NOTE: If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. + +The table B.14.2 lists the supported header fields within the REGISTER response. + +**Table B.14.2: Supported header fields within the REGISTER response** + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|-----------------|----------------------|------------|---------------------------------------------------------------------------------------| +| 1 | Accept | 2xx | [13] | o | do | +| | | 415 | | c | dc | +| 2 | Accept-Encoding | 2xx | [13] | o | do | +| | | 415 | | c | dc | +| 3 | Accept-Language | 2xx | [13] | o | do | +| | | 415 | | c | dc | +| 4 | Accept-Resource-Priority | 2xx
417 | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE) | +| 5 | Allow | 405 | [13] | m | dm | +| | | others | | o | do | +| 6 | Allow-Events | 2xx | [20] | o | IF table 6.1.3.1/23 THEN do (NOTE) | +| 7 | Authentication-Info | 2xx | [13] | o | do | +| 8 | Call-ID | 100 | [13] | m | dm | +| | | others | | | | +| 9 | Call-Info | r | [13] | o | do | +| 10 | Contact | 2xx | [13] | o | dm | +| | | 3xx | | o | do | +| | | 485 | | | | +| 11 | Content-Disposition | r | [13] | o | do | +| 12 | Content-Encoding | r | [13] | o | do | +| 13 | Content-ID | r | [216] | o | IF table 6.1.3.1/122 THEN do | +| 14 | Content-Language | r | [13] | o | do | +| 15 | Content-Length | 100 | [13] | t | dt | +| | | others | | | | +| 16 | Content-Type | r | [13] | * | d* | +| 17 | CSeq | 100 | [13] | m | dm | +| | | others | | | | +| 18 | Date | 100 | [13] | o | do | +| | | others | | | | +| 19 | Error-Info | 3xx-6xx | [13] | o | IF table 6.1.3.1/13 THEN do (NOTE) | +| 20 | Feature-Caps | 2xx | [143] | o | IF table 6.1.3.1/103 THEN do (NOTE) | +| 21 | Flow-Timer | 2xx | [65] | o | do | +| 22 | From | 100 | [13] | m | dm | +| | | others | | | | +| 23 | Geolocation-Error | 424 | [68] | m | dm | +| | | others | | o | do | +| 24 | History-Info | r | [25] | o | IF table 6.1.3.1/50 AND response to request outside an existing dialog THEN do (NOTE) | +| 25 | MIME-version | r | [13] | o | do | +| 26 | Min-Expires | 423 | [13] | m | dm | +| 27 | Organization | r | [13] | o | do | +| 28 | P-Access-Network-Info | r | [24], [2 4A], [2 4B] | o | IF table 6.1.3.1/36 THEN do (NOTE) | +| 29 | P-Associated-URI | 2xx | [24] | o | dm | +| 30 | P-Charging-Function-Addresses | r | [24], [2 4A] | o | dn/a | +| 31 | P-Charging-Vector | 100 | [24], [24A] | o | dn/a | +| | | 18x, 2xx | | o | dm | +| | | 3xx-6xx | | o | do | +| 32 | Path | 2xx | [43] | o | dm | +| 33 | Privacy | r | [34] | o | do | +| 34 | Proxy-Authenticate | 401 | [13] | o | do | + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|-------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|-------|------------|-------------------------------------| +| | | 407 | | m | dm | +| 35 | Relayed-Charge | r | [5] | n/a | dn/a | +| 36 | Require | r | [13] | c | dc | +| 37 | Response-Source | 3xx-6xx | [5] | n/a | IF table 6.1.3.1/121 THEN do (NOTE) | +| 38 | Retry-After | 404
413
480
486
500
503
600
603 | [13] | o | do | +| 39 | Security-Server | 2xx
401 | [47] | n/a | dn/a | +| | | 421
494 | | o | dn/a | +| 40 | Server | r | [13] | o | do | +| 41 | Service-Route | 2xx | [45] | o | dm | +| 42 | Session-ID | r | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE) | +| 43 | Supported | 2xx | [13] | o | do | +| 44 | Timestamp | r | [13] | o | do | +| 45 | To | 100
others | [13] | m | dm | +| 46 | Unsupported | 420 | [13] | m | dm | +| 47 | User-Agent | r | [13] | o | do | +| 48 | Via | 100
others | [13] | m | dm | +| 49 | Warning | r | [13] | o | do | +| 50 | WWW-Authenticate | 401 | [13] | m | dm | +| | | 407 | | o | do | +| NOTE: | If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | | | | + +## --- B.15 SUBSCRIBE method + +As described in table 6.1, the support of SUBSCRIBE method over the non-roaming II-NNI is based on bilateral agreement between the operators. + +The table B.15.1 lists the supported header fields within the SUBSCRIBE request. + +**Table B.15.1: Supported header fields within the SUBSCRIBE request** + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|-------------|------------|------------------------------------------------------------------------------------------------------------------------------| +| 1 | Accept | [13], [20] | o | do | +| 2 | Accept-Contact | [51] | o | IF dc1 (PNM: clause 12.17) THEN dm ELSE do | +| 3 | Accept-Encoding | [13], [20] | o | do | +| 4 | Accept-Language | [13], [20] | o | do | +| 5 | Allow | [13], [20] | o | do | +| 6 | Allow-Events | [20] | o | do | +| 7 | Authorization | [13], [20] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 8 | Call-ID | [13], [20] | m | dm | +| 9 | Call-Info | [13], [20] | o | IF dc2 (CCBS/CCNR/CCNL: clause 12.11/12.12/12.23) THEN dm ELSE dn/a | +| 10 | Cellular-Network-Info | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE) | +| 11 | Contact | [13], [20] | m | dm | +| 12 | Content-Disposition | [13], [20] | o | do | +| 13 | Content-Encoding | [13], [20] | o | do | +| 14 | Content-ID | [216] | o | IF table 6.1.3.1/122 THEN do | +| 15 | Content-Language | [13], [20] | o | do | +| 16 | Content-Length | [13], [20] | t | dt | +| 17 | Content-Type | [13], [20] | * | d* | +| 18 | CSeq | [13], [20] | m | dm | +| 19 | Date | [13], [20] | o | do | +| 20 | Event | [20] | m | dm | +| 21 | Expires | [13], [20] | o | IF dc2 (CCBS/CCNR/CCNL: clause 12.11/12.12/12.23) OR using reg event package THEN dm ELSE do | +| 22 | Feature-Caps | [143] | o | IF table 6.1.3.1/103 THEN do (NOTE) | +| 23 | From | [13], [20] | m | dm | +| 24 | Geolocation | [68] | o | do | +| 25 | Geolocation-Routing | [68] | o | do | +| 26 | History-Info | [25] | o | IF dc1 (PNM: clause 12.17) THEN dm ELSE IF table 6.1.3.1/50 AND initial request THEN do (NOTE) | +| 27 | Max-Breadth | [79] | o | dn/a | +| 28 | Max-Forwards | [13], [20] | m | dm | +| 29 | MIME-Version | [13], [20] | o | do | +| 30 | Organization | [13], [20] | o | do | +| 31 | P-Access-Network-Info | [24], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE) | +| 32 | P-Asserted-Identity | [44] | o | IF dc2 (CCBS/CCNR/CCNL: clause 12.11/12.12/12.23) OR table 6.1.3.1/27 AND initial request THEN dm (NOTE) | +| 33 | P-Asserted-Service | [26] | o | IF (non-roaming II-NNI OR home-to-visited request on roaming II-NNI) AND table 6.1.3.1/77 AND initial request THEN do (NOTE) | +| 34 | P-Called-Party-ID | [24] | o | IF home-to-visited request on roaming II-NNI AND table 6.1.3.1/34 THEN do (NOTE) | +| 35 | P-Charging-Function-Addresses | [24] | o | dn/a | +| 36 | P-Charging-Vector | [24] | o | IF table 6.1.3.1/38 AND initial request THEN dm (NOTE) | +| 37 | P-Preferred-Identity | [44] | o | dn/a | +| 38 | P-Preferred-Service | [26] | o | IF visited-to-home request on roaming II-NNI AND table 6.1.3.1/77 AND initial request THEN do (NOTE) | +| 39 | P-Private-Network-Indication | [84] | o | IF table 6.1.3.1/80 AND initial request THEN do (NOTE) | +| 40 | P-Profile-Key | [64] | o | IF table 6.1.3.1/59 AND initial request THEN do (NOTE) | +| 41 | P-Served-User | [85] | o | IF visited-to-home request on roaming II-NNI AND initial request being sent from "privileged sender" THEN dm (NOTE) | +| 42 | P-User-Database | [60] | o | dn/a | +| 43 | P-Visited-Network-ID | [24] | o | dn/a | +| 44 | Priority | [13], [20] | o | do | +| 45 | Privacy | [34] | o | IF dc3 (OIP/OIR: clause 12.3) THEN dm ELSE | + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|-------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|------------|-----------------------------------------------------------| +| | | | | do | +| 46 | Proxy-Authorization | [13], [20] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 47 | Proxy-Require | [13], [20] | o | do | +| 48 | Reason | [48] | o | IF table 6.1.3.1/40 AND subsequent request THEN do (NOTE) | +| 49 | Record-Route | [13], [20] | o | do | +| 50 | Referred-By | [53] | o | do | +| 51 | Reject-Contact | [51] | o | do | +| 52 | Relayed-Charge | [5] | n/a | dn/a | +| 53 | Request-Disposition | [51] | o | do | +| 54 | Require | [13], [20] | o | do | +| 55 | Resource-Priority | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE) | +| 56 | Route | [13], [20] | c | dc | +| 57 | Security-Client | [47] | o | dn/a | +| 58 | Security-Verify | [47] | o | dn/a | +| 59 | Session-ID | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE) | +| 60 | Supported | [13], [20] | o | IF dc1 (PNM: clause 12.17) THEN dm ELSE do | +| 61 | Target-Dialog | [140] | o | IF table 6.1.3.1/102 THEN do (NOTE) | +| 62 | Timestamp | [13], [20] | o | do | +| 63 | To | [13], [20] | m | dm | +| 64 | Trigger-Consent | [82] | o | IF table 6.1.3.1/78 THEN do (NOTE) | +| 65 | User-Agent | [13], [20] | o | do | +| 66 | Via | [13], [20] | m | dm | +| dc1: | initial request invoked due to PNM in case of ("PN UE redirection" OR "PN access control") AND (non-roaming II-NNI OR home-to-visited request on roaming II-NNI) | | | | +| dc2: | ("CC invocation request" due to CCBS/CCNR/CCNL AND non-roaming II-NNI) OR ("CC revocation request" due to CCBS/CCNR/CCNL AND non-roaming II-NNI) | | | | +| dc3: | (initial request invoked due to OIP/OIR AND "override the default setting" in temporary mode AND visited-to-home request on roaming II-NNI) OR (initial request invoked due to OIP/OIR AND "presentation of the public user identity is restricted" AND (non-roaming II-NNI OR home-to-visited request on roaming II-NNI)) | | | | +| NOTE: | If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | | | + +The table B.15.2 lists the supported header fields within the SUBSCRIBE response. + +###### **Table B.15.2: Supported header fields within the SUBSCRIBE response** + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|----------------------------|---------------------|-------------|-----------------------------------------------------------------------------------------------------------------| +| 1 | Accept | 415 | [13], [20] | o | do | +| 2 | Accept-Encoding | 415 | [13], [20] | o | do | +| 3 | Accept-Language | 415 | [13], [20] | o | do | +| 4 | Accept-Resource-Priority | 2xx
417 | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE 2) | +| 5 | Allow | 405
others | [13], [20] | m
o | dm
do | +| 6 | Allow-Events | 2xx
489 | [20] | o
m | do
dm | +| 7 | Authentication-Info | 2xx | [13], [20] | o | IF table 6.1.3.1/7 THEN do (NOTE 2) | +| 8 | Call-ID | 100
r | [13], [20] | m | dm | +| 9 | Call-Info | r | [13], [20] | o | do | +| 10 | Cellular-Network-Info | r | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE 2) | +| 11 | Contact | 2xx
3xx
485 | [13], [20] | m
o | dm
do | +| 12 | Content-Disposition | r | [13], [20] | o | do | +| 13 | Content-Encoding | r | [13], [20] | o | do | +| 14 | Content-ID | r | [216] | o | IF table 6.1.3.1/122 THEN do | +| 15 | Content-Language | r | [13], [20] | o | do | +| 16 | Content-Length | 100
others | [13], [20] | t | dt | +| 17 | Content-Type | r | [13], [20] | * | d* | +| 18 | CSeq | 100
others | [13], [20] | m | dm | +| 19 | Date | 100
others | [13], [20] | o | do | +| 20 | Error-Info | 3xx-6xx | [13], [20] | o | IF table 6.1.3.1/13 THEN do (NOTE 2) | +| 21 | Expires | 2xx | [13], [20] | m | dm | +| 22 | Feature-Caps | 2xx | [143] | o | IF table 6.1.3.1/103 THEN do (NOTE 2) | +| 23 | From | 100
others | [13], [20] | m | dm | +| 24 | Geolocation-Error | 424
others | [68] | m
o | dm
do | +| 25 | History-Info | r | [25] | o | IF table 6.1.3.1/50 AND response to initial request THEN do (NOTE 2) | +| 26 | MIME-version | r | [13], [20] | o | do | +| 27 | Min-Expires | 423 | [13], [20] | m | dm | +| 28 | Organization | r | [13], [20] | o | do | +| 29 | P-Access-Network-Info | r | [24], [24A ], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE 2) | +| 30 | P-Asserted-Identity | r | [44] | o | IF dc1 (TIP/TIR: clause 12.4) THEN dm ELSE IF table 6.1.3.1/27 AND response to initial request THEN do (NOTE 2) | +| 31 | P-Charging-Function-Addresses | r | [24], [24A ] | o | dn/a | +| 32 | P-Charging-Vector | 100
18x, 2xx
3xx-6xx | [24], [24A] | o
o
o | dn/a
IF table 6.1.3.1/38 AND response to initial request THEN dm (NOTE 2)
do | +| 33 | P-Preferred-Identity | r | [44] | o | dn/a | +| 34 | Permission-Missing | 470 | [82] | o | IF table 6.1.3.1/78 THEN do (NOTE 2) | +| 35 | Privacy | r | [34] | o | IF dc2 (TIP/TIR: clause 12.4) THEN dm ELSE do | +| 36 | Proxy-Authenticate | 401 (NOTE 1) | [13], [20] | o | do | + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | | | | | | | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|------------|------------|--------------------------------------------------------------------------------------|--|--|--|--|--|--| +| | | 407
(NOTE 1) | | m | dm | | | | | | | +| 37 | Record-Route | 2xx | [13], [20] | o | do | | | | | | | +| 38 | Relayed-Charge | r | [5] | n/a | dn/a | | | | | | | +| 39 | Require | r | [13], [20] | o | do | | | | | | | +| 40 | Response-Source | 3xx-6xx | [5] | n/a | IF table 6.1.3.1/121 THEN do
(NOTE 2) | | | | | | | +| 41 | Restoration-Info | 504 | [5] | n/a | IF table 6.1.3.1/114 AND visited-to-home response on roaming II-NNI THEN do (NOTE 2) | | | | | | | +| 42 | Retry-After | 404
413
480
486
500
503
600
603 | [13], [20] | o | do | | | | | | | +| 43 | Security-Server | 421
494 | [47] | o | dn/a | | | | | | | +| 44 | Server | r | [13], [20] | o | do | | | | | | | +| 45 | Session-ID | r | [124] | m | IF table 6.1.3.1/94 THEN dm
(NOTE 2) | | | | | | | +| 46 | Supported | 2xx | [13], [20] | o | do | | | | | | | +| 47 | Timestamp | r | [13], [20] | o | do | | | | | | | +| 48 | To | 100
others | [13], [20] | m | dm | | | | | | | +| 49 | Unsupported | 420 | [13], [20] | o | do | | | | | | | +| 50 | User-Agent | r | [13], [20] | o | do | | | | | | | +| 51 | Via | 100
others | [13], [20] | m | dm | | | | | | | +| 52 | Warning | r | [13], [20] | o | do | | | | | | | +| 53 | WWW-Authenticate | 401
(NOTE 1) | [13], [20] | m | dm | | | | | | | +| | | 407
(NOTE 1) | | o | do | | | | | | | +| dc1: | (TIP/TIR AND 2xx response to initial request AND (visited-to-home response on roaming II-NNI OR non-roaming II-NNI)) OR (TIP/TIR AND response to initial request AND "presentation is allowed" AND home-to-visited response on roaming II-NNI) | | | | | | | | | | | +| dc2: | (TIP/TIR AND non-100 response to initial request AND "override the default setting" in temporary mode AND visited-to-home response on roaming II-NNI) OR (TIP/TIR AND 2xx response to initial request AND "presentation of the network asserted identity is restricted" AND (non-roaming II-NNI OR home-to-visited response on roaming II-NNI)) | | | | | | | | | | | +| NOTE 1: The SIP status code is only applicable over the roaming II-NNI. | | | | | | | | | | | | +| NOTE 2: If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | | | | | | | | | | | + +## --- B.16 UPDATE method + +The table B.16.1 lists the supported header fields within the UPDATE request. + +**Table B.16.1: Supported header fields within the UPDATE request** + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|------------|----------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Accept | [13], [23] | o | do | +| 2 | Accept-Contact | [51] | o | do | +| 3 | Accept-Encoding | [13], [23] | o | do | +| 4 | Accept-Language | [13], [23] | o | do | +| 5 | Allow | [13], [23] | o | do | +| 6 | Allow-Events | [20] | n/a | dn/a | +| 7 | Authorization | [13], [23] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 8 | Call-ID | [13], [23] | m | dm | +| 9 | Call-Info | [13], [23] | o | do | +| 10 | Cellular-Network-Info | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE) | +| 11 | Contact | [13], [23] | m | dm | +| 12 | Content-Disposition | [13], [23] | o | do | +| 13 | Content-Encoding | [13], [23] | o | do | +| 14 | Content-ID | [216] | o | IF table 6.1.3.1/122 THEN do | +| 15 | Content-Language | [13], [23] | o | do | +| 16 | Content-Length | [13], [23] | t | dt | +| 17 | Content-Type | [13], [23] | * | d* | +| 18 | CSeq | [13], [23] | m | dm | +| 19 | Date | [13], [23] | o | do | +| 20 | Feature-Caps | [143] | o | IF table 6.1.3.1/103 THEN do (NOTE) | +| 21 | From | [13], [23] | m | dm | +| 22 | Geolocation | [68] | o | do | +| 23 | Geolocation-Routing | [68] | o | do | +| 24 | Max-Breadth | [79] | o | dn/a | +| 25 | Max-Forwards | [13], [23] | m | dm | +| 26 | MIME-Version | [13], [23] | o | do | +| 27 | Min-SE | [52] | o | do | +| 28 | Organization | [13], [23] | o | do | +| 29 | P-Access-Network-Info | [24], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE) | +| 30 | P-Charging-Function-Addresses | [24] | o | dn/a | +| 31 | P-Charging-Vector | [24] | o | IF table 6.1.3.1/38 THEN do (NOTE) | +| 32 | P-Early-Media | [74] | o | IF dc1 (CAT: clause 12.14) OR
dc2 (announcements: clause 12.21) THEN dm
ELSE IF table 6.1.3.1/69 THEN do (NOTE) | +| 33 | Priority-Share | [5] | n/a | IF home-to-visited request on roaming II-NNI
AND table 6.1.3.1/118 THEN do (NOTE) | +| 34 | Privacy | [34] | o | do | +| 35 | Proxy-Authorization | [13], [23] | o | IF table 6.1.3.1/7 THEN do (NOTE) | +| 36 | Proxy-Require | [13], [23] | o | do | +| 37 | Reason | [48] | o | IF table 6.1.3.1/40 THEN do (NOTE) | +| 38 | Record-Route | [13], [23] | o | do | +| 39 | Recv-Info | [39] | o | IF table 6.1.3.1/17 THEN do (NOTE) | +| 40 | Referred-By | [53] | o | do | +| 41 | Reject-Contact | [51] | o | do | +| 42 | Relayed-Charge | [5] | n/a | dn/a | +| 43 | Request-Disposition | [51] | o | do | +| 44 | Require | [13], [23] | c | dc | +| 45 | Resource-Priority | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE) | +| 46 | Resource-Share | [5] | n/a | IF (home-to-visited request on roaming II-NNI
OR visited-to-home request on roaming II-NNI)
AND table 6.1.3.1/116 THEN do (NOTE) | +| 47 | Route | [13], [23] | c | dc | +| 48 | Security-Client | [47] | o | dn/a | +| 49 | Security-Verify | [47] | o | dn/a | +| 50 | Session-Expires | [52] | o | do | +| 51 | Session-ID | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE) | +| 52 | Supported | [13], [23] | o | do | +| 53 | Timestamp | [13], [23] | o | do | +| 54 | To | [13], [23] | m | dm | +| 55 | User-Agent | [13], [23] | o | do | +| 56 | Via | [13], [23] | m | dm | +| dc1: | request invoked due to stopping or restarting CAT early media on an existing dialog AND (non-roaming II-NNI OR loopback traversal scenario OR home-to-visited response on roaming II-NNI) | | | | +| dc2: | request invoked due to stopping or restarting announcement early media AND (non-roaming II-NNI OR | | | | + +| Item | Header field | Ref. | RFC status | II-NNI condition | +|----------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------|------------|------------------| +| loopback traversal scenario OR home-to-visited response on roaming II-NNI) | | | | | +| NOTE: | If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. | | | | + +The table B.16.2 lists the supported header fields within the UPDATE response. + +###### **Table B.16.2: Supported header fields within the UPDATE response** + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|------|-------------------------------|-----------------|--------------------|------------|--------------------------------------------------------------------------------------| +| 1 | Accept | 2xx | [13], [23] | o | do | +| | | 415 | | c | dc | +| 2 | Accept-Encoding | 2xx | [13], [23] | o | do | +| | | 415 | | c | dc | +| 3 | Accept-Language | 2xx | [13], [23] | o | do | +| | | 415 | | c | dc | +| 4 | Accept-Resource-Priority | 2xx
417 | [78] | o | IF table 6.1.3.1/73 THEN do (NOTE 2) | +| 5 | Allow | 405 | [13], [23] | m | dm | +| | | others | | o | do | +| 6 | Allow-Events | 2xx | [20] | n/a | dn/a | +| 7 | Authentication-Info | 2xx | [13], [23] | o | IF table 6.1.3.1/7 THEN do (NOTE 2) | +| 8 | Call-ID | 100 | [13], [23] | m | dm | +| | | others | | | | +| 9 | Call-Info | r | [13], [23] | o | do | +| 10 | Cellular-Network-Info | r | [5] | n/a | IF table 6.1.3.1/117 THEN do (NOTE 2) | +| 11 | Contact | 2xx | [13], [23] | m | dm | +| | | 3xx | | o | do | +| | | 485 | | o | do | +| 12 | Content-Disposition | r | [13], [23] | o | do | +| 13 | Content-Encoding | r | [13], [23] | o | do | +| 14 | Content-ID | r | [216] | o | IF table 6.1.3.1/122 THEN do | +| 15 | Content-Language | r | [13], [23] | o | do | +| 16 | Content-Length | 100 | [13], [23] | t | dt | +| | | others | | | | +| 17 | Content-Type | r | [13], [23] | * | d* | +| 18 | CSeq | 100 | [13], [23] | m | dm | +| | | others | | | | +| 19 | Date | 100 | [13], [23] | o | do | +| | | others | | | | +| 20 | Error-Info | 3xx-6xx | [13], [23] | o | IF table 6.1.3.1/13 THEN do (NOTE 2) | +| 21 | Feature-Caps | 2xx | [143] | o | IF table 6.1.3.1/103 THEN do (NOTE 2) | +| 22 | From | 100 | [13], [23] | m | dm | +| | | others | | | | +| 23 | Geolocation-Error | 424 | [68] | m | dm | +| | | others | | o | do | +| 24 | MIME-version | r | [13], [23] | o | do | +| 25 | Min-SE | 422 | [52] | m | dm | +| 26 | Organization | r | [13], [23] | o | do | +| 27 | P-Access-Network-Info | r | [24], [24A], [24B] | o | IF table 6.1.3.1/36 THEN do (NOTE 2) | +| 28 | P-Charging-Function-Addresses | r | [24], [24A] | o | dn/a | +| 29 | P-Charging-Vector | 100 | [24], [24A] | o | dn/a | +| | | others | | o | IF table 6.1.3.1/38 THEN do (NOTE 2) | +| 30 | P-Early-Media | 2xx | [74] | o | IF table 6.1.3.1/69 THEN do (NOTE 2) | +| 31 | Priority-Share | 2xx | [5] | n/a | IF home-to-visited response on roaming II-NNI AND table 6.1.3.1/118 THEN do (NOTE 2) | +| 32 | Privacy | r | [34] | o | do | +| 33 | Proxy-Authenticate | 401 (NOTE 1) | [13], [23] | o | do | +| | | 407 (NOTE 1) | | m | dm | +| 34 | Record-Route | 2xx | [13], [23] | o | do | +| 35 | Recv-Info | 2xx | [39] | c | IF table 6.1.3.1/17 THEN dc | + +| Item | Header field | SIP status code | Ref. | RFC status | II-NNI condition | +|------|------------------|------------------------------------------------------|------------|------------|--------------------------------------------------------------------------------------------------------------------------------------| +| | | others | | o | (NOTE 2)
IF table 6.1.3.1/17 THEN do (NOTE 2) | +| 36 | Relayed-Charge | r | [5] | n/a | dn/a | +| 37 | Require | r | [13], [23] | c | dc | +| 38 | Resource-Share | 2xx | [5] | n/a | IF (home-to-visited response on roaming II-NNI OR visited-to-home response on roaming II-NNI) AND table 6.1.3.1/116 THEN do (NOTE 2) | +| 39 | Response-Source | 3xx-6xx | [5] | n/a | IF table 6.1.3.1/121 THEN do (NOTE 2) | +| 40 | Retry-After | 404
413
480
486
500
503
600
603 | [13], [23] | o | do | +| 41 | Security-Server | 421
494 | [47] | o | dn/a | +| 42 | Server | r | [13], [23] | o | do | +| 43 | Session-Expires | 2xx | [52] | o | do | +| 44 | Session-ID | r | [124] | m | IF table 6.1.3.1/94 THEN dm (NOTE 2) | +| 45 | Supported | 2xx | [13], [23] | o | do | +| 46 | Timestamp | r | [13], [23] | o | do | +| 47 | To | 100
others | [13], [23] | m | dm | +| 48 | Unsupported | 420 | [13], [23] | m | dm | +| 49 | User-Agent | r | [13], [23] | o | do | +| 50 | Via | 100
others | [13], [23] | m | dm | +| 51 | Warning | r | [13], [23] | o | do | +| 52 | WWW-Authenticate | 401
(NOTE 1)
407
(NOTE 1) | [13], [23] | m
o | dm
do | + +NOTE 1: The SIP status code is only applicable over the roaming II-NNI. + +NOTE 2: If the capability specified in table 6.1.3.1 is not supported over the II-NNI, the IBCF in the receiving network can omit or modify the SIP header fields in the received SIP message prior to forwarding the SIP message as specified in 3GPP TS 24.229 [5] clause 5.10.6.2. + +# --- Annex C (informative): The list of option items for II-NNI + +## C.1 Scope + +This annex provides a list of items that are recommended to be selected by inter-operator agreements for the interconnection between IMS operators using the II-NNI. The items in this annex have an influence on the service interconnection. + +For the purposes of this annex, these items are called "option items". The option items are extracted from the present document other than this annex, and are categorized from the aspect of service provisioning by IMS operators. + +If an option item is used based on inter-operator agreements, then relating capabilities described in the references are used over the II-NNI. In case of misalignment between the normative part of the present document and this annex, the normative part of the present document takes precedence. + +## --- C.2 Format of option item table + +The format of option item table used in the subsequent clauses is as follows: + +- The 2nd column "Option item" shows the option item. +- The 3rd column "References" shows the relevant clauses of the present document for each option item. +- The 4th column "Applicability at the II-NNI" shows the selectable patterns for each option item. +- The 5th column "Details for operator choice" shows the details for the inter-operator agreements in case the corresponding pattern is chosen. This column intends to be used to exchange each detailed conditions of the II-NNI by means of filling the conditions in the columns corresponding to the selected pattern. Blank row intends to be used as a place holder for describing additional detailed II-NNI conditions specific to the operator network not associated with the explicit descriptions in this annex. + +## --- C.3 Option item table + +### C.3.0 Supported II-NNI traversal scenarios + +In this clause the table C.3.0.1 shows the supported II-NNI traversal scenarios option items. + +**Table C.3.0.1: Supported II-NNI traversal scenarios** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|----------------------------|------------------------------|-----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Roaming II-NNI support | entire present specification | Yes | Option items in clauses C.3.1 and C.3.2.
Applicability of "Roaming Architecture for Voice over IMS with Local Breakout" (Clause 19).
If "Roaming Architecture for Voice over IMS with Local Breakout" is applicable:
+ option items in clause C.3.3;
and
+ the default TRF address to use when not included in the "g.3gpp.trf" feature-capability indicator. | +| | | | No | | +| | | | Yes | Option items in clauses C.3.1 and C.3.3. | +| | | | No | | +| 2 | Non-roaming II-NNI support | entire present specification | Yes | Option items in clauses C.3.1 and C.3.3. | +| | | | No | | + +### C.3.1 Option item table common to roaming, non-roaming II-NNI and loopback traversal scenario + +This clause describes the option item tables common to the roaming II-NNI, the loopback traversal scenario, and the non-roaming II-NNI as follows: + +- Table C.3.1.1 shows the SIP methods option items. +- Table C.3.1.1A shows the SIP overload control option items. +- Table C.3.1.2 shows the SIP negotiation of resource reservation option item. +- Table C.3.1.2A shows the periodic refresh of SIP sessions option item. +- Table C.3.1.3 shows the replacing of SIP dialogs option item. +- Table C.3.1.4 shows the session participation option item. +- Table C.3.1.5 shows the conveying capabilities of UE option item. +- Table C.3.1.5A shows the authorization of early media option item. +- Table C.3.1.6 shows the asserting the service of authenticated users option item. +- Table C.3.1.7 shows the mode of signalling. +- Table C.3.1.7A shows the SIP message bodies option item. +- Table C.3.1.7B shows the SIP message body size option item. +- Table C.3.1.8 shows the control plane transport option item. +- Table C.3.1.9 shows the user plane transport, media, and codec option items. +- Table C.3.1.10 shows the dual tone multi frequency (DTMF) option item. +- Table C.3.1.10A shows the numbering, naming and addressing option item. +- Table C.3.1.11 shows the IP version option item. +- Table C.3.1.12 shows the supplementary services option items. + +- Table C.3.1.13 shows the additional functions option items. +- Table C.3.1.14 shows the SDP lines option items. +- Table C.3.1.15 shows the emergency services option items. +- Table C.3.1.16 shows indicating the II-NNI traversal scenario option items. +- Table C.3.1.17 shows the Mission critical services option items. +- Table C.3.1.18 shows the Calling number verification using signature verification and attestation information option items. + +**Table C.3.1.1: SIP method** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|----------------|------------------------------|-----------------------------|--------------------------------------------------------------------| +| 1 | INFO method | table 6.1/5A
table 6.1/5B | Yes | Info package name to use. | +| | | | No | | +| 2 | MESSAGE method | table 6.1/9A
table 6.1/9B | Yes | Inside or outside existing dialog, and content of MESSAGE request. | +| | | | No | | +| 3 | REFER method | table 6.1/16
table 6.1/17 | Yes | Inside or outside existing dialog. | +| | | | No | | + +**Table C.3.1.1A: SIP overload control** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|----------------------|----------------------------------|-----------------------------|--------------------------------------------------------| +| 1 | SIP overload control | table 6.1.3.1/106
clause 21.1 | Yes | Mechanisms to be used. | +| | | | | Whether to exempt MPS from SIP overload controls. | +| | | | No | | +| 2 | Feedback control | table 6.1.3.1/107
clause 21.2 | Yes | Algorithm to be used if not default (see clause 21.2). | +| | | | No | | +| 3 | Event control | table 6.1.3.1/108
clause 21.3 | Yes | Addresses to targets that can be supervised. | +| | | | No | | + +**Table C.3.1.2: Negotiation of resource reservation** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|----------------------------------------------------|------------------|-----------------------------|-----------------------------| +| 1 | Negotiation of resource reservation (precondition) | table 6.1.3.1/20 | Yes | | +| | | | No | | + +**Table C.3.1.2A: Periodic refresh of SIP sessions** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|---------------------------|------------------|-----------------------------|-------------------------------------------------------------------------------------------------------------------| +| 1 | SIP session timer (timer) | table 6.1.3.1/45 | Yes | Use conditions (Possible restriction on range of times and whether SIP session timer is applied in all sessions). | +| | | | | | + +**Table C.3.1.3: Replacing of SIP dialogs** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|-------------------------------------|------------------|-----------------------------|-----------------------------| +| 1 | Replacing of SIP dialogs (replaces) | table 6.1.3.1/47 | Yes | | +| | | | No | | + +**Table C.3.1.4: Session participation** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|------------------------------|------------------|-----------------------------|-----------------------------| +| 1 | Session participation (join) | table 6.1.3.1/48 | Yes | | +| | | | No | | + +**Table C.3.1.5: Conveying capabilities of UE** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|------------------------------|------------------|-----------------------------|-----------------------------| +| 1 | Conveying capabilities of UE | table 6.1.3.1/49 | Yes | | +| | | | No | | + +**Table C.3.1.5A: Authorization of early media** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|------------------------------|------------------|-----------------------------|------------------------------------------------------------------------------------------------------| +| 1 | Authorization of early media | table 6.1.3.1/69 | Yes | Whether to use authorization request of early media generated by the entity outside the IMS network. | +| | | | No | | + +**Table C.3.1.6: Asserting the service of authenticated users** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|-----------------------------------------------------------------------------------|------------------|-----------------------------|-----------------------------------| +| 1 | Managing the indication of the asserted service (P-Asserted-Service header field) | table 6.1.3.1/77 | Yes | Service identifier values to use. | +| | | | No | | + +**Table C.3.1.7: Mode of signalling** + +| No. | Option item | | References | Applicability at the II-NNI | Details for operator choice | +|-----|------------------------|------------------|----------------|-----------------------------|-----------------------------| +| 1 | Overlap signalling | In-dialog method | clause 6.1.1.5 | Yes | | +| | | | | No | | +| | Multiple-INVITE method | | | Yes | | +| | | | | No | | + +**Table C.3.1.7A: SIP message bodies** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|-------------|--------------|-----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | MIME type | clause 6.1.4 | Yes | MIME types to use. | +| | | | | Applicable characteristics of the SIP message body MIMEs (i.e. the value(s) of Content-Disposition header field and Content-Language header field) if necessary. | +| | | | | | + +**Table C.3.1.7B: SIP message body size** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|----------------------------------------------------|--------------|-----------------------------|-----------------------------| +| 1 | Limitation on maximum length of a SIP message body | clause 6.1.4 | Yes | Maximum length accepted. | +| | | | No | | + +**Table C.3.1.8: Control plane transport** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|-------------|------------|-----------------------------|-------------------------------------------------------------------------------------------------------------------------------| +| 1 | TCP | clause 6.2 | Yes | Use conditions (e.g. port number to accept, number of simultaneous connections in case of reuse of the existing connections). | +| | | | No | | +| 2 | UDP | clause 6.2 | Yes | Use conditions (e.g. port number to accept). | +| | | | No | | +| 3 | SCTP | clause 6.2 | Yes | Use conditions (e.g. port number to accept). | +| | | | No | | + +**Table C.3.1.9: User plane transport, media, and codec** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|-------------------------------|------------------------------|-----------------------------|------------------------------------------------------------------------------------------------------| +| 1 | Speech media (m=audio) | clause 7.1 | Yes | Names of speech codecs to use. (NOTE 1, NOTE 2) | +| | | | No | | +| 2 | Video media (m=video) | clause 7.1 | Yes | Names of video codecs to use. (NOTE 1, NOTE 2) | +| | | | No | | +| 3 | Other media | clause 7.1 | Yes | Media type (m=line of SDP) to use (e.g. application, image, message). | +| | | | No | | +| 4 | RTP/AVPF | clause 7.2 | Yes | Media type (m=line of SDP) that uses the protocol. | +| | | | No | | +| 5 | Transmission Control Protocol | clause 6.1.2.1
clause 7.2 | Yes | Media type (m=line of SDP) that uses the protocol. | +| | | | No | | +| 6 | Other user plane protocols | clause 7.2 | Yes | Protocols to use (e.g. udptl, TCP/MSRP) and media types (m=line of SDP) that describe the protocols. | +| | | | No | | + +NOTE 1: Codecs which are included in the applicable codec list made by inter-operator agreements are guaranteed to be supported at the II-NNI by the peer operators. + +NOTE 2: Whether it is allowed to offer codecs which are not included in the applicable codec list made by inter-operator agreements over the II-NNI is also determined by the inter-operator agreement if necessary. + +**Table C.3.1.10: Dual tone multi frequency (DTMF)** + +| No. | Option item | | References | Applicability at the II-NNI | Details for operator choice | +|-----|------------------------|----------------------------------------|----------------------------------------------------------------------------|-----------------------------|-----------------------------| +| 1 | DTMF transport | "telephone-event" based DTMF transport | clause 7.1
table 6.1/5A
table 6.1/5B
clause 12.14
clause 12.15 | Yes | Sampling rate to use. | +| | | | | No | | +| | The SIP INFO mechanism | | | Yes | | +| | | | | No | | + +**Table C.3.1.10A: Numbering, naming and addressing** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|---------------------------------------|------------|-----------------------------|-----------------------------| +| 1 | Subaddress ("isub" tel URI parameter) | clause 8.1 | Yes | | +| | | | No | | + +**Table C.3.1.11: IP version** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|-------------|------------|-----------------------------|----------------------------------------------------------| +| 1 | IPv4 | clause 9 | Yes | Use conditions (e.g. for control plane, for user plane). | +| | | | No | | +| 2 | IPv6 | clause 9 | Yes | Use conditions (e.g. for control plane, for user plane). | +| | | | No | | + +**Table C.3.1.12: Supplementary services** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|------------------------------------------------------------------------------------------------|---------------------------------------------|-----------------------------|--------------------------------------------------------------------------| +| 1 | Malicious Communication Identification (MCID) | clause 12.2 | Yes | Minimum information exchanged over the II-NNI. | +| | | | No | | +| 2 | Originating Identification Presentation (OIP) and Originating Identification Restriction (OIR) | clause 12.3 | Yes | | +| | | | No | | +| 3 | Terminating Identification Presentation (TIP) and Terminating Identification Restriction (TIR) | clause 12.4 | Yes | | +| | | | No | | +| 4 | Anonymous Communication Rejection (ACR) | clause 12.5 | Yes | | +| | | | No | | +| 5 | Communication DIVersion (CDIV) | clause 12.6 | Yes | | +| | | | No | | +| 6 | Communication Waiting (CW) | clause 12.7 | Yes | | +| | | | No | | +| 7 | Communication HOLD (HOLD) | clause 12.8 | Yes | | +| | | | No | | +| 8 | Message Waiting Indication (MWI) | clause 12.9 | Yes | | +| | | | No | | +| 9 | Incoming Communication Barring (ICB) | clause 12.10.1 | Yes | | +| | | | No | | +| 10 | Completion of Communications to Busy Subscriber (CCBS) | clause 12.11 | Yes | | +| | | | No | | +| 11 | Completion of Communications by No Reply (CCNR) | clause 12.12 | Yes | | +| | | | No | | +| 12 | Explicit Communication Transfer (ECT) | clause 12.13 | Yes | Type of explicit communication transfer to support. | +| | | | No | | +| 13 | Customized Alerting Tone (CAT) | clause 12.14 | Yes | CAT model to use (Gateway model, forking model and early session model). | +| | | | | Media type (m=line of SDP) applicable to CAT. | +| | | | No | | +| 14 | Customized Ringing Signal (CRS) | clause 12.15 | Yes | | +| | | | No | | +| 15 | Closed User Group (CUG) | clause 12.16 | Yes | | +| | | | No | | +| 16 | Personal Network Management (PNM) | clause 12.17 | Yes | | +| | | | No | | +| 17 | Three-Party (3PTY) | clause 12.18 | Yes | | +| | | | No | | +| 18 | Conference (CONF) | clause 12.19 | Yes | | +| | | | No | | +| 19 | Flexible Alerting (FA) | clause 12.20 | Yes | | +| | | | No | | +| 20 | Announcements | During the establishment of a session | Yes | Methods for sending announcement. | +| | | | | | +| | | During an established communication session | Yes | Methods for sending announcement. | +| | | | | | +| | | Providing announcements | Yes | Methods for sending announcement. | + +| No. | Option item | | References | Applicability at the II-NNI | Details for operator choice | +|------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|----------------------------------------|---------------------------------------------------------|-----------------------------|-----------------------------------------------------------------------------| +| | | when communication request is rejected | | No | | +| | | | | | | +| 21 | Advice Of Charge (AOC) | | clause 12.22 | Yes | | +| | | | | No | | +| 22 | Completion of Communications on Not Logged-in (CCNL) | | clause 12.23 | Yes | | +| | | | | No | | +| 23 | Presence service | | clause 15 | Yes | Presence services to use (TS 24.141 [132], OMA 1.1 [142] or OMA 2.0 [138]). | +| | | | | No | | +| 24 | Messaging service | Page-mode messaging | clause 16.2 | Yes | | +| | | | | No | | +| | | Session-mode messaging | clause 16.4 | Yes | | +| | | | | No | | +| 24A | | Session-mode messaging conferences | clause 16.5 | Yes | | +| | | | | No | | +| 24A | Delivery of original destination identity | | clause 22 | Yes | Services to apply the function. | +| | | | | No | | +| 24B | Service access number translation | | table 6.1.3.1/52A
clause 27 | Yes | | +| | | | | No | | +| 25 | Other additional service using other SIP extensions | | clause 6.1.1.3.2
clause 12.6 | Yes | The SIP extensions to use and the service that uses the extensions. | +| | | | | No | | +| 26 | Multi-Identity (MiD) | | clause 6.1.1.3.1
table 6.1.3.1/126
clause 12.26.2 | Yes | Types of non-native identities to support. (NOTE) | +| | | | | No | | +| NOTE: The non-native identities, as defined in 3GPP TS 24.174 [218] are: an alternative identity, an external alternative identity and a virtual identity. | | | | | | + +**Table C.3.1.13: Additional functions** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|------------------------------------------------------|-------------------|-----------------------------|-------------------------------------------------------------------------------------------------| +| 1 | Optimal Media Routeing | clause 17 | Yes | | +| | | | No | | +| 2 | Applying forking (NOTE 1) | table 6.1.3.1/5 | Yes | Usage of Request-Disposition header field with value "no-fork". (NOTE 3) | +| | | | No (NOTE 2) | | +| 3 | Transfer of IP multimedia service tariff information | clause 11.3 | Yes | The value of the Content-Disposition header field. | +| | | | No | | +| 4 | Telepresence using IMS | clause 23 | Yes | The value of "+sip.clue" media feature tag in Contact header field. | +| | | | No | | +| 5 | Dynamic services interactions | table 6.1.3.1/125 | Yes | The identities of the services in the Service-Interact-Info header field. | +| | | | No | | +| 6 | MTSI Data channel | clause 33 | Yes | The value "webrtc-datachannel" of "+sip.app-subtype" media feature tag in Contact header field. | +| | | | No | | + +NOTE 1: Support of handling of several responses due to forking and of the Request-Disposition header field, is mandated on the II-NNI. + +NOTE 2: In case the operator interconnects with IMS non-compliant networks, and wishes to use the II-NNI anyway, then the operators might want to negotiate if the forking procedures are applicable. + +NOTE 3: The Request-Disposition header field with value "no-fork" can be used to suppress that forking occurs. However, a peer operator might require the usage of forking e.g. to implement certain services. + +**Table C.3.1.14: SDP lines** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|-------------|--------------|-----------------------------|----------------------------------------------------| +| 1 | m=line | clause 6.1.2 | Yes | Used static RTP payload type numbers. | +| | | | | | +| 2 | b=line | clause 6.1.2 | Yes | Used bandwidth modifier types. | +| | | | | | +| 3 | a=line | clause 6.1.2 | Yes | Used attributes. | +| | | | | For the "rtpmap" attribute, used "encoding names". | + +**Table C.3.1.15: Emergency services** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|-----------------------------------------------|-------------------|-----------------------------|-------------------------------| +| 1 | Public Safety Answering Point (PSAP) Callback | table 6.1.3.1/110 | Yes | Used PSAP callback indicator. | +| | | | No | | + +**Table C.3.1.16: Indicating the II-NNI traversal scenario** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|----------------------------------------------------------------------------------|---------------------------------|-----------------------------|-----------------------------| +| 1 | Support of the "iotl" SIP URI parameter indicating the II-NNI traversal scenario | table 6.1.3.1/112
clause 5.3 | Yes | | +| | | | No | | + +**Table C.3.1.17: Mission critical services** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|--------------------------------------|---------------|-----------------------------|----------------------------------------------------------| +| 1 | Support of Mission critical services | clause 28.2.2 | Yes | MBMS transmission usage and location procedures support. | +| | | | No | | + +**Table C.3.1.18: Calling number verification using signature verification and attestation information** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|--------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------|-----------------------------|-----------------------------| +| 1 | Calling number verification using signature verification and attestation information | table 6.1.3.1/119
table 6.1.3.1/120
table 6.1.3.1/123
table 6.1.3.1/124
clause 29 | Yes | | +| | | | No | | + +### C.3.2 Option item table specific to roaming II-NNI + +This clause describes the option item tables specific to roaming II-NNI as follows: + +- Table C.3.2.1 shows the mechanism for authentication option items. +- Table C.3.2.1A shows the charging option items. +- Table C.3.2.2 shows the key of service profile for HSS query option item. +- Table C.3.2.3 shows the numbering, naming and addressing option items. +- Table C.3.2.4 shows the supplementary services option items. +- Table C.3.2.5 shows the access transfer services option items. +- Table C.3.2.6 shows the registration of bulk number contacts option items. +- Table C.3.2.7 shows the P-CSCF restoration option items. +- Table C.3.2.8 shows the resource sharing option items. +- Table C.3.2.9 shows the Priority sharing option items. +- Table C.3.2.9A shows the PS data off extension option items. +- Table C.3.2.10 shows the RLOS option items. + +**Table C.3.2.1: Mechanism for authentication** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|-----------------------------------------|-----------------|-----------------------------|-----------------------------| +| 1 | IMS AKA plus Ipsec ESP | table 6.1.3.1/7 | Yes | | +| | | | No | | +| 2 | SIP digest plus check of IP association | table 6.1.3.1/7 | Yes | | +| | | | No | | +| 3 | SIP digest plus Proxy Authentication | table 6.1.3.1/7 | Yes | | +| | | | No | | +| 4 | SIP digest with TLS | table 6.1.3.1/7 | Yes | | +| | | | No | | + +**Table C.3.2.1A: Charging** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|----------------------------------------------------|---------------------------------|-----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Inter-operator accounting | table 6.1.3.1/38
clause 11.2 | Yes | Operator network identifiers populated in the type 1 "orig-ioi" and "term-ioi" header field parameters of the P-Charging-Vector header field. | +| | | | No | | +| 2 | Inter-operator accounting for the transit scenario | clause 11.2 | Yes | Operator network identifiers populated in the "transit-ioi" header field parameters of the P-Charging-Vector header field. | +| | | | No | | + +**Table C.3.2.2: The key of service profile for HSS query** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|-----------------------------------------------------------------------|------------------|-----------------------------|-----------------------------| +| 1 | The key of service profile for HSS query (P-Profile-Key header field) | table 6.1.3.1/59 | Yes | | +| | | | No | | + +**Table C.3.2.3: Numbering, naming and addressing** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|---------------------------------------------------------------|--------------------------|-----------------------------|-----------------------------| +| 1 | Dial string ("user=dialstring" SIP URI parameter) | table 6.1.3.1/67 | Yes | | +| | | | No | | +| 2 | Barring of premium numbers ("premium-rate" tel URI parameter) | clause 8.1,
clause 24 | Yes | | +| | | | No | | + +**Table C.3.2.4: Supplementary services** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|-----------------------------------------|----------------|-----------------------------|-----------------------------| +| 1 | Outgoing Communication Barring (OCB) | clause 12.10.2 | Yes | | +| | | | No | | +| 2 | Unstructured Supplementary Service Data | clause 12.24 | Yes | | +| | | | No | | +| 3 | Enhanced Calling Name | clause 12.25 | Yes | | +| | | | No | | + +**Table C.3.2.5: Access transfer services** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|-----------------------------------------------------|-------------|-----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | IMS Centralized Services (ICS) | clause 13 | Yes | | +| | | | No | | +| 2 | PS to CS Single Radio Voice Call Continuity (SRVCC) | clause 14 | Yes | Additional use conditions (PS to CS SRVCC for calls in alerting phase, support of ATCF architecture, PS to CS SRVCC for calls in pre-alerting phase and PS to CS SRVCC with the MSC server assisted mid-call feature). | +| | | | | If the ATCF architecture applies, the URIs of SCC ASs authorised to provide PS to CS SRVCC information in the MESSAGE request. | +| | | | No | | +| | | | | | +| 3 | Single Radio Video Call Continuity (vSRVCC) | clause 14 | Yes | Additional use condition (transfer in alerting phase). | +| | | | No | | +| 4 | Inter UE Transfer (IUT) | clause 18 | Yes | | +| | | | No | | +| 5 | CS to PS Single Radio Voice Call Continuity (SRVCC) | clause 14.5 | Yes | The URIs of SCC ASs authorised to provide CS to PS SRVCC information in the MESSAGE request. | +| | | | | Additional use conditions (support of CS to PS SRVCC for calls in alerting phase and support of CS to PS SRVCC with the assisted mid-call feature). | +| | | | No | | +| | | | | | +| 6 | PS to CS Dual Radio Voice Call Continuity (DRVCC) | clause 14.6 | Yes | Additional use conditions (PS to CS DRVCC for calls in alerting phase, PS to CS DRVCC for originating calls in pre-alerting phase, PS to CS DRVCC with the MSC server assisted mid-call feature and the use of IMS Centralized Services (ICS) and the tel URI in STN). | +| | | | No | | +| 7 | CS to PS Dual Radio Voice Call Continuity (DRVCC) | clause 14.7 | Yes | Additional use conditions (CS to PS DRVCC for calls in alerting phase, CS to PS DRVCC for originating calls in pre-alerting phase, CS to PS DRVCC with the MSC server assisted mid-call feature) and the use of IMS Centralized Services (ICS). | +| | | | No | | + +**Table C.3.2.6: Registration of bulk number contacts** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|--------------------------------------|-------------------|-----------------------------|-----------------------------| +| 1 | Registration of bulk number contacts | table 6.1.3.1/104 | Yes | | +| | | | No | | + +**Table C.3.2.7: P-CSCF restoration** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|-----------------------------------------|-------------|-----------------------------|-----------------------------| +| 1 | PCRF or PCF based P-CSCF restoration | clause 25.2 | Yes | | +| | | | No | | +| 2 | HSS or UDM/HSS based P-CSCF restoration | clause 25.3 | Yes | | +| | | | No | | + +**Table C.3.2.8: Resource sharing** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|------------------|------------|-----------------------------|-----------------------------| +| 1 | Resource sharing | clause 26 | Yes | | +| | | | No | | + +**Table C.3.2.9: Priority sharing** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|------------------|---------------------------------|-----------------------------|-----------------------------| +| 1 | Priority sharing | clause 28,
table 6.1.3.1/118 | Yes | | +| | | | No | | + +**Table C.3.2.9A: 3GPP PS data off extension** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|----------------------------|----------------------------------|-----------------------------|-----------------------------| +| 1 | 3GPP PS data off extension | clause 32,
table 6.1.3.1/121A | Yes | | +| | | | No | | + +**Table C.3.2.10: RLOS** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|-------------|---------------------------------|-----------------------------|-----------------------------| +| 1 | RLOS | clause 31,
table 6.1.3.1/127 | Yes | | +| | | | No | | + +### C.3.3 Option item table specific to non-roaming II-NNI and loopback traversal scenario + +This clause describes the option item tables specific to the non-roaming II-NNI and the loopback traversal scenario as follows: + +- Table C.3.3.1 shows the SIP method option items. +- Table C.3.3.2 shows the charging option items. +- Table C.3.3.3 shows the GRUU option items. +- Table C.3.3.4 shows the media feature tags option items. +- Table C.3.3.5 shows the ISDN interworking option items. +- Table C.3.3.6 shows the corporate network option items. +- Table C.3.3.7 shows the numbering, naming and addressing option items. +- Table C.3.3.8 shows the additional functions option item. +- Table C.3.3.9 shows IMS emergency session traversal scenario option item. + +**Table C.3.3.1: SIP method** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|------------------|--------------------------------|-----------------------------|-----------------------------| +| 1 | NOTIFY method | table 6.1/10
table 6.1/11 | Yes | Event package name to use. | +| | | | No | | +| 2 | SUBSCRIBE method | table 6.1/20
table 6.1/21 | Yes | Event package name to use. | +| | | | No | | +| 3 | PUBLISH method | table 6.1/15A
table 6.1/15B | Yes | Event package name to use. | +| | | | No | | + +**Table C.3.3.2: Charging** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|----------------------------------------------------|---------------------------------|-----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Inter-operator accounting | table 6.1.3.1/38
clause 11.2 | Yes | Operator network identifiers populated in the type 2 "orig-ioi" and "term-ioi" header field parameters of the P-Charging-Vector header field. | +| | | | No | | +| 2 | Inter-operator accounting for the transit scenario | clause 11.2 | Yes | Operator network identifiers populated in the "transit-ioi" header field parameters of the P-Charging-Vector header field. | +| | | | No | | + +**Table C.3.3.3: Globally routable user agent URIs (GRUU)** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|------------------------------------------|------------------|-----------------------------|-----------------------------| +| 1 | Globally Routable User Agent URIs (gruu) | table 6.1.3.1/56 | Yes | | +| | | | No | | + +**Table C.3.3.4: Media feature tags** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|--------------------|-----------------------------------------------------------------------------------|-----------------------------|-------------------------------------| +| 1 | Media feature tags | table 6.1.3.1/76
clause 12
clause 13
clause 14
clause 16
clause 18 | Yes | Names of media feature tags to use. | +| | | | No | | + +**Table C.3.3.5: ISDN interworking** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|--------------------------------------------------------------------------|------------------|-----------------------------|-----------------------------| +| 1 | User to User Call Control Information in SIP for ISDN Interworking (uui) | table 6.1.3.1/79 | Yes | | +| | | | No | | + +**Table C.3.3.6: Corporate network** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|-------------------------|------------------|-----------------------------|-----------------------------| +| 1 | Private network traffic | table 6.1.3.1/80 | Yes | | + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|---------------------------------------------|------------|-----------------------------|-----------------------------| +| | (P-Private-Network-Indication header field) | | No | | + +**Table C.3.3.7: Numbering, naming and addressing** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|------------------------------------------------------------------------|------------|-----------------------------|---------------------------------------------------------------------------------------| +| 0 | SIP URI | clause 8.1 | Yes | Any local numbers that are allowed in addition to global numbers. | +| | | | | Domain name(s) and/or IP address(es) of hostportion to accept. | +| | | | | Applicability of PSI to use. | +| | | | | Applicability of "Unavailable User Identity" in the P-Asserted-Identity header field. | +| | | | | | +| 0A | tel URI (NOTE) | clause 8.1 | Yes | Any local numbers that are allowed in addition to global numbers. | +| | | | | Applicability of the URI in the P-Asserted-Identity header field and/or Request-URI. | +| | | | No | | +| 0B | IM URI | clause 8.1 | Yes | | +| | | | No | | +| 0C | PRES URI | clause 8.1 | Yes | | +| | | | No | | +| 1 | Number Portability Routing Number ("rn" and "npdi" tel URI parameters) | clause 8.1 | Yes | | +| | | | No | | +| 2 | Calling Party's Category ("cpc" tel URI parameter) | clause 8.1 | Yes | cpc-values to use. | +| | | | No | | +| 3 | Originating Line Information ("oli" tel URI parameter) | clause 8.1 | Yes | oli-values to use. | +| | | | No | | + +NOTE: The option item is only for the non-roaming II-NNI. + +**Table C.3.3.8: Additional functions** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|-----------------------------------------|------------------------------|-----------------------------|-----------------------------| +| 1 | Support of out-of-dialog OPTIONS method | table 6.1/12
table 6.1/13 | Yes | The purpose of the method. | +| | | | No | | + +**Table C.3.3.9: IMS emergency session traversal scenario** + +| No. | Option item | References | Applicability at the II-NNI | Details for operator choice | +|-----|------------------------------------------------------|------------------------------------------------|-----------------------------|---------------------------------------------------------------| +| 1 | IMS emergency session traversal scenario | table 6.1.3.1/55
clause 30.1
clause 30.2 | Yes | The emergency service URN(s) to use. | +| | | | | The PSAP URI to use in the Route header field, if applicable. | +| | | | No | | +| 2 | Next-Generation Pan-European eCall emergency service | clause 30.3 | Yes | | +| | | | No | | + +# --- Annex D (informative): Change history + +| Change history | | | | | | | | +|-----------------------|--------------|-----------------|-----------|------------|-----------------------------------------------------------------------------------------------------|------------|------------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 03/2015 | CT-67 | CP-150129 | 736 | 1 | Addition of an optional capability regarding a new cause-param value for service number translation | 12.7.0 | 13.0.0 | +| 03/2015 | CT-67 | CP-150130 | 719 | | Correction of a minor error in subclause C.3.1 | 12.7.0 | 13.0.0 | +| 03/2015 | CT-67 | CP-150130 | 723 | | Annex A corrections | 12.7.0 | 13.0.0 | +| 03/2015 | CT-67 | CP-150130 | 726 | 3 | Applying drafting rules | 12.7.0 | 13.0.0 | +| 03/2015 | CT-67 | CP-150130 | 729 | 1 | Adding missing abbreviations | 12.7.0 | 13.0.0 | +| 06/2015 | CT-68 | CP-150339 | 0741 | - | Reference Update: RFC 7462 (alert-info urns) | 13.0.0 | 13.1.0 | +| 06/2015 | CT-68 | CP-150341 | 0746 | - | Condition on usage of Refer-Sub header field | 13.0.0 | 13.1.0 | +| 06/2015 | CT-68 | CP-150356 | 0747 | 3 | Introducing resource sharing | 13.0.0 | 13.1.0 | +| 06/2015 | CT-68 | CP-150346 | 0749 | 1 | Correcting errors in annex B | 13.0.0 | 13.1.0 | +| 06/2015 | CT-68 | CP-150347 | 0751 | - | draft-holmberg-dispatch-iotl-parameter-04 updated to RFC 7549 | 13.0.0 | 13.1.0 | +| 06/2015 | CT-68 | CP-150350 | 0753 | 1 | Additional RFC 6665 related IETF drafts added | 13.0.0 | 13.1.0 | +| 06/2015 | CT-68 | CP-150357 | 0754 | 1 | Correcting inconsistencies in the major capability table | 13.0.0 | 13.1.0 | +| 06/2015 | CT-68 | CP-150364 | 0756 | 1 | Correction of Record-Route header field applicability in annex B | 13.0.0 | 13.1.0 | +| 06/2015 | CT-68 | CP-150364 | 0758 | - | Correction of applicable SIP status code for SIP header fields in PUBLISH response in annex B | 13.0.0 | 13.1.0 | +| 06/2015 | CT-68 | CP-150364 | 0760 | - | Addition of missing text referring to an option item table in annex C | 13.0.0 | 13.1.0 | +| 06/2015 | CT-68 | CP-150364 | 0762 | 1 | Correction of the P-Charging-Vector header field in annex B | 13.0.0 | 13.1.0 | +| 06/2015 | CT-68 | CP-150364 | 0763 | 1 | Correction of the P-Early-Media header field within the PRACK response in annex B | 13.0.0 | 13.1.0 | +| 06/2015 | CT-68 | CP-150364 | 0765 | - | Correction of the Server header field within the SUBSCRIBE response in annex B | 13.0.0 | 13.1.0 | +| 06/2015 | CT-68 | CP-150364 | 0766 | - | Correction of the Allow header field in annex B | 13.0.0 | 13.1.0 | +| 06/2015 | CT-68 | CP-150364 | 0767 | - | Clarifications on NNI impacts due to CAT service | 13.0.0 | 13.1.0 | +| 06/2015 | - | - | - | - | MCC Correction of implementation of CR0765 | 13.1.0 | 13.1.1 | +| 09/2015 | CT-69 | CP-150486 | 0768 | 3 | The privacy level "session" and "critical" are not used in OIP/OIR | 13.1.1 | 13.2.0 | +| 09/2015 | CT-69 | CP-150479 | 0769 | 1 | Service access number translation | 13.1.1 | 13.2.0 | +| 09/2015 | CT-69 | CP-150471 | 0771 | 1 | Reference update: draft-ietf-mmusic-sctp-sdp | 13.1.1 | 13.2.0 | +| 09/2015 | CT-69 | CP-150475 | 0773 | - | Missing SIP request in HSS based P-CSCF restoration | 13.1.1 | 13.2.0 | +| 09/2015 | CT-69 | CP-150479 | 0774 | - | draft-mohali-dispatch-cause-for-service-number updated to latest version | 13.1.1 | 13.2.0 | +| 09/2015 | CT-69 | CP-150486 | 0775 | 1 | The Service-Interact-Info header field | 13.1.1 | 13.2.0 | +| 09/2015 | CT-69 | CP-150478 | 0776 | 1 | Plain text message body missing in table 6.1.4.1 | 13.1.1 | 13.2.0 | +| 09/2015 | CT-69 | CP-150478 | 0777 | 1 | application/x-www-form-urlencoded missing in table 6.1.4.1 | 13.1.1 | 13.2.0 | +| 09/2015 | CT-69 | CP-150486 | 0778 | 1 | application/vnd.3gpp.crs+xml MIME body missing in CRS | 13.1.1 | 13.2.0 | +| 09/2015 | CT-69 | CP-150478 | 0779 | - | message/sip MIME body missing in table 6.1.4.1 | 13.1.1 | 13.2.0 | +| 09/2015 | CT-69 | CP-150478 | 0780 | - | Applicability of SIP header fields on a roaming II-NNI | 13.1.1 | 13.2.0 | +| 09/2015 | CT-69 | CP-150469 | 0783 | - | Reference update: RFC 7415 | 13.1.1 | 13.2.0 | +| 09/2015 | CT-69 | CP-150465 | 0787 | 1 | Correction for the II-NNI conditions | 13.1.1 | 13.2.0 | +| 12/2015 | CT-70 | CP-150796 | 0790 | 2 | Clarification on the II-NNI specifications of announcement | 13.2.0 | 13.3.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|--------------------------------------------------------------------|--------|--------| +| 12/2015 | CT-70 | CP-150796 | 0791 | 2 | Updating for annex B | 13.2.0 | 13.3.0 | +| 12/2015 | CT-70 | CP-150654 | 0795 | - | Telepresence IETF draft update | 13.2.0 | 13.3.0 | +| 12/2015 | CT-70 | CP-150659 | 0796 | 3 | Introducing MCPTT | 13.2.0 | 13.3.0 | +| 12/2015 | CT-70 | CP-150657 | 0797 | 2 | Reference update of draft-mohali-dispatch-cause-for-service-number | 13.2.0 | 13.3.0 | +| 12/2015 | CT-70 | CP-150664 | 0800 | 2 | Adding the "loopback-indication" to RAVEL | 13.2.0 | 13.3.0 | +| 12/2015 | CT-70 | CP-150731 | 0804 | 1 | ICS and the conference service | 13.2.0 | 13.3.0 | +| 12/2015 | CT-70 | CP-150660 | 0805 | - | SRVCC and subscription to conference package | 13.2.0 | 13.3.0 | +| 12/2015 | CT-70 | CP-150660 | 0806 | 1 | ICS and subscription to conference package | 13.2.0 | 13.3.0 | +| 12/2015 | CT-70 | CP-150656 | 0807 | 1 | Clarification of applicable URI formats for public user identity | 13.2.0 | 13.3.0 | +| 12/2015 | CT-70 | CP-150796 | 0808 | - | Miscellaneous editorial modification | 13.2.0 | 13.3.0 | +| 12/2015 | CT-70 | CP-150671 | 0810 | 1 | Update of UP6665 references | 13.2.0 | 13.3.0 | +| 12/2015 | CT-70 | CP-150662 | 0812 | 1 | P-CSCF restoration corrections | 13.2.0 | 13.3.0 | + +## Change history + +| Date | TSG # | TSG Doc. | CR | Rev | Cat | Subject/Comment | New | +|---------|-------|-----------|------|-----|-----|-------------------------------------------------------------------------------------------------------|--------| +| 03/2016 | CT-71 | CP-160088 | 0813 | 2 | B | Adding MBMS usage info and location info procedure | 13.4.0 | +| 03/2016 | CT-71 | CP-160088 | 0814 | 2 | F | Adding "application/vnd.3gpp.mcptt-info" MIME body | 13.4.0 | +| 03/2016 | CT-71 | CP-160088 | 0815 | 2 | B | Adding MCPTT as option item in annex C | 13.4.0 | +| 03/2016 | CT-71 | CP-160088 | 0816 | 1 | B | Adding affiliation | 13.4.0 | +| 03/2016 | CT-71 | CP-160098 | 0817 | 1 | F | Adding "Timer N" in the timer table | 13.4.0 | +| 03/2016 | CT-71 | CP-160096 | 0819 | 1 | A | Updating "Details for operator choice" in DRVCC to include the STN | 13.4.0 | +| 03/2016 | CT-71 | CP-160088 | 0821 | 1 | F | Addressed MCPTT SIP interfaces | 13.4.0 | +| 06/2016 | CT-72 | CP-160262 | 0822 | 2 | F | Some error corrections and removing an editor's note | 13.5.0 | +| 06/2016 | CT-72 | CP-160262 | 0823 | 2 | F | Group regrouping | 13.5.0 | +| 06/2016 | CT-72 | CP-160262 | 0824 | 1 | F | Conference event package subscription | 13.5.0 | +| 06/2016 | CT-72 | CP-160262 | 0825 | 1 | F | MCPTT service settings | 13.5.0 | +| 06/2016 | CT-72 | CP-160262 | 0826 | - | F | Clarifying the Accept-Contact header field in MBMS usage info | 13.5.0 | +| 06/2016 | CT-72 | CP-160262 | 0827 | 2 | F | The affiliation procedure update | 13.5.0 | +| 06/2016 | CT-72 | CP-160259 | 0828 | 1 | F | Adding the Cellular-Network-Info header field | 13.5.0 | +| 06/2016 | CT-72 | CP-160258 | 0834 | 1 | A | Adding draft-mohali-dispatch-originating-cdiv-parameter | 13.5.0 | +| 06/2016 | CT-72 | CP-160258 | 0840 | 1 | A | Updates to RFC 7315 P-header extensions usage in SIP requests/responses | 13.5.0 | +| 06/2016 | CT-72 | CP-160258 | 0843 | 1 | A | P-Access-Network-Info ABNF Update | 13.5.0 | +| 06/2016 | CT-72 | CP-160261 | 0844 | 1 | F | Update ref to draft-mohali-dispatch-cause-for-service-number-06 | 13.5.0 | +| 06/2016 | CT-72 | CP-160273 | 0830 | 1 | F | Clarification of the note about forking | 14.0.0 | +| 06/2016 | CT-72 | CP-160273 | 0831 | - | F | Changing content type to correct terminology | 14.0.0 | +| 06/2016 | CT-72 | CP-160273 | 0835 | 1 | F | Clarification of Public Service Identity at II-NNI | 14.0.0 | +| 06/2016 | CT-72 | CP-160273 | 0836 | 1 | F | Correcting the subscription to the conference package for CONF and the session-mode messaging service | 14.0.0 | +| 06/2016 | CT-72 | CP-160273 | 0837 | 1 | F | Clarification on the applicability of P-Early-Media header field and early media over the II-NNI | 14.0.0 | +| 09/2016 | CT-73 | CP-160446 | 0846 | 1 | A | Usage of the Resource-Share header field | 14.1.0 | +| 09/2016 | CT-73 | CP-160447 | 0852 | 1 | A | Reference update: RFC 7913 | 14.1.0 | +| 09/2016 | CT-73 | CP-160449 | 0855 | 1 | A | Updated ref to draft-mohali-dispatch-cause-for-service-number-07 | 14.1.0 | +| 12/2016 | CT-74 | CP-160624 | 0857 | 1 | A | Updated ref to draft-mohali-dispatch-cause-for-service-number-09 | 14.2.0 | +| 12/2016 | CT-74 | CP-160620 | 0861 | 1 | A | Updated ref to draft-mohali-dispatch-originating-cdiv-parameter-02 | 14.2.0 | +| 12/2016 | CT-74 | CP-160620 | 0865 | - | A | Reference update: RFC 7976 | 14.2.0 | +| 12/2016 | CT-74 | CP-160621 | 0875 | - | A | Reference update: RFC 7989 | 14.2.0 | +| 12/2016 | CT-74 | CP-160623 | 0877 | 2 | A | Missing support of priority sharing | 14.2.0 | +| 12/2016 | CT-74 | CP-160631 | 0878 | - | F | Additional routing functionality at the IBCF | 14.2.0 | +| 03/2017 | CT-75 | CP-170087 | 0882 | 1 | A | Correction on PSAP callback indicator option item | 14.3.0 | +| 03/2017 | CT-75 | CP-170087 | 0883 | 1 | A | Correction on the architecture diagram of II-NNI | 14.3.0 | +| 03/2017 | CT-75 | CP-170087 | 0884 | 1 | A | Addition of application/call-completion MIME Type | 14.3.0 | +| 03/2017 | CT-75 | CP-170080 | 0886 | 1 | A | Update ref to draft-mohali-dispatch-cause-for-service-number | 14.3.0 | +| 03/2017 | CT-75 | CP-170078 | 0890 | 2 | A | Update ref to draft-mohali-dispatch-originating-cdiv-parameter | 14.3.0 | +| 03/2017 | CT-75 | CP-170079 | 0894 | - | A | Reference update: RFC 8055 | 14.3.0 | +| 03/2017 | CT-75 | CP-170077 | 0896 | - | A | Applicability of Resource-Share header field | 14.3.0 | +| 03/2017 | CT-75 | CP-170085 | 0897 | 1 | B | Support of "Calling number verification" | 14.3.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|---------------------------------------------------------------------------------------------|--------| +| 06/2017 | CT-76 | CP-171134 | 0872 | 5 | F | Clarification of II-NNI for IMS emergency session | 14.4.0 | +| 06/2017 | CT-76 | CP-171130 | 0898 | 2 | B | Addition of the location parameter | 14.4.0 | +| 06/2017 | CT-76 | CP-171128 | 0900 | - | A | MIME body types used by MCPTT | 14.4.0 | +| 06/2017 | CT-76 | CP-171126 | 0901 | - | F | Modifying references to align with rel-14 MCPTT stage 1 and stage 2 restructuring | 14.4.0 | +| 06/2017 | CT-76 | CP-171134 | 0902 | 1 | F | Missing support of Response-Source header field | 14.4.0 | +| 06/2017 | CT-76 | CP-171124 | 0904 | 1 | A | Reference Update RFC8119 | 14.4.0 | +| 06/2017 | CT-76 | CP-171123 | 0908 | 1 | A | Update ref to new naming of draft-mohali-sipcore-originating-cdiv-parameter | 14.4.0 | +| 06/2017 | CT-76 | CP-171131 | 0909 | 2 | F | Support of feature capability indicator "sip.607" | 14.4.0 | +| 06/2017 | CT-76 | CP-171122 | 0913 | - | A | Reference update: draft-ietf-mmusic-sctp-sdp | 14.4.0 | +| 06/2017 | CT-76 | CP-171131 | 0914 | - | F | Reference update: draft-ietf-stir-rfc4474bis | 14.4.0 | +| 06/2017 | CT-76 | CP-171125 | 0915 | 3 | B | IMS Trace (ISAT) Procedures | 14.4.0 | +| 06/2017 | CT-76 | CP-171127 | 0916 | 3 | B | Adding other Mission Critical services | 14.4.0 | +| 06/2017 | CT-76 | CP-171135 | 0910 | 1 | F | Added unspecified abbreviations | 15.0.0 | +| 06/2017 | CT-76 | CP-171135 | 0918 | 2 | F | Misalignment regarding transcoding between TS 24.229 and TS 29.165 | 15.0.0 | +| 06/2017 | CT-76 | | | | | Editorial changes by MCC | 15.0.1 | +| 09/2017 | CT-77 | CP-172049 | 0919 | 1 | A | Added the profile status in proxy role regarding "A SIP Response Code for Unwanted Calls" | 15.1.0 | +| 09/2017 | CT-77 | CP-172040 | 0920 | 1 | B | Support of IETF draft-ietf-sipcore-content-id | 15.1.0 | +| 09/2017 | CT-77 | CP-172045 | 0922 | 1 | A | Reference Update for the ISUP location parameter | 15.1.0 | +| 09/2017 | CT-77 | CP-172049 | 0925 | - | A | Reference update from draft-ietf-sipcore-status-unwanted-06 to RFC 8197 | 15.1.0 | +| 12/2017 | CT-78 | CP-173099 | 0928 | 1 | A | Reference Update for the ISUP location parameter | 15.2.0 | +| 12/2017 | CT-78 | CP-173091 | 0933 | 1 | A | Update draft ref for Originating-CDIV param in P-Served-User | 15.2.0 | +| 12/2017 | CT-78 | CP-173090 | 0934 | - | D | Editorial modification | 15.2.0 | +| 12/2017 | CT-78 | CP-173095 | 0935 | 1 | A | Adding MCData related MIME bodies | 15.2.0 | +| 12/2017 | CT-78 | CP-173098 | 0938 | 1 | A | Correction of II-NNI condition related to P-Early-Media header field | 15.2.0 | +| 12/2017 | CT-78 | CP-173102 | 0940 | - | A | Correction of II-NNI condition related to P-Early-Media header field for the UPDATE request | 15.2.0 | +| 12/2017 | CT-78 | CP-173096 | 0943 | - | A | Addition of sign XML MIME body | 15.2.0 | +| 12/2017 | CT-78 | CP-173092 | 0945 | - | F | Reference update: RFC 8262 | 15.2.0 | +| 03/2018 | CT-79 | CP-180038 | 0946 | 1 | B | Support of "Enhanced calling name" service | 15.3.0 | +| 03/2018 | CT-79 | CP-180048 | 0947 | - | F | bSRVCC-MT NNI | 15.3.0 | +| 03/2018 | CT-79 | CP-180048 | 0948 | 1 | F | Operator choice of DTMF sampling rate | 15.3.0 | +| 03/2018 | CT-79 | CP-180042 | 0950 | - | A | Reference Update for the ISUP location parameter | 15.3.0 | +| 03/2018 | CT-79 | CP-180048 | 0951 | - | F | Updating the title of referenced TS 22.179 | 15.3.0 | +| 03/2018 | CT-79 | CP-180044 | 0953 | - | A | Reference update: RFC 8224 | 15.3.0 | +| 03/2018 | CT-79 | CP-180048 | 0955 | - | F | Correction on the terminology of non-global number | 15.3.0 | +| 03/2018 | CT-79 | CP-180048 | 0956 | - | F | Correction of the option item name for Calling number verification | 15.3.0 | +| 03/2018 | CT-79 | CP-180048 | 0957 | 1 | F | Operator choice of CAT media type | 15.3.0 | +| 06/2018 | CT-80 | CP-181022 | 0958 | 1 | F | Missing explanation of abbreviation "5xx" | 15.4.0 | +| 06/2018 | CT-80 | CP-181016 | 0959 | 1 | B | Calling number verification using signature verification and attestation information | 15.4.0 | +| 06/2018 | CT-80 | CP-181170 | 0960 | 4 | F | MBMS transmission and location procedures for MCVideo service | 15.4.0 | +| 09/2018 | CT-81 | CP-182021 | 0961 | 1 | B | Functional Alias Management over II-NNI | 15.5.0 | +| 09/2018 | CT-81 | CP-182020 | 0966 | 1 | A | Update draft ref for Originating-CDIV param in P-Served-User | 15.5.0 | +| 09/2018 | CT-81 | CP-182018 | 0967 | 1 | F | Correction of NOTE numbering for trust relationship | 15.5.0 | +| 09/2018 | CT-81 | CP-182024 | 0969 | - | A | Reference Update for the ISUP Q.850 location parameter | 15.5.0 | +| 12/2018 | CT-82 | CP-183113 | 0974 | 2 | A | Update draft ref for Originating-CDIV param in P-Served-User | 15.6.0 | +| 12/2018 | CT-82 | CP-183114 | 0977 | 1 | A | Removal of editor's note on Service-Interact-Info | 15.6.0 | +| 12/2018 | CT-82 | CP-183111 | 0978 | - | F | Support of Origination-Id in INVITE and MESSAGE methods | 15.6.0 | +| 03/2019 | CT-83 | CP-190124 | 0980 | 2 | A | References update for ISAT after related RFC completed in IETF | 15.7.0 | +| 03/2019 | CT-83 | CP-190126 | 0982 | 2 | A | Reference Update for the ISUP Cause Location Parameter Draft | 15.7.0 | +| 03/2019 | CT-83 | CP-190123 | 0988 | 1 | A | P-Served-User case orig-cdiv is now RFC 8498 | 15.7.0 | +| 06/2019 | CT#84 | CP-191094 | 0989 | - | A | Reference Update for the ISUP Cause Location Parameter Draft | 15.8.0 | +| 09/2019 | CT#85 | CP-192166 | 0992 | 1 | A | Reference Update RFC8606 | 15.9.0 | +| 09/2019 | CT#85 | CP-192174 | 0990 | 3 | F | Clarification of the usage restriction of P-Asserted-Identity header field over the II-NNI. | 16.0.0 | +| 09/2019 | CT#85 | CP-192162 | 0993 | 1 | B | Support of "Multi-Device" and "Multi-Identity" services | 16.0.0 | +| 12/2019 | CT#86 | CP-193190 | 0995 | 2 | A | P-CSCF restoration in 5GS | 16.1.0 | +| 12/2019 | CT#86 | CP-193205 | 0996 | - | B | Additional-Identity header in REFER request | 16.1.0 | +| 12/2019 | CT#86 | CP-193207 | 1004 | 1 | A | Correction for setting condition of the Contact header field | 16.1.0 | +| 03/2020 | CT#87e | CP-200229 | 1005 | 2 | F | Clarification of the scope | 16.2.0 | +| 06/2020 | CT#88e | CP-201329 | 1006 | - | F | Corrections on the II-NNI specifications on the P-Charging-Vector header field | 16.3.0 | +| 06/2020 | CT#88e | CP-201240 | 1007 | 1 | F | Re-structure of subclause for MuD/MiD service | 16.3.0 | +| 06/2020 | CT#88e | CP-201242 | 1008 | 1 | F | Adding the RLOS requirements over the II-NNI | 16.3.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|----------------------------------------------------------------------------------------------------|--------| +| 09/2020 | CT#89e | CP-202076 | 1011 | 1 | A | Addition of missing capability | 16.4.0 | +| 09/2020 | CT#89e | CP-202075 | 1015 | - | A | Support of P-Charging-Vector header field in BYE and PRACK | 16.4.0 | +| 03/2021 | CT#91e | CP-210242 | 1022 | - | A | Reference update: RFC 8841 | 16.5.0 | +| 06/2021 | CT#92e | CP-211236 | 1025 | - | F | IMS data channel at the II-NNI | 16.6.0 | +| 06/2021 | CT#92e | CP-211222 | 1027 | - | A | Correction on Calling number verification using signature verification and attestation information | 16.6.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29172/0bf9346902e9a3bdabf05ceacc1947f5_img.jpg b/marked/Rel-16/29_series/29172/0bf9346902e9a3bdabf05ceacc1947f5_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f6648febc14d88296d928b085cb791af7dcf974e --- /dev/null +++ b/marked/Rel-16/29_series/29172/0bf9346902e9a3bdabf05ceacc1947f5_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:93b52b7caafb39f72b5c7e3adec2185e5b23ec6d1c8dbd39673cf98dff67d504 +size 25513 diff --git a/marked/Rel-16/29_series/29172/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-16/29_series/29172/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d62fb9f2dea78b74524d9301ee4021c7cca0970b --- /dev/null +++ b/marked/Rel-16/29_series/29172/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:176c6929fece56407c1bc1055374a5c55ba34962b286a77ad06cd2b5b077f506 +size 9559 diff --git a/marked/Rel-16/29_series/29172/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-16/29_series/29172/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..13bd11f13e0de2a9e992e881e76d9f7d1e8c31ca --- /dev/null +++ b/marked/Rel-16/29_series/29172/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:78de62cf823141a76827a75c01d833e800b88bea4a70d465ab4ab8a7f28faee2 +size 6383 diff --git a/marked/Rel-16/29_series/29172/78ffccd66df9bafd96e3e081110d09dd_img.jpg b/marked/Rel-16/29_series/29172/78ffccd66df9bafd96e3e081110d09dd_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..81c54eb854bf7f1783fe146e56488c3d5c3c7714 --- /dev/null +++ b/marked/Rel-16/29_series/29172/78ffccd66df9bafd96e3e081110d09dd_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1c83d6e16e619939b47e5aeab6a13843e7bc0a721c40c35a2f35ff813646587c +size 26510 diff --git a/marked/Rel-16/29_series/29172/a234352dfaccdc24745c88eef7724cc6_img.jpg b/marked/Rel-16/29_series/29172/a234352dfaccdc24745c88eef7724cc6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..128b14d8f79b4cd66d687fd22a17c3e55525d74a --- /dev/null +++ b/marked/Rel-16/29_series/29172/a234352dfaccdc24745c88eef7724cc6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a78b15f2c4ecbfc5bc1a23cde8067937c20ac49b6b8bb0764ec8ca1413c93124 +size 27049 diff --git a/marked/Rel-16/29_series/29172/b0d4609bc46c2d88a8318706bb5321f7_img.jpg b/marked/Rel-16/29_series/29172/b0d4609bc46c2d88a8318706bb5321f7_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d3abe676053badf35ba4b017e1cae68d1c804959 --- /dev/null +++ b/marked/Rel-16/29_series/29172/b0d4609bc46c2d88a8318706bb5321f7_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8e2afc431787cd1b0b86750c6bd1422bd13a2e22f16844888827b255f90c4106 +size 25040 diff --git a/marked/Rel-16/29_series/29172/raw.md b/marked/Rel-16/29_series/29172/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..7a1325294351818ce9f2ab8aa3b35c135de57dfc --- /dev/null +++ b/marked/Rel-16/29_series/29172/raw.md @@ -0,0 +1,1688 @@ + + +# 3GPP TS 29.172 V16.1.0 (2022-03) + +Technical Specification + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Location Services (LCS); Evolved Packet Core (EPC) LCS Protocol (ELP) between the Gateway Mobile Location Centre (GMLC) and the Mobile Management Entity (MME); SLg interface (Release 16)** + +![LTE Advanced Pro logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for LTE Advanced Pro, featuring the word "lte" in black with a green signal icon above the "t", and the words "Advanced Pro" in red and green to the right. + +LTE Advanced Pro logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters "3GPP" in a stylized black font with a red signal icon below the "P", and the text "A GLOBAL INITIATIVE" in small black letters below it. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|----------------------------------------------------|----| +| Foreword ..... | 6 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions, symbols and abbreviations ..... | 8 | +| 3.1 Definitions..... | 8 | +| 3.2 Symbols..... | 8 | +| 3.3 Abbreviations ..... | 8 | +| 4 Functional Overview..... | 9 | +| 4.1 General ..... | 9 | +| 5 ELP Message Transport..... | 10 | +| 5.1 General ..... | 10 | +| 5.2 Use of Diameter base protocol..... | 10 | +| 5.3 Securing Diameter Messages ..... | 10 | +| 5.4 Accounting functionality..... | 10 | +| 5.5 Use of sessions ..... | 10 | +| 5.6 Transport protocol..... | 11 | +| 5.7 Routing considerations..... | 11 | +| 5.8 Advertising Application Support ..... | 11 | +| 6 ELP Procedures..... | 11 | +| 6.1 General ..... | 11 | +| 6.2 Provide Subscriber Location ..... | 12 | +| 6.2.1 General ..... | 12 | +| 6.2.2 Successful Operation..... | 12 | +| 6.2.3 Unsuccessful Operation..... | 17 | +| 6.3 Subscriber Location Report..... | 17 | +| 6.3.1 General ..... | 17 | +| 6.3.2 Successful Operation..... | 17 | +| 6.3.3 Unsuccessful Operation..... | 21 | +| 7 ELP Messages and Message Formats ..... | 21 | +| 7.1 General ..... | 21 | +| 7.2 Message Formats..... | 22 | +| 7.3 ELP Messages ..... | 22 | +| 7.3.1 Provide-Location-Request (PLR) Command ..... | 22 | +| 7.3.2 Provide-Location-Answer (PLA) Command ..... | 23 | +| 7.3.3 Location-Report-Request (LRR) Command ..... | 24 | +| 7.3.4 Location-Report-Answer (LRA) Command..... | 24 | +| 7.4 Information Elements..... | 25 | +| 7.4.1 General ..... | 25 | +| 7.4.2 SLG-Location-Type ..... | 27 | +| 7.4.3 LCS-EPS-Client-Name..... | 27 | +| 7.4.4 LCS-Requestor-Name ..... | 28 | +| 7.4.5 LCS-Priority ..... | 28 | +| 7.4.6 LCS-QoS ..... | 28 | +| 7.4.7 Horizontal-Accuracy ..... | 28 | +| 7.4.8 Vertical-Accuracy..... | 28 | +| 7.4.9 Vertical-Requested ..... | 28 | +| 7.4.10 Velocity-Requested ..... | 29 | +| 7.4.11 Response-Time ..... | 29 | +| 7.4.12 Supported-GAD-Shapes ..... | 29 | +| 7.4.13 LCS-Codeword..... | 29 | +| 7.4.14 LCS-Privacy-Check..... | 29 | +| 7.4.15 Accuracy-Fulfilment-Indicator ..... | 30 | +| 7.4.16 Age-Of-Location-Estimate ..... | 30 | + +| | | | +|---------|-------------------------------------------------------------|----| +| 7.4.17 | Velocity-Estimate ..... | 30 | +| 7.4.18 | EUTRAN-Positioning-Data ..... | 30 | +| 7.4.19 | ECGI..... | 30 | +| 7.4.20 | Location-Event ..... | 30 | +| 7.4.21 | Pseudonym-Indicator..... | 30 | +| 7.4.22 | LCS-Service-Type-ID ..... | 31 | +| 7.4.23 | LCS-Privacy-Check-Non-Session..... | 31 | +| 7.4.24 | LCS-Privacy-Check-Session ..... | 31 | +| 7.4.25 | Feature-List-ID ..... | 31 | +| 7.4.26 | Feature-List..... | 31 | +| 7.4.27 | LCS-QoS-Class ..... | 31 | +| 7.4.28 | Serving-Node..... | 31 | +| 7.4.29 | GERAN-Positioning-Info ..... | 32 | +| 7.4.30 | GERAN-Positioning-Data ..... | 32 | +| 7.4.31 | GERAN-GNSS-Positioning-Data ..... | 32 | +| 7.4.32 | UTRAN-Positioning-Info..... | 32 | +| 7.4.33 | UTRAN-Positioning-Data ..... | 32 | +| 7.4.34 | UTRAN-GNSS-Positioning-Data ..... | 32 | +| 7.4.35 | LRR-Flags ..... | 32 | +| 7.4.36 | Deferred-Location-Type..... | 33 | +| 7.4.37 | LCS-Reference-Number..... | 33 | +| 7.4.38 | Area-Event-Info ..... | 33 | +| 7.4.39 | Area-Definition..... | 34 | +| 7.4.40 | Area ..... | 34 | +| 7.4.41 | Area-Type..... | 34 | +| 7.4.42 | Area-Identification ..... | 35 | +| 7.4.43 | Occurrence-Info..... | 35 | +| 7.4.44 | Interval-Time ..... | 35 | +| 7.4.45 | Periodic-LDR-Info ..... | 35 | +| 7.4.46 | Reporting-Amount..... | 35 | +| 7.4.47 | Reporting-Interval ..... | 35 | +| 7.4.48 | Reporting-PLMN-List ..... | 35 | +| 7.4.49 | PLMN-ID-List..... | 36 | +| 7.4.50 | Periodic-Location-Support-Indicator..... | 36 | +| 7.4.51 | Prioritized-List-Indicator ..... | 36 | +| 7.4.52 | PLR-Flags..... | 36 | +| 7.4.53 | PLA-Flags..... | 37 | +| 7.4.54 | Deferred-MT-LR-Data ..... | 37 | +| 7.4.55 | Termination-Cause ..... | 38 | +| 7.4.56 | LRA-Flags ..... | 38 | +| 7.4.57 | ESMLC-Cell-Info..... | 38 | +| 7.4.58 | Cell-Portion-ID ..... | 39 | +| 7.4.59 | 1xRTT-RCID..... | 39 | +| 7.4.60 | Delayed-Location-Reporting-Data ..... | 39 | +| 7.4.61 | Civic-Address ..... | 39 | +| 7.4.62 | Barometric-Pressure ..... | 39 | +| 7.4.63 | UTRAN-Additional-Positioning-Data ..... | 39 | +| 7.4.64 | Motion-Event-Info..... | 39 | +| 7.4.65 | Linear-Distance ..... | 40 | +| 7.4.66 | Maximum-Interval..... | 40 | +| 7.4.67 | Sampling-Interval ..... | 40 | +| 7.4.68 | Reporting-Duration..... | 40 | +| 7.4.69 | Reporting-Location-Requirements ..... | 40 | +| 7.4.70 | Additional-Area ..... | 40 | +| 7.5 | Result-Code AVP and Experimental-Result AVP Values..... | 41 | +| 7.5.1 | General ..... | 41 | +| 7.5.2 | Success ..... | 41 | +| 7.5.3 | Permanent Failures ..... | 41 | +| 7.5.3.1 | DIAMETER_ERROR_USER_UNKNOWN (5001) ..... | 41 | +| 7.5.3.2 | DIAMETER_ERROR_UNAUTHORIZED_REQUESTING_NETWORK (5490) ..... | 41 | +| 7.5.4 | Transient Failures ..... | 41 | +| 7.5.4.1 | DIAMETER_ERROR_UNREACHABLE_USER (4221)..... | 41 | + +7.5.4.2 DIAMETER\_ERROR\_SUSPENDED\_USER (4222) ..... 41 +7.5.4.3 DIAMETER\_ERROR\_DETACHED\_USER (4223) ..... 41 +7.5.4.4 DIAMETER\_ERROR\_POSITIONING\_DENIED (4224)..... 42 +7.5.4.5 DIAMETER\_ERROR\_POSITIONING\_FAILED (4225) ..... 42 +7.5.4.6 DIAMETER\_ERROR\_UNKNOWN\_UNREACHABLE LCS\_CLIENT (4226) ..... 42 + +**Annex A (informative): Change history ..... 43** + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 1 Scope + +The present document specifies the procedures and information coding for the EPC LCS Protocol (ELP) that is needed to support the location services in E-UTRAN, UTRAN and GERAN. The ELP message set is applicable to the SLg interface between the MME and the GMLC and the Lgd interface between the SGSN and the GMLC. ELP is developed in accordance to the general principles stated in 3GPP TS 23.271 [2]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.271: "Functional stage 2 description of Location Services (LCS)". +- [3] 3GPP TS 23.032: "Universal Geographical Area Description (GAD)". +- [4] Void. +- [5] IETF RFC 2234: "Augmented BNF for syntax specifications". +- [6] 3GPP TS 23.003: "Numbering, addressing and identification". +- [7] 3GPP TS 29.171: "LCS Application Protocol (LCS-AP) between the MME and E-SMLC". +- [8] 3GPP TS 29.274: "Evolved General Packet Radio Service (GPRS) Tunnelling Protocol for Control plane (GTPv2-C)". +- [9] Void +- [10] 3GPP TS 32.299: "Charging management; Diameter charging applications". +- [11] 3GPP TS 29.272: "Evolved Packet System; MME and SGSN Related Interfaces Based on Diameter Protocol". +- [12] 3GPP TS 29.329: "Sh Interface based on the Diameter protocol". +- [13] 3GPP TS 33.210: "3G Security; Network Domain Security; IP Network Layer Security". +- [14] IETF RFC 4960: "Stream Control Transmission Protocol". +- [15] 3GPP TS 22.071: "Location Services (LCS); Service description". +- [16] IETF RFC 5778: "Diameter Mobile IPv6: Support for Home Agent to Diameter Server Interaction". +- [17] 3GPP TS 29.229: "Cx and Dx Interfaces based on the Diameter protocol; protocol details". +- [18] 3GPP TS 29.173: "Location Services; Diameter-based SLh interface for Control Plane LCS". +- [19] 3GPP TS 29.002: "Mobile Application Part (MAP) specification". + +- [20] 3GPP TS 49.031: "Location Services (LCS) – Base Station System Application Part LCS Extension – (BSSAP-LE)". +- [21] 3GPP TS 25.413: "UTRAN Iu Interface RANAP signalling". +- [22] 3GPP2 A.S0014-D v5.0: "Interoperability Specification (IOS) for cdma2000 Access Network Interfaces – Part 4 (A1, A1p, A2, and A5 Interfaces) UTRAN Iu Interface RANAP signalling". +- [23] IETF RFC 6733: "Diameter Base Protocol". +- [24] 3GPP TS 24.080: "Mobile radio interface layer 3 Supplementary services specification; Formats and coding". + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in TR 21.905 [1]. + +**EPC-MO-LR:** EPC Mobile Originating Location Request + +**EPC-MT-LR:** EPC Mobile Terminating Location Request + +**EPC-NI-LR:** EPC Network Induced Location Request + +**PS-MO-LR:** Packet Switched Mobile Originating Location Request + +**PS-MT-LR:** Packet Switched Mobile Terminating Location Request + +**PS-NI-LR:** Packet Switched Network Induced Location Request + +**LCS:** LoCAtion Services + +**LCS Client:** software and/or hardware entity that interacts with a LCS Server (in this case, the GMLC) for the purpose of obtaining location information for one or more Mobile Stations. LCS Clients subscribe to LCS in order to obtain location information. LCS Clients may or may not interact with human users. The LCS Client is responsible for formatting and presenting data and managing the user interface (dialogue). The LCS Client may reside in the Mobile Station (UE). + +**LCS QoS:** The QoS class determines the degree of adherence to the quality of service information as required by the source of a location request. + +**Target:** UE being positioned + +## 3.2 Symbols + +For the purposes of the present document, the following symbols apply: + +| | | +|-----|---------------------------------| +| SLg | Interface between GMLC and MME | +| Lgd | Interface between GMLC and SGSN | + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in TR 21.905 [1]. + +| | | +|------|-----------------------------------------| +| GMLC | Gateway Mobile Location Centre | +| EPC | Enhanced Packet Core | +| IMEI | International Mobile Equipment Identity | + +| | | +|------|--------------------------------------------------| +| IMS | IP Multimedia Subsystem | +| IMSI | International Mobile Subscriber Identity | +| MME | Mobility Management Entity | +| TTTP | Transfer To Third Party | +| UE | User Equipment, as defined in 3GPP TS 23.032 [3] | + +# 4 Functional Overview + +## 4.1 General + +This document defines the EPC LCS Protocol (ELP) used on the SLg interface between the GMLC and the MME and on the Lgd interface between the GMLC and the SGSN in the Evolved Packet Core (EPC). + +The location of the SLg interface within the LCS logical architecture is shown in Figure 4.1-1. + +![Figure 4.1-1: SLg interface in the LCS Architecture. This diagram shows the network architecture for LTE. A UE is connected to an eNB, which is connected to an MME. The MME is connected to an HSS and an E-SMLC. The MME is also connected to a GMLC via the SLg interface. The GMLC is connected to an LRF, which is connected to a PSAP. The MME is also connected to a Serving Gateway, which is connected to a PDN Gateway, which is connected to an IMS. The IMS is connected to a PSAP.](a234352dfaccdc24745c88eef7724cc6_img.jpg) + +``` +graph LR; UE[UE] --> eNB[eNB]; eNB --> MME[MME]; MME --> HSS[HSS]; MME --> E-SMLC[E-SMLC]; MME -- SLg --> GMLC[GMLC]; GMLC --> LRF[LRF]; LRF --> PSAP((PSAP)); MME --> SG[Serving Gateway]; SG --> PG[PDN Gateway]; PG --> IMS((IMS)); IMS --> PSAP; +``` + +Figure 4.1-1: SLg interface in the LCS Architecture. This diagram shows the network architecture for LTE. A UE is connected to an eNB, which is connected to an MME. The MME is connected to an HSS and an E-SMLC. The MME is also connected to a GMLC via the SLg interface. The GMLC is connected to an LRF, which is connected to a PSAP. The MME is also connected to a Serving Gateway, which is connected to a PDN Gateway, which is connected to an IMS. The IMS is connected to a PSAP. + +**Figure 4.1-1 SLg interface in the LCS Architecture** + +The location of the Lgd interface within the LCS logical architecture is shown in Figure 4.1-2. + +![Figure 4.1-2: Lgd interface in the LCS Architecture. This diagram shows the network architecture for UMTS. A UE is connected to an RNC/BSS, which is connected to an SGSN. The SGSN is connected to an HSS and a Serving Gateway. The SGSN is also connected to a GMLC via the Lgd interface. The GMLC is connected to an LRF, which is connected to a PSAP. The Serving Gateway is connected to a PDN Gateway, which is connected to an IMS. The IMS is connected to a PSAP.](0bf9346902e9a3bdabf05ceacc1947f5_img.jpg) + +``` +graph LR; UE[UE] --> RNC[RNC/BSS]; RNC --> SGSN[SGSN]; SGSN --> HSS[HSS]; SGSN -- Lgd --> GMLC[GMLC]; GMLC --> LRF[LRF]; LRF --> PSAP((PSAP)); SGSN --> SG[Serving Gateway]; SG --> PG[PDN Gateway]; PG --> IMS((IMS)); IMS --> PSAP; +``` + +Figure 4.1-2: Lgd interface in the LCS Architecture. This diagram shows the network architecture for UMTS. A UE is connected to an RNC/BSS, which is connected to an SGSN. The SGSN is connected to an HSS and a Serving Gateway. The SGSN is also connected to a GMLC via the Lgd interface. The GMLC is connected to an LRF, which is connected to a PSAP. The Serving Gateway is connected to a PDN Gateway, which is connected to an IMS. The IMS is connected to a PSAP. + +**Figure 4.1-2 Lgd interface in the LCS Architecture** + +The high level functions of the ELP protocol are described in 3GPP TS 23.271 [2]. + +The main functions of the protocol are: + +- To allow the GMLC to request position estimates for a particular target UE from the MME or SGSN in order to support the EPC-MT-LR or PS-MT-LR positioning procedures. This is achieved using the Provide Subscriber Location message; +- To allow the MME or SGSN to return a position estimate or an error report to the GMLC in response to a Provide Subscriber Location request as part of an EPC-MT-LR or PS-MT-LR positioning procedure; +- To allow the MME to forward an unsolicited position estimate to the GMLC as part of the EPC-MO-LR or EPC-NI-LR procedures. This is achieved using the Subscriber Location Report message; +- To allow the SGSN to forward an unsolicited position estimate to the GMLC as part of the PS-MO-LR, PS-NI-LR or periodic MO-LR TTTP procedures. This is achieved using the Subscriber Location Report message; +- To allow the GMLC to acknowledge receipt of an unsolicited position estimate as part of the EPC-MO-LR, EPC-NI-LR, PS-MO-LR, PS-NI-LR or periodic MO-LR TTTP procedures; +- To allow the GMLC to request position estimates for a particular target UE from the SGSN or MME as part of the deferred MT-LR procedure. This is achieved using the Provide Subscriber Location message; +- To allow the SGSN or MME to acknowledge receipt of position estimate request to the GMLC as part of a deferred MT-LR procedure; +- To support the procedures for handover of an IMS emergency call with EPS/GPRS access. + +# --- 5 ELP Message Transport + +## 5.1 General + +The ELP protocol is defined as a Vendor Specific diameter application (SLg application). It reuses the basic mechanisms defined by the Diameter base protocol as specified in IETF RFC 6733 [23], and it defines a number of additional commands and AVPs to implement the SLg, Lgd specific procedures. + +## 5.2 Use of Diameter base protocol + +The Diameter base protocol as specified in IETF RFC 6733 [23] shall apply except as modified by the defined support of the methods and the defined support of the commands and AVPs, result and error codes as described in this specification. Unless otherwise specified, the procedures (including error handling and unrecognised information handling) shall be used unmodified. + +## 5.3 Securing Diameter Messages + +For secure transport of Diameter messages, see 3GPP TS 33.210 [13]. + +## 5.4 Accounting functionality + +Accounting functionality (Accounting Session State Machine, related command codes and AVPs) shall not be used on the SLg, Lgd interfaces. + +## 5.5 Use of sessions + +Between the MME and the GMLC and between the SGSN and the GMLC, Diameter sessions shall be implicitly terminated. An implicitly terminated session is one for which the server does not maintain state information. The client shall not send any re-authorization or session termination requests to the server. + +The Diameter base protocol as specified in IETF RFC 6733 [23] includes the Auth-Session-State AVP as the mechanism for the implementation of implicitly terminated sessions. + +The client (server) shall include in its requests (responses) the Auth-Session-State AVP set to the value NO\_STATE\_MAINTAINED (1), as described in IETF RFC 6733 [23]. As a consequence, the server shall not maintain any state information about this session and the client shall not send any session termination request. Neither the Authorization-Lifetime AVP nor the Session-Timeout AVP shall be present in requests or responses. + +## 5.6 Transport protocol + +Diameter messages over the SLg and Lgd interfaces shall make use of SCTP (see IETF RFC 4960 [14]). + +## 5.7 Routing considerations + +This clause specifies the use of the Diameter routing AVPs Destination-Realm and Destination-Host. + +Destination-Realm AVP shall always be included in all diameter requests, and therefore is declared as mandatory in the ABNF for all commands. + +When a request is initiated by the GMLC, the name of the MME or SGSN shall be determined by querying the HSS over the SLh interface, and retrieve the specific MME or SGSN that is currently serving the UE. Therefore, Destination-Host AVP shall always be included in the commands originated at the GMLC, and is declared as mandatory in the ABNF. + +When a request is initiated by the MME or SGSN, the name of the GMLC may be either locally configured in the MME/SGSN (e.g., in the intra-domain scenario, when the GMLC belongs to the same PLMN as the MME/SGSN), or it is known from a previously received location procedure initiated at the GMLC. Therefore, the Destination-Host AVP is declared as mandatory in the ABNF of the commands originated at the MME or SGSN. + +If the Vendor-Specific-Application-ID AVP is received in any of the commands defined in this specification, it shall be ignored by the receiving node, and it shall not be used for routing purposes. + +## 5.8 Advertising Application Support + +The MME, SGSN and GMLC shall advertise support of the Diameter SLg Application by including the value of the application identifier in the Auth-Application-Id AVP within the Vendor-Specific-Application-Id grouped AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands. + +The vendor identifier value of 3GPP (10415) shall be included in the Supported-Vendor-Id AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands, and in the Vendor-Id AVP within the Vendor-Specific-Application-Id grouped AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands. + +The Vendor-Id AVP included in Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands that is not included in the Vendor-Specific-Application-Id AVPs as described above shall indicate the manufacturer of the Diameter node as per IETF RFC 6733 [23]. + +# --- 6 ELP Procedures + +## 6.1 General + +The ELP procedures, between the GMLC and the MME over SLg interface and between GMLC and SGSN over Lgd interface, are used to exchange messages related to location services. The ELP can be divided into the following sub-procedures. + +- Provide Subscriber Location +- Subscriber Location Report + +## 6.2 Provide Subscriber Location + +### 6.2.1 General + +The Provide Subscriber Location operation is used by a GMLC to request the location of a target UE from the MME or SGSN at any time, as part of EPC-MT-LR or PS-MT-LR positioning procedures. The response contains a location estimate of the target UE and other additional information. + +The Provide Subscriber Location operation is also used by a GMLC to request the location of the target UE from the SGSN or MME at any time, as part of deferred MT-LR procedure. The response contains the acknowledgment of the receipt of the request and other additional information. + +### 6.2.2 Successful Operation + +![Sequence diagram showing the successful operation of the Provide Subscriber Location procedure. The GMLC sends a PROVIDE SUBSCRIBER LOCATION REQUEST to the MME/SGSN, and the MME/SGSN returns a PROVIDE SUBSCRIBER LOCATION RESPONSE.](78ffccd66df9bafd96e3e081110d09dd_img.jpg) + +``` +sequenceDiagram + participant GMLC + participant MME_SGSN as MME/SGSN + Note left of MME_SGSN: + GMLC->>MME_SGSN: PROVIDE SUBSCRIBER LOCATION REQUEST + MME_SGSN-->>GMLC: PROVIDE SUBSCRIBER LOCATION RESPONSE + Note right of GMLC: +``` + +Sequence diagram showing the successful operation of the Provide Subscriber Location procedure. The GMLC sends a PROVIDE SUBSCRIBER LOCATION REQUEST to the MME/SGSN, and the MME/SGSN returns a PROVIDE SUBSCRIBER LOCATION RESPONSE. + +**Figure 6.2.2-1: Provide Subscriber Location procedure. Successful operation.** + +The GMLC initiates the procedure by sending a PROVIDE SUBSCRIBER LOCATION REQUEST message to the MME or SGSN. This message carries the type of location information requested (e.g. current location and optionally, velocity), the UE subscriber's IMSI, LCS QoS information (e.g. accuracy, response time), an indication of whether the LCS client has the override capability, and an indication of whether delayed location reporting for UEs transiently not reachable (e.g. UEs in extended idle mode DRX or Power Saving Mode) is supported as specified in clauses 9.1.6 and 9.1.15 of 3GPP TS 23.271 [2]. The message also carries an LCS reference number, if delayed location reporting is supported. For deferred MT-LR procedure, additionally, the message carries Deferred location type, LCS reference number, H-GMLC address, periodic LDR info, triggered LDR info, etc. + +Upon reception of PROVIDE SUBSCRIBER LOCATION REQUEST message, the MME or SGSN shall perform authentication privacy verification on the location request. After that, for EPC-MT-LR or PS-MT-LR procedures the MME or SGSN shall retrieve the location information of the target UE from E-UTRAN or UTRAN/GERAN according to the procedures described in 3GPP TS 23.271 [2]. For a deferred EPC-MT-LR procedure, the MME shall wait until the UE becomes reachable before performing authentication privacy verification on the location request and instigating periodic or triggered location in the UE. + +The MME or SGSN returns a PROVIDE SUBSCRIBER LOCATION RESPONSE to the GMLC. For EPC-MT-LR or PS-MT-LR procedures, if the target UE is transiently not reachable and delayed location reporting for UEs transiently not reachable is supported, the message shall contain an indication that the UE is transiently not reachable; otherwise the message shall contain the location estimate, its age and obtained accuracy. If the MME or SGSN failed to get the current location and the LCS client is requesting the current or last known location, the MME or SGSN may return the last known location of the target UE if this is known. + +For a deferred EPC-MT-LR procedure for periodic or triggered location, the MME returns a PROVIDE SUBSCRIBER LOCATION RESPONSE to the GMLC to indicate that the MME is able and willing to support the procedure. After the MME has performed successful authentication privacy verification on the location request and successfully instigated periodic or triggered location in the UE, the MME returns a SUBSCRIBER LOCATION REPORT to the GMLC to indicate that periodic or triggered location has been activated in the UE. The MME (or a different MME) returns additional SUBSCRIBER LOCATION REPORT messages to the GMLC (or possibly to a different GMLC if not the H-GMLC) for each periodic or triggered location event detected by the UE. For details, refer to 3GPP TS 23.271 [2]. + +If the GMLC has received indication from the HSS indicating the combined MME/SGSN node supporting the optimized LCS procedure (see 3GPP TS 29.173 [18] clause 5.2.1.2) and if the GMLC also supports optimized LCS procedure, the GMLC shall set the "Optimized-LCS-Proc-Req" bit within the PLR-Flags of the PROVIDE SUBSCRIBER LOCATION REQUEST message during EPC-MT-LR and/or PS-MT-LR procedures. When the combined MME/SGSN receives this message with "Optimized-LCS-Proc-Req" bit within the PLR-Flags set, the combined MME/SGSN shall perform EPC-MT-LR or PS-MT-LR procedure depending upon the knowledge of the current RAT type of the UE. E.g. if the UE is in active mode in E-UTRAN, the combined MME/SGSN shall perform only EPC-MT-LR procedure; if the ISR activated UE is in idle mode, the combined MME/SGSN shall perform the paging followed by either EPC-MT-LR or PS-MT-LR procedure (depending upon the RAT where the UE is active). Hence, the combined MME/SGSN shall perform optimized LCS procedure to retrieve the location information of the target UE from either E-UTRAN or UTRAN/GERAN. + +The combined MME/SGSN shall return a PROVIDE SUBSCRIBER LOCATION RESPONSE to the GMLC. If the target UE is transiently not reachable and delayed location reporting for UEs transiently not reachable is supported, the message shall contain an indication that the UE is transiently not reachable; otherwise the message shall contain the location estimate, its age and obtained accuracy. If the combined MME/SGSN failed to get the current location and the LCS client is requesting the current or last known location, the combined MME/SGSN should return the latest of the last known EPS or UTRAN/GERAN location of the target UE if this is known. In both the cases, the combined MME/SGSN may set "Optimized-LCS-Proc-Performed" bit within PLA-Flags, if it has performed optimized LCS procedure. + +This procedure is mapped to the commands Provide-Location-Request/Answer in the Diameter application specified in clauses 7.3.1 and 7.3.2. + +Table 6.2.2-1: Provide Subscriber Location Request + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|-----------------------------------|-------------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location Type | SLG-Location-Type | M | This Information Element shall contain the type of location measurement requested, such as current location, initial location, last known location, etc. (see 3GPP TS 22.071 [15]). | +| IMSI | User-Name | C | If present, this Information Element shall contain the IMSI of the user whose UE is to be positioned (see Note 1). | +| MSISDN | MSISDN | C | If present, this Information Element shall contain the MSISDN of the user whose UE is to be positioned (see Note 1). | +| IMEI | IMEI | C | If present, this Information Element shall contain the IMEI of the UE to be positioned (see Note 1). | +| Client Name | LCS-EPS-Client-Name | M | This Information Element shall contain the name of the LCS client issuing the positioning request. | +| Client Type | LCS-Client-Type | M | This Information Element shall contain the type of LCS client (Emergency, Lawful Interception ...) issuing the positioning request (see 3GPP TS 23.271 [2] and 3GPP TS 32.299 [10]). | +| Requestor Name | LCS-Requestor-Name | O | If present, this Information Element contains the identity of the originating entity which has requested the location of the target UE from the LCS Client. | +| Priority | LCS-Priority | O | If present, this Information Element shall contain the priority of the LCS client issuing the positioning request. | +| QoS | LCS-QoS | O | If present, this Information Element shall contain the quality of service requested, such as the accuracy of the positioning measurement and the response time of the positioning operation. | +| Velocity Requested | Velocity-Requested | O | If present, this information element shall contain an indication of whether or not the Velocity of the target UE is requested. | +| Supported GAD Shapes | LCS-Supported-GAD-Shapes | O | If present, this Information Element shall contain the list of supported GAD shapes by the LCS client. | +| Service Type ID | LCS-Service-Type-ID | O | If present, this Information Element shall contain the service type associated for the particular positioning request (the meaning of the different service types is defined in 3GPP TS 22.071 [15]). | +| Codeword | LCS-Codeword | O | If present, this Information Element shall contain the Codeword to be used between an LCS client and a target UE in order to check and accept or reject the positioning request. | +| APN | Service-Selection | C | If present, this Information Element shall contain the Access Point Name (APN) Network Identifier of the LCS client, as used by the target UE. It shall only be included in session-related location requests. | +| Session-Related Privacy Check | LCS-Privacy-Check-Session | O | If present, this Information Element shall contain an indication of how the positioning operation should proceed in the relation to the checking of the session-related privacy settings of the user. | +| Non-Session-Related Privacy Check | LCS-Privacy-Check-Non-Session | O | If present, this Information Element shall contain an indication of how the positioning operation should proceed in the relation to the checking of the non-session-related privacy settings of the user. | +| Deferred Location Type | Deferred-Location-Type | O | If present, this Information Element shall contain the type of the event until when the location estimation is deferred. Applicable event types are: UE available, UE entering or leaving or being in a pre-defined geographical area, periodic location, UE moving by more than a minimum linear distance (NOTE). This Information Element is applicable only for the deferred MT-LR procedure.
NOTE: this value is only applicable to a deferred EPC-MT-LR. | +| LCS-Reference Number | LCS-Reference-Number | O | If present, this Information Element shall contain the reference number identifying the deferred location request or identifying the request for which delayed location reporting for UEs transiently not reachable is supported. This Information Element is applicable only when:
- the deferred MT-LR procedure is initiated; or
- an EPC-MT-LR or PS-MT-LR procedure is initiated and the message includes the indication that delayed location reporting for UEs transiently not reachable is supported. | +| Area Event Info | Area-Event-Info | O | If present, this Information Element shall contain area definition, type of area event, occurrence info and minimum interval time. For a deferred EPC-MT-LR, this Information Element may also contain the duration of event reporting, the maximum time interval between event reports, the maximum event sampling interval, and whether location | + +| | | | | +|--------------------------------------------------------------------|--------------------------|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | estimates shall be included in event reports. This Information Element is applicable only when the deferred MT-LR is initiated for the area event (UE entering or leaving or being in a pre-defined geographical area). | +| H-GMLC Address | GMLC-Address | O | If present, this Information Element shall contain the address identifying the H-GMLC which initiated the deferred MT-LR procedure. This Information Element is applicable only when the deferred MT-LR procedure is performed. | +| PLR Flags | PLR-Flags | O | This Information Element contains a bit mask. See 7.4.52 for the meaning of the bits. | +| Periodic LDR Information | Periodic-LDR-Information | O | If present, this Information Element shall contain reporting amount and reporting interval of deferred periodic location. This Information Element is applicable only when the deferred MT-LR procedure is initiated for the periodic location event. | +| Reporting PLMN List | Reporting-PLMN-List | O | If present, this Information Element shall contain a list of PLMNs in which the subsequent location estimates must be obtained, or the subsequent triggered or periodic events must be reported, by the UE as part of a periodic MO-LR TTTP or periodic MT-LR procedure. | +| Supported Features (See 3GPP TS 29.229 [17]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Motion Event Info | Motion-Event-Info | O | If present, this Information Element shall contain information for motion event reporting. This information includes the minimum linear distance for a motion event report, the duration of event reporting, the minimum and maximum time intervals between event reports, the maximum event sampling interval, whether location estimates shall be included in event reports, and whether only one location report is required or more than one. This Information Element is applicable only for a deferred EPC-MT-LR. | +| NOTE 1: At least one of these IEs shall be present in the message. | | | | + +Table 6.2.2-2: Provide Subscriber Location Answer + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|-------------------------------|-----------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result | Result-Code / Experimental-Result | M | This Information Element shall contain the result of the operation. The Result-Code AVP shall be used to indicate success / errors as defined in the Diameter base protocol (see IETF RFC 6733 [23]). The Experimental-Result AVP shall be used for ELP errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | +| Location Estimate | Location-Estimate | O | If present, this Information Element shall contain an estimate of the location of the UE in universal coordinates and the accuracy of the estimate.
This Information Element shall not be included if the PLA Flags Information Element is present and if the bit corresponding to the "UE-Transiently-Not-Reachable-Indicator" is set. | +| Accuracy Fulfilment Indicator | Accuracy-Fulfilment-Indicator | O | If present, this Information Element shall contain an indication of whether the requested accuracy (as indicated in the LCS-QoS IE in the request message) was fulfilled or not. | +| Age of Location Estimate | Age-of-Location-Estimate | O | If present, this Information Element shall contain an indication of how long ago the location estimate was obtained. | +| Velocity Estimate | Velocity-Estimate | O | If present, this Information Element shall contain an estimate of the velocity of the target UE, composed by horizontal speed, vertical speed, and their respective uncertainty (see 3GPP TS 23.032 [3]). | +| EUTRAN Positioning Data | EUTRAN-Positioning-Data | O | If present, this Information Element shall indicate the usage of each positioning method that was attempted to determine the location estimate, either successfully or unsuccessfully. The internal structure and encoding is defined in 3GPP TS 29.171 [7]. This Information Element is applicable only when the UE is attached to E-UTRAN access and when the message is sent by the MME or the combined MME/SGSN. | +| ECGI | ECGI | O | If present, this Information Element shall contain the current cell location of the target UE as delivered by the eNB to the MME. The E-UTRAN Cell Global Identifier (ECGI) is used to globally identify a cell. This Information Element is applicable only when the UE is attached to E-UTRAN access and when the message is sent by the MME or combined MME/SGSN. | +| GERAN Positioning Info | GERAN-Positioning-Info | O | If present, this Information Element shall indicate the usage of each positioning method that was attempted to determine the location estimate, either successfully or unsuccessfully. This Information Element is applicable only when the UE is attached to GERAN access and when the message is sent by the SGSN or combined MME/SGSN. | +| CGI | Cell-Global-Identity | O | If present, this Information Element shall contain the current cell location of the target UE. The Cell Global Identifier (CGI) is used to globally identify a cell. This Information Element is applicable only when the UE is attached to GERAN access and when the message is sent by the SGSN or combined MME/SGSN. | +| UTRAN Positioning Info | UTRAN-Positioning-Info | O | If present, this Information Element shall indicate the usage of each positioning method that was attempted to determine the location estimate, either successfully or unsuccessfully. This Information Element is applicable only when the UE is attached to UTRAN access and when the message is sent by the SGSN or combined MME/SGSN. | +| SAI | Service-Area-Identity | O | If present, this Information Element shall contain the current service area of the target UE. The Service Area Identifier (SAI) is used to globally identify a service area. This Information Element is applicable only when the UE is attached to UTRAN access and when the message is sent by the SGSN or combined MME/SGSN. | +| Target Serving Node Identity | Serving-Node | O | If present, this information element shall contain the address of the target side serving node for handover of an IMS Emergency Call. | +| PLA Flags | PLA-Flags | O | This Information Element contains a bit mask. See 7.4.53 for the meaning of the bits.
If this Information Element is present and if the bit corresponding to the "Deferred-MT-LR-Response-Indicator" is set, the "Location-Estimate" Information Element is ignored in this message. | + +| | | | | +|----------------------------------------------|---------------------|---|----------------------------------------------------------------------------------------------------------------------| +| E-SMLC provided Cell Info | ESMLC-Cell-Info | O | If present, this Information Element shall contain the current cell information of the target UE as known by E-SMLC. | +| Civic Address | Civic-Address | O | If present, this Information Element contains a location estimate for the target UE expressed as a Civic address. | +| Barometric Pressure | Barometric-Pressure | O | If present, this Information Element contains the barometric pressure measurement as reported by the target UE. | +| Supported Features (See 3GPP TS 29.229 [17]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | + +### 6.2.3 Unsuccessful Operation + +On receipt of a PROVIDE SUBSCRIBER LOCATION RESPONSE with a Result-Code or Experimental-Result AVP indicating failure the GMLC considers the positioning request as failed. + +If the GMLC receives "Optimized-LCS-Proc-Performed" bit within PLA-Flags set, it shall assume that the combined MME/SGSN has either performed EPC-MT-LR or PS-MT-LR procedure to retrieve the location of the target UE. And hence, it need not send another PROVIDE SUBSCRIBER LOCATION REQUEST message to the combined MME/SGSN. + +## 6.3 Subscriber Location Report + +### 6.3.1 General + +The Subscriber Location Report operation is used by an MME or SGSN to provide the location of a target UE to a GMLC, when a request for location has been implicitly issued or when a Delayed Location Reporting is triggered after receipt of a request for location for a UE transiently not reachable. + +### 6.3.2 Successful Operation + +![Sequence diagram showing the successful operation of the Subscriber Location Report procedure. The MME/SGSN sends a SUBSCRIBER LOCATION REPORT message to the GMLC, and the GMLC responds with a SUBSCRIBER LOCATION REPORT ACK message.](b0d4609bc46c2d88a8318706bb5321f7_img.jpg) + +``` + +sequenceDiagram + participant MME/SGSN + participant GMLC + Note left of MME/SGSN: + MME/SGSN->>GMLC: SUBSCRIBER LOCATION REPORT + Note right of GMLC: + GMLC-->>MME/SGSN: SUBSCRIBER LOCATION REPORT ACK + Note left of MME/SGSN: + +``` + +Sequence diagram showing the successful operation of the Subscriber Location Report procedure. The MME/SGSN sends a SUBSCRIBER LOCATION REPORT message to the GMLC, and the GMLC responds with a SUBSCRIBER LOCATION REPORT ACK message. + +**Figure 6.3.2-1: Subscriber Location Report procedure. Successful operation.** + +The MME or SGSN initiates the procedure by sending a SUBSCRIBER LOCATION REPORT message to the GMLC. The message may carry the identity of the UE, the location estimate and its age, and the event causing the location report. + +Upon reception of SUBSCRIBER LOCATION REPORT message, the GMLC shall return a SUBSCRIBER LOCATION REPORT ACK to the MME or SGSN and process the location report accordingly, e.g. transfer of the location estimate to an external LCS Client according to procedure described in 3GPP TS 23.271 [2]. + +If the Location-Event indicates a DEFERRED\_LR\_RESPONSE then the Location-Estimate shall not be sent if the LCS-Supported-GAD-Shapes had been received in Provide Subscriber Location request and the shape encoded in Location-Estimate was not marked as supported in LCS-Supported-GAD-Shapes. In such a case Termination-Cause in Deferred-MT-LR-Data shall be present with value SHAPE\_OF\_LOCATION\_ESTIMATE\_NOT\_SUPPORTED. + +This procedure is mapped to the commands Location-Report-Request/Answer in the Diameter application specified in clauses 7.3.3 and 7.3.4. + +Table 6.3.2-1: Subscriber Location Report + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|-------------------------------|-------------------------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location Event | Location-Event | M | This Information Element shall contain the type of event that caused the location procedure to be initiated. | +| IMSI | User-Name | C | If present, this Information Element shall contain the IMSI of the user whose UE is to be positioned (see Note 1). | +| MSISDN | MSISDN | C | If present, this Information Element shall contain the MSISDN of the user whose UE is to be positioned (see Note 1). | +| IMEI | IMEI | C | If present, this Information Element shall contain the IMEI of the UE to be positioned (see Note 1). | +| Client Name | LCS-EPS-Client-Name | O | If present, this Information Element shall contain the name of the LCS client where the result of the positioning operation should be sent. | +| Location Estimate | Location-Estimate | O | If present, this Information Element shall contain an estimate of the location of the UE in universal coordinates and the accuracy of the estimate. | +| Accuracy Fulfilment Indicator | Accuracy-Fulfilment-Indicator | O | If present, this Information Element shall contain an indication of whether the requested accuracy was fulfilled or not. | +| Age of Location Estimate | Age-of-Location-Estimate | O | If present, this Information Element shall contain an indication of how long ago the location estimate was obtained. | +| Velocity Estimate | Velocity-Estimate | O | If present, this Information Element shall contain an estimate of the velocity of the UE, composed by horizontal speed, vertical speed, and their respective uncertainty (see 3GPP TS 23.032 [3]). | +| EUTRAN Positioning Data | EUTRAN-Positioning-Data | O | If present, this Information Element shall indicate the usage of each positioning method that was attempted to determine the location estimate, either successfully or unsuccessfully. The internal structure and encoding is defined in 3GPP TS 29.171 [7]. This Information Element is applicable only when the UE is attached to E-UTRAN access and when the message is sent by the MME or the MME part of the combined MME/SGSN. | +| ECGI | ECGI | O | If present, this Information Element shall contain the current cell location of the target UE as delivered by the eNB to the MME. The E-UTRAN Cell Global Identifier (ECGI) is used to globally identify a cell. This Information Element is applicable only when the UE is attached to E-UTRAN access and when the message is sent by the MME or the MME part of the combined MME/SGSN. | +| GERAN Positioning Info | GERAN-Positioning-Info | O | If present, this Information Element shall indicate the usage of each positioning method that was attempted to determine the location estimate, either successfully or unsuccessfully. This Information Element is applicable only when the UE is attached to GERAN access and when the message is sent by the SGSN or the SGSN part of the combined MME/SGSN. | +| CGI | Cell-Global-Identity | O | If present, this Information Element shall contain the current cell location of the target UE. The Cell Global Identifier (CGI) is used to globally identify a cell. This Information Element is applicable only when the UE is attached to GERAN access and when the message is sent by the SGSN or the SGSN part of the combined MME/SGSN. | +| UTRAN Positioning Info | UTRAN-Positioning-Info | O | If present, this Information Element shall indicate the usage of each positioning method that was attempted to determine the location estimate, either successfully or unsuccessfully. This Information Element is applicable only when the UE is attached to UTRAN access and when the message is sent by the SGSN or the SGSN part of the combined MME/SGSN. | +| SAI | Service-Area-Identity | O | If present, this Information Element shall contain the current service area of the target UE. The Service Area Identifier (SAI) is used to globally identify a service area. This Information Element is applicable only when the UE is attached to UTRAN access and when the message is sent by the SGSN or the SGSN part of the combined MME/SGSN. | +| Service Type ID | LCS-Service-Type-ID | O | If present, this Information Element shall contain the service type associated for the particular positioning report identifying the service at the receiving LCS Client (the meaning of the different service types is defined in 3GPP TS 22.071 [15]). | +| Pseudonym Indicator | Pseudonym-Indicator | O | If present, this Information Element shall contain an indication of whether or not a pseudonym must be allocated by the network and | + +| | | | | +|-------------------------------------------------|---------------------------------|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | transferred to the LCS client as the identity of the UE. | +| Supported Features
(See 3GPP TS 29.229 [17]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| LCS QoS Class | LCS-QoS-Class | O | If present, this Information Element shall contain the LCS-QoS-Class requested by the target UE. | +| Target Serving Node Identity | Serving-Node | O | If present, this information element shall contain the address of the target side serving node for handover of an IMS Emergency Call. | +| LRR Flags
(See 7.4.35) | LRR-Flags | C | This Information Element contains a bit mask. See 7.4.35 for the meaning of the bits.
It shall be present when the message is sent over Lgd interface. | +| LCS-Reference Number | LCS-Reference-Number | O | If present, this Information Element shall contain the reference number identifying the deferred location request or identifying the request for which Delayed Location Reporting is triggered. This is same as the reference number included in the Provide Subscriber Location request for the deferred MT-LR procedure or for the EPC-MT-LR or PS-MT-LR with the Delayed-Location-Reporting-Support indication, or the reference number included in the Subscriber Location Report Ack for periodic MO-LR TTTP procedure. This Information Element shall be included if the Location-Event is set to:
- "DEFERRED_MT_LR_RESPONSE"; or
- "DELAYED_LOCATION_REPORTING". | +| Deferred MT-LR Data | Deferred-MT-LR-Data | O | If present, this Information Element is used to report the deferred location event type, the location information and optionally a reason why the serving node or UE aborted monitoring the event to the GMLC. The deferred location event type may correspond to the location event type requested in the Provide Subscriber Location Request. For a deferred EPC-MT-LR, the deferred location event type may also indicate LDR activation in the UE or expiration of the maximum time interval between event reports. This Information Element shall be included when the Location-Event is set to "DEFERRED_MT_LR_RESPONSE". | +| H-GMLC Address | GMLC-Address | O | If present, this Information Element shall contain the address identifying the H-GMLC which should receive location estimates. This is the same as the H-GMLC address included in the Provide Subscriber Location request for the deferred MT-LR procedure or the H-GMLC address included in the Subscriber Location Report Ack for periodic MO-LR TTTP procedure. | +| Sequence Number | Reporting-Amount | O | If present, this parameter contains the number of the periodic location reports completed. The sequence number would be set to 1 in the first location report and increment by 1 for each new report. When the number reaches the reporting amount value, the H-GMLC (for a periodic MT-LR or a periodic MO-LR TTTP) will know the procedure is complete. This Information Element is applicable only when the message is sent by the SGSN or the SGSN part of the combined MME/SGSN. | +| Periodic LDR Information | Periodic-LDR-Information | O | If present, this Information Element shall contain the UE requested reporting amount and reporting interval of deferred periodic location reporting. This Information Element is applicable only when the periodic MO-LR TTTP procedure is initiated by the UE and when the message is sent by the SGSN or the SGSN part of the combined MME/SGSN. | +| E-SMLC provided Cell Info | ESMLC-Cell-Info | O | If present, this Information Element shall contain the current cell information of the target UE as known by E-SMLC. | +| 1xRTT Reference Cell ID | 1xRTT-RCID | O | If present, this Information Element shall contain the 1xRTT Reference Cell ID uniquely identifying of the target cell location for handover of an IMS emergency call. This Information Element is applicable only when the UE is making handover to a cdma2000 1xRTT access and when the message is sent by the MME or the MME part of the combined MME/SGSN. | +| Delayed Location Reporting Data | Delayed-Location-Reporting-Data | O | If present, this Information Element is used to report to the GMLC the reason why the serving node ended an earlier EPC-MT-LR or PS-MT-LR with the Delayed-Location-Reporting-Support indication received for a UE transiently not reachable.
This Information Element shall be included when the Location-Event is set to "DELAYED_LOCATION_REPORTING". | + +| | | | | +|--------------------------------------------------------------------|---------------------|---|-------------------------------------------------------------------------------------------------------------------| +| Civic Address | Civic-Address | O | If present, this Information Element contains a location estimate for the target UE expressed as a Civic address. | +| Barometric Pressure | Barometric-Pressure | O | If present, this Information Element contains the barometric pressure measurement as reported by the target UE. | +| NOTE 1: At least one of these IEs shall be present in the message. | | | | + +Table 6.3.2-2: Subscriber Location Report Ack + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|----------------------------------------------|-----------------------------------|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result | Result-Code / Experimental-Result | M | This Information Element shall contain the result of the operation. The Result-Code AVP shall be used to indicate success / errors as defined in the Diameter base protocol (see IETF RFC 6733 [23]). The Experimental-Result AVP shall be used for ELP errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | +| H-GMLC Address | GMLC-Address | O | If present, this Information Element shall contain the address identifying the H-GMLC which should receive location estimates as part of periodic MO-LR TTTP procedure. This Information Element is applicable only when the message is sent towards the SGSN or the SGSN part of the combined MME/SGSN. | +| LRA Flags | LRA-Flags | O | This Information Element contains a bit mask. See 7.4.56 for the meaning of the bits. | +| Reporting PLMN List | Reporting-PLMN-List | O | If present, this Information Element shall contain a list of PLMNs in which the subsequent location estimates must be obtained as part of periodic MO-LR TTTP procedure. This Information Element is applicable only when the message is sent towards the SGSN or the SGSN part of the combined MME/SGSN. | +| LCS Reference Number | LCS-Reference-Number | O | If present, this Information Element shall contain the reference number identifying the deferred location request or identifying the request for which Delayed Location Reporting was triggered. This Information Element is applicable only when the message is sent towards the SGSN or the SGSN part of the combined MME/SGSN. | +| Supported Features (See 3GPP TS 29.229 [17]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | + +### 6.3.3 Unsuccessful Operation + +If for some reason the GMLC does not accept the SUBSCRIBER LOCATION REPORT APDU, the GMLC shall send a SUBSCRIBER LOCATION REPORT ACK message with a Result-Code or Experimental-Result AVP indicating failure. + +# 7 ELP Messages and Message Formats + +## 7.1 General + +The Diameter base protocol as specified in IETF RFC 6733 [23] shall apply except as modified by the defined support of the methods and the defined support of the commands and AVPs, result and error codes as specified in this specification. Unless otherwise specified, the procedures (including error handling and unrecognised information handling) shall be used unmodified. + +This clause specifies a Diameter application that allows a Diameter server and a Diameter client: + +- to retrieve the location information of a target UE +- to report the location information of a target UE + +The SLg/Lgd interface protocol is defined as an IETF vendor specific Diameter application, where the vendor is 3GPP. The vendor identifier assigned by IANA to 3GPP () is 10415. + +The Diameter application identifier assigned to the SLg interface application is 16777255 (allocated by IANA). + +The Lgd interface uses the Diameter application identifier defined for the SLg interface application. + +## 7.2 Message Formats + +This clause defines Command-Code values for the SLg interface application. These Command-Code values are applicable for the SLg and Lgd interfaces. + +Every command is defined by means of the ABNF syntax IETF RFC 2234 [5], according to the Command Code Format (CCF) specification defined in IETF RFC 6733 [23]. If the definition and use of an AVP is not specified in this document, the guidelines IETF RFC 6733 [23] shall apply. + +For these commands, the Application-ID field shall be set to 16777255 (application identifier of the SLg interface application). + +The Vendor-Specific-Application-Id AVP shall not be included in any command sent by Diameter nodes supporting applications defined in this specification. If the Vendor-Specific-Application-Id AVP is received in any of the commands defined in this specification, it shall be ignored by the receiving node. + +NOTE: The Vendor-Specific-Application-Id is included as an optional AVP in all Command Code Format specifications defined in this specification in order to overcome potential interoperability issues with intermediate Diameter agents non-compliant with IETF RFC 6733 [23]. + +The following Command Codes are defined in this specification: + +**Table 7.2-1: Command-Code values** + +| Command-Name | Abbreviation | Code | Clause | +|--------------------------|--------------|---------|--------| +| Provide-Location-Request | PLR | 8388620 | 7.3.1 | +| Provide-Location -Answer | PLA | 8388620 | 7.3.2 | +| Location-Report-Request | LRR | 8388621 | 7.3.3 | +| Location-Report-Answer | LRA | 8388621 | 7.3.4 | + +## 7.3 ELP Messages + +### 7.3.1 Provide-Location-Request (PLR) Command + +The Provide-Location-Request (PLR) command, indicated by the Command-Code field set to 8388620 and the 'R' bit set in the Command Flags field, is sent by the GMLC in order to request subscriber location to the MME or SGSN. + +Message Format + +``` +< Provide-Location-Request > ::= < Diameter Header: 8388620, REQ, PXY, 16777255 > + < Session-Id > + [ Vendor-Specific-Application-Id ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + { Destination-Host } + { Destination-Realm } + { SLg-Location-Type } + [ User-Name ] + [ MSISDN ] + [ IMEI ] + { LCS-EPS-Client-Name } + { LCS-Client-Type } +``` + +``` + +[ LCS-Requestor-Name ] +[ LCS-Priority ] +[ LCS-QoS ] +[ Velocity-Requested ] +[ LCS-Supported-GAD-Shapes ] +[ LCS-Service-Type-ID ] +[ LCS-Codeword ] +[ LCS-Privacy-Check-Non-Session ] +[ LCS-Privacy-Check-Session ] +[ Service-Selection ] +[ Deferred-Location-Type ] +[ LCS-Reference-Number ] +[ Area-Event-Info ] +[ GMLC-Address ] +[ PLR-Flags ] +[ Periodic-LDR-Information ] +[ Reporting-PLMN-List ] +[ Motion-Event-Info ] +*[ Supported-Features ] +*[ AVP ] +*[ Proxy-Info ] +*[ Route-Record ] + +``` + +### 7.3.2 Provide-Location-Answer (PLA) Command + +The Provide-Location-Answer (PLA) command, indicated by the Command-Code field set to 8388620 and the 'R' bit cleared in the Command Flags field, is sent by the MME or SGSN to the GMLC in response to the Provide-Location-Request command. + +Message Format + +``` + +< Provide-Location-Answer > ::= < Diameter Header: 8388620, PXY, 16777255 > +< Session-Id > +[ Vendor-Specific-Application-Id ] +[ Result-Code ] +[ Experimental-Result ] +{ Auth-Session-State } +{ Origin-Host } +{ Origin-Realm } +[ Location-Estimate ] +[ Accuracy-Fulfilment-Indicator ] +[ Age-Of-Location-Estimate ] +[ Velocity-Estimate ] +[ EUTRAN-Positioning-Data ] +[ ECGI ] +[ GERAN-Positioning-Info ] +[ Cell-Global-Identity ] +[ UTRAN-Positioning-Info ] +[ Service-Area-Identity ] +[ Serving-Node ] +[ PLA-Flags ] +[ ESMLC-Cell-Info ] +[ Civic-Address ] +[ Barometric-Pressure ] +*[ Supported-Features ] +*[ AVP ] +[ Failed-AVP ] +*[ Proxy-Info ] +*[ Route-Record ] + +``` + +### 7.3.3 Location-Report-Request (LRR) Command + +The Location-Report-Request (LRR) command, indicated by the Command-Code field set to 8388621 and the 'R' bit set in the Command Flags field, is sent by the MME or SGSN in order to provide subscriber location data to the GMLC. + +#### Message Format + +``` +< Location-Report-Request > ::= < Diameter Header: 8388621, REQ, PXY, 16777255 > +< Session-Id > +[ Vendor-Specific-Application-Id ] +{ Auth-Session-State } +{ Origin-Host } +{ Origin-Realm } +{ Destination-Host } +{ Destination-Realm } +{ Location-Event } +[ LCS-EPS-Client-Name ] +[ User-Name ] +[ MSISDN ] +[ IMEI ] +[ Location-Estimate ] +[ Accuracy-Fulfilment-Indicator ] +[ Age-Of-Location-Estimate ] +[ Velocity-Estimate ] +[ EUTRAN-Positioning-Data ] +[ ECGI ] +[ GERAN-Positioning-Info ] +[ Cell-Global-Identity ] +[ UTRAN-Positioning-Info ] +[ Service-Area-Identity ] +[ LCS-Service-Type-ID ] +[ Pseudonym-Indicator ] +[ LCS-QoS-Class ] +[ Serving-Node ] +[ LRR-Flags ] +[ LCS-Reference-Number ] +[ Deferred-MT-LR-Data ] +[ GMLC-Address ] +[ Reporting-Amount ] +[ Periodic-LDR-Information ] +[ ESMLC-Cell-Info ] +[ 1xRTT-RCID ] +[ Delayed-Location-Reporting-Data ] +[ Civic-Address ] +[ Barometric-Pressure ] +*[ Supported-Features ] +*[ AVP ] +*[ Proxy-Info ] +*[ Route-Record ] +``` + +### 7.3.4 Location-Report-Answer (LRA) Command + +The Location-Report-Answer (LRA) command, indicated by the Command-Code field set to 8388621 and the 'R' bit cleared in the Command Flags field, is sent by the GMLC to the MME or SGSN in response to the Location-Report-Request command. + +#### Message Format + +``` +< Location-Report-Answer > ::= < Diameter Header: 8388621, PXY, 16777255 > +< Session-Id > +[ Vendor-Specific-Application-Id ] +[ Result-Code ] +``` + +``` +[ Experimental-Result ] +{ Auth-Session-State } +{ Origin-Host } +{ Origin-Realm } +[ GMLC-Address ] +[ LRA-Flags ] +[ Reporting-PLMN-List ] +[ LCS-Reference-Number ] +*[ Supported-Features ] +*[ AVP ] +[ Failed-AVP ] +*[ Proxy-Info ] +*[ Route-Record ] +``` + +## 7.4 Information Elements + +### 7.4.1 General + +The following table describes the Diameter AVPs defined for the SLg interface protocol, their AVP Code values, types, possible flag values and whether the AVP may or not be encrypted. + +For all AVPs which contain bit masks and are of the type Unsigned32, bit 0 shall be the least significant bit. For example, to get the value of bit 0, a bit mask of 0x00000001 should be used. + +Table 7.4.1-1: Diameter ELP Application AVPs + +| Attribute Name | AVP Code | Clause defined | Value Type | AVP Flag rules | | | | | +|-------------------------------------|----------|----------------|-------------|----------------|-----|------------|----------|-------------| +| | | | | Must | May | Should not | Must not | May Encrypt | +| SLG-Location-Type | 2500 | 7.4.2 | Enumerated | M, V | | | | No | +| LCS-EPS-Client-Name | 2501 | 7.4.3 | Grouped | M, V | | | | No | +| LCS-Requestor-Name | 2502 | 7.4.4 | Grouped | M, V | | | | No | +| LCS-Priority | 2503 | 7.4.5 | Unsigned32 | M, V | | | | No | +| LCS-QoS | 2504 | 7.4.6 | Grouped | M, V | | | | No | +| Horizontal-Accuracy | 2505 | 7.4.7 | Unsigned32 | M, V | | | | No | +| Vertical-Accuracy | 2506 | 7.4.8 | Unsigned32 | M, V | | | | No | +| Vertical-Requested | 2507 | 7.4.9 | Enumerated | M, V | | | | No | +| Velocity-Requested | 2508 | 7.4.10 | Enumerated | M, V | | | | No | +| Response-Time | 2509 | 7.4.11 | Enumerated | M, V | | | | No | +| Supported-GAD-Shapes | 2510 | 7.4.12 | Unsigned32 | M, V | | | | No | +| LCS-Codeword | 2511 | 7.4.13 | UTF8String | M, V | | | | No | +| LCS-Privacy-Check | 2512 | 7.4.14 | Enumerated | M, V | | | | No | +| Accuracy-Fulfilment-Indicator | 2513 | 7.4.15 | Enumerated | M, V | | | | No | +| Age-Of-Location-Estimate | 2514 | 7.4.16 | Unsigned32 | M, V | | | | No | +| Velocity-Estimate | 2515 | 7.4.17 | OctetString | M, V | | | | No | +| EUTRAN-Positioning-Data | 2516 | 7.4.18 | OctetString | M, V | | | | No | +| ECGI | 2517 | 7.4.19 | OctetString | M, V | | | | No | +| Location-Event | 2518 | 7.4.20 | Enumerated | M, V | | | | No | +| Pseudonym-Indicator | 2519 | 7.4.21 | Enumerated | M, V | | | | No | +| LCS-Service-Type-ID | 2520 | 7.4.22 | Unsigned32 | M, V | | | | No | +| LCS-Privacy-Check-Non-Session | 2521 | 7.4.23 | Grouped | M, V | | | | No | +| LCS-Privacy-Check-Session | 2522 | 7.4.24 | Grouped | M, V | | | | No | +| LCS-QoS-Class | 2523 | 7.4.27 | Enumerated | M, V | | | | No | +| GERAN-Positioning-Info | 2524 | 7.4.29 | Grouped | V | | | M | No | +| GERAN-Positioning-Data | 2525 | 7.4.30 | OctetString | V | | | M | No | +| GERAN-GANSS-Positioning-Data | 2526 | 7.4.31 | OctetString | V | | | M | No | +| UTRAN-Positioning-Info | 2527 | 7.4.32 | Grouped | V | | | M | No | +| UTRAN-Positioning-Data | 2528 | 7.4.33 | OctetString | V | | | M | No | +| UTRAN-GANSS-Positioning-Data | 2529 | 7.4.34 | OctetString | V | | | M | No | +| LRR-Flags | 2530 | 7.4.35 | Unsigned32 | V | | | M | No | +| LCS-Reference-Number | 2531 | 7.4.37 | OctetString | V | | | M | No | +| Deferred-Location-Type | 2532 | 7.4.36 | Unsigned32 | V | | | M | No | +| Area-Event-Info | 2533 | 7.4.38 | Grouped | V | | | M | No | +| Area-Definition | 2534 | 7.4.39 | Grouped | V | | | M | No | +| Area | 2535 | 7.4.40 | Grouped | V | | | M | No | +| Area-Type | 2536 | 7.4.41 | Unsigned32 | V | | | M | No | +| Area-Identification | 2537 | 7.4.42 | Grouped | V | | | M | No | +| Occurrence-Info | 2538 | 7.4.43 | Enumerated | V | | | M | No | +| Interval-Time | 2539 | 7.4.44 | Unsigned32 | V | | | M | No | +| Periodic-LDR-Information | 2540 | 7.4.45 | Grouped | V | | | M | No | +| Reporting-Amount | 2541 | 7.4.46 | Unsigned32 | V | | | M | No | +| Reporting-Interval | 2542 | 7.4.47 | Unsigned32 | V | | | M | No | +| Reporting-PLMN-List | 2543 | 7.4.48 | Grouped | V | | | M | No | +| PLMN-ID-List | 2544 | 7.4.49 | Grouped | V | | | M | No | +| PLR-Flags | 2545 | 7.4.52 | Unsigned32 | V | | | M | No | +| PLA-Flags | 2546 | 7.4.53 | Unsigned32 | V | | | M | No | +| Deferred-MT-LR-Data | 2547 | 7.4.54 | Grouped | V | | | M | No | +| Termination-Cause | 2548 | 7.4.55 | Unsigned32 | V | | | M | No | +| LRA-Flags | 2549 | 7.4.56 | Unsigned32 | V | | | M | No | +| Periodic-Location-Support-Indicator | 2550 | 7.4.50 | Enumerated | V | | | M | No | +| Prioritized-List-Indicator | 2551 | 7.4.51 | Enumerated | V | | | M | No | +| ESMLC-Cell-Info | 2552 | 7.4.57 | Grouped | V | | | M | No | +| Cell-Portion-ID | 2553 | 7.4.58 | Unsigned32 | V | | | M | No | +| 1xRTT-RCID | 2554 | 7.4.59 | OctetString | V | | | M | No | +| Delayed-Location-Reporting-Data | 2555 | 7.4.60 | Grouped | V | | | M | No | + +| | | | | | | | | | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------|--------|-------------|---|--|--|---|----| +| Civic-Address | 2556 | 7.4.61 | UTF8String | V | | | M | No | +| Barometric-Pressure | 2557 | 7.4.62 | Unsigned32 | V | | | M | No | +| UTRAN-Additional-Positioning-Data | 2558 | 7.4.63 | OctetString | V | | | M | No | +| Motion-Event-Info | 2559 | 7.4.64 | Grouped | V | | | M | No | +| Linear-Distance | 2560 | 7.4.65 | Unsigned32 | V | | | M | No | +| Maximum-Interval | 2561 | 7.4.66 | Unsigned32 | V | | | M | No | +| Sampling-Interval | 2562 | 7.4.67 | Unsigned32 | V | | | M | No | +| Reporting-Duration | 2563 | 7.4.68 | Unsigned32 | V | | | M | No | +| Reporting-Location-Requirements | 2564 | 7.4.69 | Unsigned32 | V | | | M | No | +| Additional-Area | 2565 | 7.4.70 | Grouped | V | | | M | No | +| Note: The AVP header bit denoted as 'M', indicates whether support of the AVP is required. The AVP header bit denoted as 'V', indicates whether the optional Vendor-ID field is present in the AVP header. For further details, see IETF RFC 6733 [23]. | | | | | | | | | + +Table 7.4.1-2: Diameter ELP Application reused AVPs + +| Attribute Name | AVP Code | Reference | Value Type | Comment | +|-------------------------|----------|-----------------------------------------|-------------|---------------------------------------| +| LCS-Format-Indicator | 1237 | 3GPP TS 32.299 [10] | Enumerated | | +| LCS-Name-String | 1238 | 3GPP TS 32.299 [10] | UTF8String | | +| LCS-Client-Type | 1241 | 3GPP TS 32.299 [10] | Enumerated | | +| LCS-Requestor-Id-String | 1240 | 3GPP TS 32.299 [10] | UTF8String | | +| Location-Estimate | 1242 | 3GPP TS 32.299 [10] | OctetString | | +| IMEI | 1402 | 3GPP TS 29.272 [11] | UTF8String | | +| MSISDN | 701 | 3GPP TS 29.329 [12] | OctetString | | +| Service-Selection | 493 | 3GPP TS 29.272 [11], IETF RFC 5778 [16] | UTF8String | It is used to define the APN | +| User-Name | 1 | IETF RFC 6733 [23] | UTF8String | It is used to include the user's IMSI | +| Supported-Features | 628 | 3GPP TS 29.229 [17] | Grouped | | +| Feature-List-ID | 629 | 3GPP TS 29.229 [17] | Unsigned32 | See clause 7.4.25 | +| Feature-List | 630 | 3GPP TS 29.229 [17] | Unsigned32 | See clause 7.4.26 | +| Serving-Node | 2401 | 3GPP TS 29.173 [18] | Grouped | See clause 6.4.3 | +| Cell-Global-Identity | 1604 | 3GPP TS 29.272 [11] | OctetString | See clause 7.3.119 | +| Service-Area-Identity | 1607 | 3GPP TS 29.272 [11] | OctetString | See clause 7.3.122 | +| GMLC-Address | 2405 | 3GPP TS 29.173 [18] | Address | See clause 6.4.7 | +| Visited-PLMN-Id | 1407 | 3GPP TS 29.272 [11] | OctetString | See clause 7.3.9 | + +### 7.4.2 SLg-Location-Type + +The SLg-Location-Type AVP is of type Enumerated. The following values are defined: + +CURRENT\_LOCATION (0) + +CURRENT\_OR\_LAST\_KNOWN\_LOCATION (1) + +INITIAL\_LOCATION (2) + +ACTIVATE\_DEFERRED\_LOCATION (3) + +CANCEL\_DEFERRED\_LOCATION (4) + +NOTIFICATION\_VERIFICATION\_ONLY (5) + +### 7.4.3 LCS-EPS-Client-Name + +The LCS-EPS-Client-Name AVP is of type Grouped. + +AVP format: + +LCS-EPS-Client-Name ::= + +[ LCS-Name-String ] +[ LCS-Format-Indicator ] + +The details of the LCS-Name-String AVP and the LCS-Format-Indicator AVP are described in 3GPP TS 32.299 [10]. + +### 7.4.4 LCS-Requestor-Name + +The LCS-Requestor-Name AVP is of type Grouped. + +AVP format: + +LCS-Requestor-Name ::= + +[ LCS-Requestor-Id-String ] +[ LCS-Format-Indicator ] + +The details of the LCS-Requestor-Id-String AVP and the LCS-Format-Indicator AVP are described in 3GPP TS 32.299 [10]. + +### 7.4.5 LCS-Priority + +The LCS-Priority AVP is of type Unsigned32. It indicates the priority of the location request. The value 0 shall indicate the highest priority, and the value 1 shall indicate normal priority. All other values shall be treated as 1 (normal priority). For details, refer to 3GPP TS 22.071 [15]. + +### 7.4.6 LCS-QoS + +The LCS-QoS AVP is of type Grouped. + +AVP format: + +LCS-QoS ::= + +[ LCS-QoS-Class ] +[ Horizontal-Accuracy ] +[ Vertical-Accuracy ] +[ Vertical-Requested ] +[ Response-Time ] + +### 7.4.7 Horizontal-Accuracy + +The Horizontal-Accuracy AVP is of type Unsigned32. Bits 6-0 corresponds to Uncertainty Code defined in 3GPP TS 23.032 [3]. The horizontal location error should be less than the error indicated by the uncertainty code with 67% confidence. Bits 7 to 31 shall be ignored. + +### 7.4.8 Vertical-Accuracy + +The Vertical-Accuracy AVP is of type Unsigned32. Bits 6-0 corresponds to Uncertainty Code defined in 3GPP TS 23.032 [3]. The vertical location error should be less than the error indicated by the uncertainty code with 67% confidence. Bits 7 to 31 shall be ignored. + +### 7.4.9 Vertical-Requested + +The Vertical-Requested AVP is of type Enumerated. The following values are defined: + +VERTICAL\_COORDINATE\_IS\_NOT\_REQUESTED (0) + +VERTICAL\_COORDINATE\_IS\_REQUESTED (1) + +Default value if AVP is not present is: VERTICAL\_COORDINATE\_IS\_NOT\_REQUESTED (0). + +### 7.4.10 Velocity-Requested + +The Velocity-Requested AVP is of type Enumerated. The following values are defined: + +VELOCITY\_IS\_NOT\_REQUESTED (0) + +VELOCITY\_IS\_REQUESTED (1) + +Default value if AVP is not present is: VELOCITY\_IS\_NOT\_REQUESTED (0). + +### 7.4.11 Response-Time + +The Response-Time AVP is of type Enumerated. The following values are defined: + +LOW\_DELAY (0) + +DELAY\_TOLERANT (1) + +### 7.4.12 Supported-GAD-Shapes + +The Supported-GAD-Shapes AVP is of type Unsigned32 and it shall contain a bitmask. + +A node shall mark in the BIT STRING all Shapes defined in 3GPP TS 23.032 [3] it supports. + +Bits 10-0 in shall indicate the supported Shapes defined in 3GPP TS 23.032 [3]. Bits 11 to 31 shall be ignored. + +ellipsoidPoint (0) + +ellipsoidPointWithUncertaintyCircle (1) + +ellipsoidPointWithUncertaintyEllipse (2) + +polygon (3) + +ellipsoidPointWithAltitude (4) + +ellipsoidPointWithAltitudeAndUncertaintyEllipsoid (5) + +ellipsoidArc (6) + +highAccuracyEllipsoidPointWithUncertaintyEllipse (7) + +highAccuracyEllipsoidPointWithAltitudeAndUncertaintyEllipsoid (8) + +highAccuracyEllipsoidPointWithScalableUncertaintyEllipse (9) + +highAccuracyEllipsoidPointWithAltitudeAndScalableUncertaintyEllipsoid (10) + +### 7.4.13 LCS-Codeword + +The LCS-Codeword AVP is of type UTF8String. It indicates the potential codeword string to send in a notification message to the UE. + +### 7.4.14 LCS-Privacy-Check + +The LCS-Privacy-Check AVP is of type Enumerated. The following values are defined: + +ALLOWED\_WITHOUT\_NOTIFICATION (0) + +ALLOWED\_WITH\_NOTIFICATION (1) + +ALLOWED\_IF\_NO\_RESPONSE (2) + +RESTRICTED\_IF\_NO\_RESPONSE (3) + +NOT\_ALLOWED (4) + +Default value if AVP is not present is: ALLOWED\_WITHOUT\_NOTIFICATION (0). + +### 7.4.15 Accuracy-Fulfilment-Indicator + +The Accuracy-Fulfilment-Indicator AVP is of type Enumerated. The following values are defined: + +REQUESTED\_ACCURACY\_FULFILLED (0) + +REQUESTED\_ACCURACY\_NOT\_FULFILLED (1) + +### 7.4.16 Age-Of-Location-Estimate + +The Age-Of-Location-Estimate AVP is of type Unsigned32. It indicates how long ago the location estimate was obtained in minutes, as indicated in 3GPP TS 29.002 [19]. + +### 7.4.17 Velocity-Estimate + +The Velocity-Estimate AVP is of type OctetString. It is composed of 4 or more octets with an internal structure according to 3GPP TS 23.032 [3]. + +### 7.4.18 EUTRAN-Positioning-Data + +The EUTRAN-Positioning-Data AVP is of type OctetString. It shall contain the encoded content of the "Positioning-Data" Information Element as defined in 3GPP TS 29.171 [7]. + +### 7.4.19 ECGI + +The ECGI AVP is of type OctetString. It indicates the E-UTRAN Cell Global Identifier. It is coded according to clause 8.21.5, in 3GPP TS 29.274 [8]. + +### 7.4.20 Location-Event + +The Location-Event AVP is of type Enumerated. The following values are defined: + +EMERGENCY\_CALL\_ORIGINATION (0) + +EMERGENCY\_CALL\_RELEASE (1) + +MO\_LR (2) + +EMERGENCY\_CALL\_HANDOVER (3) + +DEFERRED\_MT\_LR\_RESPONSE (4) + +DEFERRED\_MO\_LR\_TTTP\_INITIATION (5) + +DELAYED\_LOCATION\_REPORTING (6) + +DEFERRED\_MT\_LR\_RESPONSE is applicable to the delivery of an event report and/or a location estimate for an LDR initiated earlier by either the network (via an MT-LR activate deferred location) or the UE (via a periodic MO-LR TTTP initiation for a UE with UTRAN access). + +DELAYED\_LOCATION\_REPORTING is applicable to the delivery of a location estimate for an EPC-MT-LR or PS-MT-LR initiated earlier by the network for a UE which was transiently not reachable. + +### 7.4.21 Pseudonym-Indicator + +The Pseudonym-Indicator AVP is of type Enumerated. It defines if a pseudonym is requested. The following values are defined: + +PSEUDONYM\_NOT\_REQUESTED (0) + +PSEUDONYM\_REQUESTED (1) + +Default value if AVP is not present is: PSEUDONYM\_NOT\_REQUESTED (0). + +### 7.4.22 LCS-Service-Type-ID + +The LCS-Service-Type-ID is of type Unsigned32. It defines the identifier associated to one of the Service Types for which the LCS client is allowed to locate the particular UE. + +### 7.4.23 LCS-Privacy-Check-Non-Session + +The LCS-Privacy-Check-Non-Session AVP is of type Grouped. + +AVP format: + +LCS-Privacy-Check-Non-Session ::= + +{ LCS-Privacy-Check } + +Default value if AVP is not present is that AVP LCS-Privacy-Check take value: ALLOWED\_WITHOUT\_NOTIFICATION (0). + +### 7.4.24 LCS-Privacy-Check-Session + +The LCS-Privacy-Check-Session AVP is of type Grouped. + +AVP format: + +LCS-Privacy-Check-Session ::= + +{ LCS-Privacy-Check } + +Default value if AVP is not present is that AVP LCS-Privacy-Check take value: NOT\_ALLOWED (4). + +### 7.4.25 Feature-List-ID + +The syntax of this AVP is defined in 3GPP TS 29.229 [17]. For this release, the Feature-List-ID AVP value shall be set to 1. + +### 7.4.26 Feature-List + +The syntax of this AVP is defined in 3GPP TS 29.229 [17]. A null value indicates that there is no feature used by the application. + +NOTE: There are no features defined for this release. + +### 7.4.27 LCS-QoS-Class + +The LCS-QoS-Class AVP is of the type Enumerated. The following values are defined. + +ASSURED (0) + +BEST EFFORT (1) + +### 7.4.28 Serving-Node + +The Serving-Node AVP is of type Grouped. This AVP shall contain the information about the network node serving the targeted user. + +### 7.4.29 GERAN-Positioning-Info + +The GERAN-Positioning-Info AVP is of type Grouped. + +AVP format: + +``` +GERAN-Positioning-Info ::= + [ GERAN-Positioning-Data ] + [ GERAN-GANSS-Positioning-Data ] + *[ AVP ] +``` + +### 7.4.30 GERAN-Positioning-Data + +The GERAN-Positioning-Data AVP is of type OctetString. It shall contain the encoded content of the "Positioning Data" Information Element as defined in 3GPP TS 49.031 [20]. + +### 7.4.31 GERAN-GANSS-Positioning-Data + +The GERAN-GANSS-Positioning-Data AVP is of type OctetString. It shall contain the encoded content of the "GANSS Positioning Data" Information Element as defined in 3GPP TS 49.031 [20]. + +### 7.4.32 UTRAN-Positioning-Info + +The UTRAN-Positioning-Info AVP is of type Grouped. + +AVP format: + +``` +UTRAN-Positioning-Info ::= + [ UTRAN-Positioning-Data ] + [ UTRAN-GANSS-Positioning-Data ] + [ UTRAN-Additional-Positioning-Data ] + *[ AVP ] +``` + +### 7.4.33 UTRAN-Positioning-Data + +The UTRAN-Positioning-Data AVP is of type OctetString. It shall contain the encoded content of the "positioningDataDiscriminator" and the "positioningDataSet" included in the "positionData" Information Element as defined in 3GPP TS 25.413 [21]. + +### 7.4.34 UTRAN-GANSS-Positioning-Data + +The UTRAN-GANSS-Positioning-Data AVP is of type OctetString. It shall contain the encoded content of the "GANSS-PositioningDataSet" only, included in the "positionData" Information Element as defined in 3GPP TS 25.413 [21]. + +### 7.4.35 LRR-Flags + +The LRR-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 7.4.35/1: + +**Table 7.4.35/1: LRR-Flags** + +| Bit | Name | Description | +|-----|------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | Lgd/SLg-Indicator | This bit, when set, indicates that the Location Report Request message is sent on the Lgd interface, i.e. the source node is an SGSN (or a combined MME/SGSN to which the UE is attached via UTRAN or GERAN).
This bit, when cleared, indicates that the Location Report Request message is sent on the SLg interface, i.e. the source node is an MME (or a combined MME/SGSN to which the UE is attached via E-UTRAN). | +| 1 | MO-LR-ShortCircuit-Indicator | This bit, when set, indicates that the MO-LR short circuit feature is used by the UE for location estimate. This bit is applicable only when for deferred MT-LR procedure and when the message is sent over Lgd interface. | +| 2 | MO-LR-ShortCircuit-Requested | This bit, when set, indicates that the UE is requesting to use MO-LR short circuit feature for location estimate. This bit is applicable only when periodic MO-LR TTTP procedure is initiated by the UE and when the message is sent over Lgd interface. | + +NOTE1: Bits not defined in this table shall be cleared by the sending MME or SGSN and discarded by the receiving GMLC. + +### 7.4.36 Deferred-Location-Type + +The Deferred-Location-Type AVP is of type Unsigned32 and it shall contain a bit mask. Each bit indicates a type of event, until when the location estimation is deferred. For details, please refer to 3GPP TS 23.271 [3] clause 4.4.2. The meaning of the bits shall be as defined in table 7.4.36/1: + +**Table 7.4.36/1: Deferred-Location-Type** + +| Bit | Event Type | Description | +|-----|-----------------------------|---------------------------------------------------------------------------------------------------------------------------------| +| 0 | UE-Available | Any event in which the SGSN has established a contact with the UE. | +| 1 | Entering-Into-Area | An event where the UE enters a pre-defined geographical area. | +| 2 | Leaving-From-Area | An event where the UE leaves a pre-defined geographical area. | +| 3 | Being-Inside-Area | An event where the UE is currently within the pre-defined geographical area. | +| 4 | Periodic-LDR | An event where a defined periodic timer expires in the UE and activates a location report or a location request. | +| 5 | Motion-Event | An event where the UE moves by more than a minimum linear distance. This event is applicable to a deferred EPC-MT-LR only. | +| 6 | LDR-Activated | An event where deferred location reporting has been activated in the UE. This event is applicable to a deferred EPC-MT-LR only. | +| 7 | Maximum-Interval-Expiration | An event where the maximum reporting interval has expired. This event is applicable to a deferred EPC-MT-LR only. | + +### 7.4.37 LCS-Reference-Number + +The LCS-Reference-Number AVP is of type OctetString of length 1. It shall contain the reference number identifying the deferred location request. + +### 7.4.38 Area-Event-Info + +The Area-Event-Info AVP is of type Grouped. + +AVP format: + +``` +Area-Event-Info ::= + { Area-Definition } +``` + +[ Occurrence-Info ] +[ Interval-Time ] +[ Maximum-Interval ] +[ Sampling-Interval ] +[ Reporting-Duration ] +[ Reporting-Location-Requirements ] +\*[ AVP ] + +If not included, the default value of Occurrence-Info shall be considered as "ONE\_TIME\_EVENT" (0). Interval-Time and Maximum-Interval AVPs are only applicable when the Occurrence-Info is set to "MULTIPLE\_TIME\_EVENT" (1). If not included, the default value of Interval-Time shall be considered as one and the default values of Maximum-Interval, Sampling-Interval and Reporting-Duration shall each be considered as the maximum value. + +### 7.4.39 Area-Definition + +The Area-Definition AVP is of type Grouped. + +AVP format: + +Area-Definition ::= +1\*10{ Area } +\*240[ Additional-Area ] +\*[ AVP ] + +For a PS-MT-LR over the Lgd interface, the Additional-Area AVP shall not be included. + +### 7.4.40 Area + +The Area AVP is of type Grouped. + +AVP format: + +Area ::= +{ Area-Type } +{ Area-Identification } +\*[ AVP ] + +### 7.4.41 Area-Type + +The Area-Type AVP is of type Unsigned32. The following values are defined: + +"Country Code" 0 +"PLMN ID" 1 +"Location Area ID" 2 +"Routing Area ID" 3 +"Cell Global ID" 4 +"UTRAN Cell ID" 5 +"Tracking Area ID" 6 + +"E-UTRAN Cell Global ID" 7 + +### 7.4.42 Area-Identification + +The Area-Identification AVP is of type OctetString and shall contain the identification of the area applicable for the change of area event based deferred location reporting. For Area-Type 0 to 5, octets are coded as described in 3GPP TS 29.002 [24]. For Area-Type 6, octets are coded as defined for the Tracking Area Identity area identification in 3GPP TS 24.080 [24]. For Area-Type 7, octets are coded as defined for the ECGI area identification in 3GPP TS 24.080 [24]. For a deferred EPC-MT-LR for the area event, only Area-Type 6 and 7 are applicable. + +### 7.4.43 Occurrence-Info + +The Occurrence-Info AVP is of type Enumerated. The following values are defined: + +ONE\_TIME\_EVENT (0) + +MULTIPLE\_TIME\_EVENT (1) + +### 7.4.44 Interval-Time + +The Interval-Time AVP is of type Unsigned32 and it contains the minimum time interval between area reports or motion reports, in seconds. The minimum value shall be 1 second and the maximum value 32767 seconds. + +### 7.4.45 Periodic-LDR-Info + +The Periodic-LDR-Info AVP is of type Grouped. + +AVP format: + +Periodic-LDR-Info ::= + +{ Reporting-Amount } + +{ Reporting-Interval } + +\*[ AVP ] + +Reporting-Interval x Reporting-Amount shall not exceed 8639999 (99 days, 23 hours, 59 minutes and 59 seconds) for compatibility with OMA MLP and RLP. + +### 7.4.46 Reporting-Amount + +The Reporting-Amount AVP is of type Unsigned32 and it contains reporting frequency. Its minimum value shall be 1 and maximum value shall be 8639999. + +### 7.4.47 Reporting-Interval + +The Interval-Time AVP is of type Unsigned32 and it contains reporting interval in seconds. Its minimum value shall be 1 and maximum value shall be 8639999. + +### 7.4.48 Reporting-PLMN-List + +The Reporting-PLMN-List AVP is of type Grouped. + +AVP format: + +Reporting-PLMN-List ::= + +1\*20{ PLMN-ID-List } + +[ Prioritized-List-Indicator ] + +\*[ AVP ] + +If not included, the default value of Prioritized-List-Indicator shall be considered as "NOT\_PRIORITIZED" (0). + +### 7.4.49 PLMN-ID-List + +The PLMN-ID-List AVP is of type Grouped. + +AVP format: + +``` +PLMN-ID-List ::= + { Visited-PLMN-Id } + [ Periodic-Location-Support-Indicator ] + *[ AVP ] +``` + +If not included, the default value of Periodic-Location-Support-Indicator shall be considered as "NOT\_SUPPORTED" (0). + +### 7.4.50 Periodic-Location-Support-Indicator + +The Periodic-Location-Support-Indicator AVP is of type Enumerated and it indicates if the given PLMN-ID (indicated by Visited-PLMN-Id) supports periodic location or not. The following values are defined: + +NOT\_SUPPORTED (0) + +SUPPORTED (1) + +### 7.4.51 Prioritized-List-Indicator + +The Prioritized-List-Indicator AVP is of type Enumerated and it indicates if the PLMN-ID-List is provided in prioritized order or not. The following values are defined: + +NOT\_PRIORITIZED (0) + +PRIORITIZED (1) + +### 7.4.52 PLR-Flags + +The PLR-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 7.4.52/1: + +**Table 7.4.52/1: PLR-Flags** + +| Bit | Name | Description | +|-----|----------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | MO-LR-ShortCircuit-Indicator | This bit, when set, indicates that the MO-LR short circuit feature is requested for the periodic location. This bit is applicable only when the deferred MT-LR procedure is initiated for a periodic location event and when the message is sent over Lgd interface. | +| 1 | Optimized-LCS-Proc-Req | This bit, when set, indicates that the GMLC is requesting the optimized LCS procedure for the combined MME/SGSN. This bit is applicable only when the MT-LR procedure is initiated by the GMLC over the Lgd interface. The GMLC shall set this bit only when the HSS indicates the combined MME/SGSN node supporting the optimized LCS procedure. | +| 2 | Delayed-Location-Reporting-Support-Indicator | This bit, when set, indicates that the GMLC supports delayed location reporting for UEs transiently not reachable (e.g. UEs in extended idle mode DRX or Power Saving Mode) as specified in clauses 9.1.6 and 9.1.15 of 3GPP TS 23.271 [2], i.e. that the GMLC supports
- receiving a PROVIDE SUBSCRIBER LOCATION RESPONSE with the UE-Transiently-Not-Reachable-Indicator set in the PLA-Flags IE; and
- receiving the location information in a subsequent SUBSCRIBER LOCATION REPORT when the UE becomes reachable. | + +NOTE1: Bits not defined in this table shall be cleared by the sending GMLC and discarded by the receiving MME or SGSN. + +### 7.4.53 PLA-Flags + +The PLA-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 7.4.53/1: + +**Table 7.4.53/1: PLA-Flags** + +| Bit | Name | Description | +|-----|----------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | Deferred-MT-LR-Response-Indicator | This bit, when set, indicates that the message is sent in response to the deferred-MT location request. | +| 1 | MO-LR-ShortCircuit-Indicator | This bit, when set, indicates that the MO-LR short circuit feature is accepted by the UE, for periodic location reporting. This bit is applicable only when the message is sent over Lgd interface. | +| 2 | Optimized-LCS-Proc-Performed | This bit, when set, indicates that the combined MME/SGSN has performed the optimized LCS procedure to retrieve the location of the target UE. This bit is applicable only when the message is sent for the MT-LR procedure over the Lgd interface. | +| 3 | UE-Transiently-Not-Reachable-Indicator | This bit, when set, indicates that the UE is transiently not reachable due to power saving (e.g. UE is in extended idle mode DRX or in Power Saving Mode), and that the location information will be returned in a subsequent Subscriber Location Report when the UE becomes reachable. | + +NOTE1: Bits not defined in this table shall be cleared by the sending MME or SGSN and discarded by the receiving GMLC. + +### 7.4.54 Deferred-MT-LR-Data + +The Deferred-MT-LR-Data AVP is of type Grouped. + +AVP format: + +``` +Deferred-MT-LR-Data ::= + { Deferred-Location-Type } + [ Termination-Cause ] +``` + +[ Serving-Node ] + +\*[ AVP ] + +Serving-Node may be included only when the Termination-Cause is present indicating MT\_LR\_RESTART. + +The Serving-Node refers to the node where the UE has moved to and shall be included, if available. + +### 7.4.55 Termination-Cause + +The Termination-Cause AVP is of type Unsigned32. The following values are defined: + +| | | +|--------------------------------------------|---| +| "Normal" | 0 | +| "Error Undefined" | 1 | +| "Internal Timeout" | 2 | +| "Congestion" | 3 | +| "MT_LR_Restart" | 4 | +| "Privacy Violation" | 5 | +| "Shape of Location Estimate Not Supported" | 6 | +| "Subscriber Termination" | 7 | +| "UE Termination" | 8 | +| "Network Termination" | 9 | + +"MT\_LR\_Restart" cause code shall be used to trigger the GMLC to restart the location procedure, either because the sending node knows that the terminal has moved under coverage of another SGSN or MME, or because the subscriber has been deregistered due to a Cancel Location received from HSS. + +Any unrecognized value of Termination-Cause shall be treated the same as value 1 ("Error Undefined"). + +### 7.4.56 LRA-Flags + +The LRA-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 7.4.56/1: + +**Table 7.4.56/1: LRA-Flags** + +| Bit | Name | Description | +|------------------------------------------------------------------------------------------------------------------------|------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | MO-LR-ShortCircuit-Indicator | This bit, when set, indicates that the MO-LR short circuit feature is used for obtaining location estimate. This bit is applicable only when the message is sent over Lgd interface. | +| NOTE1: Bits not defined in this table shall be cleared by the sending GMLC and discarded by the receiving MME or SGSN. | | | + +### 7.4.57 ESMLC-Cell-Info + +The ESMLC-Cell-Info AVP is of type Grouped. + +AVP format: + +ESMLC-Cell-Info ::= + +[ ECGI ] + +[ Cell-Portion-ID ] + +\*[ AVP ] + +### 7.4.58 Cell-Portion-ID + +The Cell-Portion-ID AVP is of type Unsigned32. It indicates the current Cell Portion location of the target UE as provided by the E-SMLC. It shall contain the value of the "Cell Portion ID" Information Element as defined in 3GPP TS 29.171 [7]. + +### 7.4.59 1xRTT-RCID + +The 1xRTT-RCID AVP is of type OctetString. It indicates the 1xRTT Reference Cell Id that consists of a Cell Identification Discriminator and a Cell Identification and shall be formatted according to octets 3 through the end of the Cell Identifier element defined in clause 4.2.17 in 3GPP2 A.S0014-D [22]. The allowable cell discriminator values are "0000 0010", and "0000 0111". + +### 7.4.60 Delayed-Location-Reporting-Data + +The Delayed-Location-Reporting-Data AVP is of type Grouped. + +AVP format: + +``` +Delayed-Location-Reporting-Data ::= + [ Termination-Cause ] + [ Serving-Node ] + *[ AVP ] +``` + +Serving-Node may be included only when the Termination-Cause is present indicating MT\_LR\_RESTART. + +The Serving-Node refers to the node where the UE has moved to and shall be included, if available. + +### 7.4.61 Civic-Address + +The Civic-Address AVP is of type UTF8String. It contains the XML document carried in the "Civic Address" Information Element as defined in 3GPP TS 29.171 [7]. + +### 7.4.62 Barometric-Pressure + +The Barometric-Pressure AVP is of type Unsigned32. It contains the "Barometric Pressure" Information Element as defined in 3GPP TS 29.171 [7]. + +### 7.4.63 UTRAN-Additional-Positioning-Data + +The UTRAN-Additional-Positioning-Data AVP is of type OctetString. It contains the "UTRAN Additional Positioning Data" Information Element as defined in 3GPP 25.413 [21]. + +### 7.4.64 Motion-Event-Info + +The Motion-Event-Info AVP is of type Grouped. + +AVP format: + +``` +Motion-Event-Info ::= + { Linear-Distance } + [ Occurrence-Info ] + [ Interval-Time ] + [ Maximum-Interval ] +``` + +[ Sampling-Interval ] + +[ Reporting-Duration ] + +[ Reporting-Location-Requirements ] + +\*[ AVP ] + +If not included, the default value of Occurrence-Info shall be considered as "ONE\_TIME\_EVENT" (0). Interval-Time and Maximum-Interval AVPs are only applicable when the Occurrence-Info is set to "MULTIPLE\_TIME\_EVENT" (1). If not included, the default value of Interval-Time shall be considered as one and the default values of Maximum-Interval, Sampling-Interval and Reporting-Duration shall each be considered as the maximum value. The Motion-Event-Info AVP is only applicable to a deferred EPC-MT-LR. + +### 7.4.65 Linear-Distance + +The Linear-Distance AVP is of type Unsigned32 and it contains the minimum linear (straight line) distance for motion event reports, in meters. The minimum value shall be 1 and maximum value shall be 10,000. The Linear-Distance AVP is only applicable to a deferred EPC-MT-LR. + +### 7.4.66 Maximum-Interval + +The Maximum-Interval AVP is of type Unsigned32 and it contains the maximum time interval between consecutive event reports, in seconds. The minimum value shall be 1 second and the maximum value 86400 seconds. The Maximum-Interval AVP is only applicable to a deferred EPC-MT-LR. + +### 7.4.67 Sampling-Interval + +The Sampling-Interval AVP is of type Unsigned32 and it contains the maximum time interval between consecutive evaluations by a UE of an area event or motion event, in seconds. The minimum value shall be 1 second and the maximum value 3600 seconds. The Sampling-Interval AVP is only applicable to a deferred EPC-MT-LR. + +### 7.4.68 Reporting-Duration + +The Reporting-Duration AVP is of type Unsigned32 and it contains the maximum duration of event reporting, in seconds. Its minimum value shall be 1 and maximum value shall be 8640000. The Reporting-Duration AVP is only applicable to a deferred EPC-MT-LR. + +### 7.4.69 Reporting-Location-Requirements + +The Reporting-Location-Requirements AVP is of type Unsigned32 and it shall contain a bit string indicating requirements on location provision for a deferred EPC-MT-LR. When a bit is set to one, the corresponding requirement is present. When a bit is set to zero or when the AVP is omitted, the corresponding requirement is not present. For support of backward compatibility, a receiver shall ignore any bits that are set to one but are not supported + +The meaning of the bits shall be as defined in table 7.4.69/1: + +**Table 7.4.69/1: Reporting-Location-Requirements** + +| Bit | Requirement | Description | +|------|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | Location-Estimate | A location estimate is required for each area event, motion event report or expiration of the maximum time interval between event reports. | +| 1-31 | None | Spare | + +### 7.4.70 Additional-Area + +The Additional-Area AVP is of type Grouped. + +AVP format: + +Additional-Area ::= + +{ Area-Type } + +{ Area-Identification } + +\*[ AVP ] + +## 7.5 Result-Code AVP and Experimental-Result AVP Values + +### 7.5.1 General + +This clause defines result code values that shall be supported by all Diameter implementations that conform to this specification. + +### 7.5.2 Success + +Result codes that fall within the Success category shall be used to inform a peer that a request has been successfully completed. The Result-Code AVP values defined in the Diameter base protocol specified in IETF RFC 6733 [23] shall be applied. + +### 7.5.3 Permanent Failures + +Errors that fall within the Permanent Failures category shall be used to inform the peer that the request has failed, and should not be attempted again. The Result-Code AVP values defined in the Diameter base protocol specified in IETF RFC 6733 [23] shall be applied. When one of the result codes defined here is included in a response, it shall be inside an Experimental-Result AVP and the Result-Code AVP shall be absent. + +#### 7.5.3.1 DIAMETER\_ERROR\_USER\_UNKNOWN (5001) + +This result code shall be sent by the MME/SGSN to indicate that the user is unknown. This error code is defined in 3GPP TS 29.229 [17] + +#### 7.5.3.2 DIAMETER\_ERROR\_UNAUTHORIZED\_REQUESTING\_NETWORK (5490) + +This result code shall be sent by the MME/SGSN to indicate that the requesting GMLC's network is not authorized to request UE location information. This error code is defined in 3GPP TS 29.173 [18] + +### 7.5.4 Transient Failures + +Errors that fall within the transient failures category are those used to inform a peer that the request could not be satisfied at the time that it was received. The request may be able to be satisfied in the future. + +#### 7.5.4.1 DIAMETER\_ERROR\_UNREACHABLE\_USER (4221) + +This result code shall be sent by the MME/SGSN to indicate that the user could not be reached in order to perform positioning procedure. + +#### 7.5.4.2 DIAMETER\_ERROR\_SUSPENDED\_USER (4222) + +This result code shall be sent by the MME/SGSN to indicate that the user is suspended in the MME. + +#### 7.5.4.3 DIAMETER\_ERROR\_DETACHED\_USER (4223) + +This result code shall be sent by the MME/SGSN to indicate that the user is detached in the MME. + +#### 7.5.4.4 DIAMETER\_ERROR\_POSITIONING\_DENIED (4224) + +This result code shall be sent by the MME/SGSN to indicate that the positioning procedure was denied. + +#### 7.5.4.5 DIAMETER\_ERROR\_POSITIONING\_FAILED (4225) + +This result code shall be sent by the MME/SGSN to indicate that the positioning procedure failed. + +#### 7.5.4.6 DIAMETER\_ERROR\_UNKNOWN\_UNREACHABLE LCS\_CLIENT (4226) + +This result code shall be sent by the GMLC to indicate that the LCS Client was not known or could not be reached. + +# Annex A (informative): Change history + +| Date | TSG # | TSG Doc. | CR | Rev | Cat | Subject/Comment | New | +|---------|--------|-----------|------|-----|-----|----------------------------------------------------------------------------------------|--------| +| 2010-03 | CT-47 | CP-100055 | | | | 3GPP TS presented for approval in CT#47 | 9.0.0 | +| 2010-06 | CT-48 | CP-100286 | 0001 | | | Velocity-Requested IE | 9.1.0 | +| 2010-09 | CT-49 | CP-100463 | 0002 | 1 | | Addition of Command Codes | 9.2.0 | +| | | | 0003 | 1 | | Notification Verification Only in Location Type | | +| | | | 0004 | 1 | | SLg for Inter Domain Scenarios | | +| | | | 0005 | | | Editorial Updates | | +| | | | 0007 | | | Definition of EUTRAN-Positioning-Data | | +| 2010-12 | CT-50 | CP-100681 | 0009 | | | Clarification of LCS-priority AVP | 9.3.0 | +| | | | 0010 | | | Correction of error code assignment | | +| | | | 0011 | | | Correction of bit numbering in Horizontal and Vertical Accuracy IEs in SLg | | +| | | | 0012 | | | Units of Age of Location Estimate IE in SLg | | +| 2011-03 | CT-51 | CP-110054 | 0013 | 1 | | Add missing Vendor Specific Application Id | 9.4.0 | +| | | | 0014 | 2 | | Essential correction on the value type of the ELP Application AVPs | | +| 2011-03 | | | | | | Update to Rel-10 version (MCC) | 10.0.0 | +| 2011-09 | CT-53 | CP-110565 | 0015 | 2 | | Correction to references | 10.1.0 | +| 2012-09 | CT-57 | | | | | Update to Rel-11 version (MCC) | 11.0.0 | +| 2013-03 | CT-59 | CP-130156 | 0016 | 1 | | Definition of Lgd interface between SGSN and GMLC (Clause 1, 3, 4, 5) | 12.0.0 | +| | | | 0017 | 1 | | Definition of Lgd interface between SGSN and GMLC (Clause 2, 6, 7) | | +| 2013-06 | CT-60 | CP-130291 | 0018 | 2 | | Support of deferred MT-LR and periodic MO-LR TTTP procedures over Lgd interface | 12.1.0 | +| 2013-09 | CT-61 | CP-130458 | 0019 | 1 | | Addressing the editor's note of the Location-Event AVP | 12.2.0 | +| 2013-12 | CT-62 | CP-130631 | 0024 | 1 | | Adding E-SMLC provided Cell info and Cell Portion | 12.3.0 | +| | | CP-130624 | 0023 | 3 | | Optimized LCS procedure between GMLC and combined MME/SGSN | | +| 2014-03 | CT-63 | CP-140032 | 0025 | 2 | | E-SMLC provided Cell info and Cell Portion | 12.4.0 | +| 2015-03 | CT-67 | CP-150015 | 0031 | - | | Renaming of Location-Type AVP | 12.5.0 | +| | | CP-150018 | 0027 | 1 | | Location reporting in emergency 1xSRVCC | | +| 2015-12 | CT-70 | CP-150776 | 0032 | 1 | | EPC-MT-LR and PS-MT-LR procedure for UEs transiently not reachable due to power saving | 13.0.0 | +| | | | 0034 | 2 | | Indoor Positioning support in SLg/Lgd | | +| 2016-06 | CT-72 | CP-160226 | 0035 | 1 | | Delayed Location Reporting Data in Subscriber Location Report | 13.1.0 | +| 2017-03 | CT#75 | CP-170036 | 0037 | 1 | | Bit ordering in Diameter AVPs used as bit-masks | 14.0.0 | +| 2017-03 | CT#75 | CP-170048 | 0038 | - | | Update of reference for the Diameter base protocol | 14.0.0 | +| 2017-03 | CT#75 | CP-170048 | 0039 | - | | Handling of the Vendor-Specific-Application-Id AVP | 14.0.0 | +| 2017-03 | CT#75 | CP-170048 | 0040 | 1 | | Cardinality of the Failed-AVP AVP in answer | 14.0.0 | +| 2017-06 | CT#76 | CP-171030 | 0036 | 3 | | Enhancements to Location Services for C IoT | 14.1.0 | +| 2018-03 | CT#79 | CP-180016 | 0041 | 1 | | Deferred location for the UE availability event with EPC Access | 14.2.0 | +| 2018-06 | CT#80 | - | - | - | | Update to Rel-15 version (MCC) | 15.0.0 | +| 2019-09 | CT#85 | CP-192095 | 0042 | 1 | | Addition of High Accuracy location estimates | 15.1.0 | +| 2019-12 | CT#86 | CP-193018 | 0046 | - | | Missing AVPs in Provide-Location-Request Command | 15.2.0 | +| 2019-12 | CT#86 | CP-193022 | 0048 | - | | Motion-Event-Info AVP | 15.2.0 | +| 2020-07 | CT#88e | - | - | - | | Update to Rel-16 version (MCC) | 16.0.0 | +| 2022-03 | CT#95e | CP-220085 | 0049 | 1 | F | High Accuracy GAD Shape with Scalable Uncertainty | 16.1.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29173/d0abac95583b52a3b35f74a215567334_img.jpg b/marked/Rel-16/29_series/29173/d0abac95583b52a3b35f74a215567334_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9bb052f06a2f560f34c4bc0cf289f27ae6657bd1 --- /dev/null +++ b/marked/Rel-16/29_series/29173/d0abac95583b52a3b35f74a215567334_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9211ccffd58a6464fc449d97016ecbd478242f69b9392ee4218971dc00b65a8d +size 54885 diff --git a/marked/Rel-16/29_series/29173/raw.md b/marked/Rel-16/29_series/29173/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..1133ddca63ad9c2a5c049bbbb5f1449383612405 --- /dev/null +++ b/marked/Rel-16/29_series/29173/raw.md @@ -0,0 +1,626 @@ + + + + +Error! No +text of + +Error! No text of specified style in +document. + +# Contents + +| | | +|---------------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions, symbols and abbreviations..... | 7 | +| 3.1 Definitions..... | 7 | +| 3.2 Abbreviations ..... | 7 | +| 4 General Description ..... | 7 | +| 4.1 Introduction ..... | 7 | +| 4.2 Architecture Overview ..... | 7 | +| 4.3 Functional Requirements of SLh Interface ..... | 8 | +| 5 Diameter-based SLh Interface ..... | 8 | +| 5.1 Introduction ..... | 8 | +| 5.2 Procedure Descriptions ..... | 8 | +| 5.2.1 Send Routing Information for LCS ..... | 8 | +| 5.2.1.1 General..... | 8 | +| 5.2.1.2 Detailed Behaviour of the HSS..... | 10 | +| 5.2.1.3 Detailed Behaviour of the GLMC ..... | 10 | +| 6 Protocol Specification and Implementations ..... | 11 | +| 6.1 Introduction ..... | 11 | +| 6.1.1 Use of Diameter Base Protocol ..... | 11 | +| 6.1.2 Securing Diameter Messages ..... | 11 | +| 6.1.3 Accounting Functionality ..... | 11 | +| 6.1.4 Use of Sessions..... | 11 | +| 6.1.5 Transport Protocol ..... | 11 | +| 6.1.6 Routing Considerations ..... | 11 | +| 6.1.7 Advertising Application Support..... | 11 | +| 6.1.8 Diameter Application Identifier..... | 12 | +| 6.1.9 User Identity to HSS resolution..... | 12 | +| 6.2 Commands..... | 12 | +| 6.2.1 Introduction ..... | 12 | +| 6.2.2 Command-Code values ..... | 12 | +| 6.2.3 LCS-Routing-Info-Request (RIR) Command ..... | 13 | +| 6.2.4 LCS-Routing-Info-Answer (RIA) Command..... | 13 | +| 6.3 Result-Code AVP and Experimental-Result AVP Values..... | 14 | +| 6.3.1 General ..... | 14 | +| 6.3.2 Success ..... | 14 | +| 6.3.3 Permanent Failures ..... | 14 | +| 6.3.3.1 DIAMETER_ERROR_USER_UNKNOWN (5001) ..... | 14 | +| 6.3.3.2 DIAMETER_ERROR_UNAUTHORIZED_REQUESTING_NETWORK (5490) ..... | 15 | +| 6.3.4 Transient Failures ..... | 15 | +| 6.3.4.1 DIAMETER_ERROR_ABSENT_USER (4201) ..... | 15 | +| 6.4 AVPs ..... | 15 | +| 6.4.1 General ..... | 15 | +| 6.4.2 LMSI..... | 16 | +| 6.4.3 Serving-Node..... | 16 | +| 6.4.4 MME-Name..... | 16 | +| 6.4.5 MSC-Number ..... | 16 | +| 6.4.6 LCS-Capabilities-Sets ..... | 17 | +| 6.4.7 GMLC-Address ..... | 17 | +| 6.4.8 Additional-Serving-Node ..... | 17 | +| 6.4.9 PPR-Address..... | 17 | +| 6.4.10 Feature-List-ID AVP..... | 17 | +| 6.4.11 Feature-List AVP..... | 17 | +| 6.4.12 MME-Realm..... | 18 | +| 6.4.13 SGSN-Name ..... | 18 | + +6.4.14 SGSN-Realm ................................................................................................................................................. 18 + +Annex A (informative): Change history................................................................................................................ 19 + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 1 Scope + +The present document describes the Diameter-based SLh interface between the GMLC and the HSS defined for the Control Plane LCS in EPC. + +LCS procedures over the SLh interface are defined in the 3GPP TS 23.271 [2]. + +This specification defines the Diameter application for the GMLC-HSS, SLh reference point. The interactions between the HSS and the GMLC are specified, including the signalling flows. As LCS procedures over the Diameter-based SLh interface are identical to the MAP-based Lh interface, the descriptions of the Lh MAP operations defined in the 3GPP TS 29.002 [3] are mapped into the descriptions of the SLh Diameter commands. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.271: "Functional stage 2 description of Location Services (LCS)". +- [3] 3GPP TS 29.002: "Mobile Application Part (MAP) specification". +- [4] 3GPP TS 29.228: "IP multimedia (IM) Subsystem Cx Interface; Signalling flows and Message Elements". +- [5] Void. +- [6] 3GPP TS 33.210: "3G security; Network Domain Security (NDS); IP network layer security". +- [7] IETF RFC 4960: "Stream Control Transport Protocol". +- [8] 3GPP TS 29.229: "Cx and Dx Interfaces based on the Diameter protocol; protocol details". +- [9] 3GPP TS 29.329: "Sh Interface based on the Diameter protocol; protocol details". +- [10] 3GPP TS 23.003: "Numbering, addressing and identification ". +- [11] 3GPP TS 23.012: "Location Management Procedures". +- [12] 3GPP TS 29.272: "Mobility Management Entity (MME) and Serving GPRS Support Node (SGSN) related interfaces based on Diameter protocol". +- [13] IETF RFC 2234: "Augmented BNF for syntax specifications". +- [14] Void +- [15] ITU-T Recommendation E.164: "The international public telecommunication numbering plan". +- [16] 3GPP TS 29.273: "Evolved Packet System (EPS); 3GPP EPS AAA interfaces". +- [17] IETF RFC 6733: "Diameter Base Protocol". + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1], 3GPP TS 23.271 [2] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in TR 21.905 [1]. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|--------|-------------------------------------------| +| ABNF | Augmented Backus-Naur form | +| AVP | Attribute Value Pair | +| H-GMLC | Home-Gateway Mobile Location Centre | +| IANA | Internet Assigned Numbers Authority | +| PMD | Pseudonym mediation device functionality | +| PPR | Privacy Profile Register | +| R-GMLC | Requesting-Gateway Mobile Location Centre | +| RFC | Request For Comments | +| V-GMLC | Visited-Gateway Mobile Location Centre | + +# --- 4 General Description + +## 4.1 Introduction + +The SLh reference point between the GMLC and the HSS is defined in the 3GPP TS 23.271 [2]. + +This document describes the Diameter-based SLh interface related procedures, message parameters and protocol specifications. + +## 4.2 Architecture Overview + +The architecture for support of Location Services in GSM, UMTS and EPS has been defined in 3GPP TS 23.271 [2] and the relevant network elements and interfaces are shown in the figure 4.2-1. + +![Figure 4.2-1: Overview of the LCS Functional Architecture. The diagram shows a central GMLC connected to an HSS via the SLh interface. The GMLC is also connected to seven other entities via various interfaces: External LCS Client (Le), MME (SLg), SGSN (Lg), MSC/MSC Server (Lg), PPR (Lpp), PMD (Lid), and AAA Server (La).](d0abac95583b52a3b35f74a215567334_img.jpg) + +``` + +graph TD + HSS[HSS] -- SLh --> GMLC[GMLC] + GMLC -- Le --> ELCS[External LCS Client] + GMLC -- SLg --> MME[MME] + GMLC -- Lg --> SGSN[SGSN] + GMLC -- Lg --> MSC[MSC/MSC Server] + GMLC -- Lpp --> PPR[PPR] + GMLC -- Lid --> PMD[PMD] + GMLC -- La --> AAA[AAA Server] + +``` + +Figure 4.2-1: Overview of the LCS Functional Architecture. The diagram shows a central GMLC connected to an HSS via the SLh interface. The GMLC is also connected to seven other entities via various interfaces: External LCS Client (Le), MME (SLg), SGSN (Lg), MSC/MSC Server (Lg), PPR (Lpp), PMD (Lid), and AAA Server (La). + +**Figure 4.2-1: Overview of the LCS Functional Architecture** + +In this architecture, the SLh interface is defined between the Gateway Mobile Location Center (GMLC) and the Home Subscriber Server (HSS) to allow the GMLC to request routing information from the HLR or HSS. + +## 4.3 Functional Requirements of SLh Interface + +The requirements for SLh interface are defined in 3GPP TS 23.271 [2]. + +The SLh interface is used by the GMLC to request routing information from the HSS i.e. the address of the H-GMLC, and/or the address of the visited MSC/MSC server, SGSN, 3GPP AAA server or MME for a particular target UE whose location has been requested. + +# 5 Diameter-based SLh Interface + +## 5.1 Introduction + +This section describes the Diameter-based SLh interface related procedures and Information elements exchanged between functional entities. + +In the tables that describe the Information Elements transported by each Diameter command, each Information Element is marked as (M) Mandatory, (C) Conditional or (O) Optional in the "Cat." column. For the correct handling of the Information Element according to the category type, see the description detailed in section 6 of the 3GPP TS 29.228 [4]. + +## 5.2 Procedure Descriptions + +### 5.2.1 Send Routing Information for LCS + +#### 5.2.1.1 General + +This procedure is used between the GMLC and the HSS. The procedure is invoked by the GMLC and is used: + +- To retrieve routing information for LCS for a specified user from the HSS. + +This procedure is mapped to the commands LCS-Routing-Info-Request/Answer in the Diameter application specified in chapter 6. Tables 5.2.1.1/1 and 5.2.1.1/2 detail the involved information elements. + +**Table 5.2.1.1/1: Send Routing Information for LCS (SLh-LCS-SRI)** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|---------------------------------------------|-------------------------|------|-------------------------------------------------------------------------------------------------------------------------| +| IMSI | User-Name | C | This information element shall contain the IMSI of the targeted user. This IE shall be present if the MSISDN is absent. | +| MSISDN | MSISDN | C | This information element shall contain the MSISDN of the targeted user. This IE shall be present if the IMSI is absent. | +| GMLC Number | GMLC-Number | O | This information element shall contain the ISDN (E.164) number of the requesting GMLC. | +| Supported Features (See 3GPP TS 29.229 [8]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | + +**Table 5.2.1.1/2: Send Routing Information for LCS (SLh-LCS-SRI) Resp** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|---------------------------------------------|-----------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result (See 5.3.5) | Result-Code / Experimental-Result | M | Result of the request.
Result-Code AVP shall be used for errors defined in the Diameter base protocol (see IETF RFC 6733 [17]).
Experimental-Result AVP shall be used for SLh errors. This is a grouped AVP which contains the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | +| IMSI | User-Name | C | This information element shall contain the IMSI of the targeted user. This IE shall be present if Result-Code is DIAMETER_SUCCESS and the MSISDN is absent. | +| MSISDN | MSISDN | C | This information element shall contain the MSISDN of the targeted user. This IE shall be present if Result-Code is DIAMETER_SUCCESS and the IMSI is absent. | +| LMSI | LMSI | C | This information element shall contain the LMSI allocated by the VLR. This IE should be present if Result-Code is DIAMETER_SUCCESS and LMSI is available in the HSS and MSC-Number is included in the Serving-Node AVP or in an Additional-Serving-Node AVP. | +| Serving Node | Serving-Node | C | This information element shall contain the information about the network node serving the targeted user i.e. the name/number of the serving node (MME, SGSN, 3GPP AAA server or MSC/MSC server), the LCS capabilities sets supported by the serving node and the IP address of the visited GMLC associated with the serving node. This IE shall be present if the Result-Code is DIAMETER_SUCCESS; otherwise it shall be absent. | +| Additional Serving Node | Additional-Serving-Node | C | This information element shall contain the information about another network node serving the targeted user. This IE may be present if Result-Code is DIAMETER_SUCCESS; otherwise it shall be absent. There may be multiple instances of this IE in the response provided by the HSS. | +| Home GMLC Address | GMLC-Address | C | This information element shall contain the IP address of the H-GMLC. This IE should be present if the Result-Code is DIAMETER_SUCCESS; otherwise it shall be absent. | +| PPR Address | PPR-Address | C | This information element shall contain the IP address of the Privacy Profile Register (PPR). This IE should be present if available in the HSS and the Result-Code is DIAMETER_SUCCESS; otherwise it shall be absent. | +| RIA Flags | RIA-Flags | O | This Information Element contains a bit mask. See 6.4.15 for the meaning of the bits. | +| Supported Features (See 3GPP TS 29.229 [8]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | + +#### 5.2.1.2 Detailed Behaviour of the HSS + +Upon reception of the Send Routing Info for LCS request, the HSS shall, in the following order: + +1. Check whether the requesting GMLC belongs to a network authorized to request UE location information. If not, Experimental-Result shall be set to DIAMETER\_ERROR\_UNAUTHORIZED\_REQUESTING\_NETWORK in the Send Routing Information for LCS Response. +2. Check that the User Identity for whom data is asked exists in HSS. If not, Experimental-Result shall be set to DIAMETER\_ERROR\_USER\_UNKNOWN in the Send Routing Information for LCS Response. +- 2a. If both IMSI and MSISDN are present in the request, check whether they identify the same User. If not, the HSS Result-Code shall be set to DIAMETER\_CONTRADICTING\_AVPS in the Send Routing Information for LCS Response. +3. Check that there is at least one serving node associated with the targeted user. If not, Experimental-Result shall be set to DIAMETER\_ERROR\_ABSENT\_USER in the Send Routing Information for LCS Response. + +If there is an error in any of the above steps then the HSS shall stop processing and shall return the error code specified in the respective step (see 3GPP TS 29.329 [9] and 3GPP TS 29.229 [8] for an explanation of the error codes). + +If the HSS cannot fulfil the received request for reasons not stated in the above steps, e.g. due to a database error or empty mandatory data elements, it shall stop processing the request and set Result-Code to DIAMETER\_UNABLE\_TO\_COMPLY. + +Otherwise, the requested operation shall take place and the HSS shall return the Result-Code AVP set to DIAMETER\_SUCCESS. The HSS returns one or several of the network addresses of the current MME, SGSN, 3GPP AAA server and/or VMSC/MSC server, the LCS capabilities of the serving nodes if available, the V-GMLC address associated with the serving nodes, if available, and whichever of the IMSI and MSISDN that was not provided in the Send Routing Info for LCS request. If MSISDN was not provided in the Send Routing Info for LCS request and the subscription is MSISDN-less, the HSS shall return the dummy MSISDN value (see 3GPP TS 23.003 [10]). If both MSISDN and IMSI were provided in the Send Routing Info for LCS request, the HSS returns either MSISDN or IMSI or both. The HSS returns the address of the H-GMLC. The HSS also provides the address of the PPR, if available. + +The HSS shall include the Diameter Identity of the SGSN (i.e. SGSN-Name and SGSN-Realm), within the Serving-Node AVP or within an Additional-Serving-Node AVP, if and only if the HSS has received an indication that the Lgd interface is supported by the SGSN (see 3GPP TS 29.272 [12]). + +The HSS shall include the SGSN Number, within the Serving-Node AVP or Additional Serving-Node AVP, except if the HSS has received an indication that the Lg interface is not supported by the SGSN (see 3GPP TS 29.272 [12]). + +If the UE is served by the MME and SGSN parts of the same combined MME/SGSN (see 3GPP TS 29.272 [12] subclause 5.2.2.1.1 for how the HSS determines if the UE is served by the combined MME/SGSN) and if this combined MME/SGSN has indicated the support for optimized LCS procedure (via the Supported-Feature AVP as defined in 3GPP TS 29.272 [12] subclause 7.3.10) and if HSS supports this optimized LCS procedure, then the HSS shall set the "Combined-MME/SGSN-Supporting-Optimized-LCS-Proc" bit of the RIA-Flags. + +Regarding the LCS capabilities of the serving nodes, if the HSS registered an SGSN via the S6d reference point (i.e., the registered serving node is an S4-SGSN), the HSS shall set the LCS-Capabilities-Set value to indicate support of Capability Set 5 (i.e., LCS release 7 or later version). If the HSS registered an MME, the HSS shall not indicate any LCS capability value to the GMLC (i.e., the LCS-Capabilities-Set AVP shall be absent over SLh when the serving node is an MME); in this case, the GMLC shall assume that the MME supports LCS Capability Set 5. + +#### 5.2.1.3 Detailed Behaviour of the GLMC + +If there are a serving node as well as additional serving nodes in a successful Send Routing Info for LCS response, the receiving shall use the serving node in preference to the additional serving nodes. + +# --- 6 Protocol Specification and Implementations + +## 6.1 Introduction + +### 6.1.1 Use of Diameter Base Protocol + +The Diameter base protocol as specified in IETF RFC 6733 [17] shall apply except as modified by the defined support of the methods and the defined support of the commands and AVPs, result and error codes as specified in this + +specification. Unless otherwise specified, the procedures (including error handling and unrecognised information handling) shall be used unmodified. + +### 6.1.2 Securing Diameter Messages + +For secure transport of Diameter messages, see 3GPP TS 33.210 [6]. + +### 6.1.3 Accounting Functionality + +Accounting functionality (Accounting Session State Machine, related command codes and AVPs) shall not be used on the SLh interface. + +### 6.1.4 Use of Sessions + +Between the GMLC and the HSS, Diameter sessions shall be implicitly terminated. An implicitly terminated session is one for which the server does not maintain state information. The client shall not send any re-authorization or session termination requests to the server. + +The Diameter base protocol as specified in IETF RFC 6733 [17] includes the Auth-Session-State AVP as the mechanism for the implementation of implicitly terminated sessions. + +The client (server) shall include in its requests (responses) the Auth-Session-State AVP set to the value NO\_STATE\_MAINTAINED (1), as described in IETF RFC 6733 [17]. As a consequence, the server shall not maintain any state information about this session and the client shall not send any session termination request. Neither the Authorization-Lifetime AVP nor the Session-Timeout AVP shall be present in requests or responses. + +### 6.1.5 Transport Protocol + +Diameter messages over the SLh interface shall make use of SCTP IETF RFC 4960 [7] as transport protocol. + +### 6.1.6 Routing Considerations + +This clause specifies the use of the Diameter routing AVPs Destination-Realm and Destination-Host. + +If GMLC knows the address/name of the HSS for a certain user, both the Destination-Realm AVP and the Destination-Host AVP shall be present in the request. Otherwise, only the Destination-Realm AVP shall be present and the command shall be routed to the next Diameter node. Consequently, the Destination-Host AVP is declared as optional in the ABNF for all requests initiated by a GMLC. + +Destination-Realm AVP is declared as mandatory in the ABNF for all requests. + +If the Vendor-Specific-Application-ID AVP is received in any of the commands defined in this specification, it shall be ignored by the receiving node, and it shall not be used for routing purposes. + +### 6.1.7 Advertising Application Support + +The HSS and GMLC shall advertise support of the Diameter SLh Application by including the value of the application identifier in the Auth-Application-Id AVP within the Vendor-Specific-Application-Id grouped AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands. + +The vendor identifier value of 3GPP (10415) shall be included in the Supported-Vendor-Id AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands, and in the Vendor-Id AVP within the Vendor-Specific-Application-Id grouped AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands. + +The Vendor-Id AVP included in Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands that is not included in the Vendor-Specific-Application-Id AVPs as described above shall indicate the manufacturer of the Diameter node as per IETF RFC 6733 [17]. + +### 6.1.8 Diameter Application Identifier + +The SLh interface protocol shall be defined as an IETF vendor specific Diameter application, where the vendor is 3GPP. The vendor identifier assigned by IANA to 3GPP () is 10415. + +The Diameter application identifier assigned to the SLh interface application is 16777291 (allocated by IANA). + +### 6.1.9 User Identity to HSS resolution + +The User identity to HSS resolution mechanism enables the GMLC (for non-roaming case) or Diameter Relay/proxy agents in the home network (for roaming case) to find the identity of the HSS that holds the LCS subscription data and routing information for the target user when multiple and separately addressable HSSs have been deployed in the home network. The resolution mechanism is not required in networks that utilise a single HSS. + +This User identity to HSS resolution mechanism may rely on routing capabilities provided by Diameter and be implemented in the home operator network within dedicated Diameter Agents (Redirect Agents or Proxy Agents) responsible for determining the HSS identity based on the provided user identity. If this Diameter based implementation is selected by the Home network operator, the principles described in the 3GPP TS 29.272 [12] shall apply. + +NOTE: Alternatives to the user identity to HSS resolution Diameter based implementation are outside the scope of this specification. + +## 6.2 Commands + +### 6.2.1 Introduction + +This section defines the Command code values and related ABNF for each command described in this specification. + +### 6.2.2 Command-Code values + +This section defines Command-Code values for the SLh interface application as allocated by IANA. + +Every command is defined by means of the ABNF syntax IETF RFC 2234 [13], according to the Command Code Format (CCF) specification defined in IETF RFC 6733 [17]. In the case, the definition and use of an AVP is not specified in this document, the guidelines in IETF RFC 6733 [17] shall apply. + +The Vendor-Specific-Application-Id AVP shall not be included in any command sent by Diameter nodes supporting applications defined in this specification. If the Vendor-Specific-Application-Id AVP is received in any of the commands defined in this specification, it shall be ignored by the receiving node. + +NOTE: The Vendor-Specific-Application-Id AVP is included as an optional AVP in all Command Code Format specifications defined in this specification in order to overcome potential interoperability issues with intermediate Diameter agents non-compliant with IETF RFC 6733 [17]. + +The following Command Codes are defined in this specification: + +**Table 6.2.2/1: Command-Code values for SLh** + +| Command-Name | Abbreviation | Code | Section | +|--------------------------|--------------|---------|---------| +| LCS-Routing-Info-Request | RIR | 8388622 | 6.2.3 | +| LCS-Routing-Info-Answer | RIA | 8388622 | 6.2.4 | + +For these commands, the Application-ID field shall be set to 16777291 (application identifier of the SLh interface application, allocated by IANA). + +### 6.2.3 LCS-Routing-Info-Request (RIR) Command + +The LCS-Routing-Info-Request (RIR) command, indicated by the Command-Code field set to 8388622 and the "R" bit set in the Command Flags field, is sent from GMLC to HSS. + +#### Message Format + +< LCS-Routing-Info-Request> ::= < Diameter Header: 8388622, REQ, PXY, 16777291 > + +< Session-Id > + +[ Vendor-Specific-Application-Id ] + +{ Auth-Session-State } + +{ Origin-Host } + +{ Origin-Realm } + +[ Destination-Host ] + +{ Destination-Realm } + +[ User-Name ] + +[ MSISDN ] + +[ GMLC-Number ] + +\*[ Supported-Features ] + +\*[ Proxy-Info ] + +\*[ Route-Record ] + +\*[ AVP ] + +### 6.2.4 LCS-Routing-Info-Answer (RIA) Command + +The LCS-Routing-Info-Answer (RIA) command, indicated by the Command-Code field set to 8388622 and the 'R' bit cleared in the Command Flags field, is sent from HSS to GMLC. + +#### Message Format + +< LCS-Routing-Info-Answer> ::= < Diameter Header: 8388622, PXY, 16777291 > + +< Session-Id > + +[ Vendor-Specific-Application-Id ] + +[ Result-Code ] + +[ Experimental-Result ] + +{ Auth-Session-State } + +{ Origin-Host } + +{ Origin-Realm } + +\*[ Supported-Features ] + +[ User-Name ] + +[ MSISDN ] + +[ LMSI ] + +[ Serving-Node ] + +\*[ Additional-Serving-Node ] + +[ GMLC-Address ] +[ PPR-Address ] +[ RIA-Flags ] +\*[ AVP ] +[ Failed-AVP ] +\*[ Proxy-Info ] +\*[ Route-Record ] + +## 6.3 Result-Code AVP and Experimental-Result AVP Values + +### 6.3.1 General + +This section defines result code values that shall be supported by all Diameter implementations that conform to this specification. + +### 6.3.2 Success + +Result codes that fall within the Success category shall be used to inform a peer that a request has been successfully completed. The Result-Code AVP values defined in the Diameter base protocol specified in IETF RFC 6733 [17] shall be applied. + +### 6.3.3 Permanent Failures + +Errors that fall within the Permanent Failures category shall be used to inform the peer that the request has failed, and should not be attempted again. The Result-Code AVP values defined in the Diameter base protocol specified in IETF RFC 6733 [17] shall be applied. When one of the result codes defined here is included in a response, it shall be inside an Experimental-Result AVP and the Result-Code AVP shall be absent. + +#### 6.3.3.1 DIAMETER\_ERROR\_USER\_UNKNOWN (5001) + +This result code shall be sent by the HSS to indicate that the user identified by the IMSI or the MSISDN is unknown. This error code is defined in 3GPP TS 29.229 [8] + +#### 6.3.3.2 DIAMETER\_ERROR\_UNAUTHORIZED\_REQUESTING\_NETWORK (5490) + +This result code shall be sent by the HSS to indicate that the requesting GMLC's network is not authorized to request UE location information. + +### 6.3.4 Transient Failures + +Errors that fall within the transient failures category are those used to inform a peer that the request could not be satisfied at the time that it was received. The request may be able to be satisfied in the future. + +#### 6.3.4.1 DIAMETER\_ERROR\_ABSENT\_USER (4201) + +This result code shall be sent by the HSS to indicate that the location of the targeted user is not known at this time to satisfy the requested operation. + +## 6.4 AVPs + +### 6.4.1 General + +The following table specifies the Diameter AVPs defined for the SLh interface protocol, their AVP Code values, types, possible flag values and whether or not the AVP may be encrypted. The Vendor-ID header of all AVPs defined in this specification shall be set to 3GPP (10415). + +For all AVPs which contain bit masks and are of the type Unsigned32, bit 0 shall be the least significant bit. For example, to get the value of bit 0, a bit mask of 0x00000001 should be used. + +**Table 6.4.1/1: SLh specific Diameter AVPs** + +| Attribute Name | AVP Code | Section defined | Value Type | AVP Flag rules | | | | | +|-------------------------|----------|-----------------|------------------|----------------|-----|------------|----------|-----------| +| | | | | Must | May | Should not | Must not | May Encr. | +| LMSI | 2400 | 6.4.2 | OctetString | M, V | | | | No | +| Serving-Node | 2401 | 6.4.3 | Grouped | M, V | | | | No | +| MME-Name | 2402 | 6.4.4 | DiameterIdentity | M, V | | | | No | +| MSC-Number | 2403 | 6.4.5 | OctetString | M, V | | | | No | +| LCS-Capabilities-Sets | 2404 | 6.4.6 | Unsigned32 | M, V | | | | No | +| GMLC-Address | 2405 | 6.4.7 | Address | M, V | | | | No | +| Additional-Serving-Node | 2406 | 6.4.8 | Grouped | M, V | | | | No | +| PPR-Address | 2407 | 6.4.9 | Address | M, V | | | | No | +| MME-Realm | 2408 | 6.4.12 | DiameterIdentity | V | | | M | No | +| SGSN-Name | 2409 | 6.4.13 | DiameterIdentity | V | | | M | No | +| SGSN-Realm | 2410 | 6.4.14 | DiameterIdentity | V | | | M | No | +| RIA-Flags | 2411 | 6.4.15 | Unsigned32 | V | | | M | No | + +NOTE 1: The AVP header bit denoted as "M", indicates whether support of the AVP is required. The AVP header bit denoted as "V", indicates whether the optional Vendor-ID field is present in the AVP header. For further details, see IETF RFC 6733 [17]. + +The following table specifies the Diameter AVPs re-used by the SLh interface protocol from existing Diameter Applications, including a reference to their respective specifications and when needed, a short description of their use within SLh. + +Any other AVPs from existing Diameter Applications, except for the AVPs from the Diameter base protocol as specified in IETF RFC 6733 [17], do not need to be supported. The AVPs from the Diameter base protocol as specified in IETF RFC 6733 [17] are not included in table 6.4.1/2, but they may be re-used for the SLh protocol. + +**Table 6.4.1/2: SLh re-used Diameter AVPs** + +| Attribute Name | Reference | Comments | +|----------------------|---------------------|--------------------| +| MSISDN | 3GPP TS 29.329 [9] | | +| SGSN-Number | 3GPP TS 29.272 [12] | | +| Supported-Features | 3GPP TS 29.229 [8] | | +| Feature-List-ID | 3GPP TS 29.229 [8] | See section 6.4.10 | +| Feature-List | 3GPP TS 29.229 [8] | See section 6.4.11 | +| GMLC-Number | 3GPP TS 29.272 [12] | | +| 3GPP-AAA-Server-Name | 3GPP TS 29.273 [16] | | + +### 6.4.2 LMSI + +The LMSI AVP is of type OctetString and it shall contain the Local Mobile Station Identity (LMSI) allocated by the VLR, as defined in 3GPP TS 23.003 [10]. For further details on the encoding of this AVP, see 3GPP TS 23.003[10]. + +### 6.4.3 Serving-Node + +The Serving-Node AVP is of type Grouped. This AVP shall contain the information about the network node serving the targeted user. + +AVP format + +Serving-Node ::= + +[ SGSN-Number ] + +[ SGSN-Name ] +[ SGSN-Realm ] +[ MME-Name ] +[ MME-Realm ] +[ MSC-Number ] +[ 3GPP-AAA-Server-Name ] +[ LCS-Capabilities-Sets ] +[ GMLC-Address ] +\*[AVP] + +The GMLC-Address AVP included in the Serving-Node grouped AVP shall contain, if present, the IPv4 or IPv6 address of the GMLC associated with the serving node (i.e., either the home GMLC or the visited GMLC, depending on the location of the serving node). + +### 6.4.4 MME-Name + +The MME-Name AVP is of type DiameterIdentity and it shall contain the Diameter identity of the serving MME. For further details on the encoding of this AVP, see IETF RFC 6733 [17]. + +### 6.4.5 MSC-Number + +The MSC-Number AVP is of type OctetString and it shall contain the ISDN number of the serving MSC or MSC server in international number format as described in ITU-T Rec E.164 [15] and shall be encoded as a TBCD-string. See 3GPP TS 29.002 [3] for encoding of TBCD-strings. + +### 6.4.6 LCS-Capabilities-Sets + +The LCS-Capabilities-Sets AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in 3GPP 29.002 [3]. + +### 6.4.7 GMLC-Address + +The GMLC-Address AVP is of type Address and shall contain the IPv4 or IPv6 address of H-GMLC or the V-GMLC associated with the serving node. + +### 6.4.8 Additional-Serving-Node + +The Additional-Serving-Node AVP is of type Grouped. This AVP shall contain the information about the network node serving the targeted user. + +AVP format + +Additional-Serving-Node ::= + +[ SGSN-Number ] +[ MME-Name ] +[ SGSN-Name ] +[ SGSN-Realm ] +[ MME-Realm ] +[ MSC-Number ] +[ 3GPP-AAA-Server-Name ] + +[ LCS-Capabilities-Sets ] + +[ GMLC-Address ] + +\*[AVP] + +The GMLC-Address AVP included in the Additional-Serving-Node grouped AVP shall contain, if present, the IPv4 or IPv6 address of the GMLC associated with the serving node (i.e., either the home GMLC or the visited GMLC, depending on the location of the serving node). + +### 6.4.9 PPR-Address + +The PPR-Address AVP is of type Address and contains the IPv4 or IPv6 address of the Privacy Profile Register for the targeted user. + +### 6.4.10 Feature-List-ID AVP + +The syntax of this AVP is defined in 3GPP TS 29.229 [8]. For this release, the Feature-List-ID AVP value shall be set to 1. + +### 6.4.11 Feature-List AVP + +The syntax of this AVP is defined in 3GPP TS 29.229 [8]. A null value indicates that there is no feature used by the application. + +NOTE: There is no feature defined for this release. + +### 6.4.12 MME-Realm + +The MME-Realm AVP is of type DiameterIdentity and it shall contain the Diameter Realm Identity of the serving MME. For further details on the encoding of this AVP, see IETF RFC 6733 [17]. + +### 6.4.13 SGSN-Name + +The SGSN-Name AVP is of type DiameterIdentity and it shall contain the Diameter identity of the serving SGSN. For further details on the encoding of this AVP, see IETF RFC 6733 [17]. + +### 6.4.14 SGSN-Realm + +The SGSN-Realm AVP is of type DiameterIdentity and it shall contain the Diameter Realm Identity of the serving SGSN. For further details on the encoding of this AVP, see IETF RFC 6733 [17]. + +### 6.4.15 RIA-Flags + +The RIA-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 6.4.15/1: + +**Table 6.4.15/1: RIA-Flags** + +| Bit | Name | Description | +|----------------------------------------------------------------------------------------------------------------|-------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | Combined-MME/SGSN-Supporting-Optimized-LCS-Proc | This bit, when set, indicates that the UE is served by the MME and the SGSN parts of the same combined MME/SGSN and this combined MME/SGSN supports the optimized LCS procedure. | +| NOTE1: Bits not defined in this table shall be cleared by the sending HSS and discarded by the receiving GMLC. | | | + +# Annex A (informative): Change history + +| Date | TSG # | TSG Doc. | CR | R ev | Subject/Comment | New | +|---------|--------|-----------|------|------|------------------------------------------------------------------------------|--------| +| 2010-03 | CT#47 | CP-090815 | | | TS presented for approval in CT#47 | 9.0.0 | +| 2010-09 | CT#49 | CP-100463 | 0002 | 1 | Application ID and Command code values | 9.1.0 | +| 2011-03 | - | - | - | - | Update to Rel-10 version (MCC) | 10.0.0 | +| 2011-12 | CT#54 | CP-11786 | 0004 | 2 | Identifications of MME in location procedures | 10.1.0 | +| 2012-03 | CT#55 | CP-120023 | 0007 | 1 | MSC-Number format | 10.2.0 | +| 2012-09 | CT#57 | CP-120490 | 0008 | 1 | LCS-Capabilities-Set AVP | 10.3.0 | +| 2012-09 | - | - | - | - | Update to Rel-11 version (MCC) | 11.0.0 | +| 2012-12 | CT#58 | CP-120719 | 0013 | 1 | Clarification on the use of Vendor-Specific-Application-Id AVP | 11.1.0 | +| 2013-03 | CT#59 | CP-130156 | 0014 | 1 | Providing Diameter identity of the SGSN to the GMLC over SLh interface | 12.0.0 | +| 2013-12 | CT#62 | CP-130624 | 0015 | 2 | HSS and GMLC indicating the support for optimized LCS procedure | 12.1.0 | +| 2014-09 | CT#65 | CP-140516 | 0016 | 1 | Title Closing TS 29.234 and reused AVP in TS 29.273 | 12.2.0 | +| 2015-03 | CT#67 | CP-150022 | 0017 | 1 | Send Routing Information Behaviour | 12.3.0 | +| 2015-03 | CT#67 | CP-150022 | 0018 | 1 | Send Routing Information - Conditions for presence of conditional parameters | 12.3.0 | +| 2015-12 | - | - | - | - | Update to Rel-13 version (MCC) | 13.0.0 | +| 2017-03 | CT#75 | CP-170036 | 0019 | - | Bit ordering in Diameter AVPs used as bit-masks | 14.0.0 | +| 2017-03 | CT#75 | CP-170048 | 0020 | - | Update of reference for the Diameter base protocol | 14.0.0 | +| 2017-03 | CT#75 | CP-170048 | 0021 | - | Handling of the Vendor-Specific-Application-Id AVP | 14.0.0 | +| 2017-03 | CT#75 | CP-170048 | 0022 | 1 | Cardinality of the Failed-AVP AVP in answer | 14.0.0 | +| 2018-06 | CT#80 | - | - | - | Update to Rel-15 version (MCC) | 15.0.0 | +| 2020-07 | CT#88e | - | - | - | Update to Rel-16 version (MCC) | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29202/0236eff05bcb8f3a343ea7933aaa306b_img.jpg b/marked/Rel-16/29_series/29202/0236eff05bcb8f3a343ea7933aaa306b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c55361cd11ef8b19bface6d8818e097fe6bf64f6 --- /dev/null +++ b/marked/Rel-16/29_series/29202/0236eff05bcb8f3a343ea7933aaa306b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:41e0090a249c2faf08cff92675b2aa5c60649dbb2d301413f6f5eea7df7630a5 +size 6225 diff --git a/marked/Rel-16/29_series/29202/43fec6623ab9cb223a9ff74e2d2a4402_img.jpg b/marked/Rel-16/29_series/29202/43fec6623ab9cb223a9ff74e2d2a4402_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9b7304a2c3c39d592be3e902ca553ab8ef6bb891 --- /dev/null +++ b/marked/Rel-16/29_series/29202/43fec6623ab9cb223a9ff74e2d2a4402_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ea4d6a1f2bcde9749a09d93d11c1893e30e414584f3d57254356cf4bb39f7bed +size 7096 diff --git a/marked/Rel-16/29_series/29202/78d5774278a3f4a614f8c0ae485ce8d9_img.jpg b/marked/Rel-16/29_series/29202/78d5774278a3f4a614f8c0ae485ce8d9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..299834891b17cbada260235bb1aff4c0b596b0c6 --- /dev/null +++ b/marked/Rel-16/29_series/29202/78d5774278a3f4a614f8c0ae485ce8d9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4be11fe56208b75731b4c0bcad77c5be49641db714dd77774c59d95ad03ff9da +size 28226 diff --git a/marked/Rel-16/29_series/29202/a9ed452e3e099e1505f7b9ad182a11e9_img.jpg b/marked/Rel-16/29_series/29202/a9ed452e3e099e1505f7b9ad182a11e9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f09a9c91a538ae96d659729ec78cacd83dd3b21c --- /dev/null +++ b/marked/Rel-16/29_series/29202/a9ed452e3e099e1505f7b9ad182a11e9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:81ad4a8d94d4e29f7a1c5b20d85ae429471831ab750330edadb9edcc643b8f5a +size 6149 diff --git a/marked/Rel-16/29_series/29202/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg b/marked/Rel-16/29_series/29202/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..fc9aef705b1a18917f686df08eeb2f7f0e9716a6 --- /dev/null +++ b/marked/Rel-16/29_series/29202/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f17eab39c27a9ae7fa2cf1fa05ef23f52769a94562bc5ba01caba45ea9e302aa +size 75639 diff --git a/marked/Rel-16/29_series/29202/e928f4874ed492d3ad4c6fa2d29aedbc_img.jpg b/marked/Rel-16/29_series/29202/e928f4874ed492d3ad4c6fa2d29aedbc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e6ef6aa9e0bf3250390e722fd1983590ec2739ce --- /dev/null +++ b/marked/Rel-16/29_series/29202/e928f4874ed492d3ad4c6fa2d29aedbc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:405880134f7a0a688f2f00e32bc93a7a9fadd258f809c4424feb4efc51982629 +size 37815 diff --git a/marked/Rel-16/29_series/29202/raw.md b/marked/Rel-16/29_series/29202/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..60997c6e2868f3a6a8f64d3d33ed0d48217f70d5 --- /dev/null +++ b/marked/Rel-16/29_series/29202/raw.md @@ -0,0 +1,558 @@ + + + + + + +# --- Contents + +| | | +|-------------------------------------------------------------------------------------------|-----------| +| Foreword ..... | 4 | +| 1 Scope..... | 4 | +| 2 References..... | 4 | +| 2.1 Normative references ..... | 4 | +| 2.2 Informative references..... | 5 | +| 3 Definitions and abbreviations ..... | 5 | +| 3.1 Definitions..... | 5 | +| 3.2 Abbreviations ..... | 5 | +| 4 Introduction..... | 6 | +| 5 Protocol architectures..... | 6 | +| 5.1 Protocol architecture in the case of MTP-based SS7 signalling transport network ..... | 6 | +| 5.2 Protocol architecture in the case of IP-based SS7 signalling transport network..... | 6 | +| 5.2.1 M3UA 6 | | +| 5.2.2 MTP3-M2PA..... | 7 | +| 5.3 Protocol architecture in the case of ATM-based SS7 signalling transport network ..... | 7 | +| Annex A (Normative): The use of M3UA in 3GPP networks..... | 8 | +| A.1 Scope..... | 8 | +| A.2 Introduction..... | 8 | +| A.3 Protocol conformance to RFC 4666..... | 9 | +| Annex B (Informative): The use of M2PA in 3GPP networks ..... | 17 | +| B.1 Scope..... | 17 | +| B.2 Introduction..... | 17 | +| B.3 Protocol conformance to RFC 4165..... | 17 | +| Annex C (informative): Change history..... | 21 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 1 Scope + +The present document defines the possible protocol architectures for transport of SS7 signalling protocols in Core Network. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +## 2.1 Normative references + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] ITU-T Recommendation Q.701: "Functional description of the message transfer part (MTP) of signalling system No. 7". +- [3] ITU-T Recommendation Q.702: "Signalling data link". +- [4] ITU-T Recommendation Q.703: "Signalling link". +- [5] ITU-T Recommendation Q.704: "Signalling network functions and messages". +- [6] ITU-T Recommendation Q.705: "Signalling network structure". +- [7] ITU-T Recommendation Q.706: "Message transfer part signalling performance". +- [8] RFC 2960: "Stream Control Transmission Protocol". + +- [9] ITU-T Recommendation G.804: "ATM cell mapping into Plesiochronous Digital Hierarchy (PDH)". +- [10] ITU-T Recommendation I.112: "Vocabulary of terms for ISDNs". +- [11] ITU-T Recommendation I.361: "B-ISDN ATM layer specification". +- [12] ITU-T Recommendation I.363.5: "B-ISDN ATM Adaptation Layer specification: Type 5 AAL". +- [13] ITU-T Recommendation Q.2110: "B-ISDN ATM adaptation layer - Service specific connection oriented protocol (SSCOP)". +- [14] ITU-T Recommendation Q.2140: "B-ISDN ATM adaptation layer - Service specific coordination function for signalling at the network node interface (SSCF at NNI)". +- [15] ITU-T Recommendation Q.2210: "Message transfer part level 3 functions and messages using the services of ITU-T Recommendation Q.2140". +- [17] RFC 3309: "SCTP Checksum Change". +- [18] RFC 4666: Signaling System 7 (SS7) Message Transfer Part 3 (MTP3) - User Adaptation Layer (M3UA)". +- [19] RFC 4165: Signaling System 7 (SS7) Message Transfer Part 2 (MTP2) -User Peer-to-Peer Adaptation Layer (M2PA)". + +## 2.2 Informative references + +- [16] RFC 2719: "Framework Architecture for Signalling Transport". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in TR 21.905 [1]. + +(no further terms defined) + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in TR 21.905 [1]. + +| | | +|-------|-------------------------------------------------------------| +| AAL5 | ATM Adaptation Layer type 5 | +| ATM | Asynchronous Transfer Mode | +| IP | Internet Protocol | +| MTP | Message Transfer Part | +| MTP1 | Message Transfer Part layer 1 | +| MTP2 | Message Transfer Part layer 2 | +| MTP3 | Message Transfer Part layer 3 | +| M2PA | Message Transfer Part 2 -User Peer-to-Peer Adaptation Layer | +| M3UA | MTP3-User Adaptation | +| PDH | Plesiochronous Digital Hierarchy | +| SSCF | Service Specific Coordination Function | +| SSCOP | Service Specific Connection Oriented Protocol | +| SCCP | Signalling Connection Control Part | +| SCTP | Stream Control Transmission Protocol | +| SDH | Synchronous Digital Hierarchy | +| TCAP | Transaction Capabilities Application Part | + +# --- 4 Introduction + +The Core Network enables the transport of SS7 signalling protocols between two entities by means of different underlying networks (e.g. MTP-based, IP-based or ATM-based). + +The transport of SS7 signalling protocol messages of any protocol layer that is identified by the MTP level 3 layer, in SS7 terms, as a user part (MTP3-user) shall be accomplished in accordance with the protocol architecture defined in the following sub-clauses. The list of these protocol layers includes, but is not limited to, Signalling Connection Control Part (SCCP). + +The transport of protocols which can be identified as SCCP-users, like for example TCAP, and in turn the transport of TCAP-users like MAP and CAP, shall also be accomplished in accordance with the defined protocol architectures, since their protocol messages are transferred as SCCP payload. + +# --- 5 Protocol architectures + +## 5.1 Protocol architecture in the case of MTP-based SS7 signalling transport network + +The transport of an MTP3-user signalling messages shall be accomplished in accordance with the relevant ITU-T Recommendations [2], [3], [4], [5], [6], [7]. + +The protocol architecture applicable in the case of MTP-based SS7 signalling transport network is shown in Figure 5.1/1 + +![Diagram of MTP-based SS7 signalling transport network protocol architecture](43fec6623ab9cb223a9ff74e2d2a4402_img.jpg) + +A diagram showing a vertical stack of four protocol layers. From top to bottom, they are: MTP3-User, MTP3, MTP2, and MTP1. Each layer is represented by a rectangular box with a thin black border, and the boxes are stacked on top of each other. + +| | +|-----------| +| MTP3-User | +| MTP3 | +| MTP2 | +| MTP1 | + +Diagram of MTP-based SS7 signalling transport network protocol architecture + +**Figure 5.1/1: Protocol architecture in the case of MTP-based SS7 signalling transport network** + +## 5.2 Protocol architecture in the case of IP-based SS7 signalling transport network + +### 5.2.1 M3UA + +The transport of an MTP3-user signalling messages shall be accomplished in accordance with the architecture defined by the "Framework Architecture for Signalling Transport" [16], by "Stream Control Transmission Protocol" [8] and by the IETF document available in Annex A. An implementation of SCTP to this document shall use the checksum method specified in RFC 3309 [17] instead of the method specified in RFC 2960 [8]. + +The M3UA protocol architecture applicable in the case of IP-based SS7 signalling transport network is shown in Figure 5.2/1 + +![Diagram of IP-based SS7 signalling transport network protocol architecture](a9ed452e3e099e1505f7b9ad182a11e9_img.jpg) + +A diagram showing a vertical stack of four protocol layers. From top to bottom, they are: MTP3-User, M3UA, SCTP, and IP. Each layer is represented by a rectangular box with a thin black border, and the boxes are stacked on top of each other. + +| | +|-----------| +| MTP3-User | +| M3UA | +| SCTP | +| IP | + +Diagram of IP-based SS7 signalling transport network protocol architecture + +**Figure 5.2/1: M3UA architecture in the case of IP-based SS7 signalling transport network** + +The definition of the use of M3UA in 3GPP core network is provided in Annex A to this specification. + +### 5.2.2 MTP3-M2PA + +An MTP3 signalling message can also be transported by M2PA, which shall be accomplished in accordance with IETF RFC 4165[19]. + +The M2PA protocol architecture applicable in the case of IP-based SS7 signalling transport network is shown in Figure 5.2/2 + +![](0236eff05bcb8f3a343ea7933aaa306b_img.jpg) + +| | +|------| +| MTP3 | +| M2PA | +| SCTP | +| IP | + +**Figure 5.2/2: M2PA architecture in the case of IP-based SS7 signalling transport network** + +The definition of the use of M2PA in 3GPP core network is provided in Annex B to this specification. + +## 5.3 Protocol architecture in the case of ATM-based SS7 signalling transport network + +The transport of an MTP3-user signalling messages shall be accomplished in accordance with the relevant ITU-T Recommendations [9], [10], [11], [12], [13], [14], [15] + +The protocol architectures applicable in the case of ATM-based SS7 signalling transport network are shown in Figure 5.3/1. + +![](78d5774278a3f4a614f8c0ae485ce8d9_img.jpg) + +**ATM over SDH** + +| | +|-----------| +| MTP3-User | +| MTP3 B | +| SSCF | +| SSCOP | +| AAL5 | +| ATM | + +**ATM over PDH** + +| | +|-----------| +| MTP3-User | +| MTP3 B | +| SSCF | +| SSCOP | +| AAL5 | +| G.804 | + +**Figure 5.3/1: Protocol architectures in the case of ATM-based SS7 signalling transport network** + +# --- Annex A (Normative): The use of M3UA in 3GPP networks + +## A.1 Scope + +This annex defines the application of M3UA in 3GPP core networks. The purpose of the Annex is to ensure the interoperability of different implementations of M3UAs used by different operators and vendors. This is achieved by: + +- Clarifying certain concepts which are used in RFC 4666; +- Defining those features in RFC 4666 for which support is mandatory; +- Defining those features in the RFC 4666 for which support is optional; +- Defining those features in RFC 4666 which shall not be used; + +The specification is intended for interfaces between network domains, however, it can also be used inside one network domain, and constitutes a minimum set of M3UA requirements to be supported between IP nodes and between IP nodes and SGW nodes in a 3GPP network. + +## --- A.2 Introduction + +M3UA may be used on a number of interfaces in a 3GPP core network. The annex is intended for the interface called A and C in figure 1. A is the Interface between two IP nodes that are equipped with SCTP, M3UA and a M3UA user. Examples of M3UA user are BICC, H.248, SCCP and ISUP. The interface can be used inside one network domain but also to interconnect network domains. Interface B can be used between network domains and inside network domains. Interface B is not in the scope for this annex, however, use of Q.701-Q.705 or Q.2210 on interface B is already standardised; in addition, M2PA is also endorsed for interface B in accordance with Annex B. Interface C is the interface between a node including SCTP, M3UA and a M3UA user and a node including SCTP, M3UA and M3UA signalling gateway functions.. This interface is inside one network domain. + +Interfaces A and C are similar. The main difference is that interface C shall also allow for interworking with the SS 7 network and therefore provides functions for the interworking. + +The signalling gateways in this picture are pure MTP3/3B-M3UA signaling gateways. They do not include any M3UA users. Still there could be a node including an M3UA user (e.g. SCCP functions) and a M3UA signalling gateway functions. In that case, the node will support all the interfaces A, B and C. + +![Figure 1: Use of M3UA in 3GPP core network. The diagram shows three network domains (Network domain 1, Network domain 2, and Network domain 3) connected via Signaling Gateways (SG). Network domain 1 contains three IP nodes, each including an M3UA user, connected to an SG. Network domain 2 contains two IP nodes, one including an M3UA user, connected to an SG. Network domain 3 contains two IP nodes, each including an M3UA user, connected to an SG. The SGs are interconnected, with labels A, B, and C indicating different signaling paths or interfaces.](b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg) + +Figure 1: Use of M3UA in 3GPP core network. The diagram shows three network domains (Network domain 1, Network domain 2, and Network domain 3) connected via Signaling Gateways (SG). Network domain 1 contains three IP nodes, each including an M3UA user, connected to an SG. Network domain 2 contains two IP nodes, one including an M3UA user, connected to an SG. Network domain 3 contains two IP nodes, each including an M3UA user, connected to an SG. The SGs are interconnected, with labels A, B, and C indicating different signaling paths or interfaces. + +Figure 1: Use of M3UA in 3GPP core network + +## A.3 Protocol conformance to RFC 4666 + +A minimum implementation shall support sections marked mandatory in the table below. It shall be possible to configure all implementations to interoperate (no error messages returned) with the minimum set. + +The table below makes comment to the sections in RFC 4666. In the comment column the following terms are used: + +- Mandatory: When support of text in a section is marked mandatory: + - On an information element, message or message class, it means that a receiver shall understand the information element, message or message class and carry out the requested action. + - For a procedure, it means that the procedure is mandatory to be carried out by the involved network elements. +- Optional: When support of the text in a section is marked optional the feature involved is only guaranteed to work between peer entities which are subject to a bilateral agreement between operators of those entities. If one end uses an optional message or information element and the other does not support it, then either a silent discard takes place of an information element as a part of the message or the message is discarded and an error message is returned. This is described as part of the handling of the optionality in the table. +- Excluded: This means that the feature shall not be used in a 3GPP environment + +Descriptive text means that the section does not include any requirements for this specification. + +Note: The word "heading" means that the section consists only of subordinate sections. + +The comments column also defines the behaviour of a minimum implementation if it does not support a message or an information element in a mandatory message. + + + +| Section number in M3UA RFC | Comments | +|-------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Abstract | Descriptive text | +| 1. Introduction | Descriptive text | +| 1.1 Scope | Descriptive text | +| 1.2 Terminology | Descriptive text. | +| 1.3 M3UA overview | Descriptive text. | +| 1.4 Functional area | Descriptive text. | +| 1.5 Sample Configurations | Descriptive text | +| 1.6 Definition of M3UA Boundaries | Descriptive text | +| 2 Conventions | Descriptive text | +| 3. M3UA Protocol Elements | Mandatory | +| 3.1 Common message header | Mandatory | +| 3.1.1 M3UA Protocol Version: | The version number field shall be set to 1 | +| 3.1.2 Message classes and types | The values are classified as follow
0-4 Mandatory
5-8 Excluded
9 Optional (Routing Key Management (RKM) Messages)
10 to 255 Excluded | +| 3.1.2 (Management (MGMT) message) | The values are classified as follow
0 Mandatory
1 Optional (Notify). When received and not supported the message maybe silently discarded.
2-255 Excluded | +| 3.1.2 (Transfer messages) | The values are classified as follow
0 Excluded
1 Mandatory
2 to 255 Excluded | +| 3.1.2 (Signalling network management (SSNM) messages) | The values are classified as follow
0 Excluded
1-6 Mandatory
7- 255 Excluded. | +| 3.1.2 (ASP State Maintenance (ASPSM) Messages) | The values are classified as follow
0 Excluded
1-6 Mandatory
7-255 Excluded | +| 3.1.2 (ASP Traffic Maintenance (ASPTM) Messages) | The values are classified as follow
0 Excluded
1-4 Mandatory
5 to 255 Excluded | +| 3.1.2 (Routing key management (RKM)) messages | Optional
If any of these messages is received and not supported an error message with the error code 0x04 (Unsupported message type) shall be sent | +| 3.1.3 Reserved | Mandatory | +| 3.1.4 Message length | Mandatory | + +| Section number in M3UA RFC | Comments | +|---------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 3.2 Variable Length Parameter Format Common Parameters: |

The values are classified as follows

0x0000-- 0x0003, 0x0005, 0x0008, 0x000a, 0x000e, 0x000f, 0x0010 0x0014—0x01ff Excluded

0x0007, 0x0009, 0x000c and 0x0012 Mandatory

0x0004 optional (INFO String) if received and not supported the message is processed but the optional information element is silently discarded,

0x0006 optional (Routing Context if received and not supported the message is processed but the optional information element is silently discarded,

0x000b optional (Traffic Mode Type) if received and not supported the message is processed but the optional information element is silently discarded,

0x0011 (ASP Identifier) if received and not supported the message is processed but the optional information element is silently discarded,

0x0012 Affected point code is mandatory. The support of value 0 in the mask field is mandatory. All other values is outside the scope of this annex.

0x0013 (Correlation ID) if received and not supported the message is processed but the optional information element is silently discarded,

| +| 3.2 Variable Length Parameter Format M3UA Specific Parameters |

The values are classified as follows

0x0201, 0x0202, 0x0203, 0x0211, 0x020d and 0x0214 to 0xffff Excluded

0x0204--0x0205, 0x0210 Mandatory

0x0200 optional (Network Appearance) if received and not supported the message is processed but the optional information element is silently discarded,

0x0206 Optinal (Concerned Destination). If received and not supported the message is processed but the optional information element is silently discarded.

0x0207 (Routing Key), 0x0208 (Registration Result), 0x0209 (Deregistration Result) 0x020a (Local Routing Key Identifier), 0x020b (Destination Point Code), 0x020c (Service Indicators) 0x020d (Subsystem Numbers), 0x020e (Originating Point Code List), 0x020f (Circuit Range), 0x0212 (Registration Status), 0x0213 (Deregistration Status) are parameters in optional message, and therefore no action is specified.

| +| 3.3 Transfer messages | These messages are mandatory at the interfaces A and C. | +| 3.3.1 Payload Data Message (DATA) |

The parameters Network Appearance, Routing Context, Correlation ID are optional

The parameter Protocol data is mandatory.

| +| 3.4 SS7 signalling network management messages | Heading | +| 3.4.1 Destination Unavailable (DUNA) |

The message is mandatory at the interface C.

The parameters Network Appearance, Routing Context, and INFO String are optional

The parameter Affected Point Code is mandatory

| +| 3.4.2 Destination Available (DAVA) |

The message is mandatory at the interface C

The parameters Network Appearance, Routing Context, and INFO String are optional.

The parameter Affected Point Code is mandatory

| +| 3.4.3 Destination State Audit (DAUD) |

The message is mandatory at the interface C

The parameters Network Appearance, Routing Context, and INFO String are optional.

The parameter Affected Point Code is mandatory

| + +| Section number in M3UA RFC | Comments | +|---------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 3.4.4 Signalling Congestion (SCON) | The message is mandatory at the interface C
The parameters Network Appearance, Routing Context, Congestion Indications and INFO String are optional
The parameter Affected point code is mandatory. | +| 3.4.5 Destination User Part Unavailable (DUPU) | The message is mandatory at the interfaces A and C.
The parameters Network Appearance, Routing Context, and INFO String are optional.

The parameters Affected point code and User/Cause are mandatory | +| 3.4.6 Destination Restricted (DRST) message | This message is mandatory. | +| 3.5 ASP State Maintenance (ASPSM) Messages | These messages are mandatory at the interfaces A and C. | +| 3.5.1 ASP Up message | The ASP Identifier and Info String parameters are optional | +| 3.5.2 ASP Up Acknowledgement Message | The Info String parameter is optional. | +| 3.5.3 ASP Down message | The Info String parameter is optional. | +| 3.5.4 ASP Down Acknowledgement message | The Info String parameter is optional. | +| 3.5.5 Heartbeat message | The message is mandatory. | +| 3.5.6 Heartbeat Acknowledgement message | The message is mandatory | +| 3.6 Routing Key Management messages | These messages are optional at the interfaces A and C. | +| 3.7 ASP Traffic Maintenance (ASPTM) Messages | These messages are mandatory at the interfaces A and C. | +| 3.7.1 ASP Active message | The parameters Traffic Mode Type, Routing Context and INFO String are optional. | +| 3.7.2 ASP Active Acknowledgement message | The Traffic Mode Type, Routing Context and INFO String are optional. | +| 3.7.3 ASP inactive message | The parameters Routing Context and INFO String are optional. | +| 3.7.4 ASP Inactive Acknowledgement | The parameters Routing Context INFO String are optional. | +| 3.8 Management (MGMT) Messages | Heading | +| 3.8.1 Error message | The message is mandatory at the interfaces A and C | +| 3.8.2 Notify message | The message is optional at the interfaces A and C | +| 4 Procedure | The application of a particular procedure at a certain interface is detailed in the following sections | +| 4.1 Procedures to Support the M3UA-User | Heading | +| 4.1.1 Receipt of Primitives from the M3UA-User | The procedure is mandatory at the interfaces A and C. | +| 4.1.2 Receipt of Primitives from the Layer Management | This section is outside the scope of this annex. | +| 4.2 Procedures to Support the Management of SCTP Associations | The procedures are mandatory at the interfaces A and C | +| 4.2.1 Receipt of M3UA Peer Management Messages | The two first paragraphs are outside the scope of this annex.
Last paragraph is mandatory. | +| 4.3 AS and ASP State Maintenance | The procedure is mandatory at the interfaces A and C. | +| 4.3.1 ASP States | Mandatory | +| 4.3.2 AS States | Mandatory | + +| Section number in M3UA RFC | Comments | +|-------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 4.3.3 M3UA Management Procedures for Primitives | This section is outside the scope of this annex. | +| 4.3.4 ASPM Procedures for Peer-to-Peer Messages | Heading | +| 4.3.4.1 ASP Up Procedure |

This procedure is mandatory at the interface C and is a subset of the procedure used at interface A. See also 4.3.4.1.2.

Note: The registration procedure is optional.

A received ASP Up must be acknowledged by an ASP Up Ack message, if no restriction applies e.g. maintenance.

| +| 4.3.4.1.1 M3UA Version Control | This procedure is mandatory at the interfaces A and C. | +| 4.3.4.1.2 IPSP Considerations (Asp Up) |

This procedure is mandatory at the interface A.

All comments applicable for section 4.3.4.1 and 4.3.4.2 are also applicable for this section.

| +| 4.3.4.2 ASP-Down Procedure |

This procedure is mandatory at the interface C and is a subset of the procedure used at interface A. See also 4.3.4.1.2.

A received ASP Down message must be acknowledged by an ASP Down Ack message, if no restriction applies eg maintenance reason.

| +| 4.3.4.3 ASP Active Procedure |

This procedure is mandatory at interface C and is a subset of the procedure used at interface A. See also 4.3.4.3.1.

Configuration data define which AS an ASP is a member of. The ASP Active message does not contain a Routing Context parameter. Consequently, the ASP Active Ack message does not include any Routing Context(s) parameter.

The traffic state an ASP has, is configured within the associated Application Server. If more than one physical entity (ASPs, SGPs or IPSPs) implements a logical entity (SG, AS) then loadshare with 1+k is the mandatory traffic mode.

A received ASP Active must be acknowledged by an ASP Active Ack message, if no restriction applies e.g. maintenance reason.

If a Routing Context parameter is included in the ASP Active message it is not needed to include the Routing Context parameter in the ASP Active Ack message.

Note: This is a deviation to RFC 4666.

| +| 4.3.4.3.1 IPSP Considerations (ASP Active) |

This procedure is mandatory at the interface A.

All comments applicable for section 4.3.4.3 are also applicable for this section.

| +| 4.3.4.4 ASP Inactive Procedures |

This procedure is mandatory at the interface C and is a subset of the procedure used at interface A. See also 4.3.4.4.1.

Configuration data defines which AS an ASP is a member of.

It is optional to send several ASP Active Ack messages in response to a single ASP Active message.

A received ASP Inactive must be acknowledged by an ASP Inactive Ack message, if no restriction applies e.g. maintenance.

The sending of Notify message is mandatory if the As state is changed.

| +| 4.3.4.4.1 IPSP Considerations (ASP Inactive) |

This procedure is mandatory at the interface A.

All comments applicable for section 4.3.4.4 are also applicable for this section.

| + +| Section number in M3UA RFC | Comments | +|----------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 4.3.4.5 Notify Procedures | The procedure is mandatory at the interfaces A and C to reflect an AS state change. | +| 4.3.4.6 Heartbeat Procedures | The procedure is optional. | +| 4.4 Routing Key management procedure | The procedure is optional. | +| 4.5 Procedures to Support the Availability or Congestion Status of SS7 Destination | Heading | +| 4.5.1 At an SGP |

Note: The use of Transfer restricted message is a national option and is about the scope of this specification.

If the SG knows that the ASP supports DRST, then SG shall Send a DRST message, if the SG does not know whether the ASP supports the DRST message the SGW shall send a DAVA message if the destination earlier was unavailable. If the destination was available then no action is required.

| +| 4.5.2 At an ASP | Heading | +| 4.5.2.1 Single SG Configurations | It is mandatory for an ASP to interoperate with one Signaling Gateway. | +| 4.5.2.2 Multiple SG Configurations | It shall be possible to configure an ASP to handle at least a configuration consisting of two Signalling Gateways. | +| 4.5.3 ASP Auditing | Only the part related to international use in Q.704 is inside the scope of this annex. | +| 4.6 MTP 3 restart | The procedure is mandatory. | +| 5. Examples of M3UA Procedures | Descriptive text | +| 5.1. Establishment of Association and Traffic between SGPs and ASPs | Note The procedures defined in the sub-sections to 5.1 are a subset of the procedures defined in section 5.5. | +| 5.1.1 Single ASP in an Application Server ("1+0" sparing) | Descriptive text | +| 5.1.1.1 Single ASP in an Application Server ("1+0" sparing), No Registration | The use of RCn is optional. | +| 5.1.1.2 Single ASP in Application Server ("1+0" sparing), Dynamic Registration | The use of dynamic registration is optional. | +| 5.1.1.3 Single ASP in Multiple Application Servers (each with "1+0" sparing), Dynamic Registration (Case 1 - Multiple Registration Requests) | The use of dynamic registration is optional. | +| 5.1.1.4 Single ASP in Multiple Application Servers (each with "1+0" sparing), Dynamic Registration (Case 2 - Single Registration Request) | The use of dynamic registration is optional. | +| 5.1.2 Two ASPs in Application Server ("1+1" sparing) | This procedure is optional. | +| 5.1.3 Two ASPs in an Application Server ("1+1" sparing, loadsharing case). | The traffic mode parameter is optional in ASP-Active message | +| 5.1.4 Three ASPs in an Application Server ("n+k" sparing, loadsharing case) | The procedure is optional. | +| 5.2 ASP Traffic Failover Examples | Heading | + +| Section number in M3UA RFC | Comments | +|---------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 5.2.1 (1+1 Sparing, Withdrawal of ASP, Backup Override) | The use of the procedure "backup override" is optional. | +| 5.2.2 (1+1 Sparing, Backup Override) | The use of the procedure "backup override" is optional. | +| 5.2.3 (n+k Sparing, Loadsharing case, Withdrawal of ASP) | The procedure is optional | +| 5.3 Normal Withdrawal of an ASP from an Application Server and Teardown of an Association | The registration procedure is optional. Routing Contexts (RC) is optional. | +| 5.3.X Normal Withdrawal of the ASP from an Application Server (1+1 sparing) loadsharing and Teardown of Association |

Image: Sequence diagram showing the withdrawal of ASP 2 and ASP 1 from an SGP. The sequence is: 1. ASP 2 sends ASP Inactive to SGP; SGP responds with ASP Inactive Ack. 2. ASP 1 sends ASP Inactive to SGP; SGP responds with ASP Inactive Ack. 3. SGP sends Notify to ASP 2. 4. ASP 2 sends ASP Down to SGP; SGP responds with ASP Down Ack. 5. SGP sends Notify to ASP 1. 6. ASP 1 sends ASP Down to SGP; SGP responds with ASP Down Ack.

The figure is added for clarification.

| +| 5.4. Auditing Examples | Heading | +| 5.4.1. SG State: Uncongested/Available | Descriptive text. | +| 5.4.2. SG State: Congested (Congestion Level=2) /Available | Descriptive text. | +| 5.4.3. SG State: Unknown/Available | Descriptive text. | +| 5.4.4. SG State: Unavailable | Descriptive text. | +| 5.5 M3UA/MTP3-User Boundary Examples | Heading | +| 5.5.1 At an ASP | Heading | +| 5.5.1.1 Support for MTP-TRANSFER Primitives at the ASP | Heading | +| 5.5.1.1.1 Support for MTP-TRANSFER Request Primitive | The procedure is mandatory at the interface A and C. This description is also applicable for an IPSP, so replace the abbreviation ASP with ASP/IPSP and SGP with SGP/IPSP | +| 5.5.1.1.2 Support for the MTP-TRANSFER Indication Primitive | The support is mandatory at the interface A and C. This description is also applicable for an IPSP, so replace the abbreviation ASP with ASP/IPSP and SGP with SGP/IPSP. | +| 5.5.1.1.3 Support for ASP Querying of SS7 Destination States | This procedure is mandatory at the interface C. The querying of congestion states is an optional national procedure and outside the scope of this annex. | +| 5.5.2 At an SGP | Heading | +| 5.5.2.1 Support for MTP-TRANSFER Request Primitive at the SGP | The procedure is mandatory at the interface C. Network Appearance is optional. | + +| Section number in M3UA RFC | Comments | +|-----------------------------------------------------------------------------|--------------------------------------------------------------------------------| +| 5.5.2.2 Support for MTP-TRANSFER Indication Primitive at the SGP | The procedure is mandatory at the interface C | +| 5.5.2.3 Support for MTP-PAUSE, MTP-RESUME, MTP-STATUS Indication Primitives | Heading | +| 5.5.2.3.1 Destination Unavailable | The procedure is mandatory at the interface C | +| 5.5.2.3.2 Destination Available | The procedure is mandatory at the interface C | +| 5.5.2.3.3 SS7 Network Congestion | The procedure is mandatory at the interface C | +| 5.5.2.3.4 Destination User Part Unavailable | The procedure is mandatory at the interface C and optional at the interface A. | +| 5.6 Examples for IPSP communication. | Descriptive text. | + +# Annex B (Informative): The use of M2PA in 3GPP networks + +## B.1 Scope + +This annex defines the application of M2PA in 3GPP core networks as an option on interface B. The purpose of the Annex is to ensure the interoperability of different implementations of M2PA as used by different operators and vendors. This is achieved by: + +- Clarifying certain concepts which are used in RFC 4165; +- Defining those features in RFC 4165 for which support is mandatory; +- Defining those features in the RFC 4165 for which support is optional; +- Defining those features in RFC 4165 which shall not be used; + +This specification is intended for interfaces between network domains. However, it can also be used inside one network domain, and constitutes, in that case, a minimum set of M2PA requirements to be supported between IP nodes and between SRP nodes in a 3GPP network. + +## B.2 Introduction + +M2PA may be used between SRPs, i.e. interface B (refer to Figure 1 of Annex A). + +Figure 2 recommends how M2PA is used in a 3GPP IP based signalling network. + +![Diagram illustrating the use of M2PA in 3GPP core networks. It shows two network domains connected via a series of nodes. The left domain is a 3GPP IP based signalling network containing three SG (Signalling Gateway) nodes and two SP (Service Point) nodes. The SG nodes are connected in a chain: SG - M2PA -> SG - MTP3/M2PA -> SG. The SP nodes are connected to the SG nodes. The right domain is an SS7 signalling network based on MTP3/MTP2. The connection between the two domains is via the third SG node, which is connected to the SS7 network through an MTP3/MTP2 interface.](e928f4874ed492d3ad4c6fa2d29aedbc_img.jpg) + +Diagram illustrating the use of M2PA in 3GPP core networks. It shows two network domains connected via a series of nodes. The left domain is a 3GPP IP based signalling network containing three SG (Signalling Gateway) nodes and two SP (Service Point) nodes. The SG nodes are connected in a chain: SG - M2PA -> SG - MTP3/M2PA -> SG. The SP nodes are connected to the SG nodes. The right domain is an SS7 signalling network based on MTP3/MTP2. The connection between the two domains is via the third SG node, which is connected to the SS7 network through an MTP3/MTP2 interface. + +Figure B2.1: Use of M2PA in 3GPP core networks + +## B.3 Protocol conformance to RFC 4165 + +A minimum implementation shall support sections marked mandatory in the table below. It shall be possible to configure all implementations to interoperate (no error messages returned) with the minimum set. + +The table below makes comment to the sections in RFC 4165. In the comment column the following terms are used: + +- Mandatory: When support of text in a section is marked mandatory: + - On an information element, message or message class, it means that a receiver shall understand the information element, message or message class and carry out the requested action. + - For a procedure, it means that the procedure is mandatory to be carried out by the involved network elements. + +- Optional: When support of the text in a section is marked optional the feature involved is only guaranteed to work between peer entities which are subject to a bilateral agreement between operators of those entities. If one end uses an optional information element and the other does not support it, then a silent discard takes place of an information element as a part of the message. This is described as part of the handling of the optionality in the table. +- Excluded: This means that the feature shall not be used in a 3GPP environment + +Descriptive text means that the section does not include any requirements for this specification. + +Note: The word "heading" means that the section consists only of subordinate sections. + +The comments column also defines the behaviour of a minimum implementation if it does not support a message or an information element in a mandatory message. + + + +| Section number in M2PA RFC | Comments | +|--------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Abstract | Descriptive text | +| 1.Introduction | Descriptive text | +| 1.1 Scope | Descriptive text | +| 1.2 Terminology | Descriptive text. | +| 1.3 Abbreviations | Descriptive text. | +| 1.4 Conventions | Descriptive text. | +| 1.5. Signaling Transport Architecture | Descriptive text | +| 1.5.1 Point Code Representation | Mandatory | +| 1.6 Services Provided by M2PA | Descriptive text | +| 1.6.1 Support for MTP Level 2 / MTP Level 3 Interface Boundary | Mandatory | +| 1.6.2 Support for Peer-to-Peer Communication | Mandatory | +| 1.7. Functions Provided by M2PA | Heading | +| 1.7.1 MTP2 Functionality | Descriptive text | +| 1.7.2 Mapping of SS7 and IP Entities | Mandatory | +| 1.7.3 SCTP Association Management | Mandatory | +| 1.7.4 Retention of MTP3 in the SS7 Network | Descriptive text | +| 1.8. Definition of the M2PA Boundaries | Heading | +| 1.8.1 Definition of the M2PA/MTP Level3 Boundaries | Descriptive text | +| 1.8.2 Definition of the Lower Layer Boundary between M2PA and SCTP | Descriptive text | +| 1.9. Differences Between M2PA and M2UA | Descriptive text | +| 2. Protocol Elements | Mandatory | +| 2.1 Common message header | Mandatory | +| 2.1.1 Version: | Mandatory | +| 2.1.2 Spare | Mandatory | +| 2.1.3 Message class | Mandatory | +| 2.1.4 Message Type | Mandatory | +| 2.1.5 Message Length | Mandatory | +| 2.2 M2PA Header | Mandatory | +| 2.2.1 Backward Sequence Number (BSN) | Mandatory | +| 2.2.2 Forward Sequence Number (FSN) | Mandatory | +| 2.3 M2PA Messages | Mandatory | +| 2.3.1 User Data | Mandatory | +| 2.3.2 Link Status | Mandatory | +| 2.3.2.1 Link Status Proving | Mandatory | +| 3 State Control | Heading | +| 3.1 SCTP Association State Control | Descriptive text | +| 3.2 M2PA Link State Control | Descriptive text | +| 4 Procedures | Mandatory | +| 4.1 Procedures to Support MTP2 Feature | Heading | +| 4.1.1 Signal Unit Format, Delimitation, Acceptance | Descriptive text | +| 4.1.2 MTP and SCTP Entities |

The content about how M2PA relates MTP and SCTP entities is Descriptive text.

The relationship between the streams of SCTP and M2PA Messages is mandatory.

| +| 4.1.3 Link Alignment | The procedure is Mandatory. | +| 4.1.4 Processor Outage | Mandatory | +| 4.1.5 Level 2 Flow Control | Mandatory | +| 4.1.6 Link Out of Service | Mandatory | +| 4.1.7 SCTP Association Problems | Mandatory | +| 4.1.8 Transmission and Reception Priorities | Mandatory | +| 4.1.9 M2PA Version Control | Mandatory | +| 4.2. Procedures to Support the MTP3/MTP2 Interface | Heading | +| 4.2.1 Sending and Receiving Messages | Mandatory | +| 4.2.2 MTP3 Signaling Link Congestion | Mandatory | +| 4.2.3 Changeover | Mandatory | +| 4.2.3.1 Multiple User Data Streams and Changeover | Descriptive text | +| 4.3 SCTP Considerations | Descriptive text | +| 4.3.1 SCTP Slow Start |

Descriptive text

Avoiding the negative effects of slow start is Mandatory.

| + +| Section number in M2PA RFC | Comments | +|--------------------------------------------|------------------| +| 5 Examples of M2PA Procedures | Descriptive text | +| 5.1 Link Initialization (Alignment) | Descriptive text | +| 5.2 Message Transmission and Reception | Descriptive text | +| 5.3 Link Status Indication | Descriptive text | +| 5.4 Link Status Message (Processor Outage) | Descriptive text | +| 5.5 Level 2 Flow Control | Descriptive text | +| 5.6 MTP3 Signaling Link Congestion | Descriptive text | +| 5.7. Link Deactivation | Descriptive text | +| 5.8 Link Changeover | Descriptive text | + +# Annex C (informative): Change history + +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | New | +|----------|--------|-----------|------|-----|--------------------------------------------------------------------------------------------------------|--------| +| Feb 2001 | | | | | Initial draft | 0.0.2 | +| Feb 2001 | | | | | Second draft | 0.1.0 | +| Feb 2001 | | | | | Contributions and comments from TSG-CN WG4#6.1 Madrid Ad Hoc incorporated | 0.2.0 | +| Feb 2001 | | | | | Contributions and comments from TSG-CN WG4#6.1 Madrid Ad Hoc incorporated and draft further elaborated | 2.0.0 | +| Mar 2001 | | | | | Comments from TSG-CN WG4#7 incorporated. | 2.1.0 | +| Mar 2001 | CN#11 | NP-010079 | | | Annex A: M3UA updated to the latest available version 6 Approved in CN#11 | 4.0.0 | +| May 2001 | | | | | Foreword added | 4.0.1 | +| Sep 2001 | CN#13 | NP-010452 | 001 | | Change of M 3UA version | 4.1.0 | +| Sep 2001 | CN#13 | | | | Editorial clean up | 4.1.0 | +| Jun 2002 | CN#16 | | | | Corrupted Figure 5.3/1 fixed | 4.1.1 | +| Jun 2002 | CN#16 | | | | Rel-5 created after CN#16 | 5.0.0 | +| Sep 2002 | CN#17 | NP-020445 | 003 | 1 | Add reference to new IETF RFC on SCTP Checksum | 5.1.0 | +| Dec 2002 | CN#18 | NP-020585 | 007 | 2 | M3UA for 3GPP networks | 5.2.0 | +| Dec 2002 | CN#18 | NP-020585 | 009 | | IETF RFC reference for M3UA | 5.2.0 | +| Dec 2004 | CN#26 | | | | Rel-6 created after CN#26 | 6.0.0 | +| Jun 2007 | CT#36 | | | | Upgraded unchanged from Rel-6 | 7.0.0 | +| Jun 2007 | CT#36 | CP-070330 | 0013 | 3 | Use of M2PA in 3GPP core network signalling system | 8.0.0 | +| Sep 2007 | CT#37 | CP-070545 | 0014 | 2 | Protocol conformance to RFC4165(M2PA) | 8.1.0 | +| Sep 2007 | CT#37 | CP-070545 | 0015 | 2 | Change of protocol conformance to M3UA | 8.1.0 | +| Dec 2008 | CT#42 | | | | Copyright Notification updated | 8.1.1 | +| 2009-12 | - | - | - | - | Update to Rel-9 version (MCC) | 9.0.0 | +| 2011-03 | - | - | - | - | Update to Rel-10 version (MCC) | 10.0.0 | +| 2011-03 | CT#52 | CP-110371 | 0016 | | Removing reference to draft-ietf-sigtran-m3ua-implementors-guide-01 | 10.1.0 | +| 2012-09 | - | - | - | - | Update to Rel-11 version (MCC) | 11.0.0 | +| 2014-09 | - | - | - | - | Update to Rel-12 version (MCC) | 12.0.0 | +| 2015-12 | CT#70 | - | - | - | Update to Rel-13 version (MCC) | 13.0.0 | +| 2017-03 | CT#75 | - | - | - | Update to Rel-14 version (MCC) | 14.0.0 | +| 2018-06 | CT#80 | - | - | - | Update to Rel-15 version (MCC) | 15.0.0 | +| 2020-07 | CT#88e | - | - | - | Update to Rel-16 version (MCC) | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29204/088921fa3f5a44c8551815122517eefd_img.jpg b/marked/Rel-16/29_series/29204/088921fa3f5a44c8551815122517eefd_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..94e7ddc27139ef46286bdc46abb48e84b1cb78c6 --- /dev/null +++ b/marked/Rel-16/29_series/29204/088921fa3f5a44c8551815122517eefd_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1df334847fe5d0be3e862f97bf36031af96619bbd02f336a89903768a61aca32 +size 82256 diff --git a/marked/Rel-16/29_series/29204/08c7a76a7786bd08b99dd4cb41583ef4_img.jpg b/marked/Rel-16/29_series/29204/08c7a76a7786bd08b99dd4cb41583ef4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..109a7b2e8ebfc99981f9735ab02363a7c23ee7ea --- /dev/null +++ b/marked/Rel-16/29_series/29204/08c7a76a7786bd08b99dd4cb41583ef4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:26b81e468be6612b26928b7eb4d2c2cab0059307cd99ceca63be9bc8c842c990 +size 36341 diff --git a/marked/Rel-16/29_series/29204/0b87abe67b21a93777287649c33e755d_img.jpg b/marked/Rel-16/29_series/29204/0b87abe67b21a93777287649c33e755d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..dc7793304db7d12e9a3efd3eecdd78ea673e344f --- /dev/null +++ b/marked/Rel-16/29_series/29204/0b87abe67b21a93777287649c33e755d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3da1188d50ea186818580ca733e141f1a24508623426d0f9a3c4688c06991e9b +size 67665 diff --git a/marked/Rel-16/29_series/29204/1a827b10290f33d4fec04d0e8ef7a897_img.jpg b/marked/Rel-16/29_series/29204/1a827b10290f33d4fec04d0e8ef7a897_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3799686114eee6e117f546906d648757008d63b6 --- /dev/null +++ b/marked/Rel-16/29_series/29204/1a827b10290f33d4fec04d0e8ef7a897_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e6b16681e53554f5fb504d1297b5f6f09f53e0507e09313af850dc19cca5035a +size 82056 diff --git a/marked/Rel-16/29_series/29204/26d664119ad25250780f554633444e54_img.jpg b/marked/Rel-16/29_series/29204/26d664119ad25250780f554633444e54_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7ace3e96f9a656b62935eee2c5fe0d20adf5162b --- /dev/null +++ b/marked/Rel-16/29_series/29204/26d664119ad25250780f554633444e54_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:884d097ea545accb61c51c5db4835c8f676d9d8fa0cfd7ed973c66939f177c99 +size 72912 diff --git a/marked/Rel-16/29_series/29204/49ee89a1d5852ab005dbbab6de09a8a6_img.jpg b/marked/Rel-16/29_series/29204/49ee89a1d5852ab005dbbab6de09a8a6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b635b999bcbe12ae5578d97d185d5ca0c16137c6 --- /dev/null +++ b/marked/Rel-16/29_series/29204/49ee89a1d5852ab005dbbab6de09a8a6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1a631c2b288b70963dbcf661fdd2c9c22f3ae60d8529be71733a2f0b72dd3d00 +size 53806 diff --git a/marked/Rel-16/29_series/29204/5860ad6bd2a2dd8d1ab12864b8f90f37_img.jpg b/marked/Rel-16/29_series/29204/5860ad6bd2a2dd8d1ab12864b8f90f37_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..dd4119d3f3faa99545bb92c85e182ec98ecffe36 --- /dev/null +++ b/marked/Rel-16/29_series/29204/5860ad6bd2a2dd8d1ab12864b8f90f37_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c0c556159292eb30b2dd51d65ce873ca74e5652a14ba16e159756b177b803667 +size 54159 diff --git a/marked/Rel-16/29_series/29204/5a4e62bead259c258d069fd3663ea670_img.jpg b/marked/Rel-16/29_series/29204/5a4e62bead259c258d069fd3663ea670_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9d404cbd24fc4357d50dd2bc17cc81c77389a890 --- /dev/null +++ b/marked/Rel-16/29_series/29204/5a4e62bead259c258d069fd3663ea670_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:beeb7f8c063755f3d8b23917bb4db53d6f6ca6881336458fce58ca83032cb508 +size 69934 diff --git a/marked/Rel-16/29_series/29204/6629e8a87e7552e2454b7c3e9f6d73a0_img.jpg b/marked/Rel-16/29_series/29204/6629e8a87e7552e2454b7c3e9f6d73a0_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d79378664d3ad92b41a0879157081344e7e9a445 --- /dev/null +++ b/marked/Rel-16/29_series/29204/6629e8a87e7552e2454b7c3e9f6d73a0_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cd2e5bc191b052b7b5fa0165f540d6fc775317d1672841f7d87da8465cb82bc8 +size 33166 diff --git a/marked/Rel-16/29_series/29204/79e1709a7317ead45379cbb8ff3ba802_img.jpg b/marked/Rel-16/29_series/29204/79e1709a7317ead45379cbb8ff3ba802_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c27ac7391bc7cf6ea0212ef6ab58d7b8d8d0e683 --- /dev/null +++ b/marked/Rel-16/29_series/29204/79e1709a7317ead45379cbb8ff3ba802_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6e180e019fbd2166d280285e1bb1f9ecc5c28a52fabee332da2ca67d59c2a457 +size 104621 diff --git a/marked/Rel-16/29_series/29204/7efae06af3af43ffe5d4b956a679cf54_img.jpg b/marked/Rel-16/29_series/29204/7efae06af3af43ffe5d4b956a679cf54_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3bc7aa7327cbb8d10781217bc4e3ad3597eedb85 --- /dev/null +++ b/marked/Rel-16/29_series/29204/7efae06af3af43ffe5d4b956a679cf54_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:832fe8d7c19f1e36c3672d9607f49e0a74721333e2702971218b5dcd95a9d92a +size 83725 diff --git a/marked/Rel-16/29_series/29204/7f17c430b9598e4d748a8041457810b3_img.jpg b/marked/Rel-16/29_series/29204/7f17c430b9598e4d748a8041457810b3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f6315e9e9916f88f85268c57f306638dbe798ff0 --- /dev/null +++ b/marked/Rel-16/29_series/29204/7f17c430b9598e4d748a8041457810b3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d4e146977ef4ec21b10c624413a58935cd5bee0518563062ab3217138e6ff2dc +size 72387 diff --git a/marked/Rel-16/29_series/29204/8307f6b04df072c9332f9987e034272c_img.jpg b/marked/Rel-16/29_series/29204/8307f6b04df072c9332f9987e034272c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1ab835f5948f3e05ae060050588b06c28da89b46 --- /dev/null +++ b/marked/Rel-16/29_series/29204/8307f6b04df072c9332f9987e034272c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:119cc7323fa6dbb57855c11ac2c28dff6d09f3ef5e6275afbcad9fdd9c98c3e6 +size 100345 diff --git a/marked/Rel-16/29_series/29204/8e14350b4b669119a3bdfca7869110ca_img.jpg b/marked/Rel-16/29_series/29204/8e14350b4b669119a3bdfca7869110ca_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b96f0851267852f4c05b1aad9aa2a60475953cf6 --- /dev/null +++ b/marked/Rel-16/29_series/29204/8e14350b4b669119a3bdfca7869110ca_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:00e1fd3fe0c6203932a64ffcfc95e0e60b7f3277b4207a6b5cfe4c12d31e58b5 +size 70841 diff --git a/marked/Rel-16/29_series/29204/8fa679f79a1bb1f527cba9f29e784e89_img.jpg b/marked/Rel-16/29_series/29204/8fa679f79a1bb1f527cba9f29e784e89_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a924c281bfe715fb9dd7a9df4e6f214fde3414ea --- /dev/null +++ b/marked/Rel-16/29_series/29204/8fa679f79a1bb1f527cba9f29e784e89_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:052a48fb8169559b2142c01bd072a192249d923fda7728e351a583bcbd5b2f52 +size 93128 diff --git a/marked/Rel-16/29_series/29204/9791722d75115ddcc599b07d7bc35d73_img.jpg b/marked/Rel-16/29_series/29204/9791722d75115ddcc599b07d7bc35d73_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f45af4642a26637e81e1ce13eb14178129a67c53 --- /dev/null +++ b/marked/Rel-16/29_series/29204/9791722d75115ddcc599b07d7bc35d73_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2d0e72348415bde4d561515b2785a315448c089c6cde6a0c2896be84d863d6b1 +size 50911 diff --git a/marked/Rel-16/29_series/29204/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg b/marked/Rel-16/29_series/29204/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e0b8b6f1bfcefe56bd2657438b6b3427179637de --- /dev/null +++ b/marked/Rel-16/29_series/29204/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d19eef58e709fa9aabe1e43bf6ccb612ddfc2789edc1296848b1f9fd3b3c1afa +size 93048 diff --git a/marked/Rel-16/29_series/29204/ae53f90bb87d6d09e2d6b5278d7c338f_img.jpg b/marked/Rel-16/29_series/29204/ae53f90bb87d6d09e2d6b5278d7c338f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ea7152bdb5a2a480f2674b5eadc3dbb798d2cece --- /dev/null +++ b/marked/Rel-16/29_series/29204/ae53f90bb87d6d09e2d6b5278d7c338f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d5f8c9644b82e69b5ba3224a560ab744859e768a5334aa31a12dea443bf11ee7 +size 64191 diff --git a/marked/Rel-16/29_series/29204/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg b/marked/Rel-16/29_series/29204/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..970688db3271216ec4c9ff03086760f4fba4c65e --- /dev/null +++ b/marked/Rel-16/29_series/29204/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:75ee1482e2b319b465b6bf6a3b9b04290a4a3b0052b7c7daad646501d9daa8b5 +size 55025 diff --git a/marked/Rel-16/29_series/29204/daa4a6fa7e2ba1954258f86b4928eb32_img.jpg b/marked/Rel-16/29_series/29204/daa4a6fa7e2ba1954258f86b4928eb32_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4561639e3f023fb3df66db087569900723a3ff0c --- /dev/null +++ b/marked/Rel-16/29_series/29204/daa4a6fa7e2ba1954258f86b4928eb32_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f9a068f57805e185d26d05c4d3e5a5a7014fe4f822e222fdc174f933fdbdc28e +size 68883 diff --git a/marked/Rel-16/29_series/29204/e180f2b5fcbe8001554a7c0677cd3f82_img.jpg b/marked/Rel-16/29_series/29204/e180f2b5fcbe8001554a7c0677cd3f82_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c4a6421d425dbbb8c1560dc1ae28554062fef00a --- /dev/null +++ b/marked/Rel-16/29_series/29204/e180f2b5fcbe8001554a7c0677cd3f82_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ae0655bb2b2c780042a149208ad6da8cba60c38a8b58ab83a8a1b28951c8eb8f +size 88585 diff --git a/marked/Rel-16/29_series/29204/e821c3d8a87ee2a9ff6b8644ffe6bdae_img.jpg b/marked/Rel-16/29_series/29204/e821c3d8a87ee2a9ff6b8644ffe6bdae_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..aca8cb499696df0dad7bd0c377f50660921dbfb0 --- /dev/null +++ b/marked/Rel-16/29_series/29204/e821c3d8a87ee2a9ff6b8644ffe6bdae_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7b272b7aa49319f9c944d538e8a57271e8acb40334583dae298ae0f1861dd235 +size 65794 diff --git a/marked/Rel-16/29_series/29204/ff0952ef692c9d960ce5f6708bcc9711_img.jpg b/marked/Rel-16/29_series/29204/ff0952ef692c9d960ce5f6708bcc9711_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..cd008e7b80f73151b3ad89102c252de3f93aba07 --- /dev/null +++ b/marked/Rel-16/29_series/29204/ff0952ef692c9d960ce5f6708bcc9711_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:386d4d5702f988597a499adb0053a81e3c7583b753b59446f1b971267e8ee15f +size 57856 diff --git a/marked/Rel-16/29_series/29204/raw.md b/marked/Rel-16/29_series/29204/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..8c03dc64a85159bd73c3ce27c0a5b5f1722a777d --- /dev/null +++ b/marked/Rel-16/29_series/29204/raw.md @@ -0,0 +1,1102 @@ + + + + + + +# --- Contents + +| | | +|--------------------------------------------------------------------------|----| +| Foreword ..... | 4 | +| Introduction ..... | 4 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Definitions and abbreviations ..... | 5 | +| 3.1 Definitions..... | 5 | +| 3.2 Abbreviations ..... | 6 | +| 4 Network architecture..... | 6 | +| 4.1 Scenarios ..... | 6 | +| 4.1.1 Outbound traffic (not yet protected) from own to foreign NE ..... | 7 | +| 4.1.2 Inbound traffic from foreign to own NE ..... | 7 | +| 4.1.3 Inbound transit traffic ..... | 8 | +| 4.1.4 Outbound transit traffic (not relayed)..... | 9 | +| 4.1.5 Outbound traffic from own to own NE ..... | 9 | +| 4.1.6 Inbound traffic from own to own NE ..... | 10 | +| 4.1.7 Outbound traffic from foreign to own NE..... | 11 | +| 4.1.8 Inbound traffic from own to foreign NE ..... | 11 | +| 4.1.9 Outbound traffic (already protected) from own to foreign NE ..... | 12 | +| 4.1.10 Outbound transit traffic (relayed by SRF)..... | 13 | +| 5 Detailed Behaviour of the SS7 Security Gateway ..... | 13 | +| 5.1 TCAP user traffic ..... | 13 | +| 5.1.1 General ..... | 13 | +| 5.1.2 Interactions with Mobile Number Portability..... | 28 | +| 5.1.3 Interactions with SCCP segmentation..... | 28 | +| 5.1.4 Protocol details ..... | 29 | +| 5.1.4.1 Transformation of unprotected message to protected message ..... | 29 | +| 5.1.4.2 Transformation of protected message to unprotected message ..... | 33 | +| 5.1.4.3 Handling of received XUDTS messages and UDTs messages ..... | 36 | +| Annex A (informative): Change history..... | 39 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The absence of security in Signalling System No. 7 (SS7) networks is an identified security weakness in 2G systems. This was formerly perceived not to be a problem, since the SS7 networks were the provinces of a small number of large institutions. This is no longer the case, and so there is now a need for security precautions. + +For 3G systems it is a clear goal to be able to protect inter-network SS7 signalling protocols. The protection is done by security gateways which are located at the network border. As a consequence intra network SS7 signalling is not protected and network elements other than Security Gateways are not impacted. + +# --- 1 Scope + +The present document provides functional description of the SS7 Security Gateway. The document covers also network architecture, routing considerations, and protocol details. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. +- [1] 3GPP TS 29.002: "Mobile Application Part (MAP) specification". +- [2] 3GPP TS 29.078: "Customized Applications for Mobile network Enhanced Logic (CAMEL) Phase 4; CAMEL Application Part (CAP) specification". +- [3] ETSI ETS 300 358: "ISDN Completion of Calls to Busy Subscriber (CCBS) supplementary service; Functional capabilities and information flows". +- [4] 3GPP TS 23.066: "Support of GSM Mobile Number Portability (MNP) stage 2". +- [5] ITU-T Recommendation Q.773: "Specifications of Signalling System No.7; Transaction capabilities formats and encoding". +- [6] 3GPP TS 33.200: "3G Security; Network Domain Security (NDS); Mobile Application Part (MAP) application layer security". +- [7] ITU-T Recommendation E.164: "The international public telecommunication numbering plan". +- [8] 3GPP TS 33.204: "3G Security; Network Domain Security (NDS); Transaction Capabilities Application Part (TCAP) user security". +- [9] ITU-T Recommendations Q.711 to Q.716 (07/96), White Book Signalling Connection Control Part (SCCP). +- [10] 3GPP TS 21.905: "Vocabulary for 3GPP Specifications". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in TR 21.905 [10] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in TR 21.905 [10]. + +| | | +|------------|-----------------------------------------------------------------------------| +| TCAP user: | Application Part identified by one of the following SCCP Subsystem Numbers: | +| | 0000 0110 HLR (MAP) | +| | 0000 0111 VLR (MAP) | +| | 0000 1000 MSC (MAP) | +| | 0000 1001 EIR (MAP) | +| | 0000 1010 is allocated for evolution (possible Authentication Centre) | +| | 1001 0001 GMLC (MAP) | +| | 1001 0010 CAP | +| | 1001 0011 gsmSCF (MAP) or IM-SSF (MAP) or Presence Network Agent | + +| | | +|-----------|------------| +| 1001 0101 | SGSN (MAP) | +| 1001 0110 | GGSN (MAP) | +| 0000 1011 | SSAP | + +## 3.2 Abbreviations + +For the purposes of the present document, the following abbreviations apply: + +| | | +|--------|-----------------------------------------------------| +| CC | Country Code | +| GSMA | Global System for Mobile communications Association | +| IV | Initialisation Vector | +| MAC | Message Authentication Code | +| MNP | Mobile Number Portability | +| MSISDN | Mobile Station International ISDN Number | +| NDC | National Destination Code | +| NE | Network Entit | +| PLMN | Public Land Mobile Network y | +| RN | Routeing Number | +| SAD | Security Association Database | +| SEG | Security Gateway | +| SPD | Security Policy Database | +| SPI | Security Parameter Index | +| SRF | Signalling Relay Functio | +| TCAP | Transcation Capabilities Application Part | +| UDT | SCCP Unidata message | +| XUDT | SCCP Extended Unidata message n | + +# --- 4 Network architecture + +In a PLMN that employs SS7 Security Gateways all TCAP user signalling messages entering or leaving the PLMN have to transit an SS7 Security Gateway which belongs to the PLMN and which performs the protection of leaving (i.e. outbound) messages and the protection checking and de-protection or blocking of entering (i.e. inbound) messages. + +One or several SS7 Security Gateways may be employed within a PLMN. + +An SS7 Security Gateway may be co-located with any TCAP user NE or it may stand alone. However, for the purpose of this document and without imposing any restrictions, it is assumed that the SS7 Security Gateways is a stand alone entity. + +It is further assumed that the SS7 Security Gateways are located at the boarder of the PLMN i.e. inbound messages transit an SS7 Security Gateway before they reach any other node within the PLMN, and outbound messages transit an SS7 Security Gateway immediately before reaching a node outside the PLMN. + +SS7 routeing is not impacted by the SS7 Security Gateway Architecture. As a consequence SS7 Security Gateways are stateless at TCAP level: No TCAP dialogue states are maintained in the SS7 Security Gateway since the outbound dialogue request message may transit a different SS7 Security Gateway than the corresponding inbound dialogue response message; similarly the inbound dialogue request message may transit a different SS7 Security Gateway than the corresponding outbound dialogue response message. + +## 4.1 Scenarios + +SS7 Security Gateways perform protection, de-protection, blocking and unmodified passing of TCAP user messages depending on the scenario as described below: + +Note that scenarios 4.1.5, 4.1.6, 4.1.7, 4.1.8, and 4.1.9 are not applicable if all PLMN's TCAP user NEs are interconnected by PLMN internal signalling links and routing tables are set up not to allow these scenarios. + +### 4.1.1 Outbound traffic (not yet protected) from own to foreign NE + +This scenario is shown in figure 4.1.1. The message is originated at a NE inside the PLMN. It may transit several transit nodes inside the PLMN before it reaches the SS7 Security Gateway. This SS7 Security Gateway protects the message + +according to the relevant Security Policy with the relevant Security Association. The message may then transit several nodes outside the PLMN (including an SS7 Security Gateway) before it reaches its destination. + +![Diagram of outbound traffic from own to foreign NE](49ee89a1d5852ab005dbbab6de09a8a6_img.jpg) + +The diagram illustrates the flow of an unprotected TCAP user message from a TCAP user NE within a PLMN cloud. The message path is: TCAP user NE → Transit Node → SS7 Security Gateway. From the SS7 Security Gateway, the message is shown as a protected TCAP user message exiting the PLMN towards a destination. Two lines from the label 'unprotected TCAP user message' point to the message path between the TCAP user NE and the SS7 Security Gateway. + +Diagram of outbound traffic from own to foreign NE + +Figure 4.1.1: Outbound traffic (not yet protected) from own to foreign NE + +### 4.1.2 Inbound traffic from foreign to own NE + +This scenario is shown in figure 4.1.2. The message is originated at a NE outside the PLMN. It may transit several transit nodes (including an SS7 Security Gateway) outside the PLMN before it reaches the PLMN's SS7 Security Gateway. This SS7 Security Gateway checks whether the message is correctly protected according to the relevant security association. If it is not, the message is blocked (discarded), otherwise it is de-protected. To determine the relevant security association the fact that the message may have been relayed by an MNP-SRF in a transit network (see Clause 4.1.10 and 5.1.2) needs to be taken into account. After successful de-protection the message may then transit several nodes inside the PLMN before it reaches the TCAP user NE. + +![Diagram of inbound traffic from foreign to own NE](9791722d75115ddcc599b07d7bc35d73_img.jpg) + +The diagram illustrates the flow of a protected TCAP user message from an origin outside the PLMN. The message path is: from origin → SS7 Security Gateway → Transit Node → TCAP user NE. The message is shown as a protected TCAP user message entering the PLMN through the SS7 Security Gateway. Two lines from the label 'unprotected TCAP user message' point to the message path between the SS7 Security Gateway and the TCAP user NE. + +Diagram of inbound traffic from foreign to own NE + +Figure 4.1.2: Inbound traffic from foreign to own NE + +### 4.1.3 Inbound transit traffic + +This scenario is shown in figure 4.1.3. The message is originated at a NE outside the transit PLMN. It may transit several transit nodes outside the transit PLMN before it reaches the SS7 Security Gateway in inbound direction. This SS7 Security Gateway passes the message unmodified. The message may then transit several transit nodes inside the transit PLMN, another SS7 Security Gateway of the transit PLMN in outbound direction (see Clause 4.1.4), and several transit nodes outside the transit and destination PLMN (potentially including an SS7 Security Gateway) before it reaches the destination PLMN. + +Note: A PLMN operator may decide not to act as transit network for specific or all combinations of origin and destination. In this case the SS7 Security Gateway may block the inbound message. + +![Diagram of Inbound transit traffic](5860ad6bd2a2dd8d1ab12864b8f90f37_img.jpg) + +The diagram illustrates the flow of inbound transit traffic within a PLMN. An orange cloud represents the PLMN. An arrow labeled 'from origin' points to a red box labeled 'SS7 Security Gateway' located outside the cloud. From this gateway, an arrow points into the cloud to a cyan box labeled 'Transit Node'. From the 'Transit Node', an arrow points to a blue box labeled 'SS7 SEG' located at the bottom of the cloud. An arrow labeled 'to destination' points from the 'SS7 SEG' out of the cloud. A label 'protected or unprotected TCAP user message' is shown with lines pointing to the arrows entering and leaving the 'SS7 Security Gateway' and the 'SS7 SEG'. + +Diagram of Inbound transit traffic + +Figure 4.1.3: Inbound transit traffic + +### 4.1.4 Outbound transit traffic (not relayed) + +This scenario is shown in figure 4.1.4. The message is originated at a NE outside the transit PLMN. It may transit several transit nodes outside the transit PLMN (including an SS7 Security Gateway), an SS7 Security Gateway of the transit PLMN in inbound direction (see Clause 4.1.3), and several transit nodes inside the transit PLMN before it reaches the SS7 Security Gateway in outbound direction. This SS7 Security Gateway passes the message unmodified. The message may then transit several transit nodes outside the transit and destination PLMN (potentially including an SS7 Security Gateway) before it reaches the destination PLMN. + +![Figure 4.1.4: Outbound transit traffic (not relayed). A diagram showing a message path within a PLMN cloud. The path starts from an origin, goes to an SS7 SEG, then to a Transit Node, and finally to an SS7 Security Gateway, which then points to the destination. Labels include 'from origin', 'protected or unprotected TCAP user message', 'PLMN', 'SS7 SEG', 'Transit Node', 'SS7 Security Gateway', and 'to destination'.](b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg) + +The diagram illustrates the flow of outbound transit traffic within a PLMN. An arrow labeled 'from origin' points to an 'SS7 SEG' box. From the 'SS7 SEG', an arrow points to a 'Transit Node' box. From the 'Transit Node', an arrow points to an 'SS7 Security Gateway' box. From the 'SS7 Security Gateway', an arrow points to 'to destination'. A label 'protected or unprotected TCAP user message' has lines pointing to the arrows between the 'SS7 SEG' and 'Transit Node', and between the 'Transit Node' and 'SS7 Security Gateway'. The entire path is contained within an orange cloud labeled 'PLMN'. + +Figure 4.1.4: Outbound transit traffic (not relayed). A diagram showing a message path within a PLMN cloud. The path starts from an origin, goes to an SS7 SEG, then to a Transit Node, and finally to an SS7 Security Gateway, which then points to the destination. Labels include 'from origin', 'protected or unprotected TCAP user message', 'PLMN', 'SS7 SEG', 'Transit Node', 'SS7 Security Gateway', and 'to destination'. + +Figure 4.1.4: Outbound transit traffic (not relayed) + +### 4.1.5 Outbound traffic from own to own NE + +This scenario is shown in figure 4.1.5. The message is originated at a NE inside the PLMN. It may transit several transit nodes inside the PLMN before it reaches the SS7 Security Gateway in outbound direction. This SS7 Security Gateway protects the message according to the relevant Security Association. The message may then transit several transit nodes outside the PLMN, another SS7 Security Gateway of the PLMN in inbound direction (see Clause 4.1.6) and several transit nodes within the PLMN before it reaches the destination NE inside the PLMN. + +![Figure 4.1.5: Outbound traffic from own to own NE. A diagram showing a message path within a PLMN cloud. Two 'TCAP user NE' boxes point to 'Transit Node' boxes. One 'Transit Node' points to an 'SS7 Security Gateway' box, which then points to another 'Transit Node' box outside the PLMN cloud. The second 'Transit Node' points to an 'SS7 SEG' box, which then points to another 'Transit Node' box inside the PLMN cloud. The second 'Transit Node' points to a 'TCAP user NE' box. Labels include 'unprotected TCAP user message', 'PLMN', 'TCAP user NE', 'Transit Node', 'SS7 Security Gateway', 'SS7 SEG', and 'protected TCAP user message'.](0b87abe67b21a93777287649c33e755d_img.jpg) + +The diagram illustrates the flow of outbound traffic from an own NE to another own NE within a PLMN. Two yellow boxes labeled 'TCAP user NE' are inside an orange cloud labeled 'PLMN'. Arrows from these boxes point to blue boxes labeled 'Transit Node'. One 'Transit Node' points to a red box labeled 'SS7 Security Gateway'. An arrow from the 'SS7 Security Gateway' points to a blue box labeled 'Transit Node' outside the cloud. From this 'Transit Node', an arrow points to a blue box labeled 'SS7 SEG'. From the 'SS7 SEG', an arrow points to a blue box labeled 'Transit Node' inside the cloud. From this 'Transit Node', an arrow points to a yellow box labeled 'TCAP user NE'. A label 'unprotected TCAP user message' has lines pointing to the arrows between the 'TCAP user NE' boxes and the 'Transit Node' boxes. A label 'protected TCAP user message' has lines pointing to the arrows between the 'SS7 Security Gateway' and the 'Transit Node' box outside the cloud, and between the 'SS7 SEG' and the 'Transit Node' box inside the cloud. + +Figure 4.1.5: Outbound traffic from own to own NE. A diagram showing a message path within a PLMN cloud. Two 'TCAP user NE' boxes point to 'Transit Node' boxes. One 'Transit Node' points to an 'SS7 Security Gateway' box, which then points to another 'Transit Node' box outside the PLMN cloud. The second 'Transit Node' points to an 'SS7 SEG' box, which then points to another 'Transit Node' box inside the PLMN cloud. The second 'Transit Node' points to a 'TCAP user NE' box. Labels include 'unprotected TCAP user message', 'PLMN', 'TCAP user NE', 'Transit Node', 'SS7 Security Gateway', 'SS7 SEG', and 'protected TCAP user message'. + +Figure 4.1.5: Outbound traffic from own to own NE + +### 4.1.6 Inbound traffic from own to own NE + +This scenario is shown in figure 4.1.6. The message is originated at a NE inside the PLMN. It may transit several transit nodes inside the PLMN, an SS7 Security Gateway of the PLMN in outbound direction (see Clause 4.1.5), and several + +transit nodes outside the PLMN before it reaches the SS7 Security Gateway in inbound direction. This SS7 Security Gateway checks whether the message is correctly protected according to the relevant Security Association. If it is not, the message is blocked (discarded), otherwise it is de-protected. The message may then transit several transit nodes inside the PLMN before it reaches the destination NE inside the PLMN. + +![Diagram of inbound traffic from own to own NE within a PLMN.](daa4a6fa7e2ba1954258f86b4928eb32_img.jpg) + +The diagram illustrates the flow of an unprotected TCAP user message within a PLMN. Two yellow boxes labeled 'TCAP user NE' are shown inside an orange cloud representing the PLMN. Arrows from these boxes point to cyan boxes labeled 'Transit Node'. From the top 'Transit Node', an arrow points to a purple box labeled 'SS7 SEG'. From the 'SS7 SEG', a red arrow points to another cyan 'Transit Node' outside the PLMN. From this external 'Transit Node', a red arrow points to a red box labeled 'SS7 Security Gateway'. From the 'SS7 Security Gateway', a red arrow points back to the external 'Transit Node', and then a red arrow points back into the PLMN to the bottom 'Transit Node'. Finally, an arrow points from the bottom 'Transit Node' to the bottom 'TCAP user NE'. The text 'unprotected TCAP user message' is on the left, and 'protected TCAP user message' is on the right, indicating the state of the message after passing through the security gateway. + +Diagram of inbound traffic from own to own NE within a PLMN. + +Figure 4.1.6: Inbound traffic from own to own NE + +### 4.1.7 Outbound traffic from foreign to own NE + +This scenario is shown in figure 4.1.7. The message is originated at a NE outside the PLMN. It may transit several transit nodes outside the PLMN, an SS7 Security Gateway of the PLMN in inbound direction (see Clause 4.1.2), and several transit nodes inside the PLMN before it reaches the SS7 Security Gateway in outbound direction. This SS7 Security Gateway protects the message according to the reverse relevant Security Association. The message may then transit several transit nodes outside the PLMN, another SS7 Security Gateway of the PLMN in inbound direction (see Clause 4.1.2) and several transit nodes within the PLMN before it reaches the destination NE inside the PLMN. + +![Diagram of outbound traffic from foreign to own NE](5a4e62bead259c258d069fd3663ea670_img.jpg) + +This diagram illustrates the flow of outbound traffic from a foreign network element (NE) to an own NE within a PLMN. The PLMN is represented by an orange cloud. The traffic path is as follows: an arrow labeled 'from origin' points to an external SS7 SEG; from the SS7 SEG, a black arrow points to a Transit Node inside the PLMN; from this Transit Node, a black arrow points to an SS7 Security Gateway; from the SS7 Security Gateway, a red arrow points to another external Transit Node; from this external Transit Node, a red arrow points to another external SS7 SEG; from this SS7 SEG, a black arrow points to a second Transit Node inside the PLMN; from this second Transit Node, a black arrow points to a TCAP user NE. A white box labeled 'unprotected TCAP user message' is positioned near the first Transit Node, and a white box labeled 'protected TCAP user message' is positioned near the second SS7 SEG. + +Diagram of outbound traffic from foreign to own NE + +Figure 4.1.7: Outbound traffic from foreign to own NE + +### 4.1.8 Inbound traffic from own to foreign NE + +This scenario is shown in figure 4.1.8. The message is originated at a NE inside the PLMN. It may transit several transit nodes inside the PLMN, an SS7 Security Gateway of the PLMN in outbound direction (see Clause 4.1.1), and several transit nodes outside the PLMN before it reaches the SS7 Security Gateway in inbound direction. This SS7 Security Gateway checks whether the message is correctly protected according to the relevant security association. If it is not, the message is blocked (discarded); otherwise it is passed unmodified. The message may then transit several transit nodes inside the PLMN, another SS7 Security Gateway of the PLMN in outbound direction (see Clause 4.1.9) and several transit nodes outside the PLMN (including an SS7 Security Gateway) before it reaches the destination NE outside the PLMN. + +![Diagram of inbound traffic from own to foreign NE](8e14350b4b669119a3bdfca7869110ca_img.jpg) + +This diagram illustrates the flow of inbound traffic from an own NE to a foreign NE within a PLMN. The PLMN is represented by an orange cloud. The traffic path is as follows: a yellow box labeled 'TCAP user NE' sends a black arrow labeled 'unprotected TCAP user message' to a Transit Node inside the PLMN; from this Transit Node, a black arrow points to an SS7 SEG; from the SS7 SEG, a red arrow points to an external Transit Node; from this external Transit Node, a red arrow points to an SS7 Security Gateway; from the SS7 Security Gateway, a red arrow points to another external Transit Node; from this external Transit Node, a red arrow points to another external SS7 SEG; from this SS7 SEG, a black arrow points to a second Transit Node inside the PLMN; from this second Transit Node, a black arrow points to an arrow labeled 'to destination'. A white box labeled 'protected TCAP user message' is positioned near the second SS7 SEG. + +Diagram of inbound traffic from own to foreign NE + +Figure 4.1.8: Inbound traffic from own to foreign NE + +### 4.1.9 Outbound traffic (already protected) from own to foreign NE + +This scenario is shown in figure 4.1.9. The message is originated at a NE inside the PLMN. It may transit several transit nodes inside the PLMN, an SS7 Security Gateway of the PLMN in outbound direction (see Clause 4.1.1), several transit nodes outside the PLMN, an SS7 Security Gateway of the PLMN in inbound direction (see Clause 4.1.8), and several transit nodes inside the PLMN before it reaches the SS7 Security Gateway. This SS7 Security Gateway passes the message unmodified. The message may then transit several transit nodes outside the PLMN (including an SS7 Security Gateway) before it reaches the destination NE outside the PLMN. + +![Diagram of outbound traffic (already protected) from own to foreign NE](7f17c430b9598e4d748a8041457810b3_img.jpg) + +The diagram illustrates the path of a TCAP user message within a PLMN (represented by an orange cloud). A yellow box labeled 'TCAP user NE' originates an 'unprotected TCAP user message' (black arrow). The message flows through a 'Transit Node' (cyan box) to an 'SS7 SEG' (purple box). From the SS7 SEG, it passes through another 'Transit Node' and then to a second 'SS7 Security Gateway' (purple box with a red border). The message is then shown as a 'protected TCAP user message' (red arrow) exiting the PLMN towards the 'destination'. + +Diagram of outbound traffic (already protected) from own to foreign NE + +Figure 4.1.9: Outbound traffic (already protected) from own to foreign NE + +### 4.1.10 Outbound transit traffic (relayed by SRF) + +This scenario is shown in figure 4.1.10. The message (originally destined for the PLMN) is originated at a NE outside the transit PLMN. It may transit several transit nodes outside the transit PLMN (including an SS7 Security Gateway), an SS7 Security Gateway of the transit PLMN in inbound direction (see Clause 4.1.2), several transit nodes inside the transit PLMN, and an MNP-SRF which replaces the SCCP called party address of the message before it reaches the SS7 Security Gateway in outbound direction. This SS7 Security Gateway recognizes that the message was relayed by an SRF by analyzing the SCCP called party address and protects the message with the relevant Security Association. The message may then transit several transit nodes outside the transit and destination PLMN (potentially including an SS7 Security Gateway) before it reaches the destination PLMN. + +![Diagram of outbound transit traffic relayed by SRF within a PLMN.](ff0952ef692c9d960ce5f6708bcc9711_img.jpg) + +The diagram illustrates the flow of outbound transit traffic within a PLMN (represented by an orange cloud). A red arrow labeled 'from origin' points to an 'SS7 SEG' (blue box). From the 'SS7 SEG', a black arrow points to an 'MNP SRF' (pink box). From the 'MNP SRF', a black arrow points to an 'SS7 Security Gateway' (blue box with a red border). A red arrow labeled 'to destination' exits the 'SS7 Security Gateway'. A line labeled 'protected TCAP user message' originates from the 'SS7 SEG' and points to the 'SS7 Security Gateway'. Another line labeled 'unprotected TCAP user message' originates from the 'MNP SRF' and points to the 'SS7 Security Gateway'. + +Diagram of outbound transit traffic relayed by SRF within a PLMN. + +Figure 4.1.10: Outbound transit traffic (relayed by SRF) + +# 5 Detailed Behaviour of the SS7 Security Gateway + +## 5.1 TCAP user traffic + +### 5.1.1 General + +With regard to TCAP user traffic the SS7 Security Gateway performs message protection, protection checking and de-protection, transparent passing, and blocking of messages depending on the message's origin (SCCP calling party address), the message's destination (SCCP called party address), and the message's direction (inbound or outbound) as shown in figure 5.1.1. + +![Flowchart for SS7 Security Gateway procedure. It starts with 'Idle', followed by 'TCAP user message', then 'Check direction'. It branches into 'INBOUND' (IN), 'OUTBOUND', and 'not crossing PLMN boundary' (pass). The 'IN' path leads to 'check origin and destination', which branches into 'own to own' (Inbound_own_to_own), 'own to foreign' (Inbound_own_to_foreign), 'foreign to own' (Inbound_foreign_to_own), and 'foreign to foreign' (pass). The first three paths lead to a 'result = block' decision, which branches into 'yes' (block) and 'no' (pass).](a33da0f14e456f92539ce3e9b7d81f9a_img.jpg) + +procedure SS7\_Security\_Gateway + +1(2) + +Procedure in the SS7 Security Gateway + +``` +graph TD; Idle([Idle]) --> TCAP[TCAP user message]; TCAP --> CheckDir[Check direction]; CheckDir --> INBOUND[INBOUND]; CheckDir --> OUTBOUND[OUTBOUND]; CheckDir --> NotCrossing[not crossing PLMN boundary]; INBOUND --> IN((IN)); OUTBOUND --> OUT((OUT)); NotCrossing --> Pass1((pass)); IN --> CheckOD[check origin and destination]; CheckOD --> OwnToOwn[own to own]; CheckOD --> OwnToForeign[own to foreign]; CheckOD --> ForeignToOwn[foreign to own]; CheckOD --> ForeignToForeign[foreign to foreign]; OwnToOwn --> InboundOwnToOwn[Inbound_own_to_own]; OwnToForeign --> InboundOwnToForeign[Inbound_own_to_foreign]; ForeignToOwn --> InboundForeignToOwn[Inbound_foreign_to_own]; ForeignToForeign --> Pass2((pass)); InboundOwnToOwn --> Result{result = block}; InboundOwnToForeign --> Result; InboundForeignToOwn --> Result; Result --> Yes[yes]; Result --> No[no]; Yes --> Block((block)); No --> Pass3((pass)); +``` + +Flowchart for SS7 Security Gateway procedure. It starts with 'Idle', followed by 'TCAP user message', then 'Check direction'. It branches into 'INBOUND' (IN), 'OUTBOUND', and 'not crossing PLMN boundary' (pass). The 'IN' path leads to 'check origin and destination', which branches into 'own to own' (Inbound\_own\_to\_own), 'own to foreign' (Inbound\_own\_to\_foreign), 'foreign to own' (Inbound\_foreign\_to\_own), and 'foreign to foreign' (pass). The first three paths lead to a 'result = block' decision, which branches into 'yes' (block) and 'no' (pass). + +Figure 5.1.1 Process SS7 Security Gateway (sheet 1 of 2) + +![Flowchart for SS7_Security_Gateway procedure. It starts with 'OUT', followed by 'check origin and destination'. A decision point branches into four cases: 'own to own' (Outbound_own_to_own), 'own to foreign' (Outbound_own_to_foreign), 'foreign to own' (Outbound_foreign_to_own), and 'foreign to foreign' (Outbound_foreign_to_foreign). All four cases lead to a 'pass' connector. Below this, a 'block' connector and a 'pass' connector (leading to 'TCAP user message') both lead to an 'Idle' terminal.](7efae06af3af43ffe5d4b956a679cf54_img.jpg) + +procedure SS7\_Security\_Gateway 2(2) + +Procedure in +the SS7 Security +Gateway + +``` +graph TD; OUT((OUT)) --> check[check origin and destination]; check --> own_to_own[own to own]; check --> own_to_foreign[own to foreign]; check --> foreign_to_own[foreign to own]; check --> foreign_to_foreign[foreign to foreign]; own_to_own --> Outbound_own_to_own[Outbound_own_to_own]; own_to_foreign --> Outbound_own_to_foreign[Outbound_own_to_foreign]; foreign_to_own --> Outbound_foreign_to_own[Outbound_foreign_to_own]; foreign_to_foreign --> Outbound_foreign_to_foreign[Outbound_foreign_to_foreign]; Outbound_own_to_own --> pass1((pass)); Outbound_own_to_foreign --> pass1; Outbound_foreign_to_own --> pass1; Outbound_foreign_to_foreign --> pass1; pass1 --> block((block)); pass1 --> pass2((pass)); pass2 --> TCAP[TCAP user message]; block --> Idle([Idle]); TCAP --> Idle; +``` + +Flowchart for SS7\_Security\_Gateway procedure. It starts with 'OUT', followed by 'check origin and destination'. A decision point branches into four cases: 'own to own' (Outbound\_own\_to\_own), 'own to foreign' (Outbound\_own\_to\_foreign), 'foreign to own' (Outbound\_foreign\_to\_own), and 'foreign to foreign' (Outbound\_foreign\_to\_foreign). All four cases lead to a 'pass' connector. Below this, a 'block' connector and a 'pass' connector (leading to 'TCAP user message') both lead to an 'Idle' terminal. + +Figure 5.1.1 Process SS7 Security Gateway (sheet 2 of 2) + +![Flowchart for macro Check_Direction. It starts with a connector, then a decision 'previous node belongs to own PLMN'. If 'yes', it goes to another decision 'next node belongs to own PLMN'. If 'yes', it ends at 'not crossing PLMN boundary' (OUTBOUND). If 'no', it ends at 'OUTBOUND'. If 'no' from the first decision, it goes to another decision 'next node belongs to own PLMN'. If 'yes', it ends at 'INBOUND'. If 'no', it ends at 'not crossing PLMN boundary'.](1a827b10290f33d4fec04d0e8ef7a897_img.jpg) + +macrodefinition Check\_Direction + +1(1) + +``` +graph TD; Start([ ]) --> D1{previous node belongs to own PLMN}; D1 -- yes --> D2{next node belongs to own PLMN}; D1 -- no --> D3{next node belongs to own PLMN}; D2 -- yes --> E1(( )); E1 --> O1[not crossing PLMN boundary]; O1 --> OUTBOUND[OUTBOUND]; D2 -- no --> OUTBOUND; D3 -- yes --> E2(( )); E2 --> INBOUND[INBOUND]; D3 -- no --> E3(( )); E3 --> O2[not crossing PLMN boundary]; +``` + +Flowchart for macro Check\_Direction. It starts with a connector, then a decision 'previous node belongs to own PLMN'. If 'yes', it goes to another decision 'next node belongs to own PLMN'. If 'yes', it ends at 'not crossing PLMN boundary' (OUTBOUND). If 'no', it ends at 'OUTBOUND'. If 'no' from the first decision, it goes to another decision 'next node belongs to own PLMN'. If 'yes', it ends at 'INBOUND'. If 'no', it ends at 'not crossing PLMN boundary'. + +Figure 5.1.2 Macro Check\_Direction (sheet 1 of 1) + +![Flowchart for macrodefinition Inbound_own_to_own](8307f6b04df072c9332f9987e034272c_img.jpg) + +macrodefinition Inbound\_own\_to\_own + +1(1) + +``` + +graph TD + Start([ ]) --> D1{message contains +protectable parameter} + D1 -- no --> P1((pass)) + D1 -- yes --> D2{message is +not protected} + + D2 -- yes --> D3{message should be +protected according +to SPD} + D3 -- no --> P2((pass)) + D3 -- yes --> D4{Fall Back allowed +according to SPD} + D4 -- yes --> P2 + D4 -- no --> B1((block)) + + D2 -- no --> D5{calling party address +consistent with SPI} + D5 -- no --> D6{protection mode +acceptable according +to SPD} + D5 -- yes --> D7{success} + + D6 -- no --> D7 + D6 -- yes --> Proc1[De-protect +message] + Proc1 --> D7 + + D7 -- no --> B1 + D7 -- yes --> P3((pass)) + +``` + +The flowchart titled 'macrodefinition Inbound\_own\_to\_own' (sheet 1 of 1) describes the logic for handling inbound messages. It starts with a check: 'message contains protectable parameter'. If 'no', it results in 'pass'. If 'yes', it checks if the 'message is not protected'. + +If the message is not protected ('yes' path), it checks if the 'message should be protected according to SPD'. If 'no', it results in 'pass'. If 'yes', it checks if 'Fall Back allowed according to SPD'. If 'yes', it results in 'pass'; if 'no', it results in 'block'. + +If the message is protected ('no' path from 'message is not protected'), it checks if the 'calling party address consistent with SPI'. If 'yes', it proceeds to a 'success' decision. If 'no', it checks if the 'protection mode acceptable according to SPD'. If 'no' to that, it proceeds to 'success'. If 'yes', it performs 'De-protect message' before checking 'success'. If the 'success' check is 'yes', it results in 'pass'; if 'no', it results in 'block'. + +Flowchart for macrodefinition Inbound\_own\_to\_own + +**Figure 5.1.3 Macro Inbound\_own\_to\_own (sheet 1 of 1)** + +The decision box "message contains protectable parameter" takes the "yes"-exit if user-information is present in the Dialogue Portion, or a parameter is present in an Invoke or ReturnError Component, or a result is present in a ReturnResult Component. + +The decision box "message is not protected" takes the "no"-exit if user-information within the Dialogue Portion is identified by the object identifier ss7-ProtectedDialogueAS or + +operationCode within an Invoke or ReturnResult Component takes the global value ss7-ProtectedDialogueAS or errorCode within an ReturnError Component takes the global value ss7-ProtectedDialogueAS. + +The decision box "message should be protected according to SPD" takes the "yes"-exit if the message's SCCP calling party address identifies a PLMN for which an SPD entry for incoming messages exists. + +The decision box "fall back allowed according to SPD" takes the "yes"-exit if the SPD entry for incoming messages is marked "fall back allowed". + +The decision box "calling party address consistent with SPI" takes the "yes"-exit if the SPI within the message's Security Header points to an SA that was negotiated with the PLMN derived from the message's SCCP calling party address. + +The decision box "protection mode acceptable according to SPD" takes the "yes"-exit if the protection mode within the message's Security Header is found in the SPD-entry for incoming messages. + +![Flowchart for macrodefinition Inbound_own_to_foreign. The process starts with an oval connector. The first decision is 'message contains protectable parameter'. If 'no', it goes to a 'pass' connector. If 'yes', it goes to the next decision 'message is not protected'. If 'no', it goes to a third decision 'called party address consistent with SPI'. If 'yes', it goes to a 'pass' connector. If 'no', it goes to a fourth decision 'protection mode correct'. If 'yes', it goes to a 'pass' connector. If 'no', it goes to a 'block' connector. The third decision 'message should be protected according to SPD' has a 'no' exit to the 'pass' connector and a 'yes' exit to the fourth decision 'Fall Back allowed according to SPD'. The fourth decision 'Fall Back allowed according to SPD' has a 'yes' exit to a 'pass' connector and a 'no' exit to the 'block' connector.](8fa679f79a1bb1f527cba9f29e784e89_img.jpg) + +macrodefinition Inbound\_own\_to\_foreign + +1(1) + +``` +graph TD; Start([ ]) --> D1{message contains protectable parameter}; D1 -- no --> P1((pass)); D1 -- yes --> D2{message is not protected}; D2 -- no --> D3{called party address consistent with SPI}; D2 -- yes --> D4{message should be protected according to SPD}; D4 -- no --> P2((pass)); D4 -- yes --> D5{Fall Back allowed according to SPD}; D5 -- yes --> P3((pass)); D5 -- no --> B1((block)); D3 -- yes --> P4((pass)); D3 -- no --> D6{protection mode correct}; D6 -- yes --> P5((pass)); D6 -- no --> B2((block)); +``` + +Flowchart for macrodefinition Inbound\_own\_to\_foreign. The process starts with an oval connector. The first decision is 'message contains protectable parameter'. If 'no', it goes to a 'pass' connector. If 'yes', it goes to the next decision 'message is not protected'. If 'no', it goes to a third decision 'called party address consistent with SPI'. If 'yes', it goes to a 'pass' connector. If 'no', it goes to a fourth decision 'protection mode correct'. If 'yes', it goes to a 'pass' connector. If 'no', it goes to a 'block' connector. The third decision 'message should be protected according to SPD' has a 'no' exit to the 'pass' connector and a 'yes' exit to the fourth decision 'Fall Back allowed according to SPD'. The fourth decision 'Fall Back allowed according to SPD' has a 'yes' exit to a 'pass' connector and a 'no' exit to the 'block' connector. + +**Figure 5.1.4 Macro Inbound\_own\_to\_foreign (sheet 1 of 1)** + +The decision box "message contains protectable parameter" takes the "yes"-exit if user-information is present in the Dialogue Portion, or a parameter is present in an Invoke or ReturnError Component, or a result is present in a ReturnResult Component. + +The decision box "message is not protected" takes the "no"-exit if user-information within the Dialogue Portion is identified by the object identifier ss7-ProtectedDialogueAS or + +operationCode within an Invoke or ReturnResult Component takes the global value ss7-ProtectedDialogueAS or errorCode within an ReturnError Component takes the global value ss7-ProtectedDialogueAS. + +The decision box "message should be protected according to SPD" takes the "yes"-exit if the message's SCCP called party address identifies a PLMN for which an SPD entry for outgoing messages exists. + +The decision box "fall back allowed according to SPD" takes the "yes"-exit if the SPD entry for outgoing messages is marked "fall back allowed". + +The decision box "called party address consistent with SPI" takes the "yes"-exit if the SPI within the message's Security Header points to an SA that was negotiated with the PLMN derived from the message's SCCP called party address. + +The decision box "protection mode correct" takes the "yes"-exit if the presence/absence of octets 10 and 11 within the message's Security Header is consistent with the protection mode in the SPD-entry for outgoing messages. Note that octets 10 and 11 of the Security Header are only used to construct the IV which is not needed (and shall therefore be absent) if the protection mode is "authenticity and integrity". + +![Flowchart for macrodefinition Inbound_foreign_to_own](79e1709a7317ead45379cbb8ff3ba802_img.jpg) + +macrodefinition Inbound\_foreign\_to\_own + +1(2) + +``` +graph TD; Start([ ]) --> D1{message contains protectable parameter}; D1 -- no --> Pass1((pass)); D1 -- yes --> D2{message is not protected}; D2 -- no --> A((A)); D2 -- yes --> D3{relayed by SRF}; D3 -- no --> D4{message should be protected according to SPD (orig. network)}; D3 -- yes --> D5{message should be protected according to SPD (relay network)}; D5 -- no --> Pass2((pass)); D5 -- yes --> D6{Fall Back allowed according to SPD (relay network)}; D6 -- no --> Block((block)); D6 -- yes --> Pass3((pass)); D4 -- no --> Pass2; D4 -- yes --> D7{Fall Back allowed according to SPD (orig. network)}; D7 -- no --> Block; D7 -- yes --> Pass3; +``` + +The flowchart titled 'macrodefinition Inbound\_foreign\_to\_own' (sheet 1 of 2) outlines the decision logic for processing inbound messages from foreign networks. It begins with a start connector leading to a decision: 'message contains protectable parameter'. If 'no', the message is 'pass'. If 'yes', it proceeds to 'message is not protected'. If 'no', it goes to connector 'A'. If 'yes', it checks 'relayed by SRF'. If 'no', it proceeds to 'message should be protected according to SPD (orig. network)'. If 'yes', it checks 'message should be protected according to SPD (relay network)'. If 'no', it is 'pass'. If 'yes', it checks 'Fall Back allowed according to SPD (relay network)'. If 'no', it is 'block'. If 'yes', it is 'pass'. From 'message should be protected according to SPD (orig. network)', if 'no', it is 'pass'. If 'yes', it checks 'Fall Back allowed according to SPD (orig. network)'. If 'no', it is 'block'. If 'yes', it is 'pass'. + +Flowchart for macrodefinition Inbound\_foreign\_to\_own + +Figure 5.1.5 Macro Inbound\_foreign\_to\_own (sheet 1 of 2) + +![Flowchart for macrodefinition Inbound_foreign_to_own (sheet 2 of 2). The process starts at node A. It enters a loop of decision boxes: 'calling party address consistent with SPI' (yes leads to 'De-protect message', no leads to 'relayed by SRF'), 'relayed by SRF' (yes leads to 'protection mode acceptable according to SPD (relay network)', no leads to 'block'), and 'protection mode acceptable according to SPD (relay network)' (yes leads to 'De-protect message', no leads to 'protection mode acceptable according to SPD (orig. network)'). The final decision 'protection mode acceptable according to SPD (orig. network)' (yes leads to 'De-protect message', no leads to 'block'). 'De-protect message' leads to 'success' (yes leads to 'pass', no leads to 'block').](e180f2b5fcbe8001554a7c0677cd3f82_img.jpg) + +macrodefinition Inbound\_foreign\_to\_own 2(2) + +``` +graph TD; A((A)) --> D1{calling party address consistent with SPI}; D1 -- yes --> DM[De-protect message]; D1 -- no --> D2{relayed by SRF}; D2 -- no --> B1((block)); D2 -- yes --> D3{protection mode acceptable according to SPD (relay network)}; D3 -- no --> B1; D3 -- yes --> DM; D3 -- no --> D4{protection mode acceptable according to SPD (orig. network)}; D4 -- yes --> DM; D4 -- no --> B2((block)); DM --> D5{success}; D5 -- yes --> P((pass)); D5 -- no --> B3((block)); +``` + +Flowchart for macrodefinition Inbound\_foreign\_to\_own (sheet 2 of 2). The process starts at node A. It enters a loop of decision boxes: 'calling party address consistent with SPI' (yes leads to 'De-protect message', no leads to 'relayed by SRF'), 'relayed by SRF' (yes leads to 'protection mode acceptable according to SPD (relay network)', no leads to 'block'), and 'protection mode acceptable according to SPD (relay network)' (yes leads to 'De-protect message', no leads to 'protection mode acceptable according to SPD (orig. network)'). The final decision 'protection mode acceptable according to SPD (orig. network)' (yes leads to 'De-protect message', no leads to 'block'). 'De-protect message' leads to 'success' (yes leads to 'pass', no leads to 'block'). + +**Figure 5.1.5 Macro Inbound\_foreign\_to\_own (sheet 2 of 2)** + +The decision box "message contains protectable parameter" takes the "yes"-exit if user-information is present in the Dialogue Portion, or a parameter is present in an Invoke or ReturnError Component, or a result is present in a ReturnResult Component. + +The decision box "message is not protected" takes the "no"-exit if user-information within the Dialogue Portion is identified by the object identifier ss7-ProtectedDialogueAS or + +operationCode within an Invoke or ReturnResult Component takes the global value ss7-ProtectedDialogueAS or errorCode within an ReturnError Component takes the global value ss7-ProtectedDialogueAS. + +The decision box "relayed by SRF" takes the "yes"-exit if the SCCP called party address consists of a Routing Number (RN) pointing to the own network and an MSISDN pointing to a relay network within the portability cluster. + +The decision box "message should be protected according to SPD (relay network)" takes the "yes"-exit if an SPD entry for incoming messages exists for the relay network. + +The decision box "Fall Back allowed according to SPD (relay network)" takes the "yes"-exit if the SPD entry for incoming messages (from the relay network) is marked "fall back allowed". + +The decision box "message should be protected according to SPD (orig. network)" takes the "yes"-exit if the message's SCCP calling party address identifies a PLMN for which an SPD entry for incoming messages exists. + +The decision box "Fall Back allowed according to SPD (relay network)" takes the "yes"-exit if the SPD entry for incoming messages (from the network identified by the SCCP calling party address) is marked "fall back allowed". + +The decision box "calling party address consistent with SPI" takes the "yes"-exit if the SPI within the message's Security Header points to an SA that was negotiated with the PLMN derived from the message's SCCP calling party address. + +The decision box "protection mode acceptable according to SPD (relay network)" takes the "yes"-exit if the presence/absence of octets 10 and 11 within the message's Security Header is consistent with a protection mode found in the SPD-entry (for incoming messages from the network identified by the SPI). Note that octets 10 and 11 of the Security Header are only used to construct the IV which is not needed (and shall therefore be absent) if the protection mode is "authenticity and integrity". + +The decision box "protection mode acceptable according to SPD (orig. network)" takes the "yes"-exit if the presence/absence of octets 10 and 11 within the message's Security Header is consistent with a protection mode found in the SPD-entry (for incoming messages from the network identified by the SCCP calling party address). Note that octets 10 and 11 of the Security Header are only used to construct the IV which is not needed (and shall therefore be absent) if the protection mode is "authenticity and integrity". + +![Flowchart for macrodefinition Outbound_own_to_own. It starts with a connector symbol, followed by a decision box 'message contains protectable parameter'. If 'no', it goes to a 'pass' connector. If 'yes', it goes to another decision box 'message needs to be protected according to SPD'. If 'no', it goes to the 'pass' connector. If 'yes', it goes to a 'protect message' box, which then leads to the 'pass' connector.](ae53f90bb87d6d09e2d6b5278d7c338f_img.jpg) + +macrodefinition Outbound\_own\_to\_own + +1(1) + +``` +graph TD; Start([ ]) --> D1{message contains protectable parameter}; D1 -- no --> Pass((pass)); D1 -- yes --> D2{message needs to be protected according to SPD}; D2 -- no --> Pass; D2 -- yes --> P[protect message]; P --> Pass; +``` + +Flowchart for macrodefinition Outbound\_own\_to\_own. It starts with a connector symbol, followed by a decision box 'message contains protectable parameter'. If 'no', it goes to a 'pass' connector. If 'yes', it goes to another decision box 'message needs to be protected according to SPD'. If 'no', it goes to the 'pass' connector. If 'yes', it goes to a 'protect message' box, which then leads to the 'pass' connector. + +**Figure 5.1.6 Macro Outbound\_own\_to\_own (sheet 1 of 1)** + +The decision box "message contains protectable parameter" takes the "yes"-exit if user-information is present in the Dialogue Portion, or a parameter is present in an Invoke or ReturnError Component, or a result is present in a ReturnResult Component. + +The decision box "message needs to be protected according to SPD" takes the "yes"-exit if an SPD entry for outgoing messages exists (for messages sent to the own network). + +![Flowchart for macro Outbound_own_to_foreign](26d664119ad25250780f554633444e54_img.jpg) + +macrodefinition Outbound\_own\_to\_foreign 1(1) + +``` +graph TD; Start([ ]) --> D1{message contains protectable parameter}; D1 -- no --> Pass((pass)); D1 -- yes --> D2{message is protected}; D2 -- yes --> Pass; D2 -- no --> D3{message needs to be protected according to SPD}; D3 -- no --> Pass; D3 -- yes --> P[protect message]; P --> Pass; +``` + +The flowchart illustrates the logic for the macro Outbound\_own\_to\_foreign. It begins with a start symbol (a circle with a vertical line) leading to a decision diamond labeled "message contains protectable parameter". If the answer is "no", the flow proceeds directly to a pass symbol (a circle with a vertical line). If the answer is "yes", it proceeds to the next decision diamond labeled "message is protected". If this second decision is "yes", the flow proceeds to the pass symbol. If the answer is "no", it proceeds to a third decision diamond labeled "message needs to be protected according to SPD". If the answer is "no", the flow proceeds to the pass symbol. If the answer is "yes", it proceeds to a process box labeled "protect message", which then leads to the pass symbol. + +Flowchart for macro Outbound\_own\_to\_foreign + +**Figure 5.1.7 Macro Outbound\_own\_to\_foreign (sheet 1 of 1)** + +The decision box "message contains protectable parameter" takes the "yes"-exit if user-information is present in the Dialogue Portion, or a parameter is present in an Invoke or ReturnError Component, or a result is present in a ReturnResult Component. + +The decision box "message is protected" takes the "yes"-exit if user-information within the Dialogue Portion is identified by the object identifier ss7-ProtectedDialogueAS or + +operationCode within an Invoke or ReturnResult Component takes the global value ss7-ProtectedDialogueAS or errorCode within an ReturnError Component takes the global value ss7-ProtectedDialogueAS. + +The decision box "message needs to be protected according to SPD" takes the "yes"-exit if an SPD entry for outgoing messages exists (for messages sent to the network identified by the SCCP called party address). + +![Flowchart for Outbound_foreign_to_own macro. It starts with an oval connector, followed by a decision diamond 'message contains protectable parameter'. If 'no', it goes to a 'pass' connector. If 'yes', it goes to another decision diamond 'message needs to be protected according to SPD'. If 'no', it goes to the 'pass' connector. If 'yes', it goes to a process box 'protect message with reverse SA', which then leads to the 'pass' connector.](e821c3d8a87ee2a9ff6b8644ffe6bdae_img.jpg) + +macrodefinition Outbound\_foreign\_to\_own 1(1) + +``` +graph TD; Start([ ]) --> D1{message contains protectable parameter}; D1 -- no --> Pass((pass)); D1 -- yes --> D2{message needs to be protected according to SPD}; D2 -- no --> Pass; D2 -- yes --> P[protect message with reverse SA]; P --> Pass; +``` + +Flowchart for Outbound\_foreign\_to\_own macro. It starts with an oval connector, followed by a decision diamond 'message contains protectable parameter'. If 'no', it goes to a 'pass' connector. If 'yes', it goes to another decision diamond 'message needs to be protected according to SPD'. If 'no', it goes to the 'pass' connector. If 'yes', it goes to a process box 'protect message with reverse SA', which then leads to the 'pass' connector. + +**Figure 5.1.8 Macro Outbound\_foreign\_to\_own (sheet 1 of 1)** + +The decision box "message contains protectable parameter" takes the "yes"-exit if user-information is present in the Dialogue Portion, or + +a parameter is present in an Invoke or ReturnError Component, or a result is present in a ReturnResult Component. + +The decision box "message needs to be protected according to SPD" takes the "yes"-exit if an SPD entry for incoming messages exists (for messages received from the network identified by the SCCP calling party address). If more than one acceptable protection modes are present, one may be chosen. + +The task box "protect message with reverse SA" performs protection of the message with the SA that is to be used for de-protection when receiving messages from the network in question. + +![Flowchart for macro Outbound_foreign_to_foreign. It starts with an oval connector, followed by a decision 'message contains protectable parameter'. If 'no', it goes to a 'pass' connector. If 'yes', it goes to a decision 'message is protected'. If 'yes', it goes to a 'pass' connector. If 'no', it goes to a decision 'relayed by SRF'. If 'no', it goes to a 'pass' connector. If 'yes', it goes to a decision 'message needs to be protected according to SPD'. If 'no', it goes to a 'pass' connector. If 'yes', it goes to a task 'protect message' which is associated with 'with SA own to foreign', and then to a 'pass' connector.](088921fa3f5a44c8551815122517eefd_img.jpg) + +macrodefinition Outbound\_foreign\_to\_foreign 1(1) + +``` +graph TD; Start([ ]) --> D1{message contains protectable parameter}; D1 -- no --> Pass((pass)); D1 -- yes --> D2{message is protected}; D2 -- yes --> Pass; D2 -- no --> D3{relayed by SRF}; D3 -- no --> Pass; D3 -- yes --> D4{message needs to be protected according to SPD}; D4 -- no --> Pass; D4 -- yes --> T1[protect message]; T1 --- T2[with SA own to foreign]; T1 --> Pass; +``` + +Flowchart for macro Outbound\_foreign\_to\_foreign. It starts with an oval connector, followed by a decision 'message contains protectable parameter'. If 'no', it goes to a 'pass' connector. If 'yes', it goes to a decision 'message is protected'. If 'yes', it goes to a 'pass' connector. If 'no', it goes to a decision 'relayed by SRF'. If 'no', it goes to a 'pass' connector. If 'yes', it goes to a decision 'message needs to be protected according to SPD'. If 'no', it goes to a 'pass' connector. If 'yes', it goes to a task 'protect message' which is associated with 'with SA own to foreign', and then to a 'pass' connector. + +Figure 5.1.9 Macro Outbound\_foreign\_to\_foreign (sheet 1 of 1) + +The decision box "message contains protectable parameter" takes the "yes"-exit if user-information is present in the Dialogue Portion, or a parameter is present in an Invoke or ReturnError Component, or a result is present in a ReturnResult Component. + +The decision box "message is protected" takes the "yes"-exit if user-information within the Dialogue Portion is identified by the object identifier ss7-ProtectedDialogueAS or operationCode within an Invoke or ReturnResult Component takes the global value ss7-ProtectedDialogueAS or errorCode within an ReturnError Component takes the global value ss7-ProtectedDialogueAS. + +The decision box "relayed by SRF" takes the "yes"-exit if the SCCP called party address consists of a Routing Number (RN) pointing to the own network and an MSISDN pointing to a relay network within the portability cluster. + +The decision box "message needs to be protected according to SPD" takes the "yes"-exit if an SPD entry for outgoing messages exists (for messages sent to the network identified by the SCCP called party address). + +### 5.1.2 Interactions with Mobile Number Portability + +In Mobile Number Portability scenarios (see 3GPP TS 23.066 [4]) a Signalling Relay Function (SRF) may relay SCCP traffic by modifying the SCCP called party address as shown in figure 4.1.10. + +A relayed message's SCCP called party address consists of a Routing Number (RN) and an MSISDN (see 3GPP TS 23.066 [4]). + +An SS7 Security Gateway needs to recognize (by analyzing the SCCP called party address) whether or not a message was relayed in order to + +- distinguish outbound transit traffic relayed by an SRF in the own network (which needs to be protected) from other outbound transit traffic (which needs to be passed transparently), and to +- distinguish inbound terminating traffic relayed by an SRF within the portability cluster (where the check needs to be based on the policy identified by the MSISDN within the SCCP called party address) from other inbound terminating traffic (where the check needs to be based on the policy identified by the SCCP calling party address). + +**NOTE :** In MNP-SRF scenarios, when the relaying PLMN does not make use of TCAP-User Security, messages sent from a source PLMN to a destination PLMN via the relaying PLMN are unprotected although protection may be desired for messages sent from the source PLMN to the destination PLMN. Network operators may therefore want to negotiate use of TCAP-User Security with all PLMNs of a portability cluster. + +### 5.1.3 Interactions with SCCP segmentation + +When the incoming SCCP message makes use of SCCP segmenting (i.e. several XUDT messages are received rather than one UDT or a single XUDT message) the SS7 Security Gateway has to perform reassembling before processing the message, and it may have to perform segmenting before sending the processed message. + +It may happen that the received SCCP message (containing an unprotected TCAP user payload) is not segmented (UDT or single XUDT), but after security processing the message's length is increased, so that the processed message needs to be segmented before it is sent. This situation may be undesired (since transfer of XUDT messages is not guaranteed by all transit networks) but cannot be avoided by the SS7 Security Gateway (see note). + +**Note:** The support of message segmentation at the SCCP layer in all transit networks could be enforced by mandating the usage of the White Book SCCP [9]. GSMA would work with International Carriers to ensure that fully operationally-verified support of XUDT is available before TCAPsec gateways are deployed. + +It may also happen that the received (protected) message is segmented (several XUDTs), but after security processing the message's length is decreased, so that the processed message does not need to be segmented before it is sent. In this case the de-protecting SS7 Security Gateway needs to know some SCCP-details of the original unprotected message as sent from the originating NE to the protecting SS7 Security Gateway. These original SCCP information needs to be transported within the TCAP-user parameter of the protected message. Depending on this information the de-protecting SS7-Security Gateway can decide whether to send a UDT or a single XUDT message towards the destination. . + +In cases where the received unprotected message is not segmented but the (to be) sent protected message needs to be segmented, the SS7 Security Gateway has to replace the message's SCCP calling party address with its own address. This is to guarantee uniqueness of the combination of the SCCP calling party address and the Segmentation local reference in the (to be) sent message. The original SCCP calling party address needs to be transported within the TCAP-user parameter of the (first segment of the) protected message. + +If the received protected message contains an original SCCP calling party address within the TCAP-user parameter, the de-protecting SS7 Security Gateway has to replace the SCCP calling party address with the original SCCP calling party address before forwarding the de-protected message to the destination. + +An SS7 Security Gateway that has sent a segmented, protected message with a replaced SCCP calling party address may receive an SCCP XUDTS message with its own address as called party address. In this case the SS7 Security Gateway shall retrieve the original SCCP calling party address, the original TCAP Message type and TCAP transaction id from the data parameter of the received XUDTS message and construct a UDT message with unmodified Return cause, called party address replaced with the retrieved original calling party address, unmodified calling party address, and Data parameter containing the retrieved TCAP message type and TCAP transaction id, and forward it to the destination. + +### 5.1.4 Protocol details + +#### 5.1.4.1 Transformation of unprotected message to protected message + +The unprotected TCAP-user message is either transported within an SCCP UDT message or it is transported within a single SCCP XUDT message or it is segmented over several SCCP XUDT messages. Other SCCP message types are not subject to protection. + +The transformation process is done in 3 steps: + +##### Step 1: SCCP re-assembly of the unprotected message + +In a first step the unprotected message is transformed into an intermediate unprotected representation which is made up of the following parameters: + +| | | +|-------------------------------------------------|--------------------------------------| +| SCCP Message type | | +| SCCP Protocol class | | +| SCCP Hop counter (optional) | | +| SCCP Called party address | | +| SCCP Calling party address | | +| SCCP Segmentation local reference (optional) | | +| SCCP Importance (optional) | | +| SCCP Data (made up of the following parameters: | TCAP Message type | +| | TCAP orig. Transaction Id (optional) | +| | TCAP dest. Transaction Id (optional) | +| | TCAP Dialogue Portion (optional) | +| | TCAP Component Portion (optional)) | + +If the unprotected message was transported within an SCCP UDT message, the intermediate unprotected representation of the message takes the following values: + +| | | +|-----------------------------------|-------------------------------------| +| SCCP Message type | UDT | +| SCCP Protocol class | same as in the received UDT message | +| SCCP Hop counter | absent | +| SCCP Called party address | same as in the received UDT message | +| SCCP Calling party address | same as in the received UDT message | +| SCCP Segmentation local reference | absent | +| SCCP Importance | absent | +| SCCP Data | same as in the received UDT message | + +If the unprotected message was transported within a single SCCP XUDT message, the intermediate unprotected representation of the message takes the following values: + +| | | +|-----------------------------------|--------------------------------------| +| SCCP Message type | XUDT | +| SCCP Protocol class | same as in the received XUDT message | +| SCCP Hop counter | same as in the received XUDT message | +| SCCP Called party address | same as in the received XUDT message | +| SCCP Calling party address | same as in the received XUDT message | +| SCCP Segmentation local reference | absent | +| SCCP Importance | same as in the received XUDT message | +| SCCP Data | same as in the received XUDT message | + +If the unprotected message was segmented over several SCCP XUDT messages, the intermediate unprotected representation of the message takes the following values: + +| | | +|-----------------------------------|-------------------------------------------------------------------------------------------------------| +| SCCP Message type | XUDT | +| SCCP Protocol class | same as in the first received XUDT message | +| SCCP Hop counter | same as in the first received XUDT message | +| SCCP Called party address | same as in the first received XUDT message | +| SCCP Calling party address | same as in the first received XUDT message | +| SCCP Segmentation local reference | same as in the first received XUDT message | +| SCCP Importance | same as in the first received XUDT message | +| SCCP Data | concatenation of the received segments (for details of the re-assembly procedure see ITU-T Q.714 [9]) | + +##### Step 2: Protection + +In a second step the intermediate unprotected representation is transformed into an intermediate protected representation which is made up of the following parameters: + +| | | +|----------------------------------------------------------|---------------------------------------------------------------------------------------------------------------| +| SCCP Hop counter (optional) | | +| SCCP Called party address | | +| SCCP Calling party address | | +| SCCP Segmentation local reference (optional) | | +| SCCP Importance (optional) | | +| Original SCCP info (made up of the following parameters: | Original SCCP Calling party address (optional)
Original SCCP Message type
Original SCCP Protocol class) | +| Original TCAP info (made up of the following parameters: | Original TCAP Message type
otid (optional)
dtid (optional)) | +| TCAPsec Security header | | +| TCAPsec Cipher- or Cleartext | | +| TCAPsecMAC | | + +The intermediate unprotected representation of the message takes the following values: + +| | | +|---------------------------------------------------------|----------------------------------------------------------------------------| +| SCCP Hop counter | same as SCCP Hop counter in the intermediate unprotected representation | +| SCCP Called party address | same as in the intermediate unprotected representation | +| SCCP Calling party address | same as in the intermediate unprotected representation | +| SCCP Segmentation local reference | same as in the intermediate unprotected representation | +| SCCP Importance | same as SCCP Importance in the intermediate unprotected representation | +| Original SCCP info made up of the following parameters: | | +| Original SCCP Message type | same as SCCP Message type in the intermediate unprotected representation | +| Original SCCP Protocol class | same as SCCP Protocol class in the intermediate unprotected representation | +| Original TCAP info made up of the following parameters: | | +| Original TCAP Message type | same as TCAP Message type in the intermediate unprotected representation | + +| | | +|------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| TCAP otid | same as TCAP orig. Transaction Id in the intermediate unprotected representation | +| TCAP dtid | same as TCAP dest. Transaction Id in the intermediate unprotected representation | +| TCAPsec Security header | See 3GPP TS 33.204 [8] | +| TCAPsec Cipher- or Cleartext | result of applying the encryption function to the concatenation of Dialogue Portion and Component Portion of the intermediate unprotected representation (ciphertext), or concatenation of Dialogue Portion and Component Portion of the intermediate unprotected representation(cleartext) | +| TCAPsec MAC | result of applying the integrity function to the concatenation of Security header and Cipher- or Cleartext of the intermediate protected representation. | + +##### Step 3: SCCP segmentation of the protected message + +In a third step the intermediate protected representation is transformed into a single SCCP UDT message, a single SCCP XUDT message, or several SCCP XUDT messages depending on the Original SCCP Message type of the intermediate protected representation and the need for segmentation as follows: + +If the Original SCCP Message type in the intermediate protected representation takes the value "UDT" and the message need not be segmented, it is transformed into a single SCCP UDT message with following parameter values: + +| | | +|-----------------------|-----------------------------------------------------------------------------------| +| Message Type | UDT | +| Protocol class | same as Original SCCP Protocol class in the intermediate protected representation | +| Called party address | same as SCCP Called party address in the intermediate protected representation | +| Calling party address | same as SCCP Calling party address in the intermediate protected representation | +| Data | (see below) | + +If the Original SCCP Message type in the intermediate protected representation takes the value "XUDT" and the message need not be segmented, it is transformed into a single SCCP XUDT message with following parameter values: + +| | | +|-----------------------|-----------------------------------------------------------------------------------| +| Message Type | XUDT | +| Protocol class | same as Original SCCP Protocol class in the intermediate protected representation | +| Hop counter | same as Original SCCP Hop counter in the intermediate protected representation | +| Called party address | same as SCCP Called party address in the intermediate protected representation | +| Calling party address | same as SCCP Calling party address in the intermediate protected representation | +| Data | (see below) | +| Segmentation | absent | +| Importance | same as Original SCCP Importance in the intermediate protected representation | + +If the Original SCCP Message type in the intermediate protected representation takes the value "UDT" and the message needs to be segmented, it is transformed into several SCCP XUDT message with following parameter values: + +| | | +|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Message Type | XUDT | +| Protocol class | first segment: class 1 (in sequence delivery), return option: same as in Original SCCP Protocol class in the intermediate protected representation
subsequent segment: class 1 (in sequence delivery), return option: no special options | +| Hop counter | absent | +| Called party address | same as SCCP Called party address in the intermediate protected representation | +| Calling party address | the SS7 Security Gateway's own address | +| Data | (segment of see below) | +| Segmentation | see [9] | +| Importance | absent | + +If the Original SCCP Message type in the intermediate protected representation takes the value "XUDT" and the message needs to be segmented, it is transformed into several SCCP XUDT message with following parameter values: + +| | | +|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Message Type | XUDT | +| Protocol class | first segment: class 1 (in sequence delivery), return option: same as in Original SCCP Protocol class in the intermediate protected representation
subsequent segment: class 1 (in sequence delivery), return option: no special options | +| Hop counter | same as Original SCCP Hop counter in the intermediate protected representation | + +| | | +|-----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Called party address | same as SCCP Called party address in the intermediate protected representation | +| Calling party address | if SCCP Segmentation Local reference is present in the intermediate protected representation: same as SCCP Calling party address in the intermediate protected representation;
otherwise: the SS7 Security Gateway's own address | +| Data | (segment of see below) | +| Segmentation | see [9]; if SCCP Segmentation Local reference is present in the intermediate protected representation, the same value shall be used. | +| Importance | same as Original SCCP Importance in the intermediate protected representation. | + +The SCCP Data parameter (re-assembled) shall take the following value: + +| | | +|-----------------------|----------------------------------| +| TCAP Message type | unidirectional | +| TCAP DialoguePortion | absent | +| TCAP ComponentPortion | one invoke component with: | +| invokeId | (any legal value) | +| linkId | absent | +| operationCode | local value 90 (secureTransport) | +| parameter | ANY DEFINED BY operationCode | + +``` +SS7-Secure-Transport-Operation-and-DataTypes { + itu-t identified-organization (4) etsi (0) mobileDomain (0) + gsm-Network (1) modules (3) ss7-Secure-Transport-Operation-and-DataTypes (27) version1 (1)} +``` + +``` +DEFINITIONS +IMPLICIT TAGS +::= +BEGIN +``` + +``` +EXPORTS + secureTransport +; +``` + +``` +IMPORTS + OPERATION +FROM Remote-Operations-Information-Objects { + joint-iso-itu-t remote-operations (4) + informationObjects (5) version1 (0) } + +; +``` + +| | +|--------------------------------------------------------------------------------------------------------| +|
secureTransport OPERATION ::= {     ARGUMENT         SecureTransportArg     CODE local:90 }
| +|--------------------------------------------------------------------------------------------------------| + +| | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +|
SecureTransportArg ::= SEQUENCE {     originalSCCP-Info           [0] OriginalSCCP-Info           OPTIONAL,     originalTCAP-Info           [1] OriginalTCAP-Info,     protectedPayload            [2] ProtectedPayload }
| +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +| | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +|
OriginalSCCP-Info ::= SEQUENCE {     originalSCCP-MessageType      [0] OriginalSCCP-MessageType      OPTIONAL,     -- original SCCP-MessageType shall be present if it is different from the actual     -- SCCP-Message type; otherwise it may be absent     originalSCCP-ProtocolClass    [1] OriginalSCCP-ProtocolClass      OPTIONAL     -- originalSCCP-ProtocolClass shall be present if it is different from the actual     -- SCCP-Protocol class (first segment); otherwise it may be absent.     originalSCCP-CallingPartyAddress [2] OriginalSCCP-CallingPartyAddress OPTIONAL,     -- originalSCCP-CallingPartyAddress shall be present if and only if the actual     -- SCCP Calling party address is the SS7 Security Gateway's own address }
| +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +``` + +OriginalSCCP-MessageType ::= ENUMERATED { + udt (9), + xudt (17) } + -- this parameter shall take the value of the Original SCCP Message type from the + -- intermediate protected representation +} + +OriginalSCCP-ProtocolClass ::= OCTET STRING(SIZE(1)) + -- coded according to ITU-T Q.713 +} + +OriginalSCCP-CallingPartyAddress ::= OCTET STRING(SIZE(3..18)) + -- coded according to ITU-T Q.713 + -- Octet 1: Address indicator + -- Octets 2 - n: Address +} + +OriginalTCAP-Info ::= SEQUENCE { + originalTCAP-MessageType OriginalTCAP-MessageType, + otid OTID OPTIONAL, + dtid DTID OPTIONAL +} + +OriginalTCAP-MessageType ::= ENUMERATED { + unidirectional (97), + begin (98), + end (100), + continue (101), + abort (103) } + -- this parameter shall take the value of the Original TCAP Message type from the + -- intermediate protected representation +} + +OTID ::= OCTET STRING(SIZE(1..4)) + -- OTID shall take the value of the TCAP otid from the intermediate protected + -- representation +} + +DTID ::= OCTET STRING(SIZE(1..4)) + -- DTID shall take the value of the TCAP dtid from the intermediate protected + -- representation +} + +ProtectedPayload ::= OCTET STRING(SIZE(13..3438)) + -- The protected payload is the concatenation of + -- 9 or 11 octets SecurityHeader, + -- n octets ciphertext or cleartext, and + -- 4 octets MAC + + -- The SecurityHeader is coded as follows (see 3GPP TS 33.204 [8]): + -- Octets 1-4: SPI + -- Octets 5-8: TVP. The TVP is a 32 bit time stamp. Its value is binary coded + -- + -- and indicates the number of intervals of 100 milliseconds + -- elapsed since 1st January 2002, 0:00:00 UTC + -- Octet 9: Indicator Byte with bits 7-1 spare and bit 0 if set indicates presence of + -- Octets 10-11 + -- Octet 10: SS7 SEG-Id + -- Octet 11: Prop +} + +``` + +END + +#### 5.1.4.2 Transformation of protected message to unprotected message + +The protected TCAP-user message is either transported within an SCCP UDT message or it is transported within a single SCCP XUDT message or it is segmented over several SCCP XUDT messages. Other SCCP message types are not subject to protection. + +The transformation process is done in 3 steps: + +##### Step 1: SCCP re-assembly of the protected message + +In a first step the protected message is transformed into the intermediate protected representation (see chapter 5.1.4.1): + +If the protected message was transported within an SCCP UDT message, the intermediate protected representation of the message takes the following values: + +| | | +|-------------------------------------|---------------------------------------------------------------------------------------------------| +| SCCP Hop counter | absent | +| SCCP Called party address | same as in the received UDT message | +| SCCP Calling party address | same as in the received UDT message | +| SCCP Segmentation local reference | absent | +| SCCP Importance | absent | +| Original SCCP info | | +| Original SCCP Calling party address | absent | +| Original SCCP Message type | UDT | +| Original SCCP Protocol class | same as SCCP Protocol class in the received UDT message | +| Original TCAP info | | +| Original TCAP Message type | same as Original TCAP Message type in the TCAP-invoke component parameter of the received message | +| otid | same as otid in the TCAP-invoke component parameter of the received message | +| dtid | same as dtid in the TCAP-invoke component parameter of the received message | +| TCAPsec Security header | same as received in the TCAP-invoke component parameter of the received message | +| TCAPsec Cipher- or Cleartext | same as received in the TCAP-invoke component parameter of the received message | +| TCAPsec MAC | same as received in the TCAP-invoke component parameter of the received message | + +If the protected message was transported within a single SCCP XUDT message, the intermediate protected representation of the message takes the following values: + +| | | +|-------------------------------------|---------------------------------------------------------------------------------------------------| +| SCCP Hop counter | same as in the received XUDT message | +| SCCP Called party address | same as in the received XUDT message | +| SCCP Calling party address | same as in the received XUDT message | +| SCCP Segmentation local reference | absent | +| SCCP Importance | same as in the received XUDT message | +| Original SCCP info | | +| Original SCCP Calling party address | absent | +| Original SCCP Message type | same as OriginalSCCP-Messagetype in the TCAP-invoke component parameter of the received message | +| Original SCCP Protocol class | same as OriginalSCCP-ProtocolClass in the TCAP-invoke component parameter of the received message | +| Original TCAP info | | +| Original TCAP Message type | same as Original TCAP Message type in the TCAP-invoke component parameter of the received message | +| otid | same as otid in the TCAP-invoke component parameter of the received message | +| dtid | same as dtid in the TCAP-invoke component parameter of the received message | +| TCAPsec Security header | same as received in the TCAP-invoke component parameter of the received message | +| TCAPsec Cipher- or Cleartext | same as received in the TCAP-invoke component parameter of the received message | +| TCAPsec MAC | same as received in the TCAP-invoke component parameter of the received message | + +If the protected message was transported within several SCCP XUDT message, the intermediate protected representation of the message takes the following values: + +| | | +|---------------------------|--------------------------------------------| +| SCCP Hop counter | same as in the first received XUDT message | +| SCCP Called party address | same as in the first received XUDT message | + +| | | +|-------------------------------------|---------------------------------------------------------------------------------------------------------------------| +| SCCP Calling party address | same as in the first received XUDT message | +| SCCP Segmentation local reference | same as in the first received XUDT message | +| SCCP Importance | same as in the first received XUDT message | +| Original SCCP info | | +| Original SCCP Calling party address | same as OriginalSCCP-CallingPartyAddress in the TCAP-invoke component parameter of the received reassembled message | +| Original SCCP Message type | same as OriginalSCCP-MessageType in the TCAP-invoke component parameter of the received reassembled message | +| Original SCCP Protocol class | same as OriginalSCCP-ProtocolClass in the TCAP-invoke component parameter of the received reassembled message | +| Original TCAP info | | +| Original TCAP Message type | same as OriginalTCAP-MessageType in the TCAP-invoke component parameter of the received reassembled message | +| otid | same as otid in the TCAP-invoke component parameter of the received reassembled message | +| dtid | same as dtid in the TCAP-invoke component parameter of the received reassembled message | +| TCAPsec Security header | same as received in the TCAP-invoke component parameter of the received reassembled message | +| TCAPsec Cipher- or Cleartext | same as received in the TCAP-invoke component parameter of the received reassembled message | +| TCAPsec MAC | same as received in the TCAP-invoke component parameter of the received reassembled message | + +##### Step 2: De-Protection + +In a second step the intermediate protected representation is transformed into an intermediate unprotected representation (see chapter 5.1.4.1): + +The intermediate unprotected representation of the message takes the following values: + +| | | +|-----------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SCCP Message type | same as OriginalSCCP-MessageType from the TCAP-invoke component's parameter of the intermediate protected representation | +| SCCP Protocol class | same as OriginalSCCP-ProtocolClass from the TCAP-invoke component's parameter of the intermediate protected representation | +| SCCP Hop counter | same as SCCP Hop counter in the intermediate protected representation | +| SCCP Called party address | same as SCCP Called party address in the intermediate protected representation | +| SCCP Calling party address | if OriginalSCCP-CallingPartyAddress is present in the intermediate protected representation, its value is taken; otherwise same as SCCP Calling party address of the intermediate protected representation | +| SCCP Segmentation local reference | if SCCP Message type in the intermediate unprotected representation is XUDT, then same as in the intermediate protected representation; otherwise absent. | +| SCCP Importance | same as in the intermediate unprotected representation | +| SCCP Data : | | +| TCAP Message type | same as OriginalTCAP-MessageType in the intermediate protected representation | +| TCAP orig. Transaction Id | same as otid in the intermediate protected representation | +| TCAP dest. Transaction Id | same as dtid in the intermediate protected representation | +| TCAP Dialogue Portion (optional) | First part of the cleartext (as indicated by TAG and LENGTH according to BER). If encryption was applied then ciphertext needs to be converted first to cleartext | +| TCAP Component Portion (optional) | second part of the cleartext (as indicated by TAG and LENGTH according to BER). If encryption was applied then ciphertext needs to be converted first to cleartext | + +##### Step 3: SCCP segmentation of the unprotected message + +In a third step the intermediate unprotected representation is transformed into a single SCCP UDT message, a single SCCP XUDT message, or several SCCP XUDT messages depending on the SCCP Message type of the intermediate unprotected representation and the need for segmentation as follows: + +If the SCCP Message type in the intermediate unprotected representation is "UDT", it is transformed into a single SCCP UDT message with following parameter values: + +| | | +|-----------------------|-----------------------------------------------------------------------------------| +| Message Type | UDT | +| Protocol class | same as SCCP Protocol class in the intermediate unprotected representation | +| Called party address | same as SCCP Called party address in the intermediate unprotected representation | +| Calling party address | same as SCCP Calling party address in the intermediate unprotected representation | +| Data | same as SCCP Data in the intermediate unprotected representation | + +If the SCCP Message type in the intermediate unprotected representation is "XUDT" and the message does not need to be segmented, it is transformed into a single SCCP XUDT message with following parameter values: + +| | | +|-----------------------|-----------------------------------------------------------------------------------| +| Message type | XUDT | +| Protocol class | same as SCCP Protocol class in the intermediate unprotected representation | +| Hop counter | same as SCCP Hop counter in the intermediate unprotected representation | +| Called party address | same as SCCP Called party address in the intermediate unprotected representation | +| Calling party address | same as SCCP Calling party address in the intermediate unprotected representation | +| Data | same as SCCP Data in the intermediate unprotected representation | +| Segmentation | absent | +| Importance | same as SCCP Importance in the intermediate unprotected representation | + +If the SCCP Message type in the intermediate unprotected representation is "XUDT" and the message needs to be segmented, it is transformed into several SCCP XUDT message with following parameter values: + +| | | +|--------------------------------------|------------------------------------------------------------------------------------------------------------------------------| +| Message type (all segments) | XUDT | +| Protocol class (first segment) | class 1 (in sequence delivery), return option: same as in SCCP Protocol class of the intermediate unprotected representation | +| (subsequent segments) | class 1 (in sequence delivery), return option: no special options | +| Hop counter (all segments) | same as SCCP Hop counter in the intermediate unprotected representation | +| Called party address (all segments) | same as SCCP Called party address in the intermediate unprotected representation | +| Calling party address (all segments) | same as SCCP Calling party address in the intermediate unprotected representation | +| Data | segment of SCCP Data from the intermediate unprotected representation (see ITU-T Q.714 [9]) | +| Segmentation | see [9]. Local reference shall be taken from the intermediate unprotected representation | +| Importance (all segments) | same as SCCP Importance in the intermediate unprotected representation | + +#### 5.1.4.3 Handling of received XUDTS messages and UDTS messages + +An SS7 Security Gateway shall not try to re-assemble XUDTS messages, since the SCCP option "return on error" is not set for subsequent XUDT segments. As a consequence the SS7 Security Gateway shall not try to protect or de-protect XUDTS messages (fragments) or UDTS messages. However, special handling of XUDTS messages and UDTS messages is required as follows: + +##### Outbound direction + +Instead of re-assembling and protecting the XUDTS messages or protecting UDTS messages, the SS7 Security Gateway shall remove the TCAP Dialogue Portion and the TCAP Component Portion from the SCCP Data parameter before sending the XUDTS message or UDTS message. This is in order not to pass the cleartext (or fragment of the cleartext) in outbound direction. SCCP message type and addresses shall not be changed. + +An example is shown in figure 5.1.4.3-1: A transit node in PLMN 2 cannot deliver the UDT message and therefore returns an UDTS message. SS7 Security Gateway 2 in PLMN 2 removes the cleartext (TCAP dialogue portion and TCAP component portion) from the SCCP data parameter. SS7 Security Gateway 1 in PLMN 1 recognizes that the + +received UDT message does not contain a TCAP unidirectional message with a secure transport invoke component and therefore it does not modify the SCCP message. + +![Sequence diagram showing message exchanges between NE 1, SS7 Sec Gateway 1, SS7 Sec Gateway 2, Transit Node, and NE 2 across PLMN 1 and PLMN 2.](08c7a76a7786bd08b99dd4cb41583ef4_img.jpg) + +``` + +sequenceDiagram + participant NE1 as NE 1 + participant SGW1 as SS7 Sec Gateway 1 + participant SGW2 as SS7 Sec Gateway 2 + participant TN as Transit Node + participant NE2 as NE 2 + + Note left of NE1: PLMN 1 + Note right of NE2: PLMN 2 + + NE1->>SGW1: UDT + SGW1->>SGW2: XUDT + SGW1->>SGW2: XUDT + SGW2->>TN: UDT + TN->>SGW2: UDT + SGW2->>SGW1: UDT + SGW1->>NE1: UDT + +``` + +Sequence diagram showing message exchanges between NE 1, SS7 Sec Gateway 1, SS7 Sec Gateway 2, Transit Node, and NE 2 across PLMN 1 and PLMN 2. + +**Figure 5.1.4.3-1: XUDTS messages and UDTS messages (Outbound direction)** + +##### Inbound direction + +Instead of re-assembling and de-protecting the XUDTS messages or de-protecting UDTS messages, the SS7 Security Gateway shall analyze the SCCP Called party address. If it matches with the SS7 Security Gateway's own address, it shall recover the OriginalSCCP-CallingPartyAddress from the (fragment in the) data parameter and replace the SCCP Called party address with the recovered value. In any case the SS7 Security Gateway shall recover and analyze the TCAP Message type from the (fragment in the) data parameter. If the recovered value is "unidirectional" and a invoke component with operation code "secure transport" is included, the SS7 Security Gateway shall recover the originalTCAP-MessageType, otid, and dtid from the OriginalTCAP-Info, replace the TCAP Message type with the original TCAP-MessageType, insert otid and dtid and remove the remaining material from the SCCP data parameter. If the received message is an XUDTS message and the original SCCP Message type was UDT then the SS7 Security shall modify the SCCP Message type to UDTS. + +An example is shown in figure 5.1.4.3-2: A transit node in a transit network cannot deliver the XUDT messages and therefore returns an XUDTS message (note that the second XUDT does not have the SCCP return option set). SS7 Security Gateway 1 in PLMN 1 recognizes that the received XUDTS message does contain a TCAP unidirectional message with a secure transport invoke component and therefore, since the original SCCP-MessageType is UDT, modifies the SCCP Message type from XUDTS to UDTS. Furthermore, the TCAP Message type is modified from unidirectional to the original TCAP-MessageType, the Transaction Ids are inserted, and the remaining material (fragment of the ciphertext) is removed. + +In addition the SS7 Security Gateway 1 in PLMN 1 recognizes that the received XUDTS message does contain SS7 Security Gateway 1's own address as SCCP Called party address and therefore replaces it with the original SCCPCalling party address. + +![Sequence diagram showing message exchanges between NE 1, SS7 Sec Gateway 1, Transit Node, SS7 Sec Gateway 2, and NE 2 across PLMN 1 and PLMN 2.](6629e8a87e7552e2454b7c3e9f6d73a0_img.jpg) + +The diagram illustrates a sequence of messages between network elements (NEs) and gateways across two PLMNs. PLMN 1 contains NE 1, SS7 Sec Gateway 1, and a Transit Node. PLMN 2 contains SS7 Sec Gateway 2 and NE 2. The message flow is as follows: + +- NE 1 sends a UDT message to SS7 Sec Gateway 1. +- SS7 Sec Gateway 1 sends two XUDT messages to the Transit Node. +- The Transit Node sends an XUDTS message back to SS7 Sec Gateway 1. +- SS7 Sec Gateway 1 sends a UDTS message back to NE 1. + +``` +sequenceDiagram + participant NE1 as NE 1 + participant SS7G1 as SS7 Sec Gateway 1 + participant TN as Transit Node + participant SS7G2 as SS7 Sec Gateway 2 + participant NE2 as NE 2 + + Note left of NE1: PLMN 1 + Note right of NE2: PLMN 2 + + NE1->>SS7G1: UDT + SS7G1->>TN: XUDT + SS7G1->>TN: XUDT + TN->>SS7G1: XUDTS + SS7G1->>NE1: UDTS +``` + +Sequence diagram showing message exchanges between NE 1, SS7 Sec Gateway 1, Transit Node, SS7 Sec Gateway 2, and NE 2 across PLMN 1 and PLMN 2. + +Figure 5.1.4.3-2: XUDTS messages and UDTS messages (inbound direction) + +# --- Annex A (informative): Change history + +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | New | +|---------|--------|-----------|------|-----|----------------------------------------------------|--------| +| 2006-06 | CT#32 | CP-060320 | | | Approved as version 7.0.0 | 7.0.0 | +| 2006-09 | CT#33 | CP-060413 | 0001 | | Addition of abbreviations and correction of a note | 7.1.0 | +| 2008-12 | CT#42 | | | | Upgraded unchanged from Rel-7 | 8.0.0 | +| 2009-12 | - | - | - | - | Update to Rel-9 version (MCC) | 9.0.0 | +| 2011-03 | - | - | - | - | Update to Rel-10 version (MCC) | 10.0.0 | +| 2012-09 | - | - | - | - | Update to Rel-11 version (MCC) | 11.0.0 | +| 2014-09 | - | - | - | - | Update to Rel-12 version (MCC) | 12.0.0 | +| 2015-12 | CT#70 | - | - | - | Update to Rel-13 version (MCC) | 13.0.0 | +| 2017-03 | CT#75 | - | - | - | Update to Rel-14 version (MCC) | 14.0.0 | +| 2018-06 | CT#80 | - | - | - | Update to Rel-15 version (MCC) | 15.0.0 | +| 2020-07 | CT#88e | - | - | - | Update to Rel-16 version (MCC) | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29205/raw.md b/marked/Rel-16/29_series/29205/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..8f26ebd5aa6a11bd4c20b0b95d4913a40fe8c3ed --- /dev/null +++ b/marked/Rel-16/29_series/29205/raw.md @@ -0,0 +1,948 @@ + + + + + + +# Contents + +| | | +|--------------------------------------------------------------------------|-----------| +| Foreword ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions, symbols and abbreviations ..... | 7 | +| 3.1 Definitions..... | 7 | +| 3.2 Symbols..... | 7 | +| 3.3 Abbreviations ..... | 7 | +| 4 Protocols..... | 8 | +| 4.1 Call control protocol (Nc interface) ..... | 8 | +| 4.2 Interworking with other protocols..... | 8 | +| 4.3 Resource control protocol (G)MSC and MGW (Mc Interface) ..... | 8 | +| 4.4 Bearer control protocol between MGWs (Nb interface)..... | 9 | +| 4.5 Signalling Transport..... | 9 | +| 4.5.1 Call Control protocols ..... | 9 | +| 4.5.2 Resource control protocol (G)MSC and MGW (Mc Interface) ..... | 9 | +| 4.5.3 Bearer control protocol between MGWs (Nb interface) ..... | 9 | +| Annex A: Void..... | 9 | +| Annex B (normative): Transparent Support of Mobile Services ..... | 9 | +| B.1 Introduction..... | 9 | +| B.2 Mobile Service Transport (MST) – Format and Codes ..... | 10 | +| B.2.1 Encapsulated Application Information..... | 10 | +| B.2.1.1 General Layout ..... | 10 | +| B.2.1.2 List of Identifiers ..... | 12 | +| B.2.1.3 Mobile Equipment Identifier ..... | 12 | +| B.2.1.4 LCLS Negotiation Request..... | 13 | +| B.2.1.5 LCLS Negotiation Response ..... | 13 | +| B.2.1.6 LCLS Status..... | 14 | +| B.2.1.7 LCLS Status Change ..... | 14 | +| B.2.1.8 LCLS Status Result ..... | 14 | +| B.2.1.9 LCLS Global Call Reference..... | 15 | +| B.2.1.10 LCLS Configuration Preference..... | 16 | +| B.2.1.11 LCLS Configuration Change Request..... | 17 | +| B.2.1.12 LCLS Configuration Change Result ..... | 17 | +| B.2.2 Application Transport Instruction Indicators ..... | 18 | +| Annex C (normative): LCLS Service Application ..... | 18 | +| C.1 Use of MST ASE ..... | 18 | +| C.2 Procedures..... | 18 | +| C.2.1 Indication of LCLS Capability ..... | 18 | +| C.2.1.1 LCLS Service Capability Indication ..... | 18 | +| C.2.1.2 Actions at Originating Serving Node ..... | 19 | +| C.2.1.3 Actions at Intermediate Serving Node..... | 19 | +| C.2.1.4 Actions at Destination Serving Node ..... | 19 | +| C.2.2 Backward LCLS Negotiation during Call Setup..... | 20 | +| C.2.2.1 Introduction ..... | 20 | +| C.2.2.2 Actions at Destination Serving Node ..... | 20 | +| C.2.2.3 Actions at Intermediate Serving Node..... | 20 | +| C.2.2.4 Actions at Originating Serving Node ..... | 20 | +| C.2.3 Answer message..... | 21 | +| C.2.3.1 Introduction ..... | 21 | +| C.2.3.2 Actions at Destination Serving Node ..... | 21 | +| C.2.3.3 Actions at Intermediate Serving Node..... | 21 | + +- C.2.3.4 Actions at Originating Serving Node ..... 21 +- C.2.4 LCLS Configuration Change Request..... 21 +- C.2.4.1 Introduction ..... 21 +- C.2.4.2 Actions at Initiating Serving Node ..... 22 +- C.2.4.3 Actions at Intermediate Serving Node..... 22 +- C.2.4.4 Actions at Terminating Serving Node ..... 22 +- C.2.5 LCLS Status Update..... 22 +- C.2.5.1 Introduction ..... 22 +- C.2.5.2 Actions at Initiating Serving Node ..... 23 +- C.2.5.3 Actions at Intermediate Serving Node..... 23 +- C.2.5.4 Actions at Terminating Serving Node ..... 23 +- C.2.6 LCLS Status Change Request..... 23 +- C.2.6.1 Introduction ..... 23 +- C.2.6.2 Actions at Initiating Serving Node ..... 23 +- C.2.6.3 Actions at Intermediate Serving Node..... 24 +- C.2.6.4 Actions at Terminating Serving Node ..... 24 + +Annex D (informative): Change history..... 25 + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 1 Scope + +The present document describes the protocols to be used when ITU-T Q.1902 "Bearer Independent Call Control" is used as call control protocol in a 3GPP Bearer Independent CS core network 3GPP TS 23.205 [1]. The Q.1902 operates between (G)MSC servers. The BICC architecture as described in ITU-T Q.1902 [6]-[10] consists of a number of protocols. The following types of protocols are described: call control protocol, bearer control protocols and a resource control protocol for this architecture. The architecture complies with the requirements imposed by 3GPP TS 23.205 [1] and TS 23.153 [2]. + +The present document is valid for a 3rd generation PLMN (UMTS) complying with Release 4 and later. + +Note: Q.1902 can be used in other network architectures than the one defined in 3GPP TS 23.205 [1] + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TS 23.205: "Bearer Independent CS Core Network – Stage 2". +- [2] 3GPP TS 23.153: "Out of Band Transcoder Control - Stage 2". +- [3] 3GPP TS 29.232: "Media Gateway Controller (MGC) – Media Gateway (MGW) Interface; Stage 3". +- [4] 3GPP TS 29.414: "Core Network Nb Data Transport and Signalling Transport". +- [5] ITU-T Recommendation Q.765.5 (06/2000): "Application Transport Mechanism". +- [6] ITU-T Recommendation Q.1902.1 (07/2001): "Bearer Independent Call Control CS2 Functional Description". Inclusive Amendment 3: "Support for the Customized Alerting Tone (CAT) service". +- [7] ITU-T Recommendation Q.1902.2 (07/2001): "Bearer Independent Call Control CS2 General functions of messages and parameters". Inclusive Amendment 5: "Support for the Customized Alerting Tone (CAT) service". +- [8] ITU-T Q.1902.3 (07/2001): "Bearer Independent Call Control CS2 Formats and Codes". Inclusive Amendment 5: "Support for the Customized Alerting Tone (CAT) service". +- [9] ITU-T Recommendation Q.1902.4 (07/2001): "Bearer Independent Call Control CS2 Basic Call Procedures". +- [10] ITU-T Recommendation Q.1902.5 (07/2001): "Exceptions to the Application Transport Mechanism in the Context of Bearer Independent Call Control". +- [11] ITU-T Recommendation Q.1902.6 (07/2001): "Generic Signalling Procedures for the support of the ISDN User Part Supplementary Services and for bearer redirection". +- [12] ITU-T Recommendation Q.1950 (07/2001): "Call Bearer Control Protocol". +- [13] ITU-T Recommendations Q.2630.1 (12/1999), Q.2630.2 (12/2000): "AAL type 2 signalling protocol". +- [14] ITU-T Recommendation Q.1990 (07/2001): "BICC Bearer Control tunnelling protocol". + +- [15] ITU-T Recommendation Q.1970 (07/2001): "BICC IP Bearer Control protocol". +- [16] ITU-T Recommendation Q.1912.1 (07/2001): "Interworking between Signalling System No. 7 ISDN user part and the Bearer Independent Call Control protocol". +- [17] ITU-T Recommendation Q.1912.2 (07/2001): "Interworking between selected Signalling System (PSTN Access DSS1, C5, R1, R2, TUP) and the Bearer Independent Call Control Protocol". +- [18] ITU-T Recommendation Q.2150.0 (05/2001): "Generic Signalling Transport Service". +- [19] ITU-T Recommendation Q.2150.1 (05/2001): "Signalling Transport Converter on MTP3 and MTP3b". +- [20] ITU-T Recommendation Q.2150.3 (12/2002): "Signalling Transport Converter on SCTP". +- [21] ITU-T Recommendation H.248.4 (11/2000): "Gateway Control Protocol: Transport over SCTP". +- [22] 3GPP TS 29.202: "SS7 signalling transport in core network". +- [23] ITU-T Recommendation H.248.5 (11/2000): "Gateway control protocol: Transport over ATM". +- [24] ITU-T Q.765 (06/2000): "Signalling system No. 7 – Application transport mechanism". +- [25] 3GPP TS 23.003: "Numbering, addressing and identification". +- [26] 3GPP TS 23.216: "Single Radio Voice Call Continuity (SRVCC); Stage 2". +- [27] 3GPP TS 23.237: "IP Multimedia subsystem (IMS) Service Continuity; Stage 2". +- [28] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [29] 3GPP TS 23.284: "Local Call Local Switch; Stage 2". + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +## 3.2 Symbols + +For the purposes of the present document, the following symbols apply: + +| | | +|----|-----------------------------------------------------| +| Nc | Interface between the (G)MSC servers. | +| Mc | Interface between the server and the media gateway. | +| Nb | Interface between media gateways (MGW). | + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations as defined in 3GPP TR 21.905 [28] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [28]. + +| | | +|------|----------------------------------| +| APM | Application Transport Mechanism | +| | Application Transport Message | +| APP | Application Transport Parameter | +| BAT | Bearer Association Transport | +| BICC | Bearer Independent Call Control | +| C5 | CCITT signalling system number 5 | +| GCR | Global Call Reference | +| LCLS | Local Call Local Switch | +| M3UA | MTP3 – User Adaptation Layer | +| MGC | Media Gateway Controller | +| MST | Mobile Service Transport | +| R1 | Regional Signalling System 1 | + +| | | +|------|--------------------------------------| +| R2 | Regional Signalling System 2 | +| SCTP | Stream Control Transmission Protocol | +| SN | Serving Node | +| TUP | Telephony User Part | + +# 4 Protocols + +Implementations providing any of the interfaces or protocols identified in the subclauses below shall implement the requirements of the specifications identified in those subclauses. + +## 4.1 Call control protocol (Nc interface) + +| | | +|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Q.1902.1 | BICC PROTOCOL (CS2) FUNCTIONAL DESCRIPTION [6] | +| Q.1902.2 | BICC PROTOCOL (CS2) AND SIGNALLING SYSTEM NO 7 ISUP
GENERAL FUNCTIONS OF MESSAGES AND PARAMETERS [7] | +| Q.1902.3 | BICC PROTOCOL (CS2) AND SIGNALLING SYSTEM NO 7 ISUP
FORMATS AND CODES [8] (NOTE) | +| Q.1902.4 | BICC (CS2) BASIC CALL PROCEDURES [9] | +| Q.1902.5 | EXCEPTIONS TO THE APM IN THE CONTEXT OF BICC [10]
AMENDMENT TO ITU-T RECOMMENDATION Q.765.5 FOR BICC CS2 [5] | +| Q.1902.6 | GENERIC SIGNALLING PROCEDURES AND SUPPORT OF THE ISDN USER PART SUPPLEMENTARY
SERVICES WITH THE BEARER INDEPENDENT CALL CONTROL PROTOCOL [11] | +| NOTE: | The "Backward CAT indicators" parameter shall be encoded as an optional 3-octet parameter in the ACM, CPG and SEG messages rather than as a 1-octet parameter as incorrectly defined in Amendment 5 of ITU-T Recommendation Q.1902.3 [8]. | + +## 4.2 Interworking with other protocols + +| | | +|----------|-------------------------------------------------------------------------------------------------------------------------------------------| +| Q.1912.1 | ISUP-BICC INTERWORKING [16] | +| Q.1912.2 | INTERWORKING BETWEEN SELECTED SIGNALLING SYSTEMS (PSTN ACCESS DSS1 C5 R1 R2 TUP)
AND THE BEARER INDEPENDENT CALL CONTROL PROTOCOL [17] | + +## 4.3 Resource control protocol (G)MSC and MGW (Mc Interface) + +| | | +|----------------|------------------------------------------------------------------------------| +| 3GPP TS 29.232 | "Media Gateway Controller (MGC) – Media Gateway (MGW) Interface;Stage 3" [3] | +|----------------|------------------------------------------------------------------------------| + +## 4.4 Bearer control protocol between MGWs (Nb interface) + +| | | +|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 3GPP TS 29.414 | "Core Network Nb Data Transport and Signalling Transport" [4]
including ITU-T Recommendation Q.1970 "IP bearer control protocol" [15] , ITU-T Recommendation Q.1990 "BICC tunneling control protocol" [14] , ITU-T Recommendation Q.2630.1-2 "AAL type 2 signalling protocol" [13]. | +|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +## 4.5 Signalling Transport + +### 4.5.1 Call Control protocols + +| | | +|----------------|--------------------------------------------------------------------------------------------| +| Q.2150.0 | "Generic Signalling Transport Service" [18] | +| Q.2150.1 | "Signalling Transport Converter on MTP3 and MTP3b" [19] | +| Q.2150.3 | "Signalling Transport Converter on SCTP" [20] | +| 3GPP TS 29.202 | "SS7 signalling transport in core network" [22] Annex A: The use of M3UA in 3GPP networks. | + +### 4.5.2 Resource control protocol (G)MSC and MGW (Mc Interface) + +| | | +|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 3GPP TS 29.232 | "Media Gateway Controller (MGC) – Media Gateway (MGW) Interface; Stage 3" [3] including ITU-T Recommendation H.248.4 "Transport over SCTP" [21], ITU-T Recommendation H.248.5 "Transport over ATM" [23], and 3GPP TS 29.202 "SS7 signalling transport in core network" [22] Annex A: The use of M3UA in 3GPP networks. | +|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +### 4.5.3 Bearer control protocol between MGWs (Nb interface) + +| | | +|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 3GPP TS 29.414 | "Core Network Nb Data Transport and signalling transport" [4] including ITU-T Recommendation Q.2630.1-2: "AAL type 2 signalling protocol" [13] and the tunnel-up and tunnel-down procedure in 3GPP TS 29.232 [31] | +|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +# --- Annex A: + +# Void + +# Annex B (normative): Transparent Support of Mobile Services + +## B.1 Introduction + +This Annex specifies a new mobile APM usage "Transparent support of mobile services". + +In ITU-T Recommendation Q.1902.3 [8], for the Application Transport Parameter (APP), the following codepoint is defined to refer to this application context identifier (ACI): + +0 0 0 0 1 1 1 MST + +The text in ITU-T Recommendation Q.1902.5 [10] shall be followed when implementing this application with the following clarification: + +- where the text refers to BAT ASE this shall be interpreted to mean Mobile Service Transport (MST) service. + +The MST service shall use implicit addressing; see ITU-T Recommendation Q.765 [24]. + +## B.2 Mobile Service Transport (MST) – Format and Codes + +### B.2.1 Encapsulated Application Information + +#### B.2.1.1 General Layout + +The general layout of the Encapsulated Application Information field of the Application Transport parameter as defined in ITU-T Recommendation Q.1902.3 [8] is shown in Table B.2.1.1.1. + +**Table B.2.1.1.1: Encapsulated application information field** + +| MSB | | | | | | | | LSB | | | | | | | | Octet | +|-----------------------------|---|---|---|---|---|---|---|-----|---|---|---|---|---|---|---|-------| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +| Identifier 1 | | | | | | | | | | | | | | | | 1 | +| Length indicator 1 | | | | | | | | | | | | | | | | 2 | +| Compatibility information 1 | | | | | | | | | | | | | | | | 3 | +| Contents 1 | | | | | | | | | | | | | | | | 4 | +| | | | | | | | | | | | | | | | | | +| Identifier n | | | | | | | | | | | | | | | | m | +| Length indicator n | | | | | | | | | | | | | | | | | +| Compatibility information n | | | | | | | | | | | | | | | | | +| Contents n | | | | | | | | | | | | | | | | p | + +Each information element within the Encapsulated Application Information field has the same structure. An information element consists of four fields which always appear in the following order: Identifier (one octet), Length indicator, Compatibility information, Contents. + +The Identifier distinguishes one type from another one and governs the interpretation of the contents. There are two types of Identifiers: type "constructor" and type "simple", for which the contents are defined as follows: + +- For a "constructor" type, the Contents field shall again consist of one or more information elements, each of which is structured as described above, i.e., Identifier, Length indicator, Compatibility information, Contents. +- For a "simple" type, the Contents field contains one value only. + +When passing on an information element of type "constructor", the order of the information elements within this "constructor" shall be maintained. + +The Length indicator specifies the length (i.e., integral number of octets in pure binary representation) of the Compatibility information and Contents. The length does not include the Identifier nor the Length indicator. + +The format of the Length indicator is shown in Table B.2.1.1.2. Bit 8 is defined as Extension indicator and indicates whether or not the information on the length continues through the next octet. Value "0" of the Extension indicator means "*information continues through the next octet*", while value "1" means "*last octet*". The Length indicator itself has a maximum length of 2 octets, i.e., if octet 1a is needed, the Extension indicator of octet 1a is always set to value "1". + +**Table B.2.1.1.2: Length indicator** + +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | Octet | +|--------|---|---|---|-----|---|---|-----|-------| +| ext. | | | | | | | LSB | 1 | +| ext. 1 | 0 | 0 | 0 | MSB | | | | 1a | + +The Compatibility information contains corresponding instructions for the case that the received information element is unrecognised. The format of this field is shown in Table B.2.1.1.3. + +**Table B.2.1.1.3: Compatibility information** + +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | Octet | +|------|-----------------------------------------------------|---|-----------------------|----------|-----------------------------------------------|---|-----------------------|-------| +| ext. | pass-on not possible
send notification indicator | | instruction indicator | reserved | general action
send notification indicator | | instruction indicator | 1 | + +The following codes are used in the subfields of the Compatibility information field. + +Bits 2 1 *Instruction indicator for general action* + +0 0 Pass on information element + +0 1 Discard information element + +1 0 Discard MST data + +1 1 Release call + +Bit 3 *Send notification indicator for general action* + +0 Do not send notification + +1 Send notification + +Bit 4 reserved + +Bits 6 5 *Instruction indicator for pass-on not possible* + +0 0 Release call + +0 1 Discard information element + +1 0 Discard MST data + +1 1 reserved (interpreted as 00) + +Bit 7 *Send notification indicator for pass-on not possible* + +0 Do not send notification + +1 Send notification + +Bit 8 *Extension indicator* + +0 Information continues through the next octet + +1 Last octet + +The Contents field is the substance of the element and contains the information the element is intended to convey. + +#### B.2.1.2 List of Identifiers + +Table B.2.1.2.1 contains the list of Identifiers. + +**Table B.2.1.2.1: List of identifiers** + +| Value | Information element name | Type | Reference | +|------------------------------|-----------------------------------|--------|-----------| +| 0000 0000 | spare | - | | +| 0000 0001 | Mobile Equipment Identifier | simple | B.2.1.3 | +| 0000 0010 | LCLS Negotiation Request | simple | B.2.1.4 | +| 0000 0011 | LCLS Negotiation Response | simple | B.2.1.5 | +| 0000 0100 | LCLS Status | simple | B.2.1.6 | +| 0000 0101 | LCLS Status Change | simple | B.2.1.7 | +| 0000 0110 | LCLS Status Result | simple | B.2.1.8 | +| 0000 0111 | LCLS Global Call Reference | simple | B.2.1.9 | +| 0000 1000 | LCLS Configuration Preference | simple | B.2.1.10 | +| 0000 1001 | LCLS Configuration Change Request | simple | B.2.1.11 | +| 0000 1010 | LCLS Configuration Change Result | simple | B.2.1.12 | +| 0000 1011
to
1101 1111 | reserved for 3GPP use | - | | +| 1110 0000
to
1111 1111 | reserved for national use | - | | + +#### B.2.1.3 Mobile Equipment Identifier + +The format of the Mobile Equipment Identifier is shown in Table B.2.1.3.1. + +**Table B.2.1.3.1: Mobile Equipment Identifier** + +| MSB | | | | | | | | LSB | | +|-----------------------------|---|---|---|---|---|---|---|-------|--| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | Octet | | +| Mobile Equipment Identifier | | | | | | | | 1 | | +| | | | | | | | | ... | | +| | | | | | | | | x | | + +The MEI contains either the International Mobile station Equipment Identity (IMEI) or the International Mobile station Equipment Identity and Software Version Number (IMEISV) as defined in subclause 6.2 of 3GPP TS 23.003 [25]. + +Both IMEI and IMEISV are TBCD encoded where IMEI is 15 digits and IMEISV is 16 digits. Bits 5 to 8 of octet n+1 (where n represents the octet of the IMEI(SV) being encoded) encodes digit 2n, bits 1 to 4 of octet n+1 encodes digit 2n-1 (i.e. the order of digits is swapped in each octet compared to the digit order defined in 3GPP TS 23.003 [25]). For IMEI, bits 5 to 8 of the last octet shall be filled with an end mark coded as '1111'. + +For the use of the Mobile Equipment Identifier (MEI) see 3GPP TS 23.216 [26] and 3GPP TS 23.237 [27]. + +#### B.2.1.4 LCLS Negotiation Request + +The format of the LCLS Negotiation Request is shown in Table B.2.1.4.1. + +**Table B.2.1.4.1: LCLS Negotiation Request** + +| MSB | | LSB | | | | | | Octet | +|---------------------|-------|-----|---|---|---|----------------------|---|-------| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +| Extension Indicator | Spare | | | | | Permission Indicator | | 1 | + +The LCLS Negotiation Request is sent in the forward direction to indicate LCLS usage permission. + +##### **Bit 1 2            Permission Indicator** + +| | | +|---------|-------------------------| +| 00 | LCLS is allowed | +| 01 | LCLS is not allowed | +| 10 – 11 | Reserved for future use | + +Bit 3 - 7            Spare + +##### **Bit 8                Extension Indicator** + +| | | +|---|-------------------------------------| +| 0 | information continues in next octet | +| 1 | last octet | + +For the use of the LCLS Negotiation Request IE see Annex C.2.1 and 3GPP TS 23.284 [29]. + +#### B.2.1.5 LCLS Negotiation Response + +The format of the LCLS Negotiation Response is shown in Table B.2.1.5.1. + +**Table B.2.1.5.1: LCLS Negotiation Response** + +| MSB | | LSB | | | | | | Octet | +|-------|---|-----|---|---|----------------------|---|---|-------| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +| Spare | | | | | Permission Indicator | | | 1 | + +The LCLS Negotiation Response contains information sent in the backwards direction to indicate result of the LCLS Negotiation Request. The LCLS Negotiation Response is coded as follows: + +##### **Bits 1 2            Permission Indicator** + +| | | +|----|--------------------------------------------| +| 00 | LCLS is allowed | +| 01 | LCLS is not allowed | +| 10 | LCLS is not supported by a subsequent node | +| 11 | spare | + +Bits 3 - 8            Spare + +For the use of the LCLS Negotiation Response IE see Annex C.2.2 and 3GPP TS 23.284 [29]. + +#### B.2.1.6 LCLS Status + +The format of the LCLS Status is shown in Table B.2.1.6.1. + +**Table B.2.1.6.1: LCLS Status** + +| • MSB | | | | | | | • LSB | Octet | +|-------------|---|---|---|---|---|---|-------|-------| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +| LCLS Status | | | | | | | | 1 | + +The LCLS Status contains information sent in forward and backward directions to indicate LCLS connection status. The LCLS Status is coded as follows: + +| Value | Meaning | +|-----------|----------------------------------------| +| 0000 0000 | no indication | +| 0000 0001 | LCLS is feasible but not yet connected | +| 0000 0010 | LCLS not connected | +| 0000 0011 | LCLS connected | + +All other values are reserved. + +For the use of the LCLS Status IE see Annex C.2.3, C.2.5 and 3GPP TS 23.284 [29]. + +#### B.2.1.7 LCLS Status Change + +The format of the LCLS Status Change is shown in Table B.2.1.7.1. + +**Table B.2.1.7.1: LCLS Status Change** + +| MSB | | | | | | | LSB | Octet | +|--------------------|---|---|---|---|---|---|-----|-------| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +| LCLS Status Change | | | | | | | | 1 | + +The LCLS Status Change Identifier contains information sent in forward and backward directions to indicate requested change of LCLS connection status. The LCLS Status Change Identifier is coded as follows: + +| Value | Meaning | +|-----------|---------------------------------------------| +| 0000 0000 | LCLS connection preparation | +| 0000 0001 | LCLS disconnection preparation | +| 0000 0010 | LCLS disconnection preparation for Handover | + +All other values are reserved. + +For the use of the LCLS Status Change IE see Annex C.2.6 and 3GPP TS 23.284 [29]. + +#### B.2.1.8 LCLS Status Result + +The format of the LCLS Status Result is shown in Table B.2.1.8.1. + +**Table B.2.1.8.1: LCLS Status Result** + +| MSB | | | | | | | LSB | Octet | +|-------|---|---|---------------------|---|---|----------------------|-----|-------| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +| Spare | | | Rejection Indicator | | | Acceptance Indicator | | 1 | + +The LCLS Status Result contains information sent in forward and backward directions to indicate result of the LCLS Status Change Request. The LCLS Status Result is coded as follows: + +| Bit 1 | Acceptance Indicator | +|-------|-------------------------------------| +| 0 | LCLS Status Change request accepted | +| 1 | LCLS Status Change request rejected | + +| | | +|---------------------|-------------------------------| +| Bits 2 3 4 5 | Rejection Indicator | +| 0000 | No indication | +| 0001 | Ongoing supplementary service | +| 0010 – 1111 | Reserved for future use | +| Bits 6 - 8 | Spare | + +For the use of the LCLS Status Result IE see Annex C.2.6 and 3GPP TS 23.284 [29]. + +#### B.2.1.9 LCLS Global Call Reference + +The format of the LCLS Global Call Reference (GCR) is shown in Table B.2.1.9.1. + +**Table B.2.1.9.1: LCLS Global Call Reference** + +| MSB | | | | LSB | | | | Octet | +|---------------------------------------------------|---|---|---|-----|---|---|---|---------------| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +| Network ID length indicator | | | | | | | | 1 | +| Network ID | | | | | | | | 2 | +| (variable length 3 – 5 octets) | | | | | | | | 4+m (m=0,1,2) | +| Node ID length indicator | | | | | | | | 5+m | +| Node ID | | | | | | | | 6+m | +| (fixed length: 2 octets) | | | | | | | | 7+m | +| Call Reference ID length indicator | | | | | | | | 8+m | +|
Call Reference ID
(fixed length: 5 octets) | | | | | | | | 9+m | +| | | | | | | | |
13+m | + +The LCLS GCR is information sent in forward direction to uniquely identify a call and correlate activities associated with that call. The LCLS GCR is coded as follows: + +- Network ID length indicator +Binary coded information indicating the number of octets in the Network ID field. +- Network ID +Information identifying a network. The Network ID field is specified in ITU-T Recommendation Q.1902.3 [8]. +- Node ID length Indicator +Binary coded information indicating the number of octets in the Node ID field. +- Node ID +A binary number that uniquely identifies within the network the node which generates the call reference. +- Call Reference ID length indicator +Binary coded information indicating the number of octets in the Call Reference ID field. +- Call Reference ID +A binary number used for the call reference of the call. It is generated by the originating serving node for each call. + +**NOTE:** If the originating serving radio access is GERAN the format of the Call Reference ID subfield is shown in Table B.2.1.9.2. The originating BSS ID is an integer that uniquely identifies the Base Station Subsystem (BSS) Node within an operator's network. + +**Table B.2.1.9.2: Call Reference ID** + +| MSB | | | | | | | | LSB | | | | | | | | +|------------------------------------------------|---|---|---|---|---|---|---|-----|--|--|--|--|--|--|-------| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | | | | Octet | +| Call Identifier
(fixed length: 3 octets) | | | | | | | | | | | | | | | 1 | +| Originating BSS ID
(fixed length: 2 octets) | | | | | | | | | | | | | | | 2 | + +For the use of the LCLS GCR IE see Annex C.2.1 and 3GPP TS 23.284 [29]. + +#### B.2.1.10 LCLS Configuration Preference + +The format of the LCLS Configuration Preference is shown in Table B.2.1.10.1. + +**Table B.2.1.10.1: LCLS Configuration Preference** + +| MSB | | | | | | | | LSB | | | | | | | | +|---------------------|-------|---|---|-----------------------------------|----------------------------------|---------------------------------|--------------------------------|-----|--|--|--|--|--|--|-------| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | | | | Octet | +| Extension Indicator | Spare | | | Backward Data Reception Indicator | Forward Data Reception Indicator | Backward Data Sending Indicator | Forward Data Sending Indicator | | | | | | | | 1 | + +The LCLS Configuration Preference contains information sent in forward and backward directions to indicate negotiated LCLS configuration preference. + +##### **Bit 1 Forward Data Sending Indicator** + +0 not required +1 required + +##### **Bit 2 Backward Data Sending Indicator** + +0 not required +1 required + +##### **Bit 3 Forward Data Reception Indicator** + +0 not required +1 required + +##### **Bit 4 Backward Data Reception Indicator** + +0 not required +1 required + +##### **Bits 5 - 7 Spare** + +##### **Bit 8 Extension Indicator** + +0 information continues in next octet +1 last octet + +For the use of the LCLS Configuration Preference IE see Annex C.2.1, C.2.2, C.2.4 and 3GPP TS 23.284 [29]. + +#### B.2.1.11 LCLS Configuration Change Request + +The format of the LCLS Configuration Change Request is shown in Table B.2.1.11.1. + +**Table B.2.1.11.1: LCLS Configuration Change Request** + +| MSB | | LSB | | | | | | Octet | +|---------------------|-------|-----|---|---|---|------|---|-------| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +| Extension Indicator | Spare | | | | | Type | | | +| | | | | | | | | 1 | + +The LCLS Configuration Change Request contains information sent in the forward and backward directions to indicate type of LCLS Configuration Change Request. + +| | | +|----------------|----------------------------------------------------| +| Bit 1 2 | Type | +| 00 | LCLS Configuration Preference Modification Request | +| 01 - 11 | Spare | +|
| | +| Bit 3 - 7 | Spare | +|
| | +| Bit 8 | Extension Indicator | +| 0 | information continues in next octet | +| 1 | last octet | + +For the use of the LCLS Configuration Change Request IE see Annex C.2.4 and 3GPP TS 23.284 [29]. + +#### B.2.1.12 LCLS Configuration Change Result + +The format of the LCLS Configuration Change Result is shown in Table B.2.1.12.1. + +**Table B.2.1.12.1: LCLS Configuration Change Result** + +| MSB | | LSB | | | | | | Octet | +|-------|---|---------------------|---|---|---|----------------------|---|-------| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +| Spare | | Rejection Indicator | | | | Acceptance Indicator | | | +| | | | | | | | | 1 | + +The LCLS Configuration Change Result contains information sent in the backward direction to indicate result of the LCLS Configuration Change Request. The LCLS Configuration Change Result is coded as follows: + +| | | +|---------------------|-------------------------------------------------------------------------------------------------------| +| Bit 1 | Acceptance Indicator | +| 0 | LCLS Configuration Change request accepted | +| 1 | LCLS Configuration Change request rejected (if set then Rejection Indicator provides further details) | +|
| | +| Bits 2 3 4 5 | Rejection Indicator | +| 0000 | No indication | +| 0001 | Requested LCLS configuration not supported | +| 0010 | Ongoing supplementary service | +| 0011 – 1111 | Reserved for future use | +|
| | +| Bits 6 - 8 | Spare | + +For the use of the LCLS Configuration Change Result IE see Annex C.2.4 and 3GPP TS 23.284 [29]. + +### B.2.2 Application Transport Instruction Indicators + +For the MST service the Application Transport Instruction Indicators (ATII) shall be set as follows: + +| | | | +|------|---|-------------------------------------| +| Bits | 1 | Release call indicator (RCI) | +| | 0 | do not release call | + +Bit 2 *Send notification indicator (SNI)* + +0 do not send notification + +# --- Annex C (normative): LCLS Service Application + +LCLS Service is defined in 3GPP TS 23.284 [29] and is dependent on the following identifiers being included in BICC/ISUP messaging. The following sections describe the detailed protocol behaviour when these identifiers are included. + +## --- C.1 Use of MST ASE + +LCLS service makes use of the services of the MST ASE described in Annex B. The services of the MST ASE are accessed by means of primitives (such as "MST\_data") which are the same as BAT ASE primitives defined in ITU-T Recommendation Q.765.5 [5]. + +## --- C.2 Procedures + +### C.2.1 Indication of LCLS Capability + +#### C.2.1.1 LCLS Service Capability Indication + +LCLS service shall be used for a call if MST\_data primitive associated with an IAM includes LCLS Information Elements: a LCLS GCR, a LCLS Negotiation Request and a LCLS Configuration Preference. The absence of the LCLS Negotiation, the LCLS Configuration Preference and the LCLS GCR Information Elements in the IAM specifies that the LCLS service shall not be used. + +The compatibility information of the LCLS Negotiation Request, the LCLS Configuration Preference and the LCLS GCR Information Elements shall be set so as to cause the Information Element to be discarded by nodes that do not support LCLS service. + +The procedures for call establishment using the LCLS service are described in 3GPP TS 23.284 [29]. + +#### C.2.1.2 Actions at Originating Serving Node + +An originating Serving Node (SN) that supports the LCLS service shall indicate this within the IAM message of the mobile originating call by including the LCLS Negotiation Request, the LCLS Configuration Preference and the LCLS GCR Information Elements within the MST Application Transport Parameter (APP) within the IAM. + +When the LCLS service is allowed to be used the IAM is sent to the succeeding node with the Permission Indicator of the LCLS Negotiation Request Information Element set to "LCLS is allowed". + +Depending on network requirements the originating SN may additionally indicate required configurations for user plane connectivity towards originating or terminating UE within the LCLS Configuration Preference Information Element. If the originating MSC server needs to: + +- send data towards the terminating UE it shall set Forward Data Sending Indicator to "required"; +- send data towards the originating UE it shall set Backward Data Sending Indicator to "required"; +- receive data from the originating UE it shall set Forward Data Reception Indicator to "required"; +- receive data from the terminating UE it shall set Backward Data Reception Indicator to "required". + +The originating SN shall perform the setting of LCLS Configuration Preference Information Element according to rules specified in sub-clause 4.2 of 3GPP TS 23.284 [29] or it may determine that LCLS is not allowed and indicate this by setting the value of Permission Indicator of the LCLS Negotiation Request Information Element to "LCLS is not allowed". + +#### C.2.1.3 Actions at Intermediate Serving Node + +For the intermediate Serving Node (SN), LCLS service indication (i.e. LCLS GCR, LCLS Negotiation Request and LCLS Configuration Preference Information Elements) shall be included only if received from the preceding node and if the node itself supports the LCLS service. + +The intermediate SN shall not change the LCLS GCR Information Element. If the intermediate SN receives Permission Indicator of the LCLS Negotiation Request Information Element set to "LCLS is not allowed" it shall not change it. + +Depending on network requirements the intermediate SN may additionally indicate required configurations for user plane connectivity towards originating or terminating UE by changing the received LCLS Configuration Preference Information Element. If the intermediate SN needs to: + +- send data towards the terminating UE it shall set Forward Data Sending Indicator to "required"; +- send data towards the originating UE it shall set Backward Data Sending Indicator to "required"; +- receive data from the originating UE it shall set Forward Data Reception Indicator to "required"; +- receive data from the terminating UE it shall set Backward Data Reception Indicator to "required". + +If the intermediate SN receives any of these indicators set to "required" it shall not change them. + +#### C.2.1.4 Actions at Destination Serving Node + +For the destination Serving Node (SN), LCLS service shall be supported only if the IAM with the LCLS Negotiation Request, LCLS Configuration Preference and LCLS GCR Information Elements within the MST Application Transport Parameter (APP) is received from the preceding node and if the node itself supports the LCLS service. + +Depending on network requirements the destination SN may additionally modify received configurations for user plane connectivity towards originating or terminating UE, by changing the settings of the LCLS Configuration Preference Information Element. If the destination SN needs to: + +- send data towards the terminating UE it shall set Forward Data Sending Indicator to "required"; +- send data towards the originating UE it shall set Backward Data Sending Indicator to "required"; +- receive data from the originating UE it shall set Forward Data Reception Indicator to "required"; +- receive data from the terminating UE it shall set Backward Data Reception Indicator to "required". + +If the destination SN receives any of these indicators set to "required" it shall not change them. + +The destination SN shall perform modification of LCLS Configuration Preference Information Element according to rules specified in sub-clause 4.2 of 3GPP TS 23.284 [29] or it may determine that LCLS is not allowed and shall indicate this by setting the value of Permission Indicator of the LCLS Negotiation Response Information Element to "LCLS is not allowed". + +### C.2.2 Backward LCLS Negotiation during Call Setup + +#### C.2.2.1 Introduction + +LCLS service shall be used for a call if MST\_data primitive associated with first backward (APM or ACM) message includes a LCLS Negotiation Response and a LCLS Configuration Preference Information Elements. The absence of the LCLS Negotiation Response and the LCLS Configuration Preference Information Elements in the first backward message specifies that the LCLS service shall not be used. + +The compatibility information of the LCLS Negotiation Response and the LCLS Configuration Preference Information Elements shall be set so as to cause the Information Element to be discarded by nodes that do not support LCLS service. + +#### C.2.2.2 Actions at Destination Serving Node + +If LCLS service is supported according to conditions specified in sub-clause C.2.1.4 a destination SN shall include in the first backward message (APM or ACM) the LCLS Negotiation Response and the LCLS Configuration Preference Information Elements in the MST\_Data request primitive. + +#### C.2.2.3 Actions at Intermediate Serving Node + +If LCLS service is supported according to conditions specified in sub-clause C.2.1.3 but a succeeding node does not return LCLS Negotiation Response Information Element in the first backward message, an Intermediate SN shall include the LCLS Negotiation Response Information Element. The Permission Indicator of the LCLS Negotiation Response Information Element shall be set to "LCLS is not supported by a subsequent node". + +On receipt of a backward message (APM, ACM or CPG) with the LCLS Negotiation Response and the LCLS Configuration Preference Information Elements the Intermediate SN shall store the LCLS configuration settings from the LCLS Configuration Preference Information Element and shall forward the LCLS Negotiation Response and the LCLS Configuration Preference Information Elements unchanged. + +#### C.2.2.4 Actions at Originating Serving Node + +If the first backward message does not contain the LCLS Negotiation Response and the LCLS Configuration Preference Information Elements the originating SN shall assume that LCLS is not supported by succeeding node and LCLS shall not be performed for that call; no further LCLS signalling shall take place for that call. + +If the first backward message contains the LCLS Negotiation Response Information Element but the Permission Indicator is set to "LCLS Not Allowed" or "LCLS is not supported by a subsequent node" then the originating SN shall not request establishment of the LCLS connection at this time. + +NOTE: A subsequent LCLS Negotiation Response Information Element can be received from succeeding nodes, e.g. in the event of a call forwarding on no reply. + +### C.2.3 Answer message + +#### C.2.3.1 Introduction + +LCLS connection may be established for a call if MST\_data primitive associated with an ANM includes a LCLS Status Identifier Information Element. The absence of the LCLS Status Identifier Information Element in the ANM specifies that the LCLS connection shall not be requested. + +The compatibility information of the LCLS Status Identifier shall be set so as to cause the Information Element to be discarded by nodes that do not support LCLS service. + +#### C.2.3.2 Actions at Destination Serving Node + +If a destination SN determines that LCLS service is feasible according to the conditions specified in sub-clause 6.2.1.3.4 of 3GPP TS 23.284 [29] it shall include the LCLS Status Identifier Information Element set to "LCLS feasible but not yet connected" within the MST Application Transport Parameter (APP) within the ANM. + +#### C.2.3.3 Actions at Intermediate Serving Node + +An Intermediate SN shall pass the LCLS Status Identifier within the ANM unchanged. + +#### C.2.3.4 Actions at Originating Serving Node + +When an originating SN receives an ANM with the LCLS Status Identifier indicating the LCLS service is feasible it shall request LCLS connection. + +### C.2.4 LCLS Configuration Change Request + +#### C.2.4.1 Introduction + +Modification of a LCLS configuration can only occur after the LCLS negotiation has been performed during the call set-up phase according to the procedures described in sub-clauses C.2.1 and C.2.2. A SN involved in a LCLS Configuration Change procedure must not initiate a new LCLS Configuration Change Request until the existing LCLS Configuration Change procedure has been completed. + +A LCLS Configuration Change Request message may be sent in either direction and at any time during the active phase of a call, after the LCLS negotiation has been performed during the call establishment. A LCLS Configuration Change Request and a LCLS Configuration Preference Information Elements indicating the requested change of the LCLS configuration shall be included in a MST\_data primitive, corresponding to an APM message. + +A MST\_Data primitive, corresponding to the APM message shall be issued in response, including the LCLS Configuration Preference and the LCLS Configuration Change Result Information Elements indicating if the requested change of LCLS configuration has been accepted and if it has not been accepted the reason for rejection. + +The compatibility information of the LCLS Configuration Preference, the LCLS Configuration Change Request and LCLS Configuration Change Result Information Elements shall be set so as to cause the Information Element to be discarded and send notification by nodes that do not support LCLS service. + +NOTE: The term "initiating" SN in the following clauses refers to a SN which initiates the LCLS Configuration Change Request. The term "terminating" SN in the following clauses refers to a SN which terminates the LCLS Configuration Change Request. + +#### C.2.4.2 Actions at Initiating Serving Node + +If a SN determines that LCLS configuration needs to be changed it may send an APM message which includes a LCLS Configuration Change Request and the LCLS Configuration Preference Information Elements to its succeeding and/or preceding node. The initiating SN shall set the desired configurations as described in sub-clause C.2.1.2. + +The LCLS Configuration Change Request may only be initiated if LCLS Negotiation was performed during call establishment. + +NOTE: this does not require that LCLS was permitted during the call establishment. + +On receipt of an APM message containing the LCLS Configuration Preference and the LCLS Configuration Change Result Information Elements, if the result indicates "accepted" the modification of the LCLS Configuration settings has been successful. If the LCLS Configuration Change Result Information Element indicates "rejected" the initiating SN shall resume the LCLS connection with the LCLS configuration unchanged. + +#### C.2.4.3 Actions at Intermediate Serving Node + +When an intermediate SN receives an APM message with the LCLS Configuration Change Request and the LCLS Configuration Preference Information Elements requesting a certain LCLS Configuration Change the intermediate SN shall check if it can support the requested LCLS configuration. If the intermediate SN can support the proposed LCLS configuration it shall forward the LCLS Configuration Preference and the LCLS Configuration Change Request Information Elements to its succeeding or preceding node. If the intermediate SN cannot support/permit the proposed LCLS configuration it shall respond with a LCLS Configuration Change Result Information Element set to "LCLS Configuration Change request rejected" along with the Rejection Indicator detailing the reason for rejection. + +On receipt of an APM message with the LCLS Configuration Change Result and LCLS Configuration Preference Information Elements from its succeeding/preceding node if the LCLS Configuration Change Result Information Elements indicates "accepted" the intermediate SN shall store the LCLS configuration settings from the LCLS Configuration Preference Information Element and shall forward the APM message to its preceding/succeeding node. + +If the LCLS Configuration Change Result Information Element indicates "rejected" the intermediate SN shall resume the LCLS connection with the LCLS configuration unchanged and the intermediate SN shall forward the APM message to its preceding/succeeding node. + +#### C.2.4.4 Actions at Terminating Serving Node + +When an SN which is a terminating SN with respect to a LCLS Configuration Change Request receives an APM message with the LCLS Configuration Change Request and LCLS Configuration Preference Information Elements requesting a certain LCLS Configuration Change the terminating SN shall check if it can support the requested LCLS configuration. + +If the terminating SN can support the proposed LCLS configuration change it shall return the LCLS Configuration Preference Information Element and the LCLS Configuration Change Result Information Element indicating acceptance of the LCLS Configuration Change to its succeeding or preceding node. If the terminating SN cannot support/permit the proposed LCLS configuration it shall respond with a LCLS Configuration Change Result Information Element set to "LCLS Configuration Change request rejected" along with the Rejection Indicator detailing the reason for rejection. + +### C.2.5 LCLS Status Update + +#### C.2.5.1 Introduction + +A LCLS Status Update message may be sent in either direction to indicate that a LCLS connection status has been changed. A LCLS Status Identifier Information Element indicating the new LCLS connection status value shall be included in a MST\_data primitive, corresponding to an APM message. + +The compatibility information of the LCLS Status Identifier shall be set so as to cause the Information Element to be discarded and send notification by nodes that do not support LCLS service. + +NOTE: The term "initiating" SN in the following clauses refers to an originating SN or a destination SN that may initiate the LCLS Status Update message. The term "terminating" SN in the following clauses refers to an originating SN or a destination SN that may receive the LCLS Status Update message. + +#### C.2.5.2 Actions at Initiating Serving Node + +If a SN determines that the LCLS connection status has been changed it shall send the new LCLS connection status value to an adjacent SN. An initiating SN shall send the LCLS Status Identifier Information Element within the MST Application Transport Parameter (APP) within the APM message. + +#### C.2.5.3 Actions at Intermediate Serving Node + +When an intermediate SN receives the APM message with the LCLS Status Identifier Information Element from the preceding/succeeding SN and if the same LCLS connection status value has not been already received from the succeeding/preceding SN, the intermediate SN shall store the new LCLS Connection status value and shall pass the LCLS Status Identifier Information Element within the APM message unchanged to its succeeding/preceding SN. + +#### C.2.5.4 Actions at Terminating Serving Node + +When a terminating SN receives the APM message with the LCLS Status Identifier Information Element from the adjacent SN, it shall update its LCLS connection status value. + +### C.2.6 LCLS Status Change Request + +#### C.2.6.1 Introduction + +A LCLS Status Change Request message may be sent in either direction and at any time during the active phase of a call, after the LCLS has been initially established. A LCLS Status Change Identifier Information Element indicating the requested change of the LCLS connection status shall be included in a MST\_data primitive, corresponding to an APM message. + +An MST\_Data primitive, corresponding to the APM message shall be issued in response, including the LCLS Status Change Identifier Information Element and a LCLS Status Result Identifier Information Element indicating if the requested change of LCLS connection status has been accepted and if it has not been accepted the reason for rejection. + +The compatibility information of the LCLS Status Change Identifier and the LCLS Status Result Identifier shall be set so as to cause the Information Element to be discarded and send notification by nodes that do not support LCLS service. + +NOTE: The term "initiating" SN in the following clauses refers to a SN which initiates the LCLS Status Change. The term "terminating" SN in the following clauses refers to a SN which terminates the LCLS Status Change. + +#### C.2.6.2 Actions at Initiating Serving Node + +When a SN determines that the LCLS connection status needs to be changed, it shall request the change of the LCLS connection status from its preceding and/or succeeding SN. An initiating SN shall send the LCLS Status Change Identifier Information Element within the MST Application Transport Parameter (APP) within an APM message. + +An APM message containing the LCLS Status Change Identifier Information Element and a LCLS Status Result Identifier Information Element will be received in response from the succeeding and/or preceding SN. + +If initiating SN is an SN serving a Radio Network (originating SN or destination SN), upon reception of the LCLS Status Result Identifier Information Element indicating the acceptance of the requested LCLS connection status change, the initiating SN shall change the LCLS connection status. + +NOTE: This change of LCLS connection status can be deferred until signalling interaction with the served Radio Network Controller, which is outside of the scope of this specification. + +#### C.2.6.3 Actions at Intermediate Serving Node + +When an intermediate SN receives from a preceding/succeeding SN an APM message that includes a LCLS Status Change Identifier Information Element within the MST Application Transport Parameter (APP) it shall check if it can support the required change of the LCLS connection status. + +If the intermediate SN cannot support the requested change of the LCLS connection status it shall respond to the preceding/succeeding SN with the APM message containing the LCLS Status Change Identifier Information Element and a LCLS Status Result Identifier Information Element with an Acceptance indicator set to "LCLS Status Change request rejected" along with a Rejection Indicator detailing the reason for rejection. + +If the intermediate SN can support the required change of the LCLS connection status it shall pass the LCLS Status Change Identifier Information Element within the APM message unchanged to its succeeding/preceding SN. An APM message will be received in response, including the LCLS Status Change Identifier Information Element and a LCLS Status Result Identifier Information Element from its succeeding/preceding SN. The intermediate SN shall pass the LCLS Status Change Identifier Information Element and the LCLS Status Result Identifier Information Element within the APM message unchanged to its succeeding/preceding SN. + +#### C.2.6.4 Actions at Terminating Serving Node + +Upon reception of an APM message that includes a LCLS Status Change Identifier Information Element, from the adjacent SN, a terminating SN shall check if it can support the required change of the LCLS connection status. + +If the terminating SN can support the required change, it shall change the LCLS connection status. If the result of the LCLS connection status change is successful the terminating SN shall send to the adjacent SN the APM message with the LCLS Status Change Identifier Information Element and a LCLS Status Result Identifier Information Element indicating the acceptance of the requested LCLS connection status change. + +NOTE: If the terminating SN is an SN serving a Radio Network (originating SN or destination SN), there can be additional signalling with the served Radio Network Controller, prior to responding to the LCLS Status Change Request; this is, however, outside of the scope of this specification. + +If the result of the LCLS connection status change is unsuccessful or if the terminating SN cannot support the required change it shall respond to the adjacent SN with the APM message containing the LCLS Status Change Identifier Information Element and a LCLS Status Result Identifier Information Element with an Acceptance indicator set to "LCLS Status Change request rejected" along with a Rejection Indicator detailing the reason for rejection. + +# Annex D (informative): Change history + +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | New | +|---------|---------------------------------|-----------|------|------|-----------------------------------------------------------------------------------|--------| +| 17/1/01 | CN3/CN4
#66
Beijing | | | 0.1. | New Document approved | 0.1.0 | +| 15/2/01 | Ad hoc
CN 4#6 in
Madrid | | | 0.2 | Revised Document approved | 0.2.0 | +| 01/3/01 | CN 4 #7
Sophia—
Antopolis | | | 0.3 | Forwarded to TSG CN Plenary meeting #11 for approval | 2.0.0 | +| 03/2001 | CN#11 | NP-010083 | | | Modifications made during CN#11 | 2.1.0 | +| 03/2001 | CN#11 | NP-010214 | | | Approved in CN#11 | 4.0.0 | +| 06/2001 | CN#12 | NP-010285 | 0001 | 1 | Changes to provide interworking between signalling transport | 4.1.0 | +| 09/2001 | CN#13 | | | | Editorial clean up | 4.2.0 | +| 09/2001 | CN#13 | NP-010452 | 0002 | | Mc signalling transport in IP environment | 4.2.0 | +| 09/2001 | CN#13 | NP-010452 | 0003 | 1 | BICC signalling transport in IP environment | 4.2.0 | +| 09/2001 | CN#13 | NP-010452 | 0004 | | Status of ITU recommendation Q.2150.3 | 4.2.0 | +| 06/2002 | CN#16 | | | | Rel-5 created after CN#16 | 5.0.0 | +| 06/2003 | CN#20 | NP-030220 | 0006 | 2 | Alignment of references after renumbering of H248 by ITU-T | 5.1.0 | +| 12/2004 | CN#26 | | | | Rel-6 created after CN#26 | 6.0.0 | +| 06/2006 | CT#32 | CP-060298 | 0009 | 1 | | 6.1.0 | +| 06/2007 | CT#36 | | | | Upgraded unchanged from Rel-6 | 7.0.0 | +| 12/2008 | CT#42 | | | | Upgraded unchanged from Rel-7 | 8.0.0 | +| 06/2009 | CT#44 | CP-090312 | 0011 | 2 | Amendment for "multimedia Customized Alerting Tone (CAT) service in ITU ISUP/BICC | 8.1.0 | +| 06/2009 | CT#44 | CP-090499 | 0013 | 1 | Mobile Service Application Transport | 9.0.0 | +| 12/2009 | CT#46 | CP-090801 | 0017 | 2 | Introduction of IMEI IE to Mobile APM for SRVCC Emergency Call | 9.1.0 | +| 06/2010 | CT#48 | CP-100267 | 0020 | 1 | ITU amendments for Customized Alerting Tone (CAT) | 9.2.0 | +| 06/2010 | CT#48 | CP-100278 | 0018 | | IPBCP version | 9.2.0 | +| 03/2011 | CT#51 | CP-110041 | 0027 | 1 | Correcting non-specific external references | 9.3.0 | +| 03/2011 | CT#51 | CP-110081 | 0021 | 1 | Introduction of LCLS Application to Mobile Service Application Transport | 10.0.0 | +| 06/2011 | CT#52 | CP-110376 | 0028 | | Miscellaneous corrections | 10.1.0 | +| 09/2011 | CT#53 | CP-110571 | 0034 | | Indication of LCLS Negotiation type | 10.2.0 | +| 12/2011 | CT#54 | CP-110799 | 0036 | 1 | Correction to Procedures for Indication of LCLS Capability | 10.3.0 | +| 12/2011 | CT#54 | CP-110799 | 0037 | 2 | Correction to Procedures for Backward LCLS Negotiation | 10.3.0 | +| 12/2011 | CT#54 | CP-110799 | 0038 | 1 | Correction to Procedures for LCLS in Answer message | 10.3.0 | +| 12/2011 | CT#54 | CP-110799 | 0039 | 2 | Correction to Procedures for LCLS Negotiation Change | 10.3.0 | +| 12/2011 | CT#54 | CP-110799 | 0040 | 1 | Correction to Procedures for LCLS Status Update | 10.3.0 | +| 12/2011 | CT#54 | CP-110799 | 0041 | 1 | Correction to Procedures for LCLS Status Change | 10.3.0 | +| 12/2011 | CT#54 | CP-110799 | 0043 | 1 | Re-specify Information Elements for LCLS Negotiation and LCLS Negotiation Change | 10.3.0 | +| 12/2012 | CT#57 | | | | Upgraded unchanged from Rel-7 | 11.0.0 | +| 2014-09 | - | - | - | - | Update to Rel-12 version (MCC) | 12.0.0 | +| 2015-12 | CT#70 | - | - | - | Update to Rel-13 version (MCC) | 13.0.0 | +| 2017-03 | CT#75 | - | - | - | Update to Rel-14 version (MCC) | 14.0.0 | +| 2018-06 | CT#80 | - | - | - | Update to Rel-15 version (MCC) | 15.0.0 | +| 2020-07 | CT#88e | - | - | - | Update to Rel-16 version (MCC) | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29217/731f533b0599c8e42a063f06e4332045_img.jpg b/marked/Rel-16/29_series/29217/731f533b0599c8e42a063f06e4332045_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4feca453bb209dfb2f1d789eb3c98837df1cb20c --- /dev/null +++ b/marked/Rel-16/29_series/29217/731f533b0599c8e42a063f06e4332045_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:81728a1632efb214a3707a2351f3a87c356ff49874d3b9026a1c8d0483101bf6 +size 6527 diff --git a/marked/Rel-16/29_series/29217/raw.md b/marked/Rel-16/29_series/29217/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..542ad8a1a1fc9f0c604807136fe2d890885aa9ad --- /dev/null +++ b/marked/Rel-16/29_series/29217/raw.md @@ -0,0 +1,879 @@ + + + + +Error! No +text of + +Error! No text of specified style in +document. + +# Contents + +| | | +|--------------------------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions and abbreviations ..... | 7 | +| 3.1 Definitions..... | 7 | +| 3.2 Abbreviations ..... | 7 | +| 4 Np reference point..... | 7 | +| 4.1 Overview ..... | 7 | +| 4.2 Np reference model ..... | 8 | +| 4.3 Functional elements..... | 8 | +| 4.3.1 RCAF..... | 8 | +| 4.3.2 PCRF ..... | 9 | +| 4.3.3 H-PCRF ..... | 9 | +| 4.3.4 V-PCRF ..... | 9 | +| 4.4 Procedures over Np reference point..... | 9 | +| 4.4.1 RUCI Report..... | 9 | +| 4.4.1.1 General..... | 9 | +| 4.4.1.2 Non-aggregated RUCI report..... | 10 | +| 4.4.1.3 Aggregated RUCI report..... | 10 | +| 4.4.2 Reporting Restriction Provisioning ..... | 10 | +| 4.4.3 UE mobility between RCAFs..... | 11 | +| 4.4.4 Removal of UE context ..... | 11 | +| 4.4.5 Race condition handling ..... | 12 | +| 5 Np protocol ..... | 12 | +| 5.1 Protocol support ..... | 12 | +| 5.2 Initialization, maintenance and termination of connection and session..... | 12 | +| 5.3 Np specific AVPs..... | 13 | +| 5.3.1 General ..... | 13 | +| 5.3.2 Aggregated-Congestion-Info AVP..... | 13 | +| 5.3.3 Aggregated-RUCI-Report AVP ..... | 13 | +| 5.3.4 Congestion-Level-Definition AVP..... | 14 | +| 5.3.5 Congestion-Level-Range AVP..... | 14 | +| 5.3.6 Congestion-Level-Set-Id AVP ..... | 14 | +| 5.3.7 Congestion-Level-Value AVP..... | 14 | +| 5.3.8 Congestion-Location-Id AVP..... | 15 | +| 5.3.9 Conditional-Restriction AVP ..... | 15 | +| 5.3.10 eNodeB-Id AVP ..... | 15 | +| 5.3.11 IMSI-List AVP ..... | 15 | +| 5.3.12 RCAF-Id AVP ..... | 16 | +| 5.3.13 Reporting-Restriction AVP ..... | 16 | +| 5.3.14 RUCI-Action AVP ..... | 16 | +| 5.3.15 Extended-eNodeB-Id AVP ..... | 17 | +| 5.4 Np re-used AVPs..... | 17 | +| 5.4.1 General ..... | 17 | +| 5.4.2 Use of the Supported-Features AVP on the Np reference point..... | 18 | +| 5.5 Np specific Experimental-Result-Code AVP values ..... | 19 | +| 5.5.1 General ..... | 19 | +| 5.5.2 Success ..... | 19 | +| 5.5.3 Permanent Failures ..... | 19 | +| 5.5.4 Transient Failures ..... | 19 | +| 5.6 Np messages..... | 19 | +| 5.6.0 Command-Code Values..... | 19 | +| 5.6.1 Non-Aggregated-RUCI-Report-Request (NRR) command ..... | 20 | +| 5.6.2 Non-Aggregated-RUCI-Report-Answer (NRA) command..... | 20 | +| 5.6.3 Aggregated-RUCI-Report-Request (ARR) command..... | 21 | +| 5.6.4 Aggregated-RUCI-Report-Answer (ARA) command..... | 21 | + +5.6.5        Modify-Uecontext-Request (MUR) command..... 21 +5.6.6        Modify-Uecontext-Answer (MUA) command..... 22 +Annex A (informative):        Change history..... 23 + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- Y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# 1 Scope + +The present document provides the stage 3 specification of the Np reference point. The functional requirements and the stage 2 specifications of the Np reference point are contained in 3GPP TS 23.203 [2]. The Np reference point lies between the RAN Congestion Awareness Function (RCAF) and the Policy and Charging Rules Function (PCRF) for the non-roaming case, between the RCAF and the H-PCRF for the home-routed scenario and between the RCAF and the V-PCRF for the visited access scenario. + +NOTE: If not specified explicitly, the PCRF also means H-PCRF for the home-routed scenario or V-PCRF in the visited access scenario in the specification. + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.203: "Policy and charging control architecture". +- [3] 3GPP TS 29.213: "Policy and Charging Control signalling flows and QoS parameter mapping". +- [4] IETF RFC 4005: "Diameter Network Access Server Application". +- [5] IETF RFC 4006: "Diameter Credit Control Application". +- [6] 3GPP TS 29.229: "Cx and Dx interfaces based on Diameter protocol; Protocol details". +- [7] IETF RFC 3588: "Diameter Base Protocol". +- [8] 3GPP TS 23.401: "GPRS enhancements for E-UTRAN access". +- [9] 3GPP TS 23.060: "General Packet Radio Service (GPRS); Service description; Stage 2". +- [10] 3GPP TS 29.215: "Policy and Charging Control (PCC) over S9 reference point; Stage 3". +- [11] 3GPP TS 29.061: "Interworking between the Public Land Mobile Network (PLMN) supporting packet based services and Packet Data Networks (PDN)". +- [12] 3GPP TS 29.274: "3GPP Evolved Packet System. Evolved GPRS Tunnelling Protocol for EPS (GTPv2)". +- [13] ITU-T Recommendation E.212: "The international identification plan for mobile terminals and mobile users". +- [14] 3GPP TS 29.212: "Policy and Charging Control (PCC); Reference points". +- [15] IETF RFC 7683: "Diameter Overload Indication Conveyance". +- [16] IETF RFC 7944: "Diameter Routing Message Priority". +- [17] IETF RFC 8583: "Diameter Load Information Conveyance". +- [18] IETF RFC 6733: "Diameter Base Protocol". +- [19] IETF RFC 5719: "Updated IANA Considerations for Diameter Command Code Allocations". + +# 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +**Home Routed Access:** Roaming scenario where the PCEF is located in the HPLMN. In a Home Routed roaming scenario, the UE obtains access to the packet data network from the HPLMN. + +**RAN user plane congestion:** RAN user plane congestion occurs when the demand for RAN resources exceeds the available RAN capacity to deliver the user data for a prolonged period of time. + +NOTE: Short-duration traffic bursts is a normal condition at any traffic load level, and is not considered to be RAN user plane congestion. Likewise, a high-level of utilization of RAN resources (based on operator configuration) is considered a normal mode of operation and might not be RAN user plane congestion. + +**Visited Access (also known as local breakout):** Roaming scenario where the PCEF is located in the VPLMN. In a Visited Access Roaming scenario, the UE obtains access to the packet data network from the VPLMN. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|--------|---------------------------------------| +| AF | Application Function | +| ARR | Aggregated RUCI Report Request | +| ARA | Aggregated RUCI Report Answer | +| DRMP | Diameter Routing Message Priority | +| H-PCRF | Home PCRF | +| MUR | Modify Uecontext Request | +| MUA | Modify Uecontext Answer | +| NRR | Non-Aggregated RUCI Report Request | +| NRA | Non-Aggregated RUCI Report Answer | +| PCC | Policy and Charging Control | +| PCRF | Policy and Charging Rule Function | +| RCAF | RAN Congestion Awareness Function | +| RUCI | RAN User Plane Congestion Information | +| V-PCRF | Visited PCRF | + +# 4 Np reference point + +## 4.1 Overview + +The Np reference point is located between the RCAF and the PCRF for the non-roaming scenario, between the RCAF and the H-PCRF for the home-routed scenario and between the RCAF and the V-PCRF for the visited access scenario. The Np reference point is used for: + +- Reporting the RUCI from the RCAF to the PCRF; +- Provisioning the Reporting Restriction from the PCRF to the RCAF; +- The User Equipment (UE) mobility between RCAF; +- The removal of the UE context in the RCAF. + +The stage 2 level requirements for the Np reference point are defined in 3GPP TS 23.203 [2]. + +Signalling flows related to Np interface are specified in 3GPP TS 29.213 [3]. + +Refer to Annex G of 3GPP TS 29.213 [3] for Diameter overload control procedures over the Np interface. + +Refer to Annex J of 3GPP TS 29.213 [3] for Diameter message priority mechanism procedures over the Np interface. + +Refer to Annex K of 3GPP TS 29.213 [3] for Diameter load control procedures over the Np interface. + +## 4.2 Np reference model + +The relationships between the involved functional entities are depicted in figure 4.2.1. The overall PCC architecture is depicted in clause 3a of 3GPP TS 29.213 [3] . + +![Diagram of the Np reference model showing RCAF and PCRF connected via the Np interface.](731f533b0599c8e42a063f06e4332045_img.jpg) + +The diagram shows two rectangular boxes, one on the left labeled 'RCAF' and one on the right labeled 'PCRF'. A horizontal line connects the two boxes. Above the line, centered between the boxes, is the label 'Np'. There is a small vertical tick mark on the line between the two boxes. + +Diagram of the Np reference model showing RCAF and PCRF connected via the Np interface. + +**Figure 4.2.1: Np reference model** + +NOTE: For the home-routed access scenario, the RCAF interacts with the H-PCRF. For the visited access scenario, the RCAF interacts with the V-PCRF. + +**Figure 4.2.2: Void** + +**Figure 4.2.3: Void** + +## 4.3 Functional elements + +### 4.3.1 RCAF + +The RCAF is a functional element which reports RAN User Plane Congestion Information (RUCI) via the Np interface to the PCRF to enable the PCRF to take the RAN user plane congestion status into account for policy decisions. RUCI includes the following information: + +- The user id (e.g. IMSI) identifying the UE impacted by congestion; +- PDN ID for which congestion information is reported; +- Congestion level information (either congestion level value or congestion level set id) of the UE impacted by congestion; +- eNodeB identifier, ECGI or SAI identifying the eNodeB, E-UTRAN cell or Service Area respectively, serving the UE if a conditional restriction to restrict location reporting is not enabled. + +NOTE 1: In case of E-UTRAN, whether the eNodeB identifier or the ECGI are included in the RUCI is up to operator configuration in the RCAF. + +The RCAF sends the RUCI to the PCRFs serving the UEs' PDN connections as follows: + +- For a PDN connection in a non-roaming scenario the RCAF reports the RUCI to the PCRF; +- For a PDN connection in a local breakout scenario, based on operator configuration, the RCAF reports the RUCI to the V-PCRF; +- For a PDN connection in a home routed scenario, based on the roaming agreement with the HPLMN and operator configuration, the RCAF reports the RUCI to the H-PCRF + +NOTE 2: Reporting of congestion information to the HPLMN may be used e.g. in case of a group of PLMNs which belong to a single business entity. + +The RCAF determines whether a given PDN connection is served in a local breakout or a home routed roaming scenario based on the APN operator identifier received as part of the APN information from the MME or the SGSN as documented in 3GPP TS 23.401 [8] and 3GPP TS 23.060 [9], respectively. + +NOTE 3: Operator configuration can be used to limit RUCI reporting on the Np interface to certain APNs only. + +The RCAF maintains a context per user id and APN. The context is identified by the IMSI and the APN. It contains the following information: + +- The previously reported congestion level over the Np reference point; +- The reporting restrictions received from the PCRF. The reporting restrictions are stored by the RCAF until the PCRF explicitly signals to remove the reporting restrictions. +- The logical PCRF id received from the PCRF to identify the PCRF that is the Np destination for the RCAF when sending aggregate messages. + +### 4.3.2 PCRF + +The PCRF is a functional element that encompasses policy control decision and flow based charging control functionalities. + +The PCRF may receive RUCI from the RCAF as input for policy decisions of congestion mitigation. The PCRF may provide, update or remove the reporting restrictions of RUCI, or stop or enable RUCI reporting for a given user id and PDN ID. The PCRF may enable or disable the reporting of congestion location identifier as part of RUCI. The PCRF may also remove the context at the RCAF for a given user id and PDN ID. + +NOTE: Depending on the RUCI reporting interval configured in the RCAF, a UE can move outside the area indicated without the RCAF immediately notifying the PCRF. In case the PCRF receives information about the cell currently serving a UE via Np and Gx when the location change reporting is enabled, then the information received via Gx is expected to take precedence. + +### 4.3.3 H-PCRF + +Functionality defined in clause 4.3.2 shall apply if UE is roaming with home-routed access scenario. + +NOTE: Reporting of congestion information to the HPLMN can be used e.g. in case of a group of PLMNs which belong to a single business entity. + +### 4.3.4 V-PCRF + +Functionality defined in clause 4.3.2 shall apply if UE is roaming with visited access scenario. + +## 4.4 Procedures over Np reference point + +### 4.4.1 RUCI Report + +#### 4.4.1.1 General + +The RCAF shall perform the RUCI reporting to the PCRF when at least one of the following conditions applies: + +- the RCAF detects a UE in the congestion area for the first time; +- a reporting restriction is enabled and the congestion level set id is changed; +- a reporting restriction is not enabled and the congestion level value is changed; +- a conditional restriction to restrict location reporting is not enabled and the UE is in a congested area and the location is changed; or +- the RCAF detects that the UE is no longer experiencing congestion (i.e. the UE is no longer detected in any of the congested cells that the RCAF is monitoring). + +The RCAF shall report the RUCI to the PCRF unless the RUCI reporting is disabled for the PDN ID or for the user id and the PDN ID. + +Two types of RUCI reports may be used on Np for transfer of congestion information from RCAF to PCRF: Non-aggregated RUCI report and Aggregated RUCI report. If the RCAF does not know the destination PCRF for the user id and PDN ID, the Non-aggregated RUCI report shall be used; otherwise the RCAF may use either the Non-aggregate RUCI report or Aggregated RUCI report for the user id and PDN ID. + +#### 4.4.1.2 Non-aggregated RUCI report + +For a Non-aggregated RUCI report, the RCAF shall send an NRR command to the PCRF by including the user id within the Subscription-Id AVP, PDN ID within the Called-Station-Id AVP and a congestion level set id within the Congestion-Level-Set-Id AVP if the reporting restriction was provided earlier or a congestion level value within the Congestion-Level-Value AVP if the reporting restriction was not provided earlier at the command level. The RCAF may also provide congestion location identifier of the UE within the Congestion-Location-Id AVP in the NRR command. The RCAF shall also include the RCAF Identity within the RCAF-Id AVP in every NRR command for a specific user id and PDN ID. + +Once the PCRF receives the NRR command, the PCRF shall store the related info and respond with an NRA command including the PCRF id within the PCRF-Address AVP. The PCRF may use the RUCI received from the RCAF as input for policy decisions. When the RCAF receives the NRA command, the RCAF may store the PCRF id in the UE context for this specific user id together with PDN ID for further aggregated RUCI report. + +If the ReportRestriction feature is supported by both the RCAF and the PCRF, the PCRF may provide reporting restrictions in the NRA command according to clause 4.4.2. + +#### 4.4.1.3 Aggregated RUCI report + +For an Aggregated RUCI report, the RCAF shall aggregate the RUCIs of different user ids and PDN IDs that have the same destination PCRF. The RCAF shall send an ARR command to the destination PCRF by including the PCRF id within the Destination-Host AVP, one or more Aggregated-RUCI-Report AVP with a congestion level set id within the Congestion-Level-Set-Id AVP if the reporting restriction was provided earlier or a congestion level value within the Congestion-Level-Value AVP if the reporting restriction was not provided earlier, the PDN ID within the Called-Station-ID AVP and a list of aggregated congestion information within the Aggregated-Congestion-Info AVP. + +NOTE 1: Each instance of Aggregated-RUCI-Report AVP aggregates the user id list of the subscribers that share the same level of congestion or share the same congestion level set id. + +NOTE 2: When the RCAF assembles a Diameter ARR command, if the message length of ARR command has exceeded the maximum length of Diameter message which can be configurable, the RCAF can divide the original ARR command into multiple aggregated RUCI messages for the delivery over Np reference point. + +Once the PCRF receives the ARR command, the PCRF shall store the related info and respond with an ARA command. The PCRF may use the RUCI received from the RCAF as input for policy decisions. + +### 4.4.2 Reporting Restriction Provisioning + +If the ReportRestriction feature is supported by both the RCAF and the PCRF, the PCRF may provide the reporting restrictions for a specific user id and PDN ID in the initial NRA command. The PCRF may also provide, modify or disable restrictions for RUCI reporting or stop or enable RUCI reporting for the specific user id and PDN ID at any later time. The PCRF may also use this procedure to enable or disable the reporting of congestion location identifier as part of RUCI. + +In order to initially provide the reporting restrictions, the PCRF shall send a Modify-Uecontext-Request (MUR) command including the targeted Subscription-Id AVP indicating the user id, the Called-Station-Id AVP indicating the targeted PDN ID and one or more Congestion-Level-Definition AVP(s) including the defined congestion level set within the Congestion-Level-Set-Id AVP and corresponding congestion level(s) within the Congestion-Level-Range AVP or reply with an NRA command including one or more Congestion-Level-Definition AVP(s) including the defined congestion level set within the Congestion-Level-Set-Id AVP and corresponding congestion level(s) within the Congestion-Level-Range AVP. The PCRF may also include the Reporting-Restriction AVP and Conditional-Restriction AVP to indicate when conditional reporting restrictions apply. + +The PCRF may modify already provided reporting restrictions. To do so the PCRF shall provide the complete list of congestion level sets and corresponding congestion levels to be used in the same manner as when initially providing reporting restrictions. This complete list shall replace any previously provided list. The absence of Reporting-Restriction AVP and Conditional-Restriction AVP indicates that previous state of reporting restrictions remains valid. + +If reporting restrictions has been provided for a specific user id and PDN ID, the PCRF may remove the reporting restrictions by, in the MUR command, including the Reporting-Restriction AVP set to 0 (No reporting restriction), together with Subscription-Id AVP indicating the user id and the Called-Station-Id AVP indicating the targeted PDN ID or reply with an NRA command including the Reporting-Restriction AVP set to 0 (No reporting restriction). + +The PCRF may disable RUCI reporting by, in the MUR command, including the RUCI-Action AVP set to 0 (Disable RUCI Reporting), together with Subscription-Id AVP indicating the user id and the Called-Station-Id AVP indicating the targeted PDN ID or reply with an NRA command including the RUCI-Action AVP set to 0 (Disable RUCI Reporting). + +To enable RUCI Reporting if previously disabled, the PCRF in the MUR command shall include the RUCI-Action AVP set to 1 (Enable RUCI Reporting), together with Subscription-Id AVP indicating the user id and the Called-Station-Id AVP indicating the targeted PDN ID or reply with an NRA command including the RUCI-Action AVP set to 1 (Enable RUCI Reporting). + +If reporting restrictions also applies, the PCRF shall include one or more Congestion-Level-Definition AVP(s) including the defined congestion level set with the Congestion-Level-Set-Id AVP and corresponding congestion level(s) within the Congestion-Level-Range AVP, within the same command. + +To provision the reporting restriction which disables the reporting of congestion location identifier of the UE as part of RUCI, the PCRF shall include Reporting-Restriction AVP set to 1 (Conditional reporting restriction) and Conditional-Restriction AVP with the bit 0 be set. To enable a previously disabled reporting of the congestion location identifier of the UE as part of RUCI, the PCRF shall include Reporting-Restriction AVP set to 2 (Unconditional reporting restriction). + +The PCRF shall include the value of the RCAF-Id AVP received in the NRR command for the specific user id and PDN ID in the Destination-Host AVP of the MUR command. + +The RCAF acknowledges the received MUR command by sending a Modify-Uecontext-Answer (MUA) command in all cases above. + +### 4.4.3 UE mobility between RCAFs + +If RUCI reporting is used for a specific user id and PDN ID and the PCRF receives a new non-aggregated RUCI report for the same user id and PDN ID but with a different RCAF id included in the RCAF-Id AVP, the PCRF shall update the related information and respond with an NRA command according to clause 4.4.1.1. + +The PCRF shall also initiate a removal of the UE context to the old RCAF according to clause 4.4.4. + +### 4.4.4 Removal of UE context + +This procedure is initiated when the PCRF needs to remove a UE context from the RCAF, e.g. at UE mobility between RCAFs. + +If the PCRF due to an event determines that a UE context needs to be removed from the RCAF, the PCRF shall send an MUR command to the targeted RCAF to explicitly release the context related to the user id and PDN ID by including the Subscription-Id AVP indicating the user id, the Called-Station-Id AVP indicating the PDN ID, the Destination-Host AVP indicating the targeted RCAF id and the RUCI-Action AVP set to 2 (Release Context). + +The RCAF when receiving the MUR command from the PCRF shall release the context related to the user id and PDN ID. If this is the last PDN ID stored for this user id the RCAF shall release the complete context. + +The RCAF shall acknowledge the received MUR command by sending an MUA command. + +### 4.4.5 Race condition handling + +If the RCAF receives an MUR command to remove a context for a specific user id and PDN ID, the request shall be handled immediately, regardless of whether there are any ongoing RUCI report transactions for that user id and PDN ID. + +If the PCRF receives an NRR command for a specific user id and PDN ID, and if there is an ongoing MUR command to remove the context for that user id and PDN ID, the PCRF shall reject the incoming request with a Diameter experimental result code of DIAMETER\_PENDING\_TRANSACTION. + +If the PCRF receives an ARR command for specific user id and PDN ID combinations for which there is at least one ongoing MUR command to remove the context, the PCRF shall accept the request and only update the context(s) that are not in the process of being removed. + +# --- 5 Np protocol + +## 5.1 Protocol support + +The Np application is defined as a vendor specific Diameter application, where the vendor is 3GPP and the Application-ID for the Np Application in the present release is 16777342. The vendor identifier assigned by IANA to 3GPP () is 10415. + +NOTE: A route entry can have a different destination based on the application identification AVP of the message. Therefore, Diameter agents (relay, proxy, redirection, translation agents) must be configured appropriately to identify the 3GPP Np application within the Auth-Application-Id AVP in order to create suitable routeing tables. + +With regard to the Diameter protocol defined over the Np interface, the PCRF acts as a Diameter server, in the sense that it is the network element that handles the RUCI reporting for a particular realm. The RCAF acts as the Diameter client, in the sense that it is the network element reporting the RUCI. + +## 5.2 Initialization, maintenance and termination of connection and session + +The initialization and maintenance of the connection between the RCAF and PCRF are defined by the underlying protocol. Establishment and maintenance of connections between Diameter nodes are described in IETF RFC 6733 [18]. + +After establishing the transport connection, the RCAF and the PCRF shall advertise the support of the Np specific Application by including the value of the application identifier in the Auth-Application-Id AVP and the value of the 3GPP (10415) in the Vendor-Id AVP of the Vendor-Specific-Application-Id AVP contained in the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands. The Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands are specified in the Diameter Base Protocol (IETF RFC 6733 [18]). + +The Np Diameter session shall be terminated after each request and answer pair interaction. + +In order to indicate that the session state is not to be maintained, the Diameter client and server shall include the Auth-Session-State AVP with the value set to NO\_STATE\_MAINTAINED (1), in the request and in the answer messages (see IETF RFC 6733 [18]). + +## 5.3 Np specific AVPs + +### 5.3.1 General + +Table 5.3.1.1 describes the Diameter AVPs defined for the Np reference point, their AVP Code values, types, possible flag values, whether or not the AVP may be encrypted and which supported features the AVP is applicable to. The Vendor-Id header of all AVPs defined in the present document shall be set to 3GPP (10415). + +Table 5.3.1.1: Np specific Diameter AVPs + +| Attribute Name | AVP Code | Clause defined | Value Type (NOTE 2) | AVP Flag rules (NOTE 1) | | | | May Encr. | Applicability (NOTE 3) | +|-----------------------------|----------|----------------|---------------------|-------------------------|-----|------------|----------|-----------|------------------------| +| | | | | Mus t | May | Should not | Must not | | | +| Aggregated-Congestion-Info | 4000 | 5.3.2 | Grouped | V, M | P | | | Y | | +| Aggregated-RUCI-Report | 4001 | 5.3.3 | Grouped | V, M | P | | | Y | | +| Congestion-Level-Definition | 4002 | 5.3.4 | Grouped | V | P | | M | Y | ReportRestriction | +| Congestion-Level-Range | 4003 | 5.3.5 | Unsigned32 | V | P | | M | Y | ReportRestriction | +| Congestion-Level-Set-Id | 4004 | 5.3.6 | Unsigned32 | V | P | | M | Y | ReportRestriction | +| Congestion-Level-Value | 4005 | 5.3.7 | Unsigned32 | V, M | P | | | Y | | +| Congestion-Location-Id | 4006 | 5.3.8 | Grouped | V | P | | M | Y | ReportRestriction | +| Conditional-Restriction | 4007 | 5.3.9 | Unsigned32 | V | P | | M | Y | ReportRestriction | +| eNodeB-Id | 4008 | 5.3.10 | OctetString | V, M | P | | | Y | | +| IMSI-List | 4009 | 5.3.11 | OctetString | V, M | P | | | Y | | +| RCAF-Id | 4010 | 5.3.12 | DiameterIdentity | V, M | P | | | Y | | +| Reporting-Restriction | 4011 | 5.3.13 | Unsigned32 | V | P | | M | Y | ReportRestriction | +| RUCI-Action | 4012 | 5.3.14 | Unsigned32 | V | P | | M | Y | ReportRestriction | +| Extended-eNodeB-Id | 4013 | 5.3.15 | OctetString | V, M | P | | M | Y | | + +NOTE 1: The AVP header bit denoted as 'M', indicates whether support of the AVP is required. The AVP header bit denoted as 'V', indicates whether the optional Vendor-ID field is present in the AVP header. For further details, see IETF RFC 6733 [18]. + +NOTE 2: The value types are defined in IETF RFC 6733 [18]. + +NOTE 3: AVPs marked with a supported feature (e.g. "ReportRestriction") are applicable as described in clause 5.4.2. + +### 5.3.2 Aggregated-Congestion-Info AVP + +The Aggregated-Congestion-Info AVP (AVP code 4000) is of type Grouped. It contains a list of user ids identified by IMSI and optionally the congestion location id in which the list of user ids are located. + +``` +Aggregated-Congestion-Info ::= < AVP Header: 4000 > + [ Congestion-Location-Id ] + [ IMSI-List ] + *[ AVP ] +``` + +### 5.3.3 Aggregated-RUCI-Report AVP + +The Aggregated-RUCI-Report AVP (AVP code 4001) is of type Grouped, and it is used to contain the congestion level value or congestion level set id for a set of users which have the same PCRF for the same PDN ID. + +The congestion-Level-Value AVP contains the congestion level value if the PCRF did not provide the reporting restriction earlier for the user id and PDN ID. + +The Congestion-Level-Set-Id AVP contains the congestion level set identifier between the PCRF and the RCAF if the PCRF provided the reporting restriction earlier for the user id and PDN ID. + +The Called-Station-Id AVP contains the PDN ID. + +The Aggregated-Congestion-Info AVP shall indicate the list of users included in the IMSI-List AVP and the congested location included in the Congestion-Location-Id AVP (if applicable), where a congestion level included in the Congestion-Level-Value AVP or congestion level set included in the Congestion-Level-Set-Id AVP shall apply. + +``` +Aggregated-RUCI-Report ::= < AVP Header: 4001 > + 1*{ Aggregated-Congestion-Info } + [ Called-Station-Id ] + [ Congestion-Level-Value ] + [ Congestion-Level-Set-Id ] + *[ AVP ] +``` + +### 5.3.4 Congestion-Level-Definition AVP + +The Congestion-Level-Definition AVP (AVP code 4002) is of type Grouped, and it is used to define a congestion level set and corresponding congestion level(s) to be used by the RCAF for a specific user id and PDN ID at congestion reporting. When this AVP is present in the MUR command reporting restrictions apply, when this AVP is absent there are no reporting restriction for the specific user id and PDN ID. + +``` +Congestion-Level-Definition ::= < AVP Header: 4002 > + { Congestion-Level-Set-Id } + { Congestion-Level-Range } + *[ AVP ] +``` + +### 5.3.5 Congestion-Level-Range AVP + +The Congestion-Level-Range AVP (AVP code 4003) is of type Unsigned32, and it is used to indicate the list of congestion level(s) bound to a certain congestion level set, between the PCRF and the RCAF. The Congestion-Level-Range AVP shall contain a bit mask. The bit 0 shall be the least significant bit. For example, to get the value of bit 0, a bit mask of 0x0001 should be used. The meaning of the bits shall be as defined below: + +**Table 5.3.5.1: Congestion Level Range** + +| Bit | Name | Description | +|-----|----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | No congestion | This bit, when set, indicates that the RCAF shall report the corresponding congestion level set id to the PCRF when there is no congestion for a certain user id and PDN ID. | +| 1 | Congestion level 1 | This bit, when set, indicates that the RCAF shall report the corresponding congestion level set id to the PCRF when congestion level 1 is reached for a certain user id and PDN ID. | +| 1+n | Congestion level 1+n | This bit, when set, indicates that the RCAF shall report the corresponding congestion level set id to the PCRF when congestion level 1+n is reached for a certain user id and PDN ID. | + +### 5.3.6 Congestion-Level-Set-Id AVP + +The Congestion-Level-Set-Id AVP (AVP code 4004) is of type Unsigned32, and it is used to indicate the congestion level set identifier between the PCRF and the RCAF. + +### 5.3.7 Congestion-Level-Value AVP + +The Congestion-Level-Value AVP (AVP code 4005) is of type Unsigned32, and it is used to indicate the congestion level associated with the user id and PDN ID. + +The following values are defined: + +0 (No congestion): + +This value indicates that there is no congestion. + +N (Congestion level n): + +These values indicate that there is congestion. The value n is an integer between 1 and 31 and indicates a congestion level. The value 1 is the lowest congestion level and value 31 is the highest congestion level. + +### 5.3.8 Congestion-Location-Id AVP + +The Congestion-Location -Id AVP (AVP code 4006) is of type Grouped, and it indicates the identifier of a congested location in which the UE is currently located. The congested location is one of the following: the eNodeB, E-UTRAN cell or Service Area serving the UE. If ECGI is included in the 3GPP-User-Location-Info AVP within Congestion-Location-Id AVP, then the eNodeB identifier within eNodeB-Id AVP or Extended-eNodeB-Id AVP shall not be + +included in this AVP. This AVP is provided in the RUCI per user id and APN. If the eNodeB identifier has a length of 18 or 21 bits it shall be provided in the Extended-eNodeB-Id AVP and otherwise in the eNodeB-Id AVP. + +AVP Format: + +``` +Congestion-Location-Id ::= < AVP Header: 4006 > + [ 3GPP-User-Location-Info ] + [ eNodeB-Id ] + [ Extended-eNodeB-Id ] + *[ AVP ] +``` + +### 5.3.9 Conditional-Restriction AVP + +The Conditional-Restriction AVP (AVP code 4007) is of type Unsigned32 and it shall contain a bit mask, and indicates what conditional reporting restrictions apply. Conditional reporting restrictions shall apply when this AVP is provided. The bit 0 shall be the least significant bit. For example, to get the value of bit 0, a bit mask of 0x0001 should be used. The meaning of the bits shall be as defined below: + +**Table 5.3.9.1: Conditional-Restriction over Np** + +| Bit | Name | Description | +|-----|---------------------------------------|--------------------------------------------------------------------------------------------------------------------| +| 0 | UE location info not included in RUCI | This bit, when set, indicates that the location information of the UE shall not be included in RUCI for reporting. | + +### 5.3.10 eNodeB-Id AVP + +The eNodeB-Id AVP (AVP code 4008) is of type OctetString, and indicates the eNodeB in which the UE is currently located. The AVP shall be coded as in clause 8.51 of 3GPP TS 29.274 [12]. + +### 5.3.11 IMSI-List AVP + +The IMSI-List AVP (AVP code 4009) is of type OctetString, and it contains a list of user ids identified by IMSI. Each IMSI shall be encoded as TBCD digits as defined in ITU-T Recommendation E.212 [13], i.e. digits from 0 through 9 are encoded "0000" to "1001". Each IMSI shall be encoded as 8 octets. If the length of the IMSI is 14, then the last octet shall be encoded as "1111 1111". If the length of the IMSI is 15, bits 5 to 8 of the last octet shall be encoded with the filler "1111". The maximum number of digits is 15. An example of the encoding of the IMSI List as the data part of the OctetString AVP is given below in Figure 5.3.11-1. Octet 1 given below is the first octet of the data part of the IMSI-List AVP. + +| Octets | Bits | | | | | | | | +|-----------|---------------------------|---|---|---|---------------------------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Number digit 2 of IMSI-1 | | | | Number digit 1 of IMSI-1 | | | | +| 2 | Number digit 4 of IMSI-1 | | | | Number digit 3 of IMSI-1 | | | | +| ... | ... | | | | ... | | | | +| 8 | 1111 | | | | Number digit 15 of IMSI-1 | | | | +| 9 | Number digit 2 of IMSI-2 | | | | Number digit 1 of IMSI-2 | | | | +| 10 | Number digit 4 of IMSI-2 | | | | Number digit 3 of IMSI-2 | | | | +| ... | ... | | | | ... | | | | +| 15 | Number digit 14 of IMSI-2 | | | | Number digit 13 of IMSI-2 | | | | +| 16 | 1111 | | | | 1111 | | | | +| 17 | Number digit 2 of IMSI-3 | | | | Number digit 1 of IMSI-3 | | | | +| 18 | Number digit 4 of IMSI-3 | | | | Number digit 3 of IMSI-3 | | | | +| ... | ... | | | | ... | | | | +| 23 | Number digit 14 of IMSI-3 | | | | Number digit 13 of IMSI-3 | | | | +| 24 | 1111 | | | | 1111 | | | | +| ... | ... | | | | ... | | | | +| (n-1)*8+1 | Number digit 2 of IMSI-n | | | | Number digit 1 of IMSI-n | | | | +| (n-1)*8+2 | Number digit 4 of IMSI-n | | | | Number digit 3 of IMSI-n | | | | +| ... | ... | | | | ... | | | | +| (n-1)*8+8 | 1111 | | | | Number digit 15 of IMSI-n | | | | + +NOTE: In the above figure showing an example of encoding, it is assumed that n IMSIs are included in the IMSI-List AVP. The digit length of IMSI-1, IMSI-2, IMSI-3 and IMSI-n are 15, 14, 14, 15 respectively. + +**Figure 5.3.11-1: Encoding of IMSI-List AVP** + +### 5.3.12 RCAF-Id AVP + +The RCAF-Id AVP (AVP code 4010) is of type DiameterIdentity, and it is used to contain the RCAF identity. + +### 5.3.13 Reporting-Restriction AVP + +The Reporting-Restriction AVP (AVP code 4011) is of type Unsigned32, and it is used to indicate the applicable reporting restrictions between the PCRF and RCAF. If this AVP is not provided during the initial reporting restriction provisioning, it shall be understood as unconditional reporting restrictions apply. + +The following values are defined: + +0 (No reporting restriction): + +This value shall be used by the PCRF to indicate to the RCAF that there are no restrictions on congestion reporting for a specific user id and PDN ID. This value shall not be used if congestion level definitions are included in the same command. + +1 (Conditional reporting restriction): + +This value shall be used by the PCRF to indicate to the RCAF that there are conditional restrictions on congestion reporting for a specific user id and PDN ID. + +2 (Unconditional reporting restriction): + +This value shall be used by the PCRF to indicate to the RCAF that there are unconditional restrictions on congestion reporting for a specific user id and PDN ID. + +### 5.3.14 RUCI-Action AVP + +The RUCI-Action AVP (AVP code 4012) is of type Unsigned32, and it is used to disable or enable RUCI reporting between the PCRF and RCAF or to release the context for a specific user id and PDN ID. + +The following values are defined: + +0 (Disable RUCI reporting): + +This value shall be used by the PCRF to indicate to the RCAF that RUCI reporting shall not be performed for a specific user id and PDN ID. + +#### 1 (Enable RUCI reporting): + +This value shall be used by the PCRF to indicate to the RCAF that RUCI reporting shall be performed for a specific user id and PDN ID. + +#### 2 (Release Context): + +This value shall be used by the PCRF to indicate to the RCAF that the context shall be released for a specific user id and PDN ID. + +### 5.3.15 Extended-eNodeB-Id AVP + +The Extended-eNodeB-Id AVP (AVP code 4013) is of type OctetString, and indicates the eNodeB in which the UE is currently located. The AVP shall be coded as in clause 8.51 of 3GPP TS 29.274 [12] for Type Extended Macro eNodeB. + +## 5.4 Np re-used AVPs + +### 5.4.1 General + +Table 5.4.1.1 lists the Diameter AVPs re-used by the Np reference point from other existing Diameter Applications, reference to their respective specifications, short description of their usage within the Np reference point and which supported features the AVP is applicable to. AVPs from existing Diameter Applications, except for the AVPs from Diameter base protocol, do not need to be supported. The AVPs from Diameter base protocol are not included in table 5.4.1.1, but they are re-used for the Np reference point. Unless otherwise stated, re-used AVPs shall maintain their 'M', 'P' and 'V' flag settings. Where RADIUS VSAs are re-used, unless otherwise stated, they shall be translated to Diameter AVPs as described in RFC 4005 [4] with the exception that the 'M' flag shall be set and the 'P' flag may be set. + +**Table 5.4.1.1: Np re-used Diameter AVPs** + +| Attribute Name | Reference | Description | Applicability (NOTE) | +|--------------------------------------------------------------------------------------------|----------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| Called-Station-Id | IETF RFC 4005 [4] | The address the user is connected to (i.e. the PDN identifier). | | +| DRMP | IETF RFC 7944 [16] | Allows Diameter endpoints to indicate the relative priority of Diameter transactions. | | +| Load | IETF RFC 8583 [17] | The AVP used to convey load information between Diameter nodes. This AVP and all AVPs within this grouped AVP shall have the 'M' bit cleared. | | +| OC-OLR | IETF RFC 7683 [15] | Contains the necessary information to convey an overload report. | | +| OC-Supported-Features | IETF RFC 7683 [15] | Defines the support for the Diameter overload indication conveyance by the sending node. | | +| PCRF-Address | TS 29.215 [10] | The identity, which indicates the destination PCRF. | | +| Subscription-Id | IETF RFC 4006 [5] | The identification of the subscription (i.e. IMSI) | | +| Supported-Features | TS 29.229 [6] | If present, this AVP informs the destination host about the features that the origin host requires to successfully complete this command exchange | | +| 3GPP-User-Location-Info | TS 29.061 [11], clause 16.4.7.2. | Indicates details of where the UE is currently located. Only SAI (Geographic Location Type set to 1) or ECGI (Geographic Location Type set to 129) is included in this information. | | +| NOTE: AVPs marked with a supported feature are applicable as described in subclause 5.4.2. | | | | + +### 5.4.2 Use of the Supported-Features AVP on the Np reference point + +When new functionality is introduced on the Np reference point, it should be defined as optional. If backwards incompatible changes cannot be avoided, the new functionality shall be introduced as a new feature and support advertised with the Supported-Features AVP. Unless otherwise stated, the use of the Supported-Features AVP on the Np reference point shall be compliant to the usage of the Supported-Features AVP on the Cx reference point and consistent with the procedures for the dynamic discovery of supported features as defined in clause 7.2 of 3GPP TS 29.229 [6]. + +When extending the application by adding new AVPs for a feature, the new AVPs shall have the M bit cleared and the AVP shall not be defined mandatory in the command ABNF. + +As defined in 3GPP TS 29.229 [6], the Supported-Features AVP is of type grouped and contains the Vendor-Id, Feature-List-ID and Feature-List AVPs. On the all reference points as specified in this specification, the Supported-Features AVP is used to identify features that have been defined by 3GPP and hence, for features defined in this document, the Vendor-Id AVP shall contain the vendor ID of 3GPP (10415). If there are multiple feature lists defined for the reference point, the Feature-List-ID AVP shall differentiate those lists from one another. + +The Supported-Features AVP shall be included in every NRR and NRA command if supported by the RCAF and PCRF respectively. + +The table below defines the features applicable to the Np interface for the feature list with a Feature-List-ID of 1. + +**Table 5.4.2.1: Features of Feature-List-ID 1 used in Np** + +| Feature bit | Feature | M/O | Description | +|-------------------------------------------------------------------------------------------------------------------------------------|-------------------|-----|-------------------------------------------------------------| +| 0 | ReportRestriction | O | This feature indicates the support of reporting restriction | +| Feature bit: The order number of the bit within the Feature-List AVP where the least significant bit is assigned number "0". | | | | +| Feature: A short name that can be used to refer to the bit and to the feature, e.g. "EPS". | | | | +| M/O: Defines if the implementation of the feature is mandatory ("M") or optional ("O") in this 3GPP Release. | | | | +| Description: A clear textual description of the feature. | | | | + +## 5.5 Np specific Experimental-Result-Code AVP values + +### 5.5.1 General + +This clause defines result code values that shall be supported by Diameter implementations that conform to this specification. + +### 5.5.2 Success + +Result Codes that fall into the Success category are used to inform a peer that a request has been successfully completed. The Result-Code AVP values defined in Diameter BASE IETF RFC 6733 [18] are applied. + +### 5.5.3 Permanent Failures + +Errors that fall into the Permanent Failures category shall be used to inform the peer that the request has failed. The Result-Code AVP values defined in Diameter Base Protocol IETF RFC 6733 [18] are applied. As an addition the following Result-Code AVP value defined in IETF RFC 4006 [5] is applicable: + +DIAMETER\_USER\_UNKNOWN (5030): + +This error shall be used by the PCRF to indicate to the RCAF that the end user specified in the request is unknown to the PCRF, or it shall be used by the RCAF to indicate to the PCRF that the end user specified in the request is unknown to the RCAF. This result code does not apply for aggregated RUCI report. + +### 5.5.4 Transient Failures + +Errors that fall within the Transient Failures category are used to inform a peer that the request could not be satisfied at the time it was received, but may be able to satisfy the request in the future. + +The Result-Code AVP values defined in Diameter Base IETF RFC 6733 [18] are applicable. As an addition the following Experimental-Result-Code value defined in 3GPP TS 29.212 [14] is applicable: + +DIAMETER\_PENDING\_TRANSACTION (4144): + +This error shall be used when a node receives an incoming request for a specific user id and PDN ID while it has an ongoing transaction for the same user id and PDN ID and cannot handle the request as described in clause 4.4.5. + +## 5.6 Np messages + +## 5.6.0 Command-Code Values + +This subclause defines the Command-Code values for the Np interface application as allocated by IANA from the vendor-specific namespace defined in IETF RFC 5719 [x]. Every command is defined by means of the ABNF syntax in IETF RFC 2234 [y], and according to the rules in IETF RFC 6733 [18]. + +NOTE: As the commands in the present specification have originally been defined based on the former specification of the Diameter Base Protocol (IETF RFC 3588 [7]), the Vendor-Specific-Application-Id AVP is still assumed as a required AVP (an AVP indicated as {AVP}) in the command code format to avoid backward compatibility issues, even if the use of this AVP has been deprecated in the new specification of the Diameter Base Protocol (IETF RFC 6733 [18]). + +The Np application identifier shall be included in the Auth-Application-Id AVP within the Vendor-Specific-Application-Id grouped AVP contained in the commands defined in this specification. + +The following Command Codes are defined in this specification: + +**Table 5.6.0.1: Command-Code values for Np** + +| Command-Name | Abbreviation | Code | Section | +|------------------------------------|--------------|---------|---------| +| Non-Aggregated-RUCI-Report-Request | NRR | 8388720 | 5.6.1 | +| Non-Aggregated-RUCI-Report-Answer | NRA | 8388720 | 5.6.2 | +| Aggregated-RUCI-Report-Request | ARR | 8388721 | 5.6.3 | +| Aggregated-RUCI-Report-Answer | ARA | 8388721 | 5.6.4 | +| Modify-Uecontext-Request | MUR | 8388722 | 5.6.5 | +| Modify-Uecontext-Answer | MUA | 8388722 | 5.6.6 | + +### 5.6.1 Non-Aggregated-RUCI-Report-Request (NRR) command + +The NRR command, indicated by the Command-Code field set to 8388720 and the 'R' bit set in the Command Flags field, is sent by the RCAF to the PCRF as part of the Non-aggregated RUCI report procedure. + +Message Format: + +``` + ::= + < Session-Id > + [ DRMP ] + { Vendor-Specific-Application-Id } + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + [ Destination-Host ] + [ Origin-State-Id ] + [ Subscription-Id ] + [ Called-Station-Id ] + [ Congestion-Level-Value ] + [ Congestion-Level-Set-Id ] + [ Congestion-Location-Id ] + [ OC-Supported-Features ] + [ RCAF-Id ] + * [ Proxy-Info ] + * [ Route-Record ] + * [ Supported-Features ] + * [ AVP ] +``` + +### 5.6.2 Non-Aggregated-RUCI-Report-Answer (NRA) command + +The NRA command, indicated by the Command-Code field set to 8388720 and the 'R' bit cleared in the Command Flags field, is sent by the PCRF to the RCAF as part of the Non-aggregated RUCI report procedure. + +Message Format: + +``` + ::= < Diameter Header: 8388720, PXY > + < Session-Id > + [ DRMP ] + { Vendor-Specific-Application-Id } + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ Result-Code ] + [ Experimental-Result ] + [ Error-Message ] + [ Error-Reporting-Host ] + [ Failed-AVP ] + [ OC-Supported-Features ] + [ OC-OLR ] + [ Reporting-Restriction ] + [ Conditional-Restriction ] + [ RUCI-Action ] + * [ Congestion-Level-Definition ] + [ PCRF-Address ] + [ Origin-State-Id ] + * [ Redirect-Host ] + [ Redirect-Host-Usage ] + [ Redirect-Max-Cache-Time ] + * [ Proxy-Info ] + * [ Supported-Features ] + * [ Load ] + * [ AVP ] +``` + +### 5.6.3 Aggregated-RUCI-Report-Request (ARR) command + +The ARR command, indicated by the Command-Code field set to 8388721 and the 'R' bit set in the Command Flags field, is sent by the RCAF to the PCRF as part of the Aggregated RUCI report procedure. + +Message Format: + +``` + ::= < Diameter Header: 8388721, REQ, PXY > + < Session-Id > + [ DRMP ] + { Vendor-Specific-Application-Id } + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + [ Destination-Host ] + [ Origin-State-Id ] + * [ Aggregated-RUCI-Report ] + [ OC-Supported-Features ] + * [ Proxy-Info ] + * [ Route-Record ] + * [ Supported-Features ] + * [ AVP ] +``` + +### 5.6.4 Aggregated-RUCI-Report-Answer (ARA) command + +The ARA command, indicated by the Command-Code field set to 8388721 and the 'R' bit cleared in the Command Flags field, is sent by the PCRF to the RCAF as part of the Aggregated RUCI report procedure. + +Message Format: + +``` + ::= < Diameter Header: 8388721, PXY > + < Session-Id > + [ DRMP ] + { Vendor-Specific-Application-Id } + { Auth-Session-State } + { Origin-Host } +``` + +``` + + { Origin-Realm } + [ Result-Code ] + [ Experimental-Result ] + [ Error-Message ] + [ Error-Reporting-Host ] + [ Failed-AVP ] + [ Origin-State-Id ] + [ OC-Supported-Features ] + [ OC-OLR ] + *[ Redirect-Host ] + [ Redirect-Host-Usage ] + [ Redirect-Max-Cache-Time ] + *[ Proxy-Info ] + *[ Supported-Features ] + *[ Load ] + *[ AVP ] + +``` + +### 5.6.5 Modify-Uecontext-Request (MUR) command + +The MUR command, indicated by the Command-Code field set to 8388722 and the 'R' bit set in the Command Flags field, is sent by the PCRF to the RCAF in order to request congestion reporting restrictions or remove the context for a specific user id and PDN ID. + +Message Format: + +``` + +< Modify-Uecontext-Request > ::= < Diameter Header: 8388722, REQ, PXY > + < Session-Id > + [ DRMP ] + { Vendor-Specific-Application-Id } + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + { Destination-Host } + [ Origin-State-Id ] + [ Subscription-Id ] + [ Called-Station-Id ] + [ OC-Supported-Features ] + [ Reporting-Restriction ] + [ Conditional-Restriction ] + [ RUCI-Action ] + *[ Congestion-Level-Definition ] + *[ Proxy-Info ] + *[ Route-Record ] + *[ AVP ] + +``` + +### 5.6.6 Modify-Uecontext-Answer (MUA) command + +The MUA command, indicated by the Command-Code field set to 8388722 and the 'R' bit set in the Command Flags field, is sent by the RCAF to the PCRF as a response to the request for congestion reporting restrictions to or remove the context a specific user id and PDN ID. + +Message Format: + +``` + +< Modify-Uecontext-Answer > ::= < Diameter Header: 8388722, PXY > + < Session-Id > + [ DRMP ] + { Vendor-Specific-Application-Id } + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ Result-Code ] + [ Experimental-Result ] + [ Failed-AVP ] + [ Origin-State-Id ] + [ OC-Supported-Features ] + [ OC-OLR ] + *[ Redirect-Host ] + [ Redirect-Host-Usage ] + [ Redirect-Max-Cache-Time ] + *[ Proxy-Info ] + *[ AVP ] + +``` + +# Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|--------|-----------|------|-----|--------------------------------------------------------------------------------|------------------------------------------------------------------------------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 2015-06 | CT#68 | CP-150367 | | | Cleaned-up by MCC, based on the version sent by e-mail on June 5th and agreed. | 2.1.0 | 2.2.0 | +| 2015-06 | - | - | - | - | MCC Editorial update after approval by TSG CT#68 | 2.2.0 | 13.0.0 | +| 2015-09 | CP-69 | CP-150477 | 0003 | 2 | Alignment of RUCI reporting restrictions' basis for UPCON | 13.0.0 | 13.1.0 | +| 2015-09 | CP-69 | CP-150477 | 0005 | 2 | Correction to the PCRF functionality | 13.0.0 | 13.1.0 | +| 2015-09 | CP-69 | CP-150477 | 0006 | 1 | Correction to the RCAF functionality | 13.0.0 | 13.1.0 | +| 2015-09 | CP-69 | CP-150477 | 0008 | 1 | Corrections to the wrong implementation of C3-150441 | 13.0.0 | 13.1.0 | +| 2015-09 | CP-69 | CP-150477 | 0009 | 1 | Fixing Ambiguous Flag Rules for AVPs reused from TS 29.061 | 13.0.0 | 13.1.0 | +| 2015-12 | CP-70 | CP-150672 | 0010 | 1 | Some corrections to 29.217 | 13.1.0 | 13.2.0 | +| 2015-12 | CP-70 | CP-150797 | 0011 | 1 | Update the PCC architecture figures in 29.217 | 13.1.0 | 13.2.0 | +| 2015-12 | CP-70 | CP-150630 | 0012 | 1 | Update draft-ietf-dime-ovli reference to RFC 7683 | 13.1.0 | 13.2.0 | +| 2015-12 | CP-70 | CP-150672 | 0013 | 1 | Vendor Specific Application ID over Np interface | 13.1.0 | 13.2.0 | +| 2015-12 | CP-70 | CP-150672 | 0016 | 2 | Race condition handling for aggregated RUCI report | 13.1.0 | 13.2.0 | +| 2015-12 | CP-70 | CP-150730 | 0018 | 1 | Diameter Message Priority over Np | 13.1.0 | 13.2.0 | +| Change history | | | | | | | | +| Date | TSG # | TSG Doc. | CR | Rev | Cat | Subject/Comment | New | +| 2016-03 | CT#71 | CP-160094 | 0022 | 1 | F | Congestion Level for the specific user id | 13.3.0 | +| 2016-03 | CT#71 | CP-160094 | 0023 | 1 | F | Add command codes and AVP numbers for Np protocol | 13.3.0 | +| 2016-03 | CT#71 | CP-160093 | 0024 | - | F | Reference of the Diameter message priority mechanism procedure | 13.3.0 | +| 2016-03 | CT#71 | CP-160094 | 0025 | 1 | F | Add missing abbreviations | 13.3.0 | +| 2016-06 | CT#72 | CP-160276 | 0026 | 2 | F | Correct Modify-Uecontext-Answer command definition and some editorial errors | 13.4.0 | +| 2016-09 | CT#73 | CP-160442 | 0027 | - | F | Correction of IETF drmp draft version | 13.5.0 | +| 2016-09 | CT#73 | CP-160453 | 0028 | 1 | F | Correction to the Np reused Diameter AVPs table | 13.5.0 | +| 2016-12 | CT#74 | CP-160614 | 0029 | - | F | Correction to change IETF drmp draft version to official RFC 7944 | 13.6.0 | +| 2016-12 | CT#74 | CP-160615 | 0030 | 2 | B | Diameter Load Control Mechanism | 14.0.0 | +| 2016-12 | CT#74 | CP-160616 | 0031 | 1 | F | Diameter base protocol specification update | 14.0.0 | +| 2017-03 | CT#75 | CP-170086 | 0033 | 2 | F | Support of long and short Macro eNodeB IDs | 14.1.0 | +| 2017-03 | CT#75 | CP-170076 | 0034 | - | F | Update instance number for the Failed-AVP in answer commands | 14.1.0 | +| 2017-06 | CT#76 | CP-171119 | 0035 | 1 | F | Reference update for draft-ietf-dime-load | 14.2.0 | +| 2017-06 | CT#76 | CP-171133 | 0040 | 1 | F | Vendor-Specific-Application-Id AVP handling | 14.2.0 | +| 2018-06 | CT#80 | | | | | Automatic upgrade from previous Release | 15.0.0 | +| 2019-09 | CT#85 | CP-192154 | 0042 | 1 | A | draft-ietf-dime-load published as RFC 8583 | 15.1.0 | +| 2020-07 | SA#88e | - | - | - | | Update to Rel-16 version (MCC) | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29219/3b621c21b0af3a504a28d2547e87138f_img.jpg b/marked/Rel-16/29_series/29219/3b621c21b0af3a504a28d2547e87138f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b2427fb3a3f13a7d6813cb51315c4c2a8717ba58 --- /dev/null +++ b/marked/Rel-16/29_series/29219/3b621c21b0af3a504a28d2547e87138f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9de584fafc2e287ee14bd04591e51b250d637d4e22fd4d875beef06435abe02b +size 6238 diff --git a/marked/Rel-16/29_series/29219/raw.md b/marked/Rel-16/29_series/29219/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..00edf00c89eabd736dcbf6e1c50f07a4263669e3 --- /dev/null +++ b/marked/Rel-16/29_series/29219/raw.md @@ -0,0 +1,819 @@ + + + + +Error! No +text of + +Error! No text of specified style in +document. + +# Contents + +| | | +|--------------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions and abbreviations ..... | 7 | +| 3.1 Definitions..... | 7 | +| 3.2 Abbreviations ..... | 7 | +| 4 Sy reference point ..... | 8 | +| 4.1 Overview ..... | 8 | +| 4.2 Sy Reference model ..... | 8 | +| 4.3 Subscriber Spending Limits ..... | 8 | +| 4.4 Functional elements..... | 9 | +| 4.4.1 PCRF ..... | 9 | +| 4.4.2 OCS ..... | 9 | +| 4.5 Spending Limits procedures over Sy reference point ..... | 9 | +| 4.5.1 Initial/Intermediate Spending Limit Report Request..... | 9 | +| 4.5.1.1 General..... | 9 | +| 4.5.1.2 Detailed behaviour of the PCRF ..... | 10 | +| 4.5.1.3 The behaviour of the OCS ..... | 10 | +| 4.5.2 Spending Limit Report ..... | 11 | +| 4.5.2.1 General..... | 11 | +| 4.5.2.2 The behaviour of the OCS ..... | 12 | +| 4.5.2.3 Detailed behaviour of the PCRF ..... | 12 | +| 4.5.3 Final Spending Limit Report Request ..... | 12 | +| 4.5.3.1 General..... | 12 | +| 4.5.3.2 Detailed behaviour of the PCRF ..... | 13 | +| 4.5.3.3 The behaviour of the OCS ..... | 13 | +| 4.5.4 Sy Session Termination by the OCS ..... | 13 | +| 5 Sy protocol..... | 13 | +| 5.1 Protocol support ..... | 13 | +| 5.1.1 Use of Diameter base protocol ..... | 13 | +| 5.1.2 Void..... | 14 | +| 5.1.3 Accounting functionality ..... | 14 | +| 5.1.4 Transport protocol ..... | 14 | +| 5.1.5 Advertising Application Support..... | 14 | +| 5.1.6 Use of the Supported-Features AVP ..... | 14 | +| 5.2 Initialization and maintenance of connection and session ..... | 15 | +| 5.3 Sy specific AVPs..... | 15 | +| 5.3.0 General ..... | 15 | +| 5.3.1 Policy-Counter-Identifier AVP ..... | 16 | +| 5.3.2 Policy-Counter-Status AVP..... | 16 | +| 5.3.3 Policy-Counter-Status-Report AVP ..... | 16 | +| 5.3.4 SL-Request-Type AVP..... | 16 | +| 5.3.5 Pending-Policy-Counter-Information AVP..... | 16 | +| 5.3.6 Pending-Policy-Counter-Change-Time AVP ..... | 17 | +| 5.3.7 SN-Request-Type AVP ..... | 17 | +| 5.4 Sy re-used AVPs ..... | 17 | +| 5.5 Sy specific Experimental-Result-Code AVP values ..... | 18 | +| 5.5.1 General ..... | 18 | +| 5.5.2 Permanent Failures ..... | 18 | +| 5.5.3 Transient Failures ..... | 19 | +| 5.6 Sy Messages..... | 19 | +| 5.6.1 Command-Code Values..... | 19 | +| 5.6.2 Spending-Limit-Request (SLR) command..... | 19 | +| 5.6.3 Spending-Limit-Answer (SLA) command ..... | 20 | +| 5.6.4 Spending-Status-Notification-Request (SNR) command..... | 20 | +| 5.6.5 Spending-Status-Notification-Answer (SNA) command ..... | 20 | + +5.6.6 Session-Termination-Request (STR) command..... 21 +5.6.7 Session-Termination-Answer (STA) command..... 21 +**Annex A (normative): User Identity for Fixed Broadband Access network convergence..... 22** +Annex B (informative): Change history..... 23 + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 1 Scope + +The present document provides the stage 3 specification of the Sy reference point for the present release. The functional requirements and the stage 2 specifications of the Sy reference point are contained in TS 23.203 [2]. The Sy reference point lies between the Policy and Charging Rule Function (PCRF) and the Online Charging System (OCS). The internal OCS functionality for policy counter provision management pertaining to Sy is specified in TS 32.296 [16]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.203: "Policy Control and Charging architecture". +- [3] Void. +- [4] IETF RFC 4005: "Diameter Network Access Server Application" +- [5] IETF RFC 4006: "Diameter Credit Control Application". +- [6] IETF RFC 5719: "Updated IANA Considerations for Diameter Command Code Allocations" +- [7] IETF RFC 2234: "Augmented BNF for syntax specifications". +- [8] 3GPP TS 29.213: "Policy and charging control signalling flows and Quality of Service (QoS) parameter mapping". +- [9] Void. +- [10] Void. +- [11] Void. +- [12] Void. +- [13] IETF RFC 791: "Transmission Control Protocol". +- [14] IETF RFC 4960: "Stream Control Transmission Protocol". +- [15] 3GPP TS 29.229: "Cx and Dx interfaces based on the Diameter protocol". +- [16] 3GPP TS 32.296: "Telecommunication management; charging management; Online Charging System (OCS) applications and interfaces". +- [17] ETSI TS 283 034 v2.2.0: "Telecommunications and Internet converged Services and Protocols for Advanced Networking (TISPAN); Network Attachment Sub-System (NASS); e4 interface based on the DIAMETER protocol". +- [18] IETF RFC 3046: "DHCP Relay Agent Information Option". +- [19] 3GPP TS 29.212: "Policy and Charging Control (PCC); Reference points". +- [20] IETF RFC 7683: "Diameter Overload Indication Conveyance". + +- [21] IETF RFC 7944: "Diameter Routing Message Priority". +- [22] IETF RFC 8583: "Diameter Load Information Conveyance". +- [23] IETF RFC 6733: "Diameter Base Protocol". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in TR 21.905 [1]. + +**policy counter:** A mechanism within the OCS to track spending applicable for a subscriber. + +**policy counter identifier:** A reference to a policy counter in the OCS for a subscriber. + +**policy counter status:** A label whose values are not standardized and that is associated with a policy counter's value relative to the spending limit(s) (the number of possible policy counter status values for a policy counter is one greater than the number of thresholds associated with that policy counter, i.e policy counter status values describe the status around the thresholds). This is used to convey information relating to subscriber spending from OCS to PCRF. Specific labels are configured jointly in OCS and PCRF. + +**spending limit:** A spending limit is the usage limit of a policy counter (e.g. monetary, volume, duration) that a subscriber is allowed to consume. + +**spending limit report:** a notification, containing the current policy counter status generated from the OCS to the PCRF via the Sy reference point. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in TR 21.905 [1]. + +| | | +|------|----------------------------------------------------| +| DRMP | Diameter Routing Message Priority | +| OCS | Online charging system | +| OFCS | Offline charging system | +| PCEF | Policy and Charging Enforcement Function | +| PCRF | Policy and Charging Rule Function | +| RCAF | RAN Congestion Awareness Function | +| SLA | Spending-Limit-Answer (SL-Answer) | +| SLR | Spending-Limit-Request (SL- Request) | +| SNA | Spending-Status-Notification-Answer (SN-Answer) | +| SNR | Spending-Status-Notification-Request (SN- Request) | +| STA | Session-Termination-Answer (ST-Answer) | +| STR | Session-Termination-Request (ST- Request) | + +# --- 4 Sy reference point + +## 4.1 Overview + +The Sy reference point is located between the Policy and Charging Rules Function (PCRF) and the Online Charging System (OCS). The Sy reference point enables transfer of policy counter status information relating to subscriber spending from OCS to PCRF and supports the following functions: + +- Request of policy counter status reporting from PCRF to OCS and subscribe to or unsubscribe from spending limit reports (i.e. notifications of policy counter status changes). +- Notification of spending limit reports from OCS to PCRF. + +- Cancellation of spending limit reporting from PCRF to OCS. + +Since the Sy reference point resides between the PCRF and OCS in the HPLMN, roaming with home routed or visited access as well as non-roaming scenarios are supported in the same manner. + +The stage 2 level requirements for the Sy reference point are defined in 3GPP TS 23.203 [2]. + +Signalling flows related to the Sy interface are specified in 3GPP TS 29.213 [8]. + +Refer to Annex G of 3GPP TS 29.213 [8] for Diameter overload control procedures over the Sy interface. + +Refer to Annex J of 3GPP TS 29.213 [8] for Diameter message priority mechanism procedures over the Sy interface. + +Refer to Annex K of 3GPP TS 29.213 [8] for Diameter load control procedures over the Sy interface. + +## 4.2 Sy Reference model + +The Sy reference point is defined between the PCRF and the OCS. The relationships between the involved functional entities are depicted in figure 4.2.1. The overall PCC architecture is depicted in clause 3a of 3GPP TS 29.213 [8] + +![Diagram of the Sy reference model showing PCRF and OCS connected by the Sy interface.](3b621c21b0af3a504a28d2547e87138f_img.jpg) + +The diagram shows two rectangular boxes, one on the left labeled 'PCRF' and one on the right labeled 'OCS'. A horizontal line connects the two boxes. Above the line, centered between the boxes, is the label 'Sy'. There is a small vertical tick mark on the line between the two boxes. + +Diagram of the Sy reference model showing PCRF and OCS connected by the Sy interface. + +Figure 4.2.1: Sy reference model + +.Figure 4.2.2: Void + +## 4.3 Subscriber Spending Limits + +Policy decisions based on spending limits is a function that allows the PCRF to make policy decisions based on the status of policy counters that are maintained in the OCS. The PCRF uses the policy counter statuses received from the OCS as input to its policy decisions, e.g. downgrade the QoS (e.g. APN-AMBR) or modify the PCC/QoS/ADC Rules. + +When the status of policy counters is first required to make a policy decision for a subscriber, the PCRF uses the Initial Spending Limit Report Request procedure. The PCRF may request specific or all policy counter statuses to be reported by the OCS for the user. The OCS provides the status to the PCRF of the requested policy counters, and will notify the PCRF of any changes in the status of those policy counters. Optionally, the OCS can provide one or more pending statuses for a requested policy counter with the times that have to be applied. The pending status of a policy counter shall autonomously become the current status of a policy counter at the PCRF when the indicated corresponding time is reached. Subsequently, the provided information for pending statuses of a policy counter shall overwrite the previously received information. + +NOTE 1: The mechanism for provisioning the policy counters in the OCS is out of scope of this document. + +NOTE 2: A policy counter in the OCS can represent the spending for one or more services, one or more devices, one or more subscribers, etc. The representation is operator dependent. There is no explicit relationship between Charging-Key and policy counter. + +The PCRF may request reporting for specific policy counter(s) that it is not currently subscribed and/or cancel reporting for specific policy counter status(es) using the Intermediate Spending Limit Report Request. The PCRF may cancel spending limit reporting for all policy counter(s) using the Final Spending Limit Report Request. + +The updated subscriber profile may also trigger the PCRF sending the Initial/Intermediate/Final Spending Limit Report Request to the OCS to subscribe and/or cancel reporting for policy counter status(es). If spending limit reporting for a policy counter is enabled, the OCS shall notify the PCRF of changes in the status of this policy counter (e.g. daily spending limit of \$2 reached) and optionally pending statuses of this policy counter with the activation time (e.g. due to a billing period that will expire at midnight). + +## 4.4 Functional elements + +### 4.4.1 PCRF + +The Policy Control and Charging Rules Function (PCRF) is a functional element that encompasses policy control decision and flow based charging control functionalities. + +The PCRF may take information on the subscriber's spending status into account in its policy decisions. The PCRF may request spending limit reporting for policy counters from the OCS using the Initial or Intermediate Spending Limit Report Request procedure as specified in clause 4.5.1. The PCRF may cancel spending limit reporting for specific policy counter(s) using the Intermediate Spending Limit Report Request procedure, or for all policy counter(s) using the Final Spending Limit Report Request procedure as specified in clause 4.5.3. + +The PCRF shall have at least one active IP-CAN session to be able to initiate an Sy session to be used when required for spending limit reporting for that subscriber. The PCRF shall terminate the Sy session when the last IP-CAN session for that subscriber is terminated or no IP-CAN session for the same user depends on the spending status information provided over Sy reference point. + +The PCRF may use the status of each relevant policy counter as input to its policy decision as required by the decision logic. + +### 4.4.2 OCS + +The Online Charging System (OCS), for the purpose of policy decisions based on the subscriber's spending, shall: + +- maintain the policy counter statuses applicable for a subscriber. +- report the policy counter status values for the subscriber when requested to the PCRF. +- when a policy counter status changes, report the change to the PCRF. + +## 4.5 Spending Limits procedures over Sy reference point + +### 4.5.1 Initial/Intermediate Spending Limit Report Request + +#### 4.5.1.1 General + +This procedure shall be used by the PCRF to request the status of policy counters available at the OCS, and to subscribe or unsubscribe to updates of policy counters by the OCS. + +This procedure is mapped to the Spending-Limit-Request/Answer commands specified in section 5.6. + +**Table 4.5.1.1/1: Initial/Intermediate Spending Limit Report Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|-------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| User Identity | Subscription-Id, Logical-Access-ID AVP, Physical-Access-ID (NOTE 1) | C | This IE shall contain the identity of the user. It shall be present in the initial request when the SL-Request-Type=INITIAL_REQUEST. | +| Request Type | SL-Request-Type | M | This IE shall indicate whether this is the initial or a subsequent request for the user. | +| Subscribed Policy Counter Identifier List | Policy-Counter-Identifier | O | This IE shall indicate the list of policy counter identifiers to be subscribed to. In the intermediate spending limit report request procedure, this list overrides a previously provisioned list. If omitted in either the Initial or Intermediate Spending Limit Report Request procedures the PCRF requests subscription to all available policy counters. | +| NOTE 1: The Logical-Access-ID AVP and Physical-Access-ID AVP are only applicable to Fixed Broadband Access network convergence as defined in annex A. | | | | + +**Table 4.5.1.1/2: Initial/Intermediate Spending Limit Report Response** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------|------------------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Policy Counter Status Report | Policy-Counter-Status-Report | O | If present, this information element shall contain a policy counter identifier, the current status value and if applicable pending policy counter statuses with the activation times. | +| Result | Result-Code or Experimental-Result | M | This IE shall contain the result of the operation. | + +#### 4.5.1.2 Detailed behaviour of the PCRF + +The PCRF shall make use of this procedure when it determines for a subscriber that + +- The status of policy counter(s) to which the PCRF does not have an existing subscription for status change notifications is/are required. +- The status of one or more, but not all, policy counter(s) to which the PCRF has an existing subscription for status change notifications are no longer required. + +NOTE: The Final Spending Limit Request procedure in clause 4.5.3 is used to remove all subscriptions. + +In the initial request, i.e. when the request is sent for the first time for the Subscriber, the PCRF shall set the SL-Request-Type AVP to the value INITIAL\_REQUEST (0). For subsequent requests for the same Subscriber, the PCRF shall set the SL-Request-Type AVP to INTERMEDIATE\_REQUEST (1). + +For each policy counter that the PCRF requires the current status and notifications of future status changes, the PCRF shall indicate the concerned policy counter identifiers in the request. Alternatively, the policy counter identifiers may be omitted if the PCRF requires the current status and notifications of future status changes of all available policy counters. + +#### 4.5.1.3 The behaviour of the OCS + +Upon reception of the request from the PCRF, the OCS shall check if there is an ongoing Sy session associated with the received Session-Id AVP. If there is no Sy session and the SL-Request-Type AVP is set to INITIAL\_REQUEST (0), an Sy session is created on the OCS. If there is an Sy session and the SL-Request-Type AVP is not set to INTERMEDIATE\_REQUEST (1), the OCS shall return a response with the Result-Code set to DIAMETER\_INVALID\_AVP\_VALUE and with the Failed-AVP AVP containing the SL-Request-Type AVP. If there is no Sy session and the SL-Request-Type AVP is not set to INITIAL\_REQUEST (0), the OCS shall return a response with the Result-Code AVP set to DIAMETER\_UNKNOWN\_SESSION\_ID. + +Upon reception of the request from the PCRF provided with explicit Policy Counter Identifier(s): + +If all the policy counter identifiers are known to the OCS, the OCS shall be able to subsequently notify the PCRF of any policy counter state changes and/or additions, removal or changes of pending policy counter statuses along with their activation time. + +If a policy counter identifier is known by the OCS, but is not applicable to the subscriber (e.g. not provisioned), the OCS may use an operator configured policy counter status to indicate this to the PCRF. + +If the OCS is configured to accept the request provided with unknown policy counter identifier(s), and if the OCS determines that one or more policy counter identifiers are unknown, an operator configured policy counter status may be used to indicate the policy counter identifier(s) determined as unknown by OCS. The status of known policy counter identifier(s) shall be returned to the PCRF in the same procedure in this case. + +Alternatively, if the OCS is configured to reject the request provided with unknown policy counter identifier(s), and if the OCS determines that one or more policy counter identifiers are unknown, the OCS shall return a response with the Experimental-Result-Code AVP set to DIAMETER\_ERROR\_UNKNOWN\_POLICY\_COUNTERS and with the Failed-AVP AVP indicating the unknown policy counter identifiers. When this failure occurs, if the SL-Request-Type AVP is set to: + +- INITIAL\_REQUEST (0), then the Sy session is not created. +- INTERMEDIATE\_REQUEST (1), then none of the changes in the request take effect but the Sy session is maintained. + +NOTE 1: In order to avoid misbehaviors due to the policy counters maintained in the Sy session, the PCRF can terminate the Sy session invoking the Final Spending Limit Request procedure in clause 4.5.3. + +When the PCRF provides a new subscribed policy counter identifier list, the OCS shall remove any policy counter identifiers no longer in the list from association with the Sy session such that the OCS will no longer notify the PCRF of those policy counter state changes. + +If an initial or intermediate request contains no policy counter identifiers, the OCS shall subsequently notify the PCRF of all available policy counter state changes and optionally the pending policy counter statuses with the activation times. If the OCS has no available policy counters for that subscriber during the Initial Spending Limit Report Request procedure, it sets the Experimental-Result-Code to DIAMETER\_ERROR\_NO\_AVAILABLE\_POLICY\_COUNTERS. When this failure occurs, if the SL-Request-Type AVP is set to: + +- INITIAL\_REQUEST (0), then the Sy session is not created. +- INTERMEDIATE\_REQUEST (1), then none of the changes in the request take effect but the Sy session is maintained. + +NOTE 2: The PCRF can terminate the Sy session invoking the Final Spending Limit Request procedure in clause 4.5.3, or maintain the Sy session assuming that further available policy counters will be notified. + +If the user identified in an initial request is not known to the OCS, the OCS shall reject the Spending Limit Report Request by including the result code of DIAMETER\_USER\_UNKNOWN in the Spending Limit Report Answer. In this case, the Sy session is not created. + +Upon successful creation of an Sy session, the OCS shall include the current status of all subscribed policy counters (if any) in the response and set the Result-Code to DIAMETER\_SUCCESS. + +### 4.5.2 Spending Limit Report + +#### 4.5.2.1 General + +This procedure shall be used by the OCS to notify the PCRF of changes in the status of subscribed policy counter(s). + +This procedure is mapped to the Spending-Status-Notification-Request / Answer commands specified commands specified in section 5.6. + +**Table 4.5.2.1/1: Spending Limit Report Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------|------------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Policy Counter Status Report | Policy-Counter-Status-Report | M | If present, this information element shall contain a policy counter identifier, the current status value and if applicable pending policy counter statuses with the activation times. | + +**Table 4.5.2.1/2: Spending Limit Report Response** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|------------------------------------|------|----------------------------------------------------| +| Result | Result-Code or Experimental-Result | M | This IE shall contain the result of the operation. | + +#### 4.5.2.2 The behaviour of the OCS + +When the status of a specific policy counter changes or when pending statuses associated with the policy counter are added, removed or changed, the OCS shall determine the Sy sessions impacted by the change (i.e. those Sy sessions that have subscribed to status change notifications for the changed policy counter) and send a Spending-Status-Notification-Request command including the current policy counter status, and if applicable pending policy counter statuses with the activation times to the PCRF associated with each affected Sy session. The OCS shall not send the policy counter status for the same policy counter until it received the response of the previous status report of the policy counter. + +If several policy counters change status at the same time, the OCS may group the status change notifications into a single Spending-Status-Notification-Request command to the PCRF by sending multiple Policy-Counter-Status-Report AVPs in the request. + +#### 4.5.2.3 Detailed behaviour of the PCRF + +The PCRF shall acknowledge the request by sending a response with a Result-Code AVP set to DIAMETER\_SUCCESS and use the status of the received policy counter(s) as input to its policy decision to apply operator defined actions, e.g. downgrade the QoS. + +NOTE: The values related to the status of a policy counter (e.g. valid, invalid or any other status) are not specified. The interpretation and actions related to the values are out of scope of 3GPP. + +The PCRF shall ignore an unknown policy counter status report for all unknown policy counter identifiers in an SLA or in an SNR from the OCS. + +If the PCRF receives an SNR command while it has an ongoing SLR transaction with the OCS, the PCRF shall update the policy counter information based on the SNR command. When the corresponding SLA command for the ongoing SLR transaction is eventually received, the PCRF shall only update policy counter information for counters that were not provided in the previously received SNR command. + +If the PCRF receives a Policy-Counter-Status-Report with one or more Pending-Policy-Counter-Information AVPs, then at the time defined by the Pending-Policy-Counter-Change-Time AVP, the pending Policy-Counter-Status shall autonomously become the current status of a policy counter. Subsequently provided information for pending statuses of a policy counter shall overwrite the previously received information. If the pending policy counter statuses are applicable to a policy counter identifier but the Pending-Policy-Counter-Information AVPs are omitted in the new policy counter status report, the PCRF shall remove all the pending policy counter statuses. + +### 4.5.3 Final Spending Limit Report Request + +#### 4.5.3.1 General + +This procedure shall be used by the PCRF to unsubscribe to any future updates of policy counters for a given subscriber by the OCS. + +This procedure is mapped to the Session-Termination-Request/Answer commands specified in IETF RFC 6733 [23]. + +**Table 4.5.3.1/1: Final Spending Limit Report Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-------------------------|------|--------------------------------------------------------------------------------------------------------| +| Termination Cause | Termination-Cause | M | This IE shall contain the reason why the session was terminated. It shall be set to "DIAMETER_LOGOUT". | + +**Table 4.5.3.1/2: Final Spending Limit Report Response** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-------------------------|------|----------------------------------------------------| +| Result | Result-Code | M | This IE shall contain the result of the operation. | + +#### 4.5.3.2 Detailed behaviour of the PCRF + +When the PCRF decides that policy decisions for a given user no longer depend on policy counter(s) to which the PCRF has existing subscriptions for status change notifications, the PCRF shall send the Final Spending Limit Report Request to the OCS. + +#### 4.5.3.3 The behaviour of the OCS + +Upon reception of the request from the PCRF, the OCS shall check that there is an ongoing Sy session associated with the received Session-Id AVP. If there is no Sy session, the OCS shall return a response with the Result-Code AVP set to DIAMETER\_UNKNOWN\_SESSION\_ID. + +The OCS shall remove all policy counter subscriptions associated with the Sy session such that the OCS will no longer notify the PCRF of policy counter state changes and close the session by returning a response with the Result-Code AVP set to DIAMETER\_SUCCESS. + +### 4.5.4 Sy Session Termination by the OCS + +If the ASR feature is supported, and the OCS decides that the Sy session for a subscriber needs to be terminated (e.g. because subscriber is removed from an OCS system), the OCS shall send the Spending-Status-Notification-Request (SNR) containing the SN-Request-Type AVP with bit 1 (Abort Session Request) set to the PCRF. + +Upon receipt of the SNR containing the SN-Request-Type AVP with bit 1 set, the PCRF shall acknowledge the receipt of the SNR by sending the Spending-Status-Notification-Answer (SNA) and shall then send a Final Spending Limit Report Request as specified in subclause 4.5.3. + +NOTE: The termination of the Sy session causes the H-PCRF to make the applicable policy decision and act accordingly, i.e. sessions on other interfaces such as the Rx or Gx interface will remain established, unless the policy decision causes their termination. + +# --- 5 Sy protocol + +## 5.1 Protocol support + +### 5.1.1 Use of Diameter base protocol + +The Diameter Base Protocol as specified in IETF RFC 6733 [23] shall apply except as modified by the defined support of the methods and the defined support of the commands and AVPs, result and error codes as specified in this specification. Unless otherwise specified, the procedures (including error handling and unrecognised information handling) shall be used unmodified. + +With regard to the Diameter protocol defined over the Sy interface, the OCS acts as a Diameter server, in the sense that it is the network element that handles policy counter status requests for a particular realm. The PCRF acts as the Diameter client, in the sense that it is the network element requesting policy counter status to the OCS. + +A Diameter routing table entry can have a different destination based on the application identifier of the command. The application identifier stored in the command header must match the value of any application identifier AVPs in the command body. Diameter agents (relay, proxy, redirection, translation agents) should use the application identifier in the command header to route to a suitable destination. + +### 5.1.2 Void + +### 5.1.3 Accounting functionality + +Accounting functionality (Accounting Session State Machine, related command codes and AVPs) shall not be used on the Sy interface. + +### 5.1.4 Transport protocol + +Diameter messages over the Sy interface shall make use of TCP IETF RFC 791 [13] or SCTP IETF RFC 4960 [14]. + +### 5.1.5 Advertising Application Support + +The Diameter application identifier assigned to the Sy interface application is 16777302. + +The PCRF and OCS shall advertise support of the Diameter Sy Application by including the value of the Sy application identifier in the Auth-Application-Id AVP within the Vendor-Specific-Application-Id grouped AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands. + +The vendor identifier value of 3GPP (10415) shall be included in the Supported-Vendor-Id AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands, and in the Vendor-Id AVP within the Vendor-Specific-Application-Id grouped AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands. + +The Vendor-Id AVP included in Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands that is not included in the Vendor-Specific-Application-Id AVPs as described above shall indicate the manufacturer of the Diameter node as per IETF RFC 6733 [23]. + +### 5.1.6 Use of the Supported-Features AVP + +The Supported-Features AVP is used during session establishment to inform the destination host about the required and optional features that the origin host supports. The client shall, in the first request in a Diameter session indicate the set of supported features. The server shall, in the first answer within the Diameter session indicate the set of features that it has in common with the client and that the server shall support within the same Diameter session. Any further command messages shall always be compliant with the list of supported features indicated in the Supported-Features AVPs during session establishment. Features that are not advertised as supported shall not be used to construct the command messages for that Diameter session. Unless otherwise stated, the use of the Supported-Features AVP on the Sy reference point shall be compliant with the requirements for dynamic discovery of supported features and associated error handling on the Cx reference point as defined in clause 7.2.1 of TS 29.229 [15]. + +The base functionality for the Sy reference point is the 3GPP Rel-11 standard and a feature is an extension to that functionality. If the origin host does not support any features beyond the base functionality, the Supported-Features AVP may be absent from the Sy commands. As defined in clause 7.1.1 of TS 29.229 [15], when extending the application by adding new AVPs for a feature, the new AVPs shall have the M bit cleared and the AVP shall not be defined mandatory in the command ABNF. + +As defined in TS 29.229 [15], the Supported-Features AVP is of type grouped and contains the Vendor-Id, Feature-List-ID and Feature-List AVPs. On the Sy reference point, the Supported-Features AVP is used to identify features that have been defined by 3GPP and hence, for features defined in this document, the Vendor-Id AVP shall contain the vendor ID of 3GPP (10415). If there are multiple feature lists defined for the Sy reference point, the Feature-List-ID AVP shall differentiate those lists from one another. + +On receiving an initial request application message, the destination host shall act as defined in clause 7.2.1 of TS 29.229 [15]. The following exceptions apply to the initial SLR/SLA command pair: + +- If the PCRF supports any supported features defined for Sy, the SLR shall include the features supported by the PCRF within Supported-Features AVP(s) with the 'M' bit cleared. + +NOTE 2: One instance of Supported-Features AVP is needed per Feature-List-ID. + +- If the SLR command does not contain any Supported-Features AVP(s) and the OCS supports no supported features defined for Sy functionality, the OCS shall not include the Supported-Features AVP in the SLA command. In this case, both PCRF and OCS shall not use any supported features defined for Sy. + +Once the PCRF and OCS have negotiated the set of supported features during session establishment, the set of common features shall be used during the lifetime of the Diameter session. + +The table below defines the features applicable to the Sy interface for the feature list with a Feature-List-ID of 1. + +**Table 5.1.6-1: Features of Feature-List-ID 1 used on the Sy interface** + +| Feature bit | Feature | M/O | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|-----|-------------------------------------------------------------------| +| 0 | ASR | O | Sy Session Termination by the OCS as specified in subclause 4.5.4 | +| Feature bit: The order number of the bit within the Feature-List AVP where the least significant bit is assigned number "0".
Feature: A short name that can be used to refer to the bit and to the feature, e.g. "EPS".
M/O: Defines if the implementation of the feature is mandatory ("M") or optional ("O").
Description: A clear textual description of the feature. | | | | + +## 5.2 Initialization and maintenance of connection and session + +The Diameter protocol between the PCRF and the OCS, shall always keep the session state, and use the same Session-Id parameter for the lifetime of each Diameter session. + +Each Diameter session shall identify a Sy session for a given user. In order to indicate that the session state is to be maintained, the Diameter client and server shall not include the Auth-Session-State AVP, either in the request or in the response messages (see IETF RFC 6733 [23]). + +The PCRF shall link the Gx session(s) or S9 session with the Sy session at Sy session initialization and maintain that until the IP-CAN session(s) for that subscriber are terminated or no IP-CAN session for the same user depends on the spending status information provided over Sy reference point. + +## 5.3 Sy specific AVPs + +### 5.3.0 General + +Table 5.3.0.1 describes the Diameter AVPs defined for the Sy reference point, their AVP Code values, types and possible flag values. The Vendor-Id header of all AVPs defined in the present document shall be set to 3GPP (10415). + +**Table 5.3.0.1: Sy specific Diameter AVPs** + +| Attribute Name | AVP Code | Clause defined | Value Type | AVP Flag rules (Note 1) | | | | Applicability (Note 2) | +|------------------------------------|----------|----------------|------------|-------------------------|-----|------------|----------|------------------------| +| | | | | Must | May | Should not | Must not | | +| Pending-Policy-Counter-Information | 2905 | 5.3.5 | Grouped | M,V | P | | | | +| Pending-Policy-Counter-Change-Time | 2906 | 5.3.6 | Time | M,V | P | | | | +| Policy-Counter-Identifier | 2901 | 5.3.1 | UTF8String | M,V | P | | | | +| Policy-Counter-Status | 2902 | 5.3.2 | UTF8String | M,V | P | | | | +| Policy-Counter-Status-Report | 2903 | 5.3.3 | Grouped | M,V | P | | | | +| SL-Request-Type | 2904 | 5.3.4 | Enumerated | M,V | P | | | | +| SN-Request-Type | 2907 | 5.3.7 | Unsigned32 | V | P | | M | ASR | + +NOTE 1: The AVP header bit denoted as 'M', indicates whether support of the AVP is required. The AVP header bit denoted as 'V', indicates whether the optional Vendor-ID field is present in the AVP header. For further details, see IETF RFC 6733 [23]. + +NOTE 2: AVPs marked with a supported feature are applicable as described in subclause 5.1.6. + +### 5.3.1 Policy-Counter-Identifier AVP + +The Policy-Counter-Identifier AVP (AVP code 2901) is of type UTF8String, and it uniquely identifies a policy counter that is maintained per subscriber within the OCS. + +### 5.3.2 Policy-Counter-Status AVP + +The Policy-Counter-Status AVP (AVP code 2902) is of type UTF8String, and identifies the policy counter status applicable for a specific policy counter and subscriber. + +NOTE: The valid values for the Policy-Counter-Status AVP are specific for each Policy-Counter-Identifier value. + +The values (e.g. valid, invalid or any other status) are not specified. The interpretation and actions related to the defined values are out of scope of 3GPP. + +### 5.3.3 Policy-Counter-Status-Report AVP + +The Policy-Counter-Status-Report AVP (AVP code 2903) is of type Grouped. It is used by the OCS to report the status of a specific policy counter. + +Associated pending policy counter statuses shall always be provided within Pending-Policy-Counter-Information AVPs if the pending policy counter statuses are applicable to the policy counter identifier. If there are no Pending-Policy-Counter-Information AVPs provided within the Policy-Counter-Status-Report AVP, previously provided pending counter statuses are removed. In addition, newly provided pending policy counter statuses overwrite previously provided ones. + +AVP Format: + +``` +Policy-Counter-Status-Report ::= < AVP Header: 2903 > + { Policy-Counter-Identifier } + { Policy-Counter-Status } + *[ Pending-Policy-Counter-Information ] + *[ AVP ] +``` + +### 5.3.4 SL-Request-Type AVP + +The SL-Request-Type AVP (AVP code 2904) is of type Enumerated, and informs the OCS whether the SLR command is being sent as part of the initial or intermediate spending limit report request procedure. + +The following values are defined: + +INITIAL\_REQUEST (0) + +This value indicates that this is the first request in the Diameter session. + +INTERMEDIATE\_REQUEST (1) + +This value indicates that this is the second or subsequent request in the Diameter session. + +### 5.3.5 Pending-Policy-Counter-Information AVP + +The Pending-Policy-Counter-Information AVP (AVP code 2905) is of type Grouped, which contains the pending policy counter status and the active time. If multiple pending policy counter AVPs are included, they shall be sorted in order of change time. + +AVP Format: + +``` +Pending-Policy-Counter-Information ::= < AVP Header: 2905 > + { Policy-Counter-Status } + { Pending-Policy-Counter-Change-Time } + *[ AVP ] +``` + +NOTE: The valid values for the Pending-Policy-Counter-Information AVP are specific for each Policy-Counter-Identifier value. + +### 5.3.6 Pending-Policy-Counter-Change-Time AVP + +The Pending-Policy-Counter-Change-Time AVP (AVP code 2906) is of type Time. This value indicates the NTP time at which the pending policy counter status becomes the current status of a policy counter. + +### 5.3.7 SN-Request-Type AVP + +The SN-Request-Type AVP (AVP code 2907) shall be of type Unsigned32 and shall contain a bit mask, and informs the PCRF about the type of the Spending-Status-Notification-Request (SNR). The bit 0 shall be the least significant bit. For example, to get the value of bit 0, a bit mask of 0x0001 should be used. + +The following values are defined, and multiple bits may be set in combination: + +**Table 5.3.7-1: SN-Request-Type AVP** + +| Bit | Name | Description | +|-----|-----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | Normal Request | This bit, when set, indicates that the SNR is used only to convey a spending limit report as detailed in subclause 4.5.2. This shall be the default value that applies when the SN-Request-Type AVP is not included in an SNR. | +| 1 | Abort Session Request | This bit, when set, indicates that the SNR is used to request the termination of the Sy session as detailed in subclause 4.5.4 | + +## 5.4 Sy re-used AVPs + +Table 5.4 lists the Diameter AVPs re-used by the Sy reference point from existing Diameter Applications, reference to their respective specifications and a short description of their usage within the Sy reference point. Other AVPs from existing Diameter Applications, except for the AVPs from Diameter base protocol, do not need to be supported. The AVPs from Diameter base protocol are not included in table 5.4, but they are re-used for the Sy reference point. Unless otherwise stated, re-used AVPs shall maintain their 'M', 'P' and 'V' flag settings. Where 3GPP Radius VSAs are re-used, unless otherwise stated, they shall be translated to Diameter AVPs as described in RFC 4005 [4] with the exception that the 'M' flag shall be set and the 'P' flag may be set. + +**Table 5.4: Sy re-used Diameter AVPs** + +| Attribute Name | Reference | Description | +|-----------------------|----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| DRMP | IETF RFC 7944 [21] | Allows Diameter endpoints to indicate the relative priority of Diameter transactions. | +| Subscription-Id | IETF RFC 4006 [5] | The identification of the subscription (IMSI, MSISDN, etc) | +| Load | IETF RFC 8583 [22] | The AVP used to convey load information between Diameter nodes.
This AVP and all AVPs within this grouped AVP shall have the 'M' bit cleared. | +| Logical-Access-ID | ETSI TS 283 034 [17] | Contains a Circuit-ID (as defined in IETF RFC 3046 [18]). The Logical Access ID may explicitly contain the identity of the Virtual Path and Virtual Channel carrying the traffic. Applicable only for Fixed Broadband Access network convergence as defined in annex A.
This AVP shall have the 'M' bit cleared. | +| OC-OLR | IETF 7683 [20] | Contains the necessary information to convey an overload report. | +| OC-Supported-Features | IETF 7683 [20] | Defines the support for the Diameter overload indication conveyance by the sending node. | +| Physical-Access-ID | ETSI TS 283 034 [17] | Identifies the physical access to which the user equipment is connected. Includes a port identifier and the identity of the access node where the port resides. Applicable only for Fixed Broadband Access network convergence as defined in annex A.
This AVP shall have the 'M' bit cleared. | +| Supported-Features | 3GPP TS 29.229 [15] | If present in a request, this AVP informs the destination host about the features that the origin host supports. If present in an answer, this AVP informs the destination host about common features with the origin host. | + +## 5.5 Sy specific Experimental-Result-Code AVP values + +### 5.5.1 General + +IETF RFC 6733 [23] specifies the Experimental-Result AVP containing Vendor-ID AVP and Experimental-Result-Code AVP. The Experimental-Result-Code AVP (AVP Code 298) is of type Unsigned32 and contains a vendor-assigned value representing the result of processing a request. The Vendor-ID AVP shall be set to 3GPP (10415). + +### 5.5.2 Permanent Failures + +Errors that fall within the Permanent Failures category shall be used to inform the peer that the request failed, and the request should not be attempted again. + +The Result-Code AVP values defined in Diameter base protocol IETF RFC 6733 [23] are applicable. Also, the following Result-Code AVP value defined in IETF RFC 4006 [5] is applicable: + +DIAMETER\_USER\_UNKNOWN (5030) + +This error shall be used by the OCS to indicate to the PCRF that the end user specified in the request is unknown to the OCS and that the Sy session cannot be created. + +The following specific Sy Experimental-Result-Code value is defined for permanent failures: + +DIAMETER\_ERROR\_UNKNOWN\_POLICY\_COUNTERS (5570) + +This error shall be used by the OCS to indicate to the PCRF that the OCS does not recognize one or more Policy Counters specified in the request, when the OCS is configured to reject the request provided with unknown policy counter identifier(s). + +### 5.5.3 Transient Failures + +Errors that fall within the transient failures category are used to inform a peer that the request could not be satisfied at the time it was received, but may be able to satisfy the request in the future. + +The Result-Code AVP values defined in Diameter base protocol IETF RFC 6733 [23] are applicable. Also the following specific Sy Experimental-Result-Code value is defined for transient failures: + +DIAMETER\_ERROR\_NO\_AVAILABLE\_POLICY\_COUNTERS (4241) + +This error shall be used by the OCS to indicate to the PCRF that the OCS has no available policy counters for the subscriber. + +The PCRF may retry the request based on local configuration or operator policy on receipt of a transient failure. + +## 5.6 Sy Messages + +### 5.6.1 Command-Code Values + +This section defines the Command-Code values for the Sy interface application as allocated by IANA from the vendor-specific namespace defined in IETF RFC 5719 [6]. Every command is defined by means of the ABNF syntax IETF RFC 2234 [7], according to the rules in IETF RFC 6733 [23]. + +The following Command Codes are defined in this specification: + +**Table 5.6.1: Command-Code values for Sy** + +| Command-Name | Abbreviation | Code | Section | +|--------------------------------------|--------------|---------|---------| +| Spending-Limit-Request | SLR | 8388635 | 5.6.2 | +| Spending-Limit-Answer | SLA | 8388635 | 5.6.3 | +| Spending-Status-Notification-Request | SNR | 8388636 | 5.6.4 | +| Spending-Status-Notification-Answer | SNA | 8388636 | 5.6.5 | + +In addition, the Session-Termination-Request and Session-Termination-Answer commands are reused from IETF RFC 6733 [23]. + +For the commands defined in this specification and reused commands, the Application-ID field shall be set to 16777302. + +### 5.6.2 Spending-Limit-Request (SLR) command + +The SLR command, indicated by the Command-Code field set to 8388635 and the 'R' bit set in the Command Flags field, is sent by the PCRF to the OCS as part of the Initial or Intermediate Spending Limit Report Request procedure. + +Message Format: + +``` + ::= + < Session-Id > + [ DRMP ] + { Auth-Application-Id } + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + [ Destination-Host ] + [ Origin-State-Id ] + [ OC-Supported-Features ] + * [ Supported-Features ] + { SL-Request-Type } + * [ Subscription-Id ] + * [ Policy-Counter-Identifier ] + [ Logical-Access-ID ] + [ Physical-Access-ID ] + * [ Proxy-Info ] + * [ Route-Record ] + * [ AVP ] +``` + +NOTE: Multiple instances of the Subscription-Id AVP in the SLR command correspond to multiple types of identifier for the same subscriber, for example IMSI and MSISDN. + +### 5.6.3 Spending-Limit-Answer (SLA) command + +The SLA command, indicated by the Command-Code field set to 8388635 and the 'R' bit cleared in the Command Flags field, is sent by the OCS to the PCRF as part of the Initial or Intermediate Spending Limit Report Request procedure. + +Message Format: + +``` + ::= < Diameter Header: 8388635, PXY > + < Session-Id > + [ DRMP ] + { Auth-Application-Id } + { Origin-Host } + { Origin-Realm } + [ Result-Code ] + [ Experimental-Result ] + [ OC-Supported-Features ] + [ OC-OLR ] + * [ Supported-Features ] + * [ Policy-Counter-Status-Report ] + [ Error-Message ] + [ Error-Reporting-Host ] + [ Failed-AVP ] + [ Origin-State-Id ] + * [ Redirect-Host ] + [ Redirect-Host-Usage ] + [ Redirect-Max-Cache-Time ] + * [ Proxy-Info ] + * [ Load ] + * [ AVP ] +``` + +### 5.6.4 Spending-Status-Notification-Request (SNR) command + +The SNR command, indicated by the Command-Code field set to 8388636 and the 'R' bit set in the Command Flags field, is sent by the OCS to the PCRF as part of the Spending Limit Report procedure. + +Message Format: + +``` + ::= < Diameter Header: 8388636, REQ, PXY > + < Session-Id > + [ DRMP ] + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + { Destination-Host } + { Auth-Application-Id } + [ Origin-State-Id ] + [ OC-Supported-Features ] + * [ Policy-Counter-Status-Report ] + [ SN-Request-Type ] + * [ Proxy-Info ] + * [ Route-Record ] + * [ AVP ] +``` + +### 5.6.5 Spending-Status-Notification-Answer (SNA) command + +The SNA command, indicated by the Command-Code field set to 8388636 and the 'R' bit cleared in the Command Flags field, is sent by the PCRF to the OCS as part of the Spending Limit Report procedure. + +Message Format: + +``` + ::= < Diameter Header: 8388636, PXY > + < Session-Id > + [ DRMP ] + { Origin-Host } + { Origin-Realm } + [ Result-Code ] + [ Experimental-Result ] + [ Origin-State-Id ] + [ OC-Supported-Features ] +``` + +``` +[ OC-OLR ] +[ Error-Message ] +[ Error-Reporting-Host ] +*[ Redirect-Host ] +[ Redirect-Host-Usage ] +[ Redirect-Max-Cache-Time ] +[ Failed-AVP ] +*[ Proxy-Info ] +*[ AVP ] +``` + +### 5.6.6 Session-Termination-Request (STR) command + +The STR command, indicated by the Command-Code field set to 275 and the 'R' bit set in the Command Flags field, is sent by the PCRF to the OCS as part of the Final Spending Limit Report Request procedure. + +Message Format: + +``` + ::= < Diameter Header: 275, REQ, PXY > + < Session-Id > + [ DRMP ] + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + { Auth-Application-Id } + { Termination-Cause } + [ Destination-Host ] + [ OC-Supported-Features ] + [ Origin-State-Id ] + *[ Proxy-Info ] + *[ Route-Record ] + *[ AVP ] +``` + +### 5.6.7 Session-Termination-Answer (STA) command + +The STA command, indicated by the Command-Code field set to 275 and the 'R' bit cleared in the Command Flags field, is sent by the OCS to the PCRF as part of the Final Spending Limit Report Request procedure. + +Message Format: + +``` + ::= < Diameter Header: 275, PXY > + < Session-Id > + [ DRMP ] + { Origin-Host } + { Origin-Realm } + [ Result-Code ] + [ Error-Message ] + [ Error-Reporting-Host ] + [ Failed-AVP ] + [ Origin-State-Id ] + [ OC-Supported-Features ] + [ OC-OLR ] + *[ Redirect-Host ] + [ Redirect-Host-Usage ] + [ Redirect-Max-Cache-Time ] + *[ Proxy-Info ] + *[ Load ] + *[ AVP ] +``` + +# --- Annex A (normative): User Identity for Fixed Broadband Access network convergence + +In the Fixed Broadband Access network convergence scenario, the User Identity refers to the Subscriber Identifier as defined in TS 29.212 [19] Annex G.5.1.6. + +If the User Identity is the Access Line Identifier, the Logical-Access-ID AVP and Physical-Access-ID AVP are included in the SLR command instead of the Subscription-Id AVP. + +# Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|--------|-----------|------|-----|-----------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 2014-12 | TSG#66 | CP-140922 | 020 | 2 | Update PCC architecture diagrams to include Np reference point | 12.2.0 | 13.0.0 | +| 2015-06 | TSG#68 | CP-150342 | 0023 | 1 | Notify a pending policy counter status change | 13.0.0 | 13.1.0 | +| 2015-06 | TSG#68 | CP-150342 | 0026 | 1 | Correction to pending policy counters status report | 13.0.0 | 13.1.0 | +| 2015-06 | TSG#68 | CP-150342 | 0029 | 5 | Including the Supported-Features AVP | 13.0.0 | 13.1.0 | +| 2015-06 | TSG#68 | CP-150348 | 0031 | 1 | Usage of AVPs related to user identity for convergence scenario | 13.0.0 | 13.1.0 | +| 2015-06 | TSG#68 | CP-150360 | 0032 | 1 | Diameter overload control over Sy | 13.0.0 | 13.1.0 | +| 2015-06 | TSG#68 | CP-150363 | 0034 | 1 | Correcting Hanging Paragraphs | 13.0.0 | 13.1.0 | +| 2015-12 | TSG#70 | CP-150797 | 0040 | 1 | Update the PCC architecture figures in 29.219 | 13.1.0 | 13.2.0 | +| 2015-12 | TSG#70 | CP-150630 | 0041 | 1 | Update draft-ietf-dime-ovli reference to RFC 7683 | 13.1.0 | 13.2.0 | +| 2015-12 | TSG#70 | CP-150788 | 0042 | 3 | Sy interface impacts for Race condition handling | 13.1.0 | 13.2.0 | +| 2015-12 | TSG#70 | CP-150788 | 0046 | 2 | Correction text for the use of the Spending-Status-Notification-Request (SNR) command on the Sy reference point | 13.1.0 | 13.2.0 | +| Change history | | | | | | | | +| Date | TSG # | TSG Doc. | CR | Rev | Cat | Subject/Comment | New | +| 2016-03 | TSG#71 | CP-160093 | 0047 | 2 | B | Diameter Message Priority over Sy interface | 13.3.0 | +| 2016-12 | TSG#74 | CP-160614 | 0052 | - | F | Change IETF drmp draft version to official RFC 7944 | 13.4.0 | +| 2016-12 | TSG#74 | CP-160615 | 0051 | 2 | B | Diameter Load Control Mechanism | 14.0.0 | +| 2016-12 | TSG#74 | CP-160616 | 0053 | 1 | F | Diameter base protocol specification update | 14.0.0 | +| 2017-03 | TSG#75 | CP-170076 | 0055 | 1 | F | Update instance number for the Failed-AVP in answer commands | 14.1.0 | +| 2017-06 | TSG#76 | CP-171119 | 0057 | 1 | F | Reference update for draft-ietf-dime-load | 14.2.0 | +| 2017-09 | TSG#77 | CP-172054 | 0062 | 2 | B | Enhancement on Sy reference point | 15.0.0 | +| 2018-03 | TSG#79 | CP-180049 | 0063 | 2 | F | Supported-Features AVP missing in SLR/SLA's ABNF | 15.1.0 | +| 2019-06 | TSG#84 | CP-191093 | 0073 | 1 | A | Correction of OCS behaviour for unknown and unavailable Policy Counters | 15.2.0 | +| 2019-09 | TSG#85 | CP-192154 | 0075 | 1 | A | draft-ietf-dime-load published as RFC 8583 | 15.3.0 | +| 2020-07 | SA#88e | - | - | - | | Update to Rel-16 version (MCC) | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29228/03d9aaba6c1af8bfd8e42c1d2422ae5c_img.jpg b/marked/Rel-16/29_series/29228/03d9aaba6c1af8bfd8e42c1d2422ae5c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f285927ed975cb4bcef6cea9a32a966a97a12e8e --- /dev/null +++ b/marked/Rel-16/29_series/29228/03d9aaba6c1af8bfd8e42c1d2422ae5c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1328719c35354b91b880ea27faae36f6d0e7adc9a7678ac527ab2cb8294f8447 +size 70122 diff --git a/marked/Rel-16/29_series/29228/08f6ace0c83e7394657fa372b47aec04_img.jpg b/marked/Rel-16/29_series/29228/08f6ace0c83e7394657fa372b47aec04_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..74c063c334c8d168568814515e95c79b5950a816 --- /dev/null +++ b/marked/Rel-16/29_series/29228/08f6ace0c83e7394657fa372b47aec04_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:984de11ebadb07b0992a450d338fc7e5b29f951535b4b838029dedcef101b499 +size 21473 diff --git a/marked/Rel-16/29_series/29228/0a73b03fba21af142d619a9a662e6490_img.jpg b/marked/Rel-16/29_series/29228/0a73b03fba21af142d619a9a662e6490_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f43b1017f7df2dbaf88a5a0eed6ec74fa44936c4 --- /dev/null +++ b/marked/Rel-16/29_series/29228/0a73b03fba21af142d619a9a662e6490_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7a816e84d40478f0d5df29ae1579460edf0cf95cef1070667827194373daeec9 +size 11870 diff --git a/marked/Rel-16/29_series/29228/17439b945bd5156395c7ba15bf04f8fb_img.jpg b/marked/Rel-16/29_series/29228/17439b945bd5156395c7ba15bf04f8fb_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a97fa60bc01a2c2a49dfb2cb8dc95e3fadeec7ec --- /dev/null +++ b/marked/Rel-16/29_series/29228/17439b945bd5156395c7ba15bf04f8fb_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:998635f4e4af6d54c706e82933eda72e03d34c46e9ec3560f013d953ed15575e +size 27009 diff --git a/marked/Rel-16/29_series/29228/21327313f7b18a481da0c87a6472a80d_img.jpg b/marked/Rel-16/29_series/29228/21327313f7b18a481da0c87a6472a80d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..51f0b5b298779fa86180169e77f1ddefdea74e92 --- /dev/null +++ b/marked/Rel-16/29_series/29228/21327313f7b18a481da0c87a6472a80d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4596c3af5f43ece328114490b6ebc76fcbe602ca0348245142fe1ada3257d1b4 +size 30642 diff --git a/marked/Rel-16/29_series/29228/255efa1d461fc79b4ed367aaec11637f_img.jpg b/marked/Rel-16/29_series/29228/255efa1d461fc79b4ed367aaec11637f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..cf915a57addf80d277d92ce4757b98359e28feea --- /dev/null +++ b/marked/Rel-16/29_series/29228/255efa1d461fc79b4ed367aaec11637f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5ed46306fecf7e4fcad09db62e344581850f68f335ac808c1badf0ce1e323ae5 +size 43740 diff --git a/marked/Rel-16/29_series/29228/30387053b5b3fede6873f6a46a9ca4a9_img.jpg b/marked/Rel-16/29_series/29228/30387053b5b3fede6873f6a46a9ca4a9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..82335f79d582621b4db27d998074bfa401ea839a --- /dev/null +++ b/marked/Rel-16/29_series/29228/30387053b5b3fede6873f6a46a9ca4a9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c94134fdc63f04c19de0c44f5afa72a79d8c686346b9bc283f4a08500bce3ce5 +size 18583 diff --git a/marked/Rel-16/29_series/29228/3442f31a562d1ef45bfa18b18a6a1ddc_img.jpg b/marked/Rel-16/29_series/29228/3442f31a562d1ef45bfa18b18a6a1ddc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..847f38f8fcb00ac5fe19f7ba6fdc5e2bd565fc02 --- /dev/null +++ b/marked/Rel-16/29_series/29228/3442f31a562d1ef45bfa18b18a6a1ddc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d92cc4339065d16860356682c2ca1f0f3f4580f96a58de0e9f496778da78566e +size 44007 diff --git a/marked/Rel-16/29_series/29228/3493d7ba4c86f944e159de1bf45ff03d_img.jpg b/marked/Rel-16/29_series/29228/3493d7ba4c86f944e159de1bf45ff03d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0f84d6e1b4119bceec824fd760cf426a73f2480a --- /dev/null +++ b/marked/Rel-16/29_series/29228/3493d7ba4c86f944e159de1bf45ff03d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:04c7c90593b94abd97a8b0fe96b7422b5e3fcae8d9031694570f993ea653255d +size 19487 diff --git a/marked/Rel-16/29_series/29228/396197257cf9437b526bb6585b6a9c8a_img.jpg b/marked/Rel-16/29_series/29228/396197257cf9437b526bb6585b6a9c8a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ddff94e1f15584da425c5b01ea8f82c5b94434b5 --- /dev/null +++ b/marked/Rel-16/29_series/29228/396197257cf9437b526bb6585b6a9c8a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:430ca223a1a38bde1e4dc42e308423cfab6a0fc35b9855ef784b689b54f0810e +size 25875 diff --git a/marked/Rel-16/29_series/29228/40a8c30f7ea5ecea4912e040c97c5b9c_img.jpg b/marked/Rel-16/29_series/29228/40a8c30f7ea5ecea4912e040c97c5b9c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3c5f672c45d7d963b57de8be199a8fe8b444816a --- /dev/null +++ b/marked/Rel-16/29_series/29228/40a8c30f7ea5ecea4912e040c97c5b9c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d299e05922813185926fd2400a3910d787b861c4e15b07b15fa91c602b3d3820 +size 35577 diff --git a/marked/Rel-16/29_series/29228/552328a9daaf3bc0069424b500025880_img.jpg b/marked/Rel-16/29_series/29228/552328a9daaf3bc0069424b500025880_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f55da3d00e890edfde365148ca306300825726a0 --- /dev/null +++ b/marked/Rel-16/29_series/29228/552328a9daaf3bc0069424b500025880_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0d240da06ddf0b5f4695a67a42af061813b993f76c31d997f6236dd4c9fd0b09 +size 44358 diff --git a/marked/Rel-16/29_series/29228/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-16/29_series/29228/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..253fcaf88db3b36e5f702482c6a1f71c22d72fb1 --- /dev/null +++ b/marked/Rel-16/29_series/29228/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:baf2b447178bdd4e7fba1b9a7051629929eb8df4c0314fef5f3396abe42c729f +size 9330 diff --git a/marked/Rel-16/29_series/29228/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-16/29_series/29228/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..773d2e11758ee5b2efc5eda483b37b7dee25b46d --- /dev/null +++ b/marked/Rel-16/29_series/29228/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:aff34bd6350335e965b91e0a39f5b089772ab1954f2613d5ef1e593d664bd659 +size 5819 diff --git a/marked/Rel-16/29_series/29228/675af5bb2357ce5b510e613d04f66bdc_img.jpg b/marked/Rel-16/29_series/29228/675af5bb2357ce5b510e613d04f66bdc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4b400d06cc0b9226a49febb4b4b8906b7ad25913 --- /dev/null +++ b/marked/Rel-16/29_series/29228/675af5bb2357ce5b510e613d04f66bdc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:73b821a17925497698b7043af3cc5c45a730784299342bc2e4b4d2491bd80642 +size 31867 diff --git a/marked/Rel-16/29_series/29228/8d66c9c295023a1380f9986d3663bb1e_img.jpg b/marked/Rel-16/29_series/29228/8d66c9c295023a1380f9986d3663bb1e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..cc8ed6717bef337e94e164ebbf40bc295ac98316 --- /dev/null +++ b/marked/Rel-16/29_series/29228/8d66c9c295023a1380f9986d3663bb1e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c87fbbf5dc3dfa2b979a7e819c71cf12a931164ab94d70ce21c762d069568de4 +size 93064 diff --git a/marked/Rel-16/29_series/29228/a0e8fe7862a6d7341faf5dac275277cc_img.jpg b/marked/Rel-16/29_series/29228/a0e8fe7862a6d7341faf5dac275277cc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..58c43d8fcfb7be76a9884fc22d1bf8d13b4c4617 --- /dev/null +++ b/marked/Rel-16/29_series/29228/a0e8fe7862a6d7341faf5dac275277cc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:52ac6f37f43788a613fcdb345a375526da4336efe2c56de425777f5b67163658 +size 45776 diff --git a/marked/Rel-16/29_series/29228/c0c7f65c51c83fbe595b47326f6b089a_img.jpg b/marked/Rel-16/29_series/29228/c0c7f65c51c83fbe595b47326f6b089a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1fa4ca0f89bac4836bcb608bb78207ec59575651 --- /dev/null +++ b/marked/Rel-16/29_series/29228/c0c7f65c51c83fbe595b47326f6b089a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a82a04ebea2c0fdf8085ee171187d17e1d8308ea175ec24abb4270846176ce4a +size 54761 diff --git a/marked/Rel-16/29_series/29228/dd6c544ab685b25dd17f59456efcfbfc_img.jpg b/marked/Rel-16/29_series/29228/dd6c544ab685b25dd17f59456efcfbfc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..018649411b62012b2cb421372f9529ec5f07a782 --- /dev/null +++ b/marked/Rel-16/29_series/29228/dd6c544ab685b25dd17f59456efcfbfc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:806f77559385cc8032fe7b39a26ecb60238acd9b03174e5ae86c2411484ef27b +size 24237 diff --git a/marked/Rel-16/29_series/29228/ec035e97a11ce40541dec6d88d54c7cb_img.jpg b/marked/Rel-16/29_series/29228/ec035e97a11ce40541dec6d88d54c7cb_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8386847a1faea390dd1f21f270a4f57462090c2a --- /dev/null +++ b/marked/Rel-16/29_series/29228/ec035e97a11ce40541dec6d88d54c7cb_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cdd9b9aa38a03b6afd014387393a2212c074c552215f192218493d5f77441ebb +size 45301 diff --git a/marked/Rel-16/29_series/29228/raw.md b/marked/Rel-16/29_series/29228/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..2a57d1b8e3fdea98319ef41001eaee92165d5e79 --- /dev/null +++ b/marked/Rel-16/29_series/29228/raw.md @@ -0,0 +1,2763 @@ + + +# 3GPP TS 29.228 V16.1.0 (2019-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; IP Multimedia (IM) Subsystem Cx and Dx interfaces; Signalling flows and message contents (Release 16)** + +![5G logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The 5G logo, consisting of the text "5G" in a bold, black, sans-serif font. Above the "5G" text are three green curved lines representing signal waves. + +5G logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, featuring the letters "3GPP" in a stylized, bold, black font. Below the "3GPP" text is a red signal icon consisting of three curved lines. Below the icon, the text "A GLOBAL INITIATIVE" is written in a smaller, black, sans-serif font. + +3GPP logo + +## **3GPP** + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2019, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|----------------------------------------------------------------------------------------------------|-----------| +| Foreword ..... | 5 | +| Introduction ..... | 6 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions of terms, symbols and abbreviations ..... | 7 | +| 3.1 Terms..... | 7 | +| 3.2 Symbols..... | 7 | +| 3.3 Abbreviations ..... | 8 | +| 4 Examples for Styles ..... | 8 | +| 4.1 Heading Styles..... | 8 | +| 4.2 Other common styles..... | 8 | +| "TSG " on the front page..... | 9 | +| Page setup parameters ..... | 9 | +| Proforma copyright release text block ..... | 11 | +| X.1 The right to copy ..... | 11 | +| Abstract Test Suite (ATS) text block ..... | 12 | +| Y Abstract Test Suite (ATS)..... | 12 | +| Y.1 Introduction ..... | 12 | +| Y.2 The TTCN Graphical form (TTCN.GR)..... | 12 | +| Y.3 The TTCN Machine Processable form (TTCN.MP) ..... | 12 | +| Annex <A> (normative): <Normative annex for a Technical Specification> ..... | 13 | +| Annex <B> (informative): <Informative annex for a Technical Specification>..... | 14 | +| B.1 Heading levels in an annex ..... | 14 | +| Annex <B>: <Informative annex title for a Technical Report>..... | 15 | +| Annex <C> (informative): Bibliography ..... | 16 | +| Annex <D> (informative): Index..... | 17 | +| Annex <X> (informative): Change history ..... | 18 | + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +This 3GPP Technical Specification (TS) specifies: + +1. The interactions between the HSS (Home Subscriber Server) and the CSCF (Call Session Control Functions), referred to as the Cx interface. +2. The interactions between the CSCF and the SLF (Server Locator Function), referred to as the Dx interface. +3. The interactions between the SIP Core and the SIP database, referred to as the Cx interface, for the Mission Critical Services, where this interface is named as AAA-1, as described in 3GPP TS 23.280 [30]. + +NOTE: In the 3GPP TS 23.280 [30] the term SIP database is used for the HSS and the term SIP Core is used for the P-CSCF, the I-CSCF and the S-CSCF when compared to this specification. + +The IP Multimedia (IM) Subsystem stage 2 is specified in 3GPP TS 23.228 [1] and the signalling flows for the IP multimedia call control based on SIP and SDP are specified in 3GPP TS 24.228 [2]. + +This document addresses the signalling flows for Cx and Dx interfaces. + +This document also addresses how the functionality of Px interface is accomplished. + +The Presence Service Stage 2 description (architecture and functional solution) is specified in 3GPP TS 23.141 [10]. + +# --- 2 References + +- [1] 3GPP TS 23.228: "IP Multimedia (IM) Subsystem – Stage 2". +- [2] 3GPP TS 24.228: "Signalling flows for the IP multimedia call control based on SIP and SDP". +- [3] 3GPP TS 33.203: "Access security for IP-based services". +- [4] 3GPP TS 23.002: "Network architecture". +- [5] 3GPP TS 29.229: "Cx Interface based on Diameter – Protocol details". +- [6] 3GPP TS 23.218: "IP Multimedia (IM) Session Handling; IP Multimedia (IM) call model". +- [7] IETF RFC 2045 "Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies". +- [8] 3GPP TS 24.229: "IP Multimedia Call Control Protocol based on SIP and SDP" – stage 3. +- [9] Void. +- [10] 3GPP TS 23.141: "Presence Service; Architecture and Functional Description". +- [11] IETF RFC 3261 "SIP: Session Initiation Protocol". +- [12] IETF RFC 4566 "SDP: Session Description Protocol". +- [13] IEEE 1003.1-2004, Part 1: Base Definitions. + +- [14] IETF RFC 2486: "The Network Access Identifier". +- [15] IETF RFC 3966: "The tel URI for Telephone Numbers". +- [16] IETF RFC 2617: "HTTP Authentication: Basic and Digest Access Authentication". +- [17] 3GPP TS 23.003: "Numbering, addressing and identification". +- [18] 3GPP TS 23.008: "Organization of subscriber data". +- [19] 3GPP TS 23.380: "IMS Restoration Procedures". +- [20] Void +- [21] IETF RFC 4005: "Diameter Network Access Server Application". +- [22] IETF RFC 4412: "Communications Resource Priority for the Session Initiation Protocol (SIP)". +- [23] 3GPP TS 23.167: "IP Multimedia Subsystem (IMS) emergency sessions". +- [24] IETF RFC 7683: "Diameter Overload Indication Conveyance". +- [25] 3GPP TS 22.153: "Multimedia Priority Service". +- [26] ANSI X3.4: "Coded Character Set - 7-bit American Standard Code for Information Interchange". +- [27] IETF RFC 7944: "Diameter Routing Message Priority". +- [28] Void +- [29] IETF IETF RFC 8583: "Diameter Load Information Conveyance". +- [30] 3GPP TS 23.280: "Common functional architecture to support mission critical services". +- [31] IETF RFC 6733: "Diameter Base Protocol". +- [32] 3GPP TS 24.323: "3GPP IP Multimedia Subsystem (IMS) service level tracing management object (MO)". + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the following terms and definitions given in TS 23.003 [17] apply: + +**Distinct Public Service Identity** + +**Distinct Public User Identity** + +**Public Service Identity** + +**Public User Identity** + +**Wildcarded Public Service Identity** + +**Wildcarded Public User Identity** + +For the purposes of the present document, the following terms and definitions apply. + +**Common Part** (of a user profile): Contains Initial Filter Criteria instances that should be evaluated both for registered and unregistered Public User Identities, or for unregistered Public Service Identities in the S-CSCF. + +**Complete user profile**: Contains the Initial Filter Criteria instances of all three different user profile parts; registered part, unregistered part and common part. + +**IP Multimedia session:** IP Multimedia session and IP Multimedia call are treated as equivalent in this specification. + +**Authentication pending flag:** A flag that indicates that the authentication of a Public User Identity - Private User Identity pair is pending and waiting for confirmation. + +**Charging information:** Data that is sent in the Charging-Information AVP. + +**Allowed WAF and/or WWSF identities:** A list of network addresses identifying WebRTC Authentication Functions (WAFs) and/or WebRTC Web Server Functions (WWSFs) allowed for a subscription. + +**Implicitly registered Public User Identity set:** A set of Public User Identities, which are registered and de-registered simultaneously when any of the Public User Identities belonging to that set is registered or de-registered. + +**Not Registered State:** Public Identity is not Registered and has no S-CSCF assigned. + +**Private Identity:** Either a Private User Identity or a Private Service Identity. + +**Public Identity:** Either a Public User Identity or a Public Service Identity. + +**Registered Part** (of a user profile): Contains Initial Filter Criteria instances that should be evaluated only for registered Public User Identities in the S-CSCF. iFCs from the registered part need not be evaluated when the Public Identity is unregistered. + +**Registered State:** Public User Identity is Registered at the request of the user and has an S-CSCF assigned. + +**S-CSCF reassignment pending flag:** A flag that is handled only when IMS Restoration Procedures are supported, and that indicates that the subscription may be reassigned to a new S-CSCF (i.e. the current S-CSCF is not responding) + +**Unregistered part** (of a user profile): Contains Initial Filter Criteria instances that should be evaluated only for unregistered Public Identities in the S-CSCF. iFCs from the unregistered part need not be evaluated when the Public User Identity is registered. + +**Unregistered State:** Public Identity is not Registered but has a serving S-CSCF assigned to execute Unregistered state services as a consequence of a terminating request, or an originating request from an AS on behalf of a user, or there is an S-CSCF keeping the user profile stored. + +**User information:** The user related data that the S-CSCF requests from the HSS or HSS pushes to the S-CSCF, e.g. user profile, charging information, allowed WAF and/or WWSF identities and authentication information. + +**User profile:** Data that is sent in the User-Data AVP. + +## 3.2 Abbreviations + +For the purposes of the present document, the following abbreviations apply: + +| | | +|--------|------------------------------------| +| AVP | Attribute Value Pair | +| C | Conditional | +| CSCF | Call Session Control Function | +| DRMP | Diameter Routing Message Priority | +| DSCP | Differentiated Services Code Point | +| GIBA | GPRS-IMS-Bundled-Authentication | +| HSS | Home Subscriber Server | +| IE | Information Element | +| IP | Internet Protocol | +| I-CSCF | Interrogating CSCF | +| IM | IP Multimedia | +| IMS | IP Multimedia Subsystem | +| M | Mandatory | +| MPS | Multimedia Priority Service | +| NASS | Network Attachment SubSystem | +| O | Optional | +| P-CSCF | Proxy CSCF | +| SIP | Session Initiation Protocol | +| SLF | Server Locator Function | + +| | | +|--------|--------------------------------| +| S-CSCF | Serving CSCF | +| WAF | WebRTC Authentication Function | +| WWSF | WebRTC Web Server Function | + +# --- 4 Main Concept + +This document presents the Cx interface related functional requirements of the communicating entities. + +It gives a functional classification of the procedures and describes the procedures and message parameters. + +Error handling flows, protocol version identification, etc. procedures are also included. + +# --- 5 General Architecture + +This clause further specifies the architectural assumptions associated with the Cx reference point, building on TS 23.228 [1] and also the Px reference point building upon TS 23.141 [10]. + +## 5.1 Functional requirements of network entities + +### 5.1.1 Functional requirements of P-CSCF + +There is no requirement for the interaction between the P-CSCF and the HSS. + +### 5.1.2 Functional requirements of I-CSCF + +The I-CSCF communicates with the HSS over the Cx interface. + +For functionality of the I-CSCF refer to TS 23.002 [4]. + +### 5.1.3 Functional requirements of S-CSCF + +The S-CSCF communicates with the HSS over the Cx interface. + +For functionality of the S-CSCF refer to TS 23.002 [4]. + +### 5.1.4 Functional requirements of HSS + +The HSS communicates with the I-CSCF and the S-CSCF over the Cx interface. + +For functionality of the HSS refer to TS 23.002 [4]. + +### 5.1.5 Functional classification of Cx interface procedures + +Operations on the Cx interface are classified in functional groups: + +1. Location management procedures + - The operations regarding registration and de-registration. + - Location retrieval operation. +2. User data handling procedures + - The download of user information during registration and to support recovery mechanisms. + - Operations to support the updating of user data and recovery mechanisms. +3. User authentication procedures + +4. IMS Restoration Procedures (see TS 23.380 [19]) to support S-CSCF service interruption + +### 5.1.6 Functional Requirements of the Presentity Presence Proxy + +The interaction between the Presentity Presence Proxy and the HSS, referred to as the Px interface, is handled using the mechanisms defined for the Cx interface. + +# --- 6 Procedure Descriptions + +In the tables that describe the Information Elements transported by each command, each Information Element is marked as (M) Mandatory, (C) Conditional or (O) Optional in the Category "Cat." column. The application level specification overrides the ABNF defining the presence of the AVPs to be included in the Diameter commands. The category defined by the Information Element table shall always be the same, i.e. Optional; or more restrictive, i.e. Mandatory or Conditional, than the presence requirements defined by the ABNF syntax, e.g. a required AVP in the ABNF shall not be overridden by an Optional IE but an Optional AVP in the ABNF may be overridden by the Mandatory or Conditional IE Category. + +- A mandatory Information Element shall always be present in the command. If this Information Element is absent, an application error occurs at the receiver and an answer message shall be sent back to the originator of the request with the Result-Code set to DIAMETER\_MISSING\_AV. This message shall also include a Failed-AVP AVP containing the missing Information Element i.e. the corresponding Diameter AVP defined by the AVP Code and the other fields set as expected for this Information Element. +- A conditional Information Element (marked as (C) in the table) shall be present in the command if certain conditions are fulfilled. + - If the receiver detects that those conditions are fulfilled and the Information Element is absent, an application error occurs and an answer message shall be sent back to the originator of the request with the Result-Code set to DIAMETER\_MISSING\_AV. This message shall also include a Failed-AVP AVP containing the missing Information Element i.e. the corresponding Diameter AVP defined by the AVP Code and the other fields set as expected for this Information Element. + - If those conditions are not fulfilled, the Information Element shall be absent. If however this Information Element appears in the message, it shall not cause an application error and it may be ignored by the receiver if this is not explicitly defined as an error case. Otherwise, an application error occurs at the receiver and an answer message with the Result-Code set to DIAMETER\_AVP\_NOT\_ALLOWED shall be sent back to the originator of the request. A Failed-AVP AVP containing a copy of the corresponding Diameter AVP shall be included in this message. +- An optional Information Element (marked as (O) in the table) may be present or absent in the command, at the discretion of the application at the sending entity. Absence or presence of this Information Element shall not cause an application error and may be ignored by the receiver. + +When a procedure is required to determine whether two S-CSCF names are equal, the rules for SIP URI comparison specified in RFC 3261 chapter 19.1.4 shall apply. + +When a procedure is required to determine the Public Identity used for an identity lookup in HSS and SLF, the HSS and SLF shall use the Public Identity from the SIP URI or Tel URI as contained in the Public-Identity AVP that is in canonical form as described by TS 23.003 [17]. + +Unknown permanent failure error codes shall be treated in the same way as DIAMETER\_UNABLE\_TO\_COMPLY. For unknown transient failure error codes the request may be repeated, or handled in the same way as DIAMETER\_UNABLE\_TO\_COMPLY. + +## 6.1 Location management procedures + +### 6.1.1 User registration status query + +This procedure is used between the I-CSCF and the HSS during SIP registrations. The procedure is invoked by the I-CSCF, corresponds to the combination of the functional level operations Cx-Query and Cx-Select-Pull (see TS 23.228 [1]) and is used: + +- To authorize the registration of the distinct Public User Identity, checking multimedia subsystem access permissions and roaming agreements. +- To perform a first security check, determining whether the distinct Public User Identity in the message is associated with the Private User Identity sent in the message. +- To obtain either the S-CSCF where the distinct Public User Identity is registered or unregistered (i.e. registered as a consequence of an originating or terminating request or there is a S-CSCF keeping the user profile stored), or the list of capabilities that the S-CSCF has to support. + +This procedure is mapped to the commands User-Authorization-Request/Answer in the Diameter application specified in TS 29.229 [5]. Tables 6.1.1.1 and 6.1.1.2 detail the involved information elements. + +**Table 6.1.1.1: User registration status query** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------------------|-------------------------------------|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Public User Identity (See 7.2) | Public-Identity | M | Public User Identity to be registered | +| Visited Network Identifier (See 7.1) | Visited-Network-Identifier | M | Identifier that allows the home network to identify the visited network | +| Type of Authorization (See 7.14) | User-Authorization-Type | C |

Type of authorization requested by the I-CSCF.

If the request corresponds to a de-registration, i.e. Expires field or expires parameter in Contact field in the REGISTER method is equal to zero, this AVP shall be present in the command and the value shall be set to DE-REGISTRATION.

If the request corresponds to an initial registration or a re-registration, i.e. Expires field or expires parameter in Contact field in the REGISTER method is not equal to zero then this AVP may be absent from the command. If present its value shall be set to REGISTRATION.

If the request corresponds to an initial registration or a re-registration or a de-registration and the I-CSCF explicitly queries the S-CSCF capabilities, then this AVP shall be present in the command and the value shall be set to REGISTRATION_AND_CAPABILITIES. The I-CSCF shall use this value when the S-CSCF currently assigned to the Public User Identity in the HSS, cannot be contacted and a new S-CSCF needs to be selected. The I-CSCF shall also use this value for RLOS related registrations when the S-CSCF currently assigned to the Public User Identity in the HSS does not support RLOS (see 3GPP TS 23.228 [1] annex Z) and a new S-CSCF (supporting RLOS) needs to be selected.

RLOS support of the different S-CSCFs shall be locally configured in the I-CSCF, and this capability is independent on the subscribed capabilities received from HSS.

| +| Private User Identity (See 7.3) | User-Name | M | Private User Identity | +| Routing Information (See 7.13) | Destination-Host, Destination-Realm | C | If the I-CSCF knows HSS name Destination-Host AVP shall be present in the command. Otherwise, only Destination-Realm AVP shall be present and the command shall be routed to the next Diameter node, e.g. SLF, based on the Diameter routing table in the I-CSCF. | +| UAR Flags (See 7.19) | UAR-Flags | O | This Information Element contains a set of indications. See 7.19 for the content of the information element. | + +**Table 6.1.1.2: User registration status response** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|----------------------------------|--------------------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result
(See 7.6) | Result-Code /
Experimental-Result | M | Result of the operation.
Result-Code AVP shall be used for errors defined in the Diameter base protocol (see IETF RFC 6733 [31]).
Experimental-Result AVP shall be used for Cx/Dx errors. This is a grouped AVP which contains the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | +| S-CSCF capabilities
(See 7.5) | Server-Capabilities | O | Required capabilities of the S-CSCF to be assigned to the IMS Subscription. | +| S-CSCF Name
(See 7.4) | Server-Name | C | Name of the assigned S-CSCF. | + +#### 6.1.1.1 Detailed behaviour + +The HSS shall, in the following order (if there is an error in any of the following steps the HSS shall stop processing and return the corresponding error code, see TS 29.229 [5]): + +0. If the HSS supports WebRTC as described in TS 23.228 [1] clause U.2.1.4, it shall check if the Private User Identity and the Public User Identity are managed by a third party, if so the HSS continues in step 4. + +NOTE : How the HSS identifies that the Private User Identity and the Public User Identity are managed by a third party for WebRTC and how the HSS identifies the corresponding user profile are implementation specific. + +1. Check that the Private User Identity and the Public User Identity exists in the HSS. If not Experimental-Result-Code shall be set to DIAMETER\_ERROR\_USER\_UNKNOWN. +2. Check that the Public User Identity matches a distinct Public User Identity in the HSS. If it doesn't, the Experimental-Result-Code shall be set to DIAMETER\_ERROR\_USER\_UNKNOWN. +3. Check that the Public User Identity received in the request is associated with the Private User Identity received in the request. If not Experimental-Result-Code shall be set to DIAMETER\_ERROR\_IDENTITIES\_DONT\_MATCH. +4. Check whether the Public User Identity received in the request is barred from the establishment of multimedia sessions. + - If it is an IMS Emergency Registration (by checking the UAR Flags) or the Public User Identity received in the request is not barred, continue to step 5. + - Otherwise, the HSS shall check whether there are other non-barred Public User Identities to be implicitly registered with that one. + - If so, continue to step 5. + - If not, Result-Code shall be set to DIAMETER\_AUTHORIZATION\_REJECTED. +5. Check the User-Authorization-Type received in the request: + - If it is REGISTRATION or if User-Authorization-Type is absent from the request, the HSS shall check whether the UAR Flags indicate that this is an IMS Emergency Registration: + - If it is not, and the Public User Identity is allowed to roam in the visited network (if not Experimental-Result-Code shall be set to DIAMETER\_ERROR\_ROAMING\_NOT\_ALLOWED) and authorized to register (if not Result-Code shall be set to DIAMETER\_AUTHORIZATION\_REJECTED) then continue to step 6. + - If it is an IMS Emergency Registration, authorization shall be granted and the HSS shall not perform any check regarding roaming. Continue to step 6. + - If it is DE\_REGISTRATION, the HSS may not perform any check regarding roaming. Continue to step 6. + +- If it is REGISTRATION\_AND\_CAPABILITIES, the HSS shall check whether the UAR Flags indicate that this is an IMS Emergency Registration: +- If it is not, and the Public User Identity is allowed to roam in the visited network (if not Experimental-Result-Code shall be set to DIAMETER\_ERROR\_ROAMING\_NOT\_ALLOWED) and authorized to register (if not Result-Code shall be set to DIAMETER\_AUTHORIZATION\_REJECTED). The HSS may return the Server-Capabilities AVP, which enables the I-CSCF to select an S-CSCF. The returned capabilities, if any, shall satisfy all the requirements of all the service profiles associated with the IMS Subscription. If Server-Capabilities AVP is absent, it indicates to the I-CSCF that it can select any available S-CSCF. If an S-CSCF is already assigned in the HSS and IMS Restoration Procedures are supported in the HSS, the HSS shall set the S-CSCF reassignment pending flag and shall allow overwriting of the S-CSCF name in the next SAR request. Result-Code shall be set to DIAMETER\_SUCCESS. The HSS shall not return any S-CSCF name. Stop processing. +- If it is an IMS Emergency Registration, authorization shall be granted and the HSS shall not perform any check regarding roaming. The HSS may return the Server-Capabilities AVP, which enables the I-CSCF to select an S-CSCF. The returned capabilities, if any, shall satisfy all the requirements of all the service profiles associated with the IMS Subscription. The Server-Capabilities AVP may be absent, to indicate to the I-CSCF that it can select any available S-CSCF. Result-Code shall be set to DIAMETER\_SUCCESS. The HSS shall not return any S-CSCF name. Stop processing. + +##### 6. Check the state of the Public User Identity received in the request: + +- If it is registered, the HSS shall return the stored S-CSCF name. No S-CSCF capabilities shall be present in the response. If User-Authorization-Type is equal to REGISTRATION or is absent, Experimental-Result-Code shall be set to DIAMETER\_SUBSEQUENT\_REGISTRATION. If User-Authorization-Type is equal to DE-REGISTRATION, Result-Code shall be set to DIAMETER\_SUCCESS. +- If it is unregistered (i.e. registered as a consequence of an originating or terminating request or there is an S-CSCF keeping the user profile stored) and User-Authorization-Type is equal to DE-REGISTRATION, the HSS shall return the stored S-CSCF name and the Result-Code shall be set to DIAMETER\_SUCCESS. If the User-Authorization-Type is equal to REGISTRATION or is absent, then the HSS shall return the stored S-CSCF name and the Experimental-Result-Code set to DIAMETER\_SUBSEQUENT\_REGISTRATION. The HSS shall not return any S-CSCF capabilities. +- If it is not registered yet, the HSS shall check the value of User-Authorization-Type received in the request: + - If the value of User-Authorization-Type is DE\_REGISTRATION and the Authentication pending flag is set, the HSS shall return the stored S-CSCF name and Experimental-Result-Code set to DIAMETER\_SUCCESS. The HSS shall not return any S-CSCF capabilities. Otherwise, if Authentication pending flag is not set, the HSS shall not return any S-CSCF name or S-CSCF capabilities. The HSS shall set the Experimental-Result-Code to DIAMETER\_ERROR\_IDENTITY\_NOT\_REGISTERED in the response. + - If the value of User-Authorization-Type is REGISTRATION or is absent, then the HSS shall check if there is at least one Public User Identity within the IMS Subscription with an S-CSCF name assigned. + - If there is at least one Public User Identity within the IMS Subscription that is registered, the HSS shall return the S-CSCF name assigned for that Public User Identity and Experimental-Result-Code set to DIAMETER\_SUBSEQUENT\_REGISTRATION. The HSS shall not return any S-CSCF capabilities. + - If there is at least one Public User Identity within the IMS Subscription that is unregistered (i.e. registered as a consequence of an originating or terminating request or there is an S-CSCF keeping the user profile stored), then the HSS shall return the stored S-CSCF name and the Experimental-Result-Code set to DIAMETER\_SUBSEQUENT\_REGISTRATION. The HSS shall not return any S-CSCF capabilities. + - If there is no identity of the user within the same IMS Subscription that is registered or unregistered, the HSS shall check if there is an S-CSCF name stored for the user (e.g. the user is being authenticated by the S-CSCF as indicated by the Authentication pending flag). If it is, the HSS shall return the stored S-CSCF name and Experimental-Result-Code set to DIAMETER\_SUBSEQUENT\_REGISTRATION. The HSS shall not return any S-CSCF capabilities. + +- If there is not any Public User Identity within the IMS Subscription with an S-CSCF name assigned, then the HSS may return the Server-Capabilities AVP, which enables the I-CSCF to select an S-CSCF. The returned capabilities, if any, shall satisfy all the requirements of all the service profiles associated with the IMS Subscription. The Server-Capabilities AVP may be absent, to indicate to the I-CSCF that it may select any available S-CSCF. Experimental-Result-Code shall be set to DIAMETER\_FIRST\_REGISTRATION. The HSS shall not return any S-CSCF name. + +If the HSS cannot fulfil received request, e.g. due to database error, it shall set Result-Code to DIAMETER\_UNABLE\_TO\_COMPLY. No S-CSCF name or S-CSCF capabilities shall be present in the response. + +### 6.1.2 S-CSCF registration/deregistration notification + +This procedure is used between the S-CSCF and the HSS. The procedure is invoked by the S-CSCF, corresponds to the combination of the operations Cx-Put and Cx-Pull (see TS 23.228 [1]) and is used: + +- To assign an S-CSCF to a Public Identity, or to clear the name of the S-CSCF assigned to one or more Public Identities. +- To download from HSS the relevant user information for the S-CSCF. +- To backup and retrieve the S-CSCF Restoration Information (see TS 23.380 [19]) in the HSS. +- To provide a P-CSCF Restoration Indication to the HSS and trigger P-CSCF Restoration mechanism. + +This procedure is mapped to the commands Server-Assignment-Request/Answer in the Diameter application specified in TS 29.229 [5]. Tables 6.1.2.1 and 6.1.2.2 describe the involved information elements. + +Table 6.1.2.1: S-CSCF registration/deregistration notification request + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|---------------------------------------------------------------------|-----------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Public User Identity / Public Service Identity (See 7.2 and 7.2a) | Public-Identity | C | Public Identity or list of Public Identities.
One and only one Public Identity shall be present if the Server-Assignment-Type is any value other than TIMEOUT_DEREGISTRATION, USER_DEREGISTRATION, DEREGISTRATION_TOO_MUCH_DATA, TIMEOUT_DEREGISTRATION_STORE_SERVER_NAME, USER_DEREGISTRATION_STORE_SERVER_NAME or ADMINISTRATIVE_DEREGISTRATION.
If Server-Assignment-Type indicates deregistration of some type and Private Identity is not present in the request, at least one Public Identity shall be present. | +| S-CSCF Name (See 7.4) | Server-Name | M | Name of the S-CSCF. | +| Private User Identity / Private Service Identity (See 7.3 and 7.3a) | User-Name | C | Private Identity.
It shall be present if it is available when the S-CSCF issues the request. It may be absent during the initiation of a session to an unregistered Public Identity (Server-Assignment-Type shall contain the value UNREGISTERED_USER) or after S-CSCF recovery upon originating request different than REGISTER (Server-Assignment-Type shall contain the value NO_ASSIGNMENT).
In case of de-registration, Server-Assignment-Type equal to TIMEOUT_DEREGISTRATION, ADMINISTRATIVE_DEREGISTRATION, DEREGISTRATION_TOO_MUCH_DATA or TIMEOUT_DEREGISTRATION_STORE_SERVER_NAME if no Public-Identity AVPs are present then User-Name AVP shall be present. | +| Server Assignment Type (See 7.8) | Server-Assignment-Type | M | Type of update, request or notification that the S-CSCF requests in the HSS (e.g. de-registration). See 3GPP TS 29.229 [5] for all the possible values. | +| User Data Already Available (See 7.16) | User-Data-Already-Available | M | This indicates if the user profile and charging information and, if supported and present in the subscription, allowed WAF and/or WWSF identities are already available in the S-CSCF.
In the case where Server-Assignment-Type is not equal to NO_ASSIGNMENT, REGISTRATION, RE_REGISTRATION or UNREGISTERED_USER, the HSS shall not use User Data Already Available when processing the request. | +| Routing Information (See 7.13) | Destination-Host | C | If the S-CSCF knows the HSS name, the Destination-Host AVP shall be present in the command.
This information is available if the request belongs to an already existing registration, e.g. in case of the re-registration, where the HSS name is stored in the S-CSCF. The HSS name is obtained from the Origin-Host AVP, which is received from the HSS, e.g. included in the MAA command. This information may not be available if the command is sent as a consequence of a session termination for an unregistered Public Identity. In this case the Destination-Host AVP is not present and the command is routed to the next Diameter node, e.g. SLF, based on the Diameter routing table in the S-CSCF. | +| Wildcarded Public Identity (See 7.2b) | Wildcarded-Public-Identity | O | If the request refers to a Wildcarded PSI or Wildcarded Public User Identity, and the Server-Assignment-Type is set to UNREGISTERED_USER, NO_ASSIGNMENT, TIMEOUT_DEREGISTRATION_STORE_SERVER_NAME, ADMINISTRATIVE_DEREGISTRATION, DEREGISTRATION_TOO_MUCH_DATA or TIMEOUT_DEREGISTRATION, the S-CSCF may include the corresponding Wildcarded PSI or Wildcarded Public User Identity in this information element.
If this element is present, it shall be used by the HSS to identify the identity affected by the request. The terms Public Identity or Public Service Identity in the detailed behaviour refer then to the Wildcarded Public Identity. | +| S-CSCF Restoration Information (See 7.21) | SCSCF-Restoration-Info | C | When the S-CSCF supports IMS Restoration Procedures, if Server-Assignment-Type is REGISTRATION or RE_REGISTRATION, and any of the related restoration information changed compared to the previous one, the S-CSCF shall send this information element to the HSS. This information allows a later retrieval in case of an S-CSCF service interruption. | + +| | | | | +|---------------------------------------------|----------------------------------|---|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Multiple-Registration-Indication (See 7.23) | Multiple-Registration-Indication | C | When the S-CSCF supports IMS Restoration Procedures, if Server-Assignment-Type is REGISTRATION and the registration is a multiple registration and the Public User Identity is not stored as registered with the Private User Identity as in the request in the S-CSCF, the S-CSCF shall send this information element to the HSS. | +| Session-Priority (See 7.24) | Session-Priority | O | This information element, if present, shall indicate the session's priority to the HSS. | +| SAR Flags (See 7.28) | SAR-Flags | O | This Information Element contains a set of indications. See 7.28 for the content of the information element. | + +Table 6.1.2.2: S-CSCF registration/deregistration notification response + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|---------------------------------------------------------------------|-----------------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Private User Identity / Private Service Identity (See 7.3 and 7.3a) | User-Name | C | Private Identity.
It shall be present if it is available when the HSS sends the response.
It may be absent in the following error case: when the Server-Assignment-Type of the request is UNREGISTERED_USER and the received Public Identity is not known by the HSS. | +| Registration result (See 7.6) | Result-Code / Experimental-Result | M | Result of registration.
Result-Code AVP shall be used for errors defined in the Diameter base protocol (see IETF RFC 6733 [31]).
Experimental-Result AVP shall be used for Cx/Dx errors. This is a grouped AVP which contains the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | +| User Profile (See 7.7) | User-Data | C | Relevant user profile.
It shall be present when Server-Assignment-Type in the request is equal to NO_ASSIGNMENT, REGISTRATION, RE_REGISTRATION or UNREGISTERED_USER according to the rules defined in clause 6.6.
If the S-CSCF receives more data than it is prepared to accept, it shall perform the de-registration of the Private Identity with Server-Assignment-Type set to DEREGISTRATION_TOO_MUCH_DATA and send back a SIP 3xx or 480 (Temporarily Unavailable) response, which shall trigger the selection of a new S-CSCF by the I-CSCF, as specified in 3GPP TS 24.229 [8]. | +| Charging Information (See 7.12) | Charging-Information | C | Addresses of the charging functions.
It shall be present when the User-Data AVP is sent to the S-CSCF according to the rules defined in clause 6.6.
When this parameter is included, either the Primary-Charging-Collection-Function-Name AVP or the Primary-Event-Charging-Function-Name AVP shall be included. All other elements shall be included if they are available. | +| Associated Private Identities | Associated-Identities | O | This AVP contains all Private Identities, which belong to the same IMS subscription as the Private Identity or Public Identity received in the SAR command.
If the IMS subscription contains only single Private Identity this AVP shall not be present. | +| Loose-Route Indication | Loose-Route-Indication | C | This AVP indicates to the S-CSCF that loose-route mechanism shall be applied to the public identities contained in the user profile received from the HSS.
If the loose-route mechanism is required, this AVP shall be present and set to LOOSE_ROUTE_REQUIRED.
If the Loose-Route mechanism is not required, this AVP may be either absent or present. If present, it shall be set to LOOSE_ROUTE_NOT_REQUIRED. | +| S-CSCF Restoration Information (See 7.21) | SCSCF-Restoration-Info | C | This information shall be present if it was stored by the S-CSCF in the HSS and Server-Assignment-Type is either UNREGISTERED_USER or NO_ASSIGNMENT.
This information shall also be present if it was stored by the S-CSCF in the HSS and the SAR indicates it is related to a multiple registration and Server-Assignment-Type is REGISTRATION.
This information may be present if it was stored by the S-CSCF in the HSS and Server-Assignment-Type is either REGISTRATION or RE_REGISTRATION and there are other Private Identities different from the Private Identity received in the SAR command being registered with the Public Identity received in the SAR command. | +| Associated Registered Private Identities (See 7.22) | Associated-Registered-Identities | C | This AVP contains all Private Identities that were registered with the Public Identity received in the SAR command.
The HSS shall send this information element if the IMS Restoration Procedures are supported and the value of Server-Assignment-Type in the request is REGISTRATION or RE_REGISTRATION and there are other Private Identities different from the Private Identity received in the SAR command being registered with the Public Identity received in the SAR command.
Otherwise, this AVP shall not be present. | + +| | | | | +|--------------------------------------------------------|--------------------------------------|---|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| S-CSCF Name
(See 7.4) | Server-Name | C | Name of the assigned S-CSCF.
This AVP shall be present, if the requesting S-CSCF name is different from the previously assigned S-CSCF name stored in the HSS. | +| Wildcarded Public Identity
(See 7.2b) | Wildcarded-Public-Identity | C | This AVP shall be present if:
- the value of Server-Assignment-Type in the request was UNREGISTERED_USER or NO_ASSIGNMENT and
- the Wildcarded-Public-Identity AVP in the request was not present and
- the Public Identity in the request fell within the range of a Wildcarded Public User Identity in the HSS whose state is registered/unregistered.

If this element is present, it shall be used by the S-CSCF to identify the identity affected by the request. | +| Privileged-
Sender
Indication
(See 7.26) | Privileged-
Sender-
Indication | O | This AVP indicates if the Private User Identity shall be considered as a privileged sender.
If not present, it means that the Private User Identity is not considered a privileged sender. | +| Allowed WAF
and/or WWSF
Identities (See
7.29) | Allowed-WAF-
WWSF-
Identities | C | Addresses of the WAFs and/or WWSFs the subscription is allowing to use.
This AVP shall be present if both
a) it is applicable for the subscription and
b) the User-Data AVP is present. | + +#### 6.1.2.1 Detailed behaviour + +On registering/deregistering a Public Identity the S-CSCF shall inform the HSS. The same procedure is used by the S-CSCF: + +- to get the user information which contains the user profile, the charging information and the allowed WAF and/or WWSF Identities. The relevant user profile downloaded is described in more detailed in clauses 6.5.1 and 6.6. +- to provide a P-CSCF Restoration Indication to the HSS when the S-CSCF, supporting the HSS based P-CSCF restoration mechanism described in TS 23.380 [19], has identified a P-CSCF failure for a given UE and then triggers the P-CSCF Restoration mechanism execution for this UE. + +The Public-Identity AVP and User-Data AVPs in this command pair shall contain only one type of identities i.e. either only Public User Identities, or only Public Service Identities. User initiated registration/deregistration procedures (i.e. server-assignment-type is set to RE\_REGISTRATION, USER\_DEREGISTRATION, etc.) shall only be allowed for distinct Public User Identities. + +The HSS holds information about the state of registration of all the identities related to an IMS Subscription. The S-CSCF uses this procedure to update such states. For Shared Public User Identities, the S-CSCF shall initiate this procedure towards the HSS for each Private User Identity undergoing a Registration or Deregistration related to the Shared Public User Identity. For implicitly registered identities, the rules defined in Clause 6.5.1 shall apply. + +When the request message was received because of a terminating session request, the HSS may prioritise the received request message according to priority level received within the Session-Priority AVP. + +NOTE 1: Refer to Annex J for HSS procedures associated with the handling of both the Session-Priority AVP and DRMP AVP received in the request message. + +The HSS shall, in the following order (in case of an error in any of the steps the HSS shall stop processing and return the corresponding error code, see TS 29.229 [5]): + +1. Check that the Public Identity and Private Identity exist in the HSS. If not Experimental-Result-Code shall be set to DIAMETER\_ERROR\_USER\_UNKNOWN. +2. The HSS may check whether the Private and Public Identities received in the request are associated in the HSS. If not Experimental-Result-Code shall be set to DIAMETER\_ERROR\_IDENTITIES\_DONT\_MATCH. +3. If more than one Public-Identity AVP is present and the Server-Assignment-Type is one of the values defined in Table 6.1.2.1 as applying for only one identity, then the Result Code shall be set to DIAMETER\_AVP\_OCCURS\_TOO\_MANY\_TIMES and no user information shall be returned. +4. The HSS shall check the Public Identity type received in the request. + +- If the identity in the request is a distinct Public User Identity, continue in step 5, otherwise the HSS shall check the server-assignment-type: + +If it indicates REGISTRATION, RE\_REGISTRATION, USER\_DEREGISTRATION, USER\_DEREGISTRATION\_STORE\_SERVER\_NAME, AUTHENTICATION\_FAILURE or AUTHENTICATION\_TIMEOUT, Experimental-Result-Code shall be set to DIAMETER\_ERROR\_IN\_ASSIGNMENT\_TYPE. + +- If the identity in the request is a Public Service Identity, then check if the PSI Activation State for that identity is active. If not, then the response shall contain Experimental-Result-Code set to DIAMETER\_ERROR\_USER\_UNKNOWN. + +##### 5. Check the Server Assignment Type value received in the request: + +- If it indicates REGISTRATION or RE\_REGISTRATION, the HSS shall check whether the Public Identity is assigned for the S-CSCF requesting the data. + +If there is already an S-CSCF assigned to the user and the requesting S-CSCF is not the same as the previously assigned S-CSCF, and IMS restoration procedures are not supported or the S-CSCF reassignment pending flag is not set, the HSS shall include the name of the previously assigned S-CSCF in the response message and the Experimental-Result-Code shall be set to DIAMETER\_ERROR\_IDENTITY\_ALREADY\_REGISTERED. + +If there is already an S-CSCF assigned to the user and the requesting S-CSCF is not the same as the previously assigned S-CSCF and IMS restoration procedures are supported, and the S-CSCF reassignment pending flag is set, the HSS shall overwrite the S-CSCF name and shall reset the S-CSCF reassignment pending flag. + +If there is no S-CSCF assigned to the user or the requesting S-CSCF is the same as the previously assigned S-CSCF stored in the HSS, the HSS shall download the relevant user information taking into consideration the value set in the User-Data-Already-Available AVP (see clause 6.6). The Result-Code shall be set to DIAMETER\_SUCCESS and the HSS shall set the registration state of the Public User Identity as registered (if not already registered). If the S-CSCF Restoration Information is included in the request and the HSS implements IMS Restoration procedures, and if it is RE\_REGISTRATION, the HSS shall store this information. If the Public User Identity's authentication pending flag which is specific for the Private User Identity is set, the HSS shall clear it. If there are multiple Private User Identities, which belong to the served IMS subscription the Associated-Identities AVP should be added to the answer message and it shall contain all Private User Identities associated to the IMS subscription. If the loose-route mechanism is required for the registered Public User Identities, the Loose-Route-Indication AVP shall be added to the answer message. If there are multiple Private User Identities being registered with the Public Identity received in the request message, and the IMS Restoration Procedures are supported in the HSS, the Associated-Registered-Identities AVP shall be added to the answer message and it shall contain all Private User Identities being registered with the Public Identity, and subject to the operator policy, the HSS may include all stored S-CSCF Restoration Information groups associated to the Private User Identities in the response. + +NOTE 2: If the HSS returns all the S-CSCF Restoration Information groups in the response, the S-CSCF can ignore the Associated-Registered-Identities AVP and skip additional Server-Assignment-Request since the information is already made available. + +If it is REGISTRATION and the HSS implements IMS Restoration procedures, if multiple registration indication is included in the request and the Public User Identity is stored as registered in the HSS, and there is restoration information related to the Private User Identity, the HSS shall not overwrite the stored S-CSCF Restoration Information, instead, it shall send the stored S-CSCF restoration information together with the user profile in the SAA. Subject to the operator policy, if there is S-CSCF Restoration Information associated with several Private User Identities, the HSS may include all the S-CSCF Restoration Information groups in the response. The Experimental-Result-Code shall be set to DIAMETER\_ERROR\_IN\_ASSIGNMENT\_TYPE. Otherwise, the HSS shall store the received S-CSCF restoration information. The Result-Code shall be set to DIAMETER\_SUCCESS. + +- If it indicates UNREGISTERED\_USER, the following applies. + +If the P-CSCF-Restoration-Indication is included in SAR-Flags AVP, the HSS supporting the P-CSCF-Restoration-mechanism feature shall check whether at least one of the serving node(s) for corresponding user support this feature. If none of the serving nodes support the feature, the HSS shall stop processing this + +request and the Result-Code shall be set to DIAMETER\_ERROR\_SERVING\_NODE\_FEATURE\_UNSUPPORTED. + +The HSS shall check whether the Public Identity is assigned for the S-CSCF requesting the data: + +- If there is already an S-CSCF assigned to the user and the requesting S-CSCF is not the same as the previously assigned S-CSCF, and IMS restoration procedures are not supported or the S-CSCF reassignment pending flag is not set and a P-CSCF-Restoration-Indication is not included in SAR-Flags AVP, the HSS shall include the name of the previously assigned S-CSCF in the response message and the Experimental-Result-Code shall be set to DIAMETER\_ERROR\_IDENTITY\_ALREADY\_REGISTERED. +- If there is already an S-CSCF assigned to the user and the requesting S-CSCF is not the same as the previously assigned S-CSCF and IMS restoration procedures are supported, and the S-CSCF reassignment pending flag is set, the HSS shall overwrite the S-CSCF name and shall reset the S-CSCF reassignment pending flag. +- If there is no S-CSCF assigned to the user or the requesting S-CSCF is the same as the previously assigned S-CSCF stored in the HSS, the HSS shall store the S-CSCF name. + +The HSS shall check the Public Identity registration state: + +- If the registration state of the Public Identity is not registered or unregistered, the HSS shall set or keep the registration state of the Public Identity as unregistered, i.e. registered as a consequence of an originating or terminating request and if a P-CSCF-Restoration-Indication is not included in SAR-Flags AVP download the relevant user information. The Result-Code shall be set to DIAMETER\_SUCCESS. If there are multiple Private User Identities associated to the Public User Identity in the HSS, the HSS shall arbitrarily select one of the Private User Identities and put it into the response message. +- If the registration state of the Public Identity is registered and IMS restoration procedures are not supported, the HSS shall set the registration state of the Public identity as unregistered, clear any S-CSCF Restoration Information associated with the Public User Identity (if any) and if a P-CSCF-Restoration-Indication is not included in SAR-Flags AVP download the relevant user information. The Result-Code shall be set to DIAMETER\_SUCCESS. If there are multiple Private User Identities associated to the Public User Identity in the HSS, the HSS shall arbitrarily select one of the Private User Identities and put it into the response message. + +NOTE 3: The case where S-CSCF Restoration Information is stored in the HSS even though IMS Restoration Procedures are not supported corresponds to the situation where the HSS supports IMS Restoration Procedures but a new assigned S-CSCF does not, while the former S-CSCF supported this feature. + +- If the registration state of the Public Identity is registered and IMS restoration procedures are supported and a P-CSCF-Restoration-Indication is not included in SAR-Flags AVP, the HSS shall include in the response all S-CSCF Restoration Information related with the Public User Identity. If there is S-CSCF Restoration Information associated with several Private User Identities, the HSS shall include all the S-CSCF Restoration Information groups in the response. The Experimental-Result-Code shall be set to DIAMETER\_ERROR\_IN\_ASSIGNMENT\_TYPE. +- If the registration state of the Public Identity is Registered and IMS Restoration Procedures are supported and a P-CSCF-Restoration-Indication is included in SAR-Flags AVP, the HSS shall set the registration state of the Public identity as Unregistered and clear any S-CSCF Restoration Information associated with the Public User Identity (if any). The Result-Code shall be set to DIAMETER\_SUCCESS. + +If there are multiple Private User Identities, which belong to the served IMS subscription the Associated-Identities AVP should be added to the answer message and it shall contain all Private User Identities associated to the IMS subscription. + +If the S-CSCF receives a wildcarded public identity from the I-CSCF, the S-CSCF shall use this wildcarded public identity to fetch the user profile (i.e. by sending a Cx-SAR including Wildcarded-Public-Identity AVP if the profile is not available) and registration information locally stored. + +If the S-CSCF does not receive a wildcarded public identity, the S-CSCF shall not perform wildcarded public identity matching and shall use the public identity received instead to fetch the user profile (i.e. by sending a + +Cx-SAR without including Wildcarded-Public-Identity AVP if the profile is not available) and registration information. + +NOTE 4: There may be SIP requests in which the S-CSCF does not receive information of a wildcarded public identity, e.g. originating call from an AS on behalf of a user. + +NOTE 5: Since a distinct public identity falling into the range of a wildcarded public identity can have a different service profile, the S-CSCF does not perform the wildcarded public identity matching against the public identity received to avoid using the wrong service profile. + +If the Wildcarded-Public-Identity AVP is not received and if the Public Identity falls within the range of a wildcarded public identity whose registration state is registered and a P-CSCF-Restoration-Indication is not included in SAR-Flags AVP, the HSS shall not overwrite the registration state. The Result-Code shall be set to DIAMETER\_ERROR\_IN\_ASSIGNMENT\_TYPE and the HSS shall include the Wildcarded-Public-Identity AVP in the response. Upon reception of this error, the S-CSCF should behave as if it has received a wildcarded public identity in the first place. + +If SAR-Flags AVP includes a P-CSCF-Restoration-Indication, the HSS supporting the P-CSCF-Restoration-mechanism feature shall send a P-CSCF restoration indication to the serving nodes where the IMSI associated to the received Private Identity is registered, i.e. SGSN and/or MME, using S6a/S6d IDR/IDA or Gr ISD request/answer as described in TS 23.380 [19] clause 5.4. The Result-Code shall be set to DIAMETER\_SUCCESS. + +- If it indicates TIMEOUT\_DEREGISTRATION, USER\_DEREGISTRATION, DEREGISTRATION\_TOO\_MUCH\_DATA or ADMINISTRATIVE\_DEREGISTRATION, the following applies. + +If it indicates ADMINISTRATIVE\_DEREGISTRATION and if the P-CSCF-Restoration-Indication is included in SAR-Flags AVP, the HSS supporting the P-CSCF-Restoration-mechanism feature shall check whether at least one of the serving node(s) for corresponding user support this feature. If none of the serving nodes support the feature, the HSS shall stop processing this request and the Result-Code shall be set to DIAMETER\_ERROR\_SERVING\_NODE\_FEATURE\_UNSUPPORTED. + +The HSS shall check the registration state for all the Public Identities in the request. + +- If a Private User Identity is present in the request, if the request did not contain Public Identities the HSS shall check the registration state of the Public Identities associated with the Private Identity identified in the request. For each Public Identity: + - If the registration state of the Public User Identity is Registered, the HSS shall check if the Public User Identity is currently registered with one or more Private User Identities. + - If the Public User Identity is currently registered with only one Private User Identity, the HSS shall set the registration state of the Public User Identity to Not Registered and clear the S-CSCF name and any S-CSCF Restoration Information associated with the Public User Identity. + - If the Public User Identity is currently registered with more than one Private User Identity, the HSS shall keep the registration state of the Public User Identity as Registered and retain the S-CSCF name associated with the Public User Identity. The HSS shall remove any S-CSCF Restoration Information associated to the registration of this Public User Identity with this Private User Identity. + - If a Private User Identity is absent in the request, if the Public User Identity is currently registered with more than one Private User Identity, the HSS shall stop processing this request and shall set the Result-Code to DIAMETER\_MISSING\_AVP. + - if the registration state of the Public Identity is Unregistered, the HSS shall set the registration state of the Public Identity to Not Registered and clear the S-CSCF name associated with the Public Identity. + +In case of ADMINISTRATIVE\_DEREGISTRATION, if SAR-Flags AVP includes a P-CSCF-Restoration-Indication, the HSS or combined HSS-UDM supporting the P-CSCF-Restoration-mechanism feature shall send a P-CSCF restoration indication to the serving nodes where the IMSI associated to the received Private Identity is registered, i.e. SGSN and/or MME, using S6a/S6d IDR/IDA or Gr ISD request/answer as described in TS 23.380 [19] clause 5.4, and SMF and/or AMF, using the Nudm\_UECM\_P-CSCF-RestorationNotification service operation as described in TS 23.380 [19] clause 5.8.4. + +The Result-Code shall be set to DIAMETER\_SUCCESS + +- If it indicates TIMEOUT\_DEREGISTRATION\_STORE\_SERVER\_NAME or USER\_DEREGISTRATION\_STORE\_SERVER\_NAME the HSS decides whether to keep the S-CSCF name associated to the Private User Identity stored or not for all the Public User Identities that the S-CSCF indicated in the request. If no Public User Identity is present in the request, the Private User Identity shall be present. +- If the HSS decides to keep the S-CSCF name stored the HSS shall keep the S-CSCF name stored for all the Public User Identities associated to the Private User Identity. The Result-Code shall be set to DIAMETER\_SUCCESS. + +The HSS shall check if each Public User Identity in the request is currently registered with one or more Private User Identities. If the request did not contain Public User Identities the HSS shall check if each Public User Identity associated with the Private User Identity in the request is currently registered with one or more Private User Identities. For each Public User Identity;- + +- If only one Private User Identity associated with the Public User Identity is currently registered with the Public User Identity, the HSS shall set the registration state of the Public User Identity to Unregistered and clear any S-CSCF Restoration Information associated with the Public User Identity +- If more than one Private User Identity that shares that Public User Identity is currently registered with the Public User Identity the HSS shall keep the registration state of the Public User Identity as Registered. The HSS shall remove any S-CSCF Restoration Information associated to the registration of this Public User Identity with the Private User Identity in the request. +- If the HSS decides not to keep the S-CSCF name the Experimental-Result shall be set to DIAMETER\_SUCCESS\_SERVER\_NAME\_NOT\_STORED. + +The HSS shall check if each Public User Identity in the request is currently registered with one or more Private User Identities. If the request did not contain Public User Identities the HSS shall check if each Public User Identity associated with the Private User Identity in the request is currently registered with one or more Private User Identities. For each Public User Identity;- + +- If only one Private User Identity associated with the Public User Identity is currently registered with the Public User Identity, the HSS shall set the registration state of the Public User Identity to Not Registered and clear the S-CSCF name associated with Public User Identity. +- If more than one Private User Identity that shares that Public User Identity is currently registered with the Public User Identity the HSS shall keep the registration state of the Public User Identity as Registered. +- If it indicates NO\_ASSIGNMENT, the HSS checks whether the Public Identity is assigned for the S-CSCF requesting the data. If the requesting S-CSCF is not the same as the assigned S-CSCF and the S-CSCF reassignment pending flag is not set, the Result-Code shall be set to DIAMETER\_UNABLE\_TO\_COMPLY, otherwise the HSS shall download the relevant user information and the Result-Code shall be set to DIAMETER\_SUCCESS. If relevant S-CSCF Restoration Information is stored in the HSS and IMS Restoration Procedures are supported, it shall be added to the answer message. If there is S-CSCF Restoration Information associated with several Private User Identities, the HSS shall include all the S-CSCF Restoration Information groups in the response. If there are multiple Private User Identities, which belong to the served IMS subscription the Associated-Identities AVP should be added to the answer message and it shall contain all Private User Identities associated to the IMS subscription. + +NOTE 6: the check of the S-CSCF reassignment pending flag is needed since an S-CSCF supporting restoration procedures can receive a user initiated de-registration for a Public Identity for which it does not have any registration data (see TS 23.380 [19]). In such case, the S-CSCF indicates NO\_ASSIGNMENT in Server-Assignment-Type to retrieve any possible restoration information from the HSS. + +- If it indicates AUTHENTICATION\_FAILURE (e.g. there is a mismatch in IP-address secure binding information) or AUTHENTICATION\_TIMEOUT (e.g. no response to Digest challenge), the HSS shall keep the registration state of the Public User Identity. The HSS shall check the registration state for the Public User Identity in the request and only if the registration state of the Public User Identity is Not Registered, the HSS shall clear the S-CSCF name associated with the Public User Identity. + +If the Public User Identity's authentication pending flag which is specific for the Private User Identity is set, the HSS shall clear it. The Result-Code shall be set to DIAMETER\_SUCCESS. + +If the HSS cannot fulfil the received request, e.g. due to database error, it shall set the Result-Code to DIAMETER\_UNABLE\_TO\_COMPLY. The HSS shall not modify any registration state nor download any Public Identity information to the S-CSCF. + +See chapter 8.1.2 and 8.1.3 for the description of the handling of the error situations: reception of an S-CSCF name different from the one stored in the HSS and reception of a Server-Assignment-Type value not compatible with the registration state of the Public Identity. + +### 6.1.3 Network initiated de-registration by the HSS, administrative + +In case of network initiated de-registration of by the HSS, the HSS change the state of the Public Identities to Not Registered and send a notification to the S-CSCF indicating the identities that shall be de-registered. The procedure is invoked by the HSS, corresponds to the functional level operation Cx-Deregister (see TS 23.228 [1]). + +This procedure is mapped to the commands Registration-Termination-Request/Answer in the Diameter application specified in TS 29.229 [5]. Tables 6.1.3.1 and 6.1.3.2 describe the involved information elements. + +**Table 6.1.3.1: Network Initiated Deregistration by HSS request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|---------------------------------------------------------------------|-------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Public User Identity / Public Service Identity (See 7.2 and 7.2a) | Public-Identity | C | It contains the list of Public Identities that are de-registered, in the form of SIP URL or TEL URL.
Public-Identity AVP shall be present if the de-registration reason code is NEW_SERVER_ASSIGNED. It may be present with the other reason codes. | +| Private User Identity / Private Service Identity (See 7.3 and 7.3a) | User-Name | M | It contains the Private Identity in the form of a NAI. The HSS shall always send a Private Identity that is known to the S-CSCF based on an earlier SAR/SAA procedure. | +| Reason for de-registration (See 7.11) | Deregistration-Reason | M | The HSS shall send to the S-CSCF a reason for the de-registration. The de-registration reason is composed of two parts: one textual message (if available) that is intended to be forwarded to the user that is de-registered, and one reason code (see 3GPP TS 29.229 [5]) that determines the behaviour of the S-CSCF | +| Routing Information (See 7.13) | Destination-Host | M | It contains the name of the S-CSCF which originated the last update of the name of the multimedia server stored in the HSS for a given IMS Subscription. The address of the S-CSCF is the same as the Origin-Host AVP in the message sent from the S-CSCF. | +| Associated Private Identities | Associated-Identities | O | This AVP contains Private Identities, which belong to the same IMS subscription as the Private Identity in the User-Name AVP and should be de-registered together with that one.
If the IMS subscription contains only a single Private Identity, this AVP shall not be present. | +| RTR Flags (See 7.30) | RTR-Flags | O | This information element contains a bit mask.
See 7.30 for the meaning of the bits. | + +**Table 6.1.3.2: Network Initiated Deregistration by HSS response** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------------|--------------------------------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result
(See 7.6) | Result-Code /
Experimental-Result | M | This information element indicates the result of de-registration. Result-Code AVP shall be used for errors defined in the Diameter base protocol (see IETF RFC 6733 [31]). Experimental-Result AVP shall be used for Cx/Dx errors. This is a grouped AVP which contains the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | +| Associated Private Identities | Associated-Identities | C | This AVP shall be present if the S-CSCF de-registered more than one Private Identity with the request. It contains all Private Identities that have been deregistered together with the one in the User-Name AVP of the request. | +| Identities with Emergency Registration
(See 7.25) | Identity-with-Emergency-Registration | C | This information element indicates a list of pairs of private and public user identities which have not been de-registered due to emergency registration. | + +#### 6.1.3.1 Detailed behaviour + +The HSS shall de-register the affected identities and invoke this procedure to inform the S-CSCF. The S-CSCF shall remove all the information stored in the S-CSCF for the affected identities. + +The HSS may de-register: + +- One Public Identity or a list of Public Identities. HSS may include all Public User Identities associated with the User-Name AVP to the request. This option is applicable with all reason codes. +- One or more Private Identities of the IMS Subscription with all associated Public Identities. No Public-Identity AVPs shall be present in this case. This option is applicable with reason codes PERMANENT\_TERMINATION, SERVER\_CHANGE, and REMOVE\_S-CSCF. +- All Public Service Identities that match a Wildcarded Public Service Identity. In this case the HSS may send one of the Public Service Identities that was received in the Server Assignment Request for that Wildcarded Public Service Identity and the associated Private Service Identity. +- A Wildcarded Public User Identity. In this case the HSS shall send a distinct Public User Identity that belongs to the same implicit registration set as the Wildcarded Public User Identity and the associated Private User Identity. + +The HSS shall send in the Deregistration-Reason AVP the reason for the de-registration, composed by a textual message (if available) aimed for the user and a reason code that determines the action the S-CSCF has to perform. The possible reason codes are: + +- PERMANENT\_TERMINATION: The HSS indicates to the S-CSCF that the S-CSCF will no longer be assigned to the Public Identity and associated implicitly registered/unregistered Public Identities (if any) for the Private Identity(ies) indicated in the request (e.g. due to an IMS subscription cancellation, or modification, or a removal of IP-address secure binding information when GIBA is used). This reason also indicates that no other S-CSCF can be assigned. + +The HSS shall check the registration state of the Public Identities. If no Public Identities are involved, the HSS shall check the registration state of the Public Identities associated with the Private User Identity identified. For each Public Identity: + +- If the registration state of the Public Identity is Registered, the HSS shall check if the Public User Identity is currently registered with one or more Private User Identities. + - If the Public User Identity is currently registered with only one Private User Identity, the HSS shall check whether the Public User Identity is included in the information element Identities with Emergency Registrations returned by S-CSCF in the response. + - If included, the HSS shall keep the S-CSCF name associated with the Public User Identity and set the registration state of the Public User Identity to Unregistered. + +- If not included, the HSS shall clear the S-CSCF name associated with the Public User Identity, and set the registration state of the Public User Identity to Not Registered. The S-CSCF initiates the de-registration of the Public User Identity unless it is emergency registered. +- If the Public User Identity is currently registered with more than one Private User Identity, the HSS shall keep the registration state of the Public User Identity as Registered and retain the S-CSCF name associated with the Public User Identity. The S-CSCF initiates the de-registration of the Public User Identity unless it is emergency registered. +- If the registration state of the Public Identity is Unregistered, the HSS shall check whether this Public User Identity is included in the information element Identities with Emergency Registrations returned by S-CSCF in the response. + - If included, the HSS shall keep the S-CSCF name associated with the Public User Identity. + - If not included, the HSS shall set the registration state of the Public Identity to Not Registered and clear the S-CSCF name associated with the Public Identity. +- NEW\_SERVER\_ASSIGNED: The HSS indicates to the S-CSCF that a new S-CSCF has been allocated to the IMS Subscription e.g. because the previous assigned S-CSCF was unavailable during a registration procedure. The S-CSCF shall remove all information for all of the Public Identities indicated in the request. +- SERVER\_CHANGE: The HSS indicates to the S-CSCF that the de-registration is requested to force the selection of new S-CSCF to assign to the IMS Subscription (e.g. when the S-CSCF capabilities are changed in the HSS or when the S-CSCF indicates that it has not enough memory for the updated User Profile). The HSS shall set the registration state to "Not Registered" and clear the S-CSCF name for all of the Public Identities affected by the request. If the S-CSCF does not indicate in the response all the Private Identities that were in the request, the HSS shall repeat this request for each of the remaining Private Identities in the IMS Subscription that are known to the S-CSCF. The S-CSCF should start the network initiated de-registration towards the user, i.e. all registrations within the IMS Subscription are de-registered and the user is asked to re-register to all existing registrations. +- REMOVE\_S-CSCF: The HSS indicates to the S-CSCF that the S-CSCF will no longer be assigned to an unregistered Public Identity(ies) (i.e. registered as a consequence of an originating or terminating request or there is a S-CSCF keeping the user profile stored) for a given IMS Subscription. + +The HSS shall check if an emergency registration exists in the S-CSCF, checking for each Public Identity contained in the request whether it is present in the information element Identities with Emergency Registrations returned by S-CSCF. + +- If an emergency registration does not exist in S-CSCF, for each Public Identity contained within the request, the HSS shall set the registration state of the Public Identity to Not Registered and clear the S-CSCF name associated with the Public Identity. The S-CSCF shall remove all information related to the Public User Identity contained within the request. +- If an emergency registration exists in S-CSCF for one or more Public User Identities contained in the request, the S-CSCF should include the corresponding Private Identity / Public User Identity pairs in the information element Identities with Emergency Registrations in the answer. The HSS, when receiving such an answer, shall not change the registration state of the Public User Identities present in the information element Identities with Emergency Registrations and shall keep unchanged the S-CSCF name associated with these Public User Identities. + +Public Identities which are emergency registered in the S-CSCF shall not be de-registered when a Cx-Deregistration request with a -reason code of PERMANENT\_TERMINATION or REMOVE\_S-CSCF is received from the HSS. In this case + +- if all to be de-registered identities are emergency registered, a Result-Code set to DIAMETER\_UNABLE\_TO\_COMPLY and a list of Private / Public Identity pairs which are emergency registered shall be returned to the HSS +- if a proper subset of the to be de-registered identities are emergency registered, a Result-Code of DIAMETER\_LIMITED\_SUCCESS and a list of Private Identity / Public Identity pairs which are emergency registered shall be returned to the HSS. + +NOTE 1: If the Public Identity that is emergency registered has normal registration as well, then for the normal registration the S-CSCF will perform the detailed de-registration procedures towards the UE for each reason code as described in TS 24.229 [8]. + +NOTE 2: It is assumed that Public Identities which are implicitly registered along with an emergency registration are also emergency registered. + +The detailed de-registration procedures performed by the S-CSCF are described in TS 24.229 [8]. + +### 6.1.4 User location query + +This procedure is used between the I-CSCF and the HSS to obtain the name of the S-CSCF assigned to a Public Identity, or the name of the AS hosting a PSI for direct routing. The procedure is invoked by the I-CSCF, is performed per Public Identity, and corresponds to the functional level operation Cx-Location-Query (see TS 23.228 [1]). + +This procedure is mapped to the commands Location Info Request/Answer in the Diameter application specified in TS 29.229 [5]. Tables 6.1.4.1 and 6.1.4.2 detail the involved information elements. + +**Table 6.1.4.1: User Location query** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|-------------------------------------------------------------------|-------------------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Public User Identity / Public Service Identity (See 7.2 and 7.2a) | Public-Identity | M | Public Identity | +| Routing information (See 7.13) | Destination-Host, Destination-Realm | C | If the I-CSCF knows HSS name Destination-Host AVP shall be present in the command. Otherwise, only Destination-Realm AVP shall be present and the command shall be routed to the next Diameter node, e.g. SLF, based on the Diameter routing table in the I-CSCF. | +| Originating Request (See 7.18) | Originating-Request | O | It indicates that the request is related to an originating SIP message. | +| Type of Authorization (See 7.14) | User-Authorization-Type | C | This information element shall be present and set to REGISTRATION_AND_CAPABILITIES by the I-CSCF if IMS Restoration Procedures are supported and the S-CSCF currently assigned to the Public User Identity in the HSS cannot be contacted. | +| Session Priority (See 7.24) | Session-Priority | O | This information element, if present, shall indicate the session's priority to the HSS. | + +**Table 6.1.4.2: User Location response** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|---------------------------------------------|--------------------------------------|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result
(See 7.6) | Result-Code /
Experimental-Result | M | Result of the operation.
Result-Code AVP shall be used for errors defined in the Diameter base protocol (see IETF RFC 6733 [31]).
Experimental-Result AVP shall be used for Cx/Dx errors. This is a grouped AVP which contains the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | +| S-CSCF Name / AS name
(See 7.4 and 7.4a) | Server-Name | C | Name of the assigned S-CSCF for basic IMS routing or the name of the AS for direct routing. | +| S-CSCF capabilities
(See 7.5) | Server-Capabilities | O | It contains the information to help the I-CSCF in the selection of the S-CSCF. | +| Wildcarded Public Identity
(See 7.2b) | Wildcarded-Public-Identity | O | If the requests refers to a Wildcarded PSI or Wildcarded Public User Identity (the Public Identity in the request matches a Wildcarded PSI or Wildcarded Public User Identity in the HSS), the HSS shall include the corresponding Wildcarded Public Identity in this information element.

The matching of distinct Public Identities takes precedence over the matching of wildcarded public identities. | +| LIA Flags
(See 7.27) | LIA-Flags | O | This information element contains a bit mask.
See 7.27 for the meaning of the bits. | + +#### 6.1.4.1 Detailed behaviour + +The HSS may prioritise the received request message according to priority level received within the Session-Priority AVP. + +NOTE 1: Refer to Annex J for HSS procedures associated with the handling of both the Session-Priority AVP and DRMP AVP received in the request message. + +The HSS shall, in the following order (if an error occurs in any of the steps the HSS shall stop processing and return the corresponding error code, see TS 29.229 [5]): + +The HSS shall, in the following order (if an error occurs in any of the steps the HSS shall stop processing and return the corresponding error code, see TS 29.229 [5]): + +1. Check that the Public Identity is known. If not the Experimental-Result-Code shall be set to DIAMETER\_ERROR\_USER\_UNKNOWN. +2. Check the type of the Public Identity contained in the request: + - If this is a Public User Identity, continue to step 2a. + - If this is a Public Service Identity: + - Check if the PSI Activation State for that identity is active. If not, then the response shall contain Experimental-Result-Code set to DIAMETER\_ERROR\_USER\_UNKNOWN. + - Check if the name of the AS hosting the Public Service Identity is stored in the HSS and that the request does not contain the Originating-Request AVP. + - If this is the case, if IMS Restoration Procedures are supported, the HSS shall check if User-Authorization-Type was received in the request, and if the value is REGISTRATION\_AND\_CAPABILITIES: + - If it is, the HSS shall reject the request with Result-Code set to DIAMETER\_UNABLE\_TO\_COMPLY. + - Otherwise, the HSS shall return the AS name and the Result-Code AVP shall be set to DIAMETER\_SUCCESS. HSS may set PSI Direct Routing Indication bit in LIA-Flags AVP, then I-CSCF shall not perform IMS Restoration Procedures (see chapter 4.3.3 in TS 23.380 [19]). + +- Otherwise, continue to step 2a. +- 2a. If IMS Restoration procedures are supported, the HSS shall check if User-Authorization-Type was received in the request, and if the value is REGISTRATION\_AND\_CAPABILITIES: +- If it is, then the HSS may return the Server-Capabilities AVP. The returned capabilities, if any, shall satisfy all the requirements of all the service profiles associated with the IMS Subscription. If Server-Capabilities AVP is absent, it indicates to the I-CSCF that it can select any available S-CSCF. Also the HSS shall set the S-CSCF reassignment pending flag and allow overwriting of the S-CSCF name in the next SAR request, which enables the I-CSCF to select an S-CSCF. The Result-Code shall be set to DIAMETER\_SUCCESS. The HSS shall not return any S-CSCF name. Stop processing. + - Otherwise, continue to step 3. +3. Check the state of the Public Identity received in the request, and where necessary, check if the Public Identity has terminating services related to the unregistered state. +- If it is registered, the HSS shall return the stored S-CSCF name. The Server-Name AVP shall contain the SIP URI of the server. The Server-Capabilities AVP shall not be present. The Result-Code AVP shall be set to DIAMETER\_SUCCESS. + - If it is unregistered (i.e. registered as a consequence of an originating or terminating request or there is a S-CSCF keeping the user profile stored) the HSS shall return the S-CSCF name assigned for that Public Identity. The Server-Name AVP shall contain the SIP URI of the server. The Server-Capabilities AVP shall not be present. The Result-Code shall be set to DIAMETER\_SUCCESS. + - If it is not registered, but either it has terminating services related to unregistered state or the request contains the Originating-Request AVP, the HSS shall check if there is at least one Public Identity within the IMS Subscription with an S-CSCF name assigned: + - If this is the case the HSS shall return the S-CSCF name assigned for that Public Identity. The Server-Name AVP shall contain the SIP URI of the server. The Server-Capabilities AVP shall not be present. The Result-Code shall be set to DIAMETER\_SUCCESS. + - If there is not any S-CSCF name assigned to a Public Identity within the IMS Subscription, the HSS may return information about the required S-CSCF capabilities, which enables the I-CSCF to select an S-CSCF. The Server-Capabilities AVP may be present. The HSS shall send the same server capability set that is sent in the user registration status response during the registration. If Server-Capabilities AVP is not present, the I-CSCF shall understand that any S-CSCF is suitable for the IMS Subscription. The Server-Name AVP shall not be present. The Experimental-Result-Code shall be set to DIAMETER\_UNREGISTERED\_SERVICE. + - If it is not registered or unregistered, and the Public Identity has no terminating services related to the unregistered state and the request does not contain the Originating-Request AVP, the response shall contain Experimental-Result-Code set to DIAMETER\_ERROR\_IDENTITY\_NOT\_REGISTERED. + +If the HSS cannot fulfil the received request, e.g. due to database error, it shall set Result-Code to DIAMETER\_UNABLE\_TO\_COMPLY. No S-CSCF name or S-CSCF capabilities shall be present in the response. + +## 6.2 User data handling procedures + +### 6.2.1 User Profile download + +As part of the registration procedure ( TS 23.228 [1]) S-CSCF obtains user data and service related information by means of the Cx-Put Resp operation (see 6.1.2). + +### 6.2.2 HSS initiated update of User Information + +This procedure is initiated by the HSS to update at least one of the following user information in S-CSCF: + +- User profile information and/or + +- Charging information and/or +- Allowed WAF and/or WWSF Identities and/or +- SIP Digest authentication information in the S-CSCF. + +This procedure shall not be used by the HSS to add, delete, or update the value of the IMSI. + +This procedure corresponds to the functional level operation Cx-Update\_Subscr\_Data (see TS 23.228 [1]). + +This procedure is mapped to the commands Push-Profile-Request/Answer in the Diameter application specified in TS 29.229 [5]. Tables 6.2.2.1 and 6.2.2.2 describe the involved information elements. + +**Table 6.2.2.1: User Profile Update request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|---------------------------------------------------------------------|-----------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Private User Identity / Private Service Identity (See 7.3 and 7.3a) | User-Name | M | Private Identity.
The HSS shall always send a Private Identity that is known to the S-CSCF based on an earlier SAR/SAA procedure. | +| User profile (See 7.7) | User-Data | C | Updated user profile (see clauses 6.5.2.1 and 6.6.1), with the format defined in chapter 7.7.
It shall be present if the user profile is changed in the HSS. If the User-Data AVP is not present, the SIP-Auth-Data-Item or Charging-Information AVP or Allowed-WAF-WWSF-Identities AVP shall be present. | +| Authentication Data (See 7.9) | SIP-Auth-Data-Item | C | SIP Digest authentication information.
It shall be present if the used authentication scheme is SIP Digest and when password change has occurred in the HSS.
If the SIP-Auth-Data-Item AVP is not present, the Charging-Information or User-Data AVP or Allowed-WAF-WWSF-Identities AVP shall be present.
See Table 6.3.6 for the contents of this information element. | +| Charging Information (See 7.12) | Charging-Information | C | Addresses of the charging functions.
It shall be present if the charging addresses are changed in the HSS. If the Charging-Information AVP is not present, the SIP-Auth-Data-Item or User-Data AVP or Allowed-WAF-WWSF-Identities AVP shall be present.
When this parameter is included, either the Primary-Charging-Collection-Function-Name AVP or the Primary-Event-Charging-Function-Name AVP shall be included. All other charging information shall be included if it is available. | +| Routing Information (See 7.13) | Destination-Host | M | It contains the name of the S-CSCF which originated the last update of the name of the multimedia server stored in the HSS for a given IMS Subscription. The address of the S-CSCF is the same as the Origin-Host AVP in the message sent from the S-CSCF. | +| Allowed WAF and/or WWSF Identities (See 7.29) | Allowed-WAF-WWSF-Identities | C | Addresses of the WAFs and/or WWSFs the subscription is allowing to use.
It shall be present if the allowed WAF and/or WWSF identities are changed in the HSS. | + +**Table 6.2.2.2: User Profile Update response** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-----------------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result (See 7.6) | Result-Code / Experimental-Result | M | This information element indicates the result of the update of User Profile in the S-CSCF.
Result-Code AVP shall be used for errors defined in the Diameter base protocol (see IETF RFC 6733 [31]).
Experimental-Result AVP shall be used for Cx/Dx errors. This is a grouped AVP which contains the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | + +#### 6.2.2.1 Detailed behaviour + +The HSS shall make use of this procedure to update the relevant user information to the S-CSCF. See chapters 6.5.2.1 and 6.6.1 for the rules of user profile updating. See chapter 6.5.2.3 for the rules of Charging Information update. See chapter 6.5.2.4 for the rules of SIP Digest Authentication Data update. See chapter 6.5.2.5 for the rules of Allowed WAF and/or WWSF Identities update. + +If there are multiple registered Private User Identities associated to the Public User Identity in the HSS, the HSS shall send only single request and select arbitrarily one of the Private User Identities and put it into the request. For updates of the profile of a Wildcarded Public Identity, the HSS shall send only one single request. That request shall contain the Wildcarded Public Identity. + +The SIP-Auth-Data-Item AVP and/or Charging-Information AVP and/or the User-Data AVP shall be present in the request. + +If the User-Data AVP is present in the request, the S-CSCF shall overwrite, for the Public Identities indicated in the User profile included in the request, current information with the information received from the HSS, except in the error situations detailed in table 6.2.2.1.1. + +If the Charging-Information AVP is present in the request, the S-CSCF shall replace the existing charging information with the information received from the HSS. + +The SIP-Auth-Data-Item AVP shall be present if the command is sent in order to update SIP Digest authentication information due to a password change. + +If the S-CSCF receives data that it can not recognise, unsupported user data in a part of the request where it may not be ignored or more data than it can accept, it shall return the corresponding error code to the HSS as indicated in table 6.2.2.1.1. The S-CSCF shall not overwrite the data that it already has to give service to the IMS Subscription. The HSS shall initiate a network-initiated de-registration procedure towards the S-CSCF with Deregistration-Reason set to SERVER\_CHANGE, which will trigger the assignment of a new S-CSCF. + +If the HSS receives DIAMETER\_ERROR\_USER\_UNKNOWN from the S-CSCF in the Push-Profile-Answer, then the HSS shall re-send the request using another arbitrarily selected registered Private Identity (if any). If restoration procedures are not supported, the HSS shall set the unknown Private User Identity's registration status to "not registered"; this will allow the synchronization of the registration status in HSS and S-CSCF. + +NOTE: If restoration procedures are supported, restoration procedures will ensure synchronization of the registration status in HSS and S-CSCF, i.e. the S-CSCF can either immediately retrieve the S-CSCF restoration information for the registered Public User Identity (sending SAR with Server Assignment Type set to NO\_ASSIGNMENT), or wait for reception of a SIP request. + +Table 6.2.2.1.1 details the valid result codes that the S-CSCF can return in the response. + +**Table 6.2.2.1.1: User information update response valid result codes** + +| Result-Code AVP value | Condition | +|----------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| DIAMETER_SUCCESS | The request succeeded. | +| DIAMETER_ERROR_NOT_SUPPORTED_USER_DATA | The request failed. The S-CSCF informs the HSS that the received user information contained information, which was not recognised or supported by the S-CSCF due to unsupported S-CSCF capabilities. | +| DIAMETER_ERROR_USER_UNKNOWN | The request failed because the Private Identity is not found in S-CSCF. | +| DIAMETER_ERROR_TOO_MUCH_DATA | The request failed. The S-CSCF informs to the HSS that it tried to push too much data into the S-CSCF. | +| DIAMETER_UNABLE_TO_COMPLY | The request failed. | + +## 6.3 Authentication procedures + +This procedure is used between the S-CSCF and the HSS to exchange information to support the authentication between the end user and the home IMS network. The procedure is invoked by the S-CSCF, corresponds to the combination of the operations Cx-AV-Req and Cx-AV-Req-Resp (see TS 33.203 [3]) and is used: + +- To retrieve authentication vectors from the HSS. +- To resolve synchronization failures between the sequence numbers in the UE and the HSS for authentication schemes that support this capability (e.g. IMS-AKA). +- To promote the result of the NASS-level authentication to the IMS level. +- To retrieve the IP-address secure binding information for GPRS-IMS-Bundled Authentication (GIBA) from the HSS. + +This procedure is mapped to the commands Multimedia-Auth-Request/Answer in the Diameter application specified in TS 29.229 [5]. Tables 6.3.1 through 6.3.7 detail the involved information elements. + +**Table 6.3.1: Authentication Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|----------------------------------------|-------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Public User Identity (See 7.2) | Public-Identity | M | This information element contains the Distinct Public User Identity of the user | +| Private User Identity (See 7.3) | User-Name | M | This information element contains the Private User Identity | +| Number Authentication Items (See 7.10) | SIP-Number-Auth-Items | M | This information element indicates the number of authentication vectors requested. Certain authentication schemes do not support more than one set of authentication vectors (e.g. SIP Digest, GIBA). | +| Authentication Data (See 7.9) | SIP-Auth-Data-Item | M | See Table 6.3.2 for the contents of this information element. | +| S-CSCF Name (See 7.4) | Server-Name | M | This information element contains the name (SIP URL) of the S-CSCF. | +| Routing Information (See 7.13) | Destination-Host | C | If the S-CSCF knows the HSS name this AVP shall be present. This information is available if the MAR belongs to an already existing registration, e.g. in case of the re-registration, where the HSS name is stored in the S-CSCF. The HSS name is obtained from the Origin-Host AVP, which is received from the HSS, e.g. included in the MAA command. This information may not be available if the command is sent in case of the initial registration. In this case the Destination-Host AVP is not present and the command is routed to the next Diameter node, e.g. SLF, based on the Diameter routing table in the client. | + +**Table 6.3.2: Authentication Data content in Authentication Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|---------------------------------------|----------------------------|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Authentication Scheme (See 7.9.2) | SIP-Authentication-Scheme | M | This information element indicates the authentication scheme. See 3GPP TS 29.229 [5] for a list of values | +| Authentication Context (See 7.9.7) | SIP-Authentication-Context | C | This information element shall contain authentication-related information relevant for performing the authentication. It shall be absent for IMS-AKA authentication schemes. | +| Authorization Information (See 7.9.4) | SIP-Authorization | C | This information element shall only be present for a request due to an IMS-AKA synchronization failure. If present, only IMS-AKA authentication schemes are allowed. | + +Table 6.3.3: Void + +Table 6.3.4: Authentication Request Response + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|----------------------------------------|-----------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| User Identity (See 7.2) | Public-Identity | C | Public User Identity. It shall be present when the result is DIAMETER_SUCCESS. | +| Private User Identity (See 7.3) | User-Name | C | Private User Identity. It shall be present when the result is DIAMETER_SUCCESS. | +| Number Authentication Items (See 7.10) | SIP-Number-Auth-Items | C | This information element indicates the number of authentication vectors delivered in the Authentication Data information element. It shall be present when the result is DIAMETER_SUCCESS. For SIP Digest, NASS Bundled authentication and GIBA this AVP shall be set to a value of 1. | +| Authentication Data (See 7.9) | SIP-Auth-Data-Item | C | If the SIP-Number-Auth-Items AVP is equal to zero or it is not present, then this information element shall not be present. See Table 6.3.5 for the contents of this information element. | +| Result (See 7.6) | Result-Code / Experimental-Result | M | This information element indicates the result of the operation. It shall be mapped to Result-Code AVP for errors defined in the Diameter base protocol (see IETF RFC 6733 [31]). It shall be mapped to Experimental-Result AVP for Cx/Dx errors. This information element is mapped to a grouped AVP which contains the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | + +**Table 6.3.5: Authentication Data information element content in Authentication Request Response** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|-------------------------------------------|---------------------------|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Item Number
(See 7.9.1) | SIP-Item-Number | C | This information element shall only be present for IMS-AKA authentication schemes.
This information element shall be present when there are multiple occurrences of the Authentication Data information element in the Authentication Request Response, and the order in which they should be processed is significant.
In this scenario, Authentication Data information elements with a low Item Number information element value should be processed before Authentication Data information elements with a high Item Number information element value. | +| Authentication Scheme
(See 7.9.2) | SIP-Authentication-Scheme | M | This information element indicates the authentication scheme. | +| Authentication Information
(See 7.9.3) | SIP-Authenticate | C | This information element shall only be present for IMS-AKA authentication schemes. | +| Authorization Information
(See 7.9.4) | SIP-Authorization | C | This information element shall only be present for IMS-AKA authentication schemes. | +| Confidentiality Key
(See 7.9.5) | Confidentiality-Key | C | This information element shall be present for IMS AKA authentication schemes.
It shall contain the confidentiality key. | +| Integrity Key
(See 7.9.6) | Integrity-Key | C | This information element shall only be present for IMS-AKA authentication schemes.
This information element shall contain the integrity key. | +| Digest Authenticate
(See 7.9.8) | SIP-Digest-Authenticate | C | This information element shall only be present for SIP Digest authentication scheme.
See Table 6.3.7 for contents of this grouped AVP. | +| Line Identifier
(See 7.9.9) | Line-Identifier | C | This information element shall only be present for NASS Bundled authentication scheme.
This information element contains fixed broadband access line identifier associated to the user. This information element can be repeated. | +| Framed IP Address
(See 7.9.10) | Framed-IP-Address | C | This information element shall only be present for GPRS-IMS-Bundled authentication scheme.
If the IP Address of the User is an IPv4 address, this AVP shall be included. | +| Framed IPv6 Prefix
(See 7.9.11) | Framed-IPv6-Prefix | C | This information element shall only be present for GPRS-IMS-Bundled authentication scheme.
If the IP Address of the User is an IPv6 address, this AVP shall be included. | +| Framed Interface Id
(See 7.9.12) | Framed-Interface-Id | C | This information element shall only be present for GPRS-IMS-Bundled authentication scheme.
If and only if the IP Address of the User is an IPv6 address and the Framed-IPv6-Prefix AVP alone is not unique for the user this AVP shall be included. | + +**Table 6.3.6: Void** + +**Table 6.3.7: Digest Authenticate information element content – Response for SIP Digest** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------------|-------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Digest Realm (See 7.9.8.1) | Digest-Realm | M | This information element corresponds to the Realm parameter as defined in IETF RFC 2617 [16]. | +| Digest Algorithm (See 7.9.8.3) | Digest-Algorithm | O | This information element contains the algorithm as defined in IETF RFC 2617 [16].
If this information element is not present, then "MD5" is assumed.
If this information element is present it shall contain "MD5". | +| Digest QoP (See 7.9.8.4) | Digest-QoP | M | This information element contains the QoP as defined in IETF RFC 2617 [16]. This information element shall be set to a value of "auth" by the HSS. | +| Digest HA1 (See 7.9.8.5) | Digest-HA1 | M | This information element contains the H(A1) as defined in IETF RFC 2617 [16]. | + +**Table 6.3.8: Void****Table 6.3.9: Void** + +### 6.3.1 Detailed behaviour + +The HSS shall, in the following order (in case of an error in any of the steps the HSS shall stop processing and return the corresponding error code, see TS 29.229 [5]): + +1. Check that the Private User Identity and the Public User Identity exist in the HSS. If not Experimental-Result-Code shall be set to DIAMETER\_ERROR\_USER\_UNKNOWN. +2. Check that the Public User Identity matches a distinct Public User Identity in the HSS. If it doesn't, the Experimental-Result-Code shall be set to DIAMETER\_ERROR\_USER\_UNKNOWN. +3. Check whether the Private and Public User Identities in the request are associated in the HSS. If not Experimental-Result-Code shall be set to DIAMETER\_ERROR\_IDENTITIES\_DONT\_MATCH. +4. Check the authentication scheme indicated in the request, and + - if it is "Unknown", check the authentication scheme stored in HSS. If it is neither NASS-Bundled authentication nor SIP Digest authentication, Experimental-Result-Code shall be set to DIAMETER\_ERROR\_AUTH\_SCHEME\_NOT\_SUPPORTED. + - if not, check that the authentication scheme indicated in the request is supported. If not Experimental-Result-Code shall be set to DIAMETER\_ERROR\_AUTH\_SCHEME\_NOT\_SUPPORTED. + +This step is only applicable for IMS-AKA authentication. If the request indicates there is a synchronization failure, the HSS shall compare the S-CSCF name received in the request to the S-CSCF name stored in the HSS: + +- If they are identical the HSS shall process AUTS as described in TS 33.203 [3] and return the requested authentication information. The Result-Code shall be set to DIAMETER\_SUCCESS. +5. Check the registration status of the Public User Identity received in the request: + - If it is registered, the HSS shall compare the S-CSCF name received in the request to the S-CSCF name stored in the HSS: + - If they are different, the HSS shall overwrite the S-CSCF name. If IMS restoration procedures are supported and the S-CSCF reassignment pending flag is set, the HSS shall reset the flag and keep the S-CSCF restoration information associated with the Public User Identity. The HSS shall download SIP-Auth-Data-Item stored up to a maximum specified in SIP-Number-Auth-Items received in the command Multimedia-Auth-Request. If authentication scheme is neither NASS-Bundled nor GIBA, the HSS shall set the Public User Identity's authentication pending flag which is specific to the Private User Identity received in the request. The Result-Code shall be set to DIAMETER\_SUCCESS. + +- If they are identical, the HSS shall download SIP-Auth-Data-Item stored up to a maximum specified in SIP-Number-Auth-Items received in the command Multimedia-Auth-Request. The Result-Code shall be set to DIAMETER\_SUCCESS. +- If it is unregistered (i.e. registered as a consequence of an originating or terminating request or there is an S-CSCF keeping the user profile stored) or not registered, the HSS shall compare the S-CSCF name received in the request to the S-CSCF name stored in the HSS: + - If they are different or if there is no S-CSCF name stored in the HSS for any Public User Identity of the IMS subscription, the HSS shall store the S-CSCF name. The HSS shall download SIP-Auth-Data-Item stored up to a maximum specified in SIP-Number-Auth-Items received in the command Multimedia-Auth-Request. If authentication scheme is neither NASS-Bundled nor GIBA, the HSS shall set the Public User Identity's authentication pending flag which is specific to the Private User Identity which was received in the request. The Result-Code shall be set to DIAMETER\_SUCCESS. + - If they are identical, the HSS shall download SIP-Auth-Data-Item stored up to a maximum specified in SIP-Number-Auth-Items received in the command Multimedia-Auth-Request. If authentication scheme is neither NASS-Bundled nor GIBA, the HSS shall set the Public User Identity's authentication pending flag which is specific to the Private User Identity that was received in the request. The Result-Code shall be set to DIAMETER\_SUCCESS. + +Exceptions to the cases specified here shall be treated by HSS as error situations, the Result-Code shall be set to DIAMETER\_UNABLE\_TO\_COMPLY. No authentication information shall be returned. + +## 6.4 User identity to HSS resolution + +The User identity to HSS resolution mechanism enables the I-CSCF and the S-CSCF to find the identity of the HSS, that holds the subscriber data for a given Public Identity when multiple and separately addressable HSSs have been deployed by the network operator. The resolution mechanism is not required in networks that utilise a single HSS. An example for a single HSS solution is server farm architecture. + +The resolution mechanism described in TS 23.228 [1] shall use a Subscription Locator Function (SLF) or a Diameter Proxy Agent. + +The I-CSCF and the S-CSCF accesses the SLF via the Dx interface. The Dx interface shall always be used in conjunction with the Cx interface. The Dx interface shall be based on the Diameter base protocol as specified in IETF RFC 6733 [31]. The SLF functionality shall use the routing mechanism provided by an enhanced Diameter redirect agent. + +The SLF or the Diameter Proxy Agent shall be able to determine the HSS identity. + +To get the HSS identity the I-CSCF and the S-CSCF shall send the Cx request normally destined to the HSS to a pre-configured Diameter address/name. + +- If this Cx Request is received by an SLF (acting as a Diameter redirect agent), the SLF shall determine the HSS identity and sends to the I-CSCF or S-CSCF a notification of redirection towards the HSS identity, in response to the Cx request. Multiple HSS identities may be included in the response, as specified in IETF RFC 6733 [31]. In such a case, the I-CSCF or the S-CSCF shall send the Cx Request to the first HSS identity in the ordered list received in the Cx Response from the SLF. If the I-CSCF or S-CSCF does not receive a successful response to the Cx Request, the I-CSCF or S-CSCF shall send a Cx Request to the next HSS identity in the ordered list. This procedure shall be repeated until a successful response from an HSS is received. +- If this Cx Request is received by the Diameter Proxy Agent, the Diameter Proxy Agent shall determine the HSS identity based on the provided user identity and - if the Diameter load control mechanism is supported (see IETF RFC 8583 [29]) - optionally also based on previously received load values from Load AVPs of type HOST. The Diameter Proxy Agent shall then forward the Cx request directly to the determined HSS. The I-CSCF and S-CSCF shall determine the HSS identity from the response to the Cx request received from the HSS. + +While the I-CSCF is stateless, the S-CSCF shall store the HSS identity/name/Realm, as specified in TS 23.228 [1] and shall use it in further Cx requests associated to the same IMS Public Identity. + +In networks where the use of the user identity to HSS resolution mechanism is required, each I-CSCF and S-CSCF shall be configured with the address/name of the SLF or the Diameter Proxy Agent to enable use of these resolution mechanisms. + +## 6.5 Implicit registration + +Implicit registration is the mechanism by which a user is allowed to register simultaneously more than one of his/her Public User Identities. The HSS knows the identities that are to be implicitly registered when it receives the indication of the registration of an individual identity. + +What follows is an extension of the affected basic procedures. + +### 6.5.1 S-CSCF initiated procedures + +The result of the S-CSCF initiated procedures affects all the Public User Identities that are configured in the HSS to be in the same implicitly registered Public User Identity set with the targeted individual Public User Identity. Where the S-CSCF initiated procedure affects the Registration state of the targeted Public User Identity, the Registration states of the Public User Identities in the associated implicitly registered Public User Identity set are affected in the same way. + +#### 6.5.1.1 Registration + +The notification of a registration of a Public User Identity implies the registration of the corresponding implicitly registered Public User Identity set. The user information downloaded in the response contains the Public User Identities of the implicitly registered Public User Identity set with the associated service profiles. This allows the S-CSCF to know which Public User Identities belong to the implicitly registered Public User Identity set. The S-CSCF shall take from the set of implicitly registered Public User Identities the first identity which is not barred, and use this as the default Public User Identity. The default Public User Identity shall be a distinct Public User Identity. + +#### 6.5.1.2 De-registration + +The de-registration of a Public User Identity implies the de-registration of the corresponding implicitly registered Public User Identity set, both in the HSS and in the S-CSCF. The S-CSCF shall include in the request a single Public User Identity to deregister all the Public User Identities that belong to the corresponding implicitly registered Public User Identity set. + +The de-registration of a Private User Identity implies the de-registration of all the corresponding Public User Identities, both in the HSS and in the S-CSCF. + +#### 6.5.1.3 Authentication + +Setting the authentication pending flag for a Public User Identity implies setting the authentication pending flag for each corresponding implicitly registered Public User Identity in the HSS. + +#### 6.5.1.4 Downloading the user profile + +If the S-CSCF requests to download a user profile from HSS, the user profile in the response shall contain the Public User Identities of the corresponding implicitly registered Public User Identity set with the associated service profiles. + +#### 6.5.1.5 Initiation of a session to a non-registered user + +The change of a Public User Identity to the Unregistered state due to the initiation of a session from/to a Public Identity that was in Not Registered state and the opposite change from Unregistered state to Not Registered state implies the same change for all the Public User Identities in the same Implicit Registration Set. + +### 6.5.2 HSS initiated procedures + +#### 6.5.2.1 Update of User Profile + +A request sent by the HSS to update the user profile shall include only the Public User Identities of the implicitly registered Public User Identity set, with the associated service profiles (even if not updated). If other Public User Identities not associated with the implicitly registered Public User Identity set are affected, they shall be downloaded in separate commands. + +This procedure shall be used by the HSS to add a newly provisioned or Not Registered Public User Identity or Identities to an existing implicitly registered Public User Identity set that is in the state Registered or Unregistered. The added Public User Identity gets the registration state of the set it is added to. + +The HSS shall use this procedure if a Public User Identity or Identities are removed from the implicitly registered Public User Identity set that is in a state Registered or Unregistered. In practise, this is done by sending a PPR for the set without the removed identities. The S-CSCF shall remove all information stored in the S-CSCF for the removed identities. + +The HSS shall not use this procedure if there is no Public User Identities left in the implicitly registered Public User Identity set after the removal. In that case HSS shall use the RTR command instead. + +The HSS shall not use this procedure to change the default Public User Identity of the implicitly registered Public User Identity set that is in a state Registered. In that case the HSS shall use the RTR command to de-register the Public User Identity set. + +When a change of the Reference Location Information occurs (e.g.. a change of authorization), the HSS may use a network initiated de-registration instead of this procedure, and may indicate to the S-CSCF that the de-registration is sent due to change of Reference Location Information. + +Moving of a Public User Identity or Identities from one implicitly registered Public User Identity set to another set shall be done in two steps: First the identity or identities are removed from the "old" set as described above, then the identity or identities are added to the "new" set as described above. + +#### 6.5.2.2 De-registration + +A request sent by the HSS to de-register any of the identities included in an implicitly registered Public User Identity set shall affect all the Public User Identities of the deregistered set. + +The de-registration of a Private User Identity implies the de-registration of all the corresponding Public User Identities, both in the HSS and in the S-CSCF. + +#### 6.5.2.3 Update of the Charging information + +A request sent by the HSS to update the charging information shall include the Private User Identity for whom the charging information changed. + +If corresponding Public Identity is registered or unregistered (i.e. registered as a consequence of an originating or terminating request or there is a S-CSCF keeping the user profile stored) and charging information is changed, the HSS should immediately push this information to the S-CSCF. + +#### 6.5.2.4 Update of the SIP Digest Authentication Data + +A request sent by the HSS to update the authentication data shall include the Private User Identity for whom the authentication data changed. + +If corresponding Public Identity is registered and authentication data is changed, the HSS should immediately push this information to the S-CSCF. + +If corresponding Public Identity is either not registered or unregistered (i.e. registered as a consequence of an originating or terminating request or there is a S-CSCF keeping the user profile stored), authentication pending flag is set and authentication data is changed, the HSS should immediately push this information to the S-CSCF. + +#### 6.5.2.5 Update of the Allowed WAF and/or WWSF Identities + +A request sent by the HSS to update the WAF and/or WWSF identities allowed for the subscription shall include the Private User Identity for whom this information changed. + +If corresponding Public Identity is registered and allowed WAF and/or WWSF identities are changed, the HSS should immediately push this information to the S-CSCF. + +## 6.6 Download of the Relevant User Profile and Charging Information and Allowed WAF and/or WWSF Identities + +The download of the relevant user profile, charging information and, if supported and part of subscription, allowed WAF and/or WWSF identities from the HSS to the S-CSCF depends on whether the user profile, charging information and, if supported and part of subscription, allowed WAF and/or WWSF identities are already stored in the S-CSCF. If the SiFC feature is supported by the HSS and S-CSCF, the HSS shall download the identifiers of the shared iFC sets. If either the HSS or the S-CSCF does not support the SiFC feature, the HSS shall download the complete iFCs, and SiFC identifiers shall not be downloaded by the HSS. The SiFC feature is defined in TS 29.229 [5]. + +If User-Data-Already-Available is set to USER\_DATA\_NOT\_AVAILABLE the HSS shall download the requested user profile, charging information and, if supported and part of subscription, allowed WAF and/or WWSF identities. If the Public User Identity in the request is included in an implicitly registered Public User Identity set, the HSS shall include in the response the service profiles associated with all Public User Identities within the implicitly registered Public User Identity set to which the received Public User Identity belongs. + +If User-Data-Already-Available is set to USER\_DATA\_ALREADY\_AVAILABLE, the HSS should not return any user profile or charging information data or allowed WAF and/or WWSF identities. The HSS may override User-Data-Already-Available set to USER\_DATA\_ALREADY\_AVAILABLE and download the user profile, charging information and, if supported and part of subscription, allowed WAF and/or WWSF identities. + +### 6.6.1 HSS initiated update of User Profile + +The request to update the user profile in the S-CSCF includes only the Public User Identities of the implicitly registered Public User Identity set with the associated service profiles. See 6.5.2.1. + +If the Public Identity is registered or unregistered (i.e. registered as a consequence of an originating or terminating request or there is a S-CSCF keeping the user profile stored) and there are changes in the user profile, the HSS should immediately push the complete user profile to the S-CSCF. + +### 6.6.2 S-CSCF operation + +At deregistration of a Public User Identity, the S-CSCF shall store the user information if it sends Server-Assignment-Request command including Server-Assignment-Type AVP set to value USER\_DEREGISTRATION\_STORE\_SERVER\_NAME or TIMEOUT\_DEREGISTRATION\_STORE\_SERVER\_NAME and the HSS responds with DIAMETER\_SUCCESS. Otherwise the S-CSCF shall not keep user information. + +## 6.7 S-CSCF Assignment + +The list of mandatory and optional capabilities received by an I-CSCF from the HSS allows operators to distribute users between S-CSCFs, depending on the different capabilities (e.g. features, role, geographical location) that each S-CSCF may have. Alternatively, an operator has the possibility to steer users to certain S-CSCFs. + +The operator shall define (possibly based on the functionality offered by each S-CSCF installed in the network) the exact meaning of the S-CSCF mandatory and optional capabilities available in his network. It is an operator task to allocate a unique value to represent a single capability (e.g. support of "wildcarded PSI") or a set of capabilities (e.g. support of "alias" and "Shared IFC sets" and "wildcarded PSI") and to use these values to identify capabilities that are mandatory and/or optional to support for a given subscription. It is a configuration task for the operator to ensure that the I-CSCF has a correct record of the capability values received from the HSS for each S-CSCF available in his + +network. The I-CSCF and the HSS do not need to know the semantic of these values. This semantic is exclusively an operator issue. + +As a first choice, the I-CSCF shall select an S-CSCF that has all the mandatory and optional capabilities for the user. Only if that is not possible shall the I-CSCF apply a 'best-fit' algorithm. If more than one S-CSCF is identified that supports all mandatory capabilities the I-CSCF may then consider optional capabilities in selecting a specific S-CSCF. The 'best-fit' algorithm is implementation dependent and out of the scope of this specification. + +It is the responsibility of the operator to ensure that there are S-CSCFs which have mandatory capabilities indicated by the HSS for any given user. However, configuration errors may occur. If such errors occur and they prevent the I-CSCF from selecting an S-CSCF which meets the mandatory capabilities indicated by the HSS, the I-CSCF shall inform the operator via the O&M subsystem. + +As an alternative to selecting an S-CSCF based on the list of capabilities received from the HSS, it is possible to steer users to certain S-CSCFs. To do this, the operator may include one or more S-CSCF names as part of the capabilities of the user profile. The reason for the selection (e.g. all the users belonging to the same company/group could be in the same S-CSCF to implement a VPN service) and the method of selection are operator issues and out of the scope of this specification. If this alternative is chosen, the HSS shall include Server-Name AVPs in the Server-Capabilities AVP and should not include Mandatory-Capability AVPs or Optional-Capability AVPs in the Server-Capabilities AVP, and the I-CSCF when receiving Server-Name AVPs within the Server-Capabilities AVP shall discard any Mandatory-Capability AVP and any Optional-Capability AVP received within the Server-Capabilities AVP. + +The following table is a guideline for operators that records S-CSCF capabilities that need to be supported by an S-CSCF in order to serve a user or a service (identified by a Public User Identity or Public Service Identity), that cannot be served by an S-CSCF which is only compliant to a previous 3GPP release. + +Table 6.7: Guidelines for S-CSCF Capabilities + +| Capability | Mandatory or Optional (NOTE 1) | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Support of "Wildcarded PSI" | M | This capability indicates that the assigned S-CSCF shall support the handling of Wildcarded PSIs. | +| Support of "OrigUnreg SPT" | M | This capability indicates that the assigned S-CSCF shall be able to process iFCs with a Session Case "Originating_Unregistered" received from the HSS in the user profile. | +| Support of "OrigCDIV SPT" | M | This capability indicates that the assigned S-CSCF shall be able to process iFCs with a Session Case "Originating_CDIV" received from the HSS in the user profile. | +| Support of "Shared iFC sets" | O | This capability indicates that the assigned S-CSCF may support the "SiFC" feature defined in the 3GPP TS 29.229 [5]. | +| Support of "Display Name" | O | This capability indicates that the assigned S-CSCF may support the handling of "Display Name". The behaviour of the S-CSCF related to this missing data is the same as if the HSS did not send the Display Name. | +| Support of "Alias" | O | This capability indicates that the assigned S-CSCF may support the "AliasInd" feature defined in 3GPP TS 29.229 [5]. | +| Support of "SIP Digest Authentication" | M | This capability indicates that the assigned S-CSCF shall support the handling of SIP Digest Authentication. | +| Support of "NASS Bundled Authentication" | M | This capability indicates that the assigned S-CSCF shall support the handling of NASS Bundled Authentication. | +| Support of "Wildcarded IMPUs" | M | This capability indicates that the assigned S-CSCF shall support the handling of Wildcarded Public User Identities. | +| Support of "Loose-Route " | M | This capability indicates that the assigned S-CSCF shall support the loose-route mechanism. | +| Support of "Service Level Trace" | M | This capability indicates that the assigned S-CSCF shall support the Service Level Trace mechanism. | +| Support of "Priority Service" | M | This capability indicates that the S-CSCF shall support a network default pre-configured namespace (e.g. "wps") and the associated Service Priority Level. See IETF RFC 4412 [22] and 3GPP TS 24.229 [8]. | +| Support of "Extended Priority " (NOTE 2) | M | This capability indicates that the S-CSCF shall support the Priority Namespaces and their associated Priority Levels. See IETF RFC 4412 [22] and 3GPP TS 24.229 [8]. | +| Support of "Early IMS Security" | M | This capability indicates that the assigned S-CSCF shall support GIBA. | +| Support of "Reference Location" | M | This capability indicates that the assigned S-CSCF shall support the handling of reference location as defined in 3GPP TS 23.167 [23]. | +| Support of "Privileged-Sender" | M | This capability indicates that the S-CSCF shall support privileged sender. See 3GPP TS 24.229 [8]. | +| Support of "IMSI" | M | This capability indicates that the assigned S-CSCF shall support the handling of the IMSI. | +| Support of "Maximum Number of allowed simultaneous registrations" | M | This capability indicates that the assigned S-CSCF shall support the handling of maximum number of allowed simultaneous registrations per user as received from the HSS. | +| NOTE 1: Mandatory (M) corresponds to a Mandatory Capability that shall be supported by the assigned S-CSCF for a given user. The I-CSCF shall not select an S-CSCF that does not meet a mandatory capability. The selection of a S-CSCF not supporting this capability would lead to an unspecified network behaviour.

Optional (O) corresponds to an Optional Capability that may be supported by the assigned S-CSCF for a given user. The selection of a S-CSCF that would not support this capability will not significantly affect the network behaviour. | | | +| NOTE 2: Support of "Extended Priority " is backward compatible with continued support of the "Priority Service". | | | + +# --- 7 Information element contents + +## 7.1 Visited Network Identifier + +This information element contains the domain name of the visited network. + +## 7.2 Public User Identity + +This information element contains the Public User Identity. For definition of a Public User Identity, see TS 23.003 [17]. + +When GPRS-IMS-Bundled Authentication (GIBA) is used, a Temporary Public User Identity is derived from the IMSI used for bearer network access according to the rules in TS 23.003 [17]. + +### 7.2a Public Service Identity + +This information element contains a Public Service Identity (PSI) that is hosted by an application server. For definition of a PSI, see TS 23.003 [17]. + +### 7.2b Wildcarded Public Identity + +This information element contains a Wildcarded PSI that is hosted by an application server or a Wildcarded Public User Identity. For definition of a Wildcarded PSI and a Wildcarded Public User Identity, see TS 23.003 [17]. + +### 7.2c Void + +## 7.3 Private User Identity + +This information element contains the Private User Identity. For definition of a Private User Identity, see TS 23.003 [17]. + +When GPRS-IMS-Bundled Authentication (GIBA) is used, the Private User Identity is derived from the IMSI as specified in TS 33.203 [3]. + +### 7.3a Private Service Identity + +This information element contains the Private Service Identity. For definition of a Private Service Identity, see TS 23.003 [17]. + +## 7.4 S-CSCF Name + +This information element contains the S-CSCF Name of the S-CSCF assigned to an IMS Subscription. For definition of a S-CSCF Name, see TS 23.008 [18]. + +### 7.4a AS Name + +This information element contains the AS Name of the AS hosting a Public Service Identity. For definition of AS Name, see TS 23.008 [18]. + +## 7.5 S-CSCF Capabilities + +This information element carries information to assist the I-CSCF during the process of selecting an S-CSCF for a certain IMS Subscription. + +## 7.6 Result + +This information element contains result of an operation. See TS 29.229 [5] for the possible values. + +## 7.7 User Profile + +This information element contains the user profile in XML format. The user profile XML shall be valid against the user profile XML schema defined in Annex E. + +Annex B specifies the UML logical model of the user profile downloaded via the Cx interface. + +Annex D contains and informative, high level representation, of the wire representation of user profile data. + +## 7.8 Server Assignment Type + +Indicates the type of server assignment. See TS 29.229 [5] for the list of existing values. + +## 7.9 Authentication Data + +This information element is composed of the following sub-elements. + +### 7.9.1 Item Number + +This information element indicates the order in which the authentication vectors are to be consumed. See TS 29.229 [5] for coding details. + +### 7.9.2 Authentication Scheme + +This information element contains the authentication scheme, which is used to encode the authentication parameters. See TS 29.229 [5] for a list of values. + +### 7.9.3 Authentication Information + +This information element is used to convey the challenge and authentication token used during the authentication procedure, see TS 33.203 [3] for more information. See TS 29.229 [5] for coding details. + +### 7.9.4 Authorization Information + +This information element is used, in an authentication request, to indicate a failure of synchronization. In a response, it is used to convey the expected response to the challenge used to authenticate the user, see TS 33.203 [3] for more information. See TS 29.229 [5] for coding details. + +### 7.9.5 Confidentiality Key + +This information element contains the confidentiality key, see TS 33.203 [3] for more information. See TS 29.229 [5] for coding details. + +### 7.9.6 Integrity Key + +This information element contains the integrity key, see TS 33.203 [3] for more information. See TS 29.229 [5] for coding details. + +### 7.9.7 Authentication Context + +This information element contains authentication-related information relevant for performing the authentication but that is not part of the SIP authentication headers. Some mechanisms (e.g. PGP, digest with quality of protection set to authint defined in IETF RFC 2617 [16], digest with predictive nonces or sip access digest) request that part or the whole SIP request (e.g. the SIP method) is passed to the entity performing the authentication. In such cases the SIPAuthentication-Context AVP shall be carrying such information. + +See TS 29.229 [5] for coding details. + +### 7.9.8 Digest Authenticate + +This information element is composed of the following sub-elements. + +#### 7.9.8.1 Digest Realm + +This information element is part of the Digest authentication challenge, and corresponds to the Realm parameter as defined in IETF RFC 3261 [11]. This information element is used to convey the Realm to the S-CSCF during the SIP Digest authentication procedure. See TS 29.229 [5] for coding details. + +#### 7.9.8.2 Void + +#### 7.9.8.3 Digest Algorithm + +This information element is part of the Digest authentication challenge, defined in IETF RFC 2617 [16]. See TS 29.229 [5] for coding details. + +#### 7.9.8.4 Digest QoP + +This information element is part of the Digest authentication challenge, defined in IETF RFC 2617 [16]. It provides the Quality of Protection indication and has an effect on the digest computation. See TS 29.229 [5] for coding details. + +#### 7.9.8.5 Digest HA1 + +This information element is part of the Digest authentication challenge, defined in IETF RFC 2617 [16]. See TS 29.229 [5] for coding details. + +### 7.9.9 Line Identifier + +This information element contains the line identifier of the user's network termination. See TS 29.229 [5] for coding details. + +### 7.9.10 Framed IP Address + +See TS 29.229 [5] for more information. + +### 7.9.11 Framed IPv6 Prefix + +See TS 29.229 [5] for more information. + +### 7.9.12 Framed Interface Id + +See TS 29.229 [5] for more information. + +#### 7.9.8.1 Digest Realm + +This information element is part of the Digest authentication challenge, and corresponds to the realm parameter as defined in IETF RFC 3261 [11]. This information element is used to convey the realm to the S-CSCF during the SIP Digest authentication procedure. + +#### 7.9.8.2 Void + +#### 7.9.8.3 Digest Algorithm + +This information element is part of the Digest authentication challenge, defined in IETF RFC 2617 [16]. + +#### 7.9.8.4 Digest QoP + +This information element is part of the Digest authentication challenge, defined in IETF RFC 2617 [16]. It provides the Quality of Protection indication and has an effect on the digest computation. + +#### 7.9.8.5 Digest HA1 + +This information element is part of the Digest authentication challenge, defined in IETF RFC 2617 [16]. + +### 7.9.9 Line Identifier + +This information element contains the line identifier of the user's network termination. + +## 7.10 Number Authentication Items + +This information element contains the number of authentication vectors requested or delivered. + +## 7.11 Reason for de-registration + +This information element contains the reason for a de-registration procedure. + +## 7.12 Charging information + +Addresses of the charging functions. See TS 29.229 [5]. + +## 7.13 Routing information + +Information to route requests. + +## 7.14 Type of authorization + +Type of authorization requested by the I-CSCF. See TS 29.229 [5] for a list of values. + +## 7.15 Void + +Void + +## 7.16 User Data Already Available + +This information element indicates to the HSS if the user profile is already available in the S-CSCF. See TS 29.229 [5] for a list of values. + +## 7.17 Associated Private Identities + +This information element indicates to the S-CSCF the Private Identities, which belong to the same IMS Subscription as the Private Identity received in the request command. See TS 29.229 [5]. + +## 7.18 Originating-Request + +This information element indicates to the HSS that the request is related to an originating SIP message. See 3GPP 29.229 [5]. + +## 7.19 User Authorization Request Flags + +This information element carries the following indication (see 3GPP 29.229 [5] for coding details): + +- IMS Emergency Registration. + +## 7.20 Loose-Route Indication + +This information element indicates to the S-CSCF that the loose-route mechanism shall be applied to the public identities contained in the user profile received from the HSS. See TS 29.229 [5]. This information is static data for the duration of the subscription or the validity of the IMS identity. Modification of this data result in Network Initiated Deregistration (SERVER\_CHANGE); see clause 6.1.3.1. + +## 7.21 S-CSCF Restoration Information + +This information element contains information for the S-CSCF to handle traffic for a registered user. It is associated with the Private User Identity and the Implicit Registration Set that is affected by the SAR request. See TS 29.229 [5] for the contents of this information element. + +## 7.22 Associated Registered Private Identities + +This information element indicates to the S-CSCF the Registered Private Identities, which were registered with the Public Identity received in the request command. See TS 29.229 [5]. + +## 7.23 Multiple Registration Indication + +This information element indicates to the HSS that this is related to a multiple registration. See TS 29.229 [5]. + +## 7.24 Session-Priority + +This information element indicates the session's priority level to the HSS. See TS 29.229 [5]. + +## 7.25 Identities with Emergency Registration + +This information element indicates to the HSS a list of pairs of Private / Public Identities that are emergency registered. See TS 29.229 [5]. + +## 7.26 Privileged-Sender Indication + +This information element indicates to the S-CSCF that the Private User Identity shall be considered as a privileged sender, as described in TS 24.229 [8]. + +## 7.27 LIA Flags + +This information element carries the following indications. See TS 29.229 [5] for coding details. + +- PSI Direct Routing Indication + +## 7.28 Server Assignment Request Flags + +This information element carries the following indication (see 3GPP 29.229 [5] for coding details): + +- P-CSCF Restoration Indication + +## 7.29 Allowed WAF and/or WWSF Identities + +Addresses of the WebRTC Authentication Functions and/or WebRTC Web Server Functions allowed for a subscription. See TS 33.203 [3]. + +## 7.30 RTR Flags + +This information element carries the following indications. See TS 29.229 [5] for coding details. + +- Reference Location Information change + +# --- 8 Error handling procedures + +## 8.1 Registration error cases + +This clause describes the handling of error cases, which can occur during the registration process. If the new and previously assigned S-CSCF names sent in the Multimedia-Auth-Request command are different and the Multimedia-Auth-Request is not indicating synchronisation failure (i.e. the request does not contain *auts* parameter), then the HSS shall overwrite the S-CSCF name. + +If the new and previously assigned S-CSCF names sent in a command other than the Multimedia-Auth-Request command are different and the S-CSCF reassignment pending flag is not set, then the HSS shall not overwrite the S-CSCF name; instead it shall send a response to the S-CSCF indicating an error. + +### 8.1.1 Cancellation of the old S-CSCF + +It is possible that in certain situations the HSS receives a Multimedia-Auth-Request (MAR) command including a S-CSCF name, which is not the same as the previously assigned S-CSCF for the user. This can happen e.g. in case the new S-CSCF is selected due to a failure in the re-registration if the previously assigned S-CSCF does not respond to REGISTER message sent from the I-CSCF after a timeout. + +In this case, the new S-CSCF is assigned for the user and if registrations in the previously assigned S-CSCF exist for the user, these registrations in the old S-CSCF are handled locally in the old S-CSCF, e.g. re-registration timers in the old S-CSCF shall cancel the registrations. + +Additionally, the HSS should de-register the registrations in the old S-CSCF by using the Registration-Termination-Request command. In this case, the HSS shall first check whether the deregistration is really required by comparing the Diameter client address of the newly assigned S-CSCF received in the MAR command to the Diameter client address + +stored in the HSS. If the Diameter client addresses match, the deregistration shall not be initiated. Otherwise the deregistration should be initiated for all the registered Public User Identities for the corresponding IMS Subscription. HSS shall check whether IMS Restoration Procedures are supported to perform deregistration: + +- If supported, Registration-Termination-Request shall be sent for all Public User Identities (with their associated Private User Identities), with Deregistration-Reason AVP value set to NEW\_SERVER\_ASSIGNED. +- Otherwise, Registration-Termination-Request shall be sent with different Deregistration-Reason AVP values, in the following order: + 1. Deregistration-Reason AVP value set to NEW\_SERVER\_ASSIGNED, for the Public User Identity (with its associated Private User Identity), which is registered in the new S-CSCF. + 2. Deregistration-Reason AVP value set to SERVER\_CHANGE, for the user Public User Identities (with their associated Private User Identities), which are not yet registered in the new S-CSCF. + +### 8.1.2 Error in S-CSCF name + +If the S-CSCF name sent in the Server-Assignment-Request command and the previously assigned S-CSCF name stored in the HSS are different and the S-CSCF reassignment pending flag is not set, then the HSS shall not overwrite the S-CSCF name. If the Server Assignment Type indicates NO\_ASSIGNMENT, the HSS shall send a response to the S-CSCF with Result-Code value set to DIAMETER\_UNABLE\_TO\_COMPLY. For all other Server Assignment Types, the HSS shall send a response to the S-CSCF with Experimental-Result-Code value set to DIAMETER\_ERROR\_IDENTITY\_ALREADY\_REGISTERED. + +If the S-CSCF name sent in the Server-Assignment-Request command and the previously assigned S-CSCF name stored in the HSS are different and IMS Restoration Procedures are supported and the S-CSCF reassignment pending flag is set, then the HSS shall allow overwriting of the S-CSCF name and proceed with the processing of the SAR command as defined in clause 6.1.2. + +### 8.1.3 Error in S-CSCF assignment type + +If the Server-Assignment-Type in the Server-Assignment-Request command sent by the S-CSCF to the HSS is not allowed (i.e if the Server-Assignment-Type is not applicable based on the user state or it is not applicable based on the user identity type), the HSS shall send a response to the S-CSCF with the Experimental-Result-Code value set to DIAMETER\_ERROR\_IN\_ASSIGNMENT\_TYPE. + +# --- 9 Protocol version identification + +See TS 29.229 [5]. + +# --- 10 Operational Aspects + +See TS 29.229 [5]. + +# Annex A (normative): Mapping of Cx operations and terminology to Diameter + +## A.1 Introduction + +This appendix gives mappings from Cx to Diameter protocol elements. Diameter protocol elements are defined in TS 29.229 [5]. + +## A.2 Cx message to Diameter command mapping + +The following table defines the mapping between stage 2 operations and Diameter commands: + +**Table A.2.1: Cx message to Diameter command mapping** + +| Cx message | Source | Destination | Command-Name | Abbreviation | +|-------------------------------------|--------|-------------|-----------------------------------|--------------| +| Cx-Query + Cx-Select-Pull | I-CSCF | HSS | User-Authorization-Request | UAR | +| Cx-Query Resp + Cx-Select-Pull Resp | HSS | I-CSCF | User-Authorization-Answer | UAA | +| Cx-Put + Cx-Pull | S-CSCF | HSS | Server-Assignment-Request | SAR | +| Cx-Put Resp + Cx-Pull Resp | HSS | S-CSCF | Server-Assignment-Answer | SAA | +| Cx-Location-Query | I-CSCF | HSS | Location-Info-Request | LIR | +| Cx-Location-Query Resp | HSS | I-CSCF | Location-Info-Answer | LIA | +| Cx-AuthDataReq | S-CSCF | HSS | Multimedia-Authentication-Request | MAR | +| Cx-AuthDataResp | HSS | S-CSCF | Multimedia-Authentication-Answer | MAA | +| Cx-Deregister | HSS | S-CSCF | Registration-Termination-Request | RTR | +| Cx-Deregister Resp | S-CSCF | HSS | Registration-Termination-Answer | RTA | +| Cx-Update Subscr Data | HSS | S-CSCF | Push-Profile-Request | PPR | +| Cx-Update Subscr Data Resp | S-CSCF | HSS | Push-Profile-Answer | PPA | + +## A.3 Cx message parameters to Diameter AVP mapping + +The following table gives an overview about the mapping: + +**Table A.3.1: Cx message parameters to Diameter AVP mapping** + +| Cx parameter | AVP Name | +|----------------------------|----------------------------| +| Visited Network Identifier | Visited-Network-Identifier | +| Public Identity | Public-Identity | +| Private Identity | User-Name | +| S-CSCF Name | Server-Name | +| AS Name | | +| S-CSCF capabilities | Server-Capabilities | +| Result | Result-Code | +| | Experimental-Result-Code | + +| Cx parameter | AVP Name | +|------------------------------------|----------------------------------| +| User profile | User-Data | +| Server Assignment Type | Server-Assignment-Type | +| Authentication data | SIP-Auth-Data-Item | +| Item Number | SIP-Item-Number | +| Authentication Scheme | SIP-Authentication-Scheme | +| Authentication Information | SIP-Authenticate | +| Authorization Information | SIP-Authorization | +| Confidentiality Key | Confidentiality-Key | +| Integrity Key | Integrity-Key | +| Number Authentication Items | SIP-Number-Auth-Items | +| Reason for de-registration | Deregistration-Reason | +| Charging Information | Charging-Information | +| Routing Information | Destination-Host | +| Type of Authorization | Authorization-Type | +| Associated Private Identities | Associated-Identities | +| Digest Authenticate | SIP-Digest-Authenticate | +| Digest Realm | Digest-Realm | +| Digest Algorithm | Digest-Algorithm | +| Digest QoP | Digest-QoP | +| Digest HA1 | Digest-HA1 | +| Line Identifier | Line-Identifier | +| Wildcarded Public Identity | Wildcarded-Public Identity | +| Loose-Route Indication | Loose-Route-Indication | +| S-CSCF Restoration Information | SCSCF-Restoration-Info | +| Multiple Registration Indication | Multiple-Registration-Indication | +| Privileged-Sender Indication | Privileged-Sender-Indication | +| LIA Flags | LIA-Flags | +| Allowed WAF and/or WWSF Identities | Allowed-WAF-WWSF-Identities | + +## A.4 Message flows + +The following message flows give examples regarding which Diameter messages shall be sent in scenarios described in TS 23.228 [1]. + +### A.4.1 Registration– user not registered + +![Sequence diagram for Registration – user not registered. The diagram shows the interaction between a User Agent (UA) in the Visited Network and various network elements (P-CSCF, I-CSCF, HSS, S-CSCF) in the Home Network. The process involves registration attempts, UAR/UAA exchanges, S-CSCF selection, authentication vector selection, and final OK responses.](8d66c9c295023a1380f9986d3663bb1e_img.jpg) + +``` + +sequenceDiagram + participant UA + participant P-CSCF + participant I-CSCF + participant HSS + participant S-CSCF + + Note left of UA: Visited Network + Note right of S-CSCF: Home Network + + UA->>P-CSCF: 1. Register + P-CSCF->>I-CSCF: 2. Register + I-CSCF->>HSS: 3. UAR + HSS-->>I-CSCF: 4. UAA + Note right of I-CSCF: S-CSCF selection + I-CSCF->>S-CSCF: 5. Register + S-CSCF->>HSS: 6. MAR + Note right of HSS: Authentication vector selection + HSS-->>S-CSCF: 7. MAA + S-CSCF-->>I-CSCF: 8. 401 Unauthorised + Note right of S-CSCF: Authentication Information + I-CSCF-->>P-CSCF: 9. 401 Unauthorised + Note right of I-CSCF: Authentication Information + P-CSCF-->>UA: 10. 401 Unauthorised + Note right of P-CSCF: Authentication Information + UA->>P-CSCF: 11. Register response + P-CSCF->>I-CSCF: 12. Register response + I-CSCF->>HSS: 13. UAR + HSS-->>I-CSCF: 14. UAA + I-CSCF->>S-CSCF: 15. Register response + Note right of S-CSCF: Authentication + S-CSCF->>HSS: 18. SAR + HSS-->>S-CSCF: 19. SAA + S-CSCF-->>I-CSCF: 20. OK + I-CSCF-->>P-CSCF: 21. OK + P-CSCF-->>UA: 22. OK + +``` + +Sequence diagram for Registration – user not registered. The diagram shows the interaction between a User Agent (UA) in the Visited Network and various network elements (P-CSCF, I-CSCF, HSS, S-CSCF) in the Home Network. The process involves registration attempts, UAR/UAA exchanges, S-CSCF selection, authentication vector selection, and final OK responses. + +Figure A.4.1.1: Registration – user not registered + +### A.4.2 Registration – user currently registered + +![Sequence diagram for Re-registration (A.4.2.1)](3442f31a562d1ef45bfa18b18a6a1ddc_img.jpg) + +``` +sequenceDiagram + participant UE + participant P-CSCF + participant I-CSCF + participant HSS + participant S-CSCF + Note left of UE: Visited Network + Note right of S-CSCF: Home Network + UE->>P-CSCF: 1. Register + P-CSCF->>I-CSCF: 2. Register + I-CSCF->>HSS: 3. UAR + HSS-->>I-CSCF: 4. UAA + I-CSCF->>S-CSCF: 5. Register + S-CSCF->>HSS: 6. SAR + HSS-->>S-CSCF: 7. SAA + S-CSCF->>I-CSCF: 8. 200 OK + I-CSCF->>P-CSCF: 9. 200 OK + P-CSCF->>UE: 10. 200 OK +``` + +Sequence diagram illustrating the Re-registration process (A.4.2.1). The diagram shows the interaction between the UE, P-CSCF, I-CSCF, HSS, and S-CSCF. The process starts with the UE sending a Register message to the P-CSCF. The P-CSCF forwards it to the I-CSCF, which sends a UAR to the HSS. The HSS responds with a UAA. The I-CSCF then sends a Register message to the S-CSCF. The S-CSCF sends a SAR to the HSS, which responds with a SAA. The S-CSCF then sends a 200 OK response to the I-CSCF, which in turn sends a 200 OK response to the P-CSCF, which finally sends a 200 OK response to the UE. + +Sequence diagram for Re-registration (A.4.2.1) + +Figure A.4.2.1: Re-registration + +### A.4.3 UE initiated de-registration + +![Sequence diagram for UE initiated de-registration (A.4.3.1)](552328a9daaf3bc0069424b500025880_img.jpg) + +``` +sequenceDiagram + participant UE + participant P-CSCF + participant I-CSCF + participant HSS + participant S-CSCF + Note left of UE: Visited Network + Note right of S-CSCF: Home Network + UE->>P-CSCF: 1. REGISTER + P-CSCF->>I-CSCF: 2. REGISTER + I-CSCF->>HSS: 3. UAR + HSS-->>I-CSCF: 4. UAA + I-CSCF->>S-CSCF: 5. REGISTER + S-CSCF->>HSS: 6. SAR + HSS-->>S-CSCF: 7. SAA + S-CSCF->>I-CSCF: 8. 200 OK + I-CSCF->>P-CSCF: 9. 200 OK + P-CSCF->>UE: 10. 200 OK +``` + +Sequence diagram illustrating the UE initiated de-registration process (A.4.3.1). The diagram shows the interaction between the UE, P-CSCF, I-CSCF, HSS, and S-CSCF. The process starts with the UE sending a REGISTER message to the P-CSCF. The P-CSCF forwards it to the I-CSCF, which sends a UAR to the HSS. The HSS responds with a UAA. The I-CSCF then sends a REGISTER message to the S-CSCF. The S-CSCF sends a SAR to the HSS, which responds with a SAA. The S-CSCF then sends a 200 OK response to the I-CSCF, which in turn sends a 200 OK response to the P-CSCF, which finally sends a 200 OK response to the UE. + +Sequence diagram for UE initiated de-registration (A.4.3.1) + +Figure A.4.3.1: UE initiated de-registration + +### A.4.4 Network initiated de-registration + +#### A.4.4.1 Registration timeout + +![Sequence diagram for registration timeout de-registration](08f6ace0c83e7394657fa372b47aec04_img.jpg) + +This sequence diagram illustrates the network-initiated de-registration process due to a registration timeout. It involves four entities: UE, P-CSCF, S-CSCF, and HSS. The process begins with timers expiring in both the P-CSCF and S-CSCF. The S-CSCF then sends a SAR (Service Authorization Request) to the HSS, which responds with an SAA (Service Authorization Answer). + +``` +sequenceDiagram + participant UE + participant P-CSCF + participant S-CSCF + participant HSS + Note right of P-CSCF: 1. Timer Expires + Note right of S-CSCF: 1. Timer Expires + S-CSCF->>HSS: 2. SAR + HSS-->>S-CSCF: 3. SAA +``` + +Sequence diagram for registration timeout de-registration + +Figure A.4.4.1.1: Network initiated de-registration – registration timeout + +#### A.4.4.2 Administrative de-registration + +![Sequence diagram for administrative de-registration](396197257cf9437b526bb6585b6a9c8a_img.jpg) + +This sequence diagram illustrates the network-initiated administrative de-registration process. It involves four entities: UE, P-CSCF, S-CSCF, and HSS. The process starts with the HSS sending an RTR (Re-Registration) to the S-CSCF. The S-CSCF then sends a Deregister message to the P-CSCF. The P-CSCF sends a UE Inform message to the UE. The UE responds with an OK 200 message to the P-CSCF, which in turn sends an OK 200 message to the S-CSCF. Finally, the S-CSCF sends an RTA (Re-Registration Termination Answer) to the HSS. + +``` +sequenceDiagram + participant UE + participant P-CSCF + participant S-CSCF + participant HSS + HSS->>S-CSCF: 1. RTR + S-CSCF->>P-CSCF: 2. Deregister + P-CSCF->>UE: 3. UE Inform + UE-->>P-CSCF: 5a. OK 200 + P-CSCF->>S-CSCF: 4. OK 200 + S-CSCF->>HSS: 5. RTA +``` + +Sequence diagram for administrative de-registration + +Figure A.4.4.2.1: Network initiated de-registration – administrative de-registration + +#### A.4.4.3 De-registration initiated by service platform + +![Sequence diagram for network initiated de-registration initiated by service platform. Lifelines: UE, P-CSCF, S-CSCF, HSS. Steps: 1. Service Control (S-CSCF internal), 2. Deregister (S-CSCF to P-CSCF), 3. UE Inform (P-CSCF to UE), 4. OK 200 (P-CSCF to S-CSCF), 5. OK 200 (UE to P-CSCF), 6. SAR (S-CSCF to HSS), 7. SAA (HSS to S-CSCF).](40a8c30f7ea5ecea4912e040c97c5b9c_img.jpg) + +``` +sequenceDiagram + participant UE + participant P-CSCF + participant S-CSCF + participant HSS + Note right of S-CSCF: 1. Service Control + S-CSCF->>P-CSCF: 2. Deregister + P-CSCF->>UE: 3. UE Inform + P-CSCF->>S-CSCF: 4. OK 200 + UE-->>P-CSCF: 5. OK 200 + S-CSCF->>HSS: 6. SAR + HSS->>S-CSCF: 7. SAA +``` + +Sequence diagram for network initiated de-registration initiated by service platform. Lifelines: UE, P-CSCF, S-CSCF, HSS. Steps: 1. Service Control (S-CSCF internal), 2. Deregister (S-CSCF to P-CSCF), 3. UE Inform (P-CSCF to UE), 4. OK 200 (P-CSCF to S-CSCF), 5. OK 200 (UE to P-CSCF), 6. SAR (S-CSCF to HSS), 7. SAA (HSS to S-CSCF). + +Figure A.4.4.3.1: Network initiated de-registration – initiated by service platform + +### A.4.5 UE Terminating SIP session set-up + +![Sequence diagram for UE Terminating SIP session set-up. Lifelines: I-CSCF, HSS, S-CSCF (under Home Network). Steps: 1. INVITE (External to I-CSCF), 2. LIR (I-CSCF to HSS), 3. LIA (HSS to I-CSCF), 5. INVITE (I-CSCF to S-CSCF).](3493d7ba4c86f944e159de1bf45ff03d_img.jpg) + +``` +sequenceDiagram + participant I-CSCF + participant HSS + participant S-CSCF + Note over I-CSCF, HSS, S-CSCF: Home Network + External->>I-CSCF: 1. INVITE + I-CSCF->>HSS: 2. LIR + HSS->>I-CSCF: 3. LIA + I-CSCF->>S-CSCF: 5. INVITE +``` + +Sequence diagram for UE Terminating SIP session set-up. Lifelines: I-CSCF, HSS, S-CSCF (under Home Network). Steps: 1. INVITE (External to I-CSCF), 2. LIR (I-CSCF to HSS), 3. LIA (HSS to I-CSCF), 5. INVITE (I-CSCF to S-CSCF). + +Figure A.4.5.1: UE Terminating SIP session set-up + +### A.4.6 Initiation of a session to a non-registered user + +![Sequence diagram for session initiation to a non-registered user](a0e8fe7862a6d7341faf5dac275277cc_img.jpg) + +This sequence diagram illustrates the interaction between an L-CSCF, HSS, and S-CSCF for session initiation to a non-registered user. The process begins with an external INVITE message to the L-CSCF. The L-CSCF sends a LIR to the HSS, which responds with a LIA. The L-CSCF then performs S-CSCF Selection and sends an INVITE to the S-CSCF. The S-CSCF sends a SAR to the HSS, which responds with a SAA. Finally, the S-CSCF performs Service Control and further actions. + +``` +sequenceDiagram + participant External + participant L-CSCF + participant HSS + participant S-CSCF + Note right of S-CSCF: 8. Service Control + Note right of S-CSCF: 9. S-CSCF performs further actions + + External->>L-CSCF: 1. INVITE + L-CSCF->>HSS: 2. LIR + HSS-->>L-CSCF: 3. LIA + Note left of L-CSCF: 4. S-CSCF Selection + L-CSCF->>S-CSCF: 5. INVITE + S-CSCF->>HSS: 6. SAR + HSS-->>S-CSCF: 7. SAA +``` + +Sequence diagram for session initiation to a non-registered user + +Figure A.4.6.1: Initiation of a session to a non-registered user + +#### A.4.6a AS originating session on behalf of a non-registered user + +![Sequence diagram for AS originating session on behalf of a non-registered user](c0c7f65c51c83fbe595b47326f6b089a_img.jpg) + +This sequence diagram illustrates the interaction between an AS, I-CSCF, HSS, and S-CSCF for an AS originating session on behalf of a non-registered user. The AS sends an INVITE to the I-CSCF. The I-CSCF sends a LIR to the HSS, which responds with a LIA. The I-CSCF then performs S-CSCF Selection and sends an INVITE to the S-CSCF. The S-CSCF sends a SAR to the HSS, which responds with a SAA. Finally, the S-CSCF performs Service Control and further actions. A dashed box encloses the first five steps, indicating a specific interaction set. + +``` +sequenceDiagram + participant AS + participant I-CSCF + participant HSS + participant S-CSCF + Note right of S-CSCF: 4. Service Control + Note right of S-CSCF: 5. S-CSCF performs further actions + + AS->>I-CSCF: 1a. INVITE + Note left of I-CSCF: 1b1. INVITE + I-CSCF->>HSS: 1b2. LIR + HSS-->>I-CSCF: 1b3. LIA + Note left of I-CSCF: 1b4. S-CSCF Selection + I-CSCF->>S-CSCF: 1b5. INVITE + S-CSCF->>HSS: 2. SAR + HSS-->>S-CSCF: 3. SAA +``` + +Sequence diagram for AS originating session on behalf of a non-registered user + +Figure A.4.6a.1: AS originating session on behalf of a non-registered user + +### A.4.7 User Profile update + +![Sequence diagram showing User Profile update between S-CSCF and HSS. The HSS sends a PPR message to the S-CSCF, and the S-CSCF sends a PPA message to the HSS.](0a73b03fba21af142d619a9a662e6490_img.jpg) + +``` +sequenceDiagram + participant S-CSCF + participant HSS + Note right of HSS: PPR + HSS->>S-CSCF: PPR + Note left of S-CSCF: PPA + S-CSCF->>HSS: PPA +``` + +Sequence diagram showing User Profile update between S-CSCF and HSS. The HSS sends a PPR message to the S-CSCF, and the S-CSCF sends a PPA message to the HSS. + +Figure A.4.7.1: User profile update + +# Annex B (informative): User profile UML model + +The purpose of this UML model is to define in an abstract level the structure of the user profile downloaded over the Cx interface and describe the purpose of the different information classes included in the user profile. + +## B.1 General description + +The following picture gives an outline of the UML model of the user profile, which is downloaded from HSS to S-CSCF: + +![UML Class Diagram of User Profile](21327313f7b18a481da0c87a6472a80d_img.jpg) + +``` +classDiagram + IMSSubscription "1" *-- "1..n" ServiceProfile + IMSSubscription "1" *-- "0..1" ReferenceLocationInformation + class IMSSubscription { + Private User Identity + IMSI + } + class ServiceProfile + class ReferenceLocationInformation { + AccessType: string + AccessInfo: string + AccessValue: string + } +``` + +The diagram shows a UML class model for the User Profile. At the top is the **IMS Subscription** class, which contains two attributes: **Private User Identity** and **IMSI**. This class has a composition relationship with two other classes. To the left is the **ServiceProfile** class, with a multiplicity of **1..n** at its end. To the right is the **ReferenceLocationInformation** class, which contains three attributes: **AccessType: string**, **AccessInfo: string**, and **AccessValue: string**, with a multiplicity of **0..1** at its end. The composition is indicated by a solid diamond on the IMS Subscription side. + +UML Class Diagram of User Profile + +**Figure B.1.1: User Profile** + +IMS Subscription class contains as a parameter the private user identity of the user in NAI format and the IMSI of the user, if available, as defined in TS 23.003 [17]. + +Each instance of the IMS Subscription class contains zero or one instance of the class Reference Location Information. + +The class Reference Location Information contains zero or one attribute AccessType, zero or one attribute AccessInfo, and zero or one attribute AccessValue. + +The attribute AccessType indicates the type of access for which the reference location of the user is defined (e.g. ADSL). The attribute AccessInfo indicates the type of the access information defined for the reference location of the user (e.g. dsl-location). The attribute AccessValue contains the location information (e.g. line identifier in fixed access networks) as configured by the operator. + +Each instance of the IMS Subscription class contains one or several instances of the class Service Profile. + +## B.2 Service profile + +The following picture gives an outline of the UML model of the Service Profile class: + +![UML Class Diagram for Service Profile](675af5bb2357ce5b510e613d04f66bdc_img.jpg) + +``` +classDiagram + class ServiceProfile { + SharedIFCSetID: integer + } + class PublicIdentity + class CoreNetworkServicesAuthorization + class InitialFilterCriteria + + ServiceProfile "1" *-- "1..n" PublicIdentity + ServiceProfile "1" *-- "0..1" CoreNetworkServicesAuthorization + ServiceProfile "1" *-- "0..n" InitialFilterCriteria +``` + +The diagram shows a UML class structure. At the top is the **ServiceProfile** class, which contains an attribute **SharedIFCSetID: integer**. Below it, three classes are shown: **PublicIdentity**, **CoreNetworkServicesAuthorization**, and **InitialFilterCriteria**. The **ServiceProfile** class has a composition relationship with each of these three classes, indicated by a solid diamond. The multiplicities are: **ServiceProfile** (1) to **PublicIdentity** (1..n), **ServiceProfile** (1) to **CoreNetworkServicesAuthorization** (0..1), and **ServiceProfile** (1) to **InitialFilterCriteria** (0..n). + +UML Class Diagram for Service Profile + +**Figure B.2.1: Service Profile** + +Each instance of the Service Profile class consists of the following classes: + +- One or several instances of the Public-Identity class. PublicIdentity class contains the Public Identities associated with that service profile. The information in the CoreNetworkServicesAuthorization and InitialFilterCriteria classes apply to all PublicIdentification class instances, which are included in one ServiceProfile class. +- An optional instance of the CoreNetworkServicesAuthorization class. If no instance of the CoreNetworkServicesAuthorization class is present, no filtering related to subscribed media or restriction on IMS Communication Service Identifiers applies in the S-CSCF. +- Zero or several instances of the InitialFilterCriteria class. + +Each instance of the Service Profile class contains the following attributes: + +- Zero or more instances of the attribute SharedIFCSetID. A SharedIFCSetID attribute points to a set of Initial Filter Criteria locally administered and stored at the S-CSCF. Shared iFC Sets may be shared by several Service Profiles. + +### B.2.1 Public Identification + +The following picture gives an outline of the UML model of Public Identification class: + +![UML Class Diagram showing Public Identification and ExtendedPriority classes.](255efa1d461fc79b4ed367aaec11637f_img.jpg) + +``` + +classDiagram + class PublicIdentification["Public Identification"] { + BarringIndication: Boolean + Identity: anyURI + IdentityType: enumerated + WildcardedPSI: anyURI + DisplayName: string + AliasIdentityGroupId: string + WildcardedIMPU: anyURI + ServiceLevelTraceInfo: string + ServicePriorityLevel: enumerated + MaxNumOfAllowedSimultRegs: Integer + } + class ExtendedPriority { + PriorityNamespace: string + PriorityLevel: string + } + PublicIdentification "1" *-- "0..n" ExtendedPriority + +``` + +The diagram shows a class named "Public Identification" with the following attributes: BarringIndication (Boolean), Identity (anyURI), IdentityType (enumerated), WildcardedPSI (anyURI), DisplayName (string), AliasIdentityGroupId (string), WildcardedIMPU (anyURI), ServiceLevelTraceInfo (string), ServicePriorityLevel (enumerated), and MaxNumOfAllowedSimultRegs (Integer). Below this class is a diamond-shaped aggregation symbol connected to a class named "ExtendedPriority" with a multiplicity of "0..n". The "ExtendedPriority" class has two attributes: PriorityNamespace (string) and PriorityLevel (string). + +UML Class Diagram showing Public Identification and ExtendedPriority classes. + +**Figure B.2.1.1: Public Identification** + +The attribute BarringIndication is of type Boolean. If it is absent, or if it is present and set to FALSE, the S-CSCF shall not restrict the use of that public user identity in any IMS communications. If it is present and set to TRUE, the S-CSCF shall prevent that public identity from being used in any IMS communication except registrations and re-registrations, as specified in TS 24.229 [8]. + +Public Identification class can contain an Identity attribute. The attribute IdentityType indicates the type of identity contained in each case. It could be either: + +- A distinct Public User Identity +- A distinct Public Service Identity +- A Wildcarded Public Service Identity +- A non distinct Public User Identity, i.e. not explicitly provisioned in HSS. +- A Wildcarded Public User Identity + +If the identity type is not present, it is assumed to be a distinct Public User Identity. + +The attribute WildcardedPSI may be present (when IdentityType is WildcardedPSI) and contains the Wildcarded Public Service Identity that matched the Public Service Identity. This Wildcarded Public Service identity shall be sent as stored in the HSS, that is, including the delimiter described in TS 23.003 [17]. + +The attribute DisplayName allows a name to be associated with a Public Identity. + +The attribute AliasIdentityGroupID indicates the Alias Public User Identity Set to which the Public User Identity belongs. If the "AliasInd" feature is supported, all Public User Identities shall have an AliasIdentityGroupID allocated. Within an IMS subscription Public User Identities that have the same AliasIdentityGroupID allocated shall be in the same implicit registration sets, and shall share their service profile and the same service data for each and every service, and shall be regarded as aliases of each other, as defined in the TS 23.008 [18]. If the "AliasInd" feature is not supported, all Public User Identities within an IMS subscription that are within the same implicit registration set and share their service profile shall be regarded aliases of each other. + +The attribute WildcardedIMPU shall be present when IdentityType is a non distinct IMPU or it may be optionally present when IdentityType is a Wildcarded IMPU. It contains the Wildcarded Public User Identity that matched the + +Public User Identity. This Wildcarded Public User identity shall be sent as stored in the HSS, that is, including the delimiter described in TS 23.003 [17]. + +The attribute ServiceLevelTraceInfo provides the Service Level Tracing Information that is related to the Public User Identity. If the ServiceLevelTraceInfo is present, service level tracing shall be enabled in the S-CSCF for the related Public User Identity according to the configuration data received. If the ServiceLevelTraceInfo is not present, service level tracing is disabled in the S-CSCF for the related Public User Identity. + +The attribute ServicePriorityLevel provides the Priority Level allowed for the Public User Identity, which can be used by the S-CSCF and other network elements for Priority Service. + +The attribute PriorityNamespace provides the Namespace as specified in IETF RFC 4412 [22] and to which the Extended Priority refers. + +The attribute PriorityLevel provides the Priority Level allowed for the Public User Identity, for the Extended Priority. Its value depends on the PriorityNamespace. + +The attribute MaxNumOfAllowedSimultRegs provides the maximum number of allowed simultaneous registrations for the Public User Identity. + +### B.2.1A Core Network Service Authorization + +The following picture gives an outline of the UML model of Core Network Service Authorization class: + +![UML Class Diagram for Core Network Service Authorization](17439b945bd5156395c7ba15bf04f8fb_img.jpg) + +``` +classDiagram + class CoreNetworkServiceAuthorization["Core Network Service Authorization"] + class SubscribedMediaProfileId["Subscribed Media Profile Id"] { + SubscribedMediaProfileId: Integer + } + class ListOfServiceIds["List of Service Ids"] + class ServiceId["Service Id"] { + ServiceId: string + } + + CoreNetworkServiceAuthorization "1" *-- "0..1" SubscribedMediaProfileId + CoreNetworkServiceAuthorization "1" *-- "0..1" ListOfServiceIds + ListOfServiceIds "1" *-- "0..n" ServiceId +``` + +The diagram illustrates the UML model for the Core Network Service Authorization class. It features three classes: Core Network Service Authorization, Subscribed Media Profile Id, and List of Service Ids. The Core Network Service Authorization class is at the top and has a composition relationship with both the Subscribed Media Profile Id and List of Service Ids classes, with a multiplicity of 0..1 for each. The List of Service Ids class further has a composition relationship with the Service Id class, with a multiplicity of 0..n. The Subscribed Media Profile Id class has an attribute SubscribedMediaProfileId of type Integer. The Service Id class has an attribute ServiceId of type string. + +UML Class Diagram for Core Network Service Authorization + +**Figure B.2.1A.1: Core Network Service Authorization** + +Each instance of the Core Network Service Authorization class contains zero or one instance of the class Subscribed Media Profile Id. If no instance of the class Subscribed Media Profile Id is present, no filtering related to subscribed media applies in S-CSCF. The Subscribed Media Profile Id is of type Integer and identifies a media profile in the S-CSCF for the authorization of media parameters. + +Each instance of the Core Network Service Authorization class contains zero or one instance of the class List of Service Ids. If no instance of the class List of Service Ids is present, no restriction on IMS Communication Service Identifiers related applies in S-CSCF. Each instance of the class List of Service Ids contains zero or more instances of the class Service Id. The Service Id is of type String and identifies an IMS Communication Service Identifier that the subscriber is authorized to use. + +### B.2.2 Initial Filter Criteria + +The following picture gives an outline of the UML model of Initial Filter Criteria class: + +![UML Class Diagram of Initial Filter Criteria](03d9aaba6c1af8bfd8e42c1d2422ae5c_img.jpg) + +``` + +classDiagram + class InitialFilterCriteria { + Priority: integer + ProfilePartIndicator: enumerated + } + class TriggerPoint { + ConditionTypeCNF: boolean + } + class ApplicationServer { + ServerName: SIP URL + DefaultHandling: enumerated + ServiceInfo: string + } + class SPT (ServicePointTrigger) { + ConditionNegated: boolean + Group: list of integers + } + class IncludeRegisterRequest + class IncludeRegisterResponse + + InitialFilterCriteria "1" *-- "0..1" TriggerPoint + InitialFilterCriteria "1" *-- "1" ApplicationServer + TriggerPoint "1" *-- "1..n" SPT + ApplicationServer "1" *-- "0..1" IncludeRegisterRequest + ApplicationServer "1" *-- "0..1" IncludeRegisterResponse + +``` + +The diagram illustrates the UML model for the Initial Filter Criteria class. At the top is the **InitialFilterCriteria** class with attributes **Priority: integer** and **ProfilePartIndicator: enumerated**. It has a composition relationship with the **TriggerPoint** class (multiplicity 0..1) and the **ApplicationServer** class (multiplicity 1). The **TriggerPoint** class has the attribute **ConditionTypeCNF: boolean** and is composed by the **SPT (ServicePointTrigger)** class (multiplicity 1..n). The **SPT** class has attributes **ConditionNegated: boolean** and **Group: list of integers**. The **ApplicationServer** class has attributes **ServerName: SIP URL**, **DefaultHandling: enumerated**, and **ServiceInfo: string**. It is composed by the **IncludeRegisterRequest** class (multiplicity 0..1) and the **IncludeRegisterResponse** class (multiplicity 0..1). + +UML Class Diagram of Initial Filter Criteria + +**Figure B.2.2.1.1: Initial Filter Criteria** + +Each instance of the InitialFilterCriteria class includes the following attributes: + +- One instance of Priority attribute that indicates the priority of the Filter Criteria. The higher the Priority Number the lower the priority of the Filter Criteria is; i.e., a Filter Criteria with a higher value of Priority Number shall be assessed after the Filter Criteria with a smaller Priority Number have been assessed. The same priority shall not be assigned to more than one initial Filter Criterion. +- An optional instance of ProfilePartIndicator attribute that is an enumerated type, with possible values "REGISTERED and UNREGISTERED, indicating if the iFC is a part of the registered or unregistered user profile. If ProfilePartIndicator is missing from the iFC, the iFC is considered to be relevant to both the registered and unregistered parts of the user profile, i.e. belongs to the common part of the user profile. + +Each instance of the InitialFilterCriteria class consists of the following classes: + +- An optional instance of TriggerPoint class that describes the trigger points that should be checked in order to find out if the indicated Application Server should be contacted or not. Each TriggerPoint is a boolean expression in Conjunctive or Disjunctive Normal form (CNF or DNF). The absence of Trigger Point instance will indicate an unconditional triggering to Application Server. + +The attribute ConditionTypeCNF attribute defines how the set of SPTs are expressed, i.e. either an Ored set of ANDed sets of SPT statements or an ANDed set of Ored sets of statements. Individual SPT statements can also be negated. These combinations are termed, respectively, Disjunctive Normal Form (DNF) and Conjunctive Normal Form (CNF) for the SPT (see Annex C). Both DNF and CNF forms can be used. ConditionTypeCNF is + +a boolean that is TRUE when the Trigger Point associated with the FilterCriteria is a boolean expression in Conjunctive Normal Form (CNF) and FALSE if the Trigger Point is expressed in Disjunctive Normal Form (DNF) (see Annex C). + +Each TriggerPoint class is composed by 1 to n instances of the SPT (ServicePointTrigger) class. + +- One instance of ApplicationServer class that defines the application server, which is contacted, if the trigger points are met. + +Each instance of the ApplicationServer class includes following attributes: + +- One instance of ServerName attribute that is the SIP URL of the application server to contact. +- An optional instance of DefaultHandling attribute that determines whether the dialog should be released if the Application Server could not be reached or not; it is of type enumerated and can take the values: SESSION\_ CONTINUED or SESSION\_ TERMINATED. +- One optional instance of the ServiceInfo attribute. The ServiceInfo attribute allows to download to S-CSCF information that is to be transferred transparently to an Application Server when the trigger points of a filter criterion are satisfied. ServiceInfo is a string conveying that information. See TS 23.218 [6] for a description of the use of this information element. + +Each instance of the ApplicationServer class includes following classes: + +- One optional instance of the IncludeRegisterRequest class that indicates to the S-CSCF that the incoming SIP REGISTER request is to be transferred to an Application Server when the trigger points of a filter criterion are satisfied. See TS 23.218 [6] for a description of the use of this information element. +- One optional instance of the IncludeRegisterResponse class that indicates to the S-CSCF that the final SIP response to the incoming SIP REGISTER request is to be transferred to an Application Server when the trigger points of a filter criterion are satisfied. See TS 23.218 [6] for a description of the use of this information element. + +### B.2.3 Service Point Trigger + +The following picture gives an outline of the UML model of Service Point Trigger class: + +![UML Class Diagram for Service Point Trigger](ec035e97a11ce40541dec6d88d54c7cb_img.jpg) + +``` + +classDiagram + class ServicePointTrigger { + ConditionNegated: boolean + Group: list of integer + RegistrationType: list of enumerated + } + class RequestURI { + RequestURI: string + } + class SIPMethod { + Method: string + } + class SIPHeader { + Header: string + Content: string + } + class SessionCase { + SessionCase: enumerated + } + class SessionDescription { + Line: string + Content: string + } + ServicePointTrigger <|-- RequestURI + ServicePointTrigger <|-- SIPMethod + ServicePointTrigger <|-- SIPHeader + ServicePointTrigger <|-- SessionCase + ServicePointTrigger <|-- SessionDescription + +``` + +The diagram shows a UML class hierarchy. At the top is the **Service Point Trigger** class, which has three attributes: **ConditionNegated** (boolean), **Group** (list of integer), and **RegistrationType** (list of enumerated). Below it, five classes inherit from **Service Point Trigger**: **Request-URI**, **SIP Method**, **SIP Header**, **Session Case**, and **Session Description**. Each of these five classes has its own specific attribute(s): **RequestURI** (string) for Request-URI, **Method** (string) for SIP Method, **Header** (string) and **Content** (string) for SIP Header, **SessionCase** (enumerated) for Session Case, and **Line** (string) and **Content** (string) for Session Description. + +UML Class Diagram for Service Point Trigger + +Figure B.2.3.1: Service Point Trigger + +The attribute **Group** of the class **Service Point Trigger** allows the grouping of SPTs that will configure the sub-expressions inside a CNF or DNF expression. For instance, in the following CNF expression $(A+B).(C+D)$ , $A+B$ and $C+D$ would correspond to different groups. + +In CNF, the attribute Group identifies the ORed sets of SPT instances. If the SPT belongs to different ORed sets, SPT can have more than one Group values assigned. At least one Group must be assigned for each SPT. + +In DNF, the attribute Group identifies the ANDed sets of SPT instances. If the SPT belongs to different ANDed sets, SPT can have more than one Group values assigned. At least one Group must be assigned for each SPT. + +The attribute ConditionNegated of the class Service Point Trigger defines whether the individual SPT instance is negated (i.e. NOT logical expression). + +**NOTE:** The operator should be aware that a negated Session Case implies that all other available session cases are set. The list of session cases depends on the release and can even be increased in the future, then a negated Session Case may end up triggering ASs unexpectedly (e.g. NOT ORIGINATED\_REGISTERED may trigger only TERMINATING\_UNREGISTERED and TERMINATING\_REGISTERED, or as well ORIGINATING\_UNREGISTERED and ORIGINATING\_CDIV). + +The attribute RegistrationType of the class Service Point Trigger is relevant only to the SIP Method SPT with a value of "REGISTER" and its' support is optional in the HSS and in the S-CSCF. The RegistrationType may contain a list of values that define whether the SPT matches to REGISTER messages that are related to initial registrations, re-registrations, and/or de-registrations. If RegistrationTypes are given, the SIP Method SPT with a value of "REGISTER" shall match if any of the RegistrationTypes match and the S-CSCF supports the RegistrationType attribute. If the SIP Method SPT contains value "REGISTER", and no RegistrationType is given, or if the S-CSCF does not support the RegistrationType attribute, the SIP Method SPT matches to all REGISTER messages. The attribute RegistrationType may be discarded if it is present in an SPT other than SIP Method with value "REGISTER". + +Request-URI class defines SPT for the Request-URI. Request-URI contains attribute RequestURI. + +SIP Method class defines SPT for the SIP method. SIP Method contains attribute Method which holds the name of any SIP method. + +SIP Header class defines SPT for the presence or absence of any SIP header or for the content of any SIP header. SIP Header contains attribute Header which identifies the SIP Header, which is the SPT, and the Content attribute defines the value of the SIP Header if required. + +The absence of the Content attribute and ConditionNegated = TRUE indicates that the SPT is the absence of a determined SIP header. + +Session Case class represents an enumerated type, with possible values "Originating", "Terminating\_Registered", "Terminating\_Unregistered", "Originating\_Unregistered", "Originating\_CDIV" indicating whether the filter should be used by the S-CSCF handling the Originating, Terminating for a registered end user, Terminating for an unregistered end user, Originating for an unregistered end user, or Originating after Call Diversion services. + +Session Description Information class defines SPT for the content of any SDP field within the body of a SIP Method. The Line attribute identifies the line inside the session description. Content is a string defining the content of the line identified by Line. + +# Annex C (informative): Conjunctive and Disjunctive Normal Form + +A Trigger Point expression is constructed out of atomic expressions (i.e. Service Point Trigger) linked by Boolean operators AND, OR and NOT. Any logical expression constructed in that way can be transformed to forms called Conjunctive Normal Form (CNF) and Disjunctive Normal Form (DNF). + +A Boolean expression is said to be in Conjunctive Normal Form if it is expressed as a conjunction of disjunctions of literals (positive or negative atoms), i.e. as an AND of clauses, each of which is the OR of one or more atomic expressions. + +Taking as an example the following trigger: + +Method = "INVITE" OR Method = "MESSAGE" OR (Method="SUBSCRIBE" AND NOT Header = "from" Content = "joe") + +The trigger can be split into the following atomic expressions: + +Method="INVITE" + +Method="MESSAGE" + +Method="SUBSCRIBE" + +NOT header="from" Content ="joe" + +Grouping the atomic expressions, the CNF expression equivalent to the previous example looks like: + +(Method="INVITE" OR Method = "MESSAGE" OR Method="SUBSCRIBE") AND (Method="INVITE" OR Method = "MESSAGE" OR (NOT Header = "from" Content = "joe")) + +This result in two "OR" groups linked by "AND" (CNF): + +(Method="INVITE" OR Method = "MESSAGE" OR Method="SUBSCRIBE") + +(Method="INVITE" OR Method = "MESSAGE" OR (NOT Header = "from" Content = "joe")) + +The XML representation of the trigger is: + +``` + + + IMPI1@homedomain.com + + + 1 + sip:IMPU1@homedomain.com + + + sip:IMPU2@homedomain.com + + + 0 + + 1 + + 0 + 0 + INVITE + + + + + +``` + +``` + + + + 0 + 0 + MESSAGE + + + 0 + 0 + SUBSCRIBE + + + 0 + 1 + INVITE + + + 0 + 1 + MESSAGE + + + + 1 + 1 + +
From
+ "joe" +
+
+ + + sip:AS1@homedomain.com + 0 + + + + + +``` + +A Boolean expression is said to be in Disjunctive Normal Form if it is expressed as a disjunction of conjunctions of literals (positive or negative atoms), i.e. as an OR of clauses, each of which is the AND of one or more atomic expressions. + +The previous example is already in DNF, composed by the following groups: + +Method="INVITE" + +Method="MESSAGE" + +Method="SUBSCRIBE" AND (NOT header="from" Content ="joe") + +The XML representation of the trigger is: + +``` + + + + IMPI1@homedomain.com + + + 1 + sip:IMPU1@homedomain.com + + +``` + +``` + + sip:IMPU2@homedomain.com + + + 0 + + 0 + + 0 + 0 + INVITE + + + 0 + 1 + MESSAGE + + + 0 + 2 + SUBSCRIBE + + + 1 + 2 + +
From
+ "joe" +
+
+
+ + sip:AS1@homedomain.com + 0 + +
+
+
+``` + +# Annex D (informative): High-level format for the User Profile + +The way the information shall be transferred through the Cx interface can be seen from a high-level point of view in the following picture: + +![Figure D.1: Example of in-line format of user profile](30387053b5b3fede6873f6a46a9ca4a9_img.jpg) + +A diagram showing the high-level format of a user profile. It consists of a horizontal bar divided into three main sections. The first section is a shaded box labeled 'IMS Subscription Data'. The second section is labeled 'Service Profile' and contains three sub-boxes: 'Public id. data', 'Core Network Serv. Auth.', and 'App.&Serv. Filters'. The third section is a shaded box labeled 'App.&Serv. Filters'. + +Figure D.1: Example of in-line format of user profile + +**Figure D.1: Example of in-line format of user profile** + +If more than one service profile is created, for example to assign a different set of filters to public identifiers 1 and 2 and public identity 3, the information shall be packaged in the following way: + +![Figure D.2: Example of in-line format of user profile](dd6c544ab685b25dd17f59456efcfbfc_img.jpg) + +A diagram showing the high-level format of a user profile with multiple service profiles. It consists of a horizontal bar divided into three main sections. The first section is a shaded box labeled 'IMS Subscription Data'. The second section is labeled 'Service Profile 1' and contains four sub-boxes: 'Public id. 1', 'Public id. 2', 'CN Serv. Auth.', and 'A&S Filters'. The third section is labeled 'Service Profile 2' and contains three sub-boxes: 'Public id. 3', 'CN Serv. Auth.', and 'A&S Filters'. + +Figure D.2: Example of in-line format of user profile + +**Figure D.2: Example of in-line format of user profile** + +# --- Annex E (normative): XML schema for the Cx interface user profile + +The file CxDataType\_Rel11.xsd, attached to this specification, contains the XML schema for the user profile that is sent over the Cx interface. The user profile XML schema defines that are used in the user profile XML. The data that is allowed to be sent in the user profile may vary depending on the features supported by the Diameter end points, see TS 29.229 [5]. The user profile XML schema file is intended to be used by an XML parser. The version of the Cx application sending the user profile XML shall be the same as the version of the sent user profile XML and thus it implies the version of the user profile XML schema to be used to validate it. + +Table E.1 describes the data types and the dependencies among them that configure the user profile XML schema. + +Table E.1: XML schema for the Cx interface user profile: simple data types + +| Data type | Tag | Base type | Comments | +|---------------------------|--------------------------------------------------------------------------------|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| tPriority | Priority | integer | >= 0 | +| tProfilePartIndicator | ProfilePartIndicator | enumerated | Possible values:
0 (REGISTERED)
1 (UNREGISTERED) | +| tSharedIFCSetID | SharedIFCSetID | integer | >= 0 | +| tGroupID | Group | integer | >= 0 | +| tRegistrationType | RegistrationType | enumerated | Possible values:
0 (INITIAL_REGISTRATION)
1 (RE-REGISTRATION)
2 (DE-REGISTRATION) | +| tDefaultHandling | DefaultHandling | enumerated | Possible values:
0 (SESSION_CONTINUED)
1 (SESSION_TERMINATED) | +| tDirectionOfRequest | SessionCase | enumerated | Possible values:
0 (ORIGINATING_REGISTERED)
1 (TERMINATING_REGISTERED)
2 (TERMINATING_UNREGISTERED)
3 (ORIGINATING_UNREGISTERED)
4 (ORIGINATING_CDIV) | +| tPrivateID | PrivateID | anyURI | Syntax described in IETF RFC 2486 [14] | +| tSIP_URL | Identity | anyURI | Syntax described in IETF RFC 3261 [11] or 3GPP TS 23003 (See Note 1) | +| tTEL_URL | Identity | anyURI | Syntax described in IETF RFC 3966 [15] or 3GPP TS 23003 (See Note 1) | +| tIdentity | Identity | (union) | Union of tSIP_URL, and tTEL_URL | +| tIdentityType | IdentityType | enumerated | Possible values:
0 (DISTINCT_PUBLIC_USER_IDENTITY)
1 (DISTINCT_PSI)
2 (WILDCARDED_PSI) (See Note 2)
3 (NON_DISTINCT_IMPU) (See Note 3)
4 (WILDCARDED_IMPU) (See Note 4) | +| tServiceInfo | ServiceInfo | string | | +| tString | RequestURI, Method, Header, Content, Line, AccessType, AccessInfo, AccessValue | string | | +| tBool | ConditionTypeCNF, ConditionNegated, BarringIndication | boolean | Possible values:
0 (false)
1 (true) | +| tSubscribedMediaProfileId | SubscribedMediaProfileId | integer | >=0 | +| tDisplayName | DisplayName | string | | +| tAliasIdentityGroupID | AliasIdentityGroupID | string | | +| tServiceLevelTraceInfo | ServiceLevelTraceInfo | string | Syntax described in 3GPP TS 24.323 [32] | +| tServicePriorityLevel | ServicePriorityLevel | enumerated | Possible values:
0 (Highest priority)
1
2
3
4 (Lowest priority) | +| tPriorityNamespace | PriorityNamespace | string | Possible values are those of the namespaces that are defined in IETF RFC 4412 [22] or defined according to the IANA registration procedure described in IETF RFC 4412 [22] for Resource-Priority Namespaces. | +| tPriorityLevel | PriorityLevel | string | Possible values depend on the PriorityNamespace and are specified with the associated namespace that is defined in IETF RFC 4412 [22] or defined according to the IANA registration procedure described in IETF RFC 4412 [22] for Resource-Priority Namespaces | +| tIMSI | IMSI | string | Syntax described in 3GPP TS 23.003 [17]. ASCII encoded according to ANSI X3.4 [26]. | +| tMaxNumOfAllowedSi | MaxNumOfAllowedSi | integer | >= 1 | + +| | | | | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|--|--| +| multRegistrations | multRegistrations | | | +| NOTE 1: Only when the "Identity" tag is a Wildcarded Identity the syntax is described in 1 23.003 [17]. It applies to both WILDCARDED_IMPU and WILDCARDED_PSI. | | | | +| NOTE 2: Wildcarded PSI could optionally be included as well in tPublicIdentityExtension. | | | | +| NOTE 3: The IMPU is not explicitly provisioned in HSS. In this case, corresponding Wildcarded IMPU is included in tPublicIdentityExtension3. | | | | +| NOTE 4: WILDCARDED_IMPU indicates that the content of the identity in the "Identity" tag is a Wildcarded Public User Identity. In this case, Wildcarded IMPU could optionally be included as well in tPublicIdentityExtension3. | | | | + +Table E.2: XML schema for the Cx interface user profile: complex data types + +| Data type | Tag | Compound of | | | +|-----------------------------------|----------------------------------|----------------------------------|-----------------------------------|----------------------| +| | | Tag | Type | Cardinality | +| tIMSSubscription | IMSSubscription | PrivateID | tPrivateID | 1 | +| | | ServiceProfile | tServiceProfile | (1 to n) | +| | | Extension | tIMSSubscriptionExtension | (0 to 1) | +| tIMSSubscriptionExtension | Extension | IMSI | tIMSI | (0 to 1) | +| | | Extension | tIMSSubscriptionExtension2 | (0 to 1) | +| tIMSSubscriptionExtension2 | Extension | ReferenceLocationInformation | tReferenceLocationInformation | (0 to n)
(NOTE 5) | +| tReferenceLocationInformation | ReferenceLocationInformation | AccessType | tString (NOTE 4) | (0 to 1) | +| | | AccessInfo | tString (NOTE 4) | (0 to 1) | +| | | AccessValue | tString (NOTE 4) | (0 to 1) | +| tServiceProfile | ServiceProfile | PublicIdentity | tPublicIdentity | (1 to n) | +| | | CoreNetworkServicesAuthorization | CoreNetworkServicesAuthorization | (0 to 1) | +| | | InitialFilterCriteria | tInitialFilterCriteria | (0 to n) | +| | | Extension | tServiceProfileExtension | (0 to 1) | +| tServiceProfileExtension | Extension | SharedIFCSetID | tSharedIFCSetID | (0 to n) | +| tCoreNetworkServicesAuthorization | CoreNetworkServicesAuthorization | SubscribedMediaProfileId | tSubscribedMediaProfileId | (0 to 1) | +| | | Extension | tCNServicesAuthorizationExtension | (0 to 1) | +| tPublicIdentity | PublicIdentity | BarringIndication | tBool | (0 to 1) | +| | | Identity | tIdentity | 1 | +| | | Extension | tPublicIdentityExtension | (0 to 1) | +| tInitialFilterCriteria | InitialFilterCriteria | Priority | tPriority | 1 | +| | | TriggerPoint | tTrigger | (0 to 1) | +| | | ApplicationServer | tApplicationServer | 1 | +| | | ProfilePartIndicator | tProfilePartIndicator | (0 to 1) | +| | | ConditionTypeCNF | tBool | 1 | +| tTrigger | TriggerPoint | SPT | tSePoTri | (1 to n) | +| | | ConditionNegated | tBool | (0 to 1) | +| tSePoTri | SPT | Group | tGroupID | (1 to n) | +| | | Choice of | RequestURI | tString | +| | | | Method | tString | +| | | | SIPHeader | tHeader | +| | | | SessionCase | tDirectionOfRequest | +| | | | SessionDescription | tSessionDescription | +| | | Extension | tSePoTriExtension | (0 to 1) | +| tSePoTriExtension | Extension | RegistrationType | tRegistrationType | (0 to 2) | +| tHeader | SIPHeader | Header | tString | 1 | +| | | Content | tString | (0 to 1) | +| tSessionDescription | SessionDescription | Line | tString | 1 | +| | | Content | tString | (0 to 1) | +| tApplicationServer | ApplicationServer | ServerName | tSIP_URL | 1 | +| | | DefaultHandling | tDefaultHandling | (0 to 1) | +| | | ServiceInfo | tServiceInfo | (0 to 1) | +| | | Extension | tApplicationServerExtension | (0 to 1) | +| tApplicationServerExtension | Extension | IncludeRegisterRequest | tIncludeRegisterRequest | (0 to 1) | +| | | IncludeRegisterResponse | tIncludeRegisterResponse | (0 to 1) | + +| | | | | | +|-----------------------------------|--------------------------|------------------------------------|-------------------------------------|----------| +| tIncludeRegisterRequest | IncludeRegisterRequest | (NOTE 2) | (NOTE 2) | (0 to 1) | +| tIncludeRegisterResponse | tIncludeRegisterResponse | (NOTE 2) | (NOTE 2) | (0 to 1) | +| tPublicIdentityExtension | Extension | IdentityType | tIdentityType | (0 to 1) | +| | | WildcardedPSI | anyURI (NOTE 3) | (0 to 1) | +| | | Extension | tPublicIdentityExtension2 | (0 to 1) | +| tPublicIdentityExtension2 | Extension | DisplayName | tDisplayName | (0 to 1) | +| | | AliasIdentityGroupID | tAliasIdentityGroupID | (0 to 1) | +| | | Extension | tPublicIdentityExtension3 | (0 to 1) | +| tPublicIdentityExtension3 | Extension | WildcardedIMPU | anyURI (NOTE 3) | (0 to 1) | +| | | ServiceLevelTraceInfo | tServiceLevelTraceInfo | (0 to 1) | +| | | ServicePriorityLevel | tServicePriorityLevel | (0 to 1) | +| | | Extension | tPublicIdentityExtension4 | (0 to 1) | +| tPublicIdentityExtension4 | Extension | ExtendedPriority | tExtendedPriority | (0 to n) | +| | | Extension | tPublicIdentityExtension5 | (0 to 1) | +| tPublicIdentityExtension5 | Extension | MaxNumOfAllowedSimultRegistrations | tMaxNumOfAllowedSimultRegistrations | (0 to 1) | +| tExtendedPriority | ExtendedPriority | PriorityNamespace | tPriorityNamespace | 1 | +| | | PriorityLevel | tPriorityLevel | 1 | +| tCNServicesAuthorizationExtension | Extension | ListOfServiceIds | tListOfServiceIds | (0 to 1) | +| tListOfServiceIds | ListOfServiceIds | ServiceId | tString | (0 to n) | + +NOTE 1: "n" shall be interpreted as non-bounded. +NOTE 2: empty cells shall be interpreted as complex XML elements without defined content. +NOTE 3: the syntax of Wildcarded Public User Identity and Wildcarded Service Identity shall be as described in 3GPP TS 23.003 [17]. +NOTE 4: the syntax of AccessType, AccessInfo and AccessValue is as described in 3GPP TS 24.229 [8] for P-Access-Network-Info header fields: AccessType corresponds to the "access-type" field whereas AccessInfo and AccessValue correspond to the type and associated value defined for the "access-info" field. +NOTE 5: the HSS shall not send more than one instance of ReferenceLocationInformation and if the S-CSCF receives more than one instance of ReferenceLocationInformation it may arbitrarily pick one for further processing. + +# Annex F (normative): Definition of parameters for service point trigger matching + +Table F.1 defines the parameters that are transported in the user profile XML. + +**Table F.1: Definition of parameters in the user profile XML** + +| Tag | Description | +|---------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| RequestURI | RequestURI tag shall include a regular expression in a form of Extended Regular Expressions (ERE) as defined in chapter 9 in IEEE 1003.1-2004 Part 1 [13]. For SIP URI, the regular expression shall be matched against the hostport of the SIP-URI. For definition of SIP-URI and hostport, see IETF RFC 3261 [11]. For Tel URI, the regular expression shall be matched against the telephone-subscriber of the telephone-uri. For definition of telephone-subscriber and telephone-uri, see IETF RFC 3966 [15]. | +| SIPHeader | A SIP Header SPT shall be evaluated separately against each header instance within the SIP message. The SIP Header SPT matches if at least one header occurrence matches the SPT. | +| Header (of SIPHeader) | Header tag shall include a regular expression in a form of Extended Regular Expressions (ERE) as defined in chapter 9 in IEEE 1003.1-2004 Part 1 [13]. The regular expression shall be matched against the header-name of the SIP header. For definition of header and header-name, see IETF RFC 3261 [11]. Before matching the header-name to the pattern, all SWSs shall be removed from the header-name and all LWSs in the header-name shall be reduced to a single white space character (SP). For definition of SWS and LWS, see IETF RFC 3261 [11]. | +| Content (of SIPHeader) | Content tag shall include a regular expression in a form of Extended Regular Expressions (ERE) as defined in chapter 9 in IEEE 1003.1-2004 Part 1 [13]. The regular expression shall be matched against the header-value of the SIP header. For definition of header and header-value, see IETF RFC 3261 [11]. If the SIP header contains several header-values in a comma-separated list, each of the header-value shall be matched against the pattern for the Content separately. Before matching the header-value to the pattern, all SWSs shall be removed from the header-value and all LWSs in the header-value shall be reduced to a single white space character (SP). For definition of SWS and LWS, see IETF RFC 3261 [11]. | +| SessionDescription | A Session Description SPT shall be evaluated separately against each SDP field instance within the SIP message. The Session Description SPT matches if at least one field occurrence matches the SPT. | +| Line (of SessionDescription) | Line tag shall include a regular expression in a form of Extended Regular Expressions (ERE) as defined in chapter 9 in IEEE 1003.1-2004 Part 1 [13]. The regular expression shall be matched against the type of the field inside the session description. For definition of type, see chapter 6 in IETF RFC 4566 [12]. | +| Content (of SessionDescription) | Content tag shall include a regular expression in a form of Extended Regular Expressions (ERE) as defined in chapter 9 in IEEE 1003.1-2004 Part 1 [13]. The regular expression shall be matched against the value of the field inside the session description. For definition of value, see chapter 6 in IETF RFC 4566 [12]. | + +# Annex G (normative): Emergency registrations + +S-CSCF and HSS shall handle emergency registrations as normal registrations with the following considerations: + +- Upon emergency registration, following cases apply: + - If a normal registration for the same user does not exist, the S-CSCF shall download corresponding user profile from HSS, ensure that the HSS allocates S-CSCF name to this subscriber and the registration status is set to UNREGISTERED. + - Otherwise, the S-CSCF shall ensure that the registration status of the user is not changed in the HSS. +- Upon deregistration or expiration of the last normal session, if an emergency registration is still active for this subscriber, the S-CSCF shall ensure that the HSS keeps S-CSCF name allocated to this subscriber and the registration status is set to UNREGISTERED. + +- Upon expiration of an emergency registration, the S-CSCF shall ensure the registration status of the user is not changed in the HSS if there are other normal registrations of the user. Otherwise, the S-CSCF may send SAR to the HSS to remove its name and set the registration status of the user to NOT REGISTERED. +- IMS Restoration procedures do not apply for IMS emergency sessions. + +# --- Annex H (normative): Diameter overload control mechanism + +## H.1 General + +Diameter overload control mechanism is an optional feature. + +IETF RFC 7683 [24] specifies a Diameter overload control mechanism which includes the definition and the transfer of related AVPs between Diameter nodes. + +It is recommended to make use of IETF RFC 7683 [24] on the Cx interface where, when applied, the I/S-CSCF shall behave as reacting nodes and the HSS as a reporting node. + +Depending on regional/national requirements and network operator policy, priority traffic (e.g. MPS as described in TS 22.153 [25]) shall be exempted from throttling due to Diameter overload control up to the point where requested traffic reduction cannot be achieved without throttling the priority traffic. + +## H.2 HSS behaviour + +The HSS requests traffic reduction from the I/S-CSCF when the HSS is in an overload situation, including OC-OLR AVP in answer commands as described in IETF RFC 7683 [24]. + +The HSS identifies that it is in an overload situation by implementation specific means. For example, the HSS may take into account the traffic over the Cx interfaces or other interfaces, the level of usage of internal resources (CPU, memory), the access to external resources, etc. + +The HSS determines the specific contents of OC-OLR AVP in overload reports and the HSS decides when to send OC-OLR AVPs by implementation specific means. + +## H.3 I/S-CSCF behaviour + +The I/S-CSCF applies required traffic reduction received in answer commands to subsequent applicable requests, as per IETF RFC 7683 [24]. + +The I/S-CSCF achieves requested traffic reduction by implementation specific means. For example, the I/S-CSCF may implement message throttling with prioritization or a message retaining mechanism for operations that can be postponed. + +Diameter requests related to priority traffic (e.g. MPS) and emergency, detected via the presence of priority information (e.g., Resource-Priority header field for MPS) in SIP messages as described in TS 24.229 [8], have the highest priority. Depending on regional/national regulatory and operator policies, these Diameter requests shall be the last to be throttled, when the I/S-CSCF has to apply traffic reduction. Relative priority amongst various priority traffic (e.g. MPS) and emergency traffic is subject to regional/national regulatory and operator policies. + +# --- Annex I (Informative): Diameter overload node behaviour + +## I.1 Message prioritization + +This clause describes possible behaviours of the I/S-CSCF regarding message prioritisation in an informative purpose. + +The I/S-CSCF may take the following into account when making throttling decisions: + +- Identification of the procedures that can be deferred (e.g. Deregistration Request), so to avoid to drop non deferrable procedures; +- Prioritisation of certain types of request (e.g. between MAR and SAR for S-CSCF, and between LIR and UAR for I-CSCF) according to the context of their use, in particular: + - Higher prioritisation of SAR commands for S-CSCF that are related to a registered user for a service, so to avoid the interruption of the registered service for the user; + - Higher prioritisation of LIR commands for I-CSCF that are related to a requested service different from registration or deregistration, so to get more originating or terminating services provided to the user; +- Skipping of optional authentication. +- Priority level of a priority user (e.g., MPS user). + +# --- Annex J (normative): Diameter message priority mechanism + +## J.1 General + +IETF RFC 7944 [27] specifies a Diameter message priority mechanism that allows Diameter nodes to indicate the relative priority of Diameter messages. With this information, other Diameter nodes may leverage the relative priority of Diameter messages into routing, resource allocation, set the DSCP marking for transport of the associated Diameter message, and also abatement decisions when overload control is applied. + +## J.2 Cx/Dx interfaces + +### J.2.1 General + +The Diameter message priority mechanism is an optional feature. + +It is recommended to make use of IETF RFC 7944 [27] over the Cx/Dx interfaces of an operator network when the overload control defined in Annex H is applied on these Cx/Dx interfaces. + +### J.2.2 S-CSCF/I-CSCF behaviour + +When the S-CSCF/I-CSCF supports the Diameter message priority mechanism, the S-CSCF/I-CSCF shall comply with IETF RFC 7944 [27]. + +The S-CSCF/I-CSCF sending a request shall determine the required priority according to its policies. When priority is required, the S-CSCF/I-CSCF shall include the DRMP AVP indicating the required priority level in the request it sends, and shall prioritise the request according to the required priority level. + +When the S-CSCF/I-CSCF receives the corresponding response, it shall prioritise the received response according to the priority level received within the DRMP AVP if present in the response, otherwise according to the priority level of the corresponding request. + +When the S-CSCF/I-CSCF receives a request, it shall handle the request according to the received DRMP AVP priority level. For the response, it may modify the priority level received in the DRMP AVP according to its policies and shall handle the response according to the required priority level. If the required priority level is different from the priority level received in the request, it shall include the DRMP AVP in the response. + +If: + +- the S-CSCF/I-CSCF supports using the Diameter message priority mechanism for DSCP marking purposes, +- the transport network utilizes DSCP marking, and +- message-dependant DSCP marking is possible for the protocol stack transporting Diameter, + +then the S-CSCF/I-CSCF shall set the DSCP marking for transport of the request or response according to the required priority level. + +Diameter requests related to priority traffic (e.g. MPS as identified by the S-CSCF/I-CSCF through SIP procedures, emergency) shall contain a DRMP AVP with a high priority of which the level value is operator dependent. + +When not-explicitly requested, the inclusion and priority value of the DRMP AVP in Diameter messages are implementation specific. + +### J.2.3 HSS/SLF behaviour + +When the HSS/SLF supports the Diameter message priority mechanism, the HSS/SLF shall comply with IETF RFC 7944 [27]. + +The HSS/SLF sending a request shall determine the required priority according to its policies. When priority is required, the HSS/SLF shall include the DRMP AVP indicating the required priority level in the request it sends, and shall prioritise the request according to the required priority level. + +When the HSS/SLF receives the corresponding response, it shall prioritise the received response according to the priority level received within the DRMP AVP if present in the response, otherwise according to the priority level of the corresponding request. + +When the HSS/SLF receives a request, it shall handle the request according to the received DRMP AVP priority level. For the response, it may modify the priority level received in the DRMP AVP according to its policies and shall handle the response according to the required priority level. If the required priority level is different from the priority level received in the request, it shall include the DRMP AVP in the response. + +If: + +- the HSS/SLF supports using the Diameter message priority mechanism for DSCP marking purposes, +- the transport network utilizes DSCP marking, and +- message-dependant DSCP marking is possible for the protocol stack transporting Diameter, + +then the HSS/SLF shall set the DSCP marking for transport of the request or response according to the required priority level. + +When not-explicitly requested, the inclusion and priority value of the DRMP AVP in Diameter messages are implementation specific. + +### J.2.4 Interactions + +If the HSS supporting the Diameter message priority mechanism receives the request message containing both the Session-Priority AVP and DRMP AVP, the HSS shall prioritize the request according to priority level received within the DRMP AVP. + +# --- Annex K (normative): Diameter load control mechanism + +## K.1 General + +The Diameter load control mechanism is an optional feature. + +It is recommended to make use of IETF IETF RFC 8583 [29] on the Cx interface where, when applied, the I-CSCF and the S-CSCF shall behave as reacting nodes and the HSS as a reporting node. + +## K.2 HSS behaviour + +The HSS may report its current load by including a Load AVP of type HOST in answer commands as described in IETF IETF RFC 8583 [29]. + +The HSS calculates its current load by implementation specific means. For example, the HSS may take into account the traffic over the Cx interface or other interfaces, the level of usage of internal resources (e.g. CPU, memory), the access to external resources, etc. + +The HSS determines when to send Load AVPs of type HOST by implementation specific means. + +## K.3 I-CSCF/S-CSCF behaviour + +When performing next hop Diameter Agent selection for requests that are routed based on realm, the I-CSCF/S-CSCF may take into account load values from Load AVPs of type PEER received from candidate next hop Diameter nodes, as per IETF IETF RFC 8583 [29]. + +# Annex L (informative): Change history + +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | New | +|----------|-------|-----------|-----|-----|----------------------------------------------------------------------------------------------------------|-------| +| Jun 2002 | CN#16 | NP-020264 | | | Version 2.0.0 approved at CN#16 | 5.0.0 | +| Sep 2002 | CN#17 | NP-020449 | 001 | 2 | Clarification of implicit registration | 5.1.0 | +| Sep 2002 | CN#17 | NP-020449 | 002 | 1 | Clarification of user registration status query | 5.1.0 | +| Sep 2002 | CN#17 | NP-020449 | 003 | 1 | Clarification of HSS initiated update of user profile | 5.1.0 | +| Sep 2002 | CN#17 | NP-020449 | 004 | 2 | Clarification of MAR command | 5.1.0 | +| Sep 2002 | CN#17 | NP-020449 | 005 | 1 | Conditionality of the SIP-Auth-Data-Item in MAA command | 5.1.0 | +| Dec 2002 | CN#18 | NP-020587 | 008 | 2 | Rejection of registration of a Temporary Public Identity without active implicit registration | 5.2.0 | +| Dec 2002 | CN#18 | NP-020587 | 010 | - | Removal of upper bounds in Cx i/f user profile | 5.2.0 | +| Dec 2002 | CN#18 | NP-020587 | 011 | - | S-CSCF Assignment | 5.2.0 | +| Dec 2002 | CN#18 | NP-020587 | 012 | - | NAS-Session-Key AVPs in MAA command | 5.2.0 | +| Dec 2002 | CN#18 | NP-020587 | 013 | 1 | Correction to detailed behaviour of user registration status query | 5.2.0 | +| Dec 2002 | CN#18 | NP-020587 | 014 | 1 | Removing the DDF dependencies from Cx interface | 5.2.0 | +| Dec 2002 | CN#18 | NP-020587 | 015 | 1 | Clarification of SERVER_CHANGE de-registration reason code | 5.2.0 | +| Dec 2002 | CN#18 | NP-020589 | 016 | 1 | Clarification of User-Authorization-Type AVP usage within the UAR | 5.2.0 | +| Dec 2002 | CN#18 | NP-020587 | 017 | 1 | Correction to HSS initiated update of user profile | 5.2.0 | +| Dec 2002 | CN#18 | NP-020588 | 019 | - | Correction in charging information | 5.2.0 | +| Dec 2002 | CN#18 | NP-020590 | 020 | 1 | Error handling in S-CSCF when receiving too much data | 5.2.0 | +| Dec 2002 | CN#18 | NP-020587 | 021 | 1 | Re-allocation of S-CSCF | 5.2.0 | +| Dec 2002 | CN#18 | NP-020591 | 022 | - | Correction of the SPI | 5.2.0 | +| Mar 2003 | CN#19 | NP-030101 | 025 | 1 | Clarification of service profile download at service profile modification | 5.3.0 | +| Mar 2003 | CN#19 | NP-030101 | 028 | - | Filter ID field removal in InitialFilterCriteria class | 5.3.0 | +| Mar 2003 | CN#19 | NP-030101 | 030 | 1 | Clarification of IMPU barring handling | 5.3.0 | +| Mar 2003 | CN#19 | NP-030101 | 032 | 1 | The default public user identity in the Server-Assignment-Answer | 5.3.0 | +| Mar 2003 | CN#19 | NP-030101 | 034 | 2 | Corrections to service profile | 5.3.0 | +| Mar 2003 | CN#19 | NP-030101 | 037 | 3 | Handling of non supported data in the S-CSCF when the profile is being updated | 5.3.0 | +| Mar 2003 | CN#19 | NP-030101 | 024 | 1 | Clarification of the HSS behaviour in REGISTRATION and DE REGISTRATION procedures at IMPU checking time. | 5.3.0 | +| Mar 2003 | CN#19 | NP-030101 | 027 | - | Deletion of Annex F | 5.3.0 | +| Mar 2003 | CN#19 | NP-030101 | 029 | - | Clarification of User-Authorization-Type AVP usage within UAR | 5.3.0 | +| Mar 2003 | CN#19 | NP-030101 | 031 | 1 | Update TS 29.228 after Diameter has become RFC | 5.3.0 | +| Mar 2003 | CN#19 | NP-030101 | 033 | 1 | Replacement of the NAS-Session-Key AVP | 5.3.0 | +| Mar 2003 | CN#19 | NP-030101 | 035 | 2 | Clarification on Re-allocation of S-CSCF | 5.3.0 | +| Mar 2003 | CN#19 | NP-030101 | 038 | 1 | Change of SPI to SPT | 5.3.0 | +| Mar 2003 | CN#19 | NP-030101 | 040 | 1 | Definition of the Subscribed Media Profile Identifier | 5.3.0 | +| Mar 2003 | CN#19 | NP-030101 | 026 | - | Error in definition of Service Point of Interest class | 5.3.0 | +| Jun 2003 | CN#20 | NP-030215 | 043 | - | Correct use of the Result-Code AVP | 5.4.0 | +| Jun 2003 | CN#20 | NP-030215 | 044 | 1 | Conditionality of User-Name AVP in Server-Assignment-Answer | 5.4.0 | +| Jun 2003 | CN#20 | NP-030215 | 045 | 2 | Corrections to the base 64 encoding examples | 5.4.0 | +| Jun 2003 | CN#20 | NP-030215 | 046 | 1 | Deregistration of implicitly registered public user identities | 5.4.0 | +| Jun 2003 | CN#20 | NP-030215 | 047 | - | Clarification on the Server-Assignment-Type NO_ASSIGNMENT | 5.4.0 | +| Jun 2003 | CN#20 | NP-030215 | 048 | 1 | Incorrect use of result-code | 5.4.0 | +| Jun 2003 | CN#20 | NP-030215 | 049 | 1 | Misalignment in the Public-User-Identity IE | 5.4.0 | +| Jun 2003 | CN#20 | NP-030215 | 050 | 1 | Duplicated Destination-Host AVP within MAR command code | 5.4.0 | +| Sep 2003 | CN#21 | NP-030383 | 042 | 3 | Error in S-CSCF Assignment Type | 5.5.0 | +| Sep 2003 | CN#21 | NP-030383 | 051 | 2 | Mistakes in the XML schema of 29.228-540 | 5.5.0 | +| Sep 2003 | CN#21 | NP-030383 | 055 | 1 | Extensibility of the public identity structure in the XML schema | 5.5.0 | +| Sep 2003 | CN#21 | NP-030394 | 041 | 2 | Introduction of Presence Stage 3 (Px) to the Cx interface | 6.0.0 | +| Sep 2003 | CN#21 | NP-030394 | 052 | - | Sharing public identities across multiple UEs | 6.0.0 | +| Dec 2003 | CN#22 | NP-030585 | 057 | 3 | Conditions for inclusion of Charging Information | 6.1.0 | +| Dec 2003 | CN#22 | NP-030500 | 060 | 1 | MAR in synchronisation failure case | 6.1.0 | +| Dec 2003 | CN#22 | NP-030500 | 061 | 1 | The S-CSCF name needs to be checked always in MAR | 6.1.0 | +| Dec 2003 | CN#22 | NP-030500 | 063 | - | Conditional AVPs in answer commands | 6.1.0 | +| Dec 2003 | CN#22 | NP-030500 | 065 | 1 | Server-Assignment-Request | 6.1.0 | +| Dec 2003 | CN#22 | NP-030500 | 067 | - | Determination of User-Authorization-Type AVP based on registration expiration | 6.1.0 | +| Dec 2003 | CN#22 | NP-030500 | 069 | 2 | Not registered state after deregistration with S-CSCF deleted at the HSS | 6.1.0 | +| Dec 2003 | CN#22 | NP-030500 | 071 | - | The extensibility of the XML schema | 6.1.0 | +| Dec 2003 | CN#22 | | | - | Reference [9] updated | 6.1.0 | +| Mar 2004 | CN#23 | NP-040046 | 077 | 1 | Clarification on S-CSCF-Name comparison | 6.2.0 | +| Mar 2004 | CN#23 | NP-040055 | 081 | - | Error for missing identification in SAR command | 6.2.0 | +| Mar 2004 | CN#23 | NP-040046 | 085 | 1 | Conditions for inclusion of Public Identity in SAR | 6.2.0 | +| Mar 2004 | CN#23 | NP-040046 | 087 | 1 | Correction to sending the Charging-Information AVP | 6.2.0 | + +| | | | | | | | +|----------|-------|-----------|------|---|-------------------------------------------------------------------------------------------------|-------| +| Mar 2004 | CN#23 | NP-040046 | 089 | - | Correction to User-Authorization-Answer | 6.2.0 | +| Mar 2004 | CN#23 | NP-040046 | 091 | - | Default handling of error cases during IMS registration | 6.2.0 | +| Jun 2004 | CN#24 | NP-040215 | 097 | 2 | Update of the charging addresses from HSS | 6.3.0 | +| Jun 2004 | CN#24 | NP-040215 | 095 | 1 | Content of the User Profile | 6.3.0 | +| Jun 2004 | CN#24 | NP-040215 | 099 | - | Correction of SessionCase attribute ambiguity | 6.3.0 | +| Sep 2004 | CN#25 | NP-040416 | 109 | 1 | LIR and services related to unregistered state | 6.4.0 | +| Sep 2004 | CN#25 | NP-040401 | 121 | 2 | Triggering initial REGISTER messages | 6.4.0 | +| Sep 2004 | CN#25 | NP-040401 | 118 | 1 | XML versioning | 6.4.0 | +| Sep 2004 | CN#25 | NP-040401 | 122 | 1 | Optimization of User Profile Download | 6.4.0 | +| Sep 2004 | CN#25 | NP-040396 | 124 | 2 | Simplification of the User Profile Split concept | 6.4.0 | +| Sep 2004 | CN#25 | NP-040416 | 120 | 3 | Use of regular expressions | 6.4.0 | +| Dec 2004 | CN#26 | NP-040523 | 138 | 1 | HSS initiated deregistration with "not registered" registration state | 6.5.0 | +| Dec 2004 | CN#26 | NP-040530 | 140 | 1 | HSS initiated deregistration with user profile removal for permanent termination | 6.5.0 | +| Dec 2004 | CN#26 | NP-040523 | 142 | 2 | HSS initiated deregistration using the network initiated de-registration procedure | 6.5.0 | +| Dec 2004 | CN#26 | NP-040530 | 146 | 1 | Clarification of R6 authentication scheme | 6.5.0 | +| Dec 2004 | CN#26 | NP-040523 | 150 | - | Regular Expressions | 6.5.0 | +| Dec 2004 | CN#26 | NP-040530 | 155 | - | Correction to XML Root Element | 6.5.0 | +| Dec 2004 | CN#26 | NP-040530 | 156 | 1 | Modification of User-Data-Already-Available in SAR command. | 6.5.0 | +| Dec 2004 | CN#26 | NP-040523 | 159 | 2 | Handling of Information Element marked as (M), (C) or (O) | 6.5.0 | +| Mar 2005 | CN#27 | NP-050030 | 166 | - | Avoiding undesired deregistration | 6.6.0 | +| Mar 2005 | CN#27 | NP-050030 | 168 | 1 | Correction to authentication procedures in not registered case | 6.6.0 | +| Mar 2005 | CN#27 | NP-050037 | 170 | 3 | Clarification of behaviour for Shared Public User Identities | 6.6.0 | +| Mar 2005 | CN#27 | NP-050037 | 172 | - | Distribution of Cipher Key and Integrity Key | 6.6.0 | +| Apr 2005 | | | | | Editorial correction on figure figure A.4.1.1 and on clauses: 6.1.4.1, 6.2.2, B.2.1 and 6.2.1.1 | 6.6.1 | +| Jun 2005 | CT#28 | CP-050086 | 181 | - | TEL-URI reference correction | 6.7.0 | +| Jun 2005 | CT#28 | CP-050086 | 183 | - | Clarification on Server Capabilities | 6.7.0 | +| Jun 2005 | CT#28 | CP-050086 | 185 | - | Incorrect Implementation of CR172 | 6.7.0 | +| Jun 2005 | CT#28 | CP-050081 | 188 | 1 | Clarification of the content of SIP-Authentication-Context | 6.7.0 | +| Jun 2005 | CT#28 | CP-050086 | 192 | - | Syntax correction for XML | 6.7.0 | +| Sep 2005 | CT#29 | CP-050422 | 196 | - | Authentication Registration with synchronization failure, Data requested from HSS | 6.8.0 | +| Sep 2005 | CT#29 | CP-050296 | 200 | - | Correction to XML Schema for SharedIFCSet | 6.8.0 | +| Sep 2005 | CT#29 | CP-050440 | 202 | 2 | Private identities on the Cx | 6.8.0 | +| Sep 2005 | CT#29 | CP-050282 | 204 | 1 | Charging-Information correction | 6.8.0 | +| Sep 2005 | CT#29 | CP-050296 | 207 | 1 | Corrections to UAR and LIR for shared public identities | 6.8.0 | +| Sep 2005 | CT#29 | CP-050422 | 208 | 1 | Behaviour of the Implicit Registration Set for the Unregistered state | 6.8.0 | +| Sep 2005 | CT#29 | CP-050296 | 210 | - | Change of stage 2 reference from Release 5 to Release 6 | 6.8.0 | +| Sep 2005 | CT#29 | CP-050294 | 211 | - | PSI Activation | 6.8.0 | +| Sep 2005 | CT#29 | CP-050271 | 213 | 2 | Removal of redundant restrictions for one Public User Identity in SAR | 6.8.0 | +| Sep 2005 | CT#29 | CP-050296 | 216 | - | Error code clean up | 6.8.0 | +| Sep 2005 | CT#29 | CP-050296 | 217 | 1 | Clarification of User Profile update | 6.8.0 | +| Dec 2005 | CT#30 | CP-050604 | 198 | 5 | XML syntax correction | 6.9.0 | +| Dec 2005 | CT#30 | CP-050611 | 220 | 1 | PSI impacts on the Cx Interface | 6.9.0 | +| Dec 2005 | CT#30 | CP-050611 | 221 | 3 | Routing for PSIs Matching a Wildcarded PSI | 6.9.0 | +| Dec 2005 | CT#30 | CP-050611 | 222 | 2 | Removal of overhead in Private Identities handling in RTR | 6.9.0 | +| Dec 2005 | CT#30 | CP-050605 | 229 | 2 | Use-Data description corrections | 6.9.0 | +| Dec 2005 | CT#30 | CP-050605 | 232 | 2 | S-CSCF assignment checking for notregistered state | 6.9.0 | +| Dec 2005 | CT#30 | CP-050605 | 236 | 4 | RTR correction | 6.9.0 | +| Dec 2005 | CT#30 | CP-050605 | 238 | 1 | PPR correction | 6.9.0 | +| Dec 2005 | CT#30 | CP-050611 | 239 | 1 | Private User Id in RTR | 6.9.0 | +| Dec 2005 | CT#30 | CP-050611 | 246 | 1 | Server capabilities associations with features | 6.9.0 | +| Dec 2005 | CT#30 | | | | Rel-7 version was created because of ETSI TISPAN references. | 7.0.0 | +| Mar 2006 | CT#31 | CP-060084 | 0243 | 1 | SPT for mobile orig unregistered | 7.1.0 | +| Mar 2006 | CT#31 | CP-060159 | 0247 | 2 | Removal of the terms Mobile Originated and Mobile Terminated | 7.1.0 | +| Mar 2006 | CT#31 | CP-060154 | 0254 | - | Alignment of Annex E with .xsd file | 7.1.0 | +| Mar 2006 | CT#31 | CP-060154 | 0256 | - | Incorrect implementation of CR 0198 | 7.1.0 | +| Mar 2006 | CT#31 | CP-060065 | 0260 | 2 | Handling of unknown errors | 7.1.0 | +| Mar 2006 | CT#31 | CP-060154 | 0263 | 2 | Private User ID in PPR and RTR | 7.1.0 | +| Mar 2006 | CT#31 | CP-060065 | 0269 | - | Message flow correction | 7.1.0 | +| Mar 2006 | CT#31 | CP-060065 | 0274 | - | Default public-id and PPR | 7.1.0 | +| Jun 2006 | CT#32 | CP-060302 | 0285 | - | S-CSCF reselection removal | 7.2.0 | +| Jun 2006 | CT#32 | CP-060308 | 0290 | 3 | Correction of the normative text in the table 6.7 | 7.2.0 | +| Jun 2006 | CT#32 | CP-060308 | 0292 | 2 | Using SiFC feature to define optional S-CSCF capabilities | 7.2.0 | +| Sep 2006 | CT#33 | CP-060308 | 0296 | - | S-CSCF assignment correction | 7.3.0 | +| Sep 2006 | CT#33 | CP-060405 | 0299 | - | Default Public User ID either SIP URI or tel URI | 7.3.0 | +| Sep 2006 | CT#33 | CP-060399 | 0304 | 1 | Barring Indication for public user identity | 7.3.0 | +| Sep 2006 | CT#33 | CP-060417 | 0306 | 2 | Deletion of description about Authentication-Data-Item | 7.3.0 | +| Sep 2006 | CT#33 | CP-060399 | 0313 | 1 | Registration message flow correction | 7.3.0 | +| Sep 2006 | CT#33 | CP-060417 | 0314 | 4 | AS originating requests on behalf of a user | 7.3.0 | + +| | | | | | | | +|----------|-------|-----------|------|---|---------------------------------------------------------------------------------|-------| +| Sep 2006 | CT#33 | CP-060416 | 0317 | 2 | Allowing a Display Name to be associated with a Public Identity. | 7.3.0 | +| Sep 2006 | CT#33 | CP-060417 | 0320 | - | Update of the Table 6.7 "Guidelines for S-CSCF Capabilities" | 7.3.0 | +| Dec 2006 | CT#34 | CP-060553 | 0325 | 1 | SDP reference correction | 7.4.0 | +| Dec 2006 | CT#34 | CP-060566 | 0326 | 1 | New message flow about AS originating session | 7.4.0 | +| Dec 2006 | CT#34 | CP-060566 | 0327 | 1 | Correction of Private Identity description in SAR | 7.4.0 | +| Dec 2006 | CT#34 | CP-060566 | 0330 | 3 | Correction of error code in SAA | 7.4.0 | +| Dec 2006 | CT#34 | CP-060566 | 0332 | 1 | Clarification on use of Authentication pending flag | 7.4.0 | +| Dec 2006 | CT#34 | CP-060566 | 0336 | 3 | Optimization of handling of Wildcarded PSIs | 7.4.0 | +| Dec 2006 | CT#34 | CP-060555 | 0338 | 1 | Wildcarded PSI as key in PPR | 7.4.0 | +| Dec 2006 | CT#34 | CP-060553 | 0342 | 1 | Correction of the HSS behaviour in UAR/UAA command pair | 7.4.0 | +| Dec 2006 | CT#34 | CP-060735 | 0343 | 3 | Clarification regarding URI canonicalization – 29.228 | 7.4.0 | +| Mar 2007 | CT#35 | CP-070020 | 0346 | 3 | Clarification of the server name in LIA | 7.5.0 | +| Mar 2007 | CT#35 | CP-070020 | 0350 | 3 | User profile data synchronisation | 7.5.0 | +| Mar 2007 | CT#35 | CP-070020 | 0352 | - | SAA result code correction | 7.5.0 | +| Mar 2007 | CT#35 | CP-070019 | 0353 | 2 | Removal of roaming restrictions for Emergency Registrations | 7.5.0 | +| Mar 2007 | CT#35 | CP-070020 | 0354 | - | Definition and use of the Wildcarded PSI information element | 7.5.0 | +| Jun 2007 | CT#36 | CP-070309 | 0358 | 1 | Removal of editor's note on IMS Recovery Procedures | 7.6.0 | +| Jun 2007 | CT#36 | CP-070479 | 0359 | 2 | Impacts of the IMS Communication Service Identifier | 7.6.0 | +| Jun 2007 | CT#36 | CP-070309 | 0361 | 2 | Clarification on LIA | 7.6.0 | +| Jun 2007 | CT#36 | CP-070309 | 0365 | 1 | Adding User-Authorization-Type is absent condition to UAR Detailed behaviour | 7.6.0 | +| Jun 2007 | CT#36 | CP-070312 | 0367 | - | Modification to the tag RegistrationType to RegistrationType in the Annex E | 7.6.0 | +| Sep 2007 | CT#37 | CP-070520 | 0374 | 1 | Authentication failure and timeout handling | 7.7.0 | +| Sep 2007 | CT#37 | CP-070522 | 0378 | - | Incorrect implemented CR 120r3 | 7.7.0 | +| Sep 2007 | CT#37 | CP-070527 | 0379 | - | User Data Already Available | 7.7.0 | +| Nov 2007 | CT#38 | CP-070743 | 0388 | 1 | Handling of USER_UNKNOWN and NOT_SUPPORTED_USER_DATA error in PPA | 7.8.0 | +| Nov 2007 | CT#38 | CP-070744 | 0392 | 2 | Alias | 7.8.0 | +| Nov 2007 | CT#38 | CP-070755 | 0376 | 6 | Updates to 29.228 for Digest on the Cx Interface | 8.0.0 | +| Mar 2008 | CT#39 | CP-080019 | 0393 | 1 | IMS Restoration after an S-CSCF failure | 8.1.0 | +| Mar 2008 | CT#39 | CP-080022 | 0395 | 2 | Update for Supporting NASS-Bundled-Authentication | 8.1.0 | +| Mar 2008 | CT#39 | CP-080019 | 0398 | - | SIP Digest password push | 8.1.0 | +| Mar 2008 | CT#39 | CP-080019 | 0400 | 1 | Wildcarded Public User Identities | 8.1.0 | +| Jun 2008 | CT#40 | CP-080261 | 0399 | 3 | Originating services after call forwarding | 8.2.0 | +| Jun 2008 | CT#40 | CP-080261 | 0406 | - | XML example | 8.2.0 | +| Jun 2008 | CT#40 | CP-080267 | 0408 | - | Emergency Registration for REGISTRATION AND CAPABILITIES | 8.2.0 | +| Jun 2008 | CT#40 | CP-080267 | 0410 | - | Removal of restriction for barred user at Emergency Registrations | 8.2.0 | +| Sep 2008 | CT#41 | CP-080456 | 0413 | 2 | Emergency Public User Identity removal | 8.3.0 | +| Sep 2008 | CT#41 | CP-080460 | 0420 | 1 | Support of "Loose-Route" indication from HSS | 8.3.0 | +| Sep 2008 | CT#41 | CP-080463 | 0421 | - | Cx Impacts of IMS Restoration Procedures | 8.3.0 | +| Sep 2008 | CT#41 | CP-080460 | 0423 | 2 | Filter Criteria enhancement for 3rd party REGISTER | 8.3.0 | +| Sep 2008 | CT#41 | CP-080463 | 0425 | 1 | Addition of Registered Private Identities in SAA | 8.3.0 | +| Sep 2008 | CT#41 | CP-080460 | 0426 | 1 | Add Assigned S-CSCF name to SAA | 8.3.0 | +| Dec 2008 | CT#42 | CP-080698 | 0427 | 2 | Service Restoration for Registered IMPU | 8.4.0 | +| Dec 2008 | CT#42 | CP-080707 | 0431 | 2 | Support for IMS Service Level Trace | 8.4.0 | +| Dec 2008 | CT#42 | CP-080708 | 0432 | - | Removal of Digest Domain | 8.4.0 | +| Dec 2008 | CT#42 | CP-080696 | 0433 | 3 | Diameter Proxy Agent - an alternative User Identity to HSS resolution mechanism | 8.4.0 | +| Dec 2008 | CT#42 | CP-080708 | 0434 | 2 | S-CSCF and AS procedures with Enhanced Filter Criteria | 8.4.0 | +| Mar 2009 | CT#43 | CP-090023 | 0435 | 1 | Priority Service | 8.5.0 | +| Mar 2009 | CT#43 | CP-090026 | 0436 | 1 | Multiple Registrations in Registration | 8.5.0 | +| Mar 2009 | CT#43 | CP-090036 | 0440 | 2 | HSS Addresses | 8.5.0 | +| Mar 2009 | CT#43 | CP-090025 | 0441 | 1 | Loose Route Indication | 8.5.0 | +| Mar 2009 | CT#43 | CP-090028 | 0442 | 2 | Support for GPRS IMS Bundled Authentication (GIBA) in Cx | 8.5.0 | +| Sep 2009 | CT#45 | CP-090728 | 0447 | 1 | Incorrect CR implementation | 8.6.0 | +| Dec 2009 | CT#46 | | 0452 | 1 | Unregistered user clarification | 8.7.0 | +| Dec 2009 | CT#46 | | 0456 | 2 | Session-Priority AVP | 8.7.0 | +| Dec 2009 | CT#46 | | 0457 | 2 | HSS behaviour after PPA with unknown user | 8.7.0 | +| Dec 2009 | CT#46 | | 0458 | 1 | Check of the S-CSCF Name | 8.7.0 | +| Dec 2009 | CT#46 | | 0460 | - | IMPI must be sent in SAR for UE initiated requests | 8.7.0 | +| Dec 2009 | CT#46 | | | - | Upgraded unchanged from Rel-8 | 9.0.0 | +| Mar 2010 | CT#47 | CP-100033 | 0462 | - | Default IMPU | 9.1.0 | +| Mar 2010 | CT#47 | CP-100031 | 0468 | 1 | Wildcarded Public Identity | 9.1.0 | +| Mar 2010 | CT#47 | CP-100033 | 0470 | 1 | Priority service attribute | 9.1.0 | +| Mar 2010 | CT#47 | CP-100033 | 0474 | 1 | User-Auth-Type not checked | 9.1.0 | +| Mar 2010 | CT#47 | CP-100033 | 0476 | 1 | GIBA is not allowed when auth. Scheme is Unknown | 9.1.0 | +| Mar 2010 | CT#47 | CP-100042 | 0477 | 2 | Clarification on the use of User-Data-Already-Available | 9.1.0 | +| Mar 2010 | CT#47 | CP-100015 | 0482 | - | Server Capabilities | 9.1.0 | +| Mar 2010 | CT#47 | CP-100031 | 0466 | - | RTR for wildcarded public user identity | 9.1.0 | +| May 2010 | | | | - | XML-file corrected | 9.1.1 | +| Jun 2010 | CT#48 | CP-100412 | 0484 | 3 | Table not aligned with XML schema for wildcarded identities | 9.2.0 | + +| | | | | | | | +|-----------|-------|-----------------|------|---|------------------------------------------------------------------------------------|--------| +| Jun 2010 | CT#48 | CP-100412 | 0487 | 3 | SAR with NO_ASSIGNMENT correction | 9.2.0 | +| Jun 2010 | CT#48 | CP-100412 | 0489 | 2 | Update of IETF Reference | 9.2.0 | +| Sep 2010 | CT#49 | CP-100447 | 0493 | 2 | Wildcarded Identities handling | 9.3.0 | +| Sep 2010 | CT#49 | CP-100447 | 0495 | | Wrong order in table for XML schema | 9.3.0 | +| Sep 2010 | CT#49 | CP-100447 | 0497 | 2 | Cx-MAR handling correction in restoration procedures | 9.3.0 | +| Sep 2010 | CT#49 | CP-100447 | 500 | 1 | Ambiguity of Presence Conditions of IEs and AVP ABNF | 9.3.0 | +| Sep 2010 | CT#49 | CP-100447 | 507 | | Correction for de-registration procedure at restoration | 9.3.0 | +| Sep 2010 | CT#49 | CP-100447 | 504 | 2 | Mandatory and optional capabilities handling | 9.3.0 | +| Dec 2010 | CT#50 | CP-100668 | 0519 | | Coding of SIP-Authorization AVP and SIP-Authenticate AVP | 9.4.0 | +| Dec 2010 | CT#50 | CP-100697 | 0509 | 1 | Clarification on Alias | 10.0.0 | +| Mar 2011 | CT#51 | CP-110044 | 0521 | - | Originating CDIV Session Case including in XML | 10.1.0 | +| Mar 2011 | CT#51 | CP-110060 | 0515 | 5 | MPS over Cx | 10.1.0 | +| Jun 2011 | CT#52 | CP-110349 | 0529 | 2 | Handling of RTR for Emergency Registration | 10.2.0 | +| Jun 2011 | CT#52 | CP-110356 | 0532 | 1 | Emergency Restoration | 10.2.0 | +| Jun 2011 | CT#52 | CP-110356 | 0535 | - | Incorrect Use of Result-Code AVP | 10.2.0 | +| Jun 2011 | CT#52 | CP-110356 | 0538 | 1 | Error in assignment type for backward compatibility scenarios | 10.2.0 | +| Jun 2011 | CT#52 | CP-110383 | 0520 | 4 | Reference Location over Cx interface | 11.0.0 | +| Sep 2011 | CT#53 | CP-110566 | 0542 | | Privileged sender | 11.1.0 | +| Sep 2011 | CT#53 | CP-110566 | 0546 | 1 | Public Identity in canonical form | 11.1.0 | +| Dec 2011 | CT#54 | CP-110781 | 0552 | 1 | Identity in the service profile | 11.2.0 | +| Dec 2011 | CT#54 | CP-110781 | 0557 | 2 | Providing the IMSI to the S-CSCF | 11.2.0 | +| Dec 2011 | CT#54 | CP-110809 | 0553 | 1 | Behaviour of HSS not supported IMS Restoration Procedures to LIR | 11.2.0 | +| Mar 2012 | CT#55 | CP-120014 | 0562 | 1 | Server-Capability AVP in LIA and UAA | 11.3.0 | +| Mar 2012 | CT#55 | CP-120014 | 0566 | 1 | Update of charging information and authentication data | 11.3.0 | +| Jun 2012 | CT#56 | CP-120245 | 0558 | 2 | Maximum Number of simultaneous registrations | 11.4.0 | +| Sep 2012 | CT#57 | CP-120439 | 0576 | 1 | Emergency registrations do not affect registration status | 11.5.0 | +| Sep 2012 | CT#57 | CP-120456 | 0577 | 1 | Add RequestURI parameter to SPT matching | 11.5.0 | +| Nov 2012 | | | | | The specification version number in the header corrected | 11.5.1 | +| Dec 2012 | CT#58 | CP-120743 | 0578 | - | Experimental-Result-Code correction | 11.6.0 | +| Dec 2012 | CT#58 | CP-120743 | 0582 | 3 | PSI direct routing with restoration procedures | 11.6.0 | +| Dec 2012 | CT#58 | CP-120743 | 0583 | - | Negated Session Case | 11.6.0 | +| Mar 2013 | CT#59 | CP-130011 | 0593 | 1 | Identities with emergency registration in RTR | 11.7.0 | +| Mar 2013 | CT#59 | CP-130020 | 0599 | 1 | Clarification on Reference Location information | 11.7.0 | +| Jun 2013 | CT#60 | CP-130374 | 0600 | 1 | Absent User-Name after S-CSCF recovery | 11.8.0 | +| Sep 2013 | CT#61 | CP-130439 | 0606 | 2 | Cancellation of the old S-CSCF for IMS Subscription and IMS Restoration Procedures | 11.9.0 | +| Sep 2013 | CT#61 | CP-13046 clause | 0601 | - | Correction on Emergency Registration | 12.0.0 | +| Dec 2013 | CT#62 | CP-130627 | 0607 | 5 | Cx Charging Information Download | 12.1.0 | +| Jun 2014 | CT#64 | CP-140237 | 0609 | 2 | Wildcarded Public Identity in SAA | 12.2.0 | +| Jun 2014 | CT#64 | CP-140243 | 0611 | 2 | Diameter Overload Control Over Cx | 12.2.0 | +| Sep 2014 | CT#65 | CP-140506 | 0624 | 2 | P-CSCF Restoration indication | 12.3.0 | +| Sep 2014 | CT#65 | CP-140515 | 0626 | - | Clarification on REGISTRATION AND CAPABILITIES for De-registration | 12.3.0 | +| Sep 2014 | CT#65 | CP-140515 | 0627 | - | Clarification on Unregistered User | 12.3.0 | +| Dec 2014 | CT#66 | CP-140794 | 0628 | 2 | HSS behaviour when P-CSCF Restoration indication is received | 12.4.0 | +| Dec 2014 | CT#66 | CP-140790 | 0630 | 1 | Priority Consideration for Diameter Overload Control | 12.4.0 | +| Dec 2014 | CT#66 | CP-140777 | 0632 | 1 | Addition of IMS-AKA based on HTTP Digest AKAv2 for WebRTC | 12.4.0 | +| Mar 2015 | CT#67 | CP-150023 | 0639 | 1 | IMSI Encoding over Cx | 12.5.0 | +| Jun 2015 | CT#68 | CP-150251 | 0633 | 4 | RTR handling when emergency registration | 12.6.0 | +| Jun 2015 | CT#68 | CP-150251 | 0642 | 1 | "Digest-AKAv1-MD5" is used as well for other Digest-AKA versions | 12.6.0 | +| Jun 2015 | CT#68 | CP-150251 | 0643 | | Confidentiality-key is mandatory | 12.6.0 | +| Jun 2015 | CT#68 | CP-150261 | 0640 | - | ADMINISTRATIVE_DEREGISTRATION with P-CSCF-Restoration-Indication | 12.6.0 | +| July 2016 | | | | | Correction of typo in previous line of history table. | 12.6.1 | +| Sep 2015 | CT#69 | CP-150428 | 0647 | 1 | Authentication tables and IE clarifications in MAR/MAA | 12.7.0 | +| Sep 2015 | CT#69 | CP-150428 | 0649 | - | Wrong CR update | 12.7.0 | +| Sep 2015 | CT#69 | CP-150432 | 0644 | 1 | S-CSCF Restoration Information deletion with SAT=UNREGISTERED_USER | 12.7.0 | +| Sep 2015 | CT#69 | CP-150436 | 0645 | - | P-CSCF Restoration when IMS Restoration is supported | 12.7.0 | +| Dec 2015 | CT#70 | CP-150754 | 0653 | 2 | Allowed WAF and/or WWSF Identities | 12.8.0 | +| Dec 2015 | CT#70 | CP-150750 | 0654 | 1 | Authentication Information IE clarification | 12.8.0 | +| Dec 2015 | CT#70 | CP-150749 | 0655 | 1 | De-registration without IMPI | 12.8.0 | +| Dec 2015 | CT#70 | CP-150749 | 0656 | 1 | IMSI change | 12.8.0 | +| Dec 2015 | CT#70 | CP-150759 | 0658 | 1 | Update reference to DOI new IETF RFC | 12.8.0 | +| Dec 2015 | CT#70 | CP-150775 | 0652 | 4 | HSS supports IMS subscriptions corresponding to users managed by third parties | 13.0.0 | +| Dec 2015 | CT#70 | CP-150768 | 0659 | 4 | DRMP AVP Procedures over Cx/Dx | 13.0.0 | +| Mar 2016 | CT#71 | CP-160031 | 0661 | 6 | Introduction of AAA-1 interface | 13.1.0 | +| Mar 2016 | CT#71 | CP-160046 | 0662 | - | De-registration of emergency registration correction | 13.1.0 | +| Jun 2016 | CT#72 | CP-160215 | 0665 | 1 | Diameter requests for priority traffic during overload control mechanism | 13.2.0 | +| 07-2016 | | | | | Correction to spec version number on cover page | 13.2.1 | + +| | | | | | | | +|---------|-------|-----------|------|---|-------------------------------------------------------------------|--------| +| 09-2016 | CT#73 | CP-160431 | 0666 | 1 | S-CSCF Restoration during Registration enhancement | 14.0.0 | +| 2016-12 | CT#74 | CP-160646 | 0673 | 2 | Reference Location | 14.1.0 | +| 2016-12 | CT#74 | CP-160672 | 0674 | 1 | Service Profile and IFC alignment between XML and text/UML | 14.1.0 | +| 2016-12 | CT#74 | CP-160681 | 0675 | 1 | Load Control | 14.1.0 | +| 2016-12 | CT#74 | CP-160664 | 0677 | - | Correction to change IETF drmp draft version to official RFC 7944 | 14.1.0 | +| 2017-03 | CT#75 | CP-170045 | 0678 | - | Mission Critical Services | 14.2.0 | +| 2017-03 | CT#75 | CP-170048 | 0679 | 1 | Update of reference for the Diameter base protocol | 14.2.0 | +| 2017-06 | CT#76 | CP-171034 | 0680 | 1 | IMS Trace (ISAT) Reference Updates | 14.3.0 | +| 2017-06 | CT#76 | CP-171018 | 0684 | 1 | Support for signaling transport level packet marking | 14.3.0 | +| 2017-09 | CT#77 | CP-172012 | 0686 | - | Correction of DRMP Procedures | 14.4.0 | +| 2017-12 | CT#78 | CP-173011 | 0687 | 1 | Cx Subscriber Deregistration Reason | 14.5.0 | +| 2018-06 | CT#80 | CP-181121 | 0688 | 1 | Change of Reference Location Information | 15.0.0 | +| 2018-09 | CT#81 | CP-182069 | 0689 | - | P-CSCF restoration for 5GC | 15.1.0 | +| 2019-03 | CT#83 | CP-190035 | 0690 | 1 | Reference Location Information change | 15.2.0 | +| 2019-09 | CT#85 | CP-192094 | 0693 | 2 | draft-ietf-dime-load published as RFC 8583 | 15.3.0 | +| 2019-09 | CT#85 | CP-192150 | 0691 | 1 | Wildcarded Public Identity in SAA | 16.0.0 | +| 2019-12 | CT#86 | CP-193047 | 0694 | - | RLOS related registrations | 16.1.0 | + +--- \ No newline at end of file diff --git a/marked/Rel-16/29_series/29229/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-16/29_series/29229/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..058bcf45b33fa39b8c7d44e16613109dbaa81eb7 --- /dev/null +++ b/marked/Rel-16/29_series/29229/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d8a55d7379cd857b71b94cf0d9e9941199eff8f1d6ebbc170c47a79977e18e44 +size 10052 diff --git a/marked/Rel-16/29_series/29229/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-16/29_series/29229/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9c1e42e488dac25b10fddef3549a3c673eb9879c --- /dev/null +++ b/marked/Rel-16/29_series/29229/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cc01960b0976602485c7c2c35ad4902055181cdb6f6a785dc2ef3ec3cca6517c +size 6459 diff --git a/marked/Rel-16/29_series/29229/raw.md b/marked/Rel-16/29_series/29229/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..9a339f55973e1a0635a079a427d5e90bc512a204 --- /dev/null +++ b/marked/Rel-16/29_series/29229/raw.md @@ -0,0 +1,1902 @@ + + +# 3GPP TS 29.229 V16.2.0 (2020-06) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Cx and Dx interfaces based on the Diameter protocol; Protocol details (Release 16)** + +![LTE Advanced Pro logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for LTE Advanced Pro, featuring the letters 'lte' in a bold, lowercase font. Above the 'e' is the text 'Advanced Pro' in a smaller font. To the right of the 'e' is a green signal icon consisting of three curved lines. + +LTE Advanced Pro logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, featuring the letters '3GPP' in a stylized, bold font. Below the 'P' is a red signal icon consisting of three curved lines. Below the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, uppercase font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + + + +## --- **Copyright Notification** + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|----------------------------------------------------------------------|----| +| Foreword ..... | 6 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions, symbols and abbreviations..... | 8 | +| 3.1 Definitions..... | 8 | +| 3.2 Abbreviations ..... | 9 | +| 4 General..... | 9 | +| 5 Use of the Diameter base protocol..... | 9 | +| 5.1 Securing Diameter Messages ..... | 9 | +| 5.2 Accounting functionality..... | 9 | +| 5.3 Use of sessions ..... | 9 | +| 5.4 Transport protocol..... | 10 | +| 5.5 Routing considerations..... | 10 | +| 5.6 Advertising Application Support ..... | 10 | +| 6 Diameter application for Cx interface..... | 11 | +| 6.1 Command-Code values ..... | 11 | +| 6.1.1 User-Authorization-Request (UAR) Command..... | 12 | +| 6.1.2 User-Authorization-Answer (UAA) Command ..... | 12 | +| 6.1.3 Server-Assignment-Request (SAR) Command..... | 12 | +| 6.1.4 Server-Assignment-Answer (SAA) Command ..... | 13 | +| 6.1.5 Location-Info-Request (LIR) Command ..... | 14 | +| 6.1.6 Location-Info-Answer (LIA) Command ..... | 14 | +| 6.1.7 Multimedia-Auth-Request (MAR) Command ..... | 15 | +| 6.1.8 Multimedia-Auth-Answer (MAA) Command..... | 15 | +| 6.1.9 Registration-Termination-Request (RTR) Command ..... | 15 | +| 6.1.10 Registration-Termination-Answer (RTA) Command ..... | 16 | +| 6.1.11 Push-Profile-Request (PPR) Command ..... | 16 | +| 6.1.12 Push-Profile-Answer (PPA) Command..... | 17 | +| 6.2 Result-Code AVP values..... | 17 | +| 6.2.1 Success ..... | 17 | +| 6.2.1.1 DIAMETER_FIRST_REGISTRATION (2001) ..... | 17 | +| 6.2.1.2 DIAMETER_SUBSEQUENT_REGISTRATION (2002) ..... | 17 | +| 6.2.1.3 DIAMETER_UNREGISTERED_SERVICE (2003) ..... | 18 | +| 6.2.1.4 DIAMETER_SUCCESS_SERVER_NAME_NOT_STORED (2004) ..... | 18 | +| 6.2.1.5 Void ..... | 18 | +| 6.2.2 Permanent Failures ..... | 18 | +| 6.2.2.1 DIAMETER_ERROR_USER_UNKNOWN (5001) ..... | 18 | +| 6.2.2.2 DIAMETER_ERROR_IDENTITIES_DONT_MATCH (5002) ..... | 18 | +| 6.2.2.3 DIAMETER_ERROR_IDENTITY_NOT_REGISTERED (5003) ..... | 18 | +| 6.2.2.4 DIAMETER_ERROR_ROAMING_NOT_ALLOWED (5004)..... | 18 | +| 6.2.2.5 DIAMETER_ERROR_IDENTITY_ALREADY_REGISTERED (5005)..... | 18 | +| 6.2.2.6 DIAMETER_ERROR_AUTH_SCHEME_NOT_SUPPORTED (5006) ..... | 18 | +| 6.2.2.7 DIAMETER_ERROR_IN_ASSIGNMENT_TYPE (5007)..... | 18 | +| 6.2.2.8 DIAMETER_ERROR_TOO_MUCH_DATA (5008) ..... | 18 | +| 6.2.2.9 DIAMETER_ERROR_NOT_SUPPORTED_USER_DATA (5009) ..... | 19 | +| 6.2.2.10 Void ..... | 19 | +| 6.2.2.11 DIAMETER_ERROR_FEATURE_UNSUPPORTED (5011)..... | 19 | +| 6.2.2.12 DIAMETER_ERROR_SERVING_NODE_FEATURE_UNSUPPORTED (5012)..... | 19 | +| 6.3 AVPs..... | 19 | +| 6.3.1 Visited-Network-Identifier AVP ..... | 21 | +| 6.3.2 Public-Identity AVP ..... | 21 | +| 6.3.3 Server-Name AVP..... | 21 | +| 6.3.4 Server-Capabilities AVP ..... | 21 | + +| | | | +|----------|------------------------------------------------------|----| +| 6.3.5 | Mandatory-Capability AVP..... | 22 | +| 6.3.6 | Optional-Capability AVP ..... | 22 | +| 6.3.7 | User-Data AVP..... | 22 | +| 6.3.8 | SIP-Number-Auth-Items AVP ..... | 22 | +| 6.3.9 | SIP-Authentication-Scheme AVP ..... | 22 | +| 6.3.10 | SIP-Authenticate AVP..... | 22 | +| 6.3.11 | SIP-Authorization AVP ..... | 23 | +| 6.3.12 | SIP-Authentication-Context AVP ..... | 23 | +| 6.3.13 | SIP-Auth-Data-Item AVP ..... | 23 | +| 6.3.14 | SIP-Item-Number AVP ..... | 23 | +| 6.3.15 | Server-Assignment-Type AVP..... | 23 | +| 6.3.16 | Deregistration-Reason AVP ..... | 25 | +| 6.3.17 | Reason-Code AVP..... | 25 | +| 6.3.18 | Reason-Info AVP ..... | 25 | +| 6.3.19 | Charging-Information AVP..... | 25 | +| 6.3.20 | Primary-Event-Charging-Function-Name AVP..... | 26 | +| 6.3.21 | Secondary-Event-Charging-Function-Name AVP ..... | 26 | +| 6.3.22 | Primary-Charging-Collection-Function-Name AVP..... | 26 | +| 6.3.23 | Secondary-Charging-Collection-Function-Name AVP..... | 26 | +| 6.3.24 | User-Authorization-Type AVP ..... | 26 | +| 6.3.25 | Void ..... | 27 | +| 6.3.26 | User-Data-Already-Available AVP..... | 27 | +| 6.3.27 | Confidentiality-Key AVP..... | 27 | +| 6.3.28 | Integrity-Key AVP ..... | 27 | +| 6.3.29 | Supported-Features AVP..... | 27 | +| 6.3.30 | Feature-List-ID AVP..... | 27 | +| 6.3.31 | Feature-List AVP..... | 27 | +| 6.3.32 | Supported-Applications AVP..... | 28 | +| 6.3.33 | Associated-Identities AVP ..... | 28 | +| 6.3.34 | Originating-Request AVP ..... | 28 | +| 6.3.35 | Wildcarded-Public-Identity AVP ..... | 28 | +| 6.3.36 | SIP-Digest-Authenticate AVP..... | 28 | +| 6.3.37 | Digest-Realm AVP ..... | 29 | +| 6.3.38 | Void ..... | 29 | +| 6.3.39 | Digest-Algorithm AVP..... | 29 | +| 6.3.40 | Digest-QoP AVP ..... | 29 | +| 6.3.41 | Digest-HA1 AVP..... | 29 | +| 6.3.42 | Line-Identifier AVP..... | 29 | +| 6.3.43 | Wildcarded-IMPU AVP..... | 29 | +| 6.3.44 | UAR-Flags AVP..... | 29 | +| 6.3.45 | Loose-Route-Indication AVP..... | 29 | +| 6.3.46 | SCSCF-Restoration-Info AVP ..... | 29 | +| 6.3.47 | Path AVP ..... | 30 | +| 6.3.48 | Contact AVP..... | 30 | +| 6.3.49 | Subscription-Info AVP..... | 30 | +| 6.3.49.1 | Call-ID-SIP-Header AVP ..... | 30 | +| 6.3.49.2 | From-SIP-Header AVP ..... | 30 | +| 6.3.49.3 | To-SIP-Header AVP ..... | 30 | +| 6.3.49.4 | Record-Route AVP..... | 31 | +| 6.3.50 | Associated-Registered-Identities AVP..... | 31 | +| 6.3.51 | Multiple-Registration-Indication ..... | 31 | +| 6.3.52 | Restoration-Info AVP..... | 31 | +| 6.3.53 | Framed-IP-Address AVP..... | 31 | +| 6.3.54 | Framed-IPv6-Prefix AVP ..... | 31 | +| 6.3.55 | Framed-Interface-Id AVP..... | 32 | +| 6.3.56 | Session-Priority AVP ..... | 32 | +| 6.3.57 | Identity-with-Emergency-Registration AVP..... | 32 | +| 6.3.58 | Privileged-Sender-Indication AVP..... | 32 | +| 6.3.59 | LIA-Flags ..... | 32 | +| 6.3.60 | OC-Supported-Features ..... | 33 | +| 6.3.61 | OC-OLR ..... | 33 | +| 6.3.62 | Initial-CSeq-Sequence-Number AVP ..... | 33 | + +| | | | +|-------------------------------|-------------------------------------------------|-----------| +| 6.3.63 | SAR-Flags ..... | 33 | +| 6.3.64 | Allowed-WAF-WWSF-Identities AVP..... | 33 | +| 6.3.65 | WebRTC-Authentication-Function-Name AVP ..... | 33 | +| 6.3.66 | WebRTC-Web-Server-Function-Name AVP..... | 33 | +| 6.3.67 | DRMP AVP..... | 33 | +| 6.3.68 | Load..... | 34 | +| 6.3.69 | RTR-Flags ..... | 34 | +| 6.3.70 | P-CSCF-Subscription-Info AVP ..... | 34 | +| 6.3.71 | Registration-Time-Out ..... | 34 | +| 6.4 | Use of namespaces ..... | 34 | +| 6.4.1 | AVP codes ..... | 34 | +| 6.4.2 | Experimental-Result-Code AVP values..... | 34 | +| 6.4.3 | Command Code values..... | 35 | +| 6.4.4 | Application-ID value..... | 35 | +| 7 | Special Requirements..... | 36 | +| 7.1 | Version Control..... | 36 | +| 7.1.1 | Defining a new feature ..... | 36 | +| 7.1.2 | Changing the version of the interface..... | 38 | +| 7.2 | Supported features..... | 38 | +| 7.2.1 | Dynamic discovery of supported features ..... | 38 | +| 7.3 | Interface versions ..... | 39 | +| 7.3.1 | Discovery of supported interface versions ..... | 39 | +| Annex A (informative): | Change history..... | 41 | + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document defines a transport protocol for use in the IP multimedia (IM) Core Network (CN) subsystem based on Diameter base protocol as specified in IETF RFC 6733 [28]. + +The present document is applicable to: + +- The Cx interface between the I-CSCF/S-CSCF and the HSS. +- The Dx interface between the I-CSCF/S-CSCF and the SLF. + +Whenever it is possible, this document specifies the requirements for this protocol by reference to specifications produced by the IETF within the scope of Diameter base protocol as specified in IETF RFC 6733 [28]. Where this is not possible, extensions to Diameter base protocol as specified in IETF RFC 6733 [28] are defined within this document. + +# --- 2 References + +The following documents contain provisions, which through reference in this text constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TS 29.228: "IP Multimedia (IM) Subsystem Cx and Dx interface; signalling flows and message contents". +- [2] 3GPP TS 33.210: "3G Security; Network Domain Security; IP Network Layer Security". +- [3] IETF RFC 3261: "SIP: Session Initiation Protocol". +- [4] IETF RFC 2396: "Uniform Resource Identifiers (URI): generic syntax". +- [5] Void. +- [6] Void. +- [7] IETF RFC 2234: "Augmented BNF for syntax specifications". +- [8] IETF RFC 3966: "The tel URI for Telephone Numbers". +- [9] Void. +- [10] Void. +- [11] 3GPP TS 29.329: "Sh Interface based on the Diameter protocol; protocol details". + +- [12] IETF RFC 3589: "Diameter Command Codes for Third Generation Partnership Project (3GPP) Release 5". + - [13] 3GPP TS 23.003: "Numbering, addressing and identification". + - [14] IETF RFC 2617: "HTTP Authentication: Basic and Digest Access Authentication". + - [15] IETF RFC 4740: "Diameter Session Initiation Protocol (SIP) Application". + - [16] 3GPP TS 29.328: "IP Multimedia (IM) Subsystem Sh interface; Signalling flows and message contents". + - [17] IETF RFC 3327: "Session Initiation Protocol Extension Header Field for Registering Non-Adjacent Contacts". + - [18] 3GPP TS 29.273: "3GPP EPS AAA interfaces". + - [19] IETF RFC 4005: "Diameter Network Access Server Application". + - [20] IETF RFC 4590: " RADIUS Extension for Digest Authentication". + - [21] IETF RFC 4960: "Stream Control Transmission Protocol". + - [22] IETF RFC 3162: "RADIUS and IPv6". + - [23] IETF RFC 7683: "Diameter Overload Indication Conveyance". + - [24] 3GPP TS 23.380: "IMS Restoration Procedures". + - [25] IETF draft-holmberg-sipcore-auth-id-01: "Authorization server identity". +- Editor's note:** The above document cannot be formally referenced until it is published as an RFC. +- [26] IETF RFC 7944: "Diameter Routing Message Priority". + - [27] IETF RFC 8583: "Diameter Load Information Conveyance". + - [28] IETF RFC 6733: "Diameter Base Protocol". + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +Refer to IETF RFC 6733 [28] for the definitions of some terms used in this document. + +For the purposes of the present document, the following terms and definitions apply. + +**Attribute-Value Pair:** see IETF RFC 6733 [28], it corresponds to an Information Element in a Diameter message. + +**Diameter Multimedia client:** a client that implements the Diameter Multimedia application. The client is one of the communicating Diameter peers that usually initiate transactions. Examples in 3GPP are the I-CSCF and S-CSCF. + +**Diameter Multimedia server:** a server that implements the Diameter Multimedia application. A Diameter Multimedia server that also supported the NASREQ and MobileIP applications would be referred to as a Diameter server. An example of a Diameter Multimedia server in 3GPP is the HSS. + +**Registration:** SIP-registration. + +**Server:** SIP-server. + +**User data:** user profile data. + +## 3.2 Abbreviations + +For the purposes of the present document, the following abbreviations apply: + +| | | +|--------|----------------------------------------------| +| AAA | Authentication, Authorization and Accounting | +| ABNF | Augmented Backus-Naur Form | +| AVP | Attribute-Value Pair | +| CN | Core Network | +| CSCF | Call Session Control Function | +| DSCP | Differentiated Services Code Point | +| DRMP | Diameter Routing Message Priority | +| HSS | Home Subscriber Server | +| IANA | Internet Assigned Numbers Authority | +| I-CSCF | Interrogating CSCF | +| IETF | Internet Engineering Task Force | +| IMS | IP Multimedia Subsystem | +| NDS | Network Domain Security | +| RFC | Request For Comments | +| S-CSCF | Serving CSCF | +| SCTP | Stream Control Transport Protocol | +| SIP | Session Initiation Protocol | +| SLF | Server Locator Function | +| UCS | Universal Character Set | +| URL | Uniform Resource Locator | +| UTF | UCS Transformation Formats | +| WAF | WebRTC Authentication Function | +| WWSF | WebRTC Web Server Function | + +# --- 4 General + +The Diameter base protocol as specified in IETF RFC 6733 [28] shall apply except as modified by the defined support of the methods and the defined support of the commands and AVPs, result and event codes specified in clause 5 of this specification. Unless otherwise specified, the procedures (including error handling and unrecognised information handling) are unmodified. + +# --- 5 Use of the Diameter base protocol + +With the clarifications listed in the following clauses the Diameter base protocol defined by IETF RFC 6733 [28] shall apply. + +## 5.1 Securing Diameter Messages + +For secure transport of Diameter messages, see 3GPP TS 33.210 [2]. + +## 5.2 Accounting functionality + +Accounting functionality (Accounting Session State Machine, related command codes and AVPs) is not used on the Cx interface. + +## 5.3 Use of sessions + +Both between the I-CSCF and the HSS and between the S-CSCF and the HSS, Diameter sessions are implicitly terminated. An implicitly terminated session is one for which the server does not maintain state information. The client does not need to send any re-authorization or session termination requests to the server. + +The Diameter base protocol includes the Auth-Session-State AVP as the mechanism for the implementation of implicitly terminated sessions. + +The client (server) shall include in its requests (responses) the Auth-Session-State AVP set to the value NO\_STATE\_MAINTAINED (1), as described in IETF RFC 6733 [28]. As a consequence, the server does not maintain any state information about this session and the client does not need to send any session termination request. Neither the Authorization-Lifetime AVP nor the Session-Timeout AVP shall be present in requests or responses. + +## 5.4 Transport protocol + +Diameter messages over the Cx and the Dx interfaces shall make use of SCTP IETF RFC 4960 [21]. + +## 5.5 Routing considerations + +This clause specifies the use of the Diameter routing AVPs Destination-Realm and Destination-Host. + +If an I-CSCF or S-CSCF knows the address/name of the HSS for a certain user, both the Destination-Realm and Destination-Host AVPs shall be present in the request. Otherwise, only the Destination-Realm AVP shall be present and the command shall be routed to the next Diameter node, e.g. the SLF or a Diameter Proxy Agent (see 3GPP TS 29.228 [1]), based on the Diameter routing table in the client. + +If the next Diameter node is an SLF, then once the SLF has returned the address or the destination HSS (using Redirect-Host AVP), the redirected request to the HSS shall include both Destination-Realm and Destination-Host AVPs. If the next Diameter node is a Diameter Proxy Agent, the Diameter Proxy Agent shall determine the destination HSS. The Diameter Proxy Agent, based on the result of this determination of the destination HSS, shall modify the Destination-Realm AVP and Destination-Host AVP of the request appropriately. The Diameter Proxy Agent shall then append a Route-Record AVP to the request and shall send the request to the destination HSS. Consequently, the Destination-Host AVP is declared as optional in the ABNF for all requests initiated by an I-CSCF or an S-CSCF. + +If the response is routed back to a Diameter Proxy Agent, the Diameter Proxy Agent shall send the response back to the I-CSCF or S-CSCF without modifying the Origin-Realm AVP and Origin-Host AVP. The response shall contain the Origin-Realm AVP set to the realm of the HSS together with the Origin-Host AVP set to the HSS that sent the response. The S-CSCF shall store the HSS realm and HSS address for each Public Identity, after the first request sent to the User Identity to HSS resolution function. + +Requests initiated by the HSS towards an S-CSCF shall include both Destination-Host and Destination-Realm AVPs. The HSS obtains the Destination-Host AVP to use in requests towards an S-CSCF, from the Origin-Host AVP received in previous requests from the S-CSCF. Consequently, the Destination-Host AVP is declared as mandatory in the ABNF for all requests initiated by the HSS. + +Destination-Realm AVP is declared as mandatory in the ABNF for all requests. + +## 5.6 Advertising Application Support + +The HSS, S-CSCF and I-CSCF shall advertise support of the Diameter Multimedia Application by including the value of the application identifier (see chapter 6) in the Auth-Application-Id AVP within the Vendor-Specific-Application-Id grouped AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands. + +The vendor identifier value of 3GPP (10415) and ETSI (13019) shall be included in the Supported-Vendor-Id AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands, and in the Vendor-Id AVP within the Vendor-Specific-Application-Id grouped AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands. + +Note: The Vendor-Id AVP included in Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands that is not included in the Vendor-Specific-Application-Id AVPs as described above shall indicate the manufacturer of the Diameter node as per IETF RFC 6733 [28]. + +# 6 Diameter application for Cx interface + +This clause specifies a Diameter application that allows a Diameter Multimedia server and a Diameter Multimedia client: + +- to exchange location information +- to authorize a user to access the IMS +- to exchange authentication information +- to download and handle changes in the user data stored in the server + +The Cx interface protocol is defined as an IETF vendor specific Diameter application, where the vendor is 3GPP. The vendor identifier assigned by IANA to 3GPP () is 10415. + +The Diameter application identifier assigned to the Cx/Dx interface application is 16777216 (allocated by IANA). + +## 6.1 Command-Code values + +This clause defines Command-Code values for this Diameter application. + +Every command is defined by means of the ABNF syntax IETF RFC 2234 [7], according to the Command Code Format (CCF) specification defined in IETF RFC 6733 [28]. Whenever the definition and use of an AVP is not specified in this document, what is stated in IETF RFC 6733 [28] shall apply. + +NOTE: As the Diameter commands described in this specification have been defined based on the former specification of the Diameter base protocol, the Vendor-Specific-Application-Id AVP is still listed as a required AVP (an AVP indicated as {AVP}) in the command code format specifications defined in this specification to avoid backward compatibility issues, even if the use of this AVP has been deprecated in the new specification of the Diameter base protocol (IETF RFC 6733 [28]). + +The command codes for the Cx/Dx interface application are taken from the range allocated by IANA in IETF RFC 3589 [12] as assigned in this specification. For these commands, the Application-ID field shall be set to 16777216 (application identifier of the Cx/Dx interface application, allocated by IANA). + +The following Command Codes are defined in this specification: + +**Table 6.1.1: Command-Code values** + +| Command-Name | Abbreviation | Code | Clause | +|----------------------------------|--------------|------|--------| +| User-Authorization-Request | UAR | 300 | 6.1.1 | +| User-Authorization-Answer | UAA | 300 | 6.1.2 | +| Server-Assignment-Request | SAR | 301 | 6.1.3 | +| Server-Assignment-Answer | SAA | 301 | 6.1.4 | +| Location-Info-Request | LIR | 302 | 6.1.5 | +| Location-Info-Answer | LIA | 302 | 6.1.6 | +| Multimedia-Auth-Request | MAR | 303 | 6.1.7 | +| Multimedia-Auth-Answer | MAA | 303 | 6.1.8 | +| Registration-Termination-Request | RTR | 304 | 6.1.9 | +| Registration-Termination-Answer | RTA | 304 | 6.1.10 | +| Push-Profile-Request | PPR | 305 | 6.1.11 | +| Push-Profile-Answer | PPA | 305 | 6.1.12 | + +### 6.1.1 User-Authorization-Request (UAR) Command + +The User-Authorization-Request (UAR) command, indicated by the Command-Code field set to 300 and the 'R' bit set in the Command Flags field, is sent by a Diameter Multimedia client to a Diameter Multimedia server in order to request the authorization of the registration of a multimedia user. + +#### Message Format + +``` +< User-Authorization-Request > ::= < Diameter Header: 300, REQ, PXY, 16777216 > + < Session-Id > + [ DRMP ] + { Vendor-Specific-Application-Id } + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ Destination-Host ] + { Destination-Realm } + { User-Name } + [ OC-Supported-Features ] + *[ Supported-Features ] + { Public-Identity } + { Visited-Network-Identifier } + [ User-Authorization-Type ] + [ UAR-Flags ] + *[ AVP ] + *[ Proxy-Info ] + *[ Route-Record ] +``` + +### 6.1.2 User-Authorization-Answer (UAA) Command + +The User-Authorization-Answer (UAA) command, indicated by the Command-Code field set to 300 and the 'R' bit cleared in the Command Flags field, is sent by a server in response to the User-Authorization-Request command. The Experimental-Result AVP may contain one of the values defined in clause 6.2. + +#### Message Format + +``` +< User-Authorization-Answer > ::= < Diameter Header: 300, PXY, 16777216 > + < Session-Id > + [ DRMP ] + { Vendor-Specific-Application-Id } + [ Result-Code ] + [ Experimental-Result ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ OC-Supported-Features ] + [ OC-OLR ] + *[ Load ] + *[ Supported-Features ] + [ Server-Name ] + [ Server-Capabilities ] + *[ AVP ] + [ Failed-AVP ] + *[ Proxy-Info ] + *[ Route-Record ] +``` + +### 6.1.3 Server-Assignment-Request (SAR) Command + +The Server-Assignment-Request (SAR) command, indicated by the Command-Code field set to 301 and the 'R' bit set in the Command Flags field, is sent by a Diameter Multimedia client to a Diameter Multimedia server in order to request it to store the name of the server that is currently serving the user. + +#### Message Format + +``` + + ::= < Diameter Header: 301, REQ, PXY, 16777216 > + < Session-Id > + [ DRMP ] + { Vendor-Specific-Application-Id } + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ Destination-Host ] + { Destination-Realm } + [ User-Name ] + [ OC-Supported-Features ] + * [ Supported-Features ] + * [ Public-Identity ] + [ Wildcarded-Public-Identity ] + { Server-Name } + { Server-Assignment-Type } + { User-Data-Already-Available } + [ SCSCF-Restoration-Info ] + [ Multiple-Registration-Indication ] + [ Session-Priority ] + [ SAR-Flags ] + * [ AVP ] + * [ Proxy-Info ] + * [ Route-Record ] + +``` + +### 6.1.4 Server-Assignment-Answer (SAA) Command + +The Server-Assignment-Answer (SAA) command, indicated by the Command-Code field set to 301 and the 'R' bit cleared in the Command Flags field, is sent by a server in response to the Server-Assignment-Request command. The Experimental-Result AVP may contain one of the values defined in clause 6.2. If Result-Code or Experimental-Result does not inform about an error, the User-Data AVP shall contain the information that the S-CSCF needs to give service to the user. + +#### Message Format + +``` + + ::= < Diameter Header: 301, PXY, 16777216 > + < Session-Id > + [ DRMP ] + { Vendor-Specific-Application-Id } + [ Result-Code ] + [ Experimental-Result ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ User-Name ] + [ OC-Supported-Features ] + [ OC-OLR ] + * [ Load ] + * [ Supported-Features ] + [ User-Data ] + [ Charging-Information ] + [ Associated-Identities ] + [ Loose-Route-Indication ] + * [ SCSCF-Restoration-Info ] + [ Associated-Registered-Identities ] + [ Server-Name ] + [ Wildcarded-Public-Identity ] + [ Privileged-Sender-Indication ] + [ Allowed-WAF-WWSF-Identities ] + * [ AVP ] + +``` + +``` + +[ Failed-AVP ] +*[ Proxy-Info ] + +*[ Route-Record ] + +``` + +### 6.1.5 Location-Info-Request (LIR) Command + +The Location-Info-Request (LIR) command, indicated by the Command-Code field set to 302 and the 'R' bit set in the Command Flags field, is sent by a Diameter Multimedia client to a Diameter Multimedia server in order to request name of the server that is currently serving the user. + +#### Message Format + +``` + + ::= < Diameter Header: 302, REQ, PXY, 16777216 > + < Session-Id > + [ DRMP ] + { Vendor-Specific-Application-Id } + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ Destination-Host ] + { Destination-Realm } + [ Originating-Request ] + [ OC-Supported-Features ] + *[ Supported-Features ] + { Public-Identity } + [ User-Authorization-Type ] + [ Session-Priority ] + + *[ AVP ] + *[ Proxy-Info ] + *[ Route-Record ] + +``` + +### 6.1.6 Location-Info-Answer (LIA) Command + +The Location-Info-Answer (LIA) command, indicated by the Command-Code field set to 302 and the 'R' bit cleared in the Command Flags field, is sent by a server in response to the Location-Info-Request command. The Experimental-Result AVP may contain one of the values defined in clause 6.2. + +#### Message Format + +``` + + ::= < Diameter Header: 302, PXY, 16777216 > + < Session-Id > + [ DRMP ] + { Vendor-Specific-Application-Id } + [ Result-Code ] + [ Experimental-Result ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ OC-Supported-Features ] + [ OC-OLR ] + *[ Load ] + *[ Supported-Features ] + [ Server-Name ] + [ Server-Capabilities ] + [ Wildcarded-Public-Identity ] + [ LIA-Flags ] + *[ AVP ] + [ Failed-AVP ] + *[ Proxy-Info ] + *[ Route-Record ] + +``` + +### 6.1.7 Multimedia-Auth-Request (MAR) Command + +The Multimedia-Auth-Request (MAR) command, indicated by the Command-Code field set to 303 and the 'R' bit set in the Command Flags field, is sent by a Diameter Multimedia client to a Diameter Multimedia server in order to request security information. + +Message Format + +``` +< Multimedia-Auth-Request > ::= < Diameter Header: 303, REQ, PXY, 16777216 > + < Session-Id > + [ DRMP ] + { Vendor-Specific-Application-Id } + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + [ Destination-Host ] + { User-Name } + [ OC-Supported-Features ] + * [ Supported-Features ] + { Public-Identity } + { SIP-Auth-Data-Item } + { SIP-Number-Auth-Items } + { Server-Name } + * [ AVP ] + * [ Proxy-Info ] + * [ Route-Record ] +``` + +### 6.1.8 Multimedia-Auth-Answer (MAA) Command + +The Multimedia-Auth-Answer (MAA) command, indicated by the Command-Code field set to 303 and the 'R' bit cleared in the Command Flags field, is sent by a server in response to the Multimedia-Auth-Request command. The Experimental-Result AVP may contain one of the values defined in clause 6.2. + +Message Format + +``` +< Multimedia-Auth-Answer > ::= < Diameter Header: 303, PXY, 16777216 > + < Session-Id > + [ DRMP ] + { Vendor-Specific-Application-Id } + [ Result-Code ] + [ Experimental-Result ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ User-Name ] + [ OC-Supported-Features ] + [ OC-OLR ] + * [ Load ] + * [ Supported-Features ] + [ Public-Identity ] + [ SIP-Number-Auth-Items ] + * [ SIP-Auth-Data-Item ] + * [ AVP ] + [ Failed-AVP ] + * [ Proxy-Info ] + * [ Route-Record ] +``` + +### 6.1.9 Registration-Termination-Request (RTR) Command + +The Registration-Termination-Request (RTR) command, indicated by the Command-Code field set to 304 and the 'R' bit set in the Command Flags field, is sent by a Diameter Multimedia server to a Diameter Multimedia client in order to request the de-registration of a user. + +#### Message Format + +``` + + ::= < Diameter Header: 304, REQ, PXY, 16777216 > + < Session-Id > + [ DRMP ] + { Vendor-Specific-Application-Id } + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + { User-Name } + [ Associated-Identities ] + * [ Supported-Features ] + * [ Public-Identity ] + { Deregistration-Reason } + RTR-Flags ] + * [ AVP ] + * [ Proxy-Info ] + * [ Route-Record ] + +``` + +### 6.1.10 Registration-Termination-Answer (RTA) Command + +The Registration-Termination-Answer (RTA) command, indicated by the Command-Code field set to 304 and the 'R' bit cleared in the Command Flags field, is sent by a client in response to the Registration-Termination-Request command. The Experimental-Result AVP may contain one of the values defined in clause 6.2. + +#### Message Format + +``` + + ::= < Diameter Header: 304, PXY, 16777216 > + < Session-Id > + < Session-Id > + [ DRMP ] + { Vendor-Specific-Application-Id } + [ Result-Code ] + [ Experimental-Result ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ Associated-Identities ] + * [ Supported-Features ] + * [ Identity-with-Emergency-Registration ] + * [ AVP ] + [ Failed-AVP ] + * [ Proxy-Info ] + * [ Route-Record ] + +``` + +### 6.1.11 Push-Profile-Request (PPR) Command + +The Push-Profile-Request (PPR) command, indicated by the Command-Code field set to 305 and the 'R' bit set in the Command Flags field, is sent by a Diameter Multimedia server to a Diameter Multimedia client in order to update the subscription data and for SIP Digest authentication the authentication data of a multimedia user in the Diameter Multimedia client whenever a modification has occurred in the subscription data or digest password that constitutes the data used by the client. + +#### Message Format + +``` + +< Push-Profile-Request > ::= < Diameter Header: 305, REQ, PXY, 16777216 > + < Session-Id > + [ DRMP ] + { Vendor-Specific-Application-Id } + { Auth-Session-State } + { Origin-Host } + +``` + +``` + +{ Origin-Realm } +{ Destination-Host } +{ Destination-Realm } +{ User-Name } +*[ Supported-Features ] +[ User-Data ] +[ Charging-Information ] +[ SIP-Auth-Data-Item ] +[ Allowed-WAF-WWSF-Identities ] +*[ AVP ] +*[ Proxy-Info ] +*[ Route-Record ] + +``` + +### 6.1.12 Push-Profile-Answer (PPA) Command + +The Push-Profile-Answer (PPA) command, indicated by the Command-Code field set to 305 and the 'R' bit cleared in the Command Flags field, is sent by a client in response to the Push-Profile-Request command. The Experimental-Result AVP may contain one of the values defined in clause 6.2. + +#### Message Format + +``` + +< Push-Profile-Answer > ::= < Diameter Header: 305, PXY, 16777216 > + < Session-Id > + [ DRMP ] + { Vendor-Specific-Application-Id } + [Result-Code ] + [ Experimental-Result ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + *[ Supported-Features ] + *[ AVP ] + [ Failed-AVP ] + *[ Proxy-Info ] + *[ Route-Record ] + +``` + +## 6.2 Result-Code AVP values + +This clause defines new result code values that must be supported by all Diameter implementations that conform to this specification. When one of the result codes defined here is included in a response, it shall be inside an Experimental-Result AVP and Result-Code AVP shall be absent. + +### 6.2.1 Success + +Result codes that fall within the Success category are used to inform a peer that a request has been successfully completed. + +#### 6.2.1.1 DIAMETER\_FIRST\_REGISTRATION (2001) + +The HSS informs the I-CSCF that: + +- The user is authorized to register this public identity; +- A S-CSCF shall be assigned to the user. + +#### 6.2.1.2 DIAMETER\_SUBSEQUENT\_REGISTRATION (2002) + +The HSS informs the I-CSCF that: + +- The user is authorized to register this public identity; +- A S-CSCF is already assigned and there is no need to select a new one. + +#### 6.2.1.3 DIAMETER\_UNREGISTERED\_SERVICE (2003) + +The HSS informs the I-CSCF that: + +- The public identity is not registered but has services related to unregistered state; +- A S-CSCF shall be assigned to the user. + +#### 6.2.1.4 DIAMETER\_SUCCESS\_SERVER\_NAME\_NOT\_STORED (2004) + +The HSS informs to the S-CSCF that: + +- The de-registration is completed; +- The S-CSCF name is not stored in the HSS. + +#### 6.2.1.5 Void + +### 6.2.2 Permanent Failures + +Errors that fall within the Permanent Failures category are used to inform the peer that the request failed, and should not be attempted again. + +#### 6.2.2.1 DIAMETER\_ERROR\_USER\_UNKNOWN (5001) + +A message was received for a user or a wildcarded identity that is unknown. + +#### 6.2.2.2 DIAMETER\_ERROR\_IDENTITIES\_DONT\_MATCH (5002) + +A message was received with a public identity and a private identity for a user, and the server determines that the public identity does not correspond to the private identity. + +#### 6.2.2.3 DIAMETER\_ERROR\_IDENTITY\_NOT\_REGISTERED (5003) + +A query for location information is received for a public identity that has not been registered before. The user to which this identity belongs cannot be given service in this situation. + +#### 6.2.2.4 DIAMETER\_ERROR\_ROAMING\_NOT\_ALLOWED (5004) + +The user is not allowed to roam in the visited network. + +#### 6.2.2.5 DIAMETER\_ERROR\_IDENTITY\_ALREADY\_REGISTERED (5005) + +The identity has already a server assigned and the registration status does not allow that it is overwritten. + +#### 6.2.2.6 DIAMETER\_ERROR\_AUTH\_SCHEME\_NOT\_SUPPORTED (5006) + +The authentication scheme indicated in an authentication request is not supported. + +#### 6.2.2.7 DIAMETER\_ERROR\_IN\_ASSIGNMENT\_TYPE (5007) + +The identity being registered has already the same server assigned and the registration status does not allow the server assignment type or the Public Identity type received in the request is not allowed for the indicated server-assignment-type. + +#### 6.2.2.8 DIAMETER\_ERROR\_TOO\_MUCH\_DATA (5008) + +The volume of the data pushed to the receiving entity exceeds its capacity. + +NOTE: This error code is also used in 3GPP TS 29.329 [11]. + +#### 6.2.2.9 DIAMETER\_ERROR\_NOT\_SUPPORTED\_USER\_DATA (5009) + +The S-CSCF informs HSS that the received subscription data contained information, which was not recognised or supported. + +#### 6.2.2.10 Void + +#### 6.2.2.11 DIAMETER\_ERROR\_FEATURE\_UNSUPPORTED (5011) + +A request application message was received indicating that the origin host requests that the command pair would be handled using a feature which is not supported by the destination host. + +#### 6.2.2.12 DIAMETER\_ERROR\_SERVING\_NODE\_FEATURE\_UNSUPPORTED (5012) + +This error is used when the HSS supports the P-CSCF-Restoration-mechanism feature, but none of the user serving node(s) supports it, as described by 3GPP TS 23.380 [24] clause 5.4. + +## 6.3 AVPs + +The following table describes the Diameter AVPs defined by 3GPP for the Cx interface protocol, their AVP Code values, types, possible flag values and whether or not the AVP may be encrypted. The Vendor-ID header of all AVPs defined in this specification shall be set to 3GPP (10415) if not otherwise indicated. + +Table 6.3.1: Diameter Multimedia Application AVPs + +| Attribute Name | AVP Code | Clause defined | Value Type | AVP Flag rules | | | | | +|---------------------------------------------|---------------|----------------|-------------|----------------|-----|------------|----------|-----------| +| | | | | Must | May | Should not | Must not | May Encr. | +| Visited-Network-Identifier | 600 | 6.3.1 | OctetString | M, V | | | | No | +| Public-Identity | 601 | 6.3.2 | UTF8String | M, V | | | | No | +| Server-Name | 602 | 6.3.3 | UTF8String | M, V | | | | No | +| Server-Capabilities | 603 | 6.3.4 | Grouped | M, V | | | | No | +| Mandatory-Capability | 604 | 6.3.5 | Unsigned32 | M, V | | | | No | +| Optional-Capability | 605 | 6.3.6 | Unsigned32 | M, V | | | | No | +| User-Data | 606 | 6.3.7 | OctetString | M, V | | | | No | +| SIP-Number-Auth-Items | 607 | 6.3.8 | Unsigned32 | M, V | | | | No | +| SIP-Authentication-Scheme | 608 | 6.3.9 | UTF8String | M, V | | | | No | +| SIP-Authenticate | 609 | 6.3.10 | OctetString | M, V | | | | No | +| SIP-Authorization | 610 | 6.3.11 | OctetString | M, V | | | | No | +| SIP-Authentication-Context | 611 | 6.3.12 | OctetString | M, V | | | | No | +| SIP-Auth-Data-Item | 612 | 6.3.13 | Grouped | M, V | | | | No | +| SIP-Item-Number | 613 | 6.3.14 | Unsigned32 | M, V | | | | No | +| Server-Assignment-Type | 614 | 6.3.15 | Enumerated | M, V | | | | No | +| Deregistration-Reason | 615 | 6.3.16 | Grouped | M, V | | | | No | +| Reason-Code | 616 | 6.3.17 | Enumerated | M, V | | | | No | +| Reason-Info | 617 | 6.3.18 | UTF8String | M, V | | | | No | +| Charging-Information | 618 | 6.3.19 | Grouped | M, V | | | | No | +| Primary-Event-Charging-Function-Name | 619 | 6.3.20 | DiameterURI | M, V | | | | No | +| Secondary-Event-Charging-Function-Name | 620 | 6.3.21 | DiameterURI | M, V | | | | No | +| Primary-Charging-Collection-Function-Name | 621 | 6.3.22 | DiameterURI | M, V | | | | No | +| Secondary-Charging-Collection-Function-Name | 622 | 6.3.23 | DiameterURI | M, V | | | | No | +| User-Authorization-Type | 623 | 6.3.24 | Enumerated | M, V | | | | No | +| User-Data-Already-Available | 624 | 6.3.26 | Enumerated | M, V | | | | No | +| Confidentiality-Key | 625 | 6.3.27 | OctetString | M, V | | | | No | +| Integrity-Key | 626 | 6.3.28 | OctetString | M, V | | | | No | +| Supported-Features | 628 | 6.3.29 | Grouped | V | M | | | No | +| Feature-List-ID | 629 | 6.3.30 | Unsigned32 | V | | | M | No | +| Feature-List | 630 | 6.3.31 | Unsigned32 | V | | | M | No | +| Supported-Applications | 631 | 6.3.32 | Grouped | V | | | M | No | +| Associated-Identities | 632 | 6.3.33 | Grouped | V | | | M | No | +| Originating-Request | 633 | 6.3.34 | Enumerated | M, V | | | | No | +| Wildcarded-Public-Identity | 634 | 6.3.35 | UTF8String | V | | | M | No | +| SIP-Digest-Authenticate | 635 | 6.3.36 | Grouped | V | | | M | No | +| Digest-Realm | 104
NOTE 3 | 6.3.37 | UTF8String | M | | | V | No | +| Digest-Algorithm | 111
NOTE 3 | 6.3.39 | UTF8String | M | | | V | No | +| Digest-QoP | 110
NOTE 3 | 6.3.40 | UTF8String | M | | | V | No | +| Digest-HA1 | 121
NOTE 3 | 6.3.41 | UTF8String | M | | | V | No | +| UAR-Flags | 637 | 6.3.44 | Unsigned32 | V | | | M | No | +| Loose-Route-Indication | 638 | 6.3.45 | Enumerated | V | | | M | No | +| SCSCF-Restoration-Info | 639 | 6.3.46 | Grouped | V | | | M | No | +| Path | 640 | 6.3.47 | OctetString | V | | | M | No | +| Contact | 641 | 6.3.48 | OctetString | V | | | M | No | +| Subscription-Info | 642 | 6.3.49 | Grouped | V | | | M | No | +| Call-ID-SIP-Header | 643 | 6.3.49.1 | OctetString | V | | | M | No | +| From-SIP-Header | 644 | 6.3.49.2 | OctetString | V | | | M | No | +| To-SIP-Header | 645 | 6.3.49.3 | OctetString | V | | | M | No | +| Record-Route | 646 | 6.3.49.4 | OctetString | V | | | M | No | +| Associated-Registered-Identities | 647 | 6.3.50 | Grouped | V | | | M | No | +| Multiple-Registration-Indication | 648 | 6.3.51 | Enumerated | V | | | M | No | +| Restoration-Info | 649 | 6.3.52 | Grouped | V | | | M | No | + +| | | | | | | | | | +|--------------------------------------|---------------|--------|------------|---|--|--|------|----| +| Session-Priority | 650 | 6.3.56 | Enumerated | V | | | M | No | +| Identity-with-Emergency-Registration | 651 | 6.3.57 | Grouped | V | | | M | No | +| Privileged-Sender-Indication | 652 | 6.3.58 | Enumerated | V | | | M | No | +| LIA-Flags | 653 | 6.3.59 | Unsigned32 | V | | | M | No | +| OC-Supported-Features | 621
NOTE 4 | 6.3.60 | Grouped | | | | M, V | No | +| OC-OLR | 623
NOTE 4 | 6.3.61 | Grouped | | | | M, V | No | +| Initial-CSeq-Sequence-Number | 654 | 6.3.62 | Unsigned32 | V | | | M | No | +| SAR-Flags | 655 | 6.3.63 | Unsigned32 | V | | | M | No | +| Allowed-WAF-WWSF-Identities | 656 | 6.3.64 | Grouped | V | | | M | No | +| WebRTC-Authentication-Function-Name | 657 | 6.3.65 | UTF8String | V | | | M | No | +| WebRTC-Web-Server-Function-Name | 658 | 6.3.66 | UTF8String | V | | | M | No | +| DRMP | 301
NOTE 5 | 6.3.67 | Enumerated | | | | M, V | No | +| Load | NOTE 6 | 6.3.68 | Grouped | | | | M, V | No | +| RTR-Flags | 659 | 6.3.69 | Unsigned32 | V | | | M | No | +| P-CSCF-Subscription-Info | 660 | 6.3.70 | Grouped | V | | | M | No | +| Registration-Time-Out | 661 | 6.3.71 | Time | V | | | M | No | + +NOTE 1: The AVP header bit denoted as 'M', indicates whether support of the AVP is required. The AVP header bit denoted as 'V', indicates whether the optional Vendor-ID field is present in the AVP header. For further details, see IETF RFC 6733 [28]. + +NOTE 1a: If the M-bit is set for an AVP and the receiver does not understand the AVP, it shall return a rejection. If the M-bit is not set for an AVP, the receiver shall not return a rejection, whether or not it understands the AVP. If the receiver understands the AVP but the M-bit value does not match with the definition in this table, the receiver shall ignore the M-bit. + +NOTE 2: Depending on the concrete command. + +NOTE 3: The value of these attributes is defined in IETF RFC 4590 [20]. + +NOTE 4: The value of these attributes is defined in IETF RFC 7683 [23]. + +NOTE 5: The value of this attribute is defined in IETF RFC 7944 [26]. + +NOTE 6: The value of this attribute is defined in IETF RFC 8583 [27]. + +### 6.3.1 Visited-Network-Identifier AVP + +The Visited-Network-Identifier AVP is of type OctetString. This AVP contains an identifier that helps the HSS to identify the visited network (e.g. the visited network domain name). Coding of octets is H-PLMN operator specific. The I-CSCF maps a received P-Visited-Network-ID onto an Octet String value that is consistently configured in I-CSCF and HSS to uniquely identify the visited network. + +### 6.3.2 Public-Identity AVP + +The Public-Identity AVP is of type UTF8String. This AVP contains the public identity of a user in the IMS. The syntax of this AVP corresponds either to a SIP URL (with the format defined in IETF RFC 3261 [3] and IETF RFC 2396 [4]) or a TEL URL (with the format defined in IETF RFC 3966 [8]). Both SIP URL and TEL URL shall be in canonical form, as described in 3GPP TS 23.003 [13]. + +### 6.3.3 Server-Name AVP + +The Server-Name AVP is of type UTF8String. This AVP contains a SIP-URL (as defined in IETF RFC 3261 [3] and IETF RFC 2396 [4]), used to identify a SIP server (e.g. S-CSCF name). + +### 6.3.4 Server-Capabilities AVP + +The Server-Capabilities AVP is of type Grouped. This AVP contains information to assist the I-CSCF in the selection of an S-CSCF. + +AVP format + +Server-Capabilities ::= + +\*[Mandatory-Capability] +\*[Optional-Capability] +\*[Server-Name] +\*[AVP] + +### 6.3.5 Mandatory-Capability AVP + +The Mandatory-Capability AVP is of type Unsigned32. Each value included in this AVP can be used to represent a single determined mandatory capability or a set of capabilities of an S-CSCF, as described in 3GPP TS 29.228 [1] (clause 6.7). + +### 6.3.6 Optional-Capability AVP + +The Optional-Capability AVP is of type Unsigned32. Each value included in this AVP can be used to represent a single determined optional capability or a set of capabilities of an S-CSCF, as described in 3GPP TS 29.228 [1] (clause 6.7). + +### 6.3.7 User-Data AVP + +The User-Data AVP is of type OctetString. This AVP contains the user data required to give service to a user. The exact content and format of this AVP is described in 3GPP TS 29.228 [1]. + +### 6.3.8 SIP-Number-Auth-Items AVP + +The SIP-Number-Auth-Items AVP is of type Unsigned32. + +When used in a request, the SIP-Number-Auth-Items indicates the number of authentication vectors the S-CSCF is requesting. This can be used, for instance, when the client is requesting several pre-calculated authentication vectors. In the answer message, the SIP-Number-Auth-Items AVP indicates the actual number of SIP-Auth-Data-Item AVPs provided by the Diameter server. + +### 6.3.9 SIP-Authentication-Scheme AVP + +The Authentication-Scheme AVP is of type UTF8String and indicates the authentication scheme used in the authentication of SIP messages. The following values are defined: + +- "Digest-AKAv1-MD5": it indicates IMS-AKA authentication scheme. + +NOTE 1: The S-CSCF uses the "Digest-AKAv1-MD5" authentication scheme towards the HSS for Digest-AKAv1 and Digest-AKAv2 versions, since they require from the HSS the same procedures that are already supported. + +- "SIP Digest": it indicates SIP Digest authentication scheme. +- "NASS-Bundled": it indicates NASS Bundled authentication scheme. +- "Early-IMS-Security": it indicates GPRS-IMS-Bundled authentication scheme. +- "Unknown": it indicates that the authentication scheme to be used is unknown at this point. + +### 6.3.10 SIP-Authenticate AVP + +The SIP-Authenticate AVP is of type OctetString and contains specific parts of the data portion of the WWW-Authenticate or Proxy-Authenticate SIP headers that are to be present in a SIP response. + +It shall contain, binary encoded, the concatenation of the authentication challenge RAND and the token AUTN. See 3GPP TS 33.203 [3] for further details about RAND and AUTN. The Authentication Information has a fixed length of 32 octets; the 16 most significant octets shall contain the RAND, the 16 least significant octets shall contain the AUTN. + +### 6.3.11 SIP-Authorization AVP + +The SIP-Authorization AVP is of type OctetString and contains specific parts of the data portion of the Authorization or Proxy-Authorization SIP headers suitable for inclusion in a SIP request. + +When included in an Authentication Request, it shall contain the concatenation of RAND, as sent to the terminal, and AUTS, as received from the terminal. RAND and AUTS shall both be binary encoded. See 3GPP TS 33.203 [3] for further details about RAND and AUTS. The Authorization Information has a fixed length of 30 octets; the 16 most significant octets shall contain the RAND, the 14 least significant octets shall contain the AUTS. + +When included in an Authentication Request Response, it shall contain, binary encoded, the expected response XRES. See 3GPP TS 33.203 [3] for further details about XRES. + +### 6.3.12 SIP-Authentication-Context AVP + +The SIP-Authentication-Context AVP is of type OctetString. + +### 6.3.13 SIP-Auth-Data-Item AVP + +The SIP-Auth-Data-Item is of type Grouped, and contains the authentication and/or authorization information for the Diameter client. + +AVP format + +SIP-Auth-Data-Item ::= < AVP Header : 612 10415 > + +[ SIP-Item-Number ] + [ SIP-Authentication-Scheme ] + [ SIP-Authenticate ] + [ SIP-Authorization ] + [ SIP-Authentication-Context ] + [ Confidentiality-Key ] + [ Integrity-Key ] + [ SIP-Digest-Authenticate ] + [ Framed-IP-Address ] + [ Framed-IPv6-Prefix ] + [ Framed-Interface-Id ] + \* [ Line-Identifier ] + \* [AVP] + +### 6.3.14 SIP-Item-Number AVP + +The SIP-Item-Number AVP is of type Unsigned32. + +### 6.3.15 Server-Assignment-Type AVP + +The Server-Assignment-Type AVP is of type Enumerated, and indicates the type of server update, request or notification being performed in a Server-Assignment-Request operation. The following values are defined: + +NO\_ASSIGNMENT (0) + +This value is used to request from HSS the user profile assigned to one or more public identities and to retrieve the S-CSCF restoration information for a registered Public User Identity, without affecting the registration state of those identities. + +#### REGISTRATION (1) + +The request is generated as a consequence of a first registration of an identity. + +##### RE\_REGISTRATION (2) + +The request corresponds to the re-registration of an identity or update of the S-CSCF Restoration Information. + +##### UNREGISTERED\_USER (3) + +The request is generated in the following cases: + +- The S-CSCF received a request for a Public Identity that is not registered, or +- An AS sent an originating request on behalf of a Public Identity that is not registered, or +- The S-CSCF identified a P-CSCF failure for a Public User Identity that is registered with only one Private User Identity and started the P-CSCF Restoration procedure including the P-CSCF Restoration Indication in the request to the HSS. + +##### TIMEOUT\_DEREGISTRATION (4) + +The SIP registration timer of an identity has expired. + +##### USER\_DEREGISTRATION (5) + +The S-CSCF has received a user initiated de-registration request. + +##### TIMEOUT\_DEREGISTRATION\_STORE\_SERVER\_NAME (6) + +The request is generated in the following cases: + +The SIP registration timer of an identity has expired. The S-CSCF keeps the user data stored in the S-CSCF and requests HSS to store the S-CSCF name. + +The S-CSCF identified a P-CSCF failure for a Public User Identity that is registered with only one Private User Identity and started the PCRF-based P-CSCF Restoration procedure. + +##### USER\_DEREGISTRATION\_STORE\_SERVER\_NAME (7) + +The S-CSCF has received a user initiated de-registration request. The S-CSCF keeps the user data stored in the S-CSCF and requests HSS to store the S-CSCF name. + +##### ADMINISTRATIVE\_DEREGISTRATION (8) + +The request is generated in the following cases: + +- The S-CSCF, due to administrative reasons or network issues, has performed the de-registration of an identity. +- The S-CSCF identified a P-CSCF failure for a Public User Identity that is registered with more than one Private User Identity and started the P-CSCF Restoration procedure including the P-CSCF Restoration Indication in the request to the HSS. + +The S-CSCF identified a P-CSCF failure for a Public User Identity that is registered with more than one Private User Identity and started the PCRF-based P-CSCF Restoration procedure. + +##### AUTHENTICATION\_FAILURE (9) + +The authentication of a user has failed. + +##### AUTHENTICATION\_TIMEOUT (10) + +The authentication timeout has occurred. + +##### DEREGISTRATION\_TOO\_MUCH\_DATA (11) + +The S-CSCF has requested user profile information from the HSS and has received a volume of data higher than it can accept. + +##### AAA\_USER\_DATA\_REQUEST (12) + +Used in the SWx protocol, defined in 3GPP TS 29.273 [18]. This value is not used in the Cx protocol. + +##### PGW\_UPDATE (13) + +Used in the SWx protocol, defined in 3GPP TS 29.273 [18]. This value is not used in the Cx protocol. + +#### RESTORATION (14) + +Used in the SWx protocol, defined in 3GPP TS 29.273 [18]. This value is not used in the Cx protocol. + +### 6.3.16 Deregistration-Reason AVP + +The Deregistration-Reason AVP is of type Grouped, and indicates the reason for a de-registration operation. + +AVP format + +``` +Deregistration-Reason ::= < AVP Header : 615 10415 > + { Reason-Code } + [ Reason-Info ] + * [AVP] +``` + +### 6.3.17 Reason-Code AVP + +The Reason-Code AVP is of type Enumerated, and defines the reason for the network initiated de-registration. The following values are defined: + +PERMANENT\_TERMINATION (0) +NEW\_SERVER\_ASSIGNED (1) +SERVER\_CHANGE (2) +REMOVE\_S-CSCF (3) + +The detailed behaviour of the S-CSCF is defined in 3GPP TS 29.228 [1]. + +### 6.3.18 Reason-Info AVP + +The Reason-Info AVP is of type UTF8String, and contains textual information to inform the user about the reason for a de-registration. + +### 6.3.19 Charging-Information AVP + +The Charging-Information is of type Grouped, and contains the addresses of the charging functions. + +AVP format + +``` +Charging-Information ::= < AVP Header : 618 10415 > + [ Primary-Event-Charging-Function-Name ] + [ Secondary-Event-Charging-Function-Name ] +``` + +[ Primary-Charging-Collection-Function-Name ] + +[ Secondary-Charging-Collection-Function-Name ] + +\*[ AVP ] + +### 6.3.20 Primary-Event-Charging-Function-Name AVP + +The Primary-Event-Charging-Function-Name AVP is of type DiameterURI. This AVP contains the address of the Primary Online Charging Function. The receiving network element shall extract the FQDN of the DiameterURI in this AVP and may use it as content of the Destination-Host AVP for the Diameter accounting requests. The parent domain of the FQDN in the DiameterURI shall be used as Destination-Realm. The number of labels used for the Destination-Realm shall be determined before the Charging Information is provisioned and may be a configuration option. + +NOTE: A FQDN is an absolute domain name including a subdomain and its parent domain. The subdomain and the parent domain contain one or more labels separated by dots. + +### 6.3.21 Secondary-Event-Charging-Function-Name AVP + +The Secondary-Event-Charging-Function-Name AVP is of type DiameterURI. This AVP contains the address of the Secondary Online Charging Function. The Destination-Host and Destination-Realm values for the Diameter accounting requests should be extracted from the DiameterURI in the way indicated in clause 6.3.20. + +### 6.3.22 Primary-Charging-Collection-Function-Name AVP + +The Primary-Charging-Collection-Function-Name AVP is of type DiameterURI. This AVP contains the address of the Primary Charging Data Function. The Destination-Host and Destination-Realm values for the Diameter accounting requests should be extracted from the DiameterURI in the way indicated in clause 6.3.20. + +### 6.3.23 Secondary-Charging-Collection-Function-Name AVP + +The Secondary-Charging-Collection-Function-Name AVP is of type DiameterURI. This AVP contains the address of the Secondary Charging Data Function. The Destination-Host and Destination-Realm for the Diameter accounting requests values should be extracted from the DiameterURI in the way indicated in clause 6.3.20. + +### 6.3.24 User-Authorization-Type AVP + +The User-Authorization-Type AVP is of type Enumerated, and indicates the type of user authorization being performed in a User Authorization operation, i.e. UAR command. The following values are defined: + +#### REGISTRATION (0) + +This value is used in case of the initial registration or re-registration. I-CSCF determines this from the Expires field or expires parameter in Contact field in the SIP REGISTER method if it is not equal to zero. + +This is the default value. + +#### DE\_REGISTRATION (1) + +This value is used in case of the de-registration. I-CSCF determines this from the Expires field or expires parameter in Contact field in the SIP REGISTER method if it is equal to zero. + +#### REGISTRATION\_AND\_CAPABILITIES (2) + +This value is used when the I-CSCF explicitly requests S-CSCF capability information from the HSS. The I-CSCF shall use this value when the user's current S-CSCF, which is stored in the HSS, cannot be contacted and a new S-CSCF needs to be selected + +### 6.3.25 Void + +### 6.3.26 User-Data-Already-Available AVP + +The User-Data-Already-Available AVP is of type Enumerated, and indicates to the HSS whether or not the S-CSCF already has the part of the user profile that it needs to serve the user. The following values are defined: + +USER\_DATA\_NOT\_AVAILABLE (0) + +The S-CSCF does not have the data that it needs to serve the user. + +USER\_DATA\_ALREADY\_AVAILABLE (1) + +The S-CSCF already has the data that it needs to serve the user. + +### 6.3.27 Confidentiality-Key AVP + +The Confidentiality-Key is of type OctetString, and contains the Confidentiality Key (CK). + +### 6.3.28 Integrity-Key AVP + +The Integrity-Key is of type OctetString, and contains the Integrity Key (IK). + +### 6.3.29 Supported-Features AVP + +The Supported-Features AVP is of type Grouped. If this AVP is present it may inform the destination host about the features that the origin host supports for the application. The Feature-List AVP contains a list of supported features of the origin host. The Vendor-Id AVP and the Feature-List-ID AVP shall together identify which feature list is carried in the Supported-Features AVP for the Application-ID present in the command header. + +Where a Supported-Features AVP is used to identify features that have been defined by 3GPP, the Vendor-Id AVP shall contain the vendor ID of 3GPP. Vendors may define proprietary features, but it is strongly recommended that the possibility is used only as the last resort. Where the Supported-Features AVP is used to identify features that have been defined by a vendor other than 3GPP, it shall contain the vendor ID of the specific vendor in question. + +If there are multiple feature lists defined by the same vendor and the same application, the Feature-List-ID AVP shall differentiate those lists from one another. The destination host shall use the value of the Feature-List-ID AVP to identify the feature list. + +AVP format + +Supported-Features ::= < AVP header: 628 10415 > + +{ Vendor-Id } + +{ Feature-List-ID } + +{ Feature-List } + +\*[AVP] + +### 6.3.30 Feature-List-ID AVP + +The Feature-List-ID AVP is of type Unsigned32 and it contains the identity of a feature list. + +### 6.3.31 Feature-List AVP + +The Feature-List AVP is of type Unsigned32 and it contains a bit mask indicating the supported features of an application. When the bit set, indicates the corresponding feature is supported by the application. For the Cx application, the meaning of the bits has been defined in 7.1.1. + +### 6.3.32 Supported-Applications AVP + +The Supported-Applications AVP is of type Grouped and it contains the supported application identifiers of a Diameter node. + +AVP format + +``` +Supported-Applications ::= < AVP header: 631 10415 > + *[ Auth-Application-Id ] + *[ Acct-Application-Id ] + *[ Vendor-Specific-Application-Id ] + *[ AVP ] +``` + +### 6.3.33 Associated-Identities AVP + +The Associated-Identities AVP is of type Grouped and it contains the private user identities associated to an IMS subscription. + +AVP format + +``` +Associated-Identities ::= < AVP header: 632, 10415 > + *[ User-Name ] + *[ AVP ] +``` + +### 6.3.34 Originating-Request AVP + +The Originating-Request AVP is of type Enumerated. The following value is defined: + +ORIGINATING (0) + +This value indicates to the HSS that the request is related to an AS originating SIP request in the Location-Information-Request operation. + +### 6.3.35 Wildcarded-Public-Identity AVP + +The Wildcarded-Public-Identity AVP is of type UTF8String. This AVP contains a Wildcarded PSI or Wildcarded Public User Identity stored in the HSS. The syntax of the contents of this AVP is described in 3GPP TS 23.003 [13]. + +### 6.3.36 SIP-Digest-Authenticate AVP + +The SIP-Digest-Authenticate is of type Grouped and it contains a reconstruction of either the SIP WWW-Authenticate or Proxy-Authentication header fields specified in IETF RFC 2617 [14]. + +AVP format + +``` +SIP-Digest-Authenticate ::= < AVP Header: 635 10415 > + { Digest-Realm } + [ Digest-Algorithm ] + { Digest-QoP } + { Digest-HA1 } + *[ AVP ] +``` + +### 6.3.37 Digest-Realm AVP + +The Digest-Realm AVP is defined in IETF RFC 4740 [15]. + +### 6.3.38 Void + +### 6.3.39 Digest-Algorithm AVP + +The Digest-Algorithm AVP is defined in IETF RFC 4740 [15]. + +### 6.3.40 Digest-QoP AVP + +The Digest-QoP AVP is defined in IETF RFC 4740 [15]. + +### 6.3.41 Digest-HA1 AVP + +The Digest-HA1 AVP is defined in IETF RFC 4740 [15]. + +### 6.3.42 Line-Identifier AVP + +The Line-Identifier AVP is of type OctetString. This AVP has Vendor Id ETSI (13019) and AVP code 500. This AVP contains a fixed broadband access line identifier associated with the user. + +### 6.3.43 Wildcarded-IMPU AVP + +The Wildcarded-IMPU AVP is of type UTF8String. This AVP contains a Wildcarded Public User Identity stored in the HSS. The syntax of the contents of this AVP is described in 3GPP TS 23.003 [13]. + +Note: This AVP is used by Sh interface as specified in the 3GPP TS 29.328 [16] and 3GPP TS 29.329 [11]. + +### 6.3.44 UAR-Flags AVP + +The UAR-Flags AVP is of type Unsigned32 and it contains a bit mask. The meaning of the bits is defined in the following table: + +**Table 6.3.44.1: UAR-Flags** + +| Bit | Name | Description | +|-----------------------------------------------------------------------------------------------------------|----------------------------|----------------------------------------------------------------------------------------------| +| 0 | IMS Emergency Registration | This bit, when set, indicates that the request corresponds to an IMS Emergency Registration. | +| Bits not defined in this table shall be cleared by the sending I-CSCF and discarded by the receiving HSS. | | | + +### 6.3.45 Loose-Route-Indication AVP + +The Loose-Route-Indication AVP is of type Enumerated and indicates to the S-CSCF whether or not the loose route mechanism is required to serve the registered Public User Identities. The following values are defined: + +LOOSE\_ROUTE\_NOT\_REQUIRED (0) + +LOOSE\_ROUTE\_REQUIRED (1) + +### 6.3.46 SCSCF-Restoration-Info AVP + +The SCSCF-Restoration-Info AVP is of type Grouped and it contains the information required for an S-CSCF to handle the requests for a user. + +AVP format + +``` +SCSCF-Restoration-Info ::= < AVP Header: 639, 10415> + { User-Name } + 1*{ Restoration-Info } + [ Registration-Time-Out ] + [ SIP-Authentication-Scheme ] + *[ AVP ] +``` + +### 6.3.47 Path AVP + +The Path AVP is of type OctetString and it contains a comma separated list of SIP proxies in the Path header as defined in IETF RFC 3327 [17]. + +### 6.3.48 Contact AVP + +The Contact AVP is of type OctetString and it contains the Contact Addresses and Parameters in the Contact header as defined in IETF RFC 3261 [11]. + +### 6.3.49 Subscription-Info AVP + +The Subscription-Info AVP is of type Grouped and it contains the UE's subscription information. The Contact AVP contains the Contact Address and Parameters in the Contact header of the subscription request. + +AVP format + +``` +Subscription-Info ::= < AVP Header: 642, 10415> + { Call-ID-SIP-Header } + { From-SIP-Header } + { To-SIP-Header } + { Record-Route } + {Contact} + *[ AVP ] +``` + +#### 6.3.49.1 Call-ID-SIP-Header AVP + +The Call-ID-SIP-Header AVP is of type OctetString and it contains the information in the Call-ID header as defined in IETF RFC 3261 [11]. + +#### 6.3.49.2 From-SIP-Header AVP + +The From-SIP-Header AVP is of type OctetString and it contains the information in the From header as defined in IETF RFC 3261 [11]. + +#### 6.3.49.3 To-SIP-Header AVP + +The To-SIP-Header AVP is of type OctetString and it contains the information in the To header as defined in IETF RFC 3261 [11]. + +#### 6.3.49.4 Record-Route AVP + +The Record-Route AVP is of type OctetString and it contains a comma separated list of Record Route header(s) as defined in IETF RFC 3261 [11]. + +### 6.3.50 Associated-Registered-Identities AVP + +The Associated-Registered-Identities AVP is of type Grouped and it contains the Private User Identities registered with the Public User Identity received in the request command. + +AVP format + +Associated-Registered-Identities ::= < AVP header: 647, 10415 > +                                    \*[ User-Name ] +                                    \*[ AVP ] + +### 6.3.51 Multiple-Registration-Indication + +The Multiple-Registration-Indication AVP is of type Enumerated and indicates to the HSS whether or not the request is related to a multiple registration. The following values are defined: + +NOT\_MULTIPLE\_REGISTRATION (0) +MULTIPLE\_REGISTRATION (1) + +### 6.3.52 Restoration-Info AVP + +The Restoration-Info AVP is of type Grouped and it contains the information related to a specific registration required for an S-CSCF to handle the requests for a user. The Contact AVP contains the Contact Address and Parameters in the Contact header of the registration request. + +AVP format + +Restoration-Info ::= < AVP Header: 649, 10415 > +                                    { Path } +                                    { Contact } +                                    [ Initial-CSeq-Sequence-Number ] +                                    [ Call-ID-SIP-Header ] +                                    [ Subscription-Info ] +                                    [ P-CSCF-Subscription-Info ] +                                    \*[ AVP ] + +### 6.3.53 Framed-IP-Address AVP + +The Framed-IP-Address AVP is defined in IETF RFC 4005 [19]. + +### 6.3.54 Framed-IPv6-Prefix AVP + +The Framed-IPv6-Prefix AVP is defined in IETF RFC 4005 [19], and it shall be encoded as defined in IETF RFC 3162 [22]. + +### 6.3.55 Framed-Interface-Id AVP + +The Framed-Interface-Id AVP is defined in IETF RFC 4005 [19]. + +### 6.3.56 Session-Priority AVP + +The Session-Priority AVP is of type Enumerated and indicates to the HSS the session's priority. The following values are defined: + +PRIORITY-0 (0) + +PRIORITY-1 (1) + +PRIORITY-2 (2) + +PRIORITY-3 (3) + +PRIORITY-4 (4) + +PRIORITY-0 is the highest priority. + +The value of the AVP when sent to the HSS is mapped from the value received by the CSCF as described in 3GPP TS 24.229 table A.162. The mapping is operator specific. + +This AVP may be placed as close to the Diameter header as possible in order to potentially allow optimized processing at the receiver. + +### 6.3.57 Identity-with-Emergency-Registration AVP + +The Identity-with-Emergency-Registration AVP is of type Grouped and it contains a pair of private/public user identities which are emergency registered. + +AVP format + +Identity-with-Emergency-Registration ::= < AVP header: 651, 10415 > + +{ User-Name } + +{ Public-Identity } + +\*[ AVP ] + +### 6.3.58 Privileged-Sender-Indication AVP + +The Privileged-Sender-Indication AVP is of type Enumerated and indicates to the S-CSCF whether or not the Private User Identity shall be considered as a privileged sender. The following values are defined: + +NOT\_PRIVILEGED\_SENDER (0) PRIVILEGED\_SENDER (1) + +### 6.3.59 LIA-Flags + +The LIA-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 6.3.59.1. + +**Table 6.3.59.1: LIA-Flags** + +| Bit | Name | Description | +|-----------------------------------------------------------------------------------------------------------------|-------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | PSI Direct Routing Indication | This bit, when set, indicates the request corresponds to PSI Direct Routing, what implies that HSS returns an AS name in Server-Name AVP. | +| NOTE: Bits not defined in this table shall be cleared by the sending HSS and discarded by the receiving I-CSCF. | | | + +### 6.3.60 OC-Supported-Features + +The OC-Supported-Features AVP is of type Grouped and it is defined in IETF RFC 7683 [23]. This AVP is used to support Diameter overload control mechanism. + +### 6.3.61 OC-OLR + +The OC-OLR AVP is of type Grouped and it is defined in IETF RFC 7683 [23]. This AVP is used to support Diameter overload control mechanism. + +### 6.3.62 Initial-CSeq-Sequence-Number AVP + +The Initial-CSeq-Sequence-Number AVP is of type Unsigned32, and it contains the sequence number of the CSeq header field contained in the initial successful REGISTER request, as defined in IETF RFC 3261 [11]. + +### 6.3.63 SAR-Flags + +The SAR-Flags AVP is of type Unsigned32 and it contains a bit mask. The meaning of the bits is defined in the following table: + +**Table 6.3.63.1: SAR-Flags** + +| Bit | Name | Description | +|-----|-------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | P-CSCF Restoration Indication | This bit, when set, indicates that the P-CSCF-Restoration-mechanism feature shall be executed, as described in 3GPP TS 23.380 [24], clause 5.4.
This AVP is optionally present only when Server-Assignment-Type takes the value ADMINISTRATIVE_DEREGISTRATION or UNREGISTERED_USER. | + +Note: Bits not defined in this table shall be cleared by the sending S-CSCF and discarded by the receiving HSS. + +### 6.3.64 Allowed-WAF-WWSF-Identities AVP + +The Allowed-WAF-WWSF-Identities AVP is of type Grouped and contains the addresses of the WAFs and WWSFs allowed for the subscription. + +AVP format + +Allowed-WAF-WWSF-Identities ::= < AVP Header : 656 10415 > + +\*[ WebRTC-Authentication-Function-Name ] + +\*[ WebRTC-Web-Server-Function-Name ] + +\*[ AVP ] + +### 6.3.65 WebRTC-Authentication-Function-Name AVP + +The WebRTC-Authentication-Function-Name AVP is of type UTF8String and contains the address of a WAF allowed for the subscription. For the format of the string see IETF draft-holmberg-sipcore-auth-id-01 [25]. + +### 6.3.66 WebRTC-Web-Server-Function-Name AVP + +The WebRTC-Web-Server-Function-Name AVP is of type UTF8String and contains the address of a WWSF allowed for the subscription. For the format of the string see IETF draft-holmberg-sipcore-auth-id-01 [25]. + +### 6.3.67 DRMP AVP + +The DRMP AVP is of type Enumerated and it is defined in IETF RFC 7944 [26]. This AVP allows the HSS/SLF and the S-CSCF/I-CSCF to indicate the relative priority of Diameter messages. The DRMP AVP may be used to set the DSCP marking for transport of the associated Diameter message. + +### 6.3.68 Load + +The Load AVP is of type Grouped and it is defined in IETF RFC 8583 [27]. This AVP is used to support the Diameter load control mechanism. + +### 6.3.69 RTR-Flags + +The RTR-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 6.3.69.1. + +**Table 6.3.69.1: RTR-Flags** + +| Bit | Name | Description | +|-----|---------------------------------------|----------------------------------------------------------------------------------------------------| +| 0 | Reference Location Information change | This bit, when set, indicates the request is sent due to change of Reference Location Information. | + +NOTE: Bits not defined in this table shall be cleared by the sending HSS and discarded by the receiving I-CSCF. + +### 6.3.70 P-CSCF-Subscription-Info AVP + +The P-CSCF-Subscription-Info AVP is of type Grouped and it contains the P-CSCF's subscription information. The Contact AVP contains the Contact Address and Parameters in the Contact header of the subscription request. + +AVP format + +``` +P-CSCF-Subscription-Info ::= < AVP Header: 660, 10415> + { Call-ID-SIP-Header } + { From-SIP-Header } + { To-SIP-Header } + { Contact } + *[ AVP ] +``` + +### 6.3.71 Registration-Time-Out + +The Registration-Time-Out AVP is of type Time (see IETF RFC 6733 [28]), and contains the point of time at which the UE's registration expires. + +## 6.4 Use of namespaces + +This clause contains the namespaces that have either been created in this specification, or the values assigned to existing namespaces managed by IANA. + +### 6.4.1 AVP codes + +This specification assigns the AVP values from the AVP Code namespace managed by 3GPP for its Diameter vendor-specific applications. See clause 6.3 for the assignment of the namespace in this specification. + +### 6.4.2 Experimental-Result-Code AVP values + +This specification has assigned Experimental-Result-Code AVP values 2001-2005 and 5001-5011. See clause 6.2. + +### 6.4.3 Command Code values + +This specification assigns the values 300-305 from the range allocated by IANA to 3GPP in IETF RFC 3589 [12]. + +### 6.4.4 Application-ID value + +IANA has allocated the value 16777216 for the 3GPP Cx interface application. + +# 7 Special Requirements + +## 7.1 Version Control + +New functionality - i.e. functionality beyond the Rel-5 standard - shall be introduced by post-Rel-5 versions of this specification to the Diameter applications as follows: + +1. If possible, the new functionality shall be defined optional. +2. If backwards incompatible changes can not be avoided, the new functionality should be introduced as a feature, see 7.1.1. +3. If the change would be backwards incompatible even as if it was defined as a feature, a new version of the interface shall be created by changing the application identifier of the Diameter application, see 7.1.2. + +### 7.1.1 Defining a new feature + +The base functionality for the Cx is the 3GPP Rel-5 standard and a feature is an extension to that functionality. A feature is a functional entity that has a significant meaning to the operation of a Diameter application i.e. a single new parameter without a substantial meaning to the functionality of the Diameter endpoints should not be defined to be a new feature. If the support for a feature is defined mandatory in a post-Rel-5 versions of this specification, the feature concept enables interworking between Diameter endpoints regardless of whether they support all, some or none of the features of the application. Features should be defined so that they are independent from one another. + +The content of a feature shall be defined as a part of the specification of the affected application messages. If new AVPs are added to the commands because of the new feature, the new AVPs shall have the 'M' bit cleared and the AVP shall not be defined mandatory in the command ABNF. The support for a feature may be defined to be mandatory behaviour of a node. + +As an option to defining a feature, an extension to S-CSCF functionality for post-Rel-5 version may be defined as part of the list of mandatory capabilities that is used by the I-CSCF during the process of selecting an S-CSCF, as described in 3GPP TS 29.228 [1]. Any new feature should be taken into account in the definition of the list of mandatory and optional S-CSCF capabilities. Guidelines for the definition of S-CSCF Capabilities are described in 3GPP TS 29.228 [1]. + +The following table of features shall apply to the Cx interface. + +Table 7.1.1: Features of Feature-List-ID 1 used in Cx + +| Feature bit | Feature | M/O | Description | +|-------------|-------------------|-----|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | SiFC | O |

Shared iFC sets

This feature is applicable for the SAR/SAA and PPR/PPA command pairs. If both the HSS and the S-CSCF support this feature, subsets of Initial Filter Criteria may be shared by several service profiles and the HSS shall download the shared iFC sets implicitly by downloading the unique identifiers of the shared iFC sets to the S-CSCF. By means of a locally administered database, the S-CSCF then maps the downloaded identifiers onto the shared iFC sets.

If the DSAI feature, as defined in 3GPP TS 29.328 [16], is also active with the shared iFC sets feature then the HSS shall behave as described below:

If the DSAI feature is active with the shared iFC sets feature and if all the iFCs bounding to a Shared iFC set are not masked by the DSAI, the HSS shall download the unique identifier of the shared iFC set to the S-CSCF. If some iFCs or all the iFCs bounding to a shared iFC set are masked by the DSAI, the HSS shall not download the identifier of the shared iFC set. Instead the HSS shall

  • - download the remaining non masked iFCs of the shared iFC set explicitly or
  • - download suitable identifiers of other shared iFC sets, i.e. those covering exactly the remaining non masked iFCs and which do not contain masked iFCs or
  • - download a combination of identifiers of shared iFC sets and explicit iFCs which cover exactly the remaining non masked iFCs.

If the S-CSCF does not support this feature, the HSS shall not download identifiers of shared iFC sets. Instead as a default behavior the HSS shall (by means of a locally administered database) download the iFCs of a shared iFC set explicitly.

If the HSS does not support this feature, no special default behaviour is required for the S-CSCF.

Note: In using this feature option, the network operator is responsible for keeping the local databases in the S-CSCFs and HSSs consistent.

| +| 1 | AliasInd | M |

Alias Indication

This feature is applicable for the SAR/SAA and PPR/PPA command pairs. If both the HSS and the S-CSCF support this feature, different aliases groups may be sent within the same service profile. Identities within the same service profile that are aliases shall be sent with identical alias group ID.

If the S-CSCF does not support this feature, the HSS shall send within the service profile only those identities that are aliases. Public User Identities that are not aliases of each other shall be sent in different service profiles even if these service profiles have exactly the same Core Network Service Authorization, Initial Filter Criteria, and Shared iFC Set information and these service profiles only differ in the contained Public User Identities. This is done in order to allow backwards compatibility since part of the handling of aliases in the S-CSCF was there before this indication was required and it applied to identities that share the same service profile and implicit registration set. In this case, the S-CSCF does not provide any additional treatment of aliases than that which existed before this indication was required.

If the HSS does not support this feature, no special default behaviour is required for the S-CSCF.

Note: All identities included in a single SAA or PPR command are always within one implicit registration set.

| +| 2 | IMSRestorationInd | O |

IMS Restoration Indication

This feature is applicable for the UAR/UAA, LIR/LIA, SAR/SAA command pairs.

If both the HSS and the I-CSCF support this feature, in case the S-CSCF currently assigned in the HSS to the Public User Identity cannot be contacted the I-CSCF shall trigger the assignment of a new S-CSCF.

If both the HSS and the S-CSCF support this feature, the S-CSCF shall send S-CSCF Restoration Information to the HSS. The HSS shall send this information element in SAA to the S-CSCF when required.

If the S-CSCF does not support this feature, the HSS shall not send the IMS Restoration Information to the S-CSCF.

| + +| | | | | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 3 | P-CSCF-Restoration-mechanism | O | HSS-based P-CSCF Restoration mechanism.
This feature is applicable for the SAR/SAA command pair.
If both the HSS and the S-CSCF support this feature, the S-CSCF shall send the P-CSCF-Restoration-Indication in SAR-Flags AVP to the HSS when required as described by 3GPP TS 23.380 [24] clause 5.4.
If the HSS does not support this feature, the S-CSCF shall not send the P-CSCF-Restoration-Indication to HSS. | +| Feature bit: The order number of the bit within the Supported-Features AVP, e.g. "1".
Feature: A short name that can be used to refer to the bit and to the feature, e.g. "MOM".
M/O: Defines if the implementation of the feature is mandatory ("M") or optional ("O").
Description: A clear textual description of the feature. | | | | + +The origin host may discover the supported features of the destination host with the dynamic discovery mechanism defined in 7.2 or via local O&M interfaces. + +### 7.1.2 Changing the version of the interface + +The version of an interface shall be changed by a future version of this specification only if there is no technically feasible means to avoid backwards incompatible changes to the Diameter application, i.e. to the current version of the interface. However, if the incompatible changes can be capsulated within a feature, there is no need to change the version of the interface. The versioning of an interface shall be implemented by assigning a new application identifier for the interface. This procedure is in line with the Diameter base protocol (see IETF RFC 3588) which defines that if an incompatible change is made to a Diameter application, a new application identifier shall be assigned for the Diameter application. + +The following table shall apply to the Cx interface, column Application identifier lists the used application identifiers on Cx and 3GPP. + +**Table 7.1.2: Application identifiers used in Cx** + +| Application identifier | First applied | +|------------------------|---------------| +| 16777216 | 3GPP Rel-5 | + +The origin host may discover which versions of an interface the destination host supports within the capabilities exchange (i.e. CER/CEA command), via the error messages defined in the chapter 7.3 or via local O&M interfaces. + +## 7.2 Supported features + +Features that are not indicated in the Supported-Features AVPs within a given application message shall not be used to construct that message. A request application message shall always be compliant with the list of supported features indicated in the Supported-Features AVPs within the application message. If a feature does not have an effect on constructing an application message, the message is by definition compliant with the feature. If no features are indicated in the application message, no features - i.e. no extensions to Rel-5 - shall be used to construct the application message. An answer application message shall always indicate in the Supported-Features AVPs the complete set of features supported by the sender of the answer application message. An answer application message shall be compliant with the features commonly supported by the sender of the request and answer application messages. + +The sender of a request application message shall discover for a given application message pair which features a destination host supports as described in 7.2.1. The discovered features of one command pair may be applicable to other command pairs within the application. Different commands within an application may support a different set of features. After discovering the features a destination host supports for a given application message pair, the sender of the request application message may store the information on the supported features of the destination host and it may use the features the destination host supports to construct the subsequent request application messages sent to the destination host. + +### 7.2.1 Dynamic discovery of supported features + +When sending a request application message to a destination host whose supported features the sender does not know, the request application message shall include the Supported-Features AVP containing the set of features required to + +process the request and generate the answer. An exception to this is where the origin host does not use any features to construct the request application message and it is not prepared to accept an answer application message which is constructed by making use of any features. For this exception the origin host need not include the Supported-Features AVP within the message. + +The Supported-Features AVP within a request application message shall always have the 'M' bit set and within an answer application message the AVP shall never have the 'M' bit set. An exception to this is where the origin host does not use any supported feature to construct the request application message but is prepared to accept an answer application message which is constructed by making use of supported features. For this exception it is optional for the origin host to set the 'M' bit of the Supported-Features AVP within the request application message. + +On receiving a request application message, the destination host shall do one of the following: + +- If it supports all features indicated in the Supported-Features AVPs within the request message, the answer application message shall include Supported-Features AVPs identifying the complete set of features that it supports. The Experimental-Result-Code AVP shall not be set to DIAMETER\_ERROR\_FEATURE\_UNSUPPORTED. +- If the request application message does not contain any Supported-Features AVPs, the answer application message shall include either Supported-Features AVPs identifying the complete set of features that it supports or, if it does not support any features, no Supported-Features AVPs shall be present. The Experimental-Result-Code AVP shall not be set to DIAMETER\_ERROR\_FEATURE\_UNSUPPORTED. +- If it does not support all the features indicated in the Supported-Features AVPs with the 'M' bit set, it shall return the answer application message with the Experimental-Result-Code AVP set to DIAMETER\_ERROR\_FEATURE\_UNSUPPORTED and it shall include also Supported-Features AVPs containing lists of all features that it supports. +- If it does not support Supported-Features AVP and it receives a request application message containing Supported-Features AVPs with the 'M' bit set, it will return the answer application message with the Result-Code AVP set to DIAMETER\_AVP\_UNSUPPORTED and a Failed-AVP AVP containing at least one Supported-Features AVP as received in the request application message. + +If an answer application message is received with the Experimental-Result-Code AVP set to DIAMETER\_ERROR\_FEATURE\_UNSUPPORTED or with the Result-Code AVP set to DIAMETER\_AVP\_UNSUPPORTED, the sender of the request application message may, based on the information in the received Supported-Features AVP or the lack of the AVP in the message, re-send the Diameter message containing only the common supported features. + +## 7.3 Interface versions + +The sender of the request application message may discover which versions of an interface a destination host supports together with the capabilities exchange (i.e. CER/CEA command pair) and with error mechanisms defined to the application messages in 7.3.1. The sender of the request application message should store information on all versions of the interface the destination host supports. The sender of the request application message should use the latest common version of the application supported by the destination host to send the request. + +If the receiver of the request application message itself or the versions of the interface it supports are not yet known, the sender of the request application message should use the latest supported version of the interface of the Diameter peer (i.e. Diameter proxy, redirect or relay agent) discovered during the capabilities exchange. If the Diameter peer is a redirect or relay agent, which advertises the 0xffffffff as an application identifier, the sender of the request application message shall use its own latest supported version of the interface when initiating the request. + +### 7.3.1 Discovery of supported interface versions + +When a Diameter agent receives a request application message and the Diameter agent doesn't find any upstream peer that would support the application identifier indicated in the request, the Diameter agent shall return the result code DIAMETER\_UNABLE\_TO\_DELIVER and it may also return the list of the application identifiers, which are supported by the destination host of the request application message. The supported application identifiers are carried in the answer application message in the Supported-Applications grouped AVP. + +Message format for the answer application message (based on the RFC 3588, clause 7.2) is as follows: + +``` + ::= < Diameter Header: code, ERR [PXY] > + 0*1< Session-Id > + { Origin-Host } + { Origin-Realm } + { Result-Code } + [ Origin-State-Id ] + [ Error-Reporting-Host ] + [ Proxy-Info ] + [ Supported-Applications ] + * [ AVP ] +``` + +If the receiver of a request application message does not support the application identifier indicated in the message, it shall return the result code DIAMETER\_APPLICATION\_UNSUPPORTED and it may also return the list of all application identifiers it supports. The supported application identifiers are carried in the Supported-Applications grouped AVP. The error message format is as specified above. + +If an answer application message is received with Result-Code AVP set to DIAMETER\_UNABLE\_TO\_DELIVER or Experimental-Result-Code AVP set to DIAMETER\_APPLICATION\_UNSUPPORTED and the message contains the Supported-Applications AVP, the receiver of the answer application message may select, based on the information in the Supported-Applications AVP, the latest common version of the interface with the destination host and re-send the Diameter message with a structure conforming to the ABNF of that release. + +# Annex A (informative): Change history + +| Date | TSG # | TSG Doc. | CR# | Rev | Subject/Comment | Out | +|----------|-------|-----------|------|-----|---------------------------------------------------------------------------------|-------| +| Jun 2002 | CN#16 | NP-020265 | | | Version 2.0.0 approved at CN#16 | 5.0.0 | +| Sep 2002 | CN#17 | NP-020449 | 001 | - | Add a reference to the new IETF RFC on SCTP checksum | 5.1.0 | +| Sep 2002 | CN#17 | NP-020449 | 003 | - | Wrong format of Charging Function Addresses | 5.1.0 | +| Sep 2002 | CN#17 | NP-020449 | 005 | - | Editorial mistake in the definition of command MAA | 5.1.0 | +| Dec 2002 | CN#18 | NP-020587 | 006 | - | Addition of User-Name AVP to SAA | 5.2.0 | +| Dec 2002 | CN#18 | NP-020587 | 007 | - | Editorial correction of SIP-Auth-Data-Item AVP definition | 5.2.0 | +| Dec 2002 | CN#18 | NP-020589 | 008 | 1 | Clarification of REGISTRATION AND CAPABILITIES value | 5.2.0 | +| Dec 2002 | CN#18 | NP-020588 | 009 | - | Correction in charging information | 5.2.0 | +| Dec 2002 | CN#18 | NP-020590 | 010 | 1 | Error handling in S-CSCF when receiving too much data | 5.2.0 | +| Mar 2003 | CN#19 | NP-030101 | 012 | 1 | Update TS 29.229 after Diameter has become RFC | 5.3.0 | +| Mar 2003 | CN#19 | NP-030101 | 015 | 1 | Clarification on Re-allocation of S-CSCF | 5.3.0 | +| Mar 2003 | CN#19 | NP-030101 | 018 | 1 | Handling of non supported data in the S-CSCF when the profile is being updated. | 5.3.0 | +| Mar 2003 | CN#19 | NP-030101 | 014 | - | Correction to the values of User-Authorizatin-Type AVP | 5.3.0 | +| Mar 2003 | CN#19 | NP-030101 | 013 | - | Replacement of the NAS-Session-Key AVP | 5.3.0 | +| Jun 2003 | CN#20 | NP-030215 | 019 | - | Conditionality of User-Name AVP in Server-Assignment-Answer | 5.4.0 | +| Sep 2003 | CN#21 | NP-030383 | 022 | 1 | Critical Correction on the PPR command code | 5.5.0 | +| Dec 2003 | CN#22 | NP-030500 | 021 | 1 | The S-CSCF name needs to be checked always in MAR and SAR | 5.6.0 | +| Dec 2003 | CN#22 | NP-030500 | 027 | - | User-Authorization-Type | 5.6.0 | +| Dec 2003 | CN#22 | NP-030518 | 029 | - | Clarification of inclusion of elements in Charging Information | 5.6.0 | +| Dec 2003 | CN#22 | | | | Application IDs and references updated | 5.6.0 | +| Mar 2004 | CN#23 | NP-040055 | 035 | - | Error for no identification in SAR command | 6.0.0 | +| Jun 2004 | CN#24 | NP-040215 | 037 | 1 | Update of the charging addresses from HSS | 6.1.0 | +| Jun 2004 | CN#24 | NP-040215 | 043 | - | Multimedia-Auth-Request (MAR) Command Message Format Corrections | 6.1.0 | +| Jun 2004 | CN#24 | NP-040215 | 050 | 2 | Use of Vendor-Id by 3GPP | 6.1.0 | +| Sep 2004 | CN#25 | NP-040395 | 065 | 2 | Application version control | 6.2.0 | +| Sep 2004 | CN#25 | NP-040401 | 056 | - | Optimization of User Profile Download | 6.2.0 | +| Sep 2004 | CN#25 | NP-040396 | 058 | - | Simplification of the User Profile Split concept | 6.2.0 | +| Sep 2004 | CN#25 | NP-040401 | 061 | - | Correction of the Application-Id code | 6.2.0 | +| Sep 2004 | CN#25 | NP-040412 | 063 | 1 | Re-numbering of 3GPP specific AVP codes | 6.2.0 | +| Dec 2004 | CN#26 | NP-040523 | 070 | - | Cx ABNF corrections | 6.3.0 | +| Mar 2005 | CN#27 | NP-050030 | 078 | 2 | Correction of authentication-related AVPs | 6.4.0 | +| Mar 2005 | CN#27 | NP-050037 | 079 | - | TEL-URI reference update | 6.4.0 | +| Mar 2005 | CN#27 | NP-050030 | 082 | 1 | Introduction of Failed-AVP | 6.4.0 | +| Jun 2005 | CT#28 | CP-050086 | 087 | - | Correction of reference | 6.5.0 | +| Jun 2005 | CT#28 | CP-050086 | 089 | 1 | Editorial corrections | 6.5.0 | +| Jun 2005 | CT#28 | CP-050086 | 088 | 2 | Corrections to message parameters | 6.5.0 | +| Sep 2005 | CT#29 | CP-050440 | 091 | 2 | Private identities on the Cx | 6.6.0 | +| Sep 2005 | CT#29 | CP-050282 | 093 | 1 | Charging-Information correction | 6.6.0 | +| Sep 2005 | CT#29 | CP-050296 | 094 | - | Error code cleanup | 6.6.0 | +| Dec 2005 | CT#30 | CP-050611 | 095 | 1 | Removal of overhead in Private Identities handling in RTR | 6.7.0 | +| Dec 2005 | CT#30 | CP-050611 | 098 | 1 | Incorrect Definition of Supported-Applications AVP | 6.7.0 | +| Jan 2006 | | | | | Rel-7 version was created because of ETSI TISPAN references. | 7.0.0 | +| Mar 2006 | CT#31 | CP-060084 | 0099 | - | Supported Features Text missing | 7.1.0 | +| Jun 2006 | CT#32 | CP-060302 | 0108 | - | S-CSCF reselection removal | 7.2.0 | +| Jun 2006 | CT#32 | CP-060308 | 0110 | 3 | Definition of new Feature for Cx | 7.2.0 | +| Sep 2006 | CT#33 | CP-060417 | 0114 | 3 | AS originating requests on behalf of a user | 7.3.0 | +| Sep 2006 | CT#33 | CP-060405 | 0118 | 2 | Correction of discovery of supported features in Sh and Cx | 7.3.0 | +| Sep 2006 | CT#33 | CP-060417 | 0119 | 1 | Sharing feature support information between command pairs | 7.3.0 | +| Dec 2006 | CT#34 | CP-060566 | 0124 | 1 | Optimization of handling of Wildcarded PSIs | 7.4.0 | +| Mar 2007 | CT#35 | CP-070020 | 0125 | 1 | M-bit in SupportedFeatures AVP | 7.5.0 | +| Sep 2007 | CT#37 | CP-070520 | 0129 | - | Misalignment of Mandatory Items in the MAR | 7.6.0 | +| Nov 2007 | CT#38 | CP-070744 | 0132 | 6 | Add alias as a new feature | 7.7.0 | +| Nov 2007 | CT#38 | CP-070755 | 0130 | 4 | Updates to 29.229 for Digest on the Cx interface | 8.0.0 | +| Mar 2008 | CT#39 | CP-080022 | 0138 | 2 | Update 29.229 for Supporting NASS-Bundled-Authentication | 8.1.0 | +| Mar 2008 | CT#39 | CP-080019 | 0139 | - | SIP Digest password push | 8.1.0 | +| Mar 2008 | CT#39 | CP-080019 | 0141 | 2 | Wildcarded Public User Identities | 8.1.0 | +| Jun 2008 | CT#40 | CP-080261 | 0145 | 1 | Correction to the behavior of the HSS defined in the SiFC feature | 8.2.0 | +| Jun 2008 | CT#40 | CP-080261 | 0146 | 2 | Realm and Host to be used for Charging | 8.2.0 | +| Sep 2008 | CT#41 | CP-080456 | 0149 | 1 | Emergency Public User Identity Removal | 8.3.0 | +| Sep 2008 | CT#41 | CP-080460 | 0155 | 1 | Support of "Loose-Route" indication from HSS | 8.3.0 | +| Sep 2008 | CT#41 | CP-080463 | 0156 | 1 | Cx Impacts of IMS Restoration Procedures | 8.3.0 | +| Sep 2008 | CT#41 | CP-080463 | 0158 | - | Add IMS Restoration as a new feature | 8.3.0 | +| Sep 2008 | CT#41 | CP-080463 | 0159 | 1 | Addition of Registered Private Identities in SAA | 8.3.0 | + +| | | | | | | | +|----------|-------|-----------|------|---|---------------------------------------------------------------------------------|--------| +| Sep 2008 | CT#41 | CP-080460 | 0160 | 1 | Add Assigned S-CSCF name to SAA | 8.3.0 | +| Dec 2008 | CT#42 | CP-080708 | 0163 | | Removal of Digest Domain | 8.4.0 | +| Dec 2008 | CT#42 | CP-080708 | 0166 | 2 | Diameter Proxy Agent - an alternative User Identity to HSS resolution mechanism | 8.4.0 | +| Mar 2009 | CT#43 | CP-090026 | 0167 | | Multiple Registrations in Registration | 8.5.0 | +| Mar 2009 | CT#43 | CP-090026 | 0168 | 1 | Restoration Information for Multiple Registrations | 8.5.0 | +| Mar 2009 | CT#43 | CP-090026 | 0169 | | Update for Restoration | 8.5.0 | +| Mar 2009 | CT#43 | CP-090051 | 0170 | 1 | Definition of Server-Assignment-Type values in Cx | 8.5.0 | +| Mar 2009 | CT#43 | CP-090028 | 0171 | | Support for GPRS IMS Bundled Authentication (GIBA) in Cx | 8.5.0 | +| Mar 2009 | CT#43 | CP-090025 | 0172 | | Use of canonical form for SIP URI/tel URI in Cx interface | 8.5.0 | +| Mar 2009 | CT#43 | CP-090026 | 0175 | 1 | Comma separated list for Path, Contact and Record-Route AVPs | 8.5.0 | +| Jun 2009 | CT#44 | CP-090484 | 0176 | 2 | Contact storage in reg event subscription | 8.6.0 | +| Jun 2009 | CT#44 | CP-090303 | 0177 | 1 | Comma separated list for path AVP | 8.6.0 | +| Sep | CT#45 | CP-090526 | 0181 | | Dx over SCTP | 8.7.0 | +| Dec 2009 | CT#46 | CP-090784 | 0182 | 2 | SIP Digest AVP Flag Settings | 8.8.0 | +| Dec 2009 | CT#46 | CP-090781 | 0185 | 1 | Unregistered user clarification | 8.8.0 | +| Dec 2009 | CT#46 | CP-090778 | 0188 | 2 | Session-Priority AVP | 8.8.0 | +| Dec 2009 | CT#46 | CP-091030 | 0189 | | Validity of Feature Bit Value in Feature-List AVP | 8.8.0 | +| Dec 2009 | CT#46 | | | | Upgraded unchanged from Rel-8 | 9.0.0 | +| Mar 2010 | CT#47 | CP-100239 | 0195 | 1 | Wildcarded Public Identity | 9.1.0 | +| Mar 2010 | CT#47 | CP-100031 | 0199 | | Wildcarded Public Identities handling | 9.1.0 | +| Jun 2010 | CT#48 | CP-100412 | 0205 | 1 | Digest AVPs wrongly defined | 9.2.0 | +| Sep 2010 | CT#49 | CP-100447 | 0207 | 2 | Wildcarded Identities handling | 9.3.0 | +| Sep 2010 | CT#49 | CP-100442 | 0209 | 2 | Mandatory and optional capabilities handling | 9.3.0 | +| Sep 2010 | CT#49 | CP-100442 | 0212 | | Reference to SCTP IETF RFC obsolete | 9.3.0 | +| Sep 2010 | CT#49 | CP-100463 | 0213 | 2 | Restoration Data Backup | 9.3.0 | +| Sep 2010 | CT#49 | CP-100447 | 0216 | | Encoding of Framed-IPv6-Prefix AVP | 9.3.0 | +| 2011-03 | - | - | - | - | Update to Rel-10 version (MCC) | 10.0.0 | +| Jun 2011 | CT#52 | CP-110349 | 0224 | 2 | Handling of RTR for Emergency Registration | 10.1.0 | +| Jun 2011 | CT#52 | CP-110349 | 0227 | | Error in assignment type for backward compatibility scenarios | 10.1.0 | +| Jun 2011 | CT#52 | CP-110349 | 0230 | | User-Authorization-Type AVP error in description | 10.1.0 | +| Sep 2011 | CT#53 | CP-110566 | 0233 | 1 | Privileged sender | 10.2.0 | +| Dec 2011 | CT#54 | CP-110781 | 0240 | 1 | Restoration of Wildcarded-IMPU AVP | 10.3.0 | +| Dec 2011 | CT#54 | CP-110812 | 0235 | 2 | Server Assignment Type AVP definition | 11.0.0 | +| Sep 2012 | CT#57 | CP-120440 | 0247 | 1 | Emergency registrations do not affect registration status | 11.1.0 | +| Dec 2012 | CT#58 | CP-120743 | 0251 | 2 | PSI direct routing with restoration procedures | 11.2.0 | +| Mar 2013 | CT#59 | CP-130011 | 0258 | 1 | Originating-request AVP in LIR | 11.3.0 | +| Jun 2013 | CT#60 | CP-130374 | 0260 | 1 | Supported-Feature AVP carries list of features specific to the Application-ID | 11.4.0 | +| Jun 2013 | CT#60 | CP-130380 | 0259 | - | Visited Network ID coding | 12.0.0 | +| Dec 2013 | CT#62 | CP-130627 | 0263 | 1 | Session-Priority AVP | 12.1.0 | +| Jun 2014 | CT#64 | CP-140243 | 0264 | 2 | Diameter Overload Control Over Cx | 12.2.0 | +| Sep 2014 | CT#65 | CP-140515 | 0265 | 1 | T-GRUU restoration | 12.3.0 | +| Sep 2014 | CT#65 | CP-140506 | 0266 | 2 | P-CSCF Restoration indication | 12.3.0 | +| Dec 2014 | CT#66 | CP-140794 | 0268 | 2 | P-CSCF Restoration mechanism new feature | 12.4.0 | +| Dec 2014 | CT#66 | CP-140794 | 0270 | 1 | P-CSCF Restoration mechanism new error | 12.4.0 | +| Dec 2014 | CT#66 | CP-140773 | 0269 | - | M-bit clarification | 12.4.0 | +| Mar 2015 | CT#67 | CP-150023 | 0273 | 1 | SIP-Authentication-Scheme AVP encoding | 12.5.0 | +| Jun 2015 | CT#68 | CP-150261 | 0274 | - | SAR-Flags inclusion in SAR command | 12.6.0 | +| Sep 2015 | CT#69 | CP-150428 | 0276 | 1 | SIP-Auth-Data-Item sub AVPs clarifications | 12.7.0 | +| Sep 2015 | CT#69 | CP-150436 | 0275 | 1 | Server-Assignment-Type AVP update to consider P-CSCF Restoration | 12.7.0 | +| Dec 2015 | CT#70 | CP-150754 | 0279 | 2 | Allowed WAF and/or WWSF Identities | 12.8.0 | +| Dec 2015 | CT#70 | CP-150759 | 0281 | 1 | Update reference to DOIC new IETF RFC | 12.8.0 | +| Dec 2015 | CT#70 | CP-150768 | 0282 | 2 | Support of the DRMP AVP over Cx/Dx | 13.0.0 | +| 2016-12 | CT#74 | CP-160664 | 0284 | 1 | Correction to change IETF drmp draft version to official RFC 7944 | 13.1.0 | +| 2016-12 | CT#74 | CP-160681 | 0283 | 1 | Load Control | 14.0.0 | +| 2017-03 | CT#75 | CP-170048 | 0285 | 1 | Update of reference for the Diameter base protocol | 14.1.0 | +| 2017-03 | CT#75 | CP-170048 | 0286 | - | Cardinality of the Failed-AVP AVP in answer | 14.1.0 | +| 2017-06 | CT#76 | CP-171018 | 0288 | 1 | Support for signaling transport level packet marking | 14.2.0 | +| 2018-06 | CT#80 | - | - | - | Update to Rel-15 version (MCC) | 15.0.0 | +| 2019-03 | CT#83 | CP-190035 | 0289 | 1 | Reference Location Information change | 15.1.0 | +| 2019-09 | CT#85 | CP-192094 | 0293 | 2 | draft-ietf-dime-load published as RFC 8583 | 15.2.0 | +| 2019-09 | CT#85 | CP-192125 | 0291 | - | Add P-CSCF subscription info to Restoration information | 16.0.0 | +| 2019-12 | CT#86 | CP-193040 | 0294 | - | S-CSCF restoration after registration timer expiry | 16.1.0 | +| 2020-06 | CT#88 | CP-201053 | 0295 | - | Support of PCRF-based P-CSCF restoration | 16.2.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29232/0e252770f8f0573617e0112b36a93d2f_img.jpg b/marked/Rel-16/29_series/29232/0e252770f8f0573617e0112b36a93d2f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..131f40110a7b3f01a051f2c55a50c00c834a2b28 --- /dev/null +++ b/marked/Rel-16/29_series/29232/0e252770f8f0573617e0112b36a93d2f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:975caeaaf2eae5946d9979a6d58a550196c23432891674ffbd9caa9c20abc82d +size 14507 diff --git a/marked/Rel-16/29_series/29232/107cbeda15ddd53da92c2f677b441c93_img.jpg b/marked/Rel-16/29_series/29232/107cbeda15ddd53da92c2f677b441c93_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0b8b093d89a259e1d64a8f3b3fa73d1be766fb04 --- /dev/null +++ b/marked/Rel-16/29_series/29232/107cbeda15ddd53da92c2f677b441c93_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:dbd1727d66d1fc9a83f00de2bcd6fe414dd0e125b7aa45d788eb49db4d098100 +size 16229 diff --git a/marked/Rel-16/29_series/29232/4ee2de50739c96fd7bd5a38150ec9c78_img.jpg b/marked/Rel-16/29_series/29232/4ee2de50739c96fd7bd5a38150ec9c78_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c59143f62fd46fd326a19ce83033d37d94f6cae4 --- /dev/null +++ b/marked/Rel-16/29_series/29232/4ee2de50739c96fd7bd5a38150ec9c78_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:25c8aa00ed324c38c2a836b6f54e2453812ae433bc1b1f80b08198dc774bf63b +size 21255 diff --git a/marked/Rel-16/29_series/29232/50d533fa0795f3e7780db917b3f5e496_img.jpg b/marked/Rel-16/29_series/29232/50d533fa0795f3e7780db917b3f5e496_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2aec342e18d254b97fb67b09a996b6061c932127 --- /dev/null +++ b/marked/Rel-16/29_series/29232/50d533fa0795f3e7780db917b3f5e496_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:106b50d22445a1f47a8648e93cadeeb0884f37fa106c765833dc941270406a0f +size 20730 diff --git a/marked/Rel-16/29_series/29232/665db9e4c084c517dc46f23397c8533a_img.jpg b/marked/Rel-16/29_series/29232/665db9e4c084c517dc46f23397c8533a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ec988dc411d428bf01943a049f105f85904b4354 --- /dev/null +++ b/marked/Rel-16/29_series/29232/665db9e4c084c517dc46f23397c8533a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:62dd14f2b865b688b2114b925b5f4c95103dd6ddffaf210465682f8fbc9f072b +size 54698 diff --git a/marked/Rel-16/29_series/29232/bbddeb46a8bee133d49003273fcfc8dd_img.jpg b/marked/Rel-16/29_series/29232/bbddeb46a8bee133d49003273fcfc8dd_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d0c7a76f210cf7c0646326fce25924ff6c9a56d1 --- /dev/null +++ b/marked/Rel-16/29_series/29232/bbddeb46a8bee133d49003273fcfc8dd_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d94a17fcdf4c5f6dd20117b6eadb5b98a00224fc49916007b44b3185fa557ea0 +size 60334 diff --git a/marked/Rel-16/29_series/29232/c7e27041e661260fd0c8e89c763bb32e_img.jpg b/marked/Rel-16/29_series/29232/c7e27041e661260fd0c8e89c763bb32e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3fad63a37928eed6c748bff29efbe1328953b7a7 --- /dev/null +++ b/marked/Rel-16/29_series/29232/c7e27041e661260fd0c8e89c763bb32e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f7f77924c03e2fd6f39d9046463bb0f410071b9ae0b37cab9a61dec330bb92b6 +size 20726 diff --git a/marked/Rel-16/29_series/29232/d2417b04116c354deccb25d98a84a0fb_img.jpg b/marked/Rel-16/29_series/29232/d2417b04116c354deccb25d98a84a0fb_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4cb83778e60f47241c7112d0d29271c291be4203 --- /dev/null +++ b/marked/Rel-16/29_series/29232/d2417b04116c354deccb25d98a84a0fb_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7c09e1438daa6976bcb8052a97ea809d32b879cbcb4bbab7a5d2ffc83d94c78a +size 16820 diff --git a/marked/Rel-16/29_series/29232/raw.md b/marked/Rel-16/29_series/29232/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..fdaf633c2aceb76e94deeff511e8b55f22b173dd --- /dev/null +++ b/marked/Rel-16/29_series/29232/raw.md @@ -0,0 +1,5697 @@ + + + + +**Error:** + +**2** + +**Error: Reference source not** + +# Contents + +| | | +|---------------------------------------------------------------------------|----| +| Foreword..... | 9 | +| 1 Scope..... | 10 | +| 2 References..... | 10 | +| 3 Definitions, symbols and abbreviations..... | 13 | +| 3.1 Definitions..... | 13 | +| 3.2 Symbols..... | 14 | +| 3.3 Abbreviations..... | 14 | +| 4 UMTS capability set..... | 14 | +| 4.1 Profile Identification..... | 14 | +| 4.2 Profile Registration..... | 14 | +| 5 Naming conventions..... | 15 | +| 5.1 MGC/MGW naming conventions..... | 15 | +| 5.2 Termination names..... | 15 | +| 6 Topology descriptor..... | 15 | +| 7 Transaction timers..... | 15 | +| 8 Transport..... | 15 | +| 9 Multiple Virtual MG..... | 15 | +| 10 Formats and codes..... | 16 | +| 10.1 Signalling Objects..... | 16 | +| 10.2 SDP Media Parameters for RTP Terminations..... | 21 | +| 10.2.1 Speech Codecs..... | 21 | +| 10.2.2 DTMF..... | 21 | +| 10.2.3 Auxiliary Payloads..... | 21 | +| 10.2.3.1 Void..... | 21 | +| 10.2.3.2 Void..... | 21 | +| 10.2.3.3 Clearmode Codec..... | 21 | +| 10.2.3.4 Silence suppression and Comfort Noise..... | 21 | +| 10.2.3.5 CS Data Service..... | 21 | +| 10.2.3.5.1 CS Data Service with no Redundancy..... | 21 | +| 10.2.3.5.2 CS Data Service with Redundancy..... | 22 | +| 10.2.4 Other Payload Types..... | 22 | +| 11 Mandatory Support of SDP and H.248.1 annex C information elements..... | 23 | +| 12 General on Packages and Transactions..... | 24 | +| 13 BICC packages..... | 24 | +| 13.1 Mandatory BICC packages..... | 24 | +| 13.2 Optional BICC packages..... | 24 | +| 14 H.248 standard packages..... | 25 | +| 14.1 Call independent H.248 transactions..... | 25 | +| 14.1.1 MGW Out of service/Maintenance Locking..... | 26 | +| 14.1.2 MGW Communication Up..... | 26 | +| 14.1.3 MGW Restoration..... | 26 | +| 14.1.4 MGW Register..... | 27 | +| 14.1.5 MGW Re-register..... | 27 | +| 14.1.6 (G)MSC Server Ordered Re-register..... | 27 | +| 14.1.7 (G)MSC Server Restoration..... | 27 | +| 14.1.8 Termination Out-of-Service..... | 28 | +| 14.1.9 Termination Restoration..... | 28 | +| 14.1.10 Audit Value..... | 29 | +| 14.1.11 Audit Capability..... | 31 | +| 14.1.12 MGW Capability Change..... | 31 | + +| | | | +|----------|----------------------------------------------------|----| +| 14.1.13 | (G)MSC Server Out of Service..... | 32 | +| 14.1.14 | MGW Resource Congestion Handling - Activate..... | 32 | +| 14.1.15 | MGW Resource Congestion Handling - Indication..... | 32 | +| 14.1.16 | Continuity Check Tone..... | 33 | +| 14.1.17 | Continuity Check Verify..... | 33 | +| 14.1.18 | Continuity Check Response..... | 33 | +| 14.1.19 | Inactivity Timeout - Activate..... | 33 | +| 14.1.20 | Inactivity Timeout – Indication..... | 34 | +| 14.1.21 | Realm Availability Change – Activation..... | 34 | +| 14.1.22 | Realm Availability Change – Indication..... | 35 | +| 14.2 | Call related H.248 transactions..... | 35 | +| 14.2.1 | Change Flow Direction..... | 37 | +| 14.2.2 | Isolate Bearer Termination..... | 37 | +| 14.2.3 | Join Bearer Termination..... | 37 | +| 14.2.4 | Establish Bearer..... | 37 | +| 14.2.5 | Prepare Bearer..... | 38 | +| 14.2.6 | Change Through Connection..... | 40 | +| 14.2.7 | Activate Interworking Function..... | 40 | +| 14.2.8 | Release procedures..... | 40 | +| 14.2.8.1 | Release Bearer..... | 40 | +| 14.2.8.2 | Release Termination..... | 40 | +| 14.2.9 | Bearer Released..... | 41 | +| 14.2.10 | Bearer Established..... | 41 | +| 14.2.11 | Send Tone..... | 41 | +| 14.2.12 | Play Announcement..... | 41 | +| 14.2.13 | Send DTMF..... | 42 | +| 14.2.14 | Detect DTMF..... | 42 | +| 14.2.15 | Report DTMF..... | 42 | +| 14.2.16 | Announcement Completed..... | 42 | +| 14.2.17 | Activate Voice Processing Function..... | 42 | +| 14.2.18 | Reserve Circuit..... | 43 | +| 14.2.19 | Tunnel Information Up..... | 44 | +| 14.2.20 | Tunnel Information Down..... | 44 | +| 14.2.21 | Tone Completed..... | 44 | +| 14.2.22 | Stop Announcement..... | 44 | +| 14.2.23 | Stop Tone..... | 44 | +| 14.2.24 | Stop DTMF Detection..... | 44 | +| 14.2.25 | Stop DTMF..... | 44 | +| 14.2.26 | Confirm Char..... | 44 | +| 14.2.27 | Modify Char..... | 45 | +| 14.2.28 | Reserve Char..... | 45 | +| 14.2.29 | Bearer Modified..... | 45 | +| 14.2.30 | Bearer Modification Failed..... | 45 | +| 14.2.31 | TFO Activation..... | 45 | +| 14.2.32 | Optimal Codec and Distant List_Notify..... | 45 | +| 14.2.33 | Codec Modify..... | 46 | +| 14.2.34 | Distant Codec List..... | 46 | +| 14.2.35 | Command Rejected..... | 47 | +| 14.2.36 | Modify Bearer Characteristics..... | 47 | +| 14.2.37 | Protocol Negotiation Result..... | 48 | +| 14.2.38 | Rate Change..... | 48 | +| 14.2.39 | Bearer Modification Support..... | 48 | +| 14.2.40 | CTM report..... | 49 | +| 14.2.41 | Prepare IP transport..... | 49 | +| 14.2.42 | Modify IP transport address..... | 51 | +| 14.2.43 | Reserve Bearer Characteristics..... | 51 | +| 14.2.44 | Confirm Bearer Characteristics..... | 52 | +| 14.2.45 | Trace activation/deactivation..... | 52 | +| 14.2.46 | Trace Activation result notification..... | 53 | +| 14.2.47 | Emergency Call Indication..... | 53 | +| 14.2.48 | TFO status Notify..... | 55 | + +| | | | +|----------|-------------------------------------------------------------|----| +| 14.2.49 | TFO Status..... | 55 | +| 14.2.50 | Termination heartbeat indication..... | 55 | +| 14.2.51 | Reserve RTP Connection Point..... | 56 | +| 14.2.52 | Configure RTP Connection Point..... | 59 | +| 14.2.53 | Reserve and Configure RTP Connection Point..... | 61 | +| 14.2.54 | ECN Failure Indication..... | 64 | +| 14.2.55 | Media Inactivity Notification..... | 64 | +| 15 | UMTS packages..... | 66 | +| 15.1 | Mandatory UMTS packages..... | 66 | +| 15.1.1 | 3GUP package..... | 66 | +| 15.1.1.1 | Properties..... | 66 | +| 15.1.1.2 | Events..... | 68 | +| 15.1.1.3 | Signals..... | 68 | +| 15.1.1.4 | Statistics..... | 68 | +| 15.1.1.5 | Procedures..... | 68 | +| 15.2 | Optional UMTS packages..... | 70 | +| 15.2.1 | Circuit Switched Data package..... | 71 | +| 15.2.1.1 | Properties..... | 71 | +| 15.2.1.2 | Events..... | 71 | +| 15.2.1.3 | Signals..... | 72 | +| 15.2.1.4 | Statistics..... | 73 | +| 15.2.1.5 | Procedures..... | 73 | +| 15.2.2 | TFO package..... | 74 | +| 15.2.2.1 | Properties..... | 74 | +| 15.2.2.2 | Events..... | 75 | +| 15.2.2.3 | Signals..... | 76 | +| 15.2.2.4 | Statistics..... | 76 | +| 15.2.2.5 | Procedures..... | 76 | +| 15.2.3 | 3G Expanded Call Progress Tones Generator Package..... | 76 | +| 15.2.3.1 | Properties..... | 77 | +| 15.2.3.2 | Events..... | 77 | +| 15.2.3.3 | Signals..... | 77 | +| 15.2.3.4 | Statistics..... | 77 | +| 15.2.3.5 | Procedures..... | 77 | +| 15.2.4 | Modification Of Link Characteristics Bearer Capability..... | 77 | +| 15.2.4.1 | Properties..... | 78 | +| 15.2.4.2 | Events..... | 78 | +| 15.2.4.3 | Signals..... | 78 | +| 15.2.4.4 | Statistics..... | 78 | +| 15.2.4.5 | Procedures..... | 78 | +| 15.2.5 | Enhanced Circuit Switched Data package..... | 78 | +| 15.2.5.1 | Properties..... | 78 | +| 15.2.5.2 | Events..... | 79 | +| 15.2.5.3 | Signals..... | 79 | +| 15.2.5.4 | Statistics..... | 79 | +| 15.2.5.5 | Procedures..... | 79 | +| 15.2.6 | Cellular Text telephone Modem Text Transport..... | 79 | +| 15.2.6.1 | Properties..... | 79 | +| 15.2.6.2 | Events..... | 80 | +| 15.2.6.3 | Signals..... | 81 | +| 15.2.6.4 | Statistics..... | 81 | +| 15.2.6.5 | Procedures..... | 81 | +| 15.2.7 | IP transport package..... | 81 | +| 15.2.8 | Flexible Tone Generator Package..... | 81 | +| 15.2.8.1 | Properties..... | 81 | +| 15.2.8.2 | Events..... | 81 | +| 15.2.8.3 | Signals..... | 82 | +| 15.2.8.4 | Statistics..... | 83 | +| 15.2.8.5 | Procedures..... | 83 | +| 15.2.9 | Trace Package..... | 83 | +| 15.2.9.1 | Properties..... | 83 | + +| | | | +|-------------------------------|----------------------------------------------------------------------------------------|-----------| +| 15.2.9.2 | Events..... | 85 | +| 15.2.9.3 | Signals..... | 86 | +| 15.2.9.4 | Statistics..... | 86 | +| 15.2.9.5 | Procedures..... | 86 | +| 15.2.10 | ASCI Group call package..... | 86 | +| 15.2.10.1 | Properties..... | 86 | +| 15.2.10.2 | Events..... | 87 | +| 15.2.10.3 | Signals..... | 87 | +| 15.2.10.4 | Statistics..... | 87 | +| 15.2.10.5 | Procedures..... | 87 | +| 15.2.11 | 3G Interface Type package..... | 87 | +| 15.2.11.1 | Properties..... | 87 | +| 15.2.11.2 | Events..... | 88 | +| 15.2.11.3 | Signals..... | 88 | +| 15.2.11.4 | Statistics..... | 88 | +| 15.2.11.5 | Procedures..... | 88 | +| Annex A (informative): | Framing protocol Interworking Function (FPIF)..... | 89 | +| A.1 | Introduction..... | 89 | +| A.2 | FPIF procedures with respect to Iu framing protocol..... | 90 | +| A.2.1 | Payload..... | 90 | +| A.2.2 | RFCIs..... | 90 | +| A.2.3 | FQC..... | 90 | +| A.2.4 | Frame number..... | 90 | +| A.3 | Relay of status information..... | 91 | +| A.3.1 | Void..... | 91 | +| A.3.2 | Rate Control Frames..... | 91 | +| A.3.2 | Time Alignment..... | 91 | +| Annex B (informative): | Examples for Usage of the 3GUP Package "Initialization Direction" Property..... | 92 | +| Annex C (Normative): | Profile description..... | 94 | +| C.1 | Profile Identification..... | 94 | +| C.2 | Summary..... | 94 | +| C.3 | Gateway Control Protocol Version..... | 94 | +| C.4 | Connection Model..... | 94 | +| C.5 | Context Attributes..... | 95 | +| C.6 | Terminations..... | 95 | +| C.6.1 | Termination Names..... | 95 | +| C.6.1.1 | General..... | 95 | +| C.6.1.2 | ASN.1 Coding..... | 96 | +| C.6.1.2.1 | General Structure..... | 96 | +| C.6.1.2.2 | Termination naming convention for TDM terminations..... | 96 | +| C.6.1.3 | ABNF Coding..... | 96 | +| C.6.1.3.1 | General Structure..... | 96 | +| C.6.1.3.2 | Termination naming convention for TDM terminations..... | 97 | +| C.6.1.3.3 | Termination naming convention for Ephemeral terminations..... | 97 | +| C.6.2 | Multiplexed terminations..... | 97 | +| C.7 | Descriptors..... | 97 | +| C.7.1 | Stream Descriptor..... | 97 | +| C.7.1.1 | LocalControl Descriptor..... | 97 | +| C.7.2 | Events Descriptor..... | 98 | +| C.7.3 | EventBuffer Descriptor..... | 99 | +| C.7.4 | Signals Descriptor..... | 100 | +| C.7.5 | DigitMap Descriptor..... | 101 | +| C.7.6 | Statistics Descriptor..... | 101 | +| C.7.7 | ObservedEvents Descriptor..... | 101 | +| C.7.8 | Topology Descriptor..... | 101 | +| C.7.9 | Error Descriptor..... | 102 | + +| | | | +|---------|--------------------------------------------------------------------------|-----| +| C.7.10 | TerminationState Descriptor..... | 102 | +| C.8 | Command API..... | 103 | +| C.8.1 | Add..... | 103 | +| C.8.2 | Modify..... | 103 | +| C.8.3 | Subtract..... | 103 | +| C.8.4 | Move..... | 104 | +| C.8.5 | AuditValue..... | 104 | +| C.8.6 | AuditCapability..... | 104 | +| C.8.7 | Notify..... | 105 | +| C.8.8 | ServiceChange..... | 105 | +| C.8.9 | Manipulating and auditing context attributes..... | 107 | +| C.9 | Generic command syntax and encoding..... | 107 | +| C.10 | Transactions..... | 107 | +| C.11 | Messages..... | 108 | +| C.12 | Transport..... | 108 | +| C.13 | Security..... | 109 | +| C.14 | Packages..... | 110 | +| C.14.1 | Generic Package..... | 113 | +| C.14.2 | Base Root Package..... | 114 | +| C.14.3 | Tone Generator Package..... | 115 | +| C.14.4 | Tone Detection Package..... | 116 | +| C.14.5 | Basic DTMF Generator Package..... | 117 | +| C.14.6 | Basic DTMF Detection Package..... | 118 | +| C.14.7 | Continuity Package..... | 119 | +| C.14.8 | TDM Circuit Package..... | 120 | +| C.14.9 | Text Telephony Package..... | 121 | +| C.14.10 | Call Discrimination Package..... | 122 | +| C.14.11 | Announcement Package..... | 124 | +| C.14.12 | Media Gateway Resource Congestion handling Package..... | 125 | +| C.14.13 | Hanging Termination Detection Package..... | 125 | +| C.14.14 | Bearer Characteristics Package..... | 126 | +| C.14.15 | Generic Bearer Connection Package..... | 127 | +| C.14.16 | Bearer Control Tunnelling Package..... | 128 | +| C.14.17 | Basic Call Progress Tones Generator with Directionality..... | 129 | +| C.14.18 | Expanded Call Progress Tones Generator Package..... | 130 | +| C.14.19 | Basic Services Tones Generation Package..... | 131 | +| C.14.20 | Expanded Services Tones Generation Package..... | 132 | +| C.14.21 | Intrusion Tones Generation Package..... | 133 | +| C.14.22 | Business Tones Generation Package..... | 134 | +| C.14.23 | 3GUP Package..... | 135 | +| C.14.24 | Modification of Link Characteristics Bearer Capability..... | 136 | +| C.14.25 | TFO package..... | 137 | +| C.14.26 | Circuit Switched Data package..... | 138 | +| C.14.27 | Enhanced Circuit Switched Data package..... | 139 | +| C.14.28 | 3G Expanded Call Progress Tones package..... | 139 | +| C.14.29 | Cellular Text Telephone Modem Text Transport Package..... | 140 | +| C.14.30 | Void..... | 141 | +| C.14.31 | Flexible Tone Generator package..... | 142 | +| C.14.32 | Trace Package..... | 143 | +| C.14.33 | ASCI Group call..... | 144 | +| C.14.34 | IP domain connection..... | 145 | +| C.14.35 | Inactivity Timer Package..... | 146 | +| C.14.36 | 3G Interface Type package..... | 147 | +| C.14.37 | Differentiated Services (ds)..... | 148 | +| C.14.38 | Gate Management (gm)..... | 149 | +| C.14.39 | Traffic management (tman)..... | 150 | +| C.14.40 | IP Realm Availability (ipra)..... | 151 | +| C.14.41 | RTCP Handling Package (rtcph)..... | 151 | +| C.14.42 | Application Data Inactivity Detection (adid)..... | 152 | +| C.14.43 | Explicit Congestion Notification for RTP-over-UDP Support (ecnrous)..... | 153 | +| C.14.44 | MG Act-as STUN Server (mgastuns)..... | 154 | + +C.14.45     Originate STUN Continuity Check (ostuncc)..... 155 +C.14.46     Enhanced Revised Offer/Answer SDP Support (eroas)..... 156 +C.15        Mandatory support of SDP and Annex C information elements..... 157 +C.16        Optional support of SDP and Annex C information elements..... 158 +Annex D (informative):     Change history..... 159 + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# 1 Scope + +The present document describes the protocol to be used on the Media Gateway Controller (MGC) – Media Gateway (MGW) interface. The Media Gateway Controllers covered in this specification are the MSC server and the GMSC server. The basis for this interface profile is the H.248.1 [10] protocol as specified in ITU-T. The usage of this protocol is described in 3GPP TS 23.205 [2] and 3GPP TS 29.205 [7] for BICC circuit switched core network, in 3GPP TS 23.231 [54] and 3GPP TS 29.231 [57] for SIP-I circuit switched core network. + +This profile includes the support for the enhanced MSC server to provide access to IMS Centralised services as described in 3GPP TS 23.292 [59] and thus the procedures related to this interface are described in 3GPP TS 29.292 [60]. As a result the interworking with SIP and the associated MGW control procedures described in 3GPP TS 29.163[61] for the interworking between BICC/ISUP circuit switched core network and IP Multimedia core network are incorporated. + +This specification describes the changes to H.248 which are needed to handle 3GPP specific traffic cases. This is done by using the H.248 standard extension mechanism. In addition certain aspects of the base protocol H.248 are not needed for this interface and thus excluded by this profile. + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. +- [1] 3GPP TS 23.153: "Out of band transcoder control; Stage 2". +- [2] 3GPP TS 23.205: "Bearer independent circuit-switched core network; Stage 2". +- [3] 3GPP TS 24.008: "Mobile radio interface Layer 3 specification; Core network protocols; Stage 3". +- [4] 3GPP TS 25.415: "UTRAN Iu interface user plane protocols". +- [5] 3GPP TS 28.062: "Inband Tandem Free Operation (TFO) of speech codecs; Service description; Stage 3". +- [6] 3GPP TS 29.007: "General requirements on interworking between the Public Land Mobile Network (PLMN) and the Integrated Services Digital Network (ISDN) or Public Switched Telephone Network (PSTN)". +- [7] 3GPP TS 29.205: "Application of Q.1900 series to Bearer Independent circuit-switched network architecture; Stage 3". +- [8] 3GPP TS 29.415: "Core Network Nb interface user plane protocols". +- [9] 3GPP TS 48.008: "Mobile Switching Centre - Base Station System (MSC - BSS) interface; Layer 3 specification". +- [10] ITU-T Recommendation H.248.1 (05/2002): "Gateway control protocol: Version 2" including the Corrigendum1 for Version 2 (03/04). +- [11] ITU-T Recommendation Q.2210 (1996): "Message transfer part level 3 functions and messages using the services of ITU-T Recommendation Q.2140". +- [12] IETF RFC 2960: "Stream control transmission protocol". + +- [13] 3GPP TS 29.202: "Signalling System No. 7 (SS7) signalling transport in core network; Stage 3". +- [14] ITU-T Recommendation H.248.8 (09/2005): "Error codes and service change reason description". +- [15] ITU-T Recommendation H.248.10 (07/2001): "Media gateway resource congestion handling package". +- [16] 3GPP TS 26.103: "Speech codec list for GSM and UMTS". +- [17] ITU-T Recommendation H.248.2 (01/2005): "Facsimile, text conversation and call discrimination packages". +- [18] 3GPP TS 26.226: "Cellular text telephony; Transport of text in the voice channel". +- [19] ITU-T Recommendation T.140 (02/1998): "Protocol for multimedia application text conversation". +- [20] 3GPP TS 25.413: "UTRAN Iu interface RANAP signalling". +- [21] 3GPP TS 25.414: "UTRAN Iu interface data transport and transport signalling". +- [22] 3GPP TS 23.078: "Customized Applications for Mobile network Enhanced Logic (CAMEL); Stage 2". +- [23] ITU-T Recommendation Q.1950 (12/2002): "Bearer independent call bearer control protocol". +- [24] ITU-T Recommendation Q.765.5 (04/2004): "Signalling system No. 7 - Application transport mechanism: Bearer Independent Call Control (BICC)". +- [25] ITU-T Recommendation G.711 (11/1988): "Pulse code modulation (PCM) of voice frequencies". +- [26] 3GPP TS 26.102: "Mandatory speech codec; AMR speech codec; Interface to Iu, Uu and Nb". +- [27] 3GPP TS 23.014: "Support of Dual Tone Multi-Frequency (DTMF) signalling". +- [28] ITU-T Recommendation H.248.7 (03/2004): "Generic Announcement Package". +- [29] 3GPP TS 32.421: "Subscriber and equipment trace: Trace concepts and requirements ". +- [30] 3GPP TS 32.422: "Subscriber and equipment trace: Trace control and configuration management". +- [31] 3GPP TS 32.423: "Subscriber and equipment trace: Trace data definition and management". +- [32] 3GPP TS 29.414: "Core Network Nb data transport and transport signalling". +- [33] ITU-T Recommendation X.213 (11/95): "Information technology - Open systems interconnection - Network Service Definitions". +- [34] Void +- [35] 3GPP TS 43.045: "Technical Realization Of Facsimile Group 3 service - Transparent". +- [36] ITU-T Recommendation H.248.36 (09/2005): "Hanging Termination Detection Package". +- [37] 3GPP TS 23.172 : "Technical realization of Circuit Switched (CS);multimedia service UDI/RDI fallback and service modification;Stage 2". +- [38] 3GPP TS 33.210 : "3G Security; Network Domain Security; IP Network Layer Security". +- [39] 3GPP TS 43.068: " Voice Group Call Service (VGCS); Stage 2". +- [40] 3GPP TS 43.069: " Voice Broadcast Service (VBS); Stage 2". +- [41] ITU-T Recommendation X.690: "ASN.1 encoding rules: Specification of Basic Encoding Rules (BER), Canonical Encoding Rules (CER) and Distinguished Encoding Rules (DER)". +- [42] ITU-T Recommendation H.248.41 (05/2006): " IP Domain Connection package". + +- [43] 3GPP TS 23.003: "Numbering, addressing and identification". +- [44] IETF RFC 3309: "Stream Control Transmission Protocol (SCTP) Checksum Change" +- [45] ITU-T Recommendation H.248.14 (03/2009):"Inactivity timer package" +- [46] Void +- [47] Void +- [48] Void +- [49] Void +- [50] Void +- [51] 3GPP TS 29.332: "Media Gateway Control Function (MGCF) - IM Media Gateway; Mn Interface". +- [52] IETF RFC 3556: "Session Description Protocol (SDP) Bandwidth Modifiers for RTP Control Protocol (RTCP) Bandwidth". +- [53] IETF RFC 4566: "SDP: Session Description Protocol". +- [54] 3GPP TS 23.231: "SIP-I based circuit switched core network; stage 2". +- [55] IETF RFC 4040: "RTP Payload Format for a 64 kbit/s Transparent Call". +- [56] Void +- [57] 3GPP TS 29.231: "Application of SIP-I Protocols to Circuit Switched (CS) core network architecture; Stage 3". +- [58] 3GPP TS 32.407: "Telecommunication Management; Performance Management (PM) Performance measurements Core Network (CN) Circuit Switched (CS) domain". +- [59] 3GPP TS 23.292: "IP Multimedia Subsystem (IMS) Centralized Services; Stage 2". +- [60] 3GPP TS 29.292: "Interworking between the IP Multimedia (IM) Core Network (CN) subsystem and MSC Server for IMS Centralized Services (ICS)". +- [61] 3GPP TS 29.163: "Interworking between the IM CN subsystem and CS networks – Stage 3". +- [62] Void +- [63] Void +- [64] IETF RFC 2198: "RTP Payload for Redundant Audio Data". +- [65] 3GPP TS 48.103: "Base Station System – Media GateWay (BSS-MGW) interface; User Plane transport mechanism". +- [66] ITU-T Recommendation H.248.57 (06/2008): "Gateway control protocol: RTP Control Protocol Package". +- [67] ITU-T Recommendation H.248.43 (06/2008): "Gateway control protocol: Gate Management and Gate Control packages". +- [69] ITU-T Recommendation H.248.53 (06/2008) inclusive *Revision 1* (03/2009): "Gateway control protocol: Traffic management packages". +- [70] ITU-T Recommendation H.248.52 (06/2008): "Gateway control protocol: QoS support packages". +- [71] ITU-T Recommendation H.248.40 (01/2007): "Gateway control protocol: Application Data Inactivity Detection package". +- [72] ITU-T Recommendation H.248.41 Amendment 1 (06/2008): "Gateway control protocol: IP domain connection package: IP Realm Availability Package". + +- [73] IETF RFC 2216: "Network Element Service Specification Template". +- [74] Void +- [75] Void +- [76] Void +- [77] 3GPP TS 26.114: "IP Multimedia Subsystem (IMS); Multimedia Telephony; Media handling and interaction". +- [78] 3GPP TS 22.153: "Multimedia Priority Service". +- [79] ITU-T Recommendation H.248.82 (03/2013): "Gateway control protocol: Explicit Congestion Notification Support". +- [80] IETF RFC 5245: "Interactive Connectivity Establishment (ICE): A Protocol for Network Address Translator (NAT) Traversal for Offer/Answer Protocols". +- [81] ITU-T Recommendation H.248.50 (09/2010) Corrigendum 1 (02/12): "Gateway control protocol: NAT traversal toolkit packages". +- [82] 3GPP TS 24.229: "IP Multimedia Call Control Protocol based on SIP and SDP". +- [83] 3GPP TS 26.445: "Codec for Enhanced Voice Services (EVS); Detailed Algorithmic Description". +- [84] IETF RFC 5939: "Session Description Protocol (SDP) Capability Negotiation". +- [85] ITU-T Recommendation H.248.80 (01/2014): "Gateway control protocol: Usage of the revised SDP offer/answer model with ITU-T H.248". + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the following terms and definitions apply: + +**context (H.248):** association between a number of Terminations + +The context describes the topology (who hears/sees whom) and the media mixing and/or switching parameters if more than two terminations are involved in the association. + +**package (H.248):** different types of gateways may implement terminations which have differing characteristics + +Variations in terminations are accommodated in the protocol by allowing terminations to have optional properties. Such options are grouped into packages, and a termination may realise a set of such packages. + +**termination (H.248):** logical entity on an MGW which is the source and/or sink of media and/or control streams + +A termination is described by a number of characterising properties, which are grouped in a set of descriptors which are included in commands. Each termination has a unique identity (TerminationID). + +**termination property (H.248):** used to describe terminations + +Related properties are grouped into descriptors. Each termination property has a unique identity (PropertyID). + +For the purposes of the present document, the following terms and definitions as defined in 3GPP TS 29.292 [60] apply: + +**ICE lite** + +**Full ICE.** + +## 3.2 Symbols + +For the purposes of the present document, the following symbols apply: + +| | | +|----|---------------------------------------------------------------------------------------------| +| Iu | Interface between the RNS and the core network. It is also considered as a reference point. | +| Mc | Interface between the server and the media gateway. | + +## 3.3 Abbreviations + +For the purposes of the present document, the following abbreviations apply: + +| | | +|-----------|----------------------------------------------------------------------------------------------------| +| BICC | Bearer Independent Call Control | +| CE | Congestion Experienced | +| ECN | Explicit Congestion Notification | +| EVS | Enhanced Voice Services | +| ICE | Interactive Connectivity Establishment | +| M3UA | SS7 MTP3 – User Adaptation Layer | +| MGC | Media Gateway Controller | +| MPS | Multimedia Priority Service | +| MTP3 | Message Transfer Part layer 3 | +| RFC | Request For Comment; this includes both discussion documents and specifications in the IETF domain | +| SCTP | Stream Control Transmission Protocol | +| SDP | Session Description Protocol | +| SDPCapNeg | SDP Capability Negotiation | +| STUN | Session Traversal Utilities for NAT | +| TFO | Tandem Free Operation | +| TrFO | Transcoder Free Operation | + +# --- 4 UMTS capability set + +The support of the Mc interface capability set shall be identified by the Mc profile and support of this profile shall then be indicated in ServiceChange procedure via the ServiceChangeProfile parameter as defined in H.248.1 [10] and clarified in section 4.2. The mandatory parts of this profile shall be used in their entirety. Failure to do so will result in a non-standard implementation. + +ITU-T Recommendation H.248.1 [10] shall be the basis for this profile. The compatibility rules for packages, signals, events, properties and statistics and the H.248 protocol are defined in ITU-T Recommendation H.248.1 [10] Their use or exclusion for this interface is clarified in clause 12. + +## 4.1 Profile Identification + +For Profile Identification see Annex C.1. + +## 4.2 Profile Registration + +The following description is based on H.248.1 profile registration procedure with some clarifications. The reply to the ServiceChange Request containing the SCP parameter indicates if the MSC Server supports the requested profile or if it does not support it and wants to propose an alternative profile. The profile (name and version) is only returned in the reply if the MGC cannot support the specified profile in the ServiceChangeRequest. The returned reply shall indicate the profile and version supported or "NoProfile" if no profile is supported. Upon reception of a profile in the reply, if the MGW supports the indicated profile, it shall issue a new ServiceChange Request with the agreed profile to explicitly confirm the acceptance of the profile to the MGC ; otherwise, if the MGW does not support the indicated profile, it may continue the registration or re-registration procedure by issuing a new ServiceChange Request with an alternative profile ; until such procedure is successfully completed the MGW shall remain out of service. In the instance that the MGW did not indicate a profile in the original ServiceChangeRequest and the MGC returned a profile in the reply, the MGW shall issue a new ServiceChangeRequest with the appropriate profile or "NoProfile" if no profile is supported. If the profile is not returned the MGC shall use the capabilities specified by the Profile indicated in the service change request. + +NOTE: It should be observed that the profile registration is not a "cold calling" negotiation; the operator shall have configured the network to support certain profiles and so the profile registration within the Mc interface permits network upgrade scenarios but otherwise is simply a means to confirm the connection of the profile to be used over the Mc interface between MGC and MGW. + +# --- 5 Naming conventions + +## 5.1 MGC/MGW naming conventions + +For definition see Annex C.11. + +## 5.2 Termination names + +For definition see Annex C.6.1. + +# --- 6 Topology descriptor + +For definition see Annex C.7.8. + +# --- 7 Transaction timers + +For definition see Annex C.10. + +# --- 8 Transport + +Each implementation of the Mc interface should provide the appropriate protocol options: MTP3B as defined in ITU-T Recommendation Q.2210 [11] (for ATM signalling transport) or SCTP as defined in RFC 2960 [12] and as updated by RFC3309 [44] (for IP signalling transport) and in the case where the signalling relation consists of both ATM signalling transport and IP signalling transport the M3UA protocol layer (3GPP TS 29.202 [13]) shall be added to SCTP to provide interworking. M3UA layer may also be added to SCTP for pure IP signalling transport. IPsec shall not be used by MSC Server or MGW for the Mc interface. Normally the Mc interface lies within a single operator's secure domain. If this is not the case then a Za interface (Security Gateway deploying IPSec) may be required, however this is a separate logical function/entity and thus is not attributed to Mc profile, the MSC Server or the MGW; for further details see 3GPP TS 33.210 [38]. For further definition see Annex C.12. + +# --- 9 Multiple Virtual MG. + +If an MGW is connected to more than one (G)MSC, the MGW shall fulfil the requirements outlined in the subclause "Multiple virtual MGW" in ITU-T Recommendation H.248.1 [10]. + +# --- 10 Formats and codes + +## 10.1 Signalling Objects + +Table 10.1 shows the parameters which are required, in addition to those defined in the subclause "Formats and Codes" of ITU-T Recommendation Q.1950 [23] (see 3GPP TS 29.205 [7]). + +The coding rules applied in ITU-T Recommendation H.248.1 [10] for the applicable coding technique shall be followed for the UMTS capability set. + +Unsupported values of parameters or properties may be reported by the MGW and shall be supported by the MSC as such by using H.248.1 error code #449 " Unsupported or Unknown Parameter or Property Value ". **Error Text in the error Descriptor:** The unsupported or unknown value is included in the error text in the error descriptor. + +**Table 10.1: Additional parameters required** + +| Signalling Object | H.248 Descriptor | Coding | +|---------------------------------------|---------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| actprot | Signal descriptor | As for the signal "Activate protocol" in subclause 15. 2.1.3 | +| Allowed RTCP APP message types | Remote Descriptor | The "a=3gpp_mtsi_app_adapt" SDP attribute defined in 3GPP TS 26.114 [77]. | +| Bearer modification possible | ObservedEvent descriptor | As for the ObservedEventDescriptor in "Bearer Modification Support" in subclause 15. 2.3.2. | +| Bearer Modification Support | EventDescriptor | As for the EventsDescriptor in "Bearer Modification Support" in subclause 15. 2.3.2. | +| Bitrate | Local control | As for the property "Bitrate" in subclause 15.1.7.1 | +| Cause | ObservedEvent descriptor | As for the ObservedEventsDescriptor parameter "Protocol Negotiation Result" in subclause 15. 2.1.2 | +| Changed Realms | Observed Events | According to Observed Events Parameters for Available Realms Changed event in ITU-T Recommendation H.248.41 [72]. | +| Codec List | Local Descriptor or Remote Descriptor | in a single SDP m-line.
For a static RTP payload type, the codec type should be implied by the RTP payload type, if not then each codec type shall be provided in a separate SDP "a=rtpmap"-line and possibly additional SDP "a=fmtp"-line(s). See Clause 10.2.
For a dynamic RTP payload type, for each codec information on the codec type shall be provided in a separate SDP "a=rtpmap"-line and possibly additional SDP "a=fmtp"-line(s). See Clause 10.2 | +| Coding | Local control | As for the property "GSM channel coding" in subclause 15. 2.1.1 | +| Connchng | ObservedEventDescriptor | As for the ObservedEventDescriptor "Connection State Change" in subclause 15.2.6.2 | +| Ctmbits | Statistics descriptor | As for the Statistics descriptor "Characters Transferred" in subclause 15.2.6.4 | +| Ctmstate | TerminationState | As for the TerminationState "Text termination connection state" in subclause 15. 2.6.1. | +| Ctmtext version | Local control | As for the property "Text Protocol Version" in subclause 15.2.6.1. | +| Ctmtransport | Local control | As for the property "Text Transport" in subclause 15.2.6.1. | +| Delay Variation Tolerance | Local Control | This is the tman/dvt property from ITU-T Recommendation H.248.53 [69] | +| Desired listener context terminations | Local control | As for the property "Number of desired listener context terminations" in subclause 15.2.10.1 | +| Diffserv Code Point | Local Control | Defined according to the Differentiated Services Code Point property in ITU-T Recommendation H.248.52 [70]. | +| Diffserv Tagging Behaviour | Local Control | Defined according to the Tagging Behaviour property in ITU-T Recommendation H.248.52 [70]. | +| Distlist | ObservedEvent descriptor | As for the ObservedEventDescriptor parameter "Distant TFO List" in subclause 15. 2.2.2 | +| ECN Enabled | Local Descriptor or Remote Descriptor | Defined according to the "ECN Enabled" property in ITU-T Recommendation H.248.82 [79]. | +| ECN Failure | Events, Observed Events | Defined according to the "ECN Failure" Event in ITU-T Recommendation H.248.82 [79]. | +| ECN Failure Type | ObservedEvents Descriptor | As for the ObservedEventsDescriptor Parameter "Failure Type" in ITU-T Recommendation H.248.82 [79]. | +| ECN Initiation Method | Local Descriptor or Remote Descriptor | Defined according to "Initiation Method" property in ITU-T Recommendation H.248.82 [79]. | +| Error | Error descriptor | As defined in the subclause "Command error code" in ITU-T Recommendation H.248.1 [10] | +| Flextone | Signal descriptor | As for the signal "Flexible Tone" in subclause 15.2.8.3 | +| ICE host candidate request | Local Descriptor | The "a=candidate" SDP attribute defined in IETF RFC 5245 [80] of type "host" with the transport, port and priority parameters with wildcard sign "\$" to request the allocation of a host candidate | +| ICE host candidate | Local Descriptor | The "a=candidate" SDP attribute defined in IETF RFC 5245 [80] | +| ICE lite indication | Local Descriptor | The "a=ice-lite" SDP attribute defined in IETF RFC 5245 [80]. | +| ICE password request | Local Descriptor | The "a=ice-pwd" SDP attribute defined in IETF RFC 5245 [80] with wildcard sign "\$". | +| ICE password | Local Descriptor | The "a=ice-pwd" SDP attribute defined in IETF RFC 5245 [80]. | +| ICE received candidate | Remote Descriptor | The "a=candidate" SDP attribute defined in IETF RFC 5245 [80] | +| ICE received password | Remote Descriptor | The "a=ice-pwd" SDP attribute defined in IETF RFC 5245 [80]. | +| ICE received Ufrag | Remote Descriptor | The "a=ice-ufrag" SDP attribute defined in IETF RFC 5245 [80]. | +| ICE Ufrag request | Local Descriptor | The "a=ice-ufrag" SDP attribute defined in IETF RFC 5245 [80] with wildcard sign "\$". | +| ICE Ufrag | Local Descriptor | The "a=ice-ufrag" SDP attribute defined in IETF RFC 5245 [80]. | +| ICE Connectivity Check Result | Events, Observed Events | Defined according to Connectivity Check Result event in ITU-T Recommendation H.248.50 [81]. | + +| | | | +|-----------------------------------------------|-----------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ICE Send Connectivity Check | Signals | Defined as the ostuncc/scc signal in ITU-T Recommendation H.248.50 [81]. | +| ICE New Peer Reflexive Candidate | Events, Observed Events | Defined according to New Peer Reflexive Candidate event in ITU-T Recommendation H.248.50 [81], only applicable for full ICE. | +| ICE Send Additional Connectivity Check | Signals | Defined as the ostuncc/sacc signal in ITU-T Recommendation H.248.50 [81], only applicable for full ICE. | +| IMEI(SV) | Local control | As for the property "IMEI(SV)" in subclause 15.2.9.1 | +| IMSI | Local control | As for the property "IMSI" in subclause 15.2.9.1 | +| inactivity timeout | EventDescriptor | As for the EventsDescriptor in subclause 6.2/H.248.14 "Inactivity Timeout" | +| Inactivity timeout | ObservedEvent descriptor | As for the ObserverdEventDescriptor in subclause 6.2/H.248.14 "Inactivity Timeout " | +| Initdirection | Local control | As for the property "Initialization Direction" in subclause 15.1.1.1 | +| Interface | Local control | As for the property "Interface" in subclause 15.1.1.1 | +| IP Address | Local Descriptor or Remote Descriptor | in SDP "c-line" | +| IP interface | Local Control | As for the property "IP interface type" in subclause 15.2.11.1 | +| IP realm identifier | Local control | As for the property "IP realm identifier" in subclause 5.1.1/H.248.41 | +| IP Version | Local Descriptor or Remote Descriptor |
in SDP "c-line", see C.16 | +| Iu IP Address | Local Descriptor or Remote Descriptor control | As defined in C.16 | +| Iu IP Port | Local Descriptor or Remote Descriptor | As defined in C.16. Port Type is not defined in the Mc profile and shall be assumed always to be UDP. | +| List of interfaces | Local control | As for the property "List of interfaces" in subclause 15.2.9.1 | +| MGW Resource Congestion Handling - Indication | EventDescriptor | As for the EventDescriptor in subclause 4.2.1/H.248.10 "MGCongestion" | +| Maximum Burst Size | Local Control | This is the tman/mbs property from ITU-T Recommendation H.248.53 [69] | +| Media Inactivity Detection | Events, Observed Events | Defined according to IP Flow Stop Detection event in ITU-T Recommendation H.248.40 [71]. | +| Media Inactivity Detection Time | Events | As for the Event Parameter in ITU-T Recommendation H.248.40 [71] "Detection Time" | +| Media Inactivity Detection Direction | Events | As for the Event Parameter in ITU-T Recommendation H.248.40 [71] "Direction" | +| Mode | Local control | As for the property "UP mode of operation" in subclause 15.1.1.1 | +| Needed conference terminations | Local control | As for the property "Number of needed conference terminations" in subclause 15.2.10.1 | +| On/Off | Local control | As for the property "Echo cancelling" in subclause E.13.1 in ITU-T Recommendation H.248.1 [10] . Default value is Off. | +| Optimalcodec | ObservedEvent descriptor | As for the ObservedEventDescriptor parameter "Optimal Codec Type" in subclause 15. 2.2.2 | +| Peak Data Rate | Local Control | This is the tman/pdr property from ITU-T Recommendation H.248.53 [69]. | +| PLMN bearer capability | Local control | As for the property "PLMN BC" in subclause 15. 2.1.1 | +| Policing Required | Local Control | This is the tman/pol property from ITU-T Recommendation H.248.53 [69]. | +| Port | Local Descriptor or Remote Descriptor | in SDP m-line.
in SDP m-line shall be set to value "RTP/AVP" for voice service
Editor's note: the value for other services in FFS. | +| Priority Information | NA | Priority Indicator (subclause 6.1.1 of ITU-T Recommendation H.248.1 [10]).
Binary Encoding: Encoding as per ITU-T Recommendation H.248.1 [10] Annex A "priority" context attribute
Textual Encoding: Encoding as per ITU-T Recommendation H.248.1 [10] Annex B "priority" context attribute | +| Rate | ObservedEvent descriptor | As for the ObservedEventDescriptor parameter "Rate Change" in subclause 15. 2.1.2 | +| Realm Availability Change | Events, Observed Events | According to Available Realms Changed event in ITU-T Recommendation H.248.41 [72]. | +| Reduction | ObservedEvent descriptor | As for the ObserverdEventDescriptor in subclause 4.2.1/H.248.10 "MGCongestion". | +| Remote Source Address Filtering | Local Control | Defined according to Remote Source Address Filtering property in ITU-T Recommendation H.248.43 [67]. | + +| | | | +|----------------------------------------------------------|---------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Remote Source Address Mask | Local Control | Defined according to Remote Source Address Mask property in ITU-T Recommendation H.248.43 [67]. | +| Remote Source Port Filtering | Local Control | Defined according to Remote Source Port Filtering property in ITU-T Recommendation H.248.43 [67]. | +| Remote Source Port | Local Control | Defined according to Remote Source Port property in ITU-T Recommendation H.248.43 [67]. | +| Remote Source Port Range | Local Control | Defined according to Remote Source Port Range property in ITU-T Recommendation H.248.43 [67]. | +| RTCP allocation | Local Control | Defined according to RTCP Allocation Specific Behaviour property in ITU-T Recommendation H.248.57 [66]. | +| Reserve_Value | Local Control | ITU-T Recommendation H.248.1 [10] Mode property.
Binary Encoding: Encoding as per ITU-T Recommendation H.248.1 Annex A "reserveValue"
Textual Encoding: Encoding as per ITU-T Recommendation H.248.1 Annex B "reservedValueMode". | +| Result | ObservedEvent descriptor | As for the ObservedEventDescriptor parameter "Protocol Negotiation Result" in subclause 15. 2.1.2 | +| RtcpbwRR | Local Descriptor or Remote Descriptor | in SDP "b:RR"-line as per IETF RFC 3556 [52]. | +| RtcpbwRS | Local Descriptor or Remote Descriptor | in SDP "b:RS"-line as per IETF RFC 3556 [52]. | +| RTPpayload | Local Descriptor or Remote Descriptor | in SDP m-line | +| SDPCapNeg configuration | Local Descriptor or Remote Descriptor | The SDP attributes for SDP capability negotiation according to IETF RFC 5939 [84]. | +| SDPCapNeg Supported Capabilities | Termination State | Defined according to SDPCapNeg Extensions property in ITU-T Recommendation H.248.80 [85]. | +| STUN server request | LocalControl | Encoding as per ITU-T Recommendation H.248.50 [81] "MG Act-as STUN Server" (mgastuns) package "Act-as STUN Server" (astuns, 0x0001) property. | +| Sustainable Data Rate | Local Control | This is the tman/sdr property from ITU-T Recommendation H.248.53 [69] | +| termination heartbeat | EventDescriptor | As for the EventsDescriptor in subclause 5.2.1/H.248.36 "Termination Heartbeat" | +| Termination heartbeat | ObservedEvent descriptor | As for the ObservedEventDescriptor in subclause 5.2.1/H.248.36 "Termination Heartbeat" | +| tfoactvalue | Local control | As for the property "TFO activity control" in subclause 15. 2.2.1 | +| TFOcodeclist (NOTE) | Local control | As for the property "TFO Codec List" in subclause 15. 2.2.1 | +| TFO Status | EventDescriptor | As for the EventsDescriptor in "TFO_Status Event" in subclause 15.2.2.2 | +| tfostatus | ObservedEvent descriptor | As for the ObservedEventsDescriptor parameter "TFO Status" in subclause 15.2.2.2 | +| Trace activativity request | Local control | As for the property "Trace Activation Control" in subclause 15.2.9.1 | +| Trace Activation Result | ObservedEvents descriptor | As for the ObservedEventDescriptor "Trace Activation result" in subclause 15.2.9.2 | +| Trace Depth | Local control | As for the property "Trace Depth" in subclause 15.2.9.1 | +| Trace Recording Session Reference | Local control | As for the property "Trace Recording Session Reference" in subclause 15.2.1.1 | +| Trace reference | Local control | As for the property "Trace Reference" in subclause 15.2.9.1 | +| Triggering events | Local control | As for the property "Triggering events" in subclause 15.2.9.1 | +| Value | Local control | As for the property "Delivery of erroneous SDUs" in subclause 15.1.1.1 | +| Version | Local control | As for the property "Upversion" in subclause 15.1.1.1 | +| Warning tone | Signal descriptor | As for the signal "CAMEL Prepaid Warning Tone" in subclause 15.2.3.3 | +| NOTE: TFOcodeclist was named Codeclist in pre-release 8. | | | + +## 10.2 SDP Media Parameters for RTP Terminations + +### 10.2.1 Speech Codecs + +The speech codecs and their configuration permitted for use over SIP-I and AoIP are defined in 3GPP TS 26.102 [26], Clauses 9 and 10. The SDP parameters for those codecs are defined in 3GPP TS 26.103 [16], Clause 7 and in 3GPP TS 26.445 [83], Annex A. + +The speech codecs for use for Enhanced MSC at the Mb interface are defined in 3GPP TS 26.114 [77]. + +Codec types may have static or dynamic RTP payload types as defined by the above references. + +For dynamic payload type being used the codecs shall be signalled accordingly in the SDP "a=rtpmap"-line, where the selected options are expressed as MIME parameters in SDP "a=fmtp"-line. + +For static payloads type being used the codecs shall be allowed to be signalled accordingly in the SDP "a=rtpmap"-line, when the selected options are expressed as MIME parameters in SDP "a=fmtp"-line. Otherwise the codec type is implied by the RTP payload type. + +### 10.2.2 DTMF + +DTMF support is defined within 3GPP TS 23.231 [54] and the RTP Payload Type shall be supported as defined in 3GPP TS 26.102 [26]. + +### 10.2.3 Auxiliary Payloads + +#### 10.2.3.1 Void + +#### 10.2.3.2 Void + +#### 10.2.3.3 Clearmode Codec + +On RTP terminations, Clearmode codec is transported according to IETF RFC 4040[55]. + +When the MGC determines that a 64 kbit/s unrestricted bearer service is requested, the clearmode codec shall be used. A dynamic payload type with CLEARMODE as encoding name shall be included in both the local and remote descriptor. + +The behaviour of the MGW shall then conform to IETF RFC 4040[55]. All voice and signal processing functions such as silence suppression, comfort noise insertion and gain adjustment shall be automatically turned off. The MGW shall inherit the same QoS objectives as the ISDN bearer service. + +#### 10.2.3.4 Silence suppression and Comfort Noise + +Support of silence suppression and comfort noise is defined in 3GPP TS 26.102 [26]. + +#### 10.2.3.5 CS Data Service + +##### 10.2.3.5.1 CS Data Service with no Redundancy + +RTP transport for CS Data services on the A-Interface User Plane over IP (AoIP) is based on RFC 4040 (CLEARMODE) [55], when this payload type is used by itself it means no redundancy is offered, which results in a 64kbps net bit stream. + +A specific Payload Type value (120) is defined in TS 48.103 [65] in the range of dynamic Payload Types for CSData without redundancy. + +The SDP-syntax on the Mc interface for CS Data without redundancy is: + +``` +m=audio RTP/AVP 120 +a=rtpmap:120 CLEARMODE/8000 +``` + +##### 10.2.3.5.2 CS Data Service with Redundancy + +A second specific Payload Type value (121) is defined in TS 48.103 [65] in the range of dynamic Payload Types for RTP Payload for Redundant Audio Data over AoIP. Redundancy for the CS Data service on AoIP is realised according to IETF RFC 2198 [64]. The SDP-syntax (red, fmtp) defined in this RFC is used to inform the MGW about the negotiated redundancy level. The encapsulated payload structure for CS Data is based on IETF RFC 4040 [55]. On AoIP RTP terminations, IETF RFC 2198 [64] shall be used for redundant data of the CLEARMODE payload type being used for the CSD service. Only the redundancy level 2 and level 3 are supported on the AoIP RTP terminations. For details at start and stop of a redundant data stream as well as in handover cases see TS 48.103 [65]. + +The MGC determines by BSSMAP negotiation with the BSS, whether redundancy is used and if so which level to use for the CS Data service. A dynamic payload type with "red" as encoding name shall be included in both the local and remote descriptor with the fmtp attribute to signal the redundancy level. The same redundancy level shall be used in the Local Descriptor and the Remote Descriptor to use the same redundancy level in both directions between the MGW with the BSS. + +NOTE: Whether the RTP payload for Redundant Audio Data is supported by the MGW is known by the MSC due to configuration data. + +The MGC shall include both the CLEARMODE payload type and the Redundant RTP Payload for Audio Data in the Mc interface towards the MGW when the Redundant RTP Payload for Audio Data encapsulating the CLEARMODE payload shall be used. The MGW shall then apply the procedures for support of RTP redundancy as described in 3GPP TS 48.103 [65]. + +The SDP-syntax on the Mc interface for CS Data with redundancy level 2 is: + +``` +m=audio RTP/AVP 121 120 +a=rtpmap:120 CLEARMODE/8000 +a=rtpmap:121 red/8000 +a=fmtp:121 120/120 +``` + +The SDP-syntax on the Mc interface for CS Data with redundancy level 3 is: + +``` +m=audio RTP/AVP 121 120 +a=rtpmap:120 CLEARMODE/8000 +a=rtpmap:121 red/8000 +a=fmtp:121 120/120/120 +``` + +### 10.2.4 Other Payload Types + +On RTP terminations, other payload types such as additional ITU-T codecs can be transported according to the RTP payload formats in IETF but their support is outside the scope of 3GPP specifications. + +# 11 Mandatory Support of SDP and H.248.1 annex C information elements + +This section shall be in accordance with the subclause "Mandatory Support of SDP and H.248.1 annex C information elements" in ITU-T Recommendation Q.1950 [23] (see 3GPP TS 29.205 [7]) with the following requirements: + +- Mc Single Codec encoding: + +The ACodec property in H.248 binary encoding and codecconfig attribute in H.248 text encoding are set as defined in ITU-T Recommendation Q.765.5 [24], for single codec information (figure 14/Q.765.5), where the Codec Information is defined either in ITU-T Recommendation Q.765.5 [24] or in another specification for the given Organization Identifier. For 3GPP codecs these are defined in 3GPP TS 26.103 [16]. The codecconfig and ACodec parameters contain the contents of the Single Codec IE, excluding the Single Codec Identifier, Length Indication and Compatibility Information. + +The 'vsel' attribute is omitted in H.248 text encoding. + +Example of encoding of an AMR codec: + +Acocode = 0206959504 (binary encoding) + +codecconfig = 0206959504 (text encoding) + +where the AMR parameters are: ETSI, UMTS\_AMR\_2, [ACS={4.75, 5.90, 7.4, 12.2}, SCS={4.75, 5.90, 7.4, 12.2}, OM=0, MACS=4] + +Example of encoding of a G.711 codec: + +Acocode = 0101 (binary encoding) + +codecconfig = 0101 (text encoding) + +where the G.711 parameters are: ITU-T, G.711 64kps A-law + +Example of encoding of an EVS codec: + +Acocode = 020E01 (binary encoding) + +codecconfig = 020E01 (text encoding) + +where the EVS parameters are: ETSI, UMTS\_EVS, Config-EVS-Code=1, and Config-EVS-Code 2 is not present + +NOTE: The "Mc Single Codec IE" differs from the ITU-T defined "Single Codec IE", while on the Nc interface (i.e. in OoBTC) the ITU-T Single Codec IE is used without deviation. + +The Acocode property or codecconfig attribute set to the MuMe Dummy codec denotes a multimedia call. The Acocode property and codecconfig attribute shall never be set to the MuMe2 Dummy codec. See 3GPP TS 26.103 [16] and 3GPP TS 23.172 [37]. + +For further definition see Annex C.15. + +# --- 12 General on Packages and Transactions + +The use of "Overspecified" (e.g. range of values) and "Underspecified" (e.g. "?") parameter specification shall not be permitted except where explicitly indicated in or referenced by the Mc interface specification. + +The use of wildcarding for the Termination Id shall be performed using 1 octet only. + +Notifications shall not be sent by the MGW in response to Release Termination procedure. + +Parameter modification and event notification shall not be permitted on non-ROOT Terminations in the NULL Context. + +Commands on ROOT Termination shall only use the NULL Context. + +If a command cannot be executed by the MSC Server due to a temporary congestion/ongoing task the error code 511 ("Temporarily Busy") may be returned; the MGW may then re-issue the command as the condition may have abated. + +NOTE: At the time of inclusion this error code did not exist in the H.248.8 further details of this error code see ITU-T Sub-series Implementors' Guide.(13 April 2006). + +If a circumstance arises at an MGW where a substantial number of notifications accumulate, either because of transmission difficulties or because the MGW recognised a number of events in a short time period, the MGW should send the notifications in a restricted manner (e.g. via configuration) until the backlog is cleared. + +For further definition see Annex C. + +# --- 13 BICC packages + +## 13.1 Mandatory BICC packages + +Mandatory BICC packages are listed in Annex C.14. + +## 13.2 Optional BICC packages + +Optional BICC packages are listed in Annex C.14. + +# 14 H.248 standard packages + +Mandatory and Optional H.248 packages are listed in Annex C.14. + +## 14.1 Call independent H.248 transactions + +Table 2 shows the relationship between each non call-related procedure in ITU-T Recommendation Q.1950 [23] (see 3GPP TS 29.205 [7]) and the corresponding stage 2 procedure defined in 3GPP TS 23.205 [2]. + +For further description of error codes and service change reasons, refer to ITU-T Recommendation H.248.8 [14]. + +**Table 14.1.1: Correspondence between ITU-T Recommendation Q.1950 [23] non call-related transactions and 3GPP TS 23.205 [2] procedures** + +| Transaction used in ITU-T Recommendation Q.1950 [23] | Procedure defined in 3GPP TS 23.205 [2] | Support | Comments | +|------------------------------------------------------|-----------------------------------------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------| +| BIWF_Service_Cancellation_Indication | MGW Out of Service | Mandatory | | +| BIWF_Lost_Communication | MGW Communication Up | Mandatory | | +| BIWF_Service_Restoration_Indication | MGW Restoration | Mandatory | | +| BIWF_Registration | MGW Register | Mandatory | | +| BIWF_Re-Registration | MGW Re-register | Mandatory | | +| CCU Ordered BIWF Re-Registration | (G)MSC Server Ordered Re-register | Mandatory | | +| CCU Initiated Service Restoration | (G)MSC Server Restoration | Optional | | +| CCU Initiated Service Cancellation | (G)MSC Server Out of Service | Optional | | +| BIWF_Service_Cancellation_Indication | Termination Out-of-Service | Mandatory | Is a part of BIWF Service cancellation in Q.1950 | +| BIWF_Service_Restoration_Indication | Termination Restoration | Mandatory | Is a part of BIWF Service cancellation in Q.1950 | +| Audit_Values | Audit Value | Mandatory | Shall be supported for the audit of Termination State and for periodic audit of MGW (empty Audit descriptor). May be supported for the audit of packages. | +| Audit_Capabilities | Audit Capability | Optional | The capabilities to be audited shall be defined in clause 12. | +| BIWF_Capability_Change | Capability Update | Optional | This corresponds to MGW Capability Change in this document. | +| | MGW Resource Congestion Handling - Activate | Mandatory | | +| | MGW Resource Congestion Handling - Indication | Mandatory | | +| Continuity Check Tone | | Optional | | +| Continuity Check Verify | | Optional | | +| Continuity Check Response | | Optional | | +| Not Defined | Inactivity Timeout - Activate | Optional | | +| Not Defined | Inactivity Timeout - Indication | Optional | | +| Not Defined | Realm Availability Change - Activation | Optional | | +| Not Defined | Realm Availability Change - Indication | Optional | | + +### 14.1.1 MGW Out of service/Maintenance Locking + +This procedure is the same as described in the subclause "BIWF Service Cancellation Indication" in ITU-T Recommendation Q.1950 [23] (see 3GPP TS 29.205 [7]), with the following clarification. + +**Table 14.1.1.1: MGW Out of service/Maintenance Locking** + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = Null
Termination ID = Root
Service Change Reason =
MGW impending failure
Termination Taken out of service
Service Change Method =
Graceful / Forced | | + +Delay is not used. + +NOTE: The termination that is taken out of service is a Media Gateway. + +### 14.1.2 MGW Communication Up + +This procedure is the same as described in the subclause "BIWF Lost Communication" in ITU-T Recommendation Q.1950 [23] (see 3GPP TS 29.205 [7]) with the following clarification. + +Use of time stamps is optional. + +Context Id value Null shall be used in this procedure. + +The ServiceChangeMGCId parameter may be returned in the MGW Communication Up response if the MGC does not wish to sustain an association with the MGW. If present in the response, the MGW shall not consider itself registered and should preferably attempt to re-register with the MGC specified in the ServiceChangeMgcID before any further alternate MGCs. + +### 14.1.3 MGW Restoration + +This procedure is the same as described in the subclause "BIWF Service Restoration Indication" in ITU-T Recommendation Q.1950 [23] (see 3GPP TS 29.205 [7]) with the following clarification. + +**Table 14.1.3: MGW Restoration** + +| Address Information | Control information | Bearer information | +|---------------------|------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = Null
Termination ID = Root | | + +Delay is not used. + +The ServiceChangeMGCId parameter may be returned in the MGW Restoration response if the MGC does not wish to sustain an association with the MGW. If present in the response, the MGW shall not consider itself registered and should preferably attempt to re-register with the MGC specified in the ServiceChangeMgcID before any further alternate MGCs. + +### 14.1.4 MGW Register + +This procedure is the same as that described in the subclause "BIWF Registration" in ITU-T Recommendation Q.1950 [23] (see 3GPP TS 29.205 [7]) with the following clarification. + +#### 14.1.4: MGW Register + +| Address Information | Control information | Bearer information | +|---------------------|---------------------------------------------------|--------------------| +| | ServiceChangeProfile =
mcprofileName / version | | + +Use of time stamps is optional. + +Context Id value Null shall be used in this procedure. + +Non Standard Data is shall not be supported. + +Service Change Address shall not be used. + +The ServiceChangeMGCId parameter may be returned in the MGW Register response. If present in the Register response, the MGW shall not consider itself registered and should preferably attempt to re-register with the MGC specified in the ServiceChangeMgcID before any further alternate MGCs. + +### 14.1.5 MGW Re-register + +This procedure is the same as that described in the subclause "BIWF Re-Registration" in ITU-T Recommendation Q.1950 [23] (see 3GPP TS 29.205 [7]) with the following clarification. + +##### Table 14.1.5.1: MGW Re-register + +| Address Information | Control information | Bearer information | +|---------------------|---------------------------------------------------|--------------------| +| | ServiceChangeProfile =
mcprofileName / version | | + +Use of time stamps is optional. + +Context Id value Null shall be used in this procedure. + +Non Standard Data is shall not be supported. + +Service Change Address shall not be used. + +The ServiceChangeMGCId parameter may be returned in the MGW Re-register response. If present in the response, the MGW shall not consider itself registered and should preferably attempt to re-register with the MGC specified in the ServiceChangeMgcID before any further alternate MGCs. + +### 14.1.6 (G)MSC Server Ordered Re-register + +This procedure is the same as described in the subclause "CCU Ordered BIWF Re-registration" in ITU-T Recommendation Q.1950 [23] (see 3GPP TS 29.205 [7]) with the following clarifications: + +Context Id value Null shall be used in this procedure. + +### 14.1.7 (G)MSC Server Restoration + +This procedure is the same as described in the subclause "CCU Initiated Service Restoration" in ITU-T Recommendation Q.1950 [23] (see 3GPP TS 29.205 [7]) with the following clarification. + +**Table 14.1.7.1: (G)MSC Server Restoration** + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Context ID = Null
Termination ID =
Root
Service Change Reason =
Cold Boot / Warm Boot
Service Change Method = Restart | | + +Delay is not used. + +### 14.1.8 Termination Out-of-Service + +This procedure is the same as described in the subclause "BIWF Service Cancellation Indication" in ITU-T Recommendation Q.1950 [23] (see 3GPP TS 29.205 [7]) with the following clarifications. This procedure may be used to inform the MSC Server of the Service State of Terminations after MGW Restart or Registration. + +**Table 14.1.8.1: ServiceChange.req (Termination Out-of-Service) MGW to MGC** + +| Address Information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = Contexts / Null / All
Termination ID = ALL/Termination(s)
Service Change Reason = Transmission failure / Termination malfunctioning /
Loss of lower layer connectivity / Termination taken out of service
Service Change Method = Graceful / Forced

NOTE1: "All" shall refer to 1 TDM group. 1 TDM group is at a T1/E1. | | + +Delay is not used. + +The MGW shall delay initiating a TDM Termination Out-of-Service procedure till completion of any on-going Termination Restoration procedure for the same TDM termination, if any, unless the MGW considers the previous transaction request or reply lost, due to e.g. failure of the control association. + +The following table illustrates the allowed combinations that can be obtained with the ServiceChange Command: + +**Table 14.1.8.2: Combinations of ContextID and TerminationID in Termination Out-of- Service Procedure** + +| ContextID | TerminationID | Description | +|-----------|---------------|----------------------------------------------------------------------------------------------------------------------------------------| +| Specific | Specific | Service Change of a specific Termination in a specific Context | +| Null | Wildcard | Service Change of all matching TDM T1/E1 level terminations in the Null Context | +| Null | Specific | Service Change of a specific termination in the Null Context | +| All | Wildcard | Service Change of all matching TDM T1/E1 level terminations in specific (non-Null) contexts in which the terminations currently exist. | + +### 14.1.9 Termination Restoration + +This procedure is the same as described in the subclause "BIWF Service Restoration Indication" in ITU-T Recommendation Q.1950 [23] (see 3GPP TS 29.205 [7]) with the following clarification. This procedure may be used to inform the MSC Server of the Service State of Terminations after MGW Restart or Registration and shall be used when individual trunks are commissioned. + +**Table 14.1.9.1: Termination Restoration** + +| Address Information | Control information | Bearer information | +|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = Contexts / Null / All
Termination ID = ALL/Termination(s)
Service Change Reason = Service Restored
Service Change Method = Restart

NOTE1: "All" shall refer to 1 TDM group. 1 TDM group is at a T1/E1. | | + +Delay shall not be used. + +The MGW shall delay initiating a TDM Termination Restoration procedure till completion of any on-going Termination Out-of-Service procedure for the same TDM termination, if any, unless the MGW considers the previous transaction request or reply lost, due to e.g. failure of the control association. + +The following table illustrates the allowed combinations that can be obtained with the ServiceChange Command: + +**Table 14.1.9.2: Combinations of ContextID and TerminationID in Termination Restoration Procedure** + +| ContextID | TerminationID | Description | +|-----------|---------------|----------------------------------------------------------------------------------------------------------------------------------------| +| Specific | Specific | Service Change of a specific Termination in a specific Context | +| Null | Wildcard | Service Change of all matching TDM T1/E1 level terminations in the Null Context | +| Null | Specific | Service Change of a specific termination in the Null Context | +| All | Wildcard | Service Change of all matching TDM T1/E1 level terminations in specific (non-Null) contexts in which the terminations currently exist. | + +### 14.1.10 Audit Value + +This procedure is the same as described in the subclause "Audit Values" in ITU-T Recommendation Q.1950 [23] (see 3GPP TS 29.205 [7]), with the following clarifications. This procedure shall be used by the MSC Server to determine the service state of physical terminations when the MSC Server itself has restarted if it is subsequently unsure of the service state of terminations or when O&M procedures indicate new physical trunks have been commissioned to an in service MGW. It shall also be used for determining the Termination State after MGW Registration (Cold Boot) prior to unblocking devices in the network if the MSC Server has not been informed specifically by Termination Restoration or Termination Out Of Service Procedure. Table 14.1.10.1: AUD\_VAL.req (Audit\_Values) MGC to MGW + +| Address Information | Control information | Bearer information | +|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| |

Transaction ID = z

Context ID = Null/Context ID/ALL

Termination ID =

Termination/Root/ALL(see NOTE1)

Audit Descriptor =

Empty/

IndAuditParameter:=

IndAudMediaDescriptor:=

TermStateDescriptor (NOTE3)

Packages (See NOTE2)

Audit Descriptor = IndAuditParameter:= IndAudMediaDescriptor:=
IndAudTerminationStateDescriptor:= SDPCapNeg Supported Capabilities (NOTE4)

NOTE1: "All" shall refer to 1 TDM group. 1 TDM group is at a T1/E1 level It shall not be used for ATM or IP termination.
"Termination" may be used for individual TDM, IP or ATM terminations.

NOTE2: Packages is for
- Null/Root Combination

NOTE3: Pre Rel6 this is performed with Audit Token

NOTE4: Used for auditing SDPCapNeg Extensions when SDPCapNeg signalling to the gateway is supported.

| | + +Upon reception of the command in the MGW: + +- The Service State returns the current Service State +- When Packages are requested, the Package Names and Versions are returned + +The following table illustrates the allowed combinations that can be obtained with the AuditValue Command: + +**Table 14.1.10.2: Combinations of AuditValue Command** + +| ContextID | TerminationID | Information Obtained | +|-----------|---------------|-------------------------------------------------------------------------------------------------| +| Specific | Wildcard | Audit of matching Terminations in a Context | +| Specific | Specific | Audit of a single Termination in a Context | +| Null | Root | Audit of Media Gateway state and events | +| Null | Wildcard | Audit of all matching TDM T1/E1 level Terminations in the null Context | +| Null | Specific | Audit of a single Termination outside of any Context | +| All | Wildcard | Audit of all matching TDM T1/E1 level Terminations and the Context to which they are associated | +| All | Specific | (Non-null) ContextID in which the Termination currently exists | + +**Table 14.1.10.3: AUD\_VAL.resp MGW to MGC** + +| Address Information | Control information | Bearer information | +|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| |

Transaction ID = z

Context ID = Null/Context ID/ALL

Termination ID =

Termination/Root/ALL(see NOTE1)

Audit Descriptor =

Empty/

IndAuditParameter:=

IndAudMediaDescriptor:=

TermStateDescriptor (NOTE3)

Packages (See NOTE2)

Audit Descriptor = IndAuditParameter:= IndAudMediaDescriptor:=
IndAudTerminationStateDescriptor:= SDPCapNeg Supported Capabilities (NOTE4)

NOTE1: "All" shall refer to 1 TDM group. 1 TDM group is at a T1/E1 level It shall not be used for ATM or IP termination.
"Termination" may be used for individual TDM, IP or ATM terminations.

NOTE2: Packages is for
- Null/Root Combination

NOTE3: Pre Rel6 this is performed with Audit Token

NOTE4: Used for auditing SDPCapNeg Extensions when SDPCapNeg signalling to the gateway is supported.

| | + +### 14.1.11 Audit Capability + +This procedure is the same as described in the subclause "Audit Capabilities" in ITU-T Recommendation Q.1950 [23] (see 3GPP TS 29.205 [7]). + +### 14.1.12 MGW Capability Change + +This procedure is the same as described in the subclause "BIWF Capability Change" in ITU-T Recommendation Q.1950 [23] (see 3GPP TS 29.205 [7]) with the following clarification:. + +For Capability changes concerning the whole MGW: + +Service Change Reason Media/Event or Signal Capability Failure shall not be used instead the following information shall be used: + +ServiceChange.req (MGW Capability Change) + +MGW to MGC + +**Table 14.1.12.1: MGW Capability Change** + +| Address Information | Control information | Bearer information | +|--------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Service Change Reason =
Packages Change/ Capability Change
Service Change Info = changed package/property/signal/event/ statistics | | +| Note: The changed package/property/signal/event/ statistics information is FFS | | | + +### 14.1.13 (G)MSC Server Out of Service + +This procedure is the same as that described in the subclause "CCU Initiated Service Cancellation" in ITU-T Recommendation Q.1950 [23] (see 3GPP TS 29.205 [7]) with the following clarification. + +**Table 14.1.13.1: (G)MSC Server Out of Service** + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------|--------------------| +| | Service Change Reason = Termination taken out of service | | + +Delay shall not be used. + +### 14.1.14 MGW Resource Congestion Handling - Activate + +If the procedure "MGW Resource Congestion Handling - Activate" is required the following procedure is initiated. + +The MGC sends a MOD.req command with the following information. + +**Table 14.1.14.1: MOD.req(MGW Resource Congestion Handling - Activate) MGC to MGW** + +| Address Information | Control information | Bearer information | +|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = Null
Termination ID = Root

NotificationRequested (Event ID = x, "MGW Resource Congestion Handling - Indication") | | + +When the processing of command (1) is complete, the MGW initiates the following procedure. + +**Table 14.1.14.2: MOD.resp (MGW Resource Congestion Handling - Activate) MGW to MGC** + +| Address Information | Control information | Bearer information | +|---------------------|-----------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = Null
TerminationID = Root | | + +### 14.1.15 MGW Resource Congestion Handling - Indication + +If the procedure "MGW Resource Congestion Handling - Indication" is required, the following procedure is initiated: + +The MGW sends a NOT.req command with the following information. + +**Table 14.1.15.1: NOT.req (MGW Resource Congestion Handling - Indication) MGW to MGC** + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = Null
Termination ID = Root

Event_ID (Event ID = x, "MGW Resource Congestion Handling - Indication (Reduction)") | | + +When the processing of command (1) is complete, the MGC initiates the following procedure. + +**Table 14.1.15.2: NOT.resp (MGW Resource Congestion Handling - Indication) MGC to MGW** + +| Address Information | Control information | Bearer information | +|---------------------|------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = Null
Termination ID = Root | | + +### 14.1.16 Continuity Check Tone + +This procedure is the same as described in Annex B.7.1.1 of ITU-T Recommendation Q.1950 [23] with the following clarification: + +The addition to "Prepare BNC Notify" defined in Annex B.7.1.1 of ITU-T Recommendation Q.1950 [23] shall be applied instead to "Reserve Circuit", as defined in Clause 13.2.2.1 + +Note: This does not preclude the use of the continuity check tone for other maintenance procedures. If the termination is audited it shall report state in service. + +### 14.1.17 Continuity Check Verify + +This procedure is the same as described in Annex B.7.2.1 of ITU-T Recommendation Q.1950 [23]. + +### 14.1.18 Continuity Check Response + +This procedure is the same as described in Annex B.7.1.2 of ITU-T Recommendation Q.1950 [23] with the following clarification: + +The addition to "Prepare BNC Notify" defined in Annex B.7.1.2 of ITU-T Recommendation Q.1950 [23] shall be applied instead to "Reserve Circuit", as defined in Clause 13.2.2.1 + +Note: This does not preclude the use of the continuity check response for other maintenance procedures. If the termination is audited it shall report state in service. + +### 14.1.19 Inactivity Timeout - Activate + +If the procedure "Inactivity Timeout - Activate" is required the following procedure is initiated. + +The MGC sends a MOD.req command with the following information. + +**Table 14.1.19.1: MOD.req (Inactivity Timeout - Activate) MGC to MGW** + +| Address Information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = Null
Termination ID = Root

NotificationRequested (Event ID = x, "Inactivity Timeout - Indication") | | + +When the processing of command (1) is complete, the MGW initiates the following procedure. + +**Table 14.1.19.2: MOD.resp (Inactivity Timeout - Activate) MGW to MGC** + +| Address Information | Control information | Bearer information | +|---------------------|-----------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = Null
TerminationID = Root | | + +### 14.1.20 Inactivity Timeout – Indication + +When the procedure "Inactivity Timeout indication" is required the following procedure is initiated: the MGW sends a NOT.req command with the following information. + +**Table 14.1.20.1: NOT.req (Inactivity Timeout - Indication) MGW to MGC** + +| Address Information | Control information | Bearer information | +|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = NULL
Termination ID = Root

Event_ID (Event ID = x,
" Inactivity Timeout - Indication ") | | + +When the processing of command is complete, the MGC initiates the following procedure. + +**Table 14.1.20.2: NOT.resp (Inactivity Timeout - Indication) MGC to MGW** + +| Address Information | Control information | Bearer information | +|---------------------|------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = NULL
Termination ID = Root | | + +### 14.1. 21 Realm Availability Change – Activation + +The MGC sends a MODIFY request command as in Table 14.1.221.1. + +**Table 14.1.21.1: Realm Availability Change – Activation** + +| Address Information | Control information | Bearer information | +|---------------------|------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID= -
Termination ID = ROOT

NotificationRequested (Event ID = x,
"Realm Availability Change") | | + +The MGW responds as in Table 14.1.21.2. + +**Table 14.1.21.2: Realm Availability Change – Activation Ack** + +| Address Information | Control information | Bearer information | +|---------------------|---------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = -
Termination ID = ROOT | | + +### 14.1. 22 Realm Availability Change – Indication + +The MGW sends a NOTIFY request command as in Table 14.1.22.1. + +**Table 14.1.22.1: Realm Availability Change – Indication** + +| Address Information | Control information | Bearer information | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID= -
Termination ID = ROOT

Event_ID (Event ID = x,
"Realm Availability Change
(Changed Realms)") | | +| NOTE: The ObservedEvent Parameters returned within the Changed Realms are defined as mandatory since it shall contain at minimum 1 parameter but may contain both Newly Available Realms and Newly Unavailable Realms. | | | + +The MGC responds as in Table 14.1.22.2 + +**Table 14.1.22.2: Realm Availability Change – Indication Ack** + +| Address Information | Control information | Bearer information | +|---------------------|---------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = -
Termination ID = ROOT | | + +## 14.2 Call related H.248 transactions + +Table 14.2.1 shows the relationship between each call-related procedure in ITU-T Recommendation Q.1950 [23] (see 3GPP TS 29.205 [7]) and the corresponding stage 2 procedure defined in 3GPP TS 23.205 [2], as well as specifying the requirement for support of each procedure on the Mc interface. + +**Table 14.2.1: Correspondence between ITU-T Recommendation Q.1950 [23] call-related transactions and 3GPP TS 23.205 [2], 3GPP TS 23.153 [1], 3GPP TS 23.231 [54] and 3GPP TS 29.292 [60] procedures** + +| Transaction used in Q.1950 | Procedure defined in 3GPP TS 23.205 [2], 23.153 [1], 23.231 [54] or 29.292 [60] | Support | Comments | +|---------------------------------------|---------------------------------------------------------------------------------|-----------|------------------------------------------------------------------------------| +| Change_Topology | Change Flow Direction | Mandatory | | +| Join | Join Bearer Termination | Mandatory | | +| Isolate | Isolate Bearer Termination | Mandatory | | +| Establish_BNC_Notify+(tunnel) | Establish Bearer | Mandatory | | +| Prepare_BNC_Notify+(tunnel) | Prepare Bearer | Mandatory | | +| Cut_Through | Change Through Connection | Mandatory | | +| Not defined in Q.1950 | Activate Interworking Function | Optional | | +| Cut_BNC (include several procedures). | Release Bearer (Release Bearer and Release termination) | Mandatory | | +| BNC Established | Bearer Established | Mandatory | | +| BNC Release | Bearer Released | Mandatory | | +| Insert_Tone | Send Tone | Mandatory | | +| Insert_Announcement | Play Announcement | Mandatory | | +| Signal Completion | Announcement Completed | Mandatory | | +| Detect_Digit | Detect DTMF | Mandatory | | +| Insert_Digit | Send DTMF | Mandatory | | +| Digit Detected | DTMF | Mandatory | | +| Confirm_Char | Confirm Char | Optional | | +| Modify_Char | Modify Char | Optional | | +| Reserve_Char | Reserve Char | Optional | | +| BNC Modified | Bearer Modified | Optional | | +| Echo Canceller | Activate Voice Processing Function | Mandatory | | +| BNC Modification failed | Bearer Modified Failed | Optional | | +| Tunnel (MGC-MGW) | Tunnel Information Down | Optional | Shall be supported for BICC associated Nb interface transport protocol on IP | +| Tunnel (MGW-MGC) | Tunnel Information Up | Optional | Shall be supported for BICC associated Nb interface transport protocol on IP | +| Insert_Tone | Stop Tone | Mandatory | | +| Insert_Announcement | Stop Announcement | Mandatory | | +| Detect_Digit | Stop DTMF Detection | Optional | | +| Insert_Digit | Stop DTMF | Mandatory | | +| Signal Completion | Tone Completed | Optional | | +| Not defined | Reserve Circuit | Mandatory | | +| Not defined | Command Rejected | Mandatory | | +| Not defined | TFO Activation | Optional | | +| Not defined | Codec Modify | Optional | | +| Not defined | Optimal Codec and Distant List_Notify | Optional | | +| Not defined | Distant Codec List | Optional | | +| Not defined | TFO status Notify | Optional | | +| Not defined | TFO status | Optional | | +| Modify_Char | Modify Bearer Characteristics | Mandatory | | +| Not defined | Rate Change | Optional | | +| Not defined | Bearer Modification Support | Optional | | +| Not defined | Protocol Negotiation Result | Optional | | +| Reserve_Char | Reserve Bearer Characteristics | Optional | | +| Confirm_Char | Confirm Bearer Characteristics | Optional | | +| ECS_Indication | Emergency Call Indication | Optional | | +| Continuity Check Tone | Continuity Check Tone | Optional | See 14.1.16 | +| Continuity Check Verify | Continuity Check Verify | Optional | See 14.1.17 | +| Continuity Check Response | Continuity Check Response | Optional | See 14.1.18 | +| Not Defined | Prepare IP Transport | Optional | Shall be supported if IP used on lu interface | +| Not Defined | Modify IP Transport Address | Optional | Shall be supported if IP used on lu interface | + +| | | | | +|-------------|-----------------------------------------------|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------| +| Not defined | Termination heartbeat | Mandatory | To allow detection of hanging contexts and terminations in the MGW that may result e.g. from a loss of communication between the MSC-S and the MGW | +| Not Defined | Reserve RTP Connection Point | Optional | Required for SIP-I associated Nb and A interface over IP | +| Not Defined | Configure RTP Connection Point | Optional | Required for SIP-I associated Nb and A interface over IP | +| Not defined | Reserve and Configure RTP Connection Point | Optional | Required for SIP-I associated Nb and A interface over IP | +| Not defined | Media Inactivity Notification | Optional | See 14.2.55 | +| Not defined | ECN Failure Indication (NOTE 2) | Optional | Only applicable if ECN support is required | +| Not defined | ICE Connectivity Check Result Indication | Optional | Only applicable if full ICE is supported. | +| Not defined | ICE New Peer Reflexive Candidate Notification | Optional | Only applicable if full ICE is supported | + +NOTE 1: A procedure defined in table 3 can be combined with another procedure in the same action. This means that they can share the same contextID and termination ID(s). +NOTE 2: ECN support is only applicable for MSC enhanced for ICS. + +### 14.2.1 Change Flow Direction + +This procedure is the same as that defined in the subclause "Change Connection Topology" in ITU-T Recommendation Q.1950 [23] (see 3GPP TS 29.205 [7]) with the following additions. + +**Table 14.2.1.1: Change Flow Direction request additions** + +| Address Information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------------------------------------------------------------|--------------------| +| | Context ID = c1,?
Connection Configuration =
(TerminationID= x1, ?
TerminationID=x2,?
[type = x]),... | | + +This procedure shall not be used for Multiparty bridge contexts. + +The Change Flow Direction response shall contain the Context ID. + +A command is only required if this procedure is combined with some other procedure which changes a termination functionality. + +### 14.2.2 Isolate Bearer Termination + +This procedure is the same as that defined in the subclause "Isolate" in ITU-T Recommendation Q.1950 [23] (see 3GPP TS 29.205 [7]). + +### 14.2.3 Join Bearer Termination + +This procedure is the same as that defined in the subclause "Join" in ITU-T Recommendation Q.1950 [23] (see 3GPP TS 29.205 [7]). + +### 14.2.4 Establish Bearer + +This procedure is the same as that defined in the subclause "Establish BNC\_notify" in ITU-T Recommendation Q.1950 [23] (see 3GPP TS 29.205 [7]) except that the Command MOV shall not be used, BNC events are requested optionally and independently and with additions as shown below. If IPBCP Tunnel Option 1 is required then the Command Response shall always precede the IPBCP Notify Command. + +**Table 14.2.4.1: Establish Bearer additions** + +| Address Information | Control information | Bearer information | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| |

UP mode = Mode

UP version = version

Delivery of erroneous SDUs = value

Interface = interface

If support mode:
Initdirection = initdir

If indication on Protocol Negotiation Result requested:
NotificationRequested (Event ID = x, "Prot Negotiation Result")

If indication on Rate Change requested:
NotificationRequested (Event ID = x, "RateChange")

If detection of hanging termination is requested:
(NOTE 3)
NotificationRequested (Event ID = x, "termination heartbeat")

If Listener context: number of desired listener context terminations = required listener context terminations

If multiple IP realms: IP realm Identifier = required IP realm identifier

If indication on BNC Established requested:
NotificationRequested (Event ID = x, "BNC Established")

If indication on BNC Modified requested:
NotificationRequested (Event ID = x, "BNC Modified")

If indication on BNC Mod Failed requested:
NotificationRequested (Event ID = x, "BNC Mod Failed")

If indication on BNC Release requested:
NotificationRequested (Event ID = x, "BNC Release")

|

If SCUDIF multimedia call :
MuMe codec (NOTE 1)

If data call other than SCUDIF multimedia call and Access Termination or Anchor MGW Network Termination:
PLMN bearer capability = PLMN capability (NOTE2)

If GSM data call other than SCUDIF multimedia call and (Anchor MGW Network Termination):
GSM channel coding = coding

| +|

NOTE1: Bearer Service Characteristics shall be excluded when this property is included.

NOTE2: Bearer Service Characteristics may be included.

NOTE3: Termination heartbeat notification shall be included when requesting a new bearer termination.

| | | + +### 14.2.5 Prepare Bearer + +This procedure is the same as that defined in the subclause "Prepare\_BNC\_notify" in ITU-T Recommendation Q.1950 [23] (see 3GPP TS 29.205 [7]) except that the Commands MOD and MOV shall not be used, the MGW shall not choose the BNC Characteristics, the BNC-cut-through-capability shall not be used, BNC events are requested optionally and independently and with additions as shown below. + +**Table 14.2.5.1: Prepare Bearer additions** + +| Address Information | Control information | Bearer information | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| |

UP mode = mode

UP version = version

Delivery of erroneous SDUs = value

Interface = interface

If support mode:
Initdirection = initdir

If CTM call and Access Termination:
State= ctmstate
Transport= ctmtransport
Version= ctmtext version

If data call and Non-Anchor MGW RAN-side termination:
Bitrate = bitrate (NOTE1)

If indication on Protocol Negotiation Result requested:
NotificationRequested (Event ID = x, "Prot Negotiation Result")

If indication on Rate Change requested:
NotificationRequested (Event ID = x, "RateChange")

If indication on Bearer Modification requested:
NotificationRequested (Event ID = x, "Bearer Modification Support")

If notification on CTM negotiation result requested:
NotificationRequested (Event ID = x, "connchange ")

NotificationRequested (Event ID = x, "termination heartbeat")

If VGCS/VBS context: number of needed conference terminations = required conference terminations

If multiple IP realms:
IP realm Identifier = required IP realm identifier.

If indication on BNC Established requested:
NotificationRequested (Event ID = x, "BNC Established")

If indication on BNC Modified requested:
NotificationRequested (Event ID = x, "BNC Modified")

If indication on BNC Mod Failed requested:
NotificationRequested (Event ID = x, "BNC Mod Failed")

If indication on BNC Release requested:
NotificationRequested (Event ID = x, "BNC Release")

|

If SCUDIF multimedia call and (network termination or Anchor MGW Access Termination):
MuMe codec (NOTE2)

If data call other than SCUDIF multimedia call and (Anchor MGW Access Termination or Anchor MGW Network Termination):
PLMN bearer capability = PLMN capability (NOTE3)

If GSM data call other than SCUDIF multimedia call and Anchor MGW Network Termination:
GSM channel coding = coding

| +|

NOTE1 : Bearer Service Characteristics shall be excluded when this property is included except for the case when bitrate = 64000 and then Bearer Service Characteristics may be included. Bitrate is optional for transparent data calls when the data rate is 64k bits/s.

NOTE2: Bearer Service Characteristics shall be excluded when this property is included.

NOTE3: Bearer Service Characteristics shall be excluded when this property is included, except for Anchor MGW network termination for which it may be included.

| | | + +### 14.2.6 Change Through Connection + +This procedure is the same as that defined in the subclause "Cut Through" in ITU-T Recommendation Q.1950 [23] (see 3GPP TS 29.205 [7]) with the following clarification and deletion. + +NotificationRequested = (Event ID = x, "Cut Through") is deleted and therefore only the Explicit (MGC Controlled Cut-Through procedure is supported. + +The MGW may support No\_Data RTP frames on RTP-A and RTP-CN terminations during the call establishment phase, i.e. when not in TrFO (see 3GPP TS 26.102 [26]), in which case it shall support it independently of the Stream Mode. + +### 14.2.7 Activate Interworking Function + +When the procedure "Activate Interworking Function" is required the following procedure is initiated: + +The MGC sends a MOD.req command with the following information. + +**Table 14.2.7.1: MOD.req (Activate Interworking function) MGC to MGW** + +| Address Information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = bearer1

Signal=actpro

If indication on Protocol Negotiation Result requested:
NotificationRequested (Event ID = x, "Prot Negotiation Result")

If indication on Rate Change requested:
NotificationRequested (Event ID = x, "RateChange") | | + +When the processing of command (1) is complete, the MGW initiates the following procedure. + +**Table 14.2.7.2: MOD.resp (Activate Interworking function) MGW to MGC** + +| Address Information | Control information | Bearer information | +|---------------------|------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
TerminationID = bearer1 | | + +### 14.2.8 Release procedures + +This subclause includes a number of procedures. + +#### 14.2.8.1 Release Bearer + +This procedure is the same as that defined in the subclause "Release" in ITU-T Recommendation Q.1950 [23] (see 3GPP TS 29.205 [7]) including the Modify command in the transaction with the clarification that the Termination ID and/or Context ID may be wildcarded (ALL). + +#### 14.2.8.2 Release Termination + +This procedure is the same as that defined in the subclause "Release" in ITU-T Recommendation Q.1950 [23] (see 3GPP TS 29.205 [7]) including a Subtract command in the transaction with the following additions. + +**Table 14.2.8.1 Sub.req (Release termination) MGC to MGW** + +| Address Information | Control information | Bearer information | +|---------------------|---------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1/ALL
Termination ID = bearer1/ALL | | + +**Table 14.2.8.2.2: Sub.resp (Release termination) MGW to MGC** + +| Address Information | Control information | Bearer information | +|---------------------|------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1/ALL
Termination ID = bearer1/ALL
If requested
Statistics= Ctmbits | | + +### 14.2.9 Bearer Released + +This procedure is the same as that defined in the subclause "BNC Release" in ITU-T Recommendation Q.1950 [23] (see 3GPP TS 29.205 [7]) with the following clarification: + +Termination ID shall be provided in the response. . + +The MGW may, as a configurable option, inhibit the reporting of normal AAL2 bearer release on a Iu termination. + +### 14.2.10 Bearer Established + +This procedure is the same as that defined in the subclause "BNC Established" in ITU-T Recommendation Q.1950 [23] (see 3GPP TS 29.205 [7]) with the following clarification: + +Termination ID shall be provided in the response. + +### 14.2.11 Send Tone + +This procedure is the same as that defined in the subclause "Media Content Insertion" - "Insert Tone" in ITU-T Recommendation Q.1950 [23] (see 3GPP TS 29.205 [7]) with the following additions. + +**Table 14.2.11.1: Send Tone additions** + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | If CAMEL Prepaid Warning Tone
Signal = warning tone
Or
Signal = flextone

If detection of hanging termination is requested:
NotificationRequested (Event ID = x,
"termination heartbeat") | | + +Signal Direction shall be either "internal" or "external". + +Only the Tone Signal Ids shall be used, not the Tone Ids within the PlayTone Signal Id. + +The termination heartbeat event shall be configured when requesting a new ephemeral bearer termination. + +### 14.2.12 Play Announcement + +This procedure is the same as that defined in the subclause "Media Content Insertion" - "Insert Announcement" in ITU-T Recommendation Q.1950 [23] (see 3GPP TS 29.205 [7]) with the following clarifications: + +**Table 14.2.12.1: Play Announcement additions** + +| Address Information | Control information | Bearer information | +|---------------------|-----------------------------------------------------------------------------------------------------------------------|--------------------| +| | If detection of hanging termination is requested:
NotificationRequested (Event ID = x,
"termination heartbeat") | | + +Signal Direction shall be either "internal" or "external". + +Stream mode may be maintained as for the ongoing call or may be restricted to "send only". + +Signal Lists shall be supported. + +The termination heartbeat event shall be configured when requesting a new ephemeral bearer termination. + +### 14.2.13 Send DTMF + +This procedure is the same as that defined in the subclause "Media Content Insertion" - "Insert Digit" in ITU-T Recommendation Q.1950 [23] (see 3GPP TS 29.205 [7]). The MGW shall ensure the minimum duration timing and minimum interval timing is achieved in accordance with the DTMF timing defined in TS 23.014 [27]. Maximum duration shall also be controlled by the MGW if required by the network. + +### 14.2.14 Detect DTMF + +This procedure is the same as that defined in the subclause "Media Content Detection" - "Detect Digit" in ITU-T Recommendation Q.1950 [23] (see 3GPP TS 29.205 [7]) with the exception that "long tone detected" (Event Id ltd) shall not be used. In addition "start tone detected" (EventId std) is optional and if not supported shall result in the command error code #449 "Unsupported or Unknown Parameter or Property Value". If both a request for "start tone detected" and "end tone detected" is received by the MGW that does not support "start tone detected" then it shall only report a notification upon detecting the end of a digit. + +Parameter *Duration* shall not be used. + +All digits shall be requested i.e. Tone\_Id shall be wildcarded. + +### 14.2.15 Report DTMF + +This procedure is the same as that defined in the subclause "Detected Digit" in ITU-T Recommendation Q.1950 [23] (see 3GPP TS 29.205 [7]) with the following clarification: + +Termination ID shall be provided in the response. + +### 14.2.16 Announcement Completed + +This procedure is the same as that defined in the subclause "Signal Completion" in ITU-T Recommendation Q.1950 [23] (see 3GPP TS 29.205 [7]) with the following clarification: + +Termination ID shall be provided in the response. + +The Signal List ID should be provided additionally if the completed Announcement belongs to a Signal List. + +### 14.2.17 Activate Voice Processing Function + +When the procedure "Activate Voice Processing Function" (VPF) is required the following procedure is initiated: + +The MGC sends an ADD.req, MOD.req or MOV.req command with the following information. + +**Table 14.2.17.1: ADD.req/MOD.req/MOV.req (Activate Voice Processing Function) MGC to MGW** + +| Address Information | Control information | Bearer information | +|---------------------|---------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = bearer1

ActivateVPF "ec"= on/off | | + +When the MGW receives the command, it shall associate the relevant voice processing function resources with the specified termination. + +When the processing of command (1) is complete, the MGW may initiate the "Voice Processing Function Ack" procedure. + +**14.2.17.2: ADD.resp/MOD.resp/MOV.resp (Voice Processing Function Ack) MGW to MGC** + +| Address Information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = bearer1 | | + +### 14.2.18 Reserve Circuit + +This procedure is activated when the "Reserve Circuit" procedure is initiated. + +An ADD.req command is sent with the following information. + +**Table 14.2.18.1: ADD.req (Reserve\_Circuit) CSM to BIWF** + +| Address Information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | Transaction ID = z
Termination ID = bearer1

Context Requested:
Context ID = ?
Context Provided:
Context ID = c1

If CTM call and Access Termination:
State= ctmstate
Transport= ctmtransport
Version= ctmtext version

If indication on Protocol Negotiation Result requested:
NotificationRequested (Event ID = x, "Prot Negotiation Result")

If indication on Rate Change requested:
NotificationRequested (Event ID = x, "RateChange")
If notification on CTM negotiation result requested:
NotificationRequested (Event ID = x, "connchange ")
If detection of hanging termination is requested:
NotificationRequested (Event ID = x, "termination heartbeat")

If indication on Bearer Released requested:
NotificationRequested (Event ID = x, "BNC Release (Cause)") – as defined in ITU-T Recommendation Q.1950 [23]

If Listener context: number of desired listener context terminations = required listener context terminations | Bearer Service Characteristics

If data call, Access Termination:
PLMN capabilities
If GSM data call, Access Termination:
GSM channel coding = coding | + +Upon completion of processing command (1) an ADD.resp command (2) is sent. + +**Table 14.2.18.2: ADD.resp BIWF to CSM** + +| Address Information | Control information | Bearer information | +|---------------------|------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
TerminationID = bearer1 | | + +### 14.2.19 Tunnel Information Up + +This procedure is the same as that defined in the subclause "Tunnel" in ITU-T Recommendation Q.1950 [23] (see 3GPP TS 29.205 [7]) with the clarification that BT/TunOpt = ? and BT/TunOpt = NO shall not be used. + +NOTE: This procedure is always initiated from the MGW. + +### 14.2.20 Tunnel Information Down + +This procedure is the same as that defined in the subclause "Tunnel" in ITU-T Recommendation Q.1950 [23] (see 3GPP TS 29.205 [7]) with the clarification that BT/TunOpt = ? and BT/TunOpt = NO shall not be used. + +NOTE: This procedure is always initiated from the MGC. + +### 14.2.21 Tone Completed + +This procedure is the same as that defined in the subclause "Signal.Completion" in ITU-T Recommendation Q.1950 [23] (see 3GPP TS 29.205 [7]) with the following clarification: + +Termination ID shall be provided in the response. + +### 14.2.22 Stop Announcement + +This procedure is the same as that defined in the subclause "Insert Announcement" in ITU-T Recommendation Q.1950 [23] (see 3GPP TS 29.205 [7]) with the following clarification. The signal descriptor shall not include any signal. + +## 14.2.23 Stop Tone + +This procedure is the same as that defined in the subclause "Insert Tone" in ITU-T Recommendation Q.1950 [23] (see 3GPP TS 29.205 [7]) with the following clarification. The signal descriptor shall not include any signal. + +## 14.2.24 Stop DTMF Detection + +This procedure is the same as that defined in the subclause "Detect Digit" in ITU-T Recommendation Q.1950 [23] (see 3GPP TS 29.205 [7]) with the following clarification. The eventDescriptor shall not include any event. + +## 14.2.25 Stop DTMF + +This procedure is the same as that defined in the subclause "Media Content Insertion" - "Insert Digit" in ITU-T Recommendation Q.1950 [23] (see 3GPP TS 29.205 [7]). The signal descriptor shall not include any signal. The MGW shall ensure the minimum duration timing and minimum interval timing is achieved in accordance with the DTMF timing defined in TS 23.014 [27]. Maximum duration shall also be controlled by the MGW if required by the network. + +## 14.2.26 Confirm Char + +This procedure is the same as that defined in the subclause "Confirm Char" in ITU-T Recommendation Q.1950 [23] (see 3GPP TS 29.205 [7]). + +## 14.2.27 Modify Char + +This procedure is the same as that defined in the subclause "Modify Char" in ITU-T Recommendation Q.1950 [23] (see 3GPP TS 29.205 [7]). + +## 14.2.28 Reserve Char + +This procedure is the same as that defined in the subclause "Reserve Char" in ITU-T Recommendation Q.1950 [23] (see 3GPP TS 29.205 [7]). + +## 14.2.29 Bearer Modified + +This procedure is the same as that defined in the subclause "BNC Modified" in ITU-T Recommendation Q.1950 [23] (see 3GPP TS 29.205 [7]). + +## 14.2.30 Bearer Modification Failed + +This procedure is the same as that defined in the subclause "BNC Modification failure" in ITU-T Recommendation Q.1950 [23] (see 3GPP TS 29.205 [7]). + +## 14.2.31 TFO Activation + +When the procedure "TFO activation" is required the following procedure is initiated: + +The MGC sends a ADD.req, MOD.req or MOV.req command with the following information. + +**Table 14.2.31.1: ADD.req/MOD.req/MOV.req (TFO activation) MGC to MGW** + +| Address Information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID =
bearer1
tfoenable = tfoactvalue
If TFO codec list:
Property= TFOcodecList | | + +When the processing of command (1) is complete, the MGW initiates the following procedure. + +**Table 14.2.31.2: ADD.resp/MOD.resp/MOV.resp (TFO activation) MGW to MGC** + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
TerminationID=bearer1 | | + +## 14.2.32 Optimal Codec and Distant List\_Notify + +When the procedure "Optimal Codec and Distant List" is required the following procedure is initiated: + +The MGC sends a ADD.req, MOD.req or MOV.req command with the following information. + +**Table 14.2.32.1: ADD.req/MOD.req/MOV.req (Codec modify and distant list) MGC to MGW** + +| Address Information | Control information | Bearer information | +|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = bearer1
Property= TFOcodecList

NotificationRequested (Event ID = x, "Codec modify")
NotificationRequested (Event ID = x, "Distant List") | | + +When the processing of command (1) is complete, the MGW initiates the following procedure. + +**Table 14.2.32.2: ADD.resp/MOD.resp/MOV.resp (Optimal codec and codec list) MGW to MGC** + +| Address Information | Control information | Bearer information | +|---------------------|-----------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
TerminationID= bearer1 | | + +## 14.2.33 Codec Modify + +When the procedure "Codec Modify" is required the following procedure is initiated: + +The MGW sends a NOT.req command with the following information. + +**Table 14.2.33.1: NOT.req (Codec modify) MGW to MGC** + +| Address Information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = bearer1

Event ( Event Id = x, "codec_modify (optimalcodec)") | | + +When the processing of command (1) is complete, the MGC initiates the following procedure. + +**Table 14.2.33.2: NOT.resp (Codec modify) MGC to MGW** + +| Address Information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = bearer1 | | + +## 14.2.34 Distant Codec List + +When the procedure "Distant Codec List" is required the following procedure is initiated: + +The MGW sends a NOT.req command with the following information. + +**Table 14.2.34.1: NOT.req (Distant codec list) MGW to MGC** + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = bearer1

Event(Event ID = x, " distant_codec_list(distlist) ") | | + +When the processing of command (1) is complete, the MGC initiates the following procedure. + +**Table 14.2.34.2: NOT.resp (Distant codec list) MGC to MGW** + +| Address Information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = bearer1 | | + +## 14.2.35 Command Rejected + +When the procedure "Command Reject" is required the following procedure is initiated: + +The MGW/MGC sends .resp to any command.req with the following information. + +**Table 14.2.34.1: NYcommand.resp (command reject ) GW/MGC to MGC/MGW** + +| Address Information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1 or no context

Reason=Error | | + +## 14.2.36 Modify Bearer Characteristics + +This procedure is the same as that defined in the subclause "Modify Char" in ITU-T Recommendation Q.1950 [23] (see 3GPP TS 29.205 [7]) with additions as shown below. + +**Table 14.2.36.1: Modify bearer Characteristics additions** + +| Address Information | Control information | Bearer information | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | If framing protocol used:

UP mode = mode
UPversion =version
Delivery of erroneous SDUs=value
Interface=interface

If support mode:
Initdirection=initdir

If data call and Non-Anchor MGW RAN-side termination:
Bitrate = bitrate (NOTE1)
If indication on Protocol Negotiation
Result requested:
NotificationRequested (Event ID = x, "Prot Negotiation Result")

If indication on Rate Change requested:
NotificationRequested (Event ID = x, "RateChange") | If SCUDIF multimedia call and (network termination or Anchor MGW Access Termination):
MuMe codec (NOTE 2)

If data call other than SCUDIF multimedia call and (Anchor MGW Access Termination or Anchor MGW Network Termination):

PLMN bearer capability = PLMN capability (NOTE3)

If GSM data call other than SCUDIF multimedia call and Anchor MGW Network Termination:
GSM channel coding=coding | +| NOTE1 : Bearer Service Characteristics shall be excluded when this property is included except for the case when bitrate = 64000 and then Bearer Service Characteristics may be included. Bitrate is optional for transparent data calls when the data rate is 64k bits/s.
NOTE2: Bearer Service Characteristics shall be excluded when this property is included.
NOTE3: Bearer Service Characteristics shall be excluded when this property is included, except for Anchor MGW network termination for which it may be included. | | | + +If the "Modify Bearer Characteristics" procedure contains a codec that is not currently in use at the Termination when it receives this procedure, and if the framing protocol is used in support mode, the MGW shall be prepared to handle a framing protocol initialisation. If the "Modify Bearer Characteristics" contains no codec or the codec that is already in use at the Termination when it receives this procedure, the MGW does not need to be prepared to handle a framing protocol initialisation. + +## 14.2.37 Protocol Negotiation Result + +When the procedure "Protocol Negotiation Result" is required the following procedure is initiated: + +The MGW sends a NOT.req command with the following information. + +**Table 14.2.37.1: NOT.req (Protocol negotiation result) MGW to MGC** + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = bearer1

Event (Event ID = x, " protres (Result,Cause)") | | + +When the processing of command (1) is complete, the MGC initiates the following procedure. + +**Table 14.2.37.2: NOT.resp (Protocol negotiation result) MGC to MGW** + +| Address Information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = bearer1 | | + +## 14.2.38 Rate Change + +When the procedure "Rate Change" is required the following procedure is initiated: + +The MGW sends a NOT.req command with the following information. + +**Table 14.2.38.1: NOT.req (Rate change) MGW to MGC** + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = bearer1

Event (Event ID = x, "ratechg(rate)") | | + +When the processing of command (1) is complete, the MGC initiates the following procedure. + +**Table 14.2.38.2: NOT.resp (Rate change) MGC to MGW** + +| Address Information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = bearer1 | | + +## 14.2.39 Bearer Modification Support + +When the procedure "Bearer Modification Support" is required, the following procedure is initiated: + +The MGW sends a NOT.req command with the following information to indicate that the bearer can be modified. + +**Table 14.2.39.1: NOT.req (Bearer Modification Support) MGW to MGC** + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = bearer1

Event (Event ID = x, "mod_link_supp") | | + +When the processing of command (1) is complete, the MGC initiates the following procedure. + +**Table 14.2.39.2: NOT.resp (Bearer Modification Support) MGC to MGW** + +| Address Information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = bearer1 | | + +## 14.2.40 CTM report + +When the procedure "CTM report" is required the following procedure is initiated: + +The MGW sends a NOT.req command with the following information. + +**Table 14.2.40.1: NOT.req (CTM report) MGW to MGC** + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = bearer1

Event (Event ID = x, "connchange (connchnge
") | | + +When the processing of command (1) is complete, the MGC initiates the following procedure. + +**Table 14.2.40.2: NOT.resp (CTM report) MGC to MGW** + +| Address Information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = bearer1 | | + +## 14.2.41 Prepare IP transport + +This procedure is activated when the "Prepare IP transport" procedure is initiated. + +An ADD.req command is sent with the following information. + +**Table 14.2.41.1: ADD.req (Prepare IP transport) MGC to MGW** + +| Address Information | Control information | Bearer information | +|-------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Local Descriptor {
lu IP Address
= ?
lu IP Port = ?
} | Transaction ID = z
Termination ID = ?
Logical Port ID = y
If Context Requested:
Context ID = ?
If Context Provided:
Context ID = c1

UP mode = mode
UP version = version
Delivery of erroneous SDUs = value
Interface = interface

If support mode:
Initdirection = initdir

If CTM call and Access Termination:
State= ctmstate
Transport= ctmtransport
Version= ctmtext version
If data call and Non-Anchor MGW RAN-side termination:
Bitrate = bitrate (NOTE1)

If indication of BNC Established requested:
Notification_Requested (Event ID = x, "BNC Connected")

If indication of BNC Release requested:
Notification_Requested (Event ID = x, "BNC Release (Cause)")

If indication of BNC Modified requested:
Notification_Requested (Event ID = x, "BNC Modified")

If indication of BNC Mod Failed requested:
Notification_Requested (Event ID = x, "BNC Mod Failed")

(all bearer change notifications as defined in ITU-T Recommendation Q.1950 [23])

If multiple IP realms:
IP realm Identifier = required IP realm identifier

NotificationRequested (Event ID = x, "termination heartbeat") | If SCUDIF multimedia call and Anchor MGW Access Termination:
MuMe codec (NOTE 2)

If data call other than SCUDIF multimedia call, Anchor MGW Access Termination:
PLMN bearer capability = PLMN capability (NOTE2)

If data call and Non-Anchor RAN termination:
Bearer Service Characteristics (NOTE 1)

If speech call, Access Termination: Codec

Bearer Characteristics = "IP" | + +NOTE1 : Bearer Service Characteristics shall be excluded when this property is included except for the case when bitrate = 64000 and then Bearer Service Characteristics may be included. Bitrate is optional for transparent data calls when the data rate is 64k bits/s.. + +NOTE2: Bearer Service Characteristics shall be excluded when this property is included. + +When the processing of command (1) is complete, the MGW initiates the following procedure. + +**Table 14.2.41.2: ADD.resp (Prepare IP transport) MGW to MGC** + +| Address Information | Control information | Bearer information | +|------------------------------------------------------------------------------|-------------------------------------------------------------------|--------------------| +| Local Descriptor {
lu IP Address = IPaddress
lu IP Port = UDPport
} | Transaction ID = z
Context ID = c1
Termination ID = bearer1 | | + +## 14.2.42 Modify IP transport address + +This procedure is activated when the "Modify IP transport address" procedure is initiated. + +A MOD.req command is sent with the following information. + +**Table 14.2.42.1: MOD.req (Modify IP transport address) MSC to MGW** + +| Address Information | Control information | Bearer information | +|-------------------------------------------------------------------------------|-------------------------------------------------------------------|--------------------| +| Remote Descriptor {
lu IP Address = IPaddress
lu IP Port = UDPport
} | Transaction ID = z
Context ID = c1
Termination ID = bearer1 | | + +When the processing of command (1) is complete, the MGW initiates the following procedure. + +**Table 14.2.42.2: MOD.resp (Modify Ip transport address) MGW to MGC** + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
TerminationID=bearer1 | | + +## 14.2.43 Reserve Bearer Characteristics + +This procedure is the same as that defined in the subclause "Reserve Char" in ITU-T Recommendation Q.1950 [23] (see 3GPP TS 29.205 [7]) with additions as shown below. + +**Table 14.2.43.1: Reserve Bearer Characteristics additions** + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | If framing protocol used:

UP mode = mode
UPversion =version
Delivery of erroneous
SDUs=value
Interface=interface
Initdirection=initdirection | | + +If the "Reserve Bearer Characteristics" procedure contains a codec that is not currently in use at the Termination when it receives this procedure, and if the framing protocol is used in support mode, the MGW shall be prepared to handle a framing protocol initialisation. If the "Reserve Bearer Characteristics" contains no codec or the codec that is already in use at the Termination when it receives this procedure, the MGW does not need to be prepared to handle a framing protocol initialisation. + +## 14.2.44 Confirm Bearer Characteristics + +This procedure is the same as that defined in the subclause "Confirm Char" in ITU-T Recommendation Q.1950 [23] (see 3GPP TS 29.205 [7]) with additions as shown below. + +**Table 14.2.44: Confirm Bearer Characteristics additions** + +| Address Information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | If framing protocol used:

UP mode = mode
UPversion =version
Delivery of erroneous SDUs=value
Interface=interface
Initdirerection=initdirection | | + +If the "Confirm Bearer Characteristics" procedure contains a codec that is not currently in use at the Termination when it receives this procedure, and if the framing protocol is used in support mode, the MGW shall be prepared to handle a framing protocol initialisation. If the "Confirm Bearer Characteristics" contains no codec or the codec that is already in use at the Termination when it receives this procedure, the MGW does not need to be prepared to handle a framing protocol initialisation. + +## 14.2.45 Trace activation/deactivation + +This procedure is activated when the "Trace activation/deactivation" procedure is initiated. + +An ADD.req command is sent with the following information. + +**Table 14.2.45.1: ADD.req/MOD.req (Trace activation/deactivation) MGC to MGW** + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Termination ID = bearer1

Context ID = c1

Trace Reference
Trace Recording Session Reference
Trace Depth
Triggering events
List of interfaces

IMSI
IMEI(SV)

Trace activity control = trace activity request

If indication on Trace Activation Result requested:
NotificationRequested (Event ID = x, "Trace activation result") | | + +Upon completion of processing command (1) an ADD.resp or MOD.resp command (2) is sent. + +**Table 14.2.45.2: ADD.resp/MOD.resp/ MGW to MGC** + +| Address Information | Control information | Bearer information | +|---------------------|------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
TerminationID = bearer1 | | + +## 14.2.46 Trace Activation result notification + +When the procedure "Trace Activation result notification" is required, the following procedure is initiated: + +The MGW sends a NOT.req command with the following information to indicate the result of the trace activation. + +**Table 14.2.46.1: NOT.req (Trace Activation result Notification) MGW to MGC** + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = bearer1

Event_ID (Event ID = x, " tracact (res)") | | + +When the processing of command (1) is complete, the MGC initiates the following procedure. + +**Table 14.2.46.2: NOT.resp (Trace Activation result Notification) MGC to MGW** + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID =
bearer1 | | + +## 14.2.47 Emergency Call Indication + +This procedure is the same as that defined in the subclause " ECS\_Indication " in ITU-T Recommendation Q.1950 Annex F [23] (see 3GPP TS 29.205 [7]) with additions as shown below. + +**Table 14.2.47.1: Emergency Call Indication additions** + +| Address Information | Control information | Bearer information | +|----------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------| +| Or as per flow 14.2.4
Establish Bearer | Or as per flow 14.2.4
Establish Bearer
With the following additions:
If Context Requested & Emergency Call:
Emergency Call Indication | Or as per flow 14.2.4
Establish Bearer | +| Or as per flow 14.2.5
Prepare Bearer | | Or as per flow 14.2.5
Prepare Bearer | +| Or as per flow 14.2.12
Play Announcement | Or as per flow 14.2.5
Prepare Bearer
With the following additions:
If Context Requested & Emergency Call:
Emergency Call Indication | Or as per flow 14.2.12
Play Announcement | +| Or as per flow 14.2.18
Reserve_Circuit | | Or as per flow 14.2.18
Reserve_Circuit | +| Or as per flow 14.2.41
Prepare_IP_transport | Or as per flow 14.2.12
Play Announcement
With the following additions:
If Context Requested & Emergency Call:
Emergency Call Indication | Or as per flow 14.2.41
Prepare_IP_transport | +| Or as per flow 14.2.2
Isolate Bearer Termination | | Or as per flow 14.2.2
Isolate Bearer Termination | +| Or as per flow 14.2.3
Join Bearer Termination | Or as per flow 14.2.18
Reserve_Circuit
With the following additions:
If Context Requested & Emergency Call:
Emergency Call Indication | Or as per flow 14.2.3
Join Bearer Termination | +| Or as per flow 14.2.51
Reserve RTP Connection Point | | Or as per flow 14.2.51
Reserve RTP Connection Point | +| Or as per flow 14.2.53
Reserve and Configure RTP Connection Point | Or as per flow 14.2.41
Prepare_IP_transport
With the following additions:
If Context Requested & Emergency Call:
Emergency Call Indication | Or as per flow 14.2.53
Reserve and Configure RTP Connection Point | +| | Or as per flow 14.2.2
Isolate Bearer Termination
With the following additions:
If Context Requested & Emergency Call:
Emergency Call Indication | | +| | Or as per flow 14.2.3
Join Bearer Termination
With the following additions:
If Context Requested & Emergency Call:
Emergency Call Indication | | +| | Or as per flow 14.2.51
Reserve RTP Connection Point
With the following additions:
If Context Requested & Emergency Call:
Emergency Call Indication | | +| | Or as per flow 14.2.53
Reserve and Configure RTP Connection Point
With the following additions:
If Context Requested & Emergency Call:
Emergency Call Indication | | + +## 14.2.48 TFO status Notify + +When the procedure "TFO status notify" is required the following procedure is initiated: + +The MGC sends a ADD.req, MOD.req or MOV req. command with the following information. + +**Table 14.2.48.1: ADD.req/MOD.req/MOV.req (TFO status) MGC to MGW** + +| Address Information | Control information | Bearer information | +|---------------------|-----------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = bearer1

NotificationRequested (Event ID = x, "TFO Status") | | + +The support of the TFO status notification is optional in the TFO package. If supported, when the processing of command (1) is complete, the MGW initiates the following procedure. + +**Table 14.2.48.2: ADD.resp/MOD.resp/MOV.resp (TFO status) MGW to MGC** + +| Address Information | Control information | Bearer information | +|---------------------|-----------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
TerminationID= bearer1 | | + +Otherwise it returns an error codec to the MGC indicating that the requested event is unsupported or unknown., as specified in ITU-T Recommendation H.248.8 [14]. + +## 14.2.49 TFO Status + +When the procedure "TFO Status" is required the following procedure is initiated: + +The MGW sends a NOT.req command with the following information. + +**Table 14.2.49.1: NOT.req (TFO Status) MGW to MGC** + +| Address Information | Control information | Bearer information | +|---------------------|-----------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = bearer1

Event_ID (Event ID = x, " TFO_status(tfostatus) ") | | + +When the processing of command (1) is complete, the MGC initiates the following procedure. + +**Table 14.2.49.2: NOT.resp (TFO Status) MGC to MGW** + +| Address Information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = bearer1 | | + +## 14.2.50 Termination heartbeat indication + +When the procedure "Termination heartbeat indication" is required the following procedure is initiated: the MGW sends a NOT.req command with the following information. + +**Table 14.2.50.1: NOT.req (Termination heartbeat) MGW to MGC** + +| Address Information | Control information | Bearer information | +|---------------------|------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = bearer1

Event_ID (Event ID = x,
"termination heartbeat") | | + +When the processing of command is complete, the MGC initiates the following procedure. + +**Table 14.2.50.2: NOT.resp (Termination heartbeat) MGC to MGW** + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID =
bearer1 | | + +The heartbeat timer shall be configured to a value much greater than the mean call holding time. + +The MSC-S is in charge of correcting any detected mismatch, by subtracting hanging terminations or clearing hanging contexts. + +## 14.2.51 Reserve RTP Connection Point + +This procedure is used to reserve an RTP bearer termination for a SIP-I associated Nb user plane, as defined in 3GPP TS 29.414 [32], or for a A interface over IP termination, as defined in 3GPP TS 3GPP TS 48.103 [65]. When the procedure "Reserve RTP Connection Point" is required the following procedure is initiated. + +The MGC sends an ADD.req command with the following information. + +**Table 14.2.51.1: ADD.req (Reserve RTP Connection Point Request) MGC to MGW** + +| Address Information | Control information | Bearer information | +|------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Local Descriptor {
Port = ?
IP Address = ?
IP Version = IPv4 or IPv6
} | Transaction ID = z
Termination ID = ?

If Context Requested:
Context ID = ?

If MPS call/session:
Priority Indicator = x

If Context Provided:
Context ID = c1

If IP Interface Type:
IP interface = "IP interface type"

If CTM call and Access Termination:
State= ctmstate
Transport= ctmtransport
Version= ctmtext version

If Resources for multiple Codecs shall be reserved:
Reserve_Value

NotificationRequested (Event ID = x, "termination heartbeat")

If indication on Bearer Released requested:
NotificationRequested (Event ID = x, "BNC Release (Cause)") – as defined in ITU-T Recommendation Q.1950

If multiple IP realms: IP realm Identifier = required IP realm identifier

If indication on Protocol Negotiation Result requested:
NotificationRequested (Event ID = x, "Prot Negotiation Result")

If indication on Rate Change requested:
NotificationRequested (Event ID = x, "RateChange")

If access termination and notification on CTM negotiation result requested:
NotificationRequested (Event ID = x, "connchange ")

If access termination and Listener context: number of desired listener context terminations = required listener context terminations
If diffserv required (NOTE 1):-
Diffserv Code Point
If tagging behaviour
Diffserv Tagging Behaviour

If Remote Source Address Filtering required (NOTE 1):-
Remote Source Address Filtering
If Remote Source Address range required:-
Remote Source Address Mask
If Remote Source Port Filtering required:-
Remote Source Port Filtering
If individual port:-
Remote Source Port
If range of ports: | Local Descriptor {
Codec List
RTP Payloads
RtcpbwRS
RtcpbwRR

If ICE is applied:
ICE host candidate request
ICE password request
ICE Ufrag request

If SDPCapNeg is signalled to the gateway:
SDPCapNeg configuration

}

If data call other than SCUDIF multimedia call and if Access Termination or Anchor MGW Network Termination:
PLMN bearer capability =
PLMN capability

If GSM data call other than SCUDIF multimedia call and if Access Termination or Anchor MGW Network Termination:
GSM channel coding = coding | + +| | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| |

Remote Source Port Range

If Media Inactivity Detection Required (NOTE 1):
NotificationRequested (Event ID = x, "Media Inactivity Detection (Media Inactivity Detection Time, Media Inactivity Detection Direction) ") (NOTE 2)

If Sustainable Data Rate Policing Required (NOTE 1):-
Policing Required
Sustainable Data Rate
Maximum Burst Size

If peak data rate policing (NOTE 1)
Policing Required
Peak Data Rate
If Delay Variation required
Delay Variation Tolerance

If RTCP handling required (NOTE 1):
RTCP allocation

If ECN Endpoint support required
ECN Enable = "True"
Initiation Method = "ECN Initiation Method"

If notification of ECN Failure
Report:
NotificationRequested (Event ID = x, "ECN Failure")

If ICE is applied:
STUN server request

| | +| NOTE 1: Only for terminations with border control functions support.
NOTE 2: The event parameters "Media Inactivity Detection Time" and "Media Inactivity Detection Direction" are optional. | | | + +When the processing of command (1) is complete, the MGW initiates the following procedure. + +**Table 14.2.51.2: ADD.resp (Reserve RTP Connection Point Acknowledge) MGW to MGC** + +| Address Information | Control information | Bearer information | +|-------------------------------------------------------------|------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Local Descriptor {
Port
IP Address
IP Version
} | Transaction ID
Termination ID
Context ID | Local Descriptor {
Codec List
RTP Payloads
RtcpbwRS
RtcpbwRR

If ICE is applied:
ICE host candidate
ICE password
ICE Ufrag
If ICE lite implementation
ICE lite indication

If SDPCapNeg is signalled to the gateway:
SDPCapNeg configuration
} | + +## 14.2.52 Configure RTP Connection Point + +This procedure is used to configure or reconfigure an RTP bearer termination for a SIP-I associated Nb user plane, as defined in 3GPP TS 29.414 [32], or for a A interface over IP termination, as defined in 3GPP TS 48.103 [65]. + +When the procedure "Configure RTP Connection Point" is required the following procedure is initiated: + +The MGC sends an MOD.req command with the following information. + +**Table 14.2.52.1: MOD.req (Configure RTP Connection Point Request) MGC to MGW** + +| Address Information | Control information | Bearer information | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| If local resources are modified:
Local Descriptor {
Port
IP Address
IP Version
}
If remote resources are modified:
Remote Descriptor {
Port
IP Address
IP Version
} | Transaction ID
Termination ID
Context ID

If IP Interface Type:
IP interface = "IP interface type"
(NOTE 1)

If Resources for multiple Codecs shall be reserved:
Reserve_Value

If CTM call and Access Termination:
State= ctmstate
Transport= ctmtransport
Version= ctmtext version

If indication on Protocol Negotiation Result requested:
NotificationRequested (Event ID = x, "Prot Negotiation Result")

If indication on Rate Change requested:
NotificationRequested (Event ID = x, "RateChange")

If access termination and notification on CTM negotiation result requested:
NotificationRequested (Event ID = x, " connchange ")

If access termination and Listener context: number of desired listener context terminations = required listener context terminations

If diffserv required (NOTE 2):-
Diffserv Code Point
If tagging behaviour
Diffserv Tagging Behaviour

If Remote Source Address Filtering required (NOTE 2):
Remote Source Address Filtering
If Remote Source Address range required:-
Remote Source Address Mask
If Remote Source Port Filtering required:-
Remote Source Port Filtering
If individual port:-
Remote Source Port
If range of ports:
Remote Source Port Range

If Media Inactivity Detection Required (NOTE 2):
NotificationRequested (Event ID = x, "Media Inactivity Detection (Media Inactivity Detection Time, Media Inactivity Detection Direction) ")
(NOTE 3)

If Sustainable Data Rate Policing Required (NOTE 2):-
Policing Required
Sustainable Data Rate
Maximum Burst Size

If peak data rate policing (NOTE 2)
Policing Required
Peak Data Rate
If Delay Variation required
Delay Variation Tolerance | If local resources are modified:
Local Descriptor {
Codec List
RTP Payloads
RtcpbwRS
RtcpbwRR

If SDPCapNeg is signalled to the gateway:
SDPCapNeg configuration
}
If remote resources are modified:
Remote Descriptor {
Codec List
RTP Payloads
RtcpbwRS
RtcpbwRR

If RTCP APP messages allowed
Allowed RTCP APP message types

If ICE is applied:
ICE received candidate
ICE received password
ICE received Ufrag
(NOTE 4)

If SDPCapNeg is signalled to the gateway:
SDPCapNeg configuration
}

If data call other than SCUDIF multimedia call and if Access Termination or Anchor MGW Network Termination:
PLMN bearer capability = PLMN capability

If GSM data call other than SCUDIF multimedia call and if Access Termination or Anchor MGW Network Termination:
GSM channel coding = coding | + +| | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| |

If RTCP handling required (NOTE 2):
RTCP allocation

If ECN Endpoint support required
ECN Enable = "True"
Initiation Method = "ECN Initiation Method"

If notification of ECN Failure
Report:
NotificationRequested (Event ID
= x,"ECN Failure")

| | +|

NOTE 1: If this property is included within the Reserve Connection Point procedure or the Reserve and Configure RTP Connection Point then it shall not be modified by this procedure.
NOTE 2: Only for terminations with border control functions support.
NOTE 3: The event parameters "Media Inactivity Detection Time" and "Media Inactivity Detection Direction" are optional.
NOTE 4: The support of ICE received candidate, ICE received password, ICE received Ufrag are optional for ICE lite, as specified in 3GPP TS 29.292 [60].

| | | + +When the processing of command (1) is complete, the MGW initiates the following procedure. + +**Table 14.2.52.2: MOD.resp (Configure RTP Connection Point Acknowledge) MGW to MGC** + +| Address Information | Control information | Bearer information | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +|

If local resources were provided in request:
Local Descriptor {
Port
IP Address
IP Version
}
If remote resources were provided in request:
Remote Descriptor {
Port
IP Address
IP Version
} NOTE

|

Transaction ID
Context ID
Termination ID

|

If local resources were provided in request:
Local Descriptor {
Codec List
RTP Payloads
RtcpbwRS
RtcpbwRR
}
If remote resources were provided in request:
Remote Descriptor {
Codec List
RTP Payloads
RtcpbwRS
RtcpbwRR
} NOTE

| +| NOTE: Sending of the Remote Descriptor is optional | | | + +## 14.2.53 Reserve and Configure RTP Connection Point + +This procedure is used to reserve and configure an RTP bearer termination for a SIP-I associated Nb user plane, as defined in 3GPP TS 29.414 [32], or for a A interface over IP termination, as defined in 3GPP TS 48.103 [65]. + +When the procedure "Reserve and Configure RTP Connection Point" is required the following procedure is initiated: + +The MGC sends a ADD.req command with the following information. + +**Table 14.2.53.1: ADD.req (Reserve and Configure RTP Connection Point Request) MGC to MGW** + +| Address Information | Control information | Bearer information | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Local Descriptor {
Port = ?
IP Address = ?
IP Version = IPv4 or IPv6
}
Remote Descriptor {
Port
IP Address
IP Version = IPv4 or IPv6
} | Transaction ID
Termination ID = ?

If Context Requested:
Context ID = ?

If MPS call/session:
Priority Indicator = x

If Context Provided:
Context ID = c1

If IP Interface Type:
IP interface = "IP interface type"

If Resources for multiple Codecs shall be reserved:
Reserve_Value

If CTM call and Access Termination:
State= ctmstate
Transport= ctmtransport
Version= ctmtext version

NotificationRequested (Event ID = x, "termination heartbeat")

If indication on Bearer Released requested:
NotificationRequested (Event ID = x, "BNC Release (Cause)") – as defined in ITU-T Recommendation Q.1950

If multiple IP realms: IP realm Identifier = required IP realm identifier

If indication on Protocol Negotiation Result requested:
NotificationRequested (Event ID = x, "Prot Negotiation Result")

If indication on Rate Change requested:
NotificationRequested (Event ID = x, "RateChange")

If access termination and notification on CTM negotiation result requested:
NotificationRequested (Event ID = x, " connchange ")

If diffserv required (NOTE 1):-
Diffserv Code Point
If tagging behaviour
Diffserv Tagging Behaviour

If Remote Source Address Filtering required (NOTE 1):-
Remote Source Address Filtering
If Remote Source Address range required:-
Remote Source Address Mask
If Remote Source Port Filtering required:-
Remote Source Port Filtering
If individual port:-
Remote Source Port
If range of ports:
Remote Source Port Range

If Media Inactivity Detection Required (NOTE 1):
NotificationRequested (Event ID = x, "Media Inactivity Detection (Media Inactivity Detection Time, Media Inactivity Detection Direction) ") (NOTE2) | Local Descriptor {
Codec List
RTP Payloads
RtcpbwRS
RtcpbwRR

If ICE is applied:
ICE host candidate request
ICE password request
ICE Ufrag request

If SDPCapNeg is signalled to the gateway:
SDPCapNeg configuration
}
Remote Descriptor {
Codec List
RTP Payloads
RtcpbwRS
RtcpbwRR

If RTCP APP messages allowed
Allowed RTCP APP message types

If ICE is applied:
ICE received candidate
ICE received password
ICE received Ufrag
(NOTE 3)

If SDPCapNeg is signalled to the gateway:
SDPCapNeg configuration
}

If data call other than SCUDIF multimedia call and Anchor MGW Network Termination:
PLMN bearer capability =
PLMN capability

If GSM data call other than SCUDIF multimedia call and Anchor MGW Network Termination:
GSM channel coding = coding | + +| | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| |

If Sustainable Data Rate Policing Required (NOTE 1):-
Policing Required
Sustainable Data Rate
Maximum Burst Size

If peak data rate policing (NOTE 1)
Policing Required
Peak Data Rate
If Delay Variation required
Delay Variation Tolerance

If RTCP handling required (NOTE 1):
RTCP allocation

If ECN Endpoint support required
ECN Enable = "True"
Initiation Method = "ECN Initiation Method"

If notification of ECN Failure
Report:
NotificationRequested (Event ID
= x,"ECN Failure")

| | +| NOTE 1: Only for terminations with border control functions support. | | | +| NOTE 2: The event parameters "Media Inactivity Detection Time" and "Media Inactivity Detection Direction" are optional. | | | +| NOTE 3: The support of ICE received candidate, ICE received password, ICE received Ufrag are optional for ICE lite, as specified in 3GPP TS 29.292 [60]. | | | + +When the processing of command (1) is complete, the MGW initiates the following procedure. + +**Table 14.2.53.2: ADD.resp(Reserve and Configure RTP Connection Point Acknowledge) MGW to MGC** + +| Address Information | Control information | Bearer information | +|----------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Local Descriptor {
Port
IP Address
IP Version
}
Remote Descriptor {
Port
IP Address
IP Version
} NOTE | Transaction ID
Termination ID
Context ID | Local Descriptor {
Codec List
RTP Payloads
RtcpbwRS
RtcpbwRR

If ICE is applied:
ICE host candidate
ICE password
ICE Ufrag
If ICE lite implementation
ICE lite indication

If SDPCapNeg is signalled to the gateway:
SDPCapNeg configuration
}
Remote Descriptor {
Codec List
RTP Payloads
RtcpbwRS
RtcpbwRR

If SDPCapNeg is signalled to the gateway:
SDPCapNeg configuration
} NOTE | +| NOTE: Sending of the Remote Descriptor is optional | | | + +Editor's note: The usage of the Call Type Discrimination IE and Text Telephony IE is ffs. + +## 14.2.54 ECN Failure Indication + +The MGW sends a NOTIFY request command as in Table 14.2.54.1. + +**Table 14.2.54.1: ECN Failure Indication** + +| Address Information | Control information | Bearer information | +|---------------------|---------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID= C1
Termination ID = T1

Event_ID (Event ID = x,
"ECN Failure (ECN Failure Type)") | | + +The MGC responds as in Table 14.2.54.2 + +**Table 14.2.54.2: ECN Failure Indication Ack** + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +## 14.2.55 Media Inactivity Notification + +When the procedure "Media Inactivity Notification" is required the following procedure is initiated: the MGW sends a NOT.req command with the following information. + +**14.2.55.1 NOT.req (Media Inactivity) MGW to MGC** + +| Address Information | Control information | Bearer information | +|---------------------|------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1

Event_ID (Event ID = x, "Media
Inactivity Detection") | | + +When the processing of command is complete, the MGC initiates the following procedure. + +**14.2.55.2 NOT.resp (Media Inactivity) MGC to MGW** + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +## 14.2.56 ICE Connectivity Check Result Notification + +The MGW sends a NOTIFY request command as defined in Table 14.2.56.1. + +**Table 14.2.56.1: ICE Connectivity Check Result Notification** + +| Address Information | Control information | Bearer information | +|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID= C1
Termination ID = T1

Event_ID (Event ID = x,
" Connectivity Check Result
(Candidate/Transport Pair)") | | + +The MSC Server responds as defined in Table 14.2.56.2 + +**Table 14.2.56.2: ICE Connectivity Check Result Notification Ack** + +| Address Information | Control information | Bearer information | +|----------------------------|--------------------------------------------------------------|---------------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +## 14.2.57 ICE New Peer Reflexive Candidate Notification + +The MGW sends a NOTIFY request command as defined in Table 14.2.57.1. + +**Table 14.2.57.1: ICE New Peer Reflexive Candidate Notification** + +| Address Information | Control information | Bearer information | +|----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|---------------------------| +| | Transaction ID = x
Context ID= C1
Termination ID = T1

Event_ID (Event ID = x,
" New Peer Reflexive Candidate
(Candidate)") | | + +The MSC Server responds as defined in Table 14.2.57.2 + +**Table 14.2.57.2: ICE New Peer Reflexive Candidate Ack** + +| Address Information | Control information | Bearer information | +|----------------------------|--------------------------------------------------------------|---------------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +## 15 UMTS packages + +### 15.1 Mandatory UMTS packages + +The following package shall be supported for the UMTS Bearer Independent Circuit-Switched Core Network: + +- 3GUP (User Plane) package (see subclause 15.1.1). + +#### 15.1.1 3GUP package. + +PackageID: threegup (0x002f) + +Version: 1 + +Extends: None + +This package identifies that the User Plane package is used for the termination. It also contains some parameters for the User Plane functions in the MGW. + +The UP Protocol operates independently of the stream mode property, i.e. type 14 UP PDUs (which are used for inband UP signalling) can be transported between UP peers, irrespective of the stream mode direction. However, other types of UP PDUs shall be handled according to the stream mode property. + +##### 15.1.1.1 Properties + +UP Mode of operation: + +PropertyID: mode (0x0001). + +Description: Defines the mode of operation of the User Plane functions , for further definitions see 3GPP TS 25.415 [4] and 29.415 [8]. + +Type: Enumeration. + +Possible Values: + +- "Trans" (0x0001) Transparent mode. +- "Supp" (0x0002) Support mode for predefined SDU sizes. + +Default: "Trans" (0x0001) Transparent mode. + +Defined in: Local Control descriptor. + +Characteristics: Read/Write. + +UP versions: + +PropertyID: upversions (0x0002). + +Description: Defines the required versions of the UP mode of operation. + +Type: Sub-list of enumeration. + +Possible Values: + +- "1" (0x01) Version 1. +- "2" (0x02) Version 2. +- "3" (0x03) Version 3. +- "4" (0x04) Version 4. +- "5" (0x05) Version 5. + +- "6" (0x06) Version 6. +- "7" (0x07) Version 7. +- "8" (0x08) Version 8. +- "9" (0x09) Version 9. +- "10" (0x0A) Version 10. +- "11" (0x0B) Version 11. +- "12" (0x0C) Version 12. +- "13" (0x0D) Version 13. +- "14" (0x0E) Version 14. +- "15" (0x0F) Version 15. +- "16" (0x10) Version 16. +- Default: "1" (0x01) Version 1. + +Defined in: Local Control descriptor. + +Characteristics: Read/Write. + +Delivery of erroneous SDUs: + +PropertyID: delerrsdu (0x0003). + +Description: Indicates how erroneous SDUs should be handled. If it is set to YES then the UP entity implements error checking and sets Frame Quality Classification (FQC) bits accordingly; bad frames are delivered to the UP layer. If it is set to NO then the UP entity performs error checking and if a bad frame is detected then it is discarded. These settings are required only when the payload is to be examined by upper layer services; an MGW may ignore the settings of this parameter if it passes frames transparently through the UP entities. If it is set to NA then no checking is performed. + +Type: Enumeration. + +Possible Values: + +- "Yes" (0x0001) Yes. +- "No" (0x0002) No. +- "NA" (0x0003) Not Applicable. + +Default: "NA" (0x0003) Not Applicable. + +Defined in: Local Control descriptor. + +Characteristics: Read/Write. + +Interface: + +PropertyID: interface (0x0004). + +Description: Indicates the type of interface on which the termination is used. + +Type: Enumeration. + +Possible Values: + +- "RAN" (0x0001) Iu interface. +- "CN" (0x0002) Nb interface. + +Defined in: Local Control descriptor. + +Characteristics: Read/Write. + +Initialisation Direction: + +PropertyID: initdir (0x0005). + +Description: Indicates whether or not the termination in the MGW should expect initialisation information, or initiate UP initialisation itself. + +For a termination with property "interface = CN": + +- If Initialisation Direction is set to Incoming then the MGW shall expect to receive an initialisation either at this termination or from an other Nb or Iu termination in the same context. +- If Initialisation Direction is set to outgoing, then the MGW shall send out an initialisation procedure from this termination. If another termination in the same context is initialised with the same codec type and configuration the MGW should re-use the RFCI values for its Initialisation PDU, otherwise it must assign its own values. + +For a termination with property "interface = RAN": + +- If Initialisation Direction is set to "incoming", then the initialisation received at this termination is from the originating RAN and can be forwarded internally to other terminations for subsequent UP initialisations. +- If Initialisation Direction is set to "outgoing", then initialisations received are from the terminating RAN and cannot be forwarded internally. RFCI value correction can be performed at this termination, and initialisations can be sent out to the RAN. + +Examples for the usage of this property are given in annex B. + +Type: Enumeration. + +Possible Values: + +- "In" (0x0001) Incoming. +- "Out" (0x0002) Outgoing. + +Defined in: Local Control descriptor. + +Characteristics: Read/Write. + +### 15.1.1.2 Events + +None. + +### 15.1.1.3 Signals + +None. + +### 15.1.1.4 Statistics + +None. + +### 15.1.1.5 Procedures + +The MGC uses this package to indicate to the MGW that the Iu (or Nb) User Plane is used between the RNC (or distant MGW) and the MGW. The package is sent in the Establish bearer, Modify Bearer Characteristics and Prepare bearer procedures. For more information on the User Plane and for a description of 'UP mode of operation', 'UP versions' and 'Delivery of erroneous SDUs' see 3GPP TS 25.415 [4]. + +The following procedures are valid for UP in Support Mode: + +- The MGW shall be able to initiate and respond to the UP control procedures (PDU type 14 frames) independently of the Stream Mode during the call establishment phase, i.e. when not in TrFO. + +- Otherwise, during TrFO the MGW shall be able to forward UP control procedures (PDU type 14 frames) received at one termination to the other termination. +- The UP Initialisation procedure is always acknowledged between MGW peers. If an MGW receives a request for a notification for the bearer establishment then the MGW shall not send the notification until after it has either sent or received the acknowledgement for the UP initialisation. +- The MGW shall always store RFCI parameters against the MGW termination that received or that sent the UP initialisation. +- If an MGW has the UP termination property Initialisation Direction = Incoming then it expects to either receive an Initialisation (externally) or after receiving initialisation information internally send an initialisation (externally), based on what occurs first. +- If an MGW has UP termination property Initialisation Direction = Outgoing and interface CN, then it generates a network originated Initialisation PDU as soon as the bearer towards the succeeding node is successfully established, with RFCIs corresponding to the last codec configured on the termination. If another termination in the same context is initialised with the same codec type and configuration the MGW should re-use the RFCI values for its Initialisation PDU, otherwise it must assign its own values. The initialisation information sent by the MGW depends on the service that the bearer supports. For CSD service see 3GPP TS 29.007 [6] chapter 11.5. For speech service see 3GPP TS 26.102 [26] chapter 8. +- If an MGW has UP termination property Initialisation Direction = Outgoing and interface RAN, then it expects to receive an Initialisation externally. It shall not pass the initialisation parameters internally. It may initiate RFCI Value Correction out from this termination. +- A CN incoming or outgoing termination having already completed its UP initialisation towards a peer MGW shall not send externally any new UP initialisation except if a reserve / modify characteristic procedure occurred on that termination since the last initialisation. +- RAN Outgoing termination may perform, during its lifetime, subsequent RFCI Value corrections, e.g. due to changes of RFCIs on other terminations. +- If an MGW has two terminations in the same context defined as supporting the UP package and with Initialisation Direction incoming, then when it receives an Initialisation procedure from one side (provided the bearer connection from the other termination to its peer MGW is established) it shall start the UP initialisation procedure towards the peer MGW. The MGW shall perform this procedure independently of the through-connection of the terminations in the context. The MGW shall relay control information from the first initialisation to the UP peer for use at the subsequent initialisation. Also, subsequent control procedures received on one UP shall be relayed to the other UP entity when the two UP entities are connected within the MGW. This behaviour is described in more detail in Annex A. - When adding a new CN incoming termination to a context that has already a RAN or CN incoming termination, if the existing termination has already completed its UP initialisation, the MGW shall not start an initialisation procedure on the new termination based on the control information already stored at the initialised incoming termination in the context. +- If an MGW has one termination with properties "interface = RAN" and "initialisation direction = outgoing" and another termination with property "initialisation direction = Incoming" in the same context, then the MGW shall not forward the UP initialisation from the Incoming termination until it has received a UP initialisation at the "RAN"/"outgoing" side. If the codec type and codec modes configured on both terminations are identical, and if the RFCI values stored at the "incoming" termination do not match the RFCI values stored at the "outgoing" RAN side then "RFCI Value Correction" may be performed to the "outgoing" RAN side: The MGW starts UP initialisation with the RFCI values 'relayed' from the "Incoming" side. No "RFCI Value Correction" is permitted at an outgoing RAN termination whose Iu initialisation negotiates the version 1 of the support mode, at an "incoming" Iu termination or at any Nb termination. +- If a new RAN outgoing termination is added to a context that has already a RAN incoming or CN incoming termination, and if the existing termination has already completed its UP initialisation, the MGW may carry out a RFCI value correction on the new RAN outgoing termination., The control information to be used for the RFCI value correction shall be relayed from the initialised incoming termination in the context. +- No RFCI value correction shall be triggered for data call. +- As an implementation option, "RFCI Value Correction" may be delayed if terminations are not through-connected; it will be triggered by connection modification. Otherwise it shall be performed immediately + +- If "RFCI Value Correction" is not performed the MGW shall map the indexes for frames from one side to the RFCI indexes for frames from the other side. This behaviour is described in more detail in Annex A. +- If an MGW has two RAN terminations connected to the same context then the "RFCI Value Correction" is performed by the Outgoing termination. +- If an MGW has two terminations which support the UP package connected to the same context and both RFCI sets match then the MGW may pass frames transparently through the UP entities; no monitoring of the frames is performed, provided that the terminations are through-connected. This behaviour is described further in Annex A. +- If the MGW is passing frames transparently, no UP monitoring is performed. When the MGW receives an H.248 procedure request which requires interpretation or interaction with the UP, then it shall resume its UP protocol responsibilities, i.e. perform monitoring or termination of the UP protocol. +- If an MGW sends an FP UP initialization message from a termination, the MGW shall only offer versions of the FP UP, which are given in the property "UP versions" of this termination and which are supported by the MGW for this termination. +- If an MGW receives an FP UP initialization message at a termination, the MGW shall only positively acknowledge this initialization message, if versions of the FP UP are offered, which are given in the property "UP versions" and which are supported at the MGW for this termination. In the positive FP UP initialization acknowledge message, the MGW shall select one of these versions. If none of these versions are offered in the FP UP initialization message, the MGW shall send a negative FP UP acknowledge message and it shall not forward the initialization to a possible second FP UP termination in the same context. +- If PCM is used on the Nb then FP UP initialization shall be performed by the termination with property "Outgoing". If the termination property is "Incoming" then it shall receive the RFCI's from its IuFP peer (or from internal MGW termination with IuFP and same codec). If IuFP is defined on another termination in the MGW but the codec is different, i.e. not TrFO then the relaying of RFCI's shall not be performed. These IuFP peer connection shall be seen as completely separate. +- the UP initialisation information attached to a termination (RFCI values, codec type and mode(s), UP initialisation completed or not) are kept unchanged when the termination is moved to a new context. +- the initialisation direction may be changed during the lifetime of a termination ; upon such a change, the MGW shall apply the behaviour attached to the new initialisation direction. + +The procedures for a termination configured in UP Transparent Mode are those described in 3GPP TS 25.415 [4]. + +## 15.2 Optional UMTS packages + +The following packages may be supported by the UMTS Bearer Independent Circuit-Switched Core Network as required by the network services deployed in the network: + +- Circuit Switched Data package (see subclause 15.2.1); +- TFO package (see subclause 15.2.2); +- 3G Expanded Call Progress Tones Generator package (see subclause 15.2.3); +- Modification of Link Characteristics Bearer Capability package (see subclause 15.2.4); +- Enhanced Circuit Switched Data package (see subclause 15.2.5); +- Cellular Text telephone Modem Text Transport package (see subclause 15.2.6); +- IP transport package (see subclause 15.2.7); +- Flexible Tone Generator Package (see subclause 15.2.8); +- Trace Package (see subclause 15.2.9); +- ASCII Group Call package (see subclause 15.2.10); +- 3G Interface Type package. + +## 15.2.1 Circuit Switched Data package + +PackageID: threegcsd (0x0030) + +Version: 1 + +Extends: None + +This package contains the information needed to be able to support GSM and UMTS Circuit Switched Data from the media gateway. + +### 15.2.1.1 Properties + +PLMN BC: + +PropertyID: plmnbc (0x0001). + +Description: The PLMN Bearer Capability. + +Type: Octet string. + +Possible values: + +- Specified in the subclause "Bearer capability" in 3GPP TS 24.008 [3] , including the Bearer Capability IEI and Length. + +Defined in: Local Control Descriptor. + +Characteristics: Read/Write. + +GSM channel coding: + +PropertyID: gsmchancod (0x0002). + +Description: Channel information needed for GSM. + +Type: Octet string. + +Possible values: + +- The second octet of Chosen Channel as specified in the subclause "Chosen Channel" in 3GPP TS 48.008 [9]. + +Defined in: Local Control Descriptor. + +Characteristics: Read/Write. + +### 15.2.1.2 Events + +Protocol Negotiation Result: + +EventID: protres (0x0001). + +Description: This event is used to report the result of the protocol negotiation. + +EventsDescriptor Parameters: None. + +ObservedEventsDescriptor Parameters: + +- Negotiation Result: + - ParameterId: result (0x0001). + - Description: reports whether the protocol negotiation has been successful. + - Type: Enumeration. + - Possible Values: + +- "Success" (0x0001): the protocol negotiation on the termination has been successful. +- "Failure" (0x0000): the protocol negotiation on the termination has failed. +- Possible Failure Cause: + - ParameterId: cause (0x0002). + - Description: indicates the possible failure cause. + - Type: Enumeration. + - Possible Values: + - "Unsp" (0x0001): the protocol negotiation has failed for an unspecified reason. + - "V8V34" (0x0002): the V.8 or the V.34 protocol negotiation has failed (modem termination only). + +Rate Change: + +EventID: ratechg (0x0002). + +Description: This event is used to report a rate change. For example for GSM FAX if the detected rate does not match the channel rate the MGW shall use this to request a new channel rate. See CMM in 3GPP TS 43.045 [35]. + +EventsDescriptor Parameters: None. + +ObservedEventsDescriptor Parameters: + +- New Rate: + - ParameterId: rate (0x0001). + - Description: reports the new rate for the termination. + - Type: Integer. + - Possible Values: transmission rate in bits per second, rounded to the nearest integer value. The value must be a valid bitrate; one of the following rates: 2400, 4800, 9600, 14400, 28800, 57600. An invalid rate shall cause the call to be released by the MSC Server. + +### 15.2.1.3 Signals + +Activate Protocol: + +SignalID: actprot (0x0001). + +Description: Activate the higher layer protocol. + +Signal type: Brief. + +Duration: N/A. + +Additional parameter: + +- Local Peer Role: + - ParameterID: localpeer (0x0001). + - Type: Enumeration. + - Possible values: + - "Orig" (0x0000): originating. + - "Term" (0x0001): terminating. + +- Description: This parameter is optional, but is required for modem and fax calls. It is used to inform the modem whether it should act as originating or terminating peer. This parameter is only included within signal towards the radio access. This may either be an Access Termination or a CN Termination toward another MGW that serves the radio access. + +### 15.2.1.4 Statistics + +None. + +### 15.2.1.5 Procedures + +This package is used to set up data calls within the CS domain. For more information on the IWF, refer to 3GPP TS 29.007 [6]. + +When the Media Gateway Controller initiates the "Establish Bearer" procedure, the "Prepare Bearer" procedure, the "Modify Bearer Characteristics" procedure, the "Reserve Circuit" procedure, the "Reserve RTP Connection Point" procedure, the "Configure RTP Connection Point" procedure or the "Reserve and Configure RTP Connection Point" procedure, it shall provide the PLMN BC ("plmnb" property above) for the termination on the mobile side and the ISDN BC (standard H.248 properties, subclause "Bearer Capabilities") for the termination on the fixed side. For a mobile-to-mobile call, it shall provide the PLMN BC on both terminations. + +The presence of the PLMN BC property may trigger the use of the IWF. + +Once the bearer has been established, after B-answer, the "Activate Interworking Function" procedure is used to activate the IWF. The Activate Protocol signal ("actprot") will start the negotiation of the layer 2 protocols on both sides. If a modem or fax service is requested, the signal shall contain the Local Peer Role parameter ("localpeer"), to tell the modem whether it should act as originating or terminating peer. + +NOTE: The Activate Protocol signal is needed only after B-answer as described above or after successful in-call modification from speech to fax, to activate the protocol timers at the correct time. This is the only time when this signal is needed (specifically, the signal is not used after a handover sequence or for lawful interception). + +The IWF Protocol Indication notifications are used by the MGW to inform the MSC server about IWF protocol events. The MSC has to request the detection of the events "Protocol Negotiation Result" and "Rate Change" in the "Activate IWF" procedure, the "Establish Bearer" procedure, the "Prepare Bearer" procedure, the "Modify Bearer Characteristics" procedure, the "Reserve Circuit" procedure, the "Reserve RTP Connection Point" procedure, the "Configure RTP Connection Point" procedure or the "Reserve and Configure RTP Connection Point" procedure. + +For handover to GSM, or change of channel characteristics within the GSM network, the property GSM Channel Coding ("gsmchancod"), which contains the information about the channel type and the number of channels, shall be transmitted to the termination on the mobile side in the "Establish Bearer", the "Prepare Bearer", the "Reserve Circuit", the "Reserve RTP Connection Point", the "Configure RTP Connection Point" and the "Reserve and Configure RTP Connection Point" procedures together with the PLMN BC. The presence of the GSM Channel Coding property also indicates that the termination is using a GSM access network. + +If the MGW has requested a rate change due to GSM fax rate mismatch (CMM procedure see 3GPP TS 43.045 [35]) then it shall suspend transmission until the MSC Server has modified the PLMN Bearer Capability and GSM Channel Coding property to match the required rate. If this occurs while other context manipulations are occurring the MGW shall only resume transmission when the streams are bothway connected and the PLMN Bearer Capability and Channel Coding are correct. The MGW shall not send subsequent rate change notifications while the outstanding rate change has not been performed by the MSC Server. + +## 15.2.2 TFO package + +PackageID: threegtfoc (0x0031) + +Version: 2 + +Extends: None + +This package defines events and properties for Tandem Free Operation (TFO) control. TFO uses inband signalling and procedures for Transcoders to enable compressed speech to be maintained between a tandem pair of transcoders. This package allows an MGW, which has inserted a transcoder, to support TFO. + +### 15.2.2.1 Properties + +TFO Activity Control: + +PropertyID: tfoenable (0x0001). + +Description: Defines if TFO is enabled or not. + +Type: Enumeration. + +Possible Values: + +- "On" (0x0001): TFO is enabled, TFO protocol is supported. +- "Off" (0x0002): TFO is not enabled, TFO protocol is not initiated or terminated. + +Defined in: Local Control descriptor. + +Characteristics: Read/Write. + +TFO Codec List: + +PropertyID: codeclist (0x0002). + +Description: List of codecs for use in TFO protocol, the Local Used Codec (see 3GPP TS 28.062 [5]) is always the first entry in the list. The MSC Server may enable TFO without providing a TFO Codec List ; in this case, the MGW shall behave as if it had received a TFO Codec List composed of the selected codec of the opposing termination within the Context. + +Type: Sub-list of Octet string. + +Possible Values: + +- List of codec types; each entry: + +Mc Single Codec, similar to as defined in ITU-T Recommendation Q.765.5 [24], for single codec information (figure 14/Q.765.5), where the Codec Information is defined either in ITU-T Recommendation Q.765.5 [24] or in another specification for the given Organization Identifier. For 3GPP codecs these are defined in 3GPP TS 26.103 [16]. The ACodec property in H.248 binary encoding or codecconfig attribute in H.248 text encoding contain the contents of the ITU-T Single Codec IE, excluding the Single Codec Identifier, Length Indication and Compatibility Information. + +In H.248 text encoding, the value of the codeclist property shall be encoded as: + +LBRKT codecconfig \*(COMMA codecconfig) RBRKT + +Example: H.248 text encoding of the TFO codec list (UMTS\_AMR\_2 with Preferred Configuration set 1, and UMTS\_AMR-WB with Preferred Configuration set 0): + +Threegtfc/codeclist = { 0206959504 , 020A00 } + +Where: + +- UMTS\_AMR\_2 parameters are: ETSI, UMTS\_AMR\_2, ACS={12.2, 7.4, 5.9, 4.75}, SCS={12.2, 7.4, 5.9, 4.75}, OM=0 plus MACS=4 +- UMTS\_AMR\_WB parameters are: ETSI, UTMS\_AMR\_WB, Config-WB-Code=00 + +Defined in: Local Control descriptor. + +Characteristics: Read/Write. + +### 15.2.2.2 Events + +Optimal Codec Event: + +EventID: codec\_modify (0x0010). + +Description: The event is used to notify the MGC that TFO negotiation has resulted in an optimal codec type being proposed. + +EventsDescriptor Parameters: None. + +ObservedEventsDescriptor Parameters: + +- Optimal Codec Type. + - ParameterID: optimalcodec (0x0011). + - Description: indicates which is the proposed codec type for TFO. + - Type: Octet string. + - Possible Values: + - Mc Single Codec; + - Similar to as defined in ITU-T Recommendation Q.765.5 [24], for single codec information (figure 14/Q.765.5), where the Codec Information is defined either in ITU-T Recommendation Q.765.5 [24] or in another specification for the given Organization Identifier. For 3GPP codecs these are defined in 3GPP TS 26.103 [16]. The ACodec property in H.248 binary encoding or codecconfig attribute in H.248 text encoding contain the contents of the ITU-T Single Codec IE, excluding the Single Codec Identifier, Length Indication and Compatibility Information. + +Codec List Event: + +EventID: distant\_codec\_list (0x0012). + +Description: The event is used to notify the MGC of the distant TFO partner's supported codec list. + +EventsDescriptor Parameters: None. + +ObservedEventsDescriptor Parameters: + +- Distant Codec List: + - ParameterID: distlist(0x0013). + - Description: indicates the codec list for TFO. + - Type: Sub-list of Octet string. + - Possible Values: + - List of codec types; each entry: + - Mc Single Codec similar to as defined in ITU-T Recommendation Q.765.5 [24], for single codec information (figure 14/Q.765.5), where the Codec Information is defined either in ITU-T Recommendation Q.765.5 [24] or in another specification for the given Organization Identifier. For 3GPP codecs these are defined in 3GPP TS 26.103 [16]. The ACodec property in H.248 binary encoding or codecconfig attribute in H.248 text encoding contain the contents of the ITU-T Single Codec IE, excluding the Single Codec Identifier, Length Indication and Compatibility Information. + +The first Codec Type in the list is the Distant Used Codec, received from the distant TFO partner (see 3GPP TS 28.062 [5]). . + +In H.248 text encoding, the value of the distlist parameter shall be encoded as: + +LBRKT codecconfig \*(COMMA codecconfig) RBRKT + +TFO Status Event: + +EventID: TFO\_status (0x0014). + +Description: The event is used to notify the MGC that a TFO link has been established or broken. + +EventsDescriptor Parameters: None. + +ObservedEventsDescriptor Parameters: + +- TFO Status: + - ParameterId: tfostatus (0x0015). + - Description: reports whether TFO has been established or broken. Upon TFO activation, no notification is sent if TFO has not been established. A TFO\_Off notification is only reported when a TFO link previously established is broken. The MGW should not report transient TFO status change. + - Type: Boolean + - Possible Values: + - "TFO\_On" : TFO has been established. + - "TFO\_Off" : TFO is no more established. + +### 15.2.2.3 Signals + +None. + +### 15.2.2.4 Statistics + +None. + +### 15.2.2.5 Procedures + +For the procedures for TFO see 3GPP TS 28.062 [5]. + +To enable TFO, the MSC Server shall configure the properties of this package on a MGW Termination with the media stream property for Codec Type set to ITU-T Recommendation G.711 [25] (see annex C of ITU-T Recommendation H.248 [10]) or Bearer Service Characteristics set to "Speech" or "3.1 kHz Audio" in TMR or USI due to Reserve Circuit Procedure, see in ITU-T Recommendation Q.1950 (see 3GPP TS 29.205 [7]). + +The TFO protocol shall be disabled if the call configuration becomes no longer TFO compatible or if the Codec Type property of the media stream at the opposing termination in the Context is reconfigured to G.711 or if the Bearer Service Characteristics of the opposing Termination is reconfigured to "Speech" or "3.1 kHz Audio". The TFO protocol may be disabled either by the MSC Server by using the TFO Activity Control property of this package or by the MGW in accordance with the TFO rules as described in [5] when it detects that TFO operation is no longer possible (for example it has G.711 encoding at opposing Terminations). + +## 15.2.3 3G Expanded Call Progress Tones Generator Package + +PackageID: threegxcg(0x0032) + +Version: 1 + +Extends: xcg version1 + +This package extends "Expanded Call Progress Tones Generator Package", as defined in ITU-T Recommendation Q.1950 [23] (see 3GPP TS 29.205 [7]). The package adds a new toneId for CAMEL prepaid warning tone. + +### 15.2.3.1 Properties + +None. + +### 15.2.3.2 Events + +None. + +### 15.2.3.3 Signals + +CAMEL Prepaid Warning Tone: + +SignalID: cpwt (0x004f). + +Description: Generate CAMEL prepaid warning tone to inform the party that the Max Call Period Duration is about to expire. CAMEL prepaid warning tone is defined in 3GPP TS 23.078 [22]. The physical characteristic of CAMEL prepaid warning tone is available in the gateway. + +Signal type: Brief. + +Duration: Provisioned, Not Auditable. + +Additional parameters: + +- Tone Direction. +- ParameterID: td (0x0010). +- Type: Enumeration. +- Values: + - "Ext" (0x01): external. + - "Int" (0x02): internal. + - "Both" (0x03): Both. +- Default: "Ext". + +### 15.2.3.4 Statistics + +None. + +### 15.2.3.5 Procedures + +None. + +## 15.2.4 Modification Of Link Characteristics Bearer Capability + +PackageName: Modification of Link Characteristics Bearer Capability + +PackageID: threegmlc(0x0046) + +Description: This package contains an event that when requested by the MGC will cause the MG to notify the MGC that modification of the link characteristics is allowed. This notification is typically generated when the bearer has been established. + +Version: 1 + +Extends: None + +### 15.2.4.1 Properties + +None. + +### 15.2.4.2 Events + +Bearer Modification Support Event. + +EventID: mod\_link\_supp (0x0001). + +Description: The event is used to notify the MGC that modification of the link characteristics of the current bearer connection is permitted. + +EventsDescriptor Parameters: None. + +ObservedEventsDescriptor Parameters: None. + +#### 15.2.4.3 Signals + +None. + +#### 15.2.4.4 Statistics + +None. + +#### 15.2.4.5 Procedures + +If the MGC is interested in determining whether or not the bearer associated with a termination supports modification of its link characteristics it shall send a request (Add/Modify/Move) with the Bearer Modification Support Event. When the bearer is established the MG will indicate in a Notify request to the MGC if modification of link characteristics is supported. A notify will NOT be generated if modification is NOT supported on the bearer. + +### 15.2.5 Enhanced Circuit Switched Data package + +PackageID: threeegcsden (0x0082) + +Version: 1 + +Extends: threeegcsd (0x030) Version 1 + +This package extends "Circuit Switched Data Package", as defined in subclause 15.1.2. This package adds a new property to define the user bitrate at a Iu termination. + +#### 15.2.5.1 Properties + +##### Bitrate + +PropertyID: bitrate (0x0003). + +Description: user bitrate. + +Type: Integer. + +Possible Values: transmission rate in bits per second, rounded to the nearest integer value. The value shall be a valid bitrate; one of the following rates: 2400, 4800, 9600, 14400, 28800, 57600, 64000. + +Defined in: Local Control Descriptor. + +Characteristics: Read/Write. + +#### 15.2.5.2 Events + +None. + +#### 15.2.5.3 Signals + +None. + +#### 15.2.5.4 Statistics + +None. + +#### 15.2.5.5 Procedures + +This package is used in addition to the 3GCSD package for CS data calls. It is used for indicating the user data rates for Inter-MSC SRNS Relocation and handover cases. If the Bitrate is not 64 kb/s at one termination in the MGW but its opposing termination has properties that define its bitrate to be 64 kb/s (e.g. TMR=UDI) then A-TRAU' protocol shall be applied by the MGW. For further details see 3GPP TS 29.007 [6]. + +## 15.2.6 Cellular Text telephone Modem Text Transport + +PackageName: CTM Text Transport + +PackageID: threegctm (0x0068) + +Description: The CTM text transport package is intended for enabling robust real time text conversation through a voice channel primarily intended for communication over mobile networks. This package includes the mechanisms needed to transport T.140 text conversation streams [19] in a voice channel environment, using the CTM Cellular Text Telephone Modem specified in 3GPP TS 26.226 [18]. The transport mechanism allows for alternating transport of voice and text. + +Version: 1 + +Extends: None + +### 15.2.6.1 Properties + +Text termination connection state: + +PropertyID: connstate (0x0001). + +Description: The connection state property is used to reflect details of the achieved text connection. For each new session connstate should be reset to "Prepare". + +Type: Enumeration. + +Possible values: + +- "Idle" (0x0001) meaning that CTM availability negotiation has failed; CTM is disabled except for monitoring the incoming line for CTM signals. +- "Prepare" (0x0002) for CTM being enabled, monitoring for CTM signals and ready to send CTM signals. +- "Connected" (0x0006) for CTM being enabled and to have detected CTM availability in the current session. + +Defined in: TerminationState. + +Characteristics: Read/Write. + +Text Transport: + +PropertyID: trpt (0x0002) + +Description: The transport parameter reflects the transport mechanism selected for the Text Conversation termination. In 3GPP, one possible transport mechanism is the Cellular Text Telephone Modem as in 3GPP TS 26.226 [18]. It is used when it is desired to transport the text conversation in a voice channel. CTM enables alternating use of the voice channel for voice and text during the call. + +Type: Enumeration. + +Possible values: + +- "ctm" (0x0008) for text transport in mobile voice channel as in 3GPP TS 26.226 [18]. + +Defined in: LocalControl. + +Characteristics: Read/Write. + +Text Protocol Version: + +PropertyID: textproto (0x0003). + +Description: The version of the ITU-T Recommendation T.140 [19] protocol used in the connection. + +Type: Integer. + +Possible values: + +- Any integer corresponding to a T.140 version number (currently 1) as in ITU-T Recommendation H.248 .2 [17]. + +Defined in: LocalControl. + +Characteristics: Read/Write. + +### 15.2.6.2 Events + +Connection State Change: + +EventID: connchange (0x0001). + +Description: + +- This event will occur when the text connection state for the termination has changed. +- The parameter values are the same as the Connection State property. +- If a CTM availability request timed out, the state is returned to Idle. + +EventDescriptorParameters: + +None. + +ObservedEventDescriptorParameters: + +ParameterName: Connection Change. + +ParameterID: connchng (0x0001). + +Type: Enumeration. + +Possible Values: As property threegctm/connstate. + +### 15.2.6.3 Signals + +None. + +### 15.2.6.4 Statistics + +Characters Transferred: + +StatisticsID: chartrans (0x0001). + +Description: Number of bytes of ITU-T Recommendation T.140 [19] data transferred through the termination. + +Units: count. + +### 15.2.6.5 Procedures + +If the MGC detects a CTM indication it shall send a request (Add/Modify/Move) with the CTM Transport property. Upon receivable of it, the MGW shall allocate a termination with CTM capabilities. Normal usage is that the CTM enabled termination handles one text stream and one voice stream and alternates between transporting voice and text in the voice channel according to the functionality of CTM. This termination could for example be combined in a context with a termination with the txp and ctyp packages for gateway functionality between PSTN text telephony and mobile CTM based text telephony. These packages are described in ITU-T Recommendation H.248.2 [17]. + +The CTM algorithm has states. The states defined in the text termination connection state property are mapped into CTM states in the following way: + +- Idle: CTM disabled because of an unsuccessful CTM availability negotiation. +- Prepare: normal initial state with CTM monitoring active. + +- Connected: CTM negotiation is completed. + +For each new call, the CTM termination shall be put in the Prepare state. + +When the CTM availability negotiation is completed, the state is Connected. + +The state transitions are automatic, except for setting Prepare state as described above. + +## 15.2.7 IP transport package + +This package has been replaced by the use of Annex C.6 IP and UDP properties (see subclauses 14.2.41 and 14.2.42). + +## 15.2.8 Flexible Tone Generator Package + +PackageID: threegflex (0x0084) + +Version: 1 + +Extends: threegxcg version 1 + +This package extends "3G Expanded Call Progress Tones Generator Package", as defined in chapter 15.1.4 above. This package adds a new tone for call duration control in CAMEL phase 4, supporting variable sequence of tones and burst list. + +### 15.2.8.1 Properties + +None. + +### 15.2.8.2 Events + +None. + +### 15.2.8.3 Signals + +Signal Name: Flexible Tone. + +SignalID: ft (0x0050). + +Description: Generate flexible 900 Hz tone. The physical characteristics of Flexible Tone is not described in the additional parameters. It shall be available in the Media Gateway. + +SignalType: Brief. + +Duration: Provisioned. + +Additional Parameters: + +- Parameter Name: Burst List Direction + +Description: Used to indicate the direction the tone is to be sent. External indicates that the tone is sent from the MG to an external point. Internal indicates that the tone is played into the Context to the other terminations. Both way indicates both internal and external behaviour. + +ParameterID: bld (0x0001). + +Type: Enumeration. + +Possible Values: + +- "Ext" (0x01): External. +- "Int" (0x02): Internal. +- "Both" (0x03): Both way. +- Default: "Ext" (0x01). + +Parameter Name: numberOfBursts. + +Description: Number of bursts in the burst list. + +ParameterID: nob (0x0002). + +Type: Integer. + +Possible values: 1 to 3. + +Default: 1. + +Parameter Name: burstInterval. + +Description: Time interval between two consecutive bursts expressed in amount of 100 ms units. + +ParameterID: bi (0x0003). + +Type: Integer. + +Possible values: 1 to 1200. + +Default: 2. + +Parameter Name: numberOfTonesInBurst. + +Description: Number of tones to be played in each burst. + +ParameterID: notib (0x0004). + +Type: Integer. + +Possible values: 1 to 3. + +Default: 3. + +Parameter Name: toneDuration. + +Description: Duration of each tone in a burst expressed in amount of 100 ms units. + +ParameterID: td (0x0005). + +Type: Integer. + +Possible values: 1 to 20. + +Default: 2. + +Parameter Name: toneInterval. + +Description: Time interval between two consecutive tones in a burst expressed in amount of 100 ms units. + +ParameterID: ti (0x0006). + +Type: Integer. + +Possible values: 1 to 20. + +Default: 2. + +## 15.2.8.4 Statistics + +None. + +## 15.2.8.5 Procedures + +The MGW should generate the tones using the above mentioned parameters as specified in 3GPP TS 23.078 [22] subclause 4.5.7.1.2 + +In case MGC requests to generate a flexible tone specifying a signal type "Timeout" and a "Duration" longer than the time needed to play the whole Burst List no action will be taken on the incoming stream to fill the gap. I.e. if any user plane stream is received on one side of the termination after the end of the burst list, it will be present, unchanged, on the other side of the termination as well (transparent mode). + +## 15.2.9 Trace Package + +PackageID: calltrace (0x0097) + +Version: 1 + +Extends: None + +This package defines properties for subscriber and equipment trace activation and deactivation properties to be attached to the trace record generated by MGW. + +### 15.2.9.1 Properties + +#### Trace Activation Control + +PropertyID: traceactivityrequest(0x0001) + +Description: Defines if trace is activated or deactivated. + +Type: Bool + +Possible Values: + +"on" (true): Trace Session is activated in MGW + +"off" (false): Trace Session is deactivated in MGW + +Defined in: Local Control descriptor + +Characteristics: Read/Write + +#### IMSI + +PropertyID: imsi(0x0002) + +Description: IMSI number of the traced subscriber to be attached to the trace record. Used for record identification like trace reference. + +Type: Octet string + +Possible Values: The IMSI is coded as defined in 3GPP TS 23.003 [43]. The IMSI is TBCD-coded with a fixed length of 8 octets. Two digits are encoded per octet, each digit is encoded 0000 to 1001 (0 to 9). Bits 8765 of octet n encodes digit 2n, bits 4321 of octet n encodes digit 2(n-1) +1 (i.e the order of digits is swapped in each octet compared to the digit order defined in 3GPP TS 23.003 [43]). 1111 is used as filler when there is an odd number of digits. Digits are packed contiguously with no internal padding. + +Defined in: Local Control descriptor + +Characteristics: Read/Write + +#### IMEI(SV) + +PropertyID: imei\_sv(0x0003) + +Description: IMEI(SV) number of the traced equipment to be attached to the trace record. Used for record identification like trace reference. + +Type: Octet string + +Possible Values: The IMEI(SV) is coded as defined in 3GPP TS 23.003 [43]. The IMEI(SV) is TBCD encoded. Two digits are encoded per octet, each digit is encoded 0000 to 1001 (0 to 9). Bits 8765 of octet n encodes digit 2n, bits 4321 of octet n encodes digit 2(n-1) +1 (i.e the order of digits is swapped in each octet compared to the + +digit order defined in 3GPP TS 23.003 [43]). 1111 is used as filler when there is an odd number of digits. Digits are packed contiguously with no internal padding. + +Defined in: Local Control descriptor + +Characteristics: Read/Write + +#### Trace Reference + +PropertyID: tracereference(0x0004) + +Description: Reference number to identify different Trace Session in OSS as defined in 3GPP TS 32.421 [29] and 3GPP TS 32.422 [30]. + +Type: Octet string + +Possible Values: OSS (EM) defines when activating a Trace Session + +Defined in: Local Control descriptor + +Characteristics: Read/Write + +#### Trace Recording Session Reference + +PropertyID: tracerecsessionref(0x0005) + +Description: A unique identifier within the Trace Session for identifying the Trace Recording sessions. Defined in 3GPP TS 32.421 [29] and in 3GPP TS 32.422 [30]. + +Type: Octet string + +Possible Values: Described in 3GPP 32.422 [30] + +Defined in: Local Control descriptor + +Characteristics: Read/Write + +#### Trace Depth + +PropertyID: tracedepth(0x0006) + +Description: Trace Depth as defined in 3GPP TS 32.421 [29] + +Type: Enumeration + +Possible Values: Defined in 3GPP TS 32.422 [30] + +Defined in: Local Control descriptor + +Characteristics: Read/Write + +#### Trigrering Events + +PropertyID: triggeringevent(0x0007) + +Description: Trigrering Events as defined in 3GPP TS 32.422 [30]. + +Type: Octet string + +Possible Values: Defined in 3GPP TS 32.422 [30]. + +Defined in: Local Control descriptor + +Characteristics: Read/Write + +#### List of interfaces + +PropertyID: listofinterfaces(0x0008) + +Description: List of interfaces to trace as defined in 3GPP TS 32.422 [30] + +Type: Octet string + +Possible Values: Defined in 3GPP TS 32.422 [30] + +Defined in: Local Control descriptor + +Characteristics: Read/Write + +## 15.2.9.2 Events + +Trace result + +EventID: tracact (0x0001) + +Description: Notification to the MSC Server if trace activation was successful/unsuccessful in the MGW. + +EventDescriptor parameters: None + +ObservedEventsDescriptor parameters: + +Result: Trace Activation Result + +res (0x0001) + +Type: enumeration + +Possible values: + +success (0x0001): "Trace Successfully activated" + +failure (0x0000): "Failure in trace activation" + +## 15.2.9.3 Signals + +None + +## 15.2.9.4 Statistics + +None + +## 15.2.9.5 Procedures + +For the network level procedures of the tracing see 3GPP 32.422 [30]. + +For the trace records of the MGW see 3GPP 32.423 [31]. + +In H.248 interface MSC Server uses 'Trace Activity Control' property to indicate MGW that a termination should be placed under trace or should be taken out of trace. In the call establishing phase MSC Server sets trace package information into proper command (Add or Modify) associated to the termination to be traced. Tracing can be activated either by giving IMEI(SV) or IMSI number as a further information. MSC Server shall also provide the values for all other properties described in this package that is IMSI if trace is activated based on IMSI, IMEI(SV) if trace is activated based on IMEI(SV), Trace reference, Trace recording session reference, Trace depth, triggering events in MGW, list of interfaces in MGW. When MSC Server activates the trace, it shall use 'Trace Activation Result' Event to detect if the Trace Activation was successful or not. MGW shall not reject the Add/Modify because of unsuccessful Trace Activation, but only send a Notification with this Event. Tracing is automatically deactivated in MGW when termination is taken out of the context in the end of the call. If the Termination is Moved to another Context, trace is automatically forwarded to new termination. + +## 15.2.10 ASCI Group call package + +PackageID: threegasci (0x00b2) + +Version: 2 + +Extends: None + +This package contains the information needed to be able to support VGCS (3GPP TS 43.068 [39]) and VBS (3GPP TS 43.069 [40]) services. + +### 15.2.10.1 Properties + +Number of needed conference terminations + +PropertyID: nct (0x0001) + +Description: Indicates the number of needed conference terminations for the call. + +Type: Integer + +Defined in Descriptor: Local Control Descriptor + +Characteristics: Read/Write + +Number of desired listener context terminations + +PropertyID: nlct (0x0002) + +Description: Indicates the number of desired terminations for a listener context. + +Type: Integer + +Defined in Descriptor: Local Control Descriptor + +Characteristics: Read/Write + +### 15.2.10.2 Events + +None. + +### 15.2.10.3 Signals + +None. + +### 15.2.10.4 Statistics + +None + +### 15.2.10.5 Procedures + +The MSC server receives the number of needed conference terminations from GCR (see 3GPP TS 43.068 [39]) and 3GPP TS 43.069 [40]) and reserves the requested number of needed Conference terminations for that call. The parameter "Number of needed conference terminations" shall be included when allocating the first termination of an ASCI-conference context. It is optional when adding further terminations. If the MGW is unable to reserve the number of requested terminations for that call, it shall response with error code 510 "insufficien resources". + +The parameter "Number of desired listener context terminations" should be included when allocating the first termination of a Listener context. + +## 15.2.11 3G Interface Type package + +PackageID: threegint (0x00e3) + +Version: 1 + +Extends: None + +This package contains a property to specify the used interface type for IP terminations. + +### 15.2.11.1 Properties + +IP Interface Type + +PropertyID: ipint (0x0001) + +Description: Indicates the type of external interface used by the termination. + +Type: Enumeration. + +Possible Values: + +- "NboIP" (0x0001) Nb over IP with SIP-I based Nc, see 29.414 [32]. +- "AoIP" (0x0002) A interface over IP. +- "MboIP" (0x0003) Mb interface +- "ExtSIPT" (0x0004) External SIP-I based network + +All other values reserved. + +Defined in: Local Control descriptor. + +Characteristics: Read/Write. + +### 15.2.11.2 Events + +None. + +### 15.2.11.3 Signals + +None. + +### 15.2.11.4 Statistics + +None + +### 15.2.11.5 Procedures + +The MSC server may indicate the interface type (reference point) associated with the RTP bearer termination to the MGW with this package. This allows MGW to collect statistics per interface type associated with the RTP bearer termination as required by 3GPP TS 32.407[58]. The provision of these statistics is outside of the scope of this specification. + +## Annex A (informative): Framing protocol Interworking Function (FPIF) + +### A.1 Introduction + +SDUs transmitted over an Iu or Nb interface and received at a MGW whose outgoing UP is also Iu or Nb shall be relayed to the outgoing UP MGW termination. If no interworking function (other than the FPIF) or transcoder device is inserted by the MGW, and if UP terminations are present, then PDUs and control procedures are passed between MGW terminations by the FPIF. The FPIF is the functional entity responsible for aligning or mapping control procedures (including RFCIs, frame numbers etc) on the separate UP interfaces according to the package procedures described in the main text. The FPIF determines if the two UP configurations are identical and thus the UP PDUs may be passed transparently. If the FPIF determines that the two UP configurations are not identical it applies the required mapping. The relaying of PDUs transparently can also be considered as FPIF bypass. + +NOTE: the implementation in the MGW can perform a more efficient processing of the PDUs in this case. The MGW switching and bypassing of the protocol functions during TrFO is left to the manufacturer's implementation. + +UP initialisations are not handled by the FPIF, only receipt of the Subflow combinations and the RFCI allocations are received by the FPIF for each UP. + +The RFCIs are relayed by the FPIF as described in main text for the UP package procedures. + +![Diagram of the Framing Protocol Interworking Function (FPIF) architecture.](bbddeb46a8bee133d49003273fcfc8dd_img.jpg) + +The diagram illustrates the FPIF architecture within a Media Gateway (MGW). At the top, two 'Iu/Nb Interface' blocks are shown. Below each interface is a box labeled 'Iu or Nb UP Support Mode Functions'. Between these boxes and the interfaces are double-headed arrows labeled 'Transfer of Iu FP protocol frames'. Below each 'Iu or Nb UP Support Mode Functions' box is a 'RNL/CNL-SAP' interface, represented by a circle. Below each 'RNL/CNL-SAP' is a 'TNL-SAP' interface, also represented by a circle. At the bottom, a thick horizontal line represents the MGW. Arrows point from each 'TNL-SAP' down to the MGW. At the top center, a pink box labeled 'FPIF' has double-headed arrows connecting it to both 'RNL/CNL-SAP' interfaces. + +Diagram of the Framing Protocol Interworking Function (FPIF) architecture. + +Figure A.1: The Framing Protocol Interworking Function + +## A.2 FPIF procedures with respect to Iu framing protocol + +This clause handles relay of user data indicated to the FPIF in a Nb- or Iu-UP-data-indication message and transmitted between peer UP layer entities in PDU types 0 and 1. The FPIF passes this information to the UP layer on the sending side in a Nb- or Iu-UP-data-request message. + +### A.2.1 Payload + +Received SDUs shall be forwarded unmodified to the next MGW. Note that if "delivery of erroneous SDUs" is set to 'no', faulty SDUs are already discarded by the Iu or Nb support mode functions and, hence, not delivered to the FPIF. + +### A.2.2 RFCIs + +If the RFCI values on the outgoing UP interface match those initialised on the incoming UP interface then the RFCI indicated by the lower layer (i.e. Iu or Nb) on the receiving side shall be forwarded unmodified to lower layer on the sending side. + +If the RFCI sets on the outgoing UP interface do not match those initialised on the incoming UP interface then the FPIF performs mapping between the RFCIs on each UP for the same initialised Subflow Combination. + +The FPIF is the entity that may perform the RFCI value correction procedure as described in the main text, after this procedure then relaying of the received RFCI shall be performed. + +### A.2.3 FQC + +The FQC indicated by the lower layer (i.e. Iu or Nb) on the receiving side shall be forwarded unmodified to lower layer on the sending side. + +### A.2.4 Frame number + +The frame number indicated by the lower layer (i.e. Iu or Nb) on the receiving side shall be forwarded unmodified to lower layer on the sending side. + +A discontinuity in framing protocol support mode frame numbers is allowed at the end of the TrFO break. + +## A.3 Relay of status information + +This clause handles relay of status information indicated to the FPIF in a Nb- or Iu-UP-status-indication message and transmitted between peer UP layer entities in PDU type 14. The FPIF in general passes this information to the UP layer on the sending side. + +### A.3.1 Void + +### A.3.2 Rate Control Frames + +The FPIF shall pass rate control request and rate control acknowledgement frames transparently between incoming UP interface and outgoing UP interface. + +Before a MGW reverts from TrFO break operation (for example during handover or relocation where the rate control procedures may have been operating independently between each UP interface) the FPIF may perform rate control procedures to each UP peer. It shall then use the Maximum rate and Current rate settings from the opposite UP configurations. This is performed to align the UP's on each side of the MGW to enable relaying of all subsequent PDUs as described above. + +Optionally, the UP layer protocol entity on the sending side may substitute the frame number received in a status request by another number, but shall then substitute the initial number back in the status indication containing the acknowledgement. Figure A.2 shows an example of the relay of the rate control procedure. + +![Sequence diagram illustrating the relay of a control procedure between an Iu UP entity, a Relay Function, and an Nb UP entity.](665db9e4c084c517dc46f23397c8533a_img.jpg) + +``` + +sequenceDiagram + participant Iu UP entity + participant Relay Function + participant Nb UP entity + + Note left of Iu UP entity: RC(0) + Iu UP entity->>Relay Function: RC(0) + Relay Function->>Nb UP entity: RC(0) + Nb UP entity->>Nb UP entity: RC(0) + Nb UP entity->>Nb UP entity: RC-NACK(0) + Nb UP entity->>Nb UP entity: RC(1) + Nb UP entity->>Nb UP entity: RC-ACK(1) + Nb UP entity->>Relay Function: RC-ACK(0) + Relay Function->>Iu UP entity: RC-ACK(0) + Note right of Nb UP entity: Not the same frame number as received in the status request + Note right of Nb UP entity: Frame number 0 is substituted back in the status indication + +``` + +The diagram shows a sequence of messages between three entities: Iu UP entity, Relay Function, and Nb UP entity. The sequence starts with an external RC(0) message arriving at the Iu UP entity. The Iu UP entity sends an RC(0) message to the Relay Function, which in turn sends an RC(0) message to the Nb UP entity. The Nb UP entity then sends three internal messages: RC(0), RC-NACK(0), and RC(1). It also receives an RC-ACK(1) message from itself. The Nb UP entity then sends an RC-ACK(0) message to the Relay Function, which finally sends an RC-ACK(0) message to the Iu UP entity. Two callouts from the Nb UP entity indicate that the frame number in the RC-ACK(0) message is not the same as received in the status request and that frame number 0 is substituted back in the status indication. + +Sequence diagram illustrating the relay of a control procedure between an Iu UP entity, a Relay Function, and an Nb UP entity. + +Figure A.2: Relay of a control procedure + +### A.3.2 Time Alignment + +Time alignment frames shall be relayed unmodified. + +## Annex B (informative): Examples for Usage of the 3GUP Package "Initialization Direction" Property + +![Figure B.1: 3G to 3G Call (A to B), originating RAB established after Nb bearer, same codec configuration on originating Iu and Nb bearers. The diagram shows a sequence of messages between an RNC (RNC A), two MGWs (MGW A and MGW B), and another RNC (RNC B). MGW A has an 'Incoming' Iu bearer and an 'Outgoing' Nb bearer. MGW B has an 'Incoming' Nb bearer and an 'Outgoing' Iu bearer. The RAB is established after the Nb bearer is set up.](c7e27041e661260fd0c8e89c763bb32e_img.jpg) + +Figure B.1: 3G to 3G Call (A to B), originating RAB established after Nb bearer, same codec configuration on originating Iu and Nb bearers. The diagram shows a sequence of messages between an RNC (RNC A), two MGWs (MGW A and MGW B), and another RNC (RNC B). MGW A has an 'Incoming' Iu bearer and an 'Outgoing' Nb bearer. MGW B has an 'Incoming' Nb bearer and an 'Outgoing' Iu bearer. The RAB is established after the Nb bearer is set up. + +**Figure B.1: 3G to 3G Call (A to B), originating RAB established after Nb bearer, same codec configuration on originating Iu and Nb bearers** + +NOTE: The Initialization Direction property of the Nb termination of MGW A could alternatively be set to 'Outgoing', but different RFCIs may then be initialized on the Iu and Nb bearers. + +![Figure B.2: 3G Originating Call, originating RAB established after Nb bearer, same codec configuration on originating Iu and Nb bearers. This diagram is similar to Figure B.1 but shows a different message sequence for an originating call where the RAB is established after the Nb bearer.](0e252770f8f0573617e0112b36a93d2f_img.jpg) + +Figure B.2: 3G Originating Call, originating RAB established after Nb bearer, same codec configuration on originating Iu and Nb bearers. This diagram is similar to Figure B.1 but shows a different message sequence for an originating call where the RAB is established after the Nb bearer. + +**Figure B.2: 3G Originating Call, originating RAB established after Nb bearer, same codec configuration on originating Iu and Nb bearers** + +NOTE: The Initialization Direction property of the Nb termination of MGW A could alternatively be set to 'Outgoing', but different RFCIs may then be initialized on the Iu and Nb bearers. + +![Figure B.3: 3G Terminating Call. The diagram shows a sequence of messages between an RNC (RNC A), two MGWs (MGW A and MGW B), and another RNC (RNC B). MGW A has an 'Incoming' Iu bearer and an 'Outgoing' Nb bearer. MGW B has an 'Incoming' Nb bearer and an 'Outgoing' Iu bearer. The RAB is established before the Nb bearer is set up.](4ee2de50739c96fd7bd5a38150ec9c78_img.jpg) + +Figure B.3: 3G Terminating Call. The diagram shows a sequence of messages between an RNC (RNC A), two MGWs (MGW A and MGW B), and another RNC (RNC B). MGW A has an 'Incoming' Iu bearer and an 'Outgoing' Nb bearer. MGW B has an 'Incoming' Nb bearer and an 'Outgoing' Iu bearer. The RAB is established before the Nb bearer is set up. + +**Figure B.3: 3G Terminating Call** + +![Figure B.4: 3G to 3G Call (A to B), originating RAB established before or in parallel to the Nb bearer or different codec configuration on originating Iu and Nb bearers. The diagram shows a sequence of messages between an RNC (RNC A), two MGWs (MGW A and MGW B), and another RNC (RNC B). MGW A has an 'Incoming' Iu bearer and an 'Outgoing' Nb bearer. MGW B has an 'Incoming' Nb bearer and an 'Outgoing' Iu bearer. The RAB is established before or in parallel to the Nb bearer.](50d533fa0795f3e7780db917b3f5e496_img.jpg) + +Figure B.4: 3G to 3G Call (A to B), originating RAB established before or in parallel to the Nb bearer or different codec configuration on originating Iu and Nb bearers. The diagram shows a sequence of messages between an RNC (RNC A), two MGWs (MGW A and MGW B), and another RNC (RNC B). MGW A has an 'Incoming' Iu bearer and an 'Outgoing' Nb bearer. MGW B has an 'Incoming' Nb bearer and an 'Outgoing' Iu bearer. The RAB is established before or in parallel to the Nb bearer. + +**Figure B.4: 3G to 3G Call (A to B), originating RAB established before or in parallel to the Nb bearer or different codec configuration on originating Iu and Nb bearers** + +![Diagram of a 3G originating call flow from RNC to PSTN via SMGW and GMGW.](d2417b04116c354deccb25d98a84a0fb_img.jpg) + +This diagram illustrates a 3G originating call flow. It consists of four main components connected in a linear sequence: RNC, SMGW, GMGW, and PSTN. The RNC is connected to the SMGW via an 'Iu' interface. The SMGW is connected to the GMGW via an 'Nb' interface. The GMGW is connected to the PSTN. Above the SMGW, there are two labels: 'Incoming' and 'Outgoing'. Above the GMGW, there is a label: 'Incoming'. + +Diagram of a 3G originating call flow from RNC to PSTN via SMGW and GMGW. + +Figure B.5: 3G Originating Call, originating RAB established before or in parallel to the Nb bearer or different codec configuration on originating Iu and Nb bearers + +![Diagram of a 2G to 2G call flow from BSC A to BSC B via MGW A and MGW B.](107cbeda15ddd53da92c2f677b441c93_img.jpg) + +This diagram illustrates a 2G to 2G call flow. It consists of four main components connected in a linear sequence: BSC A, MGW A, MGW B, and BSC B. The BSC A is connected to the MGW A via an 'A' interface. The MGW A is connected to the MGW B via an 'Nb' interface. The MGW B is connected to the BSC B via an 'A' interface. Above the MGW A, there is a label: 'Outgoing'. Above the MGW B, there is a label: 'Incoming'. + +Diagram of a 2G to 2G call flow from BSC A to BSC B via MGW A and MGW B. + +Figure B.6: 2G to 2G Call (A to B) + +## Annex C (Normative): Profile description + +### C.1 Profile Identification + +| | | +|----------------------|--------------------| +| Profile name: | Threegbicsn | +| Version: | 7 | + +*The name and version of the profile that is sent in the service change command.* + +### C.2 Summary + +This Profile describes the minimum mandatory settings and procedures required to fulfil the requirements of the Mc interface media gateway control. In addition optional settings and procedures are described which fulfil optional features and where supported, the minimum mandatory settings within the optional procedures and packages are identified that must be supported in order to support that feature. + +"Optional" or "O" means that it is optional for either the sender or the receiver to implement an element. If the receiving entity receives an optional element that it has not implemented it should send an Error Code (e.g. 445" Unsupported or Unknown Property", 501"Not Implemented", etc.). "Mandatory" or "M" means that it is mandatory for the receiver to implement an element. Whether it is mandatory for the sender to implement depends on specific functions; detail of whether elements of the core protocol are mandatory to be sent are defined in the stage 2 procedures, stage 3 procedures and/or the descriptions of individual packages. + +The setting or modification of elements described in the profile under the heading "Used in Command" has the meaning that the property can be set/modified with that command. The property may be present in other commands (in order to preserve its value in accordance with ITU-T H.248.1[10]) when those commands are used for other procedures that affect the same descriptor. + +This profile supports Explicit Congestion Notification and Multimedia Priority Service. + +### C.3 Gateway Control Protocol Version + +#### ITU Recommendation H.248.1 Version 2 + +*The minimum H.248 version required to support the profile. This should be based upon base syntax support and not an arbitrary version assignment. This is related to the ServiceChangeVersion in clause C.8.8.* + +### C.4 Connection Model + +**Table C.4: Connection Model** + +| | | +|------------------------------------------------------------|----------------| +| Maximum number of contexts: | No restriction | +| Maximum number of terminations per context: | 32 | +| Allowed termination type combinations in a context: | All | + +## C.5 Context Attributes + +**Table C.5/1: Context attributes** + +| Context Attribute | Supported | Values Supported | +|---------------------------------------------|-------------------|--------------------------------------| +| Topology | Yes (NOTE 1) | See clause C.7.8 Topology Descriptor | +| Priority Indicator | Optional (NOTE 3) | 0-15 (NOTE 4) | +| Emergency Indicator | Yes | NA | +| IEPS Indicator (NOTE 2) | No | NA | +| ContextAttribute Descriptor (NOTE 2) | No | NA | +| ContextIDList Parameter (NOTE 2) | No | NA | + +NOTE 1: Stream ID in Topology Descriptor shall not be supported. +NOTE 2: This field requires at least version 3 of the H.248.1 protocol. +NOTE 3: This Context Attribute parameter is used for MPS as specified in 3GPP TS 22.153 [78]. +NOTE 4: Priority values 11 – 15 of the Priority Indicator are reserved for MPS. + +**Table C.5/2: AND/OR Context attributes** + +| AND/OR Context Attribute | No | NA | +|-----------------------------------------------------------------------|----|----| +| NOTE: This field requires at least version 3 of the H.248.1 protocol. | | | + +## C.6 Terminations + +### C.6.1 Termination Names + +#### C.6.1.1 General + +The Termination ID structure shall follow the guidelines of H.248 and the structure is either relevant or irrelevant for MGC and MGW. + +The relevance depends on the utilized bearer type for termination. With ephemeral ATM/AAL2 and IP endpoint bearer types the internal structure of Termination ID is irrelevant for MGW and MGC and therefore Termination ID is only numeric identifier for termination. When bearer type is physical timeslot within TDM circuit the Termination ID structure shall follow the Termination naming convention for TDM circuit bearer. + +Ephemeral terminations are further denoted in the profile by the following: + +- BICC (meaning applies to terminations towards BICC) +- BICC ATM (meaning applies to terminations towards BICC with ATM transport) +- BICC IP (meaning applies to terminations towards BICC with IP transport) +- Iu (meaning applies to terminations towards Iu interface) +- RTP (meaning applies to all IP terminations, e.g. SIP-I/Nb, Mb, AoIP) +- RTP-CN (meaning applies to terminations towards SIP-I) +- RTP-A (meaning applies to terminations towards A interface over IP) + +**Editor's Note:** it is FFS if specific handling in the profile for the RTP-CN or RTP-A types is needed. + +#### C.6.1.2 ASN.1 Coding + +##### C.6.1.2.1 General Structure + +The following general structure of termination ID shall be used: + +4 octets shall be used for the termination ID. The following defines the general structure for the termination ID: + +**Table C.6.1.2.1: ASN.1 coding** + +| | | +|------------------|---| +| Termination type | X | +|------------------|---| + +Termination type: + +- Length 3 bits +- Values: + + - 000 Reserved + - 001 Ephemeral termination + - 010 TDM termination + - 011 - 110 Reserved + - 111 Reserved for ROOT termination Id (ROOT Termination ID = 0xFFFFFFFF) + +X: + +- Length 29 bits. +- Usage dependent on Termination type. TDM terminations specified below in subclause C.6.1.2.2. Other usage un-specified. + +## C.6.1.2.2 Termination naming convention for TDM terminations + +**Table C.6.1.2.2 ASN.1 coding** + +| | | | +|--------------------------|------------|------------| +| Termination type (=010 ) | PCM system | Individual | +|--------------------------|------------|------------| + +PCM system: + +- Length 24 bits +- Usage unspecified. Uniquely identifies PCM interface in MGW + +Individual: + +- Length: 5 bits +- Max. of 32 individuals (timeslots) per PCM system (max. 24 for a 24 channel system) + +## C.6.1.3 ABNF Coding + +### C.6.1.3.1 General Structure + +The following general structure of termination ID shall be used: + +TerminationID = "ROOT" / pathName / "\$" / "\*" ; According to H.248.1 annex B + +### C.6.1.3.2 Termination naming convention for TDM terminations + +pathName = TDToken UNDERSCORE ((PCMsystem / "\*") SLASH (Individual / "\*")) + +TDToken = "TDM" + +UNDERSCORE = %x5F ;"\_" + +PCMsystem : Usage not specified + +Individual = 1 \* 2 (DIGIT) ; 0-31 + +### C.6.1.3.3 Termination naming convention for Ephemeral terminations + +pathName = EphTokenUNDERSCORE(EPHsystem/"\*") + +EphToken = "Ephemeral" + +UNDERSCORE = %x5F ; "\_" + +EPHsystem : Usage is not specified + +## C.6.2 Multiplexed terminations + +Table C.6.2: Multiplexed terminations + +| | | +|-----------------------------------|----| +| Multiplex terminations supported? | No | +|-----------------------------------|----| + +## C.7 Descriptors + +### C.7.1 Stream Descriptor + +Table C.7.1: Stream descriptors + +| | | | +|------------------------------------------------|-----|---| +| Maximum number of streams per termination type | All | 1 | +|------------------------------------------------|-----|---| + +#### C.7.1.1 LocalControl Descriptor + +Table C.7.1.1/1: Local Control Descriptor + +| | | | | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----|------------------|----------------| +| If not generic list appropriate termination and stream types. | | Termination Type | Stream Type | +| ReserveGroup used: | No | - | - | +| ReserveValue used: | Yes | BICC (NOTE), RTP | Not Applicable | +| NOTE: The support is needed for the optional procedures Modify Char (see 14.2.27) and Reserve Char (see 14.2.28). These procedures use Q.1950 procedures which define the use of the Reserve Value. | | | | + +Table C.7.1.1/2: Allowed Stream Modes + +| Termination Type | Stream Type | Allowed StreamMode Values | +|------------------|----------------|----------------------------------------| +| All | Not Applicable | SendOnly, RecvOnly, SendRecv, Inactive | + +### C.7.2 Events Descriptor + +All events contained in this profile may be set on any termination/stream with the following exceptions. + +Table C.7.2/1: Events Descriptor + +| | | | | +|--------------------------------------------------------|--------------------------------|------------------|----------------| +| Events settable on termination types and stream types: | Yes | | | +| If yes | EventID | Termination Type | Stream Type | +| | Cause (g/cause, 0x0001/0x0001) | All except ROOT | Not Applicable | + +| | | | +|------------------------------------------------------------------------------------|-----------------|-----------------------------------| +| Signal Completion (g/sc, 0x0001/0x0002) | All except ROOT | Not Applicable | +| Start tone detected (tonedet/std, 0x0004/0x0001) | All except ROOT | Not Applicable | +| End Tone detected (tonedet/etd, 0x0004/0x0002) | All except ROOT | Not Applicable | +| DTMF character 0 (dd/d0, 0x0006/0x0010) to DTMF character D (dd/dd, 0x0006/0x001d) | All except ROOT | Not Applicable | +| Completion (ct/cmp, 0x000a/0x0005) | TDM | Not Applicable | +| BNC Change (GB/BNCChange, 0x0021/0x01) | BICC, lu | Not Applicable | +| Tunnel Indication (BT/TIND, 0x0022/0x01) | BICC IP | Not Applicable | +| MGCon (chp/mgcon, 0x0029/0x0001) | ROOT | Not Applicable | +| Termination Heartbeat (hangterm/thb, 0x0098/0x0001) | All except ROOT | Not Applicable | +| Protocol Negotiation Result: (threeegcsd/protres, 0x0030/0x0001) | All except ROOT | Not Applicable | +| Rate Change (threeegcsd/ratechg, 0x0030/0x0002) | All except ROOT | Not Applicable | +| Optimal Codec Event (threeegfoc/codec_modify, 0x0031/0x0010) | All except ROOT | Not Applicable | +| Codec List Event (threeegfoc/distant_codec_list, 0x0031/0x0012) | All except ROOT | Not Applicable | +| TFO Status Event (threeegfoc/TFO_status, 0x0031/0x0014) | All except ROOT | Not Applicable | +| Bearer Modification Support Event (threeegmlc/mod_link_supp, 0x0046/0x0001) | lu | Not Applicable | +| Connection State Change (threeegctm/connchange, 0x0068/0x0001) | All except ROOT | Not Applicable | +| Trace result (calltrace/ tracact, 0x0097/0x0001) | All except ROOT | Not Applicable | +| Inactivity Timeout (it/ito, 0x0045/0x0001) | ROOT | Not Applicable | +| Available Realms Changed (ipra/arc, 0x00e0/0x0001) | ROOT | Not Applicable | +| IP Flow Stop Detection (adid/ipstop, 0x009c/0x0001) | RTP-CN | Not Applicable | +| ECN Failure (ecnrous/fail, 0x010b/0x0001) | IP | Audio, Video | +| ICE New Peer Reflexive Candidate (ostuncc/nprc, 0x00c3/0x0002) | IP | Any, only applicable for full ICE | +| ICE Connectivity Check Result (ostuncc/ccr, 0x00c3/0x0001) | IP | Any, only applicable for full ICE | + +NOTE: Stream ID may be ignored in Events Descriptor + +Table C.7.2/2: Event Buffer Control + +| | | +|---------------------------|----| +| EventBuffer Control used: | No | +|---------------------------|----| + +Table C.7.2/3: Keep active + +| | | +|----------------------------|-----| +| KeepActive used on events: | Yes | +|----------------------------|-----| + +**Table C.7.2/4: Embedded events and signals** + +| | | +|--------------------------------------------------|----| +| Embedded events in an Events Descriptor: | No | +| Embedded signals in an Events Descriptor: | No | + +**Table C.7.2/5: Regulated Embedded events** + +| | | +|-----------------------------------------------------------------------|------| +| Regulated Embedded events are triggered on: | None | +| NOTE: This field requires at least version 3 of the H.248.1 protocol. | | + +**Table C.7.2/6: ResetEventsDescriptor** + +| | | +|-----------------------------------------------------------------------|------| +| ResetEventsDescriptor used with events: | None | +| NOTE: This field requires at least version 3 of the H.248.1 protocol. | | + +**Table C.7.2/7: Notification Behaviour** + +| | | +|-----------------------------------------------------------------------|------------| +| NotifyImmediate: | ALL Events | +| NotifyRegulated: | None | +| NeverNotify: | None | +| NOTE: This field requires at least version 3 of the H.248.1 protocol. | | + +### C.7.3 EventBuffer Descriptor + +**Table C.7.3: Event Buffer Descriptor** + +| | | +|-------------------------------------|----| +| EventBuffer Descriptor used: | No | +|-------------------------------------|----| + +## C.7.4 Signals Descriptor + +**Table C.7.4/1: Signals Descriptor** + +| | | | | +|-----------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|-----------------------------------| +| The setting of signals is dependant on termination or streams types: | Yes

NOTE: "No" means that all signals can be played on any termination or stream. If "Yes", any signal not listed below may be played on any termination or stream, except Signals on ROOT termination shall not be supported. | | | +| If yes | SignalID | Termination Type | Stream Type / ID | +| | Establish BNC (GB/EstBNC, 0x0021/0x01) | BICC | Not Applicable | +| | Modify BNC (GB/ModBNC, 0x0021/0x02) | BICC | Not Applicable | +| | Release BNC (GB/RelBNC, 0x0021/0x03) | BICC ATM | Not Applicable | +| | Bearer Information Transport (BT/BIT, 0x0022/0x01) | BICC IP | Not Applicable | +| | Continuity Test (ct/ct, 0x000a/0x0003) | TDM | Not Applicable | +| | Respond (ct/rsp, 0x000a/0x0004) | TDM | Not Applicable | +| | Send Additional Connectivity Check (ostuncc/sacc, 0x00c3/0x0002) | IP | Any, only applicable for full ICE | +| | Send Connectivity Check (ostuncc/scc, 0x00c3/0x0001) | IP | Any, only applicable for full ICE | +| NOTE: Stream ID may be ignored for Signals Descriptor | | | | + +**Table C.7.4/2: Signal Lists** + +| | | | +|-----------------------------------------------------------------------|------------------------------------------------------|-----------------| +| Signals Lists supported: | Yes | | +| If yes | Termination Type Supporting Lists: | ALL except ROOT | +| | Stream Type Supporting lists: | ALL | +| | Maximum number of signals to a signal list: | FFS | +| | Intersignal delay parameter supported: (NOTE) | No | +| NOTE: This field requires at least version 3 of the H.248.1 protocol. | | | + +**Table C.7.4/3: Overriding Signal type and duration** + +| | | | +|--------------------------------------------|------------------------------------|----------------------------------| +| Signal type and duration supported: | Yes | | +| If yes | SignalID | Type or duration override | +| | All Tones, Announcements and DTMFs | Both | + +**Table C.7.4/4: Signal Direction** + +| | | +|-----------------------------------------------------------------------|----| +| Signal Direction supported: | No | +| NOTE: This field requires at least version 3 of the H.248.1 protocol. | | + +**Table C.7.4/5: Notify completion** + +| | | | +|------------------------------------|-----------------------------|-------------------------------------| +| NotifyCompletion supported: | Yes | | +| If yes | SignalID | Type of completion supported | +| | All Tones and Announcements | TO, EV, SD, NC | + +| | | +|-----------------------------------------------------------------------|----| +| RequestID Parameter supported:
(NOTE)
| No | +| NOTE: This field requires at least version 3 of the H.248.1 protocol. | | + +**Table C.7.4/6: Signals played simultaneously** + +| | | +|---------------------------------------|----| +| Signals played simultaneously: | No | +|---------------------------------------|----| + +**Table C.7.4/7: Keep active** + +| | | +|------------------------------------|-----| +| KeepActive used on signals: | Yes | +|------------------------------------|-----| + +## C.7.5 DigitMap Descriptor + +**Table C.7.5: DigitMap Descriptor** + +| | | +|-----------------------------|----| +| DigitMaps supported: | No | +|-----------------------------|----| + +## C.7.6 Statistics Descriptor + +**Table C.7.6/1: Statistics Descriptor support** + +| | | +|---------------------------------|-------------| +| Statistics supported on: | Termination | +|---------------------------------|-------------| + +**Table C.7.6/2: Statistics Report on Subtract** + +| | | | +|------------------------------------------|---------------------------------|----------------------------------------------------------------------------------------------------| +| Statistics reported on Substract: | Yes | | +| If yes | StatisticalIDs reported: | If Global Text Telephony used:
Characters Transferred (threeegctm/chartrans ,
0x0068/0x0001) | + +## C.7.7 ObservedEvents Descriptor + +**Table C.7.7: ObservedEvents Descriptor** + +| | | +|----------------------------------------|----| +| Event detection time supported: | No | +|----------------------------------------|----| + +## C.7.8 Topology Descriptor + +**Table C.7.8: Topology Descriptor** + +| | | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------| +| Allowed triples: | (T1, T2, isolate) (T1, T2, oneway) (T1, T2, bothway) | +| NOTE: The Topology Descriptor shall be supported by the MGW and MGC for VGCS, VBS, handover and lawful interception. It can also be used for sending tones and playing announcements. | | + +## C.7.9 Error Descriptor + +Which H.248.8 and package defined error codes are supported? + +**Table C.7.9/1: Error Codes Sent by MGC** + +| | | +|---------------------------------------------------|--------------------------------------------------------------------------------------------------| +| Supported H.248.8 Error Codes: | ALL H.248.8, list of individual numbers> | +| Supported Error Codes defined in packages: | For a list of error codes see clauses 5.14.x | + +**Table C.7.9/2: Error Codes Sent by MGW:** + +| | | +|---------------------------------------------------|--------------------------------------------------------------------------------------------------| +| Supported H.248.8 Error Codes: | | +| Supported Error Codes defined in packages: | For a list of error codes see clauses 5.14.x | + +## C.7.10 TerminationState Descriptor + +**Table C.7.10/1: TerminationState Descriptor** + +| | | +|----------------------------------------------|------------------------| +| TerminationState: ServiceStates: | InService/OutOfService | +| TerminationState: EventBufferControl: | OFF | + +## C.8 Command API + +NOTE – It is assumed that an Error Descriptor may be returned in any command reply. + +### C.8.1 Add + +**Table C.8.1/1: Descriptors used by Command Add Request** + +| | | +|-----------------------------------------|----------------------------------------------------------------| +| Descriptors used by Add request: | Events, Signals, Media (LocalControl, Local And Remote), Audit | +|-----------------------------------------|----------------------------------------------------------------| + +**Table C.8.1/2: Descriptors used by Command Add Reply** + +| | | +|---------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Descriptors used by Add reply: |

Media (LocalControl, Local And Remote), Error

When ADD commands exclude an Audit Descriptor, the MGW response shall only include descriptors which contained underspecified or overspecified properties in the command request. Furthermore, only those properties that were underspecified or overspecified in the request shall be sent in the reply. Exceptions to this rule are:

  • - The Error Descriptor
  • - SDP properties returned in "Reserve RTP Connection Point" and "Reserve and Configure RTP Connection Point" procedures, as specified in 14.2.51 and 14.2.53

The applicability of this restriction for text encoding is FFS.

| +|---------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +### C.8.2 Modify + +**Table C.8.2/1: Descriptors used by Command Modify Request** + +| | | +|--------------------------------------------|----------------------------------------------------------------| +| Descriptors used by Modify request: | Events, Signals, Media (LocalControl, Local And Remote), Audit | +|--------------------------------------------|----------------------------------------------------------------| + +**Table C.8.2/2: Descriptors used by Command Modify Reply** + +| | | +|------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Descriptors used by Modify reply: |

Media (LocalControl, Local And Remote), Error

When MOD commands exclude an Audit Descriptor, the MGW response shall only include descriptors which contained underspecified or overspecified properties in the command request. Furthermore, only those properties that were underspecified or overspecified in the request shall be sent in the reply. Exceptions to this rule are:

  • - The Error Descriptor
  • - SDP properties returned in "Configure RTP Connection Point" in 14.2.52.

The applicability of this restriction for text encoding is FFS.

| +|------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +### C.8.3 Subtract + +**Table C.8.3/1: Descriptor used by Command Subtract Request** + +| | | +|----------------------------------------------|------| +| Descriptors used by Subtract request: | None | +|----------------------------------------------|------| + +**Table C.8.3/2: Descriptor used by Command Subtract Reply** + +| | | +|--------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Descriptors used by Subtract reply: |

None or Statistics

Ctmbits statistics are returned in the Subtract reply when related to a termination with CTM capabilities. Otherwise no statistics are returned.

| +|--------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +### C.8.4 Move + +**Table C.8.4/1: Command Move** + +| | | +|---------------------------|-----| +| Move command used: | Yes | +|---------------------------|-----| + +**Table C.8.4/2: Descriptors used by Move Request** + +| | | +|------------------------------------------|----------------------------------------------------------------| +| Descriptors used by Move request: | Events, Signals, Media (LocalControl, Local And Remote), Audit | +|------------------------------------------|----------------------------------------------------------------| + +**Table C.8.4/3: Descriptors used by Move Reply** + +| | | +|----------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Descriptors used by Move reply: | Media (LocalControl, Local And Remote), Error

When MOVE commands exclude an Audit Descriptor, the MGW response shall only include descriptors which contained underspecified or overspecified properties in the command request, with the exception of the Error Descriptor. Furthermore, only those properties that were underspecified or overspecified in the request shall be sent in the reply.
The applicability of this restriction for text encoding is FFS. | +|----------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +## C.8.5 AuditValue + +**Table C.8.5: Auditvalue** + +| Audited Properties: | Property Name and Identity | Descriptor | +|--------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------| +| Termination ID | TerminationState:
- TDM: ALL (indicating 1 TDM group) , individual termination (NOTE2)
- ATM/IP: individual termination
- Root (MGW Audit) | TerminationState Descriptor | +| Termination ID | For Packages:
- Root | Packages Descriptor (NOTE1) | +| Termination ID | None (MGW Audit) :
- Root | Audit (empty) Descriptor | +| Termination ID | IP Realm Availability :
- ipra/* (ROOT) | TerminationState Descriptor | +| Termination ID | SDPCapNeg Extensions:
- sdpe/* | TerminationState Descriptor | +| Audited Statistics: | None | | +| Audited Signals: | None | | +| Audited Events: | None | | +| Packages Audit Possible | Yes | | + +NOTE1: Support of this capability is optional. +NOTE2: Auditing a single termination of a TDM group is an alternative to the wildcarded audit (TDM: ALL) to derive the service state of the TDM group (all the terminations of the TDM group share the same service state). + +## C.8.6 AuditCapability + +**Table C.8.6/1: Auditcapability** + +| Audited Properties: | Property Name and Identity | Descriptor | +|----------------------------|-----------------------------------|-------------------| +| | FFS | FFS | +| Audited Statistics: | None | | +| Audited Signals: | None | | +| Audited Events: | None | | + +**Table C.8.6/2: Scoped Auditing** + +| | | +|-------------------------------------------------------------------------|------| +| Audited Properties / ContextAttributes used for a scoped audit : | None | +| NOTE: This field requires at least version 3 of the H.248.1 protocol. | | + +## C.8.7 Notify + +**Table C.8.7: Descriptors Used Notify** + +| | | +|------------------------------------------------------------------|-----------------------| +| Descriptors used by Notify Request or Reply: | ObservedEvents, Error | +| NOTE : The Error Descriptor shall not be used in Notify Request. | | + +## C.8.8 ServiceChange + +**Table C.8.8/1: ServiceChangeMethods and ServiceChangeReasons sent by MGC:** + +| Service Change Methods Supported: | ServiceChange Reasons supported: | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------| +| Restart (NOTE1) | "901 Cold Boot" (Optional)
"902 Warm Boot" (Optional) | +| Handoff (NOTE 1, NOTE 2) | "903 MGC Directed Change" (Mandatory) | +| Forced (NOTE1) | "905 Termination Taken Out Of Service" (Optional) | +| Graceful (NOTE1) | "905 Termination Taken Out Of Service" (Optional) | +| NOTE: When a Service Change command on the Root termination with a method other than Graceful is sent, the command shall always be sent as the only command in a message. The sending node shall always wait for the reply to a Service Change command on the Root termination with a method other than Graceful before sending further command requests. A Service Change command on the Root termination with method Graceful may be combined with other commands in a single message. | | +| NOTE1: ROOT Only. | | +| NOTE2: Not involving more than 1 MSC-S. This does not preclude the use of the MGCIId in a ServiceChange (Handoff) scenario, nor does it change the expected MG behaviour upon receipt of such a message, as the MGW has actually no means to differentiate whether the ServiceChangeMgCIId parameter that may be received in a ServiceChange (handoff) message relates to a logical MGC inside the same MSC server or is part of another MSC-Server. | | + +**Table C.8.8/2: ServiceChangeMethods and ServiceChangeReasons sent by MG:** + +| Service Change Methods Supported: | ServiceChange Reasons supported: | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Restart | "900 Service Restored" (Mandatory)
"901 Cold Boot" (Mandatory) (NOTE1)
"902 Warm Boot" (Mandatory) (NOTE1)
"910 Media Capability Failure " ALL except ROOT (Optional)
"913 Signal Capability Failure " ALL except ROOT (Optional)"914 Event Capability Failure " ALL except ROOT (Optional)
"916 Packages Change" (Optional)
"917 Capability Change "(Optional) | +| Graceful | "904 Termination Malfunction" , ALL except ROOT,(Mandatory)
"905 Termination Taken Out Of Service" , ALL,(Mandatory)
"906 Loss Of Lower Layer Connectivity" , ALL except ROOT,(Mandatory)
"907 Transmission Failure" , ALL except ROOT,(Mandatory)
"908 MG Impending Failure" ROOT only (Mandatory) | +| Forced | "904 Termination Malfunction", ALL except ROOT (Mandatory)
"905 Termination Taken Out Of Service" , Mandatory)
"906 Loss Of Lower Layer Connectivity" , ALL except ROOT (Mandatory)
"907 Transmission Failure" , ALL except ROOT (Mandatory)
"908 MG Impending Failure" ROOT only (Mandatory) | +| Handoff (NOTE 1, NOTE 2) | "903 MGC Directed Change" (Mandatory) | +| Disconnected (NOTE 1) | "900 Service Restored" (Mandatory)
"916 Packages Change" (Optional)
"917 Capability Change" (Optional) | +| NOTE: When a Service Change command on the Root termination with a method other than Graceful is sent, the command shall always be sent as the only command in a message. The sending node shall always wait for the reply to a Service Change command on the Root termination with a method other than Graceful before sending further command requests. A Service Change command on the Root termination with method Graceful may be combined with other commands in a single message. | | +| NOTE 1: ROOT Only. | | +| NOTE 2: In response to a MGC Ordered Re-Register. | | + +Table C.8.8/3: Service Change Address + +| | | +|-----------------------------------|----| +| ServiceChangeAddress used: | No | +|-----------------------------------|----| + +Table C.8.8/4: Service Change Delay + +| | | +|---------------------------------|----| +| ServiceChangeDelay used: | No | +|---------------------------------|----| + +Table C.8.8/5: Service Change Incomplete Flag + +| | | +|-----------------------------------------------------------------------|----| +| ServiceChange Incomplete Flag used: | No | +| NOTE: This field requires at least version 3 of the H.248.1 protocol. | | + +Table C.8.8/6: Service Change Version + +| | | +|----------------------------------------------|---| +| Version used in ServiceChangeVersion: | 2 | +|----------------------------------------------|---| + +Table C.8.8/7: Service Change Profile + +| | | +|----------------------------------------|-----| +| ServiceChangeProfile mandatory: | Yes | +|----------------------------------------|-----| + +Table C.8.8/8: Profile negotiation + +| | | +|---------------------------------------------|----| +| Profile negotiation as per H.248.18: | No | +|---------------------------------------------|----| + +## C.8.9 Manipulating and auditing context attributes + +Table C.8.9: Manipulating and auditing context attributes + +| | | +|----------------------------------------|---------------------------------------------------| +| Context Attributes Manipulated: | Topology, Emergency Indicator, Priority Indicator | +| Context Attributes Audited: | None | + +## C.9 Generic command syntax and encoding + +Table C.9.1: Encodings + +| | | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------| +| Supported Encodings: | Binary (optional) (NOTE 2)
Text (optional) (NOTE 1) | +| If binary encoding, is indefinite length encoding supported: | Yes (NOTE 3) | +|

NOTE 1: For a BICC network with IP transport and IPBCP is transported within H.248 messages, text encoding is not recommended to be used on Mc interface until ITU has resolved the contradiction in RFC2327 [34] and H.248.1 [10] on the usage of CR (ASCII carriage return 0x0d) and/or LF (ASCII newline 0x0a) characters e.g. in SDP these Characters are missing when using the currently specified "quotedString" type.

NOTE 2: Binary encoding is strongly recommended if only one encoding is selected to ensure interoperability.

NOTE 3: The binary encoding rules which are applicable to the defined Abstract Syntaxes are the Basic Encoding Rules for Abstract Syntax Notation One, defined in ITU-T Recommendation X.690 [41]. Specifically in accordance with ITU-T Recommendation X.690 [41] section 7.3, alternative encodings based on the definite and indefinite form of length are permitted by the basic encoding rules as a sender's option. Receivers shall support both alternatives.

| | + +## C.10 Transactions + +**Table C.10/1: Transactions per Message** + +| | | +|----------------------------------------------------------------------------------------------------------------------|----| +| Maximum number of TransactionRequests / TransactionReplies / TransResponseAcks / Segment Replies per message: | 10 | +|----------------------------------------------------------------------------------------------------------------------|----| + +**Table C.10/2: Commands per Transaction Requests** + +| | | +|-----------------------------------------------------------|-------------| +| Maximum number of commands per TransactionRequest: | Unspecified | +|-----------------------------------------------------------|-------------| + +**Table C.10/3: Commands per Transaction Reply** + +| | | +|------------------------------------------------------------------------------------------------------------------------------------------|-------------| +| Maximum number of commands per TransactionReply: | Unspecified | +| NOTE: For auditing with wildcarded requests (e.g TDM E1) then the reply may include up to 32 commands to indicate the termination state) | | + +**Table C.10/4: Optional Commands** + +| | | +|-----------------------------------------------|-----| +| Commands able to be marked "Optional": | ALL | +|-----------------------------------------------|-----| + +**Table C.10/5: Commands for Wildcarded Responses** + +| | | +|---------------------------------------------------|------------------------------| +| Wildcarded responses may be requested for: | Modify, Subtract, AuditValue | +|---------------------------------------------------|------------------------------| + +**Table C.10/6: Procedures for Wildcarded Responses** + +| | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------| +| Procedures that make use of wildcarded responses: | Release Bearer, Release Termination, Audit Value | +| NOTE: Used when multiple terminations are released with one command and in audit responses where multiple terminations are implied by the audit request. | | + +**Table C.10/7: Transaction Timers** + +| Transaction Timer: | Value | +|------------------------------------------|--------------| +| normalMGExecutionTime | Provisioned | +| normalMGCExecutionTime | Provisioned | +| MGOriginatedPendingLimit | Provisioned | +| MGCOOriginatedPendingLimit | Provisioned | +| MGProvisionalResponseTimerValue | Provisioned | +| MGCPProvisionalResponseTimerValue | Provisioned | + +## C.11 Messages + +The MGC/MGW shall be named according to the naming structure of the underlying transport protocol which carries the H.248 protocol. + +## C.12 Transport + +**Table C.12/1: Transport** + +| | | +|-----------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Supported Transports: |
  1. 1) For pure IP connections, H.248/SCTP/IP should be used. In addition, to allow for flexible implementations of gateways and controllers in order to offer efficient use of SCTP associations the M3UA layer may also be added on top of SCTP
  2. 2) For pure ATM connections, H.248/MTP3b/SSCF/SSCOP/AAL5/ATM should be used.
  3. 3) For mixed IP&ATM connections, H.248/M3UA/SCTP/IP shall be used as the IP transport.
| +| NOTE1: If using SCTP as defined in IETF RFC 2960 [12] the MGW shall always be the node to perform the "Initiation". | | +| NOTE2: Checksum calculation for SCTP shall be supported as specified in RFC 3309 [44] instead of the method specified in RFC 2960 [12]. | | + +**Table C.12/2: Segmentation** + +| | | +|-----------------------------------------------------------------------|----| +| Segmentation Supported: | No | +| NOTE: This field requires at least version 3 of the H.248.1 protocol. | | + +**Table C.12/3: Support of Control Association Monitoring** + +| | | +|--------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Control Association Monitoring Supported: |
  1. 1. Inherent in Transport
  2. 2. H.248.14 (optional MGW-driven monitoring)
  3. 3. Empty AuditValue on Root (MGC-driven monitoring)
| +|--------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +## C.13 Security + +**Table C.13: Security** + +| | | +|----------------------------|------| +| Supported Security: | None | +|----------------------------|------| + +## C.14 Packages + +**Table C.14/1: Mandatory packages** + +| Mandatory Packages: | | | +|----------------------------------------------------------------------------------------------|-------------------------------|----------------| +| Package Name | PackageID | Version | +| Generic (see ITU-T Recommendation H.248.1 [10] annex E.1) | g, (0x0001) | v1 | +| Base Root Package (see ITU-T Recommendation H.248.1 [10] annex E.2) | root, (0x0002) | v2 | +| Tone Detection Package (see ITU-T Recommendation H.248.1 [10] annex E.4) | tonedet, (0x0004)
(NOTE 1) | v1 | +| Basic DTMF Generator Package (see ITU-T Recommendation H.248.1 [10] annex E.5) | dg, (0x0005) | v1 | +| DTMF Detection Package (see ITU-T Recommendation H.248.1 [10] annex E.6) | dd, (0x0006) | v1 | +| Generic Announcement Package (see ITU-T Recommendation H.248.7 [28]) – Fixed Announcements. | an, (0x001d) | v1 | +| TDM Circuit Package (see ITU-T Recommendation H.248.1 [10] annex E.13)
NOTE 2 | tdmc, (0x000d) | v1 | +| Media Gateway Resource Congestion Handling Package (see ITU-T Recommendation H.248.10 [15] ) | chp, (0x0029) | v1 | +| Hanging Termination Detection package (see ITU-T Recommendation H.248.36 [36]). | hangterm, (0x0098) | v1 | + +NOTE 1: This package is "for extension only" and shall not be published over the Mc interface. + +NOTE 2: Network Package is not supported. + +Table C.14/2: Optional packages + +| Optional Packages: | | | | +|-----------------------------------------------------------------------------------------------------------|----------------------|---------|---------------------------------------------| +| Package Name | PackageID | Version | Support dependent on: | +| Basic Call Progress Tones Generator with Directionality, (see ITU-T Recommendation Q.1950 [23] annex A.8) | bcg, (0x0023) | v1 | Services provided by network | +| Expanded Call Progress tones Generator Package (see ITU-T Recommendation Q.1950 [23] annex A.9) | xcg, (0x0024) | v1 | Services provided by network | +| Basic Services Tones Generation Package (see ITU-T Recommendation Q.1950 [23] annex A.10) | srvtn, (0x0025) | v1 | Services provided by network | +| Bearer Control Tunnelling Package (see ITU-T Recommendation Q.1950 [23] annex A.7) | Bt, (0x0022) | v1 | Interworking with BICC and IP transport | +| Expanded Services Tones Generation Package (see ITU-T Recommendation Q.1950 [23] annex A.11) | xsrvtn, (0x0026) | v1 | Services provided by network | +| Intrusion Tones Generation Package (see ITU-T Recommendation Q.1950 [23] annex A.12) | Int, (0x0027) | v1 | Services provided by network | +| Business Tones Generation Package (see ITU-T Recommendation Q.1950 [23] annex A.13) | BIZTN, (0x0028) | v1 | Services provided by network | +| Tone Generator Package (see ITU-T Recommendation H.248.1 [10] annex E.3) | tongen, (0x0003) | v1 | (NOTE) | +| Generic Announcement Package (see ITU-T Recommendation H.248.7 [28]) – Variable Announcements | an, (0x001d) | v1 | Variable Announcements | +| Text Telephony Package (see ITU-T Recommendation H.248.2 [17]). | txp, (0x0010) | v1 | Global text telephony support | +| Call Discrimination package (see ITU-T Recommendation H.248.2 [17]). | ctyp, (0x0011) | v2 | Global text telephony support | +| Basic Continuity Package (see ITU-T Recommendation H.248.1 [10] annex E.10). | ct, (0x000a) | v1 | Only required for TDM side terminations | +| Circuit Switched Data package (see subclause 15.2.1); | threegcd, (0x0030) | v1 | Circuit Switched Data support | +| TFO package (see subclause 15.2.2); | threegtfoc, (0x0031) | v2 | TFO support | +| 3G Expanded Call Progress Tones Generator package (see subclause 15.2.3); | threegxcg, (0x0032) | v1 | Services provided by network | +| Modification of Link Characteristics Bearer Capability package (see subclause 15.2.4); | threegmlc, (0x0046) | v1 | | +| Enhanced Circuit Switched Data package (see subclause 15.2.5); | threegcden,(0x0082) | v1 | Circuit Switched Data support | +| Cellular Text telephone Modem Text Transport package (see subclause 15.2.6); | threegctm, (0x0068) | v1 | Global text telephony support | +| Flexible Tone Generator Package (see subclause 15.2.8). | threegflex, (0x0084) | v1 | Services provided by network | +| Trace Package (see subclause 15.2.9) | calltrace, (0x0097) | v1 | | +| ASCI Group call package (see subclause 15.2.10) | threegasci, (0x00b2) | v2 | VGCS and VBS services supported | +| IP Domain connection package (see ITU-T Recommendation H.248.41 [42]) | ipdc, (0x009d) | v1 | Multiple IP realms supported | +| Inactivity timer package (see ITU-T Recommendation. H248.14 [45]) | it, (0x0045) | v1 | UDP transport supported | +| 3GUP (User Plane) package (see subclause 15.1.1) | threegup, (0x002f) | v1 | Mandatory for BICC and Iu terminations | +| Bearer Characteristics Package (see ITU-T Recommendation Q.1950 [23] annex A.3) | bcp, (0x001e) | v2 | Mandatory for BICC terminations | +| Generic Bearer Connection Package (see ITU-T Recommendation Q.1950 [23] annex A.6) | Gb, (0x0021) | v1 | Mandatory only for BICC and Iu terminations | +| 3G Interface Type package (see subclause 15.2.11) | threegint (0x00e3) | v1 | | +| RTP Control Protocol Package (ITU-T Recommendation H.248.57 [66]) | rtcp.h. (0x00b5) | v1 | Border control functions support | +| Gate management Source Address/Port Filtering Package (ITU-T Recommendation H.248.43, Clause 7 [67]) | gm, (0x008c) | v2 | Border control functions support | +| Traffic management (ITU-T Recommendation H.248.53 [69]) | tman, (0x008d) | v1 | Border control functions support | +| Diffserv (ITU-T Recommendation H.248.52 [70]) | ds, (0x008b) | v2 | Border control functions support | + +| | | | | +|----------------------------------------------------------------------------------------------------|-------------------|----|---------------------------------------------------------------------------------------| +| Application Data Inactivity Detection (ITU-T Recommendation H.248.40 [71]) | adid (0x009c) | v1 | Border control functions support | +| IP realm availability (ITU-T Recommendation H.248.41 Amendment 1) [72] | ipra (0x00e0) | v1 | Border control functions support | +| Explicit Congestion Notification for RTP-over-UDP Support (see ITU-T Recommendation H.248.82 [79]) | ecnrous(0x010b) | v1 | Support of ECN feature | +| MG Act-as STUN Server (ITU-T Recommendation H.248.50 [81]) | mgastuns (0x00c2) | v1 | Support of incoming STUN connectivity checks.
Applicable for ICE lite and full ICE | +| Originate STUN Continuity Check (see ITU-T Recommendation H.248.50 [81]) | ostuncc (0x00c3) | v1 | Support of originating STUN connectivity checks
Only applicable for full ICE | +| Enhanced Revised Offer/Answer SDP Support (ITU-T Recommendation H.248.80 [85]) | eroas, (0x0109) | v1 | Support of the SDP Capability Negotiation syntax | +| NOTE: This package is "for extension only" and shall not be published over the Mc interface. | | | | + +#### Package Usage Information + +This table specifies how the packages above will be used. For example: + +- it lists whether the properties/signals/events/statistics are optional or mandatory +- if the value of the property/signal/event provisioned the provisioned value should be specified. (e.g. names and number of cycles for an H.248.7 announcement). + +Specifies the values of properties which are specified as provisioned + +Package Usage Information: + +## C.14.1 Generic Package + +Table C.14.1: Package Usage Information For Generic Package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|------------------------------------------|--------------------------------------|---------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------|--|--| +| None | - | - | - | - | | | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | | | +| None | - | - | - | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | | | +| | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command: | | | | | +| | M | ADD, MOD, NOTIFY | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | None | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| Cause (g/cause, 0x0001/0x0001) | General Cause (GeneralCause, 0x0001) | M | "NR" (0x0001) Normal Release
"UR" (0x0002) Unavailable Resources
"FT" (0x0003) Failure, Temporary
"FP" (0x0004) Failure, Permanent
"IW" (0x0005) Interworking Error
"UN" (0x0006) Unsupported | Not Applicable | | | +| | Failure Cause (FailureCause, 0x0002) | O | Octet String | Not Applicable | | | +| Events | Mandatory/Optional | Used in command: | | | | | +| | M | ADD, MOD, MOVE, NOTIFY | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | None | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| Signal Completion. (g/sc, 0x0001/0x0002) | Signal Identity (SigID, 0x0001) | M | pkgdName syntax | Not Applicable | | | +| | Termination Method (Meth, 0x0002) | M | "TO" (0x0001) Signal timed out or otherwise completed on its own
"EV" (0x0002) Interrupted by event
"SD" (0x0003) Halted by new Signals descriptor
"NC" (0x0004) Not completed, other cause | Not Applicable | | | +| | Signal List Id | O | Integer | Not Applicable | | | +| Statistics | Mandatory/Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +## C.14.2 Base Root Package + +Table C.14.2: Package Usage Information For Base Root Package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|--------------------------------------------------------------------------------------------|--------------------------|---------------------|------------------------------------------------------------|-----------------------------|--|--| +| MaxNrOfContexts
(root/numberOfContexts, 0x0002/0x0001) | O | Not used in command | 1 and up | Not Applicable | | | +| MaxTerminationsPerContext
(root/maxTerminationPerContext, 0x0002/0x0002) | O | Not used in command | See C.4 | Not Applicable | | | +| normalMGExecutionTime
(root/normalMGExecutionTime, 0x0002/0x0003) | O | Not used in command | Integer | Operator Defined | | | +| normalMGCEExecutionTime
(root/normalMGCEExecutionTime, 0x0002/0x0004) | O | Not used in command | Integer | Operator Defined | | | +| MGProvisionalResponseTimerValue
(root/MGProvisionalResponseTimerValue, 0x0002/0x0005) | O | Not used in command | Integer (initially NormalMGExecutionTime + networkdelay) | Operator Defined | | | +| MGCProvisionalResponseTimerValue
(root/MGCProvisionalResponseTimerValue, 0x0002/0x0006) | O | Not used in command | Integer (initially NormalMGCEExecutionTime + networkdelay) | Operator Defined | | | +| MGCOriGINatedPendingLimit
(root/MGCOriGINatedPendingLimit, 0x0002/0x0007) | O | Not used in command | Integer | Operator Defined | | | +| MGCOriGINatedPendingLimit
(root/MGCOriGINatedPendingLimit, 0x0002/0x0008) | O | Not used in command | Integer | Operator Defined | | | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | | | +| None | - | - | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | | | +| | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command: | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| Statistics | Mandatory/Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +## C.14.3 Tone Generator Package + +Table C.14.3: Package Usage Information For Tone Generator Package + +| Properties | Mandatory/ Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|-----------------------------------------|---------------------------------|----------------------------|--------------------------|------------------------------------|--|--| +| None | - | - | - | - | | | +| Signals | Mandatory/ Optional | Used in command: | | Duration Provisioned Value: | | | +| Play Tone
(tonegen/pt,0x0003/0x0001) | Not Used | - | - | - | | | +| | Signal Parameters | Mandatory/ Optional | Supported Values: | Duration Provisioned Value: | | | +| | - | - | - | - | | | +| Events | Mandatory/ Optional | Used in command: | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| Statistics | Mandatory/ Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +## C.14.4 Tone Detection Package + +Table C.14.4: Package Usage Information For Tone Detection Package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|--------------------------------------------------|---------------------------------|---------------------------|--------------------------|------------------------------------|--|--| +| None | - | - | - | - | | | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | | | +| None | - | - | - | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | | | +| | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command: | | | | | +| Start tone detected (tonedet/std, 0x0004/0x0001) | O | ADD, MOD, MOVE, NOTIFY | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | Tone ID List (tl,0x0001) | M | wildcard | Not Applicable | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | Tone ID (tid,0x0003) | M | Value | Not Applicable | | | +| Events | Mandatory/Optional | Used in command: | | | | | +| End Tone detected (tonedet/etd, 0x0004/0x0002) | M | ADD, MOD, MOVE, NOTIFY | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | Tone ID List (tl,0x0001) | M | wildcard | Not Applicable | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | Tone ID (tid,0x0003) | M | Value | Not Applicable | | | +| | Duration (dur,0x0002) | O | Value | Not Applicable | | | +| Events | Mandatory/Optional | Used in command: | | | | | +| Long Tone detected (tonedet/ltd, 0x0004/0x0003) | Not Used | - | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| Statistics | Mandatory/Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +## C.14.5 Basic DTMF Generator Package + +Table C.14.5: Package Usage Information For Basic DTMF Generator Package + +| Properties | Mandatory/ Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|-------------------------------------------|---------------------------------|----------------------------|--------------------------|------------------------------------|--|--| +| None | - | - | - | - | | | +| Signals | Mandatory/ Optional | Used in command: | | Duration Provisioned Value: | | | +| DTMF character 0
(dg/d0,0x0005/0x0010) | M | ADD, MOD, MOVE | | | | | +| DTMF character 1
(dg/d1,0x0005/0x0011) | Signal Parameters | Mandatory/ Optional | Supported Values: | Duration Provisioned Value: | | | +| DTMF character 2
(dg/d2,0x0005/0x0012) | None | - | - | - | | | +| DTMF character 3
(dg/d3,0x0005/0x0013) | | | | | | | +| DTMF character 4
(dg/d4,0x0005/0x0014) | | | | | | | +| DTMF character 5
(dg/d5,0x0005/0x0015) | | | | | | | +| DTMF character 6
(dg/d6,0x0005/0x0016) | | | | | | | +| DTMF character 7
(dg/d7,0x0005/0x0017) | | | | | | | +| DTMF character 8
(dg/d8,0x0005/0x0018) | | | | | | | +| DTMF character 9
(dg/d9,0x0005/0x0019) | | | | | | | +| DTMF character *
(dg/ds,0x0005/0x0020) | | | | | | | +| DTMF character #
(dg/do,0x0005/0x0021) | | | | | | | +| DTMF character A
(dg/da,0x0005/0x001a) | | | | | | | +| DTMF character B
(dg/db,0x0005/0x001b) | | | | | | | +| DTMF character C
(dg/dc,0x0005/0x001c) | | | | | | | +| DTMF character D
(dg/dd,0x0005/0x001d) | | | | | | | +| Events | Mandatory/ Optional | Used in command: | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| Statistics | Mandatory/ Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +## C.14.6 Basic DTMF Detection Package + +Table C.14.6: Package Usage Information For Basic DTMF Generator Package + +| Properties | Mandatory/ Optional | Used in command: | Supported Values: | Provisioned Value: | +|------------|---------------------|------------------|-------------------|--------------------| +| None | - | - | - | - | + +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | | | +|-------------------------------------------|--------------------------|--------------------|-------------------|-----------------------------|--|--| +| None | - | - | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | | | +| | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command: | | | | | +| DTMF character 0
(dd/d0,0x0006/0x0010) | M | ADD, MOD, NOTIFY | | | | | +| DTMF character 1
(dd/d1,0x0006/0x0011) | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| DTMF character 2
(dd/d2,0x0006/0x0012) | None | - | - | - | | | +| DTMF character 3
(dd/d3,0x0006/0x0013) | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| DTMF character 4
(dd/d4,0x0006/0x0014) | None | - | - | - | | | +| DTMF character 5
(dd/d5,0x0006/0x0015) | | | | | | | +| DTMF character 6
(dd/d6,0x0006/0x0016) | | | | | | | +| DTMF character 7
(dd/d7,0x0006/0x0017) | | | | | | | +| DTMF character 8
(dd/d8,0x0006/0x0018) | | | | | | | +| DTMF character 9
(dd/d9,0x0006/0x0019) | | | | | | | +| DTMF character *
(dd/ds,0x0006/0x0020) | | | | | | | +| DTMF character #
(dd/d0,0x0006/0x0021) | | | | | | | +| DTMF character A
(dd/da,0x0006/0x001a) | | | | | | | +| DTMF character B
(dd/db,0x0006/0x001b) | | | | | | | +| DTMF character C
(dd/dc,0x0006/0x001c) | | | | | | | +| DTMF character D
(dd/dd,0x0006/0x001d) | | | | | | | +| Events | Mandatory/Optional | Used in command: | | | | | +| | Not used | - | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| Statistics | Mandatory/Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +## C.14.7 Continuity Package + +Table C.14.7: Package Usage Information For Basic Continuity Package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | +|------------|--------------------|------------------|-------------------|--------------------| +| None | - | - | - | - | + +| Signals | Mandatory/
Optional
| Used in command: | | Duration Provisioned
Value:
| | | +|---------------------------------------------------------------------------------------|-------------------------------------|--------------------------------|------------------------------|----------------------------------------|--|--| +| Continuity Test
(ct/ct,
0x000a/0x0003)
Respond
(ct/rsp,
0x000a/0x0004) | M | ADD, MOD, MOVE | | Default | | | +| | Signal Parameters | Mandatory/
Optional
| Supported
Values:
| Duration Provisioned
Value:
| | | +| | None | - | - | - | | | +| Events | Mandatory/
Optional
| Used in command: | | | | | +| Completion,
(ct/cmp,
0x000a/0x0005) | M | ADD, NOTIFY | | | | | +| | Event
Parameters
| Mandatory/
Optional
| Supported
Values:
| Provisioned Value: | | | +| | None | - | - | - | | | +| | ObservedEvent
Parameters
| Mandatory/
Optional
| Supported
Values:
| Provisioned Value: | | | +| | Result (res,0x0008) | M | success, failure | Not Applicable | | | +| Statistics | Mandatory/
Optional
| Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +## C.14.8 TDM Circuit Package + +Table C.14.8: Package Usage Information For TDM Circuit Package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|-------------------------------------------|--------------------------|--------------------|-------------------|-----------------------------|--|--| +| Echo Cancellation (tdmc/ec,0x000d/0x0008) | M | ADD, MOD, MOVE | ALL | Default=off (False) | | | +| Gain Control (tdmc/gain,0x000d/0x000a) | Not Used | - | - | - | | | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | | | +| None | - | - | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | | | +| | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command: | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| Statistics | Mandatory/Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +## C.14.9 Text Telephony Package + +**Table C.14.9: Package Usage Information For Text Telephony Package** + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|---------------------------------------------------------------------------|--------------------------------------|------------------------|---------------------|-----------------------------|--|--| +| Conversation mode
(txp/convmode,
0x0010/0x0001) | O | ADD, MOD, MOVE | ALL | None | | | +| Communication Mode
(txp/commode,
0x0010/0x0002) | O | ADD, MOD, MOVE | ALL | None | | | +| Connection Mode
(txp/connmode,
0x0010/0x0003) | O | ADD, MOD, MOVE | ALL | None | | | +| Action at Loss of
Connection
(txp/lossconnection,
0x0010/0x0006) | O | ADD, MOD, MOVE | ALL | None | | | +| V18 Options
(txp/v18opt,
0x0010/0x0007) | O | ADD, MOD, MOVE | ALL | None | | | +| Character Set
(txp/characterset,
0x0010/0x0008) | O | ADD, MOD, MOVE | ALL | None | | | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | | | +| None | - | - | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | | | +| | - | - | | - | | | +| Events | Mandatory/Optional | Used in command: | | | | | +| Connection Mode Changed
(txp/connchg,
0x0010/0x0001) | O | ADD, MOD, MOVE, NOTIFY | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | None | - | | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | Communication Mode (commode, 0x0002) | O | As property commode | - | | | +| Statistics | Mandatory/Optional | Used in command: | | Supported Values: | | | +| Number of Characters Transferred
(txp/chartrans,
0x0010/0x0001) | O | SUBTRACT | | | | | +| Number of Alternating Turns
(txp/altturns,
0x0010/0x0002) | O | SUBTRACT | | | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +## C.14.10 Call Discrimination Package + +Table C.14.10: Package Usage Information For Call Discrimination Package + +| Properties | Mandatory/
Optional | Used in
command: | Supported
Values: | Provisioned
Value: | +|-----------------------------------------------------------------------------------|------------------------------------------------------|------------------------|----------------------|-----------------------------------| +| Call Types (ctyp/calltyp, 0x0011/0x0001) | O | ADD, MOD, MOVE | ALL | None | +| Text Call Types (ctyp/ttyp, 0x0011/0x0002) | O | ADD, MOD, MOVE | ALL | None | +| V8bis Support (ctyp/v8bsup, 0x0011/0x0003) | O | ADD, MOD, MOVE | ALL | None | +| Probe Message (ctyp/probmsg, 0x0011/0x0004) | O | ADD, MOD, MOVE | ALL | None | +| Probe Order (ctyp/probeorder, 0x0011/0x0005) | O | ADD, MOD, MOVE | ALL | None | +| Phase Reversal Detect (ctyp/phrevdet, 0x0011/0x0006) | O | ADD, MOD, MOVE | ALL | None | +| MG Responsible for Call Discrimination Signalling (ctyp/MGCallSig, 0x0011/0x0007) | O | ADD, MOD, MOVE | ALL | None | +| Signals | Mandatory/
Optional | Used in command: | | Duration
Provisioned
Value: | +| V8 Signal (ctyp/v8sig, 0x0011/0x0001) | O | MOD | | - | +| | Signal Parameters | Mandatory/
Optional | Supported
Values: | Duration
Provisioned
Value: | +| | V.8 Signal Type (ctyp/v8styp, 0x0011/0x0001) | O | ALL | - | +| | V8Sig Cont (ctyp/v8scont, 0x0011/0x0002) | O | ALL | - | +| | V18 XCI Enable (ctyp/v18xcien, 0x0011/0x0003) | O | ALL | - | +| Answer Signal (ctyp/ans, 0x0011/0x0002) | O | MOD | | - | +| | Signal Parameters | Mandatory/
Optional | Supported
Values: | Duration
Provisioned
Value: | +| | ANS Type (ctyp/AnsType, 0x0011/0x0001) | O | ALL | - | +| Calling Signal (ctyp/callsig, 0x0011/0x0003) | O | MOD | | - | +| | Signal Parameters | Mandatory/
Optional | Supported
Values: | Duration
Provisioned
Value: | +| | Call Signal Name (ctyp/csn, 0x0011/0x0001) | O | ALL | - | +| V8bis Signal | O | MOD | | - | +| | Signal Parameters | Mandatory/
Optional | Supported
Values: | Duration
Provisioned
Value: | +| | V8bisSigname (ctyp/V8bsn, 0x0011/0x0001) | O | ALL | - | +| | V8bis Signal Contents (ctyp/V8bscont, 0x0011/0x0002) | O | ALL | - | +| V18 Probe (ctyp/v18prob, 0x0011/0x0005) | O | MOD | | - | +| | Signal Parameters | Mandatory/
Optional | Supported
Values: | Duration
Provisioned
Value: | +| | None | - | - | - | + +| Events | Mandatory/
Optional
| Used in command: | | | | | +|---------------------------------------------------------------------|------------------------------------------------|--------------------------------|------------------------------|-------------------------------|--|--| +| Discriminating Tone Detected
(ctyp/dtone, 0x0011/0x0001) | O | ADD, MOD, NOTIFY | | | | | +| | Event
Parameters
| Mandatory/
Optional
| Supported
Values:
| Provisioned
Value:
| | | +| | None | - | - | - | | | +| | ObservedEvent
Parameters
| Mandatory/
Optional
| Supported
Values:
| Provisioned
Value:
| | | +| | Discriminating Tone Type
(dtt,0x0001) | O | ALL | - | | | +| | Discriminating Tone Value
(dtvalue, 0x0002) | O | ALL | - | | | +| | V8bis Type (v8bist,
0x0003) | O | ALL | - | | | +| Call Type Discrimination Result
(ctyp/calldisres, 0x0011/0x0002) | O | ADD, MOD, NOTIFY | | | | | +| | Event
Parameters
| Mandatory/
Optional
| Supported
Values:
| Provisioned
Value:
| | | +| | None | - | - | - | | | +| | ObservedEvent
Parameters
| Mandatory/
Optional
| Supported
Values:
| Provisioned
Value:
| | | +| | Discriminated Call Type
(dct,0x0001) | O | ALL | - | | | +| Statistics | Mandatory/
Optional
| Used in command: | | Supported
Values:
| | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +## C.14.11 Announcement Package + +Table C.14.11: Package Usage Information For Announcement Package + +| Properties | Mandatory/ Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|----------------------------------------------------|--------------------------------------------------|----------------------------|--------------------------|------------------------------------|--|--| +| None | - | - | - | - | | | +| Signals | Mandatory/ Optional | Used in command: | | Duration Provisioned Value: | | | +| Fixed Announcement Play (an/apf, 0x001d/0x0001) | M | ADD, MOD, MOVE | | Signal Parameters | Mandatory/ Optional | Supported Values: | Duration Provisioned Value: | | | +| | Announcement name (an,0x0001) | M | enumeration | Not Applicable | | | +| | Number Of Cycles (noc,0x0002) | M | Any Integer | - | | | +| | Announcement Variant (av,0x0003) | O | string | - | | | +| | Announcement Direction (di,0x0004) | M | Internal, External | Default=External | | | +| Variable Announcement Play (an/apv, 0x001d/0x0002) | O | ADD, MOD, MOVE | | | | | +| | Signal Parameters | Mandatory/ Optional | Supported Values: | Duration Provisioned Value: | | | +| | Announcement name (an,0x0001) | M | enumeration | Not Applicable | | | +| | Number Of Cycles (noc,0x0002) | M | Any Integer | - | | | +| | Announcement Variant (av,0x0003) | O | string | - | | | +| | Number (num,0x0004) | O | integer | - | | | +| | Specific parameters interpretation (spi, 0x0005) | O | enumeration | - | | | +| | Specific parameters (sp,0x0006) | O | string | - | | | +| | Announcement Direction (di,0x0006) | M | Internal, External | Default=External | | | +| Events | Mandatory/ Optional | Used in command: | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| Statistics | Mandatory/ Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +## C.14.12 Media Gateway Resource Congestion handling Package + +Table C.14.12: Package Usage Information For Media Gateway Resource Congestion handling Package + +| Properties | Mandatory/ Optional | Used in command: | Supported Values: | Provisioned Value: | +|----------------------------------|---------------------------------|----------------------------|--------------------------|------------------------------------| +| None | - | - | - | - | +| Signals | Mandatory/ Optional | Used in command: | | Duration Provisioned Value: | +| None | - | - | - | - | +| | Signal Parameters | Mandatory/ Optional | Supported Values: | Duration Provisioned Value: | +| | - | - | - | - | +| Events | Mandatory/ Optional | Used in command: | | | +| MGCon (chp/mgcon, 0x0029/0x0001) | M | MOD, NOTIFY | | | +| | Event Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | +| | None | - | - | - | +| | ObservedEvent Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | +| | Reduction (reduction, 0x0001) | M | 0-100 | Not Applicable | +| Statistics | Mandatory/ Optional | Used in command: | | Supported Values: | +| None | - | - | - | - | +| Error Codes | Mandatory/ Optional | | | | +| None | - | | | | + +## C.14.13 Hanging Termination Detection Package + +Table C.14.13: Package Usage Information For Hanging Termination Detection Package + +| Properties | Mandatory/ Optional | Used in command: | Supported Values: | Provisioned Value: | +|-----------------------------------------------------|---------------------------------|------------------------------------|--------------------------|------------------------------------| +| None | - | - | - | - | +| Signals | Mandatory/ Optional | Used in command: | | Duration Provisioned Value: | +| None | - | - | - | - | +| | Signal Parameters | Mandatory/ Optional | Supported Values: | Duration Provisioned Value: | +| | - | - | - | - | +| Events | Mandatory/ Optional | Used in command: | | | +| Termination Heartbeat (hangterm/thb, 0x0098/0x0001) | M | ADD, MOD, MOVE, AUDITVALUE, NOTIFY | | | +| | Event Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | +| | Timer X (timerx, 0x0001) | M | ALL | 0 (no heartbeat message) | +| | ObservedEvent Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | +| | None | - | - | - | +| Statistics | Mandatory/ Optional | Used in command: | | Supported Values: | +| None | - | - | - | - | +| Error Codes | Mandatory/ Optional | | | | +| None | - | | | | + +## C.14.14 Bearer Characteristics Package + +**Table C.14.14: Package Usage Information For Bearer Characteristics Package** + +| Properties | Mandatory/ Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|--------------------------------------------------|---------------------------------|----------------------------|--------------------------|------------------------------------|--|--| +| BNC Characteristics
(BCP/BNCChar,0x001e/0x01) | M | ADD | AAL type 2 /
IP/RTP | Not Applicable | | | +| Signals | Mandatory/ Optional | Used in command: | | Duration Provisioned Value: | | | +| None | - | - | | - | | | +| | Signal Parameters | Mandatory/ Optional | Supported Values: | Duration Provisioned Value: | | | +| | - | - | - | - | | | +| Events | Mandatory/ Optional | Used in command: | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| Statistics | Mandatory/ Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +## C.14.15 Generic Bearer Connection Package + +Table C.14.15: Package Usage Information For Generic Bearer Connection Package + +| Properties | Mandatory/ Optional | Used in command: | Supported Values: | Provisioned Value: | +|-------------------------------------------|--------------------------------------|----------------------------|--------------------------------------------------------------------------------------------------------------------------------|------------------------------------| +| None | - | - | - | - | +| Signals | Mandatory/ Optional | Used in command: | | Duration Provisioned Value: | +| Establish BNC
(GB/EstBNC, 0x0021/0x01) | M | | ADD, MOD | Not Applicable | +| | Signal Parameters | Mandatory/ Optional | Supported Values: | Duration Provisioned Value: | +| | Not Applicable | - | - | Not Applicable | +| Modify BNC
(GB/ModBNC, 0x0021/0x02) | O | | MOD | Not Applicable | +| | Signal Parameters | Mandatory/ Optional | Supported Values: | Duration Provisioned Value: | +| | Not Applicable | - | - | Not Applicable | +| Release BNC
(GB/RelBNC, 0x0021/0x03) | M (NOTE) | | MOD | Not Applicable | +| | Signal Parameters | Mandatory/ Optional | Supported Values: | Duration Provisioned Value: | +| | General cause
(Generalcause,0x01) | O | Normal Release/
Unavailable
Resources/ Failure
Temporary/ Failure
Permanent/
Interworking Error/
Unsupported | Not Applicable | +| | Failure Cause
(Failurecause,0x02) | O | OCTET STRING | Not Applicable | +| | Reset (Reset,0x03) | O | 0/ 1 | Not Applicable | +| Events | Mandatory/ Optional | Used in command: | | | +| BNC Change
(GB/BNCChange, 0x0021/0x01) | M | | ADD, MOD, NOTIFY | | +| | Event Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | +| | Type (Type ,0x01) | M | Bearer Established /
Bearer Modified/
Bearer Modification
Failure | Not Applicable | +| | ObservedEvent Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | +| | Type (Type,0x01) | M | Bearer Established /
Bearer Modified/
Bearer Modification
Failure | Not Applicable | +| Statistics | Mandatory/ Optional | Used in command: | | Supported Values: | +| None | - | | - | - | +| Error Codes | Mandatory/ Optional | | | | +| None | - | | | | + +NOTE: Mandatory for BICC ATM Terminations. If received as part of a wildcarded command including other types of terminations then for other type of terminations no action is required from MGW, but a successful command reply. + +## C.14.16 Bearer Control Tunneling Package + +Table C.14.16: Package Usage Information For Bearer Control Tunneling Package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|----------------------------------------------------|------------------------------------------|---------------------------|--------------------------|------------------------------------|--|--| +| Tunneling Options (BT/TunOpt, 0x0022/0x01) | M | ADD | 1 /2 | Not Applicable | | | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | | | +| Bearer Information Transport (BT/BIT, 0x0022/0x01) | M | ADD, MOD | | Not Applicable | | | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | | | +| | Bearer Information Tunnel (BIT, 0x01) | M | Octet String | Not Applicable | | | +| Events | Mandatory/Optional | Used in command: | | | | | +| Tunnel Indication (BT/TIND, 0x0022/0x01) | M | ADD, MOD, NOTIFY | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | Not applicable | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | Bearer Information transport (BIT, 0x01) | M | Octet String | Not Applicable | | | +| Statistics | Mandatory/Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +## C.14.17 Basic Call Progress Tones Generator with Directionality + +**Table C.14.17: Package Usage Information For Basic Call Progress Tones Generator with Directionality Package** + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------|---------------------------|--------------------------|------------------------------------|--|--| +| None | - | - | - | - | | | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | | | +| Dial Tone (bcg/bdt, 0x0023/0x0040)
Ringing Tone (bcg/brt, 0x0023/0x0041)
Busy Tone (bcg/bbt, 0x0023/0x0042)
Congestion Tone (bcg/bct, 0x0023/0x0043)
Special Information Tone (bcg/bsit, 0x0023/0x0044)
Warning Tone (bcg/bwt, 0x0023/0x0045)
Payphone Recognition Tone (bcg/bpt, 0x0023/0x0046)
Call Waiting Tone (bcg/bcw, 0x0023/0x0047)
Caller Waiting Tone (bcg/bcr, 0x0023/0x0048)
Pay Tone (bcg/bpy, 0x0023/0x0049) | O | ADD, MOD, MOVE | | Value | | | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | | | +| | Tone Direction (btd, 0x0001) | M | Internal / External | Default=External | | | +| Events | Mandatory/Optional | Used in command: | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| Statistics | Mandatory/Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +## C.14.18 Expanded Call Progress Tones Generator Package + +**Table C.14.18: Package Usage Information For Expanded Call Progress Tones Generator Package** + +| Properties | Mandatory/ Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------|----------------------------|--------------------------|------------------------------------|--|--| +| None | - | - | - | - | | | +| Signals | Mandatory/ Optional | Used in command: | | Duration Provisioned Value: | | | +| Comfort Tone (xcg/cmft,0x0024/0x004a)
Off-hook warning Tone (xcg/roh, 0x0024/0x004b)
Negative Acknowledgement (xcg/nack,0x0024/0x004c)
Vacant Number Tone (xcg/vac, 0x0024/0x004d)
Special Conditions Dial Tone (xcg/spec,0x0024/0x004e) | O | ADD, MOD, MOVE | | Value | | | +| | Signal Parameters | Mandatory/ Optional | Supported Values: | Duration Provisioned Value: | | | +| | Tone Direction (btd, 0x0001) | M | Internal / External | Default=External | | | +| Events | Mandatory/ Optional | Used in command: | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| Statistics | Mandatory/ Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +## C.14.19 Basic Services Tones Generation Package + +Table C.14.19: Package Usage Information For Basic Services Tones Generation Package + +| Properties | Mandatory/ Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------|----------------------------|--------------------------|------------------------------------|--|--| +| None | - | - | - | - | | | +| Signals | Mandatory/ Optional | Used in command: | | Duration Provisioned Value: | | | +| Recall Dial Tone
(srvtn/rdt,0x0025/0x004f)
Confirmation Tone
(srvtn/conf,0x0025/0x0050)
Held Tone
(srvtn/ht,0x0025/0x0051)
Message Waiting Tone
(srvtn/mwt,0x0025/0x0052) | O | ADD, MOD, MOVE | | Value | | | +| | Signal Parameters | Mandatory/ Optional | Supported Values: | Duration Provisioned Value: | | | +| | Tone Direction
(btd, 0x0001) | M | Internal / External | Default=External | | | +| Events | Mandatory/ Optional | Used in command: | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| Statistics | Mandatory/ Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +## C.14.20 Expanded Services Tones Generation Package + +Table C.14.20: Package Usage Information For Expanded Services Tones Generation Package + +| Properties | Mandatory/ Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------|----------------------------|--------------------------|------------------------------------|--|--| +| None | - | - | - | - | | | +| Signals | Mandatory/ Optional | Used in command: | | Duration Provisioned Value: | | | +| Call Transfer Dial Tone (xsrvtm/xferdt,0x0026/0x0053)
Call Forward Tone (xsrvtm/cft,0x0026/0x0054)
Credit Card service Tone (xsrvtm/ccst,0x0026/0x0055)
Special Recall Dial Tone (xsrvtm/srdt,0x0026/0x0056) | O | ADD, MOD, MOVE | | Value | | | +| | Signal Parameters | Mandatory/ Optional | Supported Values: | Duration Provisioned Value: | | | +| | Tone Direction (btd, 0x0001) | M | Internal / External | Default=External | | | +| Events | Mandatory/ Optional | Used in command: | | | | | +| None | - | | - | | | | +| | Event Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| Statistics | Mandatory/ Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +## C.14.21 Intrusion Tones Generation Package + +Table C.14.21: Package Usage Information For Intrusion Tones Generation Package + +| Properties | Mandatory/ Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------|----------------------------|--------------------------|------------------------------------|--|--| +| None | - | - | - | - | | | +| Signals | Mandatory/ Optional | Used in command: | | Duration Provisioned Value: | | | +| Intrusion Pending Tone (int/pend,0x0027/0x0057)
Intrusion Tone (int/int,0x0027/0x0058)
Intrusion Reminder Tone (int/rem,0x0027/0x0059)
Toll Break-In Tone (int/tbi,0x0027/0x005a)
Intrusion Queue Tone (int/intque,0x0027/0x005b)
Busy Verification Tone (int/bv,0x0027/0x005c) | O | ADD, MOD, MOVE | | Value | | | +| | Signal Parameters | Mandatory/ Optional | Supported Values: | Duration Provisioned Value: | | | +| | Tone Direction (btd, 0x0001) | M | Internal / External | Default=External | | | +| Events | Mandatory/ Optional | Used in command: | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| Statistics | Mandatory/ Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +## C.14.22 Business Tones Generation Package + +Table C.14.22: Package Usage Information For Business Tones Generation Package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------|---------------------------|--------------------------|------------------------------------|--|--| +| None | - | - | - | - | | | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | | | +| Off-Hook Queuing Tone (biztn/ofque,0x0028/0x005d)
Expensive Route Warning Tone (biztn/erwt,0x0028/0x005e)
Distinctive Dial Tone (biztn/ddt,0x0028/0x005f)
Internal Dial Tone (biztn/idt,0x0028/0x0060) | O | ADD, MOD, MOVE | | Value | | | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | | | +| | Tone Direction (btd, 0x0001) | M | Internal / External | Default=External | | | +| Events | Mandatory/Optional | Used in command: | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| Statistics | Mandatory/Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +## C.14.23 3GUP Package + +Table C.14.23: Package Usage Information For 3GUP Package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|-------------------------------------------------------------------|--------------------------|--------------------|-------------------|-----------------------------|--|--| +| UP Mode of operation
(threegup/mode, 0x002f/0x0001) | M | ADD, MOD, MOVE | ALL | Default=1 (transparent) | | | +| UP versions
(threegup/upversions, 0x002f/0x0002) | M | ADD, MOD, MOVE | 1, 2 | Default = 1 | | | +| Delivery of erroneous SDUs
(threegup/delerrsdu, 0x002f/0x0003) | M | ADD, MOD, MOVE | ALL | Default = 3 (NA) | | | +| Interface
(threegup/interface, 0x002f/0x0004) | M | ADD, MOD, MOVE | ALL | None | | | +| Initialisation Direction
(threegup/initdir, 0x002f/0x0005) | M | ADD, MOD, MOVE | ALL | None | | | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | | | +| None | - | - | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | | | +| | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command: | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| Statistics | Mandatory/Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +## C.14.24 Modification of Link Characteristics Bearer Capability + +Table C.14.24: Package Usage Information For Modification of Link Characteristics Package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | +|------------------------------------------------------------------------------|---------------------------------|---------------------------|--------------------------|------------------------------------| +| None | - | - | - | - | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | +| None | - | - | - | - | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | +| | - | - | - | - | +| Events | Mandatory/Optional | Used in command: | | | +| Bearer Modification Support Event. ( threegmlc/mod_link_supp, 0x0046/0x0001) | M | ADD, MOD, MOVE NOTIFY | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | None | - | - | - | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | None | - | - | - | +| Statistics | Mandatory/Optional | Used in command: | | Supported Values: | +| None | - | - | - | - | +| Error Codes | Mandatory/ Optional | | | | +| None | - | | | | + +## C.14.25 TFO package + +Table C.14.25: Package Usage Information For TFO + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|--------------------------------------------------------------------|--------------------------|------------------------|----------------------------|-----------------------------|--|--| +| TFO Activity Control (threegtfoc /tfoenable, (0x0031/0x0001)) | M | ADD, MOD, MOVE | ALL | None (default =Off) | | | +| TFO Codec List (threegtfoc /codeclist, (0x0031/0x0002)) | M | ADD, MOD, MOVE | See 3GPP TS 29.232 §15.2.2 | None | | | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | | | +| None | - | - | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | | | +| | - | - | | - | | | +| Events | Mandatory/Optional | Used in command: | | | | | +| Optimal Codec Event (threegtfoc /codec_modify, (0x0031/0x0010)) | O | ADD, MOD, MOVE, NOTIFY | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | None | | | | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| Codec List Event (threegtfoc /distant_codec_list, (0x0031/0x0012)) | O | ADD, MOD, MOVE, NOTIFY | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | None | | | | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| TFO Status Event (threegtfoc /TFO_status) (0x0031/0x0014) | O | ADD, MOD, MOVE, NOTIFY | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | None | | | | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| Statistics | Mandatory/Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| | - | | | | | | + +## C.14.26 Circuit Switched Data package + +Table C.14.26: Package Usage Information For CSD + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|--------------------------------------------------------------------|------------------------------------|--------------------|----------------------------------------------------------------------------------------------------------|-----------------------------|--|--| +| PLMNBC (threeegcsd /plmnb, 0x0030/0x0001) | M | ADD, MOD, MOVE | Specified in the subclause "Bearer capability" in 3GPP TS 24.008 [3]. | None | | | +| GSM Channel Coding (threeegcsd / gsmchancod, 0x0030/0x0002) | M | ADD, MOD, MOVE | The second octet of Chosen Channel as specified in the subclause "Chosen Channel" in 3GPP TS 48.008 [9]. | None | | | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | | | +| Activate Protocol (threeegcsd/ actprot, 0x0030/0x0001) | M | MOD | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | | | +| | Local Peer Role (Localpeer 0x0001) | O | ALL | None | | | +| Events | Mandatory/Optional | Used in command: | | | | | +| Protocol Negotiation Result (threeegcsd / protres, (0x0030/0x0001) | M | ADD, MOD, NOTIFY | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | None | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | Negotiation Result (result 0x0001) | M | ALL | None | | | +| Rate Change (threeegcsd / ratechg, (0x0030/0x0002) | M | ADD, MOD, NOTIFY | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | None | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | New Rate (rate 0x0001) | M | 2400, 4800, 9600, 14400, 28800, 57600 | None | | | +| Statistics | Mandatory/Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +## C.14.27 Enhanced Circuit Switched Data package + +Table C.14.27: Package Usage Information For Enhanced CSD + +| Properties | Mandatory/ Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|------------------------------------------------|---------------------------------|----------------------------|----------------------------------------------|------------------------------------|--|--| +| Bitrate (threeegcsden /bitrate, 0x0082/0x0003) | M | ADD, MOD, MOVE | 2400, 4800, 9600, 14400, 28800, 57600, 64000 | None | | | +| Signals | Mandatory/ Optional | Used in command: | | Duration Provisioned Value: | | | +| None | - | - | | - | | | +| | Signal Parameters | Mandatory/ Optional | Supported Values: | Duration Provisioned Value: | | | +| | - | - | - | - | | | +| Events | Mandatory/ Optional | Used in command: | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| Statistics | Mandatory/ Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +## C.14.28 3G Expanded Call Progress Tones package + +Table C.14.28: Package Usage Information For 3G Expanded Call Progress Tones + +| Properties | Mandatory/ Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|-------------------------------------------------------------|---------------------------------|----------------------------|--------------------------|------------------------------------|--|--| +| None | | | | | | | +| Signals | Mandatory/ Optional | Used in command: | | Duration Provisioned Value: | | | +| CAMEL Prepaid Warning Tone (threeegxcg/cpwt, 0x0032/0x004f) | M | ADD, MOD, MOVE | | - | | | +| | Signal Parameters | Mandatory/ Optional | Supported Values: | Duration Provisioned Value: | | | +| | ToneDirection(td, 0x0010) | M | Ext, Int | Default=Ext | | | +| Events | Mandatory/ Optional | Used in command: | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| Statistics | Mandatory/ Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +## C.14.29 Cellular Text Telephone Modem Text Transport Package + +Table C.14.29: Package Usage Information For CTM + +| Properties | Mandatory/ Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|------------------------------------------------------------------------|--------------------------|------------------------|-----------------------|-----------------------------|--|--| +| Termination connection state(threeegctm/ connstate, 0x0068/0x0001) | M | ADD, MOD, MOVE | ALL | | | | +| Text Transport (threeegctm/ trpt (0x0068/0x0002) | M | ADD, MOD, MOVE | CTM | | | | +| Text Protocol Version (threeegctm/ textproto 0x0068/0x0003) | M | ADD, MOD, MOVE | ALL | Default=1 | | | +| Signals | Mandatory/ Optional | Used in command: | | Duration Provisioned Value: | | | +| None | - | - | | - | | | +| | Signal Parameters | Mandatory/ Optional | Supported Values: | Duration Provisioned Value: | | | +| | - | - | -- | - | | | +| Events | Mandatory/ Optional | Used in command: | | | | | +| Connection State Change (threeegctm/ connchange 0x0068/0x0001) | M | ADD, MOD, MOVE, NOTIFY | | | | | +| | Event Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | None | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | Connchng | M | As property connstate | - | | | +| Statistics | Mandatory/ Optional | Used in command: | | Supported Values: | | | +| Number of Characters Transferred (threeegctm/ chartrans 0x0068/0x0001) | M | SUB | | | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +C.14.30 Void + +## C.14.31 Flexible Tone Generator package + +Table C.14.31: Package Usage Information For Flexible Tone Generator + +| Properties | Mandatory/ Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|-----------------------------------------------|-------------------------------------|----------------------------|--------------------------|------------------------------------|--|--| +| None | - | - | - | - | | | +| Signals | Mandatory/ Optional | Used in command: | | Duration Provisioned Value: | | | +| Flexible Tone (threeegflex/ft, 0x0084/0x0050) | M | ADD, MOD, MOVE | | - | | | +| | Signal Parameters | Mandatory/ Optional | Supported Values: | Duration Provisioned Value: | | | +| | Burst list direction(bld, 0x0001) | M | Int, Ext | Default=Ext | | | +| | NumberOfBursts (nob, 0x0002) | M | 1-3 | Default = 1 | | | +| | BurstInterval (bi, 0x0003) | M | 1-1200 | Default = 2 | | | +| | numberOfTonesInBurst (notib 0x0004) | M | 1-3 | Default=3 | | | +| | toneDuration (td 0x0005) | M | 1-20 | Default=2 | | | +| | toneInterval (ti 0x0006) | M | 1-20 | Default=2 | | | +| Events | Mandatory/ Optional | Used in command: | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| Statistics | Mandatory/ Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +## C.14.32 Trace Package + +Table C.14.32: Package Usage Information For Trace Package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|---------------------------------------------------------------------------------------|-------------------------------------|--------------------|----------------------------------------------------------------------------|-----------------------------|--|--| +| Trace Activity Control
(calltrace/traceactivityrequest,
0x0097/0x0001) | M | ADD, MOD | Trace Session is activated in MGW /
Trace Session is deactivated in MGW | Not Applicable | | | +| IMSI (calltrace/imsi,
0x0097/0x0002) | M | ADD, MOD | Octet string | Not Applicable | | | +| IMEI(SV) (calltrace/imei_sv,
0x0097/0x0003) | M | ADD, MOD | Octet string | Not Applicable | | | +| Trace Reference
(calltrace/tracereference,
0x0097/0x0004) | M | ADD, MOD | Octet string | Not Applicable | | | +| Trace Recording Session Reference
(calltrace/tracerecsessionref,
0x0097/0x0005) | M | ADD, MOD | Octet string | Not Applicable | | | +| Trace Depth (calltrace/tracedepth,
0x0097/0x0006) | M | ADD, MOD | Octet string | Not Applicable | | | +| Triggering Events
(calltrace/triggeringevent,
0x0097/0x0007) | M | ADD, MOD | Octet string | Not Applicable | | | +| List of interfaces
(calltrace/listofinterfaces,
0x0097/0x0008) | M | ADD, MOD | Octet string | Not Applicable | | | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | | | +| None | - | - | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | | | +| | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command: | | | | | +| Trace result
(calltrace/tracact,
0x0097/0x0001) | M | ADD, MOD, NOTIFY | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | None | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | TraceActivation Result (res,0x0001) | M | Trace Successfully activated/ Failure in trace activation | Not Applicable | | | +| Statistics | Mandatory/Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +## C.14.33 ASCI Group call + +Table C.14.33: Package usage information for ASCI Group Call package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|----------------------------------------------------------------------------------|--------------------------|--------------------|-------------------|-----------------------------|--|--| +| Number of needed conference terminations (threegasci/nct, 0x00b2/0x0001) | M | ADD | upto 32 | None | | | +| Number of desired listener context terminations (threegasci/nlct, 0x00b2/0x0002) | O | ADD | upto 32 | None | | | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | | | +| None | - | - | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | | | +| | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command: | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| Statistics | Mandatory/Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +## C.14.34 IP domain connection + +Table C.14.34: Package usage information for IP domain connection package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------|---------------------------|--------------------------|------------------------------------|--|--| +| IP Realm Identifier
(ipdc /realm, 0x009d /0x0001) | M | ADD | String | Operator Defined (NOTE) | | | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | | | +| None | - | - | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | | | +| | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command: | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| Statistics | Mandatory/Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | +| NOTE: A default IP realm may be configured such that if the MGW has not received the IP realm identifier and the MGW supports multiple IP realms then the default IP realm shall be used. | | | | | | | + +## C.14.35 Inactivity Timer Package + +Table C.14.35: Package Usage Information for Inactivity Timer package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|--------------------------------------------|---------------------------------------|---------------------------|--------------------------|-------------------------------------------------------|--|--| +| None | - | - | - | - | | | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | | | +| None | - | - | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | | | +| | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command: | | | | | +| Inactivity Timeout (it/ito, 0x0045/0x0001) | M | MOD, NOTIFY | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | Maximum Inactivity Time (mit, 0x0001) | M | Any integer | Unspecified, if not sent a value must be provisioned. | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | None | - | - | - | | | +| Statistics | Mandatory/Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +## C.14.36 3G Interface Type package + +Table C.14.36: Package Usage Information for 3G Interface Type package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|-----------------------------------------------------------|---------------------------------|---------------------------|---------------------------------------------------------------------------------------------------|------------------------------------|--|--| +| IP interface type,
(threegint/ipint,
0x00e3/0x0001) | M | ADD, MOD | "NboIP"
(0x0001)
"AoIP"
(0x0002)
"MboIP"
(0x0003)
"ExtSIPI"
(0x0004)
NOTE | None | | | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | | | +| None | - | - | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | | | +| | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command: | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| Statistics | Mandatory/Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | +| NOTE: Other values reserved | | | | | | | + +## C.14.37 Differentiated Services (ds) + +Table C.14.37: Differentiated Services package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | | | +|---------------------------------------------------------------|---------------------------------|---------------------------|-------------------------|-----------------------------------|--|--| +| Differentiated Services Code Point
(ds/dscp,0x008b/0x0001) | M | ADD, MODIFY | ALL | Yes | | | +| Tagging Behaviour
(ds/tb, 0x008b/0x0002) | O | ADD, MODIFY | ALL | Yes | | | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | | | +| None | - | - | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | | | +| | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| Statistics | Mandatory/Optional | Used in command | Supported Values | | | | +| None | - | - | - | | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +## C.14.38 Gate Management (gm) + +Table C.14.38: Gate Management Package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | | | +|---------------------------------------------------------|--------------------------|--------------------|------------------|----------------------------|--|--| +| Remote Source Address Filtering (gm/saf,0x008c/0x0001) | M | ADD, MODIFY | ALL | Not Applicable | | | +| Remote Source Address Mask (gm/sam,0x008c/0x0002) | O | ADD, MODIFY | ALL | Not Applicable | | | +| Remote Source Port Filtering (gm/spf,0x008c/0x0003) | M | ADD, MODIFY | ALL | Not Applicable | | | +| Remote Source Port (gm/spr,0x008c/0x0004) | O | ADD, MODIFY | ALL | Not Applicable | | | +| Explicit Source Address Setting (gm/esas,0x008c/0x0005) | Not Supported | NONE | - | - | | | +| Local Source Address (gm/lsa,0x008c/0x0006) | Not Supported | NONE | - | - | | | +| Explicit Source Port Setting (gm/esps,0x008c/0x0007) | Not Supported | NONE | - | - | | | +| Local Source Port (gm/lsp,0x008c/0x0008) | Not Supported | NONE | - | - | | | +| Remote Source Port Range (gm/spr,0x008c/0x000A) | O | ADD, MODIFY | ALL | Not Applicable | | | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | | | +| None | - | - | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | | | +| | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| Statistics | Mandatory/Optional | Used in command | Supported Values | | | | +| Discarded Packets (gm/dp,0x008c/0x0001) | Not Supported | None | - | | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +NOTE : This package extends RTP Control Protocol package (ITU-T Recommendation H.248.57 [66]) and thus inherits RTCP Allocation Specific Behaviour property (rsb). + +## C.14.39 Traffic management (tman) + +Table C.14.39: Traffic Management Package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | | | +|-----------------------------------------------------|--------------------------|--------------------|------------------|----------------------------|--|--| +| Policing (tman/pol, 0x008d/0x0005) | M | ADD, MODIFY | ALL | Not Applicable | | | +| Peak Data Rate (tman/pdr, 0x008d/0x0001) | O | ADD, MODIFY | ALL | Not Applicable | | | +| Delay Variation Tolerance (tman/dvt, 0x008d/0x0004) | O | ADD, MODIFY | ALL | ANY | | | +| Sustainable Data Rate (tman/sdr, 0x008d/0x0002) | M | ADD, MODIFY | ALL | Not Applicable | | | +| Maximum burst size (tman/mbs, 0x008d/0x0003) | M | ADD, MODIFY | ALL | Not Applicable | | | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | | | +| None | - | - | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | | | +| | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| Statistics | Mandatory/Optional | Used in command | | Supported Values | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +NOTE: The data rate shall be calculated using the packet size from IP layer upwards. The Token Bucket method as described by ITU-T Recommendation H.248.53 [69] sub-clause 9.4.3 (as per IETF RFC 2216 [73]) shall be followed where SDR = "r" and MBS = "b" (i.e. the additional "M" value does not apply). + +## C.14.40 IP Realm Availability (ipra) + +Table C.14.40: IP Realm Availability Package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | | | +|-----------------------------------------------------|----------------------------------------|---------------------------|--------------------------|-----------------------------------|--|--| +| Available Realms, (ipra/ar, 0x00e0/0x0001) | M | AUDITVALUE | ALL | Not Applicable | | | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | | | +| None | - | - | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | | | +| | - | - | | - | | | +| Events | Mandatory/Optional | Used in command | | | | | +| Available Realms Changed, (ipra/arc, 0x00e0/0x0001) | M | MODIFY, NOTIFY | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value | | | +| | - | - | | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | Newly Available Realms (nar, 0x0001) | M | ALL | Not applicable | | | +| | Newly Unavailable Realms (nur, 0x0002) | M | ALL | Not applicable | | | +| Statistics | Mandatory/Optional | Used in command | | Supported Values | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +## C.14.41 RTCP Handling Package (rtcph) + +Table C.14.41: RTCP Handling Package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | | | +|---------------------------------------------------------------|---------------------------------|---------------------------|-------------------------|-----------------------------------|--|--| +| RTCP Allocation Specific Behaviour (rtcph/rsb, 0x00b5/0x0009) | M | ADD, MODIFY | ALL | OFF | | | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | | | +| None | - | - | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | | | +| | - | - | | - | | | +| Events | Mandatory/Optional | Used in command | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | | - | | | +| Statistics | Mandatory/Optional | Used in command | | Supported Values | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +## C.14.42 Application Data Inactivity Detection (adid) + +Table C.14.42: Application Data Inactivity Detection package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | | | +|-----------------------------------------------------|-----------------------------|---------------------|------------------|----------------------------|--|--| +| None | - | - | - | - | | | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | | | +| None | - | - | - | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | | | +| | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command | | | | | +| IP Flow Stop Detection (adid/ipstop, 0x009c/0x0001) | M | ADD, MODIFY, NOTIFY | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | Detection time (dt, 0x0001) | M | ALL | Yes | | | +| | Direction (dir, 0x0002) | M | ALL | Yes | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| Statistics | Mandatory/Optional | Used in command | Supported Values | | | | +| None | - | - | - | | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +## C.14.43 Explicit Congestion Notification for RTP-over-UDP Support (ecnrous) + +**Table C.14.43.1: Explicit Congestion Notification for RTP-over-UDP Support package** + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | | | +|----------------------------------------------------------------|----------------------------------|---------------------------|-------------------------|---------------------------------------------------------------------------------------------|--|--| +| ECN Enabled (ecnrous/ecnen, 0x010b/0x0001) | M | ADD, MODIFY | True, False | - | | | +| Congestion Response Method (ecnrous/crm, 0x010b/0x0002) | Not Signalled | - | - | "RDCC"(0x0002)
NOTE | | | +| Initiation Method (ecnrous/initmethod, 0x010b/0x0003) | M | ADD, MODIFY | "leap" | "leap" | | | +| ECN Mode (ecnrous/mode, 0x010b/0x0004) | Not Signalled | - | - | "setonly" (0x0001) in the Remote Descriptor and "readonly" (0x0002) in the Local Descriptor | | | +| ECT Marking (ecnrous/ectmark, 0x010b/0x0005) | Not Signalled | - | - | "0" (0x0002) | | | +| ECN Congestion Marking (ecnrous/congestmark, 0x010b/0x0006) | Not Signalled | - | - | "nomark" (0x0003) | | | +| ECN SDP Usage (ecnrous/ecnsdp, 0x010b/0x0007) | Not Signalled | - | - | "P" (0x0001) | | | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | | | +| None | - | - | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | | | +| | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command | | | | | +| ECN Failure (ecnrous/fail, 0x010b/0x0001) | M | ADD, MODIFY, NOTIFY | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | Failure Type (type, 0x0001) | Mandatory | INIT, USE | - | | | +| | Media Sender SSRC (ssrc, 0x0002) | Not Supported | - | - | | | +| Statistics | Mandatory/Optional | Used in command | | Supported Values | | | +| Source (ecnrous/ssrc, 0x010b/0x0001) | Not Supported | - | | - | | | +| CE Counter (ecnrous/cecount, 0x010b/0x0002) | Not Supported | - | | - | | | +| ECT0 Counter (ecnrous/ectzero, 0x010b/0x0003) | Not Supported | - | | - | | | +| ECT1 Counter (ecnrous/ectone, 0x010b/0x0004) | Not Supported | - | | - | | | +| Not-ECT Counter (ecnrous/notect, 0x010b/0x0005) | Not Supported | - | | - | | | +| Lost Packets Counter (ecnrous/lost, 0x010b/0x0006) | Not Supported | - | | - | | | +| Extended Highest Sequence number (ecnrous/ehsn, 0x010b/0x0007) | Not Supported | - | | - | | | +| Duplication Counter (ecnrous/dup, 0x010b/0x0008) | Not Supported | - | | - | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +NOTE: Application Specific Rate Adaptation shall be applied in accordance with 3GPP TS 26.114 [77]. For speech this requires support of CMR and TMMBR for video. + +## C.14.44 MG Act-as STUN Server (mgastuns) + +Table C.14.44.1: MG Act-as STUN Server + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | | | +|--------------------------------------------------------|--------------------------|--------------------|------------------|----------------------------|--|--| +| Act-as STUN Server
(mgastuns/astuns, 0x00c2/0x0001) | M | ADD, MODIFY | ALL | - | | | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | | | +| None | - | - | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | | | +| | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| Statistics | Mandatory/Optional | Used in command | Supported Values | | | | +| None | - | - | - | | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +## C.14.45 Originate STUN Continuity Check (ostuncc) + +Table C.14.45.1: Originate STUN Continuity Check Package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | | | +|------------------------------------------------------------------|----------------------------------------|---------------------------|-----------------------------|-----------------------------------|--|--| +| Host Candidate Realm (ostuncc/hcr, 0x00c3/0x0001) | O | ADD, MODIFY | ALL | Yes | | | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | | | +| Send Connectivity Check (ostuncc/scc, 0x00c3/0x0001) | M | ADD, MODIFY | | Not Applicable | | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | | | +| | Control (cntrl, 0x0001) | O | "controlling", "controlled" | Not Applicable | | | +| Send Additional Connectivity Check (ostuncc/sacc, 0x00c3/0x0002) | Mandatory/Optional | Used in command | | Duration Provisioned Value | | | +| | M | MODIFY | | Not Applicable | | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | | | +| | Control (cntrl, 0x0001) | O | "controlling", "controlled" | Not Applicable | | | +| Events | Mandatory/Optional | Used in command | | | | | +| Connectivity Check Result (ostuncc/ccr, 0x00c3/0x0001) | M | ADD, MODIFY, NOTIFY | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| New Peer Reflexive Candidate (ostuncc/nprc, 0x00c3/0x0002) | Candidate/Transport Pair (ctp, 0x0001) | M | ALL | Not applicable | | | +| | Mandatory/Optional | Used in command | | | | | +| | M | ADD, MODIFY, NOTIFY | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | Candidate (can, 0x0001) | M | ALL | Not applicable | | | +| Statistics | Mandatory/Optional | Used in command | Supported Values | | | | +| None | - | - | - | | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +## C.14.46 Enhanced Revised Offer/Answer SDP Support (eroas) + +**Table C.14.46: Enhanced Revised Offer/Answer SDP Support package** + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | | | +|--------------------------------------------------------|-------------------------------------|---------------------------|-------------------------|---------------------------------------|--|--| +| SDPCapNeg Extensions
(eroas/sdpe,
0x0109/0x0001) | M | AuditValue | "cap-v0" | "cap-v0" | | | +| Signals | Mandatory/Optional | Used in command | | Duration
Provisioned Value
| | | +| None | - | - | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration
Provisioned Value
| | | +| | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| | ObservedEvent
Parameters
| Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| Statistics | Mandatory/Optional | Used in command | Supported Values | | | | +| None | - | - | - | | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +## C.15 Mandatory support of SDP and Annex C information elements + +Mandatory support of SDP and Annex C information elements shall be in accordance with subclause 11. + +**Table C.15: Mandatory Annex C and SDP information elements** + +| Information Element | Annex C Support | SDP Support | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|-------------| +| Bearer Service Characteristics | TMR | | +| ISDN BC | USI | | +| NOTE 1: When text encoding is used, all the Information Elements shall be supported via their corresponding SDP parameters, as specified in subclause 11. Annex C SDP equivalents shall not be used. | | | + +## C.16 Optional support of SDP and Annex C information elements + +Table C.16: Optional Annex C and SDP information elements + +| Information Element | Annex C Support | SDP Support | +|---------------------|-----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| v-line | "SDP_V " | As in 3GPP TS 29.332 [51], clause A.15 (NOTE 1) | +| m-line | "SDP_M " | As in 3GPP TS 29.332 [51], clause A.15 (NOTE 1) | +| c-line | "SDP_C " | As in 3GPP TS 29.332 [51], clause A.15 (NOTE 1) | +| a-line | "SDP_A " | As in 3GPP TS 29.332 [51], clause A.15 (NOTE 1) (NOTE 7) | +| b-line | "SDP_B " | As in 3GPP TS 29.332 [51], clause A.15 (NOTE 1) (NOTE 8) | +| o-line | "SDP_O" | As in 3GPP TS 29.332 [51], clause A.15 | +| s-line | "SDP_S" |

The session name (s=) line contains a single field:
s= <session-name>.

The MG shall return the value received from the MGC or if there is no s-line sent by the MGC, the MG shall populate this line as follows:
- "s=" (NOTE 1)

| +| Codec | Acodesc | Mandatory for BICC and Iu terminations. (NOTE 2) | +| BNC-Id | BIR (NOTE 3) | Mandatory for BICC-ATM (NOTE 2) | +| BIWF_Address | NSAP (NOTE 4) | Mandatory for BICC-ATM (NOTE 2) | +| Iu IP Address | IPv4
IPv6 | As defined in ITU-T Recommendation H.248.1 [10] C6. Mandatory for Iu termination with IP transport (NOTE 5) | +| Iu IP Port | Port | As defined in ITU-T Recommendation H.248.1 [10] C6. Mandatory for Iu termination with IP transport (NOTE 6) | + +NOTE 1: If the procedures Reserve RTP Connection Point, Configure RTP Connection Point, Reserve and Configure RTP Connection Point are supported, these properties shall be supported. + +NOTE 2: When text encoding is used, all the Information Elements shall be supported via their corresponding SDP parameters, as specified in subclause 11. Annex C SDP equivalents shall not be used. + +NOTE 3: The BIR length shall be fixed at 4 Octets. + +NOTE 4: The NSAP length shall be fixed at 20 Octets. The content of the RNC Transport Address or BIWF Address depends on the used transport interface but the principle is that NSAP format is used. See 3GPP TS 25.414 [21] for RNC and for core network see 3GPP TS 29.414 [32]. For IP the IANA ICP IDI format of the NSAP addressing format as specified in X.213 [33] shall be used. For IPv4 networks the IPv4 format recommended by X.213 shall be adopted. + +NOTE 5: The value is mapped to/from the first 4(or 16) octets of the IPv4 (or IPv6) address part of the Transport Layer Address in 3GPP TS 25.413 [20]. + +NOTE 6: The value is mapped to/from the Binding ID in the RANAP IE Iu transport Association, 3GPP TS 25.413 [20]. + +NOTE 7: For the RTP Payload for Redundant Audio Data, the encoding name with "red" and "fmtp" attributes shall be provided to indicate the redundancy level and shall always be signalled in conjunction with the CLEARMODE Payload type as described in 10.2.3.5.2. No other Payload types are currently defined for use with the Redundant RTP Payload. + +NOTE 8: For RTP flows, where RTCP resources are reserved together with the RTP resources using the "RTP Specific Behaviour" property of the Gate Management package (gm) property, the MGC may also supply additional RTCP bandwidth modifiers (i.e. RR and RS, see IETF RFC 3556 [52]). The AS *bandwidth* value will include the bandwidth used by RTP. In the absence of the RTCP bandwidth modifiers, the MGW shall allow an additional 5% of the AS bandwidth value for the bandwidth for RTCP, in accordance with IETF RFC 3556 [52]. + +--- + +## Annex D (informative): Change history + +| Date | TSG # | TSG Doc. | CR | Re v | Subject/Comment | New | +|----------|-------|-----------|-----|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------| +| Sep 2000 | | | | | Initial draft created after N4#4 based on N4-000620 | 0.1.0 | +| Oct 2000 | | | | | Updated after N4 R2000 Ad Hoc Stockholm based on N4-00823 and N4-000842 | 0.2.0 | +| Nov 2000 | | | | | Reference for MTP 3B corrected; RFC reference for SCTP added | 0.3.0 | +| Nov 2000 | | | | | Updated according to N4-000996, N4-000998, N4-000999, N4-001000, N4-001021, N4-001028 & N4-001097 as agreed in CN4 #5 | 1.0.0 | +| Nov 2000 | CN#10 | | | | To TSG-CN Plenary #10 for information | 1.1.0 | +| Jan 2001 | | | | | Updated according to NJ-010069, NJ-010030, NJ-010098, NJ-010094, NJ-010033, NJ-010097, NJ-010095, NJ-010112 as agreed in the Joint CN3/CN4 Meeting held during the CN4#6 | 1.1.1 | +| Jan 2001 | | | | | References ordered by specification/recommendation number; references to 3GPP specifications include full titles as shown on the title page; literal reference numbers and references to subclauses replaced with fields; all table cells outlined with 0.5pt lines; appropriate 3GPP paragraph styles applied. | 1.2.0 | +| Feb 2001 | | | | | Updated according to N4-010245, N4-010248, N4-010249, N4-010303, N4-010304, N4-010305, agreed in CN4 Release 4 ad hoc, Madrid. References to Q.1902.x replaced by references to 29.205; 3GPP styles applied consistently; form for ITU-T recommendations in text is now "ITU-T Recommendation A.NNNN". | 1.3.0 | +| Mar 2001 | | | | | Updated according to N4-010384, N4-010401 (part) & N4-010472, agreed in CN4 in Sophia Antipolis. References to Q.1950, Q.1970 and Q.1990 replaced by reference to 29.205. Reference to SIP-T deleted. Editor's note in 15.1.2.3 deleted. Editorial clean-up. | 2.0.0 | +| Mar 2001 | | | | | Sent to TSG CN#11 for approval | 2.1.0 | +| Mar 2001 | CN#11 | | | | References updated after comments in TSG CN #11 Approved in CN#11 | 4.0.0 | +| Jun 2001 | CN#12 | NP-010284 | 1 | 1 | Text encoding of codec information on Mc interface | 4.1.0 | +| Jun 2001 | CN#12 | NP-010284 | 4 | 2 | ATM-IP signalling transport Interworking | 4.1.0 | +| Jun 2001 | CN#12 | NP-010284 | 5 | 1 | Alignment of Procedure names to TS 23.205 and Q.1950 | 4.1.0 | +| Jun 2001 | CN#12 | NP-010284 | 6 | 3 | Clarifications in 3GUP package | 4.1.0 | +| Jun 2001 | CN#12 | NP-010284 | 7 | 1 | Clarification of Use of UP version property in 3GUP package | 4.1.0 | +| Jun 2001 | CN#12 | NP-010284 | 8 | 1 | Updates to UP Relay Function, Appendix A | 4.1.0 | +| Sep 2001 | CN#13 | | | | Editorial clean up | 4.2.0 | +| Sep 2001 | CN#13 | NP-010452 | 009 | | Addition of package numbers allocated by IANA | 4.2.0 | +| Sep 2001 | CN#13 | NP-010452 | 010 | 1 | Mc signalling transport in IP environment | 4.2.0 | +| Dec 2001 | CN#14 | NP-010619 | 011 | 1 | Inclusion of H.248 Annex L, "Error Codes and Service Change Reason Description" | 4.3.0 | +| Dec 2001 | CN#14 | NP-010619 | 012 | | Removal of the Reuse Idle Package | 4.3.0 | +| Dec 2001 | CN#14 | NP-010619 | 014 | | Correction of Release Procedures | 4.3.0 | +| Dec 2001 | CN#14 | NP-010619 | 015 | | Clarification Of Use Of 3GUP package For PCM | 4.3.0 | +| Dec 2001 | CN#14 | NP-010619 | 016 | | Corrections to ABNF coding of PackageIDs | 4.3.0 | +| Dec 2001 | CN#14 | NP-010619 | 017 | | Correction of BICC packages | 4.3.0 | +| Dec 2001 | CN#14 | NP-010619 | 020 | 1 | Correction of 3GUP package sub-list type | 4.3.0 | +| Dec 2001 | CN#14 | NP-010631 | 013 | 1 | Introduction of MGW Congestion Handling | 5.0.0 | +| Dec 2001 | CN#14 | NP-010631 | 019 | 2 | Maintenance locking of MG | 5.0.0 | +| Jan 2002 | | | | | A coverdheet fixed | 5.0.1 | +| Mar 2002 | CN#15 | NP-020029 | 025 | 2 | Naming convention for TDM resources | 5.1.0 | + +| Date | TSG # | TSG Doc. | CR | Re
v | Subject/Comment | New | +|----------|-------|-----------|-----|---------|---------------------------------------------------------------------------------------------|-------| +| Mar 2002 | CN#15 | NP-020029 | 027 | 2 | Correction of Bearer Modification Handling | 5.1.0 | +| Jun 2002 | CN#16 | NP-020260 | 030 | 1 | GTT enhancement on Mc | 5.2.0 | +| Jun 2002 | CN#16 | NP-020260 | 032 | | Update to TFO package to explicitly reference TS 26.103 for 3GPP codecs | 5.2.0 | +| Jun 2002 | CN#16 | NP-020260 | 033 | 2 | CTM Text Transport package | 5.2.0 | +| Jun 2002 | CN#16 | NP-020260 | 034 | | Allow the usage of logical port | 5.2.0 | +| Jun 2002 | CN#16 | NP-020249 | 036 | | Correction subclause 14.1.6 of 3GPP TS 29.332 | 5.2.0 | +| Sep 2002 | CN#17 | NP-020459 | 037 | 1 | Misalignment between TS 23.226 and TS 29.232 for Global Text Telephony | 5.3.0 | +| Sep 2002 | CN#17 | NP-020459 | 038 | 1 | Alignment of text in TS 29.232 for Global Text Telephony | 5.3.0 | +| Sep 2002 | CN#17 | NP-020459 | 039 | 1 | Alignment between prepare bearer and reserve bearer in TS 29.232 for Global Text Telephony. | 5.3.0 | +| Sep 2002 | CN#17 | NP-020463 | 044 | 1 | Missing Properties For Circuit Switched Data Calls | 5.3.0 | +| Dec 2002 | CN#18 | NP-020579 | 041 | 2 | Termination ID Correction | 5.4.0 | +| Dec 2002 | CN#18 | NP-020597 | 042 | 3 | New Procedures/Package for handling IP transport for Iu interface | 5.4.0 | +| Dec 2002 | CN#18 | NP-020578 | 046 | 2 | Updates to support Codec Modification | 5.4.0 | +| Dec 2002 | CN#18 | NP-020594 | 052 | 2 | CAMEL4 flexible tone package | 5.4.0 | +| Mar 2003 | CN#19 | NP-030108 | 053 | | Update to 3GUP – clarification of IuUP Initialisation handling | 5.5.0 | +| Mar 2003 | CN#19 | NP-030108 | 054 | 1 | Update to 3GUP – addition of reference to SDU format definition for Nb interface | 5.5.0 | +| Jun 2003 | CN#20 | NP-030211 | 057 | 1 | Alignment of references after renumbering of H248 by ITU-T | 5.6.0 | +| Jun 2003 | CN#20 | NP-030211 | 059 | | Clarification of handling of DTMF in split architecture – DTMF timing | 5.6.0 | +| Mar 2004 | CN#23 | NP-040052 | 061 | | Addition of Package Id for CTM | 5.7.0 | +| Mar 2004 | | | | | Addition of Package Ids allocated by IANA (0082 - 0084) | 5.7.0 | +| Sep 2004 | CN#25 | NP-040392 | 063 | | Correction of Procedure "Activate Voice Processing Function" | 5.8.0 | +| Sep 2004 | CN#25 | NP-040418 | 075 | 2 | 3GUP package corrections | 5.8.0 | +| Sep 2004 | CN#25 | NP-040418 | 064 | | Provisioning Of Base Root package properties | 5.8.0 | +| Sep 2004 | CN#25 | NP-040418 | 065 | | Service Change Address | 5.8.0 | +| Sep 2004 | CN#25 | NP-040418 | 066 | | Use Of Event Buffers | 5.8.0 | +| Sep 2004 | CN#25 | NP-040418 | 067 | | Digit Maps | 5.8.0 | +| Sep 2004 | CN#25 | NP-040418 | 068 | | IP secured transport | 5.8.0 | +| Sep 2004 | CN#25 | NP-040418 | 074 | | Termination Restoration | 5.8.0 | +| Sep 2004 | CN#25 | NP-040392 | 072 | 1 | Use Of Statistics | 5.8.0 | +| Dec 2004 | CN#26 | NP-040521 | 078 | | Correction of distant codec list | 5.9.0 | +| Dec 2004 | CN#26 | NP-040528 | 079 | | IP transport package Duplicate property ID in ASN.1 encoding | 5.9.0 | +| Dec 2004 | CN#26 | NP-040529 | 080 | 1 | H.248 Scope | 5.9.0 | +| Dec 2004 | CN#26 | NP-040529 | 081 | 1 | Q.1950 reference | 5.9.0 | +| Dec 2004 | CN#26 | NP-040529 | 082 | | Emdedded events | 5.9.0 | +| Dec 2004 | CN#26 | NP-040529 | 084 | | Multiple streams | 5.9.0 | +| Dec 2004 | CN#26 | NP-040529 | 085 | 1 | Overspec/underspec parameters | 5.9.0 | + +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | New | +|----------|-------|-----------|-----|-----|------------------------------------------------------------------------------------------|-------| +| Dec 2004 | CN#26 | NP-040529 | 088 | 2 | Procedures and Commands – removal of unwanted commands | 5.9.0 | +| Dec 2004 | CN#26 | NP-040547 | 092 | | Update of referenced H.248.1 version to version 2 | 6.0.0 | +| Mar 2005 | CN#27 | NP-050057 | 060 | 7 | Addition of the trace package | 6.1.0 | +| | | NP-050029 | 101 | 1 | Requirements for support of H.248 packages | | +| | | NP-050029 | 104 | 1 | Completion of specification of UMTS Packages | | +| | | NP-050036 | 106 | | Correction of implied option for Embedded Signals and Events | | +| | | NP-050036 | 108 | 2 | Removal of the 'Test' ServiceStates value from the TerminationState Descriptor | | +| | | NP-050036 | 111 | 1 | Removal of the usage of the ContextAttributeAuditReq construct | | +| | | NP-050036 | 113 | | Removal of the Multiplex descriptor | | +| | | NP-050036 | 115 | | Removal of the Modem descriptor | | +| | | NP-050133 | 120 | 4 | Requirements for support of procedures | | +| | | NP-050034 | 122 | 2 | Procedure for Emergency Call Indication | | +| | | NP-050036 | 128 | | Removal of the Error Descriptor usage in NotifyRequest | | +| | | NP-050036 | 130 | | Updating incomplete parameter definition for MGW Resource congestion handling procedures | | +| | | NP-050055 | 131 | | Removal of Signals on ROOT | | +| | | NP-050055 | 132 | | Removal of usage of Stream ID in Topology descriptor | | +| | | NP-050055 | 133 | | H.248.1 version contradiction | | +| | | NP-050036 | 135 | | Directionality of tones and announcements | | +| | | NP-050036 | 138 | 1 | New 'TFO status' event | | +| | | NP-050028 | 139 | 1 | TFO procedure clarification | | +| | | NP-050028 | 142 | 1 | TFO activation without TFO Codec List | | +| | | NP-050036 | 148 | 1 | Commands on ROOT | | +| | | NP-050036 | 149 | 1 | Use Of Audit Value | | +| | | NP-050036 | 151 | | Service Change Reasons Not supported | | +| | | NP-050036 | 155 | 1 | Descriptors in command replies | | +| | | NP-050036 | 157 | 1 | Introduction of formal profile name for Mc interface | | +| | | NP-050036 | 158 | | Service Change for Failover not defined for Mc Interface | | +| | | NP-050029 | 161 | | Removal Of VPF type | | +| | | NP-050029 | 164 | | Alignment of TFO Activation Procedure and associated parameters | | +| | | NP-050055 | 165 | 2 | Continuity Test | | +| Jun 2005 | CT#28 | CP-050236 | 184 | 1 | BNC Cut-Through Capability Package Removed | 6.2.0 | +| | | CP-050236 | 187 | 1 | Format of IP address | | +| | | CP-050101 | 188 | 2 | Profile Registration Mandatory/Negotiation Clarification | | +| | | CP-050236 | 196 | 1 | Clarification of Maintenance Procedures | | +| | | CP-050236 | 198 | 1 | Clarification of Use Of Topology and Multiparty | | +| | | CP-050236 | 200 | | Removal of Option in Prepare Bearer that the MGW can chose the BNC Characteristics | | +| | | CP-050236 | 202 | 1 | Clarification Of Use of Wildcarding | | +| | | CP-050080 | 209 | 2 | Text encoding of IPBCP for IP transport on Mc interface | | +| | | CP-050080 | 212 | 2 | Definition of requirement for support of commands | | +| | | CP-050238 | 213 | 1 | Correction to Profile registration procedures | | +| Sep 2005 | CT#29 | CP-050435 | 218 | 1 | Codec IE and Codec List on the Mc interface | 6.3.0 | +| | | CP-050290 | 224 | | Value range for BIR/NSAP | | +| | | CP-050290 | 229 | | Clarification of 'extended only' packages | | +| | | CP-050290 | 231 | | Correction to Prepare IP Transport procedure | | +| | | CP-050290 | 233 | 1 | Wildcarding of Release Procedures | | +| | | CP-050290 | 235 | | Clarification to use of local peer for CSD | | +| | | CP-050280 | 238 | 2 | Correction to clarify use of FAX and Channel Mode Modify | | +| | | CP-050290 | 242 | 1 | Clarification to use of PLMN-BC, GSM-Chanel Coding for CSD | | +| | | CP-050290 | 244 | 1 | Clarification to use of Init Dir parameter | | +| | | CP-050290 | 246 | 1 | Clarification to Termination Restoration and Termination Out Of Service | | +| | | CP-050290 | 248 | | Remove provisioning of Resource Congestion Event | | +| | | CP-050290 | 250 | | Remove Priority property | | +| | | CP-050290 | 252 | | Notifications for IP Bearer Establishment | | +| | | CP-050290 | 254 | 1 | Clarification for Use of Stream Mode Property with Announcements | | + +| Date | TSG # | TSG Doc. | CR | Re v | Subject/Comment | New | +|----------|-------|-----------|------|------|-------------------------------------------------------------------------------------------------------------------|-------| +| | | CP-050290 | 256 | | Removal of Stream Mode Loopback | | +| | | CP-050290 | 258 | | Correction to IPBCP Tunnel Procedures | | +| | | CP-050290 | 263 | | Exclusion of use of Signal ID Play Tone for DTMF | | +| | | CP-050290 | 265 | 1 | Miscellaneous Open Mc corrections | | +| | | CP-050308 | 266 | 1 | Use of Individual Audit Token | | +| | | CP-050438 | 268 | 1 | Restriction of Service Change Address in MGW Restriction | | +| | | CP-050308 | 271 | | Removal of BNC-cut-through-capability from Prepare Bearer procedure | | +| | | CP-050308 | 272 | | Updating Mc interface profile "threeegbicsn" to version 2 | | +| | | CP-050290 | 276 | | Defining a default value for "Echo cancelling" property | | +| | | CP-050309 | 278 | 1 | Correction on Burst interval duration | | +| | | CP-050308 | 281 | 1 | Clarification of "Normal Release" parameter | | +| Dec 2005 | CT#30 | CP-050603 | 0261 | 2 | Correction to clarify TFO Package use | 6.4.0 | +| | | CP-050607 | 0288 | 1 | Clarification to client/server behaviour with regards to SCTP Initiation | | +| | | CP-050607 | 0289 | 1 | Inclusion of Error Code #449 for unsupported parameter value | | +| | | CP-050618 | 0290 | 1 | Correction to Continuity Test Procedure | | +| | | CP-050607 | 0296 | 1 | Setting of CN/Outgoing Nb termination prior to bearer establishment | | +| | | CP-050607 | 0304 | 2 | Correction to use of BITRATE for CSD calls | | +| | | CP-050607 | 0308 | 1 | Bearer Released Event to Reserve Circuit procedure | | +| | | CP-050607 | 0322 | 1 | Corrections to use of GSM-Channel Coding for CSD | | +| | | CP-050618 | 0323 | 3 | Correct MCC Error in implementing CR #238 | | +| 2005-12 | CT#30 | CP-050629 | 0302 | 2 | Clean-up of hanging contexts and terminations | 7.0.0 | +| | | CP-050629 | 0309 | 1 | Clarification of MGW capability change | | +| 2006-03 | CT#31 | CP-060078 | 0307 | 2 | Clarification of Termination Restoration and Termination Out-of-Service procedures | 7.1.0 | +| | | CP-060064 | 0326 | 2 | Correction To Termination State Handling | | +| | | CP-060064 | 0329 | 1 | Send Tone procedure | | +| | | CP-060064 | 0330 | 1 | ContextID in Change Flow Direction response | | +| | | CP-060064 | 0333 | 1 | Correction To DTMF Detection | | +| | | CP-060078 | 0337 | 1 | Clarification to use of ServiceChangeMGCIId | | +| | | CP-060078 | 0338 | | Clarification to cut-through procedure | | +| | | CP-060064 | 0345 | 2 | Adding missing termination ID to Acknowledgement part of notification procedures | | +| | | CP-060078 | 0342 | 1 | Correction to syntax for event descriptions | | +| | | CP-060064 | 0348 | | Adding missing Codec, Bearer Characteristics and Bearer Service Characteristics to Prepare IP transport procedure | | +| | | CP-060067 | 0352 | 1 | Correction on the used descriptor for trace package | | +| 2006-06 | CT#32 | CP-060315 | 0377 | 2 | Introduction of Profile Description Annex to Mc interface | 7.2.0 | +| | | CP-060315 | 0379 | | Corrections to Formats and Codes table | | +| | | CP-060315 | 0382 | 1 | Clarification of H.248.2 version in references | | +| | | CP-060315 | 0386 | | Correction of the error definition of Flextone | | +| | | CP-060307 | 0370 | | Corrigendum for H.248.1 version 2 | | +| | | CP-060301 | 0365 | 2 | DTMF Detection Type | | +| | | CP-060301 | 0368 | 1 | Sequential Signal Lists | | +| | | CP-060301 | 0374 | 2 | Multimedia & CSD calls | | +| | | CP-060301 | 0385 | 1 | Clarification of ROOT termination naming | | +| 2006-09 | CT#33 | CP-060411 | 0388 | 1 | Profile Description Annex: Connection model and Context Attributes | 7.3.0 | +| | | CP-060411 | 0389 | 2 | Profile Description Annex: Terminations | | +| | | CP-060411 | 0390 | 2 | Profile Description Annex: Descriptors | | +| | | CP-060411 | 0391 | 1 | Profile Description Annex: Message, Transport and Security | | +| | | CP-060411 | 0392 | 1 | Profile Description Annex: Mandatory and optional packages | | +| | | CP-060411 | 0393 | 2 | Profile Description Annex: H.248 packages | | +| | | CP-060411 | 0394 | 2 | Profile Description Annex: BICC packages | | +| | | CP-060411 | 0395 | 2 | Profile Description Annex: Mandatory and optional 3G packages | | +| | | CP-060411 | 0396 | 1 | Profile Description Annex : Command API | | +| | | CP-060411 | 0397 | 1 | Profile Description Annex : Generic command syntax and encoding | | +| | | CP-060411 | 0398 | 1 | Profile Description Annex : Transactions | | +| | | CP-060411 | 0399 | 1 | Profile Description Annex : Mandatory support of SDP and Annex C information elements | | +| | | CP-060411 | 0400 | 1 | Profile Description Annex : Optional support of SDP and Annex C information elements | | +| | | CP-060411 | 0401 | | Encoding of G.711 codec | | + +| Date | TSG # | TSG Doc. | CR | Re v | Subject/Comment | New | +|---------|-------|-----------|------|------|-------------------------------------------------------------------------------------|-------| +| | | CP-060400 | 0404 | 3 | Profile registration procedure | | +| | | CP-060411 | 0407 | 2 | Definition of the use of mandatory and optional in Mc Profile Template | | +| | | CP-060402 | 0409 | | Trace Package ID | | +| | | CP-060400 | 0412 | | AuditValue procedure | | +| | | CP-060400 | 0415 | 1 | Use of topology for tones and announcements | | +| | | CP-060397 | 0420 | | Modification of eventId named distant codec_list in threegtfoc package | | +| | | CP-060402 | 0427 | | Wildcarding of Release Termination Response | | +| | | CP-060400 | 0430 | | Correction to Emergency Call Indication Procedure | | +| | | CP-060400 | 0436 | 1 | Use of IPSec for Mc Interface | | +| | | CP-060400 | 0439 | 2 | Correction to use of Local Peer for CSD when Anchor MGW | | +| | | CP-060411 | 0441 | 2 | New Error Code for Temporary Busy | | +| | | CP-060411 | 0442 | 1 | Profile Description Annex: Descriptors (complements) | | +| | | CP-060411 | 0443 | | Profile Description Annex: Trace package | | +| 2006-12 | CT#34 | CP-060402 | 0447 | | Incomplete list of optional UMTS packages | 7.4.0 | +| | | CP-060569 | 0376 | 6 | Enhancements for VGCS/VBS in SPLIT architecture | | +| | | CP-060569 | 0452 | | Correct the initiator of NOT.resp command | | +| | | CP-060569 | 0474 | 1 | Removal of TBD for Number of Commands Per Transaction | | +| | | CP-060569 | 0485 | 1 | Event Tunnel indication for type BICC IP | | +| | | CP-060569 | 0486 | | Tunnel Option shall be used with Add.Req only | | +| | | CP-060569 | 0487 | | IP transport package properties not used within Mov.Req | | +| | | CP-060552 | 0459 | | Encoding of PLMN BC | | +| | | CP-060561 | 0461 | 1 | Trace package correction | | +| | | CP-060554 | 0464 | | Commands in Change flow direction procedure | | +| 2007-03 | CT#35 | CP-060718 | 0481 | 3 | Definite vs Indefinite encoding rules for binary H.248 | 7.5.0 | +| | | CP-070014 | 0490 | 3 | IP domain connection indication | | +| | | CP-070014 | 0491 | | Commands Marked Optional | | +| | | CP-070014 | 0494 | 1 | Prevention of signalling overload due to Notifications | | +| | | CP-070009 | 0497 | | Exclusion of use of inherited properties from network package | | +| | | CP-070014 | 0498 | 1 | Changing Profile description Annex C from Informative to Normative | | +| | | CP-070009 | 0501 | 1 | Signal List ID to Announcement Completed procedure | | +| 2007-06 | CT#36 | CP-070014 | 0508 | 1 | Stream ID parameters in Signals and Events | 7.6.0 | +| | | CP-070314 | 0511 | 1 | IMSI/IMEI encoding in trace package | | +| | | CP-070322 | 0512 | | Adding package ID to ASCI package | | +| | | CP-070322 | 0513 | | ServiceChangeMGCId parameter | | +| | | CP-070308 | 0520 | | RFC 3309 for SCTP checksum | | +| 2007-09 | CT#37 | CP-070322 | 0522 | | Modification to EventID name definition | 7.7.0 | +| | | CP-070530 | 0524 | 3 | Service Change Methods and Reasons | | +| | | CP-070530 | 0527 | | H.248 Message Encoding | | +| | | CP-070530 | 0528 | 1 | General Corrections To Profile | | +| | | CP-070530 | 0531 | 2 | Mc profile corrections | | +| | | CP-070530 | 0535 | 2 | Support inactivity timer (H.248.14) for MGWs detecting the failure of MGC | | +| 2007-09 | CT#37 | CP-070530 | 0537 | 1 | Completion of Text Telephony and Call Discrimination Packages | 8.0.0 | +| 2007-10 | | CP-070569 | 0536 | 3 | Mandatory use termination heartbeat (H.248.36) when establish bearer/prepare bearer | 8.0.1 | +| 2007-12 | CT#38 | | | | Track marks removed | 8.1.0 | +| | | CP-070752 | 0538 | 2 | Mc enhancements for SIP-I support | | +| | | CP-070756 | 0539 | 1 | Examples for Usage of the 3GUP Package "Initialization Direction" Property | | +| | | CP-070756 | 0541 | 1 | Optional reporting of normal AAL2 bearer release | | +| | | CP-070756 | 0556 | 1 | Individual audit of TDM termination | | +| | | CP-070749 | 0545 | | Heartbeat event in Send Tone and Play Announcement procedures | | +| | | CP-070749 | 0551 | 1 | Event Descriptor correction in Mc profile | | +| | | CP-070749 | 0553 | | Reference corrections | | +| | | CP-070749 | 0555 | 1 | Number of needed listener context terminations to ASCI package | | +| 2008-03 | CT#39 | CP-070740 | 0549 | 1 | Sequencing of Termination Out-of-Service and Termination Restoration procedures | 8.2.0 | +| | | CP-080020 | 0557 | 1 | Reserve / Configure RTP Connection Point, Modify Bearer Characteristics | | +| | | CP-080020 | 0558 | 1 | Other codecs for SIP-I based Nc | | +| | | CP-080011 | 0562 | 1 | BNC events in Prepare Bearer / Establish Bearer procedures | | +| | | CP-080025 | 0564 | | CAMEL prepaid warning tone missing from formats and codes table | | +| 2008-06 | CT#40 | CP-080020 | 0575 | 1 | Applicability of descriptors to RTP terminations | 8.3.0 | +| | | CP-080270 | 0585 | | Coding of the UDP Port Property | | + +| Date | TSG # | TSG Doc. | CR | Re
v | Subject/Comment | New | +|---------|------------|-----------|------|---------|------------------------------------------------------------------------------------|--------| +| | | CP-080269 | 0581 | 1 | Use of Release Bearer Procedure | | +| | | CP-080271 | 0576 | 1 | Correction of the inconsistencies in several procedures' description | | +| | | CP-080264 | 0577 | 2 | A interface over IP support | | +| | | CP-080262 | 0578 | 1 | Addition of SIP-I based Nc within the scope of TS 29.232 | | +| 2008-09 | CT#41 | CP-080466 | 0591 | 3 | IP interface type indicator | 8.4.0 | +| | | CP-080466 | 0592 | 1 | Use of Global Text Telephony with A over IP | | +| | | CP-080466 | 0593 | | Use of 'plmnbc' and 'gsm channel coding' in AoIP | | +| | | CP-080461 | 0594 | 1 | Expansion of scope for IMS Centralised Service Access | | +| | | CP-080466 | 0599 | | Support of GSM codec | | +| | | CP-080468 | 0601 | | CTM properties setting | | +| | | CP-080466 | 0604 | 1 | Emergency Call Indication for AoIP and SIP-I terminations | | +| | | CP-080453 | 0608 | | Service Change Reason in (G)MSC Server Out of Service | | +| 2008-12 | CT#42 | CP-080686 | 0610 | 1 | SDP Media Parameters For RTP Terminations | 8.5.0 | +| | | CP-080705 | 0611 | 1 | IP transport package properties handling | | +| | | CP-080697 | 0612 | 2 | No Data frame handling independent of Stream Mode property | | +| | | CP-080705 | 0613 | - | Adding package ID to 3G Interface Type package | | +| | | | 0617 | 2 | Support of Redundancy for CSD in Mc interface for AoIP | | +| | | | 0618 | 1 | CTM transport property in the Reserve and Configure RTP connection Point procedure | | +| | | | 0621 | | IP interface type for external SIP-I based network | | +| 2009-03 | CT#43 | CP-090034 | 0622 | - | Solving Incorrect references | 8.6.0 | +| | | | 0623 | | Removing of IP transport package from packages chapter of Mc profile | | +| 2009-06 | CT#44 | CP-090297 | 0624 | 1 | Missing Signalling Object in Formats and Codes table | 8.7.0 | +| 2009-09 | CT#45 | CP-090541 | 0625 | | Clarification of Use of Reserve and Configure RTP Connection Point | 8.8.0 | +| | | CP-090541 | 0626 | 1 | Missing RTP procedures from Circuit Switched Data package description | | +| | | CP-090544 | 0627 | - | Audit of Hanging Termination Detection package | | +| 2009-12 | CT#46 | CP-090763 | 0628 | - | Commands Using IP Interface Type | 8.9.0 | +| 2009-12 | CT#46 | | | | Upgraded unchanged from Rel-8 | 9.0.0 | +| 2010-04 | | | | | History table corrected | 9.0.1 | +| 2011-03 | CT#51 | CP-110100 | 0629 | 1 | Adding CS-Ix functionalities to Mc-profile | 9.1.0 | +| 2011-03 | CT#51 | CP-110277 | 0630 | 10 | ECN Support in Mc Interface | 10.0.0 | +| 2011-03 | CT#51 | CP-110070 | 0631 | 1 | Complete Inactivity Timeout Indication Procedure | | +| 2011-06 | CT#52 | CP-110368 | 0635 | 1 | ECN Failure improvements | 10.1.0 | +| | | CP-110368 | 0637 | 1 | Alignment of 3GPP profiles with SG16 ECN package definition | | +| 2011-09 | CT#53 | CP-110563 | 0639 | - | Media inactivity notification procedure | 10.2.0 | +| 2011-12 | CT#54 | CP-110789 | 0640 | 1 | ECN Improvements | 10.3.0 | +| 2012-06 | CT#56 | CP-120226 | 0641 | 1 | Reference update: draft-ietf-avtcore-ecn-for-rtp | 10.4.0 | +| 2012-09 | CT#57 | CP-120478 | 0642 | 1 | Support of Multimedia Priority Service (MPS) over Mc Interface – Stage 3 | 11.0.0 | +| 2012-12 | CT#58 | CP-120723 | 0646 | - | Mc interface updates of ECN Support Package | 11.1.0 | +| 2012-12 | CT#58 | CP-120727 | 0648 | 1 | H.248.52 Status Update | 11.1.0 | +| 2013-06 | CT#60 | CP-130294 | 0650 | 2 | ECN relying reference change | 11.2.0 | +| 2014-06 | CT#64 | CP-140248 | 0655 | 2 | ICE support in Mc interface | 12.0.0 | +| 2014-12 | CT#66 | CP-140788 | 0656 | 1 | Adding support for EVS codec | 12.1.0 | +| 2015-06 | CT#68 | CP-150272 | 0657 | 1 | Adding support for the EVS codec over UMTS CS | 13.0.0 | +| 2016-03 | CT#71 | CP-160048 | 0658 | 1 | Removal of references to TS 26.236 | 13.1.0 | +| 2016-03 | CT#71 | CP-160027 | 0659 | - | Resolution of Editor's note on EVS over UMTS CS | 13.1.0 | +| 2016-03 | CT#71 | CP-160021 | 0660 | 1 | Mc stage 3 to support SDP Capability Negotiation | 13.1.0 | +| 2016-12 | CT#74 | CP-160662 | 0661 | 1 | Update to example of Mc Single Codec encoding for EVS | 13.2.0 | +| 2017-03 | - | - | - | - | Update to Rel-14 version (MCC) | 14.0.0 | +| 2018-06 | CT#88
e | - | - | - | Update to Rel-15 version (MCC) | 15.0.0 | +| 2020-07 | - | - | - | - | Update to Rel-16 version (MCC) | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29235/08e8bbb2a063a3935a0c649b39ade125_img.jpg b/marked/Rel-16/29_series/29235/08e8bbb2a063a3935a0c649b39ade125_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c38d2edb2f7a55fcf612396a4d641f991b0f12a0 --- /dev/null +++ b/marked/Rel-16/29_series/29235/08e8bbb2a063a3935a0c649b39ade125_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b455765c73787a06fa4e73e9a4ea6d7eebe3339755476bd4584508280c0b1c86 +size 45549 diff --git a/marked/Rel-16/29_series/29235/1b5a812c8aa20fd5cba28e97001d32de_img.jpg b/marked/Rel-16/29_series/29235/1b5a812c8aa20fd5cba28e97001d32de_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..fa85798fbbcd92ba33dbea1102d05f51f054e255 --- /dev/null +++ b/marked/Rel-16/29_series/29235/1b5a812c8aa20fd5cba28e97001d32de_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:62a1df3bd51d4a60cba86f98a349b1b9284b84e28c0ef931d8fd3df103aeb6f6 +size 71094 diff --git a/marked/Rel-16/29_series/29235/1ea7909aea2fb749a6fe98fbdb8cacae_img.jpg b/marked/Rel-16/29_series/29235/1ea7909aea2fb749a6fe98fbdb8cacae_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4e9383191d6db829a242aa79fbac35d690098afe --- /dev/null +++ b/marked/Rel-16/29_series/29235/1ea7909aea2fb749a6fe98fbdb8cacae_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:60307b3e82b2c56785e63cedb00a948175f0536c3505e913f7f050fd346bfda4 +size 29285 diff --git a/marked/Rel-16/29_series/29235/26e334e61dd059cff029338a2a604d8d_img.jpg b/marked/Rel-16/29_series/29235/26e334e61dd059cff029338a2a604d8d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6b8b6bc77fe4a97c183a21e1df0b6fdeb825a37b --- /dev/null +++ b/marked/Rel-16/29_series/29235/26e334e61dd059cff029338a2a604d8d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0606bef9eabffc4f1e4b0cd57ae1046eff00b63865676bb2459f907df6524a45 +size 26595 diff --git a/marked/Rel-16/29_series/29235/2cf3896394a2342a2b46c504ab9a8830_img.jpg b/marked/Rel-16/29_series/29235/2cf3896394a2342a2b46c504ab9a8830_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b8dee38ec4f9cc9a189af1b8767ba4d76cfc0294 --- /dev/null +++ b/marked/Rel-16/29_series/29235/2cf3896394a2342a2b46c504ab9a8830_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f98ad7f9b88a644e30767db069a4f4866c3879d005c1fbd5f2deb0fd8974ff00 +size 155424 diff --git a/marked/Rel-16/29_series/29235/2d863654cf3803cea82b686d9b3ebee8_img.jpg b/marked/Rel-16/29_series/29235/2d863654cf3803cea82b686d9b3ebee8_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6cd6dc6dbfbac4a33ae97b219cd5bd5a864eefaa --- /dev/null +++ b/marked/Rel-16/29_series/29235/2d863654cf3803cea82b686d9b3ebee8_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f9b8369d19519e189e9fbd6e2254d84fe56eb0438887bb1374a80355043446cb +size 26182 diff --git a/marked/Rel-16/29_series/29235/3198cdf0dbe501c46fe0e4073c7d8451_img.jpg b/marked/Rel-16/29_series/29235/3198cdf0dbe501c46fe0e4073c7d8451_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..de30722ecb8f4b4cd0782a8bec300b5f585a833b --- /dev/null +++ b/marked/Rel-16/29_series/29235/3198cdf0dbe501c46fe0e4073c7d8451_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8fb105a73206625274b4b7ba094a870437cf4b1111cfaa07bc838fd742071062 +size 136043 diff --git a/marked/Rel-16/29_series/29235/32ff77da4286b58c4778033acaa10836_img.jpg b/marked/Rel-16/29_series/29235/32ff77da4286b58c4778033acaa10836_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ba1d3dcea77d3da20fc52a0ef3bf6c018e2b07d6 --- /dev/null +++ b/marked/Rel-16/29_series/29235/32ff77da4286b58c4778033acaa10836_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:daf1714ef521d6f38f6fabcea3e546656e07b0e87b90e040f19aec356a52cca9 +size 53462 diff --git a/marked/Rel-16/29_series/29235/3337af75dfee8af7687b4f49914d6c93_img.jpg b/marked/Rel-16/29_series/29235/3337af75dfee8af7687b4f49914d6c93_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..803726c51b52b0622f553a525f92d3cf2f1a216a --- /dev/null +++ b/marked/Rel-16/29_series/29235/3337af75dfee8af7687b4f49914d6c93_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7c1dc7f20fc8c0b395fd70224f545c8b3fe0c8fca24e8c655895e29247c98d92 +size 77999 diff --git a/marked/Rel-16/29_series/29235/3c04b14104f95eb8f7100f6d497d956e_img.jpg b/marked/Rel-16/29_series/29235/3c04b14104f95eb8f7100f6d497d956e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ea4d6628c9e666999cb32f5a81eae0b0436a4667 --- /dev/null +++ b/marked/Rel-16/29_series/29235/3c04b14104f95eb8f7100f6d497d956e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:af4fb263c6e7d4a0b267828af39841dbf0b415b778e5f4b5dce0b8c2426b38e0 +size 165293 diff --git a/marked/Rel-16/29_series/29235/421fc75480c21e7ebb25756826652367_img.jpg b/marked/Rel-16/29_series/29235/421fc75480c21e7ebb25756826652367_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5e984fe327a20121363a02011c51e6f7247f87ce --- /dev/null +++ b/marked/Rel-16/29_series/29235/421fc75480c21e7ebb25756826652367_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:39393ca32831d941b215ae5dd1ab1d6f142e0f3b5ac1e1aae67d07210707c4c4 +size 32755 diff --git a/marked/Rel-16/29_series/29235/65e8c0628536d6d4245e9ab46ba070c3_img.jpg b/marked/Rel-16/29_series/29235/65e8c0628536d6d4245e9ab46ba070c3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4a05685e95c99d8c0cee676f6bbc0e02536e2c04 --- /dev/null +++ b/marked/Rel-16/29_series/29235/65e8c0628536d6d4245e9ab46ba070c3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4864e4a56b8a81cf2832d43118e706fdef9a9ae2c1a688d9e869ba185108a9a1 +size 186439 diff --git a/marked/Rel-16/29_series/29235/747516f5861a0ddf31e3851da8e34b95_img.jpg b/marked/Rel-16/29_series/29235/747516f5861a0ddf31e3851da8e34b95_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..baa32e692972f22d89ef63f4937e33e1a0a040ee --- /dev/null +++ b/marked/Rel-16/29_series/29235/747516f5861a0ddf31e3851da8e34b95_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:09078281c4cf7a5fce5cde525f76a56219ba68edd2beabfd0d0ff334a9475fa1 +size 17574 diff --git a/marked/Rel-16/29_series/29235/7ed5d5770331f31ade15439a21c31425_img.jpg b/marked/Rel-16/29_series/29235/7ed5d5770331f31ade15439a21c31425_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e04bcd2548fd1d81e2b081001b54e1027c927ac0 --- /dev/null +++ b/marked/Rel-16/29_series/29235/7ed5d5770331f31ade15439a21c31425_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:22f499008b8a98a7082b6e62fdd872062651c6883eb485c9363cf02f347bc8eb +size 97181 diff --git a/marked/Rel-16/29_series/29235/8269648391c59363ea61243864a2adf7_img.jpg b/marked/Rel-16/29_series/29235/8269648391c59363ea61243864a2adf7_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a56b53303c4e44b9c7357de10a1a6d58ed36a97c --- /dev/null +++ b/marked/Rel-16/29_series/29235/8269648391c59363ea61243864a2adf7_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9e3fc58136316c6446496dfe815f124fad69a3c9d680f56261b3891263d8ec6d +size 69587 diff --git a/marked/Rel-16/29_series/29235/836b0790cef5469a167fa8931df4e408_img.jpg b/marked/Rel-16/29_series/29235/836b0790cef5469a167fa8931df4e408_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6cb4ae4a4d0a6ad715706700faa7cf9111477b98 --- /dev/null +++ b/marked/Rel-16/29_series/29235/836b0790cef5469a167fa8931df4e408_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:246ad46b09a6a2f288d4917b149048b9c95274b05a87ff7fdc4f5b4ae95a2752 +size 28033 diff --git a/marked/Rel-16/29_series/29235/86bd357c573c9696393f5bde4d4cce4f_img.jpg b/marked/Rel-16/29_series/29235/86bd357c573c9696393f5bde4d4cce4f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f6b46ad19e4b25f39d9e1ef7d7f4c15daf55b89a --- /dev/null +++ b/marked/Rel-16/29_series/29235/86bd357c573c9696393f5bde4d4cce4f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cbff368fe6295548b7be95f52c6ded18d84c6c752da22941fe426b5e53796724 +size 20912 diff --git a/marked/Rel-16/29_series/29235/8e80de0cac529b2c3775d677c5203133_img.jpg b/marked/Rel-16/29_series/29235/8e80de0cac529b2c3775d677c5203133_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6a478045159814640aeebf1171c07f7d0982f749 --- /dev/null +++ b/marked/Rel-16/29_series/29235/8e80de0cac529b2c3775d677c5203133_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:18f9277e6f6864796038f63fefd49a38a327e779798d2a9a72797cc75f244c2d +size 21847 diff --git a/marked/Rel-16/29_series/29235/90ddb84c323b956e2d50a54d3f870566_img.jpg b/marked/Rel-16/29_series/29235/90ddb84c323b956e2d50a54d3f870566_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c638db78201d88fe54a7ef66fbb60b3f5ea0a6e4 --- /dev/null +++ b/marked/Rel-16/29_series/29235/90ddb84c323b956e2d50a54d3f870566_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a864cfbb4640882d88e016f7c533abe9fc7c2167e838afdf970f2a3a9e9aca71 +size 186523 diff --git a/marked/Rel-16/29_series/29235/99781d878388c3e0f359b1d6ce14119c_img.jpg b/marked/Rel-16/29_series/29235/99781d878388c3e0f359b1d6ce14119c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8ef61074406dfdc6e8ed2e9015488bd9f73dad43 --- /dev/null +++ b/marked/Rel-16/29_series/29235/99781d878388c3e0f359b1d6ce14119c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6c25dd209b1a080822fee7bf0530d38171362c94cb4407a211c897d6d51c7637 +size 17754 diff --git a/marked/Rel-16/29_series/29235/9a14684f8ae1345c6efea6f5994c730c_img.jpg b/marked/Rel-16/29_series/29235/9a14684f8ae1345c6efea6f5994c730c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..73d245ea4139ed4175528ad035f86ca3012021c6 --- /dev/null +++ b/marked/Rel-16/29_series/29235/9a14684f8ae1345c6efea6f5994c730c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:34983d5e1ec9c53a9c891b0059f3846ff50e6661354c983619328fb4f075f39e +size 73179 diff --git a/marked/Rel-16/29_series/29235/9b1ec0090070bdf52ea28763b8d52477_img.jpg b/marked/Rel-16/29_series/29235/9b1ec0090070bdf52ea28763b8d52477_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..35fdc6614c94696e7399737581a90569391632e9 --- /dev/null +++ b/marked/Rel-16/29_series/29235/9b1ec0090070bdf52ea28763b8d52477_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3e5bbb032e353b96c1454c93a13ac545f8dff80879bed76249a4f98e70d3c448 +size 176172 diff --git a/marked/Rel-16/29_series/29235/9c1d3678db4a12d5864cb2a4def1135d_img.jpg b/marked/Rel-16/29_series/29235/9c1d3678db4a12d5864cb2a4def1135d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2c72d4a098f4770c072dc571daded8c8e3275726 --- /dev/null +++ b/marked/Rel-16/29_series/29235/9c1d3678db4a12d5864cb2a4def1135d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f70fbb64abf49ce2b71dbb919167bb9c413ba9cb6c2b002e68c59c458fa00045 +size 197546 diff --git a/marked/Rel-16/29_series/29235/9e8ebf03cae78f4f81b697548c2d7250_img.jpg b/marked/Rel-16/29_series/29235/9e8ebf03cae78f4f81b697548c2d7250_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1c4c5d88f372e07e28f6bcca2f562fa4298829c8 --- /dev/null +++ b/marked/Rel-16/29_series/29235/9e8ebf03cae78f4f81b697548c2d7250_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3057aa1615aeaae4e41b10c0e8cb6415033f8faf518203156e87a70317772f3d +size 42605 diff --git a/marked/Rel-16/29_series/29235/a4bfa2343d75076b79f7e33d93915e00_img.jpg b/marked/Rel-16/29_series/29235/a4bfa2343d75076b79f7e33d93915e00_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..34b34c16c4805f19390187ee88ac4f50fb827f95 --- /dev/null +++ b/marked/Rel-16/29_series/29235/a4bfa2343d75076b79f7e33d93915e00_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7e75d7c570cd86177b22e66da8f201d12d9df99bb1e9498b2c504578e02a54e5 +size 160035 diff --git a/marked/Rel-16/29_series/29235/a70e0adcabc973b01b413b6a141884f3_img.jpg b/marked/Rel-16/29_series/29235/a70e0adcabc973b01b413b6a141884f3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..faa07d220986d30a124f248f69c968ac7bdecc78 --- /dev/null +++ b/marked/Rel-16/29_series/29235/a70e0adcabc973b01b413b6a141884f3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:93aaabdfee7cbb9f5593c2be36b70dadfacdbfabe8fad323d6bdf362f7c993b3 +size 42266 diff --git a/marked/Rel-16/29_series/29235/ae53f90bb87d6d09e2d6b5278d7c338f_img.jpg b/marked/Rel-16/29_series/29235/ae53f90bb87d6d09e2d6b5278d7c338f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..bfed976a556891f7cc74b2f4edb7214770291437 --- /dev/null +++ b/marked/Rel-16/29_series/29235/ae53f90bb87d6d09e2d6b5278d7c338f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8aeda62b03be828c76404e234377f93577c62b82c41d8349738559719e1c4189 +size 175966 diff --git a/marked/Rel-16/29_series/29235/b6ad8b32179842fca5ad086cf22b03eb_img.jpg b/marked/Rel-16/29_series/29235/b6ad8b32179842fca5ad086cf22b03eb_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f278cab33f35abe190091582be1e753866ef0698 --- /dev/null +++ b/marked/Rel-16/29_series/29235/b6ad8b32179842fca5ad086cf22b03eb_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:246adfac0819adb4ac7c5dc357abff84daf76a0e0fdedb71916d79130a657892 +size 54755 diff --git a/marked/Rel-16/29_series/29235/ccfd5ed8d9795009e923e2a0cacbcd6e_img.jpg b/marked/Rel-16/29_series/29235/ccfd5ed8d9795009e923e2a0cacbcd6e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0e1ab2fd3ea9f9b53458d9e3e8b88064f97d1ab3 --- /dev/null +++ b/marked/Rel-16/29_series/29235/ccfd5ed8d9795009e923e2a0cacbcd6e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5a09feab251c0306069a1660ee479da7f78e58012749ea90e1a043250729d5b6 +size 30990 diff --git a/marked/Rel-16/29_series/29235/d8698aacaeead6dfed9a1e448670a2e4_img.jpg b/marked/Rel-16/29_series/29235/d8698aacaeead6dfed9a1e448670a2e4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..120afc9c013208fcd537993ec89353733d97770c --- /dev/null +++ b/marked/Rel-16/29_series/29235/d8698aacaeead6dfed9a1e448670a2e4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:33b07d5a28c14f47510143e412e318bdc21923d868c43b88aa65da1ce6f89cc2 +size 38300 diff --git a/marked/Rel-16/29_series/29235/dbbc0baac7341cda76cc4f8355dce23f_img.jpg b/marked/Rel-16/29_series/29235/dbbc0baac7341cda76cc4f8355dce23f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..415ae96f681c946014cf3cea2f966a5a3745c100 --- /dev/null +++ b/marked/Rel-16/29_series/29235/dbbc0baac7341cda76cc4f8355dce23f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:150ceb8e4d0a7f06e29d92b776225608edcc12137b591913ca7594446368a014 +size 53456 diff --git a/marked/Rel-16/29_series/29235/dd5771673aececa53d42ece89218299d_img.jpg b/marked/Rel-16/29_series/29235/dd5771673aececa53d42ece89218299d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a0c6f1e420b2429cb09d98118fc995479af54bca --- /dev/null +++ b/marked/Rel-16/29_series/29235/dd5771673aececa53d42ece89218299d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fb27790d0e053c545c10b394d1ea0cbee160c962db0354348f8f1d487372b941 +size 183376 diff --git a/marked/Rel-16/29_series/29235/e05b36c0d46549e681ce6581422c66b2_img.jpg b/marked/Rel-16/29_series/29235/e05b36c0d46549e681ce6581422c66b2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1f36d94bb588c8325874668f0968bf36ca185a3e --- /dev/null +++ b/marked/Rel-16/29_series/29235/e05b36c0d46549e681ce6581422c66b2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:477604459bf5dcc2dcb12ead511a0814e72382553ffb839a00766b04ecc02de8 +size 178391 diff --git a/marked/Rel-16/29_series/29235/f468e577645d646f5157ce3eefb4ed96_img.jpg b/marked/Rel-16/29_series/29235/f468e577645d646f5157ce3eefb4ed96_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..815bc44eec0f74eac3a1705da058285248e31fa8 --- /dev/null +++ b/marked/Rel-16/29_series/29235/f468e577645d646f5157ce3eefb4ed96_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8535f57de6ca083e22cd066e63c49e408806dfa2ed0773a6a7da63cd965b4d8b +size 54716 diff --git a/marked/Rel-16/29_series/29235/raw.md b/marked/Rel-16/29_series/29235/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..ad08ae2a0a4000f29c4f2ab1f831313ad8ede692 --- /dev/null +++ b/marked/Rel-16/29_series/29235/raw.md @@ -0,0 +1,3749 @@ + + + + + + +# Contents + +| | | +|--------------------------------------------------------------------------------------------------------------------------------------------------------|----| +| Foreword ..... | 9 | +| 1 Scope..... | 10 | +| 2 References..... | 10 | +| 3 Definitions and abbreviations ..... | 12 | +| 3.1 Definitions..... | 12 | +| 3.2 Abbreviations ..... | 13 | +| 4 Interworking between a SIP-I based circuit-switched core network and an external SIP-I based network..... | 14 | +| 4.1 Reference Model ..... | 14 | +| 4.2 Signalling Interworking of a Call from the external SIP-I based network towards the SIP-I based circuit-switched core network..... | 15 | +| 4.2.1 Interworking of SIP-I messages received from external SIP-I network..... | 15 | +| 4.2.1.1 General..... | 15 | +| 4.2.1.2 Call Release from external SIP-I network when encapsulated REL is missing ..... | 15 | +| 4.2.2 Special Procedures for the reception of initial SIP INVITE requests ..... | 15 | +| 4.2.2.1 Receipt of SIP INVITE request ..... | 15 | +| 4.2.2.2 Receipt of SIP INVITE requests with SDP ..... | 15 | +| 4.2.2.3 Receipt of SIP INVITE request without SDP..... | 15 | +| 4.2.2.4 MGW Selection ..... | 16 | +| 4.2.3 Interworking of SIP-I messages received from succeeding 3GPP node ..... | 16 | +| 4.2.4 Special Procedures for Profile Interworking ..... | 16 | +| 4.2.4.1 Support of 100Rel..... | 16 | +| 4.2.4.2 Support for UPDATE method ..... | 16 | +| 4.2.4.3 Support for Preconditions ..... | 17 | +| 4.2.5 Support for Codec Negotiation..... | 17 | +| 4.2.6 Special Procedures for the reception of SIP Re-INVITE requests..... | 17 | +| 4.2.6.1 Receipt of SIP Re-INVITE request without SDP ..... | 17 | +| 4.3 Signalling Interworking of a Call from SIP-I based circuit-switched core network towards the external SIP-I based network ..... | 18 | +| 4.3.1 Interworking of SIP-I messages received from preceding 3GPP node ..... | 18 | +| 4.3.1.1 General..... | 18 | +| 4.3.1.2 Call Release from external SIP-I network when encapsulated REL is missing ..... | 18 | +| 4.3.2 Special Procedures for the reception of SIP INVITE requests..... | 18 | +| 4.3.3 Special Procedures for Profile Interworking ..... | 18 | +| 4.3.3.1 Support of 100Rel..... | 18 | +| 4.3.3.2 Support for UPDATE method ..... | 19 | +| 4.3.3.3 Support for Preconditions ..... | 19 | +| 4.3.4 Support for Codec Negotiation..... | 20 | +| 4.3.5 MGW Selection ..... | 20 | +| 4.4 DMTF Signalling Interworking applicable for all Calls between an external SIP-I based network and a SIP-I based circuit-switched core network..... | 21 | +| 4.4.1 General ..... | 21 | +| 4.4.2 DTMF support in SDP offer sent to External SIP-I network ..... | 21 | +| 4.4.3 DTMF support in SDP offer received from External SIP-I network ..... | 22 | +| 4.5 User Plane Interworking..... | 23 | +| 4.5.1 General ..... | 23 | +| 4.5.2 DTMF Interworking ..... | 23 | +| 4.6 Example Call flows ..... | 23 | +| 4.6.1 General ..... | 23 | +| 4.6.2 Incoming Call flows ..... | 24 | +| 4.6.2.1 Incoming Call - no preconditions in external network ..... | 24 | +| 4.6.2.2 Incoming Call with preconditions not met ..... | 26 | +| 4.6.3 Outgoing Call flows ..... | 28 | +| 4.6.3.1 Outgoing Call with support for preconditions ..... | 28 | +| 4.6.3.2 Outgoing Call with support of 100rel but no support for preconditions ..... | 30 | +| 4.6.3.3 Outgoing Call without support for 100rel and preconditions ..... | 32 | + +| | | | +|-----------|------------------------------------------------------------------------------------------------------------------------------------|----| +| 5 | Interworking between a SIP-I based circuit-switched core network and an ISUP based network..... | 34 | +| 5.1 | Reference Model ..... | 34 | +| 5.2 | Control Plane Interworking ..... | 34 | +| 5.3 | Signalling Interworking of a Call from the ISUP based network towards the SIP-I based circuit-switched core network..... | 36 | +| 5.3.1 | General ..... | 36 | +| 5.3.1.1 | Sending of ISUP information to adjacent SIP nodes ..... | 36 | +| 5.3.1.2 | Receipt of encapsulated ISUP information within SIP-I ..... | 36 | +| 5.3.1.3 | Special procedures related to outgoing INVITE..... | 37 | +| 5.3.1.3.1 | Overlap Signalling..... | 37 | +| 5.3.1.3.2 | Coding of encapsulated ISUP IAM parameters in outgoing INVITE ..... | 37 | +| 5.3.1.3.3 | Media offered in SDP of outgoing INVITE..... | 37 | +| 5.4 | Signalling Interworking of a Call from SIP-I based circuit-switched core network towards the ISUP based network..... | 37 | +| 5.4.1 | General ..... | 37 | +| 5.4.2 | Interworking of received ISUP messages to SIP messages..... | 37 | +| 5.4.3 | Interworking of received SIP messages to ISUP messages..... | 37 | +| 5.4.3.1 | Receipt of encapsulated ISUP information within SIP..... | 37 | +| 5.4.3.2 | Special Procedures for the Reception of SIP INVITE request ..... | 38 | +| 5.4.3.2.1 | Propagation of overlap signalling toward the 3GPP CS domain ..... | 38 | +| 5.4.3.2.2 | Derivation of TMR, USI and HLC parameters within sent IAM message..... | 38 | +| 5.4.3.2.3 | Receipt of SIP INVITE without SDP offer ..... | 38 | +| 5.4.3.2.4 | Special Procedures for deferred MGW selection procedure..... | 38 | +| 5.5 | Supplementary services..... | 38 | +| 5.5.1 | Special procedures for supplementary service interworking..... | 38 | +| 5.5.2 | Interworking of CLIP/CLIR supplementary service ..... | 39 | +| 5.5.3 | Interworking of Call Hold (HOLD) supplementary service..... | 39 | +| 5.5.4 | Interworking of Completion of Calls to Busy Subscriber (CCBS) supplementary service to SIP networks ..... | 39 | +| 5.6 | User Plane Interworking..... | 39 | +| 5.6.1 | General ..... | 39 | +| 5.6.2 | DTMF ..... | 39 | +| 5.7 | Example Call flows ..... | 40 | +| 6 | Interworking between a SIP-I based circuit-switched core network and a BICC based network ..... | 40 | +| 6.1 | Reference Model ..... | 40 | +| 6.2 | Control Plane Interworking ..... | 41 | +| 6.2.1 | General ..... | 41 | +| 6.2.2 | Signalling interactions between network entities in the control plane ..... | 41 | +| 6.3 | Signalling Interworking of a Call from the BICC based network towards the SIP-I based circuit-switched core network..... | 42 | +| 6.4 | Signalling Interworking of a Call from SIP-I based circuit-switched core network towards the BICC based network..... | 42 | +| 6.5 | Supplementary services..... | 42 | +| 6.6 | Codec Negotiation between a BICC based network and a SIP-I based circuit-switched core network ..... | 43 | +| 6.6.1 | General ..... | 43 | +| 6.6.2 | Codec Negotiation from SIP-I on Nc to BICC Network..... | 43 | +| 6.6.2.1 | Sending of IAM ..... | 43 | +| 6.6.2.2 | Sending of SDP Answer ..... | 43 | +| 6.6.2.3 | Mid-call Codec Negotiation initiated from SIP-I on Nc..... | 43 | +| 6.6.3 | Codec Negotiation from BICC Network to SIP-I on Nc..... | 43 | +| 6.6.3.1 | Sending of initial SDP Offer..... | 43 | +| 6.6.3.2 | Responding to Serving Node initiating Codec Negotiation..... | 43 | +| 6.6.3.3 | Mid-call Codec Negotiation initiated from BICC ..... | 44 | +| 6.7 | DMTF Signalling Interworking applicable for all Calls between a BICC network and a SIP-I based circuit-switched core network ..... | 44 | +| 6.7.1 | General ..... | 44 | +| 6.7.2 | DTMF transfer from SIP-I on Nc to BICC network (Out-of-Band DTMF) ..... | 44 | +| 6.7.3 | DTMF transfer from BICC network (Out-of-Band DTMF) to SIP-I on Nc ..... | 45 | +| 6.7.4 | SIP-I on Nc interworking with BICC for Inband DTMF ..... | 46 | +| 6.8 | User Plane Interworking..... | 46 | +| 6.8.1 | General ..... | 46 | + +| | | | +|---------|--------------------------------------------------------------------------------------------------------------------------------------------------|----| +| 6.8.2 | DTMF Interworking ..... | 46 | +| 6.9 | Example Call flows ..... | 46 | +| 7 | Interworking between a SIP-I based circuit-switched core network and the IP Multimedia (IM) Core Network (CN) Subsystem ..... | 47 | +| 7.1 | Reference Model ..... | 47 | +| 7.1.1 | General ..... | 47 | +| 7.1.2 | Signalling interactions between network entities in the control plane ..... | 47 | +| 7.2 | Signalling Interworking of a Call from the IP Multimedia Subsystem towards the SIP-I based circuit-switched core network..... | 48 | +| 7.2.1 | General ..... | 48 | +| 7.2.2 | Exceptions from forwarding received SIP messages ..... | 49 | +| 7.2.3 | Sending SIP INVITE request ..... | 49 | +| 7.2.4 | Updating Precondition Information..... | 50 | +| 7.2.5 | SDP Codec Negotiation..... | 50 | +| 7.2.6 | MGW Selection ..... | 50 | +| 7.2.7 | Autonomous Release..... | 50 | +| 7.2.8 | Further setting of SIP header values..... | 50 | +| 7.3 | Signalling Interworking of a Call from SIP-I based circuit-switched core network towards the IP Multimedia Subsystem..... | 52 | +| 7.3.1 | General ..... | 52 | +| 7.3.2 | Exceptions from forwarding received SIP messages ..... | 52 | +| 7.3.3 | Sending SIP INVITE request ..... | 53 | +| 7.3.4 | Updating Precondition Information..... | 53 | +| 7.3.5 | Receipt of SIP redirect (3xx) response ..... | 54 | +| 7.3.6 | SDP Codec Negotiation..... | 54 | +| 7.3.7 | MGW Selection ..... | 54 | +| 7.3.8 | Autonomous Release..... | 55 | +| 7.3.9 | Handling of forked SIP Responses..... | 55 | +| 7.3.9.1 | SIP Dialogues ..... | 55 | +| 7.3.9.2 | Reception of non-100 provisional Responses to initial INVITE..... | 55 | +| 7.3.9.3 | Reception of final Responses to initial INVITE..... | 55 | +| 7.3.10 | Further setting of SIP header values..... | 56 | +| 7.4 | DMTF Signalling Interworking applicable for all Calls between an IP Multimedia CN Subsystem and a SIP-I based circuit-switched core network..... | 57 | +| 7.5 | User Plane Interworking..... | 57 | +| 7.5.1 | General ..... | 57 | +| 7.5.2 | DTMF Interworking ..... | 58 | +| 7.6 | Example Call flows ..... | 58 | +| 7.6.1 | General ..... | 58 | +| 7.6.2 | Incoming Call flows ..... | 58 | +| 7.6.2.1 | Successful Call Establishment and Call Release ..... | 58 | +| 7.6.2.2 | Autonomous Release at MGCF ..... | 60 | +| 7.6.3 | Outgoing Call flows ..... | 61 | +| 7.6.3.1 | Outgoing Call, Sending of INVITE is deferred ..... | 61 | +| 7.6.3.2 | Outgoing Call, Sending of INVITE is not deferred..... | 62 | +| 7.6.3.3 | Interworking with forked SIP INVITE Requests ..... | 64 | +| 7.7 | CS CN Supplementary Services and IMS Supplementary Services ..... | 67 | +| 7.7.0 | General ..... | 67 | +| 7.7.1 | Number Identification Services ..... | 67 | +| 7.7.1.1 | CS CN Supplementary Service - Calling Line Identification Presentation/Restriction (CLIP/CLIR)..... | 67 | +| 7.7.1.2 | CS CN Supplementary Service - Connected Line Identification Presentation /Restriction (COLP/COLR)..... | 67 | +| 7.7.1.3 | IMS Supplementary Service - Originating Identification Presentation (OIP) and Originating Identification Restriction (OIR)..... | 67 | +| 7.7.1.4 | IMS Supplementary Service - Terminating Identification Presentation (TIP) and Terminating Identification Restriction (TIR) ..... | 67 | +| 7.7.1.5 | CS CN Supplementary Service - Direct Dialling In ..... | 67 | +| 7.7.1.6 | CS CN Supplementary Service - Malicious Call Identification ..... | 68 | +| 7.7.1.7 | IMS Supplementary Service - Malicious Communication Identification (MCID) ..... | 68 | +| 7.7.1.8 | CS CN Supplementary Service - Subaddressing ..... | 68 | + +| | | | +|----------|-----------------------------------------------------------------------------------------------------------------------------------------------|----| +| 7.7.2 | Diversion Services..... | 68 | +| 7.7.2.1 | CS CN Supplementary Service - Call Forwarding Services (CFU, CFB, CFNRy, CFNRc)..... | 68 | +| 7.7.2.2 | CS CN Supplementary Service - Call Deflection (CD)..... | 68 | +| 7.7.2.3 | IMS Supplementary Service - Communication Diversion (CDIV)..... | 68 | +| 7.7.3 | Waiting Services..... | 68 | +| 7.7.3.1 | CS CN Supplementary Service - Call Waiting..... | 68 | +| 7.7.3.2 | IMS Supplementary Service - Communication Waiting (CW)..... | 68 | +| 7.7.4 | Hold Services..... | 68 | +| 7.7.4.1 | CS CN Supplementary Service - Call Hold..... | 68 | +| 7.7.4.2 | IMS Supplementary Service - Communication Hold (HOLD)..... | 69 | +| 7.7.5 | Multipart Services..... | 69 | +| 7.7.5.1 | CS CN Supplementary Services - Conference Calling (CONF) and Three-Party (3PTY)..... | 69 | +| 7.7.5.2 | IMS Supplementary Service - Conference (CONF)..... | 69 | +| 7.7.6 | Closed User Group Service..... | 69 | +| 7.7.6.1 | CS CN Supplementary Service - Closed User Group (CUG)..... | 69 | +| 7.7.6.2 | IMS Supplementary Service - Closed User Group (CUG)..... | 69 | +| 7.7.7 | Charging Services..... | 69 | +| 7.7.7.1 | CS CN Supplementary Service - Advice of Charge (AoC)..... | 69 | +| 7.7.7.2 | IMS Supplementary Service - Advice of Charge (AOC)..... | 69 | +| 7.7.7.3 | CS CN Supplementary Service - International Telecommunication Charge Card (ITCC)..... | 69 | +| 7.7.7.4 | CS CN Supplementary Service - Reverse Charging (REV)..... | 69 | +| 7.7.8 | Barring Services..... | 70 | +| 7.7.8.1 | CS CN Supplementary Service - Barring of Outgoing Calls..... | 70 | +| 7.7.8.2 | CS CN Supplementary Service - Barring of Incoming Calls..... | 70 | +| 7.7.8.3 | CS CN Supplementary Service - Anonymous Call Rejection (ACR)..... | 70 | +| 7.7.8.4 | IMS Supplementary Service - Communication Barring (CB)..... | 70 | +| 7.7.8.5 | IMS Supplementary Service - Anonymous Communication Rejection (ACR)..... | 70 | +| 7.7.9 | Transfer Services..... | 70 | +| 7.7.9.1 | CS CN Supplementary Service - Explicit Call Transfer (ECT)..... | 70 | +| 7.7.9.2 | IMS Supplementary Service - Explicit Communication Transfer (ECT)..... | 70 | +| 7.7.10 | Call Completion Services..... | 71 | +| 7.7.10.1 | CS CN Supplementary Service - Completion of Calls to Busy Subscriber (CCBS)..... | 71 | +| 7.7.10.2 | CS CN Supplementary Service - Completion of Calls on No Reply (CCNR)..... | 71 | +| 7.7.10.3 | IMS Supplementary Service - Completion of Communications to Busy Subscriber (CCBS) and
Completion of Communication on No Reply (CCNR)..... | 71 | +| 7.7.11 | Miscellaneous Services..... | 71 | +| 7.7.11.1 | CS CN Supplementary Service - Multi-Level Precedence and Pre-emption (MLPP)..... | 71 | +| 7.7.11.2 | CS CN Supplementary Service - Multiple Subscriber Profile (MSP)..... | 71 | +| 7.7.11.3 | CS CN Supplementary Service - Multicall..... | 71 | +| 7.7.11.4 | CS CN Supplementary Service - Calling Name Presentation..... | 71 | +| 7.7.11.5 | CS CN Supplementary Service - User-to-User Signalling (UUS)..... | 71 | +| 7.7.11.6 | IMS Supplementary Service - Message Waiting Indication (MWI)..... | 71 | +| 7.7.11.7 | CS CN Supplementary Service - Global Virtual Network Service (GVNS)..... | 71 | +| 7.7.11.8 | CS CN Supplementary Service - Terminal Portability (TP)..... | 72 | +| 7.7.12 | Customized Alerting Tones Services..... | 72 | +| 7.7.12.1 | CS CN Supplementary Service - Customized Alerting Tones (CAT)..... | 72 | +| 7.7.12.2 | IMS Supplementary Service - Customized Alerting Tones (CAT) for early session model..... | 72 | +| 7.7.12.3 | IMS Supplementary Service - Customized Alerting Tones (CAT) for forking model..... | 72 | +| 7.7.12.4 | IMS Supplementary Service - Customized Alerting Tones (CAT) for gateway model..... | 72 | +| 7.8 | MGCF - IM-MGW Interaction..... | 72 | +| 7.8.1 | General..... | 72 | +| 7.8.2 | Call related Procedures for Terminations towards the IM CN Subsystem..... | 72 | +| 7.8.3 | Call related Procedures for Terminations towards SIP-I based Circuit-switched Core Network..... | 72 | +| 7.8.4 | Non-call related procedures..... | 73 | + +| | | | +|-----------------------------|-------------------------------------------------------------------------------|-----------| +| Annex A (normative): | Interconnecting functionalities in SIP-I based CS domain ..... | 74 | +| A.1 | General ..... | 74 | +| A.2 | Stage 2 Requirements..... | 74 | +| A.3 | Border Control architecture ..... | 75 | +| A.4 | Void..... | 75 | +| A.5 | Procedures at the CS-IBCF ..... | 75 | +| A.5.1 | General ..... | 75 | +| A.5.2 | CS-IBCF as an exit point ..... | 76 | +| A.5.2.1 | Initial requests ..... | 76 | +| A.5.2.2 | Subsequent requests..... | 76 | +| A.5.2.3 | CS-IBCF-initiated call release..... | 77 | +| A.5.2.4 | THIG functionality in the CS-IBCF ..... | 77 | +| A.5.2.4.1 | General..... | 77 | +| A.5.2.4.2 | Encryption for network topology hiding ..... | 78 | +| A.5.2.5 | ALG functionality in the CS-IBCF ..... | 78 | +| A.5.2.6 | Screening of SIP-I signalling..... | 78 | +| A.5.2.6.1 | General..... | 78 | +| A.5.2.6.2 | CS-IBCF procedures for SIP headers ..... | 79 | +| A.5.2.6.3 | CS-IBCF procedures for SIP message bodies ..... | 79 | +| A.5.2.7 | Void..... | 79 | +| A.5.3 | CS-IBCF as an entry point ..... | 79 | +| A.5.3.1 | Initial requests ..... | 79 | +| A.5.3.2 | Subsequent requests..... | 79 | +| A.5.3.3 | CS-IBCF-initiated call release..... | 80 | +| A.5.3.4 | THIG functionality in the CS-IBCF ..... | 80 | +| A.5.3.4.1 | General..... | 80 | +| A.5.3.4.2 | Decryption for network topology hiding ..... | 81 | +| A.5.3.5 | ALG functionality in the CS-IBCF ..... | 81 | +| A.5.3.6 | Screening of SIP-I signalling..... | 81 | +| A.5.3.7 | Void..... | 81 | +| A.6 | Procedures at the CS-TrGW ..... | 82 | +| A.6.1 | Transport Plane Control procedures..... | 82 | +| A.7 | CS-IBCF - CS-TrGW Interaction ..... | 82 | +| A.7.1 | General ..... | 82 | +| A.7.1.1 | Network Model..... | 82 | +| A.7.1.2 | Signalling flows ..... | 82 | +| A.7.1.2.1 | Basic Procedures..... | 82 | +| A.7.1.2.1.1 | Call Establishment..... | 82 | +| A.7.1.2.1.2 | Call Release..... | 85 | +| A.7.1.2.2 | Specific Use Cases..... | 85 | +| A.7.1.2.2.1 | CS-IBCF as Entry Point, Call Establishment with IP Version Interworking ..... | 85 | +| A.7.1.2.2.2 | Hanging Termination Detection..... | 86 | +| A.7.1.2.2.3 | Gate Management ..... | 87 | +| A.7.1.2.2.4 | QoS Packet Marking ..... | 87 | +| A.7.1.2.2.5 | IP Realms ..... | 88 | +| A.7.1.2.2.6 | Media Inactivity Detection..... | 88 | +| A.7.1.2.2.7 | RTCP Handling..... | 89 | +| A.7.1.2.2.8 | Bandwidth Policing ..... | 90 | +| A.7.1.2.2.8.1 | Overview ..... | 90 | +| A.7.1.2.2.8.2 | Bandwidth policing procedures..... | 90 | +| A.7.1.2.2.9 | Through-Connection ..... | 91 | +| A.7.1.2.2.10 | Emergency Call..... | 91 | +| A.7.1.2.2.11 | Interactive Connectivity Establishment ..... | 91 | +| A.7.1.2.2.12 | SDP Capability Negotiation (SDPCapNeg)..... | 91 | +| A.7.2 | Ix Signalling Procedures ..... | 92 | +| A.7.2.1 | Introduction ..... | 92 | +| A.7.2.2 | Call Related Procedures ..... | 92 | + +| | | | +|-------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------| +| A.7.2.2.1 | Reserve TrGW Connection Point ..... | 92 | +| A.7.2.2.2 | Configure TrGW Connection Point ..... | 95 | +| A.7.2.2.3 | Reserve and Configure TrGW Connection Point ..... | 98 | +| A.7.2.2.4 | Release TrGW Termination ..... | 101 | +| A.7.2.2.5 | IP Bearer Released ..... | 102 | +| A.7.2.2.6 | Media Inactivity Detection ..... | 102 | +| A.7.2.2.7 | Termination heartbeat indication ..... | 103 | +| A.7.2.2.8 | Change Through-Connection ..... | 103 | +| A.7.2.3 | Non-Call Related Procedures ..... | 104 | +| A.7.2.3.1 | Introduction ..... | 104 | +| A.7.2.3.2 | Realm Availability Change - Activate ..... | 105 | +| A.7.2.3.3 | Realm Availability Change - Indication ..... | 106 | +| A.8 | (G)MSC - CS-MGW Interaction ..... | 106 | +| A.8.1 | General ..... | 106 | +| A.8.1.1 | Network Model ..... | 106 | +| A.8.1.2 | Signalling flows ..... | 106 | +| Annex B (normative): | Additional Interworking Procedures between a SIP-I based circuit-switched Core Network and the IP Multimedia (IM) Core Network (CN) Subsystem to Support Special Services ..... | 108 | +| B.1 | General ..... | 108 | +| B.2 | Global Text Telephony ..... | 108 | +| Annex C (informative): | Change history ..... | 109 | + +--- + +## Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +--- + +# 1 Scope + +The present document specifies the interworking between SIP-I based circuit-switched core network, as specified in TS 23.231 [3] and TS 29.231 [4], with out-of-band transcoder control related procedures in TS 23.153 [5], and: + +- an external SIP-I based signalling network compliant to ITU-T Recommendation Q.1912.5 [6], +- an ISUP (ITU-T Recommendations Q.761 to Q.764 [7]) based network such as an ISUP based 3GPP CS Domain or a PSTN, +- a BICC (ITU-T Recommendations Q.1902.1 to Q.1902.6 [8]) based network such as an BICC based 3GPP CS Domain as specified in TS 23.205 [9] and TS 29.205 [10], +- an IP Multimedia Subsystem, as specified in TS 23.228 [11] and TS 24.229 [12]. + +--- + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.002: "Network architecture". +- [3] 3GPP TS 23.231: " SIP-I based circuit-switched core network; Stage 2". +- [4] 3GPP TS 29.231: "Application of SIP-I Protocols to Circuit Switched (CS) core network architecture; Stage 3". +- [5] 3GPP TS 23.153: "Out of Band Transcoder Control; Stage 2". +- [6] ITU-T Recommendation Q.1912.5 (03/04): "Interworking between Session Initiation Protocol (SIP) and Bearer Independent Call Control Protocol or ISDN User Part". +- [7] ITU-T Recommendations Q.761 to Q.764 (12/99): "Specifications of Signalling System No.7 ISDN User Part (ISUP)". +- [8] ITU-T Recommendations Q.1902.1 to Q.1902.6 (07/01): "Bearer Independent Call Control". +- [9] 3GPP TS 23.205: "Bearer-independent circuit-switched core network; Stage 2". +- [10] 3GPP TS 29.205: "Application of Q.1900 series to Bearer Independent CS Network architecture; Stage 3". +- [11] 3GPP TS 23.228: "IP Multimedia subsystem (IMS)". +- [12] 3GPP TS 24.229: "IP Multimedia Call Control Protocol based on SIP and SDP". +- [13] 3GPP TS 29.163: "Interworking between the IP Multimedia (IM) Core Network (CN) subsystem and Circuit Switched (CS) networks". +- [14] IETF RFC 791: "Internet Protocol". +- [15] IETF RFC 768: "User Datagram Protocol". +- [16] IETF RFC 793: "Transmission Control Protocol". + +- [17] IETF RFC 2460: "Internet Protocol, Version 6 (IPv6) Specification". +- [18] IETF RFC 4960: "Stream Control Transmission Protocol". +- [19] IETF RFC 3204: "MIME media types for ISUP and QSIG Objects". +- [20] IETF RFC 3261: "SIP: Session Initiation Protocol". +- [21] IETF RFC 3262: "Reliability of Provisional Responses in the Session Initiation Protocol (SIP)". +- [22] IETF RFC 3264: "An Offer/Answer Model with the Session Description Protocol (SDP)". +- [23] IETF RFC 3312: "Integration of Resource Management and Session Initiation Protocol (SIP)". +- [24] 3GPP TS 23.014: "Support of Dual Tone Multi-Frequency (DTMF) signalling". +- [25] 3GPP TS 24.629: "Explicit Communication Transfer (ECT) using IP Multimedia (IM) Core Network (CN) subsystem". +- [26] 3GPP TS 24.610: "Communication HOLD (HOLD) using IP Multimedia (IM) Core Network (CN) subsystem". +- [27] ITU-T Recommendation Q.765 (2000): "Signalling System No. 7 - Application transport mechanism". +- [28] ITU-T Recommendation Q.765.5 (2000): "Signalling system No. 7 - Application transport mechanism: Bearer Independent Call Control (BICC)". +- [29] 3GPP TS 29.238: "Interconnection Border Control Functions - Transition Gateway; H.248 Profile; Stage 3". +- [30] IETF RFC 3263: "Session Initiation Protocol (SIP): Locating SIP Servers". +- [31] IETF RFC 4028: "Session Timers in the Session Initiation Protocol (SIP)". +- [32] IETF RFC 3325: "Private Extensions to the Session Initiation Protocol (SIP) for Asserted Identity within Trusted Networks". +- [33] ITU-T Recommendation H.248.1 (2002): "Gateway control protocol: Version 3". +- [34] Void. +- [35] Void. +- [36] IETF RFC 5079: "Rejecting Anonymous Requests in the Session Initiation Protocol (SIP)". +- [37] 3GPP TS 29.162: "Interworking between the IM CN subsystem and IP networks". +- [38] IETF RFC 3550: "RTP: A Transport Protocol for Real-Time Applications". +- [39] IETF RFC 3556: "Session Description Protocol (SDP) Bandwidth Modifiers for RTP Control Protocol (RTCP) Bandwidth". +- [40] IETF RFC 3605: "Real Time Control Protocol (RTCP) attribute in Session Description Protocol (SDP)". +- [41] IETF RFC 2474: "Definition of the Differentiated Services Field (DS Field) in the IPv4 and IPv6 Headers". +- [42] IETF RFC 2216 (1997): "Network Element Service Template". +- [43] 3GPP TS 29.414: "Core network Nb data transport and transport signalling". +- [44] 3GPP TS 32.407: "Telecommunication Management; Performance Management (PM) Performance measurements Core Network (CN) Circuit Switched (CS) domain". +- [45] 3GPP TS 23.226: "Global Text Telephony (GTT); stage 2". + +- [46] ITU-T Recommendation T.140 (02/98): "Text conversation presentation protocol". +- [47] IETF RFC 4103: "RTP Payload for Text Conversation". +- [48] ITU-T Recommendation V.18 (11/00): "Operational procedures for modems in the text telephone mode". +- [49] 3GPP TS 26.226: "Cellular text telephone modem; General description". +- [50] Void. +- [51] Void. +- [52] 3GPP TS 26.114: "IP Multimedia Subsystem (IMS); Multimedia Telephony; Media handling and interaction". +- [53] ITU-T Recommendation H.248.1 (05/2002): "Gateway control protocol: Version 2" including the Corrigendum1 for Version 2 (03/04). +- [54] 3GPP TS 29.332: "Media Gateway Control Function (MGCF) - IM-Media Gateway (IM-MGW) interface, Stage 3". +- [55] 3GPP TS 29.232: "Media Gateway Controller (MGC) - Media Gateway (MGW) interface; Stage 3". +- [56] IETF RFC 5245: "Interactive Connectivity Establishment (ICE): A Protocol for Network Address Translator (NAT) Traversal for Offer/Answer Protocols". +- [57] IETF RFC 5939: "Session Description Protocol (SDP) Capability Negotiation". + +--- + +## 3 Definitions and abbreviations + +### 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in TR 21.905 [1] and the following apply: + +**ICE lite:** The lite implementation of the Interactive Connectivity Establishment (ICE) specified in IETF RFC 5245 [56]. + +**Full ICE:** The full implementation of the Interactive Connectivity Establishment (ICE) specified in IETF RFC 5245 [56]. + +**Interworking Unit (IWU):** Logical entity that interworks SIP-I signalling in the 3GPP CS Domain with any of the following signalling: (a) SIP-I signalling of an external SIP-I network, (b) ISUP signalling of a PSTN, and (c) BICC or ISUP signalling of a 3GPP CS Domain. + +**User Plane Interworking Unit (UP-IWU):** Logical entity that performs user plane interworking between the SIP-I based CS Domain and an external SIP-I network, or external ISUP network, or BICC/ISUP based 3GPP CS network. + +### 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in TR 21.905 [1] and the following apply: An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in TR 21.905 [1]. + +| | | +|-------|-----------------------------------| +| ALG | Application Level Gateway | +| ANM | ANswer Message | +| APM | Application Transport Mechanism | +| B2BUA | (SIP) Back-to-Back User Agent | +| BGCF | Breakout Gateway Control Function | +| BICC | Bearer Independent Call Control | +| CON | Connect message | +| COT | Continuity message | +| CPG | Call ProGress message | + +| | | +|-----------|----------------------------------------------------------------------------------| +| CS-IBCF | CS (domain) IBCF | +| CS-TrGW | CS (domain) TrGW | +| IBCF | Interconnection Border Control Function | +| ICE | Interactive Connectivity Establishment | +| ITU-T | International Telecommunication Union - Telecommunication Standardization Sector | +| IM-MGW | IP Multimedia Media Gateway Function | +| IW-MSC | Interworking MSC | +| MIME | Multi-purpose Internet Mail Extensions | +| MRFP | Multimedia Resource Function Processor | +| NA(P)T | Network Address Translation / Network Address and Port Translation | +| NNI | Network to Network Interface | +| O-MSC | Originating MSC | +| OoB | Out of Band | +| OoBTC | Out of Band Transcoder Control | +| RES | RESume | +| RLC | Release Complete | +| SCTP | Stream Control Transmission Protocol | +| SDPCapNeg | SDP Capability Negotiation | +| SIP-I | SIP with encapsulated ISUP | +| STUN | Session Traversal Utilities for NAT | +| SUS | SUSpend | +| TDM | Time-Division Multiplexing | +| THIG | Topology Hiding Internetwork Gateway | +| TMR | Transmission Medium Requirement | +| TrGW | Transition Gateway | +| UA | (SIP) User Agent | +| UP-IWU | User Plane Interworking Unit | +| USI | User Service Information | + +## 4 Interworking between a SIP-I based circuit-switched core network and an external SIP-I based network + +### 4.1 Reference Model + +Figure 4.1.1 shows the interworking reference model for the interworking between a SIP-I based circuit-switched core network and an external SIP-I based network: + +![Figure 4.1.1: interworking reference model diagram](1b5a812c8aa20fd5cba28e97001d32de_img.jpg) + +The diagram illustrates the interworking reference model between an External SIP-I Network and a 3GPP CS Domain. The External SIP-I Network is represented by a grey oval on the left. It connects to the 3GPP CS Domain via two main paths: a control plane path and a user plane path. The control plane path goes from the External SIP-I Network through a GMSC Server, MSC Server (containing an IWU) to an MSC Server. The user plane path goes from the External SIP-I Network through an MGW (containing a UP-IWU) to another MGW. The 3GPP CS Domain is represented by a dashed box on the right. The diagram shows the following components and interfaces: + +- External SIP-I Network:** Grey oval on the left. +- Control Plane:** Dashed lines representing signaling. The path from the External SIP-I Network to the GMSC Server, MSC Server is labeled "SIP-I over TCP or UDP or SCTP". The path between the GMSC Server, MSC Server and the MSC Server is labeled "SIP-I over SCTP" and "Nc". +- User Plane:** Solid lines representing media. The path from the External SIP-I Network to the MGW is labeled "Media/ RTP/ UDP/ IP". The path between the MGW and the MGW is labeled "Media/ RTP/ UDP/ IP" and "Nb". +- Internal Interfaces:** The path between the GMSC Server, MSC Server and the MGW is labeled "Mc". The path between the MGW and the MGW is labeled "Mc". +- Scope:** Indicated by a hatched box. The IWU in the GMSC Server, MSC Server and the UP-IWU in the MGW are highlighted with hatched boxes. +- Legend:** + - Solid line: User Plane + - Dashed line: Control Plane + - Hatched box: Scope + +Figure 4.1.1: interworking reference model diagram + +**Figure 4.1.1: interworking reference model** + +The IWU provides the control plane interworking between the external network and the SIP-I based circuit-switched core network. The IWU is a logical function within the GMSC Server (for incoming calls) and the MSC Server (for outgoing calls) that may reside with other 3GPP logical functions. + +The user plane interworking is provided by the UP-IWU. The UP-IWU is a logical function within the MGW. + +**NOTE:** In call scenarios without the need for the (G)MSC server to manipulate the bearer, the (G)MSC server may perform call control signalling without any associated MGW by not inserting a MGW in the bearer path during the call establishment. Call scenarios where the (G)MSC server needs to manipulate the bearer, e.g. scenarios with insertion of tones or announcements, lawful interception, CAMEL services do not allow this optimisation. + +**Nb reference point:** The Nb reference point is defined in accordance with TS 29.414 [43]. + +**Nc reference point:** The Nc reference point is defined in accordance with TS 29.231 [4]. + +## 4.2 Signalling Interworking of a Call from the external SIP-I based network towards the SIP-I based circuit-switched core network + +### 4.2.1 Interworking of SIP-I messages received from external SIP-I network + +#### 4.2.1.1 General + +The IWU shall decapsulate the ISUP message from the received SIP message according to the rules for Profile C in ITU-T Recommendation Q.1912.5 [6]. + +The resulting ISUP message shall be encapsulated into the SIP message. The selected SIP Header fields relating to the handling of the ISUP body shall be set as specified in clause 5.4.1.2 of ITU-T Recommendation Q.1912.5 [6]. The IWU sends the constructed SIP message to the succeeding 3GPP node. + +#### 4.2.1.2 Call Release from external SIP-I network when encapsulated REL is missing + +If the IWU receives a SIP BYE request without an encapsulated ISUP message then the IWU may construct an ISUP REL message according to the rules specified in ITU-T Recommendation Q.1912.5 [6] and encapsulate it into a SIP message, which is sent to the succeeding 3GPP node. + +NOTE: A SIP BYE request without an encapsulated ISUP message can be received from a CS-IBCF or from a node of an interconnect network when they initiate autonomous call release. It is expected that a generated ISUP REL won't add any additional information which is not available in the received SIP BYE request. + +The IWU shall send a 200 OK final response to the BYE request without an encapsulated RLC message towards the external SIP-I network. + +### 4.2.2 Special Procedures for the reception of initial SIP INVITE requests + +#### 4.2.2.1 Receipt of SIP INVITE request + +If the initial SIP-I INVITE request does not provide a complete number, then the IWU shall collect all digits required to identify the called subscriber in subsequent SIP INVITE requests as specified for Profile C in ITU-T Recommendation Q.1912.5 [6]. The IWU shall not propagate overlap signalling as described for Profile C in ITU-T Recommendation Q.1912.5 [6]. + +The IWU shall trigger GMSC functions after having constructed the ISUP message, as described in 4.2.1 above. The GMSC interrogates the HLR to get a roaming number (MSRN). The Called Party Number in the ISUP IAM message is changed by the GMSC function to the MSRN. The IWU shall include the MSRN into the Request-URI as the new target. + +#### 4.2.2.2 Receipt of SIP INVITE requests with SDP + +Based on configuration the IWU may choose to transcode media. But the IWU shall always provide the TMR/USI/HLC parameters as received on the incoming side. + +#### 4.2.2.3 Receipt of SIP INVITE request without SDP + +An IWU may reject receipt of SIP INVITE requests without SDP offer. Otherwise the rules of clause 4.2.2.1 apply with the following deviations: + +The IWU shall construct an SDP offer with contents according to local policy, e.g. SDP for a G.711 speech call. The IWU may use the TMR and USI parameters of the encapsulated IAM to determine the desired service and construct the SDP offer accordingly. The IWU may then send to the succeeding 3GPP node the SIP INVITE request with the constructed SDP offer and encapsulated IAM. + +If reliable provisional responses (see IETF RFC 3262 [21]) are supported in the external SIP-I network, the IWU may immediately send the SDP offer within a 183 Session Progress message to the preceding node. When the IWU receives the SDP answer then the IWU should send to the succeeding 3GPP node the SIP INVITE request with an encapsulated IAM message. Otherwise, the IWU shall behave in accordance with the paragraph above. + +#### 4.2.2.4 MGW Selection + +The IWU may apply the optional "optimised MGW selection", "deferred MGW selection" or "MGW bypass" procedures towards the succeeding SIP-I based circuit switched core network as described in clause 4.4 of TS 23.231 [3]. + +If MGW bypass is implemented and the IWU receives a MGW identifier: + +- in a SDP offer from external SIP-I network the IWU shall remove the MGW identifier from the SDP offer before propagating the SDP offer to the succeeding 3GPP node; + +- in a SDP answer from the succeeding 3GPP node the IWU shall remove the MGW identifier from the SDP answer before propagating back the SDP answer to the external network. + +NOTE: If MGW bypass is implemented and the external network does not include a specified connection address (0.0.0.0 for IPv4) then this will be interpreted as supporting deferred MGW selection by the succeeding node. The succeeding node will select a MGW accordingly and may return the MGW Identifier to the IWU). + +Otherwise the IWU shall seize a MGW and shall include the MGW connection address into the SDP offer of the initial SIP INVITE request it will send to the succeeding 3GPP node. + +#### 4.2.3 Interworking of SIP-I messages received from succeeding 3GPP node + +Whenever the IWU receives from the succeeding 3GPP node a SIP message with an encapsulated CON, ACM, CPG, ANM, SUS, RES message then the IWU sends the SIP message in accordance with rules in accordance with ITU-T Recommendation Q.1912.5 [6] to the external SIP-I network and the encapsulated ISUP message shall not be modified. + +#### 4.2.4 Special Procedures for Profile Interworking + +##### 4.2.4.1 Support of 100Rel + +The IWU receiving a SIP INVITE with or without tag "100Rel" in the SUPPORTED or the REQUIRED header from the external SIP-I network shall advertise its preference of provisional reliable responses to the succeeding 3GPP node via a SUPPORTED header in the initial SIP INVITE request. + +As an option the IWU may consider a received SIP INVITE request without "100Rel" as erroneous and reject the INVITE request with a 421 "Extension Required" response. + +NOTE: The option to forward a SIP INVITE request to the succeeding 3GPP node with or without tag "100Rel", if the external network does not support reliable provisional responses, is not specified in the present specification. + +##### 4.2.4.2 Support for UPDATE method + +The IWU receiving a SIP INVITE with or without the UPDATE method included in the ALLOW header shall advertise its support for the UPDATE method to the succeeding 3GPP node by listing the UPDATE method in the ALLOW header field. + +As an option the IWU may consider a received initial SIP INVITE request without listing UPDATE in the ALLOW header field as erroneous and reject the INVITE request with a 403 "Forbidden" response. + +NOTE: The option to forward a SIP INVITE request to the succeeding 3GPP node without indicating support of the UPDATE method, if the external network does not support the UPDATE method, is not specified in the present specification. + +##### 4.2.4.3 Support for Preconditions + +When the incoming SIP INVITE request indicates that remote preconditions are met and local preconditions are met then the IWU may either not include the tag "precondition" and exclude appropriate SDP lines, or include the tag "preconditions" in the SUPPORTED header and provide an SDP offer indicating that preconditions are met. + +When the incoming SIP INVITE request does not contain a "precondition" tag the IWU shall assume the preconditions have been met within the external SIP-I network. If local preconditions are met then the IWU may either not include the tag "precondition" and exclude appropriate SDP lines, or include the tag "precondition" in the SUPPORTED header and provide an SDP offer indicating that preconditions are met. + +When the incoming SIP INVITE request indicates that remote preconditions are not met or when local preconditions are not met then the IWU shall include the tag "precondition" in the REQUIRE header or SUPPORTED header in the SIP INVITE request and shall encode preconditions in the SDP offer that the related local preconditions for QoS are not met, using the segmented status type, as defined in IETF RFC 3312 [23], as well as the strength-tag value "mandatory" for the local segment and the strength-tag value "optional" for the remote segment when sending the message to the succeeding 3GPP node. Or the IWU may defer forwarding the SIP INVITE request until remote local preconditions are met. + +When the incoming SIP INVITE request indicates that preconditions have not been met and the IWU will not include a MGW the SDP with preconditions information shall be transited unchanged and the "precondition" tag shall be transited in the same header as received. + +NOTE 1: The use of the SUPPORTED header is a deviation from IETF RFC 3312 [23] when the strength-tag contains a "mandatory" value. + +NOTE 2: The support of preconditions is mandated at the Nc interface. Therefore a response without "precondition" can be considered as erroneous if preconditions were not met. + +NOTE 3: The setting of the "Continuity Check Indicator" in the "Nature of Connection Indicators" parameter within the encapsulated IAM by the IWU is of no significance. The value is ignored by the succeeding 3GPP node. + +## 4.2.5 Support for Codec Negotiation + +If the IWU uses the MGW bypass option as defined in TS 23.231 [3], then the IWU is not involved in the codec negotiation procedure and transits SDP offers and answers unchanged. Otherwise, the remaining text of this clause applies: + +If the IWU receives from the external SIP-I based network a SIP request with an SDP offer containing a codec list with or without the 3GPP\_OoBTC\_Indicator, the IWU shall follow the procedures defined for a 3GPP Intermediate Node in clause 9 of TS 23.153 [5]. + +If the IWU receives from the external SIP-I based network an INVITE or re-INVITE request without any codec information, the IWU shall send an SDP offer to the succeeding 3GPP SIP-I node, where it either shall follow the procedures defined for a 3GPP node originating SDP offer in clause 9 of TS 23.153 [5], or shall create an SDP offer with the default PCM codec. The IWU shall send the selected codec within an SDP offer towards the preceding external node. + +NOTE: Which codecs are negotiable with the external SIP-I network may depend on operator choices and preferences (local policy). + +## 4.2.6 Special Procedures for the reception of SIP Re-INVITE requests + +### 4.2.6.1 Receipt of SIP Re-INVITE request without SDP + +Upon receipt of a SIP Re-INVITE request without SDP, the IWU shall: + +- construct an SDP offer with contents reflecting the SDP already negotiated with the external SIP-I network for the call, including codec information as specified in clause 4.2.5, and send the SDP offer within a 200 OK (INVITE) message to the external SIP-I network; or +- reject the SIP Re-INVITE request. + +## 4.3 Signalling Interworking of a Call from SIP-I based circuit-switched core network towards the external SIP-I based network + +### 4.3.1 Interworking of SIP-I messages received from preceding 3GPP node + +#### 4.3.1.1 General + +An IWU receiving SIP messages with encapsulated ISUP information shall apply any interworking procedures detailed for Profile C in ITU-T Recommendation Q.1912.5 [6] affecting parameters within the ISUP, and then proceed to encapsulate any ISUP information received (with the exception of the excluded messages detailed in 5.4.3 of ITU-T Recommendation Q.1912.5 [6]) in a SIP message in a MIME body according to IETF RFC 3204 [19]. The selected SIP Header fields relating to the handling of the ISUP body shall be set as specified in ITU-T Recommendation Q.1912.5 [6]. + +#### 4.3.1.2 Call Release from external SIP-I network when encapsulated REL is missing + +If the IWU receives a SIP BYE request or 4XX, 5XX, 6XX final response to the initial INVITE request without an encapsulated ISUP REL message then the IWU may construct the ISUP REL message according to the rules specified + +in ITU-T Recommendation Q.1912.5 [6] and encapsulate it into the SIP message, which is sent to the preceding 3GPP node. + +NOTE: A SIP BYE request without an encapsulated ISUP message can be received from a CS-IBCF or from a node of an interconnect network when they initiate autonomous call release. It is expected that a generated ISUP REL message won't add any additional information which is not available in the received SIP BYE request. + +The IWU shall send a 200 OK final response to the BYE request without an encapsulated ISUP RLC message towards the external SIP-I network. + +## 4.3.2 Special Procedures for the reception of SIP INVITE requests + +The IWU shall decapsulate the ISUP message. The IWU forwards the ISUP information to the "IW-MSC" functions, which may result in a modified ISUP message. + +Based on configuration the IWU may choose to transcode media. If the IWU transcodes, it should set the TMR/USI/HLC parameters according to the codec applied in the SIP-I network. Otherwise, it should provide the TMR/USI/HLC parameters as received in the encapsulated IAM. + +The IWU shall proceed to encapsulate the ISUP message into the SIP-INVITE request. The request URI shall be aligned with the called party number. + +## 4.3.3 Special Procedures for Profile Interworking + +### 4.3.3.1 Support of 100Rel + +An IWU shall consider an initial SIP INVITE request received from the preceding 3GPP node without the tag "100Rel" in the SUPPORTED header or REQUIRED header as erroneous and shall reject the call accordingly. + +An IWU sending a SIP INVITE request towards the external SIP-I network shall advertise its preference of provisional reliable responses via a SUPPORTED header containing the tag "100Rel". + +If an IWU receives a provisional 101-199 response from the external SIP-I network with a REQUIRE header present with tag "100rel" then it shall include the tag "100Rel" into the REQUIRE header when the IWU propagates the response to the preceding 3GPP node. + +If an IWU receives from the external SIP-I network a provisional 101-199 response without tag "100rel" in the REQUIRE header then the IWU shall: + +- either includes the tag "100Rel" into the REQUIRE header when it forwards the response to the preceding 3GPP node, +- or consider the response as erroneous and reject the call accordingly. + +NOTE: The option to forward the response to the preceding 3GPP node without tag "100Rel", if the external network does not support reliable provisional responses, is not specified in the present specification. + +### 4.3.3.2 Support for UPDATE method + +An IWU sending a SIP INVITE towards the external SIP-I network shall advertise its support of the UPDATE method via the ALLOW header listing the UPDATE method. + +The IWU receiving a response to a SIP INVITE request is allowed to generate the UPDATE method towards the external network if an ALLOW header is present listing the UPDATE method. Otherwise, the IWU is not allowed to generate UPDATE requests towards the external SIP-I network and one of the following options applies: + +- The IWU shall return the response to the preceding 3GPP node containing an ALLOW header listing the UPDATE method. +- The IWU shall consider the response received from the external network as erroneous and reject the call accordingly. + +NOTE: The option to forward the response to the preceding 3GPP node without UPDATE in the ALLOW header field, if the external network does not support the UPDATE method, is not specified in the present specification. + +#### 4.3.3.3 Support for Preconditions + +When the incoming SIP INVITE request indicates that preconditions have not been met or when local preconditions are not met, the IWU shall use one of the following options: + +- a) The IWU shall send a SIP INVITE request to a succeeding external SIP-I network and include the tag "precondition" in the SUPPORTED header. The IWU shall encode preconditions in the SDP offer indicating that the related local preconditions for QoS are not met, using the segmented status type, as defined in IETF RFC 3312 [23], as well as the strength-tag value "mandatory" for the local segment and the strength-tag value "optional" for the remote segment. The "precondition" tag shall be included in the SUPPORTED header. The IWU shall encapsulate the IAM message into the SIP INVITE request and should insert "continuity check not required" as the value of the Continuity check indicator within the Nature of Connection Indicators parameter in order to avoid that an external node, which does not support preconditions, is waiting for a COT message when the IWU is not able to send the COT message. + +NOTE 1: Such an external node is not compliant to ITU-T Recommendation Q.1912.5 [6]. + +NOTE 2: The use of the SUPPORTED header is a deviation from IETF RFC 3312 [23] when a "mandatory" strength-tag is used. + +The subsequent action depends on whether the response indicates support of preconditions: + +- i) If the IWU receives from the external SIP-I network a provisional 101-199 response with a REQUIRE header or SUPPORTED header containing tag "precondition", then the IWU shall progress the call and when preconditions are met it shall send an UPDATE message or PRACK message indicating that preconditions have been fulfilled. Preconditions are fulfilled when local preconditions are met and, if the incoming SIP INVITE request indicated that preconditions had not been met, the IWU has received an indication from the preceding 3GPP node that the preconditions are subsequently met. +- ii) If the IWU receives from the external SIP-I network a provisional 101-199 response without a REQUIRE header or SUPPORTED header containing tag "precondition" and if a provisional response or successful final response carrying an encapsulated ISUP message is received from external SIP-I network prior to preconditions being met, then these responses shall be queued and later be propagated to the preceding 3GPP node once preconditions are met. If responses carrying encapsulated ISUP are to be queued and the response carrying an encapsulated ISUP message is the first response carrying an SDP answer then the IWU shall generate a 183 Progress with the SDP answer and send it to the preceding node. The IWU shall not encapsulate an ISUP message into the 183 Progress. + +NOTE 3: The option to allow the SIP response to be immediately forwarded is not specified in the present will result in the O-MSC receiving encapsulated ISUP prior to preconditions being met. In addition, reception of response without indication of support for preconditions at the O-MSC is not specified in the present specification. + +If the IWU receives a failure response from the external network, then this shall immediately be forwarded to the preceding 3GPP node. + +- b) Before sending the INVITE request to the external network the IWU shall wait until local preconditions are met and, if the incoming SIP INVITE request indicated that preconditions have not been met, it has received an indication from the preceding 3GPP node that the preconditions are met. + +The initial INVITE request to the external SIP-I network may include a precondition tag in SUPPORTED header and indicate that preconditions have been met. + +- c) The IWU shall send a SIP INVITE request to a succeeding external SIP-I network and include the tag "precondition" in the REQUIRE header. The IWU shall encode preconditions in the SDP offer indicating that the related local preconditions for QoS are not met, using the segmented status type, as defined in IETF RFC 3312 [23], as well as the strength-tag value "mandatory" for the local segment and the strength-tag value "optional" for the remote segment. The IWU shall encapsulate the IAM message into the SIP INVITE request and should insert "continuity check not required" as the value of the Continuity check indicator within + +the Nature of Connection Indicators parameter in order to avoid that an external node, which does not support preconditions, is waiting for a COT message when the IWU is not able to send the COT message. + +NOTE 4: Such an external node is not compliant to ITU-T Recommendation Q.1912.5 [6]. + +The subsequent action depends on whether the response indicates support of preconditions: + +- i) If the IWU receives from the external SIP-I network a provisional 101-199 response with a REQUIRE header or SUPPORTED header containing tag "precondition", then the IWU shall continue the call per response handling procedures described in option a) above. +- ii) If the IWU receives a 420 Bad Extension final response, then the IWU shall continue per option b) above by waiting for preconditions to be met before repeating the initial INVITE request. + +When the incoming SIP INVITE request indicates that precondition are met and local preconditions are met, the IWU shall set up the session and may include a precondition tag in the SUPPORTED header and indicate that preconditions have been met. + +When the incoming SIP INVITE request indicates that preconditions have not been met and the IWU will not include a MGW the SDP with preconditions information shall be transited unchanged and the "precondition" tag shall be transited in the same header as received. + +#### 4.3.4 Support for Codec Negotiation + +When the IWU receives an INVITE with an SDP offer containing a structured codec list, the IWU shall follow the procedures defined for a 3GPP Intermediate Node in clause 9 of TS 23.153 [5], unless the IWU uses the MGW bypass option. + +NOTE: Which codecs are negotiable with the external SIP-I network may depend on operator choices and preferences (local policy). + +#### 4.3.5 MGW Selection + +The IWU shall not perform "optimised MGW selection", or "deferred MGW selection" towards an external SIP-I network. The IWU shall select a MGW and include the MGW connection address in the SDP offer of the initial SIP INVITE request it sends to the external SIP-I network. The "MGW bypass" option may be deployed but in the case that the preceding 3GPP node signals the MGW identifier this identifier shall not be signalled to the external SIP-I network. + +### 4.4 DMTF Signalling Interworking applicable for all Calls between an external SIP-I based network and a SIP-I based circuit-switched core network + +#### 4.4.1 General + +DTMF signalling via the RTP Telephony Event (RTP Telephony Event) is mandated to be supported over the Nb interface for SIP-I based Circuit Switched Core Network on Nc Interface, see TS 23.231 [3]. + +NOTE 1: According to TS 23.231 [3] it is an option to choose either the RTP Telephony Event or inband DTMF transport within the PCM codec when only the default PCM codec is selected, however once RTP Telephony Event is chosen (indicated in the SDP answer) it must be used for any selected codec. + +If MGW bypass is supported within the CS CN (see TS 23.231 [3], clause 4.4.5), a terminating MSC or a 3GPP SIP-I intermediate node controlling a MGW that interfaces directly to the external network shall behave as an IWU, as its MGW is providing an UP-IWU function and therefore the SIP-I Server shall also comply with the procedures in this subclause. A GMSC Server or SIP-I intermediate node which is applying the MGW Bypass option shall then relay the SDP media lines for codecs and RTP Telephony Event in the SDP offers and answers transparently between the external SIP-I network and the 3GPP CS CN and is therefore not constrained by the procedures described in this subclause. + +If the SDP answer sent towards the external SIP-I network or received from the external SIP-I network includes the RTP Telephony event, then the IWU shall request its MGW to transmit and receive the DTMF to/from the external SIP-I node within the RTP Telephony Event. + +If the SDP answer sent towards or received from the SIP-I based CS CN includes the RTP Telephony event, then the IWU shall request its MGW to transmit and receive the DTMF to/from the SIP-I based CS CN within the RTP Telephony Event. + +DTMF interworking is specified for interworking towards an external SIP-I network with the assumption that the following applies: + +- External SIP-I network includes RTP Telephony event within SDP offers or SDP answers together with non-PCM speech codecs; +- External SIP-I network includes default PCM codec in SDP offers or SDP answers. + +Therefore only the case where the external SIP-I network includes default PCM codec when not including the RTP Telephony event is described. + +#### 4.4.2 DTMF support in SDP offer sent to External SIP-I network + +If an IWU receives an *initial* SDP offer from a preceding 3GPP SIP-I node with the RTP Telephony Event it shall forward the RTP Telephony Event in the offer to the succeeding (external) node. If the IWU then receives a SDP answer from the succeeding node (external network) including the RTP Telephony Event, the IWU shall include the RTP Telephony Event in the SDP answer it forwards to the SIP-I based CS CN independently of the selected codec type, i.e. any DTMF payload received would then be simply relayed through the interworking MGW, and the IWU shall also include the RTP-telephony event in possible subsequent SDP offers it sends towards the succeeding external network node. + +If an IWU receives an SDP offer from a preceding 3GPP SIP-I node without the RTP Telephony Event (only permitted if only default PCM codec offered) then it may: + +- Include additional non-PCM speech codecs and shall then include the RTP Telephony Event in the subsequent offer to the succeeding external SIP-I node; + +NOTE: If the answer from the external SIP-I node does not include the RTP Telephony Event then no interworking of DTMF Telephony Events or tones is required by the MGW. + +or: + +- send the SDP Offer to the external SIP-I node without the RTP Telephony Event (no compressed codecs included in the offer) and then no inband DTMF detection/insertion is required; or: +- Send the SDP Offer to the external SIP-I node without any additional non-PCM speech codecs and include the RTP Telephony Event. + +If the answer from the external SIP-I node includes the RTP Telephony event and the RTP Telephony event has not been offered by the preceding 3GPP SIP-I network then the IWU shall request its MGW (UP-IWU) to detect/insert inband DTMF tones to/from its preceding 3GPP SIP-I node and send/receive the DTMF to the external SIP-I node within the RTP Telephony Event, see clause 14.4.8 in TS 23.231 [3], + +If an IWU receives a SDP offer from a preceding 3GPP SIP-I node with the RTP Telephony Event and then receives a SDP answer from the external SIP-I network which includes only the PCM speech codec and excludes the RTP Telephony Event the IWU may: + +- apply "transcoding at the PLMN border" by selecting another speech codec than the default PCM codec for the interface toward the SIP-I based CS CN (if included in the offer) and then the IWU shall include the RTP Telephony Event in the answer it forwards to the SIP-I based CS CN, or: +- select default PCM codec towards the SIP-I CS CN and may include the RTP Telephony Event in the reply to the preceding (3GPP SIP-I) node and shall then request its MGW to relay inband DTMF to the RTP Telephony Event to/from the external network, see clause 14.4.8 in TS 23.231 [3], or: +- select default PCM codec towards the SIP-I CS CN and exclude the RTP Telephony Event in the reply to the preceding (3GPP SIP-I) node and then no inband DTMF detection/insertion is required. + +### 4.4.3 DTMF support in SDP offer received from External SIP-I network + +If an IWU receives an SDP offer from the external SIP-I network with the RTP Telephony Event it shall forward the RTP Telephony Event in the offer to the succeeding node. If the SDP answer from the succeeding (3GPP internal) SIP-I node includes the RTP Telephony Event the IWU shall configure its MGW to relay the RTP Telephony Events transparently as described in clause 14.4.3 of TS 23.231 [3]. + +If an IWU receives a SDP offer from the external SIP-I network without the RTP Telephony Event the IWU shall include the RTP Telephony Event in the offer to the succeeding node if any codec other than the default PCM speech codec is offered to the succeeding node. If only the default PCM speech codec is offered to the succeeding node, the IWU may include the RTP Telephony Event in the offer to the succeeding SIP-I CS CN node. + +If the IWU receives a SDP answer from the succeeding (3GPP internal) SIP-I node including the RTP Telephony Event and the RTP Telephony Event had not been received in the offer from the external network the IWU returns the default PCM codec in the SDP answer to the external SIP-I network. The IWU shall then request its MGW (UP-IWU) to detect any inband DTMF from the external SIP-I network and signal the DTMF to the succeeding 3GPP SIP-I node within the RTP Telephony Event and insert DTMF tones into the external SIP-I network if DTMF digits received via RTP Telephony Event from the succeeding 3GPP SIP-I node, see clause 14.4.8 in TS 23.231 [3]. + +If an IWU receives a SDP answer from the succeeding (3GPP internal) SIP-I node excluding the RTP Telephony Event (i.e. default PCM codec selected) but received an RTP Telephony Event in the SDP offer from the external SIP-I network it may return RTP Telephony Event in the SDP answer to the external SIP-I network. It shall then configure its MGW (UP-IWU) for transferring DTMF between inband PCM and RTP Telephony Events as described in clause 14.4.8 in TS 23.231 [3]. If the IWU chooses not to include the RTP Telephony Event in the SDP answer then default PCM codec shall be signalled in the SDP answer to the external SIP-I network. No inband DTMF detection or insertion is required; any DTMF tones received are passed transparently inband. + +If an IWU receives a SDP answer from the succeeding (3GPP internal) SIP-I node excluding the RTP Telephony Event (i.e. default PCM codec selected) and did not receive an RTP Telephony Event in the SDP offer from the external SIP-I network the IWU returns the default PCM codec as the selected codec in the SDP answer to the external network and shall not request its MGW to configure RTP Telephony Event; therefore any inband DTMF tones are passed transparently inband. + +## 4.5 User Plane Interworking + +### 4.5.1 General + +Figure 4.5.1.1 shows the user plane protocol stacks within the external SIP-I network and the 3GPP SIP-I based circuit switched core network. + +![Diagram of user plane interworking showing protocol stacks for External SIP-I Network and 3GPP SIP-I based circuit switched core network.](421fc75480c21e7ebb25756826652367_img.jpg) + +The diagram illustrates the user plane protocol stacks for interworking between an External SIP-I Network and a 3GPP SIP-I based circuit switched core network. On the left, an oval labeled 'External SIP-I Network' is connected to a table representing the protocol stacks. The table has two columns for different codecs and five rows for the protocol layers. + +| Codec,
e.g. G.711 | Codec,
e.g. NB-AMR | +|----------------------|-----------------------| +| RTP | RTP | +| UDP | UDP | +| IP | IP | +| L2, L1 | L2, L1 | + +The bottom row of the table (L2, L1) is connected to a horizontal line representing the network interface, which is labeled 'Nb' at the right end. + +Diagram of user plane interworking showing protocol stacks for External SIP-I Network and 3GPP SIP-I based circuit switched core network. + +**Figure 4.5.1.1: user plane interworking** + +If the same speech codec is used on both sides, no speech transcoding is required. + +## 4.5.2 DTMF Interworking + +For general information of DTMF interworking, see clause 4.4.1. + +The IWU may configure its UP-IWU with RTP Telephony Event at the 3GPP SIP-I termination and the external SIP-I termination. The UP-IWU shall then relay any DTMF received within the RTP Telephony Event Payload Type from one network interface to the other. + +The IWU may configure the UP-IWU with only one network termination with RTP Telephony Event and the other termination configured for default PCM. The UP-IWU shall then detect DTMF tones from the PCM-encoded speech path and transmit them as RTP Telephony Events toward the other network and shall detect RTP Telephony Events and insert the DTMF as Tones in the corresponding PCM-encoded path. + +If the IWU does not configure RTP Telephony Event on either network terminations then the UP-IWU simply relays the PCM-encoded speech from one network to the other (which may contain and therefore relay DTMF tones). + +If RTP Telephony Event is selected for either the external SIP-I connection or for the internal 3GPP CS CN connection, but not for both, then the MGW shall filter out (delete) the DTMF from the default PCM-coded speech path (when relaying the DTMF via the RTP Telephony Event) to prevent potential double signalling of the same digit if a later insertion back to inband DTMF tone transmission were to occur. + +The related UP-IWU control procedures and UP-IWU behaviour is described in clauses 14.4.3 and 14.4.8 of TS 23.231 [3], where the MGW shall be understood as UP-IWU. + +## 4.6 Example Call flows + +### 4.6.1 General + +In this clause call flows are shown as examples to demonstrate the signalling interworking of the IWU. Within the message sequence charts some content of the messages are shown in order to visualise some of the important interworking aspects, which were described in previous clauses of this document. It is to be noted that the intention is neither to show the complete content of the SIP messages nor to use the exact syntax of SIP and SDP messages as it is defined in the respective RFCs. It is also not the intention to show all alternative options that are possible for a certain call flow. + +### 4.6.2 Incoming Call flows + +#### 4.6.2.1 Incoming Call - no preconditions in external network + +Figure 4.6.2.1.1 shows a terminating call where the external network does not indicate the support of preconditions and where the SDP body contains a list of codecs according to IETF RFC 3264 [22]. The IWU assumes that remote preconditions are met. The incoming side RTP bearer termination is yet not successfully reserved and configured and therefore local preconditions are not met. Thus the IWU initiates precondition signalling when sending the INVITE request to the succeeding 3GPP node. The IWU and the 3GPP node perform codec negotiation according to 3GPP rules as specified in TS 23.153 [5]. The IWU answers to the external network with a single selected codec. If possible the selected codec is the same as received from the 3GPP node to avoid transcoding at the network border. + +The IWU changes the content of the Request URI (either a tel-URI or a SIP-URI with "user=phone") from the MSISDN of the called subscriber to the MSRN received from the HLR. The IWU inserts its own address into the From header of the initial SIP INVITE request being sent to the succeeding 3GPP node. + +![Sequence diagram for an incoming call from an external network to a 3GPP node via a GMSC Server IWU and an MGW UP-IWU. The diagram shows the flow of SIP messages including INVITE, TRYING, 183 Progress, PRACK, 200 OK, 180 Ringing, and ACK, with internal processing steps like HLR interrogation and RTP bearer termination.](ae53f90bb87d6d09e2d6b5278d7c338f_img.jpg) + +``` + +sequenceDiagram + participant ExternalNetwork as from External Network + participant GMSC as GMSC Server IWU + participant HLR as HLR Interrogation fetches MSRN + participant MGW as MGW UP-IWU + participant Node as to 3GPP Node + + Note left of GMSC: NNI + Note right of GMSC: Nc + Note right of MGW: Mc + + ExternalNetwork->>GMSC: INVITE [SDP, IAM] +Request URI: MSISDN +100rel, UPDATE +IETF codec list, +IAM + GMSC-->>ExternalNetwork: TRYING + + GMSC->>HLR: HLR Interrogation fetches MSRN + HLR-->>GMSC: + + Note right of GMSC: remote preconditions are met; +local preconditions are not met + GMSC->>MGW: Seize outgoing side RTP bearer terminations + GMSC->>Node: INVITE [SDP, IAM] +Request URI: MSRN +From: SIP URI of GMSC +100rel, UPDATE, +precondition tag +3gOoBTC, supported codec list, +preconditions not met +IAM (updated) + Node-->>GMSC: 183 Progress [SDP] +100rel, UPDATE, precondition tag, +3gOoBTC, selected codec, available codecs + + Note right of GMSC: local preconditions are met + GMSC->>MGW: Seizure of incoming side RTP bearer terminations, though-connection + GMSC-->>ExternalNetwork: 183 Progress [SDP] +100rel, UPDATE +selected codec + ExternalNetwork->>GMSC: PRACK + GMSC-->>ExternalNetwork: 200 OK (PRACK) + GMSC-->>ExternalNetwork: 180 Ringing [ACM] + ExternalNetwork->>GMSC: PRACK + GMSC-->>ExternalNetwork: 200 OK (PRACK) + GMSC-->>ExternalNetwork: 200 OK (INVITE) [ANM] + ExternalNetwork->>GMSC: ACK + + Note right of MGW: preconditions met + MGW-->>Node: PRACK [SDP] +preconditions met + Node-->>MGW: 200 OK (PRACK) [SDP] + MGW-->>Node: 180 Ringing [ACM] + MGW-->>Node: PRACK + Node-->>MGW: 200 OK (PRACK) + MGW-->>Node: 200 OK (INVITE) [ANM] + MGW-->>Node: ACK + +``` + +Sequence diagram for an incoming call from an external network to a 3GPP node via a GMSC Server IWU and an MGW UP-IWU. The diagram shows the flow of SIP messages including INVITE, TRYING, 183 Progress, PRACK, 200 OK, 180 Ringing, and ACK, with internal processing steps like HLR interrogation and RTP bearer termination. + +Figure 4.6.2.1.1: Incoming Call (message sequence chart), +example without support for preconditions at the NNI + +#### 4.6.2.2 Incoming Call with preconditions not met + +In figure 4.6.2.2.1 the external network indicates that its preconditions are not met. Because support for preconditions is mandated at the interface to the succeeding 3GPP node, the IWU can immediately send the INVITE towards the destination. + +The IWU receives from the external network the information that preconditions are met either in the PRACK or UPDATE request, where the SDP parameters are set accordingly. The IWU sends the information that preconditions are met either within the PRACK or with an UPDATE request to the 3GPP node such that the called subscriber can be alerted. + +![Sequence diagram for an incoming call with precondition update. Lifelines: External Network, GMSC Server IWU, MGW UP-IWU, and 3GPP Node. The process involves INVITE, TRYING, HLR Interrogation, Seize outgoing side RTP bearer terminations, INVITE to 3GPP node, 183 Progress, Seizure of incoming side RTP bearer terminations, 183 Progress to external network, PRACK, 200 OK (PRACK), UPDATE, 200 OK (UPDATE), 180 Ringing, PRACK, 200 OK (PRACK), 200 OK (INVITE), and ACK messages.](90ddb84c323b956e2d50a54d3f870566_img.jpg) + +``` + +sequenceDiagram + participant Ext as to External Network + participant GMSC as GMSC Server IWU + participant MGW as MGW UP-IWU + participant Node as to 3GPP Node + + Note over Ext, GMSC: NNI + Note over GMSC, Node: Nc + Note over GMSC, MGW: Mc + + Ext->>GMSC: INVITE [SDP, IAM] +Request URI: MSIDN +100rel, UPDATE, precondition tag, +IETF codec list, preconditions not met + GMSC-->>Ext: TRYING + Note over GMSC: HLR Interrogation + GMSC->>MGW: Seize outgoing side RTP bearer terminations + GMSC->>Node: INVITE [SDP, IAM] +Request URI: MSRN +From: SIP URI of GMSC +100rel, UPDATE, precondition tag, +3gOoBTC, supported codec list, preconditions not met + Node-->>GMSC: 183 Progress [SDP] +100rel, UPDATE, precondition tag, +gOoBTC, selected codec, available codecs + GMSC->>MGW: Seizure of incoming side RTP bearer terminations, though-connection + GMSC-->>Ext: 183 Progress [SDP] +100rel, UPDATE, precondition tag, +selected codec + Note right of GMSC: Selected codec chosen from succeeding +3GPP node may be supported on +external network. If not then another +codec must be chosen + Ext->>GMSC: PRACK + GMSC->>Node: PRACK + Node-->>GMSC: 200 OK (PRACK) + GMSC-->>Ext: 200 OK (PRACK) + Ext->>GMSC: UPDATE [SDP] +Preconditions met + GMSC->>Node: UPDATE [SDP] +Preconditions met + Node-->>GMSC: 200 OK (UPDATE[SDP]) + GMSC-->>Ext: 200 OK (UPDATE[SDP]) + Node-->>GMSC: 180 Ringing [ACM] + GMSC-->>Ext: 180 Ringing [ACM] + Ext->>GMSC: PRACK + GMSC->>Node: PRACK + Node-->>GMSC: 200 OK (PRACK) + GMSC-->>Ext: 200 OK (PRACK) + Node-->>GMSC: 200 OK (INVITE) [ANM] + GMSC-->>Ext: 200 OK (INVITE) [ANM] + Ext->>GMSC: ACK + GMSC->>Node: ACK + +``` + +Sequence diagram for an incoming call with precondition update. Lifelines: External Network, GMSC Server IWU, MGW UP-IWU, and 3GPP Node. The process involves INVITE, TRYING, HLR Interrogation, Seize outgoing side RTP bearer terminations, INVITE to 3GPP node, 183 Progress, Seizure of incoming side RTP bearer terminations, 183 Progress to external network, PRACK, 200 OK (PRACK), UPDATE, 200 OK (UPDATE), 180 Ringing, PRACK, 200 OK (PRACK), 200 OK (INVITE), and ACK messages. + +**Figure 4.6.2.2.1: Incoming Call (message sequence chart), +example with precondition update** + +## 4.6.3 Outgoing Call flows + +### 4.6.3.1 Outgoing Call with support for preconditions + +Figure 4.6.3.1.1 shows an outgoing call where the preconditions are not met when the IWU receives the initial SIP INVITE. Support for preconditions is confirmed from the external network. Within this example the external node provides a single codec, therefore no second SDP offer/answer is needed for codec negotiation. + +When the IWU receives from the preceding 3GPP node that preconditions are met, then it informs the external node that called subscriber can be alerted with an UPDATE request, where the SDP contains the appropriate precondition offer and the selected codec. + +![Sequence diagram of an outgoing call with preconditions support. Lifelines: 3GPP Node, MGW UP-IWU, MSC Server / IWU, and External Network. The process involves INVITE, 100 TRYING, preconditions check, 183 Progress, PRACK, 200 OK, UPDATE, 200 OK (UPDATE), 180 Ringing, PRACK, 200 OK (PRACK), 200 OK (INVITE), and ACK messages.](9c1d3678db4a12d5864cb2a4def1135d_img.jpg) + +``` + +sequenceDiagram + participant 3GPP Node + participant MGW UP-IWU + participant MSC Server / IWU + participant External Network + + Note left of MGW: from 3GPP Node + Note right of External Network: to External Network + + MGW->>MSC: INVITE [SDP, IAM] +100rel, UPDATE, precondition tag +3gOoBTC, supported codec list +preconditions not met + MSC-->>MGW: 100 TRYING + Note right of MGW: Seize outgoing side RTP bearer terminations +preconditions are not met + MSC->>External: INVITE [SDP, IAM] +100rel, UPDATE, precondition tag +3gOoBTC, supported codec list (updated) +preconditions not met + External-->>MSC: 100 TRYING + Note right of MGW: Seize incoming side RTP bearer terminations + External-->>MSC: 183 Progress [SDP] +100rel, UPDATE, precondition tag +IETF codec, local preconditions met + MGW-->>External: 183 Progress [SDP] +100rel, UPDATE, preconditions +3gOoBTC, selected codec, available codecs +local preconditions met + MGW->>MSC: PRACK + External-->>MSC: PRACK + MGW-->>External: 200 OK (PRACK) + External-->>MSC: 200 OK (PRACK) + MGW->>MSC: UPDATE [SDP] +preconditions are met + External-->>MSC: UPDATE [SDP] +selected codec, preconditions are met + External-->>MSC: 200 OK (UPDATE) [SDP] +selected codec, local preconditions met + MGW-->>External: 200 OK (UPDATE) [SDP] +local preconditions met + External-->>MSC: 180 Ringing [ACM] + MGW-->>External: 180 Ringing [ACM] + MGW->>MSC: PRACK + External-->>MSC: PRACK + MGW-->>External: 200 OK (PRACK) + External-->>MSC: 200 OK (PRACK) + External-->>MSC: 200 OK (INVITE) [ANM] + MGW-->>External: 200 OK (INVITE) [ANM] + MGW->>MSC: ACK + External-->>MSC: ACK + +``` + +Sequence diagram of an outgoing call with preconditions support. Lifelines: 3GPP Node, MGW UP-IWU, MSC Server / IWU, and External Network. The process involves INVITE, 100 TRYING, preconditions check, 183 Progress, PRACK, 200 OK, UPDATE, 200 OK (UPDATE), 180 Ringing, PRACK, 200 OK (PRACK), 200 OK (INVITE), and ACK messages. + +Figure 4.6.3.1.1: Outgoing call (message sequence chart), +example with support for preconditions + +#### 4.6.3.2 Outgoing Call with support of 100rel but no support for preconditions + +Figure 4.6.3.2.1 depicts an outgoing call where the external network supports reliable provisional responses and the UPDATE method but does not support preconditions. Therefore the IWU cannot exchange SDP precondition offers/answers with the external node. + +In this example the IWU receives more than one single codec in the 183 Progress from the external node. Therefore the IWU selects one of the received codecs and makes a second SDP offer to the external node in the PRACK in order to lock the codec. + +The IWU receives a 180 Ringing provisional response from the external network before preconditions are fulfilled. The IWU forwards the 180 Ringing response after preconditions have been fulfilled. + +NOTE 1: The IWU may also have received a successful final response to the INVITE before preconditions have been met. In this case the forwarding of the 180 Ringing response and of the final successful response towards the preceding 3GPP node is delayed until preconditions are fulfilled. + +NOTE 2: As an alternative the IWU could send PRACK to the external node when PRACK is received from the preceding 3GPP node acknowledging the 180 Ringing response. Since the sending of the 180 Ringing response to the 3GPP network may be delayed, this may lead to the retransmission of 180 Ringing response sent by the external node. + +![Sequence diagram for an outgoing call from a 3GPP Node to an External Network via an MGW UP-IWU and an MSC Server / IWU. The diagram shows the flow of SIP messages including INVITE, TRYING, 100rel, 183 Progress, PRACK, 200 OK, 180 Ringing, and ACK. It highlights the handling of preconditions, which are not met at the MGW but are updated and eventually met at the MSC Server.](dd5771673aececa53d42ece89218299d_img.jpg) + +The sequence diagram illustrates the interaction for an outgoing call. The participants are a 3GPP Node, an MGW UP-IWU, an MSC Server / IWU, and an External Network. The MGW UP-IWU is connected to the 3GPP Node via the Nc interface and to the MSC Server / IWU via the Mc interface. The MSC Server / IWU is connected to the External Network via the NNI interface. + +The call sequence is as follows: + +- The 3GPP Node sends an **INVITE [SDP, IAM]** to the MGW UP-IWU. The message includes **100rel, UPDATE, precondition tag 3gOoBTC, supported codec list, precondition not met**. +- The MGW UP-IWU responds with **TRYING**. +- The MGW UP-IWU performs **Seize outgoing side RTP bearer terminations**. At this point, **preconditions are not met**. +- The MGW UP-IWU sends the **INVITE [SDP, IAM]** to the MSC Server / IWU. The message includes **100rel, UPDATE, precondition tag 3gOoBTC, supported codec list (updated), preconditions not met**. +- The MSC Server / IWU responds with **100 TRYING**. +- The MSC Server / IWU sends **183 Progress [SDP]** with **100rel, UPDATE, IETF codec list**. +- The MGW UP-IWU receives this and notes that **O-IWU selects codec**. It then performs **Seize incoming side RTP bearer terminations**. +- The MGW UP-IWU sends **183 Progress [SDP]** back to the 3GPP Node with **100rel, UPDATE, precondition tag 3gOoBTC, selected codec, available codecs, local preconditions met**. +- The MGW UP-IWU sends **PRACK** to the MSC Server / IWU. +- The MSC Server / IWU responds with **200 OK (PRACK) [SDP]** containing the **selected codec**. +- The MGW UP-IWU responds with **200 OK (PRACK)** to the 3GPP Node. +- The MSC Server / IWU sends **180 Ringing [ACM]** to the MGW UP-IWU. +- The MGW UP-IWU sends **PRACK** to the MSC Server / IWU. +- The MSC Server / IWU responds with **200 OK (PRACK)**. +- The MGW UP-IWU sends **UPDATE [SDP]** to the MSC Server / IWU, noting that **preconditions met**. +- The MSC Server / IWU responds with **200 OK (UPDATE) [SDP]**, noting that **local preconditions met**. +- The MGW UP-IWU sends **180 Ringing [ACM]** to the 3GPP Node. +- The MGW UP-IWU sends **PRACK** to the MSC Server / IWU. +- The MGW UP-IWU responds with **200 OK (PRACK)** to the 3GPP Node. +- The MSC Server / IWU receives a message from the External Network and notes that **preconditions are met**. It then sends **200 OK (INVITE) [ANM]** to the MGW UP-IWU. +- The MGW UP-IWU responds with **200 OK (INVITE) [ANM]** to the 3GPP Node. +- The MGW UP-IWU sends **ACK** to the MSC Server / IWU. +- The MSC Server / IWU sends **ACK** to the External Network. + +Sequence diagram for an outgoing call from a 3GPP Node to an External Network via an MGW UP-IWU and an MSC Server / IWU. The diagram shows the flow of SIP messages including INVITE, TRYING, 100rel, 183 Progress, PRACK, 200 OK, 180 Ringing, and ACK. It highlights the handling of preconditions, which are not met at the MGW but are updated and eventually met at the MSC Server. + +**Figure 4.6.3.2.1: Outgoing Call (message sequence chart), +example with support of 100rel but no support for preconditions** + +#### 4.6.3.3 Outgoing Call without support for 100rel and preconditions + +Figure 4.6.3.3.1 depicts an outgoing call where the external network does not support reliable provisional responses and therefore no SDP precondition signalling can be performed with the UPDATE method. With the 183 Progress the IWU receives an IETF codec list "unreliably". If the answer includes more than one codec the IWU cannot make a second offer to the external node (to lock the selected codec) during the early dialogue. However, the IWU can make use of the received information and start codec negotiation when forwarding the 183 Progress to the preceding 3GPP node. + +The IWU immediately sends 200 OK to PRACKs received from the 3GPP node, because it cannot forward them to the external node. The reliable provisional responses cannot be signalled end-to-end. + +The final response from the external network should include the same codecs as received previously within the Progress message. If this answer includes more than one codec the IWU makes a second offer to the external network with a re-INVITE request. + +![Sequence diagram for an outgoing call from a 3GPP Node to an External Network via an MGW UP-IWU and an MSC Server / IWU. The diagram shows the signaling flow for INVITE, TRYING, Progress, OK, and ACK messages, with specific SDP details and bearer termination steps.](e05b36c0d46549e681ce6581422c66b2_img.jpg) + +``` + +sequenceDiagram + participant 3GPP Node + participant MGW UP-IWU + participant MSC Server / IWU + participant External Network + + Note left of MGW: from 3GPP Node + Note right of MSC: to External Network + + MGW->>MSC: INVITE [SDP, IAM] +100rel, UPDATE, precondition tag +3gOoBTC, supported codec list, +preconditions not met + MGW->>3GPP Node: TRYING + Note right of MGW: Seize outgoing side RTP bearer terminations + MSC->>External Network: INVITE [SDP, IAM] +100rel, UPDATE, precondition tag +3gOoBTC, supported codec list (updated) +preconditions not met + Note right of MSC: local preconditions are not met + External Network->>MSC: 100 TRYING + External Network->>MSC: 183 Progress [SDP] +IETF codec list + Note right of MSC: O-IWU selects codec + Note right of MGW: Seize incoming side RTP bearer terminations + MGW->>3GPP Node: 183 Progress [SDP] +100rel, UPDATE, precondition tag +3gOoBTC, selected codec, available codecs +local preconditions met + MGW->>MSC: PRACK + MGW->>3GPP Node: 200 OK (PRACK) + MGW->>MSC: UPDATE [SDP] +preconditions met + MGW->>3GPP Node: 200 OK (UPDATE) [SDP] +local preconditions met + Note right of MSC: preconditions are met + External Network->>MSC: 180 Ringing [ACM] + MGW->>3GPP Node: 180 Ringing [ACM] + MGW->>MSC: PRACK + MGW->>3GPP Node: 200 OK (PRACK) + External Network->>MSC: 200 OK (INVITE) [SDP, ANM] +IETF codec list + MGW->>3GPP Node: 200 OK (INVITE) [ANM] + MGW->>MSC: ACK + MSC->>External Network: ACK + MSC->>External Network: Re-INVITE [SDP] +selected codec + External Network->>MSC: 200 OK (re-INVITE) [SDP] +selected codec + MSC->>External Network: ACK + +``` + +Sequence diagram for an outgoing call from a 3GPP Node to an External Network via an MGW UP-IWU and an MSC Server / IWU. The diagram shows the signaling flow for INVITE, TRYING, Progress, OK, and ACK messages, with specific SDP details and bearer termination steps. + +Figure 4.6.3.3.1: Outgoing Call (message sequence chart), +example without support for 100rel and preconditions + +## 5 Interworking between a SIP-I based circuit-switched core network and an ISUP based network + +### 5.1 Reference Model + +Figure 5.1.1 details the interworking reference model for clause 5 of the present specification + +![Figure 5.1.1: interworking reference model. The diagram shows two main components: 'SIP-I based CS CN' on the left and 'ISUP based network, either CS CN or external network' on the right, both represented by grey ovals. Between them is a light blue rectangular box labeled 'Scope of this TS'. Inside this box are two white rectangular boxes: 'IWU' at the top and 'UP-IWU' at the bottom. A vertical dashed line labeled 'H.248' connects the IWU and UP-IWU. A solid horizontal line (User Plane) connects the SIP-I based CS CN to the UP-IWU, and another solid horizontal line (User Plane) connects the UP-IWU to the ISUP based network. A dashed horizontal line (Control Plane) connects the SIP-I based CS CN to the IWU, labeled 'SIP-I over Nc' and 'media/ RTP/ UDP/IP/ over Nb'. Another dashed horizontal line (Control Plane) connects the IWU to the ISUP based network, labeled 'ISUP'. A solid horizontal line (User Plane) also connects the IWU to the ISUP based network, labeled 'TDM'. A legend at the bottom left shows a solid line for 'User Plane' and a dashed line for 'Control Plane'. A legend at the bottom right shows a light blue box for 'Scope of this TS'.](dbbc0baac7341cda76cc4f8355dce23f_img.jpg) + +Figure 5.1.1: interworking reference model. The diagram shows two main components: 'SIP-I based CS CN' on the left and 'ISUP based network, either CS CN or external network' on the right, both represented by grey ovals. Between them is a light blue rectangular box labeled 'Scope of this TS'. Inside this box are two white rectangular boxes: 'IWU' at the top and 'UP-IWU' at the bottom. A vertical dashed line labeled 'H.248' connects the IWU and UP-IWU. A solid horizontal line (User Plane) connects the SIP-I based CS CN to the UP-IWU, and another solid horizontal line (User Plane) connects the UP-IWU to the ISUP based network. A dashed horizontal line (Control Plane) connects the SIP-I based CS CN to the IWU, labeled 'SIP-I over Nc' and 'media/ RTP/ UDP/IP/ over Nb'. Another dashed horizontal line (Control Plane) connects the IWU to the ISUP based network, labeled 'ISUP'. A solid horizontal line (User Plane) also connects the IWU to the ISUP based network, labeled 'TDM'. A legend at the bottom left shows a solid line for 'User Plane' and a dashed line for 'Control Plane'. A legend at the bottom right shows a light blue box for 'Scope of this TS'. + +NOTE: The IWU is a logical function that may reside with other 3GPP logical functions in the same physical nodes, e.g. in an (G)MSC Server. The figure shows only the logical separation. + +**Figure 5.1.1: interworking reference model** + +**Nb reference point:** The Nb reference point is defined in accordance with TS 29.414 [43]. + +**Nc reference point:** The Nc reference point is defined in accordance with TS 29.231 [4]. + +### 5.2 Control Plane Interworking + +The following clauses define the signalling interworking between the ISDN User Part (ISUP) protocols and Session Initiation Protocol (SIP) with its associated Session Description Protocol (SDP) and encapsulated ISUP at an IWU. + +The IWU shall act as a Type A or Type B exchange (ITU-T Recommendation Q.764 [7]) for the purposes of ISUP compatibility procedures. + +NOTE: An IWU may apply additional procedures to support interworking for national-specific capabilities. + +The ISUP capabilities or signalling information defined for national use are outside the scope of the present document. + +The services that can be supported through the use of the signalling interworking are limited to the services that are supported both within the ISUP based network and the SIP-I based CS CN. The IWU will originate and/or terminate services or capabilities that do not interwork seamlessly across domains according to the relevant protocol recommendation or specification. + +Table 5.2.1 lists the services seamlessly interworked within the scope of the present document. + +**Table 5.2.1: Seamlessly interworked Services** + +| Service | +|------------------------------------------------------------------| +| Speech/3.1 kHz audio | +| Data Calls (optional) | +| En bloc address signalling | +| Out of band transport of DTMF tones and information. (BICC only) | +| Inband transport of DTMF tones and information. (BICC and ISUP) | +| Multiple Subscriber Number (MSN) | +| Calling Line Identification Presentation (CLIP) | +| Calling Line Identification Restriction (CLIR) | +| Connected line presentation (COLP) | +| Connected line restriction (COLR) | +| Call Hold | +| Call Forwarding | +| Explicit Call Transfer (ECT) | +| User-to-User Signalling (UUS) | +| Call Deflection (CD) | +| Closed User Group (CUG) | +| Completion of Calls to Busy Subscriber (CCBS) | +| Multi-Level Precedence and Pre-emption (MLPP) | +| Call Waiting | + +The clause 5.3.2 of ITU-T Recommendation Q.1912.5 [6] describes additional general principles specific to SIP-I. + +The interworking procedures in clauses 5.3, 5.4 and 5.4 are based on ITU-T Recommendation Q.1912.5 [6] profile C. Clarifications are made within this specification on the application of ITU-T Recommendation Q.1912.5 [6] profile C. + +The control plane between the ISUP network and the SIP-I based CN is as shown in figure 5.2.1. + +![Diagram of control plane interworking between an ISUP based network and a SIP-I based CS CN through an Interworking Unit.](836b0790cef5469a167fa8931df4e408_img.jpg) + +The diagram illustrates the control plane interworking between an ISUP based network and a SIP-I based CS CN. It features a central 'Interworking Unit' (IWU) represented by a box with a split top. The IWU is divided into two vertical sections. The left section contains three stacked boxes labeled 'ISUP', 'MTP3', and 'MTP2'. The right section contains two stacked boxes labeled 'SIP-I' and 'SCTP'. Below these, the left section has an 'L1' box and the right section has an 'IP' box. To the left of the IWU, an arrow labeled 'ISUP' points to the top-left box, and an arrow labeled 'TDM' points to the bottom-left box. To the right of the IWU, an arrow labeled 'SIP-I' points from the top-right box, and an arrow labeled 'IP' points from the bottom-right box. Below the IWU, the text 'ISUP based network' is on the left and 'SIP-I based CS CN' is on the right. + +Diagram of control plane interworking between an ISUP based network and a SIP-I based CS CN through an Interworking Unit. + +**Figure 5.2.1: Control plane interworking between a SIP-I based circuit-switched core network and an ISUP based network** + +## 5.3 Signalling Interworking of a Call from the ISUP based network towards the SIP-I based circuit-switched core network + +### 5.3.1 General + +The procedures for Profile C in clause 7 of ITU-T Recommendation Q.1912.5 [6] shall be applied with the modifications provided in this subclause. + +#### 5.3.1.1 Sending of ISUP information to adjacent SIP nodes + +The IWU receiving ISUP information shall apply any interworking procedures detailed in clause 7 of ITU-T Recommendation Q.1912.5 [6] affecting parameters within the ISUP, and then proceed to encapsulate any ISUP information received (with the exception of the excluded messages detailed in 5.4.3 of ITU-T Recommendation Q.1912.5 [6]) in a SIP message in a MIME body according to IETF RFC 3204 [19]. SIP Header fields relating to the handling of the ISUP body shall be set as specified in clause 5.4.1.2 of ITU-T Recommendation Q.1912.5 [6]. + +NOTE 1: The text in the preceding paragraph has been derived from ITU-T Recommendation Q.1912.5 [6], clause 5.4.1. + +For a basic call setup, the SIP message used to encapsulate the ISUP message shall be the SIP message that was first triggered to be sent from the IWU as a result of the interworking specified in clause 7 of ITU-T Recommendation Q.1912.5 [6]. As an example, this means that an ISUP IAM will be encapsulated within the INVITE message that is sent out from the IWU. For the ISUP messages listed in table 1 of ITU-T Recommendation Q.1912.5 [6], the special procedures in clause 5.4.3 of ITU-T Recommendation Q.1912.5 [6] are applicable. + +NOTE 2: The text in the preceding paragraph has been derived from ITU-T Recommendation Q.1912.5 [6], clause 5.4.1.3. + +#### 5.3.1.2 Receipt of encapsulated ISUP information within SIP-I + +On receipt of a SIP message containing encapsulated ISUP, the IWU shall de-encapsulate the ISUP message from the SIP message body. The received SIP message shall be mapped to an ISUP message and merged with the de-encapsulated ISUP information according to the rules in clause 7 of ITU-T Recommendation Q.1912.5 [6]. + +NOTE 1: The text in the preceding paragraph has been derived from ITU-T Recommendation Q.1912.5 [6], clause 5.4.2. + +NOTE 2: These precedence rules have been derived from the following principles, which can also be applied for any ISUP information not covered by the present specification: + +- 1 Where a SIP header mapping to ISUP field(s) is possible (for example the mapping of Request-URI to Called Party Number), the SIP header is given precedence over the encapsulated ISUP value in the alignment process. (Conflicts can be caused by a possible service invocation within the SIP network.) +- 2 De-encapsulated ISUP information overrides ISUP information derived from default values (rather than SIP information). +- 3 Local ISUP procedures may modify information derived from SIP or default values. + +This Note has been derived from text in ITU-T Recommendation Q.1912.5 [6], clause 5.4.2 + +NOTE 3: There is a certain change against ITU-T Recommendation Q.1912.5 [6], where the above note is formulated as normative procedures. However, this is very high level and not required if you look at the real interworking procedures later on. Therefore formulating this as a Note makes much more sense. + +#### 5.3.1.3 Special procedures related to outgoing INVITE + +##### 5.3.1.3.1 Overlap Signalling + +The IWU does not need to support procedures related to overlap signalling in clause 7 of ITU-T Recommendation Q.1912.5 [6]. + +NOTE: No overlap signalling is used in a 3GPP CS domain. A G-MSC acting as IWU will collect all digits required to identify the called party and not propagate the overlap signalling further. + +### 5.3.1.3.2 Coding of encapsulated ISUP IAM parameters in outgoing INVITE + +The IWU may choose to transcode media, or attempt to interwork media without transcoding. If the IWU transcodes, it should set the TMR/USI/HLC parameters according to the codec applied in the SIP-I network. Otherwise, it should provide the TMR/USI/HLC parameters as received in the incoming IAM. If the IWU offers several codecs within SDP, it should set the TMR/USI/HLC parameters according to the preferred codec, applying the rules above for this codec. + +NOTE: ITU-T Recommendation Q.1912.5 [6] does not describe the relationship between TMR/USI/HLC and SDP codec negotiation. + +### 5.3.1.3.3 Media offered in SDP of outgoing INVITE + +The IWU should offer codecs known to be supported within the SIP-I based CS CN network. If multiple speech codecs are offered, Out of Band Transcoder Control (OoBTC) procedures shall be applied by the IWU in accordance with TS 23.153 [5]. Otherwise only the default PCM speech codec shall be signalled in an SDP offer; auxiliary payload types such as the Telephony Event RTP payload type may be included in addition. + +If the IWU applies the optional "optimised MGW selection" procedure, it shall include a MGW Identifier in the SDP. Related signalling procedures are described in clause 4.4 of TS 23.231 [3] and the encoding of the MGW Identifier is defined in TS 29.231 [4]. + +## 5.4 Signalling Interworking of a Call from SIP-I based circuit-switched core network towards the ISUP based network + +### 5.4.1 General + +The procedures for Profile C in clause 6 of ITU-T Recommendation Q.1912.5 [6] shall be applied with the modifications provided in this subclause. + +### 5.4.2 Interworking of received ISUP messages to SIP messages + +The IWU receiving backwards ISUP information shall apply any interworking procedures detailed in clause 6 of ITU-T Recommendation Q.1912.5 [6] affecting parameters within the ISUP, and then proceed to encapsulate any ISUP information received (with the exception of the excluded messages detailed in 5.4.3 of ITU-T Recommendation Q.1912.5 [6]) in a SIP message in a MIME body according to IETF RFC 3204 [19]. The selected SIP Header fields relating to the handling of the ISUP body shall be set as specified in clause 5.4.1.2 of ITU-T Recommendation Q.1912.5 [6]. + +### 5.4.3 Interworking of received SIP messages to ISUP messages + +#### 5.4.3.1 Receipt of encapsulated ISUP information within SIP + +On receipt of a SIP message containing encapsulated ISUP, the IWU shall de-encapsulate the ISUP message from the SIP message body. The received SIP message shall be mapped to an ISUP message and merged with the de-encapsulated ISUP message according to the rules for Profile C in clause 6 of ITU-T Recommendation Q.1912.5 [6]. + +NOTE 1: These precedence rules have been derived from the following principles, which can also be applied for any ISUP information not covered by the present specification: + +- 1 Where a SIP header mapping to ISUP field(s) is possible (for example the mapping of Request-URI to Called Party Number), the SIP header is given precedence over the encapsulated ISUP value in the alignment process. +- 2 De-encapsulated ISUP information overrides ISUP information derived from default values (rather than SIP information). +- 3 Local ISUP procedures may modify information derived from SIP or default values. + +This note has been derived from text in ITU-T Recommendation Q.1912.5 [6], clause 5.4.2. + +NOTE 2: There is a certain change against ITU-T Recommendation Q.1912.5 [6], where the above note is formulated as normative procedures. However, this is very high level and not required if you look at the real interworking procedures later on. Therefore formulating this as a note makes much more sense. + +### 5.4.3.2 Special Procedures for the Reception of SIP INVITE request + +#### 5.4.3.2.1 Propagation of overlap signalling toward the 3GPP CS domain + +The procedures in clause 6 of ITU-T Recommendation Q.1912.5 [6] related to the propagation of overlap signalling are not applicable, since no overlap signalling is used within the CS CN. + +#### 5.4.3.2.2 Derivation of TMR, USI and HLC parameters within sent IAM message + +The IWU may choose to transcode media and shall then set the parameters according to the coding applied within the CS Domain. Otherwise, the IWU shall select a codec for the SIP side termination using SDP offer-answer procedures, IETF RFC 3264 [22], and shall map the SDP information of this codec to the TMR/USI/HLC parameters according to table 2a of TS 29.163 [13]. If the information derived from this mapping matches the information in the TMR/USI/HLC parameters in the encapsulated ISUP, the TMR/USI/HLC parameters from the encapsulated ISUP should be used as they may contain additional information. If the information derived from this mapping contradicts the information in the TMR/USI/HLC parameters in the encapsulated ISUP, the TMR/USI/HLC parameters derived by the mapping shall be used. + +NOTE: The procedures in this note are an amendment compared to ITU-T Recommendation Q.1912.5 [6], which simply states the TMR parameters in encapsulated ISUP shall take precedence, However this is inappropriate if an incompatible codec is selected. + +#### 5.4.3.2.3 Receipt of SIP INVITE without SDP offer + +An IWU may reject receipt of SIP INVITE without SDP offer, otherwise the procedures in section 4.2.2.3 shall be followed. + +NOTE: A SIP INVITE without SDP offer is not used within the CS CN. + +#### 5.4.3.2.4 Special Procedures for deferred MGW selection procedure. + +If the IWU supports the optional "deferred MGW selection" procedure and receives an unspecified connection address in the SDP offer contained in the INVITE request, it should include a MGW Identifier for the IWU-UP it selects in the corresponding SDP answer. Related signalling procedures are described in clause 4.4 of TS 23.231 [3] and the encoding of the MGW Identifier is defined in TS 29.231 [4]. + +## 5.5 Supplementary services + +### 5.5.1 Special procedures for supplementary service interworking + +The supplementary services described in table 5.2.1 are interworked by using the parameters of the (de)encapsulated ISUP. No other interworking is required, except if otherwise described within the clauses below. + +### 5.5.2 Interworking of CLIP/CLIR supplementary service + +For the interworking of call towards the SIP-I based CS CN: the service shall be supported by encapsulation. + +For the interworking of call from the SIP-I based CS CN: ITU-T Recommendation Q.1912.5 [6], Annex B.1, shall apply. + +### 5.5.3 Interworking of Call Hold (HOLD) supplementary service + +The Profile C procedures in ITU-T Recommendation Q.1912.5 [6], clause B.10, shall be followed. + +### 5.5.4 Interworking of Completion of Calls to Busy Subscriber (CCBS) supplementary service to SIP networks + +The Profile C procedures of ITU-T Recommendation Q.1912.5 [6], clause B.11 shall be applied. + +## 5.6 User Plane Interworking + +### 5.6.1 General + +This clause describes user plane issues including interworking of DTMF. + +Figure 5.6.1.1 shows the user plane protocol stacks within the SIP-I based CS CN and an ISUP network. + +Apart from speech codecs, data call related codecs, e.g. as listed in table 2a of TS 29.163 [13], may be used. + +![Diagram of User Plane Interworking and ISUP based CS Domain. It shows two network clouds connected via a central protocol stack. The left cloud is 'SIP-I based CS CN' and the right is 'ISUP based network'. The central stack has five layers: L1, L2, IP, UDP, and RTP. Above the stack, 'Transcoding or Relay' is indicated with a double-headed arrow. To the right of the stack, a box contains 'Codec, e.g. AMR' and 'e.g. G.711', with 'TDM' written below it. Below the stack, a box is labeled 'UP-IWU'.](d8698aacaeead6dfed9a1e448670a2e4_img.jpg) + +The diagram illustrates the user plane protocol stack for interworking between a SIP-I based CS CN and an ISUP based network. The stack consists of five layers: L1, L2, IP, UDP, and RTP. Above the stack, a 'Transcoding or Relay' function is indicated by a double-headed arrow. To the right of the stack, a box contains 'Codec, e.g. AMR' and 'e.g. G.711', with 'TDM' written below it. Below the stack, a box is labeled 'UP-IWU'. + +| | | +|-----------------------|---------------| +| Codec,
e.g.
AMR | e.g.
G.711 | +| RTP | TDM | +| UDP | | +| IP | | +| L2 | | +| L1 | | + +Diagram of User Plane Interworking and ISUP based CS Domain. It shows two network clouds connected via a central protocol stack. The left cloud is 'SIP-I based CS CN' and the right is 'ISUP based network'. The central stack has five layers: L1, L2, IP, UDP, and RTP. Above the stack, 'Transcoding or Relay' is indicated with a double-headed arrow. To the right of the stack, a box contains 'Codec, e.g. AMR' and 'e.g. G.711', with 'TDM' written below it. Below the stack, a box is labeled 'UP-IWU'. + +Figure 5.6.1.1: User Plane Interworking and ISUP based CS Domain + +### 5.6.2 DTMF + +If RTP Telephony Event is selected by the 3GPP CS CN the MGW shall filter out (delete) the DTMF from the default PCM codec when relaying the DTMF via the RTP Telephony Event to prevent potential double signalling of the same digit if a later insertion back to inband PCM transmission were to occur. + +## 5.7 Example Call flows + +The call flow examples in ITU-T Recommendation Q.1912.5 [6] Appendix III are applicable with the following exceptions for the reasons specified: + +- III.2.1.1 En bloc, subscriber free indication - flow does not include use of reliable provisional response within the SIP-I network +- III.2.1.2 En bloc, early ACM - flow does not include use of reliable provisional response within the SIP-I network +- III.2.1.3 En bloc, early media scenario - flow does not include use of reliable provisional response within the SIP-I network +- III.2.1.4 En bloc, simple segmentation procedures - flow does not include use of reliable provisional response within the SIP-I network +- III.2.1.10 Overlap signalling - 3GPP G-MSC will collect all digits before continuing the call +- III.2.2.1 Backward release during call setup - flow does not include use of reliable provisional response within the SIP-I network + +## 6 Interworking between a SIP-I based circuit-switched core network and a BICC based network + +### 6.1 Reference Model + +Figure 6.1.1 details the interworking reference model for clause 6 of the present specification. + +![Figure 6.1.1: interworking reference model diagram. The diagram shows two main entities: 'SIP-I based CS CN' on the left and 'BICC based network, either CS CN or external network' on the right. Between them is a central box representing the 'Scope Of this TS', which contains two sub-components: 'IWU' (top) and 'UP-IWU' (bottom). The IWU is connected to the SIP-I based CS CN via a dashed line labeled 'SIP-I over Nc'. The UP-IWU is connected to the SIP-I based CS CN via a solid line labeled 'media/ RTP/ UDP/IP/ over Nb'. The IWU is connected to the BICC based network via a dashed line labeled 'BICC'. The UP-IWU is connected to the BICC based network via a solid line labeled 'TDM'. A vertical dashed line labeled 'H.248' connects the IWU and the UP-IWU. A legend at the bottom indicates that solid lines represent the 'User Plane' and dashed lines represent the 'Control Plane'. A light blue box represents the 'Scope Of this TS'.](b6ad8b32179842fca5ad086cf22b03eb_img.jpg) + +Figure 6.1.1: interworking reference model diagram. The diagram shows two main entities: 'SIP-I based CS CN' on the left and 'BICC based network, either CS CN or external network' on the right. Between them is a central box representing the 'Scope Of this TS', which contains two sub-components: 'IWU' (top) and 'UP-IWU' (bottom). The IWU is connected to the SIP-I based CS CN via a dashed line labeled 'SIP-I over Nc'. The UP-IWU is connected to the SIP-I based CS CN via a solid line labeled 'media/ RTP/ UDP/IP/ over Nb'. The IWU is connected to the BICC based network via a dashed line labeled 'BICC'. The UP-IWU is connected to the BICC based network via a solid line labeled 'TDM'. A vertical dashed line labeled 'H.248' connects the IWU and the UP-IWU. A legend at the bottom indicates that solid lines represent the 'User Plane' and dashed lines represent the 'Control Plane'. A light blue box represents the 'Scope Of this TS'. + +NOTE: The IWU is a logical function that may reside with other 3GPP logical functions in the same physical nodes, e.g. in an (G)MSC Server. The figure shows only the logical separation. + +**Figure 6.1.1: interworking reference model** + +**Nb reference point:** The Nb reference point is defined in accordance with TS 29.414 [43]. + +**Nc reference point:** The Nc reference point is defined in accordance with TS 29.231 [4]. + +## 6.2 Control Plane Interworking + +### 6.2.1 General + +The following clauses define the signalling interworking between the Bearer Independent Call Control (BICC) protocol (see ITU-T Recommendation Q.1902.1 to Q.1902.6 [8]) and the Session Initiation Protocol (SIP) with its associated Session Description Protocol (SDP) and encapsulated ISUP at an IWU. + +The IWU shall act as a Type A or Type B exchange (ITU-T Recommendation Q.764 [7]) for the purposes of ISUP compatibility procedures. + +The BICC capabilities or signalling information defined for national use are outside the scope of the present document. + +NOTE: An IWU may apply additional procedures to support interworking for national-specific capabilities. + +The services that can be supported through the use of the signalling interworking are limited to the services that are supported both within the BICC based network and the SIP-I based CS CN. The IWU will originate and/or terminate services or capabilities that do not interwork seamlessly across domains according to the relevant protocol recommendation or specification. + +Table 5.2.1 in clause 5.2 lists the services seamlessly interworked within the scope of the present document. + +The clause 5.3.2 of ITU-T Recommendation Q.1912.5 [6] describes additional general principles specific to SIP-I. + +The interworking procedures in the clauses 6.3 and 6.4 are based on ITU-T Recommendation Q.1912.5 [6] profile C. Clarifications are made within this specification on the application of ITU-T Recommendation Q.1912.5 [6] profile C. Specific rules for handling of the APM mechanism have been added, which are not specified in ITU-T Recommendation Q.1912.5 [6]. + +## 6.2.2 Signalling interactions between network entities in the control plane + +The control plane between a SIP-I based CS core networks and a BICC based network, where the underlying signalling transport is either IP or ATM respectively, is shown in figures 6.2.2.1 and 6.2.2.2. + +![Figure 6.2.2.1: Control plane interworking between SIP-I based CS CN and a BICC based network with IP signalling transport. The diagram shows a central 'Interworking Unit' box with five layers. From top to bottom, the layers are: BICC, STCMTP, M3US, SCTP, and IP. On the left side, the top two layers (BICC and STCMTP) are connected to a 'BICC network'. The bottom three layers (M3US, SCTP, and IP) are connected to an 'IP' transport. On the right side, the top layer (BICC) is connected to an 'SIP-I' entity. The middle layer (M3US) is connected to an 'SCTP' entity. The bottom layer (IP) is connected to an 'IP' transport. Arrows indicate bidirectional signalling flow between the networks and the Interworking Unit.](26e334e61dd059cff029338a2a604d8d_img.jpg) + +Figure 6.2.2.1: Control plane interworking between SIP-I based CS CN and a BICC based network with IP signalling transport. The diagram shows a central 'Interworking Unit' box with five layers. From top to bottom, the layers are: BICC, STCMTP, M3US, SCTP, and IP. On the left side, the top two layers (BICC and STCMTP) are connected to a 'BICC network'. The bottom three layers (M3US, SCTP, and IP) are connected to an 'IP' transport. On the right side, the top layer (BICC) is connected to an 'SIP-I' entity. The middle layer (M3US) is connected to an 'SCTP' entity. The bottom layer (IP) is connected to an 'IP' transport. Arrows indicate bidirectional signalling flow between the networks and the Interworking Unit. + +**Figure 6.2.2.1: Control plane interworking between SIP-I based CS CN and a BICC based network with IP signalling transport** + +![Figure 6.2.2.2: Control plane interworking between SIP-I based CS CN and a BICC based network with ATM signalling transport. The diagram shows a central 'Interworking Unit' box with six layers. From top to bottom, the layers are: BICC, STC, MTP3B, SSCF, SSCOP, and AAL5. On the left side, the top four layers (BICC, STC, MTP3B, and SSCF) are connected to a 'BICC network'. The bottom two layers (SSCOP and AAL5) are connected to an 'ATM' transport. On the right side, the top layer (BICC) is connected to an 'SIP-I' entity. The fifth layer (SSCOP) is connected to an 'SCTP' entity. The bottom layer (AAL5) is connected to an 'IP' transport. Arrows indicate bidirectional signalling flow between the networks and the Interworking Unit.](ccfd5ed8d9795009e923e2a0cacbcd6e_img.jpg) + +Figure 6.2.2.2: Control plane interworking between SIP-I based CS CN and a BICC based network with ATM signalling transport. The diagram shows a central 'Interworking Unit' box with six layers. From top to bottom, the layers are: BICC, STC, MTP3B, SSCF, SSCOP, and AAL5. On the left side, the top four layers (BICC, STC, MTP3B, and SSCF) are connected to a 'BICC network'. The bottom two layers (SSCOP and AAL5) are connected to an 'ATM' transport. On the right side, the top layer (BICC) is connected to an 'SIP-I' entity. The fifth layer (SSCOP) is connected to an 'SCTP' entity. The bottom layer (AAL5) is connected to an 'IP' transport. Arrows indicate bidirectional signalling flow between the networks and the Interworking Unit. + +**Figure 6.2.2.2: Control plane interworking between SIP-I based CS CN and a BICC based network with ATM signalling transport** + +Signalling between the SIP-I based CS CN and the Interworking Unit uses the services of IP (IETF RFC 791 [14] or IETF RFC 2460 [17]), SCTP (IETF RFC 4960 [18]) and SIP-I. + +## 6.3 Signalling Interworking of a Call from the BICC based network towards the SIP-I based circuit-switched core network + +The procedures in clause 5.3 shall be applied with the modifications provided in the present subclause. + +The text in clause 5.3 is to be understood as follows: + +- Where "ISUP" is mentioned, this shall be understood as BICC. As an exception, references to ISUP encapsulated within SIP-I shall be understood without modification, i.e. they still refer to ISUP rather than BICC. + +If an IAM message is received, the APM information elements (see ITU-T Recommendation Q.765 [27]) relating to the BICC APM user (see ITU-T Recommendation Q.765.5 [28]) shall be removed before the IAM message is encapsulated in the triggered SIP INVITE message. + +An APM message received from the CS side (see ITU-T Recommendation Q.765 [27]) that relates to the BICC APM user (see ITU-T Recommendation Q.765.5 [28]) shall not be encapsulated in any triggered SIP message. + +## 6.4 Signalling Interworking of a Call from SIP-I based circuit-switched core network towards the BICC based network + +The procedures in clause 5.4 shall be applied with the modifications provided in the present subclause. + +The text in clause 5.4 is to be understood as follows: + +- Where "ISUP" is mentioned, this shall be understood as BICC. As an exception, references to ISUP encapsulated within SIP-I shall be understood without modification, i.e. they still refer to ISUP rather than BICC. + +An APM message received from the BICC side (see ITU-T Recommendation Q.765 [27]) that relates to the BICC APM user (see ITU-T Recommendation Q.765.5 [28]) shall not be encapsulated in any triggered SIP message. + +## 6.5 Supplementary services + +The procedures in clause 5.5 shall be applied. + +## 6.6 Codec Negotiation between a BICC based network and a SIP-I based circuit-switched core network + +### 6.6.1 General + +The procedures in Annex B of TS 29.163 [13] shall be applied with the modifications provided in the following clauses. + +The text in Annex B of TS 29.163 [13] is to be understood as follows: + +- Where "MGCF" is mentioned, this shall be understood as IWU. +- Where "IM-MGW" is mentioned, this shall be understood as UP-IWU. +- Where "IM CN subsystem" is mentioned, this shall be understood as SIP-I based circuit-switched core network. + +The offer/answer procedures of the Session Description Protocol (SDP) for media negotiation shall be applied as specified in TS 29.231 [4]. + +### 6.6.2 Codec Negotiation from SIP-I on Nc to BICC Network + +#### 6.6.2.1 Sending of IAM + +When the IWU receives an initial INVITE request with SDP offer containing a codec list with the 3GPP\_OoBTC\_Indicator, the procedures defined for a 3GPP node terminating SDP offer in clause 9 of TS 23.153 [5] shall be applied. The IWU shall follow the procedures of clause B.2.5 of TS 29.163 [13] to create a Supported Codec List for transmission in the outgoing IAM. + +#### 6.6.2.2 Sending of SDP Answer + +When the IWU receives the backward codec information, it shall apply the procedure defined in the clause B.2.1.2 of TS 29.163 [13] and shall create the SDP answer in accordance with the procedures defined for a 3GPP node terminating SDP offer in clause 9 of TS 23.153 [5]. + +#### 6.6.2.3 Mid-call Codec Negotiation initiated from SIP-I on Nc + +When the mid-call codec negotiation is initiated from the SIP-I based CS CN side the IWU: + +- shall apply the procedures defined for a 3GPP node terminating SDP offer in clause 9 of TS 23.153 [5] for the SIP-I based CS CN side, and +- shall apply the procedures from the clause B.2.3 of TS 29.163 [13] for the BICC network side. + +### 6.6.3 Codec Negotiation from BICC Network to SIP-I on Nc + +#### 6.6.3.1 Sending of initial SDP Offer + +When the IWU receives an IAM, the IWU shall follow the procedures of clause B.2.5 of TS 29.163 [13] to convert the Supported Codec List from the IAM into an SDP offer for transmission in the outgoing INVITE request. When generating the initial SDP offer, the IWU shall apply the procedures defined for a 3GPP node originating SDP offer in clause 9 of TS 23.153 [5]. + +#### 6.6.3.2 Responding to Serving Node initiating Codec Negotiation + +When the IWU receives the SDP answer it shall select a codec configuration for the SIP-I based CS CN side in accordance with clause 9 of TS 23.153 [5]. For the BICC network side the IWU shall apply the procedure defined in the clause B.2.2.2 of TS 29.163 [13]. + +#### 6.6.3.3 Mid-call Codec Negotiation initiated from BICC + +When the mid-call codec negotiation is initiated from the BICC side the IWU: + +- shall apply the procedures from the clause B.2.4 of TS 29.163 [13] for the BICC network side, and +- shall apply the procedures defined for a 3GPP node originating SDP offer in clause 9 of TS 23.153 [5] for the SIP-I based CS CN side. + +## 6.7 DMTF Signalling Interworking applicable for all Calls between a BICC network and a SIP-I based circuit-switched core network + +### 6.7.1 General + +DTMF signalling via the RTP telephony-event is mandated to be supported over the Nb interface for SIP-I based Circuit Switched Core Network on Nc Interface, see TS 23.231 [3]. However it is an option to use this transmission method when only the default PCM codec selected. + +BICC over Nc supports both inband DTMF and DTMF via OoB signalling within the BICC APM, see TS 23.205 [9]. If OoB TC is supported then use of OoB DTMF is mandated, see TS 23.153 [5]. External BICC networks may also transport DTMF either inband or via OoB signalling within the BICC APM. + +If the usage of the RTP Telephony Event has been negotiated within the SIP-I based CS CN, the IWU shall configure this payload type at the UP-IWU. + +### 6.7.2 DTMF transfer from SIP-I on Nc to BICC network (Out-of-Band DTMF) + +If RTP Telephony Event has been selected for the 3GPP SIP-I CS CN and OoB DTMF transmission is required in the succeeding BICC network the IWU shall use the Detect DTMF procedure to request the MGW to report DTMF Digits as described in clause 14.4.6 of TS 23.231 [3], i.e. RTP Telephony Event is configured in addition to the Detect DTMF Event. An example for the interworking with explicit duration reporting in BICC is shown in figure 6.7.2.1. + +NOTE 1: If the implicit duration is reported via the BICC Out Of Band procedure it can result in the duration being shorter than the original duration of the DTMF received at the MGW and even shorter than the minimum duration required by TS 23.014 [24]. + +An example for the interworking with implicit duration reporting in BICC is shown in figure 6.7.2.2. + +NOTE 2: Support of "start of DTMF detection" is optional for the MGW (UP-IWU). + +![Figure 6.7.2.1: DTMF interworking: SIP-I to BICC, explicit duration (message sequence chart).](8269648391c59363ea61243864a2adf7_img.jpg) + +This sequence diagram illustrates the explicit duration DTMF interworking between an IWU and a UP-IWU, with a BICC Network (PLMN or External) and a Server. The process is triggered by the detection of a DTMF digit via an RTP Tel Event (start DTMF and StopDTMF). The sequence of messages is as follows: + + +- The IWU sends a **MOD. Request** [RTP Tel Event, Event = EndTone] (Tx) to the UP-IWU. Context (Cx) is indicated. +- The UP-IWU responds with a **MOD. Reply** (Tx). +- Simultaneously, the IWU sends an **RTP Telephony Event** [(Digit), E=1, Duration = y] Context (Cx) to the UP-IWU. +- The UP-IWU then sends a **Notify.Request** [Report DTMF, end tone, Digit, (duration=y)] (Tx) to the BICC Network. +- The BICC Network forwards the **Report DTMF Digit** to the Server via a **BICC OoB DTMF** (Digit (duration=y)) message. +- The UP-IWU receives a **Notify. Reply** (Tx) from the BICC Network. Context (Cx) is indicated. + +Figure 6.7.2.1: DTMF interworking: SIP-I to BICC, explicit duration (message sequence chart). + +Figure 6.7.2.1: DTMF interworking: SIP-I to BICC, explicit duration (message sequence chart) + +![Figure 6.7.2.2: DTMF interworking: SIP-I to BICC, implicit duration (message sequence chart).](9a14684f8ae1345c6efea6f5994c730c_img.jpg) + +This sequence diagram illustrates the implicit duration DTMF interworking between an IWU and a UP-IWU, with a BICC Network (PLMN or External) and a Server. The process is triggered by the detection of a DTMF digit via an RTP Tel Event (start DTMF and StopDTMF). The sequence of messages is as follows: + + +- The IWU sends a **MOD. Request** [RTP Tel Event, Event = StartTone, EndTone] (Tx) to the UP-IWU. Context (Cx) is indicated. +- The UP-IWU responds with a **MOD. Reply** (Tx). +- Simultaneously, the IWU sends an **RTP Telephony Event** [(Digit), E=0, bit = 0, Duration = x] Context (Cx) to the UP-IWU. +- The UP-IWU then sends a **Notify.Request** [Report DTMF, start tone, Digit] (Tx) to the BICC Network. +- The BICC Network forwards the **Report start of DTMF Digit** to the Server via a **BICC OoB DTMF** (Start\_Digit) message. +- The UP-IWU receives a **Notify. Reply** (Tx) from the BICC Network. Context (Cx) is indicated. +- Subsequently, the IWU sends another **RTP Telephony Event** [(Digit), E=1, bit = 1, Duration = y] Context (Cx) to the UP-IWU. +- The UP-IWU then sends a **Notify.Request** [Report DTMF, end tone, Digit] (Tx) to the BICC Network. +- The BICC Network forwards the **Report end of DTMF Digit** to the Server via a **BICC OoB DTMF** (Stop\_Digit) message. +- The UP-IWU receives a **Notify. Reply** (Tx) from the BICC Network. Context (Cx) is indicated. + +Figure 6.7.2.2: DTMF interworking: SIP-I to BICC, implicit duration (message sequence chart). + +Figure 6.7.2.2: DTMF interworking: SIP-I to BICC, implicit duration (message sequence chart) + +If RTP Telephony Event has not been selected on 3GPP SIP-I CS CN interface and OoB DTMF is required in the BICC network the IWU shall request inband DTMF detection as described in clause 14.4.2.1 of TS 23.205 [9], i.e. the RTP Telephony Event is not configured. The same principles apply for signalling implicit or explicit DTMF digits. + +### 6.7.3 DTMF transfer from BICC network (Out-of-Band DTMF) to SIP-I on Nc + +If RTP Telephony Event has been selected for the 3GPP SIP-I CS CN and OoB DTMF transmission is selected in the succeeding BICC network the IWU shall use the "Send DTMF" procedure and may use the "Stop DTMF" procedures to request the MGW to play out DTMF to the IM CN subsystem whenever it receives out-of-band DTMF indications from the BICC network. + +The UP-IWU (MGW) shall signal the RTP Telephony event(s) in accordance with clause 14.4.4 of TS 23.231 [3]. + +If implicit DTMF timing is deployed (as shown in example message sequence chart in figure 6.7.3.1) and the MGW has already completed the digit transmission it shall not take any action upon the reception of the Stop DTMF procedure. + +![Sequence diagram for DTMF Interworking: BICC to SIP-I, implicit duration. The diagram shows three lifelines: (G)MSC-S (BICC), (G)MSC-S (SIP-I), and MGW. The interaction starts with the BICC (G)MSC-S sending a 'BICC Start DTMF (Digit)' message to the SIP-I (G)MSC-S, which includes a 'Context (Cx)'. The SIP-I (G)MSC-S then sends a 'MOD. Request [RTP Tel Event, signal = Digit] (Tx)' to the MGW. The MGW responds with 'Send DTMF Digit via RTP Tel Event, E=0'. The SIP-I (G)MSC-S receives a 'MOD. Reply (Tx)' from the MGW and sends a 'Context (Cx)' back to the BICC (G)MSC-S. Next, the BICC (G)MSC-S sends a 'Stop DTMF (Digit)' message to the SIP-I (G)MSC-S, which includes a 'Context (Cx)'. The SIP-I (G)MSC-S sends a 'MOD. Request [RTP Tel Event, stop signal = Digit] (Tx)' to the MGW. The MGW responds with 'Stop DTMF Digit via RTP Tel Event, E=1'. The SIP-I (G)MSC-S receives a 'MOD. Reply (Tx)' from the MGW and sends a 'Context (Cx)' back to the BICC (G)MSC-S. The diagram is numbered 1 and 2 in circles.](32ff77da4286b58c4778033acaa10836_img.jpg) + +Sequence diagram for DTMF Interworking: BICC to SIP-I, implicit duration. The diagram shows three lifelines: (G)MSC-S (BICC), (G)MSC-S (SIP-I), and MGW. The interaction starts with the BICC (G)MSC-S sending a 'BICC Start DTMF (Digit)' message to the SIP-I (G)MSC-S, which includes a 'Context (Cx)'. The SIP-I (G)MSC-S then sends a 'MOD. Request [RTP Tel Event, signal = Digit] (Tx)' to the MGW. The MGW responds with 'Send DTMF Digit via RTP Tel Event, E=0'. The SIP-I (G)MSC-S receives a 'MOD. Reply (Tx)' from the MGW and sends a 'Context (Cx)' back to the BICC (G)MSC-S. Next, the BICC (G)MSC-S sends a 'Stop DTMF (Digit)' message to the SIP-I (G)MSC-S, which includes a 'Context (Cx)'. The SIP-I (G)MSC-S sends a 'MOD. Request [RTP Tel Event, stop signal = Digit] (Tx)' to the MGW. The MGW responds with 'Stop DTMF Digit via RTP Tel Event, E=1'. The SIP-I (G)MSC-S receives a 'MOD. Reply (Tx)' from the MGW and sends a 'Context (Cx)' back to the BICC (G)MSC-S. The diagram is numbered 1 and 2 in circles. + +Figure 6.7.3.1: DTMF Interworking: BICC to SIP-I, implicit duration (message sequence chart) + +## 6.7.4 SIP-I on Nc interworking with BICC for Inband DTMF + +The interworking between inband and out-of-band transport shall be performed according to clause 14.4.8 in TS 23.231 [3], if required. + +If the RTP Telephony event has not been negotiated within the SIP-I based CS CN, the interworking MSC towards a BICC network with inband DTMF transport shall not configure the RTP Telephony event at the attached MGW. The MGW will then transfer DTMF within the speech codec without detecting it. + +## 6.8 User Plane Interworking + +### 6.8.1 General + +This clause describes user plane issues including interworking of DTMF. + +### 6.8.2 DTMF Interworking + +If RTP Telephony Event is selected for the internal 3GPP CS CN connection and inband DTMF is selected for the BICC network the MGW shall filter out (delete) the DTMF from the default PCM codec when relaying the DTMF via the RTP Telephony Event to prevent potential double signalling of the same digit if a later insertion back to inband PCM transmission were to occur. + +## 6.9 Example Call flows + +See clause 5.7. + +# 7 Interworking between a SIP-I based circuit-switched core network and the IP Multimedia (IM) Core Network (CN) Subsystem + +## 7.1 Reference Model + +### 7.1.1 General + +Figure 7.1.1.1 details the reference model required to support interworking between the 3GPP IM CN subsystem, as specified in 3GPP TS 23.228 [11] and 3GPP TS 24.229 [12] and a SIP-I based circuit-switched core network, as specified in 3GPP TS 23.231 [3] and 3GPP TS 29.231 [4]. + +![Figure 7.1.1.1: IM CN subsystem to CS network logical interworking reference model. The diagram shows the logical interworking between the IM CN subsystem and the CS network. At the top, BGCF and CSCF are connected to MGCF via control plane interfaces Mj and Mg respectively. MGCF is connected to IM-MGW via a control plane interface Mn. IM-MGW is connected to a network entity (Note 1) via a user plane interface Mb and to the CS network via a user plane interface Nb. A legend indicates that solid lines represent the User Plane and dotted lines represent the Control Plane.](8e80de0cac529b2c3775d677c5203133_img.jpg) + +Figure 7.1.1.1: IM CN subsystem to CS network logical interworking reference model. The diagram shows the logical interworking between the IM CN subsystem and the CS network. At the top, BGCF and CSCF are connected to MGCF via control plane interfaces Mj and Mg respectively. MGCF is connected to IM-MGW via a control plane interface Mn. IM-MGW is connected to a network entity (Note 1) via a user plane interface Mb and to the CS network via a user plane interface Nb. A legend indicates that solid lines represent the User Plane and dotted lines represent the Control Plane. + +NOTE 1: The IM-MGW may be connected via the Mb to various network entities, such as a UE (via a GTP Tunnel to a GGSN), an MRFP, a TrGW or an AGW. + +**Figure 7.1.1.1: IM CN subsystem to CS network logical interworking reference model** + +**Nb reference point:** The Nb reference point is defined in accordance with 3GPP TS 29.414 [43]. + +**Nc reference point:** The Nc reference point is defined in accordance with 3GPP TS 29.231 [4]. + +**Mg reference point:** The Mg reference point is defined in accordance with 3GPP TS 24.229 [12]. + +**Mj reference point:** The Mj reference point is defined in accordance with 3GPP TS 24.229 [12]. + +**Mb reference point:** The Mb reference point is defined in accordance with 3GPP TS 23.002 [2]. + +**Mn reference point:** The Mn reference point is defined in accordance with 3GPP TS 29.332 [54]. + +## 7.1.2 Signalling interactions between network entities in the control plane + +The control plane between the IM CN Subsystem supporting SIP and a 3GPP CS network supporting a SIP-I based Nc interface is as shown in figure 7.1.2. + +![Figure 7.1.2.1: Control plane interworking protocol stack between the IM CN subsystem and a 3GPP CS network supporting SIP-I based Nc interface. The diagram shows the protocol stack for signalling. On the left, the 3GPP IMS DOMAIN contains a SIP signalling function with layers SIP, TCP/UDP/SCTP, and IP. On the right, the 3GPP CS DOMAIN contains a SIP-I signalling function with layers SIP-I, SCTP, and IP. In the center, the MGCF acts as a protocol converter with layers SIP, TCP/UDP/SCTP, and IP on the IMS side, and SIP-I, SCTP, and IP on the CS side. Arrows indicate the flow of signalling: IMS-SIP between the IMS SIP function and the MGCF SIP layer, and SIP-I/Nc between the MGCF SIP-I layer and the CS SIP-I function. IP layers are connected across all domains.](08e8bbb2a063a3935a0c649b39ade125_img.jpg) + +Figure 7.1.2.1: Control plane interworking protocol stack between the IM CN subsystem and a 3GPP CS network supporting SIP-I based Nc interface. The diagram shows the protocol stack for signalling. On the left, the 3GPP IMS DOMAIN contains a SIP signalling function with layers SIP, TCP/UDP/SCTP, and IP. On the right, the 3GPP CS DOMAIN contains a SIP-I signalling function with layers SIP-I, SCTP, and IP. In the center, the MGCF acts as a protocol converter with layers SIP, TCP/UDP/SCTP, and IP on the IMS side, and SIP-I, SCTP, and IP on the CS side. Arrows indicate the flow of signalling: IMS-SIP between the IMS SIP function and the MGCF SIP layer, and SIP-I/Nc between the MGCF SIP-I layer and the CS SIP-I function. IP layers are connected across all domains. + +**Figure 7.1.2.1: Control plane interworking protocol stack between the IM CN subsystem and a 3GPP CS network supporting SIP-I based Nc interface** + +Signalling between the SIP signalling function and the MGCF uses the services of IP (RFC 2460 [17]), and transport protocol such as TCP (RFC 793 [16]) or UDP (RFC 768 [15]) or SCTP (RFC 4960 [18]) (see TS 24.229 [12]), and SIP. + +Signalling between the SIP-I signalling function and the MGCF uses the services of IP (IETF RFC 791 [14] or IETF RFC 2460 [17]), SCTP (IETF RFC 4960 [18]) and SIP-I. + +## 7.2 Signalling Interworking of a Call from the IP Multimedia Subsystem towards the SIP-I based circuit-switched core network + +### 7.2.1 General + +If not otherwise stated within this clause the MGCF shall follow the below listed procedures for interworking incoming SIP calls: + +Sending SIP messages to the succeeding SIP-I based circuit-switched core network: + +- When an incoming SIP message is received from the preceding IMS node then the MGCF shall send this SIP message to the succeeding SIP-I based circuit-switched core network unless otherwise specified in the clauses below. +- The MGCF shall only send SIP methods, SIP headers, SDP body contents and other bodies as permitted by the profile for SIP-I on Nc as defined in TS 29.231 [4]. +- The MGCF shall, if defined by TS 29.163 [13], generate an ISUP message following TS 29.163 [13] and include this ISUP message into the SIP message in a MIME body according to IETF RFC 3204 [19]. The Content-Type header field and the Content-Disposition header field shall be set as specified in clause 5.4.1.2 of ITU-T Recommendation Q.1912.5 [6]. + +Sending SIP messages to the preceding IMS node: + +- When the MGCF receives a SIP-I message from the succeeding SIP-I based circuit-switched core network then the MGCF shall send this message to the preceding IMS node unless otherwise specified in the clauses below. +- The MGCF shall only send SIP methods, SIP headers, SDP body contents and other bodies which are permitted by the IMS profile as defined in TS 24.229 [12]. +- The MGCF shall construct IMS specific headers and bodies according to the procedures defined in TS 29.163 [13]. + +### 7.2.2 Exceptions from forwarding received SIP messages + +If call clearing is initiated either from the preceding IMS network or from the succeeding SIP-I based circuit switched core network then the MGCF shall apply the call clearing procedures as defined within TS 23.231 [3] clause 7.3.1. + +When a BYE request, 4xx, 5xx or 6xx final response to an initial INVITE request is received from the succeeding SIP-I based circuit switched core network and if a Reason Header field was not received and encapsulated ISUP REL message is included, then the ISUP Cause value received in the encapsulated ISUP REL message shall be mapped into SIP Reason header fields as specified in TS 29.163 [13]. If SIP message did not contain neither a Reason header nor encapsulated ISUP REL message, then a 4xx, 5xx, or 6xx final response shall be mapped to an ISUP cause value as specified in TS 29.163 [13] table 18 or BYE request shall be mapped to cause value 16; this cause value shall be mapped into the SIP Reason header fields as specified in TS 29.163 [13]. + +When a SIP failure response to an initial INVITE request is to be sent to the preceding IMS node, the cause value contained in the Reason header to be sent shall be used to determine the SIP failure response code as specified in TS 29.163 [13] table 9. + +If different SIP methods are used within the SIP-I based circuit switched core network and within the IMS network for basic call signalling or supplementary service signalling, then the MGCF shall map the received SIP message into the appropriate SIP message of the network the message is sent to. + +If the interworking procedures within TS 29.163 [13] do not result in any mapping then the MGCF shall not send the SIP message, which is received either from the SIP-I based circuit switched core network or from the IMS network, towards the other side. + +If the MGCF supports overlap signalling from the preceding IMS node and the first incoming SIP INVITE request does not provide a complete number, then the MGCF shall not forward this first SIP INVITE request and additional SIP INVITE requests or SIP INFO requests, which are used by the MGCF to collect all digits required to identify the called subscriber. + +The MGCF shall generate 100 Trying provisional SIP responses to acknowledge the receipt of INVITE requests. The MGCF shall not forward received 100 Trying provisional SIP responses. + +### 7.2.3 Sending SIP INVITE request + +The MGCF may reject receipt of SIP INVITE without SDP offer. Otherwise the MGCF shall construct an SDP offer with contents according to local policy, e.g. SDP for a G.711 speech call, in accordance with the built encapsulated IAM message. In the constructed SDP offer the MGCF shall encode preconditions as not met. + +NOTE 1: A SIP-I INVITE always includes an SDP offer within the CS CN. + +The MGCF shall forward the SIP INVITE request with the SDP offer and encapsulate an IAM message after the reception of the SIP INVITE request irrespective of the status of local and remote preconditions: + +When the incoming SIP INVITE request indicates that remote preconditions are not met or when local preconditions are not met then the MGCF shall include the tag "precondition" in the SUPPORTED header and shall encode preconditions in the SDP offer that the related local preconditions for QoS are not met. + +If the incoming SIP INVITE request indicates that remote preconditions are met, or if the incoming SIP INVITE request does not contain a precondition tag, and if local preconditions are met then the MGCF may either not include the tag "precondition" and exclude appropriate SDP lines, or include the tag "preconditions" in the SUPPORTED header and provide an SDP offer indicating that preconditions are met. + +NOTE 2: The use of SUPPORTED header is a deviation from IETF RFC 3312 [23] when the strength-tag contains a "mandatory" value. + +NOTE 3: The setting of the "Continuity Check Indicator" in the "Nature of Connection Indicators" parameter within the encapsulated IAM is of no significance. The value is ignored by the succeeding node of the SIP-I based circuit-switched core network. + +The MGCF shall not use the MGW bypass option, because some functions will not work as the succeeding SIP-I node does not know that it is interworking any IMS function. For example an incoming multimedia call from IMS does not result in a CS multimedia telephony service on the SIP-I based circuit switched core network. + +If the incoming SIP INVITE request does not provide a complete number, then the MGCF shall defer sending the SIP INVITE request until the MGCF has collected all digits required to identify the called subscriber. The additional digits may either, as a network option, be received in in-dialog SIP INFO requests or in additional SIP INVITE requests with the same Call-ID and From tag as a previous SIP INVITE. The MGCF shall apply the signalling procedures on the IMS side as specified in TS 29.163 [13]. + +### 7.2.4 Updating Precondition Information + +If the MGCF previously indicated to the succeeding SIP-I based circuit-switched core network that preconditions were not met, the MGCF shall send to the succeeding SIP-I based circuit-switched core network appropriate SDP lines indicating that local preconditions are met + +- when the MGCF receives from the preceding IMS network SDP indication that preconditions are met and local preconditions are met, +- or when remote preconditions at the preceding IMS network were already met and local precondition status of the MGCF changes to be met. + +NOTE: ISUP COT is not supported within SIP-I on Nc and therefore the ISUP COT message shall not be included into the SIP message. + +### 7.2.5 SDP Codec Negotiation + +When sending an SDP offer/answer to negotiate codecs with the succeeding SIP-I based circuit-switched core network the MGCF shall follow the procedures defined for a 3GPP Intermediate Node in clause 9 of TS 23.153 [5]. + +When sending an SDP offer/answer to negotiate codecs with the preceding IMS network the MGCF shall send codec information in accordance to TS 24.229 [12]. + +NOTE 1: Which codecs are negotiable with the IMS network may depend on operator choices and preferences (local policy). + +## 7.2.6 MGW Selection + +If the MGCF supports either the optional "Optimised MGW Selection" or the optional "Deferred MGW Selection" then the MGCF may include the SDP MGW Identifier into the SIP message being sent to the succeeding SIP-I based circuit switched core network in accordance to clause 4.4 of TS 23.231 [3]. + +Otherwise the MGCF shall seize a MGW and shall include the MGW connection address into the SDP offer of the initial SIP INVITE request it will send to the succeeding 3GPP SIP-I based circuit switched core network node. + +## 7.2.7 Autonomous Release + +For interworking towards the preceding IMS node the MGCF shall use the procedure as defined in TS 29.163 [13]. + +For call clearing towards the succeeding SIP-I based circuit switched core network the MGCF shall use the procedures as defined within TS 23.231 [3] clause 7.3. + +## 7.2.8 Further setting of SIP header values + +The MGCF shall act as a B2BUA as defined in IETF RFC 3261 [20]. The MGCF shall terminate the incoming SIP session and the MGCF shall originate an outgoing SIP-I call towards the SIP-I based circuit switched core network. Therefore the MGCF shall generate the SIP headers and values of Cseq, Call-ID, Via, Record-Route, Route and Contact independently from the received SIP message. For the generation of the Request-URI of an initial INVITE request and header fields To, From, Max-Forwards, and P-Asserted-Identity the MGCF shall use the information received from the preceding IMS node and perform the procedures specified below. + +The Request-URI of in-dialogue SIP requests will be populated with information received within the Contact header of previous responses according to SIP procedures. When sending a request towards the SIP-I based circuit switched core network the MGCF shall generate a From tag independent of the value received from the IMS. Furthermore, when sending a response towards the IMS, the MGCF shall generate a To tag independent of the value received from the SIP-I based circuit switched core network. + +The procedures for population of the Request-URI and header fields To, From, Max-Forwards, and P-Asserted-Identity are based on the mapping procedures specified in TS 29.163 [13]. The text in TS 29.163 [13] is to be understood as follows: + +- Where ISUP called party number is mentioned, this shall be understood as internal ISUP called party number. +- Where ISUP calling party number is mentioned, this shall be understood as internal ISUP calling party number. +- Where ISUP Generic Number (additional calling party number) is mentioned, this shall be understood as internal Generic Number (additional calling party number). +- Where ISUP Hop Counter parameter is mentioned, this shall be understood as internal ISUP Hop Counter parameter. + +NOTE: Only the userinfo component of the received SIP URI is used by mapping procedures according to TS 29.163 [13] while the received host part is ignored and a new value is generated by the MGCF. + +When sending an initial INVITE request towards the SIP-I based circuit switched core network the MGCF shall perform the following actions to generate the Request-URI and the To header field: + +- Create an internal ISUP called party number from the received Request URI according to TS 29.163 [13]. When Number Portability is supported the MGCF shall follow the procedures specified in clause 7.2.3.1.2A of TS 29.163 [13]. Otherwise the ISUP called party number is generated as specified in clause 7.2.3.1.2.1 of TS 29.163 [13]. +- Generate the new Request-URI and the new To header field from the internal ISUP called party number according to TS 29.163 [13]. +When Number Portability is supported the MGCF shall follow the procedures specified in clause 7.2.3.2.2A of TS 29.163 [13]. Otherwise the Request-URI and the To header field are generated as specified in clause 7.2.3.2.2.1 of TS 29.163 [13]. + +When sending an initial INVITE request towards the SIP-I based circuit switched core network the MGCF shall perform the following actions to generate the P-Asserted-Identity and the From header fields: + +- create an internal ISUP calling party number and an internal Generic Number (additional calling party number) as specified in clauses 7.2.3.1.2.6 and 7.2.3.1.2.7 of TS 29.163 [13]; and +- generate the new P-Asserted-Identity and the From header from the internal ISUP calling party number and the internal Generic Number (additional calling party number) as specified in clause 7.2.3.2.2.3 of TS 29.163 [13]. + +When sending the initial SIP INVITE request to the SIP-I based circuit-switched core network and if the Hop Counter procedure is supported in the SIP-I based circuit switched core network (national option), then the MGCF shall perform the following actions: + +- create an internal ISUP Hop Counter parameter from the received Max-Forwards value according to clause 7.2.3.1.2.9 of TS 29.163 [13]; and +- either generate the new Max-Forwards value from the internal ISUP Hop Counter parameter by applying the rules in clause 7.2.3.2.2.4 of TS 29.163 [13] and decrementing the resulting value by one or forward the received Max-Forwards value decremented by one. + +Otherwise if the MGCF forwards SIP request, it shall either set the Max-Forwards header to a default value or forward the received Max-Forwards value decremented by one. + +When receiving any SIP request with a Max-Forwards field value of zero, and if request shall be propagated to the other side, the MGCF shall reject the request with a 483 (Too Many Hops) SIP final response, in accordance with IETF RFC 3261 [20]. + +## 7.3 Signalling Interworking of a Call from SIP-I based circuit-switched core network towards the IP Multimedia Subsystem + +### 7.3.1 General + +If not otherwise stated within this clause the MGCF shall follow the below listed procedures for interworking outgoing SIP calls: + +Sending SIP messages to the succeeding IMS node: + +- When the MGCF receives a SIP-I message from the preceding SIP-I based circuit-switched core network then the MGCF shall send this message to the succeeding IMS network unless otherwise specified in the clauses below. +- The MGCF shall only send SIP methods, SIP headers, SDP body contents and other bodies which are permitted by the IMS profile as defined in TS 24.229 [12]. +- The MGCF shall construct IMS specific headers and bodies according to the procedures defined in TS 29.163 [13]. + +NOTE 1: This implies that if the incoming SIP-I message contained an encapsulated ISUP message then the ISUP message is removed from the forwarded SIP message. But the ISUP information may be mapped into a PSTN XML body, if supported as a network option. + +- Within IMS the initial INVITE request may be routed to a forking proxy. The MGCF shall be ready to receive responses generated due to a forked request and behave according to the procedures specified in IETF RFC 3261 [20] and clause 7.3.9 of the present specification. + +NOTE 2: The multiple early dialogues are not propagated to the preceding SIP-I based circuit-switched core network. + +NOTE 3: The MGCF does not, itself, perform forking. + +Sending SIP messages to the preceding SIP-I based circuit switched core network: + +- When the MGCF receives a SIP message from the succeeding IMS node then the MGCF shall send this SIP message to the preceding SIP-I based circuit-switched core network unless otherwise specified in the clauses below. + +- The MGCF shall only send SIP methods, SIP headers, SDP body contents and other bodies as permitted by the profile for SIP-I on Nc as defined in TS 29.231 [4]. +- The MGCF shall, if defined by TS 29.163 [13], construct an ISUP message following TS 29.163 [13] and include this ISUP message into the SIP message in a MIME body according to IETF RFC 3204 [19]. The Content-Type header field and the Content-Disposition header field shall be set as specified in clause 5.4.1.2 of ITU-T Recommendation Q.19.12.5 [6]. +- When sending an encapsulated ISUP ACM message or ISUP CPG message the MGCF shall follow the procedures defined within TS 29.163 [13] for the handling of the ring tone and therefore may request the IM-MGW to send ring tone in the backwards direction. + +### 7.3.2 Exceptions from forwarding received SIP messages + +If call clearing is initiated either from the succeeding IMS node or from the preceding SIP-I based circuit switched core network then the MGCF shall apply the call clearing procedures as defined within TS 23.231 [3] clause 7.3.1. + +When a BYE request is sent to the succeeding IMS node and if a Reason Header field was not received, then the received ISUP Cause value being received in the encapsulated ISUP REL message shall be mapped into SIP Reason header fields as defined by TS 29.163 [13]. + +When a BYE request, 4xx, 5xx or 6xx final response to an initial INVITE request is received from the succeeding IMS Node and the SIP message did not contain a Reason header, then a 4xx, 5xx, or 6xx final response shall be mapped to an ISUP cause value as specified in TS 29.163 [13] table 18 or BYE shall be mapped to cause value 16; this cause value shall be included in the encapsulated ISUP REL messages as specified in TS 29.163 [13]. + +When a SIP failure response to an initial INVITE request is to be sent to the preceding SIP-I node, the cause value contained in the encapsulated ISUP REL message to be sent shall be used to determine the SIP failure response code as specified in TS 29.163 [13] table 9. + +If different SIP methods are used within the SIP-I based circuit switched core network and within the IMS network for basic call signalling or supplementary service signalling, then the MGCF shall map the received SIP message into the appropriate SIP message of the network the message is sent to. + +The MGCF shall modify the SDP it forwards to include local address information from the IM-MGW and to adjust the codec information if the IM-MGW is configured to transcode. + +The MGCF shall not forward the received 100 Trying provisional SIP responses, and shall generate 100 Trying provisional SIP responses to acknowledge the receipt of INVITE requests. + +If the MGCF defers sending an INVITE request until preconditions are met (see clause 7.6.3.1), the MGCF shall reply to the INVITE request from the SIP-I based CS CN with a 183 Session Progress provisional response and shall not forward the subsequent PRACK and UPDATE requests from the SIP-I based CS CN, but reply with a final response to the received request. When the MGCF then receives from the preceding SIP-I based circuit-switched core network an SDP indication that preconditions are met and local preconditions are met, the MGCF shall forward to the succeeding IMS node the previously received INVITE request with appropriate SDP lines indicating that local preconditions are met. If MGCF then receives a 183 Session Progress provisional response, it shall either: + +- not forward this provisional response and acknowledge the receipt with a PRACK request toward the IMS; or +- if defined by TS 29.163 [13], construct an ISUP message and include this ISUP message into the 183 Session Progress provisional response in a MIME body and remove the SDP answer from the 183 Session Progress provisional response and forward it toward the SIP-I based CS CN. + +### 7.3.3 Sending SIP INVITE request + +When the MGCF receives an incoming SIP INVITE request the MGCF shall ignore the value of the Continuity Check indicator in the Nature of Connection Indicators parameter in the included IAM. If the incoming SIP INVITE request indicates that remote preconditions are not met or when local preconditions are not met then the MGCF should defer sending the INVITE request until remote and local preconditions are met. + +NOTE: This recommendation follows TS 29.163 [13] to avoid clipping and other obstacles, when the receiving IMS terminal does not support SIP preconditions and the SIP UPDATE method. + +As an option, instead of following the above procedure, the MGCF may include the tag "precondition" in the SUPPORTED header and encode preconditions in the SDP offer that the related local preconditions for QoS are not met. + +### 7.3.4 Updating Precondition Information + +If the MGCF previously indicated to the succeeding IMS node that preconditions were not met and a provisional response from the succeeding node indicated support for preconditions, then the MGCF shall send to the succeeding IMS node appropriate SDP lines indicating that local preconditions are met + +- when the MGCF receives from the preceding SIP-I based circuit-switched core network an SDP indication that preconditions are met and local preconditions are met, +- or when remote preconditions at the preceding SIP-I based circuit-switched core network were already met and local precondition status of the MGCF changes to be met. + +For each early SIP dialogue for which a provisional response has been received from the succeeding node indicating support for preconditions the MGCF, using an UPDATE or a PRACK request, shall send a confirmation that all the required preconditions have been met. This applies regardless of whether the early SIP dialogue existed prior to the preconditions being met or is subsequently created. The MGCF shall not interwork more than one 200 OK response to an UPDATE request sent in multiple early dialogues, and should select the 200 OK response for the early dialogue for which the resources at the IM-MGW are configured (see clause 7.3.9.2) for interworking. + +A 580 Precondition Failure response might be received from the succeeding IMS node as a response either to the INVITE request, to the UPDATE request or to the PRACK request. All early dialogues are considered terminated upon reception of the 580 Precondition Failure response to the INVITE request. The MGCF shall release the call in accordance with TS 29.163 [13], which also defines the coding of the REL message with Cause Code '127 Interworking' to be sent to the SIP-I based circuit-switched core network. The MGCF shall encapsulate the REL message into the 500 Server Internal Error response and send it to the SIP-I based circuit-switched 3GPP core network. + +Upon reception of the 580 Precondition Failure response to the UPDATE or to the PRACK request within early dialogue MGCF shall immediately send a BYE request to terminate this early dialogue. Only if there is no more early dialogues, the MGCF shall encapsulate the REL message with Cause Code '127 Interworking' into the 500 Server Internal Error response and send it to the SIP-I based circuit-switched 3GPP core network. + +### 7.3.5 Receipt of SIP redirect (3xx) response + +When receiving a SIP response with a response code 3xx, the default behaviour of the MGCF is to release the call, where the MGCF sends to the preceding SIP-I based circuit-switched core network 480 Temporarily unavailable and encapsulate an ISUP REL message with a cause code value 127 (Interworking unspecified). + +NOTE 1: The MGCF may also decide for example to redirect the call towards the URIs in the Contact header field of the response as an operator option, but such handling is outside of the scope of the present document. + +NOTE 2: Above default behaviour and Note 1 is adopted from TS 29.163 [13]. + +### 7.3.6 SDP Codec Negotiation + +When sending an SDP offer/answer to negotiate codecs with the succeeding IMS network the MGCF shall send codec information in accordance with TS 24.229 [12]. + +When sending an SDP offer/answer to negotiate codecs with the preceding SIP-I based circuit-switched core network the MGCF shall follow the procedures defined for a 3GPP Intermediate Node in clause 9 of TS 23.153 [5]. + +NOTE: Which codecs are negotiable with the IMS network may depend on operator choices and preferences (local policy). + +If the MGCF received an SDP answer without the OoBTC Indicator and multiple codecs from the IMS, and initiates a second offer toward the IMS in accordance with the procedures for a 3GPP Intermediate Node in clause 9 of TS 23.153 [5], the MGCF shall: + +- if it added the SDP offer to a SIP message received from the SIP-I based CS CN (e.g. a PRACK), remove the SDP answer from the corresponding response before sending it to the SIP-I based CS CN; and + +- if it created a new SIP message (e.g. UPDATE or re-INVITE) to send the SDP offer to the IMS, not forward the SIP message with the SDP answer (e.g. a 200 OK) to the SIP-I based CS CN. + +If the MGCF receives from the IMS due to forking for one SDP offer multiple SDP answers in provisional SIP responses of different early dialogues, the MGCF shall only interwork the first SDP answer and the MGCF shall not include any SDP answers in any subsequent SIP early responses it decides to forward. + +If the MGCF sends an SDP offer within multiple UPDATE requests for different early dialogues towards the IMS side, it will receive an SDP answer in the response to each UPDATE request and the MGCF shall not interwork more than one 200 OK response to an UPDATE request sent in multiple early dialogues, and should select the 200 OK response for the early dialogue for which the resources at the IM-MGW are configured (see clause 7.3.9.2) for interworking. + +### 7.3.7 MGW Selection + +If the MGCF supports either the optional "Optimised MGW Selection" or the optional "Deferred MGW Selection" then the MGCF shall not send a SDP MGW Identifier towards the succeeding IMS network. The MGCF shall seize an IM-MGW and shall then include the connection address in the SDP offer of the initial SIP INVITE request it will send to the succeeding IMS node. + +If the MGCF supports the optional "deferred MGW selection" procedure and receives an unspecified connection address in the SDP offer contained in the SIP INVITE request, it should include an MGW\_Identifier for the IM-MGW it selects in the corresponding answer. The encoding of the MGW\_Identifier is defined in TS 29.231 [4]. + +The MGCF shall not use the "MGW bypass" option. + +### 7.3.8 Autonomous Release + +For interworking towards the succeeding IMS node the MGCF shall use the procedure as defined in TS 29.163 [13]. + +For call clearing towards the preceding SIP-I based circuit switched core network the MGCF shall use the procedures as defined within TS 23.231 [3] clause 7.3 for call clearing towards the originating side. + +### 7.3.9 Handling of forked SIP Responses + +#### 7.3.9.1 SIP Dialogues + +The MGCF shall inspect the tag in the 'To' header field of a non-100 provisional and a 2xx final responses in accordance to SIP procedures specified in IETF RFC 3261 [20] to identify the SIP dialogue the response belongs to. If responses belonging to different dialogues are received, the initial INVITE request has been forked. + +#### 7.3.9.2 Reception of non-100 provisional Responses to initial INVITE + +Since the MGCF does not know that forking has occurred until a second non-100 provisional response creating a new early dialogue arrives the MGCF shall request the bearer resources as required by the first received SDP answer. + +For each subsequent non-100 provisional response within a new early dialogue that is received, the MGCF shall apply the following procedures: + +- Depending on the requirements in the SDP answer and the presence of P-Early-Media header the MGCF may either refrain from reconfiguring the IM-MGW, or it may use the Configure IMS Resources procedure. +- The MGCF shall construct an ISUP message in accordance to TS 29.163 [13], and send it within the SIP message to the SIP-I based circuit-switched 3GPP core network. The MGCF shall use only one SIP dialogue within the SIP-I based circuit-switched 3GPP core network, and the MGCF shall thus supply the same 'To' header field in all SIP responses relating to a call it sends towards the SIP-I based circuit-switched 3GPP core network. +- However, the MGCF may refrain from sending additional subsequent non-100 provisional response to the SIP-I based CS CN if they do not contain any new information compared to the last previous non-100 provisional response it sent towards the SIP-I based CS CN. +- If the MGCF already received an SDP answer in a previous non-100 provisional response within another early dialogue (and thus forwarded the SDP answer), the MGCF shall not include the SDP answers in any subsequent non-100 provisional response it decides to send towards the SIP-I based CS CN. + +- The MGCF shall send a PRACK request to the IMS to acknowledge the receipt of the subsequent non-100 provisional response. The MGCF will receive a response to the PRACK and shall not forward this response to the SIP-I based CS CN. +- If multiple codecs were contained in the provisional response, the MGCF shall include an SDP offer with the codec configured at the IM-MGW within the PRACK request. + +### 7.3.9.3 Reception of final Responses to initial INVITE + +Upon reception of a non-2xx final response to initial INVITE all early dialogues are considered terminated. The MGCF shall acknowledge it with an ACK request. In addition the MGCF shall create an encapsulated REL message as described in TS 29.163 [13] and shall send it within a non-2xx final response (initial INVITE) to the SIP-I based circuit-switched 3GPP core network. + +When a first 2xx final response is received for one of the early dialogues or when a received 2xx final response to an INVITE creates a new dialogue, the MGCF shall acknowledge it with the ACK request. If the remote IMS resources configured at the IM-MGW do not match the remote resources selected for the confirmed dialogue MGCF shall require updating the allocated resources. In addition the MGCF shall create an encapsulated ANM or CON message as described in TS 29.163 [13] and shall send it within a final 200 OK response to the initial INVITE to the SIP-I based circuit-switched 3GPP core network. If the previously negotiated codecs in the SIP-I based CS CN differ from the remote resources selected for the confirmed dialogue, to avoid transcoding the MGCF should construct a new SDP offer based upon those remote resources and send it to the SIP-I based CS CN within an UPDATE or re-INVITE request. + +Upon the reception of a subsequent final 2xx response for any further dialogue for an INVITE request due to forking, the MGCF shall: + +- 1) acknowledge the response with the ACK request; and +- 2) send a BYE request to this dialogue in order to terminate it. + +The INVITE transaction is completed 64\*T1 seconds after the reception of the first 2xx response. At this point the MGCF shall terminate all early dialogs that have not been already transitioned to confirmed or terminated state. + +### 7.3.10 Further setting of SIP header values + +The MGCF shall act as a B2BUA as defined in IETF RFC 3261 [20]. The MGCF shall terminate the incoming SIP-I session and the MGCF shall originate an outgoing SIP session towards the succeeding IMS node. Therefore the MGCF shall generate the SIP headers and values of Cseq, Call-ID, Via, Record-Route, Route and Contact independently from the received SIP-I message. For the generation of the Request-URI of an initial INVITE requests and header fields To, From, Max-Forwards, and P-Asserted-Identity the MGCF shall use the information received from the SIP-I based circuit switched core network node and perform the procedures specified below. + +The Request-URI of in-dialogue SIP requests will be populated with information received within the Contact header of previous responses according to SIP procedures. When sending a request towards the IMS the MGCF shall generate a From tag independent of the value received from the SIP-I based circuit switched core network. Furthermore, when sending a response towards the SIP-I based circuit switched core network, the MGCF shall generate a To tag independent of the value received from the IMS. + +The procedures for population of the Request-URI and header fields To, From, Max-Forwards, and P-Asserted-Identity are based on the mapping procedures specified in TS 29.163 [13]. The text in TS 29.163 [13] is to be understood as follows: + +- Where ISUP called party number is mentioned, this shall be understood as internal ISUP called party number. +- Where ISUP calling party number is mentioned, this shall be understood as internal ISUP calling party number. +- Where ISUP Generic Number (additional calling party number) is mentioned, this shall be understood as internal ISUP Generic Number (additional calling party number). + +NOTE: Only the userinfo component of the received SIP URI is used by mapping procedures according to TS 29.163 [13] while the received host part is ignored and a new value is generated by the MGCF. + +When sending an initial INVITE request towards the IMS network the MGCF shall perform the following actions to generate the Request-URI and the To header field: + +- Create an internal ISUP called party number from the received Request URI according to TS 29.163 [13]. When Number Portability is supported the MGCF shall follow the procedures specified in clause 7.2.3.1.2A of TS 29.163 [13]. Otherwise the internal ISUP called party number is generated as specified in clause 7.2.3.1.2.1 of TS 29.163 [13]. +- Generate the new Request-URI and the new To header field from the internal ISUP called party number according to TS 29.163 [13]. When Number Portability is supported the MGCF shall follow the procedures specified in clause 7.2.3.2.2A of TS 29.163 [13]. Otherwise the Request-URI and the To header field are generated as specified in clause 7.2.3.2.2.1 of TS 29.163 [13]. + +When sending an initial INVITE request towards the IMS network the MGCF shall perform the following actions to generate the P-Asserted-Identity and the From header fields: + +- create an internal ISUP calling party number and an internal Generic Number (additional calling party number) as specified in clauses 7.2.3.1.2.6 and 7.2.3.1.2.7 of TS 29.163 [13]; and +- generate the new P-Asserted-Identity and the From header from the internal ISUP calling party number and the internal Generic Number (additional calling party number) as specified in clause 7.2.3.2.2.3 of TS 29.163 [13]. + +When sending the initial SIP INVITE request to the IMS network and if the Hop Counter procedure is supported in the SIP-I based circuit switched core network (national option), then the MGCF shall either generate the Max-Forwards value from the received ISUP Hop Counter parameter by applying the rules in clause 7.2.3.2.2.4 of TS 29.163 [13] and decrementing the resulting value by one or forward the received Max-Forwards value decremented by one. + +Otherwise if the MGCF forwards SIP request, it shall either set the Max-Forwards header to a default value or forward the received Max-Forwards value decremented by one. + +When receiving any SIP request with a Max-Forwards field value of zero, and if request shall be propagated to the other side, the MGCF shall reject the request with a 483 (Too Many Hops) SIP final response, in accordance with IETF RFC 3261 [20]. + +## 7.4 DMTF Signalling Interworking applicable for all Calls between an IP Multimedia CN Subsystem and a SIP-I based circuit-switched core network + +The procedures in clause 4.4 are applicable with modifications described in the present subclause. + +Where the external SIP-I network is mentioned in the procedures in clause 4.4, this shall be understood as IP Multimedia (IM) Core Network (CN) Subsystem. Where an "IWU" is mentioned in those procedures, this shall be understood as MGCF. + +The IMS need not include the PCM codec in SDP offers and answers it sends. + +However, it is assumed that the RTP Telephony Event will always be included in SDP offers and answers from the IMS. + +If an IWU receives an SDP offer from a preceding 3GPP SIP-I node without the RTP Telephony Event (only permitted if only default PCM codec offered) then it shall include the RTP Telephony Event in the subsequent offer to the IMS. + +Procedures in clause 4.4 related to receiving SDP offers or answers from the external network without the RTP Telephony Event do not apply for the interworking towards the IMS. + +## 7.5 User Plane Interworking + +### 7.5.1 General + +This clause describes user plane issues including interworking of DTMF. + +Figure 7.5.1.1 shows the user plane protocol stacks within the IP Multimedia Subsystem and the 3GPP SIP-I based circuit switched core network. + +![Diagram of user plane interworking between IMS and SIP-I based CS CN. The diagram shows a stack of protocols: Codec (e.g. NB-AMR), RTP, UDP, IP, and L2, L1. The IMS side connects via an Mb interface, and the SIP-I based CS CN side connects via an Nb interface. A 'Transcoding or Relaying' label with a double-headed arrow is above the protocol stack, indicating the function of the MGCF.](9e8ebf03cae78f4f81b697548c2d7250_img.jpg) + +The diagram illustrates the user plane interworking between an IMS (IP Multimedia Subsystem) and a SIP-I based CS CN (Circuit Switched Core Network). The IMS is represented by a grey oval on the left, connected via an Mb interface. The SIP-I based CS CN is represented by a grey oval on the right, connected via an Nb interface. Between them is a protocol stack table with five rows. Above the table, a label 'Transcoding or Relaying' with a double-headed arrow indicates the function of the MGCF (Media Gateway Control Function). + +| | | +|-----------------------|-----------------------| +| Codec,
e.g. NB-AMR | Codec,
e.g. NB-AMR | +| RTP | RTP | +| UDP | UDP | +| IP | IP | +| L2, L1 | L2, L1 | + +Diagram of user plane interworking between IMS and SIP-I based CS CN. The diagram shows a stack of protocols: Codec (e.g. NB-AMR), RTP, UDP, IP, and L2, L1. The IMS side connects via an Mb interface, and the SIP-I based CS CN side connects via an Nb interface. A 'Transcoding or Relaying' label with a double-headed arrow is above the protocol stack, indicating the function of the MGCF. + +**Figure 7.5.1.1: user plane interworking** + +If the same speech codec is used on both sides, no speech transcoding is required. + +## 7.5.2 DTMF Interworking + +The procedures in clause 4.5.2 are applicable, however where the external SIP-I network is mentioned in those procedures, this shall be understood as IP Multimedia (IM) Core Network (CN) Subsystem. Where an "IWU" is mentioned in those procedures, this shall be understood as MGCF. + +# 7.6 Example Call flows + +## 7.6.1 General + +In this clause call flows are shown as examples to demonstrate the signalling interworking of the MGCF. Within the message sequence charts some contents of the messages are shown in order to visualise some of the important interworking aspects, which were described in previous clauses of this document. It is to be noted that the intention is neither to show the complete content of the SIP messages nor to use the exact syntax of SIP and SDP messages as it is defined in the respective RFCs. It is also not the intention to show all alternative options that are possible for a certain call flow. + +## 7.6.2 Incoming Call flows + +The first call flow shows the signalling for a successful basic call establishment and the later call release. The second call flow depicts a failed call setup. + +### 7.6.2.1 Successful Call Establishment and Call Release + +Figure 7.6.2.1.1 shows the first part of the incoming call signalling until the called party is alerted and the MGCF is waiting for an answer message. + +Before the received SIP INVITE request is forwarded to SIP-I based circuit switched core network the MGCF removes the PSTN XML body (after content mapped into SIP-I message), replaces the received codec list by a 3GPP structured codec list, and encapsulates the ISUP IAM message, which the MGCF mapped from the received SIP INVITE request. + +The incoming side RTP bearer termination is not yet successfully reserved and configured and therefore local preconditions are not met. Thus the MGCF initiates precondition signalling when sending the INVITE request to the succeeding SIP-I based circuit-switched network. + +The MGCF and the succeeding node perform codec negotiation according to 3GPP rules as specified in TS 23.153 [5]. The MGCF answers to the preceding IMS node with a single selected codec. If possible, the selected codec is the same as received from the 3GPP node to avoid transcoding at the network border. + +With the 183 Progress the MGCF authorizes the preceding node to use early media. Therefore, it is not necessary to include the P-Early-Media header in the 180 Ringing response. + +![Sequence diagram for an incoming call (message sequence chart) showing interactions between IMS core node, MGCF, IM-MGW, and SIP-I based circuit-switched core network.](2cf3896394a2342a2b46c504ab9a8830_img.jpg) + +The sequence diagram illustrates the message flow for an incoming call. The participants are IMS core node (CSCF, BGCf, TrGW), MGCF, IM-MGW, and SIP-I based circuit-switched core network. The MGCF is connected to the IMS core node via the Mj/Mg interface, to the SIP-I network via the Nc interface, and to the IM-MGW via the Mn interface. + +``` + +sequenceDiagram + participant IMS as IMS core node (CSCF, BGCf, TrGW) + participant MGCF + participant IM-MGW + participant SIP as SIP-I based circuit-switched core network + + Note right of MGCF: remote preconditions are met; local preconditions are not met + IMS->>MGCF: INVITE [SDP, PSTN XML] +100rel, UPDATE, P-Early-Media, IMS codec list, PSTN XML + MGCF-->>IMS: 100 Trying + MGCF->>IM-MGW: Seize outgoing side RTP bearer terminations + MGCF->>SIP: INVITE [SDP, IAM] +100rel, UPDATE, precondition tag, 3gOoBTC, supported codec list, preconditions not met, IAM + IM-MGW-->>MGCF: 100 Trying + IM-MGW-->>MGCF: 183 Progress [SDP] +100rel, UPDATE, precondition tag, 3gOoBTC, selected codec, available codecs + MGCF->>IM-MGW: Seizure of ingoing side RTP bearer terminations, though-connection + Note right of MGCF: local preconditions are met, authorise early media + MGCF-->>IMS: 183 Progress [SDP] +100rel, UPDATE, P-Early-Media, selected codec + IMS->>MGCF: PRACK + MGCF-->>IMS: 200 OK (PRACK) + IMS->>MGCF: 180 Ringing + MGCF-->>IM-MGW: PRACK + IM-MGW-->>MGCF: 200 OK (PRACK) + MGCF-->>SIP: 180 Ringing [ACM] + MGCF->>SIP: PRACK + SIP-->>MGCF: 200 OK (PRACK) + +``` + +Key message details: + +- INVITE [SDP, PSTN XML]** from IMS to MGCF includes 100rel, UPDATE, P-Early-Media, IMS codec list, and PSTN XML. +- 100 Trying** is returned from MGCF to IMS. +- Seize outgoing side RTP bearer terminations** is a control message from MGCF to IM-MGW. +- INVITE [SDP, IAM]** from MGCF to SIP includes 100rel, UPDATE, precondition tag, 3gOoBTC, supported codec list, preconditions not met, and IAM. +- 100 Trying** is returned from IM-MGW to MGCF. +- 183 Progress [SDP]** from IM-MGW to MGCF includes 100rel, UPDATE, precondition tag, 3gOoBTC, selected codec, and available codecs. +- Seizure of ingoing side RTP bearer terminations, though-connection** is a control message from MGCF to IM-MGW. +- 183 Progress [SDP]** from MGCF to IMS includes 100rel, UPDATE, P-Early-Media, and selected codec. +- PRACK** is sent from IMS to MGCF. +- 200 OK (PRACK)** is returned from MGCF to IMS. +- 180 Ringing** is sent from IMS to MGCF. +- PRACK** is sent from MGCF to IM-MGW. +- 200 OK (PRACK)** is returned from IM-MGW to MGCF. +- 180 Ringing [ACM]** is sent from MGCF to SIP. +- PRACK** is sent from MGCF to SIP. +- 200 OK (PRACK)** is returned from SIP to MGCF. + +Sequence diagram for an incoming call (message sequence chart) showing interactions between IMS core node, MGCF, IM-MGW, and SIP-I based circuit-switched core network. + +**Figure 7.6.2.1.1: Incoming Call (message sequence chart), Called Party alerted** + +Figure 7.6.2.1.2 shows how the call setup is finalised and how the call is later released from the IMS side. + +![Sequence diagram for an incoming call. Lifelines: IMS core node (CSCF, BGCF, TrGW), MGCF, IM-MGW, and SIP-I based circuit-switched core network. The diagram shows the signaling flow for an incoming call, starting with a 200 OK (INVITE) and ending with a BYE and 200 OK (BYE) sequence. A box indicates that preceding signaling sequences are shown in Figure 7.6.2.1.1.](7ed5d5770331f31ade15439a21c31425_img.jpg) + +The diagram illustrates the message sequence for an incoming call. It features four lifelines: IMS core node (CSCF, BGCF, TrGW), MGCF, IM-MGW, and SIP-I based circuit-switched core network. The sequence begins with a 200 OK (INVITE) message from the MGCF to the IMS core node, followed by an ACK message from the IMS core node to the MGCF. Simultaneously, the MGCF sends a 200 OK (INVITE) [ANM] message to the SIP-I based circuit-switched core network, which is acknowledged by an ACK message. A box labeled "For preceding signalling sequences see Figure 7.6.2.1.1" indicates the start of the sequence. The "Active Session" phase is shown between the MGCF and the SIP-I based circuit-switched core network. The call is terminated with a BYE message from the MGCF to the IMS core node, followed by a 200 OK (BYE) message from the IMS core node to the MGCF. The MGCF also sends a BYE [REL] message to the SIP-I based circuit-switched core network, which is acknowledged by a 200 OK (BYE) [RLC] message. + +``` + +sequenceDiagram + participant IMS as IMS core node (CSCF, BGCF, TrGW) + participant MGCF + participant IM-MGW + participant SIP as SIP-I based circuit-switched core network + + Note right of MGCF: For preceding signalling sequences see Figure 7.6.2.1.1 + + Note over MGCF, SIP: Active Session + + MGCF->>IMS: 200 OK (INVITE) + IMS->>MGCF: ACK + MGCF->>SIP: 200 OK (INVITE) [ANM] + SIP->>MGCF: ACK + + MGCF->>IMS: BYE + IMS->>MGCF: 200 OK (BYE) + MGCF->>SIP: BYE [REL] + SIP->>MGCF: 200 OK (BYE) [RLC] + +``` + +Sequence diagram for an incoming call. Lifelines: IMS core node (CSCF, BGCF, TrGW), MGCF, IM-MGW, and SIP-I based circuit-switched core network. The diagram shows the signaling flow for an incoming call, starting with a 200 OK (INVITE) and ending with a BYE and 200 OK (BYE) sequence. A box indicates that preceding signaling sequences are shown in Figure 7.6.2.1.1. + +**Figure 7.6.2.1.2: Incoming Call (message sequence chart), +Continuation of figure 7.6.2.1.1** + +## 7.6.2.2 Autonomous Release at MGCF + +In this example, the MGCF is waiting for an answer from the called subscriber, i.e. the final response to the SIP INVITE request. Figure 7.6.2.2.1 shows the signalling when the waiting timer expires. The MGCF initiates call clearing towards the succeeding SIP-I based circuit-switched network by sending an ISUP REL message included in a SIP BYE request. It also sends a final response for the SIP INVITE request towards the preceding IMS node indicating the error that happened. + +![Figure 7.6.2.2.1: Incoming Call Failure (message sequence chart), called subscriber does not answer. The diagram shows a sequence of messages between an IMS core node (CSCF, BGCF, TrGW), an MGCF, an IM-MGW, and a SIP-I based circuit-switched core network. The sequence starts with a message from the IMS core node to the MGCF. The MGCF sends a message to the IM-MGW. The IM-MGW sends a message to the SIP-I based circuit-switched core network. The SIP-I based circuit-switched core network sends a 480 Temporarily Unavailable message to the MGCF. The MGCF sends an ACK message to the IMS core node. The MGCF also sends a BYE [REL] message to the IM-MGW. The IM-MGW sends a 200 OK (BYE) [RLC] message to the MGCF. A timer T9 'awaiting answer' expires at the MGCF. A note indicates that for preceding signalling sequences see Figure 7.6.2.1.1.](3337af75dfee8af7687b4f49914d6c93_img.jpg) + +The diagram illustrates the message sequence for an incoming call failure where the called subscriber does not answer. The participants are: IMS core node (CSCF, BGCF, TrGW), MGCF, IM-MGW, and SIP-I based circuit-switched core network. The sequence of messages is as follows: + +- The IMS core node sends a message to the MGCF. +- The MGCF sends a message to the IM-MGW. +- The IM-MGW sends a message to the SIP-I based circuit-switched core network. +- The SIP-I based circuit-switched core network sends a **480 Temporarily Unavailable** message to the MGCF with a reason header: cause = 19. +- The MGCF sends an **ACK** message to the IMS core node. +- At the MGCF, **Timer T9 "awaiting answer" expires**. +- The MGCF sends a **BYE [REL]** message to the IM-MGW with a reason header: cause = 19 and a Cause value in REL = 19 "no answer from user (user alerted)". +- The IM-MGW sends a **200 OK (BYE) [RLC]** message to the MGCF. + +For preceding signalling sequences see Figure 7.6.2.1.1 + +Figure 7.6.2.2.1: Incoming Call Failure (message sequence chart), called subscriber does not answer. The diagram shows a sequence of messages between an IMS core node (CSCF, BGCF, TrGW), an MGCF, an IM-MGW, and a SIP-I based circuit-switched core network. The sequence starts with a message from the IMS core node to the MGCF. The MGCF sends a message to the IM-MGW. The IM-MGW sends a message to the SIP-I based circuit-switched core network. The SIP-I based circuit-switched core network sends a 480 Temporarily Unavailable message to the MGCF. The MGCF sends an ACK message to the IMS core node. The MGCF also sends a BYE [REL] message to the IM-MGW. The IM-MGW sends a 200 OK (BYE) [RLC] message to the MGCF. A timer T9 'awaiting answer' expires at the MGCF. A note indicates that for preceding signalling sequences see Figure 7.6.2.1.1. + +**Figure 7.6.2.2.1: Incoming Call Failure (message sequence chart), called subscriber does not answer** + +## 7.6.3 Outgoing Call flows + +The first two call flows show the signalling for a successful basic call establishment. The third call flow shows interworking when the call is forked within the IMS. + +### 7.6.3.1 Outgoing Call, Sending of INVITE is deferred + +Figure 7.6.3.1.1 shows an outgoing call where the preconditions are not met when the MGCF receives the initial SIP INVITE. The MGCF defers sending of INVITE until preconditions are met. The MGCF selects a codec and sends back 183 Progress. When the MGCF receives the SIP UPDATE request remote preconditions are met. + +When the MGCF sends the SIP INVITE request to the next IMS node, it does not request the support for preconditions. The selected codec is inserted as the first one within the list of offered codecs. Shown, as a network option, is the inclusion of the PSTN XML body, which is mapped from the previously received ISUP information. The MGCF offers the support for early media which is confirmed by the IMS node in the 183 progress. In this example, the answer does not authorise early media because in-band tones or announcements are not provided. + +When a 180 Ringing provisional response is received from the succeeding IMS the MGCF orders the IM-MGW to start sending the ringing tone before it propagates the 180 Ringing, which includes the ISUP ACM, to the preceding SIP-I based circuit-switched core network. + +![Sequence diagram for Outgoing Call with deferred INVITE until preconditions are met.](9b1ec0090070bdf52ea28763b8d52477_img.jpg) + +The diagram illustrates the signaling flow for an outgoing call where the sending of the INVITE message is deferred until preconditions are met. The participants involved are a SIP-I based circuit-switched core network, an IM-MGW, an MGCF, and an IMS core node (CSCF, BGCF, TrGW). + +**Sequence of Events:** + +- The SIP-I based circuit-switched core network sends an **INVITE [SDP, IAM]** to the IM-MGW. +- The IM-MGW responds with **100rel, UPDATE, precondition tag 3gOoBTC, supported codec list**. A note indicates that **preconditions not met**. +- The IM-MGW sends a **100 TRYING** response back to the core network. +- A shaded box indicates **Seize incoming side RTP bearer terminations** at the IM-MGW. +- The IM-MGW sends a **183 Progress [SDP]** response. Details include: **100rel, UPDATE, preconditions 3gOoBTC, selected codec, available codecs**. A note indicates **local preconditions met**. +- The IM-MGW sends a **PRACK** response. +- The IM-MGW receives a **200 OK (PRACK)** response. +- The IM-MGW sends an **UPDATE [SDP]** message. A note indicates **preconditions are met**. +- The IM-MGW receives a **200 OK (UPDATE) [SDP]** response. A note indicates **local preconditions met**. +- A shaded box indicates **Seize outgoing side RTP bearer terminations** at the IM-MGW. +- At this point, a note indicates **IMS will not send inband ringing tone**. +- The IM-MGW sends a **Send Tone (Ringing)** message. +- The IM-MGW receives a **180 Ringing [ACM]** response. +- The IM-MGW sends a **PRACK** response. +- The IM-MGW receives a **200 OK (PRACK)** response. +- Simultaneously, the MGCF sends an **INVITE [SDP, PSTN XML]** to the IMS core node. Details include: **100rel, UPDATE, P-Early-Media, IMS codec list (selected codec, ...), PSTN XML**. +- The IMS core node responds with **100 TRYING**. +- The IMS core node sends a **183 Progress [SDP]** response. Details include: **100rel, UPDATE, selected codec**. +- The IMS core node receives a **PRACK [SDP]** response. +- The IMS core node receives a **200 OK (PRACK) [SDP]** response. +- The IMS core node sends a **180 Ringing** message. +- The IMS core node receives a **200 OK (INVITE)** response. +- A shaded box indicates **Stop Tone (Ringing)** at the IM-MGW. +- The IM-MGW receives a **200 OK (INVITE) [ANM]** response. +- The IM-MGW sends an **ACK** response. +- The MGCF receives an **ACK** response from the IMS core node. + +Sequence diagram for Outgoing Call with deferred INVITE until preconditions are met. + +Figure 7.6.3.1.1: Outgoing Call, sending of INVITE is deferred until preconditions are met + +### 7.6.3.2 Outgoing Call, Sending of INVITE is not deferred + +Figure 7.6.3.2.1 shows an outgoing call where the preconditions are not met when the MGCF receives the initial SIP INVITE. When the MGCF sends the SIP INVITE request to the next IMS node before preconditions are fulfilled, it requests the support for preconditions. + +Support for preconditions is confirmed from the IMS node. The MGCF receives more than one codec in the 183 Progress from the external node. Therefore the MGCF selects one of the received codecs and makes a second SDP offer to the external node in the SIP PRACK request in order to lock the codec. + +When the MGCF receives from the incoming side an UPDATE message indicating that preconditions are fulfilled, it propagates the UPDATE message towards the IMS. + +When a 180 Ringing provisional response is received from the succeeding IMS the MGCF orders the IM-MGW to start sending the ringing tone before it propagates the 180 Ringing, which includes the ISUP ACM, to the preceding SIP-I based circuit-switched core network. + +![Sequence diagram for Outgoing Call (Figure 7.6.3.2.1) showing interactions between SIP-I based circuit-switched core network, IM-MGW, MGCF, and IMS core node (CSCF, BGCF, TrGW).](65e8c0628536d6d4245e9ab46ba070c3_img.jpg) + +The sequence diagram illustrates the call flow for an outgoing call where the INVITE is not deferred. The participants are: + + +- SIP-I based circuit-switched core network** (left) +- IM-MGW** (Intermediate Media Gateway) +- MGCF** (Media Gateway Control Function) +- IMS core node (CSCF, BGCF, TrGW)** (right) + + The sequence of messages is as follows: + + +- The SIP-I network sends an **INVITE [SDP, IAM]** to the IM-MGW. +- The IM-MGW responds with **100rel, UPDATE**, indicating that preconditions are not met. +- The IM-MGW sends a **100 TRYING** response back to the SIP-I network. +- The IM-MGW sends a **Seize outgoing side RTP bearer terminations** message to the MGCF. The MGCF notes that preconditions are *not met*. +- The MGCF sends an **INVITE [SDP, PSTN XML]** to the IMS core node, including a precondition tag and P-Early-Media. +- The IMS core node responds with **100 TRYING**. +- The IMS core node sends a **183 Progress [SDP]** response. The IM-MGW notes that the IMS IETF codec is modified and local preconditions are met. A note indicates that the IMS will not send an inband ringing tone. +- The IM-MGW sends a **Seize incoming side RTP bearer terminations** message to the MGCF. +- The IM-MGW sends a **183 Progress [SDP]** response to the SIP-I network, indicating that local preconditions are met. +- The IM-MGW sends a **PRACK** message to the MGCF. +- The MGCF sends a **PRACK** message to the IMS core node. +- The IMS core node responds with **200 OK (PRACK)**. +- The IM-MGW sends a **200 OK (PRACK)** response to the SIP-I network. +- The IM-MGW sends an **UPDATE [SDP]** message to the MGCF. The MGCF notes that preconditions are met. +- The MGCF sends an **UPDATE [SDP]** message to the IMS core node, indicating that the selected codec and preconditions are met. +- The IMS core node responds with **200 OK (UPDATE) [SDP]**, indicating that local preconditions are met. +- The IM-MGW sends a **200 OK (UPDATE) [SDP]** response to the SIP-I network. +- The MGCF sends a **180 Ringing** message to the IMS core node. +- The IM-MGW sends a **Send Tone (Ringing)** message to the MGCF. +- The IM-MGW sends a **180 Ringing [ACM]** response to the SIP-I network. +- The IM-MGW sends a **PRACK** message to the MGCF. +- The IM-MGW sends a **200 OK (PRACK)** response to the SIP-I network. +- The IMS core node sends a **200 OK (INVITE)** response to the MGCF. +- The IM-MGW sends a **Stop Tone (Ringing)** message to the MGCF. +- The IM-MGW sends a **200 OK (INVITE) [ANM]** response to the SIP-I network. +- The IM-MGW sends an **ACK** message to the MGCF. +- The MGCF sends an **ACK** message to the IMS core node. + +Sequence diagram for Outgoing Call (Figure 7.6.3.2.1) showing interactions between SIP-I based circuit-switched core network, IM-MGW, MGCF, and IMS core node (CSCF, BGCF, TrGW). + +Figure 7.6.3.2.1: Outgoing Call, sending of INVITE is not deferred until preconditions are met + +### 7.6.3.3 Interworking with forked SIP INVITE Requests + +In this example, the SIP INVITE request is routed within the IMS to a forking proxy. Therefore the MGCF has to interwork with multiple early dialogues. This is shown in figures 7.6.3.3.1 and 7.6.3.3.2, where only those message contents are shown that are needed for the understanding of this call flow. + +When receiving the first 183 Session Progress within dialogue A, the handling is done as in the previous call flow example (figure 7.6.3.2.1). Afterwards the MGCF receives another 183 Session Progress but within a second dialogue + +B. In this example, the received codec list does not include the codec which is already selected for dialogue A. Therefore the MGCF can not directly send the selected codec to the succeeding IMS node within the second dialogue B. + +When the SIP UPDATE request is received, which indicates that preconditions are met, the MGCF sends two SIP UPDATE requests to the succeeding IMS node to signal within both dialogues that preconditions are met. + +![Sequence diagram for Outgoing Call, multiple early dialogues. The diagram shows the interaction between an SIP-I based circuit-switched core network (via IM-MGW), an MGCF, and an IMS core node (CSCF, BGCF, CS-IBCF). The MGCF initiates two dialogues, A and B, with the IMS core node. Dialogue A is established first, followed by Dialogue B. The MGCF sends SIP INVITE, 100 Trying, 183 Session Progress, PRACK, 200 OK (PRACK), UPDATE, and 200 OK (UPDATE) messages. The IM-MGW performs RTP bearer terminations (seize outgoing and incoming) during the call setup.](3c04b14104f95eb8f7100f6d497d956e_img.jpg) + +``` + +sequenceDiagram + participant IMS_CSN as SIP-I based circuit-switched core network + participant IM_MGW as IM-MGW + participant MGCF as MGCF + participant IMS_Core as IMS core node (CSCF, BGCF, CS-IBCF) + + Note right of MGCF: Nc, Mn, Mj, Mg + + IMS_CSN->>IM_MGW: INVITE [SDP, IAM] +..... remote preconditions not met + IM_MGW-->>IMS_CSN: 100 Trying + IM_MGW->>MGCF: Seize outgoing side RTP bearer terminations + MGCF->>IMS_Core: INVITE [SDP] +....IMS codec list, preconditions not met, .... + IMS_Core-->>MGCF: 100 Trying + IMS_Core-->>MGCF: 183 Session Progress [SDP] +To: tag A, IMS codec list A, ..... + MGCF->>IM_MGW: Seize incoming side RTP bearer terminations + MGCF-->>IMS_Core: 183 Session Progress [SDP] +To: tag X +3gOoBTC, selected codec A, available +codecs XA + MGCF->>IMS_Core: PRACK +To: tag X + IMS_Core-->>MGCF: 200 OK (PRACK) [SDP] +To: tag A + MGCF-->>IMS_CSN: 200 OK (PRACK) +To: tag X + IMS_Core-->>MGCF: 183 Session Progress [SDP] +To: tag B, IMS codec list B, ..... + MGCF->>IMS_Core: PRACK +To: tag B + IMS_Core-->>MGCF: 200 OK (PRACK) +To: tag B + MGCF->>IMS_Core: UPDATE [SDP] +To: tag X, preconditions are met + IMS_Core-->>MGCF: UPDATE [SDP] +To: tag A, preconditions are met + IMS_Core-->>MGCF: UPDATE [SDP] +To: tag B, preconditions are met + IMS_Core-->>MGCF: 200 OK (UPDATE) [SDP] +To: tag A, local preconditions met + IMS_Core-->>MGCF: 200 OK (UPDATE) [SDP] +To: tag B, local preconditions met + MGCF-->>IMS_CSN: 200 OK (UPDATE) [SDP] +To: tag X, local preconditions met + +``` + +Sequence diagram for Outgoing Call, multiple early dialogues. The diagram shows the interaction between an SIP-I based circuit-switched core network (via IM-MGW), an MGCF, and an IMS core node (CSCF, BGCF, CS-IBCF). The MGCF initiates two dialogues, A and B, with the IMS core node. Dialogue A is established first, followed by Dialogue B. The MGCF sends SIP INVITE, 100 Trying, 183 Session Progress, PRACK, 200 OK (PRACK), UPDATE, and 200 OK (UPDATE) messages. The IM-MGW performs RTP bearer terminations (seize outgoing and incoming) during the call setup. + +Figure 7.6.3.3.1: Outgoing Call, multiple early dialogues + +Figure 7.6.3.3.2 shows that only the first 180 Ringing received from the IMS node is interworked with the SIP-I based circuit-switched core network. + +Finally, the SIP INVITE request is answered with a 200 OK within dialogue B. + +Any subsequent final response within dialogue A is acknowledged (with an ACK request) and immediately rejected by sending back a SIP BYE request. + +![Sequence diagram for Outgoing Call, multiple early dialogues. The diagram shows signaling between an SIP-I based circuit-switched core network (via IM-MGW), an MGCF, and an IMS core node (CSCF, BGCF, CS-IBCF). It details two dialogues, A and B, showing 180 Ringing, PRACK, 200 OK, ACK, and BYE messages. A note indicates that only the first 180 Ringing for dialogue B is sent to the circuit-switched network. Another note explains that if a second 200 OK is received for dialogue A, a BYE is sent. A third note indicates that if the received codec list for dialogue A did not include the previous selected codec A, the sequence continues as shown.](a4bfa2343d75076b79f7e33d93915e00_img.jpg) + +The diagram illustrates the signaling sequence for an outgoing call involving multiple early dialogues (A and B) between an SIP-I based circuit-switched core network and an IMS core node, mediated by an IM-MGW and an MGCF. + +**Participants:** + +- SIP-I based circuit-switched core network (via IM-MGW) +- MGCF +- IMS core node (CSCF, BGCF, CS-IBCF) + +**Interfaces:** + +- IM-MGW to MGCF: Nc, Mn +- MGCF to IMS core node: Mj, Mg + +**Sequence of Events:** + +- The IMS core node sends a **180 Ringing** (To: tag B) to the MGCF. +- The MGCF sends a **Send Tone (Ringing)** message to the IM-MGW. +- The IM-MGW sends a **180 Ringing [ACM]** (To: tag X) to the SIP-I based circuit-switched core network. +- The SIP-I based circuit-switched core network sends a **PRACK** (To: tag X) to the IM-MGW. +- The IM-MGW sends a **200 OK (PRACK)** (To: tag X) to the MGCF. +- The MGCF sends a **PRACK** (To: tag B) to the IMS core node. +- The IMS core node sends a **200 OK (PRACK)** (To: tag B) to the MGCF. +- The IMS core node then sends a **180 Ringing** (To: tag A) to the MGCF. +- The MGCF sends a **PRACK** (To: tag A) to the IMS core node. +- The IMS core node sends a **200 OK (PRACK)** (To: tag A) to the MGCF. +- The IMS core node sends a **200 OK (INVITE)** (To: tag B) to the MGCF. +- The MGCF sends an **ACK** (To: tag B) to the IMS core node. +- The IMS core node sends a **200 OK (INVITE)** (To: tag A) to the MGCF. +- The MGCF sends an **ACK** (To: tag A) to the IMS core node. +- The IMS core node sends a **BYE** (To: tag A) to the MGCF. +- The MGCF sends a **200 OK (BYE)** (To: tag A) to the IMS core node. +- Meanwhile, the MGCF sends an **INVITE [SDP]** (To: tag X, 3gOoBTC, selected codec XB, available codecs XB) to the IM-MGW. +- The IM-MGW sends a **200 OK (INVITE) [SDP]** (To: tag X) to the MGCF. +- The MGCF sends an **ACK** (To: tag X) to the IM-MGW. + +**Notes:** + +- For preceding signalling sequences see Figure 7.6.3.3.1 +- if second 200 OK response is received (referring to dialogue A) +- If received codec list for established dialogue did not include the previous selected codec A (referring to dialogue A) + +Sequence diagram for Outgoing Call, multiple early dialogues. The diagram shows signaling between an SIP-I based circuit-switched core network (via IM-MGW), an MGCF, and an IMS core node (CSCF, BGCF, CS-IBCF). It details two dialogues, A and B, showing 180 Ringing, PRACK, 200 OK, ACK, and BYE messages. A note indicates that only the first 180 Ringing for dialogue B is sent to the circuit-switched network. Another note explains that if a second 200 OK is received for dialogue A, a BYE is sent. A third note indicates that if the received codec list for dialogue A did not include the previous selected codec A, the sequence continues as shown. + +Figure 7.6.3.3.2: Outgoing Call, multiple early dialogues (continuation of figure 7.6.3.3.1) + +## 7.7 CS CN Supplementary Services and IMS Supplementary Services + +### 7.7.0 General + +The following clauses describe the MGCF behaviour when: + +- Supplementary services are invoked within the SIP-I based circuit switched core network and +- Supplementary services are invoked within the IMS. + +The support of these supplementary services is optional. If the supplementary services are supported, the procedures described within this clause shall be applied. + +Within the SIP-I based circuit switched core network: + +- Service information is carried within encapsulated ISUP messages. +- The procedures specified for the ISUP side in TS 29.163 [13] clauses 7.4 and 7.5 shall be applied to the encapsulated ISUP. + +### 7.7.1 Number Identification Services + +#### 7.7.1.1 CS CN Supplementary Service - Calling Line Identification Presentation/Restriction (CLIP/CLIR) + +There is no additional interworking beyond clauses 7.2 and 7.3 when the Calling Line Identification Presentation or a Calling Line Identification Restriction supplementary service is invoked within the SIP-I based circuit switched core network. + +#### 7.7.1.2 CS CN Supplementary Service - Connected Line Identification Presentation/Restriction (COLP/COLR) + +When the Connected Line Identification Presentation or Connected Line Identification Restriction supplementary service is invoked within the SIP-I based circuit switched core network, the MGCF shall perform the mapping to the Terminating Identification Presentation / Restriction service as specified in TS 29.163 [13] clause 7.5.2. + +#### 7.7.1.3 IMS Supplementary Service - Originating Identification Presentation (OIP) and Originating Identification Restriction (OIR) + +There is no additional interworking beyond clauses 7.2 and 7.3, when the Originating Identification Presentation or Originating Identification Restriction supplementary service is invoked within the IMS network. + +#### 7.7.1.4 IMS Supplementary Service - Terminating Identification Presentation (TIP) and Terminating Identification Restriction (TIR) + +When the Terminating Identification Presentation or Terminating Identification Restriction supplementary service is invoked within the IMS network, the MGCF shall perform the mapping to the Connected Line Identification Presentation / Restriction supplementary service as specified in TS 29.163 [13] clause 7.5.2. + +#### 7.7.1.5 CS CN Supplementary Service - Direct Dialling In + +There is no additional interworking beyond clauses 7.2 and 7.3, when the Direct Dialling In supplementary service is invoked within the SIP-I based circuit switched core network. + +#### 7.7.1.6 CS CN Supplementary Service - Malicious Call Identification + +When the Malicious Call Identification supplementary service is invoked within the SIP-I based circuit switched core network the MGCF shall perform the mapping as specified in TS 29.163 [13] clause 7.5.9. + +### 7.7.1.7 IMS Supplementary Service - Malicious Communication Identification (MCID) + +When Malicious Communication Identification service is invoked within the IMS network, then as specified in TS 29.163 [13] clause 7.5.9.2, the interworking to the Malicious Call Identification supplementary service shall not be applied. + +### 7.7.1.8 CS CN Supplementary Service - Subaddressing + +When the Subaddressing supplementary service is invoked within the SIP-I based circuit switched core network, the procedures specified in TS 29.163 [13] clause 7.4.5 shall be applied. + +## 7.7.2 Diversion Services + +### 7.7.2.1 CS CN Supplementary Service - Call Forwarding Services (CFU, CFB, CFNRy, CFNRc) + +When any of the call forwarding supplementary services (CFU, CFB, CFNRy, and CFNRc) is invoked within the SIP-I based circuit switched core network, the MGCF shall perform the mapping to the Communication Diversion service as specified in TS 29.163 [13] clauses 7.5.4.2.2 and 7.5.4.3. + +### 7.7.2.2 CS CN Supplementary Service - Call Deflection (CD) + +When the Call Deflection supplementary service is invoked within the SIP-I based circuit switched core network the MGCF shall perform the mapping to the Communication Diversion service as specified in TS 29.163 [13] clauses 7.5.4.2.2 and 7.5.4.3. + +### 7.7.2.3 IMS Supplementary Service - Communication Diversion (CDIV) + +When a Communication Diversion supplementary service is invoked within the IMS network, the MGCF shall perform the mapping to a Call Diversion supplementary service as specified in TS 29.163 [13] clauses 7.5.4.2.1 and 7.5.4.3. + +## 7.7.3 Waiting Services + +### 7.7.3.1 CS CN Supplementary Service - Call Waiting + +When the Call Waiting supplementary service is invoked within the SIP-I based circuit switched core network, the MGCF shall perform the mapping to the Communication Waiting service as specified in TS 29.163 [13] clause 7.5.12.1. + +### 7.7.3.2 IMS Supplementary Service - Communication Waiting (CW) + +When the Communication Waiting supplementary service is invoked within the IMS network, the MGCF shall perform the mapping to the Call Waiting supplementary service as specified in TS 29.163 [13] clause 7.5.12.2. + +## 7.7.4 Hold Services + +### 7.7.4.1 CS CN Supplementary Service - Call Hold + +There is no additional interworking beyond clauses 7.2 and 7.3, when the Call Hold supplementary service is invoked within the SIP-I based circuit switched core network. + +### 7.7.4.2 IMS Supplementary Service - Communication Hold (HOLD) + +There is no additional interworking beyond clauses 7.2 and 7.3, when the Communication Hold supplementary service is invoked within the IMS network. + +NOTE: Call hold for IMS is specified in TS 24.610 [26]. + +## 7.7.5 Multiparty Services + +### 7.7.5.1 CS CN Supplementary Services - Conference Calling (CONF) and Three-Party (3PTY) + +When the Conference Calling and Three-Party supplementary services are invoked within the SIP-I based circuit switched core network, the procedures specified in TS 29.163 [13] clause 7.4.14 shall be applied. + +### 7.7.5.2 IMS Supplementary Service - Conference (CONF) + +When the Conference supplementary service is invoked within the IMS network, the procedures specified in TS 29.163 [13] clause 7.5.6 shall be applied. + +## 7.7.6 Closed User Group Service + +### 7.7.6.1 CS CN Supplementary Service - Closed User Group (CUG) + +When the Closed User Group supplementary service is invoked within the SIP-I based circuit switched core network, the procedures specified in TS 29.163 [13] clause 7.5.10.2 shall be applied. + +### 7.7.6.2 IMS Supplementary Service - Closed User Group (CUG) + +When the Closed User Group supplementary service is invoked within the IMS network, the procedures specified in TS 29.163 [13] clause 7.5.10.1 shall be applied. + +## 7.7.7 Charging Services + +### 7.7.7.1 CS CN Supplementary Service - Advice of Charge (AoC) + +NOTE: Interworking for AoC is not specified in the present Release. + +### 7.7.7.2 IMS Supplementary Service - Advice of Charge (AOC) + +NOTE: Interworking for AOC is not specified in the present Release. + +### 7.7.7.3 CS CN Supplementary Service - International Telecommunication Charge Card (ITCC) + +When the International Telecommunication Charge Card supplementary service is invoked within the SIP-I based circuit switched core network no additional treatment is required by the MGCF. + +### 7.7.7.4 CS CN Supplementary Service - Reverse Charging (REV) + +When the Reverse Charging supplementary service is invoked within the SIP-I based circuit switched core network, the procedures specified in TS 29.163 [13] clause 7.4.17 shall be applied. + +## 7.7.8 Barring Services + +### 7.7.8.1 CS CN Supplementary Service - Barring of Outgoing Calls + +There is no additional interworking beyond clauses 7.2 and 7.3, when the Barring of Outgoing Call supplementary service is invoked within the SIP-I based circuit switched core network. + +### 7.7.8.2 CS CN Supplementary Service - Barring of Incoming Calls + +There is no additional interworking beyond clauses 7.2 and 7.3, when the Barring of Incoming Calls supplementary service is invoked within the SIP-I based circuit switched core network. + +### 7.7.8.3 CS CN Supplementary Service - Anonymous Call Rejection (ACR) + +When the Anonymous Call Rejection supplementary service is invoked within the SIP-I based circuit switched core network, the procedures specified in TS 29.163 [13] clause 7.4.23.1 shall be applied. + +#### 7.7.8.4 IMS Supplementary Service - Communication Barring (CB) + +NOTE: Interworking of Communication Barring is not specified in the present Release. + +#### 7.7.8.5 IMS Supplementary Service - Anonymous Communication Rejection (ACR) + +When the Anonymous Communication Rejection supplementary service is invoked within the IMS network, the procedures specified in TS 29.163 [13] clause 7.4.23.2 shall be followed with the following modifications at the SIP-I on Nc side: + +- The response code 433 (Anonymity Disallowed) defined by IETF RFC 5079 [36] is supported on SIP-I on Nc. + +### 7.7.9 Transfer Services + +#### 7.7.9.1 CS CN Supplementary Service - Explicit Call Transfer (ECT) + +When the Explicit Call Transfer supplementary service is invoked within the SIP-I based circuit switched core network and the MGCF receives from the SIP-I based circuit-switched core network an INFO message with encapsulated ISUP FAC for the notification of ECT invocation, then the MGCF shall: + +- map the FAC into a SIP re-INVITE request or SIP UPDATE request according to TS 29.163 [13] if the call is in active state (after answer). +- map the FAC into a SIP UPDATE request according to TS 29.163 [13] if the call is in active state (before answer). + +#### 7.7.9.2 IMS Supplementary Service - Explicit CommunicationTransfer (ECT) + +When the Explicit CommunicationTransfer supplementary service is invoked within the IMS network and if the transferee is another IMS terminal and the transfer target is a CS terminal, then the MGCF will receive a SIP INVITE request. No special interworking is required at the MGCF. + +NOTE: The protocol for ECT within IMS is specified in TS 24.629 [25]. The IMS terminal, which invokes the ECT service, sends a SIP REFER request to the transferee. The transferee sends a SIP INVITE request to the transfer target. + +### 7.7.10 Call Completion Services + +#### 7.7.10.1 CS CN Supplementary Service - Completion of Calls to Busy Subscriber (CCBS) + +When the Completion of Calls to Busy Subscriber supplementary service is invoked within the SIP-I based circuit switched core network, the procedures specified in TS 29.163 [13] clause 7.4.11 shall be applied. + +#### 7.7.10.2 CS CN Supplementary Service - Completion of Calls on No Reply (CCNR) + +When the Completion of Calls on No Reply supplementary service is invoked within the SIP-I based circuit switched core network, the procedures specified in TS 29.163 [13] clause 7.4.12 shall be applied. + +#### 7.7.10.3 IMS Supplementary Service - Completion of Communications to Busy Subscriber (CCBS) and Completion of Communication on No Reply (CCNR) + +When the Completion of Communications to Busy Subscriber or Completion of Communication on No Reply supplementary service is invoked within the IMS network, the procedures specified in TS 29.163 [13] clause 7.5.11.1 shall be applied. + +### 7.7.11 Miscellaneous Services + +#### 7.7.11.1 CS CN Supplementary Service - Multi-Level Precedence and Pre-emption (MLPP) + +When the Multi-Level Precedence and Pre-emption (MLPP) supplementary service is invoked within the SIP-I based circuit switched core network the procedures specified in TS 29.163 [13] clause 7.4.17 shall be applied. + +#### 7.7.11.2 CS CN Supplementary Service - Multiple Subscriber Profile (MSP) + +There is no additional interworking beyond clauses 7.2 and 7.3 when a Multiple Subscriber Profile supplementary service is invoked within the SIP-I based circuit switched core network. + +#### 7.7.11.3 CS CN Supplementary Service - Multicall + +There is no additional interworking beyond clauses 7.2 and 7.3 when the Multicall supplementary service is invoked within the SIP-I based circuit switched core network. + +#### 7.7.11.4 CS CN Supplementary Service - Calling Name Presentation + +There is no additional interworking beyond clauses 7.2 and 7.3, when the Calling Name Presentation supplementary service is invoked within the SIP-I based circuit switched core network. + +#### 7.7.11.5 CS CN Supplementary Service - User-to-User Signalling (UUS) + +NOTE: Interworking for User-to-User Signalling is not specified in the present Release. + +#### 7.7.11.6 IMS Supplementary Service - Message Waiting Indication (MWI) + +NOTE: Interworking for Message Waiting Indication is not specified in the present Release. + +#### 7.7.11.7 CS CN Supplementary Service - Global Virtual Network Service (GVNS) + +When the Global Virtual Network Service supplementary service is invoked within the SIP-I based circuit switched core network the procedures specified in TS 29.163 [13] clause 7.4.18 shall be applied. + +#### 7.7.11.8 CS CN Supplementary Service - Terminal Portability (TP) + +When the Terminal Portability supplementary service is invoked within the SIP-I based circuit switched core network, the procedures specified in TS 29.163 [13] clause 7.4.13 shall be applied. + +### 7.7.12 Customized Alerting Tones Services + +#### 7.7.12.1 CS CN Supplementary Service - Customized Alerting Tones (CAT) + +When the Customized Alerting Tones supplementary service is invoked within the SIP-I based circuit switched core network, the MGCF shall perform the mapping as specified in TS 29.163 [13] clause 7.4.24. + +#### 7.7.12.2 IMS Supplementary Service - Customized Alerting Tones (CAT) for early session model + +When the Customized Alerting Tones supplementary service is invoked within the IMS network using early session model, the MGCF shall perform the mapping for normal session SDP negotiation and early session SDP negotiation as specified in TS 29.163 [13] clause 7.5.13.2. + +#### 7.7.12.3 IMS Supplementary Service - Customized Alerting Tones (CAT) for forking model + +When the Customized Alerting Tones supplementary service is invoked within the IMS network using forking model, the MGCF shall perform the mapping as specified in TS 29.163 [13] clause 7.5.13.3. + +#### 7.7.12.4 IMS Supplementary Service - Customized Alerting Tones (CAT) for gateway model + +When the Customized Alerting Tones supplementary service is invoked within the IMS network using gateway model, the MGCF shall perform the mapping as specified in TS 29.163 [13] clause 7.5.13.4. + +## 7.8 MGCF - IM-MGW Interaction + +### 7.8.1 General + +The present clause describes signalling procedures that are applicable at the Mn interface when the MGCF and attached IM-MGW interwork between an IM CN Subsystem and a SIP-I based circuit-switched core network. + +The MGCF shall interact with the IM-MGW across the Mn reference point. The signalling interface across the Mn reference point is defined in accordance with ITU-T Recommendation H.248.1 [53] and shall conform to 3GPP specific extensions as detailed in TS 29.332 [54]. + +### 7.8.2 Call related Procedures for Terminations towards the IM CN Subsystem + +Clause 9.3.1 in TS 29.163 [13] shall apply. + +### 7.8.3 Call related Procedures for Terminations towards SIP-I based Circuit-switched Core Network + +Those procedures defined in TS 23.205 [9] that are listed in table 7.8.3.1 shall apply. + +**Table 7.8.3.1: Call related Procedures defined in TS 23.205 [9] that are applicable at terminations towards SIP-I based circuit-switched core network** + +| Procedure defined in TS 23.205 [9] | Remarks | +|--------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Change Flow Direction | NOTE 1 in that clause is replaced by:

NOTE 1: This procedure may be combined with the "Reserve RTP Connection Point" procedure, the "Configure RTP Connection Point" procedure, or the "Reserve and Configure RTP Connection Point" procedure. | +| Change Through-Connection | The NOTE in that clause is replaced by:

NOTE 2: This procedure may be combined with the "Reserve RTP Connection Point" procedure, the "Configure RTP Connection Point" procedure, or the "Reserve and Configure RTP Connection Point" procedure. | +| Bearer Released | | +| Release Termination | | +| Send Tone | | +| Stop Tone | | +| Play Announcement | Optional | +| Stop Announcement | Optional | +| Announcement Completed | Optional | +| Tone Completed | | +| Activate Voice Processing Function | Optional | +| Termination heartbeat indication | | +| Reserve RTP Connection Point | | +| Configure RTP Connection Point | | +| Reserve and Configure RTP Connection Point | | + +### 7.8.4 Non-call related procedures + +Clause 9.3.4 in TS 29.163 [13] shall apply. + +--- + +# Annex A (normative): Interconnecting functionalities in SIP-I based CS domain + +## A.1 General + +This annex describes a collection of functions that can be performed on interconnection boundaries between two SIP-I based 3GPP CS networks or between a SIP-I based CS network and other SIP-I based external network, based on operator configuration. + +In clauses A.2 and A.3 Stage 2 requirements and border control architecture are described. + +--- + +## A.2 Stage 2 Requirements + +Based on operator preference, border control functions may be applied between two SIP-I based 3GPP CS domains or between a SIP-I based 3GPP CS domain and other SIP-I based external network. These functions, provided by the CS-IBCF, are: + +- Controlling transport plane functions; +- Supporting functions to allow establishing communication between disparate address realms' SIP-I applications; +- Providing network configuration hiding to restrict the following information from being passed outside of an operator's network: exact number of MSC servers, capacity and topology of the network, naming and addressing of the network nodes; +- Screening SIP signalling information based on source/destination and operator policy (e.g. remove information that is of local significance to an operator); +- Selecting the appropriate signalling interconnections (e.g. domain based routing). The IP interconnection between core networks may be supported either by direct connection or by using an intermediate carrier; +- Supporting network resources allocation taking into consideration the codec negotiation performed by (G)MSCs across one or multiple interconnects, remaining transparent to the SDP negotiation. + +In case border control concepts are to be applied in a SIP-I based CS network, the CS-IBCF acts as an entry point for this network, and also acts as an exit point for this network. + +On the media plane the following functions shall be supported by the CS-TrGW: + +- Gate Management: + - Opening/closing of gates; + - Remote source address filtering; + - Remote source port filtering; +- QoS packet marking (differentiated services); +- NA(P)T and IP Version Interworking; +- Bandwidth policing; +- Hanging termination detection; +- IP Realm Indication. + +Additionally, the following functions may be supported by the CS-TrGW: + +- IP Realm Availability. + +## A.3 Border Control architecture + +Figure A.3.1 presents a high-level architecture diagram showing how CS-IBCF and CS-TrGW logical functions fit into the SIP-I based CS domain. + +![Figure A.3.1: CS-IBCF and CS-TrGW in SIP-I based CS domain. The diagram shows a network architecture with three main components: IWU, UP-IWU, and a 'border control logical functions' block. The IWU is connected to the UP-IWU via an Mc reference point. The UP-IWU is connected to the 'border control logical functions' block via a Media/RTP/UDP/IP bearer. The 'border control logical functions' block contains two sub-functions: CS-IBCF (which includes ALG and THIG) and CS-TrGW. The CS-IBCF is connected to the UP-IWU via a SIP-I signalling path. The CS-TrGW is connected to the UP-IWU via a CS-Ix signalling path. The 'border control logical functions' block is connected to a 'SIP-I based 3GPP CS domain/External SIP-I Network' via a dashed line representing a bearer path. A legend indicates that dashed lines represent Signalling and solid lines represent Bearer.](f468e577645d646f5157ce3eefb4ed96_img.jpg) + +Figure A.3.1: CS-IBCF and CS-TrGW in SIP-I based CS domain. The diagram shows a network architecture with three main components: IWU, UP-IWU, and a 'border control logical functions' block. The IWU is connected to the UP-IWU via an Mc reference point. The UP-IWU is connected to the 'border control logical functions' block via a Media/RTP/UDP/IP bearer. The 'border control logical functions' block contains two sub-functions: CS-IBCF (which includes ALG and THIG) and CS-TrGW. The CS-IBCF is connected to the UP-IWU via a SIP-I signalling path. The CS-TrGW is connected to the UP-IWU via a CS-Ix signalling path. The 'border control logical functions' block is connected to a 'SIP-I based 3GPP CS domain/External SIP-I Network' via a dashed line representing a bearer path. A legend indicates that dashed lines represent Signalling and solid lines represent Bearer. + +Figure A.3.1: CS-IBCF and CS-TrGW in SIP-I based CS domain + +The CS-IBCF, which provides border control functions, shall be transparent to the call control application of the adjacent 3GPP SIP-I nodes. That is, outgoing SIP-I messages from a 3GPP MSC-IWU shall assume that it is signalling to an external network. The CS-IBCF shall not perform SIP-I profile interworking functions that are defined by the main text of this specification. The CS-IBCF is a logical function that either is co-located with IWU in a single physical (G)MSC-S node, or is within a separate physical node, e.g. when co-locating with IMS-IBCF. + +The Nb reference point allows CS-MGWs to communicate with a CS-TrGW in order to provide border control functions. The CS-TrGW is a logical function that may reside in the UP-IWU. The CS-TrGW, which provides border control functions, shall be transparent to adjacent 3GPP MGWs. The CS-TrGW shall not perform any SIP-I user plane interworking functions that are defined by the main text of this specification. The CS-TrGW is a logical function that can be co-located with UP-IWU in a single physical CS-MGW node, but can also be in a separate physical node, e.g. when co-locating with IMS-TrGW. + +If the logical functions are co-located with (G)MSC and CS-MGW then the Mc profile as defined by TS 29.232 [55] shall provide the required functionality (described in clause A.8). If CS-IBCF is physically separated then the CS-IBCF control function is connected to the CS-TrGW via the CS-Ix reference point (described in clause A.7), which is realised by the Ix profile as defined by TS 29.238 [29]. + +## A.4 Void + +## A.5 Procedures at the CS-IBCF + +### A.5.1 General + +Border control functions may be applied between two SIP-I based CS domains subsystems or between an SIP-I based CS domains and other SIP-I based networks based on operator preference. The CS-IBCF may act both as an entry point and as an exit point for a network. If it processes a SIP request received from other network it functions as an entry point (see clause A.5.3) and it acts as an exit point whenever it processes a SIP request sent to other network (see clause A.5.2). + +Depending on its rule, the functions of the CS-IBCF include: + +- network configuration hiding (described in clauses A.5.2.4 and A.5.3.4); + +- application level gateway (in clauses A.5.2.5 and A.5.3.5); +- screening of SIP signalling (in clauses A.5.2.6 and A.5.3.6); +- charging (in clauses A.5.2.7 and A.5.3.7). + +NOTE: The functions performed by the CS-IBCF are configured by the operator, and they are network specific. + +## A.5.2 CS-IBCF as an exit point + +### A.5.2.1 Initial requests + +Upon receipt of any request, the CS-IBCF shall: + +- 1) if the request is an INVITE request, respond with a 100 (Trying) provisional response; +- 2) if the request is an INVITE request and the CS-IBCF is configured to perform application level gateway and/or transport plane control functionalities, save the Contact, CSeq, From and Record-Route header field values received in the request such that the CS-IBCF is able to release the session if needed; +- 3) if network topology hiding is required, apply the procedures as described in clause A.5.2.4; +- 4) if screening of SIP signalling is required, apply the procedures as described in clause A.5.2.6; +- 5) select an entry point of the destination network and forward the request to that entry point; + +NOTE: The list of the entry points can be either obtained as specified in IETF RFC 3263 [30] or provisioned in the CS-IBCF. The entry point can be a CS-IBCF or an (G)MSC server. + +When the CS-IBCF receives an INVITE request, the CS-IBCF may require the periodic refreshment of the session to avoid hung states in the CS-IBCF. If the CS-IBCF requires the session to be refreshed, the CS-IBCF shall apply the procedures described in IETF RFC 4028 [31] clause 8. + +IETF RFC 3325 [32] provides for the existence and trust of an asserted identity within a trust domain. A CS-IBCF at the boundary of the trust domain will need to determine whether to remove the P-Asserted-Identity header according to IETF RFC 3325 [32] when SIP signalling crosses the boundary of the trust domain. + +When the CS-IBCF receives a response to the initial request and network topology hiding is required, then the CS-IBCF shall apply the procedures as described in clause A.5.2.4. + +When the CS-IBCF receives a response to the initial request and screening of SIP signalling is applied, then the CS-IBCF shall apply the procedures as described in clause A.5.2.6. + +When the CS-IBCF receives a response to the initial INVITE request that establishes a dialogue, and the CS-IBCF is configured to perform application level gateway and/or transport plane control functions, the CS-IBCF shall save the Contact, To and Record-Route header field values received in the response such that the CS-IBCF is able to release the session if needed. + +### A.5.2.2 Subsequent requests + +Upon receipt of any request, the CS-IBCF shall: + +- 1) if the request is an INVITE request, respond with a 100 (Trying) provisional response; +- 2) if the request is a target refresh request and the CS-IBCF is configured to perform application level gateway and/or transport plane control functions, save the Contact and CSeq header field values received in the request such that the CS-IBCF is able to release the session if needed; +- 3) if the subsequent request is other than a target refresh request (including requests relating to an existing dialogue where the method is unknown) and the CS-IBCF is configured to perform application level gateway and/or transport plane control functionalities, save the Contact and CSeq header field values received in the request such that the CS-IBCF is able to release the session if needed; +- 4) if network topology hiding is required, apply the procedures as described in clause A.5.2.4; + +- 5) if screening of SIP signalling is required, apply the procedures as described in clause A.5.2.6. + +When the CS-IBCF receives a response to the subsequent request and network topology hiding is required, then the CS-IBCF shall apply the procedures as described in clause A.5.2.4. + +When the CS-IBCF receives a response to the subsequent request and screening of SIP signalling is required, then the CS-IBCF shall apply the procedures as described in clause A.5.2.6. + +### A.5.2.3 CS-IBCF-initiated call release + +If the CS-IBCF provides transport plane control functionality and receives an indication of a transport plane related error the CS-IBCF may: + +- 1) if the CS-IBCF has already sent an initial INVITE request to the terminating side, apply SIP procedures detailed in IETF RFC 3261 [20] to terminate any corresponding SIP dialogue(s) or otherwise cancel the INVITE at the terminating side, making use of CANCEL and/or BYE request(s), based on information saved for the related dialogue; and +- 2) if the CS-IBCF has not yet sent out a final response for the initial INVITE request, send an appropriate failure response for the initial INVITE request to the originating side; and +- 3) if the CS-IBCF has already sent out a final response for the initial INVITE request, generate a BYE request for the originating side based on the information saved for the related dialogue. + +NOTE 1: Transport plane related errors can be indicated from TrGW. + +NOTE 2: Since the CS-IBCF does not handle the encapsulated ISUP, the BYE message(s) generated by the CS-IBCF will not contain any encapsulated ISUP REL message. + +If the CS-IBCF is able to determine an appropriate Q.850 cause value, then this may be included in a Reason header in the BYE message(s). + +### A.5.2.4 THIG functionality in the CS-IBCF + +#### A.5.2.4.1 General + +The following procedures shall only be applied if network topology hiding is required by the network. The network requiring network topology hiding is called the hiding network. + +NOTE 1: Requests and responses are handled independently; therefore, no state information is needed for that purpose within a CS-IBCF. + +The CS-IBCF shall apply network topology hiding to all headers which reveal topology information, such as Via, Route, Record-Route, and Path. Therefore, the CS-IBCF shall: + +- either act as a B2BUA, i.e. set above headers as defined for a SIP user agent client by IETF RFC 3261 [20], +- or as an option follow the procedures defined in clause A.5.2.4.2. + +The CS-IBCF shall not screen SIP parameters for which there is a related ISUP parameter defined within ITU-T Recommendation Q.1912.5 [6]. + +NOTE 2: SIP-I screening is normally done by the MSC, where the encapsulated ISUP message and the SIP headers are consistently screened. + +Upon receiving an incoming initial request for which network topology hiding has to be applied and which includes a Record-Route header, the CS-IBCF shall add its own routable SIP URI to the top of the Record-Route header. + +#### A.5.2.4.2 Encryption for network topology hiding + +Upon receiving a request/response, outgoing from the hiding network the CS-IBCF shall perform the encryption for network topology hiding purposes, i.e. the CS-IBCF shall: + +- 1) use the whole header values which were added by one or more specific entity of the hiding network as input to encryption; + +- 2) not change the order of the headers subject to encryption when performing encryption; +- 3) use for one encrypted string all received consecutive header entries subject to encryption, regardless if they appear in separate consecutive headers or if they are consecutive entries in a comma separated list in one header; +- 4) construct a hostname that is the encrypted string; +- 5) append a "tokenized-by" parameter and set it to the value of the encrypting network's name, after the constructed hostname; +- 6) form one valid entry for the specific header out of the resulting NAI, e.g. prepend "SIP/2.0/UDP" for Via headers or "sip:" for Path, Route and Record-Route headers; +- 7) if the CS-IBCF encrypted an entry in the Route header, then it also inserts its own URI before the topmost encrypted entry; and +- 8) if the CS-IBCF encrypted an entry in the Via header, then it also inserts its own URI before the topmost encrypted entry. + +NOTE: Even if consecutive entries of the same network in a specific header are encrypted, they will result in only one encrypted header entry. For example: + +``` +Via: SIP/2.0/UDP ibcf1.home1.net;lr, + SIP/2.0/UDP Token( SIP/2.0/UDP msc2.home1.net;lr, + SIP/2.0/UDP msc1.home1.net;lr); + tokenized-by=home1.net, + SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd] +``` + +## A.5.2.5 ALG functionality in the CS-IBCF + +The CS-IBCF shall only apply the following procedures if application level gateway functionality is required by the network. + +The CS-IBCF acts as a B2BUA when it performs ALG functionality. The CS-IBCF, although acting as a UA, does not initiate any registration of its associated addresses. These are assumed to be known by peer-to-peer arrangements within the SIP-I based CS domain. + +In case the initial INVITE request is received from own network, i.e. the CS-IBCF acts as an exit point, the CS-IBCF shall generate a new initial INVITE request and forward it to the entry point of the other network. + +The internal function of the CS-IBCF as an ALG is equal to that one defined in TS 29.162 [37]. + +## A.5.2.6 Screening of SIP-I signalling + +### A.5.2.6.1 General + +This section relates to the screening of the SIP headers and SDP of the SIP-I signalling for policing purposes. Inspection of ISUP MIME bodies is out of the scope of this specification. + +The CS-IBCF shall act as a B2BUA when it performs screening of SIP signalling functionality. In this case the B2BUA behaviour of the CS-IBCF shall comply with the description given in clause A.5.2.5 for the ALG functionality. + +NOTE 1: Many headers are intended for end-to-end operation; removal of such headers will impact the intended end-to-end operation between nodes. Additionally security mechanisms covering SIP headers are not precluded; any such removal can prevent validation of all headers covered by the security mechanism. + +NOTE 2: SIP-I screening is normally done by the MSC, where the encapsulated ISUP message and the SIP headers are consistently screened. + +### A.5.2.6.2 CS-IBCF procedures for SIP headers + +If specified by local policy rules, the CS-IBCF may omit or modify any received SIP headers prior to forwarding SIP messages, with some exceptions. + +NOTE 1: If the CS-IBCF modifies SIP information elements (SIP headers, SIP message bodies) other than as specified by SIP procedures (e.g., IETF RFC 3261 [20]) caution needs to be taken that SIP functionality (e.g., routing using Route, Record-Route and Via) is not impacted in a way that could create interoperability problems with networks that assume that this information is not modified. + +NOTE 2: Where operator requirements can be achieved by configuration hiding, then these procedures can be used in preference to screening. + +#### A.5.2.6.3 CS-IBCF procedures for SIP message bodies + +If IP address translation (NA(P)T or IP version interworking) occurs on the user plane, the CS-IBCF shall modify SDP according to TS 29.162 [37]. + +#### A.5.2.7 Void + +### A.5.3 CS-IBCF as an entry point + +#### A.5.3.1 Initial requests + +Upon receipt of any request, the CS-IBCF shall: + +- 1) if the request is an INVITE request, then respond with a 100 (Trying) provisional response; +- 2) if the request is an INVITE request and the CS-IBCF is configured to perform application level gateway and/or transport plane control functions, save the Contact, Cseq, From and Record-Route header field values received in the request such that the CS-IBCF is able to release the session if needed; +- 3) if network topology hiding is required, then apply the procedures as described in clause A.5.3.4; +- 4) if screening of SIP signalling is required, apply the procedures as described in clause A.5.3.6; +- 5) If CS-IBCF receives an initial request for a dialogue or standalone transaction that contains a single Route header pointing to itself, and it is co-located with an (G)MSC server, or it has a preconfigured (G)MSC server to be contacted, then forward the request to that (G)MSC server. Otherwise select an (G)MSC server and forward the request to that (G)MSC server. + +When the CS-IBCF receives an INVITE request, the CS-IBCF may require the periodic refreshment of the session to avoid hung states in the CS-IBCF. If the CS-IBCF requires the session to be refreshed, the CS-IBCF shall apply the procedures described in IETF RFC 4028 [31] clause 8. + +When the CS-IBCF receives a response to an initial request (e.g. 183 or 2xx), the CS-IBCF shall: + +- 1) if network topology hiding is required, apply the procedures as described in clause A.5.3.4; +- 2) if screening of SIP signalling is applied, apply the procedures as described in clause A.5.3.6; and +- 3) if the response establishes a dialogue, and the CS-IBCF is configured to perform application level gateway and/or transport plane control functions, the CS-IBCF shall save the Contact, To and Record-Route header field values received in the response such that the CS-IBCF is able to release the session if needed. + +#### A.5.3.2 Subsequent requests + +Upon receipt of any request, the CS-IBCF shall: + +- 1) if the request is an INVITE request, then respond with a 100 (Trying) provisional response; +- 2) if the request is a target refresh request and the CS-IBCF is configured to perform application level gateway and/or transport plane control functions, save the Contact and Cseq header field values received in the request such that the CS-IBCF is able to release the session if needed; +- 3) if the subsequent request is other than a target refresh request (including requests relating to an existing dialogue where the method is unknown) and the CS-IBCF is configured to perform application level gateway and/or transport plane control functions, save the Contact and Cseq header field values received in the request such that the CS-IBCF is able to release the session if needed; + +- 4) if network topology hiding is required, then apply the procedures as described in clause A.5.3.4; +- 5) if screening of SIP signalling is required, apply the procedures as described in clause A.5.3.6. + +When the CS-IBCF receives a response to the subsequent request and network topology hiding is required, then the CS-IBCF shall apply the procedures as described in clause A.5.3.4. + +When the CS-IBCF receives a response to the subsequent request and screening of SIP signalling is required, then the CS-IBCF shall apply the procedures as described in clause A.5.3.6. + +### A.5.3.3 CS-IBCF-initiated call release + +If the CS-IBCF provides transport plane control functionality and receives an indication of a transport plane related error the CS-IBCF may: + +- 1) if the CS-IBCF has already sent an initial INVITE request to the terminating side, apply SIP procedures detailed in IETF RFC 3261 [20] to terminate any corresponding SIP dialogue(s) or otherwise cancel the INVITE at the terminating side, making use of CANCEL and/or BYE request(s), based on information saved for the related dialogue; and +- 2) if the CS-IBCF has not yet sent out a final response for the initial INVITE request, send an appropriate failure response for the initial INVITE request to the originating side; and +- 3) if the CS-IBCF has already sent out a final response for the initial INVITE request, generate a BYE request for the originating side based on the information saved for the related dialogue. + +NOTE 1: Transport plane related errors can be indicated from e.g. TrGW. + +NOTE 2: Since the CS-IBCF does not handle the encapsulated ISUP, the BYE message(s) generated by the CS-IBCF will not contain any encapsulated ISUP REL message. + +If the CS-IBCF is able to determine an appropriate Q.850 cause value, then this may be included in a Reason header in the BYE message(s). + +### A.5.3.4 THIG functionality in the CS-IBCF + +#### A.5.3.4.1 General + +The following procedures shall only be applied if network topology hiding is required by the network. The network requiring network topology hiding is called the hiding network. + +NOTE 1: Requests and responses are handled independently; therefore, no state information is needed for that purpose within a CS-IBCF. + +The CS-IBCF shall apply network topology hiding to all headers which reveal topology information, such as Via, Route, Record-Route, and Path. Therefore, the CS-IBCF shall + +- either act as a B2BUA, i.e. set above headers as defined for a SIP user agent client by IETF RFC 3261 [20], +- or as an option follow the procedures defined in A.5.3.4.2. + +The CS-IBCF shall not screen SIP parameters for which there is a related ISUP parameter defined within ITU-T Recommendation Q.1912.5 [6]. + +NOTE 2: SIP-I screening is normally done by the GMSC, where the encapsulated ISUP message and the SIP headers are consistently screened. + +Upon receiving an incoming initial request for which network topology hiding has to be applied and which includes a Record-Route header, the CS-IBCF shall add its own routable SIP URI to the top of the Record-Route header. + +#### A.5.3.4.2 Decryption for network topology hiding + +Upon receiving a request/response, incoming to the hiding network, the CS-IBCF shall perform the decryption for network topology hiding purposes, i.e. the CS-IBCF shall: + +- 1) identify hostnames encrypted by the network this CS-IBCF belongs to within all headers of the incoming message; +- 2) use those hostnames that carry the identification of the hiding network within the value of the "tokenized-by" parameter as input to decryption; +- 3) use as encrypted string the hostname which follows the sent-protocol (for Via Headers, e.g. "SIP/2.0/UDP") or the URI scheme (for Route and Record-Route Headers, e.g. "sip:"); +- 4) replace all content of the received header which carries encrypted information with the entries resulting from decryption. + +EXAMPLE: An encrypted entry to a Via header that looks like: + +``` +Via: SIP/2.0/UDP Token(SIP/2.0/UDP msc2.home1.net;lr, +SIP/2.0/UDP msc1.home1.net;lr);tokenized-by=home1.net +``` + +will be replaced with the following entries: + +``` +Via: SIP/2.0/UDP msc2.home1.net;lr, SIP/2.0/UDP msc1.home1.net;lr +``` + +NOTE: Motivations for these decryption procedures are e.g. to allow the correct routing of a response through the hiding network, to enable loop avoidance within the hiding network, or to allow the entities of the hiding network to change their entries within e.g. the Record-Route header. + +### A.5.3.5 ALG functionality in the CS-IBCF + +The CS-IBCF shall only apply the following procedures if application level gateway functionality is required by the network. + +The CS-IBCF acts as a B2BUA when it performs ALG functionality. The CS-IBCF, although acting as a UA, does not initiate any registration of its associated addresses. These are assumed to be known by peer-to-peer arrangements within the SIP-I based CS domain. + +When the CS-IBCF receives an initial INVITE request from another SIP network, the CS-IBCF shall generate a new initial INVITE request and forward it to the (G)MSC Server. + +The internal function of the CS-IBCF as an ALG is equal to that one defined in TS 29.162 [37]. + +### A.5.3.6 Screening of SIP-I signalling + +The text in clause A.5.2.6 applies without changes. + +### A.5.3.7 Void + +--- + +## A.6 Procedures at the CS-TrGW + +### A.6.1 Transport Plane Control procedures + +--- + +## A.7 CS-IBCF - CS-TrGW Interaction + +### A.7.1 General + +#### A.7.1.1 Network Model + +Figure A.7.1.1.1 shows the network model. The broken line represents the call control signalling. The dotted line represents the bearer control signalling (if applicable) and the user plane. The CS-IBCF uses one context with two + +terminations in the TrGW. The termination T1 is used towards the 3GPP PLMN and the bearer termination T2 is used for the bearer towards the external IP network. + +![Diagram of H.248 Context Model showing 3GPP PLMN, CS-IBCF, TrGW, and Ext Network components and their connections.](1ea7909aea2fb749a6fe98fbdb8cacae_img.jpg) + +The diagram illustrates the H.248 Context Model. It features four main components: '3GPP PLMN' on the left, 'CS-IBCF' at the top center, 'TrGW' at the bottom center, and 'Ext Network' on the right. A dashed green line connects the '3GPP PLMN' to the 'CS-IBCF'. A dashed red line connects the 'TrGW' to the 'Ext Network'. A solid blue vertical line connects the 'CS-IBCF' to the 'TrGW'. Inside the 'TrGW' box, there is a label 'CTXI' with two arrows pointing to 'T1' and 'T2'. The 'T1' termination is connected to the dashed red line towards the '3GPP PLMN', and the 'T2' termination is connected to the dashed red line towards the 'Ext Network'. + +Diagram of H.248 Context Model showing 3GPP PLMN, CS-IBCF, TrGW, and Ext Network components and their connections. + +Figure A.7.1.1.1: H.248 Context Model + +## A.7.1.2 Signalling flows + +### A.7.1.2.1 Basic Procedures + +#### A.7.1.2.1.1 Call Establishment + +Figure A.7.1.2.1.1.1 depicts the signalling flow for a call setup from external network towards 3GPP PLMN. The same signalling flow applies for a call setup from the 3GPP PLMN towards an external network with the exception that terminations T1 and T2 are then exchanged. + +![Sequence diagram showing the interaction between CS-TrGW and CS-IBCF for TrGW functionality. The diagram includes 16 steps: 1. SDP offer (IP2o, P2o) to CS-IBCF; 2. Use case X detected; 3. H.248 ADD req to CS-TrGW; 4. Create outgoing termination T1; 5. H.248 ADD resp; 6. Modify SDP offer; 7. SDP offer (IP1o, P1o) to network; 8. SDP answer (IP1a, P1a) from network; 9. H.248 MOD req to CS-TrGW; 10. Configure Outgoing Termination T1; 11. H.248 MOD Resp; 12. H.248 ADD req for T2; 13. Create incoming Termination T2; 14. H.248 ADD Resp; 15. Modify SDP answer; 16. SDP answer (IP2a, P2a) to network. Brackets on the right indicate phases: Reserve TrGW Connection Point, Configure TrGW Connection Point, and Reserve And Configure TrGW Connection Point.](3198cdf0dbe501c46fe0e4073c7d8451_img.jpg) + +``` + +sequenceDiagram + participant CS-TrGW + participant CS-IBCF + + Note over CS-IBCF: 1. SDP offer (IP2o, P2o) + Note right of CS-IBCF: 2. Use case X detected +that needs TrGW +functionality + CS-IBCF->>CS-TrGW: 3. H.248 ADD req +(C= ?, T= ?, LAddr=?, LPort=?) + Note left of CS-TrGW: 4. Create outgoing termination T1 + CS-TrGW->>CS-IBCF: 5. H.248 ADD resp. +(C=C1, T=T1, +LAddr=IP1o, LPort=P1o) + Note right of CS-IBCF: 6. Modify SDP offer + Note over CS-IBCF: 7. SDP offer (IP1o, P1o) + Note over CS-IBCF: 8. SDP answer (IP1a, P1a) + CS-IBCF->>CS-TrGW: 9. H.248 MOD req +(C= C1, T= T1, +RAddr=IP1a, RPort=P1a) + Note left of CS-TrGW: 10. Configure Outgoing Termination T1 + CS-TrGW->>CS-IBCF: 11. H.248 MOD Resp +(C= C1, T= T1) + CS-IBCF->>CS-TrGW: 12. H.248 ADD req +(C= C1, T= ?, LAddr=?, LPort=?, +RAddr=IP2o, RPort=P2o) + Note left of CS-TrGW: 13. Create incoming Termination T2 + CS-TrGW->>CS-IBCF: 14. H.248 ADD Resp +(C= C1, T= T2, +LAddr=IP2a, LPort=P2a, +RAddr=IP1a, RPort=P1a) + Note right of CS-IBCF: 15. Modify SDP answer + Note over CS-IBCF: 16. SDP answer (IP2a, P2a) + +``` + +Sequence diagram showing the interaction between CS-TrGW and CS-IBCF for TrGW functionality. The diagram includes 16 steps: 1. SDP offer (IP2o, P2o) to CS-IBCF; 2. Use case X detected; 3. H.248 ADD req to CS-TrGW; 4. Create outgoing termination T1; 5. H.248 ADD resp; 6. Modify SDP offer; 7. SDP offer (IP1o, P1o) to network; 8. SDP answer (IP1a, P1a) from network; 9. H.248 MOD req to CS-TrGW; 10. Configure Outgoing Termination T1; 11. H.248 MOD Resp; 12. H.248 ADD req for T2; 13. Create incoming Termination T2; 14. H.248 ADD Resp; 15. Modify SDP answer; 16. SDP answer (IP2a, P2a) to network. Brackets on the right indicate phases: Reserve TrGW Connection Point, Configure TrGW Connection Point, and Reserve And Configure TrGW Connection Point. + +1. The CS-IBCF receives an SDP offer in SIP signalling. +2. The CS-IBCF detects that one of the CS-TrGW functions is required, e.g. NAPT/NAT +3. The CS-IBCF sends a H.248 ADD command to create the outgoing termination and to request resources to execute CS-TrGW function +4. The CS-TrGW creates the outgoing termination +5. The CS-TrGW replies to CS-IBCF with a H.248 Add reply command and provides the local address and port of the outgoing termination +6. The CS-IBCF replaces the IP address inside the SDP using the information coming from CS-TrGW +7. SDP offer is sent to the network at the outgoing side +8. SDP answer is received by CS-IBCF + +9. The CS-IBCF sends a H.248 MOD command to configure the outgoing termination with Address and port information received in the SDP answer + 10. The CS-TrGW configures the outgoing termination + 11. The CS-TrGW replies to CS-IBCF with a H.248 MOD reply command + 12. The CS-IBCF sends a H.248 ADD command to create the incoming termination and to request resources to execute CS-TrGW function + 13. The CS-TrGW creates the incoming termination + 14. The CS-TrGW replies to the CS-IBCF with a H.248 Add reply command and provides the local address and port of the incoming termination. +- Note: Steps 12 to 14 may also be executed after step 2. +15. The CS-IBCF replaces the IP address inside the SDP using the information coming from CS-TrGW + 16. SDP answer is sent to the network at the incoming side + +**Figure A.7.1.2.1.1.1: CS-IBCF and CS-TrGW interaction at Call establishment** + +When creating the termination T1, the CS-IBCF may also indicate that the IP Interface type is "NboIP". + +When creating the termination T2, the CS-IBCF may also indicate that the IP Interface type is "ExtSIPI". + +NOTE: The IP Interface Type allows the CS-TrGW to collect statistics per interface type associated with the RTP bearer termination as required by TS 32.407 [44]. The provision of these statistics is outside of the scope of this specification. + +### A.7.1.2.1.2 Call Release + +Figure A.7.1.2.1.2.1 depicts the signalling flow for a call release. + +![Sequence diagram showing the interaction between CS-TrGW and CS-IBCF for call release. The process starts with an event causing release at CS-IBCF, followed by H.248 SUB requests and responses for outgoing and incoming terminations.](a70e0adcabc973b01b413b6a141884f3_img.jpg) + +``` + +sequenceDiagram + participant CS-IBCF + participant CS-TrGW + Note right of CS-IBCF: 1. Event causing release + CS-IBCF->>CS-TrGW: 2. H.248 SUB req (C=C1, T=T1) + Note left of CS-TrGW: 3. Destroy outgoing termination T1 + CS-TrGW-->>CS-IBCF: 4. H.248 SUB resp. (C=C1, T=T1) + Note right of CS-IBCF: Release TrGW Termination + CS-IBCF->>CS-TrGW: 5. H.248 SUB req (C=C1, T=T2) + Note left of CS-TrGW: 6. Destroy incoming termination T2 + CS-TrGW-->>CS-IBCF: 7. H.248 SUB resp. (C=C1, T=T2) + Note right of CS-IBCF: Release TrGW Termination + +``` + +Sequence diagram showing the interaction between CS-TrGW and CS-IBCF for call release. The process starts with an event causing release at CS-IBCF, followed by H.248 SUB requests and responses for outgoing and incoming terminations. + +1. The CS-IBCF identifies that the call is to be released. Typically this will be by the receipt of a SIP BYE request. +2. The CS-IBCF sends a H.248 SUB command to release the outgoing termination +3. The CS-TrGW destroys the outgoing termination +4. The CS-TrGW replies to CS-IBCF with a H.248 Sub reply command +5. The CS-IBCF sends a H.248 SUB command to release the incoming termination +6. The CS-TrGW destroys the incoming termination +7. The CS-TrGW replies to CS-IBCF with a H.248 Sub reply command + +Note 1: Steps 5 to 7 may also be executed before steps 2 to 4 or in parallel with steps 2 to 4. + +Note 2: Rather than releasing the two terminations separately, the CS-IBCF may request the CS-TrGW to release both terminations in a single request. + +**Figure A.7.1.2.1.2.1: CS-IBCF and CS-TrGW interaction at Call release** + +### A.7.1.2.2 Specific Use Cases + +#### A.7.1.2.2.1 CS-IBCF as Entry Point, Call Establishment with IP Version Interworking + +This case considers the call establishment message flow for the CS-IBCF and CS-TrGW, when the CS-IBCF is acting as an Entry point and IP version interworking is required. The example assumes that the external SIP-I network uses IPv4 addressing and the CS CN uses IPv6 addressing. + +With reference to the steps in figure A.7.1.2.1.1.1, the following additions are required, specific to this use case: + +3. The CS-IBCF requests the CS-TrGW to choose an IPv6-based local connection address for the created outgoing termination. + +5. The local address and port returned to the CS-IBCF are IPv6-based. +6. Specifically, the IPv6 address and port number received from the CS-TrGW in the local connection address of the outgoing termination replace the IPv4 address and port number received from the external SIP-I network. +9. Specifically, the CS-IBCF passes the IPv6 address and port number received in the SDP answer to the CS-TrGW as the remote connection address on the outgoing termination. +12. The CS-IBCF requests the CS-TrGW to choose an IPv4-based local connection address on the incoming termination. The CS-IBCF uses the IPv4 addresses and port numbers received in the initial SDP offer as the remote connection address on the incoming termination. +14. The local address and port returned to the CS-IBCF are IPv4-based. +15. Specifically, the IPv4 address and port number received from the CS-TrGW in the local connection address of the incoming termination replace the IPv6 address and port number received from the CS-CN. + +#### A.7.1.2.2.2 Hanging Termination Detection + +This clause considers the message flow for the CS-IBCF and CS-TrGW, when IP hanging termination detection is required. Hanging termination detection procedure allows the CS-IBCF to detect a hanging context and termination in the TrGW resulting, for example, from a loss of communication between the CS-IBCF and the CS-TrGW. + +When the CS-IBCF requests the CS-TrGW to reserve terminations, the CS-IBCF shall also request the CS-TrGW to periodically report termination heartbeat indications. If the CS-IBCF includes an indication of the periodicity of the termination heartbeat notifications, the specified period shall be much greater than the mean call holding time. + +The CS-IBCF and the CS-TrGW shall support detection of hanging terminations. + +The call is established as described in clause A.7.1.2.1.1. With reference to the steps in figure A.7.1.2.1.1, the following additions are required, specific to this use case: + +3. The CS-IBCF requests the CS-TrGW to send termination heartbeat notifications for the created termination. It may also include an indication of the periodicity of the termination heartbeat notifications. +12. The CS-IBCF requests the CS-TrGW to send termination heartbeat notifications for the created termination. It may also include an indication of the periodicity of the termination heartbeat notifications. + +Subsequently, the CS-TrGW shall periodically send termination heartbeat notifications, as shown in figure A.7.1.2.2.2.1, until the call is released. + +When the CS-IBCF receives a termination heartbeat notification from the CS-TrGW via the Termination heartbeat - Indication procedure, the CS-IBCF shall return a Termination heartbeat -Indication Ack (without an error) if the context id / termination identity combination exists in the CS-IBCF. If this combination does not exist, the CS-IBCF shall return an error and shall correct the mismatch, for example by requesting the CS-TrGW to subtract the indicated termination and to clear any associated context. + +![Sequence diagram showing the interaction between CS-TrGW and CS-IBCF for termination heartbeat notifications. The CS-TrGW sends a 'Termination Heartbeat Indication' message to the CS-IBCF, and the CS-IBCF responds with a 'Termination Heartbeat Indication Ack' message.](99781d878388c3e0f359b1d6ce14119c_img.jpg) + +``` +sequenceDiagram + participant CS-TrGW + participant CS-IBCF + Note left of CS-TrGW: CS-IBCF requests heartbeat notifications + CS-TrGW->>CS-IBCF: Termination Heartbeat Indication + CS-IBCF-->>CS-TrGW: Termination Heartbeat Indication Ack +``` + +Sequence diagram showing the interaction between CS-TrGW and CS-IBCF for termination heartbeat notifications. The CS-TrGW sends a 'Termination Heartbeat Indication' message to the CS-IBCF, and the CS-IBCF responds with a 'Termination Heartbeat Indication Ack' message. + +**Figure A.7.1.2.2.2.1: CS-IBCF and CS-TrGW interaction for termination heartbeat notifications** + +#### A.7.1.2.2.3 Gate Management + +This clause considers the message flow for the CS-IBCF and CS-TrGW, when the CS-IBCF is acting as an Entry point and remote source address filtering is required for the termination towards the external SIP-I network. + +Gate Management shall be a mandatory feature of the CS-TrGW, but an optional feature of the CS-IBCF. + +As a security related option, on request from the CS-IBCF, filtering may be enabled to check/validate the source address or source address and port number of incoming packets from the external network. If the CS-IBCF requests address filtering, it may additionally provide an address specification, which may identify either a single address or a range of addresses, against which filtering is to be performed. The absence of such an address specification in the request implicitly requests filtering against the IP address of the remote connection address. In addition to address filtering, the CS-IBCF may also request port filtering. If the CS-IBCF requests port filtering, it may additionally include either a port or a range of ports, against which filtering is to be performed. The absence of a port specification in the request implicitly requests filtering against the port of the remote connection address. + +If the CS-TrGW is configured to apply source IP address and possibly source port filtering, it shall only pass incoming IP packets from the identified source, and discard IP packets from other sources. + +The call is established as described in clause A.7.1.2.1.1. With reference to the steps in figure A.7.1.2.1.1.1, the following additions are required, specific to this use case: + +12. If remote source address filtering is required for the created termination, then the CS-IBCF includes the information element "Remote source address filtering" in the request sent to the CS-TrGW. In addition, it may also include the information element "Remote source address mask". + +If remote source port filtering is required for the created termination (in addition to remote source address filtering), then the CS-IBCF includes the information element "Remote source port filtering" in the request sent to the CS-TrGW. It may also include one of the information elements "Remote source port" or "Remote source port range". + +Subsequently, the CS-TrGW applies filtering as requested to the packets arriving from the external network. Any packet arriving, which does not meet the filtering requirement, is discarded. + +#### A.7.1.2.2.4 QoS Packet Marking + +This clause considers the message flow for the CS-IBCF and CS-TrGW, when the CS-IBCF requires the use of differentiated services (see IETF RFC 2474 [41]). + +It is optional for the CS-IBCF to support differentiated service controlled over the Ix Interface. It shall be mandatory for the CS-TrGW to support differentiated service controlled over the Ix Interface. A CS-TrGW can also support DiffServ Code Point marking based on local configuration. The CS-IBCF may request the CS-TrGW to set diffserv codepoints for outgoing packets on a termination. The CS-IBCF may either indicate the applicable DSCP value or configure the TrGW to copy the DSCP value in the corresponding received packet. When the CS-IBCF requests the CS-TrGW to create a termination and if differentiated services are required for the created termination, the CS-IBCF shall include the information elements "DiffServ Code Point" and/or "DiffServ Tagging Behaviour" in the request sent to the CS-TrGW. + +The call is established as described in clause A.7.1.2.1.1. With reference to the steps in figure A.7.1.2.1.1.1, the following additions are required, specific to this use case: + +3. If differentiated services are required for the created termination, then the CS-IBCF includes the information elements "DiffServ Code Point" and/or "DiffServ Tagging Behaviour" in the request sent to the CS-TrGW. +12. If differentiated services are required for the created termination, then the CS-IBCF includes the information elements "DiffServ Code Point" and/or "DiffServ Tagging Behaviour" in the request sent to the CS-TrGW. + +Subsequently, for all egress packets, the CS-TrGW shall set the DiffServ Code Point in the IP header as specified by the CS-IBCF: + +- If the DiffServ Tagging Behaviour information element was received with a value to indicate that the DiffServ Code Point should be copied, then the CS-TrGW shall copy the DiffServ Code Point in the IP header of the egress packet from the ingress packet. +- If the DiffServ Tagging Behaviour information element was not received, or was received with a value to indicate that the DiffServ Code Point should be set to a specific value, then: + +- If the DiffServ Code Point information element was received, then the CS-TrGW shall set the DiffServ Code Point in the IP header of the egress packet to the value received in the DiffServ Code Point information element. +- If the DiffServ Code Point information element was not received, then the CS-TrGW may set the DiffServ Code Point in the IP header of the egress packet to a configured default value. + +#### A.7.1.2.2.5 IP Realms + +This clause considers the message flow for the CS-IBCF and CS-TrGW, when the two networks are in different IP realms. IP realms are described in TS 23.205 [9] clause 20. + +The CS-IBCF and the CS-TrGW shall support IP realm indication. + +The call is established as described in clause A.7.1.2.1.1.1. With reference to the steps in figure A.7.1.2.1.1.1, the following additions are required, specific to this use case: + +3. The CS-IBCF may specify the required IP Realm. +4. The CS-TrGW allocates resources from the appropriate IP realm as specified by the CS-IBCF in step 3. +12. The CS-IBCF may specify the required IP Realm. +13. The CS-TrGW allocates resources from the appropriate IP realm as specified by the CS-IBCF in step 12. + +If there is a change in the IP Realms that are available or if they are modified in the CS-TrGW then the CS-TrGW shall inform the CS-IBCF via the IP Realm Availability Procedure (see clause A.7.2.3), if this procedure is supported by the CS-TrGW. The basic flow is depicted in figure A.7.1.2.2.5.1 + +![Sequence diagram showing the IP Realm Availability procedure between CS-TrGW and CS-IBCF.](747516f5861a0ddf31e3851da8e34b95_img.jpg) + +``` +sequenceDiagram + participant CS-TrGW + participant CS-IBCF + Note left of CS-TrGW: IP Realm Availability Indication + CS-TrGW->>CS-IBCF: IP Realm Availability Indication + Note right of CS-IBCF: IP Realm Availability Indication Ack + CS-IBCF->>CS-TrGW: IP Realm Availability Indication Ack +``` + +The diagram illustrates a sequence of messages between two entities, CS-TrGW and CS-IBCF. It starts with a message labeled 'IP Realm Availability Indication' sent from CS-TrGW to CS-IBCF. Following this, a return message labeled 'IP Realm Availability Indication Ack' is sent from CS-IBCF back to CS-TrGW. + +Sequence diagram showing the IP Realm Availability procedure between CS-TrGW and CS-IBCF. + +**Figure A.7.1.2.2.5.1: IP Realm Availability** + +The monitoring of IP realm availability is optional and if supported by the CS-TrGW may be requested by the CS-IBCF. + +#### A.7.1.2.2.6 Media Inactivity Detection + +The CS- TrGW and the CS-IBCF may support the detection of inactive media flows. + +The CS-IBCF may request a CS-TrGW that supports media inactivity detection to detect if a media flow is inactive. + +- NOTE: The decision to apply or not to apply media inactivity detection is general for all sessions with the same media characteristics (i.e. not user specific). Detailed conditions when media inactivity detection can be requested are not specified in the present release. + +When the CS-IBCF requests the CS-TrGW to reserve transport addresses/resources, the CS-IBCF may indicate to the CS-TrGW that detection of an inactive media flow is required and may additional specify inactivity detection time and inactivity detection direction. The IBCF may request the detection of media inactivity on a termination or a stream basis. + +The call is established as described in clause A.7.1.2.1.1.1. With reference to the steps in figure A.7.1.2.1.1.1, the following additions are required, specific to this use case: + +3. The CS-IBCF indicates to the CS-TrGW that detection of an inactive media flow is required and can additional specify inactivity detection time and inactivity detection direction. + +12. The CS-IBCF indicates to the CS-TrGW that detection of an inactive media flow is required and can additional specify inactivity detection time and inactivity detection direction. + +The CS- TrGW shall determine a media flow to be inactive if there is no media sent and/or received within the inactivity detection time period. + +When the CS-IBCF receives a notification of inactive media from the CS-TrGW via the Media Inactivity Notification procedure, the CS-IBCF shall return a Media Inactivity Notification Ack and shall take appropriate action (e.g. release the termination). + +![Sequence diagram showing Media Inactivity Notification between IBCF and TrGW. The IBCF sends a 'Media Inactivity Notification' message to the TrGW, and the TrGW responds with a 'Media Inactivity Notification - Ack' message.](86bd357c573c9696393f5bde4d4cce4f_img.jpg) + +``` + +sequenceDiagram + participant IBCF + participant TrGW + Note left of IBCF: IBCF + Note right of TrGW: TrGW + TrGW->>IBCF: Media Inactivity Notification + IBCF->>TrGW: Media Inactivity Notification - Ack + +``` + +Sequence diagram showing Media Inactivity Notification between IBCF and TrGW. The IBCF sends a 'Media Inactivity Notification' message to the TrGW, and the TrGW responds with a 'Media Inactivity Notification - Ack' message. + +**Figure A.7.1.2.2.6.1: Media Inactivity Notification** + +#### A.7.1.2.2.7 RTCP Handling + +The CS-IBCF and the CS-TrGW shall support control via the Ix interface of the specific RTCP behaviour associated to an RTP flow. + +When the CS-IBCF requests the CS-TrGW to reserve transport addresses/resources for an RTP flow, the CS-IBCF may indicate to the CS-TrGW whether to reserve corresponding RTCP resources should also request the CS-TrGW to reserve resources for the corresponding RTCP flow, but may alternatively request the CS-TrGW not to reserve resources for the corresponding RTCP flow. When the CS-IBCF requests the CS-TrGW to reserve transport addresses/resources for a non-RTP flow, the CS-IBCF shall not request the CS-TrGW to reserve resources for an RTCP flow. + +To request the CS-TrGW to reserve resources for an RTCP flow, the CS-IBCF shall provide the RTCP handling information element with a value indicating that resources for RTCP shall be reserved. + +To request the CS-TrGW not to reserve resources for an RTCP flow, the CS-IBCF shall either provide the RTCP handling information element with a value indicating that resources for RTCP shall not be reserved or omit the RTCP handling information element. + +If the CS-TrGW receives the indication to reserve RTCP resources, the TrGW shall allocate a local port with even number for an RTP flow also reserve the consecutive local port with odd number for the associated RTCP flow, and it shall send and be prepared to receive RTCP. + +If the CS-TrGW receives the indication to not reserve RTCP resources, or does not receive any indication, it shall not allocate an RTCP port when allocating a port for an RTP flow. The CS-TrGW shall not send any RTCP packets and shall silently discard any received RTCP packets. + +When RTCP resources are requested, the CS-IBCF may also specify: + +- the remote RTCP port, and optionally the remote address, where to send RTCP packets; if not specified, the CS-TrGW shall send RTCP packets to the port contiguous to the remote RTP port; +- bandwidth allocation requirements for RTCP, if the RTCP bandwidth level for the session is different than the default RTCP bandwidth as specified in RFC 3556 [39]. + +NOTE: In line with the recommendations of RFC 3605 [40], separate address or non-contiguous RTCP port numbers will not be allocated by the TrGW. + +The CS-TrGW shall return an error if it can not allocate the requested RTCP resources. + +The call is established as described in clause A.7.1.2.1.1. With reference to the steps in figure A.7.1.2.1.1.1, the following additions are required, specific to this use case: + +3. The CS-IBCF may specify if RTCP handling is required. +4. The CS-TrGW allocates RTCP resources as specified by the CS-IBCF in step 3. +12. The CS-IBCF may specify if RTCP handling is required. +13. The CS-TrGW allocates RTCP as specified by the CS-IBCF in step 12. + +#### A.7.1.2.2.8 Bandwidth Policing + +##### A.7.1.2.2.8.1 Overview + +The CS-IBCF may support traffic policing of incoming media flows. + +The CS-TrGW shall support traffic policing of the maximum average bitrate, defined as sustainable data rate (see IETF RFC 2216 [42]) of incoming media flows and may support traffic policing of the peak data rate of incoming media flows. + +The CS-IBCF may require the CS-TrGW to police the media flows to ensure that they conform to the expected data rates. + +When the CS-IBCF requests the CS-TrGW to reserve transport addresses/resources, the CS-IBCF may indicate to the CS-TrGW that policing of the related media streams is required and provide traffic policing related parameters as detailed in clause A.7.1.2.2.8.2. + +If such policing is requested, the CS-TrGW shall police the corresponding media streams as detailed in clause A.7.1.2.2.8.2, by measuring the data rate for the received packets within that media stream. If the permissible data rate provided by the CS-IBCF is exceeded, the CS-TrGW shall discard packets to reduce their data rate to the permissible data rate. + +##### A.7.1.2.2.8.2 Bandwidth policing procedures + +The call is established as described in clause A.7.1.2.1.1. With reference to the steps in figure A.7.1.2.1.1.1, the following additions are required, specific to this use case: + +3. If traffic policing is required for the created termination, then the CS-IBCF shall include the information element "Traffic Policing Required" in the request sent to the CS-TrGW. If policing of sustainable data rate is required, then the CS-IBCF shall include the information elements "Sustainable Data Rate" and "Maximum Burst Size" in the request. If policing of peak data rate is required, then the CS-IBCF shall include the information element "Peak Data Rate" in the request and may additionally include the information element "Delay Variation Tolerance". +12. If traffic policing is required for the created termination, then the CS-IBCF shall include the information element "Traffic Policing Required" in the request sent to the CS-TrGW. If policing of sustainable data rate is required, then the CS-IBCF shall include the information elements "Sustainable Data Rate" and "Maximum Burst Size" in the request. If policing of peak data rate is required, then the CS-IBCF shall include the information element "Peak Data Rate" in the request and may additionally include the information element "Delay Variation Tolerance". + +When requested by the CS-IBCF, the CS-TrGW shall police the media stream flow rates according to one or more of the following media policing(s), in accordance with IETF RFC 2216 [42]. + +The following media policing shall be supported at the CS-TRGW: + +- **Sustainable Data Rate (SDR) Policing:** + +To request policing of the sustainable data rate of a media stream, the CS-IBCF shall request media policing for that media stream and shall provide the sustainable data rate, and shall provide a maximum burst size (MBS) indicating the expected maximum size of packet bursts for that media stream. The CS-TrGW shall then measure the data rate for the received packets within that media stream as per IETF RFC 2216 [42] for "Token Bucket", where $r$ =SDR and $b$ =MBS. If the permissible sustainable data rate is exceeded, the CS-TRGW shall discard packets to reduce the data rate to the permissible sustainable data rate. + +NOTE 1: The CS-IBCF can derive the sustainable data rate from bandwidth parameters if it receives them within an SDP description. + +The following media policing may be supported in addition at the CS-TRGW; if supported, then the following applies: + +- **Peak Data Rate Policing:** + +To request policing of the peak data rate of a media stream, the CS-IBCF shall request media policing for that media stream and shall provide the peak data rate, and may provide a Delay Variation Tolerance indicating the expected maximum delay variation due to jitter for that media stream. The CS-TRGW shall then measure the data rate for the received packets within that media stream. If the permissible peak data rate is exceeded, the CS-TRGW shall discard packets to reduce the data rate to the permissible peak data rate. If both peak data rate and sustainable data rate have been provided for the same media stream, the CS-TRGW shall discard packets to reduce the data rate to the permissible peak data rate and should discard packets to reduce the data rate to the permissible sustainable data rate. + +NOTE 2: The decision to apply or not traffic policing is general for all sessions with the same media characteristics (i.e. not user specific). The conditions which media policings to apply are beyond the scope of the specification. This can be based on the media characteristics of the session (e.g. media type). + +#### A.7.1.2.2.9 Through-Connection + +The Change Through-Connection procedure is mandatory for CS-IBCF and CS-TrGW to support. + +The CS-IBCF sets the Stream mode parameter using the Change Through-Connection procedure to request the CS-TrGW to both-way or one-way through-connect or block media streams on a termination. + +The CS-IBCF may combine the Change Through-Connection procedure with the Reserve and Configure TrGW Connection Point, Reserve TrGW Connection Point or Configure TrGW Connection Point procedure in figure A.7.1.2.1.1.1., or may apply this procedure separately. + +#### A.7.1.2.2.10 Emergency Call + +This procedure is identical to that of clause A.7.1.2.1.1 apart from the CS-IBCF requesting the CS-TrGW to treat the call as emergency call with a preferential handling by including the information element "Emergency Call Indicator" when creating a context within the "Reserve and Configure TrGW Connection Point" or "Reserve TrGW Connection Point" procedure. + +With reference to the steps in figure A.7.1.2.1.1.1, the following additions are required, specific to this use case: + +3. If step 3 is performed before step 13, the CS-IBCF requests the CS-TrGW to handle the call as emergency call by including the "Emergency Call Indicator". +13. If step 13 is performed before step 3, the CS-IBCF requests the CS-TrGW to handle the call as emergency call by including the "Emergency Call Indicator". + +#### A.7.1.2.2.11 Interactive Connectivity Establishment + +The CS-IBCF and the CS-TrGW may support ICE functionality as specified in IETF RFC 5245 [56] and TS 24.229 [12]. + +Support of full ICE functionality is optional, but if ICE is supported, the CS-IBCF and the CS-TrGW shall at least support ICE lite as specified in IETF RFC 5245 [56]. + +The requirements as described in TS 29.162 [37] for IBCF and TrGW, apply to the CS-IBCF and the CS-TrGW when the ICE procedures are supported. + +#### A.7.1.2.2.12 SDP Capability Negotiation (SDPCapNeg) + +The SDP Capability Negotiation (SDPCapNeg) as specified in IETF RFC 5939 [57] is adopted as an optional functionality to negotiate capabilities and their associated configurations according to 3GPP TS 24.229 [12]. + +The requirements and procedures as described in subclause 10.2.24 of 3GPP TS 29.162 [37] for IBCF and TrGW, apply to the CS-IBCF and the CS-TrGW when SDPCapNeg is used. + +## A.7.2 Ix Signalling Procedures + +### A.7.2.1 Introduction + +This clause describes the logical signalling procedures (i.e. message identifiers are not part of the protocol) between the CS-IBCF and CS-TrGW. The procedures within this clause are intended to be implemented using the standard H.248 procedure as defined in ITU-T Recommendation H.248.1 [33] with appropriate parameter combinations. + +### A.7.2.2 Call Related Procedures + +#### A.7.2.2.1 Reserve TrGW Connection Point + +This procedure is used to reserve a termination at the CS-TrGW. + +**Table A.7.2.2.1.1: Reserve TrGW Connection Point** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|-------------------------------|-----------|----------------------------------|------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Reserve TrGW Connection Point | CS-IBCF | Context/Context Request | M | This information element indicates the existing context or requests a new context for the bearer termination. | +| | | Emergency Call Indicator | O | This information element identifies the call as emergency call that requires a preferential handling. | +| | | Termination Request | M | This information element requests a new termination for the bearer to be established. | +| | | IP Interface | O | This information element specifies the type of external interface to be used for the IP termination (e.g. ExtSIPI, NboIP). | +| | | Local IP Resources | O | This information element indicates the resource(s) (e.g. codec, auxiliary payload types) for which the CS-TrGW shall be prepared to receive user data. | +| | | ReserveValue | C | This information element indicates if multiple local resources are to be reserved.
This information element shall be included if a speech codec and auxiliary payload types are configured. | +| | | Local Connection Address Request | M | This information element requests an IP address and port number on the CS-TrGW that the remote end can send user plane data to. | +| | | Notify termination heartbeat | M | This information element requests termination heartbeat indications and may specify their periodicity. | +| | | Notify Released Bearer | O | This information element requests a notification of a released bearer. | +| | | IP Realm Identifier | O | This information element indicates the IP realm of the IP termination. | +| | | IP Version | C | This information element indicates the version of the internet protocol to be applied at the termination for the user plane. This is required for IP address translation. | +| | | DiffServ Code Point | O | This information element indicates a specific DiffServ code point to be used in the IP header in packets sent on the IP termination. | +| | | DiffServ Tagging Behaviour | O | This information element indicates whether the Diffserv code point in the IP header in packets sent on the IP termination should be copied from the received value or set to a specific value. | +| | | Remote Source Address Filtering | O | This information element indicates that remote source address filtering is required. | +| | | Remote Source Address Mask | C | This information element provides information on the valid remote source addresses. This may be included if remote source address filtering is included. It shall not be included if remote source address filtering is not included. | +| | | Remote Source Port Filtering | O | This information element indicates that remote source port filtering is required. | + +| | | | | | +|-----------------------------------|---------|-------------------------------------|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | Remote Source Port | C | This information element identifies the valid remote source port. This may be included if remote source port filtering is included. It shall not be included if remote source port filtering is not included. (NOTE 1) | +| | | Remote Source Port Range | C | This information element identifies a range of valid remote source ports. This may be included if remote source port filtering is included. It shall not be included if remote source port filtering is not included. (NOTE 1) | +| | | Media Inactivity Detection Required | O | This information element indicates that detection of inactive media flows is required. | +| | | Inactivity Detection Time | C | This information element may be present if Inactive Media Detection is required and specifies the Inactivity Detection time. | +| | | Inactivity Detection Direction | C | This information element may be present if Inactive Media Detection is required and specifies the Inactivity Detection direction. | +| | | RTCP handling | O | Indicates whether or not the CS-TrGW shall reserve a port for an RTCP flow. | +| | | Traffic Policing Required | O | This information element indicates that policing of the media flow is required. | +| | | Peak Data Rate | O | This information element may be present if Policing is required and specifies the permissible peak data rate for a media stream. (NOTE 2) | +| | | Sustainable Data Rate | O | This information element may be present if Policing is required and specifies the permissible sustainable data rate for a media stream. (NOTE 2) | +| | | Delay Variation Tolerance | O | This information element may be present if Policing on Peak Data Rate is required and specifies the maximum expected delay variation tolerance for the corresponding media stream. | +| | | Maximum Burst Size | C | This information element shall be present if Policing on Sustainable Data Rate is required and specifies the maximum expected burst size for the corresponding media stream. | +| | | ICE password request | O | This information element is present if CS-IBCF requests an ICE password. | +| | | ICE Ufrag request | O | This information element is present if CS-IBCF requests an ICE ufrag. | +| | | ICE host candidate request | O | This information element is present if CS-IBCF requests an ICE host candidate. | +| | | STUN server request | O | This information element is present if CS-IBCF requests the CS-TrGW to answer STUN connectivity checks for ICE. | +| | | SDPCapNeg configuration | O | This information element provides SDPCapNeg configuration(s) using as "a=acap", "a=tcap", "a=pcfg" and "a=acfg" SDP attributes. | +| Reserve TrGW Connection Point Ack | CS-TrGW | Context | M | This information element indicates the context where the command was executed. | +| | | Termination | M | This information element indicates the termination where the command was executed. | + +| | | | | | +|---------------------------------------------------------------------------------|--|--------------------------|---|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | Local IP Resources | C | This information element indicates the resources that the CS-TrGW has reserved to receive the user plane data from the remote peer. This IE shall be present if it was contained in the request. If the IE was not contained in the request, it may be present in the reply. | +| | | Local Connection Address | M | This information element indicates the IP address and port on the CS-TrGW that shall receive user plane data from the remote peer. | +| | | ICE password | C | This information element shall be present only if it was contained in the request. It indicates the ICE password assigned by the CS-TrGW. | +| | | ICE Ufrag | C | This information element shall be present only if it was contained in the request. It indicates the ICE Ufrag assigned by the CS-TrGW. | +| | | ICE host candidate | C | This information element shall be present only if it was contained in the request. It indicates the ICE host candidate assigned by the CS-TrGW. | +| | | ICE lite indication | C | This information element shall be present only if an ICE host candidate request was contained in the request, and the CS-IBCF supports ICE lite, but not full ICE. It indicates that the CS-TrGW only supports ICE lite. | +| | | SDPCapNeg configuration | C | This information element shall be present only if it was contained in the request. It provides SDPCapNeg configuration(s) using as "a=acap", "a=tcap", "a=pcfg" and "a=acfg" SDP attributes. | +| NOTE 1: Remote Source Port and Remote Source Port Range are mutually exclusive. | | | | | +| NOTE 2: At least one of these IEs shall be present when policing is required. | | | | | + +#### A.7.2.2.2 Configure TrGW Connection Point + +This procedure is used to configure or reconfigure a termination at the CS-TrGW. + +**Table A.7.2.2.2.1: Configure TrGW Connection Point** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|---------------------------------|-----------|-------------------------------------|------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Configure TrGW Connection Point | CS-IBCF | Context | M | This information element indicates the existing context. | +| | | Termination | M | This information element indicates the existing bearer termination. | +| | | IP Interface | O | This information element specifies the type of external interface to be used for the IP termination (e.g. ExtSIPI, NboIP). | +| | | Local IP Resources | O | This information element indicates the resources (e.g. codec, auxiliary payload types) that the CS-TrGW may use on the reception of user plane data. | +| | | Remote IP Resources | O | This information element indicates the resources (e.g. codec, auxiliary payload types) that the CS-TrGW may send user plane data to. | +| | | Local Connection Address | O | This information element indicates the IP address and port on the CS-TrGW that the remote peer can send user plane data to. | +| | | Remote Connection Address | O | This information element indicates the IP address and port that the CS-TrGW can send user plane data to. | +| | | Reserve Value | O | This information element indicates if multiple resources are to be reserved. | +| | | Notify termination heartbeat | O | This information element requests termination heartbeat indications and may specify their periodicity. | +| | | DiffServ Code Point | O | This information element indicates a specific DiffServ code point to be used in the IP header in packets sent on the IP termination. | +| | | DiffServ Tagging Behaviour | O | This information element indicates whether the Diffserv code point in the IP header in packets sent on the IP termination should be copied from the received value or set to a specific value. | +| | | Remote Source Address Filtering | O | This information element indicates that remote source address filtering is required. | +| | | Remote Source Address Mask | C | This information element provides information on the valid remote source addresses. This may be included if remote source address filtering is included. It shall not be included if remote source address filtering is not included. | +| | | Remote Source Port Filtering | O | This information element indicates that remote source port filtering is required. | +| | | Remote Source Port | C | This information element identifies the valid remote source port. This may be included if remote source port filtering is included. It shall not be included if remote source port filtering is not included. (NOTE 1) | +| | | Remote Source Port Range | C | This information element identifies a range of valid remote source ports. This may be included if remote source port filtering is included. It shall not be included if remote source port filtering is not included. (NOTE 1) | +| | | Media Inactivity Detection Required | O | This information element indicates that detection of inactive media flows is required. | + +| | | | | | +|-------------------------------------|---------|--------------------------------------|---|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | Inactivity Detection Time | C | This information element may be present if Inactive Media Detection is required and specifies the Inactivity Detection time. | +| | | Inactivity Detection Direction | C | This information element may be present if Inactive Media Detection is required and specifies the Inactivity Detection direction. | +| | | RTCP handling | O | Indicates whether or not the CS-TrGW shall reserve a port for an RTCP flow. | +| | | Traffic Policing Required | O | This information element indicates that policing of the media flow is required. | +| | | Peak Data Rate | O | This information element may be present if Policing is required and specifies the permissible peak data rate for a media stream.(NOTE 2) | +| | | Sustainable Data Rate | O | This information element may be present if Policing is required and specifies the permissible sustainable data rate for a media stream.(NOTE 2) | +| | | Delay Variation Tolerance | O | This information element may be present if Policing on Peak Data Rate is required and specifies the maximum expected delay variation tolerance for the corresponding media stream. | +| | | Maximum Burst Size | C | This information element shall be present if Policing on Sustainable Data Rate is required and specifies the maximum expected burst size for the corresponding media stream. | +| | | ICE Connectivity Check | C | This information element requests the CS-TrGW to perform ICE connectivity check as defined by IETF RFC 5245 [ab]. It is only applicable for full ICE. | +| | | Notify ICE Connectivity Check Result | C | This information element requests a notification of ICE connectivity check result. It is only applicable for full ICE. | +| | | Notify New Peer Reflexive Candidate | C | This information element requests a notification of new peer reflexive candidate was discovered during a connectivity check. It is only applicable for full ICE. | +| | | Additional ICE Connectivity Check | C | This information element requests the CS-TrGW to perform additional ICE connectivity check as defined by IETF RFC 5245 [ab]. It is only applicable for full ICE. | +| | | ICE received candidate | O | This information element is present if CS-IBCF indicates a received candidate for ICE. | +| | | ICE received password | O | This information element is present if CS-IBCF indicates a received password for ICE. | +| | | ICE received Ufrag | O | This information element is present if CS-IBCF indicates a received Ufrag for ICE. | +| Configure TrGW Connection Point Ack | CS-TrGW | SDPCapNeg configuration | O | This information element provides SDPCapNeg configuration(s) using as "a=acap", "a=tcap", "a=pcfg" and "a=acfg" SDP attributes. | +| | | Context | M | This information element indicates the context where the command was executed. | +| | | Termination | M | This information element indicates the termination where the command was executed. | + +| | | | | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------|--|---------------------------|---|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | Local IP Resources | O | This information element indicates the resources that the CS-TrGW has reserved to receive the user plane data from the far end. | +| | | Remote IP Resources | O | This information element indicates the resource (i.e. codec) that the CS-TrGW shall use to send user data to. | +| | | Local Connection Address | O | This information element indicates the IP address and port on the CS-TrGW that the remote end can send user plane data to. | +| | | Remote Connection Address | O | This information element indicates the IP address and port that the CS-TrGW can send user plane data to. May be present only if corresponding IE is present in the request. | +| NOTE 1: Remote Source Port and Remote Source Port Range are mutually exclusive.
NOTE 2: At least one of these IEs shall be present when policing is required. | | | | | + +### A.7.2.2.3 Reserve and Configure TrGW Connection Point + +This procedure is used to reserve and configure multimedia-processing resources for a termination at the CS-TrGW. + +**Table A.7.2.2.3.1: Reserve and Configure TrGW Connection Point** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|---------------------------------------------|-----------|----------------------------------|------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Reserve and Configure TrGW Connection Point | CS-IBCF | Context/Context Request | M | This information element indicates the existing context or requests a new context for the bearer termination. | +| | | Emergency Call Indicator | O | This information element identifies the call as emergency call that requires a preferential handling. | +| | | Termination/ Termination Request | M | This information element indicates the existing bearer termination or requests a new termination for the bearer to be established. | +| | | IP Interface | O | This information element specifies the used interface type for the IP termination (e.g. ExtSIPI, NboIP). | +| | | Local IP Resources | O | This information element indicates the resource(s) (e.g. codec, auxiliary payload types) for which the CS-TrGW shall be prepared to receive user data, | +| | | Remote IP Resources | O | This information element indicates the resources (e.g. codec, auxiliary payload types) that the CS-TrGW shall use to send user data. | +| | | Reserve Value | O | This information element indicates if multiple IP resources are to be reserved. | +| | | Local Connection Address request | M | This information element requests an IP address and a port number on the CS-TrGW that the remote end can send user plane data to. | +| | | Remote Connection Address | M | This information element indicates the IP address and ports of the remote party that the CS-TrGW can send user plane data to. | +| | | Notify termination heartbeat | M | This information element requests termination heartbeat indications and may specify their periodicity. | +| | | Notify Released Bearer | O | This information element requests a notification of a released bearer. | +| | | IP Realm Identifier | O | This information element indicates the IP realm of the IP termination. | +| | | IP Version | C | This information element indicates the version of the internet protocol to be applied at the termination for the user plane. This is required for IP address translation. | +| | | DiffServ Code Point | O | This information element indicates a specific DiffServ code point to be used in the IP header in packets sent on the IP termination. | +| | | DiffServ Tagging Behaviour | O | This information element indicates whether the Diffserv code point in the IP header in packets sent on the IP termination should be copied from the received value or set to a specific value. | +| | | Remote Source Address Filtering | O | This information element indicates that remote source address filtering is required. | +| | | Remote Source Address Mask | C | This information element provides information on the valid remote source addresses. This may be included if remote source address filtering is included. It shall not be included if remote source address filtering is not included. | +| | | Remote Source Port Filtering | O | This information element indicates that remote source port filtering is required. | + +| | | | +|--------------------------------------|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Remote Source Port | C | This information element identifies the valid remote source port. This may be included if remote source port filtering is included. It shall not be included if remote source port filtering is not included. (NOTE 1) | +| Remote Source Port Range | C | This information element identifies a range of valid remote source ports. This may be included if remote source port filtering is included. It shall not be included if remote source port filtering is not included. (NOTE 1) | +| Media Inactivity Detection Required | O | This information element indicates that detection of inactive media flows is required. | +| Inactivity Detection Time | C | This information element may be present if Inactive Media Detection is required and specifies the Inactivity Detection time. | +| Inactivity Detection Direction | C | This information element may be present if Inactive Media Detection is required and specifies the Inactivity Detection direction. | +| RTCP handling | O | Indicates whether or not the CS-TrGW shall reserve a port for an RTCP flow. | +| Traffic Policing Required | O | This information element indicates that policing of the media flow is required. | +| Peak Data Rate | O | This information element may be present if Policing is required and specifies the permissible peak data rate for a media stream. (NOTE 2) | +| Sustainable Data Rate | O | This information element may be present if Policing is required and specifies the permissible sustainable data rate for a media stream. (NOTE 2) | +| Delay Variation Tolerance | O | This information element may be present if Policing on Peak Data Rate is required and specifies the maximum expected delay variation tolerance for the corresponding media stream. | +| Maximum Burst Size | C | This information element shall be present if Policing on Sustainable Data Rate is required and specifies the maximum expected burst size for the corresponding media stream. | +| STUN server request | O | This information element is present if CS-IBCF requests the CS-TrGW to answer STUN connectivity checks for ICE. | +| ICE Connectivity Check | C | This information element requests the CS-TrGW to perform ICE connectivity check as defined by IETF RFC 5245 [ab]. It is only applicable for full ICE. | +| Notify ICE Connectivity Check Result | C | This information element requests a notification of ICE connectivity check result. It is only applicable for full ICE. | +| Notify New Peer Reflexive Candidate | C | This information element requests a notification of new peer reflexive candidate was discovered during a connectivity check. It is only applicable for full ICE. | +| ICE password request | O | This information element is present if CS-IBCF requests an ICE password. | +| ICE Ufrag request | O | This information element is present if CS-IBCF requests an ICE ufrag. | +| ICE host candidate request | O | This information element is present if CS-IBCF requests an ICE host candidate. | +| ICE received candidate | O | This information element is present if CS-IBCF indicates a received candidate for ICE. | +| ICE received password | O | This information element is present if CS-IBCF indicates a received password for ICE. | +| ICE received Ufrag | O | This information element is present if CS-IBCF indicates a received Ufrag for ICE. | + +| | | | | | | +|---------------------------------------------------------------------------------|---------|----------------------------|---|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | SDPCapNeg configuration | O | This information element provides SDPCapNeg configuration(s) using as "a=acap", "a=tcap", "a=pcfg" and "a=acfg" SDP attributes. | | +| Reserve and Configure TrGW Connection Point Ack | CS-TrGW | Context | M | This information element indicates the context where the command was executed. | | +| | | Termination | M | This information element indicates the termination where the command was executed. | | +| | | Local IP Resources | C | This information element indicates the resources that the CS-TrGW has reserved to receive the user plane data from the remote side. This IE shall be present if it was contained in the request. If the IE was not contained in the request, it may be present in the reply. | | +| | | Remote IP Resources | O | This information element indicates the resource (i.e. codec) that the CS-TrGW shall use to send user data. | | +| | | Local Connection Addresses | M | This information element indicates the IP address and port on the CS-TrGW that shall receive user plane data. | | +| | | Remote Connection Address | O | This information element indicates the IP address and port that the CS-TrGW can send user plane data to. May be present only if corresponding IE is present in the request. | | +| | | ICE password | C | This information element shall be present only if it was contained in the request. It indicates the ICE password assigned by the CS-TrGW. | | +| | | ICE Ufrag | C | This information element shall be present only if it was contained in the request. It indicates the ICE Ufrag assigned by the CS-TrGW. | | +| | | ICE host candidate | C | This information element shall be present only if it was contained in the request. It indicates the ICE host candidate assigned by the CS-TrGW. | | +| | | ICE lite indication | C | This information element shall be present only if an ICE host candidate request was contained in the request, and the CS-TrGW supports ICE lite, but not full ICE. It indicates that the CS-TrGW only supports ICE lite. | | +| | | SDPCapNeg configuration | C | This information element shall be present only if it was contained in the request. It provides SDPCapNeg configuration(s) using as "a=acap", "a=tcap", "a=pcfg" and "a=acfg" SDP attributes. | | +| NOTE 1: Remote Source Port and Remote Source Port Range are mutually exclusive. | | | | | | +| NOTE 2: At least one of these IEs shall be present when policing is required. | | | | | | + +#### A.7.2.2.4 Release TrGW Termination + +This procedure is used to release multimedia-processing resources for a termination at the CS-TrGW. + +**Table A.7.2.2.4.1: Release TrGW Termination** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|------------------------------|------------------|---------------------------------|-------------------------------------|------------------------------------------------------------------------------------| +| Release TrGW Termination | CS-IBCF | Context | M | This information element indicates the existing context. | +| | | Termination | M | This information element indicates the existing bearer termination to be released. | +| Release TrGW Termination Ack | CS-TrGW | Context | M | This information element indicates the context where the command was executed. | +| | | Termination | M | This information element indicates the termination where the command was executed. | + +### A.7.2.2.5 IP Bearer Released + +**Table A.7.2.2.5.1: IP Bearer Released** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|------------------------|------------------|---------------------------------|-------------------------------------|-----------------------------------------------------------------------------------------------| +| IP Bearer Released | CS-TrGW | Context | M | This information element indicates the context for the bearer termination. | +| | | Termination | M | This information element indicates the bearer termination where the bearer was released. | +| | | Bearer Released | M | This information element notifies a bearer release. | +| | | Release Cause | M | This information element indicates the cause of a bearer release. | +| IP Bearer Released Ack | CS-IBCF | Context | M | This information element indicates all context are where the command was executed. | +| | | Termination | M | This information element indicates that Bearer termination is where the command was executed. | + +### A.7.2.2.6 Media Inactivity Detection + +This command is used to notify the CS-IBCF of media inactivity on the CS-TrGW. + +**Table A.7.2.2.6.1: Media Inactivity Notification** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|-----------------------------------|------------------|---------------------------------|-------------------------------------|-------------------------------------------------------------------------------------------------------------------| +| Media Inactivity Notification | CS-TrGW | Context | M | This information element indicates the existing context for the bearer termination. | +| | | Termination | M | This information element indicates that bearer termination is where the media inactivity detection was activated. | +| | | Media Inactivity | M | This information element notifies the CS-IBCF of Media inactivity detection on the bearer termination. | +| Media Inactivity Notification Ack | CS-IBCF | Context | M | This information element indicates the context where the command was executed. | +| | | Termination | M | This information element indicates the bearer termination where the command was executed. | + +### A.7.2.2.7 Termination heartbeat indication + +This command is used by the CS-TrGW to periodically notify the CS-IBCF of a termination heartbeat. + +**Table A.7.2.2.7.1: Termination heartbeat indication** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|--------------------------------------|-----------|--------------------------|------------------------------|------------------------------------------------------------------------------------------------------------| +| Termination heartbeat indication | CS-TrGW | Context | M | This information element indicates the context for the bearer termination. | +| | | Bearer Termination | M | This information element indicates the bearer termination for which the termination heartbeat is reported. | +| | | Termination heartbeat | M | Hanging Termination event | +| Termination heartbeat indication Ack | CS-IBCF | Context | M | This information element indicates the context where the command was executed. | +| | | Bearer Termination | M | This information element indicates the bearer termination where the command was executed. | + +### A.7.2.2.8 Change Through-Connection + +This procedure is used to change the Through-connection in the bearer termination. + +**Table A.7.2.2.8.1: Change Through-Connection** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|-------------------------------|-----------|-----------------------------------------------|------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------| +| Change Through-Connection | CS-IBCF | Context/Context Request | M | This information element indicates the existing context or requests a new context for the bearer termination. | +| | | Bearer Termination/Bearer Termination Request | M | This information element indicates the existing bearer termination or requests a new Bearer termination where the through connection is changed. | +| | | Through-Connection | M | This information element indicates the through-connection of the bearer termination | +| Change Through-Connection Ack | CS-TrGW | Context | M | This information element indicates the context where the command was executed. | +| | | Bearer Termination | M | This information element indicates the bearer termination where the command was executed. | + +NOTE: This procedure may be combined with Reserve and Configure TrGW Connection Point, Reserve TrGW Connection Point or Configure TrGW Connection Point procedure. This list of procedures is not exhaustive. + +### A.7.2.2.9 ICE Connectivity Check Result Notification + +This procedure is used to report ICE connectivity check result for Full ICE. + +**Table A.7.2.2.9.1: ICE Connectivity Check Result Notification** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|------------------------------------------------|-----------|------------------------------------------|------------------------------|--------------------------------------------------------------------------------------------------------------------| +| ICE Connectivity Check Result Notification | CS-TrGW | Context | M | This information element indicates the context for the bearer termination. | +| | | Bearer Termination | M | This information element indicates the bearer termination for which the ICE Connectivity Check Result is reported. | +| | | ICE Connectivity Check Result Indication | M | This information element indicates an ICE Connectivity Check Result event. | +| ICE Connectivity Check Result Notification Ack | CS-IBCF | Context | M | This information element indicates the context where the command was executed. | +| | | Bearer Termination | M | This information element indicates the bearer termination where the command was executed. | + +### A.7.2.2.10 ICE New Peer Reflexive Candidate Notification + +This procedure is used to report ICE new peer reflexive candidate for Full ICE. + +**Table A.7.2.2.10.1: ICE New Peer Reflexive Candidate Notification** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|---------------------------------------------------|-----------|---------------------------------------------|------------------------------|-----------------------------------------------------------------------------------------------------------------------| +| ICE New Peer Reflexive Candidate Notification | CS-TrGW | Context | M | This information element indicates the context for the bearer termination. | +| | | Bearer Termination | M | This information element indicates the bearer termination for which the ICE New Peer Reflexive Candidate is reported. | +| | | ICE New Peer Reflexive Candidate Indication | M | This information element indicates an ICE New Peer Reflexive Candidate event. | +| ICE New Peer Reflexive Candidate Notification Ack | CS-IBCF | Context | M | This information element indicates the context where the command was executed. | +| | | Bearer Termination | M | This information element indicates the bearer termination where the command was executed. | + +## A.7.2.3 Non-Call Related Procedures + +### A.7.2.3.1 Introduction + +The procedures detailed in table A.7.2.3.1 shall be applied for the CS-TrGW handling component of the Ix interface. Where a corresponding procedure in TS 23.205 [9] is specified, that procedure shall apply. Where no corresponding procedure in TS 23.205 [9] is specified, the procedure is specified in a clause of this specification. + +**Table A.7.2.3.1.1: Non-call related procedures** + +| Procedure defined in TS 29.238 [29] | Corresponding Procedure defined in TS 23.205 [9] | Remarks | +|------------------------------------------------|--------------------------------------------------|--------------------------------------------------------------------------------------------------------------------| +| TrGW Out of service | MGW Out of Service | | +| TrGW Communication Up | MGW Communication Up | | +| TrGW Restoration | MGW Restoration | | +| TrGW Register | MGW Register | | +| TrGW Re-register | MGW Re-register | | +| CS-IBCF Ordered Re-register | (G)MSC Server Ordered Re-register | | +| CS-IBCF Restoration | (G)MSC Server Restoration | | +| CS-IBCF Out of Service | (G)MSC Server Out of Service | | +| Termination Out-of-Service | Termination Out-of-Service | The "Termination Out-of-Service procedure" is also used as a call-related H.248 command | +| Audit Value | Audit Value | | +| Command Rejected | Command Rejected | The "Command Rejected" procedure may be used in response both to call-related and non-call-related H.248 Commands. | +| TrGW Capability Change | Capability Update | | +| TrGW Resource Congestion Handling - Activate | MGW Resource Congestion Handling - Activate | | +| TrGW Resource Congestion Handling - Indication | MGW Resource Congestion Handling - Indication | | +| Inactivity timeout activation | Inactivity timeout activation | | +| Inactivity timeout indication | Inactivity timeout indication | | +| Realm Availability Change Activate | | See clause A.7.2.3.2. | +| Realm Availability Change Indication | | See clause A.7.2.3.3. | + +### A.7.2.3.2 Realm Availability Change - Activate + +This procedure is used to activate the realm availability notification mechanism. + +**Table A.7.2.3.2.1: Realm Availability Change - Activate** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|-----------------------------------------|-----------|------------------------------------|------------------------------|--------------------------------------------------------------------------------------------------------------------------------------| +| Realm Availability Change - Activate | CS-IBCF | Context | M | This information element indicates the NULL context. | +| | | Root Termination | M | This information element indicates that root termination is where the realm availability change notification mechanism is activated. | +| | | Realm Availability Change Activate | M | This information element requests to activate the realm availability change notification mechanism. | +| Realm Availability Change -Activate Ack | TrGW | Context | M | This information element indicates the NULL context. | +| | | Root Termination | M | This information element indicates that root termination is where the command was executed. | + +### A.7.2.3.3 Realm Availability Change - Indication + +This procedure is used to inform the CS-IBCF that there has been a change to the list of currently available realms. + +**Table A.7.2.3.3.1: Realm Availability Change - Indication** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|--------------------------------------------|-----------|-------------------------------|------------------------------|---------------------------------------------------------------------------------------------------------------------------------------| +| Realm Availability Change - Indication | TrGW | Context | M | This information element indicates the NULL context. | +| | | Root Termination | M | This information element indicates that root termination is where the realm availability change notification mechanism was activated. | +| | | Changes to Realm Availability | M | This information element indicates the changes to the list of available realms. | +| Realm Availability Change - Indication Ack | CS-IBCF | Context | M | This information element indicates the NULL context. | +| | | Root Termination | M | This information element indicates that root termination is where the command was executed. | + +## A.8 (G)MSC - CS-MGW Interaction + +### A.8.1 General + +#### A.8.1.1 Network Model + +figure A.8.1.1.1 shows the network model. The squared line represents the call control signalling. The dotted line represents the bearer control signalling (if applicable) and the user plane. The (G)MSC uses one context with at least two terminations in the CS-MGW. The termination T1 is used towards the 3GPP PLMN and the bearer termination T2 is used for the bearer towards the external IP network. + +![Figure A.8.1.1.1: H.248 Context Model diagram showing a 3GPP PLMN connected to a (G)MSC, which is connected to a CS-MGW. The CS-MGW has two terminations, T1 and T2, connected to an External Network. The (G)MSC and CS-MGW are connected by a solid line (call control signalling). The 3GPP PLMN and (G)MSC are connected by a dotted line (bearer control signalling). The CS-MGW and External Network are connected by a dotted line (bearer control signalling).](2d863654cf3803cea82b686d9b3ebee8_img.jpg) + +Figure A.8.1.1.1: H.248 Context Model diagram showing a 3GPP PLMN connected to a (G)MSC, which is connected to a CS-MGW. The CS-MGW has two terminations, T1 and T2, connected to an External Network. The (G)MSC and CS-MGW are connected by a solid line (call control signalling). The 3GPP PLMN and (G)MSC are connected by a dotted line (bearer control signalling). The CS-MGW and External Network are connected by a dotted line (bearer control signalling). + +**Figure A.8.1.1.1: H.248 Context Model** + +#### A.8.1.2 Signalling flows + +The signalling flows in A.7.1.2 apply with the following additions: + +- Instead of the procedure Reserve TrGW Connection Point the procedure Reserve RTP Connection Point as defined by TS 23.205 [9] is used. +- Instead of the procedure Reserve and Configure TrGW Connection Point the procedure Reserve and Configure RTP Connection Point as defined by TS 23.205 [9] is used. +- Instead of the procedure Configure TrGW Connection Point the procedure Configure RTP Connection Point as defined by TS 23.205 [9] is used. + +--- + +## Annex B (normative): + +# Additional Interworking Procedures between a SIP-I based circuit-switched Core Network and the IP Multimedia (IM) Core Network (CN) Subsystem to Support Special Services + +## B.1 General + +The present annex describes additional interworking between a SIP-I based circuit-switched core network and the IP Multimedia (IM) Core Network (CN) Subsystem to interwork special services such as global text telephony. Those procedures apply in combination with the procedures in clause 7. + +The procedures in the present Annex are optional. However, if a special service covered in this Annex is interworked, the procedures in the corresponding clause of this Annex shall be applied. + +--- + +## B.2 Global Text Telephony + +Global Text Telephony (GTT) offers real time conversation in text, optionally combinable with voice. GTT is mainly used for distant conversation with hearing or speech impaired users. + +GTT is supported in IMS via the Real-Time Text protocol over RTP, using IETF SIP/SDP for the negotiation of the text media and IETF RFC 4103 [47] RTP-text for transport, with text coded according to ITU-T Recommendation T.140 [46]. See TS 23.226 [45] and TS 26.114 [52]. + +Within a SIP-I based circuit-switched Core Network the default PCM codec is used to transport the PTSN inband text telephony format. PCM will also be negotiated as codec within SIP-I /SDP, without further information allowing identifying a call using global text telephony. Different specified systems for text telephony exist as PTSN inband text telephony format and are used in different regions, e.g. Baudot (in US), EDT, V.21, Bell103, Minitel and V.18. They are described in the annexes of ITU-T V.18 [48]. + +The Interworking procedures in Annex I of TS 29.163 [13] shall be applied with the following clarifications: + +- Where ISUP signalling is mentioned or depicted, the corresponding SIP-I signalling is applicable. + +## Annex C (informative): Change history + +| Change history | | | | | | | | +|----------------|--------|-----------|------|-----|--------------------------------------------------|-------------------------------------------------------------------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 06/2014 | TSG#64 | CP-140397 | 0101 | 3 | ICE support for Ix towards SIP-I based CS CN | 11.3.0 | 12.0.0 | +| 06/2015 | TSG#68 | CP-150351 | 0102 | - | Bearer Termination in Acknowledgements | 12.0.0 | 12.1.0 | +| 12/2015 | TSG#70 | CP-150667 | 0103 | 6 | Stage 2 Ix supporting SDP capability negotiation | 12.1.0 | 13.0.0 | +| Change history | | | | | | | | +| Date | TSG # | TSG Doc. | CR | Rev | Cat | Subject/Comment | New | +| 03/2016 | CT#71 | CP-160105 | 0104 | - | F | Removal of references to TS 26.235 and TS 26.236 | 13.1.0 | +| 03/2017 | CT#75 | CP-170087 | 0105 | 1 | F | Correction to reference model | 14.0.0 | +| 06/2018 | CT#80 | | | | | Automatic upgrade from previous Release | 15.0.0 | +| 12/2018 | CT#82 | CP-183121 | 0113 | 1 | A | Removal of Editor's notes for supplementary services interworking | 15.1.0 | +| 2020-07 | SA#88e | - | - | - | | Update to Rel-16 version (MCC) | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29250/06da11ab76cacc38bbcd714e437797ea_img.jpg b/marked/Rel-16/29_series/29250/06da11ab76cacc38bbcd714e437797ea_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..919330c7c99ba78684ecc50ad736d3ad01dc159f --- /dev/null +++ b/marked/Rel-16/29_series/29250/06da11ab76cacc38bbcd714e437797ea_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b268420450c1781b78e76162499ad70f07fb33a26736f8a612f94ca35fe8dcde +size 5792 diff --git a/marked/Rel-16/29_series/29250/20136850feb70fd71c7d41cdae203ebb_img.jpg b/marked/Rel-16/29_series/29250/20136850feb70fd71c7d41cdae203ebb_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a015729cc949ba83778c9c88cd42c9848dc0fa71 --- /dev/null +++ b/marked/Rel-16/29_series/29250/20136850feb70fd71c7d41cdae203ebb_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f6843778665566ab7535e4dffad603281eb18c504cd372da433174b7af32478b +size 16555 diff --git a/marked/Rel-16/29_series/29250/99bae07626f60f9ede10e2e387ef7051_img.jpg b/marked/Rel-16/29_series/29250/99bae07626f60f9ede10e2e387ef7051_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ae2fe1edfa74cb8e4a953200bcfa82b25190682e --- /dev/null +++ b/marked/Rel-16/29_series/29250/99bae07626f60f9ede10e2e387ef7051_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5ec2f0ee2463b2c022c550c3aabe5cd336491373d057940af2a045c7cffe2f88 +size 34571 diff --git a/marked/Rel-16/29_series/29250/raw.md b/marked/Rel-16/29_series/29250/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..aefbd46f0ef17618b79529ce6a7cb63bde5cadb5 --- /dev/null +++ b/marked/Rel-16/29_series/29250/raw.md @@ -0,0 +1,1203 @@ + + + + + + +# Contents + +| | | +|----------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions and abbreviations ..... | 7 | +| 3.1 Definitions..... | 7 | +| 3.2 Abbreviations ..... | 7 | +| 4 Nu reference point..... | 7 | +| 4.1 Overview ..... | 7 | +| 4.2 Nu reference model ..... | 7 | +| 4.3 Functional elements..... | 8 | +| 4.3.1 PFDF..... | 8 | +| 4.3.2 SCEF..... | 8 | +| 4.4 Procedures over Nu reference point..... | 8 | +| 4.4.1 Management of PFD..... | 8 | +| 4.4.2 PFD management notification ..... | 9 | +| 5 Nu protocol ..... | 9 | +| 5.1 Introduction ..... | 9 | +| 5.2 Transport layer ..... | 10 | +| 5.3 Application delivery layer..... | 10 | +| 5.3.1 General ..... | 10 | +| 5.3.2 HTTP status codes..... | 10 | +| 5.3.3 Methods ..... | 10 | +| 5.3.4 Resources and URI design..... | 11 | +| 5.3.5 HTTP request/response formats ..... | 11 | +| 5.3.5.1 General..... | 11 | +| 5.3.5.2 POST /nuapplication/provisioning ..... | 12 | +| 5.3.5.3 POST /nuapplication/notification ..... | 14 | +| 5.3.6 Feature negotiation ..... | 15 | +| 5.3.6.1 General..... | 15 | +| 5.3.6.2 HTTP custom headers..... | 16 | +| 5.3.6.2.1 3gpp-Optional-Features..... | 16 | +| 5.3.6.2.2 3gpp-Required-Features ..... | 16 | +| 5.3.6.2.3 3gpp-Accepted-Features..... | 16 | +| 5.4 Specific application communication ..... | 17 | +| 5.4.1 General ..... | 17 | +| 5.4.2 Content type..... | 17 | +| 5.4.3 JSON provisioning fields ..... | 17 | +| 5.4.3.1 General..... | 17 | +| 5.4.3.2 scef-notification-uri ..... | 17 | +| 5.4.4 Void..... | 18 | +| 5.4.5 JSON errors and informational response fields..... | 18 | +| 5.4.5.1 General..... | 18 | +| 5.4.6 JSON report fields ..... | 18 | +| 5.4.6.1 General..... | 18 | +| 5.4.6.2 pfd-reports..... | 18 | +| 5.4.6.3 application-ids..... | 19 | +| 5.4.7 JSON notification fields ..... | 19 | +| 5.4.7.1 General..... | 19 | +| 5.4.7.2 notification-pfd-reports ..... | 19 | +| 5.4.7.3 user-plane-location-area..... | 20 | +| 5.4.7.4 cell-ids..... | 20 | +| 5.4.7.5 enodeb-ids..... | 20 | +| 5.4.7.6 extended-enodeb-ids ..... | 20 | +| 5.4.7.7 routing-area-ids..... | 20 | +| 5.4.7.8 tracking-area-ids ..... | 21 | +| 5.5 PFDF discovery..... | 21 | + +| | | | +|-------------------------------|-----------------------------------------------|-----------| +| 5.6 | SCEF discovery..... | 21 | +| 6 | Secure communication..... | 21 | +| Annex A (informative): | JSON Schema ..... | 21 | +| A.1 | Provisioning schema ..... | 21 | +| A.2 | Error and Informational response schema ..... | 23 | +| A.3 | PFD management notification schema ..... | 25 | +| Annex B (informative): | Call Flows..... | 28 | +| B.1 | General..... | 28 | +| B.2 | Provisioning of PFDs ..... | 28 | +| Annex C (informative): | Change history..... | 29 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# 1 Scope + +The present document provides the stage 3 specification of the Nu reference point. The functional requirements and the stage 2 specifications of the Nu reference point are specified in 3GPP TS 23.682 [2]. The Nu reference point lies between the Packet Flow Description Function (PFDF) and the Service Capability Exposure Function (SCEF). + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.682: "Architecture enhancements to facilitate communications with packet data networks and applications". +- [3] 3GPP TS 23.203: "Policy and charging control architecture". +- [4] 3GPP TS 29.213: "Policy and Charging Control signalling flows and QoS parameter mapping". +- [5] 3GPP TS 33.210: "3G security; Network Domain Security (NDS); IP network layer security". +- [6] IETF RFC 2818: "HTTP Over TLS". +- [7] IETF RFC 793: "Transmission Control Protocol". +- [8] Void. +- [9] 3GPP TS 29.251: "Gw and Gwn reference points for sponsored data connectivity". +- [10] IETF RFC 3986: "Uniform Resource Identifier (URI): Generic Syntax". +- [11] IETF RFC 7159: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [12] IETF draft-newton-json-content-rules-09: "A Language for Rules Describing JSON Content". + +NOTE: This individual draft will not further progress in IETF. It is available from the following link: +. + +- [13] IETF RFC 7230: "Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing". +- [14] IETF RFC 7231: "Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content". +- [15] IETF RFC 7232: "Hypertext Transfer Protocol (HTTP/1.1): Conditional Requests". +- [16] IETF RFC 7233: "Hypertext Transfer Protocol (HTTP/1.1): Range Requests". +- [17] IETF RFC 7234: "Hypertext Transfer Protocol (HTTP/1.1): Caching". +- [18] IETF RFC 7235: "Hypertext Transfer Protocol (HTTP/1.1): Authentication". +- [19] 3GPP TS 29.274: "Evolved GPRS Tunnelling Protocol for EPS (GTPv2)". + +# 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +**Packet Flow Description (PFD):** A set of information enabling the detection of application traffic provided by a 3rd party service provider (from 3GPP TS 23.203 [3]). + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|------|------------------------------------------| +| JSON | JavaScript Object Notation | +| PCEF | Policy and Charging Enforcement Function | +| PFD | Packet Flow Description | +| PFDF | Packet Flow Description Function | +| SCEF | Service Capability Exposure Function | +| TDF | Traffic Detection Function | + +# 4 Nu reference point + +## 4.1 Overview + +The Nu reference point is located between the Packet Flow Description Function (PFDF) and the Service Capability Exposure Function (SCEF). The Nu reference point is used for provisioning of PFDs from the SCEF to the PFDF and reporting the result of the PFD Management from the PFDF to the SCEF. + +The stage 2 level requirements for the Nu reference point are defined in 3GPP TS 23.682 [2]. + +## 4.2 Nu reference model + +The Nu reference point is defined between the SCEF and the PFDF. The relationships between the different functional entities involved are depicted in figure 4.2.1. The overall PCC architecture is depicted in subclause 3a of 3GPP TS 29.213 [4]. + +![Diagram of the Nu reference model showing the PFDF and SCEF connected via the Nu reference point.](06da11ab76cacc38bbcd714e437797ea_img.jpg) + +``` + +graph LR + PFDF[PFDF] --- Nu((Nu)) + Nu --- SCEF[SCEF] + +``` + +The diagram shows two green rectangular boxes, labeled 'PFDF' on the left and 'SCEF' on the right. A horizontal line connects the two boxes. In the center of this line, there is a small vertical tick mark, and above this tick mark is the label 'Nu', representing the reference point between the two functions. + +Diagram of the Nu reference model showing the PFDF and SCEF connected via the Nu reference point. + +Figure 4.2.1: Nu reference model + +## 4.3 Functional elements + +### 4.3.1 PFDF + +The PFDF (Packet Flow Description Function) is a functional element which receives and manages the PFDs associated to application identifier (s) from the SCEF via the Nu reference point. + +The PFDF provisions PFDs for the corresponding application identifier (s) to the PCEF/TDF as defined in 3GPP TS 23.203 [3] and 3GPP TS 29.251 [9]. + +### 4.3.2 SCEF + +The SCEF (Service Capability Exposure Function) is a functional element which provides means to securely expose the services and capabilities provided by the 3GPP network interfaces. + +The SCEF shall support the management of PFDs provided by the 3rd party SCS/AS. The SCEF may provision the PFDs to the PFDF via the Nu reference point. + +## 4.4 Procedures over Nu reference point + +### 4.4.1 Management of PFD + +The PFDs associated with application identifier (s) may be created, updated or removed in the PFDF by the third party SCS/AS via the SCEF as defined in 3GPP TS 23.682 [2]. + +If the SCEF receives one or more sets of PFDs for external application identifier (s) provisioned by the third party SCS/AS, which is authorized to perform the management of PFDs based on operator policies, the SCEF shall: + +- If the external application identifier(s) is different from the application identifier(s) known at the PFDF, translate the external application identifier(s) to the application identifier(s) known at the PFDF; and +- may check if the allowed delay satisfies the required SLA against the minimum allowed delay as defined in 3GPP TS 23.682 [2]; and +- send an HTTP POST message to the PFDF including the provisioned PFD changes for the the application identifier (s) within the body of the HTTP POST as described in subclause 5.3.5.2. + +NOTE 1: It is up to operator configuration whether to use different external application identifiers that require a mapping to application identifiers known at the PFDF. The external application identifier can be the same as the application identifier known at the PFDF. + +Upon receipt of the HTTP request for the provisioning operation from the SCEF, the PFDF shall perform the following steps: + +- If an allowed delay is received for an application identifier, for Pull mode as defined in 3GPP TS 29.251 [9], the PFDF shall compare the allowed delay with the configured caching time which is: + - a caching time value configured for that application identifier; or + - the default caching time value if no caching time value is configured for that application identifier. +- Then if the PFDF cannot ensure the PCEF/TDF will pull the PFDs in time (i.e. allowed delay is shorter than the caching time), the PFDF shall within the HTTP response send a failure reason and that caching time value used in the comparison and may still store (create/update/remove) the PFDs for this application identifier. + +NOTE 2: In the Combination mode as defined in 3GPP TS 29.251 [9], the PFDF can check the received allowed delay against the caching time but will always store (create/update/remove) the PFDs. + +- In the Pull mode as defined in 3GPP TS 29.251 [9], for the application identifier(s) without the need to send failure reason; or in the Push or Combination mode as defined in 3GPP TS 29.251 [9], for received application identifier(s), the PFDF shall: + - delete all the PFD(s) for the application identifier(s) where the removal-flag is also provided and set to true; + - update the existing PFD(s) if a new PFD(s) with the same PFD identifier(s) is received , add new PFD(s) if the new PFD(s) with a new PFD identifier(s) is received, and/or delete an existing PFD(s) if the same PFD identifier(s) without any content is received, where the partial-flag is also provided and set to true; + - remove existing PFD(s) (if available) and install the new PFD(s) for the corresponding PFD identifier(s) whereno flag is provided; + - acknowledge the HTTP POST message by sending a corresponding HTTP response with the appropriate status code as defined in subclause 5.3.2. If the POST operation was successful for at least one application identifier, the PFDF shall respond with an HTTP 200 OK status code. + +### 4.4.2 PFD management notification + +In the Push mode or Combination mode as defined in 3GPP TS 29.251 [9], if the PFDs are provisioned to at least one of the known PCEF/TDFs (but not all) within the allowed delay (i.e. the provisioned PFDs can not be enforced successfully in some PCEF/TDFs known on the PFDF), the PFDF may notify the SCEF about the failed PFD provisioning with the HTTP POST message using the failure reason "PARTIAL\_FAILURE" as defined in Table 5.4.7.1-1. In this case, the PFDF may include location area(s) of the PCEF/TDF(s) which can not enforce the provisioned PFD(s) within the field "user-plane-location-area" of the corresponding instance of the PFD report(s). If the PFDs are provisioned to none of the known PCEF/TDFs within the allowed delay, the PFDF shall notify the SCEF about the failed PFD provisioning with the HTTP POST message using appropriate failure reason as defined in subclause 6.4.6.3 of 3GPP TS 29.251 [9]. + +When receiving the HTTP POST message, the SCEF shall respond with an HTTP response message. + +# 5 Nu protocol + +## 5.1 Introduction + +The following layers of the protocol stack for the Nu reference point between the SCEF and the PFDF are described in subclauses: + +- IETF RFC 793 [7] provides the communication service at the transport layer. +- An optional communication security layer can be added between the transport and the application delivery layer (see subclause 6). +- The application delivery layer provides the transport of the specific application communication data using IETF RFC 7230 [13], IETF RFC 7231 [14], IETF RFC 7232 [15], IETF RFC 7233 [16], IETF RFC 7234 [17] and IETF RFC 7235 [18]. +- The specific application communication layer constitutes the transport of the JSON content type. + +Figure 5.1.1 illustrates the protocol stack of the RESTful Nu reference point. + +![Figure 5.1.1: Protocol stack of the RESTful Nu reference point. The diagram shows two protocol stacks, one for the SCEF and one for the PFDF, connected by a vertical line labeled REST-Nu. Both stacks have six layers: Specific application communication (JSON), Application delivery (HTTP), Transport layer (TCP), Network layer (IP), Data link layer (L2), and Physical layer (L1).](99bae07626f60f9ede10e2e387ef7051_img.jpg) + +| | | | | +|------------------------------------|------|---------|------| +| Specific application communication | JSON | | JSON | +| Application delivery | HTTP | | HTTP | +| Transport layer | TCP | | TCP | +| Network layer | IP | | IP | +| Data link layer | L2 | | L2 | +| Physical layer | L1 | | L1 | +| | SCEF | REST-Nu | PFDF | + +Figure 5.1.1: Protocol stack of the RESTful Nu reference point. The diagram shows two protocol stacks, one for the SCEF and one for the PFDF, connected by a vertical line labeled REST-Nu. Both stacks have six layers: Specific application communication (JSON), Application delivery (HTTP), Transport layer (TCP), Network layer (IP), Data link layer (L2), and Physical layer (L1). + +Figure 5.1.1: Protocol stack of the RESTful Nu reference point + +## 5.2 Transport layer + +HTTP is layered over TCP, which provides a reliable transport. + +For provisioning of PFDs from the SCEF to the PFDF, the SCEF acts as an HTTP client and the PFDF acts as an HTTP server. As a result, the SCEF shall initiate a TCP connection with the PFDF. + +## 5.3 Application delivery layer + +### 5.3.1 General + +The application delivery layer shall use RESTful HTTP. + +The application delivery layer provides provisioning of the PFDs by the SCEF. + +If the SCEF needs to provision PFDs for a set of application identifier(s) (creation/update/deletion) to the PFDF, the SCEF shall send an HTTP POST message. + +### 5.3.2 HTTP status codes + +The HTTP status codes for the REST-based Nu interface are specified in the IETF RFC 7231 [14]. + +### 5.3.3 Methods + +Methods indicate to the server what action has to be performed. Every HTTP request message has a method. + +The HTTP POST method is used by the SCEF to provision PFDs for a set of application identifiers. The request URI defines the address responsible for the management of the PFDs provisioning as a controller resource. + +The HTTP POST method is also used by the PFDF to inform the SCEF for PFD management notification. + +Every HTTP request results in a response message that comes back with a status code and further information in its body, if required. The HTTP request initiator waits for this response before initiating a further request. + +### 5.3.4 Resources and URI design + +The URI design shall be based on the structure defined in IETF RFC 3986 [10]: + +``` +scheme ":" hier-part [ "?" query ] [ "#" fragment ] +hier-part = "//" authority path-abempty + / path-absolute + / path-rootless + / path-empty +``` + +The scheme may be HTTP or HTTPS for the Nu interface. Within a scheme the definition of names shall follow the rules of HTTP URIs. Host and port are the main parts of the authority. The path element identifies the resources. + +For the Nu interface, the following required parts of the URI shall be used as follows: + +scheme: The application delivery layer protocol "http" or "https". + +authority: It includes the server address and optionally a port as follows: host [":" port] + +path-absolute: The path-absolute should have the following ABNF: "/" mainapp "/" mainresource. In this release: + +"mainapp" is "nuapplication". + +"mainresource" is "provisioning". + +The PFDs management (associating/disassociating PFDs with application identifiers) in PFDF is a controller resource that is responsible for processing requests that provisioning a set of changes for more than one set of PFDs for corresponding application identifiers atomically. + +An example of the URI to identify the controller resource is . + +NOTE: A different path can be used when the Resource URI is preconfigured in the SCEF. + +### 5.3.5 HTTP request/response formats + +#### 5.3.5.1 General + +The PFDs provisioning procedure is performed through HTTP transactions consisting of a request initiated by the SCEF and answered by the PFDF. + +Table 5.3.5.1-1 summarizes the content of the requests and responses. More detailed information is specified in the corresponding subclauses as indicated in the table. + +**Table 5.3.5.1-1: Nu requests/response summary table** + +| Method | Resource URI's path | Clause Defined | Request body | Initiator | Response body | +|--------|--------------------------------------------------------------------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|------------------------------------------------------------------------------------------------------| +| POST | /nuapplication/provisioning
(NOTE 1) | 5.3.5.2 | Content-Type:
application/json
The SCEF shall include PFDs content associated with application identifier(s) using the schema defined in Annex A. | SCEF | Successful response: The PFDF may include informational data in the body of the response in Annex A. | +| POST | {sceF-notification-uri}
or
/nuapplication/notification
(NOTE 2) | 5.3.5.3 | Content-Type:
application/json
The PFDF shall include notification result and application identifier(s) using the schema defined in Annex A. | PFDF | | + +NOTE 1: A different path from /nuapplication/provisioning may be used when it is configured in the SCEF. In that case the "path" part set in the different methods should use the configured one. + +NOTE 2: A different path from /nuapplication/notification may be used when it is configured in the PFDF and no sceF-notification-uri is received in the provisioning POST. In that case the "path" part set in the different methods should use the configured one. + +#### 5.3.5.2 POST /nuapplication/provisioning + +The provisioning of the PFDs shall be performed by the SCEF by using the POST method as follows: + +- The request URI formatted as defined in subclause 5.3.4 with the "path" part set to: /nuapplication/provisioning. +- The Content-Type header field set to "application/json" +- The body of the message encoded in JSON format as defined in Annex A. The body shall include + - for the PFD(s) creation for a new application identifier, a new application identifier and its full list of PFD(s) to be created; + - for the PFD(s) full update for an existing application identifier, the existing application identifier and its new full list of PFD(s) + - for the PFD(s) partial update for an existing application identifier, the existing application identifier, partial update indication and + - new PFD(s) with new PFD identifier(s) to add new PFD(s), + - new PFD(s) with existing PFD identifier(s) to update existing PFD(s), and/or + - the existing PFD identifier(s) without any content to remove the existing PFD(s); + - for the PFD(s) removal for an existing application identifier, the existing application identifier and the removal indication. + +Upon receipt of the HTTP POST request, the PFDF shall respond to the SCEF indicating whether the provisioning was successful or not using one of the HTTP status codes as defined in subclause 5.3.2. If the provisioning was accepted, the + +PFDF shall respond with an HTTP 200 OK status code if no resource is created, or an HTTP 201 Created status code if one or more resources are created. If the allowed delay is too short according to the criteria in subclause 4.4.1, the PFDF shall respond with an HTTP 200 OK status code and additional information in the body of the response indicating failure reason "too short allowed delay" and the value of caching time as defined in Annex A. If the provisioning was rejected, the PFDF shall indicate the reason using an appropriate HTTP status code as defined in subclause 5.3.2 and optionally additional information in the body of the response as defined in Annex A. + +Below is an example of an HTTP POST and a corresponding successful response: + +POST /nuapplication/provisioning HTTP/1.1 + +Host: pfdserver.example.com + +Content-Type: application/json + +Content-Length: ... + +``` +[ +{ + "application-identifier":"test-application-1", + "removal-flag":true +}, +{ + "application-identifier":"test-application-2", + "allowed-delay":600, + "pfds":[ + { + "pfd-identifier":"pfd1", + "flow-descriptions":[ + "permit in ip from 10.68.28.39 80 to any" + ] + }, + { + "pfd-identifier":"pfd2", + "urls":[ + "^http://test.example.com(/\\S*)?$" + ] + } + ], + "partial-flag":true +} +``` + +``` + +"pfds":[ +{ + "pfd-identifier":"pfd3", + "urls":[ + "^http://test.example2.net(/\\S*)?$" + ] +}, +{ + "pfd-identifier":"pfd4" +} +] +} +] + +``` + +Here is an example of a successful response: + +HTTP/1.1 200 OK + +Date: Mon, 7 May 2012 16:00:00 GMT + +Server: pfdserver.example.com + +Content-Type: application/json + +``` + +{ + "success-message": "Notification was processed successfully.", +} + +``` + +#### 5.3.5.3 POST /nuapplication/notification + +The notification of the PFD management shall be performed by the PFDF by using the POST method as follows: + +- The request URI formatted as defined in subclause 5.3.4 with the "path" part set to: /nuapplication/notification. +- The Content-Type header field set to "application/json". +- The body of the message encoded in JSON format as defined in Annex A. The body shall include the pfd-report. + +Upon receipt of the HTTP POST request, the SCEF shall respond to the PFDF with HTTP 200 OK status code. + +Below is an example of an HTTP POST and a corresponding response: + +POST /nuapplication/notification HTTP/1.1 + +Host: scefserver.example.com + +Content-Type: application/json + +Content-Length: ... + +``` + +{ + "notification-pfd-reports": [ + { + +``` + +``` + + "application-ids": ["test-application-1", "test-application-2", "test-application-3"], + "pfd-failure-code": "PARTIAL_FAILURE", + "user-plane-location-area": { + "cell-ids" : ["46000045BD6007", "46000045BD6008"], + "tracking-area-ids" : ["46000063F8", "46000063F9"] + } +} +] +} + +``` + +Here is an example of a response: + +HTTP/1.1 200 OK + +Date: Mon, 7 May 2018 16:00:00 GMT + +Server: scefserver.example.com + +Content-Type: application/json + +### 5.3.6 Feature negotiation + +#### 5.3.6.1 General + +The REST based Nu interface needs to provide a mechanism to advertise required and optional features supported by both the SCEF and PFDF for interoperability reasons as the functionality of the REST Nu based interface is augmented. + +Feature negotiation shall take place during the first interaction (i.e. HTTP POST in provisioning) between the PFDF and the SCEF. The client shall include in the HTTP request the set of supported features as follows: + +- if a feature is required for the proper operation of the application, it shall be included within the 3gpp-Required-Features header; +- if a feature is optional for the proper operation of the application, it shall be included within the 3gpp-Optional-Features header. + +The server shall include, within the 3gpp-Accepted-Features header in the HTTP response, the set of features it supports in common with the client. + +If the server does not support any of the required features advertised by the client within the 3gpp-Required-Features header, the server shall reject the HTTP request with an HTTP 412 Precondition Failed status code and shall include the commonly supported features with the client within the 3gpp-Accepted-Features. + +If the server requires certain features to be supported that are not advertised by the client, the server shall reject the HTTP request with an HTTP 412 Precondition Failed status code and shall include the commonly supported features with the client within the 3gpp-Accepted-Features and the required features in the 3gpp-required-features. + +If the SCEF and the PFDF successfully negotiate supported features, the list of commonly supported features shall be applicable for the lifetime of the application. Features that are not advertised as supported shall not be used. + +The sender may send information that is related to the supported features. Any unrecognized information shall be ignored by the receiver. + +The table below defines the features applicable to the Nu interface. + +**Table 5.3.6.1-1: Features used in Nu Interface** + +| Feature | M/O | Description | +|-------------------------------------------------------------------------------------------------------------------------|-----|---------------------------------------------------------------------------------------------------| +| DomainNameProtocol | O | This feature supports the additional protocol matching condition for the domain name in PFD data. | +| PfdMgmtNotification | O | This feature supports the PFD management notification. | +| Feature: A short name for the feature to which the M/O and description pertain. | | | +| M/O: Indication on whether the implementation of the feature is mandatory ("M") or optional ("O") in this 3GPP Release. | | | +| Description: Textual description of the feature. | | | + +NOTE: The base functionality for the Nu interface is defined in the Release-14 version of this specification and a feature is an extension of that functionality. The negotiation of supported features allows interworking between the endpoints of the Nu interface whereby each entity may support all, some, or none of the features that the Nu application can support defined in this specification. Features are defined so that they are independent of each other. Any introduced feature is explicitly defined in this specification. + +Since a post Release-16 version of SCEF does not send any supported feature information, the interworking PFDF supporting Release-16 version does not need to send any information related to supported feature and both sides shall behave as specified in the Release-14 version of this specification. + +A post Release-16 version of PFDF may receive supported feature information from a Release-16 version of SCEF, those information will be ignored by the PFDF and both sides shall behave as specified in the Release-14 version of this specification. + +#### 5.3.6.2 HTTP custom headers + +This subclause defines any new HTTP custom headers introduced by this specification. + +##### 5.3.6.2.1 3gpp-Optional-Features + +This header is used by the client to advertise the optional features that are supported by the client. + +The encoding of the header follows the ABNF as defined in IETF RFC 7230 [13]. + +3gpp-Optional-Features = "3gpp-Optional-Features" ":" 1#token + +An example is: 3gpp-Optional-Features: feature1, feature2 + +##### 5.3.6.2.2 3gpp-Required-Features + +This header is used by the client to announce the mandatory features that must be supported in the server. + +This header is also used by the server to indicate the missing features that must be supported in the client. + +The encoding of the header follows the ABNF as defined in IETF RFC 7230 [13]. + +3gpp-Required-Features = "3gpp-Required-Features" ":" 1#token + +An example is: 3gpp-Required-Features: feature1, feature2 + +##### 5.3.6.2.3 3gpp-Accepted-Features + +The header is used by the server to confirm the commonly supported set of features with the client. + +The encoding of the header follows the ABNF as defined in IETF RFC 7230 [13]. + +3gpp-Accepted-Features = "3gpp-Accepted-Features" ":" 1#token + +An example is: 3gpp-Accepted-Features: feature1, feature2 + +## 5.4 Specific application communication + +### 5.4.1 General + +Specific application communication represents the presentation of application data structures by transforming data into the form that the application accepts. It establishes the context between application-layer entities. + +NOTE: This release only supports the content type JSON. + +### 5.4.2 Content type + +The body of HTTP messages shall be in JSON format. The content of the JSON text is defined in subclause 5.4.3 and Annex A. + +The MIME media type that shall be used within the Content-Type header field is "application/json" as defined in IETF RFC 7159 [11]. + +### 5.4.3 JSON provisioning fields + +#### 5.4.3.1 General + +Table 5.4.3.1-1 describes the JSON provisioning fields used within the body of the HTTP messages representing the PFDs information associated with an application identifier. The table includes the information about the name of the field and the type of the fields. + +**Table 5.4.3.1-1: Nu Provisioning JSON fields** + +| Field Name | Clause defined | JSON Value Type
(NOTE 1) | JCR Type
(NOTE 2) | Applicability
(NOTE 4) | +|------------------------|--------------------|-----------------------------|----------------------|---------------------------| +| application-identifier | 3GPP TS 29.251 [9] | string | string | | +| allowed-delay | 3GPP TS 29.251 [9] | number | uint64 | | +| pfdids | 3GPP TS 29.251 [9] | array | array | | +| pfd-identifier | 3GPP TS 29.251 [9] | string | string | | +| flow-descriptions | 3GPP TS 29.251 [9] | array | array | | +| urls | 3GPP TS 29.251 [9] | array | array | | +| domain-names | 3GPP TS 29.251 [9] | array | array | | +| removal-flag (NOTE 3) | 3GPP TS 29.251 [9] | boolean | boolean | | +| partial-flag (NOTE 3) | 3GPP TS 29.251 [9] | boolean | boolean | | +| dn-protocol | 3GPP TS 29.251 [9] | string | string | DomainNameProtocol | +| scef-notification-uri | 5.4.3.2 | string | string | PfdMgmtNotification | + +NOTE 1: The basic JSON value types are defined in IETF RFC 7159 [11]. +NOTE 2: The JCR types are defined in IETF draft-newton-json-content-rules [12]. +NOTE 3: Only one of the removal-flag and the partial-flag for the application identifier shall be set to true. +NOTE 4: Fields marked with a supported feature are applicable as described in subclause 5.3.6. + +#### 5.4.3.2 scef-notification-uri + +The scef-notification-uri is of type string indicating the SCEF sent URI for receiving notifications. + +### 5.4.4 Void + +### 5.4.5 JSON errors and informational response fields + +#### 5.4.5.1 General + +Table 5.4.4.1-1 describes the JSON fields defined for the errors and informational responses including their types and the field names. + +**Table 5.4.5.1-1: JSON fields for errors and informational response** + +| Field Name | Subclause defined | JSON Value Type (NOTE 1) | JCR Type (NOTE 2) | Applicability (NOTE 5) | +|-----------------|-----------------------------|--------------------------|-----------------------------------------------------------------|------------------------| +| errors | 3GPP TS 29.251 [9] (NOTE 4) | array | array | | +| error-type | 3GPP TS 29.251 [9] (NOTE 4) | string | "application"
"interface"
"server"
"other"
(NOTE 3) | | +| error-message | 3GPP TS 29.251 [9] | string | string | | +| error-tag | 3GPP TS 29.251 [9] | string | string | | +| error-path | 3GPP TS 29.251 [9] | string | string | | +| error-info | 3GPP TS 29.251 [9] | object | object | | +| success-message | 3GPP TS 29.251 [9] | string | string | | +| success-path | 3GPP TS 29.251 [9] | string | string | | +| success-info | 3GPP TS 29.251 [9] | object | object | | + +NOTE 1: The basic JSON value types are defined in IETF RFC 7159 [11]. +NOTE 2: The JCR types are defined in IETF draft-newton-json-content-rules [12]. +NOTE 3: The quoted strings for a string type. +NOTE 4: The error is sent from the PPDF to the SCEF. +NOTE 5: Fields marked with a supported feature are applicable as described in subclause 5.3.6. + +### 5.4.6 JSON report fields + +#### 5.4.6.1 General + +Table 5.4.6.1-1 describes the JSON fields defined for the report information objects which are included in the error-info field. + +**Table 5.4.6.1-1: JSON fields for Report from the PPDF** + +| Field Name | Subclause defined | JSON Value Type (NOTE 1) | JCR Type (NOTE 2) | Applicability (NOTE 4) | +|------------------|-----------------------------|--------------------------|-------------------|------------------------| +| pfd-reports | 5.4.6.2 | array | array | | +| application-ids | 5.4.6.3 | array | array | | +| pfd-failure-code | 3GPP TS 29.251 [9] (NOTE 3) | string | string | | +| caching-time | 3GPP TS 29.251 [9] | number | uint64 | | + +NOTE 1: The basic JSON value types are defined in IETF RFC 7159 [11]. +NOTE 2: The JCR types are defined in IETF draft-newton-json-content-rules [12]. +NOTE 3: The additional failure reasons for Nu are "TOO\_SHORT\_ALLOWED\_DELAY". +NOTE 4: Fields marked with a supported feature are applicable as described in subclause 5.3.6. + +#### 5.4.6.2 pfd-reports + +The pfd-reports field is of type array and it contains a list of pfd reports. + +The pfd-reports field can be used in an HTTP response to report failures in the installation/modification of PFDs. In this case, it shall be provided as a sub field of the error-info field. + +Multiple pfd report instances shall be provided within the pfd-reports field if different pfd-failure-code values are applicable within the same HTTP response. + +caching-time field is included if the pfd-failure-code is set to the value "TOO\_SHORT\_ALLOWED\_DELAY". + +A report instance shall contain application-ids and pfd-failure-code fields. + +The JCR format for the pfd-reports is: + +\$pfd-reports = "pfd-reports" : [ + +``` +{ $application-ids, + $pfd-failure-code, +``` + +\$aching-time, + +} + + +] + +#### 5.4.6.3 application-ids + +The application-ids field is of type array of string, and contains one or more application identifiers to which the PFDs belong. + +### 5.4.7 JSON notification fields + +#### 5.4.7.1 General + +Table 5.4.7.1-1 describes the JSON notification fields used within the body of the HTTP messages. The table includes the information about the name of the field and the type of the fields. + +**Table 5.4.7.1-1: Nu Notification JSON fields** + +| Field Name | Clause defined | JSON Value Type (NOTE 1) | JCR Type (NOTE 2) | Applicability (NOTE 3) | +|--------------------------|------------------------------|--------------------------|-------------------|------------------------| +| notification-pfd-reports | 5.4.7.2 | array | array | PfdMgmtNotification | +| application-ids | 5.4.6.3 | array | array | PfdMgmtNotification | +| pfd-failure-code | 3GPP TS 29.251 [9] ( NOTE 4) | string | string | PfdMgmtNotification | +| user-plane-location-area | 5.4.7.3 | object | object | PfdMgmtNotification | +| cell-ids | 5.4.7.4 | array | array | PfdMgmtNotification | +| enodeb-ids | 5.4.7.5 | array | array | PfdMgmtNotification | +| extended-enodeb-ids | 5.4.7.6 | array | array | PfdMgmtNotification | +| routing-area-ids | 5.4.7.7 | array | array | PfdMgmtNotification | +| tracking-area-ids | 5.4.7.8 | array | array | PfdMgmtNotification | + +NOTE 1: The basic JSON value types are defined in IETF RFC 7159 [11]. +NOTE 2: The JCR types are defined in IETF draft-newton-json-content-rules [12]. +NOTE 3: Fields marked with a supported feature are applicable as described in subclause 5.3.6. +NOTE 4: The additional failure reasons for Nu are "PARTIAL\_FAILURE". + +#### 5.4.7.2 notification-pfd-reports + +The notification-pfd-reports field is of type array and it contains a list of pfd reports. + +The notification-pfd-reports field can be used in an HTTP POST to notify the failures in the installation/modification of PFDs. In this case, it shall be included in the body of the message. + +Multiple pfd report instances shall be provided within the notification-pfd-reports field if different pfd-failure-code values are applicable within the same HTTP response. + +user-plane-location-area field is included if the pfd-failure-code is set to the value "PARTIAL\_FAILURE". + +A report instance shall contain application-ids and pfd-failure-code fields. + +The JCR format for the notification-pfd-reports is: + +``` +$notification-pfd-reports = "notification-pfd-reports" : [ +{ + $application-ids, + $pfd-failure-code, + $user-plane-location-area ? +} + +] +``` + +#### 5.4.7.3 user-plane-location-area + +The user-plane-location-areas field is of type object and it contains location areas of the user plane(s) which can not enforce the PFD(s) successfully. + +The JCR format for the user-plane-location-area is: + +``` +$user-plane-location-area = // : { + $cell-ids ?, + $enodeb-ids ?, + $extended-enodeb-ids ?, + $routing-area-ids ?, + $tracking-area-id ? +} +``` + +#### 5.4.7.4 cell-ids + +The cell-ids is of type string array and it contains a list of Cell Global Identities served by the user plane(s) which can not enforce the PFD(s) successfully. The content of the string has the same encoding as defined in subclause 8.21.1 of 3GPP TS 29.274 [19]. + +#### 5.4.7.5 enodeb-ids + +The enodeb-ids is of type string array and it contains a list of eNodeB identities served by the user plane(s) which can not enforce the PFD(s) successfully. The content of the string has the same encoding as defined in subclause 8.21.7 of 3GPP TS 29.274 [19]. + +#### 5.4.7.6 extended-enodeb-ids + +The enodeb-ids is of type string array and it contains a list of eNodeB identities served by the user plane(s) which can not enforce the PFD(s) successfully. The content of the string has the same encoding as defined in subclause 8.21.8 of 3GPP TS 29.274 [19]. + +#### 5.4.7.7 routing-area-ids + +The routing-area-ids is of type string array and it contains a list of Routing Area Identities served by the user plane(s) which can not enforce the PFD(s) successfully. The content of the string has the same encoding as defined in subclause 8.21.3 of 3GPP TS 29.274 [19]. + +#### 5.4.7.8 tracking-area-ids + +The tracking-area-ids is of type string array and it contains a list of Tracking Area Identities served by the user plane(s) which can not enforce the PFD(s) successfully. The content of the string has the same encoding as defined in subclause 8.21.4 of 3GPP TS 29.274 [19]. + +## 5.5 PFDF discovery + +The PFDF URI may be pre-configured on the SCEF. + +The SCEF may select the PFDF by this configuration. + +## 5.6 SCEF discovery + +The SCEF notification URI may be pre-configured on the PFDF. + +The SCEF notification URI may also be sent to the PFDF in the PFD provisioning. + +The PFDF may select the SCEF by the pre-configuration or use the notification URI received in the PFD provisioning. + +# 6 Secure communication + +Either the NDS/IP network layer security defined in 3GPP TS 33.210 [5] or HTTP over TLS as defined in IETF RFC 2818 [6] should be used to secure communication over the REST based Nu interface. + +# Annex A (informative): JSON Schema + +## A.1 Provisioning schema + +This subclause defines the JSON schema for the body of HTTP request providing the provisioned PFDs. The schema is based on IETF draft-newton-json-content-rules [12] and is defined below: + +``` +# jcr-version 0.7 +``` + +``` +# ruleset-id 3gpp.nuapplication.provisioning +``` + +``` +# import 3gpp.gwapplication.pfds as pfds +``` + +``` +; JCR representing the PFDs provisioning data +``` + +``` +$provisioning-root = @ {root} { +``` + +``` + $application-identifier, +``` + +``` + $removal-flag ?, +``` + +``` + $partial-flag ?, +``` + +``` + $allowed-delay ?, +``` + +``` + $pfds ?, +``` + +``` + $scefn-notification-uri ? +``` + +``` +} +``` + +``` +; An array list of the PFDs for multiple application identifiers +``` + +``` +$pfds-array-root = @ {root} [ $provisioning-root * ] +``` + +``` +; The detected application traffic identifier for the PFDs +``` + +``` +$application-identifier = "application-identifier" : string +``` + +``` +; The allowed delay time for the PFDs deployment +``` + +``` +$allowed-delay = "allowed-delay" : uint64 +``` + +``` +; The PFDs associated with the same application identifier +``` + +``` +$pfds = "pfds" : [ $pfd * ] +``` + +``` +; The PFD content +``` + +``` + +$pid = { + $pid-identifier, + ( $flow-descriptions | $urls | $domain-names | // : any) ?, + $pids.dn-protocol ? +} + +; The PFD identifier +$pid-identifier = "pid-identifier" : string + +; The flow descriptions +$flow-descriptions = "flow-descriptions" : [ string + ] + +; The url matching expressions +$urls = "urls" : [ string + ] + +; The domain name match criteria +$domain-names = "domain-names" : [ string + ] + +; A flag indicates whether this is a removal or not +$removal-flag = "removal-flag" : boolean + +; A flag indicates whether this is a partial update or not +$partial-flag = "partial-flag" : boolean + +; The URI in the SCEF for receiving notifications from the PPDF +$scef-notification-uri = "scef-notification-uri" : string + +``` + +## A.2 Error and Informational response schema + +This subclause defines the JSON schema for the body of HTTP responses in case of errors or success. The schema is based on IETF draft-newton-json-content-rules [12] and is defined below: + +``` + +# jcr-version 0.7 + +# ruleset-id 3gpp.nuapplication.info + +; A JCR for the error/successful response body +; Errors information + +``` + +\$errors-root = @ {root} { \$errors } + +; Success information + +\$success-root = @ {root} { +    \$success-message, +    \$success-path ?, +    \$success-info ? +} + +; Resource fields definitions + +; The list of errors returned in responses sent by the PCEF/TDF + +\$errors = "errors" : [ +{ +    \$error-type, +    \$error-message, +    \$error-tag ?, +    \$error-path ?, +    \$error-info ? +} + +] + +; The error type for an error. It can be one of 'application', 'interface', 'server' and 'other'. + +\$error-type = "error-type" : ( "application" | "interface" | "server" | "other" ) + +; The error text message + +\$error-message = "error-message" : string + +; The error tag for a specific error + +\$error-tag = "error-tag" : string + +; A JSON pointer path to the error resource + +\$error-path = "error-path" : string + +; Any additional information for the error + +\$error-info = "error-info" : { + +``` +$pfd-reports ?, + // : any * +} + +; Report fields definitions +; The list of pfd reports sent to the SCEF +$pfd-reports = "pfd-reports" : [ +{ + $application-ids, + $pfd-failure-code, + $caching-time +} + +] + +; The application identifiers for the PFDs +$application-ids = "application-ids" : [string+] + +; The string format for the pfd failure code +$pfd-failure-code =: ( + "MALFUNCTION" | + "RESOURCES_LIMITATION" | + "TOO_SHORT_ALLOWED_DELAY" | + "PARTIAL_FAILURE" | + "OTHER_REASON" +) + +; The caching time for the PFDs +$caching-time = "caching-time" : uint64 + +; The successful text message +$success-message = "success-message" : string + +; A JSON pointer path to the success resource +$success-path = "success-path" : string + +; Any additional information for the success. +``` + +``` +$success-info = "success-info" : { // : any *} +``` + +## A.3 PFD management notification schema + +This subclause defines the JSON schema for the body of HTTP request providing the notification of PFD management. The schema is based on IETF draft-newton-json-content-rules [12] and is defined below: + +``` +# jcr-version 0.7 +``` + +``` +# ruleset-id 3gpp.nuapplication.notification +``` + +``` +; A JCR for the notification body +``` + +``` +$notification-root = @ {root} { +``` + +``` + $notification-pfd-reports +``` + +``` +} +``` + +``` +; Report fields definitions +``` + +``` +; The list of pfd reports sent to the SCEF +``` + +``` +$notification-pfd-reports = "notification- pfd-reports" : [ +``` + +``` +{ +``` + +``` + $application-ids, +``` + +``` + $pfd-failure-code, +``` + +``` + $user-plane-location-area ? +``` + +``` +} + +``` + +``` +] +``` + +``` +; The application identifiers for the PFDs +``` + +``` +$application-ids = "application-ids" : [string+] +``` + +``` +; The string format for the pfd failure code +``` + +``` +$pfd-failure-code =: ( +``` + +``` + "MALFUNCTION" | +``` + +``` + "RESOURCES_LIMITATION" | +``` + +``` + "PARTIAL_FAILURE" | +``` + +``` + "OTHER_REASON" +``` + +``` +) +``` + +``` +; The location area of user planes which can not enforce the PFDs successfully +``` + +``` +$user-plane-location-area = { +``` + +\$cell-ids ?, +\$enodeb-ids ?, +\$extended-enodeb-ids ?, +\$routing-area-ids ?, +\$tracking-area-ids ? + +} + +; The cell IDs served by the user planes which can not enforce the PFDs successfully + +\$cell-ids = "cell-ids" : [ string + ] + +; The eNodeB IDs served by the user planes which can not enforce the PFDs successfully + +\$enodeb-ids = "enodeb-ids" : [ string + ] + +; The extended eNodeB IDs served by the user planes which can not enforce the PFDs successfully + +\$extended-enodeb-ids = "extended-enodeb-ids" : [ string + ] + +; The Routing Area IDs served by the user planes which can not enforce the PFDs successfully + +\$routing-area-ids = "routing-area-ids" : [ string + ] + +; The Tracking Area IDs served by the user planes which can not enforce the PFDs successfully + +\$tracking-area-ids = "tracking-area-ids" : [ string + ] + +# Annex B (informative): Call Flows + +## B.1 General + +This annex describes the procedures for the interactions between the PFDF and the SCEF. + +## B.2 Provisioning of PFDs + +This subclause describes the signalling flow for the Provisioning of PFDs. + +![Sequence diagram showing the provisioning of PFDs between SCEF and PFDF.](20136850feb70fd71c7d41cdae203ebb_img.jpg) + +``` +sequenceDiagram + participant SCEF + participant PFDF + Note right of SCEF: 1. HTTP POST + SCEF->>PFDF: 1. HTTP POST + Note left of PFDF: 2. HTTP 200 OK + PFDF-->>SCEF: 2. HTTP 200 OK +``` + +The diagram is a sequence diagram illustrating the interaction between the SCEF (Service Capability Exposure Function) and the PFDF (PDN Gateway Selection Function) for provisioning PFDs. It consists of two lifelines: SCEF on the left and PFDF on the right. The first message is an arrow from SCEF to PFDF labeled '1. HTTP POST'. The second message is an arrow from PFDF back to SCEF labeled '2. HTTP 200 OK'. + +Sequence diagram showing the provisioning of PFDs between SCEF and PFDF. + +**Figure B.2.1: Provisioning of PFDs** + +1. The SCEF sends the HTTP POST to the PFDF to indicate the creation, modification or deletion of PFDs for one or more application identifier(s) including the parameters defined in subclause 5.3.5.2. +2. The PFDF sends the HTTP 200 OK response to the SCEF including the parameters defined in subclause 5.3.5.2. + +# Annex C (informative): Change history + +| Date | TSG # | TSG Doc. | CR | Rev | Cat | Subject/Comment | New | +|---------|-------|-----------|------|-----|-----|-----------------------------------------------------------------------------------------------|--------| +| 2016-10 | | | | | | TS skeleton of Nu reference point stage 3. | 0.0.0 | +| 2016-10 | | | | | | Inclusion of C3-163247, C3-163248, C3-163322 and editorial change from Rapporteur. | 0.1.0 | +| 2016-12 | | | | | | Inclusion of C3-164069, C3-164227 and editorial change from Rapporteur. | 0.2.0 | +| 2017-01 | | | | | | Inclusion of C3-170053, C3-17 0054, C3-170056 and editorial change from Rapporteur. | 0.3.0 | +| 2017-02 | | | | | | Inclusion of C3-171187, C3-171324, and editorial change from Rapporteur. | 0.4.0 | +| 2017-04 | | | | | | Inclusion of C3-172121, C3-172193, C3-172278, and editorial change from Rapporteur. | 0.5.0 | +| 2017-05 | | | | | | Inclusion of C3-173200, C3-173202, C3-173332, C3-173333 and editorial change from Rapporteur. | 0.6.0 | +| 2017-06 | CT#76 | CP-171145 | | | | TS sent to plenary for information and approval | 1.0.0 | +| 2017-06 | CT#76 | CP-171145 | | | | TS approved at plenary | 14.0.0 | +| 2017-09 | CT#77 | CP-172047 | 0001 | 2 | F | Caching time over the Nu interface | 14.1.0 | +| 2017-09 | CT#77 | CP-172047 | 0002 | 2 | F | Clarification of partial update | 14.1.0 | +| 2017-09 | CT#77 | CP-172047 | 0003 | 1 | F | Correct the example of the PFD provisioning | 14.1.0 | +| 2017-09 | CT#77 | CP-172047 | 0004 | 1 | F | Update the reference of HTTP 1.1 | 14.1.0 | +| 2017-09 | CT#77 | CP-172047 | 0007 | - | F | PFD handling for Push or Combination mode in PFDF | 14.1.0 | +| 2017-12 | CT#78 | CP-173100 | 0008 | - | F | JSON example correction | 14.2.0 | +| 2018-06 | CT#80 | | | | | Automatic upgrade from previous Release | 15.0.0 | +| 2019-03 | CT#83 | CP-190131 | 0010 | 2 | B | Supported feature negotiation | 16.0.0 | +| 2019-03 | CT#83 | CP-190133 | 0012 | 2 | B | PFD extension | 16.0.0 | +| 2019-06 | CT#84 | CP-191097 | 0015 | - | A | Reference update: draft-newton-json-content-rules | 16.1.0 | +| 2019-06 | CT#84 | CP-191100 | 0016 | - | F | Encoding of custom header fields | 16.1.0 | +| 2019-06 | CT#84 | CP-191102 | 0018 | 1 | B | PFD management notification | 16.1.0 | +| 2019-12 | CT#86 | CP-193220 | 0019 | 3 | B | PFD partial failure notification | 16.2.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29251/1b893df61c2b73b7a85e65fc1f58e203_img.jpg b/marked/Rel-16/29_series/29251/1b893df61c2b73b7a85e65fc1f58e203_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..38a516f2be2fdb78733c094a258f69b6c3ad3053 --- /dev/null +++ b/marked/Rel-16/29_series/29251/1b893df61c2b73b7a85e65fc1f58e203_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2b537892ddf28b0b6135345f99b8cf734714b5e25459a611f342e3310c2256c9 +size 23016 diff --git a/marked/Rel-16/29_series/29251/7e670a2b556b53ea9002dfff3a420e08_img.jpg b/marked/Rel-16/29_series/29251/7e670a2b556b53ea9002dfff3a420e08_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..844b4e4d476b5175a9c4457388d3262cfa9812d4 --- /dev/null +++ b/marked/Rel-16/29_series/29251/7e670a2b556b53ea9002dfff3a420e08_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:175364e97f238d026beb5a17c18ff881531def9d19be4af966378528f7c64cf5 +size 34124 diff --git a/marked/Rel-16/29_series/29251/b5335262987c819d7f71ce40f99cb71b_img.jpg b/marked/Rel-16/29_series/29251/b5335262987c819d7f71ce40f99cb71b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..58c2438f33c6ed5b704b716302ec43f294786f39 --- /dev/null +++ b/marked/Rel-16/29_series/29251/b5335262987c819d7f71ce40f99cb71b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:776a4e437c814e16d58f366cc10daf441c9180ea7dfb3409d4d4f20b78061e22 +size 17208 diff --git a/marked/Rel-16/29_series/29251/d0abac95583b52a3b35f74a215567334_img.jpg b/marked/Rel-16/29_series/29251/d0abac95583b52a3b35f74a215567334_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..174a9b2c17f2573f562a8a66ccc840ad04352dd9 --- /dev/null +++ b/marked/Rel-16/29_series/29251/d0abac95583b52a3b35f74a215567334_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:86ebd29e895b77fd3bc42ab4d29c406288b1c46f8cbc53ea97dd57fd5a9d6257 +size 6711 diff --git a/marked/Rel-16/29_series/29251/f0b7abcb093621bb310bf61fbe0f0d2d_img.jpg b/marked/Rel-16/29_series/29251/f0b7abcb093621bb310bf61fbe0f0d2d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4f5dcf93b14f220f98312d587dfd7ebb2258be0a --- /dev/null +++ b/marked/Rel-16/29_series/29251/f0b7abcb093621bb310bf61fbe0f0d2d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a70a56b3243584418ffefc65eb0a3d099e8e4e51e3f00fbece50bf7b352e42e8 +size 16915 diff --git a/marked/Rel-16/29_series/29251/fc69ceb1dee1da7e33bd6c38fc4ceab9_img.jpg b/marked/Rel-16/29_series/29251/fc69ceb1dee1da7e33bd6c38fc4ceab9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4973c835f063ac0b71ce904cb2c6f20a9ddfe156 --- /dev/null +++ b/marked/Rel-16/29_series/29251/fc69ceb1dee1da7e33bd6c38fc4ceab9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:22fdb11cd4d73815caf8b3ab02bcb23d0d3ca9f8869bd02ae611a0a7cb1b2ada +size 5829 diff --git a/marked/Rel-16/29_series/29251/raw.md b/marked/Rel-16/29_series/29251/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..633b34842a9541273b75f66fcf73b61e96fbdb57 --- /dev/null +++ b/marked/Rel-16/29_series/29251/raw.md @@ -0,0 +1,1504 @@ + + + + +Error! No +text of + +Error! No text of specified style in +document. + +# Contents + +| | | +|-----------------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions and abbreviations ..... | 7 | +| 3.1 Definitions..... | 7 | +| 3.2 Abbreviations ..... | 7 | +| 4 Gw reference point..... | 7 | +| 4.1 Overview ..... | 7 | +| 4.2 Gw reference model ..... | 7 | +| 4.3 Functional elements..... | 8 | +| 4.3.1 PFDF..... | 8 | +| 4.3.2 PCEF..... | 8 | +| 4.4 Procedures over Gw reference point ..... | 8 | +| 4.4.1 Request for PFDs ("Pull mode" and "Combination mode")..... | 8 | +| 4.4.2 Provisioning of PFDs ("Push mode" and "Combination mode") ..... | 9 | +| 5 Gwn reference point..... | 10 | +| 5.1 Overview ..... | 10 | +| 5.2 Gwn reference model ..... | 10 | +| 5.3 Functional elements..... | 10 | +| 5.3.1 PFDF..... | 10 | +| 5.3.2 TDF..... | 10 | +| 5.4 Procedures over Gwn reference point ..... | 10 | +| 6 Gw/Gwn protocol..... | 11 | +| 6.1 Introduction ..... | 11 | +| 6.2 Transport layer ..... | 11 | +| 6.3 Application delivery layer..... | 12 | +| 6.3.2 Resources and URI design..... | 12 | +| 6.3.2.1 General..... | 12 | +| 6.3.2.2 URI design for Pull mode ..... | 13 | +| 6.3.2.3 URI design for Push mode..... | 13 | +| 6.3.3 HTTP request/response formats ..... | 13 | +| 6.3.3.1 General..... | 13 | +| 6.3.3.2 GET /gwapplication/pfds/{application-identifier} ..... | 14 | +| 6.3.3.3 GET /gwapplication/pfds?{query-parameters} ..... | 15 | +| 6.3.3.4 GET /gwapplication/pfds..... | 17 | +| 6.3.3.5 POST /gwapplication/provisioning..... | 18 | +| 6.3.4 HTTP status codes ..... | 20 | +| 6.3.5 Feature negotiation ..... | 20 | +| 6.3.5.1 General..... | 20 | +| 6.3.5.2 HTTP custom headers..... | 21 | +| 6.3.5.2.1 3gpp-Optional-Features..... | 21 | +| 6.3.5.2.2 3gpp-Required-Features..... | 21 | +| 6.3.5.2.3 3gpp-Accepted-Features..... | 21 | +| 6.3.5.3 Precedence for HTTP custom headers ..... | 22 | +| 6.4 Specific application communication ..... | 22 | +| 6.4.1 General ..... | 22 | +| 6.4.2 Content type..... | 22 | +| 6.4.3 JSON PFDs fields..... | 22 | +| 6.4.3.1 General..... | 22 | +| 6.4.3.2 application-identifier..... | 22 | +| 6.4.3.3 void ..... | 23 | +| 6.4.3.4 caching-time..... | 23 | +| 6.4.3.5 pfd..... | 23 | +| 6.4.3.6 pfd-identifier ..... | 23 | +| 6.4.3.7 flow-descriptions ..... | 23 | + +6.4.3.8 urls ..... 23 + +6.4.3.9 domain-names..... 24 + +6.4.3.10 dn-protocol..... 24 + +6.4.4 JSON provisioning fields ..... 24 + +6.4.4.1 General..... 24 + +6.4.4.2 notification-flag ..... 24 + +6.4.4.3 removal-flag..... 24 + +6.4.4.4 allowed-delay..... 25 + +6.4.4.5 partial-flag..... 25 + +6.4.5 JSON errors and informational response fields..... 25 + +6.4.5.1 General..... 25 + +6.4.5.2 error-tag ..... 25 + +6.4.6 JSON report fields ..... 25 + +6.4.6.1 General..... 25 + +6.4.6.2 pfd-reports..... 26 + +6.4.6.3 pfd-failure-code ..... 26 + +6.5 The discovery of PCEF/TDF and PFDF ..... 26 + +6.5.1 PCEF/TDF discovery ..... 26 + +6.5.2 PFDF discovery ..... 26 + +7 Secure communication..... 27 + +**Annex A (normative): JSON Schema ..... 28** + +A.1 PFDs schema..... 28 + +A.2 Provisioning schema ..... 29 + +A.3 Error and Informational response schema ..... 30 + +**Annex B (informative): Call Flows..... 33** + +B.1 General ..... 33 + +B.2 Request for PFDs (“Pull mode”)..... 33 + +B.3 Provisioning of PFDs (“Push mode”) ..... 33 + +B.4 Provisioning of PFDs by Push with Notifications ..... 34 + +Annex C (informative): Change history..... 36 + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# 1 Scope + +The present document provides the stage 3 specification of the Gw and Gwn reference points. The functional requirements and the stage 2 specifications of the Gw and Gwn reference points are specified in 3GPP TS 23.203 [2]. The Gw reference point lies between the Packet Flow Description Function (PFDF) and the Policy and Charging Enforcement Function (PCEF). The Gwn reference point lies between the Packet Flow Description Function (PFDF) and the Traffic Detection Function (TDF). + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.203: "Policy and charging control architecture". +- [3] 3GPP TS 29.213: "Policy and Charging Control signalling flows and QoS parameter mapping" +- [4] 3GPP TS 23.682: "Architecture enhancements to facilitate communications with packet data networks and applications". +- [5] 3GPP TS 29.212: "Policy and Charging Control (PCC); Reference points". +- [6] IETF RFC 793: "Transmission Control Protocol". +- [7] Void. +- [8] 3GPP TS 33.210: "3G security; Network Domain Security (NDS); IP network layer security". +- [9] IETF RFC 2818: "HTTP Over TLS". +- [10] IETF RFC 3986: "Uniform Resource Identifier (URI): Generic Syntax" +- [11] IETF RFC 7159: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [12] IETF draft-newton-json-content-rules-09: "A Language for Rules Describing JSON Content". + +NOTE: This individual draft will not further progress in IETF. It is available from the following link: +. + +- [13] IETF RFC 6733: "Diameter Base Protocol". +- [14] 3GPP TS 29.250: "Nu reference point between SCEF and PFDF for sponsored data connectivity". +- [15] 3GPP TS 29.155: "Traffic steering control; Representational state transfer (REST) over St reference point". +- [16] IETF RFC 7230: "Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing". +- [17] IETF RFC 7231: "Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content". +- [18] IETF RFC 7232: "Hypertext Transfer Protocol (HTTP/1.1): Conditional Requests". +- [19] IETF RFC 7233: "Hypertext Transfer Protocol (HTTP/1.1): Range Requests". + +- [20] IETF RFC 7234: "Hypertext Transfer Protocol (HTTP/1.1): Caching". +- [21] IETF RFC 7235: "Hypertext Transfer Protocol (HTTP/1.1): Authentication". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in TR 21.905 [1]. + +**Packet Flow Description (PFD):** A set of information enabling the detection of application traffic provided by a 3rd party service provider (from 3GPP TS 23.203 [2]). + +**Pull mode:** A mode used between the PCEF/TDF and the PFDF where the PFDs are sent by the PFDF at reception of an HTTP request from the PCEF/TDF. + +**Push mode:** A mode used between the PCEF/TDF and the PFDF where the PFDs and/or notification of PFD deletion are sent by the PFDF in an HTTP request to the PCEF/TDF. + +**Combination mode:** A mode used between the PCEF/TDF and the PFDF where both pull and push exist. This mode allows the PFDF to send the PFDs at reception of an HTTP request from the PCEF/TDF and provision PFD changes (creation/update/deletion) and/or notification of PFD creation/update/deletion in the HTTP request to the PCEF/TDF. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|------|------------------------------------------| +| JSON | JavaScript Object Notation | +| PCEF | Policy and Charging Enforcement Function | +| PFD | Packet Flow Description | +| PFDF | Packet Flow Description Function | +| SCEF | Service Capability Exposure Function | +| TDF | Traffic Detection Function | + +# --- 4 Gw reference point + +## 4.1 Overview + +The Gw reference point is located between the Packet Flow Description Function (PFDF) and the Policy and Charging Enforcement Function (PCEF). The Gw reference point is used for provisioning and removal of PFDs from the PFDF to the PCEF and reporting the handling result of PFDs from the PCEF to the PFDF. + +The stage 2 level requirements for the Gw reference point are defined in 3GPP TS 23.203 [2]. + +## 4.2 Gw reference model + +The Gw reference point is defined between the PFDF and the PCEF. The relationships between the different functional entities involved are depicted in figure 4.2.1. The overall PCC architecture is depicted in subclause 3a of 3GPP TS 29.213 [3]. + +![Figure 4.2.1: Gw reference model diagram showing PCEF and PFDF connected via a Gw interface.](d0abac95583b52a3b35f74a215567334_img.jpg) + +The diagram illustrates the Gw reference model. It consists of two rectangular boxes, one on the left labeled 'PCEF' and one on the right labeled 'PFDF'. Both boxes are light green with a darker green border. A horizontal line connects the two boxes, representing the 'Gw' interface. The label 'Gw' is positioned above the line, centered between the two boxes. + +Figure 4.2.1: Gw reference model diagram showing PCEF and PFDF connected via a Gw interface. + +**Figure 4.2.1: Gw reference model** + +## 4.3 Functional elements + +### 4.3.1 PFDF + +The PFDF (Packet Flow Description Function) is a functional element which stores PFDs associated with application identifier(s) and transfers them to the PCEF via Gw interface to enable the PCEF to perform accurate application detection when the PFDs are managed by a 3rd party service provider. + +The PFDF receives PFDs for the corresponding application identifier(s) from the SCEF as defined in 3GPP TS 23.682 [4] and 3GPP TS 29.250 [14]. + +### 4.3.2 PCEF + +The PCEF (Policy and Charging Enforcement Function) functionality defined in subclause 4.4.2 of 3GPP TS 29.212 [5] shall be applied. In addition, the PCEF shall support the management of PFDs provisioned by the PFDF. The application detection filter may be extended with the PFDs provided by the PFDF. + +## 4.4 Procedures over Gw reference point + +When the PFDF is deployed and the management of PFDs is supported by the PCEF, the mode of PFDs management shall be consistently configured in one PLMN, it may be: + +- Pull mode only, or +- Push mode only, or +- Combination mode. + +### 4.4.1 Request for PFDs ("Pull mode" and "Combination mode") + +At the time a PCC Rule with an application identifier for which PFDs provisioned by the PFDF are not available is activated or provisioned, or when the caching timer for an application identifier elapses and a PCC Rule for the application identifier is still active, the PCEF shall request all PFDs for the application identifier from the PFDF. + +The PCEF shall send an HTTP GET message to the PFDF to retrieve the PFDs for one or more application identifier(s) as defined in subclauses 6.3.3.2, 6.3.3.3 and 6.3.3.4. + +Upon receipt of the HTTP request for the pull operation, the PFDF shall respond to the PCEF indicating whether the pull operation was successful or not by using one of the HTTP status codes; if the pull operation is successful, the PFDF : + +- shall provide the PFDs of the specified application identifier(s) from the request within the body of the HTTP response; and +- if there are caching time value(s) configured for any of the specified application identifier(s), shall set the caching-time to the caching time value(s) for those application identifier(s) in the body of the HTTP response. + +The PCEF shall install, update or remove the received PFD(s) for the application identifier(s). + +The PCEF shall also for each application identifier start a caching timer with a value + +- according to the received caching time value for that application identifier, if such a value is received for that application identifier; or +- otherwise with a default caching time value configured in the PCEF. + +NOTE 1: The PCEF(s) and the PFDF(s) within an operator network are configured with the same default caching time value to be applied for all application identifiers. + +NOTE 2: In the combination mode, the HTTP POST message from the PFDF does not impact the running caching timer of an application identifier. + +When the PCEF removes the last PCC rule that refers to the corresponding application identifier, or when the caching timer expires and no PCC rule refers to the application identifier, the PCEF may remove the PFD(s) related with the application identifier. + +The PFDs retrieved from PFDF take precedence over any PFDs pre-configured in the PCEF. If all PFDs retrieved from the PFDF are removed for an application identifier, the pre-configured PFDs shall be applied again for the application identifier. + +### 4.4.2 Provisioning of PFDs ("Push mode" and "Combination mode") + +The PFDF may create, update or remove one or multiple PFDs associated with application identifier(s) to the PCEF. When the request for creation, update, or removal for an application identifier(s) is received from the SCEF, for the Push mode, the PFDF shall for each PCEF it serves: + +- immediately send to the PCEF an HTTP POST message including the provisioned changes of one or more application identifiers as specified in subclause 6.3.3.5, or +- wait for a period shorter than the allowed delay ( e.g. to aggregate all the PFDs for several application) , then send to the PCEF an HTTP POST message including the provisioned changes. + +For the Combination mode, the PFDF may for each PCEF it serves wait for a period shorter than the allowed delay (e.g. to aggregate all the PFDs for several application) and, if no HTTP GET request for that application identifier is received during the waiting time, then send an HTTP POST message including the provisioned changes and/or notification of PFD creation/update for that application identifier as specified in subclause 6.3.3.5. + +NOTE 1: In the combination mode, the PFDF can check the received allowed delay against the caching time as specified in subclause 4.4.1 of 3GPP TS 29.250 [14], in order to utilize the pull procedure. + +When the PCEF receives the HTTP POST message, the PCEF shall + +- for an application identifier(s) where no flag is provided, remove the all existing all PFD(s) (if available) and install all the new provided PDF(s). +- for an application identifier(s) where the removal-flag is also provided and set to true, delete the existing PFD(s); +- for an application identifier(s) where partial-flag is also provided and set to true + - install a new PFD(s) if the new PFD(s) with a new PFD identifier(s) is received, + - update an existing PFD(s) if a new PFD(s) with the same PFD identifier(s) is received, and/or + - delete an existing PFD(s) if the same PFD identifier(s) without any content is received; +- acknowledge the HTTP POST message by sending a corresponding HTTP response with the appropriate status code (200 OK for success) as described in subclause 6.3.4; and +- retrieve the PFDs for the corresponding application identifier(s) as defined in subclause 4.4.1 either immediately if the allowed-delay is not provided, or within the provided allowed-delay for the application identifier(s) where the notification-flag is included and set to true. + +NOTE 2: It depends on the implementation whether the PCEF initiates separate pull requests to retrieve the PFDs for different application identifier(s) within the allowed-delay. The decision to send PFD, and/or notification of PFD creation/update/deletion for certain application identifier on the PFDF is based on the operator policy. + +NOTE 3: In the push mode, the PFDF can be configured with the list of PCEFs per application identifier(s). + +NOTE 4: The caching timer is not applicable for the PCEF/TDF in Push mode. + +# 5 Gwn reference point + +## 5.1 Overview + +The Gwn reference point is located between the Packet Flow Description Function (PFDF) and the Traffic Detection Function (TDF). The Gwn reference point enables transport of PFDs from the PFDF to the TDF for a particular Application Identifier or for a set of Application Identifiers. + +The Gwn reference point supports the following functions: + +- Creation, updating and removal of individual or the whole set of PFDs from the PFDF to the TDF. +- Confirmation of creation, updating and removal of PFDs from the TDF to the PFDF. + +NOTE: The interaction between the PFDF and the TDF is not related to any IP-CAN session. + +The stage 2 level requirements for the Gwn reference point are defined in 3GPP TS 23.203 [2]. + +## 5.2 Gwn reference model + +The Gwn reference point is defined between the PFDF and the TDF. The relationships between the different functional entities involved are depicted in figure 5.2.1. The overall PCC architecture is depicted in subclause 3a of 3GPP TS 29.213 [3]. + +![Diagram of the Gwn reference model showing the TDF and PFDF connected by the Gwn reference point.](fc69ceb1dee1da7e33bd6c38fc4ceab9_img.jpg) + +The diagram shows two light green rectangular boxes, labeled 'TDF' on the left and 'PFDF' on the right. A horizontal line connects the two boxes. Above the line, centered between the boxes, is the label 'Gwn'. A small vertical tick mark is placed on the horizontal line, directly below the 'Gwn' label. + +Diagram of the Gwn reference model showing the TDF and PFDF connected by the Gwn reference point. + +Figure 5.2.1: Gwn reference model + +## 5.3 Functional elements + +### 5.3.1 PFDF + +Subclause 4.3.1 is applicable with the clarification that the TDF replaces the PCEF and Gwn interface replaces Gw interface. + +### 5.3.2 TDF + +The TDF (Traffic Detection Function) functionality defined in subclause 4b.4.2 of 3GPP TS 29.212 [5] shall be applied. In addition, the TDF shall support the management of PFDs provisioned by the PFDF. + +## 5.4 Procedures over Gwn reference point + +The procedures in subclause 4.4 are applicable with the clarification that the TDF replaces the PCEF in those procedures. + +# 6 Gw/Gwn protocol + +## 6.1 Introduction + +The following layers of the protocol stack for the Gw/Gwn reference point between PCEF/TDF and PFDF are described in subclauses: + +- TCP as defined in IETF RFC 793 [6] provides the communication service at the transport layer. + +- An optional communication security layer can be added between the transport and the application delivery layer (see clause 7). +- The application delivery layer provides the transport of the specific application communication data using HTTP as defined in IETF RFC 7230 [16], IETF RFC 7231 [17], IETF RFC 7232 [18], IETF RFC 7233 [19], IETF RFC 7234 [20] and IETF RFC 7235 [21]. +- The specific application communication layer constitutes the transport of the JSON content type. + +Figure 6.1.1 illustrates the protocol stack of the RESTful Gw/Gwn reference point. + +![Figure 6.1.1: Protocol stack of the Gw/Gwn reference point. The diagram shows two protocol stacks separated by a vertical line labeled 'Gw/Gwn'. The left stack is for PCEF/TDF and the right stack is for PFDF. Both stacks have six layers: Specific application communication (JSON), Application delivery (HTTP), Transport layer (TCP), Network layer (IP), Data link layer (L2), and Physical layer (L1).](7e670a2b556b53ea9002dfff3a420e08_img.jpg) + +| | | | | +|------------------------------------|----------|--------|------| +| Specific application communication | JSON | | JSON | +| Application delivery | HTTP | | HTTP | +| Transport layer | TCP | | TCP | +| Network layer | IP | | IP | +| Data link layer | L2 | | L2 | +| Physical layer | L1 | | L1 | +| | PCEF/TDF | Gw/Gwn | PFDF | + +Figure 6.1.1: Protocol stack of the Gw/Gwn reference point. The diagram shows two protocol stacks separated by a vertical line labeled 'Gw/Gwn'. The left stack is for PCEF/TDF and the right stack is for PFDF. Both stacks have six layers: Specific application communication (JSON), Application delivery (HTTP), Transport layer (TCP), Network layer (IP), Data link layer (L2), and Physical layer (L1). + +**Figure 6.1.1: Protocol stack of the Gw/Gwn reference point** + +## 6.2 Transport layer + +HTTP is layered over TCP, which provides a reliable transport. + +If the "Pull mode" is deployed, then the PCEF/TDF shall act as an HTTP client and the PFDF shall act as an HTTP server. In this case, the PCEF/TDF shall initiate a TCP connection with the PFDF. + +If the "Push mode" is deployed, then the PFDF shall act as an HTTP client and the PCEF/TDF shall act as an HTTP server. In this case, the PFDF shall initiate a TCP connection with the PCEF/TDF. + +If the "Combination mode" is deployed, then + +- for pull request, the HTTP roles and TCP session establishment as described above for the "Pull mode" apply. +- for push request (with or without notification), the HTTP roles and TCP session establishment as described above for the "Push mode" apply. + +## 6.3 Application delivery layer + +The application delivery layer shall use RESTful HTTP. + +The application delivery layer provides the following services: + +- Retrieval of the PFDs from the PFDF +- Provisioning of the PFDs by the PFDF +- Notification sent from PFDF to the PCEF/TDF to indicate PFD changes related to application identifiers being created, updated or deleted + +In order to retrieve the PFD for a specific application identifier, the PFDF shall send an HTTP GET message including the application identifier as a path element of the request URI as specified in subclause 6.3.3.2. + +In order to retrieve the PFDs for a set of application identifiers, the PCEF/TDF shall send an HTTP GET message to the PFDF including the application identifier(s) as the query parameters in the URI as specified in subclause 6.3.3.3. + +In order to retrieve all PFDs, the PCEF/TDF may omit the '?' and {query parameters} in the HTTP GET message's URI as specified in subclause 6.3.3.4. + +If the PFDF needs to provision PFDs for a set of application identifier(s) (creation/update/deletion) to the PCEF/TDF, the PFDF shall send an HTTP POST message, which includes the provisioned changes and/or the notifications of impacted application identifiers as described in subclause 6.3.3.5. + +### 6.3.1 Methods + +Methods indicate to the server what action has to be performed. Every HTTP request message has a method. The following HTTP methods can be used: + +- GET: Used by the PCEF/TDF to retrieve the PFDs information for a set of application identifier(s). The server returns the PFDs representation within the body of the response. +- POST: Used by the PFDF to provision or notify PFDs changes for a set of application identifiers(s). The request URI defines the address responsible for the management of the PFDs provisioning as a controller resource. + +Every HTTP request results in a response message that comes back with a status code and further information in its body, if required. The HTTP request initiator waits for this response before initiating a further request. + +### 6.3.2 Resources and URI design + +#### 6.3.2.1 General + +The URI design shall be based on the structure defined in IETF RFC 3986 [10]: + +``` +scheme ":" hier-part [ "?" query ] [ "#" fragment ] +hier-part = "//" authority path-abempty + / path-absolute + / path-rootless + / path-empty +``` + +The scheme may be HTTP or HTTPS for the Gw/Gwn interface. Within a scheme the definition of names shall follow the rules of HTTP URIs. Host and port are the main parts of the authority. The path element identifies the resources. + +For the Gw/Gwn interface, the following required parts of the URI shall be used as follows: + +- scheme: The application delivery layer protocol "http" or "https". +- authority: It includes the server address and optionally a port as follows: host [":" port] +- path-absolute: The path-absolute should have the following ABNF: "/" mainapp "/" mainresource ["/" resourcepath]. In this release: + - "mainapp" is "gwapplication". + - "mainresource" is defined in subclauses 6.3.2.2 and 6.3.2.3. + - "resourcepath" contains the path to identify the PFDs resource for a specific application identifier. + +#### 6.3.2.2 URI design for Pull mode + +In pull mode, the PFDs in PFDF is a readable RESTful resource: + +- "mainresource" is "pfd". +- "resourcepath" varies and is defined in subclauses 6.3.3.2, 6.3.3.3 and 6.3.3.4. + +An example of the URI to identify the RESTful resource is: . + +NOTE: A different resource path can be used when the Resource URI is preconfigured in the PCEF/TDF. + +#### 6.3.2.3 URI design for Push mode + +In push mode, the PFDs management (associating/disassociating PFDs with application identifiers) in PCEF/TDF is a controller resource that is responsible for processing push requests that involve provisioning and/or notifying a set of changes for more than one set of PFDs for corresponding application identifiers atomically. + +- "mainresource" shall be "provisioning". +- "resourcepath" is not applicable in push mode. + +An example of the URI to identify the controller resource is . + +NOTE: A different resource path can be used when the Resource URI is preconfigured in the PFDF. + +### 6.3.3 HTTP request/response formats + +#### 6.3.3.1 General + +The PFDs pull procedure is performed through HTTP transactions consisting of a request initiated by the PCEF/TDF and its corresponding response provided by the PFDF. While the PFDs push procedure is initiated by the PFDF and answered by the PCEF/TDF + +Table 6.3.3.1-1 summarizes the content of the requests and responses. More detailed information is specified in the corresponding subclauses as indicated in the table. + +**Table 6.3.3.1-1: Gw/Gwn requests/response summary table** + +| Method | Resource URI's path | Clause Defined | Request body | Initiator | Response body | +|--------|----------------------------------------------------------|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| GET | /gwapplication/pfds/{application-identifier}
(NOTE 1) | 6.3.3.2 | None | PCEF
/TDF | Successful response: The PFDF shall include the representation of the corresponding PDFs of the specified application identifier in the body of the response as per Annex A.1 | +| GET | /gwapplication/pfds?{query-parameters}
(NOTE 1) | 6.3.3.3 | None | PCEF
/TDF | Successful response: The PFDF shall include the representation of the corresponding PDFs for a set of application identifier(s) in the body of the response as per Annex A.1 | +| GET | /gwapplication/pfds
(NOTE 1) | 6.3.3.4 | None | PCEF
/TDF | Successful response: The PFDF shall include the representation of the corresponding PDFs for all application identifier(s) in the body of the response as per Annex A.1 | +| POST | /gwapplication/provisioning
(NOTE 2) | 6.3.3.5 | Content-Type: application/json
The PFDF may include PFDs content and/or notification associated with application identifier(s) using the schema defined in Annex A.2. | PFDF | Successful response: The PCEF/TDF may include informational data in the body of the response as per Annex A.3 | + +NOTE 1: A different path from /gwapplication/pfds/ may be used when it is configured in the PCEF/TDF. In that case the "path" part set in the different methods should use the configured one. + +NOTE 2: A different path from /gwapplication/provisioning may be used when it is configured in the PFDF. In that case the "path" part set in the different methods should use the configured one. + +#### 6.3.3.2 GET /gwapplication/pfds/{application-identifier} + +To retrieve the PFDs for a specific application identifier, the PCEF/TDF shall send an HTTP GET request to the PFDF as follows: + +- the request URI formatted as defined in subclause 6.3.2 with the "path" part set to: /gwapplication/pfds/{application-identifier}, where the application-identifier is the application id with which the PFDs are associated. + +Upon receipt of the HTTP GET, the PFDF shall respond to the PCEF/TDF indicating whether the querying of the resource was successful or not using one of the HTTP status codes as defined in subclause 6.3.4. If the resource exists, the PFDF shall respond with an HTTP 200 OK status code and include the PFDs representation state within the body of the response as defined in Annex A.1. If no resource was found, the PFDF shall respond with an HTTP 404 not found. The PFDF shall also include the Content-Type header field set to "application/json". + +If the PCEF/TDF receives the HTTP 404 not found status code, the PCEF/TDF shall remove all the PFD(s) of the queried application identifier. + +Below is an example of a corresponding HTTP GET: + +GET /gwapplication/pfds/test-application-1 HTTP/1.1 + +Host: pfdfserver.example.com + +Here is an example of a successful response : + +HTTP/1.1 200 OK + +Server: pfdserver.example.com + +Content-Type: application/json + +Content-Length: ... + +``` +{ + "application-identifier":"test-application-1", + + "caching-time":200000, + + "pfds":[ + { + + "pfd-identifier":"pfd1", + "flow-descriptions":[ + "permit in ip from 10.68.28.39 80 to any", + "permit out ip from any to 10.68.28.39 80" + ] + }, + { + + "pfd-identifier":"pfd2", + "urls":[ + "^http://test.example.com(/\\S*)?\\$" + ] + } + ] +} +``` + +#### 6.3.3.3 GET /gwapplication/pfds?{query-parameters } + +To retrieve the PFDs for a set of application identifier(s), the PCEF/TDF may send an HTTP GET request to the PFDF as follows: + +- The request URI formatted as defined in subclause 6.3.2 with the "path" part set to: /gwapplication/pfds?{query-parameters}, where the query-parameters contains one or multiple application identifier(s) delimited by comma with a parameter name "application-identifiers". As an example: "application-identifiers=id1,id2,id3" +- Any "=" and "," for any application identifier in the query parameters shall be encoded as "%3D" and "%2C" in the URI. + +Upon receipt of the HTTP request, the PFDF shall respond to the PCEF/TDF indicating whether the querying of the resources was successful or not using one of the HTTP status codes as defined in subclause 6.3.4. If at least one resource exists, the PFDF shall respond with an HTTP 200 OK status code and include a list of the PFDs associated with the found application identifier(s) within the body of the response as defined in Annex A.1. If the PFDs associated with a queried application-identifier are not provided in the response, it implicitly means that the corresponding application-identifier does not exist at the PFDF. If no resource was found, the PFDF shall respond with an HTTP 404 not found. The PFDF shall also include the Content-Type header field set to "application/json". + +If the PCEF/TDF receives the 200 OK but one or more queried application identifier(s) is not provided in the response, the PCEF/TDF shall remove the PFD(s) of the queried application identifier(s) which is not included in the response. + +If the PCEF/TDF receives the HTTP 404 not found status code, the PCEF/TDF shall remove all the PFD(s) of the queried application identifier(s). + +Below is an example of this HTTP GET on two sets of PFDs query. But only one is found in the PFDF. + +GET /gwapplication/pfds?application-identifiers=test-application-1,test-application-2 HTTP/1.1 + +Host: pfdserver.example.com + +Here is an example of a successful response : + +HTTP/1.1 200 OK + +Server: pfdserver.example.com + +Content-Type: application/json + +Content-Length: ... + +``` +[ + { + "application-identifier":"test-application-1", + "caching-time":200000, + "pfd": [ + { + "pfd-identifier":"pfd1", + "flow-descriptions": [ + "permit in ip from 10.68.28.39 80 to any", + "permit out ip from any to 10.68.28.39 80" + ] + }, + { + "pfd-identifier":"pfd2", + "urls": [ + "^http://test.example.com(/\\S*)?$" + ] + } + ] + } +] +``` + +``` + } +] +``` + +#### 6.3.3.4 GET /gwapplication/pfds + +To retrieve PFDs associated with all application identifiers, the PCEF/TDF may send an HTTP GET request to the PFDF as follows: + +- The request URI formatted as defined in subclause 6.3.2 with the "path" part set to: /gwapplication/pfds. + +Upon receipt of the HTTP request, the PFDF shall respond to the PCEF/TDF indicating whether the querying of the resources was successful or not using one of the HTTP status codes as defined in subclause 6.3.4. If at least one resource exists, the PFDF shall respond with an HTTP 200 OK status code and include a list of the PFDs associated with the found application identifier(s) within the body of the response as defined in Annex A.1. If no resource was found, the PFDF shall respond with an HTTP 404 not found. The PFDF shall also include the Content-Type header field set to "application/json". + +If the PCEF/TDF receives the 200 OK but one or more application identifier(s) which exists at the PCEF/TDF is not provided in the response, the PCEF/TDF shall remove the PFD(s) of the application identifier(s) which is not included in the response. + +If the PCEF/TDF receives the HTTP 404 not found status code, the PCEF/TDF shall remove all the PFD(s) of all the identifier(s) which exist at the PCEF/TDF. + +Below is an example of this HTTP GET. + +GET /gwapplication/pfds HTTP/1.1 + +Host: pfdserver.example.com + +Here is an example of a successful response : + +HTTP/1.1 200 OK + +Server: pfdserver.example.com + +Content-Type: application/json + +Content-Length: ... + +``` +[ + { + "application-identifier": "test-application-1", + "caching-time": 200000, + "pfds": [ + { + "pfd-identifier": "pfd1", + "flow-descriptions": [ + "permit in ip from 10.68.28.39 80 to any", + "permit out ip from any to 10.68.28.39 80" + ] + }, + ], + }, +] +``` + +``` + + { + "pfd-identifier":"pfd2", + "urls":[ + "^http://test.example.com(/\\S*)?$" + ] + } + ] +} +] + +``` + +#### 6.3.3.5 POST /gwapplication/provisioning + +The provisioning of the PFDs shall be performed by the PFDF by using the POST method as follows: + +- The request URI formatted as defined in subclause 6.3.2 with the "path" part set to: /gwapplication/provisioning. +- The Content-Type header field set to "application/json" +- The body of the message encoded in JSON format as defined in Annex A.2. The body shall include + - for the PFD(s) creation for a new application identifier, a new application identifier and its full list of PFD(s) to be created; + - for the PFD(s) full update for an existing application identifier, the existing application identifier and its new full list of PFD(s); + - for the PFD(s) partial update for an existing application identifier, the existing application identifier, partial update indication and + - new PFD(s) with new PFD identifier(s) to install the new PFD(s) , + - new PFD(s) with existing PFD identifier(s) to update the existing PFD(s), and/or + - the existing PFD identifier(s) without any content to remove the PFD(s); + - for the PFD(s) removal for an existing application identifier, the existing application identifier and the removal indication; + - for the PFD(s) notification, the notification indication and an optional allowed delay time for the PCEF/TDF to pull the corresponding PFD(s) within the allowed delay time. + +Upon receipt of the HTTP POST, the PCEF/TDF shall respond to the PFDF indicating whether the provisioning was successful or not using one of the HTTP status codes as defined in subclause 6.3.4. If the provisioning was accepted, the PCEF/TDF shall respond with an HTTP 200 OK status code if no resource is created, or an HTTP 201 Created status code if one or more resources are created. If the provisioning was rejected, the PCEF/TDF shall indicate the reason using an appropriate HTTP status code for as defined in subclause 6.3.4 and optionally additional information in the body of the response as defined in Annex A.3. If the pfd-reports is included, the PCEF/TDF shall identify the failed PFDs by including the application-identifier and specify the failed reason code by including a pfd-failure-code field. + +Depending on the value of the pfd-failure-code field, the PFDF may provision the PFDs again. + +Below is an example of an HTTP POST and a corresponding successful response: + +POST /gwapplication/provisioning HTTP/1.1 + +Host: pcefserver.example.com + +Content-Type: application/json + +Content-Length: ... + +``` +[ + { + "application-identifier":"test-application-1", + "notification-flag":true, + "allowed-delay":600 + }, + { + "application-identifier":"test-application-2", + "removal-flag":true + }, + { + "application-identifier":"test-application-3", + "pfd": [ + { + "pfd-identifier":"pfd1", + "flow-descriptions": [ + "permit in ip from 10.68.28.39 80 to any" + ] + } + ] + }, + { + "application-identifier":"test-application-4", + "partial-flag":true, + "pfd": [ + { + "pfd-identifier":"pfd3", + "urls": [ + "^http://test.example2.net(/\\S*)?$" + ] + }, + { + "pfd-identifier":"pfd4" + } + ] + } +] +``` + +``` +] +} +] +``` + +Here is an example of a successful response: + +HTTP/1.1 200 OK + +Date: Mon, 23 Apr 2012 17:10:00 GMT + +Server: pcefserver.example.com + +Content-Type: application/json + +``` +{ + "success-message": "Notification was processed successfully.", +} +``` + +### 6.3.4 HTTP status codes + +HTTP status codes are used as defined in IETF RFC 7231 [17] + +### 6.3.5 Feature negotiation + +#### 6.3.5.1 General + +The REST based Gw/Gwn interface needs to provide a mechanism to advertise required and optional features supported by both the PCEF/TDF and PFDF for interoperability reasons as the functionality of the REST Gw/Gwn based interface is augmented. + +Feature negotiation shall take place during the first interaction (either HTTP POST in push or HTTP GET in pull) between the PFDF and the PCEF/TDF. The client shall include in the HTTP request the set of supported features as follows: + +- if a feature is required for the proper operation of the application, it shall be included within the 3gpp-Required-Features header; +- if a feature is optional for the proper operation of the application, it shall be included within the 3gpp-Optional-Features header. + +The server shall include, within the 3gpp-Accepted-Features header in the HTTP response, the set of features it supports in common with the client. + +If the server does not support any of the required features advertised by the client within the 3gpp-Required-Features header, the server shall reject the HTTP request with an HTTP 412 Precondition Failed status code and shall include the commonly supported features with the client within the 3gpp-Accepted-Features. + +If the server requires certain features to be supported that are not advertised by the client, the server shall reject the HTTP request with an HTTP 412 Precondition Failed status code and shall include the commonly supported features with the client within the 3gpp-Accepted-Features and the required features in the 3gpp-required-features. + +If the PCEF/TDF and the PFDF successfully negotiate supported features, the list of commonly supported features shall be applicable for the lifetime of the application. Features that are not advertised as supported shall not be used. + +The sender may send information that is related to the supported features. Any unrecognized information shall be ignored by the receiver. + +The table below defines the features applicable to the Gw interface. + +**Table 6.3.5.1-1: Features used in Gw Interface** + +| Feature | M/O | Description | +|-------------------------------------------------------------------------------------------------------------------------|-----|---------------------------------------------------------------------------------------------------| +| PartialUpdate | O | The PPDF can use this feature for partial update in PFD push. | +| DomainNameProtocol | O | This feature supports the additional protocol matching condition for the domain name in PFD data. | +| Feature: A short name for the feature to which the M/O and description pertain. | | | +| M/O: Indication on whether the implementation of the feature is mandatory ("M") or optional ("O") in this 3GPP Release. | | | +| Description: Textual description of the feature. | | | + +The table below defines the features applicable to the Gwn interface. + +**Table 6.3.5.1-2: Features used in Gwn Interface** + +| Feature | M/O | Description | +|-------------------------------------------------------------------------------------------------------------------------|-----|---------------------------------------------------------------------------------------------------| +| PartialUpdate | O | The PPDF can use this feature for partial update in PFD push. | +| DomainNameProtocol | O | This feature supports the additional protocol matching condition for the domain name in PFD data. | +| Feature: A short name for the feature to which the M/O and description pertain. | | | +| M/O: Indication on whether the implementation of the feature is mandatory ("M") or optional ("O") in this 3GPP Release. | | | +| Description: Textual description of the feature. | | | + +NOTE: The base functionality for the Gw/Gwn interface is defined in the Release-14 version of this specification and a feature is an extension of that functionality. The negotiation of supported features allows interworking between the endpoints of the Gw/Gwn interface whereby each entity may support all, some, or none of the features that the Gw/Gwn application can support defined in this specification. Features are defined so that they are independent of each other. Any introduced feature is explicitly defined in this specification. + +#### 6.3.5.2 HTTP custom headers + +This subclause defines any new HTTP custom headers introduced by this specification. + +##### 6.3.5.2.1 3gpp-Optional-Features + +This header is used by the client to advertise the optional features that are supported by the client. + +The encoding of the header follows the ABNF as defined in IETF RFC 7230 [16]. + +3gpp-Optional-Features = "3gpp-Optional-Features" ":" 1#token + +An example is: 3gpp-Optional-Features: feature1, feature2 + +##### 6.3.5.2.2 3gpp-Required-Features + +This header is used by the client to announce the mandatory features that must be supported in the server. + +This header is also used by the server to indicate the missing features that must be supported in the client. + +The encoding of the header follows the ABNF as defined in IETF RFC 7230 [16]. + +3gpp-Required-Features = "3gpp-Required-Features" ":" 1#token + +An example is: 3gpp-Required-Features: feature1, feature2 + +##### 6.3.5.2.3 3gpp-Accepted-Features + +The header is used by the server to confirm the commonly supported set of features with the client. + +The encoding of the header follows the ABNF as defined in IETF RFC 7230 [16]. + +3gpp-Accepted-Features = "3gpp-Accepted-Features" ":" 1#token + +An example is: 3gpp-Accepted-Features: feature1, feature2 + +#### 6.3.5.3 Precedence for HTTP custom headers + +The server shall evaluate the HTTP custom headers first if other conditional headers (e.g. If-None-Match, as defined in IETF RFC 7232 [18]) are also present. + +## 6.4 Specific application communication + +### 6.4.1 General + +Specific application communication represents the presentation of application data structures by transforming data into the form that the application accepts. It establishes the context between application-layer entities. + +NOTE: This release only supports the content type JSON + +### 6.4.2 Content type + +The HTTP POST requests in pull mode shall be an encoded string which is defined in subclause 6.3.3.4. + +The HTTP responses in pull mode as well as the HTTP messages in push mode shall be in JSON format. The content of the JSON text is defined in subclause 6.4.3, 6.4.4 and Annex A. + +The MIME media type that shall be used within the Content-Type header field is “application/json” as defined in IETF RFC 7159 [11]. + +### 6.4.3 JSON PFDs fields + +#### 6.4.3.1 General + +Table 6.4.3.1.1 describes the JSON fields used within the body of the HTTP messages representing the PFDs information associated with an application identifier. The table includes the information about the name of the field and the type of the fields. + +**Table 6.4.3.1.1: Gw/Gwn PFD JSON fields** + +| Field Name | Clause defined | JSON Value Type (NOTE 1) | JCR Type (NOTE 2) | Applicability (NOTE 3) | +|------------------------|----------------|--------------------------|-------------------|------------------------| +| application-identifier | 6.4.3.2 | string | string | | +| caching-time | 6.4.3.4 | number | uint64 | | +| pfds | 6.4.3.5 | array | array | | +| pfd-identifier | 6.4.3.6 | string | string | | +| flow-descriptions | 6.4.3.7 | array | array | | +| urls | 6.4.3.8 | array | array | | +| domain-names | 6.4.3.9 | array | array | | +| dn-protocol | 6.4.3.10 | string | string | DomainNameProtocol | + +NOTE 1: The basic JSON value types are defined in IETF RFC 7159 [11]. +NOTE 2: The JCR types are defined in IETF draft-newton-json-content-rules [12]. +NOTE 3: Fields marked with a supported feature are applicable as described in subclause 6.3.5. + +#### 6.4.3.2 application-identifier + +The application-identifier field is of type string, and contains the application identifier to which the PFDs belong. + +#### 6.4.3.3 void + +#### 6.4.3.4 caching-time + +The caching-time field is of type uint64. It's a caching time value in seconds. When the caching timer elapses, the PCEF/TDF shall re-fetch the PFDs associated with the corresponding application-identifier from the PFDF. If the caching-time is: + +- omitted, the PCEF/TDF shall use the preconfigured default caching time value to control how long the PFDs valid; or +- set to zero, then the PFDs are valid until explicitly deleted by the PFDF. + +NOTE: The value zero of caching-time is only valid in the Combination mode and can be used as an indication of infinite PFD validity. It can be used to avoid unnecessary PFD refreshment for an application, in such case, the PFDs cannot be deleted at the expiration of the caching timer if it was not stopped at reception of caching-time set to zero value. + +#### 6.4.3.5 pfd + +The pfd field is of type array. It contains the PFDs that belong to a specific application identifier. When multiple PFDs are associated with the application identifier, the application is detected when any of the PFDs associated with the application identifier is matched. + +The following defines the content of the PFD: + +The pfd-identifier field shall be included within the PFD, and shall be unique within the context of an application identifier. + +At least one of the flow-descriptions field, the urls field, the domain-names field or a custom field shall be present for the application traffic detection. If a PFD contains multiple filter types, the PFD is only matched when every filter type contained in the PFD has a matching value. + +The custom field is type of any with an arbitrary field name. Any primitive type, array, or object defined in IETF RFC 7159 [11] can be set to this field. It provides the extensions for the proprietary application traffic detection mechanisms, based on the agreement between the ASP and the mobile operator. + +Below are the JCR for the PFD: + +``` +$pfd = { + $pfd-identifier, + ($flow-descriptions | $urls | $domain-names | // : any) ? +} +``` + +#### 6.4.3.6 pfd-identifier + +The pfd-identifier is of type string. It uniquely identifies a PFD within its associated application identifier. + +#### 6.4.3.7 flow-descriptions + +The flow-descriptions is of type string array. The content of the string has the same encoding as the IPFilterRule AVP value as defined in IETF RFC 6733 [13]. It represents a 3-tuple with protocol, server ip and server port for UL/DL application traffic. + +#### 6.4.3.8 urls + +The urls is type of string array. The content of the string shall be a URL or a regular expression which is used to match the significant parts of the URL. + +#### 6.4.3.9 domain-names + +The domain-names is type of string array. The content of the string shall be an FQDN or a regular expression as a domain name matching criteria. + +#### 6.4.3.10 dn-protocol + +The dn-protocol is type of string. It indicates the additional protocol and protocol field for domain names to be matched, applicable when domain-names field is present. + +The following values are defined: + +##### DNS\_QNAME + +Identifies the DNS protocol and the question name in DNS query. + +##### TLS\_SNI + +Identifies the Server Name Indication in TLS ClientHello message. + +##### TLS\_SAN + +Identifies the Subject Alternative Name in TLS ServerCertificate message. + +##### TLS\_SCN + +Identifies the Subject Common Name in TLS ServerCertificate message. + +### 6.4.4 JSON provisioning fields + +#### 6.4.4.1 General + +In addition to subclause 6.4.3, Table 6.4.4.1.1 describes the extra JSON fields used within the body of the HTTP messages representing the PFDs provisioning information in push mode. The table includes the information about the name of the field and the type of the fields. + +**Table 6.4.4.1.1: Gw/Gwn Provisioning JSON fields** + +| Field Name | Clause defined | JSON Value Type (NOTE 1) | JCR Type (NOTE 2) | Applicability (NOTE 3) | +|-----------------------------------------------------------------------------------------------------------------------------------|----------------|--------------------------|-------------------|------------------------| +| notification-flag (NOTE 4) | 6.4.4.2 | boolean | boolean | | +| removal-flag (NOTE 4) | 6.4.4.3 | boolean | boolean | | +| allowed-delay (NOTE 4) | 6.4.4.4 | number | uint64 | | +| partial-flag (NOTE 4) | 6.4.4.5 | boolean | boolean | PartialUpdate | +| NOTE 1: The basic JSON value types are defined in IETF RFC 7159 [11]. | | | | | +| NOTE 2: The JCR types are defined in IETF draft-newton-json-content-rules [12]. | | | | | +| NOTE 3: Fields marked with a supported feature are applicable as described in subclause 6.3.5. | | | | | +| NOTE 4: Only one of the notification-flag, removal-flag and the partial-flag for the application identifier shall be set to true. | | | | | + +#### 6.4.4.2 notification-flag + +The notification-flag is of type boolean. + +If the value of the flag is true, then it indicates a PFDs notification, and the corresponding PFDs information for the application identifier is not provided in the JSON body. Instead, the PCEF/TDF shall reload it with the application identifier via the pull procedure. + +#### 6.4.4.3 removal-flag + +The removal-flag is of type boolean. + +If the value of the flag is true, then it indicates the PFDs and its associated application identifier have been removed in the PPDF. The PCEF/TDF shall unbind all PFDs associated with that application identifier. + +#### 6.4.4.4 allowed-delay + +The allowed-delay field is of type uint64. It contains a time interval in seconds. The PFDs shall be deployed within this time interval. If the allowed-delay is omitted, or if it is set to zero, then the PFDs shall be immediately deployed. + +#### 6.4.4.5 partial-flag + +The partial-flag is of type boolean. + +If the value of the flag is true, then it indicates some PFDs for the application identifier(s) have been created/updated/deleted in the PFDF. The PCEF/TDF shall update existing PFDs or add new PFDs for the PFD identifier(s) with PFDs, or unbind all PFDs associated with the PFD identifier(s) without any PFDs content. + +### 6.4.5 JSON errors and informational response fields + +#### 6.4.5.1 General + +Table 6.4.5.1.1 describes the JSON fields defined for the errors and informational responses including their types and the field names. + +**Table 6.4.5.1.1: JSON fields for errors and informational response** + +| Field Name | Subclause defined | JSON Value Type (NOTE 1) | JCR Type (NOTE 2) | +|---------------------------------------------------------------------------------|------------------------------|--------------------------|-----------------------------------------------------------------| +| errors | 3GPP TS 29.155 [15] (NOTE 4) | array | array | +| error-type | 3GPP TS 29.155 [15] (NOTE 4) | string | "application"
"interface"
"server"
"other"
(NOTE 3) | +| error-message | 3GPP TS 29.155 [15] | string | string | +| error-tag | 6.4.5.2 | string | string | +| error-path | 3GPP TS 29.155 [15] | string | string | +| error-info | 3GPP TS 29.155 [15] | object | object | +| success-message | 3GPP TS 29.155 [15] | string | string | +| success-path | 3GPP TS 29.155 [15] | string | string | +| success-info | 3GPP TS 29.155 [15] | object | object | +| NOTE 1: The basic JSON value types are defined in IETF RFC 7159 [11]. | | | | +| NOTE 2: The JCR types are defined in IETF draft-newton-json-content-rules [12]. | | | | +| NOTE 3: The quoted strings for a string type. | | | | +| NOTE 4: The error is sent from the PCEF/TDF to the PFDF. | | | | + +#### 6.4.5.2 error-tag + +The error-tag field is of type string. It defines a tag for a particular error. + +##### PFD\_EVENT + +This error-tag shall be used when the PFDs cannot be installed/modified at the PCEF, pfd-reports shall be provided in the error-info as described in subclause 6.4.6. + +### 6.4.6 JSON report fields + +#### 6.4.6.1 General + +Table 6.4.6.1.1 describes the JSON fields defined for the report information objects which are included in the error-info field. + +**Table 6.4.6.1.1: JSON fields for Report from the PCEF** + +| Field Name | Subclause defined | JSON Value Type (NOTE 1) | JCR Type (NOTE 2) | +|---------------------------------------------------------------------------------|---------------------|--------------------------|-------------------| +| pdf-reports | 6.4.6.2 | array | array | +| application-ids | 3GPP TS 29.250 [14] | array | array | +| pfd-failure-code | 6.4.6.3 | string | string | +| NOTE 1: The basic JSON value types are defined in IETF RFC 7159 [11]. | | | | +| NOTE 2: The JCR types are defined in IETF draft-newton-json-content-rules [12]. | | | | + +#### 6.4.6.2 pfd-reports + +The pfd-reports field is of type array and it contains a list of pfd reports. + +The pfd-reports field can be used in an HTTP response to report failures in the installation/modification of PFDs in the Push mode. In this case, it shall be provided as a sub field of the error-info field. + +Multiple pfd report instances shall be provided within the pfd-reports field if different pfd-failure-code values are applicable within the same HTTP response. + +A report instance shall contain the application-ids and pfd-failure-code fields. + +The JCR format for the pfd-reports is: + +\$pfd-reports = "pfd-reports" : [ + +{ \$application-ids, + +\$pfd-failure-code + +} + + +] + +#### 6.4.6.3 pfd-failure-code + +The pfd-failure-code is of type string. + +The following values are defined in this release: + +MALFUNCTION + +RESOURCES\_LIMITATION + +OTHER\_REASON + +## 6.5 The discovery of PCEF/TDF and PFDF + +### 6.5.1 PCEF/TDF discovery + +For “Push mode”, the PFDF requires a method to discover the PCEF(s)/TDF(s). + +A list of PCEF/TDF URIs may be pre-configured on the PFDF. + +The PFDF may select the PCEF/TDF by this configuration. + +NOTE: Other methods to discover the PCEF(s)/TDF(s) are implementation specific. + +### 6.5.2 PFDF discovery + +For “Pull mode”, the PCEF/TDF requires a method to discover the PFDF. + +The PFDF URI may be pre-configured on the PCEF/TDF. + +The PCEF/TDF may select the PFDF by this configuration. + +NOTE 1: Other methods to discover the PFDF are implementation specific. + +NOTE 2: If multiple PFDFs are deployed within one PLMN, coordination between the PFDFs is needed to avoid duplicated provisioning, e.g. to avoid that the PCEF/TDFs served by different PFDFs are overlapping + +# --- 7 Secure communication + +Either the NDS/IP network layer security defined in 3GPP TS 33.210 [8] or HTTP over TLS as defined in IETF RFC 2818 [9] should be used to secure communication over the REST based Gw and Gwn interfaces. + +# Annex A (normative): JSON Schema + +## A.1 PFDs schema + +This subclause defines the JSON schema for the body of HTTP responses providing the state of one or more PFDs resources in pull mode. The schema is based on IETF draft-newton-json-content-rules [12] and is defined below: + +``` +# jcr-version 0.7 +``` + +``` +# ruleset-id 3gpp.gwapplication.pfds +``` + +``` +; JCR representing the pfds root resource +``` + +``` +$pfds-root = @ {root} { +``` + +``` + $application-identifier, +``` + +``` + $caching-time ?, +``` + +``` + $pfds +``` + +``` +} +``` + +``` +; An array list of the PFDs for multiple application identifiers +``` + +``` +$pfds-array-root = @ {root} [ $pfds-root * ] +``` + +``` +; The caching timer for the PFDs +``` + +``` +$caching-time = "caching-time" : uint64 +``` + +``` +; The PFDs associated with the same application identifier +``` + +``` +$pfds = "pfds" : [ $pfd * ] +``` + +``` +; The PFD content +``` + +``` +$pfd = { +``` + +``` + $pfd-identifier, +``` + +``` + ( $flow-descriptions | $urls | $domain-names | // : any) ?, +``` + +``` + $dn-protocol ? +``` + +``` +} +``` + +``` +; The PFD identifier +``` + +``` +$pfd-identifier = "pfd-identifier" : string +``` + +; The flow descriptions + +\$flow-descriptions = "flow-descriptions" : [ string + ] + +; The url matching expressions + +\$urls = "urls" : [ string + ] + +; The domain name match criteria + +\$domain-names = "domain-names" : [ string + ] + +; The domain name protocol + +``` +$dn-protocol =: ( + "DNS_QNAME" | + "TLS_SNI" | + "TLS_SAN" | + "TLS_SCN" +) +``` + +## --- A.2 Provisioning schema + +This subclause defines the JSON schema for the body of HTTP request providing the provisioned PFDs as well as the PFDs notifications in push mode. The schema is based on IETF draft-newton-json-content-rules [12] and is defined below: + +``` +# jcr-version 0.7 +``` + +``` +# ruleset-id 3gpp.gwapplication.provisioning +``` + +``` +# import 3gpp.gwapplication.pfds as pfds +``` + +``` +; JCR representing the PFDs provisioning data +``` + +``` +$provisioning-root = @{root} { + $pfds.application-identifier, + $notification-flag ?, + $removal-flag ?, + $partial-flag ?, + $allowed-delay ?, + $pfds.pfds ? +``` + +} + +; An array list of the PFDs provisioning/notification for multiple application identifiers + +\$provisioning-array-root = @{root} [ \$provisioning-root \* ] + +; A flag indicates whether this is a notification or a provisioning + +\$notification-flag = "notification-flag" : boolean + +; A flag indicates whether this is a removal or not + +\$removal-flag = "removal-flag" : boolean + +; A flag indicates whether this is a partial update or not + +\$partial-flag = "partial-flag" : boolean + +; The allowed delay time for the PFDs deployment + +\$allowed-delay = "allowed-delay" : uint64 + +## --- A.3 Error and Informational response schema + +This subclause defines the JSON schema for the body of HTTP responses in case of errors or success. The schema is based on IETF draft-newton-json-content-rules [12] and is defined below: + +# jcr-version 0.7 + +# ruleset-id 3gpp.gwaplication.info + +; A JCR for the error/successful response body + +; Errors information + +\$errors-root = @{root} { \$errors } + +; Success information + +\$success-root = @{root} { + +\$success-message, + +\$success-path ?, + +\$success-info ? + +} + +; Resource fields definitions + +; The list of errors returned in responses sent by the PCEF/TDF + +\$errors = "errors" : [ + +{ + +\$error-type, + +\$error-message, + +\$error-tag ?, + +\$error-path ?, + +\$error-info ? + +} + + +] + +; The error type for an error. It can be one of 'application', 'interface', 'server' and 'other'. + +\$error-type = "error-type" : ( "application" | "interface" | "server" | "other" ) + +; The error text message + +\$error-message = "error-message" : string + +; The error tag for a specific error + +\$error-tag = "error-tag" : string + +; A JSON pointer path to the error resource + +\$error-path = "error-path" : string + +; Any additional information for the error + +\$error-info = "error-info" : { + +\$pfd-reports ?, + +// : any \* + +} + +; Report fields definitions + +; The list of pfd reports sent to the PFDF + +\$pfd-reports = "pfd-reports" : [ + +{ \$application-ids, + +\$pfd-failure-code + +} + + +----- + +----- + +] + +; The string format for the pfd failure code + +\$pfd-failure-code =: ( + +"MALFUNCTION" | + +"RESOURCES\_LIMITATION" | + +"OTHER\_REASON" + +) + +; The successful text message + +\$success-message = "success-message" : string + +; A JSON pointer path to the success resource + +\$success-path = "success-path" : string + +; Any additional information for the success. + +\$success-info = "success-info" : { // : any \* } + +; application identifiers + +\$application-ids = "application-ids" : [ string + ] + +# Annex B (informative): Call Flows + +## B.1 General + +This annex describes the procedures for the interactions between the PFDF and the PCEF/TDF. + +## B.2 Request for PFDs (“Pull mode”) + +This subclause describes the signalling flow for the request for PFDs. + +![Sequence diagram showing the request for PFDs (Pull mode) between PCEF/TDF and PFDF.](f0b7abcb093621bb310bf61fbe0f0d2d_img.jpg) + +``` +sequenceDiagram + participant PCEF/TDF + participant PFDF + Note right of PCEF/TDF: 1. HTTP GET + PCEF/TDF->>PFDF: 1. HTTP GET + Note left of PFDF: 2. HTTP 200 OK + PFDF->>PCEF/TDF: 2. HTTP 200 OK +``` + +The diagram illustrates a sequence of two messages between two entities: PCEF/TDF and PFDF. The PCEF/TDF sends a message labeled '1. HTTP GET' to the PFDF. The PFDF responds with a message labeled '2. HTTP 200 OK' back to the PCEF/TDF. + +Sequence diagram showing the request for PFDs (Pull mode) between PCEF/TDF and PFDF. + +**Figure B.2.1: Request for PFDs** + +1. The PCEF/TDF sends the HTTP GET to the PFDF to request the PFDs including the parameters defined in subclause 6.3.3.2, 6.3.3.3 or 6.3.3.4. +2. The PFDF sends the HTTP 200 OK response to the PCEF/TDF including the parameters defined in subclause 6.3.3.2, 6.3.3.3 or 6.3.3.4. + +## B.3 Provisioning of PFDs (“Push mode”) + +This subclause describes the signalling flow for the provisioning of PFDs. + +![Sequence diagram for provisioning of PFDs](b5335262987c819d7f71ce40f99cb71b_img.jpg) + +``` +sequenceDiagram + participant PCEF/TDF + participant PFDF + PFDF->>PCEF/TDF: 1. HTTP POST + PCEF/TDF->>PFDF: 2. HTTP 200 OK +``` + +A sequence diagram showing the interaction between PCEF/TDF and PFDF. The diagram consists of two vertical lifelines. The first message is an arrow from PFDF to PCEF/TDF labeled '1. HTTP POST'. The second message is an arrow from PCEF/TDF to PFDF labeled '2. HTTP 200 OK'. + +Sequence diagram for provisioning of PFDs + +**Figure B.3.1: Provisioning of the PFDs** + +1. The PFDF sends the HTTP POST to the PCEF/TDF to provision the PFDs of one or more application identifiers including the parameters defined in subclause 6.3.3.5. +2. The PCEF/TDF sends the HTTP 200 OK response to the PFDF including the parameters defined in subclause 6.3.3.5. + +## B.4 Provisioning of PFDs by Push with Notifications + +This subclause describes the signalling flow for the provisioning of PFDs by push with notifications. + +![Sequence diagram for provisioning of PFDs by push with notification](1b893df61c2b73b7a85e65fc1f58e203_img.jpg) + +``` +sequenceDiagram + participant PCEF/TDF + participant PFDF + PFDF->>PCEF/TDF: 1. HTTP POST + PCEF/TDF->>PFDF: 2. HTTP 200 OK + Note over PCEF/TDF, PFDF: 3. Request for the PFDs +``` + +A sequence diagram showing the interaction between PCEF/TDF and PFDF. The diagram consists of two vertical lifelines. The first message is an arrow from PFDF to PCEF/TDF labeled '1. HTTP POST'. The second message is an arrow from PCEF/TDF to PFDF labeled '2. HTTP 200 OK'. Below these, a rectangular box labeled '3. Request for the PFDs' is shown, spanning across both lifelines, indicating a procedure initiated by PCEF/TDF. + +Sequence diagram for provisioning of PFDs by push with notification + +**Figure B.4.1: Provisioning of the PFDs by push with notification** + +1. The PFDF sends the HTTP POST to the PCEF/TDF to provision the notification of creation/update for one or more application identifiers including the parameters defined in subclause 6.3.3.5. +2. The PCEF/TDF sends the HTTP 200 OK response to the PFDF including the parameters defined in subclause 6.3.3.5. +3. Within the allowed-delay provided in the step1, the PCEF/TDF initiates the procedure defined in Annex B.2 to request the PFDs for the application identifiers. + +NOTE: The step 3 can be executed multiple times if the PCEF/TDF initiates separate pull requests to retrieve the PFDs for different application identifier(s). + +# Annex C (informative): Change history + +| Date | TSG # | TSG Doc. | CR | Rev | Cat | Subject/Comment | New | +|---------|-------|-----------|------|-----|-----|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------| +| 2016-10 | | | | | | TS skeleton of Gw and Gwn reference points stage 3. | 0.0.0 | +| 2016-10 | | | | | | Inclusion of C3-163212, C3-163213, C3-163304, C3-163323, C3-163326, C3-163327 and editorial change from Rapporteur. | 0.1.0 | +| 2016-11 | | | | | | Inclusion of C3-164174, C3-164177, C3-164231 and editorial change from Rapporteur. | 0.2.0 | +| 2017-01 | | | | | | Inclusion of C3-170055, C3-170060, C3-170061, C3-170063, C3-170065 and editorial change from Rapporteur. | 0.3.0 | +| 2017-02 | | | | | | Inclusion of C3-171274, C3-171304, C3-171307, C3-171308, C3-171319, and editorial change from Rapporteur. | 0.4.0 | +| 2017-03 | CT#75 | CP-170101 | | | | TS sent for Information to Plenary | 1.0.0 | +| 2017-04 | | | | | | Inclusion of C3-172137, C3-172195, C3-172197, C3-172237, C3-172238, C3-172246, and editorial change from Rapporteur. | 1.1.0 | +| 2017-05 | | | | | | Inclusion of C3-173120, C3-173154, C3-173196, C3-173198, C3-173201, C3-173288, C3-173289, C3-173290, C3-173295, C3-173297, C3-173320, C3-173322, C3-173331, and editorial change from Rapporteur. | 1.2.0 | +| 2017-06 | CT#76 | CP-171144 | | | | TS sent for approval to plenary. | 2.0.0 | +| 2017-06 | CT#76 | CP-171144 | | | | TS approved at plenary. | 14.0.0 | +| 2017-09 | CT#77 | CP-172047 | 0001 | 2 | F | Clarification of partial update. | 14.1.0 | +| 2017-09 | CT#77 | CP-172047 | 0002 | 3 | F | Clarification of combination mode. | 14.1.0 | +| 2017-09 | CT#77 | CP-172047 | 0005 | 2 | F | Clarification of PCEF's behaviour in the pull mode. | 14.1.0 | +| 2017-09 | CT#77 | CP-172047 | 0006 | 1 | F | Update the reference of HTTP 1.1. | 14.1.0 | +| 2017-09 | CT#77 | CP-172047 | 0007 | 1 | F | Caching time correction. | 14.1.0 | +| 2017-09 | CT#77 | CP-172047 | 0011 | 1 | F | PFD error report correction. | 14.1.0 | +| 2017-09 | CT#77 | CP-172047 | 0012 | 1 | F | Correction for PFD provisioning notification. | 14.1.0 | +| 2017-09 | CT#77 | CP-172047 | 0014 | 1 | F | Reference and URI design correction. | 14.1.0 | +| 2017-09 | CT#77 | CP-172047 | 0015 | 1 | F | Correction to PFD removal. | 14.1.0 | +| 2017-12 | CT#78 | CP-173100 | 0016 | - | F | Correction to PFD removal. | 14.2.0 | +| 2017-12 | CT#78 | CP-173100 | 0017 | - | F | Precedence for 3GPP custom headers. | 14.2.0 | +| 2018-06 | SA#80 | - | - | - | - | Update to Rel-15 version (MCC) | 15.0.0 | +| 2018-12 | CT#82 | CP-183120 | 0019 | 1 | A | Correction to PFD retrieval by pull mode | 15.1.0 | +| 2019-03 | CT#83 | CP-190133 | 0020 | 3 | B | PFD extension | 16.0.0 | +| 2019-06 | CT#84 | CP-191097 | 0023 | - | A | Reference update: draft-newton-json-content-rules | 16.1.0 | +| 2019-06 | CT#84 | CP-191097 | 0026 | - | A | Encoding of custom header fields | 16.1.0 | +| 2019-09 | CT#85 | CP-192168 | 0029 | | A | Correct presence condition in PFD definition | 16.2.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29272/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-16/29_series/29272/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..da9fe820f1e0711c894adb39147866c4af20ab91 --- /dev/null +++ b/marked/Rel-16/29_series/29272/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0bd6d46f945acbf52a777a76a6b880a6283dcf733e92797b288748d58070cc22 +size 9691 diff --git a/marked/Rel-16/29_series/29272/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-16/29_series/29272/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ea8a115b27e3c83e6d6ab67af3b349460bdbaf3f --- /dev/null +++ b/marked/Rel-16/29_series/29272/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8e6e22bb5df694cc1f0a2659d92dd92b8197006dec0ce9458f97fc1605e3c7d2 +size 5657 diff --git a/marked/Rel-16/29_series/29272/raw.md b/marked/Rel-16/29_series/29272/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..58ce661e32a72dd4c089d76b8b5bae8d248aa7bd --- /dev/null +++ b/marked/Rel-16/29_series/29272/raw.md @@ -0,0 +1,6993 @@ + + +# 3GPP TS 29.272 V16.7.0 (2022-06) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Evolved Packet System (EPS); Mobility Management Entity (MME) and Serving GPRS Support Node (SGSN) related interfaces based on Diameter protocol (Release 16)** + +![5G logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The 5G logo, consisting of the text "5G" in a bold, black, sans-serif font. Above the "5G" text are three green curved lines representing signal waves. + +5G logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, featuring the text "3GPP" in a stylized, bold, black font. Below the "3GPP" text is a red signal icon consisting of three curved lines. Below the icon, the text "A GLOBAL INITIATIVE" is written in a smaller, all-caps, sans-serif font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTSTM is a Trade Mark of ETSI registered for the benefit of its members +3GPPTM is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTETM is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# --- Contents + +| | | +|-----------------------------------------------------------|----| +| Foreword..... | 10 | +| 1 Scope..... | 11 | +| 2 References..... | 11 | +| 3 Definitions and abbreviations..... | 14 | +| 3.1 Definitions..... | 14 | +| 3.2 Abbreviations..... | 14 | +| 4 General Description..... | 15 | +| 5 MME – HSS (S6a) and SGSN – HSS (S6d)..... | 15 | +| 5.1 Introduction..... | 15 | +| 5.2 Mobility Services..... | 15 | +| 5.2.1 Location Management Procedures..... | 15 | +| 5.2.1.1 Update Location..... | 15 | +| 5.2.1.1.1 General..... | 15 | +| 5.2.1.1.2 Detailed behaviour of the MME and the SGSN..... | 18 | +| 5.2.1.1.3 Detailed behaviour of the HSS..... | 23 | +| 5.2.1.2 Cancel Location..... | 26 | +| 5.2.1.2.1 General..... | 26 | +| 5.2.1.2.2 Detailed behaviour of the MME and the SGSN..... | 27 | +| 5.2.1.2.3 Detailed behaviour of the HSS..... | 28 | +| 5.2.1.3 Purge UE..... | 28 | +| 5.2.1.3.1 General..... | 28 | +| 5.2.1.3.2 Detailed behaviour of the MME and the SGSN..... | 29 | +| 5.2.1.3.3 Detailed behaviour of the HSS..... | 29 | +| 5.2.2 Subscriber Data Handling Procedures..... | 30 | +| 5.2.2.1 Insert Subscriber Data..... | 30 | +| 5.2.2.1.1 General..... | 30 | +| 5.2.2.1.2 Detailed behaviour of the MME and the SGSN..... | 33 | +| 5.2.2.1.3 Detailed behaviour of HSS..... | 36 | +| 5.2.2.2 Delete Subscriber Data..... | 38 | +| 5.2.2.2.1 General..... | 38 | +| 5.2.2.2.2 Detailed behaviour of the MME and the SGSN..... | 41 | +| 5.2.2.2.3 Detailed behaviour of the HSS..... | 42 | +| 5.2.3 Authentication Procedures..... | 42 | +| 5.2.3.1 Authentication Information Retrieval..... | 42 | +| 5.2.3.1.1 General..... | 42 | +| 5.2.3.1.2 Detailed behaviour of the MME and the SGSN..... | 44 | +| 5.2.3.1.3 Detailed behaviour of the HSS..... | 44 | +| 5.2.4 Fault Recovery Procedures..... | 46 | +| 5.2.4.1 Reset..... | 46 | +| 5.2.4.1.1 General..... | 46 | +| 5.2.4.1.2 Detailed behaviour of the MME and the SGSN..... | 47 | +| 5.2.4.1.3 Detailed behaviour of the HSS..... | 48 | +| 5.2.5 Notification Procedures..... | 49 | +| 5.2.5.1 Notification..... | 49 | +| 5.2.5.1.1 General..... | 49 | +| 5.2.5.1.2 Detailed behaviour of the MME and the SGSN..... | 52 | +| 5.2.5.1.3 Detailed behaviour of the HSS..... | 53 | +| 5A MME – CSS (S7a) and SGSN – CSS (S7d)..... | 54 | +| 5A.1 Introduction..... | 54 | +| 5A.2 Mobility Services..... | 54 | +| 5A.2.1 Location Management Procedures..... | 54 | +| 5A.2.1.1 Update VCSG Location..... | 54 | +| 5A.2.1.1.1 General..... | 54 | + +| | | | +|------------|-------------------------------------------------------|----| +| 5A.2.1.1.2 | Detailed behaviour of the MME and the SGSN..... | 55 | +| 5A.2.1.1.3 | Detailed behaviour of the CSS..... | 56 | +| 5A.2.1.2 | Cancel VCSG Location..... | 56 | +| 5A.2.1.2.1 | General..... | 56 | +| 5A.2.1.2.2 | Detailed behaviour of the MME and the SGSN..... | 57 | +| 5A.2.1.2.3 | Detailed behaviour of the CSS..... | 57 | +| 5A.2.2 | Subscriber Data Handling Procedures..... | 57 | +| 5A.2.2.1 | Insert VCSG Subscriber Data..... | 57 | +| 5A.2.2.1.1 | General..... | 57 | +| 5A.2.2.1.2 | Detailed behaviour of the MME and the SGSN..... | 58 | +| 5A.2.2.1.3 | Detailed behaviour of CSS..... | 59 | +| 5A.2.2.2 | Delete VCSG Subscriber Data..... | 59 | +| 5A.2.2.2.1 | General..... | 59 | +| 5A.2.2.2.2 | Detailed behaviour of the MME and the SGSN..... | 60 | +| 5A.2.2.2.3 | Detailed behaviour of the CSS..... | 60 | +| 5A.2.3 | Fault Recovery Procedures..... | 60 | +| 5A.2.3.1 | VCSG Reset..... | 60 | +| 5A.2.3.1.1 | General..... | 60 | +| 5A.2.3.1.2 | Detailed behaviour of the MME and the SGSN..... | 61 | +| 5A.2.3.1.3 | Detailed behaviour of the CSS..... | 61 | +| 6 | MME – EIR (S13) and SGSN – EIR (S13')..... | 62 | +| 6.1 | Introduction..... | 62 | +| 6.2 | ME Identity Check Procedures..... | 62 | +| 6.2.1 | ME Identity Check..... | 62 | +| 6.2.1.1 | General..... | 62 | +| 6.2.1.2 | Detailed behaviour of the MME and the SGSN..... | 63 | +| 6.2.1.3 | Detailed behaviour of the EIR..... | 63 | +| 7 | Protocol Specification and Implementation..... | 64 | +| 7.1 | Introduction..... | 64 | +| 7.1.1 | Use of Diameter base protocol..... | 64 | +| 7.1.2 | Securing Diameter Messages..... | 64 | +| 7.1.3 | Accounting functionality..... | 64 | +| 7.1.4 | Use of sessions..... | 64 | +| 7.1.5 | Transport protocol..... | 64 | +| 7.1.6 | Routing considerations..... | 65 | +| 7.1.7 | Advertising Application Support..... | 65 | +| 7.1.8 | Diameter Application Identifier..... | 65 | +| 7.1.9 | Use of the Supported-Features AVP..... | 66 | +| 7.2 | Commands..... | 67 | +| 7.2.1 | Introduction..... | 67 | +| 7.2.2 | Command-Code values..... | 67 | +| 7.2.3 | Update-Location-Request (ULR) Command..... | 68 | +| 7.2.4 | Update-Location-Answer (ULA) Command..... | 69 | +| 7.2.5 | Authentication-Information-Request (AIR) Command..... | 69 | +| 7.2.6 | Authentication-Information-Answer (AIA) Command..... | 70 | +| 7.2.7 | Cancel-Location-Request (CLR) Command..... | 70 | +| 7.2.8 | Cancel-Location-Answer (CLA) Command..... | 70 | +| 7.2.9 | Insert-Subscriber-Data-Request (IDR) Command..... | 71 | +| 7.2.10 | Insert-Subscriber-Data-Answer (IDA) Command..... | 71 | +| 7.2.11 | Delete-Subscriber-Data-Request (DSR) Command..... | 72 | +| 7.2.12 | Delete-Subscriber-Data-Answer (DSA) Command..... | 73 | +| 7.2.13 | Purge-UE-Request (PUR) Command..... | 74 | +| 7.2.14 | Purge-UE-Answer (PUA) Command..... | 74 | +| 7.2.15 | Reset-Request (RSR) Command..... | 75 | +| 7.2.16 | Reset-Answer (RSA) Command..... | 75 | +| 7.2.17 | Notify-Request (NOR) Command..... | 76 | +| 7.2.18 | Notify-Answer (NOA) Command..... | 76 | +| 7.2.19 | ME-Identity-Check-Request (ECR) Command..... | 77 | +| 7.2.20 | ME-Identity-Check-Answer (ECA) Command..... | 77 | +| 7.2.21 | Update-VCSG-Location-Request (UVR) Command..... | 78 | + +| | | | +|----------|---------------------------------------------------|-----| +| 7.2.22 | Update-VCSG-Location-Answer (UVA) Command..... | 78 | +| 7.2.23 | Cancel-VCSG-Location-Request (CVR) Command..... | 78 | +| 7.2.24 | Cancel-VCSG-Location-Answer (CVA) Command..... | 79 | +| 7.3 | Information Elements..... | 80 | +| 7.3.1 | General..... | 80 | +| 7.3.2 | Subscription-Data..... | 89 | +| 7.3.3 | Terminal-Information..... | 90 | +| 7.3.4 | IMEI..... | 91 | +| 7.3.5 | Software-Version..... | 91 | +| 7.3.6 | 3GPP2-MEID..... | 91 | +| 7.3.7 | ULR-Flags..... | 91 | +| 7.3.8 | ULA-Flags..... | 93 | +| 7.3.9 | Visited-PLMN-Id..... | 93 | +| 7.3.10 | Feature-List AVP..... | 93 | +| 7.3.10.1 | Feature-List AVP for the S6a/S6d application..... | 93 | +| 7.3.10.2 | Feature-List AVP for the S7a/S7d application..... | 105 | +| 7.3.11 | Requested-EUTRAN-Authentication-Info..... | 106 | +| 7.3.12 | Requested-UTRAN- GERAN-Authentication-Info..... | 106 | +| 7.3.13 | RAT-Type..... | 106 | +| 7.3.14 | Number-Of-Requested-Vectors..... | 106 | +| 7.3.15 | Re-Synchronization-Info..... | 106 | +| 7.3.16 | Immediate-Response-Preferred..... | 106 | +| 7.3.17 | Authentication-Info..... | 107 | +| 7.3.18 | E-UTRAN-Vector..... | 107 | +| 7.3.19 | UTRAN-Vector..... | 107 | +| 7.3.20 | GERAN-Vector..... | 107 | +| 7.3.21 | Network-Access-Mode..... | 108 | +| 7.3.22 | HPLMN-ODB..... | 108 | +| 7.3.23 | Item-Number..... | 108 | +| 7.3.24 | Cancellation-Type..... | 108 | +| 7.3.25 | DSR-Flags..... | 109 | +| 7.3.26 | DSA-Flags..... | 111 | +| 7.3.27 | Context-Identifier..... | 111 | +| 7.3.28 | Void..... | 111 | +| 7.3.29 | Subscriber-Status..... | 111 | +| 7.3.30 | Operator-Determined-Barring..... | 112 | +| 7.3.31 | Access-Restriction-Data..... | 112 | +| 7.3.32 | APN-OI-Replacement..... | 113 | +| 7.3.33 | All-APN-Configurations-Included-Indicator..... | 113 | +| 7.3.34 | APN-Configuration-Profile..... | 113 | +| 7.3.35 | APN-Configuration..... | 114 | +| 7.3.36 | Service-Selection..... | 115 | +| 7.3.37 | EPS-Subscribed-QoS-Profile..... | 115 | +| 7.3.38 | VPLMN-Dynamic-Address-Allowed..... | 116 | +| 7.3.39 | STN-SR..... | 116 | +| 7.3.40 | Allocation-Retention-Priority..... | 116 | +| 7.3.41 | AMBR..... | 116 | +| 7.3.42 | MIP-Home-Agent-Address..... | 117 | +| 7.3.43 | MIP-Home-Agent-Host..... | 117 | +| 7.3.44 | PDN-GW-Allocation-Type..... | 117 | +| 7.3.45 | MIP6-Agent-Info..... | 117 | +| 7.3.46 | RAT-Frequency-Selection-Priority-ID..... | 118 | +| 7.3.47 | IDA-Flags..... | 118 | +| 7.3.48 | PUA-Flags..... | 118 | +| 7.3.49 | NOR-Flags..... | 118 | +| 7.3.50 | User-Id..... | 119 | +| 7.3.51 | Equipment-Status..... | 119 | +| 7.3.52 | Regional-Subscription-Zone-Code..... | 120 | +| 7.3.53 | RAND..... | 120 | +| 7.3.54 | XRES..... | 120 | +| 7.3.55 | AUTN..... | 120 | + +| | | | +|---------|--------------------------------------------------------|-----| +| 7.3.56 | KASME..... | 120 | +| 7.3.57 | Confidentiality-Key AVP..... | 120 | +| 7.3.58 | Integrity-Key AVP..... | 120 | +| 7.3.59 | Kc AVP..... | 120 | +| 7.3.60 | SRES..... | 120 | +| 7.3.61 | Void..... | 120 | +| 7.3.62 | PDN-Type..... | 120 | +| 7.3.63 | Trace-Data AVP..... | 121 | +| 7.3.64 | Trace-Reference AVP..... | 121 | +| 7.3.65 | Void..... | 122 | +| 7.3.66 | Void..... | 122 | +| 7.3.67 | Trace-Depth AVP..... | 122 | +| 7.3.68 | Trace-NE-Type-List AVP..... | 122 | +| 7.3.69 | Trace-Interface-List AVP..... | 122 | +| 7.3.70 | Trace-Event-List AVP..... | 122 | +| 7.3.71 | OMC-Id AVP..... | 122 | +| 7.3.72 | GPRS-Subscription-Data..... | 122 | +| 7.3.73 | Complete-Data-List-Included-Indicator..... | 123 | +| 7.3.74 | PDP-Context..... | 123 | +| 7.3.75 | PDP-Type..... | 124 | +| 7.3.75A | Ext-PDP-Type..... | 124 | +| 7.3.76 | Void..... | 124 | +| 7.3.77 | QoS-Subscribed..... | 124 | +| 7.3.78 | CSG-Subscription-Data..... | 124 | +| 7.3.79 | CSG-Id..... | 124 | +| 7.3.80 | Expiration-Date..... | 124 | +| 7.3.81 | Roaming-Restricted-Due-To-Unsupported-Feature..... | 125 | +| 7.3.82 | Specific-APN-Info AVP..... | 125 | +| 7.3.83 | Alert-Reason AVP..... | 125 | +| 7.3.84 | LCS-Info..... | 125 | +| 7.3.85 | GMLC-Number..... | 125 | +| 7.3.86 | LCS-PrivacyException..... | 126 | +| 7.3.87 | SS-Code..... | 126 | +| 7.3.88 | SS-Status..... | 126 | +| 7.3.89 | Notification-To-UE-User..... | 126 | +| 7.3.90 | External-Client..... | 126 | +| 7.3.91 | Client-Identity..... | 127 | +| 7.3.92 | GMLC-Restriction..... | 127 | +| 7.3.93 | PLMN-Client..... | 127 | +| 7.3.94 | Service-Type..... | 127 | +| 7.3.95 | ServiceTypeIdentity..... | 127 | +| 7.3.96 | MO-LR..... | 127 | +| 7.3.97 | Void..... | 128 | +| 7.3.98 | Trace-Collection-Entity AVP..... | 128 | +| 7.3.99 | Teleservice-List..... | 128 | +| 7.3.100 | TS-Code..... | 128 | +| 7.3.101 | Call-Barring-Info..... | 128 | +| 7.3.102 | SGSN-Number..... | 128 | +| 7.3.103 | IDR-Flags..... | 128 | +| 7.3.104 | ICS-Indicator..... | 129 | +| 7.3.105 | Visited-Network-Identifier..... | 129 | +| 7.3.107 | Homogeneous-Support-of-IMS-Voice-Over-PS-Sessions..... | 130 | +| 7.3.108 | Last-UE-Activity-Time..... | 130 | +| 7.3.109 | GMLC-Address..... | 130 | +| 7.3.110 | EPS-User-State..... | 130 | +| 7.3.111 | EPS-Location-Information..... | 131 | +| 7.3.112 | MME-User-State..... | 131 | +| 7.3.113 | SGSN-User-State..... | 131 | +| 7.3.114 | User-State..... | 131 | +| 7.3.115 | MME-Location-Information..... | 132 | +| 7.3.116 | SGSN-Location-Information..... | 132 | + +| | | | +|---------|----------------------------------------|-----| +| 7.3.117 | E-UTRAN-Cell-Global-Identity..... | 133 | +| 7.3.118 | Tracking-Area-Identity..... | 133 | +| 7.3.119 | Cell-Global-Identity..... | 133 | +| 7.3.120 | Routing-Area-Identity..... | 133 | +| 7.3.121 | Location-Area-Identity..... | 133 | +| 7.3.122 | Service-Area-Identity..... | 133 | +| 7.3.123 | Geographical-Information..... | 133 | +| 7.3.124 | Geodetic-Information..... | 133 | +| 7.3.125 | Current-Location-Retrieved..... | 133 | +| 7.3.126 | Age-Of-Location-Information..... | 134 | +| 7.3.127 | Active-APN..... | 134 | +| 7.3.128 | Error-Diagnostic..... | 134 | +| 7.3.129 | Ext-PDP-Address AVP..... | 135 | +| 7.3.130 | UE-SRVCC-Capability..... | 135 | +| 7.3.131 | MPS-Priority..... | 135 | +| 7.3.132 | VPLMN-LIPA-Allowed..... | 135 | +| 7.3.133 | LIPA-Permission..... | 135 | +| 7.3.134 | Subscribed-Periodic-RAU-TAU-Timer..... | 136 | +| 7.3.135 | SIPTO-Permission..... | 136 | +| 7.3.136 | MDT-Configuration..... | 136 | +| 7.3.137 | Job-Type..... | 137 | +| 7.3.138 | Area-Scope..... | 137 | +| 7.3.139 | List-Of-Measurements..... | 137 | +| 7.3.140 | Reporting-Trigger..... | 137 | +| 7.3.141 | Report-Interval..... | 137 | +| 7.3.142 | Report-Amount..... | 137 | +| 7.3.143 | Event-Threshold-RSRP..... | 137 | +| 7.3.144 | Event-Threshold-RSRQ..... | 137 | +| 7.3.145 | Logging-Interval..... | 137 | +| 7.3.146 | Logging-Duration..... | 138 | +| 7.3.147 | Relay-Node-Indicator..... | 138 | +| 7.3.148 | MDT-User-Consent..... | 138 | +| 7.3.149 | PUR-Flags..... | 138 | +| 7.3.150 | Subscribed-VSRVCC..... | 138 | +| 7.3.151 | Equivalent-PLMN-List..... | 139 | +| 7.3.152 | CLR-Flags..... | 139 | +| 7.3.153 | UVR-Flags..... | 139 | +| 7.3.154 | UVA-Flags..... | 139 | +| 7.3.155 | VPLMN-CSG-Subscription-Data..... | 140 | +| 7.3.156 | Local-Time-Zone..... | 140 | +| 7.3.157 | A-MSISDN..... | 140 | +| 7.3.158 | Void..... | 140 | +| 7.3.159 | MME-Number-for-MT-SMS..... | 140 | +| 7.3.160 | Void..... | 141 | +| 7.3.161 | Void..... | 141 | +| 7.3.162 | SMS-Register-Request..... | 141 | +| 7.3.163 | Time-Zone..... | 141 | +| 7.3.164 | Daylight-Saving-Time..... | 141 | +| 7.3.165 | Subscription-Data-Flags..... | 141 | +| 7.3.166 | Measurement-Period-LTE..... | 142 | +| 7.3.167 | Measurement-Period-UMTS..... | 142 | +| 7.3.168 | Collection-Period-RRM-LTE..... | 142 | +| 7.3.169 | Collection-Period-RRM-UMTS..... | 142 | +| 7.3.170 | Positioning-Method..... | 142 | +| 7.3.171 | Measurement-Quantity..... | 142 | +| 7.3.172 | Event-Threshold-Event-IF..... | 143 | +| 7.3.173 | Event-Threshold-Event-II..... | 143 | +| 7.3.174 | Restoration-Priority..... | 143 | +| 7.3.175 | SGs-MME-Identity..... | 143 | +| 7.3.176 | SIPTO-Local-Network-Permission..... | 143 | +| 7.3.177 | Coupled-Node-Diameter-ID..... | 143 | + +| | | | +|---------|-----------------------------------------------|-----| +| 7.3.178 | OC-Supported-Features..... | 143 | +| 7.3.179 | OC-OLR..... | 143 | +| 7.3.180 | ProSe-Subscription-Data..... | 143 | +| 7.3.181 | WLAN-offloadability..... | 144 | +| 7.3.182 | WLAN-offloadability-EUTRAN..... | 144 | +| 7.3.183 | WLAN-offloadability-UTRAN..... | 144 | +| 7.3.184 | Reset-ID..... | 144 | +| 7.3.185 | MDT-Allowed-PLMN-Id..... | 145 | +| 7.3.186 | Adjacent-PLMNs..... | 145 | +| 7.3.187 | Adjacent-Access-Restriction-Data..... | 145 | +| 7.3.188 | DL-Buffering-Suggested-Packet-Count..... | 145 | +| 7.3.189 | IMSI-Group-Id..... | 146 | +| 7.3.190 | Group-Service-Id..... | 146 | +| 7.3.191 | Group-PLMN-Id..... | 146 | +| 7.3.192 | Local-Group-Id..... | 146 | +| 7.3.193 | AESE-Communication-Pattern..... | 147 | +| 7.3.194 | Communication-Pattern-Set..... | 147 | +| 7.3.195 | Monitoring-Event-Configuration..... | 147 | +| 7.3.196 | Monitoring-Event-Report..... | 148 | +| 7.3.197 | UE-Reachability-Configuration..... | 149 | +| 7.3.198 | eNodeB-ID..... | 149 | +| 7.3.199 | Supported-Services..... | 150 | +| 7.3.200 | Supported-Monitoring-Events..... | 150 | +| 7.3.201 | AIR-Flags..... | 150 | +| 7.3.202 | UE-Usage-Type..... | 150 | +| 7.3.203 | DRMP..... | 151 | +| 7.3.204 | Non-IP-PDN-Type-Indicator..... | 151 | +| 7.3.205 | Non-IP-Data-Delivery-Mechanism..... | 151 | +| 7.3.206 | Additional-Context-Identifier..... | 151 | +| 7.3.207 | SCEF-Realm..... | 151 | +| 7.3.208 | Subscription-Data-Deletion..... | 152 | +| 7.3.209 | Preferred-Data-Mode..... | 152 | +| 7.3.210 | Emergency-Info..... | 152 | +| 7.3.211 | Load..... | 152 | +| 7.3.212 | V2X-Subscription-Data..... | 153 | +| 7.3.213 | V2X-Permission..... | 153 | +| 7.3.214 | PDN-Connection-Continuity..... | 153 | +| 7.3.215 | eDRX-Cycle-Length..... | 153 | +| 7.3.216 | eDRX-Cycle-Length-Value..... | 154 | +| 7.3.217 | UE-PC5-AMBR..... | 154 | +| 7.3.218 | Extended eNodeB-ID..... | 154 | +| 7.3.219 | MBSFN-Area..... | 154 | +| 7.3.220 | MBSFN-Area-ID..... | 154 | +| 7.3.221 | Carrier-Frequency..... | 154 | +| 7.3.222 | RDS-Indicator..... | 154 | +| 7.3.223 | Service-Gap-Time..... | 155 | +| 7.3.224 | Aerial-UE-Subscription-Information..... | 155 | +| 7.3.225 | Broadcast-Location-Assistance-Data-Types..... | 155 | +| 7.3.226 | Paging-Time-Window..... | 157 | +| 7.3.227 | Operation-Mode..... | 157 | +| 7.3.228 | Paging-Time-Window-Length..... | 157 | +| 7.3.229 | eDRX-Related-RAT..... | 157 | +| 7.3.230 | Core-Network-Restrictions..... | 158 | +| 7.3.231 | Interworking-5GS-Indicator..... | 158 | +| 7.3.232 | Ethernet-PDN-Type-Indicator..... | 158 | +| 7.3.233 | Subscribed-ARPI..... | 158 | +| 7.3.234 | IAB-Operation-Permission..... | 158 | +| 7.3.235 | V2X-Subscription-Data-Nr..... | 159 | +| 7.3.236 | UE-PC5-QoS..... | 159 | +| 7.3.237 | PC5-QoS-Flow..... | 159 | +| 7.3.238 | 5QI..... | 159 | + +| | | | +|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------|-----| +| 7.3.239 | PC5-Flow-Bitrates.................................................................................................................................. | 159 | +| 7.3.240 | Guaranteed-Flow-Bitrates.................................................................................................................. | 160 | +| 7.3.241 | Maximum-Flow-Bitrates..................................................................................................................... | 160 | +| 7.3.242 | PC5-Range.......................................................................................................................................... | 160 | +| 7.3.243 | PC5-Link-AMBR................................................................................................................................ | 160 | +| 7.3.244 | Third-Context-Identifier...................................................................................................................... | 160 | +| 7.4 | Result-Code and Experimental-Result Values................................................................................... | 160 | +| 7.4.1 | General........................................................................................................................................... | 160 | +| 7.4.2 | Success........................................................................................................................................... | 160 | +| 7.4.3 | Permanent Failures......................................................................................................................... | 160 | +| 7.4.3.1 | DIAMETER_ERROR_USER_UNKNOWN (5001)................................................................... | 160 | +| 7.4.3.2 | DIAMETER_ERROR_UNKNOWN_EPS_SUBSCRIPTION (5420)........................................ | 161 | +| 7.4.3.3 | DIAMETER_ERROR_RAT_NOT_ALLOWED (5421)............................................................. | 161 | +| 7.4.3.4 | DIAMETER_ERROR_ROAMING_NOT_ALLOWED (5004)................................................... | 161 | +| 7.4.3.5 | DIAMETER_ERROR_EQUIPMENT_UNKNOWN (5422)........................................................ | 161 | +| 7.4.3.6 | DIAMETER_ERROR_UNKNOWN_SERVING_NODE (5423)................................................. | 161 | +| 7.4.4 | Transient Failures............................................................................................................................ | 161 | +| 7.4.4.1 | DIAMETER_AUTHENTICATION_DATA_UNAVAILABLE (4181)....................................... | 161 | +| 7.4.4.2 | DIAMETER_ERROR_CAMEL_SUBSCRIPTION_PRESENT (4182)..................................... | 161 | +| 8 | User identity to HSS resolution.......................................................................................................... | 161 | + +| | | +|--------------------------------------------------------------------------------------------------------------------|------------| +| Annex A (normative): MME mapping table for S6a and NAS Cause Code values................................... | 162 | +|--------------------------------------------------------------------------------------------------------------------|------------| + +| | | +|--------------------------------------------------------------------------------------------------------------------|------------| +| Annex B(normative): SGSN mapping table for S6d and NAS Cause Code values................................... | 165 | +|--------------------------------------------------------------------------------------------------------------------|------------| + +| | | +|-------------------------------------------------------------------------------------------------------------------------------------|------------| +| Annex C (normative): Diameter overload control mechanism.................................................................... | 167 | +|-------------------------------------------------------------------------------------------------------------------------------------|------------| + +| | | | +|-------|---------------------------------------------------------------------------------------------------------------------------------------------------------|-----| +| C.1 | General................................................................................................................................................ | 167 | +| C.2 | S6a/S6d interfaces............................................................................................................................... | 167 | +| C.2.1 | General........................................................................................................................................... | 167 | +| C.2.2 | HSS behaviour................................................................................................................................ | 167 | +| C.2.3 | MME/SGSN behaviour................................................................................................................... | 167 | + +| | | +|-----------------------------------------------------------------------------------------------------------------------------------|------------| +| Annex D (Informative): Diameter overload control node behaviour........................................................... | 168 | +|-----------------------------------------------------------------------------------------------------------------------------------|------------| + +| | | | +|-----|------------------------------------------------------------------------------------------------------------------------------------------|-----| +| D.1 | Message prioritisation over S6a/d....................................................................................................... | 168 | +|-----|------------------------------------------------------------------------------------------------------------------------------------------|-----| + +| | | +|--------------------------------------------------------------------------------------------------------------------------------------|------------| +| Annex E (normative): Diameter message priority mechanism..................................................................... | 168 | +|--------------------------------------------------------------------------------------------------------------------------------------|------------| + +| | | | +|-------|---------------------------------------------------------------------------------------------------------------------------------------------------------|-----| +| E.1 | General................................................................................................................................................ | 168 | +| E.2 | S6a/S6d interfaces............................................................................................................................... | 168 | +| E.2.1 | General........................................................................................................................................... | 168 | +| E.2.2 | HSS, CSS, EIR behaviour............................................................................................................... | 168 | +| E.2.3 | MME/SGSN behaviour................................................................................................................... | 169 | + +| | | +|-----------------------------------------------------------------------------------------------------------------------------------------|------------| +| Annex F (normative): Diameter load control mechanism............................................................................ | 170 | +|-----------------------------------------------------------------------------------------------------------------------------------------|------------| + +| | | | +|-------|---------------------------------------------------------------------------------------------------------------------------------------------------------|-----| +| F.1 | General................................................................................................................................................ | 170 | +| F.2 | S6a/S6d interfaces............................................................................................................................... | 170 | +| F.2.1 | General........................................................................................................................................... | 170 | +| F.2.2 | HSS behaviour................................................................................................................................ | 170 | +| F.2.3 | MME/SGSN behaviour................................................................................................................... | 170 | + +| | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------|------------| +| Annex G (informative): Change history......................................................................................................... | 171 | +|-------------------------------------------------------------------------------------------------------------------------------------------------------|------------| + +## Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +--- + +## 1 Scope + +The present document describes the Mobility Management Entity (MME) and Serving GPRS Support Node (SGSN) related diameter-based interfaces towards the Home Subscriber Server (HSS) or the CSG Subscriber Server (CSS), and the MME and the SGSN related diameter-based interface towards the Equipment Identity Register (EIR). + +This specification defines the Diameter application for the MME-HSS, S6a reference point, for the MME-CSS, S7a reference point, for the SGSN-HSS, S6d reference point, and for the SGSN-CSS, S7d reference point. The interactions between the HSS/CSS and the MME/SGSN are specified, including the signalling flows. + +This specification defines the Diameter application for the MME-EIR, S13 reference point, and for the SGSN-EIR, S13' reference point. The interactions between the MME/SGSN and the EIR are specified, including the signalling flows. + +In this specification, if there is no specific indication, the following principles apply: + +- "SGSN" refers to an SGSN which at least supports the S4 interface and may support Gn and Gp interfaces. +- "S4-SGSN" refers to an SGSN which supports the S4 interface and does not support Gn and Gp interfaces. +- Gn/Gp-SGSN refers to an SGSN which supports the Gn and Gp interfaces and does not support S4 interface. +- "GPRS subscription data" refers to the parameters in the HLR column in Table 5.2. in 3GPP TS 23.008 [30]. +- "EPS subscription data" refers to the parameters in the HSS column in Table 5.2A-1 in 3GPP TS 23.008 [30]. + +The Evolved Packet System stage 2 description (architecture and functional solutions) is specified in 3GPP TS 23.401 [2] and in 3GPP TS 23.060 [12]. + +SGSN CAMEL Subscription Data are not supported over S6d interface. + +--- + +## 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.401: "GPRS enhancements for E-UTRAN access ". +- [3] 3GPP TS 23.003: "Numbering, addressing and identification". +- [4] Void. + +- [5] 3GPP TS 33.401: "3GPP System Architecture Evolution: Security Architecture". +- [6] Void". +- [7] IETF RFC 2234: "Augmented BNF for syntax specifications". +- [8] 3GPP TS 32.299: "Charging management; Diameter charging applications". +- [9] 3GPP TS 29.229: "Cx and Dx interfaces based on the Diameter protocol". +- [10] 3GPP TS 29.212: "Policy and Charging Control (PCC); Reference points". +- [11] 3GPP TS 29.214: "Policy and Charging Control over Rx reference point". +- [12] 3GPP TS 23.060: "General Packet Radio Service (GPRS); Service description; Stage 2". +- [13] 3GPP TS 22.016: "International Mobile station Equipment Identities (IMEI)". +- [14] IETF RFC 4960: "Stream Control Transmission Protocol". +- [15] Void +- [16] 3GPP TS 33.210: "3G Security; Network Domain Security; IP Network Layer Security".. +- [17] 3GPP TS 29.228: "IP multimedia (IM) Subsystem Cx and Dx Interfaces; Signalling flows and Message Elements". +- [18] 3GPP TS 33.102: "3G Security; Security Architecture". +- [19] 3GPP TS 36.413: "Evolved Universal Terrestrial Radio Access Network (E-UTRAN); S1 Application Protocol (S1AP)". +- [20] IETF RFC 5778: "Diameter Mobile IPv6: Support for Home Agent to Diameter Server Interaction". +- [21] 3GPP TS 29.061: "Interworking between the Public Land Mobile Network (PLMN) supporting packet based services and Packet Data Networks (PDN)". +- [22] 3GPP TS 32.298: "Charging Management; CDR parameter description". +- [23] 3GPP TS 32.422: "Telecommunication management; Subscriber and equipment trace; Trace control and configuration management". +- [24] 3GPP TS 29.002: "Mobile Application Part (MAP) specification". +- [25] 3GPP TS 29.329: "Sh Interface based on the Diameter protocol". +- [26] IETF RFC 5447: "Diameter Mobile IPv6: Support for Network Access Server to Diameter Server Interaction". +- [27] IETF RFC 4004: "Diameter Mobile IPv4 Application". +- [28] 3GPP2 A.S0022: "Interoperability Specification (IOS) for Evolved High Rate Packet Data (eHRPD) Radio Access Network Interfaces and Interworking with Enhanced Universal Terrestrial Radio Access Network (E-UTRAN)". +- [29] 3GPP TS 23.011: "Technical realization of Supplementary Services - General Aspects". +- [30] 3GPP TS 23.008: "Organization of subscriber data". +- [31] 3GPP TS 24.008: "Mobile radio interface Layer 3 specification; Core network protocols; Stage 3". +- [32] IETF RFC 5516: "Diameter Command Code Registration for Third Generation Partnership Project (3GPP) Evolved Packet System (EPS)". +- [33] 3GPP TS 32.251: "Telecommunication management; Charging management; Packet Switched (PS) domain charging". + +- [34] 3GPP TS 23.292: "IP Multimedia Subsystem (IMS) centralized services ". +- [35] 3GPP TS 23.216: "Single Radio Voice Call Continuity (SRVCC)". +- [36] 3GPP TS 23.015:"Technical realization of Operator Determined Barring (ODB)". +- [37] 3GPP TS 29.173: "Diameter-based SLh interface for Control Plane LCS". +- [38] 3GPP TS 29.303: "Domain Name System Procedures; Stage 3". +- [39] 3GPP TS 29.060: "General Packet Radio Service (GPRS); GPRS Tunnelling Protocol (GTP) across the Gn and Gp Interface". +- [40] 3GPP TS 36.300: "Evolved Universal Terrestrial Radio Access (E-UTRA) and Evolved Universal Terrestrial Radio Access Network (E-UTRAN); Overall description; Stage 2". +- [41] ITU-T Recommendation E.164: "The international public telecommunication numbering plan". +- [42] 3GPP TS 22.042: "Network Identity and TimeZone (NITZ); Service description; Stage 1". +- [43] 3GPP TS 23.007: "Restoration procedures". +- [44] 3GPP TS 23.272: "Circuit Switched (CS) fallback in Evolved Packet System (EPS); Stage 2". +- [45] 3GPP TS 29.010: "Information element mapping between Mobile Station - Base Station System (MS - BSS) and Base Station System - Mobile-services Switching Centre (BSS - MSC)". +- [46] 3GPP TS 29.118: "Mobility Management Entity (MME) –Visitor Location Register (VLR)SGs interface specification ". +- [47] 3GPP TS 29.172: "Evolved Packet Core (EPC) LCS Protocol (ELP) between the Gateway Mobile Location Centre (GMLC) and the Mobile Management Entity (MME)". +- [48] 3GPP TS 29.338: "Diameter based protocols to support Short Message Service (SMS) capable Mobile Management Entities (MMEs)". +- [49] 3GPP TS 29.344: "Proximity-services (ProSe) Function to Home Subscriber Server (HSS) aspects; Stage 3". +- [50] IETF RFC 7683: "Diameter Overload Indication Conveyance". +- [51] 3GPP TS 23.380: "IMS Restoration Procedures". +- [52] 3GPP TS 22.153: "Multimedia Priority Service". +- [53] 3GPP TS 23.221: "Architectural requirements". +- [54] 3GPP TS 29.336: "Home Subscriber Server (HSS) diameter interfaces for interworking with packet data networks and applications". +- [55] 3GPP TS 23.682: "Architecture enhancements to facilitate communications with packet data networks and applications ". +- [56] 3GPP TS 29.217: "Congestion reporting over Np reference point". +- [57] IETF RFC 7944: "Diameter Routing Message Priority". +- [58] 3GPP TS 43.020: "Security related network functions". +- [59] 3GPP TS 29.273: "Evolved Packet System (EPS); 3GPP EPS AAA interfaces". +- [60] IETF RFC 8583: "Diameter Load Information Conveyance". +- [61] IETF RFC 6733: "Diameter Base Protocol". +- [62] 3GPP TS 36.331: "Evolved Universal Terrestrial Radio Access (E-UTRA); Radio Resource Control (RRC); Protocol specification". + +- [63] 3GPP TS 29.128: "Mobility Management Entity (MME) and Serving GPRS Support Node (SGSN) interfaces for interworking with packet data networks and applications". +- [64] 3GPP TS 24.301: "Non-Access-Stratum (NAS) protocol for Evolved Packet System (EPS); Stage 3". +- [65] 3GPP TS 36.423: "Evolved Universal Terrestrial Radio Access Network (E-UTRAN); X2 Application Protocol (X2AP)". +- [66] 3GPP TS 29.503: "Unified Data Management Services". +- [67] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [68] 3GPP TS 23.287: "Architecture enhancements for 5G System (5GS) to support Vehicle-to-Everything (V2X) services". +- [69] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [70] 3GPP TS 29.563: "5G System; Home Subscriber Server (HSS) services for interworking with Unified Data Management (UDM); Stage 3". + +--- + +## 3 Definitions and abbreviations + +### 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +**CSG subscription data from CSS:** It identifies the CSG subscription data that a MME or a SGSN has received from a CSS for a subscriber identified by its IMSI. + +**CSG subscription data from HSS:** It identifies the CSG subscription data that a MME or a SGSN has received from a HSS for a subscriber identified by its IMSI. + +### 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in TR 21.905 [1]. + +| | | +|------|----------------------------------------------------| +| AVP | Attribute Value Pair | +| C | Conditional | +| CSS | CSG Subscriber Server | +| DCN | Dedicated Core Network | +| DRMP | Diameter Routing Message Priority | +| DSCP | Differentiated Services Code Point | +| EIR | Equipment Identity Register | +| ESM | EPS Session Management | +| HSS | Home Subscriber Server | +| IAB | Integrated Access and Backhaul | +| IE | Information Element | +| LAA | Licensed Assisted Access | +| LWA | LTE/WLAN Aggregation | +| LWIP | LTE/WLAN Radio Level Integration with IPsec Tunnel | +| M | Mandatory | +| MME | Mobility Management Entity | +| NR | New Radio | +| O | Optional | +| ODB | Operator Determined Barring | + +| | | +|-----------|----------------------------------------------| +| SCEF | Service Capability Exposure Function | +| URRP-MME | User Reachability Request Parameter for MME | +| URPP-SGSN | User Reachability Request Parameter for SGSN | + +--- + +## 4 General Description + +This document describes the S6a/S6d and S13/S13' interfaces related procedures, message parameters and protocol specifications. + +The procedures, message parameters and protocol are similar between S6a and S6d. S6a is used for location changes of the MME, while S6d is for location changes of the SGSN. Refer to clause 5 for the differences, especially clause 5.2.1. + +The procedures, message parameters and protocol are identical as for the S13 and S13'. See clause 6 for details. + +In the tables that describe the Information Elements transported by each Diameter command, each Information Element is marked as (M) Mandatory, (C) Conditional or (O) Optional in the "Cat." column. For the correct handling of the Information Element according to the category type, see the description detailed in clause 6 of the 3GPP TS 29.228 [17]. + +--- + +## 5 MME – HSS (S6a) and SGSN – HSS (S6d) + +### 5.1 Introduction + +The S6a interface enables the transfer of subscriber related data between the MME and the HSS as described in the 3GPP TS 23.401 [2]. + +The S6d interface enables the transfer of subscriber related data between the SGSN and the HSS as described in 3GPP TS 23.060 [12]. + +### 5.2 Mobility Services + +#### 5.2.1 Location Management Procedures + +##### 5.2.1.1 Update Location + +###### 5.2.1.1.1 General + +The Update Location Procedure shall be used between the MME and the HSS and between the SGSN and the HSS to update location information in the HSS. The procedure shall be invoked by the MME or SGSN and is used: + +- to inform the HSS about the identity of the MME or SGSN currently serving the user, and optionally in addition; +- to update MME or SGSN with user subscription data; subscription data that are applicable to MMEs but not to SGSNs should not be sent to the SGSN unless the SGSN is known to be a combined MME/SGSN; similarly subscription data that are applicable to SGSNs but not to MMEs should not be sent to the MME unless the MME is known to be a combined MME/SGSN. +- to provide the HSS with other user data, such as Terminal Information or UE SRVCC Capability. + +This procedure is mapped to the commands Update-Location-Request/Answer (ULR/ULA) in the Diameter application specified in chapter 7. + +Table 5.2.1.1.1/1 specifies the involved information elements for the request. + +Table 5.2.1.1.1/2 specifies the involved information elements for the answer. + +**Table 5.2.1.1.1/1: Update Location Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|---------------------------------------------------|---------------------------------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| IMSI | User-Name
(See IETF RFC 6733 [61]) | M | This information element shall contain the user IMSI, formatted according to 3GPP TS 23.003 [3], clause 2.2. | +| Supported Features
(See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Terminal Information
(See 7.3.3) | Terminal-Information | O | This information element shall contain information about the user's mobile equipment. Within this Information Element, only the IMEI and the Software-Version AVPs shall be used on the S6a/S6d interface. | +| ULR Flags
(See 7.3.7) | ULR-Flags | M | This Information Element contains a bit mask. See 7.3.7 for the meaning of the bits. | +| Visited PLMN Id
(See 7.3.9) | Visited-PLMN-Id | M | This IE shall contain the MCC and the MNC, see 3GPP TS 23.003 [3]. It may be used to apply roaming based features. | +| Equivalent PLMN List
(See 7.3.151) | Equivalent-PLMN-List | O | This Information Element shall contain the equivalent PLMN list of which the MME/SGSN requests the corresponding CSG Subscription data. | +| RAT Type
(See 7.3.13) | RAT-Type | M | This Information Element contains the radio access type the UE is using. See clause 7.3.13 for details. | +| SGSN number
(See 7.3.102) | SGSN-Number | C | This Information Element contains the ISDN number of the SGSN, see 3GPP TS 23.003 [3]. It shall be present when the message is sent on the S6d interface and the SGSN supports LCS (using MAP based Lg interface) or SMS functionalities or the Gs interface.
It may be present when the message is sent on the S6a interface and the requesting node is a combined MME/SGSN. | +| Homogeneous Support of IMS Voice Over PS Sessions | Homogeneous-Support-of-IMS-Voice-Over-PS-Sessions | O | This Information Element, if present, indicates whether or not "IMS Voice over PS Sessions" is supported homogeneously in all TAs or RAs in the serving node (MME or SGSN or combined MME/SGSN).

The value "SUPPORTED" indicates that there is support for "IMS Voice over PS Sessions" in all TAs or RAs.

The value "NOT_SUPPORTED" indicates that there is not support for "IMS Voice over PS Sessions" in any of the TAs or RAs. | +| V-GMLC address | GMLC-Address | C | This Information Element shall contain, if available, the IPv4 or IPv6 address of the V-GMLC associated with the serving node. | +| Active APN | Active-APN | O | This Information Element, if present, contains the list of active APNs stored by the MME or SGSN, including the identity of the PDN GW assigned to each APN. For the case of explicitly subscribed APNs, the following information shall be present:

- Context-Identifier: context id of subscribed APN in use
- Service-Selection: name of subscribed APN in use
- MIP6-Agent-Info: including PDN GW identity in use for subscribed APN
- Visited-Network-Identifier: identifies the PLMN where the PDN GW was allocated

For the case of the Wildcard APN, the following information shall be present:
- Context-Identifier: context id of the Wildcard APN
- Specific-APN-Info: list of APN-in use and related PDN GW identity when the subscribed APN is the wildcard APN

It may be present when MME or SGSN needs to restore PDN GW data in HSS due to a Reset procedure. | +| UE SRVCC Capability | UE-SRVCC-Capability | C | This information element shall indicate if the UE supports or does not support the SRVCC capability and shall be present if the MME or the SGSN supports SRVCC and this information is available to the MME or the SGSN. | +| MME Number for MT SMS | MME-Number-for-MT-SMS | C | This Information Element contains the ISDN number of the MME to route SMS to the UE through the MME, see 3GPP TS 23.003 [3]. It shall be present when the MME supports SMS in MME and wishes to provide SMS in MME. | + +| | | | | +|------------------------------------------|--------------------------|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SMS Register Request | SMS-Register-Request | C | This information element is used to inform the HSS if the MME or the SGSN needs to be registered for SMS, prefers not to be registered for SMS or has no preference. It shall be present when the MME supports SMS in MME and requests to be registered for SMS. It shall be present when the SGSN supports "SMS in SGSN" as defined in clause 5.3.18 in 23.060 [12], and requests to be registered for SMS. | +| SGs MME identity | SGs-MME-Identity | O | This information element is used to inform the HSS of the MME identity that the MME will use over the SGs interface. This information element shall be present, if the MME supports this information element and if the MME identity used over SGs is different from the MME Diameter identity used over S6a. | +| Coupled node's Diameter identity | Coupled-Node-Diameter-ID | O | This information element contains the Diameter identity of the coupled node (i.e. MME's Diameter identity for the SGSN and SGSN's Diameter identity for the MME) when the message is sent by the combined MME/SGSN.

This information element may be present when the message is sent on the S6a/S6d interface and the requesting node is a combined MME/SGSN. | +| Adjacent PLMNs | Adjacent-PLMNs | O | This information element, if present, shall contain the list of PLMNs where an UE served by the MME/SGSN is likely to make a handover from the PLMN where the MME/SGSN is located. This list is statically configured by the operator in the MME/SGSN, according to the geographical disposition of the different PLMNs in that area, the roaming agreements, etc... | +| Supported Services (3GPP TS 29.336 [54]) | Supported-Services | O | If present, this Information Element shall contain AVPs indicating details of the services supported by the MME/SGSN. | + +**Table 5.2.1.1/2: Update Location Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|---------------------------------------------|-----------------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Supported Features (See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Result (See 7.4) | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation.
The Result-Code AVP shall be used to indicate success / errors as defined in the Diameter base protocol (see IETF RFC 6733 [61]).
The Experimental-Result AVP shall be used for S6a/S6d errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP.
The following errors are applicable:
- User Unknown
- Unknown EPS Subscription
- RAT Not Allowed
- Roaming Not Allowed | +| Error-Diagnostic | Error-Diagnostic | O | If the Experimental Result indicates "Unknown EPS Subscription", Error Diagnostic may be present to indicate whether or not GPRS subscription data are subscribed (i.e. whether or not Network Access Mode stored in the HSS indicates that only circuit service is allowed).

If the Experimental Result indicates "Roaming Not Allowed", and the Update Location is rejected due to ODB, Error Diagnostic may be present to indicate the specific type of ODB. | +| ULA-Flags (See 7.3.8) | ULA-Flags | C | This Information Element contains a bit mask. See 7.3.8 for the meaning of the bits. It shall be present only when the Result-Code AVP is DIAMETER_SUCCESS. | +| Subscription Data (See 7.3.2) | Subscription-Data | C | This Information Element shall contain the complete subscription profile of the user. It shall be present if success is reported, unless an explicit "skip subscriber data" indication was present in the request. | +| Reset-IDs (See 7.3.184) | Reset-ID | O | The Reset-ID uniquely identifies a fallible resource in the HSS on which the user (IMSI) depends. In the event of a restart of the fallible resource a Reset message containing the Reset-ID will exactly identify the impacted subscribers. | + +#### 5.2.1.1.2 Detailed behaviour of the MME and the SGSN + +The MME shall make use of this procedure to update the MME identity stored in the HSS (e.g. at initial attach, inter MME tracking area update or radio contact after HSS reset). + +The SGSN shall make use of this procedure to update the SGSN identity stored in the HSS (e.g. at initial attach, inter SGSN routing area update or radio contact after HSS reset). + +The MME shall make use of this procedure to request SMS data and to become registered for SMS. + +The SGSN shall make use of this procedure to request to become registered for SMS. + +A combined MME/SGSN which uses different Diameter Identities for the MME and SGSN parts shall not send a second ULR when in a first ULA the ULA-Flag "Separation Indication" was not set. + +For UEs receiving emergency services, in which the UE was not successfully authenticated, the MME or SGSN shall not make use of the Update Location procedure. + +If the Update Location request is to be sent due to an inter node (SGSN to MME) update and the previous SGSN is a Gn/Gp SGSN, the MME shall set the "Single-Registration-Indication" flag in the ULR-Flags information element in the request. + +If the Update Location request is to be sent due to an initial attach, the MME or SGSN shall set the "Initial-Attach-Indicator" flag in the ULR-Flags information element in the request. + +When receiving and supporting Reset-ID AVPs in the response, the MME or SGSN shall delete all the stored Reset-IDs, if there are any, and then store all the received Reset-IDs. + +A combined MME/SGSN shall set the "Skip Subscriber Data" flag in the ULR-Flags if subscriber data are already available due to a previous location update. + +A combined MME/SGSN that has advertised its support for the combined MME/SGSN capability, by either including the SGSN Number within ULR sent over S6a or including the Coupled-Node-Diameter-ID within ULR sent over S6a/S6d or by using same Diameter identity over S6a and S6d interfaces, shall be prepared to receive a single subscription data update message (IDR or DSR) from the HSS when the subscription data is modified. + +If the MME or SGSN knows about the homogeneity of the support of IMS Voice over PS Sessions in all TAs or RAs associated to that serving node (i.e., it is supported in all the TA/RAs or it is not supported in any of the TA/RAs) and for the serving subscriber taking into account roaming relationship for IMS Voice over PS Sessions, it shall include this indication to the HSS in the "Homogeneous Support of IMS Voice over PS Sessions" IE. + +The MME or SGSN may include dynamic APN and PGW ID data in the list of Active-APN AVPs, in order to restore this information in the HSS after a Reset procedure. + +The MME/SGSN may include an equivalent PLMN list to request the CSG Subscription data of the equivalent PLMNs. + +A standalone MME shall not indicate its support for any SGSN specific features, and it shall not request explicitly the download of GPRS data (via the GPRS-Subscription-Data-Indicator flag; see clause 7.3.7). A standalone MME that does not support the "SMS in MME" feature shall not provide its MME Number for MT SMS, "SMS only" indication or SMS Registration Request and therefore not indicate its support for any SMS related features (such as ODB or barring services). + +For an SGSN, if a DIAMETER\_ERROR\_CAMEL\_SUBSCRIPTION\_PRESENT is received, the SGSN shall initiate the update location procedure with MAP over Gr interface and use Gr for the subsequent mobility procedures. + +For a standalone MME or SGSN, if EPS or GPRS subscription data is received, the standalone MME or SGSN shall replace all of the EPS or GPRS subscription data of the user in the MME or SGSN. Any optional EPS or GPRS data not received, but stored in the standalone MME or SGSN, shall be deleted. + +For a combined MME/SGSN, if EPS subscription data of the user is received, it shall replace all of the EPS subscription data of the user. Any optional EPS data not received by the combined MME/SGSN, but stored in the MME/SGSN, shall be deleted. + +For a combined MME/SGSN, if GPRS subscription data of the user is received, it shall replace all of the GPRS subscription data of the user. Any optional GPRS data not received by the combined MME/SGSN, but stored in the MME/SGSN, shall be deleted. + +When receiving an Update Location response from the HSS, the MME or SGSN shall check the result code. If it indicates success the MME or SGSN shall store the received subscription profile (if any), and it shall store the HSS identity as received in the Origin-Host AVP. + +If an Additional MSISDN (A-MSISDN) is available in the subscription data and downloaded in the A-MSISDN AVP to the MME/SGSN in an Update Location and if the MME or SGSN supports the additional MSISDN feature, the MME or SGSN shall use the Additional MSISDN as C-MSISDN. + +For UEs receiving emergency services (i.e. emergency attached UEs or normal attached UEs with a UE Requested PDN Connection for emergency services), and if the MME or SGSN supports emergency services for users in limited service state, the MME or SGSN shall proceed even if the Update Location procedure fails (e.g. authenticated users with roaming restrictions or RAT-Type restrictions in HSS). + +When receiving GPRS-Subscription-Data AVP in the response, the SGSN or combined MME/SGSN shall delete all the stored PDP-Contexts, if there are any, and then store all the received PDP-Contexts. + +When receiving the APN-Configuration-Profile AVP in a ULA, the MME or SGSN shall delete all the stored APN-Configurations, if there are any, and then store all the received APN-Configurations. + +For each of the received APN-Configurations in the APN-Configuration-Profile, if both the MIP6-Agent-Info and the PDN-GW-Allocation-Type AVPs are absent in the APN-Configuration AVP and the MME or SGSN does not have any associated PGW information, the MME or SGSN shall perform the PGW selection (static or dynamic) according to the local configuration. If MIP6-Agent-Info is present, and PDN-GW-Allocation-Type is not present, this means that the PDN GW address included in MIP6-Agent-Info has been statically allocated. If the MIP6-Agent-Info contains an FQDN of the PDN GW, the MME shall retrieve the PGW PLMN ID from the MIP-Home-Agent-Host AVP within the MIP6-Agent-Info AVP. + +When receiving an Update Location response from the HSS in the TAU or RAU procedure, for each of the received APN-Configurations in the APN-Configuration-Profile, if both the MIP6-Agent-Info and the PDN-GW-Allocation-Type AVPs are absent in the APN-Configuration AVP and the MME or SGSN has associated PGW information and the UE-level access restriction "HO-To-Non-3GPP-Access Not Allowed" is not set, the MME or SGSN should send a Notify Request if HO to the WLAN is supported in the network, including the APN and PDN GW identity to the HSS in order to restore this information in the HSS e.g. after a Reset procedure. + +If the MME/SGSN supports interworking with Gn/Gp-SGSNs, it shall ensure that the Context -Identifier sent over GTPv1 for each of the received APN-Configurations is within the range of 1 and 255. + +NOTE 1: If the MME/SGSN receives from HSS a Context-Identifier value higher than 255, how this value is mapped to a value between 1 and 255 is implementation specific. + +If the subscriber is not roaming and the SIPTO-Permission information for an APN is present, the MME or SGSN shall allow SIPTO above RAN for that APN only if the SIPTO-Permission information indicates so. + +If the subscriber is not roaming and the SIPTO-Permission information for an APN is not present, the MME or SGSN may allow SIPTO above RAN for that APN. + +If the subscriber is roaming and the SIPTO-Permission information for an APN is present, the MME or SGSN shall allow SIPTO above RAN for that APN only if the SIPTO-Permission information indicates so and the VPLMN Dynamic Address is allowed and the MME or SGSN selects a PDN GW in the VPLMN. + +If the subscriber is roaming and the SIPTO-Permission information for an APN is not present, the MME or SGSN shall not allow SIPTO above RAN for that APN. + +NOTE 2: Based on local configuration, the MME or SGSN can determine not to allow SIPTO above RAN for an APN, regardless if the SIPTO-Permission information is present. + +If the subscriber is not roaming and the SIPTO-Local-Network-Permission information for an APN is present, the MME or SGSN shall allow SIPTO at the local network for that APN only if the SIPTO-Local-Network-Permission information indicates so. + +If the subscriber is not roaming and the SIPTO-Local-Network-Permission information for an APN is not present, the MME or SGSN may allow SIPTO at the local network for that APN. + +If the subscriber is roaming and the SIPTO-Local-Network-Permission information for an APN is present, the MME or SGSN shall allow SIPTO at the local network for that APN only if the SIPTO-Local-Network-Permission information indicates so and the VPLMN Dynamic Address is allowed and the MME or SGSN selects a L-GW in the VPLMN. + +If the subscriber is roaming and the SIPTO-Local-Network-Permission information for an APN is not present, the MME or SGSN shall not allow SIPTO at the local network for that APN. + +NOTE 3: Based on local configuration, the MME or SGSN can determine not to allow SIPTO at the local network for an APN, regardless if the SIPTO-Local-Network-Permission information is present. + +If MPS-Priority AVP is present and the UE is subscribed to the eMLPP or 1x RTT priority service in the CS domain as indicated by the MPS-CS-Priority bit of the AVP, the MME shall allow the UE to initiate the RRC connection with higher priority than other normal UEs during CS Fallback procedure. If the MPS-Priority AVP is present and the UE is subscribed to MPS in the EPS domain as indicated by the MPS-EPS-Priority bit of the AVP, the MME shall allow the UE to initiate the RRC connection with higher priority than other normal UEs. + +If the subscriber is not roaming, the MME or SGSN may allow or prohibit the UE to use LIPA as indicated by LIPA-Permission for a specific APN. + +If the subscriber is roaming and the VPLMN-LIPA-Allowed AVP indicates that the UE is not allowed to use LIPA in the VPLMN where the UE is attached, the MME or SGSN shall not provide LIPA for the UE and shall not consider the LIPA-Permission AVP. If the VPLMN-LIPA-Allowed AVP indicates that the UE is allowed to use LIPA in the VPLMN, the MME or SGSN may allow or prohibit the UE to use LIPA as indicated by LIPA-Permission for a specific APN. The VPLMN-Dynamic-Address-Allowed AVP shall not be considered if it is received when the MME or SGSN establishes a PDN connection with LIPA. + +If the LIPA-Permission information for an APN indicates LIPA only, the MME or SGSN shall only allow LIPA for that APN via the authorized CSGs according to the CSG Subscription Data. If the LIPA-Permission information for an APN indicates LIPA prohibited, the MME or SGSN shall not allow LIPA for that APN. If the LIPA-Permission information for an APN indicates LIPA conditional, the MME or SGSN shall allow non LIPA, and LIPA for that APN via the authorized CSGs according to the CSG Subscription Data. If the LIPA-Permission AVP is not present for a specific APN, the APN shall not be allowed to use LIPA. + +The LIPA-Permission information for the Wildcard APN shall apply to any APN that is not explicitly present in the subscription data. + +The SIPTO-Permission information for the Wildcard APN shall apply to any APN that is not explicitly present in the subscription data. + +The SIPTO-Local-Network-Permission information for the Wildcard APN shall apply to any APN that is not explicitly present in the subscription data. + +If the subscription data received for a certain APN indicates that the APN was authorized as a consequence of having the Wildcard APN in the user subscription in HSS, then the MME shall not store this APN data beyond the lifetime of the UE session and the MME shall delete them upon disconnection of the UE. + +If the MME supports the Relay Node functionality (see 3GPP TS 36.300 [40]) and the subscription data indicates that the subscriber is not a relay, the MME shall reject the attach request from a device attempting to attach to EPS as a Relay Node. If a device requests to be attached to EPS as an UE, the MME shall proceed with the attach procedure regardless of the content of the Relay Node Indicator. + +If trace data are received in the subscriber data, the MME or SGSN shall start a Trace Session. For details, see 3GPP TS 32.422 [23]. + +If the Ext-PDP-Type AVP is present in the PDP-Context AVP, the SGSN or combined MME/SGSN shall ignore the value of the PDP-Type AVP. + +If the subscriber is not roaming and the Subscribed-Periodic-RAU-TAU-Timer information is present, the MME or SGSN shall allocate the subscribed value to the UE as periodic RAU or TAU timer. If the subscriber is roaming and the Subscribed-Periodic-RAU-TAU-Timer information is present, the MME or SGSN may use the subscribed periodic RAU/TAU timer value as an indication to decide for allocating a locally configured periodic RAU/TAU timer value to the UE. + +For a combined MME/SGSN, the node may include the Coupled-Node-Diameter-ID AVP to allow the HSS to determine if the UE is served by the MME and SGSN parts of the same combined MME/SGSN. When the message is sent over S6a interface and if this AVP is included, the MME shall include the Diameter identity of the coupled SGSN which is used by the SGSN over S6d interface. When the message is sent over S6d interface and if this AVP is included, the SGSN shall include the Diameter identity of the coupled MME which is used by the MME over S6a interface. + +NOTE 4: The Coupled-Node-Diameter-ID AVP allows the HSS to determine if the UE is served by the MME and SGSN parts of the same combined MME/SGSN, when the SGSN number is not available and when Diameter identity of S6a and S6d interfaces of the combined MME/SGSN are not the same. + +If the MME supports the "SMS in MME" feature and the UE has requested a combined EPS/IMSI attach or Combined TA/LA Update (see 3GPP TS 23.272 [44]) and the MME is not currently registered for SMS, the MME requests to be registered for SMS by indicating its MME Number for MT SMS in the request, including the SMS-Register-Request AVP and the SMS-Only-Indication flag set in the ULR-Flags AVP if UE indicates "SMS only". + +If the MME supports the "SMS in MME" feature, when receiving an EPS attach or a TAU from a UE accessing NB-IoT which requests SMS by indicating "SMS transfer without Combined Attach" (see 3GPP TS 23.401 [2]), and if the MME is not currently registered for SMS, the MME requests to be registered for SMS by indicating its MME Number for MT SMS in the request, including the SMS-Register-Request AVP. + +If the HSS provides the MME with SMS data in the ULA and the ULA-Flags is received with "MME Registered for SMS" flag set, the MME shall store this data for providing SMS in MME service and consider itself registered for SMS. + +If the SGSN supports the "SMS in SGSN" feature as specified in 3GPP TS 23.060 [12], clause 5.3.18, and wishes to provide SMS via SGSN it shall set the "SMS in SGSN" flag in the Feature-List AVP, and include SMS-Register-Request AVP. If the SGSN supports the Diameter based Gdd interface for SMS in SGSN, it shall set the "Gdd-in-SGSN" flag in the Feature-List AVP. If the UE has indicated "SMS-Only" this shall be indicated to the HSS setting the SMS-Only-Indication flag in the ULR-Flags AVP. + +NOTE 5: the setting of the "SMS in SGSN" feature bit reflects the "SMS in SGSN Offered" as described in stage 2 above. + +If the SMS-In-SGSN-Allowed-Indication flag is set in the received Subscription-Data-Flags AVP, the SGSN shall store the subscription data for providing SMS in SGSN service. + +If the subscriber is not roaming and the Restoration-Priority information for a certain APN is present, the MME or SGSN shall consider the subscribed value as the relative priority of the user's PDN connection among PDN connections to the same APN when restoring PDN connections affected by an SGW or PGW failure/restart (see 3GPP TS 23.007 [43]). If the subscriber is roaming and the Restoration-Priority information for a certain APN is present, the MME or SGSN may use the subscribed value as an indication of the relative priority of the user's PDN connection among PDN connections to the same APN based on service level agreements. The MME/SGSN may use a locally configured value as default restoration priority if the Restoration-Priority AVP for a certain APN is not present, or if it is not permitted by service level agreements for an in-bound roamer. + +If the subscription data received for a certain APN includes WLAN-offloadability AVP, then the MME or SGSN shall determine the offloadability of the UE's PDN Connection(s) to that APN based on subscription data and locally configured policy (e.g. for roaming users or when the subscription data does not include any offloadability indication). + +NOTE 6: As indicated in clause 7.3.31, if the UE-level access restriction "HO-To-Non-3GPP-Access Not Allowed" is set, the offload of PDN Connections to WLAN is not allowed for any APN. + +If the subscription data received for the user includes the DL-Buffering-Suggested-Packet-Count AVP, then the MME or SGSN should take into account the subscription data, in addition to local policies, to determine whether to invoke extended buffering of downlink packets at the SGW for High Latency Communication. Otherwise, the MME or SGSN shall make this determination based on local policies only. + +When receiving IMSI-Group-Id AVP(s) within the Subscription-Data AVP, the MME or SGSN shall replace stored IMSI-Group Ids (if any) with the received information rather than add the received information to the stored information. + +When receiving one or more Monitoring-Event-Configuration AVP(s) in the ULA, the MME or SGSN shall start the detection of the Monitoring events indicated in those AVP(s), if not already started, and shall stop the detection and delete the previous monitoring events (if any) which are not indicated in those AVP(s). If there is a failure when starting + +the detection (e.g. maximum resources exceeded), the MME or SGSN shall not store the failed configuration(s) and shall send a notification of those events whose configuration have failed, as described in clause 5.2.5.1.2 (NOR/NOA commands). If the Subscription-Data AVP is received in the ULA but it does not contain any Monitoring-Event-Configuration AVP(s), the MME or SGSN shall stop the detection and delete all stored monitoring event configurations (if any). + +If the MME/SGSN supports Monitoring, the MME/SGSN shall include the Supported-Services AVP with Supported-Monitoring-Events included in the ULR command. + +If the MME and the UE support Attach without PDN connection (i.e. EMM-REGISTERED without PDN connection) and the PDN-Connection-Restricted flag is set in the received Subscription-Data-Flags AVP, the MME shall not establish any non-emergency PDN connection and shall tear down any existing non-emergency PDN connection for this user. + +If the subscription data received for the user includes the Preferred-Data-Mode AVP, for an IP APN configuration or for a non-IP APN configuration with SGi based delivery, then the MME should (if the subscriber is not roaming) or may (if the subscriber is roaming) take into account the subscription data, in addition to local policies and the UE's Preferred Network Behaviour, to determine whether to transmit the traffic associated with this APN over the User Plane and/or over the Control Plane. Otherwise, the MME shall make this determination based on local policies and the UE's Preferred Network Behaviour only. + +If the MME receives from the HSS an Update Location response containing the Emergency-Info AVP in the Subscription-Data, the MME shall use the PDN-GW identity included in Emergency-Info as the PDN-GW used to establish emergency PDN connections with the emergency APN, for non-roaming authenticated UEs requesting the handover of an emergency PDN connection if the MME is configured to use a dynamic PDN-GW for emergency services for such user. + +When receiving V2X-Subscription-Data in the ULA, the MME shall determine whether the UE is authorized to use V2X communication over PC5 according to V2X subscription data and UE provided network capability. If the UE is authorized to use V2X communication over PC5, the MME shall store the "V2X service authorized" indication together with the UE AMBR used for PC5 interface (i.e. UE-PC5-AMBR), and provide such information to the eNodeB when needed. + +If the MME/SGSN receives from the HSS an Update Location response without the bit set for "NR as Secondary RAT" in the Feature-List AVP, the MME/SGSN, based on local policy, may restrict access for NR as secondary RAT when all relevant entities except HSS supports it. + +If the MME receives from the HSS an Update Location response containing in the subscription data the Core-Network-Restrictions AVP with the bit "5GC not allowed" set, the MME shall restrict mobility towards 5GC. + +### 5.2.1.1.3 Detailed behaviour of the HSS + +When receiving an Update Location request the HSS shall check whether subscription data exists for the IMSI. + +If the HSS determines that there is not any type of subscription for the IMSI (including EPS, GPRS and CS subscription data), a Result Code of DIAMETER\_ERROR\_USER\_UNKNOWN shall be returned. + +If the Update Location Request is received over the S6a interface, and the subscriber has not any APN configuration, the HSS shall return a Result Code of DIAMETER\_ERROR\_UNKNOWN\_EPS\_SUBSCRIPTION. + +If the Update Location Request is received over S6a, from an MME that does not support the "Non-IP PDN Type APNs" feature, and the user's subscription profile contains only APN configurations of type "Non-IP", the HSS shall return a Result Code of DIAMETER\_ERROR\_UNKNOWN\_EPS\_SUBSCRIPTION. + +If the Update Location Request is received over the S6d interface, and the subscriber has neither an APN configuration profile nor GPRS subscription data, the HSS shall return a Result Code of DIAMETER\_ERROR\_UNKNOWN\_EPS\_SUBSCRIPTION. + +When sending DIAMETER\_ERROR\_UNKNOWN\_EPS\_SUBSCRIPTION, an Error Diagnostic information may be added to indicate whether or not GPRS subscription data are subscribed (i.e. whether or not Network Access Mode stored in the HSS indicates that only CS service is allowed). + +The HSS shall check whether the RAT type the UE is using is allowed for the subscriber in the serving PLMN. If it is not, a Result Code of DIAMETER\_ERROR\_RAT\_NOT\_ALLOWED shall be returned. + +The HSS shall check whether access to EPC is allowed, based on the active Core Network Restrictions of the subscriber. If access to EPC is restricted, a Result Code of DIAMETER\_ERROR\_UNKNOWN\_EPS\_SUBSCRIPTION shall be returned. + +The HSS shall check whether roaming is not allowed in the VPLMN due to ODB. If so a Result Code of DIAMETER\_ERROR\_ROAMING\_NOT\_ALLOWED shall be returned. When this error is sent due to the MME or SGSN not supporting a certain ODB category, an Error Diagnostic information element may be added to indicate the type of ODB; if this error is sent due to the ODB indicating "Barring of Roaming", Error Diagnostic shall not be included. + +If the Update Location Request is received over the S6d interface and the HSS supports the "SGSN CAMEL Capability" feature, and the SGSN indicates support of SGSN CAMEL capability, the HSS shall check if the subscriber has SGSN CAMEL Subscription data. If the subscriber has SGSN CAMEL Subscription data, the HSS shall return a Result Code of DIAMETER\_ERROR\_CAMEL\_SUBSCRIPTION\_PRESENT. + +If the Update Location Request is received over the S6a interface, the HSS shall send a Cancel Location Request with a Cancellation-Type of MME\_UPDATE\_PROCEDURE (CLR; see chapter 7.2.7) to the previous MME (if any) and replace the stored MME-Identity with the received value (the MME-Identity is received within the Origin-Host AVP). The HSS shall reset the "UE purged in MME" flag and delete any stored last known MME location information of the (no longer) purged UE. If the "Single-Registration-Indication" flag was set in the received request, the HSS shall send a Cancel Location Request with a Cancellation-Type of SGSN\_UPDATE\_PROCEDURE to the SGSN (MAP Cancel Location), and delete the stored SGSN address and SGSN number. If the "Initial-Attach-Indicator" flag was set in the received request, and the "Single-Registration-Indication" flag was not set, the HSS shall send a Cancel Location Request with a Cancellation-Type of INITIAL\_ATTACH\_PROCEDURE (CLR; see chapter 7.2.7, or MAP Cancel Location) to the SGSN if there is an SGSN registration. + +If the Update Location Request is received over the S6d interface, the HSS shall send a Cancel Location Request with a Cancellation-Type of SGSN\_UPDATE\_PROCEDURE (CLR; see chapter 7.2.7, or MAP Cancel Location) to the previous SGSN (if any) and replace the stored SGSN-Identity with the received value (the SGSN-Identity is received within the Origin-Host AVP). The HSS shall reset the "UE purged in SGSN" flag and delete any stored last known SGSN location information of the (no longer) purged UE. If the "Initial-Attach-Indicator" flag was set in the received request, the HSS shall send a Cancel Location Request with a Cancellation-Type of INITIAL\_ATTACH\_PROCEDURE (CLR; see chapter 7.2.7) to the MME if there is an MME registration. + +When the HSS receives the Update Location Request, if a 15th digit of the IMEI AVP is received, the HSS may discard the digit. + +If the Update Location Request includes the list of active APNs, the HSS shall delete all the stored dynamic PDN GW information, if there are any, and then replace them by the PDN GW information received in the list of Active-APN AVPs. + +If the Update Location Request includes an equivalent PLMN list, the HSS shall return the CSG list (if any) for each equivalent PLMN to the MME with the subscription data, and Visited-PLMN-Id AVP shall be present in the CSG-Subscription-Data AVP to indicate the corresponding PLMN. If there is no equivalent PLMN list received, the HSS may not include Visited-PLMN-Id AVP in the CSG-Subscription-Data AVP, and the CSG-Subscription-Data AVP shall contain the CSG subscription data of the registered PLMN of the MME or the SGSN. + +If the Update Location Request is received over the S6a interface for a user for which the URRP-MME parameter is set in the HSS, the HSS shall clear the URRP-MME parameter and send an indication to the corresponding Service Related Entities. + +If the Update Location Request is received over the S6d interface for a user for which the URRP-SGSN parameter is set in the HSS, the HSS shall clear the URRP-SGSN parameter and send an indication to the corresponding Service Related Entities. + +If no result code has been sent to the MME or SGSN so far, the HSS shall include the subscription data in the ULA command according to the ULR-Flags and the supported/unsupported features of the MME or SGSN, unless an explicit "skip subscriber data" indication has been received in the request, and shall return a Result Code of DIAMETER\_SUCCESS. + +When the APN-Configuration-Profile AVP is present in the Subscription-Data AVP sent within a ULA, the AVP shall contain at least the default APN Configuration and a Context-Identifier AVP that identifies the per subscriber's default APN configuration. The default APN Configuration shall not contain the Wildcard APN (see 3GPP TS 23.003 [3], clause 9.2); the default APN shall always contain an explicit APN. + +The GPRS Subscription data (if available in the HSS) shall only be present in the ULA command if it was indicated by the serving node in the ULR-Flags AVP (see clause 7.3.7), or when the subscription data is returned by a Pre-Rel-8 HSS (via an IWF) or when the Update Location Request is received over the S6d interface and there is no APN configuration profile stored for the subscriber. + +The HSS shall use the indication received in the GPRS-Subscription-Data-Indicator for future use in the subscriber data update procedures. + +The HSS shall store the new terminal information and/or the new UE SRVCC capability, if they are present in the request. If the UE SRVCC capability is not present, the HSS shall store that it has no knowledge of the UE SRVCC capability. + +If the MME/SGSN indicates support of the Additional-MSISDN feature and an additional MSISDN (A-MSISDN) is available in the subscription data, the HSS shall send the provisioned additional MSISDN together with the MSISDN. + +If the MME/SGSN does not support the Additional-MSISDN feature, the HSS shall populate the MSISDN AVP either with the subscribed MSISDN or the subscribed additional MSISDN based on operator policy and availability. + +NOTE: When the MME/SGSN does not support the Additional-MSISDN feature, the MME/SGSN will use the MSISDN from the MSISDN AVP as C-MSISDN. + +LCS-Info, Teleservice-List and Call-Barring-Info data shall be included according to the list of supported features indicated by the serving node (see clause 7.3.10). + +If the HSS supports the "SMS in MME" feature and receives the indication that the MME supports the "SMS in MME" feature and requests to be registered for SMS by including the MME Number for MT SMS, SMS-Register-Request AVP and/or setting the SMS-Only-Indication flag in the ULR-Flags AVP if indicated from the UE, the HSS shall determine if SMS can be provided via the MME as described in 3GPP TS 23.272 [44]. If SMS in MME is accepted the HSS shall register the MME for SMS, store the "MME number for MT SMS" as the corresponding MSC number to be used for MT SMS and return an indication of MME registered for SMS in ULA-Flags AVP. + +If the MME is successfully registered for SMS the HSS shall download the available SMS related subscription data that may comprise SMS teleservice, MSISDN, ODB and barring services for SMS according to supported features. Also, if the user is considered as not reachable (i.e., MNRF flag is set in HSS for that user), and the UE is considered to have free available memory (i.e., MCEF flag is not set in HSS for that user), the HSS shall send a MAP-Alert-Service-Centre message or S6c-Alert-Service-Centre-Request to the SMS-IWMSC (see 3GPP TS 29.338 [48]). + +If the HSS supports the "SMS in SGSN" feature as described in 3GPP TS 23.060 [12], clause 5.3.18 and receives the indication from the SGSN that it supports "SMS in SGSN" feature, and SMS-Register-Request AVP and/or the SMS-Only-Indication flag in the ULR-Flags AVP if indicated from the UE, and the PS subscriber data allow for SMS services (e.g. the subscription information indicates "PS and SMS-Only"), the HSS shall determine if SMS can be provided via the SGSN as described in 3GPP TS 23.060 [12]. If "SMS in SGSN" is accepted the HSS shall indicate in the ULA that "SMS in SGSN" is allowed to the SGSN and shall handle MT SMS as described in 3GPP TS 23.060 [12], clause 5.3.18. If the HSS supports the "Gdd-in-SGSN" feature and receives the indication from the SGSN that it supports the "Gdd-in-SGSN" feature, the HSS shall store the information that the SGSN supports the Gdd interface. Also, if the user is considered as not reachable (i.e., MNRF flag is set in HSS for that user), and the UE is considered to have free available memory (i.e., MCEF flag is not set in HSS for that user), the HSS shall send a MAP-Alert-Service-Centre message or S6c-Alert-Service-Centre-Request to the SMS-IWMSC (see 3GPP TS 29.338 [48]). + +The HSS may use the indication received in the Node-Type-Indicator for future use in the subscriber data update procedures. + +Subscriber-Status AVP shall be present in the Subscription-Data AVP when sent within a ULA. If the value "OPERATOR\_DETERMINED\_BARRING" is sent, the Operator-Determined-Barring AVP or HPLMN-ODB AVP shall also be present in the Subscription-Data AVP, or vice versa. + +Access-Restriction-Data AVP shall be present within the Subscription-Data AVP sent within a ULA if at least one of the defined restrictions applies. + +The AMBR AVP shall be present in the Subscription-Data AVP when the APN-Configuration-Profile AVP is sent within a ULA (as part of the Subscription-Data AVP) and may be present in the Subscription-Data AVP when the GPRS-Subscription-Data AVP is present. + +The EPS-Subscribed-QoS-Profile AVP and the AMBR AVP shall be present in the APN-Configuration AVP when the APN-Configuration AVP is sent in the APN-Configuration-Profile AVP and when the APN-Configuration-Profile AVP is sent within a ULA (as part of the Subscription-Data AVP). + +For those APNs that have been authorized as a consequence of having the Wildcard APN in the user subscription, the HSS shall include the specific APN name and associated PDN-GW identity inside the APN context of the Wildcard APN. This indicates to the MME that the particular APN shall not be cached in the MME and it shall be deleted when the UE session is terminated. + +If a Result Code of DIAMETER\_SUCCESS is returned, the HSS shall set the Separation Indication in the response. + +If the HSS receives an indication in the ULR command about the homogeneous support of IMS Voice over PS Sessions in all TA/RAs associated to a serving node, it may use this information in the future in order to skip the T-ADS data retrieval, as described in clause 5.2.2.1 (IDR/IDA commands). + +Subscribed-VSRVCC AVP shall be present within the Subscription-Data AVP sent within a ULA only if the user is subscribed to the SRVCC and vSRVCC. + +If the UE is allowed to use Proximity-based Services in the visited PLMN, the HSS shall include ProSe-Subscription-Data AVP within the Subscription-Data AVP sent within a ULA. + +If the HSS receives the SGs MME identity and if the HSS supports this information element, the HSS shall store it for use with VLR restoration. + +If the HSS receives Update Location Request over both the S6a and S6d interfaces then based on the following conditions the HSS concludes if the UE is served by the MME and SGSN parts of the same combined MME/SGSN: + +- if both the messages contain the same SGSN number; or +- if the Diameter identity received over S6a matches with the Diameter identity received over S6d; or +- if the Coupled-Node-Diameter-ID AVP received over S6a interface matches with the Diameter identity received within Origin-Host AVP over S6d interface OR if the Coupled-Node-Diameter-ID AVP received over S6d interface matches with the Diameter identity received within Origin-Host AVP over S6a interface. + +If the HSS supports the handling of access restrictions for adjacent PLMNs, and it receives a list of adjacent PLMNs from the MME/SGSN, the HSS may send the associated Access Restriction Data, according to local operator policies, in the Adjacent-Access-Restriction-Data AVP, so the MME/SGSN can use this information to allow, or prevent, inter-RAT inter-PLMN handovers towards any of the PLMNs indicated by the HSS. The HSS shall not include in the list of Adjacent-Access-Restriction-Data the PLMN-ID, and its access restrictions, of the current PLMN where the MME/SGSN is located, since this information is already conveyed in the Access-Restriction-Data AVP inside the Subscription-Data AVP. + +If the HSS supports Monitoring events and receives a Supported-Services AVP it shall only trigger those services which are supported by the MME/SGSN. + +If the HSS has previously received over SWx (see 3GPP TS 29.273 [59]) the identity of the PDN-GW to be used for the establishment of emergency PDN connections, it shall include it as part of the Subscription-Data AVP (in the Emergency-Info AVP), in the Update Location response to the MME. + +If the UE is allowed to use V2X service in the visited PLMN and the MME supports V2X service, the HSS shall include V2X-Subscription-Data AVP into Subscription-Data AVP within the ULA command. + +If the MME/SGSN supports the "External-Identifier" feature, the HSS shall include the External-Identifier associated with Monitoring Event Configuration in the External-Identifier AVP if populated in the subscription. When multiple External Identifiers are defined for a same subscription, the HSS shall send a default External Identifier in the External-Identifier AVP of the Subscription-Data AVP, and shall include a specific External Identifier (if different from the default External Identifier) associated to each Monitoring Event Configuration in the External-Identifier AVP of each Monitoring-Event-Configuration AVP occurrence inside the Subscription-Data AVP. + +The Aerial-UE-Subscription-Information AVP shall be present within the Subscription-Data AVP sent within a ULA only if the user has Aerial UE subscription information. + +## 5.2.1.2 Cancel Location + +### 5.2.1.2.1 General + +The Cancel Location Procedure shall be used between the HSS and the MME and between the HSS and the SGSN to delete a subscriber record from the MME or SGSN. The procedure shall be invoked by the HSS and is used: + +- to inform the MME or SGSN about a subscription withdrawal, or a change in the subscriber profile that does not allow PS services anymore (e.g., the Network Access Mode does not allow PS services), or a change in the subscriber profile that does not allow access to EPC anymore, or +- to inform the MME or SGSN about an ongoing update procedure i.e. MME or SGSN change or +- to inform the MME or SGSN about an initial attach procedure. + +This procedure is mapped to the commands Cancel-Location-Request/Answer (CLR/CLA) in the Diameter application specified in chapter 7. + +Table 5.2.1.2.1/1 specifies the involved information elements for the request. + +Table 5.2.1.2.1/2 specifies the involved information elements for the answer. + +**Table 5.2.1.2.1/1: Cancel Location Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|---------------------------------------------|------------------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| IMSI | User-Name (See IETF RFC 6733 [61]) | M | This information element shall contain the user IMSI, formatted according to 3GPP TS 23.003 [3], clause 2.2. | +| Supported Features (See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Cancellation Type (See 7.3.24) | Cancellation-Type | M | Defined values that can be used are:
- MME-Update Procedure,
- SGSN-Update Procedure,
- Subscription Withdrawal,
- Update Procedure_IWF,
- Initial Attach Procedure. | +| CLR Flags (See 7.3.152) | CLR-Flags | O | This Information Element contains a bit mask. See 7.3.152 for the meaning of the bits and the condition for each bit to be set or not. | + +**Table 5.2.1.2.1/2: Cancel Location Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|---------------------------------------------|-----------------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Supported Features (See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Result (See 7.4) | Result-Code / Experimental-Result | M | The result of the operation.
The Result-Code AVP shall be used to indicate success / errors as defined in the Diameter base protocol (see IETF RFC 6733 [61]). | + +### 5.2.1.2.2 Detailed behaviour of the MME and the SGSN + +When receiving a Cancel Location request the MME or SGSN shall check whether the IMSI is known. + +If it is not known, a result code of DIAMETER\_SUCCESS is returned. + +If it is known, the MME or SGSN shall check the Cancellation Type and act accordingly. + +If the Cancellation Type is "Subscription Withdrawal", the MME or SGSN shall delete the subscription data and detach the UE; in addition, if the Reattach-Required flag is set, the MME or SGSN shall indicate to the UE to initiate an immediate re-attach procedure, as described in 3GPP TS 23.401 [2] and 3GPP TS 23.060 [12]. A result code of DIAMETER\_SUCCESS shall be returned. + +If a cancellation type of "Initial Attach Procedure" is received, the MME or SGSN shall not delete the subscription data. For details see 3GPP TS 23.401 [2] and 3GPP TS 23.060 [12]. If the MME receives this cancellation type, and it is registered for SMS, it shall consider itself as unregistered for SMS. Also in this case a result code of DIAMETER\_SUCCESS shall be returned. + +When a UE is served by a single combined MME/SGSN for both E-UTRAN and non-E-UTRAN access, the combined MME/SGSN shall check the Cancellation-Type. If it indicates Subscription Withdrawal or Update Procedure\_IWF, the CLR is processed both in the MME part and in the SGSN part of the combined node. If it indicates Initial Attach Procedure, and if the CLR-Flags AVP is received and supported by the combined MME/SGSN, the CLR is processed only in the affected part of the combined node as indicated by the "S6a/S6d-Indicator" flag in the CLR-Flags AVP. Otherwise, the CLR is processed only in the affected part of the combined node and subscription data are kept for the not affected part. + +### 5.2.1.2.3 Detailed behaviour of the HSS + +The HSS shall make use of this procedure when the subscription is withdrawn by the HSS operator, and when the HSS detects that the UE has moved to a new MME or SGSN area, and when EPC access is not allowed due to Core Network Restrictions. + +The HSS+UDM shall also make use of this procedure when the HSS+UDM detects that the UE has moved to a new AMF area, if the AMF indicates to the HSS+UDM to cancel MME and/or SGSN. The HSS+UDM shall include a cancellation type as specified in clause 5.4.2.2 of 3GPP TS 29.563 [70]. + +The HSS shall include a cancellation type of "Subscription Withdrawal" if the subscription is withdrawn by the operator, or if the subscriber profile does not allow PS services anymore, or if the Core Network Restrictions do not allow access to EPC anymore; the HSS may set the Reattach-Required flag in order to request the MME or the SGSN to trigger an immediate reattachment of the UE. + +The HSS shall include a cancellation type of "MME Update Procedure" if the UE moved to a new MME area. + +The HSS shall include a cancellation type of "SGSN Update Procedure" if the UE moved to a new SGSN area. + +The HSS shall include a cancellation type of "Initial Attach Procedure" if the cancel location is initiated due to an Initial Attach from the UE. + +The HSS shall include the CLR-Flags with the "S6a/S6d-Indicator" flag indicating the affected part of the combined node if the cancel location is to be sent to a combined MME/SGSN during initial attach procedure. + +### 5.2.1.3 Purge UE + +#### 5.2.1.3.1 General + +The Purge UE Procedure shall be used between the MME and the HSS and between the SGSN and the HSS to indicate that the subscriber's profile has been deleted from the MME or SGSN either by an MMI interaction or automatically, e.g. because the UE has been inactive for several days. + +This procedure is mapped to the commands Purge-UE-Request/Answer (PUR/PUA) in the Diameter application specified in chapter 7. + +Table 5.2.1.3.1/1 specifies the involved information elements for the request. + +Table 5.2.1.3.1/2 specifies the involved information elements for the answer. + +**Table 5.2.1.3.1/1: Purge UE Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|---------------------------------------------|------------------------------------|------|---------------------------------------------------------------------------------------------------------------------------------| +| IMSI | User-Name (See IETF RFC 6733 [61]) | M | This information element shall contain user IMSI, formatted according to 3GPP TS 23.003 [3], clause 2.2. | +| Supported Features (See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| PUR-Flags (See 7.3.149) | PUR-Flags | O | If present, this Information Element shall contain a bitmask. See clause 7.3.149 for the meaning of the bits. | +| EPS-Location-Information (See 7.3.111) | EPS-Location-Information | C | This Information Element shall contain the last known EPS-Location Information of the purged UE. Shall be present if available. | + +**Table 5.2.1.3.1/2: Purge UE Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|---------------------------------------------|-----------------------------------|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Supported Features (See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Result (See 7.4) | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation. The Result-Code AVP shall be used to indicate success / errors as defined in the Diameter base protocol (see IETF RFC 6733 [61]). The Experimental-Result AVP shall be used for S6a/S6d errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. The following errors are applicable:
- User Unknown | +| PUA-Flags (See 7.3.48) | PUA-Flags | C | This Information Element shall contain a bit mask. See clause 7.3.48 for the meaning of the bits. It shall be present only when the Result-Code AVP is DIAMETER_SUCCESS. | + +### 5.2.1.3.2 Detailed behaviour of the MME and the SGSN + +The MME shall make use of this procedure to set the "UE Purged in the MME" flag in the HSS when the subscription profile is deleted from the MME database due to MMI interaction or after long UE inactivity. + +The SGSN shall make use of this procedure to set the "UE Purged in SGSN" flag in the HSS when the subscription profile is deleted from the SGSN database due to MMI interaction or after long UE inactivity. + +The combined MME/SGSN when using a single Origin-Host identity shall make use of this procedure to set the "UE Purged in MME" and "UE Purged in SGSN" flags in the HSS when the subscription profile is deleted from the common MME/SGSN database due to MMI interaction or after long UE inactivity on all registered accesses. If the HSS has indicated support for the Partial Purge feature (see clause 7.3.10), the combined MME/SGSN may also indicate to the HSS a Purge of the UE in only one of the serving nodes in the combined node (either in the MME or in the SGSN). + +The combined MME/SGSN when using different Origin-Host identities for MME and SGSN shall send two **Purge UE Requests** as if it was not combined. + +When receiving a Purge UE response from the HSS the MME shall check the Result Code. If it indicates success, the MME shall check the PUA flag "freeze M-TMSI", and if set freeze the M-TMSI i.e. block it for immediate re-use. + +When receiving a Purge UE response from the HSS the SGSN shall check the Result Code. If it indicates success, the SGSN shall check the PUA flag "freeze P-TMSI", and if set freeze the P-TMSI i.e. block it for immediate re-use. + +When receiving a Purge UE response from the HSS the combined MME/SGSN shall check the Result Code. If it indicates success, the combined MME/SGSN shall check the PUA flag "freeze M-TMSI" and "freeze P-TMSI", and if set freeze the M-TMSI and/or the P-TMSI i.e. block it for immediate re-use. + +### 5.2.1.3.3 Detailed behaviour of HSS + +When receiving a Purge UE request the HSS shall check whether the IMSI is known. + +If it is not known, a result code of DIAMETER\_ERROR\_USER\_UNKNOWN shall be returned. + +If it is known, the HSS shall set the result code to DIAMETER\_SUCCESS and compare the received identity in the Origin-Host with the stored MME-Identity and with the stored SGSN-Identity. + +If the received identity matches the stored MME-identity and the stored SGSN-Identity (no matter whether the node type indicator bit in ULR-Flags was set or clear), then: + +- if the HSS supports the Partial Purge feature (see clause 7.3.10), and the combined MME/SGSN indicated that the UE was purged in only one of the serving nodes, the HSS shall set the PUA flags according to the serving node where the purge was done (i.e., either "freeze M-TMSI" if the purge was done in the MME, or "freeze P-TMSI" if the purge was done in the SGSN); similarly, the HSS shall either set the "UE purged in MME" flag and store the received last known MME Location information of the purged UE, or set the "UE purged in SGSN" flag and store the received last known SGSN-Location Information of the purged UE, accordingly; +- if the HSS does not support the Partial Purge feature, or the combined MME/SGSN did not indicate that the UE was purged in only one of the serving nodes, the HSS shall set the PUA flags "freeze M-TMSI" and "freeze P-TMSI" in the answer message and set the flag "UE purged in MME" and "UE purged in SGSN" and store the received last known EPS Location Information of the purged UE; + +If the received identity matches the stored MME-identity but not the stored SGSN-identity, the HSS shall set the PUA flag "freeze M-TMSI" and clear the PUA flag "freeze P-TMSI" in the answer message, set the flag "UE purged in MME" and store the received last known MME location information of the purged UE; + +If the received identity matches the stored SGSN-identity but not the stored MME-identity, the HSS shall set the PUA flag "freeze P-TMSI" and clear the PUA flag "freeze M-TMSI" in the answer message and set the flag "UE purged in SGSN" and store the received last known SGSN location information of the purged UE; + +If the received identity does not match the stored MME-identity and does not match the stored SGSN-identity, the HSS shall clear the PUA flags "freeze M-TMSI" and "freeze P-TMSI" in the answer message. + +## 5.2.2 Subscriber Data Handling Procedures + +### 5.2.2.1 Insert Subscriber Data + +#### 5.2.2.1.1 General + +The Insert Subscriber Data Procedure shall be used between the HSS and the MME and between the HSS and the SGSN for updating and/or requesting certain user data in the MME or SGSN in the following situations: + +- due to administrative changes of the user data in the HSS and the user is now located in an MME or SGSN, i.e. if the user was given a subscription and the subscription has changed; subscription data that are applicable to MMEs but not to SGSNs should not be sent to the SGSN unless the SGSN is known to be a combined MME/SGSN; similarly subscription data that are applicable to SGSNs but not to MMEs should not be sent to the MME unless the MME is known to be a combined MME/SGSN. +- the operator has applied, changed or removed Operator Determined Barring for this user; +- activate subscriber tracing in the MME or the SGSN; +- to indicate to the MME or SGSN that the HSS has requested to be notified when the UE has become reachable; +- to request from the MME or SGSN the necessary data to support the T-ADS functionality; +- to retrieve location information and/or state information from the MME or the SGSN; + +- to retrieve from the MME or the SGSN the Local Time Zone of the location in the visited network where the UE is attached; +- to update the STN-SR (e.g., as a result of an Sh interaction with an SCC-AS). +- to update the MME/SGSN with the identity of a dynamically allocated PDN GW as a result of the first PDN connection establishment associated with an APN over non 3GPP access. +- to update the MME with the identity of a PDN GW for Emergency Services as a result of the PDN connection establishment for Emergency Services over non 3GPP access. +- to indicate to the MME that the HSS has deregistered the MME for SMS. +- to indicate to the MME/SGSN that the HSS-based P-CSCF restoration procedure, as described in 3GPP TS 23.380 [51] clause 5.4, shall be executed. +- to request the MME or the SGSN to configure and report the detection of Monitoring events, or delete stored Monitoring events configuration. +- to update the MME with the O&M configured desired Active Time for power saving mode (PSM), or with the value received from the SCEF if Active Time is provided as part of the Suggested-Network-Configuration AVP. +- to update the MME with the O&M configured desired Core Network Restrictions to restrict/allow mobility to 5GC. + +If the HSS knows that the UE has attached to the MME and SGSN parts of the same combined MME/SGSN via both the E-UTRAN and UTRAN/GERAN (refer to clause 5.2.1.1.2, 5.2.1.1.3 for further details), the HSS should invoke this procedure for a single time to update and/or request certain user data in the combined MME/SGSN, i.e. the HSS should not invoke this procedure for each of the MME and the SGSN registered respectively. + +If the Node-Type-Indicator information has been previously received as cleared in the ULR-Flags and if the MME has not been registered for SMS during update location procedure for the MME, the HSS may skip any change of the SMS related subscription data and consequently does not have to make use of the Insert Subscriber Data procedure to update the SMS subscription data in the MME. + +This procedure is mapped to the commands Insert Subscriber Data-Request/Answer (IDR/IDA) in the Diameter application specified in clause 7. + +Table 5.2.2.1.1/1 specifies the involved information elements for the request. + +Table 5.2.2.1.1/2 specifies the involved information elements for the answer. + +**Table 5.2.2.1.1/1: Insert Subscriber Data Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|---------------------------------------------|-------------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| IMSI | User-Name (See IETF RFC 673 3 [61]) | M | This information element shall contain the user IMSI, formatted according to 3GPP TS 23.003 [3], clause 2.2. | +| Supported Features (See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Subscription Data (See 7.3.2) | Subscription-Data | M | This Information Element shall contain the part of the subscription profile that either is to be added to the subscription profile stored in the MME or SGSN or is replacing a part of the subscription profile stored in the MME or SGSN. | +| IDR Flags (See 7.3.103) | IDR-Flags | C | This Information Element shall contain a bit mask. See 7.3.103 for the meaning of the bits. | +| Reset-IDs (See 7.3.184) | Reset-ID | O | The Reset-ID uniquely identifies a fallible resource in the HSS on which the user (IMSI) depends. In the event of a restart of the fallible resource a Reset message containing the Reset-ID will exactly identify the impacted subscribers. | + +**Table 5.2.2.1.1/2: Insert Subscriber Data Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Supported Features
(See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host.
A combined MME/SGSN that makes use of separate origin host values in Update Location Request messages sent on S6a and Update Location Request messages sent on S6d can detect whether the IDR from HSS was sent to the MME or to the SGSN.
IDA sent from such combined MME/SGSN corresponds to the MME's or the SGSN's supported features respectively.
A combined MME/SGSN that makes use of a common origin host value in Update Location Request messages sent on S6a and Update Location Request messages sent on S6d cannot detect whether the IDR from HSS was sent to the MME or to the SGSN.
IDA sent from such combined MME/SGSN uses the union of the MME's and the SGSN's supported features. | +| Result
(See 7.4) | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation.
Result-Code AVP shall be used to indicate success / errors defined in the Diameter base protocol (see IETF RFC 6733 [61]).
The Experimental-Result AVP shall be used for S6a/S6d errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP.
The following errors are applicable in this case:
- User Unknown | +| IMS Voice over PS Sessions Supported
(See 7.3.106) | IMS-Voice-Over-PS-Sessions-Supported | C | If available to the serving node, this information element shall indicate whether or not "IMS Voice over PS Sessions" is supported by the UE's most recently used TA or RA in the serving node (MME or SGSN or combined MME/SGSN). If the UE is in detached state, this information element shall not be included in the response. | +| Last UE Activity Time
(See 7.3.108) | Last-UE-Activity-Time | C | If available to the serving node, this information element shall contain the time of the last radio contact with the UE. If the UE is in detached state, this information element shall not be included in the response. | +| RAT Type
(See 7.3.13) | RAT-Type | C | If available to the serving node, this information element shall indicate the RAT Type of the access where the UE was present at the time of the last radio contact. If the UE is in detached state, this information element shall not be included in the response. | +| IDA-Flags
(See 7.3.47) | IDA-Flags | C | This Information Element shall contain a bit mask. See 7.3.47 for the meaning of the bits. | +| EPS-User-State
(See 7.3.110) | EPS-User-State | C | This Information Element shall contain the EPS-User State. It shall be present if EPS user state was requested within IDR. | +| EPS-Location-Information
(See 7.3.111) | EPS-Location-Information | C | This Information Element shall contain the EPS-Location Information. It shall be present if EPS location information was requested within IDR. | +| Local Time Zone
(See 7.3.156) | Local-Time-Zone | C | This Information Element shall contain information on the Local Time Zone of the location in the visited network where the UE is attached. It shall be present if the Local Time Zone was requested within IDR. | +| Monitoring Event Report | Monitoring-Event-Report | C | This Information Element shall contain the report of Monitoring event. It shall be present if Monitoring event configuration is included within IDR and any of the requested Monitoring events are available to be reported. (see NOTE 1) | +| Monitoring Event Config Status | Monitoring-Event-Config-Status | C | This Information Element shall be present if Monitoring event configuration is included in IDR. It shall contain all the configuration status for each Monitoring event that was requested. | +| Supported Services
(3GPP TS 29.336 [54]) | Supported-Services | O | If present, this Information Element shall contain AVPs indicating details of the services supported by the MME/SGSN. | +| NOTE 1: In IWK-SCEF scenarios, an event is available to be reported by the visited MME only if the event is considered as authorized by the visited MME after checking with the IWK-SCEF. Otherwise, the immediate report shall be not be sent in this command (S6a/IDA), and it shall be sent over T6a using RIR command (see 3GPP TS 29.128 [63]). | | | | + +#### 5.2.2.1.2 Detailed behaviour of the MME and the SGSN + +When receiving an Insert Subscriber Data request the MME or SGSN shall check whether the IMSI is known. + +If it is not known, a result code of DIAMETER\_ERROR\_USER\_UNKNOWN shall be returned. + +If it is known, the MME or SGSN shall replace the specific part of the stored subscription data with the received data, or shall add the received data to the stored data. + +When receiving the APN-Configuration-Profile AVP within the Subscription-Data AVP, the MME or SGSN shall check the All-APN-Configurations-Included-Indicator value. If it indicates "All\_APN\_CONFIGURATIONS\_INCLUDED", the MME or SGSN shall delete all stored APN-Configurations and then store all received APN-Configurations. Otherwise, the MME or SGSN shall check the Context-Identifier value of each received APN-Configuration. If the Context-Identifier of a received APN-Configuration matches a Context-Identifier of a stored APN-Configuration, the MME or SGSN shall replace the stored APN-Configuration with the received APN-Configuration. If the Context-Identifier of a received APN-Configuration does not match a Context-Identifier of a stored APN-Configuration, the MME or SGSN shall add the received APN-Configuration to the stored APN-Configurations. If the addition or update of the subscription data succeeds in the MME or SGSN, the Result-Code shall be set to DIAMETER\_SUCCESS. The MME or SGSN shall then acknowledge the Insert Subscriber Data message by returning an Insert Subscriber Data Answer. + +For each of the received APN-Configurations in the APN-Configuration-Profile, if both the MIP6-Agent-Info and the PDN-GW-Allocation-Type AVPs are absent in the APN-Configuration AVP, the MME or SGSN shall perform the PGW selection (static or dynamic) according to the local configuration. If MIP6-Agent-Info is present, and PDN-GW-Allocation-Type is not present, this means that the PDN GW address included in MIP6-Agent-Info has been statically allocated. + +If the MME/SGSN supports interworking with Gn/Gp-SGSNs, it shall ensure that the context identifier sent over GTPv1 for each of the received APN-Configurations is within the range of 1 and 255. + +NOTE 1: If the MME/SGSN receives from HSS a Context-Identifier value higher than 255, how this value is mapped to a value between 1 and 255 is implementation specific. + +If the MME is requested to notify the HSS when the UE becomes reachable, the MME shall set the URRP-MME parameter to indicate the need to inform the HSS about UE reachability, e.g. when the next NAS activity from the UE is detected. If the SGSN is requested to notify the HSS when the UE becomes reachable, the SGSN shall set the URRP-SGSN parameter to indicate the need to inform the HSS about UE reachability, e.g. when the next NAS activity from the UE is detected. + +When receiving GPRS-Subscription-Data AVP within the Subscription-Data AVP, the SGSN or combined MME/SGSN shall check the Complete-Data-List-Included-Indicator value. If it indicates "All\_PDP\_CONTEXTS\_INCLUDED", the SGSN or combined MME/SGSN shall delete all stored PDP-Contexts and then store all received PDP-Contexts. Otherwise, the SGSN or combined MME/SGSN shall check the Context-Identifier value of each received PDP-Context. If the Context-Identifier of a received PDP-Context matches a Context-Identifier of a stored PDP-Context, the SGSN or combined MME/SGSN shall replace the stored PDP-Context with the received PDP-Context. If the Context-Identifier of a received PDP-Context does not match a Context-Identifier of a stored PDP-Context, the SGSN or combined MME/SGSN shall add the received PDP-Context to the stored PDP-Contexts. + +If the MME or SGSN receives an empty Subscription-Data AVP, it shall take no action with regard to the stored subscription data. + +When receiving HPLMN-ODB AVP within the Subscription-Data AVP, the MME or SGSN shall replace stored HPLMN-ODB data (if any) with the received information rather than add the received information to the stored information. Unsupported Barring categories need not be stored. + +When receiving Operator-Determined-Barring AVP within the Subscription-Data AVP, the MME or SGSN shall replace stored ODB subscription information (if any) with the received information rather than add the received information to the stored information. Unsupported Barring categories need not be stored. + +When receiving Access-Restriction-Data or Adjacent-Access-Restriction-Data AVPs within the Subscription-Data AVP, the MME or SGSN shall replace the corresponding stored information (if any) with the new received information, rather than adding received information to stored information. The handling of access restrictions per-PLMN is defined in 3GPP TS 23.221 [53], clause 6.3.5a and in 3GPP TS 23.401 [2] clause 4.3.28. + +When receiving APN-OI-Replacement AVP within the Subscription-Data AVP, the MME or SGSN shall replace the stored information (if any) with the received information. + +When receiving Regional-Subscription-Zone-Code AVP within the Subscription-Data AVP, the MME or SGSN shall replace stored Zone Codes (if any) with the received information rather than add the received information to the stored information. MMEs and SGSNs that do not support regional subscription need not store zone codes. If due to regional subscription restrictions or access restrictions the entire SGSN area is restricted, SGSN shall report it to the HSS by returning the "SGSN Area Restricted" indication within the IDA flags. + +When receiving CSG-Subscription-Data AVPs within the Subscription-Data AVP the MME or SGSN shall replace all stored information from previously received CSG-Subscription-Data AVPs (if any) with the received information rather than add the received information to the stored information. + +When receiving Teleservice-List AVP, Call-Barring-Info, or LCS-Info AVP, the MME or SGSN shall replace stored information (if any) with the received information rather than add the received information to the stored information. + +When receiving ProSe-Subscription-Data AVP, the MME or combined MME/SGSN shall replace stored information (if any) with the received information rather than add the received information to the stored information. + +When receiving and supporting Reset-ID AVPs within the request, the MME or SGSN shall replace stored information (if any) with received information rather than add received information to stored information. + +When receiving the IDR-Flags with the "T-ADS Data Request" bit set, and the UE is in attached state, the MME or SGSN or combined MME/SGSN shall return in the IDA message the time stamp of the UE's most recent radio contact and the associated RAT Type, and an indication of whether or not IMS Voice over PS is supported in the current (and most recently used) TA or RA. If the UE is in detached state, the MME or SGSN or combined MME/SGSN shall answer successfully to the T-ADS request from HSS, but it shall not include any of the T-ADS IEs in the response (IMS Voice over PS Sessions Supported, RAT Type and Last UE Activity Time). + +When receiving the IDR-Flags with the "EPS User State Request" bit and/or "EPS Location Information Request" bits set the MME or SGSN shall return the corresponding user information to the HSS. If the serving node is a combined MME/SGSN, and the UE is attached via both E-UTRAN and UTRAN/GERAN on the same node, the combined MME/SGSN shall provide the corresponding user information relevant for both MME and SGSN. If the Current Location Request bit was also set and the UE is in idle mode and is expected to be reachable even when it uses a power saving feature (e.g. extended idle mode DRX or PSM as defined in 3GPP TS 23.685 [55]), then the MME or SGSN or combined MME/SGSN shall page the UE in order to return the most up-to-date corresponding user information. If the Current Location Request bit was also set and either paging is unsuccessful or the UE is not expected to be reachable, then the last known location of the UE shall be returned to the HSS. If the Current Location Request bit was also set and the UE (attached via E-UTRAN) is in connected mode, then the MME or combined MME/SGSN shall use SIAP Location Reporting Control procedure towards the eNB prior to reporting the E-UTRAN Cell Global Identification in order to return the UE's most up-to-date cell information. When the location is returned to the HSS, the MME or the combined MME/SGSN shall provide the age of location information if stored in the MME or the combined MME/SGSN or received from eNB. + +When receiving the IDR-Flags with only the "Current Location Request" bit set (i.e. the "EPS Location Information Request" bit is not set), the MME or SGSN or combined MME/SGSN shall set the Result-Code to DIAMETER\_UNABLE\_TO\_COMPLY. + +If the "Local Time Zone Request" bit was set the MME or SGSN if supported shall provide the Local Time Zone corresponding to the location (e.g. TAI or RAI) of the UE to the HSS. + +If the MME or SGSN cannot fulfil the received request, e.g. due to a database error or any of the required actions cannot be performed, it shall set the Result-Code to DIAMETER\_UNABLE\_TO\_COMPLY. If subscription data are received, the MME or SGSN shall mark the subscription record "Subscriber to be restored in HSS". + +If trace data are received in the subscriber data, the MME or SGSN shall start a Trace Session. For details, see 3GPP TS 32.422 [23]. + +If the Ext-PDP-Type AVP is present in the PDP-Context AVP, the SGSN or combined MME/SGSN shall ignore the value of the PDP-Type AVP. + +When receiving the IDR-Flags with the bit "Remove SMS Registration" set, the MME shall consider itself unregistered for SMS. + +If the subscription data received for a certain APN includes WLAN-offloadability AVP, then the MME or SGSN shall determine the offloadability of the UE's PDN Connection(s) to that APN based on subscription data and locally configured policy (e.g. for roaming users or when the subscription data does not include any offloadability indication). + +NOTE 2: As indicated in clause 7.3.31, if the UE-level access restriction "HO-To-Non-3GPP-Access Not Allowed" is set, the offload of PDN Connections to WLAN is not allowed for any APN. + +When receiving the IDR-Flags with the "P-CSCF Restoration Request" bit set, the MME or SGSN or combined MME/SGSN shall execute the procedures for HSS-based P-CSCF Restoration, as described in 3GPP TS 23.380 [51] clause 5.4. + +If the subscription data received for the user includes the DL-Buffering-Suggested-Packet-Count AVP, then the MME or SGSN should take into account the subscription data, in addition to local policies, to determine whether to invoke extended buffering of downlink packets at the SGW for High Latency Communication. Otherwise, the MME or SGSN shall make this determination based on local policies only. + +When receiving IMSI-Group-Id AVP(s) within the Subscription-Data AVP, the MME or SGSN shall replace stored IMSI-Group Ids (if any) with the received information rather than add the received information to the stored information. + +In the present clause, if the feature "Extended Reference IDs" (see clause 7.3.10) is supported by the HSS and the MME/SGSN, the term "SCEF Reference ID" shall refer to the content of the 64-bit long "SCEF-Reference-ID-Ext" AVP, and the term "SCEF Reference ID for Deletion" shall refer to the content of the 64-bit long "SCEF-Reference-ID-for-Deletion-Ext" AVP. + +When receiving a Monitoring-Event-Configuration in the IDR: + +- if the SCEF Reference ID for Deletion is present in the IDR, the MME or SGSN shall stop the detection of the Monitoring event related to the SCEF Reference ID for Deletion and SCEF-ID pair, and shall delete the corresponding Monitoring event configuration data; +- if the SCEF Reference ID is present in the IDR but not stored in the MME or SGSN, the MME or SGSN shall store the received Monitoring event configuration data related to the SCEF Reference ID and SCEF-ID pair, and shall start the detection for the specified Monitoring event(s). +- if the SCEF Reference ID is present in the IDR and stored in the MME or SGSN, the MME or SGSN shall replace the stored Monitoring event configuration data related to the SCEF Reference ID and SCEF-ID pair with the received information. + +NOTE 3: In roaming scenarios the MME/SGSN can reply immediately to the HSS without waiting for the outcome of the interaction with the IWK-SCEF. + +For the monitoring event configurations for which the configuration status have changed since the last status informed to the HSS, the MME/SGSN shall notify the HSS about the outcome of the interaction with the IWK-SCEF as specified in clause 5.2.5.1.2. + +If the HSS indicates the support of Monitoring event feature to the MME/SGSN and the MME/SGSN supports Monitoring, the MME/SGSN shall include the Supported-Services AVP with Supported-Monitoring-Event included in the IDA command. + +When receiving the Maximum-Response-Time in Monitoring-Event-Configuration in IDR, the MME shall use the Maximum-Response-Time as the Active Time for the usage of PSM in UE. If not, when the MME receives the Active-Time in subscription data, the MME shall use the Active-Time as the Active Time for the usage of PSM in UE. + +When receiving AESE-Communication-Pattern AVP(s) within the Subscription-Data AVP with an SCEF Reference ID for which the MME has already stored data, it shall delete the stored data (CP set(s)) and store the received ones. + +When receiving AESE-Communication-Pattern AVP(s) within the Subscription-Data AVP with one or more SCEF Reference ID for deletion the MME shall delete the data related to the indicated SCEF Reference ID. + +If the MME and the UE support an Attach without PDN connection (i.e. EMM-REGISTERED without PDN connection) and the PDN-Connection-Restricted flag is set in the received Subscription-Data-Flags AVP, the MME shall not establish any non-emergency PDN connection and shall tear down any existing non-emergency PDN connection for this user. + +If the subscription data received for the user includes the Preferred-Data-Mode AVP, for an IP APN configuration or for a non-IP APN configuration with SGi based delivery, then the MME should (if the subscriber is not roaming) or may (if the subscriber is roaming) take into account the subscription data, in addition to local policies and the UE's Preferred Network Behaviour, to determine whether to transmit the traffic associated with this APN over the User Plane and/or over the Control Plane. Otherwise, the MME shall make this determination based on local policies and the UE's Preferred Network Behaviour only. + +If the MME subscription data received for the user includes the Emergency-Info AVP, the MME shall use the PDN-GW identity contained in such AVP as the PDN-GW used to establish emergency PDN connections with the emergency APN, for non-roaming authenticated UEs requesting the handover of an emergency PDN connection if the MME is configured to use a dynamic PDN-GW for emergency services for such user. + +When receiving V2X-Subscription-Data in the IDR, the MME shall determine whether the UE is authorized to use V2X communication over PC5 according to V2X subscription data and UE provided network capability. If the UE is authorized to use V2X communication over PC5, the MME shall store the "V2X service authorized" indication together with the UE AMBR used for PC5 interface (i.e. UE-PC5-AMBR), and provide such information to the eNodeB when needed. + +If the MME/SGSN receives from the HSS an Insert Subscriber Data request without the bit set for "NR as Secondary RAT" in the Feature-List AVP, the MME/SGSN, based on local policy, may restrict access for NR as secondary RAT when all relevant entities except HSS supports it. + +If the MME receives from the HSS Insert Subscriber Data request containing in the subscription data the Core-Network-Restrictions AVP with the bit "5GC not allowed" set, the MME shall restrict mobility towards 5GC. + +#### 5.2.2.1.3 Detailed behaviour of HSS + +The HSS shall make use of this procedure to replace a specific part of the user data stored in the MME or SGSN with the data sent, or to add a specific part of user data to the data stored in the MME or SGSN. The HSS shall also make use of this procedure to indicate to the MME that it is no longer registered for SMS. + +NOTE: When a Cancel Location message is required for other reasons, the use of IDR to indicate that the MME is no longer registered for SMS is not needed (see clause 5.2.1.2). + +Subscriber-Status AVP shall be present in the Subscription-Data AVP, sent within IDR, if the current value in the MME or SGSN needs to be changed. To remove all Operator Determined Barring Categories the Subscriber-Status shall be set to "SERVICE\_GRANTED". If Subscriber-Status AVP is present and set to OPERATOR\_DETERMINED\_BARRING, the Operator-Determined-Barring AVP or HPLMN-ODB AVP shall also be present in the Subscription-Data AVP. + +Access-Restriction-Data AVP shall be present within the Subscription-Data AVP sent within an IDR if the information stored in the MME or SGSN needs to be modified. + +APN-OI-Replacement AVP shall be present in the Subscription-Data AVP sent within an IDR, if the UE level APN-OI-Replacement has been added or modified in the HSS. + +The APN-Configuration-Profile AVP shall be present in the Subscription-Data AVP sent within an IDR if the Context-Identifier associated with the default APN configuration is changed or at least one APN-Configuration is added or modified by the HSS. If the default APN is changed in the HSS, the APN-Configuration-Profile AVP shall contain the Context-Identifier associated with the default APN and the APN-Configuration AVP for the default APN. The default APN Configuration shall not contain the Wildcard APN (see 3GPP TS 23.003 [3], clause 9.2); the default APN shall always contain an explicit APN. + +The EPS-Subscribed-QoS-Profile AVP and the AMBR AVP shall be present in the APN-Configuration AVP when the APN-Configuration AVP is sent in the APN-Configuration-Profile AVP and when the APN-Configuration-Profile AVP is sent within an IDR (as part of the Subscription-Data AVP). + +If the GPRS-Subscription-Data-Indicator information has been previously received as set in the ULR-Flags during update location procedure for the SGSN or combined MME/SGSN, the HSS shall make use of this procedure to replace the GPRS Subscription Data stored in the SGSN or combined MME/SGSN with the data sent or to add a PDP-Context to the data stored in the SGSN or combined MME/SGSN. + +ProSe-Subscription-Data AVP shall be present in the Subscription-Data AVP sent within an IDR, if the ProSe Subscription data has been added or modified in the HSS. + +If the HSS receives a message (e.g. via MAP ATM or Sh Sh-Subs-Notif) from a Service Related Entity (e.g. IP-SM-GW) indicating that the UE is unreachable, + +- the HSS shall associate the subscription to UE reachability of the service-related entity to the URRP-MME and the URRP-SGSN parameters (if not already done) +- and if the URRP-MME and/or the URRP-SGSN parameters were not already set (i.e. at least one service-related entity already listed as subscribed), the HSS shall + - set the URRP-MME and/or URRP-SGSN parameters and + - send an IDR command to the registered MME and/or to the registered SGSN including the "UE Reachability Request flag" in the IDR Request Flags in order to request the MME and/or SGSN to notify the HSS when the UE becomes reachable again, unless the HSS knows from the previous ULR command that the registered MME and/or the registered SGSN do not support UE reachability notifications. + +If the IDR is sent for the only purpose to request the MME and/or SGSN about the UE reachability status notification, the Subscription-Data AVP shall be included empty. + +If the HSS has received a message from a service related entity requesting EPS User State and/or EPS Location Information without the Serving Node Indication IE, the HSS shall set the "EPS User State Request" bit and/or "EPS Location Information Request" bit respectively in the IDR-Flags. The HSS may optionally also set the "Current Location Request" bit along with the "EPS Location Information Request" bit in the IDR-Flags, if the most up-to-date set of information is needed, unless the HSS knows from the previous ULR command that the registered MME and/or the registered SGSN do not support State/Location Information retrieval. If the IDR is sent only for the purpose of requesting the MME or the SGSN User State or Location Information, the Subscription-Data AVP included shall be empty. + +If the HSS cannot request EPS Location Information from the MME/SGSN e.g. because the UE is purged from the MME/SGSN, the HSS may make use of stored EPS Location information received in a previous IDA or PUR message. + +If the HSS has received a message from an AS requesting the current access network's support status of "IMS Voice over PS Sessions", and there is no indication about homogeneous support of IMS Voice over PS Sessions in all the serving nodes currently registered in HSS for the UE, the HSS shall set the "T-ADS Data Request flag" in the IDR Request Flags, unless the HSS knows from the previous ULR command that the registered MME and/or the registered SGSN do not support T-ADS data retrieval. If the IDR is sent for the only purpose to retrieve the "IMS Voice over PS Sessions Supported" indication from the MME or SGSN, the Subscription-Data AVP included shall be empty. + +If the HSS has received a message from an AS requesting the Local Time Zone, the HSS shall set the "Local Time Zone Request" bit in the IDR-Flags, unless the HSS knows from the previous ULR command that the registered MME and/or the registered SGSN do not support Local Time Zone retrieval. If the IDR is sent only for the purpose of requesting the Local Time Zone, the Subscription-Data AVP included shall be empty. + +If the HSS received an indication in a former ULR command from the MME or SGSN about homogeneous support of IMS Voice over PS Sessions in all TA/RAs associated to that serving node, it may use this information to skip the retrieval of T-ADS data. This can only be done if all the registered serving nodes in HSS for the UE indicated in ULR the same type of homogeneous support (i.e. both serving nodes indicated "SUPPORTED", or both serving nodes indicated "NOT\_SUPPORTED"); otherwise, the retrieval of T-ADS data shall be done, to receive the time of the last radio contact with the UE. + +All APN and PGW-ID pairs stored in the HSS not associated with an explicit APN subscription, (i.e. the access to that APN has been authorized as a consequence of having the Wildcard APN in the user subscription), shall be included by the HSS inside the APN context of the Wildcard APN, as multiple instances of the Specific-APN-Info AVP. + +When receiving an Insert Subscriber Data answer with "SGSN Area Restricted" the HSS shall set the SGSN area restricted flag as "SGSN area restricted". + +Subscribed-VSRVCC AVP may be present within the Subscription-Data AVP sent within an ISR only if the user is subscribed to the SRVCC and vSRVCC. + +If the HSS determines that the MME shall be unregistered for SMS it shall set the "Remove SMS Registration" bit in the IDR-Flags. If the IDR is sent for the only purpose to indicate that the MME is no longer registered for SMS, the Subscription-Data AVP shall be included empty. + +If the HSS needs to request to the MME/SGSN the execution of the HSS-based P-CSCF restoration procedure, as described in 3GPP TS 23.380 [51] clause 5.4, the HSS shall set the "P-CSCF Restoration Request" bit in the IDR-Flags, if supported by the MME/SGSN. If the IDR is sent only for the purpose of requesting the execution of the HSS-based P-CSCF restoration procedures, the Subscription-Data AVP included shall be empty. + +If the HSS receives a SCEF request to configure Monitoring events for the UE to be handled by the MME/SGSN or receives a SCEF request for deleting Monitoring events for the UE in the MME/SGSN, the HSS shall include Monitoring-Event-Configuration AVP(s) in the Subscription-Data AVP sent within the IDR. If the HSS has registered both an MME and an SGSN as serving nodes for a given user, and both nodes are not part of a same combined MME/SGSN node, the HSS shall send the Monitoring-Event-Configuration AVP(s) to each one of the serving nodes that supports the Monitoring event service. If the HSS receives the IDA with Monitoring-Event-Report AVP(s), the HSS shall forward the Monitoring-Event-Report AVP(s) to the SCEF associated to those Monitoring events. + +If the HSS does not receive a SCEF request to configure Monitoring events for the UE to be handled by the MME/SGSN and does not receive an Active Time with the Suggested-Network-Configuration AVP, the HSS may send an O&M configured desired Active Time value within the Active-Time AVP. + +If the HSS receives a Supported-Services AVP it shall only trigger those services which are supported by the MME/SGSN. + +If the HSS has previously received over SWx (see 3GPP TS 29.273 [59]) the identity of the PDN-GW to be used for the establishment of emergency PDN connections, it shall send it to the registered MME (if any) in the IDR command as part of the Subscription-Data AVP (in the Emergency-Info AVP). + +If V2X subscription data has been added or modified in the HSS, the HSS shall include the V2X-Subscription-Data AVP in the Subscription-Data AVP sent within an IDR. + +If the External-Identifier associated with Monitoring Event Configuration for the UE has been added or modified in the HSS and the MME/SGSN supports the "External-Identifier" feature, the HSS shall include the External-Identifier AVP in the Subscription-Data AVP. When multiple External Identifiers are defined for a same subscription, the HSS shall send a default External Identifier in the External-Identifier AVP of the Subscription-Data AVP, and shall include a specific External Identifier (if different from the default External Identifier) associated to each Monitoring Event Configuration in the External-Identifier AVP of each Monitoring-Event-Configuration AVP occurrence inside the Subscription-Data AVP. + +The Aerial-UE-Subscription-Information AVP may be present within the Subscription-Data AVP sent within an IDR only if the user has Aerial UE subscription information. + +If Core Network Restrictions in subscription data (5GC allowed/not allowed) has been added or modified in the HSS, the HSS shall include the Core-Network-Restrictions AVP in the Subscription-Data AVP sent within an IDR. + +## 5.2.2.2 Delete Subscriber Data + +### 5.2.2.2.1 General + +This procedure shall be used between the MME and the HSS and between the SGSN and the HSS, to remove some data of the HSS user profile stored in the MME or SGSN. The procedure shall be invoked by the HSS and it corresponds to the functional level operation Delete Subscriber Data (see 3GPP TS 23.401 [2]). + +It shall be used to remove: + +- a subset (which may or may not be the complete set of APN configurations) of the APN Configuration Profile for the subscriber from the SGSN or combined MME/SGSN; +- a proper subset (i.e. a subset that is not equal to the complete set of APN configurations and does not contain the default APN configuration) of the APN Configuration Profile for the subscriber from the MME; +- the regional subscription; +- the subscribed charging characteristics; +- Session Transfer Number for SRVCC; +- trace data; + +- ProSe subscription data; +- Reset-IDs; +- MSISDN; +- UE Usage Type; +- V2X subscription data. +- External Identifier(s). + +If the HSS knows that the UE has attached to the MME and SGSN parts of the same combined MME/SGSN via both E-UTRAN and UTRAN/GERAN(refer to clause 5.2.1.1.2, 5.2.1.1.3 for further details), the HSS should invoke this procedure for a single time to remove some or all data of the HSS user profile stored in the combined MME/SGSN, i.e. not invoke this procedure for each of the MME and the SGSN registered respectively. + +If the Node-Type-Indicator information has been previously received as cleared in the ULR-Flags and if the MME has not been registered for SMS during update location procedure for the MME, the HSS may skip any removal of the SMS related subscription data and consequently does not have to make use of the Delete Subscriber Data procedure to update the SMS subscription data in the MME. + +This procedure is mapped to the commands Delete-Subscriber-Data-Request/Answer (DSR/DSA) in the Diameter application specified in chapter 7. + +Table 5.2.2.2.1/1 specifies the involved information elements for the request. + +Table 5.2.2.2.1/2 specifies the involved information elements for the answer. + +**Table 5.2.2.2.1/1: Delete Subscriber Data Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|---------------------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| IMSI | User-Name
(See IETF RFC 6733 [61]) | M | This information element shall contain the user IMSI, formatted according to 3GPP TS 23.003 [3], clause 2.2. | +| Supported Features
(See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| DSR Flags
(See 7.3.25) | DSR-Flags | M | This Information Element shall contain a bit mask. See 7.3.25 for the meaning of the bits. | +| Trace Reference
(See 7.3.64) | Trace-Reference | C | This parameter shall contain the same value as used for the activation of the Trace Session.
This element shall be present only if the "Trace Data Withdrawal" bit is set in the DSR-Flags. | +| Context Identifier
(See 7.3.27) | Context-Identifier | C | This parameter shall identify the PDN subscription context or GPRS-PDP context that shall be deleted.
This element shall be present only if the "PDN subscription contexts Withdrawal" bit or the "PDP context withdrawal" bit is set in the DSR-Flags.
In the "PDN subscription contexts Withdrawal" case, the Context-Identifier shall not be associated with the default APN configuration.
For the compatibility with the MAP protocol as defined in the 3GPP TS 29.002 [24], this parameter shall not have a value of zero. | +| TS Code List
(See 7.3.100) | TS-Code | C | This parameter shall contain the teleservice codes that are to be deleted from the subscription.
This element shall be present only if the "SMS Withdrawal" bit is set in the DSR-Flags and the SMS related teleservice codes are to be deleted. | +| SS Code List
(See 7.3.87) | SS-Code | C | This parameter shall contain the supplementary service codes that are to be deleted from the subscription.
This element shall be present only if the "SMS Withdrawal" bit is set or the "LCS Withdrawal" bit is set in the DSR-Flags. | +| SCEF-Id
(See 3GPP TS 29.336 [54]) | SCEF-ID | C | This parameter shall contain the identity of the SCEF to which monitoring events that are to be deleted are associated.
This element shall be present if the "Delete monitoring events" bit is set in the DSR-Flags. | +| eDRX Related RAT List | eDRX-Related-RAT | C | This parameter shall contain the RAT types for which the eDRX Cycle Lengths is to be deleted from the subscription.
This element shall be present only if the "eDRX-Cycle-Length-Withdrawal" bit is set in the DSR-Flags and the corresponding eDRX Cycle Lengths are to be deleted.
If the "eDRX-Cycle-Length-Withdrawal" bit is set in DSR-Flags, but the eDRX-Related-RAT AVP is absent in this command, the MME/SGSN shall delete the stored eDRX cycle lengths for all RATs. | +| External Identifiers | External-Identifiers | O | If present, this parameter shall contain the External Identifier(s) to be deleted from the subscriber data; the MME/SGSN shall also delete those monitoring events that include an External-Identifier AVP in their event configuration matching any of the External-Identifiers in this IE.

This IE shall be absent if the "External-Identifier-Withdrawal" bit is not set in the DSR-Flags.

If this IE is absent, and "External-Identifier-Withdrawal" bit is set in DSR-Flags, the MME/SGSN shall delete the default External-Identifier in the Subscription-Data AVP and it shall also delete all monitoring events that include an External-Identifier AVP in their event configuration. | + +**Table 5.2.2.2.1/2: Delete Subscriber Data Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|-----------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Supported Features
(See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Result
(See 7.4) | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation.
The Result-Code AVP shall be used to indicate success / errors as defined in the Diameter base protocol (see IETF RFC 6733 [61]).
The Experimental-Result AVP shall be used for S6a/S6d errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP.
The following errors are applicable in this case:
- User Unknown | +| DSA Flags
(See 7.3.26) | DSA-Flags | C | This Information Element shall contain a bit mask. See 7.3.26 for the meaning of the bits. | + +## 5.2.2.2.2 Detailed behaviour of the MME and the SGSN + +When receiving a Delete Subscriber Data request, the MME or SGSN shall check whether the IMSI is known. + +If it is not known, a result code of DIAMETER\_ERROR\_USER\_UNKNOWN shall be returned. + +If it is known, but the Context-Identifier is associated with the default APN configuration, the MME shall not delete the PDN subscription context, and return an error with a Result-Code set to DIAMETER\_UNABLE\_TO\_COMPLY. + +Otherwise, the MME or SGSN shall delete the corresponding data according to the indication as sent in the request, and acknowledge the Delete Subscriber Data message by returning a Delete Subscriber Data Answer. + +If an MME receives a Delete Subscriber Data Request with the "Complete APN Configuration Profile Withdrawal" bit set in the DSR-Flags AVP, it shall return an error with a Result-Code set to DIAMETER\_UNABLE\_TO\_COMPLY. + +If the deletion of the subscription data succeeds in the MME or SGSN, the Result-Code shall be set to DIAMETER\_SUCCESS. + +If the Regional Subscription is deleted from the subscription data, the SGSN shall check for its routing areas whether they are allowed or not. If the entire SGSN area is restricted, SGSN shall report it to the HSS by returning the "SGSN Area Restricted" indication within the DSA flags. + +If the EPS Subscription Data is deleted from the subscription data, the MME or SGSN shall check whether all EPS Subscription Data for the subscriber is deleted or if only a subset of the stored EPS Subscription Data for the subscriber is deleted, the MME or SGSN may then deactivate the associated affected active EPS bearers. + +If the Subscribed Charging Characteristics are deleted from the subscription data, the Gn/Gp-SGSN shall maintain the existing Subscribed Charging Characteristics throughout the lifetime of the existing MM and PDP contexts, see 3GPP TS 32.251 [33]. + +If the Subscribed Charging Characteristics are deleted from the subscription data, the MME or S4-SGSN shall maintain the existing Subscribed Charging Characteristics throughout the lifetime of the existing IP CAN bearer, see 3GPP TS 32.251 [33]. + +If the MSISDN is deleted from the subscription data, the MME or SGSN shall maintain the existing MSISDN throughout the lifetime of the existing PDN connections that were established prior to the deletion of the MSISDN (i.e., other network nodes, such as PDN-GW, are not informed of such deletion for the existing PDN connections). + +If the MME or SGSN cannot fulfil the received request for other reasons, e.g. due to a database error, it shall set the Result-Code to DIAMETER\_UNABLE\_TO\_COMPLY. In this case, the MME or SGSN shall mark the subscription record "Subscriber to be restored in HSS". + +If trace data are deleted from the subscription data, the MME or SGSN shall deactivate the Trace Session identified by the trace reference. For details, see 3GPP TS 32.422 [23]. + +If External Identifiers are requested to be deleted from the subscription data, the MME/SGSN shall check whether any of the identifiers to be deleted match the default External-Identifier provided by HSS in the Subscription-Data AVP (unless all External Identifiers are requested to be deleted from the subscription); in such case, the MME/SGSN shall reject the request and return an error with a Result-Code set to DIAMETER\_UNABLE\_TO\_COMPLY. + +#### 5.2.2.2.3 Detailed behaviour of the HSS + +The HSS shall make use of this procedure to remove deleted subscription data from the MME or SGSN. + +The HSS shall make use of this procedure to remove deleted GPRS Subscription Data from the SGSN or combined MME/SGSN if the GPRS-Subscription-Data-Indicator information has been previously received as set in the ULR-Flags during update location procedure for the MME. + +The HSS shall not set the "Complete APN Configuration Profile Withdrawal" bit in the DSR-Flags AVP when sending a Delete Subscriber Data Request to an MME, since the default APN shall always be present in an MME. + +When receiving a Delete Subscriber Data Answer with "SGSN Area Restricted" the HSS shall set the SGSN area restricted flag as "SGSN area restricted". + +### 5.2.3 Authentication Procedures + +#### 5.2.3.1 Authentication Information Retrieval + +##### 5.2.3.1.1 General + +The Authentication Information Retrieval Procedure shall be used by the MME and by the SGSN to request Authentication Information from the HSS. + +This procedure is mapped to the commands Authentication-Information-Request/Answer (AIR/AIA) in the Diameter application specified in chapter 7. + +Table 5.2.3.1.1/1 specifies the involved information elements for the request. + +Table 5.2.3.1.1/2 specifies the involved information elements for the answer. + +**Table 5.2.3.1.1/1: Authentication Information Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|-----------------------------------------------------------|-------------------------------------------|------|---------------------------------------------------------------------------------------------------------------| +| IMSI | User-Name
(See IETF RFC 6733 [61]) | M | This information element shall contain the user IMSI, formatted according to 3GPP TS 23.003 [3], clause 2.2. | +| Supported Features
(See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Requested E-UTRAN Authentication Info
(See 7.3.11) | Requested-EUTRAN-Authentication-Info | C | This information element shall contain the information related to authentication requests for E-UTRAN. | +| Requested UTRAN/GERAN Authentication Info
(See 7.3.12) | Requested-UTRAN-GERAN Authentication-Info | C | This information element shall contain the information related to authentication requests for UTRAN or GERAN. | +| Visited PLMN ID
(See 7.3.9) | Visited-PLMN-ID | M | This IE shall contain the MCC and the MNC of the visited PLMN, see 3GPP TS 23.003 [3]. | +| AIR Flags
(See 7.3.201) | AIR-Flags | O | This IE, if present, contains a bit mask. See clause 7.3.201 for the meaning of the different bits. | + +**Table 5.2.3.1.1/2: Authentication Information Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|-----------------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result
(See 7.4) | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation.
This IE shall contain the Result-Code AVP shall be used to indicate success / errors as defined in the Diameter base protocol (see IETF RFC 6733 [61]).
The Experimental-Result AVP shall be used for S6a/S6d errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP.
The following errors are applicable in this case:
- User Unknown
- Unknown EPS Subscription
- Authentication Data Unavailable | +| Error-Diagnostic | Error-Diagnostic | O | If the Experimental Result indicated "Unknown EPS Subscription", Error Diagnostic may be present to indicate whether or not GPRS subscription data are subscribed (i.e. whether or not Network Access Mode stored in the HSS indicates that only CS service is allowed). | +| Supported Features
(See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Authentication Info
(See 7.3.17) | Authentication-Info | C | This IE shall contain the Authentication Vectors. | +| UE Usage Type
(See 7.3.202) | UE-Usage-Type | C | This IE shall be present if the HSS supports the Dedicated Core Networks feature, and the "Send UE Usage Type" flag was set in the AIR-Flags AVP in the AIR command, and this information is available in the user subscription.
If present, this IE shall contain the UE Usage Type of the subscriber (see clause 7.3.202). | + +### 5.2.3.1.2 Detailed behaviour of the MME and the SGSN + +The MME or SGSN shall make use of this procedure in order to retrieve the Authentication Vectors from the HSS. + +If the MME or SGSN supports Emergency services for users in limited service state, and the user's IMSI is not available from the UE, or the user's IMSI is marked as unauthenticated, the MME or SGSN shall not make use of the Authentication Information Retrieval procedure. + +If the request is triggered by a synchronization failure during E-UTRAN authentication, the MME or combined MME/SGSN shall include the Re-Synchronization Information in the Requested-EUTRAN-Authentication-Info AVP in the request. + +If the request is triggered by a synchronization failure during UTRAN or GERAN authentication, the SGSN or combined MME/SGSN shall include the Re-Synchronization Information in the Requested-UTRAN-GERAN-Authentication-Info AVP in the request. + +Re-Synchronization Information shall not be present in both the Requested-EUTRAN-Authentication-Info AVP and the Requested-UTRAN-GERAN-Authentication-Info AVP. + +A stand alone MME shall include the Requested-EUTRAN-Authentication-Info AVP and shall not include the Requested-UTRAN-GERAN-Authentication-Info AVP in the request. The Immediate-Response-Preferred AVP should be present if a EUTRAN-Vector is needed for immediate use. + +A stand alone SGSN shall not include the Requested-EUTRAN-Authentication-Info AVP and shall include the Requested-UTRAN-GERAN-Authentication-Info AVP in the request. The Immediate-Response-Preferred AVP should be present if a UTRAN/GERAN-Vector is needed for immediate use. + +A combined MME/SGSN may include both the Requested-EUTRAN-Authentication-Info AVP and the Requested-UTRAN-GERAN-Authentication-Info AVP in the request. If both the Requested-EUTRAN-Authentication-Info AVP and the Requested-UTRAN-GERAN-Authentication-Info AVP are present in the request, the Immediate-Response-Preferred AVP shall be present if the requested authentication vectors are needed for immediate use. The content of the Immediate-Response-Preferred AVP shall correspond to the access type which the UE is currently to be authenticated. The Immediate-Response-Preferred AVP shall not be present in both the Requested-EUTRAN-Authentication-Info AVP and the Requested-UTRAN-GERAN-Authentication-Info AVP. The presence of an Immediate-Response-Preferred AVP shall indicate that a vector is needed for immediate use. + +When EUTRAN-AVs and UTRAN-AVs or GERAN-AVs are requested, presence of Immediate-Response-Preferred AVP within the Requested-EUTRAN-Authentication-Info AVP shall indicate that EUTRAN-AVs are requested for immediate use in the MME/SGSN; presence of Immediate-Response-Preferred AVP within the Requested-UTRAN-GERAN-Authentication-Info AVP shall indicate that UTRAN-AVs or GERAN-AVs are requested for immediate use in the MME/SGSN. It may be used by the HSS to determine the number of vectors to be obtained from the AuC and the number of vectors downloaded to the MME or SGSN. + +If the MME or SGSN supports the Dedicated Core Networks functionality, and the MME or SGSN needs to retrieve the UE Usage Type from the HSS, it shall set the "Send UE Usage Type" flag in the AIR-Flags AVP in the AIR command. + +When receiving an Authentication Information response from the HSS, the MME or SGSN shall check the Result Code. If it indicates success and Authentication Information is present in the result, the MME or SGSN shall use the received vectors. For details see 3GPP TS 33.401 [5]. + +If the MME or SGSN supports Emergency services for users in limited service state, the MME or SGSN shall proceed even if the Authentication Information Retrieval procedure has failed. In this case, the MME or SGSN shall mark the user's IMSI as unauthenticated. + +Vectors with lower Item Number should be used before Vectors with higher Item Number are used in the MME or SGSN. For Vectors received within different requests those received by the earlier request should be used before those received by the later request. + +### 5.2.3.1.3 Detailed behaviour of the HSS + +When receiving an Authentication Information request the HSS shall check whether subscription data exists for the IMSI. + +If the HSS determines that there is not any type of subscription for the IMSI (including EPS, GPRS and CS subscription data), a result code of DIAMETER\_ERROR\_USER\_UNKNOWN shall be returned. + +If the Authentication Information Request contains a Requested-EUTRAN-Authentication-Info AVP but no Requested-UTRAN-GERAN-Authentication-Info AVP, and the subscriber has not any APN configuration, the HSS shall return a Result Code of DIAMETER\_ERROR\_UNKNOWN\_EPS\_SUBSCRIPTION. + +If the Authentication Information Request contains a Requested-UTRAN-GERAN-Authentication-Info AVP but no Requested-EUTRAN-Authentication-Info AVP, and the subscriber has neither an APN configuration profile nor GPRS subscription data, the HSS shall return a Result Code of DIAMETER\_ERROR\_UNKNOWN\_EPS\_SUBSCRIPTION. + +If the Authentication Information Request contains both Requested-EUTRAN-Authentication-Info AVP and Requested-UTRAN-GERAN-Authentication-Info AVP, and the Requested-EUTRAN-Authentication-Info AVP does not contain an Immediate-Response-Preferred AVP, and the subscriber has not any APN configuration, the HSS shall not return E-UTRAN vectors. + +If the Authentication Information Request contains both Requested-EUTRAN-Authentication-Info AVP and Requested-UTRAN-GERAN-Authentication-Info AVP, and the Requested-EUTRAN-Authentication-Info AVP contains an Immediate-Response-Preferred AVP, and the subscriber does not have any APN configuration, the HSS shall return a Result Code of DIAMETER\_ERROR\_UNKNOWN\_EPS\_SUBSCRIPTION. + +When sending DIAMETER\_ERROR\_UNKNOWN\_EPS\_SUBSCRIPTION, an Error Diagnostic information may be added to indicate whether or not GPRS subscription data are subscribed (i.e. whether or not Network Access Mode stored in the HSS indicates that only circuit service is allowed). + +If EUTRAN-Authentication-Info is requested, the HSS shall check if serving nodes within the realm identified by the received Origin-Realm AVP are allowed to request authentication information for use in the serving network identified by the received Visited-PLMN-Id AVP. + +The HSS shall then request the AuC to generate the corresponding requested Authentication Vectors (AVs). Subject to load considerations and/or other implementation specific considerations which may be based on the presence of an Immediate-Response-Preferred AVP, less AVs than the requested number of AVs may be generated. + +If EUTRAN-Authentication-Info is requested, when receiving AVs from the AuC, the HSS shall generate the KASME before sending the response to the MME or combined MME-SGSN. + +If the AuC is unable to calculate any corresponding AVs due to unallowed attachment for the UE, e.g. the UE is attaching via E-UTRAN with a SIM card equipped, the HSS shall return an error DIAMETER\_AUTHORIZATION\_REJECTED, the HSS shall not return any AV to the requesting node in the response. Otherwise, if no corresponding pre-computed AV is available, and the AuC is unable to calculate any corresponding AVs due to unknown failures, such as the internal database error, the result code shall be set to DIAMETER\_AUTHENTICATION\_DATA\_UNAVAILABLE. The MME or the SGSN may request authentication vectors again. + +For details see 3GPP TS 33.401 [5]. KASME generation is not performed before sending the response to the SGSN. + +If the Requested-EUTRAN-Authentication-Info AVP is present in the request, the HSS shall download E-UTRAN authentication vectors to the MME. If the Requested-UTRAN-GERAN-Authentication-Info AVP is present in the request, the HSS shall download UTRAN or GERAN authentication vectors to the SGSN. + +If the Immediate Response Preferred parameter has been received, the HSS may use it together with the number of requested vectors and the number of vectors stored in the HSS that are pre-computed to determine the number of vectors to be obtained from the AuC. The HSS may return less number of vectors than requested to the MME or SGSN. If both the Requested-EUTRAN-Authentication-Info AVP and the Requested-UTRAN-GERAN-Authentication-Info AVP are in the request, and one of them includes the Immediate Response Preferred parameter, the HSS may omit the vectors request that are not for immediate use. If both the Requested-EUTRAN-Authentication-Info AVP and the Requested-UTRAN-GERAN-Authentication-Info AVP are in the request, and both of them includes the Immediate Response Preferred parameter, the HSS may return E-UTRAN authentication vectors and UTRAN or GERAN authentication vectors. KASME is always computed for each E-UTRAN vector due to the PLMN-binding before sending the response to the MME independent of the presence of the Immediate Response Preferred parameter. + +If the Re-Synchronization-Info AVP has been received, the HSS shall check the AUTS parameter before sending new authentication vectors to the MME or the SGSN. For details see 3GPP TS 33.102 [18]. If both the Requested-EUTRAN-Authentication-Info AVP and the Requested-UTRAN-GERAN-Authentication-Info AVP are in the request, + +and both of them include the Re-Synchronization-Info AVP, the HSS shall not check the AUTS parameter and return the result code of DIAMETER\_UNABLE\_TO\_COMPLY. Any authentication vectors shall not be sent by the HSS to the requesting node in the response. + +If more than one EPS or UTRAN or GERAN Vector is to be included within one Authentication-Info AVP, the Item-Number AVP shall be present within each Vector. + +If the HSS supports the Dedicated Core Networks functionality, and the MME or SGSN has set the "Send UE Usage Type" flag in the AIR-Flags AVP in the AIR command: + +- if the UE Usage Type value is available in the subscription data of the user: + - if the Immediate Response Preferred parameter is not present in the Requested-EUTRAN-Authentication-Info nor in the Requested-UTRAN-GERAN-Authentication-Info, the HSS may return no authentication vectors in the response; the HSS shall then return the result code DIAMETER\_SUCCESS and may return the generated AVs (if any) to the MME or SGSN; +- the HSS shall include the UE-Usage-Type AVP in the AIA response command if the result code is DIAMETER\_SUCCESS or DIAMETER\_AUTHENTICATION\_DATA\_UNAVAILABLE. +- if the UE Usage Type value is not available in the subscription data of the user, the HSS shall answer as if the MME/SGSN had not requested the UE Usage Type parameter. + +## 5.2.4 Fault Recovery Procedures + +### 5.2.4.1 Reset + +#### 5.2.4.1.1 General + +The Reset Procedure shall be used by the HSS, after a restart, to indicate to the MME and to the SGSN that a failure has occurred. + +The Reset Procedure may also be used by the HSS as part of operation and maintenance actions e.g. to allow planned HSS outage without service interruption, or to update subscription data shared by multiple subscribers. + +This procedure is mapped to the commands Reset-Request/Answer (RSR/RSA) in the Diameter application specified in chapter 7. + +Table 5.2.4.1.1/1 specifies the involved information elements for the request. + +Table 5.2.4.1.1/2 specifies the involved information elements for the answer. + +**Table 5.2.4.1.1/1: Reset Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|----------------------------|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| User Id List
(See 7.3.50) | User-Id | O | This IE shall contain a list of User-Ids where a User-Id comprises the leading digits of an IMSI (i.e. MCC, MNC, leading digits of MSIN) and it shall identify the set of subscribers whose IMSIs begin with the User-Id. The HSS may include this information element if the occurred failure is limited to subscribers identified by one or more User-Ids. | +| Supported Features
(See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Reset-IDs
(See 7.3.184) | Reset-ID | O | If present, this information element identifies the set of impacted subscribers. | +| Subscription Data
(See 7.3.2) | Subscription-Data | O | If the Reset Procedure is used to add/ modify subscription data shared by multiple subscribers, this Information Element shall contain the part of the subscription profile that either is to be added to the subscription profile stored in the MME or SGSN or combined MME/SGSN or is replacing a part of the subscription profiles of the impacted subscribers stored in the MME or SGSN.
Shall be absent if Subscription-Data-Deletion AVP is present.
Shall be absent if Reset-ID AVP is absent | +| Subscription Data Deletion
(See 7.3.208) | Subscription-Data-Deletion | O | If the Reset Procedure is used to delete subscription data shared by multiple subscribers, this Information Element shall contain identifications of the part of the subscription profile that is to be deleted from the subscription profiles of the impacted subscribers stored in the MME or SGSN or combined MME/SGSN.
Shall be absent if Subscription-Data AVP is present.
Shall be absent if Reset-ID AVP is absent | + +**Table 5.2.4.1.1/2: Reset Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|-----------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Supported Features
(See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Result
(See 7.4) | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation.
The Result-Code AVP shall be used to indicate success / errors as defined in the Diameter base protocol (see IETF RFC 6733 [61]).
The Experimental-Result AVP shall be used for S6a/S6d errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP.
There are no Experimental-Result codes applicable for this command. | + +#### 5.2.4.1.2 Detailed behaviour of the MME and the SGSN + +When receiving a Reset message neither containing Subscription-Data nor Subscription-Data-Deletion the MME or SGSN or combined MME/SGSN shall mark all impacted subscriber records "Location Information Confirmed in HSS " as "Not Confirmed". + +When receiving a Reset message containing Subscription-Data or Subscription-Data-Deletion the MME or SGSN or combined MME/SGSN shall update all impacted subscriber records accordingly, i.e. each impacted subscriber record is updated as if an individual IDR or DSR for that subscriber was received; for details see clauses 5.2.2.1.2 and 5.2.2.2.2. The MME or SGSN or combined MME/SGSN shall not mark successfully updated subscriber records "Location Information Confirmed in HSS " as "Not Confirmed". If an impacted subscriber record cannot be updated for any reason (e.g. the updated data is considered not shareable by the MME or SGSN or combined MME/SGSN, or the update requires an individual acknowledgement to be sent to the HSS), the MME or SGSN or combined MME/SGSN shall mark that record "Location Information Confirmed in HSS " as "Not Confirmed". + +NOTE: Which subscription data are considered by the MME or SGSN or combined MME/SGSN not shareable by multiple subscribers is implementation specific. + +If the update of shared subscription data requires only local updates in the MME or SGSN or combined MME/SGSN (i.e., the update of the profile does not imply to initiate any signalling interaction towards other network nodes), the updates should be performed immediately (e.g. deleting an Operator Determined Barring). + +If the update of shared subscription data implies initiating a signalling interaction towards other nodes (e.g. towards the PGW/PCRF for the change of an APN configuration parameter, such as APN-AMBR), depending on the UE's state the following shall apply: + +- If the UE is in CONNECTED state, the updates shall be performed immediately including signalling towards other nodes. +- If the UE is in IDLE state, the signalling towards other nodes should be deferred to the next authenticated radio contact with that UE. + +NOTE: The rational for the recommendation to defer signalling towards other nodes until the next authenticated radio contact is to consider impacts to the network only when the updates are required, and to spread the signalling towards other nodes over some time, based on user's activity. + +In both cases, to avoid high processing/signalling load resulting from shared subscription data update, processing/signalling actions resulting from data updates in the MME or SGSN or combined MME/SGSN may take a maximum operator configuration-depending time. + +If the Reset-IDs IE is supported and received, the MME or SGSN or combined MME/SGSN shall make use of the Reset-IDs (together with the HSS's realm) in order to determine which subscriber records are impacted (i.e. check whether at least one received Reset-ID is associated with the subscriber); otherwise the MME or SGSN or combined MME/SGSN shall make use of the HSS Identity received in the Origin-Host AVP (by comparing it with the value stored after successful ULA) and may make use of the received User-Id-List (if any) in order to determine which subscriber records are impacted. + +At the next authenticated radio contact with the UE concerned, if the subscriber record "Location Information Confirmed in HSS" is marked as "Not Confirmed", the restoration procedure shall be triggered. + +See also 3GPP TS 29.118 [46] clause 5.9.2. + +#### 5.2.4.1.3 Detailed behaviour of the HSS + +The HSS shall make use of this procedure in order to indicate to all relevant MMEs, SGSN, and combined MME/SGSNs that the HSS has restarted and may have lost the current MME-Identity and SGSN-Identity of some of its subscribers who may be currently roaming in the MME area and/or SGSN area, and that the HSS, therefore, cannot send a Cancel Location messages or Insert Subscriber Data messages when needed. + +The HSS may make use of this procedure in order to indicate to all relevant MMEs, SGSN, and combined MME/SGSNs that the HSS has updated subscription data shared by some of its subscribers who may be currently roaming in the MME area and/or SGSN area. + +If the Reset-ID feature is not supported by the MME/SGSN and HSS, the HSS optionally may include a list of Ids identifying a subset of subscribers served by the HSS, if the occurred failure is limited to those subscribers. + +If the Reset-ID feature is supported by the MME or SGSN, the HSS optionally may include one (or several) Reset-ID AVPs identifying e.g. failed hardware components if the occurred failure is limited to those subscribers associated with e.g. the identified failed hardware components. + +The HSS should invoke this procedure towards a combined MME/SGSN only for a single time even if some of the impacted subscribers are attached to the combined MME/SGSN via UTRAN/GERAN and some of the impacted subscribers are attached to the combined MME/SGSN via E-UTRAN. + +## 5.2.5 Notification Procedures + +### 5.2.5.1 Notification + +#### 5.2.5.1.1 General + +The Notification Procedure shall be used between the MME and the HSS and between the SGSN and the HSS when an inter MME or SGSN location update does not occur but the HSS needs to be notified about + +- an update of terminal information; +- an update of the UE SRVCC capability (only if the MME/SGSN supports SRVCC). + +The Notification Procedure shall also be used between the MME and the HSS and between the SGSN and the HSS if the HSS needs to be notified about: + +- an assignment/change of a dynamically allocated PDN GW for an APN, if such a notification is needed taking into account the access restrictions and the type of PDN; + +NOTE: If the PDN is of type "non-IP", the APN is not accessible via non-3GPP access and therefore the PDN-GW ID does not need to be conveyed across accesses. + +- an assignment/change of a dynamically allocated PDN GW for the establishment of emergency PDN connections, if such notification is needed for a non roaming authenticated user, based on operator policy (e.g. on whether the operator uses static PDN GW or not for emergency services) taking into account the access restrictions and feature support; +- the failed monitoring event configurations at the MME or SGSN (if received in ULA) or the status of the monitoring event configurations at the IWK-SCEF; +- the deletion of a monitoring event configuration in SCEF for a UE (i.e. due to an SCEF restart, see 3GPP TS 23.007 [43]). + +The Notification Procedure shall be used between the MME and the HSS when an inter MME location update does not occur but the HSS needs to be notified about + +- the need to send a Cancel Location to the current SGSN. + +The Notification Procedure shall be used between the MME and the HSS when the "SMS in MME" feature is applied and between the SGSN and the HSS when an earlier short message delivery failed and the HSS needs to be notified about: + +- the UE is reachable or the UE has memory capacity available to receive one or more short messages. + +The Notification Procedure shall be used between the MME and the HSS and between the SGSN and the HSS when the HSS has requested to be notified about: + +- the UE is reachable. + +The Notification Procedure shall be used between the MME and the HSS and between the SGSN and the HSS to notify the HSS about: + +- an update of the Homogeneous Support of IMS Voice Over PS Sessions. + +The Notification Procedure shall be used between the MME and the HSS to notify the HSS about: + +- removal of MME registration for SMS. + +This procedure is mapped to the commands Notify-Request/Answer (NOR/NOA) in the Diameter application specified in chapter 7. + +Table 5.2.5.1.1/1 specifies the involved information elements for the request. + +Table 5.2.5.1.1/2 specifies the involved information elements for the answer. + +**Table 5.2.5.1.1/1: Notify Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|-----------------------------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| IMSI | User-Name
(See IETF RFC 6733 [61]) | M | This information element shall contain the user IMSI, formatted according to 3GPP TS 23.003 [3], clause 2.2. | +| Supported Features
(See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Terminal Information
(See 7.3.3) | Terminal-Information | C | This information element shall contain information about the user's mobile equipment.
When notifying the HSS about any change of Terminal Information, the MME or SGSN shall include the new Terminal Information in the request.
Within this Information Element, only the IMEI and the Software-Version AVPs shall be used on the S6a/S6d interface. | +| PDN GW Identity
(See 7.3.45) | MIP6-Agent-Info | C | This IE shall contain the identity of the selected and dynamically allocated PDN GW for an APN. It shall be present if a new PDN-GW has been selected and the subscriber is allowed handover to non 3GPP access. When notifying the HSS about a newly selected PDN GW, the MME or SGSN shall include the PDN-GW-Identity in the request.
For establishment of emergency PDN connections, this IE shall contain the identity of the PDN-GW used to establish those PDN connections. | +| PGW PLMN ID | Visited-Network-Identifier | C | This IE identifies the PLMN in which the PDN GW is located. It shall be present when the PDN GW Identity is present and does not contain an FQDN. | +| Context Identifier
(See 7.3.27) | Context-Identifier | O | This parameter shall identify the APN Configuration with which the selected PDN GW shall be correlated.
It may be present if it is available and the PDN-GW is present and is particular for one specific APN and not common to all the APNs.
For the compatibility with the MAP protocol as defined in the 3GPP TS 29.002 [24], this parameter shall not have a value of zero. | +| APN
(See TS 23.008 [30]) | Service-Selection
(See IETF RFC 5778 [20]) | C | This IE shall contain the APN for the selected and dynamically allocated PDN GW.

For establishment of non-emergency PDN connections, it shall be present if the selected PDN-GW is present and is particular for one specific APN and not common to all the APNs.

For establishment of emergency PDN connections (i.e., the Emergency-Services AVP is present, with the Emergency-Indication flag set), this AVP shall be left absent. | +| Alert Reason
(See 7.3.83) | Alert-Reason | C | This parameter shall indicate if the mobile subscriber is present or the MS has memory available.
It shall be present when notifying the HSS about the presence of the UE or the UE has memory capacity available to receive one or more short messages. | +| UE SRVCC Capability | UE-SRVCC-Capability | C | This information element shall indicate if the UE supports or does not support the SRVCC capability.
If the MME/SGSN supports SRVCC and the UE SRVCC Capability has changed, the MME or SGSN shall include the new UE SRVCC Capability in the request. | +| NOR Flags
(See 7.3.49) | NOR-Flags | C | This Information Element shall contain a bit mask. See 7.3.49 for the meaning of the bits. Absence of this information element shall be interpreted as all bits set to 0.
When notifying the HSS about the need to send cancel location to the current SGSN, the MME shall set the "Single-Registration-Indication" flag in the NOR-Flags.
When notifying the HSS about the "restricted" status of the current SGSN area, the SGSN shall set the "SGSN area restricted" flag in the NOR-Flags.
When notifying the HSS about the reachability of the UE or the UE has memory capacity available to receive one or more short messages, the MME, if the "SMS in MME" feature is applied, or SGSN shall set the "Ready for SM" flag correspondingly in the NOR-Flags.
When notifying the HSS that the UE is reachable, the MME or SGSN shall | + +| | | | | +|-----------------------------------------------------------------|----------------------------------------------------|---|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | set the "UE Reachable" flag correspondingly in the NOR-Flags.
When notifying the HSS about update of the Homogeneous Support of IMS Voice Over PS Sessions, the MME or the SGSN shall set the "Homogeneous Support of IMS Voice Over PS Sessions" flag and S6a/S6d-Indicator flag for a combined MME/SGSN correspondingly in the NOR-Flags.
When notifying the HSS about removal of MME registration for SMS, the MME shall set the "Removal of MME Registration for SMS" flag correspondingly in the NOR-Flags. | +| Homogeneous Support of IMS Voice Over PS Sessions (See 7.3.107) | Homogeneous -Support-of-IMS-Voice-Over-PS-Sessions | C | This Information Element shall be present if Homogeneous Support of IMS Voice Over PS Sessions is modified to one of the values "SUPPORTED" or "NOT_SUPPORTED".

The value "SUPPORTED" indicates that there is support for "IMS Voice over PS Sessions" in all TAs or RAs.

The value "NOT_SUPPORTED" indicates that there is not support for "IMS Voice over PS Sessions" in any of the TAs or RAs. | +| Maximum UE Availability Time | Maximum-UE-Availability-Time | O | This information element may be included when notifying the HSS that the UE is reachable. When present, it shall indicate the timestamp (in UTC) until which a UE using a power saving mechanism (such as extended idle mode DRX) is expected to be reachable for SM Delivery.
This information may be used by the SMS Center to prioritize the retransmission of Short Message to UEs using a power saving mechanism. | +| Monitoring Event Config Status | Monitoring-Event-Config-Status | C | This information element shall be present if the MME/SGSN sends the Notify Request after receiving the Configuration-Information-Answer from the IWK-SCEF. This information element shall only contain the monitoring event configuration status of those events whose configuration status has changed since the last status informed to the HSS.

This information element shall also be present if any of the monitoring events configurations received in ULA failed and shall only contain the monitoring event configuration status of those events whose detection could not be started at the MME/SGSN.

This information element shall also be present if the MME or SGSN determines that a Monitoring Event Configuration for a UE is to be deleted in the HSS (i.e. SCEF responds to a Monitoring Event Report with DIAMETER_ERROR_SCEF_REFERENCE_ID_UNKNOWN). | +| Emergency Services (See 3GPP TS 29.273 [59]) | Emergency-Services | C | The MME shall include this information element, and set the Emergency-Indication flag, to notify the HSS that a new PDN-GW has been selected for the establishment of an emergency PDN connection, whose identity is conveyed in the "PDN GW Identity" IE. | + +Table 5.2.5.1.1/2: Notify Answer + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|---------------------------------------------|-----------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result (See 7.4) | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation.
The Result-Code AVP shall be used to indicate success / errors as defined in the Diameter base protocol (see IETF RFC 6733 [61]).
The Experimental-Result AVP shall be used for S6a/S6d errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP.
The following errors are applicable in this case:
- User Unknown | +| Supported Features (See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | + +#### 5.2.5.1.2 Detailed behaviour of the MME and the SGSN + +If the MME or SGSN supports Emergency services, the MME or SGSN shall not make use of the Notification procedure for emergency attached unauthenticated UEs; for authenticated UEs, the MME shall make use of the Notification procedure to inform the HSS about the PDN-GW selected to establish emergency PDN connections, if the MME is configured to use a dynamic PGW for emergency services for such UEs. + +The MME or SGSN shall not make use of the Notification procedure to inform the HSS about the identity of the dynamically selected PDN-GW, if the access restrictions indicate that the user is not allowed to get service via non-3GPP access, or the PDN type of the APN is of type "non-IP". + +The MME or SGSN shall include conditional AVPs in NOR according to the description given in table 5.2.5.1.1/1. + +If the MME sends a Notify Request to inform the HSS that the UE has become reachable again, the MME shall clear the corresponding URRP-MME for the UE. + +If the SGSN sends a Notify Request to inform the HSS that the UE has become reachable again, the SGSN shall clear the corresponding URRP-SGSN for the UE. + +If the MME sends a Notify Request to inform the HSS about the presence of the UE to receive one or more short messages, the MME shall clear the corresponding MNRF for the UE. + +If the SGSN sends a Notify Request to inform the HSS about the presence of the UE to receive one or more short messages, the SGSN shall clear the corresponding MNRG for the UE. + +If the MME or SGSN determines that it needs to update the Homogeneous Support of IMS Voice Over PS Sessions in the HSS, the MME or SGSN shall send a Notify Request with the "Homogeneous Support of IMS Voice Over PS Sessions" bit set in the NOR-Flags AVP; if there is homogeneous support, or homogeneous non-support, of IMS Voice Over PS Sessions, the MME or SGSN shall report it by including the updated Homogeneous-Support-of-IMS-Voice-Over-PS-Sessions AVP; if the support is not homogeneous, the MME or SGSN shall report it by leaving such AVP absent in the Notify Request to the HSS. MME or SGSN shall ensure the status of Homogeneous Support of IMS Voice Sessions in HSS does not contradict with the value of "IMS voice over PS session indicator" provided to UE over NAS as specified in 3GPP TS 24.008 [31] and 3GPP TS 24.301 [64]; + +if "IMS voice over PS session indicator" sent to UE has changed from "not supported" to "supported" when status Homogenous Support of IMS Voice in HSS is "not supported", MME or SGSN shall immediately send Notify Request indicating as either homogenous support or not homogenous; + +if "IMS voice over PS session indicator" sent to UE has changed from "supported" to "not supported" when status Homogenous Support of IMS Voice in HSS is "supported", MME or SGSN shall immediately send Notify Request indicating as either homogenous non-support or not homogenous. + +If the MME needs to indicate to the HSS that it is no longer registered for SMS in the HSS, the MME shall send a Notify Request with "Removal of MME Registration for SMS" flag set in the NOR-Flags AVP. + +When receiving a Notify response from the HSS, if the result code indicates + +DIAMETER\_ERROR\_UNKNOWN\_SERVING\_NODE, the MME or SGSN shall consider the Notification procedure as failed, and it shall mark the subscriber record as "Subscriber to be restored in HSS". + +When receiving a Notify response from the HSS, if the result code indicates + +DIAMETER\_ERROR\_USER\_UNKNOWN, the MME or SGSN shall detach the subscriber and remove the subscriber from its database. + +If the MME/SGSN has received the monitoring event configurations in an ULA command and one, several or all event detections fail to be started (e.g due to maximum resources exceeded), the MME/SGSN shall send the Notify Request command with the Monitoring-Event-Config-Status AVP for the failed monitoring event configurations. + +If the MME or SGSN receives a failure response, e.g. DIAMETER\_UNABLE\_TO\_COMPLY, corresponding to a Notify Request to notify the HSS about the selected PDN-GW, the MME or SGSN shall not trigger a detach for the subscriber based only on this failure. + +NOTE 1: A failure to indicate the selected PDN-GW to the HSS does not impact connectivity provided via 3GPP access. + +When the MME/SGSN has received the Configuration-Information-Answer from the IWK-SCEF during the monitoring event configuration procedure, the MME/SGSN shall send the Notify Request command with the Monitoring-Event-Config-Status AVP as received from the IWK-SCEF in the Configuration-Information-Answer, for the monitoring + +event configurations whose status have changed (due to authorization performed by the IWK-SCEF) since last informed to the HSS. + +NOTE 2: If the Monitoring-Event-Configuration was received at the MME/SGSN in the ULA command, then the HSS is not yet informed of any status of the monitoring event configuration. In this case, the entire Monitoring-Event-Config-Status as received from IWK-SCEF has to be transferred to the HSS through a Notify Request Command. + +If the MME or SGSN determines that a Monitoring Event Configuration for a UE is to be deleted in the HSS (i.e. SCEF responds to a Monitoring Event Report with DIAMETER\_ERROR\_SCEF\_REFERENCE\_ID\_UNKNOWN), the MME or SGSN shall send a Notify Request with the Monitoring-Event-Config-Status AVP. The Monitoring-Event-Config-Status AVP shall include the error as received from SCEF. + +#### 5.2.5.1.3 Detailed behaviour of the HSS + +When receiving a Notify request the HSS shall check whether the IMSI is known. + +If it is not known, a result code of DIAMETER\_ERROR\_USER\_UNKNOWN shall be returned. + +If the IMSI is known, and the source MME or SGSN originating the Notify message is not currently registered in HSS for that UE, a result code of DIAMETER\_ERROR\_UNKNOWN\_SERVING\_NODE shall be returned. + +If the IMSI is known, and the source MME or SGSN is currently registered in HSS, the HSS shall set the result code to DIAMETER\_SUCCESS, unless otherwise stated, and + +- store the new terminal information if present in the request; +- store the new UE SRVCC capability if present in the request; +- store the new PDN GW and PLMN ID for an APN if present in the request and the APN is present in the subscription and if PDN GW is dynamically allocated; otherwise the HSS shall not store the new PDN GW data and shall set the result code to DIAMETER\_UNABLE\_TO\_COMPLY; +- store the new PDN GW and PLMN ID, and the APN itself, if both are present in the request, and the APN is not present in the subscription but a wild card APN is present in the subscription; +- if the Emergency Services IE is present, with the Emergency-Indication flag set, store the new PDN GW, as the PDN GW used to establish emergency PDN connections; the HSS shall store this information not bound to any specific APN; +- mark the location area as "restricted" if so indicated in the request; +- send Cancel Location to the current SGSN if so indicated in the request; +- if the UE has become reachable again, and NOR is received on S6a from an MME or on S6d from an SGSN, the HSS shall respectively clear the URRP-MME or the URPP-SGSN parameter for the UE and send an indication to the Service Related Entities if there is any; +- when NOR is received on S6d from an SGSN (with the Alert Reason present), the HSS shall reset the MNRG flag and send a MAP-Alert-Service-Centre message or S6c-Alert-Service-Centre-Request (see 3GPP TS 29.338 [48], i.e. the behaviour in the HSS should be the same as when a MAP-Ready for SM is received from an SGSN; +- when NOR is received on S6a from an MME (with the Alert Reason present), the HSS shall reset the MNRF flag and send a MAP-Alert-Service-Centre message or S6c-Alert-Service-Centre-Request (see 3GPP TS 29.338 [48], i.e. the behaviour in the HSS should be the same as when a MAP-Ready for SM is received from a VLR/MSC; +- when NOR is received on S6a from an MME or on S6d from an SGSN to update the Homogeneous Support of IMS Voice Over PS Sessions, the HSS shall store the updated Homogeneous Support of IMS Voice Over PS Sessions and may use this information in the future in order to skip the T-ADS data retrieval, as described in clause 5.2.2.1 (IDR/IDA commands). If the "Homogeneous Support of IMS Voice Over PS Sessions" bit is set in the NOR-Flags AVP received but without Homogeneous-Support-of-IMS-Voice-Over-PS-Sessions AVP present in the NOR message, the HSS shall take the Homogeneous Support of IMS Voice Over PS Sessions as unknown to the serving node. If the "Homogeneous Support of IMS Voice Over PS Sessions" bit is not set in the NOR-Flags AVP, the HSS shall ignore (if present) the Homogeneous-Support-of-IMS-Voice-Over-PS-Sessions AVP; + +- when NOR is received on S6a from an MME for removal of MME registration for SMS, the HSS shall remove the MME registration for SMS and the "MME number for SMS" as the corresponding MSC number to be used for MT SMS. +- when NOR is received on S6a from an MME or on S6d from an SGSN with the Monitoring-Event-Config-Status AVP, the HSS shall either trigger a Monitoring event cancelation procedure for the monitoring events that were not successfully authorized at the MME/SGSN by the IWK-SCEF or a Monitoring event suspension procedure for the monitoring events that were not successfully configured at the MME/SGSN, as specified in clause 7.2.2.2 of 3GPP TS 29.336 [54]. The HSS shall trigger a Monitoring event cancelation or suspension procedure based on the result code as indicated by MME/SGSN (e.g. DIAMETER\_ERROR\_UNAUTHORIZED\_REQUESTING\_ENTITY (5510) returned by IWK-SCEF triggers a Monitoring event cancelation procedure in HSS). +- when NOR is received on S6a from an MME or on S6d from an SGSN with an indication of the deletion of a monitoring event configuration in SCEF (DIAMETER\_ERROR\_SCEF\_REFERENCE\_ID\_UNKNOWN in the Monitoring-Event-Config-Status AVP), the HSS shall locally delete the corresponding Monitoring Event Configuration and shall not trigger a Monitoring event cancelation procedure. + +and then send the response to the MME or SGSN. + +--- + +## 5A MME – CSS (S7a) and SGSN – CSS (S7d) + +### 5A.1 Introduction + +The S7a interface enables the transfer of subscriber related CSG data in the VPLMN between the MME and the CSS as described in 3GPP TS 23.401 [2]. + +The S7d interface enables the transfer of subscriber related CSG data in the VPLMN between the SGSN and the CSS as described in 3GPP TS 23.060 [12]. + +### 5A.2 Mobility Services + +#### 5A.2.1 Location Management Procedures + +##### 5A.2.1.1 Update VCSG Location + +###### 5A.2.1.1.1 General + +The Update VCSG Location Procedure shall be used between the MME and the CSS or between the SGSN and the CSS to update location information in the CSS or retrieve the CSG subscription data of the UE from the CSS. The procedure allows: + +- to inform the CSS about the identity of the MME or SGSN currently serving the user, +- to update MME or SGSN with user CSG subscription data received from the CSS. + +This procedure is mapped to the commands Update-VCSG-Location-Request/Answer (UVR/UVA) in the Diameter application specified in chapter 7. + +Table 5A.2.1.1.1/1 specifies the involved information elements for the request. + +Table 5A.2.1.1.1/2 specifies the involved information elements for the answer. + +**Table 5A.2.1.1.1/1: Update VCSG Location Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|---------------------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| IMSI | User-Name
(See IETF RFC 6733 [61]) | M | This information element shall contain the user IMSI, formatted according to 3GPP TS 23.003 [3], clause 2.2. | +| Supported Features
(See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| MSISDN | MSISDN | C | This information element shall contain the user MSISDN, formatted according to 3GPP TS 29.329 [25]. It shall be present if available. | +| UVR Flags
(See 7.3.153) | UVR-Flags | M | This Information Element contains a bit mask. See 7.3.153 for the meaning of the bits. | +| SGSN number
(See 7.3.102) | SGSN-Number | C | This Information Element contains the ISDN number of the SGSN, see 3GPP TS 23.003 [3].
It shall be present when the message is sent on the S7d interface.
It may be present when the message on the S7a interface and the requesting node is a combined MME/SGSN. | + +**Table 5A.2.1.1.1/2: Update VCSG Location Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|-----------------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Supported Features
(See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Result
(See 7.4) | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation.
The Result-Code AVP shall be used to indicate success / errors as defined in the Diameter base protocol (see IETF RFC 6733 [61]).
The Experimental-Result AVP shall be used for S7a/S7d errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP.
The following errors are applicable:
- User Unknown | +| VPLMN CSG Subscription Data
(See 7.3.155) | VPLMN-CSG-Subscription-Data | C | This Information Element shall contain the list of CSG Ids and the associated expiry dates stored in the CSS. It shall be present if success is reported, unless an explicit "skip subscriber data" indication was present in the request or the Temporary Empty VPLMN CSG Subscription Data flag is set. | +| UVA Flags
(See 7.3.154) | UVA-Flags | C | This Information Element contains a bit mask. See 7.3.154 for the meaning of the bits. | + +#### 5A.2.1.1.2 Detailed behaviour of the MME and the SGSN + +The MME or SGSN shall make use of this procedure to register the UE in the CSS and to retrieve the "CSG subscription data from CSS" when: + +- the VPLMN supports Autonomous CSG Roaming +- and the HPLMN has enabled Autonomous CSG Roaming in the VPLMN +- and the UE has requested an initial attach or a tracking area procedure or a routing area procedure to a CSG cell +- and the MME or SGSN have not yet registered the UE in the CSS. + +If the Autonomous CSG Roaming in the VPLMN is not supported or is not allowed by the HPLMN of the subscriber, the MME or SGSN shall not make use of the Update CSG Location procedure. + +For UEs receiving emergency services, in which the UE was not successfully authenticated, the MME or SGSN shall not make use of the Update VCSG Location procedure. + +A combined MME/SGSN shall set the "Skip Subscriber Data" flag in the UVR-Flags if the "CSG subscription data from CSS" are already available due to a previously VCSG Location updating. + +A combined MME/SGSN that has chosen the option to include the SGSN Number within an Update VCSG Request sent over S7a shall be prepared to receive a single CSG subscription data update message from the CSS when the CSG subscription data is modified in the CSS. + +When receiving an Update VCSG Location Answer from the CSS, the MME or SGSN shall check the result code. If it indicates success the MME or SGSN shall delete all the stored "CSG subscription data from CSS" (if any) and then store the received "CSG subscription data from the CSS" (if any), and it shall store the CSS identity as received in the Origin-Host AVP. + +If the same CSG Id exists in both "CSG subscription data from CSS" and "CSG subscription data from HSS", the "CSG subscription data from HSS" shall take precedence over the "CSG subscription data from CSS" in further use. + +If an error response is received from the CSS, the MME or SGSN shall not reject the UE and shall end the procedure when the UE is attaching to a normal cell. If the UE is attaching to a CSG cell, in this case the MME or SGSN shall check if there is such CSG Id from the HSS. If there is no such CSG Id, the MME or SGSN shall reject the UE. + +#### 5A.2.1.1.3 Detailed behaviour of the CSS + +When receiving an Update VCSG Location request the CSS shall check whether the user is known. + +If the user is not known, and if the Update VCSG Location Request is received over the S7a/S7d interface, the CSS may: + +- store the MME or SGSN identity received within the Origin-Host AVP, and include the UVA-Flags AVP with "Temporary Empty VPLMN CSG Subscription Data" flag set, and return a Result Code of DIAMETER\_SUCCESS, or +- return a Result Code of DIAMETER\_ERROR\_USER\_UNKNOWN. + +NOTE: A mechanism is needed in the CSS to associate the CSG subscription data of the user with the received IMSI. + +If the Update VCSG Location Request is received over the S7a/S7d interface, the CSS shall replace the stored MME or SGSN identity with the received value (the identity is received within the Origin-Host AVP). + +If no result code indicating an error is sent to the MME or SGSN, the CSS shall include the VPLMN CSG subscription data in the Update VCSG Location Answer unless an explicit "skip subscriber data" indication has been received in the request, and shall return a Result Code of DIAMETER\_SUCCESS. + +#### 5A.2.1.2 Cancel VCSG Location + +##### 5A.2.1.2.1 General + +The Cancel VCSG Location Procedure shall be used between the CSS and the MME and between the CSS and the SGSN. The procedure shall be invoked by the CSS and is used: + +- to inform the MME or SGSN about the subscriber's VCSG subscription withdrawal by the CSS operator and the removal of their registration in the CSS. + +This procedure is mapped to the commands Cancel-VCSG-Location-Request/Answer (CVR/CVA) in the Diameter application specified in chapter 7. + +Table 5A.2.1.2.1/1 specifies the involved information elements for the request. + +Table 5A.2.1.2.1/2 specifies the involved information elements for the answer. + +**Table 5A.2.1.2.1/1: Cancel VCSG Location Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|---------------------------------------|------|--------------------------------------------------------------------------------------------------------------| +| IMSI | User-Name
(See IETF RFC 6733 [61]) | M | This information element shall contain the user IMSI, formatted according to 3GPP TS 23.003 [3], clause 2.2. | +| Supported Features
(See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Cancellation Type
(See 7.3.24) | Cancellation-Type | M | Defined values that can be used are:
- Subscription Withdrawal, applied to the VPLMN CSG subscription. | + +**Table 5A.2.1.2.1/2: Cancel VCSG Location Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|-----------------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Supported Features
(See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Result
(See 7.4) | Result-Code / Experimental-Result | M | The result of the operation.
The Result-Code AVP shall be used to indicate success / errors as defined in the Diameter base protocol (see IETF RFC 6733 [61]). | + +### 5A.2.1.2.2 Detailed behaviour of the MME and the SGSN + +When receiving a Cancel VCSG Location request the MME or SGSN shall check whether the IMSI is known. + +If it is not known, a result code of DIAMETER\_SUCCESS is returned. + +If it is known, the MME or SGSN shall check if the Cancellation Type is Subscription Withdrawal. In this case, the MME or SGSN shall remove the information of their registration in the CSS and the stored VPLMN CSG subscription if any. Also in this case a result code of DIAMETER\_SUCCESS is returned. + +When a UE is served by a single combined MME/SGSN for both E-UTRAN and non-E-UTRAN access, the combined MME/SGSN shall check if the Cancellation Type is Subscription Withdrawal. In this case, the Cancel VCSG Location request is processed both in the MME part and in the SGSN part of the combined node. + +### 5A.2.1.2.3 Detailed behaviour of the CSS + +The CSS shall make use of this procedure when the user's VPLMN CSG subscription is withdrawn by the CSS operator and shall include a cancellation type of "Subscription Withdrawal". + +## 5A.2.2 Subscriber Data Handling Procedures + +### 5A.2.2.1 Insert VCSG Subscriber Data + +#### 5A.2.2.1.1 General + +The Insert VCSG Subscriber Data Procedure shall be used between the CSS and the MME and between the CSS and the SGSN for updating CSG subscription data in the MME or SGSN in the following situations: + +- due to administrative changes of the user data in the CSS and the user is now located in an MME or SGSN, i.e. if the user was given a CSG subscription and the CSG subscription has changed; + +If the CSS knows that the UE has attached to the same combined MME/SGSN via both the E-UTRAN and UTRAN/GERAN, i.e. the CSS has received the Update VCSG Location Request over both the S7a interface and S7d interface respectively with the same SGSN number, the CSS should invoke this procedure for a single time to update CSG subscription data in the combined MME/SGSN, i.e. the CSS should not invoke this procedure for each of the MME and the SGSN registered respectively. + +This procedure is mapped to the commands Insert-Subscriber Data-Request/Answer (IDR/IDA) in the Diameter application specified in clause 7. + +Table 5A.2.2.1.1/1 specifies the involved information elements for the request. + +Table 5A.2.2.1.1/2 specifies the involved information elements for the answer. + +**Table 5A.2.2.1.1/1: Insert VCSG Subscriber Data Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|---------------------------------------------|------------------------------------|------|---------------------------------------------------------------------------------------------------------------------| +| IMSI | User-Name (See IETF RFC 6733 [61]) | M | This information element shall contain the user IMSI, formatted according to 3GPP TS 23.003 [3], clause 2.2. | +| Supported Features (See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| VPLMN CSG Subscription Data (See 7.3.2) | VPLMN-CSG-Subscription-Data | M | This Information Element shall contain the list of CSG Ids and the associated expiry dates stored in the VPLMN CSS. | + +**Table 5A.2.2.1.1/2: Insert VCSG Subscriber Data Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|---------------------------------------------|-----------------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Supported Features (See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Result (See 7.4) | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation. Result-Code AVP shall be used to indicate success / errors defined in the Diameter base protocol (see IETF RFC 6733 [61]). The Experimental-Result AVP shall be used for S7a/S7d errors. This is a grouped AVP which shall contain the 3GPP Vendor Id in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. The following errors are applicable in this case:
- User Unknown. | + +#### 5A.2.2.1.2 Detailed behaviour of the MME and the SGSN + +When receiving an Insert VCSG Subscriber Data request, the MME or SGSN shall check whether the IMSI is known. + +If it is not known, a result code of DIAMETER\_ERROR\_USER\_UNKNOWN shall be returned. + +If the request does not contain any CSG-Subscription-Data AVP, Experimental-Result shall be set to DIAMETER\_ERROR\_SUBS\_DATA\_ABSENT. + +If the request contains at least one CSG-Subscription-Data AVPs, the MME or SGSN shall delete all the stored "CSG subscription data from CSS" (if any), and then store the received "CSG subscription data from CSS". + +If the MME or SGSN cannot fulfil the received request, e.g. due to a database error, it shall set the Result-Code to DIAMETER\_UNABLE\_TO\_COMPLY. + +If the same CSG Id exists in both "CSG subscription data from CSS" and "CSG subscription data from HSS", the "CSG subscription data from HSS" shall take precedence over the "CSG subscription data from CSS" in further use. + +#### 5A.2.2.1.3 Detailed behaviour of CSS + +The CSS shall make use of this procedure to delete the "CSG subscription data from CSS" stored in the MME or SGSN and replace them with the CSG subscription data sent. + +If the CSS receives a Insert VCSG Subscriber Data answer with the Result Code DIAMETER\_ERROR\_USER\_UNKNOWN, the CSS shall clear the stored MME or SGSN identity. + +#### 5A.2.2.2 Delete VCSG Subscriber Data + +##### 5A.2.2.2.1 General + +This procedure shall be used between the CSS and the MME or between the CSS and the SGSN, to remove all the "CSG subscription data from CSS" stored in the MME or SGSN. The procedure shall be invoked by the CSS. + +If the CSS knows that the UE has attached to the same combined MME/SGSN via both E-UTRAN and UTRAN/GERAN, i.e. the CSS has received the Update VCSG Location Request over both the S7a interface and S7d interface respectively with the same SGSN number, the CSS should invoke this procedure for a single time to remove all the "CSG subscription data from CSS" stored in the combined MME/SGSN, i.e. not invoke this procedure for each of the MME and the SGSN registered respectively. + +This procedure is mapped to the commands Delete-Subscriber-Data-Request/Answer (DSR/DSA) in the S7a/S7d Diameter application specified in clause 7. + +Table 5A.2.2.2.1/1 specifies the involved information elements for the request. + +Table 5A.2.2.2.1/2 specifies the involved information elements for the answer. + +**Table 5A.2.2.2.1/1: Delete VCSG Subscriber Data Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|---------------------------------------|------|--------------------------------------------------------------------------------------------------------------| +| IMSI | User-Name
(See IETF RFC 6733 [61]) | M | This information element shall contain the user IMSI, formatted according to 3GPP TS 23.003 [3], clause 2.2. | +| Supported Features
(See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| DSR Flags
(See 7.3.25) | DSR-Flags | M | This Information Element shall contain a bit mask. See 7.3.25 for the meaning of the bits. | + +**Table 5A.2.2.2.1/2: Delete VCSG Subscriber Data Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|-----------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Supported Features
(See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Result
(See 7.4) | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation.
The Result-Code AVP shall be used to indicate success / errors as defined in the Diameter base protocol (see IETF RFC 6733 [61]).
The Experimental-Result AVP shall be used for S7a/S7d errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP.
The following errors are applicable in this case:
- User Unknown | + +#### 5A.2.2.2.2 Detailed behaviour of the MME and the SGSN + +When receiving a Delete VCSG Subscriber Data request, the MME or SGSN shall check whether the IMSI is known. + +If it is not known, a result code of DIAMETER\_ERROR\_USER\_UNKNOWN shall be returned. + +If it is known, the MME or SGSN shall delete all the stored "CSG subscription data from CSS". + +If the deletion of the subscription data succeeds in the MME or SGSN, the Result-Code shall be set to DIAMETER\_SUCCESS. + +If the MME or SGSN cannot fulfil the received request for other reasons, e.g. due to a database error, it shall set the Result-Code to DIAMETER\_UNABLE\_TO\_COMPLY. + +#### 5A.2.2.2.3 Detailed behaviour of the CSS + +The CSS shall make use of this procedure to remove all the CSG subscription data associated to CSS from the MME or SGSN. + +NOTE: When a Delete VCSG Subscriber Data procedure occurs, the MME or SGSN remains registered in the CSS + +If the CSS receives a Delete VCSG Subscriber Data answer with the Result Code DIAMETER\_ERROR\_USER\_UNKNOWN from the MME or SGSN, the CSS shall clear the stored MME or SGSN identity. + +### 5A.2.3 Fault Recovery Procedures + +#### 5A.2.3.1 VCSG Reset + +##### 5A.2.3.1.1 General + +The VCSG Reset Procedure shall be used by the CSS, after a restart, to indicate to the MME and to the SGSN that a failure has occurred. + +This procedure is mapped to the commands Reset-Request/Answer (RSR/RSA) in the S7a/S7d Diameter application specified in chapter 7. + +Table 5A.2.3.1.1/1 specifies the involved information elements for the request. + +Table 5A.2.3.1.1/2 specifies the involved information elements for the answer. + +**Table 5A.2.3.1.1/1: VCSG Reset Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|-------------------------|------|-------------------------------------------------------------------------------------------------------| +| Supported Features
(See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | + +**Table 5A.2.3.1.1/2: VCSG Reset Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|-----------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result
(See 7.4) | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation.
The Result-Code AVP shall be used to indicate success / errors as defined in the Diameter base protocol (see IETF RFC 6733 [61]).
The Experimental-Result AVP shall be used for S7a/S7d errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP.
There are no Experimental-Result codes applicable for this command. | +| Supported Features
(See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | + +#### 5A.2.3.1.2 Detailed behaviour of the MME and the SGSN + +When receiving a VCSG Reset message, the MME or SGSN or combined MME/SGSN, for all roaming users for which they have a registration in CSS, shall mark "Location Information Confirmed in CSS" record as "Not Confirmed". The MME or SGSN or combined MME/SGSN shall make use of the CSS Identity received in the Origin-Host AVP (by comparing it with the value stored after successful ULA) in order to determine which user records are impacted. + +When, as described in 3GPP TS 23.007 [43], an event requiring the MME or SGSN to check the "CSG subscription data from CSS" occurs, and if the user record "Location Information Confirmed in CSS" is marked as "Not Confirmed", the restoration procedure shall be triggered. + +#### 5A.2.3.1.3 Detailed behaviour of the CSS + +The CSS shall make use of this procedure in order to indicate to all relevant MMEs, SGSNs, and combined MME/SGSNs that the CSS has restarted and may have lost the current MME-Identity and SGSN-Identity of some of its users who may be currently roaming in the MME area and/or SGSN area, and to which the CSS, therefore, cannot send e.g. Insert VCSG Subscriber Data messages when needed. + +The CSS should invoke this procedure towards a combined MME/SGSN only for a single time even if some of the impacted subscribers are attached to the combined MME/SGSN via UTRAN/GERAN and some of the impacted subscribers are attached to the combined MME/SGSN via E-UTRAN. + +## 6 MME – EIR (S13) and SGSN – EIR (S13') + +### 6.1 Introduction + +The S13 interface shall enable the ME Identity check procedure between the MME and the EIR as described in the 3GPP TS 23.401 [2]. + +The S13' interface shall enable the ME Identity check procedure between the SGSN and the EIR as described in the 3GPP TS 23.060 [12]. + +### 6.2 ME Identity Check Procedures + +#### 6.2.1 ME Identity Check + +##### 6.2.1.1 General + +This Mobile Equipment Identity Check Procedure shall be used between the MME and the EIR and between the SGSN and the EIR to check the Mobile Equipment's identity status (e.g. to check that it has not been stolen, or, to verify that it does not have faults). + +This procedure is mapped to the commands ME-Identity-Check-Request/Answer (ECR/ECA) in the Diameter application specified in chapter 6. + +Table 6.2.1.1/1 specifies the involved information elements for the request. + +Table 6.2.1.1/2 specifies the involved information elements for the answer. + +**Table 6.2.1.1/1: ME Identity Check Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|----------------------------------|------------------------------------|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Terminal Information (See 7.3.3) | Terminal-Information | M | This information element shall contain the information about the used mobile equipment i.e. the IMEI. Within this Information Element, only the IMEI and the Software-Version AVPs shall be used on the S13/S13' interface. | +| IMSI | User-Name (See IETF RFC 6733 [61]) | O | This information element shall contain the user IMSI, formatted according to 3GPP TS 23.003 [3], clause 2.2. | + +**Table 6.2.1.1/2: ME Identity Check Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|-------------------------------|-----------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result (See 7.4) | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation.
The Result-Code AVP shall be used to indicate success / errors as defined in the Diameter base protocol (see IETF RFC 6733 [61]).
The Experimental-Result AVP shall be used for S13/S13' errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP.
The following errors are applicable in this case:
- Unknown equipment | +| Equipment Status (See 7.3.51) | Equipment-Status | C | This information element shall contain the status of the requested mobile equipment as defined in 3GPP TS 22.016 [13].
It shall be present if the result of the ME Identity Check is DIAMETER_SUCCESS. | + +### 6.2.1.2 Detailed behaviour of the MME and the SGSN + +The MME or the SGSN shall make use of this procedure to check the ME identity, if the MME or the SGSN is configured to check the IMEI with the EIR. + +Terminal-Information, when sent by the MME/SGSN to the EIR, shall contain the IMEI AVP, and it may contain also the Software-Version AVP. + +IMSI may be sent together with Terminal Information to the EIR for operator-determined purposes. + +When receiving the ME Identity Check answer from the EIR, the MME or the SGSN shall check the result code and the equipment status. Dependent upon the result, the MME or the SGSN will decide its subsequent actions (e.g. sending an Attach Reject if the EIR indicates that the Mobile Equipment is unknown or blacklisted). + +### 6.2.1.3 Detailed behaviour of the EIR + +When receiving an ME Identity Check request, the EIR shall check whether the mobile equipment is known. + +The EIR shall identify the mobile equipment based on the first 14 digits of the IMEI AVP; if a 15th digit is received in the IMEI AVP, this digit shall be ignored by the EIR. + +Based on operator policies, the EIR may also use the Software-Version AVP, in addition to the first 14 digits of the IMEI AVP, to check the equipment identity against Black and Grey lists (see 3GPP TS 22.016 [13]). + +If the mobile equipment identity is not known, a result code of DIAMETER\_ERROR\_EQUIPMENT\_UNKNOWN is returned. + +If it is known, the EIR shall return DIAMETER\_SUCCESS with the equipment status. + +## 7 Protocol Specification and Implementation + +### 7.1 Introduction + +#### 7.1.1 Use of Diameter base protocol + +The Diameter base protocol as specified in IETF RFC 6733 [61] shall apply except as modified by the defined support of the methods and the defined support of the commands and AVPs, result and error codes as specified in this specification. Unless otherwise specified, the procedures (including error handling and unrecognised information handling) shall be used unmodified. + +#### 7.1.2 Securing Diameter Messages + +For secure transport of Diameter messages, see 3GPP TS 33.210 [16]. + +If there are no intermediate Diameter Agent networks located between the visited PLMN and the home PLMN, the HSS or the first Diameter Agent located in the home PLMN which has direct connection with the serving network is required to check that the realm contained in the Origin-Realm AVP in the request from the serving network corresponds to the right serving network. + +If there are intermediate Diameter Agent networks located between the visited PLMN and home PLMN, the first Diameter Agent which has direct connection with the serving network is required to check that the realm contained in the Origin-Realm AVP in the request from the serving network corresponds to the right serving network. + +NOTE 1: How to do the above check is implementation specific, e.g. it may be done by checking if the IP addresses of the serving network nodes match with the realm received in the Origin-Realm AVP in the request. + +NOTE 2: Network configurations where a (potential) visited PLMN acts as intermediate Diameter Agent network are not allowed. + +NOTE 3: In the case there are intermediate Diameter Agent networks, the home network has to trust these intermediate Diameter agent networks to do the check and other hop by hop security check. This trust is usually substantiated by contracts since there are no remote technical means to verify if the checks were actually performed. + +#### 7.1.3 Accounting functionality + +Accounting functionality (Accounting Session State Machine, related command codes and AVPs) shall not be used on the S6a, S6d, S13 and S13' interfaces. + +#### 7.1.4 Use of sessions + +Between the MME and the HSS and between the SGSN and the HSS and between the MME and the EIR, Diameter sessions shall be implicitly terminated. An implicitly terminated session is one for which the server does not maintain state information. The client shall not send any re-authorization or session termination requests to the server. + +The Diameter base protocol specified in IETF RFC 6733 [61] includes the Auth-Session-State AVP as the mechanism for the implementation of implicitly terminated sessions. + +The client (server) shall include in its requests (responses) the Auth-Session-State AVP set to the value NO\_STATE\_MAINTAINED (1), as described in IETF RFC 6733 [61]. As a consequence, the server shall not maintain any state information about this session and the client shall not send any session termination request. Neither the Authorization-Lifetime AVP nor the Session-Timeout AVP shall be present in requests or responses. + +#### 7.1.5 Transport protocol + +Diameter messages over the S6a, S6d, S13, S13', S7a and S7d interfaces shall make use of SCTP IETF RFC 4960 [14]. + +## 7.1.6 Routing considerations + +This clause specifies the use of the Diameter routing AVPs Destination-Realm and Destination-Host. + +If an MME or SGSN knows the address/name of the HSS for a certain user, and the associated home network domain name, both the Destination-Realm and Destination-Host AVPs shall be present in the request. + +NOTE: When sending a ULR command for a certain user due to HSS restoration procedure (i.e, after the MME/SGSN have received a Reset command from the HSS), the MME or the SGSN might consider the stored address/name of the HSS for the user to be invalid and hence not known. + +If an MME or SGSN knows only the home network domain name for a certain user, the Destination-Realm AVP shall be present and the command shall be routed to the next Diameter node. + +If an MME or SGSN knows only the identity of the user, the home network domain name shall be derived from the user's IMSI (MNC and MCC values) to construct the EPC Home Network Realm/Domain, as indicated in 3GPP TS 23.003 [3], clause 19.2, and use it as Destination-Realm. + +Consequently, the Destination-Host AVP is declared as optional in the ABNF for all requests initiated by an MME or SGSN. + +The address/name of the EIR shall be locally configured in the MME. + +Requests initiated by the HSS towards an MME or SGSN shall include both Destination-Host and Destination-Realm AVPs. + +The HSS obtains the Destination-Host AVP to use in requests towards an MME or SGSN, from the Origin-Host AVP received in previous requests from the MME or SGSN. Consequently, the Destination-Host AVP is declared as mandatory in the ABNF for all requests initiated by the HSS. The Origin-Host AVP received in requests from the MME may contain a Diameter identity of the MME encoded as specified in clause 19.4.2.4 of 3GPP TS 23.003 [3]. The Origin-Host AVP received in requests from the SGSN may contain a Diameter identity of the SGSN encoded as specified in clause 19.4.2.6 of 3GPP TS 23.003 [3]. + +The HSS obtains the Destination-Realm AVP to use in requests towards an MME or SGSN, from the Origin-Realm AVP received in previous requests from the MME or SGSN. The Origin-Realm AVP in the requests received by the HSS in roaming cases, should contain the domain name of the network to which the MME or the SGSN belongs, encoded as specified in clause 19.2 of 3GPP TS 23.003 [3]. + +The Destination-Realm AVP is declared as mandatory in the ABNF for all requests. + +If the Vendor-Specific-Application-ID AVP is received in any of the commands defined in this specification, it shall be ignored by the receiving node, and it shall not be used for routing purposes. + +## 7.1.7 Advertising Application Support + +The HSS, MME, SGSN and EIR shall advertise support of the Diameter S6a/S6d and/or S13/S13' Application by including the value of the application identifier in the Auth-Application-Id AVP within the Vendor-Specific-Application-Id grouped AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands. + +The vendor identifier value of 3GPP (10415) shall be included in the Supported-Vendor-Id AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands, and in the Vendor-Id AVP within the Vendor-Specific-Application-Id grouped AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands. + +The Vendor-Id AVP included in Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands that is not included in the Vendor-Specific-Application-Id AVPs as described above shall indicate the manufacturer of the Diameter node as per IETF RFC 6733 [61]. + +## 7.1.8 Diameter Application Identifier + +This clause specifies three Diameter applications: The S6a/S6d interface application, the S13/S13' interface application, and the S7a/S7d interface application. + +The S6a/S6d interface application allows a Diameter server and a Diameter client: + +- to exchange location information; +- to authorize a user to access the EPS; +- to exchange authentication information; +- to download and handle changes in the subscriber data stored in the server. + +The S6a/S6d interface protocol shall be defined as an IETF vendor specific Diameter application, where the vendor is 3GPP. The vendor identifier assigned by IANA to 3GPP () is 10415. + +The Diameter application identifier assigned to the S6a/S6d interface application is 16777251 (allocated by IANA). + +The S13/S13' interface application allows a Diameter server and a Diameter client: + +- to check the validity of the ME Identity. + +The S13/S13' interface protocol shall be defined as an IETF vendor specific Diameter application, where the vendor is 3GPP. The vendor identifier assigned by IANA to 3GPP () is 10415. + +The Diameter application identifier assigned to the S13/S13' interface application is 16777252 (allocated by IANA). + +The S7a/S7d interface application allows a Diameter server and a Diameter client: + +- to authorize a user to access CSGs identified in the CSS while roaming; +- to download and handle changes in CSG subscriber data stored in the CSS. + +The S7a/S7d interface protocol shall be defined as an IETF vendor specific Diameter application, where the vendor is 3GPP. The vendor identifier assigned by IANA to 3GPP () is 10415. + +The Diameter application identifier assigned to the S7a/S7d interface application is 16777308 (allocated by IANA). + +## 7.1.9 Use of the Supported-Features AVP + +When new functionality is introduced on the S6a/S6d interfaces, it should be defined as optional. If backwards incompatible changes can not be avoided, the new functionality shall be introduced as a new feature and support advertised with the Supported-Features AVP. The usage of the Supported-Features AVP on the S6a/S6d interfaces is consistent with the procedures for the dynamic discovery of supported features as defined in clause 7.2 of 3GPP TS 29.229 [9]. + +When extending the application by adding new AVPs for a feature, the new AVPs shall have the M bit cleared and the AVP shall not be defined mandatory in the command ABNF. + +As defined in 3GPP TS 29.229 [9], the Supported-Features AVP is of type grouped and contains the Vendor-Id, Feature-List-ID and Feature-List AVPs. On the all reference points as specified in this specification, the Supported-Features AVP is used to identify features that have been defined by 3GPP and hence, for features defined in this document, the Vendor-Id AVP shall contain the vendor ID of 3GPP (10415). If there are multiple feature lists defined for the reference point, the Feature-List-ID AVP shall differentiate those lists from one another. + +The Table 7.3.10/1 defines the features applicable to the S6a/S6d interfaces for the feature list with a Feature-List-ID of 1. The Table 7.3.10/2 defines the features applicable to the S6a/S6d interfaces for the feature list with a Feature-List-ID of 2. + +NOTE 1: If the support of a feature by the receiver is required in order for the receiver to be able to correctly process the request command, then the feature is included in the Supported-Features AVP and the M-bit of the Supported-Features AVP has to be set in the request command, according to 3GPP TS 29.229 [9] clause 7.2.1. + +NOTE 2: Currently none of the features that can be included in the Supported-Features AVP of the ULR command requires that the HSS supports them to successfully process the ULR command. For this reason the MME or SGSN does not need to set the M-bit of the Supported-Features AVP in the ULR command. This corresponds to the exception to the general rule requiring the setting of the M-bit of the Supported-Features AVP in a request described in 3GPP TS 29.229 [9] clause 7.2.1. Setting the M-bit of the Supported-Features AVP in the ULR command will mean that, if any of the features is not supported, the HSS will reject the ULR command as according to 3GPP TS 29.229 [9] clause 7.2.1. + +## 7.2 Commands + +### 7.2.1 Introduction + +This clause defines the Command code values and related ABNF for each command described in this specification. + +### 7.2.2 Command-Code values + +This clause defines Command-Code values for the S6a/S6d interface application and S13/S13' interface application as allocated by IANA in the IETF RFC 5516 [32]. + +Every command is defined by means of the ABNF syntax IETF RFC 2234 [7], according to the Command Code Format (CCF) specification defined in IETF RFC 6733 [61]. In the case, the definition and use of an AVP is not specified in this document, the guidelines in IETF RFC 6733 [61] shall apply. + +The Vendor-Specific-Application-Id AVP shall not be included in any command sent by Diameter nodes supporting applications defined in this specification. If the Vendor-Specific-Application-Id AVP is received in any of the commands defined in this specification, it shall be ignored by the receiving node. + +NOTE: The Vendor-Specific-Application-Id is included as an optional AVP in all Command Code Format specifications defined in this specification in order to overcome potential interoperability issues with intermediate Diameter agents non-compliant with the IETF RFC 6733 [61]. + +The following Command Codes are defined in this specification: + +**Table 7.2.2/1: Command-Code values for S6a/S6d** + +| Command-Name | Abbreviation | Code | Clause | +|------------------------------------|--------------|------|--------| +| Update-Location-Request | ULR | 316 | 7.2.3 | +| Update-Location-Answer | ULA | 316 | 7.2.4 | +| Cancel-Location-Request | CLR | 317 | 7.2.7 | +| Cancel-Location-Answer | CLA | 317 | 7.2.8 | +| Authentication-Information-Request | AIR | 318 | 7.2.5 | +| Authentication-Information-Answer | AIA | 318 | 7.2.6 | +| Insert-Subscriber-Data-Request | IDR | 319 | 7.2.9 | +| Insert-Subscriber-Data-Answer | IDA | 319 | 7.2.10 | +| Delete-Subscriber-Data-Request | DSR | 320 | 7.2.11 | +| Delete-Subscriber-Data-Answer | DSA | 320 | 7.2.12 | +| Purge-UE-Request | PUR | 321 | 7.2.13 | +| Purge-UE-Answer | PUA | 321 | 7.2.14 | +| Reset-Request | RSR | 322 | 7.2.15 | +| Reset-Answer | RSA | 322 | 7.2.16 | +| Notify-Request | NOR | 323 | 7.2.17 | +| Notify-Answer | NOA | 323 | 7.2.18 | + +For these commands, the Application-ID field shall be set to 16777251 (application identifier of the S6a/S6d interface application, allocated by IANA). + +**Table 7.2.2/2: Command-Code values for S13/S13'** + +| Command-Name | Abbreviation | Code | Clause | +|---------------------------|--------------|------|--------| +| ME-Identity-Check-Request | ECR | 324 | 7.2.19 | +| ME-Identity-Check-Answer | ECA | 324 | 7.2.20 | + +For these commands, the Application-ID field shall be set to 16777252 (application identifier of the S13/S13' interface application, allocated by IANA). + +**Table 7.2.2/3: Command-Code values for S7a/S7d** + +| Command-Name | Abbreviation | Code | Clause | +|----------------------------------|--------------|---------|--------| +| Update-VCSG-Location-Request | UVR | 8388638 | 7.2.21 | +| Update-VCSG-Location-Answer | UVA | 8388638 | 7.2.22 | +| Insert-Subscription-Data-Request | IDR | 319 | 7.2.9 | +| Insert-Subscription-Data-Answer | IDA | 319 | 7.2.10 | +| Delete-Subscriber-Data-Request | DSR | 320 | 7.2.11 | +| Delete-Subscriber-Data-Answer | DSA | 320 | 7.2.12 | +| Reset-Request | RSR | 322 | 7.2.15 | +| Reset-Answer | RSA | 322 | 7.2.16 | +| Cancel-VCSG-Location-Request | CVR | 8388642 | 7.2.23 | +| Cancel-VCSG-Location-Answer | CVA | 8388642 | 7.2.24 | + +For these commands, the Application-ID field shall be set to 16777308 (application identifier of the S7a/S7d interface application, allocated by IANA). + +## 7.2.3 Update-Location-Request (ULR) Command + +The Update-Location-Request (ULR) command, indicated by the Command-Code field set to 316 and the "R" bit set in the Command Flags field, is sent from MME or SGSN to HSS. + +Message Format + +``` +< Update-Location-Request > ::= < Diameter Header: 316, REQ, PXY, 16777251 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ Destination-Host ] + { Destination-Realm } + { User-Name } + [ OC-Supported-Features ] + *[ Supported-Features ] + [ Terminal-Information ] + { RAT-Type } + { ULR-Flags } + [ UE-SRVCC-Capability ] + { Visited-PLMN-Id } + [ SGSN-Number ] + [ Homogeneous-Support-of-IMS-Voice-Over-PS-Sessions ] + [ GMLC-Address ] + *[ Active-APN ] + [ Equivalent-PLMN-List ] + [ MME-Number-for-MT-SMS ] + [ SMS-Register-Request ] + [ SGs-MME-Identity ] + [ Coupled-Node-Diameter-ID ] + [ Adjacent-PLMNs ] +``` + +``` + +[ Supported-Services ] +*[ AVP ] +*[ Proxy-Info ] +*[ Route-Record ] + +``` + +## 7.2.4 Update-Location-Answer (ULA) Command + +The Update-Location-Answer (ULA) command, indicated by the Command-Code field set to 316 and the 'R' bit cleared in the Command Flags field, is sent from HSS to MME or SGSN. + +Message Format + +``` + +< Update-Location-Answer > ::= < Diameter Header: 316, PXY, 16777251 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + [ Result-Code ] + [ Experimental-Result ] + [ Error-Diagnostic ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ OC-Supported-Features ] + [ OC-OLR ] + *[ Load ] + *[ Supported-Features ] + [ ULA-Flags ] + [ Subscription-Data ] + *[ Reset-ID ] + *[ AVP ] + [ Failed-AVP ] + *[ Proxy-Info ] + *[ Route-Record ] + +``` + +## 7.2.5 Authentication-Information-Request (AIR) Command + +The Authentication-Information-Request (AIR) command, indicated by the Command-Code field set to 318 and the 'R' bit set in the Command Flags field, is sent from MME or SGSN to HSS. + +Message Format + +``` + +< Authentication-Information-Request > ::= < Diameter Header: 318, REQ, PXY, 16777251 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ Destination-Host ] + { Destination-Realm } + { User-Name } + [ OC-Supported-Features ] + *[Supported-Features] + [ Requested-EUTRAN-Authentication-Info ] + [ Requested-UTRAN-GERAN-Authentication-Info ] + { Visited-PLMN-Id } + [ AIR-Flags ] + *[ AVP ] + *[ Proxy-Info ] + *[ Route-Record ] + +``` + +## 7.2.6 Authentication-Information-Answer (AIA) Command + +The Authentication-Information-Answer (AIA) command, indicated by the Command-Code field set to 318 and the 'R' bit cleared in the Command Flags field, is sent from HSS to MME or SGSN. + +### Message Format + +``` +< Authentication-Information-Answer > ::= < Diameter Header: 318, PXY, 16777251 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + [ Result-Code ] + [ Experimental-Result ] + [ Error-Diagnostic ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ OC-Supported-Features ] + [ OC-OLR ] + *[ Load ] + *[Supported-Features] + [ Authentication-Info ] + [ UE-Usage-Type ] + *[ AVP ] + [ Failed-AVP ] + *[ Proxy-Info ] + *[ Route-Record ] +``` + +## 7.2.7 Cancel-Location-Request (CLR) Command + +The Cancel-Location-Request (CLR) command, indicated by the Command-Code field set to 317 and the 'R' bit set in the Command Flags field, is sent from HSS to MME or SGSN. + +### Message Format + +``` +< Cancel-Location-Request > ::= < Diameter Header: 317, REQ, PXY, 16777251 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + { Destination-Host } + { Destination-Realm } + { User-Name } + *[Supported-Features ] + { Cancellation-Type } + [ CLR-Flags ] + *[ AVP ] + *[ Proxy-Info ] + *[ Route-Record ] +``` + +## 7.2.8 Cancel-Location-Answer (CLA) Command + +The Cancel-Location-Answer (CLA) command, indicated by the Command-Code field set to 317 and the 'R' bit cleared in the Command Flags field, is sent from MME or SGSN to HSS. + +### Message Format + +``` +< Cancel-Location-Answer > ::= < Diameter Header: 317, PXY, 16777251 > + < Session-Id > +``` + +``` + +[ DRMP ] +[ Vendor-Specific-Application-Id ] +*[ Supported-Features ] +[ Result-Code ] +[ Experimental-Result ] +{ Auth-Session-State } +{ Origin-Host } +{ Origin-Realm } +*[ AVP ] +[ Failed-AVP ] +*[ Proxy-Info ] +*[ Route-Record ] + +``` + +## 7.2.9 Insert-Subscriber-Data-Request (IDR) Command + +The Insert-Subscriber-Data-Request (IDR) command, indicated by the Command-Code field set to 319 and the 'R' bit set in the Command Flags field, is sent from HSS or CSS to MME or SGSN. + +Message Format when used over the S6a or S6d application: + +``` + +< Insert-Subscriber-Data-Request > ::= < Diameter Header: 319, REQ, PXY, 16777251 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + { Destination-Host } + { Destination-Realm } + { User-Name } + *[ Supported-Features ] + { Subscription-Data } + [ IDR- Flags ] + *[ Reset-ID ] + *[ AVP ] + *[ Proxy-Info ] + *[ Route-Record ] + +``` + +Message Format when used over the S7a or S7d application: + +``` + +< Insert-Subscriber-Data-Request > ::= < Diameter Header: 319, REQ, PXY, 16777308 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + { Destination-Host } + { Destination-Realm } + { User-Name } + *[ Supported-Features ] + *{ VPLMN-CSG-Subscription-Data } + *[ Reset-ID ] + *[ AVP ] + *[ Proxy-Info ] + *[ Route-Record ] + +``` + +## 7.2.10 Insert-Subscriber-Data-Answer (IDA) Command + +The Insert-Subscriber-Data-Answer (IDA) command, indicated by the Command-Code field set to 319 and the 'R' bit cleared in the Command Flags field, is sent from MME or SGSN to HSS or CSS. + +Message Format when used over the S6a or S6d application: + +``` +< Insert-Subscriber-Data-Answer > ::= < Diameter Header: 319, PXY, 16777251 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + *[ Supported-Features ] + [ Result-Code ] + [ Experimental-Result ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ IMS-Voice-Over-PS-Sessions-Supported ] + [ Last-UE-Activity-Time ] + [ RAT-Type ] + [ IDA-Flags ] + [ EPS-User-State ] + [ EPS-Location-Information ] + [ Local-Time-Zone ] + [ Supported-Services ] + *[ Monitoring-Event-Report ] + *[ Monitoring-Event-Config-Status ] + *[ AVP ] + [ Failed-AVP ] + *[ Proxy-Info ] + *[ Route-Record ] +``` + +Message Format when used over the S7a or S7d application: + +``` +< Insert-Subscriber-Data-Answer > ::= < Diameter Header: 319, PXY, 16777308 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + *[ Supported-Features ] + [ Result-Code ] + [ Experimental-Result ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + *[ AVP ] + [ Failed-AVP ] + *[ Proxy-Info ] + *[ Route-Record ] +``` + +## 7.2.11 Delete-Subscriber-Data-Request (DSR) Command + +The Delete-Subscriber Data-Request (DSR) command, indicated by the Command-Code field set to 320 and the 'R' bit set in the Command Flags field, is sent from HSS or CSS to MME or SGSN. + +Message Format when used over the S6a/S6d application: + +``` +< Delete-Subscriber-Data-Request > ::= < Diameter Header: 320, REQ, PXY, 16777251 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + { Destination-Host } + { Destination-Realm } + { User-Name } + *[ Supported-Features ] + { DSR-Flags } +``` + +``` + +[ SCEF-ID ] +*[ Context-Identifier ] +[ Trace-Reference ] +*[ TS-Code ] +*[ SS-Code ] +[ eDRX-Related-RAT ] +*[ External-Identifier ] +*[ AVP ] +*[ Proxy-Info ] +*[ Route-Record ] + +``` + +The SCEF-ID shall be present when the flag "Delete monitoring events" in DSR-Flags AVP is set. + +Message Format when used over the S7a/S7d application: + +``` + +< Delete-Subscriber-Data-Request > ::= < Diameter Header: 320, REQ, PXY, 16777308 > +< Session-Id > +[ DRMP ] +[ Vendor-Specific-Application-Id ] +{ Auth-Session-State } +{ Origin-Host } +{ Origin-Realm } +{ Destination-Host } +{ Destination-Realm } +{ User-Name } +*[ Supported-Features ] +{ DSR-Flags } +*[ AVP ] +*[ Proxy-Info ] +*[ Route-Record ] + +``` + +## 7.2.12 Delete-Subscriber-Data-Answer (DSA) Command + +The Delete-Subscriber Data-Answer (DSA) command, indicated by the Command-Code field set to 320 and the 'R' bit cleared in the Command Flags field, is sent from MME or SGSN to HSS or CSS. + +Message Format when used over the S6a/S6d application: + +``` + +< Delete-Subscriber-Data-Answer > ::= < Diameter Header: 320, PXY, 16777251 > +< Session-Id > +[ DRMP ] +[ Vendor-Specific-Application-Id ] +*[ Supported-Features ] +[ Result-Code ] +[ Experimental-Result ] +{ Auth-Session-State } +{ Origin-Host } +{ Origin-Realm } +[ DSA-Flags ] +*[ AVP ] +[ Failed-AVP ] +*[ Proxy-Info ] +*[ Route-Record ] + +``` + +Message Format when used over the S7a /S7d application: + +``` + +< Delete-Subscriber-Data-Answer > ::= < Diameter Header: 320, PXY, 16777308 > +< Session-Id > +[ DRMP ] +[ Vendor-Specific-Application-Id ] +*[ Supported-Features ] + +``` + +``` + +[ Result-Code ] +[ Experimental-Result ] +{ Auth-Session-State } +{ Origin-Host } +{ Origin-Realm } +*[ AVP ] +[ Failed-AVP ] +*[ Proxy-Info ] +*[ Route-Record ] + +``` + +## 7.2.13 Purge-UE-Request (PUR) Command + +The Purge-UE-Request (PUR) command, indicated by the Command-Code field set to 321 and the 'R' bit set in the Command Flags field, is sent from MME or SGSN to HSS. + +Message Format + +``` + +< Purge-UE-Request > ::= < Diameter Header: 321, REQ, PXY, 16777251 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ Destination-Host ] + { Destination-Realm } + { User-Name } + [ OC-Supported-Features ] + [ PUR-Flags ] + *[ Supported-Features ] + [ EPS-Location-Information ] + *[ AVP ] + *[ Proxy-Info ] + *[ Route-Record ] + +``` + +## 7.2.14 Purge-UE-Answer (PUA) Command + +The Purge-UE-Answer (PUA) command, indicated by the Command-Code field set to 321 and the 'R' bit cleared in the Command Flags field, is sent from HSS to MME or SGSN. + +Message Format + +``` + +< Purge-UE-Answer > ::= < Diameter Header: 321, PXY, 16777251 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + *[ Supported-Features ] + [ Result-Code ] + [ Experimental-Result ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ OC-Supported-Features ] + [ OC-OLR ] + *[ Load ] + [ PUA-Flags ] + *[ AVP ] + [ Failed-AVP ] + *[ Proxy-Info ] + *[ Route-Record ] + +``` + +## 7.2.15 Reset-Request (RSR) Command + +The Reset-Request (RSR) command, indicated by the Command-Code field set to 322 and the 'R' bit set in the Command Flags field, is sent from HSS or CSS to MME or SGSN. + +Message Format when used over the S6a/S6d application: + +``` +< Reset-Request > ::= < Diameter Header: 322, REQ, PXY, 16777251 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + { Destination-Host } + { Destination-Realm } + *[ Supported-Features ] + *[ User-Id ] + *[ Reset-ID ] + [ Subscription-Data ] + [ Subscription-Data-Deletion ] + *[ AVP ] + *[ Proxy-Info ] + *[ Route-Record ] +``` + +Message Format when used over the S7a /S7d application: + +``` +< Reset-Request > ::= < Diameter Header: 322, REQ, PXY, 16777308 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + { Destination-Host } + { Destination-Realm } + *[ Supported-Features ] + *[ Reset-ID ] + *[ AVP ] + *[ Proxy-Info ] + *[ Route-Record ] +``` + +## 7.2.16 Reset-Answer (RSA) Command + +The Reset-Answer (RSA) command, indicated by the Command-Code field set to 322 and the 'R' bit cleared in the Command Flags field, is sent from MME or SGSN to HSS or CSS. + +Message Format when used over the S6a/S6d application: + +``` +< Reset-Answer > ::= < Diameter Header: 322, PXY, 16777251 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + *[ Supported-Features ] + [ Result-Code ] + [ Experimental-Result ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + *[ AVP ] + [ Failed-AVP ] + *[ Proxy-Info ] +``` + +\*[ Route-Record ] + +Message Format when used over the S7a /S7d application: + +``` +< Reset-Answer> ::= < Diameter Header: 322, PXY, 16777308 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + *[ Supported-Features ] + [ Result-Code ] + [ Experimental-Result ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + *[ AVP ] + [ Failed-AVP ] + *[ Proxy-Info ] + *[ Route-Record ] +``` + +## 7.2.17 Notify-Request (NOR) Command + +The Notify-Request (NOR) command, indicated by the Command-Code field set to 323 and the 'R' bit set in the Command Flags field, is sent from MME or SGSN to HSS. + +Message Format + +``` +< Notify-Request> ::= < Diameter Header: 323, REQ, PXY, 16777251 > + < Session-Id > + [ Vendor-Specific-Application-Id ] + [ DRMP ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ Destination-Host ] + { Destination-Realm } + { User-Name } + [ OC-Supported-Features ] + *[ Supported-Features ] + [ Terminal-Information ] + [ MIP6-Agent-Info ] + [ Visited-Network-Identifier ] + [ Context-Identifier ] + [Service-Selection] + [ Alert-Reason ] + [ UE-SRVCC-Capability ] + [ NOR-Flags ] + [ Homogeneous-Support-of-IMS-Voice-Over-PS-Sessions ] + [ Maximum-UE-Availability-Time ] + *[ Monitoring-Event-Config-Status ] + [ Emergency-Services ] + *[ AVP ] + *[ Proxy-Info ] + *[ Route-Record ] +``` + +## 7.2.18 Notify-Answer (NOA) Command + +The Notify-Answer (NOA) command, indicated by the Command-Code field set to 323 and the 'R' bit cleared in the Command Flags field, is sent from HSS to MME or SGSN. + +Message Format + +``` + +< Notify-Answer> ::= < Diameter Header: 323, PXY, 16777251 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + [ Result-Code ] + [ Experimental-Result ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ OC-Supported-Features ] + [ OC-OLR ] + *[ Load ] + *[ Supported-Features ] + *[ AVP ] + [ Failed-AVP ] + *[ Proxy-Info ] + *[ Route-Record ] + +``` + +## 7.2.19 ME-Identity-Check-Request (ECR) Command + +The ME-Identity-Check-Request (ECR) command, indicated by the Command-Code field set to 324 and the 'R' bit set in the Command Flags field, is sent from MME or SGSN to EIR. + +### Message Format + +``` + +< ME-Identity-Check-Request> ::= < Diameter Header: 324, REQ, PXY, 16777252 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ Destination-Host ] + { Destination-Realm } + { Terminal-Information } + [ User-Name ] + *[ AVP ] + *[ Proxy-Info ] + *[ Route-Record ] + +``` + +## 7.2.20 ME-Identity-Check-Answer (ECA) Command + +The ME-Identity-Check-Answer (ECA) command, indicated by the Command-Code field set to 324 and the 'R' bit cleared in the Command Flags field, is sent from EIR to MME or SGSN. + +### Message Format + +``` + +< ME-Identity-Check-Answer> ::= < Diameter Header: 324, PXY, 16777252 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + [ Result-Code ] + [ Experimental-Result ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ Equipment-Status ] + *[ AVP ] + [ Failed-AVP ] + *[ Proxy-Info ] + *[ Route-Record ] + +``` + +## 7.2.21 Update-VCSG-Location-Request (UVR) Command + +The Update-VCSG-Location-Request (UVR) command, indicated by the Command-Code field set to 8388638 and the "R" bit set in the Command Flags field, is sent from MME or SGSN to CSS. + +### Message Format + +``` +< Update-VCSG-Location-Request > ::= < Diameter Header: 8388638, REQ, PXY, > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ Destination-Host ] + { Destination-Realm } + { User-Name } + [ MSISDN ] + [ SGSN-Number ] + *[ Supported-Features ] + { UVR-Flags } + *[ AVP ] + *[ Proxy-Info ] + *[ Route-Record ] +``` + +## 7.2.22 Update-VCSG-Location-Answer (UVA) Command + +The Update-VCSG-Location-Answer (UVA) command, indicated by the Command-Code field set to 8388638 and the 'R' bit cleared in the Command Flags field, is sent from CSS to MME or SGSN. + +### Message Format + +``` +< Update-VCSG-Location-Answer > ::= < Diameter Header: 8388638, PXY, > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + [ Result-Code ] + [ Experimental-Result ] + [ Error-Diagnostic ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + *[ Supported-Features ] + *[ VPLMN-CSG-Subscription-Data ] + [ UVA-Flags ] + *[ AVP ] + [ Failed-AVP ] + *[ Proxy-Info ] + *[ Route-Record ] +``` + +## 7.2.23 Cancel-VCSG-Location-Request (CVR) Command + +The Cancel-VCSG-Location-Request (CVR) command, indicated by the Command-Code field set to 8388642 and the 'R' bit set in the Command Flags field, is sent from CSS to MME or SGSN. + +### Message Format + +``` +< Cancel-VCSG-Location-Request > ::= < Diameter Header: 8388642, REQ, PXY, > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + { Auth-Session-State } +``` + +``` +{ Origin-Host } +{ Origin-Realm } +{ Destination-Host } +{ Destination-Realm } +{ User-Name } +*[Supported-Features ] +{ Cancellation-Type } +*[ AVP ] +*[ Proxy-Info ] +*[ Route-Record ] +``` + +## 7.2.24 Cancel-VCSG-Location-Answer (CVA) Command + +The Cancel-VCSG-Location-Answer (CVA) command, indicated by the Command-Code field set to 8388642 and the 'R' bit cleared in the Command Flags field, is sent from MME or SGSN to CSS. + +### Message Format + +``` +< Cancel-VCSG-Location-Answer > ::= < Diameter Header: 8388642, PXY, > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + *[ Supported-Features ] + [ Result-Code ] + [ Experimental-Result ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + *[ AVP ] + [ Failed-AVP ] + *[ Proxy-Info ] + *[ Route-Record ] +``` + +## 7.3 Information Elements + +### 7.3.1 General + +The following table specifies the Diameter AVPs defined for the S6a/S6d interface protocol, the S7a/S7d interface protocol and the S13/S13' interface protocol, their AVP Code values, types, possible flag values and whether or not the AVP may be encrypted. The Vendor-ID header of all AVPs defined in this specification shall be set to 3GPP (10415). + +For all AVPs which contain bit masks and are of the type Unsigned32, e.g., ULR-Flags, DSR-Flags, PUA-Flags, etc., bit 0 shall be the least significant bit. For example, to get the value of bit 0, a bit mask of 0x0001 should be used. + +**Table 7.3.1/1: S6a/S6d, S7a/S7d and S13/S13' specific DiameterAVPs** + +| Attribute Name | AVP Code | Clause defined | Value Type | AVP Flag rules | | | | | +|-----------------------------------------------|----------|----------------|-------------|----------------|-----|------------|----------|-----------| +| | | | | Must | May | Should not | Must not | May Encr. | +| Subscription-Data | 1400 | 7.3.2 | Grouped | M, V | | | | No | +| Terminal-Information | 1401 | 7.3.3 | Grouped | M, V | | | | No | +| IMEI | 1402 | 7.3.4 | UTF8String | M, V | | | | No | +| Software-Version | 1403 | 7.3.5 | UTF8String | M, V | | | | No | +| QoS-Subscribed | 1404 | 7.3.77 | OctetString | M, V | | | | No | +| ULR-Flags | 1405 | 7.3.7 | Unsigned32 | M, V | | | | No | +| ULA-Flags | 1406 | 7.3.8 | Unsigned32 | M, V | | | | No | +| Visited-PLMN-Id | 1407 | 7.3.9 | OctetString | M, V | | | | No | +| Requested-EUTRAN-Authentication-Info | 1408 | 7.3.11 | Grouped | M, V | | | | No | +| Requested-UTRAN-GERAN-Authentication-Info | 1409 | 7.3.12 | Grouped | M, V | | | | No | +| Number-Of-Requested-Vectors | 1410 | 7.3.14 | Unsigned32 | M, V | | | | No | +| Re-Synchronization-Info | 1411 | 7.3.15 | OctetString | M, V | | | | No | +| Immediate-Response-Preferred | 1412 | 7.3.16 | Unsigned32 | M, V | | | | No | +| Authentication-Info | 1413 | 7.3.17 | Grouped | M, V | | | | No | +| E-UTRAN-Vector | 1414 | 7.3.18 | Grouped | M, V | | | | No | +| UTRAN-Vector | 1415 | 7.3.19 | Grouped | M, V | | | | No | +| GERAN-Vector | 1416 | 7.3.20 | Grouped | M, V | | | | No | +| Network-Access-Mode | 1417 | 7.3.21 | Enumerated | M, V | | | | No | +| HPLMN-ODB | 1418 | 7.3.22 | Unsigned32 | M, V | | | | No | +| Item-Number | 1419 | 7.3.23 | Unsigned32 | M, V | | | | No | +| Cancellation-Type | 1420 | 7.3.24 | Enumerated | M, V | | | | No | +| DSR-Flags | 1421 | 7.3.25 | Unsigned32 | M, V | | | | No | +| DSA-Flags | 1422 | 7.3.26 | Unsigned32 | M, V | | | | No | +| Context-Identifier | 1423 | 7.3.27 | Unsigned32 | M, V | | | | No | +| Subscriber-Status | 1424 | 7.3.29 | Enumerated | M, V | | | | No | +| Operator-Determined-Barring | 1425 | 7.3.30 | Unsigned32 | M, V | | | | No | +| Access-Restriction-Data | 1426 | 7.3.31 | Unsigned32 | M, V | | | | No | +| APN-OI-Replacement | 1427 | 7.3.32 | UTF8String | M, V | | | | No | +| All-APN-Configurations-Included-Indicator | 1428 | 7.3.33 | Enumerated | M, V | | | | No | +| APN-Configuration-Profile | 1429 | 7.3.34 | Grouped | M, V | | | | No | +| APN-Configuration | 1430 | 7.3.35 | Grouped | M, V | | | | No | +| EPS-Subscribed-QoS-Profile | 1431 | 7.3.37 | Grouped | M, V | | | | No | +| VPLMN-Dynamic-Address-Allowed | 1432 | 7.3.38 | Enumerated | M, V | | | | No | +| STN-SR | 1433 | 7.3.39 | OctetString | M, V | | | | No | +| Alert-Reason | 1434 | 7.3.83 | Enumerate | M, V | | | | No | +| AMBR | 1435 | 7.3.41 | Grouped | M, V | | | | No | +| CSG-Subscription-Data | 1436 | 7.3.78 | Grouped | M, V | | | | No | +| CSG-Id | 1437 | 7.3.79 | Unsigned32 | M, V | | | | No | +| PDN-GW-Allocation-Type | 1438 | 7.3.44 | Enumerated | M, V | | | | No | +| Expiration-Date | 1439 | 7.3.80 | Time | M, V | | | | No | +| RAT-Frequency-Selection-Priority-ID | 1440 | 7.3.46 | Unsigned32 | M, V | | | | No | +| IDA-Flags | 1441 | 7.3.47 | Unsigned32 | M, V | | | | No | +| PUA-Flags | 1442 | 7.3.48 | Unsigned32 | M, V | | | | No | +| NOR-Flags | 1443 | 7.3.49 | Unsigned32 | M, V | | | | No | +| User-Id | 1444 | 7.3.50 | UTF8String | V | | | M | No | +| Equipment-Status | 1445 | 7.3.51 | Enumerated | M, V | | | | No | +| Regional-Subscription-Zone-Code | 1446 | 7.3.52 | OctetString | M, V | | | | No | +| RAND | 1447 | 7.3.53 | OctetString | M, V | | | | No | +| XRES | 1448 | 7.3.54 | OctetString | M, V | | | | No | +| AUTN | 1449 | 7.3.55 | OctetString | M, V | | | | No | +| KASME | 1450 | 7.3.56 | OctetString | M, V | | | | No | +| Trace-Collection-Entity | 1452 | 7.3.98 | Address | M, V | | | | No | +| Kc | 1453 | 7.3.59 | OctetString | M, V | | | | No | +| SRES | 1454 | 7.3.60 | OctetString | M, V | | | | No | +| PDN-Type | 1456 | 7.3.62 | Enumerated | M, V | | | | No | +| Roaming-Restricted-Due-To-Unsupported-Feature | 1457 | 7.3.81 | Enumerated | M, V | | | | No | + +| | | | | | | | | | +|---------------------------------------------------|------|---------|-------------|------|--|--|---|----| +| Trace-Data | 1458 | 7.3.63 | Grouped | M, V | | | | No | +| Trace-Reference | 1459 | 7.3.64 | OctetString | M, V | | | | No | +| Trace-Depth | 1462 | 7.3.67 | Enumerated | M, V | | | | No | +| Trace-NE-Type-List | 1463 | 7.3.68 | OctetString | M, V | | | | No | +| Trace-Interface-List | 1464 | 7.3.69 | OctetString | M, V | | | | No | +| Trace-Event-List | 1465 | 7.3.70 | OctetString | M, V | | | | No | +| OMC-Id | 1466 | 7.3.71 | OctetString | M, V | | | | No | +| GPRS-Subscription-Data | 1467 | 7.3.72 | Grouped | M, V | | | | No | +| Complete-Data-List-Included-Indicator | 1468 | 7.3.73 | Enumerated | M, V | | | | No | +| PDP-Context | 1469 | 7.3.74 | Grouped | M, V | | | | No | +| PDP-Type | 1470 | 7.3.75 | OctetString | M, V | | | | No | +| 3GPP2-MEID | 1471 | 7.3.6 | OctetString | M, V | | | | No | +| Specific-APN-Info | 1472 | 7.3.82 | Grouped | M, V | | | | No | +| LCS-Info | 1473 | 7.3.84 | Grouped | M, V | | | | No | +| GMLC-Number | 1474 | 7.3.85 | OctetString | M, V | | | | No | +| LCS-PrivacyException | 1475 | 7.3.86 | Grouped | M, V | | | | No | +| SS-Code | 1476 | 7.3.87 | OctetString | M, V | | | | No | +| SS-Status | 1477 | 7.3.88 | OctetString | M, V | | | | No | +| Notification-To-UE-User | 1478 | 7.3.89 | Enumerated | M, V | | | | No | +| External-Client | 1479 | 7.3.90 | Grouped | M, V | | | | No | +| Client-Identity | 1480 | 7.3.91 | OctetString | M, V | | | | No | +| GMLC-Restriction | 1481 | 7.3.92 | Enumerated | M, V | | | | No | +| PLMN-Client | 1482 | 7.3.93 | Enumerated | M, V | | | | No | +| Service-Type | 1483 | 7.3.94 | Grouped | M, V | | | | No | +| ServiceTypeIdentity | 1484 | 7.3.95 | Unsigned32 | M, V | | | | No | +| MO-LR | 1485 | 7.3.96 | Grouped | M, V | | | | No | +| Teleservice-List | 1486 | 7.3.99 | Grouped | M, V | | | | No | +| TS-Code | 1487 | 7.3.100 | OctetString | M, V | | | | No | +| Call-Barring-Info | 1488 | 7.3.101 | Grouped | M, V | | | | No | +| SGSN-Number | 1489 | 7.3.102 | OctetString | M, V | | | | No | +| IDR-Flags | 1490 | 7.3.103 | Unsigned32 | M, V | | | | No | +| ICS-Indicator | 1491 | 7.3.104 | Enumerated | V | | | M | No | +| IMS-Voice-Over-PS-Sessions-Supported | 1492 | 7.3.106 | Enumerated | V | | | M | No | +| Homogeneous-Support-of-IMS-Voice-Over-PS-Sessions | 1493 | 7.3.107 | Enumerated | V | | | M | No | +| Last-UE-Activity-Time | 1494 | 7.3.108 | Time | V | | | M | No | +| EPS-User-State | 149 | 7.3.110 | Grouped | V | | | M | No | +| EPS-Location-Information | 149 | 7.3.111 | Grouped | V | | | M | No | +| MME-User-State | 149 | 7.3.112 | Grouped | V | | | M | No | +| SGSN-User-State | 149 | 7.3.113 | Grouped | V | | | M | No | +| User-State | 149 | 7.3.114 | Enumerated | V | | | M | No | +| MME-Location Information | 160 | 7.3.115 | Grouped | V | | | M | No | +| SGSN-Location-Information | 160 | 7.3.116 | Grouped | V | | | M | No | + +| | | | | | | | | | +|-----------------------------------|------|---------|-------------|---|--|--|---|----| +| E-UTRAN-Cell-Global-Identity | 160 | 7.3.117 | OctetString | V | | | M | No | +| Tracking-Area-Identity | 160 | 7.3.118 | OctetString | V | | | M | No | +| Cell-Global-Identity | 160 | 7.3.119 | OctetString | V | | | M | No | +| Routing-Area-Identity | 160 | 7.3.120 | OctetString | V | | | M | No | +| Location-Area-Identity | 160 | 7.3.121 | OctetString | V | | | M | No | +| Service-Area-Identity | 160 | 7.3.122 | OctetString | V | | | M | No | +| Geographical-Information | 160 | 7.3.123 | OctetString | V | | | M | No | +| Geodetic-Information | 160 | 7.3.124 | OctetString | V | | | M | No | +| Current-Location-Retrieved | 161 | 7.3.125 | Enumerated | V | | | M | No | +| Age-Of-Location-Information | 161 | 7.3.126 | Unsigned32 | V | | | M | No | +| Active-APN | 161 | 7.3.127 | Grouped | V | | | M | No | +| Error-Diagnostic | 161 | 7.3.128 | Enumerated | V | | | M | No | +| Ext-PDP-Address | 1621 | 7.3.129 | Address | V | | | M | No | +| UE-SRVCC-Capability | 1615 | 7.3.130 | Enumerated | V | | | M | No | +| MPS-Priority | 1616 | 7.3.131 | Unsigned32 | V | | | M | No | +| VPLMN-LIPA-Allowed | 1617 | 7.3.132 | Enumerated | V | | | M | No | +| LIPA-Permission | 1618 | 7.3.133 | Enumerated | V | | | M | No | +| Subscribed-Periodic-RAU-TAU-Timer | 1619 | 7.3.134 | Unsigned32 | V | | | M | No | +| Ext-PDP-Type | 1620 | 7.3.75A | OctetString | V | | | M | No | +| SIPTO-Permission | 1613 | 7.3.135 | Enumerated | V | | | M | No | +| MDT-Configuration | 1622 | 7.3.136 | Grouped | V | | | M | No | +| Job-Type | 1623 | 7.3.137 | Enumerated | V | | | M | No | +| Area-Scope | 1624 | 7.3.138 | Grouped | V | | | M | No | +| List-Of-Measurements | 1625 | 7.3.139 | Unsigned32 | V | | | M | No | +| Reporting-Trigger | 1626 | 7.3.140 | Unsigned32 | V | | | M | No | +| Report-Interval | 1627 | 7.3.141 | Enumerated | V | | | M | No | +| Report-Amount | 1628 | 7.3.142 | Enumerated | V | | | M | No | +| Event-Threshold-RSRP | 1629 | 7.3.143 | Unsigned32 | V | | | M | No | +| Event-Threshold-RSRQ | 1630 | 7.3.144 | Unsigned32 | V | | | M | No | +| Logging-Interval | 1631 | 7.3.145 | Enumerated | V | | | M | No | + +| | | | | | | | | | +|-------------------------------------|------|---------|------------------|------|--|--|---|----| +| Logging-Duration | 1632 | 7.3.146 | Enumerated | V | | | M | No | +| Relay-Node-Indicator | 1633 | 7.3.147 | Enumerated | V | | | M | No | +| MDT-User-Consent | 1634 | 7.3.148 | Enumerated | V | | | M | No | +| PUR-Flags | 1635 | 7.3.149 | Unsigned32 | V | | | M | No | +| Subscribed-VSRVCC | 1636 | 7.3.150 | Enumerated | V | | | M | No | +| Equivalent-PLMN-List | 1637 | 7.3.151 | Grouped | V | | | M | No | +| CLR-Flags | 1638 | 7.3.152 | Unsigned32 | V | | | M | No | +| UVR-Flags | 1639 | 7.3.153 | Unsigned32 | M, V | | | | No | +| UVA-Flags | 1640 | 7.3.154 | Unsigned32 | M, V | | | | No | +| VPLMN-CSG-Subscription-Data | 1641 | 7.3.155 | Grouped | M, V | | | | No | +| Time-Zone | 1642 | 7.3.163 | UTF8String | V | | | M | No | +| A-MSISDN | 1643 | 7.3.157 | OctetString | V | | | M | No | +| MME-Number-for-MT-SMS | 1645 | 7.3.159 | OctetString | V | | | M | No | +| SMS-Register-Request | 1648 | 7.3.162 | Enumerated | V | | | M | No | +| Local-Time-Zone | 1649 | 7.3.156 | Grouped | V | | | M | No | +| Daylight-Saving-Time | 1650 | 7.3.164 | Enumerated | V | | | M | No | +| Subscription-Data-Flags | 1654 | 7.3.165 | Unsigned32 | V | | | M | No | +| Measurement-Period-LTE | 1655 | 7.3.166 | Enumerated | V | | | M | No | +| Measurement-Period-UMTS | 1656 | 7.3.167 | Enumerated | V | | | M | No | +| Collection-Period-RRM-LTE | 1657 | 7.3.168 | Enumerated | V | | | M | No | +| Collection-Period-RRM-UMTS | 1658 | 7.3.169 | Enumerated | V | | | M | No | +| Positioning-Method | 1659 | 7.3.170 | OctetString | V | | | M | No | +| Measurement-Quantity | 1660 | 7.3.171 | OctetString | V | | | M | No | +| Event-Threshold-Event-1F | 1661 | 7.3.172 | Integer32 | V | | | M | No | +| Event-Threshold-Event-1I | 1662 | 7.3.173 | Integer32 | V | | | M | No | +| Restoration-Priority | 1663 | 7.3.174 | Unsigned32 | V | | | M | No | +| SGs-MME-Identity | 1664 | 7.3.175 | UTF8String | V | | | M | No | +| SIPTO-Local-Network-Permission | 1665 | 7.3.176 | Unsigned32 | V | | | M | No | +| Coupled-Node-Diameter-ID | 1666 | 7.3.177 | DiameterIdentity | V | | | M | No | +| WLAN-offloadability | 1667 | 7.3.181 | Grouped | V | | | M | No | +| WLAN-offloadability-EUTRAN | 1668 | 7.3.182 | Unsigned32 | V | | | M | No | +| WLAN-offloadability-UTRAN | 1669 | 7.3.183 | Unsigned32 | V | | | M | No | +| Reset-ID | 1670 | 7.3.184 | OctetString | V | | | M | No | +| MDT-Allowed-PLMN-Id | 1671 | 7.3.185 | OctetString | V | | | M | No | +| Adjacent-PLMNs | 1672 | 7.3.186 | Grouped | V | | | M | No | +| Adjacent-Access-Restriction-Data | 1673 | 7.3.187 | Grouped | V | | | M | No | +| DL-Buffering-Suggested-Packet-Count | 1674 | 7.3.188 | Integer32 | V | | | M | No | +| IMSI-Group-Id | 1675 | 7.3.189 | Grouped | V | | | M | No | +| Group-Service-Id | 1676 | 7.3.190 | Unsigned32 | V | | | M | No | +| Group-PLMN-Id | 1677 | 7.3.191 | OctetString | V | | | M | No | +| Local-Group-Id | 1678 | 7.3.192 | OctetString | V | | | M | No | +| AIR-Flags | 1679 | 7.3.201 | Unsigned32 | V | | | M | No | +| UE-Usage-Type | 1680 | 7.3.202 | Unsigned32 | V | | | M | No | +| Non-IP-PDN-Type-Indicator | 1681 | 7.3.204 | Enumerated | V | | | M | No | +| Non-IP-Data-Delivery-Mechanism | 1682 | 7.3.205 | Unsigned32 | V | | | M | No | +| Additional-Context-ID | 1683 | 7.3.206 | Unsigned32 | V | | | M | No | +| SCEF-Realm | 1684 | 7.3.207 | DiameterIdentity | V | | | M | No | +| Subscription-Data-Deletion | 1685 | 7.3.208 | Grouped | V | | | M | No | +| Preferred-Data-Mode | 1686 | 7.3.209 | Unsigned32 | V | | | M | No | +| Emergency-Info | 1687 | 7.3.210 | Grouped | V | | | M | No | +| V2X-Subscription-Data | 1688 | 7.3.212 | Grouped | V | | | M | No | +| V2X-Permission | 1689 | 7.3.213 | Unsigned32 | V | | | M | No | +| PDN-Connection-Continuity | 1690 | 7.3.214 | Unsigned32 | V | | | M | No | +| eDRX-Cycle-Length | 1691 | 7.3.215 | Grouped | V | | | M | No | +| eDRX-Cycle-Length-Value | 1692 | 7.3.216 | OctetString | V | | | M | No | +| UE-PC5-AMBR | 1693 | 7.3.217 | Unsigned32 | V | | | M | No | +| MBSFN-Area | 1694 | 7.3.219 | Grouped | V | | | M | No | +| MBSFN-Area-ID | 1695 | 7.3.220 | Unsigned32 | V | | | M | No | +| Carrier-Frequency | 1696 | 7.3.221 | Unsigned32 | V | | | M | No | +| RDS-Indicator | 1697 | 7.3.222 | Enumerated | V | | | M | No | + +| | | | | | | | | | +|------------------------------------------|------|---------|-------------|---|--|--|---|----| +| Service-Gap-Time | 1698 | 7.3.223 | Unsigned32 | V | | | M | No | +| Aerial-UE-Subscription-Information | 1699 | 7.3.224 | Unsigned32 | V | | | M | No | +| Broadcast-Location-Assistance-Data-Types | 1700 | 7.3.225 | Unsigned64 | V | | | M | No | +| Paging-Time-Window | 1701 | 7.3.226 | Grouped | V | | | M | No | +| Operation-Mode | 1702 | 7.3.227 | Unsigned32 | V | | | M | No | +| Paging-Time-Window-Length | 1703 | 7.3.228 | OctetString | V | | | M | No | +| Core-Network-Restrictions | 1704 | 7.3.230 | Unsigned32 | V | | | M | No | +| eDRX-Related-RAT | 1705 | 7.3.229 | Grouped | V | | | M | No | +| Interworking-5GS-Indicator | 1706 | 7.3.231 | Enumerated | V | | | M | No | +| Ethernet-PDN-Type-Indicator | 1707 | 7.3.232 | Enumerated | V | | | M | No | +| Subscribed-ARPI | 1708 | 7.3.233 | Unsigned32 | V | | | M | No | +| IAB-Operation-Permission | 1709 | 7.3.234 | Enumerated | V | | | M | No | +| V2X-Subscription-Data-Nr | 1710 | 7.3.235 | Grouped | V | | | M | No | +| UE-PC5-QoS | 1711 | 7.3.236 | Grouped | V | | | M | No | +| PC5-QoS-Flow | 1712 | 7.3.237 | Grouped | V | | | M | No | +| 5QI | 1713 | 7.3.238 | Integer32 | V | | | M | No | +| PC5-Flow-Bitrates | 1714 | 7.3.239 | Grouped | V | | | M | No | +| Guaranteed-Flow-Bitrates | 1715 | 7.3.240 | Integer32 | V | | | M | No | +| Maximum-Flow-Bitrates | 1716 | 7.3.241 | Integer32 | V | | | M | No | +| PC5-Range | 1717 | 7.3.242 | Integer32 | V | | | M | No | +| PC5-Link-AMBR | 1718 | 7.3.243 | Integer32 | V | | | M | No | +| Third-Context-Identifier | 1719 | 7.3.244 | Unsigned32 | V | | | M | No | + +NOTE 1: The AVP header bit denoted as "M", indicates whether support of the AVP is required. The AVP header bit denoted as "V", indicates whether the optional Vendor-ID field is present in the AVP header. For further details, see IETF RFC 6733 [61]. + +NOTE 2: If the M-bit is set for an AVP and the receiver does not understand the AVP, it shall return a rejection. If the M-bit is not set for an AVP, the receiver shall not return a rejection, whether or not it understands the AVP. If the receiver understands the AVP but the M-bit value does not match with the definition in this table, the receiver shall ignore the M-bit. + +The following table specifies the Diameter AVPs re-used by the S6a/S6d interface protocol from existing Diameter Applications, including a reference to their respective specifications and when needed, a short description of their use within S6a and S6d. + +Any other AVPs from existing Diameter Applications, except for the AVPs from Diameter base protocol specified in IETF RFC 6733 [61], do not need to be supported. The AVPs from the Diameter base protocol specified in IETF RFC 6733 [61] are not included in table 7.3.1/2, but they may be re-used for the S6a/S6d protocol, the S7a/S7' protocol and the S13/S13' protocol. + +**Table 7.3.1/2: S6a/S6d, S7a/S7d and S13/S13' re-used Diameter AVPs** + +| Attribute Name | Reference | Comments | M-bit | +|-------------------------------|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------| +| Service-Selection | IETF RFC 5778 [20] | See clause 7.3.36 | | +| 3GPP-Charging-Characteristics | 3GPP TS 29.061 [21] | See 3GPP TS 32.251 [33] Annex A and 3GPP TS 32.298 [22] clause 5.1.2.2.7
This attribute holds the EPS PDN Connection Charging Characteristics data for an EPS APN Configuration, or the PDP context Charging Characteristics for GPRS PDP context, or the Subscribed Charging Characteristics data for the subscriber level 3GPP Charging Characteristics; refer to 3GPP TS 23.008 [30]. | | +| Supported-Features | 3GPP TS 29.229 [9] | | | +| Feature-List-ID | 3GPP TS 29.229 [9] | | | +| Feature-List | 3GPP TS 29.229 [9] | See clause 7.3.10 | | +| Served-Party-IP-Address | 3GPP TS 32.299 [8] | holds the PDN IP Address of the user | | +| QoS-Class-Identifier | 3GPP TS 29.212 [10] | | | +| Allocation-Retention-Priority | 3GPP TS 29.212 [10] | See clause 7.3.40 | | +| Priority-Level | 3GPP TS 29.212 [10] | | | +| Pre-emption-Capability | 3GPP TS 29.212 [10] | | | +| Pre-emption-Vulnerability | 3GPP TS 29.212 [10] | | | +| Max-Requested-Bandwidth-DL | 3GPP TS 29.214 [11] | | | +| Max-Requested-Bandwidth-UL | 3GPP TS 29.214 [11] | | | +| Extended-Max-Requested-BW-DL | 3GPP TS 29.214 [11] | | | +| Extended-Max-Requested-BW-UL | 3GPP TS 29.214 [11] | | | +| RAT-Type | 3GPP TS 29.212 [10] | See clause 7.3.13 | Must set | +| MSISDN | 3GPP TS 29.329 [25] | | | +| MIP6-Agent-Info | IETF RFC 5447 [26] | | | +| MIP-Home-Agent-Address | IETF RFC 4004 [27] | | | +| MIP-Home-Agent-Host | IETF RFC 4004 [27] | | | +| PDP-Address | 3GPP TS 32.299 [8] | | | +| Confidentiality-Key | 3GPP TS 29.229 [9] | See clause 7.3.57 | | +| Integrity-Key | 3GPP TS 29.229 [9] | See clause 7.3.58 | | +| Visited-Network-Identifier | 3GPP TS 29.229 [9] | See clause 7.3.105 | Must not set | +| GMLC-Address | 3GPP TS 29.173 [37] | See clause 7.3.109 | Must not set | +| User-CSG-Information | 3GPP TS 32.299 [8] | | Must not set | +| ProSe-Subscription-Data | 3GPP TS 29.344 [49] | See clause 7.3.180 | Must not set | +| OC-Supported-Features | IETF RFC 7683 [50] | See clause 7.3.178 | Must not set | +| OC-OLR | IETF RFC 7683 [50] | See clause 7.3.179 | Must not set | +| SCEF-Reference-ID | 3GPP TS 29.336 [54] | | Must not set | + +| Attribute Name | Reference | Comments | M-bit | +|------------------------------------|---------------------|---------------------|--------------| +| SCEF-ID | 3GPP TS 29.336 [54] | | Must not set | +| AESE-Communication-Pattern | 3GPP TS 29.336 [54] | see clause 7.3.193 | Must not set | +| Communication-Pattern-set | 3GPP TS 29.336 [54] | see clause 7.3.194 | Must not set | +| Monitoring-Event-Configuration | 3GPP TS 29.336 [54] | See clause 7.3.195 | Must not set | +| Monitoring-Event-Report | 3GPP TS 29.336 [54] | See clause 7.3.196 | Must not set | +| UE-Reachability-Configuration | 3GPP TS 29.336 [54] | See clause 7.3.197 | Must not set | +| eNodeB-ID | 3GPP TS 29.217 [56] | See clause 7.3.198 | Must not set | +| SCEF-Reference-ID-for-Deletion | 3GPP TS 29.336 [54] | | Must not set | +| Monitoring-Type | 3GPP TS 29.336 [54] | | Must not set | +| Maximum-Number-of-Reports | 3GPP TS 29.336 [54] | | Must not set | +| Monitoring-Duration | 3GPP TS 29.336 [54] | | Must not set | +| Charged-Party | 3GPP TS 29.336 [54] | | Must not set | +| UE-Reachability-Configuration | 3GPP TS 29.336 [54] | | Must not set | +| Location-Information-Configuration | 3GPP TS 29.336 [54] | | Must not set | +| Reachability-Type | 3GPP TS 29.336 [54] | | Must not set | +| Maximum-Response-Time | 3GPP TS 29.336 [54] | | Must not set | +| Reachability-Information | 3GPP TS 29.336 [54] | | Must not set | +| Monitoring-Event-Config-Status | 3GPP TS 29.336 [54] | | Must not set | +| Supported-Services | 3GPP TS 29.336 [54] | See clause 7.3.199 | Must not set | +| Supported-Monitoring-Events | 3GPP TS 29.336 [54] | See clause 7.3.200 | Must not set | +| DRMP | IETF RFC 7944 [57] | See clause 7.3.203 | Must not set | +| Reference-ID-Validity-Time | 3GPP TS 29.336 [54] | | Must not set | +| Maximum-UE-Availability-Time | 3GPP TS 29.338 [48] | See clause 5.3.3.22 | Must not set | +| Emergency-Services | 3GPP TS 29.273 [59] | | | +| Load | IETF RFC 8583 [60] | See clause 7.3.211 | Must not set | +| Extended-eNodeB-ID | 3GPP TS 29.217 [56] | See clause 7.3.218 | Must not set | +| External-Identifier | 3GPP TS 29.336 [54] | | Must not set | + +| Attribute Name | Reference | Comments | M-bit | +|---------------------------------------|---------------------|--------------------|-------------------| +| Loss-Of-Connectivity-Reason | 3GPP TS 29.336 [54] | | Must not set | +| Active-Time | 3GPP TS 29.128 [63] | | Must not set | +| Idle-Status-Indication | 3GPP TS 29.128 [63] | | Must not set | +| MTC-Provider-Info | 3GPP TS 29.336 [54] | | Must not set | +| Traffic-Profile | 3GPP TS 29.336 [54] | | Must not set | +| PDN-Connectivity-Status-Configuration | 3GPP TS 29.336 [54] | See clause 7.3.195 | Must not set | +| PDN-Connectivity-Status-Report | 3GPP TS 29.336 [54] | See clause 7.3.196 | Must not set | +| Battery-Indicator | 3GPP TS 29.336 [54] | | Battery-Indicator | +| SCEF-Reference-ID-Ext | 3GPP TS 29.336 [54] | | Must not set | +| SCEF-Reference-ID-for-Deletion-Ext | 3GPP TS 29.336 [54] | | Must not set | + +NOTE 1: The M-bit settings for re-used AVPs override those of the defining specifications that are referenced. Values include: "Must set", "Must not set". If the M-bit setting is blank, then the defining specification applies. + +NOTE 2: If the M-bit is set for an AVP and the receiver does not understand the AVP, it shall return a rejection. If the M-bit is not set for an AVP, the receiver shall not return a rejection, whether or not it understands the AVP. If the receiver understands the AVP but the M-bit value does not match with the definition in this table, the receiver shall ignore the M-bit. + +### 7.3.2 Subscription-Data + +The Subscription-Data AVP is of type Grouped. It shall contain the information related to the user profile relevant for EPS and GERAN/UTRAN. + +AVP format: + +Subscription-Data ::= + +- [ Subscriber-Status ] +- [ MSISDN ] +- [ A-MSISDN ] +- [ STN-SR ] +- [ ICS-Indicator ] +- [ Network-Access-Mode ] +- [ Operator-Determined-Barring ] +- [ HPLMN-ODB ] +- \*10[ Regional-Subscription-Zone-Code ] +- [ Access-Restriction-Data ] +- [ APN-OI-Replacement ] +- [ LCS-Info ] +- [ Teleservice-List ] +- \*[ Call-Barring-Info ] +- [ 3GPP-Charging-Characteristics ] +- [ AMBR ] +- [ APN-Configuration-Profile ] +- [ RAT-Frequency-Selection-Priority-ID ] +- [ Trace-Data ] +- [ GPRS-Subscription-Data ] +- \*[ CSG-Subscription-Data ] +- [ Roaming-Restricted-Due-To-Unsupported-Feature ] +- [ Subscribed-Periodic-RAU-TAU-Timer ] +- [ MPS-Priority ] +- [ VPLMN-LIPA-Allowed ] +- [ Relay-Node-Indicator ] +- [ MDT-User-Consent ] +- [ Subscribed-VSRVCC ] +- [ ProSe-Subscription-Data ] +- [ Subscription-Data-Flags ] + +\*[ Adjacent-Access-Restriction-Data ] +[ DL-Buffering-Suggested-Packet-Count ] +\*[ IMSI-Group-Id ] +[ UE-Usage-Type ] +\*[ AESE-Communication-Pattern ] +\*[ Monitoring-Event-Configuration ] +[ Emergency-Info ] +[ V2X-Subscription-Data ] +[ V2X-Subscription-Data-Nr ] +\*[ eDRX-Cycle-Length ] +[ External-Identifier ] +[ Active-Time ] +[ Service-Gap-Time ] +[ Broadcast-Location-Assistance-Data-Types ] +[ Aerial-UE-Subscription-Information ] +[ Core-Network-Restrictions ] +\*[ Paging-Time-Window ] +[ Subscribed-ARPI ] +[ IAB-Operation-Permission ] +\*[ AVP ] + +The AMBR included in this grouped AVP shall include the AMBR associated to the user's subscription (UE-AMBR); Max-Requested-Bandwidth-UL and Max-Requested-Bandwidth-DL within this AVP shall not both be set to "0". + +The APN-OI-Replacement included in this grouped AVP shall include the UE level APN-OI-Replacement associated to the user's subscription. + +When multiple External Identifiers are defined for the same subscription, the External-Identifier in this grouped AVP shall contain a default External Identifier determined by the HSS. + +### 7.3.3 Terminal-Information + +The Terminal-Information AVP is of type Grouped. This AVP shall contain the information about the user's terminal. + +AVP format + +Terminal-Information ::= + +[ IMEI ] +[ 3GPP2-MEID ] +[ Software-Version ] +\*[ AVP ] + +### 7.3.4 IMEI + +The IMEI AVP is of type UTF8String. This AVP shall contain the International Mobile Equipment Identity, as specified in 3GPP TS 23.003 [3]. It should consist of 14 digits, including the 8-digit Type Allocation Code (TAC) and the 6-digit Serial Number (SNR). It may also include a 15th digit. + +### 7.3.5 Software-Version + +The Software-Version AVP is of type UTF8String. This AVP shall contain the 2-digit Software Version Number (SVN) of the International Mobile Equipment Identity, as specified in 3GPP TS 23.003 [3]. + +### 7.3.6 3GPP2-MEID + +This AVP is of type OctetString. This AVP contains the Mobile Equipment Identifier of the user's terminal. For further details on the encoding of the AVP data, refer to the encoding of the Mobile Identity (MEID) octets 3 to 10 in 3GPP2 A.S0022 [28] Annex A. + +### 7.3.7 ULR-Flags + +The ULR-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 7.3.7/1: + +**Table 7.3.7/1: ULR-Flags** + +| Bit | Name | Description | +|-----|----------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | Single-Registration-Indication | This bit, when set, indicates that the HSS shall send Cancel Location to the SGSN. An SGSN shall not set this bit when sending ULR. | +| 1 | S6a/S6d-Indicator | This bit, when set, indicates that the ULR message is sent on the S6a interface, i.e. the source node is an MME (or a combined MME/SGSN to which the UE is attached via E-UTRAN).
This bit, when cleared, indicates that the ULR message is sent on the S6d interface, i.e. the source node is an SGSN (or a combined MME/SGSN to which the UE is attached via UTRAN or GERAN). | +| 2 | Skip Subscriber Data | This bit, when set, indicates that the HSS may skip subscription data in ULA. If the subscription data has changed in the HSS after the last successful update of the MME/SGSN, the HSS shall ignore this bit and send the updated subscription data. If the HSS effectively skips the sending of subscription data, the GPRS-Subscription-Data-Indicator flag can be ignored. | +| 3 | GPRS-Subscription-Data-Indicator | This bit, when set, indicates that the HSS shall include in the ULA command the GPRS subscription data, if available in the HSS; it shall be included in the GPRS-Subscription-Data AVP inside the Subscription-Data AVP (see 7.3.2).
Otherwise, the HSS shall not include the GPRS-Subscription-Data AVP in the response, unless the Update Location Request is received over the S6d interface and there is no APN configuration profile stored for the subscriber, or when the subscription data is returned by a Pre-Rel-8 HSS (via an IWF).
A standalone MME shall not set this bit when sending a ULR. | +| 4 | Node-Type-Indicator | This bit, when set, indicates that the requesting node is a combined MME/SGSN.
This bit, when cleared, indicates that the requesting node is a single MME or SGSN; in this case, if the S6a/S6d-Indicator is set, the HSS may skip the check of those supported features only applicable to the SGSN, and if, in addition the MME does not request to be registered for SMS, the HSS may consequently skip the download of the SMS related subscription data to a standalone MME. NOTE2 | +| 5 | Initial-Attach-Indicator | This bit, when set, indicates that the HSS shall send Cancel Location to the MME or SGSN if there is the MME or SGSN registration. | +| 6 | PS-LCS-Not-Supported-By-UE | This bit, when set, indicates to the HSS that the UE does not support neither UE Based nor UE Assisted positioning methods for Packet Switched Location Services. The MME shall set this bit on the basis of the UE capability information. The SGSN shall set this bit on the basis of the UE capability information and the access technology supported by the SGSN. | +| 7 | SMS-Only-Indication | This bit, when set, indicates that the UE indicated "SMS only" when requesting a combined IMSI attach or combined RA/LU. | +| 8 | Dual-Registration-5G-Indicator | This bit, when set by an MME over S6a interface, indicates that the HSS+UDM shall not send Nudm_UECM_DeregistrationNotification to the registered AMF (if any); when not set by an MME over S6a interface, it indicates that the HSS+UDM shall send Nudm_UECM_DeregistrationNotification to the registered AMF (if any). See 3GPP TS 29.503 [66].

An SGSN shall not set this bit when sending ULR over S6d interface. | + +NOTE1: Bits not defined in this table shall be cleared by the sending MME or SGSN and discarded by the receiving HSS. + +NOTE2: If the MME is registered for SMS then the HSS will download the SMS related data also for the standalone MME. + +## 7.3.8 ULA-Flags + +The ULA-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 7.3.8/1: + +**Table 7.3.8/1: ULA-Flags** + +| Bit | Name | Description | +|----------------------------------------------------------------------------------------------------------------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | Separation Indication | This bit, when set, indicates that the HSS stores SGSN number and MME number in separate memory. A Rel-8 HSS shall set the bit. An IWF interworking with a pre Rel-8 HSS/HLR shall clear the bit. | +| 1 | MME Registered for SMS | This bit, when set, indicates that the HSS has registered the MME for SMS. | +| NOTE: Bits not defined in this table shall be cleared by the sending HSS and discarded by the receiving MME or SGSN. | | | + +## 7.3.9 Visited-PLMN-Id + +The Visited-PLMN-Id AVP is of type OctetString. This AVP shall contain the concatenation of MCC and MNC. See 3GPP TS 23.003 [3]. The content of this AVP shall be encoded as an octet string according to table 7.3.9-1. + +See 3GPP TS 24.008 [31], clause 10.5.1.13, PLMN list, for the coding of MCC and MNC. If MNC is 2 digits long, bits 5 to 8 of octet 2 are coded as "1111". + +**Table 7.3.9/1: Encoding format for Visited-PLMN-Id AVP** + +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +|---|---|---|---|-------------|---|---|---|---------| +| | | | | MCC digit 2 | | | | octet 1 | +| | | | | MNC digit 3 | | | | octet 2 | +| | | | | MNC digit 2 | | | | octet 3 | + +## 7.3.10 Feature-List AVP + +### 7.3.10.1 Feature-List AVP for the S6a/S6d application + +The syntax of this AVP is defined in 3GPP TS 29.229 [9]. + +For the S6a/S6d application, the meaning of the bits shall be as defined in table 7.3.10/1 for the Feature-List-ID 1 and in table 7.3.10/2 for the Feature-List-ID 2. + +**Table 7.3.10/1: Features of Feature-List-ID 1 used in S6a/S6d** + +| Feature bit | Feature | M/O | Description | +|-------------|-------------------------------------------|-----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | ODB-all-APN | O | Operator Determined Barring of all Packet Oriented Services

This feature is applicable for the ULR/ULA and IDR/IDA command pairs. If the MME or SGSN does not support this feature, the HSS shall not send this ODB barring category to the MME or SGSN within ULA. Instead the HSS may reject location update by sending DIAMETER_ERROR_ROAMING_NOT_ALLOWED and, optionally, including the type of ODB in the Error-Diagnostic AVP. If the MME or SGSN does not indicate support of this feature in IDA and the HSS has sent this ODB category within IDR, the HSS may apply barring of roaming and send CLR. | +| 1 | ODB-HPLMN-APN | O | Operator Determined Barring of Packet Oriented Services from access points that are within the HPLMN whilst the subscriber is roaming in a VPLMN

This feature is applicable for the ULR/ULA and IDR/IDA command pairs. If the MME or SGSN does not support this feature, the HSS shall not send this ODB barring category to the MME or SGSN within ULA. Instead the HSS may reject location update by sending DIAMETER_ERROR_ROAMING_NOT_ALLOWED and, optionally, including the type of ODB in the Error-Diagnostic AVP. If the MME or SGSN does not indicate support of this feature in IDA and the HSS has sent this ODB category within IDR, the HSS may apply barring of roaming and send CLR. | +| 2 | ODB-VPLMN-APN | O | Operator Determined Barring of Packet Oriented Services from access points that are within the roamed to VPLMN

This feature is applicable for the ULR/ULA and IDR/IDA command pairs. If the MME or SGSN does not support this feature, the HSS shall not send this ODB barring category to the MME or SGSN within ULA. Instead the HSS may reject location update by sending DIAMETER_ERROR_ROAMING_NOT_ALLOWED and, optionally, including the type of ODB in the Error-Diagnostic AVP. If the MME or SGSN does not indicate support of this feature in IDA and the HSS has sent this ODB category within IDR, the HSS may apply barring of roaming and send CLR. | +| 3 | ODB-all-OG | O | Operator Determined Barring of all outgoing calls

This feature is applicable for the ULR/ULA and IDR/IDA command pairs. If the MME or SGSN does not support this feature, the HSS shall not send this ODB barring category to the MME or SGSN within ULA. Instead the HSS may reject location update. If the MME or SGSN does not indicate support of this feature in IDA and the HSS has sent this ODB category within IDR, the HSS may apply barring of roaming and send CLR. | +| 4 | ODB-all-InternationalOG | O | Operator Determined Barring of all outgoing international calls

This feature is applicable for the ULR/ULA and IDR/IDA command pairs.If the MME or SGSN does not support this feature, the HSS shall not send this ODB barring category to the MME or SGSN within ULA. Instead the HSS may reject location update. If the MME or SGSN does not indicate support of this feature in IDA and the HSS has sent this ODB category within IDR, the HSS may apply barring of roaming and send CLR. | +| 5 | ODB-all-InternationalOGNotToHPLMN-Country | O | Operator Determined Barring of all outgoing international calls except those directed to the home PLMN country

This feature is applicable for the ULR/ULA and IDR/IDA command pairs. If the MME or SGSN does not support this feature, the HSS shall not send this ODB barring category to the MME or SGSN within ULA. Instead the HSS may reject location update. If the MME or SGSN does not indicate support of this feature in IDA and the HSS has sent this ODB category within IDR, the HSS may apply barring of roaming and send CLR. | + +| | | | | +|----|-------------------------------------------------------------|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 6 | ODB-all-Interzonal OG | O | Operator Determined Barring of all outgoing inter-zonal calls

This feature is applicable for the ULR/ULA and IDR/IDA command pairs.
If the MME or SGSN does not support this feature, the HSS shall not send this ODB barring category to the MME or SGSN within ULA. Instead the HSS may reject location update.
If the MME or SGSN does not indicate support of this feature in IDA and the HSS has sent this ODB category within IDR, the HSS may apply barring of roaming and send CLR. | +| 7 | ODB-all-Interzonal OGNotTo HPLMN-Country | O | Operator Determined Barring of all outgoing inter-zonal calls except those directed to the home PLMN country

This feature is applicable for the ULR/ULA and IDR/IDA command pairs.
If the MME or SGSN does not support this feature, the HSS shall not send this ODB barring category to the MME or SGSN within ULA. Instead the HSS may reject location update.
If the MME or SGSN does not indicate support of this feature in IDA and the HSS has sent this ODB category within IDR, the HSS may apply barring of roaming and send CLR. | +| 8 | ODB-all-Interzonal OGAndInternational OGNotTo HPLMN-Country | O | Operator Determined Barring of all outgoing international calls except those directed to the home PLMN country and Barring of all outgoing inter-zonal calls

This feature is applicable for the ULR/ULA and IDR/IDA command pairs.
If the MME or SGSN does not support this feature, the HSS shall not send this ODB barring category to the MME or SGSN within ULA. Instead the HSS may reject location update.
If the MME or SGSN does not indicate support of this feature in IDA and the HSS has sent this ODB category within IDR, the HSS may apply barring of roaming and send CLR. | +| 9 | RegSub | O | Regional Subscription

This feature is applicable for the ULR/ULA, IDR/IDA and DSR/DSA command pairs.
If the MME or SGSN does not support this feature, the HSS shall not send Regional Subscription Zone Codes to the MME or SGSN within ULA. Instead the HSS may reject location update.
If the MME or SGSN does not indicate support of this feature in IDA and the HSS has sent Regional Subscription Zone Codes within IDR, the HSS may apply barring of roaming and send CLR. | +| 10 | Trace | O | Trace Function

This feature is applicable for the ULR/ULA, IDR/IDA and DSR/DSA command pairs.
If the MME or SGSN does not indicate support of this feature in ULR, the HSS shall not send Trace Data to the MME or SGSN within ULA.

If the MME or SGSN does not indicate support of this feature in IDA, and the HSS has sent Trace Data within IDR, the HSS may store this indication, and not send any further Trace Data to that MME or SGSN.

If the MME or SGSN does not indicate support of this feature in DSA, and the HSS has sent Trace Data within DSR, the HSS may store this indication, and not send any further Trace Data to that MME or SGSN | +| 11 | LCS-all-PrivExcep (NOTE 1) | O | All LCS Privacy Exception Classes

This feature is applicable for the ULR/ULA and IDR/IDA command pairs over the S6d interface, when the SGSN supports MAP based Lg interface.
If the SGSN does not support this feature, the HSS shall not send the related LCS information to the SGSN within ULA.

If the SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that SGSN. | + +| | | | | +|----|-----------------------------------|---|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 12 | LCS-Universal (NOTE 1) | O |

Allow location by any LCS client

This feature is applicable for the ULR/ULA and IDR/IDA command pairs over the S6d interface, when the SGSN supports MAP based Lg interface.
If the SGSN does not support this feature, the HSS shall not send the related LCS information to the SGSN within ULA.

If the SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that SGSN.

| +| 13 | LCS-CallSessionRelated (NOTE 1) | O |

Allow location by any value added LCS client to which a call/session is established from the target UE

This feature is applicable for the ULR/ULA and IDR/IDA command pairs over the S6d interface, when the SGSN supports MAP based Lg interface.
If the SGSN does not support this feature, the HSS shall not send the related LCS information to the SGSN within ULA.

If the SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that SGSN.

| +| 14 | LCS-CallSessionUnrelated (NOTE 1) | O |

Allow location by designated external value added LCS clients

This feature is applicable for the ULR/ULA and IDR/IDA command pairs over the S6d interface, when the SGSN supports MAP based Lg interface.
If the SGSN does not support this feature, the HSS shall not send the related LCS information to the SGSN within ULA.

If the SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that SGSN.

| +| 15 | LCS-PLMNOperator (NOTE 1) | O |

Allow location by designated PLMN operator LCS clients

This feature is applicable for the ULR/ULA and IDR/IDA command pairs over the S6d interface, when the SGSN supports MAP based Lg interface.
If the SGSN does not support this feature, the HSS shall not send the related LCS information to the SGSN within ULA.

If the SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that SGSN.

| +| 16 | LCS-ServiceType (NOTE 1) | O |

Allow location by LCS clients of a designated LCS service type

This feature is applicable for the ULR/ULA and IDR/IDA command pairs over the S6d interface, when the SGSN supports MAP based Lg interface.
If the SGSN does not support this feature, the HSS shall not send the related LCS information to the SGSN within ULA.

If the SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that SGSN.

| +| 17 | LCS-all-MOLR-SS (NOTE 1) | O |

All Mobile Originating Location Request Classes

This feature is applicable for the ULR/ULA and IDR/IDA command pairs. Over S6d interface, this feature is applicable when the SGSN supports MAP based Lg interface.
If the MME or SGSN does not support this feature, the HSS shall not send the related LCS information to the MME or SGSN within ULA.

If the MME or SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that MME or SGSN.

| + +| | | | | +|----|-------------------------------------|---|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 18 | LCS-BasicSelf Location (NOTE 1) | O |

Allow an MS to request its own location

This feature is applicable for the ULR/ULA and IDR/IDA command pairs. Over S6d interface, this feature is applicable when the SGSN supports MAP based Lg interface. If the MME or SGSN does not support this feature, the HSS shall not send the related LCS information to the MME or SGSN within ULA.

If the MME or SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that MME or SGSN.

| +| 19 | LCS-AutonomousSelfLocation (NOTE 1) | O |

Allow an MS to perform self location without interaction with the PLMN

This feature is applicable for the ULR/ULA and IDR/IDA command pairs. Over S6d interface, this feature is applicable when the SGSN supports MAP based Lg interface. If the MME or SGSN does not support this feature, the HSS shall not send the related LCS information to the MME or SGSN within ULA.

If the MME or SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that MME or SGSN.

| +| 20 | LCS-TransferToThirdParty | O |

Allow an MS to request transfer of its location to another LCS client

This feature is applicable for the ULR/ULA and IDR/IDA command pairs. Over S6d interface, this feature is applicable when the SGSN supports MAP based Lg interface. If the MME or SGSN does not support this feature, the HSS shall not send the related LCS information to the MME or SGSN within ULA.

If the MME or SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that MME or SGSN.

| +| 21 | SM-MO-PP (NOTE 1) | O |

Short Message MO-PP

This feature is applicable for the ULR/ULA and IDR/IDA command pairs. If the MME or SGSN does not support this feature, the HSS shall not send the related SMS information to the MME or SGSN within ULA.

If the MME or SGSN does not indicate support of this feature in IDA, and the HSS has sent the related SMS information within IDR, the HSS may store this indication, and not send any further SMS information to that MME or SGSN.

| +| 22 | Barring-Outgoing Calls | O |

Barring of Outgoing Calls

This feature is applicable for the ULR/ULA and IDR/IDA command pairs. If the MME or SGSN does not support this feature, the HSS shall not send the related SMS information to the MME or SGSN within ULA.

If the MME or SGSN does not indicate support of this feature in IDA, and the HSS has sent the related SMS information within IDR, the HSS may store this indication, and not send any further SMS information to that MME or SGSN.

| +| 23 | BAOC | O |

Barring of all outgoing calls

This feature is applicable for the ULR/ULA and IDR/IDA command pairs. If the MME or SGSN does not support this feature, the HSS shall not send the related SMS information to the MME or SGSN within ULA.

If the MME or SGSN does not indicate support of this feature in IDA, and the HSS has sent the related SMS information within IDR, the HSS may store this indication, and not send any further SMS information to that MME or SGSN.

| + +| | | | | +|----|--------------------------------------|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 24 | BOIC | O |

Barring of outgoing international calls

This feature is applicable for the ULR/ULA and IDR/IDA command pairs.
If the SGSN does not support this feature, the HSS shall not send the related SMS information to the MME or SGSN within ULA.

If the MME or SGSN does not indicate support of this feature in IDA, and the HSS has sent the related SMS information within IDR, the HSS may store this indication, and not send any further SMS information to that MME or SGSN.

| +| 25 | BOICExHC | O |

Barring of outgoing international calls except those directed to the home PLMN Country

This feature is applicable for the ULR/ULA and IDR/IDA command pairs.
If the MME or SGSN does not support this feature, the HSS shall not send the related SMS information to the MME or SGSN within ULA.

If the MME or SGSN does not indicate support of this feature in IDA, and the HSS has sent the related SMS information within IDR, the HSS may store this indication, and not send any further SMS information to that MME or SGSN.

| +| 26 | UE-Reachability-Notification | O |

UE Reachability Notification

This feature is applicable for the ULR/ULA and IDR/IDA command pairs, over S6a and S6d.

If the MME or SGSN indicates in the ULR command that it does not support the UE-Reachability-Notifications, the HSS shall not set the "UE-Reachability-Request" bit in IDR-Flags in subsequent IDR commands towards that MME or SGSN.

| +| 27 | T-ADS Data Retrieval | O |

Terminating Access Domain Selection Data Retrieval

This feature is applicable for the ULR/ULA and IDR/IDA command pairs, over S6a and S6d.

If the MME or SGSN indicates in the ULR command that it does not support the retrieval of T-ADS data via IDR/IDA commands, the HSS shall not set the "T-ADS Data Request" bit in IDR-Flags in subsequent IDR commands towards that MME or SGSN.

| +| 28 | State/Location-Information-Retrieval | O |

State/Location Information Retrieval

This feature is applicable for the ULR/ULA and IDR/IDA command pairs, over S6a and S6d.

If the MME or SGSN indicates in the ULR command that it does not support State/Location Information Retrieval, the HSS shall not set the "EPS User State Request", "EPS Location Information Request" or "Current Location Request" bits in IDR-Flags in subsequent IDR commands towards that MME or SGSN.

| +| 29 | Partial Purge | O |

Partial Purge from a Combined MME/SGSN

This feature is applicable for the ULR/ULA and PUR/PUA command pairs, over S6a and S6d.

If the HSS indicates in the ULA command that it does not support Partial Purge, the combined MME/SGSN shall not include in the PUR command the indication of the specific serving node where the Purge has been done.

| +| 30 | Local Time Zone Retrieval | O |

UE Time Zone Retrieval

This feature is applicable for the ULR/ULA and IDR/IDA command pairs, over S6a and S6d.

If the MME or SGSN indicates in the ULR command that it does not support the retrieval of Local Time Zone via IDR/IDA commands, the HSS shall not set the "Local Time Zone Request" bit in IDR-Flags in subsequent IDR commands towards that MME or SGSN.

| + +| | | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|---|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 31 | Additional MSISDN | O |

Additional MSISDN

This feature is applicable for the ULR/ULA, IDR/IDA and DSR/DSA command pairs, over S6a and S6d.

If the MME or SGSN indicates in the ULR command that it does not support A-MSISDN, the HSS shall populate the MSISDN AVP either with the subscribed MSISDN or the subscribed additional MSISDN based on operator policy and availability and the HSS shall not send IDR with the A-MSISDN AVP or DSR with the "A-MSISDN Withdrawal" bit to the serving nodes when the subscription data is changed.

If the MME or SGSN indicates in the IDA command that it does not support this feature and the HSS has already sent an A-MSISDN value within IDR, the HSS may store this indication and not send any further A-MSISDN updates to that MME or SGSN.

| +|

Feature bit: The order number of the bit within the Supported-Features AVP, e.g. "1".
Feature: A short name that can be used to refer to the bit and to the feature, e.g. "ODB-HPLMN-APN".
M/O: Defines if the implementation of the feature is mandatory ("M") or optional ("O").
Description: A clear textual description of the feature.
NOTE 1: If both bits, corresponding to the feature defined for Lg interface and Lgd interface respectively, are not set, and the HSS supports the feature, the HSS shall not send the related LCS information to the SGSN within ULA and IDR.

| | | | + +**Table 7.3.10/2: Features of Feature-List-ID 2 used in S6a/S6d** + +| Feature bit | Feature | M/O | Description | +|-------------|---------------------------------------|-----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | SMS in MME | O |

SMS in MME

This feature is applicable for the ULR/ULA, IDR/IDA, DSR/DSA, NOR/NOA command pairs, over S6a.

It is used by the MME to notify the HSS it is capable of SMS transfer without the need of establishing an SGs association with an MSC.

If the MME does not support this feature, the HSS shall not send the related SMS information to the MME within ULA.

If the MME does not indicate support of this feature in IDA, and the HSS has sent the related SMS information within IDR, the HSS may store this indication, and not send any further SMS information to that MME.

If the HSS does not support this feature, the HSS shall ignore any request for a registration for SMS; the MME may store this feature indication, and not send any further request for a registration for SMS to the HSS.

| +| 1 | SMS in SGSN | O |

SMS in SGSN

This feature is applicable for the ULR/ULA command pair, over S6d.

If the SGSN indicates in the ULR command that it does not support this feature, the HSS shall not indicate "SMS in SGSN Allowed" to the SGSN.

| +| 2 | Dia-LCS-all-PrivExcep (NOTE 1) | O |

All LCS Privacy Exception Classes

This feature is applicable for the ULR/ULA and IDR/IDA command pairs over the S6d interface, when the SGSN supports Diameter based Lgd interface.

If the SGSN does not support this feature, the HSS shall not send the related LCS information to the SGSN within ULA.

If the SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that SGSN.

| +| 3 | Dia-LCS-Universal (NOTE 1) | O |

Allow location by any LCS client

This feature is applicable for the ULR/ULA and IDR/IDA command pairs over the S6d interface, when the SGSN supports Diameter based Lgd interface.

If the SGSN does not support this feature, the HSS shall not send the related LCS information to the SGSN within ULA.

If the SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that SGSN.

| +| 4 | Dia-LCS-CallSessionRelated (NOTE 1) | O |

Allow location by any value added LCS client to which a call/session is established from the target UE

This feature is applicable for the ULR/ULA and IDR/IDA command pairs over the S6d interface, when the SGSN supports Diameter based Lgd interface.

If the SGSN does not support this feature, the HSS shall not send the related LCS information to the SGSN within ULA.

If the SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that SGSN.

| +| 5 | Dia-LCS-CallSessionUnrelated (NOTE 1) | O |

Allow location by designated external value added LCS clients

This feature is applicable for the ULR/ULA and IDR/IDA command pairs over the S6d interface, when the SGSN supports Diameter based Lgd interface.

If the SGSN does not support this feature, the HSS shall not send the related LCS information to the SGSN within ULA.

If the SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that SGSN.

| + +| | | | | +|----|-----------------------------------------|---|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 6 | Dia-LCS-PLMNOperator (NOTE 1) | O |

Allow location by designated PLMN operator LCS clients

This feature is applicable for the ULR/ULA and IDR/IDA command pairs over the S6d interface, when the SGSN supports Diameter based Lgd interface. If the SGSN does not support this feature, the HSS shall not send the related LCS information to the SGSN within ULA.

If the SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that SGSN.

| +| 7 | Dia-LCS-ServiceType (NOTE 1) | O |

Allow location by LCS clients of a designated LCS service type

This feature is applicable for the ULR/ULA and IDR/IDA command pairs over the S6d interface, when the SGSN supports Diameter based Lgd interface. If the SGSN does not support this feature, the HSS shall not send the related LCS information to the SGSN within ULA.

If the SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that SGSN.

| +| 8 | Dia-LCS-all-MOLR-SS (NOTE 1) | O |

All Mobile Originating Location Request Classes

This feature is applicable for the ULR/ULA and IDR/IDA command pairs over the S6d interface, when the SGSN supports Diameter based Lgd interface. If the SGSN does not support this feature, the HSS shall not send the related LCS information to the SGSN within ULA.

If the SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that SGSN.

| +| 9 | Dia-LCS-BasicSelfLocation (NOTE 1) | O |

Allow an MS to request its own location

This feature is applicable for the ULR/ULA and IDR/IDA command pairs over the S6d interface, when the SGSN supports Diameter based Lgd interface. If the SGSN does not support this feature, the HSS shall not send the related LCS information to the SGSN within ULA.

If the SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that SGSN.

| +| 10 | Dia-LCS-AutonomousSelfLocation (NOTE 1) | O |

Allow an MS to perform self location without interaction with the PLMN

This feature is applicable for the ULR/ULA and IDR/IDA command pairs over the S6d interface, when the SGSN supports Diameter based Lgd interface. If the SGSN does not support this feature, the HSS shall not send the related LCS information to the SGSN within ULA.

If the SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that SGSN.

| +| 11 | Dia-LCS-TransferToThirdParty (NOTE 1) | O |

Allow an MS to request transfer of its location to another LCS client

This feature is applicable for the ULR/ULA and IDR/IDA command pairs over the S6d interface, when the SGSN supports Diameter based Lgd interface. If the SGSN does not support this feature, the HSS shall not send the related LCS information to the SGSN within ULA.

If the SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that SGSN.

| +| 12 | Gdd-in-SGSN | O |

Support of Diameter based Gdd interface for SMS in SGSN

This feature is applicable for the ULR/ULA command pair over S6d, when the SGSN supports the Diameter based Gdd interface for SMS in SGSN.

| + +| | | | | +|----|----------------------------|---|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 13 | Optimized-LCS-Proc-Support | O |

Support for the optimized LCS procedure

This feature is applicable for the ULR/ULA command pair over S6a/S6d, when the network supports ISR and when the node is combined MME/SGSN and supports optimized LCS procedure as described in 3GPP TS 29.172 [47] clause 6.2.2.

| +| 14 | SGSN CAMEL Capability | O |

Support of SGSN CAMEL Capability

This feature is applicable for the ULR/ULA command pair over S6d, when the SGSN supports the CAMEL capability.

| +| 15 | ProSe Capability | O |

Support of ProSe Capability

This feature is applicable for the ULR/ULA and IDR/IDA command pairs over S6a (and S6d), when the MME (or combined MME/SGSN) supports the ProSe capability.
If the MME or combined MME/SGSN does not support this feature, the HSS shall not send the related ProSe subscription data to the MME or combined MME/SGSN within ULA.

If the MME or combined MME/SGSN does not indicate support of this feature in IDA, and the HSS has sent the related ProSe subscription data within IDR, the HSS may store this indication, and not send any further ProSe subscription data to that MME.

| +| 16 | P-CSCF Restoration | O |

Support of P-CSCF Restoration

This feature is applicable to the ULR/ULA and IDR/IDA command pairs over the S6a or S6d interfaces, when the MME or SGSN supports the execution of the P-CSCF restoration procedures.

If the MME or the SGSN does not indicate support of this feature in ULR, the HSS shall not send subsequent IDR commands requesting the execution of HSS-based P-CSCF restoration procedures, as described in 3GPP TS 23.380 [51] clause 5.4.

| +| 17 | Reset-IDs | O |

Support of Reset-IDs

This feature is applicable to the ULR/ULA and IDR/IDA and DSR/DSA and RSR/RSA command pairs over the S6a and S6d interfaces.

If the MME or SGSN indicates in the ULR command that it does not support Reset-IDs, the HSS shall not include Reset-ID AVPs in RSR commands sent to that MME or SGSN.

If the MME or SGSN indicates that it does not support this feature in IDA, and the HSS has already sent a Reset-ID value within IDR, the HSS may store this indication and not send any further Reset-ID updates to that MME or SGSN.

| +| 18 | Communication-Pattern | O |

Support of AESE communication patterns

This feature is applicable to the ULR/ULA and IDR/IDA command pairs over S6a (and S6d), when the MME (or combined MME/SGSN) supports the AESE communication patterns.

If the MME or combined MME/SGSN does not indicate the support for this feature, the HSS shall not send CP parameter sets to the MME or combined MME/SGSN within IDR/ULA command.

If the MME or combined MME/SGSN indicates that it does not support this feature in IDA, and the HSS has already sent CP parameter sets within IDR, the HSS may store this indication and not send any further updates related to CP parameter sets to that MME or combined MME/SGSN.

| + +| | | | | +|----|-------------------------|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 19 | Monitoring-Event | O |

Support of Monitoring Event

This feature is applicable to the ULR/ULA and IDR/IDA command pairs over the S6a or S6d interfaces, when the MME or SGSN supports the Monitoring event feature.

If the MME or SGSN does not indicate support of this feature in ULR, the HSS shall not send Monitoring event configuration data to the MME or SGSN within ULA and shall not send subsequent IDR commands requesting the configuration of Monitoring events in the MME or SGSN.

If the MME or SGSN indicates that it does not support this feature in IDA, and the HSS has already sent Monitoring event configuration data within IDR, the HSS may store this indication and not send any further updates related to Monitoring events to that MME or SGSN.

| +| 20 | Dedicated Core Networks | O |

Support of Dedicated Core Networks

This feature is applicable to the ULR/ULA, IDR/IDA and DSR/DSA command pairs over the S6a and S6d interfaces.

If the MME/SGSN does not indicate support of this feature in the ULR command, the HSS shall not send DCN-related subscription data (e.g., UE Usage Type) in ULA, and shall not send subsequent IDR or DSR commands when such subscription data are updated.

If the MME/SGSN does not indicate support of this feature in the IDA command and the HSS has already sent DCN-related subscription data in IDR, the HSS may store this indication and not send further updates related to DCN subscription data.

| +| 21 | Non-IP PDN Type APNs | O |

Support of Non-IP PDN Type APNs

This feature is applicable to the ULR/ULA and IDR/IDA command pairs over the S6a and S6d interfaces.

If the MME/SGSN does not indicate support of this feature in the ULR command, the HSS shall not send APN configurations with a Non-IP PDN type in the subscription data sent in ULA or in IDR, and shall not send IDR commands with the only purpose to update such subscription data.

If the MME or SGSN indicates in the IDA command that it does not support this feature, and the HSS has already sent Non-IP PDN Type APNs within IDR, the HSS may store this indication, and not send any further updates related to Non-IP PDN Type APNs to that MME or SGSN.

| +| 22 | Non-IP PDP Type APNs | O |

Support of Non-IP PDP Type APNs

This feature is applicable to the ULR/ULA and IDR/IDA command pairs over the S6a/S6d interface.

If the MME/SGSN does not indicate support of this feature in the ULR command, the HSS shall not send PDP contexts (as part of the GPRS-Subscription-Data) with a Non-IP PDP type in the subscription data sent in ULA or in IDR, and shall not send IDR commands with the only purpose to update such subscription data.

If the MME or SGSN indicates in the IDA command that it does not support this feature, and the HSS has already sent Non-IP PDP Type APNs within IDR, the HSS may store this indication, and not send any further updates related to Non-IP PDP Type APNs to that MME or SGSN.

| +| 23 | Removal of MSISDN | O |

Support of Removal of MSISDN

This feature is applicable to the ULR/ULA and DSR/DSA command pairs over the S6a/S6d interface.

If the MME/SGSN does not indicate support of this feature in the ULR command, the HSS shall not send DSR with the "MSISDN Withdrawal" bit set, to remove an existing MSISDN value from the subscription profile stored in the MME/SGSN.

| + +| | | | | +|----|------------------------------|---|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 24 | Emergency Service Continuity | O |

Support of Emergency Services Continuity

This feature is applicable to the ULR/ULA, NOR/NOA and IDR/IDA command pairs over the S6a interface, when the HSS and the MME support the continuity of emergency services upon mobility between 3GPP and WLAN accesses, as specified in 3GPP TS 23.401 [2].

If the MME does not indicate support of this feature in a former ULR command, the HSS shall not include the Emergency Info in an ULA command and shall not send an IDR command to update the PGW in use for emergency services.

If the HSS does not indicate support of this feature in a former ULA command, the MME shall not send a NOR command to update the PGW in use for emergency services.

If the HSS supports this feature on S6a, it shall also support the Emergency Service Continuity feature on SWx, see 3GPP TS 29.273 [59].

| +| 25 | V2X Capability | O |

Support of V2X Service

This feature is applicable for the ULR/ULA and IDR/IDA command pairs over S6a (and S6d), when the MME (or combined MME/SGSN) supports the V2X service.

If the MME or combined MME/SGSN does not support this feature, the HSS shall not send the related V2X subscription data to the MME or combined MME/SGSN within ULA.

If the MME or combined MME/SGSN does not indicate support of this feature in IDA, and the HSS has sent the related V2X subscription data within IDR, the HSS may store this indication, and not send any further V2X subscription data to that MME or that combined MME/SGSN.

| +| 26 | External-Identifier | O |

Support of External-Identifier

This feature is applicable for the ULR/ULA, DSR/DSA and IDR/IDA command pairs over S6a (and S6d), when the MME (or combined MME/SGSN) supports the External-Identifier.

If the MME or combined MME/SGSN does not support this feature:

  • -The HSS shall not send the External-Identifier subscription data to the MME or combined MME/SGSN within ULA.
  • -The HSS shall not send Monitoring Event configuration for UEs that are part of a group and have no MSISDN as part of its subscription data to the MME/SGSN.
  • -The HSS shall not indicate External-Identifier-Withdrawal in the DSR-Flags AVP of the DSR.
| +| 27 | NR as Secondary RAT | O |

Support of NR as Secondary RAT

This feature is applicable to the ULR/ULA and IDR/IDA command pairs over S6a (and S6d) when the MME (or combined MME/SGSN) supports NR as Secondary RAT, and over S6d when the SGSN supports the indication related to NR as Secondary RAT (such as, e.g., the related Access Restriction Data, or extended QoS parameters).

If the MME, SGSN, or combined MME/SGSN does not support this feature, the HSS shall not send (in ULA) or update (in IDR) subscription data related to NR as Secondary RAT.

If the HSS does not support this feature, the MME shall ignore the bit "NR as Secondary RAT Not Allowed" in Access-Restriction-Data.

| + +| | | | | +|----|--------------------------------------|---|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 28 | Unlicensed Spectrum as Secondary RAT | O |

Support of Unlicensed Spectrum as Secondary RAT

This feature is applicable to the ULR/ULA and IDR/IDA command pairs over S6a (and S6d) when the MME (or combined MME/SGSN) supports the use of unlicensed spectrum in the form of LAA or LWA/LWIP as Secondary RAT.

If the MME (or combined MME/SGSN) does not support this feature, the HSS shall not send (in ULA) or update (in IDR) subscription data related to the use of unlicensed spectrum in the form of LAA, LWA/LWIP or NR in unlicensed bands as Secondary RAT (such as, e.g., the related Access Restriction Data).

If the HSS does not support this feature, the MME shall ignore the bit "Unlicensed Spectrum as Secondary RAT Not Allowed" in Access-Restriction-Data.

| +| 29 | Ethernet PDN Type APNs | O |

Support of Ethernet PDN Type APNs

This feature is applicable to the ULR/ULA and IDR/IDA command pairs over the S6a and S6d interfaces.

If the MME (or combined MME/SGSN) does not indicate support of this feature in the ULR command, the HSS shall not send APN configurations with an Ethernet PDN type in the subscription data sent in ULA or in IDR, and shall not send IDR commands with the only purpose to update such subscription data.

If the MME (or combined MME/SGSN) indicates in the IDA command that it does not support this feature, and the HSS has already sent Ethernet PDN Type APNs within IDR, the HSS may store this indication, and not send any further updates related to Ethernet PDN Type APNs to that MME (or combined MME/SGSN).

| +| 30 | Extended Reference IDs | O |

Extended Reference IDs

This feature is applicable to the ULR/ULA and IDR/IDA command pairs over the S6a or S6d interfaces, when the HSS and MME/SGSN support handling 64-bit long Reference IDs.

If the MME or SGSN does not indicate support of this feature in ULR, the HSS shall not send ULA or IDR commands containing 64-bit long SCEF Reference IDs or SCEF Reference IDs for Deletion.

| + +Feature bit: The order number of the bit within the Supported-Features AVP, e.g. "1". +Feature: A short name that can be used to refer to the bit and to the feature, e.g. "SMS in MME". +M/O: Defines if the implementation of the feature is mandatory ("M") or optional ("O"). +Description: A clear textual description of the feature. +NOTE 1: If both bits, corresponding to the same feature defined for Lg interface and Lgd interface, are not set, and the HSS supports the feature, the HSS shall not send the related LCS information to the SGSN within ULA and IDR. + +Features that are not indicated in the Supported-Features AVPs within a given application message shall not be used to construct that message. + +### 7.3.10.2 Feature-List AVP for the S7a/S7d application + +For the S7a/S7d application, the feature list does not contain any feature in this release. + +## 7.3.11 Requested-EUTRAN-Authentication-Info + +The Requested-EUTRAN-Authentication-Info is of type Grouped. It shall contain the information related to the authentication requests for E-UTRAN. + +AVP format + +Requested-EUTRAN-Authentication-Info ::= + +[ Number-Of-Requested-Vectors ] + +[ Immediate-Response-Preferred ] + +[ Re-synchronization-Info ] +\*[AVP] + +### 7.3.12 Requested-UTRAN- GERAN-Authentication-Info + +The Requested-UTRAN-GERAN-Authentication-Info is of type Grouped. It shall contain the information related to the authentication requests for UTRAN or GERAN. + +AVP format + +Requested-UTRAN-GERAN-Authentication-Info ::= +[ Number-Of-Requested-Vectors ] +[ Immediate-Response-Preferred ] +[ Re-synchronization-Info ] +\*[AVP] + +### 7.3.13 RAT-Type + +The RAT-Type AVP is of type Enumerated and is used to identify the radio access technology that is serving the UE. See 3GPP TS 29.212 [10] for the defined values. + +3GPP TS 29.212 [10] defines distinct RAT-Type values for EUTRAN (WB-EUTRAN), EUTRAN-NB-IoT and LTE-M; these values shall be used in the signaling between the serving nodes (MME/SGSN) and the HSS, e.g. to determine the corresponding access restrictions for the UE. + +### 7.3.14 Number-Of-Requested-Vectors + +The Number-Of-Requested-Vectors AVP is of type Unsigned32. This AVP shall contain the number of AVs the MME or SGSN is prepared to receive. + +### 7.3.15 Re-Synchronization-Info + +The Re-Synchronization-Info AVP is of type OctetString. It shall contain the concatenation of RAND and AUTS. + +### 7.3.16 Immediate-Response-Preferred + +The Immediate-Response-Preferred AVP is of type Unsigned32. This optional AVP indicates by its presence that immediate response is preferred, and by its absence that immediate response is not preferred. If present, the value of this AVP is not significant. + +When EUTRAN-AVs and UTRAN-AVs or GERAN-AVs are requested, presence of this AVP within the Requested-EUTRAN-Authentication-Info AVP shall indicate that EUTRAN-AVs are requested for immediate use in the MME/SGSN; presence of this AVP within the Requested-UTRAN-GERAN-Authentication-Info AVP shall indicate that UTRAN-AVs or GERAN-AVs are requested for immediate use in the MME/SGSN. It may be used by the HSS to determine the number of vectors to be obtained from the AuC and the number of vectors downloaded to the MME or SGSN. + +### 7.3.17 Authentication-Info + +The Authentication-Info AVP is of type Grouped. This AVP contains Authentication Vectors. + +AVP format: + +Authentication-Info ::= +\*[ E-UTRAN-Vector ] + +\*[UTRAN-Vector] + +\*[GERAN-Vector] + +\*[AVP] + +### 7.3.18 E-UTRAN-Vector + +The E-UTRAN-Vector AVP is of type Grouped. This AVP shall contain an E-UTRAN Vector. + +AVP format: + +E-UTRAN-Vector ::= + +[ Item-Number ] + +{ RAND } + +{ XRES } + +{ AUTN } + +{ KASME } + +\*[AVP] + +### 7.3.19 UTRAN-Vector + +The UTRAN-Vector AVP is of type Grouped. This AVP shall contain an UTRAN Vector. + +AVP format: + +UTRAN-Vector ::= + +[ Item-Number ] + +{ RAND } + +{ XRES } + +{ AUTN } + +{ Confidentiality-Key } + +{ Integrity-Key } + +\*[AVP] + +### 7.3.20 GERAN-Vector + +The GERAN-Vector AVP is of type Grouped. This AVP shall contain a GERAN Vector. + +AVP format: + +GERAN-Vector ::= + +[ Item-Number ] + +{ RAND } + +{ SRES } + +{ Kc } + +\*[AVP] + +### 7.3.21 Network-Access-Mode + +The Network-Access-Mode AVP is of type Enumerated. The following values are defined: + +PACKET\_AND\_CIRCUIT (0) + +Reserved (1) + +ONLY\_PACKET (2) + +### 7.3.22 HPLMN-ODB + +The HPLMN-ODB AVP is of type Unsigned32 and it shall contain a bit mask indicating the HPLMN specific services of a subscriber that are barred by the operator. The meaning of the bits is HPLMN specific: + +**Table 7.3.22/1: HPLMN-ODB** + +| Bit | Description | +|-----|-------------------------------| +| 0 | HPLMN specific barring type 1 | +| 1 | HPLMN specific barring type 2 | +| 2 | HPLMN specific barring type 3 | +| 3 | HPLMN specific barring type 4 | + +HPLMN-ODB may apply to mobile originated short messages; See 3GPP TS 23.015 [36]. + +### 7.3.23 Item-Number + +The Item-Number AVP is of type Unsigned32. The Item Number is used to order Vectors received within one request. + +### 7.3.24 Cancellation-Type + +The Cancellation-Type AVP is of type Enumerated and indicates the type of cancellation. The following values are defined: + +MME\_UPDATE\_PROCEDURE (0) + +This value is used when the Cancel Location is sent to the previous MME due to a received Update Location message from a new MME or due to the HSS+UDM receiving an Nudm\_UEContextManagement service request from the AMF or due to the HSS receiving Nhss\_UECM\_SNDeregistration service operation from UDM (see clause 5.4.2.2 of 3GPP TS 29.563 [70]). + +SGSN\_UPDATE\_PROCEDURE (1) + +This value is used when the Cancel Location is sent to the previous SGSN due to a received Update Location message from a new SGSN or due to the HSS+UDM receiving an Nudm\_UEContextManagement service request from the AMF or due to the HSS receiving Nhss\_UECM\_SNDeregistration service operation from UDM (see clause 5.4.2.2 of 3GPP TS 29.563 [70]). + +SUBSCRIPTION\_WITHDRAWAL (2) + +This value is used: + +- when the Cancel Location is sent by the HSS to the current MME or SGSN due to withdrawal of the user's subscription by the HSS operator; +- when the Cancel VCSG Location is sent by the CSS to the current MME or SGSN due to withdrawal of the user's VPLMN CSG subscription by the CSS operator. + +UPDATE\_PROCEDURE\_IWF (3) + +This value is used by an IWF when interworking with a pre-Rel-8 HSS. + +INITIAL\_ATTACH\_PROCEDURE (4) + +This value is used when the Cancel Location is sent to the MME or SGSN due to a received Update Location message during initial attach procedure from an SGSN or MME respectively. + +### 7.3.25 DSR-Flags + +The DSR-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits is defined in table 7.3.25/1: + +**Table 7.3.25/1: DSR-Flags** + +| Bit | Name | Description | +|-----|------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | Regional Subscription Withdrawal | This bit, when set, indicates that Regional Subscription shall be deleted from the subscriber data. | +| 1 | Complete APN Configuration Profile Withdrawal | This bit, when set, indicates that all EPS APN configuration data for the subscriber shall be deleted from the subscriber data. This flag only applies to the S6d interface. | +| 2 | Subscribed Charging Characteristics Withdrawal | This bit, when set, indicates that the Subscribed Charging Characteristics have been deleted from the subscription data. | +| 3 | PDN subscription contexts Withdrawal | This bit, when set, indicates that the PDN subscription contexts whose identifier is included in the Context-Identifier AVP shall be deleted.
(Note 1) | +| 4 | STN-SR | This bit, when set, indicates that the Session Transfer Number for SRVCC shall be deleted from the subscriber data. | +| 5 | Complete PDP context list Withdrawal | This bit, when set, indicates that all PDP contexts for the subscriber shall be deleted from the subscriber data. | +| 6 | PDP contexts Withdrawal | This bit, when set, indicates that the PDP contexts whose identifier is included in the Context-Identifier AVP shall be deleted.
(Note 2) | +| 7 | Roaming Restricted due to unsupported feature | This bit, when set, indicates that the roaming restriction shall be deleted from the subscriber data in the MME or SGSN. | +| 8 | Trace Data Withdrawal | This bit, when set, indicates that the Trace Data shall be deleted from the subscriber data. | +| 9 | CSG Deleted | This bit, when set, indicates that
  • - the "CSG-Subscription-Data from HSS" shall be deleted in the MME or SGSN when received over the S6a or S6d interface
  • - the "CSG-Subscription-Data from CSS" shall be deleted in the MME or SGSN when received over the S7a or S7d interface.
| +| 10 | APN-OI-Replacement | This bit, when set, indicates that the UE level APN-OI-Replacement shall be deleted from the subscriber data. | +| 11 | GMLC List Withdrawal | This bit, when set, indicates that the subscriber's LCS GMLC List shall be deleted from the MME or SGSN. | +| 12 | LCS Withdrawal | This bit, when set, indicates that the LCS service whose code is included in the SS-Code AVP shall be deleted from the MME or SGSN. | +| 13 | SMS Withdrawal | This bit, when set, indicates that the SMS service whose code is included in the SS-Code AVP or TS-Code AVP shall be deleted from the MME or SGSN. | +| 14 | Subscribed periodic RAU-TAU Timer Withdrawal | This bit, when set, indicates that the subscribed periodic RAU TAU Timer value shall be deleted from the subscriber data. | +| 15 | Subscribed VSRVCC Withdrawal | This bit, when set, indicates that the Subscribed VSRVCC shall be deleted from the subscriber data. | +| 16 | A-MSISDN Withdrawal | This bit, when set, indicates that the additional MSISDN, if present, shall be deleted from the subscriber data. | +| 17 | ProSe Withdrawal | This bit, when set, indicates that the ProSe subscription data shall be deleted from the MME or combined MME/SGSN. | +| 18 | Reset-IDs | This bit, when set, indicates that the set of Reset-IDs shall be deleted from the MME or SGSN. | +| 19 | DL-Buffering-Suggested-Packet-Count Withdrawal | This bit, when set, indicates that the DL-Buffering-Suggested-Packet-Count shall be deleted in the MME or SGSN. | +| 20 | Subscribed IMSI-Group-Id Withdrawal | This bit, when set, indicates that all subscribed IMSI-Group-Id(s) shall be deleted in the MME or SGSN. | +| 21 | Delete monitoring events | This bit when set indicates to the MME or SGSN to delete all the Monitoring events for the subscriber which are associated with the provided SCEF-ID. | + +| | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------| +| 22 | User Plane Integrity Protection Withdrawal | This bit, when set, indicates to the SGSN that User Plane Integrity Protection may no longer be required when GERAN is used. The MME shall ignore it. | +| 23 | MSISDN Withdrawal | This bit, when set, indicates that the MSISDN shall be deleted from the subscriber data. | +| 24 | UE Usage Type Withdrawal | This bit, when set, indicates to the MME or SGSN that the UE Usage Type shall be deleted from the subscription data. | +| 25 | V2X Withdrawal | This bit, when set, indicates that the V2X subscription data shall be deleted from the MME or combined MME/SGSN. | +| 26 | External-Identifier-Withdrawal | This bit, when set, indicates that the External-Identifier shall be deleted from the subscriber data. | +| 27 | Aerial-UE-Subscription Withdrawal | This bit, when set, indicates that the Aerial UE subscription shall be deleted from the subscriber data. | +| 28 | Paging Time Window Subscription Withdrawal | This bit, when set, indicates that the Paging Time Window subscription shall be deleted from the subscriber data. | +| 29 | Active-Time-Withdrawal | This bit, when set, indicates that the Active Time used for PSM shall be deleted from the subscriber data. | +| 30 | eDRX-Cycle-Length -Withdrawal | This bit, when set, indicates that the eDRX-Cycle-Length shall be deleted from the subscriber data. | +| 31 | Service-Gap-Time-Withdrawal | This bit, when set, indicates that the Service Gap Time shall be deleted from the subscriber data. | +| Note 1: If the Complete APN Configuration Profile Withdrawal bit is set, this bit should not be set.
Note 2: If the Complete PDP context list Withdrawal bit is set, this bit should not be set.
Note 3: Bits not defined in this table shall be cleared by the sending HSS and discarded by the receiving MME or SGSN.
Note 4: Bits 3 and 6 are excluding alternatives and shall not both be set.
Note 5: When this AVP is transferred over the S7a/S7d interface, only the bit 9 (CSG Deleted) is meaningful, other bits shall be cleared. | | | + +## 7.3.26 DSA-Flags + +The DSA-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits is defined in table 7.3.26/1: + +**Table 7.3.26/1: DSA-Flags** + +| Bit | Name | Description | +|---------------------------------------------------------------------------------------------------------------|------------------------------|--------------------------------------------------------------------------------------------------------------------------------| +| 0 | Network Node area restricted | This bit, when set, shall indicate that the complete Network Node area (SGSN area) is restricted due to regional subscription. | +| Note: Bits not defined in this table shall be cleared by the sending SGSN and discarded by the receiving HSS. | | | + +## 7.3.27 Context-Identifier + +The Context-Identifier AVP is of type Unsigned32. + +## 7.3.28 Void + +## 7.3.29 Subscriber-Status + +The 3GPP Subscriber Status AVP is of type Enumerated. It shall indicate if the service is barred or granted. The following values are defined: + +SERVICE\_GRANTED (0) + +OPERATOR\_DETERMINED\_BARRING (1) + +### 7.3.30 Operator-Determined-Barring + +The Operator-Determined-Barring AVP is of type Unsigned32 and it shall contain a bit mask indicating the services of a subscriber that are barred by the operator. The meaning of the bits is the following: + +**Table 7.3.30/1: Operator-Determined-Barring** + +| Bit | Description | +|-----|--------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | All Packet Oriented Services Barred | +| 1 | Roamer Access HPLMN-AP Barred | +| 2 | Roamer Access to VPLMN-AP Barred | +| 3 | Barrying of all outgoing calls | +| 4 | Barrying of all outgoing international calls | +| 5 | Barrying of all outgoing international calls except those directed to the home PLMN country | +| 6 | Barrying of all outgoing inter-zonal calls | +| 7 | Barrying of all outgoing inter-zonal calls except those directed to the home PLMN country | +| 8 | Barrying of all outgoing international calls except those directed to the home PLMN country and Barrying of all outgoing inter-zonal calls | + +### 7.3.31 Access-Restriction-Data + +The Access-Restriction-Data AVP is of type Unsigned32 and it shall contain a bit mask where each bit when set to 1 indicates a restriction. The meaning of the bits is the following: + +**Table 7.3.31/1: Access-Restriction-Data** + +| Bit | Description | +|-------------------------------------------------------------------------------------------------------------|--------------------------------------------------| +| 0 | UTRAN Not Allowed | +| 1 | GERAN Not Allowed | +| 2 | GAN Not Allowed | +| 3 | I-HSPA-Evolution Not Allowed | +| 4 | WB-E-UTRAN Not Allowed | +| 5 | HO-To-Non-3GPP-Access Not Allowed | +| 6 | NB-IoT Not Allowed | +| 7 | Enhanced Coverage Not Allowed | +| 8 | NR as Secondary RAT in E-UTRAN Not Allowed | +| 9 | Unlicensed Spectrum as Secondary RAT Not Allowed | +| 10 | NR in 5GS Not Allowed | +| 11 | LTE-M Not Allowed | +| 12 | WB-E-UTRAN Except LTE-M Not Allowed | +| NOTE 1: Bits not defined in this table shall be cleared by the HSS and discarded by the receiving MME/SGSN. | | +| NOTE 2: Bits 11 and 12 are only used when bit 4 is not set. | | + +The restriction "HO-To-Non-3GPP-Access Not Allowed" shall take a higher precedence than the APN-level parameter "WLAN-Offloadability" (see clause 7.3.181). + +### 7.3.32 APN-OI-Replacement + +The APN-OI-Replacement AVP is of type UTF8String. This AVP shall indicate the domain name to replace the APN OI for the non-roaming case and the home routed roaming case when constructing the APN, and the APN-FQDN upon which to perform a DNS resolution. See 3GPP TS 23.003 [3] and 3GPP TS 29.303 [38]. + +The contents of the APN-OI-Replacement AVP shall be formatted as a character string composed of one or more labels separated by dots ("."). + +### 7.3.33 All-APN-Configurations-Included-Indicator + +The All-APN-Configurations-Included-Indicator AVP is of type Enumerated. The following values are defined: + +ALL\_APN\_CONFIGURATIONS\_INCLUDED (0) + +MODIFIED\_ADDED\_APN\_CONFIGURATIONS\_INCLUDED (1) + +### 7.3.34 APN-Configuration-Profile + +The APN-Configuration-Profile AVP is of type Grouped. It shall contain the information related to the user's subscribed APN configurations for EPS. + +The AVP format shall conform to: + +``` +APN-Configuration-Profile ::= + { Context-Identifier } + [ Additional-Context-Identifier ] + [ Third-Context-Identifier ] + { All-APN-Configurations-Included-Indicator } + 1*{APN-Configuration} + *[AVP] +``` + +The Subscription-Data AVP associated with an IMSI contains one APN-Configuration-Profile AVP. + +Each APN-Configuration-Profile AVP contains one or more APN-Configuration AVPs. + +Each APN-Configuration AVP describes the configuration for a single APN. + +Therefore, the cardinality of the relationship between IMSI and APN is one-to-many. + +The Context-Identifier AVP shall identify the per subscriber's default APN configuration. + +If present, the Additional-Context-Identifier AVP shall identify another default APN configuration, only for those subscriptions containing more than one types of APNs i.e. among APNs with an IP-based PDN type, APNs with a Non-IP PDN type, and APNs with an Ethernet PDN type; in this case, each of those two default APN configurations shall have a different PDN type category (e.g. one default APN with an IP-based PDN type, and another default APN with a Non-IP PDN type). + +If present, the Third-Context-Identifier AVP shall identify another default APN configuration, only for those subscriptions containing more than two types of APNs i.e. among APNs with an IP-based PDN type, APNs with a Non-IP PDN type, and APNs with an Ethernet PDN type; in this case, each of those three default APN configurations shall have a different PDN type category (i.e. one default APN with an IP-based PDN type, and another default APN with a Non-IP PDN type and one default APN with an Ethernet PDN type). + +### 7.3.35 APN-Configuration + +The APN-Configuration AVP is of type Grouped. It shall contain the information related to the user's subscribed APN configurations. The Context-Identifier in the APN-Configuration AVP shall identify that APN configuration, and it shall not have a value of zero. Furthermore, the Context-Identifier in the APN-Configuration AVP shall uniquely identify the EPS APN configuration per subscription. For a particular EPS user having multiple APN configurations, the Service-Selection AVP values shall be unique across APN-Configuration AVPs. + +The AVP format shall conform to: + +APN-Configuration ::= + +``` +{ Context-Identifier } +* 2 [ Served-Party-IP-Address ] +{ PDN-Type } +{ Service-Selection } +[ EPS-Subscribed-QoS-Profile ] +[ VPLMN-Dynamic-Address-Allowed ] +[ MIP6-Agent-Info ] +[ Visited-Network-Identifier ] +[ PDN-GW-Allocation-Type ] +[ 3GPP-Charging-Characteristics ] +[ AMBR ] +*[ Specific-APN-Info ] +[ APN-OI-Replacement ] +[ SIPTO-Permission ] +[ LIPA-Permission ] +[ Restoration-Priority ] +[ SIPTO-Local-Network-Permission ] +[ WLAN-offloadability ] +[ Non-IP-PDN-Type-Indicator ] +[ Non-IP-Data-Delivery-Mechanism ] +[ SCEF-ID ] +[ SCEF-Realm ] +[ Preferred-Data-Mode ] +[ PDN-Connection-Continuity ] +[ RDS-Indicator ] +[ Interworking-5GS-Indicator ] +[ Ethernet-PDN-Type-Indicator ] +*[ AVP ] +``` + +The AMBR included in this grouped AVP shall include the AMBR associated to this specific APN configuration (APN-AMBR). + +The Served-Party-IP-Address AVP may be present 0, 1 or 2 times. These AVPs shall be present if static IP address allocation is used for the UE, and they shall contain either of: + +- an IPv4 address, or +- an IPv6 address/prefix, or +- both, an IPv4 address and an IPv6 address/prefix. + +For the IPv6 prefix, the lower 64 bits of the address shall be set to zero. + +The PDN-GW-Allocation-Type AVP applies to the MIP6-Agent-Info AVP. Therefore, it shall not be present if MIP6-Agent-Info is not present. + +The APN-OI-Replacement included in this grouped AVP shall include the APN-OI-Replacement associated with this APN configuration. This APN-OI-Replacement has higher priority than UE level APN-OI-Replacement. + +The Visited-Network-Identifier AVP indicates the PLMN where the PGW was allocated, in case of dynamic PGW assignment. + +NOTE: If interworking with MAP is needed, the Context-Identifier will be in the range of 1 and 50. + +The Non-IP-Data-Delivery-Mechanism shall only be present when Non-IP-PDN-Type-Indicator is set to TRUE (1). + +The SCEF-ID AVP and the SCEF-Realm AVP shall only be present when Non-IP-PDN-Type-Indicator is set to TRUE (1), and Non-IP-Data-Delivery-Mechanism is set to SCEF-BASED-DATA-DELIVERY (1). + +The RDS-Indicator may be present when Non-IP-PDN-Type-Indicator is set to TRUE (1), and Non-IP-Data-Delivery-Mechanism is set to SCEF-BASED-DATA-DELIVERY (1). + +Absence of PDN-Connection-Continuity AVP indicates that the handling is left to local VPLMN policy. + +### 7.3.36 Service-Selection + +The Service-Selection AVP is of type of UTF8String. This AVP shall contain either the APN Network Identifier (i.e. an APN without the Operator Identifier) per 3GPP TS 23.003 [3], clauses 9.1 & 9.1.1, or this AVP shall contain the wild card value per 3GPP TS 23.003 [3], clause 9.2.1, and 3GPP TS 23.008 [30], clause 2.13.6). + +The contents of the Service-Selection AVP shall be formatted as a character string composed of one or more labels separated by dots ("."), or as the wild card APN, i.e., consisting of only one ASCII label, "\*". + +This AVP is defined in IETF RFC 5778[20]. + +### 7.3.37 EPS-Subscribed-QoS-Profile + +The EPS-Subscribed-QoS-Profile AVP is of type Grouped. It shall contain the bearer-level QoS parameters (QoS Class Identifier and Allocation Retention Priority) associated to the default bearer for an APN (see 3GPP TS 23.401 [2], clause 4.7.3). + +AVP format + +``` +EPS-Subscribed-QoS-Profile ::= + { QoS-Class-Identifier } + { Allocation-Retention-Priority } + *[AVP] +``` + +NOTE: QoS-Class-Identifier is defined in 3GPP TS 29.212 [10] as an Enumerated AVP. The values allowed for this AVP over the S6a/S6d interface are only those associated to non-GBR bearers, as indicated in 3GPP TS 23.008 [30]; e.g., values QCI\_1, QCI\_2, QCI\_3 and QCI\_4, which are associated to GBR bearers, cannot be sent over S6a/S6d. + +### 7.3.38 VPLMN-Dynamic-Address-Allowed + +The VPLMN-Dynamic-Address-Allowed AVP is of type Enumerated. It shall indicate whether for this APN, the UE is allowed to use the PDN GW in the domain of the HPLMN only, or additionally, the PDN GW in the domain of the VPLMN. If this AVP is not present, this means that the UE is not allowed to use PDN GWs in the domain of the VPLMN. The following values are defined: + +NOTALLOWED (0) + +ALLOWED (1) + +### 7.3.39 STN-SR + +The STN-SR AVP is of type OctetString and shall contain the Session Transfer Number for SRVCC. See 3GPP TS 23.003 [3] for the definition of STN-SR. This AVP contains an STN-SR, in international number format as described in ITU-T Rec E.164 [41], encoded as a TBCD-string. See 3GPP TS 29.002 [24] for encoding of TBCD-strings. This AVP shall not include leading indicators for the nature of address and the numbering plan; it shall contain only the TBCD-encoded digits of the address. + +### 7.3.40 Allocation-Retention-Priority + +The Allocation-Retention-Priority AVP is of type Grouped and is defined in 3GPP TS 29.212 [10]. It shall indicate the Priority of Allocation and Retention for the corresponding APN configuration. + +AVP format + +Allocation-Retention-Priority ::= + +{ Priority-Level } + +[ Pre-emption-Capability ] + +[ Pre-emption-Vulnerability ] + +If the Pre-emption-Capability AVP is not present in the Allocation-Retention-Priority AVP, the default value shall be PRE-EMPTION\_CAPABILITY\_DISABLED (1). + +If the Pre-emption-Vulnerability AVP is not present in the Allocation-Retention-Priority AVP, the default value shall be PRE-EMPTION\_VULNERABILITY\_ENABLED (0). + +### 7.3.41 AMBR + +The AMBR AVP is of type Grouped. + +It shall contain the maximum requested bandwidth for Uplink and Downlink traffic. The Max-Requested-Bandwidth-(UL/DL) AVPs shall encode the bandwidth value in bits per second, having an upper limit of 4294967295 bits per second. The Extended-Max-Requested-BW-(UL/DL) AVPs shall encode the bandwidth value in kilobits (1000 bits) per second, having an upper limit of 4294967295 kilobits per second. + +When the maximum bandwidth value to be set for UL (or DL, respectively) traffic is lower than 4294967296 bits per second, the Max-Requested-Bandwidth-UL (or -DL, respectively) AVP shall be present, and set to the requested bandwidth value in bits per second, and the Extended-Max-Requested-BW-UL (or -DL, respectively) AVP shall be absent. + +When the maximum bandwidth value to be set for UL (or DL, respectively) traffic is higher than 4294967295 bits per second, the Max-Requested-Bandwidth-UL (or DL, respectively) AVP shall be present, and set to its upper limit + +4294967295, and the Extended-Max-Requested-BW-UL (or -DL, respectively) shall be present, and set to the requested bandwidth value in kilobits (1000 bits) per second. + +NOTE: The value applicable for Max-Requested-Bandwidth-UL (or DL, respectively) is between 1 and 4294967295 bits per second, and the value applicable for Extended-Max-Requested-BW-UL (or -DL, respectively) is between 4294968 and 4294967295 kilobits per second. The AMBR AVP cannot indicate the requested bandwidth between 4294967296 and 4294967999 bits per second, and any larger value that cannot be represented in the granularity of kilobits per second. + +AVP format + +``` +AMBR ::= + { Max-Requested-Bandwidth-UL } + { Max-Requested-Bandwidth-DL } + [ Extended-Max-Requested-BW-UL ] + [ Extended-Max-Requested-BW-DL ] + *[AVP] +``` + +### 7.3.42 MIP-Home-Agent-Address + +The MIP-Home-Agent-Address AVP is of type Address and is defined in IETF RFC 4004 [27]. This AVP shall contain either IPv4 or IPv6 address of the PDN-GW and this IP address shall be used as the PDN-GW IP address. + +### 7.3.43 MIP-Home-Agent-Host + +The MIP-Home-Agent-Host is of type Grouped and is defined in IETF RFC 4004 [27]. This AVP shall contain a FQDN of the PDN-GW which shall be used to resolve the PDN-GW IP address using the Domain Name Service function. + +MIP-Home-Agent-Host grouped AVP is composed by Destination-Host and Destination-Realm AVPs. + +Destination-Host shall contain the hostname of the PDN-GW, formatted as described in 3GPP TS 29.303 [38], clause 4.3.2. + +Destination-Realm shall be formatted as: + +``` +epc.mnc.mcc.3gppnetwork.org +``` + +where MNC and MCC values indicate the PLMN where the PDN-GW is located. + +### 7.3.44 PDN-GW-Allocation-Type + +The PDN-GW-Allocation-Type AVP is of type Enumerated. It shall indicate whether the PDN GW address included in MIP6-Agent-Info has been statically allocated (i.e. provisioned in the HSS by the operator), or dynamically selected by other nodes. The following values are defined: + +STATIC (0) + +DYNAMIC (1) + +### 7.3.45 MIP6-Agent-Info + +The MIP6-Agent-Info AVP is of type Grouped and is defined in IETF RFC 5447 [26]. This AVP shall contain the identity of the PDN-GW. This AVP is used to convey the identity of the PDN-GW between the MME/SGSN and the HSS regardless of the specific mobility protocol used (GTP or PMIPv6). The identity of PDN-GW is either an IP address transported in MIP-Home-Agent-Address or an FQDN transported in MIP-Home-Agent-Host. FQDN shall be used if known to the MME/SGSN/HSS. + +## AVP format + +``` + +MIP6-Agent-Info ::= < AVP Header: 486 > + *2[ MIP-Home-Agent-Address ] + [ MIP-Home-Agent-Host ] + [ MIP6-Home-Link-Prefix ] + *[ AVP ] + +``` + +Within the MIP6-Agent-Info AVP, if static address allocation is used, there may be either: + +- an IPv4 address or an IPv6 address of the PGW contained in one MIP-Home-Agent-Address AVP; +- both IPv4 address and IPv6 address of the PGW contained in two MIP-Home-Agent-Address AVPs. + +The AVP MIP6-Home-Link-Prefix is not used in S6a/S6d, but it is included here to reflect the complete IETF definition of the grouped AVP. + +### 7.3.46 RAT-Frequency-Selection-Priority-ID + +The RAT-Frequency-Selection-Priority-ID AVP is of type Unsigned32 and shall contain the subscribed value of Subscriber Profile ID for RAT/Frequency Priority. For details, see 3GPP TS 23.401 [2] and 3GPP TS 23.060 [12]. The coding is defined in 3GPP TS 36.413 [19]. Values shall be in the range of 1 to 256. + +### 7.3.47 IDA-Flags + +The IDA-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meanings of the bits are defined in table 7.3.47/1: + +**Table 7.3.47/1: IDA-Flags** + +| Bit | Name | Description | +|---------------------------------------------------------------------------------------------------------------|------------------------------|--------------------------------------------------------------------------------------------------------------------------------| +| 0 | Network Node area restricted | This bit, when set, shall indicate that the complete Network Node area (SGSN area) is restricted due to regional subscription. | +| Note: Bits not defined in this table shall be cleared by the sending SGSN and discarded by the receiving HSS. | | | + +### 7.3.48 PUA-Flags + +The PUA-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meanings of the bits are defined in table 7.3.48/1: + +**Table 7.3.48/1: PUA-Flags** + +| bit | name | Description | +|----------------------------------------------------------------------------------------------------------------------|---------------|---------------------------------------------------------------------------------------------------------------------------| +| 0 | Freeze M-TMSI | This bit, when set, shall indicate to the MME that the M-TMSI needs to be frozen, i.e. shall not be immediately re-used. | +| 1 | Freeze P-TMSI | This bit, when set, shall indicate to the SGSN that the P-TMSI needs to be frozen, i.e. shall not be immediately re-used. | +| Note: Bits not defined in this table shall be cleared by the sending HSS and discarded by the receiving MME or SGSN. | | | + +### 7.3.49 NOR-Flags + +The NOR-Flags AVP is of type Unsigned32 and it contains a bit mask. The meaning of the bits is defined in table 7.3.49/1: + +**Table 7.3.49/1: NOR-Flags** + +| bit | name | Description | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | Single-Registration-Indication | This bit, when set, indicates that the HSS shall send Cancel Location to the SGSN. An SGSN shall not set this bit when sending NOR. | +| 1 | SGSN area restricted | This bit, when set, shall indicate that the complete SGSN area is restricted due to regional subscription. | +| 2 | Ready for SM from SGSN | This bit, when set, shall indicate that the UE is present or the UE has memory capacity available to receive one or more short messages via SGSN. | +| 3 | UE Reachable from MME | This bit, when set, shall indicate that the UE has become reachable again from MME. | +| 4 | Reserved | The use of this bit is deprecated. This bit shall be discarded by the receiving HSS. | +| 5 | UE Reachable from SGSN | This bit, when set, shall indicate that the UE has become reachable again from SGSN. | +| 6 | Ready for SM from MME | This bit, when set, shall indicate that the UE is present or the UE has memory capacity available to receive one or more short messages via MME. | +| 7 | Homogeneous Support of IMS Voice Over PS Sessions | This bit, when set, shall indicate that the Homogeneous Support of IMS Voice Over PS Sessions is updated. | +| 8 | S6a/S6d-Indicator | This bit, when set, shall indicate that the NOR message is sent on the S6a interface, i.e. the message is from the MME or the MME part on the combined MME/SGSN.
This bit, when cleared, indicates that the NOR message is sent on the S6d interface, i.e. the message is from the SGSN or the SGSN part on the combined MME/SGSN. | +| 9 | Removal of MME Registration for SMS | This bit, when set, shall indicate that the MME requests to remove its registration for SMS. | +| NOTE 1: The S6a/S6d-Indicator flag shall be used together with Homogeneous Support of IMS Voice Over PS Sessions flag, i.e. if the Homogeneous Support of IMS Voice Over PS Sessions bit is set, the S6a/S6d-Indicator bit shall be set if the message is sent from the MME or the MME part on the combined MME/SGSN, and shall be cleared if the message is sent from the SGSN or the SGSN part on the combined MME/SGSN. This S6a/S6d-Indicator bit shall be discarded by the receiving HSS if the Homogeneous Support of IMS Voice Over PS Sessions bit is not set. | | | +| NOTE 2: Bits not defined in this table shall be cleared by the sending MME or SGSN and discarded by the receiving HSS. | | | + +### 7.3.50 User-Id + +The User-Id AVP shall be of type UTF8String. It shall contain the leading digits of an IMSI (i.e. MCC, MNC, leading digits of MSIN, see 3GPP TS 23.003 [3], clause 2.2) formatted as a character string. Within a HSS, a User-Id identifies a set of subscribers, each with identical leading IMSI digits. + +### 7.3.51 Equipment-Status + +The Equipment-Status AVP is of type Enumerated, and shall contain the status of the mobile equipment. The following values are defined: + +WHITELISTED (0) + +BLACKLISTED (1) + +GREYLISTED (2) + +### 7.3.52 Regional-Subscription-Zone-Code + +The Regional-Subscription-Zone-Code AVP is of type OctetString. It shall contain a Zone Code (ZC) as defined in 3GPP TS 23.003 [3], clause 4.4. Up to 10 Zone Codes per VPLMN can be defined as part of the user's subscription data. + +NOTE 1: Each zone code represents a collection of tracking area or routing areas (defined by the operator of the VPLMN) where the user is allowed, or disallowed, to roam. The determination of which areas are actually allowed, and which ones are not allowed, is done by the serving node (MME/SGSN) in an implementation-dependent manner. + +NOTE 2: The description of RSZI in 3GPP TS 23.003 [3] is applicable, in the context of this specification, not only to location areas, but also to routing and tracking areas. + +### 7.3.53 RAND + +The RAND AVP is of type OctetString. This AVP shall contain the RAND. See 3GPP TS 33.401 [5]. + +### 7.3.54 XRES + +The XRES AVP is of type OctetString. This AVP shall contain the XRES. See 3GPP TS 33.401 [5]. + +### 7.3.55 AUTN + +The AUTN AVP is of type OctetString. This AVP shall contain the AUTN. See 3GPP TS 33.401 [5]. + +### 7.3.56 KASME + +The KASME AVP is of type OctetString. This AVP shall contain the K\_ASME. See 3GPP TS 33.401 [5]. + +### 7.3.57 Confidentiality-Key AVP + +The Confidentiality-Key is of type OctetString, and shall contain the Confidentiality Key (CK). + +### 7.3.58 Integrity-Key AVP + +The Integrity-Key is of type OctetString, and shall contain the Integrity Key (IK). + +### 7.3.59 Kc AVP + +The Kc AVP is of type OctetString, and shall contain the Ciphering Key (Kc). + +### 7.3.60 SRES + +The SRES AVP is of type OctetString. This AVP shall contain the SRES. See 3GPP TS 33.102 [18]. + +### 7.3.61 Void + +### 7.3.62 PDN-Type + +The PDN-Type AVP is of type Enumerated and indicates the address type of the PDN, when it is IP-based. + +NOTE: There are certain PDNs that can be accessed without using IP. These are identified by a specific PDN type indicator in their APN configuration settings (e.g. see clauses 7.3.204 and 7.3.232). + +The following values are defined: + +IPv4 (0) + +This value shall be used to indicate that the PDN can be accessed only in IPv4 mode. + +IPv6 (1) + +This value shall be used to indicate that the PDN can be accessed only in IPv6 mode. + +IPv4v6 (2) + +This value shall be used to indicate that the PDN can be accessed both in IPv4 mode, in IPv6 mode, and also from UEs supporting dualstack IPv4v6. + +IPv4\_OR\_IPv6 (3) + +This value shall be used to indicate that the PDN can be accessed either in IPv4 mode, or in IPv6 mode, but not from UEs supporting dualstack IPv4v6. It should be noted that this value will never be used as a requested PDN Type from the UE, since UEs will only use one of their supported PDN Types, i.e., IPv4 only, IPv6 only or IPv4v6 (dualstack). This value is only used as part of the APN subscription context, as an authorization mechanism between HSS and MME. + +### 7.3.63 Trace-Data AVP + +The Trace-Data AVP is of type Grouped. This AVP shall contain the information related to trace function. + +AVP format + +Trace-Data ::= + +{Trace-Reference} +{Trace-Depth} +{Trace-NE-Type-List} +[Trace-Interface-List] +{Trace-Event-List} +[OMC-Id] +{Trace-Collection-Entity} +[MDT-Configuration] +\*[AVP] + +### 7.3.64 Trace-Reference AVP + +The Trace-Reference AVP is of type OctetString. This AVP shall contain the concatenation of MCC, MNC and Trace ID, where the Trace ID is a 3 byte Octet String. See 3GPP TS 32.422 [23]. + +The content of this AVP shall be encoded as octet strings according to table 7.3.64/1. + +See 3GPP TS 24.008 [31], clause 10.5.1.13, PLMN list, for the coding of MCC and MNC. If MNC is 2 digits long, bits 5 to 8 of octet 2 are coded as "1111". + +**Table 7.3.64/1: Encoding format for Trace-Reference AVP** + +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +|----------|---|---|---|-------------|---|---|---|-------------| +| | | | | MCC digit 2 | | | | MCC digit 1 | +| | | | | MNC digit 3 | | | | MCC digit 3 | +| | | | | MNC digit 2 | | | | MNC digit 1 | +| Trace ID | | | | | | | | octet 4 | +| | | | | | | | | octet 5 | +| | | | | | | | | octet 6 | + +### 7.3.65 Void + +### 7.3.66 Void + +### 7.3.67 Trace-Depth AVP + +The Trace-Depth AVP is of type Enumerated. The possible values are those defined in 3GPP TS 32.422 [23] for Trace Depth. + +### 7.3.68 Trace-NE-Type-List AVP + +The Trace-NE-Type-List AVP is of type OctetString. Octets are coded according to 3GPP TS 32.422 [23]. + +### 7.3.69 Trace-Interface-List AVP + +The Trace-Interface-List AVP is of type OctetString. Octets are coded according to 3GPP TS 32.422 [23]. + +### 7.3.70 Trace-Event-List AVP + +The Trace-Event-List AVP is of type OctetString. Octets are coded according to 3GPP TS 32.422 [23]. + +### 7.3.71 OMC-Id AVP + +The OMC-Id AVP is of type OctetString. Octets are coded according to 3GPP TS 29.002 [24]. + +### 7.3.72 GPRS-Subscription-Data + +The GPRS-Subscription-Data AVP is of type Grouped. It shall contain the information related to the user profile relevant for GPRS. + +AVP format: + +``` +GPRS-Subscription-Data ::= + { Complete-Data-List-Included-Indicator } + 1*50{PDP-Context} + *[AVP] +``` + +NOTE: The max number of PDP-Context AVP aligns with the value of maxNumOfPDP-Contexts as defined in 3GPP TS 29.002 [24]. + +### 7.3.73 Complete-Data-List-Included-Indicator + +The Complete-Data-List-Included-Indicator AVP is of type Enumerated. The following values are defined: + +ALL\_PDP\_CONTEXTS\_INCLUDED (0) + +MODIFIED\_ADDED\_PDP\_CONTEXTS\_INCLUDED (1) + +### 7.3.74 PDP-Context + +The PDP-Context AVP is of type Grouped. For a particular GPRS user having multiple PDP Context configurations, the Service-Selection AVP values may be the same for different PDP-Context AVPs. + +AVP format + +``` +PDP-Context ::= + { Context-Identifier } + { PDP-Type } + [ PDP-Address ] + { QoS-Subscribed } + [ VPLMN-Dynamic-Address-Allowed ] + { Service-Selection } + [3GPP-Charging-Characteristics] + [ Ext-PDP-Type ] + [ Ext-PDP-Address ] + [ AMBR ] + [ APN-OI-Replacement ] + [ SIPTO-Permission ] + [ LIPA-Permission ] + [ Restoration-Priority ] + [ SIPTO-Local-Network-Permission ] + [ Non-IP-Data-Delivery-Mechanism ] + [ SCEF-ID ] + *[AVP] +``` + +The Ext-PDP-Address AVP may be present only if the PDP-Address AVP is present. If the Ext-PDP-Address AVP is present, then it shall not contain the same address type (IPv4 or IPv6) as the PDP-Address AVP. + +When PDP-Type takes the value Non-IP (HEX 02), the Ext-PDP-Type AVP shall be absent. + +The AMBR included in this grouped AVP shall include the AMBR associated to the APN included in the PDP-Context AVP (APN-AMBR). + +The APN-OI-Replacement included in this grouped AVP shall include the APN-OI-Replacement associated to the APN included in the PDP-Context. This APN-OI-Replacement has higher priority than UE level APN-OI-Replacement. + +The Non-IP-Data-Delivery-Mechanism shall only be present when PDP-Type takes the value Non-IP (HEX 02). + +The SCEF-ID shall only be present when Non-IP-Data-Delivery-Mechanism takes the value SCEF-BASED-DATA-DELIVERY (1). + +### 7.3.75 PDP-Type + +The PDP-Type AVP is of type OctetString. Octets are coded according to 3GPP TS 29.002 [24]. The allowed values are one of IPv4 encoded as HEX (21) or IPv6 encoded as HEX (57) or Non-IP encoded as HEX (02). + +### 7.3.75A Ext-PDP-Type + +The Ext-PDP-Type AVP is of type OctetString. Octets are coded according to 3GPP TS 29.002 [24] and 3GPP TS 29.060 [39] and shall contain the value of IPv4v6. + +### 7.3.76 Void + +### 7.3.77 QoS-Subscribed + +The QoS-Subscribed AVP is of type OctetString. Octets are coded according to 3GPP TS 29.002 [24] (octets of QoS-Subscribed, Ext-QoS-Subscribed, Ext2-QoS-Subscribed, Ext3-QoS-Subscribed and Ext4-QoS-Subscribed values are concatenated). + +### 7.3.78 CSG-Subscription-Data + +The CSG-Subscription-Data AVP is of type Grouped. This AVP shall contain the CSG-Id, and may contain the associated Visited-PLMN-Id, an associated expiration date and the APNs which are allowed to be accessed via Local IP Access from the CSG. + +If the Visited-PLMN-Id is not present, the CSG-Subscription-Data corresponds to the registered PLMN (i.e. the visited PLMN) of the MME or the SGSN. + +AVP format + +``` + +CSG-Subscription-Data ::= + { CSG-Id } + [ Expiration-Date ] + *[ Service-Selection ] + [ Visited-PLMN-Id ] + *[AVP] + +``` + +### 7.3.79 CSG-Id + +The CSG-Id AVP is of type Unsigned32. Values are coded according to 3GPP TS 23.003 [3]. Unused bits (least significant) shall be padded with zeros. + +### 7.3.80 Expiration-Date + +The Expiration-Date AVP is of type Time (see IETF RFC 6733 [61]) and contains the point in time when subscription to the CSG-Id expires. + +### 7.3.81 Roaming-Restricted-Due-To-Unsupported-Feature + +The Roaming-Restricted-Due-To-Unsupported-Feature AVP is of type Enumerated and indicates that roaming is restricted due to unsupported feature. The following value is defined: + +Roaming-Restricted-Due-To-Unsupported-Feature (0) + +### 7.3.82 Specific-APN-Info AVP + +The Specific-APN-Info AVP is of type Grouped. It shall only be present in the APN configuration when the APN is a wild card APN. It shall contain the APN which is not present in the subscription context but the UE is authorized to connect to and the identity of the registered PDN-GW. + +The AVP format shall conform to: + +``` +Specific-APN-Info ::= + { Service-Selection } + { MIP6-Agent-Info } + [ Visited-Network-Identifier ] + *[ AVP ] +``` + +### 7.3.83 Alert-Reason AVP + +The Alert-Reason AVP is of type Enumerated. The following values are defined: + +UE\_PRESENT (0) + +UE\_MEMORY\_AVAILABLE (1) + +### 7.3.84 LCS-Info + +The LCS-Info AVP is of type Grouped. This AVP shall contain the following LCS related information for a subscriber: + +- list of GMLCs in the HPLMN that are permitted to issue a call/session unrelated or call/session related MT-LR location request for this UE; +- privacy exception list that is applicable only over the S6d interface; +- MO-LR list. + +AVP format + +``` +LCS-Info ::= + *[ GMLC-Number ] + *[ LCS-PrivacyException ] + *[ MO-LR ] + *[AVP] +``` + +### 7.3.85 GMLC-Number + +The GMLC-Number AVP is of type OctetString. This AVP shall contain the ISDN number of the GMLC in international number format as described in ITU-T Rec E.164 [41] and shall be encoded as a TBCD-string. See 3GPP TS 29.002 [24] for encoding of TBCD-strings. This AVP shall not include leading indicators for the nature of address and the numbering plan; it shall contain only the TBCD-encoded digits of the address. + +### 7.3.86 LCS-PrivacyException + +The LCS-PrivacyException AVP is of type Grouped. This AVP shall contain the classes of LCS Client that are allowed to locate any target UE. + +AVP format + +``` +LCS-PrivacyException ::= + { SS-Code } + { SS-Status } + [ Notification-To-UE-User ] + *[ External-Client ] + *[ PLMN-Client ] + *[ Service-Type ] + *[AVP] +``` + +### 7.3.87 SS-Code + +The SS-Code AVP is of type OctetString. Octets are coded according to 3GPP TS 29.002 [24]. + +### 7.3.88 SS-Status + +The SS-Status AVP is of type OctetString. Octets are coded according to 3GPP TS 29.002 [24]. For details, see 3GPP TS 23.011 [29]. + +### 7.3.89 Notification-To-UE-User + +The Notification- To-UE-User AVP is of type Enumerated. The following values are defined: + +``` +NOTIFY_LOCATION_ALLOWED (0) +NOTIFYANDVERIFY_LOCATION_ALLOWED_IF_NO_RESPONSE (1) +NOTIFYANDVERIFY_LOCATION_NOT_ALLOWED_IF_NO_RESPONSE (2) +LOCATION_NOT_ALLOWED (3) +``` + +### 7.3.90 External-Client + +The External-Client AVP is of type Grouped. This AVP shall contain the identities of the external clients that are allowed to locate a target UE for a MT-LR. + +AVP format + +``` +External-Client ::= + { Client-Identity } + [ GMLC-Restriction ] + [ Notification-To-UE-User ] + *[AVP] +``` + +### 7.3.91 Client-Identity + +The Client-Identity AVP is of type OctetString and it shall contain the ISDN number of the external client in international number format as described in ITU-T Rec E.164 [41] and shall be encoded as a TBCD-string. See 3GPP TS 29.002 [24] for encoding of TBCD-strings. This AVP shall not include leading indicators for the nature of address and the numbering plan; it shall contain only the TBCD-encoded digits of the address. + +### 7.3.92 GMLC-Restriction + +The GMLC-Restriction AVP is of type Enumerated. The following values are defined: + +GMLC\_LIST (0) + +HOME\_COUNTRY (1) + +### 7.3.93 PLMN-Client + +The PLMN-Client AVP is of type Enumerated. The following values are defined: + +BROADCAST\_SERVICE (0) + +O\_AND\_M\_HPLMN (1) + +O\_AND\_M\_VPLMN (2) + +ANONYMOUS\_LOCATION (3) + +TARGET\_UE\_SUBSCRIBED\_SERVICE (4) + +### 7.3.94 Service-Type + +The Service-Type AVP is of type Grouped. This AVP shall contain the identities of the service type of the clients that are allowed to locate a target UE for an MT-LR. + +AVP format + +Service-Type ::= + +{ ServiceTypeIdentity } + +[ GMLC-Restriction ] + +[ Notification-To-UE-User ] + +\*[AVP] + +### 7.3.95 ServiceTypeIdentity + +The ServiceTypeIdentity AVP is of type Unsigned32. For details on the values of this AVP, see 3GPP TS 29.002 [24]. + +### 7.3.96 MO-LR + +The MO-LR AVP is of type Grouped. This AVP shall contain the classes of MO-LR for which a subscription exists for a particular UE. + +AVP format + +MO-LR ::= + +{ SS-Code } + +{ SS-Status } + +\*[AVP] + +### 7.3.97 Void + +### 7.3.98 Trace-Collection-Entity AVP + +The Trace-Collection-Entity AVP is of type Address and contains the IPv4 or IPv6 address of the Trace Collection Entity, as defined in 3GPP TS 32.422 [23], clause 5.9. + +### 7.3.99 Teleservice-List + +The Teleservice-List AVP is of type Grouped. This AVP shall contain the service codes for the short message related teleservice for a subscriber: + +AVP format + +Teleservice-List ::= + +1 \* { TS-Code }\*[ AVP ] + +### 7.3.100 TS-Code + +The TS-Code AVP is of type OctetString. Octets are coded according to 3GPP TS 29.002 [24]. + +### 7.3.101 Call-Barring-Info + +The Call-Barring-Info AVP is of type Grouped. This AVP shall contain the service codes for the short message related call barring services for a subscriber: + +AVP format + +Call-Barring-Info ::= + +{ SS-Code } + +{ SS-Status } + +\*[ AVP ] + +### 7.3.102 SGSN-Number + +The SGSN-Number AVP is of type OctetString and it shall contain the ISDN number of the SGSN. For further details on the definition of this AVP, see 3GPP TS 23.003 [3]. This AVP contains an SGSN-Number in international number format as described in ITU-T Rec E.164 [41] and shall be encoded as a TBCD-string. See 3GPP TS 29.002 [24] for encoding of TBCD-strings. This AVP shall not include leading indicators for the nature of address and the numbering plan; it shall contain only the TBCD-encoded digits of the address. + +### 7.3.103 IDR-Flags + +The IDR-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 7.3.103/1: + +**Table 7.3.103/1: IDR-Flags** + +| bit | name | Description | +|----------------------------------------------------------------------------------------------------------------------|----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | UE Reachability Request | This bit when set shall indicate to the MME or the SGSN that the HSS is awaiting a Notification of UE Reachability. | +| 1 | T-ADS Data Request | This bit, when set, shall indicate to the MME or SGSN that the HSS requests the support status of "IMS Voice over PS Sessions", and the RAT Type and timestamp of the last radio contact with the UE. | +| 2 | EPS User State Request | This bit, when set, shall indicate to the MME or the SGSN that the HSS requests the MME or the SGSN for the current user state. | +| 3 | EPS Location Information Request | This bit, when set, shall indicate to the MME or the SGSN that the HSS requests the MME or SGSN for location information | +| 4 | Current Location Request | This bit when set shall indicate to the MME or the SGSN that the HSS requests the MME or SGSN to provide the most current location information by paging the UE if the UE is in idle mode. This bit is used only in combination with the "EPS Location Information Request" bit. | +| 5 | Local Time Zone Request | This bit when set shall indicate to the MME or the SGSN that the HSS requests the MME or SGSN to provide information on the time zone of the location in the visited network where the UE is attached. | +| 6 | Remove SMS Registration | This bit when set shall indicate to the MME that it shall consider itself unregistered for SMS. | +| 7 | RAT-Type Requested | This bit when set shall indicate to the MME or the SGSN that the HSS requests the MME or SGSN to provide the RAT Type that corresponds to the requested EPS Location Information. This bit is used only in combination with the "EPS Location Information Request" bit. | +| 8 | P-CSCF Restoration Request | This bit, when set, shall indicate to the MME or SGSN that the HSS requests the execution of the HSS-based P-CSCF restoration procedures, as described in 3GPP TS 23.380 [51] clause 5.4. | +| NOTE: Bits not defined in this table shall be cleared by the sending HSS and discarded by the receiving MME or SGSN. | | | + +### 7.3.104 ICS-Indicator + +The ICS-Indicator AVP is of type Enumerated. The meaning of the values is defined in 3GPP TS 23.292 [34] and 3GPP TS 23.216 [35]. The following values are defined: + +FALSE (0) + +TRUE (1) + +### 7.3.105 Visited-Network-Identifier + +The Visited-Network-Identifier AVP contains the identity of the network where the PDN-GW was allocated, in the case of dynamic PDN-GW assignment. + +The AVP shall be encoded as: + +mnc.mcc.3gppnetwork.org + +### 7.3.106 IMS-Voice-Over-PS-Sessions-Supported + +The IMS-Voice-Over-PS-Sessions-Supported AVP is of type Enumerated. The following values are defined: + +#### NOT\_SUPPORTED (0) + +This value indicates that "IMS Voice over PS Sessions" is not supported by the UE's most recently used TA or RA in the serving node. + +#### SUPPORTED (1) + +This value indicates that "IMS Voice over PS Sessions" is supported by the UE's most recently used TA or RA in the serving node. + +### 7.3.107 Homogeneous-Support-of-IMS-Voice-Over-PS-Sessions + +The Homogeneous-Support-of-IMS-Voice-Over-PS-Sessions AVP is of type Enumerated. The following values are defined: + +#### NOT\_SUPPORTED (0) + +This value indicates that "IMS Voice over PS Sessions" is not supported, homogeneously, in any of the TAs or RAs associated to the serving node for the served subscribers including consideration on roaming relationship for IMS Voice over PS. + +#### SUPPORTED (1) + +This value indicates that "IMS Voice over PS Sessions" is supported, homogeneously, in all of the TAs or RAs associated to the serving node for the served subscriber including consideration on roaming relationship for IMS Voice over PS. + +If this AVP is not present in the command, it indicates that there is no homogeneous support of IMS Voice Over PS Sessions on all the TA/RAs of the serving node, or that the homogeneity of this support is unknown to the serving node. + +NOTE: In order to ensure the T-ADS by HPLMN, MME or SGSN is expected to either set "Homogenous Support of IMS Voice over PS Sessions" AVP to "NOT\_SUPPORTED (0)", or not to set this AVP for inbound roaming subscribers if there is no IMS Voice over PS roaming relationship with the HPLMN. + +### 7.3.108 Last-UE-Activity-Time + +The Last-UE-Activity-Time AVP is of type Time (see IETF RFC 6733 [61]), and contains the point of time of the last radio contact of the serving node (MME or SGSN) with the UE. + +### 7.3.109 GMLC-Address + +The GMLC-Address AVP is of type Address and shall contain the IPv4 or IPv6 address of the V-GMLC associated with the serving node. + +### 7.3.110 EPS-User-State + +The EPS-User-State AVP is of type Grouped. It shall contain the information related to the user state in the MME and/or the SGSN. + +AVP format + +EPS-User-State ::= + +[MME-User-State] + +[SGSN-User-State] + +\*[AVP] + +### 7.3.111 EPS-Location-Information + +The EPS-Location Information AVP is of type Grouped. It shall contain the information related to the user location relevant for EPS. + +AVP format + +``` +EPS-Location-Information ::= + [MME-Location-Information] + [SGSN-Location-Information] + *[AVP] +``` + +### 7.3.112 MME-User-State + +The MME-User-State AVP is of type Grouped. It shall contain the information related to the user state in the MME. + +AVP format + +``` +MME-User-State ::= + [User-State] + *[AVP] +``` + +### 7.3.113 SGSN-User-State + +The SGSN-User-State AVP is of type Grouped. It shall contain the information related to the user state in the SGSN. + +AVP format + +``` +SGSN-User-State ::= + [User-State] + *[AVP] +``` + +### 7.3.114 User-State + +The User-State AVP is of type Enumerated and indicates the user state in EPS. The following values are defined: + +DETACHED (0) + +The UE is in EMM\_DEREGISTERED state. + +ATTACHED\_NOT\_REACHABLE\_FOR\_PAGING (1) + +The SGSN has determined from its internal data that the UE is attached to the network, but there is no EPS bearer active, and the UE is not reachable for paging. This value is only applicable to S4-SGSN. + +ATTACHED\_REACHABLE\_FOR\_PAGING (2) + +The SGSN has determined from its internal data that the UE is attached to the network, but there is no EPS bearer active; the SGSN has not determined from its internal data that the UE is not reachable for paging. This value is only applicable to S4-SGSN. + +CONNECTED\_NOT\_REACHABLE\_FOR\_PAGING (3) + +The SGSN or MME has determined from its internal data that the UE is attached to the network, there is at least one EPS bearer active, and the UE is not reachable for paging. + +CONNECTED\_REACHABLE\_FOR\_PAGING (4) + +The SGSN or MME has determined from its internal data that the UE is attached to the network, there is at least one EPS bearer active, and the SGSN or MME has not determined from its internal data that the UE is not reachable for paging. + +#### RESERVED (5) + +This value should not be used by MME or SGSN over S6a/S6d. If this value is received by the HSS from pre-rel-12 MME/SGSNs, the HSS shall consider that the UE is not reachable and use the "Network determined not reachable" state when reporting the User State to other network entities, e.g. over Sh. + +NOTE: The state associated to a "Network determined not reachable" condition should also be used by HSS when reporting to the requesting entity, e.g. over Sh, that the user was found to be not reachable (for instance, if the HSS receives no answer from the MME/SGSN to the user state query). + +### 7.3.115 MME-Location-Information + +The MME-Location-Information AVP is of type Grouped. It shall contain the information related to the user location relevant for the MME. + +AVP format + +MME-Location-Information ::= + +[E-UTRAN-Cell-Global-Identity] +[Tracking-Area-Identity] +[Geographical-Information] +[Geodetic-Information] +[Current-Location-Retrieved] +[Age-Of-Location-Information] +[User-CSG-Information] +[ eNodeB-ID ] +[ Extended-eNodeB-ID ] +\*[AVP] + +An eNodeB-ID AVP may be present for Monitoring event reporting. + +### 7.3.116 SGSN-Location-Information + +The SGSN-Location-Information AVP is of type Grouped. It shall contain the information related to the user location relevant for the SGSN. + +AVP format + +SGSN-Location-Information ::= + +[Cell-Global-Identity] +[Location-Area-Identity] +[Service-Area-Identity] +[Routing-Area-Identity] +[Geographical-Information] +[Geodetic-Information] + +[Current-Location-Retrieved] +[Age-Of-Location-Information] +[ User-CSG-Information] +\*[AVP] + +### 7.3.117 E-UTRAN-Cell-Global-Identity + +The E-UTRAN-Cell-Global-Identity AVP is of type OctetString and shall contain the E-UTRAN Cell Global Identification of the user which identifies the cell the user equipment is registered, as specified in 3GPP TS 23.003 [3]. Octets are coded as described in 3GPP TS 29.002 [24]. + +### 7.3.118 Tracking-Area-Identity + +The Tracking-Area-Identity AVP is of type OctetString and shall contain the Tracking Area Identity of the user which identifies the tracking area where the user is located, as specified in 3GPP TS 23.003 [3]. Octets are coded as described in 3GPP TS 29.002 [24]. + +### 7.3.119 Cell-Global-Identity + +The Cell-Global-Identity AVP is of type OctetString and shall contain the Cell Global Identification of the user which identifies the cell the user equipment is registered, as specified in 3GPP TS 23.003 [3]. Octets are coded as described in 3GPP TS 29.002 [24]. + +### 7.3.120 Routing-Area-Identity + +The Routing-Area-Identity AVP is of type OctetString and shall contain the Routing Area Identity of the user which identifies the routing area where the user is located, as specified in 3GPP TS 23.003 [3]. Octets are coded as described in 3GPP TS 29.002 [24]. + +### 7.3.121 Location-Area-Identity + +The Location-Area-Identity AVP is of type OctetString and shall contain the Location Area Identification of the user which identifies the Location area where the user is located, as specified in 3GPP TS 23.003 [3]. Octets are coded as described in 3GPP TS 29.002 [24]. + +### 7.3.122 Service-Area-Identity + +The Service-Area-Identity AVP is of type OctetString and shall contain the Service Area Identifier of the user where the user is located, as specified in 3GPP TS 23.003 [3]. Octets are coded as described in 3GPP TS 29.002 [24]. + +### 7.3.123 Geographical-Information + +The Geographical-Information AVP is of type OctetString and shall contain the geographical Information of the user. For details and octet encoding, see 3GPP TS 29.002 [24]. + +### 7.3.124 Geodetic-Information + +The Geodetic-Information AVP is of type OctetString and shall contain the Geodetic Location of the user. For details and octet encoding, see 3GPP TS 29.002 [24]. + +### 7.3.125 Current-Location-Retrieved + +The Current-Location-Retrieved AVP is of type Enumerated. The following values are defined: + +ACTIVE-LOCATION-RETRIEVAL (0) + +This value is used when location information was obtained after a successful paging procedure for Active Location Retrieval when the UE is in idle mode or after retrieving the most up-to-date location information from the eNB when the UE is in connected mode. + +### 7.3.126 Age-Of-Location-Information + +The Age-Of-Location-Information AVP is of type Unsigned32 and shall contain the the elapsed time in minutes since the last network contact of the user equipment. For details, see 3GPP TS 29.002 [24]. + +### 7.3.127 Active-APN + +The Active-APNs AVP is of type Grouped. It shall contain information about a dynamically established APN on a serving node, so the HSS can restore it, if it is eventually lost after a node restart. + +The AVP format shall conform to: + +``` +Active-APN ::= + { Context-Identifier } + [ Service-Selection ] + [ MIP6-Agent-Info ] + [ Visited-Network-Identifier ] + *[ Specific-APN-Info ] + *[ AVP ] +``` + +### 7.3.128 Error-Diagnostic + +The Error-Diagnostic AVP is of type Enumerated. The following values are defined: + +- GPRS\_DATA\_SUBSCRIBED (0) + +This value shall be used when Experimental-Error is DIAMETER\_ERROR\_UNKNOWN\_EPS\_SUBSCRIPTION and there is GPRS Subscription Data for the user. + +- NO\_GPRS\_DATA\_SUBSCRIBED (1) + +This value shall be used when Experimental-Error is DIAMETER\_ERROR\_UNKNOWN\_EPS\_SUBSCRIPTION and there is not GPRS Subscription Data for the user. + +- ODB\_ALL\_APN (2) + +This value shall be used when Experimental-Error is DIAMETER\_ERROR\_ROAMING\_NOT\_ALLOWED and the Operator Determined Barring indicates "All Packet Oriented Services Barred" (see clause 7.3.30). + +- ODB\_HPLMN\_APN (3) + +This value shall be used when Experimental-Error is DIAMETER\_ERROR\_ROAMING\_NOT\_ALLOWED and the Operator Determined Barring indicates "Roamer Access HPLMN-AP Barred" (see clause 7.3.30). + +- ODB\_VPLMN\_APN (4) + +This value shall be used when Experimental-Error is DIAMETER\_ERROR\_ROAMING\_NOT\_ALLOWED and the Operator Determined Barring indicates "Roamer Access to VPLMN-AP Barred" (see clause 7.3.30). + +### 7.3.129 Ext-PDP-Address AVP + +The Ext-PDP-Address AVP is of type Address and indicates an additional address of the data protocol, and it may be included when the PDP supports dual-stack (IPv4v6). + +### 7.3.130 UE-SRVCC-Capability + +The UE-SRVCC-Capability AVP is of type Enumerated. It shall indicate if the UE supports or does not support the SRVCC capability. The following values are defined: + +UE-SRVCC-NOT-SUPPORTED (0) + +UE-SRVCC-SUPPORTED (1) + +### 7.3.131 MPS-Priority + +The MPS-Priority AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 7.3.131/1: + +**Table 7.3.131/1: MPS-Priority** + +| Bit | Name | Description | +|----------------------------------------------------------------------------------------------------------------------|------------------|-------------------------------------------------------------------------------------------------------------------| +| 0 | MPS-CS-Priority | This bit, when set, indicates that the UE is subscribed to the eMLPP or 1x RTT priority service in the CS domain. | +| 1 | MPS-EPS-Priority | This bit, when set, indicates that the UE is subscribed to the MPS in the EPS domain. | +| Note: Bits not defined in this table shall be cleared by the sending HSS and discarded by the receiving MME or SGSN. | | | + +NOTE: The HSS derives the information for MPS-CS-Priority from the eMLPP Subscription Data as defined in the 3GPP TS 29.002 [24] or 1x RTT priority service which is out of the scope of 3GPP. + +### 7.3.132 VPLMN-LIPA-Allowed + +The VPLMN-LIPA-Allowed AVP is of type Enumerated. It shall indicate whether the UE is allowed to use LIPA in the VPLMN where the UE is roaming. The following values are defined: + +LIPA\_NOTALLOWED (0) + +This value indicates that the UE is not allowed to use LIPA in the VPLMN where the UE is roaming. + +LIPA\_ALLOWED (1) + +This value indicates that the UE is allowed to use LIPA in the VPLMN where the UE is roaming. + +### 7.3.133 LIPA-Permission + +The LIPA-Permission AVP is of type Enumerated. It shall indicate whether the APN can be accessed via Local IP Access. The following values are defined: + +LIPA\_PROHIBITED (0) + +This value indicates that this APN is prohibited to be accessed via LIPA. + +LIPA\_ONLY (1) + +This value indicates that this APN can be accessed only via LIPA. + +LIPA\_CONDITIONAL (2) + +This value indicates that this APN can be accessed via both non LIPA and LIPA. + +### 7.3.134 Subscribed-Periodic-RAU-TAU-Timer + +The Subscribed-Periodic-RAU-TAU-Timer AVP is of type Unsigned32 and it shall contain the subscribed periodic RAU/TAU timer value in seconds as specified in 3GPP TS 24.008 [31]. + +### 7.3.135 SIPTO-Permission + +The SIPTO-Permission AVP is of type Enumerated. It shall indicate whether the traffic associated with this particular APN is allowed or not for SIPTO above RAN. + +The following values are defined: + +SIPTO\_above\_RAN\_ALLOWED (0) + +SIPTO\_above\_RAN\_NOTALLOWED (1) + +### 7.3.136 MDT-Configuration + +The MDT-Configuration AVP is of type Grouped. It shall contain MDT related information as specified in 3GPP TS 32.422 [23]. + +The AVP format shall conform to: + +MDT-Configuration ::= + +``` +{ Job-Type } +[ Area-Scope ] +[ List-Of-Measurements ] +[ Reporting-Trigger ] +[ Report-Interval ] +[ Report-Amount ] +[ Event-Threshold-RSRP ] +[ Event-Threshold-RSRQ ] +[ Logging-Interval ] +[ Logging-Duration ] +[ Measurement-Period-LTE ] +[ Measurement-Period-UMTS ] +[ Collection-Period- RRM-LTE ] +[ Collection-Period-RRM-UMTS ] +[ Positioning-Method ] +[ Measurement-Quantity ] +[ Event-Threshold-Event-1F ] +[ Event-Threshold-Event-1I ] +*[ MDT-Allowed-PLMN-Id ] +*[ MBSFN-Area ] +*[ AVP ] +``` + +### 7.3.137 Job-Type + +The Job-Type AVP is of type Enumerated. The possible values are those defined in 3GPP TS 32.422 [23] for Job-Type. + +### 7.3.138 Area-Scope + +The Area-Scope AVP is of type Grouped. See 3GPP TS 32.422 [23]. + +The AVP format shall conform to: + +``` +Area-Scope ::= + *[ Cell-Global-Identity ] + *[ E-UTRAN-Cell-Global-Identity ] + *[ Routing-Area-Identity ] + *[ Location-Area-Identity ] + *[ Tracking-Area-Identity ] + *[ AVP ] +``` + +### 7.3.139 List-Of-Measurements + +The List-Of-Measurements AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits is defined in 3GPP TS 32.422 [23]. The most significant bit is bit 8 of the first octet. + +### 7.3.140 Reporting-Trigger + +The Reporting-Trigger AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits is defined in 3GPP TS 32.422 [23]. The most significant bit is bit 8 of the first octet. + +### 7.3.141 Report-Interval + +The Report-Interval AVP is of type Enumerated. The possible values are those defined in 3GPP TS 32.422 [23] for Report Interval + +### 7.3.142 Report-Amount + +The Report-Amount AVP is of type Enumerated. The possible values are those defined in 3GPP TS 32.422 [23] for Report Amount. + +### 7.3.143 Event-Threshold-RSRP + +The Event-Threshold-RSRP AVP is of type Unsigned32. See 3GPP TS 32.422 [23] for allowed values + +### 7.3.144 Event-Threshold-RSRQ + +The Event-Threshold-RSRQ AVP is of type Unsigned32. See 3GPP TS 32.422 [23] for allowed values + +### 7.3.145 Logging-Interval + +The Logging-Interval AVP is of type Enumerated. The possible values are those defined in 3GPP TS 32.422 [23] for Logging Interval + +### 7.3.146 Logging-Duration + +The Logging-Duration AVP is of type Enumerated. The possible values are those defined in 3GPP TS 32.422 [23] for Logging Duration + +### 7.3.147 Relay-Node-Indicator + +The Relay-Node-Indicator AVP is of type Enumerated. It shall indicate whether the subscription data belongs to a Relay Node or not (see 3GPP TS 36.300 [40]). The following values are defined: + +NOT\_RELAY\_NODE (0) + +This value indicates that the subscription data does not belong to a Relay Node. + +RELAY\_NODE (1) + +This value indicates that the subscription data belongs to a Relay Node. + +The default value when this AVP is not present is NOT\_RELAY\_NODE (0). + +### 7.3.148 MDT-User-Consent + +The MDT-User-Consent AVP is of type Enumerated. It shall indicate whether the user has given his consent for MDT activation or not (see 3GPP TS 32.422 [23]). The following values are defined: + +CONSENT\_NOT\_GIVEN (0) + +CONSENT\_GIVEN (1) + +The default value when this AVP is not present in ULA is CONSENT\_NOT\_GIVEN (0). Absence of this AVP in IDR shall be interpreted as the MDT-User-Consent has not been modified. + +The presence of this subscription parameter in ULA or IDR shall be independent of the support of the Trace Function by the MME/SGSN (see clause 7.3.10). + +### 7.3.149 PUR-Flags + +The PUR-Flags AVP is of type Unsigned32 and it shall contain a bitmask. The meaning of the bits is defined in table 7.3.149/1: + +**Table 7.3.149/1: PUR-Flags** + +| bit | name | Description | +|-------|----------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | UE Purged in MME | This bit, when set, indicates that the combined MME/SGSN has purged the UE in the MME part of the node. This bit shall not be set by a standalone SGSN. | +| 1 | UE Purged in SGSN | This bit, when set, shall indicate that the combined MME/SGSN has purged the UE in the SGSN part of the node. This bit shall not be set by a standalone MME. | +| NOTE: | Bits not defined in this table shall be cleared by the sending MME or SGSN and discarded by the receiving HSS. | | + +### 7.3.150 Subscribed-VSRVCC + +The Subscribed-VSRVCC AVP is of type Enumerated. It shall indicate that the user is subscribed to the vSRVCC. The following value is defined: + +VSRVCC\_SUBSCRIBED (0) + +Absence of this AVP in IDR shall be interpreted as the Subscribed-VSRVCC has not been modified. + +Absence of this AVP in ULA shall be interpreted as the user is not subscribed to the vSRVCC. + +### 7.3.151 Equivalent-PLMN-List + +The Equivalent-PLMN-List AVP is of type Grouped. This AVP shall contain the equivalent PLMN IDs of the registered PLMN (i.e. the visited PLMN) of the MME or the SGSN. + +AVP format + +Equivalent-PLMN-List ::= + +1\*{ Visited-PLMN-Id } + +\*[AVP] + +### 7.3.152 CLR-Flags + +The CLR-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 7.3.152/1: + +**Table 7.3.152/1: CLR-Flags** + +| Bit | Name | Description | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | S6a/S6d-Indicator (Note 1) | This bit, when set, indicates that the CLR message is sent on the S6a interface, i.e. the message is to the MME or the MME part on the combined MME/SGSN.
This bit, when cleared, indicates that the CLR message is sent on the S6d interface, i.e. the message is to the SGSN or the SGSN part on the combined MME/SGSN. | +| 1 | Reattach-Required | This bit, when set, indicates that the MME or SGSN shall request the UE to initiate an immediate re-attach procedure as described in 3GPP TS 23.401 [2] and in 3GPP TS 23.060 [12]. | +| NOTE 1: The S6a/S6d-Indicator flag shall be used during initial attach procedure for a combined MME/SGSN. The S6a/S6d-Indicator flag may also be sent to a standalone node.
NOTE 2: Bits not defined in this table shall be cleared by the sending HSS and discarded by the receiving MME or SGSN.
NOTE 3: For the purpose of withdrawing "Aerial UE Subscription", HSS may send CLR with CLR-Flag set to Reattach-Required. | | | + +### 7.3.153 UVR-Flags + +The UVR-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 7.3.154/1: + +**Table 7.3.154/1: UVR-Flags** + +| Bit | Name | Description | +|----------------------------------------------------------------------------------------------------------------|----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | Skip Subscriber Data | This bit, when set, indicates that the CSS may skip subscription data in UVA. If the CSG subscription data has changed in the CSS after the last successful update of the MME/SGSN, the CSS shall ignore this bit and send the updated CSG subscription data. | +| Bits not defined in this table shall be cleared by the sending MME or SGSN and discarded by the receiving CSS. | | | + +### 7.3.154 UVA-Flags + +The UVA-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 7.3.156/1: + +**Table 7.3.156/1: UVA-Flags** + +| Bit | Name | Description | +|----------------------------------------------------------------------------------------------------------------|---------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | Temporary Empty VPLMN CSG Subscription Data | This bit, when set, indicates that the CSS has currently no VPLMN CSG subscription data for this user but has registered the MME or SGSN, so to inform them if later changes in VPLMN CSG subscription data occur. | +| Bits not defined in this table shall be cleared by the sending MME or SGSN and discarded by the receiving CSS. | | | + +### 7.3.155 VPLMN-CSG-Subscription-Data + +The VPLMN-CSG-Subscription-Data AVP is of type Grouped. This AVP shall contain the CSG-Id, and optionally an associated expiration date. + +AVP format + +``` +VPLMN-CSG-Subscription-Data ::= + { CSG-Id } + [ Expiration-Date ] + *[AVP] +``` + +### 7.3.156 Local-Time-Zone + +The Local-Time-Zone AVP is of type Grouped and shall contain the Time Zone and the Daylight Saving Time (DST) adjustment of the location in the visited network where the UE is attached. + +The AVP format shall conform to: + +``` +Local-Time-Zone ::= + { Time-Zone } + { Daylight-Saving-Time } + * [ AVP ] +``` + +### 7.3.157 A-MSISDN + +The A-MSISDN AVP is of type OctetString. See 3GPP TS 23.003 [3] for the definition of the Additional MSISDN. This AVP contains an A-MSISDN, in international number format as described in ITU-T Rec E.164 [41], encoded as a TBCD-string. See 3GPP TS 29.002 [24] for encoding of TBCD-strings. This AVP shall not include leading indicators for the nature of address and the numbering plan; it shall contain only the TBCD-encoded digits of the address. + +This AVP may be present in the Subscription-Data AVP when sent within ULA. + +It may also be present in the Subscription-Data AVP, sent within an IDR, if the current value in the MME or SGSN needs to be changed. + +### 7.3.158 Void + +### 7.3.159 MME-Number-for-MT-SMS + +The MME-Number-for-MT-SMS AVP is of type OctetString and it shall contain the ISDN number corresponding to the MME for MT SMS. For further details on the definition of this AVP, see 3GPP TS 23.003 [3]. This AVP contains an international number with the format as described in ITU-T Rec E.164 [41] and shall be encoded as a TBCD-string. See 3GPP TS 29.002 [24] for encoding of TBCD-strings. This AVP shall not include leading indicators for the nature of address and the numbering plan; it shall contain only the TBCD-encoded digits of the address. + +### 7.3.160 Void + +### 7.3.161 Void + +### 7.3.162 SMS-Register-Request + +The SMS-Register-Request AVP is of type Enumerated and it shall indicate whether the MME or the SGSN requires to be registered for SMS (e.g. SGs interface not supported) or if the MME or the SGSN prefers not to be registered for SMS or if the MME or the SGSN has no preference. + +The following values are defined: + +SMS\_REGISTRATION\_REQUIRED (0) + +SMS\_REGISTRATION\_NOT\_PREFERRED (1) + +NO\_PREFERENCE (2) + +The criteria for setting these values are defined in 3GPP TS 23.272 [44] and 3GPP TS 23.060 [12]. + +### 7.3.163 Time-Zone + +The Time-Zone AVP is of type UTF8String and shall contain the time zone of the location in the visited network where the UE is attached. + +It contains the offset from UTC (Coordinated Universal Time) in units of 15 minutes, as defined in 3GPP TS 22.042 [42]. It shall be expressed as positive (i.e. with the leading plus sign [+]) if the local time is ahead of or equal to UTC of day and as negative (i.e. with the leading minus sign [-]) if it is behind UTC of day. + +The value contained in the Time-Zone AVP shall take into account daylight saving time, such that when the sending entity changes from regular (winter) time to daylight saving (summer) time, there is a change to the value in the Time-Zone AVP. + +The contents of the Time-Zone AVP shall be formatted as a character string with the following format: + +Basic format: $\pm n$ , with "n" being the number of units of 15 minutes from UTC. + +For example, if the offset is $+2h = +8 \times 15mn$ , the value of the Time-Zone AVP will be: "+8". + +### 7.3.164 Daylight-Saving-Time + +The Daylight-Saving-Time AVP is of type Enumerated and shall contain the Daylight Saving Time (in steps of 1 hour) used to adjust for summertime the time zone of the location where the UE is attached in the visited network. + +The following values are defined: + +NO\_ADJUSTMENT (0) + +PLUS\_ONE\_HOUR\_ADJUSTMENT (1) + +PLUS\_TWO\_HOURS\_ADJUSTMENT (2) + +### 7.3.165 Subscription-Data-Flags + +The Subscription-Data-Flags is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 7.3.165/1: + +**Table 7.3.165/1: Subscription-Data-Flags** + +| Bit | Name | Description | +|-------------------------------------------------------------------------------------------------------------------|----------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | PS-And-SMS-Only-Service-Provision-Indication | This bit, when set, indicates that the subscription is for PS Only and permits CS service access only for SMS. | +| 1 | SMS-In-SGSN-Allowed-Indication | This bit, when set, indicates that SMS in SGSN for the user is allowed. | +| 2 | User Plane Integrity Protection | This bit, when set, indicates that the SGSN may decide to activate integrity protection of the user plane when GERAN is used (see 3GPP TS 43.020 [58]). The MME shall ignore it. | +| 3 | PDN-Connection-Restricted | This bit, when set, indicates to the MME that it shall not establish any non-emergency PDN connection for this user if the MME and the UE supports Attach without PDN connection. The SGSN shall ignore it. | +| 4 | Acknowledgement-Of-Downlink-NAS-Data PDUs disabled | This bit, when set, indicates to the MME that acknowledgement of downlink NAS data PDUs for Control Plane CLoT Optimization is disabled for this UE (even for APN configurations with RDS Indicator set to ENABLED (1)). When not set it indicated to the MME that acknowledgement of downlink NAS data PDUs for Control Plane CLoT Optimization is enabled (for APN configurations with RDS Indicator set to ENABLED (1)) for this UE, which is the default (see 3GPP TS 23.401 [2]). The SGSN shall ignore it. | +| NOTE: Bits not defined in this table shall be cleared by the sender and discarded by the receiver of the command. | | | + +### 7.3.166 Measurement-Period-LTE + +The Measurement-Period-LTE AVP is of type Enumerated. The possible values are those defined in 3GPP TS 32.422 [23] for Measurement period LTE. + +### 7.3.167 Measurement-Period-UMTS + +The Measurement-Period-UMTS AVP is of type Enumerated. The possible values are those defined in 3GPP TS 32.422 [23] for Measurement period UMTS. + +### 7.3.168 Collection-Period-RRM-LTE + +The Collection-Period-RRM-LTE AVP is of type Enumerated. The possible values are those defined in 3GPP TS 32.422 [23] for Collection period for RRM measurements LTE. + +### 7.3.169 Collection-Period-RRM-UMTS + +The Collection-Period-RRM-UMTS AVP is of type Enumerated. The possible values are those defined in 3GPP TS 32.422 [23] for Collection period for RRM measurements UMTS. + +### 7.3.170 Positioning-Method + +The Positioning-Method AVP is of type OctetString. It contains one octet carrying a bit map of 8 bits. The possible values are those defined in 3GPP TS 32.422 [23] for Positioning Method. + +### 7.3.171 Measurement-Quantity + +The Measurement-Quantity AVP is of type OctetString. It contains one octet carrying a bit map of 8 bits. The possible values are those defined in 3GPP TS 32.422 [23] for Measurement quantity. + +### 7.3.172 Event-Threshold-Event-1F + +The Event-Threshold-Event-1F AVP is of type Integer32. See 3GPP TS 32.422 [23] for allowed values. + +### 7.3.173 Event-Threshold-Event-1I + +The Event-Threshold-Event-1I AVP is of type Integer32. See 3GPP TS 32.422 [23] for allowed values + +### 7.3.174 Restoration-Priority + +The Restoration-Priority AVP is of type Unsigned32. It shall indicate the relative priority of a user's PDN connection among PDN connections to the same APN when restoring PDN connections affected by an SGW or PGW failure/restart (see 3GPP TS 23.007 [43]). + +Values 1 to 16 are defined, with value 1 as the highest level of priority. + +### 7.3.175 SGs-MME-Identity + +The SGs-MME-Identity AVP is of type UTF8String. This AVP shall contain the MME identity used over the SGs interface and specified in 3GPP TS 23.003 [3] clause 19.4.2.4. + +### 7.3.176 SIPTO-Local-Network-Permission + +The SIPTO-Local-Network-Permission AVP is of type Unsigned32. It shall indicate whether the traffic associated with this particular APN is allowed or not for SIPTO at the local network. + +The following values are defined: + +| | | +|-------------------------------------|---| +| "SIPTO at Local Network ALLOWED" | 0 | +| "SIPTO at Local Network NOTALLOWED" | 1 | + +### 7.3.177 Coupled-Node-Diameter-ID + +The Coupled-Node-Diameter-ID AVP is of type DiameterIdentity. This AVP shall contain the S6a or S6d Diameter identity of the coupled node as specified in 3GPP TS 23.003 [3] clause 19.4.2.4 and clause 19.4.2.6. + +### 7.3.178 OC-Supported-Features + +The OC-Supported-Features AVP is of type Grouped and it is defined in IETF RFC 7683 [50]. This AVP is used to support Diameter overload control mechanism, see Annex C for more information. + +### 7.3.179 OC-OLR + +The OC-OLR AVP is of type Grouped and it is defined in IETF RFC 7683 [50]. This AVP is used to support Diameter overload control mechanism, see Annex C for more information. + +### 7.3.180 ProSe-Subscription-Data + +The ProSe-Subscription-Data AVP is of type Grouped. It shall contain the ProSe related subscription data. It was originally defined in 3GPP TS 29.344 [49]. + +AVP format + +``` +ProSe-Subscription-Data ::= + { ProSe-Permission } + *[AVP] +``` + +### 7.3.181 WLAN-offloadability + +The WLAN-offloadability AVP is of type Grouped. This AVP contains WLAN offloadability for E-UTRAN or UTRAN. + +AVP format: + +``` +WLAN-offloadability ::= + [ WLAN-offloadability-EUTRAN ] + [ WLAN-offloadability-UTRAN ] + *[ AVP ] +``` + +### 7.3.182 WLAN-offloadability-EUTRAN + +The WLAN-offloadability-EUTRAN AVP is of type Unsigned32 and it shall contain a bitmask. The meaning of the bits is defined in table 7.3.182/1: + +**Table 7.3.182/1: WLAN-offloadability-EUTRAN** + +| bit | name | Description | +|-------|----------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | WLAN offloadability for E-UTRAN | This bit, when set, shall indicate that the traffic associated with the APN is allowed to be offloaded to WLAN from E-UTRAN using the WLAN/3GPP Radio Interworking feature. If not set, it means the traffic associated with the APN is not allowed to be offloaded to WLAN from E-UTRAN. | +| NOTE: | Bits not defined in this table shall be cleared by the sending HSS and discarded by the receiving MME or SGSN. | | + +### 7.3.183 WLAN-offloadability-UTRAN + +The WLAN-offloadability-UTRAN AVP is of type Unsigned32 and it shall contain a bitmask. The meaning of the bits is defined in table 7.3.183/1: + +**Table 7.3.183/1: WLAN-offloadability-UTRAN** + +| bit | name | Description | +|-------|-----------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | WLAN offloadability for UTRAN | This bit, when set, shall indicate that the traffic associated with the APN is allowed to be offloaded to WLAN from UTRAN using the WLAN/3GPP Radio Interworking feature. If not set, it means the traffic associated with the APN is not allowed to be offloaded to WLAN from UTRAN. | +| NOTE: | Bits not defined in this table shall be cleared by the sending HSS and discarded by the receiving MME or SGSN.. | | + +### 7.3.184 Reset-ID + +The Reset-ID is of type OctetString. The value shall uniquely (within the HSS's realm) identify a resource in the HSS that may fail or has restarted. + +In the Reset procedure, when used to add/modify/delete subscription data shared by multiple subscribers, the Reset-ID is used to identify the set of affected subscribers. + +### 7.3.185 MDT-Allowed-PLMN-Id + +The MDT-Allowed-PLMN-Id AVP is of type OctetString. This AVP shall contain the concatenation of MCC and MNC. See 3GPP TS 23.003 [3]. The content of this AVP shall be encoded as an octet string according to table 7.3.185/1. + +This AVP identifies the PLMN in which the MDT data collection shall take place. + +See 3GPP TS 24.008 [31], clause 10.5.1.13, PLMN list, for the coding of MCC and MNC. If MNC is 2 digits long, bits 5 to 8 of octet 2 are coded as "1111". + +**Table 7.3.185/1: Encoding format for MDT-Allowed-PLMN-Id AVP** + +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +|---|---|---|---|---|---|---|---|--| +| | | | | | | | | | +| | | | | | | | | | +| | | | | | | | | | + +### 7.3.186 Adjacent-PLMNs + +The Adjacent-PLMNs AVP is of type Grouped. This AVP shall contain a list of PLMN IDs where an UE served by the MME/SGSN is likely to make a handover from the PLMN where the MME/SGSN is located. + +AVP format: + +``` + +Adjacent-PLMNs ::= + 1*{ Visited-PLMN-Id } + *[AVP] + +``` + +### 7.3.187 Adjacent-Access-Restriction-Data + +The Adjacent-Access-Restriction-Data AVP is of type Grouped. This AVP shall contain a pair of PLMN ID and the associated Access Restriction Data for that PLMN. + +AVP format: + +``` + +Adjacent-Access-Restriction-Data ::= + { Visited-PLMN-Id } + { Access-Restriction-Data } + *[AVP] + +``` + +### 7.3.188 DL-Buffering-Suggested-Packet-Count + +The DL-Buffering-Suggested-Packet-Count AVP is of type Integer32. It shall indicate whether extended buffering of downlink packets at the SGW, for High Latency Communication, is requested or not. When requested, it may also suggest the number of downlink packets to buffer at the SGW for this user. + +The following values are defined: + +"Extended DL Data Buffering NOT REQUESTED" 0 +"Extended DL Data Buffering REQUESTED, without a suggested number of packets" -1 +"Extended DL Data Buffering REQUESTED, with a suggested number of packets" > 0 + +"Extended DL Data Buffering REQUESTED", with or without a suggested number of packets to be buffered for this user, indicates that extended buffering of downlink packets at the SGW is applicable to this user. + +"Extended DL Data Buffering NOT REQUESTED" indicates that extended buffering of downlink packets at the SGW is not applicable to this user. + +### 7.3.189 IMSI-Group-Id + +The IMSI-Group-Id AVP shall be of type Grouped. This AVP shall contain the information about the IMSI-Group-Id. + +AVP format + +IMSI-Group-Id ::= + +{ Group-Service-Id } + +{ Group-PLMN-Id } + +{ Local-Group-Id } + +\*[AVP] + +For details see 3GPP TS 23.003 [3], clause 19.9). + +### 7.3.190 Group-Service-Id + +The Group-Service-Id AVP is of type Unsigned32 and it shall identify the specific service for which the IMSI-Group-Id is used. The following values are defined: + +**Table 7.3.190-1: Group-Service-Id** + +| Value | Description | +|-------|---------------------------------------------------------------------------| +| 1 | Group specific NAS level congestion control | +| 2 | Group specific Monitoring of Number of UEs present in a geographical area | + +Values greater than 1000 are reserved for home operator specific use. IMSI-Group-IDs with a Group-Service-Id in this range shall not be sent outside the HPLMN unless roaming agreements allow so. + +### 7.3.191 Group-PLMN-Id + +The Group-PLMN-Id AVP is of type OctetString. This AVP shall contain the concatenation of MCC and MNC. See 3GPP TS 23.003 [3]. The content of this AVP shall be encoded as an octet string according to table 7.3.191-1. + +See 3GPP TS 24.008 [31], clause 10.5.1.13, PLMN list, for the coding of MCC and MNC. If MNC is 2 digits long, bits 5 to 8 of octet 2 are coded as "1111". + +**Table 7.3.191-1: Encoding format for Group-PLMN-Id AVP** + +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +|---|---|---|---|---|---|---|---|--| +| | | | | | | | | | +| | | | | | | | | | +| | | | | | | | | | + +### 7.3.192 Local-Group-Id + +The Local-Group-Id AVP is of type OctetString. It shall contain an operator defined value, representing a group. + +### 7.3.193 AESE-Communication-Pattern + +AESE-Communication-Pattern AVP is of type Grouped and is defined in 3GPP TS 29.336 [54]. + +AVP format + +AESE-Communication-Pattern ::= + +[ SCEF-Reference-ID ] + +[ SCEF-Reference-ID-Ext ] + +{ SCEF-ID } + +\*[ SCEF-Reference-ID-for-Deletion ] + +\*[ SCEF-Reference-ID-for-Deletion-Ext ] + +\*[ Communication-Pattern-Set ] + +[ MTC-Provider-Info ] + +\*[AVP] + +At least one reference ID (either in SCEF-Reference-ID or in SCEF-Reference-ID-Ext) or a reference ID for deletion (either in SCEF-Reference-ID-for-Deletion or in SCEF-Reference-ID-for-Deletion-Ext) shall be present. + +When the "Extended Reference IDs" feature is supported by the HSS and MME/SGSN, the SCEF-Reference-ID-Ext and SCEF-Reference-ID-for-Deletion-Ext AVPs shall be used insted of SCEF-Reference-ID and SCEF-Reference-ID-for-Deletion respectively. + +### 7.3.194 Communication-Pattern-Set + +Communication-Pattern-Set AVP is of type Grouped and is defined in 3GPP TS 29.336 [54]. + +AVP format + +Communication-Pattern-Set ::= + +[ Periodic-Communication-Indicator ] + +[ Communication-Duration-Time ] + +[ Periodic-Time ] + +\*[ Scheduled-Communication-Time ] + +[ Stationary-Indication ] + +[ Reference-ID-Validity-Time ] + +[ Traffic-Profile ] + +[ Battery-Indicator ] + +\*[AVP] + +If the Reference-ID-Validity-Time AVP is absent, it indicates that there is no expiration time defined for the Communication-Pattern-Set. + +### 7.3.195 Monitoring-Event-Configuration + +The Monitoring-Event-Configuration AVP is of type Grouped. It shall contain the Monitoring event configuration related subscription data. It is originally defined in 3GPP TS 29.336 [54]. + +For S6a/S6d interface, the Monitoring-Event-Configuration AVP format is specified as following: + +AVP format: + +Monitoring-Event-Configuration ::= + +[ SCEF-Reference-ID ] +[ SCEF-Reference-ID-Ext ] +{ SCEF-ID } +{ Monitoring-Type } +\*[ SCEF-Reference-ID-for-Deletion ] +\*[ SCEF-Reference-ID-for-Deletion-Ext ] +[ Maximum-Number-of-Reports ] +[ Monitoring-Duration ] +[ Charged-Party ] +[ UE-Reachability-Configuration ] +[ Location-Information-Configuration ] +[ SCEF-Realm ] +[ External-Identifier ] +[ MTC-Provider-Info ] +[ PDN-Connectivity-Status-Configuration ] +\*[ AVP ] + +When the Monitoring-Event-Configuration AVP is used over the S6a/S6d interfaces, the SCEF-Realm AVP shall be present and its value shall be obtained by the HSS from the Origin-Realm AVP of the Configuration-Information-Request command conveying the corresponding monitoring event configuration over the S6t interface from the SCEF to the HSS. + +The Monitoring-Type AVP shall only be taken into account in combination with SCEF-Reference-ID/SCEF-Reference-ID-Ext AVP; Monitoring-Type AVP shall be ignored for deletion of an event (i.e. when SCEF-Reference-ID-for-Deletion/SCEF-Reference-ID-for-Deletion-Ext AVP is present). + +Maximum-Number-of-Reports shall not be present over S6a/S6d interfaces if Monitoring-Type is AVAILABILITY\_AFTER\_DDN\_FAILURE (6). + +Maximum-Number-of-Reports shall not be greater than one over S6a/S6d interfaces if Monitoring-Type is LOCATION\_REPORTING (2) and MONTE-Location-Type is LAST\_KNOWN\_LOCATION (1). + +When multiple External Identifiers are defined for the same subscription, the External-Identifier in this grouped AVP, if present, shall contain the specific External Identifier to be associated with this monitoring event; if it is not present, the External Identifier associated with this monitoring event shall be the default External Identifier defined in the subscription (see clause 7.3.2). + +When the "Extended Reference IDs" feature is supported by the HSS and MME/SGSN, the SCEF-Reference-ID-Ext and SCEF-Reference-ID-for-Deletion-Ext AVPs shall be used instead of SCEF-Reference-ID and SCEF-Reference-ID-for-Deletion respectively. + +## 7.3.196 Monitoring-Event-Report + +The Monitoring-Event-Report AVP is of type Grouped. It shall contain the Monitoring event report data. It is originally defined in 3GPP TS 29.336 [54]. + +For S6a/S6d interface, the Monitoring-Event-Report AVP format is specified as following: + +AVP format: + +Monitoring Event Report ::= + +``` +{ SCEF-Reference-ID } +[ SCEF-Reference-ID-Ext ] +[ SCEF-ID ] +[ Reachability-Information ] +[ EPS-Location-Information ] +[ Monitoring-Type ] +[ Loss-Of-Connectivity-Reason ] +[ Idle-Status-Indication ] +[ Maximum-UE-Availability-Time ] +*[ PDN-Connectivity-Status-Report ] +*[ AVP ] +``` + +For S6a/S6d interface, when the Monitoring-Type AVP takes the value UE\_REACHABILITY (1), the Reachability-Information AVP shall take the value REACHABLE\_FOR\_DATA (1). + +For S6a/S6d interface, when the Monitoring-Type AVP takes the value PDN\_CONNECTIVITY\_STATUS (10), the PDN-Connectivity-Status-Report AVP(s) shall contain the list of active PDNs, for the given APN provided in the monitoring event configuration, or for all APNs if no APN was provided; each PDN-Connectivity-Status-Report shall have the PDN-Connectivity-Status-Type set to value "CREATED (0)". + +When the "Extended Reference IDs" feature is supported by the HSS and MME/SGSN, the SCEF-Reference-ID-Ext AVP shall be used instead of SCEF-Reference-ID; in such case, the required AVP "SCEF-Reference-ID" shall be included in the grouped AVP by the sender, but its content shall be discarded by the receiver. + +### 7.3.197 UE-Reachability-Configuration + +The UE-Reachability-Configuration AVP is of type Grouped, and it shall contain the details for configuration for UE reachability. It is originally defined in 3GPP TS 29.336 [54]. + +For S6a/S6d interface, the UE-Reachability-Configuration AVP format is specified as following: + +AVP format: + +UE-Reachability-Configuration ::= + +``` +[ Reachability-Type ] +[ Maximum-Response-Time ] +*[ AVP ] +``` + +NOTE: When a Maximum-Response-Time value is not received from the SCEF, the HSS can send an O&M configured desired active time value within the Maximum-Response-Time AVP. + +For S6a/S6d interface, the Reachability-Type AVP shall have bit 0 ("Reachability for SMS") cleared, and it shall have bit 1 ("Reachability for Data") set. + +### 7.3.198 eNodeB-ID + +The eNodeB-ID AVP is of type OctetString, and indicates the eNodeB in which the UE is currently located. It is originally defined in 3GPP TS 29.217 [56]. + +### 7.3.199 Supported-Services + +The Supported-Services AVP is of type Grouped and it shall contain the different bit masks representing the services supported by the MME/SGSN: + +AVP format + +``` +Supported-Services ::= + [ Supported-Monitoring-Events ] + *[AVP] +``` + +### 7.3.200 Supported-Monitoring-Events + +The Supported-Monitoring-Events AVP is of type Unsigned64 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 7.3.200-1: + +**Table 7.3.200 -1: Supported-Monitoring-Events** + +| Bit | Name | Description | +|-------|-------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------| +| 0 | UE and UICC and/or new IMSI-IMEI-SV association | only used on S6t interface | +| 1 | UE-reachability | This bit shall be set if UE reachability Monitoring event is supported in the MME/SGSN | +| 2 | Location-of-the-UE | This bit shall be set if Location of the UE and change in location of the UE Monitoring event is supported in the MME/SGSN | +| 3 | Loss-of-connectivity | This bit shall be set if Loss of connectivity Monitoring event is supported in the MME/SGSN | +| 4 | Communication-failure | This bit shall be set if Communication failure Monitoring event is supported in the MME/SGSN | +| 5 | Roaming-status | only used on S6t interface | +| 6 | Availability after DDN failure | This bit shall be set if Availability after DDN failure Monitoring event is supported in the MME/SGSN | +| 7 | Idle Status Indication | This bit shall be set if Idle Status Indication reporting is supported in the MME/SGSN | +| 8 | PDN Connectivity Status | This bit shall be set if PDN Connectivity Status monitoring event is supported in the MME/SGSN | +| NOTE: | Bits not defined in this table shall be cleared by the sender and discarded by the receiver of the command. | | + +### 7.3.201 AIR-Flags + +The AIR-Flags AVP is of type Unsigned32 and it shall contain a bitmask. The meaning of the bits is defined in table 7.3.201/1: + +**Table 7.3.201/1: AIR-Flags** + +| bit | name | Description | +|-------|----------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------| +| 0 | Send UE Usage Type | This bit, when set, indicates that the MME or SGSN requests the HSS to send the subscription parameter "UE Usage Type". | +| NOTE: | Bits not defined in this table shall be cleared by the sending MME or SGSN and discarded by the receiving HSS. | | + +### 7.3.202 UE-Usage-Type + +The UE-Usage-Type AVP is of type Unsigned32. This value shall indicate the usage characteristics of the UE that enables the selection of a specific Dedicated Core Network (DCN). See clause 4.3.25 of 3GPP TS 23.401 [2]. + +The allowed values of UE-Usage-Type shall be in the range of 0 to 255. + +Values in the range of 0 to 127 are standardized and defined as follows: + +0: Spare, for future use + +... + +127: Spare, for future use + +Values in the range of 128 to 255 are operator-specific. + +### 7.3.203 DRMP + +The DRMP AVP is of type Enumerated and it is defined in IETF RFC 7944 [57]. This AVP allows the HSS, the CSS, the EIR and the MME/SGSN to indicate the relative priority of Diameter messages. The DRMP AVP may be used to set the DSCP marking for transport of the associated Diameter message. + +### 7.3.204 Non-IP-PDN-Type-Indicator + +The Non-IP-PDN-Type-Indicator AVP is of type Enumerated and indicates whether the APN has a Non-IP PDN type. + +The following values are defined: + +FALSE (0) + +This value indicates that the APN does not have a Non-IP PDN type. + +TRUE (1) + +This value indicates that the APN has a Non-IP PDN type and, in this case, the value indicated by the PDN-Type AVP inside APN-Configuration AVP shall be ignored. + +The default value when this AVP is not present is FALSE (0). + +### 7.3.205 Non-IP-Data-Delivery-Mechanism + +The Non-IP-Data-Delivery-Mechanism AVP is of type Unsigned32 and indicates the mechanism to be used for Non-IP data delivery for a given APN. The following values are defined: + +SGI-BASED-DATA-DELIVERY (0) + +This value indicates that the Non-IP data is delivered via Point-To-Point tunnelling over the SGI interface. + +SCEF-BASED-DATA-DELIVERY (1) + +This value indicates that the Non-IP data is delivered via the SCEF. + +The default value when this AVP is not present is SGI-BASED-DATA-DELIVERY (0). + +### 7.3.206 Additional-Context-Identifier + +The Additional-Context-Identifier AVP is of type Unsigned32 and indicates the identity of another default APN to be used when the subscription profile of the user contains APNs with more than one PDN type among IP-based PDN types, non-IP PDN types and Ethernet PDN types. + +### 7.3.207 SCEF-Realm + +The SCEF-Realm AVP is of type DiameterIdentity and it shall contain the Diameter realm of the SCEF. For further details on the encoding of this AVP, see IETF RFC 6733 [61]. + +### 7.3.208 Subscription-Data-Deletion + +The Subscription-Data-Deletion AVP is of type Grouped and indicates the shared subscription data that need to be deleted from the subscription profiles of the impacted subscribers. + +AVP format + +Subscription-Data-Deletion ::= + +``` +{ DSR-Flags } +[ SCEF-ID ] +*[ Context-Identifier ] +[ Trace-Reference ] +*[ TS-Code ] +*[ SS-Code ] +*[ AVP ] +``` + +### 7.3.209 Preferred-Data-Mode + +The Preferred-Data-Mode AVP is of type Unsigned32 and it shall contain a bitmask. The meaning of the bits is defined in table 7.3.209/1: + +**Table 7.3.209/1: Preferred-Data-Mode** + +| bit | name | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | Data over User Plane Preferred | This bit, when set, shall indicate that the User Plane is preferred for transmitting the traffic associated with the APN. If not set, it means that the User Plane is not preferred for transmitting the traffic associated with the APN. | +| 1 | Data over Control Plane Preferred | This bit, when set, shall indicate that the Control Plane is preferred for transmitting the traffic associated with the APN. If not set, it means that the Control Plane is not preferred for transmitting the traffic associated with the APN. | +| NOTE 1: Bits not defined in this table shall be cleared by the sending HSS and discarded by the receiving MME.
NOTE 2: At least one of the bits 0 and 1 shall be set to 1. Both bits 0 and 1 may be set to 1 to indicate that both User Plane and Control Plane are preferred for transmitting the traffic associated with the APN.
NOTE 3: This parameter only applies to E-UTRAN and SGi PDN connections. Data over User Plane refers to PDN data transported over S1-U and Data Radio Bearer. Data over Control Plane refers to PDN data transported over NAS and Signalling Radio Bearer. | | | + +### 7.3.210 Emergency-Info + +The Emergency-Info AVP is of type Grouped. It shall contain the identity of the PDN-GW used for the establishment of emergency PDN connections. + +The AVP format shall conform to: + +Emergency-Info ::= + +``` +[ MIP6-Agent-Info ] +*[ AVP ] +``` + +### 7.3.211 Load + +The Load AVP is of type Grouped and it is defined in IETF RFC 8583 [60]. This AVP is used to support Diameter load control mechanism, see Annex F for more information. + +### 7.3.212 V2X-Subscription-Data + +The V2X-Subscription-Data AVP is of type Grouped. It shall contain the V2X related subscription data for the network scheduled LTE sidelink communication.. + +AVP format: + +``` +V2X-Subscription-Data ::= + [ V2X-Permission ] + [ UE-PC5-AMBR ] + *[AVP] +``` + +The UE-PC5-AMBR AVP within the V2X-Subscription-Data AVP indicates the UE AMBR used for LTE PC5 interface. + +### 7.3.213 V2X-Permission + +The V2X-Permission AVP is of type Unsigned32 and it shall contain a bit mask that indicates the permissions for V2X service subscribed by the user. The meaning of the bits shall be as defined in table 7.3.x2-1: + +**Table 7.3.x2-1: V2X-Permission** + +| Bit | Name | Description | +|--------------------------------------------------------------------------------------------|---------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------| +| 0 | Allow V2X communication over PC5 as Vehicle UE | This bit, when set, indicates that the user is allowed to use V2X communication over PC5 as Vehicle UE in the serving PLMN. | +| 1 | Allow V2X communication over PC5 as Pedestrian UE | This bit, when set, indicates that the user is allowed to use V2X communication over PC5 as Pedestrian UE in the serving PLMN. | +| NOTE: Bits not defined in this table shall be cleared by the HSS and discarded by the MME. | | | + +### 7.3.214 PDN-Connection-Continuity + +The PDN-Connection-Continuity AVP is of type Unsigned32 and indicates how to handle the PDN connection when the UE moves between "broadband" (WB-E-UTRAN, UTRAN) and "narrowband" (NB-IoT, GPRS, EC-GSM-IoT). The following values are defined: + +MAINTAIN-PDN-CONNECTION (0) + +DISCONNECT-PDN-CONNECTION-WITH-REACTIVATION-REQUEST (1) + +DISCONNECT-PDN-CONNECTION-WITHOUT-REACTIVATION-REQUEST (2) + +This AVP corresponds to the "PDN continuity at inter RAT mobility" field as defined in 3GPP TS 23.401 [2] table 5.7.1-1. + +### 7.3.215 eDRX-Cycle-Length + +The eDRX-Cycle-Length AVP is of type Grouped. This AVP shall contain an eDRX cycle length, along with the RAT type for which this cycle length is applicable to (e.g. E-UTRAN and NB-IOT). + +AVP format: + +``` +eDRX-Cycle-Length ::= + { RAT-Type } + { eDRX-Cycle-Length-Value } +``` + +\*[ AVP ] + +### 7.3.216 eDRX-Cycle-Length-Value + +The eDRX-Cycle-Length-Value AVP is of type OctetString. This AVP shall contain the extended DRX cycle value subscribed for this user for a given RAT type. The contents of eDRX-Cycle-Length-Value shall consist of 1 octet. + +The encoding shall be as defined in 3GPP TS 24.008 [31], clause 10.5.5.32, and it shall only contain the value of the field "eDRX value" for a given RAT type, i.e., the 4 least significant bits of the octet in this AVP shall contain bits 1-4 of octet 3 in the "Extended DRX parameter" IE (see Figure 10.5.5.32 of 3GPP TS 24.008 [31]), and the 4 most significant bits of the octet in this AVP shall be set to 0. + +### 7.3.217 UE-PC5-AMBR + +The UE-PC5-AMBR AVP is of type Unsigned32. It indicates the maximum bits delivered by UE over the PC5 interface within a period of time. The unit of UE-PC5-AMBR is bits/s. + +### 7.3.218 Extended eNodeB-ID + +The Extended eNodeB-ID AVP is of type OctetString, and indicates the eNodeB in which the UE is currently located. It is originally defined in 3GPP TS 29.217 [56]. + +### 7.3.219 MBSFN-Area + +The MBSFN-Area AVP is of type Grouped. It contains a MBSFN Area ID and a Carrier Frequency (see 3GPP TS 32.422 [23]). + +The AVP format shall conform to: + +MBSFN-Area ::= + +[ MBSFN-Area-ID ] + +[ Carrier-Frequency ] + +\*[ AVP ] + +If both MBSFN-Area-ID and Carrier-Frequency values are present, a specific MBSFN area is indicated. If Carrier-Frequency value is present, but MBSFN-Area-ID is absent, all MBSFN areas on that carrier frequency are indicated. If both MBSFN-Area-ID and Carrier-Frequency are absent, any MBSFN area is indicated. + +### 7.3.220 MBSFN-Area-ID + +The MBSFN-Area-ID AVP is of type Unsigned32 and it shall contain the MBSFN Area ID value, in the range of 0..255 (see 3GPP TS 36.331 [62]). + +### 7.3.221 Carrier-Frequency + +The Carrier-Frequency AVP is of type Unsigned32 and it shall contain the Carrier Frequency value, in the range of 0..262143 (see 3GPP TS 36.331 [62]). + +### 7.3.222 RDS-Indicator + +The RDS-Indicator AVP is of type Enumerated and indicates whether the Reliable Data Service (RDS) is enabled or disabled for the APN. See 3GPP TS 23.682 [55]. + +The following values are defined: + +DISABLED (0) + +ENABLED (1) + +The default value when this AVP is not present is DISABLED (0). + +### 7.3.223 Service-Gap-Time + +The Service-Gap-Time AVP is of type Unsigned32 and indicates the minimum number of seconds during which the UE shall stay in ECM-IDLE mode, after leaving the ECM-CONNECTED mode, before being allowed to send a subsequent connection request to enter ECM-CONNECTED mode again. See description of the Service Gap Control feature in 3GPP TS 23.401 [2]. + +### 7.3.224 Aerial-UE-Subscription-Information + +The Aerial-UE-Subscription-Information AVP is of type Unsigned32 and indicates the subscription of Aerial UE function. The following values are defined: + +AERIAL\_UE\_ALLOWED (0) + +AERIAL\_UE\_NOT\_ALLOWED (1) + +This AVP corresponds to the "Aerial UE subscription information" information element as defined in 3GPP TS 36.413[19] and TS 36.423 [65]. + +### 7.3.225 Broadcast-Location-Assistance-Data-Types + +The Broadcast-Location-Assistance-Data-Types AVP is of type Unsigned64. The content of this AVP is a bit mask which indicates the broadcast location assistance data types for which the UE is subscribed to receive ciphering keys used to decipher broadcast assistance data. + +The meaning of the bits is defined in table 7.3.225-1: + +**Table 7.3.225-1: Broadcast-Location-Assistance-Data-Types** + +| bit | name | Description | +|-----|---------------------------|----------------------------------------------------------------------------------------------------------------------------| +| 0 | Positioning SIB Type 1-1 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 1-1. | +| 1 | Positioning SIB Type 1-2 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 1-2. | +| 2 | Positioning SIB Type 1-3 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 1-3. | +| 3 | Positioning SIB Type 1-4 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 1-4. | +| 4 | Positioning SIB Type 1-5 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 1-5. | +| 5 | Positioning SIB Type 1-6 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 1-6. | +| 6 | Positioning SIB Type 1-7 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 1-7. | +| 7 | Positioning SIB Type 2-1 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-1. | +| 8 | Positioning SIB Type 2-2 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-2. | +| 9 | Positioning SIB Type 2-3 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-3. | +| 10 | Positioning SIB Type 2-4 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-4. | +| 11 | Positioning SIB Type 2-5 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-5. | +| 12 | Positioning SIB Type 2-6 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-6. | +| 13 | Positioning SIB Type 2-7 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-7. | +| 14 | Positioning SIB Type 2-8 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-8. | +| 15 | Positioning SIB Type 2-9 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-9. | +| 16 | Positioning SIB Type 2-10 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-10. | +| 17 | Positioning SIB Type 2-11 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-11. | +| 18 | Positioning SIB Type 2-12 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-12. | +| 19 | Positioning SIB Type 2-13 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-13. | +| 20 | Positioning SIB Type 2-14 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-14. | +| 21 | Positioning SIB Type 2-15 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-15. | +| 22 | Positioning SIB Type 2-16 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-16. | +| 23 | Positioning SIB Type 2-17 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-17. | +| 24 | Positioning SIB Type 2-18 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-18. | +| 25 | Positioning SIB Type 2-19 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-19. | +| 26 | Positioning SIB Type 3-1 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 3-1. | +| 27 | Positioning SIB Type 1-8 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 1-8. | +| 28 | Positioning SIB Type 2-20 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-20. | +| 29 | Positioning SIB Type 2-21 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-21. | +| 30 | Positioning SIB Type 2-22 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-22. | +| 31 | Positioning SIB Type 2-23 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-23. | +| 32 | Positioning SIB Type 2-24 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-24. | + +| | | | +|-------|----------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------| +| 33 | Positioning SIB Type 2-25 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-25. | +| 34 | Positioning SIB Type 4-1 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 4-1. | +| 35 | Positioning SIB Type 5-1 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 5-1. | +| NOTE: | Bits not defined in this table shall be cleared by the sending HSS and discarded by the receiving MME or SGSN. | | + +### 7.3.226 Paging-Time-Window + +The Paging-Time-Window AVP is of type Grouped. This AVP shall contain the Paging Time Window length, along with the Operation Mode (see clause 7.3.227) for which this time window length is applicable to. + +AVP format: + +``` +Paging-Time-Window ::= + { Operation-Mode } + { Paging-Time-Window-Length } + *[ AVP ] +``` + +### 7.3.227 Operation-Mode + +The Operation-Mode AVP is of type Unsigned32. This value shall indicate the operation mode for which the Paging-Time-Window-Length applies. See clause 3GPP TS 24.008 [31], clause 10.5.5.32. + +The allowed values of Operation-Mode shall be in the range of 0 to 255. + +Values are defined as follows: + +- 0: Spare, for future use +- 1: Iu mode +- 2: WB-S1 mode +- 3: NB-S1 mode +- 4 to 255: Spare, for future use + +### 7.3.228 Paging-Time-Window-Length + +The Paging-Time-Window-Length AVP is of type OctetString. This AVP shall contain the Paging time window length subscribed for this user for a given operation mode. The contents of Paging-Time-Window-Length shall consist of 1 octet. + +The encoding shall be as defined in 3GPP TS 24.008 [31], clause 10.5.5.32, and it shall only contain the value of the field "Paging Time Window length" for a given RAT type, i.e., the 4 most significant bits of the octet in this AVP shall contain bits 5-8 of octet 3 in the "Extended DRX parameter" IE (see Figure 10.5.5.32 of 3GPP TS 24.008 [31]), and the 4 least significant bits of the octet in this AVP shall be set to 0. + +### 7.3.229 eDRX-Related-RAT + +The eDRX-Related-RAT AVP is of type Grouped. This AVP shall contain the RAT type to which the eDRX Cycle Length is related: + +AVP format + +``` +eDRX-Related-RAT ::= +``` + +1 \* { RAT-Type } + \*[AVP] + +### 7.3.230 Core-Network-Restrictions + +The Core-Network-Restrictions AVP is of type Unsigned32 and shall contain a bitmask indicating the types of Core Network that are disallowed for a given user. The meaning of the bits shall be as defined in table 7.3.230-1: + +**Table 7.3.230-1: Core-Network-Restrictions** + +| Bit | Name | Description | +|--------------------------------------------------------------------------------------------|-----------------|--------------------------------------------------------------------------------------| +| 0 | Reserved | The use of this bit is deprecated. This bit shall be discarded by the receiving MME. | +| 1 | 5GC not allowed | Access to 5GC not allowed. | +| NOTE: Bits not defined in this table shall be cleared by the HSS and discarded by the MME. | | | + +### 7.3.231 Interworking-5GS-Indicator + +The Interworking-5GS-Indicator AVP is of type Enumerated and indicates whether the interworking between 5GS and EPS is subscribed or not subscribed for the APN. See 3GPP TS 23.502 [67]. + +The following values are defined: + +NOT-SUBSCRIBED (0) + +SUBSCRIBED (1) + +The default value when this AVP is not present is NOT-SUBSCRIBED (0). + +### 7.3.232 Ethernet-PDN-Type-Indicator + +The Ethernet-PDN-Type-Indicator AVP is of type Enumerated and indicates whether the APN has an Ethernet PDN type. + +The following values are defined: + +FALSE (0) + +This value indicates that the APN does not have an Ethernet PDN type. + +TRUE (1) + +This value indicates that the APN has an Ethernet PDN type and in this case the value indicated by the PDN-Type AVP inside APN-Configuration AVP shall be ignored. + +The default value when this AVP is not present is FALSE (0). + +### 7.3.233 Subscribed-ARPI + +The Subscribed-ARPI AVP is of type Unsigned32 and shall contain the subscribed value of the Additional RRM Policy Index. For details, see 3GPP TS 23.401 [2]. + +### 7.3.234 IAB-Operation-Permission + +The IAB-Operation-Permission AVP is of type Enumerated. It shall indicate to the MME or SGSN whether the UE is allowed for IAB operation. See 3GPP TS 23.401 [2]. + +The following values are defined: + +IAB\_OPERATION\_ALLOWED (0) + +IAB\_OPERATION\_NOTALLOWED (1) + +### 7.3.235 V2X-Subscription-Data-Nr + +The V2X-Subscription-Data-Nr AVP is of type Grouped. It shall contain the V2X related subscription data for the network scheduled NR sidelink communication. + +AVP format: + +``` +V2X-Subscription-Data-Nr ::= + [ V2X-Permission ] + [ UE-PC5-AMBR ] + [ UE-PC5-QoS ] + *[AVP] +``` + +The UE-PC5-AMBR AVP within the V2X-Subscription-Data AVP indicates the UE AMBR used for NR PC5 interface. + +### 7.3.236 UE-PC5-QoS + +The UE-PC5-QoS AVP is of type Grouped. It shall contain the PC5 QoS parameters for V2X communication over NR PC5 reference point. + +AVP format: + +``` +UE-PC5-QoS ::= + 1*{ PC5-QoS-Flow } + [ PC5-Link-AMBR ] + *[AVP] +``` + +### 7.3.237 PC5-QoS-Flow + +The PC5-QoS-Flow AVP is of type Grouped. It shall contain the QoS parameters for a PC5 flow. + +AVP format: + +``` +PC5-QoS-Flow ::= + { 5QI } + [ PC5-Flow-Bitrates ] + [ PC5-Range ] + *[AVP] +``` + +### 7.3.238 5QI + +The 5QI AVP is of type Integer32. It shall contain the 5QI. See 3GPP TS 23.501 [69] for allowed values. If the 5QI is used in PC5 QoS parameter, it shall contain PQI, PQI is a special 5QI (see clause 5.4.2.1 of 3GPP TS 23.287 [68]). + +### 7.3.239 PC5-Flow-Bitrates + +The PC5-Flow-Bitrates AVP is of type Grouped. It shall contain the PC5 Flow Bit Rates, it's for GBR QoS Flows only. + +AVP format: + +PC5-Flow-Bitrates ::= + +[ Guaranteed-Flow-Bitrates ] + +[ Maximum-Flow-Bitrates ] + +### 7.3.240 Guaranteed-Flow-Bitrates + +The Guaranteed-Flow-Bitrates AVP is of type Integer32. It indicates the guaranteed bits delivered for the PC5 QoS flow by UE over the PC5 interface within a period of time. The unit of Guaranteed-Flow-Bitrates is bits/s. + +### 7.3.241 Maximum-Flow-Bitrates + +The Maximum-Flow-Bitrates AVP is of type Integer32. It indicates the maximum bits delivered for the PC5 QoS flow by UE over the PC5 interface within a period of time. The unit of Maximum-Flow-Bitrates is bits/s. + +### 7.3.242 PC5-Range + +The PC5-Range AVP is of type Integer32. It indicates the Range in the unit of meters. See clause 5.4.2.4 of 3GPP TS 23.287 [68]. + +### 7.3.243 PC5-Link-AMBR + +The PC5-Link-AMBR AVP is of type Integer32. It indicates the PC5 Link Aggregated Bit Rates for all the Non-GBR QoS Flows. The unit of PC5-Link-AMBR is bits/s. + +### 7.3.244 Third-Context-Identifier + +The Third-Context-Identifier AVP is of type Unsigned32 and indicates the identity of another default APN to be used when the subscription profile of the user contains APNs with three PDN types, i.e. IP-based PDN types, non-IP PDN types and Ethernet PDN types. + +## 7.4 Result-Code and Experimental-Result Values + +### 7.4.1 General + +This clause defines result code values that shall be supported by all Diameter implementations that conform to this specification. + +### 7.4.2 Success + +Result codes that fall within the Success category shall be used to inform a peer that a request has been successfully completed. The Result-Code AVP values defined in the Diameter base protocol IETF RFC 6733 [61] shall be applied. + +### 7.4.3 Permanent Failures + +Errors that fall within the Permanent Failures category shall be used to inform the peer that the request has failed, and should not be attempted again. The Result-Code AVP values defined in the Diameter base protocol IETF RFC 6733 [61] shall be applied. When one of the result codes defined here is included in a response, it shall be inside an Experimental-Result AVP and the Result-Code AVP shall be absent. + +#### 7.4.3.1 DIAMETER\_ERROR\_USER\_UNKNOWN (5001) + +This result code shall be sent by the HSS to indicate that the user identified by the IMSI is unknown + +#### 7.4.3.2 DIAMETER\_ERROR\_UNKNOWN\_EPS\_SUBSCRIPTION (5420) + +This result code shall be sent by the HSS to indicate that no EPS subscription is associated with the IMSI. + +#### 7.4.3.3 DIAMETER\_ERROR\_RAT\_NOT\_ALLOWED (5421) + +This result code shall be sent by the HSS to indicate the RAT type the UE is using is not allowed for the IMSI. + +#### 7.4.3.4 DIAMETER\_ERROR\_ROAMING\_NOT\_ALLOWED (5004) + +This result code shall be sent by the HSS to indicate that the subscriber is not allowed to roam within the MME or SGSN area. + +#### 7.4.3.5 DIAMETER\_ERROR\_EQUIPMENT\_UNKNOWN (5422) + +This result code shall be sent by the EIR to indicate that the mobile equipment is not known in the EIR. + +#### 7.4.3.6 DIAMETER\_ERROR\_UNKNOWN\_SERVING\_NODE (5423) + +This result code shall be sent by the HSS to indicate that a Notify command has been received from a serving node which is not registered in HSS as the node currently serving the user. + +### 7.4.4 Transient Failures + +Result codes that fall within the transient failures category shall be used to inform a peer that the request could not be satisfied at the time it was received, but may be able to satisfy the request in the future. The Result-Code AVP values defined in the Diameter base protocol IETF RFC 6733 [61] shall be applied. When one of the result codes defined here is included in a response, it shall be inside an Experimental-Result AVP and the Result-Code AVP shall be absent. + +#### 7.4.4.1 DIAMETER\_AUTHENTICATION\_DATA\_UNAVAILABLE (4181) + +This result code shall be sent by the HSS to indicate that an unexpectedly transient failure occurs. The requesting node can try the request again in the future. + +#### 7.4.4.2 DIAMETER\_ERROR\_CAMEL\_SUBSCRIPTION\_PRESENT (4182) + +This result code shall be sent by the HSS to indicate that the subscriber to be registered has SGSN CAMEL Subscription data. + +--- + +## 8 User identity to HSS resolution + +The User identity to HSS resolution mechanism enables the MME, SGSN (for non-roaming case) or Diameter Relay/proxy agents in the home network (for roaming case) to find the identity of the HSS that holds the subscriber data for a given user identity when multiple and separately addressable HSSs have been deployed in the home network. The resolution mechanism is not required in networks that utilise a single HSS. + +This User identity to HSS resolution mechanism may rely on routing capabilities provided by Diameter and be implemented in the home operator network within dedicated Diameter Agents (Redirect Agents or Proxy Agents) responsible for determining the HSS identity based on the provided user identity. If this Diameter based implementation is selected by the Home network operator, the principles described below shall apply. + +In non-roaming case, in networks where more than one independently addressable HSS are deployed in the home network, each MME and SGSN shall be configured with the address/identity of a Diameter Agent (Redirect Agent or Proxy Agent) implementing this resolution mechanism. + +For support of roaming case, Diameter Relay agents and/or Diameter Proxy agents in the home network receiving the Diameter signalling from visited networks shall be configured with the address/identity of a Diameter Agent (Redirect Agent or Proxy Agent) implementing this resolution mechanism. + +To get the HSS identity that holds the subscriber data for a given user identity in the home network, the Diameter request normally destined to the HSS shall be sent to a pre-configured address/identity of a Diameter agent supporting the User identity to HSS resolution mechanism. + +- If this Diameter request is received by a Diameter Redirect Agent, the Diameter Redirect Agent shall determine the HSS identity based on the provided user identity and shall return a notification of redirection towards the HSS identity, in response to the Diameter request. Multiple HSS identities may be included in the response, as specified in IETF RFC 6733 [61]. In such a case, the requesting Diameter entity shall send the Diameter request to the first HSS identity in the ordered list received in the Diameter response from the Diameter Redirect Agent. If no successful response to the Diameter request is received, the requesting Diameter entity shall send a Diameter request to the next HSS identity in the ordered list. This procedure shall be repeated until a successful response from an HSS is received. After the user identity to HSS resolution, the MME or the SGSN shall store the determined HSS identity/name/Realm and shall use it in further Diameter requests to the same user identity. +- If this Diameter request is received by a Diameter Proxy Agent, the Diameter Proxy Agent shall determine the HSS identity based on the provided user identity and - if the Diameter load control mechanism is supported (see IETF RFC 8583 [60]) - optionally also based on previously received load values from Load AVPs of type HOST. The Diameter Proxy Agent shall then forward the Diameter request directly to the determined HSS. In this case, the user identity to HSS resolution decision is communicated to the MME/SGSN in the Origin-Host/Origin-Realm AVPs of the response. The MME or the SGSN may store the determined HSS identity/name/Realm and may use it in further Diameter requests to the same user identity. + +In roaming case, whereas a Diameter Relay Agent is stateless, a stateful Diameter Proxy Agent in the home network may store the determined HSS identity/name/Realm and use it in further Diameter requests associated to the same user identity. + +NOTE: Alternatives to the user identity to HSS resolution Diameter based implementation are outside the scope of this specification. + +--- + +## Annex A (normative): MME mapping table for S6a and NAS Cause Code values + +When the UE initiates Attach, Tracking Area Update or Service Request, there may be the need for the MME to communicate with the HSS via S6a to retrieve authentication data and/or subscription data. If this retrieval is rejected by the HSS, the received Diameter-Result-Code values or Experimental-Result values need to be mapped to appropriate cause codes over NAS to the UE. + +This mapping shall be as shown in Table A.1. + +If the retrieval is successful, not needed (e.g. because data are already available) or not possible (e.g. because HSS is unavailable or overloaded), detected error conditions need to be mapped to appropriate cause codes over NAS to the UE. + +This mapping shall be as shown in Table A.2. + +**Table A.1: Mapping from S6a error code to NAS Cause Code values** + +| Reject indication received at MME over S6a | NAS Cause Code sent to UE | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------| +| DIAMETER_ERROR_USER_UNKNOWN (5001) | #8 "EPS services and non-EPS services not allowed" | +| DIAMETER_ERROR_UNKNOWN_EPS_SUBSCRIPTION (5420) without Error Diagnostic, or with Error Diagnostic of GPRS_DATA_SUBSCRIBED | #15 "No suitable cells in tracking area" | +| DIAMETER_ERROR_UNKNOWN_EPS_SUBSCRIPTION (5420) with Error Diagnostic of NO_GPRS_DATA_SUBSCRIBED | #7 "EPS services not allowed" | +| DIAMETER_ERROR_RAT_NOT_ALLOWED (5421) | #15 "No suitable cells in tracking area", or
#13 "Roaming not allowed in this tracking area", or
#12 "Tracking area not allowed"
(NOTE 1) | +| DIAMETER_ERROR_ROAMING_NOT_ALLOWED (5004), without Error Diagnostic | #11 "PLMN not allowed" | +| DIAMETER_ERROR_ROAMING_NOT_ALLOWED (5004), with Error Diagnostic of ODB_HPLMN_APN or ODB_VPLMN_APN | #14 "EPS services not allowed in this PLMN" | +| DIAMETER_ERROR_ROAMING_NOT_ALLOWED (5004), with Error Diagnostic of ODB_ALL_APN | #15 "No suitable cells in tracking area" | +| DIAMETER_AUTHORIZATION_REJECTED (5003)
DIAMETER_UNABLE_TO_DELIVER (3002)
DIAMETER_REALM_NOT_SERVED (3003) | #15 "No suitable cells in tracking area", or
#17 "Network failure", or
#42 "Severe network failure"
(NOTE 1) | +| DIAMETER_UNABLE_TO_COMPLY (5012),
DIAMETER_INVALID_AVP_VALUE (5004)
DIAMETER_AVP_UNSUPPORTED (5001)
DIAMETER_MISSING_AVP (5005)
DIAMETER_RESOURCES_EXCEEDED (5006)
DIAMETER_AVP_OCCURS_TOO_MANY_TIMES (5009)
DIAMETER_AUTHENTICATION_DATA_UNAVAILABLE (4181)
(NOTE 2) | #17 "Network failure" or #42 "Severe network failure"
(NOTE 1) | + +NOTE 1: Any of those NAS Cause Code values may be sent to the UE, depending on operator's choice. + +NOTE 2: Any other permanent errors from the Diameter base protocol as defined in IETF RFC 6733 [61], not listed here, should be mapped to NAS Cause Code #17 "Network failure". + +**Table A.2: Mapping from detected error condition to NAS Cause Code values** + +| Condition | NAS cause code sent to UE | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| The MME receives a SGsAP-LOCATION-UPDATE-REJECT message from the VLR indicating in the reject cause "IMSI unknown in HLR" or if the UE has packet only subscription. Only used in the Combined Tracking and Location Area Update procedure. | #2 "IMSI Unknown in HSS" | +| The MME receives in Update-Location-Answer message an indication of Roaming restricted in MME due to unsupported feature | #14 "EPS services not allowed in this PLMN" | +| The MME cannot service an UE generated request because CS domain is not available and SMS in MME is not supported. | #18 "CS domain not available" | +| The value OPERATOR_DETERMINED_BARRING is received in the Subscriber-Status AVP | #15 "No suitable cells in tracking area" | +| The HSS indicates that due to subscription to a "regionally restricted service" the UE is not allowed to operate in the tracking area. | #12 "Tracking area not allowed" | +| The CSG ID of the cell from where the UE has sent the TRACKING AREA UPDATE REQUEST message is not contained in the Allowed CSG list. | #25 "Not authorized for this CSG" | +| The MME detects that it cannot communicate with the HSS in the HPLMN of the subscriber. How the MME detect this is implementation specific. | #15 "No suitable cells in tracking area"
#14 "EPS services not allowed in this PLMN"
#111 "Protocol error, unspecified"

NOTE: Any of those NAS Cause Code values may be sent to the UE, depending on operator's choice / configuration, e.g. NAS Cause Code #14 is to be sent to the UE if the network is an LTE only network. | +| The MME detects by internal configuration that roaming is not allowed. | #11 "PLMN not allowed" | +| The MME detects that it cannot send a request to the HSS due to HSS overload (see Annex C). | #22 "Congestion"
#42 "Severe network failure"

NOTE 1: Cause #22 should be used. In addition, the MME may ask the UE not to retry before a backoff timer expires, based on an operator policy. The eventual timer value may take into account the value received in the corresponding active overload report and operator policy.

NOTE 2: Cause #42 may be used, for attach requests, in case of severe overload, according to operator policy. | + +## Annex B(normative): SGSN mapping table for S6d and NAS Cause Code values + +When the UE initiates Attach, Routing Area Update or Service Request, there may be the need for the SGSN to communicate with the HSS via S6d to retrieve authentication data and/or subscription data. If this retrieval is rejected by the HSS, the received Diameter-Result-Code values or Experimental-Result values need to be mapped to appropriate cause codes over NAS to the UE. + +NOTE: Mapping from MAP Gr error codes to NAS Cause Code values is described in the 3GPP TS 29.010 [45]. + +This mapping shall be as shown in Table B.1. + +If the retrieval is successful, not needed (e.g. because data are already available) or not possible (e.g. because HSS is unavailable or overloaded), detected error conditions need to be mapped to appropriate cause codes over NAS to the UE. + +This mapping shall be as shown in Table and B.2. + +**Table B.1: Mapping from S6d error code to NAS Cause Code values** + +| Reject indication received at SGSN over S6d | NAS Cause Code sent to UE | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------| +| DIAMETER_ERROR_USER_UNKNOWN (5001) | #8 "GPRS services and non-GPRS services not allowed" | +| DIAMETER_ERROR_UNKNOWN_EPS_SUBSCRIPTION (5420) | #7 "GPRS services not allowed" | +| DIAMETER_ERROR_RAT_NOT_ALLOWED (5421) | #15 "No suitable cells in location area", or
#13 "Roaming not allowed in this location area", or
#12 "Location area not allowed"
(NOTE 1) | +| DIAMETER_ERROR_ROAMING_NOT_ALLOWED (5004)
, without Error Diagnostic | #11 "PLMN not allowed" | +| DIAMETER_ERROR_ROAMING_NOT_ALLOWED (5004), with Error Diagnostic of ODB_HPLMN_APN or ODB_VPLMN_APN | #14 "GPRS services not allowed in this PLMN" | +| DIAMETER_ERROR_ROAMING_NOT_ALLOWED (5004), with Error Diagnostic of ODB_ALL_APN | #15 "No suitable cells in location area" | +| DIAMETER_AUTHORIZATION_REJECTED (5003)
DIAMETER_UNABLE_TO_DELIVER (3002) | #15 "No suitable cells in location area" | +| DIAMETER_UNABLE_TO_COMPLY (5012),
DIAMETER_INVALID_AVP_VALUE (5004)
DIAMETER_AUTHENTICATION_DATA_UNAVAILABLE (4181) and no retry takes place
(NOTE 2) | #17 "Network failure" | + +NOTE 1: Any of those NAS Cause Code values may be sent to the UE, depending on operator's choice. +NOTE 2: Any other permanent errors from the Diameter base protocol as defined in IETF RFC 6733 [61], not listed here, should be also mapped to NAS Cause Code #17 "Network failure". + +**Table B.2: Mapping from detected error condition to NAS Cause Code values** + +| Condition | NAS cause code to UE | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| The SGSN receives a BSSAP+-LOCATION-UPDATE-REJECT message from the VLR indicating in the reject cause "IMSI unknown in HLR" or if the UE has packet only subscription. Only used in the Combined Routing and Location Area Update procedure. | #2 "IMSI Unknown in HLR" | +| The SGSN receives in Update-Location-Answer message an indication of Roaming restricted in SGSN due to unsupported feature | #14 "GPRS services not allowed in this PLMN" | +| The value OPERATOR_DETERMINED_BARRING is received in the Subscriber-Status AVP | #15 "No suitable cells in routing area" | +| The HLR indicates that due to subscription to a "regionally restricted service" the MS is not allowed to operate in the location area. | #12 "Location area not allowed" | +| The CSG ID of the cell from where the UE has sent the ROUTING AREA UPDATE REQUEST message is not contained in the Allowed CSG list. | #25 "Not authorized for this CSG" | +| The SGSN indicates that the MS has requested "SMS-only services" and the SMS services are provided by the SGSN in the PS domain. | #28 "SMS provided via GPRS in this routing area" | +| The SGSN detects that it cannot communicate with the HLR in the HPLMN of the subscriber. How the SGSN detect this is implementation specific. | #15 "No suitable cells in routing area"
#14 "GPRS services not allowed in this PLMN"

NOTE: Any of those NAS Cause Code values may be sent to the UE, depending on operator's choice / configuration, e.g. NAS Cause Code #14 is to be sent to the UE if the network is an LTE only network. | +| The SGSN detects by internal configuration that roaming is not allowed. | #11 "PLMN not allowed" | +| The SGSN detects that it cannot send a request to the HSS due to HSS overload (see Annex C). | #22 "Congestion".

In addition, the MME may ask the UE not to retry before a backoff timer expires, based on an operator policy. The eventual timer value may take into account the value received in the corresponding active overload report and operator policy. | + +--- + +## Annex C (normative): Diameter overload control mechanism + +### C.1 General + +IETF RFC 7683 [50] specifies a Diameter overload control mechanism which includes the definition and the transfer of related AVPs between Diameter nodes. + +Depending on regional/national requirements and network operator policy, priority traffic (e.g. MPS as described in 3GPP TS 22.153 [52]) shall be exempted from throttling due to Diameter overload control up to the point where requested traffic reduction cannot be achieved without throttling the priority traffic. + +--- + +### C.2 S6a/S6d interfaces + +#### C.2.1 General + +Diameter overload control mechanism is an optional feature. + +It is recommended to make use of IETF RFC 7683 [50] on the S6a/S6d interfaces where, when applied, the MME or the SGSN shall behave as reacting nodes and the HSS as a reporting node. + +#### C.2.2 HSS behaviour + +The HSS requests traffic reduction from its clients when the HSS is in an overload situation, including OC-OLR AVP in answer commands as described in IETF RFC 7683 [50]. + +The HSS identifies that it is in an overload situation by implementation specific means. For example, the HSS may take into account the traffic over the S6a/d interfaces or other interfaces, the level of usage of internal resources (CPU, memory), the access to external resources, etc. + +The HSS determines the specific contents of OC-OLR AVP in overload reports and the HSS decides when to send OC-OLR AVPs by implementation specific means. + +#### C.2.3 MME/SGSN behaviour + +The MME/SGSN applies required traffic reduction received in answer commands to subsequent applicable requests, as per RFC 7683 [50]. + +Requested traffic reduction is achieved by the MME/SGSN by implementation specific means. For example, it may implement message throttling with prioritization or a message retaining mechanism for operations that can be postponed. + +Diameter requests related to priority traffic (e.g. MPS as identified by the MME/SGSN through access procedures) and emergency have the highest priority. Depending on regional/national regulatory and operator policies, these Diameter requests shall be the last to be throttled, when the MME/SGSN has to apply traffic reduction. Relative priority amongst various priority traffic (e.g. MPS) and emergency traffic is subject to regional/national regulatory and operator policies. + +As a result of the need to throttle traffic, the MME or SGSN may reject Attach, Tracking Area Update or Service Requests initiated by UEs. The possible NAS causes are described in the Annex A and B. + +--- + +## Annex D (Informative): Diameter overload control node behaviour + +### D.1 Message prioritisation over S6a/d + +This clause describes possible behaviours of the MME/SGSN regarding message prioritisation as guidance and for an informative purpose when Diameter overload control is applied over S6a/d. + +When the HSS is overloaded, the MME/SGSN will receive overload reports from the HSS requesting a reduction of the requests sent by the MME/SGSN. The following and not exhaustive considerations may be taken into account for the MME/SGSN throttling decisions: + +- Prioritisation of requests related to priority traffic (e.g. MPS as identified by the MME/SGSN through access procedures, emergency) +- Identification of the procedures that can be deferred (e.g. UE reachable notification, purge after a long inactivity time), so to avoid to drop non deferrable procedures; +- Prioritisation of certain types of requests (i.e. between AIR, ULR, PUR, NOR) according to the context of their use, in particular: + - Higher prioritisation of ULR commands when used in relation with mobility management (e.g. handover) for an attached user, so to avoid the interruption of the service for the user; + - Lower prioritisation of AIR and ULR commands when related to an initial attach, so to avoid the attachment of new users; +- Skipping of optional authentication (e.g. in TAU procedures). + +--- + +## Annex E (normative): Diameter message priority mechanism + +### E.1 General + +IETF RFC 7944 [57] specifies a Diameter routing message priority mechanism that allows Diameter nodes to indicate the relative priority of Diameter messages. With this information, other Diameter nodes may leverage the relative priority of Diameter messages into routing, resource allocation, set the DSCP marking for transport of the associated Diameter message, and also abatement decisions when overload control is applied. + +--- + +### E.2 S6a/S6d interfaces + +#### E.2.1 General + +The Diameter message priority mechanism is an optional feature. + +It is recommended to make use of IETF RFC 7944 [57] over the S6a/S6d interfaces of an operator network when the overload control defined in Annex C is applied on these S6a/d interfaces. + +#### E.2.2 HSS, CSS, EIR behaviour + +When the HSS, the CSS or the EIR supports the Diameter message priority mechanism, the HSS, the CSS, or the EIR shall comply with IETF RFC 7944 [57]. + +The HSS or the CSS sending a request shall determine the required priority according to its policies. When priority is required, the HSS or the CSS shall include the DRMP AVP indicating the required priority level in the request it sends, and shall prioritise the request according to the required priority level. + +When the HSS or the CSS receives the corresponding response, the HSS or the CSS shall prioritise the received response according to the priority level received within the DRMP AVP if present in the response, otherwise according to the priority level of the corresponding request. + +When the HSS, the CSS, or the EIR receives a request, it shall handle the request according to the received DRMP AVP priority level. For the response, the HSS, the CSS, or the EIR may modify the priority level received in the DRMP AVP according to its policies and shall handle the response according to the required priority level. If the required priority level is different from the priority level received in the request, the HSS, the CSS, or the EIR shall include the DRMP AVP in the response.If: + +- the HSS, the CSS or the EIR supports using the Diameter message priority mechanism for DSCP marking purposes, +- the transport network utilizes DSCP marking, and +- message-dependant DSCP marking is possible for the protocol stack transporting Diameter, + +then the HSS, the CSS or the EIR shall set the DSCP marking for transport of the request or response according to the required priority level. + +When not-explicitly requested, the inclusion and priority value of the DRMP AVP in Diameter messages are implementation specific. + +## E.2.3 MME/SGSN behaviour + +When the MME/SGSN supports the Diameter message priority mechanism, the MME/SGSN shall comply with IETF RFC 7944 [57]. + +The MME/SGSN sending a request shall determine the required priority according to its policies. When priority is required, the MME/SGSN shall include the DRMP AVP indicating the required priority level in the request it sends, and shall prioritise the requests according to the required priority level. + +When the MME/SGSN receives the corresponding response, it shall prioritise the received response according to the priority level received within the DRMP AVP if present in the response, otherwise according to the priority level of the corresponding request. + +When the MME/SGSN receives a request, it shall handle the request according to the received DRMP AVP priority level. For the response, it may modify the priority level received in the DRMP AVP according to its policies and shall handle the response according to the required priority level. If the required priority level is different from the priority level received in the request, it shall include the DRMP AVP in the response. + +If: + +- the MME/SGSN supports using the Diameter message priority mechanism for DSCP marking purposes, +- the transport network utilizes DSCP marking, and +- message-dependant DSCP marking is possible for the protocol stack transporting Diameter, + +then the MME/SGSN shall set the DSCP marking for transport of the request or response according to the required priority level. + +Diameter requests related to high priority traffic (e.g. MPS as identified by the MME/SGSN via the RRC Establishment Cause IE set to the highPriorityAccess value as per 3GPP TS 36.413 [19] or through subscription information in the MPS-Priority AVP, emergency) shall contain a DRMP AVP with a high priority of which the level value is operator dependent. + +When not-explicitly requested, the inclusion and priority value of the DRMP AVP in Diameter messages are implementation specific. + +--- + +## Annex F (normative): Diameter load control mechanism + +### F.1 General + +IETF RFC 8583 [60] specifies a mechanism for sharing of Diameter load information. It includes the definition and the transfer of related AVPs between Diameter nodes. + +--- + +### F.2 S6a/S6d interfaces + +#### F.2.1 General + +Diameter load control mechanism is an optional feature. + +It is recommended to make use of IETF RFC 8583 [60] on the S6a/S6d interfaces where, when applied, the MME or the SGSN shall behave as receiving nodes and the HSS as a reporting node. + +#### F.2.2 HSS behaviour + +The HSS may report its current load by including a Load AVP of type HOST in answer commands as described in IETF RFC 8583 [60]. + +The HSS calculates its current load by implementation specific means. For example, the HSS may take into account the traffic over the S6a/d interfaces or other interfaces, the level of usage of internal resources (CPU, memory), the access to external resources, etc. + +The HSS determines when to send Load AVPs of type HOST by implementation specific means. + +#### F.2.3 MME/SGSN behaviour + +When performing next hop Diameter Agent selection for requests that are routed based on realm, the MME/SGSN may take into account load values from Load AVPs of type PEER received from candidate next hop Diameter nodes, as per IETF RFC 8583 [60]. + +## Annex G (informative): Change history + +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | New | +|---------|-------|-----------|------|-----|--------------------------------------------------------------------------|-------| +| 2008-09 | CT#41 | CP-080475 | | | V2.0.0 approved in CT#41 | 8.0.0 | +| 2008-12 | CT#42 | CP-080691 | 0001 | 1 | S6a Vendor-Specific-Application-Id AVP | 8.1.0 | +| | | CP-080691 | 0002 | 1 | RegSub feature | | +| | | CP-080691 | 0005 | - | Clarification on Immediate-Response-Preferred | | +| | | CP-080691 | 0006 | 1 | Correction of the Reference of Supported Features | | +| | | CP-080691 | 0007 | - | Definition of RAT-Frequency-Selection-Priority | | +| | | CP-080691 | 0008 | 2 | ME Identity Check | | +| | | CP-080703 | 0009 | 2 | Gr alignment | | +| | | CP-080971 | 0010 | 3 | Closed Subscriber Group | | +| | | CP-080691 | 0011 | - | AVP codes | | +| | | CP-080691 | 0012 | 1 | MSISDN AVP | | +| | | CP-080691 | 0013 | - | Result codes | | +| | | CP-080691 | 0014 | - | Removal of Editor's note in ULA Flag | | +| | | CP-080691 | 0015 | 2 | Duplicated AMBR AVP and Use of Called-Station-Id | | +| | | CP-080691 | 0017 | - | Change of AVP to carry the APN information | | +| | | CP-080691 | 0018 | 1 | Reference to 3GPP-Charging-Characteristics | | +| | | CP-080691 | 0019 | - | Access Restriction Data Definition | | +| | | CP-080691 | 0020 | - | AMBR Definition | | +| | | CP-080691 | 0021 | 1 | AVPs Encoding | | +| | | CP-080691 | 0022 | 1 | PDN-GW Delete | | +| | | CP-080691 | 0023 | 1 | Requesting Node Type Clarification | | +| | | CP-080691 | 0024 | - | Authn Session State AVP | | +| | | CP-080691 | 0026 | 2 | Trace Session Activation and Deactivation | | +| | | CP-080691 | 0027 | 1 | Context-Identifier in APN-Configuration-Profile | | +| | | CP-080691 | 0029 | - | APN-OIReplacement | | +| | | CP-080703 | 0032 | - | Access Restriction | | +| | | CP-080691 | 0033 | 1 | Context Identifier clarification | | +| | | CP-080691 | 0034 | 1 | APN-Configuration correction | | +| | | CP-080691 | 0037 | - | Removal of Supported RAT Types | | +| | | CP-080691 | 0039 | 1 | Extension of the Terminal-Information AVP for non-3GPP accesses | | +| | | CP-080691 | 0040 | - | Conditionality of ULA-Flags and PUA-Flags AVPs | | +| | | CP-080691 | 0042 | - | Wrong Description for Complete APN Configuration Profile Withdrawal | | +| | | CP-080691 | 0043 | - | Purge UE Detailed Behaviour | | +| | | CP-080691 | 0044 | 1 | MME/SGSN area restricted flag cleanup | | +| | | | | - | TS number in cover page corrected | 8.1.1 | +| 2009-03 | CT#43 | CP-090056 | 0048 | 2 | Context Identifier for Update or Removal of PDN GW | 8.2.0 | +| | | CP-090046 | 0049 | - | Clarification of the relationship between Subscriber-Status and ODB | | +| | | CP-090046 | 0051 | 2 | Context-Identifier in APN-Configuration-Profile | | +| | | CP-090024 | 0052 | - | Update of the AVP Codes | | +| | | CP-090236 | 0053 | 2 | PDN GW update for Wildcard APN | | +| | | CP-090044 | 0054 | 1 | Ready for SM | | +| | | CP-090046 | 0055 | - | ODB for SM | | +| | | CP-090044 | 0056 | 2 | Handling LCS Subscription Data | | +| | | CP-090046 | 0057 | 2 | Charging Characteristics | | +| | | CP-090046 | 0058 | 2 | Regional-Subscription-Zone-Code AVP Correction | | +| | | CP-090046 | 0059 | 2 | Trace Depth corrections | | +| | | CP-090046 | 0060 | 2 | Delete Subscriber Data Request procedure | | +| | | CP-090046 | 0063 | 1 | Coding definition for STN-SR | | +| | | CP-090046 | 0064 | - | Trace Reference in DSR | | +| | | CP-090046 | 0065 | 1 | DSR-Flags | | +| | | CP-090046 | 0066 | 2 | Clarification on All-APN-Configurations-Included-Indicator | | +| | | CP-090046 | 0069 | - | User-Name AVP contains only the IMSI | | +| | | CP-090046 | 0070 | 1 | MIP6-Agent-Info Definition and Usage | | +| | | CP-090046 | 0075 | 1 | Allocation Retention Priority | | +| | | CP-090046 | 0076 | 1 | APN includes only the Network Identifier | | +| | | CP-090046 | 0077 | - | Error Codes and ABNF Corrections | | +| | | CP-090039 | 0078 | 4 | User to HSS resolution | | +| | | CP-090046 | 0079 | 1 | Introducing the Trace-Collection-Entity AVP | | +| | | CP-090046 | 0081 | 4 | Usage of Immediate-Response-Preferred AVP | | +| | | CP-090044 | 0082 | 3 | Handling SMS Subscription Data | | +| | | CP-090046 | 0083 | - | SCTP version | | +| | | CP-090046 | 0084 | - | RFC 5447 References | | +| 2009-06 | CT#44 | CP-090287 | 0086 | 1 | Notification of SMS over IP Non-Delivery for E-UTRAN and UE Reachability | 8.3.0 | +| | | CP-090287 | 0087 | 1 | Coding of Immediate Response Preferred AVP | | + +| | | | | | | | +|---------|-------|-----------|------|---|-------------------------------------------------------------------------------|-------| +| | | CP-090287 | 0088 | - | Trace Event List | | +| | | CP-090287 | 0089 | - | Removal of Requesting Node Type from AIR | | +| | | CP-090287 | 0091 | - | Regional-Subscription-Zone-Code clarification | | +| | | CP-090287 | 0092 | - | Clarification of PLMN encoding | | +| | | CP-090287 | 0093 | - | Diameter Command Codes for S6a/S6d/S13/S13' | | +| | | CP-090287 | 0094 | - | Update of Diameter Codes | | +| | | CP-090287 | 0095 | 1 | Formatting of APN in Service-Selection AVP | | +| | | CP-090378 | 0096 | 3 | User Data Download Indication | | +| | | CP-090315 | 0097 | - | Usage of Single-Registration-Indication | | +| | | CP-090495 | 0098 | 3 | ULR processing enhancement | | +| 2009-09 | CT#45 | CP-090531 | 0100 | 2 | Correction on APN-OI-Replacement | 8.4.0 | +| | | CP-090726 | 0101 | 3 | GPRS subscription data over S6d | | +| | | CP-090531 | 0102 | 1 | Usage of DIAMETER_ERROR_UNKNOWN_EPS_SUBSCRIPTION | | +| | | CP-090531 | 0103 | 6 | Cancel Location for Initial Attach | | +| | | CP-090531 | 0104 | 4 | Subscriber Data Update | | +| | | CP-090531 | 0105 | 1 | Usage of Single Registration Indication | | +| | | CP-090531 | 0106 | 2 | Charging Characteristics Reference | | +| | | CP-090531 | 0107 | 1 | Alerting Reason Behaviour | | +| | | CP-090531 | 0108 | 1 | Wildcard APN | | +| | | CP-090531 | 0109 | - | Subscriber's NAM | | +| | | CP-090531 | 0111 | - | Trace ID length correction | | +| | | CP-090531 | 0112 | 1 | Subscription-Data AVP in Update Location Answer | | +| | | CP-090531 | 0113 | 1 | Default values for Allocation Retention Priority AVP | | +| | | CP-090531 | 0114 | - | Default APN and Wildcard APN | | +| | | CP-090531 | 0115 | 2 | Correction in behavior of DSR-Flags | | +| | | CP-090531 | 0116 | 1 | PDN Type | | +| | | CP-090531 | 0118 | 1 | Clarification on the process of skip subscriber data flag in the HSS | | +| | | CP-090532 | 0119 | 1 | Corrections on IDR ABNF and Service Type AVP | | +| | | CP-090532 | 0120 | 1 | TS-Code AVP is missing in DSR command | | +| | | CP-090532 | 0123 | 1 | Cleanup of the TS | | +| | | CP-090532 | 0124 | 1 | Format of User-Id | | +| | | CP-090532 | 0125 | 1 | GPRS Subscription Data Update | | +| | | CP-090532 | 0126 | 2 | APN-Configuration-Profile | | +| | | CP-090532 | 0128 | 1 | 3GPP2-MEID AVP | | +| | | CP-090532 | 0129 | 1 | MIP6-Agent-Info AVP | | +| | | CP-090532 | 0130 | - | Alignment of Supported Feature concept with 29.229 | | +| | | CP-090532 | 0133 | 1 | EPS Subscribed QoS | | +| | | CP-090532 | 0137 | 1 | Restruction of the TS 29.272 | | +| | | CP-090532 | 0138 | 1 | Trace Depth per session | | +| | | CP-090532 | 0140 | - | Clarification of Unsigned32 bit flag AVPs | | +| | | CP-090532 | 0141 | 1 | Extra Regional-Subscription-Zone-Codes | | +| | | CP-090532 | 0142 | 1 | Clarification of Service-Selection AVP encoding | | +| | | CP-090532 | 0143 | 1 | User to HSS identity resolution for Diameter Proxy Agents | | +| | | CP-090532 | 0144 | - | RFSP coding | | +| 2009-09 | CT#45 | CP-090556 | 0122 | 3 | Optimization of Subscriber Data Update | 9.0.0 | +| | | CP-090562 | 0131 | | Emergency Support in S6a | | +| 2009-12 | CT#46 | CP-091030 | 0148 | 4 | Clarification on Some Subscription Data List Handling in MME/SGSN | 9.1.0 | +| | | CP-090793 | 0149 | 1 | APN level APN-OI-Replacement | | +| | | CP-090800 | 0150 | 2 | ICS-Flag | | +| | | CP-090767 | 0152 | 2 | RFSP alignment in 29.272 | | +| | | CP-090801 | 0153 | 1 | Notify Request for Emergency Attached UEs | | +| | | CP-090767 | 0155 | 2 | Wildcard APN | | +| | | CP-090767 | 0157 | 1 | Lifetime of Charging Characteristics after Change | | +| | | CP-091030 | 0159 | 2 | Correction on the UE initiated detach procedure | | +| | | CP-090767 | 0163 | 2 | FQDN for S6a NOR | | +| | | CP-090767 | 0165 | - | HPLMN-ODB AVP correction | | +| | | CP-091032 | 0167 | | From GMLC-Address to GMLC-Number | | +| | | CP-091030 | 0171 | 1 | Static PDN GW | | +| | | CP-091030 | 0177 | 1 | Clarification on Usage of Re-Synchronization-Info AVP | | +| | | CP-091030 | 0179 | 1 | Clarification on the Number of PDP-Contexts in the GPRS-Subscription-Data AVP | | +| | | CP-090767 | 0185 | - | APN-Configuration-Profile usage in IDR | | +| | | CP-091030 | 0187 | 2 | IMEI encoding | | +| | | CP-091030 | 0189 | 1 | APN-Configuration Service-Selection values | | +| | | CP-091030 | 0191 | 1 | QoS attributes | | +| | | CP-090789 | 0196 | 1 | Subscription-Data clarification for UE Reachability | | +| | | CP-091030 | 0198 | 2 | Vendor Specific Application ID | | +| | | CP-090776 | 0200 | 1 | Destination Realm | | +| | | CP-090767 | 0202 | - | Correction to fault recovery procedure and ME identity check procedure | | +| | | CP-090767 | 0204 | - | Reference of 3GPP-Charging-Characteristics | | +| | | CP-090767 | 0206 | - | Reset procedure MME/SGSN behavior | | + +| | | | | | | +|---------------|-----------|------|---|----------------------------------------------------------------------------------------------|--------| +| 2010-03 CT#47 | CP-100020 | 0181 | 2 | Correction to Purge UE Detailed Behaviour | 9.2.0 | +| | CP-100020 | 0210 | | HPLMN ODB | | +| | CP-100048 | 0211 | 2 | TADS support in S6a/S6d | | +| | CP-100020 | 0217 | | Cancellation-Type clarifications | | +| | CP-100020 | 0219 | 1 | IETF References update | | +| | CP-100020 | 0221 | | Static PDN GW | | +| | CP-100046 | 0222 | 1 | Addition of V-GMLC address for S6a | | +| | CP-100020 | 0223 | 1 | Handling of UE Reachability MME Parameter | | +| | CP-100020 | 0227 | | Indication of PLMN ID of the selected PGW | | +| | CP-100040 | 0228 | | Context-Identifier in NOR | | +| | CP-100235 | 0230 | 5 | EPS Subscriber State and Location Information Request | | +| | CP-100040 | 0233 | 1 | Reset to Combined MME/SGSN | | +| | CP-100040 | 0234 | 1 | NOR-Flags correction | | +| 2010-06 CT#48 | CP-100040 | 0236 | 2 | Indication of LCS Capabilities support over S6a/S6d | 9.3.0 | +| | CP-100040 | 0238 | 1 | Fix ambiguity on context id AVP | | +| | CP-100264 | 0241 | 1 | Service-Selection values | | +| | | 0243 | 1 | MIP6-Agent-Info | | +| | | 0245 | 2 | Fix ambiguity on usage of the Supported-Features AVP | | +| | | 0260 | 1 | Correction of Context-Identifier | | +| | CP-100277 | 0247 | 1 | Dynamic information update after a Reset procedure | | +| | | 0248 | 1 | Notify command from unknown MME | | +| | CP-100416 | 0249 | 4 | S6a Error Codes | | +| 2010-09 CT#49 | CP-100279 | 0258 | 3 | URRP for SGSN | 9.4.0 | +| | CP-100265 | 0262 | 3 | MME mapping between Diameter error codes and NAS Cause Code values | | +| | CP-100456 | 0268 | 1 | Restoration of the SGSN Number in the VLR | | +| | CP-100457 | 0272 | | QoS-Subscribed | | +| | CP-100457 | 0273 | | Trace-Reference AVP encoding | | +| | CP-100457 | 0284 | | Usage of MIP-Home-Agent-Host AVP | | +| | CP-100457 | 0285 | | Correction on HSS behaviour about IMEI | | +| | CP-100577 | 0275 | 2 | NAS Cause Code values | | +| | CP-100463 | 0276 | | LCS Privacy Features for MME | | +| | CP-100443 | 0281 | 2 | Correction to Delete Subscriber Data for SGSN | | +| 2010-09 CT#49 | CP-100443 | 0283 | 1 | Unclear Cancel-Type Setting for Single Registration and Initial Attach | 10.0.0 | +| | CP-100465 | 0267 | 1 | Addition of SIPTO permissions in PS subscription data | | +| 2010-10 CT#50 | CP-100689 | 0324 | 1 | HSS Error Returned due to ODB | 10.1.0 | +| | CP-100689 | 0316 | 1 | Clarification on Access Restriction Data | | +| | CP-100698 | 0297 | 1 | Removal of Notify Messages during detach or last PDN connection deactivation via 3GPP access | | +| | CP-100679 | 0303 | 1 | Usage of Served Party IP Address AVP inside the APN Configuration | | +| | CP-100679 | 0305 | 1 | Usage of APN-OI-Replacement AVP | | +| | CP-100679 | 0307 | | AMBR clarification | | +| | CP-100679 | 0308 | | Store HSS Identity in MME/SGSN after successful ULA | | +| | CP-100679 | 0315 | 3 | Fix ambiguity in the LCS related indication | | +| | CP-100679 | 0327 | 2 | Unknown EPS Subscription | | +| | CP-100688 | 0325 | 1 | Periodic TAU/RAU timer in HSS subscription | | +| | CP-100707 | 0313 | 1 | Correction of Restoration flag | | +| | CP-100707 | 0319 | | Default APN and Wildcard APN | | +| | CP-100707 | 0322 | 1 | Usage of PGW Allocation Type AVP | | +| | CP-100699 | 0323 | | Usage of STN-SR AVP | | +| | CP-100699 | 0291 | 3 | Enhanced SRVCC | | +| | CP-100687 | 0290 | 4 | Addition of MPS Priority in Subscription Data | | +| | CP-100683 | 0289 | 1 | Addition of LIPA permission in Subscription Data | | +| | CP-100684 | 0288 | 1 | SIPTO Permission for Wildcard APN | | +| 2011-03 CT#51 | CP-110087 | 0329 | 2 | Minimization of Drive Tests (MDT) | 10.2.0 | +| | CP-110042 | 0330 | 2 | Feature Flags for UE Reachability Notification and State/Location Info Retrieval | | +| | CP-110042 | 0337 | 3 | Correction of error cause handling | | +| | CP-110042 | 0339 | 2 | Setting of M bit AVP flag | | +| | CP-110042 | 0343 | 1 | AMBR Correction | | +| | CP-110073 | 0332 | 2 | Correction on PGW PLMN ID | | +| | CP-110088 | 0334 | 2 | Relay Node Indicator | | +| | CP-110051 | 0346 | 1 | PDP Address correction | | +| | CP-110051 | 0351 | 2 | Ambiguity in IDR flags | | +| 2011-06 CT#52 | CP-110051 | 0353 | | Homogeneous Support for IMS Voice over PS AVP missing | 10.3.0 | +| | CP-110351 | 0362 | | SGSN-Number AVP correction | | +| | CP-110380 | 0357 | 2 | MDT user consent | | +| 2011-09 CT#53 | CP-110375 | 0363 | 1 | Purge from Combined MME/SGSN | 10.4.0 | +| | CP-110562 | 0372 | 1 | Active-APN AVP definition | | +| | CP-110562 | 0374 | | Context-Identifier when interworking with GTPv1 | | +| | CP-110562 | 0380 | 1 | APN-AMBR for GPRS | | + +| | | | | | | +|---------------|-----------|------|----|----------------------------------------------------------------------------|--------| +| 2011-09 CT#53 | CP-110565 | 0377 | | Correction on DIAMETER_AUTHORIZATION_REJECTED | 11.0.0 | +| | CP-110699 | 0381 | | Correction of implementation error in TS 29.272, CR 324 | | +| | CP-110581 | 0369 | 2 | Behaviour of HSS in abnormal case of Immediate-Response-Preferred AVP | | +| | CP-110584 | 0370 | 3 | Add vSRVCC updates to the S6a interface | | +| 2011-12 CT#54 | CP-110787 | 0390 | 1 | Unknown EPS Subscription over S6d/S6a | 11.1.0 | +| | CP-110811 | 0387 | 2 | Equivalent PLMN CSG Subscription Request | | +| | CP-110787 | 0397 | 1 | M-bit Handling | | +| 2012-03 CT#55 | CP-120023 | 0409 | 1 | GMLC-Number format | 11.2.0 | +| | CP-120025 | 0399 | 3 | Initial Attach Indication in CLR | | +| | CP-120029 | 0406 | | T-ADS data request for detached UE | | +| | CP-120029 | 0410 | 1 | Removal of Subscribed Periodic TAU/RAU timer in HSS subscription | | +| | CP-120037 | 0400 | | Clarification on UE-SRVCC-Capability AVP in ULR | | +| | CP-120037 | 0402 | | ODB clarification | | +| | CP-120037 | 0403 | 2 | S6a location reporting | | +| 2012-06 CT#56 | CP-120240 | 0401 | 3 | CSG ID and Local Time for NPLI | 11.3.0 | +| | CP-120413 | 0415 | 4 | Ready for SM in MME | | +| | CP-120249 | 0418 | 1 | ULR handling for combined MME/SGSN | | +| | CP-120249 | 0419 | | Clarification on Update of PGW ID | | +| 2012-09 CT#57 | CP-120476 | 0382 | 10 | VCSG procedures over S7a/S7d | 11.4.0 | +| | CP-120476 | 0394 | 5 | Delete CSG subscription Data over S7a /S7d | | +| | CP-120476 | 0416 | 4 | VCSG Reset procedure over S7a/S7d | | +| | CP-120481 | 0404 | 5 | PS additional number over S6a/S6d | | +| | CP-120462 | 0421 | - | Single Registration Indication | | +| | CP-120462 | 0422 | - | Zone Codes | | +| | CP-120462 | 0423 | - | Clarification on Notification of UE Reachability | | +| | CP-120462 | 0428 | - | CSG-Subscription-Data replacement | | +| | CP-120462 | 0430 | 1 | Update of Homogeneous Support of IMS Over PS Sessions | | +| | CP-120462 | 0434 | 2 | Mapping S6a and NAS cause code | | +| | CP-120473 | 0429 | 4 | SMS in MME | | +| | CP-120473 | 0432 | 1 | SMS in SGSN | | +| | CP-120480 | 0433 | 2 | Local Time Zone | | +| | CP-120722 | 0441 | 1 | User-CSG-Information | | +| 2012-12 CT#58 | CP-120713 | 0457 | 1 | SGSN-Number AVP | 11.5.0 | +| | CP-120740 | 0436 | 1 | Application ID for S7a/S7d | | +| | CP-120740 | 0443 | 2 | Empty VCSG Subscription Data | | +| | CP-120742 | 0438 | 1 | Notification Procedure clarification for UE with Emergency Bearer Services | | +| | CP-120742 | 0445 | - | Inclusion of APN-OI Replacement in PDP Context | | +| | CP-120742 | 0450 | - | Correction in the chapter of Reset-Answer (RSA) command | | +| | CP-120742 | 0452 | 1 | UE Time Zone | | +| | CP-120742 | 0453 | 1 | Corrections to Local Time Zone | | +| | CP-120742 | 0454 | 2 | Clarification on IDR-Flags | | +| | CP-120742 | 0455 | - | Correction of General Description of Delete Subscriber Data | | +| | CP-120742 | 0458 | - | DSR-Flags | | +| | CP-120742 | 0461 | 1 | Wrong implementation of the Daylight-Saving-Time AVP | | +| | CP-120736 | 0446 | 1 | A-MSISDN Correction | | +| | CP-120732 | 0447 | 1 | MME network condition to NAS cause code mapping | | +| | CP-120732 | 0448 | 2 | SGSN network condition to NAS cause code mapping | | +| | CP-120732 | 0449 | 3 | MME de-registration for "SMS in MME" | | +| | CP-120732 | 0451 | 1 | Correction on Update Location Request | | +| | CP-120732 | 0459 | 1 | Alignment of stage 3 SMS in MME with stage 2 | | +| | CP-120741 | 0460 | 1 | Use of Flag instead of Enumerated AVPs | | +| 2013-03 CT#59 | CP-130022 | 0466 | - | Corrections to wrong references and command/AVP name | 11.6.0 | +| | CP-130022 | 0467 | 1 | Update to Subscription-Data-Flags | | +| | CP-130022 | 0471 | 1 | Values not allowed for QCI over S6a/S6d | | +| | CP-130022 | 0472 | 1 | Cause Code Mapping | | +| | CP-130022 | 0470 | 1 | Registration for SMS Request for SMS in SGSN | | +| | CP-130025 | 0474 | - | MDT parameters | | +| 2013-03 CT#59 | CP-130031 | 0442 | 3 | Check of Serving Node for S6a Security | 12.0.0 | +| | CP-130031 | 0468 | 1 | MME name encoding over S6a | | +| | CP-130156 | 0475 | 1 | SGSN indicating support of Lgd interface to HSS | | +| 2013-06 CT#60 | CP-130380 | 0490 | 1 | Removal of SMS-Only AVP and Typo Corrections on Some AVP Definitions | 12.1.0 | +| | CP-130380 | 0501 | 2 | MME identity for restoration procedures | | +| | CP-130380 | 0492 | 1 | Definition of A New Feature-List | | +| | CP-130380 | 0488 | 1 | UE-SRVCC-Capability Update Clarification | | +| | CP-130380 | 0483 | - | Reset clarification | | +| | CP-130380 | 0481 | 2 | AIR rejection | | +| | CP-130380 | 0479 | 1 | Storing Last known Location Information of purged UE in HSS | | +| | CP-130380 | 0512 | 1 | Maximum value for the subscribed periodic RAU TAU timer | | +| | CP-130279 | 0497 | 1 | Definition of SS Status for Call Barring | | + +| | | | | | | | +|---------|-------|-----------|------|---|------------------------------------------------------------------------------------------------------------------------------|--------| +| | | CP-130378 | 0489 | 2 | SIPTO permission for Local Network enhancements | | +| | | CP-130288 | 0487 | - | PS Location Info request with RAT-type | | +| | | CP-130309 | 0482 | - | CSS clarification | | +| | | CP-130295 | 0478 | - | Restoration Priority during SGW and PGW restoration procedures | | +| | | CP-130410 | 0508 | 1 | HSS handling of T-ADS for detached subscriber | | +| 2013-09 | CT#61 | CP-130444 | 0515 | - | Correction to the restoration priority levels during SGW and PGW restoration procedures | 12.2.0 | +| | | CP-130450 | 0517 | - | HPLMN-ODB Correction | | +| | | CP-130463 | 0518 | 2 | CancelLocation requesting reattach | | +| | | CP-130456 | 0519 | 1 | Indication of Gdd support over S6d | | +| | | CP-130461 | 0520 | 2 | Homogeneous Support Of Voice over IP | | +| | | CP-130461 | 0521 | 1 | Definition of User-State values | | +| | | CP-130461 | 0522 | 1 | Context Identifier Range Inconsistency | | +| 2013-12 | CT#62 | CP-130611 | 0528 | 1 | Addtion of S6aS6d-Indicator in NOR | 12.3.0 | +| | | CP-130617 | 0533 | 1 | MME Initiated Removal of MME Registration for SMS | | +| | | CP-130624 | 0523 | 1 | Combined MME/SGSN indicating the support for optimized LCS procedure | | +| | | CP-130624 | 0526 | 1 | Clarification on Description of Features for LCS | | +| | | CP-130644 | 0525 | 1 | SMS in MME | | +| | | CP-130623 | 0529 | 1 | Alert Service Center sent over S6c | | +| | | CP-130632 | 0530 | 1 | Purge Clarification | | +| | | CP-130639 | 0531 | 1 | SGSN CAMEL Subscription Indication | | +| 2014-03 | CT#63 | CP-140035 | 0534 | 2 | Clarification on Current-Location-Retrieved and Age-of-Location-Information | 12.4.0 | +| | | CP-140035 | 0536 | 3 | Mechanism to determine if the UE is served by the MME and SGSN parts of the same combined MME/SGSN | | +| | | CP-140035 | 0537 | - | Call-Barring-Info AVP | | +| | | CP-140035 | 0538 | - | Missing SGs-MME-Identity AVP in the ULR | | +| 2014-06 | CT#64 | CP-140257 | 0544 | 1 | SS-Status AVP Definition | 12.5.0 | +| | | CP-140264 | 0555 | 3 | Cause Mapping for ODB | | +| | | CP-140264 | 0556 | 2 | NOR Error User Unknown | | +| | | CP-140254 | 0557 | 1 | Enhancement for ProSe | | +| | | CP-140413 | 0558 | - | Correction on SGSN CAMEL Capability in Supported-Features | | +| | | CP-140243 | 0540 | 5 | Diameter overload control mechanism | | +| | | CP-140243 | 0559 | 1 | Diameter overload over S6a/d | | +| 2014-09 | CT#65 | CP-140523 | 0564 | 2 | Clarification on ProSe Subscription Data | 12.6.0 | +| | | CP-140514 | 0565 | 2 | WLAN offloadability defined in HSS | | +| | | CP-140506 | 0567 | 2 | P-CSCF Restoration Indication | | +| 2014-12 | CT#66 | CP-140772 | 0569 | 2 | Reset-ID | 12.7.0 | +| | | CP-140772 | 0581 | 3 | M-bit setting of Supported-Features AVP | | +| | | CP-140764 | 0571 | - | MDT PLMN List | | +| | | CP-140764 | 0580 | 1 | S6a/S6d-Indicator in NOR | | +| | | CP-140790 | 0575 | 1 | Priority Consideration for Diameter Overload Control | | +| 2014-12 | CT#66 | CP-140765 | 0574 | 2 | Roaming Subscription Corresponding to Specific RAT | 13.0.0 | +| | | CP-140759 | 0578 | 2 | Stored HSS Identity for HSS Restoration Procedure | | +| 2015-03 | CT#67 | CP-150035 | 0582 | 1 | Clarification on the usage of SV in IMEI check procedure | 13.1.0 | +| 2015-06 | CT#68 | CP-150265 | 0583 | 1 | Cleanup and small error corrections | 13.2.0 | +| | | CP-150263 | 0584 | 2 | Access Restriction Data per PLMN | | +| | | CP-150279 | 0585 | 1 | Alignment of using ProSe and ProSe services | | +| 2015-09 | CT#69 | CP-150427 | 0597 | - | Wrong Application-ID for S7a Diameter Application | 13.3.0 | +| | | CP-150454 | 0586 | 3 | Subscription data for extended buffering at the SGW | | +| | | CP-150453 | 0587 | 2 | Introducing IMSI-Group ID Lists to the subscription Info | | +| | | CP-150449 | 0588 | 3 | Addition of CP parameters to subscription data | | +| 2015-12 | CT#70 | CP-150778 | 0590 | 9 | Add MTC Monitoring support | 13.4.0 | +| | | CP-150778 | 0606 | 1 | Roaming and interaction with the IWK-SCEF | | +| | | CP-150778 | 0607 | 4 | Introducing a Bitmask to inform the HSS of the Monitoring capabilities of the MME/SGSN | | +| | | CP-150778 | 0609 | 2 | Deletion of all Monitoring events assigned to a subscriber (UE) | | +| | | CP-150785 | 0598 | 1 | DL-Buffering-Suggested-Packet-Count AVP | | +| | | CP-150781 | 0600 | 1 | Retrieval of "UE Usage Type" over S6a/S6d | | +| | | CP-150762 | 0601 | 1 | Clarification of precedence between UE-level "HO to non-3GPP access" access restriction, and APN-level "WLAN-Offloadability" | | +| | | CP-150768 | 0602 | 4 | Diameter message priority over S6a/d | | +| | | CP-150771 | 0604 | 2 | Introduction of validity time delete and replace procedure for CP sets | | +| | | CP-150755 | 0611 | 1 | ProSe in combined MME/SGSN | | +| | | CP-150744 | 0614 | - | Erroneous AVP code for some MDT parameters | | +| | | CP-150759 | 0614 | 1 | Update reference to DOIC new IETF RFC | | +| | | CP-150776 | 0615 | 1 | Mobile Terminating SMS handling for extended Idle mode DRX | | +| 2016-03 | CT#71 | CP-160029 | 0618 | 2 | Notifying the status of MONTE event configuration at the IWK-SCEF to the HSS | 13.5.0 | +| | | CP-160043 | 0619 | 1 | Fix the issue on HSS restart procedure | | +| | | CP-160039 | 0620 | 1 | User Plane Integrity Protection Indicator | | +| | | CP-160029 | 0621 | 3 | Configure Monitoring Event to Multiple Serving Nodes | | + +| | | | | | | | +|---------|-------|-----------|------|---|---------------------------------------------------------------------------------|--------| +| | | CP-160033 | 0623 | 1 | Allow SMS for NB-IoT UE without Combined Attach | | +| | | CP-160045 | 0625 | - | Adjacent PLMNs | | +| | | CP-160045 | 0626 | 1 | Invocation of Alert procedure by HSS after ULR | | +| | | CP-160023 | 0629 | 1 | Diameter message priority over S7a/d, S13, S13' | | +| | | CP-160033 | 0630 | 2 | Addition of NB-IoT radio access type to the Access-Restriction-Data feature | | +| | | CP-160033 | 0631 | 3 | New PDN-Type for Cellular IoT | | +| 2016-03 | | | | | Table 7.3.1/1 formatted | 13.5.1 | +| 2016-06 | CT#72 | CP-160215 | 0643 | 1 | Diameter requests for priority traffic during overload control mechanism | 13.6.0 | +| 2016-06 | CT#72 | CP-160238 | 0628 | 3 | Subscription Data for combined MME/SGSN | 13.6.0 | +| 2016-06 | CT#72 | CP-160238 | 0632 | 1 | Cause Mapping | 13.6.0 | +| 2016-06 | CT#72 | CP-160238 | 0633 | - | Correction on Service-Selection | 13.6.0 | +| 2016-06 | CT#72 | CP-160238 | 0639 | 2 | Group-Service-Id | 13.6.0 | +| 2016-06 | CT#72 | CP-160233 | 0635 | - | Renaming of Validity-Time AVP | 13.6.0 | +| 2016-06 | CT#72 | CP-160228 | 0636 | - | Update SMS Support for NB-IoT | 13.6.0 | +| 2016-06 | CT#72 | CP-160225 | 0637 | 2 | SCEF realm | 13.6.0 | +| 2016-06 | CT#72 | CP-160222 | 0638 | 2 | Shared Subscription data update | 14.0.0 | +| 2016-06 | CT#72 | CP-160217 | 0640 | 1 | Support for Non-IP PDP types | 14.0.0 | +| 2016-06 | CT#72 | CP-160221 | 0641 | 1 | MSISDN Removal from Subscription Profile | 14.0.0 | +| 2016-09 | CT#73 | CP-160423 | 0645 | - | PDN-Connection-Restricted flag | 14.1.0 | +| 2016-09 | CT#73 | CP-160423 | 0647 | 1 | Preferred Data Mode for an SGi PDN connection | 14.1.0 | +| 2016-09 | CT#73 | CP-160428 | 0652 | - | CR implementation error on ECR and ECA commands | 14.1.0 | +| 2016-09 | CT#73 | CP-160426 | 0658 | 2 | Current Location Retrieval | 14.1.0 | +| 2016-09 | CT#73 | CP-160437 | 0649 | 1 | Removal of Editor's Note on non shareable subscription data | 14.1.0 | +| 2016-09 | CT#73 | CP-160437 | 0650 | - | Removal of Editor's Note on detailed checks for shared subscription data update | 14.1.0 | +| 2016-09 | CT#73 | CP-160437 | 0656 | 2 | Solution to avoid high load resulting from shared subscription data update | 14.1.0 | +| 2016-09 | CT#73 | CP-160433 | 0653 | - | Change of Network Access Mode | 14.1.0 | +| 2016-09 | CT#73 | CP-160432 | 0654 | - | Usage of Supported Features | 14.1.0 | +| 2016-09 | CT#73 | CP-160432 | 0655 | - | Handling of MSISDN removal from subscription profile | 14.1.0 | +| 2016-12 | CT#74 | CP-160679 | 0659 | 4 | Handover of Emergency PDN Connections | 14.2.0 | +| 2016-12 | CT#74 | CP-160673 | 0660 | 1 | Reset-ID AVP description for shared subscription data update | 14.2.0 | +| 2016-12 | CT#74 | CP-160673 | 0671 | 1 | Update of "Homogeneous Support" Status | 14.2.0 | +| 2016-12 | CT#74 | CP-160673 | 0684 | 1 | Missing S7a/S7d application identifier | 14.2.0 | +| 2016-12 | CT#74 | CP-160654 | 0662 | 1 | Communication-Pattern Feature | 14.2.0 | +| 2016-12 | CT#74 | CP-160681 | 0666 | 1 | Load Control | 14.2.0 | +| 2016-12 | CT#74 | CP-160681 | 0677 | 1 | Host Load | 14.2.0 | +| 2016-12 | CT#74 | CP-160665 | 0668 | 1 | Dynamic Removal of UE Usage Type | 14.2.0 | +| 2016-12 | CT#74 | CP-160665 | 0674 | 1 | Presence of UE Usage Type in Error Responses | 14.2.0 | +| 2016-12 | CT#74 | CP-160657 | 0670 | 1 | Undefined Bits in Access Restriction Data | 14.2.0 | +| 2016-12 | CT#74 | CP-160678 | 0672 | 1 | Add V2X Subscription Data to S6a Interface | 14.2.0 | +| 2016-12 | CT#74 | CP-160664 | 0682 | - | Correction to change IETF drmp draft version to official RFC 7944 | 14.2.0 | +| 2016-12 | CT#74 | CP-160660 | 0683 | 1 | Deletion of all monitoring events | 14.2.0 | +| 2017-03 | CT#75 | CP-170028 | 0692 | 1 | Maximum Response Time | 14.3.0 | +| 2017-03 | CT#75 | CP-170039 | 0687 | 1 | Enhanced Coverage | 14.3.0 | +| 2017-03 | CT#75 | CP-170039 | 0688 | 1 | Inter-RAT PDN-Continuity | 14.3.0 | +| 2017-03 | CT#75 | CP-170044 | 0693 | 1 | Emergency-Info AVP in ULA | 14.3.0 | +| 2017-03 | CT#75 | CP-170043 | 0696 | 1 | Correct UE-PC5-AMBR Format | 14.3.0 | +| 2017-03 | CT#75 | CP-170036 | 0697 | 2 | Removal of complete APN Configuration Profile | 14.3.0 | +| 2017-03 | CT#75 | CP-170036 | 0698 | 1 | Clarification of MDT User Consent | 14.3.0 | +| 2017-03 | CT#75 | CP-170036 | 0699 | 1 | Missing M/O values in several feature flags | 14.3.0 | +| 2017-03 | CT#75 | CP-170036 | 0700 | 2 | Subscription parameters for eDRX | 14.3.0 | +| 2017-03 | CT#75 | CP-170036 | 0701 | 2 | Support of long and short Macro eNodeB IDs | 14.3.0 | +| 2017-03 | CT#75 | CP-170048 | 0704 | - | Update of reference for the Diameter base protocol | 14.3.0 | +| 2017-03 | CT#75 | CP-170048 | 0705 | - | Handling of the Vendor-Specific-Application-Id AVP | 14.3.0 | +| 2017-03 | CT#75 | CP-170048 | 0706 | - | Cardinality of the Failed-AVP AVP in answer | 14.3.0 | +| 2017-06 | CT#76 | CP-171029 | 0707 | 1 | External Identifier in Subscription-Data | 14.4.0 | +| 2017-06 | CT#76 | CP-171021 | 0709 | - | Alignment of PDN-Connection-Restricted Flag handling on NAS specification | 14.4.0 | +| 2017-06 | CT#76 | CP-171017 | 0713 | 1 | Add MBSFN Area List to MDT Configuration parameters | 14.4.0 | +| 2017-06 | CT#76 | CP-171184 | 0715 | 2 | Communication Patterns without Expiry Time | 14.4.0 | +| 2017-06 | CT#76 | CP-171029 | 0717 | 1 | Loss Of Connectivity Reason in S6a/d IDA | 14.4.0 | +| 2017-06 | CT#76 | CP-171018 | 0720 | 1 | Support for signaling transport level packet marking | 14.4.0 | +| 2017-06 | CT#76 | CP-171043 | 0718 | 1 | Clarification of S6a/Notification-Request command for non-IP APNs | 15.0.0 | +| 2017-06 | CT#76 | CP-171041 | 0721 | - | Removal of UE-Usage-Type | 15.0.0 | +| 2017-09 | CT#77 | CP-172027 | 0727 | 1 | Access Restriction to NR as Secondary RAT | 15.1.0 | +| 2017-09 | CT#77 | CP-172027 | 0728 | 1 | Extended QoS for 5G NR | 15.1.0 | +| 2017-09 | CT#77 | CP-172018 | 0729 | 1 | Acknowledgements of downlink NAS data PDUs | 15.1.0 | +| 2017-09 | CT#77 | CP-172018 | 0730 | 1 | Reliable Data Service | 15.1.0 | +| 2017-09 | CT#77 | CP-172026 | 0731 | 1 | Enhancements for NAPS on Idle Status Indication | 15.1.0 | +| 2017-09 | CT#77 | CP-172013 | 0736 | - | Correction of DRMP Procedures | 15.1.0 | + +| | | | | | | | +|---------|--------|-----------|------|---|--------------------------------------------------------------------------|--------| +| 2017-12 | CT#78 | CP-173016 | 0743 | 1 | Correction on subscribed eDRX parameter value | 15.2.0 | +| 2017-12 | CT#78 | CP-173028 | 0740 | 1 | Clarification of UE Reachability monitoring event over S6a/S6d | 15.2.0 | +| 2017-12 | CT#78 | CP-173025 | 0741 | - | Error in the DIAMETER_ERROR_EQUIPMENT_UNKNOWN name | 15.2.0 | +| 2017-12 | CT#78 | CP-173025 | 0744 | 3 | Active Time in Insert Subscriber Data | 15.2.0 | +| 2017-12 | CT#78 | CP-173035 | 0746 | 1 | Access restriction to unlicensed spectrum as secondary RAT | 15.2.0 | +| 2017-12 | CT#78 | CP-173036 | 0747 | 1 | Access Restrictions to NR as Secondary RAT on MM Context | 15.2.0 | +| 2018-03 | CT#79 | CP-180013 | 0755 | 2 | Handling of Homogenous-Support-of-IMS-Voice-Over-PS-Sessions AVP | 15.3.0 | +| 2018-03 | CT#79 | CP-180021 | 0756 | - | Service Gap Time | 15.3.0 | +| 2018-03 | CT#79 | CP-180025 | 0757 | 1 | Filtering the Report for Number of UEs in a Geographic Area | 15.3.0 | +| 2018-06 | CT#80 | CP-181122 | 0758 | - | Bandwidth Clarification | 15.4.0 | +| 2018-06 | CT#80 | CP-181122 | 0759 | 1 | Supported-Services AVP code | 15.4.0 | +| 2018-06 | CT#80 | CP-181122 | 0762 | 1 | Subscription for Aerial UE in 3GPP system | 15.4.0 | +| 2018-06 | CT#80 | CP-181124 | 0765 | 1 | Subscription data for ciphering keys | 15.4.0 | +| 2018-06 | CT#80 | CP-181133 | 0763 | 1 | Access Restrictions | 15.4.0 | +| 2018-09 | CT#81 | CP-182077 | 0766 | - | Update of Broadcast-Location-Assistance-Data-Types AVP | 15.5.0 | +| 2018-09 | CT#81 | CP-182067 | 0767 | 2 | Access Restriction Data for NR as Secondary RAT not supported by HSS | 15.5.0 | +| 2018-09 | CT#81 | CP-182067 | 0774 | - | Applicable values for AMBR | 15.5.0 | +| 2018-09 | CT#81 | CP-182075 | 0768 | 1 | Handling of monitoring events in ULA | 15.5.0 | +| 2018-09 | CT#81 | CP-182072 | 0769 | 1 | Subscribed PTW length | 15.5.0 | +| 2018-09 | CT#81 | CP-182072 | 0770 | 1 | DSR-Flag for Active-Time | 15.5.0 | +| 2018-09 | CT#81 | CP-182071 | 0771 | 2 | DSR-Flag for eDRX-Cycle-Length | 15.5.0 | +| 2018-09 | CT#81 | CP-182084 | 0773 | - | Access Restrictions | 15.5.0 | +| 2018-12 | CT#82 | CP-183092 | 0775 | 4 | Single Registration | 15.6.0 | +| 2018-12 | CT#82 | CP-183092 | 0776 | 1 | Interworking with 5GS indicator in APN Subscription | 15.6.0 | +| 2018-12 | CT#82 | CP-183092 | 0789 | 2 | MME_UPDATE_PROCEDURE | 15.6.0 | +| 2018-12 | CT#82 | CP-183098 | 0785 | 1 | Deletion of monitoring events when unknown in SCEF | 15.6.0 | +| 2018-12 | CT#82 | CP-183098 | 0786 | - | Event configuration failure in ULA | 15.6.0 | +| 2018-12 | CT#82 | CP-183098 | 0787 | 1 | Idle-Status-Indication is missing in monitoring event report | 15.6.0 | +| 2018-12 | CT#82 | CP-183098 | 0788 | 1 | Applicability of Maximum Number of Reports | 15.6.0 | +| 2018-12 | CT#82 | CP-183100 | 0784 | 3 | Behavior of MME/SGSN upon reception of DIAMETER_UNABLE_TO_COMPLY for NOR | 15.6.0 | +| 2018-12 | CT#82 | CP-183100 | 0790 | 1 | Paging Time Window | 15.6.0 | +| 2019-03 | CT#83 | CP-190034 | 0791 | 1 | eDRX AVPs | 15.7.0 | +| 2019-03 | CT#83 | CP-190038 | 0792 | - | Missing Maximum-UE-Availability-Time AVP | 15.7.0 | +| 2019-03 | CT#83 | CP-190034 | 0794 | 1 | Access Restriction to NR as Secondary RAT for SGSN | 15.7.0 | +| 2019-03 | CT#83 | CP-190034 | 0795 | - | Paging-Time-Window AVP name | 15.7.0 | +| 2019-03 | CT#83 | CP-190037 | 0796 | 1 | Handling of multiple external IDs for the same UE | 15.7.0 | +| 2019-06 | CT#84 | CP-191023 | 0797 | - | Service Gap Time Deletion | 15.8.0 | +| 2019-09 | CT#85 | CP-192094 | 0804 | 2 | draft-ietf-dime-load published as RFC 8583 | 15.9.0 | +| 2019-09 | CT#85 | CP-192121 | 0801 | 1 | Communication pattern enhancement | 16.0.0 | +| 2019-09 | CT#85 | CP-192122 | 0800 | 1 | Event type PDN Connectivity Status | 16.0.0 | +| 2019-09 | CT#85 | CP-192122 | 0802 | - | Ethernet PDN Type | 16.0.0 | +| 2019-12 | CT#86 | CP-193024 | 0808 | - | Applicability of Core Network Restrictions | 16.1.0 | +| 2019-12 | CT#86 | CP-193038 | 0809 | 1 | Subscribed ARPI | 16.1.0 | +| 2019-12 | CT#86 | CP-193038 | 0810 | - | LTE-M Access Restriction | 16.1.0 | +| 2019-12 | CT#86 | CP-193038 | 0812 | - | Missing protocol code-point values | 16.1.0 | +| 2019-12 | CT#86 | CP-193052 | 0807 | 1 | Battery Indication for Communication pattern enhancement | 16.1.0 | +| 2020-03 | CT#87e | CP-200027 | 0813 | 1 | Addition of IAB-Operation-Permission to subscriber data | 16.2.0 | +| 2020-03 | CT#87e | CP-200036 | 0814 | 1 | Subscription data for NR V2X | 16.2.0 | +| 2020-06 | CT#88e | CP-201053 | 0815 | - | Alignments on definitions | 16.3.0 | +| 2020-06 | CT#88e | CP-201053 | 0816 | - | Supported Monitoring Events | 16.3.0 | +| 2020-06 | CT#88e | CP-201053 | 0818 | - | Error cause handling | 16.3.0 | +| 2020-06 | CT#88e | CP-201053 | 0819 | 1 | Update of RAT restrictions | 16.3.0 | +| 2020-06 | CT#88e | CP-201053 | 0821 | 1 | Supported Features for combined MME/SGSN | 16.3.0 | +| 2020-06 | CT#88e | CP-201049 | 0817 | 1 | Subscribed PC5 QoS Parameters for NR V2X | 16.3.0 | +| 2020-06 | CT#88e | CP-201033 | 0820 | 1 | SGSN Interworking with 5G | 16.3.0 | +| 2020-09 | CT#89e | CP-202109 | 0822 | 2 | Monitoring Configurations in ULA | 16.4.0 | +| 2020-09 | CT#89e | CP-202094 | 0823 | - | Immediate Event Report in IDA | 16.4.0 | +| 2020-09 | CT#89e | CP-202094 | 0824 | 1 | Corrections on Broadcast-Location-Assistance-Data-Types | 16.4.0 | +| 2020-12 | CT#90e | CP-203032 | 0826 | - | Extended Reference ID | 16.5.0 | +| 2020-12 | CT#90e | CP-203032 | 0825 | 1 | Correction for implementation error | 16.5.0 | +| 2021-03 | CT#91e | CP-210057 | 0828 | - | Default APN for Ethernet PDN types | 16.6.0 | +| 2021-03 | CT#91e | CP-210053 | 0829 | 2 | Cancellation Type for UDICOM | 16.6.0 | +| 2022-06 | CT#96 | CP-221066 | 0839 | - | CR 0828 has not been correctly implemented | 16.7.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29273/37989819a8404d835f28c204734ee90a_img.jpg b/marked/Rel-16/29_series/29273/37989819a8404d835f28c204734ee90a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3690ea3a174a3c0754a36cada84fda4f97b0ec9c --- /dev/null +++ b/marked/Rel-16/29_series/29273/37989819a8404d835f28c204734ee90a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:eb4884b6c28805f56d6372e8014f0056adbb1e269b2c8874f0160a913dbfc754 +size 109102 diff --git a/marked/Rel-16/29_series/29273/3f47bcff76a8105d2539569fc8909db7_img.jpg b/marked/Rel-16/29_series/29273/3f47bcff76a8105d2539569fc8909db7_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f24a0cfeb987ac15fea111f447d0366082cda208 --- /dev/null +++ b/marked/Rel-16/29_series/29273/3f47bcff76a8105d2539569fc8909db7_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6cfcc47df33865bfc29e7b819a23c595690e59d7377251468943658c86835627 +size 167287 diff --git a/marked/Rel-16/29_series/29273/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-16/29_series/29273/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..bcb0a6f714ea503488d950cfd075399ccc8ab81f --- /dev/null +++ b/marked/Rel-16/29_series/29273/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:109b68e5c0a9b8ebe56f58ea1cb569390b36453c3d75d6d84db2a042f9119830 +size 9700 diff --git a/marked/Rel-16/29_series/29273/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-16/29_series/29273/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..127fedf84d3be2a3af27c6cee518b64081caa30f --- /dev/null +++ b/marked/Rel-16/29_series/29273/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:beb32f392bf8b07e7d7334fb2bc314dd93e3df8473103b041101b9dd48e91982 +size 6418 diff --git a/marked/Rel-16/29_series/29273/69981c87c5b93c90e9012f6dabce4215_img.jpg b/marked/Rel-16/29_series/29273/69981c87c5b93c90e9012f6dabce4215_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f541bdb240f9d23c5c46b3e44c6186b5f05cef77 --- /dev/null +++ b/marked/Rel-16/29_series/29273/69981c87c5b93c90e9012f6dabce4215_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c3fc627aa8550569bacbc0f4c85d287f39af8298c0b011b9638c42e1f8124e71 +size 143879 diff --git a/marked/Rel-16/29_series/29273/7c19fc92dc74a74ec346d46bc39a3946_img.jpg b/marked/Rel-16/29_series/29273/7c19fc92dc74a74ec346d46bc39a3946_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8ccea5a99825052f8866cbb1c57f2662bb35a5a5 --- /dev/null +++ b/marked/Rel-16/29_series/29273/7c19fc92dc74a74ec346d46bc39a3946_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c37cb9daa31db80ef624780839aed3f0649c720e12ae1e402c4a55f28fa182cd +size 142050 diff --git a/marked/Rel-16/29_series/29273/81044422af6818d2bb2839b5c325d322_img.jpg b/marked/Rel-16/29_series/29273/81044422af6818d2bb2839b5c325d322_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..be6e85b869ab49a3c627be50e2819375f847516e --- /dev/null +++ b/marked/Rel-16/29_series/29273/81044422af6818d2bb2839b5c325d322_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3bb5d281b9b38d3fae1e5a4da6725f864947f7bdff901cc9edacbcc44787ea76 +size 144102 diff --git a/marked/Rel-16/29_series/29273/b1a6ab9f3d33d6e8d64173bfa595b763_img.jpg b/marked/Rel-16/29_series/29273/b1a6ab9f3d33d6e8d64173bfa595b763_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..fe2c52371820138507ce30339ec184d57ffcddf3 --- /dev/null +++ b/marked/Rel-16/29_series/29273/b1a6ab9f3d33d6e8d64173bfa595b763_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9b976b3358cd1808c3ac142055b1ba8d1b0a4f26a5d1698d71e6d2c7d1aa5d21 +size 134151 diff --git a/marked/Rel-16/29_series/29273/cf734b5645d3e02a8df25f67904cd2d3_img.jpg b/marked/Rel-16/29_series/29273/cf734b5645d3e02a8df25f67904cd2d3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..84f942ab48b87f4be4e221f12e303530c07ef319 --- /dev/null +++ b/marked/Rel-16/29_series/29273/cf734b5645d3e02a8df25f67904cd2d3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8121f9cce84c83df77f054ee1a1674f0a2efcd4ecc1d6bfdfc01948d1f3bf729 +size 152069 diff --git a/marked/Rel-16/29_series/29273/f5dc5aa74ea5482955a1e8e161b5c549_img.jpg b/marked/Rel-16/29_series/29273/f5dc5aa74ea5482955a1e8e161b5c549_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c600960400b0fb5c72b976e079072be5bcb0ffc1 --- /dev/null +++ b/marked/Rel-16/29_series/29273/f5dc5aa74ea5482955a1e8e161b5c549_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:63468d9c626ae70e4cc933f0645520d4aca49875841b1343b2e19743acbbf112 +size 102343 diff --git a/marked/Rel-16/29_series/29273/raw.md b/marked/Rel-16/29_series/29273/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..2e444ff5b6b1397c027d6ba84976dc8ba3656ce0 --- /dev/null +++ b/marked/Rel-16/29_series/29273/raw.md @@ -0,0 +1,7233 @@ + + +# 3GPP TS 29.273 V16.2.0 (2020-09) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Evolved Packet System (EPS); 3GPP EPS AAA interfaces (Release 16)** + +![LTE Advanced Pro logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for LTE Advanced Pro. It features the word "lte" in a bold, black, lowercase font. Above the "e" is the text "Advanced Pro" in a smaller, red font. To the right of the "e" is a green signal icon consisting of three curved lines of increasing height. + +LTE Advanced Pro logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The logo for 3GPP. It features the letters "3GPP" in a stylized, bold, black font. Below the "P" is a red signal icon consisting of three curved lines of increasing height. Below the logo, the text "A GLOBAL INITIATIVE" is written in a smaller, black, uppercase font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|-------------------------------------------------------------------------------------------|----| +| Foreword..... | 11 | +| Introduction..... | 12 | +| 1 Scope..... | 13 | +| 2 References..... | 13 | +| 3 Definitions, symbols and abbreviations..... | 15 | +| 3.1 Definitions..... | 15 | +| 3.1.1 General..... | 15 | +| 3.1.2 Handling of Information Elements..... | 15 | +| 3.2 Abbreviations..... | 16 | +| 4 SWa Description..... | 16 | +| 4.1 Functionality..... | 16 | +| 4.1.1 General..... | 16 | +| 4.1.2 Procedure Descriptions..... | 17 | +| 4.1.2.1 SWa Authentication and Authorization procedure..... | 17 | +| 4.1.2.1.1 General..... | 17 | +| 4.1.2.1.2 3GPP AAA Server Detailed Behaviour..... | 19 | +| 4.1.2.1.3 3GPP AAA Proxy Detailed Behaviour..... | 20 | +| 4.1.2.2 SWa HSS/AAA Initiated Detach..... | 20 | +| 4.1.2.3 SWa Non-3GPP Access Network Initiated Detach..... | 20 | +| 4.1.2.4 SWa Re-Authentication and Re-Authorization Procedure..... | 20 | +| 4.1.2.4.1 General..... | 20 | +| 4.1.2.4.2 3GPP AAA Server Detailed Behaviour..... | 22 | +| 4.1.2.4.3 3GPP AAA Proxy Detailed Behaviour..... | 22 | +| 4.2 Protocol Specification..... | 22 | +| 4.2.1 General..... | 22 | +| 4.2.2 Commands..... | 23 | +| 4.2.2.1 Commands for SWa authentication and authorization procedures..... | 23 | +| 4.2.2.1.1 Diameter-EAP-Request (DER) Command..... | 23 | +| 4.2.2.1.2 Diameter-EAP-Answer (DEA) Command..... | 23 | +| 4.2.2.2 Commands for SWa HSS/AAA Initiated Detach..... | 24 | +| 4.2.2.3 Commands for Untrusted non-3GPP Access network Initiated Session Termination..... | 24 | +| 4.2.2.4 Commands for SWa Re-Authentication and Re-Authorization Procedures..... | 24 | +| 4.2.2.4.1 Re-Auth-Request (RAR) Command..... | 24 | +| 4.2.2.4.2 Re-Auth-Answer (RAA) Command..... | 24 | +| 4.2.2.4.3 Diameter-EAP-Request (DER) Command..... | 24 | +| 4.2.2.4.4 Diameter-EAP-Answer (DEA) Command..... | 24 | +| 4.2.3 Information Elements..... | 24 | +| 4.2.4 Session Handling..... | 25 | +| 5 STa Description..... | 25 | +| 5.1 Functionality..... | 25 | +| 5.1.1 General..... | 25 | +| 5.1.2 Procedures Description..... | 25 | +| 5.1.2.1 STa Access Authentication and Authorization..... | 25 | +| 5.1.2.1.1 General..... | 25 | +| 5.1.2.1.2 3GPP AAA Server Detailed Behaviour..... | 35 | +| 5.1.2.1.3 3GPP AAA Proxy Detailed Behaviour..... | 41 | +| 5.1.2.1.4 Trusted non-3GPP access network Detailed Behaviour..... | 43 | +| 5.1.2.2 HSS/AAA Initiated Detach on STa..... | 44 | +| 5.1.2.2.1 General..... | 44 | +| 5.1.2.2.2 3GPP AAA Server Detailed Behaviour..... | 45 | +| 5.1.2.2.3 3GPP AAA Proxy Detailed Behaviour..... | 46 | +| 5.1.2.3 STa Re-Authorization and Re-Authentication Procedures..... | 46 | +| 5.1.2.3.1 General..... | 46 | + +| | | | +|-----------|-----------------------------------------------------------------------------------------------|----| +| 5.1.2.3.2 | 3GPP AAA Server Detailed Behaviour..... | 53 | +| 5.1.2.3.3 | 3GPP AAA Proxy Detailed Behaviour..... | 54 | +| 5.1.2.3.4 | Trusted Non-3GPP Access Network Detailed Behaviour..... | 54 | +| 5.1.2.4 | Non-3GPP Access Network Initiated Session Termination..... | 55 | +| 5.1.2.4.1 | General..... | 55 | +| 5.1.2.4.2 | 3GPP AAA Server Detailed Behaviour..... | 55 | +| 5.1.2.4.3 | 3GPP AAA Proxy Detailed Behaviour..... | 55 | +| 5.1.2.5 | ERP Re-Authentication in Non-3GPP Access..... | 56 | +| 5.1.2.5.1 | General..... | 56 | +| 5.1.2.5.2 | ER server located in 3GPP AAA Proxy or 3GPP AAA Server Detailed Behaviour..... | 56 | +| 5.1.2.5.3 | 3GPP AAA Proxy Detailed Behaviour..... | 57 | +| 5.2 | Protocol Specification..... | 57 | +| 5.2.1 | General..... | 57 | +| 5.2.2 | Commands..... | 58 | +| 5.2.2.1 | Commands for STa PMIPv6 or GTPv2 or ERP (re-)authentication and authorization procedures..... | 58 | +| 5.2.2.1.1 | Diameter-EAP-Request (DER) Command..... | 58 | +| 5.2.2.1.2 | Diameter-EAP-Answer (DEA) Command..... | 58 | +| 5.2.2.2 | Commands for STa HSS/AAA Initiated Detach for Trusted non-3GPP Access..... | 59 | +| 5.2.2.2.1 | Abort-Session-Request (ASR) Command..... | 59 | +| 5.2.2.2.2 | Abort-Session-Answer (ASA) Command..... | 60 | +| 5.2.2.2.3 | Session-Termination-Request (STR) Command..... | 60 | +| 5.2.2.2.4 | Session-Termination-Answer (STA) Command..... | 60 | +| 5.2.2.3 | Commands for Re-Authentication and Re-Authorization Procedure..... | 60 | +| 5.2.2.3.1 | Re-Auth-Request (RAR) Command..... | 60 | +| 5.2.2.3.2 | Re-Auth-Answer (RAA) Command..... | 61 | +| 5.2.2.3.3 | AA-Request (AAR) Command..... | 61 | +| 5.2.2.3.4 | AA-Answer (AAA) Command..... | 61 | +| 5.2.2.3.5 | Diameter-EAP-Request (DER) Command..... | 62 | +| 5.2.2.3.6 | Diameter-EAP-Answer (DEA) Command..... | 62 | +| 5.2.2.4 | Commands for Trusted non-3GPP Access network Initiated Session Termination..... | 62 | +| 5.2.2.4.1 | Session-Termination-Request (STR) Command..... | 62 | +| 5.2.2.4.2 | Session-Termination-Answer (STA) Command..... | 62 | +| 5.2.3 | Information Elements..... | 63 | +| 5.2.3.1 | General..... | 63 | +| 5.2.3.2 | Mobile-Node-Identifier..... | 65 | +| 5.2.3.3 | MIP6-Feature-Vector..... | 66 | +| 5.2.3.4 | QoS Capability..... | 66 | +| 5.2.3.5 | Service-Selection..... | 66 | +| 5.2.3.6 | RAT-Type..... | 66 | +| 5.2.3.7 | ANID..... | 67 | +| 5.2.3.8 | AMBR..... | 67 | +| 5.2.3.9 | AN-Trusted..... | 67 | +| 5.2.3.10 | Feature-List-ID AVP..... | 67 | +| 5.2.3.11 | Feature-List AVP..... | 67 | +| 5.2.3.12 | MIP-FA-RK..... | 67 | +| 5.2.3.13 | MIP-FA-RK-SPI..... | 67 | +| 5.2.3.14 | Full-Network-Name..... | 67 | +| 5.2.3.15 | Short-Network-Name..... | 67 | +| 5.2.3.16 | Void..... | 68 | +| 5.2.3.17 | Void..... | 68 | +| 5.2.3.18 | WLAN-Identifier..... | 68 | +| 5.2.3.19 | Transport-Access-Type..... | 68 | +| 5.2.3.20 | DER-Flags..... | 68 | +| 5.2.3.21 | DEA-Flags..... | 69 | +| 5.2.3.22 | SSID..... | 70 | +| 5.2.3.23 | HESSID..... | 70 | +| 5.2.3.24 | Access-Network-Info..... | 70 | +| 5.2.3.25 | TWAN-Connection-Mode..... | 71 | +| 5.2.3.26 | TWAN-Connectivity-Parameters..... | 71 | +| 5.2.3.27 | Connectivity-Flags..... | 72 | +| 5.2.3.28 | TWAN-PCO..... | 72 | + +| | | | +|-------------|-----------------------------------------------------------------------------------|-----| +| 5.2.3.29 | TWAG-CP-Address..... | 72 | +| 5.2.3.30 | TWAG-UP-Address..... | 72 | +| 5.2.3.31 | TWAN-S2a-Failure-Cause..... | 72 | +| 5.2.3.32 | SM-Back-Off-Timer..... | 73 | +| 5.2.3.33 | WLCP-Key..... | 73 | +| 5.2.3.34 | Void..... | 73 | +| 5.2.3.35 | IMEI-Check-In-VPLMN-Result..... | 73 | +| 5.2.4 | Session Handling..... | 74 | +| 6 | SWd Description..... | 74 | +| 6.1 | Functionality..... | 74 | +| 6.1.1 | General..... | 74 | +| 6.1.2 | Procedures Description..... | 75 | +| 6.1.2.1 | Trusted non-3GPP Access / Access Gateway related procedures..... | 75 | +| 6.1.2.1.1 | Trusted Non-3GPP Access Authentication and Authorization..... | 75 | +| 6.1.2.1.2 | HSS/AAA Initiated Detach for Trusted non-3GPP Access..... | 77 | +| 6.1.2.1.3 | Access and Service Authorization information update..... | 77 | +| 6.1.2.1.4 | Trusted non-3GPP Access Network Initiated Session Termination..... | 78 | +| 6.1.2.2 | Untrusted non-3GPP Access / ePDG related procedures..... | 78 | +| 6.1.2.3 | PDN GW related procedures..... | 79 | +| 6.2 | Protocol Specification..... | 79 | +| 6.2.1 | General..... | 79 | +| 6.2.2 | Commands..... | 80 | +| 6.2.2.1 | Commands used in connection with the STa interface..... | 80 | +| 6.2.2.1.1 | Commands for STa PMIPv6 or GTPv2 authentication and authorization procedures..... | 80 | +| 6.2.2.1.1.1 | Diameter-EAP-Request (DER) Command..... | 80 | +| 6.2.2.1.1.2 | Diameter-EAP-Answer (DEA) Command..... | 81 | +| 6.2.2.1.2 | Commands for STa HSS/AAA Initiated Detach for Trusted non-3GPP Access..... | 81 | +| 6.2.2.1.3 | Commands for STa Access and Service Authorization Update Procedure..... | 81 | +| 6.2.2.1.4 | Commands for Trusted non-3GPP Access network Initiated Session Termination..... | 81 | +| 6.2.2.2 | Commands used in connection with the SWm interface..... | 81 | +| 6.2.2.3 | Commands used in connection with the S6b interface..... | 82 | +| 6.2.3 | Information Elements..... | 82 | +| 6.2.3.1 | General..... | 82 | +| 7 | SWm Description..... | 83 | +| 7.1 | Functionality..... | 83 | +| 7.1.1 | General..... | 83 | +| 7.1.2 | Procedures Description..... | 84 | +| 7.1.2.1 | Authentication and Authorization Procedures..... | 84 | +| 7.1.2.1.1 | General..... | 84 | +| 7.1.2.1.2 | 3GPP AAA Server Detailed Behaviour..... | 88 | +| 7.1.2.1.3 | 3GPP AAA Proxy Detailed Behaviour..... | 91 | +| 7.1.2.1.4 | ePDG Detailed Behaviour..... | 91 | +| 7.1.2.2 | Authorization Procedures..... | 93 | +| 7.1.2.2.1 | General..... | 93 | +| 7.1.2.2.2 | 3GPP AAA Server Detailed Behaviour..... | 96 | +| 7.1.2.2.3 | 3GPP AAA Proxy Detailed Behaviour..... | 96 | +| 7.1.2.2.4 | ePDG Detailed Behaviour..... | 97 | +| 7.1.2.3 | ePDG Initiated Session Termination Procedures..... | 97 | +| 7.1.2.3.1 | General..... | 97 | +| 7.1.2.3.2 | 3GPP AAA Server Detailed Behavior..... | 98 | +| 7.1.2.3.3 | 3GPP AAA Proxy Detailed Behavior..... | 98 | +| 7.1.2.4 | 3GPP AAA Server Initiated Session Termination Procedures..... | 98 | +| 7.1.2.4.1 | General..... | 98 | +| 7.1.2.4.2 | 3GPP AAA Server Detailed Behaviour..... | 99 | +| 7.1.2.4.3 | 3GPP AAA Proxy Detailed Behaviour..... | 100 | +| 7.1.2.5 | Authorization Information Update Procedures..... | 100 | +| 7.1.2.5.1 | General..... | 100 | +| 7.1.2.5.2 | 3GPP AAA Server Detailed Behaviour..... | 101 | +| 7.1.2.5.3 | ePDG Detailed Behaviour..... | 101 | +| 7.2 | Protocol Specification..... | 101 | + +| | | | +|-------------|-------------------------------------------------------------------|-----| +| 7.2.1 | General..... | 101 | +| 7.2.2 | Commands..... | 102 | +| 7.2.2.1 | Commands for SWm Authentication and Authorization Procedures..... | 102 | +| 7.2.2.1.1 | Diameter-EAP-Request (DER) Command..... | 102 | +| 7.2.2.1.2 | Diameter-EAP-Answer (DEA) Command..... | 102 | +| 7.2.2.1.3 | Diameter-AA-Request (AAR) Command..... | 103 | +| 7.2.2.1.4 | Diameter-AA-Answer (AAA) Command..... | 103 | +| 7.2.2.2 | Commands for ePDG Initiated Session Termination..... | 104 | +| 7.2.2.2.1 | Session-Termination-Request (STR) Command..... | 104 | +| 7.2.2.2.2 | Session-Termination-Answer (STA) Command..... | 104 | +| 7.2.2.3 | Commands for 3GPP AAA Server Initiated Session Termination..... | 105 | +| 7.2.2.3.1 | Abort-Session-Request (ASR) Command..... | 105 | +| 7.2.2.3.2 | Abort-Session-Answer (ASA) Command..... | 105 | +| 7.2.2.3.3 | Session-Termination-Request (STR) Command..... | 105 | +| 7.2.2.3.4 | Session-Termination-Answer (STA) Command..... | 105 | +| 7.2.2.4 | Commands for Authorization Information Update..... | 106 | +| 7.2.2.4.1 | Re-Auth-Request (RAR) Command..... | 106 | +| 7.2.2.4.2 | Re-Auth-Answer (RAA) Command..... | 106 | +| 7.2.3 | Information Elements..... | 106 | +| 7.2.3.1 | General..... | 106 | +| 7.2.3.2 | Feature-List-ID AVP..... | 108 | +| 7.2.3.3 | Feature-List AVP..... | 108 | +| 7.2.3.4 | Emergency-Services..... | 108 | +| 7.2.3.5 | AAR-Flags..... | 109 | +| 7.2.4 | Session Handling..... | 109 | +| 8 | SWx Description..... | 109 | +| 8.1 | Functionality..... | 109 | +| 8.1.1 | General..... | 109 | +| 8.1.2 | Procedures Description..... | 109 | +| 8.1.2.1 | Authentication Procedure..... | 109 | +| 8.1.2.1.1 | General..... | 109 | +| 8.1.2.1.2 | Detailed behaviour..... | 112 | +| 8.1.2.2 | Location Management Procedures..... | 113 | +| 8.1.2.2.1 | General..... | 113 | +| 8.1.2.2.2 | UE/PDN Registration/DeRegistration Notification..... | 113 | +| 8.1.2.2.2.1 | General..... | 113 | +| 8.1.2.2.2.2 | Detailed behaviour..... | 115 | +| 8.1.2.2.3 | Network Initiated De-Registration by HSS, Administrative..... | 117 | +| 8.1.2.2.3.1 | General..... | 117 | +| 8.1.2.2.3.2 | Detailed behaviour..... | 118 | +| 8.1.2.3 | HSS Initiated Update of User Profile..... | 118 | +| 8.1.2.3.1 | General..... | 118 | +| 8.1.2.3.2 | HSS Detailed behaviour..... | 120 | +| 8.1.2.3.3 | 3GPP AAA Server Detailed behaviour..... | 120 | +| 8.1.2.4 | Fault Recovery Procedures..... | 121 | +| 8.1.2.4.1 | HSS Reset Indication..... | 121 | +| 8.1.2.4.1.1 | General..... | 121 | +| 8.1.2.4.1.2 | HSS Detailed behaviour..... | 122 | +| 8.1.2.4.1.3 | 3GPP AAA Server Detailed behaviour..... | 122 | +| 8.1.2.4.2 | HSS Restoration..... | 122 | +| 8.1.2.4.2.1 | General..... | 122 | +| 8.1.2.4.2.2 | HSS Detailed behaviour..... | 124 | +| 8.1.2.4.2.3 | 3GPP AAA Server Detailed behaviour..... | 124 | +| 8.2 | Protocol Specification..... | 124 | +| 8.2.1 | General..... | 124 | +| 8.2.2 | Commands..... | 124 | +| 8.2.2.1 | Authentication Procedure..... | 124 | +| 8.2.2.2 | HSS Initiated Update of User Profile Procedure..... | 125 | +| 8.2.2.3 | Non-3GPP IP Access Registration Procedure..... | 126 | +| 8.2.2.4 | Network Initiated De-Registration by HSS Procedure..... | 127 | +| 8.2.3 | Information Elements..... | 128 | + +| | | | +|-----------|---------------------------------------------------------------------|-----| +| 8.2.3.0 | General..... | 128 | +| 8.2.3.1 | Non-3GPP-User-Data..... | 130 | +| 8.2.3.2 | Subscription-ID..... | 131 | +| 8.2.3.3 | Non-3GPP-IP-Access..... | 131 | +| 8.2.3.4 | Non-3GPP-IP-Access-APN..... | 131 | +| 8.2.3.5 | RAT-Type..... | 131 | +| 8.2.3.6 | Session-Timeout..... | 131 | +| 8.2.3.7 | APN-Configuration..... | 131 | +| 8.2.3.8 | ANID..... | 132 | +| 8.2.3.9 | SIP-Auth-Data-Item..... | 132 | +| 8.2.3.10 | Confidentiality-Key..... | 132 | +| 8.2.3.11 | Integrity-Key..... | 132 | +| 8.2.3.12 | Server-Assignment-Type AVP..... | 132 | +| 8.2.3.13 | Trace-Info..... | 133 | +| 8.2.3.14 | Trace-Data..... | 133 | +| 8.2.3.15 | Feature-List-ID AVP..... | 133 | +| 8.2.3.16 | Feature-List AVP..... | 133 | +| 8.2.3.17 | PPR-Flags..... | 135 | +| 8.2.3.18 | TWAN-Default-APN-Context-Id..... | 135 | +| 8.2.3.19 | TWAN-Access-Info..... | 136 | +| 8.2.3.20 | Access-Authorization-Flags..... | 136 | +| 8.2.3.21 | AAA-Failure-Indication..... | 136 | +| 8.2.3.22 | OC-Supported-Features..... | 137 | +| 8.2.3.23 | OC-OLR..... | 137 | +| 8.2.3.24 | 3GPP-AAA-Server-Name..... | 137 | +| 8.2.3.25 | DRMP..... | 137 | +| 8.2.3.26 | Load..... | 137 | +| 8.2.3.27 | ERP-Authorization..... | 137 | +| 8.2.3.28 | MIP6-Feature-Vector..... | 137 | +| 8.2.4 | Session Handling..... | 138 | +| 8.3 | User identity to HSS resolution..... | 138 | +| 9 | S6b Description..... | 139 | +| 9.1 | Functionality..... | 139 | +| 9.1.1 | General..... | 139 | +| 9.1.2 | Procedures Description..... | 139 | +| 9.1.2.1 | Authentication and Authorization Procedures when using DSMIPv6..... | 139 | +| 9.1.2.1.1 | General..... | 139 | +| 9.1.2.1.2 | PDN GW Detailed Behaviour..... | 142 | +| 9.1.2.1.3 | 3GPP AAA Server Detailed Behaviour..... | 143 | +| 9.1.2.1.4 | 3GPP AAA Proxy Detailed Behaviour..... | 144 | +| 9.1.2.2 | Authorization Procedures when using PMIPv6 or GTPv2..... | 144 | +| 9.1.2.2.1 | General..... | 144 | +| 9.1.2.2.2 | PDN GW Detailed Behaviour..... | 147 | +| 9.1.2.2.3 | 3GPP AAA Server Detailed Behaviour..... | 147 | +| 9.1.2.2.4 | 3GPP AAA Proxy Detailed Behaviour..... | 149 | +| 9.1.2.3 | PDN GW Initiated Session Termination Procedures..... | 149 | +| 9.1.2.3.1 | General..... | 149 | +| 9.1.2.3.2 | PDN GW Detailed Behaviour..... | 150 | +| 9.1.2.3.3 | 3GPP AAA Server Detailed Behaviour..... | 150 | +| 9.1.2.3.4 | 3GPP AAA Proxy Detailed Behaviour..... | 150 | +| 9.1.2.4 | 3GPP AAA Initiated Session Termination Procedures..... | 150 | +| 9.1.2.4.1 | General..... | 150 | +| 9.1.2.4.2 | PDN GW Detailed Behaviour..... | 151 | +| 9.1.2.4.3 | 3GPP AAA Server Detailed Behaviour..... | 151 | +| 9.1.2.4.4 | 3GPP AAA Proxy Detailed Behaviour..... | 152 | +| 9.1.2.5 | Service Authorization Information Update Procedures..... | 152 | +| 9.1.2.5.1 | General..... | 152 | +| 9.1.2.5.2 | Detailed Behaviour..... | 155 | +| 9.1.2.6 | Authorization Procedures when using MIPv4 FACoA..... | 156 | +| 9.1.2.6.1 | General..... | 156 | +| 9.1.2.6.2 | PDN GW Detailed Behaviour..... | 157 | + +| | | | +|-----------|---------------------------------------------------------------------------|-----| +| 9.1.2.6.3 | 3GPP AAA Server Detailed Behaviour..... | 158 | +| 9.1.2.6.4 | 3GPP AAA Proxy Detailed Behaviour..... | 159 | +| 9.2 | Protocol Specification..... | 159 | +| 9.2.1 | General..... | 159 | +| 9.2.2 | Commands..... | 159 | +| 9.2.2.1 | Commands for S6b DSMIPv6 Authorization Procedures..... | 159 | +| 9.2.2.1.1 | Diameter-EAP-Request (DER) Command..... | 159 | +| 9.2.2.1.2 | Diameter-EAP-Answer (DEA) Command..... | 160 | +| 9.2.2.2 | Commands for S6b PMIPv6, GTPv2 or DSMIPv6 Authorization Procedures..... | 160 | +| 9.2.2.2.1 | AA-Request (AAR) Command..... | 160 | +| 9.2.2.2.2 | AA-Answer (AAA) Command..... | 161 | +| 9.2.2.3 | Commands for PDN GW Initiated Session Termination..... | 162 | +| 9.2.2.3.1 | Session-Termination-Request (STR) Command..... | 162 | +| 9.2.2.3.2 | Session-Termination-Answer (STA) Command..... | 162 | +| 9.2.2.4 | Commands for 3GPP AAA Server Initiated Session Termination..... | 162 | +| 9.2.2.4.1 | Abort-Session-Request (ASR) Command..... | 162 | +| 9.2.2.4.2 | Abort-Session-Answer (ASA) Command..... | 163 | +| 9.2.2.4.3 | Session-Termination-Request (STR) Command..... | 163 | +| 9.2.2.4.4 | Session-Termination-Answer (STA) Command..... | 163 | +| 9.2.2.5 | Commands for S6b MIPv4 FCoA Authorization Procedures..... | 163 | +| 9.2.2.5.1 | AA-Request (AAR) Command..... | 163 | +| 9.2.2.5.2 | AA-Answer (AAA) Command..... | 164 | +| 9.2.2.6 | Commands for S6b Service Authorization Information Update Procedures..... | 164 | +| 9.2.2.6.1 | Re-Auth-Request (RAR) Command..... | 164 | +| 9.2.2.6.2 | Re-Auth-Answer (RAA) Command..... | 165 | +| 9.2.3 | Information Elements..... | 165 | +| 9.2.3.0 | General..... | 165 | +| 9.2.3.1 | S6b DSMIPv6 procedures..... | 165 | +| 9.2.3.1.1 | General..... | 165 | +| 9.2.3.1.2 | Visited-Network-Identifier..... | 166 | +| 9.2.3.1.3 | Void..... | 166 | +| 9.2.3.1.4 | Void..... | 166 | +| 9.2.3.1.5 | RAR-Flags..... | 166 | +| 9.2.3.2 | S6b PMIPv6 or GTPv2 procedures..... | 167 | +| 9.2.3.2.1 | General..... | 167 | +| 9.2.3.2.2 | MIP6-Agent-Info..... | 167 | +| 9.2.3.2.3 | MIP6-Feature-Vector..... | 167 | +| 9.2.3.2.4 | QoS-Capability..... | 168 | +| 9.2.3.2.5 | QoS-Resources..... | 168 | +| 9.2.3.2.6 | Origination-Time-Stamp..... | 168 | +| 9.2.3.2.7 | Maximum-Wait-Time..... | 168 | +| 9.2.3.3 | S6b Re-used Diameter AVPs..... | 168 | +| 9.2.3.4 | Feature-List-ID AVP..... | 168 | +| 9.2.3.5 | Feature-List AVP..... | 168 | +| 9.2.3.6 | S6b MIPv4 FCoA procedures..... | 169 | +| 9.2.3.6.1 | General..... | 169 | +| 9.2.3.6.2 | MIP6-Agent-Info..... | 169 | +| 9.2.3.6.3 | MIP6-Feature-Vector..... | 170 | +| 9.2.3.6.4 | QoS-Capability..... | 170 | +| 9.2.3.6.5 | QoS-Resources..... | 170 | +| 9.2.3.6.6 | MIP-MN-HA-SPI..... | 170 | +| 9.2.3.6.7 | MIP-Session-Key..... | 170 | +| 9.2.3.7 | DER-S6b-Flags..... | 170 | +| 9.2.4 | Session Handling..... | 170 | +| 10 | Result-Code and Experimental-Result Values..... | 171 | +| 10.1 | General..... | 171 | +| 10.2 | Success..... | 171 | +| 10.3 | Permanent Failures..... | 171 | +| 10.3.1 | General..... | 171 | +| 10.3.2 | DIAMETER_ERROR_USER_UNKNOWN (5001)..... | 171 | +| 10.3.3 | DIAMETER_ERROR_IDENTITY_NOT_REGISTERED (5003)..... | 171 | + +| | | | +|------------|----------------------------------------------------------|-----| +| 10.3.4 | DIAMETER_ERROR_ROAMING_NOT_ALLOWED (5004)..... | 171 | +| 10.3.5 | DIAMETER_ERROR_IDENTITY_ALREADY_REGISTERED (5005)..... | 171 | +| 10.3.6 | DIAMETER_ERROR_USER_NO_NON_3GPP_SUBSCRIPTION (5450)..... | 171 | +| 10.3.7 | DIAMETER_ERROR_USER_NO_APN_SUBSCRIPTION (5451)..... | 171 | +| 10.3.8 | DIAMETER_ERROR_RAT_TYPE_NOT_ALLOWED (5452)..... | 172 | +| 10.3.9 | DIAMETER_ERROR_LATE_OVERLAPPING_REQUEST (5453)..... | 172 | +| 10.3.10 | DIAMETER_ERROR_TIMED_OUT_REQUEST (5454)..... | 172 | +| 10.3.11 | DIAMETER_ERROR_ILLEGAL_EQUIPMENT (5554)..... | 172 | +| 10.4 | Transient Failures..... | 172 | +| 10.4.1 | General..... | 172 | +| 11 | 3GPP AAA Server/Proxy – EIR..... | 172 | +| 11.1 | Functionality..... | 172 | +| 11.1.1 | General..... | 172 | +| 11.1.2 | Procedures Description..... | 172 | +| 11.1.2.1 | ME Identity Check..... | 172 | +| 11.1.2.1.1 | General..... | 172 | +| 11.1.2.1.2 | 3GPP AAA Server Detailed Behaviour..... | 173 | +| 11.1.2.1.3 | 3GPP AAA Proxy Detailed Behaviour..... | 173 | +| 11.1.2.1.4 | EIR Detailed Behaviour..... | 174 | +| 11.2 | Protocol Specification..... | 174 | +| 11.2.1 | General..... | 174 | +| 11.2.2 | Commands..... | 174 | +| 11.2.2.1 | ME Identity Check..... | 174 | +| 11.2.2.1.1 | ME-Identity-Check-Request (ECR) Command..... | 174 | +| 11.2.2.1.2 | ME-Identity-Check-Answer (ECA) Command..... | 174 | +| 11.2.3 | Information Elements..... | 174 | +| 11.2.3.1 | General..... | 174 | +| 11.2.4 | Session Handling..... | 175 | + +**Annex A (informative): Trusted WLAN authentication and authorization procedure.....175** + +| | | | +|-------|----------------------------------------------------------|-----| +| A.1 | General..... | 175 | +| A.2 | Call Flow for SCM and EPC-routed access..... | 175 | +| A.2.1 | Successful call flow..... | 175 | +| A.2.2 | Unsuccessful call flow..... | 177 | +| A.2.3 | Call flow with IMEI check in VPLMN..... | 179 | +| A.3 | Call Flow for MCM for EPC-routed access and/or NSWO..... | 180 | +| A.3.1 | Successful call flow..... | 180 | +| A.3.2 | Call flow with IMEI check in VPLMN..... | 181 | +| A.4 | Call Flow for TSCM and EPC-routed access..... | 183 | + +**Annex B (normative): Diameter overload control mechanism.....184** + +| | | | +|-------|--------------------------------------------------|-----| +| B.1 | General..... | 184 | +| B.2 | SWx interface..... | 184 | +| B.2.1 | General..... | 184 | +| B.2.2 | HSS behaviour..... | 184 | +| B.2.3 | 3GPP AAA server behaviour..... | 184 | +| B.3 | STa interface..... | 185 | +| B.3.1 | General..... | 185 | +| B.3.2 | 3GPP AAA server behaviour..... | 185 | +| B.3.3 | Trusted non 3GPP access network behaviour..... | 185 | +| B.4 | S6b interface..... | 185 | +| B.4.1 | General..... | 185 | +| B.4.2 | 3GPP AAA server behaviour..... | 185 | +| B.4.3 | PDN-GW behaviour..... | 186 | +| B.5 | SWa Interface..... | 186 | +| B.5.1 | General..... | 186 | +| B.5.2 | 3GPP AAA server behaviour..... | 186 | +| B.5.3 | untrusted non-3GPP access network behaviour..... | 186 | +| B.6 | SWm Interface..... | 186 | + +| | | | +|----------------------------------------------------------------------------------------------|---------------------------------------------------|------------| +| B.6.1 | General..... | 186 | +| B.6.2 | 3GPP AAA server behaviour..... | 186 | +| B.6.3 | ePDG behaviour..... | 187 | +| Annex C (Informative): Diameter overload control node behaviour..... | | 187 | +| C.1 | Introduction..... | 187 | +| C.2 | Message prioritization over SWx..... | 187 | +| C.3 | Message prioritisation over STa, SWm and SWa..... | 188 | +| C.4 | Message prioritization over S6b..... | 189 | +| Annex D (normative): Diameter message priority mechanism..... | | 190 | +| D.1 | General..... | 190 | +| D.2 | SWa, STa, SWd, SWm, SWx, S6b interfaces..... | 190 | +| Annex E (informative): Untrusted WLAN authentication and authorization procedure..... | | 191 | +| E.1 | General..... | 191 | +| E.2 | Successful call flow..... | 191 | +| E.3 | Call flow with IMEI check in VPLMN..... | 192 | +| Annex F (normative): Diameter load control mechanism..... | | 194 | +| F.1 | General..... | 194 | +| F.2 | SWx interface..... | 194 | +| F.2.1 | General..... | 194 | +| F.2.2 | HSS behaviour..... | 194 | +| F.2.3 | 3GPP AAA server behaviour..... | 194 | +| F.3 | STa interface..... | 194 | +| F.3.1 | General..... | 194 | +| F.3.2 | 3GPP AAA server behaviour..... | 194 | +| F.3.3 | Trusted non 3GPP access network behaviour..... | 195 | +| F.4 | S6b interface..... | 195 | +| F.4.1 | General..... | 195 | +| F.4.2 | 3GPP AAA server behaviour..... | 195 | +| F.4.3 | PDN-GW behaviour..... | 195 | +| F.5 | SWa Interface..... | 195 | +| F.5.1 | General..... | 195 | +| F.5.2 | 3GPP AAA server behaviour..... | 195 | +| F.5.3 | untrusted non-3GPP access network behaviour..... | 195 | +| F.6 | SWm Interface..... | 196 | +| F.6.1 | General..... | 196 | +| F.6.2 | 3GPP AAA server behaviour..... | 196 | +| F.6.3 | ePDG behaviour..... | 196 | +| Annex G (informative): Change history..... | | 196 | + +## Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +--- + +## Introduction + +The present specification details the stage 3 work related to all 3GPP AAA reference points used by the different non-3GPP accesses included in EPS. + +# 1 Scope + +The present document defines the stage-3 protocol description for several reference points for the non-3GPP access in EPS. + +- The present document is applicable to: +- The SWa reference point between an un-trusted non-3GPP IP access and the 3GPP AAA Server/Proxy. +- The STa reference point between a trusted non-3GPP IP access and the 3GPP AAA Server/Proxy. +- The SWd reference point between the 3GPP AAA Proxy and 3GPP AAA Server. +- The SWx reference point between the 3GPP AAA Server and the HSS. +- The S6b reference point between the 3GPP AAA Server/Proxy and the PDN GW. +- The SWm reference point between the 3GPP AAA Server/Proxy and the ePDG. +- The reference point between the 3GPP AAA Server/Proxy and the EIR. + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] IETF RFC 5779: "Diameter Proxy Mobile IPv6: Mobility Access Gateway and Local Mobility Anchor Interaction with Diameter Server". +- [3] 3GPP TS 23.402: "Architecture enhancements for non-3GPP accesses". +- [4] IETF RFC 4005: "Diameter Network Access Server Application" +- [5] IETF RFC 4072: "Diameter Extensible Authentication Protocol (EAP) Application" +- [6] IETF RFC 5447 "Diameter Mobile IPv6: Support for Network Access Server to Diameter Server Interaction". +- [7] Void. +- [8] IETF RFC 3748: "Extensible Authentication Protocol (EAP)". +- [9] IETF RFC 5777: "Traffic Classification and Quality of Service (QoS) Attributes for Diameter". +- [10] Void +- [11] IETF RFC 5778: "Diameter Mobile IPv6: Support for Home Agent to Diameter Server Interaction". +- [12] Void +- [13] 3GPP TS 24.303: "Mobility management based on Dual-Stack Mobile IPv6; Stage 3". + +- [14] 3GPP TS 23.003: "Numbering, addressing and identification". +- [15] IETF RFC 4282: "The Network Access Identifier". +- [16] 3GPP TS 33.203: "3G security; Access security for IP-based services". +- [17] 3GPP TS 29.230: "Diameter applications; 3GPP specific codes and identifiers". +- [18] IETF RFC 4004: "Diameter Mobile IPv4 Application". +- [19] 3GPP TS 33.402: "3GPP System Architecture Evolution (SAE); Security aspects of non-3GPP accesses". +- [20] IETF RFC 4006: "Diameter Credit-Control Application". +- [21] Void. +- [22] 3GPP TS 29.228: "IP multimedia (IM) Subsystem Cx and Dx Interfaces; Signalling flows and Message Elements". +- [23] 3GPP TS 29.212: "Policy and Charging Control (PCC); Reference points". +- [24] 3GPP TS 29.229: "Cx and Dx interfaces based on the Diameter protocol; Protocol details". +- [25] 3GPP2 X. S0057-B: "EUTRAN – eHRPD Connectivity and Interworking: Core Network Aspects". +- [26] 3GPP TS 24.302: "Access to the 3GPP Evolved Packet Core (EPC) via non-3GPP access networks". +- [27] IETF RFC 5448: "Improved Extensible Authentication Protocol Method for 3rd Generation Authentication and Key Agreement (EAP-AKA')". +- [28] IETF RFC 6611: "Mobile IPv6 (MIPv6) Bootstrapping for the Integrated Scenario". +- [29] 3GPP TS 29.272: "Evolved Packet System; MME and SGSN Related Interfaces Based on Diameter Protocol". +- [30] 3GPP TS 32.299: "Charging management; Diameter charging applications". +- [31] 3GPP TS 29.061: "Interworking between the Public Land Mobile Network (PLMN) supporting packet based services and Packet Data Networks (PDN)". +- [32] 3GPP TS 32.422: "Telecommunication management; Subscriber and equipment trace; Trace control and configuration management". +- [33] Void. +- [34] 3GPP TS 29.303: "Domain Name System Procedures; Stage 3". +- [35] IETF RFC 1035: "Domain Names - Implementation and Specification". +- [36] Void. +- [37] IETF RFC 5729: "Clarifications on the Routing of Diameter Requests Based on the Username and the Realm". +- [38] 3GPP TS 29.274: "3GPP Evolved Packet System (EPS); Evolved General Packet Radio Service (GPRS) Tunnelling Protocol for Control plane (GTPv2-C); Stage 3". +- [39] 3GPP TS 23.139: "3GPP System-Fixed Broadband Access Network Interworking; Stage 2". +- [40] IEEE Std 802.11-2012: "IEEE Standard for Information technology - Telecommunications and information exchange between systems - Local and metropolitan area networks - Specific requirements - Part 11: Wireless LAN Medium Access Control (MAC) and Physical Layer (PHY) Specifications". + +- [41] Void. +- [42] Void. +- [43] 3GPP TS 24.139: "3GPP system - fixed broadband access network interworking". +- [44] IETF RFC 4187: "Extensible Authentication Protocol Method for 3rd Generation Authentication and Key Agreement (EAP-AKA)". +- [45] 3GPP TS 23.203: "Policy and Charging Control Architecture". +- [46] IETF RFC 5580: "Carrying Location Objects in RADIUS and Diameter". +- [47] IETF RFC 7683: "Diameter Overload Indication Conveyance". +- [48] ETSI TS 283 034: "Telecommunications and Internet converged Services and Protocols for Advanced Networking (TISPAN); Network Attachment Sub-System (NASS); e4 interface based on the DIAMETER protocol". +- [49] 3GPP TS 23.008: "Organization of subscriber data". +- [50] Void +- [51] Void +- [52] 3GPP TS 23.380: "IMS Restoration Procedures". +- [53] IETF RFC 7944: "Diameter Routing Message Priority". +- [54] IETF RFC 8583: "Diameter Load Information Conveyance". +- [55] IETF RFC 6696: "EAP Extensions for the EAP Re-authentication Protocol (ERP)". +- [56] IETF RFC 6734: "Diameter Attribute-Value Pairs for Cryptographic Key Transport". +- [57] IETF RFC 6942: "Diameter Support for the EAP Re-authentication Protocol (ERP)". +- [58] IETF RFC 6733: "Diameter Base Protocol". + +--- + +## 3 Definitions, symbols and abbreviations + +### 3.1 Definitions + +#### 3.1.1 General + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +**Multi-connection mode (MCM):** see definition in clause 3.1 of 3GPP TS 23.402 [3]. + +**Single-connection mode (SCM):** see definition in clause 3.1 of 3GPP TS 23.402 [3]. + +**Transparent single-connection mode (TSCM):** see definition in clause 3.1 of 3GPP TS 23.402 [3]. + +**Trusted WLAN Identifier (TWID):** Identifier of a given Trusted WLAN, a combination of, e.g., an SSID and/or an HESSID as defined in IEEE Std 802.11-2012 [40]. + +#### 3.1.2 Handling of Information Elements + +In the tables that describe the Information Elements transported by each Diameter command, each Information Element is marked as (M) Mandatory, (C) Conditional or (O) Optional in the Category "Cat." column. For the correct handling + +of the Information Elements and their precedence to any included ABNF definition of the command as defined according to their category types, see the description detailed in clause 6 of the 3GPP TS 29.228 [22]. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|-------------|--------------------------------------------| +| AE | Authentication Extension | +| DRMP | Diameter Routing Message Priority | +| DSCP | Differentiated Services Code Point | +| EIR | Equipment Identity Register | +| EPC | Evolved Packet Core | +| ER | EAP Re-authentication | +| ERP | EAP Re-Authentication Protocol | +| ePDG | Evolved Packet Data Gateway | +| eHRPD | evolved High Rate Packet Data | +| FA | Foreign Agent | +| FACoA | FA Care-of-Address | +| HA | Home Agent | +| HBM | Host Based Mobility | +| HESSID | Homogenous Extended Service Set Identifier | +| HSGW | eHRPD Serving Gateway | +| LMA | Local Mobility Anchor | +| MAG | Mobile Access Gateway | +| MIPv4 | Mobile IP version 4 | +| MN | Mobile Node | +| NBM | Network Based Mobility | +| NAS | Network Access Server | +| PBU | Proxy Binding Update | +| PDN GW | PDN Gateway | +| PGW | PDN Gateway, the abbreviation of PDN GW | +| PMIP/PMIPv6 | Proxy Mobile IP version 6 | +| RRP | MIPv4 Registration Reply | +| RRQ | MIPv4 Registration Request | +| SA | Security Association | +| SGW | Serving Gateway | +| SIPTO | Selected IP Traffic Offload | +| SSID | Service Set Identifier | +| TWAN | Trusted WLAN Access Network | +| WLCP | Wireless LAN Control Plane Protocol | + +--- + +## 4 SWa Description + +### 4.1 Functionality + +#### 4.1.1 General + +The SWa reference point is defined between the untrusted non-3GPP IP access and the 3GPP AAA Server or Proxy. The definition of the reference point and its functionality is given in 3GPP TS 23.402 [3]. + +The SWa reference point is optionally used to authenticate and authorize the UE for the access to the EPS. It is up to the non-3GPP operator's policy whether this interface and the procedures defined in this clause are used. + +NOTE: From the EPS operator's view, the tunnel authentication and authorization procedures described in clause 7 (SWm description) and clause 9 are required to ensure the user's authentication and authorization when the UE is attached to an untrusted non-3GPP IP access. + +The same procedures as defined for STa reference points are used also in the SWa, but with reduced message content. As an exception, the service authorization information update procedure is not applicable for the SWa reference point. + +## 4.1.2 Procedure Descriptions + +### 4.1.2.1 SWa Authentication and Authorization procedure + +#### 4.1.2.1.1 General + +This procedure follows the STa Authentication and Authorization procedure, with the following differences: + +- Information elements that would reflect information about the user's service request and about the access network are not included or are optional in the authentication and authorization request. +- The information elements that describe the user's subscription profile are not downloaded to the non-3GPP access network. + +NOTE: The information elements related to the IP Mobility Mode Selection function are not supported over this interface. + +**Table 4.1.2.1/1: SWa Authentication and Authorization Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|----------------------------------------------|----------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| User Identity | User-Name | M | This information element shall contain the identity of the user. The identity shall be represented in NAI form as specified in the IETF RFC 4282 [15] and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]. This IE shall include the leading digit used to differentiate between authentication schemes. | +| EAP payload | EAP-payload | M | This IE shall contain the Encapsulated EAP payload used for the UE – 3GPP AAA Server mutual authentication | +| Authentication Request Type | Auth-Request-Type | M | This IE shall define whether the user is to be authenticated only, authorized only or both. AUTHORIZE_AUTHENTICATE shall be used in this case. | +| UE Layer-2 address | Calling-Station-ID | M | This IE shall carry the Layer-2 address of the UE. | +| Access Type | RAT-Type | C | If present, this IE shall contain the untrusted non-3GPP access network technology type that is serving the UE. | +| Access Network Identity | ANID | O | If present, this IE shall contain the access network identifier used for key derivation at the HSS. (See 3GPP TS 24.302 [26] for all possible values)
It shall be included if the non-3GPP access network selects the EAP-AKA' authentication method. | +| Full Name for Network | Full-Network-Name | O | If present, this IE shall contain the full name for network as specified in 3GPP TS 24.302 [26]. This AVP may be inserted by the non-3GPP access network depending on its local policy and only when it is not connected to the UE's Home Network | +| Short Name for Network | Short-Network-Name | O | If present, this IE shall contain the short name for network as specified in 3GPP TS 24.302 [26]. This AVP may be inserted by the non-3GPP access network depending on its local policy and only when it is not connected to the UE's Home Network | +| Transport Access Type | Transport-Access-Type | C | For interworking with Fixed Broadband access networks (see 3GPP TS 23.139 [39]), if the access network needs to receive the IMSI of the UE in the authentication response, then this information element shall be present, and it shall contain the value "BBF" (see clause 5.2.3.19). | +| Supported Features (See 3GPP TS 29.229 [24]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host for the lifetime of the Diameter session. | +| AAA Failure Indication | AAA-Failure-Indication | O | If present, this information element shall indicate that the request is sent after the non-3GPP access network has determined that a previously assigned 3GPP AAA Server is unavailable. | +| WLAN Location Information | Access-Network-Information | O | If present, this IE shall contain the location information of the WLAN Access Network where the UE is attached. | +| WLAN Location Timestamp | User-Location-Info-Time | O | This IE may be present if the WLAN Location Information IE is present.
When present, this IE shall contain the NTP time at which the UE was last known to be in the location reported in the WLAN Location Information. | + +**Table 4.1.2.1/2: SWa Authentication and Authorization Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|----------------------------------------------|-----------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| User Identity | User-Name | M | This information element shall contain the identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15] and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]. This IE shall include the leading digit used to differentiate between authentication schemes. | +| EAP payload | EAP payload | M | This IE shall contain the Encapsulated EAP payload used for UE-3GPP AAA Server mutual authentication. | +| Authentication Request Type | Auth-Request-Type | M | It shall contain the value AUTHORIZE_AUTHENTICATE. See IETF RFC 4072 [5]. | +| Result code | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation. Result codes are as in Diameter base protocol (see IETF RFC 6733 [58]). Experimental-Result AVP shall be used for SWa errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | +| Session Alive Time | Session-Timeout | O | This AVP may be present if the Result-Code AVP is set to DIAMETER_SUCCESS. If present, it shall contain the maximum number of seconds the user session is allowed to remain active. | +| Accounting Interim Interval | Accounting Interim-Interval | O | If present, this IE shall contain the Charging duration | +| Pairwise Master Key | EAP-Master-Session-Key | C | This IE shall be present if the Result-Code AVP is set to DIAMETER_SUCCESS. | +| 3GPP AAA Server URI | Redirect-Host | C | This information element shall be present if the Result-Code value is set to DIAMETER_REDIRECT_INDICATION. When the user has previously been authenticated by another 3GPP AAA Server, it shall contain the Diameter URI of the 3GPP AAA Server currently serving the user. The node receiving this IE shall behave as defined in the Diameter base protocol (see IETF RFC 6733 [58]). The command shall contain zero or more occurrences of this information element. When choosing a destination for the redirected message from multiple Redirect-Host AVPs, the receiver shall send the Diameter request to the first 3GPP AAA Server in the ordered list received in the Diameter response. If no successful response to the Diameter request is received, the receiver shall send the Diameter request to the next 3GPP AAA Server in the ordered list. This procedure shall be repeated until a successful response is received from a 3GPP AAA Server. | +| Trust Relationship Indicator | AN-Trusted | M | This AVP shall contain the 3GPP AAA Server's decision on handling the non-3GPP access network, i.e. trusted or untrusted. For the SWa case, the value "UNTRUSTED" shall be used. | +| Supported Features (See 3GPP TS 29.229 [24]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host for the lifetime of the Diameter session. | +| Permanent User Identity | Mobile-Node-Identifier | C | This information element shall only be sent if the Result-Code AVP is set to DIAMETER_SUCCESS and if the Transport Access Type in the request command indicated that the UE is accessing the EPC from a Fixed Broadband access network (i.e., the Transport-Access-Type AVP takes the value "BBF"); it shall contain an AAA/HSS assigned permanent user identity (i.e. an IMSI in root NAI format as defined in clause 19 of 3GPP TS 23.003 [14]) to be used by the non-3GPP access network in subsequent PCC procedure for identifying the user in the EPS network. This IE shall not include the leading digit prepended in front of the IMSI used to differentiate between authentication schemes. | + +#### 4.1.2.1.2 3GPP AAA Server Detailed Behaviour + +The detailed behaviour of the 3GPP AAA Server follows the behaviour defined for the STa Authentication and Authorization procedure (refer to clause 5.1.2.1.2), with the following deviations: + +- The 3GPP AAA Server shall handle the non-3GPP access network as untrusted. + +- The 3GPP AAA Server marks the trust relationship as "untrusted" with the User Identity. +- The authentication method shall be selected based on the presence of the Access Network Identity as specified in 3GPP TS 33.402 [19]: if this information element is present, the EAP-AKA' method as specified in IETF RFC 5448 [27] is used; otherwise, the EAP-AKA method as specified in IETF RFC 4187 [44] is used. + +When a WLAN Access Network provides WLAN Location Information to the 3GPP AAA Server that it considers as network provided location, the 3GPP AAA Server should store this information for the duration of the WLAN session of the UE, along with the WLAN Location Timestamp if received from the WLAN Access Network, or with the timestamp at which the WLAN Location Information is received from the WLAN Access Network, and provide it to the ePDG during a subsequent Authentication and Authorization procedure or Authorization procedure over the SWm reference point (see clauses 7.1.2.1.2 and 7.1.2.2.2). + +The 3GPP AAA Server shall delete any stored WLAN Location Information and WLAN Location Timestamp associated with the UE when a WLAN Access Network provides WLAN Location Information to the 3GPP AAA Server that it does not consider as network provided location. + +NOTE: It is up to local 3GPP AAA Server policies to decide whether the location information received from the WLAN access network can be considered as network provided location. + +#### 4.1.2.1.3 3GPP AAA Proxy Detailed Behaviour + +The detailed behaviour of the 3GPP AAA Proxy follows the behaviour defined for the STa Authentication and Authorization procedure (refer to clause 5.1.2.1.3), with the following exception: + +- The 3GPP AAA Proxy shall insert or overwrite Visited-Network-Identifier AVP before forwarding the request to the 3GPP AAA Server. + +NOTE: If the untrusted WLAN is operated by the VPLMN's equivalent PLMN, the 3GPP AAA proxy can receive the Visited-Network-Identifier AVP from the Authentication and Authorization Request message. + +- The 3GPP AAA Proxy shall handle the non-3GPP access network as untrusted and marks the trust relationship as "untrusted". + +On receipt of the authentication and authorization answer that completes a successful authentication, the 3GPP AAA Proxy shall record the authentication state of the user. + +#### 4.1.2.2 SWa HSS/AAA Initiated Detach + +This procedure equals with the STa HSS/AAA Initiated Detach procedure, refer to clause 5.1.2.2. + +The 3GPP AAA Server shall delete any stored WLAN Location Information and WLAN Location Timestamp associated with the UE when it becomes aware that the WLAN session of the UE is terminated. + +#### 4.1.2.3 SWa Non-3GPP Access Network Initiated Detach + +This procedure equals with the STa Non-3GPP Access Network Initiated Detach procedure, refer to clause 5.1.2.4. + +The 3GPP AAA Server shall delete any stored WLAN Location Information and WLAN Location Timestamp associated with the UE when it becomes aware that the WLAN session of the UE is terminated. + +#### 4.1.2.4 SWa Re-Authentication and Re-Authorization Procedure + +##### 4.1.2.4.1 General + +This procedure is optional and it may be invoked by the 3GPP AAA Server, if the operator policies require that the re-authentication of the user for the SWa is to be renewed and the untrusted non-3GPP access network supports the re-authentication. + +This procedure shall be performed in two steps: + +- The 3GPP AAA server shall issue an unsolicited re-auth request towards the untrusted non-3GPP access, indicating that both re-authentication and re-authorization of the user is needed. Upon receipt of such a + +request, the untrusted non-3GPP access shall respond to the request and shall indicate the disposition of the request. This procedure is mapped to the Diameter command codes Re-Auth-Request and Re-Auth-Answer specified in IETF RFC 6733 [58]. Information element contents for these messages shall be as shown in tables 4.1.2.4.1/1 and 4.1.2.4.1/2. + +- Upon receiving the re-auth request, the untrusted non-3GPP access shall immediately invoke the SWa authentication and authorization procedure requesting the identity of the user via EAP and using DER/DEA commands, with the same session-ID but the content adapted to the needs of a re-authentication. Information element contents for these messages shall be as shown in tables 4.1.2.4.1/3 and 4.1.2.4.1/4. + +If the re-authentication of the user is not successful, the untrusted non-3GPP access shall detach the user. + +**Table 4.1.2.4.1/1: SWa Re-auth request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Permanent User Identity | User-Name | M | This information element shall contain the permanent identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15], and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]; this IE shall not include the leading digit prepended in front of the IMSI used to differentiate between authentication schemes. | +| Re-Auth Request Type | Re-Auth-Request-Type | M | This information element shall define whether the user is to be authorized only or authenticated and authorized. AUTHORIZE_AUTHENTICATE shall be used in this case. | +| Routing Information | Destination-Host | M | This information element shall be obtained from the Origin-Host AVP, which was included in a previous command received from the untrusted non-3GPP access. | + +**Table 4.1.2.4.1/2: SWa Re-auth response** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-----------------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Permanent User Identity | User-Name | M | This information element shall contain the permanent identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15] and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]; this IE shall not include the leading digit prepended in front of the IMSI used to differentiate between authentication schemes. | +| Result | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation. The Result-Code AVP shall be used for errors defined in the Diameter Base Protocol (see IETF RFC 6733 [58]). The Experimental-Result AVP shall be used for SWa errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP and the error code in the Experimental-Result-Code AVP. | + +**Table 4.1.2.4.1/3: SWa Authentication and Authorization Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|-----------------------------|-------------------------|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| User Identity | User-Name | M | This information element shall contain the identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15] and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]. This IE shall include the leading digit used to differentiate between authentication schemes. | +| EAP payload | EAP-payload | M | This IE shall contain the Encapsulated EAP payload used for the UE – 3GPP AAA Server mutual authentication. | +| Authentication Request Type | Auth-Request-Type | M | This IE shall define whether the user is to be authenticated only, authorized only or both. AUTHORIZE_AUTHENTICATE shall be used in this case. | + +**Table 4.1.2.4.1/4: SWa Authentication and Authorization Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|-----------------------------|-----------------------------------|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| User Identity | User-Name | M | This information element shall contain the identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15] and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]. This IE shall include the leading digit used to differentiate between authentication schemes. | +| EAP payload | EAP payload | O | If present, this IE shall contain the Encapsulated EAP payload used for UE- 3GPP AAA Server mutual authentication. | +| Authentication Request Type | Auth-Request-Type | M | It shall contain the value AUTHORIZE_AUTHENTICATE. See IETF RFC 4072 [5]. | +| Result code | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation. Result codes are defined in the Diameter base protocol (see IETF RFC 6733 [58]). The Experimental-Result AVP shall be used for SWa errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | +| Session Alive Time | Session-Timeout | O | If present, this IE shall contain the maximum number of seconds the user session should remain active. | +| Accounting Interim Interval | Accounting Interim-Interval | O | If present, this IE shall contain the Charging duration. | +| Pairwise Master Key | EAP-Master-Session-Key | C | This IE shall be sent if Result-Code AVP is set to DIAMETER_SUCCESS. | + +#### 4.1.2.4.2 3GPP AAA Server Detailed Behaviour + +The 3GPP AAA Server shall trigger this procedure according to the local policies configured by the operator. + +The 3GPP AAA Server shall use the same authentication method that was used during the full authentication executed at the UE's attach. If EAP-AKA' is used, the 3GPP AAA Server shall use the ANID parameter received during the authentication and authorization executed at the UE attach (refer to clause 4.1.2.1.1). + +#### 4.1.2.4.3 3GPP AAA Proxy Detailed Behaviour + +The detailed behaviour of the 3GPP AAA Proxy follows the behaviour defined for the STa Re-Authorization and Re-Authentication Procedures (refer to clause 5.1.2.3.3), with the following addition: + +- When forwarding the authorization answer or the authentication and authorization answer, the 3GPP AAA Proxy shall record the authentication state of the user. + +## 4.2 Protocol Specification + +### 4.2.1 General + +The SWa reference point shall use the same Diameter application as the STa reference point. The first authentication command exchange (DER/DEA) is common between the SWa and STa reference points. During this initial exchange, the 3GPP AAA Server determines the HPLMN's trust relationship with the non-3GPP access network and communicates it to the non-3GPP access network and the UE as described in clause 5.1.2.1.2. The contents of the subsequent commands are dependent on this trust relationship determination and are specific to the SWa or STa reference points. + +## 4.2.2 Commands + +### 4.2.2.1 Commands for SWa authentication and authorization procedures + +#### 4.2.2.1.1 Diameter-EAP-Request (DER) Command + +The Diameter-EAP-Request (DER) command, indicated by the Command-Code field set to 268 and the 'R' bit set in the Command Flags field, is sent from a trusted non-3GPP access network to a 3GPP AAA Server. + +``` +< Diameter-EAP-Request > ::= < Diameter Header: 268, REQ, PXY > + < Session-Id > + [ DRMP ] + { Auth-Application-Id } + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + { Auth-Request-Type } + { EAP-Payload } + [ User-Name ] + [ Calling-Station-Id ] + [ RAT-Type ] + ... + [ ANID ] + [ Full-Network-Name ] + [ Short-Network-Name ] + *[ Supported-Features ] + [ AAA-Failure-Indication ] + [ Transport-Access-Type ] + [ OC-Supported-Features ] + [ Access-Network-Info ] + [ User-Location-Info-Time ] + ... + *[ AVP ] +``` + +#### 4.2.2.1.2 Diameter-EAP-Answer (DEA) Command + +The Diameter-EAP-Answer (DEA) command, indicated by the Command-Code field set to 268 and the 'R' bit cleared in the Command Flags field, is sent from a 3GPP AAA Server to a trusted non-3GPP access network NAS. + +``` +< Diameter-EAP-Answer > ::= < Diameter Header: 268, PXY > + < Session-Id > + [ DRMP ] + { Auth-Application-Id } + { Result-Code } + [ Experimental-Result ] + { Origin-Host } + { Origin-Realm } + { Auth-Request-Type } + [ EAP-Payload ] + [ User-Name ] + [ Session-Timeout ] + [ Accounting-Interim-Interval ] + [ EAP-Master-Session-Key ] + *[ Redirect-Host ] + [ AN-Trusted ] + *[ Supported-Features ] + [ Mobile-Node-Identifier ] + [ OC-Supported-Features ] + [ OC-OLR ] + *[ Load ] +``` + +... +\*[ AVP ] + +#### 4.2.2.2 Commands for SWa HSS/AAA Initiated Detach + +Refer to clause 5.2.2.2. + +#### 4.2.2.3 Commands for Untrusted non-3GPP Access network Initiated Session Termination + +Refer to clause 5.2.2.4. + +#### 4.2.2.4 Commands for SWa Re-Authentication and Re-Authorization Procedures + +##### 4.2.2.4.1 Re-Auth-Request (RAR) Command + +The Diameter Re-Auth-Request (RAR) command, indicated by the Command-Code field set to 258 and the "R" bit set in the Command Flags field, shall be sent from a 3GPP AAA server to an untrusted non-3GPP access network NAS. ABNF for the RAR command shall be as follows: + +``` +< Re-Auth-Request > ::= < Diameter Header: 258, REQ, PXY, 16777250 > + < Session-Id > + [ DRMP ] + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + { Destination-Host } + { Auth-Application-Id } + { Re-Auth-Request-Type } + [ User-Name ] + ... + *[ AVP ] +``` + +##### 4.2.2.4.2 Re-Auth-Answer (RAA) Command + +The Diameter Re-Auth-Answer (RAA) command, indicated by the Command-Code field set to 258 and the "R" bit cleared in the Command Flags field, shall be sent from an untrusted non-3GPP access network NAS to a 3GPP AAA server. ABNF for the RAA command shall be as follows: + +``` +< Re-Auth-Answer > ::= < Diameter Header: 258, PXY, 16777250 > + < Session-Id > + [ DRMP ] + { Result-Code } + { Origin-Host } + { Origin-Realm } + ... + *[ AVP ] +``` + +##### 4.2.2.4.3 Diameter-EAP-Request (DER) Command + +Refer to clause 4.2.2.1.1. + +##### 4.2.2.4.4 Diameter-EAP-Answer (DEA) Command + +Refer to clause 4.2.2.1.2 + +### 4.2.3 Information Elements + +The information elements of SWa are the same as the IEs defined for the STa interface described in the clause 5.2.3. + +#### 4.2.4 Session Handling + +The session handling for the SWa interface is the same as the STa session handling described in the clause 5.2.4. + +--- + +## 5 STa Description + +### 5.1 Functionality + +#### 5.1.1 General + +The STa reference point is defined between a non-3GPP access network and the 3GPP AAA Server or between a non-3GPP access network and the 3GPP AAA Proxy. The definition of the reference point and its functionality is given in 3GPP TS 23.402 [3]. + +Whether a Non-3GPP access network is Trusted or Untrusted is not a characteristic of the access network; this decision shall be made during the access authentication and authorization procedure executed between the non-3GPP access network and the 3GPP AAA Server. This is implemented by the STa and SWa reference points sharing the same Diameter application and partly sharing the same authentication and authorization procedure. The STa and SWa reference points are clearly distinguished after the exchange of the first authentication and authorization messages, during which trusted/untrusted decision is made by the 3GPP AAA server and this decision is communicated to the non-3GPP access network. The other procedures are specific to the STa and SWa reference points. + +The STa reference point shall be used to authenticate and authorize the UE. + +The STa reference point may also be used to transport PMIPv6, GTPv2, or MIPv4 FA-CoA mode related mobility parameters in a case the UE attaches to the EPC using the S2a reference point. The procedures specified for EPC access via GTP based S2a are only applicable to trusted WLAN access networks (see clause 16 of 3GPP TS 23.402 [3]). + +Additionally the STa reference point may also be used to transport DSMIPv6 related mobility parameters in case the UE attaches to the EPC using the S2c reference point. In particular, in this case the STa reference point may be used for conveying the Home Agent IP address or FQDN from the AAA server to the gateway of the trusted non-3GPP access for Home Agent discovery based on DHCPv6 (see TS 24.303 [13]). + +This reference point shall be also used to transport charging-related information and optionally information about IP Mobility Mode Selection. + +#### 5.1.2 Procedures Description + +##### 5.1.2.1 STa Access Authentication and Authorization + +###### 5.1.2.1.1 General + +These procedures are transported over Diameter, the Access (Re-)Authentication and Authorization between the trusted non-3GPP access network and the 3GPP AAA Proxy or Server. The STa interface and Diameter application shall be used for authenticating and authorizing the UE for EPC access in PMIPv6, GTPv2, MIPv4 FA-CoA mode or for TWAN access without EPC S2a access (i.e. non-seamless WLAN offload) via trusted non-3GPP accesses and non-3GPP accesses that are decided to be untrusted during the authentication and authorization procedure. + +When EAP-AKA' is used in the STa access authentication and either EPC access in NBM (PMIPv6 or GTPv2) or TWAN access without EPC S2a access (i.e. non-seamless WLAN offload) is used, the trusted non-3GPP access network shall support also the role of the NAS. Specifically, in the case where PMIPv6 is used, the network element of the non-3GPP access network acting as a MAG shall have also the role of the NAS. During the STa access authentication the NAS shall serve as pass-through EAP authenticator. + +Diameter usage over the STa interface: + +- When EAP is used, the trusted non-3GPP access authentication and authorization procedure shall be mapped to the Diameter-EAP-Request and Diameter-EAP-Answer command codes specified in IETF RFC 4072 [5]. + +- For (re)authentication procedures, the messaging described below shall be reused. + +During the STa Access Authentication and Authorization procedure the non-3GPP access network may provide information on its PMIPv6 or GTPv2 capabilities to the 3GPP AAA Server. + +During the STa Access Authentication and Authorization procedure the trusted non-3GPP access network shall provide information on the Access Network Identity (ANID) to the 3GPP AAA Server. Specifically, the TWAN shall set the Access Network Identity as specified in clause 8.1.1.2 of 3GPP TS 24.302 [26] for a WLAN access network. + +For a trusted non-3GPP access, the 3GPP AAA Server may perform IP mobility mode selection between NBM and HBM. The 3GPP AAA Server may provide to the trusted non-3GPP access network an indication if either NBM or local IP address assignment (for HBM) shall be used. + +For a trusted WLAN access, + +- the TWAN should send information on whether it supports TSCM, SCM or MCM or any combination of them to the 3GPP AAA Server as specified in 3GPP TS 23.402 [63]. If it indicates support of the MCM, the TWAN shall also provide the 3GPP AAA Server with the TWAG's control plane IPv4 address, or IPv6 address or both (if it supports both IPv4 and IPv6), to be sent to the UE and used for WLCP if the MCM is selected. +- if the user is successfully authenticated and authorized for this access, the 3GPP AAA Server: + - shall select either TSCM, SCM or MCM and indicate to the TWAN the selected mode of operation. If the 3GPP AAA Server does not provide such an indication, the TSCM shall be used; + - may either only authorize the user to access to EPC via S2a (i.e. EPC-routed service only), or only authorize the user to access the TWAN without granting access to EPC via S2a (i.e. non-seamless WLAN offload service only), or authorize both EPC-routed and non-seamless WLAN offload services. If the SCM is selected, the 3GPP AAA Server shall indicate to the TWAN its decision to either authorize access to EPC via S2a or only authorize the user to access the TWAN without granting access to EPC via S2a, i.e. not both; + - when authorizing the SCM to be used for EPC access, the 3GPP AAA server shall forward the PDN connectivity parameters received from the UE to the TWAN, i.e. the UE requested PDN type (IPv4, IPv6 or IPv4v6), the attach type (initial attach or handover), optionally the requested APN (if received from the UE) and optionally the Protocol Configuration Options (if received from the UE); + - when authorizing the MCM for EPC access, the 3GPP AAA server shall derive the WLCP key as defined in 3GPP TS 33.402 [19] and shall provide the WLCP key to the TWAN to protect the WLCP signalling. + +if the user is successfully authenticated and authorized for this access, the TWAN: + +- shall decide the S2a protocol variant to use if access to EPC is authorized and the TWAN decides to establish S2a. +- if the SCM has been authorized to be used for EPC access, the TWAN shall return an indication to the 3GPP AAA Server on whether the requested connectivity has been granted and, if so, also pass on to the 3GPP AAA Server the connectivity parameters to be provided to the UE, i.e. the selected APN, the selected PDN type (IPv4, IPv6 or IPv4v6), the IPv4 address (for PDN type IPv4 or IPv4v6), the IPv6 interface identifier (for PDN type IPv6 or IPv4v6), optionally the Protocol Configuration Options received from the PDN GW once S2a has been established, and the TWAG user plane MAC address. If the requested connectivity has not been granted, the TWAN should provide the 3GPP AAA Server with a cause indicating why the requested connectivity could not be granted; the TWAN may also provide a Session Management back-off timer to be sent to the UE to instruct the UE to not request new PDN connectivity to the same APN for the indicated time. + +When authorizing NBM to be used, the 3GPP AAA server shall return NBM related information back to the trusted non-3GPP access network. + +During the STa Access Authentication and Authorization procedure, when DSMIPv6 is used, the 3GPP AAA Server may provide a Home Agent IPv6 address (and optionally IPv4 address) or FQDN to the trusted non-3GPP access network. This is needed if the DHCPv6 option for Home Agent address discovery is chosen (see TS 24.303 [13] and IETF RFC 6611 [28]). If the Home Agent IPv6 address or FQDN is not included in the final Authentication and Authorization Answer by the 3GPP AAA server, the trusted non-3GPP access network shall not assign the Home Agent via DHCPv6. + +During the STa Access Authentication and Authorization procedure for MIPv4 FA-CoA mode using trusted non-3GPP access, the 3GPP AAA Server may provide the mobility security parameters FA-RK and FA-RK-SPI to the trusted non-3GPP access network. + +The User-Name AVP may contain a decorated NAI (as defined in clause 19.3.3 of 3GPP TS 23.003 [14]). In this case the 3GPP AAA Proxy shall process the decorated NAI and support routing of the Diameter request messages based on the decorated NAI as described in IETF RFC 5729 [37]. + +Based on local policies, EPC access for emergency services over a trusted non-3GPP access is supported as specified in clause 4.5.7.2.1 of 3GPP TS 23.402 [3] for: + +- UEs with a valid EPC subscription that are authenticated and authorized for EPC services; +- UEs that are authenticated only; +- UEs with an unauthenticated IMSI; and/or +- UICC-less UEs. + +For PMIPv6, GTPv2 and MIPv4 FA-CoA mode trusted non-3GPP accesses, upon mobility between 3GPP and non-3GPP accesses, for the PDNs the UE is already connected, the PDN GW identity for each of the already allocated PDN GW(s) with the corresponding PDN information is provided to the trusted non-3GPP system. The PDN GW identity is a FQDN and/or IP address of the PDN GW. The non-3GPP access network shall use the received PDN GW identity for mobility with IP address preservation or in case of static PDN GW assignment. If a FQDN is provided, the trusted non-3GPP system shall then derive it to IP address according to the selected mobility management protocol. + +NOTE: Mobility with IP address preservation is not supported between TWAN and 3GPP access in TSCM. + +During the STa Access Authentication and Authorization procedure, the bootstrapping of an ER server in the TWAN with a given root key may be performed, as described in IETF RFC 6696 [55] and 3GPP TS 33.402 [19]. This procedure is used to provide an ER server with the keying material that will be used for further EAP re-authentication procedures using ERP. + +**Table 5.1.2.1/1: STa Access Authentication and Authorization Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|----------------------------------------------|----------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| User Identity | User-Name | M | This information element shall contain the identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15] and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]. This IE shall include the leading digit used to differentiate between authentication schemes, if it contains a NAI other than an Emergency NAI for Limited Service State. | +| EAP payload | EAP-payload | M | This IE shall contain the Encapsulated EAP payload used for the UE – 3GPP AAA Server mutual authentication | +| Authentication Request Type | Auth-Request-Type | M | This IE shall define whether the user is to be authenticated only, authorized only or both. AUTHORIZE_AUTHENTICATE shall be used in this case. | +| UE Layer-2 address | Calling-Station-ID | M | This IE shall contain the Layer-2 address of the UE. | +| Supported 3GPP QoS profile | QoS-Capability | O | If the non-3GPP access network supports QoS mechanisms, this information element may be included to contain the access network's QoS capabilities as defined in IETF RFC 5777 [9]. | +| Mobility Capabilities | MIP6-Feature-Vector | C | This information element shall contain the mobility capabilities of the non-3GPP access network. This information shall be utilized if dynamic mobility mode selection is executed. This information may also be used to decide whether to authorize access to EPC to a user accessing a TWAN.

The PMIP6_SUPPORTED flag and/or the GTPv2 SUPPORTED flag shall be set if the non-3GPP access supports PMIPv6 and/or GTPv2. PMIP6_SUPPORTED flag is defined in IETF RFC 5779 [2].

The flag MIP6_INTEGRATED shall be set if DHCPv6 based Home Agent address discovery is supported as defined in IETF RFC 5447 [6].

The MIP4_SUPPORTED flag shall be set if the non-3GPP access supports MIPv4 FA-CoA mode. | +| Access Type | RAT-Type | M | This IE shall contain the non-3GPP access network technology type that is serving the UE.
The TWAN shall set the Access Type value to "WLAN". | +| Access Network Identity | ANID | M | This IE shall contain the access network identifier used for key derivation at the HSS. (See 3GPP TS 24.302 [26] for all possible values) | +| Full Name for Network | Full-Network-Name | O | If present, this IE shall contain the full name for network as specified in 3GPP TS 24.302 [26]. This AVP may be inserted by the non-3GPP access network depending on its local policy and only when it is not connected to the UE's Home Network. If the Visited Network Identifier is present, this AVP shall be set. | +| Short Name for Network | Short-Network-Name | O | If present, this IE shall contain the short name for network as specified in 3GPP TS 24.302 [26]. This AVP may be inserted by the non-3GPP access network depending on its local policy and only when it is not connected to the UE's Home Network. If the Visited Network Identifier is present, this AVP shall be set. | +| Visited Network Identifier | Visited-Network-Identifier | O | If present, this IE shall contain the Identifier that allows the home network to identify the Visited Network. This AVP may be inserted by the non-3GPP access network depending on its local policy and only when it is not connected to the UE's Home Network. | +| APN Id | Service-Selection | O | If present, this information element shall contain the Network Identifier part of the APN the user wants to connect to (if available). | +| Terminal Information | Terminal-Information | O | If present, this information element shall contain information about the user's mobile equipment. The type of identity carried depends on the access technology type. For an HRPD access network, the 3GPP2-MEID AVP shall be included in this grouped AVP. | +| Supported Features (See 3GPP TS 29.229 [24]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host for the lifetime of the Diameter session. | + +| | | | | +|-----------------------------------------------|------------------------------|---|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Selected Trusted WLAN Identifier | WLAN-Identifier | O | If present, this IE shall contain the WLAN Identifier selected by the UE to access the Trusted WLAN Access Network (see clause 16 of 3GPP TS 23.402 [3]). | +| AAA Failure Indication | AAA-Failure-Indication | O | If present, this information element shall indicate that the request is sent after the non-3GPP access network has determined that a previously assigned 3GPP AAA Server is unavailable. | +| DER Flags | DER-Flags | O | This Information Element contains a bit mask. See 5.2.3.20 for the meaning of the bits. | +| Transport Access Type | Transport-Access-Type | C | For interworking with Fixed Broadband access networks (see 3GPP TS 23.139 [39]), if the access network needs to receive the IMSI of the UE in the authentication response, then this information element shall be present, and it shall contain the value "BBF" (see clause 5.2.3.19). | +| Supported TWAN Connection Modes | TWAN-Connection-Mode | O | The TWAN should include this IE.
If present, this information element shall contain the TWAN connection modes supported by the TWAN, i.e. TSCM, SCM and/or MCM. | +| Provided Connectivity Parameters | TWAN-Connectivity-Parameters | C | This information element shall be present if the 3GPP AAA Server has previously authorized the SCM to be used for EPC access.

TWAN-Connectivity-Parameters is a grouped AVP.

If the requested connectivity has been granted, the following information elements shall be included:
- selected APN
- selected PDN type
- UE IPv4 Address (for PDN type IPv4 or IPv4v6)
- UE IPv6 Interface Identifier (for PDN type IPv6 or IPv4v6)
- Protocol Configuration Options (if received from the PGW)
- TWAG user plane MAC address

The absence of both an IPv4 address and an IPv6 Interface Identifier indicates that the requested connectivity could not be granted. If the requested connectivity has not been granted, the following information elements may be included:
- a cause indicating why the requested connectivity has not been granted
- a Session Management back-off timer to be sent to the UE | +| TWAG Control Plane IP Address | TWAG-CP-Address | C | The TWAN shall include this IE if it indicates support of the MCM in the Supported TWAN Connection Modes IE. When present, this IE shall contain the TWAG Control Plane IPv4 Address, or the TWAG Control Plane IPv6 link local address, or both (if the TWAG supports IPv4 and IPv6), to be used for WLCP by the UE if the MCM is used. | +| IMEI Check in VPLMN Result | IMEI-Check-In-VPLMN-Result | C | The 3GPP AAA Proxy shall include this IE if it has performed an IMEI check in the VPLMN. When present, this IE shall contain the result of the IMEI check. | +| Domain-Specific Re-authentication Key Request | ERP-RK-Request | O | If present, this IE indicates the willingness of an ER server located in the non-3GPP access network to act as the ER server for this session.

When present, this IE shall contain the name of the realm in which the ER server is located. | + +**Table 5.1.2.1/2: Trusted non-3GPP Access Authentication and Authorization Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|-----------------------------|----------------------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| User Identity | User-Name | M | This information element shall contain the identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15] and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]. This IE shall include the leading digit used to differentiate between authentication schemes, if it contains a NAI other than an Emergency NAI for Limited Service State. | +| EAP payload | EAP payload | O | If present, this IE shall contain the Encapsulated EAP payload used for UE- 3GPP AAA Server mutual authentication. This IE shall not be included if the UE has been authenticated and the 3GPP AAA Server authorizes the SCM for EPC access for the UE and the Result-Code AVP is set to DIAMETER_MULTI_ROUND_AUTH. | +| Authentication Request Type | Auth-Request-Type | M | It shall contain the value AUTHORIZE_AUTHENTICATE. See IETF RFC 4072 [5]. | +| Result code | Result-Code / Experimental Result Code | M | This IE shall contain the result of the operation. Result codes are as in Diameter base protocol (see IETF RFC 6733 [58]). Experimental-Result AVP shall be used for STa errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | +| Session Alive Time | Session-Timeout | O | This AVP may be present if the Result-Code AVP is set to DIAMETER_SUCCESS; if present, it contains the maximum number of seconds the session is allowed to remain active. | +| Accounting Interim Interval | Accounting Interim-Interval | O | If present, this IE shall contain the Charging duration. | +| Pairwise Master Key | EAP-Master-Session-Key | C | This IE shall be present if Result-Code AVP is set to DIAMETER_SUCCESS. | +| Default APN | Context-Identifier | C | This AVP shall indicate the default APN for the user. If the Access Network Identity received in the Authentication and Authorization Request indicates WLAN (see clause 8.1.1.2 of 3GPP TS 24.302 [26]) and if the TSCM is selected, this AVP shall be set to the Default APN for Trusted WLAN if received from the HSS; otherwise this AVP shall be set to the subscriber's Default APN for 3GPP and other non-3GPP accesses. It shall only be included if NBM is authorized for use, the non-3GPP access network was decided to be trusted, the Emergency-Indication bit of the Emergency-Services AVP is not set in the Authentication and Authorization Answer and the Result-Code AVP is set to either:
- DIAMETER_SUCCESS or
- DIAMETER_MULTI_ROUND_AUTH, and TWAN-S2a-Connectivity-Indicator is set in DEA-Flags.
(see NOTE 1) | +| APN-OI replacement | APN-OI-Replacement | C | This AVP shall indicate the domain name to replace the APN-OI in the non-roaming case or in the home routed roaming case when constructing the PDN GW FQDN upon which a DNS resolution needs to be performed. See 3GPP TS 23.003 [3]. It shall only be included if NBM is authorized for use, the Emergency-Indication bit of the Emergency-Services AVP is not set in the Authentication and Authorization Answer and the Result-Code AVP is set to either:
- DIAMETER_SUCCESS or
- DIAMETER_MULTI_ROUND_AUTH, and TWAN-S2a-Connectivity-Indicator is set in DEA-Flags.
(see NOTE 1) | + +| | | | | +|--------------------|-------------------|---|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| APN and PGW Data | APN-Configuration | C |

This information element shall only be sent if EPC Access is authorized, the Emergency-Indication bit of the Emergency-Services AVP is not set in the Authentication and Authorization Answer and the Result-Code AVP is set to either:

  • - DIAMETER_SUCCESS or
  • - DIAMETER_MULTI_ROUND_AUTH, and TWAN-S2a-Connectivity-Indicator is set in DEA-Flags.

(see NOTE 1)

When NBM is authorized for use, this AVP shall contain the default APN, the list of authorized APNs, including the wildcard APN if configured in the user's subscription, user profile information and PDN GW information.

When local IP address assignment is used (for HBM), this AVP shall only be present if DHCP based Home Agent discovery is used and contain the Home Agent Information for discovery purposes.

The trusted non-3gpp access network knows if NBM is authorized for use or if a local IP address (for HBM) is assigned based on the flags in the MIP6-Feature-Vector.

APN-Configuration is a grouped AVP, defined in 3GPP TS 29.272 [29]. When NBM is authorized for use, the following information elements per APN may be included:

  • - APN
  • - Authorized 3GPP QoS profile
  • - Statically allocated User IP Address (IPv4 and/or IPv6)
  • - Allowed PDN types
  • - PDN GW identity
  • - PDN GW allocation type
  • - VPLMN Dynamic Address Allowed
  • - APN-AMBR
  • - Visited Network Identifier (see clause 5.1.2.1.4)
  • - SIPTO permission

When DSMIPv6 is used, the following information elements per Home Agent may be included:

  • - HA-APN (Home Agent APN as defined in 3GPP TS 23.003 [14])
  • - Authorized 3GPP QoS profile
  • - PDN GW identity

When MIPv4 FACoA is used, the following information elements per APN may be included:

  • - APN
  • - Allowed PDN types
| +| Serving GW Address | MIP6-Agent-Info | O | This AVP shall be used only in chained S2a-S8 cases and it shall be sent only if the Result-Code AVP is set to DIAMETER_SUCCESS. | + +| | | | | +|-----------------------|---------------------|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Mobility Capabilities | MIP6-Feature-Vector | C |

This information element shall only be sent if EPC Access is authorized and if the Result-Code AVP is set to either:

  • - DIAMETER_SUCCESS or
  • - DIAMETER_MULTI_ROUND_AUTH, and TWAN-S2a-Connectivity-Indicator is set in DEA-Flags.

(see NOTE 1)

It shall contain a AAA/HSS authorized set of mobility capabilities to the trusted non-3GPP access network, if dynamic mobility mode selection between NBM and HBM is done. It shall also be sent when authorizing access to EPC to a user accessing a TWAN.

The PMIP6_SUPPORTED and/or the GTPv2_SUPPORTED shall be set to indicate that NBM (PMIPv6 or GTPv2) is authorized for use.

Otherwise, ASSIGN_LOCAL_IP or MIP4_SUPPORTED flag shall be set by the 3GPP AAA Server to mandate which HBM mobility protocol is used.

The MIP6_INTEGRATED flag shall be set if a Home Agent address is provided for DHCPv6 based Home Agent address discovery. In the latter case HA information for DHCPv6 discovery is provided via the APN-Configuration AVP.

| +|-----------------------|---------------------|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +| | | | | +|-------------------------|-------------------------------|---|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Permanent User Identity | Mobile-Node-Identifier | C |

This information element shall only be sent if the Result-Code AVP is set to either:

  • - DIAMETER_SUCCESS or
  • - DIAMETER_MULTI_ROUND_AUTH, and TWAN-S2a-Connectivity-Indicator is set in DEA-Flags.

(see NOTE 1)

This information element shall only be sent if NBM or MIPv4 is authorized for use, or when authorizing the user to access the TWAN without granting access to EPC S2a (i.e. non-seamless WLAN offload).

If the user is authenticated, it shall contain an AAA/HSS assigned permanent user identity (i.e. an IMSI in root NAI format as defined in clause 19 of 3GPP TS 23.003 [14]) to be used:

  • - by the MAG in subsequent PBUs as the MN-ID identifying the user in the EPS network, or
  • - by the trusted non-3GPP access network in subsequent MIPv4 RRQs as the MN-NAI identifying the user in the EPS network, or
  • - by the trusted non-3GPP access network to derive the IMSI to be sent in subsequent Create Session Request on GTP S2a.

For an Emergency Attach, if the UE is UICC-less (i.e. the User Identity IE in the request contains an IMEI) or if the IMSI is not authenticated, the Permanent User Identity shall contain the IMEI in Emergency NAI for Limited Service State format as defined in clause 19 of 3GPP TS 23.003 [14].

This information element shall also be sent if HBM is authorized for use, or to access a Fixed Broadband access network without granting access to EPC S2a (i.e. non-seamless WLAN offload), and the Result-Code AVP is set to DIAMETER_SUCCESS and if the Transport Access Type in the request command indicated that the UE is accessing the EPC from a Fixed Broadband access network (i.e., the Transport-Access-Type AVP takes the value "BBF"); it shall contain an AAA/HSS assigned permanent user identity (i.e. an IMSI in root NAI format as defined in clause 19 of 3GPP TS 23.003 [14]) to be used:

  • - by the trusted non-3GPP access network in subsequent PCC procedure for identifying the user in the EPS network.

If this IE contains an identity based on IMSI, this IE shall not include the leading digit prepended in front of the IMSI used to differentiate between authentication schemes.

| +| 3GPP AAA Server URI | Redirect-Host | C |

This information element shall be sent if the Result-Code value is set to DIAMETER_REDIRECT_INDICATION. When the user has previously been authenticated by another 3GPP AAA Server, it shall contain the Diameter URI of the 3GPP AAA Server currently serving the user. The node receiving this IE shall behave as defined in the Diameter base protocol (see IETF RFC 6733 [58]). The command shall contain zero or more occurrences of this information element. When choosing a destination for the redirected message from multiple Redirect-Host AVPs, the receiver shall send the Diameter request to the first 3GPP AAA Server in the ordered list received in the Diameter response. If no successful response to the Diameter request is received, the receiver shall send the Diameter request to the next 3GPP AAA Server in the ordered list. This procedure shall be repeated until a successful response is received from a 3GPP AAA Server.

| +| UE Charging Data | 3GPP-Charging-Characteristics | O |

If present, this information element shall contain the type of charging method to be applied to the user (see 3GPP TS 29.061 [31]).

| +| UE AMBR | AMBR | C |

This Information Element shall contain the UE AMBR of the user. It shall be present only if the non-3GPP access network was decided to be trusted, the Result-Code AVP is set to DIAMETER_SUCCESS and ANID is "HRPD".

| + +| | | | | +|----------------------------------------------|------------------------------|---|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Trust Relationship Indicator | AN-Trusted | C | This AVP shall be included only in the first authentication and authorization response. If present, it shall contain the 3GPP AAA Server's decision on handling the non-3GPP access network trusted or untrusted.
For the STa case, the value "TRUSTED" shall be used. | +| Supported Features (See 3GPP TS 29.229 [24]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host for the lifetime of the Diameter session. | +| FA-RK | MIP-FA-RK | C | This AVP shall be present if MIPv4 FACoA mode is used, the MN-FA authentication extension is supported and the Result-Code AVP is set to DIAMETER_SUCCESS. | +| FA-RK-SPI | MIP-FA-RK-SPI | C | This AVP shall be present if MIP-FA-RK is present | +| Trace information | Trace-Info | C | This information element shall only be sent if the Result-Code AVP is set to either:
- DIAMETER_SUCCESS or
- DIAMETER_MULTI_ROUND_AUTH, and TWAN-S2a-Connectivity-Indicator is set in DEA-Flags.
(see NOTE 1)

This AVP shall be included if the subscriber and equipment trace has been activated for the user in the HSS and signalling based activation is used to download the trace activation from the HSS to the non-3GPP access network.
Only the Trace-Data AVP shall be included to the Trace-Info AVP and shall contain the following AVPs:
- Trace-Reference
- Trace-Depth-List
- Trace-Event-List, for PGW
- Trace-Collection-Entity
The following AVPs may also be included in the Trace-Data AVP:
- Trace-Interface-List, for PGW, if this AVP is not present, trace report generation is requested for all interfaces for PGW listed in 3GPP TS 32.422 [32]
- Trace-NE-Type-List, with the only allowed value being "PDN GW". If this AVP is not included, trace activation in PDN GW is required. | +| MSISDN | Subscription-ID | C | This AVP shall contain the MSISDN of the UE and shall be sent if it is available and the non-3GPP access network is trusted and the Result-Code AVP is set to either:
- DIAMETER_SUCCESS or
- DIAMETER_MULTI_ROUND_AUTH, and TWAN-S2a-Connectivity-Indicator is set in DEA-Flags.
(see NOTE 1) | +| DEA Flags | DEA-Flags | O | This Information Element contains a bit mask. See 5.2.3.21 for the meaning of the bits. | +| Selected TWAN Connection Mode | TWAN-Connection-Mode | C | The 3GPP AAA Server shall include this IE if it selects either the SCM or MCM and the Result-Code AVP is set to either:
- DIAMETER_SUCCESS or
- DIAMETER_MULTI_ROUND_AUTH, and TWAN-S2a-Connectivity-Indicator is set in DEA-Flags.
(see NOTE 1)
When present, this IE shall indicate the selected mode of operation (either SCM or MCM).
If this IE is not present, the TWAN shall use TSCM. | +| Requested Connectivity Parameters | TWAN-Connectivity-Parameters | C | This IE shall contain the requested connectivity parameters received from the UE if the 3GPP AAA Server authorizes the SCM for TWAN and the Result-Code AVP is set to DIAMETER_MULTI_ROUND_AUTH, and TWAN-S2a-Connectivity-Indicator is set in DEA-Flags.

When present, the following information elements shall be included:
- attach type (initial attach or handover)
- requested APN (if received from the UE, see NOTE 3) if the UE did not request an Emergency Attach.
- requested PDN type
- Protocol Configuration Options (if received from the UE) | + +| | | | | +|----------------------|----------------------|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| WLCP Key | WLCP-Key | C | This IE shall be present if the Result-Code AVP is set to DIAMETER_SUCCESS and the selected TWAN Connection Mode is MCM. If present, it shall contain the key for protecting WLCP signalling (see 3GPP TS 33.402 [19]). | +| Terminal Information | Terminal-Information | C | This information element enables to convey the user's Mobile Equipment Identity to the non-3GPP access network in scenarios where the UE signals its Mobile Equipment Identity directly to the 3GPP AAA Server, i.e. when the Terminal-Information AVP is not received in the Authentication and Authorization Request.

For a trusted WLAN access, the 3GPP AAA Server shall include this IE if the user's Mobile Equipment Identity is available. When present, this grouped AVP shall contain the IMEI AVP and, if available, the Software Version AVP. (see NOTE 2) | +| Emergency Services | Emergency-Services | C | If the 3GPP AAA Server supports IMS emergency sessions over TWAN (see clause 4.5.7 of 3GPP TS 23.402 [3]), it shall include this IE and set the Emergency-Indication bit when the UE indicates an Emergency Attach in EAP-AKA' signalling. | +| Emergency Info | Emergency-Info | C | When present, this IE shall contain the identity of the PDN GW dynamically allocated for emergency services. It shall be present for a non-roaming authenticated user, if this information was received from the HSS, the TWAN indicated support of IMS Emergency sessions and the Result-Code AVP is set to either:
- DIAMETER_SUCCESS or
- DIAMETER_MULTI_ROUND_AUTH and TWAN-S2a-Connectivity-Indicator is set in DEA-Flags. (see NOTE 1) | +| ERP Keying Material | Key | C | If the 3GPP AAA Server supports ERP, this IE shall be present if the Result-Code AVP is set to DIAMETER_SUCCESS, the domain-specific re-authentication key was requested and the use of ERP is authorized for this user (see clause 8.2.3.27). In that case, this IE shall contain the Domain-Specific Root Key (DSRK) and the Extended Master Session Key name (EMSKname), and it may contain the DSRK lifetime. | +| ERP Realm | ERP-Realm | C | This IE shall be present if the ERP Keying Material is present. This IE indicates the realm where the ER server is located; it also indicates the domain name to use as the realm part of the KeyName-NAI used during ERP-based re-authentication. | +| UE Usage Type | UE-Usage-Type | C | This IE shall be present if this information is available in the user subscription. When present, this IE shall contain the UE Usage Type of the subscriber. | + +NOTE 1: The 3GPP AAA Server may decide to not include the AVP if the Result-Code AVP is set to DIAMETER\_SUCCESS and the AVP has already been sent in a previous message with the Result-Code AVP set to DIAMETER\_MULTI\_ROUND\_AUTH and the TWAN-S2a-Connectivity-Indicator set in DEA-Flags. In that case, the TWAN shall consider the information received in the previous message as still applicable. + +NOTE 2: For a trusted WLAN access, the UE signals its Mobile Equipment Identity to the 3GPP AAA Server via EAP-AKA' and the 3GPP AAA Server forwards this information to the TWAN in the Terminal-Information AVP in the Authentication and Authorization Answer. + +NOTE 3: The Service-Selection AVP in the Requested Connectivity Parameters IE shall contain the APN requested by the UE, regardless of whether this APN is authorized by a matching APN or by the wildcard APN in the user's subscription. + +#### 5.1.2.1.2 3GPP AAA Server Detailed Behaviour + +On receipt of the first DER message, the 3GPP AAA Server shall check the validity of the ANID AVP and whether the non-3GPP access network is entitled to use the included value. The correct syntax of the ANID is checked as follows: + +- In a non-roaming case, i.e. when the 3GPP AAA Server receives the request directly and not via the 3GPP AAA Proxy, checking ANID is mandatory; +- In a roaming case when the request is received via an 3GPP AAA proxy, checking ANID is optional. The 3GPP AAA Server may decide to check ANID based on local configuration, e.g. depending on the received visited network identifier. + +- If the checking result shows that the included ANID value is not valid (not defined by 3GPP) or that the requesting entity is not entitled to use the received ANID value, the Result-Code shall be set to DIAMETER\_UNABLE\_TO\_COMPLY. + +The 3GPP AAA Server shall check if user data exists in the 3GPP AAA Server (containing valid authentication information for the current access network identity). If not, the 3GPP AAA Server shall use the procedures defined in SWx interface to obtain access authentication and authorization data. + +If IMEI check is required by operator policy and the TWAN is in the HPLMN, the 3GPP AAA Server shall: + +- retrieve the IMEI(SV) from the UE as specified in 3GPP TS 23.402 [26]; +- if the IMEI(SV) is available, check the Mobile Equipment's identity status towards the EIR, using the ME Identity Check procedure (see clause 11); + - upon getting the IMEI check result from the EIR, determine whether to continue or stop the authentication and authorization procedure; +- if the IMEI(SV) is not available, determine whether to continue or stop the authentication and authorization procedure based on operator policy; +- if the 3GPP AAA Server determines that the authentication and authorization procedure shall be stopped, it shall: + - notify the UE that the Mobile Equipment used is not acceptable to the network (e.g. blacklisted), as specified in 3GPP TS 24.302 [26]; + - respond to the TWAN with the Experimental-Result-Code DIAMETER\_ERROR\_ILLEGAL\_EQUIPMENT. + +Specific operator policies may be configured for emergency services, regarding whether to check the IMEI and, if the IMEI needs to be checked, whether to continue or stop the authentication and authorization procedure upon getting the IMEI check result or when the IMEI(SV) is not available. + +If the IMEI-Check-Required-In-VPLMN bit is set in the DER-Flags AVP of the first Authentication and Authorization Request message and the TWAN is in the VPLMN, the 3GPP AAA Server shall: + +- retrieve the IMEI(SV) from the UE as specified in 3GPP TS 23.402 [26]; +- request the VPLMN to check the IMEI, by setting the IMEI-Check-Request-In-VPLMN bit in the DEA-Flags AVP and including the IMEI(SV) if available in the DEA message; +- upon getting the IMEI-Check-In-VPLMN-Result AVP in the subsequent DER message, if the IMEI check failed in the VPLMN: + - notify the UE that the Mobile Equipment used is not acceptable to the network (e.g. blacklisted), as specified in 3GPP TS 24.302 [26]; + - respond to the TWAN with the Experimental-Result-Code DIAMETER\_ERROR\_ILLEGAL\_EQUIPMENT. + +See Annex A.2.3 and A.3.2. + +If the 3GPP AAA Server receives a request message not related to any existing session and is able to recognize that the non-3GPP access network included the AAA-Failure-Indication AVP in the request, the 3GPP AAA Server shall also include the AAA-Failure-Indication AVP over the SWx interface, while retrieving the access authentication and authorization data from the HSS. + +If SWx authentication response indicates that: + +- The user does not exist, then the 3GPP AAA Server shall respond the non-3GPP access network with Experimental-Result-Code DIAMETER\_ERROR\_USER\_UNKNOWN. +- The user does not have non-3GPP access subscription, then 3GPP AAA Server shall respond the non-3GPP access network with Experimental-Result-Code DIAMETER\_ERROR\_USER\_NO\_NON\_3GPP\_SUBSCRIPTION. +- The user is not allowed to roam in the visited network, then 3GPP AAA Server shall respond the non-3GPP access network with Experimental-Result-Code DIAMETER\_ERROR\_ROAMING\_NOT\_ALLOWED. + +- The user is currently being served by a different 3GPP AAA Server, then the 3GPP AAA Server shall respond to the non-3GPP access network with the Result-Code set to DIAMETER\_REDIRECT\_INDICATION and the Redirect-Host set to the Diameter URI of the 3GPP AAA Server currently serving the user (this Diameter URI shall be constructed based on the Diameter Identity included in the 3GPP-AAA-Server-Name AVP returned in the SWx authentication response from the HSS). +- The user is not allowed to use the current access type, then the 3GPP AAA Server shall respond to the non-3GPP access network with Experimental-Result-Code DIAMETER\_ERROR\_RAT\_TYPE\_NOT\_ALLOWED. +- Any other error occurred, then the error code DIAMETER\_UNABLE\_TO\_COMPLY shall be returned to the non-3GPP access network. + +When SWx authentication response includes the requested authentication information, the 3GPP AAA Server shall proceed with the authentication and authorization procedure. The 3GPP AAA Server shall use the procedures defined in SWx interface to obtain the user's subscription profile from HSS. + +Before sending out the authentication challenge, the 3GPP AAA Server shall decide, whether the access network is handled as Trusted or Untrusted. The 3GPP AAA Server shall make the decision based on the Access Network Identifier and Visited Network Identity information elements, according to its local policies. The local policies of the 3GPP AAA Server shall be based on the security criteria described in 3GPP TS 33.402 [19]. + +NOTE 1: The network operator can configure this e.g. according to the roaming agreements with the non-3GPP AN operator or with VPLMN operator. + +In a roaming case, if the 3GPP AAA Server has received the trust relationship indicator from the VPLMN (AN-Trusted AVP), the 3GPP AAA Server may use this information as input parameter to the trusted/untrusted evaluation. + +The VPLMN trust relationship indicator may be utilized only if the appropriate trust relationship exists between the HPLMN and VPLMN operators. + +Based on the trusted/untrusted decision, the 3GPP AAA Server may send a trust relationship indication to the UE, as described in 3GPP TS 24.302 [26]. + +The 3GPP AAA Server shall indicate the trust relationship assessment of the non-3GPP access network to the UE in the AT\_TRUST\_IND attribute (in the EAP-Request/AKA'-Challenge) as defined in 3GPP TS 24.302 [26]. The 3GPP AAA Server shall also indicate the trust relationship assessment to the non-3GPP access network using AN-Trusted AVP in the DEA command. + +If the decision is "Trusted", the STa authentication and authorization procedure is executed as described here, in clause 5.1.2.1 and its clauses. Otherwise, the SWa authentication and authorization procedure is executed as described in clause 4.1.2.1. + +The 3GPP AAA Server marks the trust relationship as "trusted" with the User Identity. If the 3GPP AAA Server detects that an S6b session already exists for the corresponding UE and the S6b session was established as a result of an authentication request for DSMIPv6, the 3GPP AAA Server shall send the trust relationship to the PDN GW as specified in clause 9.1.2.5. + +The 3GPP AAA Server shall run EAP-AKA' authentication as specified in 3GPP TS 33.402 [19]. Exceptions shall be treated as error situations and the result code shall be set to DIAMETER\_UNABLE\_TO\_COMPLY. + +Once authentication is successfully completed, the 3GPP AAA Server shall perform the following authorization checking (if there is an error in any of the steps, the 3GPP AAA Server shall stop processing and return the corresponding error): + +- 1) Check if the user is barred to use the non 3GPP Access. If it is so, then the Result-Code shall be set to DIAMETER\_AUTHORIZATION\_REJECTED +- 2) Check the access type. If the received access type is listed in the user's disallowed RAT-Types, this shall be treated as error and the Experimental-Result-Code DIAMETER\_ERROR\_RAT\_TYPE\_NOT\_ALLOWED shall be returned. + +The following steps are only executed if the non-3GPP access network was decided to be Trusted. + +- 3) If the APN Id IE is present in the request, check if the user has a subscription for the requested APN or for the wildcard APN. If not, Experimental-Result-Code shall be set to DIAMETER\_ERROR\_USER\_NO\_APN\_SUBSCRIPTION + - 4) for a trusted WLAN access (i.e. ANID in the request indicates WLAN, see clause 8.1.1.2 of 3GPP TS 24.302 [26]), check if the user is authorized to access to EPC via S2a and/or non-seamless WLAN offload via the selected WLAN: + - if no TWAN-Access-Info AVP was received from the HSS in the user's subscription, the 3GPP AAA Server shall consider that access to EPC and non-seamless WLAN Offload is authorized; + - if one or more TWAN-Access-Info AVP(s) was received from the HSS in the user's subscription: + - if the TWAN has signalled the selected Trusted WLAN in the request and the selected Trusted WLAN identifier contains only the SSID of the selected WLAN, the 3GPP AAA Server shall authorize the access methods allowed by the TWAN-Access-Info AVP explicitly matching the selected trusted WLAN (i.e. including a WLAN-Identifier AVP with the same SSID and without HESSID information) if any; +- NOTE 2: When the TWAN does not include the HESSID in the request, the authorization information in the 3GPP AAA Server containing both SSID and HESSID is not applicable; therefore, in order to get specific authorization of the UE in this case, the operator needs to define authorization information for the SSID in question (without HESSID), or to rely on the "wildcard" authorization (i.e., a TWAN-Access-Info AVP not including a WLAN-Identifier AVP). +- if the TWAN has signalled the selected Trusted WLAN in the request and the selected Trusted WLAN identifier contains both the SSID and the HESSID of the selected WLAN, the 3GPP AAA Server shall authorize the access methods allowed by the TWAN-Access-Info AVP explicitly matching the selected trusted WLAN (i.e. including a WLAN-Identifier AVP with the same SSID and same HESSID); + + +Else, if no match is found, the 3GPP AAA Server shall authorize the access methods allowed by the TWAN-Access-Info AVP explicitly matching the HESSID of the selected Trusted WLAN identifier (i.e. TWAN-Access-Info including a WLAN-Identifier AVP with the same HESSID and without SSID information); + +Else, if no match is found, the 3GPP AAA Server shall authorize the access methods allowed by the TWAN-Access-Info AVP explicitly matching the SSID of the selected Trusted WLAN identifier (i.e. TWAN-Access-Info including a WLAN-Identifier AVP with the same SSID and without HESSID information) ; + - otherwise, if the selected Trusted WLAN does not match explicitly any of the TWAN-Access-Info or if TWAN has not signalled the selected Trusted WLAN Identifier, the 3GPP AAA Server shall apply the access methods allowed by the "wildcard" TWAN-Access-Info AVP (i.e. TWAN-Access-Info AVP not including a WLAN-Identifier AVP) if any; + - otherwise, if the "wildcard" TWAN-Access-Info is not present, the 3GPP AAA Server shall consider that access to EPC and non-seamless WLAN Offload is not authorized. +- 5) Check if the user is not authorized to perform non-seamless WLAN Offload and, if the user is also barred from using the subscribed APNs, then the Result-Code shall be set to DIAMETER\_AUTHORIZATION\_REJECTED. + - 6) If present, check the flags of the received MIP6-Feature-Vector AVP: + - If the MIP6-INTEGRATED flag is set and the 3GPP AAA Server has authorized DHCP Home Agent assignment, the 3GPP AAA Server shall include the Home Agent addresses in the APN-Configuration AVP in the response and the MIP6-Feature-Vector AVP with the MIP6-INTEGRATED flag set. If the HA assignment via DHCPv6 is not used, the MIP6-Feature-Vector AVP with the MIP6-INTEGRATED flag not set shall be sent. + - The PMIP6\_SUPPORTED and/or GTPv2 SUPPORTED flag indicates to the 3GPP AAA Server whether the trusted non-3GPP access network supports NBM or not. + +As specified in 3GPP TS 23.402 [3], based on the information it has regarding the UE (see 3GPP TS 24.302 [26]), local/home network capabilities and local/home network policies, the 3GPP AAA Server may perform mobility mode selection between NBM and HBM. + +For a trusted WLAN access, if the user is successfully authenticated and authorized for this access, the 3GPP AAA Server may either only authorize the user to access to EPC via S2a (i.e. EPC-routed service only), or only authorize the user to access the TWAN without granting access to EPC via S2a (i.e. non-seamless WLAN offload service only), or authorize both EPC-routed and non-seamless WLAN offload services, taking also into account the subscriber profile, access network, the selected WLAN identifier if present, and the TWAN's non-seamless WLAN offload capability if present, and the authorized mode of operation (TSCM, SCM or MCM). The 3GPP AAA Server may authorize both EPC-routed and non-seamless WLAN offload services only if the MCM is selected, or in non-roaming scenarios if the TSCM is selected; the 3GPP AAA Server shall not authorize both EPC-routed and non-seamless WLAN offload services if the SCM is selected or in roaming scenarios if the TSCM is selected. + +If the 3GPP AAA Server decides that access to EPC is authorized and NBM should be used for such access, the PMIP6\_SUPPORTED and GTPv2\_SUPPORTED flags shall be set in the response to indicate that NBM is authorized for use for the UE by the trusted non 3GPP access network. If only the PMIPv6\_SUPPORTED or the GTPv2\_SUPPORTED flag is present in the response, the trusted non-3GPP access network shall assume that this also indicates that NBM is authorized for use. In addition, for a trusted WLAN access, the Non-seamless WLAN offload Authorization flag shall be set in the DEA-Flags AVP in the response if the non-seamless WLAN offload is authorized. + +If the 3GPP AAA Server decides to only authorize the user to access the TWAN without granting access to EPC S2a (i.e. non-seamless WLAN offload service only), none of the flags (PMIP6\_SUPPORTED, GTPv2\_SUPPORTED, MIP4\_SUPPORTED, MIP6-INTEGRATED, ASSIGN\_LOCAL\_IP) shall be set in the response, i.e. the Mobility Capabilities IE is not sent in the response, and the Non-seamless WLAN offload Authorization flag shall be set in the DEA-Flags AVP in the response. + +If the 3GPP AAA Server decides that a local IP address should be assigned for HBM, the ASSIGN\_LOCAL\_IP flag shall be set in the response to indicate to the trusted non 3GPP access network that a local IP address (for HBM) should be assigned. + +The 3GPP AAA Server shall not set the PMIP6\_SUPPORTED/GTPv2\_SUPPORTED and ASSIGN\_LOCAL\_IP flags both at the same time in the response. + +- The MIP4\_SUPPORTED flag indicates to the 3GPP AAA Server whether the trusted non-3GPP access network supports MIPv4 FA-CoA mode or not. As specified in 3GPP TS 23.402 [3], based on the information it has regarding the UE (see 3GPP TS 24.302 [26]), local/home network capabilities and local/home network policies, the 3GPP AAA Server may perform mobility mode selection. If the 3GPP AAA Server decides that MIPv4 FA-CoA mode should be used, the MIP4\_SUPPORTED flag shall be set in the response. + +NOTE 3: When selecting DSMIPv6 the AAA server assumes that the trusted non 3GPP access gateway has the capability to assign a local IP address to the UE. + +For Trusted WLAN access, the 3GPP AAA Server shall select the TWAN connection mode, i.e. either TSCM, SCM or MCM, taking into account the modes supported by the TWAN (as reported in the first DER message), those supported by the UE (as reported in the EAP payload, see 3GPP TS 24.302 [26]) and operator policy. The 3GPP AAA Server shall then indicate to the TWAN the TWAN connection mode it has selected, either explicitly using the Selected TWAN Connection Mode IE if it has selected SCM or MCM, or implicitly by not including the Selected TWAN Connection Mode IE if it has selected TSCM. + +For Trusted WLAN access, if the 3GPP AAA Server has determined that the EAP-AKA' authentication is correct (i.e., the UE has sent a valid EAP-AKA' challenge response) and if the 3GPP AAA Server authorizes the SCM to be used for EPC access, the 3GPP AAA Server shall reply to the first DER message it receives with a result code set to DIAMETER\_MULTI\_ROUND\_AUTH, leave the EAP-Payload AVP absent in the reply, and set the TWAN-S2a-Connectivity-Indicator bit to 1 in the DEA-Flags AVP; it shall also include in the response command all subscription-related parameters for the user, so the TWAN is able to proceed with the setup of the required S2a network connectivity (e.g., establishment of the GTP tunnel). After receiving a subsequent DER command from the TWAN, the 3GPP AAA Server shall check if the TWAN-S2a-Connectivity-Indicator is set, and if so, it may disregard the received EAP-Payload, since the EAP-AKA' challenge response has been already successfully checked. If the TWAN could not provide the requested S2a network connectivity and included a Session Management back-off timer in the DER command, the 3GPP AAA Server shall instruct the UE to not request new PDN connectivity to the same APN for the indicated time as specified in 3GPP TS 24.302 [26]. See Annex A. + +Once the Authentication and Authorization procedure successfully finishes, the 3GPP AAA Server shall download, the authentication data, the list of authorized APN's if the UE did not indicate an Emergency Attach in EAP-AKA' signalling (see 3GPP TS 24.302 [26]), and the authorized mobility protocols in the authentication and authorization response from the HSS (see SWx procedure in Clause 8.1.2.1). If the Access Network Identity received in the Authentication and Authorization Request indicates WLAN (see clause 8.1.1.2 of 3GPP TS 24.302 [26]) and if the TSCM is selected, the 3GPP AAA Server shall set the Default APN in the Authentication and Authorization Answer to the Default APN for Trusted WLAN if received from the HSS, otherwise to the subscriber's Default APN for 3GPP and other non-3GPP accesses. + +For a trusted WLAN access, if the user is authorized to access to EPC via S2a, and/or non-seamless WLAN offload via the selected WLAN, the 3GPP AAA Server shall send the user's Mobile Equipment Identity to the TWAN, if this information is available. + +Once the Authentication and Authorization procedures successfully finish and if MIPv4 FACoA mode is used the 3GPP AAA Server shall calculate the MIPv4 FACoA mobility security parameters as defined in 3GPP TS 33.402 [19] and include these in the authentication and authorization response to the trusted non 3GPP access network. + +Exceptions to the cases specified here shall be treated by 3GPP AAA Server as error situations, the Result-Code shall be set to DIAMETER\_UNABLE\_TO\_COMPLY and, therefore, no authorization information shall be returned. + +For Fixed Broadband access network, the 3GPP AAA Server shall determine if the UE is connected via a BBF-defined WLAN access according to the Transport-Access-type AVP. If the UE is connected via a BBF-defined WLAN access, the 3GPP AAA Server shall perform the enabling of the UE reflective QoS function as specified in 3GPP TS 24.139 [43]. + +NOTE 4: This behaviour is applicable for both fixed broadband access interworking and the fixed broadband access convergence. The architecture of fixed broadband access interworking is specified in 3GPP TS 23.139 [39]. The architecture of the fixed broadband access convergence is specified in 3GPP TS 23.203 [45]. + +If the 3GPP AAA Server supports IMS Emergency sessions over WLAN (see clause 4.5.7.2 of 3GPP TS 23.402 [3]), the 3GPP AAA Server shall proceed as specified above, but with the following modifications, for an Emergency Attach: + +- 1) The 3GPP AAA Server shall reject the Authentication and Authorization Request and set the result code to DIAMETER\_UNABLE\_TO\_COMPLY if the TWAN does not indicate support of IMS Emergency sessions in the DER-Flags AVP in the request. +- 2) If the UE does not have an IMSI: + - if local policies allow emergency sessions for all UEs, the 3GPP AAA Server shall skip the procedures defined for the SWx interface to obtain access authentication and authorization data, shall skip the authorization checkings and shall authorize the UE to access to EPC for emergency services. The Permanent User Identity IE in the answer shall contain the IMEI in Emergency NAI for Limited Service State format as defined in clause 19 of 3GPP TS 23.003 [14]; + - otherwise the 3GPP AAA Server shall reject the request with the Experimental-Result-Code set to DIAMETER\_ERROR\_USER\_UNKNOWN. +- 3) If the UE has an IMSI but the IMSI is not authenticated: + - if local policies allow emergency sessions for unauthenticated UEs with an IMSI, the 3GPP AAA Server shall skip the procedures defined for the SWx interface to obtain access authorization data, shall skip the authorization checkings, shall request the UE to provide its IMEI as specified in clause 13.4 of 3GPP TS 33.402 [19] and shall authorize the UE to access to EPC for emergency services. The Permanent User Identity IE in the answer shall contain the IMEI in Emergency NAI for Limited Service State format as defined in clause 19 of 3GPP TS 23.003 [14]; + - otherwise the 3GPP AAA Server shall reject the request with the Experimental-Result-Code set as specified for authentication failures in this clause. +- 4) If the UE has an authenticated IMSI but the UE is not authorized to access the EPC: + - if local policies allow emergency sessions for any authenticated UE, the 3GPP AAA Server shall authorize the UE to access to EPC for emergency services; + +- otherwise the 3GPP AAA Server shall reject the request with the Experimental-Result-Code set as specified for authorization failures in this clause. +- 5) When authorizing a UE to access to EPC for emergency services, the 3GPP AAA Server: +- shall set the Emergency-Indication bit of the Emergency-Services IE in the answer; + - shall not allow the use of non-seamless WLAN offload services. + +In addition, if the 3GPP AAA Server supports IMS Emergency sessions over WLAN (see clause 4.5.7.2 of 3GPP TS 23.402 [3]), the 3GPP AAA Server shall also include the Emergency Info IE in the Authentication and Authorization Answer, for emergency and non-emergency Attach, if this information was received from the HSS, the user is not roaming, the TWAN indicated support of IMS Emergency sessions and the Result-Code AVP is set to either: + +- DIAMETER\_SUCCESS or +- DIAMETER\_MULTI\_ROUND\_AUTH and TWAN-S2a-Connectivity-Indicator is set in DEA-Flags. + +Once the Authentication and Authorization procedures successfully finish, if a domain-specific re-authentication key was requested and the use of ERP is authorized for this user based on subscription parameter, the 3GPP AAA Server which support ERP shall derive the DSRK from the EMSK and the domain name received in the request as specified in IETF RFC 6696[55] and shall include the DSRK, the EMSKName, and optionally the DSRK lifetime in the authentication and authorization response to the non-3GPP access network. + +Otherwise, when the 3GPP AAA Server does not support ERP, the domain-specific re-authentication key request is ignored if present in the authentication and authorization request. + +#### 5.1.2.1.3 3GPP AAA Proxy Detailed Behaviour + +The 3GPP AAA Proxy is required to handle roaming cases in which the non-3GPP access network is connected to a VPLMN. The 3GPP AAA Proxy shall act as a stateful proxy, with the following additions. + +If IMEI check is required by operator policy and the TWAN is in the VPLMN, the 3GPP AAA Proxy shall: + +- set the IMEI-Check-Required-In-VPLMN bit in the first Authentication and Authorization Request message sent to the 3GPP AAA Server; +- upon receipt of a subsequent DER message with the IMEI-Check-Request-in-VPLMN bit set to 1 in the DER-Flags AVP, + - if the IMEI(SV) is available, check the Mobile Equipment's identity status towards the EIR, using the ME Identity Check procedure (see clause 11); + - upon getting the IMEI check result from the EIR, determine whether to continue or stop the authentication and authorization procedure; + - if the IMEI(SV) is not available, determine whether to continue or stop the authentication and authorization procedure based on operator policy; + - send the result of the IMEI check to the 3GPP Server in the IMEI-Check-In- VPLMN-Result AVP. + +Specific operator policies may be configured for emergency services, regarding whether to check the IMEI and, if the IMEI needs to be checked, whether to continue or stop the authentication and authorization procedure upon getting the IMEI check result or when the IMEI(SV) is not available. + +See Annex A.2.3 and A.3.2. + +On receipt of an authentication and authorization request, the 3GPP AAA Proxy + +- shall check the Visited-Network-Identifier AVP, + - If the AVP is not present, the 3GPP AAA Proxy shall insert it before forwarding the request to the 3GPP AAA Server. + +- If the AVP is present, the 3GPP AAA Proxy may check and overwrite its value, depending on its local policy, e.g. the trusted non-3GPP access network is being operated by the VPLMN operator or by a third party. +- shall check the ANID AVP. If the result of the checking shows that the included ANID value is not valid (not defined by 3GPP) or that the requesting entity is not entitled to use the received value, the Result-Code shall be set to DIAMETER\_UNABLE\_TO\_COMPLY and the authentication response shall be sent to the trusted non-3GPP access network. +- may take a decision about the trustworthiness of the non-3GPP access from VPLMN's point of view. If such decision is taken, it shall be based on the Access Network Identifier and optionally, on further information about the non-3GPP access network, according to the 3GPP AAA Proxy's local policies. These local policies shall reflect the security criteria described in 3GPP TS 33.402 [19], with the assumption that the PDN GW will be allocated in the VPLMN. + +NOTE 1: For example, if hop-by-hop security relationship exists between the NAS and the 3GPP AAA Proxy, the 3GPP AAA Proxy may use the Origin-Host AVP to uniquely identify the NAS and the access network. + +The decision about the trustworthiness of the non-3GPP access network is encoded to the VPLMN trust relationship indicator that is inserted to the authentication and authorization request. + +On receipt of the first authentication and authorization request, the 3GPP AAA Proxy shall check locally configured information whether users from the HPLMN are allowed to activate a PDN connection from the non-3GPP access network via this (V)PLMN. If not, the Experimental-Result-Code shall be set to DIAMETER\_ERROR\_ROAMING\_NOT\_ALLOWED and the authentication and authorization response shall be sent to the non-3GPP access network. + +NOTE 2: It is assumed that there is a roaming agreement between the non-3GPP access network and the VPLMN. + +On receipt of the first authentication and authorization request, a 3GPP AAA Proxy which supports ERP may check whether ERP is supported by the non-3GPP access network. If the non-3GPP access network supports ERP and there is an ER server requesting a domain-specific re-authentication key in the authentication and authorization request, the 3GPP AAA Proxy may not authorize it based on locally configured information, remove the domain-specific key request before forwarding the request. If the non-3GPP access network supports ERP and there is no ER server in the non-3GPP access network or if the ER server in the non-3GPP access network was not authorized based on locally configured information, the 3GPP AAA Proxy may act as ER server and include the domain-specific re-authentication key request into the first authentication and authorization request forwarded to the 3GPP AAA server. + +On receipt of the authentication and authorization answer that completes a successful authentication, the 3GPP AAA Proxy + +- may check locally configured information about using the chained S8-S2a option towards the given HPLMN. If chaining is required, the 3GPP AAA Proxy shall select a Serving GW from its network configuration database and shall include the Serving GW address in the answer. +- shall check locally configured information for the maximum allowed static QoS parameters valid for visitors from the given HPLMN and modify the QoS parameters received from the 3GPP AAA Server, to enforce the policy limitations. +- shall record the state of the connection (i.e. Authentication and Authorization Successful). +- may check if ERP keying material is provided in the answer in response to the domain-specific re-authentication key requested by the 3GPP AAA Proxy acting as an ER server. If it is, the 3GPP AAA Proxy shall remove the ERP keying material from the answer forwarded to the non-3GPP access network and store the DSRK, the EMSKName and the DSRK lifetime. If there is no ERP keying material and the DEA-Flag does not indicate that ERP is supported by the 3GPP AAA Server, the 3GPP AAA Proxy shall not forward any ERP related messages to the 3GPP AAA Server. +- shall forward the ERP keying material to the TWAN if received from the 3GPP AAA Server and the ER server is located in the TWAN. + +#### 5.1.2.1.4 Trusted non-3GPP access network Detailed Behaviour + +The Trusted non-3GPP access network shall initiate the Trusted non-3GPP Access Authentication and Authorization procedure when the user attaches to the access network. During the authentication, it shall act as a pass-through EAP authenticator. + +If the IMEI-Check-Request-In-VPLMN bit is set in the DEA-Flags AVP of the DEA message, the TWAN shall request the 3GPP AAA Proxy to check the IMEI, by setting the IMEI-Check-Request-In-VPLMN bit in the DER-Flags AVP and including the IMEI(SV) in the DER message. See Annex A.2.3 and A.3.2. + +If PMIPv6, GTPv2 or MIPv4 FACoA is used, at successful completion of the procedure, the trusted non-3GPP access network shall store the non-3GPP user data received from the 3GPP AAA Server. The trusted non-3GPP access network shall utilize these data + +- To authorize the APNs received in PDN connection creation request from the UE; +- To authorize the requested home address types: IPv4 home address and/or IPv6 home network prefix; +- To check if the UE requested APN is authorized as such or based on the wildcard APN. + +NOTE: The user will be allowed to create PDN connections only to the subscribed APNs and use the address types that are allowed by the subscribed PDN types. + +If DSMIPv6 is used and if the trusted non-3GPP access network has received the PGW identity in form of the FQDN from the 3GPP AAA Server, then the trusted non-3GPP access network may obtain the IP address of the Home Agent functionality of that PGW as described in 3GPP TS 29.303 [34]. + +If MIPv4 FACoA is used and if the non-3GPP access network has received FA-RK-SPI and FA-RK from the 3GPP AAA Server, the trusted non-3GPP access network will use FA-RK key and FA-RK-SPI to further derive MN-FA shared key and MN-FA-SPI, as defined in 3GPP TS 33.402 [19]. These are used to process the MN-FA Authentication Extension in the RRQ/RRP messages if the extension is present. + +If the subscriber is not roaming and the SIPTO-Permission information for an APN is present, the HSGW shall allow SIPTO for that APN only if the SIPTO-Permission information indicates so. If the subscriber is not roaming and the SIPTO-Permission information for an APN is not present, the HSGW may allow SIPTO for that APN. If the subscriber is roaming and the SIPTO-Permission information for an APN is present, the HSGW shall allow SIPTO for that APN only if the SIPTO-Permission information indicates so and the VPLMN Dynamic Address is allowed and the HSGW selects a PDN GW in the VPLMN. For the requested APN allowed for SIPTO, the trusted non-3GPP access network may use the 3GPP DNS mechanism to select a PGW which is close to the HSGW. Detailed behaviour is specified in 3GPP2 X.S0057 [25], 3GPP TS 23.402 [3] and 3GPP TS 29.303 [34]. + +For optimized handover of an emergency session from E-UTRAN to an S2a based cdma2000® HRPD access network, if the trusted non-3GPP access network supports Emergency services for users in limited service state, then the trusted non-3GPP access network shall skip the authentication procedure (for users without an IMSI or with an IMSI marked as unauthenticated); or if the trusted non-3GPP access network accepts that the authentication may fail (for users with an IMSI), it shall continue with the procedure. For these cases, the Trusted non-3GPP access network shall release any non-emergency PDN connections. + +The TWAN decides the S2a protocol variant to use if access to EPC is authorized and the TWAN decides to establish S2a. The TWAN may be configured with the S2a protocol variant(s) on a per PLMN granularity, or may retrieve information regarding the S2a protocol variants supported by the PDN GW (PMIPv6 or/and GTPv2) from the Domain Name Service Function as described in 3GPP TS 29.303[34]. For static PDN GW assignment, in order to determine the PLMN of the PDN GW, the TWAN may use the Visited Network Identifier, if received from the 3GPP AAA Server, or the FQDN of the PDN GW, if included in the MIPv6-Agent-Info AVP of the APN in use; if none of them are available, it may use the PLMN where the 3GPP AAA Server is located. If the TWAN supports Dedicated Core Networks and receives the UE-Usage-Type from the 3GPP AAA Server, the TWAN shall select the PGW as specified in clause 5.8 of 3GPP TS 29.303 [34]. + +For Trusted WLAN access, the TWAN should attempt the establishment of the S2a connectivity if the 3GPP AAA Server authorizes the SCM to be used for EPC access and the 3GPP AAA Server answers the authentication request with a result code of DIAMETER\_MULTI\_ROUND\_AUTH and with the TWAN-S2a-Connectivity-Indicator bit set to 1 in the DEA-Flags AVP. After completing the S2a network connectivity actions, the TWAN shall re-issue a new DER command including the last EAP-Payload sent in a former request, and setting the TWAN-S2a-Connectivity-Indicator bit to 1 in the DER-Flags AVP. If the requested connectivity has been granted, the TWAN shall also provide the 3GPP + +AAA Server with the connectivity parameters provided to the UE; otherwise, the TWAN should also provide a cause indicating why the requested connectivity could not be granted and may provide a Session Management back-off timer to be sent to the UE to instruct the UE to not request new PDN connectivity to the same APN for the indicated time. + +If GTPv2 is used on S2a and if the Trace-Info AVP including Trace-Data has been received in the authorization response, the trusted non-3GPP access network shall send a GTPv2 Trace Session Activation message (see 3GPP TS 29.274 [38]) to the PGW to start a trace session for the user. + +If the Trusted non-3GPP access network determines that a previously assigned 3GPP AAA Server is unavailable, it may attempt to send a new authentication and authorization request to an alternate 3GPP AAA Server. If the Trusted non-3GPP access network receives from this new server a redirect indication towards the former server (due to the HSS having stored the former 3GPP AAA Server identity), it shall terminate all previously existing sessions and PDN connections for that user, and it shall re-send again the request towards the new server, but it shall include the AAA-Failure-Indication AVP in the new request. + +If the TWAN supports IMS Emergency sessions over WLAN (see clause 4.5.7.2 of 3GPP TS 23.402 [3]), the TWAN shall: + +- set the Emergency-Capability-Indication bit in the DER-Flags AVP to indicate support of IMS emergency sessions to the 3GPP AAA Server (to be forwarded to the UE via EAP-AKA' signalling). +- interpret the receipt of an Emergency NAI for Limited Service State or an IMSI-based Emergency NAI from the UE, or the Emergency-Services AVP from the 3GPP AAA Server, with the Emergency-Indication bit set, as an indication that the UE requests to access the EPC for emergency services; +- give preferential treatment to UEs which access the EPC for emergency services, e.g. in scenarios including network overload; +- use its Emergency Configuration Data to determine the APN to be associated with the emergency PDN connection and possibly the PGW to use; +- use the PGW identified in the Emergency PGW Identity IE, during a handover of an emergency PDN connection to a trusted WLAN access, if this information is received from the 3GPP AAA Server, the user is a non-roaming authenticated user and the TWAN is configured to use a dynamic PGW for emergency services for such users; +- proceed during an Emergency Attach for a UE without a UICC or with an authenticated IMSI as specified above with the following modifications, if local policies (related with local regulations) in the TWAN allows unauthenticated emergency sessions: + - if the UE is UICC-less, the User Identity IE in the Authentication and Authorization Request shall contain the IMEI in Emergency NAI for Limited Service State format as defined in clause 19 of 3GPP TS 23.003 [14]; + - if the Permanent User Identity IE in the answer contains an IMEI based NAI but the User Identity IE in the request did not contain an IMEI based NAI, the TWAN shall determine that the IMSI was not authenticated and proceed accordingly with the setup of the Emergency PDN connection over S2b (see 3GPP TS 29.274 [38]). + +## 5.1.2.2 HSS/AAA Initiated Detach on STa + +### 5.1.2.2.1 General + +This procedure is used between the 3GPP AAA/HSS and the trusted non-3GPP access network to instruct the non-3GPP access network to detach a specific user from the access network. The procedure is based on Diameter session abort messages. + +Diameter usage over the STa interface: + +- This procedure is mapped to the Diameter command codes Diameter-Abort-Session-Request (ASR), Diameter-Abort-Session-Answer (ASA), Diameter-Session-Termination-Request (STR) and Diameter-Session-Termination-Answer (STA) specified in IETF RFC 6733 [58]. Information element contents for these messages are shown in tables 5.1.2.2.1/1 and 5.1.2.2.1/2. +- The STa application id value of 16777250 shall be used as the Application Id in ASR/ASA/STR/STA commands. + +**Table 5.1.2.2.1/1: Information Elements passed in ASR message** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Permanent User Identity | User-Name | M | This information element shall contain the permanent identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4822 [15], and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]. If this IE contains an identity based on IMSI, this IE shall not include the leading digit prepended in front of the IMSI used to differentiate between authentication schemes. | +| Auth-Session-State | Auth-Session-State | O | If present this information element shall indicate to the Non-3GPP access network whether the 3GPP AAA Server requires an STR message. | + +**Table 5.1.2.2.1/2: Information Elements passed in ASA message** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-------------------------|------|-----------------------------------------------------| +| Result-Code | Result-Code | M | This IE shall indicate the result of the operation. | + +**Table 5.1.2.2.1/3: Information Elements passed in STR message** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-------------------------|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Termination-Cause | Termination-Cause | M | This information element shall contain the reason why the session was terminated. It shall be set to "DIAMETER_ADMINISTRATIVE" to indicate that the session was terminated in response to an ASR message. | + +**Table 5.1.2.2.1/4: Information Elements passed in STA message** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-------------------------|------|----------------------------------------------------| +| Result-Code | Result-Code | M | This IE shall contain the result of the operation. | + +## 5.1.2.2.2 3GPP AAA Server Detailed Behaviour + +The 3GPP AAA Server shall make use of this procedure to instruct the Non-3GPP access network to detach a specific user from the access network. + +In the DSMIPv6 case, the 3GPP AAA Server shall initiate first the detach procedure over the S6b reference point towards the PDN GW. When this process has finalized, the 3GPP AAA Server can initiate the detach procedure of the UE from the non-3GPP access network. + +The 3GPP AAA Server shall include the Auth-Session-State AVP in the ASR command with a value of NO\_STATE\_MAINTAINED if it does not require a STR from the Non-3GPP access network. If it does require a STR from the Non-3GPP access network, the 3GPP AAA Server shall either omit the Auth-Session-State AVP from the ASR command or include the Auth-Session-State AVP in the ASR command with a value of STATE\_MAINTAINED. + +On receipt of the ASR command, the Non-3GPP access network shall check if the user is known in the Non-3GPP access network. If not, Experimental-Result-Code shall be set to DIAMETER\_ERROR\_USER\_UNKNOWN. + +If the user is known, the Non-3GPP access network shall perform the disconnection of all the PDN connections active for this user and remove any stored user information, except for emergency PDN connections which shall remain active, if the trusted Non-3GPP access supports Emergency services for users in limited service state. + +The Non-3GPP access network shall set the Result-Code to DIAMETER\_SUCCESS and send back the ASA command to the 3GPP AAA Server, which shall update the status of the subscriber on the detached access network. + +If required by the 3GPP AAA Server, the Non-3GPP access network shall send an STR with the Termination-Cause set to DIAMETER\_ADMINISTRATIVE. The 3GPP AAA Server shall set the Result-Code to DIAMETER\_SUCCESS and return the STA command to the Non-3GPP access network. + +### 5.1.2.2.3 3GPP AAA Proxy Detailed Behaviour + +When the 3GPP AAA Proxy receives the ASR from the 3GPP AAA Server it shall route the request to the non-3GPP access network. + +If the 3GPP AAA Proxy requires an STR but the 3GPP AAA Server does not, the 3GPP AAA Proxy may override the value of the Auth-Session-State AVP in the ASR and set it to STATE\_MAINTAINED. In this case, the 3GPP AAA Proxy shall not forward the STR received from the non-3GPP access network onto the 3GPP AAA Server and shall return an STA command to the non-3GPP access network with the Result-Code set to DIAMETER\_SUCCESS. The 3GPP AAA Proxy shall not override the value of the Auth-Session-State AVP under any other circumstances. + +On receipt of the ASA message with Diameter Result Code set to DIAMETER\_SUCCESS, the 3GPP AAA Proxy shall route the successful response to the 3GPP AAA Server and shall release the resources associated with the session. + +When the 3GPP AAA Proxy receives the STR from the Non-3GPP access network, it shall route the request to the 3GPP AAA Server. On receipt of the STA message, the 3GPP AAA Proxy shall route the response to the Non-3GPP access network. + +## 5.1.2.3 STa Re-Authorization and Re-Authentication Procedures + +### 5.1.2.3.1 General + +The STa Re-Authorization procedure shall be used between the 3GPP AAA Server and the trusted non-3GPP access network for enabling: + +- the 3GPP AAA Server to modify the previously provided authorization parameters. This may happen due to a modification of the subscriber profile in the HSS (for example, removal of a specific APN associated with the subscriber, or change of the identity of a dynamically allocated PDN GW, or change of the identity of a dynamically allocated PDN GW for emergency services, see clause 8.1.2.3). In this case, this procedure is performed in two steps: + - The 3GPP AAA server shall issue an STa Re-Auth request towards the trusted non-3GPP access network. Upon receipt of such a request, the trusted non-3GPP access network shall respond to the request and shall indicate the disposition of the request. This procedure is mapped to the Diameter command Re-Auth-Request and Re-Auth-Answer specified in IETF RFC 6733 [58]. Information element contents for these messages are shown in tables 5.1.2.3.1/1 and 5.1.2.3.1/2. + - Upon receiving the STa Re-Auth request, the non-3GPP access network shall immediately invoke the STa access authorization procedure, based on the reuse of the Diameter command codes AA-Request and AA-Answer commands specified in IETF RFC 4005 [4]. Information element contents for these messages are shown in tables 5.1.2.3.1/3 and 5.1.2.3.1/4. +- the trusted non-3GPP access network to retrieve the subscriber profile from the HSS. This procedure may be initiated at any time by the Trusted non-3GPP access network for check if there is any modification in the user authorization parameters previously provided by the 3GPP AAA Server. In this one-step procedure, the trusted non-3GPP access network shall invoke the STa access authorization procedure, based on the reuse of the Diameter commands AA-Request and AA-Answer commands IETF RFC 4005 [4]. Information element contents for these messages are shown in tables 5.1.2.3.1/3 and 5.1.2.3.1/4. + +After receiving the authorization answer, the trusted non-3GPP access network will release the active PDN connections, for which the authorization has been revoked. If the authorization was rejected by the 3GPP AAA server (e.g. because the user's subscription for non-3GPP accesses has been terminated), the non-3GPP access network shall detach the user from the non-3GPP access network and release all resources. If an emergency PDN connection is active and the trusted non-3GPP access supports emergency services for users in limited service state, the non-3GPP access network shall keep the user attached in the non-3GPP access and the emergency PDN connection active. The non-emergency resources shall be released. + +The STa Re-Authentication procedure shall be used between the 3GPP AAA Server and the trusted non-3GPP access network for re-authenticating the user. This procedure may be initiated at any time by the 3GPP AAA Server based on HPLMN operator policies configured in the 3GPP AAA server. This procedure is performed in two steps: + +- The 3GPP AAA server issues an STa Re-Auth request towards the trusted non-3GPP access. Upon receipt of such a request, the trusted non-3GPP access network shall respond to the request and indicate the disposition of the request. This procedure is mapped to the Diameter command Re-Auth-Request and Re-Auth-Answer specified in IETF RFC 6733 [58]. Information element contents for these messages are shown in tables 5.1.2.3.1/1 and 5.1.2.3.1/2. +- Upon receiving the STa Re-Auth request, the trusted non-3GPP access network shall immediately invoke the STa Access Authentication and Authorization procedure, based on the Re-Auth Request Type provided by the 3GPP AAA server. This procedure is mapped to the Diameter command codes based on the reuse of the Diameter commands Diameter-EAP-Request and Diameter-EAP-Answer specified in IETF RFC 4072 [5]. Information element contents for these messages are shown in tables 5.1.2.3.1/5 and 5.1.2.3.1/6. + +If the re-authentication of the user is not successful, the trusted non-3GPP access network will release all the active PDN connections of the user, except for emergency PDN connections which shall remain active if the trusted non-3GPP access network supports Emergency services for users in limited service state. After a successful authentication and authorization procedure, the trusted non-3GPP access network shall release the active PDN connections for which the authorization has been revoked. + +**Table 5.1.2.3.1/1: STa Re-Auth request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-------------------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Permanent User Identity | User-Name | M | This information element shall contain the permanent identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15] and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]. If this IE contains an identity based on IMSI, this IE shall not include the leading digit prepended in front of the IMSI used to differentiate between authentication schemes. | +| Re-Auth Request Type | Re-Auth-Request-Type | M | This IE shall define whether the user is to be authorized only or authenticated and authorized. In this case, the following values shall be used:
AUTHORIZE_AUTHENTICATE if the re-authentication of the user is requested;
AUTHORIZE_ONLY if the update of the previously provided user authorization parameters is requested. | +| Routing Information | Destination-Host | M | This information element shall be obtained from the Origin-Host AVP, which was included in a previous command received from the trusted non-3GPP access. | + +**Table 5.1.2.3.1/2: STa Re-Auth response** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-----------------------------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Permanent User Identity | User-Name | M | This information element shall contain the permanent identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15] and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]. If this IE contains an identity based on IMSI, this IE shall not include the leading digit prepended in front of the IMSI used to differentiate between authentication schemes. | +| Result | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation. The Result-Code AVP shall be used for errors defined in the Diameter base protocol (see IETF RFC 6733 [58]). The Experimental-Result AVP shall be used for STa errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | + +**Table 5.1.2.3.1/3: STa Authorization Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|----------------------------|-------------------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Permanent User Identity | User-Name | M | This information element shall contain the permanent identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15] and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]. If this IE contains an identity based on IMSI, this IE shall not include the leading digit prepended in front of the IMSI used to differentiate between authentication schemes. | +| Request-Type | Auth-Request-Type | M | This IE shall define whether the user is to be authenticated only, authorized only or both. In this case, it shall have the value: AUTHORIZE_ONLY | +| Mobility Capabilities | MIP6-Feature-Vector | C | This information element shall contain the mobility capabilities of the non-3GPP access network. This AVP shall be included only if optimized idle mode mobility from E-UTRAN to HRPD access is executed. When included, the PMIP_SUPPORTED and the OPTIMIZED_IDLE_MODE_MOBILITY flags shall be set. | +| Routing Information | Destination-Host | M | The 3GPP AAA Server name shall be obtained from the Origin-Host AVP of a previously received message. | +| Access Network Information | Access-Network-Info | O | If present, this IE shall contain the identity and location information of the access network where the UE is attached. | +| Local Time Zone | Local-Time-Zone | O | If present, this IE shall contain the time zone of the location in the access network where the UE is attached. | + +**Table 5.1.2.3.1/4: STa Authorization response** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|-----------------------------|---------------------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Registration Result | Result Code/ Experimental Result Code | M | This IE shall contain the result of the operation.
The Result-Code AVP shall be used for errors defined in the Diameter base protocol (see IETF RFC 6733 [58]).
The Experimental-Result AVP shall be used for STa errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP | +| Request-Type | Auth-Request-Type | M | It shall contain the value AUTHORIZE_ONLY. See IETF RFC 4072 [5]. | +| Session Alive Time | Session-Timeout | O | This AVP may be present if the Result-Code AVP is set to DIAMETER_SUCCESS; if present, it shall contain the maximum number of seconds the user session is allowed to remain active. This AVP is defined in IETF RFC 6733 [58]. | +| Accounting Interim Interval | Acct-Interim-Interval | O | If present, this IE shall contain the Charging duration. | +| Default APN | Context-Identifier | C | This AVP shall indicate the default APN for the user. It shall only be included if NBM is authorized for use, the Emergency-Indication AVP was not present in the initial Authentication and Authorization Answer and the Result-Code AVP is set to DIAMETER_SUCCESS. | +| APN-OI replacement | APN-OI-Replacement | C | This AVP shall indicate the domain name to replace the APN-OI in the non-roaming case or in the home routed roaming case when constructing the PDN GW FQDN upon which it needs to perform a DNS resolution. See 3GPP TS 23.003 [3]. It shall only be included if NBM is authorized for use, the Emergency-Indication bit of the Emergency-Services AVP was not set in the initial Authentication and Authorization Answer and the Result-Code AVP is set to DIAMETER_SUCCESS. | +| APN and PGW Data | APN-Configuration | C | This information element shall only be sent if the Emergency-Indication bit of the Emergency-Services AVP was not set in the initial Authentication and Authorization Answer and the Result-Code AVP is set to DIAMETER_SUCCESS.
When NBM is authorized for use, this AVP shall contain the default APN, the list of authorized APNs, user profile information and PDN GW information. When local IP address assignment is used (for HBM), this AVP shall only be present if DHCP based Home Agent discovery is used and contain the Home Agent Information for discovery purposes.
The Trusted Non-3GPP access network knows if NBM is authorized for use or if a local IP address (for HBM) is assigned based on the flags in the MIP6-Feature-Vector received during the STa access authentication and authorization procedure.
APN-Configuration is a grouped AVP, defined in 3GPP TS 29.272 [29]. When NBM is authorized for use, the following information elements per APN may be included:
  • - APN
  • - APN-AMBR
  • - Authorized 3GPP QoS profile
  • - Statically allocated User IP Address (IPv4 and/or IPv6)
  • - Allowed PDN types (IPv4, IPv6, IPv4v6, IPv4_OR_IPv6)
  • - PDN GW identity
  • - PDN GW allocation type
  • - VPLMN Dynamic Address Allowed
  • - Visited Network Identifier (see clause 5.1.2.1.4)
When DSMIPv6 with HA discovery based on DHCPv6 is used, the following information elements per Home Agent may be included:
  • - HA-APN (Home Agent APN as defined in 3GPP TS 23.003 [14])
  • - Authorized 3GPP QoS profile
  • - PDN GW identity
| +| UE Charging Data | 3GPP-Charging-Characteristics | O | If present, this information element shall contain the type of charging method to be applied to the user (see 3GPP TS 29.061 [31]). | +| UE AMBR | AMBR | C | This Information Element shall contain the modified UE AMBR of the user. It shall be present if the Result-Code AVP is set to DIAMETER_SUCCESS and ANID is "HRPD". | +| Mobility Capabilities | MIP6-Feature-Vector | C | This information element shall only be sent if it has been received in the corresponding authorization request and the Result-Code AVP is set to DIAMETER_SUCCESS.
When included, the PMIP_SUPPORTED and the | + +| | | | | +|-------------------|-----------------|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | OPTIMIZED_IDLE_MODE_MOBILITY flags shall be set. | +| Trace information | Trace-Info | C | This AVP shall be included if the subscriber and equipment trace has been activated for the user in the HSS and signalling based activation is used to download the trace activation from the HSS to the trusted non-3GPP access network.
Only the Trace-Data AVP shall be included to the Trace-Info AVP and shall contain the following AVPs:
- Trace-Reference
- Trace-Depth-List
- Trace-Event-List, for PGW
- Trace-Collection-Entity
The following AVPs may also be included in the Trace-Data AVP:
- Trace-Interface-List, for PGW, if this AVP is not present, trace report generation is requested for all interfaces for PGW listed in 3GPP TS 32.422 [32]
- Trace-NE-Type-List, with the only allowed value being "PDN GW". If this AVP is not included, trace activation in PDN GW is required. | +| MSISDN | Subscription-ID | C | This AVP shall contain the MSISDN of the UE and shall be sent if it is available and the Result-Code AVP is set to DIAMETER_SUCCESS. | +| Emergency Info | Emergency-Info | C | This IE shall contain the identity of the PDN GW dynamically allocated for emergency services. It shall be present for a non-roaming authenticated user, if this information was received from the HSS, the TWAN indicated support of IMS Emergency Sessions and the Result-Code AVP is set to DIAMETER_SUCCESS. | +| UE Usage Type | UE-Usage-Type | C | This IE shall be present if this information is available in the user subscription. When present, this IE shall contain the UE Usage Type of the subscriber. | + +**Table 5.1.2.3.1/5: STa Access Authentication and Authorization Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|-----------------------------|-------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| User Identity | User-Name | M | This information element shall contain the identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15] and it shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]. This IE shall include the leading digit used to differentiate between authentication schemes. | +| EAP payload | EAP-payload | M | This IE shall contain the Encapsulated EAP payload used for the UE – 3GPP AAA Server mutual authentication | +| Authentication Request Type | Auth-Request-Type | M | This IE shall define whether the user is to be authenticated only, authorized only or both. In this case, it shall have the value AUTHORIZE_AUTHENTICATE. | + +**Table 5.1.2.3.1/6: Trusted non-3GPP Access Authentication and Authorization Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|-----------------------------|----------------------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| User Identity | User-Name | M | This information element shall contain the identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15] and it shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]. This IE shall include the leading digit used to differentiate between authentication schemes, if it contains a NAI other than an Emergency NAI for Limited Service State. | +| EAP payload | EAP payload | M | This IE shall contain the Encapsulated EAP payload used for UE-3GPP AAA Server mutual authentication. | +| Authentication Request Type | Auth-Request-Type | M | It shall contain the value AUTHORIZE_AUTHENTICATE. See IETF RFC 4072 [5]. | +| Result code | Result-Code / Experimental Result Code | M | This IE shall contain the result of the operation. Result codes are as in Diameter base protocol (see IETF RFC 6733 [58]). Experimental-Result AVP shall be used for STa errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | +| Session Alive Time | Session-Timeout | O | This AVP may be present if the Result-Code AVP is set to DIAMETER_SUCCESS; if present, it contains the maximum number of seconds the user session is allowed to remain active. This AVP is defined in IETF RFC 6733 [58]. | +| Accounting Interim Interval | Accounting Interim-Interval | O | If present, this IE shall contain the Charging duration. | +| Pairwise Master Key | EAP-Master-Session-Key | C | This IE shall be sent if Result-Code AVP is set to DIAMETER_SUCCESS. | +| Default APN | Context-Identifier | C | This AVP shall indicate the default APN for the user. It shall only be included if NBM is authorized for use, the Emergency-Indication bit of the Emergency-Services AVP was not set in the initial Authentication and Authorization Answer and the Result-Code AVP is set to DIAMETER_SUCCESS. | +| APN-OI replacement | APN-OI-Replacement | C | This AVP shall indicate the domain name to replace the APN-OI in the non-roaming case or in the home routed roaming case when constructing the PDN GW FQDN upon which it needs to perform a DNS resolution. See 3GPP TS 23.003 [3]. It shall only be included if NBM is authorized for use, the Emergency-Indication bit of the Emergency-Services AVP was not set in the initial Authentication and Authorization Answer and the Result-Code AVP is set to DIAMETER_SUCCESS. | + +| | | | | +|-------------------|-------------------------------|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| APN and PGW Data | APN-Configuration | C |

This information element shall only be sent if the non-3GPP access network was decided to be trusted, the Emergency-Indication bit of the Emergency-Services AVP was not set in the initial Authentication and Authorization Answer and the Result-Code AVP is set to DIAMETER_SUCCESS.

When NBM is authorized for use this AVP shall contain the default APN, the list of authorized APNs, user profile information and PDN GW information.

When local IP address assignment is used (for HBM), this AVP shall only be present if DHCP based Home Agent discovery is used and contain the Home Agent Information for discovery purposes.

The trusted non-3GPP access network knows if NBM is authorized for use or if a local IP address (for HBM) is assigned based on the flags in the MIP6-Feature-Vector.

APN-Configuration is a grouped AVP, defined in 3GPP TS 29.272 [29]. When NBM is authorized for use, the following information elements per APN may be included:

  • - APN
  • - APN-AMBR
  • - Authorized 3GPP QoS profile
  • - User IP Address (IPv4 and/or IPv6)
  • - Allowed PDN types (IPv4, IPv6, IPv4v6, IPv4_OR_IPv6)
  • - PDN GW identity
  • - PDN GW allocation type
  • - VPLMN Dynamic Address Allowed
  • - APN-AMBR
  • - Visited Network Identifier (see clause 5.1.2.1.4)

When DSMIPv6 with HA discovery based on DHCPv6 is used, the following information elements per Home Agent may be included:

  • - HA-APN (Home Agent APN as defined in 3GPP TS 23.003 [14])
  • - Authorized 3GPP QoS profile
  • - PDN GW identity
| +| UE Charging Data | 3GPP-Charging-Characteristics | O | If present, this information element shall contain the type of charging method to be applied to the user (see 3GPP TS 29.061 [31]). | +| UE AMBR | AMBR | C | This Information Element shall contain the UE AMBR of the user. It shall be present only if the non-3GPP access network was decided to be trusted, the Result-Code AVP is set to DIAMETER_SUCCESS and ANID is "HRPD". | +| FA-RK | MIP-FA-RK | C | This AVP shall be present if MIPv4 is used, MN-FA authentication extension is supported and the Result-Code AVP is set to DIAMETER_SUCCESS. | +| FA-RK-SPI | MIP-FA-RK-SPI | C | This AVP shall be present if MIP-FA-RK is present | +| Trace information | Trace-Info | C |

This AVP shall be included if the subscriber and equipment trace has been activated for the user in the HSS and signalling based activation is used to download the trace activation from the HSS to the trusted non-3GPP access network.

Only the Trace-Data AVP shall be included to the Trace-Info AVP and shall contain the following AVPs:

  • - Trace-Reference
  • - Trace-Depth-List
  • - Trace-Event-List, for PGW
  • - Trace-Collection-Entity

The following AVPs may also be included in the Trace-Data AVP:

  • - Trace-Interface-List, for PGW, if this AVP is not present, trace report generation is requested for all interfaces for PGW listed in 3GPP TS 32.422 [32]
  • - Trace-NE-Type-List, with the only allowed value being "PDN GW". If this AVP is not included, trace activation in PDN GW is required.
| +| MSISDN | Subscription-ID | C | This AVP shall contain the MSISDN of the UE and shall be sent if it is available and the Result-Code AVP is set to DIAMETER_SUCCESS. | + +| | | | | +|----------------|----------------|---|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| WLCP Key | WLCP-Key | C | This IE shall be present if the Result-Code AVP is set to DIAMETER_SUCCESS and the TWAN Connection Mode previously selected is MCM. If present, it shall contain the key for protecting WLCP signalling (see 3GPP TS 33.402 [19]). | +| Emergency Info | Emergency-Info | C | This IE shall contain the identity of the PDN GW dynamically allocated for emergency services. It shall be present for a non-roaming authenticated user, if this information was received from the HSS, the TWAN indicated support of IMS Emergency Sessions and the Result-Code AVP is set to DIAMETER_SUCCESS. | +| UE Usage Type | UE-Usage-Type | C | This IE shall be present if this information is available in the user subscription. When present, this IE shall contain the UE Usage Type of the subscriber. | + +### 5.1.2.3.2 3GPP AAA Server Detailed Behaviour + +Handling of Re-Auth Request: + +The 3GPP AAA Server shall make use of this procedure to indicate the following: + +- If the relevant service authorization information shall be updated in the Trusted non-3GPP access network, the Re-Auth-Request-Type shall be set to AUTHORIZE\_ONLY. This procedure may be triggered by the HSS sending a subscription data update (refer to clause 8.1.2.3) or by local policies, e.g. periodic re-authorization configured by the operator. As for the STa reference point, only a single Diameter authorization session is used for a user, this procedure is initiated for all the PDN connections of this user, i.e. a single instance of Re-authorization Request shall be used per user. +- If the re-authentication and re-authorization of the user shall be executed, the Re-Auth-Request-Type shall be set to AUTHORIZE\_AUTHENTICATE. This procedure may be triggered e.g. by the expiration of a timer started at the successful completion of the last (re-)authentication of the user, depending on the local policies configured in the 3GPP AAA Server. + +Handling of Authorization Request: + +The 3GPP AAA Server shall check that the user exists in the 3GPP AAA Server. The check shall be based on Diameter Session-Id. If not, Experimental-Result-Code shall be set to DIAMETER\_ERROR\_USER\_UNKNOWN. If the user exists, the 3GPP AAA Server shall perform the authorization checking described in chapter 5.1.2.1.2. + +If the Authorization request contained the MIP6-Feature-Vector with the OPTIMIZED\_IDLE\_MODE\_MOBILITY flag set, the 3GPP AAA server shall request the user data from the HSS, in order to retrieve up-to-date PDN GW information. + +Handling of Authentication and Authorization Requests: + +The 3GPP AAA Server shall execute the re-authentication of the user, using a full authentication or fast re-authentication, as described in 3GPP TS 33.402 [19], clause 6.2 and 6.3. If full authentication is executed and there are no valid authentication vectors for the given non-3GPP access network available in the 3GPP AAA Server, it shall fetch authentication vectors from the HSS. A combined authentication and authorization shall be executed, with reduced message content described in Tables 5.1.2.3.1/5 and 5.1.2.3.1/6. The QoS-Capability, Access Network Identity, Access Type, Visited Network Identifier, Terminal Information elements received during the initial authentication and authorization procedure as well as the trustworthiness of the non-3GPP AN and the IP mobility mode selected during that procedure shall be considered as valid. If re-authentication of the user is successful and MIPv4 FACoA mode is used the 3GPP AAA Server shall create the MIPv4 FACoA security parameters as defined in 3GPP TS 33.402 [19]. + +If the re-authentication of the user is unsuccessful, the 3GPP AAA Server shall: + +- Terminate all S6b authorization sessions connected to the user, as described in clause 9.1.2.4 +- Remove all APN-PDN GW bindings from the HSS, as described in clauses 8.1.2.2.2.1 and 8.1.2.2.2.2. +- De-register the user from the HSS, as described in clauses 8.1.2.2.2.1 and 8.1.2.2.2.2. Depending on the cause of the re-authentication being unsuccessful, the Server Assignment Type shall be set to AUTHENTICATION\_FAILURE or AUTHENTICATION\_TIMEOUT. + +- Release all resources connected to the user. + +#### 5.1.2.3.3 3GPP AAA Proxy Detailed Behaviour + +The 3GPP AAA Proxy is required to handle roaming cases in which the Non-3GPP access network is in the VPLMN. The 3GPP AAA Proxy shall act as a stateful proxy, with the following additions. + +When forwarding the authorization answer or the authentication and authorization answer, the 3GPP AAA Proxy + +- shall check locally configured information for the maximum allowed static QoS parameters valid for visitors from the given HPLMN and modify the QoS parameters received from the 3GPP AAA Server, to enforce the policy limitations. +- shall record the state of the connection (i.e. Authentication and Authorization Successful). + +#### 5.1.2.3.4 Trusted Non-3GPP Access Network Detailed Behaviour + +Upon receiving the re-auth request, the Trusted non-3GPP access network shall perform the following checks and if an error is detected, the non-3GPP access network shall stop processing the request and return the corresponding error code. + +Check the Re-Auth-Request-Type AVP: + +- 1) If it indicates AUTHENTICATE\_ONLY, Result-Code shall be set to DIAMETER\_INVALID\_AVP\_VALUE. +- 2) If it indicates AUTHORIZE\_AUTHENTICATE, the authentication and authorization of the user is initiated, as defined in 3GPP TS 33.402, with the Diameter message contents described by Tables 5.1.2.3.1/5 and 5.1.2.3.1/6. +- 3) If it indicates AUTHORIZE\_ONLY, the non-3GPP access network shall just perform an authorization procedure as described by Tables 5.1.2.3.1/3 and 5.1.2.3.1/4. + +After successful authorization or authentication and authorization procedure, the trusted non-3GPP access network shall overwrite, for the subscriber identity indicated in the request and the received session, the current authorization information with the information received from the 3GPP AAA Server. + +For the TWAN access, if the TWAN receives the PDN GW Identity from 3GPP AAA Server which is different from the currently selected PDN GW for the same APN, the TWAN shall not tear down the existing PDN connection. + +If the TWAN supports Dedicated Core Networks and receives the UE-Usage-Type from the 3GPP AAA Server, the TWAN shall select the PGW as specified in clause 5.8 of 3GPP TS 29.303 [34] for new PDN connections. + +The release of a PDN connection shall be initiated if the user's subscription for the APN belonging to an active PDN connection has been terminated. + +If the authorization or authentication and authorization procedure was unsuccessful, the non-3GPP access network shall detach the user from the non-3GPP access and release all resources. If the trusted non-3GPP access supports emergency services for users in limited service state, and there is an emergency PDN connection active for such user, the non-3GPP access network shall keep the user attached in the non-3GPP access and the emergency PDN connection active. The non-emergency resources shall be released. + +The Trusted Non-3GPP access network shall initiate the re-authorization of the user in a one-step procedure (i.e. without receiving a re-authorization request from the AAA Server) if the PDN GW information needs to be updated for optimized idle mode mobility from E-UTRAN to HRPD access. + +If GTPv2 is used on S2a and if the Trace-Info AVP including Trace-Data has been received in the authorization response, the trusted non-3GPP access network shall send a GTPv2 Trace Session Activation message (see 3GPP TS 29.274 [38]) to the PGW to start a trace session for the user. If the Trace-Info AVP including Trace-Reference (directly under the Trace-Info) has been received in the authorization response, the trusted non-3GPP access network shall send a GTPv2 Trace Session Deactivation message to the PGW to stop the ongoing trace session, identified by the Trace-Reference. For details, see 3GPP TS 32.422 [32]. + +For the TWAN access, the TWAN shall send the identification, location information of the Access Point where the UE is attached, and the local time zone of the UE, in the authorization request towards the 3GPP AAA Server that follows a re-authorization request issued by the 3GPP AAA Server to the TWAN. + +## 5.1.2.4 Non-3GPP Access Network Initiated Session Termination + +### 5.1.2.4.1 General + +The STa reference point allows the non-3GPP access network to inform the 3GPP AAA server that the session resources of the non-3GPP access network assigned to a given user are being released. + +The procedure shall be initiated by the non-3GPP access network and removes non-3GPP access information from the 3GPP AAA Server. These procedures are based on the reuse of Diameter STR and STA commands as specified in IETF RFC 6733 [58]. + +**Table 5.1.2.4.1/1: STa Session Termination Request** + +| Information Element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Permanent User Identity | User-Name | M | This information element shall contain the permanent identity of the user in NAI format as defined in clause 19 of 3GPP TS 23.003 [14]. If this IE contains an identity based on IMSI, this IE shall not include the leading digit prepended in front of the IMSI used to differentiate between authentication schemes. | +| Termination Cause | Termination-Cause | M | This IE shall contain the reason for the disconnection. | + +**Table 5.1.2.4.1/2: STa Session Termination Answer** + +| Information Element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-----------------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation. The Result-Code AVP shall be used for errors as defined in the Diameter base protocol (see IETF RFC 6733 [58]). Experimental-Result AVP shall be used for STa errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | + +### 5.1.2.4.2 3GPP AAA Server Detailed Behaviour + +Upon reception of the Session Termination Request message from the non-3GPP access network, the 3GPP AAA Server shall check that there is an ongoing session associated to the two parameters received (Session-Id and User-Name). + +If an active session is found and it belongs to the user identified by the User-Name parameter, the 3GPP AAA Server shall deregister itself as the managing 3GPP AAA Server for the subscriber following the procedures listed in 8.1.2.2.2. In case of a deregistration success, the 3GPP AAA Server shall release the session resources associated to the specified session and a Session Termination Response shall be sent to the non-3GPP access network, indicating DIAMETER\_SUCCESS. If deregistration from the HSS fails, the 3GPP AAA Server shall return a Session-Termination Response with the Diameter Error DIAMETER\_UNABLE\_TO\_COMPLY. + +Otherwise, the 3GPP AAA Server returns a Session Termination Response with the Diameter Error DIAMETER\_UNKNOWN\_SESSION\_ID + +### 5.1.2.4.3 3GPP AAA Proxy Detailed Behaviour + +The 3GPP AAA Proxy is required to handle roaming cases in which the non-3GPP access network is located in the VPLMN. The 3GPP AAA Proxy shall act as a stateful proxy. + +On receipt of the Session Termination Request message from the non-3GPP access network, the 3GPP AAA Proxy shall route the message to the 3GPP AAA Server. + +On receipt of the Session Termination Answer message from the 3GPP AAA Server, the 3GPP AAA Proxy shall route the message to the non-3GPP access network and it shall release any local resources associated to the specified session only if the result code is set to DIAMETER\_SUCCESS. + +## 5.1.2.5 ERP Re-Authentication in Non-3GPP Access + +### 5.1.2.5.1 General + +The STa reference point allows the non-3GPP access network to perform re-authentication using ERP. + +ERP allows the UE and the ER server to mutually verify proof of possession of key material derived from a previous successful EAP authentication and to establish a security association between the UE and the non-3GPP access network. + +When this procedure is used, the ER server is collocated either with a TWAP or the 3GPP AAA Proxy or the 3GPP AAA Server. When the ER is located in the TWAP, ERP re-authentication procedures are out of the scope of this specification. + +When ERP is used, the ERP re-authentication procedure shall be mapped to the Diameter-EAP-Request and Diameter-EAP-Answer command codes specified in IETF RFC 4072 [5]. + +**Table 5.1.2.5.1/1: STa ERP Re-authentication Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|-----------------------------|-------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| KeyName-NAI | User-Name | M | This information element shall contain the KeyName-NAI (as defined in clause 19.3.8 of 3GPP TS 23.003 [14]) in the context of EAP re-authentication using ERP as described in IETF RFC 6696 [55] and 3GPP TS 33.402 [19]. | +| EAP-Initiate | EAP-payload | M | This IE shall contain the EAP-Initiate/Re-auth message used for the UE – ER Server mutual authentication. | +| Authentication Request Type | Auth-Request-Type | M | This IE defines whether the user is to be authenticated only, authorized only or both. AUTHORIZE_AUTHENTICATE shall be used in this case. | +| DER-Flags | DER-Flags | M | This Information Element contains a bit mask. See clause 5.2.3.20. | + +**Table 5.1.2.5.1/2: STa ERP Re-authentication Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|-----------------------------|----------------------------------------|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| KeyName-NAI | User-Name | M | This information element shall contain the KeyName-NAI (as defined in clause 19.3.8 of 3GPP TS 23.003 [14]) in the context of EAP re-authentication using ERP as described in IETF RFC 6696 [55] and 3GPP TS 33.402 [19]. | +| EAP-Finish | EAP payload | O | If present, this IE shall contain the EAP-Finish as described in IETF RFC 6942 [57]. | +| Authentication Request Type | Auth-Request-Type | M | It shall contain the value AUTHORIZE_AUTHENTICATE. See IETF RFC 4072 [5]. | +| Result code | Result-Code / Experimental Result Code | M | This IE shall contain the result of the operation. Result codes are as in Diameter Base Protocol (IETF RFC 3588 [7]). Experimental-Result AVP shall be used for STa errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | +| ERP Keying Material | Key | C | This IE shall be present if the ERP re-authentication is successful. In that case, this IE shall contain the Re-authentication MSK (rMSK) derived by ERP and may contain the rMSK lifetime. | + +### 5.1.2.5.2 ER server located in 3GPP AAA Proxy or 3GPP AAA Server Detailed Behaviour + +Upon reception of the ERP re-authentication request from the non-3GPP access network, the 3GPP AAA Proxy or the 3GPP AAA Server acting as ER server shall search in its local database for a valid, unexpired root key matching the keyName part of the KeyName-NAI. + +If the root key is not found, the 3GPP AAA Proxy or 3GPP AAA Server shall set the Result-Code to DIAMETER\_UNABLE\_TO\_COMPLY and the answer shall include an EAP-Payload AVP encapsulating an EAP Failure indicating that the ERP re-authentication has failed. + +If such root key is found, the 3GPP AAA Server shall generate the ERP keying material as described in IETF RFC 6696 [55], shall include the requested ERP keying material in the answer and the result code shall be set to DIAMETER\_SUCCESS. + +NOTE: Only the ERP Implicit Bootstrapping mode defined in IETF RFC 6696 [55] is supported in this release. + +#### 5.1.2.5.3 3GPP AAA Proxy Detailed Behaviour + +Upon reception of the ERP authentication request from the non-3GPP access network, the 3GPP AAA Proxy shall check if the realm part of the KeyName-NAI is its own domain name. If not, the Result-Code shall be set to DIAMETER\_UNABLE\_TO\_COMPLY. + +If the keyName part of the KeyName-NAI is its own domain name, the 3GPP AAA Proxy shall behave as described in clause 5.1.2.5.2. + +NOTE: In roaming case, the location of the ER server in the home 3GPP AAA Server is not supported in this release. + +## 5.2 Protocol Specification + +### 5.2.1 General + +The STa reference point shall be based on Diameter, as defined in IETF RFC 6733 [58], and contain the following additions and extensions: + +- IETF RFC 4005 [4], which defines a Diameter protocol application used for Authentication, Authorization and Accounting (AAA) services in the Network Access Server (NAS) environment. +- IETF RFC 4072 [5], which provides a Diameter application to support the transport of EAP (IETF RFC 3748 [8]) frames over Diameter. +- IETF RFC 5779 [2], which defines a Diameter extensions and application for PMIPv6 MAG to AAA and LMA to AAA interfaces. +- IETF RFC 5447 [6], which defines Diameter extensions for Mobile IPv6 NAS to AAA interface. + +In the case of a trusted non-3GPP IP access where PMIPv6 is used as mobility protocol, the MAG to 3GPP AAA server or the MAG to 3GPP AAA proxy communication shall use the MAG to AAA interface functionality defined in IETF RFC 5779 [2] and the NAS to AAA interface functionality defined in IETF RFC 5447 [6]. + +The trusted non-3GPP access network to AAA interface functionality over the STa reference defines a new Application Id: + +- "STa" with value 16777250. + +The STa application reuses existing EAP (IETF RFC 4072 [5]) application commands, command ABNFs, and application logic and procedures. + +## 5.2.2 Commands + +### 5.2.2.1 Commands for STa PMIPv6 or GTPv2 or ERP (re-)authentication and authorization procedures + +#### 5.2.2.1.1 Diameter-EAP-Request (DER) Command + +The Diameter-EAP-Request (DER) command, indicated by the Command-Code field set to 268 and the "R" bit set in the Command Flags field, is sent from a non-3GPP access network NAS to a 3GPP AAA server. The ABNF is re-used from the IETF RFC 5779 [2]. + +``` +< Diameter-EAP-Request > ::= < Diameter Header: 268, REQ, PXY, 16777250 > + < Session-Id > + [ DRMP ] + { Auth-Application-Id } + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + [ Destination-Host ] + { Auth-Request-Type } + { EAP-Payload } + [ User-Name ] + [ Calling-Station-Id ] + ... + [ RAT-Type ] + [ ANID ] + [ Full-Network-Name ] + [ Short-Network-Name ] + [ QoS-Capability ] + [ MIP6-Feature-Vector ] + [ Visited-Network-Identifier ] + [ Service-Selection ] + [ Terminal-Information ] + [ OC-Supported-Features ] + *[ Supported-Features ] + [ AAA-Failure-Indication ] + [ WLAN-Identifier ] + [ DER-Flags ] + [ TWAN-Connection-Mode ] + [ TWAN-Connectivity-Parameters ] + * 2 [ TWAG-CP-Address ] + [ ERP-RK-Request ] + ... + *[ AVP ] +``` + +#### 5.2.2.1.2 Diameter-EAP-Answer (DEA) Command + +The Diameter-EAP-Answer (DEA) command, indicated by the Command-Code field set to 268 and the "R" bit cleared in the Command Flags field, is sent from a 3GPP AAA Server to a non-3GPP access network NAS. The ABNF is re-used from the IETF RFC 5779 [2]. The ABNF also contains AVPs that are reused from IETF RFC 4072 [5]. + +``` +< Diameter-EAP-Answer > ::= < Diameter Header: 268, PXY, 16777250 > + < Session-Id > + [ DRMP ] + { Auth-Application-Id } + { Result-Code } + [ Experimental-Result ] + { Origin-Host } + { Origin-Realm } +``` + +``` + +{ Auth-Request-Type } +[ EAP-Payload ] +[ User-Name ] +[ Session-Timeout ] +[ Accounting-Interim-Interval ] +[ EAP-Master-Session-Key ] +[ Context-Identifier ] +[ APN-OI-Replacement ] +*[ APN-Configuration ] +[ MIP6-Agent-Info ] +[ MIP6-Feature-Vector ] +[ Mobile-Node-Identifier ] +[ 3GPP-Charging-Characteristics ] +[ AMBR ] +*[ Redirect-Host ] +[ AN-Trusted ] +[ Trace-Info ] +[ Subscription-ID ] +[ OC-Supported-Features ] +[ OC-OLR ] +*[ Load ] +*[ Supported-Features ] +[ MIP-FA-RK ] +[ MIP-FA-RK-SPI ] +[ NSWO-Authorization ] +[ DEA-Flags ] +[ TWAN-Connection-Mode ] +[ TWAN-Connectivity-Parameters ] +[ WLCP-Key ] +[ Terminal-Information ] +[ UE-Usage-Type ] +[ Emergency-Services ] +[ Emergency-Info ] +[ Key ] +[ ERP-Realm ] +... +*[ AVP ] + +``` + +## 5.2.2.2 Commands for STa HSS/AAA Initiated Detach for Trusted non-3GPP Access + +### 5.2.2.2.1 Abort-Session-Request (ASR) Command + +The Abort-Session-Request (ASR) command, indicated by the Command-Code field set to 274 and the "R" bit set in the Command Flags field, is sent from a 3GPP AAA Server/Proxy to a non-3GPP access network NAS. ABNF for the ASR commands is as follows: + +``` + +< Abort-Session-Request > ::= < Diameter Header: 274, REQ, PXY, 16777250 > + < Session-Id > + [ DRMP ] + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + { Destination-Host } + { Auth-Application-Id } + [ User-Name ] + [ Auth-Session-State ] + ... + *[ AVP ] + +``` + +#### 5.2.2.2.2 Abort-Session-Answer (ASA) Command + +The Abort-Session-Answer (ASA) command, indicated by the Command-Code field set to 274 and the "R" bit cleared in the Command Flags field, is sent from a non-3GPP access network NAS to a 3GPP AAA Server/Proxy. ABNF for the ASA commands is as follows: + +``` +< Abort-Session-Answer > ::= < Diameter Header: 274, PXY, 16777250 > + < Session-Id > + [ DRMP ] + { Result-Code } + { Origin-Host } + { Origin-Realm } + ... + *[ AVP ] +``` + +#### 5.2.2.2.3 Session-Termination-Request (STR) Command + +The Session-Termination-Request (STR) command, indicated by the Command-Code field set to 275 and the "R" bit set in the Command Flags field, is sent from a trusted non-3GPP access network to a 3GPP AAA Server/Proxy. The Command Code value and ABNF are re-used from the IETF RFC 6733 [58], Session-Termination-Request command. + +``` + ::= < Diameter Header: 275, REQ, PXY, 16777250 > + < Session-Id > + [ DRMP ] + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + [ Destination-Host ] + { Auth-Application-Id } + { Termination-Cause } + [ User-Name ] + [ OC-Supported-Features ] + ... + *[ AVP ] +``` + +#### 5.2.2.2.4 Session-Termination-Answer (STA) Command + +The Session-Termination-Answer (STA) command, indicated by the Command-Code field set to 275 and the "R" bit cleared in the Command Flags field, is sent from a 3GPP AAA Server/Proxy to a trusted non-3GPP access network. The Command Code value and ABNF are re-used from the IETF RFC 6733 [58], Session-Termination-Answer command. + +``` + ::= < Diameter Header: 275, PXY, 16777250 > + < Session-Id > + [ DRMP ] + { Result-Code } + { Origin-Host } + { Origin-Realm } + [ OC-Supported-Features ] + [ OC-OLR ] + *[ Load ] + *[ AVP ] +``` + +### 5.2.2.3 Commands for Re-Authentication and Re-Authorization Procedure + +#### 5.2.2.3.1 Re-Auth-Request (RAR) Command + +The Diameter Re-Auth-Request (RAR) command, indicated by the Command-Code field set to 258 and the "R" bit set in the Command Flags field, is sent from a 3GPP AAA Server to a Trusted Non-3GPP access network. ABNF for the RAR command is as follows: + +``` +< Re-Auth-Request > ::= < Diameter Header: 258, REQ, PXY, 16777250 > + < Session-Id > +``` + +``` + +[ DRMP ] +{ Origin-Host } +{ Origin-Realm } +{ Destination-Realm } +{ Destination-Host } +{ Auth-Application-Id } +{ Re-Auth-Request-Type } +[ User-Name ] +... +*[ AVP ] + +``` + +#### 5.2.2.3.2 Re-Auth-Answer (RAA) Command + +The Diameter Re-Auth-Answer (RAA) command, indicated by the Command-Code field set to 258 and the "R" bit cleared in the Command Flags field, is sent from a Trusted Non-3GPP access network to a 3GPP AAA Server/Proxy. ABNF for the RAA commands is as follows: + +``` + +< Re-Auth-Answer > ::= < Diameter Header: 258, PXY, 16777250 > + < Session-Id > + [ DRMP ] + { Result-Code } + { Origin-Host } + { Origin-Realm } + ... + *[ AVP ] + +``` + +#### 5.2.2.3.3 AA-Request (AAR) Command + +The AA-Request (AAR) command, indicated by the Command-Code field set to 265 and the "R" bit set in the Command Flags field, is sent from a Trusted Non-3GPP access network to a 3GPP AAA Server/Proxy. The ABNF is re-used from IETF RFC 4005 [4], adding AVPs from IETF RFC 5779 [2]. + +``` + +< AA-Request > ::= < Diameter Header: 265, REQ, PXY, 16777250 > + < Session-Id > + [ DRMP ] + { Auth-Application-Id } + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + { Auth-Request-Type } + [ Destination-Host ] + [ User-Name ] + [ MIP6-Feature-Vector ] + [ Access-Network-Info ] + [ Local-Time-Zone ] + + [ OC-Supported-Features ] + ... + *[ AVP ] + +``` + +#### 5.2.2.3.4 AA-Answer (AAA) Command + +The AA-Answer (AAA) command, indicated by the Command-Code field set to 265 and the "R" bit cleared in the Command Flags field, is sent from a 3GPP AAA Server/Proxy to a Trusted Non-3GPP access network. The ABNF is re-used from IETF RFC 4005 [4], adding AVPs from IETF RFC 5779 [2]. + +``` + +< AA-Answer > ::= < Diameter Header: 265, PXY, 16777250 > + < Session-Id > + [ DRMP ] + { Auth-Application-Id } + { Auth-Request-Type } + { Result-Code } + +``` + +``` + +[ Experimental-Result ] +{ Origin-Host } +{ Origin-Realm } +[ Session-Timeout ] +[ Accounting-Interim-Interval ] +[ Context-Identifier ] +[ APN-OI-Replacement ] +*[ APN-Configuration ] +[ 3GPP-Charging-Characteristics ] +[ Trace-Info ] +[ Subscription-ID ] +[ OC-Supported-Features ] +[ OC-OLR ] +[ UE-Usage-Type ] +[ Emergency-Info ] +*[ Load ] +... +*[ AVP ] + +``` + +### 5.2.2.3.5 Diameter-EAP-Request (DER) Command + +Refer to clause 5.2.2.1.1 + +### 5.2.2.3.6 Diameter-EAP-Answer (DEA) Command + +Refer to clause 5.2.2.1.2 + +## 5.2.2.4 Commands for Trusted non-3GPP Access network Initiated Session Termination + +### 5.2.2.4.1 Session-Termination-Request (STR) Command + +The Session-Termination-Request (STR) command, indicated by the Command-Code field set to 275 and the "R" bit set in the Command Flags field, is sent from a non-3GPP access network to a 3GPP AAA server. The Command Code value and ABNF are re-used from the IETF RFC 6733 [58], Session-Termination-Request command. + +``` + + ::= < Diameter Header: 275, REQ, PXY, 16777250 > +< Session-Id > +[ DRMP ] +{ Origin-Host } +{ Origin-Realm } +{ Destination-Realm } +[ Destination-Host ] +{ Auth-Application-Id } +{ Termination-Cause } +[ User-Name ] +[ OC-Supported-Features ] +... +*[ AVP ] + +``` + +### 5.2.2.4.2 Session-Termination-Answer (STA) Command + +The Session-Termination-Answer (STA) command, indicated by the Command-Code field set to 275 and the "R" bit cleared in the Command Flags field, is sent from a 3GPP AAA server to a non-3GPP access network. The Command Code value and ABNF are re-used from the IETF RFC 6733 [58], Session-Termination-Answer command. + +``` + + ::= < Diameter Header: 275, PXY, 16777250 > +< Session-Id > + +``` + +``` +[ DRMP ] +{ Result-Code } +{ Origin-Host } +{ Origin-Realm } +[ OC-Supported-Features ] +[ OC-OLR ] +*[ Load ] +*[ AVP ] +``` + +## 5.2.3 Information Elements + +### 5.2.3.1 General + +The following table describes the Diameter AVPs defined for the STa interface protocol in NBM mode, their AVP Code values, types, possible flag values and whether or not the AVP may be encrypted. + +For all AVPs which contain bit masks and are of the type Unsigned32, bit 0 shall be the least significant bit. For example, to get the value of bit 0, a bit mask of 0x00000001 should be used. + +**Table 5.2.3.1/1: Diameter STa AVPs** + +| | AVP Flag rules | +|--|----------------| +|--|----------------| + +| Attribute Name | AVP Code | Clause defined | Value Type | Must | May | Should not | Must not | +|------------------------------|----------|----------------|-------------|------|-----|------------|----------| +| MIP6-Feature-Vector | 124 | 5.2.3.3 | Unsigned64 | M | | | V,P | +| QoS-Capability | 578 | 5.2.3.4 | Grouped | M | | | V,P | +| Service-Selection | 493 | 5.2.3.5 | UTF8String | M | | | V,P | +| RAT-Type | 1032 | 5.2.3.6 | Enumerated | M,V | | | P | +| ANID | 1504 | 5.2.3.7 | UTF8String | M,V | | | P | +| AN-Trusted | 1503 | 5.2.3.9 | Enumerated | M,V | | | P | +| MIP-FA-RK | 1506 | 5.2.3.12 | OctetString | M,V | | | P | +| MIP-FA-RK-SPI | 1507 | 5.2.3.13 | Unsigned32 | M,V | | | P | +| Full-Network-Name | 1516 | 5.2.3.14 | OctetString | V | | | M,P | +| Short-Network-Name | 1517 | 5.2.3.15 | OctetString | V | | | M,P | +| WLAN-Identifier | 1509 | 5.2.3.18 | Grouped | V | | | M,P | +| Mobile-Node-Identifier | 506 | 5.2.3.2 | UTF8String | M | | | V,P | +| AAA-Failure-Indication | 1518 | 8.2.3.21 | Unsigned32 | V | | | M,P | +| Transport-Access-Type | 1519 | 5.2.3.19 | Enumerated | V | | | M,P | +| APN-Configuration | 1430 | 8.2.3.7 | Grouped | M,V | | | P | +| Visited-Network-Identifier | 600 | 9.2.3.1.2 | OctetString | M,V | | | P | +| DER-Flags | 1520 | 5.2.3.20 | Unsigned32 | V | | | M,P | +| DEA-Flags | 1521 | 5.2.3.21 | Unsigned32 | V | | | M,P | +| SSID | 1524 | 5.2.3.22 | UTF8String | V | | | M,P | +| HESSID | 1525 | 5.2.3.23 | UTF8String | V | | | M,P | +| Access-Network-Info | 1526 | 5.2.3.24 | Grouped | V | | | M,P | +| TWAN-Connection-Mode | 1527 | 5.2.3.25 | Unsigned32 | V | | | M,P | +| TWAN-Connectivity-Parameters | 1528 | 5.2.3.26 | Grouped | V | | | M,P | +| Connectivity-Flags | 1529 | 5.2.3.27 | Unsigned32 | V | | | M,P | +| TWAN-PCO | 1530 | 5.2.3.28 | OctetString | V | | | M,P | +| TWAG-CP-Address | 1531 | 5.2.3.29 | Address | V | | | M,P | +| TWAG-UP-Address | 1532 | 5.2.3.30 | UTF8String | V | | | M,P | +| TWAN-S2a-Failure-Cause | 1533 | 5.2.3.31 | Unsigned32 | V | | | M,P | +| SM-Back-Off-Timer | 1534 | 5.2.3.32 | Unsigned32 | V | | | M,P | +| WLCP-Key | 1535 | 5.2.3.33 | OctetString | V | | | M,P | +| Emergency-Services | 1538 | 7.2.3.4 | Unsigned32 | V | | | M,P | +| IMEI-Check-In-VPLMN-Result | 1540 | 5.2.3.35 | Unsigned32 | V | | | M,P | + +NOTE 1: The AVP header bit denoted as "M", indicates whether support of the AVP is required. The AVP header bit denoted as "V", indicates whether the optional Vendor-ID field is present in the AVP header. For further details, see IETF RFC 6733 [58],. + +NOTE 2: If the M-bit is set for an AVP and the receiver does not understand the AVP, it shall return a rejection. If the M-bit is not set for an AVP, the receiver shall not return a rejection, whether or not it understands the AVP. If the receiver understands the AVP but the M-bit value does not match with the definition in this table, the receiver shall ignore the M-bit. + +The following table describes the Diameter AVPs re-used by the STa interface protocol from existing Diameter Applications, including a reference to their respective specifications and when needed, a short description of their use within STa. Other AVPs from existing Diameter Applications, except for the AVPs from Diameter base protocol defined in IETF RFC 6733 [58], do not need to be supported. + +**Table 5.2.3.1/2: STa re-used Diameter AVPs** + +| Attribute Name | Reference | Comments | M-bit | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------|-------------------------------------------------------------------------------------------|--------------| +| Accounting-Interim-Interval | IETF RFC 6733 [58] | | | +| Auth-Request-Type | IETF RFC 6733 [58] | | | +| Calling-Station-Id | IETF RFC 4005 [4] | | | +| Subscription-ID | IETF RFC 4006 [20] | | Must not set | +| EAP-Master-Session-Key | IETF RFC 4072 [5] | | | +| EAP-Payload | IETF RFC 4072 [5] | | | +| RAT-Type | 3GPP TS 29.212 [23] | | | +| Re-Auth-Request-Type | IETF RFC 6733 [58] | | | +| Session-Timeout | IETF RFC 6733 [58] | | | +| User-Name | IETF RFC 6733 [58] | | | +| Terminal-Information | 3GPP TS 29.272 [29] | | | +| MIP6-Agent-Info | IETF RFC 5447 [6] | | | +| APN-OI-Replacement | 3GPP TS 29.272 [29] | | | +| Supported-Features | 3GPP TS 29.229 [24] | | | +| Feature-List-ID | 3GPP TS 29.229 [24] | See clause 5.2.3.10 | | +| Feature-List | 3GPP TS 29.229 [24] | See clause 5.2.3.11 | | +| BSSID | 3GPP TS 32.299 [30] | | | +| Location-Information | IETF RFC 5580 [46] | | | +| Location-Data | IETF RFC 5580 [46] | | | +| Operator-Name | IETF RFC 5580 [46] | | | +| Logical-Access-ID | ETSI TS 283 034 [48] | | | +| Local-Time-Zone | 3GPP TS 29.272 [29] | | | +| PDN-Type | 3GPP TS 29.272 [29] | | | +| Served-Party-IP-Address | 3GPP TS 32.299 [30] | | | +| OC-Supported-Features | IETF RFC 7683 [47] | See clause 8.2.3.22 | | +| OC-OLR | IETF RFC 7683 [47] | See clause 8.2.3.23 | | +| DRMP | IETF RFC 7944 [53] | See clause 8.2.3.25 | Must not set | +| Emergency-Info | 3GPP TS 29.272 [29] | | | +| Load | IETF RFC 8583 [54] | See clause 8.2.3.26 | Must not set | +| ERP-RK-Request | IETF RFC 6942 [57] | | Must not set | +| Key | IETF RFC 6734 [56] | This is a grouped AVP containing Key-Type, Keying-Material and, optionally, Key-Lifetime. | Must not set | +| ERP-Realm | IETF RFC 6942 [57] | | Must not set | +| UE-Usage-Type | 3GPP TS 29.272 [29] | | | +| NOTE 1: The M-bit settings for re-used AVPs override those of the defining specifications that are referenced. Values include: "Must set", "Must not set". If the M-bit setting is blank, then the defining specification applies. | | | | +| NOTE 2: If the M-bit is set for an AVP and the receiver does not understand the AVP, it shall return a rejection. If the M-bit is not set for an AVP, the receiver shall not return a rejection, whether or not it understands the AVP. If the receiver understands the AVP but the M-bit value does not match with the definition in this table, the receiver shall ignore the M-bit. | | | | + +Only those AVP initially defined in this reference point or AVP with values initially defined in this reference point and for this procedure are described in the following subchapters. + +### 5.2.3.2 Mobile-Node-Identifier + +The Mobile-Node-Identifier AVP (AVP Code 506) is of type UTF8String. + +The Mobile-Node-Identifier AVP is returned in an answer message that ends a successful authentication (and possibly an authorization) exchange between the AAA client and the AAA server. The returned Mobile Node Identifier may be used as the PMIPv6 MN-ID or as the MIPv4 MN-NAI or to derive the IMSI to be sent in GTPv2 signalling. + +The Mobile-Node-Identifier is defined on IETF RFC 5779 [2]. + +### 5.2.3.3 MIP6-Feature-Vector + +The MIP6-Feature-Vector AVP (AVP Code 124) is of type Unsigned64 and contains a 64 bit flags field of supported mobile IP capabilities of the non-3GPP access network (when this AVP is used in the request commands) and the mobile IP capabilities the 3GPP AAA Server has authorized (when this AVP is used in the response commands). + +The following capabilities are defined for STa interface: + +- MIP6\_INTEGRATED (0x0000000000000001) +This flag is set by the non-3GPP access network and the 3GPP AAA Server. It means that the Mobile IPv6 integrated scenario bootstrapping functionality is supported. +- PMIP6\_SUPPORTED (0x0000010000000000) +When this flag is set by the non-3GPP access network it indicates to the 3GPP AAA Server that it supports PMIPv6. +When this flag is set by the 3GPP AAA Server it indicates to the non-3GPP access network that NBM shall be used. +- ASSIGN\_LOCAL\_IP (0x0000080000000000) +This flag is set by the 3GPP AAA Server. +When this flag is set by the 3GPP AAA Server it indicates to the non-3GPP access network that the non-3GPP access network shall assign to the user a local IP address (for HBM). +- MIP4\_SUPPORTED (0x0000100000000000) +This flag is set by the non-3GPP access network, the PDN GW and the 3GPP AAA Server. When this flag is set by the non-3GPP access network it indicates to the 3GPP AAA Server that it supports MIPv4 FA-CoA mode. When this flag is set by the 3GPP AAA Server it indicates to the non-3GPP access network that MIPv4 FA-CoA mode shall be used. When this flag is set by the PDN GW and 3GPP AAA Server over the S6b interface, it shows that MIPv4 mobility protocol is used on the S2a interface. +- OPTIMIZED\_IDLE\_MODE\_MOBILITY (0x0000200000000000) +This flag is set by the Trusted Non-3GPP access network if the PDN GW information needs to be updated for the case of idle mode mobility from E-UTRAN to HRPD access. +- GTPv2\_SUPPORTED (0x0000400000000000) +When this flag is set by the non-3GPP access network it indicates to the 3GPP AAA Server that it supports GTPv2. +When this flag is set by the 3GPP AAA Server it indicates to the non-3GPP access network that NBM shall be used. + +### 5.2.3.4 QoS Capability + +This AVP is FFS + +### 5.2.3.5 Service-Selection + +The Service-Selection AVP is of type of UTF8String. This AVP contains an APN Network Identifier (i.e., an APN without the Operator Identifier), and it shall consist of one or more labels according to DNS naming conventions (IETF RFC 1035 [35]) describing the access point to the packet data network. + +The contents of the Service-Selection AVP shall be formatted as a character string composed of one or more labels separated by dots ("."). + +The Service-Selection AVP is defined in IETF RFC 5778 [11]. + +### 5.2.3.6 RAT-Type + +The RAT-Type AVP (AVP code 1032) is of type Enumerated and is used to identify the radio access technology that is serving the UE. It follows the specification described in TS 29.212 [23]. + +### 5.2.3.7 ANID + +The ANID AVP is of type UTF8String; this AVP contains the Access Network Identity; see 3GPP TS 24.302 [26] for defined values. + +### 5.2.3.8 AMBR + +Please refer to 3GPP TS 29.272 [29] for the encoding of this AVP. + +### 5.2.3.9 AN-Trusted + +The AN-Trusted AVP (AVP Code 1503) is of type Enumerated. + +The AN-Trusted AVP sent from the 3GPP AAA Server to the Non-3GPP access network conveys the decision about the access network being trusted or untrusted by the HPLMN. + +The following values are defined: + +TRUSTED (0) + +This value is used when the non-3GPP access network is to be handled as trusted. + +UNTRUSTED (1) + +This value is used when the non-3GPP access network is to be handled as untrusted. + +### 5.2.3.10 Feature-List-ID AVP + +The syntax of this AVP is defined in 3GPP TS 29.229 [24]. For this release, the Feature-List-ID AVP value shall be set to 1 for the STa/SWa application. + +### 5.2.3.11 Feature-List AVP + +The syntax of this AVP is defined in 3GPP TS 29.229 [24]. A null value indicates that there is no feature used by the STa/SWa application. + +NOTE: There are no STa/SWa features defined for this release. + +### 5.2.3.12 MIP-FA-RK + +The MIP-FA-RK AVP is of type OctetString; this AVP contains the FA-RK used to calculate the security parameters needed for the MN-FA authentication extension as defined by 3GPP TS 33.402 [19]. + +### 5.2.3.13 MIP-FA-RK-SPI + +The MIP-FA-RK-SPI AVP is of type Unsigned32; this AVP contains the security index used in identifying the security context for the FA-RK as defined by 3GPP TS 33.402 [19]. + +### 5.2.3.14 Full-Network-Name + +The Full-Network-Name AVP is of type OctetString; this AVP shall contain the Full Network Name and be encoded as the Full name value field of the AT\_FULL\_NAME\_FOR\_NETWORK attribute specified in clause 8.2.5.1 of 3GPP TS 24.302 [26]. + +### 5.2.3.15 Short-Network-Name + +The Short-Network-Name AVP is of type OctetString; this AVP shall contain the Short Network Name and be encoded as the Short name value field of the AT\_SHORT\_NAME\_FOR\_NETWORK attribute specified in clause 8.2.5.2 of 3GPP TS 24.302 [26]. + +#### 5.2.3.16 Void + +#### 5.2.3.17 Void + +#### 5.2.3.18 WLAN-Identifier + +The WLAN-Identifier AVP is of type Grouped. It contains the type and value of an IEEE 802.11 identifier of a Trusted WLAN. + +AVP Format: + +WLAN-Identifier ::= < AVP Header: 1509 10415 > +[ SSID ] +[ HESSID ] +\*[ AVP ] + +#### 5.2.3.19 Transport-Access-Type + +The Transport-Access-Type AVP (AVP code 1519) is of type Enumerated and is used to identify the transport access technology that is serving the UE. + +The following values are defined: + +BBF (0) + +This value shall be used to indicate a BBF transport access network. + +#### 5.2.3.20 DER-Flags + +The DER-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 5.2.3.20/1: + +**Table 5.2.3.20/1: DER-Flags** + +| Bit | Name | Description | +|-------------------------------------------------------------------------------------------------------------------|---------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | NSWO-Capability-Indication | This bit, when set, indicates to the 3GPP AAA proxy/server that the TWAN supports non-seamless WLAN offload service (see clause 16 of 3GPP TS 23.402 [3]). | +| 1 | TWAN-S2a-Connectivity-Indicator | This bit is only applicable to the TWAN authentication and authorization procedure, when authorizing the SCM for EPC access.
When set, it indicates to the 3GPP AAA Server that the TWAN has completed the necessary S2a network connectivity actions, and the 3GPP AAA Server can finalize the EAP conversation by sending a final EAP 'Success' or 'Failure' response to the TWAN. | +| 2 | IMEI-Check-Required-In-VPLMN | This bit is only applicable to the TWAN authentication and authorization procedure, when the UE and the network support Mobile Equipment Identity signalling over trusted WLAN.
When set, it indicates to the 3GPP AAA Server that the 3GPP AAA Server shall retrieve the IMEI(SV) from the UE and return it to the VPLMN with the IMEI-Check-Request-In-VPLMN bit set in the DEA-Flags. | +| 3 | IMEI-Check-Request-In-VPLMN | This bit is only applicable to the TWAN authentication and authorization procedure, when the UE and the network support Mobile Equipment Identity signalling over trusted WLAN.
When set, it indicates that the 3GPP AAA Proxy shall perform the IMEI(SV) check in the VPLMN and send the IMEI check result to the 3GPP AAA Server. | +| 4 | Emergency-Capability-Indication | This bit, when set, indicates to the 3GPP AAA Server that the TWAN supports IMS emergency sessions (see clause 4.5.7 of 3GPP TS 23.402 [3]). | +| 5 | ERP-Support-Indication | This bit, when set, indicates to the 3GPP AAA proxy/server that the non-3GPP access network supports EAP extensions for the EAP Re-authentication Protocol (ERP). | +| 6 | ERP-Re-Authentication | This bit, when set, indicates to the 3GPP AAA proxy/server that the authentication request is sent for EAP re-authentication based on ERP. | +| NOTE: Bits not defined in this table shall be cleared by the sender and discarded by the receiver of the command. | | | + +### 5.2.3.21 DEA-Flags + +The DEA-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 5.2.3.21/1: + +**Table 5.2.3.21/1: DEA-Flags** + +| Bit | Name | Description | +|-------------------------------------------------------------------------------------------------------------------|---------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | NSWO-Authorization | This bit, when set, indicates to the TWAN that the non-seamless WLAN offload service is authorized (see clause 16 of 3GPP TS 23.402 [3]). | +| 1 | TWAN-S2a-Connectivity-Indicator | This bit is only applicable to the TWAN authentication and authorization procedure, when authorizing the SCM for EPC access; when set, it indicates to the TWAN that the EAP-AKA' authentication has been successful (i.e., the 3GPP AAA Server has checked the validity of the challenge response sent by the UE), and the network connectivity set up may proceed at the TWAN. | +| 2 | IMEI-Check-Request-In-VPLMN | This bit is only applicable to the TWAN authentication and authorization procedure, when the UE and the network support Mobile Equipment Identity signalling over trusted WLAN.
When set, it indicates that the VPLMN shall perform the IMEI check and return the outcomes to the 3GPP AAA Server. | +| NOTE: Bits not defined in this table shall be cleared by the sender and discarded by the receiver of the command. | | | + +### 5.2.3.22 SSID + +The SSID AVP is of type UTF8String and it shall contain the Service Set Identifier which identifies a specific 802.11 extended service set (see IEEE Std 802.11-2012 [40]). It shall contain a string of 1 to 32 octets. + +### 5.2.3.23 HESSID + +The HESSID AVP is of type UTF8String and it shall contain a 6-octet MAC address that identifies the Homogenous Extended Service Set (see IEEE Std 802.11-2012 [40]). It shall be encoded in upper-case ASCII characters with the octet values separated by dash characters. It shall contain a string of 17 octets. Example: "00-10-A4-23-19-C0". + +### 5.2.3.24 Access-Network-Info + +The Access-Network-Info AVP is of type Grouped. + +For a Trusted WLAN, it shall contain the SSID of the WLAN and, unless otherwise determined by the TWAN operator's policies, it shall contain at least one of the following elements: + +- the BSSID, +- the civic address of the access point to which the UE is attached, +- the Logical Access ID (see ETSI ES 283 034 [48]) associated to the access point to which the UE is attached. + +It may also contain the name of the TWAN operator (either a PLMN-ID or an operator name in realm format). + +For an untrusted WLAN, it shall contain the same information as specified above for a trusted WLAN, where the operator name indicates the WLAN operator name. + +AVP Format: + +``` +Access-Network-Info ::= < AVP Header: 1526 10415 > + [ SSID ] + [ BSSID ] + [ Location-Information ] + [ Location-Data ] + [ Operator-Name ] + [ Logical-Access-ID ] + *[ AVP ] +``` + +The Location-Data and Location-Information AVPs are defined in IETF RFC 5580 [46]; the content of Location-Information shall indicate that the encoding follows a civic location profile, by setting the "Code" field to 0. + +The Operator-Name AVP is defined in IETF RFC 5580 [46]; the first 8 bits contain the Namespace ID field, whose values are managed by IANA, and are encoded as a single ASCII character. Only values "1" (Realm) and "2" (E212, containing MCC and MNC values) shall be used in this specification. + +### 5.2.3.25 TWAN-Connection-Mode + +The TWAN-Connection-Mode AVP (AVP Code 1527) is of type Unsigned32 and it shall contain a 32 bit flags field which is used to indicate the connection modes supported by the TWAN (when this AVP is used in the request commands) and the selected TWAN connection mode the 3GPP AAA Server has authorized (when this AVP is used in the response commands). + +**Table 5.2.3.25/1: TWAN-Connection-Mode** + +| Bit | Name | Description | +|-------------------------------------------------------------------------------------------------------------------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | TSC-MODE | This bit, when set by the TWAN, indicates to the 3GPP AAA Server that the TWAN supports the TSCM. | +| 1 | SC-MODE | This bit, when set by the TWAN, indicates to the 3GPP AAA Server that the TWAN supports the SCM.
This bit, when set by the 3GPP AAA Server, indicates to the TWAN that the SCM shall be used. | +| 2 | MC-MODE | This bit, when set by the TWAN, indicates to the 3GPP AAA Server that the TWAN supports the MCM.
This bit, when set by the 3GPP AAA Server, indicates to the TWAN that the MCM shall be used. | +| NOTE: Bits not defined in this table shall be cleared by the sender and discarded by the receiver of the command. | | | + +### 5.2.3.26 TWAN-Connectivity-Parameters + +The TWAN-Connectivity-Parameters AVP is of type Grouped. + +AVP Format: + +``` + +TWAN-Connectivity-Parameters ::= < AVP Header: 1528 10415 > + [ Connectivity-Flags ] + [ Service-Selection ] + [ PDN-Type ] + * 2 [ Served-Party-IP-Address ] + [ TWAN-PCO ] + [ TWAG-UP-Address ] + [ TWAN-S2a-Failure-Cause ] + [ SM-Back-Off-Timer ] + *[ AVP ] + +``` + +The Service-Selection AVP indicates the APN requested by the UE (requested connectivity parameters) or the APN selected by the TWAN (provided connectivity parameters). It shall contain both the network identifier part and the operator identifier part of the Access Point Name. + +The PDN-Type AVP indicates the PDN type requested by the UE (requested connectivity parameters) or the PDN type allocated by the network (provided connectivity parameter). It may be set to IPv4, IPv6 or IPv4v6. + +The UE's Served-Party-IP-Address AVP may be present 0, 1 or 2 times. These AVPs shall be present if the S2a connection was successfully established, and they shall contain either of: + +- an IPv4 address, or +- an IPv6 interface identifier, or +- both, an IPv4 address and an IPv6 interface identifier. + +For the IPv6 interface identifier, the higher 64 bits of the address shall be set to zero. + +The TWAN-S2a-Failure-Cause AVP may be present to indicate the cause of S2a connectivity establishment failure. + +The SM-Back-Off-Timer AVP may be present to provide a Session Management back-off timer to be sent to the UE. The exact value of the SM-Back-Off-Timer is operator dependant. + +### 5.2.3.27 Connectivity-Flags + +The Connectivity-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 5.2.3.26/1: + +**Table 5.2.3.26/1: Connectivity-Flags** + +| Bit | Name | Description | +|-------|-------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | Initial-Attach-Indicator | This bit may be set by the 3GPP AAA Server.
This bit, when set, indicates that a UE performs the Initial Attach procedure from non-3GPP access network. When not set, it indicates that a UE performs the Handover procedure. | +| NOTE: | Bits not defined in this table shall be cleared by the sender and discarded by the receiver of the command. | | + +### 5.2.3.28 TWAN-PCO + +The TWAN-PCO AVP is of type OctetString and shall contain the Protocol Configuration Options for the UE. + +### 5.2.3.29 TWAG-CP-Address + +The TWAG-CP-Address AVP is of type Address and shall contain the TWAG control-plane IPv4 and/or IPv6 address that the TWAG supports, to be used for WLCP by the UE if MCM is selected. + +### 5.2.3.30 TWAG-UP-Address + +The TWAG-UP-Address AVP is of type UTF8String and shall contain a 6-octet MAC address that identifies the TWAG user-plane MAC address to be used for encapsulating user plane packets between the UE and the TWAN, when SCM is used. + +It shall be encoded in upper-case ASCII characters with the octet values separated by dash characters. It shall contain a string of 17 octets. Example: "00-10-A4-23-19-C0". + +### 5.2.3.31 TWAN-S2a-Failure-Cause + +The TWAN-S2a-Failure-Cause AVP (AVP Code 1533) is of type Unsigned32 and it shall contain a 32 bit cause value field which is used to indicate the cause of S2a connectivity establishment failure to the 3GPP AAA Server by the TWAN. The description of the TWAN-S2a-Failure-Cause value is specified as in Table 5.2.3.30/1: + +**Table 5.2.3.30/1: TWAN-S2a-Failure-Cause value description** + +| Cause value (decimal) | Cause Value | Meaning | +|-----------------------|---------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 26 | Insufficient resources | This cause is used to indicate that the requested service cannot be provided due to insufficient resources. | +| 27 | Unknown APN | This cause is used to indicate that the requested service was rejected because the access point name could not be resolved. | +| 29 | User authentication failed | This cause is used to indicate that the requested service was rejected by the external packet data network due to a failed user authentication | +| 30 | Request rejected by TWAN or PDN GW | This cause is used to indicate that the requested service or operation was rejected by the TWAN or PDN GW. | +| 31 | Request rejected, unspecified | This cause is used to indicate that the requested service or operation was rejected due to unspecified reasons. | +| 32 | Service option not supported | This cause is used to indicate that the UE requests a service which is not supported by the PLMN. | +| 33 | Requested service option not subscribed | This cause is used to indicate that the UE requests a service option which it has no subscription. | +| 34 | Service option temporarily out of order | This cause is used to indicate that the network cannot serve the request because of temporary outage of one or more functions required for supporting the service. | +| 38 | Network failure | This cause is used to indicate that the requested service was rejected due to an error situation in the network. | +| 50 | PDN type IPv4 only allowed | This value is used to indicate that only PDN type IPv4 is allowed for the requested PDN connectivity. | +| 51 | PDN type IPv6 only allowed | This value is used to indicate that only PDN type IPv6 is allowed for the requested PDN connectivity. | +| 54 | PDN connection does not exist | This value is used at handover from a 3GPP access network to indicate that the network does not have any information about the requested PDN connection. | +| 113 | Multiple accesses to a PDN connection not allowed | This value is used to indicate that the request for the additional access to a PDN connection was rejected by the PDN GW. | + +### 5.2.3.32 SM-Back-Off-Timer + +The SM-Back-Off-Timer AVP is of type Unsigned32 and it shall contain the session management back-off timer value in seconds. The session management back-off timer is provided to the UE as specified in clause 8.1.4.16 of 3GPP TS 24.302 [26]. + +### 5.2.3.33 WLCP-Key + +The WLCP-Key AVP (AVP Code 1535) is of type OctetString and it shall contain the WLCP Key used for protecting the WLCP signalling between the UE and the TWAN, as specified in 3GPP TS 33.402 [19]. + +### 5.2.3.34 Void + +### 5.2.3.35 IMEI-Check-In-VPLMN-Result + +The IMEI-Check-In-VPLMN-Result AVP (AVP Code 1540) is of type Unsigned32 and it shall contain a 32 bit cause value field which is used to indicate the result of the IMEI check performed in the VPLMN. The description of the IMEI-Check-In-VPLMN-Result value is specified as in Table 5.2.3.35/1: + +**Table 5.2.3.35/1: IMEI-Check-In-VPLMN-Result value description** + +| Cause value (decimal) | Cause Value | Meaning | +|-----------------------|-------------|----------------------------------------------------------------------------------------------------------------| +| 0 | Successful | This cause is used to indicate that the IMEI check has been performed successfully in the VPLMN. | +| 1 | Illegal_ME | This cause is used to indicate that the IMEI check has failed in the VPLMN due to an illegal Mobile Equipment. | + +## 5.2.4 Session Handling + +The Diameter protocol between the non-3GPP access network and the 3GPP AAA Server or 3GPP AAA Proxy, shall always keep the session state, and use the same Session-Id parameter for the lifetime of each Diameter session. + +A Diameter session shall identify a given user. In order to indicate that the session state is to be maintained, the Diameter client and server shall not include the Auth-Session-State AVP, either in the request or in the response messages (see IETF RFC 6733 [58]). + +# 6 SWd Description + +## 6.1 Functionality + +### 6.1.1 General + +The SWd reference point connects the 3GPP AAA Proxy and the 3GPP AAA Server. The functionality of the SWd reference point is to transport authentication, authorization and related information in AAA messages including: + +- Carrying data for authentication signalling between 3GPP AAA Proxy and 3GPP AAA Server; +- Carrying data for authorization signalling between 3GPP AAA Proxy and 3GPP AAA Server +- Carrying charging signalling per user; +- Carrying keying data for the purpose of radio interface integrity protection and encryption; +- Carrying authentication data for the purpose of tunnel establishment, tunnel data authentication and encryption, for the case in which the ePDG is in the VPLMN; +- Carrying mapping of a user identifier and a tunnel identifier sent from the ePDG to the 3GPP AAA Proxy through the 3GPP AAA Server; +- Used for purging a user from the access network for immediate service termination; +- Enabling the identification of the operator networks amongst which the roaming occurs; +- If QoS mechanisms are applied: carrying data for AN QoS capabilities/policies (e.g. the supported 3GPP QoS profiles) within authentication request from 3GPP AAA Proxy to 3GPP AAA Server. +- Carrying the IP Mobility Capabilities between 3GPP AAA Proxy and 3GPP AAA Server. + +## 6.1.2 Procedures Description + +### 6.1.2.1 Trusted non-3GPP Access / Access Gateway related procedures + +#### 6.1.2.1.1 Trusted Non-3GPP Access Authentication and Authorization + +When used in connection with the STa interface, the SWd interface shall support the trusted non-3GPP access authentication and authorization procedure defined in clause 5.1.2.1. For this procedure, the 3GPP AAA Proxy shall forward the Diameter commands received from the 3GPP AAA Server and the trusted non-3GPP access network as a stateful Diameter proxy, with the following exceptions: + +- The 3GPP AAA Proxy may reject an authentication and authorization request, if roaming is not allowed for the users of the given HPLMN. +- When forwarding an authentication and authorization request, the 3GPP AAA Proxy shall check the presence and value of the visited network identifier. If the AVP was missing, it shall insert it, if the AVP was present, it may overwrite the AVP value before forwarding the request. +- The 3GPP AAA Proxy may modify the service authorization information in the authentication and authorization answer that it forwards to the trusted non-3GPP access network, in order to enforce the QoS limitations according to the local policies and the roaming agreement with the home operator. +- The 3GPP AAA Proxy may decide about the trustworthiness of the non-3GPP access from the VPLMN point of view and insert a trust relationship indicator to the authentication and authorization request. +- If it supports the ER server functionality, the 3GPP AAA Proxy may decide about the use of ERP for re-authentication and indicate its willingness to act as the ER server for this session into the first authentication and authorization request forwarded to the 3GPP AAA server. + +The 3GPP AAA Proxy shall decide about using the S2a-PMIP based S8 chaining and in case it has selected that option, it shall select the Serving GW to be invoked and it shall add the Serving GW address to the authentication and authorization answer that is sent upon successful completion of the authentication. + +Table 6.1.2.1.1/1 describes the trusted non-3GPP access authentication and authorization request forwarded on the SWd interface. + +**Table 6.1.2.1.1-1: Trusted non-3GPP Access Authentication and Authorization Request on SWd** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|----------------------------------|----------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| User Identity | User-Name | M | This information element shall contain the identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15] and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]. This IE shall include the leading digit used to differentiate between authentication schemes. | +| EAP payload | EAP-payload | M | This IE shall contain the Encapsulated EAP payload used for the UE – 3GPP AAA Server mutual authentication | +| Authentication Request Type | Auth-Request-Type | M | This IE shall define whether the user is to be authenticated only, authorized only or both. AUTHORIZE_AUTHENTICATE shall be used in this case. | +| UE Layer-2 address | Calling-Station-ID | M | This IE shall contain the Layer-2 address of the UE. | +| Supported 3GPP QoS profile | QoS-Capability | O | If the trusted non-3GPP Access supports QoS mechanisms, this information element may be included to contain the access network's QoS capabilities as defined in IETF RFC 5777 [9]. | +| Mobility Capabilities | MIP6-Feature-Vector | C |

This information element shall contain the mobility capabilities of the trusted non-3GPP access network, if dynamic mobility mode selection is done. This information may also be used to decide whether to authorize access to EPC to a user accessing a TWAN.

The PMIP6_SUPPORTED flag and/or the GTPv2_SUPPORTED flag shall be set if the trusted non-3GPP access network supports PMIPv6 and/or GTPv2. PMIP6_SUPPORTED flag is defined in IETF RFC 5779 [2].

The flag MIP6_INTEGRATED shall be set if DHCPv6 based Home Agent address discovery is supported as defined in IETF RFC 5447 [6].

The MIP4_SUPPORTED flag shall be set if the trusted non-3GPP access supports MIPv4 FA-CoA mode.

| +| Access Type | RAT-Type | M | This IE shall contain the trusted non-3GPP access network technology type that is serving the UE. | +| Access Network Identity | ANID | M | This IE shall contain the access network identifier used for key derivation at the HSS. (See 3GPP TS 24.302 [26] for all possible values) | +| Visited Network Identifier | Visited-Network-Identifier | M | This IE shall contain the Identifier that allows the home network to identify the Visited Network. | +| Full Name for Network | Full-Network-Name | O | This IE shall contain the full name for network as specified in 3GPP TS 24.302 [26]. This AVP may be inserted by the non-3GPP access network depending on its local policy and only when it is not connected to the UE's Home Network. If the Visited Network Identifier is present, this AVP shall be set. | +| Short Name for Network | Short-Network-Name | O | This IE shall contain the short name for network as specified in 3GPP TS 24.302 [26]. This AVP may be inserted by the non-3GPP access network depending on its local policy and only when it is not connected to the UE's Home Network. If the Visited Network Identifier is present, this AVP shall be set. | +| APN Id | Service-Selection | O | If present, this information element shall contain the Network Identifier part of the APN the user wants to connect to (if available). | +| Terminal Information | Terminal-Information | O | If present, this information element shall contain information about the user's mobile equipment. The type of identity carried depends on the access technology type. For HRPD access network, the 3GPP2-MEID AVP shall be included in this grouped AVP. | +| Trust Relationship Indicator | AN-Trusted | O | If present, This AVP shall express the trusted/untrusted decision about the non-3GPP IP access, from the VPLMN's point of view. The value "TRUSTED" shall be used in this case. | +| Selected Trusted WLAN Identifier | WLAN-Identifier | O | If present, this IE shall contain the Trusted WLAN Identifier selected by the UE to access the Trusted WLAN Access Network (see clause 16 of 3GPP TS 23.402 [3]). | +| DER Flags | DER-Flags | O | This Information Element contains a bit mask. See 5.2.3.20 for the meaning of the bits. | + +| | | | | +|-----------------------------------------------|------------------------------|---|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Transport Access Type | Transport-Access-Type | C | For interworking with Fixed Broadband access networks (see 3GPP TS 23.139 [39]), if the access network needs to receive the IMSI of the UE in the authentication response, then this information element shall be present, and it shall contain the value "BBF" (see clause 5.2.3.19). | +| Supported TWAN Connection Modes | TWAN-Connection-Mode | O | The TWAN should include this IE.
If present, this information element shall contain the TWAN connection modes supported by the TWAN, i.e. TSCM, SCM and/or MCM. | +| Provided Connectivity Parameters | TWAN-Connectivity-Parameters | C | This information element shall be present if the 3GPP AAA Server has previously authorized the SCM to be used for EPC access.

TWAN-Connectivity-Parameters is a grouped AVP.

If the requested connectivity has been granted, the following information elements shall be included:
- selected APN
- selected PDN type
- UE IPv4 Address (for PDN type IPv4 or IPv4v6)
- UE IPv6 Interface Identifier (for PDN type IPv6 or IPv4v6)
- Protocol Configuration Options (if received from the PGW)
- TWAG user plane MAC address

The absence of both an IPv4 address and an IPv6 Interface Identifier indicates that the requested connectivity could not be granted. If the requested connectivity has not been granted, the following information elements may be included:
- a cause indicating why the requested connectivity has not been granted | +| TWAG Control Plane IP Address | TWAG-CP-Address | C | The TWAN shall include this IE if it indicates support of the MCM in the Supported TWAN Connection Modes IE. When present, this IE shall contain the TWAG Control Plane IPv4 Address, or the TWAG Control Plane IPv6 link local address, or both (if the TWAG supports IPv4 and IPv6), to be used for WLCP by the UE if the MCM is used. | +| Domain-Specific Re-authentication Key Request | ERP-RK-Request | O | If present, this IE indicates the willingness of an ER server in the non-3GPP access network or the 3GPP AAA proxy to act as the ER server for this session.

When present, this IE shall contain the name of the realm in which the ER server is located. | + +NOTE: For more details on the 3GPP AAA Proxy behaviour, refer to clause 5.1.2.1.3. + +#### 6.1.2.1.2 HSS/AAA Initiated Detach for Trusted non-3GPP Access + +When used in connection with the STa interface, the SWd interface shall support the HSS initiated detach procedure defined in clause 5.1.2.2. + +For this procedure, the 3GPP AAA Proxy shall forward the Diameter commands received from the 3GPP AAA Server and the access network GW as a stateful Diameter proxy. + +#### 6.1.2.1.3 Access and Service Authorization information update + +When used in connection with the STa interface, the SWd interface shall support the trusted non-3GPP access and service authorization information update procedure defined in clause 5.1.2.3. For this procedure, the 3GPP AAA Proxy shall forward the Diameter commands received from the 3GPP AAA Server and the trusted non-3GPP access network as a stateful Diameter proxy, with the following exceptions: + +- When forwarding an authentication and authorization request, the 3GPP AAA Proxy shall check the presence and value of the visited network identifier. If the AVP was missing, it shall insert it, if the AVP was present, it may overwrite the AVP value before forwarding the request. + +- The 3GPP AAA Proxy may modify the service authorization information in the authentication and authorization answer that it forwards to the trusted non-3GPP access network, in order to enforce the QoS limitations according to the local policies and the roaming agreement with the home operator. + +Table 6.1.2.1.3/1 describes the trusted non-3GPP access authorization request forwarded on the SWd interface. As the content is very similar to that of the request received on the STa interface, only those AVPs are listed that are handled differently on the two interfaces. + +**Table 6.1.2.1.3/1: Trusted Non-3GPP Access Authorization Request on SWd interface** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|----------------------------|----------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Permanent User Identity | User-Name | M | This information element shall contain the permanent identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15] and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]; this IE shall not include the leading digit prepended in front of the IMSI used to differentiate between authentication schemes. | +| Request-Type | Auth-Req-Type | M | This IE shall contain the Authorization Request Type. The following values only shall be used:
AUTHORIZE_ONLY
This value shall indicate the initial request for authorization of the user to the APN. | +| Visited Network Identifier | Visited-Network-Identifier | M | This IE shall contain an identifier that allows the home network to identify the Visited Network. | +| Routing Information | Destination-Host | M | This IE shall contain the 3GPP AAA Server name that is obtained from the Origin-Host AVP of a previously received message. | +| Supported 3GPP QoS profile | QoS-Capability | O | If the trusted non-3GPP Access supports QoS mechanisms, this information element may be included to contain the access network's QoS capabilities as defined in IETF RFC 5777 [9]. | +| Access Type | RAT-Type | O | If present, this IE contain the trusted non-3GPP access network access technology type that is serving the UE. | + +NOTE: For more details on the 3GPP AAA Proxy behaviour, refer to clause 5.1.2.3.3. + +#### 6.1.2.1.4 Trusted non-3GPP Access Network Initiated Session Termination + +When used in connection with the STa reference point, the SWd reference point shall support the access network initiated session termination procedures as defined in clause 5.1.2.4 + +For this procedure, the 3GPP AAA Proxy shall forward the Diameter commands received from the 3GPP AAA Server and the access network gateway as a stateful Diameter proxy. + +#### 6.1.2.2 Untrusted non-3GPP Access / ePDG related procedures + +When used in connection with the SWm reference point, the SWd reference point shall support the following procedures: + +- Authentication procedures as defined in clause 7.1.2.1 +- Authorization procedures as defined in clause 7.1.2.2 +- Access network/ePDG initiated session termination procedures as defined in clause 7.1.2.3 +- HSS/AAA initiated detach procedures as defined in clause 7.1.2.4 +- Service authorization information update procedures as defined in clause 7.1.2.5 + +For all these procedures, the 3GPP AAA Proxy shall forward the Diameter commands received from the 3GPP AAA Server and the ePDG as a stateful Diameter proxy, with the following exceptions: + +- The 3GPP AAA Proxy may reject an authentication or an authorization request, if roaming is not allowed for the users of the given HPLMN. + +- The 3GPP AAA Proxy may modify the service authorization information in the authorization answer that it forwards to the ePDG, in order to enforce the QoS limitations according to the local policies and the roaming agreement with the home operator. +- The 3GPP AAA Proxy shall decide about using the S8-S2b chaining and in case it has selected that option, it shall select the Serving GW to be invoked and it shall add the Serving GW address to the authentication answer that is sent upon successful completion of the authentication. + +NOTE: For more detailed behavior of the 3GPP AAA Proxy, refer to clauses 7.1.2.1.3 and 7.1.2.2.3 respectively. + +When used in connection with the SWa interface point, the SWd reference point shall support the following procedures: + +- Authentication and authorization procedure as defined in clause 4.1.2.1 +- HSS/AAA initiated detach procedures as defined in clause 4.1.2.2 +- Untrusted non-3GPP access network initiated detach procedures as defined in clause 4.1.2.3 +- Re-Authentication and Re-Authorization Procedure as defined in clause 4.1.2.4 + +For all these procedures, the 3GPP AAA Proxy shall forward the Diameter commands received from the 3GPP AAA Server and the untrusted non-3GPP access network as a stateful Diameter proxy, with the following exceptions: + +- The 3GPP AAA Proxy may reject an authentication and authorization request, if roaming is not allowed for the users of the given HPLMN. +- When forwarding an authentication and authorization request, the 3GPP AAA Proxy shall insert the visited network identifier. + +### 6.1.2.3 PDN GW related procedures + +When used in connection with the S6b reference point, the SWd reference point shall support the following procedures: + +- Authentication and authorization procedures when using DSMIP as defined in clause 9.1.2.1 +- Authorization procedures when using NBM as defined in clause 9.1.2.2 +- PDN GW initiated session termination procedures as defined in clause 9.1.2.3 +- HSS/AAA initiated detach procedures as defined in clause 9.1.2.4 +- Service authorization information update procedures as defined in clause 9.1.2.5 + +For all these procedures, the 3GPP AAA Proxy shall forward the Diameter commands received from the 3GPP AAA Server and the PDN GW as a stateful Diameter proxy, with the following exceptions: + +- The 3GPP AAA Proxy may reject an authentication or authorization request, if roaming is not allowed for the users of the given HPLMN +- The 3GPP AAA Proxy may modify the service authorization information in the authorization answers that it forwards to the PDN GW, in order to enforce the QoS limitations according to the local policies and the roaming agreement with the home operator. + +NOTE: For more detailed behavior of the 3GPP AAA Proxy, refer to clauses 9.1.2.1.4, 9.1.2.2.4, 9.1.2.3.4, and 9.1.2.4.4, respectively. + +## 6.2 Protocol Specification + +### 6.2.1 General + +The SWd reference point shall be based on Diameter, as defined in IETF RFC 6733 [58] and contain the following additions and extensions: + +- IETF RFC 4005 [4], which defines a Diameter protocol application used for Authentication, Authorization and Accounting (AAA) services in the Network Access Server (NAS) environment. +- IETF RFC 4072 [5], which provides a Diameter application to support the transport of EAP (IETF RFC 3748 [8]) frames over Diameter. +- IETF RFC 5779 [2], which defines Diameter extensions and application for PMIPv6 MAG to AAA and LMA to AAA interfaces. +- IETF RFC 5447 [6], which defines Diameter extensions for Mobile IPv6 NAS to AAA interface. + +There is no separate application ID defined for the SWd interface. The application ID used by the 3GPP AAA Proxy depends on the command sent over SWd. + +NOTE: Even though the 3GPP AAA Proxy may add new AVPs to the Diameter commands forwarded to/from the 3GPP AAA Server, there is no AVP present in the SWd reference point that would not be present in the interface that is used in connection with it. Therefore, the same Application ID can be used. + +## 6.2.2 Commands + +### 6.2.2.1 Commands used in connection with the STa interface + +#### 6.2.2.1.1 Commands for STa PMIPv6 or GTPv2 authentication and authorization procedures + +##### 6.2.2.1.1.1 Diameter-EAP-Request (DER) Command + +The Diameter-EAP-Request (DER) command, indicated by the Command-Code field set to 268 and the "R" bit set in the Command Flags field, is sent from a trusted non-3GPP access network NAS to a 3GPP AAA server. The ABNF is re-used from the IETF RFC 5779 [2]. + +``` +< Diameter-EAP-Request > ::= < Diameter Header: 268, REQ, PXY, 16777250 > + < Session-Id > + [ DRMP ] + { Auth-Application-Id } + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + [ Destination-Host ] + { Auth-Request-Type } + { EAP-Payload } + [ User-Name ] + [ Calling-Station-Id ] + ... + [ RAT-Type ] + [ ANID ] + [ QoS-Capability ] + [ MIP6-Feature-Vector ] + [ Visited-Network-Identifier ] + [ Service-Selection ] + [ Terminal-Information ] + [ AN-Trusted ] + [ Full-Network-Name ] + [ Short-Network-Name ] + *[ Supported-Features ] + [ WLAN-Identifier ] + [ DER-Flags ] + [ TWAN-Connection-Mode ] + [ TWAN-Connectivity-Parameters ] +``` + +``` + +* 2 [ TWAG-CP-Address ] +[ TWAN-S2a-Failure-Cause ] +[ ERP-RK-Request ] +... +*[ AVP ] + +``` + +#### 6.2.2.1.1.2 Diameter-EAP-Answer (DEA) Command + +The Diameter-EAP-Answer (DEA) command, indicated by the Command-Code field set to 268 and the "R" bit cleared in the Command Flags field, is sent from a 3GPP AAA server to a 3GPP AAA Proxy. The ABNF is re-used from the IETF RFC 5779 [2]. The ABNF also contains AVPs that are reused from IETF RFC 4072 [5]. + +``` + +< Diameter-EAP-Answer > ::= < Diameter Header: 268, PXY, 16777250 > + < Session-Id > + [ DRMP ] + { Auth-Application-Id } + { Result-Code } + [ Experimental-Result ] + { Origin-Host } + { Origin-Realm } + { Auth-Request-Type } + [ EAP-Payload ] + [ User-Name ] + [ Session-Timeout ] + [ Accounting-Interim-Interval ] + [ EAP-Master-Session-Key ] + [ Context-Identifier ] + [ APN-OI-Replacement ] + *[ APN-Configuration ] + [ MIP6-Feature-Vector ] + [ Mobile-Node-Identifier ] + *[ Redirect-Host ] ] + [ Trace-Info ] + [ Subscription-ID ] + *[ Supported-Features ] + [ DEA-Flags ] + [ TWAN-Connection-Mode ] + [ TWAN-Connectivity-Parameters ] + [ Terminal-Information ] + [ Key ] + [ ERP-Realm ] + ... + *[ AVP ] + +``` + +#### 6.2.2.1.2 Commands for STa HSS/AAA Initiated Detach for Trusted non-3GPP Access + +The ABNFs defined for the STa interface in clause 5.2.2.2 and in its clauses apply. + +#### 6.2.2.1.3 Commands for STa Access and Service Authorization Update Procedure + +The ABNFs defined for the STa interface in clause 5.2.2.3 and in its clauses apply. + +#### 6.2.2.1.4 Commands for Trusted non-3GPP Access network Initiated Session Termination + +The ABNFs defined for the STa interface in clause 5.2.2.4 and in its clauses apply. + +#### 6.2.2.2 Commands used in connection with the SWm interface + +The ABNFs defined for the SWm interface in clause 7.2.2 and in its clauses apply. + +### 6.2.2.3 Commands used in connection with the S6b interface + +The ABNFs defined for the S6b interface in clause 9.2.2 and in its clauses apply. + +## 6.2.3 Information Elements + +### 6.2.3.1 General + +The following table describes the Diameter AVPs defined for the SWd interface protocol in NBM mode, their AVP Code values, types, possible flag values and whether or not the AVP may be encrypted. + +For all AVPs which contain bit masks and are of the type Unsigned32, bit 0 shall be the least significant bit. For example, to get the value of bit 0, a bit mask of 0x00000001 should be used. + +**Table 6.2.3.1/1: Diameter SWd AVPs** + +| Attribute Name | AVP Code | Clause defined | Value Type | AVP Flag rules | | | | +|------------------------------|----------|----------------|-------------|----------------|-----|------------|----------| +| | | | | Must | May | Should not | Must not | +| MIP6-Feature-Vector | 124 | 5.2.3.3 | Unsigned64 | M | | | V,P | +| QoS-Capability | 578 | 5.2.3.4 | Grouped | M | | | V,P | +| RAT-Type | 1032 | 5.2.3.6 | Enumerated | M,V | | | P | +| ANID | 1504 | 5.2.3.7 | UTF8String | M,V | | | P | +| Service-Selection | 493 | 5.2.3.5 | UTF8String | M | | | V,P | +| Mobile-Node-Identifier | 506 | 5.2.3.2 | UTF8String | M | | | V,P | +| AN-Trusted | 1503 | 5.2.3.9 | Enumerated | M,V | | | P | +| Full-Network-Name | 1516 | 5.2.3.14 | OctetString | V | | | M,P | +| Short-Network-Name | 1517 | 5.2.3.15 | OctetString | V | | | M,P | +| WLAN-Identifier | 1509 | 5.2.3.18 | Grouped | V | | | M,P | +| APN-Configuration | 1430 | 8.2.3.7 | Grouped | M,V | | | P | +| Visited-Network-Identifier | 600 | 9.2.3.1.2 | OctetString | M,V | | | P | +| DER-Flags | 1520 | 5.2.3.20 | Unsigned32 | V | | | M,P | +| DEA-Flags | 1521 | 5.2.3.21 | Unsigned32 | V | | | M,P | +| SSID | 1524 | 5.2.3.22 | UTF8String | V | | | M,P | +| HESSID | 1525 | 5.2.3.23 | UTF8String | V | | | M,P | +| TWAN-Connection-Mode | 1527 | 5.2.3.25 | Unsigned32 | V | | | M,P | +| TWAN-Connectivity-Parameters | 1528 | 5.2.3.26 | Grouped | V | | | M,P | +| Connectivity-Flags | 1529 | 5.2.3.27 | Unsigned32 | V | | | M,P | +| TWAN-PCO | 1530 | 5.2.3.28 | OctetString | V | | | M,P | +| TWAG-CP-Address | 1531 | 5.2.3.29 | Address | V | | | M,P | +| TWAG-UP-Address | 1532 | 5.2.3.30 | UTF8String | V | | | M,P | +| TWAN-S2a-Failure-Cause | 1533 | 5.2.3.31 | Unsigned32 | V | | | M,P | + +NOTE 1: The AVP header bit denoted as "M", indicates whether support of the AVP is required. The AVP header bit denoted as "V", indicates whether the optional Vendor-ID field is present in the AVP header. For further details, see IETF RFC 6733 [58]. + +NOTE 2: If the M-bit is set for an AVP and the receiver does not understand the AVP, it shall return a rejection. If the M-bit is not set for an AVP, the receiver shall not return a rejection, whether or not it understands the AVP. If the receiver understands the AVP but the M-bit value does not match with the definition in this table, the receiver shall ignore the M-bit. + +The following table describes the Diameter AVPs re-used by the SWd interface protocol from existing Diameter Applications, including a reference to their respective specifications and when needed, a short description of their use within SWd. Other AVPs from existing Diameter Applications, except for the AVPs from Diameter base protocol defined in IETF RFC 6733 [58], do not need to be supported. + +**Table 6.2.3.1/2: SWd re-used Diameter AVPs** + +| Attribute Name | Reference | Comments | M-bit | +|-----------------------------|---------------------|-------------------------------------------------------------------------------------------|--------------| +| Accounting-Interim-Interval | IETF RFC 6733 [58] | | | +| Auth-Request-Type | IETF RFC 6733 [58] | | | +| Calling-Station-Id | IETF RFC 4005 [6] | | | +| Subscription-ID | IETF RFC 4006 [20] | | Must not set | +| EAP-Master-Session-Key | IETF RFC 4072 [5] | | | +| EAP-Payload | IETF RFC 4072 [5] | | | +| RAT-Type | 3GPP TS 29.212 [23] | | | +| Re-Auth-Request-Type | IETF RFC 6733 [58] | | | +| Session-Timeout | IETF RFC 6733 [58] | | | +| User-Name | IETF RFC 6733 [58] | | | +| Terminal-Information | 3GPP TS 29.272 [29] | | | +| APN-OI-Replacement | 3GPP TS 29.272 [29] | | | +| Supported-Features | 3GPP TS 29.229 [24] | See NOTE 1. | | +| Feature-List-ID | 3GPP TS 29.229 [24] | See NOTE 1. | | +| Feature-List | 3GPP TS 29.229 [24] | See NOTE 1. | | +| PDN-Type | 3GPP TS 29.272 [29] | | | +| Served-Party-IP-Address | 3GPP TS 32.299 [30] | | | +| DRMP | IETF RFC 7944 [53] | See clause 8.2.3.25 | Must not set | +| ERP-RK-Request | IETF RFC 6942 [57] | | Must not set | +| ERP-Realm | IETF RFC 6942 [57] | | Must not set | +| Key | IETF RFC 6734 [56] | This is a grouped AVP containing Key-Type, Keying-Material and, optionally, Key-Lifetime. | Must not set | + +NOTE 1: There is no separate Diameter application ID defined for the SWd interface so a separate supported feature list is not required. The supported features depend on the command being proxied over SWd. + +NOTE 2: The M-bit settings for re-used AVPs override those of the defining specifications that are referenced. Values include: "Must set", "Must not set". If the M-bit setting is blank, then the defining specification applies. + +NOTE 3: If the M-bit is set for an AVP and the receiver does not understand the AVP, it shall return a rejection. If the M-bit is not set for an AVP, the receiver shall not return a rejection, whether or not it understands the AVP. If the receiver understands the AVP but the M-bit value does not match with the definition in this table, the receiver shall ignore the M-bit. + +Only those AVP initially defined in this reference point and for this procedure are described in the following subchapters. + +## 7 SWm Description + +### 7.1 Functionality + +#### 7.1.1 General + +The SWm reference point is defined between the ePDG and the 3GPP AAA Server or between the ePDG and the 3GPP AAA Proxy. The definition of the reference point and its functionality is given in 3GPP TS 23.402 [3]. + +The SWm reference point shall be used to authenticate and authorize the UE. + +The SWm reference point is also used to transport NBM related mobility parameters in a case the UE attaches to the EPC via the S2b (based on PMIPv6 or GTPv2) and SWn reference points (i.e. IP Mobility Mode Selection information). + +Additionally the SWm reference point may also be used to transport DSMIPv6 related mobility parameters in case the UE attaches to the EPC using the S2c reference point. In particular, in this case the SWm reference point may be used + +for conveying the Home Agent IP address or FQDN from the AAA server to the ePDG for Home Agent discovery based on IKEv2 (see TS 24.303 [13]). + +## 7.1.2 Procedures Description + +### 7.1.2.1 Authentication and Authorization Procedures + +#### 7.1.2.1.1 General + +The authentication and authorization procedure shall be used between the ePDG and 3GPP AAA Server/Proxy. When a PDN connection is activated by the UE an IKEv2 exchange shall be initiated. It shall be invoked by the ePDG, on receipt from the UE of a "tunnel establishment request" message. This shall take the form of forwarding an IKEv2 exchange with the purpose of authenticating in order to set up an IKE Security Association (SA) between the UE and the ePDG. + +During the Access Authentication and Authorization procedure the ePDG may provide information on its PMIPv6 or GTPv2 capabilities to the 3GPP AAA Server. The 3GPP AAA Server may perform IP mobility mode selection between NBM or HBM as specified in clause 4.1.3.2 of 3GPP TS 23.402 [3]. The 3GPP AAA Server may provide to the ePDG an indication if either NBM or local IP address assignment shall be used. If NBM shall be used, the ePDG then decides the S2b protocol variant to use. + +The User-Name AVP may contain a decorated NAI (as defined in clause 19.3.3 of 3GPP TS 23.003 [14]). In this case the 3GPP AAA Proxy shall process the decorated NAI and support routing of the Diameter request messages based on the decorated NAI as described in IETF RFC 5729 [37]. + +Upon a successful authorization, when NBM is used, the 3GPP AAA server shall return NBM related information back to the ePDG. This information may include the assigned PDN GW, UE IPv6 HNP and/or UE IPv4-HoA. + +Upon a successful authorization, when DSMIPv6 is used, to enable HA address discovery based on IKEv2 (see TS 24.303 [13]), the 3GPP AAA server may also download PDN GW identity to the ePDG. + +The PDN GW identity is a FQDN and/or IP address of the PDN GW. If a FQDN is provided, the ePDG shall derive it to IP address according to the selected mobility management protocol. + +If DSMIPv6 is used, a single IKE SA is used for all PDN connections of the user. If PMIPv6 or GTPv2 is used, a separate IKE SA is created for each PDN connection of the user (refer to 3GPP TS 24.302 [26]). + +Each new additional IKE SA shall be handled in a different Diameter session. In such cases, the IP mobility mode selected during the first authentication and authorization procedure is valid for all PDN connections of the user, therefore, dynamic IP mobility mode selection is not executed during the further procedures. The ePDG may select the same or different S2b protocol variant(s) towards different PDN GWs when NBM has been selected. + +Based on local policies, EPC access for emergency services over an untrusted WLAN access is supported as specified in clause 4.5.7.2.1 of 3GPP TS 23.402 [3] for: + +- UEs with a valid EPC subscription that are authenticated and authorized for EPC services; +- UEs that are authenticated only; +- UEs with an unauthenticated IMSI; and/or +- UICC-less UEs. + +The SWm reference point shall perform authentication and authorization based on the reuse of the DER/DEA command set defined in Diameter EAP application, IETF RFC 4072 [5]. + +**Table 7.1.2.1.1/1: Authentication and Authorization Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|----------------------------------------------|----------------------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| User Identity | User-Name | M | This information element shall contain the identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15] and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]. This IE shall include the leading digit used to differentiate between authentication schemes, if it contains a NAI other than an Emergency NAI for Limited Service State. | +| EAP payload | EAP-Payload | M | This information element shall contain the encapsulated EAP payload used for the UE - 3GPP AAA Server mutual authentication | +| Authentication Request Type | Auth-Request-Type | M | This information element shall indicate whether the user is to be authenticated only, authorized only or both. It shall have the value of AUTHORIZE_AUTHENTICATE. | +| APN | Service-Selection | C | This information element shall contain the Network Identifier part of the APN for which the UE is requesting authorization. This AVP shall be present if the ePDG has received an APN from the UE and the UE did not indicate the establishment of an emergency session in the IKEv2 signalling. This AVP shall be absent if the UE indicated the establishment of an emergency session during the IKEv2 tunnel establishment (see clause 7.2.5 of 3GPP TS 24.302 [26]). | +| Visited Network Identifier (See 9.2.3.1.2) | Visited-Network-Identifier | C | This information element shall contain the identifier that allows the home network to identify the Visited Network.
This AVP shall be present if the ePDG is not in the UE's home network i.e. the UE is roaming. | +| Access Type | RAT-Type | C | This information element shall be present if the access type is known by the ePDG. If present, it shall contain the non-3GPP access network access technology type that is serving the UE. When not known by the ePDG, this information element should be present and, in that case, it shall take the value VIRTUAL (1). | +| Mobility features | MIP6-Feature-Vector | O | This AVP shall be present, if the handling of any of the flags listed here requires dynamic (i.e. per user) handling for the VPLMN-HPLMN relation of the ePDG and 3GPP AAA Server. If present, the AVP shall contain the mobility features supported by the ePDG. Flags that are not relevant in the actual relation shall be set to zero.
If dynamic IP mobility mode selection is used, the PMIP6_SUPPORTED flag and/or the GTPv2_SUPPORTED flag shall be set by the ePDG if PMIPv6 and/or GTPv2 are supported. PMIP6_SUPPORTED flag is defined in IETF RFC 5779 [2].
The MIP6_INTEGRATED flag shall be used to indicate to the 3GPP AAA server that the ePDG supports IKEv2 based Home Agent address discovery. | +| AAA Failure Indication | AAA-Failure-Indication | O | If present, this information element shall indicate that the request is sent after the ePDG has determined that a previously assigned 3GPP AAA Server is unavailable. | +| Supported Features (See 3GPP TS 29.229 [24]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host for the lifetime of the Diameter session. | +| UE local IP address | UE-Local-IP-Address | O | The ePDG shall include this IE based on local policy for Fixed Broadband access network interworking as specified in 3GPP TS 23.139 [39].
The ePDG may also include this IE, regardless of Fixed Broadband access network interworking.
If present, it shall contain the source IPv4 or IPv6 address of the IKE_SA_AUTH message from the UE. | +| Terminal Information | Terminal-Information | C | The ePDG shall include this IE and set it to the user's Mobile Equipment Identity, if this information is available.
For an untrusted WLAN access, this grouped AVP shall contain the IMEI AVP and, if available, the Software-Version AVP.
When the RAT type is not known by the ePDG, but the UE has provided the IMEI(SV), this grouped AVP shall contain the IMEI AVP and, if available, the Software-Version AVP. | +| Emergency Services | Emergency-Services | C | An ePDG which supports emergency services shall include this information element, with the Emergency-Indication bit set, if the UE indicated the establishment of an emergency session during the IKEv2 tunnel establishment (see clause 7.2.5 of 3GPP TS 24.302 [26]). | + +**Table 7.1.2.1.1/2: Authentication and Authorization Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|-----------------------------|----------------------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| User Identity | User-Name | O | This information element, if present, shall contain the identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15] and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]. This IE shall include the leading digit used to differentiate between authentication schemes, if it contains a NAI other than an Emergency NAI for Limited Service State. | +| EAP payload | EAP-Payload | O | If present, this information element shall contain the encapsulated EAP payload used for UE - 3GPP AAA Server mutual authentication | +| Master-Session-Key | EAP-Master-Session-Key | C | This IE shall contain keying material for protecting the communication between the user and the ePDG. It shall be present when Result Code is set to DIAMETER_SUCCESS. | +| Authentication Request Type | Auth-Request-Type | M | It shall contain the value AUTHORIZE_AUTHENTICATE. See IETF RFC 4072 [5]. | +| Result code | Result-Code / Experimental-Result-Code | M | This IE shall contain the result of the operation. The Result-Code AVP shall be used for errors defined in the Diameter base protocol (see IETF RFC 6733 [58]) or as per in NASREQ (see IETF RFC 4005 [4]). | +| 3GPP AAA Server URI | Redirect-Host | C | This information element shall be sent if the Result-Code value is set to DIAMETER_REDIRECT_INDICATION. When the user has previously been authenticated by another 3GPP AAA Server, it shall contain the Diameter URI of the 3GPP AAA Server currently serving the user. The node receiving this IE shall behave as defined in the Diameter base protocol (see IETF RFC 6733 [58]). The command shall contain zero or more occurrences of this information element. When choosing a destination for the redirected message from multiple Redirect-Host AVPs, the receiver shall send the Diameter request to the first 3GPP AAA Server in the ordered list received in the Diameter response. If no successful response to the Diameter request is received, the receiver shall send the Diameter request to the next 3GPP AAA Server in the ordered list. This procedure shall be repeated until a successful response is received from a 3GPP AAA Server. | +| Mobility Capabilities | MIP6-Feature-Vector | O | This AVP shall be present if it was received in the authentication and authorization request and the authentication and authorization succeeded. It shall contain the authorized mobility features. Flags that are not relevant in the actual relation shall be set to zero. The PMIP6_SUPPORTED flag and/or the GTPv2_SUPPORTED flag shall be set to indicate that NBM (PMIPv6 or GTPv2) is to be used. The ASSIGN_LOCAL_IP flag shall be set to indicate that a local IP address is to be assigned. The MIP6_INTEGRATED flag shall be set if a Home Agent address is provided for IKEv2 based Home Agent address discovery. In the latter case HA information for IKEv2 discovery is provided via the APN-Configuration AVP. | +| APN-OI replacement | APN-OI-Replacement | C | This AVP shall indicate the domain name to replace the APN-OI in the non-roaming case or in the home routed roaming case when constructing the PDN GW FQDN upon which it needs to perform a DNS resolution. See 3GPP TS 23.003 [3]. It shall only be included if NBM is used, the Emergency-Indication bit of the Emergency-Services AVP is not set in the Authentication and Authorization Request and the Result-Code AVP is set to DIAMETER_SUCCESS. | +| APN and PGW Data | APN-Configuration | C | This information element shall only be sent if the Result-Code AVP is set to DIAMETER_SUCCESS and the Emergency-Indication bit of the Emergency-Services AVP is not set in the Authentication and Authorization Request. The APN-Configuration is a grouped AVP, defined in 3GPP TS 29.272 [29]. When NBM is used, the following information elements per APN may be included:
- APN
- APN-AMBR
- Authorized 3GPP QoS Profile
- User home IP Address (if static IPv4 and/or IPv6 is allocated to the UE's subscribed APN)
- Allowed PDN types
- PDN GW identity (if the PDN connection was active in case of HO, or if there is a static PDN GW allocated to the UE's subscribed APN)
- PDN GW allocation type
- VPLMN Dynamic Address Allowed | + +| | | | +|--|--|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | |
  • - Visited Network Identifier
  • - Interworking-5GS-Indicator

When local IP address assignment is used, this AVP shall only be present if IKEv2 based Home Agent discovery is used and

  • - if the PDN connection was active in case of HO, or
  • - if there is static PDN GW allocated to the UE's subscribed APN, or
  • - if the 3GPP AAA Server/Proxy selects the PDN GW based on the identity of the ePDG

In these cases, the following information elements shall be included:

  • - HA-APN (Home Agent APN as defined in 3GPP TS 23.003 [14])
  • - PDN GW identity

NOTE 1.

| +|--|--|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +| | | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------|---|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Trace information | Trace-Info | C | This AVP shall be included if the subscriber and equipment trace has been activated for the user in the HSS and signalling based activation is used to download the trace activation from the HSS to the ePDG.
Only the Trace-Data AVP shall be included to the Trace-Info AVP and shall contain the following AVPs:
- Trace-Reference
- Trace-Depth
- Trace-Event-List, for PGW
- Trace-Collection-Entity
The following AVPs may also be included in the Trace-Data AVP:
- Trace-Interface-List, for PGW, if this AVP is not present, trace report generation is requested for all interfaces for PGW listed in 3GPP TS 32.422 [32]
- Trace-NE-Type-List, with the only allowed value being "PDN GW". If this AVP is not included, trace activation in PDN GW is required. | +| MSISDN | Subscription-ID | C | This AVP shall contain the MSISDN of the UE and shall be sent only if it is available. | +| Session time | Session-Timeout | C | If the authorization succeeded, then this IE shall contain the time this authorization is valid for. | +| Permanent User Identity | Mobile-Node-Identifier | C | This information element shall be present if NBM is used.

If the user is authenticated, it shall contain an AAA/HSS assigned permanent user identity (i.e. IMSI in root NAI format as defined in clause 19 of 3GPP TS 23.003 [14]) to be used by:
- the MAG in subsequent PBUs as the MN-ID identifying the user in the EPS network for PMIP based S2b,
- by the ePDG to derive the IMSI to send in subsequent Create Session Request for GTP based S2b.

For an emergency PDN connection, if the UE is UICC-less (i.e. the User Identity IE in the request contains an IMEI) or if the IMSI is not authenticated, the Permanent User Identity shall contain the IMEI in Emergency NAI for Limited Service State format as defined in clause 19 of 3GPP TS 23.003 [14].

If this IE contains an identity based on IMSI, this IE shall not include the leading digit prepended in front of the IMSI used to differentiate between authentication schemes. | +| Serving GW Address | MIP6-Agent-Info | O | This AVP shall be used only in chained S2b-S8 cases and it shall be sent only if the Result-Code AVP is set to DIAMETER_SUCCESS. | +| UE Charging Data | 3GPP-Charging-Characteristics | O | This information element contains the type of charging method to be applied to the user (see 3GPP TS 29.061 [31]). | +| Supported Features (See 3GPP TS 29.229 [24]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host for the lifetime of the Diameter session. | +| WLAN Location Information | Access-Network-Information | O | If present, this IE shall contain the location information of the WLAN Access Network where the UE is attached. | +| WLAN Location Timestamp | User-Location-Info-Time | C | This IE should be present if the WLAN Location Information IE is present. When present, this IE shall contain the NTP time at which the UE was last known to be in the location reported in the WLAN Location Information. | +| Emergency Info | Emergency-Info | C | This IE shall only be present if the Result-Code AVP is set to DIAMETER_SUCCESS. When present, it shall contain the identity of the dynamically allocated PDN-GW used for the establishment of emergency PDN connections. It shall be present for a non-roaming authenticated user, if this information was received from the HSS and if the Emergency-Services AVP is present, with the Emergency-Indication bit set, in the Authentication and Authorization Request. | +| UE Usage Type | UE-Usage-Type | C | This IE shall be present if this information is available in the user subscription. When present, this IE shall contain the UE Usage Type of the subscriber. | +| Core Network Restrictions | Core-Network-Restrictions | C | This IE shall be present if this information is available in the user subscription. When present, this IE shall contain the Core Network Restrictions of the subscriber. | +| NOTE 1: If a static PDN GW allocated to the UE's subscribed APN has been received from the HSS, the 3GPP AAA Server/Proxy shall only provide the static PDN GW identity in the Authentication and Authorization Answer. | | | | + +#### 7.1.2.1.2 3GPP AAA Server Detailed Behaviour + +On receipt of the DER message, the 3GPP AAA Server shall check that the user data exists in the 3GPP AAA Server. If not, the 3GPP AAA Server shall use the procedures defined for the SWx interface to obtain access authentication and authorization data. + +If the HSS returns DIAMETER\_ERROR\_USER\_UNKNOWN, the 3GPP AAA Server shall return the same error to the ePDG. + +If the HSS indicates that the user is currently being served by a different 3GPP AAA Server, the 3GPP AAA Server shall respond to the ePDG with the Result-Code set to DIAMETER\_REDIRECT\_INDICATION and Redirect-Host set to the Diameter URI of the 3GPP AAA Server currently serving the user (this Diameter URI shall be constructed based on the Diameter Identity included in the 3GPP-AAA-Server-Name AVP returned in the SWx authentication response from the HSS). + +Otherwise, the 3GPP AAA Server shall proceed with the authentication and authorization procedure. The 3GPP AAA Server shall use the procedures defined in SWx interface to obtain authorization data from HSS. + +If IMEI check is required by operator policy and the ePDG is in the HPLMN, the 3GPP AAA Server shall: + +- if the IMEI(SV) is available, check the Mobile Equipment's identity status with the EIR, using the ME Identity Check procedure (see clause 11); +- upon getting the IMEI check result from the EIR, determine whether to continue or stop the authentication and authorization procedure; +- if the IMEI(SV) is not available, determine whether to continue or stop the authentication and authorization procedure based on operator policy; +- if the 3GPP AAA Server determines that the authentication and authorization procedure shall be stopped, it shall respond to the ePDG with the Experimental-Result-Code DIAMETER\_ERROR\_ILLEGAL\_EQUIPMENT. + +Specific operator policies may be configured for emergency services, regarding whether to check the IMEI and, if the IMEI needs to be checked, whether to continue or stop the authentication and authorization procedure upon getting the IMEI check result or when the IMEI(SV) is not available. + +If the 3GPP AAA Server receives a request message not related to any existing session and is able to recognize that the ePDG included the AAA-Failure-Indication AVP in the request, the 3GPP AAA Server shall also include the AAA-Failure-Indication AVP over the SWx interface, while retrieving the access authentication and authorization data from the HSS. + +If the user does not have non-3GPP access subscription, then 3GPP AAA Server shall respond to the ePDG with Experimental-Result-Code DIAMETER\_ERROR\_USER\_NO\_NON\_3GPP\_SUBSCRIPTION. + +If a Visited- Network-Identifier is present in the request and if the user is not allowed to roam in the visited network, then the 3GPP AAA Server shall return Experimental-Result-Code set to DIAMETER\_ERROR\_ROAMING\_NOT\_ALLOWED. + +If the user is not allowed to use the current access type, then the 3GPP AAA Server shall return Experimental-Result-Code set to DIAMETER\_ERROR\_RAT\_TYPE\_NOT\_ALLOWED. + +Otherwise the 3GPP AAA Server shall run EAP-AKA as specified in 3GPP TS 33.402 [19]. Exceptions to the cases specified here shall be treated by 3GPP AAA Server as error situations, the Result-Code shall be set to DIAMETER\_UNABLE\_TO\_COMPLY and, therefore, no authentication information shall be returned. + +Upon receiving the authentication and authorization request from the ePDG, the 3GPP AAA Server marks the trust relationship as "untrusted" with the User Identity. If the 3GPP AAA Server detects that an S6b session already exists for this UE and the S6b session was established as a result of an authentication request for DSMIPv6, the 3GPP AAA Server shall send the trust relationship to the PDN GW as specified in clause 9.1.2.5. + +Once authentication is successfully completed, the 3GPP AAA Server shall perform the following authorization checking (if there is an error in any of the steps, the 3GPP AAA Server shall stop processing and return the corresponding error code): + +- 1) Check if the user is barred to use the non 3GPP Access. If it is so, then the Result-Code shall be set to DIAMETER\_AUTHORIZATION\_REJECTED +- 2) Check whether the user is barred to use the subscribed APNs. If it is so, Result-Code shall be set to DIAMETER\_AUTHORIZATION\_REJECTED. +- 3) if the Emergency-Indication bit of the Emergency-Services AVP is not set in the Authentication and Authorization Request, check if there was request for an APN received. If not, the default APN of the user is selected to be used during the actual authentication and authorization procedure. +- 4) if the Emergency-Indication bit of the Emergency-Services AVP is not set in the Authentication and Authorization Request, check if user has a subscription for the requested APN or for the wildcard APN. If not, Experimental-Result-Code shall be set to DIAMETER\_ERROR\_USER\_NO\_APN\_SUBSCRIPTION +- 5) If present, check the flags of the received MIP6-Feature-Vector AVP: The evaluation of the flags is executed only in the first authentication and authorization procedure for the user after an initial attach or handover, in all the subsequent procedures, the AAA Server shall insert the same values. + - If the MIP6-INTEGRATED flag is set and the 3GPP AAA server has authorized IKEv2 Home Agent assignment, the 3GPP AAA server shall include the Home Agent addresses in the APN-Configuration AVP in the response and the MIP6-Feature-Vector AVP with the MIP6-INTEGRATED flag set. In this case, the 3GPP AAA Server may select the Home Agent based on the identity of the ePDG as included in the Origin-Host AVP in the authentication and authorization request if no static PDN GW identity is received from the HSS. If the HA assignment via IKEv2 is not used, the MIP6-Feature-Vector AVP with the MIP6-INTEGRATED flag not set shall be sent. + - The PMIP6\_SUPPORTED and/or GTPv2\_SUPPORTED flag indicates to the 3GPP AAA server whether the ePDG supports NBM or not. As specified in 3GPP TS 23.402 [3], based on the information it has regarding the UE (see 3GPP TS 24.302 [26]), local/home network capabilities and local/home network policies, the 3GPP AAA server may perform mobility mode selection. If the 3GPP AAA server decides that NBM should be used, the PMIP6\_SUPPORTED and GTPv2\_SUPPORTED flags shall be set in the response to indicate the NBM support of the UE to the ePDG. If only the PMIP6\_SUPPORTED or the GTPv2\_SUPPORTED flag is present in the response, the ePDG shall assume that this also indicates the NBM support of the UE to the ePDG and the ePDG may select any S2b protocol variant (PMIPv6 or GTPv2). If the 3GPP AAA server decides that a local IP address should be assigned, the ASSIGN\_LOCAL\_IP flag shall be set in the response to indicate to the ePDG that a local IP address should be assigned. + +NOTE 1: When selecting DSMIPv6, the AAA server assumes that the ePDG has the capability to assign a local IP address to the UE. + +- The 3GPP AAA server shall not set the PMIP6\_SUPPORTED/GTPv2\_SUPPORTED and ASSIGN\_LOCAL\_IP flags both at the same time in the response. + +Upon successful authentication and authorization, the Result-Code shall be set to DIAMETER\_SUCCESS and: + +- if the Emergency-Indication bit of the Emergency-Services AVP was not set in the Authentication and Authorization Request, the 3GPP AAA Server shall return user data relevant to the APN as received from the HSS. If the requested APN received from UE is authorized by the wildcard APN, the 3GPP AAA Server shall include the wildcard APN in the Service-Selection AVP of the APN-Configuration AVP; +- if the Emergency-Services AVP was present, with the Emergency-Indication bit set, in the Authentication and Authorization Request, the 3GPP AAA Server shall include the Emergency Info IE if this information was received from the HSS and the user is not roaming. + +Exceptions to the cases specified here shall be treated by 3GPP AAA Server as error situations, the Result-Code shall be set to DIAMETER\_UNABLE\_TO\_COMPLY and, therefore, no authorization information shall be returned. + +For Fixed Broadband access network interworking as specified in 3GPP TS 23.139 [39], the 3GPP AAA server shall determine if the UE is connected via a BBF-defined WLAN access according to the UE local IP address in UE-Local-IP-Address AVP from the ePDG. If the UE is connected via a BBF-defined WLAN access, the 3GPP AAA server shall perform the enabling UE reflective QoS function as specified in 3GPP TS 24.139 [43]. + +The 3GPP AAA Server shall interpret the receipt of the Emergency-Services AVP, with the Emergency-Indication bit set, as an indication that the UE requests to access the EPC for emergency services. + +The 3GPP AAA Server shall give preferential treatment to UEs which access the EPC for emergency services, e.g. in scenarios including network overload. + +If the 3GPP AAA Server has WLAN Location Information about the UE, the 3GPP AAA Server shall provide it to the ePDG, along with the WLAN Location Timestamp if available (see clause 4.1.2.1.2). + +If the 3GPP AAA Server supports IMS Emergency sessions over WLAN (see clause 4.5.7.2 of 3GPP TS 23.402 [3]), the 3GPP AAA Server shall proceed as specified above, but with the following modifications, for an Emergency Attach: + +- 1) if the UE does not have an IMSI: + - if local policies allow emergency sessions for all UEs, the 3GPP AAA Server shall skip the procedures defined for the SWx interface to obtain access authentication and authorization data, skip the authorization checkings and authorize the UE to access to EPC for emergency services. The Permanent User Identity IE in the answer shall contain the IMEI in Emergency NAI for Limited Service State format as defined in clause 19 of 3GPP TS 23.003 [14]; + - otherwise the 3GPP AAA Server shall reject the request with the Experimental-Result-Code set to DIAMETER\_ERROR\_USER\_UNKNOWN. +- 2) if the UE has an IMSI but the IMSI is not authenticated: + - if local policies allow emergency sessions for unauthenticated UEs with an IMSI, the 3GPP AAA Server shall skip the procedures defined for the SWx interface to obtain access authorization data, shall skip the authorization checkings and shall return an answer with the DIAMETER\_ERROR\_USER\_UNKNOWN Result-Code to the ePDG to request the UE to provide its IMEI as specified in clause 13.3 of 3GPP TS 33.402 [19]. + +NOTE 2: According to the procedure specified in clause 7.4.4 of 3GPP TS 24.302 [26], this results in an ePDG, that is configured to support unauthenticated emergency session over WLAN and Mobile Equipment Identity signalling over untrusted WLAN, to query the UE's IMSI and to initiate a new Authentication and Authorization procedure with the same parameters as provided in the first Authentication and Authorization Request but with the addition of the UE's IMEI in the Terminal-Information AVP. + +If the Authentication and Authorization Request also included the UE's IMEI (i.e. new authentication and authorization procedure after the ePDG queried the UE), the 3GPP AAA Server shall authorize the UE to access to EPC for emergency services. The Permanent User Identity IE in the answer shall contain the IMEI in Emergency NAI for Limited Service State format as defined in clause 19 of 3GPP TS 23.003 [14]; + +- otherwise the 3GPP AAA Server shall reject the request with the Experimental-Result-Code set as specified for authentication failures in this clause. +- 3) if the UE has an authenticated IMSI but the UE is not authorized to access the EPC: + - if local policies allow emergency sessions for any authenticated UE, the 3GPP AAA Server shall authorize the UE to access to EPC for emergency services; + - otherwise the 3GPP AAA Server shall reject the request with the Experimental-Result-Code set as specified for authorization failures in this clause. + +### 7.1.2.1.3 3GPP AAA Proxy Detailed Behaviour + +The 3GPP AAA Proxy shall be required to handle roaming cases in which the ePDG is in the VPLMN. The 3GPP AAA Proxy shall act as a stateful proxy with the following additions. + +If IMEI check is required by operator policy and the ePDG is in the VPLMN, the 3GPP AAA Proxy shall: + +- if the IMEI(SV) is available, check the Mobile Equipment's identity status with the EIR, using the ME Identity Check procedure (see clause 11); +- upon getting the IMEI check result from the EIR, determine whether to continue or stop the authentication and authorization procedure; + +- if the IMEI(SV) is not available, determine whether to continue or stop the authentication and authorization procedure based on operator policy; +- if the 3GPP AAA Proxy determines that the authentication and authorization procedure shall be stopped, it shall: + - respond to the ePDG with the Experimental-Result-Code DIAMETER\_ERROR\_ILLEGAL\_EQUIPMENT, and + - send a SWm Session Termination Request towards the 3GPP AAA Server (see clause 7.1.2.3). + +Specific operator policies may be configured for emergency services, regarding whether to check the IMEI and, if the IMEI needs to be checked, whether to continue or stop the authentication and authorization procedure upon getting the IMEI check result or when the IMEI(SV) is not available. + +On receipt of the first authentication and authorization request, the 3GPP AAA Proxy shall check locally configured information whether users from the HPLMN are allowed to activate a PDN connection from the non-3GPP access network via this (V)PLMN. If not, the Experimental-Result-Code shall be set to DIAMETER\_ERROR\_ROAMING\_NOT\_ALLOWED and the authentication response shall be sent to the ePDG. + +On receipt of the authentication and authorization answer that completes a successful authentication, the 3GPP AAA Proxy + +- may check locally configured information about using the chained S8-S2b option towards the given HPLMN. If chaining is required, the 3GPP AAA Proxy shall select a Serving GW from its network configuration database and shall include the Serving GW address in the response. +- shall check locally configured information for the maximum allowed static QoS parameters valid for visitors from the given HPLMN and modify the QoS parameters received from the 3GPP AAA Server, to enforce the policy limitations. +- shall record the state of the connection (i.e. Authorization Successful). +- may select the Home Agent based on the identity of the ePDG as included in the Origin-Host AVP in the authentication and authorization request if IKEv2 based Home Agent discovery is used and VPLMN Dynamic Address Allowed AVP is received. In this case, the 3GPP AAA proxy shall include the Home Agent addresses in the APN-Configuration AVP in the response and the MIP6-Feature-Vector AVP with the MIP6-INTEGRATED flag set if no static PDN GW identity is received from the 3GPP AAA Server. + +#### 7.1.2.1.4 ePDG Detailed Behaviour + +The ePDG shall initiate a new authentication and authorization procedure for each new IKE\_SA. Each IKE\_SA shall be handled in a different session. + +The ePDG shall set flags signalling its capabilities to the same value in all authentication and authorization procedure for the same user (include the same MIP6-Feature-Vector). During the second and further authentication and authorization procedures, the ePDG shall discard the flag values received from the AAA Server and reuse the values received during the first procedure executed for the user. + +An ePDG which supports emergency services shall include the Emergency-Services AVP, with the Emergency-Indication bit set, if the UE indicated the establishment of an emergency session during the IKEv2 tunnel establishment (see clause 7.2.5 of 3GPP TS 24.302 [26]). + +For PMIPv6/GTPv2 based S2b, when receiving a Serving GW address in an authentication response, the ePDG shall check, whether it has already a Serving GW address stored for the user. + +- If it has no Serving GW address available, it shall store the received value and use it as LMA address when creating PMIP bindings. +- If it has already a stored Serving GW address value, it shall ignore the received SGW-Address AVP. + +NOTE 1: In case of untrusted access, there is an authentication session started for all PDN connection setup requests of a user. These sessions may invoke different 3GPP AAA Proxies, which in turn may assign different Serving GWs to the user. The ePDG behaviour ensures that in spite of this possibility, the same Serving GW is used for all PDN connections of the user. + +NOTE 2: The ePDG knows if NBM is used or if a local IP address is assigned based on the flags in the MIP6-Feature-Vector or based on preconfigured information. If the PMIP6\_SUPPORTED and/or the GTPv2\_SUPPORTED flag are set in the MIP6-Feature-Vector received from the 3GPP AAA Server, the ePDG knows that NBM is used. + +For PMIPv6/GTPv2 based S2b and a PDN connection other than for emergency services, the ePDG shall utilize the downloaded APN configuration data to authorize the UE requested home address types: IPv4 home address and/or IPv6 home network prefix. + +For GTPv2 based S2b and a PDN connection for emergency services, the ePDG shall ignore APN configuration data received from the 3GPP AAA Server and shall use its Emergency Configuration Data to determine the APN to be associated with the emergency PDN connection and possibly the PGW to use (see clause 4.5.7.2 of 3GPP TS 23.402 [3]). During a handover of an emergency PDN connection to an untrusted WLAN access, the ePDG shall use the PGW identified in the Emergency Info IE if this information is received from the 3GPP AAA Server, the user is a non-roaming authenticated user and the ePDG is configured to use a dynamic PGW for emergency services for such users. + +The ePDG may use the Visited\_Network\_Identifier to determine the S2b protocol type (PMIPv6 or GTPv2). The ePDG may be configured with the S2b protocol variant(s) on a per HPLMN granularity, or may retrieve information regarding the S2b protocol variants supported by the PDN GW (PMIPv6 or/and GTPv2) from the Domain Name Service Function as described in 3GPP TS 29.303[34]. If the ePDG supports Dedicated Core Networks and received the UE-Usage-Type from the 3GPP AAA Server, the ePDG shall select the PGW as specified in clause 5.8 of 3GPP TS 29.303 [34]. + +The ePDG shall select a combined PGW/SMF for PDN connections that may be subject to mobility to 5GS, e.g. for UEs supporting N1 mode (see 3GPP TS 24.302 [26]) and not restricted to interworking with 5GS by user subscription (see "5GC" bit within Core-Network-Restrictions AVP and Interworking-5GS-Indicator AVP specified) as specified in clause 5.12.3 of 3GPP TS 29.303 [34]. + +If GTPv2 is used on S2b and if the Trace-Info AVP including Trace-Data has been received in the authorization response, the ePDG shall send a GTPv2 Trace Session Activation message (see 3GPP TS 29.274 [38]) to the PGW to start a trace session for the user. + +If DSMIPv6 is used and if ePDG has received the PGW identity in form of the FQDN from the 3GPP AAA server, then the ePDG may obtain the IP address of the Home Agent functionality of that PGW as described in 3GPP TS 29.303 [34]. + +If the ePDG determines that a previously assigned 3GPP AAA Server is unavailable, it may attempt to send a new authentication and authorization request to an alternate 3GPP AAA Server. If the ePDG receives from this new server a redirect indication towards the former server (due to the HSS having stored the former 3GPP AAA Server identity), it shall terminate all previously existing sessions and PDN connections for that user, and it shall re-send again the request towards the new server, but it shall include the AAA-Failure-Indication AVP in the new request. + +The ePDG shall give preferential treatment to UEs which access the EPC for emergency services, e.g. in scenarios including network overload. + +The ePDG shall store the WLAN Location Information associated with the UE when it receives such information from the 3GPP AAA Server. + +If IMEI check is required by operator policy, the ePDG shall be configured to retrieve the IMEI(SV) from the UE (as specified in 3GPP TS 23.402 [26]) during the authentication and authorization procedure. + +If the ePDG supports IMS Emergency sessions over WLAN (see clause 4.5.7.2 of 3GPP TS 23.402 [3]) and if local policies in the ePDG allows unauthenticated emergency sessions, the ePDG shall proceed during an Emergency Attach for a UE without a UICC or with an unauthenticated IMSI as specified above with the following modifications: + +- 1) If the UE is UICC-less, the User Identity IE in the Authentication and Authorization Request shall contain the IMEI in Emergency NAI for Limited Service State format as defined in clause 19 of 3GPP TS 23.003 [14]. +- 2) If the User Identity IE does not contain an IMEI (i.e. the UE has an IMSI), the ePDG shall request the IMEI from the UE as specified in clause 13.3 of 3GPP TS 33.402 [19] and clause 7.4.4 of 3GPP TS 24.302 [26] and include the IMEI in the Terminal-Information AVP in the next Authentication and Authorization Request message. + +The Authentication and Authorization Request in step 8 of clause 13.3 of 3GPP TS 33.402 [19] (i.e. after querying the UE's IMSI) shall contain the same parameters as provided in the first Authentication and Authorization Request (step 3) but with the addition of the IMEI in the Terminal-Information AVP. + +NOTE 3: The IMEI cannot be signalled to the 3GPP AAA Server in the first Authentication and Authorization Request sent to the 3GPP AAA Server, since the ePDG requests the IMEI to the UE in the first IKE\_AUTH\_Response message after getting the first Authentication and Authorization Answer from the 3GPP AAA Server. + +NOTE 4: The Authentication and Authorization Requests in steps 3 and 8 of clause 13.3 of 3GPP TS 33.402 [19] are handled independently from each other by the 3GPP AAA Server. + +3) If the Permanent User Identity IE in the answer contains an IMEI based NAI but the User Identity IE in the request did not contain an IMEI based NAI, the ePDG shall derive that the IMSI was not authenticated and proceed accordingly with the setup of the Emergency PDN connection over S2b (see 3GPP TS 29.274 [38]). + +## 7.1.2.2 Authorization Procedures + +### 7.1.2.2.1 General + +This procedure shall be used between the ePDG and 3GPP AAA Server and Proxy. It shall be invoked by the ePDG, upon receipt of a valid Re-Authorization Request message from the 3GPP AAA Server (see clause 7.1.2.5). It may also be initiated by the ePDG, when the ePDG detects a change of the outer IP address of the UE, to: + +- update the 3GPP AAA Server with the new UE local IP address; and +- retrieve the most up to date WLAN Location Information stored at the 3GPP AAA Server, when the 3GPP AAA server has sent WLAN Location Information during the initial Authentication and Authorization procedure (see clause 4.5.7.2.8 of 3GPP TS 23.402 [3]). + +This procedure shall be used by the ePDG to update the previously provided authorization parameters. This may happen due to a modification of the subscriber profile in the HSS (for example, removal of a specific APN associated with the subscriber, or change of the identity of a dynamically allocated PDN GW, see clause 8.1.2.3). + +This procedure is mapped to the Diameter command codes AA-Request (AAR) and AA-Answer (AAA) specified in RFC 4005 [4]. Information element contents for these messages are shown in tables 7.1.2.2.1/1 and 7.1.2.2.1/2. + +**Table 7.1.2.2.1/1: SWm Authorization Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-------------------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Permanent User Identity | User-Name | M | This information element shall contain the permanent identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15] and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]. If this IE contains an identity based on IMSI, this IE shall not include the leading digit prepended in front of the IMSI used to differentiate between authentication schemes. | +| Request Type | Auth-Request-Type | M | This information element shall contain the type of request. It shall have the value AUTHORIZE_ONLY. | +| AAR Flags | AAR-Flags | O | This IE contains a bit mask. See 7.2.3.5 for the meaning of the bits.

This IE may be present and indicate that the ePDG requests to retrieve the most up to date WLAN Location Information of the UE, if the ePDG received the WLAN Location Information during the initial Authentication and Authorization procedure. | +| UE local IP address | UE-Local-IP-Address | C | This IE shall be present if the ePDG provided the UE Local IP address in the initial Authentication and Authorization Request and the UE Local IP address has changed. | + +**Table 7.1.2.2.1/2: SWm Authorization Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|--------------------------------------|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Permanent User Identity | User-Name | M | This information element shall contain the permanent identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15], and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]. If this IE contains an identity based on IMSI, this IE shall not include the leading digit prepended in front of the IMSI used to differentiate between authentication schemes. | +| Request Type | Auth-Request-Type | M | It shall contain the value AUTHORIZE_ONLY. See IETF RFC 4072 [5]. | +| Registration Result | Result-Code/Experimental Result Code | M | This IE shall contain the result of the operation. The Result-Code AVP shall be used for errors defined in the Diameter base protocol (see IETF RFC 6733 [58]) or as per in NASREQ (see IETF RFC 4005 [4]). | +| UE IPv4 Home Address | PMIP6-IPv4-Home-Address | O | If the authorization succeeded, and the user has an IPv4-HoA statically defined as part of his profile data, then this IE may be present. It shall contain the IPv4-HoA allocated and assigned to the UE. | +| APN-OI replacement | APN-OI-Replacement | C | This AVP shall indicate the domain name to replace the APN-OI in the non-roaming case or in the home routed roaming case when constructing the PDN GW FQDN upon which it needs to perform a DNS resolution. See 3GPP TS 23.003 [3]. It shall only be included if NBM is used, the Emergency-Indication bit of the Emergency-Services AVP was not set in the initial Authentication and Authorization Request, and the Result-Code AVP is set to DIAMETER_SUCCESS. | +| APN and PGW Data | APN-Configuration | C | This information element shall only be sent if the Result-Code AVP is set to DIAMETER_SUCCESS and the Emergency-Indication bit of the Emergency-Services AVP was not set in the initial Authentication and Authorization Request.
APN-Configuration is a grouped AVP, defined in 3GPP TS 29.272 [29]. When NBM is used, the following information elements per APN may be included:
- APN
- APN-AMBR
- Authorized 3GPP QoS profile
- Statically allocated User IP Address (IPv4 and/or IPv6)
- Allowed PDN types
- PDN GW identity
- PDN GW allocation type
- VPLMN Dynamic Address Allowed
- Visited Network Identifier
When local IP address assignment is used, this AVP shall only be present if IKEv2 based Home Agent discovery is used and
- if the PDN connection was active in case of HO, or
- if there is static PDN GW allocated to the UE's subscribed APN.
In these cases, the following information elements shall be included:
- HA-APN (Home Agent APN as defined in 3GPP TS 23.003 [14])
- PDN GW identity | +| Trace information | Trace-Info | C | This AVP shall be included if the subscriber and equipment trace has been activated for the user in the HSS and signalling based activation is used to download the trace activation from the HSS to the ePDG.

Only the Trace-Data AVP shall be included if trace activation is requested. Only the Trace-Reference AVP shall be included if trace deactivation is requested.

If the Trace-Data AVP is included, it shall contain the following AVPs:
- Trace-Reference
- Trace-Depth
- Trace-Event-List, for PGW
- Trace-Collection-Entity
The following AVPs may also be included in the Trace-Data AVP:
- Trace-Interface-List, for PGW, if this AVP is not present, trace report generation is requested for all interfaces for PGW listed in 3GPP TS 32.422 [32]
- Trace-NE-Type-List, with the only allowed value being "PDN GW". If this AVP is not included, trace activation in PDN GW is required. | +| MSISDN | Subscription-ID | C | This AVP shall contain the MSISDN of the UE and shall be sent only if it is | + +| | | | | +|---------------------------|-------------------------------|---|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | available. | +| UE Charging Data | 3GPP-Charging-Characteristics | O | If present, this information element shall contain the type of charging method to be applied to the user (see 3GPP TS 29.061 [31]). | +| Session time | Session-Timeout | C | If the authorization succeeded, then this IE shall contain the time this authorization is valid for. | +| WLAN Location Information | Access-Network-Information | O | If present, this IE shall contain the location information of the WLAN Access Network where the UE is attached. | +| WLAN Location Timestamp | User-Location-Info-Time | C | This IE should be present if the WLAN Location Information IE is present. When present, this IE shall contain the NTP time at which the UE was last known to be in the location reported in the WLAN Location Information. | + +#### 7.1.2.2.2 3GPP AAA Server Detailed Behaviour + +The 3GPP AAA Server shall process the steps in the following order (if there is an error in any of the steps, the 3GPP AAA Server shall stop processing and return the corresponding error code): + +- 1) Check that the user exists in the 3GPP AAA Server. The check shall be based on Diameter Session-id and User Name. If the Session-Id included in the request does not correspond with any active session, or if an active session is found but it does not belong to the user identified by the User Name parameter, Experimental-Result-Code shall be set to DIAMETER\_ERROR\_USER\_UNKNOWN. +- 2) If the Emergency-Indication bit of the Emergency-Services AVP was not set in the initial Authentication and Authorization Request, check whether the user is allowed to access the APN. If not, Result-Code shall be set to DIAMETER\_AUTHORIZATION\_REJECTED. +- 3) The Result-Code shall be set to DIAMETER\_SUCCESS and, if the Emergency-Indication bit of the Emergency-Services AVP was not set in the initial Authentication and Authorization Request, the 3GPP AAA Server shall return user data relevant to the APN as received from the HSS. +- 4) If the WLAN-Location-Info-Request bit is set to 1 in the AAR-Flags AVP and if the 3GPP AAA Server knows the WLAN Location Information of the UE, the 3GPP AAA Server shall provide it to the ePDG, along with the WLAN Location Timestamp if available (see clause 4.1.2.1.2). + +If the Emergency-Indication bit of the Emergency-Services AVP was not set in the initial Authentication and Authorization Request, once the Authentication and Authorization procedure successfully finishes, the 3GPP AAA Server shall download, together with authentication data, the list of authorized APNs and the authorized mobility protocols in the authentication and authorization response from the HSS (see SWx procedure in Clause 8.1.2.1). + +Exceptions to the cases specified here shall be treated by 3GPP AAA Server as error situations, the Result-Code shall be set to DIAMETER\_UNABLE\_TO\_COMPLY and, therefore, no authorization information shall be returned. + +If the 3GPP AAA Server answers with DIAMETER\_AUTHORIZATION\_REJECTED, it shall terminate locally the associated SWm Diameter session. + +#### 7.1.2.2.3 3GPP AAA Proxy Detailed Behaviour + +The 3GPP AAA Proxy shall be required to handle roaming cases in which the ePDG is in the VPLMN. The 3GPP AAA Proxy shall act as a stateful proxy, with the following extensions. + +On receipt of the authorization answer, the 3GPP AAA Proxy: + +- Shall check locally configured information for the maximum allowed static QoS parameters valid for visitors from the given HPLMN and modify the QoS parameters received from the 3GPP AAA Server, to enforce the policy limitations. +- Shall record the state of the connection (i.e. Authorization Successful). + +If the 3GPP AAA Proxy receives a DIAMETER\_AUTHORIZATION\_REJECTED response from the 3GPP AAA Server, it shall forward it to the ePDG, and terminate locally the associated SWm Diameter session. + +#### 7.1.2.2.4 ePDG Detailed Behaviour + +Upon receipt of a valid Re-Authorization Request message from the 3GPP AAA Server, the ePDG shall initiate the authorization procedure after successfully completing the authentication of the user. The ePDG shall initiate a separate authorization session for each IKE\_SA of the user. When initiated by the ePDG to retrieve the most up to date WLAN Location Information stored at the 3GPP AAA Server, the ePDG shall initiate the authorization procedure for one IKE\_SA of the user. + +If NBM is used, at successful completion of the procedure, the ePDG shall store the APN configuration data received from the 3GPP AAA Server. The ePDG shall utilize these data to authorize the requested home address types: IPv4 home address and/or IPv6 home network prefix. + +NOTE: The user will be allowed to create PDN connections only to the subscribed APNs and use the address types that are allowed by the subscribed PDN types. + +Upon receiving the authorization response: + +- If NBM is used and if any other Result-Code than DIAMETER\_SUCCESS was received in the response, the ePDG shall release the corresponding PDN connection (PMIPv6 binding or GTPv2 tunnel) and IKE\_SA of the user, and terminate locally the associated SWm Diameter session. +- If DSMIPv6 is used, + - If any other Result-Code than DIAMETER\_SUCCESS was received, the ePDG shall release the corresponding IKE\_SA of the user, and terminate locally the associated SWm Diameter session. + - If the Result-Code DIAMETER\_SUCCESS was received in the response, the ePDG shall update the previously provided authorization parameters. + +NOTE: The ePDG knows if NBM is used or if a local IP address is assigned based on the flags in the MIP6-Feature-Vector received during the initial authentication and authorization procedure or based on preconfigured information. If the PMIP6\_SUPPORTED and/or the GTPv2\_SUPPORTED flag are set in the MIP6-Feature-Vector received from the 3GPP AAA Server, the ePDG knows that NBM is used. + +If GTPv2 is used on S2b and if the Trace-Info AVP including Trace-Data has been received in the authorization response, the ePDG shall send a GTPv2 Trace Session Activation message (see 3GPP TS 29.274 [38]) to the PGW to start a trace session for the user. If the Trace-Info AVP including Trace-Reference (directly under the Trace-Info) has been received in the authorization response, the ePDG shall send a GTPv2 Trace Session Deactivation message to the PGW to stop the ongoing trace session, identified by the Trace-Reference. For details, see 3GPP TS 32.422 [32]. + +If DSMIPv6 is used and if ePDG has received the PGW identity in form of the FQDN from the 3GPP AAA server, then the ePDG may obtain the IP address of the Home Agent functionality of that PGW as described in 3GPP TS 29.303 [34]. + +The ePDG shall store the WLAN Location Information associated with the UE when it receives such information from the 3GPP AAA Server. The ePDG shall delete any stored WLAN Location Information associated with the UE when it receives from the 3GPP AAA Server an Authorization Answer not including any WLAN Location Information and the WLAN-Location-Info-Request bit was set to 1 in the AAR-Flags AVP. + +#### 7.1.2.3 ePDG Initiated Session Termination Procedures + +##### 7.1.2.3.1 General + +The SWm reference point allows the ePDG to inform the 3GPP AAA Server/Proxy about the termination of an IKE\_SA between UE and ePDG, and that therefore the mobility session established on the ePDG for all associated PDN connections are to be removed. + +The SWm Session Termination Request procedure shall be initiated by the ePDG to the 3GPP AAA Server which shall remove associated non-3GPP Access information. The AAA Server shall then return the SWm Session Termination Answer containing the result of the operation. These procedures are based on the reuse of Diameter STR and STA commands as specified in IETF RFC 6733 [58]. + +**Table 7.1.2.3.1/1: SWm Session Termination Request** + +| Information Element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-------------------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Permanent User Identity | User-Name | M | This information element shall contain the permanent identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15] and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]. If this IE contains an identity based on IMSI, this IE shall not include the leading digit prepended in front of the IMSI used to differentiate between authentication schemes. | +| Termination Cause | Termination-Cause | M | This information element shall contain the reason for the disconnection. | + +**Table 7.1.2.3.1/2: SWm Session Termination Answer** + +| Information Element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-------------------------|------|----------------------------------------------------| +| Result | Result-Code | M | This IE shall contain the result of the operation. | + +### 7.1.2.3.2 3GPP AAA Server Detailed Behavior + +Upon reception of the Session Termination Request message from the ePDG, the 3GPP AAA Server shall check that there is an ongoing session associated to the two parameters received (Session-Id and User-Name). + +If an active session is found and it belongs to the user identified by the User-Name parameter, the 3GPP AAA Server shall release the session resources associated to the specified session and a Session Termination Response shall be sent to the ePDG, indicating DIAMETER\_SUCCESS. + +Otherwise, the 3GPP AAA Server returns a Session Termination Response with the Diameter Error DIAMETER\_UNKNOWN\_SESSION\_ID. + +### 7.1.2.3.3 3GPP AAA Proxy Detailed Behavior + +The 3GPP AAA Proxy is required to handle roaming cases in which the ePDG is located in the VPLMN. The 3GPP AAA Proxy shall act as a stateful proxy. + +On receipt of the Session Termination Request message from the ePDG, the 3GPP AAA Proxy shall route the message to the 3GPP AAA Server. + +On receipt of the Session Termination Answer message from the 3GPP AAA Server, the 3GPP AAA Proxy shall route the message to the ePDG, and it shall release any local resources associated to the specified session only if the result code is set to DIAMETER\_SUCCESS. + +## 7.1.2.4 3GPP AAA Server Initiated Session Termination Procedures + +### 7.1.2.4.1 General + +The SWm reference point shall allow the 3GPP AAA Server to request the termination of an IKE\_SA between UE and ePDG, and therefore the termination of all mobility session established for all associated PDN connections. + +If the user has several accesses (IKE\_SA) active at an ePDG, a separate Session Termination procedure shall be initiated for each of them. + +The procedure shall be initiated by the 3GPP AAA Server. This procedure is based on the reuse of NASREQ IETF RFC 4005 [4] ASR, ASA, STR and STA commands. + +**Table 7.1.2.4.1/1: SWm Abort Session Request** + +| Information Element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-------------------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Permanent User Identity | User-Name | M | This information element shall contain the permanent identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15] and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]. If this IE contains an identity based on IMSI, this IE shall not include the leading digit prepended in front of the IMSI used to differentiate between authentication schemes. | +| Auth-Session-State | Auth-Session-State | O | If present, this information element indicates to the ePDG whether the 3GPP AAA Server requires an STR message. | + +**Table 7.1.2.4.1/2: SWm Abort Session Answer** + +| Information Element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-------------------------|------|----------------------------------------------------| +| Result | Result-Code | M | This IE shall contain the result of the operation. | + +**Table 7.1.2.4.1/3: SWm Session Termination Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-------------------------|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Termination-Cause | Termination-Cause | M | This information element shall contain the reason why the session was terminated. It shall be set to "DIAMETER_ADMINISTRATIVE" to indicate that the session was terminated in response to an ASR message. | + +**Table 7.1.2.4.1/4: SWm Session Termination Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-------------------------|------|----------------------------------------------------| +| Result-Code | Result-Code | M | This IE shall contain the result of the operation. | + +#### 7.1.2.4.2 3GPP AAA Server Detailed Behaviour + +The 3GPP AAA Server shall make use of this procedure to instruct the ePDG to terminate the IKE\_SA between UE and ePDG. + +In the DSMIPv6 case, the 3GPP AAA Server shall initiate first the detach procedure over the S6b reference point towards the PDN GW. When this process has finalized, the 3GPP AAA Server can initiate the termination of the IKE\_SA towards the ePDG. + +The 3GPP AAA Server shall include the Auth-Session-State AVP in the ASR command with a value of NO\_STATE\_MAINTAINED if it does not require a STR from the ePDG. If it does require a STR from the ePDG, the 3GPP AAA Server shall either omit the Auth-Session-State AVP from the ASR command or include the Auth-Session-State AVP in the ASR command with a value of STATE\_MAINTAINED. + +On receipt of the ASR command, the ePDG shall check if there is an ongoing session associated with the received Session-Id. If an active session is found and it belongs to the user identified by the User-Name parameter, the ePDG shall terminate the associated IKE\_SA between UE and ePDG and return an ASA to the 3GPP AAA Server with the Result-Code to DIAMETER\_SUCCESS. Otherwise, the ePDG shall return an ASA to the 3GPP AAA Server with the Result-Code set to DIAMETER\_UNKNOWN\_SESSION\_ID. + +On receipt of the ASA with a Result-Code of DIAMETER\_SUCCESS, the 3GPP AAA Server shall release any local resources associated with the specified session. + +If required by the 3GPP AAA Server, the ePDG shall send an STR with the Termination-Cause set to DIAMETER\_ADMINISTRATIVE. The 3GPP AAA Server shall set the Result-Code to DIAMETER\_SUCCESS and return the STA command to the ePDG. + +#### 7.1.2.4.3 3GPP AAA Proxy Detailed Behaviour + +When the 3GPP AAA Proxy receives the ASR from the 3GPP AAA Server it shall route the request to the ePDG. + +If the 3GPP AAA Proxy requires an STR but the 3GPP AAA Server does not, the 3GPP AAA Proxy may override the value of the Auth-Session-State in the ASR and set it to STATE\_MAINTAINED. In this case, the 3GPP AAA Proxy shall not forward the STR received from the ePDG onto the 3GPP AAA Server and shall return an STA command to the ePDG with the Result-Code set to DIAMETER\_SUCCESS. The 3GPP AAA Proxy shall not override the value of the Auth-Session-State AVP under any other circumstances. + +On receipt of the ASA message with Diameter Result Code set to DIAMETER\_SUCCESS, the 3GPP AAA Proxy shall route the successful response to the 3GPP AAA Server and shall release any local resources associated with the session. + +When the 3GPP AAA Proxy receives the STR from ePDG, it shall route the request to the 3GPP AAA Server. On receipt of the STA message, the 3GPP AAA Proxy shall route the response to the ePDG. + +#### 7.1.2.5 Authorization Information Update Procedures + +##### 7.1.2.5.1 General + +This procedure shall be used between the 3GPP AAA Server and the ePDG for the purpose of modifying the previously provided authorization parameters. This may happen due to a modification of the subscriber profile in the HSS (for example change of the identity of a dynamically allocated PDN GW, see clause 8.1.2.3). + +This procedure shall be performed in two steps: + +- The 3GPP AAA Server shall issue an unsolicited re-authorization request towards the ePDG. Upon receipt of such a request, the ePDG shall respond to the request and indicate the disposition of the request. This procedure is based on the Diameter commands Re-Auth-Request and Re-Auth-Answer specified in IETF RFC 6733 [58]. Information element contents for these messages shall be as shown in tables 7.1.2.5.1/1 and 7.1.2.5.1/2. +- Upon receiving the re-authorization request, the ePDG shall immediately invoke the authorization procedure specified in 7.1.2.2 for the session indicated in the request. This procedure is based on the Diameter commands AA-Request (AAR) and AA-Answer (AAA) specified in IETF RFC 4005 [4]. Information element contents for these messages are shown in tables 7.1.2.2.1/1 and 7.1.2.2.1/2. + +**Table 7.1.2.5.1/1: SWm Authorization Information Update Request** + +| Information Element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-------------------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Permanent User Identity | User-Name | M | This information element shall contain the permanent identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15] and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]. If this IE contains an identity based on IMSI, this IE shall not include the leading digit prepended in front of the IMSI used to differentiate between authentication schemes. | +| Re-Auth Request Type | Re-Auth-Request-Type | M | This IE shall define whether the user is to be authorized only or authenticated and authorized. AUTHORIZE_ONLY shall be set in this case. | +| Routing Information | Destination-Host | M | This information element shall be obtained from the Origin-Host AVP, which was included in a previous command received from the trusted non-3GPP access. | + +**Table 7.1.2.5.1/2: SWm Authorization Information Update Answer** + +| Information Element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-------------------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Permanent User Identity | User-Name | M | This information element shall contain the permanent identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15] and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]. If this IE contains an identity based on IMSI, this IE shall not include the leading digit prepended in front of the IMSI used to differentiate between authentication schemes. | +| Result | Result-Code | M | This IE shall contain the result of the operation. | + +### 7.1.2.5.2 3GPP AAA Server Detailed Behaviour + +The 3GPP AAA server shall make use of the re-authorization procedure defined in the Diameter base protocol, IETF RFC 6733 [58] to indicate that relevant service authorization information shall be updated in the ePDG. + +### 7.1.2.5.3 ePDG Detailed Behaviour + +Upon receipt of the Re-authorization Request message from the 3GPP AAA Server or the 3GPP AAA Proxy, the ePDG shall check that there is an ongoing session associated to any of the parameters received in the message (identified by the Session-Id AVP and the User-Name AVP). + +If an active session is found, the ePDG shall initiate an authorization procedure for the session identified by the Session-Id AVP and the User-Name AVP and a Re-authorization Answer message shall be sent to the 3GPP AAA Server or the 3GPP AAA Proxy with the Result-Code indicating DIAMETER\_SUCCESS. This new authorization procedure shall be performed as described in clause 7.1.2.2. + +If the Session-Id included in the request does not correspond with any active session, or if an active session is found but it does not belong to the user identified by the User Name parameter, then an Re-authorization Answer message shall be sent to the 3GPP AAA Server or the 3GPP AAA Proxy with the Result-Code indicating DIAMETER\_UNKNOWN\_SESSION\_ID. + +Exceptions to the cases specified here shall be treated by ePDG as error situations, the Result-Code shall be set to DIAMETER\_UNABLE\_TO\_COMPLY and, therefore, no authorization procedure shall be initiated. + +Table 7.1.2.5.3/1 details the valid result codes that the ePDG can return in the response. + +**Table 7.1.2.5.3/1: Re-authorization Answer valid result codes** + +| Result-Code AVP value | Condition | +|-----------------------------|-----------------------------------------------------------| +| DIAMETER_SUCCESS | The request succeeded. | +| DIAMETER_UNKNOWN_SESSION_ID | The request failed because the user is not found in ePDG. | +| DIAMETER_UNABLE_TO_COMPLY | The request failed. | + +## 7.2 Protocol Specification + +### 7.2.1 General + +The SWm reference point shall be based on Diameter, as defined in IETF RFC 6733 [58] and contain the following additions and extensions: + +- IETF RFC 4005 [4], which defines a Diameter protocol application used for Authentication, Authorization and Accounting (AAA) services in the Network Access Server (NAS) environment. +- IETF RFC 4072 [5], which provides a Diameter application to support the transport of EAP (IETF RFC 3748 [8]) frames over Diameter. + +- IETF RFC 5779 [2], which defines a Diameter extensions and application for PMIPv6 MAG to AAA and LMA to AAA interfaces. +- IETF RFC 5447 [6], which defines Diameter extensions for Mobile IPv6 NAS to AAA interface. + +In the case of an untrusted non-3GPP IP access, the MAG to 3GPP AAA server or the MAG to 3GPP AAA proxy communication shall use the MAG to AAA interface functionality defined in IETF RFC 5779 [2] and the NAS to AAA interface functionality defined in IETF RFC 5447 [6]. + +The Diameter application for the SWm reference point shall use the Diameter Application Id with value 16777264. + +## 7.2.2 Commands + +### 7.2.2.1 Commands for SWm Authentication and Authorization Procedures + +#### 7.2.2.1.1 Diameter-EAP-Request (DER) Command + +The Diameter-EAP-Request (DER) command, indicated by the Command-Code field set to 268 and the "R" bit set in the Command Flags field, is sent from a ePDG to a 3GPP AAA Server/Proxy. The ABNF is based on the one in IETF RFC 5779 [2]. + +``` +< Diameter-EAP-Request > ::= < Diameter Header: 268, REQ, PXY, 16777264 > + < Session-Id > + [ DRMP ] + { Auth-Application-Id } + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + [ Destination-Host ] + { Auth-Request-Type } + { EAP-Payload } + [ User-Name ] + [ RAT-Type ] + [ Service-Selection ] + [ MIP6-Feature-Vector ] + [ QoS-Capability ] + [ Visited-Network-Identifier ] + [ AAA-Failure-Indication ] + *[ Supported-Features ] + [ UE-Local-IP-Address ] + [ OC-Supported-Features ] + [ Terminal-Information ] + [ Emergency- Services ] + ... + *[ AVP ] +``` + +#### 7.2.2.1.2 Diameter-EAP-Answer (DEA) Command + +The Diameter-EAP-Answer (DEA) command, indicated by the Command-Code field set to 268 and the "R" bit cleared in the Command Flags field, is sent from a 3GPP AAA Server/Proxy to the ePDG. The ABNF is based on the one in IETF RFC 5779 [2]. + +``` +< Diameter-EAP-Answer > ::= < Diameter Header: 268, PXY, 16777264 > + < Session-Id > + [ DRMP ] + { Auth-Application-Id } + { Auth-Request-Type } + { Result-Code } + { Origin-Host } + { Origin-Realm } + { EAP-Payload } + [ User-Name ] +``` + +``` + +[ EAP-Master-Session-Key ] +[ APN-OI-Replacement ] +[ APN-Configuration ] +[ MIP6-Feature-Vector ] +[ Mobile-Node-Identifier ] +[ Trace-Info ] +[ Subscription-ID ] +[ Session-Timeout ] +[ MIP6-Agent-Info ] +[ 3GPP-Charging-Characteristics ] +*[ Redirect-Host ] +*[ Supported-Features ] +[ OC-Supported-Features ] +[ OC-OLR ] +*[ Load ] +[ Access-Network-Info ] +[ User-Location-Info-Time ] +[ UE-Usage-Type ][ Emergency-Info ] +[ Core-Network-Restrictions ] +... +*[ AVP ] + +``` + +#### 7.2.2.1.3 Diameter-AA-Request (AAR) Command + +The AA-Request (AAR) command, indicated by the Command-Code field set to 265 and the "R" bit set in the Command Flags field, is sent from a ePDG to a 3GPP AAA Server/Proxy. + +``` + + ::= < Diameter Header: 265, REQ, PXY, 16777264 > + < Session-Id > + [ DRMP ] + { Auth-Application-Id } + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + [ Destination-Host ] + { Auth-Request-Type } + [ User-Name ] + [ OC-Supported-Features ] + [ AAR-Flags ] + [ UE-Local-IP-Address ] + ... + *[ AVP ] + +``` + +#### 7.2.2.1.4 Diameter-AA-Answer (AAA) Command + +The AA-Answer (AAA) command, indicated by the Command-Code field set to 265 and the "R" bit cleared in the Command Flags field, is sent from 3GPP AAA Server/Proxy to a ePDG. + +``` + + ::= < Diameter Header: 265, REQ, PXY, 16777264 > + < Session-Id > + +``` + +``` + +[ DRMP ] +{ Auth-Application-Id } +{ Auth-Request-Type } +{ Result-Code } +{ Origin-Host } +{ Origin-Realm } +[ User-Name ] +[ APN-OI-Replacement ] +[ APN-Configuration ] +[ Trace-Info ] +[ Subscription-ID ] +[ 3GPP-Charging-Characteristics ] +[ Session-Timeout ] +[ OC-Supported-Features ] +[ OC-OLR ] +*[ Load ] +[ Access-Network-Info ] +[ User-Location-Info-Time ] +... +*[ AVP ] + +``` + +## 7.2.2.2 Commands for ePDG Initiated Session Termination + +### 7.2.2.2.1 Session-Termination-Request (STR) Command + +The Session-Termination-Request (STR) command, indicated by the Command-Code field set to 275 and the "R" bit set in the Command Flags field, is sent from a ePDG to a 3GPP AAA Server/Proxy. The ABNF is based on the one in IETF RFC 6733 [58], and is defined as follows: + +``` + +< Session-Termination-Request > ::= < Diameter Header: 275, REQ, PXY, 16777264 > +< Session-Id > +[ DRMP ] +{ Origin-Host } +{ Origin-Realm } +{ Destination-Realm } +[ Destination-Host ] +{ Auth-Application-Id } +{ Termination-Cause } +[ User-Name ] +[ OC-Supported-Features ] +... +*[ AVP ] + +``` + +### 7.2.2.2.2 Session-Termination-Answer (STA) Command + +The Session-Termination-Answer (STA) command, indicated by the Command-Code field set to 275 and the "R" bit clear in the Command Flags field, is sent from a 3GPP AAA Server/Proxy to a ePDG. The ABNF is based on the one in IETF RFC 6733 [58], and is defined as follows: + +``` + +< Session-Termination-Answer > ::= < Diameter Header: 275, PXY, 16777264 > +< Session-Id > +[ DRMP ] +{ Result-Code } +{ Origin-Host } +{ Origin-Realm } +[ OC-Supported-Features ] +[ OC-OLR ] +*[ Load ] +... +*[ AVP ] + +``` + +### 7.2.2.3 Commands for 3GPP AAA Server Initiated Session Termination + +#### 7.2.2.3.1 Abort-Session-Request (ASR) Command + +The Abort-Session-Request (ASR) command shall be indicated by the Command-Code field set to 274 and the "R" bit set in the Command Flags field, and shall be sent from a 3GPP AAA Server/Proxy to an ePDG. The ABNF is based on that in IETF RFC 4005 [4]. + +``` +< Abort-Session-Request > ::= < Diameter Header: 274, REQ, PXY, 16777264 > + < Session-Id > + [ DRMP ] + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + { Destination-Host } + { Auth-Application-Id } + [ User-Name ] + [ Auth-Session-State ] + ... + *[ AVP ] +``` + +#### 7.2.2.3.2 Abort-Session-Answer (ASA) Command + +The Abort-Session-Answer (ASA) command shall be indicated by the Command-Code field set to 274 and the "R" bit cleared in the Command Flags field, and shall be sent from a ePDG to a 3GPP AAA Server/Proxy. The ABNF is based on that in IETF RFC 4005 [4]. + +``` +< Abort-Session-Answer > ::= < Diameter Header: 274, PXY, 16777264 > + < Session-Id > + [ DRMP ] + { Result-Code } + { Origin-Host } + { Origin-Realm } + ... + *[ AVP ] +``` + +#### 7.2.2.3.3 Session-Termination-Request (STR) Command + +The Session-Termination-Request (STR) command, indicated by the Command-Code field set to 275 and the "R" bit set in the Command Flags field, is sent from an ePDG to a 3GPP AAA Server/Proxy. The Command Code value and ABNF are re-used from the IETF RFC 6733 [58] Session-Termination-Request command. + +``` +< Session-Termination-Request > ::= < Diameter Header: 275, REQ, PXY, 16777264 > + < Session-Id > + [ DRMP ] + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + [ Destination-Host ] + { Auth-Application-Id } + { Termination-Cause } + [ User-Name ] + [ OC-Supported-Features ] + ... + *[ AVP ] +``` + +#### 7.2.2.3.4 Session-Termination-Answer (STA) Command + +The Session-Termination-Answer (STA) command, indicated by the Command-Code field set to 275 and the "R" bit cleared in the Command Flags field, is sent from a 3GPP AAA Server/Proxy to an ePDG. The Command Code value and ABNF are re-used from the IETF RFC 6733 [58] Session-Termination-Answer command. + +``` + + ::= < Diameter Header: 275, PXY, 16777264 > + < Session-Id > + [ DRMP ] + { Result-Code } + { Origin-Host } + { Origin-Realm } + [ OC-Supported-Features ] + [ OC-OLR ] + *[ Load ] + *[ AVP ] + +``` + +## 7.2.2.4 Commands for Authorization Information Update + +### 7.2.2.4.1 Re-Auth-Request (RAR) Command + +The Re-Auth-Request (RAR) command shall be indicated by the Command-Code field set to 258 and the "R" bit set in the Command Flags field, and shall be sent from a 3GPP AAA Server/Proxy to a ePDG. The ABNF is based on the one in IETF RFC 4005 [4] and is defined as follows. + +``` + +< Re-Auth-Request > ::= < Diameter Header: 258, REQ, PXY, 16777264 > + < Session-Id > + [ DRMP ] + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + { Destination-Host } + { Auth-Application-Id } + { Re-Auth-Request-Type } + [ User-Name ] + ... + *[ AVP ] + +``` + +### 7.2.2.4.2 Re-Auth-Answer (RAA) Command + +The Re-Auth-Answer (RAA) command shall be indicated by the Command-Code field set to 258 and the "R" bit cleared in the Command Flags field, and shall be sent from a ePDG to a 3GPP AAA Server/Proxy. The ABNF is based on the one in IETF RFC 4005 [4] and is defined as follows. + +``` + +< Re-Auth-Answer > ::= < Diameter Header: 258, PXY, 16777264 > + < Session-Id > + [ DRMP ] + { Result-Code } + { Origin-Host } + { Origin-Realm } + [ User-Name ] + ... + *[ AVP ] + +``` + +## 7.2.3 Information Elements + +### 7.2.3.1 General + +The following table describes the Diameter AVPs defined for the SWm interface protocol for untrusted non-3GPP access, their AVP Code values, types, possible flag values and whether or not the AVP may be encrypted. + +For all AVPs which contain bit masks and are of the type Unsigned32, bit 0 shall be the least significant bit. For example, to get the value of bit 0, a bit mask of 0x00000001 should be used. + +**Table 7.2.3.1/1: Diameter SWm AVPs** + +| Attribute Name | AVP Code | Clause defined | Value Type | AVP Flag rules | | | | +|----------------------------|----------|----------------|-------------|----------------|-----|------------|----------| +| | | | | Must | May | Should not | Must not | +| APN-Configuration | 1430 | 8.2.3.7 | Grouped | M,V | | | P | +| Mobile-Node-Identifier | 506 | 5.2.3.2 | OctetString | M | | | V,P | +| MIP6-Feature-Vector | 124 | 5.2.3.3 | Unsigned64 | M | | | V,P | +| QoS-Capability | 578 | 9.2.3.2.4 | Grouped | M | | | V,P | +| RAT-Type | 1032 | 5.2.3.6 | Enumerated | M,V | | | P | +| Visited-Network-Identifier | 600 | 9.2.3.1.2 | OctetString | M,V | | | P | +| Trace-Info | 1505 | 8.2.3.1.3 | Grouped | V | | | M,P | +| Service-Selection | 493 | 5.2.3.5 | UTF8String | M | | | V,P | +| AAA-Failure-Indication | 1518 | 8.2.3.21 | Unsigned32 | V | | | M,P | +| Emergency- Services | 1538 | 7.2.3.4 | Unsigned32 | V | | | M,P | +| Access-Network-Info | 1526 | 5.2.3.24 | Grouped | V | | | M,P | +| AAR-Flags | 1539 | 7.2.3.5 | Unsigned32 | V | | | M,P | + +NOTE 1: The AVP header bit denoted as "M", indicates whether support of the AVP is required. The AVP header bit denoted as "V", indicates whether the optional Vendor-ID field is present in the AVP header. For further details, see IETF RFC 6733 [58]. + +NOTE 2: If the M-bit is set for an AVP and the receiver does not understand the AVP, it shall return a rejection. If the M-bit is not set for an AVP, the receiver shall not return a rejection, whether or not it understands the AVP. If the receiver understands the AVP but the M-bit value does not match with the definition in this table, the receiver shall ignore the M-bit. + +The following table describes the Diameter AVPs re-used by the SWm interface protocol from existing Diameter Applications, including a reference to their respective specifications and when needed, a short description of their use within SWm. Other AVPs from existing Diameter Applications, except for the AVPs from Diameter base protocol defined in IETF RFC 6733 [58], do not need to be supported. + +**Table 7.2.3.1/2: SWm re-used Diameter AVPs** + +| Attribute Name | Reference | Comments | M-bit | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------|---------------------|--------------| +| Auth-Request-Type | IETF RFC 6733 [58] | | | +| Subscription-ID | IETF RFC 4006 [20] | | | +| EAP-Master-Session-Key | IETF RFC 4072 [5] | | | +| EAP-Payload | IETF RFC 4072 [5] | | | +| Re-Auth-Request-Type | IETF RFC 6733 [58] | | | +| Session-Timeout | IETF RFC 6733 [58] | | | +| User-Name | IETF RFC 6733 [58] | | | +| MIP6-Agent-Info | IETF RFC 5447 [6] | | | +| APN-OI-Replacement | 3GPP TS 29.272 [29] | | | +| Terminal-Information | 3GPP TS 29.272 [29] | | | +| Supported-Features | 3GPP TS 29.229 [24] | | | +| Feature-List-ID | 3GPP TS 29.229 [24] | See clause 7.2.3.2 | | +| Feature-List | 3GPP TS 29.229 [24] | See clause 7.2.3.3 | | +| 3GPP-Charging-Characteristics | 3GPP TS 29.061 [31] | | | +| UE-Local-IP-Address | 3GPP TS 29.212 [23] | | | +| OC-Supported-Features | IETF RFC 7683 [47] | See clause 8.2.3.22 | | +| OC-OLR | IETF RFC 7683 [47] | See clause 8.2.3.23 | | +| User-Location-Info-Time | 3GPP TS 29.212 [23] | See clause 5.3.101 | | +| DRMP | IETF RFC 7944 [53] | See clause 8.2.3.25 | Must not set | +| Emergency-Info | 3GPP TS 29.272 [29] | | | +| Load | IETF RFC 8583 [54] | See clause 8.2.3.26 | Must not set | +| UE-Usage-Type | 3GPP TS 29.272 [29] | | | +| Core-Network-Restrictions | 3GPP TS 29.272 [29] | | | +| NOTE 1: The M-bit settings for re-used AVPs override those of the defining specifications that are referenced. Values include: "Must set", "Must not set". If the M-bit setting is blank, then the defining specification applies. | | | | +| NOTE 2: If the M-bit is set for an AVP and the receiver does not understand the AVP, it shall return a rejection. If the M-bit is not set for an AVP, the receiver shall not return a rejection, whether or not it understands the AVP. If the receiver understands the AVP but the M-bit value does not match with the definition in this table, the receiver shall ignore the M-bit. | | | | + +Only those AVP initially defined in this reference point and for this procedure are described in the following subchapters. + +### 7.2.3.2 Feature-List-ID AVP + +The syntax of this AVP is defined in 3GPP TS 29.229 [24]. For this release, the Feature-List-ID AVP value shall be set to 1 for the SWm application. + +### 7.2.3.3 Feature-List AVP + +The syntax of this AVP is defined in 3GPP TS 29.229 [24]. A null value indicates that there is no feature used by the SWm application. + +NOTE: There are no SWm features defined for this release. + +### 7.2.3.4 Emergency-Services + +The Emergency-Services AVP is of type Unsigned32 and it shall contain a bitmask. The meaning of the bits is defined in table 7.2.3.4/1: + +**Table 7.2.3.4/1: Emergency-Services** + +| Bit | Name | Description | +|----------------------------------------------------------------------------------------------------|----------------------|-----------------------------------------------------------------------------------------------| +| 0 | Emergency-Indication | This bit, when set, indicates a request to establish a PDN connection for emergency services. | +| NOTE: Bits not defined in this table shall be cleared by the sender and discarded by the receiver. | | | + +### 7.2.3.5 AAR-Flags + +The AAR-Flags AVP is of type Unsigned32 and it shall contain a bitmask. The meaning of the bits is defined in table 7.2.3.5/1: + +**Table 7.2.3.5/1: AAR-Flags** + +| Bit | Name | Description | +|-------|----------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | WLAN-Location-Info-Request | This bit, when set, indicates an ePDG request to retrieve the most up to date WLAN Location Information of the UE stored at the 3GPP AAA Server. | +| NOTE: | Bits not defined in this table shall be cleared by the sender and discarded by the receiver. | | + +## 7.2.4 Session Handling + +The Diameter protocol between the ePDG and the 3GPP AAA Server or the 3GPP AAA Proxy shall always keep the session state, and use the same Session-Id parameter for the lifetime of each Diameter session. + +A Diameter session shall identify + +- a PDN Connection of a given user, if NBM is used +- a user, if DSMIPv6 is used. + +In order to indicate that the session state is to be maintained, the Diameter client and server shall not include the Auth-Session-State AVP, either in the request or in the response messages (see IETF RFC 6733 [58]). + +# 8 SWx Description + +## 8.1 Functionality + +### 8.1.1 General + +The SWx reference point is defined between the 3GPP AAA Server and the HSS. The description of the reference point and its functionality is given in 3GPP TS 23.402 [3]. + +The SWx reference point is used to authorize the UE and to transport NBM related mobility parameters when NBM is used to establish connectivity to the EPC. + +The SWx is used to authenticate and authorize the UE when the S2a, S2b or S2c reference points are used to connect to EPC. This reference point is also used to update the HSS with the PDN-GW address information. Additionally, this reference point may be used to retrieve and update other mobility related parameters including static QoS profiles for non-3GPP accesses. + +Additional requirements for the SWx interface can be found in clause 12 of 3GPP TS 23.402 [3]. + +### 8.1.2 Procedures Description + +#### 8.1.2.1 Authentication Procedure + +##### 8.1.2.1.1 General + +This procedure is used between the 3GPP AAA Server and the HSS. The procedure is invoked by the 3GPP AAA Server when a new set of authentication information for a given subscriber is to be retrieved from an HSS. This can happen for example, when a new trusted or untrusted non 3GPP/IP access subscriber has accessed the 3GPP AAA Server for authentication or when a new set of authentication information is required for one of the subscribers already + +registered in the 3GPP AAA server. The procedure shall be invoked by 3GPP AAA Server when it detects that the VPLMN or access network has changed. + +**Table 8.1.2.1.1/1: Authentication request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|----------------------------------------------|------------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| IMSI | User-Name (See IETF RFC 6733 [58]) | M | This information element shall contain the user IMSI, formatted according to 3GPP TS 23.003 [14], clause 2.2. | +| Visited Network Identifier | Visited-Network-Identifier | C | This IE shall contain the identifier that allows the home network to identify the Visited Network. The 3GPP AAA Server shall include this information element when received from signalling across the SWd. | +| Number Authentication Items | SIP-Number-Auth-Items | M | This information element shall indicate the number of authentication vectors requested | +| Authentication Data | SIP-Auth-Data-Item | M | See tables 8.1.2.1.1/2 and 8.1.2.1.1/3 for the contents of this information element. The content shown in table 8.1.2.1.1/2 shall be used for a normal authentication request; the content shown in table 8.1.2.1.1/3 shall be used for an authentication request after synchronization failure. | +| Routing Information | Destination-Host | C | If the 3GPP AAA Server knows the HSS name, this AVP shall be present.
This information is available if the 3GPP AAA Server already has the HSS name stored. The HSS name shall be obtained from the Origin-Host AVP, which is received from a previous command from the HSS or from the SLF; otherwise only the Destination-Realm is included so that it is resolved to an HSS address in an SLF-like function. Once resolved the Destination-Host AVP is included with the suitable HSS address and it is stored in the 3GPP AAA Server for further usage. | +| Access Network Identity | ANID | C | This IE shall contain the access network identifier used for key derivation at the HSS. (See 3GPP TS 24. 302 [26] for all possible values).
This IE shall be present if the Authentication Method is EAP-AKA'. | +| Access Type | RAT-Type | M | This IE shall contain the radio access technology that is serving the UE. (See 3GPP TS 29.212 [23] for all possible values).
When this IE is not received by the 3GPP AAA Server, neither from the ePDG nor from the non-3GPP access network, it shall take the value VIRTUAL (1). | +| Terminal Information | Terminal-Information | O | This information element shall contain information about the user's mobile equipment. The AVP shall be present only if received from the non-3GPP access network, in authentication and authorization request. The AVP shall be transparently forwarded by the 3GPP AAA server.
(see NOTE 1) | +| AAA Failure Indication | AAA-Failure-Indication | O | If present, this information element shall indicate that the 3GPP AAA Server currently registered in the HSS, is unavailable. | +| Supported Features (See 3GPP TS 29.229 [24]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | + +NOTE 1: The Terminal-Information AVP is not present in this message for a WLAN access. + +**Table 8.1.2.1.1/2: Authentication Data content - request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|---------------------------|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Authentication Method | SIP-Authentication-Scheme | M | This information element shall indicate the authentication method. It shall contain one of the values EAP-AKA or EAP-AKA'. EAP-AKA is specified in IETF RFC 4187 [44] and EAP-AKA' is specified in IETF RFC 5448 [27]. | + +**Table 8.1.2.1.1/3: Authentication Data content - request, synchronization failure** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|---------------------------|---------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Authentication Method | SIP-Authentication-Scheme | M | This information element shall indicate the authentication method. It shall contain one of the values EAP-AKA or EAP-AKA'. | +| Authorization Information | SIP-Authorization | M | This IE shall contain the concatenation of Rand, as sent to the terminal, and auts, as received from the terminal. Rand and auts shall both be binary encoded. | + +**Table 8.1.2.1.1/4: Authentication answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|----------------------------------------------|------------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| IMSI | User-Name (See IETF RFC 6733 [58]) | M | This information element shall contain the user IMSI, formatted according to 3GPP TS 23.003 [14], clause 2.2. | +| Number Authentication Items | SIP-Number-Auth-Items | C | This AVP shall indicate the number of authentication vectors delivered in the Authentication Data information element. It shall be present when the result is DIAMETER_SUCCESS. | +| Authentication Data | SIP-Auth-Data-Item | C | If the SIP-Number-Auth-Items AVP is equal to zero or it is not present, then this AVP shall not be present. See table 8.1.2.1.1/5 for the contents of this information element. | +| 3GPP AAA Server Name | 3GPP-AAA-Server-Name | C | This AVP shall contain the Diameter address of the 3GPP AAA Server. This AVP shall be sent when the user has been previously authenticated by another 3GPP AAA Server and therefore there is another 3GPP AAA Server serving the user. | +| Result | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation. The Result-Code AVP shall be used for errors defined in the Diameter base protocol (see IETF RFC 6733 [58]). The Experimental-Result AVP shall be used for SWx errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | +| Supported Features (See 3GPP TS 29.229 [24]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | + +**Table 8.1.2.1.1/5: Authentication Data content - response** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------------|---------------------------|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Item Number | SIP-Item-Number | C | This information element shall be present in a SIP-Auth-Data-Item grouped AVP in circumstances where there are multiple occurrences of SIP-Auth-Data-Item AVPs, and the order in which they should be processed is significant.
In this scenario, SIP-Auth-Data-Item AVPs with a low SIP-Item-Number value should be processed before SIP-Auth-Data-Items AVPs with a high SIP-Item-Number value. | +| Authentication Method | SIP-Authentication Scheme | M | This IE shall contain one of the values EAP-AKA or EAP-AKA'. | +| Authentication Information AKA | SIP-Authenticate | M | This IE shall contain, binary encoded, the concatenation of the authentication challenge RAND and the token AUTN. See 3GPP TS 33.203 [16] for further details about RAND and AUTN. | +| Authorization Information AKA | SIP-Authorization | M | This IE shall contain binary encoded, the expected response XRES. See 3GPP TS 33.203 [16] for further details about XRES. | +| Confidentiality Key AKA | Confidentiality-Key | M | This information element shall contain the confidentiality key CK or CK'. It shall be binary encoded. | +| Integrity Key AKA | Integrity-Key | M | This information element shall contain the integrity key IK or IK'. It shall be binary encoded. | + +#### 8.1.2.1.2 Detailed behaviour + +The HSS shall, in the following order (if there is an error in any of the steps, the HSS shall stop processing and return the corresponding error code): + +1. Check that the user exists in the HSS. If not Experimental-Result-Code shall be set to DIAMETER\_ERROR\_USER\_UNKNOWN. +2. Check that the user has non-3GPP subscription and that the user is allowed in the EPC. If not Experimental-Result-Code shall be set to DIAMETER\_ERROR\_USER\_NO\_NON\_3GPP\_SUBSCRIPTION. +3. If a Visited-Network-Identifier is present, check that the user is allowed to roam in the visited network. If the user is not allowed to roam in the visited network, Experimental-Result-Code shall be set to DIAMETER\_ERROR\_ROAMING\_NOT\_ALLOWED. +4. Check the access type. If the access type indicates any value that is restricted for the user, then the Experimental-Result-Code shall be set to DIAMETER\_ERROR\_RAT\_TYPE\_NOT\_ALLOWED. +5. The HSS shall check if there is an existing 3GPP AAA Server already assisting the user + - If there is a 3GPP AAA Server already serving the user, the HSS shall compare the 3GPP AAA server name received in the request to the 3GPP AAA Server name stored in the HSS. + - If they are not identical and the received message contains the AAA-Failure-Indication AVP, the HSS shall remove the old 3GPP AAA Server name previously assigned for this subscriber, and store the name of the new 3GPP AAA Server that sent the request containing the AAA-Failure-Indication AVP, and continue from step 6. The HSS should attempt to notify the old 3GPP AAA Server about the new server assignment, by means of the network initiated de-registration procedure (see clause 8.1.2.2.3) indicating as reason code "NEW\_SERVER\_ASSIGNED". + - If they are not identical the HSS shall return the old 3GPP AAA Server to the requester 3GPP AAA Server and return an error by setting the Experimental-Result-Code to DIAMETER\_ERROR\_IDENTITY\_ALREADY\_REGISTERED. + - The requester 3GPP AAA Server, upon detection of a 3GPP AAA Server name in the response assumes that the user already has a 3GPP AAA Server assigned, so makes use of Diameter redirect function to indicate the 3GPP AAA Server name where to address the authentication request. + +6. The HSS shall check the request type. + - If the request indicates there is a synchronization failure, the HSS shall process AUTS as described in 3GPP TS 33.203 [16] and return the requested authentication information. The Result-Code shall be set to DIAMETER\_SUCCESS. + - If the request indicates authentication, the HSS shall generate the authentication vectors for the requested authentication method, EAP-AKA or EAP-AKA', as described in 3GPP TS 33.402 [19]. The HSS shall download Authentication-Data-Item up to a maximum specified in SIP-Number-Auth-Items received in the command Multimedia-Auth-Request. The result code shall be set to DIAMETER\_SUCCESS. + - If there is no 3GPP AAA Server already serving the user, the HSS shall store the received 3GPP AAA Server name. + +Exceptions to the cases specified here shall be treated by HSS as error situations, the Result-Code shall be set to DIAMETER\_UNABLE\_TO\_COMPLY. No authentication information shall be returned. + +Origin-Host AVP shall contain the 3GPP AAA Server identity. + +## 8.1.2.2 Location Management Procedures + +### 8.1.2.2.1 General + +According to the requirements described in 3GPP TS 23.402 [3], SWx reference point shall enable: + +- Registration of the 3GPP AAA Server serving an authorized trusted or untrusted non-3GPP access user in the HSS. +- Retrieval of charging-related information from HSS. +- Deregistration procedure between the 3GPP AAA Server and the HSS. +- Retrieval of subscriber profile from HSS. + +### 8.1.2.2.2 UE/PDN Registration/DeRegistration Notification + +#### 8.1.2.2.2.1 General + +This procedure is used between the 3GPP AAA Server and the HSS. + +- To register the current 3GPP AAA Server address in the HSS for a given non-3GPP user. This procedure is invoked by the 3GPP AAA Server after a new subscriber has been authenticated by the 3GPP AAA Server. +- To de-register the current 3GPP AAA Server address in the HSS for a given non-3GPP user. This procedure is invoked when the 3GPP AAA Server removes the access information for a non-3GPP user after all sessions for the user (i.e. the STa, SWm, S6b sessions) have been terminated. +- To download the subscriber profile to the 3GPP AAA Server on demand. This procedure is invoked when for some reason the subscription profile of a subscriber is lost. +- To update the HSS with the identity and the PLMN ID of a dynamically allocated PDN GW as a result of the first PDN connection establishment associated to an APN. +- To update the HSS with the identity of the dynamically allocated PDN GW selected for the establishment of an emergency PDN connection. + +**Table 8.1.2.2.2.1/1: Non-3GPP IP Access Registration request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|-------------------------------------------------|---------------------------------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| IMSI | User-Name
(See IETF RFC 6733 [58]) | M | This information element shall contain the user IMSI and shall be formatted according to 3GPP TS 23.003 [14], clause 2.2. | +| Server Assignment Type | Server-Assignment-Type | M | This IE shall contain the type of procedure the 3GPP AAA Server requests in the HSS.
When this IE contains REGISTRATION value, the 3GPP AAA Server requests the HSS to perform a registration of the non-3GPP user.
When this IE contains USER_DEREGISTRATION / ADMINISTRATIVE_DEREGISTRATION / AUTHENTICATION_FAILURE / AUTHENTICATION_TIMEOUT, the 3GPP AAA Server requests the HSS to de-register the non-3GPP user.
When this IE contains AAA_USER_DATA_REQUEST value, the 3GPP AAA Server requests the HSS to download the subscriber user profile towards the 3GPP AAA Server as part of 3GPP AAA Server initiated profile download request, but no registration is requested.
When this IE contains PGW_UPDATE value, the 3GPP AAA Server requests the HSS to update the PGW identity for the non-3GPP user for an APN in the user subscription or for emergency services.
Any other value shall be considered as an error case. | +| Routing Information | Destination-Host | C | If the 3GPP AAA Server knows the HSS name this AVP shall be present. This information is available if the 3GPP AAA Server already has the HSS name stored. The HSS name shall be obtained from the Origin-Host AVP, which is received from the HSS as part of authentication response; otherwise only the Destination-Realm is included so that it is resolved to an HSS address in an SLF-like function. Once resolved the Destination-Host AVP shall be included with the suitable HSS address and it shall be stored in the 3GPP AAA Server for further usage. | +| PGW identity | MIP6-Agent-Info | C | This IE shall contain, either the identity of the dynamically allocated PDN GW, or the identity of a dynamically allocated PDN GW selected for the establishment of emergency PDN connections, and is included if the Server-Assignment-Type is set to PGW_UPDATE. | +| PGW PLMN ID | Visited-Network-Identifier | C | This IE shall contain the identity of the PLMN where the PDN-GW was allocated, in cases of dynamic PDN-GW assignment. It shall be present when the PGW Identity is present and does not contain an FQDN. | +| Context Identifier | Context-Identifier | O | For non-emergency PDN connection establishment, this parameter shall identify the APN Configuration with which the reallocated PDN GW shall be correlated, and it may be included if it is available and the Server-Assignment-Type is set to PGW_UPDATE.

For emergency PDN connection establishment, this information element shall be left absent. | +| APN Id | Service-Selection | C | For non-emergency PDN connection establishment, this information element shall contain the Network Identifier part of the APN, and it shall be included if the Server-Assignment-Type is set to PGW_UPDATE.

For emergency PDN connection establishment, this information element shall be left absent. | +| Supported Features
(See 3GPP TS 29.229 [24]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Terminal Information | Terminal-Information | C | The 3GPP AAA Server shall include this IE and set it to the user's Mobile Equipment Identity, if this information is available, and if the Server-Assignment-Type is set to REGISTRATION.

This IE shall also be present, independently of the value of the Server-Assignment-Type, if the Terminal-Information has changed from the last value previously reported to the HSS.

This grouped AVP shall contain the IMEI AVP and, if available, the Software-Version AVP, for a trusted or untrusted WLAN access. When the RAT type is not known by the 3GPP AAA Server, but the UE has provided the IMEI(SV), this grouped AVP shall contain the IMEI AVP and, if available, the Software-Version AVP. | + +| | | | | +|--------------------|--------------------|---|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Emergency Services | Emergency-Services | C | The 3GPP AAA Server shall include this information element, and set the Emergency-Indication bit, to notify the HSS that a new PDN-GW has been selected for the establishment of an emergency PDN connection, whose identity is conveyed in the "PGW identity" IE. This IE shall only be included when the Server-Assignment-Type is set to PGW_UPDATE. | +|--------------------|--------------------|---|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +**Table 8.1.2.2.2.1/2: Non-3GPP IP Access Registration response** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|----------------------------------------------|------------------------------------|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| IMSI | User-Name (See IETF RFC 6733 [58]) | M | This information element shall contain the user IMSI and shall be formatted according to 3GPP TS 23.003 [14], clause 2.2. | +| Registration result | Result-Code / Experimental-Result | M | This IE contains the result of the operation. The Result-Code AVP shall be used for errors defined in the Diameter base protocol (see IETF RFC 6733 [58]). The Experimental-Result AVP shall be used for SWx errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | +| User Profile | Non-3GPP-User-Data | C | This IE shall contain the relevant user profile. Clause 8.2.3.1 details the contents of the AVP. It shall be present when Server-Assignment-Type in the request is equal to AAA_USER_DATA_REQUEST or REGISTRATION and the Result-Code is equal to DIAMETER_SUCCESS. | +| 3GPP AAA Server Name | 3GPP-AAA-Server-Name | C | This AVP shall contain the Diameter address of the 3GPP AAA Server. This AVP shall be present when the user has been previously authenticated by another 3GPP AAA Server and therefore there is another 3GPP AAA Server serving the user. | +| Supported Features (See 3GPP TS 29.229 [24]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | + +#### 8.1.2.2.2.2 Detailed behaviour + +When a new trusted or untrusted non-3GPP IP access subscriber has been authenticated by the 3GPP AAA Server, the 3GPP AAA Server initiates the registration towards the HSS. The HSS shall, in the event of an error in any of the steps, stop processing and return the corresponding error code. + +At reception of the Non-3GPP IP Access Registration, the HSS shall perform (in the following order): + +1. Check that the user is known. If not Experimental-Result-Code shall be set to DIAMETER\_ERROR\_USER\_UNKNOWN. +2. The HSS shall check if there is an existing 3GPP AAA Server already assisting the user + - If there is a 3GPP AAA Server already serving the user, the HSS shall compare the 3GPP AAA Server name received in the request to the 3GPP AAA Server name stored in the HSS. + - If they are not identical the HSS shall return the old 3GPP AAA Server to the requester 3GPP AAA Server and return an error by setting the Experimental-Result-Code to DIAMETER\_ERROR\_IDENTITY\_ALREADY\_REGISTERED. + +The requester 3GPP AAA Server, upon detection of a 3GPP AAA Server name in the response assumes that the user already has a 3GPP AAA Server assigned, so makes use of Diameter redirect function to indicate the 3GPP AAA Server name where to address the Non-3GPP IP Access Registration request. + +- If they are identical but there is no APN configuration information in HSS for the user, the HSS shall return the Experimental Result Code DIAMETER\_ERROR\_USER\_NO\_NON\_3GPP\_SUBSCRIPTION and it shall remove the 3GPP AAA Server name previously assigned for this subscriber. +- If there is not a 3GPP AAA Server already serving the user, the HSS shall return an error, setting the Result-Code to DIAMETER\_UNABLE\_TO\_COMPLY in the Response command. + +3. After the HSS has determined that the requesting 3GPP AAA server is identical to the registered 3GPP AAA server, the HSS shall check the Server Assignment Type value received in the request: + - If it indicates REGISTRATION, the HSS shall set the subscribers User Status to REGISTERED for the authenticated and authorized trusted or untrusted non-3GPP IP access subscriber, download the relevant user profile information and set the Result-Code AVP to DIAMETER\_SUCCESS in the Server-Assignment-Response command. For those APNs that have been authorized as a consequence of having the Wildcard APN in the user subscription, the HSS shall include the specific APN name and associated PDN-GW identity inside the Specific-APN-Info AVP of the Wildcard APN. + - If it indicates USER\_DEREGISTRATION / ADMINISTRATIVE\_DEREGISTRATION / AUTHENTICATION\_FAILURE / AUTHENTICATION\_TIMEOUT, the HSS shall remove the 3GPP AAA Server name previously assigned for the subscriber, set the User Status for the subscriber to NOT\_REGISTERED and set the Result-Code AVP to DIAMETER\_SUCCESS in the Server-Assignment-Response command. The HSS shall not remove the stored dynamic PGW-ID and APN information for the subscriber. + - If it indicates AAA\_USER\_DATA\_REQUEST, the HSS shall download the relevant user profile information to the requester 3GPP AAA Server and set the Result-Code AVP to DIAMETER\_SUCCESS in the Response command. + - If it indicates PGW\_UPDATE, the HSS shall check if the subscriber is registered. + + +If the subscriber is registered and the Emergency-Services AVP is present in the request, with the Emergency-Indication bit set, the HSS shall store the PDN GW Identity as the PDN GW used to establish emergency PDN connections by the non-3GPP access network, and update the MME with this information as specified in 3GPP TS 29.272 [29]. + +If the subscriber is registered and the Emergency-Indication bit of the Emergency-Services AVP is not set in the request, and there is not a static PDN GW subscribed, the HSS shall store the PGW identity and PLMN (if it is received in the command) for the non-3GPP user and the APN identified by the APN Id or by the Context Identifier if present in the request; otherwise, the HSS shall not update or delete the stored PDN GW and, for this case, shall set the result code to DIAMETER\_UNABLE\_TO\_COMPLY. + +If the APN corresponding to the PGW identity is not present in the subscription but the wild card APN is present in the subscription, the HSS shall store the new PDN GW identity and PLMN for an APN if present in the request. The HSS shall set the Result-Code AVP to DIAMETER\_SUCCESS in the Server-Assignment-Response command. If the Context Identifier is included in the request, the HSS may use it to locate the APN Configuration. + +If the APN corresponding to the PGW identity is not present in the subscription and the wild card APN is not present in the subscription, the HSS shall reject the request and set the Result-Code AVP to DIAMETER\_UNABLE\_TO\_COMPLY. + +If the subscriber is not registered, the HSS shall reject the request and set the Experimental-Result-Code AVP to DIAMETER\_ERROR\_IDENTITY\_NOT\_REGISTERED. + - If it indicates any other value, the Result-Code shall be set to DIAMETER\_UNABLE\_TO\_COMPLY, and no registration/de-registration or profile download procedure shall be performed. + +Origin-Host AVP shall contain the 3GPP AAA Server identity. + +If the subscription data received for a certain APN indicates that the APN was authorized as a consequence of having the Wildcard APN in the user subscription in HSS, then the 3GPP AAA Server shall not store this APN data beyond the lifetime of the UE sessions related to the specific APN and the 3GPP AAA Server shall delete them upon disconnection of the UE. If the PGW Identity contains an FQDN of the PDN GW, the 3GPP AAA Server shall retrieve the PGW PLMN ID from the MIP-Home-Agent-Host AVP within the MIP6-Agent-Info AVP which contains the PGW Identity. + +For trusted WLAN access, if the transparent single-connection mode is used as specified in 3GPP TS 24.302 [26], the 3GPP AAA Server may be configured by local policy to not update the HSS with the PGW Identity used over TWAN for the default APN of the user (i.e. to skip the Non-3GPP IP Access Registration request with Server-Assignment-Type set to "PGW\_UPDATE"). + +NOTE: This 3GPP AAA Server option can be used when the same APN is configured for TWAN and other access technologies in which case the network can select different PDN GWs for PDN connections to this APN. Updating the HSS with the selected PDN GW identity for Trusted WLAN access could affect PDN connections over other access technologies. + +### 8.1.2.2.3 Network Initiated De-Registration by HSS, Administrative + +#### 8.1.2.2.3.1 General + +This procedure is used between the 3GPP AAA Server and the HSS to remove a previous registration and all associated state. When the de-registration procedure is initiated by HSS, indicating that a subscription has to be removed, the 3GPP AAA Server subsequently triggers the detach procedure via the appropriate interface. + +**Table 8.3.2.3: Network Initiated Deregistration by HSS request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|-------------------------------------------------|---------------------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| IMSI | User-Name
(See IETF RFC 6733 [58]) | M | This information element shall contain the user IMSI and shall be formatted according to 3GPP TS 23.003 [14], clause 2.2. | +| Reason for de-registration | Deregistration-Reason | M | This IE shall contain the reason for the de-registration as the HSS shall send to the 3GPP AAA server a reason for the de-registration. The de-registration reason shall be composed of two parts: one textual message (if available) that is intended to be forwarded to the user that is de-registered, and one reason code (see 3GPP TS 29.229 [24]) that determines the behaviour of the 3GPP AAA Server. | +| Routing Information | Destination-Host | M | This IE shall contain the 3GPP AAA server name that is obtained from the Origin-Host AVP, which is received from the 3GPP AAA Server, | +| Supported Features
(See 3GPP TS 29.229 [24]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | + +**Table 8.3.2.4: Network Initiated Deregistration by HSS response** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|-------------------------------------------------|-----------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result | Result-Code / Experimental-Result | M | This IE shall contain the Result of the operation. The Result-Code AVP shall be used for errors defined in the Diameter base protocol (see IETF RFC 6733 [58]). The Experimental-Result AVP shall be used for SWx errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | +| Supported Features
(See 3GPP TS 29.229 [24]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | + +#### 8.1.2.2.3.2 Detailed behaviour + +The HSS shall de-register the affected identity and invoke this procedure to inform the 3GPP AAA server to remove the subscribed user from the 3GPP AAA Server. + +The HSS shall send in the Deregistration-Reason AVP the reason for the de-registration, composed by a textual message (if available) aimed for the user and a reason code that determines the action the 3GPP AAA server has to perform. The possible reason codes are: + +- PERMANENT\_TERMINATION: The non-3gpp subscription or service profile(s) has been permanently terminated or the Core Network Restrictions do not allow access to EPC anymore. The HSS shall clear the user's 3GPP AAA Server name and set the User Status to NOT\_REGISTERED. The 3GPP AAA Server should start the network initiated de-registration towards the user. +- NEW\_SERVER\_ASSIGNED: The HSS indicates to the 3GPP AAA Server that a new 3GPP AAA Server has been allocated to the user (e.g. because the previous assigned 3GPP AAA Server was found unavailable at a certain point). The 3GPP AAA Server shall remove all user data and session information for the user indicated in the de-registration request. The 3GPP AAA Server shall not start the network initiated de-registration towards the user. + +### 8.1.2.3 HSS Initiated Update of User Profile + +#### 8.1.2.3.1 General + +According to the requirements described in 3GPP TS 23.402 [3], 3GPP TS 32.422 [32] and 3GPP TS 23.380 [52], SWx reference point shall enable: + +- Indication to 3GPP AAA Server of change of non-3GPP subscriber profile within HSS; +- Activation and deactivation of the subscriber and equipment trace in the PDN GW. +- Request of identity and location information of the access network and/or UE local time zone. +- Indication to the 3GPP AAA Server that the HSS-based P-CSCF restoration procedure for WLAN, shall be executed as described in 3GPP TS 23.380 [52] clause 5.6. + +This procedure is used between the 3GPP AAA Server and the HSS. The procedure is invoked by the HSS when the subscriber profile has been modified and needs to be sent to the 3GPP AAA Server. This may happen due to a modification in the HSS. + +The procedure is also invoked by the HSS to update the 3GPP AAA Server with + +- the identity of a dynamically allocated PDN GW which is included in the APN-Configuration AVP in the User Profile as a result of the first PDN connection establishment associated with an APN over 3GPP access; or +- the identity of a dynamically allocated PDN GW for emergency services as a result of the establishment of an emergency PDN connection in E-UTRAN. + +This procedure is mapped to the Diameter command codes Push-Profile-Request (PPR) and Push-Profile-Answer (PPA) specified in the 3GPP TS 29.229 [24]. Information element contents for these messages are shown in tables 8.1.2.3.1/1 and 8.1.2.3.1/2. + +**Table 8.1.2.3.1/1: User Profile Update request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|-------------------------------------------------|---------------------------------------|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| IMSI | User-Name
(See IETF RFC 6733 [58]) | M | This information element shall contain the user IMSI and shall be formatted according to 3GPP TS 23.003 [14], clause 2.2. | +| User profile | Non-3GPP-User-Data | M | This IE shall contain the updated user profile. Clause 8.2.3.1 details the contents of the AVP.
In case of trace activation or deactivation, the Trace-Info AVP shall be included, and this may be the only AVP that is present under this grouped AVP. | +| Routing Information | Destination-Host | M | This IE shall contain the 3GPP AAA Server name that is obtained from the Origin-Host AVP, which is received from the 3GPP AAA Server | +| PPR Flags | PPR-Flags | O | This Information Element contains a bit mask. See 8.2.3.17 for the meaning of the bits. | +| Supported Features
(See 3GPP TS 29.229 [24]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | + +**Table 8.1.2.3.1/2: User Profile Update response** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|-------------------------------------------------|-----------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation.
The Result-Code AVP shall be used for errors defined in the Diameter base protocol (see IETF RFC 6733 [58]).
The Experimental-Result AVP shall be used for SWx errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | +| Access Network Information | Access-Network-Info | O | If present, this IE shall contain the identity and location information of the access network where the UE is attached. | +| Local Time Zone | Local-Time-Zone | O | If present, this IE shall contain the time zone of the location in the access network where the UE is attached. | +| Supported Features
(See 3GPP TS 29.229 [24]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | + +### 8.1.2.3.2 HSS Detailed behaviour + +The HSS shall make use of this procedure to update the relevant user profile in the 3GPP AAA server (e.g. change of subscription data or change of the identity of a dynamically allocated PDN GW associated with an APN), or activate / deactivate subscriber and equipment trace in the PDN GW. + +The HSS shall make use of this procedure to request the identity, location information and UE local time zone of the access network where the UE is currently attached. In this case, the HSS shall set the Access-Network-Info-Request and/or the UE-Local-Time-Zone-Request bits in the PPR-Flags AVP; if the HSS sends this command for the only purpose of requesting access network information or the local time zone of the UE (i.e., the user profile is not actually modified), the Non-3GPP-User-Data shall be included in the command as an empty AVP. The HSS shall only invoke this procedure if the 3GPP AAA Server has indicated support for the corresponding feature (see clause 8.2.3.16). + +The HSS shall make use of this procedure to request to the 3GPP AAA Server the execution of the HSS-based P-CSCF restoration procedure, as described in 3GPP TS 23.380 [52] clause 5.4 if the 3GPP AAA Server indicated the support of this procedure in an earlier command to the HSS. In this case, the HSS shall set the "P-CSCF Restoration Request" bit in the PPR Flags and the procedure shall only be used for the purpose of the P-CSCF restoration for WLAN; then, the Non-3GPP-User-Data AVP shall be included as an empty AVP. + +The HSS shall make use of this procedure to update the identity of a dynamically allocated PDN GW for emergency services in the 3GPP AAA server, if the 3GPP AAA Server indicated the support of the Emergency Services Continuity feature in an earlier command to the HSS. + +### 8.1.2.3.3 3GPP AAA Server Detailed behaviour + +When the HSS-initiated user profile update procedure is successful, the 3GPP AAA Server shall overwrite entirely, for the subscriber identity indicated in the request, the currently stored user profile data with the information received from the HSS, if at least one APN-Configuration AVP is included in the Non-3GPP-User-Data AVP received from HSS. If no APN-Configurations are included in the Non-3GPP-User-Data AVP, the 3GPP AAA Server shall only update the currently stored user profile data with the new received data from the HSS. + +If the HSS-initiated user profile update procedure is not successful, the 3GPP AAA Server shall not modify the stored user profile. + +After a successful user profile download, the 3GPP AAA Server shall initiate re-authentication procedure as described in clause 7.2.2.4 if the subscriber has previously been authenticated and authorized to untrusted non-3GPP access. If the subscriber has previously been authenticated and authorized to trusted non-3GPP IP Access then the 3GPP AAA Server shall initiate a re-authorization procedure as described in clause 5.1.2.3. + +As multiple authorization sessions may exist for the user (see clause 7.1.2.1), the 3GPP AAA Server shall examine the need to execute re-authorization for each of these sessions, and may execute the multiple re-authorization procedures in parallel. In case the user's non-3GPP subscription has been deleted or the user's APN has been barred, the re-authorization shall be executed in all ongoing user related authorization sessions. Otherwise, the re-authorization procedure shall be invoked for the authorization sessions for which at least one of the following conditions is fulfilled: + +- The user's subscribed APN has been deleted from the HSS. +- The APN configuration data has been previously downloaded to the ePDG and the new version of APN configuration received from HSS reflects a modification in these data. + +Following a successful download of subscription and equipment trace data, the 3GPP AAA Server shall forward the trace data by initiating reauthorization towards all PDN GWs that have an active authorization session. + +When the UE is attached to a Trusted WLAN, if the HSS has invoked the User Profile Update procedure by setting the Access-Network-Info-Request and/or UE-Local-Time-Zone-Request bits in the PPR-Flags, the 3GPP AAA Server shall initiate a re-authorization procedure towards the TWAN by setting the Re-Auth-Request-Type to AUTHORIZE\_ONLY; the TWAN shall send the identification, location information of the Access Point where the UE is attached and the local time zone of the UE, in the subsequent authorization request (AAR command) that follows the re-authorization request/answer exchange (RAR/RAA). If the 3GPP AAA Server determines that the UE is not currently attached to a Trusted WLAN, it shall not initiate any re-authorization procedure towards the access network, and it shall not include any network access information or UE local time zone in the response to the HSS. + +NOTE: The 3GPP AAA Server cannot answer the Push Profile Request received from the HSS until the AAR command has been received from the TWAN, since it needs to receive the information from the access network, before sending back the Push Profile Answer to the HSS. + +If the 3GPP AAA Server receives the Push-Profile-Request command with an empty Non-3GPP-User-Data AVP, but some other action is indicated by setting any of the bits in the PPR-Flags AVP, the 3GPP AAA Server shall ignore the Non-3GPP-User-Data AVP, i.e., it shall not apply any changes to the stored user profile. + +When the PPR Flags are received with the "P-CSCF Restoration Request" bit set, if an IMS PDN connection is established via a trusted or untrusted WLAN access for which the PGW has indicated the support of the P-CSCF restoration feature in an earlier command, the 3GPP AAA Server shall execute the HSS-based P-CSCF restoration for WLAN procedure, as described in 3GPP TS 23.380 [52] clause 5.6. Otherwise, the 3GPP AAA Server does not execute the HSS-based P-CSCF restoration for WLAN procedure. + +Table 8.1.2.3.3/1 details the valid result codes that the 3GPP AAA Server can return in the response. + +**Table 8.1.2.3.3/1: User profile response valid result codes** + +| Result-Code AVP value | Condition | +|-----------------------------|----------------------------------------------------------------------| +| DIAMETER_SUCCESS | The request succeeded. | +| DIAMETER_ERROR_USER_UNKNOWN | The request failed because the user is not found in 3GPP AAA Server. | +| DIAMETER_UNABLE_TO_COMPLY | The request failed. | + +## 8.1.2.4 Fault Recovery Procedures + +### 8.1.2.4.1 HSS Reset Indication + +#### 8.1.2.4.1.1 General + +This procedure is used by the HSS to indicate to the 3GPP AAA Server that it has restarted, and the registration data and the dynamic data stored for a set of users may have been lost. + +This procedure is mapped to the Diameter command codes Push-Profile-Request (PPR) and Push-Profile-Answer (PPA) specified in the 3GPP TS 29.229 [24]. Information Element contents for these messages are shown in tables 8.1.2.4.1.1/1 and 8.1.2.4.1.1/2. + +**Table 8.1.2.4.1.1/1: HSS Reset Indication Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|-------------------------------------------------|---------------------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| User List | User-Name
(See IETF RFC 6733 [58]) | M | This information element shall indicate the users affected by the HSS restart. It shall contain either:
- The string "*", if all users are affected by the restart
- The leading digits of the IMSI series of the set of users affected by the restart. | +| Supported Features
(See 3GPP TS 29.229 [24]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| PPR Flags | PPR-Flags | M | This Information Element contains a bit mask. See 8.2.3.17 for the meaning of the bits. The HSS shall set the Reset-Indication bit when sending PPR to the 3GPP AAA Server. | + +**Table 8.1.2.4.1.1/2: HSS Reset Indication Response** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|----------------------------------------------|-----------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation.
The Result-Code AVP shall be used for errors defined in the Diameter base protocol (see IETF RFC 6733 [58]).
The Experimental-Result AVP shall be used for SWx errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | +| Supported Features (See 3GPP TS 29.229 [24]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | + +#### 8.1.2.4.1.2 HSS Detailed behaviour + +The HSS shall use this procedure to indicate to the 3GPP AAA Server about a restart event, affecting a set of users, for whom their registration data and dynamic data may have been lost. The HSS shall only send this command if the 3GPP AAA Server has indicated support for the "HSS Restoration" feature. In this case, the HSS shall set the Reset-Indication bit in the PPR-Flags AVP in the PPR command. + +NOTE: If there are multiple 3GPP AAA Servers deployed in the HPLMN, and the HSS is configured (in an implementation-specific manner) in such a way that it can determine that a certain 3GPP AAA Server does not contain any of the users affected by the restart, it can skip sending the PPR command to that specific 3GPP AAA Server. + +#### 8.1.2.4.1.3 3GPP AAA Server Detailed behaviour + +If the 3GPP AAA Server supports the "HSS Restoration" feature, it shall answer with a successful result to the PPR command, and it shall mark those users affected by the HSS restart as "pending to be restored in HSS". + +The 3GPP AAA Server shall use the HSS Identity received in the Origin-Host AVP (by comparing it with the value stored after a successful MAA command) and may make use of the received "User List" Information Element in order to determine which subscriber records are impacted, if any. If the 3GPP AAA Server determines that there are no subscribers affected by the HSS restart, it shall answer with a successful result to the HSS. + +#### 8.1.2.4.2 HSS Restoration + +##### 8.1.2.4.2.1 General + +This procedure is used by the 3GPP AAA Server to restore in the HSS the registration data and the dynamic data for a certain user. The 3GPP AAA Server shall use this procedure only after having received a previous indication from HSS of a restart event affecting that user. + +This procedure is mapped to the Diameter command codes Server-Assignment-Request (SAR) and Server-Assignment-Answer (SAA) specified in the 3GPP TS 29.229 [24]. Information element contents for these messages are shown in tables 8.1.2.4.2.1/1 and 8.1.2.4.2.1/2. + +**Table 8.1.2.4.2.1/1: HSS Restoration Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|-------------------------------------------------|---------------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| IMSI | User-Name
(See IETF RFC 6733 [58]) | M | This information element shall contain the IMSI of the user, for whom the registration data and dynamic data is being restored in HSS, and it shall be formatted according to 3GPP TS 23.003 [14], clause 2.2. | +| Server Assignment Type | Server-Assignment-Type | M | This IE shall contain the value "RESTORATION". | +| Active APN | Active-APN | C |

This Information Element, if present, contains the list of active APNs stored by the 3GPP AAA Server for this user, including the identity of the PDN GW assigned to each APN. For the explicitly subscribed APNs, the following information shall be present:

  • - Context-Identifier: context id of subscribed APN in use
  • - Service-Selection: name of subscribed APN in use
  • - MIP6-Agent-Info: including PDN GW identity in use for subscribed APN
  • - Visited-Network-Identifier: identifies the PLMN where the PDN GW was allocated

For the Wildcard APN, the following information shall be present:

  • - Context-Identifier: context id of the Wildcard APN
  • - Specific-APN-Info: list of APN-in use and related PDN GW identity when the subscribed APN is the wildcard APN
| +| Supported Features
(See 3GPP TS 29.229 [24]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | + +**Table 8.1.2.4.2.1/2: HSS Restoration Response** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|-------------------------------------------------|---------------------------------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| IMSI | User-Name
(See IETF RFC 6733 [58]) | M | This information element shall contain the user IMSI and shall be formatted according to 3GPP TS 23.003 [14], clause 2.2. | +| Registration result | Result-Code / Experimental-Result | M |

This IE contains the result of the operation.

The Result-Code AVP shall be used for errors defined in the Diameter base protocol (see IETF RFC 6733 [58]).

The Experimental-Result AVP shall be used for SWx errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP.

| +| Supported Features
(See 3GPP TS 29.229 [24]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | + +#### 8.1.2.4.2.2 HSS Detailed behaviour + +Upon receipt of the SAR command, if the HSS supports the "HSS Restoration" feature, and the user's IMSI is known, the HSS shall update the registration data (from the Origin-Host AVP received in the 3GPP AAA Server command) and dynamic data of the user (included in the "Active APN" Information Element), and answer with a successful result. + +#### 8.1.2.4.2.3 3GPP AAA Server Detailed behaviour + +The 3GPP AAA Server shall use this command to update the HSS with the registration data and dynamic data it has for a user affected by the HSS restart, identified by the "User List" IE received previously in the PPR command, and marked in the 3GPP AAA Server as "pending to be restored in HSS". The 3GPP AAA Server shall only make use of this procedure in the HSS has indicated support for the "HSS Restoration" feature. + +The 3GPP AAA Server shall invoke the SAR command towards the HSS, after having received further interactions over other reference points (S6b, STa, SWm ...) for a user marked as "pending to be restored in HSS". + +Once the 3GPP AAA Server receives confirmation from HSS, in the SAA command, that the user has been successfully restored in the HSS, via the "HSS Restoration Response" command, it shall clear the "pending to be restored in HSS" flag for that user. + +## 8.2 Protocol Specification + +### 8.2.1 General + +The SWx reference point shall be Diameter based. This is defined as an IETF vendor specific Diameter application, where the Vendor ID is 3GPP. The Application Id used shall be 16777265. + +### 8.2.2 Commands + +#### 8.2.2.1 Authentication Procedure + +The Multimedia-Authentication-Request (MAR) command, indicated by the Command-Code field set to 303 and the 'R' bit set in the Command Flags field, is sent by the 3GPP AAA Server to the HSS in order to request security information. This corresponds to clause 8.1.2.1. + +Message Format + +``` +< Multimedia-Auth-Request > ::= < Diameter Header: 303, REQ, PXY, 16777265 > + < Session-Id > + [ DRMP ] + { Vendor-Specific-Application-Id } + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + [ Destination-Host ] + { User-Name } + [ RAT-Type ] + [ ANID ] + [ Visited-Network-Identifier ] + [ Terminal-Information ] + { SIP-Auth-Data-Item } + { SIP-Number-Auth-Items } + [ AAA-Failure-Indication ] + [ OC-Supported-Features ] + *[ Supported-Features ] + ... + *[ AVP ] +``` + +The Multimedia-Authentication-Answer (MAA) command, indicated by the Command-Code field set to 303 and the 'R' bit cleared in the Command Flags field, is sent by a server in response to the Multimedia-Authentication-Request command. The Result-Code or Experimental-Result AVP may contain one of the values defined in clause 6.2 of 3GPP TS 29.229 [24] in addition to the values defined in IETF RFC 6733 [58]. + +#### Message Format + +``` +< Multimedia-Auth-Answer > ::= < Diameter Header: 303, PXY, 16777265 > + < Session-Id > + [ DRMP ] + { Vendor-Specific-Application-Id } + [ Result-Code ] + [ Experimental-Result ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + { User-Name } + [ SIP-Number-Auth-Items ] + *[ SIP-Auth-Data-Item ] + [ 3GPP-AAA-Server-Name ] + [ OC-Supported-Features ] + [ OC-OLR ] + *[ Load ] + *[ Supported-Features ] + ... + *[ AVP ] +``` + +NOTE: As the Diameter commands described in this specification have been defined based on the former specification of the Diameter base protocol, the Vendor-Specific-Application-Id AVP is still listed as a required AVP (an AVP indicated as {AVP}) in the command code format specifications defined in this specification to avoid backward compatibility issues, even if the use of this AVP has been deprecated in the new specification of the Diameter base protocol (IETF RFC 6733 [58]). + +### 8.2.2.2 HSS Initiated Update of User Profile Procedure + +The Push-Profile-Request (PPR) command, indicated by the Command-Code field set to 305 and the 'R' bit set in the Command Flags field, is sent by the HSS to the 3GPP AAA Server in order to update the subscription data whenever a modification has occurred in the subscription data; this corresponds to clause 8.1.2.3. This command is also sent by HSS to indicate a restart event to the 3GPP AAA Server, so the registration data and the dynamic data previously stored in HSS can be restored; this corresponds to clause 8.1.2.4.1. + +#### Message Format + +``` +< Push-Profile-Request > ::= < Diameter Header: 305, REQ, 16777265 > + < Session-Id > + [ DRMP ] + { Vendor-Specific-Application-Id } + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + { Destination-Host } + { Destination-Realm } + { User-Name } + [ Non-3GPP-User-Data ] + [ PPR-Flags ] + *[ Supported-Features ] + ... + *[ AVP ] +``` + +The Push-Profile-Answer (PPA) command, indicated by the Command-Code field set to 305 and the 'R' bit cleared in the Command Flags field, is sent by the HSS in response to the Push-Profile-Request command. The Result-Code or + +Experimental-Result AVP may contain one of the values defined in clause 6.2 of 3GPP TS 29.229 [24] in addition to the values defined in IETF RFC 6733 [58]. + +#### Message Format + +``` +< Push-Profile-Answer > ::= < Diameter Header: 305, PXY, 16777265 > +< Session-Id > +[ DRMP ] +{ Vendor-Specific-Application-Id } +[ Result-Code ] +[ Experimental-Result ] +{ Auth-Session-State } +{ Origin-Host } +{ Origin-Realm } +[ Access-Network-Info ] +[ Local-Time-Zone ] +*[ Supported-Features ] +... +*[ AVP ] +``` + +NOTE: As the Diameter commands described in this specification have been defined based on the former specification of the Diameter base protocol, the Vendor-Specific-Application-Id AVP is still listed as a required AVP (an AVP indicated as {AVP}) in the command code format specifications defined in this specification to avoid backward compatibility issues, even if the use of this AVP has been deprecated in the new specification of the Diameter base protocol (IETF RFC 6733 [58]). + +### 8.2.2.3 Non-3GPP IP Access Registration Procedure + +The Server-Assignment-Request (SAR) command, indicated by the Command-Code field set to 301 and the 'R' bit set in the Command Flags field, is sent by the 3GPP AAA Server to the HSS; this corresponds to clause 8.1.2.2.2. This command is also sent by the 3GPP AAA Server to restore the registration data and the dynamic data previously stored in HSS, which may have been lost after a restart; this corresponds to clause 8.1.2.4.2. + +#### Message Format + +``` +< Server-Assignment-Request > ::= < Diameter Header: 301, REQ, PXY, 16777265 > +< Session-Id > +[ DRMP ] +{ Vendor-Specific-Application-Id } +{ Auth-Session-State } +{ Origin-Host } +{ Origin-Realm } +[ Destination-Host ] +{ Destination-Realm } +[ Service-Selection ] +[ Context-Identifier ] +[ MIP6-Agent-Info ] +[ Visited-Network-Identifier ] +{ User-Name } +{ Server-Assignment-Type } +*[ Active-APN ] +[ OC-Supported-Features ] +*[ Supported-Features ] +[ Terminal-Information ] +[ Emergency-Services ] +... +*[ AVP ] +``` + +The Server-Assignment-Answer (SAA) command, indicated by the Command-Code field set to 301 and the 'R' bit cleared in the Command Flags field, is sent by the HSS to the 3GPP AAA Server to confirm the registration, de-registration, user profile download or restoration procedure. The Result-Code or Experimental-Result AVP may + +contain one of the values defined in clause 6.2 of 3GPP TS 29.229 [24] in addition to the values defined in IETF RFC 6733 [58]. + +#### Message Format + +``` +< Server-Assignment-Answer > ::= < Diameter Header: 301, PXY, 16777265 > + < Session-Id > + [ DRMP ] + { Vendor-Specific-Application-Id } + [ Result-Code ] + [ Experimental-Result ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + { User-Name } + [ Non-3GPP-User-Data ] + [ 3GPP-AAA-Server-Name ] + [ OC-Supported-Features ] + [ OC-OLR ] + *[ Load ] + *[ Supported-Features ] + ... + *[ AVP ] +``` + +NOTE: As the Diameter commands described in this specification have been defined based on the former specification of the Diameter base protocol, the Vendor-Specific-Application-Id AVP is still listed as a required AVP (an AVP indicated as {AVP}) in the command code format specifications defined in this specification to avoid backward compatibility issues, even if the use of this AVP has been deprecated in the new specification of the Diameter base protocol (IETF RFC 6733 [58]). + +#### 8.2.2.4 Network Initiated De-Registration by HSS Procedure + +The Registration-Termination-Request (RTR) command, indicated by the Command-Code field set to 304 and the "R" bit set in the Command Flags field, is sent by a Diameter Multimedia server to a Diameter Multimedia client in order to request the de-registration of a user. This corresponds to clause 8.1.2.2.3. + +#### Message Format + +``` + ::= < Diameter Header: 304, REQ, PXY, 16777265 > + < Session-Id > + [ DRMP ] + { Vendor-Specific-Application-Id } + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + { Destination-Host } + { Destination-Realm } + { User-Name } + { Deregistration-Reason } + *[ Supported-Features ] + ... + *[ AVP ] +``` + +The Registration-Termination-Answer (RTA) command, indicated by the Command-Code field set to 304 and the "R" bit cleared in the Command Flags field, is sent by a client in response to the Registration-Termination-Request command. The Result-Code or Experimental-Result AVP may contain one of the values defined in clause 6.2 of 3GPP TS 29.229 [24] in addition to the values defined in IETF RFC 6733 [58]. + +#### Message Format + +``` + ::= < Diameter Header: 304, PXY, 16777265 > + < Session-Id > + [ DRMP ] +``` + +``` + +{ Vendor-Specific-Application-Id } +[ Result-Code ] +[ Experimental-Result ] +{ Auth-Session-State } +{ Origin-Host } +{ Origin-Realm } +*[ Supported-Features ] +... +*[ AVP ] + +``` + +NOTE: As the Diameter commands described in this specification have been defined based on the former specification of the Diameter base protocol, the Vendor-Specific-Application-Id AVP is still listed as a required AVP (an AVP indicated as {AVP}) in the command code format specifications defined in this specification to avoid backward compatibility issues, even if the use of this AVP has been deprecated in the new specification of the Diameter base protocol (IETF RFC 6733 [58]). + +## 8.2.3 Information Elements + +### 8.2.3.0 General + +The following table describes the Diameter AVPs defined for the SWx interface protocol, their AVP Code values, types, possible flag values and whether or not the AVP may be encrypted. + +For all AVPs which contain bit masks and are of the type Unsigned32, bit 0 shall be the least significant bit. For example, to get the value of bit 0, a bit mask of 0x00000001 should be used. + +**Table 8.2.3.0/1: Diameter SWx AVPs** + +| Attribute Name | AVP Code | Clause defined | Value Type | AVP Flag rules | | | | +|-----------------------------|----------|----------------|------------------|----------------|-----|------------|----------| +| | | | | Must | May | Should not | Must not | +| Non-3GPP-User-Data | 1500 | 8.2.3.1 | Grouped | M,V | | | P | +| Non-3GPP-IP-Access | 1501 | 8.2.3.3 | Enumerated | M,V | | | P | +| Non-3GPP-IP-Access-APN | 1502 | 8.2.3.4 | Enumerated | M,V | | | P | +| ANID | 1504 | 5.2.3.7 | UTF8String | M,V | | | P | +| Trace-Info | 1505 | 8.2.3.13 | Grouped | V | | | M,P | +| PPR-Flags | 1508 | 8.2.3.17 | Unsigned32 | V | | | M,P | +| TWAN-Default-APN-Context-Id | 1512 | 8.2.3.18 | Unsigned32 | V | | | M,P | +| TWAN-Access-Info | 1510 | 8.2.3.19 | Grouped | V | | | M,P | +| Access-Authorization-Flags | 1511 | 8.2.3.20 | Unsigned32 | V | | | M,P | +| WLAN-Identifier | 1509 | 5.2.3.18 | Grouped | V | | | M,P | +| Service-Selection | 493 | 5.2.3.5 | UTF8String | M | | | V,P | +| AAA-Failure-Indication | 1518 | 8.2.3.21 | Unsigned32 | V | | | M,P | +| Access-Network-Info | 1524 | 5.2.3.24 | Grouped | V | | | M,P | +| 3GPP-AAA-Server-Name | 318 | 8.2.3.24 | DiameterIdentity | M, V | | | P | +| ERP-Authorization | 1541 | 8.2.3.27 | Unsigned32 | V | | | M,P | + +NOTE 1: The AVP header bit denoted as "M", indicates whether support of the AVP is required. The AVP header bit denoted as "V", indicates whether the optional Vendor-ID field is present in the AVP header. For further details, see IETF RFC 6733 [58]. + +NOTE 2: If the M-bit is set for an AVP and the receiver does not understand the AVP, it shall return a rejection. If the M-bit is not set for an AVP, the receiver shall not return a rejection, whether or not it understands the AVP. If the receiver understands the AVP but the M-bit value does not match with the definition in this table, the receiver shall ignore the M-bit. + +The following table describes the Diameter AVPs re-used by the SWx interface protocol from existing Diameter Applications, including a reference to their respective specifications and when needed, a short description of their use within SWx. Other AVPs from existing Diameter Applications, except for the AVPs from Diameter base protocol (see IETF RFC 6733 [58]), do not need to be supported. + +**Table 8.2.3.0/2: SWx re-used Diameter AVPs** + +| Attribute Name | Reference | Comments | M-bit | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------|---------------------|--------------| +| User-Name | ETF RFC 6733 [58] | | | +| Session-Timeout | ETF RFC 6733 [58] | | | +| Subscription-ID | IETF RFC 4006 [20] | | | +| MIP6-Agent-Info | IETF RFC 5447 [6] | | | +| MIP6-Feature-Vector | IETF RFC 5447 [6] | | | +| Service-Selection | IETF RFC 5778 [11] | | | +| 3GPP-Charging-Characteristics | 3GPP TS 29.061 [31] | | | +| RAT-Type | 3GPP TS 29.212 [23] | | | +| Visited-Network-Identifier | 3GPP TS 29.229 [24] | | | +| SIP-Number-Auth-Items | 3GPP TS 29.229 [24] | | | +| SIP-Item-Number | 3GPP TS 29.229 [24] | | | +| SIP-Auth-Data-Item | 3GPP TS 29.229 [24] | | | +| SIP-Authentication-Scheme | 3GPP TS 29.229 [24] | | | +| SIP-Authenticate | 3GPP TS 29.229 [24] | | | +| SIP-Authorization | 3GPP TS 29.229 [24] | | | +| Confidentiality-Key | 3GPP TS 29.229 [24] | | | +| Integrity-Key | 3GPP TS 29.229 [24] | | | +| Server-Assignment-Type | 3GPP TS 29.229 [24] | | | +| Deregistration-Reason | 3GPP TS 29.229 [24] | | | +| Supported-Features | 3GPP TS 29.229 [24] | | | +| Feature-List-ID | 3GPP TS 29.229 [24] | | | +| Feature-List | 3GPP TS 29.229 [24] | | | +| APN-Configuration | 3GPP TS 29.272 [29] | | | +| Context-Identifier | 3GPP TS 29.272 [29] | | | +| Terminal-Information | 3GPP TS 29.272 [29] | | | +| AMBR | 3GPP TS 29.272 [29] | | | +| APN-OI-Replacement | 3GPP TS 29.272 [29] | | | +| Trace-Reference | 3GPP TS 29.272 [29] | | | +| Trace-Data | 3GPP TS 29.272 [29] | | | +| Active-APN | 3GPP TS 29.272 [29] | | | +| BSSID | 3GPP TS 32.299 [30] | | | +| Location-Information | IETF RFC 5580 [46] | | | +| Location-Data | IETF RFC 5580 [46] | | | +| Operator-Name | IETF RFC 5580 [46] | | | +| Local-Time-Zone | 3GPP TS 29.272 [29] | | | +| OC-Supported-Features | IETF RFC 7683 [47] | See clause 8.2.3.22 | Must not set | +| OC-OLR | IETF RFC 7683 [47] | See clause 8.2.3.23 | Must not set | +| DRMP | IETF RFC 7944 [53] | See clause 8.2.3.25 | Must not set | +| Emergency-Info | 3GPP TS 29.272 [29] | | | +| Load | IETF RFC 8583 [54] | See clause 8.2.3.26 | Must not set | +| UE-Usage-Type | 3GPP TS 29.272 [29] | | | +| Core-Network-Restrictions | 3GPP TS 29.272 [29] | | | +| NOTE 1: The M-bit settings for re-used AVPs override those of the defining specifications that are referenced. Values include: "Must set", "Must not set". If the M-bit setting is blank, then the defining specification applies. | | | | +| NOTE 2: If the M-bit is set for an AVP and the receiver does not understand the AVP, it shall return a rejection. If the M-bit is not set for an AVP, the receiver shall not return a rejection, whether or not it understands the AVP. If the receiver understands the AVP but the M-bit value does not match with the definition in this table, the receiver shall ignore the M-bit. | | | | + +Only those AVP initially defined in this reference point or AVP with values initially defined in this reference point and for this procedure are described in the following subchapters. + +### 8.2.3.1 Non-3GPP-User-Data + +The Non-3GPP-User-Data AVP is of type Grouped. It contains the information related to the user profile relevant for EPS. + +AVP format: + +``` +Non-3GPP-User-Data ::= < AVP Header: 1500 10415 > + [ Subscription-ID ] + [ Non-3GPP-IP-Access ] + [ Non-3GPP-IP-Access-APN ] + *[ RAT-Type ] + [ Session-Timeout ] + [ MIP6-Feature-Vector ] + [ AMBR ] + [ 3GPP-Charging-Characteristics ] + [ Context-Identifier ] + [ APN-OI-Replacement ] + *[ APN-Configuration ] + [ Trace-Info ] + [ TWAN-Default-APN-Context-Id ] + *[ TWAN-Access-Info ] + [ UE-Usage-Type ] + [ Emergency-Info ] + [ ERP-Authorization ] + [ Core-Network-Restrictions ] + *[ AVP ] +``` + +The Subscription-ID, if present in this grouped AVP, shall contain either an MSISDN (if this identity is present in the subscription), or an External Identifier (if the subscriber does not have an MSISDN identity but has an External Identifier in the subscription). + +The AMBR included in this grouped AVP shall include the AMBR associated to the user's subscription (UE-AMBR). + +The APN-OI-Replacement included in this grouped AVP shall include the UE level APN-OI-Replacement associated to the user's subscription. This APN-OI-Replacement has lower priority than APN level APN-OI-Replacement that is included in the APN-Configuration AVP. + +The Non-3GPP-User-Data AVP shall only contain APN-Configuration AVP(s) configured in the user subscription with an IP PDN type. + +The Context-Identifier in this grouped AVP shall identify the user's default APN configuration. The TWAN-Default-APN-Context-Id AVP identifies the default APN configuration for EPC access over Trusted WLAN. This AVP shall be present if the default APN configuration for EPC access over Trusted WLAN differs from the default APN configuration for 3GPP access and other non-3GPP accesses. This AVP may be present otherwise. + +The RAT-Type AVP(s) shall include the access technology type(s) not allowed for the user as specified in clause 2.13.126 of 3GPP TS 23.008 [49]. + +The Emergency-Info AVP shall contain the identity of the PDN-GW used for the establishment of emergency PDN connections. + +The MIP6-Feature-Vector may provide HSM and/or NBM authorization information (see clause 8.2.3.28). + +For the conditions specified in clause 8.1.2.3.2, the Non-3GPP-User-Data AVP shall be empty, i.e. not include any AVP. + +If the Non-3GPP-User-Data AVP is not empty, the Non-3GPP-IP-Access AVP, the Non-3GPP-IP-Access-APN AVP, the Context-Identifier AVP and at least one item of the APN-Configuration AVP shall always be included, except when the Non-3GPP-User-Data AVP is used for downloading trace activation or deactivation information on the SWx interface, for an already registered user, or when the Non-3GPP-User-Data is used for downloading the Emergency-Info. In those specific cases, the Trace-Info AVP, or respectively the Emergency-Info AVP, shall be included and the presence of any further AVPs is optional. + +### 8.2.3.2 Subscription-ID + +The Subscription-ID AVP is of type Grouped and indicates the user identity to be used for charging purposes. It is defined in the IETF RFC 4006 [20]. EPC shall make use only of the MSISDN and External Identifier values. + +When the identity to be conveyed is an MSISDN, the AVP Subscription-Id-Type shall be set to value "END\_USER\_E164". + +When the identity to be conveyed is an External Identifier, the AVP Subscription-Id-Type shall be set to value "END\_USER\_NAI". + +Then AVP Subscription-Id-Data, with type UTF8String, shall contain the identity of the user. + +AVP format: + +``` +Subscription-Id ::= < AVP Header: 443 > + [ Subscription-Id-Type ] + [ Subscription-Id-Data ] +``` + +### 8.2.3.3 Non-3GPP-IP-Access + +The Non-3GPP-IP-Access AVP (AVP code 1501) is of type Enumerated, and allows operators to determine if the subscriber is barred from using the non-3GPP access network. The following values are defined: + +NON\_3GPP\_SUBSCRIPTION\_ALLOWED (0) + +The subscriber has non-3GPP subscription and is authorized to use the non-3GPP access network. + +NON\_3GPP\_SUBSCRIPTION\_BARRED (1) + +The subscriber is barred from using the non-3GPP access network. + +### 8.2.3.4 Non-3GPP-IP-Access-APN + +The Non-3GPP-IP-Access-APN AVP (AVP code 1502) is of type Enumerated, and allows operator to disable all APNs for a subscriber at one time. The following values are defined: + +Non\_3GPP\_APNS\_ENABLE (0) + +Enable all APNs for a subscriber. + +Non\_3GPP\_APNS\_DISABLE (1) + +Disable all APNs for a subscriber + +### 8.2.3.5 RAT-Type + +The RAT-Type AVP (AVP code 1032) is of type Enumerated. The encoding of the AVP is specified in 3GPP TS 29.212 [23]. + +### 8.2.3.6 Session-Timeout + +The Session-Timeout AVP is of type Unsigned32. It is defined in IETF RFC 6733 [58] and indicates the maximum period for a session measured in seconds. This AVP is used for re-authentication purposes. If this field is not used, the non-3GPP Access Node will apply default time intervals. + +### 8.2.3.7 APN-Configuration + +The APN-Configuration AVP is of type Grouped AVP and is defined in 3GPP TS 29.272 [29]. + +The following AVPs defined in the APN-Configuration AVP in 3GPP TS 29.272 [29] are not applicable to Non-3GPP accesses and therefore need not be included in the APN-Configuration AVP over the SWx, SWd, SWm, STa and S6b reference points: + +- LIPA-Permission AVP +- Restoration-Priority AVP +- SIPTO-Local-Network-Permission AVP +- WLAN-offloadability AVP +- Non-IP-PDN-Type-Indicator AVP +- Non-IP-Data-Delivery-Mechanism AVP +- SCEF-ID AVP +- SCEF-Realm AVP +- Preferred-Data-Mode AVP + +### 8.2.3.8 ANID + +The ANID AVP is defined in chapter 5.2.3.7. + +### 8.2.3.9 SIP-Auth-Data-Item + +The SIP-Auth-Data-Item AVP is defined in 3GPP TS 29.229 [24]. The optional AVPs that are needed in SWx reference point are included in the ABNF representation below. + +AVP format: + +``` +SIP-Auth-Data-Item ::= < AVP Header: 612 10415 > + [ SIP-Item-Number ] + [ SIP-Authentication-Scheme ] + [ SIP-Authenticate ] + [ SIP-Authorization ] + [ Confidentiality-Key ] + [ Integrity-Key ] + *[ AVP ] +``` + +### 8.2.3.10 Confidentiality-Key + +The Confidentiality-Key AVP is defined in 3GPP TS 29.229 [24]. It is of type OctetString, and contains the Confidentiality Key (CK') or, after key derivation using the Access Network Identifier, the Confidentiality Key (CK'). For the 3GPP AAA server it is transparent whether the value received corresponds to CK or CK'. + +### 8.2.3.11 Integrity-Key + +The Integrity-Key AVP is defined in 3GPP TS 29.229 [24]. It is of type OctetString, and contains the Integrity Key (IK) or, after key derivation using the Access Network Identifier, the Integrity Key (IK'). For the 3GPP AAA server it is transparent whether the value received corresponds to IK or IK'. + +### 8.2.3.12 Server-Assignment-Type AVP + +The Server-Assignment-Type AVP is defined in 3GPP TS 29.229 [24] and it is of type Enumerated, and indicates the type of server update being performed in a Server-Assignment-Request operation. As part of the SWx protocol specification, the following values are additionally defined: + +AAA\_USER\_DATA\_REQUEST (12) + +This value is used to request the non-3GPP user profile data from the 3GPP AAA Server to the HSS. + +PGW\_UPDATE (13) + +This value is used to store, update or delete the PDN-GW Identity in the HSS, as requested from the 3GPP AAA Server. + +#### RESTORATION (14) + +This value is used to store in the HSS registration data and dynamic data that may have been potentially lost after a restart event. + +#### 8.2.3.13 Trace-Info + +The Trace-Info AVP is of type Grouped. This AVP shall contain the information related to subscriber and equipment trace function and the required action, i.e. activation or deactivation + +AVP format + +Trace-Info ::= < AVP header: 1505 10415> + +[Trace-Data] + +[Trace-Reference] + +\*[AVP] + +Either the Trace-Data or the Trace-Reference AVP shall be included. When trace activation is needed, Trace-Data AVP shall be included, while the trace deactivation request shall be signalled by including the Trace-Reference directly under the Trace-Info. The Trace-Reference AVP is of type OctetString. The Diameter AVP is defined in 3GPP TS 29.272 [29]. + +#### 8.2.3.14 Trace-Data + +The Trace-Data AVP is of type Grouped. The Diameter AVP is defined in 3GPP TS 29.272 [29]. + +#### 8.2.3.15 Feature-List-ID AVP + +The syntax of this AVP is defined in 3GPP TS 29.229 [24]. For this release, the Feature-List-ID AVP value shall be set to 1 for the SWx application. + +#### 8.2.3.16 Feature-List AVP + +The syntax of this AVP is defined in 3GPP TS 29.229 [24]. A null value indicates that there is no feature used by the SWx application. The meaning of the bits shall be as defined in table 8.2.3.16/1. + +**Table 8.2.3.16/1: Features of Feature-List-ID 1 used in SWx** + +| Feature bit | Feature | M/O | Description | +|-------------|--------------------------------------|-----|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | HSS Restoration | O |

HSS Restoration

This feature is applicable for the MAR/MAA, PPR/PPA and SAR/SAA command pairs.
If the 3GPP AAA Server does not indicate support for this feature in a former MAR or SAR command, the HSS shall not send a PPR command to indicate a restart event to the 3GPP AAA Server.

| +| 1 | Access-Network-Information-Retrieval | O |

Access Network Information Retrieval

This feature is applicable for the MAR/MAA and PPR/PPA and SAR/SAA command pairs.
If the 3GPP AAA Server does not indicate support for this feature in a former MAR or SAR command, the HSS shall not send a PPR command to request access network information from the 3GPP AAA Server.

| +| 2 | UE Local Time Zone Retrieval | O |

UE Local Time Zone Retrieval

This feature is applicable for the MAR/MAA and PPR/PPA and SAR/SAA command pairs.
If the 3GPP AAA Server does not indicate support for this feature in a former MAR or SAR command, the HSS shall not send a PPR command to request the local time zone of the UE from the 3GPP AAA Server.

| +| 3 | P-CSCF Restoration for WLAN | O |

Support of P-CSCF Restoration for WLAN

This feature is applicable to the MAR/MAA and PPR/PPA and SAR/SAA command pairs over the SWx interface, when the 3GPP AAA Server supports the execution of the P-CSCF restoration procedures for WLAN as described in 3GPP TS 23.380 [52] clause 5.6.
If the 3GPP AAA Server does not indicate support of this feature in a former MAR or SAR command, the HSS shall not send a PPR command requesting the execution of HSS-based P-CSCF restoration procedures for WLAN,

| +| 4 | Emergency Services Continuity | O |

Support of Emergency Services Continuity

This feature is applicable to the PPR/PPA and SAR/SAA command pairs over the SWx interface, when the HSS and the 3GPP AAA Server support the continuity of emergency services upon mobility between 3GPP and WLAN accesses, as specified in clause 4.5.7.2 of 3GPP TS 23.402 [3].
If the 3GPP AAA Server does not indicate support of this feature in a former SAR command, the HSS shall not include the Emergency Info in a SAA command and shall not send a PPR command to update the Emergency Info.
If the HSS does not indicate support of this feature in a former SAA command (e.g. during the registration of the non-3GPP user), the 3GPP AAA Server shall not send a SAR command to update the Emergency Info.
If the HSS supports this feature on SWx, it shall also support the Emergency Service Continuity feature on S6a, see 3GPP TS 29.272 [29].

| +| 5 | ERP | O |

Support of EAP Reauthentication Protocol

This feature is applicable to the MAR/MAA and PPR/PPA command pairs over the SWx interface.
If the 3GPP AAA Server does not indicate support of this feature in a former MAR command, the HSS shall not include ERP authorization data in the subscription profile, and it shall not send subsequent PPR commands to update the ERP authorization status of this user.
If the HSS does not indicate support of this feature in the MAA command, the 3GPP AAA Server shall not expect the reception of explicit authorization of ERP in the subscription profile, and may allow/disallow ERP for all subscribers, according to local policy.

| + +| | | | | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 6 | Dedicated Core Networks | O |

Support of Dedicated Core Networks

This feature is applicable to the SAR/SAA and PPR/PPA command pairs over the SWx interface.

If the 3GPP AAA Server does not indicate support of this feature in the SAR command, the HSS shall not send DCN-related subscription data (e.g., UE Usage Type) in SAA, and shall not send subsequent PPR commands when such subscription data are updated.

If the 3GPP AAA Server does not indicate support of this feature in the PPA command and the HSS has already sent DCN-related subscription data in PPR, the HSS may store this indication and not send further updates related to DCN subscription data.

| +| Feature bit: The order number of the bit within the Supported-Features AVP, e.g. "1".
Feature: A short name that can be used to refer to the bit and to the feature.
M/O: Defines if the implementation of the feature is mandatory ("M") or optional ("O").
Description: A clear textual description of the feature. | | | | + +Features that are not indicated in the Supported-Features AVPs within a given application message shall not be used to construct that message. + +### 8.2.3.17 PPR-Flags + +The PPR-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 8.2.3.17/1: + +**Table 8.2.3.17/1: PPR-Flags** + +| Bit | Name | Description | +|--------------------------------------------------------------------------------------------------------------------------|-----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | Reset-Indication | This bit, when set, indicates that the HSS has undergone a restart event and the registration data and dynamic data needs to be restored, if available at the 3GPP AAA Server. | +| 1 | Access-Network-Info-Request | This bit, when set, indicates that the HSS requests the 3GPP AAA Server the identity and location information of the access network where the UE is currently attached. | +| 2 | UE-Local-Time-Zone-Request | This bit, when set, indicates that the HSS requests the 3GPP AAA Server the time zone of the location in the access network where the UE is attached. | +| 3 | P-CSCF Restoration Request | This bit, when set, indicates to the 3GPP AAA Server that the HSS requests the execution of the HSS-based P-CSCF restoration procedures for WLAN, as described in 3GPP TS 23.380 [52] clause 5.6. | +| NOTE: Bits not defined in this table shall be cleared by the sending HSS and discarded by the receiving 3GPP AAA Server. | | | + +### 8.2.3.18 TWAN-Default-APN-Context-Id + +The TWAN-Default-APN-Context-Id AVP is of the type Unsigned32 and shall identify the context identifier of the subscriber's default APN to be used for Trusted WLAN access to EPC over S2a. + +Note: The default APN for Trusted WLAN access to EPC over S2a can differ from the default APN for 3GPP and other non-3GPP accesses. + +### 8.2.3.19 TWAN-Access-Info + +The TWAN-Access-Info AVP is of type Grouped. + +If no WLAN-Identifier AVP is included in the TWAN-Access-Info AVP, the allowed access methods shall apply to any arbitrary Trusted WLAN. See clause 5.1.2.1.2. + +If the Access-Authorization-Flags AVP is not present in the TWAN-Access-Info AVP, EPC access and Non-Seamless WLAN Offload shall be considered to be not allowed. + +A specific Trusted-WLAN shall appear in at most one TWAN-Access-Info AVP. + +There shall be at most one TWAN-Access-Info AVP not including any WLAN-Identifier. + +AVP Format: + +``` +TWAN-Access-Info:= < AVP Header: 1510 10415 > + [ Access-Authorization-Flags ] + [ WLAN-Identifier ] + *[ AVP ] +``` + +### 8.2.3.20 Access-Authorization-Flags + +The Access-Authorization-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 8.2.3.20/1: + +**Table 8.2.3.20/1: Access-Authorization-Flags** + +| Bit | Name | Description | +|-------|--------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | EPC-Access-Authorization | This bit, when set, indicates that the UE is allowed to access the EPC when connected via Trusted WLAN access. This flag, when not set, indicates that the UE is not allowed to access EPC when connected via Trusted WLAN access. | +| 1 | NSWO-Access-Authorization | This bit, when set, indicates that the UE is allowed Non-Seamless WLAN Offload access via Trusted WLAN access. This flag, when not set, indicates that the UE is not allowed to Non-Seamless WLAN Offload via Trusted WLAN access. | +| NOTE: | Bits not defined in this table shall be cleared by the sending HSS and discarded by the receiving 3GPP AAA Server. | | + +NOTE: UE is allowed to access the EPC when connected via Trusted WLAN access only if the Non-3GPP-IP-Access-APN AVP does not disable all APNs and the EPC-Access-Authorization bit is set. + +### 8.2.3.21 AAA-Failure-Indication + +The AAA-Failure-Indication AVP is of type Unsigned32 and it shall contain a bitmask. The meaning of the bits is defined in table 8.2.3.21/1: + +**Table 8.2.3.21/1: AAA-Failure-Indication** + +| Bit | Name | Description | +|-------|----------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------| +| 0 | AAA Failure | This bit, when set, indicates that a previously assigned 3GPP AAA Server is unavailable. | +| NOTE: | Bits not defined in this table shall be cleared by the sender and discarded by the receiver. | | + +### 8.2.3.22 OC-Supported-Features + +The OC-Supported-Features AVP is of type Grouped and it is defined in IETF RFC 7683 [47]. This AVP is used to support Diameter overload control mechanism, see Annex B for more information. + +### 8.2.3.23 OC-OLR + +The OC-OLR AVP is of type Grouped and it is defined in IETF RFC 7683 [47]. This AVP is used to support Diameter overload control mechanism, see Annex B for more information. + +### 8.2.3.24 3GPP-AAA-Server-Name + +The 3GPP-AAA-Server-Name AVP is of type DiameterIdentity, and defines the Diameter address of the 3GPP AAA Server node. + +### 8.2.3.25 DRMP + +The DRMP AVP is of type Enumerated and is defined in IETF RFC 7944 [53]. This AVP allows the 3GPP functional entities to indicate the relative priority of Diameter messages. The DRMP AVP may be used to set the DSCP marking for transport of the associated Diameter message. + +### 8.2.3.26 Load + +The Load AVP is of type Grouped and it is defined in IETF RFC 8583 [54]. This AVP is used to support Diameter load control mechanism, see Annex E for more information. + +### 8.2.3.27 ERP-Authorization + +The ERP-Authorization AVP is of type Unsigned32 and it indicates whether the subscriber is authorized, or not, to make use of the EAP Reauthentication Protocol. The following values are defined: + +ERP\_NOT\_AUTHORIZED (0) + +ERP\_AUTHORIZED (1) + +### 8.2.3.28 MIP6-Feature-Vector + +The MIP6-Feature-Vector AVP (AVP Code 124) is of type Unsigned64 and contains a 64 bit flags field of the mobile IP capabilities authorized by the HSS. + +The following capabilities are defined for the SWx interface: + +- MIP6\_INTEGRATED (0x0000000000000001) +This flag means that DSMIPv6 is authorized. +- PMIP6\_SUPPORTED (0x0000010000000000) +This flag means that NBM is authorized. +- MIP4\_SUPPORTED (0x0000100000000000) +This flag means that MIPv4 is authorized. +- GTPv2\_SUPPORTED (0x0000400000000000) +This flag means that NBM is authorized. + +NBM shall be considered as authorized if at least one of the PMIP6\_SUPPORTED and GTPv2\_SUPPORTED flag is set. + +NOTE: The selection of the protocol variant (GTPv2 or PMIPv6) on S2a/S2b is determined solely by the TWAN/ePDG. It does not matter whether the HSS sets the PMIP6\_SUPPORTED and/or GTPv2\_SUPPORTED flags to authorize NBM. + +Based on operator policy, the 3GPP AAA Server may also authorize the use of NBM, irrespective of the presence or content of the MIP6-Feature-Vector AVP in the Non-3GPP User Data. + +## 8.2.4 Session Handling + +The Diameter protocol between the 3GPP AAA Server and the HSS shall not keep the session state and each Diameter request/response interaction shall be transported over a different diameter session which is implicitly terminated. + +In order to indicate that session state shall not be maintained, the diameter client and server shall include the Auth-Session-State AVP set to the value NO\_STATE\_MAINTAINED (1), as described in IETF RFC 6733 [58]. As a consequence, the server shall not maintain any state information about this session and the client shall not send any + +session termination request. Neither the Authorization-Lifetime AVP nor the Session-Timeout AVP shall be present in requests or responses. + +## 8.3 User identity to HSS resolution + +The User identity to HSS resolution mechanism enables the 3GPP AAA server to find the identity of the HSS that holds the subscriber data for a given user identity when multiple and separately addressable HSSs have been deployed by the network operator. The resolution mechanism is not required in networks that utilise a single HSS or when a 3GPP AAA server is configured to use pre-defined HSS address/identity. + +This User identity to HSS resolution mechanism may rely on routing capabilities provided by Diameter and be implemented in the home operator network within dedicated Diameter Agents (Redirect Agents or Proxy Agents) responsible for determining the HSS identity based on the provided user identity. If this Diameter based implementation is selected by the Home network operator, the principles described below shall apply. + +In networks where more than one independently addressable HSS are utilized by a network operator, and the 3GPP AAA server is not configured to use pre-defined HSS address/identity, each 3GPP AAA server shall be configured with the address/identity of the Diameter Agent (Redirect Agent or Proxy Agent) implementing this resolution mechanism. + +To get the HSS identity that holds the subscriber data for a given user identity, the 3GPP AAA server shall send the Diameter request normally destined to the HSS to a pre-configured address/identity of a Diameter agent supporting the User identity to HSS resolution mechanism. + +- If this Diameter request is received by a Diameter Redirect Agent, the Diameter Redirect Agent shall determine the HSS identity based on the provided user identity and sends to the 3GPP AAA server a notification of redirection towards the HSS identity, in response to the Diameter request. Multiple HSS identities may be included in the response from the Diameter Redirect Agent, as specified in IETF RFC 6733 [58]. In such a case, the 3GPP AAA server shall send the Diameter request to the first HSS identity in the ordered list received in the Diameter response from the Diameter Redirect Agent. If no successful response to the Diameter request is received, the 3GPP AAA server shall send a Diameter request to the next HSS identity in the ordered list. This procedure shall be repeated until a successful response from an HSS is received. +- If this Diameter request is received by a Diameter Proxy Agent, the Diameter Proxy Agent shall determine the HSS identity based on the provided user identity and - if the Diameter load control mechanism is supported (see IETF RFC 8583 [54]) - optionally also based on previously received load values from Load AVPs of type HOST. The Diameter Proxy Agent shall then forward the Diameter request directly to the determined HSS. The 3GPP AAA server shall determine the HSS identity from the response to the Diameter request received from the HSS. + +After the User identity to HSS resolution, the 3GPP AAA server shall store the HSS identity/name/Realm and shall use it in further Diameter requests associated to the same user identity. + +NOTE: Alternatives to the user identity to HSS resolution Diameter based implementation are outside the scope of this specification. + +--- + +## 9 S6b Description + +### 9.1 Functionality + +#### 9.1.1 General + +The S6b reference point is defined between the 3GPP AAA Server and the PDN-GW. The definition of the reference point and its functionality is given in 3GPP TS 23.402 [3]. + +When the UE attaches to the EPC using the S2c reference point, the S6b reference point is used to authenticate and authorize the UE, and update the PDN-GW address to the 3GPP AAA server and HSS. + +When the UE attaches to the EPC using the S2a/S2b reference point in the PMIPv6 or GTPv2 mode, the S6b reference point is used to update the 3GPP AAA server or the 3GPP AAA proxy with the PDN-GW address information and with + +the selected S2a/S2b protocol variant. Furthermore, this reference point may be used to retrieve and update other mobility related parameters including static QoS profiles for non-3GPP accesses. + +The S6b reference point is also used to authenticate and authorize the incoming MIPv4 Registration Request in the case the UE attaches to the EPC over the S2a reference point using MIPv4 FACoA procedures. + +The S6b reference point is used by the 3GPP AAA Server in the case the UE attaches to the EPC using the S2c reference point to indicate to the PDN GW that a PDN GW reallocation shall be performed. This indication triggers the actual Home Agent reallocation procedure as specified in 3GPP TS 24.303 [13]. + +The S6b reference point is also used to download subscriber and equipment trace information to the PDN GW. + +The S6b reference point is also used by the 3GPP AAA Server to indicate to the PDN GW that the HSS-based P-CSCF restoration procedure for WLAN shall be executed as described in 3GPP TS 23.380 [52] clause 5.6. + +## 9.1.2 Procedures Description + +### 9.1.2.1 Authentication and Authorization Procedures when using DSMIPv6 + +#### 9.1.2.1.1 General + +The S6b interface shall enable the authentication and authorization between the UE and the 3GPP AAA Server/Proxy for DSMIPv6. + +When an UE performs the DSMIPv6 initial attach, it runs an IKEv2 exchange with the PDN GW as specified in 3GPP TS 24.303 [13]. In this exchange EAP AKA is used for UE authentication over IKEv2. The PDN GW acts as an IKEv2 responder and an EAP pass-through authenticator for this authentication. + +The S6b authentication and authorization procedure is invoked by the PDN GW after receiving an IKE\_SA\_AUTH message from the UE. The S6b reference point performs authentication based on reuse of the DER/DEA command set defined in Diameter EAP. The exact procedure follows the steps specified in IETF RFC 5778 [11]. + +NOTE: This procedure is only used with DSMIPv6-capable UEs; therefore, only PDNs with PDN Types IPv6 or IPv4v6 are accessible in this case. + +**Table 9.1.2.1/1: Authentication and Authorization Request** + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|----------------------------------------------|----------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| User identity | User-Name | M | This information element shall contain the identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15] and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]. This IE shall include the leading digit used to differentiate between authentication schemes. | +| Authentication Request Type | Auth-Request-Type | M | This IE shall define whether the UE is to be authenticated only, authorized only or both. AUTHORIZE_AUTHENTICATE shall be used in this case. | +| EAP Payload | EAP-Payload | M | This IE shall contain the Encapsulated payload for UE – 3GPP AAA Server mutual authentication | +| PGW PLMN ID | Visited-Network-Identifier | C | This IE shall contain the identifier that allows the home network to identify the PLMN where the PGW is located. It shall be present when the PGW Identity does not contain an FQDN. | +| Access Type | RAT-Type | C | This Information Element shall contain the non-3GPP access network technology type that is serving the UE.
This IE shall be present if it is available when the PDN GW sends the request. | +| PDN GW Identity | MIP6 -Agent-Info | M | This IE shall contain the FQDN and/or IPv6 address(es) of the PDN GW that the user shall be connected to.
If the PDN GW includes the IP address in the PDN GW Identity, it shall include the HA IPv6 address and, if used, the IPv4 address, as DSMIPv6 is used. | +| MIP Subscriber Profile | MIP6-Feature-Vector | M | This AVP shall be included to inform the 3GPP AAA Server about the used mobility protocol. None of the PMIP6_SUPPORTED or MIP4_SUPPORTED flags shall be set, since DSMIPv6 is used in this case. | +| APN | Service-Selection | O | If present, this IE shall contain the Network Identifier part of the APN extracted from the IKE_AUTH message.
It shall include the APN that the user shall be connected to. It shall be only included if received from UE. In case it is not received, the 3GPP AAA Server shall assign the received PDN-GW identity to the default APN. | +| QoS capabilities | QoS-Capability | O | This IE shall be included if present in the request message. It shall indicate to the 3GPP AAA Server that the PGW requests downloading a static QoS profile for the UE. The PGW may include this IE only at the initial attach of the UE. | +| Supported Features (See 3GPP TS 29.229 [24]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host for the lifetime of the Diameter session. | +| Care of Address | MIP-Careof-Address | O | If present, this IE shall contain the IPv4 or the IPv6 Care of Address of the UE as defined in IETF RFC 5778 [11] | +| AAA Failure Indication | AAA-Failure-Indication | O | If present, this information element shall indicate that the request is sent after the PDN-GW has determined that a previously assigned 3GPP AAA Server is unavailable. | +| DER S6b Flags | DER-S6b-Flags | O | This Information Element contains a bit mask. See 9.2.3.7 for the meaning of the bits. | +| UE local IP address | UE-Local-IP-Address | O | The PDN GW shall include this IE based on local policy for Fixed Broadband access network interworking as specified in 3GPP TS 23.139 [39]. If present, it shall contain the source IPv4 or IPv6 address of the IKE_SA_AUTH message from the UE. | + +**Table 9.1.2.1/2: Authentication and Authorization Answer** + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|-----------------------------|----------------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| User Identity | User-Name | O | This information element, if present, shall contain the identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15] and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]. This IE shall include the leading digit used to differentiate between authentication schemes. | +| EAP Payload | EAP-Payload | O | If present, this IE shall contain the Encapsulated payload for UE – 3GPP AAA Server mutual authentication | +| Master Session Key | EAP-Master-Session-Key | C | This IE shall contain the Keying material for protecting the communication between the UE and PDN GW. It shall be present only if the result code is set to success. | +| Authentication Request Type | Auth-Request-Type | M | It shall contain the value AUTHORIZE_AUTHENTICATE. See IETF RFC 4072 [5]. | +| Result Code | Result-Code / Experimental-Result-Code | M | This IE shall contain the result of the operation.
The Result-Code AVP shall be used for errors defined in the Diameter base protocol (see IETF RFC 6733 [58]) or as per in NASREQ IETF RFC 4005 [58]). The Result-Code DIAMETER_MULTI_ROUND_AUTH shall be used in the responses that trigger further requests from the PDN GW and DIAMETER_SUCCESS shall be included at the successful completion of the authentication and authorization procedure.

The Experimental-Result AVP shall be used for S6b errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP.

If the Result-Code is set to DIAMETER_SUCCESS_RELOCATE_HA as defined in IETF RFC 5778 [11], then the 3GPP AAA server is indicating to the PGW that it shall initiate a HA switch procedure towards the UE. | +| MIP Subscriber Profile | MIP6-Feature-Vector | C | This AVP shall be present if the authorization was successful. None of the PMIP6_SUPPORTED or MIP4_SUPPORTED flags shall be set, since DSMIPv6 is used in this case. | +| Permanent User Identity | Mobile-Node-Identifier | C | This information element shall only be sent if the Result-Code AVP is set to DIAMETER_SUCCESS.
This IE shall contain an AAA/HSS assigned permanent user identity (i.e. an IMSI in root NAI format as defined in clause 19 of 3GPP TS 23.003 [14]). This IE shall not include the leading digit prepended in front of the IMSI used to differentiate between authentication schemes. | +| APN and PGW Data | APN-Configuration | C | This information element shall only be sent if the Result-Code AVP is set to DIAMETER_SUCCESS.
This AVP shall contain the default APN, the list of authorized APNs, user profile information.
APN-Configuration is a grouped AVP including the following information elements per APN:
- APN
- Authorized 3GPP QoS profile
- Statically allocated User IP Address (IPv4 and/or IPv6)
- Allowed PDN type (IPv4, IPv6, IPv4v6, IPv4_OR_IPv6)
- APN-AMBR | +| Reallocated PGW Address | MIP6-Agent-Info | C | This information element shall only be sent if the Result-Code AVP is set to DIAMETER_SUCCESS_RELOCATE_HA indicating to the PDN GW that it shall initiate a HA switch procedure towards the UE.
This information element shall contain the PDN GW identity of the target PDN GW. | +| Session Time | Session-Timeout | C | If the authentication and authorization succeeded, then this IE shall contain the time this authorization is valid for. | +| QoS resources | QoS-Resources | C | This AVP shall be included only if the QoS-Capability AVP was received in the authorization request and the authorization succeeded. Then the 3GPP AAA server shall include a static QoS profile in this IE during the UE initial attach if the PDN GW included QoS-Capabilities AVP in the request message and the UE has been provisioned with a static QoS profile. The QoS profile template value in this IE shall be set to 0. | + +| | | | | +|----------------------------------------------|-------------------------------|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| UE Charging Data | 3GPP-Charging-Characteristics | O | If present, this information element shall contain the type of charging method to be applied to the user (see 3GPP TS 29.061 [31]). | +| 3GPP AAA Server URI | Redirect-Host | C | This information element shall be sent if the Result-Code value is set to DIAMETER_REDIRECT_INDICATION. When the user has previously been authenticated by another 3GPP AAA Server, it shall contain the Diameter URI of the 3GPP AAA Server currently serving the user. The node receiving this IE shall behave as defined in the Diameter base protocol (see IETF RFC 6733 [58]). The command shall contain zero or more occurrences of this information element. When choosing a destination for the redirected message from multiple Redirect-Host AVPs, the receiver shall send the Diameter request to the first 3GPP AAA Server in the ordered list received in the Diameter response. If no successful response to the Diameter request is received, the receiver shall send the Diameter request to the next 3GPP AAA Server in the ordered list. This procedure shall be repeated until a successful response is received from a 3GPP AAA Server. | +| Trust Relationship Indicator | AN-Trusted | C | This AVP shall contain the 3GPP AAA Server's decision on handling the non-3GPP access network, i.e. trusted, or untrusted. This AVP shall be present if the 3GPP AAA Server is able to make decision on whether the access network is Trusted or Untrusted. | +| Trace information | Trace-Info | C | This AVP shall be included if the subscriber and equipment trace has been activated for the user in the HSS and signalling based activation is to be used to download the trace activation from the HSS to the PDN GW.
Only the Trace-Data AVP shall be included to the Trace-Info AVP and shall contain the following AVPs:
- Trace-Reference
- Trace-Depth
- Trace-Event-List, for PGW
- Trace-Collection-Entity
The following AVPs may also be included in the Trace-Data AVP:
- Trace-Interface-List, for PGW, if this AVP is not present, trace report generation is requested for all interfaces for PGW listed in 3GPP TS 32.422 [32]
- Trace-NE-Type-List, with the only allowed value being "PDN GW". If this AVP is not included, trace activation in PDN GW is required. | +| Supported Features (See 3GPP TS 29.229 [24]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host for the lifetime of the Diameter session. | + +#### 9.1.2.1.2 PDN GW Detailed Behaviour + +After completing the IKE\_SA\_INIT exchange, upon receipt of an IKE\_AUTH message, including the IDi payload but not the AUTH payload, the PDN GW shall send an Diameter-EAP-Request (DER) message towards the 3GPP AAA Server / Proxy. The EAP Payload AVP shall contain an EAP-Response/Identity with the identity extracted from the IDi field. + +Upon receipt of an IKE\_AUTH message with an EAP payload from the UE, the PDN GW shall send an Diameter-EAP-Request (DER) with the EAP Payload AVP containing the according EAP-Response to the 3GPP AAA Server / Proxy. + +Upon receipt of a Diameter-EAP-Answer (DEA) message from the 3GPP AAA Server / Proxy, the PDN GW shall then send an IKE\_AUTH message containing the according EAP Payload to the UE. + +Upon receipt of an IKE\_AUTH message with the AUTH payload after the EAP authentication was successful, the PDN\_GW shall proceed as specified in 3GPP TS 24.303 [13]. + +If the handover indication to the PGW is missing, i.e. IPv6 Home Network Prefix assigned to the UE is not included in IKE\_AUTH request message as specified in 3GPP TS 24.303 [13], the PGW shall notify 3GPP AAA Server that the UE performs initial attach by setting Initial-Attach-Indicator in the DER-S6b-flags AVP. + +The PDN GW shall utilize the downloaded APN configuration data, among others, to decide whether the user's request for an IPv4 home address and/or IPv6 home address prefix shall be accepted or rejected. + +If the Result-Code AVP is set to DIAMETER\_SUCCESS\_RELOCATE\_HA and if the PGW has received a PGW identity in form of the FQDN from the 3GPP AAA server, then the PGW may obtain the IP address of the Home Agent functionality of that PGW as described in 3GPP TS 29.303 [34]. + +If Trace-Info AVP has been received in the authentication and authorization response, the PDN GW shall start a trace session for the user. For details, see 3GPP TS 32.422 [32]. + +If the PDN-GW determines that a previously assigned 3GPP AAA Server is unavailable, it may attempt to send a new authentication and authorization request to an alternate 3GPP AAA Server. If the PDN-GW receives from this new server a redirect indication towards the former server (due to the HSS having stored the former 3GPP AAA Server identity), it shall terminate all previously existing sessions and PDN connections for that user, and it shall re-send again the request towards the new server, but it shall include the AAA-Failure-Indication AVP in the new request. + +#### 9.1.2.1.3 3GPP AAA Server Detailed Behaviour + +For S6b, on receipt of the DER message, the 3GPP AAA Server shall process the DER message according to 3GPP TS 33.402 [19]. + +Upon successful completion, a DIAMETER\_SUCCESS shall be returned to indicate successful authentication procedure and authentication information shall be returned. If the APN requested by the PDN GW is authorized by the wildcard APN, the 3GPP AAA Server shall include the wildcard APN in the Service-Selection AVP of the APN-Configuration AVP. The AAA server shall also include, among others, the MIP6-Feature-Vector AVP, including the subscriber profile of the UE in terms of DSMIPv6 feature the UE is authorized to use. + +If the HSS indicates that the user is currently being served by a different PDN GW, the 3GPP AAA Server shall respond to the PDN GW with the Result-Code set to DIAMETER\_SUCCESS\_RELOCATE\_HA and include the new assigned PDN GW identity in the MIP6-Agent-Info AVP. + +If receiving the UE Care of Address from the PDN GW and Initial-Attach-Indicator set by the PGW in DER-S6b-flags, the 3GPP AAA Server may select a different PDN GW which is closer to the UE than the currently serving PDN GW as specified in 3GPP TS 23.402 [3] based on the received UE Care of Address. In this case, the 3GPP AAA Server shall respond to the PDN GW with the Result-Code set to DIAMETER\_SUCCESS\_RELOCATE\_HA and include the selected PDN GW identity in the MIP6-Agent-Info AVP. + +If the HSS indicates that the user is currently being served by a different 3GPP AAA Server, the 3GPP AAA Server shall respond to the PDN-GW with the Result-Code set to DIAMETER\_REDIRECT\_INDICATION and Redirect-Host set to the Diameter URI of the 3GPP AAA Server currently serving the user (this Diameter URI shall be constructed based on the Diameter Identity included in the 3GPP-AAA-Server-Name AVP returned in the SWx authentication response from the HSS). + +If the 3GPP AAA Server receives a request message not related to any existing session and is able to recognize that the PDN-GW included the AAA-Failure-Indication AVP in the request, the 3GPP AAA Server shall also include the AAA-Failure-Indication AVP over the SWx interface, while retrieving the access authentication and authorization data from the HSS. + +The 3GPP AAA Server shall run EAP-AKA as specified in 3GPP TS 33.402 [19]. Exceptions shall be treated as error situations and the result code shall be set to DIAMETER\_UNABLE\_TO\_COMPLY. + +Before sending out the AKA challenge, the 3GPP AAA Server shall decide whether the access network is handled as Trusted or Untrusted and set the value of the AN-Trusted AVP correspondingly in the answer message to indicate the trust relationship of the access network to the PDN GW. The 3GPP AAA Server shall make the decision based on the UE Identity and the trust relationship information marked during the authentication and authorization procedure over STa, SWa or SWm. If the 3GPP AAA server is unable to determine the trust relationship of the access network, it shall not include the AN-Trusted AVP in the answer message to the PDN GW. + +For Fixed Broadband access network interworking as specified in 3GPP TS 23.139 [39], + +- For trusted access, the 3GPP AAA server shall determine if the UE is connected via a BBF-defined WLAN access according to the UE local IP address in UE-Local-IP-Address AVP from the PDN GW. If the UE is connected via a BBF-defined WLAN access, the 3GPP AAA server shall perform the enabling UE reflective QoS function as specified in 3GPP TS 24.139 [43]. + +- For untrusted access, the UE local IP address is assigned by the ePDG and not by the non-3GPP access network. Hence, in this case the 3GPP AAA Server shall ignore the UE local IP address in UE-Local-IP-Address AVP from the PDN GW. + +#### 9.1.2.1.4 3GPP AAA Proxy Detailed Behaviour + +The 3GPP AAA Proxy is required to handle roaming cases in which the PDN GW is in the VPLMN. The 3GPP AAA Proxy shall act as a stateful proxy. + +On receipt of the authentication answer that completes a successful authentication, the 3GPP AAA Proxy shall record the state of the connection (i.e. Authentication Successful). + +If receiving the UE Care of Address from the PDN GW which is in the VPLMN, the 3GPP AAA Proxy may select a different PDN GW which is closer to the UE than the currently serving PDN GW as specified in 3GPP TS 23.402 [3] based on the received UE Care of Address. In this case, the 3GPP AAA Proxy shall respond to the PDN GW with the Result-Code set to DIAMETER\_SUCCESS\_RELOCATE\_HA and include the selected PDN GW identity in the MIP6-Agent-Info AVP. + +#### 9.1.2.2 Authorization Procedures when using PMIPv6 or GTPv2 + +##### 9.1.2.2.1 General + +The following authorization procedures take place upon a reception of a PBU at the PDN GW from the MAG or upon a reception of a Create Session Request at the PDN GW from the trusted non-3GPP access network or from the ePDG. + +The PDN GW shall update its identity to the 3GPP AAA Server and HSS. Static QoS profile information may also be downloaded at the same time. If the PDN GW reports to the 3GPP AAA server that GTPv2 is used over the S2a or S2b interface, the 3GPP AAA Server may decide not to download parameters to the PDN GW on the S6b interface which are already provided to the PGW via the trusted non-3GPP access network through the STa and GTPv2 based S2a interfaces or via the ePDG through the SWm and the GTPv2 based S2b interfaces (e.g. static QoS profile, Trace Information, APN-AMBR). + +The procedures are based on the reuse of NASREQ IETF RFC 4005 [4] AAR and AAA commands and the Diameter extensions defined for PMIP in IETF RFC 5779 [2]. + +**Table 9.1.2.2.1/1: Authorization request** + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|----------------------------------------------|----------------------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Permanent User Identity | User-Name | M | This information element shall contain the permanent identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15] and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]; this IE shall not include the leading digit prepended in front of the IMSI used to differentiate between authentication schemes. | +| Authentication Request Type | Auth-Request-Type | M | This IE shall defines whether the UE is to be authenticated only, authorized only or both. AUTHORIZE_ONLY shall be used in this case. | +| PDN GW Identity | MIP6-Agent-Info | C | If present, this IE shall contain the identity of the selected PDN GW for the UE and the corresponding PDN connection. It shall be present on the first authorization request sent by the PGW to the 3GPP AAA Server for a given APN. Also, it shall be present to communicate to the 3GPP AAA Server the identity of the PDN GW used for the establishment of emergency PDN connections. | +| PGW PLMN ID | Visited-Network-Identifier | C | This IE shall contain the identifier that allows the home network to identify the PLMN where the PGW is located. It shall be present when the PGW Identity is present and does not contain an FQDN. | +| Mobility features | MIP6-Feature-Vector | M | This IE shall contain the mobility features used by the PDN GW. The PDN GW shall set the PMIP6_SUPPORTED flag or the GTPv2_SUPPORTED flag according to the protocol variant used over the S2a or the S2b interface. | +| APN | Service-Selection | M | This IE shall contain the Network Identifier part of the APN extracted from the PBU or the Create Session Request message. For emergency PDN connection establishment (i.e., when Emergency-Services AVP is present, with the Emergency-Indication bit set), this IE may be ignored by the 3GPP AAA Server. | +| QoS capabilities | QoS-Capability | O | If included in the request message, this IE shall indicate to the 3GPP AAA server that the PDN GW requests downloading a static QoS profile for the UE. The PDN GW may include this IE only at the initial attach of the UE. The PDN GW should not include this IE if GTPv2 is used over the S2a or the S2b interface. The PDN GW shall not include this IE if the Emergency-Indication bit of the Emergency-Services AVP is set in the message. | +| Supported Features (See 3GPP TS 29.229 [24]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host for the lifetime of the Diameter session. | +| Origination Time Stamp | Origination-Time-Stamp | C |

The PGW shall include this IE if it received the Origination Time Stamp from the MME/SGSN or TWAN/ePDG and if the PGW supports the procedure specified in clause 13.2 of 3GPP TS 29.274 [38].

If included in the request message, this IE shall contain the Origination Time Stamp value provided to the PGW in the Create Session Request or PBU message. This indicates the time at which the originating entity initiated the request.

| +| Maximum Wait Time | Maximum-Wait-Time | C |

The PGW shall include this IE if it received the Maximum Wait Time from the MME/SGSN or TWAN/ePDG, and the PGW supports the procedure specified in clause 13.3 of 3GPP TS 29.274 [38], and the 3GPP AAA Server pertains to the same PLMN as the PGW or if the 3GPP AAA Server pertains to a different PLMN and operator policy in the PGW allows to use this procedure towards this PLMN.

If included in the request message, this IE shall contain the Maximum Wait Time provided to the PGW in the Create Session Request or PBU message. This indicates the duration during which the originator of the request waits for a response.

| +| Emergency Services | Emergency-Services | C | The PGW shall include this information element, with the Emergency-Indication bit set, during the establishment of an emergency PDN connection. | + +**Table 9.1.2.2.1/2: Authorization answer** + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------|-------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result code | Result-Code | M | This IE shall contain the result of the operation. The possible values of the Result-Code AVP are defined in IETF RFC 6733 [58]. This IE shall be set to DIAMETER_SUCCESS if the update of the PDN GW identity succeeded. It shall be set to DIAMETER_AUTHORIZATION_REJECTED if the update of the PDN GW identity failed. | +| Authentication Request Type | Auth-Request-Type | M | It shall contain the value AUTHORIZE_ONLY. See IETF RFC 4072 [5]. | +| Authorized mobility features | MIP6-Feature-Vector | C | The 3GPP AAA Server shall insert this AVP if the authorization was successful. The PMIP6_SUPPORTED or the GTPv2_SUPPORTED flag shall be set according to the value received in the Authorization request. | +| Session time | Session-Timeout | C | If the authorization succeeded, then this IE shall contain the time this authorization is valid for. | +| APN and PGW Data | APN-Configuration | C | This information element shall only be sent if the Result-Code AVP is set to DIAMETER_SUCCESS.
This AVP shall contain the user profile information.
APN-Configuration is a grouped AVP and shall include the following information elements:
- APN
- Authorized 3GPP QoS profile
- APN-AMBR
This information element need not be included in the Authorization answer, if the MIP6-Feature-Vector in the Authorization request indicates that GTPv2 is used over S2a or S2b.
This information element shall not be included in the Authorization Answer if the Emergency-Indication bit of the Emergency-Services AVP is set in the Authorization Request. | +| QoS resources | QoS-Resources | C | This AVP shall be included only if the QoS-Capability AVP was received in the authorization request and the authorization succeeded. Then the 3GPP AAA server shall include a static QoS profile in this IE during the UE initial attach if the PDN GW included a QoS-Capabilities AVP in the request message and the UE has been provisioned with a static QoS profile. The QoS profile template value in this IE shall be set to 0. | +| 3GPP AAA Server URI | Redirect-Host | C | This information element shall be sent if the Result-Code value is set to DIAMETER_REDIRECT_INDICATION. When the user has previously been authenticated by another 3GPP AAA Server, it shall contain the Diameter URI of the 3GPP AAA Server currently serving the user. The node receiving this IE shall behave as defined in the Diameter base protocol (see IETF RFC 6733 [58]). The command shall contain zero or more occurrences of this information element. When choosing a destination for the redirected message from multiple Redirect-Host AVPs, the receiver shall send the Diameter request to the first 3GPP AAA Server in the ordered list received in the Diameter response. If no successful response to the Diameter request is received, the receiver shall send the Diameter request to the next 3GPP AAA Server in the ordered list. This procedure shall be repeated until a successful response is received from a 3GPP AAA Server. | +| Trace information | Trace-Info | C | This AVP shall be included if the MIP6-Feature-Vector in the Authorization request indicates that PMIPv6 is used over S2a or S2b and if the subscriber and equipment trace has been activated or deactivated for the user in the HSS GW and signalling based activation is used to download the trace (de)activation from the HSS to the PDN GW.

In an authorization response sent during the authorization procedure at PDN connection setup, the Trace-Data AVP shall be included.
In an authorization response sent during the service authorization information update procedure,
- the Trace-data AVP shall be included if trace activation is requested
- the Trace-Reference AVP shall be included, if trace deactivation is requested.

If the Trace-Data AVP is included, it shall contain the following AVPs:
- Trace-Reference | + +| | | | | +|-------------------------------------------------|--------------------|---|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | |
  • - Trace-Depth
  • - Trace-Event-List, for PGW
  • - Trace-Collection-Entity

The following AVPs may also be included in the Trace-Data AVP:

  • - Trace-Interface-List, for PGW, if this AVP is not present, trace report generation is requested for all interfaces for PGW listed in 3GPP TS 32.422 [32]
  • - Trace-NE-Type-List, with the only allowed value being "PDN GW". If this AVP is not included, trace activation in PDN GW is required.
| +| Supported Features
(See 3GPP TS 29.229 [24]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host for the lifetime of the Diameter session. | + +#### 9.1.2.2.2 PDN GW Detailed Behaviour + +Upon receipt of a PBU message from the MAG or upon receipt of a Create Session Request from the trusted non-3GPP access network or the ePDG which requires the establishment of a new PDN connection via the non-3GPP access, the PDN GW shall initiate an authorization procedure, by sending an Authorization Request message to the 3GPP AAA server or to the 3GPP AAA Proxy, with the Auth-Request-Type set to AUTHORIZE\_ONLY, in order to update the PGW Address for the APN and the selected S2a or S2b protocol variant, as well as to optionally download any UE specific APN profile information such as IP address allocation information, QoS Information, Session timeouts, Session Idle timeouts etc. + +The Create Session Request received from the trusted non-3GPP access network or the ePDG may include the identities of the 3GPP AAA server assigned to the UE i.e. the Origin-Host and Origin-Realm of the 3GPP AAA server included in the DEA message received by the ePDG/TWAN over SWm or STa interface. If supported, the PDN GW shall use these identities to address the Authorization Request message to the selected 3GPP AAA server. + +The PDN GW shall include in the request the APN where the user shall be connected to. The PGW shall additionally include the Emergency-Services AVP, with the Emergency-Indication bit set, during the establishment of an emergency PDN connection. + +The PDN GW Identity and PLMN shall only be included in the initial request to the 3GPP AAA server; subsequent authorization messages (due to a handover to a different MAG, for instance) shall not include it again. + +After reception of the Authorization Response message, the PDN GW shall check that the Result-Code is set to DIAMETER\_SUCCESS and, if so, it shall proceed to connect the user to the specified APN. + +For PMIPv6 based S2a or S2b, if Trace-Info AVP including Trace-Data has been received in the authorization response, the PDN GW shall start a trace session for the user. If Trace-Info including Trace-Reference (directly under the Trace-Info) has been received in the authorization response, the PDN GW shall stop the ongoing trace session, identified by the Trace-Reference. For details, see 3GPP TS 32.422 [32]. + +For GTPv2 based S2a or S2b, the PDN GW shall ignore the Trace-Info AVP if received in the authorization response. + +NOTE: For GTPv2 based S2a or S2b, trace is activated and deactivated via the STa and S2a interfaces or via the SWm and S2b interfaces. + +#### 9.1.2.2.3 3GPP AAA Server Detailed Behaviour + +Upon receipt of the Authorization Request message from the PDN GW, the 3GPP AAA Server shall check whether the user's profile is available. + +If the user's data exist in the 3GPP AAA Server, it shall check, whether it also has an active access authorization session for the user. + +- If not, the 3GPP AAA Server shall reject the authorization request, including the Result-Code DIAMETER\_AUTHORIZATION\_REJECTED. +- If the 3GPP AAA Server has an existing authorization session, + +- If the APN requested by the PDN GW is included in the list of authorized APNs of the user or if the Emergency-Indication bit of the Emergency-Services AVP is set in the Authorization Request, then the 3GPP AAA Server shall: + - set the Result-Code to DIAMETER\_SUCCESS; + - include the APN-Configuration AVP in the authorization answer if PMIP is used over S2a or S2b; the APN-Configuration AVP may also be included if GTPv2 is used over S2a or S2b. When the APN-Configuration AVP is included in the authorization answer, the Service-Selection AVP within the APN-Configuration AVP shall contain the wildcard APN if the APN requested by the PDN GW is authorized by the wildcard APN; + - update the PDN GW information for the APN for the UE on the HSS as specified in clause 8.1.2.2.2, if the Emergency-Indication bit of the Emergency-Services AVP is not set in the Authorization Request; and + - update on the HSS the PDN GW Identity used for the establishment of emergency PDN connections for the UE, as specified in clause 8.1.2.2.2, based on operator policy (e.g. on whether the operator uses a static PDN GW or not for emergency services), if the Emergency-Services AVP is present, with the Emergency-Indication bit set, in the Authorization Request and the user is non-roaming and authenticated. +- If the APN requested by the PDN GW is not included in the list of authorized APNs and the Emergency-Indication AVP is not present in the Authorization Request, then the status code DIAMETER\_AUTHORIZATION\_REJECTED shall be returned to the PDN GW to indicate an unsuccessful authorization. + +If the user's profile does not exist in the 3GPP AAA Server, it shall retrieve the Diameter identity of the 3GPP AAA Server currently serving the user from the HSS following the procedures for subscriber profile download as specified in clause 8.1.2.2.2. Depending on the HSS response, + +- If the HSS indicates that the user is currently being served by a different 3GPP AAA Server, the 3GPP AAA Server shall respond to the PDN-GW with the Result-Code set to DIAMETER\_REDIRECT\_INDICATION and Redirect-Host set to the Diameter URI of the 3GPP AAA Server currently serving the user (this Diameter URI shall be constructed based on the Diameter Identity included in the 3GPP-AAA-Server-Name AVP returned in the SWx authentication response from the HSS). +- If the HSS returns DIAMETER\_ERROR\_USER\_UNKNOWN, the 3GPP AAA Server shall return the same error to the PDN GW. +- If the HSS sends the user's profile to the 3GPP AAA Server, the authorization shall be rejected by setting the Result-Code to DIAMETER\_AUTHORIZATION\_REJECTED. The 3GPP AAA Server shall delete the downloaded user profile. + +NOTE 1: The last outcome corresponds to the case that the user has no active access authorization procedure. This is considered as an error situation, e.g. the Trusted Non-3GPP access network may have sent PBU without authorizing the user. + +NOTE 2: After the 3GPP AAA Server has accepted a new S6b session from a particular PGW, the 3GPP AAA server can consider that any existing S6b session(s) for the same UE – APN combination supported via a different PGW (i.e. with a different Origin-Host AVP) is obsolete and can send ASR command(s) to initiate the termination of the hanging session(s) in that PGW. + +If the 3GPP AAA Server supports the detection and handling of late arriving requests as specified in clause 13.2 of 3GPP TS 29.274 [38], upon receipt of an Authorization Request which collides with an existing session context, for the same UE and APN but a different PGW (i.e. different Origin-Host AVP), the 3GPP AAA Server shall accept the new Authorization Request only if it contains a more recent Origination Time Stamp than the Origination Time Stamp stored for the existing S6b session. An incoming Authorization Request shall be considered as more recent than an existing session and be accepted if no Origination Time Stamp information was provided for at least one of the two sessions. The 3GPP AAA Server shall reject an incoming Authorization Request whose Origination Time Stamp is less recent than the Origination Time Stamp of the existing session by setting the Experimental-Result-Code to DIAMETER\_ERROR\_LATE\_OVERLAPPING\_REQUEST. + +If the 3GPP AAA Server supports the detection and handling of late arriving requests as specified in clause 13.3 of 3GPP TS 29.274 [38], upon receipt of an Authorization Request which contains the Origination Time Stamp and the Maximum Wait Time parameters, the 3GPP AAA Server should check that the request has not already timed out at the originating entity. The 3GPP AAA Server may perform additional similar checks before sending the answer, e.g. upon receipt of a response from the HSS. The 3GPP-AAA Server should reject an Authorization Request that is known to have timed out by setting the Experimental-Result-Code to DIAMETER\_ERROR\_TIMED\_OUT\_REQUEST. + +#### 9.1.2.2.4 3GPP AAA Proxy Detailed Behaviour + +The 3GPP AAA Proxy is required to handle roaming cases in which the PDN GW is located in the VPLMN. The 3GPP AAA Proxy shall act as a stateful proxy. + +On receipt of the authorization answer, the 3GPP AAA Proxy + +- shall check locally configured information for the maximum allowed static QoS parameters valid for visitors from the given HPLMN and modify the QoS parameters received from the 3GPP AAA Server, to enforce the policy limitations. +- shall record the state of the connection (i.e. Authorization Successful). + +#### 9.1.2.3 PDN GW Initiated Session Termination Procedures + +##### 9.1.2.3.1 General + +The S6b reference point allows the PDN GW to inform the 3GPP AAA server that the UE disconnected a PDN connection associated to an APN, or that the PDN connection was handed over to the 3GPP access, and therefore the mobility session established for this PDN connection is to be removed. + +The procedure shall be initiated by the PDN GW. These procedures are based on the reuse of Diameter STR and STA commands as specified in IETF RFC 6733 [58]. + +Each PDN connection shall be identified by the Diameter Session-Id parameter. + +**Table 9.1.2.3.1/1: S6b Session Termination Request** + +| Information Element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-------------------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Permanent User Identity | User-Name | M | This information element shall contain the permanent identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15] and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]; this IE shall not include the leading digit prepended in front of the IMSI used to differentiate between authentication schemes. | +| Termination Cause | Termination-Cause | M | This IE shall contain the reason for the disconnection, according to the values and reasons described in IETF RFC 6733 [58]. In particular:
  • - If the session is terminated as a result of a PDN disconnection initiated by the UE, the Termination-Cause shall be set to the value DIAMETER_LOGOUT (1)
  • - If the session is terminated as a result of a PDN handover towards 3GPP access, the Termination-Cause shall be set to the value DIAMETER_USER_MOVED (7)
| + +**Table 9.1.2.3.1/2: S6b Session Termination Answer** + +| Information Element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-----------------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation. The Result-Code AVP shall be used for errors defined in the Diameter base protocol (see IETF RFC 6733 [58]). The Experimental-Result AVP shall be used for S6b errors. | + +### 9.1.2.3.2 PDN GW Detailed Behaviour + +The PDN GW shall make use of this procedure when the PDN Connection associated to the diameter session is, either disconnected, or handed over to the 3GPP access. + +Upon receipt of the Session Termination Answer message from the 3GPP AAA Server or from the 3GPP AAA Proxy, the PDN GW shall check the Result Code AVP, and in case of a DIAMETER\_SUCCESS code, it shall release the context associated to the active session identified by the Session-Id parameter used in the initial authorization exchange. + +### 9.1.2.3.3 3GPP AAA Server Detailed Behaviour + +Upon receipt of the Session Termination Request message from the PDN GW or from the 3GPP AAA Proxy, the 3GPP AAA Server shall check that there is an ongoing session associated to any of the parameters received in the message (Session-Id and User Name). + +If an active session is found, the 3GPP AAA Server shall release the session context associated to the specified session, and a Session Termination Answer message shall be sent to the PDN GW or 3GPP AAA Proxy, indicating DIAMETER\_SUCCESS. + +If the Session-Id included in the request does not correspond with any active session, or if an active session is found but it does not belong to the user identified by the User Name parameter, then a Session Termination Answer message shall be sent to the PDN GW or 3GPP AAA Proxy, indicating DIAMETER\_UNKNOWN\_SESSION\_ID. + +### 9.1.2.3.4 3GPP AAA Proxy Detailed Behaviour + +The 3GPP AAA Proxy is required to handle roaming cases in which the PDN GW is located in the VPLMN. The 3GPP AAA Proxy shall act as a stateful proxy. + +On receipt of the Session Termination Request message from the PDN GW, the 3GPP AAA Proxy shall route the message to the 3GPP AAA Server. + +On receipt of the Session Termination Answer message from the 3GPP AAA Server, the 3GPP AAA Proxy shall route the message to the PDN GW, and it shall release any local resources associated to the specified sessions only if the result code is set to DIAMETER\_SUCCESS. + +## 9.1.2.4 3GPP AAA Initiated Session Termination Procedures + +### 9.1.2.4.1 General + +The S6b reference point allows the 3GPP AAA server to order a PDN GW to remove a PDN connection previously activated by the UE. + +This procedure shall be initiated by the 3GPP AAA server. This indicates to the PDN GW to remove the corresponding PDN connection (identified by Session-ID AVP and User-Name AVP). This procedure is based on the reuse of NASREQ IETF RFC 4005 [4] ASR, ASA, STR and STA commands. + +The 3GPP AAA Server shall include the Auth-Session-State AVP in the ASR command with a value of NO\_STATE\_MAINTAINED if it does not require a STR from the PDN GW. If it does require a STR from the PDN GW, the 3GPP AAA Server shall either omit the Auth-Session-State AVP from the ASR command or include the Auth-Session-State AVP in the ASR command with a value of STATE\_MAINTAINED. + +**Table 9.1.2.4.1/1: S6b Abort Session Request** + +| Information Element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Permanent User Identity | User-Name | M | This information element shall contain the permanent identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15] and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]; this IE shall not include the leading digit prepended in front of the IMSI used to differentiate between authentication schemes. | +| Auth-Session-State | Auth-Session-State | O | If present, this information element shall indicate to the PDN GW whether the 3GPP AAA Server requires an STR message. | + +**Table 9.1.2.4.1/2: S6b Abort Session Answer** + +| Information Element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-----------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation.
The Result-Code AVP shall be used for errors defined in the Diameter base protocol (see IETF RFC 6733 [58]).
The Experimental-Result AVP shall be used for S6b errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | + +**Table 9.1.2.4.1/3: S6b Session Termination Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-------------------------|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Termination-Cause | Termination-Cause | M | This information element shall contain the reason why the session was terminated. It shall be set to "DIAMETER_ADMINISTRATIVE" to indicate that the session was terminated in response to an ASR message. | + +**Table 9.1.2.4.1/4: S6b Session Termination Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-------------------------|------|-----------------------------------------------------| +| Result-Code | Result-Code | M | This IE shall indicate the result of the operation. | + +#### 9.1.2.4.2 PDN GW Detailed Behaviour + +Upon receipt of the Abort Session Request message from the 3GPP AAA Server or from the 3GPP AAA Proxy, the PDN GW shall check that there is an ongoing session with the received session-ID. + +If an active session is found: + +- In the PMIPv6 or GTPv2 or MIPv4 cases, the PDN GW shall release any resources associated with the identified diameter session, but it shall not terminate any associated PDN connection. +- In the DSMIPv6 case, the PDN GW shall initiate a termination procedure for the associated PDN connection, and shall release any resources associated with the identified diameter session. + +If the termination procedure is successful for the identified session, an Abort Session Answer message shall be sent to the 3GPP AAA Server or 3GPP AAA Proxy, indicating DIAMETER\_SUCCESS. + +If the Session-Id included in the request does not correspond with any active session, or if an active session is found but it does not belong to the user identified by the User Name parameter, then an Abort Session Answer message shall be sent to the 3GPP AAA Server or 3GPP AAA Proxy, indicating DIAMETER\_UNKNOWN\_SESSION\_ID. + +If the termination procedure for the identified session cannot be completed successfully, an Abort Session Answer message shall be sent to the 3GPP AAA Server or 3GPP AAA Proxy, indicating DIAMETER\_UNABLE\_TO\_COMPLY. + +If the termination procedure was successful for the identified session and the STR is required by the 3GPP AAA Server, the PDN GW shall send an STR to the 3GPP AAA Server with the Termination-Cause set to DIAMETER\_ADMINISTRATIVE. + +#### 9.1.2.4.3 3GPP AAA Server Detailed Behaviour + +The 3GPP AAA Server shall initiate a separate procedure for each active PDN connection of the user, even if the user has several PDN connections via the same PDN GW. + +Upon receipt of the Abort Session Answer message from the PDN GW or from the 3GPP AAA Proxy, the 3GPP AAA Server shall check the Result Code AVP, and in case of a DIAMETER\_SUCCESS code, it shall release the context associated to the active session identified by the Session-Id parameter. + +If the error code DIAMETER\_UNABLE\_TO\_COMPLY is received in the Result Code AVP, the 3GPP AAA Server shall not release the context for the identified session. + +If the error code DIAMETER\_UNKNOWN\_SESSION\_ID is received in the Result Code AVP, the 3GPP AAA Server shall release the context for the identified session. + +On receipt of the STR from PDN GW, the 3GPP AAA Server shall return an STA command with the Result-Code set to DIAMETER\_SUCCESS. + +#### 9.1.2.4.4 3GPP AAA Proxy Detailed Behaviour + +The 3GPP AAA Proxy is required to handle roaming cases in which the PDN GW is located in the VPLMN. The 3GPP AAA Proxy shall act as a stateful proxy. + +On receipt of the Abort Session Request message from the 3GPP AAA Server, the 3GPP AAA Proxy shall route the message to the PDN GW. + +If the 3GPP AAA Proxy requires an STR but the 3GPP AAA Server does not, the 3GPP AAA Proxy may override the value of the Auth-Session-State in the ASR and set it to STATE\_MAINTAINED. In this case, the 3GPP AAA Proxy shall not forward the STR received from the PDN GW onto the 3GPP AAA Server and shall return an STA command to the PDN GW with the Result-Code set to DIAMETER\_SUCCESS. The 3GPP AAA Proxy shall not override the value of the Auth-Session-State AVP under any other circumstances. + +On receipt of the Abort Session Answer message from the PDN GW, the 3GPP AAA Proxy shall route the message to the 3GPP AAA Server, and it shall release any local resources associated to the specified session only if the result code is set to DIAMETER\_SUCCESS. + +When the 3GPP AAA Proxy receives the STR from PDN GW, it shall route the request to the 3GPP AAA Server. On receipt of the STA message, the 3GPP AAA Proxy shall route the response to the PDN GW. + +#### 9.1.2.5 Service Authorization Information Update Procedures + +##### 9.1.2.5.1 General + +The S6b reference point allows the 3GPP AAA server to modify the authorization information previously provided to the PDN GW, i.e. during Service Authentication and Authorization when using DSMIPv6, or Service Authorization using PMIPv6 or GTPv2 or MIPv4, or the service authorization information provided during a previous Service Authorization update. This procedure is triggered by the modification of the non-3GPP profile of the UE or by activating or deactivating subscriber and equipment trace in the HSS or by the request of a P-CSCF restoration for WLAN. This procedure is also triggered by the authentication and authorization via STa or SWm, when the 3GPP AAA Server detects that an S6b session already exists for the UE, as specified in clause 5.1.2.1.2 and 7.1.2.1.2. In this case, the 3GPP AAA Server shall use this procedure to send the trust relationship to the PDN GW. + +The Service Authorization Information Update procedure is performed in two steps: + +1. The 3GPP AAA server issues an unsolicited re-authentication and/or re-authorization request towards the PDN GW. Upon receipt of this request, the PDN GW responds to the request and indicates the disposition of the request. If the re-authorization request is used for the purpose of the P-CSCF restoration for WLAN, only the P-CSCF Restoration Request bit shall be set in the RAR Flags. This procedure is based on the reuse of Diameter RAR and RAA commands as specified in IETF RFC 6733 [58]. The information element content for these messages is shown in tables 9.1.2.5.1/1 and 9.1.2.5.1/2. +2. After receiving the re-authorization request, the PDN GW invokes the authorization procedure for the APN identified by the session ID included in the former re-authorization request message. The authorization procedure for PMIPv6 or GTPv2 is described in the clause 9.1.2.2. Tables 9.1.2.5.1/3 and 9.1.2.5.1/4 describe the message contents in case of DSMIPv6. + +**Table 9.1.2.5.1/1: S6b Re-authorization request** + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Permanent User Identity | User-Name | M | This information element shall contain the permanent identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15] and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]; this IE shall not include the leading digit prepended in front of the IMSI used to differentiate between authentication schemes. | +| Request Type | Re-Auth-Request-Type | M | This shall define whether re-authentication or re-authorization is required. AUTHORIZE_ONLY shall be used in this case. | +| RAR Flags | RAR-Flags | C | This Information Element contains a bit mask. See 9.2.3.1.5 for the meaning of the bits. | + +**Table 9.1.2.5.1/2: S6b Re-authorization response** + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-----------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation.
The Result-Code AVP shall be used for errors defined in the Diameter base protocol (see IETF RFC 6733 [58]).
The Experimental-Result AVP shall be used for S6b errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | + +**Table 9.1.2.5.1/3: Authorization Request when using DSMIPv6** + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|-----------------------------|----------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| User identity | User-Name | M | This information element shall contain the permanent identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15] and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]; this IE shall not include the leading digit prepended in front of the IMSI used to differentiate between authentication schemes. | +| Authentication Request Type | Auth-Request-Type | M | This IE defines whether the UE is to be authenticated only, authorized only or both. AUTHORIZE_ONLY shall be used in this case. | +| PGW PLMN ID | Visited-Network-Identifier | C | This IE shall contain the identifier that allows the home network to identify the PLMN where the PGW is located. It shall be present when the PGW Identity does not contain an FQDN. | +| Access Type | RAT-Type | M | This IE shall contain the non-3GPP access network technology type that is serving the UE. | +| PDN GW Identity | MIP6 -Agent-Info | M | This IE shall contain the FQDN and/or IP address(es) of the PDN GW that the user is connected to. | +| APN | Service-Selection | O | This IE shall contain the Network Identifier part of the APN extracted from the IKE_AUTH message.
It shall include the APN that the user shall be connected to. It shall be only included if received from UE. In case it is not received, the 3GPP AAA server shall assign the received PDN-GW identity to the default APN. | +| QoS capabilities | QoS-Capability | C | If included in the request message, this IE shall indicate to the 3GPP AAA server that the PGW is capable of downloading a static QoS profile for the UE. The PGW shall include this IE only during UE the initial attach. | + +**Table 9.1.2.5.1/4: Authorization Answer when using DSMIPv6** + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------|----------------------------------------|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result Code | Result-Code / Experimental-Result-Code | M |

This IE shall contain the result of the operation.
The Result-Code AVP shall be used for errors defined in the Diameter base protocol (see IETF RFC 6733 [58]) or as per in NASREQ IETF RFC 4005 [4]). 1xxx should be used for multi-round, 2xxx for success.

The Experimental-Result AVP shall be used for S6b errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP.

| +| Authentication Request Type | Auth-Request-Type | M | It shall contain the value AUTHORIZE_ONLY. See IETF RFC 4072 [5]. | +| APN and PGW Data | APN-Configuration | C |

This information element shall only be sent if the Result-Code AVP is set to DIAMETER_SUCCESS.
This AVP shall contain the default APN, the list of authorized APNs, and user profile information.
The APN-Configuration is a grouped AVP and shall include the following information elements per APN:
- APN
- Authorized 3GPP QoS profile
- Statically allocated User IP Address (IPv4 and/or IPv6)
- VPLMN Dynamic Address Allowed.

This information element might not be present if the authorization procedure is triggered by the 3GPP AAA Server to send the trust relationship to the PDN GW.

| +| Session Time | Session-Timeout | C |

If the authentication and authorization succeeded, then this IE shall contain the time this authorization is valid for.
This information element might not be present if the authorization procedure is triggered by the 3GPP AAA Server to send the trust relationship to the PDN GW.

| +| QoS resources | QoS-Resources | C |

If the authentication and authorization succeeded, then the 3GPP AAA server shall include a static QoS profile in this IE during the UE initial attach if the PGW included QoS-Capabilities AVP in the request message and the UE has been provisioned with a static QoS profile.
The QoS profile template value in this IE shall be set to 0.
This IE shall contain the QoS Profile authorized by the 3GPP AAA server for the requested APN based on the subscribed QoS parameters.

This information element might not be present if the authorization procedure is triggered by the 3GPP AAA Server to send the trust relationship to the PDN GW.

| +| Trace information | Trace-Info | C |

This AVP shall be included if the subscriber and equipment trace has been activated or deactivated for the user in the HSS and signaling based activation is used to download the trace (de)activation from the HSS to the PDN GW.
Trace-data AVP shall be included (directly under the Trace-Info) if trace activation is requested
Trace-Reference AVP shall be included, if trace deactivation is requested.
If the Trace-Data AVP is included, it shall contain the following AVPs:
- Trace-Reference
- Trace-Depth
- Trace-Event-List, for PGW
- Trace-Collection-Entity

The following AVPs may also be included in the Trace-Data AVP:
- Trace-Interface-List, for PGW, if this AVP is not present, trace report generation is requested for all interfaces for PGW listed in 3GPP TS 32.422 [32]
- Trace-NE-Type-List, with the only allowed value being "PDN GW". If this AVP is not included, trace activation in PDN GW is required.

| +| Trust Relationship Indicator | AN-Trusted | C |

This AVP shall contain the 3GPP AAA Server's decision on handling the non-3GPP access network, i.e. trusted, or untrusted.
This AVP shall be sent if this re-authorization procedure is triggered by the authentication and authorization via STa or SWm, when the 3GPP AAA Server detects that an S6b session already exists for the UE and

| + +| | | | | +|--|--|--|---------------------------------------------------------------------------------------| +| | | | the S6b session was established as a result of an authentication request for DSMIPv6. | +|--|--|--|---------------------------------------------------------------------------------------| + +#### 9.1.2.5.2 Detailed Behaviour + +The 3GPP AAA server shall make use of this procedure in two steps to indicate and update relevant service authorization information in the PDN GW. + +The 3GPP AAA server shall send a re-authorization request for all authorization sessions that are active for the user except for the request of a P-CSCF restoration for WLAN which only applies to the session related to the IMS APN. + +Each PDN GW, upon reception of an unsolicited re-authentication and/or re-authorization request shall perform the following check and if there is an error detected, the PDN GW shall stop processing and return the corresponding error code. + +Check the Re-Auth-Request-Type AVP: + +1. If it indicates AUTHENTICATE\_ONLY, Result-Code shall be set to DIAMETER\_INVALID\_AVP\_VALUE. +2. If it indicates AUTHORIZE\_ONLY, then, depending on the used IP mobility protocol: + - In case of PMIPv6 or GTPv2, the PDN GW shall perform an authorization procedure as described in clause 9.1.2.2. If the P-CSCF Restoration Request bit in the RAR Flags is set: + - for the case where the PDN GW triggers the extended P-CSCF restoration mechanism, the PDN GW may send the authorisation request with only mandatory AVPs. + - for the case where the PDN GW triggers the basic P-CSCF restoration mechanism, the PDN GW shall send a Session Termination Request to the 3GPP AAA Server. + - In case of DSMIPv6, the PDN GW shall perform an authorization procedure, sending an authorization request described in Tables 9.1.5.1/3 and 9.1.5.1/4. If the Trust-Relationship-Update flag is set in the RAR Flags present in the request, the PDN GW may send an authorization request with only mandatory AVPs. +3. If it indicates AUTHORIZE\_AUTHENTICATE, Result-Code shall be set to DIAMETER\_INVALID\_AVP\_VALUE. + +When receiving the authorization request, if the authorization procedure is triggered by the 3GPP AAA Server to send the trust relationship to the PDN GW, the 3GPP AAA Server shall send the trust relationship of the access network for the subscriber to the PDN GW with Result-Code DIAMETER\_SUCCESS. If the received AA-Request is triggered by the P-CSCF Restoration Request bit set in the RAR Flags sent to the PDN GW, the 3GPP AAA Server may send an authorization answer to the PDN GW with Result-Code DIAMETER\_SUCCESS with only the mandatory AVPs described in Table 9.1.2.2.1/2. Otherwise, the 3GPP AAA Server shall check, whether + +- the subscriber still has non-3GPP subscription to access EPC network +- the non-3GPP APNs are enabled for the user, and +- the updated user profile contains the APN, for which the given authorization session was created. + +If any of the checked conditions are not met, the 3GPP AAA Server shall set the Result-Code to DIAMETER\_AUTHORIZATION\_REJECTED. Otherwise, it shall respond with Result-Code DIAMETER\_SUCCESS. + +After successful service authorization information update procedure, the PDN GW shall overwrite the stored user and APN data, for the subscriber identity indicated in the request, with the information received from the 3GPP AAA server. A session termination shall be initiated if the subscriber is no longer authorized to use the activated APN. If only trust relationship of the access network is received, the PDN GW shall keep all stored user and APN data for the subscriber identity as indicated in the request. + +If the P-CSCF-Restoration-Request bit in the RAR Flags is set, the PDN GW shall keep all stored user data and APN data for the subscriber identity indicated in the request unless this data is present in the authorisation answer and proceed with the P-CSCF restoration for WLAN as specified in 3GPP TS 23.380 [52]. + +For PMIPv6 based S2a or S2b, if Trace-Info AVP including Trace-Data has been received in the authorization response, the PDN GW shall start a trace session for the user. If Trace-Info including Trace-Reference (directly under the Trace-Info) has been received in the authorization response, the PDN GW shall stop the ongoing trace session, identified by the Trace-Reference. For details, see 3GPP TS 32.422 [32]. + +For GTPv2 based S2a or S2b, the PDN GW shall ignore the Trace-Info AVP if received in the authorization response. + +NOTE: For GTPv2 based S2a or S2b, trace is activated and deactivated via the STa and S2a interfaces or via the SWm and S2b interfaces. + +## 9.1.2.6 Authorization Procedures when using MIPv4 FACoA + +### 9.1.2.6.1 General + +The following authorization procedures take place upon a reception of a RRQ at the PDN GW from the FA. + +The PDN GW shall update its identity to the 3GPP AAA Server and HSS. Static QoS profile information may also be downloaded at the same time. + +MIPv4 security parameters shall be exchanged between the PDN GW and the 3GPP AAA Server. + +The procedures are based on the reuse of NASREQ IETF RFC 4005 [4] AAR and AAA commands. + +**Table 9.1.2.6.1/1: Authorization request** + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|----------------------------------------------|----------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Permanent User Identity | User-Name | M | This IE shall contain the permanent user identity. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15] and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]; this IE shall not include the leading digit prepended in front of the IMSI used to differentiate between authentication schemes. | +| Authentication Request Type | Auth-Request-Type | M | This IE shall define whether the UE is to be authenticated only, authorized only or both. AUTHORIZE_ONLY shall be used in this case. | +| PDN GW Identity | MIP6-Agent-Info | O | This IE shall contain the address and possibly the FQDN of the selected PDN GW for the UE and the corresponding PDN connection | +| PGW PLMN ID | Visited-Network-Identifier | C | This IE shall contain the identifier that allows the home network to identify the PLMN where the PGW is located. It shall be present when the PGW Identity is present and does not contain an FQDN. | +| Mobility features | MIP6-Feature-Vector | M | This IE shall contain the mobility features used by the PDN GW. The MIP4_SUPPORTED flag shall be set | +| APN | Service-Selection | C | If present this IE shall contain the Network Identifier part of the APN extracted from the RRQ message. In case it is not received, the 3GPP AAA Server shall assign the received PDN-GW identity to the default APN. | +| QoS capabilities | QoS-Capability | O | If included in the request message, this IE shall indicate to the 3GPP AAA Server that the PDN GW requests downloading of a static QoS profile for the UE. The PDN GW may include this IE only at the initial attach of the UE. | +| Supported Features (See 3GPP TS 29.229 [24]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host for the lifetime of the Diameter session. | +| MN-HA security parameter index | MIP-MN-HA-SPI | C | This IE shall contain the MN-HA security parameter index which is used in identifying MN-HA shared key as defined by 3GPP TS 33.402 [19]. It shall be included when the PDN-GW does not have the MN-HA shared key required to verify the MIPv4 RRQ message. | + +**Table 9.1.2.6.1/2: Authorization answer** + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|----------------------------------------------|-------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result code | Result-Code | M | This IE shall contain the result of the operation. The possible values of the Result-Code AVP are defined in IETF RFC 6733 [58]. This IE shall be set to DIAMETER_SUCCESS if the authorization of a MAG or the update of the PDN GW identity succeeded. It shall be set to DIAMETER_AUTHORIZATION_REJECTED if the authorization of a new MAG or the update of the PDN GW identity failed. | +| Authentication Request Type | Auth-Request-Type | M | It shall contain the value AUTHORIZE_ONLY. See IETF RFC 4072 [5]. | +| Authorized mobility features | MIP6-Feature-Vector | C | The 3GPP AAA Server shall insert this AVP if the authorization was successful. The MIP4_SUPPORTED flag shall be set. | +| Session time | Session-Timeout | C | If the authorization succeeded, then this IE shall contain the time this authorization is valid for. | +| QoS resources | QoS-Resources | C | This AVP shall be included only if the QoS-Capability AVP was received in the authorization request and the authorization succeeded. Then the 3GPP AAA Server shall include a static QoS profile in this IE during the UE initial attach if the PDN GW included QoS-Capabilities AVP in the request message and the UE has been provisioned with a static QoS profile. The QoS profile template value in this IE shall be set to 0. | +| 3GPP AAA Server URI | Redirect-Host | C | This information element shall be sent if the Result-Code value is set to DIAMETER_REDIRECT_INDICATION. When the user has previously been authenticated by another 3GPP AAA Server, it shall contain the Diameter URI of the 3GPP AAA Server currently serving the user. The node receiving this IE shall behave as defined in the Diameter base protocol (see IETF RFC 6733 [58]). The command shall contain zero or more occurrences of this information element. When choosing a destination for the redirected message from multiple Redirect-Host AVPs, the receiver shall send the Diameter request to the first 3GPP AAA Server in the ordered list received in the Diameter response. If no successful response to the Diameter request is received, the receiver shall send the Diameter request to the next 3GPP AAA Server in the ordered list. This procedure shall be repeated until a successful response is received from a 3GPP AAA Server. | +| Supported Features (See 3GPP TS 29.229 [24]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host for the lifetime of the Diameter session. | +| MN-HA shared key | MIP-Session-Key | C | This information element contains the MN-HA shared key as defined by 3GPP TS 33.402 [19], it shall be included if the Result-Code value is set to DIAMETER_SUCCESS and the MIP-MN-HA-SPI was sent in the authorization request.. | +| APN Data | APN-Configuration | C | This information element shall only be sent if the Result-Code AVP is set to DIAMETER_SUCCESS.
This AVP shall contain the user profile information.
APN-Configuration is a grouped AVP and shall include the following information elements:
- APN
- Authorized 3GPP QoS profile
- APN-AMBR | + +#### 9.1.2.6.2 PDN GW Detailed Behaviour + +Upon receipt of a RRQ message from the FA, the PDN GW shall initiate an authorization procedure, by sending an Authorization Request message to the 3GPP AAA Server or to the 3GPP AAA Proxy, with the Auth-Request-Type set to AUTHORIZE\_ONLY, in order to update the PGW Address for the APN, as well as to download any UE specific APN profile information such as IP address allocation information, QoS Information, Session timeouts, Session Idle timeouts, MIPv4 security parameters etc. + +If the APN was included in the RRQ message, the PDN GW shall include in the request the APN where the user shall be connected. + +The PDN GW Identity shall only be included in the initial request to the 3GPP AAA Server; subsequent authorization messages (due to a handover to a different FA, for instance) shall not include it again. + +If the PDN GW does not have a MN-HA shared key associated with the SPI received in the RRQ MN-HA-AE, the PDN GW shall include the SPI in the Authorization Request to the 3GPP AAA Server. + +After successful reception of the Authorization Request message, the PDN GW shall check that the Result-Code is set to DIAMETER\_SUCCESS and, if so, it shall use the MN-HA key to verify the MN-HA AE of the RRQ received from the FA. + +If the PDN-GW successfully verifies the MN-HA-AE it shall proceed to connect the user to the specified APN, and will send the RRP message to the FA. + +#### 9.1.2.6.3 3GPP AAA Server Detailed Behaviour + +Upon receipt of the Authorization Request message from the PDN GW, the 3GPP AAA Server shall update the PDN GW information for the APN for the UE on the HSS. If the APN was not received from the PDN GW the 3GPP AAA Server shall assign the received PDN-GW identity to the default APN . + +The 3GPP AAA Server must check that the user exists. If the user's data exists in the 3GPP AAA Server, it shall check, whether it also has an active access authorization session for the user. + +- If not, the 3GPP AAA Server shall reject the authorization request, including the Result-Code DIAMETER\_AUTHORIZATION\_REJECTED. +- If the 3GPP AAA Server has an existing authorization session, + - If the APN requested by the PDN GW is included in the list of authorized APNs of the user, then the 3GPP AAA Server shall include the Service-Selection AVP in the authorization answer. If no APN was requested the Service-Selection AVP shall contain the default APN. + - If the MN-HA-SPI was included in the request and it matches the SPI belonging to a SA of the user then the 3GPP AAA Server shall include the MIP-Session-Key of the SA in the authorization answer and set the Result-Code to DIAMETER\_SUCCESS. + - If the MN-HA-SPI was included in the request and there is no match with a SPI belonging to a SA of the user then the status code DIAMETER\_AUTHORIZATION\_REJECTED shall be returned to the PDN GW to indicate an unsuccessful authorization. +- If the APN requested by the PDN GW is not included in the list of authorized APNs, then the status code DIAMETER\_AUTHORIZATION\_REJECTED shall be returned to the PDN GW to indicate an unsuccessful authorization. + +If the user's profile does not exist in the 3GPP AAA Server, it shall retrieve the Diameter identity of the 3GPP AAA Server currently serving the user from the HSS following the procedures for subscriber profile download as specified in clause 8.1.2.2.2. Depending on the HSS response, + +- If the HSS indicates that the user is currently being served by a different 3GPP AAA Server, the 3GPP AAA Server shall respond to the PDN-GW with the Result-Code set to DIAMETER\_REDIRECT\_INDICATION and Redirect-Host set to the Diameter URI of the 3GPP AAA Server currently serving the user (this Diameter URI shall be constructed based on the Diameter Identity included in the 3GPP-AAA-Server-Name AVP returned in the SWx authentication response from the HSS). +- If the HSS returns DIAMETER\_ERROR\_USER\_UNKNOWN, the 3GPP AAA Server shall return the same error to the PDN GW. +- If the HSS sends the user's profile to the 3GPP AAA Server, the authorization shall be rejected by setting the Result-Code to DIAMETER\_AUTHORIZATION\_REJECTED. The 3GPP AAA Server shall delete the downloaded user profile. + +NOTE: The last outcome corresponds to the case that the user has no active access authorization procedure. This is considered as an error situation, e.g. the Trusted Non-3GPP access network may have sent RRQ without authorizing the user. + +#### 9.1.2.6.4 3GPP AAA Proxy Detailed Behaviour + +The 3GPP AAA Proxy is required to handle roaming cases in which the PDN GW is located in the VPLMN. The 3GPP AAA Proxy shall act as a stateful proxy. + +On receipt of the authorization answer, the 3GPP AAA Proxy + +- shall check locally configured information for the maximum allowed static QoS parameters valid for visitors from the given HPLMN and modify the QoS parameters received from the 3GPP AAA Server, to enforce the policy limitations. +- shall record the state of the connection (i.e. Authorization Successful). + +## 9.2 Protocol Specification + +### 9.2.1 General + +The S6b reference point shall be based on Diameter, as defined in IETF RFC 6733 [58], and contain the following additions and extensions: + +- IETF RFC 4005 [4], which defines a Diameter protocol application used for Authentication, Authorization and Accounting (AAA) services in the Network Access Server (NAS) environment. +- IETF RFC 5779 [2], which defines a Diameter extensions and application for PMIPv6 MAG to AAA and LMA to AAA interfaces. +- IETF RFC 5777 [9], which defines attribute value pairs to convey QoS information between Diameter peers. + +The PDN GW to 3GPP AAA server or the PDN GW to 3GPP AAA proxy communication shall use the LMA to AAA interface functionality defined in IETF RFC 5779 [2] to update the 3GPP AAA server with PDN GW identity, indicate the protocol selected on S2a or S2b and optionally retrieve mobility related parameters and static QoS profiles, when PMIPv6 or GTPv2 based S2a or S2b is used. + +The PDN-GW acts as a LMA when the UE attaches to the EPC using the S2a or S2b reference points and PMIPv6 is used. The PDN GW also follows the LMA to AAA interface functionality defined in IETF RFC 5779 [2] when UE attaches to the EPC using S2a or S2b reference point and GTPv2 is used. The PDN GW acts as HA when the UE attaches to the EPC using the S2a reference point and MIPv4 is used. + +In the case the UE attached to the EPC using the S2c reference point, then the communication between the PDN GW and HA, IETF RFC 5778 [11] shall be used. The Application Id to be advertised over the S6b reference point corresponds to the DSMIPv6 "Diameter Mobile IPv6 IKE (MIP6I)" Application Id as defined in IETF RFC 5778 [11]. + +IKEv2 EAP-based initiator authentication is used for authenticating and authorizing the UE and updating the PDN-GW identity. In this case, the PDN GW shall behave as described in 3GPP TS 33.402 [19]. + +### 9.2.2 Commands + +#### 9.2.2.1 Commands for S6b DSMIPv6 Authorization Procedures + +##### 9.2.2.1.1 Diameter-EAP-Request (DER) Command + +The Diameter-EAP-Request (DER) command, indicated by the Command-Code field set to 268 and the "R" bit set in the Command Flags field, is sent from a PGW to a 3GPP AAA server. The Command Code value and the ABNF are re-used from the IETF RFC 5778 [11]. + +``` + +< Diameter-EAP-Request > ::= < Diameter Header: 268, REQ, PXY, 16777272 > + < Session-Id > + [ DRMP ] + { Auth-Application-Id } + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + { Auth-Request-Type } + [ RAT-Type ] + [ User-Name ] + [ Service-Selection ] + { EAP-Payload } + [ MIP6-Feature-Vector ] + [ MIP6-Agent-Info ] + [ QoS-Capability ] + [ Visited-Network-Identifier ] + [ MIP-Careof-Address ] + [ AAA-Failure-Indication ] + *[ Supported-Features ] + [DER-S6b-Flags] + [ UE-Local-IP-Address ] + ... + *[ AVP ] + +``` + +#### 9.2.2.1.2 Diameter-EAP-Answer (DEA) Command + +The Diameter-EAP-Answer (DEA) command, indicated by the Command-Code field set to 268 and the "R" bit cleared in the Command Flags field, is sent from a 3GPP AAA server to a PGW. The Command Code value and the ABNF are re-used from the IETF RFC 5778 [11]. + +``` + + ::= < Diameter Header: 268, PXY, 16777272 > + < Session-Id > + [ DRMP ] + { Auth-Application-Id } + { Auth-Request-Type } + { Result-Code } + { Origin-Host } + { Origin-Realm } + [ User-Name ] + [ EAP-Payload ] + [ EAP-Master-Session-Key ] + [ Mobile-Node-Identifier ] + [ APN-Configuration ] + [ MIP6-Agent-Info ] + [ MIP6-Feature-Vector ] + [ 3GPP-Charging-Characteristics ] + *[ QoS-Resources ] + *[ Redirect-Host ] + [ Trace-Info ] + *[ Supported-Features ] + ... + *[ AVP ] + +``` + +#### 9.2.2.2 Commands for S6b PMIPv6, GTPv2 or DSMIPv6 Authorization Procedures + +##### 9.2.2.2.1 AA-Request (AAR) Command + +The AA-Request (AAR) command, indicated by the Command-Code field set to 265 and the "R" bit set in the Command Flags field, is sent from the PDN GW to the 3GPP AAA Server. The Command Code value and ABNF are + +re-used from the IETF RFC 4005 [4] AA-Request command. New AVPs are added using the \*[AVP] extension mechanism in the original ABNF. + +NOTE: This command is used for the S6b Authorization Procedure for PMIPv6 or GTPv2, and also for the S6b Service Authorization Information Update procedure for PMIPv6, GTPv2 or DSMIPv6 following a previous RAR/RAA command exchange initiated by the 3GPP AAA Server. + +``` + ::= < Diameter Header: 265, REQ, PXY, 16777272 > + < Session-Id > + [ DRMP ] + { Auth-Application-Id } + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + { Auth-Request-Type } + [ User-Name ] + [ MIP6-Agent-Info ] + [ MIP6-Feature-Vector ] + [ Visited-Network-Identifier ] + [ QoS-Capability ] + [ Service-Selection ] + [ OC-Supported-Features ] + [ Origination-Time-Stamp ] + [ Maximum-Wait-Time ] + *[ Supported-Features ] + [ Emergency- Services ] + ... + *[ AVP ] +``` + +#### 9.2.2.2.2 AA-Answer (AAA) Command + +The AA-Answer (AAA) command, indicated by the Command-Code field set to 265 and the "R" bit cleared in the Command Flags field, is sent from the 3GPP AAA Server to the PDN GW. The Command Code value and ABNF are re-used from the IETF RFC 4005 [4] AA-Answer command. New AVPs are added using the \*[AVP] extension mechanism in the original ABNF. + +NOTE: This command is used for the S6b Authorization Procedure for PMIPv6 or GTPv2, and also for the S6b Service Authorization Information Update procedure for PMIPv6, GTPv2 or DSMIPv6 following a previous RAR/RAA command exchange initiated by the 3GPP AAA Server. + +``` + ::= < Diameter Header: 265, PXY, 16777272 > + < Session-Id > + [ DRMP ] + { Auth-Application-Id } + { Auth-Request-Type } + { Result-Code } + { Origin-Host } + { Origin-Realm } + ... + [ MIP6-Feature-Vector ] + [ Session-Timeout ] + [ APN-Configuration ] + [ QoS-Resources ] + [ AN-Trusted ] + *[ Redirect-Host ] + [ Trace-Info ] + [ OC-Supported-Features ] + [ OC-OLR ] + *[ Load ] +``` + +``` + +*[ Supported-Features ] +... +*[ AVP ] + +``` + +### 9.2.2.3 Commands for PDN GW Initiated Session Termination + +#### 9.2.2.3.1 Session-Termination-Request (STR) Command + +The Session-Termination-Request (STR) command, indicated by the Command-Code field set to 275 and the "R" bit set in the Command Flags field, is sent from a PDN GW to a 3GPP AAA server. The Command Code value and ABNF are re-used from the IETF RFC 6733 [58] Session-Termination-Request command. New AVPs are added using the \*[AVP] extension mechanism in the original ABNF. + +``` + + ::= < Diameter Header: 275, REQ, PXY, 16777272 > +< Session-Id > +[ DRMP ] +{ Auth-Application-Id } +{ Origin-Host } +{ Origin-Realm } +{ Destination-Realm } +{ Termination-Cause } +[ User-Name ] +[ OC-Supported-Features ] +... +*[ AVP ] + +``` + +#### 9.2.2.3.2 Session-Termination-Answer (STA) Command + +The Session-Termination-Answer (STA) command, indicated by the Command-Code field set to 275 and the "R" bit cleared in the Command Flags field, is sent from a 3GPP AAA server to a PDN GW. The Command Code value and ABNF are re-used from the IETF RFC 6733 [58] Session-Termination-Answer command. + +``` + + ::= < Diameter Header: 275, PXY, 16777272 > + +< Session-Id > +[ DRMP ] +{ Result-Code } +{ Origin-Host } +{ Origin-Realm } +[ OC-Supported-Features ] +[ OC-OLR ] +*[ Load ] +*[ AVP ] + +``` + +### 9.2.2.4 Commands for 3GPP AAA Server Initiated Session Termination + +#### 9.2.2.4.1 Abort-Session-Request (ASR) Command + +The Abort-Session-Request (ASR) command, indicated by the Command-Code field set to 274 and the "R" bit set in the Command Flags field, is sent from a 3GPP AAA Server/Proxy to a PDN GW. The ABNF is based on the one in IETF RFC 4005 [4]. + +``` + +< Abort-Session-Request > ::= < Diameter Header: 274, REQ, PXY, 16777272 > +< Session-Id > +[ DRMP ] +{ Origin-Host } +{ Origin-Realm } +{ Destination-Realm } +{ Destination-Host } +{ Auth-Application-Id } +[ User-Name ] +[ Auth-Session-State ] +... + +``` + +\*[ AVP ] + +#### 9.2.2.4.2 Abort-Session-Answer (ASA) Command + +The Abort-Session-Answer (ASA) command, indicated by the Command-Code field set to 274 and the "R" bit cleared in the Command Flags field, is sent from a PDN GW to a 3GPP AAA Server/Proxy. The ABNF is based on the one in IETF RFC 4005 [4]. + +``` +< Abort-Session-Answer > ::= < Diameter Header: 274, PXY, 16777272 > + < Session-Id > + [ DRMP ] + { Result-Code } + { Origin-Host } + { Origin-Realm } + ... + *[ AVP ] +``` + +#### 9.2.2.4.3 Session-Termination-Request (STR) Command + +The Session-Termination-Request (STR) command, indicated by the Command-Code field set to 275 and the "R" bit set in the Command Flags field, is sent from an PDN GW to a 3GPP AAA Server/Proxy. The Command Code value and ABNF are re-used from the IETF RFC 6733 [58] Session-Termination-Request command. + +``` + ::= < Diameter Header: 275, REQ, PXY, 16777272 > + < Session-Id > + [ DRMP ] + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + { Auth-Application-Id } + { Termination-Cause } + [ User-Name ] + [ OC-Supported-Features ] + ... + *[ AVP ] +``` + +#### 9.2.2.4.4 Session-Termination-Answer (STA) Command + +The Session-Termination-Answer (STA) command, indicated by the Command-Code field set to 275 and the "R" bit cleared in the Command Flags field, is sent from a 3GPP AAA Server/Proxy to an PDN GW. The Command Code value and ABNF are re-used from the IETF RFC 6733 [58] Session-Termination-Answer command. + +``` + ::= < Diameter Header: 275, PXY, 16777272 > + < Session-Id > + [ DRMP ] + { Result-Code } + { Origin-Host } + { Origin-Realm } + [ OC-Supported-Features ] + [ OC-OLR ] + *[ Load ] + *[ AVP ] +``` + +### 9.2.2.5 Commands for S6b MIPv4 FACoA Authorization Procedures + +#### 9.2.2.5.1 AA-Request (AAR) Command + +The AA-Request (AAR) command, indicated by the Command-Code field set to 265 and the "R" bit set in the Command Flags field, is sent from a PDN GW to a 3GPP AAA Server. The Command Code value and ABNF are re-used from the IETF RFC 4005 [4] AA-Request command. New AVPs are added using the \*[AVP] extension mechanism in the original ABNF. + +``` + + ::= < Diameter Header: 265, REQ, PXY, 16777272 > + < Session-Id > + [ DRMP ] + { Auth-Application-Id } + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + { Auth-Request-Type } + [ User-Name ] + [ MIP6-Agent-Info ] + [ MIP6-Feature-Vector ] + [ Visited-Network-Identifier ] + [ QoS-Capability ] + [ Service-Selection ] + *[ Supported-Features ] + [MIP-MN-HA-SPI] + [ OC-Supported-Features ] + ... + *[ AVP ] + +``` + +#### 9.2.2.5.2 AA-Answer (AAA) Command + +The AA-Answer (AAA) command, indicated by the Command-Code field set to 265 and the "R" bit cleared in the Command Flags field, is sent from a 3GPP AAA Server to a PDN GW. The Command Code value and ABNF are re-used from the IETF RFC 4005 [4] AA-Answer command. New AVPs are added using the \*[AVP] extension mechanism in the original ABNF. + +``` + + ::= < Diameter Header: 265, PXY, 16777272 > + < Session-Id > + [ DRMP ] + { Auth-Application-Id } + { Auth-Request-Type } + { Result-Code } + { Origin-Host } + { Origin-Realm } + [ OC-Supported-Features ] + [ OC-OLR ] + *[ Load ] + ... + [ MIP6-Feature-Vector ] + [ Session-Timeout ] + [ APN-Configuration ] + [ QoS-Resources ] + *[ Redirect-Host ] + *[ Supported-Features ] + [MIP-Session-Key] + ... + *[ AVP ] + +``` + +#### 9.2.2.6 Commands for S6b Service Authorization Information Update Procedures + +##### 9.2.2.6.1 Re-Auth-Request (RAR) Command + +The Diameter Re-Auth-Request (RAR) command shall be indicated by the Command-Code field set to 258 and the "R" bit set in the Command Flags field and is sent from a 3GPP AAA Server or 3GPP AAA Proxy to a PDN-GW. The ABNF for the RAR command shall be as follows: + +``` + +< Re-Auth-Request > ::= < Diameter Header: 258, REQ, PXY, 16777272 > + < Session-Id > + [ DRMP ] + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + { Destination-Host } + { Auth-Application-Id } + { Re-Auth-Request-Type } + [ User-Name ] + [ RAR-Flags ] + ... + *[ AVP ] + +``` + +### 9.2.2.6.2 Re-Auth-Answer (RAA) Command + +The Diameter Re-Auth-Answer (ASA) command shall be indicated by the Command-Code field set to 258 and the "R" bit cleared in the Command Flags field and is sent from a PDN-GW to a 3GPP AAA Server or 3GPP AAA Proxy. The ABNF for the RAA commands shall be as follows: + +``` + +< Re-Auth-Answer > ::= < Diameter Header: 258, PXY, 16777272 > + < Session-Id > + [ DRMP ] + { Result-Code } + { Origin-Host } + { Origin-Realm } + [ User-Name ] + ... + *[ AVP ] + +``` + +## 9.2.3 Information Elements + +### 9.2.3.0 General + +The following clauses describes the Diameter AVPs defined for the S6b interface protocol in the different modes of operation (DSMIPv6, PMIPv6/GTPv2, MIPv4...). + +For all AVPs which contain bit masks and are of the type Unsigned32, bit 0 shall be the least significant bit. For example, to get the value of bit 0, a bit mask of 0x00000001 should be used. + +### 9.2.3.1 S6b DSMIPv6 procedures + +#### 9.2.3.1.1 General + +The following table describes the Diameter AVPs defined for the S6b interface protocol in DSMIPv6 mode, their AVP Code values, types, possible flag values and whether or not the AVP may be encrypted. + +**Table 9.2.3.1.1/1: Diameter S6b AVPs for DSMIPv6** + +| Attribute Name | AVP Code | Clause defined | Value Type | AVP Flag rules | | | | +|----------------------------|----------|----------------|-------------|----------------|-----|------------|----------| +| | | | | Must | May | Should not | Must not | +| MIP6-Agent-Info | 486 | 9.2.3.2.2 | Grouped | M | | | V,P | +| MIP6-Feature-Vector | 124 | 9.2.3.2.3 | Unsigned64 | M | | | V,P | +| Visited-Network-Identifier | 600 | 9.2.3.1.2 | OctetString | M,V | | | P | +| RAR-Flags | 1522 | 9.2.3.1.5 | Unsigned32 | V | | | M,P | +| QoS-Capability | 578 | 9.2.3.2.4 | Grouped | M | | | V,P | +| QoS-Resources | 508 | 9.2.3.2.5 | Grouped | M | | | V,P | +| Trace-Info | 1505 | 8.2.3.13 | Grouped | V | | | M,P | +| Service-Selection | 493 | 5.2.3.5 | UTF8String | M | | | V,P | +| Trust-Relationship-Update | 1515 | 9.2.3.1.4 | Enumerated | V | | | M,P | +| AAA-Failure-Indication | 1518 | 8.2.3.21 | Unsigned32 | V | | | M,P | +| DER-S6b-Flags | 1523 | 9.2.3.7 | Unsigned32 | V | | | M,P | + +NOTE 1: The AVP header bit denoted as "M", indicates whether support of the AVP is required. The AVP header bit denoted as "V", indicates whether the optional Vendor-ID field is present in the AVP header. For further details, see IETF RFC 6733 [58]. + +NOTE 2: If the M-bit is set for an AVP and the receiver does not understand the AVP, it shall return a rejection. If the M-bit is not set for an AVP, the receiver shall not return a rejection, whether or not it understands the AVP. If the receiver understands the AVP but the M-bit value does not match with the definition in this table, the receiver shall ignore the M-bit. + +### 9.2.3.1.2 Visited-Network-Identifier + +The Visited-Network-Identifier AVP contains an identifier that helps the home network to identify the visited network (e.g. the visited network domain name). The Vendor-Id shall be set to 10415 (3GPP). + +The AVP shall be encoded as: + +mnc.mcc.3gppnetwork.org + +If MNC consists of only 2 digits, a leading digit "0" shall be added to the MNC value (e.g., if MNC=15 and MCC=234, the value of Visited-Network-Identifier shall be "mnc015.mcc234.3gppnetwork.org"). + +### 9.2.3.1.3 Void + +### 9.2.3.1.4 Void + +### 9.2.3.1.5 RAR-Flags + +The RAR-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 9.2.3.1.5/1: + +**Table 9.2.3.1.5/1: RAR-Flags** + +| Bit | Name | Description | +|-------------------------------------------------------------------------------------------------------------------|--------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | Trust-Relationship-Update-indication | This bit, when set, indicates to the PDN GW that the 3GPP AAA server only initiates the re-authorization procedure send the trust relationship to the PDN GW, and the PDN GW shall not perform any authorization procedure towards the UE. | +| 1 | P-CSCF Restoration Request | This bit, when set, shall indicate to the PDN GW that the 3GPP AAA Server requests the execution of the HSS-based P-CSCF restoration procedures for WLAN, as described in 3GPP TS 23.380 [52] clause 5.6. | +| NOTE: Bits not defined in this table shall be cleared by the sender and discarded by the receiver of the command. | | | + +### 9.2.3.2 S6b PMIPv6 or GTPv2 procedures + +#### 9.2.3.2.1 General + +The following table describes the Diameter AVPs defined for the S6b interface protocol in PMIPv6 or GTPv2 mode, their AVP Code values, types, possible flag values and whether or not the AVP may be encrypted. + +**Table 9.2.3.2.1/1: Diameter S6b AVPs for PMIPv6 or GTPv2** + +| Attribute Name | AVP Code | Clause defined | Value Type | AVP Flag rules | | | | +|----------------------------|----------|----------------|-------------|----------------|-----|------------|----------| +| | | | | Must | May | Should not | Must not | +| MIP6-Agent-Info | 486 | 9.2.3.2.2 | Grouped | M | | | V,P | +| MIP6-Feature-Vector | 124 | 9.2.3.2.3 | Unsigned64 | M | | | V,P | +| QoS-Capability | 578 | 9.2.3.2.4 | Grouped | M | | | V,P | +| QoS-Resources | 508 | 9.2.3.2.5 | Grouped | M | | | V,P | +| Trace-Info | 1505 | 8.2.3.13 | Grouped | V | | | M,P | +| Service-Selection | 493 | 5.2.3.5 | UTF8String | M | | | V,P | +| Visited-Network-Identifier | 600 | 9.2.3.1.2 | OctetString | M,V | | | P | +| Origination-Time-Stamp | 1536 | 9.2.3.2.6 | Unsigned64 | V | | | M,P | +| Maximum-Wait-Time | 1537 | 9.2.3.2.7 | Unsigned32 | V | | | M,P | +| Emergency- Services | 1538 | 7.2.3.5 | Unsigned32 | V | | | M,P | + +NOTE 1: The AVP header bit denoted as "M", indicates whether support of the AVP is required. The AVP header bit denoted as "V", indicates whether the optional Vendor-ID field is present in the AVP header. For further details, see IETF RFC 6733 [58]. + +NOTE 2: If the M-bit is set for an AVP and the receiver does not understand the AVP, it shall return a rejection. If the M-bit is not set for an AVP, the receiver shall not return a rejection, whether or not it understands the AVP. If the receiver understands the AVP but the M-bit value does not match with the definition in this table, the receiver shall ignore the M-bit. + +#### 9.2.3.2.2 MIP6-Agent-Info + +The MIP6-Agent-Info AVP contains the PDN GW identity or (for the chained S2 - PMIP based S8 case) the Serving GW address information. This AVP is defined in IETF RFC 5447 [6]. The identity of PDN GW is either an IP address transported in MIP-Home-Agent-Address or an FQDN transported in MIP-Home-Agent-Host. The PDN GW may use its IP address if a single IP address can be used for all Access Networks and protocols towards the PDN GW. In all other cases the PDN GW shall use its FQDN. MAG/AAA/HSS shall use FQDN if known. The grouped AVP has the following grammar: + +``` +MIP6-Agent-Info ::= < AVP Header: 486 > + *2[ MIP-Home-Agent-Address ] + [ MIP-Home-Agent-Host ] + [ MIP6-Home-Link-Prefix ] + *[ AVP ] +``` + +NOTE: The AVP MIP6-Home-Link-Prefix is not used in S6b, but it is included here to reflect the complete IETF definition of the grouped AVP. + +#### 9.2.3.2.3 MIP6-Feature-Vector + +The MIP6-Feature-Vector AVP contains a 64 bit flags field of supported mobility capabilities of the NAS. This AVP is defined in IETF RFC 5447 [6]. The NAS may include this AVP in a request message to indicate the mobility capabilities of the NAS to the 3GPP AAA server. Similarly, the Diameter server may include this AVP in an answer message to inform the NAS about which of the NAS indicated capabilities are supported or authorized by the 3GPP AAA Server. + +Following capabilities are supported on S6b reference point in PMIPv6 or GTPv2 mode: + +- PMIP6\_SUPPORTED +- IP4\_HOA\_SUPPORTED +- GTPv2\_SUPPORTED + +#### 9.2.3.2.4 QoS-Capability + +The QoS-Capability AVP contains a list of supported Quality of Service profile templates (and therefore the support of the respective parameter AVPs). This AVP is defined in IETF RFC 5777 [9]. + +#### 9.2.3.2.5 QoS-Resources + +The QoS-Resources AVP includes a description of the Quality of Service resources for policing traffic flows. This AVP is defined in IETF RFC 5777 [9]. + +#### 9.2.3.2.6 Origination-Time-Stamp + +The Origination-Time-Stamp is of type Unsigned64. It indicates the UTC time when the originating entity initiated the request. It shall contain the number of milliseconds since 00:00:00 on 1 January 1900 UTC. + +NOTE: This AVP contains the same numeric value, in milliseconds, as received over the GTPv2 protocol from the originating entity (see 3GPP TS 29.274 [38], clause 8.119). + +#### 9.2.3.2.7 Maximum-Wait-Time + +The Maximum-Wait-Time is of type Unsigned32. It indicates the number of milliseconds since the Origination-Time-Stamp during which the originator of a request waits for a response. See 3GPP TS 29.274 [38]. + +#### 9.2.3.3 S6b Re-used Diameter AVPs + +**Table 9.2.3.3/1: S6b re-used Diameter AVPs** + +| Attribute Name | Reference | Comments | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------|---------------------| +| Supported-Features | 3GPP TS 29.229 [24] | | +| Feature-List-ID | 3GPP TS 29.229 [24] | See clause 9.2.3.4 | +| Feature-List | 3GPP TS 29.229 [24] | See clause 9.2.3.5 | +| MIP-Careof-Address | IETF RFC 5778 [11] | | +| UE-Local-IP-Address | 3GPP TS 29.212 [23] | | +| OC-Supported-Features | IETF RFC 7683 [47] | See clause 8.2.3.22 | +| OC-OLR | IETF RFC 7683 [47] | See clause 8.2.3.23 | +| DRMP | IETF RFC 7944 [53] | See clause 8.2.3.25 | +| Load | IETF RFC 8583 [54] | See clause 8.2.3.26 | +| NOTE 1: The M-bit settings for re-used AVPs override those of the defining specifications that are referenced. Values include: "Must set", "Must not set". If the M-bit setting is blank, then the defining specification applies. | | | +| NOTE 2: If the M-bit is set for an AVP and the receiver does not understand the AVP, it shall return a rejection. If the M-bit is not set for an AVP, the receiver shall not return a rejection, whether or not it understands the AVP. If the receiver understands the AVP but the M-bit value does not match with the definition in this table, the receiver shall ignore the M-bit. | | | + +#### 9.2.3.4 Feature-List-ID AVP + +The syntax of this AVP is defined in 3GPP TS 29.229 [24]. For this release, the Feature-List-ID AVP value shall be set to 1 for the S6b application. + +#### 9.2.3.5 Feature-List AVP + +The syntax of this AVP is defined in 3GPP TS 29.229 [24]. A null value indicates that there is no feature used by the S6b application. The meaning of the bits shall be as defined in table 9.2.3.5/1. + +**Table 9.2.3.5/1: Features of Feature-List-ID 1 used in S6b** + +| Feature bit | Feature | M/O | Description | +|-------------|-----------------------------|-----|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | P-CSCF Restoration for WLAN | O |

Support of P-CSCF Restoration for WLAN

This feature is applicable to the AAR/AAA and RAR/RAA command pairs over the S6b interface, when the PDN GW supports the execution of the P-CSCF restoration procedures for WLAN for the related IMS PDN connection as described in 3GPP TS 23.380 [52] clause 5.6.

If the PDN-GW does not indicate support of this feature in a former AAR command, the 3GPP AAA Server shall not send a RAR command requesting the execution of the HSS-based P-CSCF restoration procedures for WLAN,

| + +Feature bit: The order number of the bit within the Supported-Features AVP, e.g. "1". +Feature: A short name that can be used to refer to the bit and to the feature. +M/O: Defines if the implementation of the feature is mandatory ("M") or optional ("O"). +Description: A clear textual description of the feature. + +Features that are not indicated in the Supported-Features AVPs within a given application message shall not be used to construct that message. + +### 9.2.3.6 S6b MIPv4 FACoA procedures + +#### 9.2.3.6.1 General + +The following table describes the Diameter AVPs defined for the S6b interface protocol in MIPv4 mode, their AVP Code values, types, possible flag values and whether or not the AVP may be encrypted. + +**Table 9.2.3.6.1/1: Diameter S6b AVPs for MIPv4 FACoA** + +| Attribute Name | AVP Code | Clause defined | Value Type | AVP Flag rules | | | | +|---------------------|----------|----------------|-------------|----------------|-----|------------|----------| +| | | | | Must | May | Should not | Must not | +| MIP6-Agent-Info | 486 | 9.2.3.6.2 | Grouped | M | | | V,P | +| MIP6-Feature-Vector | 124 | 9.2.3.6.3 | Unsigned64 | M | | | V,P | +| QoS-Capability | 578 | 9.2.3.6.4 | Grouped | M | | | V,P | +| QoS-Resources | 508 | 9.2.3.6.5 | Grouped | M | | | V,P | +| MIP-MN-HA-SPI | 491 | 9.2.3.6.6 | Unsigned32 | M | | | V,P | +| MIP-Session-Key | 343 | 9.2.3.6.7 | OctetString | M | | | V,P | +| Service-Selection | 493 | 5.2.3.5 | UTF8String | M | | | V,P | + +NOTE 1: The AVP header bit denoted as "M", indicates whether support of the AVP is required. The AVP header bit denoted as "V", indicates whether the optional Vendor-ID field is present in the AVP header. For further details, see IETF RFC 6733 [58]. + +NOTE 2: If the M-bit is set for an AVP and the receiver does not understand the AVP, it shall return a rejection. If the M-bit is not set for an AVP, the receiver shall not return a rejection, whether or not it understands the AVP. If the receiver understands the AVP but the M-bit value does not match with the definition in this table, the receiver shall ignore the M-bit. + +#### 9.2.3.6.2 MIP6-Agent-Info + +The MIP6-Agent-Info AVP contains the PDN GW identity. This AVP is defined in IETF RFC 5447 [6]. The identity of PDN GW is either an IP address transported in MIP-Home-Agent-Address or an FQDN transported in MIP-Home-Agent-Host. The PDN GW may use its IP address if a single IP address can be used for all Access Networks and protocols towards the PDN GW. In all other cases the PDN GW shall use its FQDN. The FA/3GPP AAA Server/HSS shall use FQDN if known. The grouped AVP has the following grammar: + +``` +MIP6-Agent-Info ::= < AVP Header: 486 > + *2[ MIP-Home-Agent-Address ] + [ MIP-Home-Agent-Host ] + [ MIP6-Home-Link-Prefix ] + *[ AVP ] +``` + +NOTE: The AVP MIP6-Home-Link-Prefix is not used in S6b, but it is included here to reflect the complete IETF definition of the grouped AVP. + +#### 9.2.3.6.3 MIP6-Feature-Vector + +The MIP6-Feature-Vector AVP contains a 64 bit flags field of supported mobility capabilities of the NAS. This AVP is defined in IETF RFC 5447 [6]. The NAS may include this AVP in a request message to indicate the mobility capabilities of the NAS to the 3GPP AAA Server. Similarly, the Diameter server may include this AVP in an answer message to inform the NAS about which of the NAS indicated capabilities are supported or authorized by the 3GPP AAA Server. + +Following capabilities are supported on S6b reference point in MIPv4 FACoA mode: + +- MIP4\_SUPPORTED + +#### 9.2.3.6.4 QoS-Capability + +The QoS-Capability AVP contains a list of supported Quality of Service profile templates (and therefore the support of the respective parameter AVPs). This AVP is defined in IETF RFC 5777 [9]. + +#### 9.2.3.6.5 QoS-Resources + +The QoS-Resources AVP includes a description of the Quality of Service resources for policing traffic flows. This AVP is defined in IETF RFC 5777 [9]. + +#### 9.2.3.6.6 MIP-MN-HA-SPI + +The MIP-MN-HA-SPI AVP contains the index of the security association between the Mobile Node and the HA. This AVP is defined in IETF RFC 5778 [11]. + +#### 9.2.3.6.7 MIP-Session-Key + +The MIP-Session-Key AVP contains the MN-HA shared key. This AVP is defined in IETF RFC 4004 [18]. + +#### 9.2.3.7 DER-S6b-Flags + +The DER-S6b-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 9.2.3.7/1: + +**Table 9.2.3.7/1: DER-S6b-Flags** + +| Bit | Name | Description | +|-------|-------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | Initial-Attach-Indicator | This bit, when set, indicates that a UE performs the Initial Attach procedure from non-3GPP access network. When not set, it indicates that a UE performs the Handover procedure. | +| NOTE: | Bits not defined in this table shall be cleared by the sender and discarded by the receiver of the command. | | + +### 9.2.4 Session Handling + +The Diameter protocol between the PDN-GW and the 3GPP AAA Server or the 3GPP AAA Proxy shall always keep session state, and use the same Session-Id parameter for the lifetime of each Diameter session. + +A Diameter session shall identify a PDN Connection for a given user and an APN, while the PDN Connection is kept alive in the non-3GPP access. When the PDN Connection is either disconnected on the non-3GPP access, or handed over to the 3GPP access, the diameter session shall be terminated. In order to indicate that the session state is to be maintained, the Diameter client and server shall not include the Auth-Session-State AVP, either in the request or in the response messages (see IETF RFC 6733 [58]). + +--- + +## 10 Result-Code and Experimental-Result Values + +### 10.1 General + +This clause defines result code values that shall be supported by all Diameter implementations that conform to this specification. + +### 10.2 Success + +Result codes that fall within the Success category shall be used to inform a peer that a request has been successfully completed. The Result-Code AVP values defined in Diameter base protocol (IETF RFC 6733 [58]) shall be applied. + +### 10.3 Permanent Failures + +#### 10.3.1 General + +Errors that fall within the Permanent Failures category shall be used to inform the peer that the request has failed, and should not be attempted again. The Result-Code AVP values defined in Diameter base protocol (IETF RFC 6733 [58]) shall be applied. When one of the result codes defined here is included in a response, it shall be inside an Experimental-Result AVP and the Result-Code AVP shall be absent. + +#### 10.3.2 DIAMETER\_ERROR\_USER\_UNKNOWN (5001) + +This result code shall be sent by the HSS to indicate that the user identified by the IMSI is unknown (see 3GPP TS 29.229 [24]). + +#### 10.3.3 DIAMETER\_ERROR\_IDENTITY\_NOT\_REGISTERED (5003) + +This result code shall be sent by the HSS to indicate that there is currently no 3GPP AAA Server registered for the user (see 3GPP TS 29.229 [24]). + +#### 10.3.4 DIAMETER\_ERROR\_ROAMING\_NOT\_ALLOWED (5004) + +This result code shall be sent by the HSS to indicate that the subscriber is not allowed to roam in a certain non-3GPP V-PLMN (see 3GPP TS 29.229 [24]). + +#### 10.3.5 DIAMETER\_ERROR\_IDENTITY\_ALREADY\_REGISTERED (5005) + +This result code shall be sent by the HSS to indicate that the node identity trying to be registered by a 3GPP AAA Server is already registered for a specific user (see 3GPP TS 29.229 [24]). + +#### 10.3.6 DIAMETER\_ERROR\_USER\_NO\_NON\_3GPP\_SUBSCRIPTION (5450) + +This result code shall be sent by the HSS to indicate that no non-3GPP subscription is associated with the IMSI. + +#### 10.3.7 DIAMETER\_ERROR\_USER\_NO\_APN\_SUBSCRIPTION (5451) + +This result code shall be sent by the 3GPP AAA Server to indicate that the requested APN is not included in the user's profile, and therefore is not authorized for that user. + +### 10.3.8 DIAMETER\_ERROR\_RAT\_TYPE\_NOT\_ALLOWED (5452) + +This result code shall be sent by the HSS to indicate the RAT type the UE is using is not allowed for the IMSI. + +### 10.3.9 DIAMETER\_ERROR\_LATE\_OVERLAPPING\_REQUEST (5453) + +This result code shall be sent by the 3GPP AAA Server to indicate that the incoming request collides with an existing session which has a more recent time stamp than the time stamp of the new request. + +### 10.3.10 DIAMETER\_ERROR\_TIMED\_OUT\_REQUEST (5454) + +This result code shall be sent by the 3GPP AAA Server to indicate that the incoming request is known to have already timed out at the originating entity. + +### 10.3.11 DIAMETER\_ERROR\_ILLEGAL\_EQUIPMENT (5554) + +This result code shall be sent by the 3GPP AAA Server or 3GPP AAA Proxy to indicate that the Mobile Equipment used is not acceptable to the network, e.g. blacklisted. + +## 10.4 Transient Failures + +### 10.4.1 General + +Result codes that fall within the transient failures category shall be used to inform a peer that the request could not be satisfied at the time it was received, but may be able to satisfy the request in the future. The Result-Code AVP values defined in Diameter base protocol ( IETF RFC 6733 [58]) shall be applied. When one of the result codes defined here is included in a response, it shall be inside an Experimental-Result AVP and the Result-Code AVP shall be absent. + +There are no Transient Error codes defined in this specification. + +--- + +## 11 3GPP AAA Server/Proxy – EIR + +### 11.1 Functionality + +#### 11.1.1 General + +The definition of the reference point between the 3GPP AAA Server or 3GPP AAA Proxy and the EIR and its functionality is specified in clauses 7.2 and 16.2 in 3GPP TS 23.402 [3]. + +The 3GPP AAA Server/Proxy – EIR reference point is used to check the Mobile Equipment's identity status (e.g. to check that it has not been stolen, or, to verify that it does not have faults). + +#### 11.1.2 Procedures Description + +##### 11.1.2.1 ME Identity Check + +###### 11.1.2.1.1 General + +The Mobile Equipment Identity Check Procedure shall be used between the 3GPP AAA Server and the EIR if the TWAN or ePDG is in the HPLMN, or between the 3GPP AAA Proxy and the EIR if the TWAN or ePDG is in the VPLMN, to check the Mobile Equipment's identity status (e.g. to check that it has not been stolen, or, to verify that it does not have faults). + +The Diameter Identity of the EIR is locally configured in the 3GPP AAA Server and 3GPP AAA Proxy. + +This procedure is mapped to the commands ME-Identity-Check-Request/Answer (ECR/ECA) in the Diameter application specified in clause 7 of 3GPP TS 29.272 [29]. + +Table 11.1.2.1.1/1 specifies the involved information elements for the request. + +Table 11.1.2.1.1/2 specifies the involved information elements for the answer. + +**Table 11.1.2.1.1/1: ME Identity Check Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|------------------------------------|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Terminal Information | Terminal-Information | M | This information element shall contain the information about the used mobile equipment i.e. the IMEI. Within this Information Element, only the IMEI and the Software-Version AVPs shall be used on the 3GPP AAA Server/Proxy – EIR interface. | +| IMSI | User-Name (See IETF RFC 6733 [58]) | O | This information element shall contain the user IMSI, formatted according to 3GPP TS 23.003 [3], clause 2.2. | + +**Table 11.1.2.1.1/2: ME Identity Check Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-----------------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation.
The Result-Code AVP shall be used to indicate success / errors as defined in the Diameter base protocol (see IETF RFC 6733 [58]).
The Experimental-Result AVP shall be used for errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP.
The following errors are applicable in this case:
- Unknown equipment | +| Equipment Status | Equipment-Status | C | This information element shall contain the status of the requested mobile equipment as defined in 3GPP TS 22.016 [13].
It shall be present if the result of the ME Identity Check is DIAMETER_SUCCESS. | + +#### 11.1.2.1.2 3GPP AAA Server Detailed Behaviour + +The 3GPP AAA Server shall make use of this procedure to check the ME identity, if the 3GPP AAA Server is configured to check the IMEI with the EIR and if the ePDG or TWAN is in the HPLMN. + +Terminal-Information, when sent by the 3GPP AAA Server to the EIR, shall contain the IMEI AVP, and it may contain also the Software-Version AVP. + +IMSI may be sent together with Terminal Information to the EIR for operator-determined purposes. + +When receiving the ME Identity Check answer from the EIR, the 3GPP AAA Server shall check the result code and the equipment status. Dependent upon the result, the 3GPP AAA Server shall determine whether to continue or stop the authentication and authorization procedure, see clause 5.1.2.1 and 7.1.2.1. + +#### 11.1.2.1.3 3GPP AAA Proxy Detailed Behaviour + +The 3GPP AAA Proxy shall make use of this procedure to check the ME identity, if the 3GPP AAA Proxy is configured to check the IMEI with the EIR and if the ePDG or TWAN is in the VPLMN. + +Terminal-Information, when sent by the 3GPP AAA Proxy to the EIR, shall contain the IMEI AVP, and it may contain also the Software-Version AVP. + +IMSI may be sent together with Terminal Information to the EIR for operator-determined purposes. + +When receiving the ME Identity Check answer from the EIR, the 3GPP AAA Proxy shall check the result code and the equipment status. Dependent upon the result, the 3GPP AAA Server shall determine whether to continue or stop the authentication and authorization procedure, see clause 5.1.2.1 and 7.1.2.1. + +#### 11.1.2.1.4 EIR Detailed Behaviour + +See clause 6.2.1.3 of 3GPP TS 29.272 [29]. + +## 11.2 Protocol Specification + +### 11.2.1 General + +The 3GPP AAA Server/Proxy – EIR reference point shall be based on Diameter, as defined in IETF RFC 6733 [58]. It shall be defined as an IETF vendor specific Diameter application, where the vendor is 3GPP. The vendor identifier assigned by IANA to 3GPP () is 10415. + +The Diameter application used over the 3GPP AAA Server/Proxy – EIR reference point is the S13/S13' Diameter application, and the application identifier is 16777252 (allocated by IANA). + +### 11.2.2 Commands + +#### 11.2.2.1 ME Identity Check + +##### 11.2.2.1.1 ME-Identity-Check-Request (ECR) Command + +See clause 7.2.19 of 3GPP TS 29.272 [29]. + +##### 11.2.2.1.2 ME-Identity-Check-Answer (ECA) Command + +See clause 7.2.20 of 3GPP TS 29.272 [29]. + +### 11.2.3 Information Elements + +#### 11.2.3.1 General + +The following table specifies the Diameter AVPs re-used by the 3GPP AAA Server/Proxy - EIR interface protocol from existing Diameter Applications, including a reference to their respective specifications and when needed, a short description of their use for the 3GPP AAA Server/Proxy – EIR interface. + +Any other AVPs from existing Diameter Applications, except for the AVPs from Diameter Base Protocol, do not need to be supported. The AVPs from Diameter base protocol specified in IETF RFC 6733 [58] are not included in table 11.2.3.1/1, but they may be re-used for the 3GPP AAA Server/Proxy - EIR protocol. + +**Table 11.2.3.1/1: Diameter AVPs re-used for the 3GPP AAA Server/Proxy – EIR interface** + +| Attribute Name | Reference | Comments | M-bit | +|----------------------|---------------------|----------|-------| +| Terminal-Information | 3GPP TS 29.272 [29] | | | +| User-Name | IETF RFC 6733 [58] | | | +| Equipment-Status | 3GPP TS 29.272 [29] | | | + +## 11.2.4 Session Handling + +The Diameter sessions between the 3GPP AAA Server and the EIR, and between the 3GPP AAA Proxy and the EIR, shall be handled as specified for the Diameter sessions between the MME and the EIR in clause 7.1.4 of 3GPP TS 29.272 [29]. + +--- + +# Annex A (informative): Trusted WLAN authentication and authorization procedure + +## A.1 General + +This clause provides example call flows for the Trusted WLAN authentication and authorization procedure. + +Call flows for TSCM or SCM for Non-seamless WLAN Offload are not represented as they can be easily derived from the normative part of this specification. + +This Annex is informative and the normative descriptions in this specification and in 3GPP TS 33.402 [19] prevail over the descriptions in this Annex if there is any difference. + +## A.2 Call Flow for SCM and EPC-routed access + +### A.2.1 Successful call flow + +Figure Annex A.2-1 describes a successful call flow for SCM and EPC-routed access, i.e. with S2a connectivity being granted to the UE. + +![Sequence diagram of TWAN Authentication and Authorization Procedure for SCM and EPC routed access – successful case. The diagram shows interactions between UE, TWAN, PGW, 3GPP AAA Proxy (Roaming), 3GPP AAA, and HSS. The process involves 802.11 connection, EAP exchange, DER/DEA messages for authentication and authorization, and session creation.](69981c87c5b93c90e9012f6dabce4215_img.jpg) + +``` + +sequenceDiagram + participant UE + participant TWAN + participant PGW + participant 3GPP_AAA_Proxy as 3GPP AAA Proxy (Roaming) + participant 3GPP_AAA as 3GPP AAA + participant HSS + + Note right of 3GPP_AAA_Proxy: Roaming + + UE->>TWAN: 1. 802.11 Connection Established + TWAN->>UE: 2. EAP-REQ / Identity + UE->>TWAN: 3. EAP-RSP / Identity + TWAN->>3GPP_AAA: 4. DER (EAP-RSP / Identity) + 3GPP_AAA->>HSS: 5. Authentication Vector Retrieval + 3GPP_AAA->>TWAN: 6. DEA (EAP-REQ / AKA'-Challenge (modes=TSCM+SCM+MCM)) + TWAN->>UE: 7. EAP-REQ / AKA'-Challenge + UE->>TWAN: 8. EAP-RSP / AKA'-Challenge (mode=SCM, EPC/NSWO, APN, PDN Type, IMEISV...) + TWAN->>3GPP_AAA: 9. DER (EAP-RSP / AKA'-Challenge) + 3GPP_AAA->>HSS: 10. Subscriber Profile Retrieval and Registration + 3GPP_AAA->>TWAN: 11. DEA (mode=SCM, TWAN-S2a-Connectivity flag, subscription info, EPC/NSWO, APN, PDN Type, IMEISV...) + TWAN->>PGW: 12. Create Session Request / PBU + PGW->>3GPP_AAA: 13. Update PGW Address + PGW->>TWAN: 14. Create Session Response / PBA + TWAN->>3GPP_AAA: 15. DER (TWAN-S2a-Connectivity flag, APN, PDN Type ...) + 3GPP_AAA->>TWAN: 16. DEA (AKA'-Notification) + TWAN->>UE: 17. EAP-REQ / AKA'-Notification + UE->>TWAN: 18. EAP-RSP / AKA'-Notification + TWAN->>3GPP_AAA: 19. DER (EAP-RSP / AKA'-Notification) + 3GPP_AAA->>TWAN: 20. DEA (EAP-Success) + TWAN->>UE: 21. EAP-Success + +``` + +Sequence diagram of TWAN Authentication and Authorization Procedure for SCM and EPC routed access – successful case. The diagram shows interactions between UE, TWAN, PGW, 3GPP AAA Proxy (Roaming), 3GPP AAA, and HSS. The process involves 802.11 connection, EAP exchange, DER/DEA messages for authentication and authorization, and session creation. + +**Figure Annex A.2-1: TWAN Authentication and Authorization Procedure for SCM and EPC routed access – successful case** + +1. A connection is established between the UE and the TWAN, using a specific procedure based on IEEE 802.11 [40]. +2. The TWAN sends an EAP Request/Identity to the UE. +3. The UE sends an EAP Response/Identity message to the TWAN. +4. The TWAN forwards the EAP payload received from the UE to the 3GPP AAA Server and also indicates the supported TWAN connection modes in the DER message. The routing path may include one or several 3GPP AAA proxies for roaming case. +5. The 3GPP AAA Server retrieves authentication vectors for the UE from the HSS. +6. The 3GPP AAA Server sends an EAP Request/AKA'-Challenge in which it also indicates to the UE the TWAN connection modes supported by the network (e.g. TSCM, SCM and MCM) and in which it also requests the UE to provide its Mobile Equipment Identity. The Result-Code AVP in the DEA message is set to DIAMETER\_MULTI\_ROUND\_AUTH. The TWAN-S2a-Connectivity Indicator is not set in the DEA-Flags AVP. +7. The TWAN forwards the EAP payload to the UE. + +8. The UE sends the EAP Response/AKA'-Challenge in which it also indicates the requested connection mode. If the UE requests SCM and an EPC-routed access, the UE also indicates the requested APN, PDN type, Initial Attach/Handover indication and/or PCO. The user's Mobile Equipment Identity is also included, if available and if requested by the 3GPP AAA Server. +9. The TWAN forwards the EAP payload to 3GPP AAA Server. +10. If the 3GPP AAA Server successfully authenticates the UE, the 3GPP AAA Server downloads the user's subscription information from the HSS. +11. If the 3GPP AAA Server authorizes the SCM for EPC access for the UE, the 3GPP AAA Server includes the UE requested APN, PDN type, Initial Attach/Handover indication and/or PCO in the DEA message with the Result-Code AVP set to DIAMETER\_MULTI\_ROUND\_AUTH. The 3GPP AAA Server also sets the TWAN-S2a-Connectivity Indicator in the DEA-Flags AVP to request the TWAN to proceed with the establishment of the S2a connectivity. The 3GPP AAA Server also includes the user's Mobile Equipment Identity, if available. +12. The TWAN sends a Create Session Request/PBU message to the PDN GW to initiate the S2a tunnel establishment. +13. The PDN GW informs the 3GPP AAA Server/HSS of its PDN GW identity and the APN corresponding to the UE's PDN Connection. +14. The PDN GW returns a Create Session Response/PBA message to the TWAN, including the IP address(es) allocated for the UE. +15. The TWAN includes the provided Connectivity Parameters received from the PDN GW and sets the TWAN-S2a-Connectivity Indicator in the DER-Flags AVP in the DER message to the 3GPP AAA Server. The 3GPP AAA Server ignores the EAP payload included in the DER message. +16. The 3GPP AAA Server includes the PDN connectivity parameters in the AKA'-Notification and sends the DEA message to the TWAN. The Result-Code AVP in the DEA message is set to DIAMETER\_MULTI\_ROUND\_AUTH. The TWAN-S2a-Connectivity Indicator is not set in the DEA-Flags AVP. +17. The TWAN forwards the EAP payload to the UE. +- 18-19. The UE responds with an EAP-RSP/AKA'-Notification message that the TWAN forwards to the 3GPP AAA Server. +- 20-21. The 3GPP AAA Server sends an EAP Success message that the TWAN forwards to the UE. The Result-Code AVP in the DEA message is set to DIAMETER\_SUCCESS. The subscription information need not to be included in the DEA message (if not changed). + +## A.2.2 Unsuccessful call flow + +Figure Annex A.2-2 describes an unsuccessful call flow for SCM and EPC-routed access, where S2a connectivity can not be granted to the UE due to an overload condition in the network for the APN requested by the UE. + +![Sequence diagram of TWAN Authentication and Authorization Procedure for SCM and EPC routed access – UE request rejected with a Session Management back-off timer. The diagram shows interactions between UE, TWAN, PGW, 3GPP AAA Proxy (Roaming), 3GPP AAA, and HSS. The process starts with 802.11 connection establishment and EAP-REQ/Identity. The TWAN sends a DER (EAP-RSP / Identity) to the 3GPP AAA Proxy, which triggers an Authentication Vector Retrieval from the HSS. The 3GPP AAA Proxy sends a DEA (EAP-REQ / AKA'-Challenge) to the TWAN, which is forwarded to the UE. The UE responds with an EAP-RSP / AKA'-Challenge. The TWAN sends a DER (EAP-RSP / AKA'-Challenge) to the 3GPP AAA Proxy, which triggers a Subscriber Profile Retrieval and Registration from the HSS. The 3GPP AAA Proxy sends a DEA (mode=SCM, TWAN-S2a-Connectivity flag, subscription info, EPC/NSWO, APN, PDN Type, IMEISV...) to the TWAN. The TWAN sends a Create Session Request / PBU to the PGW. The PGW responds with a Create Session Response / PBA. The TWAN sends a DER (TWAN-S2a-Connectivity flag, TWAN-S2a-Failure-Cause, SM-Back-Off-Timer) to the 3GPP AAA Proxy. The 3GPP AAA Proxy sends a DEA (AKA'-Notification) to the TWAN, which is forwarded to the UE. The UE responds with an EAP-RSP / AKA'-Notification, which the TWAN forwards to the 3GPP AAA Proxy via a DER (EAP-RSP / AKA'-Notification). Finally, the 3GPP AAA Proxy sends a DEA (EAP-Failure) to the TWAN, which is forwarded to the UE as an EAP-Failure.](7c19fc92dc74a74ec346d46bc39a3946_img.jpg) + +Sequence diagram of TWAN Authentication and Authorization Procedure for SCM and EPC routed access – UE request rejected with a Session Management back-off timer. The diagram shows interactions between UE, TWAN, PGW, 3GPP AAA Proxy (Roaming), 3GPP AAA, and HSS. The process starts with 802.11 connection establishment and EAP-REQ/Identity. The TWAN sends a DER (EAP-RSP / Identity) to the 3GPP AAA Proxy, which triggers an Authentication Vector Retrieval from the HSS. The 3GPP AAA Proxy sends a DEA (EAP-REQ / AKA'-Challenge) to the TWAN, which is forwarded to the UE. The UE responds with an EAP-RSP / AKA'-Challenge. The TWAN sends a DER (EAP-RSP / AKA'-Challenge) to the 3GPP AAA Proxy, which triggers a Subscriber Profile Retrieval and Registration from the HSS. The 3GPP AAA Proxy sends a DEA (mode=SCM, TWAN-S2a-Connectivity flag, subscription info, EPC/NSWO, APN, PDN Type, IMEISV...) to the TWAN. The TWAN sends a Create Session Request / PBU to the PGW. The PGW responds with a Create Session Response / PBA. The TWAN sends a DER (TWAN-S2a-Connectivity flag, TWAN-S2a-Failure-Cause, SM-Back-Off-Timer) to the 3GPP AAA Proxy. The 3GPP AAA Proxy sends a DEA (AKA'-Notification) to the TWAN, which is forwarded to the UE. The UE responds with an EAP-RSP / AKA'-Notification, which the TWAN forwards to the 3GPP AAA Proxy via a DER (EAP-RSP / AKA'-Notification). Finally, the 3GPP AAA Proxy sends a DEA (EAP-Failure) to the TWAN, which is forwarded to the UE as an EAP-Failure. + +**Figure Annex A.2-2: TWAN Authentication and Authorization Procedure for SCM and EPC routed access – UE request rejected with a Session Management back-off timer.** + +1. to 11. Same as Figure Annex A.2-1. + +12. The TWAN sends a Create Session Request/PBU message to the PDN GW to initiate the S2a tunnel establishment, or skips this step and goes directly to step 14 if it is already aware of an overload condition for the requested APN and the UE request cannot be served by another PGW and if it decides to reject this UE request. + +13. The PDN GW rejects the UE request, possibly including overload control information. + +14. The TWAN rejects the request due to an overload condition for the APN requested by the UE. The TWAN returns the cause "insufficient resources" and provides a Session Management back-off timer to be sent to the UE. The TWAN also sets the TWAN-S2a-Connectivity Indicator in the DER-Flags AVP in the DER message to the 3GPP AAA Server. The 3GPP AAA Server ignores the EAP payload included in the DER message. + +15. The 3GPP AAA Server forwards the Session Management back-off timer received from the TWAN encapsulated in the AKA'-Notification and sends the DEA message to the TWAN. The Result-Code AVP in the DEA message is set to DIAMETER\_MULTI\_ROUND\_AUTH. The TWAN-S2a-Connectivity Indicator is not set in the DEA-Flags AVP. + +16. The TWAN forwards the EAP payload to the UE. + +17-18. The UE responds with an EAP-RSP/AKA'-Notification message that the TWAN forwards to the 3GPP AAA Server. + +19-20. The 3GPP AAA Server sends an EAP Failure message that the TWAN forwards to the UE. The *Result-Code* AVP in the DEA message is set to DIAMETER\_UNABLE\_TO\_COMPLY. + +### A.2.3 Call flow with IMEI check in VPLMN + +Figure Annex A.2-3 describes a roaming call flow for SCM and EPC-routed access, with IMEI check performed in the VPLMN. + +![Sequence diagram showing TWAN Authentication and Authorization Procedure for SCM and EPC routed access, with IMEI check performed in the VPLMN.](3f47bcff76a8105d2539569fc8909db7_img.jpg) + +``` + +sequenceDiagram + participant UE + participant TWAN + participant PGW + box "Roaming" + participant 3GPP AAA Proxy + end + participant 3GPP AAA + participant HSS + + Note over UE, TWAN: 1. 802.11 Connection Established + TWAN->>UE: 2. EAP-REQ / Identity + UE->>TWAN: 3. EAP-RSP / Identity + TWAN->>3GPP AAA Proxy: 4. DER (EAP-RSP / Identity) + Note right of 3GPP AAA Proxy: IMEI-Check-Required-In-VPLMN + 3GPP AAA Proxy->>3GPP AAA: 4. DER (EAP-RSP / Identity, IMEI-Check-Required-In-VPLMN) + 3GPP AAA->>HSS: 5. Authentication Vector Retrieval + 3GPP AAA->>3GPP AAA Proxy: 6. DEA (EAP-REQ / AKA'-Challenge (mode=TSCM+SCM+MCM)) + 3GPP AAA Proxy->>TWAN: 6. DEA (EAP-REQ / AKA'-Challenge (mode=TSCM+SCM+MCM)) + TWAN->>UE: 7. EAP-REQ / AKA'-Challenge + UE->>TWAN: 8. EAP-RSP / AKA'-Challenge (mode=SCM, EPC/NSWO, APN, PDN Type, IMEISV...) + TWAN->>3GPP AAA Proxy: 9. DER (EAP-RSP / AKA'-Challenge) + 3GPP AAA Proxy->>TWAN: 9A. DEA (IMEI-Check-Request-In-VPLMN, Terminal-Information) + TWAN->>3GPP AAA Proxy: 9B. DER (IMEI-Check-Request-In-VPLMN, Terminal-Information) + Note right of 3GPP AAA Proxy: EIR check + 3GPP AAA Proxy->>3GPP AAA: 9C. DER (IMEI-Check-In-VPLMN-Result) + 3GPP AAA->>HSS: 10. Subscriber Profile Retrieval and Registration + 3GPP AAA->>3GPP AAA Proxy: 11. DEA (mode=SCM, TWAN-S2a-Connectivity flag, subscription info, EPC/NSWO, APN, PDN Type, IMEISV...) + 3GPP AAA Proxy->>TWAN: 11. DEA (mode=SCM, TWAN-S2a-Connectivity flag, subscription info, EPC/NSWO, APN, PDN Type, IMEISV...) + TWAN->>PGW: 12. Create Session Request / PBU + PGW->>3GPP AAA: 13. Update PGW Address + PGW->>TWAN: 14. Create Session Response / PBA + TWAN->>3GPP AAA Proxy: 15. DER (TWAN-S2a-Connectivity flag, APN, PDN Type ...) + 3GPP AAA Proxy->>3GPP AAA: 15. DER (TWAN-S2a-Connectivity flag, APN, PDN Type ...) + 3GPP AAA->>3GPP AAA Proxy: 16. DEA (AKA'-Notification) + 3GPP AAA Proxy->>TWAN: 16. DEA (AKA'-Notification) + TWAN->>UE: 17. EAP-REQ / AKA'-Notification + UE->>TWAN: 18. EAP-RSP / AKA'-Notification + TWAN->>3GPP AAA Proxy: 19. DER (EAP-RSP / AKA'-Notification) + 3GPP AAA Proxy->>3GPP AAA: 19. DER (EAP-RSP / AKA'-Notification) + 3GPP AAA->>3GPP AAA Proxy: 20. DEA (EAP-Success) + 3GPP AAA Proxy->>TWAN: 20. DEA (EAP-Success) + TWAN->>UE: 21. EAP-Success + +``` + +Sequence diagram showing TWAN Authentication and Authorization Procedure for SCM and EPC routed access, with IMEI check performed in the VPLMN. + +**Figure Annex A.2-3: TWAN Authentication and Authorization Procedure for SCM and EPC routed access, with IMEI check performed in the VPLMN** + +1. to 3. Same as Figure A.2-1. + +4. If IMEI check is required by operator policy, the 3GPP AAA Proxy sets the IMEI-Check-Required-In-VPLMN bit in the DER-Flags AVP. + +5. to 9. Same as Figure A.2-1. + +9A. The 3GPP AAA Server requests the VPLMN to perform the IMEI check by setting the IMEI-Check-Request-In-VPLMN bit in the DEA-Flags AVP and including the Terminal-Information AVP in the DEA message. + +9B. The TWAN returns the IMEI-Check-Request-In-VPLMN flag in the DER-Flags AVP and the Terminal-Information AVP to the 3GPP AAA Proxy. + +9C. The 3GPP AAA Proxy performs the IMEI check in the VPLMN and forwards the DER to the 3GPP AAA Server, replacing the IMEI-Check-Request-In-VPLMN bit in the DER-Flags AVP by the IMEI-Check-In-VPLMN-Result AVP. + +10. to 21. Same as Figure A.2-1 if the IMEI check in VPLMN was successful. + +Otherwise the 3GPP AAA Server sends an EAP Failure message that the TWAN forwards to the UE. The Result-Code AVP in the DEA message is set to DIAMETER\_ERROR\_ILLEGAL\_EQUIPMENT. + +## A.3 Call Flow for MCM for EPC-routed access and/or NSWO + +### A.3.1 Successful call flow + +Figure Annex A.3-1 describes a successful call flow for MCM, for EPC-routed access and/or Non-seamless WLAN offload. + +![Sequence diagram showing the successful call flow for MCM authentication and authorization. The diagram involves six main entities: UE, TWAN, PGW, 3GPP AAA Proxy (within a Roaming domain), 3GPP AAA, and HSS. The process starts with an 802.11 connection establishment between UE and TWAN, followed by EAP-REQ/Identity and EAP-RSP/Identity exchanges. The TWAN then sends a DER (EAP-RSP / Identity) to the 3GPP AAA Proxy. The 3GPP AAA Proxy sends a DEA (EAP-REQ / AKA'-Challenge) with modes=TSCM+SCM+MCM to the 3GPP AAA. The 3GPP AAA performs Authentication Vector Retrieval from the HSS. The 3GPP AAA sends an EAP-REQ / AKA'-Challenge to the TWAN, which forwards it to the UE. The UE responds with an EAP-RSP / AKA'-Challenge (mode=MCM, IMEISV) to the TWAN, which sends a DER (EAP-RSP / AKA'-Challenge) to the 3GPP AAA Proxy. The 3GPP AAA Proxy performs Subscriber Profile Retrieval and Registration with the HSS. The 3GPP AAA Proxy sends a DEA (AKA'-Notification) to the TWAN, which forwards it to the UE. The UE responds with an EAP-RSP / AKA'-Notification to the TWAN, which sends a DER (EAP-RSP / AKA'-Notification) to the 3GPP AAA Proxy. Finally, the 3GPP AAA Proxy sends a DEA (EAP-Success, mode=MCM, subscription info, EPC/NSWO, IMEISV ...) to the TWAN, which forwards it to the UE as an EAP-Success message.](37989819a8404d835f28c204734ee90a_img.jpg) + +Sequence diagram showing the successful call flow for MCM authentication and authorization. The diagram involves six main entities: UE, TWAN, PGW, 3GPP AAA Proxy (within a Roaming domain), 3GPP AAA, and HSS. The process starts with an 802.11 connection establishment between UE and TWAN, followed by EAP-REQ/Identity and EAP-RSP/Identity exchanges. The TWAN then sends a DER (EAP-RSP / Identity) to the 3GPP AAA Proxy. The 3GPP AAA Proxy sends a DEA (EAP-REQ / AKA'-Challenge) with modes=TSCM+SCM+MCM to the 3GPP AAA. The 3GPP AAA performs Authentication Vector Retrieval from the HSS. The 3GPP AAA sends an EAP-REQ / AKA'-Challenge to the TWAN, which forwards it to the UE. The UE responds with an EAP-RSP / AKA'-Challenge (mode=MCM, IMEISV) to the TWAN, which sends a DER (EAP-RSP / AKA'-Challenge) to the 3GPP AAA Proxy. The 3GPP AAA Proxy performs Subscriber Profile Retrieval and Registration with the HSS. The 3GPP AAA Proxy sends a DEA (AKA'-Notification) to the TWAN, which forwards it to the UE. The UE responds with an EAP-RSP / AKA'-Notification to the TWAN, which sends a DER (EAP-RSP / AKA'-Notification) to the 3GPP AAA Proxy. Finally, the 3GPP AAA Proxy sends a DEA (EAP-Success, mode=MCM, subscription info, EPC/NSWO, IMEISV ...) to the TWAN, which forwards it to the UE as an EAP-Success message. + +**Figure Annex A.3-1: TWAN Authentication and Authorization Procedure for MCM – successful case** + +1. A connection is established between the UE and the TWAN, using a specific procedure based on IEEE 802.11 [40]. + +2. The TWAN sends an EAP Request/Identity to the UE. +3. The UE sends an EAP Response/Identity message to the TWAN. +4. The TWAN forwards the EAP payload received from the UE to the 3GPP AAA Server and also indicates the supported TWAN connection modes in the DER message. For MCM, the TWAN also provides the TWAG's control plane IPv4 and/or IPv6 addresses to be used by the UE for WLCP if the MCM is selected. The routing path may include one or several 3GPP AAA proxies for roaming case. +5. The 3GPP AAA Server retrieves authentication vectors for the UE from the HSS. +6. The 3GPP AAA Server sends an EAP Request/AKA'-Challenge in which it also indicates to the UE the TWAN connection modes supported by the network (e.g. TSCM, SCM and MCM) and, for MCM, the WLCP transport(s) supported by the TWAN (i.e. IPv4 and/or IPv6), and in which it also requests the UE to provide its Mobile Equipment Identity. The Result-Code AVP in the DEA message is set to DIAMETER\_MULTI\_ROUND\_AUTH. The TWAN-S2a-Connectivity Indicator is not set in the DEA-Flags AVP. +7. The TWAN forwards the EAP payload to the UE. +8. The UE sends the EAP Response/AKA'-Challenge in which it also indicates the requested connection mode. In this example, the UE requests the MCM. The user's Mobile Equipment Identity is also included, if available and if requested by the 3GPP AAA Server. +9. The TWAN forwards the EAP payload to the 3GPP AAA Server. +10. If the 3GPP AAA Server successfully authenticates the UE, the 3GPP AAA Server downloads the user's subscription information from the HSS. +11. The 3GPP AAA Server includes the information required for the MCM in the AKA'-Notification as specified in 3GPP TS 24.302[26] (e.g. NSWO authorization, TWAG control plane address) and sends the DEA message to the TWAN. The Result-Code AVP in the DEA message is set to DIAMETER\_MULTI\_ROUND\_AUTH. The TWAN-S2a-Connectivity Indicator is not set in the DEA-Flags AVP. +12. The TWAN forwards the EAP payload to the UE. +- 13-14. The UE responds with an EAP-RSP/AKA'-Notification message that the TWAN forwards to the 3GPP AAA Server. +- 15-16. The 3GPP AAA Server sends an EAP Success message that the TWAN forwards to the UE. The Result-Code AVP in the DEA message is set to DIAMETER\_SUCCESS. The DEA message also indicates to the TWAN the selected connected mode (MCM), the user's subscription information, whether the user is authorized for EPC and/or non-seamless WLAN offload, the WLCP key for WLCP signalling protection, and the user's Mobile Equipment Identity if it is available. + +Dependent on the authorizations received from the 3GPP AAA server, the UE may subsequently initiate the establishment of PDN connections to access the EPC and/or proceed with non-seamless WLAN offload. + +### A.3.2 Call flow with IMEI check in VPLMN + +Figure Annex A.3-x describes a roaming call flow for MCM, for EPC-routed access and/or Non-seamless WLAN offload, with IMEI check performed in the VPLMN. + +![Sequence diagram showing TWAN Authentication and Authorization Procedure for MCM, with an IMEI check in the VPLMN. The diagram involves UE, TWAN, PGW, 3GPP AAA Proxy, 3GPP AAA, and HSS. The 3GPP AAA Proxy is part of a Roaming domain. The procedure includes 16 steps: 1. 802.11 Connection Established; 2. EAP-REQ / Identity; 3. EAP-RSP / Identity; 4. DER (EAP-RSP / Identity) with IMEI-Check-Required-In-VPLMN flag; 5. Authentication Vector Retrieval; 6. DEA (EAP-REQ / AKA'-Challenge) with mode=TSCM+SCM+MCM; 7. EAP-REQ / AKA'-Challenge; 8. EAP-RSP / AKA'-Challenge with mode=MCM, IMEISV; 9. DER (EAP-RSP / AKA'-Challenge); 9A. DEA (IMEI-Check-Request-In-VPLMN, Terminal-Information); 9B. DER (IMEI-Check-Request-In-VPLMN, Terminal-Information); EIR check; 9C. DER (IMEI-Check-In-VPLMN-Result); 10. Subscriber Profile Retrieval and Registration; 11. DEA (AKA'-Notification); 12. EAP-REQ / AKA'-Notification; 13. EAP-RSP / AKA'-Notification; 14. DER (EAP-RSP / AKA'-Notification); 15. DEA (EAP-Success, mode=MCM, subscription info, EPC/NSWO, IMEISV ...); 16. EAP-Success.](b1a6ab9f3d33d6e8d64173bfa595b763_img.jpg) + +Sequence diagram showing TWAN Authentication and Authorization Procedure for MCM, with an IMEI check in the VPLMN. The diagram involves UE, TWAN, PGW, 3GPP AAA Proxy, 3GPP AAA, and HSS. The 3GPP AAA Proxy is part of a Roaming domain. The procedure includes 16 steps: 1. 802.11 Connection Established; 2. EAP-REQ / Identity; 3. EAP-RSP / Identity; 4. DER (EAP-RSP / Identity) with IMEI-Check-Required-In-VPLMN flag; 5. Authentication Vector Retrieval; 6. DEA (EAP-REQ / AKA'-Challenge) with mode=TSCM+SCM+MCM; 7. EAP-REQ / AKA'-Challenge; 8. EAP-RSP / AKA'-Challenge with mode=MCM, IMEISV; 9. DER (EAP-RSP / AKA'-Challenge); 9A. DEA (IMEI-Check-Request-In-VPLMN, Terminal-Information); 9B. DER (IMEI-Check-Request-In-VPLMN, Terminal-Information); EIR check; 9C. DER (IMEI-Check-In-VPLMN-Result); 10. Subscriber Profile Retrieval and Registration; 11. DEA (AKA'-Notification); 12. EAP-REQ / AKA'-Notification; 13. EAP-RSP / AKA'-Notification; 14. DER (EAP-RSP / AKA'-Notification); 15. DEA (EAP-Success, mode=MCM, subscription info, EPC/NSWO, IMEISV ...); 16. EAP-Success. + +**Figure Annex A.3-x: TWAN Authentication and Authorization Procedure for MCM, with an IMEI check in the VPLMN** + +1. to 3. Same as Figure A.3-1. + +4. If IMEI check is required by operator policy, the 3GPP AAA Proxy sets the IMEI-Check-Required-In-VPLMN bit in the DER-Flags AVP. + +5. to 9. Same as Figure A.3-1. + +9A. The 3GPP AAA Server requests the VPLMN to perform the IMEI check by setting the IMEI-Check-Request-In-VPLMN bit in the DEA-Flags AVP and including the Terminal-Information AVP in the DEA message. + +9B. The TWAN returns the IMEI-Check-Request-In-VPLMN flag in the DER-Flags AVP and the Terminal-Information AVP to the 3GPP AAA Proxy. + +9C. The 3GPP AAA Proxy performs the IMEI check in the VPLMN and forwards the DER to the 3GPP AAA Server, replacing the IMEI-Check-Request-In-VPLMN bit in the DER-Flags AVP by the IMEI-Check-In-VPLMN-Result AVP. + +10. to 16. Same as Figure A.3-1 if the IMEI check in VPLMN was successful. + +Otherwise the 3GPP AAA Server sends an EAP Failure message that the TWAN forwards to the UE. The Result-Code AVP in the DEA message is set to DIAMETER\_ERROR\_ILLEGAL\_EQUIPMENT. + +## A.4 Call Flow for TSCM and EPC-routed access + +Figure Annex A.4-1 describes a successful call flow for TSCM for EPC-routed access, i.e with S2a connectivity being granted to the UE. + +![Sequence diagram showing the TWAN Authentication and Authorization Procedure for TSCM – successful case. The diagram involves six lifelines: UE, TWAN, PGW, 3GPP AAA Proxy (within a Roaming block), 3GPP AAA, and HSS. The process starts with an 802.11 connection establishment between UE and TWAN, followed by EAP-REQ/Identity and EAP-RSP/Identity exchanges. The TWAN then sends a DER (EAP-RSP / Identity) to the 3GPP AAA Proxy. The 3GPP AAA Proxy sends an Authentication Vector Retrieval to the HSS. The HSS returns a Subscriber Profile Retrieval and Registration to the 3GPP AAA. The 3GPP AAA sends a DEA (EAP-REQ / AKA'-Challenge) to the TWAN, which forwards it to the UE as EAP-REQ / AKA'-Challenge. The UE responds with EAP-RSP / AKA'-Challenge, which the TWAN forwards to the 3GPP AAA Proxy as DER (EAP-RSP / AKA'-Challenge). The 3GPP AAA Proxy sends a DEA (EAP-Success, subscription info, EPC/NSWO ...) to the TWAN, which forwards it to the UE as EAP-Success. The TWAN then sends a Create Session Request / PBU to the PGW. The PGW sends an Update PGW Address to the 3GPP AAA. The 3GPP AAA returns a Create Session Response / PBA to the PGW, which in turn sends a Create Session Response / PBA to the TWAN. Finally, the TWAN sends an EAP-Success to the UE.](f5dc5aa74ea5482955a1e8e161b5c549_img.jpg) + +``` + +sequenceDiagram + participant UE + participant TWAN + participant PGW + subgraph Roaming + participant 3GPP AAA Proxy + end + participant 3GPP AAA + participant HSS + + Note over UE, TWAN: 1. 802.11 Connection Established + TWAN->>UE: 2. EAP-REQ / Identity + UE->>TWAN: 3. EAP-RSP / Identity + TWAN->>3GPP AAA: 4. DER (EAP-RSP / Identity) + Note over TWAN, 3GPP AAA: (via 3GPP AAA Proxy) + 3GPP AAA->>HSS: 5. Authentication Vector Retrieval + 3GPP AAA->>TWAN: 6. DEA (EAP-REQ / AKA'-Challenge (modes=TSCM+SCM+MCM)) + Note over 3GPP AAA, TWAN: (via 3GPP AAA Proxy) + TWAN->>UE: 7. EAP-REQ / AKA'-Challenge + UE->>TWAN: 8. EAP-RSP / AKA'-Challenge + TWAN->>3GPP AAA: 9. DER (EAP-RSP / AKA'-Challenge) + Note over TWAN, 3GPP AAA: (via 3GPP AAA Proxy) + 3GPP AAA->>HSS: 10. Subscriber Profile Retrieval and Registration + 3GPP AAA->>TWAN: 11. DEA (EAP-Success, subscription info, EPC/NSWO ... ) + Note over 3GPP AAA, TWAN: (via 3GPP AAA Proxy) + TWAN-->>UE: 12. EAP-Success + TWAN->>PGW: 13. Create Session Request / PBU + PGW->>3GPP AAA: 14. Update PGW Address + PGW->>TWAN: 15. Create Session Response / PBA + Note over PGW, TWAN: (via 3GPP AAA Proxy) + TWAN-->>UE: 16. EAP-Success + +``` + +Sequence diagram showing the TWAN Authentication and Authorization Procedure for TSCM – successful case. The diagram involves six lifelines: UE, TWAN, PGW, 3GPP AAA Proxy (within a Roaming block), 3GPP AAA, and HSS. The process starts with an 802.11 connection establishment between UE and TWAN, followed by EAP-REQ/Identity and EAP-RSP/Identity exchanges. The TWAN then sends a DER (EAP-RSP / Identity) to the 3GPP AAA Proxy. The 3GPP AAA Proxy sends an Authentication Vector Retrieval to the HSS. The HSS returns a Subscriber Profile Retrieval and Registration to the 3GPP AAA. The 3GPP AAA sends a DEA (EAP-REQ / AKA'-Challenge) to the TWAN, which forwards it to the UE as EAP-REQ / AKA'-Challenge. The UE responds with EAP-RSP / AKA'-Challenge, which the TWAN forwards to the 3GPP AAA Proxy as DER (EAP-RSP / AKA'-Challenge). The 3GPP AAA Proxy sends a DEA (EAP-Success, subscription info, EPC/NSWO ...) to the TWAN, which forwards it to the UE as EAP-Success. The TWAN then sends a Create Session Request / PBU to the PGW. The PGW sends an Update PGW Address to the 3GPP AAA. The 3GPP AAA returns a Create Session Response / PBA to the PGW, which in turn sends a Create Session Response / PBA to the TWAN. Finally, the TWAN sends an EAP-Success to the UE. + +**Figure Annex A.4-1: TWAN Authentication and Authorization Procedure for TSCM – successful case** + +1. A connection is established between the UE and the TWAN, using a specific procedure based on IEEE 802.11 [40]. +2. The TWAN sends an EAP Request/Identity to the UE. +3. The UE sends an EAP Response/Identity message to the TWAN. +4. The TWAN forwards the EAP payload received from the UE to the 3GPP AAA Server and also indicates the supported TWAN connection modes in the DER message. The routing path may include one or several 3GPP AAA proxies for roaming case. +5. The 3GPP AAA Server retrieves authentication vectors for the UE from the HSS. +6. The 3GPP AAA Server sends an EAP Request/AKA'-Challenge in which it also indicates to the UE the TWAN connection modes supported by the network (e.g. TSCM, SCM and MCM). The Result-Code AVP in the DEA message is set to DIAMETER\_MULTI\_ROUND\_AUTH. The TWAN-S2a-Connectivity Indicator is not set in the DEA-Flags AVP. +7. The TWAN forwards the EAP payload to the UE. +8. The UE sends the EAP Response/AKA'-Challenge. In this example, the UE does not signal any requested connection mode in that message, which indicates a request for TSCM. +9. The TWAN forwards the EAP payload to the 3GPP AAA Server. + +10. If the 3GPP AAA Server successfully authenticates the UE, the 3GPP AAA Server downloads the user's subscription information from the HSS. +11. The 3GPP AAA Server sends an EAP Success message that the TWAN forwards to the UE in step 12 or 16. The Result-Code AVP in the DEA message is set to DIAMETER\_SUCCESS. The DEA message also contains the user's subscription information, whether the user is authorized for EPC and/or non-seamless WLAN offload. The 3GPP AAA Server does not signal any selected TWAN connection mode in the DEA message, which indicates to the TWAN that TSCM is selected. +12. The TWAN forwards the EAP Success message to the UE, when using layer 3 attach trigger. +13. The TWAN sends a Create Session Request/PBU message to the PDN GW to initiate the S2a tunnel establishment (assuming EPC access has been authorized). +14. The PDN GW informs the 3GPP AAA Server/HSS of its PDN GW identity and the APN corresponding to the UE's PDN Connection. +15. The PDN GW returns a Create Session Response/PBA message to the TWAN, including the IP address(es) allocated for the UE. +16. The TWAN forwards the EAP Success message to the UE, when using layer 2 attach trigger. + +--- + +## Annex B (normative): Diameter overload control mechanism + +### B.1 General + +IETF RFC 7683 [47] specifies a Diameter overload control mechanism which includes the definition and the transfer of related AVPs between Diameter nodes. + +### B.2 SWx interface + +#### B.2.1 General + +The Diameter overload control mechanism is an optional feature over the SWx interface. + +It is recommended to make use of IETF RFC 7683 [47] on the SWx interface where, when applied, the 3GPP AAA server shall behave as a reacting node and the HSS as a reporting node. + +#### B.2.2 HSS behaviour + +The HSS requests traffic reduction from the 3GPP AAA server when it is in an overload situation, by including OC-OLR AVP in answer commands as described in IETF RFC 7683 [47]. + +The HSS identifies that it is in an overload situation by implementation specific means. For example, the HSS may take into account the traffic over the SWx interfaces or other interfaces, the level of usage of internal resources (CPU, memory), the access to external resources etc. + +The HSS determines the specific contents of the OC-OLR AVP in overload reports and the HSS decides when to send OC-OLR AVPs by implementation specific means. + +#### B.2.3 3GPP AAA server behaviour + +The 3GPP AAA server applies required traffic reduction received in answer commands to subsequent applicable requests, as per IETF RFC 7683 [47]. + +Requested traffic reduction is achieved by the 3GPP AAA server by implementation specific means. For example, it may implement message throttling with prioritization. + +The 3GPP AAA server, when requested to apply traffic reduction over the SWx interface, may request traffic reduction over the interfaces (e.g STa, SWm, S6b) towards the access nodes if the Diameter overload control mechanism is supported on these interfaces. + +Annex C gives guidance on message prioritisation over the SWx interface. + +## **B.3 STa interface** + +### **B.3.1 General** + +The Diameter overload control mechanism is an optional feature over the STa interface. + +It is recommended to make use of the IETF RFC 7683 [47] over the STa interface where, when applied, the trusted non 3GPP access network shall behave as a reacting node and the 3GPP AAA server as a reporting node. + +### **B.3.2 3GPP AAA server behaviour** + +The 3GPP AAA server requests traffic reduction from the trusted non 3GPP access network when it is in an overload situation, by including OC-OLR AVP in answer commands as described in IETF RFC 7683 [47]. + +The 3GPP AAA server identifies that it is in an overload situation by implementation specific means. For example, the 3GPP AAA server may take into account the traffic over the STa interfaces or other interfaces, the level of usage of internal resources (CPU, memory), the access to external resources etc. + +The 3GPP AAA server determines the specific contents of the OC-OLR AVP in overload reports and the 3GPP AAA server decides when to send OC-OLR AVPs by implementation specific means. + +The 3GPP AAA server, when requested to apply traffic reduction over the SWx interface, may also request traffic reduction over the STa interfaces towards the trusted access networks nodes. + +### **B.3.3 Trusted non 3GPP access network behaviour** + +The trusted non 3GPP access network applies required traffic reduction received in answer commands to subsequent applicable requests, as per IETF RFC 7683 [47]. + +Requested traffic reduction is achieved by the trusted non 3GPP access network by implementation specific means. For example, it may implement message throttling with prioritization. + +Annex C gives guidance on message prioritisation over the STa interface. + +## **B.4 S6b interface** + +### **B.4.1 General** + +The Diameter overload control mechanism is an optional feature over the S6b interface. + +It is recommended to make use of the IETF RFC 7683 [47] over the S6b interface where, when applied, the PDN-GW shall behave as a reacting node and the 3GPP AAA server as a reporting node. + +### **B.4.2 3GPP AAA server behaviour** + +The 3GPP AAA server requests traffic reduction from the PDN-GW when it is in an overload situation, by including OC-OLR AVP in answer commands, as described in IETF RFC 7683 [47]. + +The 3GPP AAA server identifies that it is in an overload situation by implementation specific means. For example, the 3GPP AAA server may take into account the traffic over the S6b interfaces and other interfaces, the level of usage of internal resources (CPU, memory), the access to external resources etc. + +The 3GPP AAA server determines the specific contents of the OC-OLR AVP in overload reports and when the 3GPP AAA server decides when to send OC-OLR AVPs by implementation specific means. + +The 3GPP AAA server, when requested to apply traffic reduction over the SWx interface, may also request traffic reduction over the S6b interfaces towards the PDN-GWs. + +### **B.4.3 PDN-GW behaviour** + +The PDN-GW applies required traffic reduction received in answer commands to subsequent applicable requests, as per IETF RFC 7683 [47]. Requested traffic reduction is achieved by the PDN-GW by implementation specific means. For example, it may implement message throttling with prioritization. + +Annex C gives guidance on message prioritisation over the S6b interface. + +## **B.5. SWa Interface** + +### **B.5.1 General** + +The Diameter overload control mechanism is an optional feature over the SWa interface. + +It is recommended to make use of the IETF RFC 7683 [47] over the SWa interface where, when applied, the untrusted non-3GPP access network shall behave as a reacting node and the 3GPP AAA server as a reporting node. + +### **B.5.2 3GPP AAA server behaviour** + +The 3GPP AAA server behaviour is the same as described in clause B.3.2 for STa by replacing: + +- trusted non 3GPP access network by untrusted non 3GPP access network; +- STa by SWa. + +### **B.5.3 untrusted non-3GPP access network behaviour** + +The untrusted non-3GPP access network behaviour is the same as described in clause B.3.3 for STa by replacing: + +- trusted non 3GPP access network by untrusted non 3GPP access network; +- STa by SWa. + +Annex C gives guidance on message prioritisation over the SWa interface. + +## **B.6 SWm Interface** + +### **B.6.1 General** + +The Diameter overload control mechanism is an optional feature over the SWm interface. + +It is recommended to make use of the IETF RFC 7683 [47] over the SWm interface where, when applied, the ePDG shall behave as a reacting node and the 3GPP AAA server as a reporting node. + +### **B.6.2 3GPP AAA server behaviour** + +The 3GPP AAA server behaviour is the same as described in clause B.3.2 for STa by replacing + +- trusted non 3GPP access network by ePDG; + +- STa by SWm. + +### B.6.3 ePDG behaviour + +The ePDG behaviour is the same as described in clause B.3.3 for STa by replacing: + +- trusted non 3GPP access network by ePDG; +- STa by SWm. + +Annex C gives guidance on message prioritisation over the SWm interface. + +--- + +## Annex C (Informative): Diameter overload control node behaviour + +### C.1 Introduction + +Annex C gives guidance on the Diameter overload control node behaviours regarding message prioritisation over non 3GPP access interfaces. + +### C.2 Message prioritization over SWx + +This clause gives an analysis of possible behaviours of the 3GPP AAA server regarding message prioritisation as guidance and for an informative purpose. + +When the HSS is overloaded, the 3GPP AAA server will receive overload reports from the HSS requesting a reduction of the requests sent by the 3GPP AAA server. This will apply to MAR and SAR requests. + +The 3GPP AAA server can consider some messages with a lower or a higher priority; lower priority messages will be candidates for throttling before higher priority messages. + +The 3GPP AAA server can take into account if it has already registered the user: + +- Diameter requests related to PDN connections for emergency services have the highest priority. Depending on regional/national requirements and network operator policy, these Diameter requests are the last to be throttled, when the 3GPP AAA Server has to apply traffic reduction; +- if the user is not already registered in the 3GPP AAA server and the user is not establishing a PDN connection for emergency services, the 3GPP AAA server gives a lower priority to the MAR command to be sent to the HSS. This will correspond to the following cases: + - the user is not registered for non 3GPP access in the HSS and is doing an attach on a non 3GPP access; + - the user is not registered for non 3GPP access in the HSS and is doing an handover from a 3GPP access; if the MAR command is throttled, the PDN connection will be then maintained in the 3GPP access; + - the user is registered in the HSS but with another 3GPP AAA server, apart a restoration case (see further), this relates to a new session. There is nevertheless a limitation for an inter RAT mobility between non 3GPP accesses when such a MAR is throttled, this is considered as acceptable; + - after a not throttled and successful MAR, the subsequent requests (SARs) have a higher priority, otherwise it would mean that the initial MAR command processed by the (overloaded) HSS has been useless. An example is the call flow described in Annex C; + - if the user is registered in the 3GPP AAA server, the 3GPP AAA server gives a higher priority to the MAR or SAR commands to be sent to the HSS as to maintain the service to the user; nevertheless, if a SAR + +indicates a PGW\_UPDATE and is related to an additional Diameter session over S6b for the user, so to establish an additional PDN connection, a lower priority may be given to this SAR; + +- in a restoration procedure due to the failure of the old 3GPP AAA server, the new 3GPP AAA server is informed of such a restoration procedure by the presence of the AAA-Failure-Indication AVP in the request received from the access. As restoration procedures may be a source of a high signalling traffic and contribute to a HSS overload, the new 3GPP AAA server may give a lower priority to such MAR messages; +- the deregistration of the user by the 3GPP AAA server has a higher priority as releasing resources in the HSS. + +## C.3 Message prioritisation over STa, SWm and SWa + +This clause gives an analysis of possible behaviours of the trusted non 3GPP access network over STa, of the untrusted non 3GPP access network over SWa and of the ePDG over SWm regarding message prioritisation as guidance and for an informative purpose. + +In the rest of the clause, a reacting node identifies: + +- a trusted non 3GPP access network over STa; +- an untrusted non 3GPP access network over SWa; +- an ePDG over SWm. + +As applying Diameter overload control over SWm and SWa may overlap, this is an operator policy to apply Diameter overload control either on SWm or on SWa or on both. + +When the 3GPP AAA server is overloaded, the reacting node will receive overload reports from the 3GPP AAA server requesting a reduction of requests sent by the reacting node. This will apply to DER, STR (and also AAR for STa and SWm) commands. + +The reacting node can consider some messages with a lower or a higher priority; lower priority messages will be candidates for throttling before higher priority messages. The reacting node can take into account the following considerations: + +- Diameter requests related to PDN connections for emergency services have the highest priority. Depending on regional/national requirements and network operator policy, these Diameter requests are the last to be throttled, when the reacting node has to apply traffic reduction; +- if the user has no existing context in the reacting node and the user is not establishing a PDN connection for emergency services, the reacting node gives a lower priority to authentication and authorisation procedures, so to DER commands. This avoids adding new users on the 3GPP AAA server. There is nevertheless a consequence in limiting an inter RAT mobility between non 3GPP accesses when such a DER is throttled, this is considered as acceptable; +- if the initial request was not throttled, the subsequent requests have a higher priority, otherwise it would mean that the initial request processed by the (overloaded) 3GPP AAA server has been useless. An example is the call flow described in Annex A.2 for STa; +- If the user has an existing context in the reacting node, new requests have a higher priority so to maintain the service to the user; +- DER Requests (and also AAR for STa) resulting from the reception of a re-authentication re-authorisation procedure (or also re-authorisation procedure over STa) from the 3GPP AAA server have a higher priority, so to maintain the service to the user; +- The trusted non 3GPP access network has the possibility (see 5.1.2.3.1 clause), at any time, to send a AAR command for check if there is any modification in the user authorization parameters previously provided by the 3GPP AAA Server. The trusted non 3GPP access network may defer such AAR requests to diminish the traffic without impacting the service to the user; +- Session termination procedures initiated by the reacting node may have a higher priority as releasing resources in the 3GPP AAA server. + +## C.4 Message prioritization over S6b + +This clause gives an analysis of possible behaviours of the PDN-GW regarding message prioritisation as guidance and for an informative purpose. + +When the 3GPP AAA server is overloaded, the PDN-GW will receive overload reports from the 3GPP AAA server requesting a reduction of requests sent by the PDN-GW. This will apply to AAR and STR commands. + +The PDN-GW can consider some messages with a lower or a higher priority; lower priority messages will be candidates for throttling before higher priority messages. + +Following considerations can be taken into account: + +- An important point to consider is that UEs accessing the PDN-GW via S2a or S2b have already been previously authorized to use the non 3GPP access (i.e. via STa or SWm or SWa). The AAR command over S6b following this initial authorisation has a higher priority, otherwise, if the AAR is throttled, it would mean that the initial authorisation procedure (and its process by the 3GPP AAA server) has been useless; +- An exception is in the Multi Connection Mode (MCM) (described in 3GPP TS 23.402 [3]), where after a first PDN connection being established, the UE requests the establishment of additional PDN connections. As the priority, when overload in the 3GPP AAA server, is to maintain the existing service in preference to setting up new services for the user, such AAR commands over S6b may have a lower priority; +- Traffic reduction over the STa or SWm or SWa interfaces with the throttling of new authentication authorisation procedures, results in diminishing requests for new PDN connections to the PDN-GW and diminishing the traffic over S6b; +- regarding the 3GPP AAA Server behaviour, it is better to request traffic reduction over the STa or SWm or SWa interfaces than over the S6b interface, so following the principle to request the traffic reduction as early and as close as possible to the traffic source (i.e. the UE); +- AAR Requests resulting from the reception of a re-authorisation procedure from the 3GPP AAA server have a higher priority, so to maintain the service to the user; +- the session termination procedures over S6b initiated by the PDN-GW resulting from a UE request may have a higher priority as releasing resources in the 3GPP AAA server. + +## Annex D (normative): Diameter message priority mechanism + +### D.1 General + +IETF RFC 7944 [53] specifies a Diameter routing message priority mechanism that allows Diameter nodes to indicate the relative priority of Diameter messages. With this information, other Diameter nodes may leverage the relative priority of Diameter messages into routing, resource allocation, set the DSCP marking for transport of the associated Diameter message, and also abatement decisions when overload control is applied. + +### D.2 SWa, STa, SWd, SWm, SWx, S6b interfaces + +The Diameter message priority mechanism is an optional feature which may apply on one or several of the SWa, STa, SWd, SWm, SWx, S6b interfaces. + +It is recommended to make use of IETF RFC 7944 [53] over the SWa, STa, SWd, SWm, SWx, S6b interfaces of an operator network when the overload control defined in Annex C is applied on these interfaces. + +A 3GPP functional entity supporting the Diameter message priority mechanism over an interface listed above shall comply with IETF RFC 7944 [53]. + +A 3GPP functional entity sending a request shall determine the required priority according to its policies. When priority is required, it shall include the DRMP AVP indicating the required priority level in the request it sends, and shall prioritise the request according to the required priority level. + +When the 3GPP functional element receives the corresponding response, it shall prioritise the received response according to the priority level received within the DRMP AVP if present in the response, otherwise according to the priority level of the corresponding request. + +When a 3GPP functional entity receives a request, it shall handle the request according to the received DRMP AVP priority level. For the response, it may modify the priority level received in the DRMP AVP according to its policies and shall handle the response according to the required priority level. If the required priority level is different from the priority level received in the request, it shall include the DRMP AVP in the response. + +If: + +- a 3GPP functional entity supports using the Diameter message priority mechanism for DSCP marking purposes, +- the transport network utilizes DSCP marking, and +- message-dependant DSCP marking is possible for the protocol stack transporting Diameter, + +then the 3GPP functional entity shall set the DSCP marking for transport of the request or response according to the required priority level. + +Diameter requests related to high priority traffic (e.g, MPS, emergency) shall contain a DRMP AVP with a high priority of which the level value is operator dependent. + +When not-explicitly requested, the inclusion and priority value of the DRMP AVP in Diameter messages are implementation specific. + +# Annex E (informative): Untrusted WLAN authentication and authorization procedure + +## E.1 General + +This clause provides example call flows for the Untrusted WLAN authentication and authorization procedure. + +This Annex is informative and the normative descriptions in this specification and in 3GPP TS 33.402 [19] prevail over the descriptions in this Annex if there is any difference. + +See clause 8.2.2 of 3GPP TS 33.402 [19] for details on the IKEv2 and EAP-AKA procedures. This clause focuses on the SWm, S6b and SWx signalling interactions. + +## E.2 Successful call flow + +Figure Annex E.2-1 describes a successful Untrusted WLAN authentication and authorization call flow. + +![Sequence diagram showing the successful Untrusted WLAN authentication and authorization procedure. Lifelines: UE, ePDG, PGW, Roaming (3GPP AAA Proxy), 3GPP AAA, HSS. The process involves IKE SA_INIT, IKE_AUTH exchanges, EAP-AKA authentication, and session creation.](81044422af6818d2bb2839b5c325d322_img.jpg) + +``` + +sequenceDiagram + participant UE + participant ePDG + participant PGW + participant Roaming as Roaming (3GPP AAA Proxy) + participant 3GPP AAA + participant HSS + + Note right of Roaming: Roaming + UE->>ePDG: 1. IKE SA_INIT + ePDG-->>UE: 2. IKE_AUTH_Request (User ID, APN, Configuration Payload) + ePDG->>3GPP AAA: 3. DER (EAP-RSP / Identity, User Identity, APN) + 3GPP AAA->>HSS: 4. Authentication Vector Retrieval + HSS-->>3GPP AAA: + 3GPP AAA->>ePDG: 5. DEA (EAP-REQ / AKA-Challenge) + ePDG-->>UE: 6. IKE_AUTH_Response (EAP-REQ / AKA-Challenge) + UE->>ePDG: 7. IKE_AUTH_Request (EAP-RSP / AKA-Challenge, IMEISV) + ePDG->>3GPP AAA: 8. DER (EAP-RSP / AKA-Challenge, Terminal-Information) + 3GPP AAA->>ePDG: 9. DEA (EAP-REQ/AKA-Notification) + ePDG-->>UE: 9. IKE_AUTH_Response (EAP-REQ / AKA-Notification) + UE-->>ePDG: 9. IKE_AUTH_Request (EAP-RSP / AKA-Notification) + ePDG-->>3GPP AAA: 9. DER (EAP-RSP/AKA-Notification) + 3GPP AAA->>HSS: 10. Subscriber Profile Retrieval and Registration + HSS-->>3GPP AAA: + 3GPP AAA->>ePDG: 11. DEA (EAP-Success, subscription info, MSK, Permanent User Identity) + ePDG-->>UE: 12. IKE_AUTH_Response (EAP-Success) + UE->>ePDG: 13. IKE_AUTH_Request (AUTH) + ePDG->>PGW: 14. Create Session Request / PBU + PGW->>3GPP AAA: 15. Update PGW Address + 3GPP AAA->>HSS: + HSS-->>3GPP AAA: + PGW-->>ePDG: 16. Create Session Response / PBA + ePDG-->>UE: 17. IKE_AUTH_Response (AUTH) + +``` + +Sequence diagram showing the successful Untrusted WLAN authentication and authorization procedure. Lifelines: UE, ePDG, PGW, Roaming (3GPP AAA Proxy), 3GPP AAA, HSS. The process involves IKE SA\_INIT, IKE\_AUTH exchanges, EAP-AKA authentication, and session creation. + +Figure Annex E.2-1: Untrusted WLAN Authentication and Authorization Procedure – successful case + +3. The ePDG sends the EAP-RSP/Identity payload to the 3GPP AAA Server and also indicates the user identity and requested APN, if received from the UE. +4. The 3GPP AAA Server retrieves authentication vectors for the UE from the HSS. +5. The 3GPP AAA Server sends an EAP Request/AKA-Challenge. +6. The ePDG forwards the EAP payload to the UE and also requests the UE to provide its Mobile Equipment Identity if required. +8. The ePDG forwards the EAP payload to the 3GPP AAA Server. The user's Mobile Equipment Identity is also included, if available. +9. If dynamic IP mobility selection is executed, the selected mobility mode is sent to the UE in an AKA-Notification request. +10. If the 3GPP AAA Server successfully authenticates the UE, the 3GPP AAA Server downloads the user's subscription information from the HSS. +11. If the 3GPP AAA Server authorizes the access for the UE, the 3GPP AAA Server sends an EAP Success message that the ePDG forwards to the UE. The Result-Code AVP in the DEA message is set to DIAMETER\_SUCCESS. The subscription information, keying material and permanent user identity are also provided to the ePDG. +14. The ePDG sends a Create Session Request/PBU message to the PDN GW to initiate the S2b tunnel establishment. +15. The PDN GW informs the 3GPP AAA Server/HSS of its PDN GW identity and the APN corresponding to the UE's PDN Connection. +16. The PDN GW returns a Create Session Response/PBA message to the ePDG, including the IP address(es) allocated for the UE. +17. The IKEv2 negotiation completes. The ePDG provides the UE IP address to the UE. + +## E.3 Call flow with IMEI check in VPLMN + +Figure Annex E.3-1 describes a roaming call flow, with IMEI check performed in the VPLMN. + +![Sequence diagram for Untrusted WLAN Authentication and Authorization Procedure, with IMEI check performed in the VPLMN. The diagram shows interactions between UE, ePDG, PGW, 3GPP AAA Proxy (in Roaming), 3GPP AAA, and HSS. The process involves IKE SA_INIT, IKE_AUTH requests and responses, DER (EAP-RSP), DEA (EAP-REQ), an EIR check for IMEI, and session creation messages.](cf734b5645d3e02a8df25f67904cd2d3_img.jpg) + +``` + +sequenceDiagram + participant UE + participant ePDG + participant PGW + participant 3GPP_AAA_Proxy as 3GPP AAA Proxy + participant 3GPP_AAA as 3GPP AAA + participant HSS + + Note right of 3GPP_AAA_Proxy: Roaming + Note right of 3GPP_AAA_Proxy: EIR check + + UE->>ePDG: 1. IKE SA_INIT + ePDG->>UE: 2. IKE_AUTH_Request (User ID, APN, Configuration Payload) + ePDG->>3GPP_AAA_Proxy: 3. DER (EAP-RSP / Identity, User Identity, APN) + 3GPP_AAA_Proxy->>3GPP_AAA: 4. Authentication Vector Retrieval + 3GPP_AAA->>3GPP_AAA_Proxy: 5. DEA (EAP-REQ / AKA-Challenge) + 3GPP_AAA_Proxy->>ePDG: 6. IKE_AUTH_Response (EAP-REQ / AKA-Challenge) + ePDG->>UE: 7. IKE_AUTH_Request (EAP-RSP / AKA-Challenge, IMEISV) + ePDG->>3GPP_AAA_Proxy: 8. DER (EAP-RSP / AKA-Challenge, Terminal-Information) + Note right of 3GPP_AAA_Proxy: EIR check + 3GPP_AAA_Proxy->>3GPP_AAA: 8'. DER (EAP-RSP / AKA-Challenge, Terminal-Information) + 3GPP_AAA->>3GPP_AAA_Proxy: 9. DEA (EAP-REQ/AKA-Notification) + 3GPP_AAA_Proxy->>ePDG: 9. IKE_AUTH_Response (EAP-REQ / AKA-Notification) + ePDG->>UE: 9. IKE_AUTH_Request (EAP-RSP / AKA-Notification) + ePDG->>3GPP_AAA_Proxy: 9. DER (EAP-RSP/AKA-Notification) + 3GPP_AAA_Proxy->>3GPP_AAA: 10. Subscriber Profile Retrieval and Registration + 3GPP_AAA->>3GPP_AAA_Proxy: 11. DEA (EAP-Success, subscription info, MSK, Permanent User Identity) + 3GPP_AAA_Proxy->>ePDG: 12. IKE_AUTH_Response (EAP-Success) + ePDG->>UE: 13. IKE_AUTH_Request (AUTH) + ePDG->>PGW: 14. Create Session Request / PBU + PGW->>3GPP_AAA_Proxy: 15. Update PGW Address + 3GPP_AAA_Proxy->>PGW: 16. Create Session Response / PBA + PGW->>ePDG: 17. IKE_AUTH_Response (AUTH) + +``` + +Sequence diagram for Untrusted WLAN Authentication and Authorization Procedure, with IMEI check performed in the VPLMN. The diagram shows interactions between UE, ePDG, PGW, 3GPP AAA Proxy (in Roaming), 3GPP AAA, and HSS. The process involves IKE SA\_INIT, IKE\_AUTH requests and responses, DER (EAP-RSP), DEA (EAP-REQ), an EIR check for IMEI, and session creation messages. + +**Figure Annex E.3-1: Untrusted WLAN Authentication and Authorization Procedure, with IMEI check performed in the VPLMN** + +1. to 5. Same as Figure E.2-1. + +6. If IMEI check is required by operator policy, the ePDG requests the UE to provide its Mobile Equipment Identity. + +7. Same as Figure E.2-1. + +8. The ePDG includes the Terminal-Information AVP in the DER command. If IMEI check is required by operator policy, the 3GPP AAA Proxy performs the IMEI check in the VPLMN. If the IMEI check allows to continue the authentication and authorization procedure, the 3GPP AAA Proxy forwards the DER to the 3GPP AAA Server (as shown in this figure). Otherwise the 3GPP AAA Proxy responds to the ePDG with the Experimental-Result-Code DIAMETER\_ERROR\_ILLEGAL\_EQUIPMENT and sends a SWm Session Termination Request towards the 3GPP AAA Server. + +9 to 17. Same as Figure E.2-1 if the IMEI check in VPLMN was successful. + +--- + +## Annex F (normative): Diameter load control mechanism + +### F.1 General + +IETF RFC 8583 [54] specifies a Diameter overload control mechanism which includes the definition and the transfer of related AVPs between Diameter nodes. + +### F.2 SWx interface + +#### F.2.1 General + +The Diameter load control mechanism is an optional feature over the SWx interface. + +It is recommended to make use of IETF RFC 8583 [54] on the SWx interface where, when applied, the 3GPP AAA server shall behave as a reacting node and the HSS as a reporting node. + +#### F.2.2 HSS behaviour + +The HSS may report its current load by including a Load AVP of type HOST in answer commands as described in IETF RFC 8583 [54]. + +The HSS calculates its current load by implementation specific means. For example, the HSS may take into account the traffic over the SWx interface or other interfaces, the level of usage of internal resources (e.g. CPU, memory), the access to external resources, etc. + +The HSS determines when to send Load AVPs of type HOST by implementation specific means. + +#### F.2.3 3GPP AAA server behaviour + +When performing next hop Diameter Agent selection for requests that are routed based on realm, the 3GPP AAA server may take into account load values from Load AVPs of type PEER received from candidate next hop Diameter nodes, as per IETF RFC 8583 [54]. + +### F.3 STa interface + +#### F.3.1 General + +The Diameter load control mechanism is an optional feature over the STa interface. + +It is recommended to make use of the IETF RFC 8583 [54] over the STa interface where, when applied, the trusted non 3GPP access network shall behave as a reacting node and the 3GPP AAA server as a reporting node. + +#### F.3.2 3GPP AAA server behaviour + +The 3GPP AAA server may report its current load by including a Load AVP of type HOST in answer commands as described in IETF RFC 8583 [54]. + +The 3GPP AAA server calculates its current load by implementation specific means. For example, the 3GPP AAA server may take into account the traffic over the STa interface or other interfaces, the level of usage of internal resources (e.g. CPU, memory), the access to external resources, etc. + +The 3GPP AAA server determines when to send Load AVPs of type HOST by implementation specific means. + +### F.3.3 Trusted non 3GPP access network behaviour + +When performing next hop Diameter Agent selection for requests that are routed based on realm, the Trusted non 3GPP access network may take into account load values from Load AVPs of type PEER received from candidate next hop Diameter nodes, as per IETF RFC 8583 [54]. + +## F.4 S6b interface + +### F.4.1 General + +The Diameter load control mechanism is an optional feature over the S6b interface. + +It is recommended to make use of the IETF RFC 8583 [54] over the S6b interface where, when applied, the PDN-GW shall behave as a reacting node and the 3GPP AAA server as a reporting node. + +### F.4.2 3GPP AAA server behaviour + +The 3GPP AAA server may report its current load by including a Load AVP of type HOST in answer commands as described in IETF RFC 8583 [54]. + +The 3GPP AAA server calculates its current load by implementation specific means. For example, the 3GPP AAA server may take into account the traffic over the S6b interface or other interfaces, the level of usage of internal resources (e.g. CPU, memory), the access to external resources, etc. + +The 3GPP AAA server determines when to send Load AVPs of type HOST by implementation specific means. + +### F.4.3 PDN-GW behaviour + +When performing next hop Diameter Agent selection for requests that are routed based on realm, the PDN-GW may take into account load values from Load AVPs of type PEER received from candidate next hop Diameter nodes, as per IETF RFC 8583 [54]. + +## F.5. SWa Interface + +### F.5.1 General + +The Diameter load control mechanism is an optional feature over the SWa interface. + +It is recommended to make use of the IETF RFC 8583 [54] over the SWa interface where, when applied, the untrusted non-3GPP access network shall behave as a reacting node and the 3GPP AAA server as a reporting node. + +### F.5.2 3GPP AAA server behaviour + +The 3GPP AAA server behaviour is the same as described in clause F.3.2 for STa by replacing: + +- trusted non 3GPP access network by untrusted non 3GPP access network; +- STa by SWa. + +### F.5.3 untrusted non-3GPP access network behaviour + +The untrusted non-3GPP access network behaviour is the same as described in clause F.3.3 for STa by replacing: + +- trusted non 3GPP access network by untrusted non 3GPP access network; +- STa by SWa. + +## F.6 SWm Interface + +### F.6.1 General + +The Diameter load control mechanism is an optional feature over the SWm interface. + +It is recommended to make use of the IETF RFC 8583 [54] over the SWm interface where, when applied, the ePDG shall behave as a reacting node and the 3GPP AAA server as a reporting node. + +### F.6.2 3GPP AAA server behaviour + +The 3GPP AAA server behaviour is the same as described in clause F.3.2 for STa by replacing + +- trusted non 3GPP access network by ePDG; +- STa by SWm. + +### F.6.3 ePDG behaviour + +The ePDG behaviour is the same as described in clause F.3.3 for STa by replacing: + +- trusted non 3GPP access network by ePDG; +- STa by SWm. + +## Annex G (informative): Change history + +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | New | +|---------|-------|-----------|------|-----|------------------------------------------------------------------|-------| +| 2008-12 | CT#42 | CP-080717 | | | V2.0.0 approved in CT#42 | 8.0.0 | +| 2009-03 | CT#43 | CP-090051 | 0002 | 2 | Clarification on QoS Resource on S6b | 8.1.0 | +| | | CP-090051 | 0003 | 1 | Context Identifier for Update or Removal of PDN GW | | +| | | CP-090051 | 0007 | - | Clarification on the S6b Authorization Procedure for DSMIPv6 | | +| | | CP-090051 | 0009 | - | Clarification on DHCPv6/IKEv2 based HA discovery | | +| | | CP-090051 | 0010 | 1 | Clarification on AAA server authentication/authorization | | +| | | CP-090051 | 0011 | 1 | Difference of S6b and H2 | | +| | | CP-090051 | 0013 | 1 | STR on HSS/AAA initiated detach over STa | | +| | | CP-090051 | 0014 | 1 | STR on 3GPP AAA Server initiated detach over SWm | | +| | | CP-090051 | 0015 | 1 | STR on 3GPP AAA Server initiated detach over S6b | | +| | | CP-090051 | 0016 | 1 | Multiple 3GPP AAA identities | | +| | | CP-090051 | 0019 | 1 | User-Name AVP contains only the IMSI | | +| | | CP-090051 | 0020 | - | Removal of APN-Barring-Type Reference | | +| | | CP-090051 | 0021 | 1 | Charging AVPs | | +| | | CP-090051 | 0022 | 1 | MIP6-Agent-Info Definition and Usage | | +| | | CP-090051 | 0023 | 1 | REAUTHENTICATION_FAILURE Correction | | +| | | CP-090051 | 0025 | 1 | Definition of Server-Assignment-Type values | | +| | | CP-090051 | 0026 | - | Multiple Occurrences of SIP-Auth-Data-Item AVP | | +| | | CP-090051 | 0028 | 1 | Using MIP6-Agent-Info for SGW address | | +| | | CP-090051 | 0029 | 1 | MIP6-Agent-Info corrections | | +| | | CP-090051 | 0030 | 1 | Trace activation in PDN GW over the SWx and S6b interfaces | | +| | | CP-090051 | 0031 | 1 | Signalling VPLMN Trust of non-3GPP AN | | +| | | CP-090051 | 0033 | - | Corrections in Visited Network Identifier definitions | | +| | | CP-090051 | 0034 | 2 | Service Authorization Information update on S6b when using DSMIP | | +| | | CP-090051 | 0035 | 4 | STa/SWa clarifications | | +| | | CP-090051 | 0036 | 1 | IP address authorization corrections | | +| | | CP-090051 | 0037 | 2 | SWm Authentication Correction | | +| | | CP-090051 | 0039 | 1 | SWm corrections - others | | +| | | CP-090051 | 0040 | 3 | SWm Service Authorization Information Update corrections | | +| | | CP-090051 | 0041 | 5 | Combined Authentication and authorization procedure on SWm | | +| | | CP-090051 | 0042 | 2 | S6b related corrections | | +| | | CP-090051 | 0044 | 2 | Corrections to S6b/HA clause 9 | | + +| | | | | | | | +|---------|-------|-----------|------|---|----------------------------------------------------------------------------|--------| +| | | CP-090039 | 0045 | 3 | User to HSS resolution | | +| | | CP-090051 | 0080 | 1 | Corrections to STR procedures for AAA_UNKNOWN_SESSION_ID | | +| | | CP-090051 | 0081 | 1 | Corrections to S6b STR procedures | | +| | | CP-090236 | 0082 | 1 | PDN GW update for Wildcard APN | | +| | | CP-090051 | 0083 | - | RFC 5447 References | | +| 2009-06 | CT#44 | CP-090289 | 0084 | 1 | Use of Access-Restriction-Data AVP | 8.2.0 | +| | | CP-090289 | 0085 | - | Difference between S6b and H2 | | +| | | CP-090289 | 0086 | 1 | Corrections to 29.273 | | +| | | CP-090289 | 0087 | 1 | Inclusion of static IP address | | +| | | CP-090289 | 0088 | 1 | Home Agent discovery | | +| | | CP-090289 | 0090 | - | Incorrect command for user profile updates | | +| | | CP-090289 | 0092 | 1 | Home Agent discovery | | +| | | CP-090289 | 0093 | 1 | Formatting of APN in Service-Selection AVP | | +| | | CP-090289 | 0094 | - | Update of AVP Codes | | +| | | CP-090289 | 0096 | 1 | STa/SWa separation correction | | +| | | CP-090289 | 0097 | - | SWa corrections | | +| | | CP-090289 | 0098 | 1 | STa re-authorization and re-authentication | | +| | | CP-090289 | 0101 | 2 | SWa re-authentication | | +| | | CP-090289 | 0102 | 1 | Adding APN-OI-Replacement | | +| | | CP-090289 | 0103 | 2 | HA reallocation clarification | | +| 2009-09 | CT#45 | CP-090537 | 0105 | 2 | Correction on APN-OI-Replacement | 8.3.0 | +| | | CP-090537 | 0106 | - | Correction on the Description of Mobility Features over S6b | | +| | | CP-090537 | 0111 | - | EAP-AKA' IETF RFC Reference | | +| | | CP-090537 | 0112 | - | Removal of Remaining Editor Notes | | +| | | CP-090537 | 0113 | 1 | MIP6_SPLIT flag removal | | +| | | CP-090537 | 0108 | 3 | Support of optimized idle mode mobility | | +| | | CP-090537 | 0115 | - | E-UTRAN - eHRPD Connectivity and Interworking Reference | | +| | | CP-090537 | 0116 | 2 | Detailed behaviour in error cases | | +| | | CP-090537 | 0118 | 1 | Application IDs | | +| | | CP-090537 | 0119 | - | Service-Selection AVP Code | | +| | | CP-090537 | 0120 | - | PDN-Type AVP | | +| | | CP-090537 | 0121 | 1 | Clarifications on PGW Handling on S6b/H2 | | +| 2009-09 | CT#45 | CP-090562 | 0117 | 1 | Emergency Support in AAA interfaces | 9.0.0 | +| 2009-12 | CT#46 | CP-090793 | 0122 | 2 | APN level APN-OI-Replacement | | +| | | CP-090774 | 0126 | 3 | Correction of Allowed PDN Types | 9.1.0 | +| | | CP-090774 | 0128 | 2 | Incorrect HSS behaviour on deregistration | | +| | | CP-090774 | 0130 | 2 | MIP6 Agent Info | | +| | | CP-090774 | 0132 | - | Nonce | | +| | | CP-090774 | 0136 | - | 3GPP AAA Server detailed behaviour at HSS Initiated Update of User Profile | | +| | | CP-090774 | 0140 | 2 | Static PDN GW | | +| | | CP-090787 | 0141 | - | Removal of Definition of APN-Configuration | | +| | | CP-090774 | 0143 | 1 | PGW deregistration via S6b | | +| | | CP-090774 | 0145 | 1 | Add Supported-Features AVP to STa/SWa | | +| | | CP-090774 | 0147 | - | Add Supported-Features AVP to SWm | | +| | | CP-090774 | 0149 | - | Add Supported-Features AVP to SWx | | +| | | CP-090774 | 0151 | - | Add Supported-Features AVP to S6b | | +| | | CP-090774 | 0153 | 1 | Correction of Application ID | | +| | | CP-090774 | 0155 | 1 | Error Handling | | +| | | CP-090774 | 0157 | - | HSS/AAA-Initiated Disconnection | | +| 2010-03 | CT#47 | CP-10024 | 0163 | 1 | Correction in Subscription-ID | 9.2.0 | +| | | CP-10024 | 0165 | - | NAI decoration and realm-based routing clarifications | | +| | | CP-10024 | 0167 | - | IETF References update | | +| | | CP-10024 | 0169 | - | Permanent User Identity | | +| | | CP-10024 | 0171 | 1 | Static PDN GW | | +| | | CP-10024 | 0173 | - | QoS AVP Codes | | +| | | CP-10024 | 0175 | - | Indication of PLMN ID of the selected PGW | | +| | | CP-10044 | 0176 | - | Context-Identifier in Registration Request | | +| 2010-06 | CT#48 | CP-100290 | 0179 | 1 | Corrections on Session Termination between the PGW and the AAA | 9.3.0 | +| | | CP-100277 | 0180 | - | Corrections to implementation of CR 128 and CR 175 | | +| | | CP-100277 | 0181 | - | PGW Identity upon successful authorization on SWm | | +| 2010-06 | CT#48 | CP-100443 | 0184 | - | Ambiguity of Presence Conditions of IEs and AVP ABNF | 9.4.0 | +| | | CP-100457 | 0188 | - | IETF References | | +| | | CP-100457 | 0189 | 1 | SWm missing AVPs | | +| 2010-09 | CT#49 | CP-100603 | 0187 | 1 | Removal of Invalid Reference | 10.0.0 | +| 2010-12 | CT#50 | CP-100679 | 0197 | 1 | Correcting PDN GW behaviour for S6b | 10.1.0 | +| | | CP-100698 | 0194 | 1 | Update APN and PDN GW in the 3GPP AAA Server on SWx | | +| | | CP-100698 | 0195 | 1 | Update APN and PDN GW in Non-3GPP IP Access over the STa & SWm interfaces | | +| | | CP-100686 | 0196 | 3 | SWm and S6b procedures for GTP based S2b | | + +| | | | | | | | +|---------|-------|-----------|------|---|------------------------------------------------------------------------|--------| +| | | CP-100707 | 0200 | - | MIP6 Feature Vector flags assignment | | +| | | CP-100707 | 0203 | - | SWx AVP Bits Definition | | +| | | CP-100707 | 0206 | - | Visited-Network-Identifier Data Type | | +| 2011-03 | CT#51 | CP-110051 | 0210 | 1 | Usage of Auth-Request-Type in response messages | 10.2.0 | +| | | CP-110073 | 0208 | 2 | Correction on PGW PLMN ID | | +| 2011-06 | CT#52 | CP-110359 | 0214 | 1 | Trace-Depth-List correction | 10.3.0 | +| | | CP-110359 | 0217 | 1 | MIPv4 security parameters on the STa and S6b interfaces | | +| | | CP-110359 | 0221 | 1 | PGW Update | | +| | | CP-110359 | 0223 | 1 | APN Configuration for SWx | | +| | | CP-110360 | 0219 | - | Authentication Timeout | | +| 2011-12 | CT#54 | CP-110778 | 0227 | 1 | S6b session handling after handover to 3GPP access | 10.4.0 | +| | | CP-110778 | 0235 | 1 | Incorrect access name on SWa | | +| | | CP-110793 | 0228 | 5 | Correction on Trust Relationship Indication | | +| | | CP-110793 | 0238 | - | Implementation Error of CR 196 R3 | | +| 2011-12 | CT#54 | CP-110812 | 0225 | 4 | SWx Restoration | 11.0.0 | +| 2012-03 | CT#55 | CP-120016 | 0257 | 1 | Wrong Command Code in STa AA-Answer | 11.1.0 | +| | | CP-120020 | 0251 | 2 | Authorize the requested home address types | | +| | | CP-120020 | 0260 | - | Content of Service-Selection AVP | | +| | | CP-120040 | 0245 | 1 | Wildcard APN in the user subscription | | +| | | CP-120040 | 0253 | - | Permanent User Identity in SWm Authentication and Authorization Answer | | +| | | CP-120040 | 0255 | - | Encoding of Visited-Network-Identifier AVP | | +| | | CP-120040 | 0256 | - | Re-Authorization Errors | | +| | | CP-120042 | 0254 | 1 | Permanent User Identity at SWa | | +| | | CP-120044 | 0240 | 1 | PDN GW reallocation based on UE's location | | +| 2012-06 | CT#56 | CP-120225 | 0243 | 3 | Trust Relationship Indication | 11.2.0 | +| | | CP-120238 | 0264 | - | S6b procedures for GTP based S2a | | +| | | CP-120247 | 0265 | 2 | Missing IE in TS 29.273 | | +| | | CP-120247 | 0266 | - | Emergency scenario for STa interface | | +| | | CP-120247 | 0267 | 2 | Visited Network Identifier | | +| | | CP-120247 | 0278 | 1 | Network Name | | +| | | CP-120238 | 0268 | 6 | STa & SWd procedures for GTP S2a & Trusted WLAN access | | +| | | CP-120238 | 0269 | 1 | Default APN for 'Trusted WLAN access' | | +| | | CP-120238 | 0270 | 3 | Informing Serving SSID to the AAA Server | | +| | | CP-120238 | 0271 | 1 | Avoiding registration of PDN-GW identity for TWAN | | +| | | CP-120238 | 0275 | 1 | Clarifications on TWAN behaviour | | +| | | CP-120237 | 0273 | 2 | PDN GW selection for S2c during tunnel establishment | | +| 2012-09 | CT#57 | CP-120441 | 0285 | - | Update of IETF draft status to RFC | 11.3.0 | +| | | CP-120447 | 0287 | 2 | PGW selection in eHRPD for SIPTO | | +| | | CP-120461 | 0272 | 3 | Recovering from AAA Server failure | | +| | | CP-120474 | 0279 | 1 | Transport Access Type AVP for BBAI | | +| | | CP-120477 | 0280 | 1 | NSWO-Capability & NSWO-Authorization AVPs | | +| | | CP-120477 | 0281 | - | Access Type for TWAN access | | +| | | CP-120656 | 0292 | 1 | Reference list correction to align with the corrected TS 29.212 title | | +| 2012-12 | CT#58 | CP-120711 | 0307 | 1 | Removal of AVP Encryption | 11.4.0 | +| | | CP-120733 | 0293 | - | Repeat information for Trusted non-3GPP access network | | +| | | CP-120733 | 0300 | 5 | Matching WLAN-ID between Selected WLAN ID and TWAN Access Info | | +| | | CP-120733 | 0301 | 1 | Update of draft-ietf-radext-ieee802ext reference | | +| | | CP-120747 | 0294 | - | Correction on Auth-Request-Type | | +| | | CP-120747 | 0295 | - | Description of Result IE | | +| | | CP-120728 | 0297 | 2 | Information Elements for SWa interface | | +| | | CP-120728 | 0299 | 1 | Session ID in the SWm Authorization procedure | | +| | | CP-120750 | 0302 | 1 | Trace Info for PGW | | +| | | CP-120750 | 0303 | 1 | Add the definition of trace-reference | | +| 2013-03 | CT#59 | CP-120741 | 0309 | 2 | Use of Flag instead of Enumerated AVPs | | +| | | CP-130022 | 0314 | 2 | About EAP-AKA' challenge message | 11.5.0 | +| | | CP-130022 | 0315 | 1 | TWAN Authorization when HE-SSID is not provided | | +| | | CP-130022 | 0317 | - | Missing P-Bit settings in Information Element tables | | +| 2013-06 | CT#60 | CP-130022 | 0316 | - | Presence condition of PGW-ID AVP in S6b AAR command | 11.6.0 | +| | | CP-130288 | 0313 | 3 | New DER-S6b-flags on S6b interface | | +| | | CP-130288 | 0325 | 1 | MIP4 supported flag | | +| | | CP-130288 | 0323 | 1 | 3GPP AAA Proxy behavior | | +| | | CP-130288 | 0321 | 1 | Definition of HA-APN | | +| | | CP-130288 | 0320 | 2 | Trust relationship for PGW | | +| 2013-06 | CT#60 | CP-130293 | 0318 | 2 | UE local IP address for SWm or S6b | | +| | | CP-130381 | 0326 | 1 | EAP-AKA clarification | 12.0.0 | +| 2013-09 | CT#61 | CP-130381 | 0319 | 2 | Clarification for Routing Policies | | +| | | CP-130459 | 0333 | 1 | Category of Authentication Data Information Element in SWx/MAR command | 12.1.0 | +| | | CP-130472 | 0329 | 2 | Add 3GPP AAA Proxy detailed Behaviour on SWa | | + +| | | | | | | | +|---------------|--|-----------|------|---|-------------------------------------------------------------------------------------------------------------|--------| +| | | CP-130472 | 0331 | 1 | Correction on IP Mobility Mode Selection function | | +| | | CP-130461 | 0327 | 2 | Clarification on provision of HA information for DHCP-based HA discovery on STa | | +| | | CP-130461 | 0332 | - | Applicability of IP Filters and Routing Policies functionality on EPC | | +| 2013-12 CT#62 | | CP-130602 | 0351 | - | EAP Payload | 12.2.0 | +| | | CP-130640 | 0338 | - | Clarification on Trust Relationship Indicator | | +| | | CP-130640 | 0339 | 1 | MIP6-Agent-Info over the S6b interface | | +| | | CP-130640 | 0346 | - | Clarification of M-bit handling | | +| | | CP-130640 | 0354 | 1 | Reflective QoS for BBF convergence | | +| | | CP-130606 | 0341 | - | IMSI for BBF in trusted S2c case | | +| | | CP-130616 | 0343 | 4 | NSWO via the trusted WLAN | | +| | | CP-130616 | 0345 | 1 | VPLMN trust relationship indicator | | +| | | CP-130616 | 0356 | 1 | EPC Access Authorization | | +| | | CP-130633 | 0353 | 1 | PGW update on SWx | | +| 2014-03 CT#63 | | CP-140023 | 0366 | 1 | Replacement of IETF WLAN AVPs | 12.3.0 | +| | | CP-140033 | 0361 | - | Incorrect Diameter commands | | +| | | CP-140033 | 0363 | 1 | Condition for sending APN Information | | +| | | CP-140030 | 0364 | 1 | Retrieval of Network Provided Location Information via HSS | | +| 2014-06 CT#64 | | CP-140033 | 0367 | - | RAT Type correction | 12.4.0 | +| | | CP-140247 | 0368 | - | STa Authentication for Trusted WLAN access | | +| | | CP-140253 | 0369 | 4 | IMSI for BBF convergence | | +| | | CP-140253 | 0370 | 1 | Reflective QoS in BBF architecture | | +| | | CP-140252 | 0373 | 2 | Civic Address Encoding | | +| | | CP-140252 | 0377 | - | TWAN-BSSID AVP re-naming | | +| | | CP-140243 | 0374 | 3 | Diameter overload over SWx | | +| 2014-09 CT#65 | | CP-140243 | 0375 | 3 | Diameter overload over STa and S6b | 12.5.0 | +| | | CP-140510 | 0379 | 2 | Session Management back-off timer for UE in Single-Connection mode | | +| | | CP-140516 | 0381 | 2 | Remove TS 23.234 from TS 29.273 | | +| | | CP-140516 | 0382 | 1 | Remove TS 29.234 from TS 29.273 | | +| 2014-12 CT#66 | | CP-140519 | 0383 | 1 | Circuit ID in NetLoc-TWLAN | 12.6.0 | +| | | CP-140771 | 0385 | - | Correct wrong references to 3GPP specifications that define Diameter experimental result codes 5001 to 5005 | | +| | | CP-140771 | 0397 | 3 | Restricted RAT Types | | +| | | CP-140784 | 0386 | 1 | WLCP key for WLCP signalling protection | | +| | | CP-140784 | 0387 | 1 | TWAN authentication and authorization call flows for MCM and TSCM | | +| | | CP-140784 | 0398 | 1 | Back-off timer refers to Tw1 | | +| | | CP-140790 | 0389 | 3 | Diameter Overload over SWm and SWa | | +| | | CP-140754 | 0394 | 2 | Leading Digit of User-Name AVP | | +| 2015-03 CT#67 | | CP-140757 | 0396 | - | Incorrect implementation of CR on EAP-Payload | 12.7.0 | +| | | CP-150021 | 0401 | 1 | Usage of decorated NAI | | +| 2015-06 CT#68 | | CP-150021 | 0404 | 1 | Clarification of user de-registration | 12.8.0 | +| | | CP-150276 | 0416 | 1 | Correction of the type of the Redirect-Host AVP | | +| 2015-06 | | CP-150250 | 0407 | - | Repeated SWm session for default APN | 12.8.1 | +| 2015-06 CT#68 | | | | | Implemented Rel-13 CRs removed (0410r1, 0417r1, 0418r1, 0405r1) | 13.0.0 | +| | | CP-150268 | 0410 | 1 | The value of SM-Back-Off-Timer | | +| | | CP-150268 | 0417 | 1 | Clarification on the S6b Service Authorization Information Update procedure for DSMIPv6 | | +| | | CP-150268 | 0418 | 1 | Removing EPC before Root NAI | | +| 2015-09 CT#68 | | CP-150268 | 0405 | 1 | PDN GW Identity | 13.1.0 | +| | | CP-150455 | 0422 | 1 | IMEI(SV) signalling for untrusted WLAN access | | +| | | CP-150455 | 0423 | 2 | IMEI(SV) signalling for trusted WLAN access | | +| | | CP-150455 | 0424 | 1 | IMEI(SV) signalling during Non-3GPP IP Access Registration | | +| | | CP-150442 | 0425 | 1 | 3GPP AAA Server sends an ASR command to clean up possible hanging resources | | +| | | CP-150442 | 0426 | 3 | Overlapping transaction over S6b | | +| | | CP-150451 | 0427 | 1 | Default access type for SCM | | +| 2015-12 CT#70 | | CP-150447 | 0428 | - | Reference to a wrong clause in TS 23.008 | 13.2.0 | +| | | CP-150770 | 0429 | 5 | Emergency PDN connection over untrusted WLAN access | | +| | | CP-150770 | 0430 | 3 | Network provided WLAN Location Information for PDN connection establishment over S2b | | +| | | CP-150764 | 0431 | 1 | UE local IP address in Authentication and Authorization Request over SWm | | +| | | CP-150780 | 0433 | 3 | P-CSCF Restoration for WLAN over SWx | | +| | | CP-150780 | 0434 | 5 | Authorisation procedure with the extended P-CSCF restoration mechanism for WLAN | | +| | | CP-150787 | 0435 | - | Transfer of IMEI from 3GPP AAA Server to HSS over SWx | | +| | | CP-150773 | 0436 | 3 | Multiple accesses to a PDN connection not allowed for SCM | | +| | | CP-150748 | 0438 | - | Visited-Network-Identifier for untrusted WLAN | | + +| | | | | | | | +|---------|--------|-----------|------|---|----------------------------------------------------------------------------------------|--------| +| | | CP-150748 | 0443 | 2 | Blocking TWAN access to EPC | | +| | | CP-150782 | 0439 | 1 | Handling of S6b Authorization Request without Origination Timestamp | | +| | | CP-150846 | 0440 | 4 | Diameter message priority over non 3GPP access | | +| | | CP-150759 | 0444 | 1 | Reference to DOIC updated with IETF RFC 7683 | | +| 2016-03 | CT#71 | CP-160035 | 0446 | - | Remove the default access AVP | 13.3.0 | +| | | CP-160042 | 0447 | - | Extension on TWAN-S2a-Failure-Cause | | +| | | CP-160042 | 0448 | 1 | Authorize the UE requested APN | | +| | | CP-160037 | 0449 | - | Correction of CR implementation on Emergency PDN connection over untrusted WLAN access | | +| | | CP-160037 | 0450 | 1 | ePDG retrieval of WLAN Location Information | | +| | | CP-160153 | 0452 | 2 | Result-Codes for P-CSCF Restoration | | +| 2016-06 | CT#72 | CP-160220 | 0453 | 1 | RAT type not allowed | 13.4.0 | +| 2016-06 | CT#72 | CP-160220 | 0454 | 1 | Wildcard APN for SWx and S6b | 13.4.0 | +| 2016-06 | CT#72 | CP-160220 | 0455 | 2 | Clarification on the use of SAR message when AAA has no profile | 13.4.0 | +| 2016-06 | CT#72 | CP-160220 | 0456 | 1 | Wildcard authorized APN in TWAN | 13.4.0 | +| 2016-06 | CT#72 | CP-160220 | 0457 | 2 | APN information over S6b | 13.4.0 | +| 2016-06 | CT#72 | CP-160231 | 0458 | - | Removal of NBIFOM reference | 13.4.0 | +| 2016-06 | CT#72 | CP-160223 | 0459 | 2 | Incorrect usage of term "Untrusted WLAN" when RAT type is not known | 13.4.0 | +| 2016-09 | CT#73 | CP-160418 | 0463 | - | APN subscription check in the STa authentication and authorization procedure | 13.5.0 | +| 2016-09 | CT#73 | CP-160418 | 0465 | 1 | Transferring AAA identifier from the ePDG/TWAN to the PGW | 13.5.0 | +| 2016-09 | CT#73 | CP-160436 | 0461 | 1 | 3GPP AAA Server/Proxy – EIR reference point | 14.0.0 | +| 2016-09 | CT#73 | CP-160436 | 0462 | 2 | STa and SWm extensions for IMEI check | 14.0.0 | +| 2016-12 | CT#74 | CP-160674 | 0466 | 2 | Destination-Host correction on STa & SWm | 14.1.0 | +| 2016-12 | CT#74 | CP-160674 | | | 3GPP AAA Server behaviour in the user profile updated procedure | 14.1.0 | +| 2016-12 | CT#74 | CP-160674 | 0489 | 1 | Handling of Undefined bit in DER-Flags | 14.1.0 | +| 2016-12 | CT#74 | CP-160679 | 0468 | 4 | Handover of Emergency PDN Connections | 14.1.0 | +| 2016-12 | CT#74 | CP-160679 | 0471 | 1 | IMEI check for Emergency Attach over WLAN | 14.1.0 | +| 2016-12 | CT#74 | CP-160679 | 0473 | 1 | Emergency services over untrusted WLAN for unauthenticated or unauthorized UEs | 14.1.0 | +| 2016-12 | CT#74 | CP-160679 | 0474 | 2 | Support of Emergency sessions over Trusted WLAN | 14.1.0 | +| 2016-12 | CT#74 | CP-160682 | 0469 | 1 | Missing IMEI-Check-In-VPLMN-Result AVP | 14.1.0 | +| 2016-12 | CT#74 | CP-160682 | 0477 | 1 | IMEI check call flow for untrusted WLAN | 14.1.0 | +| 2016-12 | CT#74 | CP-160657 | 0476 | 1 | APN-Configuration AVP format for Non-3GPP accesses | 14.1.0 | +| 2016-12 | CT#74 | CP-160681 | 0484 | 2 | Load Control | 14.1.0 | +| 2016-12 | CT#74 | CP-160653 | 0486 | - | Renaming of Emergency-Indication AVP | 14.1.0 | +| 2016-12 | CT#74 | CP-160664 | 0491 | - | Correction to change IETF drmp draft version to official RFC 7944 | 14.1.0 | +| 2016-12 | CT#74 | CP-160651 | 0492 | - | Discontinuation of the I-WLAN feature | 14.1.0 | +| 2017-03 | CT#75 | CP-170050 | 0493 | 1 | DIAMETER_ERROR_ILLEGAL_EQUIPMENT code | 14.2.0 | +| 2017-03 | CT#75 | CP-170044 | 0494 | 1 | Emergency-Info AVP in Non-3GPP IP Access Registration response | 14.2.0 | +| 2017-03 | CT#75 | CP-170049 | 0495 | 1 | Addition of ERP support for TWAN Interworking | 14.2.0 | +| 2017-03 | CT#75 | CP-170037 | 0496 | 1 | Bit ordering in Diameter AVPs used as bit-masks | 14.2.0 | +| 2017-03 | CT#75 | CP-170037 | 0497 | 1 | Handling of AAA Failure Indication over SWa | 14.2.0 | +| 2017-03 | CT#75 | CP-170037 | 0498 | 1 | SWm Behaviour after Failed Re-Authorization | 14.2.0 | +| 2017-03 | CT#75 | CP-170048 | 0499 | 1 | Update of reference for the Diameter base protocol | 14.2.0 | +| 2017-03 | CT#75 | CP-170048 | 0500 | 1 | Handling of the Vendor-Specific-Application-Id | 14.2.0 | +| 2017-06 | CT#76 | CP-171033 | 0466 | 1 | NAI for emergency services over WLAN access to EPC | 14.3.0 | +| 2017-06 | CT#76 | CP-171018 | 0503 | 1 | Support for signaling transport level packet marking | 14.3.0 | +| 2017-06 | CT#76 | CP-171035 | 0505 | 1 | Only ERP Implicit Bootstrapping mode is supported in Rel-14 | 14.3.0 | +| 2017-06 | CT#76 | CP-171042 | 0507 | - | Definition of Origination-Time-Stamp AVP | 14.3.0 | +| 2017-09 | CT#77 | CP-172019 | 0509 | 1 | Emergency sessions over untrusted WLAN with an unauthenticated IMSI | 14.4.0 | +| 2017-09 | CT#77 | CP-172015 | 0511 | - | PGW selection for WLAN with deployed DCNs | 14.4.0 | +| 2017-09 | CT#77 | CP-172013 | 0514 | - | Correction of DRMP Procedures | 14.4.0 | +| 2017-09 | CT#77 | CP-172023 | 0508 | - | MIP6-Feature-Vector over SWx | 15.0.0 | +| 2017-09 | CT#77 | CP-172023 | 0512 | 3 | External-ID in non-3GPP subscription profile | 15.0.0 | +| 2017-12 | CT#78 | CP-173026 | 0515 | - | Authorization procedure initiated by ePDG | 15.1.0 | +| 2018-06 | CT#80 | CP-181123 | 0518 | - | Full-Network-Name and Short-Network-Name AVPs | 15.2.0 | +| 2019-03 | CT#83 | CP-190032 | 0519 | 1 | Mobility between EPC/ePDG and 5GS | 15.3.0 | +| 2019-09 | CT#85 | CP-192094 | 0521 | 2 | draft-ietf-dime-load published as RFC 8583 | 15.4.0 | +| 2020-03 | CT#87e | CP-200047 | 0522 | - | APN-OI-Replacement not applicable for Emergency services | 16.0.0 | +| 2020-06 | CT#88e | CP-201053 | 0523 | - | APN-OI-Replacement | 16.1.0 | +| 2020-09 | CT#89e | CP-202043 | 0525 | 1 | AAA Deregistration | 16.2.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29275/13345bf381e6bb956d897e5791dfae18_img.jpg b/marked/Rel-16/29_series/29275/13345bf381e6bb956d897e5791dfae18_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c52a7a1bd7db1531438c1e19e48fa934e172f5f3 --- /dev/null +++ b/marked/Rel-16/29_series/29275/13345bf381e6bb956d897e5791dfae18_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:480af21d3f9a4366231cc7a1f0403b3db529904c97d71b2ba662b46cca03b1b3 +size 7668 diff --git a/marked/Rel-16/29_series/29275/13dbd16a58861b335d8e10047ae8e524_img.jpg b/marked/Rel-16/29_series/29275/13dbd16a58861b335d8e10047ae8e524_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2ca1b6985c91acab000bfc2c856baf9c3e8d9901 --- /dev/null +++ b/marked/Rel-16/29_series/29275/13dbd16a58861b335d8e10047ae8e524_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:44a0d8ffcfedb43f7ee94a5f4c9517537eb665a74d4a4caee496df0e0c533261 +size 7552 diff --git a/marked/Rel-16/29_series/29275/1e5a58dcaf0936bf18dc3dd0d9cd43ff_img.jpg b/marked/Rel-16/29_series/29275/1e5a58dcaf0936bf18dc3dd0d9cd43ff_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f6e0b8d1fc2c4c1ece343396a613d4a22136e132 --- /dev/null +++ b/marked/Rel-16/29_series/29275/1e5a58dcaf0936bf18dc3dd0d9cd43ff_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:52275312dd44a8143064c54e488e8a9cbc5708da01a52e253ff98bcaa2173240 +size 12936 diff --git a/marked/Rel-16/29_series/29275/2b3464c6315594e2fa8b84d72cff2cd2_img.jpg b/marked/Rel-16/29_series/29275/2b3464c6315594e2fa8b84d72cff2cd2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..17b5d06c593c99ffb55dad53d6fe9aa8a003580f --- /dev/null +++ b/marked/Rel-16/29_series/29275/2b3464c6315594e2fa8b84d72cff2cd2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:338caf3d69265431d3801f567332ba236a1ecd3485e94bdce1cd09ba24d36d1b +size 29117 diff --git a/marked/Rel-16/29_series/29275/3750b0149a6380885998ab3ca6a8787c_img.jpg b/marked/Rel-16/29_series/29275/3750b0149a6380885998ab3ca6a8787c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..cb9f71dd6c4998df7e3108f2212de6eaffe39b87 --- /dev/null +++ b/marked/Rel-16/29_series/29275/3750b0149a6380885998ab3ca6a8787c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1ec6c9d418edc55885cf5827be43e9dab7976093444e634768daedafb18cdef3 +size 6835 diff --git a/marked/Rel-16/29_series/29275/38d82ffe820e339811b396206f40a201_img.jpg b/marked/Rel-16/29_series/29275/38d82ffe820e339811b396206f40a201_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9fc933de342558e202b86d3f6e5d46c32415c9e0 --- /dev/null +++ b/marked/Rel-16/29_series/29275/38d82ffe820e339811b396206f40a201_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2c757830eae73ce6ce5f8253199a2fccf555633cbcb42e4c1f0c9692a1fcb14b +size 8315 diff --git a/marked/Rel-16/29_series/29275/665db9e4c084c517dc46f23397c8533a_img.jpg b/marked/Rel-16/29_series/29275/665db9e4c084c517dc46f23397c8533a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ea6e0253bc961566cff67f2b157e8207859606d2 --- /dev/null +++ b/marked/Rel-16/29_series/29275/665db9e4c084c517dc46f23397c8533a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bc44b2d917aaef69ad3fe0979eb8f7ceb1c410e12b3b0dd80822c6aca685fa27 +size 6980 diff --git a/marked/Rel-16/29_series/29275/a363e069a25ec09f106b2f5609adecba_img.jpg b/marked/Rel-16/29_series/29275/a363e069a25ec09f106b2f5609adecba_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..cebd420f02d72011ba9dc0edfa1c471fb9ac0c46 --- /dev/null +++ b/marked/Rel-16/29_series/29275/a363e069a25ec09f106b2f5609adecba_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3eca84b383a459faeffac93bc815098a380b7afc62061c99f4dc0d8739cf6462 +size 13502 diff --git a/marked/Rel-16/29_series/29275/b1e7bb95fa1587d870de03df02477df4_img.jpg b/marked/Rel-16/29_series/29275/b1e7bb95fa1587d870de03df02477df4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a7e677e00ee769991077b8ca7a0a925ea2e2e84d --- /dev/null +++ b/marked/Rel-16/29_series/29275/b1e7bb95fa1587d870de03df02477df4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:590e76c8bb49a6b27030f42a8dadd50e1501a849397da5c1fb15cd219bfa6657 +size 7714 diff --git a/marked/Rel-16/29_series/29275/b22a2b17c5f35e4706033e34ab0f3e9a_img.jpg b/marked/Rel-16/29_series/29275/b22a2b17c5f35e4706033e34ab0f3e9a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..fb83910acb65e06c553c52d3313a130c21c73365 --- /dev/null +++ b/marked/Rel-16/29_series/29275/b22a2b17c5f35e4706033e34ab0f3e9a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:814e62fb932bea9d1ff3994c3cbe93c31194f0a0a8ce7da18930d1164511dbb5 +size 8274 diff --git a/marked/Rel-16/29_series/29275/b9ccd94b9abd3bca5576d3cb09c4a8e5_img.jpg b/marked/Rel-16/29_series/29275/b9ccd94b9abd3bca5576d3cb09c4a8e5_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..be9f2fa880bae10895c48e82657d2efcfca1a913 --- /dev/null +++ b/marked/Rel-16/29_series/29275/b9ccd94b9abd3bca5576d3cb09c4a8e5_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0515375eef87fd4d513b9f846e8958e71253a0e54257865455331be34e9b5209 +size 11939 diff --git a/marked/Rel-16/29_series/29275/c020c072c67473d7823d1f9551942732_img.jpg b/marked/Rel-16/29_series/29275/c020c072c67473d7823d1f9551942732_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..88b8b97db8056433b64a479c024dbf31e72f8ad3 --- /dev/null +++ b/marked/Rel-16/29_series/29275/c020c072c67473d7823d1f9551942732_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:79b2e9fb179e5073def8d6a6f26a9e87e2ffebc32604960e36ea6f1f87cf3c2e +size 6445 diff --git a/marked/Rel-16/29_series/29275/c036e2540a94b31357ceb0002f0cacab_img.jpg b/marked/Rel-16/29_series/29275/c036e2540a94b31357ceb0002f0cacab_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4a4df1f0176b27933bca466010c92b7f4c90d063 --- /dev/null +++ b/marked/Rel-16/29_series/29275/c036e2540a94b31357ceb0002f0cacab_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7b239b7c09898d9516adc585e01231a2992b267e3e1bceb6ff780fd511ce62ef +size 45148 diff --git a/marked/Rel-16/29_series/29275/cc3d87694102054bcd694ae696bc41fa_img.jpg b/marked/Rel-16/29_series/29275/cc3d87694102054bcd694ae696bc41fa_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..abde25ca94b53eeda26e4a01fd53e63dc22df1e8 --- /dev/null +++ b/marked/Rel-16/29_series/29275/cc3d87694102054bcd694ae696bc41fa_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:44233b718d2e496804442f747d3b05bd4e138cd5b301ad40bf92f4c027041f1d +size 19292 diff --git a/marked/Rel-16/29_series/29275/d47e75401a5155ebc965d8aa004861a2_img.jpg b/marked/Rel-16/29_series/29275/d47e75401a5155ebc965d8aa004861a2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0ce49bbc7bef19293e5cb34d66dfd9794edeb7e0 --- /dev/null +++ b/marked/Rel-16/29_series/29275/d47e75401a5155ebc965d8aa004861a2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e1d7b1ccab20917f89df83d44a143f445586a5f5549599f3db4b178aca997df3 +size 11892 diff --git a/marked/Rel-16/29_series/29275/d9638e837004a4e09dbbc50b8aecbd5f_img.jpg b/marked/Rel-16/29_series/29275/d9638e837004a4e09dbbc50b8aecbd5f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..749bc53b9b19117e0f5ea3ede6b5a17e066e79e1 --- /dev/null +++ b/marked/Rel-16/29_series/29275/d9638e837004a4e09dbbc50b8aecbd5f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:985639bd496a52b6ffaa861ec33dcc8ccec53608268c183df4277b4b20455aad +size 12177 diff --git a/marked/Rel-16/29_series/29275/d964618f772e53e0dcf684977e62daf9_img.jpg b/marked/Rel-16/29_series/29275/d964618f772e53e0dcf684977e62daf9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b0fefd7f8fdf49da70c1cb304bb65c304c6e50c9 --- /dev/null +++ b/marked/Rel-16/29_series/29275/d964618f772e53e0dcf684977e62daf9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b534f957507814a5a0de850a5cc0e736ea1e39ad0853355818d8568fddc3cef7 +size 6346 diff --git a/marked/Rel-16/29_series/29275/f92e919c70b7adda2d0e778889f44fae_img.jpg b/marked/Rel-16/29_series/29275/f92e919c70b7adda2d0e778889f44fae_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5050014f9a6f25005176163ad723454e807e3320 --- /dev/null +++ b/marked/Rel-16/29_series/29275/f92e919c70b7adda2d0e778889f44fae_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fbd2fa9f5928347beba10e337713edcda67fd330aca87d614316c3d302e116b8 +size 8776 diff --git a/marked/Rel-16/29_series/29275/raw.md b/marked/Rel-16/29_series/29275/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..6daef164233be1bc00384b7496a8394954700667 --- /dev/null +++ b/marked/Rel-16/29_series/29275/raw.md @@ -0,0 +1,3558 @@ + + + + +**Error:** + +**2** + +**Error: Reference source not** + +# Contents + +| | | +|-----------------------------------------------------------------------------|----| +| Foreword..... | 10 | +| 1 Scope..... | 11 | +| 2 References..... | 11 | +| 3 Definitions and abbreviations..... | 13 | +| 3.1 Definitions..... | 13 | +| 3.2 Abbreviations..... | 13 | +| 4 General..... | 14 | +| 4.1 PDN connection..... | 14 | +| 4.2 PMIPv6 protocol stacks..... | 14 | +| 5 Mobility Management procedures..... | 15 | +| 5.1 Proxy Mobile IPv6 PDN Connection Creation procedure..... | 15 | +| 5.1.1 General..... | 15 | +| 5.1.1.1 Proxy Binding Update..... | 15 | +| 5.1.1.2 Proxy Binding Acknowledgement..... | 19 | +| 5.1.2 MAG procedures..... | 21 | +| 5.1.3 LMA procedures..... | 22 | +| 5.2 Proxy Mobile IPv6 PDN Connection Lifetime Extension procedure..... | 22 | +| 5.2.1 General..... | 22 | +| 5.2.1.1 Proxy Binding Update..... | 22 | +| 5.2.1.2 Proxy Binding Acknowledgement..... | 25 | +| 5.2.2 MAG procedures..... | 26 | +| 5.2.3 LMA procedures..... | 26 | +| 5.3 Proxy Mobile IPv6 PDN Connection Handover procedure..... | 28 | +| 5.3.1 General..... | 28 | +| 5.3.1.1 Proxy Binding Update..... | 28 | +| 5.3.1.2 Proxy Binding Acknowledgement..... | 32 | +| 5.3.2 MAG procedures..... | 34 | +| 5.3.3 LMA procedures..... | 34 | +| 5.4 Proxy Mobile IPv6 MAG Initiated PDN Connection Deletion procedure..... | 35 | +| 5.4.1 General..... | 35 | +| 5.4.1.1 Proxy Binding Update..... | 36 | +| 5.4.1.2 Proxy Binding Acknowledgement..... | 38 | +| 5.4.2 MAG procedures..... | 39 | +| 5.4.3 LMA procedures..... | 39 | +| 5.5 Proxy Mobile IPv6 LMA Initiated PDN Connection Deletion procedure..... | 40 | +| 5.5.1 General..... | 40 | +| 5.5.1.1 Binding Revocation Indication..... | 40 | +| 5.5.2 MAG procedures..... | 42 | +| 5.5.3 LMA procedures..... | 42 | +| 5.6 Proxy Mobile IPv6 PDN Connection IPv4 address allocation procedure..... | 42 | +| 5.6.1 General..... | 42 | +| 5.6.1.1 Proxy Binding Update..... | 43 | +| 5.6.1.2 Proxy Binding Acknowledgement..... | 44 | +| 5.6.2 MAG procedures..... | 45 | +| 5.6.3 LMA procedures..... | 46 | +| 5.7 Proxy Mobile IPv6 LMA Initiated IPv4 Address Release procedure..... | 46 | +| 5.7.1 General..... | 46 | +| 5.7.1.1 Binding Revocation Indication..... | 46 | +| 5.7.1.2 Binding Revocation Acknowledgment..... | 47 | +| 5.7.2 MAG procedures..... | 48 | +| 5.7.3 LMA procedures..... | 48 | +| 5.8 Proxy Mobile IPv6 Multiple PDN Extensions..... | 48 | +| 5.8.1 General..... | 48 | +| 5.8.2 Extensions to PMIPv6 Data Structure..... | 48 | +| 5.8.3 Extensions to PMIPv6 BULE and BCE Lookups..... | 49 | + +| | | | +|----------|-------------------------------------------------------------------------|----| +| 5.8.3.1 | General..... | 49 | +| 5.8.3.2 | Extensions to PMIPv6 BCE Lookups..... | 49 | +| 5.8.3.3 | Extensions to PMIPv6 BULE Lookups..... | 49 | +| 5.8.4 | Extensions to PMIPv6 Procedure..... | 50 | +| 5.8.4.1 | General..... | 50 | +| 5.8.4.2 | MAG procedure..... | 50 | +| 5.8.4.3 | LMA procedure..... | 50 | +| 5.9 | Serving GW Procedure at Chaining Case..... | 50 | +| 5.9.1 | General..... | 50 | +| 5.9.2 | Signalling procedures..... | 50 | +| 5.9.2.1 | PMIP-based S8 Serving GW procedures..... | 50 | +| 5.9.3 | Payload packets at chained case..... | 51 | +| 5.10 | Proxy Mobile IPv6 MAG Initiated IPv4 Address Release procedure..... | 51 | +| 5.10.1 | General..... | 51 | +| 5.10.1.1 | Proxy Binding Update..... | 51 | +| 5.10.1.2 | Proxy Binding Acknowledgement..... | 52 | +| 5.10.2 | MAG procedures..... | 53 | +| 5.10.3 | LMA procedures..... | 53 | +| 5.11 | Proxy Mobile IPv6 LMA Initiated Update Notification procedure..... | 53 | +| 5.11.1 | General..... | 53 | +| 5.11.1.1 | Update Notification..... | 54 | +| 5.11.1.2 | Update Notification Acknowledgement..... | 54 | +| 5.11.2 | LMA procedures..... | 55 | +| 5.11.3 | MAG procedures..... | 55 | +| 5.12 | Proxy Mobile IPv6 Mobile Network Prefix Allocation procedure..... | 55 | +| 5.12.1 | General..... | 55 | +| 5.12.1.1 | Proxy Binding Update..... | 55 | +| 5.12.1.2 | Proxy Binding Acknowledgement..... | 56 | +| 5.12.2 | MAG procedures..... | 57 | +| 5.12.3 | LMA procedures..... | 57 | +| 6 | Tunnel Management procedures..... | 58 | +| 6.1 | General..... | 58 | +| 6.2 | MAG procedure..... | 58 | +| 6.3 | LMA procedure..... | 59 | +| 6.4 | Data Structures..... | 59 | +| 6.4.1 | Binding Update List Entry..... | 59 | +| 6.4.2 | Binding Cache Entry..... | 60 | +| 6.5 | Security..... | 61 | +| 7 | Path Management procedures..... | 62 | +| 7.1 | General..... | 62 | +| 7.2 | Heartbeat Mechanism..... | 62 | +| 7.2.1 | General..... | 62 | +| 7.2.2 | Heartbeat Message..... | 62 | +| 7.2.2.1 | Heartbeat Request..... | 62 | +| 7.2.2.2 | Heartbeat Response..... | 62 | +| 7.3 | Void..... | 63 | +| 7.4 | Void..... | 63 | +| 7.5 | Void..... | 63 | +| 7.6 | UE-specific Error Handling..... | 63 | +| 7.6.1 | General..... | 63 | +| 7.6.2 | MAG and LMA procedure..... | 63 | +| 7.7 | Void..... | 63 | +| 7.8 | Partial node failure requiring the removal of a subset of sessions..... | 63 | +| 7.8.1 | General..... | 63 | +| 7.8.2 | Binding Revocation Indication message..... | 63 | +| 7.8.3 | Binding Revocation Acknowledgement message..... | 64 | +| 7.8.4 | MAG procedures..... | 64 | +| 7.8.5 | LMA procedures..... | 64 | +| 8 | PMIP-based S5 and PMIP-based S8 description..... | 65 | +| 8.1 | Initial Attach procedures..... | 65 | + +| | | | +|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|----| +| 8.1.1 | General..... | 65 | +| 8.1.2 | Serving GW procedures..... | 65 | +| 8.1.3 | PDN GW procedures..... | 65 | +| 8.2 | Serving GW Initiated PDN Connection Lifetime Extension procedures..... | 65 | +| 8.2.1 | General..... | 65 | +| 8.2.2 | Serving GW procedures..... | 65 | +| 8.2.3 | PDN GW procedures..... | 65 | +| 8.3 | UE, MME or HSS initiated Detach procedures..... | 65 | +| 8.3.1 | General..... | 65 | +| 8.3.2 | Serving GW procedures..... | 65 | +| 8.3.3 | PDN GW procedures..... | 65 | +| 8.4 | PDN GW Initiated PDN Disconnection procedures..... | 66 | +| 8.4.1 | General..... | 66 | +| 8.4.2 | Serving GW procedures..... | 66 | +| 8.4.3 | PDN GW procedures..... | 66 | +| 8.5 | UE Requested Additional PDN Connectivity procedures..... | 66 | +| 8.5.1 | General..... | 66 | +| 8.5.2 | Serving GW procedures..... | 66 | +| 8.5.3 | PDN GW procedures..... | 66 | +| 8.6 | Handover procedures..... | 66 | +| 8.6.1 | Intra-LTE TAU and Inter-eNodeB Handover with Serving GW Relocation procedures..... | 66 | +| 8.6.1.1 | General..... | 66 | +| 8.6.1.2 | Serving GW procedures..... | 66 | +| 8.6.1.3 | PDN GW procedures..... | 66 | +| 8.6.2 | TAU/RAU or Handover between GERAN A/Gb Mode or UTRAN Iu Mode and E-UTRAN procedures..... | 67 | +| 8.6.2.1 | General..... | 67 | +| 8.6.2.2 | Serving GW procedures..... | 67 | +| 8.6.2.3 | PDN GW procedures..... | 67 | +| 8.6.3 | Handover from Trusted or Untrusted Non-3GPP IP Access over S2a/S2b to 3GPP Access Handover E-UTRAN over PMIP based S5/S8 without optimization procedures..... | 67 | +| 8.6.3.1 | General..... | 67 | +| 8.6.3.2 | Serving GW procedures..... | 67 | +| 8.6.3.3 | PDN GW procedures..... | 67 | +| 8.6.4 | Handover from Trusted or Untrusted Non-3GPP IP Access over S2a/S2b to 3GPP Access UTRAN/GERAN over PMIP based S5/S8 without optimization..... | 67 | +| 8.6.4.1 | General..... | 67 | +| 8.6.4.2 | Serving GW procedures..... | 67 | +| 8.6.4.3 | PDN GW procedures..... | 67 | +| 8.6.5 | Handover from Trusted or Untrusted Non-3GPP IP Access over S2c to 3GPP Access over PMIP based S5/S8 without optimization..... | 68 | +| 8.6.5.1 | General..... | 68 | +| 8.6.5.2 | Serving GW procedures..... | 68 | +| 8.6.5.3 | PDN GW procedures..... | 68 | +| 8.6.6 | Void..... | 68 | +| 8.6.7 | Void..... | 68 | +| 8.7 | UE Requested PDN Disconnection procedures..... | 68 | +| 8.7.1 | General..... | 68 | +| 8.7.2 | Serving GW procedures..... | 68 | +| 8.7.3 | PDN GW procedures..... | 68 | +| 8.8 | IPv4 Address Allocation using DHCP..... | 68 | +| 8.8.1 | General..... | 68 | +| 8.8.2 | Serving GW procedures..... | 68 | +| 8.8.3 | PDN GW procedures..... | 68 | +| 8.9 | PDN-GW Initiated IPv4 Address Delete Procedure..... | 69 | +| 8.9.1 | General..... | 69 | +| 8.9.2 | Serving GW procedures..... | 69 | +| 8.9.3 | PDN GW procedures..... | 69 | +| 8.10 | Mobile Network Prefix Allocation using DHCPv6 Prefix Delegation..... | 69 | +| 8.10.1 | General..... | 69 | +| 8.10.2 | Serving GW procedures..... | 69 | + +| | | | +|--------|------------------------------------------------------------------------------------------------------------|----| +| 8.10.3 | PDN GW procedures..... | 69 | +| 9 | Trusted Non-3GPP Access over S2a Description..... | 69 | +| 9.0 | General..... | 69 | +| 9.1 | Initial Attach procedures..... | 69 | +| 9.1.1 | General..... | 69 | +| 9.1.2 | Trusted Non-3GPP Access procedures..... | 69 | +| 9.1.3 | PDN GW procedures..... | 69 | +| 9.2 | Trusted Non-3GPP Access Initiated PDN Connection Lifetime Extension procedures..... | 70 | +| 9.2.1 | General..... | 70 | +| 9.2.2 | Trusted Non-3GPP Access procedures..... | 70 | +| 9.2.3 | PDN GW procedures..... | 70 | +| 9.3 | UE / Trusted Non-3GPP Access Initiated Detach and UE Requested PDN Disconnection procedures..... | 70 | +| 9.3.1 | General..... | 70 | +| 9.3.2 | Trusted Non-3GPP Access procedures..... | 70 | +| 9.3.3 | PDN GW procedures..... | 70 | +| 9.4 | HSS / AAA Initiated Detach procedures..... | 70 | +| 9.4.1 | General..... | 70 | +| 9.4.2 | Trusted Non-3GPP Access procedures..... | 70 | +| 9.4.3 | PDN GW procedures..... | 70 | +| 9.5 | UE Initiated Connectivity to Additional PDN procedures..... | 71 | +| 9.5.1 | General..... | 71 | +| 9.5.2 | Trusted Non-3GPP Access procedures..... | 71 | +| 9.5.3 | PDN GW procedures..... | 71 | +| 9.6 | 3GPP Access to Trusted Non-3GPP IP Access with PMIPv6 on S2a Handover procedures without optimization..... | 71 | +| 9.6.1 | General..... | 71 | +| 9.6.2 | Trusted Non-3GPP Access procedures..... | 71 | +| 9.6.3 | PDN GW procedures..... | 71 | +| 9.7 | PDN GW Initiated Resource Allocation Deactivation procedures..... | 71 | +| 9.7.1 | General..... | 71 | +| 9.7.2 | Trusted Non-3GPP Access procedures..... | 71 | +| 9.7.3 | PDN GW procedures..... | 71 | +| 9.8 | IPv4 Address Allocation using DHCP..... | 72 | +| 9.8.1 | General..... | 72 | +| 9.8.2 | Trusted Non-3GPP Access procedures..... | 72 | +| 9.8.3 | PDN GW procedures..... | 72 | +| 9.9 | PDN-GW Initiated IPv4 Address Delete Procedure..... | 72 | +| 9.9.1 | General..... | 72 | +| 9.9.2 | Trusted Non-3GPP Access procedures..... | 72 | +| 9.9.3 | PDN GW procedures..... | 72 | +| 9.10 | Optimized E-UTRAN to CDMA2000 eHRPD Handover procedure..... | 72 | +| 9.10.1 | General..... | 72 | +| 9.10.2 | CDMA2000 HRPD access procedure..... | 72 | +| 9.10.3 | PDN GW procedures..... | 72 | +| 9.11 | Optimized Idle Mode Mobility: E-UTRAN Access to cdma2000 eHRPD Access procedure..... | 73 | +| 9.11.1 | General..... | 73 | +| 9.11.2 | CDMA2000 eHRPD access procedure..... | 73 | +| 9.11.3 | PDN GW procedures..... | 73 | +| 10 | Untrusted Non-3GPP Access over S2b Description..... | 73 | +| 10.1 | Initial Attach procedures..... | 73 | +| 10.1.1 | General..... | 73 | +| 10.1.2 | ePDG procedures..... | 73 | +| 10.1.3 | PDN GW procedures..... | 74 | +| 10.2 | ePDG Initiated PDN Connection Lifetime Extension procedures..... | 74 | +| 10.2.1 | General..... | 74 | +| 10.2.2 | ePDG procedures..... | 74 | +| 10.2.3 | PDN GW procedures..... | 74 | +| 10.3 | UE / ePDG Initiated Detach and UE Requested PDN Disconnection procedures..... | 74 | +| 10.3.1 | General..... | 74 | +| 10.3.2 | ePDG procedures..... | 74 | + +| | | | +|----------|--------------------------------------------------------------------------------------------------------------|----| +| 10.3.3 | PDN GW procedures..... | 75 | +| 10.4 | HSS / AAA Initiated Detach procedures..... | 75 | +| 10.4.1 | General..... | 75 | +| 10.4.2 | ePDG procedures..... | 75 | +| 10.4.3 | PDN GW procedures..... | 75 | +| 10.5 | UE Initiated Connectivity to Additional PDN procedures..... | 75 | +| 10.5.1 | General..... | 75 | +| 10.5.2 | ePDG procedures..... | 75 | +| 10.5.3 | PDN GW procedures..... | 76 | +| 10.6 | 3GPP Access to Untrusted Non-3GPP IP Access with PMIPv6 on S2b Handover procedures without optimization..... | 76 | +| 10.6.1 | General..... | 76 | +| 10.6.2 | ePDG procedures..... | 76 | +| 10.6.3 | PDN GW procedures..... | 76 | +| 10.7 | PDN GW Initiated Resource Allocation Deactivation procedures..... | 76 | +| 10.7.1 | General..... | 76 | +| 10.7.2 | ePDG procedures..... | 76 | +| 10.7.3 | PDN GW procedures..... | 76 | +| 10.8 | PDN-GW Initiated IPv4 Address Delete Procedure..... | 77 | +| 10.8.1 | General..... | 77 | +| 10.8.2 | ePDG procedures..... | 77 | +| 10.8.3 | PDN GW procedures..... | 77 | +| 11 | S2a and S2b Chaining with PMIP-based S8 Description..... | 77 | +| 11.1 | Initial Attach procedures..... | 77 | +| 11.1.1 | General..... | 77 | +| 11.1.2 | ePDG / Trusted Non-3GPP Access procedures..... | 77 | +| 11.1.3 | Serving GW procedures..... | 77 | +| 11.2 | ePDG / Trusted Non-3GPP Access Initiated PDN Connection Lifetime Extension procedures..... | 78 | +| 11.2.1 | General..... | 78 | +| 11.2.2 | ePDG / Trusted Non-3GPP Access procedures..... | 78 | +| 11.2.3 | Serving GW procedures..... | 78 | +| 11.3 | UE / ePDG / Trusted Non-3GPP Access Initiated Detach procedures..... | 78 | +| 11.3.1 | General..... | 78 | +| 11.3.2 | ePDG / Trusted Non-3GPP Access procedures..... | 78 | +| 11.3.3 | Serving GW procedures..... | 78 | +| 11.4 | HSS / AAA Initiated Detach procedures..... | 78 | +| 11.4.1 | General..... | 78 | +| 11.4.2 | ePDG / Trusted Non-3GPP Access procedures..... | 78 | +| 11.4.3 | Serving GW procedures..... | 78 | +| 11.5 | UE Initiated Connectivity to Additional PDN procedures..... | 79 | +| 11.5.1 | General..... | 79 | +| 11.5.2 | ePDG / Trusted Non-3GPP Access procedures..... | 79 | +| 11.5.3 | Serving GW procedures..... | 79 | +| 11.6 | 3GPP Access to Trusted / Untrusted Non-3GPP IP Access Handover procedures without optimization..... | 79 | +| 11.6.1 | General..... | 79 | +| 11.6.2 | ePDG / Trusted Non-3GPP Access procedures..... | 79 | +| 11.6.3 | Serving GW procedures..... | 79 | +| 11.7 | UE Requested PDN Disconnection procedures..... | 80 | +| 11.7.1 | General..... | 80 | +| 11.7.2 | ePDG / Trusted Non-3GPP Access procedures..... | 80 | +| 11.7.3 | Serving GW procedures..... | 80 | +| 11.8 | PDN GW Initiated Resource Allocation Deactivation procedures..... | 80 | +| 11.8.1 | General..... | 80 | +| 11.8.2 | ePDG / Trusted Non-3GPP Access procedures..... | 80 | +| 11.8.3 | Serving GW procedures..... | 80 | +| 12 | Information Elements..... | 80 | +| 12.1 | Additional Proxy Mobile IPv6 Information Elements..... | 80 | +| 12.1.1 | 3GPP-Specific PMIPv6 Information Elements..... | 80 | +| 12.1.1.0 | General..... | 80 | +| 12.1.1.1 | 3GPP Specific PMIPv6 error code..... | 82 | + +| | | | +|-----------|--------------------------------------------------------------------------------------|----| +| 12.1.1.2 | Fully Qualified PDN Connection Set Identifier (FQ-CSID)..... | 82 | +| 12.1.1.3 | PDN Type Indication..... | 83 | +| 12.1.1.4 | PDN GW IP address..... | 83 | +| 12.1.1.5 | DHCPv4 Address Allocation Procedure Indication..... | 84 | +| 12.1.1.6 | Charging ID..... | 84 | +| 12.1.1.7 | Selection Mode..... | 84 | +| 12.1.1.8 | Charging Characteristics..... | 84 | +| 12.1.1.9 | Serving Network..... | 85 | +| 12.1.1.10 | Mobile Equipment Identity..... | 85 | +| 12.1.1.11 | MSISDN..... | 85 | +| 12.1.1.12 | APN Restriction..... | 86 | +| 12.1.1.13 | Maximum APN Restriction..... | 86 | +| 12.1.1.14 | Unauthenticated IMSI..... | 86 | +| 12.1.1.15 | PDN Connection ID..... | 86 | +| 12.1.1.16 | PGW Back-Off Time..... | 87 | +| 12.1.1.17 | Signalling Priority Indication..... | 87 | +| 12.1.1.18 | Static IP Address Allocation Indication..... | 87 | +| 12.1.1.19 | Additional Protocol Configuration Options..... | 88 | +| 12.1.1.20 | MME/SGSN Identifier..... | 88 | +| 12.1.1.21 | End Marker Notification..... | 88 | +| 12.1.1.22 | Trusted WLAN Mode Indication..... | 88 | +| 12.1.1.23 | UE Time Zone..... | 89 | +| 12.1.1.24 | Access Network Identifier Timestamp..... | 89 | +| 12.1.1.25 | Logical Access ID..... | 90 | +| 12.1.1.26 | Origination Time Stamp..... | 90 | +| 12.1.1.27 | Maximum Wait Time..... | 90 | +| 12.1.1.28 | TWAN Capabilities..... | 91 | +| 13 | Trusted WLAN Access over S2a Description..... | 91 | +| 13.1 | Initial Attach procedures..... | 91 | +| 13.1.1 | General..... | 91 | +| 13.1.2 | TWAN procedures..... | 91 | +| 13.1.3 | PDN GW procedures..... | 92 | +| 13.2 | TWAN Initiated PDN Connection Lifetime Extension procedures..... | 92 | +| 13.2.1 | General..... | 92 | +| 13.2.2 | TWAN procedures..... | 92 | +| 13.2.3 | PDN GW procedures..... | 93 | +| 13.3 | UE / TWAN Initiated Detach and UE/TWAN Requested PDN Disconnection procedures..... | 93 | +| 13.3.1 | General..... | 93 | +| 13.3.2 | TWAN procedures..... | 93 | +| 13.3.3 | PDN GW procedures..... | 93 | +| 13.4 | HSS / AAA Initiated Detach procedures..... | 93 | +| 13.4.1 | General..... | 93 | +| 13.4.2 | TWAN procedures..... | 93 | +| 13.4.3 | PDN GW procedures..... | 93 | +| 13.5 | PDN GW Initiated Resource Allocation Deactivation procedures..... | 94 | +| 13.5.1 | General..... | 94 | +| 13.5.2 | TWAN procedures..... | 94 | +| 13.5.3 | PDN GW procedures..... | 94 | +| 13.6 | 3GPP Access to TWAN with PMIPv6 on S2a Handover procedures without optimization..... | 94 | +| 13.6.1 | General..... | 94 | +| 13.6.2 | TWAN procedures..... | 94 | +| 13.6.3 | PDN GW procedures..... | 94 | +| 13.7 | UE Initiated Connectivity to Additional PDN procedures..... | 95 | +| 13.7.1 | General..... | 95 | +| 13.7.2 | TWAN procedures..... | 95 | +| 13.7.3 | PDN GW procedures..... | 95 | +| 14 | Proxy Mobile IPv6 EPC Restoration Procedure..... | 95 | +| 14.1 | PGW triggered SGW restoration procedure..... | 95 | +| 14.1.1 | General..... | 95 | +| 14.1.2 | Serving GW procedures..... | 96 | + +| | | | +|-----------------------------|----------------------------------------------------------------|-----------| +| 14.1.3 | PDN GW procedures..... | 96 | +| 14.2 | Update PDP context/Bearer at P-CSCF failure..... | 96 | +| 14.2.1 | General..... | 96 | +| 14.2.2 | PDN GW procedures..... | 96 | +| 14.2.3 | Serving GW, TWAN and ePDG procedures..... | 96 | +| 14.3 | Inform UE about P-CSCF failure..... | 97 | +| 14.3.1 | General..... | 97 | +| 14.3.2 | PDN GW procedures..... | 97 | +| 14.3.3 | Serving GW procedures..... | 97 | +| 15 | Proxy Mobile IPv6 End Marker Notification Procedure..... | 97 | +| 15.1 | General..... | 97 | +| 15.2 | Serving GW procedures..... | 97 | +| 15.3 | PDN GW procedures..... | 98 | +| Annex A: | void..... | 99 | +| Annex B (Normative): | Definition of the protocol number in pseudo-header..... | 99 | +| B.1 | General..... | 99 | +| B.2 | Interworking of different protocol number..... | 99 | +| Annex C (informative): | Change History..... | 100 | + +--- + +--- + +## Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +--- + +# 1 Scope + +The present document specifies the stage 3 of the PMIPv6 Based Mobility and Tunnelling Protocols used over the PMIP-based S2a, S2b, S5, and S8 reference points defined in 3GPP TS 23.402 [3], and are thus applicable to the Serving GW, PDN Gateway, ePDG, and Trusted Non-3GPP Access. Protocols specifications are compliant with relevant IETF RFCs. In this specification PMIP refers to PMIPv6 as defined in IETF RFC5213 [4] taking into account the corrections regarding the protocol number definition in IETF RFC6275 [8]. + +--- + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.401: "GPRS enhancements for E-UTRAN access ". +- [3] 3GPP TS 23.402: "Architecture Enhancements for non-3GPP accesses". +- [4] IETF RFC 5213: "Proxy Mobile IPv6". +- [5] IETF RFC 5844: "IPv4 Support for Proxy Mobile IPv6". +- [6] IETF RFC 5846: "Binding Revocation for IPv6 Mobility". +- [7] IETF RFC 5845: "Generic Routing Encapsulation (GRE) Key Option for Proxy Mobile IPv6". +- [8] IETF RFC 6275: "Mobility Support in IPv6". +- [9] IETF RFC 4282: "The Network Access Identifier". +- [10] IETF RFC 4283: "Mobile Node Identifier Option for Mobile IPv6 (MIPv6)". +- [11] IETF RFC 5149: "Service Selection for Mobile Ipv6". +- [12] 3GPP TS 23.003: "Numbering, addressing and identification". +- [13] 3GPP TS 23.007: "Restoration Procedures". +- [14] Void +- [15] Void +- [16] 3GPP TS 24.008: "Mobile radio interface Layer 3 specification; Core network protocols". +- [17] IETF RFC 5847: "Heartbeat Mechanism for Proxy Mobile IPv6". +- [18] IANA Mobile Ipv6 Parameters Registry, <>. +- [19] 3GPP TS 33.402: "3GPP System Architecture Evolution (SAE); Security aspects of non-3GPP accesses". +- [20] IETF RFC 2784: "Generic Routing Encapsulation (GRE)". +- [21] IETF RFC 2890: "Key and Sequence Number Extensions to GRE". + +- [22] 3GPP TS 29.274: "3GPP Evolved Packet System (EPS); Evolved General Packet Radio Service (GPRS) Tunnelling Protocol for Control plane (GTPv2-C); Stage 3". +- [23] 3GPP TS 23.060: "General Packet Radio Service (GPRS); Service description; Stage 2". +- [24] 3GPP TS 29.282: "Mobile IPv6 vendor specific option format and usage within 3GPP". +- [25] 3GPP TS 32.251: "Charging Management; Packet Switched (PS) domain charging". +- [26] 3GPP TS 32.298: "Charging Management; Charging Data Record (CDR) parameter description". +- [27] IETF RFC 4291: "IP Version 6 Addressing Architecture". +- [28] 3GPP TS 29.060: "General Packet Radio Service (GPRS); GPRS Tunnelling Protocol (GTP) across the Gn and Gp interface". +- [29] ITU-T Recommendation E.164: "The international public telecommunication numbering plan". +- [30] 3GPP TS 29.212: "Policy and Charging Control (PCC); Reference points". +- [31] IETF RFC 2473: "Generic Packet Tunneling in IPv6 Specification". +- [32] IANA Registry of Assigned Numbers. Mobile IPv6 parameters, Status Codes: +. +- [33] IANA Registry of Assigned Numbers. Mobile IPv6 parameters, Binding Revocation Acknowledgement Status Codes: . +- [34] IETF RFC5555: "Mobile IPv6 Support for Dual Stack Hosts and Routers". +- [35] IETF RFC 7077: "Update Notifications for Proxy Mobile IPv6". +- [36] 3GPP TS 23.380: "IMS Restoration Procedures". +- [37] IETF RFC 6757: "Access Network Identifier Option". +- [38] IETF RFC 3775, "Mobility Support in IPv6". +- [39] 3GPP TS 24.302: "Access to the 3GPP Evolved Packet Core (EPC) via non-3GPP access networks; Stage 3". +- [40] IETF RFC 5905, "Network Time Protocol Version 4: Protocol and Algorithms Specification". +- [41] IETF RFC 7563: "Extensions to the Proxy Mobile IPv6 (PMIPv6) Access Network Identifier Option". +- [42] IETF RFC 3046: "DHCP Relay Agent Information Option". +- [43] IETF RFC 6463: "Runtime Local Mobility Anchor (LMA) Assignment Support for Proxy Mobile IPv6". +- [44] IETF RFC 7389: "Separation of Control and User Plane for Proxy Mobile IPv6". +- [45] IETF RFC 7148: "Prefix Delegation Support for Proxy Mobile IPv6". + +--- + +## 3 Definitions and abbreviations + +### 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +The following terms used in this Technical Specification are defined in: + +- the PMIPv6 specification IETF RFC 5213 [4]: IPv6 Home Network Prefix, Proxy Care-of Address, Local Mobility Anchor Address; +- the IPv4 Support for PMIPv6 specification IETF RFC 5844 [5]: IPv4 Home Address, IPv4 Local Mobility Anchor Address; +- the MIPv6 specification [8] and extended by the PMIPv6 specification IETF RFC 5213 [4]: Binding Cache Entry, Binding Update List Entry; +- the Binding Revocation for IPv6 Mobility [6]: Binding Revocation Indication and Binding Revocation Acknowledgement; +- the Separation of Control and User Plane for PMIPv6 specification IETF RFC 7389 [44]: LMA User-Plane Address. + +**Local Mobility Anchor:** Within EPS the Local Mobility Anchor functionality consists of a PMIPv6 Local Mobility Anchor as described in the PMIPv6 specification IETF RFC 5213 [4] with support of IPv4 Support for PMIPv6 as defined in IETF RFC 5844 [5], Binding Revocation for IPv6 Mobility as defined in IETF RFC 5846 [6], GRE Key Option for PMIPv6 as defined in IETF RFC 5845 [7], and PMIPv6 Heartbeat Mechanism as defined in IETF RFC 5847 [17]. + +**Mobile Access Gateway:** Within EPS the Mobility Access Gateway functionality consists of a PMIPv6 Mobility Access Gateway as described in the PMIPv6 specification IETF RFC 5213 [4] with support of IPv4 Support for PMIPv6 as defined in IETF RFC 5844 [5], Binding Revocation for IPv6 Mobility as defined in IETF RFC 5846 [6], GRE Key Option for PMIPv6 as defined in IETF RFC 5845 [7], and PMIPv6 Heartbeat Mechanism as defined in IETF RFC 5847 [17]. + +**PDN Connection:** The association between a UE represented by one IPv4 Home Address and/or one IPv6 Home Network Prefix, and a PDN represented by an APN. On a PMIPv6 peer (MAG or LMA) there is a one-to-one mapping between a PDN connection and a PMIPv6 binding. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|-----------|-------------------------------------------------| +| 3GSPEC | 3GPP Specific PMIPv6 Error Code | +| BCE | Binding Cache Entry | +| BRA | Binding Revocation Acknowledgement | +| BRI | Binding Revocation Indication | +| BULE | Binding Update List Entry | +| EPC | Evolved Packet Core | +| ePDG | Evolved Packet Data Gateway | +| GRE | Generic Routing Encapsulation | +| GW | Gateway | +| IMSI | International Mobile Subscriber Identity | +| IMEI | International Mobile station Equipment Identity | +| IPv4-LMAA | IPv4 LMAA | +| LMA | Local Mobility Anchor | +| LMAA | LMA Address | +| MAG | Mobility Access Gateway | +| MIPv6 | Mobile IPv6 | +| NAI | Network Access Identifier | +| PBA | Proxy Binding Acknowledgment | +| PBU | Proxy Binding Update | +| PMIPv6 | Proxy MIPv6 | +| Proxy-CoA | Proxy Care-of Address | +| TWAN | Trusted WLAN Access Network | +| UPN | Update Notification | +| UPA | Update Notification Acknowledgment | + +## 4 General + +### 4.1 PDN connection + +On a PMIPv6 peer (MAG or LMA) there is a one-to-one mapping between a PDN connection and a PMIPv6 binding. + +Traffic sent over a given PDN connection is encapsulated with GRE [20] using different, per-interface per-PDN connection, per direction (uplink and downlink) GRE keys [21] to allow multiplexing and demultiplexing of traffic belonging to different PDN connections at MAG and LMA. For the handover between 3GPP access and non-3GPP access, the uplink GRE Key shall be the same. + +### 4.2 PMIPv6 protocol stacks + +Protocol stacks for PMIPv6 are depicted in Figure 4.2-1. The MAG functions are defined in 3GPP TS 23.402 [3], e. g., relaying DHCPv4/DHCPv6 packets between the UE and the DHCP server, forwarding the payload packets between the UE and the LMA. + +![Figure 4.2-1: Protocol stacks for PMIP. The diagram shows three protocol stacks: Control Plane A, Control Plane B, and User Plane. Each stack is shown between a MAG (Mobile Access Gateway) and an LMA (PDN Gateway). Control Plane A uses PMIPv6 over UDP over IPv4 over L2/L1. Control Plane B uses PMIPv6 over IPv6 over L2/L1. User Plane uses IPv4/IPv6 over GRE over IPv4/IPv6 over L2/L1.](c036e2540a94b31357ceb0002f0cacab_img.jpg) + +| Control Plane A | | Control Plane B | | User Plane | | +|-----------------|--------|-----------------|--------|------------|-----------| +| MAG | LMA | MAG | LMA | MAG | LMA | +| PMIPv6 | PMIPv6 | PMIPv6 | PMIPv6 | IPv4/IPv6 | IPv4/IPv6 | +| UDP | UDP | | | GRE | GRE | +| IPv4 | IPv4 | IPv6 | IPv6 | IPv4/IPv6 | IPv4/IPv6 | +| L2/L1 | L2/L1 | L2/L1 | L2/L1 | L2/L1 | L2/L1 | + +Figure 4.2-1: Protocol stacks for PMIP. The diagram shows three protocol stacks: Control Plane A, Control Plane B, and User Plane. Each stack is shown between a MAG (Mobile Access Gateway) and an LMA (PDN Gateway). Control Plane A uses PMIPv6 over UDP over IPv4 over L2/L1. Control Plane B uses PMIPv6 over IPv6 over L2/L1. User Plane uses IPv4/IPv6 over GRE over IPv4/IPv6 over L2/L1. + +Figure 4.2-1: Protocols stacks for PMIP + +The Control Plane A shall be used if PMIPv6 messages are transported over IPv4 as described in IETF RFC 5844 [5]. The Control Plane B shall be used if PMIPv6 messages are transported over IPv6 as described in IETF RFC 5213 [4]. User Plane traffic shall be transported with GRE encapsulation as described in IETF RFC 2890 [21] (see also IETF RFC 2784 [20]). + +Figure 4.2-2: Void + +## 5 Mobility Management procedures + +### 5.1 Proxy Mobile IPv6 PDN Connection Creation procedure + +#### 5.1.1 General + +The PMIPv6 PDN Connection Creation procedure is initiated by the node acting as a MAG to create a new PDN connection with the node acting as an LMA for an UE that either attaches for the first time to the EPC, or connects to an additional PDN. The procedure starts with the MAG sending a PBU including the APN to the LMA to register with the LMA a binding for the UE's PDN connection. If multiple PDN connections to the same APN function is supported by the MAG, a PDN connection ID shall also be included in the same PBU message. The LMA confirms establishment of the binding by sending a PBA to the MAG. If multiple PDN connections to the same APN function is supported by the LMA, the received PDN connection ID shall also be included in the same PBA message. Establishment of the binding achieves the following: + +- **PDN selection:** The LMA select the PDN based on the APN contained in the PBU. +- **IPv6 Home Network Prefix assignment:** The LMA assigns to the UE's PDN connection an IPv6 Home Network Prefix valid in the selected PDN. +- **IPv4 Home Address assignment:** The LMA assigns to the UE's PDN connection an IPv4 Home Address valid in the selected PDN. +- **Downlink and Uplink GRE Key Assignment:** The MAG and LMA will establish downlink and uplink GRE keys to be used for GRE encapsulation of the PDN connection's downlink and uplink traffic, respectively. +- **GRE Tunnel Establishment:** A GRE tunnel is established between the MAG and LMA with the assigned GRE keys to carry uplink and downlink traffic that the UE respectively sends and receives on the PDN connection. +- **BCE Creation:** The LMA creates a BCE for the PDN connection. +- **BULE Creation:** The MAG creates a BULE for the PDN connection. +- **MAG Link Local Address assignment:** The LMA assigns the MAG link local address. +- **UE Interface Identifier (IID) assignment:** The LMA assigns to the UE an IPv6 Interface Identifier to allow formation of an UE Link Local Address from the well-known link local address prefix (fe80::/64). +- **PDN connection ID:** The PDN connection ID is provided by the MAG and accepted by LMA, if multiple PDN connections to the same APN function is supported by both MAG and LMA. +- **LMA Control Plane Address:** the LMA may assign an alternate LMAA or IPv4-LMAA, if this option is supported by both MAG and LMA. +- **LMA User Plane Address:** the LMA may assign an alternate LMA address for user plane, if this option is supported by both MAG and LMA. + +Regarding the usage and support of the protocol number in the pseudo-header see Annex B. + +#### 5.1.1.1 Proxy Binding Update + +The fields of a PBU message for the PMIPv6 PDN Connection Creation procedure are depicted in Table 5.1.1.1-1. + +The Mobility Options in a PBU message for the PMIPv6 PDN Connection Creation procedure are depicted in Table 5.1.1.1-2. When the mobility option is present in the message, only the first instance shall be recognised. If multiple instances are included in the message, the receiver ignores all other instances. + +Other flags are not used by this specification. + +**Table 5.1.1.1-1: Fields of a PBU message for the PMIPv6 PDN Connection Creation procedure** + +| Information element | IE Description | Reference | +|------------------------------------------|---------------------------------------------------------------------------------|--------------------| +| Sequence Number | Set to a locally (i.e. per MAG) monotonically increasing value. | IETF RFC 5213 [4] | +| Acknowledge (A) | Set to "1" to request an acknowledgement message. | IETF RFC 6275 [8] | +| Proxy Registration Flag (P) | Set to "1" to indicate that the Binding Update message is a proxy registration. | IETF RFC 5213 [4] | +| Force UDP encapsulation request (F) Flag | Set to "0" to indicate that UDP encapsulation is not used for the user plane. | IETF RFC 5555 [34] | +| Lifetime | Set to the requested number of time units the binding shall remain valid. | IETF RFC 6275 [8] | + +**Table 5.1.1.1-2: Mobility Options in a PBU message for the PMIPv6 PDN Connection Creation procedure** + +| Information element | Cat. | IE Description | Reference | +|---------------------------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------| +| Mobile Node Identifier option | M | Set to the NAI identifier of the UE as specified in 3GPP TS 23.003 [12]. The format of the NAI is specified in the subclause 19.3 in 3GPP TS 23.003 [12]. | 3GPP TS 23.003 [12] | +| Ipv6 Home Network Prefix option | C | For dynamic allocation, set the Home Network Prefix to the value "0:0" and Prefix Length to the value "0" to request allocation for the UE's PDN connection of an Ipv6 Home Network Prefix in the PDN corresponding the EPS Access Point Name. For static allocation, set the Home Network Prefix to the received static allocated Ipv6 Home Network Prefix and Prefix Length to the value "64".
NOTE 1. | IETF RFC 5213 [4] | +| Link-local Address | C | Present when Ipv6 Home Network Prefix option is present. Link-local address of the MAG. Set to ALL_ZERO (all bits set to 0), indicating that the MAG requests a link-local address to be used on the access link shared with the UE. | IETF RFC 5213 [4] | +| Handoff Indicator option | M | Set to the value "1" to indicate attachment over a new interface. | IETF RFC 5213 [4] | +| Access Technology Type option | M | Set to the 3GPP access type, i.e. GERAN, UTRAN, E-UTRAN or NB-IoT, or to the value matching the characteristics of the non-3GPP access (e.g., HRPD) the UE is using to attach to the EPS as defined in the Access Technology Type Option type values registry of the IANA Mobile Ipv6 Parameters Registry [18]. The ePDG may use the access technology type of the untrusted non-3GPP access network if it is able to acquire it; otherwise it shall indicate Virtual as the access technology.
The TWAN shall set the Access Technology Type Option value to 4 i.e. "IEEE 802.11a/b/g" on the S2a interface.
NOTE 2.
NOTE 3. | IETF RFC 5213 [4] | +| Timestamp option | M | Set to the current time | IETF RFC 5213 [4] | +| GRE key option | M | Set to the downlink GRE key to be used for downlink GRE encapsulated packets sent over the PDN connection. | IETF RFC 5845 [7] | +| Ipv4 Home Address Request option | C | For dynamic allocation, set the Ipv4 Home Address to the value "0.0.0.0" and Prefix-len to the value "0" or "32" to request allocation for the UE's PDN connection of an Ipv4 Home Address in the PDN corresponding to the EPS Access Point Name. For static allocation, set the Ipv4 Home Address to the received static allocated Ipv4 Home Address and Prefix-len to the value "32".
NOTE 1. | IETF RFC 5844 [5] | +| Service Selection Mobility Option | M | Set to the EPS Access Point Name to which the UE attaches the new PDN connection.
The encoding of the APN field follows 3GPP TS 23.003 [12] subclause 9.1 but excluding the trailing zero byte. The content of the APN field shall be the full APN with both the APN Network Identifier and APN Operator Identifier being present as specified in 3GPP TS 23.003 [12] subclauses 9.1.1 and 9.1.2.
NOTE 4. | IETF RFC 5149 [11] | +| Protocol Configuration Options | O | Contain Protocol Configuration Options. | Subclause 12.1.1.0 | +| PDN GW IP Address | O | Contain PDN GW IP address (on S2a or S2b when used for chained S2a/S2b-PMIP based S8). | Subclause 12.1.1.4 | +| MAG Fully Qualified PDN Connection Set Identifier | O | Contain a Fully Qualified PDN Connection Set Identifier if generated by the MAG on the S5/S8, S2a (for Trusted WLAN Access) and S2b interfaces as specified in 3GPP TS 23.007 [13]. | Subclause 12.1.1.2 | +| MME Fully Qualified PDN Connection Set Identifier | O | Contain a Fully Qualified PDN Connection Set Identifier if generated by the MME, and included by the MAG on the S5/S8 interfaces as specified in 3GPP TS 23.007 [13]. | Subclause 12.1.1.2 | + +| | | | | +|-------------------------------------------|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------| +| Selection Mode | O | Contains APN selection mode (on S5/S8). | Subclause 12.1.1.7 | +| Charging Characteristics | O | Contains the Charging Characteristics to be applied for EPC charging | Subclause 12.1.1.8 | +| Serving Network | C | This IE shall be included on S2a (for TWAN access), S5 and S8 interfaces to identify the Serving Network. This IE may be included on S2a to identify the Serving Network of the eHRPD access network. | Subclause 12.1.1.9 | +| Mobile Equipment Identity | O | This IE shall contain the MEI of the UE and shall be present, if available, on the S5, S8, S2a or S2b interface. | Subclause 12.1.1.10 | +| MSISDN | O | This IE shall contain the MSISDN and shall be present, if available, on the S5, S8, S2a or S2b interfaces. | Subclause 12.1.1.11 | +| Maximum APN Restriction | O | Contains the most stringent restriction of already active PDN connections (on S5/S8). | Subclause 12.1.1.13 | +| Unauthenticated IMSI | O | Contains the Unauthenticated IMSI | Subclause 12.1.1.14 | +| PDN connection ID | O | Contains the PDN connection ID | Subclause 12.1.1.15 | +| Signalling Priority Indication | O | The SGW shall forward this IE on the S5/S8 interfaces if received from the MME/SGSN. | Subclause 12.1.1.17 | +| Additional Protocol Configuration Options | O | Contains Additional Protocol Configuration Options. | Subclause 12.1.1.19 | +| MME/SGSN Identifier | O | The SGW shall include the MME/SGSN Identifier on the S5 interface if the SGW supports the PGW triggered SGW restoration procedure and this information is received from the MME/SGSN as specified in 3GPP TS 23.007 [13]. | Subclause 12.1.1.20 | +| Access Network Identifier Option | O | The TWAN shall include the access network identifier on S2a. | IETF RFC 6757 [37]
IETF RFC 7563 [41] | +| Trusted WLAN Mode Indication | O | Contains the selected trusted WLAN mode (SCM or MCM) on S2a interface. | Subclause 12.1.1.22 | +| UE Time Zone | O | The TWAN shall include the UE Timezone on the S2a interface. | Subclause 12.1.1.23 | +| Logical Access ID | O | Contains the Circuit-ID with the Relay Identity that allocated it. | Subclause 12.1.1.25 | +| Redirect-Capability Mobility Option | O | The MAG shall include this IE on the S5, S8, S2a and S2b interface if it supports the capability to receive from the LMA an alternate LMAA or IPv4-LMAA. | IETF RFC 6463 [43] | +| LMA User-Plane Address Mobility Option | O | The MAG shall include this IE on the S5, S8, S2a and S2b interface if it supports the capability to receive from the LMA an alternate LMA address for user plane. If so, the LMA User-Plane Address field within this Mobility Option shall be a zero-length field, or have a value of ALL_ZERO with all bits in the IPv4 address or the IPv6 address set to zero. | IETF RFC 7389 [44] | +| Origination Time Stamp | O | The SGW shall forward this IE on the S5/S8 interface if received from the MME/SGSN and if it supports the procedure specified in subclause 13.2 of 3GPP TS 29.274 [22].
The TWAN/ePDG shall include this IE on the S2a/S2b interface for the conditions specified in subclause 13.2 of 3GPP TS 29.274 [22]. | Subclause 12.1.1.26 | +| Maximum Wait Time | O | The SGW shall forward this IE on the S5/S8 interface if received from the MME/SGSN and if it supports the procedure specified in subclause 13.3 of 3GPP TS 29.274 [22].
The TWAN/ePDG shall include this IE on the S2a/S2b interface for the conditions specified in subclause 13.3 of 3GPP TS 29.274 [22]. | Subclause 12.1.1.27 | +| TWAN capabilities | O | The MAG shall include this IE on the S2a interface if any of the applicable flags is set to 1.
Applicable flags are:
- WLCP PDN Connection Modification Support Indication: This flag shall be set to 1 on the S2a interface if the TWAN supports the WLCP PDN Connection Modification procedure. | Subclause 12.1.1.28 | + +NOTE 1: At least one of the two options, namely, the IPv6 Home Network Prefix option or the IPv4 Home + +| | | +|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NOTE 2: | Address Request option shall be present. If both an IPv6 Home Network Prefix and an IPv4 Home Address are requested, both options shall be included in the same PBU message. | +| NOTE 3: | The methods that the ePDG may use to acquire the access technology type of the untrusted non-3GPP IP access network are not specified in this release. | +| NOTE 4: | The PDN-GW can be informed about the type of access network used by the UE over several reference points, see 3GPP TS 29.212 [30] for the mapping between the code values for the different access network types. | +| NOTE 4: | The APN field is not encoded as a dotted string as commonly used in documentation. | + +### 5.1.1.2 Proxy Binding Acknowledgement + +The fields of a PBA message for the PMIPv6 PDN Connection Creation procedure are depicted in Table 5.1.1.2-1. + +The Mobility Options in a PBA message for the PMIPv6 PDN Connection Creation procedure are depicted in Table 5.1.1.2-2. When the mobility option is present in the message, only the first instance shall be recognised. If multiple instances are included in the message, the receiver ignores all other instances. + +Other flags are not used by this specification. + +Only the message fields and mobility options used for acceptance cases are present in the following tables. + +**Table 5.1.1.2-1: Fields of a PBA message for the PMIPv6 PDN Connection Creation procedure** + +| Information element | IE Description | Reference | +|-----------------------------|---------------------------------------------------------------------------------|-------------------| +| Status | Set to indicate the result. | IETF RFC 6275 [8] | +| Proxy Registration Flag (P) | Set to "1" to indicate that the Binding Update message is a proxy registration. | IETF RFC 5213 [4] | +| Sequence Number | Set to the value received in the corresponding PBU. | IETF RFC 5213 [4] | +| Lifetime | Set to the granted number of time units the binding shall remain valid. | IETF RFC 6275 [8] | + +**Table 5.1.1.2-2: Mobility Options in a PBA message for the PMIPv6 PDN Connection Creation procedure** + +| Information element | Cat. | IE Description | Reference | +|---------------------------------------------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------| +| Mobile Node Identifier option | M | Copied from corresponding field of PBU. | IETF RFC 5213 [4] | +| IPv6 Home Network Prefix option | C | Present if IPv6 Home Network Prefix is allocated. When it's present, set the Home Network Prefix to the IPv6 Home Network Prefix Allocated for the UE's PDN connection based on the selected PDN corresponding to the EPS Access Point Name for dynamic allocation, or set to the static IPv6 Home Network Prefix received in the PBU for static allocation. The Prefix Length is set to the value "64". In addition, the Interface Identifier (IID) allocated for the UE is encoded in the low order 64 bits of this option, i.e., the IPv6 Home Network Prefix option. | IETF RFC 5213 [4] | +| Link-local Address | C | Present when IPv6 Home Network Prefix option is present. Link-local address to be used by the MAG on the access link shared with the UE. | IETF RFC 5213 [4] | +| Handoff Indicator option | M | Copied from corresponding field of PBU. | IETF RFC 5213 [4] | +| Access Technology Type option | M | Copied from corresponding field of PBU. | IETF RFC 5213 [4] | +| Timestamp option | M | Copied from corresponding field of PBU, or set to the current time of LMA in case of timestamp error. | IETF RFC 5213 [4] | +| GRE key option | M | Set to the uplink GRE key to be used for uplink GRE encapsulated packets sent over the PDN connection. | IETF RFC 5845 [7] | +| IPv4 Home Address Reply Option | C | Present if IPv4 address is allocated. When it's present, set the IPv4 Home Address to the IPv4 Home Address allocated for the UE's PDN connection based on the selected PDN corresponding to the EPS Access Point Name for dynamic allocation, or set to the static IPv4 Home Address received in the PBU for static allocation. The Prefix-len is set to a non-zero value.
NOTE 1 | IETF RFC 5844 [5] | +| IPv4 Default Router Address Option | C | This option shall be present if and only if IPv4 Home Address Reply Option is present and for trusted WLAN access if the transparent Single-connection mode is used.
The LMA sets the value of the UE's IPv4 default router address which belongs to the same subnet as the IPv4 Home Address allocated to the UE. | IETF RFC 5844 [5] | +| Service Selection Mobility Option | M | Copied from the corresponding field in the PBU message, formatted as defined in 3GPP TS 23.003 [12]. The encoding of the APN field follows 3GPP TS 23.003 [12] subclause 9.1 but excluding the trailing zero byte. The content of the APN field shall be the full APN with both the APN Network Identifier and APN Operator Identifier being present as specified in 3GPP TS 23.003 [12] subclauses 9.1.1 and 9.1.2.
NOTE 2. | IETF RFC 5149[11] | +| PDN Type Indication | C | This option shall be present if and only if PDN type is changed in the PDN GW compared to what was requested in the PBU. | Subclause 12.1.1.3 | +| DHCPv4 Address Allocation Procedure Indication | C | This option shall be present if and only if DHCPv4 is to be used to allocate the IPv4 address to the UE. | Subclause 12.1.1.5 | +| Protocol Configuration Options | O | Contain Protocol Configuration Options. | Subclause 12.1.1.0 | +| 3GPP Specific PMIPv6 Error Code | O | Contain 3GPP Specific PMIPv6 Error Code (on S5/S8/S2a) | Subclause 12.1.1.1 | +| LMA Fully Qualified PDN Connection Set Identifier | O | Contain a Fully Qualified PDN Connection Set Identifier if generated by the LMA on the S5/S8 interfaces as specified in 3GPP TS 23.007 [13]. | Subclause 12.1.1.2 | +| Charging ID | M | Contain the Charging ID information | Subclause 12.1.1.6 | +| APN Restriction | O | Contains the restriction of this PDN connection (on S5/S8). | Subclause 12.1.1.12 | +| PDN connection ID | O | Contains the PDN connection ID received in PBU | Subclause 12.1.1.15 | +| PGW Back-Off Time | O | This IE may be included on the S5/S8/S2a interfaces | Subclause 12.1.1.16 | + +| | | | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------| +| | | when the PDN GW rejects the Proxy Binding Update with the 3GSPEC set to "APN congestion". | | +| Additional Protocol Configuration Options | O | Contains Additional Protocol Configuration Options. | Subclause 12.1.1.19 | +| Access Network Identifier Option | O | Contains the access network identifier option received in PBU with the sub-options accepted (on S2a when TWAN access is used) | IETF RFC 6757 [37]
IETF RFC 7563 [41] | +| Redirect Mobility Option | O | The LMA may include this IE on the S5, S8, S2a and S2b interface if the LMA supports sending an alternate LMAA or IPv4-LMAA and the MAG indicated corresponding support in the PBU message. If so, the LMA shall include one instance of this IE and set it to the alternate LMAA or IPv4-LMAA (for an IPv6 or IPv4 transport network respectively). (see NOTE 3) | IETF RFC 6463 [43] | +| LMA User-Plane Address Mobility Option | O | The LMA may include this IE on the S5, S8, S2a and S2b interface if the LMA supports sending an alternate LMA address for user plane and the MAG indicated corresponding support in the PBU message. If so, the LMA shall include only one instance of this IE and set it to the IPv4 or IPv6 address for user plane (for an IPv4 or IPv6 transport network respectively). | IETF RFC 7389 [44] | +| NOTE 1: If the PDN type is IPv4v6 and DHCPv4 is to be used to allocate the IPv4 address to the UE, the IPv4 Home Address Reply Option shall not be included. | | | | +| NOTE 2: The APN field is not encoded as a dotted string as commonly used in documentation. | | | | +| NOTE 3: As specified in IETF RFC 6463 [43], a binding for the UE's PDN connection is created at the LMA (with the alternate LMAA or IPv4-LMAA) and thus the MAG does not need to send a new PBU to that LMA for creating such a binding. | | | | + +## 5.1.2 MAG procedures + +A MAG initiating the PMIPv6 PDN Connection Creation procedure shall follow the "Mobile Node Attachment and Initial Binding Registration" procedure described in the PMIPv6 IETF RFC 5213 [4] taking into account the corrections regarding the protocol number definition in IETF RFC6275 [8] and interworking solution specified in Annex B and IPv4 support for PMIPv6 IETF RFC 5844 [5] specifications with the following additional requirements: + +1. Generate a downlink GRE key that is not already in use locally for the PDN connection's downlink traffic to that UE, as specified in the GRE Key Option for PMIPv6 specification IETF RFC 5845 [7]. +2. For IP address allocation, the IPv6 Home Network Prefix option and/or the IPv4 Home Address Request option shall be present according to the UE request and the user subscription for non-3GPP access, or according to the PDN Type received from the MME/SGSN for 3GPP access. +3. If the static IPv4 Home Address and/or IPv6 Home Network Prefix are available at the MAG, set them in the IPv4 home address Request option and/or the IPv6 home prefix option in the PBU. +4. Optionally, assign a Fully Qualified PDN Connection Set Identifier that identifies a set of PDN connections belonging to an arbitrary number of UEs. +5. Provide a PDN connection ID, if multiple PDN connections to the same APN function is supported by the MAG. +6. Include the Redirect-Capability Mobility Option if the MAG supports the capability to receive from the LMA an alternate LMAA or IPv4-LMAA. +7. Include the LMA User Plane Address Mobility Option if the MAG supports the capability to receive from the LMA an alternate LMA address for user plane. +8. Set other parameters in the PBU as specified by the PBU parameters section for this procedure. + +## 5.1.3 LMA procedures + +On reception of a PBU, the LMA shall initiate the "Initial Binding Registration (New Mobility session)" and "Processing Binding Registrations" procedures described in the PMIPv6 IETF RFC 5213 [4] taking into account the corrections regarding the protocol number definition in IETF RFC6275 [8] and interworking solution specified in Annex B and IPv4 support for PMIPv6 IETF RFC 5844 [5] specifications with the following additional requirements: + +1. Select the PDN for the UE's PDN connection based on the APN present in the PBU. +2. Check if the received IPv6 Home prefix and/or IPv4 Home address are topologically correct. +3. If no static IPv6 Home Network Prefix and/or IPv4 Home Address were received in the PBU, allocate the IPv6 Home Network Prefix and/or an IPv4 Home Address for the selected PDN. +4. If a PCO with value IPv4 Address Allocation via DHCPv4 is present in the PBU, + - if the LMA allocates an IPv4 address, it shall include the IPv4 Home Address Reply Option in the PBA message + - if the LMA allocates an IPv6 prefix, the LMA shall not allocate an IPv4 address and shall not include the IPv4 Home Address Reply Option in the PBA message +5. Generate a uplink GRE key that is not already in use locally for the PDN connection's uplink traffic from that UE, as specified in the GRE Key Option for PMIPv6 specification IETF RFC 5845 [7]. +6. Assign to the UE an IPv6 Interface Identifier to allow formation of an UE Link Local Address from the well-known link local address prefix (fe80::/64). +7. Optionally, assign a Fully Qualified PDN Connection Set Identifier that identifies a set of PDN connections belonging to an arbitrary number of UEs. +8. If PDN connection ID was received in the PBU message, + - the LMA includes the received a PDN connection ID in the PBA message, if the multiple PDN connections to the same APN function is supported by the LMA; or + - the LMA ignores the received PDN connection ID and does not include it in the PBA message , if the multiple PDN connections to the same APN function is not supported by the LMA. +9. If the Redirect-Capability Mobility Option was received in the PBU message, optionally assign an alternate LMAA or IPv4-LMAA. +10. If the LMA User Plane Address Mobility Option was received in the PBU message, optionally assign an alternate LMA address for user plane. +11. Set parameters in the PBA as specified by the PBA parameters section for this procedure. + +## 5.2 Proxy Mobile IPv6 PDN Connection Lifetime Extension procedure + +### 5.2.1 General + +The PMIPv6 PDN Connection Lifetime Extension procedure is initiated by the node acting as a MAG to prolong the lifetime of an existing PDN connection with the node acting as an LMA for an UE that is already attached. This procedure may also be used when the MME is relocated and the MAG remains unchanged (see 3GPP TS 23.007 [13]). The procedure starts with the MAG sending a PBU to the LMA to extend the binding lifetime for the UE's PDN connection. The LMA confirms that the binding lifetime is extended by sending a PBA to the MAG. + +#### 5.2.1.1 Proxy Binding Update + +The fields of a PBU message for the PMIPv6 PDN Connection Lifetime Extension procedure are depicted in Table 5.2.1.1-1. + +The Mobility Options in a PBU message for the PMIPv6 PDN Connection Lifetime Extension procedure are depicted in Table 5.2.1.1-2. When the mobility option is present in the message, only the first instance shall be recognised. If multiple instances are included in the message, the receiver ignores all other instances. + +Other flags are not used by this specification. + +**Table 5.2.1.1-1: Fields of a PBU message for the PMIPv6 PDN Connection Lifetime Extension procedure** + +| Information element | IE Description | Reference | +|------------------------------------------|---------------------------------------------------------------------------------|--------------------| +| Sequence Number | Set to a locally (i.e. per MAG) monotonically increasing value. | IETF RFC 5213 [4] | +| Acknowledge (A) | Set to "1" to request an acknowledgement message. | IETF RFC 6275 [8] | +| Proxy Registration Flag (P) | Set to "1" to indicate that the Binding Update message is a proxy registration. | IETF RFC 5213 [4] | +| Force UDP encapsulation request (F) Flag | Set to "0" to indicate that UDP encapsulation is not used for the user plane. | IETF RFC 5555 [34] | +| Lifetime | Set to the requested number of time units the binding shall remain valid. | IETF RFC 6275 [8] | + +**Table 5.2.1.1-2: Mobility Options in a PBU message for the PMIPv6 PDN Connection Lifetime Extension procedure** + +| Information element | Cat. | IE Description | Reference | +|---------------------------------------------------|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------| +| Mobile Node Identifier option | M | Set to the UE NAI that is derived from the UE IMSI if an authenticated IMSI is available, or from the UE IMEI if IMSI is not available or the IMSI is not authenticated by the network. The NAI format is specified in 3GPP TS 23.003 [12]. | IETF RFC 5213 [4],
3GPP TS 23.003 [12] | +| IPv6 Home Network Prefix option | C | Set the Home Network Prefix to the IPv6 Home Network Prefix allocated to the UE's PDN connection based on the selected PDN and Prefix Length to the value "64".
NOTE 1. | IETF RFC 5213 [4] | +| Link-local Address | C | Present when IPv6 Home Network Prefix option is present. Set to the link-local address already allocated to the MAG (in the previous initial binding registration) for use on the access link shared with the UE. | IETF RFC 5213 [4] | +| Handoff Indicator option | M | Set to the value "5" to indicate handoff state not changed (Re-registration). | IETF RFC 5213 [4] | +| Access Technology Type option | M | Set to the 3GPP access type, i.e. GERAN, UTRAN, E-UTRAN or NB-IoT, or to the value matching the characteristics of the non-3GPP access (e.g., HRPD) the UE is using to attach to the EPS as defined in the Access Technology Type Option type values registry of the IANA Mobile IPv6 Parameters Registry [18].
The ePDG may use the access technology type of the untrusted non-3GPP access network if it is able to acquire it; otherwise it shall indicate Virtual as the access technology.
The TWAN shall set the Access Technology Type Option value to 4 i.e. "IEEE 802.11a/b/g" on the S2a interface.
NOTE 2
NOTE 3 | IETF RFC 5213 [4] | +| Timestamp option | M | Set to the current time | IETF RFC 5213 [4] | +| GRE Key option | M | Set to the previously exchanged downlink GRE key to be used for downlink GRE encapsulated packets sent over the PDN connection. | IETF RFC 5845 [7] | +| IPv4 Home Address Request option | C | Set the IPv4 Home Address to the IPv4 Home Address allocated for the UE's PDN connection based on the selected PDN and Prefix-len to the non-zero value received from LMA.
NOTE 1. | IETF RFC 5844 [5] | +| Service Selection Mobility Option | M | Set to the EPS Access Point Name to which the UE's PDN connection is attached.
The encoding of the APN field follows 3GPP TS 23.003 [12] subclause 9.1 but excluding the trailing zero byte. The content of the APN field shall be the full APN with both the APN Network Identifier and APN Operator Identifier being present as specified in 3GPP TS 23.003 [12] subclauses 9.1.1 and 9.1.2.
NOTE 4. | IETF RFC 5149[11] | +| MME Fully Qualified PDN Connection Set Identifier | O | Contain a Fully Qualified PDN Connection Set Identifier if generated by the MME, and included by the MAG on the S5/S8 interfaces as specified in 3GPP TS 23.007 [13]. | Subclause 12.1.1.2 | +| MAG Fully Qualified PDN Connection Set Identifier | O | Contain a Fully Qualified PDN Connection Set Identifier if generated by the MAG on the S5/S8, S2a (for Trusted WLAN Access) and S2b interfaces as specified in 3GPP TS 23.007 [13]. | Subclause 12.1.1.2 | +| PDN connection ID | C | Contains the PDN connection ID if the BULE contains the PDN Connection ID. | Subclause 12.1.1.15 | + +NOTE 1: At least one of the two options, namely, the IPv6 Home Network Prefix option or the IPv4 Home Address Request option shall be present. If the UE has both IPv4 home address and IPv6 home network prefix registered, both the IPv6 Home Network Prefix option and IPv4 Home Address Request option shall be included in the same PBU message. + +NOTE 2: The methods that the ePDG may use to acquire the access technology type of the untrusted non-3GPP IP access network are not specified in this release. + +NOTE 3: The PDN-GW can be informed about the type of access network used by the UE over several reference points, see 3GPP TS 29.212 [30] for the mapping between the code values for the + +different access network types. +NOTE 4: The APN field is not encoded as a dotted string as commonly used in documentation. + +### 5.2.1.2 Proxy Binding Acknowledgement + +The fields of a PBA message for the PMIPv6 PDN Connection Lifetime Extension procedure are depicted in Table 5.2.1.2-1. + +The Mobility Options in a PBA message for the PMIPv6 PDN Connection Lifetime Extension procedure are depicted in Table 5.2.1.2-2. When the mobility option is present in the message, only the first instance shall be recognised. If multiple instances are included in the message, the receiver ignores all other instances. + +Other flags are not used by this specification. + +Only the message fields and mobility options used for acceptance cases are present in the following tables. + +**Table 5.2.1.2-1: Fields of a PBA message for the PMIPv6 PDN Connection Lifetime Extension procedure** + +| Information element | IE Description | Reference | +|-----------------------------|---------------------------------------------------------------------------------|-------------------| +| Status | Set to indicate the result. | IETF RFC 6275 [8] | +| Proxy Registration Flag (P) | Set to "1" to indicate that the Binding Update message is a proxy registration. | IETF RFC 5213 [4] | +| Sequence Number | Set to the value received in the corresponding PBU. | IETF RFC 5213 [4] | +| Lifetime | Set to the granted number of time units the binding shall remain valid. | IETF RFC 6275 [8] | + +**Table 5.2.1.2-2: Mobility Options in a PBA message for the PMIPv6 PDN Connection Lifetime Extension procedure** + +| Information element | Cat. | IE Description | Reference | +|--------------------------------------------------------------------------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------| +| Mobile Node Identifier option | M | Copied from corresponding field of PBU. | IETF RFC 5213 [4] | +| IPv6 Home Network Prefix option | C | If it is present in the corresponding PBU, set the Home Network Prefix to the IPv6 Home Network Prefix allocated to the UE's PDN connection based on the selected PDN and Prefix Length to the value "64". | IETF RFC 5213 [4] | +| Link-local Address | C | Present when IPv6 Home Network Prefix option is present. Set to the link-local address already allocated to the MAG (in the previous initial binding registration) for use on the access link shared with the UE. | IETF RFC 5213 [4] | +| Handoff Indicator option | M | Copied from corresponding field of PBU. | IETF RFC 5213 [4] | +| Access Technology Type option | M | Copied from corresponding field of PBU. | IETF RFC 5213 [4] | +| Timestamp option | M | Copied from corresponding field of PBU, or set to the current time of LMA in case of timestamp error. | IETF RFC 5213 [4] | +| GRE key option | M | Set to the previously exchanged uplink GRE key to be used for uplink GRE encapsulated packets sent over the PDN connection. | IETF RFC 5845 [7] | +| IPv4 Home Address Reply Option | C | If it is present in the corresponding PBU, set the IPv4 Home Address to the IPv4 Home Address allocated for the UE's PDN connection based on the selected PDN and Prefix-len to the non-zero value present in the corresponding PBU. | IETF RFC 5844 [5] | +| IPv4 Default Router Address Option | C | This option shall be present if and only if IPv4 Home Address Reply Option is present and PBU is accepted. The LMA sets the value of the UE's IPv4 default router address which belongs to the same subnet as the IPv4 Home Address allocated to the UE. | IETF RFC 5844 [5] | +| Service Selection Mobility Option | M | Copied from the corresponding field in the PBU message.
The encoding of the APN field follows 3GPP TS 23.003 [12] subclause 9.1 but excluding the trailing zero byte. The content of the APN field shall be the full APN with both the APN Network Identifier and APN Operator Identifier being present as specified in 3GPP TS 23.003 [12] subclauses 9.1.1 and 9.1.2.
NOTE 1. | IETF RFC 5149[11] | +| 3GPP Specific PMIPv6 Error Code | O | Contain 3GPP Specific PMIPv6 Error Code (on S5/S8). | Subclause 12.1.1.1 | +| LMA Fully Qualified PDN Connection Set Identifier | O | Contain a Fully Qualified PDN Connection Set Identifier if generated by the LMA on the S5/S8 interfaces as specified in 3GPP TS 23.007 [13]. | Subclause 12.1.1.2 | +| PDN connection ID | C | Contains the PDN connection ID received in PBU | Subclause 12.1.1.15 | +| NOTE 1: The APN field is not encoded as a dotted string as commonly used in documentation. | | | | + +## 5.2.2 MAG procedures + +A MAG initiating the PMIPv6 PDN Connection Lifetime Extension procedure shall follow the "Extending Binding Lifetime" procedure described in the PMIPv6 [4] and IPv4 support for PMIPv6 [5] specifications, while parameters in the PBU are set as specified by the PBU parameters section for this procedure. When an MME FQ-CSID is received by the MAG during MME relocation, if the MAG supports the feature according to 3GPP TS 23.007 [13], it shall store the Node ID and CSID from the MME FQ-CSID for the PDN connection and forward the MME FQ-CSID to the LMA in the PBU. + +## 5.2.3 LMA procedures + +On reception of a PBU, the LMA shall initiate the "Binding Lifetime Extension without Handover" procedure as described in the PMIPv6 [4] and IPv4 support for PMIPv6 [5] specifications, while parameters in the PBA are set as specified by the PBA parameters section for this procedure. When an MME FQ-CSID is received by the LMA, if the + +LMA supports the feature according to 3GPP TS 23.007 [13], it shall store the Node-ID and CSID from the MME FQ-CSID in place of those previously stored for the PDN connection. + +## 5.3 Proxy Mobile IPv6 PDN Connection Handover procedure + +### 5.3.1 General + +The PMIPv6 PDN Connection Handover procedure is initiated by the node acting as a new MAG for the UE to update an existing PDN connection for an UE that is already attached to the EPC. The procedure starts with the new MAG sending a PBU including the APN to the LMA to update the binding for the UE's PDN connection. If multiple PDN connections to the same APN function is supported by the new MAG, a PDN connection ID shall also be included in the same PBU message. The LMA confirms update of the binding by sending a PBA to the MAG. If multiple PDN connections to the same APN function is supported by the LMA, the received PDN connection ID shall also be included in the same PBA message. Update of the binding achieves the following: + +- **IPv6 Home Network Prefix re-assignment:** The LMA re-assigns to the UE's PDN connection the IPv6 Home Network Prefix valid in the selected PDN. +- **IPv4 Home Address re-assignment:** The LMA re-assigns to the UE's PDN connection the IPv4 Home Address valid in the selected PDN. +- **Downlink and Uplink GRE Key Assignment:** The MAG and LMA will establish downlink and uplink GRE keys to be used for GRE encapsulation of downlink and uplink traffic, respectively on the PDN connection. +- **GRE Tunnel Establishment:** A GRE tunnel is established between the MAG and LMA with the assigned GRE keys to carry uplink and downlink traffic that UE respectively sends and receives on the PDN connection. +- **BCE Update:** The LMA updates or creates the BCE for the PDN connection. +- **BULE Creation: The new MAG creates a BULE for the PDN connection.** +- **IP address(es) preservation:** the IP addresses allocated in the previous initial attachment are reused if IP address(es) preservation decision is made. +- **MAG Link Local Address re-assignment:** The LMA re-assigns the same MAG link local address. +- **UE Interface Identifier (IID) re-assignment:** The LMA re-assigns to the UE the same IPv6 Interface Identifier to allow formation of the same UE Link Local Address from the well-known link local address prefix (fe80::/64). +- **PDN connection ID:** The PDN connection ID is provided by the MAG and accepted by LMA, if multiple PDN connections to the same APN function is supported by both MAG and LMA. +- **LMA Control Plane Address:** for handover between non-3GPP and 3GPP access, the LMA may assign a possibly different alternate LMAA or IPv4-LMAA if this option is supported by both MAG and LMA. For an intra-3GPP access handover, the LMA shall re-assign the same alternate LMAA or IPv4-LMAA if such an address was allocated during the PDN connection establishment or during a handover between non-3GPP and 3GPP access. +- **LMA User Plane Address:** for handover between non-3GPP and 3GPP access, the LMA may assign a possibly different alternate LMA address for user plane, if this option is supported by both MAG and LMA. For an intra-3GPP access handover, the LMA shall re-assign the same alternate LMA address for user plane if such an address was allocated during the PDN connection establishment or during a handover between non-3GPP and 3GPP access. + +The PMIPv6 LMA Initiated Update Notification procedure is then initiated by the LMA to notify the old MAG for handover with SGW relocation as specified in 3GPP TS 23.402 [3], to trigger the generation of End Marker by the MAG as specified in subclause 5.11. + +#### 5.3.1.1 Proxy Binding Update + +The fields of a PBU message for the PMIPv6 PDN Connection Handover procedure are depicted in Table 5.3.1.1-1. + +The Mobility Options in a PBU message for the PMIPv6 PDN Connection Handover procedure are depicted in Table 5.3.1.1-2. When the mobility option is present in the message, only the first instance shall be recognized. If multiple instances are included in the message, the receiver ignores all other instances. + +**Table 5.3.1.1-1: Fields of a PBU message for the PDN Connection Handover procedure** + +| Information element | IE Description | Reference | +|------------------------------------------|---------------------------------------------------------------------------------|--------------------| +| Sequence Number | Set to a locally (i.e. per MAG) monotonically increasing value. | IETF RFC 5213 [4] | +| Acknowledge (A) | Set to "1" to request an acknowledgement message. | IETF RFC 6275 [8] | +| Proxy Registration Flag (P) | Set to "1" to indicate that the Binding Update message is a proxy registration. | IETF RFC 5213 [4] | +| Force UDP encapsulation request (F) Flag | Set to "0" to indicate that UDP encapsulation is not used for the user plane. | IETF RFC 5555 [34] | +| Lifetime | Set to the requested number of time units the binding shall remain valid. | IETF RFC 6275 [8] | + +**Table 5.3.1.1-2: Mobility Options in a PBU message for the PMIPv6 PDN Connection Handover procedure** + +| Information element | Cat. | IE Description | Reference | +|-----------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------| +| Mobile Node Identifier option | M | Set to the UE NAI that is derived from the UE IMSI if an authenticated IMSI is available, or from the UE IMEI if IMSI is not available or the IMSI is not authenticated by the network. The NAI format is specified in 3GPP TS 23.003 [12]. | IETF RFC 5213 [4],
3GPP TS 23.003 [12] | +| IPv6 Home Network Prefix option | C | If available at the MAG, set the Home Network Prefix to the IPv6 Home Network Prefix allocated to the UE's PDN connection and Prefix Length to the value "64". Otherwise, set the Home Network Prefix to the value "0::0" and Prefix Length to the value "0" to request allocation for the UE's PDN connection of an IPv6 Home Network Prefix for the UE in the PDN corresponding to the EPS Access Point Name.
NOTE 1. | IETF RFC 5213 [4] | +| Link-local Address | C | Present when IPv6 Home Network Prefix option is present. If available, set to the link-local address already allocated to the MAG (in the previous initial binding registration) for use on the access link shared with the UE. If not available, set to ALL_ZERO (all bits set to 0), indicating that the MAG requests a link-local address. | IETF RFC 5213 [4] | +| Handoff Indicator option | M | Set to the value "2" (Handoff between two different interfaces) in case the handover is an inter access handover (i.e. from 3GPP to non-3GPP, from non-3GPP to 3GPP, or between two non-3GPP accesses) and IP address(es) preservation decision is taken; or
Set to the value "3" (Handoff between mobile access gateways for the same interface) in case the handover is an intra access (i.e. between two 3GPP accesses) handover; or
Set to the value "4" (Handoff state unknown) in case the handover is an inter access handover (i.e. from 3GPP to non-3GPP, from non-3GPP to 3GPP, or between two non-3GPP accesses) and IP address(es) preservation decision is negative or unknown. | IETF RFC 5213 [4] | +| Access Technology Type option | M | Set to the 3GPP access type, i.e., to GERAN, UTRAN or E-UTRAN, or to the value matching the characteristics of the non-3GPP access (e.g., HRPD) the UE is using to attach to the EPS as defined in the Access Technology Type Option type values registry of the IANA Mobile IPv6 Parameters Registry [18].
The ePDG may use the access technology type of the untrusted non-3GPP access network if it is able to acquire it; otherwise it shall indicate Virtual as the access technology.
The TWAN shall set the Access Technology Type Option value to 4 i.e. "IEEE 802.11a/b/g" on the S2a interface.
NOTE 2
NOTE 3 | IETF RFC 5213 [4] | +| Timestamp option | M | Set to the current time | IETF RFC 5213 [4] | +| GRE key option | M | Set to the downlink GRE key to be used for downlink GRE encapsulated packets sent over the PDN connection. | IETF RFC 5845 [7] | +| IPv4 Home Address Request option | C | If available at the MAG, set the IPv4 Home Address to the IPv4 Address allocated to the UE's PDN connection and Prefix-len to the value "32". Otherwise, set the IPv4 Home Address to the value "0.0.0.0" and Prefix-len to the value "0" or "32" to request allocation for the UE's PDN connection of an IPv4 Home Address in the PDN corresponding to the EPS Access Point Name.
NOTE 1. | IETF RFC 5844 [5] | +| Service Selection Mobility Option | M | Set to the EPS Access Point Name to which the UE's PDN connection is attached.
The encoding of the APN field follows 3GPP TS 23.003 | IETF RFC 5149[11] | + +| | | | | +|--|--|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | [12] subclause 9.1 but excluding the trailing zero byte.
The content of the APN field shall be the full APN with both the APN Network Identifier and APN Operator Identifier being present as specified in 3GPP TS 23.003
[12] subclauses 9.1.1 and 9.1.2.
NOTE 4. | | +|--|--|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| + +| | | | | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------| +| Protocol Configuration Options | O | Contain Protocol Configuration Options. | Subclause 12.1.1.0 | +| PDN GW IP Address | O | Contain PDN GW IP address (on S2a or S2b when used for chained S2a/S2b-PMIP based S8).. | Subclause 12.1.1.4 | +| MAG Fully Qualified PDN Connection Set Identifier | O | Contain a Fully Qualified PDN Connection Set Identifier if generated by the MAG on the S5/S8 interfaces as specified in 3GPP TS 23.007 [13]. | Subclause 12.1.1.2 | +| MME Fully Qualified PDN Connection Set Identifier | O | Contain a Fully Qualified PDN Connection Set Identifier if generated by the MME, and included by the MAG on the S5/S8 interfaces as specified in 3GPP TS 23.007 [13]. | Subclause 12.1.1.2 | +| Selection Mode | C | Contains APN selection mode (on S5/S8). Shall be present if the PDN connection is initiated by S4 SGSN or MME. | Subclause 12.1.1.7 | +| Charging Characteristics | O | Contains the Charging Characteristics to be applied for EPC charging | Subclause 12.1.1.8 | +| Serving Network | C | This IE shall be included on S2a (for TWAN access), S5 and S8 interfaces to identify the Serving Network. This IE may be included on S2a to identify the Serving Network of the eHRPD access network. | Subclause 12.1.1.9 | +| Mobile Equipment Identity | O | This IE shall contain the MEI of the UE and shall be present, if available, on the S5, S8, S2a or S2b interface. | Subclause 12.1.1.10 | +| MSISDN | O | This IE shall contain the MSISDN and shall be present, if available, on the S5, S8, S2a or S2b interfaces. | Subclause 12.1.1.11 | +| Maximum APN Restriction | O | Contains the most stringent restriction of already active PDN connections (on S5/S8). | Subclause 12.1.1.13 | +| PDN connection ID | O | Contains the PDN connection ID | Subclause 12.1.1.15 | +| Signalling Priority Indication | O | The SGW shall forward this IE on the S5/S8 interfaces during the handover from non-3GPP to 3GPP procedure. | Subclause 12.1.1.17 | +| MME/SGSN Identifier | O | The SGW shall include the MME/SGSN Identifier on the S5 interface if the SGW supports the PGW triggered SGW restoration procedure and this information is received from the MME/SGSN as specified in 3GPP TS 23.007 [13]. | Subclause 12.1.1.20 | +| Access Network Identifier Option | O | The TWAN shall include the access network identifier on S2a. | IETF RFC 6757 [37]
IETF RFC 7563 [41] | +| Trusted WLAN Mode Indication | O | Contains the selected trusted WLAN mode (SCM or MCM) on S2a interface. | Subclause 12.1.1.22 | +| UE Time Zone | O | The TWAN shall include the UE Timezone on the S2a interface. | Subclause 12.1.1.23 | +| Logical Access ID | O | Contains the Circuit-ID with the Relay Identity that allocated it. | Subclause 12.1.1.25 | +| Redirect-Capability Mobility Option | O | The MAG shall include this IE on the S5, S8, S2a and S2b interface if it supports the capability to receive from the LMA an alternate LMAA or IPv4-LMAA. | IETF RFC 6463 [43] | +| LMA User-Plane Address Mobility Option | O | The MAG shall include this IE on the S5, S8, S2a and S2b interface if it supports the capability to receive from the LMA an alternate LMA address for user plane. If so, the LMA User Plane Address field within this Mobility Option shall be a zero-length field, or have a value of ALL_ZERO with all bits in the IPv4 address or the IPv6 address set to zero. | IETF RFC 7389 [44] | +| TWAN capabilities | O | The MAG shall include this IE on the S2a interface if any of the applicable flags is set to 1.
Applicable flags are:
- WLCP PDN Connection Modification Support Indication: This flag shall be set to 1 on the S2a interface if the TWAN supports the WLCP PDN Connection Modification procedure. | Subclause 12.1.1.28 | +| NOTE 1: At least one of the two options, namely, the IPv6 Home Network Prefix option or the IPv4 Home Address Request option shall be present. If the MAG knows the UE has both IPv4 home address and IPv6 home network prefix registered, both the IPv6 Home Network Prefix option and IPv4 Home Address Request option shall be included in the same PBU message. | | | | +| NOTE 2: The methods that the ePDG may use to acquire the access technology type of the untrusted | | | | + +| | | +|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NOTE 3: | non-3GPP IP access network are not specified in this release.
The PDN-GW can be informed about the type of access network used by the UE over several reference points, see 3GPP TS 29.212 [30] for the mapping between the code values for the different access network types. | +| NOTE 4: | The APN field is not encoded as a dotted string as commonly used in documentation. | + +### 5.3.1.2 Proxy Binding Acknowledgement + +The fields of a PBA message for the PMIPv6 PDN Connection Handover procedure are depicted in Table 5.3.1.2-1. + +The Mobility Options in a PBA message for the PMIPv6 PDN Connection Handover procedure are depicted in Table 5.3.1.2-2. When the mobility option is present in the message, only the first instance shall be recognised. If multiple instances are included in the message, the receiver ignores all other instances. + +Other flags are not used by this specification. + +Only the message fields and mobility options used for acceptance cases are present in the following tables. + +**Table 5.3.1.2-1: Fields of a PBA message for the PMIPv6 PDN Connection Handover procedure** + +| Information element | IE Description | Reference | +|-----------------------------|---------------------------------------------------------------------------------|-------------------| +| Status | Set to indicate the result. | IETF RFC 6275 [8] | +| Proxy Registration Flag (P) | Set to "1" to indicate that the Binding Update message is a proxy registration. | IETF RFC 5213 [4] | +| Sequence Number | Set to the value received in the corresponding PBU. | IETF RFC 5213 [4] | +| Lifetime | Set to the granted number of time units the binding shall remain valid. | IETF RFC 6275 [8] | + +**Table 5.3.1.2-2: Mobility Options in a PBA message for the PMIPv6 PDN Connection Handover procedure** + +| Information element | Cat. | IE Description | Reference | +|--------------------------------------------------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------| +| Mobile Node Identifier option | M | Copied from corresponding field of PBU. | IETF RFC 5213 [4] | +| IPv6 Home Network Prefix option | C | Present if IPv6 Home Network Prefix is allocated. When it's present, set the Home Network Prefix to the IPv6 Home Network Prefix Allocated for the UE's PDN connection based on the selected PDN corresponding to the EPS Access Point Name for dynamic allocation, or set to the static IPv6 Home Network Prefix received in the PBU for static allocation. The Prefix Length is set to the value "64". In addition, the Interface Identifier (IID) allocated for the UE is encoded in the low order 64 bits of this option, i.e., the IPv6 Home Network Prefix option. | IETF RFC 5213 [4] | +| Link-local Address | C | Present when IPv6 Home Network Prefix option is present. Set to the link-local address already allocated to the MAG (in the previous initial binding registration) for use on the access link shared with the UE. | IETF RFC 5213 [4] | +| Handoff Indicator option | M | Copied from corresponding field of PBU. | IETF RFC 5213 [4] | +| Access Technology Type option | M | Copied from corresponding field of PBU. | IETF RFC 5213 [4] | +| Timestamp option | M | Copied from corresponding field of PBU, or set to the current time of LMA in case of timestamp error. | IETF RFC 5213 [4] | +| GRE key option | M | Set to the uplink GRE key to be used for uplink GRE encapsulated packets sent over the PDN connection. The same uplink GRE key used for the UE's PDN connection with the previous MAG shall be re-assigned. | IETF RFC 5845 [7] | +| IPv4 Home Address Reply Option | C | Present if IPv4 address is allocated. When it's present, set the IPv4 Home Address to the IPv4 Home Address allocated for the UE's PDN connection based on the selected PDN corresponding to the EPS Access Point Name for dynamic allocation, or set to the static IPv4 Home Address received in the PBU for static allocation. The Prefix-len is set to a non-zero value. | IETF RFC 5844 [5] | +| IPv4 Default Router Address Option | C | This option shall be present if and only if IPv4 Home Address Reply Option is present and for trusted WLAN access if the transparent Single-connection mode is used.
The LMA sets the value of the UE's IPv4 default router address which belongs to the same subnet as the IPv4 Home Address allocated to the UE. | IETF RFC 5844 [5] | +| Service Selection Mobility Option | M | Copied from the corresponding field in the PBU message.
The encoding of the APN field follows 3GPP TS 23.003 [12] subclause 9.1 but excluding the trailing zero byte. The content of the APN field shall be the full APN with both the APN Network Identifier and APN Operator Identifier being present as specified in 3GPP TS 23.003 [12] subclauses 9.1.1 and 9.1.2.
NOTE 1. | IETF RFC 5149 [11] | +| PDN Type Indication | C | This option shall be present if and only if PDN type is changed in the PDN GW compared to what was requested in the PBU. | Subclause 12.1.1.3 | +| PMIPv6 DHCPv4 Address Allocation Procedure Indication | C | This option shall be present if and only if DHCPv4 is to be used to allocate the IPv4 address to the UE. | Subclause 12.1.1.5 | +| Protocol Configuration Options | O | Contain Protocol Configuration Options. | Subclause 12.1.1.0 | +| 3GPP Specific PMIPv6 Error Code | O | Contain 3GPP Specific PMIPv6 Error Code (on S5/S8). | Subclause 12.1.1.1 | +| LMA Fully Qualified PDN Connection Set Identifier List | O | Contain a Fully Qualified PDN Connection Set Identifiers if generated by the LMA on the S5/S8 interfaces as specified in 3GPP TS 23.007 [13]. | Subclause 12.1.1.2 | +| Charging ID | M | Contain the Charging ID information | Subclause 12.1.1.6 | +| APN Restriction | O | Contains the restriction of this PDN connection (on | Subclause 12.1.1.12 | + +| | | | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------| +| | | S5/S8). | | +| PDN connection ID | O | Contains the PDN connection ID received in PBU | Subclause 12.1.1.15 | +| Static IP Address Allocation Indication | O | Contains Static IP Address Allocation Indication if the IPv4 address and/or IPv6 Home Network Prefix is statically allocated. See NOTE 2 | Subclause 12.1.1.18 | +| Access Network Identifier Option | O | Contains the access network identifier option received in PBU with the sub-options accepted (on S2a when TWAN access is used) | IETF RFC 6757 [37]
IETF RFC 7563 [41] | +| Redirect Mobility Option | O | The LMA may include this IE on the S5, S8, S2a and S2b interface if the LMA supports sending an alternate LMAA or IPv4-LMAA and the MAG indicated corresponding support in the PBU message. If so, the LMA shall include one instance of this IE and set it to the alternate LMAA or IPv4-LMAA (for an IPv6 or IPv4 transport network respectively). (see NOTE 3) | IETF RFC 6463 [43] | +| LMA User-Plane Address Mobility Option | O | The LMA may include this IE on the S5, S8, S2a and S2b interface if the LMA supports sending an alternate LMA address for user plane and the MAG indicated corresponding support in the PBU message. If so, the LMA shall include only one instance of this IE and set it to the IPv4 or IPv6 address for user plane (for an IPv4 or IPv6 transport network respectively). | IETF RFC 7389 [44] | +| NOTE 1: The APN field is not encoded as a dotted string as commonly used in documentation. | | | | +| NOTE 2: Static IP Address Allocation Indication is used by MAG to provide dynamic IPv4/v6 address flag information as specified in 3GPP TS 32.251 [25]. | | | | +| NOTE 3: As specified in IETF RFC 6463 [43], a binding for the UE's PDN connection is created at the LMA (with the alternate LMAA or IPv4-LMAA) and thus the MAG does not need to send a new PBU to that LMA for creating such a binding. | | | | + +### 5.3.2 MAG procedures + +A MAG initiating the PMIPv6 PDN Connection Handover procedure shall follow the "Mobile Node Attachment and Initial Binding Registration" procedure described in the PMIPv6 [4] and IPv4 support for PMIPv6 [5] specifications with the following additional requirements: + +1. Generate a downlink GRE key that is not already in use locally for the PDN connection's downlink traffic to that UE, as specified in the GRE Key Option for PMIPv6 specification [7]. +2. Provide a PDN connection ID, if multiple PDN connections to the same APN function is supported by the MAG. +3. Set other parameters in the PBU as specified by the PBU parameters section for this procedure. +4. Optionally, assign a Fully Qualified PDN Connection Set Identifier that identifies a set of PDN connections belonging to an arbitrary number of UEs. +5. Include the Redirect-Capability Mobility Option if the MAG supports the capability to receive from the LMA an alternate LMAA or IPv4-LMAA. +6. Include the LMA User Plane Address Mobility Option if the MAG supports the capability to receive from the LMA an alternate LMA address for user plane. + +### 5.3.3 LMA procedures + +On reception of a PBU, the LMA shall initiate the "Binding Lifetime Extension (After handoff)" and "Processing Proxy Binding Updates" procedures described in the PMIPv6 [4] and IPv4 support for PMIPv6 [5] specifications with the following additional requirements: + +1. Re-assign the same uplink GRE key that was used by the previous MAG for the PDN connection's uplink traffic from the UE, as specified in the GRE Key Option for PMIPv6 specification [7]. +2. Check if the received IPv6 Home prefix and/or IPv4 Home address are topologically correct. +3. Dynamic IP address allocation: + +- a) If Handoff Indicator option is "2" or "3": Re-allocate the IPv6 Home Network Prefix and/or the IPv4 Home Address for the selected PDN which were/was allocated during the previous attachment. + - b) If Handoff Indicator option is "4": Make the IP address preservation decision as per the PMIPv6 specification [4]. +- 3a. Static IP address allocation: If the IPv4 address and/or IPv6 Home Network Prefix is statically allocated, the LMA includes Static IP Address Allocation Indication in the PBA message. + 4. Optionally, assign or reuse a Fully Qualified PDN Connection Set Identifier that identifies a set of PDN connections belonging to an arbitrary number of UEs. + 5. If PDN connection ID was received in the PBU message, + - a) the LMA updates PDN connection ID in the BCE accordingly and includes the received a PDN connection ID in the PBA message, if the multiple PDN connections to the same APN function is supported by the LMA; or + - b) the LMA ignores the received PDN connection ID and does not include the received a PDN connection ID in the PBA message, if the multiple PDN to the same APN function is not supported by the LMA. + 6. If the Redirect-Capability Mobility Option was received in the PBU message, + - for handover between non-3GPP and 3GPP access, the LMA may assign a possibly different alternate LMAA or IPv4-LMAA; + - for an intra-3GPP access handover, the LMA shall re-assign the same alternate LMAA or IPv4-LMAA if such an address was allocated during the PDN connection establishment or during a handover between non-3GPP and 3GPP access. + 7. If the LMA User Plane Address Mobility Option was received in the PBU message, + - for handover between non-3GPP and 3GPP access, the LMA may assign a possibly different alternate LMA address for user plane; + - for an intra-3GPP access handover, the LMA shall re-assign the same alternate LMA address for user plane if such an address was allocated during the PDN connection establishment or during a handover between non-3GPP and 3GPP access. + 8. Set parameters in the PBA as specified by the PBA parameters section for this procedure. + +The LMA performs the lookup of BCE as described in subclause 5.8.3. If no existing BCE is found, the LMA shall follow the Proxy Mobile IPv6 PDN Connection Creation procedure as specified in section 5.1.3. + +## 5.4 Proxy Mobile IPv6 MAG Initiated PDN Connection Deletion procedure + +### 5.4.1 General + +The PMIPv6 MAG Initiated PDN Connection Deletion procedure is initiated by the node acting as a MAG to tear down an existing PDN connection with the node acting as an LMA. The procedure starts with the MAG sending a PBU to the LMA to deregister with the LMA a binding for the UE's PDN connection. The LMA confirms deregistration of the binding by sending a PBA to the MAG. Deregistration of the binding achieves the following: + +- **IPv6 Home Network Prefix deallocation:** When the PDN connection is released, the LMA returns the IPv6 Home Network Prefix assigned to the UE's PDN connection to the pool of free IPv6 Home Network Prefixes. +- **IPv4 Home Address deallocation:** When the PDN connection is released, the LMA returns the IPv4 Home Address assigned to the UE's PDN connection to the pool of free IPv4 Home Network Addresses. +- **Downlink and Uplink GRE Key de-assignment:** The MAG and LMA will return, respectively, the PDN connection's uplink and downlink GRE keys to their respective pool of free GRE keys. +- **GRE Tunnel Tear-down:** The GRE tunnel between the MAG and LMA is deleted. + +- **BCE Deletion:** The LMA deletes the BCE for the PDN connection. +- **BULE Deletion:** The MAG deletes the BULE for the PDN connection. + +#### 5.4.1.1 Proxy Binding Update + +The fields of a PBU message for the PMIPv6 MAG Initiated PDN Connection Deletion procedure are depicted in Table 5.4.1.1-1. + +The Mobility Options in a PBU message for the PMIPv6 MAG Initiated PDN Connection Deletion procedure are depicted in Table 5.4.1.1-2. When the mobility option is present in the message, only the first instance shall be recognised. If multiple instances are included in the message, the receiver ignores all other instances. + +Other flags are not used by this specification. + +**Table 5.4.1.1-1: Fields of a PBU message for the PMIPv6 MAG Initiated PDN Connection Deletion procedure** + +| Information element | IE Description | Reference | +|------------------------------------------|---------------------------------------------------------------------------------|--------------------| +| Sequence Number | Set to a locally (i.e. per MAG) monotonically increasing value. | IETF RFC 5213 [4] | +| Acknowledge (A) | Set to "1" to request an acknowledgement message. | IETF RFC 6275 [8] | +| Proxy Registration Flag (P) | Set to "1" to indicate that the Binding Update message is a proxy registration. | IETF RFC 5213 [4] | +| Force UDP encapsulation request (F) Flag | Set to "0" to indicate that UDP encapsulation is not used for the user plane. | IETF RFC 5555 [34] | +| Lifetime | Set to "0" to request deletion of the BCE. | IETF RFC 6275 [8] | + +**Table 5.4.1.1-2: Mobility Options in a PBU message for the PMIPv6 MAG Initiated PDN Connection Deletion procedure** + +| Information element | Cat. | IE Description | Reference | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------| +| Mobile Node Identifier option | M | Set to the UE NAI that is derived from the UE IMSI if an authenticated IMSI is available, or from the UE IMEI if IMSI is not available or the IMSI is not authenticated by the network. The NAI format is specified in 3GPP TS 23.003 [12]. | IETF RFC 5213 [4],
3GPP TS 23.003 [12] | +| IPv6 Home Network Prefix option | C | Set the Home Network Prefix to the IPv6 Home Network Prefix allocated to the UE's PDN connection based on the selected PDN and Prefix Length to the value "64".
NOTE 1. | IETF RFC 5213 [4] | +| Handoff Indicator option | M | Set to the value "4" to indicate Handoff state unknown. | IETF RFC 5213 [4] | +| Access Technology Type option | M | Set to the 3GPP access type, i.e., to GERAN, UTRAN, E-UTRAN or NB-IoT, or to the value matching the characteristics of the non-3GPP access (e.g., HRPD) the UE is using to attach to the EPS as defined in the Access Technology Type Option type values registry of the IANA Mobile IPv6 Parameters Registry [18].
The ePDG may use the access technology type of the untrusted non-3GPP access network if it is able to acquire it; otherwise it shall indicate Virtual as the access technology.
The TWAN shall set the Access Technology Type Option value to 4 i.e. "IEEE 802.11a/b/g" on the S2a interface.
NOTE 2
NOTE 3 | IETF RFC 5213 [4] | +| Timestamp option | M | Set to the current time | IETF RFC 5213 [4] | +| IPv4 Home Request Address option | C | Set the IPv4 Home Address to the IPv4 Home Address allocated for the UE's PDN connection based on the selected PDN and Prefix-len to the non-zero value received from the LMA.
NOTE 1. | IETF RFC 5844 [5] | +| Service Selection Mobility Option | M | Set to the EPS Access Point Name to which the UE's PDN connection is attached.
The encoding of the APN field follows 3GPP TS 23.003 [12] subclause 9.1 but excluding the trailing zero byte.
The content of the APN field shall be the full APN with both the APN Network Identifier and APN Operator Identifier being present as specified in 3GPP TS 23.003 [12] subclauses 9.1.1 and 9.1.2.
NOTE 4. | IETF RFC 5149[11] | +| Protocol Configuration Options | O | Contain Protocol Configuration Options. | Subclause 12.1.1.0 | +| PDN connection ID | C | Contains the PDN connection ID if the BULE contains the PDN Connection ID. | Subclause 12.1.1.15 | +| Access Network Identifier Option | O | The TWAN shall include the access network identifier on S2a. | IETF RFC 6757 [37]
IETF RFC 7563 [41] | +| UE Time Zone | O | The TWAN shall include the UE Timezone on the S2a interface. | Subclause 12.1.1.23 | +| Access Network Identifier Timestamp | O | The TWAN shall include the timestamp on the S2a interface if the Access Network Identifier option is present. It shall indicate the time when the TWAN acquired the Access Network Identifier. | Subclause 12.1.1.24 | +| NOTE 1: At least one of the two options, namely, the IPv6 Home Network Prefix option or the IPv4 Home Address Request option shall be present. If the UE has both IPv4 home address and IPv6 home network prefix registered, both the IPv6 Home Network Prefix option and IPv4 Home Address Request option shall be included in the same PBU message. | | | | +| NOTE 2: The methods that the ePDG may use to acquire the access technology type of the untrusted non-3GPP IP access network are not specified in this release. | | | | +| NOTE 3: The PDN-GW can be informed about the type of access network used by the UE over several reference points, see 3GPP TS 29.212 [30] for the mapping between the code values for the different access network types. | | | | +| NOTE 4: The APN field is not encoded as a dotted string as commonly used in documentation. | | | | + +### 5.4.1.2 Proxy Binding Acknowledgement + +The fields of a PBA message for the PMIPv6 MAG Initiated PDN Connection Deletion procedure are depicted in Table 5.4.1.2-1. + +The Mobility Options in a PBA message for the MAG Initiated PDN Connection Deletion procedure are depicted in Table 5.4.1.2-2. When the mobility option is present in the message, only the first instance shall be recognised. If multiple instances are included in the message, the receiver ignores all other instances. + +Other flags are not used by this specification. + +Only the message fields and mobility options used for acceptance cases are present in the following tables. + +**Table 5.4.1.2-1: Fields of a PBA message for the PMIPv6 MAG Initiated PDN Connection Deletion procedure** + +| Information element | IE Description | Reference | +|-----------------------------|---------------------------------------------------------------------------------|-------------------| +| Status | Set to indicate the result. | IETF RFC 6275 [8] | +| Proxy Registration Flag (P) | Set to "1" to indicate that the Binding Update message is a proxy registration. | IETF RFC 5213 [4] | +| Sequence Number | Set to a value received in the corresponding PBU. | IETF RFC 5213 [4] | +| Lifetime | Set to "0" to request deletion of the binding. | IETF RFC 6275 [8] | + +**Table 5.4.1.2-2: Mobility Options in a PBA message for the PMIPv6 MAG Initiated PDN Connection Deletion procedure** + +| Information element | Cat. | IE Description | Reference | +|------------------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------| +| Mobile Node Identifier option | M | Copied from corresponding field of PBU. | IETF RFC 5213 [4] | +| IPv6 Home Network Prefix option | C | If it is present in the corresponding PBU, set to the IPv6 Home Network Prefix allocated to the UE's PDN connection based on the selected PDN. | IETF RFC 5213 [4] | +| Handoff Indicator option | M | Copied from corresponding field of PBU. | IETF RFC 5213 [4] | +| Access Technology Type option | M | Copied from corresponding field of PBU. | IETF RFC 5213 [4] | +| Timestamp option | M | Copied from corresponding field of PBU, or set to the current time of LMA in case of timestamp error. | IETF RFC 5213 [4] | +| IPv4 Home Address Reply Option | C | If it is present in the corresponding PBU, set the IPv4 Home Address to the IPv4 Home Address allocated for the UE's PDN connection based on the selected PDN and Prefix-len to a non-zero value received in the corresponding PBU. | IETF RFC 5844 [5] | +| IPv4 Default Router Address Option | C | This option shall be present if and only if IPv4 Home Address Reply Option is present and PBU is accepted. The LMA sets the value of the UE's IPv4 default router address which belongs to the same subnet as the IPv4 Home Address allocated to the UE. | IETF RFC 5844 [5] | +| Service Selection Mobility Option | M | Copied from the corresponding field in the PBU message.
The encoding of the APN field follows 3GPP TS 23.003 [12] subclause 9.1 but excluding the trailing zero byte. The content of the APN field shall be the full APN with both the APN Network Identifier and APN Operator Identifier being present as specified in 3GPP TS 23.003 [12] subclauses 9.1.1 and 9.1.2.
NOTE 1. | IETF RFC 5149[11] | +| Protocol Configuration Options | O | Contain Protocol Configuration Options. | Subclause 12.1.1.0 | +| 3GPP Specific PMIPv6 Error Code | O | Contain 3GPP Specific PMIPv6 Error Code | Subclause 12.1.1.1 | +| PDN connection ID | C | Contains the PDN connection ID received in PBU | Subclause 12.1.1.15 | +| Access Network Identifier Option | O | Contains the access network identifier option received in PBU with the sub-options accepted (on S2a when TWAN access is used) | IETF RFC 6757 [37]
IETF RFC 7563 [41] | + +NOTE 1: The APN field is not encoded as a dotted string as commonly used in documentation. + +## 5.4.2 MAG procedures + +A MAG initiating the PMIPv6 Initial MAG Initiated PDN Connection Deletion procedure shall follow the "Mobile Node Detachment and Binding De-Registration" procedure described in the PMIPv6 [4] and IPv4 support for PMIPv6 [5] specifications, while parameters in the PBU are set as specified by the PBU parameters section for this procedure. + +## 5.4.3 LMA procedures + +On reception of a PBU, the LMA shall initiate the "Binding De-Registration" procedure described in the PMIPv6 [4] and IPv4 support for PMIPv6 [5] specifications, while parameters in the PBA are set as specified by the PBA parameters section for this procedure. + +# 5.5 Proxy Mobile IPv6 LMA Initiated PDN Connection Deletion procedure + +## 5.5.1 General + +In EPC the PMIPv6 LMA Initiated PDN Connection Deletion is initiated by the node acting as a LMA to notify the node acting as a MAG, that the Binding Cache Entry related to the UE is about to be deactivated, so the MAG should remove the resources related to that PDN connection. The procedure starts with the LMA sending a BRI to the MAG to revoke the binding. The MAG confirms the revocation of the binding by sending a BRA to the LMA. + +The LMA Initiated PDN Connection Deletion Procedure initiated by the LMA achieves the following: + +- **IPv6 Home Network Prefix release:** When the UE's PDN connection is deactivated, the LMA returns the IPv6 Home Network Prefix assigned to the UE's PDN connection to the pool of free IPv6 Home Network Prefixes. +- **IPv4 Home Address release:** When the UE's PDN connection is deactivated, the LMA returns the IPv4 Home Address assigned to the UE's PDN connection to the pool of free IPv4 Home Network Addresses. +- **Downlink and Uplink GRE keys de-assignment:** The MAG and LMA will return, respectively, the PDN connection's uplink and downlink GRE keys to their respective pool of free GRE keys. +- **GRE tunnel Deletion:** The GRE tunnel is removed from the LMA and the MAG. +- **BCE Deletion:** The LMA deletes the BCE for the PDN connection. +- **BULE Deletion:** The MAG deletes the BULE for the PDN connection. + +### 5.5.1.1 Binding Revocation Indication + +The fields of a BRI message for the PMIPv6 LMA Initiated PDN Connection Deletion procedure are depicted in Table 5.5.1.1-1. + +The Mobility Options in a BRI message for the LMA Initiated PDN Connection Deletion procedure are depicted in Table 5.5.1.1-2. When the mobility option is present in the message, only the first instance shall be recognised. If multiple instances are included in the message, the receiver ignores all other instances. + +**Table 5.5.1.1-1: Fields of a BRI message for the PMIPv6** + +| Information element | IE Description | Reference | +|------------------------------|---------------------------------------------------------------------------------------------------|-------------------| +| Revocation Trigger | Set to a value indicating the event which triggered the revoking node to send the BRI message | IETF RFC 5846 [6] | +| Sequence Number | A sequence number generated by the LMA, and increased for every BRI sent. | IETF RFC 5846 [6] | +| Proxy Binding Flag (P) | Set to "1" to indicate that the Binding Revocation Indication is for a proxy MIPv6 binding entry. | IETF RFC 5213 [4] | +| IPv4 HoA Binding Only (V) | Set to "0" to request for complete binding revocation | IETF RFC 5846 [6] | +| Global Per-Peer Bindings (G) | Set to 0 to indicate that the request is for a specific PMIPv6 BCE. | IETF RFC 5846 [6] | + +**Table 5.5.1.1-2: Mobility Options in a BRI message for the PMIPv6 LMA Initiated PDN Connection Deletion** + +| Information element | Cat. | IE Description | Reference | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------| +| Mobile Node Identifier option | M | Set to the UE NAI that is derived from the UE IMSI if an authenticated IMSI is available, or from the UE IMEI if IMSI is not available or the IMSI is not authenticated by the network. The NAI format is specified in 3GPP TS 23.003[12]. | IETF RFC 5213 [4],
3GPP TS 23.003[12] | +| IPv6 Home Network Prefix option | C | Set the Home Network Prefix to the Home Network Prefix of the UE's PDN connection.
Set the Prefix Length to the value "64".
NOTE 1. | IETF RFC 5213 [4] | +| IPv4 Home Address Request option | C | Set the IPv4 Home Address to the IPv4 home address of the UE's PDN connection.
Set the Prefix-len to the non-zero value which was sent to the MAG at PMIPv6 PDN connection creation procedure or Handover procedure.
NOTE 1. | IETF RFC 5844 [5] | +| Service Selection Mobility Option | M | Set to the EPS Access Point Name to which the UE's PDN connection is attached.
The encoding of the APN field follows 3GPP TS 23.003 [12] subclause 9.1 but excluding the trailing zero byte.
The content of the APN field shall be the full APN with both the APN Network Identifier and APN Operator Identifier being present as specified in 3GPP TS 23.003 [12] subclauses 9.1.1 and 9.1.2.
NOTE 2. | IETF RFC 5149[11] | +| Protocol Configuration Options | O | Contain Protocol Configuration Options. | Subclause 12.1.1.0 | +| PDN connection ID | C | Contains the PDN connection ID if the BCE contains the PDN Connection ID. | Subclause 12.1.1.15 | +| 3GPP Specific PMIPv6 Error Code | O | For the S5/S8 and S2a/S2b interfaces, contain 3GPP Specific PMIPv6 Error Code. | Subclause 12.1.1.1 | +| NOTE 1: At least one of the two options, namely, the IPv6 Home Network Prefix option or the IPv4 Home Address Request option shall be present. If the UE has both IPv4 home address and IPv6 home network prefix registered, both the IPv6 Home Network Prefix option and IPv4 Home Address Request option shall be included in the same BRI message. | | | | +| NOTE 2: The APN field is not encoded as a dotted string as commonly used in documentation. | | | | + +### 5.5.1.2 Binding Revocation Acknowledgment + +The fields of a BRA message for the PMIPv6 LMA Initiated PDN Connection Deletion procedure are depicted in Table 5.5.1.2-1. + +The Mobility Options in a BRA message for the LMA Initiated PDN Connection Deletion procedure are depicted in Table 5.5.1.2-2. When the mobility option is present in the message, only the first instance shall be recognised. If multiple instances are included in the message, the receiver ignores all other instances. + +Only the message fields and mobility options used for acceptance cases are present in the following tables. + +**Table 5.5.1.2-1: Fields of a BRA message for a PMIPv6 LMA Initiated PDN Connection Deletion** + +| Information element | IE Description | Reference | +|------------------------------|-------------------------------------------------------------------------------------------------------|-------------------| +| Status | Indicates the result of the BRI | IETF RFC 5846 [6] | +| Sequence Number | Set to the value received in the corresponding BRI. | IETF RFC 5846 [6] | +| Proxy Registration Flag (P) | Set to "1" to indicate that the Binding Revocation Acknowledgment is for a proxy MIPv6 binding entry. | IETF RFC 5213 [4] | +| IPv4 HoA Binding Only (V) | Set to "0"; the same value as for BRI | IETF RFC 5846 [6] | +| Global Per-Peer Bindings (G) | Set to "0"; the same value as for the BRI. | IETF RFC 5846 [6] | + +**Table 5.5.1.2-2: Mobility Options in a BRA message for the PMIPv6 LMA Initiated PDN Connection Deletion** + +| Information element | Cat. | IE Description | Reference | +|-------------------------------------|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------| +| Mobile Node Identifier option | M | Copied from corresponding field of BRI. | IETF RFC 5213 [4] | +| IPv6 Home Network Prefix option | C | Set the Home Network Prefix to the IPv6 Home Network Prefix of the UE's PDN connection received in BRI.
Set the Prefix Length to the value "64". | IETF RFC 5213 [4] | +| IPv4 Home Address Reply Option | C | Set the IPv4 Home Address to the IPv4 home address of the UE's PDN connection received in BRI.
Set the Prefix-len to the non-zero value received in BRI. | IETF RFC 5844 [5] | +| Service Selection Mobility Option | M | Copied from the corresponding field in the BRI message.
The encoding of the APN field follows 3GPP TS 23.003 [12] subclause 9.1 but excluding the trailing zero byte.
The content of the APN field shall be the full APN with both the APN Network Identifier and APN Operator Identifier being present as specified in 3GPP TS 23.003 [12] subclauses 9.1.1 and 9.1.2.
NOTE 1. | IETF RFC 5149[11] | +| Protocol Configuration Options | O | Contain Protocol Configuration Options | Subclause 12.1.1.0 | +| 3GPP Specific PMIPv6 Error Code | O | Contain 3GPP Specific PMIPv6 Error Code (on S5/S8). | Subclause 12.1.1.1 | +| PDN connection ID | C | Contains the PDN connection ID received in BRI | Subclause 12.1.1.15 | +| Access Network Identifier Option | O | The TWAN shall include the access network identifier on S2a. | IETF RFC 6757 [37] | +| Access Network Identifier Timestamp | O | The TWAN shall include the timestamp on the S2a interface if the Access Network Identifier option is present. It shall indicate the time when the TWAN acquired the Access Network Identifier. | Subclause 12.1.1.24 | +| UE Time Zone | O | The TWAN shall include the UE Timezone on the S2a interface. | Subclause 12.1.1.23 | + +NOTE 1: The APN field is not encoded as a dotted string as commonly used in documentation. + +## 5.5.2 MAG procedures + +The MAG shall follow the "Local Mobility Anchor Revokes a PMIPv6 Binding" procedure described in the IETF RFC 5846 [6]. The MAG should release the resources associated with the UE's PDN connection referred to in the BRI message. + +The MAG shall respond with a BRA. + +## 5.5.3 LMA procedures + +The LMA shall send a BRI to the MAG as described in the "Local Mobility Anchor Revokes a PMIPv6 binding" procedure described in the IETF RFC 5846 [6]. The LMA shall clear the BCE related to the UE's PDN connection after sending the BRI in case of UE detach. + +# 5.6 Proxy Mobile IPv6 PDN Connection IPv4 address allocation procedure + +## 5.6.1 General + +The IPv4 address allocation procedure is initiated by the node acting as a MAG when DHCPv4 message is received from the UE which requires a new IPv4 address. The MAG sends a PBU to LMA requesting a new IPv4 address for an existing PDN connection. The LMA assigns a new IPv4 address by sending a PBA to the MAG. IPv4 address assignment procedure achieves the following: + +- **IPv4 Home Address assignment:** The LMA assigns to the UE's PDN connection an IPv4 Home Address valid in the selected PDN. + +### 5.6.1.1 Proxy Binding Update + +The fields of a PBU message for the PMIPv6 PDN Connection IPv4 address allocation procedure are depicted in Table 5.6.1.1-1. + +The Mobility Options in a PBU message for the PMIPv6 PDN Connection IPv4 address allocation procedure are depicted in Table 5.6.1.1-2. When the mobility option is present in the message, only the first instance shall be recognised. If multiple instances are included in the message, the receiver ignores all other instances. + +Other flags are not used by this specification. + +**Table 5.6.1.1-1: Fields of a PBU message for the PMIPv6 PDN Connection IPv4 address allocation procedure** + +| Information element | IE Description | Reference | +|------------------------------------------|---------------------------------------------------------------------------------|--------------------| +| Sequence Number | Set to a locally (i.e. per MAG) monotonically increasing value. | IETF RFC 5213 [4] | +| Acknowledge (A) | Set to "1" to request an acknowledgement message. | IETF RFC 6275 [8] | +| Proxy Registration Flag (P) | Set to "1" to indicate that the Binding Update message is a proxy registration. | IETF RFC 5213 [4] | +| Force UDP encapsulation request (F) Flag | Set to "0" to indicate that UDP encapsulation is not used for the user plane. | IETF RFC 5555 [34] | +| Lifetime | Set to the requested number of time units the binding shall remain valid. | IETF RFC 6275 [8] | + +**Table 5.6.1.1-2: Mobility Options in a PBU message for the PMIPv6 PDN Connection IPv4 address allocation procedure** + +| Information element | Cat. | IE Description | Reference | +|-----------------------------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------| +| Mobile Node Identifier option | M | Set to the UE NAI that is derived from the UE IMSI if an authenticated IMSI is available, or from the UE IMEI if IMSI is not available or the IMSI is not authenticated by the network. The NAI format is specified in 3GPP TS 23.003 [12]. | IETF RFC 5213 [4],
3GPP TS 23.003 [12] | +| IPv6 Home Network Prefix option | M | Set the Home Network Prefix to the IPv6 Home Network Prefix allocated to the UE's PDN connection based on the selected PDN and Prefix Length to the value "64". | IETF RFC 5213 [4] | +| Link-local Address | M | Set to the link-local address already allocated to the MAG (in the previous initial binding registration) for use on the access link shared with the UE. | IETF RFC 5213 [4] | +| Handoff Indicator option | M | Set to the value "5" to indicate handoff state not changed (Re-registration). | IETF RFC 5213 [4] | +| Access Technology Type option | M | Set to the 3GPP access type, i.e., to GERAN, UTRAN, E-UTRAN or NB-IoT, or to the value matching the characteristics of the non-3GPP access (e.g., HRPD) the UE is using to attach to the EPS as defined in the Access Technology Type Option type values registry of the IANA Mobile IPv6 Parameters Registry [18].
NOTE 1 | IETF RFC 5213 [4] | +| Timestamp option | M | Set to the current time | IETF RFC 5213 [4] | +| IPv4 Home Address Request option | M | For dynamic allocation, set the IPv4 Home Address to the value "0.0.0.0" and Prefix-len to the value "0" or "32" to request allocation for the UE's PDN connection of an IPv4 Home Address in the PDN corresponding to the EPS Access Point Name. For static allocation, set the IPv4 Home Address to the received static allocated IPv4 Home Address and Prefix-len to the value "32". | IETF RFC 5844 [5] | +| Service Selection Mobility Option | M | Set to the EPS Access Point Name to which the UE's PDN connection is attached.
The encoding of the APN field follows 3GPP TS 23.003 [12] subclause 9.1 but excluding the trailing zero byte. The content of the APN field shall be the full APN with both the APN Network Identifier and APN Operator Identifier being present as specified in 3GPP TS 23.003 [12] subclauses 9.1.1 and 9.1.2.
NOTE 2. | IETF RFC 5149[11] | +| PDN connection ID | C | Contains the PDN connection ID if the BULE contains the PDN Connection ID. | Subclause 12.1.1.15 | + +NOTE 1: The PDN-GW can be informed about the type of access network used by the UE over several reference points, see 3GPP TS 29.212 [30] for the mapping between the code values for the different access network types. + +NOTE 2: The APN field is not encoded as a dotted string as commonly used in documentation. + +### 5.6.1.2 Proxy Binding Acknowledgement + +The fields of a PBA message for the PMIPv6 PDN Connection IPv4 address allocation procedure are depicted in Table 5.6.1.2-1. + +The Mobility Options in a PBA message for the PMIPv6 PDN Connection IPv4 address allocation procedure are depicted in Table 5.6.1.2-2. When the mobility option is present in the message, only the first instance shall be recognised. If multiple instances are included in the message, the receiver ignores all other instances. + +Other flags are not used by this specification. + +Only the message fields and mobility options used for acceptance cases are present in the following tables. + +**Table 5.6.1.2-1: Fields of a PBA message for the PMIPv6 PDN Connection IPv4 address allocation procedure** + +| Information element | IE Description | Reference | +|-----------------------------|---------------------------------------------------------------------------------|-------------------| +| Status | Set to indicate the result. | IETF RFC 6275 [8] | +| Proxy Registration Flag (P) | Set to "1" to indicate that the Binding Update message is a proxy registration. | IETF RFC 5213 [4] | +| Sequence Number | Set to the value received in the corresponding PBU. | IETF RFC 5213 [4] | +| Lifetime | Set to the granted number of time units the binding shall remain valid. | IETF RFC 6275 [8] | + +**Table 5.6.1.2-2: Mobility Options in a PBA message for the PMIPv6 PDN Connection IPv4 address allocation procedure** + +| Information element | Cat. | IE Description | Reference | +|------------------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------| +| Mobile Node Identifier option | M | Copied from corresponding field of PBU. | IETF RFC 5213 [4] | +| IPv6 Home Network Prefix option | M | Set the Home Network Prefix to the IPv6 Home Network Prefix allocated to the UE's PDN connection based on the selected PDN and Prefix Length to the value "64". | IETF RFC 5213 [4] | +| Link-local Address | M | Set to the link-local address already allocated to the MAG (in the previous initial binding registration) for use on the access link shared with the UE. | IETF RFC 5213 [4] | +| Handoff Indicator option | M | Copied from corresponding field of PBU. | IETF RFC 5213 [4] | +| Access Technology Type option | M | Copied from corresponding field of PBU. | IETF RFC 5213 [4] | +| Timestamp option | M | Copied from corresponding field of PBU, or set to the current time of LMA in case of timestamp error. | IETF RFC 5213 [4] | +| IPv4 Home Address Reply option | M | Set the IPv4 Home Address to the IPv4 Home Address allocated for the UE's PDN connection based on the selected PDN corresponding to the EPS Access Point Name for dynamic allocation, or set to the static IPv4 Home Address received in the PBU for static allocation. The Prefix-len is set to a non-zero value. | IETF RFC 5844 [5] | +| IPv4 Default Router Address Option | M | The LMA sets the value of the UE's IPv4 default router address which belongs to the same subnet as the IPv4 Home Address allocated to the UE. | IETF RFC 5844 [5] | +| Service Selection Mobility Option | M | Copied from the corresponding field in the PBU message.
The encoding of the APN field follows 3GPP TS 23.003 [12] subclause 9.1 but excluding the trailing zero byte. The content of the APN field shall be the full APN with both the APN Network Identifier and APN Operator Identifier being present as specified in 3GPP TS 23.003 [12] subclauses 9.1.1 and 9.1.2.
NOTE 1. | IETF RFC 5149[11] | +| 3GPP Specific PMIPv6 Error Code | O | Contain 3GPP Specific PMIPv6 Error Code (on S5/S8). | Subclause 12.1.1.1 | +| PDN connection ID | C | Contains the PDN connection ID received in PBU | Subclause 12.1.1.15 | + +NOTE 1: The APN field is not encoded as a dotted string as commonly used in documentation. + +## 5.6.2 MAG procedures + +The MAG initiating IPv4 Address Allocation using DHCPv4 procedure shall follow the "Extending Binding Lifetime" procedure described in the PMIPv6 [4] and "DHCP Relay Agent co-located with MAG" or "DHCP Server co-located with MAG" procedure as described in IPv4 support for PMIPv6 [5] specifications, while parameters in the PBU are set as specified by the PBU parameters section for this procedure. + +1. If the static IPv4 Home Address is available at the MAG, set it in the IPv4 home address Request option in the PBU. +2. Set other parameters in the PBU as specified by the PBU parameters section for this procedure. + +### 5.6.3 LMA procedures + +On reception of a PBU, the LMA shall initiate the "Binding Lifetime Extension without Handover" procedures as described in the PMIPv6 [4] and IPv4 support for PMIPv6 [5] specifications with the following additional requirements: + +1. Check if the received IPv4 Home address is topologically correct. +2. Allocate an IPv4 Home Address for the selected PDN. +3. Set parameters in the PBA as specified by the PBA parameters section for this procedure. + +## 5.7 Proxy Mobile IPv6 LMA Initiated IPv4 Address Release procedure + +### 5.7.1 General + +In the case when UE is assigned both IPv6 HNP and IPv4 Home Address, if IPv4 Address lease expires or DHCPv4 Release procedure, the node acting as LMA initiates IPv4 Address Release procedure to notify the node acting as MAG about release of IPv4 address of UE for a certain PDN connection. LMA indicates MAG by sending a BRI and MAG confirms by replying with a BRA as described in IETF RFC 5846 [6]. + +LMA Initiated IPv4 Address Release procedure achieves the following: + +- **IPv4 Home Address release:** The LMA returns the IPv4 Home Address assigned to the UE's PDN connection to the pool of free IPv4 Home Network Addresses. + +#### 5.7.1.1 Binding Revocation Indication + +The fields of a BRI message for the PMIPv6 LMA Initiated PDN Connection Deletion procedure are depicted in Table 5.7.1.1-1. + +The Mobility Options in a BRI message for the LMA Initiated PDN Connection Deletion procedure are depicted in Table 5.7.1.1-2. When the mobility option is present in the message, only the first instance shall be recognised. If multiple instances are included in the message, the receiver ignores all other instances. + +**Table 5.7.1.1-1: Fields of a BRI message for the LMA Initiated IPv4 Address Release** + +| Information element | IE Description | Reference | +|------------------------------|---------------------------------------------------------------------------------------------------|-------------------| +| Revocation Trigger | Set to a value indicating the event which triggered the revoking node to send the BRI message. | IETF RFC 5846 [6] | +| Sequence Number | A sequence number generated by the LMA, and increased for every BRI sent. | IETF RFC 5846 [6] | +| Proxy Binding Flag (P) | Set to "1" to indicate that the Binding Revocation Indication is for a proxy MIPv6 binding entry. | IETF RFC 5213 [4] | +| IPv4 HoA Binding Only (V) | Set to "1" to revoke IPv4 address only | IETF RFC 5846 [6] | +| Global Per-Peer Bindings (G) | Set to 0 to indicate that the request is for a specific PMIPv6 BCE. | IETF RFC 5846 [6] | + +**Table 5.7.1.1-2: Mobility Options in a BRI message for the LMA Initiated IPv4 Address Release** + +| Information element | Cat. | IE Description | Reference | +|-----------------------------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------| +| Mobile Node Identifier option | M | Set to the UE NAI that is derived from the UE IMSI if an authenticated IMSI is available, or from the UE IMEI if IMSI is not available or the IMSI is not authenticated by the network. The NAI format is specified in 3GPP TS 23.003[12]. | IETF RFC 5213 [4],
3GPP TS 23.003[12] | +| IPv4 Home Address Request option | M | Set the IPv4 Home Address to the IPv4 home address of the UE's PDN connection and Prefix-len to the non-zero value which was sent to the MAG at PMIPv6 PDN connection creation procedure or Handover procedure. | IETF RFC 5844 [5] | +| Service Selection Mobility Option | M | Set to the EPS Access Point Name to which the UE's PDN connection is attached.
The encoding of the APN field follows 3GPP TS 23.003 [12] subclause 9.1 but excluding the trailing zero byte. The content of the APN field shall be the full APN with both the APN Network Identifier and APN Operator Identifier being present as specified in 3GPP TS 23.003 [12] subclauses 9.1.1 and 9.1.2.
NOTE 1. | IETF RFC 5149[11] | +| PDN connection ID | C | Contains the PDN connection ID if the BCE contains the PDN Connection ID. | Subclause 12.1.1.15 | + +NOTE 1: The APN field is not encoded as a dotted string as commonly used in documentation. + +### 5.7.1.2 Binding Revocation Acknowledgment + +The fields of a BRA message for the PMIPv6 LMA Initiated PDN Connection Deletion procedure are depicted in Table 5.7.1.2-1. + +The Mobility Options in a BRA message for the LMA Initiated PDN Connection Deletion procedure are depicted in Table 5.7.1.2-2. When the mobility option is present in the message, only the first instance shall be recognised. If multiple instances are included in the message, the receiver ignores all other instances. + +Only the message fields and mobility options used for acceptance cases are present in the following tables. + +**Table 5.7.1.2-1: Fields of a BRA message for a LMA Initiated IPv4 Address Release** + +| Information element | IE Description | Reference | +|------------------------------|---------------------------------------------------------------------------------------------------|-------------------| +| Status | Indicates the result of the BRI | IETF RFC 5846 [6] | +| Sequence Number | Set to the value received in the corresponding BRI. | IETF RFC 5846 [6] | +| Proxy Binding Flag (P) | Set to "1" to indicate that the Binding Revocation Indication is for a proxy MIPv6 binding entry. | IETF RFC 5213 [4] | +| IPv4 HoA Binding Only (V) | Set to "1"; the same value as for BRI | IETF RFC 5846 [6] | +| Global Per-Peer Bindings (G) | Set to 0 to indicate that the request is for a specific PMIPv6 BCE. | IETF RFC 5846 [6] | + +**Table 5.7.1.2-2: Mobility Options in a BRA message for the LMA Initiated IPv4 Address Release** + +| Information element | Cat. | IE Description | Reference | +|--------------------------------------------------------------------------------------------|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------| +| Mobile Node Identifier option | M | Copied from corresponding field of BRI. | IETF RFC 5213 [4] ,
3GPP TS 23.003 [12] | +| IPv4 Home Address Reply Option | M | Set the IPv4 Home Address to the IPv4 home address of the UE's PDN connection received in BRI.
Set the Prefix-len to the non-zero value received in BRI. | IETF RFC 5844 [5] | +| Service Selection Mobility Option | M | Copied from the corresponding field in the BRI message.
The encoding of the APN field follows 3GPP TS 23.003 [12] subclause 9.1 but excluding the trailing zero byte.
The content of the APN field shall be the full APN with both the APN Network Identifier and APN Operator Identifier being present as specified in 3GPP TS 23.003 [12] subclauses 9.1.1 and 9.1.2.
NOTE 1. | IETF RFC 5149[11] | +| 3GPP Specific PMIPv6 Error Code | O | Contain 3GPP Specific PMIPv6 Error Code (on S5/S8) | Subclause 12.1.1.1 | +| PDN connection ID | C | Contains the PDN connection ID received in BRI | Subclause 12.1.1.15 | +| NOTE 1: The APN field is not encoded as a dotted string as commonly used in documentation. | | | | + +## 5.7.2 MAG procedures + +The MAG shall follow the procedure for Revocation Trigger in BRI as "IPv4 HoA only" in "Binding Revocation Responder" sub-section of "Mobile Access Gateway" described in the IETF RFC 5846 [6]. The MAG shall respond with a BRA. BRA message parameters are set as per the details in BRA section of the procedure. + +## 5.7.3 LMA procedures + +The LMA shall send a BRI to the MAG as described for revoking IPv4 address only in the "Binding Revocation Initiator" sub-section of "Local Mobility Anchor" described in the IETF RFC 5846 [6]. The LMA shall delete the IPv4 Address from corresponding BCE related to the UE's PDN connection after receiving the BRA in reply to the BRI sent from LMA. BRI message parameters are set as per the details in BRI section of the procedure. + +# 5.8 Proxy Mobile IPv6 Multiple PDN Extensions + +## 5.8.1 General + +In EPC a UE can connect or disconnect to multiple distinct PDNs in an independent manner. Thus a distinct PMIPv6 BCE and BULE exist for each of the PDN connections of an UE. + +Supporting multiple PDN connections to the same APN function is optional for MAG and LMA. A MAG which supports the multiple PDN connections to the same APN function shall include PDN connection ID in the PBU message at initial attach/handover procedure. If the LMA supports the multiple PDN connections to the same APN function, it shall include the received PDN connection ID in the PBA message. If the LMA does not support the multiple PDN connections to the same APN function, it shall ignore the received PDN connection ID and shall not include the PDN connection ID in the PBA message. If the received PBA message does not contain a PDN connection ID, the MAG shall not send any PBU message for additional PDN connectivity request to the same APN for the same UE. + +## 5.8.2 Extensions to PMIPv6 Data Structure + +There shall be a unique BCE and BULE for each PDN connection. Each PDN connection can be uniquely identified by MN ID, an APN, and optionally a PDN connection ID in the BCE and BULE. + +To support Multiple PDNs the MAG and LMA maintains extended data structure compared to the standard PMIPv6 as defined in IETF RFC 5213 [4]. Since multiple PDN connections of a UE can be distinguished based on an APN, both the BCE on the LMA and the BULE on the MAG need to be extended with the following additional field: + +- APN of a UE's PDN connection. + +Moreover, to support multiple PDN connections to the same APN function, the MAG and LMA shall maintain extended data structure compared to the PMIPv6 data structure described above. This extension is only applicable if multiple PDN connections to the same APN function is supported by both MAG and LMA. + +Since the multiple PDN connections with the same APN of a UE shall be distinguished based on MN ID, an APN, and a PDN connection ID, both the BCE on the LMA and the BULE on the MAG need to be extended with the following additional field: + +- PDN connection ID of a UE's PDN connection. The PDN connection ID is provided by the MAG to the LMA at PDN Connection Creation procedure or Handover procedure. For S2a/S2b interface, the MAG generates the PDN connection ID which shall be unique per MN-ID per APN. How the MAG generates the PDN Connection ID for the S2a and S2b reference points is out of scope of 3GPP. For S5/S8 interface, the MAG uses the EPS bearer identity of the default bearer as PDN connection ID. + +## 5.8.3 Extensions to PMIPv6 BULE and BCE Lookups + +### 5.8.3.1 General + +To support Multiple PDNs the MAG and LMA perform extended lookups on the extended data structure compared to the standard PMIPv6 as defined in IETF RFC 5213 [4]. + +In standard PMIPv6 as defined in IETF RFC 5213 [4], a PMIPv6 BCE/BULE is looked up based on the Mobile Node Identifier (MN-Id), the access technology types (ATT) and if it exist the MN's link-layer identifier (MN-LL-Id). + +In EPC the MN-LL-Id is not used and the EPC support handover between different interfaces for handover between non-3GPP and 3GPP accesses. + +Distinct PMIPv6 BCE and BULE exist for each of the PDN connections of an UE. + +The feature of having multiple PDN connections to the same APN is only supported if both MAG and LMA support it. + +### 5.8.3.2 Extensions to PMIPv6 BCE Lookups + +If the multiple PDN connections to the same APN feature is not supported, all PDN connections of a UE can be distinguished based on an APN and there is a one-to-one mapping between a PMIPv6 BCE, a PDN connection, and the (MN-Id, APN) tuple. An UE PDN connection can be uniquely identified by a (MN-Id, APN) tuple, the BCE is accordingly looked up on a per (MN-Id, APN) tuple basis. + +If the multiple PDN connections to the same APN feature is supported, the LMA shall store the received PDN connection ID in the BCE. There is a one-to-one mapping between a PMIPv6 BCE, a PDN connection, and the (MN-Id, APN, PDN connection ID) tuple. Thus, an UE PDN connection can be uniquely identified by a (MN-Id, APN, PDN connection ID) tuple. The BCE is accordingly looked up as follows: + +- If a PDN connection ID is received in the request message, the PMIPv6 BCE is looked up based on the (MN-Id, APN, PDN connection ID) tuple. If no existing binding is found based on the (MN-Id, APN, PDN connection ID) tuple, the LMA shall re-perform the PMIPv6 BCE lookup based on a per (MN-Id, APN) tuple. +- If a PDN connection ID is not received in the request message, the PMIPv6 BCE lookup is based on a per (MN-Id, APN) tuple. + +### 5.8.3.3 Extensions to PMIPv6 BULE Lookups + +If the multiple PDN connections to the same APN feature is not supported, an UE PDN connection can be uniquely identified by a (MN-Id, APN) tuple. In this case the BULE is accordingly looked up on a per (MN-Id, APN) tuple basis. + +If the multiple PDN connections to the same APN feature is supported, the MAG shall generate a PDN connection ID per PDN connection and store it in the BULE. Thus, there is a one-to-one mapping between a PMIPv6 BULE, a PDN connection, and the (MN-Id, APN, PDN connection ID) tuple. An UE PDN connection can be uniquely identified by a per (MN-Id, APN, PDN connection ID) tuple. The BULE is accordingly looked up on a per (MN-Id, APN, PDN connection ID) tuple basis. + +## 5.8.4 Extensions to PMIPv6 Procedure + +### 5.8.4.1 General + +The processing rules on the received PMIPv6 message are specified in IETF RFC 5213 [4] and IETF RFC 5844 [5]. This subclause specifies the additional PMIPv6 procedures. + +### 5.8.4.2 MAG procedure + +If the PMIPv6 PBU retransmission is triggered, a PMIPv6 PBU message with identical mobility options, except the value of the Timestamp option is new, shall be sent. + +### 5.8.4.3 LMA procedure + +If before responding to a received PMIPv6 PBU message, a new PMIPv6 PBU message with the same MN-ID, APN (and PDN connection ID) mobility options is received, then the LMA may respond to one or all of the received PMIPv6 PBU messages. + +If the LMA receives a PMIPv6 PBU message with HI = 1 from the same MAG and an existing BCE with the same MN-ID, APN (and PDN connection ID) is found, the LMA may refresh the BCE or release the old BCE and create a new one based on the received PBU message. + +## 5.9 Serving GW Procedure at Chaining Case + +### 5.9.1 General + +Chained S2a/S2b with GTP-based S8 is not supported in this release. + +Chained S2a/S2b with PMIP-based S8 is used when VPLMN has business relationship with Non-3GPP Networks and Serving GW in VPLMN supporting a LMA function as local non-3GPP Anchor. + +### 5.9.2 Signalling procedures + +When either of the S2a or S2b interfaces is chained with a PMIP-based S8 interface, the Serving GW acts as the signaling endpoint for each interface. On the S2a or S2b interface, the Serving GW acts as an LMA. On the chained PMIP-based S8 interface, the Serving GW acts as MAG. When a procedure is initiated by its peer on a given interface for a given PDN connection, the Serving GW shall trigger an equivalent procedure over the chained interface for the designated PDN connection. The procedure initiated by its peer cannot be completed before the completion of the equivalent procedure initiated over the chained interface. + +#### 5.9.2.1 PMIP-based S8 Serving GW procedures + +Upon receiving a PMIPv6 message over S8 for an LMA initiated procedure for a given PDN connection, the Serving GW shall initiate the corresponding LMA procedure over S2a or S2b for the designated PDN connection. + +Upon receiving a PMIPv6 message over S2a or S2b for a MAG initiated procedure for a given PDN connection, the Serving GW shall initiate the corresponding MAG procedure over PMIP-based S8 for the designated PDN connection. + +**Table 5.9.2.1-1: procedure, message and IE mapping at PMIPv6 based S8** + +| Initiated procedure | Messages | Initiating interface | Chained interface | Corresponding procedure
Chained interface | Corresponding messages | +|---------------------------------------------------------------------|----------|----------------------|-------------------|---------------------------------------------------------------------|------------------------| +| PDN Connection Creation as specified in subclause 5.1 | PBU/PBA | S2a or S2b | PMIPv6 based S8 | PDN Connection Creation as specified in subclause 5.1 | PBU/PBA | +| PDN Connection Lifetime Extension as specified in subclause 5.2 | PBU/PBA | S2a or S2b | PMIPv6 based S8 | PDN Connection Lifetime Extension as specified in subclause 5.2 | PBU/PBA | +| PDN Connection Handover as specified in subclause 5.3 | PBU/PBA | S2a or S2b | PMIPv6 based S8 | PDN Connection Handover as specified in subclause 5.3 | PBU/PBA | +| MAG Initiated PDN Connection Deletion as specified in subclause 5.4 | PBU/PBA | S2a or S2b | PMIPv6 based S8 | MAG Initiated PDN Connection Deletion as specified in subclause 5.4 | PBU/PBA | +| LMA Initiated PDN Connection Deletion as specified in subclause 5.5 | BRI/BRA | PMIPv6 based S8 | S2a or S2b | LMA Initiated PDN Connection Deletion as specified in subclause 5.5 | BRI/BRA | + +### 5.9.3 Payload packets at chained case + +When the S2a or S2b interfaces is chained with a PMIP-based S8 interface, both uplink and downlink payload packets are forwarded by the Serving GW between the S2a or S2b PMIPv6 GRE tunnel and the S8 PMIPv6 GRE tunnel for a given PDN connection. + +## 5.10 Proxy Mobile IPv6 MAG Initiated IPv4 Address Release procedure + +### 5.10.1 General + +In the case when UE is assigned both IPv6 HNP and IPv4 Home Address, for DHCPv4 Release procedure, the node acting as MAG initiates the selective de-registration of IPv4 home address procedure to notify the node acting as LMA about release of IPv4 address of UE for a certain PDN connection. MAG notifies LMA by sending a PBU and LMA confirms by replying with a PBA as described in IETF RFC 5844 [5]. IPv4 address release procedure achieves the following: + +**IPv4 Home Address release:** The LMA releases an IPv4 Home Address of the UE's PDN connection. + +#### 5.10.1.1 Proxy Binding Update + +The fields of a PBU message for the PMIPv6 MAG Initiated IPv4 Address Release procedure are depicted in Table 5.10.1.1-1. + +The Mobility Options in a PBU message for the PMIPv6 MAG Initiated IPv4 Address Release procedure are depicted in Table 5.10.1.1-2. When the mobility option is present in the message, only the first instance shall be recognised. If multiple instances are included in the message, the receiver ignores all other instances. + +Other flags are not used by this specification. + +**Table 5.10.1.1-1: Fields of a PBU message for the PMIPv6 MAG Initiated IPv4 Address Release procedure** + +| Information element | IE Description | Reference | +|------------------------------------------|---------------------------------------------------------------------------------|--------------------| +| Sequence Number | Set to a locally (i.e. per MAG) monotonically increasing value. | IETF RFC 5213 [4] | +| Acknowledge (A) | Set to "1" to request an acknowledgement message. | IETF RFC 6275 [8] | +| Proxy Registration Flag (P) | Set to "1" to indicate that the Binding Update message is a proxy registration. | IETF RFC 5213 [4] | +| Force UDP encapsulation request (F) Flag | Set to "0" to indicate that UDP encapsulation is not used for the user plane. | IETF RFC 5555 [34] | +| Lifetime | Set to "0" to request deletion of the IPv4 binding. | IETF RFC 5844 [5] | + +**Table 5.10.1.1-2: Mobility Options in a PBU message for the PMIPv6 MAG Initiated IPv4 Address Release procedure** + +| Information element | Cat. | IE Description | Reference | +|-----------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------| +| Mobile Node Identifier option | M | Set to the NAI identifier of the UE as specified in 3GPP TS 23.003 [12]. | 3GPP TS 23.003 [12] | +| Handoff Indicator option | M | Set to the value "4" to indicate Handoff state unknown. | IETF RFC 5213 [4] | +| Access Technology Type option | M | Set to the value matching the characteristics of the non-3GPP access on S2a (e.g., HRPD) the UE is using to attach to the EPS as defined in the Access Technology Type Option type values registry of the IANA Mobile IPv6 Parameters Registry [18].
NOTE 1 | IETF RFC 5213 [4] | +| Timestamp option | M | Set to the current time | IETF RFC 5213 [4] | +| IPv4 Home Address Request option | M | Set the IPv4 Home Address to the IPv4 Home Address to be released of the UE's PDN connection and Prefix-len to the non-zero value received from LMA. | IETF RFC 5844 [5] | +| Service Selection Mobility Option | M | Set to the EPS Access Point Name to which the UE's PDN connection is attached, formatted as defined in 3GPP TS 23.003 [12] | IETF RFC 5149[11] | + +NOTE 1: The PDN-GW can be informed about the type of access network used by the UE over several reference points, see 3GPP TS 29.212 [30] for the mapping between the code values for the different access network types. + +## 5.10.1.2 Proxy Binding Acknowledgement + +The fields of a PBA message for the PMIPv6 MAG Initiated IPv4 Address Release procedure are depicted in Table 5.10.1.2-1. + +The Mobility Options in a PBA message for the PMIPv6 MAG Initiated IPv4 Address Release procedure are depicted in Table 5.10.1.2-2. When the mobility option is present in the message, only the first instance shall be recognised. If multiple instances are included in the message, the receiver ignores all other instances. + +Other flags are not used by this specification. + +Only the message fields and mobility options used for acceptance cases are present in the following tables. + +**Table 5.10.1.2-1: Fields of a PBA message for the PMIPv6 MAG Initiated IPv4 Address Release procedure** + +| Information element | IE Description | Reference | +|-----------------------------|---------------------------------------------------------------------------------|-------------------| +| Status | Set to indicate the result. | IETF RFC 6275 [8] | +| Proxy Registration Flag (P) | Set to "1" to indicate that the Binding Update message is a proxy registration. | IETF RFC 5213 [4] | +| Sequence Number | Set to the value received in the corresponding PBU. | IETF RFC 5213 [4] | +| Lifetime | Set to "0" to request deletion of the IPv4 binding. | IETF RFC 5844 [5] | + +**Table 5.10.1.2-2: Mobility Options in a PBA message for the PMIPv6 MAG Initiated IPv4 Address Release procedure** + +| Information element | Cat. | IE Description | Reference | +|------------------------------------|------|-----------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| Mobile Node Identifier option | M | Copied from corresponding field of PBU. | IETF RFC 5213 [4] | +| Handoff Indicator option | M | Copied from corresponding field of PBU. | IETF RFC 5213 [4] | +| Access Technology Type option | M | Copied from corresponding field of PBU. | IETF RFC 5213 [4] | +| Timestamp option | M | Copied from corresponding field of PBU, or set to the current time of LMA in case of timestamp error. | IETF RFC 5213 [4] | +| IPv4 Home Address Reply Option | M | Set the IPv4 Home Address to the released IPv4 Home Address of the UE's PDN connection and Prefix-len to the non-zero value received in BRI. | IETF RFC 5844 [5] | +| IPv4 Default Router Address Option | M | The LMA sets the value of the UE's IPv4 default router address which belongs to the same subnet as the IPv4 Home Address allocated to the UE. | IETF RFC 5844 [5] | +| Service Selection Mobility Option | M | Copied from the corresponding field in the PBU message, formatted as defined in 3GPP TS 23.003 [12] | IETF RFC 5149[11] | +| 3GPP Specific PMIPv6 Error Code | O | Contain 3GPP Specific PMIPv6 Error Code (on S5/S8). | Subclause 12.1.1.1 | + +## 5.10.2 MAG procedures + +The MAG initiating IPv4 Address Release using DHCPv4 procedure shall follow the "Selective De-Registration" procedure and "DHCP Server co-located with MAG" procedure as described in IPv4 support for PMIPv6 [5] specifications, while parameters in the PBU are set as specified by the PBU parameters section for this procedure. + +1. Set the IPv4 home address to be released in the IPv4 home address Request option in the PBU. +2. Set other parameters in the PBU as specified by the PBU parameters section for this procedure. + +## 5.10.3 LMA procedures + +On reception of a PBU, the LMA shall initiate the "Selective De-Registration" procedures as described in the IPv4 support for PMIPv6 [5] specifications with the following additional requirements: + +1. Release the IPv4 Home Address corresponding to the IPv4 home address Request option in the PBU message. +2. Set parameters in the PBA as specified by the PBA parameters section for this procedure. + +# 5.11 Proxy Mobile IPv6 LMA Initiated Update Notification procedure + +## 5.11.1 General + +In EPC the PMIPv6 LMA Initiated Update Notification procedure is initiated by the node acting as a LMA to notify the node acting as a MAG, that the Binding Cache Entry related to the UE is about to be updated, so the MAG updates the resources related to that PDN connection. The procedure starts with the LMA sending a PMIPv6 UPN message to the MAG. The MAG confirms by sending a PMIPv6 UPA message to the LMA. + +The PMIPv6 LMA Initiated Update Notification procedure is initiated by the node acting as a LMA to notify the node acting as a MAG, to trigger the generation of End Marker by the MAG. The procedure starts with the LMA sending a PMIPv6 UPN message to the MAG. The LMA shall not request an acknowledgement message from the MAG. See clause 15. + +This PMIPv6 LMA Initiated Update Notification procedure is based on the PMIPv6 notification procedure as specified in the IETF RFC 7077 [35]. + +### 5.11.1.1 Update Notification + +The fields of a UPN message for the PMIPv6 LMA Initiated Update Notification procedure are depicted in Table 5.11.1.1-1. + +The Mobility Options in a UPN message for the PMIPv6 LMA Initiated Update Notification procedure are depicted in Table 5.11.1.1-2. When the mobility option is present in the message, only the first instance shall be recognised. If multiple instances are included in the message, the receiver shall ignore all other instances. + +Other flags are not used by this specification. + +**Table 5.11.1.1-1: Fields of a UPN message for the PMIPv6 LMA Initiate Update Notification procedure** + +| Information element | Description | | Reference | +|---------------------|------------------------------------------------------------------------------------------------------------|--|--------------------| +| Sequence Number | Set to a locally (i.e. per LMA) monotonically increasing value. | | IETF RFC 5213 [4] | +| Notification Reason | Set to the corresponding notification reason | | IETF RFC 7077 [35] | +| Acknowledge (A) | Set to "1" to request an acknowledgement message.
Set to "0" not to request an acknowledgement message. | | IETF RFC 7077 [35] | + +**Table 5.11.1.1-2: Mobility Options in a UPN message for the PMIPv6 LMA Initiated Update Notification procedure** + +| Information element | Cat. | IE Description | Reference | +|------------------------------------------|------|-------------------------------------------------------------------------------------------------|---------------------| +| Mobile Node Identifier option | M | Set to the NAI identifier of the UE as specified in 3GPP TS 23.003 [12]. | 3GPP TS 23.003 [12] | +| Service Selection Mobility Option | O | This IE shall be set to the EPS Access Point Name to which the UE's PDN connection is attached. | IETF RFC 5149 [11] | +| PDN connection ID | O | This IE shall contain the PDN connection ID if the BCE contains the PDN Connection ID. | Subclause 12.1.1.15 | +| MME/SGSN Identifier | O | Contains the MME/S4-SGSN identifier | Subclause 12.1.1.20 | +| Protocol Configuration Option | O | Contains Protocol Configuration Options. | Subclause 12.1.1.0 | +| End Marker Notification | O | Contains the End Marker Notification (on S5/S8). | Subclause 12.1.1.21 | +| PDN GW IP Address | O | Contains PDN GW IP address for control plane used by the PDN connection. | Subclause 12.1.1.4 | +| GRE key option | O | Contains the uplink GRE key for control plane used by the PDN connection. | IETF RFC 5845 [7] | +| Additional Protocol Configuration Option | O | Contains Additional Protocol Configuration Options. | Subclause 12.1.1.19 | + +### 5.11.1.2 Update Notification Acknowledgement + +The fields of a UPA message for the PMIPv6 LMA Initiated Update procedure are depicted in Table 5.11.1.2-1. + +The Mobility Options in a UPA message for the PMIPv6 LMA Initiated Update procedure are depicted in Table 5.11.1.2-2. When the mobility option is present in the message, only the first instance shall be recognised. If multiple instances are included in the message, the receiver shall ignore all other instances. + +Other flags are not used by this specification. + +Only the message fields and mobility options used for acceptance cases are present in the following tables. + +**Table 5.11.1.2-1: Fields of a UPA message for the PMIPv6 LMA Initiated Update Notification procedure** + +| Information element | Description | | Reference | +|---------------------|-----------------------------------------------------|--|--------------------| +| Sequence Number | Set to the value received in the corresponding UPN. | | IETF RFC 5213 [4] | +| Status | Indicates the result of the UPN | | IETF RFC 7077 [35] | + +**Table 5.11.1.2-2: Mobility Options in a UPA message for the PMIPv6 LMA Initiated Update Notification procedure** + +| Information element | Cat. | IE Description | Reference | +|-----------------------------------|------|-------------------------------------------------------------------------------------|---------------------| +| Mobile Node Identifier option | M | Copied from the corresponding field in the UPN. | 3GPP TS 23.003 [12] | +| Service Selection Mobility Option | O | This IE shall be copied from the corresponding field in the UPN message if present. | IETF RFC 5149 [11] | +| PDN connection ID | C | Contains the PDN connection ID received in UPN | Subclause 12.1.1.15 | +| 3GPP Specific PMIPv6 Error Code | O | Contains a 3GPP Specific PMIPv6 Error Code. | Subclause 12.1.1.1 | + +## 5.11.2 LMA procedures + +A LMA initiating the PMIPv6 LMA Initiated Update Notification procedure shall follow the procedure described in IETF RFC 7077 [35], while parameters in the UPN message are set as specified by the UPN message parameters section for this procedure. + +## 5.11.3 MAG procedures + +On reception of a UPN, the MAG shall follow the procedure described in IETF RFC 7077 [35], while parameters in the UPA message are set as specified by the UPA message parameters section for this procedure. + +# 5.12 Proxy Mobile IPv6 Mobile Network Prefix Allocation procedure + +## 5.12.1 General + +Proxy Mobile IPv6 Mobile Network Prefix Allocation procedure is initiated by the node acting as a MAG when DHCPv6 Reply message is received from the node acting as a LMA which is co-located with delegating router if the UE requests a network prefix shorter than the default /64 prefix (i.e. prefixes in addition to the default prefix) as specified in 3GPP TS 23.402 [3]. The MAG sends a PBU to LMA associating the network prefix with an existing PDN connection. The LMA confirms the assigned network prefix by sending a PBA to the MAG. Proxy Mobile IPv6 Mobile Network Prefix Allocation achieves the following: + +- **Delegated Mobile Network Prefix assignment:** The LMA assigns to the UE's PDN connection the mobile network prefix shorter than the default /64 prefix valid in the selected PDN. +- **BCE Update:** The LMA includes the delegated mobile network prefix in the BCE for the PDN connection. +- **BULE Update:** The MAG includes the delegated mobile network prefix in the BULE for the PDN connection. + +### 5.12.1.1 Proxy Binding Update + +The fields of a PBU message for the PMIPv6 Mobile Network Prefix Allocation procedure are depicted in Table 5.12.1.1-1. + +The Mobility Options in a PBU message for the PMIPv6 Mobile Network Prefix Allocation procedure are depicted in Table 5.12.1.1-2. When the mobility option is present in the message, only the first instance shall be recognised. If multiple instances are included in the message, the receiver ignores all other instances. + +Other flags are not used by this specification. + +**Table 5.12.1.1-1: Fields of a PBU message for the PMIPv6 Mobile Network Prefix Allocation procedure** + +| Information element | IE Description | Reference | +|------------------------------------------|---------------------------------------------------------------------------------|--------------------| +| Sequence Number | Set to a locally (i.e. per MAG) monotonically increasing value. | IETF RFC 5213 [4] | +| Acknowledge (A) | Set to "1" to request an acknowledgement message. | IETF RFC 6275 [8] | +| Proxy Registration Flag (P) | Set to "1" to indicate that the Binding Update message is a proxy registration. | IETF RFC 5213 [4] | +| Force UDP encapsulation request (F) Flag | Set to "0" to indicate that UDP encapsulation is not used for the user plane. | IETF RFC 5555 [34] | +| Lifetime | Set to the requested number of time units the binding shall remain valid. | IETF RFC 6275 [8] | + +**Table 5.12.1.1-2: Mobility Options in a PBU message for the PMIPv6 Mobile Network Prefix Allocation procedure procedure** + +| Information element | Cat. | IE Description | Reference | +|----------------------------------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------| +| Mobile Node Identifier option | M | Set to the UE NAI that is derived from the UE IMSI if an authenticated IMSI is available, or from the UE IMEI if IMSI is not available or the IMSI is not authenticated by the network. The NAI format is specified in 3GPP TS 23.003 [12]. | IETF RFC 5213 [4],
3GPP TS 23.003 [12] | +| Delegated Mobile Network Prefix Option | M | Set the Delegated Mobile Network Prefix Option to the mobile network prefix allocated to the UE's PDN connection. | IETF RFC 7148 [45] | +| Link-local Address | M | Set to the link-local address already allocated to the MAG (in the previous initial binding registration) for use on the access link shared with the UE. | IETF RFC 5213 [4] | +| Handoff Indicator option | M | Set to the value "5" to indicate handoff state not changed (Re-registration). | IETF RFC 5213 [4] | +| Access Technology Type option | M | Set to the 3GPP access type, i.e., to GERAN, UTRAN or E-UTRAN. | IETF RFC 5213 [4] | +| Timestamp option | M | Set to the current time | IETF RFC 5213 [4] | +| Service Selection Mobility Option | M | Set to the EPS Access Point Name to which the UE's PDN connection is attached.
The encoding of the APN field follows 3GPP TS 23.003 [12] subclause 9.1 but excluding the trailing zero byte. The content of the APN field shall be the full APN with both the APN Network Identifier and APN Operator Identifier being present as specified in 3GPP TS 23.003 [12] subclauses 9.1.1 and 9.1.2.
NOTE 1. | IETF RFC 5149 [11] | +| PDN connection ID | C | Contains the PDN connection ID if the BULE contains the PDN Connection ID. | Subclause 12.1.1.15 | + +NOTE 1: The APN field is not encoded as a dotted string as commonly used in documentation. + +### 5.12.1.2 Proxy Binding Acknowledgement + +The fields of a PBA message for the PMIPv6 Mobile Network Prefix Allocation procedure are depicted in Table 5.12.1.2-1. + +The Mobility Options in a PBA message for the PMIPv6 Mobile Network Prefix Allocation procedure are depicted in Table 5.12.1.2-2. When the mobility option is present in the message, only the first instance shall be recognised. If multiple instances are included in the message, the receiver ignores all other instances. + +Other flags are not used by this specification. + +Only the message fields and mobility options used for acceptance cases are present in the following tables. + +**Table 5.12.1.2-1: Fields of a PBA message for the PMIPv6 Mobile Network Prefix Allocation procedure** + +| Information element | IE Description | Reference | +|-----------------------------|---------------------------------------------------------------------------------|-------------------| +| Status | Set to indicate the result. | IETF RFC 6275 [8] | +| Proxy Registration Flag (P) | Set to "1" to indicate that the Binding Update message is a proxy registration. | IETF RFC 5213 [4] | +| Sequence Number | Set to the value received in the corresponding PBU. | IETF RFC 5213 [4] | +| Lifetime | Set to the granted number of time units the binding shall remain valid. | IETF RFC 6275 [8] | + +**Table 5.12.1.2-2: Mobility Options in a PBA message for the PMIPv6 Mobile Network Prefix Allocation procedure** + +| Information element | Cat. | IE Description | Reference | +|----------------------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------| +| Mobile Node Identifier option | M | Copied from corresponding field of PBU. | IETF RFC 5213 [4] | +| Delegated Mobile Network Prefix Option | M | Copied from corresponding field of PBU. | IETF RFC 7148 [45] | +| Link-local Address | M | Set to the link-local address already allocated to the MAG (in the previous initial binding registration) for use on the access link shared with the UE. | IETF RFC 5213 [4] | +| Handoff Indicator option | M | Copied from corresponding field of PBU. | IETF RFC 5213 [4] | +| Access Technology Type option | M | Copied from corresponding field of PBU. | IETF RFC 5213 [4] | +| Timestamp option | M | Copied from corresponding field of PBU, or set to the current time of LMA in case of timestamp error. | IETF RFC 5213 [4] | +| Service Selection Mobility Option | M | Copied from the corresponding field in the PBU message.
The encoding of the APN field follows 3GPP TS 23.003 [12] subclause 9.1 but excluding the trailing zero byte. The content of the APN field shall be the full APN with both the APN Network Identifier and APN Operator Identifier being present as specified in 3GPP TS 23.003 [12] subclauses 9.1.1 and 9.1.2.
NOTE 1. | IETF RFC 5149 [11] | +| 3GPP Specific PMIPv6 Error Code | O | Contain 3GPP Specific PMIPv6 Error Code (on S5/S8). | Subclause 12.1.1.1 | +| PDN connection ID | C | Contains the PDN connection ID received in PBU | Subclause 12.1.1.15 | + +NOTE 1: The APN field is not encoded as a dotted string as commonly used in documentation. + +## 5.12.2 MAG procedures + +The MAG initiating PMIPv6 Mobile Network Prefix Allocation using DHCPv6 prefix delegation procedure shall follow the "Delegating Router Co-located with Local Mobility Anchor" procedure as described in IETF RFC 7148 [45], while parameters in the PBU message are set as specified by the PBU message parameters section for this procedure. + +## 5.12.3 LMA procedures + +On reception of a PBU, the LMA shall initiate the " Delegating Router Co-located with Local Mobility Anchor " procedures as described described in IETF RFC 7148 [45], while parameters in the PBA message are set as specified by the PBA message parameters section for this procedure. + +## 6 Tunnel Management procedures + +### 6.1 General + +The Mobile Anchor Gateway (MAG) and the Local Mobility Anchor (LMA) establish and maintain a bi-directional tunnel for each PDN connection, which is used for routing the UE's PDN connection user-plane traffic between the MAG and the LMA. This tunnel is based on GRE encapsulation as specified in IETF RFC 2890 [21] (see also IETF RFC 2784 [20]) and is established as a result of exchanging the Proxy Binding Update (PBU) and the Proxy Binding Acknowledgment (PBA) messages between the MAG and LMA. The PBU and PBA messages establish unique Binding Cache Entry (BCE) and Binding Update List Entry (BULE) entries for each PDN connection at the LMA and the MAG respectively. The tunnel end points are: + +- the Proxy-CoA at the MAG and LMAA or LMA User Plane Address (if an alternate address is used for user plane) at the LMA with GRE encapsulation (for IPv6 transport network); or +- the IPv4-Proxy-CoA at the MAG and IPv4-LMAA or LMA User Plane Address (if an alternate address is used for user plane) at the LMA with GRE encapsulation (for IPv4 transport network), as described in IETF RFC 5845 [7]. + +GRE encapsulation shall always be used; the GRE tunneling negotiation described in IETF RFC 5845 [7] is not applicable and the GRE Key Identifier Option shall always be present in the PBU messages for PMIPv6 PDN Connection Creation and binding registration after handover. + +The LMA may assign an alternate LMAA or IPv4-LMAA during the setup of the PDN connection, if this option is supported by both MAG and LMA. + +Tear down of GRE tunnels and cleanup of state is done explicitly by MAG Initiated PDN Connection Deletion or LMA Initiated PDN Connection Deletion; additionally, the tunnel is torn down when the binding lifetime expires as described in IETF RFC 5213 [4]. + +A PMIPv6 node (MAG or LMA), which uses the control plane A protocol stack (see subclause 4.2) shall send signalling messages specified in Section 5 with IPv4-UDP encapsulation in IPv4 transport network as specified in IETF RFC 5844 [5]. + +A PMIPv6 node (MAG or LMA), which uses the control plane B protocol stack (see subclause 4.2) shall send signalling messages specified in Section 5 natively, without encapsulation in IPv6 transport network as specified in IETF RFC 5213 [4]. + +The maximum size of an inner IP packet that may be transmitted without fragmentation by the PDN GW or the MS/UE is the same as the maximum N-PDU size that can be transmitted without IP fragmentation as defined in 3GPP TS 23.060 [23]. + +Recommendations on how to set the default inner MTU size at the PDN GW and UE/MS to avoid IP fragmentation of both inner IP packets (in the PDN GW or UE/MS) and outer IP packets in the backbone are specified in clause 9.3 of 3GPP TS 23.060 [23]. + +To avoid network overload due to excessive signalling, when sending a PBU message, the requested binding lifetime should be sufficiently large, e.g. greater than 300 seconds. After accepting a PBU request, the binding lifetime may be reset to another value by the LMA based on local configuration. + +### 6.2 MAG procedure + +When the PDN connectivity is established, the downlink GRE key for the PDN connection downlink traffic is selected by the MAG and sent to LMA in PBU message. This downlink GRE key shall be unique within the MAG for a given LMAA or IPv4-LMAA, or for a given (IPv4-)Proxy-CoA if the MAG indicates to the LMA that it supports the capability to receive an alternate LMA address for user plane. + +The uplink GRE key is received from LMA in a PBA message, and also from the MME in case Serving GW relocation occurs. The MAG shall be able to send the PDN connection uplink traffic using the received uplink GRE key towards the LMAA or IPv4-LMAA or LMA User Plane Address (if an alternate address is used for user plane) before sending the PBU or before receiving the PBA. + +When the PDN connection is released, the downlink GRE key shall be released by the MAG. + +## 6.3 LMA procedure + +When the PDN connectivity is established, the uplink GRE key for the PDN connection uplink traffic is selected by the LMA and sent to MAG in PBA message. This uplink GRE key shall be unique within the LMA. + +The LMA function shall be able to accept the PDN connection uplink packets from any MAG without enforcing that the source IP address of the outer IP header matches the Proxy-CoA in the UE BCE. + +If GTP based S5/S8 is used for E-UTRAN access and PMIP based S2a is used for HRPD access, and optimized handover from E-UTRAN to HRPD is supported, when the PGW allocates an uplink TEID for a default bearer of a GTP tunnel, it shall also reserve an uplink GRE key with the same value of the default bearer uplink TEID. + +When the PDN connection is released, the uplink GRE key shall be released by the LMA. + +## 6.4 Data Structures + +### 6.4.1 Binding Update List Entry + +MAG maintains a unique Binding Update List Entry for for each PDN connection of a UE. The required elements of BULE as per 3GPP requirements are described in table 6.4.1-1. + +**Table 6.4.1-1: Elements of BULE** + +| Element | Description | Reference | +|-----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------| +| Mobile Node Identifier | Set to the UE NAI that is derived from the UE IMSI if an authenticated IMSI is available, or from the UE IMEI if IMSI is not available or the IMSI is not authenticated by the network. The NAI format is specified in 3GPP TS 23.003 [12]. | 3GPP TS 23.003 [12], IETF RFC 5213 [4] | +| Access Point Name | Set to the EPS Access Point Name to which the UE's PDN connection is attached, formatted as defined in 3GPP TS 23.003 [12] | 3GPP TS 23.003 [12] | +| Lifetime | Set to lifetime granted for the binding as received in PBA. | IETF RFC 6275 [8] | +| Remaining Lifetime | This lifetime is initialized from the lifetime granted for the binding and is decremented until it reaches 0. | IETF RFC 6275 [8] | +| Sequence Number | The sequence number of the last Proxy Binding Update message sent. | IETF RFC 6275 [8] | +| Timestamp | Time at which last PBU was sent. | IETF RFC 6275 [8] | +| Binding Flag | Set to 1 if MAG receives an ICMPv6 parameter problem, code 1, error message in response to a PBU. Set to 0 if MAG continues to send PBU. | IETF RFC 6275 [8] | +| IPv6 Home Network Prefix | IPv6 Home Network Prefix assigned to the UE's PDN connection. | IETF RFC 5213 [4] | +| Link-local Address | IPv6 Link-local address to be used by the MAG on the access link shared with the UE. | IETF RFC 5213 [4] | +| IPv4 Home Address | IPv4 Home Address assigned to UE's PDN connection. | IETF RFC 5213 [4] | +| IPv4 default-router address | The IPv4 default-router address of the mobile node. | IETF RFC 5844 [5] | +| LMA IPv6 Address | IPv6 Address of the LMA for control plane, and for user plane if no alternate LMA user plane address is used. | IETF RFC 6275 [8] | +| LMA IPv4 Address | IPv4 Address of the LMA for control plane, and for user plane if no alternate LMA user plane address is used. | IETF RFC 5844 [5] | +| LMA User-Plane Address | IPv4 or IPv6 Address of the LMA for user plane. | IETF RFC 7389 [44] | +| Downlink GRE Key | Downlink GRE key for the PDN connection as selected by MAG. | IETF RFC 5845 [7] | +| Uplink GRE key | Uplink GRE key for the PDN connection selected by LMA as received in GRE Key option of PBA. | IETF RFC 5845 [7] | +| Chained Binding Cache Entry | Reference to the corresponding BCE used for the binding on the S8 interface. It shall be present only in the Serving GW, in case of S2a/S2b - PMIP based-S8 chaining. | | +| PDN Connection ID | Set to the PDN Connection ID if multiple PDN connections to the same APN is supported by both MAG and LMA | Subclause 12.1.1.15 | + +## 6.4.2 Binding Cache Entry + +LMA maintains a unique Binding Cache Entry for each PDN connection for a UE. The required elements of BCE as per 3GPP requirements are described in table 6.4.1-2. + +**Table 6.4.2-1: Elements of BCE** + +| Element | Element Description | Reference | +|-----------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------| +| Mobile Node Identifier | The MN-Id mobility option as received in PBU. | 3GPP TS 23.003 [12], IETF RFC 5213 [4] | +| Access Point Name | The Service Selection Mobility option received in PBU | 3GPP TS 23.003 [12] | +| Lifetime | Lifetime granted for the binding. | IETF RFC 6275 [8] | +| Sequence Number | Sequence number of last received PBU. | IETF RFC 6275 [8] | +| IPv6 Home Network Prefix | IPv6 Home Network Prefix assigned to the UE's PDN connection. | IETF RFC 5213 [4] | +| Link-local Address | The assigned IPv6 link local address to MAG for use on the access link shared with the UE. | IETF RFC 5213 [4] | +| IPv4 Home Address | IPv4 Home Address assigned to UE's PDN connection. | IETF RFC 5213 [4] | +| IPv4 default-router address | The IPv4 default-router address of the mobile node. | IETF RFC 5844 [5] | +| IPv6 Proxy care-of-address | MAG IPv6 Address, i.e. the source address of the IP packet in which PBU was received. | IETF RFC 6275 [8] | +| IPv4 Proxy care-of-address | MAG IPv4 Address. | IETF RFC 5844 [5] | +| LMA User-Plane Address | IPv4 or IPv6 Address of the LMA for user plane. | IETF RFC 7389 [44] | +| Access Technology Type | Access Technology Type as received in PBU. | IETF RFC 5213 [4] | +| Timestamp | Timestamp as received in PBU. | | +| Binding Flag | '1' as it is proxy registration. | IETF RFC 5213 [4] | +| Downlink GRE key | Downlink GRE key for the PDN connection selected by MAG as received in GRE key option of PBU. | IETF RFC 5845 [7] | +| Uplink GRE key | Uplink GRE key for the PDN connection selected by LMA. | IETF RFC 5845 [7] | +| Chained Binding Update List Entry | Reference to the corresponding BULE used for binding on the S2a / S2b interface.
It shall be present only in the Serving GW, in case of S2a/S2b – PMIP-based S8 chaining. | | +| PDN Connection ID | Set to the PDN Connection ID if multiple PDN connections to the same APN is supported by both MAG and LMA | Subclause 12.1.1.15 | + +## 6.5 Security + +Security aspects for PMIPv6 are described in 3GPP TS 33.402 [19]. + +## 7 Path Management procedures + +### 7.1 General + +The path management for PMIPv6 is very similar to that of GTP; the main difference is the use of PMIPv6 messages instead of GTP messages. + +Path failure handling procedures are specified in 3GPP TS 23.007 [13]. + +### 7.2 Heartbeat Mechanism + +#### 7.2.1 General + +A LMA or MAG shall support sending Heartbeat Message to a peer MAG or LMA for Failure Detection and Restart Detection. The Heartbeat Message and procedures of Failure Detection and Restart Detection are defined in IETF RFC 5847 [17]. When and how often a Heartbeat Request message are sent is implementation specific but a periodic Heartbeat Request shall not be sent more often than every 60 s on each path. + +#### 7.2.2 Heartbeat Message + +##### 7.2.2.1 Heartbeat Request + +Table 7.2.2.1-1 specifies the information elements included in the Heartbeat Request message. + +**Table 7.2.2.1-1: Fields of a Heartbeat message for the Heartbeat request** + +| Information element | IE Description | Reference | +|---------------------|--------------------------------------------------|--------------------| +| R flag | Set to 0 for a request message. | IETF RFC 5847 [17] | +| Sequence Number | Set to a locally monotonically increasing value. | IETF RFC 5847 [17] | + +##### 7.2.2.2 Heartbeat Response + +Table 7.2.2.2-1 and 7.2.2.2-2 specifies the information elements included in the Heartbeat Response message. + +**Table 7.2.2.2-1: Fields of a Heartbeat message for the Heartbeat Response** + +| Information element | IE Description | Reference | +|---------------------|-----------------------------------------------------------------------------------------------------|--------------------| +| R flag | Set to 1 for a response message. | IETF RFC 5847 [17] | +| U flag | Set to 0 if the heartbeat response is sent as an answer to a heartbeat request. Set to 1 otherwise. | IETF RFC 5847 [17] | +| Sequence Number | Set to the value received in the corresponding Heartbeat Request message. | IETF RFC 5847 [17] | + +**Table 7.2.2.2-2: Mobility Options in a Heartbeat message for the Heartbeat Response** + +| Information element | IE Description | Reference | +|---------------------|---------------------------------------------|--------------------| +| Restart Counter | indicates the current Restart Counter value | IETF RFC 5847 [17] | + +## 7.3 Void + +## 7.4 Void + +## 7.5 Void + +## 7.6 UE-specific Error Handling + +### 7.6.1 General + +A PMIPv6 node (i.e., LMA or MAG) may support the UE-specific error indication such that a PMIPv6 node may send a message to the source PMIPv6 node when no binding exists for a packet received from a GRE tunnel. + +### 7.6.2 MAG and LMA procedure + +If a PMIPv6 receiving node (i.e. MAG or LMA) verifies that no PMIPv6 binding exists for a received user packet based on GRE Key, the receiving PMIPv6 node shall discard the packet. The PMIPv6 node may report the error to the peer PMIPv6 node, in the form of an ICMP message, as specified in Sections 8.1, 8.2 and 8.3 of IETF RFC2473 [31] for the node unreachable error case. + +Handling of the received error in the form of an ICMP message is specified in 3GPP TS 23.007 [13]. + +## 7.7 Void + +## 7.8 Partial node failure requiring the removal of a subset of sessions + +### 7.8.1 General + +See 3GPP TS 23.007 [13] for the description of this function. + +### 7.8.2 Binding Revocation Indication message + +The fields of a BRI message to revoke bulk PMIPv6 bindings initiated by the LMA or the MAG are depicted in Table 7.8.2-1. + +The Mobility Options in a BRI message to revoke bulk PMIPv6 bindings sent by the LMA or the MAG are depicted in Table 7.8.2-2. + +**Table 7.8.2-1: Fields of a BRI message for the PMIPv6** + +| Information element | IE Description | Reference | +|------------------------------|---------------------------------------------------------------------------------------------------|-------------------| +| Revocation Trigger | Set to the value of "Revoking Mobility Node Local Policy" | IETF RFC 5846 [6] | +| Sequence Number | A sequence number generated by the LMA, and increased for every BRI sent. | IETF RFC 5846 [6] | +| Proxy Binding Flag (P) | Set to "1" to indicate that the Binding Revocation Indication is for a proxy MIPv6 binding entry. | RFC 5213 [4] | +| IPv4 HoA Binding Only (V) | Set to "0" to request for complete binding revocation | IETF RFC 5846 [6] | +| Global Per-Peer Bindings (G) | Set to 1 | IETF RFC 5846 [6] | + +**Table 7.8.2-2: Mobility Options in a BRI message for the PMIPv6 LMA or MAG Initiated bulk PDN Connections Deletion for Partial Node failure** + +| Information element | Cat. | IE Description | Reference | +|-----------------------------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| Mobile Node Identifier | C | Set to the IP address of the MAG, only when the BRI message is sent by the MAG. | 3GPP TS 23.402[3] | +| Fully Qualified PDN Connection Set Identifier | M | This IE shall be included by the MAG or LMA on the S5/S8, S2a (for Trusted WLAN Access) and S2b interfaces (see 3GPP TS 23.007 [13]) and contains the Fully Qualified PDN Connection Set Identifier(s) that need to be revoked. | Subclause 12.1.1.2 | + +### 7.8.3 Binding Revocation Acknowledgement message + +The fields of a BRA message to revoke bulk PMIPv6 bindings for the PMIPv6 LMA or MAG Initiated PDN Connection Deletion procedure are depicted in Table 7.8.3-1. + +**Table 7.8.3-1: Fields of a BRA message for a PMIPv6 for a MAG or LMA Initiated bulk PDN Connections Deletion for Partial Node failure** + +| Information element | IE Description | Reference | +|------------------------------|-------------------------------------------------------------------------------------------------------|-------------------| +| Status | Indicates the result of the BRI. | IETF RFC 5846 [6] | +| Sequence Number | Set to the value received in the corresponding BRI. | IETF RFC 5846 [6] | +| Proxy Registration Flag (P) | Set to "1" to indicate that the Binding Revocation Acknowledgment is for a proxy MIPv6 binding entry. | RFC 5213 [4] | +| IPv4 HoA Binding Only (V) | Set to "0"; the same value as for BRI | IETF RFC 5846 [6] | +| Global Per-Peer Bindings (G) | Set to 1; the same value as for the BRI. | IETF RFC 5846 [6] | + +### 7.8.4 MAG procedures + +The MAG can be the initiator or the receiver of a BRI message to revoke bulk PMIPv6 bindings. + +The MAG shall follow the "Local Mobility Anchor Revokes Bulk PMIPv6 Bindings" procedure described in the IETF RFC 5846 [6] when it receives a Binding Revocation Indication message with G bit set, removing the sessions identified by the Fully Qualified PDN Connection Set Identifier Mobility Option. + +The MAG shall follow the "Mobile Access Gateway Revoke Bulk PMIPv6 Bindings" when it sends a Binding Revocation Indication message with G bit set to the LMA, including the Fully Qualified PDN Connection Set Identifier Mobility Option. + +### 7.8.5 LMA procedures + +The LMA can be the initiator or the receiver of a BRI message to revoke bulk PMIPv6 bindings. + +The LMA shall follow the "Mobile Access Gateway Revokes Bulk PMIPv6 Bindings" procedure described in the IETF RFC 5846 [6] when it receives a Binding Revocation Indication message with G bit set, removing the sessions identified by the Fully Qualified PDN Connection Set Identifier Mobility Option. + +The LMA shall follow the "Local Mobility Anchor Revoke Bulk PMIPv6 Bindings" when it sends a Binding Revocation Indication message with G bit set to the LMA, including the Fully Qualified PDN Connection Set Identifier Mobility Option. + +--- + +## 8 PMIP-based S5 and PMIP-based S8 description + +### 8.1 Initial Attach procedures + +#### 8.1.1 General + +#### 8.1.2 Serving GW procedures + +The Serving GW shall follow the MAG procedure for the PMIPv6 PDN Connection Creation as outlined in subclause 5.1.2. + +#### 8.1.3 PDN GW procedures + +The PDN GW shall follow the LMA procedure for the PMIPv6 PDN Connection Creation as outlined in subclause 5.1.3. + +### 8.2 Serving GW Initiated PDN Connection Lifetime Extension procedures + +#### 8.2.1 General + +#### 8.2.2 Serving GW procedures + +The Serving GW shall follow the MAG procedure for the PMIPv6 PDN Connection Lifetime Extension as outlined in subclause 5.2.2. + +#### 8.2.3 PDN GW procedures + +The PDN GW shall follow the LMA procedure for the PMIPv6 PDN Connection Lifetime Extension as outlined in subclause 5.2.3. + +### 8.3 UE, MME or HSS initiated Detach procedures + +#### 8.3.1 General + +#### 8.3.2 Serving GW procedures + +The Serving GW shall follow the MAG procedure for the PMIPv6 MAG Initiated PDN Connection Deletion as outlined in subclause 5.4.2 repeated for each PDN connection of the UE. + +#### 8.3.3 PDN GW procedures + +The PDN GW shall follow the LMA procedure for the PMIPv6 MAG Initiated PDN Connection Deletion as outlined in subclause 5.4.3. + +### 8.4 PDN GW Initiated PDN Disconnection procedures + +#### 8.4.1 General + +#### 8.4.2 Serving GW procedures + +The Serving GW shall follow the MAG procedure for the PMIPv6 LMA Initiated PDN Connection Deletion as outlined in subclause 5.5.2. + +#### 8.4.3 PDN GW procedures + +The PDN GW shall follow the LMA procedure for the PMIPv6 LMA Initiated PDN Connection Deletion for the selected PDN connection as outlined in subclause 5.5.3. + +The PGW shall include the 3GPP Specific PMIPv6 error code IE and set it to the cause "Reactivation requested" when the PGW initiates the PDN GW Initiated Resource Allocation Deactivation procedure as part of the P-CSCF restoration procedure over 3GPP access, as specified in 3GPP TS 23.380 [36]. + +## 8.5 UE Requested Additional PDN Connectivity procedures + +### 8.5.1 General + +### 8.5.2 Serving GW procedures + +If the Request Type indicates "initial attach", the Serving GW shall follow the MAG procedure for the PMIPv6 PDN Connection Creation as outlined in subclause 5.1.2. + +If the Request Type indicates "Handover", the Serving GW shall follow the MAG procedure for the PMIPv6 PDN Connection Handover as outlined in subclause 5.3.2. + +### 8.5.3 PDN GW procedures + +If the Request Type indicates "initial attach", the PDN GW shall follow the LMA procedure for the PMIPv6 PDN Connection Creation as outlined in subclause 5.1.3. + +If the Request Type indicates "Handover", the PDN GW shall follow the LMA procedure for the PMIPv6 PDN Connection Handover as outlined in subclause 5.3.3. + +## 8.6 Handover procedures + +### 8.6.1 Intra-LTE TAU and Inter-eNodeB Handover with Serving GW Relocation procedures + +#### 8.6.1.1 General + +#### 8.6.1.2 Serving GW procedures + +The Serving GW shall follow the MAG procedure for the PMIPv6 PDN Connection Handover as outlined in subclause 5.3.2 repeated for each PDN connection of the UE. + +#### 8.6.1.3 PDN GW procedures + +The PDN GW shall follow the LMA procedure for the PMIPv6 PDN Connection Handover as outlined in subclause 5.3.3. + +### 8.6.2 TAU/RAU or Handover between GERAN A/Gb Mode or UTRAN Iu Mode and E-UTRAN procedures + +#### 8.6.2.1 General + +#### 8.6.2.2 Serving GW procedures + +The Serving GW shall follow the MAG procedure for the PMIPv6 PDN Connection Handover as outlined in subclause 5.3.2 repeated for each PDN connection of the UE. + +#### 8.6.2.3 PDN GW procedures + +The PDN GW shall follow the LMA procedure for the PMIPv6 PDN Connection Handover as outlined in subclause 5.3.3. + +### 8.6.3 Handover from Trusted or Untrusted Non-3GPP IP Access over S2a/S2b to 3GPP Access Handover E-UTRAN over PMIP based S5/S8 without optimization procedures + +#### 8.6.3.1 General + +#### 8.6.3.2 Serving GW procedures + +The Serving GW shall follow the MAG procedure for the PMIPv6 PDN Connection Handover as outlined in subclause 5.3.2 repeated for each PDN connection of the UE. + +#### 8.6.3.3 PDN GW procedures + +The PDN GW shall follow the LMA procedure for the PMIPv6 PDN Connection Handover as outlined in subclause 5.3.3. + +### 8.6.4 Handover from Trusted or Untrusted Non-3GPP IP Access over S2a/S2b to 3GPP Access UTRAN/GERAN over PMIP based S5/S8 without optimization + +#### 8.6.4.1 General + +#### 8.6.4.2 Serving GW procedures + +The Serving GW shall follow the MAG procedure for the PMIPv6 PDN Connection Handover as outlined in subclause 5.3.2 repeated for each PDN connection of the UE. + +#### 8.6.4.3 PDN GW procedures + +The PDN GW shall follow the LMA procedure for the PMIPv6 PDN Connection Handover as outlined in subclause 5.3.3. + +### 8.6.5 Handover from Trusted or Untrusted Non-3GPP IP Access over S2c to 3GPP Access over PMIP based S5/S8 without optimization + +#### 8.6.5.1 General + +#### 8.6.5.2 Serving GW procedures + +The Serving GW shall follow the MAG procedure for the PMIPv6 PDN Connection Handover as outlined in subclause 5.3.2 repeated for each PDN connection of the UE. + +#### 8.6.5.3 PDN GW procedures + +The PDN GW shall follow the LMA procedure for the PMIPv6 PDN Connection Handover as outlined in subclause 5.3.3. + +#### 8.6.6 Void + +#### 8.6.7 Void + +## 8.7 UE Requested PDN Disconnection procedures + +### 8.7.1 General + +### 8.7.2 Serving GW procedures + +The Serving GW shall follow the MAG procedure for the PMIPv6 MAG Initiated PDN Connection Deletion, for the selected PDN connection as outlined in subclause 5.4.2. + +### 8.7.3 PDN GW procedures + +The PDN GW shall follow the LMA procedure for the PMIPv6 MAG Initiated PDN Connection Deletion, for the selected PDN connection as outlined in subclause 5.4.3. + +## 8.8 IPv4 Address Allocation using DHCP + +### 8.8.1 General + +### 8.8.2 Serving GW procedures + +The Serving GW shall follow the MAG procedure for the Proxy Mobile IPv6 PDN Connection IPv4 Address Allocation Procedure as defined in sub clause 5.6.2. + +### 8.8.3 PDN GW procedures + +The PDN GW shall follow the LMA procedure for the Proxy Mobile IPv6 PDN Connection IPv4 Address Allocation Procedure as defined in sub clause 5.6.3. + +## 8.9 PDN-GW Initiated IPv4 Address Delete Procedure + +### 8.9.1 General + +### 8.9.2 Serving GW procedures + +If UE is assigned both IPv6 HNP and IPv4 HoA, the Serving GW shall follow the MAG procedure for the LMA Initiated IPv4 Address Release procedure as defined in sub clause 5.7.2. + +### 8.9.3 PDN GW procedures + +If UE is assigned both IPv6 HNP and IPv4 HoA, the PDN GW shall follow the LMA procedure for the LMA Initiated IPv4 Address Release procedure as defined in sub clause 5.7.3. + +If UE is assigned only IPv4 HoA, then PDN-GW initiated PDN Disconnection procedure is initiated. + +## 8.10 Mobile Network Prefix Allocation using DHCPv6 Prefix Delegation + +### 8.10.1 General + +### 8.10.2 Serving GW procedures + +The Serving GW shall follow the MAG procedure for the Proxy Mobile IPv6 Mobile Network Prefix Allocation procedure as defined in subclause 5.12.2. + +### 8.10.3 PDN GW procedures + +The PDN GW shall follow the LMA procedure for the Proxy Mobile IPv6 Mobile Network Prefix Allocation procedure as defined in sub clause 5.12.3. + +--- + +## 9 Trusted Non-3GPP Access over S2a Description + +### 9.0 General + +Please refer to clause 13 for the description of the Trusted WLAN Access over S2a interface. + +## 9.1 Initial Attach procedures + +### 9.1.1 General + +### 9.1.2 Trusted Non-3GPP Access procedures + +In PMIPv6 mode, the Trusted Non-3GPP Access shall follow the MAG procedure for the PMIPv6 PDN Connection Creation as outlined in subclause 5.1.2. + +### 9.1.3 PDN GW procedures + +In PMIPv6 mode, the PDN GW shall follow the MAG procedure for the PMIPv6 PDN Connection Creation as outlined in subclause 5.1.3. + +The PGW may include a PGW Back-Off Time IE when rejecting the PBU with the cause "APN congestion" (see subclause 4.5.8 of 3GPP TS 23.402 [3]). + +## 9.2 Trusted Non-3GPP Access Initiated PDN Connection Lifetime Extension procedures + +### 9.2.1 General + +### 9.2.2 Trusted Non-3GPP Access procedures + +In PMIPv6 mode, the Trusted Non-3GPP Access shall follow the MAG procedure for the PMIPv6 PDN Connection Lifetime Extension as outlined in subclause 5.2.2. + +### 9.2.3 PDN GW procedures + +In PMIPv6 mode, the PDN GW shall follow the LMA procedure for the PMIPv6 PDN Connection Lifetime Extension as outlined in subclause 5.2.3. + +## 9.3 UE / Trusted Non-3GPP Access Initiated Detach and UE Requested PDN Disconnection procedures + +### 9.3.1 General + +### 9.3.2 Trusted Non-3GPP Access procedures + +In PMIPv6 mode, the Trusted Non-3GPP Access shall follow the MAG procedure for the PMIPv6 MAG Initiated PDN Connection Deletion as outlined in subclause 5.4.2 for PDN Disconnection procedure,. + +For Detach the Trusted Non-3GPP Access shall follow the above repeated for each PDN connection of the UE. + +### 9.3.3 PDN GW procedures + +In PMIPv6 mode, the PDN GW shall follow the LMA procedure for the PMIPv6 MAG Initiated PDN Connection Deletion as outlined in subclause 5.4.3. + +## 9.4 HSS / AAA Initiated Detach procedures + +### 9.4.1 General + +The HSS/AAA may initiate a detach procedure resulting in a PMIPv6 De-Registration. + +### 9.4.2 Trusted Non-3GPP Access procedures + +In PMIPv6 mode, the Trusted Non-3GPP Access shall follow the MAG procedure for the PMIPv6 MAG Initiated PDN Connection Deletion as outlined in subclause 5.4.2 repeated for each PDN connection of the UE. + +### 9.4.3 PDN GW procedures + +In PMIPv6 mode, the PDN GW shall follow the LMA procedure for the PMIPv6 MAG Initiated PDN Connection Deletion as outlined in subclause 5.4.3. + +## 9.5 UE Initiated Connectivity to Additional PDN procedures + +### 9.5.1 General + +### 9.5.2 Trusted Non-3GPP Access procedures + +In PMIPv6 mode, if the Request Type indicates "initial attach", the Trusted Non-3GPP Access shall follow the MAG procedure for the PMIPv6 PDN Connection Creation as outlined in subclause 5.1.2. If the Request Type indicates "Handover", the Trusted Non-3GPP Access shall follow the MAG procedure for the PMIPv6 PDN Connection Handover as outlined in subclause 5.3.2. + +### 9.5.3 PDN GW procedures + +In PMIPv6 mode, if the Request Type indicates "initial attach", the PDN GW shall follow the LMA procedure for the PMIPv6 PDN Connection Creation as outlined in subclause 5.1.3. If the Request Type indicates "Handover", the PDN GW shall follow the LMA procedure for the PMIPv6 PDN Connection Handover as outlined in subclause 5.3.3. + +If the Request Type indicates "initial attach" or "handover", the PGW may include a PGW Back-Off Time IE when rejecting the PBU with the cause "APN congestion" (see subclause 4.5.8 of 3GPP TS 23.402 [3]). + +## 9.6 3GPP Access to Trusted Non-3GPP IP Access with PMIPv6 on S2a Handover procedures without optimization + +### 9.6.1 General + +### 9.6.2 Trusted Non-3GPP Access procedures + +In PMIPv6 mode, the Trusted Non-3GPP Access shall follow the MAG procedure for the PMIPv6 PDN Connection Handover as outlined in subclause 5.3.2. + +### 9.6.3 PDN GW procedures + +In PMIPv6 mode, the PDN GW shall follow the LMA procedure for the PMIPv6 PDN Connection Handover as outlined in subclause 5.3.3. + +If IPv6 network prefix preservation is supported at a handover from 3GPP Access with a GTP-based S5/S8 to non-3GPP Access, the LMA shall provide to the MAG the link-local address which is used by the PDN GW at the link shared with the UE in the 3GPP Access. + +## 9.7 PDN GW Initiated Resource Allocation Deactivation procedures + +### 9.7.1 General + +### 9.7.2 Trusted Non-3GPP Access procedures + +In PMIPv6 mode, the Trusted Non-3GPP Access shall follow the MAG procedure for the PMIPv6 LMA Initiated PDN Connection Deletion as outlined in subclause 5.5.2. + +### 9.7.3 PDN GW procedures + +In PMIPv6 mode, the PDN GW shall follow the LMA procedure for the PMIPv6 LMA Initiated PDN Connection Deletion as outlined in subclause 5.5.3. + +## 9.8 IPv4 Address Allocation using DHCP + +### 9.8.1 General + +### 9.8.2 Trusted Non-3GPP Access procedures + +The Trusted Non-3GPP Access shall follow the MAG procedure for the Proxy Mobile IPv6 PDN Connection IPv4 Address Allocation Procedure as defined in sub clause 5.6.2. + +### 9.8.3 PDN GW procedures + +The PDN GW shall follow the LMA procedure for the Proxy Mobile IPv6 PDN Connection IPv4 Address Allocation Procedure as defined in sub clause 5.6.3. + +## 9.9 PDN-GW Initiated IPv4 Address Delete Procedure + +### 9.9.1 General + +### 9.9.2 Trusted Non-3GPP Access procedures + +If UE is assigned both IPv6 HNP and IPv4 HoA, the Trusted Non-3GPP Access shall follow the MAG procedure for the LMA Initiated IPv4 Address Release procedure as defined in sub clause 5.7.2. + +### 9.9.3 PDN GW procedures + +If UE is assigned both IPv6 HNP and IPv4 HoA, the PDN GW shall follow the LMA procedure for the LMA Initiated IPv4 Address Release procedure as defined in sub clause 5.7.3. + +If UE is assigned only IPv4 HoA, then PDN-GW initiated Resource Allocation Deactivation procedure is initiated. + +## 9.10 Optimized E-UTRAN to CDMA2000 eHRPD Handover procedure + +### 9.10.1 General + +### 9.10.2 CDMA2000 HRPD access procedure + +In PMIPv6 mode, the CDMA2000 HRPD access shall follow the MAG procedure for the PMIPv6 PDN Connection Handover procedure as outlined in subclause 5.3.2. + +### 9.10.3 PDN GW procedures + +In PMIPv6 mode, the PDN GW shall follow the LMA procedure for the PMIPv6 PDN Connection Handover procedure as outlined in subclause 5.3.3. + +## 9.11 Optimized Idle Mode Mobility: E-UTRAN Access to cdma2000 eHRPD Access procedure + +### 9.11.1 General + +### 9.11.2 CDMA2000 eHRPD access procedure + +In PMIPv6 mode, the CDMA2000 eHRPD access shall follow the MAG procedure for the PMIPv6 PDN Connection Handover procedure as outlined in subclause 5.3.2. + +### 9.11.3 PDN GW procedures + +In PMIPv6 mode, the PDN GW shall follow the LMA procedure for the PMIPv6 PDN Connection Handover procedure as outlined in subclause 5.3.3. + +--- + +## 10 Untrusted Non-3GPP Access over S2b Description + +### 10.1 Initial Attach procedures + +#### 10.1.1 General + +If multiple authentications are supported by the network both ePDG and PDN GW shall support the corresponding procedures as specified for PAP and CHAP authentication of the UE with external networks in 3GPP TS 33.402 [19]. Multiple authentication is per PDN connection when the UE requested additional PDN connectivity as specified in subclause 10.5. + +#### 10.1.2 ePDG procedures + +In PMIPv6 mode, the ePDG shall follow the MAG procedure for the PMIPv6 PDN Connection Creation as outlined in subclause 5.1.2. + +If ePDG supports multiple authentication exchanges with the UE in the IKEv2 protocol, the ePDG shall send the PAP or CHAP additional authentication and authorization information received from the UE in the Additional Protocol Configuration Options IE in the PBU to the PDN-GW as specified 3GPP TS 33.402 [19]. The ePDG shall follow the multiple authentication procedures when receiving PAP or CHAP additional authentication and authorization information in the Additional Protocol Configuration Options IE in the PBA from the PDN-GW and sending the information to the UE as specified in 3GPP TS 33.402 [19]. + +If the UE requests the DNS IPv4/IPv6 address in the Configuration Payload (CFG\_REQ) during the IPsec tunnel establishment procedure, as specified 3GPP TS 33.402 [19], and if the ePDG supports the Additional Protocol Configuration Options IE, the ePDG may include this IE in the PBU to the PDN-GW and correspondingly set "DNS IPv4/IPv6 Server Address Request" parameter. If the ePDG receives the Additional Protocol Configuration Options IE with "DNS Server IPv4/v6 Address" parameter in the PBA from the PDN-GW, the ePDG shall send this information in the Configuration Payload (CFG\_REPLY) to the UE as specified in 3GPP TS 33.402 [19]. + +If the UE includes the P-CSCF\_IP6\_ADDRESS attribute, or the P-CSCF\_IP4\_ADDRESS attribute or both in the CFG\_REQUEST configuration payload during the IPsec tunnel establishment procedure as specified in 3GPP TS 24.302 [39], and if the ePDG supports these IKEv2 attributes and the Additional Protocol Configuration Options IE, the ePDG shall include the Additional Protocol Configuration Options IE in the PBU to the PDN-GW and correspondingly set the P-CSCF IPv6 Address Request, or P-CSCF IPv4 Address Request, or both parameters as defined in 3GPP TS 24.008 [16]. If the ePDG receives the Additional Protocol Configuration Options IE with the P-CSCF IPv4 Address, or P-CSCF IPv6 Address, or both parameters respectively in the PBA from the PDN-GW, the ePDG shall send these information in the Configuration Payload (CFG\_REPLY) to the UE as specified in 3GPP TS 24.302 [39]. + +If the UE includes the P-CSCF\_RESELECTION\_SUPPORT attribute in the CFG\_REQUEST configuration payload during the IPsec tunnel establishment procedure as specified in 3GPP TS 24.302 [39], and if the ePDG supports the P-CSCF restoration extension procedure for the untrusted WLAN access (see 3GPP TS 23.380 [36]), the ePDG shall include the Additional Protocol Configuration Options IE in the PBU to the PDN-GW and correspondingly set the P-CSCF\_RESELECTION\_SUPPORT, as defined in 3GPP TS 24.008 [16]. + +#### 10.1.3 PDN GW procedures + +In PMIPv6 mode, the PDN GW shall follow the LMA procedure for the PMIPv6 PDN Connection Creation as outlined in subclause 5.1.3. + +If PDN GW supports multiple authentications it shall send the PAP or CHAP additional authentication and authorization information received from the ePDG in the Additional Protocol Configuration Options IE in the PBU to the external AAA server and the PDN GW shall send the PAP or CHAP additional authentication and authorization information received from the external AAA server to the ePDG in the Additional Protocol Configuration Options IE in the PBA as specified in 3GPP TS 33.402 [19]. + +If the PDN-GW supports Additional Protocol Configuration Options IE and if the PDN-GW receives it with the "DNS IPv4/IPv6 Server Address Request" parameter in the PBU from the ePDG, the PGW may include the Additional Protocol Configuration Options IE in the PBA and correspondingly set "DNS IPv4/IPv6 Address" as specified in 3GPP TS 24.008 [16]. + +If the PDN-GW supports the Additional Protocol Configuration Options IE and if the PGW receives it with the P-CSCF IPv4 Address Request, or P-CSCF IPv6 Address Request or both parameters in the PBU from the ePDG, the PGW may include the Additional Protocol Configuration Options IE in the PBA and correspondingly set it with the P-CSCF IPv4 Address, or P-CSCF IPv6 Address, or both parameters respectively as specified in 3GPP TS 24.008 [16]. + +## 10.2 ePDG Initiated PDN Connection Lifetime Extension procedures + +### 10.2.1 General + +### 10.2.2 ePDG procedures + +In PMIPv6 mode, the ePDG shall follow the MAG procedure for the PMIPv6 PDN Connection Lifetime Extension as outlined in subclause 5.2.2. + +### 10.2.3 PDN GW procedures + +In PMIPv6 mode, the PDN GW shall follow the LMA procedure for the PMIPv6 PDN Connection Lifetime Extension as outlined in subclause 5.2.3. + +## 10.3 UE / ePDG Initiated Detach and UE Requested PDN Disconnection procedures + +### 10.3.1 General + +### 10.3.2 ePDG procedures + +In PMIPv6 mode, the ePDG shall follow the MAG procedure for the PMIPv6 MAG Initiated PDN Connection Deletion as outlined in subclause 5.4.2 for PDN Disconnection procedure, + +For Detach the ePDG shall follow the above repeated for each PDN connection of the UE. + +### 10.3.3 PDN GW procedures + +In PMIPv6 mode, the PDN GW shall follow the LMA procedure for the PMIPv6 MAG Initiated PDN Connection Deletion as outlined in subclause 5.4.3. + +## 10.4 HSS / AAA Initiated Detach procedures + +### 10.4.1 General + +The HSS/AAA may initiate a detach procedure resulting in a PMIPv6 De-Registration. + +### 10.4.2 ePDG procedures + +In PMIPv6 mode, the ePDG shall follow the MAG procedure for the PMIPv6 MAG Initiated PDN Connection Deletion as outlined in subclause 5.4.2 repeated for each PDN connection of the UE. + +### 10.4.3 PDN GW procedures + +In PMIPv6 mode, the PDN GW shall follow the LMA procedure for the PMIPv6 MAG Initiated PDN Connection Deletion as outlined in subclause 5.4.3. + +## 10.5 UE Initiated Connectivity to Additional PDN procedures + +### 10.5.1 General + +### 10.5.2 ePDG procedures + +In PMIPv6 mode, if the Request Type indicates "initial attach", the ePDG shall follow the MAG procedure for the PMIPv6 PDN Connection Creation as outlined in subclause 5.1.2. If the Request Type indicates "Handover", the ePDG shall follow the MAG procedure for the PMIPv6 PDN Connection Handover as outlined in subclause 5.3.2. + +If the UE requests the DNS IPv4/IPv6 address in the Configuration Payload (CFG\_REQ) during the IPsec tunnel establishment procedure, as specified 3GPP TS 33.402 [19], and if the ePDG supports the Additional Protocol Configuration Options IE, the ePDG may include this IE in the PBU to the PDN-GW and correspondingly set "DNS IPv4/IPv6 Server Address Request" parameter. If the ePDG receives the Additional Protocol Configuration Options IE with "DNS Server IPv4/v6 Address" parameter in the PBA from the PDN-GW, the ePDG shall send this information in the Configuration Payload (CFG\_REPLY) to the UE as specified in 3GPP TS 33.402 [19]. + +If the UE includes the P-CSCF\_IP6\_ADDRESS attribute, or the P-CSCF\_IP4\_ADDRESS attribute or both in the CFG\_REQUEST configuration payload during the IPsec tunnel establishment procedure as specified in 3GPP TS 24.302 [39], and if the ePDG supports these IKEv2 attributes and the Additional Protocol Configuration Options IE, the ePDG shall include the Additional Protocol Configuration Options IE in the PBU to the PDN-GW and correspondingly set the P-CSCF IPv6 Address Request, or P-CSCF IPv4 Address Request, or both parameters as defined in 3GPP TS 24.008 [16]. If the ePDG receives the Additional Protocol Configuration Options IE with the P-CSCF IPv4 Address, or P-CSCF IPv6 Address, or both parameters respectively in the PBA from the PDN-GW, the ePDG shall send these information in the Configuration Payload (CFG\_REPLY) to the UE as specified in 3GPP TS 24.302 [39]. + +If the UE includes the P-CSCF\_RESELECTION\_SUPPORT attribute in the CFG\_REQUEST configuration payload during the IPsec tunnel establishment procedure as specified in 3GPP TS 24.302 [39], and if the ePDG supports the P-CSCF restoration extension procedure for the untrusted WLAN access (see 3GPP TS 23.380 [36]), the ePDG shall include the Additional Protocol Configuration Options IE in the PBU to the PDN-GW and correspondingly set the P-CSCF\_RESELECTION\_SUPPORT, as defined in 3GPP TS 24.008 [16]. + +### 10.5.3 PDN GW procedures + +In PMIPv6 mode, if the Request Type indicates "initial attach", the PDN GW shall follow the LMA procedure for the PMIPv6 PDN Connection Creation as outlined in subclause 5.1.3. If the Request Type indicates "Handover", the PDN GW shall follow the LMA procedure for the PMIPv6 PDN Connection Handover as outlined in subclause 5.3.3. + +If the PDN-GW supports Additional Protocol Configuration Options IE and if the PDN-GW receives it with the "DNS IPv4/IPv6 Server Address Request" parameter in the PBU from the ePDG, the PGW may include the Additional Protocol Configuration Options IE in the PBA and correspondingly set "DNS IPv4/IPv6 Address" as specified in 3GPP TS 24.008 [16]. + +If the PDN-GW supports the Additional Protocol Configuration Options IE and if the PGW receives it with the P-CSCF IPv4 Address Request, or P-CSCF IPv6 Address Request or both parameters in the PBU from the ePDG, the PGW may include the Additional Protocol Configuration Options IE in the PBA and correspondingly set it with the P-CSCF IPv4 Address, or P-CSCF IPv6 Address, or both parameters respectively as specified in 3GPP TS 24.008 [16]. + +## 10.6 3GPP Access to Untrusted Non-3GPP IP Access with PMIPv6 on S2b Handover procedures without optimization + +### 10.6.1 General + +### 10.6.2 ePDG procedures + +In PMIPv6 mode, the ePDG shall follow the MAG procedure for the PMIPv6 PDN Connection Handover as outlined in subclause 5.3.2. + +If the UE includes the P-CSCF\_RESELECTION\_SUPPORT attribute in the CFG\_REQUEST configuration payload during the IPsec tunnel establishment procedure as specified in 3GPP TS 24.302 [39], and if the ePDG supports the P- + +CSCF restoration extension procedure for the untrusted WLAN access (see 3GPP TS 23.380 [36]), the ePDG shall include the Additional Protocol Configuration Options IE in the PBU to the PDN-GW and correspondingly set the P-CSCF\_RESELECTION\_SUPPORT, as defined in 3GPP TS 24.008 [16]. + +### 10.6.3 PDN GW procedures + +In PMIPv6 mode, the PDN GW shall follow the LMA procedure for the PMIPv6 PDN Connection Handover as outlined in subclause 5.3.3. + +If IPv6 network prefix preservation is supported at a handover from 3GPP Access with a GTP-based S5/S8 to non-3GPP Access, the LMA shall provide to the MAG the link-local address which is used by the PDN GW at the link shared with the UE in the 3GPP Access. + +## 10.7 PDN GW Initiated Resource Allocation Deactivation procedures + +### 10.7.1 General + +### 10.7.2 ePDG procedures + +In PMIPv6 mode, the ePDG shall follow the MAG procedure for the PMIPv6 LMA Initiated PDN Connection Deletion as outlined in subclause 5.5.2. + +### 10.7.3 PDN GW procedures + +In PMIPv6 mode, the PDN GW shall follow the LMA procedure for the PMIPv6 LMA Initiated PDN Connection Deletion as outlined in subclause 5.5.3. + +The PGW shall include the 3GPP Specific PMIPv6 error code IE and set it to the cause "Reactivation requested" when the PGW initiates the PDN GW Initiated Resource Allocation Deactivation procedure as part of the P-CSCF restoration procedure over WLAN access, as specified in 3GPP TS 23.380 [36]. + +## 10.8 PDN-GW Initiated IPv4 Address Delete Procedure + +### 10.8.1 General + +### 10.8.2 ePDG procedures + +If UE is assigned both IPv6 HNP and IPv4 HoA, the ePDG shall follow the MAG procedure for the LMA Initiated IPv4 Address Release procedure as defined in sub clause 5.7.2. + +### 10.8.3 PDN GW procedures + +If UE is assigned both IPv6 HNP and IPv4 HoA, the PDN GW shall follow the LMA procedure for the LMA Initiated IPv4 Address Release procedure as defined in sub clause 5.7.3. + +If UE is assigned only IPv4 HoA, then PDN-GW initiated Resource Allocation Deactivation procedure is initiated. + +--- + +## 11 S2a and S2b Chaining with PMIP-based S8 Description + +### 11.1 Initial Attach procedures + +#### 11.1.1 General + +#### 11.1.2 ePDG / Trusted Non-3GPP Access procedures + +In PMIPv6 mode, the ePDG or Trusted Non-3GPP Access shall follow the MAG procedure for the PMIPv6 PDN Connection Creation. In addition to the general procedure, it shall include the PDN GW IP address received during the authorization procedure into the PBU request, encoding it into a Vendor-Specific Option (refer to clause 12.1.1.4). + +#### 11.1.3 Serving GW procedures + +In PMIPv6 mode, the Serving GW shall follow: + +- the LMA procedure for the PMIPv6 PDN Connection Creation on the S2a/S2b interface. In addition to the general procedure, the Serving GW shall include the PDN GW IP address received in the PBU request into the PBA, using the same encoding (refer to clause 12.1.1.4). +- the MAG procedure for the PMIPv6 PDN Connection Creation on the S8 interface. The Serving GW shall send the PBU request to the PDN GW IP address received on the chained S2a / S2b interface. + +### 11.2 ePDG / Trusted Non-3GPP Access Initiated PDN Connection Lifetime Extension procedures + +#### 11.2.1 General + +#### 11.2.2 ePDG / Trusted Non-3GPP Access procedures + +In PMIPv6 mode, the ePDG or Trusted Non-3GPP Access shall follow the MAG procedure for the PMIPv6 PDN Connection Lifetime Extension. + +#### 11.2.3 Serving GW procedures + +In PMIPv6 mode, the Serving GW shall follow: + +- the LMA procedure for the PMIPv6 PDN Connection Lifetime Extension on the S2a/S2b interface. +- the MAG procedure for the PMIPv6 PDN Connection Lifetime Extension on the S8 interface. + +### 11.3 UE / ePDG / Trusted Non-3GPP Access Initiated Detach procedures + +#### 11.3.1 General + +#### 11.3.2 ePDG / Trusted Non-3GPP Access procedures + +In PMIPv6 mode, the ePDG or Trusted Non-3GPP Access shall follow the MAG procedure for the PMIPv6 MAG Initiated PDN Connection Deletion repeated for each PDN connection of the UE. + +#### 11.3.3 Serving GW procedures + +In PMIPv6 mode, the Serving GW shall follow: + +- the LMA procedure for the PMIPv6 MAG Initiated PDN Connection Deletion on the S2a/S2b interface. + +- the MAG procedure for the PMIPv6 MAG Initiated PDN Connection Deletion on the S8 interface. + +## 11.4 HSS / AAA Initiated Detach procedures + +### 11.4.1 General + +The HSS/AAA may initiate a detach procedure resulting in a PMIPv6 De-Registration. + +### 11.4.2 ePDG / Trusted Non-3GPP Access procedures + +In PMIPv6 mode, the ePDG or Trusted Non-3GPP Access shall follow the MAG procedure for the PMIPv6 MAG Initiated PDN Connection Deletion repeated for each PDN connection of the UE. + +### 11.4.3 Serving GW procedures + +In PMIPv6 mode, the Serving GW shall follow: + +- the LMA procedure for the PMIPv6 MAG Initiated PDN Connection Deletion on the S2a/S2b interface. +- the MAG procedure for the PMIPv6 MAG Initiated PDN Connection Deletion on the S8 interface. + +## 11.5 UE Initiated Connectivity to Additional PDN procedures + +### 11.5.1 General + +### 11.5.2 ePDG / Trusted Non-3GPP Access procedures + +In PMIPv6 mode, the ePDG or Trusted Non-3GPP Access shall follow the MAG procedure for the PMIPv6 PDN Connection Creation if the Request Type indicates "initial attach", or the PMIPv6 PDN Connection Handover if the Request Type indicates "Handover". In addition to the general procedure, it shall include the PDN GW IP address received during the authorization procedure into the PBU request, encoding it to the Vendor-Specific Option (refer to clause 12.1.1.4). + +### 11.5.3 Serving GW procedures + +In PMIPv6 mode, the Serving GW shall follow: + +- the LMA procedure for the PMIPv6 PDN Connection Creation if the Request Type indicates "initial attach", or the PMIPv6 PDN Connection Handover if the Request Type indicates "Handover" on the S2a/S2b interface. In addition to the general procedure, the Serving GW shall include the PDN GW IP address received in the PBU request into the PBA, using the same encoding (refer to clause 12.1.1.4). +- the MAG procedure for the PMIPv6 PDN Connection Creation if the Request Type indicates "initial attach", or the PMIPv6 PDN Connection Handover if the Request Type indicates "Handover" on the S8 interface. The Serving GW shall send the PBU request to the PDN GW IP address received on the chained S2a / S2b interface. + +## 11.6 3GPP Access to Trusted / Untrusted Non-3GPP IP Access Handover procedures without optimization + +### 11.6.1 General + +### 11.6.2 ePDG / Trusted Non-3GPP Access procedures + +In PMIPv6 mode, the ePDG or Trusted Non-3GPP Access shall follow the MAG procedure for the PMIPv6 PDN Connection Handover. In addition to the general procedure, it shall include the PDN GW IP address received during the authorization procedure into the PBU request, encoding it to the Vendor-Specific Option (refer to clause 12.1.1.4). + +### 11.6.3 Serving GW procedures + +In PMIPv6 mode, the Serving GW shall follow: + +- the LMA procedure for the PMIPv6 PDN Connection Handover on the S2a/S2b interface. In addition to the general procedure, the Serving GW shall include the PDN GW IP address received in the PBU request into the PBA, using the same encoding (refer to clause 12.1.1.4). +- the MAG procedure for the PMIPv6 PDN Connection Handover on the S8 interface. The Serving GW shall send the PBU request to the PDN GW IP address received on the chained S2a / S2b interface. + +## 11.7 UE Requested PDN Disconnection procedures + +### 11.7.1 General + +### 11.7.2 ePDG / Trusted Non-3GPP Access procedures + +In PMIPv6 mode, the ePDG or Trusted Non-3GPP Access shall follow the MAG procedure for the PMIPv6 MAG Initiated PDN Connection Deletion, for the selected PDN connection. + +### 11.7.3 Serving GW procedures + +In PMIPv6 mode, the Serving GW shall follow: + +- the LMA procedure for the PMIPv6 MAG Initiated PDN Connection Deletion, for the selected PDN connection on the S2a/S2b interface. +- the MAG procedure for the PMIPv6 MAG Initiated PDN Connection Deletion, for the selected PDN connection on the S8 interface. + +## 11.8 PDN GW Initiated Resource Allocation Deactivation procedures + +### 11.8.1 General + +### 11.8.2 ePDG / Trusted Non-3GPP Access procedures + +In PMIPv6 mode, the ePDG or Trusted Non-3GPP Access shall follow the MAG procedure for the PMIPv6 LMA Initiated PDN Connection Deletion. + +### 11.8.3 Serving GW procedures + +In PMIPv6 mode, the Serving GW shall follow: + +- the MAG procedure for the PMIPv6 LMA Initiated PDN Connection Deletion on the S8 interface. +- the LMA procedure for the PMIPv6 LMA Initiated PDN Connection Deletion on the S2a/S2b interface. + +--- + +## 12 Information Elements + +### 12.1 Additional Proxy Mobile IPv6 Information Elements + +#### 12.1.1 3GPP-Specific PMIPv6 Information Elements + +##### 12.1.1.0 General + +This specification requires the encoding of additional 3GPP-specific Information Elements for PMIPv6 with the 3GPP Mobility Option, as defined by 3GPP TS 29.282 [24]. The 3GPP specific Information Elements defined by this specification are listed in the table 12.1.1.0-1. + +**Table 12.1.1.0-1: 3GPP Specific PMIPv6 Information Elements** + +| 3GPP Specific PMIPv6 Information Element | 3GPP Specific PMIPv6 Information Element Description | +|-------------------------------------------------|--------------------------------------------------------------------------------------------------| +| Protocol Configuration Options | 3GPP PCO data, in the format from 3GPP TS 24.008 [16] subclause 10.5.6.3, starting with octet 3. | +| 3GPP Specific PMIPv6 error code | 3GPP Vendor-Specific PMIPv6 error code, as specified in subclause 12.1.1.1 | +| PDN GW IP address | PDN GW IP address, as specified in subclause 12.1.1.4 | +| DHCPv4 Address Allocation Procedure Indication | DHCPv4 Address Allocation Procedure Indication, as specified in subclause 12.1.1.5. | +| Fully Qualified PDN Connection Set Identifier | FQ-CSID as specified in subclause 12.1.1.2 | +| PDN Type Indication | PDN type indication as specified in subclause 12.1.1.3 | +| Charging ID | Charging ID as specified in subclause 12.1.1.6 | +| Selection Mode | Selection Mode as specified in subclause 12.1.1.7 | +| Charging Characteristics | Subclause 12.1.1.8 | +| Serving Network | Subclause 12.1.1.9 | +| Mobile Equipment Identity | Subclause 12.1.1.10 | +| MSISDN | Subclause 12.1.1.11 | +| APN Restriction | Subclause 12.1.1.12 | +| Maximum APN Restriction | Subclause 12.1.1.13 | +| Unauthenticated IMSI | Subclause 12.1.1.14 | +| PDN Connection ID | Subclause 12.1.1.15 | +| PGW Back-Off Time | Subclause 12.1.1.16 | +| Signalling Priority Indication | Subclause 12.1.1.17 | +| Static IP Address Allocation Indication | Subclause 12.1.1.18 | +| Additional Protocol Configuration Options | Subclause 12.1.1.19 | +| MME/SGSN Identifier | Subclause 12.1.1.20 | +| End Marker Notification | Subclause 12.1.1.21 | +| Trusted WLAN Mode Indication | Subclause 12.1.1.22 | +| UE Time Zone | Subclause 12.1.1.23 | +| Access Network Identifier Timestamp | Subclause 12.1.1.24 | +| Logical Access ID | Subclause 12.1.1.25 | +| Origination Time Stamp | Subclause 12.1.1.26 | +| Maximum Wait Time | Subclause 12.1.1.27 | +| TWAN Capabilities | Subclause 12.1.1.28 | + +Depending on the need for 3GPP-specific information content, there several items of this information element may be added to the PBU, PBA, BRI, BRA, UPN or UPA. + +The subtype for a 3GPP specific PMIPv6 Information Element is defined in 3GPP TS 29.282 [24]. The data format of the 3GPP specific PMIPv6 Information Element is defined in this specification. If the data format is defined by another specification, that specification shall be referenced in the table above. + +#### 12.1.1.1 3GPP Specific PMIPv6 error code + +Proxy Binding Acknowledgement (PBA) and Binding Revocation Acknowledgment (BRA) contain a mandatory Status information element and also may contain a 3GPP Specific PMIPv6 Error Code (3GSPEC) information element, which is coded within Mobility Options field. + +NOTE: ETSI RFC 5213 [4] and IETF RFC 6275 [8] specify PMIPv6 Status values for a PBA message for indicating the acceptance of a message, or for reporting an error. Up-to-date values for the Status field are specified in the IANA registry of assigned numbers [32]. IETF RFC 5846 [6] specifies PMIPv6 Status values for the BRA message. Up-to-date BRA status values are specified in the IANA registry of assigned numbers [33]. + +Binding Revocation Indication (BRI) may contain a 3GPP Specific PMIPv6 Error Code (3GSPEC) information element, which is coded within Mobility Options field. + +The purpose of the 3GSPEC information element, which is depicted in Figure 12.1.1.1-1 is to carry a GTPv2 Cause value within PMIPv6 messages. 3GPP TS 29.274 [22] specifies GTPv2 Cause values. + +![](f92e919c70b7adda2d0e778889f44fae_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|---------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP Specific PMIPv6 Error Code | | | | | | | | + +Figure 12.1.1.1-1: 3GPP Specific PMIPv6 Error Code + +If MAG/SGW receives a 3GSPEC IE in Proxy Binding Acknowledgement message from LMA/PGW, which requires that the MAG/SGW shall send a GTPv2 message to MME/SGSN, then the MAG/SGW shall copy 3GSPEC value into GTPv2 Cause IE. If in such case, the MAG/SGW does not receive 3GSPEC IE with PBA, depending on the overall meaning of the PMIPv6 Status IE the MAG/SGW shall send to MME/SGSN one of the following GTPv2 Cause values with CS bit set to 1: + +- a) - "Request Accepted" (decimal 16), if the received PMIPv6 Status indicates PBU acceptance. +- b) - "Request rejected for a PMIP reason" (decimal 112), if the received PMIPv6 Status indicates PBU rejection. + +If MAG/SGW receives a 3GSPEC IE in Binding Revocation Indication message from LMA/PGW, which requires that the MAG/SGW shall send a GTPv2 message to MME/SGSN, then the MAG/SGW shall copy 3GSPEC value into GTPv2 Cause IE with CS bit set to 1. + +If MAG/SGW receives a Cause IE with a GTPv2 message, which requires sending a Binding Revocation Acknowledgement message to LMA/PGW, the MAG/SGW shall copy the GTPv2 Cause value into the 3GSPEC IE. + +#### 12.1.1.2 Fully Qualified PDN Connection Set Identifier (FQ-CSID) + +A fully qualified PDN Connection Set Identifier (FQ-CSID) identifies a set of PDN connections belonging to an arbitrary number of UEs on a node such as a MME, SGW or PGW. The FQ-CSID is generated by the MAG, the LMA and any other node such as the MME for 3GPP access. It is generated for each new PDN connection, and it is used in case of partial node failure to identify the PDN connections associated with a Connection Set Identifier. + +The FQ-CSID is coded as follows: + +| Octets | Bits | | | | | | | | | | | | +|----------------|---------------------------------------------|---|---|---|--------------------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Node-ID Type | | | | Number of CSIDs= m | | | | | | | | +| 2 to p | Node-ID | | | | | | | | | | | | +| (p+1) to (p+2) | First PDN Connection Set Identifier (CSID) | | | | | | | | | | | | +| (p+3) to (p+4) | Second PDN Connection Set Identifier (CSID) | | | | | | | | | | | | +| ... | ... | | | | | | | | | | | | +| (m-1) to m | m"th PDN Connection Set Identifier (CSID) | | | | | | | | | | | | + +Figure 12.1.1.2-1: FQ-CSID + +The details of each field and value are specified in 3GPP TS 29.274[22]. + +### 12.1.1.3 PDN Type Indication + +The purpose of the PDN type indication option is to indicate the GW decision to change the PDN type and a cause for the change. This attribute is set by the LMA in the PBA. + +The MAG shall set the PDN type accordingly, if this option is present in the PBA. + +| Octets | Bits | | | | | | | | +|--------|----------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | PDN type | | | | | | | | +| 2 | Cause | | | | | | | | + +Figure 12.1.1.3-1: PMIPv6 PDN type indication + +The following defines the value of the PMIPv6 PDN type indication. + +| | +|----------------------------------------------| +| PDN type value | +| #1: IPv4 | +| #2: IPv6 | +| Cause value as defined in 3GPP TS 29.274[13] | +| #18: New PDN type due to network preference; | + +### 12.1.1.4 PDN GW IP address + +The purpose of the PDN GW IP address information element is to carry the IP address of the PDN GW to which the receiving Serving GW shall send a PBU on the chained S8 interface. This information element shall be included in a PBU for initial attach or handover sent on S2a or S2b interface for S2a/S2b - PMIP based S8 chaining scenario. + +This information element shall be included in an Update Notification message according to the conditions specified in subclause 20.2.7.1 of 3GPP TS 23.007 [13]. + +The content and encoding of the PDN GW IP address is depicted on Figure 12.1.1.4-1. + +| Octets | Bits | | | | | | | | +|--------|----------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1-4/16 | IPv4 or IPv6 Address | | | | | | | | + +Figure 12.1.1.4-1: PDN GW IP Address + +#### 12.1.1.5 DHCPv4 Address Allocation Procedure Indication + +The purpose of the DHCPv4 Address Allocation option is to indicate that DHCPv4 is to be used in allocating the IPv4 address to the UE if the option is present in the PBA message. + +#### 12.1.1.6 Charging ID + +The Charging ID is defined in figure 12.1.1.6-1. + +![](c020c072c67473d7823d1f9551942732_img.jpg) + +| Octets | Bits | | | | | | | | +|---------------|-------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1-4 | Charging ID value | | | | | | | | + +**Figure 12.1.1.6-1: Charging ID** + +### 12.1.1.7 Selection Mode + +Selection Mode indicates the way the MME or SGSN selected the APN: whether a subscribed APN was selected, or whether a non-subscribed APN sent by a UE or a non-subscribed APN chosen by the SGSN was selected. The Selection Mode is defined in 3GPP TS 23.060 [23] + +The encoding of the Selection Mode is shown in Figure 12.1.1.7-1. + +![](a363e069a25ec09f106b2f5609adecba_img.jpg) + +| | Bits | | | | | | | | +|--------|----------|---|---|---|---|---|----------------|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| Octets | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Reserved | | | | | | Selection Mode | | + +**Figure 12.1.1.7-1: Selection mode** + +The reserved bits shall be set to 1 by the MAG and not processed by the LMA. + +The defined Selection Mode values are shown in Table 12.1.1.7-1. + +**Table 12.1.1.7-1: Selection Mode** + +| Value | Selection mode value | +|-------|----------------------------------------------------------------------------------------| +| 0 | MS or network provided APN, subscribed verified | +| 1 | MS provided APN, subscription not verified | +| 2 | Network provided APN, subscription not verified | +| 3 | For future use. Shall not be sent. If received, shall be interpreted as the value '2'. | + +### 12.1.1.8 Charging Characteristics + +The Charging Characteristics information element is defined in 3GPP TS 32.251 [25] and is a way of informing both the SGW and PGW of the rules for producing charging information based on operator configured triggers. For the encoding of this information element see 3GPP TS 32.298 [26]. + +The Charging Characteristics is defined in figure 12.1.1.8-1. + +![](13345bf381e6bb956d897e5791dfae18_img.jpg) + +| | Bits | | | | | | | | +|--------|--------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| Octets | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1-2 | Charging Characteristics value | | | | | | | | + +**Figure 12.1.1.8-1: Charging Characteristics** + +### 12.1.1.9 Serving Network + +Serving Network identifies the serving network the UE is attached to. The format of the Serving Network 3GPP-specific Information Element is defined below. + +| Octets | Bits | | | | | | | | +|--------|-------------|---|---|---|-------------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | MCC digit 2 | | | | MCC digit 1 | | | | +| 2 | MNC digit 3 | | | | MNC digit 2 | | | | +| 3 | MNC digit 1 | | | | | | | | + +Figure 12.1.1.9-1 + +### 12.1.1.10 Mobile Equipment Identity + +The purpose of the Mobile Equipment Identity (MEI) information element is used to convey the UE's terminal identity from the Serving GW, TWAN or ePDG to the PDN GW over the S5/S8, S2a or S2b interface. + +The encoding of the MEI is depicted in Figure 12.1.1.10-1. + +| Octets | Bits | | | | | | | | +|--------|---------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 8 | Mobile Equipment Identity | | | | | | | | + +Figure 12.1.1.10-1: Mobile Equipment Identity (MEI) + +The MEI contains either the IMEI or IMEISV in the format defined in subclause 6.2 of 3GPP TS 23.003 [12]. + +The MEI shall contain the IMEISV if it is available. If only the IMEI is available, then the last semi-octet of octet 8 of MEI shall be set to "1111". Both IMEI and IMEISV are TBCD encoded, where IMEI is 15 BCD digits and IMEISV is 16 BCD digits. Bits 5 to 8 of octet n encodes digit 2n, bits 1 to 4 of octet n encodes digit 2n-1. Digits are packed contiguously with no internal padding. + +NOTE: This encoding follows that of the IMEI(SV) field in the International Mobile Equipment Identity (and Software Version) (IMEI(SV)) information element defined in clause 7.7.53 of 3GPP TS 29.060 [28]. + +### 12.1.1.11 MSISDN + +The purpose of the MSISDN information element is used to convey the user's MSISDN from the Serving GW to the PDN GW over the S5/S8 interface, from the trusted non-3GPP access network to the PDN-GW over S2a and from ePDG to the PDN-GW over S2b. MSISDN is defined in 3GPP TS 23.003 [12]. + +The content and encoding of the MSISDN is depicted on Figure 12.1.1.11-1. + +| Octets | Bits | | | | | | | | +|--------|----------------|---|---|---|------------------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Number digit 2 | | | | Number digit 1 | | | | +| n | Number digit m | | | | Number digit m-1 | | | | + +Figure 12.1.1.11-1: MSISDN + +Octets 1 to n represent the MSISDN value in international number format as described in ITU-T Rec E.164 [29], encoded as TBCD digits, i.e. digits from 0 through 9 are encoded "0000" to "1001". When there is an odd number of digits, bits 8 to 5 of the last octet are encoded with the filler "1111". + +### 12.1.1.12 APN Restriction + +The APN Restriction is defined in figure 12.1.1.12-1. The APN Restriction value is specified in 3GPP TS 29.274 [22]. + +![](3750b0149a6380885998ab3ca6a8787c_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|-----------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | APN Restriction value | | | | | | | | + +Figure 12.1.1.12-1: APN Restriction + +### 12.1.1.13 Maximum APN Restriction + +The Maximum APN Restriction is defined in figure 12.1.1.13-1. The Maximum APN Restriction value is specified in 3GPP TS 29.274 [22]. + +![](b1e7bb95fa1587d870de03df02477df4_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|-------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Maximum APN Restriction value | | | | | | | | + +Figure 12.1.1.13-1: Maximum APN Restriction + +### 12.1.1.14 Unauthenticated IMSI + +The purpose of the Unauthenticated IMSI information element is used to convey the user's IMSI for the emergency attached UE with an IMSI which is not authenticated by the network. The format of IMSI is defined in 3GPP TS 23.003 [12]. + +The content and encoding of the Unauthenticated IMSI is depicted on Figure 12.1.1.14-1. + +![](cc3d87694102054bcd694ae696bc41fa_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|----------------|---|---|---|------------------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Number digit 2 | | | | Number digit 1 | | | | +| n | Number digit m | | | | Number digit m-1 | | | | + +Figure 12.1.1.14-1: Unauthenticated IMSI + +Octets 1 to n represent the IMSI value in international number format as described in ITU-T Rec E.164 [29], encoded as TBCD digits, i.e. digits from 0 through 9 are encoded "0000" to "1001". When there is an odd number of digits, bits 8 to 5 of the last octet are encoded with the filler "1111". The maximum number of digits is 15. + +### 12.1.1.15 PDN Connection ID + +The purpose of the PDN Connection ID information element is used to convey the PDN Connection ID. + +The content and encoding of the PDN Connection ID is depicted on Figure 12.1.1.15-1. + +![](b9ccd94b9abd3bca5576d3cb09c4a8e5_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|---------------------------|---|---|---|-------------------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Spare (all bits set to 0) | | | | PDN Connection ID | | | | + +Figure 12.1.1.15-1: PDN Connection ID + +NOTE: The format of the PDN connection ID is aligned with EPS bearer ID defined for GTPv2 in 3GPP TS 29.274 [22]. + +### 12.1.1.16 PGW Back-Off Time + +The PGW Back-Off Time information element is coded as shown in figure 12.1.1.16-1. The timer unit and timer value are specified in 3GPP TS 29.274 [22]. + +![](38d82ffe820e339811b396206f40a201_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|------------|---|---|-------------|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Timer unit | | | Timer value | | | | | + +Figure 12.1.1.16-1: PGW Back-Off Time + +### 12.1.1.17 Signalling Priority Indication + +The Signalling Priority Indication information element contains signalling priority indications received from the UE for a specific PDN connection. + +The Signalling Priority Indication information element is coded as shown in figure 12.1.1.17-1. + +![](13dbd16a58861b335d8e10047ae8e524_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|-------|---|---|---|---|---|---|------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Spare | | | | | | | LAPI | + +Figure 12.1.1.17-1: Signalling Priority Indication + +The following bits within Octet 1 shall indicate: + +- Bit 8 to 2 – Spare, for future use and set to zero. +- Bit 1 – LAPI (Low Access Priority Indication): This bit defines if the UE indicated low access priority when establishing the PDN connection. It shall be encoded as the Low Priority parameter of the Device Properties IE in 3GPP TS 24.008 [16]. The receiver shall assume the value "0" if the Signalling Priority Indication IE is applicable for a message but not included in that message by the sender. The low access priority indication may be included in charging records. + +### 12.1.1.18 Static IP Address Allocation Indication + +The Static IP Address Allocation Indication information element contains Static IP Address Allocation Indication for the Handover procedures. These indications are equivalent for the Static IPv4/IPv6 Address Flag defined in 3GPP TS 29.274 [22]. + +The Static IP Address Allocation Indication information element is coded as shown in figure 12.1.1.18-1. + +![](d964618f772e53e0dcf684977e62daf9_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|-------|---|---|---|------|---|------|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Spare | | | | S6PI | | S4AI | | + +Figure 12.1.1.18-1: Static IP Address Allocation Indication + +The following bits within Octet 1 shall indicate: + +- Bit 8 to 3 – Spare, for future use and set to zero. +- Bit 2 – S6PI (Static IPv6 Home Network Prefix Indication): if this bit is set to 1, it indicates that IPv6 Home Network Prefix is statically allocated. +- Bit 1 – S4AI (Static IPv4 Address Indication): if this bit is set to 1, it indicates that IPv4 address is statically allocated. + +### 12.1.1.19 Additional Protocol Configuration Options + +The Additional Protocol Configuration Options IE contains additional 3GPP protocol configuration options information. The IE is in the same format as the PCO IE specified in 3GPP TS 24.008 [16] subclause 10.5.6.3, starting with octet 3. + +### 12.1.1.20 MME/SGSN Identifier + +The purpose of the MME/SGSN Identifier information element is to carry the IP address of the MME/SGSN. The content and encoding of the MME/SGSN Identifier is depicted on Figure 12.1.1.20-1. + +![](d9638e837004a4e09dbbc50b8aecbd5f_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|----------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1-4/16 | IPv4 or IPv6 Address | | | | | | | | + +Figure 12.1.1.20-1: MME/SGSN Identifier + +### 12.1.1.21 End Marker Notification + +The purpose of the End Marker Notification information element is used to convey the End Marker Notification. + +The content and encoding of the End Marker Notification is depicted on Figure 12.1.1.21-1. + +![](665db9e4c084c517dc46f23397c8533a_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|-------|---|---|---|---|---|---|-----| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Spare | | | | | | | EMN | + +Figure 12.1.1.21-1: End Marker Notification + +The following bits within Octet 1 shall indicate: + +- Bit 8 to 2 – Spare, for future use and set to zero. +- Bit 1 – EMN (End Marker Notification): This bit shall be set to the value "1". + +### 12.1.1.22 Trusted WLAN Mode Indication + +The purpose of the Trusted WLAN Mode Indication information element is to convey the selected trusted WLAN Mode. + +The content and encoding of the Trusted WLAN Mode Indication is depicted on Figure 12.1.1.22-1. + +![](b22a2b17c5f35e4706033e34ab0f3e9a_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|-------|---|---|---|---|---|-----|-----| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Spare | | | | | | MCM | SCM | + +Figure 12.1.1.22-1: Trusted WLAN Mode Indication + +The following bits within Octet 1 shall indicate: + +- Bit 8 to 3 – Spare, for future use and set to zero. +- Bit 2 –MCM (Multiple-connection mode Indication): if this bit is set to 1, it indicates that the Multiple-connection mode is used. +- Bit 1 –SCM (Single-connection mode Indication): if this bit is set to 1, it indicates that the Single-connection mode is used. + +### 12.1.1.23 UE Time Zone + +UE Time Zone is used to indicate the offset between universal time and local time in steps of 15 minutes of where the UE currently resides. The "Time Zone" field uses the same format as the "Time Zone" IE in 3GPP TS 24.008 [5]. + +The content and encoding of the UE Time Zone is depicted on Figure 12.1.1.23-1. + +![](1e5a58dcaf0936bf18dc3dd0d9cd43ff_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|-----------|---|---|---|---|---|----------------------|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Time Zone | | | | | | | | +| 2 | Spare | | | | | | Daylight Saving Time | | + +Figure 12.1.1.23-1: UE Time Zone + +The value of the Time Zone field in octet 1 represents the time zone adjusted for daylight saving time. + +The following bits within Octet 2 shall indicate: + +- Bit 8 to 3 – Spare, for future use and set to zero. +- Bit 2 to 1 – The value of the Daylight Saving Time field specifies the adjustment that has been made. Possible values for the Daylight Saving Time field are given below in Table 12.1.1.23-2 + +Table 12.1.1.23-1 Possible values for the "Daylight Saving Time" field and their meanings. + +| Daylight Saving Time | Value (binary) | | +|----------------------------------------------|----------------|-------| +| | Bit 2 | Bit 1 | +| No adjustment for Daylight Saving Time | 0 | 0 | +| +1 hour adjustment for Daylight Saving Time | 0 | 1 | +| +2 hours adjustment for Daylight Saving Time | 1 | 0 | +| Spare | 1 | 1 | + +## 12.1.1.24 Access Network Identifier Timestamp + +The Access Network Identifier Timestamp indicates the UTC time when the Access Network Identifier information was acquired. The content and encoding of the Access Network Identifier Timestamp is depicted on Figure 12.1.1.24-1. Octets 1 to 4 are encoded in the same format as the first four octets of the 64-bit timestamp format as defined in section 6 of IETF RFC 5905 [40]. + +NOTE: The encoding is defined as the time in seconds relative to 00:00:00 on 1 January 1900 + +![](d47e75401a5155ebc965d8aa004861a2_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|-------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1-4 | Access Network Identifier Timestamp | | | | | | | | + +Figure 12.1.1.24-1: Access Network Identifier Timestamp + +## 12.1.1.25 Logical Access ID + +The purpose of the Logical Access ID information element is to convey the Logical Access ID. The Logical Access ID is implemented by providing both the Relay Identity which is either an IP Address or and FQDN along with the allocated Circuit-ID. + +The Logical Access ID is depicted on Figure 12.1.1.25-1. + +![](2b3464c6315594e2fa8b84d72cff2cd2_img.jpg) + +| Octets | Bits | | | | | | | | +|----------------|-----------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Relay Identity Type | | | | | | | | +| 2 | Relay Identity Length | | | | | | | | +| 3 to k | Relay Identity | | | | | | | | +| (k+1) to (k+2) | Circuit-ID Length | | | | | | | | +| (k+3) to q | Circuit-ID | | | | | | | | + +**Figure 12.1.1.25-1: Logical Access ID** + +The Relay Identity Type is encoded in octet 1. It indicates the type of identity as described in Table 12.1.1.25-1. The Relay Identity Length is encoded in the octet 2. It indicates the length of the relay identity. The octets 3 to K contains the Relay Identity. If the Relay Identity type is set to 1 (i.e. an FQDN), it is encoded as described in section 3.1 of IETF RFC 1035 [31] but excluding the trailing zero byte. The Circuit-ID length in the octet (k+1) to (k+2) indicates the length of the Circuit-ID. The Circuit-ID is as defined in IETF RFC 3046 [42], it is encoded in octets (k+3) to q as an Octetstring and provided by the Relay. + +**Table 12.1.1.25-1: Relay Identity Type** + +| Relay Identity Type | Values (Decimal) | +|----------------------|------------------| +| IPv4 or IPv6 Address | 0 | +| FQDN | 1 | + +## 12.1.1.26 Origination Time Stamp + +The Origination Time Stamp information element is coded as shown in figure 12.1.1.26-1. The Origination Time Stamp value shall be encoded as specified in 3GPP TS 29.274 [22]. + +| Octets | Bits | | | | | | | | +|--------|------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1-6 | Origination Time Stamp value | | | | | | | | + +**Figure 12.1.1.26-1: Origination Time Stamp** + +## 12.1.1.27 Maximum Wait Time + +The Maximum Wait Time information element is coded as shown in figure 12.1.1.27-1. The Maximum Wait Time value shall be encoded as specified in 3GPP TS 29.274 [22]. + +| Octets | Bits | | | | | | | | +|--------|-------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1-2 | Maximum Wait Time value | | | | | | | | + +**Figure 12.1.1.27-1: Maximum Wait Time** + +## 12.1.1.28 TWAN Capabilities + +The purpose of the TWAN Capabilities information element is to convey the capabilities supported by the TWAN to the PGW. + +The content and encoding of the TWAN Capabilities is depicted on Figure 12.1.1.28-1. + +| Octets | Bits | | | | | | | | +|--------|-------|---|---|---|---|---|---|-----------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Spare | | | | | | | WPM
SI | + +**Figure 12.1.1.28-1: TWAN Capabilities** + +The following bits within Octet 1 shall indicate: + +- Bit 8 to 2 – Spare, for future use and set to zero. +- Bit 1 – WLCP PDN Connection Modification Support Indication (WPMSI): if this bit is set to 1, it indicates that the TWAN supports the WLCP PDN Connection Modification procedure. This indication is used by the P-CSCF restoration extension procedure for TWAN access (see 3GPP TS 23.380 [36]). + +## 13 Trusted WLAN Access over S2a Description + +### 13.1 Initial Attach procedures + +#### 13.1.1 General + +#### 13.1.2 TWAN procedures + +In PMIPv6 mode, the TWAN shall follow the MAG procedure for the PMIPv6 PDN Connection Creation as outlined in subclause 5.1.2. + +If the transparent single-connection mode is used as specified in 3GPP TS 23.402 [3], the TWAN may include Additional Protocol Configuration Options IE in PBU to retrieve additional IP configuration parameters from the PGW (e.g. DNS server). + +The TWAN shall include the Trusted WLAN Mode Indication for single-connection mode or multi-connection mode. It shall not do so for transparent single-connection mode. The PGW shall assume that transparent single-connection mode is used if it receives the PBU from the TWAN without this IE. + +If the single-connection mode or multi-connection mode is used as specified in 3GPP TS 23.402 [3], the TWAN shall include Protocol Configuration Options IE in PBU if the TWAN receives the PCO from the UE. + +The TWAN shall include the Access Network Identifier Option IE in the PBU message and set its contents as follows: + +- the Access Network Identifier Option IE shall contain the SSID and, unless otherwise determined by the TWAN operator's policies, at least one of the following Information Elements: + - the Logical Access ID in the Logical Access ID IE; + - the BSSID in the Access Network Identifier Option IE and/or + - the civic address of the access point to which the UE is attached in the Access Network Identifier Option IE. +- It may also contain the identifier of the TWAN operator, i.e. either the TWAN PLMN-ID if the TWAN is operated by a mobile operator, or the TWAN Operator Name otherwise; +- the SSID and the BSSID (when present) shall be encoded in the Network-Identifier sub-option as specified in IETF RFC 6757 [37], respectively in the "Network Name" field and the "Access-Point Name" field; +- the TWAN PLMN-ID (when present) shall be encoded in the Operator-Identifier sub-option with the "Operator-Identifier (Op-ID) Type" field set to "2" indicating realm of the operator. The TWAN PLMN-ID shall indicate the PLMN-ID of the TWAN operator and shall be encoded as specified in subclause 19.2 of 3GPP TS 23.003 [12]; +- the TWAN Operator Name (when present) shall be encoded in the Operator-Identifier sub-option with the "Operator-Identifier (Op-ID) Type" field set to "2" indicating realm of the operator. The TWAN Operator Name shall indicate the realm name of the TWAN operator and shall be encoded as specified in subclause 19.8 of 3GPP TS 23.003 [12]. +- the Civic Address shall be encoded in the Civic Location Sub-Option with the "Format" field set to "0" indicating that the value denotes binary encoding. The Civic Address is specified in IETF RFC 7563 [41]. + +NOTE: The Access Network Identifier Option IE defined in this specification contains similar information as the TWAN Identifier IE defined for GTPv2 in 3GPP TS 29.274 [22] apart from the Logical Access ID which is defined in a separate 3GPP specific IE called Logical Access ID. The Access Network Identifier Option information does not relate to the Access Network Identity (ANID) defined in 3GPP TS 24.302 [39]. + +The TWAN shall include the Serving Network IE in PBU and set it to the PLMN identity of the selected PLMN used for 3GPP-based access authentication. The selected PLMN is the PLMN of the 3GPP AAA Proxy in roaming case and the PLMN of the 3GPP AAA Server in non-roaming case. + +The TWAN shall include the UE Time Zone IE and shall set its content as specified in subclause 12.1.1.23. + +### 13.1.3 PDN GW procedures + +In PMIPv6 mode, the PDN GW shall follow the LMA procedure for the PMIPv6 PDN Connection Creation as outlined in subclause 5.1.3. + +The PDN GW may include Additional Protocol Configuration Options IE in PBA message to provide the TWAN with additional IP configuration parameters (e.g. DNS server), if a corresponding request was received in the PBU message. + +The PDN GW may include Protocol Configuration Options IE in the PBA message, if the Trusted WLAN Mode Indication indicating single-connection mode or multi-connection mode was received in the PBU message. + +If the PGW supports Access Network Identifier Option and the TWAN had included the Access Network Identifier Option IE in the PBU message, the PGW shall include the Access Network Identifier Option IE with the sub-option(s) that it accepted as outlined in subclause 4.2 of IETF RFC 6757 [37]. The PGW shall not alter the contents of the sub-option(s) received from the TWAN. + +## 13.2 TWAN Initiated PDN Connection Lifetime Extension procedures + +### 13.2.1 General + +### 13.2.2 TWAN procedures + +In PMIPv6 mode, the TWAN shall follow the MAG procedure for the PMIPv6 PDN Connection Lifetime Extension as outlined in subclause 5.2.2. + +### 13.2.3 PDN GW procedures + +In PMIPv6 mode, the PDN GW shall follow the LMA procedure for the PMIPv6 PDN Connection Lifetime Extension as outlined in subclause 5.2.3. + +## 13.3 UE / TWAN Initiated Detach and UE/TWAN Requested PDN Disconnection procedures + +### 13.3.1 General + +### 13.3.2 TWAN procedures + +In PMIPv6 mode, the TWAN shall follow the MAG procedure for the PMIPv6 MAG Initiated PDN Connection Deletion as outlined in subclause 5.4.2 for Detach/PDN Disconnection procedure. + +The TWAN shall include the Access Network Identifier Option IE and the Access Network Identifier Timestamp IE and shall set its content as specified in subclause 13.1.2 and 12.1.1.24 respectively. + +The TWAN shall include the UE Time Zone IE and shall set its content as specified in subclause 12.1.1.23. + +### 13.3.3 PDN GW procedures + +In PMIPv6 mode, the PDN GW shall follow the LMA procedure for the PMIPv6 MAG Initiated PDN Connection Deletion as outlined in subclause 5.4.3. + +If the PGW supports Access Network Identifier Option and the TWAN had included the Access Network Identifier Option IE in the PBU message, the PGW shall include the Access Network Identifier Option IE with the sub-option(s) that it accepted as outlined in subclause 4.2 of IETF RFC 6757 [37]. The PGW shall not alter the contents of the sub-option(s) received from the TWAN. + +## 13.4 HSS / AAA Initiated Detach procedures + +### 13.4.1 General + +The HSS/AAA may initiate a detach procedure resulting in a PMIPv6 De-Registration. + +### 13.4.2 TWAN procedures + +In PMIPv6 mode, the TWAN shall follow the MAG procedure for the PMIPv6 MAG Initiated PDN Connection Deletion as outlined in subclause 5.4.2. + +The TWAN shall include the Access Network Identifier Option IE and the Access Network Identifier Timestamp IE and shall set its content as specified in subclause 13.1.2 and 12.1.1.24 respectively. + +The TWAN shall include the UE Time Zone IE and shall set its content as specified in subclause 12.1.1.23. + +### 13.4.3 PDN GW procedures + +In PMIPv6 mode, the PDN GW shall follow the LMA procedure for the PMIPv6 MAG Initiated PDN Connection Deletion as outlined in subclause 5.4.3. + +If the PGW supports Access Network Identifier Option and the TWAN had included the Access Network Identifier Option IE in the PBU message, the PGW shall include the Access Network Identifier Option IE with the sub-option(s) that it accepted as outlined in subclause 4.2 of IETF RFC 6757 [37]. The PGW shall not alter the contents of the sub-option(s) received from the TWAN. + +## 13.5 PDN GW Initiated Resource Allocation Deactivation procedures + +### 13.5.1 General + +### 13.5.2 TWAN procedures + +In PMIPv6 mode, the Trusted Non-3GPP Access shall follow the MAG procedure for the PMIPv6 LMA Initiated PDN Connection Deletion as outlined in subclause 5.5.2. + +The TWAN shall include the Access Network Identifier Option IE and the Access Network Identifier Timestamp IE and shall set its content as specified in subclause 13.1.2 and 12.1.1.24 respectively. + +The TWAN shall include the UE Time Zone IE and shall set its content as specified in subclause 12.1.1.23. + +### 13.5.3 PDN GW procedures + +In PMIPv6 mode, the PDN GW shall follow the LMA procedure for the PMIPv6 LMA Initiated PDN Connection Deletion as outlined in subclause 5.5.3. + +The PGW shall include the 3GPP Specific PMIPv6 error code IE and set it to the cause "Reactivation requested" when the PGW initiates the PDN GW Initiated Resource Allocation Deactivation procedure as part of the P-CSCF restoration procedure over WLAN access, as specified in 3GPP TS 23.380 [36]. + +## 13.6 3GPP Access to TWAN with PMIPv6 on S2a Handover procedures without optimization + +### 13.6.1 General + +This procedure shall apply for a TWAN access using single-connection mode or multi-connection mode. + +## 13.6.2 TWAN procedures + +In PMIPv6 mode, the TWAN shall follow the MAG procedure for the PMIPv6 PDN Connection Handover as outlined in subclause 5.3.2. + +The TWAN shall include in the PBU message: + +- the Protocol Configuration Options IE if the TWAN received the PCO from the UE. +- the Access Network Identifier Option IE and set its content as specified in subclause 13.1.2. +- the Serving Network IE and set it to the PLMN identity of the selected PLMN used for 3GPP-based access authentication. The selected PLMN is the PLMN of the 3GPP AAA Proxy in roaming case and the PLMN of the 3GPP AAA Server in non-roaming case. +- the Trusted WLAN Mode Indication for single-connection mode or multi-connection mode. + +The TWAN shall include the UE Time Zone IE and shall set its content as specified in subclause 12.1.1.23. + +The TWAN shall include the TWAN Capabilities IE in the PBU message and set the WLCP PDN Connection Modification Support Indication flag to 1 if the TWAN supports this procedure. + +## 13.6.3 PDN GW procedures + +In PMIPv6 mode, the PDN GW shall follow the LMA procedure for the PMIPv6 PDN Connection Handover as outlined in subclause 5.3.3. + +If the PGW supports Access Network Identifier Option and the TWAN had included the Access Network Identifier Option IE in the PBU message, the PGW shall include the Access Network Identifier Option IE with the sub-option(s) that it accepted as outlined in subclause 4.2 of IETF RFC 6757 [37]. The PGW shall not alter the contents of the sub-option(s) received from the TWAN. + +The PDN GW may include Protocol Configuration Options IE in the PBA message. + +# 13.7 UE Initiated Connectivity to Additional PDN procedures + +## 13.7.1 General + +This procedure only applies for a TWAN access using the multiconnection mode. + +## 13.7.2 TWAN procedures + +In PMIPv6 mode, the TWAN shall follow the MAG procedure for the PMIPv6 PDN Connection Creation as outlined in subclause 5.1.2, or the MAG procedure for the PMIPv6 PDN Connection Handover as outlined in subclause 5.3.2. + +The TWAN shall include in the PBU message: + +- the Protocol Configuration Options IE if the TWAN received the PCO from the UE; +- the Access Network Identifier Option IE and the UE timezone IE and set their contents as specified in subclause 13.1.2; +- the Serving Network IE and set it to the PLMN identity of the selected PLMN used for 3GPP-based access authentication. The selected PLMN is the PLMN of the 3GPP AAA Proxy in roaming case and the PLMN of the 3GPP AAA Server in non-roaming case; +- the Trusted WLAN Mode Indication for multi-connection mode; +- the TWAN Capabilities IE and set the WLCP PDN Connection Modification Support Indication flag to 1 if the TWAN supports this procedure. + +### 13.7.3 PDN GW procedures + +In PMIPv6 mode, the PDN GW shall follow the LMA procedure for the PMIPv6 PDN Connection Creation as outlined in subclause 5.1.3, or the LMA procedure for the PMIPv6 PDN Connection Handover as outlined in subclause 5.3.3. + +If the PGW supports Access Network Identifier Option and the TWAN had included the Access Network Identifier Option IE in the PBU message, the PGW shall include the Access Network Identifier Option IE with the sub-option(s) that it accepted as outlined in subclause 4.2 of IETF RFC 6757 [37]. The PGW shall not alter the contents of the sub-option(s) received from the TWAN. + +The PDN GW may include the Protocol Configuration Options IE in the PBA message. + +--- + +## 14 Proxy Mobile IPv6 EPC Restoration Procedure + +### 14.1 PGW triggered SGW restoration procedure + +#### 14.1.1 General + +The PGW triggered SGW restoration procedure is specified in 3GPP TS 23.007 [13]. The Proxy Mobile IPv6 LMA Initiated Update Notification procedure specified in subclause 5.11 is used to initiate the PGW triggered SGW restoration procedure. + +#### 14.1.2 Serving GW procedures + +The Serving GW shall follow the PGW triggered SGW restoration procedure as specified in subclause 27.2.3.3 of 3GPP TS 23.007 [13]. When receiving the Update Notification message with notification reason "PGW Downlink Trigger Notification", the Serving GW shall response with an Update Notification Acknowledgement message specified as the MAG procedure in subclause 5.11. + +#### 14.1.3 PDN GW procedures + +The PDN GW shall follow the PGW triggered SGW restoration procedure as specified in subclause 27.2.3.4 and 20.2.7.1 of 3GPP TS 23.007 [13]. When sending the Update Notification message, the PDN GW shall follow the LMA procedure specified in subclause 5.11 as follows: + +1. The notification reason shall be set to "PGW Downlink Trigger Notification". + +**Editor's Note:** The Notification reason "PGW Downlink Trigger Notification " needs to be registered in IANA. + +2. If the MME/S4-SGSN identifier was received in the last Create Session Request or Modify Bearer Request message as specified in 3GPP TS 23.007 [13], the MME/SGSN Identifier mobility option shall contain the stored MME/S4-SGSN identifier. +3. If the restoration procedure is caused by S5 path failure as specified in subclause 20.2.7.1 of 3GPP TS 23.007 [13], the Update Notification Message shall contain the PDN GW IP Address and GRE key option which shall contain the PGW IP address and uplink GRE key for control plane for the PDN connection. + +### 14.2 Update PDP context/Bearer at P-CSCF failure + +#### 14.2.1 General + +The update PDP context/Bearer at P-CSCF failure procedure is specified in subclause 5.1 of 3GPP TS 23.380 [36]. The Proxy Mobile IPv6 LMA Initiated Update Notification procedure specified in subclause 5.11 is used to inform the SGW at P-CSCF failure. + +This procedure is also used from the PGW to the TWAN or ePDG to provide the UE with a list of available P-CSCF addresses as part of the P-CSCF restoration extension procedure for TWAN access and untrusted WLAN access (3GPP TS 23.380 [36]). + +## 14.2.2 PDN GW procedures + +The PDN GW shall follow the update PDP context/Bearer at P-CSCF failure procedure as specified in subclause 5.1 of 3GPP TS 23.380 [36], or the P-CSCF restoration extension procedure for TWAN access and untrusted WLAN access as specified in 3GPP TS 23.380 [36]. When sending the Update Notification message, the PDN GW shall follow the LMA procedure specified in subclause 5.11 as follows: + +1. The notification reason shall be set to "PGW-TRIGGERED-PCSCF-RESTORATION-PCO". +2. The Service Selection Mobility Option shall be set to the corresponding APN to which the UE PDN connection is attached +3. The PDN connection ID Mobility Option shall contain the PDN connection ID stored in the BCE if multiple PDN connection to a given APN is supported. +4. The PCO Mobility Option (for S5/S8 and S2a) or the APCO Mobility Option (for S2b) shall contain a list of available P-CSCF addresses. + +## 14.2.3 Serving GW, TWAN and ePDG procedures + +The Serving GW shall follow the update PDP context/Bearer at P-CSCF failure procedure as specified in subclause 5.1 of 3GPP TS 23.380 [36]. When receiving the Update Notification message with notification reason "PGW triggered P-CSCF restoration using PCO", the Serving GW shall respond with an Update Notification Acknowledgement message specified as the MAG procedure in subclause 5.11. + +The TWAN and ePDG shall follow the P-CSCF restoration extension procedure for TWAN access and untrusted WLAN access as specified in 3GPP TS 23.380 [36]. When receiving the Update Notification message with notification reason "PGW triggered P-CSCF restoration using PCO", the TWAN or ePDG shall respond with an Update Notification Acknowledgement message specified as the MAG procedure in subclause 5.11. + +# 14.3 Inform UE about P-CSCF failure + +## 14.3.1 General + +The Inform UE about P-CSCF failure procedure is specified in subclause 5.2 of 3GPP TS 23.380 [36]. The Proxy Mobile IPv6 LMA Initiated Update Notification procedure specified in subclause 5.11 is used to inform the SGW at P-CSCF failure. + +## 14.3.2 PDN GW procedures + +The PDN GW shall follow the inform UE about P-CSCF failure procedure as specified in subclause 5.2 of 3GPP TS 23.380 [36]. When sending the Update Notification message, the PDN GW shall follow the LMA procedure specified in subclause 5.11 as follows: + +1. The notification reason shall be set to "PGW-TRIGGERED-PCSCF-RESTORATION-DHCP". +2. The Service Selection Mobility Option shall be set to the corresponding APN to which the UE PDN connection is attached +3. The PDN connection ID Mobility Option shall contain the PDN connection ID stored in the BCE if multiple PDN connection to a given APN is supported. +4. The PCO Mobility Option shall contain an indicator that there is P-CSCF failure. + +## 14.3.3 Serving GW procedures + +The Serving GW shall follow the inform UE about P-CSCF failure procedure as specified in subclause 5.2 of 3GPP TS 23.380 [36]. When receiving the Update Notification message with notification reason "PGW triggered P-CSCF restoration using DHCP", the Serving GW shall response with an Update Notification Acknowledgement message specified as the MAG procedure in subclause 5.11. + +# 15 Proxy Mobile IPv6 End Marker Notification Procedure + +## 15.1 General + +Proxy Mobile IPv6 End Marker notification procedure is specified in subclause 5.7.1 and 5.7.2 of 3GPP TS 23.402 [3]. The Proxy Mobile IPv6 LMA Initiated Update Notification procedure specified in subclause 5.11 is used to initiate the Proxy Mobile IPv6 End Marker Notification Procedure. + +## 15.2 Serving GW procedures + +The Serving GW shall follow the Proxy Mobile IPv6 End Marker notification procedure as specified in subclause 5.7.1 and 5.7.2 of 3GPP TS 23.402 [3]. When receiving the Update Notification message with notification reason "VENDOR-SPECIFIC-REASON" and End Marker Notification mobility option and the serving GW has downlink user plane established, the Serving GW shall generate End Marker as specified in subclause 5.7.1 and 5.7.2 of 3GPP TS 23.402 [3]. When receiving the Update Notification message, the Serving GW shall follow the MAG procedure specified in subclause 5.11. + +## 15.3 PDN GW procedures + +The PDN GW shall follow Proxy Mobile IPv6 End Marker notification procedure as specified in subclause 5.7.1 and 5.7.2 of 3GPP TS 23.402 [3]. When sending the Update Notification message, the PDN GW shall follow the LMA procedure specified in subclause 5.11 as follows: + +1. The PDN GW shall set the notification reason to "VENDOR-SPECIFIC-REASON" as specified in IETF RFC 7077 [35]. +2. The PDN GW shall include End Marker Notification mobility option. +3. The PDN GW shall set the Acknowledge (A) flag to "0", thereby not requesting an acknowledgement message from the Serving GW. + +## Annex A: void + +## Annex B (Normative): Definition of the protocol number in pseudo-header + +### B.1 General + +In this specification PMIP refers to PMIPv6 as defined in IETF RFC5213 [4] and IETF RFC5213 [4] is based on Mobile IPv6 IETF RFC 3775[8]. IETF RFC 3775[38], however, is obsolete by IETF RFC 6275 [8], which specifies protocol number 135 instead of 2 to be used in the checksum pseudo-header. For forward compatibility with future 3GPP releases, the protocol number 135 shall be supported. In addition the protocol number 2 may also be supported. + +NOTE: Some nodes complying to an earlier version of this specification can be implemented according to IETF RFC 3775[38] and this could result in the use of different protocol numbers within a network. + +To migrate a protocol number 2 based PMIP network into a protocol number 135 based PMIP network, the network migration may be achieved by static configuration or supporting a migration solution as specified in this Annex B. Any other alternatives for a specific development use case are possible. + +### B.2 Interworking of different protocol number + +If a PMIPv6 node (LMA) supports both protocol numbers (2 and 135), it shall silently discard the received PBU message if the checksum value calculated from the protocol number 2 and 135 are both invalid. If one of the protocol number (2 or 135) is valid in checksum calculation, the node shall use this protocol number in the "pseudo-header" when sending any subsequent PMIPv6 messages with the same peer PMIPv6 node. If the checksum validation is skipped, the LMA shall use the configured protocol number for the subsequent PMIPv6 messages to that peer node. + +If a PMIPv6 node (MAG) supports both protocol numbers (2 and 135), it shall construct PBU message using protocol number 135 which takes precedence over protocol number 2. If no response is received from LMA, the MAG sends another PBU message to the peer node using protocol number 2. The MAG shall store the protocol number of the response message and use it for the subsequent message interaction. If the checksum validation is skipped, the MAG shall use the configured protocol number for the subsequent PMIPv6 messages to that peer node. + +--- + +## Annex C (informative): Change History + +| Change history | | | | | | | | +|----------------|-------|-----------|------|-----|----------------------------------------------------------------------------------|-------|-------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 2008-09 | CT#41 | CP-080476 | | | V2.0.0 approved in CT#41 | 2.0.0 | 8.0.0 | +| 2008-12 | CT#42 | CP-080692 | 0002 | | IPv4 Address Acknowledgement option in PBA | 8.0.0 | 8.1.0 | +| | | CP-080692 | 0006 | 2 | IPv4 Address Deletion | | | +| | | CP-080692 | 0007 | | PDN-GW Initiated Resource Allocation Deactivation | | | +| | | CP-080692 | 0008 | 2 | PDNType-IP Address Option | | | +| | | CP-080692 | 0009 | 4 | PMIP Bulk Revocation Support. | | | +| | | CP-080692 | 0010 | 1 | Link local address | | | +| | | CP-080692 | 0011 | | Service selection option in the PBA message | | | +| | | CP-080692 | 0012 | 4 | PMIP IPv4 address allocation | | | +| | | CP-080692 | 0019 | | Interface Id in PBA at HO case | | | +| | | CP-080692 | 0022 | | Clarification to subclause PMIP6 LMA Initiated PDN Connection Deletion Procedure | | | +| | | CP-080692 | 0023 | | Update references to latest version of IETF documents | | | +| | | CP-080692 | 0025 | | Putting back GSM logo on front page | | | +| | | CP-080692 | 0026 | | PMIPv6 Heartbeat/Path Management Update | | | +| | | CP-080692 | 0031 | | PMIPv6 clarification | | | +| | | CP-080692 | 0033 | | Optimized E-UTRAN to CDMA2000 HRPD Handover procedure cleanup | | | +| | | CP-080692 | 0036 | 1 | IPv4-UDP encapsulation option | | | +| | | CP-080692 | 0037 | 2 | S5/S8 procedure corrections | | | +| | | CP-080692 | 0038 | 1 | S2a procedure corrections | | | +| | | CP-080692 | 0039 | | S2b procedure corrections | | | +| | | CP-080692 | 0040 | 1 | Chaining case procedure corrections | | | +| | | CP-080692 | 0042 | 1 | DHCPv4 Address Allocation 3GPP VSO | | | +| | | CP-080692 | 0043 | 1 | PDN type indicator | | | +| | | CP-080692 | 0044 | | FFS cleanup | | | +| | | CP-080692 | 0045 | | HI FFS cleanup | | | +| | | CP-080692 | 0046 | | Clean up on BULE and BCE | | | +| | | CP-080692 | 0047 | 2 | Clarification on PMIPv6 Protocol Stack | | | +| | | CP-080692 | 0048 | 3 | Modifications for S2a/S2b - PMIP based S8 chaining | | | +| 2009-03 | CT#43 | CP-090052 | 0054 | 1 | 3GPP VSO PDN type cause value | 8.1.0 | 8.2.0 | +| | | CP-090052 | 0055 | | 3GPP VSO DHCPv4 Address Allocation Procedure Indication | | | +| | | CP-090052 | 0056 | 1 | 3GPP VSO PMIP error code missing in PBA and BRA | | | +| | | CP-090052 | 0059 | 1 | 3GPP VSO PCO in PBU/PBA message | | | +| | | CP-090052 | 0061 | 1 | Old BCE is lost at handover | | | +| | | CP-090052 | 0062 | 2 | Partial Node Failure | | | +| | | CP-090052 | 0064 | 2 | Alignments of cause codes | | | +| | | CP-090052 | 0065 | 4 | UE specific Error Indication | | | +| | | CP-090052 | 0066 | | Clarification on Heartbeat Request Message | | | +| | | CP-090052 | 0071 | 2 | Link-local Address Option | | | +| | | CP-090052 | 0072 | 1 | IPv4 Deferred Address Allocation and PDN Type | | | +| | | CP-090052 | 0073 | 3 | PMIP VSO Charging ID | | | +| | | CP-090052 | 0074 | 1 | ATT Values for PMIP base S5/S8 | | | +| | | CP-090052 | 0077 | | Detach or PDN Disconnection | | | +| | | CP-090052 | 0079 | | Status Field update | | | +| | | CP-090052 | 0080 | 1 | Correction to tunnel management | | | +| | | CP-090052 | 0085 | 2 | Carrying APN selection mode in PMIP | | | +| | | CP-090271 | 0086 | 6 | Removing 3GPP Vendor Specific Mobility Option format | | | +| 2009-04 | | | | | Correction to history table | 8.2.0 | 8.2.1 | +| 2009-06 | CT#44 | CP-090290 | 0090 | 2 | PMIP VSO Charging Characteristics | 8.2.1 | 8.3.0 | +| | | CP-090290 | 0092 | | PDN Type Cause Value | | | +| | | CP-090290 | 0093 | 1 | UE Requested additional PDN Connectivity Procedure | | | +| | | CP-090290 | 0094 | 1 | IP address allocation Procedure | | | +| | | CP-090290 | 0095 | 1 | FQ-CSID | | | +| | | CP-090290 | 0097 | 2 | Timestamp | | | +| | | CP-090290 | 0098 | 2 | Serving Network VSO in PBU | | | +| | | CP-090290 | 0099 | | GRE Key usage in PDN Connection Lifetime Extension | | | +| | | CP-090290 | 0101 | 3 | PMIPv6 messages transport over IPv4 | | | +| | | CP-090290 | 0102 | 3 | PDN Type for PMIPv6 | | | +| | | CP-090290 | 0106 | 2 | Carrying MEI over PMIP based S5/S8 | | | +| | | CP-090290 | 0107 | 2 | Carrying MSISDN over PMIP based S5/S8 | | | +| | | CP-090290 | 0109 | 2 | Access technology type to be used by ePDG | | | +| | | CP-090290 | 0110 | 1 | Binding Revocation Indication | | | +| 2009-09 | CT#45 | CP-090538 | 0114 | 1 | APN Restriction for PMIPv6 | 8.3.0 | 8.4.0 | +| | | CP-090538 | 0116 | | The IPv4 address allocation procedure | | | +| | | CP-090538 | 0117 | 1 | Clean up on 3GPP Specific PMIPv6 Error Code | | | +| | | CP-090538 | 0118 | 1 | GRE Key usage in PDN Connection Lifetime Extension | | | +| | | CP-090538 | 0120 | 1 | Defining values for 3GPP specific PMIPv6 error code | | | +| | | CP-090538 | 0121 | 1 | Conditional 3GPP specific PMIPv6 information elements | | | +| | | CP-090538 | 0122 | 1 | Reintroducing specific 3GPP Access Technology Types | | | +| | | CP-090538 | 0124 | 1 | Clarifications for HO 3GPP to non-3GPP | | | + +| | | | | | | | | +|---------|-------|-----------|------|---|------------------------------------------------------------------------------------|--------|--------| +| | | CP-090538 | 0125 | 2 | Default MTU size to avoid IP fragmentation in EPS | | | +| | | CP-090538 | 0126 | 1 | Heartbeat Mechanism condition for path failure detection | | | +| | | CP-090538 | 0127 | 2 | Correct on GRE key assignment | | | +| | | CP-090538 | 0128 | 1 | E-UTRAN to HRPD optimized handover | | | +| | | CP-090538 | 0130 | 2 | The revision of LMA's dynamic IP address allocation in handover procedure | | | +| | | CP-090729 | 0131 | 1 | Partial failure handling alignment with stage 2 | | | +| | | CP-090729 | 0132 | 3 | Partial failure handling for S1 based handovers | | | +| 2009-12 | CT#46 | CP-090971 | 0133 | 5 | UE-specific Error Indication | 8.4.0 | 8.5.0 | +| | | CP-090775 | 0139 | 1 | IPv4 Address Release for PMIPv6 based S2a | | | +| | | CP-090775 | 0140 | 2 | Correct IPv4 Home Address Reply option IE name | | | +| | | CP-090775 | 0142 | 3 | Clarification on Heartbeat Mechanism | | | +| | | CP-090775 | 0143 | | FFS Cleanup for Service Selection Mobility Option | | | +| | | CP-090775 | 0144 | 1 | IPv4 Default-Router Address option | | | +| | | CP-090775 | 0145 | 1 | Clarifications on the format of Mobile Node Identifier option | | | +| | | CP-090775 | 0146 | 1 | Removing access type mapping table from annex B | | | +| | | CP-090775 | 0152 | 1 | Clarifications on the format of Service Selection Mobility Option | | | +| | | CP-090775 | 0154 | | Correct fields of revocation message | | | +| 2009-12 | CT#46 | CP-090801 | 0134 | | IMEI based NAI | 8.5.0 | 9.0.0 | +| | | CP-090801 | 0135 | | Unauthenticated IMSI | | | +| | | CP-090802 | 0136 | 2 | Multiple PDN to the Same APN for PMIP-based Interfaces | | | +| | | CP-090802 | 0137 | 1 | BCE extensions for MUPSAP | | | +| 2010-03 | CT#47 | CP-100026 | 0157 | 1 | Correction of the UE-specific Error Indication | 9.0.0 | 9.1.0 | +| | | | 0159 | 1 | Bulk Binding Revocation Indication | | | +| | | | 0161 | | FQ-CSID option | | | +| 2010-06 | CT#48 | CP-100265 | 0167 | | Cause Mapping | 9.1.0 | 9.2.0 | +| 2010-09 | CT#49 | CP-100444 | 0171 | | PMIPv6 Reference Update | 9.2.0 | 9.3.0 | +| 2010-12 | CT#50 | CP-100669 | 0174 | 1 | Essential correction to the mapping between PMIP 3GSPEC and GTP Cause | 9.3.0 | 9.4.0 | +| 2010-12 | CT#50 | CP-100694 | 0177 | 2 | IPv4 Default Router Address | 9.4.0 | 10.0.0 | +| 2011-03 | CT#51 | CP-110081 | 0180 | 1 | Clarification on IE using interfaces | 10.0.0 | 10.1.0 | +| | | CP-110072 | 0189 | 1 | Handling of UE specific Error Indication over the PMIP | | | +| | | CP-110072 | 0190 | 1 | LMA initiated PDN Connection Deletion with Reactivation requested | | | +| | | CP-110208 | 0191 | | Clarification of PCO decoding | | | +| 2011-06 | CT#52 | CP-110369 | 0178 | 2 | APN based congestion control | 10.1.0 | 10.2.0 | +| | | CP-110369 | 0179 | 2 | Low access priority indicator | | | +| | | CP-110372 | 0193 | 1 | Incorrect RFC reference for the UE-specific Error Handling | | | +| | | CP-110372 | 0194 | 1 | PDN GW IP address Correction | | | +| 2011-09 | CT#53 | CP-110558 | 0198 | 2 | PMIP message format | 10.2.0 | 10.3.0 | +| | | CP-110567 | 0201 | 1 | Signalling path failure handling | | | +| 2011-09 | CT#53 | CP-110580 | 0200 | | Default inner MTU size | 10.3.0 | 11.0.0 | +| 2011-12 | CT#54 | CP-110785 | 0211 | 2 | Correction of the protocol stack for PMIP | 11.0.0 | 11.1.0 | +| | | CP-110785 | 0212 | 2 | Migration solution of the PMIP protocol stack issue | | | +| | | CP-110791 | 0220 | 2 | Static IP Address Allocation Indication for Handover procedure | | | +| | | CP-110791 | 0225 | 1 | Learn capability of MUPSAP from PDN connection ID | | | +| | | CP-110792 | 0218 | 1 | Authentication with external networks over PMIP S2b | | | +| 2012-03 | CT#55 | CP-120018 | 0232 | 1 | PMIP binding lifetime | 11.1.0 | 11.2.0 | +| | | CP-120036 | 0234 | 2 | PGW based provisioning of the DNS server address for the S2b interface | | | +| 2012-06 | CT#56 | CP-120248 | 0237 | 2 | IPv4 Address Allocation procedure | 11.2.0 | 11.3.0 | +| | | CP-120248 | 0239 | 1 | Clarification for IPv4 Home Address Request option in dynamic IP allocation | | | +| | | CP-120248 | 0240 | 1 | S2a related changes when Trusted WLAN Access is used | | | +| | | CP-120248 | 0241 | 2 | Clarifying the use of Default Router Address Option in case of Trusted WLAN access | | | +| | | CP-120248 | 0238 | 3 | Multiple PDN connections | | | +| | | CP-120248 | 0247 | 1 | GRE key reference correction | | | +| 2012-09 | CT#57 | CP-120477 | 0249 | 1 | RAT Type for EPC access via TWAN | 11.3.0 | 11.4.0 | +| | | CP-120464 | 0250 | 2 | Extensions to PMIPv6 signalling | | | +| | | | 0251 | | Correction to references for TS 29.275 | | | +| | | CP-120656 | 0252 | 1 | Reference list correction to align with the corrected TS 29.212 title | | | +| 2012-12 | CT#58 | CP-120729 | 0255 | 1 | Signalling Priority Indication in handover | 11.4.0 | 11.5.0 | +| | | CP-120729 | 0266 | - | Static IP Address Allocation Indication | | | +| | | CP-120739 | 0253 | 3 | New PMIP message for EPC Restoration Procedure | | | +| | | CP-120739 | 0254 | 1 | MME/SGSN Id for the PGW triggered SGW restoration procedure | | | +| | | CP-120733 | 0259 | 1 | MSISDN over PMIPv6 S2b/S2a interface | | | +| | | CP-120733 | 0262 | 2 | TWAN operator identification for EPC access charging | | | +| | | CP-120733 | 0268 | 2 | Trusted WLAN AP identity over S2a | | | +| 2013-03 | CT#59 | CP-130019 | 0272 | 1 | IETF Draft Reference- Update Notifications for Proxy Mobile IPv6 | 11.5.0 | 11.6.0 | +| | | CP-130024 | 0273 | 2 | Completion of replacing RFC 3775 with RFC 6275 references | | | + +| | | | | | | | | +|---------|--------|-----------|------|---|---------------------------------------------------------------------------------------------------------------------|--------|--------| +| | | CP-130024 | 0274 | 4 | Protocol number used in pseudo-header Migration RFC 3775 to RFC 6275 | | | +| | | CP-130027 | 0275 | - | Sending SSID for SaMOG in PMIP | | | +| 2013-06 | CT#60 | CP-130284 | 0277 | - | Lifetime in PBU message | 11.6.0 | 11.7.0 | +| 2013-09 | CT#61 | CP-130465 | 0278 | 1 | Clarification of operator identifier field within APN encoding | 11.7.0 | 12.0.0 | +| | | CP-130465 | 0280 | 1 | Incorrect IE description for Service Selection Mobility Option in BRA | | | +| | | CP-130464 | 0281 | 2 | Addition of End Marker Support for Handover Scenarios with SGW Relocation | | | +| 2013-12 | CT#62 | CP-130609 | 0285 | 3 | Correction of reference to Update Notifications for Proxy Mobile IPv6 | 12.0.0 | 12.1.0 | +| | | CP-130637 | 0283 | 1 | Clarification on mobility options for APN congestion control over S2a PMIP | | | +| | | CP-130633 | 0286 | 2 | 3GPP Access to TWAN Handover procedures without optimization | | | +| | | CP-130633 | 0287 | 1 | Clarification on how to use PCO on the S2a PMIP interface | | | +| 2014-03 | CT#63 | CP-140020 | 0289 | 1 | Update the reference of IETF draft Update Notifications for Proxy Mobile IPv6 to RFC 7077 | 12.1.0 | 12.2.0 | +| | | CP-140023 | 0295 | 1 | Reflecting back Access Network Identifier options in Proxy Binding Acknowledgement message for TWAN access | | | +| | | CP-140031 | 0290 | 1 | Clarification on usage of APCO on the S2a PMIP interface | | | +| | | CP-140031 | 0293 | 4 | Trusted WLAN mode indication | | | +| | | CP-140030 | 0291 | 1 | Extension of ANI to convey other types of location information | | | +| | | CP-140030 | 0292 | 1 | Providing the NAI in MAG Initiated PDN Connection Deletion procedure | | | +| | | CP-140030 | 0296 | 1 | Access Network Identifier clarification | | | +| | | CP-140029 | 0282 | 3 | Implementation error of "Apply Serving Network on S2a for eHRPD access" C4-131878. | | | +| 2014-06 | CT#64 | CP-140252 | 0298 | - | UE Time Zone information for TWAN S2a access | 12.2.0 | 12.3.0 | +| | | CP-140252 | 0299 | 2 | Access Network Identifier Timestamp in PDN disconnection procedure | | | +| | | CP-140252 | 0300 | - | TWAN ID Timestamp in Bearer Revocation Ack message for PGW initiated bearer deactivation procedure in Trusted WLAN. | | | +| | | CP-140252 | 0305 | 3 | Encoding of the civic address | | | +| | | CP-140252 | 0306 | 2 | A new 3GPP specific option to carry the Logical Access ID in PMIPv6 | | | +| | | CP-140252 | 0309 | - | Remove editor's note from TWAN procedures | | | +| | | CP-140252 | 0311 | 2 | SSID not sufficient for TWAN location | | | +| | | CP-140261 | 0301 | 1 | Alternate LMAA or IPv4-LMAA | | | +| | | CP-140261 | 0302 | 1 | Alternate LMA address for user plane | | | +| | | CP-140261 | 0307 | 3 | Alternate LMAA or IPv4-LMAA during Handover | | | +| | | CP-140261 | 0308 | 3 | Alternate LMA address for user plane during Handover | | | +| | | CP-140247 | 0303 | 3 | UE Initiated Connectivity to Additional PDN procedures | | | +| | | CP-140247 | 0304 | 2 | HO procedures for non-transparent mode | | | +| 2014-09 | CT#65 | CP-140518 | 0313 | 1 | PGW IP Address and GRE key in the Update Notification | 12.3.0 | 12.4.0 | +| 2014-12 | CT#66 | CP-140779 | 0314 | 1 | Update the reference to IETF draft on carrying Civic address in ANI IE | 12.4.0 | 12.5.0 | +| | | CP-140972 | 0315 | 1 | Removal of Optimized HO procedure from HRPD to EUTRAN | | | +| | | CP-140972 | 0317 | 1 | Missing description on Access Technology Type option for TWAN access | | | +| 2014-12 | CT#66 | CP-140796 | 0316 | 1 | Provisioning of P-CSCF address via APCO for S2b | 12.5.0 | 13.0.0 | +| 2015-03 | CT#67 | CP-150025 | 0318 | 1 | Update reference RFC Separation of Control and User Plane for PMIPv6 | 13.0.0 | 13.1.0 | +| 2015-06 | CT#68 | CP-150270 | 0320 | - | Correction on the rejection of the PBU for APN congestion | 13.1.0 | 13.2.0 | +| | | CP-150270 | 0321 | 2 | Normative Text for the Optional IEs in the UPN and UPA | | | +| | | CP-150270 | 0322 | 1 | Support of IPv6 Prefix Delegation over PMIP-based S5/S8 | | | +| | | CP-150270 | 0324 | 1 | Editorial corrections to clause 13 | | | +| | | CP-150274 | 0325 | 1 | Add MEI to S2a/S2b interfaces | | | +| 2015-09 | CT#69 | CP-150442 | 0326 | 1 | Origination Time Stamp and Maximum Wait Time in PBU | 13.2.0 | 13.3.0 | +| 2015-12 | CT#70 | CP-150780 | 0327 | 1 | Extensions for P-CSCF restoration for trusted and untrusted WLAN access | 13.3.0 | 13.4.0 | +| | | CP-150751 | 0329 | 1 | Update the reference for Civic Address | | | +| | | CP-150745 | 0332 | 1 | IANA registration of new Update Notification Reasons | | | +| 2016-06 | CT#72 | CP-160228 | 0333 | - | Addition of NB-IoT radio access type | 13.4.0 | 13.5.0 | +| 2017-03 | CT#72 | - | - | - | Update to Rel-14 version (MCC) | 13.5.0 | 14.0.0 | +| 2018-06 | CT#80 | - | - | - | Update to Rel-15 version (MCC) | 14.0.0 | 15.0.0 | +| 2020-07 | CT#88e | - | - | - | Update to Rel-16 version (MCC) | 15.0.0 | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29280/raw.md b/marked/Rel-16/29_series/29280/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..088cf682e1a6c8e12924ad6276debcc06f716d8c --- /dev/null +++ b/marked/Rel-16/29_series/29280/raw.md @@ -0,0 +1,825 @@ + + + + + + +# --- Contents + +| | | +|------------------------------------------------------------------|----| +| Foreword ..... | 4 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Definitions, symbols and abbreviations ..... | 6 | +| 3.1 Definitions..... | 6 | +| 3.2 Symbols..... | 6 | +| 3.3 Abbreviations ..... | 6 | +| 4 General Description ..... | 6 | +| 5 Sv Messages and Information Elements ..... | 6 | +| 5.1 Introduction ..... | 6 | +| 5.2 Sv Messages..... | 7 | +| 5.2.1 General ..... | 7 | +| 5.2.2 SRVCC PS to CS Request..... | 8 | +| 5.2.3 SRVCC PS to CS Response ..... | 10 | +| 5.2.4 SRVCC PS to CS Complete Notification..... | 10 | +| 5.2.5 SRVCC PS to CS Complete Acknowledge..... | 11 | +| 5.2.6 SRVCC PS to CS Cancel Notification ..... | 11 | +| 5.2.7 SRVCC PS to CS Cancel Acknowledge ..... | 12 | +| 5.2.8 SRVCC CS to PS Request..... | 12 | +| 5.2.9 SRVCC CS to PS Response ..... | 12 | +| 5.2.10 SRVCC CS to PS Complete Notification..... | 13 | +| 5.2.11 SRVCC CS to PS Complete Acknowledge..... | 13 | +| 5.2.12 SRVCC CS to PS Cancel Notification ..... | 14 | +| 5.2.13 SRVCC CS to PS Cancel Acknowledge ..... | 14 | +| 5.3 Path Management Messages ..... | 14 | +| 5.3.1 Introduction ..... | 14 | +| 5.3.2 Echo Request message ..... | 14 | +| 5.3.3 Echo Response message..... | 15 | +| 5.3.4 Version Not Supported Indication message ..... | 15 | +| 5.4 Reliable Delivery of Signalling Messages ..... | 15 | +| 5.5 Error Handling..... | 15 | +| 5.6 Restoration and Recovery ..... | 15 | +| 6 Sv Information Elements ..... | 15 | +| 6.1 General ..... | 15 | +| 6.2 STN-SR..... | 16 | +| 6.3 Source to Target Transparent Container ..... | 16 | +| 6.4 Target to Source Transparent Container ..... | 17 | +| 6.5 MM Context for E-UTRAN (v)SRVCC..... | 17 | +| 6.6 MM Context for UTRAN SRVCC..... | 18 | +| 6.7 SRVCC Cause..... | 19 | +| 6.8 Target RNC ID..... | 19 | +| 6.9 Target Global Cell ID..... | 20 | +| 6.10 Tunnel Endpoint Identifier for Control Plane (TEID-C) ..... | 20 | +| 6.11 Sv Flags..... | 20 | +| 6.12 Service Area Identifier ..... | 21 | +| 6.13 MM Context for CS to PS SRVCC..... | 21 | +| Annex A (informative): Change history..... | 23 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 1 Scope + +The present document describes the Sv interface between the Mobility Management Entity (MME) or Serving GPRS Support Node (SGSN) and 3GPP MSC server enhanced for SRVCC. Sv interface is used to support Inter-RAT handover from IMS based voice service over EPS to CS domain over 3GPP UTRAN/GERAN access or from UTRAN (HSPA) to 3GPP UTRAN/GERAN access and to support Inter-RAT handover from IMS based voice and video service over EPS to CS domain over 3GPP UTRAN access. Sv interface is also used to support Inter-RAT handover from voice service in CS domain over 3GPP UTRAN/GERAN access to IMS based service over LTE or UTRAN (HSPA). + +If there is no specific indication, the term "MSC server" denotes 3GPP MSC server enhanced for SRVCC or 3GPP MSC server enhanced for vSRVCC as defined in 3GPP TS 23.216 [2]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TR 23.216: "Single Radio Voice Call Continuity (SRVCC)". +- [3] 3GPP TS 29.274: "Evolved GPRS Tunnelling Protocol for Control Plane (GTPv2-C)". +- [4] 3GPP TS 23.003: "Numbering, addressing and identification". +- [5] 3GPP TS 23.007: "Restoration Procedures". +- [6] 3GPP TS 33.401: "3GPP System Architecture Evolution (SAE): Security architecture". +- [7] 3GPP TS 24.008: "Mobile radio interface Layer 3 specification; Core network protocols; Stage 3". +- [8] 3GPP TS 48.008: "Mobile Switching Centre – Base Station System (MSC - BSS) interface; Layer 3 specification". +- [9] 3GPP TS 25.413: "UTRAN Iu interface Radio Access Network Application Part (RANAP) signalling". +- [10] 3GPP TS 33.102: "3G Security; Security architecture". +- [11] 3GPP TS 29.002: "Mobile Application Part (MAP) specification; Stage 3". +- [12] 3GPP TS 24.301: "Non-Access-Stratum (NAS) protocol for Evolved Packet". +- [13] 3GPP TS 23.237: "IP Multimedia Subsystem (IMS) Service Continuity: Stage 2". +- [14] 3GPP TS 36.413: "S1 Application Protocol (SIAP)". +- [15] 3GPP TS 33.401: "3GPP System Architecture Evolution (SAE); Security architecture". +- [16] 3GPP TS 23.251: "Network Sharing; Architecture and Functional Description". +- [17] 3GPP TS 29.276: "Optimized Handover Procedures and Protocols between E-UTRAN access and cdma2000 HRPD Access". + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 23.216 [2] apply: + +**SRVCC** +vSRVCC + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 23.251 [16] apply: + +**Anchor PLMN** + +## 3.2 Symbols + +For the purposes of the present document, the following symbols apply: + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|----------|------------------------------------------------------------| +| C-MSISDN | Correlation MSISDN. | +| GWCN | Gateway Core Network | +| MME/SGSN | MME or SGSN. | +| MOCN | Multi-Operator Core Network | +| SRVCC | Single Radio Voice Call Continuity. | +| STN-SR | Session Transfer Number for SRVCC: see 3GPP TS 23.003 [4]. | +| vSRVCC | Single Radio Video Call Continuity. | + +# --- 4 General Description + +This document describes the Sv interface related procedures, message parameters and protocol specifications. The Sv messages are based on GTP. The message format, IE coding, and protocol error handling for Sv is per GTP as specified in 3GPP TS 29.274 [3]. + +The general rules for IP address and UDP port number handling for the GTP messages on the Sv interface is per 3GPP TS 29.274 [3]. + +# --- 5 Sv Messages and Information Elements + +## 5.1 Introduction + +The Sv application defines a set of messages between the MME/SGSN and MSC Server to provide SRVCC as defined in 3GPP TS 23.216 [2]. The Sv message header shall be conformant to the GTPv2-C Message Header, see 3GPP TS 29.274 [3]. The messages to be used and the information elements are described in the following sections. + +## 5.2 Sv Messages + +### 5.2.1 General + +Sv Messages are used for both the Inter-RAT handover from IMS based voice service over EPS to CS domain over 3GPP UTRAN/GERAN access or from UTRAN (HSPA) to 3GPP UTRAN/GERAN access and the Inter-RAT handover from IMS based voice and video service over EPS to CS domain over 3GPP UTRAN access. + +Sv Messages are also used for the Inter-RAT handover from voice service in CS domain over 3GPP UTRAN/GERAN access to IMS based service over LTE or UTRAN (HSPA). + +Sv Message Type value is defined in 3GPP TS 29.274 [3]. The message format is coded as per GTP in 3GPP TS 29.274 [3]. + +**Table 5.2.1: Message types for Sv interface** + +| Message Type value (Decimal) | Message | Reference | Initial | Triggered | +|------------------------------|--------------------------------------|---------------------|---------|-----------| +| 0 | Reserved | 3GPP TS 29.274 [3] | | | +| 1 | Echo Request | 3GPP TS 29.274 [3] | X | | +| 2 | Echo Response | 3GPP TS 29.274 [3] | | X | +| 3 | Version Not Supported Indication | 3GPP TS 29.274 [3] | | X | +| 4-16 | Reserved for S101 interface | 3GPP TS 29.276 [17] | | | +| 17-24 | Reserved for S121 interface | 3GPP TS 29.276 [17] | | | +| 25 | SRVCC PS to CS Request | 5.2.2 | X | | +| 26 | SRVCC PS to CS Response | 5.2.3 | | X | +| 27 | SRVCC PS to CS Complete Notification | 5.2.4 | X | | +| 28 | SRVCC PS to CS Complete Acknowledge | 5.2.5 | | X | +| 29 | SRVCC PS to CS Cancel Notification | 5.2.6 | X | | +| 30 | SRVCC PS to CS Cancel Acknowledge | 5.2.7 | | X | +| 31 | SRVCC CS to PS Request | 5.2.8 | X | | +| 32-239 | Reserved for GTPv2 | 3GPP TS 29.274 [3] | | | +| 240 | SRVCC CS to PS Response | 5.2.9 | | X | +| 241 | SRVCC CS to PS Complete Notification | 5.2.10 | X | | +| 242 | SRVCC CS to PS Complete Acknowledge | 5.2.11 | | X | +| 243 | SRVCC CS to PS Cancel Notification | 5.2.12 | X | | +| 244 | SRVCC CS to PS Cancel Acknowledge | 5.2.13 | | X | +| 245 to 247 | For future Sv interface use | - | | | +| 248-255 | Reserved for GTPv2 | 3GPP TS 29.274 [3] | | | + +The GTPv2-C messages shall be sent per UE on the Sv interface. + +There shall be one pair of TEID-C per UE on the Sv interface. The same tunnel shall be shared for the control messages related to the same UE operation. + +The TEID field in the SRVCC PS to CS Request and in the SRVCC CS to PS Request message header shall be set to "0" because this is the first message sent between the MME/SGSN and the MSC server to establish the tunnel for a UE. + +The TEID field in the SRVCC PS to CS Cancel Notification message header shall be set to "0" if the message is sent before reception of the acceptance response to the SRVCC PS to CS Request. If the MME/SGSN sends the SRVCC PS to CS Cancel Notification message after the acceptance response to the SRVCC PS to CS Request, the TEID field of the SRVCC PS to CS Cancel Notification message may be set to the MSC Server's TEID value received in the SRVCC PS to CS Response message. Therefore the MSC Server shall be able to accept the SRVCC PS to CS Cancel Notification messages with "0" or non-zero TEID in the message header. + +The TEID field in the SRVCC CS to PS Cancel Notification message header shall be set to "0" if the message is sent before reception of the acceptance response to the SRVCC CS to PS Request. If the MSC Server sends the SRVCC CS to PS Cancel Notification message after the acceptance response to the SRVCC CS to PS Request, the TEID field of the SRVCC CS to PS Cancel Notification message may be set to the MME/SGSN TEID value received in the SRVCC CS to PS Response message. Therefore the MME/SGSN shall be able to accept the SRVCC CS to PS Cancel Notification messages with "0" or non-zero TEID in the message header. + +### 5.2.2 SRVCC PS to CS Request + +A SRVCC PS to CS Request message shall be sent across Sv interface from the MME/SGSN to the target MSC server as part of the MME/SGSN SRVCC procedure in 3GPP TS 23.216 [2]. + +This message shall also be sent across Sv interface from the MME to the target MSC server as part of the vSRVCC procedure in 3GPP TS 23.216 [2]. + +Table 5.2.2 specifies the presence requirements and conditions of the IEs in the message. + +#### **Table 5.2.2: Information Elements in a SRVCC PS to CS Request** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|----------------------------------------|----|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------|------| +| IMSI | C | This IE shall be included in the message except for the cases:
- The UE is emergency attached and it is UICClass
- The UE is emergency attached and the IMSI is not authenticated | IMSI | 0 | +| ME Identity (MEI) | C | This IE shall be included in the message for all types of emergency calls by the MME and the SGSN. | MEI | 0 | +| | CO | This IE shall be included for all SRVCC calls if available in the MME or SGSN (NOTE 2). | | | +| Sv Flags | C | This IE shall be included if any one of the applicable flags is set to 1.
The following flags are applicable:
- EmInd: this flag shall be sent if this session is for an emergency call.
- ICS: this flag shall be sent to request IMS Centralized Service support.
- VHO: this flag shall be sent if the MME requests the vSRVCC HO. | Sv Flags | 0 | +| MME/SGSN Sv Address for Control Plane | M | This IE specifies the address for control plane Initial message which is chosen by the source MME/SGSN. The target MSC Server shall send subsequent control plane Initial messages related to the GTP tunnel for this UE towards this address. | IP-Address | 0 | +| MME/SGSN Sv TEID for Control Plane | M | This IE specifies the tunnel for control plane message which is chosen by the source MME/SGSN. The target MSC Server shall include this TEID in the GTP header of all control plane messages related to the GTP tunnel for this UE. | TEID-C | 0 | +| C-MSISDN | C | The MME/SGSN shall include C-MSISDN IE in the message except for the cases:
- The UE is emergency attached and it is UICClass
- The UE is emergency attached and the IMSI is not authenticated
The C-MSISDN is defined in 3GPP TS 23.003 [4]. | MSISDN | 0 | +| STN-SR | C | The MME/SGSN shall include STN-SR IE if this session is not for an emergency call. | STN-SR | 0 | +| MM Context for E-UTRAN (v)SRVCC | C | The MME shall include mobile station classmarks, supported codecs, and CS Security key in MM Context for E-UTRAN (v)SRVCC. The derivation of the CS security keys shall follow the procedures defined 3GPP TS 33.401[7]. | MM Context for E-UTRAN (v)SRVCC | 0 | +| MM Context for UTRAN SRVCC | C | The SGSN shall include mobile station classmarks, supported codecs, and CS Security key in MM Context for UTRAN (HSPA) SRVCC. The derivation of the CS security keys shall follow the procedures defined 3GPP TS 33.102[10]. | MM Context for UTRAN SRVCC | 0 | +| Source to Target Transparent Container | M | The MME or SGSN shall include Source to Target Transparent Container IE | Source to Target Transparent Container IE | 0 | +| Target RNC ID | C | This IE shall be used to identify the target access for (v)SRVCC handover to UTRAN (NOTE 1). | Target RNC ID | 0 | +| Target Cell ID | C | This IE shall be used to identify the target access for SRVCC handover to GERAN (NOTE 1). | Target Global Cell ID | 0 | +| Source SAI | CO | The SGSN shall include this IE during a SRVCC Handover from UTRAN to GERAN and shall set it as per the SAI of the Source ID IE received from the source RNC (see 3GPP TS 25.413 [9]). See NOTE 3. | Service Area Identifier | 0 | +| Allocation/Retention Priority | CO | The MME shall include this IE if (v)SRVCC with priority is supported and (v)SRVCC is performed for an IMS-based MPS session (see 3GPP TS 23.216 [2]). | ARP | 0 | +| Anchor PLMN ID | CO | The MME/SGSN shall include this IE during SRVCC from UTRAN/E-UTRAN PS to UTRAN/GERAN CS domain GWCN/MOCN to be used for subsequent SRVCC handover in the reverse direction as specified in 3GPP TS 23.251 [16]. | PLMN ID | 0 | + +| | | | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|------|-------------------|----| +| Private Extension | O | None | Private Extension | VS | +| NOTE1: Based upon the SRVCC Handover procedure, either Target RNC ID or Target Cell ID shall be present in this message | | | | | +| NOTE2: An MME or SGSN supporting the Sv interface should attempt to get the ME Identity for all SRVCC calls for interception, charging or Automatic Device Detection in the MSC. | | | | | +| NOTE 3: The Source SAI is sent in BSSMAP Handover Request during a SRVCC Handover from UTRAN to GERAN. A default SAI configured in the MSC Server enhanced for SRVCC is sent in BSSMAP Handover Request during a SRVCC Handover from E-UTRAN to GERAN. The default SAI for E-UTRAN should be different from the SAIs used in UTRAN. | | | | | + +### 5.2.3 SRVCC PS to CS Response + +A SRVCC PS to CS Response message shall be sent across Sv interface as a response to SRVCC PS to CS Request by the MSC server during SRVCC procedure in 3GPP TS 23.216 [2]. + +Table 5.2.3 specifies the presence requirements and conditions of the IEs in the message. + +Cause IE indicates if the SRVCC PS to CS request has been accepted, or not. The request has not been accepted by the target MSC server if the Cause IE value differs from "Request accepted". + +**Table 5.2.3: Information Elements in a SRVCC PS to CS Response** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|-----------------------------------------|----|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------|------| +| Cause | M | | Cause | 0 | +| (v)SRVCC rejected Cause | CO | This IE shall be sent if Cause value differs from "Request accepted".
MSC Server shall include this information element to indicate the reason for rejecting SRVCC PS to CS request | SRVCC Cause | 0 | +| MSC Server Sv Address for Control Plane | O | If the Cause IE contains the value "Request accepted", the target MSC server may include MSC server Sv Address for Control Plane IE in SRVCC PS to CS Response message if target MSC Server decides to use different IP address for the subsequent communication. The source MME/SGSN shall store this MSC server address and use it when sending subsequent control plane messages to this GTP-C tunnel. | IP Address | 0 | +| MSC Server Sv TEID for Control Plane | C | The target MSC server shall include MSC server Sv Tunnel Endpoint Identifier for Control Plane IE in SRVCC PS to CS Response message if the Cause IE contains the value "Request accepted". The source MME/SGSN shall include this TEID-C in the GTP-C header of all subsequent uplink control plane messages from the source MME/SGSN to the target MSC servers. | TEID-C | 0 | +| Target to Source Transparent Container | C | If the Cause IE contains the value "Request accepted ", this IE shall be included and shall carry the Target to Source Transparent Container to be sent within the Handover command or the Relocation Command towards the source access network. | Target to Source Transparent Container IE | 0 | +| Private Extension | O | None | Private Extension | VS | + +### 5.2.4 SRVCC PS to CS Complete Notification + +A SRVCC PS to CS Complete Notification message shall be sent across Sv interface to the source MME/SGSN during SRVCC procedure as specified in 3GPP TS 23.216 [2]: + +- to indicate the SRVCC handover with CS Domain has been successfully finished; +- or to indicate the SRVCC handover with CS Domain has finished (i.e. HO Complete / Relocation Complete message has been received from the target RAN) but the IMS Session Transfer procedure completion in 3GPP TS 23.237 [13] has failed by including the appropriate SRVCC post failure Cause value. + +This message shall also be sent on Sv interface to the source MME during vSRVCC procedure in 3GPP TS 23.216 [2]. + +Table 5.2.4 specifies the presence requirements and conditions of the IEs in the message. + +**Table 5.2.4: Information Elements in a SRVCC PS to CS Complete Notification** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|--------------------------|----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|------| +| IMSI | C | This IE shall be included in the message except for the cases:
- The UE is emergency attached and it is UICClass
- The UE is emergency attached and the IMSI is not authenticated | IMSI | 0 | +| SRVCC post failure Cause | CO | This IE shall be sent if a call is to be released locally in the MSC Server due to IMS session leg establishment failure. The MSC Server shall include this IE to indicate the nature of the failure (i.e., permanent or temporary) | SRVCC Cause | 0 | +| Private Extension | O | None | Private Extension | VS | + +### 5.2.5 SRVCC PS to CS Complete Acknowledge + +A SRVCC PS to CS Complete Acknowledge message shall be sent across Sv interface as a response to SRVCC PS to CS Complete Notification during (v)SRVCC handover with CS Domain in 3GPP TS 23.216 [2]. + +Table 5.2.5 specifies the presence requirements and conditions of the IEs in the message. + +**Table 5.2.5: Information Elements in a SRVCC PS to CS Complete Acknowledge** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|----------------------|---|---------------------|-------------------|------| +| Cause | M | None | Cause | 0 | +| Private Extension | O | None | Private Extension | VS | + +### 5.2.6 SRVCC PS to CS Cancel Notification + +A SRVCC PS to CS Cancel Notification message shall be sent across Sv interface from the MME/SGSN to the target MSC server to request the cancellation of an ongoing SRVCC handover. + +This message shall also be sent across Sv interface from the MME to the target MSC server to request the cancellation of an ongoing vSRVCC handover. + +Table 5.2.6 specifies the presence requirements and conditions of the IEs in the message. + +**Table 5.2.6: Information Elements in a SRVCC PS to CS Cancel Notification** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|----------------------|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|------| +| IMSI | C | This IE shall be included in the message except for the cases:
- The UE is emergency attached and it is UICClass
- The UE is emergency attached and the IMSI is not authenticated | IMSI | 0 | +| Cancel Cause | M | MME/SGSN indicates the reason for Handover cancellation | SRVCC Cause | 0 | +| ME Identity (MEI) | C | This IE shall be included in the message for the following cases:
- The UE is emergency attached and it is UICClass
- The UE is emergency attached and the IMSI is not authenticated | MEI | 0 | +| Private Extension | O | None | Private Extension | VS | + +### 5.2.7 SRVCC PS to CS Cancel Acknowledge + +A SRVCC PS to CS Cancel Acknowledge message shall be sent across Sv interface as a response to SRVCC PS to CS Cancel Notification. + +Table 5.2.7 specifies the presence requirements and conditions of the IEs in the message. + +**Table 5.2.7: Information Elements in a SRVCC PS to CS Cancel Acknowledge** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|----------------------|---|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|------| +| Cause | M | None | Cause | 0 | +| Sv Flags | C | This IE shall be included if any one of the applicable flags is set to 1.
The following flags are applicable:
- STI: this flag shall be sent if the MSC Server has started the IMS session transfer procedure. | Sv Flags | 0 | +| Private Extension | O | None | Private Extension | VS | + +### 5.2.8 SRVCC CS to PS Request + +A SRVCC CS to PS Request message shall be sent across Sv interface from the MSC Server to the target MME/SGSN as part of UTRAN/GERAN to E-UTRAN/UTRAN (HSPA) SRVCC procedure in 3GPP TS 23.216 [2]. + +Table 5.2.8 specifies the presence requirements and conditions of the IEs in the message. + +**Table 5.2.8: Information Elements in a SRVCC CS to PS Request** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|-----------------------------------------|---|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------|------| +| IMSI | C | The IE shall be included if available. | IMSI | 0 | +| ME Identity (MEI) | C | This IE shall be included if available. | MEI | 0 | +| MSC Server Sv Address for Control Plane | M | This IE specifies the address for control plane Initial message which is chosen by the source MSC Server. The target MME/SGSN shall send subsequent control plane Initial messages related to the GTP tunnel for this UE towards this address. | IP Address | 0 | +| MSC Server Sv TEID for Control Plane | M | This IE specifies the tunnel for control plane message which is chosen by the source MSC Server. The target MME/SGSN shall include this TEID in the GTP header of all control plane messages related to the GTP tunnel for this UE. | TEID-C | 0 | +| Source to Target Transparent Container | M | The MSC Server shall include Source to Target Transparent Container IE. | Source to Target Transparent Container | 0 | +| Target Identification | M | This IE shall be included to identify the target access. | Target Identification | 0 | +| P-TMSI | C | This IE shall be included if available. | P-TMSI | 0 | +| Source RAI | C | This IE shall be included if available | ULI | 0 | +| P-TMSI Signature | C | This IE shall be included if available | P-TMSI Signature | 0 | +| GUTI | C | This IE shall be included if available. | GUTI | 0 | +| MM Context for CS to PS SRVCC | M | | MM Context for CS to PS SRVCC | 0 | +| Private Extension | O | None | Private Extension | VS | + +### 5.2.9 SRVCC CS to PS Response + +A SRVCC CS to PS Response message shall be sent across Sv interface as a response to SRVCC CS to PS Request by the MME/SGSN during UTRAN/GERAN to E-UTRAN/UTRAN (HSPA) SRVCC procedure as specified in 3GPP TS 23.216 [2]. + +Table 5.2.9 specifies the presence requirements and conditions of the IEs in the message. + +Cause IE indicates if the SRVCC CS to PS request has been accepted, or not. The request has not been accepted by the target MME/SGSN if the Cause IE value differs from "Request accepted". + +**Table 5.2.9: Information Elements in a SRVCC CS to PS Response** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|----------------------------------------|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------|------| +| Cause | M | | Cause | 0 | +| SRVCC rejected Cause | O | This IE may be sent if Cause value is differs from "Request accepted".
MME/SGSN may include additional information to indicate the reason for rejecting SRVCC CS to PS request | SRVCC Cause | 0 | +| MME/SGSN Sv Address for Control Plane | O | If the Cause IE contains the value" Request accepted", the target MME/SGSN may include MME/SGSN Sv Address for Control Plane IE in SRVCC CS to PS Response message if target MME/SGSN decides to use different IP address for the subsequent communication. The source MSC Server shall store this MME/SGSN address and use it when sending subsequent control plane initial messages to this GTP-C tunnel. | IP Address | 0 | +| MME/SGSN Sv TEID for Control Plane | C | The target MME/SGSN shall include MME/SGSN Sv Tunnel Endpoint Identifier for Control Plane IE in SRVCC CS to PS Response message if the Cause IE contains the value "Request accepted". The source MSC Server shall include this TEID-C in the GTP-C header of all subsequent control plane messages from the source MSC Server to the target MME/SGSN. | TEID-C | 0 | +| Target to Source Transparent Container | C | If the Cause IE contains the value "Request accepted", this IE shall be included and shall carry the Target to Source Transparent Container to be sent within the Handover command or the Relocation Command towards the source access network. | Target to Source Transparent Container | 0 | +| Private Extension | O | None | Private Extension | VS | + +### 5.2.10 SRVCC CS to PS Complete Notification + +A SRVCC CS to PS Complete Notification message shall be sent across Sv interface from the target MME/SGSN to the source MSC Server to indicate the SRVCC handover with PS Domain has been finished during UTRAN/GERAN to E-UTRAN/UTRAN (HSPA) SRVCC procedure as specified in 3GPP TS 23.216 [2]. + +Table 5.2.10 specifies the presence requirements and conditions of the IEs in the message. + +**Table 5.2.10: Information Elements in a SRVCC CS to PS Complete Notification** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|----------------------|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|------| +| SRVCC failure Cause | C | This IE shall be included if there is a failure detected by the target MME/SGSN during UTRAN/GERAN to E-UTRAN/UTRAN (HSPA) SRVCC procedure as specified in 3GPP TS 23.216 [2]. | SRVCC cause | 0 | +| Private Extension | O | None | Private Extension | VS | + +### 5.2.11 SRVCC CS to PS Complete Acknowledge + +A SRVCC CS to PS Complete Acknowledge message shall be sent across Sv interface as a response to SRVCC CS to PS Complete Notification during UTRAN/GERAN to E-UTRAN/UTRAN (HSPA) SRVCC procedure as specified in 3GPP TS 23.216 [2]. + +Table 5.2.10 specifies the presence requirements and conditions of the IEs in the message. + +**Table 5.2.11: Information Elements in a SRVCC CS to PS Complete Acknowledge** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|----------------------|---|---------------------|-------------------|------| +| Cause | M | None | Cause | 0 | +| Private Extension | O | None | Private Extension | VS | + +### 5.2.12 SRVCC CS to PS Cancel Notification + +A SRVCC CS to PS Cancel Notification message shall be sent across Sv interface from the MSC Server to the target MME/SGSN to request the cancellation of an ongoing SRVCC handover. + +Table 5.2.12 specifies the presence requirements and conditions of the IEs in the message. + +**Table 5.2.12: Information Elements in a SRVCC CS to PS Cancel Notification** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|----------------------|---|-----------------------------------------------------------------|-------------------|------| +| IMSI | C | The IMSI shall be included if available. | IMSI | 0 | +| Cancel Cause | M | MSC Server shall indicate the reason for Handover cancellation. | SRVCC Cause | 0 | +| ME Identity (MEI) | C | This IE shall be included if available. | MEI | 0 | +| Private Extension | O | None | Private Extension | VS | + +### 5.2.13 SRVCC CS to PS Cancel Acknowledge + +A SRVCC CS to PS Cancel Acknowledge message shall be sent across Sv interface as a response to SRVCC CS to PS Cancel Notification. + +Table 5.2.13 specifies the presence requirements and conditions of the IEs in the message. + +**Table 5.2.13: Information Elements in a SRVCC CS to PS Cancel Acknowledge** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|----------------------|---|---------------------|-------------------|------| +| Cause | M | None | Cause | 0 | +| Private Extension | O | None | Private Extension | VS | + +## 5.3 Path Management Messages + +### 5.3.1 Introduction + +The following GTPv2-C messages support path management for the Sv interface: + +- Echo Request +- Echo Response +- Version Not Supported Indication + +These messages are defined for GTPv2-C and the handling and definition shall also be as defined in GTPv2-C, see 3GPP TS 29.274 [3]. + +### 5.3.2 Echo Request message + +3GPP TS 29.274 [3] specifies the information elements included in the Echo Request message. + +### 5.3.3 Echo Response message + +3GPP TS 29.274 [3] specifies the information elements included in the Echo Response message. + +### 5.3.4 Version Not Supported Indication message + +3GPP TS 29.274 [3] specifies the detailed handling and information elements included in the Version Not Supported Indication message. + +## 5.4 Reliable Delivery of Signalling Messages + +This is performed as according to GTPv2 in 3GPP TS 29.274 [3]. + +## 5.5 Error Handling + +This is performed as according to GTPv2 in 3GPP TS 29.274 [3]. + +## 5.6 Restoration and Recovery + +This is performed as according to GTPv2 in 3GPP TS 23.007 [5]. + +# 6 Sv Information Elements + +## 6.1 General + +IE type value used in Sv Message is defined in TS 29.274 [3]. The IE format is coded as per GTP in TS 29.274 [3]. + +Table 6.1 shows the IEs used for SRVCC. Within information elements, certain fields may be described as spare. These bits shall be transmitted with the value set to 0. To allow for future features, the receiver shall not evaluate these bits. + +**Table 6.1-1: Information Elements for SRVCC** + +| IE Type value (Decimal) | Information elements | Comment / Reference | Number of Fixed Octets | +|-------------------------|-------------------------------------------------|-----------------------|------------------------| +| 0 | Reserved | 3GPP TS 29.274 [3] | 3GPP TS 29.274 [3] | +| 1 | International Mobile Subscriber Identity (IMSI) | 3GPP TS 29.274 [3] | 3GPP TS 29.274 [3] | +| 2 | Cause | 3GPP TS 29.274 [3] | 3GPP TS 29.274 [3] | +| 3 | Recovery (Restart Counter) | 3GPP TS 29.274 [3] | 3GPP TS 29.274 [3] | +| 4-34 | Reserved for S101 interface | 3GPP TS 29.276 [17] | 3GPP TS 29.276 [17] | +| 35-50 | Reserved for S121 interface | 3GPP TS 29.276 [17] | 3GPP TS 29.276 [17] | +| 51 | STN-SR | Variable Length / 6.2 | Not Applicable | +| 52 | Source to Target Transparent Container | Variable Length / 6.3 | Not Applicable | +| 53 | Target to Source Transparent Container | Variable Length / 6.4 | Not Applicable | +| 54 | MM Context for E-UTRAN (v)SRVCC | Variable Length / 6.5 | Not Applicable | +| 55 | MM Context for UTRAN SRVCC | Variable Length / 6.6 | Not Applicable | +| 56 | SRVCC Cause | Fixed Length / 6.7 | 1 | +| 57 | Target RNC ID | Variable Length / 6.8 | Not Applicable | +| 58 | Target Global Cell ID | Variable Length / 6.9 | Not Applicable | +| 59 | TEID-C | Extendable / 6.10 | 4 | +| 60 | Sv Flags | Extendable / 6.11 | 1 | +| 61 | Service Area Identifier | Extendable / 6.12 | 7 | +| 62 | MM Context for CS to PS SRVCC | Extendable / 6.13 | 42 | +| 63-70 | For future Sv interface use | - | | +| 71-73 | Reserved for GTPv2 | 3GPP TS 29.274 [3] | 3GPP TS 29.274 [3] | +| 74 | IP Address | 3GPP TS 29.274 [3] | 3GPP TS 29.274 [3] | +| 75 | Mobile Equipment Identity (MEI) | 3GPP TS 29.274 [3] | 3GPP TS 29.274 [3] | +| 76 | MSISDN | 3GPP TS 29.274 [3] | 3GPP TS 29.274 [3] | +| 77-85 | Reserved for GTPv2 | 3GPP TS 29.274 [3] | 3GPP TS 29.274 [3] | +| 86 | ULI | 3GPP TS 29.274 [3] | 3GPP TS 29.274 [3] | +| 111 | P-TMSI | 3GPP TS 29.274 [3] | 3GPP TS 29.274 [3] | +| 112 | P-TMSI Signature | 3GPP TS 29.274 [3] | 3GPP TS 29.274 [3] | +| 117 | GUTI | 3GPP TS 29.274 [3] | 3GPP TS 29.274 [3] | +| 120 | PLMN ID | 3GPP TS 29.274 [3] | 3GPP TS 29.274 [3] | +| 121 | Target Identification | 3GPP TS 29.274 [3] | 3GPP TS 29.274 [3] | +| 122-154 | Reserved for GTPv2 | 3GPP TS 29.274 [3] | 3GPP TS 29.274 [3] | +| 155 | Allocation/Retention Priority (ARP) | 3GPP TS 29.274 [3] | 3GPP TS 29.274 [3] | +| 156-254 | Reserved for GTPv2 | 3GPP TS 29.274 [3] | 3GPP TS 29.274 [3] | +| 255 | Private Extension | 3GPP TS 29.274 [3] | 3GPP TS 29.274 [3] | + +NOTE: The size of the TLI (Type, Length and Instance) fields, i.e "4" octets, has been subtracted from the number of the fixed octets of the "Fixed Length" and "Extendable" IEs. + +## 6.2 STN-SR + +STN-SR is defined in 3GPP TS 23.003 [4]. STN-SR is transferred via GTP tunnels. The sending entity copies the value part of the STN-SR into the Value field of the STN-SR IE. The STN-SR IE is coded as depicted in Figure 6.2-1. Octet 5 contains the Nature of Address and Numbering Plan Indicator (NANPI) of the "AddressString" ASN.1 type (see 3GPP TS 29.002 [11]). Octets 6 to (n+4) contain the actual STN-SR (digits of an address encoded as a TBCD-STRING as in the "AddressString" ASN.1 type). For an odd number of STN-SR digits, bits 8 to 5 of the last octet are encoded with the filler "1111". + +| Octets | Bits | | | | | | | | +|--------|---------------------|---|---|---|-------------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 51 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 | NANPI | | | | | | | | +| 6 | Digit 2 | | | | Digit 1 | | | | +| ... | | | | | | | | | +| n+4 | Digit m | | | | Digit (m-1) | | | | + +Figure 6.2-1: STN-SR + +## 6.3 Source to Target Transparent Container + +The Source to Target Transparent Container contains information that shall be transferred transparently by CN entities from the source RAN to the target RAN. + +When the target network is GERAN, the Transparent container field contains the value part of the *Old BSS to New BSS Information* IE defined in 3GPP TS 48.008 [8], i.e. octets 3 to n, excluding octet 1 (Element ID) and octet 2 (Length). + +When the target network is UTRAN, this container carries the *Source RNC to Target RNC Transparent Container* IE defined in 3GPP TS 25.413 [9]. The Transparent container field contains a *transparent copy* of the corresponding ASN.1/PER IE (see subclauses 8.2.2 and 8.48 in 3GPP TS 29.274 [3]). + +When the target network is E-UTRAN, the container carries the *Source eNB To Target eNB Transparent Container* IE defined in 3GPP TS 36.413 [14]. The Transparent container field contains a *transparent copy* of the corresponding ASN.1/PER IE (see subclauses 8.2.2 and 8.48 in 3GPP TS 29.274 [3]). + +The receiver of this Information Element shall ignore the length of the transparent container encoded in octet 5 and shall derive the actual length of the container from the length encoded in octets 2 to 3 minus 1. + +For backward compatibility, the sender of this Information Element shall set the octet 5 to the actual length of the transparent container if the size of the container is smaller or equal to 255 octets, and to the value "255" otherwise. + +| Octets | Bits | | | | | | | | | | | | +|------------|-------------------------------------|---|---|---|----------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Type = 52 (decimal) | | | | | | | | | | | | +| 2 to 3 | Length = n (decimal) | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | +| 5 | Length of the Transparent container | | | | | | | | | | | | +| 6 to (n+4) | Transparent container | | | | | | | | | | | | + +Figure 6.3-1: Source to Target Transparent Container + +## 6.4 Target to Source Transparent Container + +The Target to Source Transparent Container contains information that shall be transferred transparently by CN entities from the target RAN to the source RAN. + +When the target network is GERAN, the Transparent container field contains the value part of the *Layer 3 Information* IE defined in 3GPP TS 48.008 [8], i.e., octets 3 to n, excluding octet 1 (Element ID) and octet 2 (Length). + +When the target network is UTRAN, this container carries the *Target RNC to Source RNC Transparent Container* IE defined in 3GPP TS 25.413 [9]. The Transparent container field contains a *transparent copy* of the corresponding ASN.1/PER IE (see subclauses 8.2.2 and 8.48 in 3GPP TS 29.274 [3]). + +When the target network is E-UTRAN, the container carries the *Target eNB To Source eNB Transparent Container* IE defined in 3GPP TS 36.413 [14]. The Transparent container field contains a *transparent copy* of the corresponding ASN.1/PER IE (see subclauses 8.2.2 and 8.48 in 3GPP TS 29.274 [3]). + +The receiver of this Information Element shall ignore the length of the transparent container encoded in octet 5 and shall derive the actual length of the container from the length encoded in octets 2 to 3 minus 1. + +For backward compatibility, the sender of this Information Element shall set the octet 5 to the actual length of the transparent container if the size of the container is smaller or equal to 255 octets, and to the value "255" otherwise. + +| Octets | Bits | | | | | | | | +|------------|-------------------------------------|---|---|---|----------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 53 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 | Length of the Transparent container | | | | | | | | +| 6 to (n+4) | Transparent container | | | | | | | | + +Figure 6.4-1: Target to Source Transparent Container + +## 6.5 MM Context for E-UTRAN (v)SRVCC + +The MM Context information element contains mobile station classmarks, supported codec list, and the security parameters that are necessary for the MSC server to setup the ciphering connection (and integrity protection for 3G) with the target access for (v)SRVCC. CS ciphering keys parameters: $CK_{SRVCC}$ , $IK_{SRVCC}$ , and eKSI for E-UTRAN (v)SRVCC are defined in 3GPP TS 33.401 [6]. + +Mobile Station Classmark 2, Mobile Station Classmark 3, and Supported Codec List information Elements indicate the supported encryption algorithms for GERAN access and CS supported codecs. The coding of Mobile Station Classmarks and Supported Codec List fields include the IE value part as it is specified in 3GPP TS 24.008 [7]. + +eKSI shall be coded as bits 1 to 3 of the NAS Key Set Identifier IE in TS 24.301 [12]. For an emergency call without an authenticated IMSI, the source MME shall set the key sequence value of the eKSI to the value '111' and $CK_{SRVCC}$ and $IK_{SRVCC}$ to all 0's in binary. + +| Octets | Bits | | | | | | | | +|----------------|------------------------------------------|---|---|---|----------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 54 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 | Spare | | | | eKSI | | | | +| 6 to 21 | $CK_{SRVCC}$ | | | | | | | | +| 22 to 37 | $IK_{SRVCC}$ | | | | | | | | +| 38 | Length of the Mobile Station Classmark 2 | | | | | | | | +| 39 to a | Mobile Station Classmark 2 | | | | | | | | +| b | Length of the Mobile Station Classmark 3 | | | | | | | | +| (b+1) to c | Mobile Station Classmark 3 | | | | | | | | +| d | Length of the Supported Codec List | | | | | | | | +| (d+1) to (n+4) | Supported Codec List | | | | | | | | + +Figure 6.5-1: MM Context for E-UTRAN (v)SRVCC + +## 6.6 MM Context for UTRAN SRVCC + +The MM Context information element contains mobile station classmarks, supported codec list, and the security parameters that are necessary for the MSC server to setup the ciphering connection (and integrity protection for 3G) + +with the target access for SRVCC. The usage of CK'cs, IK'cs, KSI'cs, Kc', CKSN'cs are defined in 3GPP TS 33.102 [10]. + +Mobile Station Classmark 2, Mobile Station Classmark 3, and Supported Codec List information Elements indicate the supported encryption algorithms for GERAN access and CS supported codecs. The coding of Mobile Station Classmarks and Supported Codec List fields include the IE value part as it is specified in 3GPP TS 24.008 [7]. + +CKSN'cs shall be coded as bits 1 to 8 of the CKSN IE in TS 24.008 [7]. The KSI'cs shall be coded as bits 1 to 4 of the CKSN IE in TS 24.008 [7]. + +The source SGSN will send to the MSC Server enhanced for SRVCC either the KSI'cs/CK'cs/IK'cs for an UMTS subscriber or the CKSN'cs/Kc' for a GSM subscriber (see 3GPP TS 33.102 [10]): + +- when transferring KSI'cs/CK'cs/IK'cs, the source SGSN shall set the key sequence value of the CKSN'cs to the value '111' and Kc' to all 0's in binary; +- when transferring CKSN'cs/Kc', the source SGSN shall set the key sequence value of the KSI'cs to the value '111', and CK'cs and IK'cs to all 0's in binary. + +For an emergency call without an authenticated IMSI, the source SGSN shall set the key sequence value of the CKSN'cs and KSI'cs to all 1's, and Kc', CK'cs and IK'cs to all 0's in binary. + +| Octets | Bits | | | | | | | | | | | | +|----------------|------------------------------------------|---|---|---|----------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Type = 55 (decimal) | | | | | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | +| 5 | Spare | | | | KSI'cs | | | | | | | | +| 6 to 21 | CK'cs | | | | | | | | | | | | +| 22 to 37 | IK'cs | | | | | | | | | | | | +| 38 to 45 | Kc' | | | | | | | | | | | | +| 46 | CKSN'cs | | | | | | | | | | | | +| 47 | Length of the Mobile Station Classmark 2 | | | | | | | | | | | | +| 48 to a | Mobile Station Classmark 2 | | | | | | | | | | | | +| b | Length of the Mobile Station Classmark 3 | | | | | | | | | | | | +| (b+1) to c | Mobile Station Classmark 3 | | | | | | | | | | | | +| d | Length of the Supported Codec List | | | | | | | | | | | | +| (d+1) to (n+4) | Supported Codec List | | | | | | | | | | | | + +Figure 6.6-1: MM Context for UTRAN SRVCC + +## 6.7 SRVCC Cause + +SRVCC Cause IE is coded as this is depicted in Figure 6.7-1. + +| Octets | Bits | | | | | | | | +|--------|---------------------|---|---|---|----------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 56 (decimal) | | | | | | | | +| 2 to 3 | Length = 1 | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 | SRVCC Cause value | | | | | | | | + +Figure 6.7-1: SRVCC Cause + +The SRVCC Cause value indicates the reason for cancellation or the rejection of the SRVCC PS to CS Request or the SRVCC CS to PS Request. The SRVCC Cause is also used by the target MME/SGSN to indicate the reason for a failure in the SRVCC CS to PS Complete Notification message.. + +**Table 6.7-1: SRVCC Cause values** + +| Cause value (decimal) | Meaning | +|-----------------------|-----------------------------------------------------------------------------------------| +| 0 | Reserved. Shall not be sent and if received the Cause shall be treated as an invalid IE | +| 1 | Unspecified | +| 2 | Handover/Relocation cancelled by source system | +| 3 | Handover /Relocation Failure with Target system | +| 4 | Handover/Relocation Target not allowed | +| 5 | Unknown Target ID | +| 6 | Target Cell not available | +| 7 | No Radio Resources Available in Target Cell | +| 8 | Failure in Radio Interface Procedure | +| 9 | Permanent session leg establishment error | +| 10 | Temporary session leg establishment error | +| 11-255 | Spare. This value range is reserved for SRVCC Cause values | + +## 6.8 Target RNC ID + +This IE shall contain the identity of the target RNC. The encoding of this IE is defined in 3GPP TS 29.002 [11]. + +| Octets | Bits | | | | | | | | +|------------|----------------------|---|---|---|----------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 57 (decimal) | | | | | | | | +| 2 to 3 | Length = n (decimal) | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 to (n+4) | RNC ID | | | | | | | | + +**Figure 6.8-1: Target RNC ID** + +## 6.9 Target Global Cell ID + +This IE shall contain the identity of the target GSM Cell ID. The encoding of this IE is defined in 3GPP TS 29.002 [11]. + +| Octets | Bits | | | | | | | | +|------------|----------------------|---|---|---|----------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 58 (decimal) | | | | | | | | +| 2 to 3 | Length = n (decimal) | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 to (n+4) | Cell ID | | | | | | | | + +**Figure 6.9-1: Target Cell ID** + +## 6.10 Tunnel Endpoint Identifier for Control Plane (TEID-C) + +Tunnel Endpoint Identifier for Control Plane (TEID-C) is coded as depicted in Figure 6.10-1. + +| Octets | Bits | | | | | | | | | | | | +|---------|------------------------------------------------------------|---|---|---|----------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Type = 59 (decimal) | | | | | | | | | | | | +| 2-3 | Length = n (decimal) | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | +| 5-8 | Tunnel Endpoint Identifier for Control Plane (TEID-C) | | | | | | | | | | | | +| 9-(n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | + +**Figure 6.10-1: Tunnel Endpoint Identifier for Control Plane (TEID-C)** + +## 6.11 Sv Flags + +Sv Flags is coded as depicted in Figure 6.11-1. + +| Octets | Bits | | | | | | | | +|---------|------------------------------------------------------------|-------|-------|-------|----------|-----|-----|-------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 60 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 | Spare | Spare | Spare | Spare | VHO | STI | ICS | EmInd | +| 6-(n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 6.11-1: Sv Flags + +The following bits within Octet 5 indicate: + +- Bit 1 – EmInd (Emergency Indicator): This flag is used to indicate the IMS emergency session. +- Bit 2 – ICS (IMS Centralized Service): This flag is used to request ICS support. +- Bit 3 – STI (Session Transfer Indicator): This flag is used to indicate IMS session transfer has been invoked. +- Bit 4 – VHO (vSRVCC flag): This flag is used to indicate that the vSRVCC HO is requested by the MME. + +## 6.12 Service Area Identifier + +This IE shall contain the identifier of a service area. The encoding of this IE is defined in Figure 6.12-1. + +| Octets | Bits | | | | | | | | | | | | +|----------|------------------------------------------------------------|---|---|---|-------------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Type = 61 (decimal) | | | | | | | | | | | | +| 2-3 | Length = n | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | +| 5 | MCC digit 2 | | | | MCC digit 1 | | | | | | | | +| 6 | MNC digit 3 | | | | MNC digit 3 | | | | | | | | +| 7 | MNC digit 2 | | | | MNC digit 1 | | | | | | | | +| 8 to 9 | Location Area Code (LAC) | | | | | | | | | | | | +| 10 to 11 | Service Area Code (SAC) | | | | | | | | | | | | +| 12-(n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | + +Figure 6.12-1: Service Area Identifier + +The Location Area Code (LAC) consists of 2 octets. Bit 8 of Octet 8 is the most significant bit and bit 1 of Octet 9 the least significant bit. The coding of the location area code is the responsibility of each administration. Coding using full hexadecimal representation shall be used. + +The Service Area Code (SAC) consists of 2 octets. Bit 8 of Octet 10 is the most significant bit and bit 1 of Octet 11 the least significant bit. The SAC is defined by the operator. See 3GPP TS 23.003 [4] subclause 12.5 for more information. + +## 6.13 MM Context for CS to PS SRVCC + +The MM Context for CS to PS SRVCC information element contains the security parameters that are necessary for the MME/SGSN to setup the ciphering connection and integrity protection with the target access for SRVCC. The usage of CK'ps, IK'ps, KSI'ps, Kc'ps, CKSN'ps are defined in 3GPP TS 33.102 [10]. + +Note: Kc'ps, is called GPRS Kc in 3GPP TS 33.102 [10]. + +CKSN'ps shall be coded as bits 1 to 8 of the CKSN IE in TS 24.008 [7]. The KSI'ps shall be coded as bits 1 to 4 of the CKSN IE in TS 24.008 [7]. + +The source MSC Server shall send to the MME/SGSN either the KSIPS /CKPS /IKPS or the CKSNPS /KcPS as specified in 3GPP TS 33.102 [10] and 3GPP TS 33.401[15]: + +- when transferring KSIPS /CKPS /IKPS, the source MSC Server shall set the key sequence value of the CKSNPS to the value '111' and KcPS to all 0's in binary; +- when transferring CKSNPS /KcPS, the source MSC Server shall set the key sequence value of the KSIPS to the value '111', and CKPS and IKPS to all 0's in binary. + +| Octets | Bits | | | | | | | | | | | | | | | | | +|------------|------------------------------------------------------------|-------|-------|-------------------|----------|---|---|---|--|--|--|--|--|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | | | | | | +| 1 | Type = 62 (decimal) | | | | | | | | | | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | | | | | | +| 5 | Spare | Spare | Spare | KSI PS | | | | | | | | | | | | | | +| 6 to 21 | CK PS | | | | | | | | | | | | | | | | | +| 22 to 37 | IK PS | | | | | | | | | | | | | | | | | +| 38 to 45 | Kc PS | | | | | | | | | | | | | | | | | +| 46 | CKSN PS | | | | | | | | | | | | | | | | | +| 47 – (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | | | | | | + +Figure 6.13-1: MM Context for CS to PS SRVCC + +# --- Annex A (informative): Change history + +| Date | TSG # | TSG Doc | CT4 Doc | CR | Rev | Cat | Subject/Comment | New | +|---------|--------|-----------|------------|------|-----|-----|-------------------------------------------------------------------------------|--------| +| 2008-12 | CT#42 | CP-080715 | | | | | V2.0.0 approved in CT#42 | 8.0.0 | +| 2009-03 | CT#43 | CP-090047 | C4-090919 | 0001 | 3 | F | Finalizing Sv spec | 8.1.0 | +| 2009-09 | CT#45 | CP-090544 | C4-091655 | 0003 | | | Definition of TEID-C IE | 8.2.0 | +| 2009-09 | CT#45 | CP-090544 | C4-091860 | 0004 | | | Cleanup of ENs | | +| 2009-09 | CT#45 | CP-090544 | C4-092117 | 0005 | 2 | | HSPA security parameter alignment | | +| 2009-09 | CT#45 | CP-090561 | C4-091939 | 0006 | 2 | | IMEI Changes for SRVCC | 9.0.0 | +| 2009-12 | CT#46 | CP-090777 | C4-094068 | 0011 | 1 | | MSISDN Correction | 9.1.0 | +| 2009-12 | CT#46 | CP-090825 | - | 0012 | 2 | | Alignment with stage 2 for SRVCC HO cancellation procedure | | +| 2010-03 | CT#47 | CP-100027 | C4-1000422 | 0015 | | F | TEID-C, IP Address and UDP Port handling on Sv interface | 9.2.0 | +| | | CP-100027 | C4-100432 | 0018 | | F | IE type value correction | | +| | | CP-100047 | C4-100425 | 0016 | | F | IMSI IE presence corrections | | +| 2010-06 | CT#48 | CP-100280 | C4-101534 | 0020 | 1 | F | Session continuity terminology is not correct | 9.3.0 | +| 2010-09 | CT#49 | CP-100457 | C4-102409 | 0021 | 2 | F | IMEI over the Sv Interface | 9.4.0 | +| 2010-12 | CT#50 | CP-100667 | C4-103287 | 0023 | 1 | F | MM Context for UTRAN SRVCC | 9.5.0 | +| 2011-03 | CT#51 | CP-110043 | C4-110371 | 0027 | 1 | A | Length of the Transparent container | 9.6.0 | +| | | CP-110052 | C4-110403 | 0024 | 2 | F | Target to Source Transparent Container in the SRVCC PS to CS Response message | | +| 2011-03 | | | | | | | Update to Rel-10 version (MCC) | 10.0.0 | +| 2011-06 | CT#52 | CP-110363 | C4-111587 | 0031 | 1 | A | Source SAI during SRVCC HO from UTRAN to GERAN | 10.1.0 | +| 2011-06 | CT#52 | CP-110355 | C4-111548 | 0034 | 1 | A | IE Type Extendable Corrections | 10.1.0 | +| 2011-06 | CT#52 | CP-110353 | C4-111644 | 0037 | 3 | A | STN-SR encoding clarification | 10.1.0 | +| 2011-09 | CT#53 | CP-110565 | C4-112201 | 0038 | 2 | F | "MME/SGSN Sv Address for Control Plane" IE in SRVCC PS to CS Request | 10.2.0 | +| 2011-09 | CT#53 | CP-110584 | C4-112214 | 0039 | 2 | B | Add vSRVCC updates to the Sv interface | 11.0.0 | +| 2011-12 | CT#54 | CP-110779 | C4-112849 | 0047 | | A | Coding of Source to Target Transparent Container | 11.1.0 | +| | | CP-110817 | C4-112460 | 0040 | 1 | B | eMPS for SRVCC | | +| | | CP-110784 | C4-112526 | 0043 | 2 | A | Handling of Extendable IEs | | +| 2012-06 | CT#56 | CP-120234 | C4-120947 | 0050 | 2 | B | CS to PS SRVCC | 11.2.0 | +| | | CP-120227 | C4-121332 | 0049 | 3 | A | SRVCC cause values | | +| | | CP-120229 | C4-121038 | 0052 | - | B | eMPS on vSRVCC | | +| | | CP-120229 | C4-121318 | 0053 | 2 | F | Usage of messages for vSRVCC | | +| 2012-09 | CT#57 | CP-120475 | C4-121726 | 0055 | 1 | B | CS to PS SRVCC Cancel Notification/Acknowledge | 11.3.0 | +| | | CP-120475 | C4-121727 | 0056 | 1 | B | Remove NONCE in CS to PS SRVCC | | +| | | CP-120475 | C4-121798 | 0058 | 3 | B | Anchor PLMN in SRVCC PS to CS Request | | +| | | CP-120457 | C4-121526 | 0059 | - | F | Sv Flags clarifications | | +| 2013-06 | CT#60 | CP-130286 | C4-131029 | 0060 | 3 | F | MEI over Sv for Emergency Call | 11.4.0 | +| 2013-09 | CT#61 | CP-130451 | C4-131101 | 0061 | - | F | GTP-C message types for rSRVCC | 11.5.0 | +| 2013-09 | CT#61 | CP-130470 | C4-131427 | 0062 | 1 | B | Update to cover the S121 | 12.0.0 | +| 2013-12 | CT#62 | CP-130628 | C4-131841 | 0063 | 1 | F | Clarification on the encoding of Transparent Container | 12.1.0 | +| 2014-06 | CT#64 | CP-140261 | C4-141145 | 0069 | 1 | F | Version Not Supported Indication | 12.2.0 | +| | | CP-140232 | C4-141212 | 0073 | 4 | | Transparent container ambiguity | | +| 2015-03 | CT#67 | CP-150025 | C4-150068 | 0074 | - | F | Correct the wrong reference | 12.3.0 | +| | | CP-150025 | C4-150298 | 0075 | 1 | F | Usage of the GTPv2-C Header in Sv interface | 12.3.0 | +| 2015-12 | CT#70 | - | - | - | - | - | Update to Rel-13 version (MCC) | 13.0.0 | +| 2017-03 | CT#75 | - | - | - | - | - | Update to Rel-14 version (MCC) | 14.0.0 | +| 2018-06 | CT#80 | - | - | - | - | - | Update to Rel-15 version (MCC) | 15.0.0 | +| 2020-07 | CT#88e | - | - | - | - | - | Update to Rel-16 version (MCC) | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29281/088921fa3f5a44c8551815122517eefd_img.jpg b/marked/Rel-16/29_series/29281/088921fa3f5a44c8551815122517eefd_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..44599e6a37f92555f0c2e85a1fd48779aa47d1c7 --- /dev/null +++ b/marked/Rel-16/29_series/29281/088921fa3f5a44c8551815122517eefd_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:535c519d5f6a7365aa8f9ccfacf7bb13f083f00aa33c4d5d35843e56f740c947 +size 17600 diff --git a/marked/Rel-16/29_series/29281/1c140ee5d1a87186977da94a96bfa700_img.jpg b/marked/Rel-16/29_series/29281/1c140ee5d1a87186977da94a96bfa700_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..555642d87bb7993a68a4b9bef6ac59f6d1602d19 --- /dev/null +++ b/marked/Rel-16/29_series/29281/1c140ee5d1a87186977da94a96bfa700_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7915fc21af52ae4b9867f93928550175e1c5b244b705b815dc2d593c9e31b283 +size 24697 diff --git a/marked/Rel-16/29_series/29281/49a49278cad196bdfe0db6b4dd1be7fd_img.jpg b/marked/Rel-16/29_series/29281/49a49278cad196bdfe0db6b4dd1be7fd_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..88d0261a47afa25b72de2c36ee3ec761e8b76297 --- /dev/null +++ b/marked/Rel-16/29_series/29281/49a49278cad196bdfe0db6b4dd1be7fd_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:83059a495c81a970daa086d75032ee20752eacfa630e7d0e7ac6b075f3e4b9ff +size 30746 diff --git a/marked/Rel-16/29_series/29281/5a95b187de0044da69b7322e04761b86_img.jpg b/marked/Rel-16/29_series/29281/5a95b187de0044da69b7322e04761b86_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5c7db2114639bd1e813aaab311c5ab69ce0329e5 --- /dev/null +++ b/marked/Rel-16/29_series/29281/5a95b187de0044da69b7322e04761b86_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:463b4308876b51ece859583074ee6410626c0274aaca7bac8525571e62ace7bf +size 22587 diff --git a/marked/Rel-16/29_series/29281/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-16/29_series/29281/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a0dc637ae294cb91589a427e8bd602ffae51e0e2 --- /dev/null +++ b/marked/Rel-16/29_series/29281/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0c657753667ecab94bfe0ae8d115ac0f56e0410e86a78330afc15d6754d18324 +size 10212 diff --git a/marked/Rel-16/29_series/29281/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-16/29_series/29281/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..fcae311d5c0dc734bd8dc6b2ecdeeb55016d4f03 --- /dev/null +++ b/marked/Rel-16/29_series/29281/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:23d05fc6ec908c5e785b351094754a06cd6998abbee997d89894131fed303fc7 +size 5817 diff --git a/marked/Rel-16/29_series/29281/73dff6b45b2b9ffd384bab3235f869af_img.jpg b/marked/Rel-16/29_series/29281/73dff6b45b2b9ffd384bab3235f869af_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7af79129e95895b28275d73ac064908690971029 --- /dev/null +++ b/marked/Rel-16/29_series/29281/73dff6b45b2b9ffd384bab3235f869af_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a2426b42123773793402eed84f7d63083e6ecaa6902e5abfe1d3bebd122ad9e7 +size 16505 diff --git a/marked/Rel-16/29_series/29281/805c475f0859e607af0530ba43194bf1_img.jpg b/marked/Rel-16/29_series/29281/805c475f0859e607af0530ba43194bf1_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0ca344430275fd556d23c9a510b18a827978b6fe --- /dev/null +++ b/marked/Rel-16/29_series/29281/805c475f0859e607af0530ba43194bf1_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:203e19a0250e9448aac20f17750463c4e455fd704439f00634db5566afee2b50 +size 17742 diff --git a/marked/Rel-16/29_series/29281/9c1d3678db4a12d5864cb2a4def1135d_img.jpg b/marked/Rel-16/29_series/29281/9c1d3678db4a12d5864cb2a4def1135d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7a85aaa8003c78a09634254e0181e4a4264f3e24 --- /dev/null +++ b/marked/Rel-16/29_series/29281/9c1d3678db4a12d5864cb2a4def1135d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2f7dc2c37ea0e5a55126a776ff413b044b664c0c584e700711c1fa0c5dff6190 +size 23391 diff --git a/marked/Rel-16/29_series/29281/db5ab5d386827a5d5f5fad0f45612b90_img.jpg b/marked/Rel-16/29_series/29281/db5ab5d386827a5d5f5fad0f45612b90_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..cee58c4109f4030b2b2f0ce5bcd1e74a01a6cf29 --- /dev/null +++ b/marked/Rel-16/29_series/29281/db5ab5d386827a5d5f5fad0f45612b90_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2e0c76730d5760a54ea0130373f06aa5f655c64213bcee0d319a9d0519b5ab00 +size 18926 diff --git a/marked/Rel-16/29_series/29281/fbfa653853daf5541118a9ddecb92284_img.jpg b/marked/Rel-16/29_series/29281/fbfa653853daf5541118a9ddecb92284_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7bc55589ebe742caae48d7b6b02586ec624f32de --- /dev/null +++ b/marked/Rel-16/29_series/29281/fbfa653853daf5541118a9ddecb92284_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:09f2e429bf620da20c8438bcce5bfd3266cd46234215d637f955fa213ade9e27 +size 13189 diff --git a/marked/Rel-16/29_series/29281/raw.md b/marked/Rel-16/29_series/29281/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..6a6e914afa9d71a1851502acc6a71324a9893620 --- /dev/null +++ b/marked/Rel-16/29_series/29281/raw.md @@ -0,0 +1,1356 @@ + + +# 3GPP TS 29.281 V16.2.0 (2021-03) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; General Packet Radio System (GPRS) Tunnelling Protocol User Plane (GTPv1-U) (Release 16)** + +![5G logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The 5G logo, consisting of the text "5G" in a bold, black, sans-serif font. Above the "5G" text are three green curved lines representing signal waves. + +5G logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, featuring the letters "3GPP" in a stylized, bold, black font. Below the "3GPP" text is a red signal icon consisting of three curved lines. Below the icon, the text "A GLOBAL INITIATIVE" is written in a smaller, black, sans-serif font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +# **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +# --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2021, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTSTM is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|-------------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions and abbreviations ..... | 8 | +| 3.1 Definitions..... | 8 | +| 3.2 Abbreviations ..... | 8 | +| 4 General..... | 9 | +| 4.1 GTP Path ..... | 9 | +| 4.2 GTP-U Tunnels ..... | 9 | +| 4.2.1 GTP-U Tunnel description ..... | 9 | +| 4.2.2 IP transport ..... | 10 | +| 4.2.3 GTP-U Tunnel IP transport ..... | 10 | +| 4.2.4 Ingress GTP tunnel (GTPv1-U sending endpoint) ..... | 10 | +| 4.2.5 Egress GTP tunnel (GTPv1-U receiving endpoint)..... | 10 | +| 4.2.6 MBMS IP Multicast Distribution of the User Plane Data ..... | 11 | +| 4.3 GTP-U Protocol Entity ..... | 11 | +| 4.3.0 General ..... | 11 | +| 4.3.1 Handling of Sequence Numbers..... | 11 | +| 4.4 Protocol stack ..... | 12 | +| 4.4.0 GTP-PDU Stacks..... | 12 | +| 4.4.1 UDP/IP ..... | 13 | +| 4.4.2 UDP header and port numbers ..... | 13 | +| 4.4.2.0 General..... | 13 | +| 4.4.2.1 Echo Request Message ..... | 13 | +| 4.4.2.2 Echo Response Message ..... | 13 | +| 4.4.2.3 Encapsulated T-PDUs..... | 13 | +| 4.4.2.4 Error Indication ..... | 13 | +| 4.4.2.5 Supported Extension Headers Notification..... | 13 | +| 4.4.2.6 End Marker ..... | 14 | +| 4.4.3 IP header and IP addresses ..... | 14 | +| 4.4.3.1 Echo Request Message ..... | 14 | +| 4.4.3.2 Echo Response Message ..... | 14 | +| 4.4.3.3 Encapsulated T-PDUs..... | 14 | +| 4.4.3.4 Error Indication ..... | 14 | +| 4.4.3.5 Supported Extension Headers Notification..... | 14 | +| 4.4.3.6 End Marker ..... | 14 | +| 4.5 Transmission Order and Bit Definitions ..... | 14 | +| 4.6 New Functionality ..... | 15 | +| 5 GTP-U header ..... | 15 | +| 5.1 General format..... | 15 | +| 5.2 GTP-U Extension Header..... | 16 | +| 5.2.1 General format of the GTP-U Extension Header ..... | 16 | +| 5.2.2 Extension Header types ..... | 18 | +| 5.2.2.1 UDP Port..... | 18 | +| 5.2.2.2 PDCP PDU Number ..... | 19 | +| 5.2.2.2A Long PDCP PDU Number ..... | 19 | +| 5.2.2.3 Service Class Indicator ..... | 20 | +| 5.2.2.4 RAN Container ..... | 21 | +| 5.2.2.5 Xw RAN Container ..... | 21 | +| 5.2.2.6 NR RAN Container..... | 22 | +| 5.2.2.7 PDU Session Container ..... | 22 | +| 6 GTP-U Message Formats..... | 22 | +| 6.1 General ..... | 22 | + +| | | | +|-------------------------------|----------------------------------------------------------|-----------| +| 6.2 | Presence requirements of Information Elements ..... | 23 | +| 7 | GTP-U Messages ..... | 23 | +| 7.1 | General ..... | 23 | +| 7.2 | Path Management Messages ..... | 23 | +| 7.2.1 | Echo Request ..... | 23 | +| 7.2.2 | Echo Response ..... | 24 | +| 7.2.3 | Supported Extension Headers Notification ..... | 24 | +| 7.3 | Tunnel Management Messages ..... | 24 | +| 7.3.1 | Error Indication ..... | 24 | +| 7.3.2 | End Marker ..... | 25 | +| 7.3.2.1 | General ..... | 25 | +| 7.3.2.2 | End Marker in EPS ..... | 25 | +| 7.3.2.3 | End Marker in 5GS ..... | 26 | +| 8 | Information Elements ..... | 26 | +| 8.1 | Information Element Types ..... | 26 | +| 8.2 | Recovery ..... | 27 | +| 8.3 | Tunnel Endpoint Identifier Data I ..... | 27 | +| 8.4 | GTP-U Peer Address ..... | 27 | +| 8.5 | Extension Header Type List ..... | 28 | +| 8.6 | Private Extension ..... | 28 | +| 9 | Error Handling ..... | 28 | +| 9.1 | Protocol Errors ..... | 28 | +| 9.2 | Path Failure ..... | 29 | +| 10 | Security ..... | 29 | +| 11 | Reliable Delivery of Signalling Messages ..... | 29 | +| 12 | GTP Parameters ..... | 29 | +| 12.1 | General ..... | 29 | +| 12.2 | Timers ..... | 29 | +| 12.3 | Others ..... | 29 | +| 13 | Tunnelling Scenarios ..... | 29 | +| 13.1 | General ..... | 29 | +| 13.2 | Tunnelling between SGWs ..... | 30 | +| 13.3 | Transfer of the user plane data between PDN GWs ..... | 30 | +| 13.4 | Tunnelling between SGSNs ..... | 30 | +| 13.5 | Tunnelling between Source RNC and Target RNC ..... | 30 | +| 13.6 | Transfer of the user plane data between GGSNs ..... | 30 | +| 13.7 | Tunnelling between RNC and eNodeB ..... | 30 | +| 13.8 | Tunnelling between SGSN and eNodeB ..... | 30 | +| 13.9 | Tunnelling between Source eNodeB and Target eNodeB ..... | 31 | +| 13.10 | Tunnelling between SGSN and RNC ..... | 31 | +| 13.11 | Tunnelling between SGSN and SGW ..... | 31 | +| 13.12 | Tunnelling between SGW and eNodeB ..... | 31 | +| 13.13 | Tunnelling between SGW and RNC ..... | 31 | +| 13.14 | Tunnelling between SGW and SGSN ..... | 31 | +| Annex A (Normative): | PDU session user plane protocol over N9 ..... | 32 | +| Annex B (informative): | Change history ..... | 32 | + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document defines the user plane of GTP used on: + +- the Gn and Gp interfaces of the General Packet Radio Service (GPRS); +- the Iu, Gn and Gp interfaces of the UMTS system; +- the S1-U, S11-U, S2a, S2b, X2, S4, S5, S8, S12, M1 and Sn interfaces of the Evolved Packet System (EPS); +- the F1-U, Xn, N3, N9 and N19 interfaces of the 5G System (5GS); + +This definition ensures full backwards compatibility with RNC, SGSN and GGSN implementations according to release 7 of 3GPP TS 29.060 [6]. + +NOTE: Releases previous to Release-8 have used 3GPP TS 29.060 [6] as normative definition of the user plane of GTP. This shall be considered when essential corrections are included in the present document or in pre-release-8 version of 3GPP TS 29.060 [6]. + +Fallback from GTPv1-U to GTPv0-U shall not be supported. Therefore, 3GPP Rel-8 and onwards GTPv1-U entity should not listen to the well-known GTPv0 port 3386. If GTPv1 entity listens to the GTPv0 port, the entity shall silently discard any received GTPv0-U message. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.003: "Numbering, addressing and identification". +- [3] 3GPP TS 23.007: "Restoration procedures". +- [4] 3GPP TS 23.060: "General Packet Radio Service (GPRS); Service description; Stage 2". +- [5] 3GPP TS 23.401: "General Packet Radio Service (GPRS) enhancements for Evolved Universal Terrestrial Radio Access Network (E-UTRAN) access". +- [6] 3GPP TS 29.060: "General Packet Radio Service (GPRS); GPRS Tunnelling Protocol (GTP) across the Gn and Gp interface". + +- [7] 3GPP TS 29.274: "3GPP Evolved Packet System; Evolved GPRS Tunnelling Protocol for EPS (GTPv2)". +- [8] 3GPP TS 32.295: "Telecommunication management; Charging management; Charging Data Record (CDR) transfer". +- [9] IETF RFC 768 (STD 0006): "User Datagram Protocol", J. Postel. +- [10] IETF RFC 791 (STD 0005): "Internet Protocol", J. Postel. +- [11] IETF RFC 4291: "IP Version 6 Addressing Architecture". +- [12] 3GPP TS 33.210: "3G security; Network Domain Security (NDS); IP network layer security". +- [13] 3GPP TS 23.121: "Architectural requirements for Release 1999". +- [14] 3GPP TS 43.129: "Packet-switched handover for GERAN A/Gb mode; Stage 2". +- [15] IETF RFC 2460: "Internet Protocol, Version 6 (IPv6) Specification". +- [16] 3GPP TS 25.413: "UTRAN Iu interface RANAP signalling". +- [17] 3GPP TS 36.300: "Evolved Universal Terrestrial Radio Access (E-UTRA) and Evolved Universal Terrestrial Radio Access Network (E-UTRAN); Overall description; Stage 2". +- [18] 3GPP TS 23.246: "Multimedia Broadcast/Multicast Service (MBMS); Architecture and functional description; Stage 2". +- [19] IETF RFC 4604 (2006): "Using Internet Group Management Protocol Version 3 (IGMPv3) and Multicast Listener Discovery Protocol Version 2 (MLDv2) for Source-Specific Multicast". +- [20] IETF RFC 4607 (2006): "Source-Specific Multicast for IP". +- [21] 3GPP TS 33.102: "3G Security; Security architecture". +- [22] 3GPP TS 33.401: "3GPP System Architecture Evolution (SAE): Security architecture". +- [23] 3GPP TS 23.402: "Architecture enhancements for non-3GPP accesses". +- [24] 3GPP TS 36.323: "Evolved Universal Terrestrial Radio Access (E-UTRA); Packet Data Convergence Protocol (PDCP) specification". +- [25] 3GPP TS 36.425: "E-UTRAN X2 interface user plane protocol". +- [26] IETF RFC 2474, "Definition of the Differentiated Services Field (DS Field) in the IPv4 and IPv6 Headers". +- [27] 3GPP TS 36.465: "Evolved Universal Terrestrial Radio Access (E-UTRAN) and Wireless LAN (WLAN) Xw interface user plane protocol". +- [28] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [29] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [30] 3GPP TS 38.425: "NG-RAN; NR user plane protocol". +- [31] 3GPP TS 38.415: "NG-RAN; PDU Session User Plane Protocol". +- [32] 3GPP TS 33.250: "Security assurance specification for the PGW network product class". +- [33] 3GPP TS 23.527: "5G System; Restoration Procedures". +- [34] 3GPP TS 38.300: "NR; NR and NG-RAN Overall Description; Stage 2". +- [35] 3GPP TS 38.323: "NR; Packet Data Convergence Protocol (PDCP) specification". +- [36] IETF RFC 8200: "Internet Protocol, Version 6 (IPv6) Specification" + +- [37] IETF RFC 6437: "IPv6 Flow Label Specification". +- [38] 3GPP TS 37.340: "Evolved Universal Terrestrial Radio Access (E-UTRA) and NR; Multi-connectivity; Stage 2". + +# 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in TR 21.905 [1]. + +**Common Tunnel Endpoint Identifier (C-TEID):** Unambiguously identifies a tunnel endpoint in the receiving GTP-U protocol entity for a given UDP/IP endpoint. The sending end side of a GTP tunnel locally assigns the C-TEID value used in the TEID field and signals it to the destination Tunnel Endpoint using a control plane message. + +**GTP-U Message:** GTP-U (user plane) messages are either user plane messages or signalling messages. User plane messages are used to carry user data packets between GTP-U entities. Signalling messages are sent between network nodes for path management and tunnel management. **GTP-U peer:** node implementing at least one side of any of the GTP user plane based protocols. RNC, SGSN, GGSN, eNodeB, SGW, ePDG, gNB, N3IWF, UPF, PGW or TWAN or MME. + +**GTP-U Tunnel:** A GTP-U tunnel is identified in each node with a TEID, an IP address and a UDP port number. A GTP-U tunnel is necessary to enable forwarding packets between GTP-U entities. + +**GTP-U Tunnel Endpoint:** A GTP-U tunnel endpoint identifies a user plane context (e.g EPS bearer, PDU session or a RAB) for which a received GTP-U packet is intended. A given GTP-U tunnel endpoint may receive GTP-U packets from more than one source GTP-U peer (See clause 4.3.0). **UDP/IP Path:** Connection-less unidirectional or bidirectional path defined by two end-points. An IP address and a UDP port number define an end-point. A UDP/IP path carries GTP messages between network nodes related to one or more GTP tunnels. + +**GTP-PDU:** GTP Protocol Data Unit (PDU) is a GTP-U message, which may be either a G-PDU or a signalling message. + +**G-PDU:** User data packet (T-PDU) plus GTP-U header, sent between GTP network nodes. + +**Signalling Message:** A GTP-U message (GTP-PDU that is not a G-PDU) sent between GTP network nodes. These may be Path Management messages or Tunnel Management messages. + +**T-PDU:** A user data packet, for example an IP datagram, sent between a UE and a network entity in an external packet data network. A T-PDU is the payload that is tunnelled in the GTP-U tunnel. + +**Tunnel Endpoint Identifier (TEID):** Unambiguously identifies a tunnel endpoint in the receiving GTP-U protocol entity for a given UDP/IP endpoint. The receiving end side of a GTP tunnel locally assigns the TEID value the transmitting side has to use. The TEID values are exchanged between tunnel endpoints using control plane message. + +**Trusted WLAN Access Network:** see 3GPP TS 23.402 [23]. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in TR 21.905 [1]. + +| | | +|--------|-----------------------------------| +| C-TEID | Common Tunnel Endpoint Identifier | +| EN-DC | E-UTRA-NR Dual Connectivity | +| ePDG | Evolved Packet Data Gateway | +| GSN | GPRS Support Node | +| GGSN | Gateway GPRS Support Node | + +| | | +|-------|---------------------------------------| +| G-PDU | GTP encapsulated user Plane Data Unit | +| GTP | GPRS Tunnelling Protocol | +| GTP-C | GTP Control | +| GTP-U | GTP User | +| IE | Information Element | +| IGMP | Internet Group Management Protocol | +| IP | Internet Protocol | +| IPv4 | Internet Protocol version 4 | +| IPv6 | Internet Protocol version 6 | +| MME | Mobility Management Entity | +| PDU | Packet Data Unit | +| PGW | PDN Gateway | +| QoS | Quality of Service | +| RANAP | Radio Access Network Application Part | +| RNC | Radio Network Controller | +| SGSN | Serving GPRS Support Node | +| SGW | Serving Gateway | +| TEID | Tunnel Endpoint Identifier | +| T-PDU | Transport PDU | +| TWAN | Trusted WLAN Access Network | +| UDP | User Datagram Protocol | +| UTRAN | UMTS Terrestrial Radio Access Network | + +# --- 4 General + +## 4.1 GTP Path + +For the definition of UDP/IP Path and GTP Endpoint, see 3GPP TS 29.060 [6]. + +## 4.2 GTP-U Tunnels + +### 4.2.1 GTP-U Tunnel description + +GTP-U Tunnels are used to carry encapsulated T-PDUs and signalling messages between a given pair of GTP-U Tunnel Endpoints. The Tunnel Endpoint ID (TEID) which is present in the GTP header shall indicate which tunnel a particular T-PDU belongs to. In this manner, packets are multiplexed and de-multiplexed by GTP-U between a given pair of Tunnel Endpoints. The TEID value to be used in the TEID field shall be signalled to the peer GTP-U entity using a control plane protocol like GTPv1-C, GTPv2-C, RANAP or S1-AP. + +In what follows we refer to the outer GTPv1-U IP packet as the IP packet that carries a GTPv1-U packet. The inner IP packet in a GTPv1-U packet (T-PDU) is either + +- An IP packet sent to the UE/MS in the downlink direction over one or more tunnels from the external network identified by the APN. +- An IP packet sent from a UE/MS in the uplink direction over one or more tunnels to the external network identified by the APN. + +NOTE 1: Not all tunnels in 3GPP networks will necessarily be GTPv1-U, + +NOTE 2: The inner MTU size of the GTPv1-U tunnel is typically not the same as the outer MTU size of the IP path carrying the outer IP packets. + +The maximum size of a T-PDU that may be transmitted without fragmentation by GGSN or the MS is defined in 3GPP TS 23.060 [4]. + +### 4.2.2 IP transport + +According to IETF RFC 791 [10], any IPv4 router in the backbone may fragment the outer IPv4 GTPv1-U packet with a flag of DF=0. + +Unnecessary fragmentation should be avoided when possible due to the following: + +- Fragmentation is bandwidth inefficient, since the complete IP header is duplicated in each fragment. +- Fragmentation is CPU intensive since more fragments require more processing at both GTPv1-U endpoints and IP routers. It also requires additional memory at the receiver. +- If one fragment is lost, the complete packet has to be discarded. The reason is there is no selective retransmission of IP fragments provided in IPv4 or IPv6. + +Recommendations on how to set the default inner MTU size at the PDN GW and UE/MS to avoid IP fragmentation of both inner IP packets (in the PDN GW or UE/MS) and outer IP packets in the backbone are specified in clause 9.3 of 3GPP TS 23.060 [4]. + +### 4.2.3 GTP-U Tunnel IP transport + +Functionality for IP transport and IP fragmentation at a RAN node on the Iu interface or S12 is defined in 3GPP TS 25.414 [16]. + +Functionality for IP transport and IP fragmentation at an eNodeB on the S1-U and X2 interface is defined in 3GPP TS 36.300 [17]. + +Functionality for IP transport and IP fragmentation at an NG-RAN on the N3 and Xn interface is defined in 3GPP TS 38.300 [34]. + +The outer GTPv1-U packet layer shall support IPv4 as defined by IETF RFC 791 [10] and should support IPv6 as defined by IETF RFC 8200 [36]. + +The following text as well as clauses 4.2.4 and 4.2.5 apply only to core network GTPv1-U endpoints. + +GTPv1-U tunnel endpoints do not need to change the hopcount/TTL or to perform any IP routing functions in respect to inner IP packet other than the functions explicitly stated here. However, other co-located functions may do so. For example, the GGSN/PGW/UPF may change the hopcount/TTL as the IP datagram enters/leaves the Gi/SGi/N6 interface from/to the GTPv1-U tunnel interface and IP packets may be discarded or rejected at any point by a co-located function due to local policy and/or QoS (the policy enforcement point). + +### 4.2.4 Ingress GTP tunnel (GTPv1-U sending endpoint) + +An inner IP packet shall be encapsulated at the GTPv1-U sender with a GTP header, UDP and IP header. If the resulting outer IP packet is larger than the MTU of the first link towards the destination GTPv1-U endpoint, fragmentation of the IP packet shall be performed by the sender as per IETF RFC 791 [10] for an outer layer of IPv4 and IETF RFC 8200 [36] for an outer layer of IPv6. The GTPv1-U sender should preferably fragment the IP packet to the smallest MTU of any link between GTPv1-U sender and GTPv1-U receiver. + +Fragmentation policy of the inner datagram is implementation dependent but shall interwork with IETF RFC 791 [10] for inner IPv4 datagrams and IETF RFC 8200 [36] for inner IPv6 packets. + +### 4.2.5 Egress GTP tunnel (GTPv1-U receiving endpoint) + +The GTPv1-U receiving endpoint packets shall reassemble any IP fragments in datagrams received from the GTPv1-U sending endpoint as per IETF RFC 791 [10] for outer IPv4 datagrams and as per IETF RFC 8200 [36] for outer IPv6 datagrams. The IP reassembly buffer in the receiving endpoint shall be at least the inner MTU size plus the size of the tunnel headers (outer IP header, outer UDP header, and GTP header, including any GTP extension headers). + +The completely reassembled IP packet shall then be passed to the IP/UDP/GTPv1-U layers to extract the inner IP packet which is then processed further according to the receiving node's functionality. + +### 4.2.6 MBMS IP Multicast Distribution of the User Plane Data + +GTP-U Multicast Tunnels are used for unidirectional transfer of the encapsulated T-PDUs from one GTP-U Tunnel Endpoint acting as an IP multicast source to multiple GTP-U Tunnel Endpoints acting as IP multicast listeners, as specified in TS 23.246 [18]. The Common Tunnel Endpoint ID (C-TEID) which is present in the GTP header shall indicate which tunnel a particular T-PDU belongs to. The C-TEID value to be used in the TEID field is allocated at the source Tunnel Endpoint and signalled to the destination Tunnel Endpoint using a control plane protocol i.e. GTPv1-C, and RANAP, GTPv2-C and S1-AP. There is one C-TEID allocated per MBMS bearer service. + +The destination IP address in the outer GTPv1-U IP header is an address in the multicast address range as specified in IETF RFC 4607 [20]. + +If the RNC decides to receive IP multicast packets, then the RNC shall join the IP multicast group as specified by IETF RFC 4604 [19] and IETF RFC 4607 [20]. + +If the eNodeB supports MBMS as specified in TS 23.246 [18], it shall join the IP multicast group as specified in IETF RFC 4604 [19] and IETF RFC 4607 [20]. + +The characteristics for point-to-multipoint GTP-U Multicast Tunnels used for MBMS are the same as for a point-to-point GTP-U Tunnels unless specified otherwise. The differences are specified in clause 7.1. + +## 4.3 GTP-U Protocol Entity + +### 4.3.0 General + +The GTP-U protocol entity provides packet transmission and reception services to user plane entities in the RNC, SGSN, GGSN, eNodeB, SGW, ePDG, PGW, TWAN, MME, gNB, N3IWF, and UPF. The GTP-U protocol entity receives traffic from a number of GTP-U tunnel endpoints and transmits traffic to a number of GTP-U tunnel endpoints. There is a GTP-U protocol entity per IP address. + +The TEID in the GTP-U header is used to de-multiplex traffic incoming from remote tunnel endpoints so that it is delivered to the User plane entities in a way that allows multiplexing of different users, different packet protocols and different QoS levels. The GTP-U protocol supports the possibility for one GTP-U tunnel endpoint to receive packets from multiple remote GTP-U endpoints. This may be used in the following scenarios: + +- Tracking Area Update procedure with Serving GW change and data forwarding as specified in clause 5.3.3.1A of 3GPP TS 23.401 [5], if the above capability is supported by the receiving eNB; +- Dual connectivity in 5GC as specified in clause 5.11.1 of 3GPP TS 23.501 [28], where the master and secondary NG-RAN may be assigned the same uplink F-TEID of the UPF by the SMF for uplink traffic of the same PDU session; and +- IPv6 multihoming scenario as specified in clause 5.6.4.3 of 3GPP TS 23.501 [28], where the downlink traffic from multiple PDU Session Anchors of the same PDU session may be assigned the same N9 F-TEID of the branching point UPF by the SMF. + +### 4.3.1 Handling of Sequence Numbers + +This functionality is provided only when the S bit is set to 1 in the GTP-U header. + +For PGW, SGW, ePDG, eNodeB, TWAN, MME, gNB, N3IWF, and UPF, the usage of sequence numbers in G-PDUs is optional, but if GTP-U protocol entities in these nodes are relaying G-PDUs to other nodes, then they shall relay the sequence numbers as well. For all other cases, the PGW, SGW, ePDG, eNodeB, TWAN, MME, gNB, N3IWF and UPF should set the "S" flag to 0 in the GTPv1 header which then indicates that the sequence number is not used in the T-PDU. + +An RNC, SGSN or GGSN shall reorder out of sequence T-PDUs when in sequence delivery is required. This is optional at the SGSN for UTRAN access. The GTP-U protocol entity shall deliver to the user plane entity only in sequence T-PDUs and notify the sequence number associated to each of them. The notification of the sequence number is not necessary at the GGSN, but it is mandatory at the SGSN and RNC. The user plane entity shall provide a sequence number to the GTP-U layer together with T-PDUs to be transmitted in sequence. GTP-U protocol entities at the GGSN + +may optionally generate autonomously the sequence number, but should be able to use sequence numbers provided by the user plane entity. The sequence number is handled on a per GTP-U Tunnel (that is TEID) basis. During relocations and handovers, if a buffered packet is forwarded from the source to the target GTP-U protocol entity along with PDCP T-PDU extension headers, the source of the T-PDU may be considered different and may not relay the sequence numbers. + +When the sequence number is included in the GTP-U header, a user plane entity acting as a relay of T-PDUs between GTP-U protocol entities, or between PDCP (or SNDCP) protocol entities and GTP-U protocol entities, shall relay the sequence numbers between those entities as well. In this way it is possible to keep consistent values of sequence numbers from the GGSN to the UE (MS in GPRS) by relaying the sequence number across the CN GTP-U bearer, the Iu GTP-U bearer and the Radio bearer (via PDCP or SNDCP N-PDU numbers). This functionality is beneficial during SRNS relocation. + +For GTP-U signalling messages having a response message defined for a request message, Sequence Number shall be a message number valid for a path. Within a given set of continuous Sequence Numbers from 0 to 65535, a given Sequence Number shall, if used, unambiguously define a GTP-U signalling request message sent on the path (see clause Reliable delivery of signalling messages). The Sequence Number in a signalling response message shall be copied from the signalling request message that the GTP-U entity is replying to. For GTP-U messages not having a defined response message for a request message, i.e. for messages Supported Extension Headers Notification and Error Indication, the Sequence Number shall be ignored by the receiver. + +## 4.4 Protocol stack + +### 4.4.0 GTP-PDU Stacks + +The protocol stack for a GTP-PDU G-PDU is shown in Figure 4.4-1. The protocol stack for a GTP-PDU signaling message is shown in Figure 4.4-2. + +![Figure 4.4-1 G-PDU Protocol Stack diagram](fbfa653853daf5541118a9ddecb92284_img.jpg) + +The diagram shows a vertical stack of three rectangular boxes. The top box is labeled 'T-PDU'. The middle box is labeled 'GTPv1-U Header'. The bottom box is labeled 'UDP/IP'. A large curly brace on the right side groups the top two boxes ('T-PDU' and 'GTPv1-U Header') and is labeled 'G-PDU'. + +Figure 4.4-1 G-PDU Protocol Stack diagram + +Figure: 4.4-1 G-PDU Protocol Stack + +NOTE: T-PDU may contain an IP Datagram, Ethernet or unstructured PDU Data frames as specified in 3GPP TS 23.501 [28]. + +![Figure 4.4-2 Signalling Message Protocol Stack diagram](5a95b187de0044da69b7322e04761b86_img.jpg) + +The diagram shows a vertical stack of three rectangular boxes. The top box is labeled 'Zero or more IEs'. The middle box is labeled 'GTPV1-U Header'. The bottom box is labeled 'UDP/IP'. A large curly brace on the right side groups the top two boxes ('Zero or more IEs' and 'GTPV1-U Header') and is labeled 'Signaling Message (Path Management or Tunnel Management)'. + +Figure 4.4-2 Signalling Message Protocol Stack diagram + +Figure: 4.4-2 Signalling Message Protocol Stack + +### 4.4.1 UDP/IP + +UDP/IP is the only path protocol defined to transfer GTP messages in the version 1 of GTP. + +A GTPv1-U peer shall support the User Datagram Protocol (UDP) as defined by IETF RFC 768 [9] shall be used. + +A GTPv1-U peer shall support IPv4 as defined by IETF RFC 791 [10] and should support IPv6 as defined by IETF RFC 8200 [36]. + +The DSCP marking as defined by IETF RFC 2474 [26] shall be set: + +- based on the QCI, and optionally the ARP priority level, of the associated EPS bearer, as described in clause 4.7.3 of 3GPP TS 23.401 [5]; +- based on the 5QI and ARP of the associated 5G QoS Flow, as described in clause 5.7.1.6 and clause 5.7.1.7 of 3GPP TS 23.501 [28]. + +### 4.4.2 UDP header and port numbers + +#### 4.4.2.0 General + +For the GTP-U messages described below (other than the Echo Response message, see clause 4.4.2.2), the UDP Source Port or the Flow Label field (see IETF RFC 6437 [37]) should be set dynamically by the sending GTP-U entity to help balancing the load in the transport network. + +When using GTP-U over IPv6 (see IETF RFC 8200 [36]), the UDP checksum shall not be set to zero by the sending GTP-U entity unless it is ensured that the peer GTP-U entity and the path in-between supports UDP zero checksum. + +NOTE 1: GTP-U entities complying with an earlier version of the specification or on path IPv6 middleboxes can implement IPv6 as specified in IETF RFC 2460 [15] and discard UDP packets containing a zero checksum. + +NOTE 2: How a sending GTP-U entity knows whether the peer GTP-U entity and the path in-between supports UDP zero checksum is out of scope of this specification. + +#### 4.4.2.1 Echo Request Message + +The UDP Destination Port number for GTP-U request messages is 2152. It is the registered port number for GTP-U. + +#### 4.4.2.2 Echo Response Message + +The UDP Destination Port value shall be the value of the UDP Source Port of the corresponding request message. + +The UDP Source Port shall be the value from the UDP Destination Port of the corresponding request message. + +#### 4.4.2.3 Encapsulated T-PDUs + +The UDP Destination Port number shall be 2152. It is the registered port number for GTP-U. + +#### 4.4.2.4 Error Indication + +The UDP destination port for the Error Indication shall be the user plane UDP port (2152). + +NOTE: In network deployments including non-GTP-aware stateful firewalls, those firewalls must be configured to allow response messages coming from a different UDP port and IP address than the triggering message. + +#### 4.4.2.5 Supported Extension Headers Notification + +The UDP destination port for the Supported Extension Headers Notification shall be the user plane UDP port (2152). + +#### 4.4.2.6 End Marker + +The UDP Destination Port number shall be 2152. It is the registered port number for GTP-U. + +The UDP Destination Port and UDP Source Port shall be the same as those of the corresponding GTP-U tunnel for which the End Marker message is sent. + +### 4.4.3 IP header and IP addresses + +#### 4.4.3.1 Echo Request Message + +The IP Source Address shall be an IP address of the source GTP-U entity from which the message is originating. + +The IP Destination Address in a GTP request message shall be an IP address of the destination GTP-U entity. + +#### 4.4.3.2 Echo Response Message + +The IP Source Address shall be copied from the IP destination address of the GTP request message to which this GTP-U entity is replying. + +The IP Destination Address shall be copied from the IP Source Address of the GTP request message to which this GTP-U entity is replying. + +#### 4.4.3.3 Encapsulated T-PDUs + +The IP Source Address shall be an IP address of the source GTP-U entity from which the message is originating. + +The IP Destination Address shall be an IP address of the destination GTP-U entity. + +#### 4.4.3.4 Error Indication + +The IP source address shall be an address of the source GTP-U entity from which the message is originated + +NOTE: In network deployments including non-GTP-aware stateful firewalls, those firewalls must be configured to allow response messages coming from a different UDP port and IP address than the triggering message. + +The IP destination address for Error Indication shall be the source address of the GTP-PDU that is the cause for this GTP-U entity to send this message. + +#### 4.4.3.5 Supported Extension Headers Notification + +The IP Source Address for the Supported Extension Headers Notification shall be copied from the IP destination address of the GTP message that triggered the GTP-U entity to send this message. + +The IP Destination Address for the Supported Extension Headers Notification shall be copied from the IP source address of the GTP message that triggered the GTP-U entity to send this message. + +#### 4.4.3.6 End Marker + +The IP Source Address shall be an IP address of the source GTP-U entity from which the message is originating. + +The IP Destination Address shall be an IP address of the destination GTP-U entity. + +The IP Destination Address and IP Source Address shall be the same as those of the corresponding GTP-U tunnel for which the End Marker message is sent. + +## 4.5 Transmission Order and Bit Definitions + +As specified in 3GPP TS 29.060 [6], clause 5. + +## 4.6 New Functionality + +With regard to the previous releases, the present specification may define some new functions. Such new functions shall ensure full backwards compatibility with Pre-Rel-8 nodes conforming to 3GPP TS 29.060 [6]. If the new functions are specified with the Extension Headers, bits 8 and 7 of the Extension Header Type shall be set to 0, 0 respectively or 0, 1 respectively. If the new functions are specified with Information Elements, such Information Elements shall be TLV-encoded and optional. + +# --- 5 GTP-U header + +## 5.1 General format + +The GTP-U header is a variable length header whose minimum length is 8 bytes. There are three flags that are used to signal the presence of additional optional fields: the PN flag, the S flag and the E flag. The PN flag is used to signal the presence of N-PDU Numbers. The S flag is used to signal the presence of the GTP Sequence Number field. The E flag is used to signal the presence of the Extension Header field, used to enable future extensions of the GTP header defined in this document, without the need to use another version number. If and only if one or more of these three flags are set, the fields Sequence Number, N-PDU and Extension Header shall be present. The sender shall set all the bits of the unused fields to zero. The receiver shall not evaluate the unused fields. For example, if only the E flag is set to 1, then the N-PDU Number and Sequence Number fields shall also be present, but will not have meaningful values and shall not be evaluated. + +### Always present fields: + +- **Version field:** This field is used to determine the version of the GTP-U protocol. The version number shall be set to '1'. +- **Protocol Type (PT):** This bit is used as a protocol discriminator between GTP (when PT is '1') and GTP' (when PT is '0'). GTP is described in this document and the GTP' protocol in 3GPP TS 32.295 [8]. Note that the interpretation of the header fields may be different in GTP' than in GTP. +- **Extension Header flag (E):** This flag indicates the presence of a meaningful value of the Next Extension Header field. When it is set to '0', the Next Extension Header field either is not present or, if present, shall not be interpreted. When it is set to '1', the Next Extension Header field is present, and shall be interpreted, as described below in this clause. +- **Sequence number flag (S):** This flag indicates the presence of a meaningful value of the Sequence Number field. When it is set to '0', the Sequence Number field either is not present or, if present, shall not be interpreted. When it is set to '1', the Sequence Number field is present, and shall be interpreted, as described below in this clause. For the Echo Request, Echo Response, Error Indication and Supported Extension Headers Notification messages, the S flag shall be set to '1'. Since the use of Sequence Numbers is optional for G-PDUs, the PGW, SGW, ePDG, eNodeB and TWAN should set the flag to '0'. However, when a G-PDU (T-PDU+header) is being relayed by the Indirect Data Forwarding for Inter RAT HO procedure, then if the received G-PDU has the S flag set to '1', then the relaying entity shall set S flag to '1' and forward the G-PDU (T-PDU+header). In an End marker message the S flag shall be set to '0'. +- **N-PDU Number flag (PN):** This flag indicates the presence of a meaningful value of the N-PDU Number field. When it is set to '0', the N-PDU Number field either is not present, or, if present, shall not be interpreted. When it is set to '1', the N-PDU Number field is present, and shall be interpreted, as described below in this clause. +- **Message Type:** This field indicates the type of GTP-U message. +- **Length:** This field indicates the length in octets of the payload, i.e. the rest of the packet following the mandatory part of the GTP header (that is the first 8 octets). The Sequence Number, the N-PDU Number or any Extension headers shall be considered to be part of the payload, i.e. included in the length count. +- **Tunnel Endpoint Identifier (TEID):** This field unambiguously identifies a tunnel endpoint in the receiving GTP-U protocol entity. The receiving end side of a GTP tunnel locally assigns the TEID value the transmitting side has to use. The TEID value shall be assigned in a non-predictable manner for PGW S5/S8/S2a/S2b + +interfaces (see 3GPP TS 33.250 [32]). The TEID shall be used by the receiving entity to find the PDP context, except for the following cases: + +- The Echo Request/Response and Supported Extension Headers notification messages, where the Tunnel Endpoint Identifier shall be set to all zeroes. +- The Error Indication message where the Tunnel Endpoint Identifier shall be set to all zeroes. +- When setting up a GTP-U tunnel, the GTP-U entity shall not assign the value 'all zeros' to its own TEID. However, for backward compatibility, if a GTP-U entity receives (via respective control plane message) a peer's TEID that is set to the value 'all zeros', the GTP-U entity shall accept this value as valid and send the subsequent G-PDU with the TEID field in the header set to the value 'all zeros'. + +### Optional fields: + +- Sequence Number: If Sequence Number field is used for G-PDUs (T-PDUs+headers), an increasing sequence number for T-PDUs is transmitted via GTP-U tunnels, when transmission order must be preserved. For Supported Extension Headers Notification and Error Indication messages, the Sequence Number shall be ignored by the receiver, even though the S flag is set to '1'. +- N-PDU Number: This field is used at the Inter SGSN Routeing Area Update procedure and some inter-system handover procedures (e.g. between 2G and 3G radio access networks). This field is used to co-ordinate the data transmission for acknowledged mode of communication between the MS and the SGSN. The exact meaning of this field depends upon the scenario. (For example, for GSM/GPRS to GSM/GPRS, the SNDPCP N-PDU number is present in this field). +- Next Extension Header Type: This field defines the type of Extension Header that follows this field in the GTP-PDU. + +| Octets | Bits | | | | | | | | | | +|--------|----------------------------------------------------------|---|----|---|-----|---|---|----|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | +| 1 | Version | | PT | | (*) | E | S | PN | | | +| 2 | Message Type | | | | | | | | | | +| 3 | Length (1 st Octet) | | | | | | | | | | +| 4 | Length (2 nd Octet) | | | | | | | | | | +| 5 | Tunnel Endpoint Identifier (1 st Octet) | | | | | | | | | | +| 6 | Tunnel Endpoint Identifier (2 nd Octet) | | | | | | | | | | +| 7 | Tunnel Endpoint Identifier (3 rd Octet) | | | | | | | | | | +| 8 | Tunnel Endpoint Identifier (4 th Octet) | | | | | | | | | | +| 9 | Sequence Number (1 st Octet) 1) 4) | | | | | | | | | | +| 10 | Sequence Number (2 nd Octet) 1) 4) | | | | | | | | | | +| 11 | N-PDU Number 2) 4) | | | | | | | | | | +| 12 | Next Extension Header Type 3) 4) | | | | | | | | | | + +NOTE 0: (\*) This bit is a spare bit. It shall be sent as '0'. The receiver shall not evaluate this bit. + +NOTE 1: 1) This field shall only be evaluated when indicated by the S flag set to 1. + +NOTE 2: 2) This field shall only be evaluated when indicated by the PN flag set to 1. + +NOTE 3: 3) This field shall only be evaluated when indicated by the E flag set to 1. + +NOTE 4: 4) This field shall be present if and only if any one or more of the S, PN and E flags are set. + +Figure 5.1-1: Outline of the GTP-U Header + +## 5.2 GTP-U Extension Header + +### 5.2.1 General format of the GTP-U Extension Header + +The format of GTP-U Extension Headers is depicted in figure 5.2.1-1. The Extension Header Length field specifies the length of the particular Extension header in 4 octets units. The Next Extension Header Type field specifies the type of + +any Extension Header that may follow a particular Extension Header. If no such Header follows, then the value of the Next Extension Header Type shall be 0. + +| | | | +|--------|-------|----------------------------| +| Octets | 1 | Extension Header Length | +| | 2 – m | Extension Header Content | +| | m+1 | Next Extension Header Type | + +**Figure 5.2.1-1: Outline of the Extension Header Format** + +The length of the Extension header shall be defined in a variable length of 4 octets, i.e. $m+1 = n*4$ octets, where n is a positive integer. + +Bits 7 and 8 of the Next Extension Header Type define how the recipient shall handle unknown Extension Types, see Figure 5.2.1-2. The recipient of an extension header of unknown type but marked as 'comprehension not required' for that recipient shall read the 'Next Extension Header Type' field (using the Extension Header Length field to identify its location in the GTP-PDU). + +The recipient of an extension header of unknown type, but marked as 'comprehension required' for that recipient, shall: + +- If the message with the unknown extension header was a request or a G-PDU, send a Supported Extension Headers Notification to the originator of the GTP-PDU, discard the message and log an error. + +Bits 7 and 8 of the Next Extension Header Type have the following meaning: + +| Bits | | Meaning | +|------|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 8 | 7 | | +| 0 | 0 | Comprehension of this extension header is not required. An Intermediate Node shall forward it to any Receiver Endpoint | +| 0 | 1 | Comprehension of this extension header is not required. An Intermediate Node shall discard the Extension Header Content and not forward it to any Receiver Endpoint. Other extension headers shall be treated independently of this extension header. | +| 1 | 0 | Comprehension of this extension header is required by the Endpoint Receiver but not by an Intermediate Node. An Intermediate Node shall forward the whole field to the Endpoint Receiver. | +| 1 | 1 | Comprehension of this header type is required by recipient (either Endpoint Receiver or Intermediate Node) | + +**Figure 5.2.1-2: Definition of bits 7 and 8 of the Extension Header Type** + +An Endpoint Receiver is the ultimate receiver of the GTP-PDU (e.g. an RNC or the GGSN for the GTP-U plane). An Intermediate Node is a node that handles GTP but is not the ultimate endpoint (e.g. an SGSN for the GTP-U plane traffic between GGSN and RNC). + +| Next Extension Header Field Value | Type of Extension Header | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------| +| 0000 0000 | No more extension headers | +| 0000 0001 | Reserved - Control Plane only. | +| 0000 0010 | Reserved - Control Plane only. | +| 0000 0011 | Long PDCP PDU Number. See NOTE 2. | +| 0010 0000 | Service Class Indicator | +| 0100 0000 | UDP Port. Provides the UDP Source Port of the triggering message. | +| 1000 0001 | RAN Container | +| 1000 0010 | Long PDCP PDU Number. See NOTE 3. | +| 1000 0011 | Xw RAN Container | +| 1000 0100 | NR RAN Container | +| 1000 0101 | PDU Session Container. See NOTE 4. | +| 1100 0000 | PDCP PDU Number [4]-[5]. See NOTE 1. | +| 1100 0001 | Reserved - Control Plane only. | +| 1100 0010 | Reserved - Control Plane only. | +| NOTE 1: As an exception to the comprehension rule specified above, for a G-PDU with a Next Extension Header Field set to the value "1100 0000", the SGW shall consider this corresponding extension header as 'comprehension not required'. | | +| NOTE 2: This value shall be used by a source eNB or gNB complying with this release of the specification. | | +| NOTE 3: This value shall not be used by a source eNB or gNB complying with this release of the specification. It may be received from a source eNB complying with an earlier release of the specification, i.e. not supporting the extension header value "0000 0011". | | +| NOTE 4: For a GTP-PDU with several Extension Headers, the PDU Session Container should be the first Extension Header. | | + +Figure 5.2.1-3: Definition of Extension Header Type + +### 5.2.2 Extension Header types + +Extension header types marked as "Reserved – Control Plane only" in figure 5.2.1-3 are not used in the GTP user plane. These extension header types are defined in 3GPP TS 29.060 [6]. + +The following clauses define the format of the extension header types applicable to the GTP user plane. + +#### 5.2.2.1 UDP Port + +This extension header may be transmitted in Error Indication messages to provide the UDP Source Port of the G-PDU that triggered the Error Indication. It is 4 octets long, and therefore the Length field has value 1. + +| Octets | Bits | | | | | | | | +|--------|-----------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 0x01 | | | | | | | | +| 2-3 | UDP Port number | | | | | | | | +| 4 | Next Extension Header Type (note) | | | | | | | | + +NOTE: The value of this field is 0 if no other Extension header follows. + +**Figure 5.2.2.1-1: UDP Port Extension Header** + +#### 5.2.2.2 PDCP PDU Number + +This extension header is transmitted, for example in UTRAN, at SRNS relocation time, to provide the PDCP sequence number of not yet acknowledged N-PDUs. It is 4 octets long, and therefore the Length field has value 1. + +When used during a handover procedure between two eNBs at the X2 interface (direct DL data forwarding) or via the S1 interface (indirect DL data forwarding) in E-UTRAN, bit 8 of octet 2 is spare and shall be set to zero. + +When used during a handover procedure between two NG-RANs at the Xn interface (direct DL data forwarding) or via the N3 interface (indirect DL data forwarding), bits 5-8 of octet 2 are spare and shall be set to zero. + +NOTE 1: The PDCP PDU number field of the PDCP PDU number extension header has a maximum value which requires 15 bits (see 3GPP TS 36.323 [24]); thus, bit 8 of octet 2 is spare. + +NOTE 2: The PDCP PDU number field of the PDCP PDU number extension header has a maximum value which requires 12 bits (see 3GPP TS 38.323 [35]); thus, bit 5-8 of octet 2 are spare. + +| Octets | Bits | | | | | | | | +|--------|-------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 0x01 | | | | | | | | +| 2 | PDCP PDU number | | | | | | | | +| 3 | PDCP PDU number. | | | | | | | | +| 4 | Next Extension Header Type (Note 3) | | | | | | | | + +NOTE 3: The value of this field is 0 if no other Extension header follows. + +**Figure 5.2.2.2-1: PDCP PDU Number Extension Header** + +#### 5.2.2.2A Long PDCP PDU Number + +This extension header is used for direct X2 or indirect S1 DL data forwarding during a Handover procedure between two eNBs. This extension header is also used for direct Xn or indirect N3 DL data forwarding during a Handover procedure between two NG-RANs. The Long PDCP PDU number extension header is 8 octets long, and therefore the Length field has value 2. + +The PDCP PDU number field of the Long PDCP PDU number extension header has a maximum value which requires 18 bits (see 3GPP TS 36.323 [24] and 3GPP TS 38.323 [35]). Bit 2 of octet 2 is the most significant bit and bit 1 of octet 4 is the least significant bit, see Figure 5.2.2.2A-1. Bits 8 to 3 of octet 2, and Bits 8 to 1 of octets 5 to 7 shall be set to 0. + +NOTE: A G-PDU which includes a PDCP PDU Number contains either the extension header PDCP PDU Number or Long PDCP PDU Number. + +| Octets | Bits | | | | | | | | | | +|--------|-------------------------------------|---|---|---|---|---|-----------------|---|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | +| 1 | 0x02 | | | | | | | | | | +| 2 | Spare | | | | | | PDCP PDU number | | | | +| 3 | PDCP PDU number | | | | | | | | | | +| 4 | PDCP PDU number | | | | | | | | | | +| 5 | Spare | | | | | | | | | | +| 6 | Spare | | | | | | | | | | +| 7 | Spare | | | | | | | | | | +| 8 | Next Extension Header Type (Note 1) | | | | | | | | | | + +NOTE 1: The value of this field is 0 if no other Extension header follows. + +**Figure 5.2.2.2A-1: Long PDCP PDU Number Extension Header** + +#### 5.2.2.3 Service Class Indicator + +This extension header identifies the service class indicator (SCI) associated with the T-PDU carried by the downlink G-PDU. This information may be used by the A/Gb mode GERAN access for improved radio utilisation (see clause 5.3.5.3 of 3GPP TS 23.060 [4]). + +In this version of the specification, this extension header may be transmitted over the Gn/Gp, S5/S8 and S4 interface. An eNodeB, RNC or MME shall ignore this information if received over the S1-U, S12, Iu, S11-U or any other interfaces not defined above, but still shall handle the G-PDU. + +NOTE1: This extension header is also sent over the S1-U, S12, Iu interface and S11-U if the SGW receives the Service Class Indicator from S5/S8 for a UE having a user plane connection with an RNC or an eNodeB. This can happen when the PGW does not have an accurate knowledge of the current RAT of the user e.g. after a handover from GERAN to (E)UTRAN. + +It is 4 octets long and therefore the Length field has the value 1. + +| Octets | Bits | | | | | | | | +|--------|-----------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 0x01 | | | | | | | | +| 2 | Service Class Indicator | | | | | | | | +| 3 | Spare | | | | | | | | +| 4 | Next Extension Header Type (note) | | | | | | | | + +NOTE: The value of this field is 0 if no other Extension header follows. + +**Figure 5.2.2.3-1: Service Class Indicator Extension Header** + +If the bit 8 of octet 2 is set to 0, this indicates an operator specific Service Class Indicator value is included. Otherwise, it shall indicate that a standardised SCI is included. + +NOTE 2: No standardized SCI value is defined in this release, it is intended to standardize SCIs in a future release. + +Bits 8 to 1 of the octet 2 represent the binary coded value of the SCI, applications with similar Radio Resource Management treatment in GERAN shall be represented by the same value. + +The octet 2 is coded as shown in Table 5.2.2.3-1. + +Bits 8 to 1 of the octet 3 are spare bits and shall be set to zero. + +Table 5.2.2.3-1: Service Class Indicator + +| | | +|----------------------------------------|------------------------| +| Service Class Indicator (SCI), octet 2 | | +| Bit | | +| 8 | | +| 0 | Operator-specific SCI | +| Bits | | +| 7 6 5 4 3 2 1 | | +| 0 0 0 0 0 0 0 | | +| to | | +| 0 0 0 1 1 1 1 | Operator-specific SCIs | +| 0 0 1 0 0 0 0 | | +| to | | +| 1 1 1 1 1 1 1 | Spare for future use | +| Bit | | +| 8 | | +| 1 | Standardised SCI | +| Bits | | +| 7 6 5 4 3 2 1 | | +| 0 0 0 0 0 0 0 | | +| to | | +| 1 1 1 1 1 1 1 | Spare for future use | + +#### 5.2.2.4 RAN Container + +This extension header may be transmitted in a G-PDU over the X2 user plane interface between the eNBs. The RAN Container has a variable length and its content is specified in 3GPP TS 36.425 [25]. A G-PDU message with this extension header may be sent without a T-PDU. + +![](73dff6b45b2b9ffd384bab3235f869af_img.jpg) + +| | | | | | | | | | +|-----------|-----------------------------------|---|---|---|---|---|---|---| +| | Bits | | | | | | | | +| Octets | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 0xn | | | | | | | | +| 2-(4n -1) | RAN Container | | | | | | | | +| 4n | Next Extension Header Type (NOTE) | | | | | | | | + +NOTE: The value of this field is '0' if no other Extension header follows. + +Figure 5.2.2.4-1: RAN Container Extension Header + +#### 5.2.2.5 Xw RAN Container + +This extension header may be transmitted in a G-PDU over the Xw user plane interface between the eNB and the WLAN Termination (WT). The Xw RAN Container has a variable length and its content is specified in 3GPP TS 36.465 [27]. A G-PDU message with this extension header may be sent without a T-PDU. + +| Octets | Bits | | | | | | | | +|-----------|-----------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 0xn | | | | | | | | +| 2-(4n -1) | Xw RAN Container | | | | | | | | +| 4n | Next Extension Header Type (NOTE) | | | | | | | | + +NOTE: The value of this field is '0' if no other Extension header follows. + +**Figure 5.2.2.5-1: Xw RAN Container Extension Header** + +#### 5.2.2.6 NR RAN Container + +This extension header may be transmitted in a G-PDU over the X2-U, Xn-U and F1-U user plane interfaces, within NG-RAN and, for EN-DC, within E-UTRAN. The NR RAN Container has a variable length and its content is specified in 3GPP TS 38.425 [30]. A G-PDU message with this extension header may be sent without a T-PDU. + +| Octets | Bits | | | | | | | | +|-----------|-----------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 0xn | | | | | | | | +| 2-(4n -1) | NR RAN Container | | | | | | | | +| 4n | Next Extension Header Type (NOTE) | | | | | | | | + +NOTE: The value of this field is '0' if no other Extension header follows. + +**Figure 5.2.2.6-1: NR RAN Container Extension Header** + +#### 5.2.2.7 PDU Session Container + +This extension header shall be transmitted in a G-PDU over the N3 and N9 user plane interfaces, between NG-RAN and UPF, or between two UPFs. It shall also be transmitted in End Marker packets over data forwarding tunnels in 5GS, for data forwarding between 5GS and EPS. The PDU Session Container has a variable length and its content is specified in 3GPP TS 38.415 [31]. + +| Octets | Bits | | | | | | | | +|-----------|-----------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 0xn | | | | | | | | +| 2-(4n -1) | PDU Session Container | | | | | | | | +| 4n | Next Extension Header Type (NOTE) | | | | | | | | + +NOTE: The value of this field is '0' if no other Extension header follows. + +**Figure 5.2.2.7-1: PDU Session Container Extension Header** + +# 6 GTP-U Message Formats + +## 6.1 General + +GTP-U defines a set of messages between the two ends of the user plane of the interfaces Iu, Gn, Gp, S1-U, S11-U, S2a, S2b, S4, S5, S8, S12, X2, M1, Sn, Xn, N3, N9 and N19. + +GTP-U messages are sent across a GTP user plane tunnel. A GTP-U message may be either a signalling message across the user plane tunnel, or a G-PDU message. + +- GTP-U signalling messages are used for user plane path management, or for user plane tunnel management. + +- G-PDU is a vanilla user plane message, which carries the original packet (T-PDU). In G-PDU message, GTP-U header is followed by a T-PDU. + +A T-PDU is an original packet, for example an IP datagram, Ethernet frame or unstructured PDU Data, from an UE, or from a network node in an external packet data network. + +The complete range of message types defined for GTPv1 is defined in 3GPP TS 29.060 [6]. The table below includes those applicable to GTP user plane. The three columns to the right define which of the three protocols sharing the common header of GTPv1 (GTP-C, GTP-U or GTP') might implement the specific message type. + +**Table 6.1-1: Messages in GTP-U** + +| Message Type value (Decimal) | Message | Reference | GTP-C | GTP-U | GTP' | +|------------------------------|-------------------------------------------------------|-----------|-------|-------|------| +| 1 | Echo Request | | X | X | x | +| 2 | Echo Response | | X | X | x | +| 3-25 | Reserved in 3GPP TS 32.295 [8] and 3GPP TS 29.060 [6] | | | | | +| 26 | Error Indication | | | X | | +| 27-30 | Reserved in 3GPP TS 29.060 [6] | | | | | +| 31 | Supported Extension Headers Notification | | X | X | | +| 32-253 | Reserved in 3GPP TS 29.060 [6] | | | | | +| 254 | End Marker | | | X | | +| 255 | G-PDU | | | X | | + +## 6.2 Presence requirements of Information Elements + +As specified in 3GPP TS 29.060 [6], clause 7.1.1. + +# 7 GTP-U Messages + +## 7.1 General + +GTP-U Tunnels are used to carry encapsulated T-PDUs and signalling messages between a given pair of GTP-U Tunnel Endpoints. The Tunnel Endpoint ID (TEID) which is present in the GTP header shall indicate which tunnel a particular T-PDU belongs to. In this manner, packets are multiplexed and de-multiplexed by GTP-U between a given pair of Tunnel Endpoints. The TEID value to be used in the TEID field shall be negotiated for instance during the GTP-C Create PDP Context and the RAB assignment procedures that take place on the control plane. + +For MBMS IP Multicast Distribution, the TEID value to be used in the TEID field shall be allocated at the source Tunnel Endpoint and signalled to the destination Tunnel Endpoint using for instance the GTP-C MBMS Session Start procedures that take place on the control plane. Because of the point-to-multipoint characteristics of MBMS IP Multicast Distribution, the path management messages Echo Request and Echo Response, the tunnel management message Error Indication, the message Supported Extension Headers Notification and the message End Marker shall not be used for MBMS IP Multicast Distribution. + +User payload is transmitted in G-PDU packets. A G-PDU is a packet including a GTP-U header and a T-PDU. A G-PDU may include extension headers. A G-PDU shall not include any information element. + +GTP-U signalling messages are classified into path management messages, defined in clause 7.2 of the present document, and tunnel management messages, defined in clause 7.3 of the present document. + +## 7.2 Path Management Messages + +### 7.2.1 Echo Request + +A GTP-U peer may send an Echo Request on a path to the other GTP-U peer to find out if it is alive (see clause Path Failure). Echo Request messages may be sent for each path in use. A path is considered to be in use if at least one PDP + +context, EPS Bearer, PDU Session, MBMS UE context, or MBMS bearer context uses the path to the other GTP-U peer. When and how often an Echo Request message may be sent is implementation specific but an Echo Request shall not be sent more often than every 60 s on each path. This doesn't prevent resending an Echo Request with the same sequence number according to the T3-RESPONSE timer. + +Even if there is no path in use, a GTP-U peer shall be prepared to receive an Echo Request at any time and it shall reply with an Echo Response. The optional Private Extension contains vendor or operator specific information. + +**Table 7.2.1-1: Information Elements in an Echo Request** + +| Information element | Presence requirement | Reference | +|---------------------|----------------------|-----------| +| Private Extension | Optional | 8.6 | + +For the GTP-U tunnel setup between two nodes for forwarding user traffic, e.g. between eNodeBs for direct forwarding over X2, Echo Request path maintenance message shall not be sent except if the forwarded data and the normal data are sent over the same path. + +### 7.2.2 Echo Response + +The message shall be sent as a response to a received Echo Request. + +The Restart Counter value in the Recovery information element shall not be used, i.e. it shall be set to zero by the sender and shall be ignored by the receiver. The Recovery information element is mandatory due to backwards compatibility reasons. + +The optional Private Extension contains vendor or operator specific information. + +**Table 7.2.2-1: Information Elements in an Echo Response** + +| Information element | Presence requirement | Reference | +|---------------------|----------------------|-----------| +| Recovery | Mandatory | 8.2 | +| Private Extension | Optional | 8.6 | + +### 7.2.3 Supported Extension Headers Notification + +This message indicates a list of supported Extension Headers that the GTP entity on the identified IP address can support. This message is sent only in case a GTP entity was required to interpret a mandatory Extension Header but the GTP entity was not yet upgraded to support that extension header. The GTP endpoint sending this message is marked as not enabled to support some extension headers (as derived from the supported extension header list). The peer GTP entity may retry to use all the extension headers with that node, in an attempt to verify it has been upgraded. Implementers should avoid repeated attempts to use unknown extension headers with an endpoint that has signalled its inability to interpret them. + +**Table 7.2.3-1: Information Elements in Supported Extension Headers Notification** + +| Information element | Presence requirement | Reference | +|----------------------------|----------------------|-----------| +| Extension Header Type List | Mandatory | 8.5 | + +## 7.3 Tunnel Management Messages + +### 7.3.1 Error Indication + +When a GTP-U node receives a G-PDU for which no EPS Bearer context, PDP context, PDU Session, MBMS Bearer context, or RAB exists, the GTP-U node shall discard the G-PDU. If the TEID of the incoming G-PDU is different from the value 'all zeros' the GTP-U node shall also return a GTP error indication to the originating node. GTP entities may include the "UDP Port" extension header (Type 0x40), in order to simplify the implementation of mechanisms that can mitigate the risk of Denial-of-Service attacks in some scenarios. + +Handling of the received Error Indication is specified in 3GPP TS 23.007 [3] and 3GPP TS 23.527 [33]. + +The information element Tunnel Endpoint Identifier Data I shall be the TEID fetched from the G-PDU that triggered this procedure. + +The information element GTP-U Peer Address shall be the destination address (e.g. destination IP address, MBMS Bearer Context) fetched from the original user data message that triggered this procedure. A GTP-U Peer Address can be a GGSN, SGSN, RNC, PGW, SGW, ePDG, eNodeB, TWAN, MME, gNB, N3IWF, or UPF address. The TEID and GTP-U peer Address together uniquely identify the related PDP context, RAB, PDU session or EPS bearer in the receiving node. + +The optional Private Extension contains vendor or operator specific information. + +**Table 7.3.1-1: Information Elements in an Error Indication** + +| Information element | Presence requirement | Reference | +|-----------------------------------|----------------------|-----------| +| Tunnel Endpoint Identifier Data I | Mandatory | 8.3 | +| GTP-U Peer Address | Mandatory | 8.4 | +| Private Extension | Optional | 8.6 | + +### 7.3.2 End Marker + +#### 7.3.2.1 General + +The End Marker message indicates the end of the payload stream on a given tunnel, i.e. a G-PDU that arrives after an End Marker message on this tunnel may be silently discarded. Table 7.3.2.1-1 specifies the information element included in the End Marker message. + +If an End Marker message is received with a TEID for which there is no context, then the receiver shall ignore this message. + +The optional Private Extension contains vendor or operator specific information. + +**Table 7.3.2.1-1: Information Elements in End Marker message** + +| Information element | Presence requirement | Reference | +|---------------------|----------------------|-----------| +| Private Extension | Optional | 8.6 | + +#### 7.3.2.2 End Marker in EPS + +The End Marker message(s) shall be sent after sending the last G-PDU that needs to be sent on a GTP-U tunnel as specified in 3GPP TS 23.401 [5] or after receiving an End Marker Indication as specified in clause 5.7.1 of 3GPP TS 23.402 [23]. + +The End Marker message(s) shall be sent for each GTP-U tunnel, except for the case of an E-UTRAN Initiated E-RAB modification procedure. During an E-UTRAN Initiated E-RAB modification procedure, the SGW shall send End marker message(s) to the eNodeB on the old S1-U tunnel for the tunnel(s) that are switched, i.e. if the S1 eNodeB F-TEID of the GTP-U tunnel provided by the MME in a Modify Bearer Request or Modify Access Bearer Request is not the same as the one previously stored in the SGW. Each GTP-U tunnel is identified with a respective TEID value in the GTP-U header. + +An MME may receive End Marker packets over an S11-U tunnel during the following procedures: + +- Inter-MME TAU procedure; +- Establishment of S1-U bearer during Data Transport in Control Plane CIoT EPS optimisation. + +The MME shall discard the End Marker packets. The MME may also initiate the release of the corresponding S11-U resources; however the release of the S11-U resources is implementation dependent. + +#### 7.3.2.3 End Marker in 5GS + +The End Marker message(s) shall also be sent after sending the last G-PDU that needs to be sent on a GTP-U tunnel or after receiving an End Marker Indication as specified in 3GPP TS 23.501 [28] and 3GPP TS 23.502 [29]. End marker packets sent over data forward tunnels in 5GS, for data forwarding between 5GS and EPS, shall be sent with the PDU Session Container extension header including the Qos Flow Identifier of one of the QoS flows mapped to the same E-RAB. + +For QoS Flows transferred to and from Secondary RAN Node in Dual Connectivity (see clause 4.14.1 of 3GPP TS 23.502 [29]), end marker packets shall be sent over old tunnel for the transferred QoS flows without the Qos Flow Identifier included as specified in 3GPP TS 37.340 [38]. + +End Marker messages shall not be sent over the N19 interface. + +# 8 Information Elements + +## 8.1 Information Element Types + +A GTP-U Signalling message may contain several information elements. The TLV (Type, Length, Value) or TV (Type, Value) encoding format shall be used for the GTP information elements. The information elements shall be sorted, with the Type fields in ascending order, in the signalling messages. The Length field contains the length of the information element excluding the Type and Length field. + +For all the length fields, bit 8 of the lowest numbered octet is the most significant bit and bit 1 of the highest numbered octet is the least significant bit. + +Within information elements, certain fields may be described as spare. These bits shall be transmitted with the value defined for them. To allow for future features, the receiver shall not evaluate these bits. + +The most significant bit in the Type field is set to 0 when the TV format is used and set to 1 for the TLV format. + +![Figure 8.1-1: Type field for TV and TLV format. The diagram shows two octet structures. The top structure is for TV format, where the first bit (Octet 8) is 0 and the remaining bits (Octets 7-1) are the Type field. The bottom structure is for TLV format, where the first bit (Octet 8) is 1 and the remaining bits (Octets 7-1) are the Type field.](1c140ee5d1a87186977da94a96bfa700_img.jpg) + +| | | Bits | | | | | | | | +|--------|--|------|-------------------|---|---|---|---|---|---| +| Octets | | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | | 0 | Type -> TV format | | | | | | | + + + +| | | Bits | | | | | | | | +|--------|--|------|--------------------|---|---|---|---|---|---| +| Octets | | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | | 1 | Type -> TLV format | | | | | | | + +Figure 8.1-1: Type field for TV and TLV format. The diagram shows two octet structures. The top structure is for TV format, where the first bit (Octet 8) is 0 and the remaining bits (Octets 7-1) are the Type field. The bottom structure is for TLV format, where the first bit (Octet 8) is 1 and the remaining bits (Octets 7-1) are the Type field. + +Figure 8.1-1: Type field for TV and TLV format + +The complete range of information element types defined for GTPv1 is defined in 3GPP TS 29.060 [6]. The table below includes those applicable to GTP user plane. + +Table 8.1-1: Information Elements + +| IE Type Value | Format | Information Element | Reference | +|---------------|--------|-----------------------------------|-----------| +| 0-13 | TV | Reserved in 3GPP TS 29.060 [6] | | +| 14 | TV | Recovery | 8.2 | +| 15 | TV | Reserved in 3GPP TS 29.060 [6] | | +| 16 | TV | Tunnel Endpoint Identifier Data I | 8.3 | +| 17-132 | TV/TLV | Reserved in 3GPP TS 29.060 [6] | | +| 133 | TLV | GSN Address. See NOTE 1. | 8.4 | +| 134-140 | TLV | Reserved in 3GPP TS 29.060 [6] | | +| 141 | TLV | Extension Header Type List | 8.5 | + +| IE Type Value | Format | Information Element | Reference | +|--------------------------------------------------------------------------------------|--------|--------------------------------|-----------| +| 0-13 | TV | Reserved in 3GPP TS 29.060 [6] | | +| 142-254 | TLV | Reserved in 3GPP TS 29.060 [6] | | +| 255 | TLV | Private Extension | 8.6 | +| NOTE 1: This IE is named as " GTP-U Peer Address" in the rest of this specification. | | | | + +## 8.2 Recovery + +The value of the restart counter shall be set to 0 by the sending entity and ignored by the receiving entity. This information element is used in GTP user plane due to backwards compatibility reasons. + +![](088921fa3f5a44c8551815122517eefd_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|---------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 14 (Decimal) | | | | | | | | +| 2 | Restart counter | | | | | | | | + +Figure 8.2-1: Restart Counter Information Element + +## 8.3 Tunnel Endpoint Identifier Data I + +The Tunnel Endpoint Identifier Data I information element contains the Tunnel Endpoint Identifier used by a GTP entity for the user plane. + +![](db5ab5d386827a5d5f5fad0f45612b90_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|-----------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 16 (Decimal) | | | | | | | | +| 2 - 5 | Tunnel Endpoint Identifier Data I | | | | | | | | + +Figure 8.3-1: Tunnel Endpoint Identifier Data I Information Element + +## 8.4 GTP-U Peer Address + +The GTP-U peer Address information element contains the address of a GTP. The Length field may have only two values (4 or 16) that determine if the Value field contains IPv4 or IPv6 address. + +The IPv4 address structure is defined in RFC 791 [10]. + +The IPv6 address structure is defined in RFC 4291 [11]. + +The encoded address might belong not only to a GSN, but also to an RNC, eNodeB, SGW, ePDG, gNB, N3IWF, UPF, PGW or TWAN. + +![](9c1d3678db4a12d5864cb2a4def1135d_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|----------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 133 (Decimal) | | | | | | | | +| 2-3 | Length | | | | | | | | +| 4-n | IPv4 or IPv6 Address | | | | | | | | + +Figure 8.4-1: GTP-U Peer Address Information Element + +## 8.5 Extension Header Type List + +This information element contains a list of 'n' Extension Header Types. The length field is set to the number of extension header types included. + +![](805c475f0859e607af0530ba43194bf1_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|----------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 141 (Decimal) | | | | | | | | +| 2 | Length (value= n) | | | | | | | | +| 3-n+2 | Extension types list | | | | | | | | + +Figure 8.5-1: Extension Header Type List Information Element + +## 8.6 Private Extension + +The Private Extension information element contains vendor specific information. The Extension Identifier is a value defined in the Private Enterprise number list in the most recent "Assigned Numbers" RFC (RFC 1700 or later). + +This is an optional information element that may be included in any GTP Signalling message. A signalling message may include more than one information element of the Private Extension type. + +![](49a49278cad196bdfe0db6b4dd1be7fd_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|----------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 255 (Decimal) | | | | | | | | +| 2-3 | Length | | | | | | | | +| 4-5 | Extension Identifier | | | | | | | | +| 6-m | Extension Value | | | | | | | | + +Figure 8.6-1: Private Extension Information Element + +# 9 Error Handling + +## 9.1 Protocol Errors + +As specified in 3GPP TS 29.060 [6], clauses 11.1. + +## 9.2 Path Failure + +Path failure handling procedures are specified in 3GPP TS 23.007 [17] and 3GPP TS 23.527 [33]. + +# --- 10 Security + +Network domain security is specified in 3GPP TS 33.102 [21] and 3GPP TS 33.401 [22]. + +# --- 11 Reliable Delivery of Signalling Messages + +Each path maintains a queue with signalling messages to be sent to the peer. The message at the front of the queue, if it is a request for which a response has been defined, shall be sent with a Sequence Number, and shall be held in a path list until a response is received. Each path has its own list. The Sequence Number shall be unique for each outstanding request message sourced from the same IP/UDP endpoint. + +The T3-RESPONSE timer shall be started when a signalling request message (for which a response has been defined) is sent. A signalling message request or response has probably been lost if a response has not been received before the T3-RESPONSE timer expires. At the expiry of the timer the request is retransmitted if the total number of request attempts is less than N3-REQUESTS times. + +All received request messages shall be responded to and all response messages associated with a certain request shall always include the same information. Duplicated response messages shall be discarded. A response message without a matching outstanding request should be considered as a duplicate. + +If a GTP protocol entity is not successful with the transfer of a signalling message, it shall inform the upper layer of the unsuccessful transfer so that the controlling upper entity may take the necessary measures. + +# --- 12 GTP Parameters + +## 12.1 General + +The GTP system parameters defined here and their recommended values shall not be fixed, but shall be possible to configure as described in clause 'Reliable delivery of messages'. + +## 12.2 Timers + +The timer T3-RESPONSE holds the maximum wait time for a response of a request message. + +## 12.3 Others + +The counter N3-REQUESTS holds the maximum number of attempts made by GTP to send a request message. The recommended value is 5. + +# --- 13 Tunnelling Scenarios + +## 13.1 General + +There are user packets sent between network nodes without a GTP-U reference point defined. The scenarios and applicability of GTP-U tunnelling are described in the following clauses. + +## 13.2 Tunnelling between SGWs + +GTP T-PDU tunnelling is applicable from the old SGW to the new S GW only when indirect forwarding is applicable during a S1-based Handover procedure or inter-RAT handover procedure with SGW Relocation, as described in the 3GPP TS 23.401 [5]. For the GTP-U tunnel setup between SGWs, path maintenance messages do not need to be sent. + +GTP T-PDU tunnelling is applicable from the old SGW to the forwarding SGW during a TAU/RAU with SGW change procedure when indirect data forwarding is used to forward DL data buffered in the old SGW to the UE via the forwarding SGW, as described in the clause 5.3.3.1A of 3GPP TS 23.401 [5]. + +## 13.3 Transfer of the user plane data between PDN GWs + +GTP shall not specify tunnelling between PDN GWs. Transfer of UE-to-UE traffic between PDN GWs shall use the SGi interface. + +## 13.4 Tunnelling between SGSNs + +T-PDUs, stored in the old SGSN and not yet sent to the MS, shall be tunnelled to the new SGSN as a part of the Inter SGSN Routeing Update procedure described in 3GPP TS 23.060 [4]. Some T-PDUs may still be on their way from the GGSN/PGW to the old SGSN because they have been sent before the tunnel change. These T-PDUs shall also be tunnelled to the new SGSN. + +For intersystem SRNS Relocation, the establishment of the GTP tunnel(s) for the forwarding of G-PDUs is as described in the 3GPP TS 23.121 [13] and in the 3GPP TS 23.060 [4] specifications. + +For PS Handover, the establishment of the GTP tunnel(s) for the forwarding of G-PDUs is as described in the 3GPP TS 43.129 [14]. + +The GTP T-PDU tunnelling between SGSNs is applicable also for RAU interaction with a Gn/Gp SGSN when forwarding DL data buffered in the old Gn/Gp SGSN to the UE, via the new SGSN (e.g. when direct tunnel is not established) as described in the 3GPP TS 23.060 [4]. + +## 13.5 Tunnelling between Source RNC and Target RNC + +For the 3G-3G SRNS Relocation, the establishment of the GTP tunnel for the forwarding of G-PDUs between source and target RNC, is as described in the 3GPP TS 23.121 [13] and in the 3GPP TS 23.060 [4] specifications. + +## 13.6 Transfer of the user plane data between GGSNs + +GTP shall not specify tunnelling between GGSNs. Transfer of MS-to-MS traffic between GGSNs shall use the Gi interface. + +## 13.7 Tunnelling between RNC and eNodeB + +GTP T-PDU tunnelling is applicable between RNC and eNodeB during an inter-RAT handover between E-UTRAN and UTRAN Iu mode procedure as described in the 3GPP TS 23.401 [5]. + +## 13.8 Tunnelling between SGSN and eNodeB + +GTP T-PDU tunnelling is applicable between SGSN and eNodeB during an inter-RAT handover between E-UTRAN and GERAN A/Gb mode/UTRAN Iu mode procedure as described in the 3GPP TS 23.401 [5]. + +GTP T-PDU tunnelling between SGSN and eNodeB is applicable also for a TAU interaction with a Gn/Gp SGSN when forwarding DL data buffered in the old Gn/Gp SGSN to the UE via the target eNodeB, if such forwarding is supported by the eNodeB as described in the clause 5.3.3.1A of 3GPP TS 23.401 [5]. + +## 13.9 Tunnelling between Source eNodeB and Target eNodeB + +GTP T-PDU tunnelling is applicable between eNodeBs during an X2-based handover and E-UTRAN initiated E-RAB modification procedure as described in the 3GPP TS 23.401 [5]. + +## 13.10 Tunnelling between SGSN and RNC + +GTP T-PDU tunnelling between SGSN and RNC is applicable also for a TAU interaction with a Gn/Gp SGSN when forwarding DL data buffered in the old Gn/Gp SGSN to the UE, via the new RNC (e.g. when direct tunnel is established), if such forwarding is supported by the RNC as described in the clause 5.3.3.1A of 3GPP TS 23.401 [5]. + +## 13.11 Tunnelling between SGSN and SGW + +GTP T-PDU tunnelling is applicable from the old Gn/Gp SGSN to the forwarding SGW during a TAU/RAU interaction with a Gn/Gp SGSN when indirect data forwarding is used to forward DL data buffered in the old Gn/Gp SGSN to the UE via the forwarding SGW, as described in the clause 5.3.3.1A of 3GPP TS 23.401 [5]. + +## 13.12 Tunnelling between SGW and eNodeB + +GTP T-PDU tunnelling between SGW and eNodeB is applicable also for a TAU with SGW change procedure when forwarding DL data buffered in the old SGW to the UE via the target eNodeB, if such forwarding is supported by the eNodeB as described in the clause 5.3.3.1A of 3GPP TS 23.401 [5]. + +## 13.13 Tunnelling between SGW and RNC + +GTP T-PDU tunnelling between SGW and RNC is applicable also for a RAU with SGW change procedure when forwarding DL data buffered in the old SGW to the UE via the new RNC when Direct Tunnel is used at the target side, if such forwarding is supported by the RNC as described in the clause 5.3.3.1A of 3GPP TS 23.401 [5]. + +## 13.14 Tunnelling between SGW and SGSN + +GTP T-PDU tunnelling between SGW and SGSN is applicable also for a RAU with SGW change procedure when forwarding DL data buffered in the old SGW to the UE via the new SGSN when Direct Tunnel is not used at the target side as described in the clause 5.3.3.1A of 3GPP TS 23.401 [5]. + +# Annex A (Normative): PDU session user plane protocol over N9 + +The PDU session user plane protocol shall be supported over the N9 interface as specified in 3GPP TS 38.415 [31]. + +# Annex B (informative): Change history + +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | New | +|---------|-------|-----------|------|-----|-----------------------------------------------------------------------|--------| +| 2008-12 | CT#42 | CP-080716 | | | V2.0.0 approved in CT#42 | 8.0.0 | +| 2009-03 | CT#43 | CP-090048 | 0001 | 1 | Correction on GTP-U path failure | 8.1.0 | +| | | | 0002 | | UDP Port Extension Header | | +| | | | 0003 | 1 | Correction to IP support | | +| | | | 0006 | | Handling of End Marker packet | | +| 2009-06 | CT#44 | CP-090481 | 0007 | 3 | GTP-U tunnelling over X2 | 8.2.0 | +| | | | 0008 | 2 | GTP-U updates for MBMS HSPA Evolution | | +| 2009-09 | CT#45 | CP-090539 | 0010 | 1 | Forwarding Tunnel Error Indication handling | 8.3.0 | +| | | | 0011 | 1 | Clarification on the usage of Echo Request | | +| | | | 0012 | 2 | Clarification to the Sequence Number usage in EPC | | +| | | | 0014 | 3 | Updating the Error Indication clause | | +| | | | 0016 | | Eliminating Editor's Notes | | +| | | | 0018 | 1 | Path Failure text correction | | +| | | | 0019 | 1 | Support of NDS/IP for LTE | | +| 2009-09 | CT#45 | CP-090559 | 0013 | 1 | MBMS for EPS support in GTPv1-U | 9.0.0 | +| 2009-12 | CT#46 | CP-090773 | 0023 | 2 | End Marker in S1 based handover and Inter RAT handover procedures | 9.1.0 | +| | | | 0025 | | GTP-U sequence number handling | | +| 2010-03 | CT#47 | CP-100023 | 0027 | 1 | Sequence Number corrections | 9.2.0 | +| 2010-06 | CT#48 | CP-100287 | 0028 | 1 | Message applicability of MBMS in GTP-U | 9.3.0 | +| 2010-12 | CT#50 | CP-100686 | 0031 | 1 | Addition of GTP-U interface over S2b | 10.0.0 | +| | | | 0033 | 2 | End Marker message | | +| | | | 0035 | 1 | Echo Request & Echo Response | | +| 2011-03 | CT#51 | CP-110258 | 0037 | 2 | TEID value 0 for GTP-U tunnel | 10.1.0 | +| | | | 0038 | 3 | GTP-U protocol missing information | | +| | | | 0039 | | Scope of GTPv1 | | +| 2011-06 | CT#52 | CP-110374 | 0040 | | eNB Error Indication Handling | 10.2.0 | +| | | | 0042 | 1 | Addition of the MBMS reference points | | +| 2011-09 | CT#53 | CP-110567 | 0044 | | User plane path failure handling | 10.3.0 | +| 2011-09 | CT#53 | CP-110580 | 0043 | | Default inner MTU size | 11.0.0 | +| | | CP-110577 | 0045 | 1 | Correction to references | | +| 2011-12 | CT#54 | CP-110810 | 0046 | 1 | Add the definition of C-TEID | 11.1.0 | +| | | | 0048 | 1 | Dynamic allocation of UDP source ports | | +| | | | 0049 | | Requirement for sending Error Indication | | +| 2012-03 | CT#55 | CP-120036 | 0050 | | Tunnelling between eNodeB and RNC | 11.2.0 | +| | | CP-120036 | 0053 | 1 | GTP-U header | | +| | | | 0052 | 1 | Addition of GTP based S2a | | +| 2012-06 | CT#56 | | 0054 | | Tunnelling Scenarios | 11.3.0 | +| 2012-09 | CT#57 | CP-120682 | 0059 | 6 | New extension header in GTP-U for SIRIG | 11.4.0 | +| 2012-12 | CT#58 | CP-120751 | 0060 | 2 | Length of PDCP PDU number | 11.5.0 | +| | | CP-120735 | 0061 | - | Removal of editor's note in extension header in GTP-U for SIRIG | | +| 2013-03 | CT#59 | CP-130021 | 0062 | - | Clarification on support of GTP-U over the S2a interface | 11.6.0 | +| 2014-09 | CT#65 | CP-140521 | 0064 | 2 | Introduction of Dual Connectivity Function | 12.0.0 | +| | | | 0065 | - | Correct the ambiguous GTP-U PDU | | +| 2014-12 | CT#66 | CP-140789 | 0067 | 1 | Definition of RAN Container for flow control during X2UP handover | 12.1.0 | +| | | CP-140972 | 0068 | 1 | End Marker used in PMIP-based S5/S8 case | | +| | | CP-140972 | 0069 | 2 | Correct the GSN Address IE name | | +| 2015-09 | CT#69 | CP-150454 | 0071 | 2 | Tunnelling scenarios for supporting High Latency communication | 13.0.0 | +| | | CP-150448 | 0072 | 3 | G-PDU extension header handling | | +| 2016-03 | CT#71 | CP-160033 | 0074 | 1 | S11-U tunneling for MO/MT data transport in control plane (SGi based) | 13.1.0 | +| | | CP-160033 | 0075 | 1 | End Marker handling by MME | | +| | | CP-160038 | 0076 | 1 | Comprehension requirement for PDCP PDU Number | | +| | | CP-160040 | 0077 | 2 | 18 bits PDCP PDU Number | | + +| | | | | | | | +|---------|--------|-----------|------|---|---------------------------------------------------------------------|--------| +| 2016-06 | CT#72 | CP-160228 | 0078 | 1 | Handling of End Marker packets over S11-U by MME | 13.2.0 | +| 2017-03 | CT#75 | CP-170032 | 0080 | 1 | Support for transport level packet marking over GTP-U interfaces | 14.0.0 | +| 2017-06 | CT#76 | CP-171019 | 0082 | - | Xw RAN Container for LTE-WLAN Aggregation (LWA) | 14.1.0 | +| 2017-09 | CT#77 | CP-172025 | 0083 | 1 | GTP-U Extension Header Handling | 15.0.0 | +| 2017-12 | CT#78 | CP-173034 | 0084 | 1 | Supports N3, N9 and Xn userplane interface | 15.1.0 | +| 2018-03 | CT#79 | CP-180026 | 0086 | 1 | New GTP-U extension header for 5GS | 15.2.0 | +| 2018-03 | CT#79 | CP-180026 | 0087 | 1 | Support End Marker in 5GS | 15.2.0 | +| 2018-03 | CT#79 | CP-180026 | 0089 | 1 | New GTP-U Extension Header for the PDU Session Container | 15.2.0 | +| 2018-03 | CT#79 | CP-180023 | 0088 | 1 | Unpredictability of GTP TEID for PGW GTP-U | 15.2.0 | +| 2018-06 | CT#80 | CP-181128 | 0092 | 1 | Change of Comprehension for 'Long PDCP PDU Number' extension header | 15.3.0 | +| 2018-06 | CT#80 | CP-181132 | 0093 | 2 | Fix the location of the PDU Session Container | 15.3.0 | +| 2018-06 | CT#80 | CP-181132 | 0095 | - | User Plane Protocol over N9 | 15.3.0 | +| 2018-09 | CT#81 | CP-182084 | 0096 | 1 | General 5G Corrections | 15.4.0 | +| 2018-09 | CT#81 | CP-182084 | 0097 | 2 | GTP-U Tunnel Endpoint Description | 15.4.0 | +| 2018-09 | CT#81 | CP-182084 | 0099 | 1 | DSCP Marking on IPv4 Outer Header based on 5QI/ARP | 15.4.0 | +| 2018-12 | CT#82 | CP-183092 | 0100 | 1 | T-PDU content | 15.5.0 | +| 2018-12 | CT#82 | CP-183092 | 0101 | - | Referencing F1-U in the Introduction clause | 15.5.0 | +| 2018-12 | CT#82 | CP-183092 | 0102 | - | Data forwarding between 5GS and EPS | 15.5.0 | +| 2018-12 | CT#82 | CP-183092 | 0103 | - | Receiving packets from multiple remote GTP-U endpoints | 15.5.0 | +| 2019-09 | CT#85 | CP-192116 | 0104 | 1 | Error Indication and Path Failure in 5GS | 15.6.0 | +| 2019-12 | CT#85 | CP-193024 | 0108 | 1 | PDCP PDU Number | 15.7.0 | +| 2019-12 | CT#85 | CP-193041 | 0109 | - | Implementing the conclusions of TR 29.892 for GTP-U | 16.0.0 | +| 2019-12 | CT#85 | CP-193050 | 0107 | - | N19 user plane interface for 5G VN group communication | 16.0.0 | +| 2020-09 | CT#89e | CP-202099 | 0110 | 1 | End marker in EPS and 5GS | 16.1.0 | +| 2021-03 | CT#91e | CP-210056 | 0114 | 1 | End Marker in NG-RAN initiated QoS Flow mobility | 16.2.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29292/2cf3896394a2342a2b46c504ab9a8830_img.jpg b/marked/Rel-16/29_series/29292/2cf3896394a2342a2b46c504ab9a8830_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..010fd8b09cdc1cc5ddba8370f56d76d91d95e92b --- /dev/null +++ b/marked/Rel-16/29_series/29292/2cf3896394a2342a2b46c504ab9a8830_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9a5945dceecdbd4478a25e5e6c1c5b66d87142d5acc65a218b3bdc33c80bd52e +size 26446 diff --git a/marked/Rel-16/29_series/29292/3337af75dfee8af7687b4f49914d6c93_img.jpg b/marked/Rel-16/29_series/29292/3337af75dfee8af7687b4f49914d6c93_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..590139c7e327d01fb1c0c3909647980b7dff7ec2 --- /dev/null +++ b/marked/Rel-16/29_series/29292/3337af75dfee8af7687b4f49914d6c93_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cd7baa183ed720d8168b1cccd30a952909e989aba02d9607340aea47f4eb6341 +size 27220 diff --git a/marked/Rel-16/29_series/29292/367378559e35017a5e1a6f5c30798c5a_img.jpg b/marked/Rel-16/29_series/29292/367378559e35017a5e1a6f5c30798c5a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..df2321de01f746b8fdbb08945817be2186865c42 --- /dev/null +++ b/marked/Rel-16/29_series/29292/367378559e35017a5e1a6f5c30798c5a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:57cdc816fd32f21d6aad7525eeabc145a72453a94f1f05f1b0897b2b92b908f5 +size 26330 diff --git a/marked/Rel-16/29_series/29292/39536a630fa74c3bcfd1670ee2152809_img.jpg b/marked/Rel-16/29_series/29292/39536a630fa74c3bcfd1670ee2152809_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3164873b3eeeb7ffba35c06df34786f10ee067a7 --- /dev/null +++ b/marked/Rel-16/29_series/29292/39536a630fa74c3bcfd1670ee2152809_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8649db13ca21149e632d97523d7e78b5e016203456aa3d4bf732985d609b1998 +size 25291 diff --git a/marked/Rel-16/29_series/29292/65d47e1d0e5982c00e9bd116b89e2b6a_img.jpg b/marked/Rel-16/29_series/29292/65d47e1d0e5982c00e9bd116b89e2b6a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ff4e7def23f329d5d9144b3c9727d81f058c18c9 --- /dev/null +++ b/marked/Rel-16/29_series/29292/65d47e1d0e5982c00e9bd116b89e2b6a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d9b6d2553ea9f66ce96fc332895d4fd8139c56b191ec7b99b92e0a4997f098e1 +size 23816 diff --git a/marked/Rel-16/29_series/29292/7ed5d5770331f31ade15439a21c31425_img.jpg b/marked/Rel-16/29_series/29292/7ed5d5770331f31ade15439a21c31425_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..03306c1d5a13e608983837124f3d3207faea2b14 --- /dev/null +++ b/marked/Rel-16/29_series/29292/7ed5d5770331f31ade15439a21c31425_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2f4a538a25464cb6567eae78ffe3165f68dd680c161c0272badc84816898a496 +size 27418 diff --git a/marked/Rel-16/29_series/29292/853f59c89931a666c07903b31d098277_img.jpg b/marked/Rel-16/29_series/29292/853f59c89931a666c07903b31d098277_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..875a176e2479bbf72e6960de02786ac50b26f68f --- /dev/null +++ b/marked/Rel-16/29_series/29292/853f59c89931a666c07903b31d098277_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:504d2554d941f1dec2d3ce4c3c223b3574931c304e9f2ce6a0ba1b01d6bf8717 +size 27738 diff --git a/marked/Rel-16/29_series/29292/90ddb84c323b956e2d50a54d3f870566_img.jpg b/marked/Rel-16/29_series/29292/90ddb84c323b956e2d50a54d3f870566_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c58527f9cd951831b08db8f56e2a6f5df3fbbead --- /dev/null +++ b/marked/Rel-16/29_series/29292/90ddb84c323b956e2d50a54d3f870566_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7aa6466545b0be973afe555c29248a25accbca97c72f32b265481ae1350c6feb +size 80427 diff --git a/marked/Rel-16/29_series/29292/raw.md b/marked/Rel-16/29_series/29292/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..d59818b9d14c99f7f9007d09d2a469c6324ed924 --- /dev/null +++ b/marked/Rel-16/29_series/29292/raw.md @@ -0,0 +1,2622 @@ + + + + + + +# Contents + +| | | +|------------------------------------------------------------------------------------|----| +| Foreword ..... | 7 | +| 1 Scope..... | 8 | +| 2 References..... | 8 | +| 3 Definitions and abbreviations ..... | 11 | +| 3.1 Definitions..... | 11 | +| 3.2 Abbreviations ..... | 11 | +| 4 Interworking overview ..... | 12 | +| 4.1 Interworking reference model ..... | 12 | +| 4.2 Interworking reference points and interfaces ..... | 12 | +| 4.3 Interworking functional entities ..... | 13 | +| 4.3.1 MSC Server enhanced for ICS ..... | 13 | +| 4.3.2 Circuit Switched Media Gateway Function (CS-MGW) ..... | 13 | +| 4.4 Control plane interworking ..... | 13 | +| 4.5 User plane interworking ..... | 13 | +| 5 Control plane procedures and interworking..... | 13 | +| 5.1 General ..... | 13 | +| 5.2 IMS registration procedures interworking ..... | 14 | +| 5.2.1 Initial registration ..... | 14 | +| 5.2.2 Reregistration ..... | 14 | +| 5.2.3 MSC Server initiated deregistration ..... | 14 | +| 5.3 Interworking of mobile originating call setup from NAS signalling to SIP ..... | 15 | +| 5.3.1 General ..... | 15 | +| 5.3.2 Receipt of a setup message..... | 15 | +| 5.3.3 Sending of INVITE ..... | 15 | +| 5.3.3.1 General..... | 15 | +| 5.3.3.2 Coding of INVITE ..... | 15 | +| 5.3.3.3 Coding of the SDP offer ..... | 17 | +| 5.3.3.4 Actions on the SDP answer ..... | 17 | +| 5.3.4 Sending of ALERTING..... | 17 | +| 5.3.4a Sending of PROGRESS ..... | 17 | +| 5.3.4b Through-Connecting early media from IMS..... | 18 | +| 5.3.5 Applying ringback tone ..... | 18 | +| 5.3.6 Receipt of 200 OK (INVITE)..... | 18 | +| 5.3.7 Receipt of status-codes 3xx ..... | 18 | +| 5.3.8 Receipt of SIP status-codes 4xx, 5xx or 6xx..... | 18 | +| 5.3.9 Receipt of DISCONNECT ..... | 23 | +| 5.3.10 Restoration procedures ..... | 23 | +| 5.3.11 Autonomous clearing initiated by the MSC Server..... | 24 | +| 5.4 Interworking of mobile terminating call setup from SIP to NAS signalling ..... | 24 | +| 5.4.1 General ..... | 24 | +| 5.4.2 Receipt of initial INVITE..... | 25 | +| 5.4.3 Sending of SETUP ..... | 25 | +| 5.4.4 Receipt of CALL CONFIRMED..... | 28 | +| 5.4.5 Bearer establishment ..... | 29 | +| 5.4.5.1 Network side bearer establishment..... | 29 | +| 5.4.5.2 Access bearer assignment..... | 29 | +| 5.4.5.3 Transcoding ..... | 29 | +| 5.4.6 Receipt of ALERTING..... | 29 | +| 5.4.7 Applying early media ..... | 29 | +| 5.4.8 Call rejection or abandonment..... | 30 | +| 5.4.8.1 Receipt of RELEASE COMPLETE or DISCONNECT..... | 30 | +| 5.4.8.2 Receipt of CANCEL or BYE..... | 33 | +| 5.4.9 Receipt of CONNECT ..... | 33 | +| 5.4.10 Call failure procedures ..... | 33 | +| 5.4.11 Autonomous clearing initiated by the MSC Server..... | 33 | + +| | | | +|-------------|-------------------------------------------------------------------------------|----| +| 5.5 | Interworking of established call clearing between NAS signalling and SIP..... | 34 | +| 5.5.1 | General ..... | 34 | +| 5.5.2 | Clearing initiated by the mobile ..... | 34 | +| 5.5.3 | Clearing initiated by the IM CN subsystem ..... | 34 | +| 5.5.4 | Autonomous clearing initiated by the MSC Server..... | 34 | +| 5.6 | Supplementary Services invocation ..... | 34 | +| 5.6.1 | Originating identification presentation/restriction (OIP/OIR) ..... | 34 | +| 5.6.2 | Terminating identification presentation/restriction (TIP/TIR)..... | 35 | +| 5.6.2.1 | Terminating identification presentation (TIP) ..... | 35 | +| 5.6.2.2 | Terminating identification restriction (TIR) ..... | 35 | +| 5.6.3 | Communication Hold (HOLD)..... | 36 | +| 5.6.3.1 | HOLD initiated via NAS signalling..... | 36 | +| 5.6.3.1.1 | Hold..... | 36 | +| 5.6.3.1.2 | Resume..... | 36 | +| 5.6.3.2 | HOLD initiated via SIP signalling..... | 36 | +| 5.6.3.2.1 | Hold..... | 36 | +| 5.6.3.2.2 | Resume..... | 37 | +| 5.6.4 | Communication Waiting (CW) ..... | 37 | +| 5.6.4.1 | Receipt of initial INVITE ..... | 37 | +| 5.6.4.2 | Accepting the waiting call ..... | 37 | +| 5.6.4.3 | Rejecting the waiting call ..... | 38 | +| 5.6.4.4 | Communication release during waiting condition..... | 38 | +| 5.6.4.5 | CW condition timeout..... | 38 | +| 5.6.4.6 | Notification to originator ..... | 39 | +| 5.6.5 | Communication Barring (CB)..... | 39 | +| 5.6.6 | Communication Diversion..... | 39 | +| 5.6.6.1 | General..... | 39 | +| 5.6.6.2 | CDIV invocation..... | 39 | +| 5.6.6.2.1 | Communication Forwarding Unconditional (CFU) ..... | 39 | +| 5.6.6.2.2 | Communication Forwarding Busy (CFB)..... | 39 | +| 5.6.6.2.3 | Communication Forwarding No Reply (CFNR)..... | 39 | +| 5.6.6.2.4 | Communication Forwarding on Not Logged-In (CFNL)..... | 40 | +| 5.6.6.2.5 | Communication Deflection (CD)..... | 40 | +| 5.6.6.2.6 | Communication Forwarding on Subscriber Not Reachable (CFNRc)..... | 40 | +| 5.6.6.3 | Notifications relating to CDIV ..... | 40 | +| 5.6.6.3.1 | Void..... | 40 | +| 5.6.6.3.2 | Notification to an originating user on CS access ..... | 40 | +| 5.6.6.3.3 | Notification to a terminating user on CS access ..... | 41 | +| 5.6.7 | Explicit Communication Transfer (ECT)..... | 42 | +| 5.6.7.1 | General..... | 42 | +| 5.6.7.2 | MSC Server as transferor on behalf of UE ..... | 42 | +| 5.6.7.3 | MSC Server as transferee on behalf of UE..... | 42 | +| 5.6.7.3.1 | Actions without 3PCC..... | 42 | +| 5.6.7.3.2 | Actions with 3PCC..... | 43 | +| 5.6.7.4 | MSC Server as transfer target on behalf of UE ..... | 43 | +| 5.6.8 | Conference (CONF) ..... | 43 | +| 5.6.8.1 | General..... | 43 | +| 5.6.8.2 | MSC Server as conference creator..... | 43 | +| 5.6.8.2.1 | Conference creation..... | 43 | +| 5.6.8.2.2 | Putting the conference on hold..... | 44 | +| 5.6.8.2.3 | Resuming a held conference ..... | 44 | +| 5.6.8.2.4 | Adding a party to the conference ..... | 44 | +| 5.6.8.2.5 | Terminating the conference or disconnecting a party from the conference..... | 44 | +| 5.6.8.2.6 | Receipt of a SplitMPTY message ..... | 45 | +| 5.6.8.2.7 | Remote party disconnects from the conference ..... | 45 | +| 5.6.8.3 | MSC Server as conference participant..... | 45 | +| 5.6.8.3.1 | Receipt of invitation to conference ..... | 45 | +| 5.6.8.3.1.1 | General ..... | 45 | +| 5.6.8.3.1.2 | Receipt of REFER within a dialog ..... | 45 | +| 5.6.8.3.1.3 | Receipt of REFER outside a dialog..... | 45 | +| 5.6.8.3.1.4 | Receipt of INVITE ..... | 46 | +| 5.6.8.3.2 | Notification of conference invocation..... | 46 | + +| | | | +|------------|---------------------------------------------------------------------|----| +| 5.6.9 | Customized Alerting Tones (CAT) ..... | 46 | +| 5.6.9.1 | General..... | 46 | +| 5.6.9.2 | Early session model ..... | 46 | +| 5.6.9.2.1 | Originating request..... | 46 | +| 5.6.9.3 | Forking model..... | 47 | +| 5.6.9.4 | Gateway model ..... | 47 | +| 5.6.10 | Communication Completion Services (CCBS/CCNL/CCNR) ..... | 47 | +| 5.6.10.1 | General..... | 47 | +| 5.6.10.2 | Communication Completion Terminated at Served User..... | 47 | +| 5.6.10.3 | Communication Completion Originated at Served User ..... | 47 | +| 5.6.10.3.1 | Actions without 3PCC..... | 47 | +| 5.6.10.3.2 | Actions with 3PCC..... | 47 | +| 5.7 | Supplementary Service Configuration ..... | 47 | +| 5.7.1 | General ..... | 47 | +| 5.7.2 | Receipt of REGISTER message..... | 48 | +| 5.7.3 | Receipt of HTTP response..... | 48 | +| 5.7.4 | Service data interworking..... | 48 | +| 5.7.4.1 | Originating identification presentation/restriction (OIP/OIR)..... | 48 | +| 5.7.4.1.1 | Registration/erasure..... | 48 | +| 5.7.4.1.2 | Activation/deactivation ..... | 48 | +| 5.7.4.1.3 | Interrogation ..... | 48 | +| 5.7.4.2 | Terminating identification presentation/restriction (TIP/TIR) ..... | 49 | +| 5.7.4.2.1 | Registration/erasure..... | 49 | +| 5.7.4.2.2 | Activation/deactivation ..... | 49 | +| 5.7.4.2.3 | Interrogation ..... | 49 | +| 5.7.4.3 | Communication Hold (HOLD)..... | 49 | +| 5.7.4.4 | Communication Waiting (CW)..... | 50 | +| 5.7.4.4.1 | Registration/erasure..... | 50 | +| 5.7.4.4.2 | Activation/deactivation ..... | 50 | +| 5.7.4.4.3 | Interrogation ..... | 50 | +| 5.7.4.5 | Communication Barring (CB) ..... | 50 | +| 5.7.4.5.1 | Registration/erasure..... | 50 | +| 5.7.4.5.2 | Activation/deactivation ..... | 51 | +| 5.7.4.5.3 | Interrogation ..... | 52 | +| 5.7.4.6 | Communication Diversion (CDIV) ..... | 52 | +| 5.7.4.6.1 | Registration ..... | 52 | +| 5.7.4.6.1a | Erasure..... | 53 | +| 5.7.4.6.2 | Activation/deactivation ..... | 54 | +| 5.7.4.6.3 | Interrogation..... | 54 | +| 5.7.4.7 | Explicit Communication Transfer (ECT) ..... | 55 | +| 5.7.4.8 | Conference (CONF)..... | 55 | +| 5.7.4.9 | Communication Completion Services (CCBS/CCNL/CCNR)..... | 55 | +| 5.7.4.9.1 | Activation/deactivation ..... | 55 | +| 5.7.4.9.2 | Interrogation ..... | 55 | +| 5.8 | Handover / Relocation..... | 56 | +| 5.8.1 | Intra-MSC Handover/Relocation..... | 56 | +| 5.8.2 | Inter-MSC Handover/Relocation..... | 56 | +| 6 | User plane interworking..... | 56 | +| 6.1 | General ..... | 56 | +| 6.2 | IuCS to Mb interworking ..... | 56 | +| 6.2.1 | Interworking with transcoding ..... | 56 | +| 6.2.2 | Transcoder-less interworking ..... | 57 | +| 6.3 | TDM-based A-interface to Mb interworking ..... | 58 | +| 6.3.1 | Interworking with transcoding ..... | 58 | +| 6.3.2 | Transcoder-less interworking ..... | 58 | +| 6.4 | IP-based A-interface to Mb interworking ..... | 59 | +| 6.4.1 | Interworking with transcoding ..... | 59 | +| 6.4.2 | Transcoder-less interworking ..... | 59 | +| 7 | MSC Server – CS-MGW interaction ..... | 60 | +| 7.1 | Mobile originated call ..... | 60 | + +| | | | +|------------------------|---------------------------------------------------------------|----| +| 7.1.1 | CS-MGW selection ..... | 60 | +| 7.1.2 | IMS session side establishment..... | 60 | +| 7.1.2.1 | General..... | 60 | +| 7.1.2.2 | Additions to Reserve RTP Connection Point Procedure ..... | 60 | +| 7.1.2.3 | Additions to Configure RTP Connection Point Procedure..... | 61 | +| 7.1.3 | Access bearer establishment..... | 62 | +| 7.1.3.1 | General..... | 62 | +| 7.1.3.2 | Iu interface on IP..... | 63 | +| 7.1.3.3 | A interface over IP ..... | 63 | +| 7.1.3.4 | A interface over TDM..... | 63 | +| 7.1.3.5 | Iu over UTRAN and GERAN..... | 63 | +| 7.1.4 | Apply ringing tone..... | 63 | +| 7.1.5 | Through connection..... | 63 | +| 7.1.5a | Handling of Forking ..... | 63 | +| 7.1.6 | Failure handling in MSC server ..... | 63 | +| 7.2 | Mobile terminated call ..... | 64 | +| 7.2.1 | CS-MGW selection ..... | 64 | +| 7.2.2 | Network side session establishment ..... | 64 | +| 7.2.2.1 | General..... | 64 | +| 7.2.2.2 | Additions to Reserve and Configure RTP Connection Point ..... | 64 | +| 7.2.3 | Access bearer assignment..... | 66 | +| 7.2.3.1 | General..... | 66 | +| 7.2.3.2 | Iu interface on IP..... | 66 | +| 7.2.3.3 | A interface over IP ..... | 66 | +| 7.2.3.4 | A interface over TDM..... | 66 | +| 7.2.3.5 | Iu over UTRAN and GERAN..... | 66 | +| 7.2.4 | Apply ringing tone..... | 66 | +| 7.2.5 | Through connection..... | 67 | +| 7.2.6 | Announcement..... | 67 | +| 7.2.7 | Failure handling in the MSC server..... | 67 | +| 7.2A | Notification Procedures..... | 67 | +| 7.2A.1 | General information..... | 67 | +| 7.2A.2 | ECN Failure Indication..... | 67 | +| 7.2A.3 | ICE Connectivity Check Result Notification ..... | 68 | +| 7.2A.4 | ICE New Peer Reflexive Candidate Notification..... | 68 | +| 7.3 | Call clearing ..... | 68 | +| 7.3.1 | Clearing received from the network ..... | 68 | +| 7.3.1.1 | Access bearer clearing ..... | 68 | +| 7.3.1.2 | Network side clearing ..... | 69 | +| 7.3.2 | Clearing received from the user..... | 69 | +| 7.3.2.1 | Access bearer clearing ..... | 69 | +| 7.3.2.2 | Network side clearing ..... | 69 | +| 7.3.3 | Call clearing received from the CS-MGW ..... | 69 | +| 7.3.3.1 | Bearer released received on the access side..... | 69 | +| 7.3.3.2 | Bearer released received on the network side..... | 69 | +| 7.4 | Call independent procedures ..... | 69 | +| 7.5 | Explicit Congestion Notification..... | 69 | +| 7.6 | Multimedia Priority Service (MPS) Support..... | 69 | +| 7.7 | Interactive Connectivity Establishment ..... | 70 | +| 7.8 | Codec Parameters Handling..... | 70 | +| 7.8.1 | Handling of common codec parameters ..... | 70 | +| 7.8.2 | EVS speech codec ..... | 70 | +| 7.9 | SDP Capability Negotiation (SDPCapNeg)..... | 70 | +| Annex A (informative): | Change history..... | 71 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 1 Scope + +IMS Centralized Services (ICS) enable the delivery of IM CN subsystem based multimedia telephony and supplementary services as defined in 3GPP TS 24.173 [4] to users regardless of the attached access network type; e.g. CS domain access or IP-CAN. + +The present document specifies the principles of interworking between the IM CN subsystem and CS domain in order to enable ICS for UEs using CS domain access. + +The present document addresses the area of registration procedures interworking between the CS domain and IM CN subsystem. + +The present document addresses the areas of control and user plane interworking between the IM CN subsystem and CS domain through an MSC Server enhanced for ICS and CS-MGW respectively. This includes the signalling procedures between the MSC Server and CS-MGW. For the specification of control plane interworking, present document defines the protocol interworking between the 3GPP profile of SIP as described in 3GPP TS 24.229 [2] and NAS signalling as described in 3GPP TS 24.008 [3] required for the support of IM CN subsystem based multimedia telephony and supplementary services. + +The present document addresses the area of supplementary service configuration interworking between the CS domain and IM CN subsystem. + +The present document is applicable to the MSC Server and CS-MGW. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 24.229: "IP Multimedia Call Control Protocol based on SIP and SDP". +- [3] 3GPP TS 24.008: "Mobile radio interface layer 3 specification; Core Network protocols; Stage 3". +- [4] 3GPP TS 24.173: "IMS multimedia telephony communication service and supplementary services; Stage 3". +- [5] 3GPP TS 23.292: "IP Multimedia Subsystem (IMS) Centralized Services; Stage 2". +- [6] 3GPP TS 23.002: "Network Architecture". +- [7] 3GPP TS 24.292: "IP Multimedia (IM) Core Network (CN) subsystem Centralized Services (ICS); Stage 3". +- [8] 3GPP TS 23.018: "Basic call handling; Technical realization". +- [9] 3GPP TS 22.003: "Circuit Teleservices supported by a Public Land Mobile Network (PLMN)". +- [10] 3GPP TS 23.003: "Numbering, addressing and identification". +- [11] 3GPP TS 29.232: "Media Gateway Controller (MGC) – Media Gateway (MGW) interface; Stage 3". +- [12] 3GPP TS 24.081: "Line Identification Supplementary Services – Stage 3". + +- [13] Void +- [14] 3GPP TS 24.608: "Terminating Identification Presentation (TIP) and Terminating Identification Restriction (TIR) using IP Multimedia (IM) Core Network (CN) subsystem; Protocol specification". +- [15] 3GPP TS 25.414: "UTRAN Iu interface data transport and transport signalling". +- [16] 3GPP TS 25.415: "UTRAN Iu interface user plane protocols". +- [17] 3GPP TS 25.411: "UTRAN Iu interface layer 1". +- [18] 3GPP TS 29.414: "Core network Nb data transport and transport signalling". +- [19] 3GPP TS 48.004: "Base Station System – Mobile-services Switching Centre (BSS – MSC) interface; Layer 1 specification". +- [20] 3GPP TS 29.002: "Mobile Application Part (MAP) specification". +- [21] Void. +- [22] 3GPP TS 26.226: "CTM Cellular Text telephony Modem, General description". +- [23] 3GPP TS 24.604: "Communication Diversion (CDIV) using IP Multimedia (IM) Core Network (CN) subsystem; Protocol specification". +- [24] 3GPP TS 24.082: "Call Forwarding (CF) supplementary services; Stage 3". +- [25] 3GPP TS 24.072: "Call Deflection (CD) Supplementary Service; Stage 3". +- [26] 3GPP TS 24.083: "Call Waiting (CS) and Call Hold (HOLD) supplementary services; Stage 3". +- [27] 3GPP TS 24.610: "Communication HOLD (HOLD) using IP Multimedia (IM) Core Network (CN) subsystem; Protocol specification". +- [28] 3GPP TS 26.114: "IP Multimedia Subsystem (IMS); Multimedia Telephony; Media handling and interaction". +- [29] 3GPP TS 24.080: "Mobile radio interface layer 3 supplementary services specification; Formats and coding". +- [30] 3GPP TS 24.088: "Call Barring (CB) Supplementary Service – Stage 3". +- [31] 3GPP TS 24.611: "Anonymous Communication Rejection (ACR) and Communication Barring (CB); using IP Multimedia (IM) Core Network (CN) subsystem; Protocol specification". +- [32] 3GPP TS 24.091: "Explicit Call Transfer (ECT) supplementary service; Stage 3". +- [33] 3GPP TS 24.629: "Explicit Communication Transfer (ECT) using IP Multimedia (IM) Core Network (CN) subsystem; Protocol specification". +- [34] 3GPP TS 24.084: "Multi Party (MPTY) supplementary service – Stage 3". +- [35] 3GPP TS 24.605: "Conference (CONF) using IP Multimedia (IM) Core Network (CN) subsystem; Protocol specification". +- [36] 3GPP TS 24.147: "Conferencing using the IP Multimedia (IM) Core Network (CN) subsystem; Stage 3". +- [37] 3GPP TS 23.009: "Handover procedures". +- [38] 3GPP TS 48.103: "Base Station System – Media GateWay (BSS-MGW) interface; User Plane transport mechanism". +- [39] 3GPP TS 23.205: "Bearer Independent switched core network; Stage 2". +- [40] 3GPP TS 23.231: "SIP-I based circuit-switched core network; Stage 2". + +- [41] 3GPP TS 24.010: "Mobile radio interface layer 3 Supplementary services specification; General aspects". +- [42] 3GPP TS 24.623: "Extensible Markup Language (XML) Configuration Access Protocol (XCAP) over the Ut interface for Manipulating Supplementary Services". +- [43] 3GPP TS 24.607: "Originating Identification Presentation (OIP) and Originating Identification Restriction (OIR) using IP Multimedia (IM) Core Network (CN) subsystem; Protocol specification". +- [44] 3GPP TS 24.615: "Communication Waiting (CW) using IP Multimedia (IM) Core Network (CN) subsystem; Protocol specification". +- [45] IETF RFC 3326: "The Reason Header Field for the Session Initiation Protocol (SIP)". +- [46] 3GPP TS 29.163: "Interworking between the IP Multimedia (IM) Core Network (CN) subsystem and Circuit Switched (CS) networks". +- [47] IETF RFC 5009: "Private Header (P-Header) Extension to the Session Initiation Protocol (SIP) for Authorization of Early Media". +- [48] IETF RFC 3168: "The Addition of Explicit Congestion Notification (ECN) to IP". +- [49] IETF RFC 6679: "Explicit Congestion Notification (ECN) for RTP over UDP". +- [50] IETF RFC 3959: "The Early Session Disposition Type for the Session Initiation Protocol (SIP)". +- [51] 3GPP TS 24.182: "IP Multimedia Subsystem (IMS) Customized Alerting Tones (CAT); Protocol specification". +- [52] 3GPP TS 24.642: "Completion of Communications to Busy Subscriber (CCBS) and Completion of Communications by No Reply (CCNR) using IP Multimedia (IM) Core Network (CN) subsystem". +- [53] 3GPP TS 24.093: "Completion of Calls to Busy Subscriber (CCBS); Stage 3". +- [54] 3GPP TS 22.153: "Multimedia Priority Service". +- [55] IETF RFC 4458: "Session Initiation Protocol (SIP) URIs for Applications such as Voicemail and Interactive Voice Response (IVR)". +- [56] 3GPP TS 32.260: "Telecommunication management; Charging management; IP Multimedia Subsystem (IMS) charging". +- [57] IETF RFC 3262: "Reliability of provisional responses in Session Initiation Protocol (SIP)". +- [58] IETF RFC 3312: "Integration of Resource Management and Session Initiation Protocol (SIP)". +- [59] IETF RFC 4032: "Update to the Session Initiation Protocol (SIP) Preconditions Framework". +- [60] IETF RFC 5245: "Interactive Connectivity Establishment (ICE): A Protocol for Network Address Translator (NAT) Traversal for Offer/Answer Protocols". +- [61] 3GPP TS 26.441: "Codec for Enhanced Voice Services (EVS); General Overview". +- [62] 3GPP TS 26.445: "Codec for Enhanced Voice Services (EVS); Detailed Algorithmic Description". +- [63] IETF RFC 5939: "Session Description Protocol (SDP) Capability Negotiation". +- [64] 3GPP TS 23.333: "Multimedia Resource Function Controller (MRFC) - Multimedia Resource Function Processor (MRFP) Mp interface: Procedures Descriptions". +- [65] IETF RFC 8197: "A SIP Response Code for Unwanted Calls". +- [66] IETF RFC 8224: "Authenticated Identity Management in the Session Initiation Protocol (SIP)". + +- [67] ITU-T Recommendation Q.850 (05/1998) including Amendment 1 (07/2001): "Usage of cause and location in the Digital Subscriber Signalling System No. 1 and the Signalling System No. 7 ISDN User Part". +- [68] IETF RFC 8606: "ISDN User Part (ISUP) Cause Location Parameter for the SIP Reason Header Field". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +**ICE lite:** The lite implementation of the Interactive Connectivity Establishment (ICE) specified in IETF RFC 5245 [60]. + +**Full ICE:** The full implementation of the Interactive Connectivity Establishment (ICE) specified in IETF RFC 5245 [60]. + +**NAS signalling:** layer 3 signalling carried over CS domain access between the UE and MSC Server as defined in 3GPP TS 24.008 [3]. + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 24.629 [33] apply: + +**transferee** + +**transferor** + +**transfer target** + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|-----------|----------------------------------------------------------------------------------------| +| 3PCC | 3 rd Party Call Control | +| ACR | Anonymous Communication Rejection | +| BAIC | Barring of All Incoming Calls | +| BAOC | Barring of All Outgoing Calls | +| BIC-Roam | Barring of Incoming Calls when Roaming outside the home PLMN country | +| BOIC | Barring of Outgoing International Calls | +| BOIC-exHC | Barring of Outgoing International Calls except those directed to the Home PLMN Country | +| CB | Communication Barring | +| CCBS | Completion of Communication to Busy Subscriber | +| CCNL | Completion of Communications on Not Logged-in | +| CCNR | Completion of Communications on No Reply | +| CD | Communication Deflection | +| CDIV | Communication DIVersion | +| CFNL | Communication Forwarding on Not Logged-in | +| CFNR | Communication Forwarding No Reply | +| CFNRc | Communication Forwarding on subscriber Not Reachable | +| CFU | Communication Forwarding Unconditional | +| CONF | CONFerence | +| CS | Circuit Switched | +| CS-MGW | Circuit Switched Media Gateway | +| ECN | Explicit Congestion Notification | +| ECT | Explicit Communication Transfer | +| EVS | Enhanced Voice Services | +| GRUU | Globally Routable User Agent URI | + +| | | +|-----------|------------------------------------------------| +| HOLD | communication HOLD | +| ICB | Incoming Communication Barring | +| ICE | Interactive Connectivity Establishment | +| ICS | IM CN subsystem Centralized Services | +| IMS-MGW | IP Multimedia Subsystem-Media Gateway Function | +| IuFP | Iu Framing Protocol | +| MboIP | Mb over IP | +| MRFP | Media Resource Function Processor | +| MPS | Multimedia Priority Service | +| NAS | Non Access Stratum | +| OCB | Outgoing Communication Barring | +| OIP | Originating Identification Presentation | +| OIR | Originating Identification Restriction | +| RTCP | RTP Control Protocol | +| SDPCapNeg | SDP Capability Negotiation | +| TDM | Time Division Multiplex | +| TIP | Terminating Identification Presentation | +| TIR | Terminating Identification Restriction | + +# 4 Interworking overview + +## 4.1 Interworking reference model + +Figure 4.1.1 details the reference model required to support interworking between the 3GPP IM CN subsystem and CS domain access for IM basic voice calls and supplementary services. + +![Figure 4.1.1: MSC Server – IM CN subsystem interworking reference model diagram. The diagram shows the interworking between a GERAN/UTRAN (CS domain) and the IM CN subsystem. The GERAN/UTRAN is connected to an MSC Server enhanced for ICS via an A/IuCS interface (dashed line for control plane, solid line for user plane). The MSC Server enhanced for ICS is connected to a CSCF via an I2 interface (dashed line). The MSC Server enhanced for ICS is also connected to a CSMGW via an Mc interface (dashed line). The CSMGW is connected to a (NOTE2) entity via an Mb interface (solid line). A legend indicates that dashed lines represent the control plane and solid lines represent the user plane.](853f59c89931a666c07903b31d098277_img.jpg) + +``` + +graph LR + GERAN[GERAN/UTRAN] -- "A/IuCS (Control plane)" --> MSC[MSC Server enhanced for ICS] + GERAN -- "A/IuCS (User plane)" --> CSMGW[CSMGW] + MSC -- "I2 (Control plane)" --> CSCF[CSCF] + MSC -- "Mc (Control plane)" --> CSMGW + CSMGW -- "Mb (User plane)" --> NOTE2[(NOTE2)] + +``` + +Figure 4.1.1: MSC Server – IM CN subsystem interworking reference model diagram. The diagram shows the interworking between a GERAN/UTRAN (CS domain) and the IM CN subsystem. The GERAN/UTRAN is connected to an MSC Server enhanced for ICS via an A/IuCS interface (dashed line for control plane, solid line for user plane). The MSC Server enhanced for ICS is connected to a CSCF via an I2 interface (dashed line). The MSC Server enhanced for ICS is also connected to a CSMGW via an Mc interface (dashed line). The CSMGW is connected to a (NOTE2) entity via an Mb interface (solid line). A legend indicates that dashed lines represent the control plane and solid lines represent the user plane. + +NOTE 1: The logical split of the signalling and bearer path between the CS access network and MSC Server enhanced for ICS is as shown; however, the signalling and bearer may be directly connected to the MGW. + +NOTE 2: The CS-MGW may be connected via the Mb reference point to various network entities, such as a UE (via a GTP tunnel to a GGSN), an MRFP, or an IMS-MGW, or a remote CS-MGW. + +**Figure 4.1.1: MSC Server – IM CN subsystem interworking reference model** + +## 4.2 Interworking reference points and interfaces + +The reference points and network interfaces shown in figure 4.1.1 are as described: + +**A reference point:** The A reference point is defined in 3GPP TS 23.002 [6]. + +**IuCS reference point:** The IuCS reference point is defined in 3GPP TS 23.002 [6]. + +**I2 reference point:** The call control protocol specified in this document for use on the I2 reference point (i.e. between MSC Server enhanced for ICS and CSCF) is based on Mw reference point as defined in 3GPP TS 23.002 [6] and the 3GPP profile of SIP as defined in accordance with 3GPP TS 24.229 [2]. + +**Mc reference point:** The Mc reference point is defined in 3GPP TS 23.002 [6]. + +**Mb reference point:** The Mb reference point is defined 3GPP TS 23.002 [6]. + +## 4.3 Interworking functional entities + +### 4.3.1 MSC Server enhanced for ICS + +This is the component which provides the interworking between CS domain access and IM CN subsystem control planes, and it shall support the functions as defined in accordance with 3GPP TS 23.002 [6]. + +For brevity, where the term "MSC Server" is used in the rest of the specification, this shall be understood as "MSC Server enhanced for ICS". + +### 4.3.2 Circuit Switched Media Gateway Function (CS-MGW) + +This is the component which provides the interworking between CS domain access and IM CN subsystem user planes, and it shall support the functions as defined in accordance with 3GPP TS 23.002 [6]. + +## 4.4 Control plane interworking + +Within the IM CN subsystem, the 3GPP profile of SIP defined in 3GPP TS 24.229 [2] is used for session control. + +Over CS domain access, NAS signalling is used for call origination, call termination and supplementary services. + +Therefore, in order to provide the required interworking to enable ICS for UE using CS domain access, the control plane protocols shall be interworked within the MSC Server. + +## 4.5 User plane interworking + +Within the IM CN subsystem, framing protocols such as RTP are used to transport media packets to and from IM CN subsystem entities such as the UE, MRFP or IMS-MGW. + +CS domain access uses circuit switched bearer channels like TDM circuits (e.g. 64kbps PCM), ATM/AAL2 circuits or IP bearers using the IuFP framing protocol or RTP to carry voice frames. + +Therefore, in order to provide the required interworking to enable ICS for a UE using CS domain access, the user plane protocols shall be interworked within the CS-MGW, under the control of the MSC Server. + +# --- 5 Control plane procedures and interworking + +## 5.1 General + +The following subclauses define the procedures and signalling interworking performed by the MSC Server to enable ICS for UEs attached to the CS domain. The interworking between NAS signalling and the Session Initiation Protocol (SIP) with its associated Session Description Protocol (SDP) is specified. + +The capabilities of SIP and SDP that are interworked with NAS signalling are defined in 3GPP TS 24.229 [2]. + +Table 5.1.1 lists the service interworking within the scope of the present document. + +**Table 5.1.1: Interworking between NAS signalling and SIP/SDP** + +| Telephony or Supplementary Service | +|----------------------------------------------------| +| TS11 non-emergency speech calls | +| Originating Identification Presentation (OIP) | +| Originating Identification Restriction (OIR) | +| Terminating Identification presentation (TIP) | +| Terminating Identification restriction (TIR) | +| Communication Hold and Resume | +| Communication Waiting | +| Communication Barring | +| Communication Diversion | +| Explicit Communication Transfer | +| Conferencing | +| Communication Completion to Busy Subscriber (CCBS) | +| Communication Completion on No Reply (CCNR) | +| Communication Completion on Not Logged-in (CCNL) | + +## 5.2 IMS registration procedures interworking + +### 5.2.1 Initial registration + +Upon successful completion of the location updating procedure as specified in 3GPP TS 24.008 [3], an MSC Server supporting the ICS Indicator parameter as specified in 3GPP TS 29.002 [20] shall determine whether to perform initial IMS registration on behalf of the UE. + +The relevant location update case, when an initial registration is needed to the IM CN subsystem is a location update to new MSC/VLR service area (the MSC/VLR was not the previous serving network element). + +In accordance with 3GPP TS 23.292 [5], clause 7.2.1.1, the MSC Server may perform an initial IMS registration. The optional flag referred to in clause 7.2.1.1 of 3GPP TS 23.292 [5] is implemented as the ICS Indicator parameter in 3GPP TS 29.002 [20]. + +When performing initial IMS registration, the MSC Server shall send a REGISTER request on behalf of the UE as described in 3GPP TS 24.292 [7]. + +### 5.2.2 Reregistration + +The MSC Server shall initiate reregistration for a previously registered Public User Identity as described in 3GPP TS 24.292 [7] if that subscriber is still registered in the MSC Server via CS domain access. + +### 5.2.3 MSC Server initiated deregistration + +The MSC Server shall send a REGISTER request for deregistration on behalf of the UE as described in 3GPP TS 24.292 [7] upon receipt of any indication that the subscriber is no longer registered in this MSC Server. + +Prior to sending a REGISTER request for deregistration, the MSC Server shall release all IMS dialogs related to the Public User Identity that is going to be deregistered or to one of the implicitly registered Public User Identities. + +## 5.3 Interworking of mobile originating call setup from NAS signalling to SIP + +### 5.3.1 General + +The mobile originating call shall be established in accordance with 3GPP TS 23.018 [8] and 3GPP TS 24.008 [3]. The IM CN subsystem originating session shall be established in accordance with 3GPP TS 24.292 [7] and 3GPP TS 24.229 [2]. The following subclauses describe the additional requirements for interworking between NAS signalling and SIP. + +The following subclauses also assume the originating call is received from a subscriber with an active IM CN subsystem registration via the MSC Server performing the interworking. + +### 5.3.2 Receipt of a setup message + +Upon receipt of a setup message (a SETUP message or an EMERGENCY SETUP message), the MSC Server shall determine whether the originating call shall be directed to the IM CN subsystem. + +The originating call shall be directed to the IM CN subsystem if all of the following conditions are met: + +- the setup message is a SETUP message and is determined by the MSC Server not to be an emergency call, and +- the bearer capability 1 information element indicates teleservice 11 as described in 3GPP TS 22.003 [9], and +- the CTM text telephony indication in the bearer capability 1 information element is set to "CTM text telephony is not supported", and +- the bearer capability 2 information element is not present. + +Otherwise the originating call shall be handled by the MSC Server without interworking to the IM CN subsystem. + +### 5.3.3 Sending of INVITE + +#### 5.3.3.1 General + +Upon determining that an incoming SETUP message shall be interworked to the IM CN subsystem, the MSC Server shall generate an INVITE request as further detailed in the subclauses below. + +#### 5.3.3.2 Coding of INVITE + +The INVITE request shall be coded as described in 3GPP TS 24.292 [7] with the following SETUP message interworking applied: + +- The called party BCD number information element in the SETUP message is used to derive the Request URI of the INVITE request as follows: + 1. if the type of number field is set to "international number", then the number digit fields, prefixed with a "+", shall be used to build a tel URI or a SIP URI with "user=phone"; or + 2. if the type of number field is set to "national number", according to local policy: + - a) if the called party BCD number is considered as if the mobile station sent a "geo-local number" then the MSC Server shall, as an operator option, either: + - convert the number to international format by prefixing the number digits with "+CC" (where CC is the country code of the network in which the MSC Server is located) and use this to build a tel URI or a SIP URI with "user=phone"; or + - use the number digit fields to build a tel URI or a SIP URI with "user=phone". The phone-context parameter shall include the home network domain name defined for IMS centralized services in 3GPP TS 23.003 [10]. The phone-context which includes the home network domain name of the calling party is prefixed by the "geo-local" string according to 3GPP TS 24.229 [2]. + +- b) if the called party BCD number is considered as if the mobile station sent a "home-local number", then the MSC Server shall, as an operator option, either: + - convert the number to international format by prefixing the number digits with "+CC" (where CC is the country code of the home network of the calling party) and use this to build a tel URI or a SIP URI with "user=phone"; or + - use the number digit fields to build a tel URI or a SIP URI with "user=phone". The phone-context parameter shall include the home network domain name defined for IMS centralized services in 3GPP TS 23.003 [10]. + +NOTE 1: When the calling party is not in roaming situation, the current physical location of the user is identical to the home network of the user; by default, the called party BCD number information element received in the SETUP message should be considered as a "geo-local number". + +- 3. if the type of number field is set to "unknown", then the MSC Server shall build a SIP URI with "user=phone" or a tel URI, including the received digits as an unprocessed dial string to the IM CN subsystem, using one of the formats for UEs without dial string processing capabilities, as defined in 3GPP TS 24.229 [2], clause 5.1.2A.1.3; + +NOTE 2: This sets the requirement that the dialling plan is designed so it enables the IM CN subsystem to differentiate local numbers from other numbers; refer to clause 5.1.2A.1.3. + +- if the CLIR invocation information element is present in the SETUP message, the From header shall be set to an Anonymous User Identity as defined in 3GPP TS 23.003 [10] and the MSC Server shall include a Privacy header with priv-value set to "id"; +- if the CLIR suppression information element is present in the SETUP message, the MSC Server shall include a Privacy header with priv-value set to "none"; +- if the CLIR invocation information element and CLIR suppression information element are not present in the SETUP message, the MSC Server shall not include a Privacy header; +- the P-Asserted-Identity header shall be set to the default public identity received during registration procedures; +- the Contact header shall be set to: + - the public GRUU received at registration as specified in 3GPP TS 24.229 [2]; or + - if the CLIR suppression information element is present in the SETUP message to the temporary GRUU received at registration as specified in 3GPP TS 24.229 [2]. + +When a SIP URI is used for the Request URI, the host portion of the SIP URI shall be set to the home network domain name defined for IMS centralized services in 3GPP TS 23.003 [10]. + +If the MSC server supports the P-Early-Media header as a network option, then it shall include the header in each outgoing SIP INVITE request. + +The MSC Server shall include a P-Charging-Vector header field in the initial INVITE request with an "icid-value" header field parameter as specified in 3GPP TS 32.260 [56]. + +Unless local configuration indicates that the network is serving users not supporting SIP preconditions, the MSC server shall include in a Supported header field of the initial INVITE request: + +- 1) a "100rel" option tag as defined in IETF RFC 3262 [57] to indicate the support for reliable provisional responses; and +- 2) a "precondition" option tag as defined in IETF RFC 3312 [58] to indicate the support for the SIP preconditions mechanism. + +#### 5.3.3.3 Coding of the SDP offer + +The MSC Server shall determine the speech codecs supported by the UE as specified in 3GPP TS 24.008 [3] and use this information when constructing a codec list for the SDP offer. The MSC Server may also add speech codecs. The added speech codecs are based on configuration data in the MSC Server. + +If the MSC Server indicated the support for the SIP preconditions mechanism as described in clause 5.3.3.2 and + +- the access bearer establishment has been initiated prior to the sending of the INVITE request (e.g. no speech codec or one speech codec is indicated from the originating UE) the MSC Server shall indicate that preconditions have been met in the initial SDP offer using the segmented status type, as defined in IETF RFC 3312 [58] and IETF RFC 4032 [59], as well as the strength-tag value "mandatory" for the local segment and the strength-tag value "optional" for the remote segment. The MSC Server may indicate in the bearer establishment procedure to the UE the speech codec the UE shall use; or +- the access side bearer establishment has not been performed prior to sending the INVITE request, + - a) the MSC Server shall indicate that preconditions have not been met in the SDP offer using the segmented status type, as defined in IETF RFC 3312 [58] and IETF RFC 4032 [59], as well as the strength-tag value "mandatory" for the local segment and the strength-tag value "optional" for the remote segment; and. + - b) once access side bearer establishment has been performed, the MSC Server shall indicate that preconditions have been met in a new SDP offer in a subsequent UPDATE or PRACK request. + +#### 5.3.3.4 Actions on the SDP answer + +At the receipt of the SDP answer the MSC Server shall analyse the received speech codecs: + +- If the received speech codecs in the SDP answer do not include any of the speech codecs provided by the UE in the SETUP message or the SDP answer only include the default speech codec the MSC Server shall instruct the CS-MGW to perform transcoding and indicate in the bearer establishment procedure to the UE the speech codec the UE shall use. Which of the codecs used is based on local policy; +- if only one speech codec is received in the SDP answer, the MSC Server shall select that speech codec and may indicate the speech codec in the bearer establishment procedure to the UE; +- if more than one speech codec is received in the SDP answer the MSC Server shall select one codec based on local configuration and may indicate the speech codec in the bearer establishment procedure to the UE; and send a new SDP offer which shall indicate the speech codec that the MSC Server has selected. + +For UTRAN and GERAN Iu-mode, the NAS Synchronisation Indicator information element shall be used to inform the UE of the selected codec as specified in 3GPP TS 24.008 [3]. + +### 5.3.4 Sending of ALERTING + +The MSC Server shall send an ALERTING message towards the UE upon receiving the first 180 Ringing response. + +### 5.3.4a Sending of PROGRESS + +Once all the following conditions have been met: + +- 1) the MSC server supports the P-Early-Media header field, and received the first SIP 181 (Call is being forwarded) response, or 182 (Queued) response, or 183 (Session Progress) response, or a SIP UPDATE request that includes a P-Early-Media header field authorizing backward early media; +- 2) SDP preconditions are not used, or applicable SDP preconditions have been met; +- 3) the MSC server did not receive a SIP 180 (Ringing) response; and +- 4) a PROGRESS message has not been sent before; + +then the MSC server shall send a PROGRESS message. + +### 5.3.4b Through-Connecting early media from IMS + +If a SIP 18x response or a SIP UPDATE request is received by the MSC server, once all the following conditions have been met: + +- 1) the MSC server supports the P-Early-Media header field, and the response or request includes a P-Early-Media header field authorizing backward early media; and + +- 2) SDP preconditions are not used, or applicable SDP preconditions have been met; + +then the MSC server shall instruct the CS-MGW to through-connect as described in clause 7.1.5 for early media from the IMS side unless the CS-MGW has already been through-connected. + +NOTE: An MSC server supporting the early session model CAT supplementary service applies additional procedure described in clause 5.6.9. + +### 5.3.5 Applying ringback tone + +The MSC Server shall instruct the CS-MGW to apply ringback tone towards the UE in the following conditions: + +- a 180 Ringing response is received and either: + - the MSC Server does not support the P-Early-Media header as a network option; or + - the MSC Server supports the P-Early-Media header as a network option and according to IETF RFC 5009 [47] backward early media is not authorized (the most recently received P-Early-Media header does not authorize backward early media or the P-Early-Media header has not yet been received). + +### 5.3.6 Receipt of 200 OK (INVITE) + +Upon receipt of the first 200 OK (INVITE) response, the MSC Server shall: + +- instruct the CS-MGW to stop ringback if ringback was previously applied; and +- instruct the CS-MGW to through-connect the bearer in both directions; and +- send a CONNECT message towards the UE as described in 3GPP TS 24.008 [3]. + +Interworking applied for the TIP service is described in clause 5.6.2.1. + +The MSC Server shall not progress any further early dialogs to established dialogs. Therefore, upon receipt of a subsequent 200 OK final response to the initial INVITE request (e.g. due to forking), the MSC Server shall: + +- acknowledge the response with an ACK request; and +- send a BYE request to this dialog in order to terminate it. + +### 5.3.7 Receipt of status-codes 3xx + +Upon receipt of a 3xx response to the initial INVITE, the default behaviour of the MSC Server shall be to release the call with a cause code value of 127 (Interworking unspecified). + +NOTE: The MSC Server may also decide to redirect the call toward the URI in the Contact header field of the 3xx response, as an operator option. Such handling is outside the scope of the present document. + +### 5.3.8 Receipt of SIP status-codes 4xx, 5xx or 6xx + +If the MSC Server receives a 4xx, 5xx or 6xx SIP response to the initial SIP INVITE request and the MSC Server has not sent a SIP CANCEL request, the MSC Server shall initiate call clearing procedures by sending a CC DISCONNECT message towards the UE as described in 3GPP TS 24.008 [3] with the following interworking applied: + +- 1) If one or more Reason header fields are included in the 4xx, 5xx or 6xx SIP response, then the cause value of each Reason header field shall be mapped to a cause information element in the CC DISCONNECT message as follows: + - a) if the Reason header field contains a Q.850 cause value, the numeric "cause" parameter value shall be mapped to the cause value octet of the cause information element in the CC DISCONNECT message according to table 5.3.8.2. The MSC Server shall set: + - the coding standard to "Standard defined for the GSM PLMNs"; and + - the location as follows: + +- I) to "network beyond interworking point"; or + - II) if, as a network option, the MSC Server supports the location header field parameter as described in IETF RFC 8606 [68], the MSC Server shall derive the value of the location from the location parameter in the SIP Reason header field according to table 5.3.8.3; +- b) if the Reason header field contains a SIP status-code, the coding of the cause information element in the CC DISCONNECT message shall be as follows: +- set the coding standard to "Standard defined for the GSM PLMNs"; + - set the location to "network beyond interworking point"; and + - derive the cause value from the SIP status-code received in the Reason header field according to table 5.3.8.1. The 4xx, 5xx, and 6xx SIP responses that are not covered in this table shall be interworked to a cause value of 127 (Interworking, unspecified); and +- c) if no Reason header field is included in the 4xx, 5xx or 6xx SIP response, the coding of the cause information element in the CC DISCONNECT message is derived from the SIP status-code of the SIP response according to table 5.3.8.1, where the following information elements shall be set to: +- coding standard to "Standard defined for the GSM PLMNs"; and + - location to "network beyond interworking point". + +**Table 5.3.8.1: Mapping the 4xx/5xx/6xx status-code to the cause information element** + +| SIP status-code | Cause value | +|-----------------------------------|-----------------------------------------------------| +| 400 Bad Request | 127 (Interworking, unspecified) | +| 401 Unauthorized | 127 (Interworking, unspecified) | +| 402 Payment Required | 127 (Interworking, unspecified) | +| 403 Forbidden | 79 (Service or option not implemented, unspecified) | +| 404 Not Found | 1 (Unassigned (unallocated) number) | +| 405 Method Not Allowed | 127 (Interworking, unspecified) | +| 406 Not Acceptable | 127 (Interworking, unspecified) | +| 407 Proxy authentication required | 127 (Interworking, unspecified) | +| 408 Request Timeout | 102 (Recovery on timer expiry) | +| 410 Gone | 22 (Number changed) | +| 413 Request Entity too long | 127 (Interworking, unspecified) | +| 414 Request-URI too long | 127 (Interworking, unspecified) | +| 415 Unsupported Media type | 127 (Interworking, unspecified) | +| 416 Unsupported URI scheme | 127 (Interworking, unspecified) | +| 417 Unknown Resource-Priority | 79 (Service or option not implemented, unspecified) | +| 420 Bad Extension | 127 (Interworking, unspecified) | +| 421 Extension required | 127 (Interworking, unspecified) | +| 422 Session Interval Too Small | 31 (Normal, unspecified) | +| 423 Interval Too Brief | 127 (Interworking, unspecified) | +| 424 Bad Location Information | 127 (Interworking, unspecified) | +| 428 Use Identity Header (NOTE 2) | 127 (Interworking, unspecified) | + +| SIP status-code | Cause value | +|-----------------------------------------------------------------------------------------|------------------------------------------------------| +| 433 Anonymity Disallowed | 24 (Call rejected due to feature at the destination) | +| 436 Bad Identity Info (NOTE 2) | 127 (Interworking, unspecified) | +| 437 Unsupported Credential (NOTE 2) | 127 (Interworking, unspecified) | +| 438 Invalid Identity Header (NOTE 2) | 127 (Interworking, unspecified) | +| 436 Bad Identity Info (NOTE 2) | 127 (Interworking, unspecified) | +| 480 Temporarily Unavailable | 41 (Temporary Failure) | +| 481 Call/Transaction does not exist | 127 (Interworking, unspecified) | +| 482 Loop detected | 127 (Interworking, unspecified) | +| 483 Too many hops | 127 (Interworking, unspecified) | +| 484 Address Incomplete | 28 (Invalid number format (incomplete number)) | +| 485 Ambiguous | 127 (Interworking, unspecified) | +| 486 Busy Here | 17 (User busy) | +| 487 Request terminated | 127 (Interworking, unspecified) | +| 488 Not acceptable here | 127 (Interworking, unspecified) | +| 493 Undecipherable | 127 (Interworking, unspecified) | +| 500 Server Internal error | 127 (Interworking, unspecified) | +| 501 Not implemented | 79 (Service or option not implemented, unspecified) | +| 502 Bad Gateway | 127 (Interworking, unspecified) | +| 503 Service Unavailable | 127 (Interworking, unspecified) | +| 504 Server timeout | 102 (Recovery on timer expiry) | +| 505 Version not supported | 127 (Interworking, unspecified) | +| 513 Message too large | 127 (Interworking, unspecified) | +| 580 Precondition failure | 127 (Interworking, unspecified) | +| 600 Busy Everywhere | 17 (User busy) | +| 603 Decline | 21 (Call rejected) | +| 604 Does not exist anywhere | 1 (Unassigned (unallocated) number) | +| 606 Not acceptable | 127 (Interworking, unspecified) | +| 607 Unwanted (NOTE) | 21 (Call rejected) | +| NOTE 1: The "607 Unwanted" SIP status code is defined in IETF RFC 8197 [65]. | | +| NOTE 2: The 428, 436, 437 and 438 SIP response codes are defined in IETF RFC 8224 [66]. | | + +If the MSC Server supports restoration procedures, the MSC Server shall in addition to the procedures in this clause perform the procedures in clause 5.3.10. + +**Table 5.3.8.2: Mapping of "cause" parameter for protocol "Q.850" to the cause information element** + +| Reason header field with protocol value "Q.850" | Cause information element | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------| +| "cause" parameter value | Cause value | +| 1 (Unallocated (unassigned) number) | 1 (Unallocated (unassigned) number) | +| 3 (No route to destination) | 3 (No route to destination) | +| 8 (Pre-emption) | 25 (Pre-emption) | +| 16 (Normal call clearing) | 16 (Normal call clearing) | +| 17 (User busy) | 17 (User busy) | +| 18 (No user responding) | 18 (No user responding) | +| 19 (No answer from user (user alerted)) | 19 (User alerting, no answer) | +| 21 (Call rejected) | 21 (Call rejected) | +| 22 (Number changed) | 22 (Number changed) | +| 24 (Call rejected due to feature at the destination) | 24 (Call rejected due to feature at the destination) | +| 26 (Non-selected user clearing) | 26 (Non selected user clearing) | +| 27 (Destination out of order) | 27 (Destination out of order) | +| 28 (Invalid number format (address incomplete)) | 28 (Invalid number format (incomplete number)) | +| 29 (Facility rejected) | 29 (Facility rejected) | +| 31 (Normal, unspecified)
(class default) (NOTE 1, NOTE 2) | 31 (Normal, unspecified) | +| 34 (No circuit/channel available) | 34 (No circuit/channel available) | +| 38 (Network out of order) | 38 (Network out of order) | +| 41 (Temporary failure) | 41 (Temporary failure) | +| 42 (Switching equipment congestion) | 42 (Switching equipment congestion) | +| 43 (Access information discarded) | 43 (Access information discarded) | +| 44 (Requested circuit/channel not available) | 44 (requested circuit/channel not available) | +| 47 (Resource unavailable, unspecified)
(class default) (NOTE 3) | 47 (Resource unavailable, unspecified) | +| 50 (Requested facility not subscribed) | 50 (Requested facility not subscribed) | +| 55 (Incoming calls barred within CUG) | 55 (Incoming calls barred within the CUG) | +| 57 (Bearer capability not authorised) | 57 (Bearer capability not authorised) | +| 58 (Bearer capability not presently available) | 58 (Bearer capability not presently available) | +| 63 (Service option not available, unspecified)
(class default) (NOTE 4) | 63 (Service option not available, unspecified) | +| 65 (Bearer capability not implemented) | 65 (Bearer capability not implemented) | +| 69 (Requested facility not implemented) | 69 (Requested facility not implemented) | +| 70 (Only restricted digital information capability is available) | 70 (Only restricted digital information capability is available) | +| 79 (Service or option not implemented, unspecified)
(class default) (NOTE 5) | 79 (Service or option not implemented, unspecified) | +| 87 (User not member of CUG) | 87 (User not member of CUG) | +| 88 (Incompatible destination) | 88 (Incompatible destination) | +| 91 (Invalid transit network selection) | 91 (Invalid transit network selection) | +| 95 (Invalid message, unspecified)
(class default) (NOTE 6) | 95 (Semantically incorrect message) | +| 97 (Message type non-existent or not implemented) | 97 (Message type non-existent or not implemented) | +| 98 (Message not compatible with call state or message type non-existent or not implemented) | 98 (Message type not compatible with protocol state) | +| 99 (Information element/parameter non-existent or not implemented) | 99 (Information element non-existent or not implemented) | +| 102 (Recovery on timer expiry) | 102 (Recovery on timer expiry) | +| 111 (Protocol error, unspecified)
(class default) (NOTE 7) | 111 (Protocol error, unspecified) | +| 127 (Interworking, unspecified)
(class default) (NOTE 8) | 127 (Interworking, unspecified) | +| NOTE 1: Class 0 and class 1 have the same default value. | | +| NOTE 2: All other values in the range 0 to 31 not appearing in table shall be treated as cause 31. | | +| NOTE 3: All other values in the range 32 to 47 not appearing in table shall be treated as cause 47. | | +| NOTE 4: All other values in the range 48 to 63 not appearing in table shall be treated as cause 63. | | +| NOTE 5: All other values in the range 64 to 79 not appearing in table shall be treated as cause 79. | | +| NOTE 6: All other values in the range 80 to 95 not appearing in table shall be treated as cause 95. | | +| NOTE 7: All other values in the range 96 to 111 not appearing in table shall be treated as cause 111. | | +| NOTE 8: All other values in the range 112 to 127 not appearing in table shall be treated as cause 127. | | +| NOTE 9: There are values which are specified in ITU-T Recommendation Q.850 [67] but not included in the present table. The reasons for not including them are: | | +|
  • - the corresponding value is not specified in 3GPP TS 24.008 [3]; or
  • - the value is specified in 3GPP TS 24.008 [3] but not applicable to be sent to the user (for example value 6 "Channel unacceptable").
| | + +**Table 5.3.8.3: Mapping of SIP Reason header field location parameter to location parameter of Cause information element** + +| Reason header field with protocol value "Q.850" | Cause information element | +|--------------------------------------------------------|-----------------------------------------| +| "location" parameter value | "Location" parameter value | +| U | user | +| LPN | private network serving the local user | +| LN | public network serving the local user | +| TN | transit network | +| RLN | public network serving the remote user | +| RPN | private network serving the remote user | +| LOC-6 | network beyond interworking point | +| INTL | international network | +| LOC-8 | network beyond interworking point | +| LOC-9 | network beyond interworking point | +| BI | network beyond interworking point | +| LOC-11 | network beyond interworking point | +| LOC-12 | network beyond interworking point | +| LOC-13 | network beyond interworking point | +| LOC-14 | network beyond interworking point | +| LOC-15 | network beyond interworking point | + +### 5.3.9 Receipt of DISCONNECT + +If the MSC Server receives a DISCONNECT message from the UE prior to receiving a final response to the initial INVITE, the MSC Server shall send a CANCEL request. If a 200 OK response to the initial INVITE is received after sending the CANCEL request, the MSC Server shall send a BYE request to the IM CN subsystem to terminate the session. + +If the DISCONNECT message contains one or more cause information elements, the first cause information element shall be mapped to a Reason header field in the CANCEL or BYE request as follows: + +- set the protocol field to "Q.850"; and +- set the numeric "cause" parameter value to the cause value field of the cause information element according to table 5.4.8.1.2. + +NOTE: The inclusion of reason-text in the Reason header is implementation specific. + +If, as a network option, the MSC Server supports the location header field parameter as described in IETF RFC 8606 [68], the MSC Server shall map the location parameter of the cause information element to the location parameter in the SIP Reason header field according to table 5.4.8.1.3. + +### 5.3.10 Restoration procedures + +If the MSC Server receives a SIP 504 (Server Time-out) response and all the following conditions are fulfilled: + +- 1) there is no re-registration ongoing; +- 2) a P-Asserted-Identity header field set to a value equal to an URI: + - from the Service-Route header field value received during registration; or + - from the Path header field value received during registration; and +- 3) the SIP response contains a Content-Type header field set to "application/3gpp-ims+xml" as defined in 3GPP TS 24.229 [2] clause 7.6; and +- 4) the SIP response includes an IM CN subsystem XML body as specified in 3GPP TS 24.229 [2] clause 7.6 with the element, including a version attribute, with the child element: + - with the child element set to "restoration" (see 3GPP TS 24.229 [2] table 7.6.2); and + +- with the child element set to "initial-registration" (see 3GPP TS 24.229 [2] table 7.6.3); + +then the MSC Server shall initiate restoration procedures by performing an initial registration as specified in clause 5.2.1. + +If the MSC Server is unsuccessful to send an initial SIP INVITE request to the next hop determined by one of the following: + +- there is no response to the SIP INVITE request by the MSC Server; or +- by unspecified means available to the MSC Server; + +and if there is no re-registration ongoing then the MSC Server may initiate restoration procedures by performing an initial registration as specified in clause 5.2.1. + +NOTE: If there is an ongoing re-registration and the conditions in this clause for initiating an initial registration were fulfilled the MSC Server regards this user as not registered and waits until a successful registration before sending any more INVITE request for this user. Meanwhile the MSC Server can fall back to the procedures for non ICS UE attached to a legacy MSC for call establishment as described in 3GPP TS 23.292 [5]. + +### 5.3.11 Autonomous clearing initiated by the MSC Server + +If the MSC Server determines due to internal procedures that the call shall be released, call release shall be in accordance with 3GPP TS 24.008 [3] clause 5.4.4 with the additional interworking defined here. + +The MSC Server shall send a SIP-CANCEL request as specified in 3GPP TS 24.229 [2] to the IM CN subsystem. The MSC Server shall include a Reason header field in the request populated as follows: + +- the protocol field set to "Q.850"; and +- a "cause" header field parameter aligned with the value used in the cause information element of the call clearing message towards the UE. + +NOTE: The inclusion of reason-text in the Reason header is implementation specific. + +## 5.4 Interworking of mobile terminating call setup from SIP to NAS signalling + +### 5.4.1 General + +The IM CN subsystem terminating session shall be established in accordance with 3GPP TS 24.292 [7] and 3GPP TS 24.229 [2]. The mobile terminating call shall be established at the visited MSC Server in accordance with 3GPP TS 23.018 [8] and 3GPP TS 24.008 [3]. The following subclauses describe the additional requirements for interworking between SIP and NAS signalling. + +### 5.4.2 Receipt of initial INVITE + +Upon receipt of an initial INVITE request, the MSC Server shall validate the INVITE request and SDP offer, if present, as described in 3GPP TS 24.292 [7]. + +After validating the INVITE request, the terminating party shall be validated as follows: + +- a) the MSC Server shall identify the terminating subscriber using the P-Called-Party-ID header or Request-URI from the INVITE request and use this to retrieve the VLR data; +- b) if the VLR data cannot be retrieved, the MSC Server shall send a 500 (Server Internal Error) response to the INVITE request and shall include the Reason header field with the protocol header field parameter set to "Q.850" and the cause header field parameter set to "20"; + +NOTE 1: The inclusion of the text header field parameter set to "Subscriber absent" in the Reason header field is implementation specific. + +- c) if the VLR data can be retrieved, the following check shall be performed: + +- if the IMSI is detached, the MSC Server shall send a 480 (Temporarily unavailable) response to the INVITE request. + +Upon successful validation of the terminating party, the MSC Server shall initiate the establishment of a MM connection as specified in 3GPP TS 24.008 [3]. If a MM connection cannot be established (e.g. no PAGE RESPONSE message is received), the MSC Server shall send a 408 (Request Timeout) response to the INVITE request. + +If the initial INVITE request includes a MIME body (part) according to clause 4.4.1 of 3GPP TS 24.615 [44] with the "communication-waiting-indication" element contained in the "ims-cw" root element according to 3GPP TS 24.615 [44], and if the MSC Server determines that the incoming call can be presented to the subscriber as described in 3GPP TS 24.083 [26], then clause 5.6.4.1 applies. + +NOTE 2: Clause 5.6.8.3.1.4 contains additional applicable procedures executed upon receipt of an initial INVITE request if the MSC Server is as conference participant. + +The MSC Server shall store the "icid-value" header field parameter received in the P-Charging-Vector header field. + +If the received INVITE request: + +- a) does not contain a "precondition" option-tag in a Supported header field or in a Require header field, the MSC Server shall not make use of the SIP precondition mechanism; or +- b) contains the "precondition" option-tag in the Supported header field or in the Require header field and local configuration indicates support of the SIP precondition mechanism, the MSC Server shall make use of the SIP precondition mechanism and shall include the Require header field with the "precondition" option-tag in any corresponding response containing the SDP body, which the MSC Server sends towards the originating end point. When the MSC Server sends a 183 (Session Progress) response with an SDP answer, the MSC Server shall only request confirmation for the result of the resource reservation (as defined in as defined in IETF RFC 3312 [59]) at the originating end point if an SDP offer has been received indicating that there are any remaining unfulfilled preconditions at the originating end point. + +If the MSC Server rejects the received INVITE request, then depending on operator policy, the MSC Server may insert in a SIP failure response a Response-Source header field with an "fe" header field parameter constructed with the URN namespace "urn:3gpp:fe", the "fe-id" part of the URN set to "msc-server" and the "role" header field parameter set to "msc-server-ics" in accordance with subclause 7.2.17 of 3GPP TS 24.229 [2]. + +### 5.4.3 Sending of SETUP + +After successful MM connection establishment, the MSC Server shall send a SETUP message as described in 3GPP TS 24.008 [3] with the following INVITE request interworking applied: + +- the MSC Server may include a bearer capability 1 information element set to indicate teleservice 11 as described in 3GPP TS 22.003 [9]; +- the MSC Server shall not include a bearer capability 2 information element; and +- the MSC Server shall build the calling party number BCD information element according to the tables 5.4.3.1 or 5.4.3.2 below. + +![Flowchart mapping INVITE message to SETUP message based on Privacy and P-Asserted-Identity headers.](90ddb84c323b956e2d50a54d3f870566_img.jpg) + +``` + +graph TD + A[INVITE received] --> B{Privacy header "id" or "header" present?} + B -- Yes --> C["digits = empty +Type of number = unknown +presentation restricted +Network provided"] + B -- No --> D{Is P-Asserted-Id present and Id=E.164?} + D -- No --> E[Network option] + D -- Yes --> F[Network option] + F -- "#1 (From)" --> G{Is From = E.164? and Privacy ? user} + F -- "#2 (PAI)" --> H["digits = P-Asserted-Id +Type of number = national or international +presentation allowed +Network provided"] + G -- No --> I["digits = empty +Type of number = unknown +presentation allowed +Network provided"] + G -- Yes --> J["digits = From +Type of number = national or international +presentation allowed +User-provided, not screened"] + E -- "#1 (From)" --> K{Is From = E.164? and Privacy ? user} + E -- "#2 (PAI)" --> L["digits = empty +Type of number = unknown +presentation allowed +Network provided"] + K -- No --> L + K -- Yes --> J + +``` + +The flowchart illustrates the mapping of an INVITE message to a SETUP message. It starts with 'INVITE received' and checks for the presence of 'Privacy header "id" or "header"'. If present, the mapping results in 'digits = empty', 'Type of number = unknown', 'presentation restricted', and 'Network provided'. If not present, it checks if 'P-Asserted-Id' is present and in E.164 format. If not, it uses a 'Network option' and checks the 'From' header. If the 'From' header is E.164 and not 'user', it results in 'digits = From', 'Type of number = national or international', 'presentation allowed', and 'User-provided, not screened'. Otherwise, it results in 'digits = empty', 'Type of number = unknown', 'presentation allowed', and 'Network provided'. If 'P-Asserted-Id' is present and in E.164 format, it uses a 'Network option' and checks the 'PAI' header, resulting in 'digits = P-Asserted-Id', 'Type of number = national or international', 'presentation allowed', and 'Network provided'. + +Flowchart mapping INVITE message to SETUP message based on Privacy and P-Asserted-Identity headers. + +**Figure 5.4.3.1: Mapping of INVITE message (with From and/or P-Asserted-Identity) to SETUP message (informative)** + +The default mapping is based on table 5.4.3.1. + +As a network option, the mapping described in table 5.4.3.2 can be applied to create the calling party number BCD information element in the SETUP message based on the From header field in the following cases: + +- when the received P-Asserted-Identity header field and the From header field contain URIs with an E.164 number format and the Privacy header field does not contain values "id", "header" or "user"; or +- when the P-Asserted-Identity header field is absent or not in the E.164 number format and the received From header field contains the URI with an E.164 number format and the Privacy header field does not contain values "id", "header" or "user". + +**Table 5.4.3.1: Setting of the calling party BCD number information element in SETUP message from P-Asserted-Identity** + +| SIP Component | Value | Calling party BCD number information element | Value | +|-------------------------------------------------------------------------------------|------------------------------------------------------------------------------|----------------------------------------------|---------------------------------------------------------------------------| +| P-Asserted-Identity header field (NOTE 1, NOTE 2) and Privacy header field | E.164 number

and
Priv-value≠ "id" or "header" | Digits | digits contained in tel URI or SIP URI | +| | | Type of number | "national number" or "international number" | +| | | Numbering Plan Identification | "ISDN/telephony numbering plan" | +| | | Presentation Indicator | "presentation allowed" | +| | | Screening indicator | "Network provided" (NOTE 5) | +| P-Asserted-Identity header field present or not and Privacy header field is present | priv-value= "id" or "header" | Digits | do not include any number digits fields | +| | | Type of number | "unknown" | +| | | Numbering Plan Identification | "unknown" | +| | | Presentation Indicator | "presentation restricted" | +| | | Screening indicator | "Network provided" (NOTE 5) | +| P-Asserted-Identity header field

and
Privacy header field | Absent or other than E.164 number

and
Priv-value≠ "id" or "header" | Digits | do not include any number digits fields except for NOTE 3 and NOTE 4 case | +| | | Type of number | "unknown" | +| | | Numbering Plan Identification | "unknown" | +| | | Presentation Indicator | "presentation allowed" | +| | | Screening indicator | "Network provided" (NOTE 5) | +| Privacy header field | priv-value | Presentation Indicator | "Presentation Indicator" | +| priv-value | "header" | Presentation Indicator | Presentation restricted | +| | "user" | Presentation Indicator | Presentation allowed | +| | "none" | Presentation Indicator | Presentation allowed | +| | "id" | Presentation Indicator | Presentation restricted | + +NOTE 1: It is possible that a P-Asserted-Identity header field includes both a tel URI and a SIP or SIPS URI. In this case, either the tel URI or the SIP URI with user="phone" and a specific host portion, as selected by operator policy, may be used. + +NOTE 2: The number mapping does not include any digits contained in the phone-context parameter. + +NOTE 3: If a display-name is present in the P-Asserted-Identity header and if the MSC Server supports the network option of mapping display name to calling name identity, the MSC Server may use the P-Asserted-Identity header to build a facility information element with a name indicator parameter set to the display name. + +NOTE 4: Interworking of display name received in conjunction with a tel URI or SIP URI to calling name presentation using CNAP is subject to local regulatory requirements on calling line identity and whether the originating network of the call is trusted to provide an authentic identity. + +NOTE 5: As a network option, the MSC Server may support "Calling number verification using signature verification and attestation information" feature defined in 3GPP TS 24.229 [2]. If the MSC Server received a "verstat" tel URI parameter (defined in 3GPP TS 24.229 [2] clause 7.2A.20) in the P-Asserted-Identity header field the MSC Server may map the "verstat" tel URI parameter to the Screening Indicator field as follows: +- the value "No-TN-Validation" to the value "User-provided, not screened"; +- the value "TN-Validation-Passed" to the value "User-provided, verified and passed"; and +- the value "TN-Validation-Failed" to the value "User-provided, verified and failed". + +**Table 5.4.3.2: Setting of the calling party BCD number information element in SETUP message from From header field** + +| SIP Component | Value | Calling party BCD number information element | Value | +|-------------------------------------------------------------|------------------------------------------------|----------------------------------------------|---------------------------------------------------------------------------| +| From header field (NOTE 1, NOTE 2) and Privacy header field | E.164 number and Priv-value≠ "user" | Digits | digits contained in tel URI or SIP URI | +| | | Type of number | "national number" or "international number" | +| | | Numbering Plan Identification | "ISDN/telephony numbering plan" | +| | | Presentation Indicator | "presentation allowed" | +| | | Screening indicator | "User-provided, not screened" (NOTE 5) | +| From header field and Privacy header field | other than E.164 number and Priv-value≠ "user" | Digits | do not include any number digits fields except for NOTE 3 and NOTE 4 case | +| | | Type of number | "unknown" | +| | | Numbering Plan Identification | "unknown" | +| | | Presentation Indicator | "presentation allowed" | +| | | Screening indicator | "User-provided, not screened" (NOTE 5) | +| Privacy header field | priv-value | Presentation Indicator | "Presentation Indicator" | +| priv-value | "header" | Presentation Indicator | Presentation allowed | +| | "user" | Presentation Indicator | Presentation restricted | +| | "none" | Presentation Indicator | Presentation allowed | +| | "id" | Presentation Indicator | Presentation allowed | + +NOTE 1: It is possible that a From header field includes both a tel URI and a SIP or SIPS URI. In this case, either the tel URI or the SIP URI with user="phone" and a specific host portion, as selected by operator policy, may be used. + +NOTE 2: The number mapping does not include any digits contained in the phone-context parameter. + +NOTE 3: If a display-name is present in the From header and if the MSC Server supports the network option of mapping display name to calling name identity, the MSC Server may use the From header to build a facility information element with a name indicator parameter set to the display name. + +NOTE 4: Interworking of display name received in conjunction with a tel URI or SIP URI to calling name presentation using CNAP is subject to local regulatory requirements on calling line identity and whether the originating network of the call is trusted to provide an authentic identity. + +NOTE 5: As a network option, the MSC Server may support "Calling number verification using signature verification and attestation information" feature defined in 3GPP TS 24.229 [2]. If the MSC Server received a "verstat" tel URI parameter (defined in 3GPP TS 24.229 [2] clause 7.2A.20) in the From header field the MSC Server may map the "verstat" tel URI parameter to the Screening Indicator field as follows: + +- the value "No-TN-Validation" to the value "User-provided, not screened"; +- the value "TN-Validation-Passed" to the value "User-provided, verified and passed"; and +- the value "TN-Validation-Failed" to the value "User-provided, verified and failed". + +### 5.4.4 Receipt of CALL CONFIRMED + +Upon receipt of a CALL CONFIRMED message: + +- if a bearer capabilities 1 information element is present and indicates a teleservice other than 11 as described in 3GPP TS 22.003 [9], the MSC Server shall initiate call clearing procedures using a cause value of 58 (bearer capability not presently available); +- if a bearer capabilities 1 information element is present and includes a CTM text telephony indication set to "CTM text telephony is supported", the default behaviour of the MSC Server shall be to continue with call setup but not to provide user plane interworking between CTM and real-time-text at the CS-MGW. + +NOTE: Conversion between CTM as described in 3GPP TS 26.226 [22] and real-time-text as described in 3GPP TS 26.114 [28] may be provided as an implementation option if the SDP offer included the payload type for real-time-text. Such conversion is outside the scope of the present document. + +### 5.4.5 Bearer establishment + +#### 5.4.5.1 Network side bearer establishment + +If the initial INVITE request contained an SDP offer, the MSC Server should use the codecs received in the SDP offer and determine the codecs supported by the UE as specified in 3GPP TS 24.008 [3] to select and return a single codec in the SDP answer. + +The MSC Server shall reject all non-audio media descriptions from the SDP offer in the SDP answer. + +The SDP answer shall be returned in the first reliable response. + +If the initial INVITE request did not contain an SDP offer, the MSC Server should determine the codecs supported by the UE as specified in 3GPP TS 24.008 [3] and use this information when constructing a codec list for the SDP offer and send the SDP offer in the first reliable response to the INVITE request. + +#### 5.4.5.2 Access bearer assignment + +The MSC Server shall initiate access bearer assignment only after the following conditions are satisfied: + +- the incoming side RTP connection point has been successfully reserved and configured in the CS-MGW; and +- either: + - preconditions were not requested in the SDP of the initial INVITE request; or + - an SDP offer has been received indicating that remote preconditions have been met. + +For UTRAN and GERAN Iu-mode, the NAS Synchronisation Indicator information element shall be used to inform the UE of the selected codec as specified in 3GPP TS 24.008 [3]. + +#### 5.4.5.3 Transcoding + +The CS-MGW may include a speech transcoder based upon the speech coding information provided to each bearer termination. + +### 5.4.6 Receipt of ALERTING + +Upon receipt of the ALERTING message from the UE, the MSC Server shall send a 180 Ringing response. + +NOTE: Starting timer T301 (or a corresponding internal alerting supervision timing function) as specified in 3GPP TS 24.008 [3] at the MSC Server is an implementation option. The default value for T301 in 3GPP TS 24.008 [3] is longer than the range specified for the IM CN subsystem's no reply timer specified in 3GPP TS 24.604 [23], which should allow the IM CN subsystem to properly control CFNA. However, if T301 is started and expires prior to the no reply timer in the IM CN subsystem, the non-2xx response returned to the IM CN subsystem will prevent invocation of the CFNA service. + +### 5.4.7 Applying early media + +The MSC Server may instruct the CS-MGW to apply ringback tone or an announcement towards the IM CN subsystem in the following condition: + +- the MSC Server supports the P-Early-Media header as a network option; and +- the P-Early-Media header was received in the initial INVITE request. + +If these conditions are met and the MSC Server chooses to apply early media, the following actions are taken: + +- prior to applying an announcement, the MSC Server shall include in the 183 Session Progress response a P-Early-Media header authorizing backward early media; + +- prior to applying ringback tone, the MSC Server shall include in the 180 Ringing response a P-Early-Media header authorizing backward early media. + +### 5.4.8 Call rejection or abandonment + +#### 5.4.8.1 Receipt of RELEASE COMPLETE or DISCONNECT + +If the MSC Server receives a RELEASE COMPLETE or DISCONNECT message from the UE during call establishment, the MSC Server shall send a status-code 4xx, 5xx or 6xx response to the initial INVITE. The status-code sent shall be determined by examining the first cause information element received in the RELEASE COMPLETE or DISCONNECT message and applying the mapping specified in table 5.4.8.1.1. + +**Table 5.4.8.1.1: Mapping the cause information element to the 4xx/5xx/6xx status-code** + +| Cause value | SIP status-code | +|------------------------------------------------|-----------------------------| +| 1 (Unassigned (unallocated) number) | 404 Not Found | +| 3 (No route to destination) | 500 Server Internal Error | +| 6 (Channel unacceptable) | 500 Server Internal Error | +| 8 (Operator determined barring) | 603 Decline | +| 16 (Normal call clearing) | 480 Temporarily Unavailable | +| 17 (User busy) | 486 Busy Here | +| 18 (No user responding) | 480 Temporarily Unavailable | +| 19 (User alerting, no answer) | 480 Temporarily Unavailable | +| 21 (Call rejected) | 603 Decline | +| 22 (Number changed) | 410 Gone | +| 25 (Pre-emption) | 480 Temporarily Unavailable | +| 26 (Non selected user clearing) | 480 Temporarily Unavailable | +| 27 (Destination out of order) | 502 Bad Gateway | +| 28 (Invalid number format (incomplete number)) | 484 Address Incomplete | +| 29 (Facility rejected) | 501 Not Implemented | +| 30 (Response to STATUS ENQUIRY) | 500 Server Internal Error | +| 31 (Normal, unspecified) | 480 Temporarily Unavailable | +| 34 (No circuit/channel available) | 480 Temporarily Unavailable | +| 38 (Network out of order) | 500 Server Internal Error | +| 41 (Temporary failure) | 500 Server Internal Error | +| 42 (Switching equipment congestion) | 500 Server Internal Error | +| 43 (Access information discarded) | 500 Server Internal Error | +| 44 (Requested circuit/channel not available) | 500 Server Internal Error | +| 47 (Resources unavailable, unspecified) | 500 Server Internal Error | +| 49 (Quality of service unavailable) | 500 Server Internal Error | +| 50 (Requested facility not subscribed) | 500 Server Internal Error | +| 55 (Incoming calls barred within the CUG) | 603 Decline | +| 57 (Bearer capability not authorized) | 500 Server Internal Error | + +| Cause value | SIP status-code | +|-------------------------------------------------------------------------|-----------------------------| +| 58 (Bearer capability not presently available) | 500 Server Internal Error | +| 63 (Service or option not available, unspecified) | 501 Not Implemented | +| 65 (Bearer service not implemented) | 500 Server Internal Error | +| 68 (ACM equal to or greater than ACMmax) | 500 Server Internal Error | +| 69 (Requested facility not implemented) | 501 Not Implemented | +| 70 (Only restricted digital information bearer capability is available) | 501 Not Implemented | +| 79 (Service or option not implemented, unspecified) | 501 Not Implemented | +| 81 (Invalid transaction identifier value) | 500 Server Internal Error | +| 87 (User not member of CUG) | 403 Forbidden | +| 88 (Incompatible destination) | 500 Server Internal Error | +| 91 (Invalid transit network selection) | 404 Not Found | +| 95 (Semantically incorrect message) | 500 Server Internal Error | +| 96 (Invalid mandatory information) | 500 Server Internal Error | +| 97 (Message type non-existent or not implemented) | 501 Not Implemented | +| 98 (Message type not compatible with protocol state) | 501 Not Implemented | +| 99 (Information element non-existent or not implemented) | 501 Not Implemented | +| 100 (Conditional IE error) | 500 Server Internal Error | +| 101 (Message not compatible with protocol state) | 500 Server Internal Error | +| 102 (Recovery on timer expiry) | 504 Server timeout | +| 111 (Protocol error, unspecified) | 500 Server Internal Error | +| 127 (Interworking, unspecified) | 480 Temporarily Unavailable | + +NOTE 1: Alternative mappings are allowed per operator policy. + +The first cause information element included in the RELEASE COMPLETE or DISCONNECT message shall be mapped to a Reason header field in the SIP final response sent as a result of this clause as follows: + +- set the protocol field to "Q.850"; and +- set the numeric "cause" parameter value to the cause value field of the cause information element according to table 5.4.8.1.2. + +NOTE 2: The inclusion of reason-text in the Reason header is implementation specific. + +If, as a network option, the MSC Server supports the location header field parameter as described in IETF RFC 8606 [68], the MSC Server shall map the location parameter of the cause information element to the location parameter in the SIP Reason header field according to table 5.4.8.1.3. + +**Table 5.4.8.1.2: Mapping of cause information element to "cause" parameter for protocol "Q.850"** + +| Cause information element | Reason header field with protocol value "Q.850" | +|--------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------| +| Cause value | "cause" parameter value | +| 1 (Unallocated (unassigned) number) | 1 (Unallocated (unassigned) number) | +| 3 (No route to destination) | 3 (No route to destination) | +| 6 (Channel unacceptable) | 6 (Channel unacceptable) | +| 16 (Normal call clearing) | 16 (Normal call clearing) | +| 17 (User busy) | 17 (User busy) | +| 18 (No user responding) | 18 (No user responding) | +| 19 (User alerting, no answer) | 19 (No answer from user (user alerted)) | +| 21 (Call rejected) | 21 (Call rejected) | +| 22 (Number changed) | 22 (Number changed) | +| 24 (Call rejected due to feature at the destination) | 24 (Call rejected due to feature at the destination) | +| 25 (Pre-emption) | 8 (Preemption) | +| 26 (Non selected user clearing) | 26 (Non-selected user clearing) | +| 27 (Destination out of order) | 27 (Destination out of order) | +| 28 (Invalid number format (incomplete number)) | 28 (Invalid number format (address incomplete)) | +| 29 (Facility rejected) | 29 (Facility rejected) | +| 30 (Response to STATUS ENQUIRY) | 30 (Response to STATUS ENQUIRY) | +| 31 (Normal, unspecified) (NOTE 1) | 31 (Normal, unspecified) | +| 34 (No circuit/channel available) | 34 (No circuit/channel available) | +| 38 (Network out of order) | 38 (Network out of order) | +| 41 (Temporary failure) | 41 (Temporary failure) | +| 42 (Switching equipment congestion) | 42 (Switching equipment congestion) | +| 43 (Access information discarded) | 43 (Access information discarded) | +| 44 (requested circuit/channel not available) | 44 (Requested circuit/channel not available) | +| 47 (Resource unavailable, unspecified) (NOTE 2) | 47 (Resource unavailable, unspecified) | +| 49 (Quality of service unavailable) | 49 (Quality of service not available) | +| 50 (Requested facility not subscribed) | 50 (Requested facility not subscribed) | +| 55 (Incoming calls barred within the CUG) | 55 (Incoming calls barred within CUG) | +| 57 (Bearer capability not authorised) | 57 (Bearer capability not authorised) | +| 58 (Bearer capability not presently available) | 58 (Bearer capability not presently available) | +| 63 (Service option not available, unspecified) (NOTE 3) | 63 (Service option not available, unspecified) | +| 65 (Bearer capability not implemented) | 65 (Bearer capability not implemented) | +| 69 (Requested facility not implemented) | 69 (Requested facility not implemented) | +| 70 (Only restricted digital information capability is available) | 70 (Only restricted digital information capability is available) | +| 79 (Service or option not implemented, unspecified) (NOTE 4) | 79 (Service or option not implemented, unspecified) | +| 81 (Invalid transaction identifier value) | 81 (Invalid call reference value) | +| 87 (User not member of CUG) | 87 (User not member of CUG) | +| 88 (Incompatible destination) | 88 (Incompatible destination) | +| 91 (Invalid transit network selection) | 91 (Invalid transit network selection) | +| 95 (Semantically incorrect message) (NOTE 5) | 95 (Invalid message, unspecified) | +| 97 (Message type non-existent or not implemented) | 97 (Message type non-existent or not implemented) | +| 98 (Message type not compatible with protocol state) | 98 (Message not compatible with call state or message type non-existent or not implemented) | +| 99 (Information element non-existent or not implemented) | 99 (Information element/parameter non-existent or not implemented) | +| 101 (Message not compatible with protocol state) | 101 (Message not compatible with call state) | +| 102 (Recovery on timer expiry) | 102 (Recovery on timer expiry) | +| 111 (Protocol error, unspecified) (NOTE 6) | 111 (Protocol error, unspecified) | +| 127 (Interworking, unspecified) (NOTE 7) | 127 (Interworking, unspecified) | +| NOTE 1: All other values in the range 0 to 31 not appearing in table shall be treated as cause 31. | | +| NOTE 2: All other values in the range 32 to 47 not appearing in table shall be treated as cause 47. | | +| NOTE 3: All other values in the range 48 to 63 not appearing in table shall be treated as cause 63. | | +| NOTE 4: All other values in the range 64 to 79 not appearing in table shall be treated as cause 79. | | +| NOTE 5: All other values in the range 80 to 95 not appearing in table shall be treated as cause 95. | | +| NOTE 6: All other values in the range 96 to 111 not appearing in table shall be treated as cause 111. | | +| NOTE 7: All other values in the range 112 to 127 not appearing in table shall be treated as cause 127. | | + +**Table 5.4.8.1.3: Mapping of location parameter of Cause information element to SIP Reason header field location parameter** + +| Cause information element | Reason header field with protocol value "Q.850" | +|-----------------------------------------|-------------------------------------------------| +| "Location" parameter value | "location" parameter value | +| user | U | +| private network serving the local user | LPN | +| public network serving the local user | LN | +| transit network | TN | +| public network serving the remote user | RLN | +| private network serving the remote user | RPN | +| international network | INTL | +| network beyond interworking point | BI | + +#### 5.4.8.2 Receipt of CANCEL or BYE + +If the MSC Server receives a CANCEL or BYE request, the MSC Server shall initiate call clearing procedures by sending a DISCONNECT message towards the UE as described in 3GPP TS 24.008 [3] with the following interworking applied: + +- if one or more Reason header fields are included in the CANCEL or BYE request, then the cause value of each Reason header field shall be mapped to a cause information element in the DISCONNECT message as follows: + - a) if the Reason header field contains the protocol header field parameter set to "Q.850", or "SIP" with a cause header field parameter value other than "200", the cause information element shall be built as described in clause 5.3.8; and + - b) if the Reason header field contains the protocol header field parameter set to "SIP", the cause header field parameter set to "200" as specified in IETF RFC 3326 [45], the cause information element shall be set to cause value 13 (call completed elsewhere). +- if no Reason header field is included in the CANCEL or BYE request, a cause value set to 31 (normal, unspecified), coding standard set to "Standard defined for the GSM PLMNs" and location set to "network beyond interworking point" shall be used in the cause information element in the DISCONNECT message. + +### 5.4.9 Receipt of CONNECT + +Upon receipt of the CONNECT message from the UE, the MSC Server shall send a 200 OK response to the initial INVITE. + +Interworking applied for the TIR services is described in clause 5.6.2.2. + +### 5.4.10 Call failure procedures + +The MSC Server shall handle call failures (e.g. timer expiration) during mobile terminating call establishment in accordance with 3GPP TS 24.008 [3]. The cause value used towards the calling user as specified in 3GPP TS 24.008 [3] shall be mapped to a final response to the INVITE request as specified in clause 5.4.8.1. + +### 5.4.11 Autonomous clearing initiated by the MSC Server + +If the MSC Server determines due to internal procedures that the call shall be released, call release shall be in accordance with 3GPP TS 24.008 [3] clause 5.4.4 with the additional interworking defined here. + +NOTE 1: If a SIP 200 (OK) response has been sent but the SIP ACK request is not yet received, the procedure in clause 5.5.4 is used instead. + +Depending on the reason for the clearing, the MSC Server shall send a SIP 4xx or 5xx response as specified in 3GPP TS 24.229 [2] to the IM CN subsystem. The MSC Server shall include a Reason header field populated as follows: + +- the protocol field set to "Q.850"; and + +- a "cause" header field parameter aligned with the value used in the cause information element of the call clearing message towards the UE. + +NOTE 2: The inclusion of reason-text in the Reason header is implementation specific. + +## 5.5 Interworking of established call clearing between NAS signalling and SIP + +### 5.5.1 General + +The following subclauses define the procedure and signalling interworking performed by the MSC Server for call clearing of an established call. This interworking is independent of the direction of original call establishment. + +Call clearing during call setup is described in subclauses 5.3.7, 5.3.8, 5.3.9, 5.4.8.1 and 5.4.10. + +### 5.5.2 Clearing initiated by the mobile + +MSC Server handling of call clearing initiated by the mobile shall be in accordance with 3GPP TS 24.008 [3] with the additional interworking defined here. + +Upon receipt of a DISCONNECT message, the MSC Server shall send a BYE request as specified in 3GPP TS 24.229 [2] to the IM CN subsystem. The first cause information element in the DISCONNECT message shall be included in a Reason header field in the BYE request as follows: + +- set the protocol value to "Q.850"; and +- set the numeric "cause" parameter value to the cause value field of the cause information element according to table 5.4.8.1.2. + +NOTE: The inclusion of the "text" header field parameter in the Reason header field is implementation specific. + +If, as a network option, the MSC Server supports the location header field parameter as described in IETF RFC 8606 [68], the MSC Server shall map the location parameter of the cause information element to the location parameter in the SIP Reason header field according to table 5.4.8.1.3. + +### 5.5.3 Clearing initiated by the IM CN subsystem + +Upon receipt of a BYE request, the MSC Server shall send a DISCONNECT message towards the mobile. If one or more Reason header fields is included in the BYE request, each Reason header field shall be mapped to a cause information element in the DISCONNECT message according to clause 5.3.8. + +If no Reason header is present, a cause information element value of 16 (Normal call clearing) shall be used. + +### 5.5.4 Autonomous clearing initiated by the MSC Server + +If the MSC Server determines due to internal procedures that the call shall be released, call release shall be in accordance with 3GPP TS 24.008 [3] with the additional interworking defined here. + +The MSC Server shall send a BYE request to the IM CN subsystem. The MSC Server shall align according to table 5.4.8.1.2 the value used in the cause information element in the DISCONNECT message with the value used in the "cause" parameter for the "Q.850" protocol field in the Reason header of the BYE request. + +## 5.6 Supplementary Services invocation + +### 5.6.1 Originating identification presentation/restriction (OIP/OIR) + +The interworking required for OIP is defined in clause 5.4.3. + +The interworking required for OIR is defined in clause 5.3.3.2. + +### 5.6.2 Terminating identification presentation/restriction (TIP/TIR) + +#### 5.6.2.1 Terminating identification presentation (TIP) + +When interworking a SIP 200 OK (INVITE) response to a CONNECT message as described in clause 5.3.6, a MSC Server which supports the normal operation of the connected number supplementary service as described in 3GPP TS 24.081 [12] shall apply the following interworking for the TIP supplementary service: + +- if a P-Asserted-Identity header containing a tel URI or a SIP URI with "user=phone" is present, the MSC Server shall use this header to build a connected number information element as follows: + - if the tel URI or number within the userinfo part of the SIP URI is in international format, set the type of number to "international number", otherwise set the type of number to "national number"; and + - set the number plan identification to "ISDN/telephony numbering plan"; and + - set the presentation indicator to "presentation allowed"; and + - set the screening indicator to "network provided"; and + - set the number digits fields to the telephone number contained in the tel URI or the userinfo part of the SIP URI; or + +NOTE 1: If the P-Asserted-Identity header contains both a tel URI and a SIP URI with "user=phone", the URI used for mapping is implementation specific. + +NOTE 2: The number mapping does not include any digits contained in the phone-context parameter. + +- if a P-Asserted-Identity header is present but does not contain a tel URI or a SIP URI with "user=phone", the MSC Server shall build a connected number information element as follows: + - set the type of number to "unknown"; and + - set the number plan identification to "unknown"; and + - set the presentation indicator to "number not available due to interworking"; and + - set the screening indicator to "network provided"; and + - do not include any number digits fields; or +- if no P-Asserted-Identity header is present but a Privacy header with priv-value set to "id" is present, the MSC Server shall build a connected number information element as follows: + - set the type of number to "unknown"; and + - set the number plan identification to "unknown"; and + - set the presentation indicator to "presentation restricted"; and + - set the screening indicator to "network provided"; and + - do not include any number digits fields; or +- if neither a P-Asserted-Identity header nor a Privacy header field with a priv-value set to "id" is present, then no connected number information element shall be included. + +#### 5.6.2.2 Terminating identification restriction (TIR) + +The MSC Server shall not include a Privacy header in any response to an INVITE request. + +NOTE: 3GPP TS 24.081 [12] does not provide a mechanism for a terminator to temporarily override default settings for this service. The inclusion of a Privacy header could lead to the AS serving the terminating user to mistakenly assume that a default setting is being temporarily overridden by the terminating user. Omitting the Privacy header allows the AS supporting the terminating user to perform the appropriate actions for the TIR service in "permanent mode" as specified in 3GPP TS 24.608 [14]. + +### 5.6.3 Communication Hold (HOLD) + +#### 5.6.3.1 HOLD initiated via NAS signalling + +##### 5.6.3.1.1 Hold + +When the MSC Server receives a HOLD message as specified in 3GPP TS 24.083 [26] and the media on the IM CN subsystem side of the CS-MGW is "sendonly" or "inactive", no interworking is required and the MSC Server shall send a HOLD ACKNOWLEDGE message to the UE as specified in 3GPP TS 24.083 [26]. If the media on the IM CN subsystem side is "recvonly" or "sendrecv", the MSC Server shall send an UPDATE or re-INVITE request containing an SDP offer configured as follows: + +- mark the media as "sendonly" or "inactive" as described in 3GPP TS 24.610 [27]; and +- if RTCP is disabled for this media stream, include RR and RS bandwidth modifiers with values greater than zero to enable RTCP as described in 3GPP TS 26.114 [28] clause 7.3.1. + +Upon receipt of the SDP answer in a 200 OK response to the UPDATE or re-INVITE request, the MSC Server shall send a HOLD ACKNOWLEDGE message to the UE as specified in 3GPP TS 24.083 [26]. + +If the SDP offer is rejected or a non-200 response is received to the UPDATE or re-INVITE request, the MSC Server shall send a HOLD REJECT message to the UE as specified in 3GPP TS 24.083 [26] with cause parameter set to "Facility rejected". + +##### 5.6.3.1.2 Resume + +When the MSC Server receives a RETRIEVE message as specified in 3GPP TS 24.083 [26] and the media on the IM CN subsystem side of the CS-MGW is "recvonly" or "sendrecv", no interworking is required and the MSC Server shall send a RETRIEVE ACKNOWLEDGE message to the UE as specified in 3GPP TS 24.083 [26]. If the media on the IM CN subsystem side is "sendonly" or "inactive", the MSC Server shall send an UPDATE or re-INVITE request containing an SDP offer with media marked as "recvonly" or "sendrecv" as described in 3GPP TS 24.610 [27]. The MSC Server may include RR and RS bandwidth modifiers set to zero in the SDP offer to disable RTCP. + +Upon receipt of the SDP answer in a 200 OK response to the UPDATE or re-INVITE request, the MSC Server shall send a RETRIEVE ACKNOWLEDGE message to the UE as specified in 3GPP TS 24.083 [26]. + +If the SDP offer is rejected or a non-200 response is received to the UPDATE or re-INVITE request, the MSC Server shall send a RETRIEVE REJECT message to the UE as specified in 3GPP TS 24.083 [26] with cause parameter set to "Facility rejected". + +#### 5.6.3.2 HOLD initiated via SIP signalling + +##### 5.6.3.2.1 Hold + +The IM CN subsystem makes a hold request by sending an UPDATE or re-INVITE request with an "inactive" or "sendonly" SDP attribute, depending on the current state of the session. Upon receipt of a hold request from the IM CN subsystem, the MSC Server shall perform the following interworking: + +- if the MSC Server received a non-zero SS screening indicator as defined in 3GPP TS 24.080 [29] from the UE, the MSC Server shall send a FACILITY message indicating the call has been placed on hold as specified in 3GPP TS 24.083 [26]; +- if the MSC Server did not receive a non-zero SS screening indicator from the UE, the MSC Server shall not send any message to the UE. + +##### 5.6.3.2.2 Resume + +The IM CN subsystem requests to resume a session by sending an UPDATE or re-INVITE request with an "recvonly" or "sendrecv" SDP attribute, depending on the current state of the session. Upon receipt of a resume request from the IM CN subsystem, the MSC Server shall perform the following interworking: + +- if the MSC Server received a non-zero SS screening indicator as defined in 3GPP TS 24.080 [29] from the UE, the MSC Server shall send a FACILITY message indicating the call has been retrieved as specified in 3GPP TS 24.083 [26]; + +- if the MSC Server did not receive a non-zero SS screening indicator from the UE, the MSC Server shall not send any message to the UE. + +### 5.6.4 Communication Waiting (CW) + +#### 5.6.4.1 Receipt of initial INVITE + +NOTE: Clause 5.4.2 contains general applicable procedures executed upon receipt of an initial INVITE request. + +If the initial INVITE request includes: + +- a MIME body (part) according to clause 4.4.1 of 3GPP TS 24.615 [44] with the "communication-waiting-indication" element contained in the "ims-cw" root element according to 3GPP TS 24.615 [44]; or +- does not contain a Replaces header field corresponding to an established dialog and the target of the INVITE request is engaged in the established SIP dialog; + +then, upon interworking the initial INVITE request to a SETUP message as described in clause 5.4.3, the MSC Server shall apply the following additional interworking: + +- the MSC Server shall include a Signal information element with value 7 (call waiting tone on); and +- if the INVITE request includes a MIME body (part) according to clause 4.4.1 of 3GPP TS 24.615 [44] with the "communication-waiting-indication" element contained in the "ims-cw" root element according to 3GPP TS 24.615 [44]: +- the MSC Server shall store an indication that this session includes a CW AS; and +- the MSC Server may start timer TUE-CW as described in 3GPP TS 24.615 [44]. + +If the CALL CONFIRMED message received by the MSC Server during mobile terminating call setup contains a Cause information element set to a value of 17 (User busy), then upon interworking the subsequent ALERTING message to a 180 Ringing response as described in clause 5.4.6, the MSC Server shall apply the following additional interworking: + +- the MSC Server shall insert an Alert-Info header set to "urn:alert:service:call-waiting" as described in 3GPP TS 24.615 [44] into the 180 Ringing response. + +#### 5.6.4.2 Accepting the waiting call + +If the subscriber chooses to accept the waiting call and put the existing call on hold, the MSC Server shall: + +- upon receipt of the HOLD message for the existing call, apply the interworking specified in clause 5.6.3.1.1; and +- upon receipt of the CONNECT message for the waiting call, stop timer TUE-CW if it was started and apply the interworking specified in clause 5.4.9. + +If the subscriber chooses to accept the waiting call and release the existing call, the MSC Server shall: + +- upon receipt of the DISCONNECT message for the existing call, apply the interworking specified in clause 5.5.2; and +- upon receipt of the CONNECT message for the waiting call, stop timer TUE-CW if it was started and apply the interworking specified in clause 5.4.9. + +#### 5.6.4.3 Rejecting the waiting call + +If the MSC Server receives a first clearing message from the UE during call establishment, the cause value used towards the calling user as specified in 3GPP TS 24.008 [3] shall be mapped to a final response to the INVITE request as specified in clause 5.4.8.1, except for cause codes: + +- 19 (User alerting, no answer) and 18 (No user responding). A first clearing message from the UE during call establishment with cause code 19 (User alerting, no answer) or 18 (No user responding) shall be mapped to the 480 (Temporarily unavailable) final response including a Reason header field (see RFC 3326 [45]) with the protocol set to "Q.850" and the cause set to "19" or "18", respectively; +- 63 (Service or option not available, unspecified) and 69 (Requested facility not implemented): + +- if the MSC Server stored an indication that the session includes a CW AS, a first clearing message from the UE during call establishment with cause code 63 (Service or option not available, unspecified) or 69 (Requested facility not implemented) used towards the calling user as specified in 3GPP TS 24.008 [3] shall be mapped to the 415 (Unsupported Media Type) final response; or +- if the MSC Server did not store an indication that the session includes a CW AS, the cause codes 63 (Service or option not available, unspecified) and 69 (Requested facility not implemented) used towards the calling user as specified in 3GPP TS 24.008 [3] shall be mapped to a final response to the INVITE request as specified in clause 5.4.8.1. + +Depending on operator policy, the MSC Server may insert in a SIP failure response a Response-Source header field with an "fe" header field parameter constructed with the URN namespace "urn:3gpp:fe", the "fe-id" part of the URN set to "msc-server" and the "role" header field parameter set to "msc-server-ics" in accordance with subclause 7.2.17 of 3GPP TS 24.229 [2]. + +The MSC Server shall stop timer TUE-CW if it was started. + +#### 5.6.4.4 Communication release during waiting condition + +Upon receipt of a BYE or CANCEL request for the waiting call, the MSC Server shall stop timer TUE-CW if it was started, and: + +- if the BYE or CANCEL request includes a Reason header field (see RFC 3326 [45]) with the protocol set to "SIP" and the cause set to "408" then the MSC Server shall send a first clearing message according to clause 5.4.8.2, with the following addition: + - the Cause information element shall be set to cause 102 "recovery on timer expiry"; or +- the MSC Server shall act in accordance with clause 5.4.8.2. + +#### 5.6.4.5 CW condition timeout + +If timer TUE-CW was started and expires, the MSC Server shall: + +- send a DISCONNECT message as described in 3GPP TS 24.008 [3], towards the UE for the waiting call, including the Cause information element, where the cause value is set to 102 "recovery on timer expiry", the coding standard set to "Standard defined for the GSM PLMNs" and location set to "network beyond interworking point"; +- if the MSC Server stored an indication that the session includes a CW AS, send a 480 (Temporarily unavailable) final response, including a Reason header field set to cause 19, according to 3GPP TS 24.615 [44] in response to the initial INVITE request, and depending on operator policy, the MSC Server may insert a Response-Source header field with an "fe" header field parameter constructed with the URN namespace "urn:3gpp:fe", the "fe-id" part of the URN set to "msc-server" and the "role" header field parameter set to "msc-server-ics" in accordance with subclause 7.2.17 of 3GPP TS 24.229 [2]; +- ; +- if the MSC Server did not store an indication that the session includes a CW AS, the MSC Server shall act in accordance with clause 5.4.10. + +NOTE: Starting timer T2 or (optionally) T3 (or corresponding internal alerting supervision timing functions) as specified in 3GPP TS 24.083 [26] is an implementation option. Corresponding timers have been defined in 3GPP TS 24.615 [44] and 3GPP TS 24.604 [23]. If timers T2 or optionally T3 are started and expire, any resulting SIP responses that are not a 480 (Temporarily unavailable) final response, including a Reason header field set to cause 19, can interact with CW and (optionally) CDIV. + +#### 5.6.4.6 Notification to originator + +For originating calls interworked to the IM CN subsystem as described in clause 5.3, if the MSC Server receives a 180 Ringing response with a Alert-Info header field set to "urn:alert:service:call-waiting" according to 3GPP TS 24.615 [44], the MSC Server shall, according to 3GPP TS 24.083 [26], send if possible, the ALERTING message as the carrier message for the Call Waiting notification. Otherwise the MSC Server shall send a FACILITY message as the carrier message for the Call Waiting notification as specified in 3GPP TS 24.083 [26]. + +### 5.6.5 Communication Barring (CB) + +When interworking a 4xx, 5xx or 6xx response to the initial INVITE request to a DISCONNECT message as described in clause 5.3.8, the MSC Server shall apply the following additional interworking for the CB services described in 3GPP TS 24.611 [31]: + +- if a 433 Anonymity Disallowed response is received, the MSC Server shall include in the DISCONNECT a NotifySS operation containing an SS-Code set to the common code for incoming barring services and an SS-Status set to indicate the service is active and operative as specified in 3GPP TS 24.088 [30]; +- if a 603 Decline response is received, the MSC Server shall include in the DISCONNECT a NotifySS operation containing an SS-Code set to the common code for all barring services and an SS-Status set to indicate the service is active and operative as specified in 3GPP TS 24.088 [30]. + +NOTE: The common SS code is used as 3GPP TS 24.611 [31] specifies the use of a 603 Decline response for both the OCB and ICB services. + +### 5.6.6 Communication Diversion + +#### 5.6.6.1 General + +The following subclauses describe the MSC Server interworking behaviour related to the Communication Diversion (CDIV) services defined in 3GPP TS 24.604 [23]. + +#### 5.6.6.2 CDIV invocation + +##### 5.6.6.2.1 Communication Forwarding Unconditional (CFU) + +Invocation of CFU is handled by the IM CN subsystem as described in 3GPP TS 24.604 [23] and requires no interworking at the MSC Server. + +##### 5.6.6.2.2 Communication Forwarding Busy (CFB) + +For network determined user busy, invocation of CFB is handled by the IM CN subsystem as described in 3GPP TS 24.604 [23] and requires interworking at the MSC Server. + +For user determined user busy during mobile terminating call establishment as described in clause 5.4, if the MSC Server receives a DISCONNECT, RELEASE or RELEASE COMPLETE message from the UE with a cause information element set to "User Busy", the MSC Server shall perform the interworking described in clause 5.4.8.1. + +##### 5.6.6.2.3 Communication Forwarding No Reply (CFNR) + +Invocation of CFNR is handled by the IM CN subsystem as described in 3GPP TS 24.604 [23] and requires no interworking at the MSC Server. + +##### 5.6.6.2.4 Communication Forwarding on Not Logged-In (CFNL) + +Invocation of CFNL is handled by the IM CN subsystem as described in 3GPP TS 24.604 [23] and requires no interworking at the MSC Server. + +##### 5.6.6.2.5 Communication Deflection (CD) + +During mobile terminating call establishment as described in clause 5.4, if the MSC Server receives a DISCONNECT message from the UE with a facility information element containing a call deflection request as specified in 3GPP TS 24.072 [25], the MSC Server shall send a 302 (Moved Temporarily) response to the initial INVITE with the following interworking applied: + +- the DeflectedToNumber parameter in the facility information element received in the DISCONNECT message is used to derive a Contact header as follows: + - if the nature of address indicator is set to "international number", then the address digits in the DeflectedToNumber parameter, prefixed with a "+", shall be used to build a tel URI or a SIP URI with "user=phone"; or + - if the nature of address indicator is not set to "international number", then the MSC Server shall either: + +- convert the address digits in the DeflectedToNumber parameter to international format by prefixing the number digits with "+CC" and use this to build a tel URI or a SIP URI with "user=phone"; or + +NOTE 1: CC is the country code of the network in which the MSC Server is located. + +- use the address digits in the DeflectedToNumber parameter to build a tel URI or a SIP URI with "user=phone". The phone-context parameter shall include the home network domain name defined for IMS centralized services in 3GPP TS 23.003 [10]. For geo-local numbers, the home domain name shall be prefixed by the "geo-local" string according to 3GPP TS 24.229 [2]. + +NOTE 2: The manner in which the MSC Server distinguishes between geo-local and home-local numbers is implementation specific. + +Depending on operator policy, the MSC Server may insert in a 302 (Moved Temporarily) response a Response-Source header field with an "fe" header field parameter constructed with the URN namespace "urn:3gpp:fe", the "fe-id" part of the URN set to "msc-server" and the "role" header field parameter set to "msc-server-ics" in accordance with subclause 7.2.17 of 3GPP TS 24.229 [2]. + +##### 5.6.6.2.6 Communication Forwarding on Subscriber Not Reachable (CFNRc) + +Clause 5.4.2 describes a number of scenarios where the MSC Server determines the terminating user is not reachable prior to sending the SETUP message and returns the appropriate response to the INVITE request to allow CFNRc to be initiated in the IM CN subsystem. If the MSC Server determines the terminating user is not reachable prior to sending the SETUP message for any other scenario not described in clause 5.4.2, the MSC Server shall send a 500 Server Internal Error response to the initial INVITE request and depending on operator policy, the MSC Server may insert in the 500 (Server Internal Error) response a Response-Source header field with an "fe" header field parameter constructed with the URN namespace "urn:3gpp:fe", the "fe-id" part of the URN set to "msc-server" and the "role" header field parameter set to "msc-server-ics" in accordance with subclause 7.2.17 of 3GPP TS 24.229 [2]. + +#### 5.6.6.3 Notifications relating to CDIV + +##### 5.6.6.3.1 Void + +##### 5.6.6.3.2 Notification to an originating user on CS access + +For originating calls interworked to the IM CN subsystem as described in clause 5.3, if communication diversion occurs for a served user with the subscription option "Originating user receives notification that his communication has been diverted (forwarded or deflected)" as described in 3GPP TS 24.604 [23], the following interworking shall be applied upon receipt of a 181 (Call Is Being Forwarded) response: + +- if a History-Info header field is present and any history entry contains a "cause" SIP URI parameter, as defined in IETF RFC 4458 [55] set to a value listed in table 5.6.6.3.2.1, the MSC Server shall send a FACILITY message containing a NotifySS operation indicating the call has been forwarded. The NotifySS operation shall contain an SS-Code as specified in 3GPP TS 24.082 [24] and 3GPP TS 24.072 [25] mapped from the value of the last "cause" SIP URI parameter according to table 5.6.6.3.2.1; + +**Table 5.6.6.3.2.1: Mapping the History-Info cause value to SS-Code** + +| Cause value | SS-Code | +|-------------|--------------------------------------| +| 302 | CFU | +| 404 | Common SS-Code for all forwarding SS | +| 408 | CFNRy | +| 480 | CD | +| 486 | CFB | +| 487 | CD | +| 503 | CFNRc | + +NOTE: Per 3GPP TS 24.604 [23] the History-Info header field can also be received in a SIP 180 (Ringing) or SIP 200 (OK) response to the initial SIP INVITE request. No interworking is performed in these scenarios as 3GPP TS 24.082 [24] does not allow this information to be presented to the subscriber in a manner consistent with 3GPP TS 24.604 [23]. + +##### 5.6.6.3.3 Notification to a terminating user on CS access + +When interworking a SIP INVITE request to a SETUP message as described in clause 5.4.3, the MSC Server shall apply the following interworking to provide notification of CDIV if a History-Info header field is present in the INVITE request: + +- if any history entry in the History-Info header field contains a "cause" SIP URI parameter, as defined in IETF RFC 4458 [55], set to a value listed in table 5.6.6.3.2.1, the MSC Server shall send a FACILITY information element containing a NotifySS operation indicating the call has been forwarded. The NotifySS operation shall contain an SS-Code as specified in 3GPP TS 24.082 [24] and 3GPP TS 24.072 [25] mapped from the value of the last "cause" SIP URI parameter according to table 5.6.6.3.2.1. +- if + - a) the SIP INVITE request does not contain a Privacy header field with any of the privacy values "header", "session" or "history"; and + - b) the history entry in the History-Info header field preceding the last history entry in History-Info header field containing a "cause" SIP URI parameter defined in IETF RFC 4458 [55] set to a value listed in table 5.6.6.3.2.1 does not contain an escaped privacy header with a value of "history", +- then the following additional interworking shall be applied: + - if the hi-targeted-to-uri within the history entry preceding the last history entry containing a "cause" SIP URI parameter contains a tel URI or a SIP URI with "user=phone", the MSC Server shall include a redirecting party BCD number information element set as follows: + - if the tel URI or telephone number within the SIP URI is in international format, set the type of number to "international number", otherwise set the type of number to "national number"; + - set the number plan identification to "ISDN/telephony numbering plan"; + - set the presentation indicator to "presentation allowed"; + - set the screening indicator to "network provided"; and + - set the number digits fields to the telephone number contained in the tel URI or SIP URI; + +NOTE: The number mapping does not include any digits contained in the phone-context parameter. + +- otherwise, + - the MSC Server shall build a redirecting party BCD number information element as follows: + - set the type of number to "unknown"; + - set the number plan identification to "unknown"; + - set the presentation indicator to "number not available due to interworking"; and + - set the screening indicator to "network provided". + +### 5.6.7 Explicit Communication Transfer (ECT) + +#### 5.6.7.1 General + +The following subclauses describe the MSC Server interworking behaviour related to the ECT service defined in 3GPP TS 24.629 [33] and a UE using CS access domain signalling specified in 3GPP TS 24.091 [32]. + +#### 5.6.7.2 MSC Server as transferor on behalf of UE + +When the MSC Server receives a FACILITY message containing an ECT request from a UE with one answered call in a held state and another call in an answered and active or alerting state as specified in 3GPP TS 24.091 [32], the MSC Server shall build and send a REFER request as specified for a transferor UE in 3GPP TS 24.629 [33]. + +When the MSC Server receives a NOTIFY request on the REFER dialog, interworking shall be applied based upon the SIP response status-code contained in the "message/sipfrag" message body as follows: + +- if status-code 100 Trying is received, no interworking is applied; +- if status-code 200 OK is received, the MSC Server shall send a FACILITY message indicating transfer success to the UE as specified in 3GPP TS 24.091 [32]. The MSC Server shall then initiate clearing of the two calls towards the UE as specified in 3GPP TS 24.091 [32] and initiate clearing of the IM CN subsystem session with the transferee as specified in clause 5.5.4. +- if status-code 503 is received, the MSC Server shall send a FACILITY message with a return error parameter set to "SystemFailure" and leave the two calls from the UE in the conditions they were in prior to the ECT request; +- if any other status-code is received, the MSC Server shall send a FACILITY message with a return error parameter set to "IllegalSS-Operation" and leave the two calls from the UE in the conditions they were in prior to the ECT request. + +#### 5.6.7.3 MSC Server as transferee on behalf of UE + +##### 5.6.7.3.1 Actions without 3PCC + +NOTE 1: CS domain access signalling as specified in 3GPP TS 24.091 [32] does not provide a mechanism to present the transfer request to the transferee for authorization of the transfer. Automatic acceptance and execution of the REFER request by the MSC Server can therefore pose a security risk or have unwanted charging consequences. Acceptance of REFER requests is therefore subject to operator policy, which is outside the scope of the present document. + +When the MSC Server receives a REFER request in the context of a call transfer scenario as described in 3GPP TS 24.629 [33] clause 4.5.2.4.1.2.2, the MSC Server may perform the actions specified for a transferee UE in 3GPP TS 24.629 [33]. + +If the MSC Server does not support accepting REFER requests on behalf of the UE per operator policy, then the MSC Server shall return a 403 (Forbidden) response and depending on operator policy, the MSC Server may insert in the 403 (Forbidden) response a Response-Source header field with an "fe" header field parameter constructed with the URN namespace "urn:3gpp:fe", the "fe-id" part of the URN set to "msc-server" and the "role" header field parameter set to "msc-server-ics" in accordance with subclause 7.2.17 of 3GPP TS 24.229 [2]. + +If the MSC Server received a non-zero SS screening indicator from the UE as defined in 3GPP TS 24.080 [29], then upon sending the NOTIFY request indicating that the transfer is complete, the MSC Server may send a FACILITY message to the UE as specified in 3GPP TS 24.091 [32]. The MSC Server may include an Rdn parameter set to indicate that the remote party number is not available due to interworking. + +NOTE 2: The remote party number, as indicated in the Refer-To header sent by the transferor, is not available to the MSC Server as it is replaced by the transferor AS as specified in 3GPP TS 24.629 [33]. + +NOTE 3: Depending on the conferencing implementation in the IM CN subsystem (e.g. the manner in which users are invited to a conference), the MSC Server might not be able to distinguish between REFER requests for the ECT service and REFER requests for the conferencing service. In such cases, the MSC Server will not know which SS operation to indicate in the FACILITY message. Handling of this scenario is implementation specific. + +##### 5.6.7.3.2 Actions with 3PCC + +When 3PCC is used for ECT as specified in 3GPP TS 24.629 [33], no special interworking is required at the MSC Server. + +#### 5.6.7.4 MSC Server as transfer target on behalf of UE + +When the MSC Server receives an INVITE request which does not replace an existing session (e.g. blind ECT), the MSC Server shall follow the interworking procedures specified in clause 5.4. + +When the MSC Server receives an INVITE request which replaces an existing session, the MSC Server shall perform the actions specified for a transfer target UE in 3GPP TS 24.629 [33]. If the MSC Server received a non-zero SS screening indicator as defined in 3GPP TS 24.080 [29], then upon successful session establishment with the transferee the MSC Server shall send a FACILITY message to the UE as specified in 3GPP TS 24.091 [32] with the following interworking applied: + +- if a Privacy header with priv-value set to "id" is present, the MSC Server may include an Rdn parameter in the FACILITY message set to indicate presentation restricted as specified in 3GPP TS 24.080 [29]; +- if a Privacy header with a priv-value set to "id" is not present in the INVITE request, then: + - if a P-Asserted-Identity header containing a tel URI or a SIP URI with "user=phone" is present in the INVITE, the MSC Server may include an Rdn parameter in the FACILITY message with a value set to the telephone number contained in this URI; + - if a P-Asserted-Identity header is present but does not contain a tel URI or a SIP URI with "user=phone", the MSC Server may include an Rdn parameter in the FACILITY message set to indicate the number is not available due to interworking as specified in 3GPP TS 24.080 [29]. + +### 5.6.8 Conference (CONF) + +#### 5.6.8.1 General + +IM CN subsystem CONF functionality at a MSC Server is specified in 3GPP TS 24.292 [7]. The following subclauses describe the MSC Server interworking behaviour related to the CONF service defined in 3GPP TS 24.605 [35] and a UE using CS access domain signalling specified in 3GPP TS 24.084 [34]. + +#### 5.6.8.2 MSC Server as conference creator + +##### 5.6.8.2.1 Conference creation + +When the MSC Server receives a BuildMPTY request from a UE with one active call and one held call as described in 3GPP TS 24.084 [34], the MSC Server shall initiate conference creation and invite the remote parties to the conference as described in 3GPP TS 24.292 [7]. + +NOTE: Conference creation and inviting users to the conference are two distinct actions in the IM CN subsystem. However, in CS access signalling a single message creates the conference and adds the existing calls to the conference. + +After receiving NOTIFY requests indicating both remote parties have successfully transferred to the conference, the MSC Server shall send a FACILITY message indicating BuildMPTY success as specified in 3GPP TS 24.084 [34]. + +If a non-200 final response to the INVITE request which attempts to create the conference is received, the MSC Server shall send a FACILITY message with a return error parameter set to "SystemFailure" and leave the two calls from the UE in the conditions they were in prior to the conference creation request. + +##### 5.6.8.2.2 Putting the conference on hold + +When the MSC Server receives a HoldMPTY request from a UE with an active conference, the MSC Server shall send an UPDATE or re-INVITE request containing a new SDP offer as described in clause 5.6.3.1.1. + +Upon receipt of the SDP answer in a 200 OK response to the UPDATE or re-INVITE request, the MSC Server shall send a FACILITY message indicating success as specified in 3GPP TS 24.084 [34]. + +If the SDP offer is rejected or a non-200 response is received to the UPDATE or re-INVITE request, the MSC Server shall send a FACILITY message as specified in 3GPP TS 24.084 [34] with a return error parameter set to "SystemFailure". + +##### 5.6.8.2.3 Resuming a held conference + +When the MSC Server receives a RetrieveMPTY request from a UE with a conference on hold, the MSC Server shall send an UPDATE or re-INVITE request containing a new SDP offer as described in clause 5.6.3.1.2. + +Upon receipt of the SDP answer in a 200 OK response to the UPDATE or re-INVITE request, the MSC Server shall send a FACILITY message indicating success as specified in 3GPP TS 24.084 [34]. + +If the SDP offer is rejected or a non-200 response is received to the UPDATE or re-INVITE request, the MSC Server shall send a FACILITY message with a return error parameter set to "SystemFailure". + +##### 5.6.8.2.4 Adding a party to the conference + +When the MSC Server receives a BuildMPTY from a UE with a conference on hold and separate active or waiting call as described in 3GPP TS 24.084 [34], the MSC Server shall: + +- invite the remote party to the conference as described in 3GPP TS 24.292 [7]; and +- send an UPDATE or re-INVITE request to resume the held conference as described in clause 5.6.3.1.2. + +##### 5.6.8.2.5 Terminating the conference or disconnecting a party from the conference + +When the MSC Server receives a DISCONNECT message from a UE with an established conference, with a transaction identifier corresponding to a specific remote party, the MSC Server shall start a conference termination specific timer. While the timer is running, MSC Server shall collect potential further DISCONNECT messages from the UE, with valid transaction identifiers, corresponding to other remote parties. These additional DISCONNECT messages shall not trigger starting a new timer and shall not restart the timer. + +NOTE 1: The value for the conference termination timer is implementation specific. The timer has to be long enough to allow that the UE encodes and transmits all the DISCONNECT messages to the MSC Server but it should be kept short so that the DISCONNECT messages used for disconnecting a single conference participant are not delayed too long. A value around 1 sec is seen as satisfactory. + +When the timer expires, MSC Server shall examine, whether it has received a DISCONNECT message corresponding to all remote parties that have been participants of the established conference and depending on that shall act as follows: + +- If a DISCONNECT messages has been received for each participant, the MSC Server shall send a BYE request to the conference-URI. + +NOTE 2: A complete set of DISCONNECT messages is interpreted as request to terminate the established conference. The BYE request will lead to a termination of the conference by the conference focus, after removal all the participants, as described in 3GPP TS 24.147 [36], clause 5.3.2.7. + +- Otherwise, the MSC Server shall generate a separate REFER request for each DISCONNECT message to remove the corresponding party/parties from the conference as specified in 3GPP TS 24.147 [36] clause 5.3.1.6.3, with the Refer-To header of the REFER request set to the address of the conference participant being removed and also containing a "method" URI parameter set to "BYE". If the address of the conference participant being removed is a tel URI, the MSC server shall convert the tel URI to a SIP URI and shall set the host portion of the SIP URI to the home network domain name defined for IMS centralized services in 3GPP TS 23.003 [10]. + +NOTE 3: The MSC Server thus treats the DISCONNECT message(s) received before timer expiry as the user's request for disconnecting the party/parties belonging to the received transaction identity/identities. + +##### 5.6.8.2.6 Receipt of a SplitMPTY message + +When the MSC Server receives a SplitMPTY request from the UE, the MSC Server shall send a FACILITY message with a return error parameter set to "ss-NotAvailable". + +##### 5.6.8.2.7 Remote party disconnects from the conference + +When the MSC Server receives a SIP NOTIFY request from a conference focus indicating that a specific remote party has disconnected from the conference, the MSC Server shall send a CC DISCONNECT message to the UE, with a transaction identifier corresponding to the specific remote party. + +#### 5.6.8.3 MSC Server as conference participant + +##### 5.6.8.3.1 Receipt of invitation to conference + +###### 5.6.8.3.1.1 General + +The methods by which the MSC Server, on behalf of the UE, can be invited to a conference are described in 3GPP TS 24.605 [35] clause 4.5.2.1.2 and 3GPP TS 24.147 [36] clause 5.3.1.5. + +###### 5.6.8.3.1.2 Receipt of REFER within a dialog + +Upon receipt of a REFER request within a dialog, the MSC Server shall act as a transferee on behalf of the UE as specified in clause 5.6.7.3.1. + +NOTE 1: If the Refer-To header of the REFER request contains a conference URI, this will result in the user joining a conference. + +NOTE 2: CS domain access signalling as specified in 3GPP TS 24.091 [32] does not provide a mechanism to present the transfer request to the transferee for authorization of the transfer. Automatic acceptance and execution of the REFER request by the MSC Server can therefore pose a security risk or have unwanted charging consequences. Acceptance of REFER requests is therefore subject to operator policy, which is outside the scope of the present document. + +###### 5.6.8.3.1.3 Receipt of REFER outside a dialog + +If the MSC Server does not support accepting REFER requests on behalf of the UE per operator policy, then the MSC Server shall return a 403 Forbidden response. + +Support for the MSC Server, on behalf of a UE, joining a conference in this manner requires that the MSC Server shall: + +- initiate a terminating call leg toward the UE in accordance with 3GPP TS 24.008 [3]; and + +NOTE: If the user is involved in a call, then the call waiting procedures described in 3GPP TS 24.008 [3] and 3GPP TS 24.083 [26] apply. + +- initiate an originating call toward the URI identified in the Refer-To header (e.g. the conference URI); and +- combine these two call legs into a single call. + +Support for this method of joining a conference may be provided as an implementation option but is outside the scope of the present document. + +###### 5.6.8.3.1.4 Receipt of INVITE + +NOTE: Clause 5.4.2 contains general applicable procedures executed upon receipt of an initial INVITE request. + +If an INVITE request is received, the MSC Server shall act as follows: + +- if the user is idle, the MSC Server shall act according to the mobile terminating call set up procedures specified in clause 5.4; +- if the user is engaged in an established SIP dialog and the INVITE request contains a Replaces header field corresponding to the established dialog, the MSC Server act as a transfer target on behalf of the UE as specified in clause 5.6.7.4; or +- if the user is engaged in an established SIP dialog and the INVITE request does not contain a Replaces header field corresponding to the established dialog, the MSC Server shall follow the communication waiting procedures described in clause 5.6.4.1. + +##### 5.6.8.3.2 Notification of conference invocation + +If the MSC Server received a non-zero SS screening indicator from the UE as defined in 3GPP TS 24.080 [29], then upon joining a conference on behalf of a UE, the MSC Server may send a FACILITY message to the UE indicating a multiparty call has been invoked as specified in 3GPP TS 24.084 [34]. + +NOTE: If the MSC Server was invited to the conference via reception of a REFER request as specified in 3GPP TS 24.147 [36] clause 5.3.1.5.2, the MSC Server is not able to distinguish between REFER requests for the conferencing service and REFER requests for the ECT service. In such cases, the MSC Server will not know which SS operation to indicate in the FACILITY message. Handling of this scenario is implementation specific. + +### 5.6.9 Customized Alerting Tones (CAT) + +#### 5.6.9.1 General + +The following subclauses describe the MSC Server interworking behaviour related to the Customized Alerting Tones (CAT) services defined in 3GPP TS 24.182 [51]. + +Based on operator options, one of three different models described in 3GPP TS 24.182 [51] is used in an IM CN subsystem to provide the CAT service. The CAT interworking procedures at the MSC server differ between these models and are described separately for each model in the subsequent sub-clauses. Support of the interworking procedures for each of those models is optional. + +No special interworking procedures for the CAT service when MSC server receive a terminating request from IMS network are required. + +#### 5.6.9.2 Early session model + +##### 5.6.9.2.1 Originating request + +If the MSC server supports early-session as a network option, upon receiving an incoming SETUP message, before the MSC server sending the generated SIP INVITE request as described in clause 5.3.3, it shall include the option tag "early-session", as defined in IETF RFC 3959 [50], in Supported header field. + +After receiving the first SIP 18x response including an early-session SDP, the MSC server shall send the ALERTING message as described in 3GPP TS 24.008 [3], then the MSC server shall follow the same procedure as described for MGCF in 3GPP TS 29.163 [46] clause 7.5.13 to negotiate with IMS side for early-session and normal session establishment. + +#### 5.6.9.3 Forking model + +Interworking at MSC server follows the basic call interworking procedures. Support of the P-Early-Media header field and related procedures as described in clause 5.3.4a and clause 5.3.4b are required in addition. + +#### 5.6.9.4 Gateway model + +Interworking at MSC server follows the basic call interworking procedures. Support of the P-Early-Media header field and related procedures as described in clause 5.3.4a and clause 5.3.4b are required in addition. + +### 5.6.10 Communication Completion Services (CCBS/CCNL/CCNR) + +#### 5.6.10.1 General + +The following subclauses describe the MSC Server interworking behaviour related to the Communication Completion services defined in 3GPP TS 24.642 [52] and a UE using CS access domain signalling specified in 3GPP TS 24.093 [53]. + +#### 5.6.10.2 Communication Completion Terminated at Served User + +When the Served User is the terminating user, no special interworking is required at the MSC Server. + +#### 5.6.10.3 Communication Completion Originated at Served User + +##### 5.6.10.3.1 Actions without 3PCC + +When the MSC Server receives a CC Recall as a REFER request as described in 3GPP TS 24.642 [52] clause 4.5.4.2.3.1, the MSC Server may assign a CCBS Index to this recall if not already done, and may perform the CC Recall procedures as specified by 3GPP TS 24.093 [53]. When the SETUP message is received, normal call handling continues. + +If the MSC Server does not support accepting REFER requests on behalf of the UE per operator policy, then the MSC Server shall return a 403 Forbidden response. + +##### 5.6.10.3.2 Actions with 3PCC + +When 3PCC is used for CCBS/CCNL/CCNR as specified in 3GPP TS 24.642 [52], no special interworking is required at the MSC Server. + +## 5.7 Supplementary Service Configuration + +### 5.7.1 General + +The MSC Server may support the interworking between call independent supplementary service signalling described in 3GPP TS 24.010 [41] and the XCAP application usage for manipulating supplementary services data described in 3GPP TS 24.623 [42]. This MSC Server may support this interworking for any subset of the supplementary services within the scope of the present document. This interworking shall only be performed for the TS11 service code. If the MSC Server interworks a supplementary service invoke operation received via NAS signalling to the IM CN subsystem, the MSC Server shall not also transfer the received information to the VLR as described in 3GPP TS 29.002 [20]. This interworking is defined in the following subclauses. + +NOTE: This interworking is subject to the limitations inherited by the NAS signalling procedures defined for each supplementary service. For example, if no NAS signalling procedure is defined for registration, erasure, activation, deactivation or interrogation of a particular supplementary service that is being controlled by the IM CN subsystem, then no interworking procedure is defined. + +### 5.7.2 Receipt of REGISTER message + +Upon receipt of a REGISTER message for a supplementary service whose interworking is within the scope of the present document, the MSC Server shall generate the appropriate HTTP request according to table 5.7.2.1 if supplementary service configuration interworking for that supplementary service is supported by the MSC Server. + +**Table 5.7.2.1: Mapping REGISTER / FACILITY to HTTP request** + +| Invoke operation in the REGISTER message | HTTP request | +|------------------------------------------|--------------| +| RegisterSS | PUT | +| ActivateSS | PUT | +| DeactivateSS | PUT | +| InterrogateSS | GET | +| EraseSS | PUT | + +NOTE: Not all invoke operations are valid for all supplementary services. Interworking definitions for each supplementary service are only provided for invoke operations explicitly defined for each supplementary service. + +The interworking of message contents for each supplementary service is described in clause 5.7.4. + +### 5.7.3 Receipt of HTTP response + +Upon receipt of an HTTP response to a previously sent HTTP request as described in clause 5.7.2, the MSC Server shall terminate the appropriate service interaction by sending a RELEASE COMPLETE message. The interworking of message contents for each supplementary service is described in clause 5.7.4. + +### 5.7.4 Service data interworking + +#### 5.7.4.1 Originating identification presentation/restriction (OIP/OIR) + +# 5.7.4.1.1 Registration/erasure + +The OIP/OIR services require no registration. Erasure is not applicable. + +#### 5.7.4.1.2 Activation/deactivation + +The OIP/OIR services are activated at provisioning and deactivated at withdrawal and therefore require no interworking at the MSC Server. + +#### 5.7.4.1.3 Interrogation + +If the MSC Server supports supplementary service configuration interworking for the OIP/OIR services, the interworking procedures in this clause shall be applied. + +When the MSC Server receives a REGISTER message with an InterrogateSS invoke operation for the CLIP or CLIR supplementary service code as described in 3GPP TS 24.081 [12], the MSC Server shall generate and send an HTTP GET request to fetch the instance of the Originating Identity document as specified in 3GPP TS 24.623 [42]. + +Upon receiving a response to the HTTP GET request, the MSC Server shall apply the following interworking: + +- If a 200 OK response is received which includes an Originating Identity document as defined in 3GPP TS 24.607 [43], the MSC Server shall send a RELEASE COMPLETE message as follows: + - If the Originating Identity document indicates the interrogated service (CLIP/OIP or CLIR/OIR) is active, the MSC Server shall indicate an SS-Status of provisioned and active; or + - If the Originating Identity document indicates the interrogated service (CLIP/OIP or CLIR/OIR) service is not active, the MSC Server shall indicate an SS-Status of provisioned but not active; + - If the CLIR/OIR service was interrogated, then the following additional interworking shall be applied: + - If there is a "default-behaviour" attribute included and set to "presentation-restricted" in the Originating Identity document, the MSC Server shall set the CLI Restriction Option parameter to indicate Temporary (Default Restricted); + - If there is a "default-behaviour" attribute included and set to "presentation-not-restricted" in the Originating Identity document the MSC Server shall set the CLI Restriction Option parameter to Temporary (Default Allowed); +- If a non 200 OK response is received or if a 200 OK response is received which does not include an Originating Identity document, the MSC Server shall send a RELEASE COMPLETE message with an implementation-specific error code. + +### 5.7.4.2 Terminating identification presentation/restriction (TIP/TIR) + +#### 5.7.4.2.1 Registration/erasure + +The TIP/TIR services require no registration. Erasure is not applicable. + +#### 5.7.4.2.2 Activation/deactivation + +The TIP/TIR services are activated at provisioning and deactivated at withdrawal and therefore require no interworking at the MSC Server. + +#### 5.7.4.2.3 Interrogation + +If the MSC Server supports supplementary service configuration interworking for the TIP/TIR services, the interworking procedures in this clause shall be applied. + +When the MSC Server receives a REGISTER message with an InterrogateSS invoke operation for the COLP or COLR supplementary service code as described in 3GPP TS 24.081 [12], the MSC Server shall generate an HTTP GET request to fetch the instance of the Terminating Identity document as specified in 3GPP TS 24.623 [42]. + +Upon receiving a response to the HTTP GET request, the MSC Server shall apply the following interworking: + +- If a 200 OK response is received which includes a Terminating Identity document as defined in 3GPP TS 24.608 [14], the MSC Server shall send a RELEASE COMPLETE message as follows: + - If the Terminating Identity document indicates the interrogated service (COLP/TIP or COLR/TIR) is active, the MSC Server shall indicate an SS-Status of provisioned and active; or + - If the Terminating Identity document indicates the interrogated service (COLP/TIP or COLR/TIR) service is not active, the MSC Server shall indicate an SS-Status of provisioned but not active; + +NOTE: CS signalling defined in 3GPP TS 24.081 [12] does not allow for the temporary mode status of the COLR service to be sent to the UE. + +- If a non 200 OK response is received or if a 200 OK response is received which does not include a Terminating Identity document, the MSC Server shall send a RELEASE COMPLETE message with an implementation-specific error code. + +### 5.7.4.3 Communication Hold (HOLD) + +Configuration of the HOLD service involves no signalling and therefore requires no interworking at the MSC Server. + +### 5.7.4.4 Communication Waiting (CW) + +#### 5.7.4.4.1 Registration/erasure + +The CW service requires no registration. Erasure is not applicable. + +#### 5.7.4.4.2 Activation/deactivation + +If the MSC Server supports supplementary service configuration interworking for the CW service, the interworking procedures in this clause shall be applied. + +When the MSC Server receives a REGISTER message with an ActivateSS or DeactivateSS invoke operation for the CW supplementary service code as described in 3GPP TS 24.083 [26], the MSC Server shall include an instance of the call waiting document described in 3GPP TS 24.615 [44] in the HTTP PUT request as follows: + +- If the invoke operation is ActivateSS, the MSC Server shall set the "active" attribute to "true"; +- If the invoke operation is DeactivateSS, the MSC Server shall set the "active" attribute to "false". + +#### 5.7.4.4.3 Interrogation + +If the MSC Server supports supplementary service configuration interworking for the CW service, the interworking procedures in this clause shall be applied. + +When the MSC Server receives a REGISTER message with an InterrogateSS invoke operation for the CW supplementary service code as described in 3GPP TS 24.083 [26], the MSC Server shall generate and send an HTTP GET request to fetch the instance of the call waiting document as specified in 3GPP TS 24.623 [42]. + +When a response to the HTTP GET request is received, the MSC Server shall apply the following interworking: + +- If a 200 OK is received which includes a call waiting document as defined in 3GPP TS 24.615 [44], the MSC Server shall send a RELEASE COMPLETE message as follows: + - If the call waiting document includes an "active" attribute set to "true", the MSC Server shall indicate an SS-Status of provisioned and active; + - If the call waiting document includes an "active" attribute set to "false", the MSC Server shall indicate an SS-Status of provisioned but not active; + +- If a non 200 OK response is received or if a 200 OK response is received which does not include a call waiting document, the MSC Server shall send a RELEASE COMPLETE message with an implementation-specific error code. + +#### 5.7.4.5 Communication Barring (CB) + +##### 5.7.4.5.1 Registration/erasure + +If the user has the subscription option "control of barring services" set to "by subscriber using a password" a password is registered at provisioning time and the UE can change the registered password at any later time using the procedures in this subclause. + +When the MSC Server receives a REGISTER message with an invoke component of the operation "register password" as specified in 3GPP TS 24.010 [41], the MSC Server enhanced for ICS first sends a FACILITY message towards the UE with an invoke component of the operation "get password". After receiving a FACILITY message from the UE with a return result component including a password, the MSC Server enhanced for ICS shall use this password to perform a password check procedure by sending an HTTP POST request towards the XCAP server as specified in 3GPP TS 24.623 [42]. + +Upon receiving an HTTP 200 (OK) response to the password check request as above, the MSC Server enhanced for ICS requests the new password from the UE as specified in 3GPP TS 24.010 [41] by sending a FACILITY message towards the UE with an invoke component of the operation "get password". When the UE returns the password the MSC Server enhanced for ICS requests the new password again. After receiving the password again, the MSC Server enhanced for ICS compares the two passwords, and if they are equal, registers the new password by performing the password change procedure as specified in 3GPP TS 24.623 [42]. + +Upon receiving the HTTP 200 (OK) response to the password change request as above, the MSC Server enhanced for ICS sends a Release Complete with the return result component of the operation "register password" as specified in 3GPP TS 24.010 [41]. + +Error responses towards the UE are sent as specified in 3GPP TS 24.010 [41]. + +Erasure of the CB service is not specified for NAS signalling in 3GPP TS 24.088 [30], therefore interworking procedures for service erasure are not applicable. + +##### 5.7.4.5.2 Activation/deactivation + +When the MSC Server receives a REGISTER message with an ActivateSS or DeactivateSS invoke operation for any call barring supplementary service code as described in 3GPP TS 24.088 [30], the MSC Server shall perform the password procedure as specified in 3GPP TS 24.088 [30], and store the received password for later mapping to the password portion of the SIP URI in the XCAP user identity as specified in 3GPP TS 24.623 [42]. The MSC Server shall then perform an interrogation as specified in 3GPP TS 24.611 [31] of either the element or the element depending on whether the received supplementary service code indicated an incoming or an outgoing barring service. + +To perform the interrogation the MSC Server populates the HTTP GET request as specified in 3GPP TS 24.623 [42]. If the result of the interrogation is that the user is not provisioned with the service indicated in the received REGISTER message, the MSC Server sends an appropriate error response. + +If the result of the interrogation is that the user is provisioned with the supplementary service indicated in the REGISTER request, and the activation status is different than the desired status, the MSC Server sends an HTTP PUT request as specified in 3GPP TS 24.623 [42] including the following rule: + +- 1) If the invoke operation is ActivateSS, the MSC Server shall set the "active" attribute to "true": + - a) If the supplementary service code is BAOC the MSC Server shall include an element including barring rule where the condition element is empty or no condition element is included, and not include the element, as defined in 3GPP TS 24.611 [31]. + - b) If the supplementary service code is BOIC the MSC Server shall include an element including a barring rule for the international condition, and not include the element, as defined in 3GPP TS 24.611 [31]. + +- c) If the supplementary service code is BOIC-exHC excluding home the MSC Server shall include an element including a barring rule for the international-exHC condition, and not include the element, as defined in 3GPP TS 24.611 [31]. + - d) If the supplementary service code is BAIC the MSC Server shall include an element including a barring rule where the condition element is empty or no condition element is included, and not include the element, as defined in 3GPP TS 24.611 [31]. + - e) If the supplementary service code is BIC-Roam the MSC Server shall include an element including a barring rule for the roaming condition, and not include the element, as defined in 3GPP TS 24.611 [31]. +- 2) If the invoke operation is DeactivateSS: +- a) If the supplementary service code is BAOC the MSC Server shall include an element including barring rule where the condition element is empty or no condition element is included, as defined in 3GPP TS 24.611 [31]. In addition, the MSC server shall in the condition element add a element. + - b) If the supplementary service code is BOIC the MSC Server shall include an element including a barring rule for the international condition, as defined in 3GPP TS 24.611 [31]. In addition, the MSC server shall in the condition element add a element. + - c) If the supplementary service code is BOIC-exHC excluding home the MSC Server shall include an element including a barring rule for the international-exHC condition, as defined in 3GPP TS 24.611 [31]. In addition, the MSC server shall in the condition element add a element. + - d) If the supplementary service code is BAIC the MSC Server shall include an element including a barring rule where the condition element is empty or no condition element is included, as defined in 3GPP TS 24.611 [31]. In addition, the MSC server shall in the condition element add a element. + - e) If the supplementary service code is BIC-Roam the MSC Server shall include an element including a barring rule for the roaming condition, as defined in 3GPP TS 24.611 [31]. In addition, the MSC server shall in the condition element add a element. + +#### 5.7.4.5.3 Interrogation + +If the MSC Server supports supplementary service configuration interworking for the CB service, the interworking procedures in this clause shall be applied. + +When the MSC Server receives a REGISTER message with an InterrogateSS invoke operation for the BAOC, BAIC, BOIC, BOIC-exHC or BIC-Roam supplementary service code as described in 3GPP TS 24.088 [30], the MSC Server shall generate and send an HTTP GET request to fetch the instance of the Communication Barring document as specified in 3GPP TS 24.623 [42]. + +When a response to the HTTP GET request is received, the MSC Server shall apply the following interworking: + +- 1) If an HTTP 200 (OK) response is received which includes a Communication Barring document as defined in 3GPP TS 24.611 [31], the MSC Server shall send a RELEASE COMPLETE message as follows: + - If the Communication Barring document indicates the call barring service being interrogated is active, the MSC Server shall include a BasicServiceCode set to the TS11 service code; + - If the Communication Barring document indicates the call barring service being interrogated is not active, the MSC Server shall include an SS-Status of deactivated; +- 2) If an HTTP non 200 (OK) response is received or if an HTTP 200 OK response is received which does not include a Communication Barring document, the MSC Server shall send a RELEASE COMPLETE message with an implementation-specific error code. + +## 5.7.4.6 Communication Diversion (CDIV) + +### 5.7.4.6.1 Registration + +If the MSC Server supports supplementary service configuration interworking for the CDIV service, the interworking procedures in this clause shall be applied. + +When the MSC Server receives a REGISTER message with a RegisterSS invoke operation for a supplementary service code listed below, the MSC Server shall include Communication Diversion document as described in 3GPP TS 24.604 [23] in the HTTP PUT request as follows: + +- The MSC Server shall set the active attribute to "true"; +- If the supplementary service code is CFU as described in 3GPP TS 24.082 [24], the MSC Server shall include a forwarding rule where the condition element is empty or no condition element is included, as defined in 3GPP TS 24.604 [23];; +- If the supplementary service code is CFB as described in 3GPP TS 24.082 [24], the MSC Server shall include a forwarding rule for the busy condition defined in 3GPP TS 24.604 [23]; +- If the supplementary service code is CFNRy as described in 3GPP TS 24.082 [24], the MSC Server shall include a forwarding rule for the no-answer condition defined in 3GPP TS 24.604 [23]; +- If the supplementary service code is CFNRc as described in 3GPP TS 24.082 [24], the MSC Server shall include a forwarding rule for the not-reachable condition defined in 3GPP TS 24.604 [23]; +- The MSC Server shall include a "target" element set to the TEL URI representation of the ForwardedToNumber parameter received in the REGISTER message. The TEL URI shall be constructed as described in clause 5.3.3.2. + +NOTE: The Communication Diversion document described in 3GPP TS 24.604 [23] defines XML elements which have no functional equivalent in the service configuration signalling defined in 3GPP TS 24.082 [24]. The inclusion of these elements and the values assigned to them is subject to operator policy. + +The MSC Server shall store a copy of the Communication Diversion document until the HTTP PUT response is received and processed. + +When a response to the HTTP PUT request is received, the MSC Server shall apply the following interworking: + +- If a 200 OK is received, the MSC Server shall send a RELEASE COMPLETE message as follows: + - The MSC Server shall indicate an SS-Status of provisioned and active; + - The MSC Server shall set the ForwardedToNumber parameter to the "target" element in the stored Communication Diversion document. +- If a non 200 OK response is received or if a 200 OK response is received which does not include a Communication Diversion document, the MSC Server shall send a RELEASE COMPLETE message with an implementation-specific error code. + +### 5.7.4.6.1a Erasure + +If the MSC Server supports supplementary service configuration interworking for the CDIV service, the interworking procedures in this clause shall be applied. + +When the MSC Server receives a REGISTER message with an EraseSS invoke operation for a supplementary service listed below, the MSC Server shall first fetch the instance of the Communication Diversion document as described in clause 5.7.4.6.3. If the MSC Server is unable to fetch the Communication Diversion document, the MSC Server shall send a RELEASE COMPLETE message with an implementation-specific error code. + +The MSC Server shall then include the Communication Diversion document as described in 3GPP TS 24.604 [23] in an HTTP PUT request, modified as follows: + +- If the supplementary service code is CFU, the MSC Server shall remove the forwarding rule with an empty condition element or no condition element included, if present; + +- If the supplementary service code is CFB, the MSC Server shall remove the forwarding rule for the busy condition defined in 3GPP TS 24.604 [23], if present; +- If the supplementary service code is CFNRy, the MSC Server shall remove the forwarding rule for the no-answer condition defined in 3GPP TS 24.604 [23], if present; +- If the supplementary service code is CFNRc, the MSC Server shall remove the forwarding rule for the not-reachable condition defined in 3GPP TS 24.604 [23], if present; +- If the supplementary service code is "all forwarding SS", the MSC Server shall remove all forwarding rules described above. + +When a response to the HTTP PUT request is received, the MSC Server shall apply the following interworking: + +- If a 200 OK is received, the MSC Server shall send a RELEASE COMPLETE message as follows: + - If an SS-Status parameter is required as specified in 3GPP TS 24.082 [24] clause 1.3.1, the MSC Server shall indicate an SS-Status of not active; +- If a non 200 OK response is received or if a 200 OK response is received which does not include a Communication Diversion document, the MSC Server shall send a RELEASE COMPLETE message with an implementation-specific error code. + +#### 5.7.4.6.2 Activation/deactivation + +If the MSC Server supports supplementary service configuration interworking for the CDIV service, the interworking procedures in this clause shall be applied. + +When the MSC Server receives a REGISTER message with an ActivateSS or DeactivateSS invoke operation for the CFU, CFB, CFNRy or CFNRc supplementary service code as described in 3GPP TS 24.082 [24], the MSC Server shall include a Communication Diversion document as described in 3GPP TS 24.604 [23] in the HTTP PUT request as follows: + +- If the invoke operation is ActivateSS, the MSC Server shall set the "active" attribute to "true"; +- If the invoke operation is DeactivateSS, the MSC Server shall set the "active" attribute to "false"; +- If the supplementary service code is CFU as described in 3GPP TS 24.082 [24], the MSC Server shall include a forwarding rule with an empty condition element or no condition element included; +- If the supplementary service code is CFB as described in 3GPP TS 24.082 [24], the MSC Server shall include a forwarding rule for the busy condition defined in 3GPP TS 24.604 [23]; +- If the supplementary service code is CFNRy as described in 3GPP TS 24.082 [24], the MSC Server shall include a forwarding rule for the no-answer condition defined in 3GPP TS 24.604 [23]; +- If the supplementary service code is CFNRc as described in 3GPP TS 24.082 [24], the MSC Server shall include a forwarding rule for the not-reachable condition defined in 3GPP TS 24.604 [23]; + +NOTE: The Communication Diversion document described in 3GPP TS 24.604 [23] defines XML elements which have no functional equivalent in the service configuration signalling defined in 3GPP TS 24.082 [24]. The inclusion of these elements and the values assigned to them is subject to operator policy. + +The MSC Server shall store a copy of the Communication Diversion document until the HTTP PUT response is received and processed. + +When a response to the HTTP PUT request is received, the MSC Server shall apply the following interworking: + +- If a 200 OK is received, the MSC Server shall send a RELEASE COMPLETE message as follows: + - If the "active" attribute in the stored Communication Diversion document is set to "true", the MSC Server shall indicate an SS-Status of provisioned and active; + - If the "active" attribute in the stored Communication Diversion document is set to "false", the MSC Server shall indicate an SS-Status of provisioned but not active; + +- If a non 200 OK response is received or if a 200 OK response is received which does not include a Communication Diversion document, the MSC Server shall send a RELEASE COMPLETE message with an implementation-specific error code. + +#### 5.7.4.6.3 Interrogation + +If the MSC Server supports supplementary service configuration interworking for the CDIV service, the interworking procedures in this clause shall be applied. + +When the MSC Server receives a REGISTER message with an InterrogateSS invoke operation for the CFU, CFB, CFNRy or CFNRc supplementary service code as described in 3GPP TS 24.082 [24], the MSC Server shall generate and send an HTTP GET request to fetch the instance of the Communication Diversion document as specified in 3GPP TS 24.604 [23]. + +When a response to the HTTP GET request is received, the MSC Server shall apply the following interworking: + +- If a 200 OK is received which includes a Communication Diversion document as defined in 3GPP TS 24.604 [23], the MSC Server shall send a RELEASE COMPLETE message as follows: + - If the Communication Diversion document indicates the call forwarding service being interrogated is active, the MSC Server shall indicate an SS-Status of provisioned and active; + - If the Communication Diversion document indicates the call forwarding service being interrogated is not active, the MSC Server shall indicate an SS-Status of provisioned but not active; + - If the Communication Diversion document contains a "target" attribute containing a TEL URI, the MSC Server shall set the ForwardedToNumber parameter to the TEL URI. +- If a non 200 OK response is received or if a 200 OK response is received which does not include a Communication Diversion document, the MSC Server shall send a RELEASE COMPLETE message with an implementation-specific error code. + +#### 5.7.4.7 Explicit Communication Transfer (ECT) + +Configuration of the ECT service involves no signalling and therefore requires no interworking at the MSC Server. + +#### 5.7.4.8 Conference (CONF) + +Configuration of the CONF service involves no signalling and therefore requires no interworking at the MSC Server. + +#### 5.7.4.9 Communication Completion Services (CCBS/CCNL/CCNR) + +##### 5.7.4.9.1 Activation/deactivation + +Activation in the IMS network as specified in 3GPP TS 24.642 [52] is performed using announcement procedures and inband interaction and no special interworking is needed. + +If the MSC Server supports interworking of deactivating all outstanding CCBS requests, the MSC Server shall upon receipt of a REGISTER message with a Deactivate all CCBS Requests Invoke operation revoke all outstanding CCBS requests using the methods in 3GPP TS 24.642 [52]. + +If the MSC receives a REGISTER message with a Deactivate specific CCBS Request the MSC Server shall if no interworking is supported respond with a RELEASE COMPLETE message with an implementation specific error code. + +##### 5.7.4.9.2 Interrogation + +If the MSC Server supports supplementary service configuration interworking for the CCBS service, the interworking procedures in this clause shall be applied. + +When the MSC Server receives a REGISTER message with an InterrogateSS invoke operation for the CCBS supplementary service code as described in 3GPP TS 24.093 [53], the MSC Server shall generate and send an HTTP GET request to fetch the instance of the Communication Completion document as specified in 3GPP TS 24.642 [52]. + +When an HTTP 200 OK response is received which includes a Communication Completion document as defined in 3GPP TS 24.642 [52], the MSC Server shall: + +- 1) if the Communication Completion document indicates the call forwarding service being interrogated is active generate an HTTP GET request to fetch an instance of the Communication Completion Request Records document as defined in 3GPP TS 24.642 [52]; + +when a response to the HTTP GET request is received the MSC server shall: + +- a) if an HTTP 200 OK is received which includes a Communication Completion Request Records document as defined in 3GPP TS 24.642 [52] where there is one or more instances of the "cc-entry" element, assign to each of these elements a CCBS Index and send a RELEASE COMPLETE message indicating an SS-Status of provisioned and include the list of outstanding CCBS requests; and + - b) if an HTTP non 200 OK response is received or if there are no instances of the "cc-entry" element, send a RELEASE COMPLETE message indicating an SS-status set to "provisioned", but there are no outstanding requests; and +- 2) if the Communication Completion document indicates the communication completion service being interrogated is not active, send a RELEASE COMPLETE message indicating an SS-Status of not provisioned. + +When an HTTP non 200 OK response is received or if an HTTP 200 OK response is received which does not include a Communication Completion document, the MSC Server shall send a RELEASE COMPLETE message with an implementation-specific error code. + +## 5.8 Handover / Relocation + +### 5.8.1 Intra-MSC Handover/Relocation + +The MSC Server applies the procedures specified in 3GPP TS 23.009 [37] for Intra-MSC handover/relocation in the CS domain. After the handover/relocation is completed, the MSC Server shall process the interworking between the NAS signalling with the SIP signalling as specified in sub-clauses 5.3 through 5.6. + +### 5.8.2 Inter-MSC Handover/Relocation + +The MSC Server applies the procedures specified in 3GPP TS 23.009 [37] for Inter-MSC handover/relocation in the CS domain. After the handover/relocation is completed, the anchor MSC Server shall process the interworking between the NAS signalling with the SIP signalling as specified in sub-clauses 5.3 through 5.6. The NAS signalling contained in the MAP messages is passed between the anchored MSC Server and the target MSC Server through the E interface as specified in 3GPP TS 29.002 [20]. + +--- + +## 6 User plane interworking + +### 6.1 General + +The following subclauses define the interworking performed by the CS-MGW between the IM CN subsystem and CS domain access. The interworking between the Mb reference point and the user plane portions of the IuCS and A reference points is specified. + +### 6.2 IuCS to Mb interworking + +#### 6.2.1 Interworking with transcoding + +Figure 6.2.1.1 shows the user plane protocol stacks for the IuCS and IM CN subsystem interworking when transcoding is required. + +![Figure 6.2.1.1: IuCS to Mb protocol stack (transcoding). The diagram shows a protocol stack for transcoding between IuCS and Mb. At the top, 'Transcoding' is indicated by a curved arrow between 'voice codec 1' and 'voice codec 2'. Below this, the stack consists of: IuFP (connected to RTP and UDP), L3 (connected to IP), L2 (connected to L2), and L1 (connected to L1). The stack is flanked by IuCS on the left and Mb on the right, with a CS-MGW in the center.](2cf3896394a2342a2b46c504ab9a8830_img.jpg) + +| | | +|------------------|------------------| +| Transcoding | | +| voice
codec 1 | voice
codec 2 | +| IuFP | RTP | +| | UDP | +| L3 | IP | +| L2 | L2 | +| L1 | L1 | + +IuCS                      CS-MGW                      Mb + +Figure 6.2.1.1: IuCS to Mb protocol stack (transcoding). The diagram shows a protocol stack for transcoding between IuCS and Mb. At the top, 'Transcoding' is indicated by a curved arrow between 'voice codec 1' and 'voice codec 2'. Below this, the stack consists of: IuFP (connected to RTP and UDP), L3 (connected to IP), L2 (connected to L2), and L1 (connected to L1). The stack is flanked by IuCS on the left and Mb on the right, with a CS-MGW in the center. + +**Figure 6.2.1.1: IuCS to Mb protocol stack (transcoding)** + +IuFP is defined in 3GPP TS 25.415 [16]. IuCS layer 2 and layer 3 are defined in 3GPP TS 25.414 [15]. The IuCS layer 1 is defined in 3GPP TS 25.411 [17]. + +## 6.2.2 Transcoder-less interworking + +Figure 6.2.2.1 shows the user plane protocol stacks for the interworking when the same codec configuration is used on the IuCS and Mb reference points and transcoding is not required. + +![Figure 6.2.2.1: IuCS to Mb protocol stack (no transcoding). The diagram shows a protocol stack for transcoder-less interworking. At the top, 'Transcoder-less user plane interworking' is shown. Below this, the stack consists of: IuFP (connected to RTP and UDP), L3 (connected to IP), L2 (connected to L2), and L1 (connected to L1). The stack is flanked by IuCS on the left and Mb on the right, with a CS-MGW in the center.](65d47e1d0e5982c00e9bd116b89e2b6a_img.jpg) + +| | | +|-----------------------------------------------|-----| +| Transcoder-less
user plane
interworking | | +| IuFP | RTP | +| | UDP | +| L3 | IP | +| L2 | L2 | +| L1 | L1 | + +IuCS                      CS-MGW                      Mb + +Figure 6.2.2.1: IuCS to Mb protocol stack (no transcoding). The diagram shows a protocol stack for transcoder-less interworking. At the top, 'Transcoder-less user plane interworking' is shown. Below this, the stack consists of: IuFP (connected to RTP and UDP), L3 (connected to IP), L2 (connected to L2), and L1 (connected to L1). The stack is flanked by IuCS on the left and Mb on the right, with a CS-MGW in the center. + +**Figure 6.2.2.1: IuCS to Mb protocol stack (no transcoding)** + +If no transcoder is inserted, the CS-MGW shall interwork procedures between the IuCS and Mb reference points as specified in 3GPP TS 29.414 [18] clause 7.4. + +## 6.3 TDM-based A-interface to Mb interworking + +### 6.3.1 Interworking with transcoding + +Figure 6.3.1.1 shows the user plane protocol stacks for the TDM-based A and Mb reference point interworking when transcoding is required. + +![Diagram of TDM-based A to Mb protocol stack with transcoding. A CS-MGW box is shown between interfaces A and Mb. On the A side, the stack consists of voice codec 1, TDM CS Bearer Channel, and L1. On the Mb side, the stack consists of voice codec 2, RTP, UDP, IP, L2, and L1. A 'Transcoding' label with a curved arrow is positioned above the box, indicating a conversion between the two voice codecs.](7ed5d5770331f31ade15439a21c31425_img.jpg) + +Diagram of TDM-based A to Mb protocol stack with transcoding. A CS-MGW box is shown between interfaces A and Mb. On the A side, the stack consists of voice codec 1, TDM CS Bearer Channel, and L1. On the Mb side, the stack consists of voice codec 2, RTP, UDP, IP, L2, and L1. A 'Transcoding' label with a curved arrow is positioned above the box, indicating a conversion between the two voice codecs. + +Figure 6.3.1.1: TDM-based A to Mb protocol stack (transcoding) + +Layer 1 for the TDM-based A-interface is defined in 3GPP TS 48.004 [19]. + +### 6.3.2 Transcoder-less interworking + +Figure 6.3.2.1 shows the user plane protocol stacks for the interworking when the same codec is used on the TDM-based A and Mb reference points and transcoding is not required. + +![Diagram of TDM-based A to Mb protocol stack without transcoding. A CS-MGW box is shown between interfaces A and Mb. The top section of the box is labeled 'Transcoder-less user plane interworking'. Below this, the stack on the A side consists of TDM CS Bearer Channel and L1. The stack on the Mb side consists of RTP, UDP, IP, L2, and L1.](367378559e35017a5e1a6f5c30798c5a_img.jpg) + +Diagram of TDM-based A to Mb protocol stack without transcoding. A CS-MGW box is shown between interfaces A and Mb. The top section of the box is labeled 'Transcoder-less user plane interworking'. Below this, the stack on the A side consists of TDM CS Bearer Channel and L1. The stack on the Mb side consists of RTP, UDP, IP, L2, and L1. + +Figure 6.3.2.1: TDM-based A to Mb protocol stack (no transcoding) + +## 6.4 IP-based A-interface to Mb interworking + +### 6.4.1 Interworking with transcoding + +Figure 6.4.1.1 shows the user plane protocol stacks for the IP-based A and Mb reference point interworking when transcoding is required. + +![Diagram of IP-based A to Mb protocol stack with transcoding. It shows a CS-MGW unit with two parallel stacks. The left stack is for the A interface and the right stack is for the Mb interface. Both stacks consist of L1, L2, IP, UDP, RTP, and Voice Codec layers. A 'Transcoding' label with a double-headed arrow is positioned above the Voice Codec layers, indicating conversion between Voice Codec 1 and Voice Codec 2.](3337af75dfee8af7687b4f49914d6c93_img.jpg) + +| | | +|---------------|---------------| +| Transcoding | | +| Voice Codec 1 | Voice Codec 2 | +| RTP | RTP | +| UDP | UDP | +| IP | IP | +| L2 | L2 | +| L1 | L1 | + +A CS-MGW Mb + +Diagram of IP-based A to Mb protocol stack with transcoding. It shows a CS-MGW unit with two parallel stacks. The left stack is for the A interface and the right stack is for the Mb interface. Both stacks consist of L1, L2, IP, UDP, RTP, and Voice Codec layers. A 'Transcoding' label with a double-headed arrow is positioned above the Voice Codec layers, indicating conversion between Voice Codec 1 and Voice Codec 2. + +Figure 6.4.1.1: IP-based A to Mb protocol stack (transcoding) + +The IP-based A-interface user plane transport is defined in 3GPP TS 48.103 [38]. + +## 6.4.2 Transcoder-less interworking + +Figure 6.4.2.1 shows the user plane protocol stacks for the interworking when the same codec is used on the IP-based A and Mb reference points and transcoding is not required. + +![Diagram of IP-based A to Mb protocol stack without transcoding. It shows a CS-MGW unit with two parallel stacks. The left stack is for the A interface and the right stack is for the Mb interface. Both stacks consist of L1, L2, IP, UDP, RTP, and a 'Transcoder-less user plane interworking' layer. No transcoding is indicated between the two sides.](39536a630fa74c3bcfd1670ee2152809_img.jpg) + +| | | +|-----------------------------------------|-----| +| Transcoder-less user plane interworking | | +| RTP | RTP | +| UDP | UDP | +| IP | IP | +| L2 | L2 | +| L1 | L1 | + +A CS-MGW Mb + +Diagram of IP-based A to Mb protocol stack without transcoding. It shows a CS-MGW unit with two parallel stacks. The left stack is for the A interface and the right stack is for the Mb interface. Both stacks consist of L1, L2, IP, UDP, RTP, and a 'Transcoder-less user plane interworking' layer. No transcoding is indicated between the two sides. + +Figure 6.4.2.1: IP-based A to Mb protocol stack (no transcoding) + +The IP-based A-interface user plane transport is defined in 3GPP TS 48.103 [38]. + +--- + +# 7 MSC Server – CS-MGW interaction + +## 7.1 Mobile originated call + +### 7.1.1 CS-MGW selection + +The MSC Server shall select a CS-MGW for the bearer connection before it performs the access bearer assignment or the network side connection point reservation. + +## 7.1.2 IMS session side establishment + +### 7.1.2.1 General + +The MSC Server shall either select bearer characteristics or request the CS-MGW to select and provide the bearer characteristics for the network side session before sending the INVITE request. The MSC Server shall use the Reserve RTP Connection Point procedure as defined in 3GPP TS 23.205 [39] and in 3GPP TS 29.232 [11], with additional information elements as specified in the present subclause. + +Within this procedure, the MSC Server shall indicate the received speech codecs from the UE and the MSC Server may indicate some configured speech codec(s) to the CS-MGW and request a local IP address and UDP port from the CS-MGW and the MSC Server may also indicate that the IP interface type is for MboIP as defined in 3GPP TS 23.205 [39] and in 3GPP TS 29.232 [11], with additional information elements as specified in the present subclause. The local IP address and UDP port are used by the CS-MGW to receive user plane data. + +The CS-MGW shall reply to the MSC Server with the selected local speech codec(s) and the selected local IP address and UDP port(s). + +After the succeeding node has provided the SDP answer, the MSC Server uses the Configure RTP Resources procedure as defined in 3GPP TS 29.232 [11] to request the CS-MGW to configure the bearer. + +### 7.1.2.2 Additions to Reserve RTP Connection Point Procedure + +This procedure is used to reserve an RTP bearer termination. The Reserve RTP Connection Point procedure defined in 3GPP TS 23.205 [39] shall be applied with additional information elements as defined in table 7.1.2.2.1. + +**Table 7.1.2.2.1: Additions to Reserve RTP Connection Point Procedure** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|----------------------------------|---------------|----------------------------|------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Reserve RTP Connection Point | (G)MSC-Server | Priority information | O | This information element requests the CS-MGW to apply priority treatment for the terminations and bearer connections in the specified context. | +| | | ECN Enable | O | This information element requests the CS-MGW to apply ECN procedures. | +| | | ECN Initiation Method | C | This information element specifies the ECN Initiation method and requests the CS-MGW to perform IP header settings as an ECN endpoint. It may be included only if ECN is enabled. | +| | | Notify ECN Failure Event | C | This information element requests a notification if an ECN failure occurs. It may only be supplied if ECN is enabled. | +| | | ICE password request | O | This information element is present if MSC Server requests an ICE password. | +| | | ICE Ufrag request | O | This information element is present if MSC Server requests an ICE ufrag. | +| | | ICE host candidate request | O | This information element is present if MSC Server requests an ICE host candidate. | +| | | STUN server request | O | This information element is present if MSC Server requests the CS-MGW to answer STUN connectivity checks for ICE. | +| | | SDPCapNeg configuration | O | This information element provides SDPCapNeg configuration(s) using as "a=acap", "a=tcap", "a=pcfg" and "a=acfg" SDP attributes. | +| Reserve RTP Connection Point Ack | MGW | ICE password | C | This information element shall be present only if it was contained in the request. It indicates the ICE password assigned by the CS-MGW. | +| | | ICE Ufrag | C | This information element shall be present only if it was contained in the request. It indicates the ICE Ufrag assigned by the CS-MGW. | +| | | ICE host candidate | C | This information element shall be present only if it was contained in the request. It indicates the ICE host candidate assigned by the CS-MGW. | +| | | ICE lite indication | C | This information element shall be present only if an ICE host candidate request was contained in the request, and the CS-MGW supports ICE lite, but not full ICE. It indicates that the CS-MGW only supports ICE lite. | +| | | SDPCapNeg configuration | C | This information element shall be present only if it was contained in the request. It provides SDPCapNeg configuration(s) using as "a=acap", "a=tcap", "a=pcfg" and "a=acfg" SDP attributes. | + +### 7.1.2.3 Additions to Configure RTP Connection Point Procedure + +This procedure is used to configure or reconfigure an RTP bearer termination. The Configure RTP Connection Point procedure defined in 3GPP TS 23.205 [39] shall be applied with additional information elements as defined in table 7.1.2.3.1. + +Table 7.1.2.3.1: Additions to Configure RTP Connection Point Procedure + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|------------------------------------|---------------|--------------------------------------|------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Configure RTP Connection Point | (G)MSC-Server | Allowed RTCP APP message types | O | This information element is present if MSC server allows the MGW to send RTCP APP packets of the indicated types defined in TS 26.114 [28]. The MGW shall not send other RTCP APP packets. If the parameter is not supplied, the MGW shall not send any RTCP APP packets. | +| | | ECN Enable | O | This information element requests the CS-MGW to apply ECN procedures. | +| | | ECN Initiation Method | C | This information element specifies the ECN Initiation method and requests the CS-MGW to perform IP header settings as an ECN endpoint. It may be included only if ECN is enabled. | +| | | Notify ECN Failure Event | C | This information element requests a notification if an ECN failure occurs. It may only be supplied if ECN is enabled. | +| | | ICE Connectivity Check | C | This information element requests the CS-MGW to perform ICE connectivity check as defined by IETF RFC 5245 [60]. It is only applicable for full ICE. | +| | | Notify ICE Connectivity Check Result | C | This information element requests a notification of ICE connectivity check result. It is only applicable for full ICE. | +| | | Notify New Peer Reflexive Candidate | C | This information element requests a notification of new peer reflexive candidate was discovered during a connectivity check. It is only applicable for full ICE. | +| | | Additional ICE Connectivity Check | C | This information element requests the CS-MGW to perform additional ICE connectivity check as defined by IETF RFC 5245 [60]. It is only applicable for full ICE. | +| | | ICE received candidate | O | This information element is present if MSC Server indicates a received candidate for ICE. | +| | | ICE received password | O | This information element is present if MSC Server indicates a received password for ICE. | +| | | SDPCapNeg configuration | O | This information element provides SDPCapNeg configuration(s) using as "a=acap", "a=tcap", "a=pcfg" and "a=acfg" SDP attributes. | +| Configure RTP Connection Point Ack | MGW | | | | +| | | | | | + +## 7.1.3 Access bearer establishment + +### 7.1.3.1 General + +The way the MSC Server media gateway interaction is carried out depends on the characteristics of the access bearer network. + +### 7.1.3.2 lu interface on IP + +The MSC Server and the CS-MGW shall act in accordance with clause 6.1.3 in 3GPP TS 23.205 [39] and apply the coding in accordance with 3GPP TS 29.232 [11]. + +### 7.1.3.3 A interface over IP + +The MSC Server and the CS-MGW shall act in accordance with clause 6.1.5 in 3GPP TS 23.205 [39] and apply the coding in accordance with 3GPP TS 29.232 [11]. + +### 7.1.3.4 A interface over TDM + +The MSC Server and the CS-MGW shall act in accordance with clause 6.1.1.4 in 3GPP TS 23.205 [39] and apply the coding in accordance with 3GPP TS 29.232 [11]. + +### 7.1.3.5 lu over UTRAN and GERAN + +The MSC Server and the CS-MGW shall act in accordance with clause 6.1.1.4 in 3GPP TS 23.205 [39] and apply the coding in accordance with 3GPP TS 29.232 [11]. + +## 7.1.4 Apply ringing tone + +If the condition as defined in clause 5.3.5 is fulfilled the MSC Server shall instruct the CS-MGW to send ringing tone towards the calling party. In this case the MSC Server shall use the Send Tone procedure in accordance with 3GPP TS 23.205 [39] and 3GPP TS 29.232 [11]. + +If the MSC Server wishes to stop sending the ringing tone e.g. due to the receipt of a 200 OK response to the INVITE request the MSC Server shall apply the Stop Tone procedure as defined in 3GPP TS 23.205 [39] and 3GPP TS 29.232 [11]. + +## 7.1.5 Through connection + +If the MSC Server wants to configure the CS-MGW so that the bearer will be through-connected in the backward direction the MSC Server shall: + +- use Change Through-Connection procedure as defined in 3GPP TS 29.232 [11] during any one of the Prepare Bearer and Reserve Circuit procedures as defined in 3GPP TS 29.232 [11]; or +- use Configure the RTP Connection Point procedure as defined in 3GPP TS 29.232 [11] during Prepare IP bearer procedure as defined in 3GPP TS 29.232 [11]. + +If the MSC Server wants to configure the CS-MGW so that the bearer will be both-way through connected the MSC Server shall use Change Through-Connection procedure as defined in 3GPP TS 29.232 [11]. + +## 7.1.5a Handling of Forking + +The procedures described in subclauses 7.1.1 to 7.1.6 shall be applied with the addition that the MSC Server and the CS-MGW shall act in accordance with subclauses 9.2.3.4.1 to 9.2.3.4.4 in 3GPP TS 29.163 [46]. + +NOTE: For the references to 3GPP TS 29.163 [46], the O-MGCF and I-MGCF in 3GPP TS 29.163 [46] is to be understood as MSC Server, the IM-MGW is to be understood as CS-MGW, and the Configure IMS Resources procedure is to be understood as Configure RTP Resources procedure. + +## 7.1.6 Failure handling in MSC server + +If any procedure between the MSC Server and the CS-MGW has not completed successfully or the MSC Server receives a Bearer Released procedure from the CS-MGW the procedure in accordance with clause 6.1.1.12 of 3GPP TS 23.231 [40] and 3GPP TS 29.232 [11] shall be applied. + +## 7.2 Mobile terminated call + +### 7.2.1 CS-MGW selection + +The MSC Server shall select an CS-MGW for the bearer connection before it performs the network side bearer establishment or the access bearer assignment. The selection of the CS-MGW does not take place before the call proceeding has been received by the MSC Server. + +### 7.2.2 Network side session establishment + +#### 7.2.2.1 General + +The MSC Server shall request the CS-MGW to prepare for the network side session establishment using the Reserve and Configure RTP Connection Point procedure as specified in 3GPP TS 23.205 [39] and 3GPP TS 29.232 [11], with additional information elements as specified in the present subclause. Within this procedure, the MSC Server shall indicate the received speech codecs from the remote UE and request a local IP address and UDP port from the CS-MGW and the MSC Server may also indicate that the IP interface type is for MboIP as defined in 3GPP TS 29.232 [11]. The local IP address and UDP ports are used by the CS-MGW to receive user plane data. The MSC Server shall include the local IP address and UDP port number in the SDP answer for the selected codec. + +#### 7.2.2.2 Additions to Reserve and Configure RTP Connection Point + +This procedure is used to reserve and configure an RTP bearer termination. The Reserve and Configure RTP Connection Point procedure defined in 3GPP TS 23.205 [39] shall be applied with additional information elements as defined in table 7.2.2.2.1. + +**Table 7.2.2.2.1: Additions to Reserve and Configure RTP Connection Point Procedure** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|------------------------------------------------|---------------|--------------------------------------|------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Reserve and Configure RTP Connection Point | (G)MSC-Server | Allowed RTCP APP message types | O | This information element is present if MSC server allows the MGW to send RTCP APP packets of the indicated types defined in TS 26.114 [28]. The MGW shall not send other RTCP APP packets. If the parameter is not supplied, the MGW shall not send any RTCP APP packets. | +| | | Priority information | O | This information element requests the CS-MGW to apply priority treatment for the terminations and bearer connections in the specified context. | +| | | ECN Enable | O | This information element requests the CS-MGW to apply ECN procedures and IP header settings as an ECN endpoint. | +| | | ECN Initiation Method | C | This information element specifies the ECN Initiation method and requests the CS-MGW to perform IP header settings as an ECN endpoint. It may be included only if ECN is enabled. | +| | | Notify ECN Failure Event | C | This information element requests a notification if an ECN failure occurs. It may only be supplied if ECN is enabled. | +| | | STUN server request | O | This information element is present if MSC Server requests the CS-MGW to answer STUN connectivity checks for ICE. | +| | | ICE Connectivity Check | C | This information element requests the CS-MGW to perform ICE connectivity check as defined by IETF RFC 5245 [60]. It is only applicable for full ICE. | +| | | Notify ICE Connectivity Check Result | C | This information element requests a notification of ICE connectivity check result. It is only applicable for full ICE. | +| | | Notify New Peer Reflexive Candidate | C | This information element requests a notification of new peer reflexive candidate was discovered during a connectivity check. It is only applicable for full ICE. | +| | | ICE password request | O | This information element is present if MSC Server requests an ICE password. | +| | | ICE Ufrag request | O | This information element is present if MSC Server requests an ICE ufrag. | +| | | ICE host candidate request | O | This information element is present if MSC Server requests an ICE host candidate. | +| | | ICE received candidate | O | This information element is present if MSC Server indicates a received candidate for ICE. | +| | | ICE received password | O | This information element is present if MSC Server indicates a received password for ICE. | +| | | ICE received Ufrag | O | This information element is present if MSC Server indicates a received Ufrag for ICE. | +| | | SDPCapNeg configuration | O | This information element provides SDPCapNeg configuration(s) using as "a=acap", "a=tcap", "a=pcfg" and "a=acfg" SDP attributes. | +| Reserve and Configure RTP Connection Point Ack | MGW | ICE password | C | This information element shall be present only if it was contained in the request. It indicates the ICE password assigned by the CS-MGW. | + +| | | | | +|--|-------------------------|---|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | ICE Ufrag | C | This information element shall be present only if it was contained in the request. It indicates the ICE Ufrag assigned by the CS-MGW. | +| | ICE host candidate | C | This information element shall be present only if it was contained in the request. It indicates the ICE host candidate assigned by the CS-MGW. | +| | ICE lite indication | C | This information element shall be present only if an ICE host candidate request was contained in the request, and the CS-MGW supports ICE lite, but not full ICE. It indicates that the CS-MGW only supports ICE lite. | +| | SDPCapNeg configuration | C | This information element shall be present only if it was contained in the request. It provides SDPCapNeg configuration(s) using as "a=acap", "a=tcap", "a=pcfg" and "a=acfg" SDP attributes. | + +## 7.2.3 Access bearer assignment + +### 7.2.3.1 General + +The way the MSC Server-CS-MGW interaction is carried out depends on the characteristics of the access bearer network. + +#### 7.2.3.2 Iu interface on IP + +The MSC Server and the CS-MGW shall act in accordance with clause 6.2.3 in 3GPP TS 23.205 [39] and apply the coding in accordance with 3GPP TS 29.232 [11]. + +#### 7.2.3.3 A interface over IP + +The MSC Server and the CS-MGW shall act in accordance with clause 6.2.4 in 3GPP TS 23.205 [39] and apply the coding in accordance with 3GPP TS 29.232 [11]. + +#### 7.2.3.4 A interface over TDM + +The MSC Server and the CS-MGW shall act in accordance with clause 6.2.2.2.4 in 3GPP TS 23.205 [39] and apply the coding in accordance with 3GPP TS 29.232 [11]. + +#### 7.2.3.5 Iu over UTRAN and GERAN + +The MSC Server and the CS-MGW shall act in accordance with clause 6.2.2.2.4 in 3GPP TS 23.205 [39] and apply the coding in accordance with 3GPP TS 29.232 [11]. + +## 7.2.4 Apply ringing tone + +If the condition as defined in clause 5.4.7 is fulfilled the MSC Server shall instruct the CS-MGW to send ringing tone towards the calling party. In this case the MSC Server shall use the Send Tone procedure in accordance with 3GPP TS 23.205 [39] and 3GPP TS 29.232 [11]. + +If the MSC Server wishes to stop sending the ringing tone, e.g. due to receipt of the CONNECT message, the MSC Server shall apply the Stop Tone procedure as defined in 3GPP TS 23.205 [39] and 3GPP TS 29.232 [11]. + +## 7.2.5 Through connection + +If the MSC Server wants to configure the CS-MGW so that the bearer will not be through-connected the MSC Server shall: + +- use Change Through-Connection procedure as defined in 3GPP TS 29.232 [11] during any one of the Prepare Bearer and Reserve Circuit procedures as defined in 3GPP TS 29.232 [11]; or + +- use Configure the RTP Connection Point procedure as defined in 3GPP TS 29.232 [11] during Prepare IP bearer procedure as defined in 3GPP TS 29.232 [11]. + +If the MSC Server wants to configure the CS-MGW so that the bearer will be both-way through connected the MSC Server shall use the Change Through-Connection procedure as defined in 3GPP TS 29.232 [11]. + +## 7.2.6 Announcement + +If the MSC Server wants to provide an announcement, e.g. when the condition in clause 5.4.7 is fulfilled, the MSC Server shall instruct the CS-MGW to send an announcement. In this case the MSC Server shall use the Play Announcement procedure in accordance with 3GPP TS 23.205 [39] and 3GPP TS 29.232 [11]. + +If the MSC Server wishes to stop the sending of an announcement the MSC Server shall apply the Stop Announcement procedure as defined in 3GPP TS 23.205 [39] and 3GPP TS 29.232 [11]. + +## 7.2.7 Failure handling in the MSC server + +If any procedure between the MSC Server and the CS-MGW has not completed successfully or the MSC Server receives a Bearer Released procedure from the CS-MGW the procedure in accordance with clause 6.2.1.3.13 of 3GPP TS 23.231 [40] and 3GPP TS 29.232 [11] shall be applied. + +# 7.2A Notification Procedures + +## 7.2A.1 General information + +This subclause contains procedures common to mobile originated and mobile terminated calls which are not defined in 3GPP TS 23.205 [39] but are applicable to the MSC Server enhanced for ICS and the CS-MGW. + +## 7.2A.2 ECN Failure Indication + +This procedure is used to report ECN related errors (see 3GPP TS 29.163 [46] clause 9.2.11.1c). + +**Table 7.2A.2.1: Procedures between MSC Server and CS-MGW: ECN Failure Indication** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|----------------------------|------------|--------------------------|------------------------------|--------------------------------------------------------------------------------------------------| +| ECN Failure Indication | CS-MGW | Context | M | This information element indicates the context for the bearer termination. | +| | | Bearer Termination | M | This information element indicates the bearer termination for which the ECN failure is reported. | +| | | ECN Failure Indication | M | This IE indicates an ECN failure event. | +| ECN Failure Indication Ack | MSC Server | Context | M | This information element indicates the context where the command was executed. | +| | | Bearer Termination | M | This information element indicates the bearer termination where the command was executed. | + +### 7.2A.3 ICE Connectivity Check Result Notification + +This procedure is used to report ICE connectivity check result for Full ICE. + +**Table 7.2A.3.1: Procedures between MSC Server and CS-MGW: ICE Connectivity Check Result Notification** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|------------------------------------------------|------------|-------------------------------|------------------------------|--------------------------------------------------------------------------------------------------------------------| +| ICE Connectivity Check Result Notification | CS-MGW | Context | M | This information element indicates the context for the bearer termination. | +| | | Bearer Termination | M | This information element indicates the bearer termination for which the ICE Connectivity Check Result is reported. | +| | | ICE Connectivity Check Result | M | This information element indicates an ICE Connectivity Check Result event. | +| ICE Connectivity Check Result Notification Ack | MSC Server | Context | M | This information element indicates the context where the command was executed. | +| | | Bearer Termination | M | This information element indicates the bearer termination where the command was executed. | + +### 7.2A.4 ICE New Peer Reflexive Candidate Notification + +This procedure is used to report ICE new peer reflexive candidate for Full ICE. + +**Table 7.2A.4.1: Procedures between MSC Server and CS-MGW: ICE New Peer Reflexive Candidate Notification** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|---------------------------------------------------|------------|----------------------------------|------------------------------|----------------------------------------------------------------------------------------------------------------------| +| ICE New Peer Reflexive Candidate Notification | CS-MGW | Context | M | This information element indicates the context for the bearer termination. | +| | | Bearer Termination | M | This information element indicates the bearer termination for which the ICE New Peer Reflexive Candidate is reported | +| | | ICE New Peer Reflexive Candidate | M | This information element indicates an ICE New Peer Reflexive Candidate event. | +| ICE New Peer Reflexive Candidate Notification Ack | MSC Server | Context | M | This information element indicates the context where the command was executed. | +| | | Bearer Termination | M | This information element indicates the bearer termination where the command was executed. | + +## 7.3 Call clearing + +### 7.3.1 Clearing received from the network + +#### 7.3.1.1 Access bearer clearing + +Once the call clearing and the release of the associated radio resources have been completed, the MSC Server releases any CS-MGW allocated resources for the access side. If any resources were seized in the CS-MGW, the MSC Server uses the Release Termination procedure as specified in 3GPP TS 29.232 [11] to request the CS-MGW to remove the access side bearer termination. + +#### 7.3.1.2 Network side clearing + +If the MSC Server requires to release resources due to the receipt of a BYE or CANCEL request or a response including a failure indication from the network the MSC Server shall act in accordance with clause 7.2.6 in 3GPP TS 23.231 [40] and 3GPP TS 29.232 [11]. + +## 7.3.2 Clearing received from the user + +### 7.3.2.1 Access bearer clearing + +Once the call clearing and the release of the associated radio resources have been completed, the MSC Server releases any CS-MGW allocated resources for the access side. If any resources were seized in the CS-MGW, the MSC Server uses the Release Termination procedure as specified in 3GPP TS 29.232 [11] to request the CS-MGW to remove the access side bearer termination. + +### 7.3.2.2 Network side clearing + +If the MSC Server requires to release resources due to the receipt of a BYE or CANCEL request or a response including a failure indication from the originating or terminating UE the MSC Server shall act in accordance with clause 7.2.6 in 3GPP TS 23.231 [40] and 3GPP TS 29.232 [11]. + +## 7.3.3 Call clearing received from the CS-MGW + +### 7.3.3.1 Bearer released received on the access side + +After the MSC Server has received the Bearer Released procedure from the CS-MGW on the access side, the MSC Server shall release the access resources as described in 3GPP TS 24.008 [3]. If the call is already established towards the network side, call clearing to the network side is performed as described in clause 5.5.3. + +### 7.3.3.2 Bearer released received on the network side + +After the MSC Server has received the Bearer Released procedure from the CS-MGW on the network side, the MSC Server shall clear the call to the network side as described in clause 5.5.3 and clear the call to the UE as described in 3GPP TS 24.008 [3]. + +## 7.4 Call independent procedures + +The MSC Server and the CS-MGW are involved in a number of procedures which are not related to the setting up and clearing of calls. The MSC Server and the CS-MGW shall comply with the requirements stated in the different subclauses 10.1 - 10.10 of 3GPP TS 23.205 [39] and subclauses 10.12 - 10.16 of 3GPP TS 23.205 [39]. + +## 7.5 Explicit Congestion Notification + +An MSC Server and a CS-MGW may support Multimedia Telephony using Explicit Congestion Notification (see IETF RFC 3168 [48], IETF RFC 6679 [49], and 3GPP TS 26.114 [28]), and may then act as an ECN endpoint to enable ECN with a local ECN-capable terminal within a local network that properly handles ECN-marked packets. + +The ECN procedures described in 3GPP TS 29.163 [46], clause 9.2.11, for MGCF and IM-MGW are then applicable for MSC Server and the CS-MGW. + +## 7.6 Multimedia Priority Service (MPS) Support + +The Multimedia Priority Service (MPS) is specified in 3GPP TS 22.153 [54]. An MSC Server and a CS-MGW may support the priority treatment of a call/session identified as an MPS call/session. + +The MPS procedures described in 3GPP TS 29.163 [46], clause 9.4, for MGCF and IM-MGW are then applicable for MSC Server and the CS-MGW. + +## 7.7 Interactive Connectivity Establishment + +An MSC Server and a CS-MGW may support ICE functionality as specified in IETF RFC 5245 [60] and 3GPP TS 24.229 [2]. + +Support of full ICE functionality is optional, but if ICE is supported, the MSC Server and the CS-MGW shall at least support ICE lite as specified in IETF RFC 5245 [60]. + +The requirements as described in clause 9.2.12 of 3GPP TS 29.163 [46] for MGCF and IM-MGW, apply to the MSC Server and the CS-MGW when the ICE procedures are supported. + +## 7.8 Codec Parameters Handling + +### 7.8.1 Handling of common codec parameters + +The requirements as described in clause 9.2.13.1 of 3GPP TS 29.163 [46] for the MGCF and the IM-MGW, apply to the MSC Server and the CS-MGW. + +### 7.8.2 EVS speech codec + +The Enhanced Voice Services (EVS) speech codec is defined in 3GPP TS 26.441 [61]. Its RTP payload type is defined in 3GPP TS 26.445 [62], and procedures for its usage as IMS Multimedia Telephony speech codec are defined in 3GPP TS 26.114 [28]. + +The MSC Server and the CS-MGW may support transcoding to and from the EVS speech codec. If they do so, the requirements as described in clause 9.2.13.2 of 3GPP TS 29.163 [46] for the MGCF and the IM-MGW, apply to the MSC Server and the CS-MGW. + +## 7.9 SDP Capability Negotiation (SDPCapNeg) + +The SDP Capability Negotiation (SDPCapNeg) as specified in IETF RFC 5939 [63] is adopted as an optional functionality to negotiate capabilities and their associated configurations according to 3GPP TS 24.229 [2]. + +The SDPCapNeg requirements and procedures described in subclause 5.2.23 of 3GPP TS 23.333 [64] for MRFC and MRFP are then applicable for MSC Server and the CS-MGW. + +## Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|--------|-----------|------|-----|-----------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 06/2013 | CT#60 | CP-130343 | 0073 | 3 | Handling of dialed digits home-local number | 11.6.0 | 12.0.0 | +| 06/2013 | CT#60 | CP-130343 | 0078 | 2 | Identity mapping correction | 11.6.0 | 12.0.0 | +| 06/2013 | CT#60 | CP-130343 | 0083 | 1 | Mapping between cause IE and SIP status code when timer expires | 11.6.0 | 12.0.0 | +| 06/2013 | CT#60 | CP-130343 | 0084 | 1 | Mapping between cause values and SIP status code related to not implemented features/services | 11.6.0 | 12.0.0 | +| 06/2013 | CT#60 | CP-130343 | 0085 | 1 | Mapping of CUG specific cause values | 11.6.0 | 12.0.0 | +| 06/2013 | CT#60 | CP-130343 | 0086 | 1 | Mapping of cause value 8 "operator determined barring" | 11.6.0 | 12.0.0 | +| 09/2013 | CT#61 | CP-130558 | 0088 | | Identity mapping correction | 12.0.0 | 12.1.0 | +| 06/2014 | CT#64 | CP-140353 | 0095 | - | Conference creation | 12.1.0 | 12.2.0 | +| 06/2014 | CT#64 | CP-140354 | 0100 | - | Removal of CDIVN | 12.1.0 | 12.2.0 | +| 06/2014 | CT#64 | CP-140385 | 0089 | 1 | Support of SIP precondition mechanism by MSC server | 12.1.0 | 12.2.0 | +| 06/2014 | TSG#64 | CP-140396 | 0090 | 2 | ICE support for MSC Server enhanced for ICS | 12.1.0 | 12.2.0 | +| 09/2014 | CT-65 | CP-140542 | 0101 | - | ICE: reference correction | 12.2.0 | 12.3.0 | +| 09/2014 | CT-65 | CP-140554 | 0102 | 3 | Sending of PROGRESS during aSRVCC | 12.2.0 | 12.3.0 | +| 12/2014 | CT-66 | CP-140912 | 0103 | 2 | Update of protocol stacks and associated text for IuCS to Mb interworking | 12.3.0 | 12.4.0 | +| 12/2014 | CT-66 | CP-140919 | 0104 | 3 | Sending of PROGRESS upon SIP UPDATE message | 12.3.0 | 12.4.0 | +| 12/2014 | CT-66 | CP-140933 | 0105 | 3 | Adding support for EVS codec | 12.3.0 | 12.4.0 | +| 06/2015 | CT-68 | CP-150337 | 0111 | 2 | Correcting rules condition for CFU service | 12.4.0 | 12.5.0 | +| 06/2015 | CT-68 | CP-150364 | 0112 | 2 | Notify UE remote party state after SRVCC | 12.5.0 | 13.0.0 | +| 09/2015 | CT-69 | CP-150484 | 0113 | 1 | Clarifying clearing initiated by the mobile | 13.0.0 | 13.1.0 | +| 09/2015 | CT-69 | CP-150484 | 0114 | 1 | Autonomous clearing initiated by the MSC Server | 13.0.0 | 13.1.0 | +| 09/2015 | CT-69 | CP-150463 | 0120 | - | Missing 4xx final responses | 13.0.0 | 13.1.0 | +| 09/2015 | CT-69 | CP-150463 | 0126 | 2 | Mapping to/from Q.850 cause codes | 13.0.0 | 13.1.0 | +| 12/2015 | CT-70 | CP-150667 | 0127 | 5 | Stage 2 Mc supporting of SDP capability negotiation | 13.1.0 | 13.2.0 | +| 12/2015 | CT-70 | CP-150660 | 0128 | 1 | Removing a conference participant | 13.1.0 | 13.2.0 | +| Change history | | | | | | | | +| Date | TSG # | TSG Doc. | CR | Rev | Cat | Subject/Comment | New | +| 03/2016 | CT#71 | CP-160105 | 0130 | 1 | F | Removal of references to TS 26.235 | 13.3.0 | +| 03/2017 | CT#75 | CP-170085 | 0131 | - | B | Reception of 666 (Unwanted) response | 14.0.0 | +| 06/2017 | CT#76 | CP-171131 | 0132 | 1 | F | Mapping of additional 4xx response codes for SPECTRE | 14.1.0 | +| 06/2017 | CT#76 | CP-171129 | 0133 | 3 | B | ICS: Interworking procedures of password | 14.1.0 | +| 06/2017 | CT#76 | CP-171134 | 0134 | 2 | F | Mapping SIP Reason header field cause "Call completed elsewhere" to a cause information element in the DISCONNECT message | 14.1.0 | +| 06/2017 | CT#76 | CP-171131 | 0135 | 1 | F | Reference update: draft-ietf-sipcore-status-unwanted | 14.1.0 | +| 06/2017 | CT#76 | CP-171134 | 0136 | 1 | F | Completion of "Reserve RTP Connection Point", "Reserve and Configure RTP Connection Point" and "Configure RTP Connection Point" procedures. | 14.1.0 | +| 06/2017 | CT#76 | CP-171129 | 0137 | 2 | B | Registration of password for ICS | 14.1.0 | +| 06/2017 | CT#76 | CP-171134 | 0138 | - | F | Response-Source header field handling completion | 14.1.0 | +| 09/2017 | CT#77 | CP-172049 | 0139 | - | F | Reference update from draft-ietf-sipcore-status-unwanted-06 to RFC 8197 | 14.2.0 | +| 12/2017 | CT#78 | CP-172049 | 0140 | - | F | Interworking of cause location parameter | 14.3.0 | +| 12/2017 | CT#78 | CP-173104 | 0141 | - | F | Call rejection when IMSI is detached | 15.0.0 | +| 12/2017 | CT#78 | CP-173104 | 0142 | 1 | B | Call rejection when VLR data cannot be retrieved | 15.0.0 | +| 03/2018 | CT#79 | CP-180044 | 0144 | - | A | Reference update: RFC 8224 | 15.1.0 | +| 03/2018 | CT#79 | CP-180042 | 0146 | - | A | Reference Update for the ISUP location parameter | 15.1.0 | +| 03/2018 | CT#79 | CP-180042 | 0148 | - | A | Correction of incorrect reference numbering | 15.1.0 | +| 09/2018 | CT#81 | CP-182018 | 0152 | - | A | Screening indicator values | 15.2.0 | +| 09/2018 | CT#81 | CP-182017 | 0153 | - | F | Mapping of calling identity number verification status | 15.2.0 | +| 09/2018 | CT#81 | CP-182024 | 0155 | - | A | Reference Update for the ISUP Q.850 location parameter | 15.2.0 | +| 03/2019 | CT#83 | CP-190126 | 0157 | 2 | A | Reference Update for the ISUP Cause Location Parameter Draft | 15.3.0 | +| 06/2019 | CT#84 | CP-191094 | 0159 | - | A | Reference Update for the ISUP Cause Location Parameter Draft | 15.4.0 | +| 09/2019 | CT#85 | CP-192166 | 0161 | 1 | A | Reference Update RFC8606 | 15.5.0 | +| 2020-07 | SA#88e | - | - | - | | Update to Rel-16 version (MCC) | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29303/06291c5328a7a4335d41a48850a3a207_img.jpg b/marked/Rel-16/29_series/29303/06291c5328a7a4335d41a48850a3a207_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d9502e9ad9dd7fcf16e5b395ce4d6671453bf911 --- /dev/null +++ b/marked/Rel-16/29_series/29303/06291c5328a7a4335d41a48850a3a207_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0be8a25b0d393dedec501e8cbba6cd15e450436cbb125d32d23aebf201d94995 +size 70097 diff --git a/marked/Rel-16/29_series/29303/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-16/29_series/29303/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..bd218ff2e9a51426300af9c2a8928dff34faa856 --- /dev/null +++ b/marked/Rel-16/29_series/29303/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0dedbb210a8cbd8105ea585c016f8798489cbbea4b64e526a59558f4cb77fea0 +size 10081 diff --git a/marked/Rel-16/29_series/29303/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-16/29_series/29303/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..603045f5a2ca16719d91e02b0a682f68fd708e52 --- /dev/null +++ b/marked/Rel-16/29_series/29303/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8dde84e31e5f488747155f9f49fae93d5b00c4c053f6ca2fd7074861988c23b2 +size 5763 diff --git a/marked/Rel-16/29_series/29303/raw.md b/marked/Rel-16/29_series/29303/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..8b9dc4511d1cb461f5cea75577e27d568303ae8a --- /dev/null +++ b/marked/Rel-16/29_series/29303/raw.md @@ -0,0 +1,3819 @@ + + +# 3GPP TS 29.303 V16.4.0 (2021-03) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Domain Name System Procedures; Stage 3; (Release 16)** + +![5G logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The 5G logo, featuring the text "5G" in a bold, black, sans-serif font. Above the "5G" text are three green curved lines representing signal waves. + +5G logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, featuring the text "3GPP" in a bold, black, stylized font. Below the "3GPP" text is a red signal icon consisting of three curved lines. Below the icon, the text "A GLOBAL INITIATIVE" is written in a smaller, black, sans-serif font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + + + +## --- **Copyright Notification** + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2021, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|----------------------------------------------------------------------------------------------------------------------|----| +| Foreword ..... | 6 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions, symbols and abbreviations ..... | 8 | +| 3.1 Definitions..... | 8 | +| 3.2 Abbreviations ..... | 9 | +| 4 General DNS Based Node Selection Description ..... | 9 | +| 4.1 Resource Records..... | 9 | +| 4.1.1 A and AAAA ..... | 9 | +| 4.1.2 NAPTR..... | 9 | +| 4.1.3 SRV ..... | 10 | +| 4.2 Selecting Domain Names..... | 10 | +| 4.3 Identifying Nodes, Services and Protocols ..... | 10 | +| 4.3.1 IETF RFC 3958 Service and Protocol service names for 3GPP ..... | 10 | +| 4.3.2 Identification of canonical node names..... | 10 | +| 4.3.3 Services from node names or other FQDN identifying a service..... | 12 | +| 4.3.3.1 General..... | 12 | +| 4.3.3.2 Procedure ..... | 12 | +| 4.3.3.2.1 S-NAPTR Procedure - General..... | 12 | +| 4.3.3.2.2 S-NAPTR Procedure for a canonical node name..... | 13 | +| 4.3.3.3 Services of a PGW from PGW node name (or collocated PGW/GGSN)..... | 13 | +| 4.3.3.4 Services of a MME from MME node name (or GUTI or 5G-GUTI)..... | 14 | +| 4.3.3.5 Services of an SGSN from a P-TMSI..... | 15 | +| 4.3.3.6 Services of an SGW from SGW canonical node name ..... | 16 | +| 4.3.3.7 Services of an MSC Server from MSC Server canonical node name ..... | 17 | +| 4.3.3.8 Services of an AMF from AMF instance name (or 5G-GUTI) ..... | 17 | +| 4A SGW/PGW selection using GTP-C load control ..... | 18 | +| 4A.1 General ..... | 18 | +| 4A.2 Node-level load control..... | 18 | +| 4A.3 APN-level load control..... | 19 | +| 5 Procedures for EPC Node Discovery and Selection ..... | 20 | +| 5.1 Procedures for Discovering and Selecting a PGW..... | 20 | +| 5.1.1 Discovering a PGW for a 3GPP Access..... | 20 | +| 5.1.1.1 General..... | 20 | +| 5.1.1.2 Discovering a PGW or collocated PGW/GGSN for a 3GPP Access - S8/Gp roaming case existing PDN..... | 21 | +| 5.1.1.3 Discovering a PGW or collocated PGW/GGSN for a 3GPP Access - S5/Gn intra-operator existing PDN..... | 22 | +| 5.1.1.4 Discovering a PGW, collocated PGW/GGSN or GGSN for a 3GPP Access - S5/Gn intra-operator initial attach ..... | 24 | +| 5.1.2 Discovering a PGW for a non-3GPP Access with Network Based Mobility Management..... | 24 | +| 5.1.2.1 Discovering a PGW for a non-3GPP Access – S2a/S2b initial attach for roaming and non-roaming ..... | 24 | +| 5.1.2.2 Discovering a PGW for a non-3GPP Access – S2a/S2b initial attach and chained PMIP-based S8-S2a/S2b..... | 24 | +| 5.1.3 Discovering a PGW for a non-3GPP Access with DSMIPv6 ..... | 25 | +| 5.1.3.1 Discovering a PGW for a non-3GPP Access – S2c initial attach..... | 25 | +| 5.2 Procedures for Discovering and Selecting a SGW..... | 25 | +| 5.2.1 General ..... | 25 | +| 5.2.2 SGW Selection during TAU or RAU with SGW change - 3GPP roaming case..... | 26 | +| 5.2.3 SGW Selection during TAU or RAU with SGW change - non-roaming case..... | 27 | +| 5.2.4 SGW Selection during non-3GPP handover to 3GPP access..... | 28 | +| 5.3 Procedures for Discovering and Selecting a PGW and SGW ..... | 28 | + +| | | | +|---------------------------------------------|----------------------------------------------------------------------------------------------------------------|-----------| +| 5.4 | Procedures for Discovering and Selecting an MME ..... | 29 | +| 5.4A | Procedures for Discovering and Selecting an AMF with N26 interface ..... | 31 | +| 5.4B | Procedures for Discovering and Selecting an MME_SRVCC..... | 31 | +| 5.5 | Procedures for Discovering and Selecting an SGSN ..... | 32 | +| 5.5.1 | General ..... | 32 | +| 5.5.2 | SGSN initial target selection based on RAI (UTRAN target/GERAN Iu mode target/GERAN Gb mode target)..... | 32 | +| 5.5.3 | SGSN initial target selection based on RNC-ID (UTRAN target/GERAN Iu mode target)..... | 34 | +| 5.5.4 | Void ..... | 35 | +| 5.6 | GW Selection for SIPTO..... | 35 | +| 5.6.1 | SIPTO above RAN ..... | 35 | +| 5.6.2 | SIPTO at the local network with LGW collocated with the (H)(e)NB ..... | 35 | +| 5.6.3 | SIPTO at the local network with stand-alone GW (LGW collocated with SGW) ..... | 35 | +| 5.6.4 | SIPTO for eHRPD ..... | 36 | +| 5.7 | Procedures for Discovering and Selecting an MSC Server..... | 36 | +| 5.7.1 | General ..... | 36 | +| 5.7.2 | Selection of the MSC server enhanced for SRVCC based on target RAI (UTRAN / GERAN Iu & A/Gb mode target) ..... | 36 | +| 5.8 | Procedures to support Dedicated Core Networks ..... | 37 | +| 5.8.1 | General ..... | 37 | +| 5.8.2 | SGW, PGW and GGSN Selection Procedure..... | 37 | +| 5.8.3 | MMEGI and Null-NRI/SGSN Group ID Retrieval Procedure..... | 38 | +| 5.8.4 | MME and SGSN Selection Procedure ..... | 39 | +| 5.8.5 | AMF Selection Procedure ..... | 39 | +| 5.9 | Procedures to support Cellular Internet of Things ..... | 40 | +| 5.9.1 | DCN based solution..... | 40 | +| 5.9.2 | Alternative solution ..... | 40 | +| 5.10 | Procedures for Discovering and Selecting an SGW-U ..... | 40 | +| 5.11 | Procedures for Discovering and Selecting PGW-U ..... | 41 | +| 5.12 | Procedures to select a node supporting a particular network capability ..... | 42 | +| 5.12.1 | General principles..... | 42 | +| 5.12.1.1 | General..... | 42 | +| 5.12.1.2 | Selecting a node supporting a particular network capability within a Dedicated Core Network..... | 43 | +| 5.12.1.3 | Selecting an SGW or PGW supporting a particular network capability..... | 43 | +| 5.12.2 | Procedures to support Dual Connectivity with NR ..... | 44 | +| 5.12.2.1 | General..... | 44 | +| 5.12.3 | Procedures to support interworking with 5GC ..... | 44 | +| 5.12.3.1 | General..... | 44 | +| 5.12.3.2 | PGW-C/SMF selection ..... | 44 | +| 5.12.3.3 | PGW-U/UPF selection..... | 45 | +| 5.13 | Procedures to support Ethernet PDN Connection in EPS ..... | 45 | +| 5.13.1 | DCN based solution..... | 45 | +| 5.13.2 | Network Capability based solution ..... | 45 | +| 5.13.3 | Alternative solutions..... | 45 | +| 5.14 | Procedures for Discovering and Selecting a UCMF ..... | 45 | +| 6 | Procedures for OAM System Node Discovery ..... | 46 | +| 6.1 | Procedures for Relay Node OAM System Discovery..... | 46 | +| 6.1.1 | General ..... | 46 | +| 6.1.2 | OAM System Selection based on Type Allocation Code ..... | 46 | +| 7 | Procedures for NF Discovery in 5G System..... | 46 | +| 7.1 | General ..... | 46 | +| 7.2 | Procedure for AMF Discovery by 5G-AN ..... | 46 | +| Annex A (Informative): Examples..... | | 48 | +| A.1 | Introduction ..... | 48 | +| A.2 | Preconditions..... | 48 | +| A.3 | Collocated Simple LTE Example..... | 48 | +| A.3.1 | Network description ..... | 48 | +| A.3.2 | Master file for "Collocated Simple LTE Example" ..... | 49 | +| A.3.3 | SOA and NS records ..... | 49 | +| A.3.4 | MME file for "Collocated Simple LTE Example" ..... | 50 | + +| | | | +|-----------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------|-----------| +| A. 3.5 | APN file for "Collocated Simple LTE Example" ..... | 52 | +| A. 3.6 | PGW/SGW node file for "Collocated Simple LTE Example" ..... | 52 | +| A. 3.7 | TAI/TAC file for "Collocated Simple LTE Example" ..... | 54 | +| A. 3.8 | MME lookup based on GUTI for "Simple LTE Example" ..... | 56 | +| A. 3.9 | APN lookup for "Simple LTE Example" (i.e. PGW candidate list)..... | 57 | +| A. 3.10 | TAI lookup for "Simple LTE Example" (i.e. SGW candidate list)..... | 59 | +| A. 3.11 | Finding the collocated SGW and PGW together..... | 61 | +| A. 3.12 | S11 lookup by SGW canonical node name ..... | 62 | +| A. 3.13 | TAI lookup for "Colocation Simple LTE Example" (i.e. MME candidate list)..... | 63 | +| A.4 | LTE Example with Dedicated Core Network ..... | 64 | +| A.4.1 | General ..... | 64 | +| A.4.2 | APN file for DCN..... | 64 | +| A.4.3 | PGW/SGW node file for "Collocated Simple LTE Example" ..... | 65 | +| A.4.4 | TAI/TAC file for DCN..... | 65 | +| Annex B (Normative): DNS procedures clarifications..... | | 67 | +| B.1 | DNS RFC procedures general clarifications..... | 67 | +| B.2 | DNS procedures 3GPP clarifications on S-NAPTR ..... | 67 | +| B.3 | DNS procedures 3GPP clarifications for Dedicated Core Networks..... | 68 | +| B.4 | DNS procedures 3GPP clarifications for Network Capability..... | 68 | +| Annex C (Informative): DNS Pseudo-Code ..... | | 68 | +| C.1 | S-NAPTR procedure base pseudo-code..... | 68 | +| C.2 | S-NAPTR procedure - no topon..... | 70 | +| C.3 | S-NAPTR procedure candidate list..... | 71 | +| C.4 | S-NAPTR procedure pseudo-code with topon..... | 71 | +| Annex D (Informative): SGSN examples ..... | | 74 | +| D.1 | Introduction ..... | 74 | +| D.2 | Preconditions ..... | 74 | +| D.3 | SGSN file ..... | 74 | +| D.4 | Null-NRI/SGSN Group ID file for DCN ..... | 75 | +| Annex E (Informative): SGW/PGW selection examples using GTP-C load control ..... | | 76 | +| E.1 | PGW selection using GTP-C load control at node level..... | 76 | +| E.2 | PGW selection using GTP-C load control at APN level..... | 76 | +| E. 2.1 | PGW selection when APN load control information is available for each candidate PGW ..... | 76 | +| E.2.2 | PGW selection when APN load control information is not available for each candidate PGW ..... | 77 | +| Annex F (Informative): Examples for AMF Discovery by 5G AN ..... | | 77 | +| F.1 | Introduction ..... | 77 | +| F.2 | Preconditions ..... | 77 | +| F.3 | Example of an AMF Region with 2 AMF Sets ..... | 77 | +| F.3.1 | Master file..... | 77 | +| F.3.2 | SOA and NS records ..... | 78 | +| F.3.3 | AMF Set file ..... | 78 | +| Annex G (Informative): Change history ..... | | 79 | + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document describes Domain Name System (DNS) Procedures for the Evolved Packet System. This document covers the Evolved Packet Core gateway node selection using DNS (e.g. SGW and PGW nodes) excluding all User Equipment (UE) initiated DNS-based discovery and selection procedures. + +The present document specifies functions, procedures and information which apply to GERAN Iu mode. However, functionality related to GERAN Iu mode is neither maintained nor enhanced. + +The present document also describes the Domain Name System (DNS) Procedures for the Evolved Packet System interworking with the 5G System, as specified in 3GPP TS 23.501 [28] and 3GPP TS 23.502 [29]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] IETF RFC 1034:"DOMAIN NAMES - CONCEPTS AND FACILITIES". +- [3] IETF RFC 1035:"DOMAIN NAMES - IMPLEMENTATION AND SPECIFICATION". +- [4] 3GPP TS 23.003: "Numbering, addressing and identification". +- [5] GSMA PRD IR.67: "DNS Guidelines for Operators" Version 2.1.0. +- [6] IETF RFC 3596: "DNS Extensions to Support IP Version 6". +- [7] IETF RFC 3403: " Dynamic Delegation Discovery System (DDDS) Part Three: The Domain Name System (DNS) Database". +- [8] IETF RFC 2782: "A DNS RR for specifying the location of services (DNS SRV)". +- [9] IETF RFC 3958: "Domain-Based Application Service Location Using SRV RRs and the Dynamic Delegation Discovery Service (DDDS)". +- [10] IETF RFC 3401: "Dynamic Delegation Discovery System (DDDS) Part One: The Comprehensive DDDS". +- [11] 3GPP TS 23.401: "GPRS enhancements for E-UTRAN access ". +- [12] 3GPP TS 25.413: "UTRAN Iu interface RANAP signalling". + +- [13] IETF RFC 2671: "Extension Mechanisms for DNS (EDNS0)". +- [14] IETF RFC 3402: "Dynamic Delegation Discovery System (DDDS) Part Two: The Algorithm". +- [15] IETF RFC 2308: "Negative Caching of DNS Queries (DNS NCACHE)". +- [16] IETF RFC 3330: "Special Use IPv4 Addresses". +- [17] IETF RFC 3849: "IPv6 Address Prefix Reserved for Documentation". +- [18] 3GPP TS 23.060: "General Packet Radio Service (GPRS); Service Description; Stage 2". +- [19] 3GPP TS 36.413: "Evolved Universal Terrestrial Access Network (E-UTRAN); S1 Application Protocol (S1AP)". +- [20] 3GPP TS 23.216: "Single Radio Voice Call Continuity (SRVCC)". +- [21] 3GPP TS 36.413: "Evolved Universal Terrestrial Radio Access Network (E-UTRAN); S1 Application Protocol (S1AP)". +- [22] 3GPP TS 36.300: "Evolved Universal Terrestrial Radio Access (E-UTRA) and Evolved Universal Terrestrial Radio Access Network (E-UTRAN); Overall description; Stage 2". +- [23] 3GPP TS 29.274: "3GPP Evolved Packet System (EPS); Evolved General Packet Radio Service (GPRS) Tunnelling Protocol for Control plane (GTPv2-C); Stage 3". +- [24] 3GPP2 X.S0057-B: "E-UTRAN - eHRPD Connectivity and Interworking: Core Network Aspects". +- [25] 3GPP TS 23.402: "Architecture enhancements for non-3GPP accesses". +- [26] 3GPP TS 29.244: "Interface between the Control Plane and the User Plane of EPC Nodes; stage 3". +- [27] 3GPP TS 29.272: "Mobility Management Entity (MME) and Serving GPRS Support Node (SGSN) related interfaces based on Diameter protocol". +- [28] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [29] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [30] 3GPP TS 29.273: "Evolved Packet System (EPS); 3GPP EPS AAA interfaces". + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +Domain Name System as defined in IETF RFC 1034 [2], IETF RFC 1035[3], and as used in 3GPP in 3GPP TS 23.003 [4] and GSMA PRD IR.67 [5] + +The phrase "operators shall provision" in this document is intended to convey what is required to provision in DNS to provide DNS based selection for the corresponding function documented here. If there is a non-DNS procedure in an operator's network for that function then there is no functional requirement for the operator to provision such DNS records. + +The term "S4-SGSN" refers to a Release-8 SGSN that has at least one set of S4/S3/S16 interfaces enabled. + +The term "Release 8 SGSN supporting only Gn/Gp" refers to a Release 8 or later SGSN that either explicitly does not support S4 interfaces or all S4/S3/S16 interfaces are disabled due to operator policy. Such a node cannot use an SGW but can use a collocated PGW/GGSN. See 3GPP TS 23.401 [11] Annex D for use cases. + +The term "Release-8 SGSN" applies to either case. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905[1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|-------|--------------------------------------| +| DCN | Dedicated Core Network | +| DDDS | Dynamic Delegation Discovery Service | +| DNS | Domain Name System | +| ECGI | E-UTRAN Cell Global Identification | +| eHRPD | evolved High Rate Packet Data | +| FQDN | Fully Qualified Domain Name | +| GUTI | Globally Unique Temporary Identity | +| HSGW | eHRPD Serving Gateway | +| LGW | Local Gateway | +| LIPA | Local IP Access | +| NR | New Radio | +| PGW | PDN Gateway | +| RAI | Routing Area Identity | +| SGW | Serving Gateway | +| SIPTO | Selected IP Traffic Offload | +| TAI | Tracking Area Identity | +| TAU | Tracking Area Update | +| TWAN | Trusted WLAN Access Network | + +# --- 4 General DNS Based Node Selection Description + +## 4.1 Resource Records + +### 4.1.1 A and AAAA + +The A resource record is used to define IPv4 host address corresponding to fully qualified name of the host as defined in IETF RFC 1035 [3]. The AAAA resource record is used to define IPv6 host address corresponding to fully qualified name of the host as defined in IETF RFC 3596 [6]. + +It should be noted that in DNS A or AAAA record names, in general, represent a host and its "equivalent" interface. Host names, in general, cannot be used as node names. A node may need to have more than one host name for the simple reason that it can have multiple interfaces for different purposes. + +### 4.1.2 NAPTR + +The NAPTR resource record is defined in IETF RFC 3403 [7] and is a powerful tool that allows DNS to be used to lookup services for a wide variety of resource names, which are not in domain name syntax. NAPTR would be used by a client program to rewrite a string into a domain name. The rewrite process is controlled by flags that provide information on how to communicate with the host at the domain name that was the result of the rewrite. If DNS returns multiple NAPTR resource records those can be prioritized using embedded order and preference values defined by the DNS administrator. + +The S-NAPTR procedure i.e., the "Straightforward-NAPTR" procedure, is defined in IETF RFC 3958 [9] and describes a Dynamic Delegation Discovery System (DDDS) [10] application procedures on how to resolve a domain name, application service name, and application protocol dynamically to target server and port by using both NAPTR and + +SRV (see IETF RFC 2782 [8]) resource records. The S-NAPTR also simplifies the use of NAPTR by limiting the NAPTR flags only to "a", "s" and "". Furthermore, only NAPTR "replacement" expressions are allowed, not "regular expressions", during the rewrite process. The changes compared to IETF RFC 3403 [7] NAPTR usage are procedural and are limited only to the resolver. The S-NAPTR use of the NAPTR resource record is exactly the same as defined in IETF RFC 3403 [7] from the DNS server and DNS infrastructure point of view. Additional information on S-NAPTR usage is provided in Annex B and Annex C. + +The NAPTR resource record flags "s" and "" allow another layer of indirection in the DNS configuration. The "" flag causes the S-NAPTR procedure to query for new NAPTR resource records from the DNS infrastructure. The "s" flag causes the S-NAPTR procedure to query for an intermediary SRV resource record pointing to A/AAAA resource records. This additional query provides a selection mechanism by which the operator is able to assign different weights to different A/AAAA resource records while larger weights are given a proportionately higher probability of being selected. A DNS server might provide the A/AAAA records together with the SRV resource records as per IETF RFC 2782 [7]. The length of the NAPTR resource record indirection chain enabled using the "" flag is unbounded and may lead to a deep chaining of resource records over time in the DNS configuration. Additional layer of indirection and possible deep chaining both grows the DNS configuration significantly in size and complexity, and also makes the configuration prone to hard to trace errors. The use of NAPTR resource record "" flag pointing to other NAPTR resource records with flag "" is strongly discouraged. Specifically, NAPTR resource flag "" should only be provisioned to point to terminal NAPTR records (i.e., flag "a" or flag "s"). Generally, the use of flag "a" or of flag "s" is encouraged. + +### 4.1.3 SRV + +The SRV resource record is defined in IETF RFC 2782 [8] and allows DNS administrators to use pool of servers for a single domain with static load balancing to each server, to move services from host to host, and to designate some hosts as primary servers for a service from a pool of hosts. A resolver can ask for a specific service/protocol combination for a specific domain name and get back a Fully Qualified Domain Names (FQDN) of any available servers. + +## 4.2 Selecting Domain Names + +When using the S-NAPTR procedure under the DDDS framework, it becomes essential which domain name gets used for querying the actual NAPTR records. In the S-NAPTR procedure, the Application-Unique String used by the DDDS algorithm is the starting domain name for which the information of the services, protocols and actual canonical node names are sought. Related to the Application-Unique String, the First well-Known Rule of the DDDS algorithm in the S-NAPTR procedure outputs the same domain name that constitutes the Application-Unique String. For each node type in EPC that can be queried for information using the S-NAPTR procedure, the authoritative DNS server for the given domain should be provisioned with unique domain name for each EPC node or other identifier that is explicitly specified by a procedure in this specification (for example one based on APN, TAI, GUTI, etc) and corresponding NAPTR records. The authoritative DNS server for a given domain shall provision at least the EPC node names that may be exposed to the inter-operator roaming interfaces. + +## 4.3 Identifying Nodes, Services and Protocols + +### 4.3.1 IETF RFC 3958 Service and Protocol service names for 3GPP + +Service and protocol service names for the S-NAPTR procedure shall be used in accordance with 3GPP TS 23.003 [4], clause 19.4.3. + +### 4.3.2 Identification of canonical node names + +There are many use cases where it is desirable to select a collocated node in preference to a non-collocated node, or a topologically closer (with respect to the network topology) node in preference to a less topologically closer node. To easily do this action a "canonical" node name shall be employed so that the "canonical" node names from two or more sets of records can be compared to see if nodes are actually the same nodes, or topologically closer nodes. + +In DNS neither A or AAAA host names, in general, represent a node name, but rather a set of "equivalent" interfaces. A node may need to have more than one host name for the simple reason that it can have different interfaces for different purposes. For example, a node can have a set of roaming interfaces on a completely different network than the internal + +network due to security needs. Hence, there are always situations where multiple A/AAAA record sets must exist that implies multiple distinct host names. Therefore, host names, in general, cannot be used as node names. + +Instead of creating new DNS records to map a host name to a node name this specification defines how host names shall be constructed and used in S-NAPTR procedure within 3GPP EPC. + +The host names shall have form: + +<"topon" | "topoff"> . . + +Where the first label is "topon" or "topoff" to indicate whether or not collocated and topologically close node selection shall be preferred, "single-label-interface-name" is a single label used to name a specific interface on a node (e.g. Eth-0, S8, vip, board3), "canonical-node-name" is the canonical node name of a specific node. A node shall have exactly one canonical node name so a host name always includes the unique canonical node name of the node. Hence, when comparing the host name FQDNs to find out whether the nodes are actually the same, the first two labels of the host name FQDN shall be ignored. + +NOTE 1: The canonical node name is not related to canonical name in the CNAME DNS record. + +When using host names with "topon" as the first label the canonical node names of nodes shall be hierarchically structured to allow an operator to reflect the topological closeness of two nodes by naming the nodes with canonical node names sharing a common suffix domain name. The number of labels in the common suffix shall represent how close the operator considers them during node selection. The higher the number of labels in the common suffix is, the closer the nodes are. In other words, two topologically closest nodes are those with the longest matching suffix in their respective canonical node names. + +The following list contains examples of domain names where canonical node names are in bold: + +topon.Eth-0.gw32.california.west. **example.com** + +topon.S8.gw32.california.west. **example.com** + +topon.vip.gw3.oregon.west. **example.com m** + +topon.board3.pg1.cluster1.net27. **example.net** + +topon.S5.gw4.cluster1.net27. **example.net** + +topon.board3.pg1.cluster2.net27. **example.net** + +In the examples above, "Eth-0.gw32.california.west.example.com" and "S8.gw32.california.west.example.com" are two different interfaces on the same node, "gw32.california.west.example.com". On the other hand, "gw4.cluster1.net27.example.net" is topologically closer to "pg1.cluster1.net27.example.net" (they are both connected to the "cluster1.net27.example.net" subnetwork) than to "pg1.cluster2.net27.example.net" (only connected to the wider "net27.example.net" subnetwork.) + +Interface names and node names do NOT identify a function in the procedures here. The interface is part of the natural hierarchy within a node and the host name is already returned with the existing DNS records. The approach of identifying a canonical node name from a host name is believed to be simpler and more logical to maintain than creating additional DNS records simply to return a node name. + +The topologically aware naming restriction (i.e. the format above using "topon" or "topoff") shall be placed only on all targets/replacements pointing logically to a A/AAAA record sets from the S-NAPTR procedure. These targets/replacements are denoted host names here (following the normal DNS terminology unless a CNAME is used to point to the actual A or AAAA record). This restriction shall NOT apply to any other DNS records the operator may be using. + +Specifically, a NAPTR with flag "a" will have a replacement target pointing to the A/AAAA record directly, thus the topologically aware naming restriction on the host name applies to the replacement in the NAPTR record with a flag "a". For the NAPTR flag "s" case the topologically aware naming restriction on the host name applies to the target in the SRV record, and not the NAPTR record replacement. For the NAPTR empty flag "" case the topologically aware naming does not apply any restriction since this is not a host name. Other flags are not used in S-NAPTR. + +During DNS provisioning for the S-NAPTR procedure the operator is free to add another layer of indirection using a CNAME record (see clause 6.6.2 of IETF RFC 1034 [2]). + +While operators shall provision host names in DNS according to the above rules, it is still possible that the host name might be incorrectly configured (i.e. not conforming to the above format with first label of "topon" or "topoff"). For such misconfigured records implementations shall treat the misconfigured host name as valid within the S-NAPTR procedure where that host name was found, but may favor correctly configured records. Misconfigured host name for topological matching and colocation checks shall be treated as if the misconfigured host name had the label "topoff." prepended. Operators shall not depend on this behavior. + +The order of using DNS records to contact a node is based on following ordering. When collocation of a pair of node types is explicitly stated as applicable in a procedure, collocation of the nodes shall have highest importance. When topological matching is explicitly stated as applicable in a procedure then topological matching with "topon", is of second highest importance. Then finally the ordering obtained by the S-NAPTR output. When collocation and topological ordering applies, collocated sets of nodes have highest importance, then sets of nodes with "topon" and the most labels in their common suffix, then sets of nodes with "topon" and second most number of labels and so on until we reach non-collocated nodes with "topoff" and within sets with same colocation or topological order then S-NAPTR order of one of the two nodes is used (specified in the specific procedure). Additional informative clarifications on how S-NAPTR is employed in the context of 3GPP EPC node usage and specifically how topological matching using the "topon" label interacts with S-NAPTR ordering is provided in Annex C.4. + +### 4.3.3 Services from node names or other FQDN identifying a service + +#### 4.3.3.1 General + +There are potential use cases where a node has a logical name of a peer or other FQDN identifier for a service but does not have the protocols it supports. The NAPTR record for any of the services can be provisioned at the node's logical name or other FQDN identifier for a service. The node logical name or other FQDN identifier for a service is equal to the domain name under which NAPTR records are provisioned. This allows any core network node to discover the available services based on node's logical name or other FQDN identifier for a service. + +#### 4.3.3.2 Procedure + +##### 4.3.3.2.1 S-NAPTR Procedure - General + +These procedures are employed when any core network node has the FQDN of an entity and needs to find one or more services at that entity. + +**NOTE:** There are three likely sources of the entity name. O&M provisioned, 3GPP specified based on some other identifier of a service (such as GUTI, TAC, IMSI, MISDN etc.), or the canonical node name obtained from a previous S-NAPTR procedure. Note that a node can have more than one name, i.e. an alias, but there shall be only one canonical node name for a node. (CNAME records are a way to create aliases for the canonical node name or any other FQDN as per IETF RFC 1034 [2]) + +The S-NAPTR procedure requires that DNS NAPTR records shall be consistently provisioned as described in IETF RFC 3958 [9]. This means a NAPTR record for each protocol using "a" flag and the service field populated with the service and proto value may be provisioned. If a more sophisticated load balancing or non-standard ports are desired, NAPTR with "s" flag for each protocol and the corresponding SRV records with relative weighting for each interface need to be provisioned. NAPTR records with empty "" flag records may also be used. + +A DNS resolver that intends to use the S-NAPTR procedure shall use the FQDN of the node or a specified FQDN identifier of a service as the Application-Unique String. If all protocols are desired, then the resolver simply runs the S-NAPTR procedure as if all protocols match. + +The S-NAPTR procedure logically outputs a list of host names each with a service, protocol, port and a list of IPv4 and IPv6 addresses. This list can be obtained one host name at a time, in a procedure similar to Annex C.2, or a complete ordered list of all nodes, in a procedure similar to Annex C.3. Such a complete list obtained from an S-NAPTR procedure is referred here as a candidate list. + +**NOTE:** The candidate list is valid for at most for finite period of time due to DNS time to live and order of the records can change due to statistical selection. Operators should provision records with reasonable time to live values. + +##### 4.3.3.2.2 S-NAPTR Procedure for a canonical node name + +One very important special case is S-NAPTR based on a node's canonical node name. + +Operators shall provision NAPTR records for all enabled interfaces of a node that are explicitly listed in clause 19.4.3 of 3GPP TS 23.003 [4] at the FQDN of the node's unique canonical node name. + +NOTE 1: Exception to this rule: The NAPTR records for x-3gpp-mme: x-s1-mme and x-3gpp-sgw: x-s1-u from clause 19.4.3 of 3GPP TS 23.003 [4] are to be considered entirely optional in this release of 3GPP. + +With such provisioning by an operator a DNS resolver can at any time use the S-NAPTR procedure with a valid canonical node name to find all interfaces and protocols supported by that node that are listed in clause 19.4.3 of 3GPP TS 23.003 [4]. This includes interfaces of co-located functions that might not be easily discovered by other means. + +NOTE 2: The remaining clauses within clause 4.3.3 cover cases where the FQDN used for the Application-Unique String is known to correspond to the resource of exactly one node and are relatively simple. These include the cases where an explicit identifier is defined by 3GPP for S-NAPTR lookup and examples of S-NAPTR based on canonical node names (the later is not intended to be an exhaustive list of examples). More complicated cases that cover identifiers for multiple nodes are covered in other clauses. + +#### 4.3.3.3 Services of a PGW from PGW node name (or collocated PGW/GGSN) + +A UE with both a 3GPP access capability and non-3GPP access capability can roam in and out of the 3GPP network while maintaining the same PDN connection. + +To support roaming to or from a non-3GPP network the HSS (or AAA) server can have an FQDN of a particular PGW or collocated PGW/GGSN node. One reason for using an FQDN instead of an IP address is that a PGW can be multihomed (i.e. more than one IP address). Another possible use case is when the PGW interface needs to be changed between PMIP and GTP. Even if each interface type only uses one IP address, the different interfaces can still use different IP addresses. For example, roaming and non-roaming interfaces are likely to be separated from each other using firewall or other mechanisms. Another possible use case is when the Home Agent (HA) functionality of a particular PGW needs to be discovered, e.g., during the HA reallocation procedure. + +If the PGW node name employed by the operator is the PGW canonical node name then see clause 4.3.3.2 for provisioning. + +If the PGW node name employed by the operator is not the PGW canonical node name then the operators shall provision at least the NAPTR records for S5 and S8 interfaces of a PGW node (see clause 19.4.3 of 3GPP TS 23.003 [4]) at that PGW node name. If the GGSN function is co-located then the NAPTR records for the Gn/Gp interfaces of the collocated PGW/GGSN shall be included as well. Only interfaces that exist and are allowed by the operator policy need be included. + +NOTE 1: The PGW node name in HSS/AAA may or may not be the PGW's canonical node name if the PGW's FQDN was placed in the HSS/AAA from a non-3GPP source. + +To resolve the allowed PMIPv6 interfaces the S-NAPTR procedure shall be used with the "Service Parameters" of + +"x-3gpp-pgw:x-s5-pmip" , "x-3gpp-pgw:x-s8-pmip" + +as defined in clause 19.4.3 of 3GPP TS 23.003 [4], and the Application-Unique String set to the FQDN of the PGW or collocated PGW/GGSN node. + +The S-NAPTR procedure logically outputs a list of host names each with a service, protocol, port and a list of IPv4 and IPv6 addresses. This list can be obtained one host name at a time, in a procedure similar to Annex C.2, or a complete ordered list of all nodes, in a procedure similar to Annex C.3. Such a complete list obtained from an S-NAPTR procedure is referred here as a candidate list. + +For a more explicit example, an operator might provision a PGW name at: + +gw1.pgw.node.epc.mnc.mcc.3gppnetwork.org + +Similarly for the GTPv2 interfaces the S-NAPTR procedure shall use "Service Parameters" of + +"x-3gpp-pgw:x-s5-gtp" , "x-3gpp-pgw:x-s8-gtp" + +as defined in clause 19.4.3 of 3GPP TS 23.003 [4], and the Application-Unique String set to the FQDN of the specific PGW or collocated PGW/GGSN node. + +Similarly for the GTPv1 Gn/Gp interfaces the S-NAPTR procedure shall use "Service Parameters" of + +"x-3gpp-pgw:x-gn", "x-3gpp-pgw:x-gp" "x-3gpp-ggsn:x-gn", "x-3gpp-ggsn:x-gp" + +as defined in clause 19.4.3 of 3GPP TS 23.003 [4], and the Application-Unique String set to the FQDN of the specific PGW, collocated PGW/GGSN node. The "Service Parameters" of "x-3gpp-pgw:x-gn", "x-3gpp-pgw:x-gp" represent collocated PGW/GGSN nodes and "x-3gpp-ggsn:x-gn", "x-3gpp-ggsn:x-gp" represent a GGSN that does not have a PGW co-located. + +Similarly for the Home Agent functionality of a PGW the S-NAPTR procedure shall use "Service Parameters" of + +"x-3gpp-pgw:x-s2c-dsmip" + +as defined in clause 19.4.3 of 3GPP TS 23.003 [4], and the Application-Unique String set to the FQDN of the specific PGW. + +Similarly for the S2a interface the S-NAPTR procedure shall use "Service Parameters" of + +"x-3gpp-pgw:x-s2a-pmip", "x-3gpp-pgw:x-s2a-gtp" + +as defined in clause 19.4.3 of 3GPP TS 23.003 [4], and the Application-Unique String set to the FQDN of the specific PGW. + +Similarly for the S2b interface the S-NAPTR procedure shall use "Service Parameters" of + +"x-3gpp-pgw:x-s2b-pmip", "x-3gpp-pgw:x-s2b-gtp" + +as defined in clause 19.4.3 of 3GPP TS 23.003 [4], and the Application-Unique String set to the FQDN of the specific PGW. + +Additional requirements to support DCN are specified in clause 5.8. It is also possible for the DNS resolver to leave "Service Parameters" unspecified in the S-NAPTR procedure in order to identify all interfaces for all supported services and protocols. + +NOTE 2: The services based on S-NAPTR at the canonical node name of the PGW might return services other than ones starting with x-3gpp-pgw or x-3gpp-ggsn since the PGW node can have a co-located SGW function or other functions. + +#### 4.3.3.4 Services of a MME from MME node name (or GUTI or 5G-GUTI) + +There are procedures when: + +- the old MME must be contacted by the new AMF, MME or S4 SGSN (a Release-8 SGSN supporting only Gn/Gp may also optionally use this procedure); +- the old AMF must be contacted by the new MME. + +The primary use case is context transfer. + +The 3GPP defined MME node FQDN shall be constructed as defined in clause 19.4.2.4 of 3GPP TS 23.003 [4] where the needed data can be obtained from the UE's old GUTI (or mapped from old P-TMSI and old RAI see clause 4.3.3.5 for more details, or mapped from the 5G-GUTI). The 3GPP defined MME node FQDN is either the canonical node name itself or an alias of the MME's canonical node name (the operator is free to choose the canonical node name). + +If the MME node name employed by the operator is the 3GPP defined MME node FQDN then see clause 4.3.3.2 for provisioning. + +If the MME node name employed by the operator is the 3GPP defined MME node FQDN, the operator shall provision NAPTR records under the 3GPP defined MME node FQDN for at least "x-3gpp-mme:x-s10", "x-3gpp-mme:x-s3" if S3/S4 GERAN/UTRAN is supported, and "x-3gpp-mme:x-gn" or "x-3gpp-mme:x-gp" if Gn/Gp is supported. + +So, for example, for an MME or AMF to find all S10 interfaces of an MME based on the old GUTI or 5G-GUTI, the S-NAPTR procedure shall be prefixed with "Service Parameters" of + +"x-3gpp-mme:x-s10" + +and set the Application-Unique String to the FQDN as defined in clause 19.4.2.4 of 3GPP TS 23.003 [4], with the initial query targeted at 3GPP defined MME node FQDN. + +Similarly, for example, for an MME to find all N26 interfaces of an AMF based on the old GUTI, the S-NAPTR procedure shall be prefixed with "Service Parameters" of + +"x-3gpp-mme:x-s10" + +and set the Application-Unique String to the FQDN as defined in clause 19.4.2.4 of 3GPP TS 23.003 [4], with the initial query targeted at 3GPP defined MME node FQDN. + +The S-NAPTR procedure logically outputs a list of host names each with a service, protocol, port and a list of IPv4 and IPv6 addresses. This list can be obtained one host name at a time, in a procedure similar to Annex C.2, or a complete ordered list of all nodes, in a procedure similar to Annex C.3. Such a complete list obtained from an S-NAPTR procedure is referred here as a candidate list. + +Similarly, for an S4-SGSN to find all S3 interfaces of an MME based on the old GUTI it would use a "Service Parameter" of "x-3gpp-mme:x-s3". + +Similarly, for a Release 8 Gn/Gp-SGSN to find all Gn and Gp interfaces of an MME based on the old GUTI it would use a "Service Parameter" of "x-3gpp-mme:x-gn", "x-3gpp-mme:x-gp". + +To find all MME related services of an MME based on the MME's canonical node name, the S-NAPTR procedure shall be prefixed with "Service Parameters" of + +"x-3gpp-mme:x-s10", "x-3gpp-mme:x-s3", "x-3gpp-mme:x-s11", "x-3gpp-mme:x-gn", "x-3gpp-mme:x-gp", + +and set the Application-Unique String to the MME's canonical node name. + +It is also possible for the DNS resolver to use only the interfaces it is interested in or leave "Service Parameters" unspecified in the S-NAPTR procedure in order to identify all interfaces for all supported services and protocols. + +NOTE 1: The services based on MME canonical node name can return services not starting with x-3gpp-mme since the MME node might, for example, have a co-located SGSN. + +NOTE 2: The above procedures for discovering and selecting an AMF are identical to the procedures specified for discovering and selecting an MME; they can be used by MMEs not upgraded to support the procedure specified in clause 4.3.3.8. In this case, AMFs are provisioned in DNS as MMEs, following the mapping rules specified for EPS interworking with 5GS in clause 2.10.2 of 3GPP TS 23.003 [4], and the code space between AMF Region ID and MMEGI needs to be coordinated. + +#### 4.3.3.5 Services of an SGSN from a P-TMSI + +There are procedures where the source SGSN must be contacted by the target MME or a target S4-SGSN. A Release 8 SGSN supporting only Gn/Gp may also optionally use this procedure. + +During a mobility procedure towards a new core network node, a UE served by a SGSN has a previously assigned P-TMSI by the source SGSN. A pre-Release-8 UE will provide the P-TMSI. A Release-8 UE will map P-TMSI to a derived GUTI using the procedure in 3GPP TS 23.003 [4] clause 2.8.2 and referred to in Annex H of 3GPP TS 23.401 [11]. + +The target MME or a target S4-SGSN extracts the source's NRI, RAC, LAC, MNC and MCC from the P-TMSI (or GUTI based on the procedure described in 3GPP TS 23.003 [4] clause 2.8.2). + +The FQDN based on NRI, RAC, LAC, MNC and MCC as defined in 3GPP TS 23.003 [4] clause 19.4.2.6 is denoted in this specification as the NRI-RAI FQDN. + +If the SGSN canonical node name employed by the operator is the NRI-RAI FQDN then see clause 4.3.3.2 for provisioning. + +If the 3GPP defined NRI-RAI FQDN is not employed by an operator as the SGSN's canonical node name then the operator shall provision NAPTR records under the NRI-RAI FQDN with at least "x-3gpp-sgsn:x-s3", "x-3gpp-sgsn:x- + +s4", "x-3gpp-sgsn:x-s16" (assuming the SGSN supports S3/S4/S16 GERAN/U-TRAN) and at least "x-3gpp-sgsn:x-gn", "x-3gpp-sgsn:x-gp" (assuming the SGSN supports legacy Gn/Gp). + +The S-NAPTR procedure for finding the old SGSN services and interfaces from the P-TMSI is started with "Service Parameters" of + +"x-3gpp-sgsn:x-gn", "x-3gpp-sgsn:x-gp", "x-3gpp-sgsn:x-s3", "x-3gpp-sgsn:x-s16" + +as defined in 3GPP TS 23.003 [4] and setting the Application-Unique String to the NRI-RAI FQDN based on NRI, RAC, LAC, MNC and MCC as defined in 3GPP TS 23.003 [4] clause 19.4.2.6: + +NOTE 1: In the event a valid NRI is not available then the value shall be excluded from the FQDN. The default SGSN in the SGSN pool shall be provisioned under that record (or the sole SGSN if there is no SGSN pool for that RAI). + +NOTE 2: Service Parameters are logically limited to those supported by the target node that is performing the search for the source SGSN. So for example, a target Release-8 SGSN supporting only Gn/Gp would employ "x-3gpp-sgsn:x-gn" and "x-3gpp-sgsn:x-gp". An S4-SGSN only supporting S4/S3/S16 would employ "x-3gpp-sgsn:x-s3", "x-3gpp-sgsn:x-s16". A target MME would employ "x-3gpp-sgsn:x-s3" and may additionally include "x-3gpp-sgsn:x-gn" and "x-3gpp-sgsn:x-gp", to support the procedures in Annex D of 3GPP TS 23.401 [11]. + +The S-NAPTR procedure logically outputs a list of host names each with a service, protocol, port and a list of IPv4 and IPv6 addresses. This list can be obtained one host name at a time, in a procedure similar to Annex C.2, or a complete ordered list of all nodes, in a procedure similar to Annex C.3. Such a complete list obtained from an S-NAPTR procedure is referred here as a candidate list. + +NOTE 3: The services based on canonical node name can return services not starting with x-3gpp-sgsn since the SGSN node might, for example, have a co-located MME. + +For a pre-Release-8 target node i.e. a UE moving from eUTRAN to pre-Release-8 UTRAN/GERAN the UE will provide a derived P-TMSI based on a GUTI (See Annex H of 3GPP TS 23.401 [11]). As a result the source MME or Release-8 SGSN looks like a pre-Release-8 SGSN to a pre-Release-8 target node. For pre-Release-8 compatibility operators would continue to provision A/AAAA records as described in Annex C.1 of 3GPP TS 23.003 [4] for the corresponding Gn/Gp interfaces regardless of whether the source SGSN is pre-Release-8 or not. + +NOTE 4: Gn/Gp interfaces are provisioned redundantly for both ".gprs" and ".3gppnetwork.org" top level domains during the transition to Release-8 to allow a gradual forward migration to 3gppnetwork.org while still supporting existing pre-Release-8 usage. + +#### 4.3.3.6 Services of an SGW from SGW canonical node name + +An MME or S4-SGSN may need to find SGW interfaces on a SGW based solely on SGW's canonical node name. The most common use cases are: + +- An MME finding an S11 interface from an SGW node name where the SGW node name was determined from an S5/S8 interface selection based on TAI/eNodeB-ID (see clause 5.2). +- An S4-SGSN finding an S4 interface from an SGW node name where the SGW node name was determined from an S5/S8 interface selection based on RAI/RNC-ID (see clause 5.2). +- Finding if an SGW node has PGW interfaces from an SGW node name (both SGW and PGW functions would be listed under one canonical node name for co-located PGW/SGW). + +See clause 4.3.3.2 for DNS provisioning of the canonical node name records. + +For LTE initial attach cases, the S11 interface is initially unknown by an MME. The S5/S8 interface and the SGW hostname will be selected by procedures in clause 5. The MME will obtain SGW S11 interfaces from the SGW canonical node name. The S-NAPTR procedure shall use "Service Parameter" of + +"x-3gpp-sgw:x-s11" + +as defined in clause 19.4.3 of 3GPP TS 23.003 [4], and the Application-Unique String set to the canonical node name of the specific SGW node to find the available S11 interfaces + +The S-NAPTR procedure logically outputs a list of host names each with a service, protocol, port and a list of IPv4 and IPv6 addresses. This is a "candidate" list of services and interfaces of that SGW (see Annex C.2 for a more detailed description of a candidate list). + +For example, an operator might provision an SGW name at: + +gw21.sgw.node.epc.mnc.mcc.3gppnetwork.org + +Similarly, for GERAN/UTRAN initial attach cases the S4-SGSN will need to obtain the SGW S4 interface after procedures in clause 5 select the S5/S8 interface and SGW hostname. The only change from the MME case is the "Service Parameter" of + +"x-3gpp-sgw:x-s4" + +is employed. + +In cases where a new PDN connection is added to an existing SGW the available SGW S5/S8 interfaces are commonly needed. + +To resolve the allowed SGW PMIPv6 interfaces the S-NAPTR procedure shall be used with the "Service Parameters" of + +"x-3gpp-sgw:x-s5-pmip", "x-3gpp-sgw:x-s8-pmip" + +as defined in clause 19.4.3 of 3GPP TS 23.003 [4], and the Application-Unique String set to the canonical node name of the specific SGW node + +Similarly for the S5/S8 GTP interfaces the S-NAPTR procedure shall use "Service Parameters" of + +"x-3gpp-sgw:x-s5-gtp", "x-3gpp-sgw:x-s8-gtp" + +as defined in clause 19.4.3 of 3GPP TS 23.003 [4], and the Application-Unique String set to the FQDN of the specific SGW node. + +Additional requirements to support DCN are specified in clause 5.8. + +It is also possible to combine the "Service Parameters" in the S-NAPTR or to leave "Service Parameters" as logically unspecified initially in the S-NAPTR procedure in order to identify all interfaces for all 3GPP TS 29.303 supported protocols of the node. + +NOTE 1: The services based on canonical node name can return services not starting with x-3gpp-sgw since the SGW node might, for example, have a co-located PGW. + +#### 4.3.3.7 Services of an MSC Server from MSC Server canonical node name + +During the SRVCC operations (see 3GPP TS 23.216 [20]), an MME or an SGSN may need to find the MSC Server Sv interface based on MSC Server canonical node name. The most common use cases are: + +- An MME or an SGSN finding the Sv interface from an MSC Server node name, where the MSC server node name was determined from the Sv interface selection based on the Target RAI. + +See clause 4.3.3.2 for DNS provisioning of the canonical node name records. + +To find the MSC server services under the MSC server node name, the operator shall at least provision the "Service Parameter" of + +"x-3gpp-msc:x-sv" + +#### 4.3.3.8 Services of an AMF from AMF instance name (or 5G-GUTI) + +During a 5GS to EPS Idle mode mobility using N26 interface (see clause 4.11.1.3.2 of 3GPP TS 23.502 [29]), the MME needs to contact the old AMF for contexts transfer. + +The 3GPP defined AMF instance FQDN shall be constructed as defined in clause 28.3.2.8 of 3GPP TS 23.003 [4] where the needed data can be obtained from the UE's old GUTI (mapped from the 5G-GUTI). The 3GPP defined AMF + +instance FQDN is either the canonical node name itself or an alias of the AMF's canonical node name (the operator is free to choose the canonical node name). + +If the AMF node name employed by the operator is the 3GPP defined AMF instance FQDN then see clause 4.3.3.2 for provisioning. + +If the AMF node name employed by the operator is the 3GPP defined AMF instance FQDN, the operator shall provision NAPTR records under the 3GPP defined AMF instance FQDN for "x-3gpp-amf:x-n26". + +So, for example, for an MME to find all N26 interfaces of an AMF based on the old GUTI, the S-NAPTR procedure shall be prefixed with "Service Parameters" of + +"x-3gpp-amf:x-n26" + +and set the Application-Unique String to the FQDN as defined in clause 28.3.2.8 of 3GPP TS 23.003 [4], with the initial query targeted at 3GPP defined AMF instance FQDN. + +The S-NAPTR procedure logically outputs a list of host names each with a service, protocol, port and a list of IPv4 and IPv6 addresses. This list can be obtained one host name at a time, in a procedure similar to Annex C.2, or a complete ordered list of all nodes, in a procedure similar to Annex C.3. Such a complete list obtained from an S-NAPTR procedure is referred here as a candidate list. + +NOTE: The above procedure avoids the need for code space coordination between AMF Region ID and MMEGI for EPS interworking with 5GS, i.e. the full address space of the AMF Region ID can be used for 5GS. + +# --- 4A SGW/PGW selection using GTP-C load control + +## 4A.1 General + +The nodes responsible for the SGW or PGW selection (i.e. the MME, S4-SGSN, TWAN or ePDG) shall apply the additions specified in this clause, if GTP-C load control is supported and enabled (see clause 12.2 of 3GPP TS 29.274 [23]). + +GTP-C load control allows for the advertising of load information at node level (i.e. the SGW or PGW load) or at APN level (for a PGW only) and selecting the target node (i.e. the SGW or PGW) based on this information. + +The nodes responsible for the SGW or PGW selection shall take into account the load control information reported via GTP-C signalling and shall implement a SGW or PGW selection logic according to the principles specified in the following clauses. + +NOTE: The exact algorithm used at the node performing the SGW or PGW selection, as per the aforementioned requirements, is implementation specific. + +## 4A.2 Node-level load control + +This clause specifies the extensions to the SGW or PGW selection procedures which shall be supported when GTP-C load control is supported and enabled at node level. + +The node level load information consists of the "Load Metric" of the target node, i.e. the SGW or PGW, representing the current utilization of the resources as compared to the overall available resources at the target node. + +Using the DNS based procedures specified in this document, the node performing the SGW or PGW selection (i.e. the MME, S4-SGSN, ePDG or TWAN), referred to as "selecting node" hereafter, shall prepare the candidate list of the target nodes satisfying the required criteria to serve the new session request. + +The criteria for ordering the candidate list of target nodes shall be as specified in clause 4.3.2, i.e. giving priority to collocation when applicable, then to topological matching when applicable, then to the ordering obtained by the S-NAPTR output and then to the ordering obtained by the priority in the SRV records (when SRV records are used). However, the selecting node may select a candidate target node with a lower relative order if all the candidate target nodes with a higher relative order are not available, e.g. when they have reported a Load-Metric=100. + +Then within sets of available candidates with the same relative order (e.g. with the same topological order or with the same NAPTR order field) and with the same priority in SRV records (when SRV records are used), further called the "TNodeList" for the list of candidate target nodes "TNode", the node performing the SGW or PGW selection shall use the "Load Metric" and, if available (i.e. when SRV records are used), the DNS-weight-factor of each candidate target node to perform the node selection as indicated below: + +- 1) The selecting node shall calculate the effective available load of each candidate target nodes, considering the current available load and the DNS weight-factor of the target node as follows: + +$$\text{TNode-effective-available-load} = (100 - \text{TNode-load-metric})\% \times \text{TNode-weight-factor}$$ + +- 2) The selecting node shall then calculate the relative available load of each candidate target node, representing the effective-available-load of the target node, as compared to the effective-available-load of all the other candidate target nodes as follows: + +$$\text{TNode-relative-available-load} = (\text{TNode-effective-available-load} / \text{sum-of-effective-available-load-of-all-the-nodes-in-TNodeList}) \times 100\%$$ + +- 3) The selecting node shall then select the SGW or PGW for new session requests according to the TNode-relative-available-load of each target candidate node, e.g. a TNode-relative-available-load value of X% indicates that the corresponding target node should be selected for X% of the new sessions requests. + +The selecting node shall assume the following in the calculations above: + +- The selecting node shall assume the TNode-load-metric=0 for a candidate target node for which no node level load-metric is available (e.g. due to the load control feature being not supported between two PLMNs and that the PGW and the MME are from different PLMNs); +- The selecting node shall compute the TNode-weight-factor as (65535-NAPTR preference), as per Annex B.2, for each candidate target node if no SRV weight factor is received from the DNS, i.e. when only NAPTR records with the "a" flag are provisioned. + +Annex E.1 provides an example illustrating these principles. + +When using GTP-C load control, the DNS should not be provisioned with a mix of NAPTR records with an "s" flag and with an "a" flag for a given FQDN. + +NOTE: It is not possible to directly compare the TNode-weight-factor used with SRV records with the TNode-weight-factor used when there is no SRV record. It is implementation specific how to distribute the load among candidate SGW or PGWs if the DNS is provisioned with a mix of NAPTR records with an "s" flag and with an "a" flag. + +## 4A.3 APN-level load control + +This clause specifies the extensions to the PGW selection procedures which shall be supported when GTP-C load control is supported and enabled at node level and APN level. + +A PGW may report the following APN load control information for a given APN via GTP-C signalling (see clause 12.2.4 of 3GPP TS 29.274 [23]): + +- APN-Load-Metric: this indicates the current resource utilization for a particular APN, as a percentage, compared to the total resources reserved for that APN at the target PGW; and +- APN-relative-capacity: this indicates the total resources configured for a given APN, compared to the total resources of the target PGW, as a percentage. It is a static parameter and does not change unless the resources configured for the APN change. + +The selecting node shall calculate the TNode APN weight factor of each candidate target node, considering the TNode APN relative capacity and the TNode weight factor as follows: + +$$\text{TNode-APN-weight-factor} = \text{TNode-weight-factor} \times \text{TNode-APN-relative-capacity}.$$ + +The node performing the PGW selection shall then apply the principles and assumption specified in clause 4A.1 with the following additions or modifications: + +- the selecting node shall substitute node level (TNode-"X") parameters with their corresponding APN level (TNode-APN-"X") parameters to calculate the relative APN available load of each candidate target node, i.e.: + +$$\text{TNode-APNx-effective-available-load} = (100 - \text{TNode-APNx-load-metric}) \% \times \text{TNode-APNx-weight-factor}$$ + +$$\text{TNode-APNx-relative-available-load} = (\text{TNode-APNx-effective-available-load} / \text{sum-of-APNx-effective-available-load-of-all-the-nodes-in-TNodeList}) \times 100\%$$ + +- the selecting node shall then select the PGW for new session requests according to the TNode-APN-relative-available-load of each target candidate node, e.g. a TNode-APN-relative-available-load value of X% indicates that the corresponding target node should be selected for X% of the new sessions requests towards the requested APN. + +- If the candidate PGW did not provide APN load control information for an APN (called "APNx"), but provided APN load control information for other APNs (called "APNn"), the selecting node shall assume the following when computing the relative APN available load for that candidate PGW for the "APNx": + +$$\text{TNode-APNx-relative-capacity} = (100 - \text{sum of [TNode-APN-relative-capacity of other APNs "APNn"]}]) \text{ for the same PGW}$$ + +$$\text{TNode-APNx-load-metric} = \{ \text{TNode-load-metric} - \text{sum of [for each APNs in APNn (TNode-APN-load-metric} \times \text{TNode-APN-relative-capacity) / 100]} \} / \{ 100 - \text{sum of [TNode-APN-relative-capacity of each APNs in APNn]} / 100 \}$$ + +NOTE: The formula to compute the APNx load metric results from the following equation: + +$$\text{TNode-load-metric} \times \text{TNode-capacity} = \text{sum of [for each APNs in APNn (TNode-APN-load-metric} \times \text{TNode-capacity} \times \text{TNode-APN-relative-capacity) / 100]} + \text{TNode-APNx-load-metric} \times \text{TNode-capacity} \times (100 - \text{sum of [TNode-APN-relative-capacity of each APNs in APNn]} / 100)$$ + +- If the candidate PGW did not provide APN load control information for any APN, the selecting node shall assume the following when computing the relative APN available load for that candidate PGW for an APN: + +$$\text{TNode-APNx-relative-capacity} = 100$$ + +$$\text{TNode-APNx-load-metric} = \text{TNode-load-metric (i.e. the load at the target node level)}$$ + +Annex E.2 provides examples illustrating these principles. + +# 5 Procedures for EPC Node Discovery and Selection + +## 5.1 Procedures for Discovering and Selecting a PGW + +### 5.1.1 Discovering a PGW for a 3GPP Access + +#### 5.1.1.1 General + +The procedures here give a list of possible PGWs and their interfaces that serve a particular APN. This is very similar to the existing function that resolves the GGSN IP address based on an APN. + +NOTE 1: The RAI/RNC-ID FQDN is used in addition to the APN FQDN when selecting the GGSN for SIPTO above RAN enabled APN. See clause 5.6. + +However, the Release-8 behaviour includes more functionality than pre-Release-8 systems since the PGW now can support more than one protocol and there is sometimes a desire to have the PGW and SGW collocated or topologically close to each other (with respect to the network topology), if possible. New DNS records are required to distinguish between different protocols and interfaces and assist in the more complicated selections. + +The operator shall provision the authoritative DNS server(s) responsible for the APN-FQDN, including all derivatives used by the operator in the APN-OI replacement field (as defined in 3GPP TS 23.060 [18] and 3GPP TS 23.401 [11]) with NAPTR records for the given APN-FQDN and corresponding PGWs under the APN-FQDN. + +See clause 19.4.2.2 of 3GPP TS 23.003 [4]. + +The above format is used in DNS for use in DNS queries by S4-SGSN and MME to networks with DNS provisioned to Release-8. A Release-8 SGSN only supporting Gn/Gp may also optionally use this procedure. + +The DNS records provisioned at that location are NAPTR records and include all S5/S8 and Gn/Gp interfaces for PGW, GGSN, and collocated PGW/GGSN that are intended to be used for that APN. + +The pre-Release-8 format APN as specified in clause 9.1 of 3GPP TS 23.003 [4] is still used in pre-Release-8 SGSN DNS queries and continues to be used as a fallback in Release-8 SGSN for discovering Gn/Gp interfaces. + +The DNS records provisioned at that location are A and/or AAAA records but only for the Gn/Gp interfaces of a standalone GGSN or collocated PGW/GGSN. + +The APN-FQDN is derived from the APN where the APN is typically in the legacy format of ".mnc.mcc.gprs" as specified in clause 9.1 of 3GPP TS 23.003 [4]. + +NOTE 2: The APN-FQDN is used for DNS query purposes in Release-8. It does not imply a change in the use or format of the APN in other protocols, nodes or UE/MS. The APN-FQDN and the APN use independent formats but are related as below for DNS usage by the MME and S4-SGSN. + +The APN received by the EPC node discovery function for 3GPP accesses, is always of the form of an APN-NI part and operator part. It is the output from Annex A of 3GPP TS 23.060 [18], which is exactly three labels with last label "gprs". + +If the APN is constructed using the default APN-OI or using the APN-OI Replacement field (as defined in 3GPP TS 23.060 [18] and 3GPP TS 23.401 [11]), then the APN-FQDN shall be obtained from the APN as specified in clause 19.4.2.2.1 of 3GPP TS 23.003 [4], otherwise the APN is considered to be invalid and cannot be used. + +In Annex A of 3GPP TS 23.060 [18] the SDL diagram refers to a "DNS interrogation" succeeding or failing which is the only DNS interaction. This is clarified as follows: + +For the procedures defined in the present document the APN-FQDN shall be used in the S-NAPTR with a NAPTR query (see later clauses for details). If the S-NAPTR procedure succeeds the "DNS interrogation" succeeds. If the S-NAPTR procedure fails to find a PGW or collocated PGW/GGSN then the "DNS interrogation" fails. + +For the legacy procedures defined in Annex A of 3GPP TS 23.060 [18] the unmodified APN shall be used in the DNS A query and DNS AAAA query. If either query succeeds, the "DNS interrogation" succeeds. If the A and AAAA queries both fail then the "DNS interrogation" fails. + +The nodes responsible for the PGW selection (i.e. the MME or S4-SGSN) shall apply the additions specified in clause 4A, if GTP-C load control is supported and enabled. + +#### 5.1.1.2 Discovering a PGW or collocated PGW/GGSN for a 3GPP Access - S8/Gp roaming case existing PDN + +This clause covers the case where the SGW or S4-SGSN is in the visiting network, the SGW is already pre-selected by having at least one existing PDN connection and a UE attempts to create a new PDN connection for a different APN to be selected in the home network. + +Operators shall provision NAPTR records for each APN-FQDN that allows roaming with at least "Service Parameters" of + +"x-3gpp-pgw:x-s8-gtp", "x-3gpp-pgw:x-s8-pmip", "x-3gpp-ggsn:x-gp", "x-3gpp-pgw:x-gp" + +for each such supported interface of that type. + +The S-NAPTR procedure, employed by the MME or S4-SGSN, to discover all S8 interfaces shall use "Service Parameters" of + +"x-3gpp-pgw:x-s8-gtp", "x-3gpp-pgw:x-s8-pmip"" + +as defined in clause 19.4.3 of 3GPP TS 23.003 [4], and set the Application-Unique String to the APN FQDN as defined in clause 19.4.2.2 of 3GPP TS 23.003 [4]. The "Service Parameter" of "x-3gpp-pgw:x-gp" shall be included if the MME or S4-SGSN wishes to potentially bias towards a collocated PGW/GGSN. + +Additional requirements to support DCN are specified in clause 5.8. + +The S-NAPTR procedure logically outputs a list of host names each with a service, protocol, port and a list of candidate IPv4 and IPv6 addresses. This is a "candidate" list of PGW or collocated PGW/GGSN for that APN (see Annex C.2 for an informative description of a candidate list and Annex B for the S-NAPTR procedure). + +The above procedure shall be used by the MME or S4-SGSN to select the PGW or collocated PGW/GGSN. + +NOTE 1: When an LTE capable terminal is in GERAN/UTRAN access, the S4-SGSN might wish to preferentially select a node with both Gp and S8 (i.e. a co-located PGW/GGSN) based on an operator policy. A preference for a co-located PGW/GGSN may also exist in an LTE access based on operator policy. The MME, or Release-8 SGSN, may find co-located PGW/GGSN nodes by searching the APN "candidate" list for interfaces with the same canonical node name in a Gp interface host name and S8 interface host name. + +The PGW and SGW cannot be collocated in this case since the SGW and PGW are in different operator networks. Furthermore, topological matching by DNS host names shall not be done since the host names are under different operators' administrative control. + +The Service Parameter of "x-3gpp-pgw:x-gp" denotes a collocated Release 8 GGSN function on a PGW. A PGW with a collocated Release 8 GGSN function may be preferred subject to operator policies. If that is the case the collocated PGW/GGSN nodes should be moved to the front of the candidate list but otherwise retaining the same relative order. The interfaces from the candidate list that are not S8 based shall be removed. The PGW S8 interfaces are tried in order from the candidate list. + +NOTE 2: Contrary to the non-roaming case, in the roaming case the domain name of the SGW interface selected does not influence the PGW selection. + +In the above procedure after the PGW has been contacted, the selected PGW node name, selected IP address, port (if non standard) and selected protocol type (GTPv2 vs. PMIP) shall be stored in the MME or S4-SGSN so it can be accessed on a PDN basis. + +NOTE 3: In this release of 3GPP only standard ports are used. + +3GPP TS 23.401 [11] currently indicates only one of PMIP or GTPv2 will be used based on roaming agreements so the above query would actually not require both *gtp* and *pmip*. The operator could use the order field in the NAPTR records to accomplish an optional fallback to the other protocol type. + +Use cases where a SGW needs to be selected are covered in clause 5.2. However, since Gn/Gp access bypasses SGW selection completely both for subsequent PDP context activations and initial attach we note that special case here. + +If the UE is in GERAN or UTRAN access and the Release 8 SGSN supports Gp, but not S4, the procedure above is modified as follows. The "Service Parameters" shall be + +"x-3gpp-pgw:x-gp" , "x-3gpp-ggsn:x-gp" + +Additional requirements to support DCN are specified in clause 5.8. + +If an LTE capable mobile is in GERAN/UTRAN access a PGW with a collocated PGW/GGSN function may be preferred subject to operator policies. If that is the case the PGW/GGSN nodes should be moved to the front of the candidate list but otherwise retaining the same relative order. The rest of the procedure is the same as above. + +If the APN record does not exist at the .3gppnetwork.org domain and the UE is in GERAN or UTRAN access and the Release 8 SGSN supports Gp then the pre Release-8 DNS procedures shall apply for the APN lookup by the Release 8 SGSN (i.e. APN lookup by A/AAAA records in the domain .gprs). + +#### 5.1.1.3 Discovering a PGW or collocated PGW/GGSN for a 3GPP Access - S5/Gn intra-operator existing PDN + +Operators shall provision NAPTR records for each APN-FQDN for use within their network with at least "Service Parameters" of + +"x-3gpp-pgw:x-s5-gtp", "x-3gpp-pgw:x-s5-pmip", "x-3gpp-ggsn:x-gn", "x-3gpp-pgw:x-gn" + +for each such supported interface of that type. + +Assuming the SGW is already pre-selected by having an existing PDN connection and a UE attempts to create a new PDN connection for a different APN in the user's home network, then the MME or S4-SGSN shall perform the following procedure: + +The S-NAPTR procedure, employed by the MME or S4-SGSN to discover S5 interfaces shall use "Service Parameters" of + +"x-3gpp-pgw:x-s5-gtp", "x-3gpp-pgw:x-s5-pmip" + +as defined in clause 19.4.3 of 3GPP TS 23.003 [4], and set the Application-Unique String to the APN FQDN as defined in clause 19.4.2.2 of 3GPP TS 23.003 [4]. The "Service Parameter" of "x-3gpp-pgw:x-gn" shall be included if the MME or S4-SGSN wishes to potentially bias towards a collocated PGW/GGSN. + +Additional requirements to support DCN are specified in clause 5.8. + +The S-NAPTR procedure logically outputs a list of host names each with a service, protocol, port and a list of candidate IPv4 and IPv6 addresses. This is a "candidate" list of PGW or collocated PGW/GGSN for that APN (see Annex C.2 for an informative description of a candidate list and Annex B for the S-NAPTR procedure). + +Collocation and topological ordering between the PGW and SGW applies in this case. + +If the existing SGW hostname has "topoff" then the candidate list of PGW shall be used in the order given to try to contact a PGW, after moving any colocated SGW/PGW to the front of the candidate list while maintaining relative order within that set. + +The Service Parameter of "x-3gpp-pgw:x-gn" denotes a collocated Release 8 GGSN function on a PGW. A PGW with a collocated Release 8 GGSN function may be preferred subject to operator policies. If that is the case the collocated PGW/GGSN nodes should be moved to the front of the candidate list but otherwise retaining the same relative order. The interfaces from the candidate list that are not S5 based shall be removed. The PGW S5 interfaces are tried in order from the candidate list.. + +If the existing SGW hostname has "topon" the two candidate lists shall be used in the procedure in Annex C.4 with the PGW as "A" and the SGW as "B". Annex C.4 results in a list of PGW to try in order. + +Once a PGW is successfully contacted the selected PGW host name, PGW IP address used, port (if non-standard) and selected protocol type (GTP vs PMIP) shall be stored in the MME or S4-SGSN so it can be accessed on a PDN basis. + +NOTE 1: In this release of 3GPP only standard ports are used. + +Use cases where a SGW needs to be selected are covered in clause 5.2 and clause 5.3. However, since Gn/Gp access bypasses SGW selection completely both for subsequent PDP context activations and initial attach we note that special case here. + +If the UE is in GERAN or UTRAN access and the Release 8 SGSN supports Gn, but not S4, the procedure above is modified as follows. The "Service Parameters" shall be + +"x-3gpp-pgw:x-gn", "x-3gpp-ggsn:x-gn" + +Additional requirements to support DCN are specified in clause 5.8. + +NOTE 2: When the SGSN supports Gn selects the GGSN or collocated PGW/GGSN for SIPTO above RAN enabled APN, in addition to the APN FQDN, the S-NAPTR procedure use the "Service Parameters" of "x-3gpp-pgw:x-gn", "x-3gpp-ggsn:x-gn", and set the Application-Unique String to the RAI FQDN as specified in clause 5.5.2 or the RNC-ID FQDN as specified in clause 19.4.2.7 of 3GPP TS 23.003 [4]. See clause 5.6. + +If an LTE capable mobile is in GERAN/UTRAN access a PGW with a collocated PGW/GGSN function may be preferred subject to operator policies. A preference for a co-located PGW/GGSN may also exist in an LTE access based on operator policy. The MME, or Release-8 SGSN, may find co-located PGW/GGSN nodes by searching the APN "candidate" list for interfaces with the same canonical node name in a Gn interface host name and S5 interface host name. If that is the case the PGW/GGSN nodes should be moved to the front of the candidate list but otherwise retaining the same relative order. The rest of the procedure is the same as above. + +If the APN record does not exist at the .3gppnetwork.org domain and the UE is in GERAN or UTRAN access and the Release 8 SGSN supports Gn then the pre Release-8 DNS procedures shall apply for the APN lookup by the Release 8 SGSN (i.e. APN lookup by A/AAAA records in the domain .gprs). + +Those procedures apply also to the case of roaming with local breakout when subscription data and network policy allow selection of a PGW from the VPLMN (see e.g. clause 4.2.2 in 3GPP TS 23.401 [11]). + +#### 5.1.1.4 Discovering a PGW, collocated PGW/GGSN or GGSN for a 3GPP Access - S5/Gn intra-operator initial attach + +During the initial attach and PDN connection creation using a 3GPP access both a PGW and an SGW need to be selected by an MME and will also be used by a S4-SGSN in PDP context creation. The discovery and selection procedures for cases employing a SGW are the same as for the PGW and the SGW discovery and selection procedure described in clause 5.3. + +The discovery and selection procedures for a Release-8 SGSN selecting a Gn interface for PDP context creation are in clause 5.1.1.3. + +### 5.1.2 Discovering a PGW for a non-3GPP Access with Network Based Mobility Management + +#### 5.1.2.1 Discovering a PGW for a non-3GPP Access – S2a/S2b initial attach for roaming and non-roaming + +The MAG functionality or TWAN within the trusted non-3GPP IP access or the e-PDG shall use the S-NAPTR procedure with "Service Parameters" of + +"x-3gpp-pgw:x-s2a-pmip", "x-3gpp-pgw:x-s2b-pmip", "x-3gpp-pgw:x-s2a-mipv4", "x-3gpp-pgw:x-s2b-gtp", +"x-3gpp-pgw:x-s2a-gtp" + +and the APN-FQDN as the Application-Unique String. + +.apn.epc.mnc.mcc.3gppnetwork.org + +See clause 19.4.2.2 of 3GPP TS 23.003 [4]. + +Additional requirements to support DCN are specified in clause 5.8. + +The S-NAPTR procedure logically outputs a list of host names each with a service, protocol, port and a list of IPv4 and IPv6 addresses. This is a "candidate" list of PGW for that APN (see Annex B for S-NAPTR procedure and see Annex C.2 for an informative description of a candidate list). + +There is no requirement for selection for a collocated PGW/SGW in this procedure. In the above procedure, the selected PGW node name, port and selected type (PMIPv6, MIPv4 or GTP) shall be stored in the MAG functionality, TWAN or the ePDG so it can be accessed on a PDN basis. + +The nodes responsible for the PGW selection (i.e. the TWAN or ePDG) shall apply the additions specified in clause 4A, if GTP-C load control is supported and enabled. + +#### 5.1.2.2 Discovering a PGW for a non-3GPP Access – S2a/S2b initial attach and chained PMIP-based S8-S2a/S2b + +The MAG functionality within the trusted non-3GPP IP access or the e-PDG shall use the S-NAPTR procedure with the "Service Parameters" of + +"x-3gpp-pgw:x-s2a-pmip", "x-3gpp-pgw:x-s2b-pmip" + +and the APN-FQDN as the Application-Unique String. + +.apn.epc.mnc.mcc.3gppnetwork.org + +See clause 19.4.2.2 of 3GPP TS 23.003 [4]. + +The S-NAPTR procedure logically outputs a list of host names each with a service, protocol, port and a list of IPv4 and IPv6 addresses. This is a "candidate" list of PGW for that APN (see Annex B for S-NAPTR procedure and see Annex C.2 for an informative description of a candidate list). + +The MAG selects a PGW based on the protocol type (GTP v/s PMIPv6) supported over the S5/ S8 interface based on information received over STa and SWm interfaces. + +The PGW and SGW cannot be collocated in this case since the SGW and PGW are in different operator networks. + +The DNS records in the order returned are then used to contact the PGW node. + +The nodes responsible for the PGW selection (i.e. the TWAN or ePDG) shall apply the additions specified in clause 4A, if GTP-C load control is supported and enabled. + +### 5.1.3 Discovering a PGW for a non-3GPP Access with DSMIPv6 + +#### 5.1.3.1 Discovering a PGW for a non-3GPP Access – S2c initial attach + +This clause covers the case where the IP address of the Home Agent (HA) functionality of a particular PGW needs to be discovered from the FQDN of the PGW. This query may be sent from a trusted access gateway or from an ePDG. The trusted access gateway or ePDG shall use the S-NAPTR procedure with "Service Parameters" of + +"x-3gpp-pgw:x-s2c-dsmip" + +as defined in clause 19.4.3 of 3GPP TS 23.003 [4], and the Application-Unique String set to the FQDN of the specific PGW. + +The nodes responsible for the PGW selection (i.e. the TWAN or ePDG) shall apply the additions specified in clause 4A, if GTP-C load control is supported and enabled. + +## 5.2 Procedures for Discovering and Selecting a SGW + +### 5.2.1 General + +These procedures are employed when an SGW needs to be selected by an EPC core node and a PGW has already been selected. In particular for the tracking area update procedure with SGW change. + +The SGW is selected based on the target cell where the UE has moved into. The MME has the new target eNodeB cell ID (eCID)/target eNodeB-ID and TAI available. The MME shall construct the TAI FQDN as defined in clause 19.4.2.3 of 3GPP TS 23.003 [4] and the MME shall construct the eNodeB-ID FQDN as defined in clause 19.4.2.10 of 3GPP TS 23.003 [4]. + +The selected SGW shall serve the UE's TAI and/or eNodeB-ID. During the attach/TAU/Handover procedure the MME receives the TAI value and eNodeB-ID which is derived from the ECGI or received from the source MME/SGSN. The MME shall construct the TAI FQDN as defined in clause 19.4.2.3 of 3GPP TS 23.003 [4] and eNodeB-ID FQDN as defined in clause 19.4.2.10 of 3GPP TS 23.003 [4]. + +Operators shall provision, for each TAI/eNodeB-ID value in their network, NAPTR records under the TAI/eNodeB-ID FQDN corresponding to each valid SGW interfaces from the following "Service Parameters" + +"x-3gpp-sgw:x-s8-gtp", "x-3gpp-sgw:x-s8-pmip", "x-3gpp-sgw:x-s5-gtp", "x-3gpp-sgw:x-s5-pmip" + +where additional "Service Parameters" may be included optionally. + +Additional requirements to support DCN are specified in clause 5.8. + +For each RAI/RNC-ID value that is served by a S4-SGSN the same records would be provisioned under the RAI FQDN (see clause 5.5.2 for the RAI FQDN) or the RNC-ID FQDN (see clause 19.4.2.7 of 3GPP TS 23.003 [4] for the RNC-ID FQDN). + +The S-NAPTR procedure employed by an MME for finding a candidate set of SGW nodes shall use the TAI FQDN/eNodeB-ID FQDN as the Application-Unique String. + +For the purposes of this document the NAPTR record-set at that location will be called the TAI/eNodeB-ID NAPTR record-set. + +The MME selects the S11 interface of the SGW from the SGW's canonical node record (see clause 4.3.3) if it is not obtained from the TAI/eNodeB-ID records. + +NOTE: If an operator does not use the "a" and "s" flags in the TAI/eNodeB-ID NAPTR records (i.e. they use the "" flag) and they are using SGW service areas it is strongly recommended that the TAI/eNodeB-ID NAPTR records point directly to NAPTR records representing the SGW service areas. This is to facilitate possible future use in the SGW Load Re-balancing procedure. + +For the case of an S4-SGSN making the SGW selection the RAI FQDN (see clause 5.5.2) or the RNC-ID FQDN (see clause 19.4.2.7 of 3GPP TS 23.003 [4] for the RNC-ID FQDN) is used instead of the TAI FQDN or the eNodeB-ID FQDN to select the SGW but is otherwise the same as the MME handling TAU. The S4-SGSN selects the S4 interface of the SGW from the SGW's canonical node record (see clause 4.3.3) if it is not obtained from the RAI/RNC-ID records. + +S-GW selection when SGW that acts as a local anchor for non-3GPP access in the case of S8-S2a/b chained roaming is outside the scope of this specification. + +The nodes responsible for the SGW selection (i.e. the MME or S4-SGSN) shall apply the additions specified in clause 4A, if GTP-C load control is supported and enabled. + +### 5.2.2 SGW Selection during TAU or RAU with SGW change - 3GPP roaming case + +For the roaming case the type of protocol (PMIP vs. GTP) is chosen based on a roaming agreement according to 3GPP TS 23.401 [11]. The MME shall therefore use the S-NAPTR procedure with "Service Parameters" of + +"x-3gpp-sgw:x-s8-gtp" or "x-3gpp-sgw:x-s8-pmip" + +Additional requirements to support DCN are specified in clause 5.8.(based on whether GTP v2 or PMIPv6 is used for the current PDN connection) + +as defined in clause 19.4.3 of 3GPP TS 23.003 [4], and possibly restricted based on a roaming agreement to use only GTPv2 or PMIPv6 and set the Application-Unique String to the TAI FQDN as defined in clause 19.4.2.3 of 3GPP TS 23.003 [4] or the eNodeB-ID FQDN as defined in clause 19.4.2.10 of 3GPP TS 23.003 [4]. + +The S-NAPTR procedure logically outputs a list of host names each with a service, protocol, port and a list of IPv4 and IPv6 addresses. This is a "candidate" list of SGW for that TAI/eNodeB-ID (see Annex B for S-NAPTR procedure and see Annex C.2 for an informative description of a candidate list). + +If the first choice protocol (PMIP or GTPv2) fails the second choice MAY be tried subject to the operators' roaming agreements. + +Neither collocation of PGW and SGW nor topological ordering rules apply in this case. + +The present clause to this point implicitly assumes only one PDN connection is currently employed by a UE which may not be the case with multiple PDN connections for the same UE. All PDN connections after the TAU must be on the same SGW since there is only one SGW at a time for a UE. + +If an existing PDN for the UE is PMIPv6 S8 and some existing PDN for the UE is GTPv2 S8 then a SGW supporting both protocols is required. If that occurs and there are no such SGW then the PDN connections with the least important retention (from the ARP value) would have to be dropped until a list of viable SGW of one protocol meeting the retention policies is found. If there are non viable SGW they are removed from the original SGW candidate list. After this point the SGW candidate list order is used in the same way as it was in the case of only one PDN connection. + +Once an SGW is successfully contacted the selected SGW host name, selected SGW IP address, selected port (if non-standard) and selected protocol type (GTPv2 vs. PMIP - which is unchanged here) shall be stored in the MME so it can be accessed on a PDN basis. + +NOTE 1: In this release of 3GPP only standard ports are used. + +For the case of an S4-SGSN making the SGW selection the RAI FQDN (see clause 5.5.2) or the RNC-ID FQDN (see clause 19.4.2.7 of 3GPP TS 23.003 [4] for the RNC-ID FQDN) is used instead of the TAI/eNodeB-ID FQDN to select the SGW but is otherwise the same as the MME handling TAU. The S4-SGSN selects the S4 interface of the SGW from the SGW's canonical node record (see clause 4.3.3) if it is not obtained from the RAI/RNC-ID records. + +NOTE 2: A SGW will need to be selected at a handover attach from another access type. The SGW selection method is the same as presented here since there are existing PDN connections (typically PMIPv6 for non-3GPP accesses). + +### 5.2.3 SGW Selection during TAU or RAU with SGW change - non-roaming case + +This differs from the 3GPP roaming case in 5.2.2 primarily in that the PGW and the SGW are in the same network. Hence, there is a need to be able of selecting a SGW collocated with the PGW or a topologically close SGW. The current PGW's node name should previously have been stored in the MME or S4-SGSN when the default bearer was established or transported from the old MME to the new MME, and is therefore available for comparison. + +For the non-roaming case the S-NAPTR procedure shall be initiated with "Service Parameters" of + +"x-3gpp-sgw:x-s5-gtp" and/or "x-3gpp-sgw:x-s5-pmip" + +Additional requirements to support DCN are specified in clause 5.8.(based on whether GTPv2 or PMIPv6 is used for the current PDN connection) + +as defined in clause 19.4.3 of 3GPP TS 23.003 [4], and set the Application-Unique String to the TAI FQDN as defined in clause 19.4.2.3 of 3GPP TS 23.003 [4]. The Application-Unique-String may be set to the eNodeB-ID FQDN as defined in clause 19.4.2.10 of 3GPP TS 23.003 [4] as an operator specific deployment option. + +The S-NAPTR procedure logically outputs a list of host names each with a service, protocol, port and a list of IPv4 and IPv6 addresses. This is a "candidate" list of SGW for that TAI/eNodeB-ID (see Annex B for S-NAPTR procedure and see Annex C.2 for a more detailed informative description of a candidate list). + +Collocation of PGW and SGW and topological ordering rules both apply in this case.If the existing PGW hostname for the PDN has "topoff" then the "candidate" list of SGW would be used in the order given to try to contact a SGW after moving the PGW with the same SGW node name to the front of the list keeping relative order. + +If the existing PGW hostname has "topon" the two candidate lists shall be used in the procedure in Annex C.4 with the SGW as "A" and the PGW as "B". Annex C.4 results in a list of SGW to try in order. + +The present clause to this point implicitly assumes only one PDN connection is currently employed by a UE which may not be the case with multiple PDN connections for the same UE. + +If an existing PDN for the UE is PMIPv6 S5 and some existing PDN for the UE is GTPv2 S5 then a SGW supporting both protocols is required. If that occurs and there are no such SGW then the PDN connections with the least important retention (from the ARP value) would have to be dropped until a list of viable SGW of one protocol meeting the retention policies is found. If there are non viable SGW they are removed from the original SGW candidate list. After this point the SGW candidate list order is used in the same way as it was in the case of only one PDN connection. + +After this point it is a matter of operator policy or vendor implementation which PDN or PDNs (and hence their corresponding PGW canonical node names) are used for selecting the corresponding best SGW interface. + +NOTE 1: One possible option would be as follows. First try to maximize the number of PDN connections that are on PGW colocated on the same viable SGW. If there are no colocated choices the PGW giving the closest topological match to any viable SGW are used. If they are all equal then SGW ordering from the SGW candidate list is used. This approach would be very similar, but not identical, to passing the list of PGW being used as list "B" and the SGW candidate list with only viable SGW as list "A" in the procedure in Annex C.4 + +Once an SGW is successfully contacted the selected SGW host name, SGW IP address used, port (if non-standard) and selected type (GTP vs PMIP) shall be stored in the MME so it can be accessed on a PDN basis. + +NOTE 2: In this release of 3GPP only standard ports are used. + +For the case of an S4-SGSN making the SGW selection the RAI FQDN (see clause 5.5.2) is used or as an operator deployment option the Application-Unique-String may be set to the RNC-ID FQDN as defined in clause 19.4.2.7 of 3GPP TS 23.003 [4] instead of the TAI/eNodeB-ID FQDN to select the SGW but is otherwise the same as the MME handling for TAU. The S4-SGSN selects the S4 interface of the SGW from the SGW's canonical node record (see clause 4.3.3) if it is not obtained from the RAI or RNC-ID records. + +NOTE 3: A SGW will need to be selected at a handover attach from another access type. The SGW selection method is the same as presented here since there are existing PDN connections (typically PMIPv6 for non-3GPP accesses). + +NOTE 4: eNodeB-ID and RNC-ID FQDN are only employed by Release 10 or onwards MME/SGSNs for SGW selection. + +### 5.2.4 SGW Selection during non-3GPP handover to 3GPP access + +The SGW selection is similar with other cases. For the non-roaming case, there is a need of selecting a SGW collocated with the PGW or a topologically close SGW. The current PGW's node name should previously have been stored in the HSS and would be sent to the MME during the access authentication procedure and is therefore available for comparison. + +The S-NAPTR procedure for SGW Selection is same as clause 5.2.2 for roaming case, and is same as clause 5.2.3 for non-roaming case. + +## 5.3 Procedures for Discovering and Selecting a PGW and SGW + +This scenario applies to the UE initial attach and PDP context activation cases, where the MME or S4-SGSN has not yet assigned a PGW or a SGW to the UE. During the attach procedures, the MME shall select the SGW and the PGW as described below. During the UTRAN/GERAN PDP context activation procedure, the S4-SGSN shall select the SGW and the PGW as described below. + +NOTE 1: The procedure specified in this clause is not applied for the LGW selection for LIPA service or for SIPTO at the local network with LGW collocated with (H)(e)NB. The MME/S4 SGSN uses the LGW address proposed by the (H)(e)NB in the S1-AP/RANAP message as specified in 3GPP TS 36.413 [19] and 3GPP TS 25.413 [12] to select the appropriate LGW for LIPA service or for SIPTO at the local network with LGW collocated with (H)(e)NB. + +For SIPTO at the local network with stand-alone GW, the SGW shall be selected based on the < LHN name> provided by the (H)(e)NodeB during the attach or SIPTO at local network PDN connection creation. The MME shall construct the Local Home Network-ID FQDN defined in clause 19.4.2.11 of 3GPP TS 23.003 [4]. + +The selected SGW shall serve the UE's TAI/eNodeB-ID. During the attach procedure the MME receives the TAI value and eNodeB-ID which is derived from the ECGI. The S-NAPTR procedure to obtain a list of "candidate" SGW shall be used with "Service Parameters" of + +"x-3gpp-sgw:x-s5-gtp", "x-3gpp-sgw:x-s5-pmip" + +Additional requirements to support DCN are specified in clause 5.8. as defined in clause 19.4.3 of 3GPP TS 23.003 [4], and set the Application-Unique String set to the TAI FQDN as defined in clause 19.4.2.3 of 3GPP TS 23.003 [4] or as an operator specific deployment option the Application-Unique-String may be set to the eNodeB-ID FQDN as defined in clause 19.4.2.10 of 3GPP TS 23.003 [4]. For SIPTO at the Local Network with stand-alone GW the Local Home Network ID as defined in clause 19.4.2.11 of 3GPP TS 23.003 [4] shall be used to select the SGW. + +The S-NAPTR procedure logically outputs a list of host names each coupled with a service, a protocol, a port, and a list of IPv4 and IPv6 addresses. This is the "candidate" list of SGWs for a specific TAI/eNodeB-ID (see Annex B for S-NAPTR procedure and see Annex C.2 for an informativedescription of the candidate list). + +The list of "candidate" PGW is obtained as follows: + +The S-NAPTR procedure to get the list of "candidate" PGW shall use "Service Parameters" of + +"x-3gpp-pgw:x-s5-gtp", "x-3gpp-pgw:x-s5-pmip", "x-3gpp-pgw:x-gn" + +Additional requirements to support DCN are specified in clause 5.8. + +as defined in clause 19.4.3 of 3GPP TS 23.003 [4], and the Application-Unique String set to the APN FQDN as defined in clause 19.4.2.2 of 3GPP TS 23.003 [4]. + +The S-NAPTR procedure logically outputs a list of host names each coupled with a service, a protocol, a port, and a list of IPv4 and IPv6 addresses. This is the "candidate" list of PGWs for a specific APN (see Annex C.2 for a detailed description of a candidate list). + +The two candidate lists shall be used in the procedure described in Annex C.4 with the SGW as an "A" node type and the PGW as a "B" node type in the procedure. + +The procedure described in Annex C.4 results in a selection of a SGW and a PGW along with the protocol, the IP address and the port. In the case of a failure to contact the SGW or the PGW, the required gateway reselection procedures are described in Annex C.4. + +The MME selects the S11 interface of the SGW from the SGW's canonical node record (see clause 4.3.3) if it is not obtained from the TAI records. + +NOTE 2: The MME (S4-SGSN) send a GTPv2 Create Session Request to the SGW respectively over S11 or S4 with the IPv4/IPv6 address of the PGW. After the SGW has been successfully contacted over S11 or S4, the SGW can try to contact the PGW over S5/S8. + +Once the SGW has successfully been contacted, the selected SGW host name, the used SGW IP address, the port number and the selected protocol type shall be stored in the MME or S4-SGSN per PDN. + +Once the PGW has successfully been contacted, the selected PGW host name, the used PGW IP address, the port number and the selected protocol type shall be stored in the MME or S4-SGSN per PDN. + +For the case of an S4-SGSN making the selection the RAI FQDN is used, or as an operator deployment option the Application-Unique-String may be set to the RNC-ID FQDN as defined in clause 19.4.2.7 of 3GPP TS 23.003 [4] instead of the TAI FQDN/eNodeB-ID FQDN to select the SGW but is otherwise the same as an MME doing the selection. The S4-SGSN selects the S4 interface of the SGW from the SGW's canonical node record (see clause 4.3.3) if it is not obtained from the RAI or RNC-ID records. + +The nodes responsible for the SGW and PGW selection (i.e. the MME or S4-SGSN) shall apply the additions specified in clause 4A, if GTP-C load control is supported and enabled. + +## 5.4 Procedures for Discovering and Selecting an MME + +These procedures can be used as part of: + +- the 'Inter eNodeB handover with MME relocation' procedure to select an MME; +- the RAN Information Management (RIM) procedure to select an MME; +- UTRAN/GERAN to E-UTRAN SRVCC procedure to select an MME as specified in 3GPP TS 23.216 [20]; +- IMSI and APN Information retrieval procedure for RAN User Plane Congestion mitigation to select an MME as specified in clause 5.9.3 of 3GPP TS 23.401[11]; +- NAS Message Redirection procedure to retrieve the MMEGI identifying the DCN serving a particular UE usage type as specified in 3GPP TS 23.401[11]; +- 5GS to EPS handover using N26 interface to select an MME, as specified in clause 4.11.1.2.1 of 3GPP TS 23.502 [29]; or +- EPS to 5GS handover using N26 interface to select an AMF, as specified in clause 4.11.1.2.2 of 3GPP TS 23.502 [29]. + +In the 'Inter eNodeB handover with MME relocation' procedure, the 'UTRAN Iu mode to E-UTRAN Inter RAT handover' procedure, the 'GERAN A/Gb mode to E-UTRAN Inter RAT handover' procedure, the 'UTRAN/GERAN to E-UTRAN SRVCC' procedure, the 5GS to EPS handover using N26 interface, the MME is selected based on the target cell where the UE is expected to move into. The MME has the new target eNodeB cell ID (eCID) and TAI available. The TAI includes the TAC, the MNC and the MCC. + +In the EPS to 5GS handover using N26 interface procedure, the AMF is selected based on the target 5GS TAI received from the source eNB. The 5GS TAI includes the 5GS TAC, the MNC and the MCC. + +In the 'IMSI and APN Information retrieval' procedure, the MME is selected based on the TAI of the cell or eNodeB that is congested in the user plane. The RCAF has the congested eNodeB cell ID (eCID) and TAI available. The TAI includes the TAC, the MNC and the MCC. + +The S-NAPTR procedure for finding a candidate set of MME nodes for a target TAI is always started at the TAI FQDN as defined in clause 19.4.2.3 of 3GPP TS 23.003 [4]. The S-NAPTR procedure performed at the source MME/S4-SGSN/AMF for finding a candidate set of target MME nodes is started with at least the "Service Parameters" of + +"x-3gpp-mme:x-s10" + +as defined in clause 19.4.3 of 3GPP TS 23.003 [4]. + +The S-NAPTR procedure for finding a candidate set of AMFs for a target 5GS TAI shall be started at the 5GS TAI FQDN as defined in clause 28.3.2.6 of 3GPP TS 23.003 [4]. The S-NAPTR procedure performed at the source MME for finding a candidate set of target AMF nodes is started with at least the "Service Parameters" of + +"x-3gpp-mme:x-s10" + +as defined in clause 19.4.3 of 3GPP TS 23.003 [4]. + +Additional requirements to support DCN are specified in clause 5.8. + +The S-NAPTR procedure logically outputs a list of host names each with a service, protocol, port and a list of IPv4 and IPv6 addresses. This is a "candidate" list of MMEs (or AMFs) for that TAI (or 5GS TAI) (see Annex C.2 for a more detailed description of a candidate list). + +Topological closeness shall not be used for the MME selection so the MME candidate list would be used in the order given to try to contact a MME. + +NOTE 1: The source MME/S4-SGSN may wish to preferentially select a target MME that is co-located with a SGSN function based on an operator policy. The S-NAPTR procedure using the canonical node name (clause 4.3.3) may be used to find any co-located SGSN interfaces in the candidate list. Optionally an operator may provision NAPTR records with "x-3gpp-sgsn:x-gn" and/or "x-3gpp-sgsn:x-s4" at the TAI FQDN to allow an MME to directly get a candidate list for the co-located SGSN and hence for the source MME to match node names from the hostnames in the two candidate lists. + +NOTE 2: If an operator does not use the "a" and "s" flags in the TAI NAPTR records (i.e. they use the "" flag) it is strongly recommended that the TAI NAPTR records point directly to NAPTR records at mmegi.mme.epc.mnc.mcc.3gppnetwork.org (i.e. an MME pool ) + +NOTE 3: The above procedures for discovering and selecting an AMF are identical to the procedures specified for discovering and selecting an MME but using a 5GS TAI FQDN instead of a TAI FQDN; they can be used by MMEs not upgraded to support the procedure specified in clause 5.4A, during an EPS to 5GS handover using N26 interface. In this case, AMFs are provisioned in DNS as MMEs, following the mapping rules specified for EPS interworking with 5GS in clause 2.10.2 of 3GPP TS 23.003 [4]. + +For an S4-SGSN making the selection the "Service Parameter" of "x-3gpp-mme:x-s3" shall be employed instead of "x-3gpp-mme:x-s10". + +Additional requirements to support DCN are specified in clause 5.8. + +For an MSC making the selection the "Service Parameter" of "x-3gpp-mme:x-sv" shall be employed instead of "x-3gpp-mme:x-s10". + +For an RCAF making the selection of an MME the "Service Parameter" of "x-3gpp-mme:x-nq" shall be employed. + +An SGSN supporting only Gn/Gp may also optionally use this procedure with "Service Parameter" of "x-3gpp-mme:x-gn" in the '3G Gn/Gp SGSN to MME Combined Hard Handover and SRNS Relocation' procedure as specified in Annex D.3.4 of 3GPP TS 23.401 [11] . + +Additional requirements to support DCN are specified in clause 5.8. + +NOTE 4: The SGSN supporting only Gn/Gp need map the eNodeB id to the RNC id to avoid updating the Target ID IE in the GTPv1 Forward Relocation Request message. + +For the case when a UE is moving from a pre-Release-8 UTRAN/GERAN to an MME the pre-Release-8 source node will not be able to use the .3gppnetwork.org based records. As a result the MME being selected looks like a pre-Release-8 SGSN to a pre-Release-8 node performing a selection. For pre-Release 8 compatibility, operators would continue to provision A/AAAA records as per Annex C.1 of 3GPP TS 23.003 [4] for the corresponding MME Gn/Gp interfaces under the RNC-ID corresponding to the mapped target ID value (see clause D.3.4 of 3GPP TS 23.401 [11] and clause 5.5.3 of the present document). + +In the RAN Information Management (RIM) procedure, the MME is selected based on the Target eNodeB Identifier specified by source RAN node. + +### 5.4A Procedures for Discovering and Selecting an AMF with N26 interface + +These procedures can be used as part of: + +- EPS to 5GS handover using N26 interface to select an AMF, as specified in clause 4.11.1.2.2 of 3GPP TS 23.502 [29]. + +In the EPS to 5GS handover using N26 interface procedure, the AMF is selected based on the target 5GS TAI received from the source eNB. The 5GS TAI includes the 5GS TAC, the MNC and the MCC. + +The S-NAPTR procedure for finding a candidate set of AMFs for a target 5GS TAI shall be started at the 5GS TAI FQDN as defined in clause 28.3.2.6 of 3GPP TS 23.003 [4]. The S-NAPTR procedure performed at the source MME for finding a candidate set of target AMF nodes is started with at least the "Service Parameters" of + +"x-3gpp-amf:x-n26" + +as defined in clause 19.4.3 of 3GPP TS 23.003 [4]. + +Additional requirements to support DCN are specified in clause 5.8. + +The S-NAPTR procedure logically outputs a list of host names each with a service, protocol, port and a list of IPv4 and IPv6 addresses. This is a "candidate" list of AMFs for that 5GS TAI (see Annex C.2 for a more detailed description of a candidate list). + +### 5.4B Procedures for Discovering and Selecting an MME\_SRVCC + +These procedures can be used as part of: + +- 5G-SRVCC from NG-RAN to UTRAN procedure to select an MME\_SRVCC, as specified in clause 6.5 of 3GPP TS 23.216 [20]. + +In the 5G-SRVCC from NG-RAN to UTRAN procedure, the MME\_SRVCC is selected based on the Target ID received from the source NG-RAN. The Target ID includes the Target RNC ID. + +The S-NAPTR procedure for finding a candidate set of MME\_SRVCCs for a Target RNC ID shall be started at the Target RNC ID for UTRAN FQDN as defined in clause 19.4.2.7 of 3GPP TS 23.003 [4]. The S-NAPTR procedure performed at the source AMF for finding a candidate set of target MME\_SRVCC nodes is started with at least the "Service Parameters" of + +"x-3gpp-mme:x-s10" + +as defined in clause 19.4.3 of 3GPP TS 23.003 [4]. + +The S-NAPTR procedure logically outputs a list of host names each with a service, protocol, port and a list of IPv4 and IPv6 addresses. This is a "candidate" list of MME\_SRVCCs for that Target RNC ID (see Annex C.2 for a more detailed description of a candidate list). + +## 5.5 Procedures for Discovering and Selecting an SGSN + +### 5.5.1 General + +These procedures are employed: + +- when a target SGSN that serves the target cell or RNC needs to be initially selected by an EPC core node or Release-8 SGSN or an MSC. It explicitly does not cover selection of an SGSN by a RNC or BSS; +- as part of the UTRAN/GERAN to UTRAN (HSPA) SRVCC procedure to select an SGSN as specified in 3GPP TS 23.216 [20]; or +- for APN Information retrieval procedure for RAN User Plane Congestion mitigation to select an SGSN as specified in clause 6.17 of 3GPP TS 23.060[18]. +- NAS Message Redirection procedure to retrieve Null-NRI or the SGSN Group ID identifying the DCN serving a particular UE usage type as specified in 3GPP TS 23.401[11]. + +Clause 4.3.3.5 "Services of an SGSN from a P-TMSI" specifies how a target MME/S4-SGSN discovers the IP address of the source SGSN during Idle Mode Mobility from GERAN /UTRAN. + +EPC core nodes, i.e. the MME and the S4-SGSN employ the procedures below during the SRNS relocation procedure and the RAN Information Management (RIM) procedure. A Release-8 SGSN supporting only Gn/Gp may also optionally use this procedure. An MSC supporting UTRAN/GERAN to UTRAN (HSPA) SRVCC procedure to select an SGSN may also use this procedure as specified in 3GPP TS 23.216 [20]. + +The SGSN is selected based on information in the Target ID (see 3GPP TS 23.003 [4] and 3GPP TS 25.413 [12]). For PS GERAN the Target ID has the global cell ID including PLMN and for U-TRAN the Target ID has RAC, RNC-ID and PLMN. + +For the Fallback to GTPv1 scenario as specified in 3GPP TS 29.274 [23] clause 7.10, the new SGSN/MME shall send the related GTPv1 request message with the peer SGSN IP address on the Gn/Gp interface after receiving the GTPv2 response message with Cause "Fallback to GTPv1". The new MME/SGSN shall make another DNS query to obtain the peer SGSN IP address on the Gn/Gp interface if that address is not available. The A/AAAA query shall be used to obtain the peer SGSN IP address on the Gn/Gp interface. + +### 5.5.2 SGSN initial target selection based on RAI (UTRAN target/GERAN Iu mode target/GERAN Gb mode target) + +In both U-TRAN and GERAN cases the target RAC, LAC, MNC, and MCC are available from the information in the Target ID. This selection is done by an MME or Release-8 SGSN during SRNS relocation procedures and the RAN Information Management (RIM) procedures. + +The S-NAPTR procedure for an MME/SGSN finding a candidate set of SGSN services and interfaces serving the target Routing Area is started with "Service Parameters" of + +"x-3gpp-sgsn:x-gn", "x-3gpp-sgsn:x-gp", "x-3gpp-sgsn:x-s3", "x-3gpp-sgsn:x-nqprime" + +Additional requirements to support DCN are specified in clause 5.8. + +as defined in 3GPP TS 23.003 [4] and setting the Application-Unique String to the RAI FQDN based on RAC, LAC, MNC, MCC as defined in 3GPP TS 23.003 [4] clause 19.4.2.5: + +rac.lac.rac.epc.mnc.mcc.3gppnetwork.org + +The S-NAPTR procedure logically outputs a list of host names each with a service, protocol, port and a list of IPv4 and IPv6 addresses. This is a "candidate" list of SGSN for that RAI (see Annex B for S-NAPTR procedure and see Annex C.2 for a more informative description of a candidate list). + +NOTE 1: In the SRNS relocation procedure, for an MME making the selection there is an existing PDN connection (and hence an existing SGW) so the S3 interfaces would logically be preferred over the Gn/Gp interfaces to keep the existing PDN connection. However, if there is a colocated PGW/GGSN being employed with the 3GPP TS 23.401 [11] Annex D procedures then the Gn/Gp interfaces on the target SGSN can also be valid. Operators should prioritize the DNS records according to their preference. + +For an S4-SGSN making the selection the "Service Parameter" of "x-3gpp-sgsn:x-s16" shall be employed instead of "x-3gpp-sgsn:x-s3". + +Additional requirements to support DCN are specified in clause 5.8. + +For an MSC making the selection the "Service Parameter" of "x-3gpp-sgsn:x-sv" shall be employed instead of "x-3gpp-sgsn:x-s3". + +For an RCAF making the selection of an SGSN the "Service Parameter" of "x-3gpp-sgsn:x-nqprime" shall be employed. + +A Release 8 SGSN supporting only Gn/Gp may also optionally use this procedure with "Service Parameters" of "x-3gpp-sgsn:x-gn" and "x-3gpp-sgsn:x-gp". + +Additional requirements to support DCN are specified in clause 5.8. + +Operators shall provision, for each RAI value in their network, NAPTR records under the RAI FQDN corresponding to each valid SGSN interfaces from at least the following "Service Parameters" + +"x-3gpp-sgsn:x-gn", "x-3gpp-sgsn:x-gp", "x-3gpp-sgsn:x-s3", "x-3gpp-sgsn:x-s16", "x-3gpp-sgsn:x-nqprime" + +Additional requirements to support DCN are specified in clause 5.8. + +where NAPTR records for additional "Service Parameters" may be included optionally. + +NOTE 2: The NAPTR record at the RAI FQDN can be provisioned to correspond to only the default SGSN node(s) in the SGSN pool(s) serving that RAI. The default SGSN after the DNS procedure exits would be contacted with GTP, the default SGSN then selects the actual SGSN within that SGSN pool. This results in all relocation requests being handled by the default SGSN nodes. If the operator's goal is to avoid load on the default SGSN nodes then the records provisioned at the RAI FQDN should instead include the entire set of SGSN in all SGSN pools that service that RAI. The S-NAPTR procedure would then return each SGSN in the SGSN pool based on the provisioned DNS weights and priority. + +NOTE 3: The NAPTR record at the RAI FQDN for the service parameter of "x-3gpp-sgsn:x-nqprime" is provisioned with the entire set of SGSN in all SGSN pools that are serving that RAI. + +NOTE 4: The SGSN(s) closest to the geographical region covered by the RAI can be biased by provisioning the DNS records with higher priority or weights. + +3GPP does not require that collocation and "topon" naming is applicable in SGSN selection. + +NOTE 5: Service parameters are limited to those supported by the node doing the search. + +NOTE 6: SGW records will also be provisioned under the RAI FQDN see clause 5.2 + +In the SRNS relocation procedure, for the case when a UE is moving from a pre-Release-8 UTRAN/GERAN to a Release-8 target SGSN the pre-Release-8 source node will not be able to use the .3gppnetwork.org based records. As a result the Release 8 SGSN (or MME) being selected looks like a pre-Release 8 SGSN to a pre-Release-8 node performing a selection. For pre-Release 8 compatibility operators would continue to provision A/AAAA records as per Annex C.1 of 3GPP TS 23.003 [4] for the corresponding Gn/Gp interfaces regardless of whether the SGSN is pre-Release-8 or not. Vendors shall support pre-Release 8 DNS procedures on Release 8 SGSN. + +In the RAN Information Management (RIM) procedure, the SGSN is selected based on the RAI specified by source RAN node. + +### 5.5.3 SGSN initial target selection based on RNC-ID (UTRAN target/GERAN Iu mode target) + +NOTE 1: In the SRNS relocation procedure, the finer granularity this procedure allows only applies to UTRAN/GERAN Iu mode and only when different RNC-IDs have the same RAI values. + +This procedure is used for a UTRAN/GERAN Iu mode target in the SRNS relocation procedure and the RAN Information Management (RIM) procedure. + +In UTRAN/GERAN Iu mode case the target RNC-ID, MNC, and MCC are available from the information in the Target ID. + +The S-NAPTR procedure for an MME/S4- SGSN finding a candidate set of SGSN services and interfaces serving the target RNC is started with "Service Parameters" of + +"x-3gpp-sgsn:x-gn", "x-3gpp-sgsn:x-gp", "x-3gpp-sgsn:x-s3" + +Additional requirements to support DCN are specified in clause 5.8. + +as defined in 3GPP TS 23.003 [4] and setting the Application-Unique String to the RNC-ID FQDN based on RNC-ID,MNC,MCC as defined in 3GPP TS 23.003 [4] clause 19.4.2. 5. + +The S-NAPTR procedure logically outputs a list of host names each with a service, protocol, port and a list of IPv4 and IPv6 addresses. This is a "candidate" list of SGSN for that RNC-ID (see Annex B for S-NAPTR procedure and see Annex C.2 for a more informative description of a candidate list). + +NOTE 2: In the SRNS relocation procedure, for an MME making the selection there is an existing PDN connection (and hence an existing SGW) so the S3 interfaces would logically be preferred over the Gn/Gp interfaces to keep the existing PDN connection. However, if there is a colocated PGW/GGSN being employed with the 3GPP TS 23.401 [11] Annex D procedures then the Gn/Gp interfaces on the target SGSN can also be valid. Operators should prioritize the DNS records accordingly. + +For an S4-SGSN making the selection the "Service Parameter" of "x-3gpp-sgsn:x-s16" shall be employed instead of "x-3gpp-sgsn:x-s3". + +Additional requirements to support DCN are specified in clause 5.8. + +For an MSC making the selection the "Service Parameter" of "x-3gpp-sgsn:x-sv" shall be employed instead of "x-3gpp-sgsn:x-s3". + +A Release 8 SGSN supporting only Gn/Gp may also optionally use this procedure with "Service Parameters" of "x-3gpp-sgsn:x-gn" and "x-3gpp-sgsn:x-gp". Additional requirements to support DCN are specified in clause 5.8. If there are no NAPTR records at that RNC-ID then the RAI based lookup in clause 5.5.2 shall be used as a fallback. + +Operators using this feature shall provision, for each RNC-ID value in their network, NAPTR records under the RNC-ID FQDN corresponding to each valid SGSN interfaces from the following "Service Parameters" + +"x-3gpp-sgsn:x-gn", "x-3gpp-sgsn:x-gp", "x-3gpp-sgsn:x-s3", "x-3gpp-sgsn:x-s16", + +Additional requirements to support DCN are specified in clause 5.8. + +where NAPTR records for additional "Service Parameters" may be included optionally. + +Operators not using this feature shall not provision the RNC-ID records. + +NOTE 3: The NAPTR record at the RNC-ID FQDN can be provisioned to correspond to only the default SGSN node(s) in the SGSN pool(s) serving that RNC. The default SGSN after the DNS procedure exits would be contacted with GTP, the default SGSN then selects the actual SGSN within that SGSN pool. This results in all relocation requests being handled by the default SGSN nodes. If the operator's goal is to avoid load on the default SGSN nodes then the records provisioned at the RNC-ID FQDN should instead include the entire set of SGSN in all SGSN pools that service that RNC. The S-NAPTR procedure would then return each SGSN in the SGSN pool based on the provisioned DNS weights and priority. + +NOTE 4: The SGSN(s) closest to the geographical region serving the RNC can be biased by provisioning the DNS records with higher priority or weights. + +3GPP does not require that collocation and "topon" naming is applicable in SGSN selection. + +NOTE 5: Service parameters are limited to those supported by the node doing the search. + +In the SRNS relocation procedure, for the case when a UE is moving from a pre-Release-8 UTRAN/GERAN to a Release-8 target SGSN the pre-Release-8 source node will not be able to use the .3gppnetwork.org based records. As a result the target Release-8 SGSN (or MME) looks like a pre-Release-8 SGSN to a pre-Release-8 source node. For pre-Release 8 compatibility operators would continue to provision A/AAAA records as per Annex C.3 of 3GPP TS 23.003 [4] for the corresponding Gn/Gp interfaces regardless of whether the target SGSN is pre-Release-8 or not. Vendors shall support pre-Release 8 DNS procedures on Release 8 SGSN. + +In the RAN Information Management (RIM) procedure, the SGSN is selected based on the RNC-ID specified by source RAN node. + +### 5.5.4 Void + +## 5.6 GW Selection for SIPTO + +### 5.6.1 SIPTO above RAN + +DNS procedures defined in the clause 5 in this specification also apply for the GW selection for SIPTO service. + +The S-NAPTR based selection of the SGW (based on TAI, eNodeB-ID, RAI, or RNC-ID) gives the shortest user plane path from the UE to the SGW from the S-NAPTR ordering. Topological naming should be employed (as specified in clause 4.3.2) to find the shortest user plane path from the SGW to the PGW based on the topological closeness. With this approach, the MME or SGSN can select an SGW and PGW to achieve the shortest user plane path to the UE for a SIPTO enabled APN. + +The S-NAPTR based selection of the GGSN gives the shortest user plane path from the UE to the GGSN from the S-NAPTR ordering. When the network supports Direct Tunnel, separate S-NAPTR procedures should be used, with APN FQDN and then with RAI FQDN or RNC-ID FQDN, to retrieve a list of candidates respectively, the common one from the S-NAPTR ordering should be selected. + +### 5.6.2 SIPTO at the local network with LGW collocated with the (H)(e)NB + +The LGW shall reside in the local network and be collocated with the (H)(e)NB. The MME/SGSN shall use the LGW address proposed by the (H)(e)NB in the S1-AP/RANAP message, instead of selecting the PGW via DNS interrogation as specified in clause 5. + +The SGW shall remain in the mobile operator's core network, i.e. collocation of the SGW and LGW is not applicable. + +DNS procedures defined in the clause 5 in this specification apply for the SGW selection (i.e. based on TAI, eNodeB-ID, RAI, or RNC-ID). + +*Editor's Note: procedures for Gn SGSN are FFS.* + +### 5.6.3 SIPTO at the local network with stand-alone GW (LGW collocated with SGW) + +The stand-alone GW shall reside in the local network and be collocated with the SGW. + +DNS procedures defined in the clause 5 in this specification also apply for the GW selection for SIPTO service with the following additions. + +The MME/SGSN shall use the Local (H)(e)NB Network ID provided by the (H)(e)NB in the S1-AP/RANAP message to discover the SGW via the DNS. The S-NAPTR based selection of the SGW (based on the Local (H)(e)NB Network ID) gives the shortest user plane path from the UE to the SGW from the S-NAPTR ordering. Topological naming should be employed (as specified in clause 4.3.2) to find collocated SGW and LGW. + +NOTE: Based on operator policy, the MME/SGSN can select a local SGW (based on the Local (H)(e)NB Network ID) at UE attachment to the (H)eNB regardless of whether a SIPTO at the local network PDN connection is established or not (see TS 23.401 clause 4.3.15.2). + +### 5.6.4 SIPTO for eHRPD + +For the support of the SIPTO service for eHRPD access, topological naming should be employed (as specified in clause 4.3.2) to find the shortest user plane path from the HSGW to the PGW based on the topological closeness. With this approach, the HSGW can select a PGW to achieve the shortest userplane to the UE for a SIPTO enabled APN. Details related to SIPTO support for eHRPD access are specified in 3GPP2 X.S0057 [24] and 3GPP TS 23.402 [25]. + +## 5.7 Procedures for Discovering and Selecting an MSC Server + +### 5.7.1 General + +These procedures are employed when a target MSC Server that serves the target cell or RNC needs to be initially selected by an EPC core node or Release-8 SGSN for the SRVCC operation. It explicitly does not cover selection of an MSC Server by a RAN node nor the selection of an MSC server at an SRNS relocation. + +EPC core nodes, i.e. the MME and the S4-SGSN employ the procedures below during the PS-to-CS relocation procedure for the SRVCC operation. A Release-8 SGSN supporting only Gn/Gp may also optionally use this procedure. + +The MSC server enhanced for SRVCC is selected based on information received in the Target ID from the source E-UTRAN or UTRAN (see 3GPP TS 23.003 [4], 3GPP TS 25.413 [12] and 3GPP TS 36.413 [21]). + +### 5.7.2 Selection of the MSC server enhanced for SRVCC based on target RAI (UTRAN / GERAN Iu & A/Gb mode target) + +In SRVCC operations towards UTRAN and GERAN, the target MCC, MNC, LAC and optionally the RAC are available from the information in the Target ID. + +The S-NAPTR procedure for an MME/SGSN finding the MSC Sv service and interfaces serving the target Routing Area is started with "Service Parameters" of + +"x-3gpp-msc:x-sv" + +as defined in 3GPP TS 23.003 [4] and setting the Application-Unique String to the RAI FQDN based on RAC, LAC, MNC, MCC as defined in 3GPP TS 23.003 [4] clause 19.4.2.5: + +rac.lac.rac.epc.mnc.mcc.3gppnetwork.org + +The MME/SGSN shall set the RAC to a default value, e.g. hexadecimal value 'FF', if it is not available from the information in the Target ID. + +A Release 8 SGSN supporting only Gn/Gp may also optionally use this procedure with "Service Parameters" of "x-3gpp-msc:x-sv". + +Operators shall provision, for each RAI value in their network, NAPTR records under the RAI FQDN corresponding to each valid MSC interfaces from at least the following "Service Parameters" + +"x-3gpp-msc:x-sv", + +where NAPTR records for additional "Service Parameters" may be included optionally. + +NOTE 1: The NAPTR record at the RAI FQDN can be provisioned to correspond to only the default MSC server node(s) in the MSC pool(s) serving that RAI. The default MSC Server would be contacted with GTP, the default MSC server then selects the actual MSC Server within that MSC Server pool. This results in all SRVCC PS to CS service requests being handled by the default MSC Server nodes. If the operator's goal is to avoid load on the default MSC Server nodes then the records provisioned at the RAI FQDN should instead include the entire set of MSC Servers in all MSC Server pools that service that RAI. The S-NAPTR procedure would then return each MSC Server in the MSC Server pool based on the provisioned DNS weights and priority. + +NOTE 2: The MSC Server closest to the geographical region covered by the RAI can be biased by provisioning the DNS records with higher priority or weights. + +3GPP does not require that collocation and "topon" naming is applicable in MSC Server selection. + +NOTE 3: Service parameters are limited to those supported by the node doing the search. + +NOTE 4: SGW records will also be provisioned under the RAI FQDN see clause 5.2 + +## 5.8 Procedures to support Dedicated Core Networks + +### 5.8.1 General + +These procedures shall be employed in PLMNs deploying DCNs for: + +- discovering and selecting an SGW, PGW or GGSN in a DCN serving a particular UE usage type; +- retrieving the MMEGI or Null-NRI/SGSN Group ID to identify the DCN serving a particular UE usage type and to determine whether to perform a NAS Message Redirection procedure (see clause 5.19.1 of 3GPP TS 23.401 [11]); +- discovering and selecting a target MME or SGSN serving a particular UE usage type during a handover procedure with a MME or SGSN change. + +DNS procedures to support DCNs shall be supported as specified in the rest of the specification, with the additions specified in the following clauses. + +The UE usage type used during DNS procedure shall be the one mapped from the UE Usage Type received from the HSS as part of the subscription, based on the serving network operator configured policies and the UE related context information available at the serving network, e.g. information about roaming. + +### 5.8.2 SGW, PGW and GGSN Selection Procedure + +The S-NAPTR procedure employed to discover and select an SGW, PGW or GGSN in a DCN shall use the Application-Unique String set to the FQDN specified in the rest of this specification, e.g. with the APN-FQDN for PGW selection or with the TAI/eNodeB-ID/RAI/RNC-ID FQDN for SGW selection, and use the enhanced "Service Parameters" as specified in clause 19.4.3 of 3GPP TS 23.003 [4], i.e. appending the character string "+ue-" to the 'app-protocol' name identifying the UE usage type for which the discovery and selection procedure is performed. + +For example, the MME or S4-SGSN shall discover all GTP based S8 interfaces using "Service Parameters" of + +"x-3gpp-pgw:x-s8-gtp+ue-" + +Operators shall provision corresponding NAPTR records for these FQDNs, with enhanced "Service Parameters" appending the character string "+ue-" to the 'app-protocol' name identifying the UE usage type(s) for which the record applies. + +The S-NAPTR procedure shall logically output a candidate list of SGWs, PGWs or GGSNs serving at least the requested UE usage type, according to the general principles specified in clause 4.3.3.2.1 and Annex B.3. If no candidate SGW, PGW or GGSN is found for the requested UE usage type, possibly also after using local configuration, the procedure shall be performed with Service Parameters without the "+ue-" appended to the 'app-protocol' name. + +NOTE 1: This is required to discover and select an SGW, PGW or GGSN when no dedicated SGW, PGW or GGSN is configured for a particular UE usage type and FQDN. + +As an exception to the above requirement if no candidate SGW, PGW or GGSN is found for the requested UE usage type for the selection of an SGW, PGW or GGSN in the same PLMN, the MME/SGSN, TWAN or ePDG may decide not to perform an S-NAPTR procedure with Service Parameters without the "+ue-" appended to the 'app-protocol' name if so configured by operator policies and abort the selection procedure. + +NOTE 2: This can avoid selecting an SGW, PGW or GGSN not intended to support specific UE usage type. + +Annex A.4 provides examples of DNS provisioning for SGW and PGW discovery and selection procedures in a DCN, and examples of procedures for discovery and selection of SGW/PGW. + +### 5.8.3 MMEGI and Null-NRI/SGSN Group ID Retrieval Procedure + +To retrieve the MMEGI identifying the DCN serving a particular UE usage type, the S-NAPTR procedure shall use the Application-Unique String set to the TAI FQDN as defined in clause 19.4.2.3 of 3GPP TS 23.003 [4] and use the enhanced service parameters as specified in clause 19.4.3 of 3GPP TS 23.003 [4], i.e. appending the character string "+ue-" to the 'app-protocol' name identifying the UE usage type for which the discovery and selection procedure is performed. The MME shall discover the MMEGI for a particular UE usage type by using the "Service Parameters" of + +"x-3gpp-mme:x-s10+ue-" + +To retrieve the Null-NRI/SGSN Group ID identifying the DCN serving a particular UE usage type, the S-NAPTR procedure shall use the Application-Unique String set to the RAI FQDN as defined in clause 19.4.2.5 of 3GPP TS 23.003 [4] and use the enhanced service parameters as specified in clause 19.4.3 of 3GPP TS 23.003 [4], i.e. appending the character string "+ue-" to the 'app-protocol' name identifying the UE usage type for which the discovery and selection procedure is performed. Gn/Gp SGSN shall discover the Null-NRI/SGSN Group ID for a particular UE usage type by using "Service Parameters" of + +"x-3gpp-sgsn:x-gn+ue-" + +S4-SGSN shall discover the Null-NRI/SGSN Group ID for a particular UE usage type by using "Service Parameters" of + +"x-3gpp-sgsn:x-s16+ue-" + +Operators shall provision corresponding NAPTR records for these FQDNs, with enhanced "Service Parameters" appending the character string "+ue-" to the 'app-protocol' name identifying the UE usage type(s) for which the record applies. The MMEGI or Null-NRI/SGSN Group ID shall be provisioned in the host name of these records. The MMEGI or Null-NRI/SGSN Group ID shall be retrieved from the host name. + +The NAPTR records associated to the TAI FQDN shall be provisioned with a host name in the replacement part, as specified in 4.3.2, having the canonical-node-name start as: + +mme.mmegei + +The NAPTR records associated to the RAI FQDN shall be provisioned with a host name in the replacement part, as specified in 4.3.2, having the canonical-node-name start as: + +nri-sgsn.null-nri + +The NAPTR records associated to the RAI FQDN shall be provisioned with a host name in the replacement part, as specified in 4.3.2, having the canonical-node-name start as: + +nri-sgsn.sgsngi + + and shall be Hex coded digits representing the Null-NRI code of the SGSNs and SGSN Group ID respectively (see 3GPP TS 25.413 [12]). If there are less than 4 significant digits in and , one or more "0" digit(s) is/are inserted at the left side to fill the 4 digit coding respectively. Coding for other fields is the same as specified in 3GPP TS 23.003 [4]. + +NOTE 1: Annex A provides examples of the MMEGI and Null-NRI/SGSN Group ID retrieval procedures. + +### 5.8.4 MME and SGSN Selection Procedure + +The S-NAPTR procedure employed to discover and select an MME or SGSN serving a particular UE usage type, during a handover procedure with a MME or SGSN change, shall use the Application-Unique String set to the FQDN specified in the rest of this specification, e.g. with the TAI-FQDN for MME selection or with an RAI or RNC-ID FQDN for SGSN selection, and use the enhanced "Service Parameters" as specified in clause 19.4.3 of 3GPP TS 23.003 [4], i.e. appending the character string "+ue-" to the 'app-protocol' name identifying the UE usage type for which the discovery and selection procedure is performed. + +For example, the procedure for an MME to find a candidate set of target MMEs makes use of the "Service Parameters" of: + +"x-3gpp-mme:x-s10+ue-" + +and the procedure for an MME to find a candidate set of target SGSNs makes use of the "Service Parameters" of: + +"x-3gpp-sgsn:x-s3+ue-" + +Operators shall provision corresponding NAPTR records for these FQDNs, with enhanced "Service Parameters" appending the character string "+ue-" to the 'app-protocol' name identifying the UE usage type(s) for which the record applies. + +The S-NAPTR procedure shall logically output a candidate list of MMEs and SGSNs serving at least the requested UE usage type, according to the general principles specified in clause 4.3.3.2.1 and Annex B.3. If no candidate MME or SGSN is found for the requested UE usage type, possibly also after using local configuration, the procedure shall be performed with Service Parameters without the "+ue-" appended to the 'app-protocol' name. + +NOTE 1: This is required to discover and select an MME or SGSN when no dedicated MME or SGSN is configured for a particular UE usage type and FQDN. + +As an exception to the above requirement if no candidate MME or SGSN is found for the requested UE usage type for the selection of an MME or SGSN in the same PLMN, the MME/SGSN may decide not to perform an S-NAPTR procedure with Service Parameters without the "+ue-" appended to the 'app-protocol' name if so configured by operator policies and abort the selection procedure. + +NOTE 2: This can avoid selecting an MME or SGSN not intended to support specific UE usage types. + +Annex A.4 provides examples of DNS provisioning for MME discovery and selection procedures in a DCN. + +### 5.8.5 AMF Selection Procedure + +The S-NAPTR procedure employed to discover and select an AMF serving a particular UE usage type, during a EPS to 5GS handover using N26 interface procedure, shall use the Application-Unique String set to the FQDN specified in the rest of this specification, e.g. with the 5GS TAI-FQDN for AMF selection, and use the enhanced "Service Parameters" as specified in clause 19.4.3 of 3GPP TS 23.003 [4], i.e. appending the character string "+ue-" to the 'app-protocol' name identifying the UE usage type for which the discovery and selection procedure is performed. + +For example, the procedure for an MME to find a candidate set of target AMFs with N26 interface makes use of the "Service Parameters" of: + +"x-3gpp-amf:x-n26+ue-" + +Operators shall provision corresponding NAPTR records for these FQDNs, with enhanced "Service Parameters" appending the character string "+ue-" to the 'app-protocol' name identifying the UE usage type(s) for which the record applies. + +The S-NAPTR procedure shall logically output a candidate list of AMFs serving at least the requested UE usage type, according to the general principles specified in clause 4.3.3.2.1 and Annex B.3. If no candidate AMF is found for the requested UE usage type, possibly also after using local configuration, the procedure shall be performed with Service Parameters without the "+ue-" appended to the 'app-protocol' name. + +NOTE 1: This is required to discover and select an AMF when no dedicated AMF is configured for a particular UE usage type and FQDN. + +As an exception to the above requirement if no candidate AMF is found for the requested UE usage type for the selection of an AMF in the same PLMN, the MME may decide not to perform an S-NAPTR procedure with Service Parameters without the "+ue-" appended to the 'app-protocol' name if so configured by operator policies and abort the selection procedure. + +NOTE 2: This can avoid selecting an AMF not intended to support specific UE usage types. + +## 5.9 Procedures to support Cellular Internet of Things + +### 5.9.1 DCN based solution + +When DCN is supported in the network, the node performing the selection function may use the DNS procedures enhanced for supporting DCNs as specified in clause 5.8, to select an EPC entity, e.g. an SGW or PGW, which supports CIoT by configuring a specific UE Usage Type(s) for CIoT. + +For a MS requesting a PDN Connection of type "Non-IP", the S4-SGSN may use the DNS procedures enhanced for supporting DCNs as specified in clause 5.8, to select an EPC entity, e.g. an SGW or PGW, which supports this PDN Connection of type "Non-IP" by configuring a specific UE Usage Type. + +For a MS requesting a PDP Context of type "Non-IP", the Gn/Gp-SGSN may use the DNS procedures enhanced for supporting DCNs as specified in clause 5.8, to select a GGSN which supports this PDP Context of type "Non-IP" by configuring a specific UE Usage Type. + +### 5.9.2 Alternative solution + +The SGSN shall use the DNS procedures specified in this specification for selecting a GGSN or PGW supporting the Non-IP PDN Type without any change. The GGSNs or PGWs configured in the DNS for an APN which can be used for a Non-IP PDN connection shall all support the Non-IP PDN type. + +The MME shall use the DNS procedures specified in this specification for selecting a PGW optimised for CIoT without any change. The PGWs configured in the DNS for an APN which can be used for NB-IoT access or for a Non-IP PDN connection shall all support NB-IoT or the Non-IP PDN type respectively. + +The MME or SGSN shall select an SGW optimised for CIoT, using the DNS procedures for selecting an SGW specified in clauses 5.2 and 5.3, but retaining then one SGW, from the candidate SGWs list, which is also known to support of CIoT. The MME or SGSN knows whether an SGW supports CIoT via the Notification of Supported features over the S11 or S4 interface (for the CIoT feature), as specified in 3GPP TS 29.274 [23]. + +A source MME or SGSN shall select a target MME or SGSN, during a handover procedure for a UE supporting some CIoT EPS Optimisations, using the DNS procedures for selecting an MME or SGSN during a handover procedure specified in clause 5.4 or 5.5, but retaining then one target MME or SGSN, from the candidate target MME or SGSN list, which is also known by local configuration to support at least one CIoT EPS optimisation. The selected target MME or SGSN may forward the Forward Relocation Request to another MME or SGSN in the target MME or SGSN pool, as specified in 3GPP TS 29.274 [23]. + +## 5.10 Procedures for Discovering and Selecting an SGW-U + +These procedures shall be employed when an SGW-U needs to be selected by an SGW-C and the SGW-C supports the UP selection function based on DNS specified in Annex B.2.6 of 3GPP TS 29.244 [26]. + +Operators shall provision, for each TAI/eNodeB-ID/RAI/RNC-ID value in their network, NAPTR records under the TAI/eNodeB-ID/RAI/RNC-ID FQDN corresponding to each UP function serving as an SGW-U with the following "Service Parameters": + +"x-3gpp-upf:x-sxa" + +where additional "Service Parameters" may be included optionally. + +When DCN is deployed, operators shall provision corresponding NAPTR records for these FQDNs, with enhanced "Service Parameters" appending the character string "+ue-" to the 'app-protocol' name identifying the UE usage type(s) for which the record applies: + +"x-3gpp-upf:x-sxa+ue-" + +The SGW-C may select a specific SGW-U for UE supporting a particular network capability (see clause 5.x). Operators shall provision corresponding NAPTR records for these FQDNs, with enhanced "Service Parameters" appending the character string "+nc-" to the 'app-protocol' name as follows: + +"x-3gpp-upf:x-sxa+nc-" + +To discover and select an SGW-U, the SGW-C shall use S-NAPTR procedure with the "Service Parameters" of: + +"x-3gpp-upf:x-sxa" + +and the TAI/eNodeB-ID/RAI/RNC-ID FQDN as the Application-Unique String. See clause 19.4 of 3GPP TS 23.003 [4]. + +The S-NAPTR procedure logically outputs a list of host names each coupled with a service, a protocol, a port, and a list of IPv4 and IPv6 addresses. This is the "candidate" list of SGW-U's for a given TAI/eNodeB-ID/RAI/RNC-ID. + +When DCN is deployed, the S-NAPTR procedure employed to discover and select an SGW-U shall use the Application-Unique String set to the TAI/eNodeB-ID/RAI/RNC-ID FQDN, and use the enhanced "Service Parameters" as specified in clause 19.4.3 of 3GPP TS 23.003 [4], i.e. appending the character string "+ue-" to the 'app-protocol' name identifying the UE usage type for which the discovery and selection procedure is performed. + +For example, the SGW-C shall discover a UP function capable to serve as a SGW-U using the "Service Parameters" of: + +"x-3gpp-upf:x-sxa+ue-" + +The S-NAPTR procedure employed to discover and select an SGW-U shall use the Application-Unique String set to the TAI/eNodeB-ID/RAI/RNC-ID FQDN, and use the enhanced "Service Parameters" as specified in clause 19.4.3 of 3GPP TS 23.003 [4], i.e. appending the character string "+nc-" to the 'app-protocol' name identifying specific SGW-U supporting a particular network capability. + +For example, the SGW-C shall discover a UP function capable to serve as a SGW-U using the "Service Parameters" of: + +"x-3gpp-upf:x-sxa+nc-" + +## 5.11 Procedures for Discovering and Selecting PGW-U + +These procedures shall be employed when a PGW-U needs to be selected by an PGW-C and the PGW-C supports the UP selection function based on DNS specified in Annex B.2.6 of 3GPP TS 29.244 [26]. + +Operators shall provision, for each APNs configured in their network, NAPTR records under the APN FQDN corresponding to each UP function serving as a PGW-U with the following "Service Parameters": + +"x-3gpp-upf:x-sxb" + +where additional "Service Parameters" may be included optionally. See clause 19.4.2.2 of 3GPP TS 23.003 [4]. + +When DCN is deployed, operators shall provision corresponding NAPTR records for these FQDNs, with enhanced "Service Parameters" appending the character string "+ue-" to the 'app-protocol' name identifying the UE usage type(s) for which the record applies: + +"x-3gpp-upf:x-sxb+ue-" + +The PGW-C may select a specific PGW-U supporting a particular network capability (see clause 5.x). Operators shall provision corresponding NAPTR records for these FQDNs, with enhanced "Service Parameters" appending the character string "+nc-" to the 'app-protocol' name, the following record applies: + +"x-3gpp-upf:x-sxb+nc-" + +To discover and select a PGW-U, the PGW-C shall use S-NAPTR procedure with the "Service Parameters" of: + +"x-3gpp-upf:x-sxb" + +and the APN FQDN as the Application-Unique String. + +The S-NAPTR procedure logically outputs a list of host names each coupled with a service, a protocol, a port, and a list of IPv4 and IPv6 addresses. This is the "candidate" list of PGW-U's for a given APN. + +When DCN is deployed, the S-NAPTR procedure employed to discover and select an PGW-U shall use the Application-Unique String set to the APN FQDN, and use the enhanced "Service Parameters" as specified in clause 19.4.3 of 3GPP TS 23.003 [4], i.e. appending the character string "+ue-" to the 'app-protocol' name identifying the UE usage type for which the discovery and selection procedure is performed. + +For example, the PGW-C shall discover a UP function capable to serve as a PGW-U using the "Service Parameters" of: + +"x-3gpp-upf:x-sxb+ue-". + +The S-NAPTR procedure employed to discover and select an PGW-U shall use the Application-Unique String set to the APN FQDN, and use the enhanced "Service Parameters" as specified in clause 19.4.3 of 3GPP TS 23.003 [4], i.e. appending the character string "+nc-" to the 'app-protocol' name identifying specific PGW-U supporting a particular network capability. + +For example, the PGW-C shall discover a UP function capable to serve as a PGW-U using the "Service Parameters" of: + +"x-3gpp-upf:x-sxb+nc-". + +## 5.12 Procedures to select a node supporting a particular network capability + +### 5.12.1 General principles + +#### 5.12.1.1 General + +Operators may need to discover and select a network node supporting a particular network capability. + +DNS procedures to select a node supporting a particular network capability shall be supported as specified in the rest of the specification, with the additions specified in clause 5.12. The following clauses also further define the specific network capabilities for which these procedures may be used. + +Enhanced "Service Parameters" as specified in clause 19.4.3 of 3GPP TS 23.003 [4] may be used to select a network node with a particular network capability, by appending the character string "+nc-" to the 'app-protocol' name. + +Operators shall provision corresponding NAPTR records for these FQDNs, with enhanced "Service Parameters" appending the character string "+nc-" to the 'app-protocol' name identifying the network capability(s) for which the record applies. + +The S-NAPTR procedure shall logically output a candidate list of network nodes supporting at least the requested network capability, according to the general principles specified in clause 4.3.3.2.1, Annex B.4. If no candidate network nodes are found for the requested network capability, possibly also after using local configuration, the procedure shall be performed with Service Parameters without the "+nc-" appended to the 'app-protocol' name. + +NOTE 1: This is required to discover and select a network node when no dedicated network node is configured for a particular network capability. + +As an exception to the above requirement if no network node is found for the requested network capability for the selection of a network node in the same PLMN, e.g. the SGW and PGW in the same PLMN, the node performing the node selection may decide to not perform an S-NAPTR procedure with Service Parameters listed in the above requirement, if so configured by operator policies, and abort the selection procedure. + +NOTE 2: This can avoid selecting a network node not supporting a particular network capability. + +#### 5.12.1.2 Selecting a node supporting a particular network capability within a Dedicated Core Network + +When using Dedicated Core Networks, the selection of a node supporting a particular network capability may solely rely on the procedures specified for DCNs in clause 5.8, or combine the procedures specified in clauses 5.12 and 5.8 by using Enhanced "Service Parameters" as specified in clause 19.4.3 of 3GPP TS 23.003 [4] to select a network node with a particular network capability within a particular DCN, by appending the character string "+nc-" and "+ue-" to the 'app-protocol' name and provisioning NAPTR records accordingly. + +For example, the MME or S4-SGSN shall discover all GTP based S5/S8 interfaces using "Service Parameters" of + +"x-3gpp-pgw:x-s5-gtp+nc-+ue-", "x-3gpp-pgw:x-s8-gtp+nc-+ ue-" + +or + +"x-3gpp-pgw:x-s5-gtp+ue-+nc-", "x-3gpp-pgw:x-s8-gtp+ ue-+nc-" + +NOTE: An 'app-protocol' name appears at most once in a NAPTR record. For instance, "x-3gpp-pgw:x-s5-gtp+nc-: x-s5-gtp+ue-" is not a valid NAPTR record. + +If no candidate network nodes are found for the requested network capability and UE usage type, possibly also after using local configuration, the procedure shall be performed with Service Parameters: + +- without the "+nc-" appended to the 'app-protocol' name; +- without the "+ue-" appended to the 'app-protocol' name; +- without the "+nc-" nor the "+ue-" appended to the 'app-protocol' name. + +As an exception to the above requirement if no network node is found for the requested network capability and UE usage type for the selection of a network node in the same PLMN, e.g. the SGW and PGW in the same PLMN, the node performing the node selection may decide to not perform an S-NAPTR procedure with Service Parameters listed in the above requirement, if so configured by operator policies, and abort the selection procedure. + +#### 5.12.1.3 Selecting an SGW or PGW supporting a particular network capability + +The S-NAPTR procedure employed to discover and select an SGW and PGW supporting a particular network capability shall use the Application-Unique String set to the FQDN specified in the rest of this specification, e.g. with the APN-FQDN for PGW selection or with the TAI/eNodeB-ID/RAI/RNC-ID FQDN for SGW selection, and use the enhanced "Service Parameters" as specified in clause 19.4.3 of 3GPP TS 23.003 [4], i.e. appending the character string "+nc-" to the 'app-protocol' name. + +For example, the MME or S4-SGSN shall discover all GTP based S5/S8 interfaces using "Service Parameters" of + +"x-3gpp-pgw:x-s5-gtp+nc-", "x-3gpp-pgw:x-s8-gtp+nc-" + +Operators shall provision corresponding NAPTR records for these FQDNs, with enhanced "Service Parameters" appending the character string "+nc-" to the 'app-protocol' name. + +The S-NAPTR procedure shall logically output a candidate list of SGWs or PGWs supporting the requested network capability. If no candidate SGW and PGW is found, possibly also after using local configuration, the procedure shall be performed with Service Parameters without the "+nc-" appended to the 'app-protocol' name. + +NOTE 1: This is required to discover and select an SGW or PGW when no dedicated SGW or PGW is configured to support the requested network capability. + +As an exception to the above requirement if no candidate SGW or PGW is found to support the requested network capability for the selection of an SGW or PGW in the same PLMN, the MME or S4-SGSN may decide not to perform an S-NAPTR procedure with Service Parameters without the "+nc-" appended to the 'app-protocol' name if so configured by operator policies and abort the selection procedure. + +NOTE 2: This can avoid selecting an SGW or PGW not supporting the requested network capability. + +### 5.12.2 Procedures to support Dual Connectivity with NR + +#### 5.12.2.1 General + +An MME or SGSN may select specific SGWs and PGWs for UEs supporting dual connectivity with NR and not restricted to use NR by user subscription (see "NR as Secondary RAT Not Allowed" bit within Access Restriction Data as specified in TS 29.272 [27]) or local operator policy, e.g. due to requirements of higher bitrates, data usage reporting over the secondary RAT, etc. A UE signals its support for dual connectivity with NR to the MME and SGSN in NAS signalling. The specific SGWs and PGWs may be combined SGW/PGW functions. + +DNS procedures to support Dual Connectivity with NR shall be supported as specified in clause 5.12.1, with the following additions: + +- the shall be set to "nr". + +For example, the MME or S4-SGSN shall discover all GTP based S5/S8 interfaces using "Service Parameters" of "x-3gpp-pgw:x-s5-gtp+nc-nr", "x-3gpp-pgw:x-s8-gtp+nc-nr" + +- this network capability may apply to: + - the 'app-service' names "x-3gpp-sgw", "x-3gpp-pgw"; + - the 'app-protocol' names: "x-s5-gtp", "x-s8-gtp", "x-s11". + +### 5.12.3 Procedures to support interworking with 5GC + +#### 5.12.3.1 General + +5GS interworking procedures with EPC rely on selecting a combined PGW-C/SMF and PGW-U/UPF during the PDN connection establishment (see clause 4.11 of 3GPP TS 23.501 [28]). + +#### 5.12.3.2 PGW-C/SMF selection + +An MME and an ePDG shall select a combined PGW-C/SMF for PDN connections that may be subject to mobility to 5GS, e.g. for UEs supporting N1 mode and not restricted to interworking with 5GS by user subscription (see "5GC" bit within Core-Network-Restrictions AVP and Interworking-5GS-Indicator AVP specified in 3GPP TS 29.272 [27] and 3GPP TS 29.273 [30]). A UE signals its support for 5GC NAS to the MME in NAS signalling and to the ePDG in IKEv2 signalling. + +An MME and an ePDG should also select a combined PGW-C/SMF, if possible, for PDN connections of UEs not supporting N1 mode that are not restricted to access the 5GC by user subscription (see "5GC" bit within Core-Network-Restrictions AVP and Interworking-5GS-Indicator AVP specified in 3GPP TS 29.272 [27] and 3GPP TS 29.273 [30]). + +A PDN connection of a subscription restricted from accessing the 5GC or without 5GS interworking subscribed for the APN is not subject to mobility to 5GS and may be connected to a PGW, a PGW-C or a combined PGW-C/SMF; when PGW-C (or PGW) and combined PGW-C/SMF are available for election, the preference order may be based on operator's policy in the MME or ePDG. + +DNS procedures to select a combined PGW-C/SMF shall be supported as specified in clause 5.12.1, with the following additions: + +- the shall be set to "smf". + +For example, the MME shall discover all GTP based S5/S8 interfaces using "Service Parameters" of "x-3gpp-pgw:x-s5-gtp+nc-smf", "x-3gpp-pgw:x-s8-gtp+nc-smf" and the ePDG shall discover all GTP based S2b interfaces using "Service Parameters" of "x-3gpp-pgw:x-s2b-gtp+nc-smf". + +- this network capability may apply to: + - the 'app-service' name "x-3gpp-pgw"; + - the 'app-protocol' names: "x-s5-gtp", "x-s8-gtp", "x-s2b-gtp". + +#### 5.12.3.3 PGW-U/UPF selection + +A PGW-C/SMF shall select a combined PGW-U/UPF for PDN connections that may be subject to mobility to 5GS and for PDN connections not subject to mobility to 5GS but that access the 5GC. + +If the PGW-C/SMF supports the UP function selection based on DNS procedures specified in Annex B.2.6 of 3GPP TS 29.244 [26], DNS procedures to select a combined PGW-U/UPF shall be supported as specified in clause 5.11 (for discovering and selecting a PGW-U), with the following additions: + +- the app-service of x-3gpp-upf with app-protocol "x-n4" identifies a User Plane function supporting N4 capabilities; +- the app-service of x-3gpp-upf with app-protocols "x-sxb:x-n4" identifies a PGW-U supporting N4 capabilities (i.e. a combined PGW-U/UPF). + +## 5.13 Procedures to support Ethernet PDN Connection in EPS + +### 5.13.1 DCN based solution + +When DCN is supported in the network, the MME may use the DNS procedures enhanced for supporting DCNs as specified in clause 5.8, to select an EPC entity, e.g. an SGW or a combined PGW-C/SMF, which supports Ethernet PDN connection by configuring to support a specific UE Usage Type(s). + +### 5.13.2 Network Capability based solution + +An MME may use the DNS procedure as specified in clause 5.12.1, to select an EPC entity, e.g. an SGW or a combined PGW-C/SMF which supports Ethernet PDN connection, with the following additions: + +- the shall be set to "eth" for an SGW selection and shall be set to "smf.eth" for a combined PGW-C/PGW-U selection. (See also clause 5.12.3 and Annex B.4) + +For example, the MME shall discover all GTP based S5/S8 interfaces using "Service Parameters" of "x-3gpp-pgw:x-s5-gtp+nc-smf.eth", "x-3gpp-pgw:x-s8-gtp+nc-smf.eth" + +- this network capability may apply to: + - the 'app-service' names "x-3gpp-sgw", "x-3gpp-pgw"; + - the 'app-protocol' names: "x-s5-gtp", "x-s8-gtp", "x-s11". + +### 5.13.3 Alternative solutions + +The MME may use the DNS procedures specified in this specification for selecting a combined PGW-C/SMF supporting Ethernet PDN connection without any change if all combined PGW-C/SMFs configured in the DNS for an APN support Ethernet PDN connection. + +The MME may know whether an SGW supports Ethernet PDN connection via the Notification of Supported features over the S11 interface (for the ETH feature), as specified in 3GPP TS 29.274 [23]. + +## 5.14 Procedures for Discovering and Selecting a UCMF + +These procedures shall be employed when a UCMF needs to be discovered and selected by MME. + +Operators shall provision NAPTR records under UCMF FQDN corresponding to valid UCMF interfaces from the following "Service Parameters": + +- "x-3gpp-ucmf:x-urcmp", "x-3gpp-ucmf:x-n55" + +Where additional "Service Parameters" may be included optionally. + +MMEs are expected to select a UCMF based on MME's capability to support URCMP or N55 based signalling. If multiple UCMFs are deployed, implementation specific algorithms should be used to distribute load among available UCMFs. + +3GPP does not require that collocation and "topon" naming is applicable in UCMF selection. + +# 6 Procedures for OAM System Node Discovery + +## 6.1 Procedures for Relay Node OAM System Discovery + +### 6.1.1 General + +These procedures may be employed when a relay node (see 3GPP TS 36.300 [22], clause 4.7) needs to discover its Operations and Maintenance (OAM) system. The relay nodes employ the procedures below during the startup procedure in order to discover the OAM system, from which it obtains its configuration and updated software. + +The OAM system is selected based on the operator identity and the type allocation code identifying the relay node vendor, and optionally the tracking area code (see 3GPP TS 23.003 [4]). This enables vendor-specific OAM systems for relay nodes. + +### 6.1.2 OAM System Selection based on Type Allocation Code + +In both UTRAN and E-UTRAN cases the operator identity in terms of MNC and MCC is available from the information in IMSI (see 3GPP TS 23.003 [4], clause 2.2). The type allocation code (IMEI-TAC) identifying the relay node vendor is available from IMEI or IMEISV (see 3GPP TS 23.003 [4], clause 6.2). + +- 1) In relay node startup procedure, the relay node may use the vendor-specific relay node OAM system FQDN as it is defined in 3GPP TS 23.003 [4], clause 23.3.2.2, to discover its OAM system. Operator provisions A/AAAA record under 3GPP vendor-specific relay node OAM system FQDN. + +# --- 7 Procedures for NF Discovery in 5G System + +## 7.1 General + +The discovery of NFs in the 5G System is supported by the NRF (see 3GPP TS 23.501 [28] and 3GPP TS 23.502 [29]), except for the following scenarios for which DNS procedures are defined: + +- AMF discovery and selection by MME, for EPS interworking with the 5G System using the N26 interface (see clauses 4.3.3.4, 4.3.3.8, 5.4 and 5.4A); and +- AMF discovery by 5G-AN (see clause 7.2). + +## 7.2 Procedure for AMF Discovery by 5G-AN + +The 5G-AN selects an AMF Set and an AMF from the AMF set as specified in clause 6.3.5 of 3GPP TS 23.501 [28]. + +NOTE 1: The 5G-AN (NG-RAN and N3IWF) is responsible for initiating the SCTP connectivity and setting up the NG-C association with the AMF. This requires the 5G-AN to first obtain the AMF's IP address(es). + +In the 5G System, AMFs may be added or removed dynamically for scalability or planned maintenance. The DNS procedure specified in this clause may be used by the 5G-AN to discover the AMFs available in an AMF Set. + +NOTE 2: The 5G-AN might obtain the information about the available AMFs via alternative means, e.g. OAM. + +The AMFs available within an AMF Set should be provisioned within NAPTR records in the DNS, under the AMF Set FQDN (as defined in clause 28.3.2.7 of 3GPP TS 23.003 [4]), with the Service Parameters "x-3gpp-amf:x-n2". + +The 5G-AN may discover the AMFs available within an AMF Set by: + +- constructing the AMF Set FQDN, as defined in clause 28.3.2.7 of 3GPP TS 23.003 [4], identifying the AMF Set of the AMFs to be discovered; and +- initiating an S-NAPTR procedure, with the Application-Unique String set to that AMF Set FQDN, and with the "Service Parameters" set to "x-3gpp-amf:x-n2". + +The S-NAPTR procedure outputs a list of host names (AMFs) each with a service, protocol, port and a list of IPv4 and IPv6 addresses. See further details and examples in Annexes B, C and X. + +# Annex A (Informative): Examples + +## A.1 Introduction + +This annex includes examples of the DNS provisioning needed for EPC node discovery and selection procedures. Examples are not exhaustive either in scope or in content but are intended to be sufficient to illustrate the general techniques and some of the more important use cases. + +## A.2 Preconditions + +The following are general comments applying to all examples provided here. + +- a) DNS master file format follows IETF RFC 1035 [3] chapter 5. The reader is reminded that in that format the character ":" is used for comments, "\$" is used for directives, and enclosing parenthesis ( ) combine lines. +- b) Examples are built from smaller files and merged with the \$INCLUDE directive. This is to allow each file to be documented in a separate clause and to allow reuse of files in some of the examples. +- c) Only one operator's network is used in all examples using MCC=311 (United States) and MNC=990 (currently an unassigned MNC value). All DNS records presented here are within the zone cut epc.mnc990.mcc311.3gppnetwork.org. +- d) Since the fully qualified domain names here are relatively long to avoid line wrapping and to save space in the examples we use the standard \$ORIGIN directive +\$ORIGIN epc.mnc990.mcc311.3gppnetwork.org. +Hence any domain names in the file that are not fully qualified (i.e. does not end with a period) would have epc.mnc990.mcc311.3gppnetwork.org. appended to them to form the fully qualified value. In the descriptive text in this Annex we use the same convention. +- e) When a printout is provided, it is from an actual printout of the "dig" command (from the BIND distribution) but with all values of the string .epc.mnc990.mcc311.3gppnetwork.org. replaced with .\$ORIGIN in order to keep the output on one line when possible. Note the "+tcp" option is used in the "dig" command to avoid truncating large DNS responses in the examples. +- f) Files provided here have been tested with a recent version of BIND and are presented here unmodified. In the examples the BIND server was set as authoritative only with default settings to make the configuration self contained. In a real network a recursive server is likely to be used as an intermediary and/or multiple authoritative servers. +- g) The time to live (TTL) in the examples are all set to 1 hour = 3600 seconds by using the \$TTL directive from IETF RFC 2308 [15]. +- h) IPv4 addresses in the examples are from the IPv4 example documentation address space of 192.0.2.0/24 of IETF RFC 3330 [16] and IPv6 addresses are from the IPv6 documentation address space of IETF RFC 3849 [17] . These are by no means representative and are used solely for example purposes. +- i) Since A/AAAA records are well known we only provide A/AAAA records for the simpler examples and do not document every A and AAAA lookup in detail. + +## A.3 Collocated Simple LTE Example + +### A.3.1 Network description + +This is a fairly complete example of an operator network with the following properties. + +- 1) Network only has LTE access with only interworking with LTE access. There is no support for Gn/Gp and no support for S3/S4. +- 2) Network does not support PMIPv6 for S5 but does allow very limited roaming use of S8 PMIPv6. This is a policy that is extremely unlikely to be used by a real operator and is used only for illustrative purposes. +- 3) There are two combined PGW/SGW nodes and two standalone MME nodes. +- 4) Any load balancing between nodes of the same functional type is on a strict bias. Hence, SRV records are not needed. +- 5) Operator desires the flattest DNS structure possible due to desire to minimize the number of DNS queries. The use of NATPR with flag "" is therefore not used by operator policy. This is feasible since the network is small. +- 6) Due to 4) and 5) only NAPTR records with flag "a" are used by the operator in this example. +- 7) One MME pool area. +- 8) One SGW service area. +- 9) Operator desires that S1-U link cost is minimized (i.e. SGW closest to eNodeB is used) +- 10) Operator does not care about distance or transport costs between SGW and PGW beyond the collocation for S5. Hence it does not use "topon" naming. +- 11) Small number of APNs + +Other than item 2) this set of conditions might fit a green field operator or government agency deploying LTE for use on laptop computers or high end hand held devices for internet access. This represents one of the simpler networks possible while still being non-trivial. + +Very large networks would tend to use MME pool areas and SGW service areas and NAPTR empty flag records. How complex the structure in DNS is employed between the initial NAPTR entry point and the final A/AAAA record set(s) is solely the operator's choice so long as the S-NAPTR requirements are met. + +Additional comments on this example are in each clause as needed. Also commented out DNS records are often included in the sample files to illustrate how additional interface types would be added. + +### A. 3.2 Master file for "Collocated Simple LTE Example" + +The master file for this example will be CS\_EX.txt and has following content. + +``` +$ORIGIN epc.mnc990.mcc311.3gppnetwork.org. +; +$TTL 3600 ; 1 hour - this directive is defined in IETF RFC 2308 not RFC 1035 +; +$INCLUDE SOA_DB.txt +; +$INCLUDE CS_MME_DB.txt +; +$INCLUDE CS_SGW_PGW_NODE_DB.txt +; +$INCLUDE CS_TAI_DB.txt +; +$INCLUDE CS_APN_DB.txt +; +; End of file +``` + +The included files are detailed in following clauses. + +### A. 3.3 SOA and NS records + +The SOA and NS records need to exist for any DNS zone. Our example will use the following file with name SOA\_DB.txt whose content is: + +``` +; SOA and NS glue records +; Note @, ns1, ns2 are relative to $ORIGIN +; +``` + +``` + +@ 1D IN SOA @ administrator.example.com. ( + 2008122401 ; serial + 1H ; refresh + 15 ; retry + 1w ; expire + 1h ; minimum - note this parameter + ; is used for negative caching + ; see RFC 2308 chapter 4 + ) + IN NS ns1 + IN NS ns2 +; +; Glue records for the two DNS servers +ns1 IN A 192.0.2.247 +ns2 IN A 192.0.2.248 + +; End of file + +``` + +### A. 3.4 MME file for "Collocated Simple LTE Example" + +The MME S10 record lookup by GUTI is probably the simplest example of the NAPTR records and is the simplest introduction to the S-NAPTR procedure as well. + +A NAPTR record is required to be provisioned at mmec.mmegi.mme (see clause 4.3.3.4 of this TS). This is used for GUTI based lookup of the old or source MME. Specifically, the target MME takes the UE's old GUTI value and derives the old MME's DNS name. The goal of the target MME is usually to be able to do a context transfer of the old MME's data (or similar action). MME to MME communication is done over S10. Hence, S10 is critical for the GUTI record in an LTE only network. + +The mmec.mmegi.mme is also the natural place for the MME canonical node record set. For this example we place the MME canonical node records and the required record for GUTI based lookup at the same location both for simplicity and better DNS caching. + +For this example we have two MMEs with MMEC codes of 1 and 2 respectively and both in the same MME pool (MMEGI = 8000 hexadecimal). + +The file containing the MME records for this example will be CS\_MME\_DB.txt and has following NAPTR record content. + +``` + +; +; This is the GUTI related record and the MME node record +; The operator has decided to use the 3GPP name as the canonical node name of the MME +; rather than having two records (the 3GPP one and an operator defined value) +; +mmec01.mmegi8001.mme ( +; IN NAPTR order pref. flag service regexp replacement +; IN NAPTR 100 999 "a" "x-3gpp-mme:x-s10" "" topoff.eth1.mmec01.mmegi8001.mme ) +; IN NAPTR 200 999 "a" "x-3gpp-mme:x-s11" "" topoff.eth3.mmec01.mmegi8001.mme +; IN NAPTR 300 999 "a" "x-3gpp-mme:x-s3" "" topoff.eth5.mmec01.mmegi8001.mme +; IN NAPTR 400 999 "a" "x-3gpp-mme:x-gn" "" topoff.eth6.mmec01.mmegi8001.mme +; IN NAPTR 500 999 "a" "x-3gpp-mme:x-s1-mme" "" topoff.eth7.mmec01.mmegi8001.mme + +; This particular operator only supports LTE access in their accesses etc. +; So the S3 record is commented out above. If the operator wants the MME to be used with S3/S4 +; SGSN nodes then the record would have to be included. +; The Gn/Gp interface is commented out for same reason. This operator does not support it. +; If the operator wants the MME to be used for Gn/Gp SGSN interworking +; then the record would have to be included. +; +; Reminder: Canonical node name records must be complete. +; However, "x-3gpp-mme:x-s1-mme" is an exception. +; While S1-MME interface must be physically present and used in a MME +; it is explicitly optional for an operator to provision in this release of 3GPP +;. So it too is commented out + +; NAPTR order plays no major role in this particular example since the MME node is already +; selected in GUTI case and as a canonical node name. In most cases the interface type +; (S10 vs S11 etc) is functionally determined so the NAPTR order is rarely used in this record set +; If the S3 and Gn records were not commented out the S10 is preferred over S3 over Gn +; I.e. a combined MME/SGSN could communicate to the MME above using any of the three protocols + +``` + +``` + +; at context transfer. +; So the operator is stating that S10 is preferred over S3 over Gn +; +; Of course if the MME had multiple S10 interfaces +; the operator could provision more than one S10 record with different orders +; perhaps to select S10 IPv6 over S10 IPv4 + +; We have the same type of records for the other MME (same comments would apply) + +; +mmec02.mmegi8001.mme ( +; IN NAPTR order pref. flag service regexp replacement + IN NAPTR 100 999 "a" "x-3gpp-mme:x-s10" "" topoff.eth1.mmec02.mmegi8001.mme ) + IN NAPTR 200 999 "a" "x-3gpp-mme:x-s11" "" topoff.eth3.mmec02.mmegi8001.mme + IN NAPTR 300 999 "a" "x-3gpp-mme:x-s3" "" topoff.eth5.mmec02.mmegi8001.mme + IN NAPTR 400 999 "a" "x-3gpp-mme:x-gn" "" topoff.eth6.mmec02.mmegi8001.mme + IN NAPTR 500 999 "a" "x-3gpp-mme:x-s1-mme" "" topoff.eth7.mmec02.mmegi8001.mme +; +; +; All MME IP addresses for both MME +; +topoff.eth1.mmec01.mmegi8001.mme IN A 192.0.2.11 + IN A 192.0.2.12 + IN AAAA 2001:db8:0:0:0:0:0:0 + IN AAAA 2001:db8:0:1:0:0:0:0 +topoff.eth3.mmec01.mmegi8001.mme IN A 192.0.2.13 + IN A 192.0.2.14 + IN AAAA 2001:db8:0:2:0:0:0:0 + IN AAAA 2001:db8:0:3:0:0:0:0 +topoff.eth1.mmec02.mmegi8001.mme IN A 192.0.2.17 + IN A 192.0.2.18 + IN AAAA 2001:db8:0:6:0:0:0:0 + IN AAAA 2001:db8:0:7:0:0:0:0 +topoff.eth3.mmec02.mmegi8001.mme IN A 192.0.2.19 + IN A 192.0.2.110 + IN AAAA 2001:db8:0:8:0:0:0:0 + IN AAAA 2001:db8:0:9:0:0:0:0 + +; end of file + +``` + +The partially qualified MME host names are topoff.eth1.mmec01.mmegi8001., topoff.eth3.mmec02.mmegi8001.mme and similar. The (partially qualified) canonical node names are mmec01.mmegi8001.mme and mmec02.mmegi8001.mme (obtained by stripping off the first two labels of the host names). + +The fully qualified MME node names are the relatively long + +mmec01.mmegi8001.mme.epc.mnc990.mcc311.3gppnetwork.org. + +and + +mmec02.mmegi8001.mme.epc.mnc990.mcc311.3gppnetwork.org. + +which are obtained by appending the value of \$ORIGIN to the partially qualified MME node names. As stated before we will use the partially qualified names in this Annex to avoid this visual clutter and for typographical reasons. + +Note that hostnames such as topoff.eth1.mmec01.mmegi8001.mme intentionally give back the node name mmec01.mmegi8001.mme so this record set is both for GUTI lookup and MME canonical node name lookup (and it is self consistent). + +For the purposes of GUTI lookup the S10 record is sufficient for LTE only access and LTE only interworking. As stated in the comments above, S3 would be added for S4-SGSN support and the Gn/Gp records for Gn/Gp SGSN support. + +For the purposes of being a canonical node record the S10 and S11 MME records are included (and they are mandatory to provision in the canonical node record of the MME). + +NOTE 1: The rule for canonical node records is to always include all services that are allowed to be used on a node and are defined in 3GPP TS 23.003 [4] clause 19.4.3 for that node. Node records are meant to be complete. We have an exception here since x-3gpp-mme:x-s1-mme is explicitly optional in this release of 3GPP. + +### A. 3.5 APN file for "Collocated Simple LTE Example" + +Reminder, the format of the APN FQDN is standardized by 3GPP TS 23.003 [4] clause 19.4.2.2 and is of form .apn.epc.mnc.mcc.3gppnetwork.org + +Service names are in 3GPP TS 23.003 [4] clause 19.4.3 + +There are two APN-NI in this network "imsTV1", and "imsTV2". + +The file containing the APN records for this example will be CS\_APN\_DB.txt and has following content. + +``` +; +; +imsTV1.apn ( +; IN NAPTR order pref. flag service regexp replacement +; IN NAPTR 100 999 "a" "x-3gpp-pgw:x-s5-gtp:x-s8-gtp" "" topoff.vip1.gw01.nodes ) +; IN NAPTR 200 999 "a" "x-3gpp-pgw:x-s5-gtp:x-s8-gtp" "" topoff.vip1.gw21.nodes +; IN NAPTR 300 999 "a" "x-3gpp-pgw:x-gn:x-gp" "" topoff.vip3.gw01.nodes +; IN NAPTR 400 999 "a" "x-3gpp-pgw:x-gn:x-gp" "" topoff.vip3.gw21.nodes +; IN NAPTR 500 999 "a" "x-3gpp-pgw:x-s8-pmip" "" topoff.vip2.gw01.nodes +; IN NAPTR 600 999 "a" "x-3gpp-pgw:x-s8-pmip" "" topoff.vip2.gw21.nodes +; +; Operator has imsTV1.apn using gw01.nodes when possible. Possibly one IMS core and video server +; are closer to gw01.nodes than gw21.nodes +; +; Operator only allows PMIPv6 for roaming type scenarios and only as a last choice +; The operator does not support Gn/Gp so those records are commented out + +imsTV2.apn ( +; IN NAPTR order pref. flag service regexp replacement +; IN NAPTR 200 999 "a" "x-3gpp-pgw:x-s5-gtp:x-s8-gtp" "" topoff.vip1.gw01.nodes ) +; IN NAPTR 100 999 "a" "x-3gpp-pgw:x-s5-gtp:x-s8-gtp" "" topoff.vip1.gw21.nodes +; IN NAPTR 400 999 "a" "x-3gpp-pgw:x-gn:x-gp" "" topoff.vip3.gw01.nodes +; IN NAPTR 300 999 "a" "x-3gpp-pgw:x-gn:x-gp" "" topoff.vip3.gw21.nodes +; IN NAPTR 600 999 "a" "x-3gpp-pgw:x-s8-pmip" "" topoff.vip2.gw01.nodes +; IN NAPTR 500 999 "a" "x-3gpp-pgw:x-s8-pmip" "" topoff.vip2.gw21.nodes +; +; This is almost the same as imsTV1. +; However, NAPTR order values for a particular interface type are reverse in comparison +; to imsTV1.apn +; +; Operator has imsTV2.apn using gw21.nodes when possible. + +; Obviously more APN would exist for a real operator +; +; end of file +``` + +If collocation were not a consideration then the APN-NI "imsTV1" causes topoff.vip1.gw01.nodes to be selected and the APN-NI "imsTV2" causes topoff.vip1.gw21.nodes to be selected. This is because in the corresponding record set the order 100 record is taken before the order 200 record in the S-NAPTR. In case of failure of a PGW then the other PGW can be used (the record with order 200). If there is deliberate bias to a specific PGW is solely the concern of this operator, the S-NAPTR procedure simply honors this. + +However, collocation is a consideration (topological checks are not relevant here since all records use topoff). + +The (partially qualified) PGW node names are gw01.nodes and gw21.nodes (obtained by stripping off the first two labels of the partially qualified host names topoff.vip1.gw01.nodes, topoff.vip1.gw21.nodes and so on). + +### A. 3.6 PGW/SGW node file for "Collocated Simple LTE Example" + +The file containing the PGW/SGW canonical node name records (and A/AAAA records for the PGW/SGW nodes) for this example will be CS\_SGW\_PGW\_NODE\_DB.txt and has following content. + +; Node records for the combined PGW/SGW + +``` + +gw01.nodes ( +; IN NAPTR order pref. flag service regexp replacement +; IN NAPTR 200 999 "a" "x-3gpp-pgw:x-s5-gtp:x-s8-gtp" "" topoff.vip1.gw01.nodes ) +; IN NAPTR 400 999 "a" "x-3gpp-pgw:x-s8-pmip" "" topoff.vip2.gw01.nodes +; IN NAPTR 500 999 "a" "x-3gpp-pgw:x-gn:x-gp" "" topoff.vip3.gw01.nodes +; Above record is commented out since this operator does not support Release 8 Gn/Gp functions +; Would have to be included otherwise +; +; Above are PGW records. +; Note this operator does NOT support PMIP for S5 +; Following are SGW records + IN NAPTR 100 999 "a" "x-3gpp-sgw:x-s11" "" topoff.eth1.gw01.nodes + IN NAPTR 300 999 "a" "x-3gpp-sgw:x-s5-gtp:x-s8-gtp" "" topoff.eth4.gw01.nodes + IN NAPTR 600 999 "a" "x-3gpp-sgw:x-s8-pmip" "" topoff.eth9.gw01.nodes +; IN NAPTR 700 999 "a" "x-3gpp-sgw:x-s4" "" topoff.eth6.gw01.nodes +; IN NAPTR 710 999 "a" "x-3gpp-sgw:x-s12" "" topoff.eth6.gw01.nodes +; IN NAPTR 800 999 "a" "x-3gpp-sgw:x-gn:x-gp" "" topoff.eth8.gw01.nodes +; Above records are commented out since this operator does not support any SGSN variant +; or UTRAN support. The operator is pure LTE in this example +; Above records would be included if the SGWs were able to be used with the corresponding +; SGSN function (or direct tunnel function) +; +; Reminder: Canonical node records must be complete. +; +; Exception, "x-3gpp-sgw:x-s1-u" records could be listed but are purely optional for an operator +to provision +; in this release of 3GPP. + +; NAPTR order plays no real role in this particular example (except for S8) +; Reasons for this example are: +; This is the PGW/SGW canonical node record so there is no node selection based from the record +; The interface type is functionally determined in most use cases using this record set except S5/S8 +; This operator does NOT support PMIP for S5 and there is only one S5-GTP record. +; So order is not important except for S8. +; For S8 the operator does places PMIP with highest order just to be sure that GTP based S8 will be +; used first when possible even at re-selection of an S8 interface on the SGW or PGW as per this +; particular operators policy +; This is of course subject to the roaming agreements this operator has. + +``` + +; Same record for the other combined PGW/SGW + +``` + +gw21.nodes ( +; IN NAPTR order pref. flag service regexp replacement + IN NAPTR 200 999 "a" "x-3gpp-pgw:x-s5-gtp:x-s8-gtp" "" topoff.vip1.gw21.nodes ) + IN NAPTR 400 999 "a" "x-3gpp-pgw:x-s8-pmip" "" topoff.vip2.gw21.nodes +; IN NAPTR 500 999 "a" "x-3gpp-pgw:x-gn:x-gp" "" topoff.vip3.gw21.nodes + +; Above are PGW records. + +; Following are SGW records + IN NAPTR 100 999 "a" "x-3gpp-sgw:x-s11" "" topoff.eth1.gw21.nodes + IN NAPTR 300 999 "a" "x-3gpp-sgw:x-s5-gtp:x-s8-gtp" "" topoff.eth4.gw21.nodes + IN NAPTR 600 999 "a" "x-3gpp-sgw:x-s8-pmip" "" topoff.eth9.gw21.nodes +; IN NAPTR 700 999 "a" "x-3gpp-sgw:x-s4" "" topoff.eth6.gw21.nodes +; IN NAPTR 710 999 "a" "x-3gpp-sgw:x-s12" "" topoff.eth6.gw21.nodes +; IN NAPTR 800 999 "a" "x-3gpp-sgw:x-gn:x-gp" "" topoff.eth8.gw21.nodes + + +; A/AAAA records +; +; IP addresses for gw01 +; +topoff.vip1.gw01.nodes IN A 192.0.2.113 + IN A 192.0.2.114 + IN AAAA 2001:db8:0:c:0:0:0:0 + IN AAAA 2001:db8:0:d:0:0:0:0 +topoff.vip2.gw01.nodes IN A 192.0.2.143 + IN A 192.0.2.144 + IN AAAA 2001:db8:0:2a:0:0:0:0 + +``` + +``` + +IN AAAA 2001:db8:0:2b:0:0:0:0 +topoff.eth1.gw01.nodes IN A 192.0.2.129 +IN A 192.0.2.130 +IN AAAA 2001:db8:0:1c:0:0:0:0 +IN AAAA 2001:db8:0:1d:0:0:0:0 +topoff.eth4.gw01.nodes IN A 192.0.2.131 +IN A 192.0.2.132 +IN AAAA 2001:db8:0:1e:0:0:0:0 +IN AAAA 2001:db8:0:1f:0:0:0:0 +topoff.eth9.gw01.nodes IN A 192.0.2.133 +IN A 192.0.2.134 +IN AAAA 2001:db8:0:20:0:0:0:0 +IN AAAA 2001:db8:0:21:0:0:0:0 + +; IP addresses for gw21 +; +topoff.vip1.gw21.nodes IN A 192.0.2.115 +IN A 192.0.2.116 +IN AAAA 2001:db8:0:e:0:0:0:0 +IN AAAA 2001:db8:0:f:0:0:0:0 +topoff.vip2.gw21.nodes IN A 192.0.2.135 +IN A 192.0.2.136 +IN AAAA 2001:db8:0:22:0:0:0:0 +IN AAAA 2001:db8:0:23:0:0:0:0 +topoff.eth1.gw21.nodes IN A 192.0.2.137 +IN A 192.0.2.138 +IN AAAA 2001:db8:0:24:0:0:0:0 +IN AAAA 2001:db8:0:25:0:0:0:0 +topoff.eth4.gw21.nodes IN A 192.0.2.139 +IN A 192.0.2.140 +IN AAAA 2001:db8:0:26:0:0:0:0 +IN AAAA 2001:db8:0:27:0:0:0:0 +topoff.eth9.gw21.nodes IN A 192.0.2.141 +IN A 192.0.2.142 +IN AAAA 2001:db8:0:28:0:0:0:0 +IN AAAA 2001:db8:0:29:0:0:0:0 + +;end of file + +``` + +The above records are essentially standalone records representing the PGW/SGW node and its interfaces. An operator would normally define the records when a new node is brought into service and would only modify it when new IP interfaces or services are added to that particular node. + +The fact both record types are here under the same name is a result of the PGW/SGW being collocated and having the same canonical node name. + +NOTE: The rule for node records is to always include all services that are allowed to be used on a node and are defined in 3GPP TS 23.003 [4] clause 19.4.3 for that node. Node records are meant to be complete. + +The lack of a record in a canonical node name record set is just as important as the records that are there. The commented out records in the example would be included for supporting S4-SGSN and/or Gn/Gp interfaces. Their absence states that the node does not support the function. + +### A. 3.7 TAI/TAC file for "Collocated Simple LTE Example" + +The format of the TAI/TAC name is standardized by 3GPP 23.003 [4] clause 19.4.2.3 and is of form tac-lb.tac-hb.tac.epc.mnc.mcc.3gppnetwork.org and service names are in 3GPP 23.003 [4] clause 19.4.3. + +The file containing the TAI/TAC records for this example will be SIMPLE\_TAI\_DB.txt and has following content. + +``` + +; All TAC codes for one region + +*.tac-hb01.tac ( +; IN NAPTR order pref. flag service regexp replacement +; IN NAPTR 100 999 "a" "x-3gpp-sgw:x-s5-gtp:x-s8-gtp" "" topoff.eth4.gw01.nodes ) +; IN NAPTR 200 999 "a" "x-3gpp-sgw:x-s5-gtp:x-s8-gtp" "" topoff.eth4.gw21.nodes +; IN NAPTR 300 999 "a" "x-3gpp-sgw:x-s8-pmip" "" topoff.eth9.gw01.nodes +; IN NAPTR 400 999 "a" "x-3gpp-sgw:x-s8-pmip" "" topoff.eth9.gw21.nodes +; Above records are needed for SGW selection in initial attach of a UE (or TAU or handover attach) +; +; IN NAPTR 500 999 "a" "x-3gpp-mme:x-s10" "" topoff.eth1.mmec01.mmegi8001.mme +; IN NAPTR 600 999 "a" "x-3gpp-mme:x-s10" "" topoff.eth1.mmec02.mmegi8001.mme + +``` + +``` + +; Above two records are needed for target MME selection by source MME +; +; IN NAPTR 700 999 "a" "x-3gpp-sgw:x-s11" "" topoff.eth1.gw01.nodes ) +; IN NAPTR 800 999 "a" "x-3gpp-sgw:x-s11" "" topoff.eth1.gw21.nodes +; Above two S11 records are purely optional for an operator to provision and are only +; an optimization when included so they are commented out for this example +; IN NAPTR 900 999 "a" "x-3gpp-sgw:x-s4" "" topoff.eth6.gw01.nodes ) +; IN NAPTR 1000 999 "a" "x-3gpp-sgw:x-s4" "" topoff.eth6.gw21.nodes +; This operator does not support S3/S4 so they are commented out for this example +; Above two S4 records are purely optional for an operator to provision even if S3/S4 is supported + +; Note relative value of NAPTR order is important between the S5/S8 records, +; relative value of NAPTR order is important between the S10 records, +; relative value of NAPTR order is important between the S11 records +; but is not really important between different interface types used here +; (i.e. the MME selection procedure does not look for an SGW interface) +; +; This operators policy is PMIPv6 is used only as last choice +; and only for S8 they don't allow S5 PMIPv6 at all + +; All TAC codes for another region + +*.tac-hb40.tac ( +; IN NAPTR order pref. flag service regexp replacement +; IN NAPTR 200 999 "a" "x-3gpp-sgw:x-s5-gtp:x-s8-gtp" "" topoff.eth4.gw01.nodes ) +; IN NAPTR 100 999 "a" "x-3gpp-sgw:x-s5-gtp:x-s8-gtp" "" topoff.eth4.gw21.nodes +; IN NAPTR 400 999 "a" "x-3gpp-sgw:x-s8-pmip" "" topoff.eth9.gw01.nodes +; IN NAPTR 300 999 "a" "x-3gpp-sgw:x-s8-pmip" "" topoff.eth9.gw21.nodes +; +; IN NAPTR 600 999 "a" "x-3gpp-mme:x-s10" "" topoff.eth1.mmec01.mmegi8001.mme +; IN NAPTR 500 999 "a" "x-3gpp-mme:x-s10" "" topoff.eth1.mmec02.mmegi8001.mme +; +; IN NAPTR 800 999 "a" "x-3gpp-sgw:x-s11" "" topoff.eth1.gw01.nodes ) +; IN NAPTR 700 999 "a" "x-3gpp-sgw:x-s11" "" topoff.eth1.gw21.nodes +; +; IN NAPTR 1000 999 "a" "x-3gpp-sgw:x-s4" "" topoff.eth6.gw01.nodes ) +; IN NAPTR 900 999 "a" "x-3gpp-sgw:x-s4" "" topoff.eth6.gw21.nodes + +; For the example the TAC values *.tac-hb40.tac are on other side of network than the *.tac-hb01.tac +; Relative order reverses in comparison to since those TAI are closer to the other set of nodes + +; end of file + +``` + +SGW records are here since TAI is used to select the SGW in the initial attach procedure (and TAU with SGW change). The MME record is here for the 'Inter eNodeB handover with MME relocation' procedure where a target MME must be selected by the source MME. + +Wild cards are used in this example to simplify provisioning assuming that the operator picks tac codes with the same high byte for each eNodeB that are equivalent in terms of prioritization. Otherwise each TAC code needs to be provisioned individually in DNS requiring a small amount of additional repetitive provisioning as each set of TAC codes is added to a network. + +From above SGW records we see only GTP based S5 so there is no PMIPv6 S5 support for the SGWs. The operator insists on GTP based S5 i.e. when one of their PGW is used and the UE is in their network (the operator does let roamers use another operators PMIPv6 PGW though). The S5/S8 SGW interfaces with (partially qualified) canonical node name gw01.nodes is used when possible for tac codes with high byte of 01 hex and the S5/S8 SGW interfaces with (partially qualified) canonical node name gw21.nodes is used when possible for tac codes with high byte of 40 hex. This follows from the NAPTR order 100 record being used before the order 200 record in the corresponding record set. This is the general mechanism an operator can use to steer the SGW selection based on which TAI the user initially attaches to (or during TAU with SGW service change). So an operator trying to minimize S1-U link costs would set the order to the smallest value for the SGW with the least cost S1-U link(s) to the eNodeB(s) serving that TAI and use higher order for the TAI corresponding to the more expensive links. + +The gw01.nodes and gw21.nodes are the collocated PGW/SGW canonical node names the operator chooses. These were defined in the file CS\_SGW\_PGW\_NODE\_DB.txt. + +The TAI records are not intended to determine the SGW S11 interface directly but only the candidate list SGW S5/S8 interfaces with node names. S11 interface lookup can be done from the SGW canonical node name (see records in CS\_SGW\_PGW\_NODE\_DB.txt) so inclusion of S11 here is not strictly needed. + +### A. 3.8 MME lookup based on GUTI for "Simple LTE Example" + +Here we "manually" execute the S-NAPTR procedure using the standard "dig" command for finding the source MME at the target MME (for example in a TAU procedure) to illustrate the procedure and show how the DNS records work in practice. + +The target MME receives the LTE UE's old GUTI. The target MME extracts the MNC, MCC, MMEC and MMEGI values. In this example the UE is in a cell where the MME selected by the RAN is assumed to be MMEC=1 and MMEGI=8000 hexadecimal. The MME creates the Application Unique String mmec01.mmegi8001.mme.\$ORIGIN (see clause 4.3.3.4 of this TS) + +NOTE: Reminder \$ORIGIN is epc.mnc990.mcc311.3gppnetwork.org. and is employed here simply to keep the length of the example text manageable. + +The target MME starts the S-NAPTR with Application Unique String = mmec01.mmegi8001.mme.\$ORIGIN and desired services x-3gpp-mme:x-s10 since it is trying to contact the old MME to do a context transfer. + +Here we emulate the same action manually with the dig command. + +``` +----- Command to DNS server----- +command: dig @192.0.2.247 +tcp NAPTR mmec01.mmegi8001.mme.$ORIGIN +-----Start Response from DNS server----- + +; <<>> DiG 9.5.0-P2-W2 <<>> @192.0.2.247 +tcp NAPTR mmec01.mmegi8001.mme.$ORIGIN +; (1 server found) +;; global options: printcmd +;; Got answer: +;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 1399 +;; flags: qr aa rd; QUERY: 1, ANSWER: 2, AUTHORITY: 2, ADDITIONAL: 10 +;; WARNING: recursion requested but not available + +;; QUESTION CLAUSE: +;mmec01.mmegi8001.mme.$ORIGIN. IN NAPTR + +;; ANSWER CLAUSE: +mmec01.mmegi8001.mme.$ORIGIN. 3600 IN NAPTR 100 999 "a" "x-3gpp-mme:x-s10" "" +topoff.eth1.mmec01.mmegi8001.mme.$ORIGIN. +mmec01.mmegi8001.mme.$ORIGIN. 3600 IN NAPTR 200 999 "a" "x-3gpp-mme:x-s11" "" +topoff.eth3.mmec01.mmegi8001.mme.$ORIGIN. + +;; AUTHORITY CLAUSE: +$ORIGIN. 3600 IN NS ns1.$ORIGIN. +$ORIGIN. 3600 IN NS ns2.$ORIGIN. + +;; ADDITIONAL CLAUSE: +topoff.eth1.mmec01.mmegi8001.mme.$ORIGIN. 3600 IN A 192.0.2.12 +topoff.eth1.mmec01.mmegi8001.mme.$ORIGIN. 3600 IN A 192.0.2.11 +topoff.eth1.mmec01.mmegi8001.mme.$ORIGIN. 3600 IN AAAA 2001:db8:: +topoff.eth1.mmec01.mmegi8001.mme.$ORIGIN. 3600 IN AAAA 2001:db8:0:1:: +topoff.eth3.mmec01.mmegi8001.mme.$ORIGIN. 3600 IN A 192.0.2.14 +topoff.eth3.mmec01.mmegi8001.mme.$ORIGIN. 3600 IN A 192.0.2.13 +topoff.eth3.mmec01.mmegi8001.mme.$ORIGIN. 3600 IN AAAA 2001:db8:0:2:: +topoff.eth3.mmec01.mmegi8001.mme.$ORIGIN. 3600 IN AAAA 2001:db8:0:3:: +ns1.$ORIGIN. 3600 IN A 192.0.2.247 +ns2.$ORIGIN. 3600 IN A 192.0.2.248 + +;; Query time: 15 msec +;; SERVER: 192.0.2.247#53(192.0.2.247) +;; WHEN: Wed Jan 21 16:30:20 2009 +;; MSG SIZE rcvd: 524 +``` + +-----End Response from DNS server----- + +MME retains only NAPTR with matching services matching x-3gpp-mme:x-s10 yielding + +| NAPTR record set | service | flag | order | preference | +|------------------|------------------|------|-------|------------| +| replacement | x-3gpp-mme:x-s10 | "a" | 100 | 999 | + +MME node sorts the NAPTR records by RFC 3958 rules. Obviously since this is a list of only one record it yields the same list back again unchanged. + +Since the record is the terminal ("a") flag we have the host name (and canonical node name inside it). + +Formally the A/AAAA record lookup can be performed at this point or it can be deferred until a later step. + +The MME can store the important content now + +topoff.eth1.mmec01.mmegi8001.mme.\$ORIGIN services of x-3gpp-mme:x-s10 + +Because there is only one match the MME now has the final candidate list (except for IP addresses). + +topoff.eth1.mmec01.mmegi8001.mme.\$ORIGIN services of x-3gpp-mme:x-s10 + +Note the needed A/AAAA records for topoff.eth1.mmec01.mmegi8001.mme are already present in the additional record clause of the response. + +``` +topoff.eth1.mmec01.mmegi8001.mme.$ORIGIN. 3600 IN A 192.0.2.12 +topoff.eth1.mmec01.mmegi8001.mme.$ORIGIN. 3600 IN A 192.0.2.11 +topoff.eth1.mmec01.mmegi8001.mme.$ORIGIN. 3600 IN AAAA 2001:db8:: +topoff.eth1.mmec01.mmegi8001.mme.$ORIGIN. 3600 IN AAAA 2001:db8:0:1:: +``` + +If the records had not been available in the additional record clause of the response then the MME would have had to done the A/AAAA record lookups directly. Emulated by dig command they would have been + +``` +command: dig @192.0.2.247 +tcp A topoff.eth1.mmec01.mmegi8001.mme.$ORIGIN +and +``` + +``` +command: dig @192.0.2.247 +tcp AAAA topoff.eth1.mmec01.mmegi8001.mme.$ORIGIN +``` + +or + +``` +command: dig @192.0.2.247 +tcp ANY topoff.eth1.mmec01.mmegi8001.mme.$ORIGIN +``` + +Regardless of the source of the A and AAAA records, the order of the A records shall be randomly shuffled by the MME. The same shall be done for the AAAA records. (For our "manual" example it will be a coin flip as to which of the two records is first). + +The MME now has a candidate list (very short here) with the needed IPv4 and IPv6 addresses. I.e.: + +``` +(topoff.eth1.mmec01.mmegi8001.mme.$ORIGIN, services of x-3gpp-mme:x-s10, {192.0.2.12,192.0.2.11}, { +2001:db8::, 2001:db8:0:1:: } ) +``` + +The target MME then can use the IPv4 (or IPv6) addresses to contact the source MME over S10 to get the UE's context information from the old MME. + +When an operator uses only NAPTR flag "a" records the S-NAPTR procedure will only require one NAPTR lookup from the Application Unique String in all cases greatly streamlining the DNS lookups. Also assuming a modern DNS server where the NAPTR and A/AAAA records in the same DNS server the needed A/AAAA records are likely to be in the additional record clause (as the above real output shows). + +However, the needed A/AAAA records would NOT have been present even in this small example if the DNS resolver (dig here) had not used TCP transport (or EDNS0 for UDP) since the packet size of the response in this example was 524 bytes which exceeds the 512 byte limit for using UDP transport without EDNS0. + +### A. 3.9 APN lookup for "Simple LTE Example" (i.e. PGW candidate list) + +Assume a non-roaming LTE UE indicates it want to use APN-NI string "imsTV2" to the MME in our example network at initial attach. + +NOTE 1: Reminder \$ORIGIN is epc.mnc990.mcc311.3gppnetwork.org. and is employed here simply to keep the length of the example text manageable + +The MME starts the S-NAPTR procedure with Application Unique String = imsTV2.apn.\$ORIGIN and desired services x-3gpp-pgw:x-s5-gtp and x-3gpp-pgw:x-s5-pmip. + +Here we emulate the same action the MME would do manually with the dig command. + +MME starts with Application Unique String = imsTV2.apn.\$ORIGIN and the desired services x-3gpp-pgw:x-s5-gtp and x-3gpp-pgw:x-s5-pmip + +``` +----- Command to DNS server----- +command: dig @192.0.2.247 +tcp NAPTR imsTV2.apn.$ORIGIN +-----Start Response from DNS server----- + +; <<>> DiG 9.5.0-P2-W2 <<>> @192.0.2.247 +tcp NAPTR imsTV2.apn.$ORIGIN +; (1 server found) +;; global options: printcmd +;; Got answer: +;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 1796 +;; flags: qr aa rd; QUERY: 1, ANSWER: 4, AUTHORITY: 2, ADDITIONAL: 18 +;; WARNING: recursion requested but not available + +;; QUESTION CLAUSE: +;imsTV2.apn.$ORIGIN. IN NAPTR + +;; ANSWER CLAUSE: +imsTV2.apn.$ORIGIN. 3600 IN NAPTR 600 999 "a" "x-3gpp-pgw:x-s8-pmip" "" +topoff.vip2.gw01.node.$ORIGIN. +imsTV2.apn.$ORIGIN. 3600 IN NAPTR 100 999 "a" "x-3gpp-pgw:x-s5-gtp:x-s8-gtp" "" +topoff.vip1.gw21.node.$ORIGIN. +imsTV2.apn.$ORIGIN. 3600 IN NAPTR 200 999 "a" "x-3gpp-pgw:x-s5-gtp:x-s8-gtp" "" +topoff.vip1.gw01.node.$ORIGIN. +imsTV2.apn.$ORIGIN. 3600 IN NAPTR 500 999 "a" "x-3gpp-pgw:x-s8-pmip" "" +topoff.vip2.gw21.node.$ORIGIN. + +;; AUTHORITY CLAUSE: +$ORIGIN. 3600 IN NS ns2.$ORIGIN. +$ORIGIN. 3600 IN NS ns1.$ORIGIN. + +;; ADDITIONAL CLAUSE: +topoff.vip1.gw21.node.$ORIGIN. 3600 IN A 192.0.2.116 +topoff.vip1.gw21.node.$ORIGIN. 3600 IN A 192.0.2.115 +topoff.vip1.gw21.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:e:: +topoff.vip1.gw21.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:f:: +topoff.vip1.gw01.node.$ORIGIN. 3600 IN A 192.0.2.114 +topoff.vip1.gw01.node.$ORIGIN. 3600 IN A 192.0.2.113 +topoff.vip1.gw01.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:c:: +topoff.vip1.gw01.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:d:: +topoff.vip2.gw21.node.$ORIGIN. 3600 IN A 192.0.2.136 +topoff.vip2.gw21.node.$ORIGIN. 3600 IN A 192.0.2.135 +topoff.vip2.gw21.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:22:: +topoff.vip2.gw21.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:23:: +topoff.vip2.gw01.node.$ORIGIN. 3600 IN A 192.0.2.144 +topoff.vip2.gw01.node.$ORIGIN. 3600 IN A 192.0.2.143 +topoff.vip2.gw01.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:2a:: +topoff.vip2.gw01.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:2b:: +ns1.$ORIGIN. 3600 IN A 192.0.2.247 +ns2.$ORIGIN. 3600 IN A 192.0.2.248 + +;; Query time: 0 msec +;; SERVER: 192.0.2.247#53(192.0.2.247) +;; WHEN: Wed Jan 21 19:21:14 2009 +;; MSG SIZE rcvd: 890 + +-----End Response from DNS server----- + +MME retains only NAPTR records with matching services x-3gpp-pgw:x-s5-gtp and +x-3gpp-pgw:x-s5-pmip yielding: +NAPTR record set +replacement service flag order preference +topoff.vip1.gw21.node.$ORIGIN x-3gpp-pgw:x-s5-gtp:x-s8-gtp "a" 100 999 +topoff.vip1.gw01.node.$ORIGIN x-3gpp-pgw:x-s5-gtp:x-s8-gtp "a" 200 999 +; Note the x-s8-gtp are not really included but are kept here to allow the +; reader to see which NAPTR record was kept from the DNS response. +; The DNS server "luckily" returns this in sorted order but the MME must sort it . +; The DNS server is not responsible for sorting but the DNS resolver (i.e. the MME) +MME node sorts NAPTR by RFC 3958 yielding +NAPTR record set +replacement service flag order preference +topoff.vip1.gw21.node.$ORIGIN x-3gpp-pgw:x-s5-gtp:x-s8-gtp "a" 100 999 +topoff.vip1.gw01.node.$ORIGIN x-3gpp-pgw:x-s5-gtp:x-s8-gtp "a" 200 999 +MME Stores records since they are flag "a" +topoff.vip1.gw21.node.$ORIGIN services of x-3gpp-pgw:x-s5-gtp +``` + +``` +topoff.vip1.gw01.node.$ORIGIN services of x-3gpp-pgw:x-s5-gtp +MME now has final candidate list (A and AAAA lookup is deferred for our hand example) +topoff.vip1.gw21.node.$ORIGIN services of x-3gpp-pgw:x-s5-gtp +topoff.vip1.gw01.node.$ORIGIN services of x-3gpp-pgw:x-s5-gtp +``` + +The needed A/AAAA records were included with additional records. I.e. + +``` +topoff.vip1.gw21.node.$ORIGIN. 3600 IN A 192.0.2.116 +topoff.vip1.gw21.node.$ORIGIN. 3600 IN A 192.0.2.115 +topoff.vip1.gw21.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:e:: +topoff.vip1.gw21.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:f:: +``` + +and + +``` +topoff.vip1.gw01.node.$ORIGIN. 3600 IN A 192.0.2.114 +topoff.vip1.gw01.node.$ORIGIN. 3600 IN A 192.0.2.113 +topoff.vip1.gw01.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:c:: +topoff.vip1.gw01.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:d:: +``` + +IF the A and AAAA records were not available in the Additional Record clause (or a DNS cache) the MME would do the A/AAAA lookups. Which emulating with manual commands would look like: + +``` +dig @192.0.2.247 +tcp A topoff.vip1.gw21.node.$ORIGIN +dig @192.0.2.247 +tcp AAAA topoff.vip1.gw21.node.$ORIGIN +dig @192.0.2.247 +tcp A topoff.vip1.gw01.node.$ORIGIN +dig @192.0.2.247 +tcp AAAA topoff.vip1.gw01.node.$ORIGIN +``` + +We can form the full candidate list now (after random shuffling the A and AAAA records) to get + +``` +(topoff.vip1.gw21.node.$ORIGIN ,services of x-3gpp-pgw:x-s5-gtp , {192.0.2.115,192.0.2.116}, { +2001:db8:0:e::,2001:db8:0:f::} ) +(topoff.vip1.gw01.node.$ORIGIN ,services of x-3gpp-pgw:x-s5-gtp , {192.0.2.114,192.0.2.113}, { +2001:db8:0:c::, 2001:db8:0:d::}) +``` + +The fact that the node topoff.vip1.gw21.node.\$ORIGIN comes first is a direct result of the two different NAPTR order values. + +NOTE 2: This is the last example in this Annex with A and AAAA lookups and IP addresses explicitly included in the candidate list. This detail is left for the reader for the remaining clauses. + +For the initial attach case the candidate list of SGW has to be formally found to handle the collocated PGW and SGW case. The SGW candidate list is found in the next clause. + +NOTE 3: If this DNS procedure was being used for an additional PDN connection for a UE with an existing SGW rather than a first attach, then the MME would check to see if the current SGW node name matches any of the PGW node names in the above list (gw01.node.\$ORIGIN and gw21.node.\$ORIGIN) to try to pick a collocated PGW on the current SGW. The canonical node name record of the current SGW can be used by the MME to find all S5/S8 SGW interfaces on the current PGW. This is a smaller example of what follows so we do not detail it further. + +### A. 3.10 TAI lookup for "Simple LTE Example" (i.e. SGW candidate list) + +Assume a non-roaming LTE UE performs an initial attach and indicates it wants to use an APN-NI (an APN in this operator's network). The MME knows it does not need to use S8 since it is a non-roaming UE and must be local APN so S5 is used. + +NOTE 1: Reminder \$ORIGIN is epc.mnc990.mcc311.3gppnetwork.org. and is employed here simply to keep the length of the example text manageable. + +The MME has the TAI value where the UE has attached. We assume the low byte of the TAC is hex 11 and the high byte is hex 40. + +The MME starts the S-NAPTR procedure with Application Unique String = tac-lb11.tac-hb40.tac.\$ORIGIN and desired services x-3gpp-sgw:x-s11,x-3gpp-sgw:x-s5-gtp, x-3gpp-sgw:x-s5-pmip. + +NOTE 2: This particular MME vendor looks for the x-s11 values, which is only an optional optimization. This will not have any benefit in this example since the operator chosed not to provision them. + +Here we emulate the same action the MME would do manually with the "dig" command. + +MME starts with Application Unique String = tac-lb11.tac-hb40.tac.\$ORIGIN +desired services x-3gpp-sgw:x-s11,x-3gpp-sgw:x-s5-gtp, x-3gpp-sgw:x-s5-pmip + +----- Command to DNS server----- + +command: dig @192.0.2.247 +tcp NAPTR tac-lb11.tac-hb40.tac.\$ORIGIN + +-----Start Response from DNS server----- + +; <<>> DiG 9.5.0-P2-W2 <<>> @192.0.2.247 +tcp NAPTR tac-lb11.tac-hb40.tac.\$ORIGIN + +; (1 server found) + +;; global options: printcmd + +;; Got answer: + +;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 622 + +;; flags: qr aa rd; QUERY: 1, ANSWER: 6, AUTHORITY: 2, ADDITIONAL: 26 + +;; WARNING: recursion requested but not available + +;; QUESTION CLAUSE: + +;tac-lb11.tac-hb40.tac.\$ORIGIN. IN NAPTR + +;; ANSWER CLAUSE: + +tac-lb11.tac-hb40.tac.\$ORIGIN. 3600 IN NAPTR 400 999 "a" "x-3gpp-sgw:x-s8-pmip" "" + +topoff.eth9.gw01.node.\$ORIGIN. + +tac-lb11.tac-hb40.tac.\$ORIGIN. 3600 IN NAPTR 500 999 "a" "x-3gpp-mme:x-s10" "" + +topoff.eth1.mmec02.mmegi8001.mme.\$ORIGIN. + +tac-lb11.tac-hb40.tac.\$ORIGIN. 3600 IN NAPTR 600 999 "a" "x-3gpp-mme:x-s10" "" + +topoff.eth1.mmec01.mmegi8001.mme.\$ORIGIN. + +tac-lb11.tac-hb40.tac.\$ORIGIN. 3600 IN NAPTR 100 999 "a" "x-3gpp-sgw:x-s5-gtp:x-s8-gtp" "" + +topoff.eth4.gw21.node.\$ORIGIN. + +tac-lb11.tac-hb40.tac.\$ORIGIN. 3600 IN NAPTR 200 999 "a" "x-3gpp-sgw:x-s5-gtp:x-s8-gtp" "" + +topoff.eth4.gw01.node.\$ORIGIN. + +tac-lb11.tac-hb40.tac.\$ORIGIN. 3600 IN NAPTR 300 999 "a" "x-3gpp-sgw:x-s8-pmip" "" + +topoff.eth9.gw21.node.\$ORIGIN. + +;; AUTHORITY CLAUSE: + +\$ORIGIN. 3600 IN NS ns2.\$ORIGIN. + +\$ORIGIN. 3600 IN NS ns1.\$ORIGIN. + +;; ADDITIONAL CLAUSE: + +topoff.eth4.gw21.node.\$ORIGIN. 3600 IN A 192.0.2.140 + +topoff.eth4.gw21.node.\$ORIGIN. 3600 IN A 192.0.2.139 + +topoff.eth4.gw21.node.\$ORIGIN. 3600 IN AAAA 2001:db8:0:26:: + +topoff.eth4.gw21.node.\$ORIGIN. 3600 IN AAAA 2001:db8:0:27:: + +topoff.eth4.gw01.node.\$ORIGIN. 3600 IN A 192.0.2.132 + +topoff.eth4.gw01.node.\$ORIGIN. 3600 IN A 192.0.2.131 + +topoff.eth4.gw01.node.\$ORIGIN. 3600 IN AAAA 2001:db8:0:1e:: + +topoff.eth4.gw01.node.\$ORIGIN. 3600 IN AAAA 2001:db8:0:1f:: + +topoff.eth9.gw21.node.\$ORIGIN. 3600 IN A 192.0.2.142 + +topoff.eth9.gw21.node.\$ORIGIN. 3600 IN A 192.0.2.141 + +topoff.eth9.gw21.node.\$ORIGIN. 3600 IN AAAA 2001:db8:0:28:: + +topoff.eth9.gw21.node.\$ORIGIN. 3600 IN AAAA 2001:db8:0:29:: + +topoff.eth9.gw01.node.\$ORIGIN. 3600 IN A 192.0.2.134 + +topoff.eth9.gw01.node.\$ORIGIN. 3600 IN A 192.0.2.133 + +topoff.eth9.gw01.node.\$ORIGIN. 3600 IN AAAA 2001:db8:0:20:: + +topoff.eth9.gw01.node.\$ORIGIN. 3600 IN AAAA 2001:db8:0:21:: + +topoff.eth1.mmec02.mmegi8001.mme.\$ORIGIN. 3600 IN A 192.0.2.18 + +topoff.eth1.mmec02.mmegi8001.mme.\$ORIGIN. 3600 IN A 192.0.2.17 + +topoff.eth1.mmec02.mmegi8001.mme.\$ORIGIN. 3600 IN AAAA 2001:db8:0:6:: + +topoff.eth1.mmec02.mmegi8001.mme.\$ORIGIN. 3600 IN AAAA 2001:db8:0:7:: + +topoff.eth1.mmec01.mmegi8001.mme.\$ORIGIN. 3600 IN A 192.0.2.12 + +topoff.eth1.mmec01.mmegi8001.mme.\$ORIGIN. 3600 IN A 192.0.2.11 + +topoff.eth1.mmec01.mmegi8001.mme.\$ORIGIN. 3600 IN AAAA 2001:db8:: + +topoff.eth1.mmec01.mmegi8001.mme.\$ORIGIN. 3600 IN AAAA 2001:db8:0:1:: + +ns1.\$ORIGIN. 3600 IN A 192.0.2.247 + +ns2.\$ORIGIN. 3600 IN A 192.0.2.248 + +;; Query time: 0 msec + +;; SERVER: 192.0.2.247#53(192.0.2.247) + +;; WHEN: Wed Jan 21 19:33:00 2009 + +``` +;; MSG SIZE rcvd: 1285 +``` + +``` +-----End Response from DNS server----- +``` + +MME retains only the NAPTR with matching services x-3gpp-sgw:x-s11,x-3gpp-sgw:x-s5-gtp, and x-3gpp-sgw:x-s5-pmip yielding + +NAPTR record set + +| replacement | service | flag | order | preference | +|--------------------------------|------------------------------|------|-------|------------| +| topoff.eth4.gw01.node.\$ORIGIN | x-3gpp-sgw:x-s5-gtp:x-s8-gtp | "a" | 200 | 999 | +| topoff.eth4.gw21.node.\$ORIGIN | x-3gpp-sgw:x-s5-gtp:x-s8-gtp | "a" | 100 | 999 | + +; Note the x-s8-gtp are not really included but are kept here to allow the +; reader to see which NAPTR record was kept from the DNS response. + +MME node sorts the NAPTR records by RFC 3958 yielding + +NAPTR record set + +| replacement | service | flag | order | preference | +|--------------------------------|------------------------------|------|-------|------------| +| topoff.eth4.gw21.node.\$ORIGIN | x-3gpp-sgw:x-s5-gtp:x-s8-gtp | "a" | 100 | 999 | +| topoff.eth4.gw01.node.\$ORIGIN | x-3gpp-sgw:x-s5-gtp:x-s8-gtp | "a" | 200 | 999 | + +MME Stores + +``` +topoff.eth4.gw21.node.$ORIGIN services of x-3gpp-sgw:x-s5-gtp +topoff.eth4.gw01.node.$ORIGIN services of x-3gpp-sgw:x-s5-gtp +``` + +MME now has candidate list + +``` +topoff.eth4.gw21.node.$ORIGIN services of x-3gpp-sgw:x-s5-gtp +topoff.eth4.gw01.node.$ORIGIN services of x-3gpp-sgw:x-s5-gtp +``` + +Again the A/AAAA records were available in the additional record clause. + +``` +topoff.eth4.gw21.node.$ORIGIN. 3600 IN A 192.0.2.140 +topoff.eth4.gw21.node.$ORIGIN. 3600 IN A 192.0.2.139 +topoff.eth4.gw21.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:26:: +topoff.eth4.gw21.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:27:: +and +topoff.eth4.gw01.node.$ORIGIN. 3600 IN A 192.0.2.132 +topoff.eth4.gw01.node.$ORIGIN. 3600 IN A 192.0.2.131 +topoff.eth4.gw01.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:1e:: +topoff.eth4.gw01.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:1f:: +``` + +NOTE: The size of the response was 1285 bytes and indicates why EDNS0 or TCP transport should be used for S-NAPTR when feasible. Most of the data in the Additional Record Clause would not have been available if only 512 bytes had been sent. + +### A. 3.11 Finding the collocated SGW and PGW together + +IP addresses are not included here for readability. + +We are now in a position to look at both the SGW candidate list and PGW candidate list at the same time. + +From A.3.9 we had the PGW candidate list for the APN-NI "imsTV2" was + +``` +topoff.vip1.gw21.node.$ORIGIN services of x-3gpp-pgw:x-s5-gtp +topoff.vip1.gw01.node.$ORIGIN services of x-3gpp-pgw:x-s5-gtp +``` + +From A.3.10 we had the SGW candidate list for TAI where low byte of TAC is hex 11 and the high byte is hex 40 was + +``` +topoff.eth4.gw21.node.$ORIGIN services of x-3gpp-sgw:x-s5-gtp +topoff.eth4.gw01.node.$ORIGIN services of x-3gpp-sgw:x-s5-gtp +``` + +We only have GTPv2 so the protocols match. + +Both nodes gw21.node.\$ORIGIN and gw01.node.\$ORIGIN are collocated. + +Hence, moving the collocated nodes to the front of both lists leaves them unchanged. + +The procedure requires we use the SGW ordering to select the SGW first. + +Hence, the SGW interface to try first is topoff.eth4.gw21.node.\$ORIGIN + +That is node gw21.node.\$ORIGIN. + +That means the PGW record that is collocated is: + +``` +topoff.vipl.gw21.node.$ORIGIN services of x-3gpp-pgw:x-s5-gtp +which is the first PGW interface to try. +``` + +NOTE: It is an "accident" that this is the same order as the APN-NI "imsTV2" gave back. If APN-NI had been "imsTV1" the order would have been reversed in the PGW candidate list and it would NOT have been first. Again the collocation ordering takes precedence. + +The MME would use the IP addresses from the records (not shown) for the S11 Create Session Request attempt. + +Assuming it succeeds we would not need to try any other PGW or SGW records. + +The MME needs the S11 interface so it can physically send the Create Session Request to the SGW. That is covered in the next clause. + +### A. 3.12 S11 lookup by SGW canonical node name + +Assume an SGW has been picked with canonical node name of gw21.node.\$ORIGIN + +The MME starts with Application Unique String = gw21.node.\$ORIGIN obtained from the SGW selection with desired services x-3gpp-sgw:x-s11 + +``` +----- Command to DNS server----- +command: dig @192.0.2.247 +tcp NAPTR gw21.node.$ORIGIN +-----Start Response from DNS server----- + +; <<>> DiG 9.5.0-P2-W2 <<>> @192.0.2.247 +tcp NAPTR gw21.node.$ORIGIN +; (1 server found) +;; global options: printcmd +;; Got answer: +;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 23 +;; flags: qr aa rd; QUERY: 1, ANSWER: 5, AUTHORITY: 2, ADDITIONAL: 22 +;; WARNING: recursion requested but not available + +;; QUESTION CLAUSE: +;gw21.node.$ORIGIN. IN NAPTR + +;; ANSWER CLAUSE: +gw21.node.$ORIGIN. 3600 IN NAPTR 600 999 "a" "x-3gpp-sgw:x-s8-pmip" "" +topoff.eth9.gw21.node.$ORIGIN. +gw21.node.$ORIGIN. 3600 IN NAPTR 100 999 "a" "x-3gpp-sgw:x-s11" "" topoff.eth1.gw21.node.$ORIGIN. +gw21.node.$ORIGIN. 3600 IN NAPTR 200 999 "a" "x-3gpp-pgw:x-s5-gtp:x-s8-gtp" "" +topoff.vipl.gw21.node.$ORIGIN. +gw21.node.$ORIGIN. 3600 IN NAPTR 300 999 "a" "x-3gpp-sgw:x-s5-gtp:x-s8-gtp" "" +topoff.eth4.gw21.node.$ORIGIN. +gw21.node.$ORIGIN. 3600 IN NAPTR 400 999 "a" "x-3gpp-pgw:x-s8-pmip" "" +topoff.vip2.gw21.node.$ORIGIN. + +;; AUTHORITY CLAUSE: +$ORIGIN. 3600 IN NS ns2.$ORIGIN. +$ORIGIN. 3600 IN NS ns1.$ORIGIN. + +;; ADDITIONAL CLAUSE: +topoff.eth1.gw21.node.$ORIGIN. 3600 IN A 192.0.2.138 +topoff.eth1.gw21.node.$ORIGIN. 3600 IN A 192.0.2.137 +topoff.eth1.gw21.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:24:: +topoff.eth1.gw21.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:25:: +topoff.vipl.gw21.node.$ORIGIN. 3600 IN A 192.0.2.116 +topoff.vipl.gw21.node.$ORIGIN. 3600 IN A 192.0.2.115 +topoff.vipl.gw21.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:e:: +topoff.vipl.gw21.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:f:: +topoff.eth4.gw21.node.$ORIGIN. 3600 IN A 192.0.2.139 +topoff.eth4.gw21.node.$ORIGIN. 3600 IN A 192.0.2.140 +topoff.eth4.gw21.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:27:: +topoff.eth4.gw21.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:26:: +topoff.vip2.gw21.node.$ORIGIN. 3600 IN A 192.0.2.136 +topoff.vip2.gw21.node.$ORIGIN. 3600 IN A 192.0.2.135 +topoff.vip2.gw21.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:22:: +topoff.vip2.gw21.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:23:: +topoff.eth9.gw21.node.$ORIGIN. 3600 IN A 192.0.2.141 +``` + +``` + +topoff.eth9.gw21.node.$ORIGIN. 3600 IN A 192.0.2.142 +topoff.eth9.gw21.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:29:: +topoff.eth9.gw21.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:28:: +ns1.$ORIGIN. 3600 IN A 192.0.2.247 +ns2.$ORIGIN. 3600 IN A 192.0.2.248 + +;; Query time: 0 msec +;; SERVER: 192.0.2.247#53(192.0.2.247) +;; WHEN: Wed Jan 21 19:45:36 2009 +;; MSG SIZE rcvd: 1072 + +-----End Response from DNS server----- +MME retains only the NAPTR records with matching service x-3gpp-sgw:x-s11 yielding +NAPTR record set +replacement service flag order preference +topoff.eth1.gw21.node.$ORIGIN x-3gpp-sgw:x-s11 "a" 100 999 +MME node sorts NAPTR by RFC 3958 (trivially here) yielding +NAPTR record set +replacement service flag order preference +topoff.eth1.gw21.node.$ORIGIN x-3gpp-sgw:x-s11 "a" 100 999 +MME Stores +topoff.eth1.gw21.node.$ORIGIN services of x-3gpp-sgw:x-s11 +MME now has candidate list +topoff.eth1.gw21.node.$ORIGIN services of x-3gpp-sgw:x-s11 + +``` + +Again the needed A and AAAA records are in the additional record clause + +``` + +topoff.eth1.gw21.node.$ORIGIN. 3600 IN A 192.0.2.138 +topoff.eth1.gw21.node.$ORIGIN. 3600 IN A 192.0.2.137 +topoff.eth1.gw21.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:24:: +topoff.eth1.gw21.node.$ORIGIN. 3600 IN AAAA 2001:db8:0:25:: + +``` + +### A. 3.13 TAI lookup for "Colocation Simple LTE Example" (i.e. MME candidate list) + +This type of lookup is done for the "Inter eNodeB handover with MME relocation" procedure where the old MME selects the target MME in a new TAI. + +The service is x-3gpp-mme:x-s10 again. + +Since this also starts with the TAI NAPTR lookup we have the same type of record set as the SGW selection from TAI clause (see A.3.10) and to not waste space the same TAC value will be used. + +The only difference from that clause starts with which NAPTR records match. + +From the Answer clause these are: + +``` + +;; ANSWER CLAUSE: +tac-1b11.tac-hb40.tac.$ORIGIN. 3600 IN NAPTR 500 999 "a" "x-3gpp-mme:x-s10" "" +topoff.eth1.mmec02.mmegi8001.mme.$ORIGIN. +tac-1b11.tac-hb40.tac.$ORIGIN. 3600 IN NAPTR 600 999 "a" "x-3gpp-mme:x-s10" "" +topoff.eth1.mmec01.mmegi8001.mme.$ORIGIN. + +``` + +Which are already in order. The NAPTR order of 500 is less than NAPTR order of 600. + +So S10 interfaces in order are: + +topoff.eth1.mmec02.mmegi8001.mme.\$ORIGIN. + +topoff.eth1.mmec01.mmegi8001.mme.\$ORIGIN. + +and the needed A/AAAA records from the Additional clause in the DNS response in clause A.3.10 are: + +``` + +topoff.eth1.mmec02.mmegi8001.mme.$ORIGIN. 3600 IN A 192.0.2.18 +topoff.eth1.mmec02.mmegi8001.mme.$ORIGIN. 3600 IN A 192.0.2.17 +topoff.eth1.mmec02.mmegi8001.mme.$ORIGIN. 3600 IN AAAA 2001:db8:0:6:: +topoff.eth1.mmec02.mmegi8001.mme.$ORIGIN. 3600 IN AAAA 2001:db8:0:7:: + +topoff.eth1.mmec01.mmegi8001.mme.$ORIGIN. 3600 IN A 192.0.2.12 + +``` + +``` +topoff.eth1.mmec01.mmegi8001.mme.$ORIGIN. 3600 IN A 192.0.2.11 +topoff.eth1.mmec01.mmegi8001.mme.$ORIGIN. 3600 IN AAAA 2001:db8:: +topoff.eth1.mmec01.mmegi8001.mme.$ORIGIN. 3600 IN AAAA 2001:db8:0:1:: +``` + +## A.4 LTE Example with Dedicated Core Network + +### A.4.1 General + +The example of an operator network for DCN deployment has same properties as described in A.3.1 with the following modifications: + +- 5) Combined PGW/SGW (01) supports UE usage type of 1, 10, 20 and Combined PGW/SGW (21) supports all the UEs except UEs associated with UE usage type 1, 10, 20. +- 7) Two MME pool areas are defined and each MME pool has two MMEs. The MME pool with MMEGI of 8001 supports UE usage type of 1, 10, 20 where the other MME pool supports all the UEs except UEs associated with UE usage type 1, 10, 20. +- 11) There is only one APN-NI in this network "imsTV1". + +The following figure shows the simple example of DCN deployment. + +![Diagram of DCN deployment showing a hierarchy of network elements. At the top is a cylinder representing the PDN. Below it are two ovals representing SGW/PGW units: SGW/PGW (01) with 'UE usage type=1, 10, 20' and SGW/PGW (21) with '(Default)'. Both are connected to the PDN. Below SGW/PGW (01) is an oval for MMEGI=8001 containing MME01 and MME02, with 'UE usage type=1, 10, 20'. Below SGW/PGW (21) is an oval for MMEGI=8002 containing MME03 and MME04, with '(Default)'. Both MME pools are connected to a common 'LTE area' at the bottom.](06291c5328a7a4335d41a48850a3a207_img.jpg) + +``` + +graph TD + PDN[(PDN)] --- SGW01((SGW/PGW (01) +UE usage type=1, 10, 20)) + PDN --- SGW21((SGW/PGW (21) +(Default))) + SGW01 --- MME01Pool((MMEGI=8001 +MME01 MME02 +UE usage type=1, 10, 20)) + SGW21 --- MME02Pool((MMEGI=8002 +MME03 MME04 +(Default))) + MME01Pool --- LTE_area([LTE area]) + MME02Pool --- LTE_area + +``` + +Diagram of DCN deployment showing a hierarchy of network elements. At the top is a cylinder representing the PDN. Below it are two ovals representing SGW/PGW units: SGW/PGW (01) with 'UE usage type=1, 10, 20' and SGW/PGW (21) with '(Default)'. Both are connected to the PDN. Below SGW/PGW (01) is an oval for MMEGI=8001 containing MME01 and MME02, with 'UE usage type=1, 10, 20'. Below SGW/PGW (21) is an oval for MMEGI=8002 containing MME03 and MME04, with '(Default)'. Both MME pools are connected to a common 'LTE area' at the bottom. + +Figure A.4.x1-1: Simple example of DCN deployment + +### A.4.2 APN file for DCN + +The format of the APN FQDN is standardized by 3GPP TS 23.003 [4] clause 19.4.2.2 and is of form .apn.epc.mnc.mcc.3gppnetwork.org. + +Service names are in 3GPP TS 23.003 [4] clause 19.4.3 with +ue- appended to the 'app-protocol' name. + +The file containing the APN records for this example will be CS\_APN\_DB.txt and has following content. + +``` +imsTV1.apn +; IN NAPTR order pref. flag service regexp replacement +; IN NAPTR 100 999 "a" "x-3gpp-pgw:x-s5-gtp+ue-1.10.20:x-s8-gtp+ue-1.10.20" "" +topoff.vip1.gw01.nodes ) +; IN NAPTR 200 999 "a" "x-3gpp-pgw:x-s5-gtp:x-s8-gtp" "" topoff.vip1.gw21.nodes +; IN NAPTR 300 999 "a" "x-3gpp-pgw:x-gn+ue-1.10.20:x-gp+ue-1.10.20" "" +topoff.vip3.gw01.nodes +; IN NAPTR 400 999 "a" "x-3gpp-pgw:x-gn:x-gp" "" topoff.vip3.gw21.nodes +; IN NAPTR 500 999 "a" "x-3gpp-pgw:x-s8-pmip+ue-1.10.20" "" topoff.vip2.gw01.nodes +; IN NAPTR 600 999 "a" "x-3gpp-pgw:x-s8-pmip" "" topoff.vip2.gw21.nodes +;The operator uses PGW01 for UE usage type of 1,10,20 and PGW21 for non DCN user. +;The operator does not support Gn/Gp so those records are commented out +``` + +### A.4.3 PGW/SGW node file for "Collocated Simple LTE Example" + +The file containing the PGW/SGW canonical node name records (and A/AAAA records for the PGW/SGW nodes) for this example will be CS\_SGW\_PGW\_NODE\_DB.txt and has following content. + +``` +; Node records for the combined PGW/SGW + +gw01.nodes +; IN NAPTR order pref. flag service regexp replacement +; IN NAPTR 200 999 "a" "x-3gpp-pgw:x-s5-gtp+ue-1.10.20:x-s8-gtp+ue-1.10.20" "" +topoff.vip1.gw01.nodes ) +; IN NAPTR 400 999 "a" "x-3gpp-pgw:x-s8-pmip+ue-1.10.20" "" +topoff.vip2.gw01.nodes +; IN NAPTR 500 999 "a" "x-3gpp-pgw:x-gn+ue-1.10.20:x-gp+ue-1.10.20" "" +topoff.vip3.gw01.nodes +; The operator does not support Gn/Gp so those records are commented out +; +; Above are PGW records. + +; Following are SGW records +; IN NAPTR 100 999 "a" "x-3gpp-sgw:x-s11+ue-1.10.20" "" topoff.eth1.gw01.nodes +; IN NAPTR 300 999 "a" "x-3gpp-sgw:x-s5-gtp+ue-1.10.20:x-s8-gtp+ue-1.10.20" "" +topoff.eth4.gw01.nodes +; IN NAPTR 600 999 "a" "x-3gpp-sgw:x-s8-pmip+ue-1.10.20" "" topoff.eth9.gw01.nodes +; IN NAPTR 700 999 "a" "x-3gpp-sgw:x-s4+ue-1.10.20" "" topoff.eth6.gw01.nodes +; IN NAPTR 710 999 "a" "x-3gpp-sgw:x-s12+ue-1.10.20" "" topoff.eth6.gw01.nodes +; IN NAPTR 800 999 "a" "x-3gpp-sgw:x-gn+ue-1.10.20:x-gp+ue-1.10.20" "" +topoff.eth8.gw01.nodes +; The records related to the non supported interfaces are commented out +; +; Same record for the other combined PGW/SGW +; As gw21 does not support any particular UE usage type, so no changes in the existing records + +gw21.nodes +; IN NAPTR order pref. flag service regexp replacement +; IN NAPTR 200 999 "a" "x-3gpp-pgw:x-s5-gtp:x-s8-gtp" "" topoff.vip1.gw21.nodes ) +; IN NAPTR 400 999 "a" "x-3gpp-pgw:x-s8-pmip" "" topoff.vip2.gw21.nodes +; IN NAPTR 500 999 "a" "x-3gpp-pgw:x-gn:x-gp" "" topoff.vip3.gw21.nodes + +; Above are PGW records. + +; Following are SGW records +; IN NAPTR 100 999 "a" "x-3gpp-sgw:x-s11" "" topoff.eth1.gw21.nodes +; IN NAPTR 300 999 "a" "x-3gpp-sgw:x-s5-gtp:x-s8-gtp" "" topoff.eth4.gw21.nodes +; IN NAPTR 600 999 "a" "x-3gpp-sgw:x-s8-pmip" "" topoff.eth9.gw21.nodes +; IN NAPTR 700 999 "a" "x-3gpp-sgw:x-s4" "" topoff.eth6.gw21.nodes +; IN NAPTR 710 999 "a" "x-3gpp-sgw:x-s12" "" topoff.eth6.gw21.nodes +; IN NAPTR 800 999 "a" "x-3gpp-sgw:x-gn:x-gp" "" topoff.eth8.gw21.nodes + +; For A/AAAA records, see A.3.6. +``` + +### A.4.4 TAI/TAC file for DCN + +The format of the TAI/TAC name is standardized by 3GPP 23.003 [4] clause 19.4.2.3 and is of form tac-lb.tac-hb.tac.epc.mnc.mcc.3gppnetwork.org and service names are in 3GPP 23.003 [4] clause 19.4.3 with +ue- appended to the 'app-protocol' name. + +The file containing the TAI/TAC records for this example will be SIMPLE\_TAI\_DB.txt and has following content. + +``` +; All TAC codes for one region +; MME pool represented by mmegi8001 and mmegi8002 are for DCN user and non DCN user respectively. +*.tac-hb01.tac +( +; IN NAPTR order pref. flag service regexp replacement +; IN NAPTR 100 999 "a" "x-3gpp-sgw:x-s5-gtp+ue-1.10.20:x-s8-gtp+ue-1.10.20" "" +topoff.eth4.gw01.nodes ) +IN NAPTR 200 999 "a" "x-3gpp-sgw:x-s5-gtp:x-s8-gtp" "" topoff.eth4.gw21.nodes +IN NAPTR 300 999 "a" "x-3gpp-sgw:x-s8-pmip+ue-1.10.20" "" topoff.eth9.gw01.nodes +IN NAPTR 400 999 "a" "x-3gpp-sgw:x-s8-pmip" "" topoff.eth9.gw21.nodes +; The operator uses PGW01 for UE usage type of 1,10,20 and PGW21 for non DCN user. +; Above records are needed for SGW selection in initial attach of a UE (or TAU or handover attach) +; +IN NAPTR 500 999 "a" "x-3gpp-mme:x-s10+ue-1.10.20" "" topoff.eth1.mmec01.mmegi8001.mme +IN NAPTR 600 999 "a" "x-3gpp-mme:x-s10+ue-1.10.20" "" topoff.eth1.mmec02.mmegi8001.mme +IN NAPTR 700 999 "a" "x-3gpp-mme:x-s10" "" topoff.eth1.mmec03.mmegi8002.mme +IN NAPTR 800 999 "a" "x-3gpp-mme:x-s10" "" topoff.eth1.mmec04.mmegi8002.mme +; From the above records with +ue-, MMEGI information can be retrieved when +necessary. +; + +*.tac-hb40.tac +( +; IN NAPTR order pref. flag service regexp replacement +; IN NAPTR 100 999 "a" "x-3gpp-sgw:x-s5-gtp+ue-1.10.20:x-s8-gtp+ue-1.10.20" "" +topoff.eth4.gw01.nodes ) +IN NAPTR 200 999 "a" "x-3gpp-sgw:x-s5-gtp:x-s8-gtp" "" topoff.eth4.gw21.nodes +IN NAPTR 300 999 "a" "x-3gpp-sgw:x-s8-pmip+ue-1.10.20" "" topoff.eth9.gw01.nodes +IN NAPTR 400 999 "a" "x-3gpp-sgw:x-s8-pmip" "" topoff.eth9.gw21.nodes +; +IN NAPTR 600 999 "a" "x-3gpp-mme:x-s10+ue-1.10.20" "" topoff.eth1.mmec01.mmegi8001.mme +IN NAPTR 500 999 "a" "x-3gpp-mme:x-s10+ue-1.10.20" "" topoff.eth1.mmec02.mmegi8001.mme +IN NAPTR 800 999 "a" "x-3gpp-mme:x-s10" "" topoff.eth1.mmec03.mmegi8002.mme +IN NAPTR 700 999 "a" "x-3gpp-mme:x-s10" "" topoff.eth1.mmec04.mmegi8002.mme +; From the above records with +ue-, MMEGI information can be retrieved when +necessary. +; +``` + +# --- Annex B (Normative): DNS procedures clarifications + +## B.1 DNS RFC procedures general clarifications + +This clause clarifies DNS resolver use of the S-NAPTR procedures in EPC core network nodes. + +NOTE: The only EPC core network nodes identified explicitly at this time that employ S-NAPTR procedures are the MME and Release 8 SGSN. + +DNS resolvers in EPC core network nodes shall support recursive queries and responses over UDP transport as specified in IETF RFC 1035 [3]. The EPC core network nodes may assume the existence of a local caching DNS server (see GSMA PRD IR.67 [5]) and hence may not need to do iterative queries as specified in IETF RFC 1035 [3]. However, the final deployment decision of local caching DNS servers is up to the operators. It is recommended that the EPC core network nodes support DNS queries and responses over TCP transport up to the 65535 byte maximum. Support of IETF RFC 2671 [13] (EDNS0) is recommended, in order to allow DNS response packets sizes over 512 octets when using UDP transport. + +It is recommended that resolvers in EPC core network nodes cache frequently used DNS queries in order to lower load on DNS infrastructure. + +EPC core network nodes shall support SRV records as specified in IETF RFC 2782 [8]. However, in the 3GPP scope the ordering of SRV records of the same priority SHALL use the algorithm described in IETF RFC 2782 [8] page 4 instead of the the "SHOULD" requirement in the IETF RFC. This is a 3GPP specific requirement to strengthen the described algorithm and actually allow predictable behavior of the IETF RFC 2782 [8] based load balancing. + +## --- B.2 DNS procedures 3GPP clarifications on S-NAPTR + +IETF RFC 3958 [9] S-NAPTR procedures are unmodified with an exception of the following clarifications on the topological closeness and multi-protocol support: + +- 1) For topological closeness the "topon" label matching of clause 4.3.2 of the present document takes precedence over NAPTR ordering but NAPTR ordering is still used when matching label lengths are equal. Therefore, a full list of "candidate" records is needed as sketched in Appendix A.2 of IETF RFC 3958 [9], which in turn requires "backtracking" as described by IETF RFC 3958 [9] clause 2.2.4. When collocation is to be considered applicable in a procedure it takes precedence in ordering over both "topon" and NAPTR ordering regardless of the value of the "topon|topoff" label. +- 2) IETF RFC 3958 [9] has an ambiguity for S-NAPTR with multiple protocols in last paragraph of clause 2.2.5 "It MAY choose to run simultaneous DDDS resolutions for more than one protocol, in which case the requirements above apply for each protocol independently. That is, do not switch protocols mid- resolution." The term "simultaneous DDDS resolutions" and "apply for each protocol independently" are not defined and can have different meanings. To resolve that ambiguity in S-NAPTR, the present document formally defines "Service description meeting the client requirement" from IETF RFC 3402 [14] clause 3.3 step 4 as a NAPTR record with one or more of the 3GPP desired service and protocol field pair(s) and such that all ancestor NAPTR records in the current path to this point also include the identified service and protocol in the DDDS procedure. The present document uses that as the definition of "simultaneous DDDS resolutions". See clause C.1 for more practical information on this point. +- 3) Strict ordering within S-NAPTR is obtained from the NAPTR order value as required in IETF RFC 3402 [14] and IETF RFC 3958 [8]. The value of (65535- NAPTR preference) shall be used as a statistical weight the same way the SRV weight is used on page 4 of IETF RFC 2782 [8] for SRV records. + +Items 1) , 2) and 3) impact the ordering of DNS records in which they are returned by the S-NAPTR procedure. Items 1) and 2) also involve areas where the IETF RFC 3958 [9] only provides a sketch of the procedures needed and implicitly relies on IETF RFC 3402 [14] for details. To clarify these points as well as to guide implementations informative pseudo-code is provided in clauses C.1, C.2 and C.3. Item 3) allows an operators to load balance within one + +NAPTR record set without employing SRV records giving a simpler DNS provisioning and potentially reducing the number of DNS queries. + +## B.3 DNS procedures 3GPP clarifications for Dedicated Core Networks + +When the app-protocol as input to the S-NAPTR procedure has the substring with at least +ue included, then any app-protocol returned from DNS shall be considered to match as follows. The characters following the + character follows the ABNF grammar as follows. + +``` +"ue-" (USAGENUM)*( "." USAGENUM) +USAGENUM = 1*3(DIGIT) +DIGIT = %x30-39; 0-9 +``` + +A record with any USAGENUM matching the input type value shall be considered as matching. As an example, x-s10+ue-8 as S-NAPTR input shall match a record with x-s10+ue-3.8.10.38, but shall not match a record with x-s10+ue-3.10.38. + +## B.4 DNS procedures 3GPP clarifications for Network Capability + +When the app-protocol as input to the S-NAPTR procedure has the substring with at least +nc included, then any app-protocol returned from DNS shall be considered to match as follows. The characters following the +nc follows the ABNF grammar as follows. + +``` +"nc-" (NETCAP)*( "." NETCAP) +NETCAP = 1*5(DIGIT / ALPHA) +DIGIT = %x30-39; 0-9 +ALPHA = %x41-5A / %x61-7A; A-Z / a-z +``` + +A record with any NETCAP matching the input value shall be considered as matching. As an example, x-s5-gtp+nc-nr as S-NAPTR input shall match a record with x-s5-gtp+nc-nr.5gs, but shall not match a record with x-s5-gtp+nc-nrs. + +# Annex C (Informative): DNS Pseudo-Code + +## C.1 S-NAPTR procedure base pseudo-code + +The primary purpose of clause C.1 is to show practically any differences that are normatively documented in clause B.2. The changes to the IETF RFC 3958 [9] pseudo-code make this much clearer and self-contained than the normative text from clause B.2. + +The pseudo-code immediately following is the pseudo-code from IETF RFC 3958 [9] Appendix A.1 modified to incorporate the clarifications from clause B.2. + +``` +target = [initial domain] +; Next line is changed from Appendix A.1 of RFC 3958 +usable-service-protocol-set = [initial desired service and protocol pairs] + +naptr-done = false + +while (not naptr-done) +``` + +``` + +{ + NAPTR-RRset = [DNSlookup of NAPTR RRs for target] +; Next two lines are changed from Appendix A.1 of RFC 3958 + NAPTR weight := 65535 - NAPTR PREF for each RR + [sort NAPTR by ORDER, and by statistical NAPTR weight within each ORDER] + rr-done = false + cur-rr = [first NAPTR RR] + + while (not rr-done) +; Next three lines are changed from Appendix A.1 of RFC 3958 + compatable-service-protocol-set = [ [usable-service-protocol-set] set interclause with + [SERVICE field of cur-rr] ] + if ([compatable-service-protocol-set] is not empty) + rr-done = true + target= [REPLACEMENT target of NAPTR RR] +; Next line is changed from Appendix A.1 of RFC 3958 + usable-service-protocol-set = [compatable-service-protocol-set] + else + cur-rr = [next rr in list] + + if (not empty [FLAG in cur-rr]) + naptr-done = true +} + +port = -1 + +if ([FLAG in cur-rr is "S"]) +{ + SRV-RRset = [DNSlookup of SRV RRs for target] +; Next line is changed from Appendix A.1 + [Sort SRV RRset using the algorithm described on page 4 of IETF RFC 2782 [8]] + target = [target of first RR of SRV-RRset] + port = [port in first RR of SRV-RRset] +} + +; now, whether it was an "S" or an "A" in the NAPTR, we +; have the target for an A record lookup +; Remaining lines are changed from Appendix A.1 of RFC 3958 +; or AAAA record lookup + +IPv4_hosts = [DNSlookup of A RRs for target] +IPv6_hosts = [DNSlookup of AAAA RRs for target] +randomized order of IPv4_hosts and IPv6_hosts +hostname = [target] +return (hostname, usable-service-protocol-set, IPv4_hosts, IPv6_hosts, port) + +``` + +The significant differences in the above Pseudo-Code and the IETF RFC 3958 [9] Pseudo-Code are : + +- A) [Sort SRV RRset using the algorithm described on page 4 of IETF RFC 2782 [8]] which was changed from [sort SRV-RRset based on PREF] + The Pseudo-Code in IETF RFC 3958 [9] simply has an error. There isn't even a PREF in a SRV record. Again see page 4 of IETF RFC 2782 [8] for the proper procedure. + The NAPTR weight is defined to be 65535 - NAPTR preference and is handled analogously to the SRV case. +- B) IETF RFC 3958 [9] Appendix A.1 starts with "Assuming the client supports 1 protocol for a particular application" so the pseudo-code obviously was designed for one protocol at a time. The lines with usable-service-protocol-set and compatable-service-protocol-set above are the most important change to support multiple service/protocol combinations and are really the primary reason for providing the above Pseudo-Code. + +There are two possible ways to interpret the last paragraph of clause 2.2.5 of IETF RFC 3958 [9] when a list of multiple services/protocols is desired. One is the above interpretation using "set interclause" which allows multiple services/protocols. The other is to run the above procedure for one service and protocol at a time from the "desired service\_ and\_protocol\_set" and get a separate list for each service and protocol. In both approaches the relative ordering within a particular service and protocol is identical. If the proper interpretation of IETF RFC 3958 [9] is one service and protocol at a time, then the IETF RFC 3958 [9] does not define order between different service or protocols. Thus 3GPP is free to order between different 3GPP service and protocol types so long as the order within a service and protocol is + +respected. The above method does respect the order within a service and protocol therefore it is valid in either interpretation of clause 2.2.5 of IETF RFC 3958 [9] and also valid in IETF RFC 3402 [14]. + +The remaining changes in Pseudo-Code above are minor and mostly intended to show that the S-NAPTR procedure logically outputs following: + +(hostname, usable-service-protocol-set, IPv4\_hosts, IPv6\_hosts, port) + +where the returned hostname is the FQDN of the topologically aware node name with topon/topoff and interface information. + +NOTE: Lookup of the A and AAAA records to get the IPv4 and IPv6 addresses may be deferred until they are needed to contact a selected server as an optional optimization. + +In the 3GPP scope, a full implementation of RFC 3958 SHALL implement "backtracking" as described by IETF RFC 3958 [9] clause 2.2.4 as required in clause B.2. + +For simplicity of the presentation in this Annex we assume a full IETF RFC 3958 [9] implementation with a call back interface as described in Appendix A.2 of the IETF RFC 3958 [9]. + +``` +procedure S_NAPTR_to_callback(targetFQDN, + desired_service_and_protocol_set, + call_back_function) +``` + +where the call\_back\_function has interface + +``` +call_back_function (hostname, usable_service_and_protocol_set, port, IPv4_list, IPv6_list) +``` + +The call\_back\_function returns "stop" if it does not want more records otherwise it returns "looking" and will be called with the next record. + +## C.2 S-NAPTR procedure - no topon + +If topological closeness is not stated as specifically applicable to a procedure, or all node names are prefixed with "topoff", and if collocation is stated as not applicable to a procedure, then the first interface that can be successfully connected to would be sufficient to be returned from the S-NAPTR procedure. The following pseudo-code shows how the procedure works. + +``` +/* + * The Callback function called from the S-NAPTR procedure + * for each FQDN the S-NAPTR procedure finds.. + */ +procedure try_to_connect (hostname, service_and_protocol_set, port, IP4_list, IP6_list) + Begin procedure + // Comment does procedure as outlined in C.1 + Use 3GPP procedures to try to connect in turn to all combinations + of the service/protocols and IP addresses provided in the input. + Upon first success return(stop); + If all fail return(looking); + End procedure; +}; + +/* + * The S-NAPTR procedure follows + */ + +procedure connect_first_match (targetFQDN, desired_protocol_set) + Begin procedure + status:=S_NAPTR_to_callback(targetFQDN, + desired_service_and_protocol_set , + try_to_connect); + if status equals looking return(failure) else return(success); + End procedure; +``` + +## C.3 S-NAPTR procedure candidate list + +The following procedure will get the complete candidate list. This is the "sorted list of matches" described in Appendix A.2 of IETF RFC 3958 [9]. This is used for an exhaustive search of all matches. + +If the "topon" feature is specifically applicable to find "close" nodes, or collocation is applicable, then the simple approach of getting the first match as described in clause C.2 cannot be used. The S-NAPTR must be performed by exhaustive searching for all matching records since the best match by "topon" node name can be any record independent of S-NAPTR record ordering. + +``` + +/* + * The Callback function called by the S-NAPTR procedure for + * each found match.. + */ + +procedure private_store_candidate_list (hostname, service_and_protocol_set, port, IP4_list, IP6_list) + Begin procedure + increment snaptr_output_order; + create structure with fields + (hostname, service_and_protocol_set, port, IP4_list, IP6_list, snaptr_output_order, List_Name) + add structure to end of candidate_list; + return(looking); + End procedure; + +/* + * The procedure to find all candidate nodes. + */ + +procedure get_candidate_list (targetFQDN, desired_service_and_protocol_set, List_Name) + Begin procedure + candidate_list:= empty; + snaptr_output_order:=0; + + /* + * The S-NAPTR resolving starts here. + */ + status:=S_NAPTR_to_callback(targetFQDN, + desired_service_and_protocol_set , + private_store_candidate_list); + + return(candidate_list); + End procedure; + +``` + +The procedure includes the NAPTR output ordering explicitly as a field with each record which is important in the context of "topon" matches and checks for collocated nodes. + +## C.4 S-NAPTR procedure pseudo-code with topon + +Collocation, when stated as specifically applicable in a procedure, takes precedence over other criteria such as topological ordering or S-NAPTR ordering. Topological ordering, when stated as specifically applicable in a procedure, takes precedence over S-NAPTR ordering. However, S-NAPTR ordering is used for ordering nodes with equivalent topological distances. Pseudo code below is informative and shows how to implement the ordering of record selection. See clause 4.3.2 for normative text. + +Assume two distinct types of nodes "A" and "B" are being checked for closeness and the best record pair is needed. First step, which is documented in each case in the main text of this document is to get two candidate lists using a procedure such as that outlined in clause C.3. + +``` + +candidate_list_A:= get_candidates (targetFQDN_A, desired_service_and_protocol_set_A, "A"); +candidate_list_B:= get_candidates (targetFQDN_B, desired_service_and_protocol_set_B, "B"); + +``` + +As an example take the selection of a PGW and SGW by an MME during a UE initial attach procedure. Both a PGW and SGW need to be selected and if "topon" is used in both lists the selected pair is to be as close as possible (collocated being the closest). + +Sometimes one list in the procedure is not found by DNS (or was found previously) because the node was already selected. In that case, one of the candidate lists can be just one node. + +For example, an UE with an existing PDN connection adds a new PDN connection to a different APN, which may result in a different PGW but needs to continue using the current SGW. Here one of the two candidate lists would just be the data for the current SGW node (i.e., its node name and whether it supports GTPv2 and/or PMIPv6 for S5/S8). + +The following pseudo-code illustrates topological matching with full ordering. + +``` + +procedure topo_matching (candidate_list_A, candidate_list_B, topology_check, colocation_check) // +Comment: topology_check and colocation_check are booleans indicating if those checks are done + Begin procedure + paired_sets_list:=empty; + if (colocation_check) + Begin if + total_list:= candidate_list_A appended with candidate_list B; + // Comment: Below canonical_node_name is the hostname with first two labels removed + Foreach unique canonical_node_name from total_list do + Begin foreach + Foreach service and protocol do + Begin foreach + full_match_list:= get all records from total_list with service and protocol + and canonical_node name + If there is at least one "A" record and one "B" record in full_match_list then + Begin If + degree:=256; + suffix:=canonical_node_name; + create structure with fields + (degree, suffix, service_and_protocol, full_match_list) + add that structure to paired_sets_list + End If + End foreach + End foreach + End foreach + End foreach + End if; + if (topology_check) + Begin if + max_labels:=( maximum number of DNS labels in total_list)- 2 + else + max_labels =0; + End If; + + from number_labels_to_match:= max_labels down to 0 do + Begin do + if number_labels_to_match equals 0 then + Begin if + total_list:= candidate_list_A appended with candidate_list B + else + total_list:= get all records from candidate_list_A and candidate_list_B + with "topon" as first label and hostname has at least + (number_labels_to_match+2) labels + // Comment: Add 2 since the first two labels are not part of the node name + End If; + + // Comment: Below suffix is a hostname chopped off to include only the last number_labels_to_match + Foreach unique suffix from total_list do + Begin foreach + Foreach service and protocol do + Begin foreach + full_match_list:= get all records from total_list with service and protocol + and suffix contained in end of the hostname + If there is at least one "A" record and one "B" record in full_match_list then + Begin If + degree:=number_labels + create structure with fields + (degree, suffix, service_and_protocol, full_match_list) + add that structure to paired_sets_list + End If + End foreach + End foreach + End foreach + End foreach + End do + sort paired_sets by degree + return (paired_sets_list) + End Procedure; + +``` + +NOTE 1: Matching collocated nodes get a degree of 256, which is above any normal match. Also the above procedure is specific to this document and is not a part of S-NAPTR. + +NOTE 2: Order from S-NAPTR is from one S-NAPTR procedure. There is no meaningful order obtained from S-NAPTR between records from two different S-NAPTR procedures. So one node type will be selected "logically first" based on other criteria outside S-NAPTR information. + +The above procedure simply creates a list of records which are sorted by decreasing degree of matching in DNS labels. It also gives the list of paired nodes with the same suffix and compatible service which is needed by the 3GPP application. + +Since highest degree is preferred over S-NAPTR ordering with "topon" labels the selection is done by degree starting with the highest degree obtaining only the possible "A" and "B" nodes at that degree. A sublist of the paired\_sets\_list containing the highest degree is taken from paired\_sets\_list denoted as degree\_sublist. Assume the "A" node is to be selected "logically first". Sort the "A" parts of degree\_sublist in increasing "snaptr\_output\_order". For the records in that order try to connect to the node with the service and protocol in the record using 3GPP procedures. On failure proceed with the next record. When that degree\_sublist is exhausted then degree-1 is tried and so on until an "A" node is selected. Once an "A" node is chosen, the procedure has also a selected degree, suffix and service. + +NOTE 3: The remaining part of this procedure is not needed if the "B" node was already pre-selected outside the present procedure. + +Taking the degree\_sublist used to select the "A" node create a new sublist from only records with the same service, same protocol and suffix. Remove the "A" node records from that sublist. Sort this new sublist by increasing "snaptr\_output\_order" (see clause C.3). Using the records in that order try to connect to the "B" nodes with the service and protocol in the record. On a failure proceed with the next record. When that list is exhausted the procedure continues in next paragraph. + +NOTE 4: The suffix of the "A" node that was selected influences which "B" nodes are closest to it. We can't easily and simply reuse the above structure for that reason and it is easier to "reset" the procedure. + +A new candidate\_list\_A is created consisting only of the selected "A" node A and service\_and\_protocol. The procedure "topo\_matching" is run again giving a new paired\_sets\_list. The "A" node records are removed from the new paired\_sets\_list leaving only "B" nodes. Sort the records in paired\_sets\_list in decreasing order of degree and within degree in increasing "snaptr\_output\_order" (see clause C.3). Using the records in that order try to connect to the "B" nodes with the service in the record. On failure go to next record. + +NOTE 5: Failing to actually contact a node should result in the failing node(s) to be removed from consideration for a period of time. Such removal is not detailed above. Also a reasonable implementation would give up after some maximum number of failed attempts. + +# Annex D (Informative): SGSN examples + +## D.1 Introduction + +This annex includes examples of the DNS provisioning needed for an SGSN discovery and selection procedures. Examples are not exhaustive either in scope or in content but are intended to be sufficient to illustrate the general techniques and some of the more important use cases. + +## D.2 Preconditions + +Provisions of annex A.2 apply also here. + +## D.3 SGSN file + +A NAPTR record is required to be provisioned under the NRI-RAI FQDN (see clause 4.3.3.5 of this TS). The format of the NRI-RAI FQDN is nri-sgsn.rac.lac.rac as defined in clause 19.4.2.6 of 3GPP TS 23.003 [4]. + +The nri-sgsn.rac.lac.rac is also the natural place for the SGSN canonical node record set. For this example we place the SGSN canonical node records and the required record for the lookup at the same location both for simplicity and better DNS caching. + +For this example we have two SGSNs with NRI codes of 1 and 2 respectively and both in the same SGSN pool (LAC = 1000 hexadecimal and RAC = 0003 hexadecimal). + +``` +; +; This is the P-TMSI and RAI related record and the SGSN node record +; The operator has decided to use the 3GPP name as the canonical node name of the SGSN +; rather than having two records (the 3GPP one and an operator defined value) +; +nri-sgsn01.rac0003.lac1001.rac +; IN NAPTR order pref. flag service regexp replacement + + IN NAPTR 200 999 "a" "x-3gpp-sgsn:x-s4" "" topoff.eth1.nri-sgsn01.rac0003.lac1001.rac + IN NAPTR 200 999 "a" "x-3gpp-sgsn:x-s3" "" topoff.eth2.nri-sgsn01.rac0003.lac1001.rac + IN NAPTR 300 999 "a" "x-3gpp-sgsn:x-gn" "" topoff.eth3.nri-sgsn01.rac0003.lac1001.rac + +; +; Reminder: Canonical node name records must be complete. +; In most cases the interface type (S3 etc) is functionally determined so the NAPTR order is rarely +; used in this record set. The S3 is preferred over over Gn. +; +; Of course if the SGSN had multiple S3 interfaces +; the operator could provision more than one S3 record with different orders +; perhaps to select S3 IPv6 over S3 IPv4 + +; We have the same type of records for the other SGSN (same comments would apply) + +; +nri-sgsn02.rac0003.lac1001.rac +; IN NAPTR order pref. flag service regexp replacement + + IN NAPTR 200 999 "a" "x-3gpp-sgsn:x-s4" "" topoff.eth1.nri-sgsn02.rac0003.lac1001.rac + IN NAPTR 200 999 "a" "x-3gpp-sgsn:x-s3" "" topoff.eth2.nri-sgsn02.rac0003.lac1001.rac + IN NAPTR 300 999 "a" "x-3gpp-sgsn:x-gn" "" topoff.eth3.nri-sgsn02.rac0003.lac1001.rac + +; +; All SGSN IP addresses for both SGSNs +; +topoff.eth1.nri-sgsn01.rac0003.lac1001.rac IN A 192.0.2.11 + IN A 192.0.2.12 + IN AAAA 2001:db8:0:0:0:0:0:0 + IN AAAA 2001:db8:0:1:0:0:0:0 +topoff.eth2.nri-sgsn01.rac0003.lac1001.rac IN A 192.0.2.13 + IN A 192.0.2.14 + IN AAAA 2001:db8:0:2:0:0:0:0 +``` + +``` + + IN AAAA 2001:db8:0:3:0:0:0:0 +topoff.eth3.nri-sgsn01.rac0003.lac1001.rac IN A 192.0.2.15 + IN A 192.0.2.16 + IN AAAA 2001:db8:0:4:0:0:0:0 + IN AAAA 2001:db8:0:5:0:0:0:0 +topoff.eth1.nri-sgsn02.rac0003.lac1001.rac IN A 192.0.2.17 + IN A 192.0.2.18 + IN AAAA 2001:db8:0:6:0:0:0:0 + IN AAAA 2001:db8:0:7:0:0:0:0 +topoff.eth2.nri-sgsn02.rac0003.lac1001.rac IN A 192.0.2.19 + IN A 192.0.2.20 + IN AAAA 2001:db8:0:8:0:0:0:0 + IN AAAA 2001:db8:0:9:0:0:0:0 +topoff.eth3.nri-sgsn02.rac0003.lac1001.rac IN A 192.0.2.21 + IN A 192.0.2.22 + IN AAAA 2001:db8:0:10:0:0:0:0 + IN AAAA 2001:db8:0:11:0:0:0:0 + +; end of file + +``` + +The partially qualified SGSN host names are topoff.eth1.nri-sgsn01.rac0003.lac1001.rac and topoff.eth1.nri-sgsn02.rac0003.lac1001.rac, and similar. + +The fully qualified SGSN node names are the relatively long + +nri-sgsn01.rac0003.lac1001.rac.epc.mnc990.mcc311.3gppnetwork.org. + +and + +nri-sgsn02.rac0003.lac1001.rac.epc.mnc990.mcc311.3gppnetwork.org. + +which are obtained by appending the value of \$ORIGIN to the partially qualified SGSN node names. As stated before we will use the partially qualified names in this Annex to avoid this visual clutter and for typographical reasons. + +## D.4 Null-NRI/SGSN Group ID file for DCN + +A NAPTR record is required to be provisioned under the RAI FQDN (see clause 5.8.3). The format of the RAI FQDN is rac.lac.rac as defined in clause 19.4.2.5 of 3GPP TS 23.003 [4]. + +For this example we have two SGSN pools represented by SGSN Group ID (sgsngi=0001) and Null-NRI (null-nri=0005). Each pool has two SGSNs with NRI code of 1, 2 and 3, 4 respectively. + +``` + +; +rac0003.lac1001.rac +; IN NAPTR order pref. flag service regexp replacement + + IN NAPTR 100 999 "a" "x-3gpp-sgsn:x-gn+ue-1.10.20" "" topoff.eth1.nri- +sgsn0001.sgsngi0001.rac0003.lac1001.rac + IN NAPTR 200 999 "a" "x-3gpp-sgsn:x-s16+ue-1.10.20" "" topoff.eth3.nri- +sgsn0002.sgsngi0001.rac0003.lac1001.rac + IN NAPTR 100 999 "a" "x-3gpp-sgsn:x-gn+ue-2.5" "" topoff.eth1.nri-sgsn0003.null- +nri0005.rac0003.lac1001.rac + IN NAPTR 200 999 "a" "x-3gpp-sgsn:x-s16+ue-2.5" "" topoff.eth3.nri-sgsn0004.null- +nri0005.rac0003.lac1001.rac + +; +;From above records, Null-NRI and SGSN Group ID information can be retrieved when necessary. + +``` + +# Annex E (Informative): SGW/PGW selection examples using GTP-C load control + +## E.1 PGW selection using GTP-C load control at node level + +This example illustrates the principles of the SGW or PGW selection specified in clause 4A.2, with GTP-C load control supported and enabled at node level. + +The example assumes that the procedures specified in this document have 3 candidate PGWs with the same relative order, (e.g. with the same topological order) and assume that the following weights are received from the DNS and "Load Metric" reported via GTP-C signalling: + +PGW1: DNS-weight-factor = 20, Load-metric = 10% + +PGW2: DNS-weight-factor = 20, Load-metric = 20% + +PGW3: DNS-weight-factor = 60, Load-metric= 30% + +Based on the above, the selecting node calculates the effective available load for each candidate PGW: + +PGW1-effective-available-load = (100 – 10)% X 20 = 18 + +PGW2-effective-available-load = (100 – 20)% X 20 = 16 + +PGW3-effective-available-load = (100 – 30)% X 60 = 42 + +The selecting node then calculates the relative available load of each candidate PGW (rounding-off to nearest integer value): + +PGW1-relative-available-load = 18 / (18 + 16 + 42) = ~ 24% + +PGW2-relative-available-load = 16 / (18 + 16 + 42) = ~ 21% + +PGW3-relative-available-load = 42 / (18 + 16 + 42) = ~ 55% + +Out of the total new session requests, the node selects the PGW1, PGW2 and PGW3 for 24%, 21% and 55% respectively, e.g. per 100 new sessions requests, the PGW1 is selected for 24 sessions, PGW2 for 21 sessions and PGW3 for the remaining 55 new sessions. + +## E.2 PGW selection using GTP-C load control at APN level + +### E. 2.1 PGW selection when APN load control information is available for each candidate PGW + +This example illustrates the principles of the PGW selection specified in clause 4A.3, with GTP-C load control supported and enabled at node level and APN level. + +The example assumes that the procedures specified in this document have 3 candidate PGWs with the same relative order, (e.g. with the same topological order) and assume that the following weights are received from the DNS and APN load control information reported via GTP-C signalling: + +PGW1: DNS-weight-factor = 20, APN1-Load-metric = 60%, APN1-relative-capacity = 50% + +PGW2: DNS-weight-factor = 20, APN1-Load-metric = 50%, APN1-relative-capacity = 20% + +PGW3: DNS-weight-factor = 60, APN1-Load-metric= 50%, APN1-relative-capacity = 10% + +Based on the above, the APN1-effective-available-load is calculated as follows: + +PGW1-APN1-effective-available-load = (100 – 60)% X 50% X 20 = 4 + +$$\text{PGW2-APN1-effective-available-load} = (100 - 50)\% \times 20\% \times 20 = 2$$ + +$$\text{PGW3-APN1-effective-available-load} = (100 - 50)\% \times 10\% \times 60 = 3$$ + +Then the APN1-relative-available-load is calculated as below (by rounding-off to nearest integer value): + +$$\text{PGW1-APN1-relative-available-load} = 4 / (4 + 2 + 3) = \sim 45\%$$ + +$$\text{PGW2-APN1-relative-available-load} = 2 / (4 + 2 + 3) = \sim 22\%$$ + +$$\text{PGW3-APN1-relative-available-load} = 3 / (4 + 2 + 3) = \sim 33\%$$ + +Out of the total new session requests for APN1, the PGW1 is selected for 45%, PGW2 for 22% and PGW3 for 33%, e.g. per 100 new sessions requests for APN1, the PGW1 is selected for 45 sessions, PGW2 for 22 sessions and PGW3 for 33 sessions. + +### E.2.2 PGW selection when APN load control information is not available for each candidate PGW + +This example illustrates the principles of the PGW selection specified in clause 4A.3, with GTP-C load control supported and enabled at node level and APN level. + +The example assumes that the procedures specified in this document have 3 candidate PGWs with the same relative order, (e.g. with the same topological order) and assume that the following weights are received from the DNS and APN load control information reported via GTP-C signalling; it is assumed in particular that PGW3 did only report APN load control information for the APN2. + +$$\text{PGW1: DNS-weight-factor} = 20, \text{ APN1-Load-metric} = 60\%, \text{ APN1-relative-capacity} = 50\%$$ + +$$\text{PGW2: DNS-weight-factor} = 20, \text{ APN1-Load-metric} = 50\%, \text{ APN1-relative-capacity} = 20\%$$ + +$$\text{PGW3: DNS-weight-factor} = 60, \text{ APN2-Load-metric} = 50\%, \text{ APN2-relative-capacity} = 30\%, \text{ PGW3-Load-Metric} = 40\%$$ + +Based on the above, the APN1-effective-available-load for the PGW3 is calculated assuming the following: + +$$\text{PGW3-APN1-relative-capacity} = 100\% - 30\% = 70\%$$ + +$$\text{PGW3-APN1-load-metric} = \{40\% - (50\% \times 30\%)\} / \{(100\% - 30\%)\} = \{40\% - 15\%\} / \{70\%\} = \sim 36\%$$ + +# Annex F (Informative): Examples for AMF Discovery by 5G AN + +## F.1 Introduction + +This annex provides examples of DNS provisioning for AMF Discovery by 5G AN. + +## F.2 Preconditions + +See annex A.2. + +## F.3 Example of an AMF Region with 2 AMF Sets + +### F.3.1 Master file + +The master file for this example has following content. + +``` +$ORIGIN 5gc.mnc990.mcc311.3gppnetwork.org. +``` + +``` +; +$TTL 600 ; 10 minutes - this directive is defined in IETF RFC 2308 not IETF RFC 1035 +; +$INCLUDE SOA_DB.txt +; +$INCLUDE AMFSET_DB.txt +; +; End of file +``` + +### F.3.2 SOA and NS records + +See Annex A.3.3. + +### F.3.3 AMF Set file + +The file containing the AMF Set records for this example will be AMFSET\_DB.txt and has following NAPTR record content. + +In this example, we have two AMF Sets 1 and 2, in AMF Region 48 (hexadecimal), with 2 AMFs available in each AMF Set. + +``` +; AMF Set 1 of AMF Region 48 + +set001.region48.amfset +; IN NAPTR order pref. flag service regexp replacement + IN NAPTR 100 999 "a" "x-3gpp-amf:x-n2" "" topoff.amf11.amf + IN NAPTR 100 999 "a" "x-3gpp-amf:x-n2" "" topoff.amf12.amf + +; AMF Set 2 of AMF Region 48 +set002.region48.amfset +; IN NAPTR order pref. flag service regexp replacement + IN NAPTR 100 999 "a" "x-3gpp-amf:x-n2" "" topoff.amf21.amf + IN NAPTR 100 999 "a" "x-3gpp-amf:x-n2" "" topoff.amf22.amf + +; AMFs IP addresses +; +topoff.amf11.amf IN A 192.0.2.11 + IN A 192.0.2.12 + IN AAAA 2001:db8:0:0:0:0:0:0 + IN AAAA 2001:db8:0:1:0:0:0:0 +topoff.amf12.amf IN A 192.0.2.13 + IN A 192.0.2.14 + IN AAAA 2001:db8:0:2:0:0:0:0 + IN AAAA 2001:db8:0:3:0:0:0:0 +topoff.amf21.amf IN A 192.0.2.17 + IN A 192.0.2.18 + IN AAAA 2001:db8:0:6:0:0:0:0 + IN AAAA 2001:db8:0:7:0:0:0:0 +topoff.amf22.amf IN A 192.0.2.19 + IN A 192.0.2.110 + IN AAAA 2001:db8:0:8:0:0:0:0 + IN AAAA 2001:db8:0:9:0:0:0:0 + +; end of file +``` + +# Annex G (Informative): Change history + +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | New | +|---------|-------|-----------|------|-----|-------------------------------------------------------------------------------|--------| +| 2008-12 | CT#42 | CP-080714 | | | V2.0.0 approved in CT#42 | 8.0.0 | +| 2009-03 | CT#43 | CP-090054 | 0001 | 1 | DNS examples | 8.1.0 | +| | | | 0002 | 2 | DNS cleanup regarding topon/topoff | | +| | | | 0003 | 1 | Missing clause for node name records of SGW | | +| | | | 0004 | 1 | DNS Editorial cleanup | | +| | | | 0005 | | SGW Selection for TAU and Handover | | +| | | | 0007 | 1 | Correction to DNS procedures | | +| | | | 0008 | 2 | Clarifications to NAPTR flag usage | | +| | | | 0009 | 1 | | | +| 2009-06 | CT#44 | CP-090291 | 0010 | 1 | Home agent discovery | 8.2.0 | +| | | | 0011 | 1 | Correction for PGW selection for colocated PGW/GGSN | | +| | | | 0012 | 1 | Handling when hostnames are missing topon/topoff | | +| | | | 0013 | 1 | Release 8 SGSN clarifications | | +| 2009-06 | CT#44 | CP-090542 | 0015 | | Incorrect FQDN nodes.mnc.mcc.3gppnetwork.org | 8.3.0 | +| | | | 0017 | 3 | Failure of DNS procedures | | +| | | | 0018 | 1 | Correction about discovering and selecting a PGW and SGW | | +| 2009-12 | - | - | - | - | Update to Rel-9 version (MCC) | 9.0.0 | +| 2010-03 | CT#47 | CP-100019 | 0024 | 2 | APN-FQDN construction | 9.1.0 | +| 2010-09 | CT#49 | CP-100457 | 0027 | 1 | Construction of APN-FQDN | 9.2.0 | +| 2010-12 | CT#50 | CP-100678 | 0030 | 3 | Add missing MME/SGSN selection for the RIM procedure | 9.3.0 | +| 2010-12 | CT#50 | CP-100686 | 0029 | 1 | PGW selection by ePDG with GTP over S2b | 10.0.0 | +| | | CP-100684 | 0033 | 3 | SIPTO support in DNS | | +| | | CP-100684 | 0036 | 2 | GW selection for SIPTO based on eNodeB id | | +| | | CP-100693 | 0034 | | Correcting clause numbers in Annex A.3 | | +| | | CP-100693 | 0035 | 1 | Clarifications to DNS Based GW Selection in Roaming Cases | | +| | | CP-100693 | 0037 | 1 | Correction in Annex C | | +| 2011-03 | CT#51 | CP-110057 | 0038 | 2 | GGSN selection for SIPTO APN | 10.1.0 | +| | | CP-110057 | 0045 | 2 | GW selection based on RAI/RNC-ID/TAI/eNodeB ID | | +| | | CP-110056 | 0039 | 2 | PGW selection for LIPA | | +| | | CP-110076 | 0042 | 1 | Adding SGSN selection cases | | +| | | CP-110076 | 0044 | 2 | DNS Service for Sv | | +| | | CP-110076 | 0047 | 1 | MME selection | | +| | | CP-110088 | 0043 | 3 | DNS procedure for Relay Node OAM system discovery | | +| | | CP-110059 | 0046 | | Service parameter for the GTP based S2b | | +| 2011-06 | CT#52 | CP-110364 | 0051 | 1 | Services of a MME from MME node name | 10.2.0 | +| | | CP-110374 | 0049 | 1 | SGSN Selection | | +| 2011-07 | | | | | Editorial correction to history table. | 10.2.1 | +| 2011-09 | CT#53 | CP-110567 | 0056 | 2 | SGSN selection | 10.3.0 | +| 2012-03 | CT#55 | CP-120028 | 0058 | 1 | SGSN selection | 11.0.0 | +| | | CP-120045 | 0061 | 1 | PGW discovery for GTP based S2a | | +| 2012-06 | CT#56 | CP-120234 | 0062 | 2 | DNS procedure for CS to PS SRVCC | 11.1.0 | +| 2012-09 | CT#57 | CP-120447 | 0064 | 1 | PGW selection in eHRPD for SIPTO | 11.2.0 | +| | | CP-120457 | 0065 | 1 | SGW selection based on eNodeB ID | | +| 2013-06 | CT#60 | CP-130378 | 0067 | 1 | GWs selection for SIPTO at the local network | 12.0.0 | +| 2013-09 | CT#61 | CP-130453 | 0069 | 2 | SGW selection for SIPTO at the Local Network | 12.1.0 | +| | | CP-130462 | 0070 | 2 | GERAN Iu Mode | | +| 2013-12 | CT#62 | CP-130620 | 0071 | 1 | SGW selection for SIPTO at the Local Home Network | 12.2.0 | +| 2014-06 | CT#64 | CP-140230 | 0076 | 1 | Cleanup the pre-Release-8 DNS procedure on Release-8 SGSN | 12.3.0 | +| 2014-09 | CT#65 | CP-140505 | 0077 | 2 | SGW/PGW selection with GTP-C node level load control | 12.4.0 | +| | | CP-140505 | 0078 | 2 | PGW selection with GTP-C APN level Load Control | | +| 2014-12 | CT#66 | CP-140797 | 0079 | 3 | MME and SGSN selection by RCAF | 13.0.0 | +| 2015-06 | CT#68 | CP-150270 | 0080 | 3 | Multiple IP addresses in DNS Record | 13.1.0 | +| 2015-12 | CT#70 | CP-150781 | 0082 | 2 | DNS procedures for Decor | 13.2.0 | +| | | CP-150765 | 0083 | - | Priority ordering of SRV records | | +| 2016-03 | CT#71 | CP-160038 | 0084 | 1 | GTP-C Load Control – Mix of NAPTR records with "s" and "a" flags | 13.3.0 | +| | | CP-160022 | 0085 | 1 | Clarification on the use of UE Usage Type | | +| | | CP-160022 | 0086 | 4 | DNS procedures for Decor | | +| | | CP-160033 | 0087 | 3 | Impacts on the DNS procedures for CIoT with introduction of NB-IoT and Non-IP | | +| 2016-06 | CT#72 | CP-160224 | 0088 | 1 | MME and SGSN selection procedures for Dedicated Core Networks | 13.4.0 | +| 2016-06 | CT#72 | CP-160228 | 0089 | 2 | Clarification on the DNS impact for CIoT | 13.4.0 | +| 2016-09 | CT#73 | CP-160435 | 0090 | 1 | Use of DNS to select a GGSN handling Non-IP data | 14.0.0 | +| 2016-12 | CT#74 | CP-160680 | 0092 | 1 | Use of DéCOR for NonIP_GPRS | 14.1.0 | +| 2016-12 | CT#74 | CP-160680 | 0096 | - | GW selection by S4-SGSN for Non-IP PDN type | 14.1.0 | +| 2016-12 | CT#74 | CP-160665 | 0094 | 1 | DECOR for GPRS Core | 14.1.0 | + +| | | | | | | | +|---------|--------|-----------|------|---|----------------------------------------------------------------------------------------|--------| +| 2017-06 | CT#76 | CP-171036 | 0097 | 1 | UP function selection by DNS | 14.2.0 | +| 2017-09 | CT#77 | CP-172015 | 0099 | - | PGW selection for WLAN with deployed DCNs | 14.3.0 | +| 2017-09 | CT#77 | CP-172020 | 0100 | - | Missing CUPS stage 3 reference | 14.3.0 | +| 2017-12 | CT#78 | CP-173036 | 0104 | 4 | SGW/PGW selection for NR | 15.0.0 | +| 2018-03 | CT#79 | CP-180020 | 0107 | 1 | Correction for indicating DCNR to Combined SGW/PGW | 15.1.0 | +| 2018-06 | CT#80 | CP-181132 | 0108 | 1 | Selection of a combined PGW/SMF for interworking with 5GS | 15.2.0 | +| 2018-09 | CT#81 | CP-182067 | 0109 | - | DNS records for selecting a node with a network capability in a Dedicated Core Network | 15.3.0 | +| 2018-09 | CT#81 | CP-182084 | 0110 | 1 | EPS interworking with 5GS | 15.3.0 | +| 2018-09 | CT#81 | CP-182084 | 0111 | 1 | AMF Discovery by 5G AN | 15.3.0 | +| 2018-12 | CT#82 | CP-183092 | 0115 | 3 | Procedures to support interworking with 5GC | 15.4.0 | +| 2018-12 | CT#82 | CP-183092 | 0116 | - | Corrections to references in clause 7.2 | 15.4.0 | +| 2018-12 | CT#82 | CP-183092 | 0117 | 1 | EPS interworking with 5GS | 15.4.0 | +| 2019-03 | CT#83 | CP-190032 | 0118 | - | PGW/SMF selection by ePDG | 15.5.0 | +| 2019-03 | CT#83 | CP-190032 | 0119 | - | Incomplete references for AMF discovery and selection by MME | 15.5.0 | +| 2019-09 | CT#85 | CP-192188 | 0120 | 1 | Selection of MME_SRVCC | 16.0.0 | +| 2019-09 | CT#85 | CP-192126 | 0121 | 1 | DNS procedures to support Ethernet PDN | 16.0.0 | +| 2019-12 | CT#86 | CP-193041 | 0122 | 1 | UEs not supporting 5GC NAS with a 5GS subscription | 16.1.0 | +| 2020-03 | CT#87e | CP-200021 | 0126 | - | UCMF Selection by MMEs | 16.2.0 | +| 2020-06 | CT#88e | CP-201062 | 0127 | - | Service parameter for SGW | 16.3.0 | +| 2021-03 | CT#91e | CP-210049 | 0130 | - | DCN support for AMF discovery | 16.4.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29305/00504fc688ebcf131ccbeff94dfc9939_img.jpg b/marked/Rel-16/29_series/29305/00504fc688ebcf131ccbeff94dfc9939_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..821963aedaa82caa3d634c3b84b7be42f2da6dcb --- /dev/null +++ b/marked/Rel-16/29_series/29305/00504fc688ebcf131ccbeff94dfc9939_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5e1906c769834d1fe56cfb7f5fe9fc8255325dd3df057abdf2fd29a081d27615 +size 41991 diff --git a/marked/Rel-16/29_series/29305/04cfca33e3fc26513abe649d7474f733_img.jpg b/marked/Rel-16/29_series/29305/04cfca33e3fc26513abe649d7474f733_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..080e4f68da6de0d1f45f0241f772bf1840643d16 --- /dev/null +++ b/marked/Rel-16/29_series/29305/04cfca33e3fc26513abe649d7474f733_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:184a31a5d4db2661ed7b1570a3318d128efe6d546f3112507c2f51803690f330 +size 46975 diff --git a/marked/Rel-16/29_series/29305/0dfdff10c725fe9c332b07ade9d23a5e_img.jpg b/marked/Rel-16/29_series/29305/0dfdff10c725fe9c332b07ade9d23a5e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f960118d404b9d9ccd3145a60fb6c401d8128d03 --- /dev/null +++ b/marked/Rel-16/29_series/29305/0dfdff10c725fe9c332b07ade9d23a5e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5db1f57f79482c6dab4a1c3f3d9bf413bb83584968f846ccfb8ca28466ddd3a9 +size 39125 diff --git a/marked/Rel-16/29_series/29305/0f6e3cdce0f01d6ccceabcced508bb5b_img.jpg b/marked/Rel-16/29_series/29305/0f6e3cdce0f01d6ccceabcced508bb5b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1d4e1393e7fe73830c4a15764d328cfcfb40f1ee --- /dev/null +++ b/marked/Rel-16/29_series/29305/0f6e3cdce0f01d6ccceabcced508bb5b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5e11e5626bbcccf95aba0e0d829e6d136843c68e01feb9c67a5c2753d524f200 +size 21665 diff --git a/marked/Rel-16/29_series/29305/11f18bf0233d812ad2604f88f3385d60_img.jpg b/marked/Rel-16/29_series/29305/11f18bf0233d812ad2604f88f3385d60_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..df22b872acafbbc154109e617ac2a8e4cfb75c27 --- /dev/null +++ b/marked/Rel-16/29_series/29305/11f18bf0233d812ad2604f88f3385d60_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1ba0609ea59bab967cf7a07c8ea17403e72a99fa39a723d597ad1c849b8e8d7c +size 34699 diff --git a/marked/Rel-16/29_series/29305/1399c76ef88f22b70d05ed3f781d3c48_img.jpg b/marked/Rel-16/29_series/29305/1399c76ef88f22b70d05ed3f781d3c48_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0c43288d5b22d1589b0ed0c2535e0a0427bacd59 --- /dev/null +++ b/marked/Rel-16/29_series/29305/1399c76ef88f22b70d05ed3f781d3c48_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:86db1764f88eca67c9102a0eb96c65a09c064911325ad938b8ff5815b114d362 +size 38293 diff --git a/marked/Rel-16/29_series/29305/16152cf1d84aea10848758f51a91ff6a_img.jpg b/marked/Rel-16/29_series/29305/16152cf1d84aea10848758f51a91ff6a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..648614a8a269c93cfef582e560b9f5923d7e32e4 --- /dev/null +++ b/marked/Rel-16/29_series/29305/16152cf1d84aea10848758f51a91ff6a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6e000776fa8db5f58fbafa9007cb28d9d0408b5ad20f9a988e2b4bed41b372b0 +size 52333 diff --git a/marked/Rel-16/29_series/29305/18003425d0e8638dde4acc9c5c468c5c_img.jpg b/marked/Rel-16/29_series/29305/18003425d0e8638dde4acc9c5c468c5c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d8c10fcfb815a38e51dccc649800a8e28cff869e --- /dev/null +++ b/marked/Rel-16/29_series/29305/18003425d0e8638dde4acc9c5c468c5c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c9703324ec3c2c48189dacaee273ab3d15c49381d8aa7652fb8fed608e06e509 +size 36190 diff --git a/marked/Rel-16/29_series/29305/1b893df61c2b73b7a85e65fc1f58e203_img.jpg b/marked/Rel-16/29_series/29305/1b893df61c2b73b7a85e65fc1f58e203_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b75af7c801f11f2d543f323fe463aece022fa1d7 --- /dev/null +++ b/marked/Rel-16/29_series/29305/1b893df61c2b73b7a85e65fc1f58e203_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1c94ec0508f3c671d43f4eeee783cdf636ed1ba587a324e43d1bcd7f9f5b9edf +size 36271 diff --git a/marked/Rel-16/29_series/29305/1eadbbe42cfcac5c0023577110aec5e3_img.jpg b/marked/Rel-16/29_series/29305/1eadbbe42cfcac5c0023577110aec5e3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2063f0a5e05c7a0fa7283aa624515b780ee912f8 --- /dev/null +++ b/marked/Rel-16/29_series/29305/1eadbbe42cfcac5c0023577110aec5e3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:773f5d3709c42f9887ccb7f1242aef217338e6f6c453ee87c40010192f27c124 +size 48666 diff --git a/marked/Rel-16/29_series/29305/26d664119ad25250780f554633444e54_img.jpg b/marked/Rel-16/29_series/29305/26d664119ad25250780f554633444e54_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..39d63a901fd3c291b5258a483f7c49fabfc77743 --- /dev/null +++ b/marked/Rel-16/29_series/29305/26d664119ad25250780f554633444e54_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:df365e7defad22f794256327f228d166b2be0f0af72e869e732c41157de08a3f +size 40322 diff --git a/marked/Rel-16/29_series/29305/27b06ec9f42b5d727a2630f61a5f1861_img.jpg b/marked/Rel-16/29_series/29305/27b06ec9f42b5d727a2630f61a5f1861_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a17ec8ea37eaf0a3ad2d862e49b4e3e1d80f4465 --- /dev/null +++ b/marked/Rel-16/29_series/29305/27b06ec9f42b5d727a2630f61a5f1861_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:49e285d06d4e82492786c62847646b8fd1c2c83d435ce0298b453e0f6e5206b7 +size 19450 diff --git a/marked/Rel-16/29_series/29305/2837ffdadcdb1e5bababa56b564e56ed_img.jpg b/marked/Rel-16/29_series/29305/2837ffdadcdb1e5bababa56b564e56ed_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5891d2625d771a6e5ff47c8c4ba18ae1b28e418d --- /dev/null +++ b/marked/Rel-16/29_series/29305/2837ffdadcdb1e5bababa56b564e56ed_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:14fe4939f898382c3d22ee8350fd204f4f7042ccaca74fb21c84250447ba7a2f +size 38346 diff --git a/marked/Rel-16/29_series/29305/28d75f39a24203712ee907b32cf0bbe5_img.jpg b/marked/Rel-16/29_series/29305/28d75f39a24203712ee907b32cf0bbe5_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..20c652d67cf9b9f1e26a49105a3ff89231593247 --- /dev/null +++ b/marked/Rel-16/29_series/29305/28d75f39a24203712ee907b32cf0bbe5_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7e3c1f446e0cb30cdda3ef0e0204bab4da845aee6ec6cdee2f835427069636f8 +size 58663 diff --git a/marked/Rel-16/29_series/29305/29a9cd1cb2a960eb91dbf79aab5d8668_img.jpg b/marked/Rel-16/29_series/29305/29a9cd1cb2a960eb91dbf79aab5d8668_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e61cb83cda5e851068cada837f1bcb9767654300 --- /dev/null +++ b/marked/Rel-16/29_series/29305/29a9cd1cb2a960eb91dbf79aab5d8668_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:eacb4c1c17e9c9ceecedd6b7c63ed308b973e54e0166b2ba4f84afc2602879c4 +size 18406 diff --git a/marked/Rel-16/29_series/29305/2ae3eae1bd80a90f192f568ae246a9a6_img.jpg b/marked/Rel-16/29_series/29305/2ae3eae1bd80a90f192f568ae246a9a6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6545e52550410fda1f9b00863aa350a09bf682b8 --- /dev/null +++ b/marked/Rel-16/29_series/29305/2ae3eae1bd80a90f192f568ae246a9a6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:41cdabe46da0e2b3ffe9412070b3ee804196eee1cdc4a5a5254a89a54712eebf +size 38681 diff --git a/marked/Rel-16/29_series/29305/2eb23c2210154279f8013a1594fbcc5a_img.jpg b/marked/Rel-16/29_series/29305/2eb23c2210154279f8013a1594fbcc5a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8c44a04416dafa682fd1193e981da95252cde9dd --- /dev/null +++ b/marked/Rel-16/29_series/29305/2eb23c2210154279f8013a1594fbcc5a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0b942ebbac597688c6904cfb9152869ba0d090f7e905f485f1231e67b68f8dfa +size 30916 diff --git a/marked/Rel-16/29_series/29305/38d82ffe820e339811b396206f40a201_img.jpg b/marked/Rel-16/29_series/29305/38d82ffe820e339811b396206f40a201_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..02911c3ac622972a299e120bc59c3dabd3c0bf6e --- /dev/null +++ b/marked/Rel-16/29_series/29305/38d82ffe820e339811b396206f40a201_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4bb442c39c662ab18c030c0fc78bb060d8bb59e68352e93fb25042520bc44ce0 +size 38793 diff --git a/marked/Rel-16/29_series/29305/3ad00ce93ad9dea9ee0f47535e5355e6_img.jpg b/marked/Rel-16/29_series/29305/3ad00ce93ad9dea9ee0f47535e5355e6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ff7ae82abae0309f2d45b877de8e880a1cf2cc88 --- /dev/null +++ b/marked/Rel-16/29_series/29305/3ad00ce93ad9dea9ee0f47535e5355e6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:508efdf9ce0936220fa2c2b3012121f9cede4fa52300946a39a63b9f8d074a5b +size 63705 diff --git a/marked/Rel-16/29_series/29305/4b398c5e8c4fd656d5b7a61806400650_img.jpg b/marked/Rel-16/29_series/29305/4b398c5e8c4fd656d5b7a61806400650_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b4c5128ce173a0b884069eba6fc249b7b4a0938b --- /dev/null +++ b/marked/Rel-16/29_series/29305/4b398c5e8c4fd656d5b7a61806400650_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:614d0f0d82aaafcfbb2c4f5a1c82987bca7ea7aa81751ce669013ef5cc54a712 +size 38226 diff --git a/marked/Rel-16/29_series/29305/4bfb457b83429c217736e6d51b2f3945_img.jpg b/marked/Rel-16/29_series/29305/4bfb457b83429c217736e6d51b2f3945_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1e4b611bcecdac4a31c52dd6c85a60bd09c43133 --- /dev/null +++ b/marked/Rel-16/29_series/29305/4bfb457b83429c217736e6d51b2f3945_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5250b772a9fd4bfd2b0d93ecded5cc14dbcc8b072814d89fda85f9ac26a5a4ca +size 45024 diff --git a/marked/Rel-16/29_series/29305/4ee2de50739c96fd7bd5a38150ec9c78_img.jpg b/marked/Rel-16/29_series/29305/4ee2de50739c96fd7bd5a38150ec9c78_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..88750bc474977ffa566f4cc06000194845cba066 --- /dev/null +++ b/marked/Rel-16/29_series/29305/4ee2de50739c96fd7bd5a38150ec9c78_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6ec13a11ce8a8b1e30c6c420a0aa602cbd924fa7269fdaf9316b58721d4ebc07 +size 47023 diff --git a/marked/Rel-16/29_series/29305/5152ddc7d77f41ae1eaf931aaac810eb_img.jpg b/marked/Rel-16/29_series/29305/5152ddc7d77f41ae1eaf931aaac810eb_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3a6528f99e6a699e8d4198df9d0cfa281e7ef5f5 --- /dev/null +++ b/marked/Rel-16/29_series/29305/5152ddc7d77f41ae1eaf931aaac810eb_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a7d196f89474257261d0407a6437dfa85351ec277e3e34f4e2990ad137fb0eda +size 42538 diff --git a/marked/Rel-16/29_series/29305/68843e462129ecabfcc023c2f228999f_img.jpg b/marked/Rel-16/29_series/29305/68843e462129ecabfcc023c2f228999f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..70b7e5a12de6f2693ffee23e1ff15064bdd88f5f --- /dev/null +++ b/marked/Rel-16/29_series/29305/68843e462129ecabfcc023c2f228999f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9931e1c437c3457753a83484d7403dbdd02141f0a5ef62846c1e9e605ff29c4e +size 36183 diff --git a/marked/Rel-16/29_series/29305/694df81535f89c7bfb9ef0df6f130dc0_img.jpg b/marked/Rel-16/29_series/29305/694df81535f89c7bfb9ef0df6f130dc0_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ec6ca5b50f432c677720c63a1999fb5d4bfdeada --- /dev/null +++ b/marked/Rel-16/29_series/29305/694df81535f89c7bfb9ef0df6f130dc0_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5a3fa81ebe5ab026c7fa7d312f7ce5c1691f8ea16be2d325280406ce24202ba7 +size 44555 diff --git a/marked/Rel-16/29_series/29305/6e15fc9ea763541c5913d26f85072ae1_img.jpg b/marked/Rel-16/29_series/29305/6e15fc9ea763541c5913d26f85072ae1_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1426115be0e6762bd0da90833c9a2609c680d042 --- /dev/null +++ b/marked/Rel-16/29_series/29305/6e15fc9ea763541c5913d26f85072ae1_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:83ba9c02fe86230b447f7b96d970165674653ed6b04ecba42615d012bd96e4ab +size 40201 diff --git a/marked/Rel-16/29_series/29305/6f659142d4789aa889184459f884787e_img.jpg b/marked/Rel-16/29_series/29305/6f659142d4789aa889184459f884787e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..292359c97ba3dc2b3b4340a5a3b956c7ce581997 --- /dev/null +++ b/marked/Rel-16/29_series/29305/6f659142d4789aa889184459f884787e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a5d390d39e547ff3f3bc767e6b3c61f34ffafd506f78d371e1aac72140ac5d45 +size 15816 diff --git a/marked/Rel-16/29_series/29305/77464a47f104d0d647b2414591137b64_img.jpg b/marked/Rel-16/29_series/29305/77464a47f104d0d647b2414591137b64_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..348ab667c1695a52eed9a97072cd9cb4703b2132 --- /dev/null +++ b/marked/Rel-16/29_series/29305/77464a47f104d0d647b2414591137b64_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5a629e4810400c403d3d23ce587734f45cfdc27f5f6e72f3195e6b79093b1302 +size 41730 diff --git a/marked/Rel-16/29_series/29305/78ff716475b2f65bf01c3a4d02d89fc4_img.jpg b/marked/Rel-16/29_series/29305/78ff716475b2f65bf01c3a4d02d89fc4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3db4a357e2473fb3312811c6dfd915a87e4e2769 --- /dev/null +++ b/marked/Rel-16/29_series/29305/78ff716475b2f65bf01c3a4d02d89fc4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:daf769b9c0103572f7a723e044300c976e03814d29518f381dcb79e320c38f55 +size 44279 diff --git a/marked/Rel-16/29_series/29305/78ffccd66df9bafd96e3e081110d09dd_img.jpg b/marked/Rel-16/29_series/29305/78ffccd66df9bafd96e3e081110d09dd_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0c11459332f155b4c61fd5d012c7be07cf5b69a2 --- /dev/null +++ b/marked/Rel-16/29_series/29305/78ffccd66df9bafd96e3e081110d09dd_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:11623d041ba817ec6dae37ed2b2bc4947a3309c095d027b4db05d59d9257db2e +size 47290 diff --git a/marked/Rel-16/29_series/29305/79e1709a7317ead45379cbb8ff3ba802_img.jpg b/marked/Rel-16/29_series/29305/79e1709a7317ead45379cbb8ff3ba802_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..cd19bcd26544aa32b9e91596e7d90e46977df0b0 --- /dev/null +++ b/marked/Rel-16/29_series/29305/79e1709a7317ead45379cbb8ff3ba802_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6182b732813eede10f5994aac8ca95895c9e9c5079b75ea0b66fc60a0992f88e +size 45203 diff --git a/marked/Rel-16/29_series/29305/7efae06af3af43ffe5d4b956a679cf54_img.jpg b/marked/Rel-16/29_series/29305/7efae06af3af43ffe5d4b956a679cf54_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8dc618140178ce424d21b3b76b38e30d6825870a --- /dev/null +++ b/marked/Rel-16/29_series/29305/7efae06af3af43ffe5d4b956a679cf54_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0a66c7674c01d1ae34b9fbca09deb62ba4c50ab41a20fed646487122f4c98ece +size 67924 diff --git a/marked/Rel-16/29_series/29305/832a0ce332e784fe80289e9f00f56574_img.jpg b/marked/Rel-16/29_series/29305/832a0ce332e784fe80289e9f00f56574_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4fa2525498f68dc12a57a2fc7db13e4bca88b65b --- /dev/null +++ b/marked/Rel-16/29_series/29305/832a0ce332e784fe80289e9f00f56574_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1fbc53b76996f951c60abdeea91c12ddce1c3346f6e3ce8a11e56cebd73f22c9 +size 48842 diff --git a/marked/Rel-16/29_series/29305/8a94796989f4fcba2688c4faa7991538_img.jpg b/marked/Rel-16/29_series/29305/8a94796989f4fcba2688c4faa7991538_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2066794f22e15b163e1056575ba11365d641d892 --- /dev/null +++ b/marked/Rel-16/29_series/29305/8a94796989f4fcba2688c4faa7991538_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d01a36d439ee05f898465d3505c2563a8ffc297c10dbe9f27accd293ab7671d7 +size 37163 diff --git a/marked/Rel-16/29_series/29305/8fe194ec0e70ac418890f8f1ad02a102_img.jpg b/marked/Rel-16/29_series/29305/8fe194ec0e70ac418890f8f1ad02a102_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6ee0f3f6c27110f6e9c9fbced75cd18e776313be --- /dev/null +++ b/marked/Rel-16/29_series/29305/8fe194ec0e70ac418890f8f1ad02a102_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7268fecaff619e642a0d55466ebdd9f3a2579469fd26520c66e0597d4d3b6377 +size 17780 diff --git a/marked/Rel-16/29_series/29305/90ddb84c323b956e2d50a54d3f870566_img.jpg b/marked/Rel-16/29_series/29305/90ddb84c323b956e2d50a54d3f870566_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0aca5107e3a1ac2d692f1080cd299d7c245da45d --- /dev/null +++ b/marked/Rel-16/29_series/29305/90ddb84c323b956e2d50a54d3f870566_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b5d7f4c965df50a41b7c006cb5d97a2441f91264d5766d2100cdb258cf2361c1 +size 45153 diff --git a/marked/Rel-16/29_series/29305/9b9d2abd741ed4bafe7f78f89961c663_img.jpg b/marked/Rel-16/29_series/29305/9b9d2abd741ed4bafe7f78f89961c663_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..32f5fd9a556cc0563ece0909dcce95bc85355455 --- /dev/null +++ b/marked/Rel-16/29_series/29305/9b9d2abd741ed4bafe7f78f89961c663_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e125da23d17b8b1b5627d4e9e536d6aea12b0552817f34a5c076fda53fb07c1b +size 30919 diff --git a/marked/Rel-16/29_series/29305/9c1d3678db4a12d5864cb2a4def1135d_img.jpg b/marked/Rel-16/29_series/29305/9c1d3678db4a12d5864cb2a4def1135d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..856255028987324b4e3c2500288f96ea1469a9a5 --- /dev/null +++ b/marked/Rel-16/29_series/29305/9c1d3678db4a12d5864cb2a4def1135d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:501c707ad4aeeaf69548ce40e993b3728d129339cf89eef8d01530b83b709757 +size 44791 diff --git a/marked/Rel-16/29_series/29305/9d1df8fe4616b242b4846c78ea8970f5_img.jpg b/marked/Rel-16/29_series/29305/9d1df8fe4616b242b4846c78ea8970f5_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..cb5667e2ffe3809db43d710358817fb722224866 --- /dev/null +++ b/marked/Rel-16/29_series/29305/9d1df8fe4616b242b4846c78ea8970f5_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4a2b8b29d86a1864e6a094eb28e2df4c5c7e2a620e57a7f2a7f701ccede71426 +size 26884 diff --git a/marked/Rel-16/29_series/29305/9f6dec4d4e9fde40bce018861ef1278e_img.jpg b/marked/Rel-16/29_series/29305/9f6dec4d4e9fde40bce018861ef1278e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6b11b77592bf12ce8d311ae63c02f090aaf8d9f5 --- /dev/null +++ b/marked/Rel-16/29_series/29305/9f6dec4d4e9fde40bce018861ef1278e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4193a9706bee43c4287ed6207c50aacd599a9849e3f335771696153f8ab7c5e8 +size 44919 diff --git a/marked/Rel-16/29_series/29305/9fc0c37f0024c76bce2fb5115a7f2c50_img.jpg b/marked/Rel-16/29_series/29305/9fc0c37f0024c76bce2fb5115a7f2c50_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..20975d1ae963d5cdff16c5d0e33668198e1936d5 --- /dev/null +++ b/marked/Rel-16/29_series/29305/9fc0c37f0024c76bce2fb5115a7f2c50_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ef7275949691e364924390db2073b6e254d70b64fab3940bbd497c6248a4cee7 +size 43809 diff --git a/marked/Rel-16/29_series/29305/a1890b9a9b85f13e67ed59bbad623659_img.jpg b/marked/Rel-16/29_series/29305/a1890b9a9b85f13e67ed59bbad623659_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c99ddca1a06c2c2d9747141b0270eb9e6085d867 --- /dev/null +++ b/marked/Rel-16/29_series/29305/a1890b9a9b85f13e67ed59bbad623659_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d6b7f124b898c4c7148e3ccd059b182b2c1346be6ba711bf2ce96c154f806368 +size 44368 diff --git a/marked/Rel-16/29_series/29305/a27134bc3a3c899782febdd02b502240_img.jpg b/marked/Rel-16/29_series/29305/a27134bc3a3c899782febdd02b502240_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..57df92bece75c27e6484e2bcb98577d3b1d162f3 --- /dev/null +++ b/marked/Rel-16/29_series/29305/a27134bc3a3c899782febdd02b502240_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6089de5463d72a33492a8f29aa5a4ca3fb624e423b9f9b8281b815a827a2ad24 +size 14758 diff --git a/marked/Rel-16/29_series/29305/ae53f90bb87d6d09e2d6b5278d7c338f_img.jpg b/marked/Rel-16/29_series/29305/ae53f90bb87d6d09e2d6b5278d7c338f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..929abc783f5eb4094a88026218bfcf1993828e71 --- /dev/null +++ b/marked/Rel-16/29_series/29305/ae53f90bb87d6d09e2d6b5278d7c338f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:dd1a208a3732a02300d809320ccddc766dfc2eebcfa8271c4c3377f05a756f93 +size 49153 diff --git a/marked/Rel-16/29_series/29305/b327d9f0565f7e032fc82b4322c844dc_img.jpg b/marked/Rel-16/29_series/29305/b327d9f0565f7e032fc82b4322c844dc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1c46c63e3b11a8e848c5b401a18ac57c60f65d88 --- /dev/null +++ b/marked/Rel-16/29_series/29305/b327d9f0565f7e032fc82b4322c844dc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8b36dd931c88d47529986795a36d148712f5c3dea6a5f80afa7c55a705505bd0 +size 17318 diff --git a/marked/Rel-16/29_series/29305/b5335262987c819d7f71ce40f99cb71b_img.jpg b/marked/Rel-16/29_series/29305/b5335262987c819d7f71ce40f99cb71b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..54aeffdd7ac10bb3eb10cb8b53128be1663b1b23 --- /dev/null +++ b/marked/Rel-16/29_series/29305/b5335262987c819d7f71ce40f99cb71b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a62918e6c0176935ec5506a61c53c6aa0deb9b302142ccbddccb653c737dc2c8 +size 30997 diff --git a/marked/Rel-16/29_series/29305/b90144cfbb81a2d610d920240fda689d_img.jpg b/marked/Rel-16/29_series/29305/b90144cfbb81a2d610d920240fda689d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c07f6f414c93aad943d30018bb7aa1616840e4b6 --- /dev/null +++ b/marked/Rel-16/29_series/29305/b90144cfbb81a2d610d920240fda689d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ff07c03ee3537281af23a0da811f423a4f358960fcda0880677604597db27c1a +size 63950 diff --git a/marked/Rel-16/29_series/29305/bffdddb47fced140f8d17fdc2a29f592_img.jpg b/marked/Rel-16/29_series/29305/bffdddb47fced140f8d17fdc2a29f592_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2d6aa1f50d6b7e8fcdb993077eec13eaea74567c --- /dev/null +++ b/marked/Rel-16/29_series/29305/bffdddb47fced140f8d17fdc2a29f592_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c289f098a14259d94b34777ff4d67746115ba6dc2963ff98a79ffd88c5e9b980 +size 75690 diff --git a/marked/Rel-16/29_series/29305/c036e2540a94b31357ceb0002f0cacab_img.jpg b/marked/Rel-16/29_series/29305/c036e2540a94b31357ceb0002f0cacab_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..59a15753763f6e8796e1e4c33fe35007e9a17a8b --- /dev/null +++ b/marked/Rel-16/29_series/29305/c036e2540a94b31357ceb0002f0cacab_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cd63014be358341934a8a9307b5db0f7141d0e9a82ba3094669c889e0a1a0eef +size 28199 diff --git a/marked/Rel-16/29_series/29305/d26959f4514c26ca19c3d6f00da85956_img.jpg b/marked/Rel-16/29_series/29305/d26959f4514c26ca19c3d6f00da85956_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c4391750beb26d2bbd4647351a0a72cc23b1a142 --- /dev/null +++ b/marked/Rel-16/29_series/29305/d26959f4514c26ca19c3d6f00da85956_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1b991d407ec24f7b6b5e29f852750a45f03e660c1d48626e2e8442ec23cb082a +size 59631 diff --git a/marked/Rel-16/29_series/29305/d6c377ae3e619ff992bd3647dbf43593_img.jpg b/marked/Rel-16/29_series/29305/d6c377ae3e619ff992bd3647dbf43593_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..82ce2d6c332b77d6cd9d99031452d3b67ad86683 --- /dev/null +++ b/marked/Rel-16/29_series/29305/d6c377ae3e619ff992bd3647dbf43593_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7b9b09e08bd9cf85c0395bc28f20b4be55b206ce13a9e035709e336f5c23378d +size 42817 diff --git a/marked/Rel-16/29_series/29305/d79d33da852cb7bca3e87b400a15c3e8_img.jpg b/marked/Rel-16/29_series/29305/d79d33da852cb7bca3e87b400a15c3e8_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d2bde7422af371184ce8f0909ee7bdf268a88a7b --- /dev/null +++ b/marked/Rel-16/29_series/29305/d79d33da852cb7bca3e87b400a15c3e8_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1d486ceb8448996fe0f4ff1e64e189df31ef744759284565796b2086f92298f9 +size 19608 diff --git a/marked/Rel-16/29_series/29305/dbd4bab54b57e8d1abf80e3de6471130_img.jpg b/marked/Rel-16/29_series/29305/dbd4bab54b57e8d1abf80e3de6471130_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c80859b4e875c6f19b9ca7b97dd7ed7fc1b0ead1 --- /dev/null +++ b/marked/Rel-16/29_series/29305/dbd4bab54b57e8d1abf80e3de6471130_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8787aa31764f6b45871539ab516ddf35e71188efb54a45f08e55d12f318103d3 +size 37085 diff --git a/marked/Rel-16/29_series/29305/dd5771673aececa53d42ece89218299d_img.jpg b/marked/Rel-16/29_series/29305/dd5771673aececa53d42ece89218299d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c1e405455d621e4a43003530215cf6027c1f5cc3 --- /dev/null +++ b/marked/Rel-16/29_series/29305/dd5771673aececa53d42ece89218299d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:df25ee559e00f3cc82084a46a220e17741c9c86b18186d3ea611839409cc67c1 +size 58184 diff --git a/marked/Rel-16/29_series/29305/df82d77a0d2637cbf2da9ea920a554fa_img.jpg b/marked/Rel-16/29_series/29305/df82d77a0d2637cbf2da9ea920a554fa_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7160db318e72aaedd2f85c4ffe3e8336286087df --- /dev/null +++ b/marked/Rel-16/29_series/29305/df82d77a0d2637cbf2da9ea920a554fa_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9b9171ff7cf15915a62b0b8f7b8ae8f2654ffe604278972930e2ca93117b6d72 +size 53563 diff --git a/marked/Rel-16/29_series/29305/e05b36c0d46549e681ce6581422c66b2_img.jpg b/marked/Rel-16/29_series/29305/e05b36c0d46549e681ce6581422c66b2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..36044707ae751f342dda36c6a912f536778b7250 --- /dev/null +++ b/marked/Rel-16/29_series/29305/e05b36c0d46549e681ce6581422c66b2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:595069bf6da3e9deaaf2e07fa4b72a170ff2af56db94afdaf17d3f104b0e8af7 +size 47691 diff --git a/marked/Rel-16/29_series/29305/e180f2b5fcbe8001554a7c0677cd3f82_img.jpg b/marked/Rel-16/29_series/29305/e180f2b5fcbe8001554a7c0677cd3f82_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c6e3c03578ac5fdcb08ec0947c8ee6338b5fe5a6 --- /dev/null +++ b/marked/Rel-16/29_series/29305/e180f2b5fcbe8001554a7c0677cd3f82_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f6c515d307f4ab8ede26a1143f6903dfc8ec357a2377535ab00d44cda8991c1d +size 49444 diff --git a/marked/Rel-16/29_series/29305/e48a7aa9d3880694350259852fefbef2_img.jpg b/marked/Rel-16/29_series/29305/e48a7aa9d3880694350259852fefbef2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f73bb25c7e039dc6362a74206911fc5a5db83e5a --- /dev/null +++ b/marked/Rel-16/29_series/29305/e48a7aa9d3880694350259852fefbef2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c0190a002d29fb830e52046e25d349157ca178c5d2d33f77fed6e8f183b37645 +size 37772 diff --git a/marked/Rel-16/29_series/29305/e6df2733626a85205c1db682e6259c46_img.jpg b/marked/Rel-16/29_series/29305/e6df2733626a85205c1db682e6259c46_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..24a3fc24f0c4e120cd6b89eaf0d6a7c59ee17a65 --- /dev/null +++ b/marked/Rel-16/29_series/29305/e6df2733626a85205c1db682e6259c46_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9a20bd5cd59571829476050a3260ace7df7e607cf0930d923d8eca2df17b8fa4 +size 19416 diff --git a/marked/Rel-16/29_series/29305/eb03559a4d92ea9ebd63ea9be663c50a_img.jpg b/marked/Rel-16/29_series/29305/eb03559a4d92ea9ebd63ea9be663c50a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..79105f725c8096498001d9b9b41074db987c6153 --- /dev/null +++ b/marked/Rel-16/29_series/29305/eb03559a4d92ea9ebd63ea9be663c50a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2dc54206636ad64e3c713aa2b31b91db0d1ab3ecb020b5f1bc6c36663a9bc4b0 +size 44553 diff --git a/marked/Rel-16/29_series/29305/f5deee2f3301ee351c4008283ffafbb3_img.jpg b/marked/Rel-16/29_series/29305/f5deee2f3301ee351c4008283ffafbb3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..24f4a2584b624126d3c3fce4d172187e1726dfb8 --- /dev/null +++ b/marked/Rel-16/29_series/29305/f5deee2f3301ee351c4008283ffafbb3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c73aaa4115fbffcf5325bbe005224d501abc2621fac66d6e885093ef395482b2 +size 48185 diff --git a/marked/Rel-16/29_series/29305/ff0952ef692c9d960ce5f6708bcc9711_img.jpg b/marked/Rel-16/29_series/29305/ff0952ef692c9d960ce5f6708bcc9711_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ddcc4b81e13a8e6a86a9da56cb4010af428c9754 --- /dev/null +++ b/marked/Rel-16/29_series/29305/ff0952ef692c9d960ce5f6708bcc9711_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d82a53b94eeae53f176926e194a445ea6085a98b178b4ec9c33a7acf1c78071f +size 57969 diff --git a/marked/Rel-16/29_series/29305/raw.md b/marked/Rel-16/29_series/29305/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..7e4be94d4ee238275983b745145d629ad20779f6 --- /dev/null +++ b/marked/Rel-16/29_series/29305/raw.md @@ -0,0 +1,4157 @@ + + + + + + +# --- Contents + +| | | +|----------------------------------------------------------------------------------|----| +| Foreword ..... | 7 | +| Introduction ..... | 7 | +| 1 Scope..... | 8 | +| 2 References..... | 8 | +| 3 Definitions, symbols and abbreviations ..... | 9 | +| 3.1 Definitions ..... | 9 | +| 3.2 Symbols..... | 9 | +| 3.3 Abbreviations ..... | 9 | +| 4 Introduction (Informative) ..... | 9 | +| 4.1 General Description..... | 9 | +| 4.2 Scenario One: S6a/S6d - Pre Rel8 Gr interworking scenario with one IWF ..... | 9 | +| 4.2.1 General Description..... | 9 | +| 4.2.2 Network Deployments..... | 10 | +| 4.3 Scenario Two: S6a/S6d - Rel8 Gr interworking scenario with one IWF..... | 11 | +| 4.3.1 General Description..... | 11 | +| 4.3.2 Network Deployments..... | 12 | +| 4.4 Scenario Three: S6a/S6d - S6a/S6d interworking scenario with two IWFs ..... | 14 | +| 4.4.1 General Description..... | 14 | +| 4.4.2 Network Deployments..... | 14 | +| 4.5 Scenario Four: S13/S13' - Gf interworking scenario with one IWF ..... | 17 | +| 4.5.1 General Description..... | 17 | +| 4.5.2 Network Deployments..... | 18 | +| 5 General issues ..... | 19 | +| 5.1 Message Routing Mechanism ..... | 19 | +| 5.2 Void..... | 20 | +| 5.3 Security Consideration for IWF ..... | 20 | +| 6 The Interworking Scenarios..... | 20 | +| 6.1 One IWF scenario..... | 20 | +| 6.2 Two IWF scenario..... | 20 | +| 7 The Mapping of the Procedures ..... | 21 | +| 7.1 Authentication Information Retrieval ..... | 21 | +| 7.1.1 One IWF Scenario ..... | 21 | +| 7.1.2 Two IWFs Scenario..... | 22 | +| 7.2 Update Location..... | 22 | +| 7.2.1 One IWF Scenario ..... | 22 | +| 7.2.2 Two IWFs Scenario..... | 23 | +| 7.3 Cancel Location..... | 24 | +| 7.3.1 One IWF Scenario ..... | 24 | +| 7.3.2 Two IWFs Scenario..... | 25 | +| 7.4 Purge..... | 26 | +| 7.4.1 One IWF Scenario ..... | 26 | +| 7.4.2 Two IWFs Scenario..... | 27 | +| 7.5 Insert Subscriber Data ..... | 28 | +| 7.5.1 One IWF Scenario ..... | 28 | +| 7.5.2 Two IWFs Scenario..... | 29 | +| 7.6 Delete Subscriber Data..... | 30 | +| 7.6.1 One IWF Scenario ..... | 30 | +| 7.6.2 Two IWFs Scenario..... | 31 | +| 7.7 Reset..... | 32 | +| 7.7.1 One IWF Scenario ..... | 32 | +| 7.7.2 Two IWFs Scenario..... | 33 | +| 7.8 Notification..... | 34 | +| 7.8.1 One IWF Scenario ..... | 34 | +| 7.8.2 Two IWFs Scenario..... | 34 | + +| | | | +|--------|------------------------------------------------------------------------------------------------|----| +| 7.9 | IMEI Check..... | 35 | +| 7.9.1 | One IWF Scenario ..... | 35 | +| 7.10 | Trace Activation..... | 36 | +| 7.10.1 | One IWF Scenario ..... | 36 | +| 7.10.2 | Two IWFs Scenario..... | 38 | +| 7.11 | Trace Deactivation ..... | 38 | +| 7.11.1 | One IWF Scenario ..... | 38 | +| 7.11.2 | Two IWFs Scenario..... | 40 | +| 8 | The Mapping of the Parameters ..... | 40 | +| 8.1 | Mapping of Parameters for the Authentication Info Retrieval Procedure ..... | 40 | +| 8.1.1 | AIR mapping to SendAuthenticationInfoArg (v3)..... | 40 | +| 8.1.2 | AIR mapping to SendAuthenticationInfoArg (v2)..... | 42 | +| 8.1.3 | AIR mapping to SendParametersArg (v1) ..... | 42 | +| 8.1.4 | SendAuthenticationInfoRes / Error (v3) mapping to AIA ..... | 42 | +| 8.1.5 | SendAuthenticationInfoRes / Error (v2) mapping to AIA ..... | 42 | +| 8.1.6 | SendParameterList / Error (v1) mapping to AIA ..... | 43 | +| 8.1.7 | SendAuthenticationInfoArg (v3) mapping to AIR..... | 43 | +| 8.1.8 | AIA mapping to SendAuthenticationInfoRes/Error (v3) ..... | 44 | +| 8.2 | Mapping of Parameters for the Update Location Procedure..... | 45 | +| 8.2.1 | ULR mapping to UpdateGprsLocationArg ..... | 45 | +| 8.2.2 | UpdateGprsLocationRes/Error/InsertSubscriberDataArg/ActivateTraceModeArg mapping to ULA ..... | 46 | +| 8.2.3 | UpdateGprsLocationArg mapping to ULR ..... | 49 | +| 8.2.4 | ULA mapping to InsertSubscriberDataArg/ ActivateTraceModeArg/UpdateGprsLocationRes/Error ..... | 50 | +| 8.3 | Mapping of Parameters for the Cancel Location Procedure ..... | 52 | +| 8.3.1 | CancelLocationArg mapping to CLR..... | 52 | +| 8.3.2 | CLA mapping to CancelLocationRes/Error ..... | 53 | +| 8.3.3 | CLR mapping to CancelLocationArg..... | 53 | +| 8.3.4 | CancelLocationRes / Error mapping to CLA ..... | 53 | +| 8.4 | Mapping of Parameters for the Purge Procedure ..... | 54 | +| 8.4.1 | PUR mapping to PurgeMS-Arg..... | 54 | +| 8.4.2 | PurgeMS-Res / Error mapping to PUA ..... | 54 | +| 8.4.3 | PurgeMS-Arg mapping to PUR..... | 54 | +| 8.4.4 | PUA mapping to PurgeMS-Res/Error ..... | 55 | +| 8.5 | Mapping of Parameters for the Insert Subscriber Data Procedure..... | 55 | +| 8.5.1 | InsertSubscriberDataArg mapping to IDR ..... | 55 | +| 8.5.2 | IDA mapping to InsertSubscriberDataRes/Error..... | 55 | +| 8.5.3 | IDR mapping to InsertSubscriberDataArg/ ActivateTraceModeArg ..... | 56 | +| 8.5.4 | InsertSubscriberDataRes / Error mapping to IDA..... | 58 | +| 8.5.5 | ProvideSubscriberInfoArg mapping to IDR..... | 59 | +| 8.5.6 | IDA mapping to ProvideSubscriberInfoRes/Error ..... | 59 | +| 8.5.7 | IDR mapping to ProvideSubscriberInfoArg..... | 60 | +| 8.5.8 | ProvideSubscriberInfoRes/Error mapping to IDA ..... | 60 | +| 8.6 | Mapping of Parameters for the Delete Subscriber Data Procedure ..... | 61 | +| 8.6.1 | DeleteSubscriberDataArg mapping to DSR..... | 61 | +| 8.6.2 | DSA mapping to DeleteSubscriberDataRes/Error ..... | 62 | +| 8.6.3 | DSR mapping to DeleteSubscriberDataArg/ DeactivateTraceModeArg ..... | 62 | +| 8.6.4 | DeleteSubscriberDataRes / Error mapping to DSA ..... | 64 | +| 8.7 | Mapping of Parameters for the Reset Procedure..... | 64 | +| 8.7.1 | Reset (v1 or v2) mapping to RSR..... | 64 | +| 8.7.2 | RSR mapping to ResetArg (v1 or v2) ..... | 64 | +| 8.8 | Mapping of Parameters for the Notification Procedure ..... | 65 | +| 8.8.1 | NOR mapping to UpdateGprsLocation-Arg ..... | 65 | +| 8.8.2 | UpdateGprsLocation-Arg mapping to NOR ..... | 66 | +| 8.8.3 | NOR mapping to ReadyForSM-Arg ..... | 66 | +| 8.8.4 | ReadyForSM-Arg mapping to NOR ..... | 67 | +| 8.9 | Mapping of Parameters for the IMEI Check Procedure..... | 67 | +| 8.9.1 | ECR mapping to CheckIMEI-Arg..... | 67 | +| 8.9.2 | CheckIMEI-Res / Error mapping to ECA ..... | 68 | +| 8.10 | Mapping of Parameters for the Trace Activate Procedure..... | 68 | +| 8.10.1 | ActivateTraceMode-Arg mapping to IDR ..... | 68 | +| 8.10.2 | IDA mapping to ActivateTraceMode-Res / Error..... | 68 | + +| | | | +|-----------------|----------------------------------------------------------------------------------------|-----------| +| 8.11 | Mapping of Parameters for the Trace Deactivate Procedure ..... | 69 | +| 8.11.1 | DeactivateTraceMode-Arg mapping to DSR..... | 69 | +| 8.11.2 | DSA mapping to DeactivateTraceMode-Res / Error ..... | 69 | +| Annex A: | IWFs for the support of SMS capable MMEs or SGSNs..... | 69 | +| A.1 | General ..... | 69 | +| A.2 | IWF related to the SGd/Gdd interfaces between MME/SGSN and central SMS functions ..... | 69 | +| A.2.1 | Introduction ..... | 69 | +| A.2.2 | General considerations ..... | 69 | +| A.2.3 | Interworking scenarios ..... | 70 | +| A.2.3.1 | One IWF scenario ..... | 70 | +| A.2.3.2 | Two IWF scenario ..... | 70 | +| A.2.4 | The mapping of procedures ..... | 71 | +| A.2.4.1 | MO Forward Short Message..... | 71 | +| A.2.4.1.1 | One IWF Scenario..... | 71 | +| A.2.4.1.2 | Two IWFs Scenario..... | 71 | +| A.2.4.2 | MT Forward Short Message ..... | 72 | +| A.2.4.2.1 | One IWF Scenario..... | 72 | +| A.2.4.2.2 | Two IWFs Scenario..... | 73 | +| A.2.4.3 | Alert Service Centre..... | 74 | +| A.2.4.3.1 | One IWF Scenario..... | 74 | +| A.2.4.3.2 | Two IWFs Scenario..... | 74 | +| A.2.5 | The mapping of parameters ..... | 75 | +| A.2.5.1 | Mapping of Parameters for the MO Forward Short Message procedure..... | 75 | +| A.2.5.1.1 | OFR mapping to MO-ForwardSM-Arg ..... | 75 | +| A.2.5.1.2 | MO-ForwardSM-Res / Error mapping to OFA ..... | 76 | +| A.2.5.1.3 | MO-ForwardSM-Arg mapping to OFR ..... | 76 | +| A.2.5.1.4 | OFA mapping to MO-ForwardSM-Res/Error ..... | 77 | +| A.2.5.2 | Mapping of Parameters for the MT Forward Short Message Procedure ..... | 77 | +| A.2.5.2.1 | MT-ForwardSM-Arg mapping to TFR ..... | 77 | +| A.2.5.2.2 | TFA mapping to MT-ForwardSM-Res/Error..... | 78 | +| A.2.5.2.3 | TFR mapping to MT-ForwardSM-Arg ..... | 79 | +| A.2.5.2.4 | MT-ForwardSM-Res / Error mapping to TFA..... | 79 | +| A.2.5.3 | Mapping of Parameters for the Alert Service Centre Procedure ..... | 80 | +| A.2.5.x.1 | ALR mapping to alertServiceCentre-Arg ..... | 80 | +| A.2.5.3.2 | alertServiceCentre-Res / Error mapping to ALA ..... | 80 | +| A.2.5.3.3 | alertServiceCentre-Arg mapping to ALR ..... | 81 | +| A.2.5.3.4 | ALA mapping to alertServiceCentre-Res ..... | 81 | +| A.3. | IWF related to the S6c interface between HSS and central SMS functions ..... | 82 | +| A.3.1 | Introduction ..... | 82 | +| A.3.2 | Interworking scenarios ..... | 82 | +| A.3.2.1 | IWF scenario..... | 82 | +| A.3.3 | General considerations ..... | 83 | +| A.3.3.1 | Routing considerations ..... | 83 | +| A.3.4 | The mapping of procedures ..... | 83 | +| A.3.4.1 | Send Routing Info for SM ..... | 83 | +| A.3.4.2 | Alert Service Centre..... | 84 | +| A.3.4.3 | Report SM Delivery Status ..... | 85 | +| A.3.5 | The mapping of parameters ..... | 85 | +| A.3.5.1 | Mapping of Parameters for the Send Routing Info for SM Procedure ..... | 85 | +| A.3.5.1.1 | RoutingInfoForSM-Arg mapping to SRR..... | 85 | +| A.3.5.1.2 | SRA mapping to RoutingInfoForSM-Res/Error ..... | 86 | +| A.3.5.1.3 | SRA mapping to informServiceCentreArg ..... | 87 | +| A.3.5.2 | Mapping of Parameters for the Alert Service Centre Procedure ..... | 87 | +| A.3.5.2.1 | ALR mapping to alertServiceCentre-Arg ..... | 87 | +| A.3.5.2.2 | alertServiceCentre-Res / Error mapping to ALA ..... | 88 | +| A.3.5.3 | Mapping of Parameters for the Report SM Delivery Status Procedure..... | 88 | +| A.3.5.3.1 | ReportSM-DeliveryStatusArg mapping to RDR..... | 88 | +| A.3.5.3.2 | RDA mapping to ReportSM-DeliveryStatusRes/Error..... | 89 | +| A.4 | IWF related to the S6a/S6a+D interface between MME and HSS ..... | 90 | +| A.4.1 | Introduction ..... | 90 | +| A.Z.2 | Interworking scenario ..... | 90 | + +| | | | +|------------------------|----------------------------------------------------------------------|-----| +| A.4.3 | General considerations ..... | 90 | +| A.4.3.1 | Procedures covered..... | 90 | +| A.4.4 | The mapping of procedures ..... | 91 | +| A.4.4.1 | Common aspects ..... | 91 | +| A.4.4.2 | Update Location..... | 92 | +| A.4.4.3 | Cancel Location ..... | 93 | +| A.4.4.3.1 | Cancel Location over S6a ..... | 93 | +| A.4.4.3.2 | Cancel Location over MAP D ..... | 94 | +| A.4.4.4 | Purge ..... | 95 | +| A.4.4.5 | Insert Subscriber Data..... | 96 | +| A.4.4.5.1 | Insert Subscriber Data over S6a ..... | 96 | +| A.4.4.5.2 | Insert Subscriber Data over MAP D ..... | 96 | +| A.4.4.6 | Delete Subscriber Data ..... | 97 | +| A.4.4.6.1 | Delete Subscriber Data over S6a..... | 97 | +| A.4.4.6.2 | Delete Subscriber Data over MAP D ..... | 97 | +| A.4.4.7 | Reset..... | 98 | +| A.4.4.8 | Notification ..... | 98 | +| A.4.5 | The mapping of parameters ..... | 99 | +| A.4.5.1 | Unchanged AVPs..... | 99 | +| A.4.5.2 | Mapping of Parameters for the Update Location procedure..... | 99 | +| A.4.5.2.1 | ULR mapping to ULR..... | 99 | +| A.4.5.2.1 | ULR mapping to UpdateLocationArg..... | 100 | +| A.4.5.2.2 | InsertSubscriberDataArg mapping to ULA..... | 100 | +| A.4.5.2.2 | Mapping to InsertSubscriberDataRes..... | 100 | +| A.4.5.3 | Mapping of Parameters for the Cancel Location procedure ..... | 101 | +| A.4.5.3.1 | CLR mapping to PurgeMSArg mapping to..... | 101 | +| A.4.5.3.2 | CancelLocationArg mapping to IDR ..... | 101 | +| A.4.5.3.3 | IDA mapping to CancelLocationRes/Error..... | 101 | +| A.4.5.4 | Mapping of Parameters for the Purge Procedure ..... | 101 | +| A.4.5.4.1 | PUR mapping to PurgeMS-Arg ..... | 101 | +| A.4.5.4.2 | PurgeMS-Res / Error mapping to PUA ..... | 102 | +| A.4.5.5 | Mapping of Parameters for the Insert Subscriber Data Procedure ..... | 102 | +| A.4.5.5.1 | InsertSubscriberDataArg mapping to IDR..... | 102 | +| A.4.5.5.2 | IDA mapping to InsertSubscriberDataRes/Error ..... | 102 | +| A.4.5.6 | Mapping of Parameters for the Delete Subscriber Data Procedure ..... | 102 | +| A.4.5.6.1 | DeleteSubscriberDataArg mapping to DSR..... | 102 | +| A.4.5.6.2 | DSA mapping to DeleteSubscriberDataRes/Error ..... | 102 | +| A.4.5.7 | Mapping of Parameters for the Reset Procedure ..... | 103 | +| A.4.5.7.1 | Reset mapping to RSR ..... | 103 | +| A.4.5.8 | Mapping of Parameters for the Notification Procedure ..... | 103 | +| A.4.5.8.1 | NOR mapping to ReadyForSM-Arg ..... | 103 | +| Annex B (informative): | Change history..... | 104 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The content of this specification is a part of overall solution to meet the requirement of the interworking between EPS and the legacy system, mainly for the interfaces between S4-SGSN/MME and HSS/HLR/EIR. + +# --- 1 Scope + +The present document is to specify the InterWorking Functions (IWF) + +- between MAP-based Gr, Gf interfaces and Diameter-based S6a, S6d, S13, S13a interfaces; +- between the S6a interface with SMS subscription data on the MME side and the S6a interface without SMS subscription data plus the MAP-based D interface for SMS subscription on the HSS side; +- between MAP-based C for SMS interface and Diameter-based S6c interface; +- between MAP-based E for SMS interface and Diameter-based SGd interface. + +The InterWorking Function between the S6a interface with SMS subscription data and the S6a interface without SMS subscription data plus the MAP-based D interface for SMS subscription (S6a/S6a+D) is described in Annex A. + +The InterWorking Function between MAP-based C for SMS interface and Diameter-based S6c interface is described in Annex A.3 + +The InterWorking Function between MAP-based E for SMS interface and Diameter-based SGd interface is described in Annex A.2 + +For each IWF scenario, the present document will specify the mapping of related procedures and the corresponding parameter handling. + +The present document will also specify the related mechanisms for the IWF, e.g. message routing, user data handling. The other mechanism, such as security, will also be described in this document as a part of the whole solution. + +If there is no specific indication, the SGSN in the specification refers to a S4-SGSN which supports S4 interface. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 33.401: "3GPP System Architecture Evolution: Security Architecture". +- [3] 3GPP TS 23.272: "Circuit Switched (CS) fallback in Evolved Packet System (EPS); Stage 2". +- [4] 3GPP TS 23.272: "Circuit Switched (CS) fallback in Evolved Packet System (EPS); Stage 2". +- [5] 3GPP TS 29.272: "Evolved Packet System (EPS); Mobility Management Entity (MME) and Serving GPRS Support Node (SGSN) related interfaces based on Diameter protocol". +- [6] 3GPP TS 23.204: "Support of Short Message Service (SMS) over generic 3GPP Internet Protocol (IP) access; Stage 2". +- [7] 3GPP TS 23.003: "Numbering, addressing and identification". + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in TR 21.905 [1]. + +**example:** text used to clarify abstract rules by applying them literally. + +## 3.2 Symbols + +For the purposes of the present document, the following symbols apply: + +| | | +|----------|---------------| +| | | +|----------|---------------| + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in TR 21.905 [1]. + +| | | +|-----|-----------------------| +| EPS | Evolved Packet System | +| IWF | Interworking Function | +| TAU | Tracking Area Update | + +# --- 4 Introduction (Informative) + +## 4.1 General Description + +The interworking scenarios in this specification are described based on interface mapping. + +The stage 2 network deployments for each of the interworking scenarios are also described. + +## 4.2 Scenario One: S6a/S6d - Pre Rel8 Gr interworking scenario with one IWF + +### 4.2.1 General Description + +This interworking scenario is for S6a/S6d interface based on Diameter and Pre Rel8 Gr interface based on MAP with one IWF in the path. + +This IWF scenario can be an inter PLMN use case. + +This IWF scenario can be an intra PLMN use case for operator to do the partly update of their legacy network. + +This interworking scenario is described as below: + +![Diagram of S6a/S6d - Pre Rel8 Gr interworking scenario with one IWF](e6df2733626a85205c1db682e6259c46_img.jpg) + +This diagram illustrates the network architecture for S6a/S6d interworking. On the left, under the heading 'VPLMN (EPS)', is a box labeled 'MME/SGSN'. On the right, under the heading 'HPLMN (Pre-REL8)', is a box labeled 'Pre-REL8 HLR'. A red line connects the 'MME/SGSN' box to a central box labeled 'IWF'. Below this connection is the label 'S6a/S6d' in red. Another red line connects the 'IWF' box to the 'Pre-REL8 HLR' box. Below this second connection is the label 'Pre Rel8 Gr' in red. + +Diagram of S6a/S6d - Pre Rel8 Gr interworking scenario with one IWF + +**Figure 4.2.1-1 S6a/S6d - Pre Rel8 Gr interworking scenario with one IWF** + +The Pre Rel8 HLR shall be upgraded to support Rel-8 EPS security and Pre Rel8 Gr shall be upgraded to support transfer of Rel-8 security parameters.. + +### 4.2.2 Network Deployments + +This IWF scenario will apply the following network deployment situation: + +- Users of a Pre Rel8 UMTS/GPRS network access into a visited EPS with only E-UTRAN, which is described as below: + +![Diagram of IWF Scenario one network deployment](1eadbbe42cfcac5c0023577110aec5e3_img.jpg) + +This diagram shows a network deployment scenario. On the left, representing the visited EPS, there is a cloud labeled 'E-UTRAN' connected to a box labeled 'MME', which is in turn connected to a box labeled 'UE'. A red line labeled 'S6a' in red connects the 'MME' box to a central box labeled 'IWF'. On the right, representing the home Pre Rel8 network, the 'IWF' box is connected via a red line labeled 'Pre Rel8' in red to a box labeled 'Pre Rel8 HLR'. This 'Pre Rel8 HLR' box is connected to a box labeled 'Gn/Gp SGSN'. Below the 'Gn/Gp SGSN' box are two clouds labeled 'Pre Rel8 UTRAN' and 'Pre Rel8 GERAN'. + +Diagram of IWF Scenario one network deployment + +**Figure 4.2.2-1 IWF Scenario one network deployment: visited EPS with E-UTRAN only, home Pre Rel8 UMTS/GPRS only** + +The subscription data for Pre Rel8 Gn/Gp SGSN is downloaded to MME. Mapping of the subscription data is done on MME. Additional security solution is needed in which the Pre Rel8 HLR can not be changed. + +- Users of a Pre Rel8 UMTS/GPRS network access into a visited EPS with E-UTRAN and UTRAN/GERAN, which is described as below: + +![Diagram of IWF Scenario one network deployment. A visited EPS (left) contains an MME connected to E-UTRAN, Rel8 UTRAN, and Rel8 GERAN. The MME is connected to an SGSN, which is connected to an IWF. The IWF is connected to a Pre Rel8 HLR (right) via a 'Pre Rel8 Gr' interface. The SGSN is also connected to the Pre Rel8 HLR via an 'S6d' interface. The Pre Rel8 HLR is connected to a Gn/Gp SGSN, which is connected to Pre Rel8 UTRAN and Pre Rel8 GERAN. A UE is shown below the visited EPS.](d26959f4514c26ca19c3d6f00da85956_img.jpg) + +``` + +graph TD + subgraph Visited_EPS [Visited EPS] + E_UTRAN((E-UTRAN)) + Rel8_UTRAN((Rel8 UTRAN)) + Rel8_GERAN((Rel8 GERAN)) + MME[MME] + SGSN[SGSN] + UE[UE] + MME --- E_UTRAN + MME --- Rel8_UTRAN + MME --- Rel8_GERAN + MME --- SGSN + UE --- SGSN + end + IWF[IWF] + Pre_Rel8_HLR[Pre Rel8 HLR] + Gn_Gp_SGSN[Gn/Gp SGSN] + Pre_Rel8_UTRAN((Pre Rel8 UTRAN)) + Pre_Rel8_GERAN((Pre Rel8 GERAN)) + SGSN --- IWF + IWF ---|Pre Rel8 Gr| Pre_Rel8_HLR + SGSN ---|S6d| Pre_Rel8_HLR + Pre_Rel8_HLR --- Gn_Gp_SGSN + Gn_Gp_SGSN --- Pre_Rel8_UTRAN + Gn_Gp_SGSN --- Pre_Rel8_GERAN + +``` + +Diagram of IWF Scenario one network deployment. A visited EPS (left) contains an MME connected to E-UTRAN, Rel8 UTRAN, and Rel8 GERAN. The MME is connected to an SGSN, which is connected to an IWF. The IWF is connected to a Pre Rel8 HLR (right) via a 'Pre Rel8 Gr' interface. The SGSN is also connected to the Pre Rel8 HLR via an 'S6d' interface. The Pre Rel8 HLR is connected to a Gn/Gp SGSN, which is connected to Pre Rel8 UTRAN and Pre Rel8 GERAN. A UE is shown below the visited EPS. + +**Figure 4.2.2-2 IWF Scenario one network deployment: visited EPS with E-UTRAN and UTRAN/GERAN, home Pre Rel8 UMTS/GPRS only** + +The subscription data for Pre Rel8 Gn/Gp SGSN is downloaded to SGSN. Mapping of the subscription data is done on SGSN. Security solution is not needed because the security mechanism in visited and home network is the same. + +## 4.3 Scenario Two: S6a/S6d - Rel8 Gr interworking scenario with one IWF + +### 4.3.1 General Description + +This interworking scenario is for S6a/S6d interface based on Diameter and Rel8 Gr interface based on MAP with one IWF in the path. + +This IWF scenario can be an inter PLMN use case. + +This IWF scenario can be an intra PLMN use case for operator to do the partly update of their legacy network. + +This interworking scenario is described as below: + +![Figure 4.3.1-1: S6a/S6d - Rel8 Gr interworking scenario with one IWF. The diagram shows a VPLMN (EPS) on the left and an HPLMN (UMTS/GPRS/EPS) on the right. The VPLMN contains an MME/SGSN. The HPLMN contains a Rel8 HLR. An IWF is positioned between them. A red line labeled 'S6a/S6d' connects the MME/SGSN to the IWF. Another red line labeled 'Rel8 Gr' connects the IWF to the Rel8 HLR.](27b06ec9f42b5d727a2630f61a5f1861_img.jpg) + +Figure 4.3.1-1: S6a/S6d - Rel8 Gr interworking scenario with one IWF. The diagram shows a VPLMN (EPS) on the left and an HPLMN (UMTS/GPRS/EPS) on the right. The VPLMN contains an MME/SGSN. The HPLMN contains a Rel8 HLR. An IWF is positioned between them. A red line labeled 'S6a/S6d' connects the MME/SGSN to the IWF. Another red line labeled 'Rel8 Gr' connects the IWF to the Rel8 HLR. + +**Figure 4.3.1-1 S6a/S6d - Rel8 Gr interworking scenario with one IWF** + +### 4.3.2 Network Deployments + +This IWF scenario will apply the following network deployment situation: + +- Users of a Rel8 UMTS/GPRS network access into a visited EPS with only E-UTRAN, which is described as below: + +![Figure 4.3.2-1: IWF Scenario two network deployment: visited EPS with E-UTRAN only, home Rel8 UMTS/GPRS only. On the left, the visited EPS contains an E-UTRAN (cloud) connected to a UE (box), which is also connected to an MME (box). The MME is connected to an IWF (box) via a red line labeled 'S6a'. On the right, the home network contains a Rel8 UTRAN (cloud) and a Rel8 GERAN (cloud) connected to a Gn/Gp SGSN (box). The Gn/Gp SGSN is connected to a Rel8 HLR (box) and to the IWF via a red line labeled 'Rel8 Gr'.](78ffccd66df9bafd96e3e081110d09dd_img.jpg) + +Figure 4.3.2-1: IWF Scenario two network deployment: visited EPS with E-UTRAN only, home Rel8 UMTS/GPRS only. On the left, the visited EPS contains an E-UTRAN (cloud) connected to a UE (box), which is also connected to an MME (box). The MME is connected to an IWF (box) via a red line labeled 'S6a'. On the right, the home network contains a Rel8 UTRAN (cloud) and a Rel8 GERAN (cloud) connected to a Gn/Gp SGSN (box). The Gn/Gp SGSN is connected to a Rel8 HLR (box) and to the IWF via a red line labeled 'Rel8 Gr'. + +**Figure 4.3.2-1 IWF Scenario two network deployment: visited EPS with E-UTRAN only, home Rel8 UMTS/GPRS only** + +The subscription data for Rel8 Gn/Gp SGSN is downloaded to MME. Mapping of the subscription data is done on MME. Additional security solution is needed in which the Pre Rel8 HLR can be changed. + +- Users of a Rel8 UMTS/GPRS network access into a visited EPS with E-UTRAN and UTRAN/GERAN, which is described as below: + +![Figure 4.3.2-2: IWF Scenario two network deployment: visited EPS with E-UTRAN and UTRAN/GERAN, home Rel8 UMTS/GPRS only. The diagram shows a visited network on the left with an MME connected to E-UTRAN, Rel8 UTRAN, and Rel8 GERAN. The MME is connected to an SGSN, which is connected to a UE. The SGSN is connected to an IWF via an S6d interface. The IWF is connected to a home network on the right via a Rel8 Gr interface. The home network contains a Rel8 HLR and a Gn/Gp SGSN connected to Rel8 UTRAN and Rel8 GERAN.](ff0952ef692c9d960ce5f6708bcc9711_img.jpg) + +Figure 4.3.2-2: IWF Scenario two network deployment: visited EPS with E-UTRAN and UTRAN/GERAN, home Rel8 UMTS/GPRS only. The diagram shows a visited network on the left with an MME connected to E-UTRAN, Rel8 UTRAN, and Rel8 GERAN. The MME is connected to an SGSN, which is connected to a UE. The SGSN is connected to an IWF via an S6d interface. The IWF is connected to a home network on the right via a Rel8 Gr interface. The home network contains a Rel8 HLR and a Gn/Gp SGSN connected to Rel8 UTRAN and Rel8 GERAN. + +**Figure 4.3.2-2 IWF Scenario two network deployment: visited EPS with E-UTRAN and UTRAN/GERAN, home Rel8 UMTS/GPRS only** + +The subscription data for Rel8 Gn/Gp SGSN is downloaded to SGSN. Mapping of the subscription data is done on SGSN. Security solution is not needed because the security mechanism in visited and home network is the same. + +- Users of a Pre Rel8 UMTS/GPRS/E-UTRAN network access into a visited EPS with E-UTRAN and UTRAN/GERAN, which is described as below: + +![Figure 4.3.2-3: IWF Scenario two network deployment: visited EPS with E-UTRAN and UTRAN/GERAN, home EPS with E-UTRAN only and Pre Rel8 UMTS/GPRS. The diagram shows a visited network on the left with an MME connected to E-UTRAN, Rel8 UTRAN, and Rel8 GERAN. The MME is connected to an SGSN, which is connected to a UE. The SGSN is connected to an IWF via an S6d interface. The IWF is connected to a home network on the right via a Rel8 Gr interface. The home network contains a Rel8 HSS and a Gn/Gp SGSN connected to Pre Rel8 UTRAN and Pre Rel8 GERAN. There is also an S6a interface between the MME in the visited network and the Rel8 HSS in the home network.](3ad00ce93ad9dea9ee0f47535e5355e6_img.jpg) + +Figure 4.3.2-3: IWF Scenario two network deployment: visited EPS with E-UTRAN and UTRAN/GERAN, home EPS with E-UTRAN only and Pre Rel8 UMTS/GPRS. The diagram shows a visited network on the left with an MME connected to E-UTRAN, Rel8 UTRAN, and Rel8 GERAN. The MME is connected to an SGSN, which is connected to a UE. The SGSN is connected to an IWF via an S6d interface. The IWF is connected to a home network on the right via a Rel8 Gr interface. The home network contains a Rel8 HSS and a Gn/Gp SGSN connected to Pre Rel8 UTRAN and Pre Rel8 GERAN. There is also an S6a interface between the MME in the visited network and the Rel8 HSS in the home network. + +**Figure 4.3.2-3 IWF Scenario two network deployment: visited EPS with E-UTRAN and UTRAN/GERAN, home EPS with E-UTRAN only and Pre Rel8 UMTS/GPRS** + +The subscription data for Pre Rel8 Gn/Gp SGSN and the subscription data for MME is downloaded to SGSN. Mapping of the subscription data is done on SGSN. Security solution is not needed because the security mechanism in visited and home network is the same. + +## 4.4 Scenario Three: S6a/S6d - S6a/S6d interworking scenario with two IWFs + +### 4.4.1 General Description + +This interworking scenario is for S6a/S6d interface based on Diameter, S6a/S6d interface based on Diameter and SS7/MAP based roaming agreement with two IWFs in the path. + +With this interworking scenario, two EPS operators can reuse the SS7 based roaming agreement. + +This IWF scenario can only be an inter PLMN use case in which the two IWFs are in the VPLMN and HPLMN separately. + +This interworking scenario is described as below: + +![Diagram of S6a/S6d interworking scenario with two IWFs](c036e2540a94b31357ceb0002f0cacab_img.jpg) + +The diagram illustrates the network architecture for the S6a/S6d interworking scenario. It is divided into two main sections by a vertical line: VPLMN (EPS) on the left and HPLMN (EPS) on the right. In the VPLMN (EPS), an MME/SGSN is connected to an IWF via an S6a/S6d interface. This IWF is connected to another IWF in the HPLMN (EPS) via an SS7/MAP interface. The second IWF is then connected to a Rel8 HSS-MME/Rel8 HSS-SGSN via another S6a/S6d interface. The SS7/MAP interface is highlighted in red, and the S6a/S6d interfaces are also highlighted in red. + +Diagram of S6a/S6d interworking scenario with two IWFs + +Figure 4.4.1-1 S6a/S6d - S6a/S6d interworking scenario with two IWFs + +### 4.4.2 Network Deployments + +This IWF scenario will apply the following network deployment situation: + +- Users of a Pre Rel8 UMTS/GPRS/EPS for UTRAN/GERAN and E-UTRAN network access into a visited EPS with only E-UTRAN, which is described as below: + +![Figure 4.4.2-1: IWF Scenario three network deployment: visited EPS with E-UTRAN only, home EPS with E-UTRAN and UTRAN/GERAN and Pre Rel8 UMTS/GPRS](7efae06af3af43ffe5d4b956a679cf54_img.jpg) + +This diagram illustrates a network architecture where a visited EPS (left) contains only E-UTRAN and a UE. The home EPS (right) contains E-UTRAN, Pre Rel8 UTRAN, and Pre Rel8 GERAN. The visited EPS is connected to the home EPS via an IWF (Interworking Function) through a Rel8 Gn interface. The MME in the visited EPS is connected to the UE and to the IWF via an S6a interface. The IWF in the home EPS is connected to the MME and to the SGSN via an S6a interface. The SGSN is connected to the Pre Rel8 UTRAN and Pre Rel8 GERAN. The MME is also connected to the Rel8 HSS. + +Figure 4.4.2-1: IWF Scenario three network deployment: visited EPS with E-UTRAN only, home EPS with E-UTRAN and UTRAN/GERAN and Pre Rel8 UMTS/GPRS + +**Figure 4.4.2-1 IWF Scenario three network deployment: visited EPS with E-UTRAN only, home EPS with E-UTRAN and UTRAN/GERAN and Pre Rel8 UMTS/GPRS** + +The subscription data for Pre Rel8 Gn/Gp SGSN, subscription data for SGSN and the subscription data for MME is downloaded to MME. MME picks up the subscription data for MME and discards the subscription data for Pre Rel8 UMTS/GPRS and the subscription data for SGSN. + +- Users of a Pre Rel8 UMTS/GPRS/EPS for UTRAN/GERAN and E-UTRAN network access into a visited EPS with E-UTRAN and UTRAN/GERAN, which is described as below: + +![Figure 4.4.2-2: IWF Scenario three network deployment: visited EPS with E-UTRAN only and UTRAN/GERAN, home EPS with E-UTRAN and UTRAN/GERAN and Pre Rel8 UMTS/GPRS](bffdddb47fced140f8d17fdc2a29f592_img.jpg) + +This diagram illustrates a network architecture where the visited EPS (left) contains E-UTRAN, Rel8 UTRAN, and Rel8 GERAN. The home EPS (right) contains E-UTRAN, Pre Rel8 UTRAN, and Pre Rel8 GERAN. The visited EPS is connected to the home EPS via an IWF (Interworking Function) through a Rel8 Gn interface. The MME in the visited EPS is connected to the UE and to the SGSN via an S6a interface. The SGSN is connected to the Rel8 UTRAN and Rel8 GERAN. The IWF in the home EPS is connected to the MME and to the SGSN via an S6a or S6d interface. The SGSN is connected to the Pre Rel8 UTRAN and Pre Rel8 GERAN. The MME is also connected to the Rel8 HSS. + +Figure 4.4.2-2: IWF Scenario three network deployment: visited EPS with E-UTRAN only and UTRAN/GERAN, home EPS with E-UTRAN and UTRAN/GERAN and Pre Rel8 UMTS/GPRS + +**Figure 4.4.2-2 IWF Scenario three network deployment: visited EPS with E-UTRAN only and UTRAN/GERAN, home EPS with E-UTRAN and UTRAN/GERAN and Pre Rel8 UMTS/GPRS** + +The subscription data for Pre Rel8 Gn/Gp SGSN, subscription data for SGSN and the subscription data for MME is downloaded to SGSN or MME. SGSN or MME picks up the subscription data for SGSN or MME and discards the subscription data for Pre Rel8 UMTS/GPRS and the subscription data for MME or SGSN. + +- Users of an EPS for UTRAN/GERAN and E-UTRAN network access into a visited EPS with only E-UTRAN, which is described as below: + +![Figure 4.4.2-3: IWF Scenario three network deployment: visited EPS with E-UTRAN only, home EPS with E-UTRAN and UTRAN/GERAN. The diagram shows a visited EPS on the left with an E-UTRAN connected to an MME, which is connected to an IWF. A UE is connected to the E-UTRAN. The IWF is connected to another IWF on the right via a 'Rel8 Gr' interface. The home EPS on the right contains a Rel8 HSS, an MME, and an SGSN. The MME is connected to the IWF and the Rel8 HSS. The SGSN is connected to the Rel8 HSS and to two radio access networks: Rel8 UTRAN and Rel8 GERAN. A red line labeled 'S6a' connects the IWF on the left to the Rel8 HSS on the right.](16152cf1d84aea10848758f51a91ff6a_img.jpg) + +Figure 4.4.2-3: IWF Scenario three network deployment: visited EPS with E-UTRAN only, home EPS with E-UTRAN and UTRAN/GERAN. The diagram shows a visited EPS on the left with an E-UTRAN connected to an MME, which is connected to an IWF. A UE is connected to the E-UTRAN. The IWF is connected to another IWF on the right via a 'Rel8 Gr' interface. The home EPS on the right contains a Rel8 HSS, an MME, and an SGSN. The MME is connected to the IWF and the Rel8 HSS. The SGSN is connected to the Rel8 HSS and to two radio access networks: Rel8 UTRAN and Rel8 GERAN. A red line labeled 'S6a' connects the IWF on the left to the Rel8 HSS on the right. + +**Figure 4.4.2-3 IWF Scenario three network deployment: visited EPS with E-UTRAN only, home EPS with E-UTRAN and UTRAN/GERAN** + +The subscription data for SGSN and the subscription data for MME is downloaded to MME. MME picks up the subscription data for MME and discards the subscription data for the subscription data for SGSN. + +- Users of an EPS for UTRAN/GERAN and E-UTRAN network access into a visited EPS with E-UTRAN and UTRAN/GERAN, which is described as below: + +![Figure 4.4.2-4: IWF Scenario three network deployment: visited EPS with E-UTRAN and UTRAN/GERAN, home EPS with E-UTRAN and UTRAN/GERAN. The diagram shows a visited EPS on the left with an E-UTRAN connected to an MME, a Rel8 UTRAN connected to an SGSN, and a Rel8 GERAN connected to the same SGSN. A UE is connected to the E-UTRAN. The MME is connected to the IWF and the SGSN. The IWF is connected to another IWF on the right via a 'Rel8 Gr' interface. The home EPS on the right contains a Rel8 HSS, an MME, and an SGSN. The MME is connected to the IWF and the Rel8 HSS. The SGSN is connected to the Rel8 HSS and to two radio access networks: Rel8 UTRAN and Rel8 GERAN. Red lines labeled 'S6a' and 'S6d' connect the IWF on the left to the Rel8 HSS on the right. Another red line labeled 'S6a or S6d' connects the IWF on the right to the Rel8 HSS on the right.](b90144cfbb81a2d610d920240fda689d_img.jpg) + +Figure 4.4.2-4: IWF Scenario three network deployment: visited EPS with E-UTRAN and UTRAN/GERAN, home EPS with E-UTRAN and UTRAN/GERAN. The diagram shows a visited EPS on the left with an E-UTRAN connected to an MME, a Rel8 UTRAN connected to an SGSN, and a Rel8 GERAN connected to the same SGSN. A UE is connected to the E-UTRAN. The MME is connected to the IWF and the SGSN. The IWF is connected to another IWF on the right via a 'Rel8 Gr' interface. The home EPS on the right contains a Rel8 HSS, an MME, and an SGSN. The MME is connected to the IWF and the Rel8 HSS. The SGSN is connected to the Rel8 HSS and to two radio access networks: Rel8 UTRAN and Rel8 GERAN. Red lines labeled 'S6a' and 'S6d' connect the IWF on the left to the Rel8 HSS on the right. Another red line labeled 'S6a or S6d' connects the IWF on the right to the Rel8 HSS on the right. + +**Figure 4.4.2-4 IWF Scenario three network deployment: visited EPS with E-UTRAN and UTRAN/GERAN, home EPS with E-UTRAN and UTRAN/GERAN** + +The subscription data for SGSN and the subscription data for MME is downloaded to SGSN or MME. SGSN or MME picks up the subscription data for SGSN or MME and discards the subscription data for MME or SGSN. + +- Users of a Pre Rel8 UMTS/GPRS/EPS for E-UTRAN only network access into a visited EPS with only E-UTRAN, which is described as below: + +![Figure 4.4.2-5: IWF Scenario three network deployment. The diagram shows a visited EPS on the left with an E-UTRAN connected to an MME, which is connected to a UE. The MME is connected to an IWF via an S6a interface. The IWF is connected to another IWF via a Rel8 Gf interface. The second IWF is connected to a home EPS on the right. The home EPS contains an E-UTRAN connected to an MME, which is connected to a Rel8 HSS. The Rel8 HSS is connected to a Gn/Gp SGSN, which is connected to Pre Rel8 UTRAN and Pre Rel8 GERAN. The second IWF is connected to the Rel8 HSS via an S6a interface.](df82d77a0d2637cbf2da9ea920a554fa_img.jpg) + +Figure 4.4.2-5: IWF Scenario three network deployment. The diagram shows a visited EPS on the left with an E-UTRAN connected to an MME, which is connected to a UE. The MME is connected to an IWF via an S6a interface. The IWF is connected to another IWF via a Rel8 Gf interface. The second IWF is connected to a home EPS on the right. The home EPS contains an E-UTRAN connected to an MME, which is connected to a Rel8 HSS. The Rel8 HSS is connected to a Gn/Gp SGSN, which is connected to Pre Rel8 UTRAN and Pre Rel8 GERAN. The second IWF is connected to the Rel8 HSS via an S6a interface. + +**Figure 4.4.2-5 IWF Scenario three network deployment: visited EPS with E-UTRAN only, home EPS with E-UTRAN only and Pre Rel8 UMTS/GPRS** + +The subscription data for Pre Rel8 Gn/Gp SGSN and the subscription data for MME is downloaded to MME. MME picks up the subscription data for MME and discards the subscription data for Pre Rel8 Gn/Gp SGSN. + +NOTE: This IWF scenario can not be used for interworking between two EPS network with only E-UTRAN in which there is no MAP based roaming agreement to be reused. + +## 4.5 Scenario Four: S13/S13' - Gf interworking scenario with one IWF + +### 4.5.1 General Description + +This interworking scenario is for S13/S13' interface based on Diameter and Gf interface based on MAP with one IWF in the path. + +This IWF scenario can only be an intra PLMN use case for operator to do the partly update of their legacy network. + +This interworking scenario is described as below: + +![Figure 4.5.1-1: S13/S13' - Gf interworking scenario with one IWF. The diagram shows a V or HPLMN (EPS) containing an MME/SGSN connected to an IWF via an S13/S13' interface. The IWF is connected to a Pre Rel8 EIR via a Gf interface.](6f659142d4789aa889184459f884787e_img.jpg) + +Figure 4.5.1-1: S13/S13' - Gf interworking scenario with one IWF. The diagram shows a V or HPLMN (EPS) containing an MME/SGSN connected to an IWF via an S13/S13' interface. The IWF is connected to a Pre Rel8 EIR via a Gf interface. + +**Figure 4.5.1-1 S13/S13' - Gf interworking scenario with one IWF** + +### 4.5.2 Network Deployments + +This IWF scenario will apply the following network deployment situation: + +- ME identity/IMEISV of a user from a Pre Rel8 UMTS/GPRS network can be checked in a visited EPS with E-UTRAN only, which is described as below: + +![Diagram of IWF Scenario for network deployment: UE access from EPS with E-UTRAN only. It shows a UE connected to an E-UTRAN cloud, which is connected to an MME. The MME is connected to an IWF via an S13 interface. The IWF is connected to a Pre Rel8 EIR via a Gf interface.](9b9d2abd741ed4bafe7f78f89961c663_img.jpg) + +The diagram illustrates a network architecture where a User Equipment (UE) is connected to an E-UTRAN cloud. The E-UTRAN cloud is connected to an MME. The MME is connected to an IWF (Interworking Function) via an S13 interface. The IWF is connected to a Pre Rel8 EIR (Equipment Identity Register) via a Gf interface. The MME is also connected to the E-UTRAN cloud via an S1 interface. + +Diagram of IWF Scenario for network deployment: UE access from EPS with E-UTRAN only. It shows a UE connected to an E-UTRAN cloud, which is connected to an MME. The MME is connected to an IWF via an S13 interface. The IWF is connected to a Pre Rel8 EIR via a Gf interface. + +**Figure 4.5.2-1 IWF Scenario for network deployment: UE access from EPS with E-UTRAN only** + +- ME identity/IMEISV of a user from a Pre Rel8 UMTS/GPRS network can be checked in a visited EPS with E-UTRAN and UTRAN/GERAN, which is described as below: + +![Diagram of IWF Scenario for network deployment: UE access from EPS with E-UTRAN and UTRAN/GERAN. It shows a UE connected to an E-UTRAN cloud, which is connected to an MME. The MME is connected to an IWF via an S13 interface. The IWF is connected to a Pre Rel8 EIR via a Gf interface. The MME is also connected to an SGSN, which is connected to Rel8 UTRAN and Rel8 GERAN clouds. The IWF is also connected to the SGSN via an S13' interface.](77464a47f104d0d647b2414591137b64_img.jpg) + +The diagram illustrates a network architecture where a User Equipment (UE) is connected to an E-UTRAN cloud. The E-UTRAN cloud is connected to an MME. The MME is connected to an IWF (Interworking Function) via an S13 interface. The IWF is connected to a Pre Rel8 EIR via a Gf interface. The MME is also connected to an SGSN, which is connected to Rel8 UTRAN and Rel8 GERAN clouds. The IWF is also connected to the SGSN via an S13' interface. + +Diagram of IWF Scenario for network deployment: UE access from EPS with E-UTRAN and UTRAN/GERAN. It shows a UE connected to an E-UTRAN cloud, which is connected to an MME. The MME is connected to an IWF via an S13 interface. The IWF is connected to a Pre Rel8 EIR via a Gf interface. The MME is also connected to an SGSN, which is connected to Rel8 UTRAN and Rel8 GERAN clouds. The IWF is also connected to the SGSN via an S13' interface. + +**Figure 4.5.2-2 IWF Scenario for network deployment: UE access from EPS with E-UTRAN and UTRAN/GERAN** + +# 5 General issues + +## 5.1 Message Routing Mechanism + +The principles for IWF message routing are: + +- For the same user, the messages shall go to and come back through the same route with the same IWF(s) for the duration of a MAP dialog. +- To ensure the correct message routing for the interworking scenarios, the IWFs in the network shall be able to map the SS7 number and the Diameter identity of the MME/SGSN 1-to-1. This may be achieved by static or dynamic configuration. +- To ensure the parallel multiple request messages can get their correct response messages, the IWFs in the network shall be able to map the MAP Dialogue Id and the Diameter Session Id 1-to-1. + +The overall message routing mechanism for the scenario is described as below: + +1. The MME/SGSN may not be able to identify whether there is an IWF or not on the route to an HSS. The routing of the first message from the MME/SGSN to the IWF/HSS is the same as for a normal Diameter message routing. If the MME/SGSN knows the address/name of the IWF/HSS for a certain user, both the Destination-Realm and Destination-Host AVPs shall be present in the request. Otherwise, only the Destination-Realm AVP shall be present and the command shall be routed to the next Diameter node based on the Diameter routing table in the client. + +When the MME/SGSN receives an answer message from the IWF/HSS, it should store the identity of the IWF/HSS for each IMSI for future reference to be able to send messages for the same IMSI. + +2. The IWF shall assign an SS7 number for the Diameter node MME/SGSN and shall assign a Diameter identity for the SS7 node HSS. This may be achieved by static configuration or dynamic assignment when the first signalling exchange occurs between the Diameter/SS7 nodes and the IWF. The IWF shall maintain a mapping table (address mapping table) for the assignment relationship. + +When a Diameter message reaches the IWF to set up a new Diameter session, the IWF(s) shall allocate a MAP Dialogue Id for the Diameter session. The IWF(s) shall maintain a mapping table (session mapping table) between the MAP Dialogue Id and the Diameter Session Id. + +The IWF shall then process messages as described below: + +- a. When the IWF receives a Diameter message from a Diameter node, it shall map the Diameter message to a MAP message. It shall obtain a MAP Dialogue Id from the Diameter Session Id in the received message according to the session mapping table. The IWF shall obtain the source/destination SS7 Number from the source/destination Diameter Identity in the received message according to the address mapping table. + - b. When the IWF receives an SS7 message from an SS7 node, it shall map the MAP message to a Diameter message. It shall obtain the Diameter Session Id from the MAP Dialogue Id in the received message according to the session mapping table. The IWF shall obtain the source/destination Diameter Identity from the source/destination SS7 Number in the received message according to the address mapping table. +3. When the HSS/HLR receives the first message from IWF/SGSN, the HSS/HLR shall record the SS7 number of the source for future message handling. + +## 5.2 Void + +## 5.3 Security Consideration for IWF + +To support the full EPS-AKA security level for the related IWF scenarios, the Pre Rel8 HLR shall be upgraded so that E-UTRAN authentication vector requests from nodes serving E-UTRAN can be identified. The detailed mechanism is described in 3GPP TS 33.401 [2]. + +# 6 The Interworking Scenarios + +## 6.1 One IWF scenario + +In this scenario, one IWF is located between MME or SGSN or combined MME/SGSN and HSS or one IWF is located between MME and EIR, as illustrated in figure 6.1-1: + +![Figure 6.1-1: One IWF scenarios. The diagram shows two separate scenarios. The top scenario shows a box labeled 'MME or SGSN or Combined MME/SGSN' connected via a double-headed arrow labeled 'S6a/S6d' to a box labeled 'IWF'. The 'IWF' box is connected via a double-headed arrow labeled 'Gr' to a box labeled 'HSS'. The bottom scenario shows a box labeled 'MME or SGSN or Combined MME/SGSN' connected via a double-headed arrow labeled 'S13/S13'' to a box labeled 'IWF'. The 'IWF' box is connected via a double-headed arrow labeled 'Gf' to a box labeled 'EIR'.](2eb23c2210154279f8013a1594fbcc5a_img.jpg) + +``` +graph LR; subgraph Top; A1[MME or SGSN or Combined MME/SGSN] <-->|S6a/S6d| B1[IWF]; B1 <-->|Gr| C1[HSS]; end; subgraph Bottom; A2[MME or SGSN or Combined MME/SGSN] <-->|S13/S13'| B2[IWF]; B2 <-->|Gf| C2[EIR]; end; +``` + +Figure 6.1-1: One IWF scenarios. The diagram shows two separate scenarios. The top scenario shows a box labeled 'MME or SGSN or Combined MME/SGSN' connected via a double-headed arrow labeled 'S6a/S6d' to a box labeled 'IWF'. The 'IWF' box is connected via a double-headed arrow labeled 'Gr' to a box labeled 'HSS'. The bottom scenario shows a box labeled 'MME or SGSN or Combined MME/SGSN' connected via a double-headed arrow labeled 'S13/S13'' to a box labeled 'IWF'. The 'IWF' box is connected via a double-headed arrow labeled 'Gf' to a box labeled 'EIR'. + +Figure 6.1-1: One IWF scenarios + +The IWF needs not to be aware whether its connection via Gr is to an HSS or to a second IWF (see Two IWF scenario). + +## 6.2 Two IWF scenario + +In this scenario, two IWFs are located between MME or SGSN or combined MME/SGSN and HSS, as illustrated in figure 6.2-1: + +![Figure 6.2-1: Two IWFs scenario. The diagram shows a sequence of four boxes connected by double-headed arrows. From left to right: 'MME or SGSN or Combined MME/SGSN' connected to 'IWF1' via 'S6a/S6d'; 'IWF1' connected to 'IWF2' via 'Gr'; and 'IWF2' connected to 'HSS' via 'S6a/S6d'.](d79d33da852cb7bca3e87b400a15c3e8_img.jpg) + +``` +graph LR; A[MME or SGSN or Combined MME/SGSN] <-->|S6a/S6d| B1[IWF1]; B1 <-->|Gr| B2[IWF2]; B2 <-->|S6a/S6d| C[HSS]; +``` + +Figure 6.2-1: Two IWFs scenario. The diagram shows a sequence of four boxes connected by double-headed arrows. From left to right: 'MME or SGSN or Combined MME/SGSN' connected to 'IWF1' via 'S6a/S6d'; 'IWF1' connected to 'IWF2' via 'Gr'; and 'IWF2' connected to 'HSS' via 'S6a/S6d'. + +Figure 6.2-1: Two IWFs scenario + +The IWF1 is located in the VPLMN. IWF2 is located in the HPLMN. The IWF1 needs not to be aware whether its connection via Gr is to an IWF or to an HSS (see One IWF scenario). + +# 7 The Mapping of the Procedures + +## 7.1 Authentication Information Retrieval + +### 7.1.1 One IWF Scenario + +The mapping of procedures for this scenario is shown in figure 7.1.1-1: + +![Sequence diagram showing the mapping of Authentication Info Retrieval Procedure for scenario with one IWF. The diagram involves three main entities: MME or SGSN or Combined MME/SGSN, IWF, and HSS. The IWF receives an AIR message from the MME/SGSN over the S6a/S6d interface. The IWF then sends a SendAuthenticationInfo message to the HSS over the Gr interface. The HSS responds with a Dialogue Continuation message (dashed line) and a SendAuthenticationInfo Ack message. Finally, the IWF sends an AIA message back to the MME/SGSN.](79e1709a7317ead45379cbb8ff3ba802_img.jpg) + +``` +sequenceDiagram + participant MME_SGSN as MME or SGSN or Combined MME/SGSN + participant IWF + participant HSS + Note right of MME_SGSN: S6a/S6d + Note right of IWF: Gr + MME_SGSN->>IWF: 1. AIR + IWF->>HSS: 2. SendAuthenticationInfo + HSS-->>IWF: 3. Dialogue Continuation + IWF->>HSS: 4. SendAuthenticationInfo Ack + IWF->>MME_SGSN: 5. AIA +``` + +Sequence diagram showing the mapping of Authentication Info Retrieval Procedure for scenario with one IWF. The diagram involves three main entities: MME or SGSN or Combined MME/SGSN, IWF, and HSS. The IWF receives an AIR message from the MME/SGSN over the S6a/S6d interface. The IWF then sends a SendAuthenticationInfo message to the HSS over the Gr interface. The HSS responds with a Dialogue Continuation message (dashed line) and a SendAuthenticationInfo Ack message. Finally, the IWF sends an AIA message back to the MME/SGSN. + +**Figure 7.1.1-1: Mapping of Authentication Info Retrieval Procedure for scenario with one IWF** + +1. The IWF receives an AIR message from the MME, SGSN or combined MME/SGSN. +2. The IWF opens a MAP v3 dialogue towards the HSS by sending SendAuthenticationInfo. +3. The HSS may initiate MAP version fallback and/or send partial results. The IWF performs the version fallback and/or stores the partial results. If EPS-Vectors are requested for immediate use, version fallback is not applicable; +4. The HSS closes the MAP dialogue by sending the (final) SendAuthenticationInfo Ack to the IWF. +5. The IWF uses the information received from the HSS to construct an AIA which is sent to the MME, SGSN, or combined MME/SGSN. + +### 7.1.2 Two IWFs Scenario + +The mapping of procedures for this scenario is shown in figure 7.1.2-1: + +![Sequence diagram showing the mapping of Authentication Info Retrieval Procedure for a scenario with two IWFs. The diagram involves four lifelines: MME or SGSN or Combined MME/SGSN, IWF1, IWF2, and HSS. The sequence of messages is: 1. AIR from MME/SGSN to IWF1; 2. SendAuthenticationInfo from IWF1 to IWF2; 3. AIR from IWF2 to HSS; 4. AIA from HSS to IWF2; 5. Dialogue Continuation from IWF2 to IWF1 (dashed line); 6. SendAuthenticationInfo Ack from IWF2 to IWF1; 7. AIA from IWF1 to MME/SGSN. The interfaces S6a/S6d are indicated between the MME/SGSN and IWF1, and between IWF2 and HSS. The interface Gr is indicated between IWF1 and IWF2.](e180f2b5fcbe8001554a7c0677cd3f82_img.jpg) + +``` +sequenceDiagram + participant MME or SGSN or Combined MME/SGSN + participant IWF1 + participant IWF2 + participant HSS + Note right of MME or SGSN or Combined MME/SGSN: S6a/S6d + Note right of IWF1: Gr + Note right of IWF2: S6a/S6d + MME or SGSN or Combined MME/SGSN->>IWF1: 1. AIR + IWF1->>IWF2: 2. SendAuthenticationInfo + IWF2->>HSS: 3. AIR + HSS-->>IWF2: 4. AIA + IWF2-->>IWF1: 5. Dialogue Continuation + IWF2->>IWF1: 6. SendAuthenticationInfo Ack + IWF1->>MME or SGSN or Combined MME/SGSN: 7. AIA +``` + +Sequence diagram showing the mapping of Authentication Info Retrieval Procedure for a scenario with two IWFs. The diagram involves four lifelines: MME or SGSN or Combined MME/SGSN, IWF1, IWF2, and HSS. The sequence of messages is: 1. AIR from MME/SGSN to IWF1; 2. SendAuthenticationInfo from IWF1 to IWF2; 3. AIR from IWF2 to HSS; 4. AIA from HSS to IWF2; 5. Dialogue Continuation from IWF2 to IWF1 (dashed line); 6. SendAuthenticationInfo Ack from IWF2 to IWF1; 7. AIA from IWF1 to MME/SGSN. The interfaces S6a/S6d are indicated between the MME/SGSN and IWF1, and between IWF2 and HSS. The interface Gr is indicated between IWF1 and IWF2. + +**Figure 7.1.2-1: Mapping of Authentication Info Retrieval Procedure for scenario with two IWFs** + +1. The IWF1 receives an AIR message from the MME, SGSN or combined MME/SGSN. +2. The IWF1 opens a MAP v3 dialogue towards IWF2 by sending SendAuthenticationInfo. +3. The IWF2 constructs an AIR message and sends it to the HSS. +4. The IWF2 receives AIA from the HSS. +5. If segmentation is required, the IWF2 sends partial results to the IWF1 which stores the partial results. +6. The IWF2 closes the MAP dialogue by sending the (final) SendAuthenticationInfo Ack to IWF1. +7. The IWF1 uses the information received from the IWF2 to construct an AIA which is sent to the MME, SGSN, or combined MME/SGSN. + +## 7.2 Update Location + +### 7.2.1 One IWF Scenario + +The mapping of procedures for this scenario is shown in figure 7.2.1-1: + +![Sequence diagram showing the mapping of Update Location Procedure for scenario with one IWF. The diagram involves three main entities: MME or SGSN or Combined MME/SGSN, IWF, and HSS. The IWF acts as a relay between the MME/SGSN and the HSS. The sequence of messages is: 1. ULR from MME/SGSN to IWF; 2. UpdateGprsLocation from IWF to HSS; 3. Dialogue Continuation from HSS to IWF (dashed line); 4. UpdateGprsLocation Ack from HSS to IWF; 5. ULA from IWF to MME/SGSN. The interfaces are labeled S6a/S6d between MME/SGSN and IWF, and Gr between IWF and HSS.](eb03559a4d92ea9ebd63ea9be663c50a_img.jpg) + +``` + +sequenceDiagram + participant MME_SGSN as MME or SGSN or Combined MME/SGSN + participant IWF + participant HSS + Note right of MME_SGSN: S6a/S6d + Note right of IWF: Gr + MME_SGSN->>IWF: 1. ULR + IWF->>HSS: 2. UpdateGprsLocation + HSS-->>IWF: 3. Dialogue Continuation + HSS->>IWF: 4. UpdateGprsLocation Ack + IWF->>MME_SGSN: 5. ULA + +``` + +Sequence diagram showing the mapping of Update Location Procedure for scenario with one IWF. The diagram involves three main entities: MME or SGSN or Combined MME/SGSN, IWF, and HSS. The IWF acts as a relay between the MME/SGSN and the HSS. The sequence of messages is: 1. ULR from MME/SGSN to IWF; 2. UpdateGprsLocation from IWF to HSS; 3. Dialogue Continuation from HSS to IWF (dashed line); 4. UpdateGprsLocation Ack from HSS to IWF; 5. ULA from IWF to MME/SGSN. The interfaces are labeled S6a/S6d between MME/SGSN and IWF, and Gr between IWF and HSS. + +**Figure 7.2.1-1: Mapping of Update Location Procedure for scenario with one IWF** + +1. The IWF receives an ULR message from the MME, SGSN or combined MME/SGSN. +2. The IWF shall open a MAP v3 dialogue towards the HSS by sending UpdateGprsLocation. +3. Depending on "skip subscriber data" indication received in the ULR (bullet 1 above) and hence sent as per bullet 2 in the UpdateGprsLocation, the HSS may continue the MAP dialogue by sending one or several InsertSubscriberData messages (in acknowledgement mode or in burst mode) to the IWF. The IWF then temporarily stores the received data and sends InsertSubscriberData Ack messages to the HSS. + +Note that the HSS may send InsertSubscriberData messages although a "skip subscriber data" indication was present. In this case InsertSubscriberData messages received from the HSS shall be acknowledged but need not be stored in the IWF. + +When sending InsertSubscriberData Ack messages to the HSS the IWF shall mirror back any services requested by the HSS (within the InsertSubscriberData message) but not supported by the MME or SGSN or combined MME/SGSN (as indicated in 1.ULR). The IWF shall reject a MAP ActivateTraceMode message received from the HSS by returning ActivateTraceMode Error (facilityNotSupported). + +If the IWF received a MAP ActivateTraceMode message from the HSS, the IWF needs to store the received trace data. Based upon support of tracing (as indicated the ULR received in bullet 1 above), the MME/SGSN sends an ActivateTraceMode Result (positive Ack) or Error FacilityNotSupported (negative Ack) to the HSS. + +4. The HSS shall close the MAP dialogue by sending UpdateGprsLocation Ack to the IWF. +5. The IWF shall use the information received from the HSS to construct an ULA which is sent to the MME, SGSN, or combined MME/SGSN. + +### 7.2.2 Two IWFs Scenario + +The mapping of procedures for this scenario is shown in figure 7.2.2-1: + +![Sequence diagram illustrating the mapping of Update Location Procedure for a scenario with two IWFs. The diagram shows interactions between MME or SGSN or Combined MME/SGSN, IWF1, IWF2, and HSS over S6a/S6d and Gr interfaces.](ae53f90bb87d6d09e2d6b5278d7c338f_img.jpg) + +``` + +sequenceDiagram + participant MME_SGSN as MME or SGSN or Combined MME/SGSN + participant IWF1 + participant IWF2 + participant HSS + + Note left of MME_SGSN: S6a/S6d + Note right of IWF1: Gr + Note left of IWF2: S6a/S6d + + MME_SGSN->>IWF1: 1. ULR + IWF1->>IWF2: 2. UpdateGprsLocation + IWF2->>HSS: 3. ULR + HSS-->>IWF2: 4. ULA + IWF2-->>IWF1: 5. Dialogue Continuation + IWF2->>IWF1: 6. UpdateGprsLocation Ack + IWF1->>MME_SGSN: 7. ULA + +``` + +Sequence diagram illustrating the mapping of Update Location Procedure for a scenario with two IWFs. The diagram shows interactions between MME or SGSN or Combined MME/SGSN, IWF1, IWF2, and HSS over S6a/S6d and Gr interfaces. + +**Figure 7.2.2-1: Mapping of Update Location Procedure for scenario with two IWFs** + +1. The IWF1 receives an ULR message from the MME, SGSN or combined MME/SGSN. +2. The IWF1 shall open a MAP v3 dialogue towards IWF2 by sending UpdateGprsLocation. +3. The IWF2 shall construct a ULR message and shall send it to the HSS. +4. The IWF2 receives ULA from the HSS. +5. If subscriber data is included in the ULA(as per bullet 4), the IWF2 shall send one or several InsertSubscriberData messages (in acknowledgement mode or in burst mode) to the IWF1. IWF1 then temporarily stores the received data and sends InsertSubscriberData Ack messages to the IWF2. If trace data is included in the ULA (bullet 4. above) , the IWF2 sends an ActivateTraceMode message to the IWF1, which sends an ActivateTraceMode Ack message to the IWF2. +6. The IWF2 shall close the MAP dialogue by sending UpdateGprsLocation Ack to IWF1. +7. The IWF1 shall use the information received from the IWF2 to construct an ULA which shall be sent to the MME, SGSN, or combined MME/SGSN. + +## 7.3 Cancel Location + +### 7.3.1 One IWF Scenario + +The mapping of procedures for this scenario is shown in figure 7.3.1-1: + +![Sequence diagram showing the mapping of Cancel Location Procedure for a scenario with one IWF. The diagram involves three lifelines: MME or SGSN or Combined MME/SGSN, IWF, and HSS. The IWF receives a CancelLocation message from the HSS, sends a CLR to the MME/SGSN, receives a CLA from the MME/SGSN, and finally sends a CancelLocationAck back to the HSS.](26d664119ad25250780f554633444e54_img.jpg) + +``` +sequenceDiagram + participant HSS + participant IWF + participant MME_SGSN as MME or SGSN or Combined MME/SGSN + Note right of HSS: Gr + Note left of IWF: S6a/S6d + HSS->>IWF: 1. CancelLocation + IWF->>MME_SGSN: 2. CLR + MME_SGSN->>IWF: 3. CLA + IWF->>HSS: 4. CancelLocationAck +``` + +Sequence diagram showing the mapping of Cancel Location Procedure for a scenario with one IWF. The diagram involves three lifelines: MME or SGSN or Combined MME/SGSN, IWF, and HSS. The IWF receives a CancelLocation message from the HSS, sends a CLR to the MME/SGSN, receives a CLA from the MME/SGSN, and finally sends a CancelLocationAck back to the HSS. + +**Figure 7.3.1-1: Mapping of Cancel Location Procedure for scenario with one IWF** + +1. The IWF receives a CancelLocation MAP v3 message from the HSS (the IWF shall reject CancelLocation messages in version <3 and shall initiate version fallback when receiving CancelLocation messages in versions >3; not shown in figure 7.3.1-1). +2. The IWF sends CLR to the MME or SGSN or combined MME/SGSN. +3. The IWF receives CLA. +4. The IWF closes the MAP dialogue with the HSS by sending CancelLocation Ack. + +### 7.3.2 Two IWFs Scenario + +The mapping of procedures for this scenario is shown in figure 7.3.2-1: + +![Sequence diagram for Cancel Location Procedure with two IWFs](90ddb84c323b956e2d50a54d3f870566_img.jpg) + +A sequence diagram illustrating the mapping of the Cancel Location Procedure for a scenario with two IWFs. The diagram shows interactions between five entities: MME or SGSN or Combined MME/SGSN, IWF1, IWF2, and HSS, connected by S6a/S6d and Gr interfaces. The sequence of messages is as follows: + +- The HSS sends a CLR message to IWF2. +- The IWF2 sends a CancelLocation message to IWF1. +- The IWF1 sends a CLR message to the MME or SGSN or Combined MME/SGSN. +- The MME or SGSN or Combined MME/SGSN sends a CLA message to IWF1. +- The IWF1 sends a CancelLocation Ack message to IWF2. +- The IWF2 sends a CLA message to the HSS. + +Sequence diagram for Cancel Location Procedure with two IWFs + +**Figure 7.3.2-1: Mapping of Cancel Location Procedure for scenario with two IWFs** + +1. The IWF2 receives a CLR message from the HSS. +2. The IWF2 opens a MAP v3 dialogue towards IWF1 by sending CancelLocation. +3. The IWF1 constructs a CLR message and sends it to the MME, SGSN, or combined MME/SGSN. +4. The IWF1 receives CLA from the MME, SGSN or combined MME/SGSN. +5. The IWF1 closes the MAP dialogue with the IWF2 by sending CancelLocation Ack. +6. The IWF2 sends CLA to the HSS. + +## 7.4 Purge + +### 7.4.1 One IWF Scenario + +The mapping of procedures for this scenario is shown in figure 7.4.1-1: + +![Sequence diagram showing the mapping of Purge Procedure for a scenario with one IWF. Lifelines: MME or SGSN or Combined MME/SGSN, IWF, and HSS. The sequence is: 1. PUR from MME/SGSN to IWF (S6a/S6d); 2. PurgeMS from IWF to HSS (Gr); 3. PurgeMS Ack from HSS to IWF (Gr); 4. PUA from IWF to MME/SGSN (S6a/S6d).](2ae3eae1bd80a90f192f568ae246a9a6_img.jpg) + +``` +sequenceDiagram + participant MME_SGSN as MME or SGSN or Combined MME/SGSN + participant IWF + participant HSS + Note right of MME_SGSN: S6a/S6d + Note right of IWF: Gr + MME_SGSN->>IWF: 1. PUR + IWF->>HSS: 2. PurgeMS + HSS-->>IWF: 3. PurgeMS Ack + IWF-->>MME_SGSN: 4. PUA +``` + +Sequence diagram showing the mapping of Purge Procedure for a scenario with one IWF. Lifelines: MME or SGSN or Combined MME/SGSN, IWF, and HSS. The sequence is: 1. PUR from MME/SGSN to IWF (S6a/S6d); 2. PurgeMS from IWF to HSS (Gr); 3. PurgeMS Ack from HSS to IWF (Gr); 4. PUA from IWF to MME/SGSN (S6a/S6d). + +**Figure 7.4.1-1: Mapping of Purge Procedure for scenario with one IWF** + +- 1. The IWF receives a PUR message from the MME, SGSN, or combined MME/SGSN. +- 2. The IWF opens a MAP v3 dialogue towards the HSS by sending PurgeMS. +- 3. The IWF receives PurgeMS Ack from the HSS. +- 4. The IWF sends PUA to the MME, SGSN, or combined MME/SGSN. + +### 7.4.2 Two IWFs Scenario + +The mapping of procedures for this scenario is shown in figure 7.4.2-1: + +![Sequence diagram showing the mapping of the Purge Procedure for a scenario with two IWFs. The diagram involves five lifelines: MME or SGSN or Combined MME/SGSN, IWF1, IWF2, HSS, and a Gr interface. The sequence of messages is: 1. PUR from MME/SGSN to IWF1; 2. PurgeMS from IWF1 to IWF2; 3. PUR from IWF2 to HSS; 4. PUA from HSS to IWF2; 5. PurgeMS Ack from IWF2 to IWF1; 6. PUA from IWF1 to MME/SGSN. The S6a/S6d interface is indicated between the MME/SGSN and IWF1, and between IWF2 and HSS.](9c1d3678db4a12d5864cb2a4def1135d_img.jpg) + +``` +sequenceDiagram + participant MME_SGSN as MME or SGSN or Combined MME/SGSN + participant IWF1 + participant IWF2 + participant HSS + Note right of IWF1: Gr + Note right of MME_SGSN: S6a/S6d + Note right of IWF2: S6a/S6d + MME_SGSN->>IWF1: 1. PUR + IWF1->>IWF2: 2. PurgeMS + IWF2->>HSS: 3. PUR + HSS-->>IWF2: 4. PUA + IWF2-->>IWF1: 5. PurgeMS Ack + IWF1-->>MME_SGSN: 6. PUA +``` + +Sequence diagram showing the mapping of the Purge Procedure for a scenario with two IWFs. The diagram involves five lifelines: MME or SGSN or Combined MME/SGSN, IWF1, IWF2, HSS, and a Gr interface. The sequence of messages is: 1. PUR from MME/SGSN to IWF1; 2. PurgeMS from IWF1 to IWF2; 3. PUR from IWF2 to HSS; 4. PUA from HSS to IWF2; 5. PurgeMS Ack from IWF2 to IWF1; 6. PUA from IWF1 to MME/SGSN. The S6a/S6d interface is indicated between the MME/SGSN and IWF1, and between IWF2 and HSS. + +**Figure 7.4.2-1: Mapping of Purge Procedure for scenario with two IWFs** + +1. The IWF1 receives a PUR message from the MME, SGSN, or combined MME/SGSN. +2. The IWF1 opens a MAP v3 dialogue towards IWF2 by sending PurgeMS. +3. The IWF2 constructs a PUR message and sends it to the HSS. +4. The IWF2 receives PUA from the HSS. +5. The IWF2 closes the MAP dialogue with the IWF1 by sending PurgeMS Ack. +6. The IWF1 sends PUA to the MME, SGSN, or combined MME/SGSN. + +## 7.5 Insert Subscriber Data + +### 7.5.1 One IWF Scenario + +The mapping of procedures for this scenario is shown in figure 7.5.1-1: + +![Sequence diagram showing the mapping of Insert Subscriber Data Procedure for scenario with one IWF. The diagram involves three main entities: MME or SGSN or Combined MME/SGSN, IWF, and HSS. The IWF receives a message from the HSS, sends an IDR to the MME/SGSN, receives an IDA from the MME/SGSN, sends an Ack to the HSS, and finally receives an END message from the HSS. Steps 1 to 4 may be repeated several times.](28d75f39a24203712ee907b32cf0bbe5_img.jpg) + +``` +sequenceDiagram + participant HSS + participant IWF + participant MME_SGSN as MME or SGSN or Combined MME/SGSN + + Note right of HSS: Gr + Note left of IWF: S6a/S6d + + HSS->>IWF: 1. InsertSubscriberData/ProvideSubscriberInfo + IWF->>MME_SGSN: 2. IDR + MME_SGSN->>IWF: 3. IDA + IWF->>HSS: 4. InsertSubscriberData/ProvideSubscriberInfo Ack + Note right of HSS: 5. Steps 1 to 4 may be repeated several times for InsertSubscriberData + HSS->>IWF: 6. END +``` + +Sequence diagram showing the mapping of Insert Subscriber Data Procedure for scenario with one IWF. The diagram involves three main entities: MME or SGSN or Combined MME/SGSN, IWF, and HSS. The IWF receives a message from the HSS, sends an IDR to the MME/SGSN, receives an IDA from the MME/SGSN, sends an Ack to the HSS, and finally receives an END message from the HSS. Steps 1 to 4 may be repeated several times. + +**Figure 7.5.1-1: Mapping of Insert Subscriber Data Procedure for scenario with one IWF** + +1. The IWF receives an (stand alone) InsertSubscriberData or ProvideSubscriberInfo message from the HSS. +2. The IWF constructs an IDR message and sends it to the MME, SGSN, or combined MME/SGSN. +3. The IWF receives IDA from the MME, SGSN, or combined MME/SGSN. +4. The IWF sends InsertSubscriberData or ProvideSubscriberInfo Ack to the HSS. +5. Steps 1 to 4 may be repeated several times for InsertSubscriberData. The repetition may be in burst mode or in acknowledge mode. +6. The HSS closes the MAP dialogue. + +NOTE: In a mapping procedure, the IWF correlates the MAP Dialogue ID of the MAP request message and the Diameter Session-ID of the mapped Diameter request message which is to be used in the subsequent mapping from Diameter Answer message to corresponding MAP Ack message. + +### 7.5.2 Two IWFs Scenario + +The mapping of procedures for this scenario is shown in figure 7.5.2-1: + +![Sequence diagram showing the mapping of Insert Subscriber Data Procedure for a scenario with two IWFs. The diagram involves four lifelines: MME or SGSN or Combined MME/SGSN, IWF1, IWF2, and HSS. The sequence of messages is: 1. IDR from HSS to IWF2; 2. InsertSubscriberData/ProvideSubscriberInfo from IWF2 to IWF1; 3. IDR from IWF1 to MME/SGSN; 4. IDA from MME/SGSN to IWF1; 5. InsertSubscriberData/ProvideSubscriberInfo Ack from IWF1 to IWF2; 6. A dashed line indicates steps 2 to 5 may be repeated for InsertSubscriberData; 7. END from IWF2 to IWF1; 8. IDA from IWF2 to HSS. Interfaces S6a/S6d are shown between MME/SGSN and IWF1, and between IWF2 and HSS. The Gr interface is shown between IWF1 and IWF2.](dd5771673aececa53d42ece89218299d_img.jpg) + +``` + +sequenceDiagram + participant HSS + participant IWF2 + participant IWF1 + participant MME_SGSN as MME or SGSN or Combined MME/SGSN + + Note right of HSS: S6a/S6d + Note left of IWF2: Gr + Note right of IWF1: S6a/S6d + + HSS->>IWF2: 1. IDR + IWF2->>IWF1: 2. InsertSubscriberData/ProvideSubscriberInfo + IWF1->>MME_SGSN: 3. IDR + MME_SGSN->>IWF1: 4. IDA + IWF1->>IWF2: 5. InsertSubscriberData/ProvideSubscriberInfo Ack + Note left of IWF1: 6. steps 2 to 5 may be repeated several times for InsertSubscriberData + IWF2->>IWF1: 7. END + IWF2->>HSS: 8. IDA + +``` + +Sequence diagram showing the mapping of Insert Subscriber Data Procedure for a scenario with two IWFs. The diagram involves four lifelines: MME or SGSN or Combined MME/SGSN, IWF1, IWF2, and HSS. The sequence of messages is: 1. IDR from HSS to IWF2; 2. InsertSubscriberData/ProvideSubscriberInfo from IWF2 to IWF1; 3. IDR from IWF1 to MME/SGSN; 4. IDA from MME/SGSN to IWF1; 5. InsertSubscriberData/ProvideSubscriberInfo Ack from IWF1 to IWF2; 6. A dashed line indicates steps 2 to 5 may be repeated for InsertSubscriberData; 7. END from IWF2 to IWF1; 8. IDA from IWF2 to HSS. Interfaces S6a/S6d are shown between MME/SGSN and IWF1, and between IWF2 and HSS. The Gr interface is shown between IWF1 and IWF2. + +**Figure 7.5.2-1: Mapping of Insert Subscriber Data Procedure for scenario with two IWFs** + +1. The IWF2 receives a IDR message from the HSS. +2. The IWF2 opens a MAP v3 dialogue towards IWF1 by sending InsertSubscriberData (if the IDR-Flags AVP within the IDR is not present or the "UE Reachability Request" flag was set in the IDR-Flags AVP within the IDR) or ProvideSubscriberInfo in other cases. If segmentation of the data (on MAP level) is required the IWF2 temporarily stores the data that could not be sent in this step. +3. The IWF1 constructs a IDR message and sends it to the MME, SGSN, or combined MME/SGSN. +4. The IWF1 receives IDA from the MME, SGSN, or combined MME/SGSN. +5. The IWF1 sends InsertSubscriberData or ProvideSubscriberInfo Ack to IWF2. +6. If segmentation is required for InsertSubscriberData, steps 2 to 5 are repeated until all data are sent. Repetition may be in burst mode or in acknowledge mode. +7. IWF2 closes the MAP dialogue with IWF1. +8. IWF2 sends IDA to the HSS. + +NOTE: In a mapping procedure, the IWFs correlates the MAP Dialogue ID of the MAP request message and the Diameter Session-ID of the mapped Diameter request message which is to be used in the subsequent mapping from Diameter Answer message to corresponding MAP Ack message or vice versa. + +## 7.6 Delete Subscriber Data + +### 7.6.1 One IWF Scenario + +The mapping of procedures for this scenario is shown in figure 7.6.1-1: + +![Sequence diagram showing the mapping of Delete Subscriber Data Procedure for scenario with one IWF. The diagram involves three lifelines: MME or SGSN or Combined MME/SGSN, IWF, and HSS. The IWF and HSS are connected via the Gr interface, and the IWF and MME/SGSN are connected via the S6a/S6d interface. The sequence of messages is: 1. DeleteSubscriberData from HSS to IWF; 2. DSR from IWF to MME/SGSN; 3. DSA from MME/SGSN to IWF; 4. DeleteSubscriberData Ack from IWF to HSS.](00504fc688ebcf131ccbeff94dfc9939_img.jpg) + +``` +sequenceDiagram + participant HSS + participant IWF + participant MME_SGSN as MME or SGSN or Combined MME/SGSN + Note right of HSS: Gr + Note left of IWF: S6a/S6d + HSS->>IWF: 1. DeleteSubscriberData + IWF->>MME_SGSN: 2. DSR + MME_SGSN->>IWF: 3. DSA + IWF->>HSS: 4. DeleteSubscriberData Ack +``` + +Sequence diagram showing the mapping of Delete Subscriber Data Procedure for scenario with one IWF. The diagram involves three lifelines: MME or SGSN or Combined MME/SGSN, IWF, and HSS. The IWF and HSS are connected via the Gr interface, and the IWF and MME/SGSN are connected via the S6a/S6d interface. The sequence of messages is: 1. DeleteSubscriberData from HSS to IWF; 2. DSR from IWF to MME/SGSN; 3. DSA from MME/SGSN to IWF; 4. DeleteSubscriberData Ack from IWF to HSS. + +**Figure 7.6.1-1: Mapping of Delete Subscriber Data Procedure for scenario with one IWF** + +1. The IWF receives a DeleteSubscriberData MAP v3 message from the HSS (the IWF shall reject DeleteSubscriberData messages in version <3 and shall initiate version fallback when receiving DeleteSubscriberData messages in versions >3; not shown in figure 7.6.1-1). +2. The IWF sends DSR to the MME or SGSN or combined MME/SGSN. +3. The IWF receives DSA. +4. The IWF closes the MAP dialogue with the HSS by sending DeleteSubscriberData Ack. + +### 7.6.2 Two IWFs Scenario + +The mapping of procedures for this scenario is shown in figure 7.6.2-1: + +![Sequence diagram showing the mapping of Delete Subscriber Data Procedure for a scenario with two IWFs. Lifelines: MME or SGSN or Combined MME/SGSN, IWF1, IWF2, HSS. Messages: 1. DSR (HSS to IWF2), 2. DeleteSubscriberData (IWF2 to IWF1), 3. DSR (IWF1 to MME/SGSN), 4. DSA (MME/SGSN to IWF1), 5. DeleteSubscriberData Ack (IWF1 to IWF2), 6. DSA (IWF2 to HSS). Interfaces S6a/S6d and Gr are indicated.](e05b36c0d46549e681ce6581422c66b2_img.jpg) + +``` +sequenceDiagram + participant HSS + participant IWF2 + participant IWF1 + participant MME_SGSN as MME or SGSN or Combined MME/SGSN + + Note right of HSS: S6a/S6d + Note left of IWF2: Gr + Note right of IWF1: S6a/S6d + + HSS->>IWF2: 1. DSR + IWF2->>IWF1: 2. DeleteSubscriberData + IWF1->>MME_SGSN: 3. DSR + MME_SGSN->>IWF1: 4. DSA + IWF1->>IWF2: 5. DeleteSubscriberData Ack + IWF2->>HSS: 6. DSA +``` + +Sequence diagram showing the mapping of Delete Subscriber Data Procedure for a scenario with two IWFs. Lifelines: MME or SGSN or Combined MME/SGSN, IWF1, IWF2, HSS. Messages: 1. DSR (HSS to IWF2), 2. DeleteSubscriberData (IWF2 to IWF1), 3. DSR (IWF1 to MME/SGSN), 4. DSA (MME/SGSN to IWF1), 5. DeleteSubscriberData Ack (IWF1 to IWF2), 6. DSA (IWF2 to HSS). Interfaces S6a/S6d and Gr are indicated. + +**Figure 7.6.2-1: Mapping of Delete Subscriber Data Procedure for scenario with two IWFs** + +- 1. The IWF2 receives a DSR message from the HSS. +- 2. The IWF2 opens a MAP v3 dialogue towards IWF1 by sending DeleteSubscriberData. +- 3. The IWF1 constructs a DSR message and sends it to the MME, SGSN, or combined MME/SGSN. +- 4. The IWF1 receives DSA from the MME, SGSN or combined MME/SGSN. +- 5. The IWF1 closes the MAP dialogue with the IWF2 by sending DeleteSubscriberData Ack. +- 6. The IWF2 sends DSA to the HSS. + +## 7.7 Reset + +### 7.7.1 One IWF Scenario + +The mapping of procedures for this scenario is shown in figure 7.7.1-1: + +![Sequence diagram for Figure 7.7.1-1: Mapping of Reset Procedure for scenario with one IWF. Lifelines: MME or SGSN or Combined MME/SGSN, IWF, HSS. Interfaces: S6a/S6d between MME/SGSN and IWF, Gr between IWF and HSS. Sequence: 1. Reset from HSS to IWF; 2. RSR from IWF to MME/SGSN; 3. RSA from MME/SGSN to IWF.](b5335262987c819d7f71ce40f99cb71b_img.jpg) + +``` +sequenceDiagram + participant HSS + participant IWF + participant MME_SGSN as MME or SGSN or Combined MME/SGSN + Note right of HSS: Gr + Note left of IWF: S6a/S6d + HSS->>IWF: 1. Reset + IWF->>MME_SGSN: 2. RSR + MME_SGSN->>IWF: 3. RSA +``` + +Sequence diagram for Figure 7.7.1-1: Mapping of Reset Procedure for scenario with one IWF. Lifelines: MME or SGSN or Combined MME/SGSN, IWF, HSS. Interfaces: S6a/S6d between MME/SGSN and IWF, Gr between IWF and HSS. Sequence: 1. Reset from HSS to IWF; 2. RSR from IWF to MME/SGSN; 3. RSA from MME/SGSN to IWF. + +**Figure 7.7.1-1: Mapping of Reset Procedure for scenario with one IWF** + +1. The IWF receives a Reset MAP v1 or v2 message from the HSS. +2. The IWF sends RSR to the MME or SGSN or combined MME/SGSN. +3. The IWF receives RSA. + +### 7.7.2 Two IWFs Scenario + +The mapping of procedures for this scenario is shown in figure 7.7.2-1: + +![Sequence diagram for Figure 7.7.2-1: Mapping of Reset Procedure for scenario with two IWFs. Lifelines: MME or SGSN or Combined MME/SGSN, IWF1, IWF2, HSS. Interfaces: S6a/S6d between MME/SGSN and IWF1, Gr between IWF1 and IWF2, S6a/S6d between IWF2 and HSS. Sequence: 1. RSR from HSS to IWF2; 2. Reset from IWF2 to IWF1; 3. RSA from IWF2 to HSS; 4. RSR from IWF1 to MME/SGSN; 5. RSA from MME/SGSN to IWF1.](1b893df61c2b73b7a85e65fc1f58e203_img.jpg) + +``` +sequenceDiagram + participant HSS + participant IWF2 + participant IWF1 + participant MME_SGSN as MME or SGSN or Combined MME/SGSN + Note right of HSS: S6a/S6d + Note left of IWF2: Gr + Note right of IWF1: S6a/S6d + HSS->>IWF2: 1. RSR + IWF2->>IWF1: 2. Reset + IWF2->>HSS: 3. RSA + IWF1->>MME_SGSN: 4. RSR + MME_SGSN->>IWF1: 5. RSA +``` + +Sequence diagram for Figure 7.7.2-1: Mapping of Reset Procedure for scenario with two IWFs. Lifelines: MME or SGSN or Combined MME/SGSN, IWF1, IWF2, HSS. Interfaces: S6a/S6d between MME/SGSN and IWF1, Gr between IWF1 and IWF2, S6a/S6d between IWF2 and HSS. Sequence: 1. RSR from HSS to IWF2; 2. Reset from IWF2 to IWF1; 3. RSA from IWF2 to HSS; 4. RSR from IWF1 to MME/SGSN; 5. RSA from MME/SGSN to IWF1. + +**Figure 7.7.2-1: Mapping of Reset Procedure for scenario with two IWFs** + +1. The IWF2 receives a RSR message from the HSS. +2. The IWF2 opens a MAP v1 or v2 (vendor option) dialogue towards IWF1 by sending Reset. +3. The IWF2 sends RSA to the HSS. +4. The IWF1 constructs a RSR message and sends it to the MME, SGSN, or combined MME/SGSN. +5. The IWF1 receives RSA from the MME, SGSN or combined MME/SGSN. + +## 7.8 Notification + +### 7.8.1 One IWF Scenario + +The mapping of procedures for this scenario is shown in figure 7.8.1-1: + +![Sequence diagram for the One IWF Scenario. Lifelines: MME or SGSN or Combined MME/SGSN, IWF, and HSS. The diagram shows five steps: 1. NOR from MME/SGSN to IWF; 2. UpdateGprsLocation from IWF to HSS; 3. NOA from IWF to MME/SGSN; 4. dialogue continuation between IWF and HSS; 5. UpdateGprsLocation Ack from HSS to IWF. Interfaces S6a/S6d and Gr are indicated.](a1890b9a9b85f13e67ed59bbad623659_img.jpg) + +``` +sequenceDiagram + participant MME_SGSN as MME or SGSN or Combined MME/SGSN + participant IWF + participant HSS + Note right of MME_SGSN: S6a/S6d + Note right of IWF: Gr + MME_SGSN->>IWF: 1. NOR + IWF->>HSS: 2. UpdateGprsLocation + IWF->>MME_SGSN: 3. NOA + IWF-->>HSS: 4. dialogue continuation + HSS->>IWF: 5. UpdateGprsLocation Ack +``` + +Sequence diagram for the One IWF Scenario. Lifelines: MME or SGSN or Combined MME/SGSN, IWF, and HSS. The diagram shows five steps: 1. NOR from MME/SGSN to IWF; 2. UpdateGprsLocation from IWF to HSS; 3. NOA from IWF to MME/SGSN; 4. dialogue continuation between IWF and HSS; 5. UpdateGprsLocation Ack from HSS to IWF. Interfaces S6a/S6d and Gr are indicated. + +**Figure 7.8.1-1: Mapping of Notification Procedure for scenario with one IWF** + +1. The IWF receives a NOR message from the MME, SGSN, or combined MME/SGSN. +2. The IWF sends UpdateGprsLocation or ReadyForSM to the HSS. +3. The IWF sends NOA to the MME, SGSN, or combined MME/SGSN. +4. The HSS (if it does not support the "skip subscriber data" indication) may continue the MAP dialogue by sending InsertSubscriberData messages which are positively acknowledged and discarded by the IWF. +5. The HSS closes the MAP dialogue by sending UpdateGprsLocation Ack or ReadyForSM Ack. + +### 7.8.2 Two IWFs Scenario + +The mapping of procedures for this scenario is shown in figure 7.8.2-1: + +![Sequence diagram showing the mapping of Notification Procedure for a scenario with two IWFs. The diagram involves four lifelines: MME or SGSN or Combined MME/SGSN, IWF1, IWF2, and HSS. The sequence of messages is: 1. NOR from MME/SGSN to IWF1; 2. UpdateGprsLocation from IWF1 to IWF2; 3. NOA from IWF1 to MME/SGSN; 4. NOR from IWF2 to HSS; 5. UpdateGprsLocation Ack from IWF2 to IWF1; 6. NOA from HSS to IWF2. The interfaces S6a/S6d and Gr are indicated above the message arrows.](6e15fc9ea763541c5913d26f85072ae1_img.jpg) + +``` +sequenceDiagram + participant MME_SGSN as MME or SGSN or Combined MME/SGSN + participant IWF1 + participant IWF2 + participant HSS + Note right of MME_SGSN: S6a/S6d + Note right of IWF1: Gr + Note right of IWF2: S6a/S6d + MME_SGSN->>IWF1: 1. NOR + IWF1->>IWF2: 2. UpdateGprsLocation + IWF1->>MME_SGSN: 3. NOA + IWF2->>HSS: 4. NOR + IWF2->>IWF1: 5. UpdateGprsLocation Ack + HSS->>IWF2: 6. NOA +``` + +Sequence diagram showing the mapping of Notification Procedure for a scenario with two IWFs. The diagram involves four lifelines: MME or SGSN or Combined MME/SGSN, IWF1, IWF2, and HSS. The sequence of messages is: 1. NOR from MME/SGSN to IWF1; 2. UpdateGprsLocation from IWF1 to IWF2; 3. NOA from IWF1 to MME/SGSN; 4. NOR from IWF2 to HSS; 5. UpdateGprsLocation Ack from IWF2 to IWF1; 6. NOA from HSS to IWF2. The interfaces S6a/S6d and Gr are indicated above the message arrows. + +**Figure 7.8.2-1: Mapping of Notification Procedure for scenario with two IWFs** + +1. The IWF1 receives a NOR message from the MME, SGSN, or combined MME/SGSN. +2. The IWF1 sends UpdateGprsLocation or ReadyForSM to the IWF2. +3. The IWF1 sends NOA to the MME, SGSN, or combined MME/SGSN. +4. The IWF2 sends NOR to the HSS. +5. The IWF2 closes the MAP dialogue with IWF1 by sending UpdateGprsLocation Ack or ReadyForSM Ack. +6. The IWF2 receives NOA from the HSS. + +## 7.9 IMEI Check + +### 7.9.1 One IWF Scenario + +The mapping of procedures for this scenario is shown in figure 7.9.1-1: + +![Sequence diagram showing the mapping of IMEI Check Procedure with one IWF. Lifelines: MME or SGSN or Combined MME/SGSN, IWF, and EIR. The sequence is: 1. ECR from MME/SGSN to IWF (S13/S13' interface); 2. Check IMEI from IWF to EIR (Gf interface); 3. Check IMEI Ack from EIR to IWF; 4. ECA from IWF to MME/SGSN.](2837ffdadcdb1e5bababa56b564e56ed_img.jpg) + +``` +sequenceDiagram + participant MME or SGSN or Combined MME/SGSN + participant IWF + participant EIR + Note right of MME or SGSN or Combined MME/SGSN: S13/S13' + Note right of IWF: Gf + MME or SGSN or Combined MME/SGSN->>IWF: 1. ECR + IWF->>EIR: 2. Check IMEI + EIR-->>IWF: 3. Check IMEI Ack + IWF-->>MME or SGSN or Combined MME/SGSN: 4. ECA +``` + +Sequence diagram showing the mapping of IMEI Check Procedure with one IWF. Lifelines: MME or SGSN or Combined MME/SGSN, IWF, and EIR. The sequence is: 1. ECR from MME/SGSN to IWF (S13/S13' interface); 2. Check IMEI from IWF to EIR (Gf interface); 3. Check IMEI Ack from EIR to IWF; 4. ECA from IWF to MME/SGSN. + +**Figure 7.9.1-1: Mapping of IMEI Check Procedure with one IWF** + +- 1. The IWF receives an ECR message from the MME/SGSN. +- 2. The IWF sends Check IMEI to the EIR. +- 3. The IWF receives Check IMEI Ack from the EIR. +- 4. The IWF sends ECA to the MME/SGSN. + +## 7.10 Trace Activation + +### 7.10.1 One IWF Scenario + +The mapping of procedures for this scenario is shown in figure 7.10.1-1: + +![Sequence diagram showing the mapping of Trace Activation Procedure for scenario with one IWF. Lifelines: MME or SGSN or Combined MME/SGSN, IWF, HSS. Messages: 1. ActivateTraceMode (HSS to IWF), 2. IDR (IWF to MME/SGSN), 3. IDA (MME/SGSN to IWF), 4. ActivateTraceMode Ack (IWF to HSS). Interfaces S6a/S6d and Gr are indicated.](78ff716475b2f65bf01c3a4d02d89fc4_img.jpg) + +``` +sequenceDiagram + participant HSS + participant IWF + participant MME_SGSN as MME or SGSN or Combined MME/SGSN + Note right of HSS: Gr + Note left of IWF: S6a/S6d + HSS->>IWF: 1. ActivateTraceMode + IWF->>MME_SGSN: 2. IDR + MME_SGSN->>IWF: 3. IDA + IWF->>HSS: 4. ActivateTraceMode Ack +``` + +Sequence diagram showing the mapping of Trace Activation Procedure for scenario with one IWF. Lifelines: MME or SGSN or Combined MME/SGSN, IWF, HSS. Messages: 1. ActivateTraceMode (HSS to IWF), 2. IDR (IWF to MME/SGSN), 3. IDA (MME/SGSN to IWF), 4. ActivateTraceMode Ack (IWF to HSS). Interfaces S6a/S6d and Gr are indicated. + +**Figure 7.10.1-1: Mapping of Trace Activation Procedure for scenario with one IWF** + +- 1. The IWF receives an ActivateTraceMode message from the HSS. +- 2. The IWF shall construct an IDR message and send it to the MME, SGSN, or combined MME/SGSN. +- 3. The IWF receives IDA from the MME, SGSN, or combined MME/SGSN. +- 4. The IWF shall send an ActivateTraceMode Ack to the HSS. + +### 7.10.2 Two IWFs Scenario + +![Sequence diagram for Trace Activation Procedure with two IWFs. Lifelines: MME or SGSN or Combined MME/SGSN, IWF1, IWF2, HSS. Interfaces: S6a/S6d between MME/SGSN and IWF1, Gr between IWF1 and IWF2, S6a/S6d between IWF2 and HSS. Sequence: 1. IDR from HSS to IWF2; 2. ActivateTraceMode from IWF2 to IWF1; 3. IDR from IWF1 to MME/SGSN; 4. IDA from MME/SGSN to IWF1; 5. ActivateTraceMode Ack from IWF1 to IWF2; 6. IDA from IWF2 to HSS.](04cfca33e3fc26513abe649d7474f733_img.jpg) + +``` +sequenceDiagram + participant HSS + participant IWF2 + participant IWF1 + participant MME_SGSN as MME or SGSN or Combined MME/SGSN + + Note right of HSS: S6a/S6d + Note right of IWF2: Gr + Note right of IWF1: S6a/S6d + + HSS->>IWF2: 1. IDR + IWF2->>IWF1: 2. ActivateTraceMode + IWF1->>MME_SGSN: 3. IDR + MME_SGSN->>IWF1: 4. IDA + IWF1->>IWF2: 5. ActivateTraceMode Ack + IWF2->>HSS: 6. IDA +``` + +Sequence diagram for Trace Activation Procedure with two IWFs. Lifelines: MME or SGSN or Combined MME/SGSN, IWF1, IWF2, HSS. Interfaces: S6a/S6d between MME/SGSN and IWF1, Gr between IWF1 and IWF2, S6a/S6d between IWF2 and HSS. Sequence: 1. IDR from HSS to IWF2; 2. ActivateTraceMode from IWF2 to IWF1; 3. IDR from IWF1 to MME/SGSN; 4. IDA from MME/SGSN to IWF1; 5. ActivateTraceMode Ack from IWF1 to IWF2; 6. IDA from IWF2 to HSS. + +**Figure 7.10.2-1: Mapping of Trace Activation Procedure for scenario with two IWFs** + +1. The IWF2 receives an IDR message from the HSS. +2. If the IWF2 finds that Trace Data is included in the IDR, it shall open a MAP v3 dialogue towards IWF1 by sending ActivateTraceMode. +3. The IWF1 shall construct an IDR message and shall send it to the MME, SGSN, or combined MME/SGSN. +4. The IWF1 receives IDA from the MME, SGSN, or combined MME/SGSN. +5. The IWF1 shall send an ActivateTraceMode Ack to IWF2. +6. IWF2 shall send an IDA to the HSS. + +## 7.11 Trace Deactivation + +### 7.11.1 One IWF Scenario + +The mapping of procedures for this scenario is shown in figure 7.11.1-1: + +![Sequence diagram showing the mapping of Trace Deactivation Procedure for scenario with one IWF. Lifelines: MME or SGSN or Combined MME/SGSN, IWF, HSS. Messages: 1. DeactivateTraceMode (HSS to IWF), 2. DSR (IWF to MME/SGSN), 3. DSA (MME/SGSN to IWF), 4. DeactivateTraceMode Ack (IWF to HSS). Interfaces S6a/S6d and Gr are indicated.](9f6dec4d4e9fde40bce018861ef1278e_img.jpg) + +``` +sequenceDiagram + participant HSS + participant IWF + participant MME_SGSN as MME or SGSN or Combined MME/SGSN + Note right of HSS: Gr + Note left of IWF: S6a/S6d + HSS->>IWF: 1. DeactivateTraceMode + IWF->>MME_SGSN: 2. DSR + MME_SGSN->>IWF: 3. DSA + IWF->>HSS: 4. DeactivateTraceMode Ack +``` + +Sequence diagram showing the mapping of Trace Deactivation Procedure for scenario with one IWF. Lifelines: MME or SGSN or Combined MME/SGSN, IWF, HSS. Messages: 1. DeactivateTraceMode (HSS to IWF), 2. DSR (IWF to MME/SGSN), 3. DSA (MME/SGSN to IWF), 4. DeactivateTraceMode Ack (IWF to HSS). Interfaces S6a/S6d and Gr are indicated. + +**Figure 7.11.1-1: Mapping of Trace Deactivation Procedure for scenario with one IWF** + +- 1. The IWF receives a DeactivateTraceMode message from the HSS. +- 2. The IWF shall construct a DSR message and shall send it to the MME, SGSN, or the combined MME/SGSN. +- 3. The IWF receives DSA from the MME, SGSN, or combined MME/SGSN. +- 4. The IWF shall send a DeactivateTraceMode Ack to the HSS. + +### 7.11.2 Two IWFs Scenario + +![Sequence diagram illustrating the Mapping of Trace Deactivation Procedure for scenario with two IWFs. The diagram shows interactions between MME or SGSN or Combined MME/SGSN, IWF1, IWF2, and HSS. The sequence of messages is: 1. DSR from HSS to IWF2; 2. DeactivateTraceMode from IWF2 to IWF1; 3. DSR from IWF1 to MME/SGSN; 4. DSA from MME/SGSN to IWF1; 5. DeactivateTraceMode Ack from IWF1 to IWF2; 6. DSA from IWF2 to HSS. Interfaces S6a/S6d and Gr are indicated above the participants.](f5deee2f3301ee351c4008283ffafbb3_img.jpg) + +``` + +sequenceDiagram + participant HSS + participant IWF2 + participant IWF1 + participant MME_SGSN as MME or SGSN or Combined MME/SGSN + + Note right of HSS: S6a/S6d + Note left of IWF2: Gr + Note right of IWF1: S6a/S6d + + HSS->>IWF2: 1. DSR + IWF2->>IWF1: 2. DeactivateTraceMode + IWF1->>MME_SGSN: 3. DSR + MME_SGSN->>IWF1: 4. DSA + IWF1->>IWF2: 5. DeactivateTraceMode Ack + IWF2->>HSS: 6. DSA + +``` + +Sequence diagram illustrating the Mapping of Trace Deactivation Procedure for scenario with two IWFs. The diagram shows interactions between MME or SGSN or Combined MME/SGSN, IWF1, IWF2, and HSS. The sequence of messages is: 1. DSR from HSS to IWF2; 2. DeactivateTraceMode from IWF2 to IWF1; 3. DSR from IWF1 to MME/SGSN; 4. DSA from MME/SGSN to IWF1; 5. DeactivateTraceMode Ack from IWF1 to IWF2; 6. DSA from IWF2 to HSS. Interfaces S6a/S6d and Gr are indicated above the participants. + +**Figure 7.11.2-1: Mapping of Trace Deactivation Procedure for scenario with two IWFs** + +1. The IWF2 receives a DSR message from the HSS. +2. If the IWF2 finds that a Trace Data Withdrawal indication is included in the DSR, it shall open a MAP v3 dialogue towards IWF1 by sending DeactivateTraceMode. +3. The IWF1 shall construct a DSR message and shall send it to the MME, SGSN, or the combined MME/SGSN. +4. The IWF1 receives DSA from the MME, SGSN, or combined MME/SGSN. +5. The IWF1 shall send a DeactivateTraceMode Ack to the IWF2. +6. The IWF2 shall send a DSA to the HSS. + +# 8 The Mapping of the Parameters + +## 8.1 Mapping of Parameters for the Authentication Info Retrieval Procedure + +### 8.1.1 AIR mapping to SendAuthenticationInfoArg (v3) + +When the IWF needs to construct a MAP-SendAuthenticationInfo message as a result of receiving an AIR command (see sections 7.1.1 step 2, and 7.1.2 step 2), the IWF shall open a MAP dialogue in application context version 3 and populate sub-parameters of SendAuthenticationInfoArg as described below: + +**imsi** in SendAuthenticationInfoArg shall be populated with the value of the User-Name AVP received within AIR. + +If AIR contains a Requested-EUTRAN-Authentication-Info AVP but does not contain a Requested-UTRAN-GERAN-Authentication-Info AVP: + +**numberOfRequestedVectors** in SendAuthenticationInfoArg shall be populated with the value of the Number-Of-Requested-Vectors AVP received within the Requested-EUTRAN-Authentication-Info AVP received within AIR. + +If AIR contains a Requested-UTRAN-GERAN-Authentication-Info AVP but does not contain a Requested-EUTRAN-Authentication-Info AVP: + +**numberOfRequestedVectors** in SendAuthenticationInfoArg shall be populated with the value of the Number-Of-Requested-Vectors AVP received within the Requested-UTRAN-GERAN-Authentication-Info AVP received within AIR. + +If AIR contains a Requested-EUTRAN-Authentication-Info AVP and a Requested-UTRAN-GERAN-Authentication-Info AVP, and the Immediate-Response-Preferred AVP is present within the Requested-EUTRAN-Authentication-Info AVP: + +**numberOfRequestedVectors** in SendAuthenticationInfoArg shall be populated with the value of the Number-Of-Requested-Vectors AVP received within the Requested-EUTRAN-Authentication-Info AVP received within AIR. + +If AIR contains a Requested-EUTRAN-Authentication-Info AVP and a Requested-UTRAN-GERAN-Authentication-Info AVP, and the Immediate-Response-Preferred AVP is not present within the Requested-EUTRAN-Authentication-Info AVP: + +**numberOfRequestedVectors** in SendAuthenticationInfoArg shall be populated with the value of the Number-Of-Requested-Vectors AVP received within the Requested-UTRAN-GERAN-Authentication-Info AVP received within AIR. + +**segmentationProhibited** shall be absent in SentAuthenticationInfoArg. + +If AIR contains a Requested-EUTRAN-Authentication-Info AVP but does not contain a Requested-UTRAN-GERAN-Authentication-Info AVP: + +**immediateResponsePreferred** in SendAuthenticationInfoArg shall be present if and only if the Immediate-Response-Preferred AVP is present within the Requested-EUTRAN-Authentication-Info AVP within AIR. + +If AIR contains a Requested-UTRAN-GERAN-Authentication-Info AVP but does not contain a Requested-EUTRAN-Authentication-Info AVP: + +**immediateResponsePreferred** in SendAuthenticationInfoArg shall be present if and only if the Immediate-Response-Preferred AVP is present within the Requested-UTRAN-GERAN-Authentication-Info AVP within AIR. + +If AIR contains a Requested-EUTRAN-Authentication-Info AVP and a Requested-UTRAN-GERAN-Authentication-Info AVP: + +**immediateResponsePreferred** in SendAuthenticationInfoArg shall be present if and only if the Immediate-Response-Preferred AVP is present within the Requested-UTRAN-GERAN-Authentication-Info AVP or within the Requested-EUTRAN-Authentication-Info AVP within AIR. + +**re-synchronisationInfo** in SendAuthenticationInfoArg shall be present if and only if a Re-synchronization-Info AVP is present within the Requested-EUTRAN-Authentication-Info AVP or within the Requested-UTRAN-GERAN-Authentication-Info AVP within AIR. + +**extensionContainer** in SendAuthenticationInfoArg shall be absent. + +**requestingNodeType** in SendAuthenticationInfoArg shall be present and shall be populated with the value +"mme" if a Requested-EUTRAN-Authentication-Info AVP and no Requested-UTRAN-GERAN-Authentication-Info AVP was present within AIR; +"sgsn" if a Requested-UTRAN-GERAN-Authentication-Info AVP and no Requested EUTRAN-Authentication-Info AVP was present within AIR; +. "mme-sgsn" if both a Requested-EUTRAN-Authentication-Info AVP and a Requested-UTRAN-GERAN-Authentication-Info AVP were present within AIR . + +**requestingPLMN-Id** in SendAuthenticationInfoArg shall be present and shall be populated with the value received within the Visited-PLMN-ID AVP within AIR. + +**numberOfRequestedAdditional-Vectors** in SendAuthenticationInfoArg shall be present if and only if both a Requested-EUTRAN-Authentication-Info AVP and a Requested-UTRAN-GERAN-Authentication-Info AVP are present within AIR. If present, the parameter shall be populated with the value received in the Number-Of-Requested-Vectors AVP within the Requested-EUTRAN-Authentication-Info (if the Immediate-Response-Preferred AVP is absent + +within Requested-EUTRAN-Authentication-Info AVP within AIR) or with the value received in the Number-Of-Requested-Vectors AVP within the Requested-UTRAN-GERAN-Authentication-Info AVP (otherwise). + +**additionalVectorsAreForEPS** shall be present in SendAuthenticationInfoArg if and only if a Requested-EUTRAN-Authentication-Info AVP and a Requested-UTRAN-GERAN-Authentication-Info AVP are present within AIR and the Immediate-Response-Preferred AVP is absent in the Requested-EUTRAN-Authentication-Info AVP. + +### 8.1.2 AIR mapping to SendAuthenticationInfoArg (v2) + +When the IWF needs to construct a MAP-SendAuthenticationInfo message in MAP AC version 2 as a result of MAP version negotiation (see sections 7.1.1 step 3), the IWF shall open a MAP dialogue in application context version 2 and populate sub-parameters of SendAuthenticationInfoArg as described below: + +**imsi** in SendAuthenticationInfoArg shall be populated with the value of the User-Name AVP received within AIR. + +### 8.1.3 AIR mapping to SendParametersArg (v1) + +When the IWF needs to construct a MAP-SendParameters message in MAP AC version 1 as a result of MAP version negotiation (see section 7.1.1 step 3), the IWF shall open a MAP dialogue in application context version 1 and populate sub-parameters of SendParametersArg as described below: + +**subscriberId** in SendParametersArg shall take the imsi alternative; imsi shall be populated with the value of the User-Name AVP received within AIR. + +**requestedParameterList** in SendParametersArg shall contain one RequestParameter which contains the value of "requestAuthenticationSet". + +### 8.1.4 SendAuthenticationInfoRes / Error (v3) mapping to AIA + +When the IWF needs to construct an AIA command as a result of receiving a SendAuthenticationInfo Ack/Error message in MAP version 3 (see sections 7.1.1 step 5, and 7.1.2 step 7), the IWF shall populate AVPs of AIA as described below: + +**Result-Code / Experimental-Result** AVP shall be set to: + +- DIAMETER\_SUCCESS if a SendAuthenticationInfoRes parameter was received in a TCAP ResultLast component; +- DIAMETER\_ERROR\_USER\_UNKNOWN if an error of unknownSubscriber without a diagnostic parameter or with a diagnostic parameter of imsiUnknown was received; +- DIAMETER\_ERROR\_UNKNOWN\_SUBSCRIPTION if an error unknownSubscriber with a diagnostic parameter of gprs-eps-SubscriptionUnknown was received; +- an appropriate DIAMETER base protocol result code otherwise. + +**Auth-Session-State** AVP shall be set to the value NO\_STATE\_MAINTAINED (1). + +**Supported-Features** AVP shall be absent. + +**Authentication-Info** AVP shall be present if authenticationSetList or eps-AuthenticationSetList is present in the received SendAuthenticationInfoRes. If present, the AVP shall contain EPS-Vector AVPs and/or either UTRAN-Vector AVPs or GERAN-Vector AVPs as mapped from received EPC-AVs and/or either AuthenticationQuintuplets or AuthenticationTriplets respectively. + +### 8.1.5 SendAuthenticationInfoRes / Error (v2) mapping to AIA + +When the IWF needs to construct an AIA command as a result of receiving a SendAuthenticationInfo Ack/Error message in MAP version 2 (see sections 7.1.1 step 5), the IWF shall populate AVPs of AIA as described below: + +**Result-Code / Experimental-Result** AVP shall be set to: + +- DIAMETER\_SUCCESS if a SendAuthenticationInfoRes parameter was received in a TCAP ResultLast component; + +- DIAMETER\_ERROR\_USER\_UNKNOWN if an error of unknownSubscriber without a diagnostic parameter or with a diagnostic parameter of imsiUnknown was received; +- DIAMETER\_ERROR\_UNKNOWN\_SUBSCRIPTION if an error unknownSubscriber with a diagnostic parameter of gprsSubscriptionUnknown was received; +- an appropriate DIAMETER base protocol result code otherwise. + +**Auth-Session-State** AVP shall be set to the value NO\_STATE\_MAINTAINED (1). + +**Supported-Features** AVP shall be absent. + +**Authentication-Info** AVP shall be present if authenticationSetList is present in the received SendAuthenticationInfoRes. If present, the AVP shall contain GERAN-Vector AVPs as mapped from received AuthenticationTriplets. + +### 8.1.6 SendParameterList / Error (v1) mapping to AIA + +When the IWF needs to construct an AIA command as a result of receiving a SendParameters Ack/Error message in MAP version 1 (see sections 7.1.1 step 5), the IWF shall populate AVPs of AIA as described below: + +**Result-Code / Experimental-Result** AVP shall be set to: + +DIAMETER\_SUCCESS if a SentParameterList parameter was received in a TCAP ResultLast component; + +DIAMETER\_ERROR\_USER\_UNKNOWN if an error of unknownSubscriber was received; + +an appropriate DIAMETER base protocol result code otherwise. + +**Auth-Session-State** AVP shall be set to the value NO\_STATE\_MAINTAINED (1). + +**Supported-Features** AVP shall be absent. + +**Authentication-Info** AVP shall be present if sentParameterList is present in the received TCAP ResultLast component. If present, the AVP shall contain GERAN-Vector AVPs as mapped from received AuthenticationTriplets. + +### 8.1.7 SendAuthenticationInfoArg (v3) mapping to AIR + +When the IWF needs to construct an AIR command as a result of receiving a SendAuthenticationInfo message in MAP version 3 (see sections 7.1.2 step 3), the IWF shall populate AVPs of AIR as described below: + +**Auth-Session-State** AVP shall be set to the value NO\_STATE\_MAINTAINED (1). + +**User-Name** AVP shall be populated with the value received within the imsi parameter of SendAuthenticationInfoArg. + +**Supported-Features** AVP shall be absent. + +**Requested-EUTRAN-Authentication-Info** AVP shall be present if requestingNodeType parameter within SendAuthenticationInfoArg takes the value of "mme" or "mme-sgsn". + +**Number-Of-Requested-Vectors** AVP within Requested-EUTRAN-Authentication-Info AVP (if present) shall be populated with + +- a) the value received within the numberOfRequestedVectors parameter of SendAuthenticationInfoArg if requestingNodeType parameter within SendAuthenticationInfoArg takes the value of "mme"; +- b) the value received within the numberOfRequestedVectors parameter of SendAuthenticationInfoArg if requestingNodeType parameter within SendAuthenticationInfoArg takes the value of "mme-sgsn" and the additionalVectorsAreForEPS parameter is absent from SendAuthenticationInfoArg; +- c) the value received within the numberOfRequestedAdditional-Vectors parameter of SendAuthenticationInfoArg if requestingNodeType parameter within SendAuthenticationInfoArg takes the value of "mme-sgsn" and the additionalVectorsAreForEPS parameter is present within SendAuthenticationInfoArg. + +**Immediate-Response-Preferred** AVP within Requested-EUTRAN-Authentication-Info AVP (if present) shall be present if: + +- a) requestingNodeType parameter within SendAuthenticationInfoArg takes the value of "mme" and immediateResponsePreferred parameter is present in SendAuthenticationInfoArg, or +- b) requestingNodeType parameter within SendAuthenticationInfoArg takes the value of "mme-sgsn" and additionalVectorsAreForEPS parameter is absent from SendAuthenticationInfoArg and immediateResponsePreferred is present within SendAuthenticationInfoArg. + +**Re-synchronization-Info** AVP within Requested-EUTRAN-Authentication-Info AVP (if present) shall be populated with the value received in the re-synchronizationInfo parameter within SendAuthenticationInfoArg. + +**Requested-UTRAN-GERAN-Authentication-Info** AVP shall be present if requestingNodeType parameter within SendAuthenticationInfoArg takes the value of "sgsn" or "mme-sgsn". + +**Number-Of-Requested-Vectors** AVP within Requested-UTRAN-GERAN-Authentication-Info AVP (if present) shall be populated with: + +- a) the value received within the numberOfRequestedVectors parameter of SendAuthenticationInfoArg if requestingNodeType parameter within SendAuthenticationInfoArg takes the value of "sgsn"; +- b) the value received within the numberOfRequestedVectors parameter of SendAuthenticationInfoArg if requestingNodeType parameter within SendAuthenticationInfoArg takes the value of "mme-sgsn" and the additionalVectorsAreForEPS parameter is present within SendAuthenticationInfoArg; +- c) the value received within the numberOfRequestedAdditional-Vectors parameter of SendAuthenticationInfoArg if requestingNodeType parameter within SendAuthenticationInfoArg takes the value of "mme-sgsn" and the additionalVectorsAreForEPS parameter is absent from SendAuthenticationInfoArg. + +**Immediate-Response-Preferred** AVP within Requested-UTRAN-GERAN-Authentication-Info AVP (if present) shall be present if + +- a) requestingNodeType parameter within SendAuthenticationInfoArg takes the value of "sgsn" and immediateResponsePreferred parameter is present in SendAuthenticationInfoArg, or +- b) requestingNodeType parameter within SendAuthenticationInfoArg takes the value of "mme-sgsn" and additionalVectorsAreForEPS parameter is present from SendAuthenticationInfoArg and immediateResponsePreferred is present within SendAuthenticationInfoArg. + +**Re-synchronization-Info** AVP within Requested-EUTRAN-Authentication-Info AVP (if present) shall be populated with the value received in the re-synchronizationInfo parameter within SendAuthenticationInfoArg. + +**Visited-PLMN-Id** AVP shall be populated with the value of the requestingPLMN-Id parameter received within SendAuthenticationInfoArg. + +**RequestingNodeType** AVP shall be populated with the value of the requestingNodeType parameter received within SendAuthenticationInfoArg. + +### 8.1.8 AIA mapping to SendAuthenticationInfoRes/Error (v3) + +When the IWF needs to construct a MAP SendAuthenticationInfo Ack message (v3) as a result of receiving an AIA command (see sections 7.1.2 steps 5 and 6), the IWF shall construct partial result messages (if segmentation is required) and a final result message or an error message (if the Result-Code AVP within AIA takes a value different from "success"). Sub-parameters of SendAuthenticationInfoRes shall be populated as described below: + +**authenticationSetList** within SendAuthenticationInfoRes shall be present if UTRAN-Vector AVP or GERAN-Vector AVP is present in Authentication-Info AVP within AIA. If so the parameter shall be populated with the value received within the UTRAN-Vector AVP or GERAN-Vector AVP (whichever is present). + +**eps-AuthenticationSetList** within SendAuthenticationInfoRes shall be present if EPS-Vector AVP is present in Authentication-Info AVP within AIA. If so the parameter shall be populated with the values received within the EPS-Vector AVP. + +An error of **unknownSubscriber** with unknownSubscriberParam containing a unknownSubscriberDiagnostic of "imsiUnknown" shall be sent if the received AIA command contains an Experimental-Result AVP with a value of "User Unknown". + +An error of **unknownSubscriber** with unknownSubscriberParam containing a unknownSubscriberDiagnostic of "gprs-epsSubscriptionUnknown" shall be sent if the received AIA command contains an Experimental-Result AVP with a value of "Unknown EPS Subscription". + +Other values within the Result-Code / Experimental-Result AVP shall be mapped onto an appropriate MAP error. + +## 8.2 Mapping of Parameters for the Update Location Procedure + +### 8.2.1 ULR mapping to UpdateGprsLocationArg + +When the IWF needs to construct a MAP-UpdateGprsLocation message as a result of receiving an ULR command (see sections 7.2.1 step 2, and 7.2.2 step 2), the IWF shall open a MAP dialogue in application context version 3 and populate sub-parameters of UpdateGprsLocationArg as described below: + +**imsi** in UpdateGprsLocationArg shall be populated with the value of the User-Name AVP received within ULR. + +**sgsn-Number** in UpdateGprsLocationArg shall be populated with the value of the SGSN.Number AVP if present within ULR, otherwise it shall be populated with a value locally assigned to the IWF and consistent with SS7 routing principles. + +**sgsn-Address** in UpdateGprsLocationArg shall be populated with the IP-address of the source node sending the ULR command. + +**extensionContainer** in UpdateGprsLocationArg shall be absent. + +**sgsn-Capability** in UpdateGprsLocationArg shall be populated as follows: + +- solsaSupportIndicator shall be absent; +- extensionContainer shall be absent; +- superChargerSupportedInServingNetworkEntity shall be absent; +- gprsEnhancementSupportIndicator shall be present; +- supportedCamelPhases shall be absent or shall indicate no support of any CAMEL phase; +- supportedLCS-CapabilitySet shall be absent or shall indicate no support of any LCS capability set; +- offeredCamel4CSIs shall be absent; +- smsCallBarringSupportIndicator shall be absent; +- supportedRAT-TypesIndicator shall be present and populated with the value received within the RAT-Type AVP in the received ULR; +- supportedFeatures shall be present if a SupportedFeature AVP was present in the received ULR which indicated support of ods and regsubs. + +**informPreviousNetworkEntity** in UpdateGprsLocationArg shall be absent; + +**ps-LCS-NotSupportedByUE** in UpdateGprsLocationArg shall be absent + +**v-gmlc-Address** in UpdateGprsLocationArg shall be absent. + +**add-info** in UpdateGprsLocationArg shall be present if a Terminal-Information AVP was present in the received ULR. If present the parameter shall be populated with the received IMEI and software version; skipSubscriberDataUpdate in add-info shall be absent. + +**eps-info** in UpdateGprsLocationArg shall be present. + +- if the S6a/S6d indicator within the ULR-Flags AVP was set, the parameter shall contain isr-Information with updateLocation indication, and if a Single-Registration-Indication was present in the received ULR-Flags AVP then the isr-Information shall also contain a cancelSGSN indication, and if an InitialAttachIndicator was present in the received ULR-Flags AVP then the isr-Information shall also contain initialAttachIndicator; + +- if the S6a/S6d indicator within the ULR-Flags was not set, the parameter shall contain isr-Information with updateLocation indication, and if an InitialAttachIndicator was present within the ULR-Flags AVP, the parameter shall contain isr-Information with initialAttachIndicator. + +**servingNodeTypeIndicator** in UpdateGprsLocationArg shall be present if the S6a/S6d-Indicator was present in the ULR-Flags AVP within the received ULR. + +**skipSubscriberData Update** in UpdateGprsLocationArg shall be present if a skip subscriber data indication was received within the ULR-Flags within ULR. + +**usedRAT-Type** in UpdateGprsLocationArg shall be populated with the value received within the RAT-Type AVP within ULR. + +**gprsSubscriptionDataNotNeeded** in UpdateGprsLocationArg shall be present if bit 3 (GPRS-Subscription-Data-Indicator) was not set in the ULR-Flags AVP received within ULR. + +**nodeTypeIndicator** in UpdateGprsLocationArg shall be present if bit 4 (Node-Type-Indicator) was set in the ULR-Flags AVP received within ULR. + +**areaRestricted** in UpdateGprsLocationArg shall be absent. + +**ue-reachableIndicator** in UpdateGprsLocationArg shall be absent. + +**ue-srvcc-Capability** in UpdateGprsLocationArg shall be present if a UE-SRVCC-Capability AVP was present in the received ULR. If present the parameter shall be populated with the received ue-srvcc-Capability. + +**mmeNumberforMTSMS** in UpdateGprsLocationArg shall be populated with the value of the MME-Number-for-MT-SMS AVP if present within ULR. + +**sms-Only** in UpdateGprsLocationArg shall be populated with the value of the SMS-Only AVP if present within ULR. + +**smsRegisterRequest** in UpdateGprsLocationArg shall be populated with the value of the SMS-Register-Request AVP if present within ULR. + +**adjacentPLMN-List** in UpdateGprsLocationArg shall be constructed with the values of the Adjacent-PLMNs grouped AVP, if present within ULR. + +### 8.2.2 + +#### UpdateGprsLocationRes/Error/InsertSubscriberDataArg/ActivateTraceModeArg mapping to ULA + +When the IWF needs to construct an ULA command as a result of receiving an UpdateGprsLocation Ack/Error message (see sections 7.2.1 step 5, and 7.2.2 step 7), the IWF shall populate AVPs of ULA as described below: + +**Result-Code / Experimental-Result** AVP shall be set to: + +- DIAMETER\_SUCCESS if an UpdateGprsLocationRes parameter was received in a TCAP ResultLast component; +- DIAMETER\_ERROR\_USER\_UNKNOWN if an error of unknownSubscriber without a diagnostic parameter or with a diagnostic parameter of imsiUnknown was received; +- DIAMETER\_ERROR\_UNKNOWN\_SUBSCRIPTION if an error of unknownSubscriber with a diagnostic parameter of gprs-eps-SubscriptionUnknown was received; +- DIAMETER\_ERROR\_RAT\_NOT\_ALLOWED if an error of roamingNotAllowed with a roamingNotAllowedParam containing an additionalRoamingNotAllowedCause of "supportedRAT-TypesNotAllowed" was received; +- DIAMETER\_ERROR\_ROAMING\_NOT\_ALLOWED if an error of roamingNotAllowed without "supportedRAT-TypesNotAllowed" was received; +- an appropriate DIAMETER base protocol result code otherwise. + +**Auth-Session-State** AVP shall be set to the value NO\_STATE\_MAINTAINED (1). + +**Supported-Features** AVP shall be absent. + +**ULA-Flags** AVP: Flags shall be set as follows: + +- **SeparationIndication** shall be set to 1 if the sgsn-mmeSeparationSupported parameter was present within UpdateGprsLocationRes; otherwise shall be set to 0. +- **MME Registered for SMS** shall be set to 1 if the mmeRegisteredforSMS parameter was present within UpdateGprsLocationRes; otherwise shall be set to 0. + +**Subscription-Data** AVP shall be present if MAP InsertSubscriberData messages have been received from the HSS and a "skip-subscriber-Data" indication was not present in the received ULR command or a MAP ActivateTraceMode message has been received from the HSS. If present the AVP shall be populated as follows: + +**Subscriber status** AVP shall be present if a subscriberStatus parameter was present in a received SubscriberData parameter within InsertSubscriberDataArg. If so, values shall be mapped appropriately. + +**MSISDN** AVP shall be present if an msisdn parameter was present in a received SubscriberData parameter within InsertSubscriberDataArg. + +**STN-SR** AVP shall be present if an stn-sr parameter was present in a received EPS-SubscriptionData parameter within InsertSubscriberDataArg. + +**Network-Access-Mode** AVP shall be present if a networkAccessMode parameter was present within InsertSubscriberDataArg. + +**Operator-Determined-Barring** AVP shall be present if an odb-GeneralData parameter was present within an odb-Data parameter within a SubscriberData parameter within InsertSubscriberDataArg. + +**HPLMN-ODB** AVP shall be present if an odb-HPLMN-Data parameter was present within an odb-Data parameter within a SubscriberData parameter within InsertSubscriberDataArg. + +**Regional-Subscription-Zone-Code** AVPs shall be present if ZoneCodes were present within an regionalSubscriptionData parameter within a SubscriberData parameter within InsertSubscriberDataArg. + +**Access-Restriction-Data** AVP shall be present if accessRestrictionData or ext-AccessRestrictionData parameters were present within InsertSubscriberDataArg, and/or a ho-to-non-3GPP-Access-Not-Allowed parameter was present in an eps-SubscriptionData parameter within InsertSubscriberDataArg. + +**APN-OI-Replacement** AVP shall be present if an apn-oi-Replacement parameter was present within an eps-SubscriptionData parameter within InsertSubscriberDataArg. + +**3GPP-Charging-Characteristics** AVP shall be present if a chargingCharacteristics parameter was present within InsertSubscriberDataArg. + +**AMBR** AVP shall be present if an ambr parameter was present within an eps-SubscriptionData parameter within InsertSubscriberDataArg. + +**APN-Configuration-Profile** AVP shall be present if an apn-ConfigurationProfile parameter was present within an eps-SubscriptionData parameter within InsertSubscriberDataArg. + +**RAT-Frequency-Selection-Priority-ID** AVP shall be present if a rfsp-id parameter was present within an eps-SubscriptionData parameter within InsertSubscriberDataArg. + +**Adjacent-Access-Restriction-Data** AVP shall be present if adjacentAccessRestrictionDataList was present within InsertSubscriberDataArg. + +- **IMSI-Group-Id** AVP shall be present if imsi-Group-Id-List was present within InsertSubscriberDataArg. +- **Trace-Data** AVP shall be present if a MAP ActivateTraceMode message has been received from the HSS. Sub-AVPs in Trace-Data AVP shall be populated as follows: + - **Trace-Reference** AVP shall be present and populated with the values received within the traceReference and traceReference2 parameters within ActivateTraceModeArg. + +- **Trace-Depth-List** AVP shall be present if a Trace-DepthList parameter was present within ActivateTraceModeArg. +- **Trace-NE-Type-List** AVP shall be present if a TraceNE-TypeList parameter was present within ActivateTraceModeArg. +- **Trace-Depth-List** AVP shall be present if a Trace-DepthList parameter was present within ActivateTraceModeArg. +- **Trace-Interface-List** AVP shall be present if a TraceInterfaceList parameter was present within ActivateTraceModeArg. +- **Trace-Event-List** AVP shall be present if a TraceEventList parameter was present within ActivateTraceModeArg. +- **OMC-Id** AVP shall be present if a OMC-Id parameter was present within ActivateTraceModeArg. +- **Trace-Collection-Entity** AVP shall be present if a TraceCollectionEntity parameter was present within ActivateTraceModeArg. +- **MDT-Configuration** AVP shall be present if a MDT-Configuration parameter was present within ActivateTraceModeArg. + +**GPRS-Subscription-Data** AVP shall be present if a gprsSubscriptionData parameter was present within InsertSubscriberDataArg. + +**LCS-Info** AVP shall be present if a LCS Information parameter was present within InsertSubscriberDataArg. + +**CSG-Subscription-Data** AVPs shall be populated with information received within the csg-SubscriptionDataList parameter within InsertSubscriberDataArg. + +**Roaming-Restricted-Due-To-Unsupported-Feature** AVP shall be present and set to "Roaming-Restricted-Due-To-Unsupported-Feature (0)" if the parameter roamingRestrictedInSgsnDueToUnsupportedFeature was present within InsertSubscriberDataArg. Otherwise shall be absent. + +**Teleservice-List** AVP shall be present if a Teleservice List parameter was present within InsertSubscriberDataArg. + +**Call-Barring-Info** AVPs shall be present if call barring SS-code and SS-status parameters were present within InsertSubscriberDataArg and the SS-Code AVP and SS-Status AVP within the Call-Barring-Info AVPs shall be populated with the values of the received call barring SS-code and SS-status parameters within InsertSubscriberDataArg. + +**MDT-User-Consent** AVP shall be present if a MDT User Consent parameter was present within InsertSubscriberDataArg. + +**Subscribed-VSRVCC** AVP shall be present if a Subscribed vSRVCC parameter was present in a received EPS-SubscriptionData parameter within InsertSubscriberDataArg. + +**PS-and-SMS-Only-Service-Provision** AVP shall be present if a psAndSMS-OnlyServiceProvision parameter was present within InsertSubscriberDataArg. + +**SMS-In-SGSN-Allowed** AVP shall be present if an smsInSGSNAllowed parameter was present within InsertSubscriberDataArg. + +### 8.2.3 UpdateGprsLocationArg mapping to ULR + +When the IWF needs to construct an ULR command as a result of receiving an UpdateGprsLocation message without a pdn-gw-update parameter within eps-info and without an isr-Information parameter within eps-info not indicating updateLocation or without a skipSubscriberDataUpdate parameter within add-info (see section 7.2.2 step 3), the IWF shall populate AVPs of ULR as described below: + +**Auth-Session-State** AVP shall be set to the value NO\_STATE\_MAINTAINED (1). + +**User-Name** AVP shall be populated with the value received within the imsi parameter of UpdateGprsLocationArg. + +**Supported-Features** AVP shall be populated with a value mapped from received parameter supportedFeatures within sgsn-Capability. + +**Terminal-Information** AVP shall be present if an add-info parameter was received within UpdateGprsLocationArg. If present the received value of the imeisv parameter shall be mapped onto IMEI and (if present) Software Version. + +**RAT-Type** AVP shall be populated with the value received within the usedRAT-Type parameter of UpdateGprsLocationArg + +**ULR-Flags** AVP: Flags shall be set as follows: + +**Single-Registration-Indication** shall be set to 1 if the ISR-Information parameter within the EPS-Info parameter within UpdateGprsLocationArg is present and indicates "cancelSGSN"; otherwise shall be set to 0. + +- **S6a/S6d-Indicator** shall be set to 1 if the servingNodeTypeIndicator parameter was present in UpdateGprsLocationArg; otherwise shall be set to 0. +- **Skip Subscriber Data** shall be set to 1 if a skipSubscriberData parameter was present in UpdateGprsLocationArg; otherwise shall be set to 0. +- **GPRS-Subscription-Data-Indicator** shall be set to 1 if the "GPRS Subscription Data not needed Indicator" was absent from UpdateGprsLocationArg; otherwise shall be set to 0. +- **Node-Type-Indicator** shall be set to 1 if the "Node-Type Indicator" was present in UpdateGprsLocationArg; otherwise shall be set to 0. +- **Initial-Attach-Indicator** shall be set to 1 if the initialAttachIndicator parameter within the ISR-Information parameter within the EPS-Info parameter within UpdateGprsLocationArg is present; otherwise shall be set to 0. + +**Visited-PLMN-Id** AVP shall populated with a value derived from the sgsn-Number parameter received within UpdateGprsLocationArg. + +**SGSN-Number** AVP shall be populated with the value received within the SGSN Number parameter of UpdateGprsLocationArg. + +**UE-SRVCC-Capability** AVP shall be present if a ue-srvcc-Capability parameter was present in UpdateGprsLocationArg. If present the AVP shall be populated with the received ue-srvcc-Capability parameter. + +**MME-Number-for-MT-SMS** AVP shall be populated with the value received within the mmeNumberforMTSMS parameter of UpdateGprsLocationArg. + +**SMS-Register-Request** AVP shall be populated with the value received within the smsRegisterRequest parameter of UpdateGprsLocationArg. + +**SMS-Only** AVP shall be populated with the value received within the sms-Only parameter of UpdateGprsLocationArg. + +**Adjacent-PLMNs** AVP shall be constructed with the values received within the adjacentPLMN-List parameter of UpdateGprsLocationArg. + +### 8.2.4 ULA mapping to InsertSubscriberDataArg/ ActivateTraceModeArg/UpdateGprsLocationRes/Error + +When the IWF needs to construct a MAP InsertSubscriberData messages and/or a MAP- ActivateTraceMode message and/or a MAP-UpdateGprsLocation Ack message, as a result of receiving an ULA command (see sections 7.2.2 steps 5 and 6), the IWF shall populate sub-parameters of InsertSubscriberDataArg, ActivateTraceModeArg and UpdateGprsLocationRes/Error as described below: + +**InsertSubscriberDataArg:** + +imsi in InsertSubscriberDataArg shall be absent. + +**msisdn** in InsertSubscriberDataArg shall be populated with the value received within the MSISDN AVP within the Subscription-Data AVP within ULA. + +**category** in InsertSubscriberDataArg shall be absent. + +**subscriberStatus** in InsertSubscriberDataArg shall be populated with the value received within the Subscriber-Status AVP within the Subscription-Data AVP within ULA. + +**bearerServiceList** in InsertSubscriberDataArg shall be absent. + +**teleserviceList** in InsertSubscriberDataArg shall be absent + +**provisionedSS** in InsertSubscriberDataArg shall be absent. + +**odb-Data** in InsertSubscriberDataArg shall be populated with the value received within the Operator-Determined-Barring AVP and HPLMN-ODB AVP within the Subscription-Data AVP within ULA. + +**roamingRestrictedDueToUnsupportedFeature** in InsertSubscriberDataArg shall be absent. + +**regionalSubscriptionData** in InsertSubscriberDataArg shall be populated with the value received within the Regional-Subscription-Zone-Code AVPs within the Subscription-Data AVP within ULA. + +**vbsSubscriptionData** in InsertSubscriberDataArg shall be absent. + +**vgcsSubscriptionData** in InsertSubscriberDataArg shall be absent + +**vlrCamelsubscriptionInfo** in InsertSubscriberDataArg shall be absent. + +**naea-PreferredCI** in InsertSubscriberDataArg shall be absent. + +**gprsSubscriptionData** in InsertSubscriberDataArg shall be populated with GPRS-Subscription Data received within the Subscription-Data AVP within ULA. + +**roamingRestrictedInSgsnDueToUnsupportedFeature** in InsertSubscriberDataArg shall be present if a Roaming-Restricted-Due-To-Unsupported-Feature AVP Subscription-Data AVP within ULA. + +**networkAccessMode** in InsertSubscriberDataArg shall be populated with the value received within the Network-Access-Mode AVP within the Subscription-Data AVP within ULA. + +**lsaInformation** in InsertSubscriberDataArg shall be absent. + +**lmu-Indicator** in InsertSubscriberDataArg shall be absent + +**lcsInformation** in InsertSubscriberDataArg shall be absent. + +**istAlertTimer** in InsertSubscriberDataArg shall be absent. + +**superChargerSupportedInHLR** in InsertSubscriberDataArg shall be absent. + +**mc-SS-Info** in InsertSubscriberDataArg shall be absent. + +**cs-AllocationRetentionPriority** in InsertSubscriberDataArg shall be absent. + +**sgsn-CAMEL-SubscriptionInfo** in InsertSubscriberDataArg shall be absent. + +**chargingCharacteristics** in InsertSubscriberDataArg shall be populated with the value received within the 3GPP-Charging-Characteristics AVP within the Subscription-Data AVP within ULA. + +**accessRestrictionData** and **ext-AccessRestrictionData** in InsertSubscriberDataArg shall be populated according to the values received within the Access-Restriction-Data AVP within the Subscription-Data AVP within ULA. + +**ics-Indicator** in InsertSubscriberDataArg shall be absent. + +**LCS Information** in InsertSubscriberDataArg shall be populated with the value received within the LCS-Info AVP within the Subscription-Data AVP within ULA. + +**Teleservice List** in InsertSubscriberDataArg shall be populated with the value received within the Teleservice-List AVP within the Subscription-Data AVP within ULA. + +SS-code and SS-status parameters of **Call Barring Information List** in InsertSubscriberDataArg shall be populated with the values of SS-Code AVP and SS-Status AVP received within the Call-Barring-Info AVPs within the Subscription-Data AVP within ULA. + +**psAndSMS-OnlyServiceProvision** in InsertSubscriberDataArg shall be populated with the value received within the Subscription-Data AVP within ULA. + +**smsInSGSNAllowed** in InsertSubscriberDataArg shall be populated with the value received within the Subscription-Data AVP within ULA. + +**adjacentAccessRestrictionDataList** in InsertSubscriberDataArg shall be constructed with the values received within the Adjacent-Access-Restriction-Data AVP within the Subscription-Data AVP within ULA. + +**imsi-Group-Id-List** in InsertSubscriberDataArg shall be constructed with the values received within the IMSI-Group-Id AVP within the Subscription-Data AVP within ULA. + +Sub-parameters of **eps-SubscriptionData** in InsertSubscriberDataArg shall be populated as follows: + +**apn-oi-Replacement** shall be populated with the value received in the APN-OI-Replacement AVP within the Subscription-Data AVP within ULA. + +**rfsp-id** shall be populated with the value received within the RAT-Frequency-Selection-Priority-ID AVP within the Subscription-Data AVP within ULA. + +**ambr** shall be populated with the value received within the AMBR AVP within the Subscription-Data AVP within ULA. + +**apn-ConfigurationProfile** shall be populated with the value received within the APN-Configuration-Profile AVP within the Subscription-Data AVP within ULA. + +**stn-sr** shall be populated with the value received within the STN-SR AVP within the Subscription-Data AVP within ULA. + +**csg-SubscriptionDataList** shall be populated with values received within CSG-Subscription-Data AVPs within the Subscription-Data AVP within ULA. + +**ue-ReachabilityRequestIndicator** shall be absent. + +**mdtUserConsent** shall be populated with the value received within MDT-User-Consent AVP within the Subscription-Data AVP within ULA. + +**subscribed-vsrvcc** shall be present if the Subscribed-VSRVCC AVP is present within the Subscription-Data AVP within ULA. + +**pcscf-Restoration-Request** shall be absent. + +#### ActivateTraceModeArg: + +**imsi** in ActivateTraceModeArg shall be absent. + +**TraceReference** shall be populated with the value of Trace-ID part of the Trace-Reference AVP received within the Trace-Data AVP within the Subscription-Data AVP within ULA. + +**TraceType** shall be present with any value. + +**TraceReference2** shall be populated with the value of MCC+MNC part of the Trace-Reference AVP received within the Trace-Data AVP within the Subscription-Data AVP within ULA. + +**TraceDepthList** shall be populated with the value received in the Trace-Depth-List AVP within the Trace-Data AVP within the Subscription-Data AVP within ULA. + +**TraceNE-TypeList** shall be populated with the value received in the Trace-NE-Type-List AVP within the Trace-Data AVP within the Subscription-Data AVP within ULA. + +**TraceInterfaceList** shall be populated with the value received in the Trace-Interface-List AVP within the Trace-Data AVP within the Subscription-Data AVP within ULA. + +**TraceEventList** shall be populated with the value received in the Trace-Event-List AVP within the Trace-Data AVP within the Subscription-Data AVP within ULA. + +**Omc-Id** shall be populated with the value received in the OMC-Id AVP within the Trace-Data AVP within the Subscription-Data AVP within ULA + +**TraceCollectionEntity** shall be populated with the address received within the Trace-Collection-Entity AVP within the Subscription-Data AVP within ULA. + +#### **UpdateGprsLocationRes:** + +**hlr-Number** in UpdateGprsLocationRes shall be populated with a value locally assigned to the IWF and consistent with SS7 routing principles. + +**extensionContainer** in UpdateGprsLocationRes shall be absent. + +**add-Capability** in UpdateGprsLocationRes shall be present. + +**sgsn-mmeSeparationSupported** in UpdateGprsLocationRes shall be present if the Separation Indication within the ULA-Flags AVP was set to 1 within ULA. + +**MDT-Configuration** shall be populated with the value received within the MDT-Configuration AVP within the Subscription-Data AVP within ULA. + +**mmeRegisteredforSMS** in UpdateGprsLocationRes shall be present if the "MME registered for SMS" flag within the ULA-Flags AVP was set to 1 within ULA. + +#### **UpdateGprsLocation Error:** + +An error of **unknownSubscriber** with unknownSubscriberParam containing a unknownSubscriberDiagnostic of "imsiUnknown" shall be sent if the received ULA command contains an Experimental-Result AVP with a value of "User Unknown". + +An error of **unknownSubscriber** with unknownSubscriberParam containing a unknownSubscriberDiagnostic of "gprs-epsSubscriptionUnknown" shall be sent if the received ULA command contains an Experimental-Result AVP with a value of "Unknown EPS Subscription". + +Other values within the Result-Code / Experimental-Result AVP shall be mapped onto an appropriate MAP error. + +## **8.3 Mapping of Parameters for the Cancel Location Procedure** + +### **8.3.1 CancelLocationArg mapping to CLR** + +When the IWF needs to construct a CLR command as a result of receiving a MAP-CancelLocation message (see sections 7.3.1 step 2, and 7.3.2 step 3), the the IWF shall populate AVPs of CLR as described below: + +**Auth-Session-State** AVP shall be set to the value NO\_STATE\_MAINTAINED (1). + +**User-Name** AVP shall be populated with the imsi value received within the identity parameter of CancelLocationArg. + +**Supported-Features** AVP shall be absent. + +**CancellationType** AVP shall contain the value MME\_UPDATE\_PROCEDURE if the parameter CancellationType within CancelLocationArg was set to updateProcedure and typeOfUpdate within CancelLocationArg was set to mme-change; the AVP shall contain the value SGSN\_UPDATE\_PROCEDURE if the parameter CancellationType within CancelLocationArg was set to updateProcedure and typeOfUpdate within CancelLocationArg was set to sgsn-change; the AVP shall contain the value SUBSCRIPTION\_WITHDRAWAL if the parameter CancellationType within CancelLocationArg was set to subscriptionWithdraw; the AVP shall contain the value UPDATE\_PROCEDURE\_IWF if the parameter CancellationType within CancelLocationArg was set to updateProcedure and typeOfUpdate within CancelLocationArg was absent; the AVP shall contain the value INITIAL\_ATTACH\_PROCEDURE if the parameter CancellationType within CancelLocationArg was set to InitialAttachProcedure. + +**CLR-Flags** AVP: Flags shall be set as follows: + +- **S6a/S6d-Indicator** shall be set to 1 if the TypeOfUpdate parameter was present in CancelLocationArg and indicates "mme-change"; it shall be set to 0 if the TypeOfUpdate parameter was present in CancelLocationArg and indicates "sgsn-change". +- **Reattach-Required** shall be set to 1 if the reattach-Required parameter was present in CancelLocationArg. + +### 8.3.2 CLA mapping to CancelLocationRes/Error + +When the IWF needs to construct MAP-CancelLocation Ack message as a result of receiving an CLA command (see sections 7.3.1 step 4 and 7.3.2.step 5), the IWF shall populate sub-parameters of CancelLocationRes/Error as described below: + +**CancelLocationRes:** + +**extensionContainer** in CancelLocationRes shall be absent. + +**CancelLocation Error:** + +Values other than SUCCESS within the Result-Code / Experimental-Result AVP shall be mapped onto an appropriate MAP error. + +### 8.3.3 CLR mapping to CancelLocationArg + +When the IWF needs to construct a MAP-CancelLocation message as a result of receiving a CLR command (see sections 7.3.2 step 2), the IWF shall open a MAP dialogue in application context version 3 and populate sub-parameters of CancelLocationArg as described below: + +**identity** in CancelLocationArg shall be populated with the imsi value of the User-Name AVP received within CLR. + +**cancellationType** in CancelLocationArg shall contain a value of updateProcedure if the Cancellation-Type AVP received in CLR contains the value MME\_UPDATE\_PROCEDURE or SGSN\_UPDATE\_PROCEDURE. The parameter shall contain a value of subscriptionWithdraw if the Cancellation-Type AVP received in CLR contains the value SUBSCRIPTION\_WITHDRAWAL. The parameter shall contain a value of InitialAttachProcedure if the Cancellation-Type AVP received in CLR contains the value INITIAL\_ATTACH\_PROCEDURE. + +**extensionContainer** in CancelLocationArg shall be absent. + +**typeOfUpdate** in CancelLocationArg shall be set to sgsn-change if SGSN\_UPDATE\_PROCEDURE was received in the Cancellation-Type AVP within CLR, or INITIAL\_ATTACH\_PROCEDURE was received in the Cancellation-Type AVP within CLR and the S6a/S6d-Indicator flag was cleared in the CLR-Flags AVP within the received CLR. It shall be set to mme-change if MME\_UPDATE\_PROCEDURE was received in Cancellation-Type AVP within CLR, or if INITIAL\_ATTACH\_PROCEDURE was received in the Cancellation-Type AVP within CLR and the S6a/S6d-Indicator flag was set in the CLR-Flags AVP within the received CLR. Otherwise it shall be absent. + +**reattach-Required** in CancelLocationArg shall be present if the Reattach-Required flag was set in the CLR-Flags AVP received within CLR. + +### 8.3.4 CancelLocationRes / Error mapping to CLA + +When the IWF needs to construct an CLA command as a result of receiving a CancelLocation Ack/Error message (see sections 7.3.2 step 6), the IWF shall populate AVPs of CLA as described below: + +**Result-Code / Experimental-Result** AVP shall be set to: + +- DIAMETER\_SUCCESS if a CancelLocationRes parameter was received in a TCAP ResultLast component; +- an appropriate DIAMETER base protocol result code otherwise. + +**Supported-Features** AVP shall be absent. + +**Auth-Session-State** AVP shall be set to the value NO\_STATE\_MAINTAINED (1). + +## 8.4 Mapping of Parameters for the Purge Procedure + +### 8.4.1 PUR mapping to PurgeMS-Arg + +When the IWF needs to construct a MAP-PurgeMS message as a result of receiving an PUR command (see sections 7.4.1 step 2 and 7.4.2. step 2), the IWF shall open a MAP dialogue in application context version 3 and populate sub-parameters of PurgeMS-Arg as described below: + +**imsi** in PurgeMS-Arg shall be populated with the imsi value of the User-Name AVP received within PUR. + +**vlr-Number** in PurgeMS-Arg shall be absent. + +**sgsn-Number** in PurgeMS-Arg shall be populated with a value locally assigned to the IWF and consistent with SS7 routing principles. + +**extensionContainer** in PurgeMS-Arg shall be absent. + +### 8.4.2 PurgeMS-Res / Error mapping to PUA + +When the IWF needs to construct an PUA command as a result of receiving a PurgeMS Ack/Error message (see sections 7.4.1 step 4 and 7.4.2. step 6), the IWF shall populate AVPs of PUA as described below: + +**Result-Code / Experimental-Result** AVP shall be set to: + +- DIAMETER\_SUCCESS if a PurgeMS-Res parameter was received in a TCAP ResultLast component; +- DIAMETER\_ERROR\_USER\_UNKNOWN if an error of unknownSubscriber without a diagnostic parameter or with a diagnostic parameter of imsiUnknown or gprs-eps-SubscriptionUnknown was received; +- an appropriate DIAMETER base protocol result code otherwise. + +**Auth-Session-State** AVP shall be set to the value NO\_STATE\_MAINTAINED (1). + +**PUA-Flags** AVP: Flags shall be set as follows: + +- **Freeze M-TMSI** shall be set to 1 if the freezeM-TMSI parameter was present within PurgeMS-Res; otherwise shall be set to 0. +- **Freeze P-TMSI** shall be set to 1 if the freezeP-TMSI parameter was present within PurgeMS-Res; otherwise shall be set to 0. + +### 8.4.3 PurgeMS-Arg mapping to PUR + +When the IWF needs to construct a PUR command as a result of receiving a MAP-PurgeMS message (see section 7.4.2 step 3), the the IWF shall populate AVPs of PUR as described below: + +**Auth-Session-State** AVP shall be set to the value NO\_STATE\_MAINTAINED (1). + +**User-Name** AVP shall be populated with the value received within the imsi parameter of PurgeMS-Arg. + +**Supported-Features** AVP shall be absent. + +### 8.4.4 PUA mapping to PurgeMS-Res/Error + +When the IWF needs to construct MAP-PurgeMS Ack message as a result of receiving a PUA command (see section 7.4.2.step 5), the IWF shall populate sub-parameters of PurgeMS-Res/Error as described below: + +**PurgeMS-Res:** + +**freezeTMSI** in PurgeMS-Res shall be absent. + +**freezeP-TMSI** in PurgeMS-Res shall be present if a Freeze-P-TMSI indication was received within the PUA-Flags AVP within PUA. + +**extensionContainer** in PurgeMS-Res shall be absent. + +**freezeM-TMSI** in PurgeMS-Res shall be present if a Freeze-M-TMSI indication was received within the PUA-Flags AVP within PUA. + +#### **PurgeMS Error:** + +An error of **unknownSubscriber** with unknownSubscriberParam containing a unknownSubscriberDiagnostic of "imsiUnknown" shall be sent if the received AIA command contains an Experimental-Result AVP with a value of "User Unknown". + +Values other than SUCCESS within the Result-Code / Experimental-Result AVP shall be mapped onto an appropriate MAP error. + +## **8.5 Mapping of Parameters for the Insert Subscriber Data Procedure** + +### **8.5.1 InsertSubscriberDataArg mapping to IDR** + +When the IWF needs to construct an IDR command as a result of receiving a MAP-InsertSubscriberData message (see sections 7.5.1 step 2, and 7.5.2 step 3), the IWF shall populate AVPs of IDR as described below: + +**Auth-Session-State** AVP shall be set to the value NO\_STATE\_MAINTAINED (1). + +**User-Name** AVP shall be populated with the value received within the imsi parameter of InsertSubscriberDataArg. + +**Supported-Features** AVP shall be absent. + +**Subscription-Data** AVP: See chapter 8.2.2. + +**IDR-Flags** AVP: Flags shall be set as follows: + +UE Reachability Request shall be set to 1 if the ue-reachabilityRequestIndicator was present within InsertSubscriberDataArg; otherwise shall be set to 0 or the AVP shall be absent. + +P-CSCF Restoration Request flag shall be set to 1 if the pscf-Restoration-Request parameter was present within InsertSubscriberDataArg; otherwise shall be set to 0 or the AVP shall be absent. + +### **8.5.2 IDA mapping to InsertSubscriberDataRes/Error** + +When the IWF needs to construct a MAP-InsertSubscriberData Ack message as a result of receiving an IDA command (see sections 7.5.1 step 4 and 7.5.2 step 5), the IWF shall populate sub-parameters of InsertSubscriberDataRes/Error as described below: + +#### **InsertSubscriberDataRes:** + +**teleserviceList** in InsertSubscriberDataRes shall include all teleserviceCodes that have been received within InsertSubscriberDataArg. + +**bearerServiceList** in InsertSubscriberDataRes shall include all bearerServiceCodes that have been received within InsertSubscriberDataArg. + +**ss-List** in InsertSubscriberDataRes shall include all ssCodes that have been received within InsertSubscriberDataArg. + +**odb-GeneralData** in InsertSubscriberDataRes shall include all odb categories that have been requested within the received InsertSubscriberDataArg but are not supported by the serving node as indicated within the Supported-Feature AVP within IDA. + +**regionalSubscriptionResponse** in InsertSubscriberDataRes + +-shall be set to regionalSubscNotSupported if regional subscription was requested within the received InsertSubscriberDataArg but is not supported by the serving node as indicated within the Supported-Feature AVP within IDA. + +-shall be set to networkNode-AreaRestricted if regional subscription was requested within the received InsertSubscriberDataArg but a Network-Node-Area-Restricted indication has been received within the IDA- + +Flags AVP within IDA. + +- otherwise shall be absent. + +**supportedCamelPhases** in InsertSubscriberDataRes shall be absent or shall indicate that no CAMEL phase is supported. + +**extensionContainer** in CancelLocationRes shall be absent. + +**offeredCamel4CSIs** in InsertSubscriberDataRes shall be absent. + +**supportedFeatures** in InsertSubscriberDataRes shall be populated with the information received within the Supported-Features AVP within IDA. + +#### **InsertSubscriberData Error:** + +Values other than SUCCESS within the Result-Code / Experimental-Result AVP shall be mapped onto an appropriate MAP error. + +### **8.5.3 IDR mapping to InsertSubscriberDataArg/ ActivateTraceModeArg** + +When the IWF needs to construct a MAP-InsertSubscriberData message or a MAP-ActivateTraceMode message as a result of receiving an IDR command (see sections 7.5.2 step 2, and 7.10.2 step 2), the IWF shall open a MAP dialogue in application context version 3 and populate sub-parameters of InsertSubscriberDataArg/ActivateTraceModeArg as described below: + +#### **InsertSubscriberDataArg:** + +**imsi** in InsertSubscriberDataArg shall be populated with the value received within the User-Name AVP within IDR. + +**msisdn** in InsertSubscriberDataArg shall be populated with the value received within the MSISDN AVP within the Subscription-Data AVP within IDR. + +**category** in InsertSubscriberDataArg shall be absent. + +**subscriberStatus** in InsertSubscriberDataArg shall be populated with the value received within the Subscriber-Status AVP within the Subscription-Data AVP within IDR. + +**bearerServiceList** in InsertSubscriberDataArg shall be absent. + +**teleserviceList** in InsertSubscriberDataArg shall be absent + +**provisionedSS** in InsertSubscriberDataArg shall be absent. + +**odb-Data** in InsertSubscriberDataArg shall be populated with the value received within the Operator-Determined-Barring AVP and HPLMN-ODB AVP within the Subscription-Data AVP within IDR. + +**roamingRestrictedDueToUnsupportedFeature** in InsertSubscriberDataArg shall be absent. + +**regionalSubscriptionData** in InsertSubscriberDataArg shall be populated with the value received within the Regional-Subscription-Zone-Code AVPs within the Subscription-Data AVP within IDR. + +**vbsSubscriptionData** in InsertSubscriberDataArg shall be absent. + +**vgcsSubscriptionData** in InsertSubscriberDataArg shall be absent + +**vlrCamelSubscriptionInfo** in InsertSubscriberDataArg shall be absent. + +**naea-PreferredCI** in InsertSubscriberDataArg shall be absent. + +**gprsSubscriptionData** in InsertSubscriberDataArg shall be populated with GPRS-Subscription Data received within the Subscription-Data AVP within IDR. + +**roamingRestrictedInSgsnDueToUnsupportedFeature** in InsertSubscriberDataArg shall be present if a Roaming-Restricted-due-To-Unsupported-Feature AVP was received within the Subscription-Data AVP within IDR. + +**networkAccessMode** in InsertSubscriberDataArg shall be populated with the value received within the Network-Access-Mode AVP within the Subscription-Data AVP within IDR. + +**lsaInformation** in InsertSubscriberDataArg shall be absent. + +**lmu-Indicator** in InsertSubscriberDataArg shall be absent + +**lcsInformation** in InsertSubscriberDataArg shall be absent. + +**istAlertTimer** in InsertSubscriberDataArg shall be absent. + +**superChargerSupportedInHLR** in InsertSubscriberDataArg shall be absent. + +**mc-SS-Info** in InsertSubscriberDataArg shall be absent. + +**cs-AllocationRetentionPriority** in InsertSubscriberDataArg shall be absent. + +**sgsn-CAMEL-SubscriptionInfo** in InsertSubscriberDataArg shall be absent. + +**chargingCharacteristics** in InsertSubscriberDataArg shall be populated with the value received within the 3GPP-Charging-Characteristics AVP within the Subscription-Data AVP within IDR. + +**accessRestrictionData** and **ext-AccessRestrictionData** in InsertSubscriberDataArg shall be populated according to the values received within the Access-Restriction-Data AVP within the Subscription-Data AVP within IDR. + +**ics-Indicator** in InsertSubscriberDataArg shall be absent. + +**LCS Information** in InsertSubscriberDataArg shall be populated with the value received within the LCS-Info AVP within the Subscription-Data AVP within ULA. + +**Teleservice List** in InsertSubscriberDataArg shall be populated with the value received within the Teleservice-List AVP within the Subscription-Data AVP within ULA. + +**Call Barring Information List** in InsertSubscriberDataArg shall be populated with the value received within the Call- Barring-Infor-List AVP within the Subscription-Data AVP within ULA. + +**adjacentAccessRestrictionDataList** in InsertSubscriberDataArg shall be constructed with the value received within the Adjacent-Access-Restriction-Data AVP within the Subscription-Data AVP within IDR. + +**imsi-Group-Id-List** in InsertSubscriberDataArg shall be constructed with the values received within the IMSI-Group-Id AVP within the Subscription-Data AVP within IDR. + +- Sub-parameters of **eps-SubscriptionData** in InsertSubscriberDataArg shall be populated as follows: + - apn-oi-Replacement** shall be populated with the value received in the APN-OI-Replacement AVP within the Subscription-Data AVP within IDR. + - rfsp-id** shall be populated with the value received within the RAT-Frequency-Selection-Priority-ID AVP within the Subscription-Data AVP within IDR. + - ambr** shall be populated with the value received within the AMBR AVP within the Subscription-Data AVP within IDR. + - apn-ConfigurationProfile** shall be populated with the value received within the APN-Configuration-Profile AVP within the Subscription-Data AVP within IDR. + - stn-sr** shall be populated with the value received within the STN-SR AVP within the Subscription-Data AVP within IDR. + - subscribed-vsrvcc** shall be present if the Subscribed-VSRVCC AVP is present within the Subscription-Data AVP within IDR. +- csg-SubscriptionDataList** in InsertSubscriberDataArg shall be populated with information received within the CSG-Subscription-Data AVPs within the Subscription-Data AVP within IDR. + +**ue-ReachabilityRequestIndicator** in the InsertSubscriberDataArg shall be present if the corresponding information was present within the IDR-Flags AVP within an IDR; otherwise it shall be absent. + +**psAndSMS-OnlyServiceProvision** in InsertSubscriberDataArg shall be populated with the information received within the PS-and-SMS-Only-Service-Provision AVP within the Subscription-Data AVP within IDR. + +**smsInSGSNAllowed** in InsertSubscriberDataArg shall be populated with the information received within the SMS-In-SGSN-Allowed AVP within the Subscription-Data AVP within IDR. + +**pcscf-Restoration-Request** in the InsertSubscriberDataArg shall be present if the corresponding information was present within the IDR-Flags AVP within an IDR; otherwise it shall be absent. + +#### ActivateTraceModeArg: + +**imsi** shall be populated with the value received within the User-Name AVP within IDR. + +**TraceReference** shall be populated with the value of Trace-ID part of the Trace-Reference AVP received within the Trace-Data AVP within the Subscription-Data AVP within IDR. + +**TraceType** shall be present with any value. + +**TraceReference2** shall be populated with the value of MCC+MNC part of the Trace-Reference AVP received within the Trace-Data AVP within the Subscription-Data AVP within IDR. + +**TraceDepthList** shall be populated with the value received in the Trace-Depth-List AVP within the Trace-Data AVP within the Subscription-Data AVP within IDR. + +**TraceNE-TypeList** shall be populated with the value received in the Trace-NE-Type-List AVP within the Trace-Data AVP within the Subscription-Data AVP within IDR. + +**TraceInterfaceList** shall be populated with the value received in the Trace-Interface-List AVP within the Trace-Data AVP within the Subscription-Data AVP within IDR. + +**TraceEventList** shall be populated with the value received in the Trace-Event-List AVP within the Trace-Data AVP within the Subscription-Data AVP within IDR. + +**Omc-Id** shall be populated with the value received in the OMC-Id AVP within the Trace-Data AVP within the Subscription-Data AVP within IDR. + +**TraceCollectionEntity** shall be populated with the address received within the Trace-Collection-Entity AVP within the Subscription-Data AVP within IDR. + +### 8.5.4 InsertSubscriberDataRes / Error mapping to IDA + +When the IWF needs to construct an IDA command as a result of receiving an InsertSubscriberData Ack/Error message (see sections 7.5.2 step 8), the IWF shall populate AVPs of IDA as described below: + +**Result-Code / Experimental-Result** AVP shall be set to: + +- DIAMETER\_SUCCESS if no InsertSubscriberData error component was received; +- an appropriate DIAMETER base protocol result code otherwise. + +**Auth-Session-State** AVP shall be set to the value NO\_STATE\_MAINTAINED (1). + +**IDA-Flags** AVP: Flags shall be set as follows: + +- **Network-Node-Area-Restricted** shall be set to 1 if the regionalSubscriptionResponse parameter within InsertSubscriberDataRes indicated regionalSubscNotSupported; otherwise shall be set to 0. + +**Supported-Features** AVP: Support of features shall be indicated according to information received within the supportedFeatures parameter within InsertSubscriberDataRes. + +### 8.5.5 ProvideSubscriberInfoArg mapping to IDR + +When the IWF needs to construct an IDR command as a result of receiving a MAP-ProvideSubscriberInfo message (see sections 7.5.1 step 2, and 7.5.2 step 3), the IWF shall populate AVPs of IDR as described below: + +**Auth-Session-State** AVP shall be set to the value NO\_STATE\_MAINTAINED (1). + +**User-Name** AVP shall be populated with the value received within the imsi parameter of ProvideSubscriberInfoArg. + +**Supported-Features** AVP shall be absent. + +**Subscription-Data** AVP shall be empty. + +**IDR-Flags** AVP: Flags shall be set as follows: + +**UE Reachability Request** shall be set to 0. + +**T-ADS Data Request** shall be set to 1 if the t-adsData within the RequestedInfo parameter within ProvideSubscriberInfoArg was present; otherwise it shall be set to 0 or the AVP shall be absent. + +**EPS User State Request** shall be set to 1 if the subscriberState within the RequestedInfo parameter was present within ProvideSubscriberInfoArg; otherwise it shall be set to 0 or the AVP shall be absent. + +**EPS Location Information Request** shall be set to 1 if the locationInformation within the RequestedInfo parameter was present within ProvideSubscriberInfoArg; otherwise it shall be set to 0 or the AVP shall be absent. + +**Current Location Request** shall be set to 1 if the currentLocation within the RequestedInfo parameter was present within ProvideSubscriberInfoArg; otherwise it shall be set to 0. + +**Local Time Zone Request** shall be set to 1 if the localTimeZoneRequest within the RequestedInfo parameter was present within ProvideSubscriberInfoArg; otherwise it shall be set to 0. + +**P-CSCF Restoration Request** shall be set to 0. + +### 8.5.6 IDA mapping to ProvideSubscriberInfoRes/Error + +When the IWF needs to construct a MAP-ProvideSubscriberInfo Ack message as a result of receiving an IDA command (see sections 7.5.1 step 4 and 7.5.2.step 5), the IWF shall populate sub-parameters of ProvideSubscriberInfoRes/Error as described below: + +#### ProvideSubscriberInfoRes: + +Sub-parameters of **SubscriberInfo** in ProvideSubscriberInfoRes shall be populated as follows: + +**imsVoiceOverPS-SessionsIndication** shall be populated with the value received in the IMS-Voice-Over-PS-Sessions-Supported AVP within IDA. + +**lastUE-ActivityTime** shall be populated with the value received in the Last-UE-Activity-Time AVP within IDA. + +**lastRAT-Type** shall be populated with the value received in the RAT-Type AVP within IDA. + +**eps-SubscriberState** shall be populated with the value received in the EPS-User-State AVP within IDA. + +Sub-parameters of **locationInformationEPS** shall be populated with the values of the corresponding AVPs received in the EPS-Location-Information AVP within IDA. + +**timeZone** shall be populated with the value received in the Time-Zone AVP within IDA. + +**daylightSavingTime** shall be populated with the value received in the Daylight-Saving-Time AVP within IDA. + +**extensionContainer** in ProvideSubscriberInfoRes shall be absent. + +#### ProvideSubscriberInfo Error: + +Values other than SUCCESS within the Result-Code / Experimental-Result AVP shall be mapped onto an appropriate MAP error. + +### 8.5.7 IDR mapping to ProvideSubscriberInfoArg + +When the IWF needs to construct a MAP-ProvideSubscriberInfo message as a result of receiving an IDR command (see sections 7.5.2 step 2), the IWF shall open a MAP dialogue in application context version 3 and populate sub-parameters of ProvideSubscriberInfoArg as described below: + +#### ProvideSubscriberInfoArg: + +**imsi** in ProvideSubscriberInfoArg shall be populated with the value received within the User-Name AVP within IDR. + +**lmsi** in ProvideSubscriberInfoArg shall be absent. + +Sub-parameters of **requestedInfo** in ProvideSubscriberInfoArg shall be populated as follows: + +**t-adsData** in requestedInfo shall be present if the "T-ADS Data Request" flag was set in the IDR-Flags AVP within IDR. + +**subscriberState** in requestedInfo shall be present if the "EPS User State Request" flag was set in the IDR-Flags AVP within IDR. + +**locationInformation** in requestedInfo shall be present if the "EPS Location Information Request" flag was set in the IDR-Flags AVP within IDR. + +**currentLocation** in requestedInfo shall be present if the "Current Location Request" flag was set in the IDR-Flags AVP within IDR. + +**localTimeZoneRequest** in requestedInfo shall be present if the "Local Time Zone Request" flag was set in the IDR-Flags AVP within IDR. + +**extensionContainer** in ProvideSubscriberInfoArg shall be absent. + +**callPriority** in ProvideSubscriberInfoArg shall be absent. + +### 8.5.8 ProvideSubscriberInfoRes/Error mapping to IDA + +When the IWF needs to construct an IDA command as a result of receiving an ProvideSubscriberInfo Ack/Error message (see sections 7.5.2 step 8), the IWF shall populate AVPs of IDA as described below: + +**Auth-Session-State** AVP shall be set to the value NO\_STATE\_MAINTAINED (1). + +**Supported-Features** AVP shall be absent. + +**Result-Code / Experimental-Result** AVP shall be set to: + +- DIAMETER\_SUCCESS if no ProvideSubscriberInfo error component was received; +- an appropriate DIAMETER base protocol result code otherwise. + +**IMS-Voice-Over-PS-Sessions-Supported** AVP shall be populated with the value received within the imsVoiceOverPS-SessionsIndication parameter within the SubscriberInfo parameter of ProvideSubscriberInfoRes. + +**Last-UE-Activity-Time** AVP shall be populated with the value received within the lastUE-ActivityTime parameter within the SubscriberInfo parameter of ProvideSubscriberInfoRes. + +**RAT-Type** AVP shall be populated with the value received within the lastRAT-Type parameter within the SubscriberInfo parameter of ProvideSubscriberInfoRes. + +**EPS-User-State** AVP shall be populated with the value received within the eps-SubscriberState parameter within the SubscriberInfo parameter of ProvideSubscriberInfoRes. + +AVPs within **EPS-Location-Information** AVP shall be populated with the values of the corresponding sub-parameters received within the locationInformationEPS parameter within the SubscriberInfo parameter of ProvideSubscriberInfoRes. + +**IDA-Flags** AVP shall be absent. + +AVPs within **Local-Time-Zone** AVP shall be populated as follows: + +- **Time-Zone** AVP shall be populated with the value received within the `timeZone` parameter within the `SubscriberInfo` parameter of `ProvideSubscriberInfoRes`. +- **Daylight-Saving-Time** AVP shall be populated with the value received within the `daylightSavingTime` parameter within the `SubscriberInfo` parameter of `ProvideSubscriberInfoRes`. + +## 8.6 Mapping of Parameters for the Delete Subscriber Data Procedure + +### 8.6.1 DeleteSubscriberDataArg mapping to DSR + +When the IWF needs to construct a DSR command as a result of receiving a MAP-DeleteSubscriberData message (see sections 7.6.1 step 2, and 7.6.2 step 3), the the IWF shall populate AVPs of DSR as described below: + +**Auth-Session-State** AVP shall be set to the value `NO_STATE_MAINTAINED (1)`. + +**User-Name** AVP shall be populated with the value received within the `imsi` parameter of `DeleteSubscriberDataArg`. + +**Supported-Features** AVP shall be absent. + +**DSR-Flags** AVP: Flags shall be set as follows: + +- **RegionalSubscriptionWithdrawal** shall be set to 1 if a `regionalSubscriptionIdentifier` parameter was present in `DeleteSubscriberDataArg`; otherwise shall be set to 0. +- **Complete APN Configuration Profile Withdrawal** shall be set to 1 if the `allEPS-Data` parameter was present within the `EPS-SubscriptionDataWithdraw` parameter within `DeleteSubscriberDataArg`; otherwise shall be set to 0. +- **Subscribed Charging Characteristics Withdrawal** shall be set to 1 if the `chargingCharacteristicsWithdraw` parameter was present within `DeleteSubscriberDataArg`; otherwise shall be set to 0. +- **PDN Subscription Context Withdrawal** shall be set to 1 if the `contextIdList` parameter was present within the `EPS-SubscriptionDataWithdraw` parameter within `DeleteSubscriberDataArg`; otherwise shall be set to 0. +- **STN-SR** shall be set to 1 if the `stn-srWithdraw` parameter was present within `DeleteSubscriberDataArg`; otherwise shall be set to 0. +- **GMLC List Withdrawal** shall be set to 1 if the `GMLC List Withdraw` parameter was present within `DeleteSubscriberDataArg`; otherwise shall be set to 0. +- **LCS Withdrawal** shall be set to 1 if the `SS code list` parameter was present within `DeleteSubscriberDataArg`; otherwise shall be set to 0. +- **Complete PDP context list Withdrawal** shall be set to 1 if the `allGPRS-Data` parameter was present within the `GPRS-SubscriptionDataWithdraw` parameter within `DeleteSubscriberDataArg`; otherwise shall be set to 0. +- **PDP context Withdrawal** shall be set to 1 if the `contextIdList` parameter was present within the `GPRS-SubscriptionDataWithdraw` parameter within `DeleteSubscriberDataArg`; otherwise shall be set to 0. +- **Roaming Restricted in due to unsupported feature** shall be set to 1 if the `roamingRestrictedInSgsnDueToUnsupportedFeature` parameter was present within `DeleteSubscriberDataArg`; otherwise shall be set to 0. +- **Trace Data Withdrawal** shall be set to 0. +- **CSG Deleted** shall be set to 1 if the `csg-SubscriptionDeleted` parameter was present within `DeleteSubscriberDataArg`; otherwise shall be set to 0. +- **APN-OI-Replacement** shall be set to 1 if the `apn-oi-replacementWithdraw` parameter was present within `DeleteSubscriberDataArg`; otherwise shall be set to 0. + +- **SMS Withdrawal** shall be set to 1 if the SS-Code list parameter was present within DeleteSubscriberDataArg and the service codes are related to short message services; otherwise shall be set to 0. +- **Subscribed VSRVCC Withdrawal** shall be set to 1 if the subscribed-vsrvccWithdraw parameter was present within DeleteSubscriberDataArg; otherwise shall be set to 0. + +**Context-Identifier** AVPs shall be populated with values received within the contextIdList parameter within EPS-SubscriptionDataWithdraw or GPRS-SubscriptionDataWithdraw within DeleteSubscriberDataArg; + +### 8.6.2 DSA mapping to DeleteSubscriberDataRes/Error + +When the IWF needs to construct a MAP-DeleteSubscriberData Ack message as a result of receiving a DSA command (see sections 7.6.1 step 4 and 7.6.2.step 5), the IWF shall populate sub-parameters of DeleteSubscriberDataRes/Error as described below: + +#### **DeleteSubscriberDataRes:** + +**regionalSubscriptionResponse** in DeleteSubscriberDataRes shall be set to: + +- regionalSubscNotSupported if a corresponding information was received within the Supported-Feature AVP within DSA . +- networkNode-AreaRestricted if a Network-Node-Area-Restricted indication was received within the DSA-Flags AVP within DSA. + +**extensionContainer** in DeleteSubscriberDataRes shall be absent. + +#### **DeleteSubscriberData Error:** + +Values other than SUCCESS within the Result-Code / Experimental-Result AVP shall be mapped onto an appropriate MAP error. + +### 8.6.3 DSR mapping to DeleteSubscriberDataArg/ DeactivateTraceModeArg + +When the IWF needs to construct a MAP-DeleteSubscriberData message or a MAP-DeactivateTraceMode message as a result of receiving a DSR command (see sections 7.6.2 step 2, 7.11.2 step 2), the IWF shall open a MAP dialogue in application context version 3 and populate sub-parameters of DeleteSubscriberDataArg/DeactivateTraceModeArg as described below: + +#### **DeleteSubscriberDataArg:** + +**imsi** in DeleteSubscriberDataArg shall be populated with the value of the User-Name AVP received within DSR. + +**basicServiceList** in DeleteSubscriberDataArg shall be absent. + +**ss-List** in DeleteSubscriberDataArg shall be absent. + +**roamingRestrictionDueToUnsupportedFeature** in DeleteSubscriberDataArg shall be absent. + +**regionalSubscriptionIdentifier** in DeleteSubscriberDataArg shall be present if a Regional-Subscription-Withdrawal indication has been received within the DSR-Flags AVP within DSR. If present, the value of the ZoneCode is arbitrary. + +**vbsGroupIndication** in DeleteSubscriberDataArg shall be absent. + +**vgcsGroupIndication** in DeleteSubscriberDataArg shall be absent. + +**camelSubscriptionInfoWithdraw** in DeleteSubscriberDataArg shall be absent. + +**extensionContainer** in DeleteSubscriberDataArg shall be absent. + +**gprsSubscriptionDataWithdraw** in DeleteSubscriberDataArg shall be present if corresponding information was received within the DSR-Flags AVP and GPRS-Context-Identifier AVPs within DSR. + +**roamingRestrictedInSgsnDueToUnsupportedFeature** in DeleteSubscriberDataArg shall be present if a corresponding indication has been received within the DSR-Flags AVP within DSR. + +**lsaInformationWithdraw** in DeleteSubscriberDataArg shall be absent. + +**gmlc-ListWithdraw** in DeleteSubscriberDataArg shall be absent. + +**istInformationWithdraw** in DeleteSubscriberDataArg shall be absent. + +**specificCSI-Withdraw** in DeleteSubscriberDataArg shall be absent. + +**chargingCharacteristicsWithdraw** in DeleteSubscriberDataArg shall be present if a Subscribed-Charging-Characteristics-Withdrawal indication was received within the DSR-Flags AVP within DSR. + +**stn-srWithdraw** in DeleteSubscriberDataArg shall be present if a STN-SR indication was received within the DSR-Flags AVP within DSR. + +**epsSubscriptionDataWithdraw** in DeleteSubscriberDataArg shall be present if a Complete-APN-Configuration-Profile-Withdrawal indication or a PDN-Subscription-Context-Withdrawal indication was received within the DSR-Flags AVP. The sub-parameter allEPS-Data shall be present if a Complete-APN-Configuration-Profile-Withdrawal indication was received in the DSR-Flags AVP within DSR. The sub-parameter contextIdList shall be present if a PDN-Subscription-Context-Withdrawal indication was received within the DSR-Flags AVP within DSR; if so, the contextIdList shall be populated with values received within the Context-Identifier AVPs within DSR. + +**GMLC List Withdraw** in DeleteSubscriberDataArg shall be present if a GMLC List Withdrawal indication was received within the DSR-Flags AVP. + +**SS-Code List** in DeleteSubscriberDataArg shall be present if corresponding information was received within the DSR-Flags AVP and SS-Code AVPs within DSR. + +**apn-oi-replacementWithdraw** in DeleteSubscriberDataArg shall be present if a APN-OI-Replacement indication was received within the DSR-Flags AVP within DSR. + +**csg-SubscriptionDeleted** in DeleteSubscriberDataArg shall be present if a CSG Deleted indication was received within the DSR-Flags AVP within DSR. + +**SS-Code List** in DeleteSubscriberDataArg shall be present if SMS Withdrawal bit was set within the DSR-Flags AVP and SS-Code AVPs was within DSR. + +**subscribed-vsrvccWithdraw** in DeleteSubscriberDataArg shall be present if a Subscribed VSRVCC Withdrawal indication was received within the DSR-Flags AVP within DSR. + +#### **DeactivateTraceModeArg:** + +**imsi** in DeactivateTraceModeArg shall be populated with the value received within the User-Name AVP within DSR. + +**TraceReference** in DeactivateTraceModeArg shall be populated with the value of Trace-ID part of the Trace-Reference AVP received within DSR. + +**TraceReference2** in DeactivateTraceModeArg shall be populated with the value of MCC+MNC part of the Trace-Reference AVP received within DSR. + +### **8.6.4 DeleteSubscriberDataRes / Error mapping to DSA** + +When the IWF needs to construct a DSA command as a result of receiving a DeleteSubscriberData Ack/Error message (see sections 7.6.2 step 6), the IWF shall populate AVPs of DSA as described below: + +**Result-Code / Experimental-Result** AVP shall be set to: + +- DIAMETER\_SUCCESS if a DeleteSubscriberDataRes parameter was received in a TCAP ResultLast component; +- an appropriate DIAMETER base protocol result code otherwise. + +**Auth-Session-State** AVP shall be set to the value NO\_STATE\_MAINTAINED (1). + +**Supported-Features** AVP shall be present and shall indicate support of Regional Subscription if a Regional-Subscription-Withdrawal indication was present within the DSR-Flags AVP within DSR and no regionalSubscNotSupported indication was received in regionalSubscriptionResponse in DeleteSubscriberDataRes. + +**DSA-Flags** AVP: Flags shall be set as follows: + +- **Network-Node-Area-Restricted** shall be set to 1 if a networkNode-AreaRestricted indication was received within the regionalSubscriptionResponse parameter within DeleteSubscriberDataRes; otherwise shall be set to 0. + +## 8.7 Mapping of Parameters for the Reset Procedure + +### 8.7.1 Reset (v1 or v2) mapping to RSR + +When the IWF needs to construct a RSR command as a result of receiving a MAP-Reset message with AC version 1 or version 2 (see sections 7.7.1 step 2, and 7.7.2 step 4), the the IWF shall populate AVPs of RSR as described below: + +**Auth-Session-State** AVP shall be set to the value NO\_STATE\_MAINTAINED (1). + +**User-Id** AVPs shall be populated with the values received within the HLR-Id parameters within hlr-list within ResetArg. + +**Supported-Features** AVP shall be absent. + +### 8.7.2 RSR mapping to ResetArg (v1 or v2) + +When the IWF needs to construct MAP-Reset message as a result of receiving a RSR command (see section 7.7.2 step 2), the IWF shall open a MAP dialogue in version 1 or version 2 according to an implementation option; note that the IWF shall be prepared to fall back to v1 when v2 is chosen. Sub-parameters of ResetArg shall be populated as described below: + +**networkResource** in ResetArg (only v1) shall be set to hlr. + +**hlr-Number** in ResetArg shall be populated with a value locally assigned to the IWF and consistent with SS7 routing principles. + +**hlr-List** in ResetArg shall be populated with values received within User-Id AVPs within RSR. + +## 8.8 Mapping of Parameters for the Notification Procedure + +### 8.8.1 NOR mapping to UpdateGprsLocation-Arg + +When the IWF needs to construct a MAP-UpdateGprsLocation message as a result of receiving an NOR command (see sections 7.8.1 step 2 and 7.8.2. step 2), the IWF shall open a MAP dialogue in application context version 3 and populate sub-parameters of UpdateGprsLocation-Arg as described below: + +**imsi** in UpdateGprsLocationArg shall be populated with the value of the User-Name AVP received within NOR. + +**sgsn-Number** in UpdateGprsLocationArg shall be populated with a value locally assigned to the IWF and consistent with SS7 routing principles. + +**sgsn-Address** in UpdateGprsLocationArg shall be populated with the IP-address of the source node sending the NOR command. + +**extensionContainer** in UpdateGprsLocationArg shall be absent. + +**sgsn-Capability** in UpdateGprsLocationArg shall be absent. + +**informPreviousNetworkEntity** in UpdateGprsLocationArg shall be absent; + +**ps-LCS-NotSupportedByUE** in UpdateGprsLocationArg shall be absent + +**v-gmlc-Address** in UpdateGprsLocationArg shall be absent. + +**add-info** in UpdateGprsLocationArg shall be present if a Terminal-Information AVP was present in the received NOR. If present the parameter shall be populated with the received IMEI and software version, and with a skipSubscriberDataUpdate indication. + +**eps-info** in UpdateGprsLocationArg shall be present and contain a pdn-gw-update parameter if the received NOR contained a MIP6-Agent-Info AVP. It shall be present and contain a isr-Information parameter if the received NOR contained a Single-Registration-Indication indication within the NOR-Flags AVP. + +**servingNodeTypeIndicator** in UpdateGprsLocationArg shall be present only if the S6a/S6d-Indicator flag within the NOR-Flags AVP received within the NOR is set to 1; otherwise, it shall be absent. + +**skipSubscriberData Update** in UpdateGprsLocationArg shall be present. + +**usedRAT-Type** in UpdateGprsLocationArg shall be absent. + +**gprsSubscriptionDataNotNeeded** in UpdateGprsLocationArg shall be absent. + +**nodeTypeIndicator** in UpdateGprsLocationArg shall be absent. + +**areaRestricted** in UpdateGprsLocationArg shall be present if the corresponding information was received within the NOR-Flags AVP within a NOR; otherwise it shall be absent. + +**ue-reachableIndicator** in UpdateGprsLocationArg shall be present if the corresponding information was received within the NOR-Flags AVP within a NOR; otherwise it shall be absent. + +**ue-srvcc-Capability** in UpdateGprsLocationArg shall be present if a UE-SRVCC-Capability AVP was present in the received NOR. If present the parameter shall be populated with the received ue-srvcc-Capability. + +**homogeneousSupportOfIMSVoiceOverPSSessions** in UpdateGprsLocationArg shall be present if the corresponding information was received within the NOR; otherwise it shall be absent. + +**updateofHomogeneousSupportOfIMSVoiceOverPSSessions** in UpdateGprsLocationArg shall be present if the corresponding information was received within the NOR-Flags AVP within a NOR; otherwise it shall be absent. + +**removalofMMERegistrationforSMS** in UpdateGprsLocationArg shall be present if the corresponding information was received within the NOR-Flags AVP within a NOR; otherwise it shall be absent. + +### 8.8.2 UpdateGprsLocation-Arg mapping to NOR + +When the IWF needs to construct a NOR command as a result of receiving a MAP-UpdateGprsLocation message with a pdn-gw-update parameter within eps-info or with an isr-Information parameter within eps-info not indicating updateLocation or with a skipSubscriberDataUpdate parameter within add-info or with ue-srvcc-Capability parameter but without usedRAT-Type parameter (see section 7.8.2 step 4), the the IWF shall populate AVPs of NOR as described below: + +**Auth-Session-State** AVP shall be set to the value NO\_STATE\_MAINTAINED (1). + +**User-Name** AVP shall be populated with the value received within the imsi parameter of UpdateGprsLocation-Arg. + +**Supported-Features** AVP shall be absent. + +**Terminal-Information** AVP shall be present if an add-info parameter was present in UpdateGprsLocationArg.. + +**MIP6-Agent-Info** AVP shall be present if pdn-gw-Identity was received within pdn-gw-update parameter within eps-info within UpdateGprsLocationArg. + +**Service-Selection** AVP shall be present if apn was received within pdn-gw-update parameter within eps-info within UpdateGprsLocationArg. + +**NOR-Flags** AVP: Flags shall be set as follows: + +- Single-Registration-Indication shall be set to 1 if a cancelSGSN indication was received within the ISR-Information within the eps-info within the UpdateGprsLocationArg; otherwise it shall be set to 0. +- SGSN area restricted shall be set to 1 if an sgsnAreaRestricted indication was received within the UpdateGprsLocationArg; otherwise it shall be set to 0. + +- Ready for SM shall be set to 0. +- UE Reachable shall be set to 1 if a ue-reachableIndicator was received within the UpdateGprsLocationArg; otherwise it shall be set to 0. +- S6a/S6d-Indicator shall be set to 1 if a servingNodeTypeIndicator was received within the UpdateGprsLocationArg; otherwise it shall be set to 0. +- Homogeneous Support of IMS Voice Over PS Sessions shall be set to 1 if an updateofHomogeneousSupportOfIMSVoiceOverPSSessions was received within the UpdateGprsLocationArg; otherwise it shall be set to 0. +- Removal of MME Registration for SMS shall be set to 1 if a removalofMMERegistrationforSMS was received within the UpdateGprsLocationArg; otherwise it shall be set to 0. + +**Context-Identifier** AVP shall be present if contextId was received within pdn-gw-update parameter within eps-info within UpdateGprsLocationArg. + +**UE-SRVCC-Capability** AVP shall be present if a ue-srvcc-Capability parameter was present in UpdateGprsLocationArg. If present the AVP shall be populated with the received ue-srvcc-Capability parameter. + +**Homogeneous-Support-of-IMS-Voice-Over-PS-Sessions** AVP shall be present if updateofHomogeneousSupportOfIMSVoiceOverPSSessions was present in UpdateGprsLocationArg; otherwise it shall be absent. + +### 8.8.3 NOR mapping to ReadyForSM-Arg + +When the IWF needs to construct a MAP-ReadyForSM message as a result of receiving an NOR command (see sections 7.8.1 step 2 and 7.8.2. step 2), the IWF shall open a MAP dialogue in application context version 3 and populate sub-parameters of ReadyForSMArg as described below: + +**imsi** in ReadyForSMArg shall be populated with the value of the User-Name AVP received within NOR. + +**alertReason** in ReadyForSMArg shall be populated with the value of the Alert-Reason AVP received within NOR. + +**alertReasonIndicator** in ReadyForSMArg shall be present if the "Ready for SM from SGSN" flag within the NOR-Flags AVP received within NOR is set; otherwise it shall be absent. + +**additionalAlertReasonIndicator** in ReadyForSMArg shall be absent. + +**extensionContainer** in ReadyForSMArg shall be absent. + +**maximumUeAvailabilityTime** shall be present and populated with the value of the Max-UE-Availaibility-Time AVP, when received within NOR. + +### 8.8.4 ReadyForSM-Arg mapping to NOR + +When the IWF needs to construct a NOR command as a result of receiving a MAP-ReadyForSM message (see section 7.8.2 step 4), the the IWF shall populate AVPs of NOR as described below: + +**User-Name** AVP shall be populated with the value received within the imsi parameter of ReadyForSMArg. + +**Supported-Features** AVP shall be absent. + +**Terminal-Information** AVP shall be absent. + +**MIP6-Agent-Info** AVP shall be absent. + +**Context-Identifier** AVP shall be absent. + +**Service-Selection** AVP shall be absent. + +**Alert-Reason** AVP shall be present and populated with the value received within the alertReason parameter of ReadyForSMArg. + +**NOR-Flags** AVP: Flags shall be set as follows: + +- Single-Registration-Indication shall be set to 0. +- SGSN area restricted shall be set to 0. +- Ready for SM from SGSN shall be set to 1 if alertReasonIndicator is received within ReadyForSMArg; otherwise it shall be set to 0. +- Ready for SM from MME shall be set to 1 if alertReasonIndicator is not received within ReadyForSMArg; otherwise it shall be set to 0. +- UE Reachable shall be set to 0. +- Homogeneous Support of IMS Voice Over PS Sessions shall be set to 0. +- Removal of MME Registration for SMS shall be set to 0. + +**Maximum-UE-Availability-Time** AVP shall be present and populated with the value of the maximumUeAvailabilityTime parameter, when received in the ReadyForSMArg. + +## 8.9 Mapping of Parameters for the IMEI Check Procedure + +### 8.9.1 ECR mapping to CheckIMEI-Arg + +When the IWF needs to construct a MAP-CheckIMEI message as a result of receiving an ECR command (see section 7.9.1 step 2), the IWF shall open a MAP dialogue in application context version 3 and populate sub-parameters of CheckIMEI-Arg as described below: + +**imei** in CheckIMEI-Arg shall be populated with the imei (and software version) as received within the Terminal-Information AVP within ECR. + +**requestedEquipmentInfo** in CheckIMEI-Arg shall indicate equipmentStatus. + +**extensionContainer** in CheckIMEI-Arg shall be absent. + +### 8.9.2 CheckIMEI-Res / Error mapping to ECA + +When the IWF needs to construct an ECA command as a result of receiving a CheckIMEI Ack/Error message (see section 7.9.1 step 4), the IWF shall populate AVPs of ECA as described below: + +**Result-Code / Experimental-Result** AVP shall be set to: + +- DIAMETER\_SUCCESS if a CheckIMEI-Res parameter was received in a TCAP ResultLast component; +- DIAMETER\_ERROR\_UNKNOWN\_EQUIPMENT if an error of unknownEquipment was received; +- an appropriate DIAMETER base protocol result code otherwise. + +**Auth-Session-State** AVP shall be set to the value NO\_STATE\_MAINTAINED (1). + +**Equipment-Status** AVP shall be populated with a value as received within the equipmentStatus parameter within CheckIMEI-Res. + +## 8.10 Mapping of Parameters for the Trace Activate Procedure + +### 8.10.1 ActivateTraceMode-Arg mapping to IDR + +When the IWF needs to construct an IDR command as a result of receiving a MAP-ActivateTraceMode message (see sections 7.10.1 step 2), the IWF shall populate AVPs of the IDR as described below: + +**User-Name** AVP shall be populated with the value received within the imsi parameter of ActivateTraceModeArg. + +**Supported-Features** AVP shall be absent. + +**Subscription-Data** AVP shall be present and populated as follows: + +**Trace-Data** AVP shall be present and populated as in chapter 8.2.2. + +All other sub-AVPs shall be absent. + +### 8.10.2 IDA mapping to ActivateTraceMode-Res / Error + +When the IWF needs to construct a MAP-ActivateTraceMode Ack message as a result of receiving an IDA command (see sections 7.10.1 step 4), the IWF shall populate sub-parameters of ActivateTraceMode Res/Error as described below: + +#### ActivateTraceModeRes: + +**traceSupportIndicator** shall be present if an indication of support of this feature was received within the Supported-Feature AVP within IDA; Otherwise, it shall be absent. + +**extensionContainer** shall be absent. + +#### ActivateTraceMode Error: + +Values other than SUCCESS within the Result-Code / Experimental-Result AVP shall be mapped onto an appropriate MAP error. + +## 8.11 Mapping of Parameters for the Trace Deactivate Procedure + +### 8.11.1 DeactivateTraceMode-Arg mapping to DSR + +When the IWF needs to construct an DSR command as a result of receiving a MAP-DeactivateTraceMode message (see sections 7.11.1 step 2), the IWF shall populate AVPs of DSR as described below: + +**User-Name** AVP shall be populated with the value received within the imsi parameter of DeactivateTraceModeArg. + +**Trace-Reference** AVP shall be populated with the values received within the traceReference and traceReference2 parameters of DeactivateTraceModeArg. + +**Supported-Features** AVP shall be absent. + +**DSR-Flags** AVP: Trace Data Withdrawal shall be set to 1. All other Flags shall be set as 0. + +**Context-Identifier** AVPs shall be absent. + +### 8.11.2 DSA mapping to DeactivateTraceMode-Res / Error + +When the IWF needs to construct a MAP-DeactivateTraceMode Ack message as a result of receiving an DSA command (see sections 7.11.1 step 4), the IWF shall populate sub-parameters of DeactivateTraceMode Res/Error as described below: + +#### DeactivateTraceModeRes: + +**extensionContainer** shall be absent. + +#### DeactivateTraceMode Error: + +Values other than SUCCESS within the Result-Code / Experimental-Result AVP shall be mapped onto an appropriate MAP error. + +# --- Annex A: IWFs for the support of SMS capable MMEs or SGSNs + +## A.1 General + +This Annex describes the various cases of IWFs used for SMS related interfaces. + +## A.2 IWF related to the SGd/Gdd interfaces between MME/SGSN and central SMS functions + +### A.2.1 Introduction + +The clause A.2 with its subclauses describes the IWFs used between an MME/SGSN, supporting the SGd/Gdd interface and Central SMS functions (SMS-GMSC, SMS-IWMSC, SMS Router) supporting a MAP E interface. + +3GPP TS 23.204 [6] has specified the support of SMS for IMS UE to IMS UE without MSISDN which impacts the IWF description for the IP-SM-GW with SMS Central functions over SGd/Gdd. + +### A.2.2 General considerations + +Void + +### A.2.3 Interworking scenarios + +#### A.2.3.1 One IWF scenario + +This interworking scenario, illustrated in figure A.2.3.1-1, is between a MME/SGSN supporting SGd/Gdd interface based on Diameter and central SMS functions (SMS-GMSC, SMS-IWMSC, SMS Router) supporting a MAP based E interface for SMS with one IWF in the path. + +This interworking scenario also applies between an IP/SM/GW supporting SGd/Gdd interface based on Diameter and central SMS functions (SMS-GMSC, SMS-IWMSC) supporting a MAP based E interface for SMS with one IWF in the path, in particular for SMS for IMS UE to IMS UE without MSISDN (see 3GPP TS 23.204 [6]). + +This IWF scenario can be an inter PLMN use case where the MME/SGSN and the IWF are in the Visited PLMN. + +This IWF scenario can be an intra PLMN use case where the central SMS functions are supporting MAP based interfaces. + +![Diagram of SGd - E for SMS interworking scenario with one IWF. It shows three boxes connected by double-headed arrows. The left box is labeled 'MME/SGSN/ IP-SM-GW'. The middle box is labeled 'IWF1'. The right box is labeled 'SMS-GMSC', 'SMS-IWMSC', and 'SMS Router'. The arrow between the left and middle boxes is labeled 'SGd/Gdd'. The arrow between the middle and right boxes is labeled 'E for SMS'.](29a9cd1cb2a960eb91dbf79aab5d8668_img.jpg) + +``` + +graph LR + A[MME/SGSN/ +IP-SM-GW] <--> |SGd/Gdd| B[IWF1] + B <--> |E for SMS| C["SMS-GMSC +SMS-IWMSC +SMS Router"] + +``` + +Diagram of SGd - E for SMS interworking scenario with one IWF. It shows three boxes connected by double-headed arrows. The left box is labeled 'MME/SGSN/ IP-SM-GW'. The middle box is labeled 'IWF1'. The right box is labeled 'SMS-GMSC', 'SMS-IWMSC', and 'SMS Router'. The arrow between the left and middle boxes is labeled 'SGd/Gdd'. The arrow between the middle and right boxes is labeled 'E for SMS'. + +**Figure A.2.3.1-1 SGd - E for SMS interworking scenario with one IWF** + +For MO Forward short messages requests, the IWF shall use the SC address (E.164 number) received over SGd/Gdd for routing over MAP. + +For MT Forward short messages, the IWF shall rely on the E.164 number of the MME/SGSN used to route the MAP message towards the IWF to locally determine the Diameter address of the MME/SGSN. + +For ALR, the IWF shall use the SC address (E.164 number) received over SGd/Gdd for routing over MAP. + +#### A.2.3.2 Two IWF scenario + +This interworking scenario, illustrated in figure A.2.3.2-1 is between a MME/SGSN supporting a SGd/Gdd interface based on Diameter and central SMS functions (SMS-GMSC, SMS-IWMSC, SMS Router) supporting a SGd/Gdd interface based on Diameter with two IWF in the path, a MAP based E interface for SMS being used between the IWFs. + +This interworking scenario, also applies between an IP-SM-GW supporting a SGd/Gdd interface based on Diameter and central SMS functions (SMS-GMSC) supporting a SGd/Gdd interface based on Diameter with two IWF in the path, a MAP based E interface for SMS being used between the IWFs, in particular for SMS for IMS UE to IMS UE without MSISDN (see 3GPP TS 23.204 [6]). + +![Figure A.2.3.2-1: Two IWFs scenario. A block diagram showing four entities connected in a line: MME/SGSN/IP-SM-GW, IWF1, IWF2, and SMS-GMSC/SMS-IWMSC/SMS Router. Arrows indicate connections: SGd/Gdd between MME/SGSN/IP-SM-GW and IWF1; E for SMS between IWF1 and IWF2; and SGd/Gdd between IWF2 and SMS-GMSC/SMS-IWMSC/SMS Router.](0f6e3cdce0f01d6ccceabcced508bb5b_img.jpg) + +``` + +graph LR + A[MME/SGSN/IP-SM-GW] <-->|SGd/Gdd| B[IWF1] + B <-->|E for SMS| C[IWF2] + C <-->|SGd/Gdd| D["SMS-GMSC +SMS-IWMSC +SMS Router"] + +``` + +Figure A.2.3.2-1: Two IWFs scenario. A block diagram showing four entities connected in a line: MME/SGSN/IP-SM-GW, IWF1, IWF2, and SMS-GMSC/SMS-IWMSC/SMS Router. Arrows indicate connections: SGd/Gdd between MME/SGSN/IP-SM-GW and IWF1; E for SMS between IWF1 and IWF2; and SGd/Gdd between IWF2 and SMS-GMSC/SMS-IWMSC/SMS Router. + +**Figure A.2.3.2-1: Two IWFs scenario** + +The IWF1 is located in the PLMN of the MME/SGSN or in the PLMN of the IP-SM-GW. IWF2 is located in the PLMN of the SMS-GMSC or the SMS-IWMSC or the SMS Router. The SMS Router may be in a PLMN different from the PLMN of the SMS-GMSC. + +The IWF1 needs not to be aware whether its connection via E for SMS interface is to an IWF or to central SMS functions (see One IWF scenario). + +For routing of MO and MT forward short messages and ALR, the IWF1 shall behave as the IWF of the one IWF scenario. + +For MO Forward short messages requests, the IWF2 shall rely on the E.164 number of the SMS-SC used to route the MAP message towards the IWF2 to locally determine the Diameter address of the SMS-IWMSC. + +For MT Forward short messages requests, the IWF2 shall use the E.164 number of the MME/SGSN/IP-SM-GW received over SGd/Gdd to route the MAP message towards the IWF1. + +For ALR, the IWF2 shall route the message using the SMS-GMSC Diameter Address received in the Alert Service Centre message. + +### A.2.4 The mapping of procedures + +#### A.2.4.1 MO Forward Short Message + +##### A.2.4.1.1 One IWF Scenario + +The mapping of the MO Forward Short Message procedure for this scenario is shown in figure A.2.4.1.1-1: + +![Figure A.2.4.1.1-1: Mapping of MO Forward Short Message procedure with one IWF. A sequence diagram showing four steps: 1. OFR from MME/SGSN/IP-SM-GW to IWF; 2. MO-ForwardSM from IWF to SMS-IWMSC; 3. MO-ForwardSM Ack from SMS-IWMSC to IWF; 4. OFA from IWF to MME/SGSN/IP-SM-GW. The IWF to SMS-IWMSC connection is labeled MAP E.](68843e462129ecabfcc023c2f228999f_img.jpg) + +``` + +sequenceDiagram + participant MME/SGSN/IP-SM-GW + participant IWF + participant SMS-IWMSC + Note right of IWF: MAP E + MME/SGSN/IP-SM-GW->>IWF: 1. OFR + IWF->>SMS-IWMSC: 2. MO-ForwardSM + SMS-IWMSC-->>IWF: 3. MO-ForwardSM Ack + IWF-->>MME/SGSN/IP-SM-GW: 4. OFA + +``` + +Figure A.2.4.1.1-1: Mapping of MO Forward Short Message procedure with one IWF. A sequence diagram showing four steps: 1. OFR from MME/SGSN/IP-SM-GW to IWF; 2. MO-ForwardSM from IWF to SMS-IWMSC; 3. MO-ForwardSM Ack from SMS-IWMSC to IWF; 4. OFA from IWF to MME/SGSN/IP-SM-GW. The IWF to SMS-IWMSC connection is labeled MAP E. + +**Figure A.2.4.1.1-1: Mapping of MO Forward Short Message procedure with one IWF** + +1. The IWF receives a OFR message from the MME/SGSN/IP-SM-GW. +2. The IWF opens a MAP v3 dialogue towards the SMS-IWMSC by sending MO-ForwardSM. + +3. The IWF receives MO-ForwardSM Ack from the SMS-IWMSC. +4. The IWF sends OFA to the MME/SGSN/IP-SM-GW. + +##### A.2.4.1.2 Two IWFs Scenario + +The mapping of the MO Forward Short Message procedure for this scenario is shown in figure A.2.4.1.2-1: + +![Sequence diagram for MO Forward Short Message procedure with two IWFs. Lifelines: MME/SGSN, IWF1, IWF2, and SMS-IWMSC. The diagram shows six steps: 1. MME/SGSN sends OFR to IWF1; 2. IWF1 sends MO-ForwardSM to IWF2; 3. IWF2 sends OFR to SMS-IWMSC; 4. SMS-IWMSC sends OFA to IWF2; 5. IWF2 sends MO-ForwardSM Ack to IWF1; 6. IWF1 sends OFA to MME/SGSN. Above the lifelines, 'SGd/Gdd' is shown under MME/SGSN, IWF1, and IWF2, and 'MAP E' is shown between IWF1 and IWF2.](d6c377ae3e619ff992bd3647dbf43593_img.jpg) + +``` +sequenceDiagram + participant MME/SGSN + participant IWF1 + participant IWF2 + participant SMS-IWMSC + Note over MME/SGSN: SGd/Gdd + Note over IWF1: SGd/Gdd + Note over IWF2: SGd/Gdd + Note between IWF1 and IWF2: MAP E + MME/SGSN->>IWF1: 1. OFR + IWF1->>IWF2: 2. MO-ForwardSM + IWF2->>SMS-IWMSC: 3. OFR + SMS-IWMSC->>IWF2: 4. OFA + IWF2->>IWF1: 5. MO-ForwardSM Ack + IWF1->>MME/SGSN: 6. OFA +``` + +Sequence diagram for MO Forward Short Message procedure with two IWFs. Lifelines: MME/SGSN, IWF1, IWF2, and SMS-IWMSC. The diagram shows six steps: 1. MME/SGSN sends OFR to IWF1; 2. IWF1 sends MO-ForwardSM to IWF2; 3. IWF2 sends OFR to SMS-IWMSC; 4. SMS-IWMSC sends OFA to IWF2; 5. IWF2 sends MO-ForwardSM Ack to IWF1; 6. IWF1 sends OFA to MME/SGSN. Above the lifelines, 'SGd/Gdd' is shown under MME/SGSN, IWF1, and IWF2, and 'MAP E' is shown between IWF1 and IWF2. + +**Figure A.2.4.1.2-1: Mapping of MO Forward Short Message procedure with two IWFs** + +1. The IWF1 receives an OFR message from the MME/SGSN. +2. The IWF1 opens a MAP v3 dialogue towards IWF2 by sending MO-ForwardSM. +3. The IWF2 constructs the OFR message and sends it to the SMS-IWMSC. +4. The IWF2 receives the OFA message from the SMS-IWMSC. +5. The IWF2 closes the MAP dialogue with the IWF2 by sending MO-ForwardSM Ack. +6. The IWF1 sends the OFA message to the MME/SGSN. + +#### A.2.4.2 MT Forward Short Message + +##### A.2.4.2.1 One IWF Scenario + +The mapping of the MT Forward Short Message procedure for this scenario is shown in figure A.2.4.2.1-1: + +![Sequence diagram for MT Forward Short Message procedure with one IWF.](4b398c5e8c4fd656d5b7a61806400650_img.jpg) + +Sequence diagram illustrating the mapping of the MT Forward Short Message procedure with one IWF. The diagram shows four lifelines: MME/SGSN/IP-SM-GW, SGd/Gdd, IWF, and SMS-GMSC or SMS Router. The interaction is as follows: + +1. The SMS-GMSC or SMS Router sends a MT-ForwardSM message to the IWF. +2. The IWF sends a TFR message to the MME/SGSN/IP-SM-GW. +3. The MME/SGSN/IP-SM-GW sends a TFA message to the IWF. +4. The IWF sends a MT-ForwardSM Ack message to the SMS-GMSC or SMS Router. + +Sequence diagram for MT Forward Short Message procedure with one IWF. + +**Figure A.2.4.2.1-1: Mapping of MT Forward Short Message procedure with one IWF** + +1. The IWF receives a [MT-ForwardSM](#) MAP v3 message from the SMS-GMSC or from the SMS Router. +2. The IWF sends TFR to the MME/SGSN/IP-SM-GW. +3. The IWF receives TFA. +4. The IWF closes the MAP dialogue with the SMS-GMSC or the SMS Router by sending [MT-ForwardSM Ack](#). + +##### A.2.4.2.2 Two IWFs Scenario + +The mapping of the MT Forward Short Message procedure for this scenario is shown in figure A.2.4.2.2-1: + +![Sequence diagram for MT Forward Short Message procedure with two IWFs.](4bfb457b83429c217736e6d51b2f3945_img.jpg) + +Sequence diagram illustrating the mapping of the MT Forward Short Message procedure with two IWFs. The diagram shows six lifelines: MME/SGSN/IP-SM-GW, SGd/Gdd, IWF1, MAP E, IWF2, SGd/Gdd, and SMS-GMSC or SMS Router. The interaction is as follows: + +1. The SMS-GMSC or SMS Router sends a TFR message to IWF2. +2. IWF2 sends a MT-ForwardSM message to IWF1. +3. IWF1 sends a TFR message to the MME/SGSN/IP-SM-GW. +4. The MME/SGSN/IP-SM-GW sends a TFA message to IWF1. +5. IWF1 sends a MT-ForwardSM Ack message to IWF2. +6. IWF2 sends a TFA message to the SMS-GMSC or SMS Router. + +Sequence diagram for MT Forward Short Message procedure with two IWFs. + +**Figure A.2.4.2.2-1: Mapping of MT Forward Short Message procedure with two IWFs** + +1. The IWF2 receives a TFR message from the SMS-GMSC or the SMS Router. +2. The IWF2 opens a MAP v3 dialogue towards IWF1 by sending MT-ForwardSM. + +3. The IWF1 constructs the TFR message and sends it to the MME/SGSN/IP-SM/GW. +4. The IWF1 receives the TFA message from the MME/SGSN/IP-SM-GW. +5. The IWF1 closes the MAP dialogue with the IWF1 by sending MT-ForwardSM Ack. +6. The IWF2 sends an OFA message to the SMS-GMSC or the SMS Router. + +#### A.2.4.3 Alert Service Centre + +##### A.2.4.3.1 One IWF Scenario + +The mapping of the Alert Service Center procedure for this scenario is shown in figure A.2.4.3.1-1: + +![Sequence diagram showing the mapping of Alert Service Centre procedure with one IWF. The diagram involves three main entities: MME/SGSN, IWF, and SMS-GMSC or SMS Router. The MME/SGSN sends an ALR message to the IWF. The IWF sends an alertServiceCenter message to the SMS-GMSC or SMS Router. The SMS-GMSC or SMS Router responds with an alertServiceCenter Ack message to the IWF. Finally, the IWF sends an ALA message back to the MME/SGSN. The diagram also indicates the use of SGd/Gdd and MAP E protocols.](1399c76ef88f22b70d05ed3f781d3c48_img.jpg) + +``` +sequenceDiagram + participant MME/SGSN + participant IWF + participant SMS-GMSC or SMS Router + Note right of MME/SGSN: SGd/Gdd + Note right of IWF: MAP E + MME/SGSN->>IWF: 1. ALR + IWF->>SMS-GMSC or SMS Router: 2. alertServiceCenter + SMS-GMSC or SMS Router-->>IWF: 3. alertServiceCenter Ack + IWF->>MME/SGSN: 4. ALA +``` + +Sequence diagram showing the mapping of Alert Service Centre procedure with one IWF. The diagram involves three main entities: MME/SGSN, IWF, and SMS-GMSC or SMS Router. The MME/SGSN sends an ALR message to the IWF. The IWF sends an alertServiceCenter message to the SMS-GMSC or SMS Router. The SMS-GMSC or SMS Router responds with an alertServiceCenter Ack message to the IWF. Finally, the IWF sends an ALA message back to the MME/SGSN. The diagram also indicates the use of SGd/Gdd and MAP E protocols. + +**Figure A.2.4.3.1-1: Mapping of Alert Service Centre procedure with one IWF** + +1. The IWF receives an ALR message from the MME or SGSN. +2. The IWF opens a MAP v3 dialogue towards the SMS-GMSC or SMS Router by sending an alertServiceCentre. +3. The IWF receives an alertServiceCentre Ack from the SMS-GMSC or SMS Router. +4. The IWF sends an ALA message to the MME or SGSN. + +##### A.2.4.3.2 Two IWFs Scenario + +The mapping of the Alert Service Center procedure for this scenario is shown in figure A.2.4.x.2-1: + +![Sequence diagram showing the mapping of Alert Service Centre procedure with two IWFs. The diagram involves four lifelines: MME/SGSN, IWF1, IWF2, and SMS-GMSC or SMS Router. The sequence of messages is: 1. ALR from MME/SGSN to IWF1; 2. alertServiceCenter from IWF1 to IWF2; 3. ALR from IWF2 to SMS-GMSC or SMS Router; 4. ALA from SMS-GMSC or SMS Router to IWF2; 5. alertServiceCenter Ack from IWF2 to IWF1; 6. ALA from IWF1 to MME/SGSN. Above the lifelines, 'SGd/Gdd' is indicated for MME/SGSN, IWF1, and IWF2, and 'MAP E' is indicated for the IWF1-IWF2 interaction.](694df81535f89c7bfb9ef0df6f130dc0_img.jpg) + +``` + +sequenceDiagram + participant MME/SGSN + participant IWF1 + participant IWF2 + participant SMS-GMSC or SMS Router + + Note right of MME/SGSN: SGd/Gdd + Note right of IWF1: MAP E + Note right of IWF2: SGd/Gdd + + MME/SGSN->>IWF1: 1. ALR + IWF1->>IWF2: 2. alertServiceCenter + IWF2->>SMS-GMSC or SMS Router: 3. ALR + SMS-GMSC or SMS Router->>IWF2: 4. ALA + IWF2->>IWF1: 5. alertServiceCenter Ack + IWF1->>MME/SGSN: 6. ALA + +``` + +Sequence diagram showing the mapping of Alert Service Centre procedure with two IWFs. The diagram involves four lifelines: MME/SGSN, IWF1, IWF2, and SMS-GMSC or SMS Router. The sequence of messages is: 1. ALR from MME/SGSN to IWF1; 2. alertServiceCenter from IWF1 to IWF2; 3. ALR from IWF2 to SMS-GMSC or SMS Router; 4. ALA from SMS-GMSC or SMS Router to IWF2; 5. alertServiceCenter Ack from IWF2 to IWF1; 6. ALA from IWF1 to MME/SGSN. Above the lifelines, 'SGd/Gdd' is indicated for MME/SGSN, IWF1, and IWF2, and 'MAP E' is indicated for the IWF1-IWF2 interaction. + +**Figure A.2.4.3.2-1: Mapping of Alert Service Centre procedure with two IWFs** + +1. The IWF1 receives an ALR message from the MME or SGSN. +2. The IWF1 opens a MAP v3 dialogue towards the IWF2 by sending an alertServiceCentre. +3. The IWF2 sends an ALR message to the SMS-GMSC or SMS Router. +4. The IWF2 receives an ALA from the SMS-GMSC or SMS Router. +5. The IWF2 sends an alertServiceCenter Ack to the IWF1. +6. The IWF1 sends an ALA message to the MME or SGSN. + +### A.2.5 The mapping of parameters + +#### A.2.5.1 Mapping of Parameters for the MO Forward Short Message procedure + +##### A.2.5.1.1 OFR mapping to MO-ForwardSM-Arg + +When the IWF needs to construct a MAP MO-ForwardSM message as a result of receiving an OFR command (see subclause A.2.4.1.1 step 2), the IWF shall open a MAP dialogue in application context version 3 and populate sub-parameters of MO-ForwardSM-Arg as described below: + +**sm-RP-DA** in MO-ForwardSM-Arg shall be present and populated with the value received within the SC-Address AVP within OFR. + +**sm-RP-OA** in MO-ForwardSM-Arg shall be present and populated with the value received within the MSISDN AVP within the User-Identifier AVP within OFR. + +**sm-RP-UI** in MO-ForwardSM-Arg shall be present and populated with the value received within the SM-RP-UI AVP within OFR + +**extensionContainer** in MO-ForwardSM-Arg shall be present . + +**imsi** in MO-ForwardSM-Arg shall be present and populated with the value received within the User-Name AVP in the User-Identifier AVP within OFR. . + +**correlationID** in MO-ForwardSM-Arg shall be present if SMSMI-Correlation-ID AVP in OFR is present and be populated as follows: + +**hlr-id** parameter shall be populated with the value received within HSS-ID AVP within SMSMI-Correlation-ID AVP within OFR. + +**sip-uri-A parameter** shall be populated with the value received within Originating-SIP-URI AVP within SMSMI-Correlation-ID AVP within OFR. + +**sip-uri-B parameter** shall be populated with the value received within Destination-SIP-URI AVP within SMSMI-Correlation-ID AVP within OFR. + +**sm-DeliveryOutcome** in MO-ForwardSM-Arg shall be present if SMSMI-Correlation-ID AVP in OFR is present and be populated with the value received in SM-Delivery-Cause within IP-SM-GW-SM-Delivery-Outcome within SM-Delivery-Outcome within OFR. + +##### A.2.5.1.2 MO-ForwardSM-Res / Error mapping to OFA + +When the IWF needs to construct an OFA command as a result of receiving a MAP MO-ForwardSM Ack/Error message (see subclause A.2.4.1.1 step 4), the IWF shall populate AVPs of OFA as described below: + +**Result-Code / Experimental-Result** AVP shall be set to: + +- DIAMETER\_SUCCESS if a MO-ForwardSM-Res parameter was received in the TCAP ResultLast component; +- DIAMETER\_ERROR\_FACILITY\_NOT\_SUPPORTED if an error of facilityNotSupported was received; +- DIAMETER\_UNABLE\_TO\_COMPLY if an error of systemFailure was received; +- DIAMETER\_SM\_DELIVERY\_FAILURE if an error of sm-DeliveryFailure was received; +- an appropriate DIAMETER base protocol result code otherwise. + +**SM-Delivery- Failure-Cause** AVP: shall be populated as follows: + +**SM-Enumerated-Delivery-Failure-Cause** AVP shall be present and populated with the value received within the SM-EnumeratedDeliveryFailureCause parameter, when present, within the sm-DeliveryFailureCause of the MO-ForwardSM message. + +**SM-Diagnostic-Info** AVP shall be populated with the value received within the diagnosticInfo parameter, when present, within the sm-DeliveryFailureCause within the MO-ForwardSM message. + +**SM-RP-UI** AVP shall be populated with the value received within the sm-RP-UI parameter, when present, of the MT-ForwardSM-Res message. + +#### A.2.5.1.3 MO-ForwardSM-Arg mapping to OFR + +When the IWF needs to construct a OFR command as a result of receiving a MAP MO-ForwardSM message (see subclause A.2.4.1.2 step 3), the IWF shall populate AVPs of OFR as described below: + +**User-Name** AVP shall be present and populated with the value received within the sm-RP-DA parameter of MO-ForwardSM-Arg and translated into an UTF8String format. + +**User Identifier** AVP shall be present and shall be populated as follows: + +**User-Name** AVP shall be present and populated with the value received within the imsi parameter of MO-ForwardSM-Arg and translated into an UTF8String format. + +**MSISDN** AVP shall be populated with the value received within the sm-RP-OA parameter of MO-ForwardSM-Arg + +**SM-RP-UI** AVP shall be populated with the value received within the sm-RP-UI parameter of MO-ForwardSM-Arg + +**Supported-Features** AVP shall be absent. + +#### A.2.5.1.4 OFA mapping to MO-ForwardSM-Res/Error + +When the IWF needs to construct MAP MO-ForwardSM Ack message as a result of receiving a OFA command (see subclause A.2.4.1.2 step 5), the IWF shall populate sub-parameters of MO-ForwardSM-Res/Error as described below: + +**mo-ForwardSM-Res:** + +**sm-RP-UI** in MO-ForwardSM-Res shall be populated with the value received within the SM-RP-UI AVP when present. + +**extensionContainer** in MO-ForwardSM-Res shall be absent. + +**mo-ForwardSM Error:** + +Values other than SUCCESS within the Result-Code / Experimental-Result AVP shall be mapped onto the following MAP errors: + +- An error of **systemFailure** if a DIAMETER\_UNABLE\_TO\_COMPLY result was received; +- An error of **unexpectedDataValue** if a DIAMETER\_INVALID\_AVP\_VALUE result was received; +- An error of **facilityNotSupported** if a DIAMETER\_ERROR\_FACILITY\_NOT\_SUPPORTED result was received; +- An error of **sm-DeliveryFailure** if a DIAMETER\_ERROR\_SM\_DELIVERY\_FAILURE. +- **sm-DeliveryFailureCause** when a DIAMETER\_ERROR\_SM\_DELIVERY\_FAILURE result was received, shall be populated as follows: + - **SM-EnumeratedDeliveryFailureCause** shall be populated with the value received within the SM-Enumerated-Delivery-Failure-Cause AVP within the SM-DeliveryFailureCause AVP within OFA; + - **diagnosticInfo** parameter shall be populated with the value received within the SM-Diagnostic-Info AVP, when present, within the SM-DeliveryFailureCause AVP within OFA. + +## A.2.5.2 Mapping of Parameters for the MT Forward Short Message Procedure + +### A.2.5.2.1 MT-ForwardSM-Arg mapping to TFR + +When the IWF needs to construct a TFR command as a result of receiving a MAP MT-ForwardSM message (see subclause A.2.4.2.1 step 2), the IWF shall populate AVPs of TFR as described below: + +**User-Name** AVP shall be populated with the value received within the sm-RP-DA parameter of MT-ForwardSM-Arg. + +**SC-Address** AVP shall be populated with the value received within the sm-RP-OA parameter of MT-ForwardSM-Arg + +**SM-RP-UI** AVP shall be populated with the value received within the sm-RP-UI parameter of MT-ForwardSM-Arg + +**SMSMI-Correlation-ID** AVP shall be present if correlationID in MT-ForwardSM-Arg is present and be populated as follows: + +**Originating-SIP-URI** AVP shall be populated with the value received within the sip-uri-A parameter within correlationID of MT-ForwardSM-Arg. + +**Destination-SIP-URI** AVP shall be populated with the value received within the sip-uri-B parameter within correlationID of MT-ForwardSM-Arg. + +**TFR-Flags** AVP: Flags shall be set as follows: + +**More-Messages- To-Send** shall be set to 1 if the moreMessagesToSend parameter was present within MT-ForwardSM-Arg; otherwise shall be set to 0 or the AVP shall be absent. + +**Supported-Features** AVP shall be absent. + +**SM-Delivery-Timer** AVP shall be present and populated with the value of the smDeliveryTime, when present within the MT-ForwardSM-Arg. + +**SM-Delivery- Start-Time** AVP shall be present and populated with the value of the smDeliveryStartTime, when present within the MT-ForwardSM-Arg. + +**Maximum-Retransmission-Time** AVP shall be present and populated with the value of the maximumRetransmissionTime parameter, when present within the MT-ForwardSM-Arg. + +**SMS-GMSC Address AVP** shall be present and populated with the value of the smsGmscAddress parameter, when present within the MT-ForwardSM-Arg. + +#### A.2.5.2.2 TFA mapping to MT-ForwardSM-Res/Error + +When the IWF needs to construct MAP MT-ForwardSM Ack message as a result of receiving a TFA command (see subclause A.2.4.2.1 step 4), the IWF shall populate sub-parameters of MT-ForwardSM-Res/Error as described below: + +##### **mt-ForwardSM-Res:** + +**sm-RP-UI** in MO-ForwardSM-Res shall be populated with the value received within the SM-RP-UI AVP when present. + +**extensionContainer** in MT-ForwardSM-Res shall be absent. + +##### **mt-ForwardSM Error:** + +Values other than SUCCESS within the Result-Code / Experimental-Result AVP shall be mapped onto the following MAP errors: + +- An error of **systemFailure** error if a DIAMETER\_UNABLE\_TO\_COMPLY result was received; +- An error of **dataMissing** if a DIAMETER\_MISSING\_AVV result was received; +- An error of **unexpectedDataValue** if a DIAMETER\_INVALID\_AVV\_VALUE result was received; +- An error of **facilityNotSupported** if a DIAMETER\_ERROR\_FACILITY\_NOT\_SUPPORTED result was received; +- An error of **unidentifiedSubscriber** if a DIAMETER\_ERROR\_USER\_UNKNOWN result was received; +- An error of **illegalSubscriber** if a DIAMETER\_ERROR\_ILLEGAL\_USER result was received; +- An error of **illegalEquipment** if a DIAMETER\_ERROR\_ILLEGAL\_EQUIPMENT result was received; +- An error of **subscriberBusyForMT-SMS** if a DIAMETER\_ERROR\_USER\_BUSY\_FOR\_MT\_SMS result was received; +- An error of **sm-DeliveryFailure** if a DIAMETER\_ERROR\_SM\_DELIVERY\_FAILURE result was received; +- An error of **absentSubscriberSM** if a DIAMETER\_ERROR\_ABSENT\_USER result was received. +- **sm-DeliveryFailureCause**, when a DIAMETER\_ERROR\_SM\_DELIVERY\_FAILURE result was received, shall be populated as follows: + - **SM-EnumeratedDeliveryFailureCause** shall be populated with the value received within the SM-Enumerated-Delivery-Failure-Cause AVP within the SM-DeliveryFailureCause AVP within TFA; + - **diagnosticInfo** shall be populated with the value received within the SM-Diagnostic-Info AVP, when present, within the SM-DeliveryFailureCause AVP within TFA. +- **absentSubscriberDiagnosticSM**, when a DIAMETER\_ERROR\_ABSENT\_USER result was received, shall be populated with the value received within the Absent-Subscriber-Diagnostic-SM AVP, when present, within TFA. +- **requestedRetransmissionTime** shall be present and populated with the value received in the Requested-Retransmission-Time AVP, when present, within TFA. + +#### A.2.5.2.3 TFR mapping to MT-ForwardSM-Arg + +When the IWF needs to construct a MAP MT-ForwardSM message as a result of receiving a TFR command (see subclause A.2.4.2.2 step 2), the IWF shall open a MAP dialogue in application context version 3 and populate sub-parameters of MT-ForwardSM-Arg as described below: + +**sm-RP-DA** in MT-ForwardSM-Arg shall be present and populated with the value received within the User-Name AVP within TFR. + +**sm-RP-OA** in MT-ForwardSM-Arg shall be present and populated with the value received within the SC-Address AVP within TFR. + +**correlationID** in MT-ForwardSM-Arg shall be present if SMSMI-Correlation-ID AVP in TFR is present and be populated as follows: + +**sip-uri-A parameter** shall be populated with the value received within Originating-SIP-URI AVP within SMSMI-Correlation-ID AVP within TFR. + +**sip-uri-B parameter** shall be populated with the value received within Destination-SIP-URI AVP within SMSMI-Correlation-ID AVP within TFR. + +**sm-RP-UI** in MT-ForwardSM-Arg shall be present and populated with value received within the SM-RP-UI AVP within TFR + +**moreMessagesToSend** shall be present if the More-Messages-To-Send flag is set to 1 within the TFR-Flags AVP within MT-ForwardSM-Arg. + +**smDeliveryTime** in MT-ForwardSM-Arg shall be present and populated with the value within the SM-Delivery-Timer AVP when received within TFR. + +**smDeliveryStartTime** in MT-ForwardSM-Arg shall be present and populated with the value within the SM-Delivery-Start-Time AVP when received within TFR. + +**maximumRetransmissionTime** in MT-ForwardSM-Arg shall be present and populated with the value of the Maximum-Retransmission-Time AVP when received within TFR. + +**smsGmscAddress** shall be present and populated with the value within the SMS-GMSC Address AVP, when received within TFR. + +NOTE: The value of the MME-Number-For-MT-SMS AVP or of the SGSN-Number AVP is not conveyed in the MAP MT-ForwardSM message but is used by IWF2 for routing the MAP MT-ForwardSM message towards IWF1. + +#### A.2.5.2.4 MT-ForwardSM-Res / Error mapping to TFA + +When the IWF needs to construct a TFA command as a result of receiving a MAP MT-ForwardSM Ack/Error message (see subclause A.2.4.2.2 step 6), the IWF shall populate AVPs of TFA as described below: + +**Result-Code / Experimental-Result** AVP shall be set to: + +- DIAMETER\_SUCCESS if a MT-ForwardSM-Res parameter was received in the TCAP ResultLast component; +- DIAMETER\_ERROR\_USER\_UNKNOWN if an error of unidentifiedSubscriber was received; +- DIAMETER\_ERROR\_ABSENT\_USER if an error of absentSubscriberSM was received; +- DIAMETER\_ERROR\_USER\_BUSY\_FOR\_MT\_SMS if an error of subscriberBusyForMT-SMS was received; +- DIAMETER\_ERROR\_ILLEGAL\_USER if an error of illegalSubscriber was received; +- DIAMETER\_ERROR\_ILLEGAL\_EQUIPMENT if an error of illegalEquipment was received +- DIAMETER\_UNABLE\_TO\_COMPLY if an error of systemFailure was received +- DIAMETER\_SM\_DELIVERY\_FAILURE if an error of sm-DeliveryFailure was received; +- an appropriate DIAMETER base protocol result code otherwise. + +**SM-Delivery-Failure-Cause** AVP, when an error of sm-DeliveryFailure was received, shall be populated as follows: + +- **SM-Enumerated-Delivery-Failure-Cause** AVP shall be present and populated with the value received within the SM-EnumeratedDeliveryFailureCause parameter of the MT-ForwardSM Error message. +- **SM-Diagnostic-Info** AVP shall be populated with the value received within the diagnosticInfo parameter, when present, within the sm-DeliveryFailureCause within the MT-ForwardSM Error message. + +**Absent-Subscriber-Diagnostic-SM** AVP, when an error of absentSubscriberSM was received, shall be populated with the value received within the absentSubscriberDiagnosticSM parameter of the MT-ForwardSM Error message. + +**SM-RP-UI** AVP shall be populated with the value received within the sm-RP-UI parameter, when present, of the MT-ForwardSM-Res message. + +**Requested-Retransmission-Time** AVP shall be present and populated with the value received within the requestedRetransmissionTime parameter, when present within the MT-ForwardSM Error message. + +## A.2.5.3 Mapping of Parameters for the Alert Service Centre Procedure + +### A.2.5.x.1 ALR mapping to alertServiceCentre-Arg + +When the IWF needs to construct a MAP alertServiceCentre message as a result of receiving an ALR command, the IWF shall open a MAP dialogue in application context version 3 and populate sub-parameters of alertServiceCentre-Arg as described below: + +- **msisdn** shall be populated with the dummy MSISDN value (see clause 3 of 3GPP TS 23.003 [7]) + +NOTE: No MSISDN AVP is present in this scenario within the User-Identifier AVP in the ALR message. + +- **imsi** shall be populated with the value received within User-Name AVP within the User-Identifier AVP within ALR. +- **serviceCentreAddress** shall be present and populated with the value received within the SC-Address AVP within ALR. +- **newSgsnNumber** shall be present and populated with the value received within the SGSN-Number AVP of the Serving-Node AVP within ALR. +- **newMmeNumber** shall be present and populated with the value received within the MME-Number-for-MT-SMS AVP of the Serving-Node AVP within ALR. +- **newSgsnDiameterAddress** shall be present and populated with the value received within the SGSN-Name and SGSN-Realm AVPs of the Serving-Node AVP, when present in ALR. +- **newMmeDiameterAddress** shall be present and populated with the value received within the MME-Name and MME-Realm AVPs of the Serving-Node AVP, when present in ALR. +- **smsGmscAlertEvent** shall be present and populated with the value received within the SMS-GMSC-Alert-Event AVP within ALR. +- **smsGmscDiameterAddress** shall be present and populated with the value received in the Destination-Host and Destination-Realm in ALR. + +### A.2.5.3.2 alertServiceCentre-Res / Error mapping to ALA + +When the IWF needs to construct an ALA command as a result of receiving a MAP alertServiceCentre Ack/Error message, the IWF shall populate AVPs of ALA as described below: + +**Result-Code / Experimental-Result** AVP shall be set to: + +- DIAMETER\_SUCCESS if no error was received in the TCAP ResultLast component; +- a DIAMETER base protocol result code according to the following table: + +**Table A.2.5.3.2-1 Mapping from MAP error codes to Diameter error codes** + +| MAP error code | Diameter Result code / Experimental Result | +|----------------------------|--------------------------------------------| +| systemFailure | DIAMETER_UNABLE_TO_COMPLY | +| dataMissing | DIAMETER_MISSING_AVV | +| unexpectedDataValue | DIAMETER_INVALID_AVV_VALUE | + +Supported Features AVP shall be absent. + +#### A.2.5.3.3 alertServiceCentre-Arg mapping to ALR + +When the IWF needs to construct an ALR command as a result of receiving a MAP alertServiceCentre message, the IWF shall populate the ALR as described below: + +- **User-Name AVP within User-Identifier AVP** shall be present and populated with the value received within the imsi parameter of the alertServiceCenter-Arg. +- **SC-Address AVP** shall be present and populated with the value received within the serviceCentreAddress parameter of the alertServiceCenter-Arg. +- **SGSN-Number AVP of the Serving-Node AVP** shall be present and populated with the value received within the newSgsnNumber of the alertServiceCenter-Arg. +- **MME-Number-for-MT-SMS AVP** shall be present and populated with the value received within the newMmeNumber of the alertServiceCenter-Arg. +- **SGSN-Name and SGSN-Realm AVPs of the Serving-Node AVP** shall be present and populated with the value received within newSgsnDiameterAddress, when present in the alertServiceCenter-Arg. +- **MME-Name and MME-Realm AVPs** shall be present and populated with the value received within newMmeDiameterAddress, when present in the alertServiceCenter-Arg. +- **SMS-GMSC-Alert-Event AVP** shall be present and populated with the value received within the smsGmscAlertEvent of the alertServiceCenter-Arg. +- **Destination-Host and Destination-Realm AVPs** shall be present and populated with the value received in the smsGmscDiameterAddress in the alertServiceCenter-Arg. + +#### A.2.5.3.4 ALA mapping to alertServiceCentre-Res + +When the IWF needs to construct a MAP alertServiceCentre Ack/Error message as a result of receiving an ALA command, the IWF shall populate the MAP alertServiceCenter Ack/Error as described below: + +MAP error code shall be set as follows: + +**Table A.2.5.3.4-1 Mapping from Diameter error codes to MAP error codes** + +| Diameter Result code / Experimental Result | MAP error code | +|--------------------------------------------|----------------------------| +| DIAMETER_UNABLE_TO_COMPLY | systemFailure | +| DIAMETER_MISSING_AVV | dataMissing | +| DIAMETER_INVALID_AVV_VALUE | unexpectedDataValue | + +## A.3. IWF related to the S6c interface between HSS and central SMS functions + +### A.3.1 Introduction + +3GPP TS 23.272 [3] has specified the "SMS in MME" architecture option, where an IWF between the HSS supporting the S6c interface and the central SMS functions (SMS-GMSC, SMS-IWMSC, SMS Router) supporting the MAP C interface for SMS is defined. This S6c IWF is described in the following subclauses. + +3GPP TS 23.204 [6] has specified the support of SMS for IMS UE to IMS UE without MSISDN which impacts the IWF description over S6c. + +### A.3.2 Interworking scenarios + +#### A.3.2.1 IWF scenario + +This interworking scenario is illustrated in the two following figures: + +- in figure A.3.2.1-1, an IWF is between a HSS supporting the S6c interface based on Diameter and central SMS functions (SMS-GMSC, SMS-IWMSC) supporting a MAP based C interface for SMS. There is no SMS Router. +- in figure A.3.2.1-2, there is a SMS router used for MT SMS with which the IWF will interact, taking into account that Diameter requests from the IWF, according to operator configuration, are sent to the SMS Router either directly or via the HSS. + +This IWF scenario can be an inter PLMN use case where the HSS, the SMS Router, the IP-SM-GW and the IWF are in the Home PLMN. + +In the Home PLMN, when the HSS supports S6c, the SMS Router shall also support S6c, i.e. there is no IWF between HSS and SMS Router. + +This IWF scenario can be an intra PLMN use case. + +![Figure A.3.2.1-1: S6c - C for SMS interworking scenario with an IWF](a27134bc3a3c899782febdd02b502240_img.jpg) + +``` +graph LR; HSS[HSS] <--> |S6c| IWF[IWF]; IWF <--> |C for SMS| SMS[\"SMS-GMSC +SMS-IWMSC\"]; +``` + +The diagram shows three rectangular boxes arranged horizontally. From left to right, they are labeled 'HSS', 'IWF', and 'SMS-GMSC SMS-IWMSC'. A double-headed arrow labeled 'S6c' connects the 'HSS' box to the 'IWF' box. Another double-headed arrow labeled 'C for SMS' connects the 'IWF' box to the 'SMS-GMSC SMS-IWMSC' box. + +Figure A.3.2.1-1: S6c - C for SMS interworking scenario with an IWF + +Figure A.3.2.1-1 S6c - C for SMS interworking scenario with an IWF + +![Figure A.3.2.1-2: S6c - C for SMS interworking scenario with SMS Router and an IWF](9d1df8fe4616b242b4846c78ea8970f5_img.jpg) + +``` +graph LR; HSS[HSS] <--> |S6c| IWF[IWF]; IWF <--> |C for SMS| SMS[\"SMS-GMSC\"]; HSS <--> |S6c| SR[\"SMS Router +IP-SM-GW\"]; SR <--> |S6c| IWF; +``` + +The diagram shows four rectangular boxes. At the top left is 'HSS', at the top center is 'IWF', and at the top right is 'SMS-GMSC'. At the bottom center is a box labeled 'SMS Router IP-SM-GW'. A double-headed arrow labeled 'S6c' connects 'HSS' to 'IWF'. A double-headed arrow labeled 'C for SMS' connects 'IWF' to 'SMS-GMSC'. A double-headed arrow labeled 'S6c' connects 'HSS' to 'SMS Router IP-SM-GW'. Another double-headed arrow labeled 'S6c' connects 'SMS Router IP-SM-GW' to 'IWF'. + +Figure A.3.2.1-2: S6c - C for SMS interworking scenario with SMS Router and an IWF + +Figure A.3.2.1-2 S6c - C for SMS interworking scenario with SMS Router and an IWF + +### A.3.3 General considerations + +#### A.3.3.1 Routing considerations + +MAP requests issued by the SMS-GMSC are routed to the IWF on the basis of the SSN and of the MSISDN, then the corresponding Diameter requests are routed on the basis of the Diameter application identifier and of the MSISDN or of the IMSI. If a SMS router is deployed, the HSS will forward the Send Routing Info for SM commands to the SMS router. + +In a retry context of SMS for IMS UE to IMS UE without MSISDN (see 3GPP TS 23.204 [6]), the MAP requests issued by the SMS-GMSC or the SMS-SC are routed to the IWF on the basis of the SSN and of the HSS ID, then the corresponding Diameter requests are routed on the basis of the Diameter application identifier and of the HSS ID. In this case, the HSS does not forward the Send Routing Info for SM commands to the IP-SM-GW. + +Diameter requests (i.e when an Alert procedure) issued by the HSS are routed to the IWF on the basis of the application identifier and of the SC-Address AVP containing the SMS-SC number. Then the corresponding MAP request is routed to the SMS-IWMSC on the basis of the SSN and of the SMS-SC number. + +### A.3.4 The mapping of procedures + +#### A.3.4.1 Send Routing Info for SM + +The mapping of the Send Routing Info for SM procedure is shown in figure A.3.4.1-1: + +![Sequence diagram showing the mapping of the Send Routing Info for SM procedure. The diagram involves three main entities: HSS or SMS Router or IP-SM-GW, IWF, and SMS-GMSC. The IWF and SMS-GMSC communicate via a MAP C interface, while the IWF and HSS or SMS Router or IP-SM-GW communicate via an S6c interface. The sequence of messages is: 1. sendRoutingInfoForSM from SMS-GMSC to IWF; 2. SRR from IWF to HSS or SMS Router or IP-SM-GW; 3. SRA from HSS or SMS Router or IP-SM-GW to IWF; 4. sendRoutingInfoForSM Ack from IWF to SMS-GMSC; 5. informServiceCentre from IWF to SMS-GMSC.](5152ddc7d77f41ae1eaf931aaac810eb_img.jpg) + +``` +sequenceDiagram + participant HSS or SMS Router or IP-SM-GW + participant IWF + participant SMS-GMSC + Note right of HSS or SMS Router or IP-SM-GW: S6c + Note right of IWF: MAP C + SMS-GMSC->>IWF: 1. sendRoutingInfoForSM + IWF->>HSS or SMS Router or IP-SM-GW: 2. SRR + HSS or SMS Router or IP-SM-GW->>IWF: 3. SRA + IWF->>SMS-GMSC: 4. sendRoutingInfoForSM Ack + IWF->>SMS-GMSC: 5. informServiceCentre +``` + +Sequence diagram showing the mapping of the Send Routing Info for SM procedure. The diagram involves three main entities: HSS or SMS Router or IP-SM-GW, IWF, and SMS-GMSC. The IWF and SMS-GMSC communicate via a MAP C interface, while the IWF and HSS or SMS Router or IP-SM-GW communicate via an S6c interface. The sequence of messages is: 1. sendRoutingInfoForSM from SMS-GMSC to IWF; 2. SRR from IWF to HSS or SMS Router or IP-SM-GW; 3. SRA from HSS or SMS Router or IP-SM-GW to IWF; 4. sendRoutingInfoForSM Ack from IWF to SMS-GMSC; 5. informServiceCentre from IWF to SMS-GMSC. + +**Figure A.3.4.1-1: Mapping of Send Routing Info for SM procedure** + +1. The IWF receives a sendRoutingInfoForSM MAP V3 message from the SMS-GMSC. +2. The IWF sends SRR to the HSS or SMS Router or IP-SM-GW. +3. The IWF receives SRA from the HSS or SMS Router or IP-SM-GW. +4. The IWF sends a sendRoutingInfoForSM Ack message to the SMS-GMSC. +5. The IWF sends an informServiceCentre message to the SMS-GMSC if the SRA contains information elements requiring to be delivered with an informServiceCentre message and closes the MAP dialog + +#### A.3.4.2 Alert Service Centre + +The mapping of the Alert Service Centre procedure is shown in figure A.3.4.2-1: + +![Sequence diagram for Alert Service Centre procedure. Lifelines: HSS, IWF, SMS-IWMSC. Messages: 1. ALR (HSS to IWF), 2. alertServiceCentre (IWF to SMS-IWMSC), 3. alertServiceCentre Ack (SMS-IWMSC to IWF), 4. ALA (IWF to HSS). Protocols S6c and MAP C are indicated.](dbd4bab54b57e8d1abf80e3de6471130_img.jpg) + +``` +sequenceDiagram + participant HSS + participant IWF + participant SMS-IWMSC + Note right of HSS: S6c + Note right of IWF: MAP C + HSS->>IWF: 1. ALR + IWF->>SMS-IWMSC: 2. alertServiceCentre + SMS-IWMSC-->>IWF: 3. alertServiceCentre Ack + IWF-->>HSS: 4. ALA +``` + +Sequence diagram for Alert Service Centre procedure. Lifelines: HSS, IWF, SMS-IWMSC. Messages: 1. ALR (HSS to IWF), 2. alertServiceCentre (IWF to SMS-IWMSC), 3. alertServiceCentre Ack (SMS-IWMSC to IWF), 4. ALA (IWF to HSS). Protocols S6c and MAP C are indicated. + +**Figure A.3.4.2-1: Mapping of Alert Service Centre procedure** + +- 1. The IWF receives a ALR message from the HSS. +- 2. The IWF opens a MAP v3 dialogue towards the SMS-IWMSC by sending alertServiceCentre. +- 3. The IWF receives alertServiceCentre Ack from the SMS-IWMSC. +- 4. The IWF sends ALA to the MME, SGSN. + +### A.3.4.3 Report SM Delivery Status + +The mapping of the Report SM Delivery Status procedure is shown in figure A.3.4.3-1: + +![Sequence diagram for Report SM Delivery Status procedure. Lifelines: HSS, IWF, SMS-GMSC/SMS-SC. Messages: 1. reportSM-DeliveryStatus (SMS-GMSC/SMS-SC to IWF), 2. RDR (IWF to HSS), 3. RDA (HSS to IWF), 4. reportSM-DeliveryStatus Ack (IWF to SMS-GMSC/SMS-SC). Protocols S6c and MAP C are indicated.](8a94796989f4fcba2688c4faa7991538_img.jpg) + +``` +sequenceDiagram + participant HSS + participant IWF + participant SMS-GMSC-SMS-SC as SMS-GMSC +SMS-SC + Note right of HSS: S6c + Note right of IWF: MAP C + SMS-GMSC-SMS-SC-->>IWF: 1. reportSM-DeliveryStatus + IWF-->>HSS: 2. RDR + HSS-->>IWF: 3. RDA + IWF-->>SMS-GMSC-SMS-SC: 4. reportSM-DeliveryStatus Ack +``` + +Sequence diagram for Report SM Delivery Status procedure. Lifelines: HSS, IWF, SMS-GMSC/SMS-SC. Messages: 1. reportSM-DeliveryStatus (SMS-GMSC/SMS-SC to IWF), 2. RDR (IWF to HSS), 3. RDA (HSS to IWF), 4. reportSM-DeliveryStatus Ack (IWF to SMS-GMSC/SMS-SC). Protocols S6c and MAP C are indicated. + +**Figure A.3.4.3-1: Mapping of Report SM Delivery Status procedure** + +- 1. The IWF receives a reportSM-DeliveryStatus MAP V3 message from the SMS-GMSC or the SMS-SC. + +2. The IWF sends RDR to the HSS. +3. The IWF receives SRA from the HSS. +4. The IWF closes the MAP dialogue with the SMS-GMSC by sending a reportSM-DeliveryStatus Ack to the SMS-GMSC or the SMS-SC. + +### A.3.5 The mapping of parameters + +#### A.3.5.1 Mapping of Parameters for the Send Routing Info for SM Procedure + +##### A.3.5.1.1 RoutingInfoForSM-Arg mapping to SRR + +When the IWF needs to construct a SRR command as a result of receiving a MAP sendRoutingInfoForSM message (see subclause A.3.4.1.1 step 2), the IWF shall populate AVPs of SRR as described below: + +- **MSISDN AVP** shall be populated with the value received within the msisdn parameter of RoutingInfoForSM-Arg when available. +- **User-Name AVP** shall be populated with the value received within the imsi parameter of RoutingInfoForSM-Arg when available. +- **SMSMI-Correlation-ID AVP** shall be present if correlationID in RoutingInfoForSM-Arg is present and be populated as follows: + - **Destination-SIP-URI AVP** shall be populated with the value received within the sip-uri-B parameter of RoutingInfoForSM-Arg. +- **SM-RP-PRI AVP** shall be present and populated with the value received within the sm-RP-PRI parameter of RoutingInfoForSM-Arg. +- **SC-Address AVP** shall be present and populated with the value received within the serviceCentreAddress parameter of RoutingInfoForSM-Arg +- **SM-RP-MTI AVP** shall be populated with the value received within the sm-RP-MTI parameter, when present, of RoutingInfoForSM-Arg +- **SM-RP-SMEA AVP** shall be populated with the value received within the sm-RP-SMEA parameter, when present, of RoutingInfoForSM-Arg +- **SRR-Flags AVP**: Flags shall be set as follows: + - **GPRS-Indicator** shall be set to 1 if the gprsSupportIndicator parameter was present within RoutingInfoForSM-Arg; otherwise shall be set to 0 or the AVP shall be absent. +- **SM-Delivery-Not-Intended AVP** shall be populated with the value received within the sm-deliveryNotIntended parameter, when present, of RoutingInfoForSM-Arg +- **Supported-Features AVP** shall be absent. + +##### A.3.5.1.2 SRA mapping to RoutingInfoForSM-Res/Error + +When the IWF needs to construct a MAP sendRoutingInfoForSM Ack message as a result of receiving a SRA command (see subclause A.3.4.1.1 step 5), the IWF shall populate sub-parameters of RoutingInfoForSM-Res/Error as described below: + +#### RoutingInfoForSM-Res: + +- **imsi** shall be populated with the value received within the User-Name AVP, when present, within SRA. +- Sub-parameters of **locationInfoWithLMSI** shall be populated as follows: + - **networkNode-Number** shall be populated with the value received within either the MME-Number-for-MT-SMS AVP or the MSC-Number AVP or the SGSN-Number AVP or the IP-SM-GW-Number AVP, within the Serving-Node when present, within the SRA. + +- Sub-parameters **diameter-Name** and **diameter-Realm** of **networkNodeDiameterAddress** shall be populated with the values received within the MME-Name & MME-Realm AVPs or within the IP-SM-GW-Name & IP-SM-GW-Realm AVPs within the Serving-Node AVP when present, within the SRA. +- **Imsi** shall be populated with the value received within the LMSI AVP when present, within the SRA. +- **gprsNodeIndicator** shall be set if the received Serving Node AVP contains a SGSN AVP. +- **additional-Number** shall be populated with the value received within either the MME-Number-for-MT-SMS User-Name AVP or the MSC-Number AVP or the SGSN-Number SGSN AVP, within the Additional-Serving-Node when present, within the SRA. +- Sub-parameters **diameter-Name** and **diameter-Realm** of **additionalNetworkNodeDiameterAddress** shall be populated with the values received within the MME-Name and MME-Realm AVPs within the Additional-Serving-Node AVP when present, within the SRA. +- **sm-RP-UI** in MO-ForwardSM-Res shall be populated with the value received within the SM-RP-UI AVP when present. +- **extensionContainer** in MT-ForwardSM-Res shall be absent. + +#### Error: + +Values other than SUCCESS within the Result-Code / Experimental-Result AVP shall be mapped according to the following table: + +**Table A.3.5.1.2-1 Mapping from Diameter error codes to MAP error codes** + +| Diameter Result code / Experimental Result | MAP error code | +|----------------------------------------------|----------------------------------| +| DIAMETER_UNABLE_TO_COMPLY | systemFailure | +| DIAMETER_MISSING_AV | dataMissing | +| DIAMETER_INVALID_AVP_VALUE | unexpectedDataValue | +| DIAMETER_ERROR_FACILITY_NOT_SUPPORTED | facilityNotSupported | +| DIAMETER_ERROR_USER_UNKNOWN | unknownSubscriber | +| DIAMETER_ERROR_SERVICE_NOT_SUBSCRIBED | teleserviceNotProvisioned | +| DIAMETER_ERROR_SERVICE_BARRED | callBarred | +| DIAMETER_ERROR_ABSENT_USER | absentSubscriberSM | + +When the Diameter Result code is **DIAMETER\_ERROR\_ABSENT\_USER**, one or two absent user diagnostics (MME-Absent-User-Diagnostic-SM or MSC-Absent-User-Diagnostic-SM or SGSN-Absent-User-Diagnostic-SM AVPs) may be received. The following additional mapping shall apply: + +- When only one absent user diagnostic AVP is received, it is mapped to the **absentSubscriberDiagnosticSM** parameter. +- When two absent user diagnostics AVPs are received, the SGSN-Absent-User-Diagnostic-SM AVP is mapped to the **additionalAbsentSubscriberDiagnosticSM** parameter, the other AVP is mapped to the **absentSubscriberDiagnosticSM** parameter. + +#### A.3.5.1.3 SRA mapping to informServiceCentreArg + +When the IWF needs to construct a MAP **informServiceCentre** message as a result of receiving a SRA command (see subclause A.3.4.1.1 step 4), the IWF shall populate sub-parameters of **InformServiceCentreArg** as described below: + +- **storedMSISDN** shall be populated with the value received within the MSISDN AVP within the User Identifier AVP, when present, within SRA. +- **mw-Status** shall be populated with the value received within the MWD-Status AVP, when present, within SRA. +- **absentSubscriberDiagnosticSM** shall be populated with the value received within + - either the MME-Absent-User-Diagnostic-SM AVP or the MSC-Absent-User-Diagnostic-SM AVP or the SGSN-Absent-User-Diagnostic-SM AVP, when only one of them is present, within the SRA. + +- either MME-Absent-User-Diagnostic-SM AVP or the MSC-Absent-User-Diagnostic-SM AVP, if one of them is present and if SGSN-Absent-User-Diagnostic-SM AVP is also present. +- **additionalAbsentSubscriberDiagnosticSM** shall be populated with the value received within the SGSN-Absent-User-Diagnostic-SM AVP, if it is present and if either the MME-Absent-User-Diagnostic-SM AVP or the MSC-Absent-User-Diagnostic-SM AVP is present, within the SRA. + +### A.3.5.2 Mapping of Parameters for the Alert Service Centre Procedure + +#### A.3.5.2.1 ALR mapping to alertServiceCentre-Arg + +When the IWF needs to construct a MAP alertServiceCentre message as a result of receiving an ALR command (see subclause A.3.4.2 step 2), the IWF shall open a MAP dialogue in application context version 3 and populate sub-parameters of alertServiceCentre-Arg as described below: + +- **msisdn** shall be populated with the value received within MSISDN AVP, when present, within the User-Identifier AVP within ALR. +- **imsi** shall be populated with the value received within User-Name AVP, when present, within the User-Identifier AVP within ALR. +- **serviceCentreAddress** shall be present and populated with the value received within the SC-Address AVP within ALR. +- **correlationId** shall be present if SMSMI-Correlation-ID AVP within ALR is present and be populated as follows: + - sip-uri-B parameter** shall be populated with the value received within Destination-SIP-URI AVP within SMSMI-Correlation-ID AVP within ALR + +#### A.3.5.2.2 alertServiceCentre-Res / Error mapping to ALA + +When the IWF needs to construct an ALA command as a result of receiving a MAP alertServiceCentre Ack/Error message (see subclause A.3.4.2 step 4), the IWF shall populate AVPs of ASA as described below: + +**Result-Code / Experimental-Result** AVP shall be set to: + +- DIAMETER\_SUCCESS if a MO-ForwardSM-Res parameter was received in the TCAP ResultLast component; +- a DIAMETER base protocol result code according to the following table: + +**Table A.3.5.2.2-1 Mapping from MAP error codes to Diameter error codes** + +| MAP error code | Diameter Result code / Experimental Result | +|----------------------------|--------------------------------------------| +| systemFailure | DIAMETER_UNABLE_TO_COMPLY | +| dataMissing | DIAMETER_MISSING_AVF | +| unexpectedDataValue | DIAMETER_INVALID_AVF_VALUE | + +**Supported Features** AVP shall be absent. + +### A.3.5.3 Mapping of Parameters for the Report SM Delivery Status Procedure + +#### A.3.5.3.1 ReportSM-DeliveryStatusArg mapping to RDR + +When the IWF needs to construct a SRR command as a result of receiving a MAP reportSM-DeliveryStatus message (see subclause A.3.4.3 step 2), the IWF shall populate AVPs of SRR as described below: + +- **User-Identifier** AVP shall be present and populated as follows: + - **MSISDN AVP** shall be populated with the value received, after format translation, within the msisdn parameter of ReportSM-DeliveryStatusArg. + +- **SMSMI-Correlation-ID** AVP shall be present if correlationID in ReportSM-DeliveryStatusArg is present and be populated as follows: + - **Destination-SIP-URI** AVP shall be populated with the value received within the sip-uri-B parameter of ReportSM-DeliveryStatusArg. +- **SC-Address** AVP shall be present and populated with the value received within the serviceCentreAddress parameter of RoutingInfoForSM-Arg +- **SM-Delivery-Outcome** AVP shall be present and populated as follows: + +**SGSN-SM-Delivery-Outcome** AVP shall be populated + +- with the value received in sm-DeliveryOutcome parameter within ReportSM-DeliveryStatusArg if deliveryOutcomeIndicator flag is present; +- with the value received in additionalSM-DeliveryOutcome, when present, within ReportSM-DeliveryStatusArg; + +otherwise SGSN-SM-Delivery-Outcome AVP shall be absent. + +**MSC-SM-Delivery-Outcome** AVP shall be populated + +- with the value received in sm-DeliveryOutcome parameter within ReportSM-DeliveryStatusArg if deliveryOutcomeIndicator flag is absent; + +otherwise MSC-SM-Delivery-Outcome AVP shall be absent. + +**MME-SM-Delivery-Outcome** AVP shall be absent. + +NOTE: the MAP-REPORT-SM-DELIVERY-STATUS request does not differentiate the delivery to a MSC from a delivery to a MME. + +**IP-SM-GW-Delivery-Outcome** AVP shall be populated + +- with the value received in sm-DeliveryOutcome parameter within ReportSM-DeliveryStatusArg if ip-sm-gw-Indicator flag is present; +- with the value received in ip-sm-gw-sm-deliveryOutcome, when present, within ReportSM-DeliveryStatusArg; + +otherwise IP-SM-GW- Delivery-Outcome AVP shall be absent. + +NOTE: The IP-SM-GW- Delivery-Outcome AVP presence can only occur when SMS-GMSC supports T4 triggering. + +**Supported-Features** AVP shall be absent. + +### A.3.5.3.2 RDA mapping to ReportSM-DeliveryStatusRes/Error + +When the IWF needs to construct a MAP reportSM-DeliveryStatus Ack message as a result of receiving a RDA command (see subclause A.3.4. step 4), the IWF shall populate sub-parameters of reportSM-DeliveryStatusRes/Error as described below: + +**reportSM-DeliveryStatusRes:** + +- **storedMSISDN** shall be populated with the value, after format translation, received within the User-Name AVP, when present, within SRA. +- **extensionContainer** shall be absent. + +**Error:** + +Values other than SUCCESS within the Result-Code / Experimental-Result AVP shall be mapped according to the following table: + +**Table A.3.5.3.2-1 Mapping from Diameter error codes to MAP error codes** + +| Diameter Result code / Experimental Result | MAP error code | +|--------------------------------------------|------------------------| +| DIAMETER_UNABLE_TO_COMPLY | systemFailure | +| DIAMETER_MISSING_AVP | dataMissing | +| DIAMETER_INVALID_AVP_VALUE | unexpectedDataValue | +| DIAMETER_ERROR_USER_UNKNOWN | unknownSubscriber | +| DIAMETER_ERROR_MWD_LIST_FULL | messageWaitingListFull | + +## A.4 IWF related to the S6a/S6a+D interface between MME and HSS + +### A.4.1 Introduction + +3GPP TS 23.272 [2] has specified the "SMS in MME" architecture option, where an IWF, named S6a/S6a+D IWF, between the S6a interface with SMS subscription data on the MME side and the S6a interface without SMS subscription data plus the MAP-based D interface for SMS subscription on the MME side is defined. This S6a/S6a+D IWF is described in the following subclauses. + +### A.4.2 Interworking scenario + +This interworking scenario is illustrated in the figure A.4.2.1-1 where an IWF is placed between a MME supporting a Diameter based S6a interface with the SMS in MME feature and a HSS supporting a S6a interface without the SMS feature and a MAP D interface where the IWF emulates a VLR limited to the support of SMS teleservice. + +This IWF scenario, according to 3GPP TS 23.272 [4], may be used for roaming cases between the HSS in the home PLMN and the MME in the visited network. + +![Diagram of S6a/S6a+D for SMS interworking scenario with one IWF. It shows an MME connected to an IWF via an S6a with SMS interface. The IWF is connected to an HSS via two interfaces: S6a without SMS and D limited to SMS.](8fe194ec0e70ac418890f8f1ad02a102_img.jpg) + +``` + +graph LR + MME[MME] <--> S6a_with_SMS[S6a with SMS] + S6a_with_SMS <--> IWF[S6a/S6a+D IWF] + IWF <--> S6a_without_SMS[S6a without SMS] + S6a_without_SMS <--> HSS[HSS] + IWF <--> D_limited_to_SMS[D limited to SMS] + D_limited_to_SMS <--> HSS + +``` + +Diagram of S6a/S6a+D for SMS interworking scenario with one IWF. It shows an MME connected to an IWF via an S6a with SMS interface. The IWF is connected to an HSS via two interfaces: S6a without SMS and D limited to SMS. + +**Figure A.4.2-1 S6a/S6a+D for SMS interworking scenario with one IWF** + +The S6a interface without SMS between the IWF and the HSS may be replaced by a MAP Gr interface without SMS between a S6a/Gr + D IWF and the HSS as illustrated in the figure A.4.2-2. The mapping of procedures described in clause A.4.4 and the mapping of parameters described in clause A.4.5 shall apply by replacing the commands transferred between the IWF and the HSS over S6a by the corresponding ones over the Gr interface in compliance with the clauses 6, 7, 8. + +![Diagram of S6a/Gr+D for SMS interworking scenario with one IWF. It shows an MME connected to an IWF via an S6a with SMS interface. The IWF is connected to an HSS via two interfaces: Gr without SMS and D limited to SMS.](b327d9f0565f7e032fc82b4322c844dc_img.jpg) + +``` + +graph LR + MME[MME] <--> S6a_with_SMS[S6a with SMS] + S6a_with_SMS <--> IWF[S6a/Gr + D IWF] + IWF <--> Gr_without_SMS[Gr without SMS] + Gr_without_SMS <--> HSS[HSS] + IWF <--> D_limited_to_SMS[D limited to SMS] + D_limited_to_SMS <--> HSS + +``` + +Diagram of S6a/Gr+D for SMS interworking scenario with one IWF. It shows an MME connected to an IWF via an S6a with SMS interface. The IWF is connected to an HSS via two interfaces: Gr without SMS and D limited to SMS. + +**Figure A.4.2-2 S6a/Gr+D for SMS interworking scenario with one IWF** + +The IWF shall be configured as a MSC-VLR in the HSS over the D interface. Only the SMS teleservice will be available on the D interface. + +## A.4.3 General considerations + +### A.4.3.1 Procedures covered + +The MAP procedures on the D interface to be supported by the IWF are: + +- the procedures involved in the support of SMS teleservice: + - MAP-UPDATE-LOCATION + - MAP-CANCEL-LOCATION + - MAP-INSERT-SUBSCRIBER-DATA + - MAP-DELETE-SUBSCRIBER-DATA + - MAP-READY-FOR-SM +- the procedures not linked to the SMS teleservice as such: + - MAP-PURGE + - MAP-RESET + +Other MAP procedures of the D interface between a VLR and the HSS shall not be supported by the IWF. + +NOTE 1: Some MAP general procedures that are not linked to the SMS service does not need to be handled over the MAP D interface, as they will be normally handled with equivalent procedures by the HSS over the S6 interface, e.g. for MAP-PROVIDE-SUBSCRIBER-INFO, MAP-ACTIVATE/DEACTIVATE-TRACE-MODE or MAP-RESTORE-DATA. + +NOTE 2: It is considered that proper configuration of HSS will avoid the HSS to attempt to use procedures not supported by the IWF. + +The following S6a procedures defined in 3GPP TS 29.272 [5] shall be supported by the IWF. + +- Update Location +- Cancel Location +- Purge UE +- Insert Subscriber Data +- Delete Subscriber Data +- Authentication Information Retrieval +- Reset +- Notification + +The Authentication Information Retrieval procedure can be simply relayed by the IWF as having no interaction with a MAP procedure on the D interface. + +## A.4.4 The mapping of procedures + +### A.4.4.1 Common aspects + +In the S6a, ULR and NOR commands requests received from MME with the SMS in MME feature bit set , the IWF may remove it in the corresponding command transferred to the HSS. + +In the S6a ULA, NOA commands that the IWF transfers to the MME, the IWF shall set the SMS in MME feature bit if it was set in the associated ULR or NOR request. + +In the S6a commands IDR, DSR that the IWF transfers to the MME, the IWF shall set the SMS in MME feature bit if it was set in the previous ULR received from the MME. + +In the S6a, IDA, DSA answers received from MME with the SMS in MME feature bit set, the IWF may remove it in the corresponding command transferred to the HSS. + +The IWF shall support MAP version V3 and should support fallback to version V1 or V2. + +#### A.4.4.2 Update Location + +The mapping of the Update Location procedure is shown in figure A.4.4.2-1: + +![Sequence diagram showing the mapping of the Update Location procedure between MME, IWF, and HSS. The diagram shows 8 steps: 1. ULR from MME to IWF; 2. ULR from IWF to HSS; 3. ULA from HSS to IWF; 4. updateLocation (MAP D) from IWF to HSS; 5. insertSubscriberData from HSS to IWF; 6. insertSubscriberDataAck from IWF to HSS; 7. updateLocationAck from IWF to HSS; 8. ULA from IWF to MME. A dashed line separates steps 6 and 7.](832a0ce332e784fe80289e9f00f56574_img.jpg) + +``` + +sequenceDiagram + participant MME + participant IWF + participant HSS + Note right of IWF: S6a + MME->>IWF: 1. ULR + IWF->>HSS: 2. ULR + HSS-->>IWF: 3. ULA + Note right of IWF: MAP D + IWF->>HSS: 4. updateLocation + HSS-->>IWF: 5. insertSubscriberData + IWF-->>HSS: 6. insertSubscriberDataAck + Note right of IWF: ----- + IWF-->>HSS: 7. updateLocationAck + IWF-->>MME: 8. ULA + +``` + +Sequence diagram showing the mapping of the Update Location procedure between MME, IWF, and HSS. The diagram shows 8 steps: 1. ULR from MME to IWF; 2. ULR from IWF to HSS; 3. ULA from HSS to IWF; 4. updateLocation (MAP D) from IWF to HSS; 5. insertSubscriberData from HSS to IWF; 6. insertSubscriberDataAck from IWF to HSS; 7. updateLocationAck from IWF to HSS; 8. ULA from IWF to MME. A dashed line separates steps 6 and 7. + +**Figure A.4.4.2-1: Mapping of the Update Location procedure** + +1. The IWF receives a ULR from the MME with the SMS in MME feature bit set and a request to be registered for MT-SMS. +2. The IWF stores the SMS related information (SMS Register Request, SMS only indication, MME number for MT-SMS), sends the ULR to the HSS where the IWF may clear the SMS in MME feature bit and remove the information related to SMS. +3. The HSS answers with a ULA. +4. If the ULA is successful and has the SMS in MME feature bit cleared and the received Network Access Mode (NAM) is PS + CS, the IWF sends a MAP updateLocation to the HSS with the MME Number for MT SMS. Otherwise the IWF skips to the step 8. +5. The HSS sends a MAP insertSubscriberData with the CS subscription data of the user. +6. If the IWF receives the SMS teleservice in insertSubscriberData and + - if the SMS Register Request is "SMS in MME required", + - or if the SMS Register Request is "No preference" and a "SMS only indication" was received in step 2, + - or if the SMS Register Request is "No preference" and no SMS only indication" was received in step 2 and no other CS teleservices than the SMS teleservice have been received, + then the IWF sends an insertSubscriberDataAck in which the IWF returns the received CS teleservices other than the SMS teleservice, if any; + - otherwise the IWF sends an insertSubscriberDataAck in which the IWF returns the received CS teleservices including the SMS teleservice. + +If the IWF has not received the SMS teleservice in insertSubscriberData, the IWF sends an insertSubscriberDataAck where the IWF returns the received CS teleservices + +- 7 The HSS sends a MAP updateLocationAck. +8. If the ULA received in step 3 is successful and the received Network Access Mode (NAM) is PS, the IWF sends the received ULA with the SMS in MME feature bit set and the indication that MME is not registered for SMS. + +NOTE: The use of SMS in MME is not possible in this IWF case when the user has no CS subscription for the SMS teleservice. + +If the IWF receives the SMS teleservice in insertSubscriberData and + +if the SMS Register Request is "SMS in MME required", + +or if the SMS Register Request is "No preference" and a "SMS only indication" was received in step 2, + +or if the SMS Register Request is "No preference" and no SMS only indication" was received in step 2 and no other CS teleservices than the SMS teleservice have been received in step 5, + +then the IWF sends the ULA received in step 3 in which the IWF sets the SMS in MME feature bit and indicates that the MME is registered for SMS and includes the SMS subscription data; + +otherwise the IWF sends the ULA received in step 3 in which the IWF sets the SMS in MME feature bit and indicates that the MME is not registered for SMS and does not include any SMS subscription data. + +NOTE: the MSC registration is not cancelled because it has been indicated that SMS teleservice is not supported. Further it is assumed that the MME will perform an SGs association which will initiate a Location Update via a VLR + +If the IWF has not received the SMS teleservice in insertSubscriberData, the IWF sends the ULA received in step 3 in which the IWF indicates that the MME is not registered for SMS. + +If the ULA received in step 4 is unsuccessful, the IWF sends the ULA received in step 3 unchanged. + +If in step 7, the IWF receives an updateLocation answer with a MAP error, the IWF sends the ULA received in step 3 unchanged with the indication that MME is not registered for SMS. + +#### A.4.4.3 Cancel Location + +##### A.4.4.3.1 Cancel Location over S6a + +The mapping of the Cancel Location over S6a procedure is shown in figure A.4.4.3.1-1: + +![Sequence diagram showing the mapping of the Cancel Location over S6a procedure between MME, IWF, and HSS.](38d82ffe820e339811b396206f40a201_img.jpg) + +``` +sequenceDiagram + participant MME + participant IWF + participant HSS + Note right of IWF: S6a + HSS->>IWF: 1. CLR + IWF->>MME: 2. CLR + Note right of IWF: MAP D + IWF->>HSS: 3. purgeMS + HSS->>IWF: 4. purgeMSAck + Note right of IWF: S6a + MME->>IWF: 5. CLA + IWF->>HSS: 6. CLA +``` + +The diagram illustrates a sequence of messages between three entities: MME, IWF, and HSS. The sequence starts with the HSS sending a CLR message to the IWF (step 1). The IWF then forwards this CLR message to the MME (step 2). Next, the IWF sends a purgeMS message to the HSS (step 3). The HSS responds with a purgeMSAck message to the IWF (step 4). Simultaneously, the MME sends a CLA message to the IWF (step 5). Finally, the IWF forwards the CLA message to the HSS (step 6). The interfaces used are S6a for the CLR and CLA messages, and MAP D for the purgeMS and purgeMSAck messages. + +Sequence diagram showing the mapping of the Cancel Location over S6a procedure between MME, IWF, and HSS. + +**Figure A.4.4.3.1-1: Mapping of the Cancel Location over S6a procedure** + +1. The IWF receives a CLR from the HSS. +2. The IWF send the CLR unchanged to the MME. +3. The IWF, if it has been registered by the HSS over the MAP D interface shall send a MAP purgeMS message to the HSS. +4. the IWF receives a purgeMSAck from the HSS. +5. the IWF receives a CLA from the MME. +6. the IWF sends the CLA unchanged to the MME. + +The steps 3/4 and the step 5 may occur in parallel. + +#### A.4.4.3.2 Cancel Location over MAP D + +The mapping of the Cancel Location over MAP D procedure is shown in figure A.4.4.3.2-1: + +![Sequence diagram for Figure A.4.4.3.2-1: Mapping of the Cancel Location over MAP D procedure. Lifelines: MME, IWF, HSS. The sequence starts with HSS sending 1. CancelLocation to IWF. IWF sends 2. IDR to MME. MME sends 3. IDA to IWF. IWF sends 4. CancelLocationAck to HSS. The S6a interface is between MME and IWF, and MAP D is between IWF and HSS.](11f18bf0233d812ad2604f88f3385d60_img.jpg) + +``` +sequenceDiagram + participant MME + participant IWF + participant HSS + Note right of IWF: S6a + Note right of HSS: MAP D + HSS->>IWF: 1. CancelLocation + IWF->>MME: 2. IDR + MME->>IWF: 3. IDA + IWF->>HSS: 4. CancelLocationAck +``` + +Sequence diagram for Figure A.4.4.3.2-1: Mapping of the Cancel Location over MAP D procedure. Lifelines: MME, IWF, HSS. The sequence starts with HSS sending 1. CancelLocation to IWF. IWF sends 2. IDR to MME. MME sends 3. IDA to IWF. IWF sends 4. CancelLocationAck to HSS. The S6a interface is between MME and IWF, and MAP D is between IWF and HSS. + +**Figure A.4.4.3.2-1: Mapping of the Cancel Location over MAP D procedure** + +1. The IWF receives a CancelLocation from the HSS +2. If the MME is registered for SMS, the IWF sends an IDR to the MME with the indication to remove the MME registration for SMS; otherwise the IWF skips to the step 4. +3. The IWF receives an IDA. +4. The IWF sends a CancelLocation Ack to the HSS. + +#### A.4.4.4 Purge + +The mapping of the Purge procedure is shown in figure A.4.4.4-1: + +![Sequence diagram for Figure A.4.4.4-1: Mapping of the Purge procedure. Lifelines: MME, IWF, HSS. The sequence starts with MME sending 1. PUR to IWF. IWF sends 2a. PUR to HSS. HSS sends 3a. PUA to IWF. IWF sends 2b. PurgeMS to HSS. HSS sends 3b. PurgeMS Ack to IWF. IWF sends 4. PUA to MME. The S6a interface is between MME and IWF, and between IWF and HSS. The MAP D interface is between IWF and HSS.](e48a7aa9d3880694350259852fefbef2_img.jpg) + +``` +sequenceDiagram + participant MME + participant IWF + participant HSS + Note right of IWF: S6a + Note right of HSS: S6a + Note right of HSS: MAP D + MME->>IWF: 1. PUR + IWF->>HSS: 2a. PUR + HSS->>IWF: 3a. PUA + IWF->>HSS: 2b. PurgeMS + HSS->>IWF: 3b. PurgeMS Ack + IWF->>MME: 4. PUA +``` + +Sequence diagram for Figure A.4.4.4-1: Mapping of the Purge procedure. Lifelines: MME, IWF, HSS. The sequence starts with MME sending 1. PUR to IWF. IWF sends 2a. PUR to HSS. HSS sends 3a. PUA to IWF. IWF sends 2b. PurgeMS to HSS. HSS sends 3b. PurgeMS Ack to IWF. IWF sends 4. PUA to MME. The S6a interface is between MME and IWF, and between IWF and HSS. The MAP D interface is between IWF and HSS. + +**Figure A.4.4.4-1: Mapping of the Purge procedure** + +1. The IWF receives a PUR message from the MME. + +- 2a. The IWF sends the PUR message unchanged to the HSS. +- 3a. The IWF receives PUA from the HSS. +- 2b. The IWF, if it has been registered by the HSS over the MAP D interface, sends a MAP purgeMS message to the HSS. +- 3b. The IWF receives a MAP purgeMSAck message from the HSS. +4. The IWF sends PUA to the MME. + +The steps 2a/3a and 2b/3b may occur in parallel. + +#### A.4.4.5 Insert Subscriber Data + +##### A.4.4.5.1 Insert Subscriber Data over S6a + +If the IWF receives an IDR from the HSS, the IWF sends the IDR unchanged to the MME apart the possible setting of the SMS in MME feature bit as described in subclause A.4.4.1. + +##### A.4.4.5.2 Insert Subscriber Data over MAP D + +The mapping of the Insert Subscriber Data over MAP D procedure is shown in figure A.4.4.5.2-1: + +![Sequence diagram showing the mapping of the Insert Subscriber Data over MAP D procedure between MME, IWF, and HSS.](4ee2de50739c96fd7bd5a38150ec9c78_img.jpg) + +``` +sequenceDiagram + participant MME + participant IWF + participant HSS + Note right of IWF: S6a + Note right of IWF: MAP D + HSS->>IWF: 1. InsertSubscriberData + IWF->>MME: 2. IDR + MME->>IWF: 3. IDA + IWF->>HSS: 4. InsertSubscriberData Ack + Note left of MME: 5. Steps 1 to 4 may be repeated several times for InsertSubscriberData + HSS->>IWF: 6. END +``` + +The diagram illustrates the sequence of messages for the Insert Subscriber Data over MAP D procedure. It involves three entities: MME, IWF, and HSS. The IWF acts as a central node, with the S6a interface on its left towards the MME and the MAP D interface on its right towards the HSS. The sequence of messages is as follows: 1. The HSS sends an InsertSubscriberData message to the IWF. 2. The IWF sends an IDR (Insert Subscriber Data Request) message to the MME. 3. The MME sends an IDA (Insert Subscriber Data Answer) message back to the IWF. 4. The IWF sends an InsertSubscriberData Ack (Acknowledge) message to the HSS. 5. A dashed line indicates that steps 1 to 4 may be repeated several times for InsertSubscriberData. 6. Finally, the HSS sends an END message to the IWF. + +Sequence diagram showing the mapping of the Insert Subscriber Data over MAP D procedure between MME, IWF, and HSS. + +**Figure A.4.4.5.2-1: Mapping of the Insert Subscriber Data over MAP D procedure** + +1. The IWF receives a (stand alone) MAP InsertSubscriberData message from the HSS. +2. If the MAP InsertSubscriberData does not contain any data related to SMS, the IWF ignores the received data data and skips to the step 4 + +If the MAP InsertSubscriberData contains data related to SMS, the IWF maps them into an IDR towards the MME and ignores the other received data data. + +3. The IWF receives IDA from the MME. +4. The IWF sends InsertSubscriberData Ack to the HSS. +5. Steps 1 to 4 may be repeated several times for InsertSubscriberData. The repetition may be in burst mode or in acknowledge mode. + +6. The HSS closes the MAP dialogue. + +#### A.4.4.6 Delete Subscriber Data + +##### A.4.4.6.1 Delete Subscriber Data over S6a + +If the IWF receives a DSR from the HSS, the IWF sends the DSR unchanged to the MME apart the possible setting of the SMS in MME feature bit as described in subclause A.4.4.1 + +##### A.4.4.6.2 Delete Subscriber Data over MAP D + +The mapping of the Delete Subscriber Data over MAP D procedure is shown in figure A.4.4.6.2-1: + +![Sequence diagram showing the mapping of the Delete Subscriber Data over MAP D procedure between MME, IWF, and HSS. The diagram is divided into two sections: S6a (between MME and IWF) and MAP D (between IWF and HSS). The sequence of messages is: 1. DeleteSubscriberData (HSS to IWF), 2. DSR (IWF to MME), 3. DSA (MME to IWF), 4. DeleteSubscriberData Ack (IWF to HSS), 5. IDR (IWF to MME), 6. IDA (MME to IWF), 7. PurgeMS (IWF to HSS), 8. PurgeMS Ack (HSS to IWF).](9fc0c37f0024c76bce2fb5115a7f2c50_img.jpg) + +``` + +sequenceDiagram + participant MME + participant IWF + participant HSS + Note over MME, IWF: S6a + Note over IWF, HSS: MAP D + HSS->>IWF: 1. DeleteSubscriberData + IWF->>MME: 2. DSR + MME->>IWF: 3. DSA + IWF->>HSS: 4. DeleteSubscriberData Ack + IWF->>MME: 5. IDR + MME->>IWF: 6. IDA + IWF->>HSS: 7. PurgeMS + HSS->>IWF: 8. PurgeMS Ack + +``` + +Sequence diagram showing the mapping of the Delete Subscriber Data over MAP D procedure between MME, IWF, and HSS. The diagram is divided into two sections: S6a (between MME and IWF) and MAP D (between IWF and HSS). The sequence of messages is: 1. DeleteSubscriberData (HSS to IWF), 2. DSR (IWF to MME), 3. DSA (MME to IWF), 4. DeleteSubscriberData Ack (IWF to HSS), 5. IDR (IWF to MME), 6. IDA (MME to IWF), 7. PurgeMS (IWF to HSS), 8. PurgeMS Ack (HSS to IWF). + +**Figure A.4.4.6.2-1: Mapping of the Delete Subscriber Data over MAP D procedure** + +1. The IWF receives a MAP DeleteSubscriberData message from the HSS. +2. If the MAP DeleteSubscriberData does not contain any data related to SMS, the IWF ignores the received data data. The IWF skips to step 4.If the MAP DeleteSubscriberData contains data related to SMS, the IWF maps them into a DSR towards the MME and ignores the other received data data . +3. The IWF receives DSA from the MME. +4. The IWF sends DeleteSubscriberData Ack to the HSS. +- 5 If the SMS subscription is withdrawn, the IWF sends an IDR to the MME with the indication to remove the MME registration for SMS. Otherwise the procedure is terminated. +6. The IWF receives an IDA from the MME. +7. The IWF sends a PurgeMS to the HSS. +8. The IWF receives a Purge MS Ack from the HSS. + +#### A.4.4.7 Reset + +The mapping of the Reset procedure is shown in figure A.4.4.7-1: + +![Sequence diagram showing the mapping of the Reset over S6a procedure between MME, IWF, and HSS.](18003425d0e8638dde4acc9c5c468c5c_img.jpg) + +``` + +sequenceDiagram + participant MME + participant IWF + participant HSS + Note right of IWF: S6a + HSS->>IWF: 1a. RSR + Note right of IWF: MAP D + HSS->>IWF: 1b. Reset + Note left of IWF: S6a + IWF->>MME: 2. RSR + MME->>IWF: 3. RSA + Note right of IWF: S6a + IWF->>HSS: 4. RSA + +``` + +The diagram illustrates the sequence of messages for the Reset over S6a procedure. It involves three entities: MME, IWF, and HSS. The sequence starts with the HSS sending two messages to the IWF: 1a. RSR (over the S6a interface) and 1b. Reset (over the MAP D interface). The IWF then sends a message 2. RSR to the MME (over the S6a interface). The MME responds with 3. RSA to the IWF (over the S6a interface). Finally, the IWF sends 4. RSA to the HSS (over the S6a interface). + +Sequence diagram showing the mapping of the Reset over S6a procedure between MME, IWF, and HSS. + +**Figure A.4.4.7-1: Mapping of the Reset over S6a procedure** + +When there is a reset from HSS, the reset shall normally occur on both the S6a interface and the MAP D interface. The procedure handling may also apply when only a RSR is received on the S6a interface and no Reset message over the MAPD interface. + +NOTE: It is out of the scope to address the handling of a Reset message received over the MAP D interface without receiving a RSR over the S6a interface. + +- 1a. The IWF receives a RSR from the HSS, the IWF stores this information +- 1.b The IWF should receive a MAP Reset from the HSS. +2. The IWF sends a RSR unchanged to the MME. +3. The IWF receives a RSA from the MME. +4. The IWF sends the RSA unchanged to the HSS. + +#### A.4.4.8 Notification + +The mapping of the Notification procedure is shown in figure A.4.4.8-1: + +![Sequence diagram illustrating the mapping of the Notification Procedure between MME, IWF, and HSS. The diagram shows four steps: 1. NOR from MME to IWF; 2a. NOR from IWF to HSS; 3a. NOA from HSS to IWF; 2b. ReadyForSM from IWF to HSS; 3b. ReadyForSM Ack from HSS to IWF; 4. NOA from IWF to MME. The S6a interface is used between MME and IWF, and between IWF and HSS. The MAP D interface is used between IWF and HSS.](0dfdff10c725fe9c332b07ade9d23a5e_img.jpg) + +``` + +sequenceDiagram + participant MME + participant IWF + participant HSS + Note right of IWF: S6a + MME->>IWF: 1. NOR + Note right of IWF: S6a + IWF->>HSS: 2a. NOR + HSS-->>IWF: 3a. NOA + Note right of IWF: MAP D + IWF->>HSS: 2b. ReadyForSM + HSS-->>IWF: 3b. ReadyForSM Ack + IWF-->>MME: 4. NOA + +``` + +Sequence diagram illustrating the mapping of the Notification Procedure between MME, IWF, and HSS. The diagram shows four steps: 1. NOR from MME to IWF; 2a. NOR from IWF to HSS; 3a. NOA from HSS to IWF; 2b. ReadyForSM from IWF to HSS; 3b. ReadyForSM Ack from HSS to IWF; 4. NOA from IWF to MME. The S6a interface is used between MME and IWF, and between IWF and HSS. The MAP D interface is used between IWF and HSS. + +**Figure A.4.4.8-1: Mapping of the Notification Procedure** + +1. The IWF receives a NOR message from the MME. +- 2a. If the NOR message contains notifications other than the Ready for SM from MME notification, the IWF sends a NOR message with the Ready for SM flag cleared, the Alert Reason information element removed and unchanged for the other notifications to the HSS. +- 3a. The IWF receives a NOA if a NOR was sent in step 2a. +- 2b. If the Ready for SM from MME flag is set in the NOR received in step 1, the IWF sends a MAP ReadyForSM message to the HSS. +- 3b. The IWF receives a MAP ReadyForSM Ack message, if a MAP ReadyForSM message was sent in step 2b. +- 4 If the NOR and/or the MAP ReadyForSM Ack messages received from the HSS are successful, the IWF sends a successful NOA to the MME. + +The steps 2a/3a and 2b/3b may occur in parallel. + +If one of the NOA or ReadyForSM answer from the HSS is successful and the other unsuccessful, the NOA sent to MME should be with an unsuccessful result mapped from the received error. + +## A.4.5 The mapping of parameters + +### A.4.5.1 Unchanged AVPs + +Many commands between the MME and the IWF are not specific to SMS and are transferred over the S6a interface between the IWF and the HSS. Unless otherwise stated in the following A.4.5 subclauses, the AVPs received by the IWF in a Diameter command are transferred unchanged in the Diameter command sent by the IWF. + +### A.4.5.2 Mapping of Parameters for the Update Location procedure + +#### A.4.5.2.1 ULR mapping to ULR + +When the IWF receives a ULR from the MME with the SMS in MME feature bit set, the IWF generates a ULR towards the HSS where: + +- the feature bit "SMS in MME" shall not be set; +- the MME-Number-for-MT-SMS AVP, the SMS-Only AVP and the SMS-Register-Request AVP shall be removed. + +#### A.4.5.2.1 ULR mapping to UpdateLocationArg + +When the IWF needs to construct a MAP-UpdateLocation message as a result of receiving an ULR command (see sections A.Z.4.2 step 4), the IWF shall open a MAP dialogue in application context version 3 and populate sub-parameters of UpdateLocationArg as described below: + +- **imsi** in UpdateLocationArg shall be populated with the value of the User-Name AVP received within ULR. +- **msc-Number** in UpdateLocationArg shall be populated with the value of the MME-Number-for-MT-SMS AVP within ULR, +- **vlr-Number** in UpdateLocationArg shall be populated with a value locally assigned to the IWF and consistent with SS7 routing principles. +- **mme-DiameterAddress** in UpdateLocationArg shall be present and be populated as follows + - **diameter-Name** shall be populated with the value received in the Origin-Host AVP within ULR; + - **diameter-Realm** shall be populated with the value received within the Origin-Realm AVP within ULR. + +Other parameters defined for UpdateLocationArg shall be absent. + +#### A.4.5.2.2 InsertSubscriberDataArg mapping to ULA + +When the IWF needs to construct an ULA command as a result of receiving a successful ULA and a successful UpdateLocation Ack, the IWF shall behave as described in subclause A.Z.4.2 step 8 and in particular: + +- **Teleservice-List** AVP shall only contain the TS-Code AVPs related to the short message teleservice with the values received in the corresponding Ext-TeleserviceCode parameters in the InsertSubscriberDataArg. +- **Call-Barring-Info** AVPs shall be present if call barring SS-code and SS-status parameters were present within the Call Barring Information List parameter within the InsertSubscriberDataArg and the SS-Code AVP and SS-Status AVP within the Call-Barring-Info AVPs shall be populated with the values of the received call barring SS-code and SS-status parameters within the Call Barring Information List parameter within the InsertSubscriberDataArg. +- **Operator-Determined-Barring** AVP shall be present if an odb-GeneralData parameter within SubscriberData parameter within InsertSubscriberDataArg was present with values related to call barring which shall be mapped to the corresponding flags within Operator-Determined-Barring AVP. + +NOTE: ODB values in the ULA received from HSS are transferred unchanged in the ULA sent to the MME. + +#### A.4.5.2.2 Mapping to InsertSubscriberDataRes + +When the IWF needs to construct a MAP-InsertSubscriberData Ack message as a result of receiving an InsertSubscriberDataArg message (see subclause A.Z.4.2, step 6), the IWF shall populate sub-parameter of InsertSubscriberDataRes as follows: + +- **ss-List** in InsertSubscriberDataRes shall include the ssCodes that have been received within InsertSubscriberDataArg and for which the corresponding flag of the Feature-List AVP is not set in the IDA. +- **teleserviceList** in InsertSubscriberDataRes shall include all teleserviceCodes that have been received within InsertSubscriberDataArg except those related to the short message teleservice. +- **bearerServiceList** in InsertSubscriberDataRes shall include all bearerServiceCodes that have been received within InsertSubscriberDataArg. +- **odb-GeneralData** in InsertSubscriberDataRes shall include all odb categories that have been received within InsertSubscriberDataArg and that are not supported by the MME as indicated within the Supported-Feature AVP within ULR. + +Other sub parameters in InsertSubscriberDataRes shall be absent. + +- For **InsertSubscriberData Error**: Values other than SUCCESS within the Result-Code / Experimental-Result AVP shall be mapped onto an appropriate MAP error. + +### A.4.5.3 Mapping of Parameters for the Cancel Location procedure + +#### A.4.5.3.1 CLR mapping to PurgeMSArg mapping to + +When the IWF needs to construct a MAP-PurgeMS message as a result of receiving CLR command (see subclause A.4.4.3.1 step 3), the IWF shall open a MAP dialogue in application context version 3 and populate sub-parameters of PurgeMS-Arg as described below: + +- **imsi** in PurgeMS-Arg shall be populated with the imsi value of the User-Name AVP received within CLR. +- **vlr-Number** in PurgeMS-Arg shall be populated with the value given in the previous Update Location procedure. +- **sgsn-Number** and **extensionContainer** in PurgeMS-Arg shall be absent. + +#### A.4.5.3.2 CancelLocationArg mapping to IDR + +When the IWF needs to construct an IDR as a result of receiving a CancelLocation message (see subclause A.4.4.3.2 step 2), the IWF shall populate AVPs of DSR as described below: + +##### IDR-Flags AVP: + +- **Remove SMS Registration** flag shall be set to 1. +- Other flags shall be set to 0. + +**Subscription-Data** AVP shall be included empty. + +#### A.4.5.3.3 IDA mapping to CancelLocationRes/Error + +When the IWF needs to construct a MAP-CancelLocation Ack message as a result of receiving an IDA command (see subclause A.4.4.3.2 step 4), the IWF shall populate sub-parameters of CancelLocationRes/Error as described below: + +##### CancelLocationRes: + +- **extensionContainer** in CancelLocationRes shall be absent. + +##### CancelLocation Error: + +- Values other than SUCCESS within the Result-Code / Experimental-Result AVP shall be mapped onto an appropriate MAP error. + +### A.4.5.4 Mapping of Parameters for the Purge Procedure + +#### A.4.5.4.1 PUR mapping to PurgeMS-Arg + +When the IWF needs to construct a MAP-PurgeMS message as a result of receiving a PUR command (see subclause A.4.4.4 step 2b), the IWF shall open a MAP dialogue in application context version 3 and populate sub-parameters of PurgeMS-Arg as described below: + +- **imsi** in PurgeMS-Arg shall be populated with the imsi value of the User-Name AVP received within PUR. +- **vlr-Number** in PurgeMS-Arg shall be populated with the value given in the previous Update Location procedure. +- **sgsn-Number** and **extensionContainer** in PurgeMS-Arg shall be absent. + +#### A.4.5.4.2 PurgeMS-Res / Error mapping to PUA + +The Result-Code / Experimental-Result AVP and the other AVPs of the PUA sent by the IWF to the MME, shall be the same as those received in the PUA from the HSS and are not dependent of the PurgeMS Ack message received over MAP D. + +## A.4.5.5 Mapping of Parameters for the Insert Subscriber Data Procedure + +### A.4.5.5.1 InsertSubscriberDataArg mapping to IDR + +When the IWF needs to construct an IDR as a result of receiving a InsertSubscriberData message, the IWF shall behave as described in subclause A.Z.4.2 step 8. In particular: + +- **Teleservice-List** AVP, shall be present if short message related Ext-TeleserviceCode parameters were received and shall contain the TS-Code AVPs related to the short message teleservice with the values received in the corresponding Ext-TeleserviceCode parameters. +- **Call-Barring-Info** AVPs shall be present if call barring SS-code and SS-status parameters were present within the Call Barring Information List parameter within the InsertSubscriberDataArg and the SS-Code AVP and SS-Status AVP within the Call-Barring-Info AVPs shall be populated with the values of the received call barring SS-code and SS-status parameters within the Call Barring Information List parameter within the InsertSubscriberDataArg. + +### A.4.5.5.2 IDA mapping to InsertSubscriberDataRes/Error + +When the IWF needs to construct a MAP-InsertSubscriberData Ack message as a result of receiving an IDA command (see subclause A.Z.4.5.2, step 4), the IWF shall populate sub-parameter of InsertSubscriberDataRes as follows: + +**ss-List** in InsertSubscriberDataRes shall include the ssCodes that have been received within InsertSubscriberDataArg and for which the corresponding flag of the Feature-List AVP is not set in the IDA. + +Other sub parameters in InsertSubscriberDataRes shall be absent. + +For **InsertSubscriberData Error**: Values other than SUCCESS within the Result-Code / Experimental-Result AVP shall be mapped onto an appropriate MAP error. + +## A.4.5.6 Mapping of Parameters for the Delete Subscriber Data Procedure + +### A.4.5.6.1 DeleteSubscriberDataArg mapping to DSR + +When the IWF needs to construct a DSR command as a result of receiving a MAP-DeleteSubscriberData message (see subclause A.4.4.6.2 step 2), the IWF shall populate AVPs of DSR as described below: + +- **User-Name** AVP shall be populated with the value received within the imsi parameter of DeleteSubscriberDataArg. +- **Supported-Features** AVP shall be absent. +- **DSR-Flags** AVP: Flags shall be set as follows: +- **SMS Withdrawal** shall be set to 1 if the SS-Code list parameter was present within DeleteSubscriberDataArg and the service codes are related to short message services; otherwise shall be set to 0. +- other flags shall be set to 0. + +### A.4.5.6.2 DSA mapping to DeleteSubscriberDataRes/Error + +When the IWF needs to construct a MAP-DeleteSubscriberData Ack message as a result of receiving a DSA command (see subclause A.4.4.6.2 step 4), the IWF shall populate sub-parameters of DeleteSubscriberDataRes/Error as described below: + +#### **DeleteSubscriberDataRes:** + +- No sub-parameter shall be present in DeleteSubscriberDataRes. + +#### **DeleteSubscriberData Error:** + +Values other than SUCCESS within the Result-Code / Experimental-Result AVP shall be mapped onto an appropriate MAP error. + +## A.4.5.7 Mapping of Parameters for the Reset Procedure + +### A.4.5.7.1 Reset mapping to RSR + +When the IWF needs to construct a RSR command as a result of receiving a RSR and a MAP Reset message (see subclause A.4.4.7 step 2), the IWF shall send the RSR received from HSS unchanged and ignore the sub-parameters of the MAP Reset message. + +## A.4.5.8 Mapping of Parameters for the Notification Procedure + +### A.4.5.8.1 NOR mapping to ReadyForSM-Arg + +When the IWF needs to construct a MAP-ReadyForSM message as a result of receiving a NOR command (see subclause A.Z.4.8 step 2b), the IWF shall open a MAP dialogue in application context version 3 and populate sub-parameters of ReadyForSMArg as described below: + +- **imsi** in ReadyForSMArg shall be populated with the value of the User-Name AVP received within NOR. +- **alertReason** in ReadyForSMArg shall be populated with the value of the Alert-Reason AVP received within NOR. +- **alertReasonIndicator** in ReadyForSMArg shall be absent. +- **additionalAlertReasonIndicator** in ReadyForSMArg shall be absent. +- **extensionContainer** in ReadyForSMArg shall be absent. +- **maximumUeAvailabilityTime** in ReadyForSMArg shall be present and populated with the value received within the Maximum-UE-Availability-Time AVP, when present, within NOR . + +## Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|--------|-----------|------|-----|--------------------------------------------------------------------------|--------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 2008-12 | CT#42 | CP-080711 | | | Version 1.0.0 approved in CT#42 | 1.0.0 | 8.0.0 | +| 2009-03 | CT#43 | CP-090056 | 0001 | | Supported RAT Type | 8.0.0 | 8.1.0 | +| | | CP-090056 | 0002 | | Trace | | | +| | | CP-090056 | 0004 | | Context Identifier for Update or Removal of PDN GW | | | +| | | CP-090044 | 0005 | 2 | Ready For SM | | | +| | | CP-090044 | 0006 | | Handling LCS Subscription Data | | | +| | | CP-090056 | 0007 | 1 | Requesting-Node-Type mapping | | | +| | | CP-090056 | 0008 | | Parameter mapping correction | | | +| | | CP-090044 | 0010 | 2 | Handling SMS Subscription Data | | | +| 2009-06 | CT#44 | CP-090308 | 0011 | | Parameter Mapping | 8.1.0 | 8.2.0 | +| | | CP-090380 | 0013 | 3 | User Data Download | | | +| 2009-09 | CT#45 | CP-090545 | 0014 | | Notification of SMS over IP Non-Delivery for E-UTRAN and UE Reachability | 8.2.0 | 8.3.0 | +| | | CP-090545 | 0015 | | Removal of User Data Handling Principles | | | +| | | CP-090545 | 0016 | 2 | Cancel Location for Initial Attach | | | +| 2009-12 | - | - | - | - | Update to Rel-9 version (MCC) | 8.3.0 | 9.0.0 | +| 2011-03 | CT#51 | CP-110082 | 0018 | 1 | UE SRVCC Capability Support for IWF | 9.0.0 | 10.0.0 | +| 2011-06 | CT#52 | CP-110380 | 0020 | 1 | Parameter Mapping for MDT | 10.0.0 | 10.1.0 | +| 2011-09 | CT#53 | CP-110584 | 0021 | 2 | Add vSRVCC updates to the IWF function | 10.1.0 | 11.0.0 | +| 2012-03 | CT#55 | CP-120024 | 0026 | 1 | Mapping of Parameters for Insert Subscriber Data | 11.0.0 | 11.1.0 | +| | | CP-120025 | 0022 | 1 | Mapping of Parameters for Cancel Location | | | +| 2012-06 | CT#56 | CP-120240 | 0023 | 3 | Mapping of CSG ID and Local Time for NPLI | 11.1.0 | 11.2.0 | +| 2012-09 | CT#57 | CP-120473 | 0029 | 4 | SMS in MME/SGSN | 11.2.0 | 11.3.0 | +| | | CP-120473 | 0032 | 1 | SMS in MME IWF General | | | +| | | CP-120480 | 0034 | 1 | Local Time Zone | | | +| 2012-12 | CT#58 | CP-120714 | 0038 | 4 | Clarification on EPS Info | 11.3.0 | 11.4.0 | +| | | CP-120732 | 0033 | 5 | SMS in MME S6c IWF | | | +| | | CP-120732 | 0035 | 3 | SMS in MME IWF error cases for SGd | | | +| | | CP-120732 | 0036 | 5 | SMS in MME S6a/S6a+D IWF | | | +| | | CP-120732 | 0037 | - | SMS in MME SGd IWF | | | +| 2013-06 | CT#60 | CP-130278 | 0045 | 1 | Parameter Mapping of SS Status for Call Barring | 11.4.0 | 11.5.0 | +| 2013-09 | CT#61 | CP-130450 | 0048 | - | MME Diameter address mapping | 11.5.0 | 11.6.0 | +| 2013-09 | CT#61 | CP-130463 | 0046 | 2 | CancelLocation requesting reattach | 11.6.0 | 12.0.0 | +| | | CP-130456 | 0047 | 1 | IWF description for Gdd support | | | +| 2013-12 | CT#62 | CP-130614 | 0050 | 4 | Parameter Mapping for S6aS6d-Indicator in NOR | 12.0.0 | 12.1.0 | +| | | CP-130617 | 0055 | - | Parameter Mapping for MME Initiated Removal of MME Registration for SMS | | | +| | | CP-130623 | 0051 | 1 | S6c support for HSS and SMS Router | | | +| | | CP-130623 | 0056 | 1 | Figures about IWF description for Gdd support | | | +| | | CP-130800 | 0052 | 2 | IWFs with SMS for IMS UE without MSISDN | | | +| | | CP-130643 | 0053 | 1 | Forwarding of Diameter based SRI for SMS | | | +| 2014-09 | CT#65 | CP-140506 | 0058 | 1 | P-CSCF Restoration Indication | 12.1.0 | 12.2.0 | +| 2015-06 | CT#68 | CP-150263 | 0060 | 1 | Access Restriction Data per PLMN | 12.2.0 | 13.0.0 | +| 2015-12 | CT#70 | CP-150784 | 0061 | 1 | Introducing IMSI-Group ID List | 13.0.0 | 13.1.0 | +| 2016-03 | CT#71 | CP-160030 | 0062 | - | Alert procedure from MME/SGSN to SMS-GMSC for MT SMS to UE using eDRX | 13.1.0 | 13.2.0 | +| 2017-03 | CT#75 | - | - | - | Update to Rel-14 version (MCC) | 13.2.0 | 14.0.0 | +| 2017-12 | CT#78 | CP-173036 | 0063 | - | Mapping of ext-AccessRestrictionData in IWF | 14.0.0 | 15.0.0 | +| 2018-03 | CT#79 | CP-180012 | 0068 | - | Correction of DIAMETER ERROR_SYSTEM_FAILURE | 15.0.0 | 15.1.0 | +| 2020-07 | CT#88e | - | - | - | Update to Rel-16 version (MCC) | 15.1.0 | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29332/raw.md b/marked/Rel-16/29_series/29332/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..16ce687eb5581b4da7c437e0b38d69ed8587283b --- /dev/null +++ b/marked/Rel-16/29_series/29332/raw.md @@ -0,0 +1,3690 @@ + + + + +**Error:** + +**2** + +**Error: Reference source not** + +# Contents + +| | | +|-------------------------------------------------------------------------|-----------| +| Foreword..... | 7 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions, symbols and abbreviations..... | 10 | +| 3.1 Definitions..... | 10 | +| 3.2 Symbols..... | 11 | +| 3.3 Abbreviations..... | 11 | +| 4 UMTS capability set..... | 12 | +| 4.1 Capability set..... | 12 | +| 5 Naming conventions..... | 12 | +| 5.1 MGCF/IM-MGW naming conventions..... | 12 | +| 5.2 Void..... | 12 | +| 6 Topology descriptor..... | 12 | +| 7 Transaction timers..... | 12 | +| 8 Transport..... | 12 | +| 9 Multiple Virtual MG..... | 12 | +| 10 Formats and codes..... | 13 | +| 10.1 Signalling Objects..... | 13 | +| 10.2 Codec Parameters..... | 16 | +| 10.2.1 AMR and AMR-WB Codecs..... | 16 | +| 10.2.2 DTMF Payload Type..... | 17 | +| 10.2.3 Other Codecs..... | 17 | +| 10.2.3.1 G.711 Codec..... | 18 | +| 10.2.3.2 Clearmode..... | 18 | +| 10.2.3.3 Silence suppression and comfort noise..... | 18 | +| 10.2.3.4 VBD codec..... | 18 | +| 10.2.3.5 Real-Time Text Telephony Media..... | 19 | +| 10.2.3.6 T.38 FAX..... | 19 | +| 11 Mandatory Support of SDP and H.248 Annex C information elements..... | 20 | +| 12 General on packages and Transactions..... | 20 | +| 12.1 Profile Details..... | 20 | +| 13 Void..... | 20 | +| 14 Call independent H.248 transactions..... | 20 | +| 15 Transactions towards IM CN Subsystem..... | 20 | +| 15.2 IMS packages..... | 20 | +| 16 Transactions towards ISUP..... | 21 | +| 16.1 Procedures relating to a termination towards ISUP..... | 21 | +| 16.2 ISUP packages..... | 21 | +| 17 Transactions towards BICC..... | 21 | +| 17.1 Procedures related to a termination towards BICC..... | 21 | +| 17.2 BICC packages..... | 21 | +| Annex A (normative): Profile Description..... | 21 | +| A.1 Profile Identification..... | 21 | +| A.2 Summary..... | 21 | +| A.3 Gateway Control Protocol Version..... | 22 | +| A.4 Connection Model..... | 22 | + +| | | | +|-------------|---------------------------------------------------------------|----| +| A.5 | Context Attributes..... | 22 | +| A.6 | Terminations..... | 23 | +| A.6.1 | Termination Names..... | 23 | +| A.6.1.1 | General..... | 23 | +| A.6.1.2 | ASN.1 Encoding..... | 23 | +| A.6.1.2.1 | General Structure..... | 23 | +| A.6.1.2.2 | Termination naming convention for TDM terminations..... | 24 | +| A.6.1.3 | ABNF coding..... | 24 | +| A.6.1.3.1 | General Structure..... | 24 | +| A.6.1.3.2 | Termination Naming Convention for TDM Terminations..... | 24 | +| A.6.1.3.1.1 | Naming Structure..... | 24 | +| A.6.1.3.1.2 | Syntactical Specification..... | 25 | +| A.6.1.3.1.3 | Wildcarding..... | 25 | +| A.6.1.3.1.4 | Heterogeneous TDM Port Configurations..... | 26 | +| A.6.1.3.2 | Termination Naming Convention for Ephemeral Terminations..... | 26 | +| A.6.1.3.2.1 | Naming Structure..... | 26 | +| A.6.1.3.2.2 | Syntactical Specification..... | 26 | +| A.6.2 | Multiplexed terminations..... | 26 | +| A.7 | Descriptors..... | 27 | +| A.7.1 | Stream Descriptor..... | 27 | +| A.7.1.1 | Local Control Descriptor..... | 27 | +| A.7.2 | Events Descriptor..... | 27 | +| A.7.3 | EventBuffer Descriptor..... | 29 | +| A.7.4 | Signals Descriptor..... | 29 | +| A.7.5 | DigitMap Descriptor..... | 30 | +| A.7.6 | Statistics Descriptor..... | 30 | +| A.7.7 | ObservedEvents Descriptor..... | 31 | +| A.7.8 | Topology Descriptor..... | 31 | +| A.7.9 | Error Descriptor..... | 31 | +| A.7.10 | TerminationState Descriptor..... | 31 | +| A.8 | Command API..... | 31 | +| A.8.1 | Add..... | 31 | +| A.8.2 | Modify..... | 32 | +| A.8.3 | Subtract..... | 32 | +| A.8.4 | Move..... | 33 | +| A.8.5 | Auditvalue..... | 33 | +| A.8.6 | Auditcapability..... | 34 | +| A.8.7 | Notify..... | 34 | +| A.8.8 | Service Change..... | 34 | +| A.8.9 | Manipulating and auditing context attributes..... | 36 | +| A.9 | Generic command syntax and encoding..... | 36 | +| A.10 | Transactions..... | 36 | +| A.11 | Messages..... | 37 | +| A.12 | Transport..... | 37 | +| A.13 | Security..... | 38 | +| A.14 | Packages..... | 38 | +| A.14.1 | Generic Package..... | 41 | +| A.14.2 | Base Root Package..... | 42 | +| A.14.3 | Basic DTMF Generator Package..... | 43 | +| A.14.4 | Basic DTMF Detection Package..... | 44 | +| A.14.5 | TDM Circuit Package..... | 44 | +| A.14.6 | MGW Congestion Package..... | 45 | +| A.14.7 | Continuity Package..... | 46 | +| A.14.8 | Announcement Package..... | 46 | +| A.14.9 | Bearer Characteristics Package..... | 47 | +| A.14.10 | Generic Bearer Connection Package..... | 47 | +| A.14.11 | Call Progress Tones Generator Package v1..... | 48 | +| A.14.12 | Basic Call Progress Tones Generator with Directionality..... | 49 | +| A.14.13 | Expanded Call Progress Tones Generator Package..... | 49 | +| A.14.14 | Basic Services Tones Generation Package..... | 50 | +| A.14.15 | Bearer Control Tunnelling Package..... | 51 | + +| | | | +|-----------|-----------------------------------------------------------------------------|----| +| A.14.16 | Expanded Services Tones Generation Package..... | 52 | +| A.14.17 | Intrusion Tones Generation Package..... | 52 | +| A.14.18 | 3GUP Package..... | 53 | +| A.14.19 | Modification of Link Characteristics Bearer Capability..... | 54 | +| A.14.20 | Hanging Termination Detection Package..... | 54 | +| A.14.21 | TFO package..... | 55 | +| A.14.22 | Media Gateway Overload Control Package..... | 56 | +| A.14.23 | Inactivity Timer Package..... | 56 | +| A.14.24 | MGC Information Package..... | 57 | +| A.14.25 | RTP Package..... | 57 | +| A.14.26 | Tone Generator Package..... | 58 | +| A.14.27 | Tone Detection Package..... | 58 | +| A.14.28 | H324 Package..... | 60 | +| A.14.29 | H.245 Transport Package..... | 61 | +| A.14.30 | IP domain connection..... | 61 | +| A.14.31 | H.245 Transport Package for SPC use..... | 62 | +| A.14.32 | MONA preference package..... | 63 | +| A.14.33 | 3G Interface Type package..... | 65 | +| A.14.34 | RTCP Feedback Message package..... | 65 | +| A.14.35 | Explicit Congestion Notification for RTP-over-UDP Support (ecnrous)..... | 67 | +| A.14.36 | Differentiated Services (ds)..... | 68 | +| A.14.37 | MG Act-as STUN Server (mgastuns)..... | 69 | +| A.14.38 | Originate STUN Continuity Check (ostuncc)..... | 70 | +| A.14.39 | Enhanced Revised Offer/Answer SDP Support (eroas)..... | 71 | +| A.15 | Mandatory support of SDP and H.248 Annex C information elements..... | 72 | +| A.16 | Optional support of SDP and H.248 Annex C information elements..... | 74 | +| A.17 | Procedures..... | 74 | +| A.17.1 | Call Independent Procedures..... | 74 | +| A.17.1.2 | Profile registration..... | 75 | +| A.17.2 | IMS Terminations Procedures..... | 76 | +| A.17.2.1 | Summary of Procedures related to a termination towards IM CN Subsystem..... | 76 | +| A.17.2.2 | Reserve IMS Connection Point..... | 78 | +| A.17.2.3 | Configure IMS Resources..... | 80 | +| A.17.2.4 | Reserve IMS Connection Point and configure remote resources..... | 82 | +| A.17.2.5 | VOID..... | 84 | +| A.17.2.6 | Termination heartbeat indication..... | 84 | +| A.17.2.7 | Request RTCP-Interworking..... | 85 | +| A.17.2.8 | Notify RTCP-Interworking..... | 85 | +| A.17.2.9 | Signal H.245-Interworking..... | 86 | +| A.17.2.10 | ECN Failure Indication..... | 86 | +| A.17.2.11 | ICE Connectivity Check Result Notification..... | 87 | +| A.17.2.12 | ICE New Peer Reflexive Candidate Notification..... | 87 | +| A.17.3 | TDM Terminations Procedures..... | 88 | +| A.17.3.1 | Summary Procedures related to a termination towards ISUP..... | 88 | +| A.17.3.2 | Reserve TDM Circuit..... | 89 | +| A.17.3.3 | Release TDM Termination..... | 89 | +| A.17.3.4 | Termination heartbeat indication..... | 89 | +| A.17.4 | BICC Terminations Procedures..... | 91 | +| A.17.4.1 | Procedures related to a termination towards BICC..... | 91 | +| A.17.5 | Multiplex Termination Procedures..... | 92 | +| A.17.5.1 | Procedures related to a Multiplex termination..... | 92 | +| A.17.5.2 | Add Multiplex Termination..... | 92 | +| A.17.5.3 | Configure Multiplex Termination..... | 95 | +| A.17.5.4 | Signal H245 Message..... | 95 | +| A.17.5.5 | Notify H.245 Message..... | 96 | +| A.17.5.6 | Notify MONA Preference Reception..... | 96 | +| A.17.5.7 | Notify MONA Preference Completed..... | 97 | +| A.17.5.8 | Signal SPC..... | 97 | +| A.17.5.9 | Notify SPC..... | 98 | +| A.17.5.10 | Notify MPC..... | 98 | +| A.17.5.11 | Notify Detection of Legacy Interworking..... | 99 | + +A.17.5.12 Stop MPC..... 99 +A.17.5.13 Stop SPC..... 100 +A.17.5.14 Stop MONA Negotiation..... 101 +A.17.6 SIP-I on Nc Terminations Procedures..... 102 +A.17.6.1 Summary of Procedures related to a termination towards SIP-I on Nc CN Subsystem..... 102 +**Annex B (normative): Void..... 104** +**Annex C (normative): Void..... 105** +Annex D (informative): Change history..... 106 + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 1 Scope + +The present document describes the protocol to be used on the Media Gateway Control Function (MGCF) – IM Media Gateway (IM-MGW) interface. This interface provides the Media Gateway Control for interworking between the IP Multimedia Subsystem (IMS) and CS domain (ISUP, BICC and SIP-I). The basis for this protocol is the H.248 protocol as specified in ITU-T. The IMS architecture is described in 3GPP TS 23.228 [1]. The interaction of the MGCF-IM MGW interface signalling procedures in relation to the SIP, and BICC/ISUP signalling at the MGCF are described in 3GPP TS 29.163[4]. + +The interaction of the MGCF-IM MGW interface signalling procedures in relation to the IMS SIP and SIP-I on Nc at the MGCF are described in 3GPP TS 29.235[47]. + +This specification describes the application of H.248 on the Mn interface. Required extensions use the H.248 standard extension mechanism. In addition certain aspects of the base protocol H.248 are not needed for this interface and thus excluded by this profile. + +In addition this profile provides support for PSTN/ISDN Emulation as required by ETSI TISPAN. + +The specification contains a normative Annex defining the H.248.1 Profile in accordance with ITU-T recommendations for H.248.1 applications. Where there exists any contradiction between the normative Annex A and the rest of the specification, the Normative Annex shall take precedence. The main body of the specification provides an introduction to the use of the profile for the Mn interface and introduces any specific functionality (e.g. new packages) associated to the Mn. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TS 23.228: "IP Multimedia Subsystem (IMS); Stage 2". +- [2] 3GPP TS 29.007: "General requirements on interworking between the Public Land Mobile Network (PLMN) and the Integrated Services Digital Network (ISDN) or Public Switched Telephone Network (PSTN)". +- [3] 3GPP TS 29.205: "Application of Q.1900 series to Bearer Independent CS Network architecture; Stage 3". +- [4] 3GPP TS 29.163: "Interworking between the IM CN subsystem and CS networks – Stage 3". +- [5] 3GPP TS 29.232: "Media Gateway Controller (MGC); Media Gateway (MGW) interface; Stage 3". +- [6] 3GPP TS 26.226: "Cellular Text Telephone Modem; General Description". +- [7] 3GPP TS 26.103: "Speech codec list for GSM and UMTS". +- [8] Void +- [9] ITU-T Recommendation H.248.1 (05/2002): "Gateway Control Protocol: Version 2" including the Corrigendum1 for Version 2 (03/04). +- [10] ITU-T Recommendation H.248.8 (09/2005): "Error Codes and Service Change Reason Description". +- [11] ITU-T Recommendation H.248.2 (01/2005): "Facsimile, text conversation and call discrimination packages". +- [12] ITU-T Recommendation H.248.10 (07/2001): "Media Gateway Resource Congestion Handling Package". +- [13] Void +- [14] ITU-T Recommendation Q.1950 (12/2002): "Call Bearer Control Protocol". +- [15] IETF RFC 2960: "Stream Control Transmission Protocol". +- [16] IETF RFC 4867: "RTP Payload Format and File Storage Format for the Adaptive Multi-Rate (AMR) and Adaptive Multi-Rate Wideband (AMR-WB) Audio Codecs". +- [17] IETF RFC 4566: "SDP: Session Description Protocol". +- [18] IETF RFC 2833: "RTP Payload for DTMF Digits, Telephony Tones and Telephony Signals". +- [19] Void +- [20] Void +- [21] 3GPP TS 29.415: "Core Network Nb Interface User Plane Protocols". +- [22] 3GPP TS 23.153: "Out of band transcoder control". +- [23] IETF RFC 768: "User Datagram Protocol". +- [24] IETF RFC 3332: "Signaling System 7 (SS7) Message Transfer Part 3 (MTP3) - User Adaptation Layer (M3UA)". +- [25] 3GPP TS 29.202: "SS7 Signalling Transport in Core Network". +- [26] ITU-T Recommendation H.248.7 (03/2004): "Generic Announcement Package". +- [27] ITU-T Recommendation H.248.36 (09/2005): "Hanging Termination Detection Package ". +- [28] ITU-T Recommendation H.248.11 (11/2002): "Media gateway overload control package". +- [29] ITU-T Recommendation H.248.14 (03/2009): "Inactivity timer package". + +- [30] ITU-T Recommendation H.248.45 (05/2006): "MGC Information Package". +- [31] Void +- [32] IETF RFC 3555: "MIME Type Registration of RTP Payload Formats". +- [33] IETF RFC 3551: "RTP Profile for Audio and Video Conferences with Minimal Control". +- [34] Void +- [35] IETF RFC 4040: "RTP Payload Format for a 64 kbit/s Transparent Call". +- [36] IETF RFC 3389: "Real-time Transport Protocol (RTP) Payload for Comfort Noise (CN)". +- [37] ITU-T Recommendation V.152 (01/2005): "Procedures for supporting voice-band data over IP networks" including Corrigendum 1. +- [38] ITU-T Recommendation H.248.4 (12/2009): "Gateway control protocol: Transport over Stream Control Transmission Protocol (SCTP)". +- [39] IETF RFC 3556: "Session Description Protocol (SDP) Bandwidth Modifiers for RTP Control Protocol (RTCP) Bandwidth". +- [40] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [41] ITU-T Recommendation H.248.12 (07/2001): "Gateway control protocol: H.248.1 packages for H.323 and H.324 interworking". +- [42] ITU-T Recommendation H.248.12 Amendment 2 (08/2007): "Gateway control protocol: H.248.1 packages for H.323 and H.324 interworking Amendment 2: Transport Mechanism". +- [43] IETF RFC 3309: "Stream Control Transmission Protocol (SCTP) Checksum Change". +- [44] ITU-T Recommendation H.248.41 (05/2006): "IP Domain Connection package". +- [45] Void +- [46] ITU-T Recommendation H.248.72 (12/2009): "Gateway control protocol: ITU-T H.248 support for media-oriented negotiation acceleration (MONA)". +- [47] 3GPP TS 29.235: "Interworking between SIP-I based circuit-switched core network and other networks". +- [48] 3GPP TS 23.231: "SIP-I based circuit-switched core network; Stage 2". +- [49] ITU-T Recommendation H.248.71 (02/2010): "Gateway Control Protocol: RTCP support packages". +- [50] IETF RFC 4103: "RTP Payload for Text Conversation". +- [51] ITU-T Recommendation T.140: "Text conversation presentation protocol". +- [52] IETF RFC 4102: "Registration of the text/red MIME Sub-Type". +- [53] IETF RFC 2198: "RTP Payload for Redundant Audio Data". +- [54] ITU-T Recommendation V.18 (11/00): "Operational and interworking requirements for DCEs operating in the text telephone mode" including V.18 (2000) Amendment 1 (11/02): "Harmonization with ANSI TIA/EIA-825 (2000) text phones". +- [55] ITU-T Recommendation G.168 (03/2009): "Digital network echo cancellers". +- [56] Void +- [57] Void +- [58] Void + +- [59] IETF RFC 4145: "TCP-Based Media Transport in the Session Description Protocol (SDP)". +- [60] IETF RFC 4585: "Extended RTP Profile for Real-time Transport Control Protocol (RTCP) - Based Feedback (RTP/AVPF)". +- [61] ITU-T Recommendation X.690: "ASN.1 encoding rules: Specification of Basic Encoding Rules (BER), Canonical Encoding Rules (CER) and Distinguished Encoding Rules (DER)". +- [62] 3GPP TS 26.114: "IP Multimedia Subsystem (IMS); Multimedia Telephony; Media handling and interaction". +- [63] 3GPP TS 22.153: "Multimedia Priority Service". +- [64] ITU-T Recommendation H.248.52 (06/2008): "Gateway control protocol: QoS support packages". +- [65] ITU-T Recommendation T.38 (09/2010): "Procedures for real-time Group 3 facsimile communication over IP networks". +- [66] ITU-T Recommendation H.248.82 (03/2013): "Gateway control protocol: Explicit Congestion Notification Support". +- [67] ITU-T Recommendation H.248.50 (2010) Corrigendum 1 (02/12): "Gateway control protocol: NAT traversal toolkit packages". +- [68] IETF RFC 5245: "Interactive Connectivity Establishment (ICE): A Protocol for Network Address Translator (NAT) Traversal for Offer/Answer Protocols". +- [69] 3GPP TS 24.229: "IP Multimedia Call Control Protocol based on SIP and SDP". +- [70] IETF RFC 5939: "Session Description Protocol (SDP) Capability Negotiation". +- [71] ITU-T Recommendation H.248.80 (01/2014): "Gateway control protocol: Usage of the revised SDP offer/answer model with ITU-T H.248". + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the [following] terms and definitions [given in ... and the following] apply. + +**Context (H.248):** A context is an association between a number of Terminations. The context describes the topology (who hears/sees whom) and the media mixing and/or switching parameters if more than two terminations are involved in the association. + +**Package (H.248):** Different types of gateways may implement terminations which have differing characteristics. Variations in terminations are accommodated in the protocol by allowing terminations to have optional properties. Such options are grouped into packages, and a termination may realise a set of such packages. + +**Termination (H.248):** A termination is a logical entity on an MGW which is the source and/or sink of media and/or control streams. A termination is described by a number of characterising properties, which are grouped in a set of descriptors which are included in commands. Each termination has a unique identity (TerminationID). + +**Termination Property (H.248):** Termination properties are used to describe terminations. Related properties are grouped into descriptors. Each termination property has a unique identity (PropertyID). + +For the purposes of the present document, the following terms and definitions as defined in 3GPP TS 29.163 [4] apply: + +**ICE lite** + +**Full ICE.** + +## 3.2 Symbols + +For the purposes of the present document, the following symbols apply: + +Mn Interface between the media gateway control function and the IMS media gateway. + +## 3.3 Abbreviations + +For the purposes of the present document, the following abbreviations given in TR 21.905 [40] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in TR 21.905 [40]. + +| | | +|-----------|----------------------------------------------------------------------------------------------------| +| AMR | Adaptive MultiRate | +| BICC | Bearer Independent Call Control | +| CN | Core Network | +| CS | Circuit-Switched | +| DTMF | Dual Tone Multi Frequency | +| CE | Congestion Experienced | +| ECN | Explicit Congestion Notification | +| FFS | For further study | +| GSM | Global System for Mobile communications | +| ICE | Interactive Connectivity Establishment | +| IETF | Internet Engineering Task Force | +| IM | IP Multimedia | +| IM-MGW | IP Multimedia Media Gateway | +| IMS | IP Multimedia Subsystem | +| IP | Internet Protocol | +| ISDN | Integrated Services Digital Network | +| ISUP | ISDN User Part | +| MG/MGW | Media GateWay | +| MGC | Media Gateway Controller | +| MGCF | Media Gateway Control Function | +| MIME | Multipurpose Internet Mail Extensions | +| MPS | Multimedia Priority Service | +| n.a. | not applicable | +| PDH | Plesiochronous Digital Hierarchy | +| PES | PSTN/ISDN Emulation Subsystem | +| PSTN | Public Switched Telephone Network | +| PT | Payload Type | +| R2 | (ETSI TISPAN NGN) Release 2 | +| RFC | Request For Comment; this includes both discussion documents and specifications in the IETF domain | +| RTCP | RTP Control Protocol | +| RTP | Real-time Transport Protocol | +| SCTP | Stream Control Transmission Protocol | +| SDH | Synchronous Digital Hierarchy | +| SDP | Session Description Protocol | +| SDPCapNeg | SDP Capability Negotiation | +| SIP | Session Initiation Protocol | +| SONET | Synchronous Optical NETwork | +| SS | Silence Suppression | +| SS7 | Signalling System No. 7 | +| STUN | Session Traversal Utilities for NAT | +| TDM | Time Division Multiplexing | +| TISPAN | Telecommunications and Internet converged Services and Protocols for Advanced Networking | +| TMGW | Trunking MGW | +| TS | Technical Specification (3GPP, ETSI) | +| VBD | VoiceBand Data | + +# --- 4 UMTS capability set + +## 4.1 Capability set + +The support of the Mn interface capability set shall be identified by the Mn profile and support of this profile shall be indicated in ServiceChange procedure. + +The mandatory parts of this capability set shall be used in their entirety whenever it is used within the H.248 profile. Failure to do so will result in a non-standard implementation. + +ITU-T Recommendation H.248.1 (05/02) [9] is the basis for this Capability Set. The compatibility rules for packages, signals, events, properties and statistics and the H.248 protocol are defined in ITU-T Recommendation H.248.1 [9]. Their use or exclusion for this interface is clarified in clause 12. + +# --- 5 Naming conventions + +## 5.1 MGCF/IM-MGW naming conventions + +The MGCF shall be named according to the naming structure of the underlying transport protocol which carries the H.248 protocol. + +For further definition of the Termination Names see Annex A.6. + +## 5.2 Void + +# --- 6 Topology descriptor + +No special behaviour, for definition of use see Annex A. 5. + +# --- 7 Transaction timers + +No special behaviour, for definition of timers see Annex A.10. + +# --- 8 Transport + +Each implementation of the Mn interface should provide SCTP (as defined in IETF RFC2960 [15] and as updated by RFC3309 [43]), however other options are permitted within the profile. For further definition see Annex A12. + +# --- 9 Multiple Virtual MG. + +The support of multiple virtual MGW outlined in the subclause "Multiple virtual MGW" in ITU-T Recommendation H.248.1 [9] is optional. + +# --- 10 Formats and codes + +## 10.1 Signalling Objects + +Table 10.1 shows the parameters which are required. + +The coding rules applied in ITU-T Recommendation H.248.1 [9] for the applicable coding technique shall be followed for the UMTS capability set. + +**Table 10.1: required parameters** + +| Signalling Object | H.248 Descriptor | Coding | +|----------------------------------------|---------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Additional Bandwidth Properties | Remote Descriptor | The "a=bw-info" SDP attribute defined in 3GPP TS 26.114 [62], see table A.15/1. | +| Allowed RTCP APP message types | Remote Descriptor | The "a=3gpp_mtsi_app_adapt" SDP attribute defined in 3GPP TS 26.114 [62]. | +| Bearer Service Characteristics | Local Descriptor or Remote Descriptor | As per Q.1950 [14]. For TMR, only values "3.1 kHz audio" or "speech" are required. | +| BNC Release | EventDescriptor | As for the EventsDescriptor in subclause E.1.2.1/H.248.1 "Cause" | +| BNC Release | ObservedEvent descriptor | As for the ObservedEventsDescriptor in subclause E.1.2.1/H.248.1 "Cause" | +| Codec List | Local Descriptor or Remote Descriptor | in a single SDP m-line.
For a static RTP payload type, the codec type should be implied by the RTP payload type, if not then each codec type shall be provided in a separate SDP "a=rtpmap"-line and possibly additional SDP "a=fmtp"-line(s). See Clause 10.2.
For a dynamic RTP payload type, for each codec information on the codec type shall be provided in a separate SDP "a=rtpmap"-line and possibly additional SDP "a=fmtp"-line(s). See Clause 10.2.
For T.38, additional SDP attributes listed in subclause 10.2.3.6 may be provided. | +| Context ID | NA | Binary Encoding: As per ITU-T Recommendation H.248.1 [9] Annex A.
Textual Encoding: As per ITU-T Recommendation H.248.1 [9] Annex B. | +| Diffserv Code Point | Local Control | Defined according to the Differentiated Services Code Point property in ITU-T Recommendation H.248.52 [64]. | +| ECN Enabled | Local Descriptor or Remote Descriptor | Defined according to the "ECN Enabled" property in ITU-T Recommendation H.248.82 [66]. | +| ECN Failure | Events, Observed Events | Defined according to the "ECN Failure" Event in ITU-T Recommendation H.248.82 [66]. | +| ECN Failure Type | ObservedEvents Descriptor | As for the ObservedEventsDescriptor Parameter "Failure Type" in ITU-T Recommendation H.248.82 [66]. | +| ECN Initiation Method | Local Descriptor or Remote Descriptor | Defined according to "Initiation Method" property in ITU-T Recommendation H.248.82 [66]. | +| Forward media in MPC | Signal descriptor | As for the signal "Forward Media in Preconfigured Channel" in H.248.72 [46] subclause 7.3.2 | +| Highest Multiplex Level | Termination state | As for property "Highest multiplexing Level" in subclause 4.1.2/H.248.12 [41] | +| H245 message content | ObservedEvent descriptor | As for the ObservedEventDescriptor in subclause A.8.2.1.2/H.248.12a2 [42] "Contents of H.245 message". | +| ICE host candidate request | Local Descriptor | The "a=candidate" SDP attribute defined in IETF RFC 5245 [68] of type "host" with the transport, port and priority parameters with wildcard sign "\$" to request the allocation of a host candidate | +| ICE host candidate | Local Descriptor | The "a=candidate" SDP attribute defined in IETF RFC 5245 [68] | +| ICE lite indication | Local Descriptor | The "a=ice-lite" SDP attribute defined in IETF RFC 5245 [68]. | +| ICE password request | Local Descriptor | The "a=ice-pwd" SDP attribute defined in IETF RFC 5245 [68] with wildcard sign "\$". | +| ICE password | Local Descriptor | The "a=ice-pwd" SDP attribute defined in IETF RFC 5245 [68]. | +| ICE received candidate | Remote Descriptor | The "a=candidate" SDP attribute defined in IETF RFC 5245 [68] | +| ICE received password | Remote Descriptor | The "a=ice-pwd" SDP attribute defined in IETF RFC 5245 [68]. | +| ICE received Ufrag | Remote Descriptor | The "a=ice-ufrag" SDP attribute defined in IETF RFC 5245 [68]. | +| ICE Ufrag request | Local Descriptor | The "a=ice-ufrag" SDP attribute defined in IETF RFC 5245 [68] with wildcard sign "\$". | +| ICE Ufrag | Local Descriptor | The "a=ice-ufrag" SDP attribute defined in IETF RFC 5245 [68]. | +| ICE Connectivity Check Result | Events, Observed Events | Defined according to Connectivity Check Result event in ITU-T Recommendation H.248.50 [67]. | +| ICE Send Connectivity Check | Signals | Defined as the ostuncc/scc signal in ITU-T Recommendation H.248.50 [67]. | +| ICE New Peer Reflexive Candidate | Events, Observed Events | Defined according to New Peer Reflexive Candidate event in ITU-T Recommendation H.248.50 [67]. | +| ICE Send Additional Connectivity Check | Signals | Defined as the ostuncc/sacc signal in ITU-T Recommendation H.248.50 [67]. | +| Inactivity timeout | EventDescriptor | As for the EventsDescriptor in subclause 6.2/H.248.14 "Inactivity Timeout" | +| Inactivity timeout | ObservedEvent descriptor | As for the ObservedEventDescriptor in subclause 6.2/H.248.14 "Inactivity Timeout " | + +| | | | +|-----------------------------------|---------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Incoming H245 message | Event descriptor | As for the EventDescriptor in subclause A.8.2.1/H.248.12a2 [42] "Incoming H.245 message" | +| Incoming Multiplex table | Local Control | As for property "Incoming Multiplex Table" in subclause 4.1.5/H.248.12 [41] | +| Interwork H.245-RTCP | Signal descriptor | As for the EventDescriptor parameter in subclause 8.2.1.1.1/H.248.71[49] "Feedback Message Type ". | +| IP Address | Local Descriptor or Remote Descriptor | in SDP "c-line" | +| IP interface | Local control | As for the property "IP interface type" in subclause 15.2.11.1 in 3GPP TS 29.232 [5] | +| IP realm identifier | Local control | As for the property "IP realm identifier " in subclause 5.1.1/H.248.41[44] | +| Legacy Interworking Detected | Event descriptor | As for the EventDescriptor in H.248. 72 [46] subclause 7.2.3 "Legacy Detected" | +| mediatype | Local Descriptor or Remote Descriptor | in sdp m-line
"audio" for voice service, "video" for video service and "image" for T.38 service. | +| Mona Preference Channel reception | Event descriptor | As for the EventDescriptor in H.248. 72 [46] subclause 7.2.4 "MPC reception" | +| MONA Preference completed | Event descriptor | As for the EventDescriptor in H.248.72 [46] subclause 7.2.2 "MONA Preference negotiation completed" | +| MONA preference message content | ObservedEvent descriptor | As for the ObservedEventDescriptor in H.248.72 [46] subclause 7.2.1.2.1 "Contents of MONA preference message ". | +| MONA Preference recv | Event descriptor | As for the EventDescriptor in H.248. 72 [46] subclause 7.2.2.1 "MONA Preference reception" | +| MPC MUX Code | Signal descriptor | As for the additional parameter of the signal "Forward Media in Preconfigure Channel" in H.248.72 [46] subclause 7.3.2.1 | +| Muxcode | ObservedEvent descriptor | As for the ObservedEventDescriptor in H.248. 72 [46] subclause 7.2.4.2.1 "Mux Code". | +| Muxdescriptor | Multiplex Descriptor | Binary Encoding: As per ITU-T Recommendation H.248.1 [9] Annex A.
Textual Encoding: As per ITU-T Recommendation H.248.1 [9] Annex B. | +| Outgoing H245 message | Signal descriptor | As for the signal "Outgoing H.245 Message " in subclause A.8.3.1/H.248.12a2 [42] | +| Outgoing H245 message content | Signal descriptor | As for the additional parameter of the signal "Outgoing H.245 Message " in subclause A.8.3.1.1/H.248.12a2 [42] | +| Outgoing MONA preference content | Signal descriptor | As for the additional parameter of the signal " Outgoing MONA preference message" in H.248. 72 [46] subclause 7.3.1.1.1 | +| Outgoing MONA preferences | Signal descriptor | As for the signal "Outgoing MONA preference message " in H.248. 72 [46] subclause 7.3.1 | +| Outgoing multiplex table | Local Control | As for property "Outgoing Multiplex Table" in subclause 4.1.6/H.248.12 [41] | +| Port | Local Descriptor or Remote Descriptor | in SDP m-line.
in SDP m-line shall be set to value "RTP/AVP" for voice or video service, and set to value "UDPTL" or "TCPTL" for T.38 service. | +| Priority Information | NA | Priority Indicator (subclause 6.1.1 of ITU-T Recommendation H.248.1 [9])
Binary Encoding: Encoding as per ITU-T Recommendation H.248.1 [9] Annex A "priority" context attribute
Textual Encoding: Encoding as per ITU-T Recommendation H.248.1 [9] Annex B "priority" context attribute | +| Remote H223 capability | Local Control | As for property "Remote H.223 capability" in subclause 4.1.4/H.248.12 [41] | +| Reserve_Value | Local Control | ITU-T Recommendation H.248.1 [9] Mode property.
Binary Encoding: Encoding as per ITU-T Recommendation H.248.1 Annex A "reserveValue"
Textual Encoding: Encoding as per ITU-T Recommendation H.248.1 Annex B "reservedValueMode". | +| RtcpbwRR | Local Descriptor or Remote Descriptor | in SDP "b:RR"-line as per IETF RFC 3556 [39]. | +| RtcpbwRS | Local Descriptor or Remote Descriptor | in SDP "b:RS"-lineas per IETF RFC 3556 [39]. | +| RTCP Filter | Event descriptor | As for the EventDescriptor parameter in subclause 8.2.1.1.1/H.248.71[49] "Feedback Message Type ". | + +| | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------| +| RTPpayload | Local Descriptor or Remote Descriptor | in SDP m-line | +| SCP | Event descriptor | As for the EventDescriptor parameter in H.248. 72 [46] subclause 6.2.1.1 "SCP". | +| SDPCapNeg configuration | Local Descriptor or Remote Descriptor | The SDP attributes for SDP capability negotiation according to IETF RFC 5939 [70]. | +| SDPCapNeg Supported Capabilities | Termination State | Defined according to SDPCapNeg Extensions property in ITU-T Recommendation H.248.80 [71]. | +| SPC In | Observed event descriptor | As for the ObservedEventDescriptor parameter in H.248. 72 [46] subclause 6.2.2.1 ""Incoming H.245 message" | +| SPC Out | Signal descriptor | As for the additional parameter of the signal "Outgoing H.245 Message " in H.248. 72 [46] subclause 6.3.1.1 | +| Stream ID | Stream Descriptor | Binary Encoding: As per ITU-T Recommendation H.248.1 [9] Annex A.
Textual Encoding: As per ITU-T Recommendation H.248.1 [9] Annex B. | +| Termination ID | NA | Binary Encoding: As per ITU-T Recommendation H.248.1 [9] Annex A.
Textual Encoding: As per ITU-T Recommendation H.248.1 [9] Annex B. | +| Transaction ID | NA | Binary Encoding: As per ITU-T Recommendation H.248.1 [9] Annex A.
Textual Encoding: As per ITU-T Recommendation H.248.1 [9] Annex B. | +| UpdatePicture_Event | ObservedEvent descriptor | As for the EventDescriptor parameter in subclause 8.2.1.2.1/H.248.71[49] "Update Picture ". | +| UpdatePicture_Signal | Signal descriptor | As for the SignalDescriptor parameter "Update Picture " in subclause 8.3.1.1.1/H.248.71[49]. | +| NOTE: For binary encoding, the SDP equivalents "SDP_V", "SDP_M", "SDP_C", "SDP_A", and SDP_B" in ITU-T Recommendation H.248.1 [9], Annex C.11, shall be used to encode the corresponding SDP lines. Other SDP equivalents may be used, for details see Annex A. The SDP equivalents shall be used in the order specified for the corresponding SDP lines in IETF RFC 2327 [17]. Rules for the usage of SDP in ITU-T Recommendation H.248.1 [9] shall also be applied to the SDP equivalents. SDP description types (v= , m=, a= etc.) are not encoded. CR/LF are not encoded. | | | + +## 10.2 Codec Parameters + +### 10.2.1 AMR and AMR-WB Codecs + +On IMS terminations, the AMR and AMR-WB codecs are transported according to the IETF AMR RTP profile, IETF RFC 4867 [16], 3GPP TS 26.114 [62] selects options applicable within 3GPP. + +IETF RFC 4867 [16] contains the MIME registration of the IETF AMR RTP profile with media type "audio" and media subtype of "AMR" and "AMR-WB". The AMR and AMR-WB codecs shall be signaled accordingly in the SDP "a=rtpmap"-line and a dynamic RTP payload type shall be used. + +The selected options are expressed as MIME parameters in SDP "a=fmtp"-line. The following MIME parameters shall be supported on the Mn interface: + +- "mode-set" +- "mode-change-period" + +In addition the following MIME parameters may be supported on the Mn interface: + +- "octet-align" +- "mode-change-neighbor" (for IMS this parameter shall be included and set to 1) +- "maxptime" +- "ptime" + +For compatibility with GSM peers, the IM-MGW shall perform mode changes only in every second sent package. + +Example of encoding of AMR codec + +ABNF: + +``` + +Local { + v=0 + c=IN IP4 $ + m=audio $ RTP/AVP 96 + a=rtpmap:96 AMR/8000 + a=fmtp:96 mode-set=0,2,5,7;mode-change-period=2;mode-change-neighbor=1 + a=maxptime:20 +} + +``` + +ASN.1: + +``` + +LocalDescriptor{ + PropertyParams{ + PkgdName=0x000B001 /*SDP_V */ + value= "0" + PkgdName=0x000B008 /*SDP_C */ + value= "IN IP4 $" + PkgdName=0x000B00F /*SDP_M */ + value= "audio $ RTP/AVP 96" + PkgdName=0x000B00C /*SDP_A */ + value= "rtpmap:96 AMR/8000" + PkgdName=0x000B00C /*SDP_A */ + value= "fmtp:96 mode-set=0,2,5,7;mode-change-period=2;mode-change-neighbor=1" + PkgdName=0x000B00C /*SDP_A */ + value= "maxptime:20" + } +} + +``` + +NOTE: The c-line may be provided after m-line. + +On RTP-CN (SIP-I) terminations speech codecs are supported according to 3GPP TS 29.232 [5] subclause 10.2.1. + +### 10.2.2 DTMF Payload Type + +On IMS and RTP-CN (SIP-I) terminations, DTMF is transported according to the IETF RFC 2833 [18] "telephone event" format. + +IETF RFC 2833[18] contains the MIME registration with media type "audio" and media subtype "telephone-event". DTMF shall be signaled accordingly in the SDP "a=rtpmap"-line and a dynamic RTP payload type shall be used. + +An IM-MGW supporting DTMF shall support the default options of the IETF RFC 2833 [18] "telephone event" format. Therefore, a support of optional MIME parameters of "telephone-event" is not required at the Mn interface. + +### 10.2.3 Other Codecs + +On IMS terminations, other codecs such as ITU-T codecs are transported according to the RTP payload formats in IETF RFC 3555[32]. 3GPP TS 29.163[4], clause B.2.5.4, specifies the options applicable within 3GPP. + +IETF RFC 3555[32] contains the MIME registration with media type "audio" and corresponding media subtype. + +For dynamic payload type being used the ITU-T codecs shall be signaled accordingly in the SDP "a=rtpmap"-line, where the selected options are expressed as MIME parameters in SDP "a=fmtp"-line. + +For static payloads type being used ITU-T codecs shall be allowed to be signaled accordingly in the SDP "a=rtpmap"-line, when the selected options are expressed as MIME parameters in SDP "a=fmtp"-line. Otherwise the codec type is implied by the RTP payload type. + +#### 10.2.3.1 G.711 Codec + +On IMS and RTP-CN (SIP-I) terminations, G.711 codec is transported according to IETF RFC 3551[33]. + +#### 10.2.3.2 Clearmode + +On IMS and RTP-CN (SIP-I) terminations, Clearmode codec is transported according to IETF RFC 4040[35]. + +When the MGC determines that a 64 kbit/s unrestricted bearer service is requested, the clearmode codec shall be used. A Dynamic Payload type with CLEARMODE as encoding name shall be included in both the local and remote descriptor. + +The behaviour of the MGW shall then conform to IETF RFC 4040[35]. All voice and signal processing functions such as silence suppression, comfort noise insertion and gain adjustment shall be automatically turned off. The MGW shall inherit the same QoS objectives as the ISDN bearer service. + +#### 10.2.3.3 Silence suppression and comfort noise + +On RTP-CN (SIP-I) terminations silence suppression and comfort noise are supported according to 3GPP TS 29.232 [5] subclause 10.2.3.4. For IMS terminations the following text applies. + +Silence Suppression (SS) mode is direction-independent and shall be supported call/bearer individually. Silence suppression mode must be explicitly enabled and disabled. Default shall be a disabled SS mode. + +If a codec has built-in support for silence suppression and comfort noise insertion, and an a= line has been defined in IETF RFC3551[33] or IETF RFC 3555 [32] to activate or de-activate these features, the activation or deactivation of these features shall be indicated using the a= line according to IETF RFC 3551[33] and IETF RFC 3555[32]. If the selected codec does not have built in support for silence suppression and comfort noise (CN) insertion, the CN payload code defined in RFC 3389[36] may be included in the media description. + +E.g (for ITU-T Recommendation G.711 A-law codec): + +``` +v=0 +c=IN
+m=audio RTP/AVP 8 13 +a=ptime: 10 +``` + +If the CN payload is included in the Local Descriptor, the MGW shall be prepared to receive CN packets during silence periods. This action corresponds to an implicit enabling of the SS mode in receiving direction. + +If the CN payload is included in the Remote Descriptor, the MGW shall send CN packets during silence periods. This action corresponds to an implicit enabling of the SS mode in sending direction. + +Comfort noise generation, voice activity detection and discontinuous transmission algorithms are outside the scope of the present document. + +#### 10.2.3.4 VBD codec + +Voiceband data refers to traffic from facsimile, modem or text telephony applications. + +On IMS terminations, voiceband data traffic is transported for facsimile /modem or data/ modem (but not text/modem, see sub clause 10.2.3.5) according to ITU-T Recommendation V.152 [37] and its Corrigendum 1. ITU-T Recommendation G.711 must be used as VBD codec. The RTP Payload Type (PT) codepoint, "0" or "8" or a value from the dynamic PT range , is used in the MG. + +NOTE 1: Use of "0" or "8" is indicating to the MG that only inband-based VBD stimuli must be detected. Both peering MGs are consequently not directly synchronized in their state transitions between "voice" and "VBD" modes. + +NOTE 2: Use of "a value from the dynamic PT range" is indicating a VBD RTP packet according to ITU-T Recommendation V.152 [37]. The MGW may offer then an enhanced VBD service. + +Upon detection of voiceband facsimile/modem or data/modem data traffic, the Media Gateway shall autonomously switch from Audio mode to VBD mode with VBD codec. + +Transitioning between Audio mode and VBD mode is possible in both directions. The procedures for transitioning between these two operation modes are described in ITU-T Recommendation V.152 clause 10/V.152 [37]. Any state transition requires the detection of a "VBD stimuli" (see ITU-T Recommendation V.152 clause 9/V.152 [37]). The IM-MGW shall be compliant with ITU-T Recommendation G.168 [55] on detecting VBD. + +For Real-Time Text Telephony support within IMS at the IMS termination see subclause 10.2.3.5. + +#### 10.2.3.5 Real-Time Text Telephony Media + +On IMS terminations, text is transported according to IETF RFC 4103 [50] "text/t140" conversation RTP payload format and coded according to ITU-T Recommendation T.140 [51]. + +If redundancy is used per IETF RFC 2198 [53], another payload type number needs to be provided for the redundancy format. + +IETF RFC 4103 [50] contains the MIME registration with media type "text" and media subtype "t140". IETF RFC 4102 [52] contains the MIME registration with media type "text" and media subtype "red" (for redundancy coding variant). + +RTP- Real-Time Text shall be signalled in a distinct SDP m-line accordingly in the SDP "a=rtpmap"-line and a dynamic RTP payload type shall be used. + +Example of SDP which describes RTP Real-Time Text transport on port 11000 without redundancy: + +``` +m=text 11000 RTP/AVP 98 +a=rtpmap:98 t140/1000 +``` + +Example of SDP which describes RTP Real-Time Text transport on port 11000, but also utilizes IETF RFC 2198 [53] to provide two levels of redundancy for the text packets: + +``` +m=text 11000 RTP/AVP 100 98 +a=rtpmap:98 t140/1000 +a=rtpmap:100 red/1000 +a=fmtp:100 98/98/98 +``` + +When Real-Time Text Telephony is configured at the IMS Termination in the IM-MGW and G.711 encoding is configured at peer CS side Termination and the terminations are through-connected the IM-MGW shall + +- monitor the CS side termination incoming PCM streams for text telephony in accordance with provisioned inband text telephony tone types at the CS side termination and, if multiple inband text telephony tone types are provisioned, in accordance with ITU-T Recommendation V.18 [54]; +- forward any detected incoming text telephony media at the CS side termination towards the IMS termination text stream; and +- multiplex any Real Time Text payload received from the IMS side to the CS side termination outgoing PCM streams for text telephony in accordance with provisioned inband text telephony tone type at the CS side termination in accordance with ITU-T Recommendation V.18 [54]. + +#### 10.2.3.6 T.38 FAX + +FAX according to ITU-T recommendation T.38 [65] may be supported at IMS terminations at an IM-MGW and at the MGCF according to the procedures in the present Clause. + +Version 2 or higher of T.38 is recommended. + +An IM-MGW supporting T.38 shall support the "UDPTL/UDP" and may support "TPKT/TCP" transport of FAX. + +To configure FAX terminations, the MGCF shall signal "udptl" or "tcp" in an SDP m-line and may signal the T.38 SDP attributes listed in Table 10.2.3.6.1 to the IM-MGW. + +**Table 10.2.3.6.1: Applicable T.38 SDP attributes at the Mn Interface.** + +| Attribute | Remarks | +|----------------------------|-------------------------------------------------------------------------------------------------------------------| +| T38FaxVersion | T.38 SDP attributes shall only be provisioned for Version 2 or higher. Version 0 applies if attribute is omitted. | +| T38MaxBitRate | | +| T38FaxMaxBuffer | | +| T38FaxMaxDatagram | | +| T38FaxMaxIFP | Only if T.38 version 4 is supported by the IM-MGW | +| T38FaxUdpEC | | +| T38FaxUdpECDepth | Only if T.38 version 4 is supported by the IM-MGW | +| T38FaxUdpFECMaxSpan | Only if T.38 version 4 is supported by the IM-MGW | +| T38ModemType | Only if T.38 version 4 is supported by the IM-MGW | + +# --- 11 Mandatory Support of SDP and H.248 Annex C information elements + +See Annex A.15. + +# --- 12 General on packages and Transactions + +The use of "Overspecified" (e.g. range of values) and "Underspecified" (e.g. "?") parameter specification shall not be permitted except where explicitly indicated in or referenced by the Mn interface specification. + +Commands on ROOT Termination shall only use the NULL Context. + +## 12.1 Profile Details + +VOID. + +NOTE: Profile now defined in normative Annex A. + +# --- 13 Void + +# 14 Call independent H.248 transactions + +See section A.17.1 + +# --- 15 Transactions towards IM CN Subsystem + +15.1 Procedures related to a termination towards IM CN SubsystemFor Transactions towards IM CN Subsystem see A.17.2. + +## 15.2 IMS packages + +None + +# --- 16 Transactions towards ISUP + +## 16.1 Procedures relating to a termination towards ISUP + +See section A.17.3. + +## 16.2 ISUP packages + +None + +# 17 Transactions towards BICC + +## 17.1 Procedures related to a termination towards BICC + +See section A.17.4 + +## 17.2 BICC packages + +This Clause is only applicable for terminations towards BICC Networks. The support of terminations towards BICC networks is optional. + +No new packages for terminations towards BICC Networks are defined in the present specification. See Clause 12.1.14 for reused packages from other specifications. + +If the Nb framing protocol (see 3GPP TS 29.415 [21]) is applied at the termination towards the BICC network, the following package shall be applied: + +3GUP package (see subclause 15.1.1 of 3GPP TS 29.232 [5]); To enable bearer modification at OoBTC capable networks on Nb interface (see 3GPP TS 23.153 [22]) at the termination towards the BICC network, the following package shall be applied: + +Modification of Link Characteristics Bearer Capability (see subclause 15.1.5 of 3GPP TS 29.232 [5]); + +# Annex A (normative): Profile Description + +## A.1 Profile Identification + +**Table A.1/1: Profile version** + +| | | +|----------------------|----------------| +| Profile name: | threeegimscsiw | +| Version: | 6 | + +## A.2 Summary + +This Profile describes the minimum mandatory settings and procedures required to fulfil the Media Gateway control requirements for a) the interworking scenario between 3GPP IMS and 3GPP CS or PSTN/ISDN and b) the interworking scenario between NGN and PSTN/ISDN (i.e ETSI IMS-PSTN/ISDN, ETSI PES-PSTN/ISDN). + +In addition optional settings and procedures are described which fulfil optional features and where supported, the minimum mandatory settings within the optional procedures and packages are identified that must be supported in order to support that feature. + +"Optional" or "O" means that it is optional for either the sender or the receiver to implement an element. If the receiving entity receives an optional element that it has not implemented it should send an Error Code (e.g. 445 "Unsupported or Unknown Property", 501 "Not Implemented", etc.). "Mandatory" or "M" means that it is mandatory for the receiver to implement an element. Whether it is mandatory for the sender to implement depends on specific functions; detail of whether elements of the core protocol are mandatory to be sent are defined in the stage 2 procedures, stage 3 procedures and/or the descriptions of individual packages. + +The setting or modification of elements described in the profile under the heading "Used in Command" has the meaning that the property can be set/modified with that command. The property may be present in other commands (in order to preserve its value in accordance with ITU-T H.248.1[9]) when those commands are used for other procedures that affect the same descriptor. + +This profile supports Explicit Congestion Notification, Multimedia Priority Service and Rate Adaptation for Media Endpoints using Enhanced Bandwidth Negotiation. + +## A.3 Gateway Control Protocol Version + +ITU Recommendation H.248.1 Version 2 [9] shall be the version supported. + +## A.4 Connection Model + +**Table A.4/1: Connection Model** + +| | | +|------------------------------------------------------------|---------------------------| +| Maximum number of contexts: | No restriction | +| Maximum number of terminations per context: | 2 (NOTE 1)
32 (NOTE 2) | +| Allowed terminations type combinations in a Context | All (NOTE 3) | + +NOTE 1: Support of 2 terminations per context is required for TISPAN. Support of more than two terminations per context (e.g. for monitoring) is optional. +NOTE 2: Support of 32 termination per context is required for 3GPP +NOTE 3: For TISPAN NGN R2 only the following is required: +- Context[a](IMS, TDM), +- Context[b](TDM, TDM), +- Context [c] (TDM), +- Context [d] (IMS). + +## A.5 Context Attributes + +**Table A.5/1: Context attributes** + +| Context Attribute | Supported | Values Supported | +|--------------------------|-------------------|-------------------------| +| Topology | Optional (NOTE 1) | All | +| Priority Indicator | Optional (NOTE 2) | 0-15 (NOTE 3) | +| Emergency Indicator | Yes | Not Applicable | + +NOTE 1: The "Topology" attribute is optional for example support of monitoring. If requested and not supported error code 444 shall be returned. +NOTE 2: This Context Attribute parameter is used for MPS as specified in 3GPP TS 22.153 [63]. +NOTE 3: Priority values 11 – 15 of the Priority Indicator are reserved for MPS. + +## A.6 Terminations + +### A.6.1 Termination Names + +#### A.6.1.1 General + +The Termination ID structure is provisioned in the MGC and MG and is known by the MG and the MGC at or before start up. + +With ephemeral ATM/AAL2 and IP endpoint bearer types the internal structure of Termination ID is irrelevant for MGW and MGC and therefore Termination ID is only a numeric identifier for the termination. When bearer type is a physical timeslot within TDM circuit the Termination ID structure shall follow the Termination naming convention for TDM circuit bearer. + +Ephemeral terminations are further denoted in the profile by the following: + +- BICC (meaning applies to terminations towards BICC) +- BICC ATM (meaning applies to terminations towards BICC with ATM transport) +- BICC IP (meaning applies to terminations towards BICC with IP transport) +- IMS (meaning applies to terminations toward IMS) +- Multiplex (meaning applies to terminations performing multiplexing) + +- RTP-CN (meaning applies to terminations towards SIP-I on Nc) + +#### A.6.1.2 ASN.1 Encoding + +##### A.6.1.2.1 General Structure + +The following general structure of TerminationID shall be used: + +4 octets shall be used for the termination ID. The following defines the general structure for the termination ID: + +| | | +|------------------|---| +| Termination type | X | +|------------------|---| + +Termination type: + +Length 3 bits + +Values: + +000 Reserved + +001 Ephemeral termination + +010 TDM termination + +011 - 110 Reserved + +111 Reserved for ROOT termination Id (ROOT Termination Id = 0xFFFFFFFF) + +X: + +Length 29 bits. + +Usage dependent on Termination type. TDM terminations specified below in subclause 5.2.2. Other usage unspecified. + +The use of wildcarding for the Termination Id shall be performed using 1 octet only. + +##### A.6.1.2.2 Termination naming convention for TDM terminations + +**Table C.6.1.2.2/1 ASN.1 coding** + +| | | | +|--------------------------|------------|------------| +| Termination type (=010 ) | PCM system | Individual | +|--------------------------|------------|------------| + +PCM system: + +Length 24 bits + +Usage unspecified. Uniquely identifies PCM interface in MGW + +Individual: + +Length: 5 bits + +Max. of 32 individuals (timeslots) per PCM system (max. 24 for a 24 channel system) + +#### A.6.1.3 ABNF coding: + +##### A.6.1.3.1 General Structure + +The following general structure of termination ID shall be used: + +TerminationID = "ROOT" / pathName / "\$" / "\*" ; according to ITU-T H.248.1 [9] Annex B. + +##### A.6.1.3.2 Termination Naming Convention for TDM Terminations + +###### A.6.1.3.1.1 Naming Structure + +A hierarchical naming structure is recommended for physical Terminations. + +The PCMsystem is recommended to follow the following physical and digital signal hierarchy: + +PCMsystem = \_/\_/... + +The identifies the particular hierarchy level. + +Some example values of are: + +"s", "su", "stm4", "stm1", "oc3", "ds3", "e3", "ds2", "e2", "ds1", "e1" where "s" indicates a slot number and "su" indicates a sub-unit within a slot. + +Leading zeroes MUST NOT be used in any of the numbers ("#") above. + +The is a decimal number which is used to reference a particular instance of a at that level of the hierarchy. Value ranges always starting with one. + +The number of levels and naming of those levels is based on the physical hierarchy within the Media Gateway. + +Here are some examples of the Termination structure: + +1. TDM Terminations at SDH STM-1 ports: +tdm/s\_/stm1\_/e1\_/ +e.g., tdm/s\_2/stm1\_3/e1\_17/25 +2. TDM Terminations at PDH E1 ports (e.g., for "PCM system" only applications): +tdm/s\_/e1\_/ +e.g., tdm/s\_2/e1\_17/25 + +NOTE 1: This Termination naming convention may be used to align with ASN.1 TDM Termination names as defined in A.6.1.2.2. The alignment must take into account the numbering scheme of "" with the "PCM system" field, and the upper level(s) are regarded as prefix ("tdm/s-" versus "3-bit codepoint for 'TDM' "). + +NOTE 2: See also clause 3/H.248.33 concerning "PCM system" definition. + +3. TDM Terminations at SONET OC-3 ports: +tdm/s\_/oc3\_/ds1\_/ +e.g., tdm/s\_2/oc3\_3/ds1\_17/22 + +###### A.6.1.3.1.2 Syntactical Specification + +The syntax specification may be used for the population of valid TDM TerminationID structures for. + +ABNF (IETF RFC 4234) is used for the syntax specification. + +pathName = TDMToken SLASH (PCMsystem / "\*") + +TDMToken = "tdm" + +PCMsystem = 0\*(HierarchyLevelHIGHToken SLASH) HierarchyLevelLOWToken + +HierarchyLevelHIGHToken = (UnitTypeToken " " UnitNumber) + +HierarchyLevelLOWToken = (UnitTypeToken " " Wildcard) / Channel / Wildcard + +UnitTypeToken = "ChassisToken" / "SDHToken" / "SONETToken" / "PDHToken" + +ChassisToken = "s" / "su" ; slot, sub-unit within slot + +SDHToken = "stm4" / "stm1" ; relevant is capacity, but not +electrical or optical interface type + +SONETToken = "oc12" / "oc3" + +PDHToken = "ds3" / "e3" / "ds2" / "e2" / "ds1" / "e1" ; ANSI & ETSI + +UnitNumber = 1\*DIGIT + +Channel = %d0-31 / %d0-23 ; value range E1/T1 system + +Wildcard = "\*" + +###### A.6.1.3.1.3 Wildcarding + +Wildcarding (CHOOSE, ALL) is allowed for number fields ("``"). + +Examples for wildcarding: + +1. TDM Terminations at SDH STM-1 ports: + +e.g., wildcarding on top level: `tdm/*` + +e.g., wildcarding on slot level: `tdm/s_3/*` + +e.g., wildcarding on STM-1 level: `tdm/s_3/stm1_4/*` + +e.g., wildcarding on E1 level: `tdm/s_2/stm1_4/e1_49/*` + +2. TDM Terminations at PDH E1 ports: + +e.g., wildcarding on E1 level: `tdm/s_1/e1_2/*` + +###### A.6.1.3.1.4 Heterogeneous TDM Port Configurations + +An homogeneous TDM port configuration relates to a MGW with a single port type for physical Terminations. There is therefore a single TDM Termination name structure in use. + +Heterogeneous TDM configurations means different port types, either by different signal hierarchies, like SDH/STM-1 and SDH/STM-4, and/or a mix of SDH and PDH interfaces. The number of port types in use is determining the number of TDM Termination name structures. With heterogeneous configurations the TDM Termination name structure may be aligned, for instance, by using the "highest common digital signal hierarchy" as highest Termination name hierarchical level. There is consequently a single TDM Termination name structure with a "flattened" hierarchy. + +Example: + +MGW with SDH/STM-1 and PDH/E1 ports. Common denominator is "e1", a selected TDM Termination name might be therefore a common two-level structure with "`tdm/e1_/`". The unit types "s", "su" or "stm1" are not used here. + +NOTE: This concept is followed in A.6.1.2.2, ASN.1 for TDM Terminations. + +##### A.6.1.3.2 Termination Naming Convention for Ephemeral Terminations + +###### A.6.1.3.2.1 Naming Structure + +An alphanumeric pathname structure is recommended for Ephemeral terminations: + +`ephemeral/` + +e.g., `Ephemeral/1/0/40000` + +###### A.6.1.3.2.2 Syntactical Specification + +The syntax rules may be used for the population of valid ephemeral TerminationID structures for. ABNF (IETF RFC 4234) is used for the syntax specification. + +ABNF coding: + +pathName = EphToken SLASH EPHsystem + +EphToken = "Ephemeral" ; so called prefix + +; The maximum length of 'pathname' is defined in Annex B.2/H.248.1. + +EPHsystem = 0\*(HierarchyLevelHIGHToken SLASH) HierarchyLevelLOWToken + +HierarchyLevelHIGHToken = 1\*alphanum + +HierarchyLevelLOWToken = Individual / Wildcard + +alphanum = ALPHA / DIGIT + +Individual = 1\*DIGIT + +Wildcard = "\$" / "\*" + +### A.6.2 Multiplexed terminations + +**Table A.6.2/1: Multiplexed terminations** + +| | | +|-----------------------------------------------------------------------|------------| +| MultiplexTerminations Supported | Yes (NOTE) | +| NOTE : Yes for multimedia interworking and No for voice interworking. | | + +**Table A.6.2/2: Multiplex Types Supported** + +| | | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------| +| Multiplex types supported: | H.223 | +| Maximum number of terminations connected to multiplex: | TBD (NOTE) | +| NOTE: It is not clear what is the exact purpose of this parameter; further clarification within H.248.1 core protocol is required before this property shall be used. | | + +## A.7 Descriptors + +### A.7.1 Stream Descriptor + +**Table A.7.1/1: Stream descriptors** + +| | | +|----------------------------------------------------------------------------------------------------------------|----------| +| Maximum number of streams per termination type | 2 (NOTE) | +| NOTE : Value 2 for multimedia interworking and Real-Time Text interworking and value 1 for voice interworking. | | + +#### A.7.1.1 Local Control Descriptor + +**Table A.7.1.1/1: Local Control Descriptor** + +| | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|------------------------------------| +| | Termination Type | Stream Type | +| Reserve group used: | No | | +| Reserve value used: | Yes (NOTE 1) | Terminations Toward IMS and RTP-CN | +| NOTE 1: The "Reserve value" parameter is, inter alia, required for negotiation of multiple payload types, ie ITU-T Rec. G.711, comfort noise (according ITU-T Rec. G.711 Appendix II), DTMF tone relay (see RFC2833 [18]). | | | + +**Table A.7.1.1/2: Allowed Stream Modes** + +| Termination Type | Stream Type | Allowed StreamMode Values | +|-------------------------|-----------------------------|----------------------------------------| +| TDM | Not Applicable | SendOnly, RecvOnly, SendRecv, Inactive | +| IMS | Audio, Video, Text (NOTE 1) | SendOnly, RecvOnly, SendRecv, Inactive | +| BICC IP, RTP-CN | Not Applicable | SendOnly, RecvOnly, SendRecv, Inactive | +| BICC ATM | Not Applicable | SendOnly, RecvOnly, SendRecv, Inactive | +| Multiplex (NOTE 2) | Audio, Video | SendOnly, RecvOnly, SendRecv, Inactive | + +NOTE 1: Audio and Video for multimedia interworking, Audio and Text for Real-Time Text interworking, and Not applicable for voice interworking. +NOTE 2: Specific for multimedia interworking. + +### A.7.2 Events Descriptor + +**Table A.7.2/1: Events Descriptor** + +| Events settable on termination types and stream types: | Yes | | | +|---------------------------------------------------------------|-------------------------------------------------------------------------------|-----------------------------------------------------|---------------------------------------------------| +| | Event ID | Termination Type | Stream Type | +| | Detect_Digit(Digit) (d0 to dd, inclusive) | ALL except ROOT | Not Applicable | +| | BNC Established | Terminations towards BICC network | Not Applicable | +| | BNC Modification Failed | Terminations towards BICC network | Not Applicable | +| | BNC Modified | Terminations towards BICC network | Not Applicable | +| | Tunnel | Terminations towards BICC network with IP transport | Not Applicable | +| | g/cause | ALL except ROOT | Not Applicable | +| | g/sc | ALL except ROOT | Not Applicable | +| | ct/cmp | TDM | Not Applicable | +| | chp/mgcon | ROOT | Not Applicable | +| | Hangterm/thb | ALL except ROOT | Not Applicable | +| | ocp/mg_overload | ROOT | Not Applicable | +| | it/ito | ROOT | Not Applicable | +| | Start tone detected (tonedet/std) | RTP-CN, IMS, TDM, BICC | Only applicable to audio stream | +| | End Tone detected (tonedet/etd) | IMS | RTP-CN, TDM, BICC Only applicable to audio stream | +| | Optimal Codec Event (threegtoc/codecs_modify) | TDM, BICC, RTP-CN | Not Applicable | +| | Codec List Event (threegtoc/distant_codec_list) | TDM, BICC, RTP-CN | Not Applicable | +| | TFO Status Event (threegtoc/TFO_status) | TDM, BICC, RTP-CN | Not Applicable | +| | Incoming H.245 message (h245tp/h245msgin, 0x00 b4/0x0001) | Multiplex | Not Applicable | +| | MONA Preference reception (monapref/monaprefmsgin, 0x00f8/0x0001) | Multiplex | Not Applicable | +| | MONA Preference negotiation completed (monapref/monaprefcompl, 0x00f8/0x0002) | Multiplex | Not Applicable | + +| | | | | +|------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------|-----------|------------------------------| +| | Legacy Detected (monapref/legdet, 0x00f8/0x0003) | Multiplex | Not Applicable | +| | MPC reception (monapref/mpcrec, 0x00f8/0x0004) | Multiplex | Not Applicable | +| | RTCP Feedback Message Detection (rtcpfb/det, 0x00f6/0x0001) | IP | Not Applicable | +| | ECN Failure(ecnrous/fail, 0x010b/0x0001) | IP | Audio, Video | +| | ICE New Peer Reflexive Candidate (ostuncc/nprc, 0x00c3/0x0002) – See subclause A.14.38 | IP | Only applicable for full ICE | +| | ICE Connectivity Check Result (ostuncc/ccr, 0x00c3/0x0001) – See subclause A.14.38 | IP | Only applicable for full ICE | +| NOTE: Events for Terminations towards BICC network dependent on option to support such interworking, e.g. not required for TISPAN NGN R2 TMGW. | | | | +| NOTE1: BNC Release event is defined in formats and codes table 10.1 and refers to the g/cause event. | | | | + +Table A.7.2/2: Event Buffer Control + +| | | +|-----------------------------------|----| +| Event Buffer Control used: | No | +|-----------------------------------|----| + +Table A.7.2/3: Keep active + +| | | +|----------------------------------------------------------------|----------------------| +| Keepactive used on events: | Conditional (NOTE 1) | +| NOTE 1: Required for 3GPP, not required by TISPAN NGN R2 TMGW. | | + +Table A.7.2/4: Embedded events + +| | | +|------------------------------------------------|----| +| Embedded events in an event descriptor: | No | +|------------------------------------------------|----| + +Table A.7.2/5: Embedded signals + +| | | +|-----------------------------------------------------------------------------------------|-----| +| Embedded signals in an event descriptor: | Yes | +| NOTE: Used if MONA procedures are supported in the Add Multiplex Termination procedure. | | + +### A.7.3 EventBuffer Descriptor + +Table A.7.3/1: Event Buffer Descriptor + +| | | +|--------------------------------------|----| +| Event Buffer descriptor used: | No | +|--------------------------------------|----| + +### A.7.4 Signals Descriptor + +Table A.7.4/1: Signals Descriptor + +| | | | | +|--------------------------------------------------------------------|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Signals settable dependant on termination or streams types: | | Yes
NOTE: "Yes" means any signal not listed below may be played on any termination or stream, except Signals on ROOT termination shall not be supported. | | +| If yes | Signal ID | Termination Type | Stream Type / ID | +| | ct/* | TDM | Not Applicable | +| | gb/* | BICC | Not Applicable | +| | bt/* | BICC IP | Not Applicable | + +| | | | | +|--|--------------------------------------------------------------------------------------|-------------------------------|------------------------------| +| | cg/rt
cg/bt
cg/ct | TDM | Not Applicable | +| | an/apf | ALL except ROOT and Multiplex | Not Applicable | +| | Outgoing H.245 Message (h245tp/h245msgout, 0x00b4/0x0001) | Multiplex | Not Applicable | +| | Outgoing MONA preference message (monapref/monaprefmsgout, 0x00 f8/0x0001) | Multiplex | Not Applicable | +| | Forward Media in Preconfigured Channel (monapref/Preconfchannelmedia, 0x00f8/0x0002) | Multiplex | Not Applicable | +| | Feedback Message Sending (rtcpfb/fbmesssend, 0x00f6/0x0001) | IP | Not Applicable | +| | Send Additional Connectivity Check (ostuncc/sacc, 0x00c3/0x0002) | IP | Only applicable for full ICE | +| | Send Connectivity Check (ostuncc/scc, 0x00c3/0x0001) | IP | Only applicable for full ICE | + +Table A.7.4/2: Signal Lists + +| | | | +|-------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------|----------------------| +| Signals Lists supported: | | Conditional (NOTE 1) | +| If yes | Termination Type Supporting Lists: | ALL except ROOT | +| | Stream Type Supporting lists: | ALL | +| | Maximum number of signals to a signal list: | FFS | +| | Intersignal delay parameter supported: | No | +| NOTE 1: Required for 3GPP, not required for TISPAN NGN R2 TMGW.
NOTE 2: This field requires at least version 3 of the H.248.1 protocol | | | + +Table A.7.4/3: Overriding Signal type and duration + +| | | +|--------------------------------------------|----------| +| Signal type and duration supported: | Optional | +| NOTE: Not required for TISPAN NGN R2 TMGW. | | + +Table A.7.4/4: Notify completion + +| | | | +|-----------------------------------------------------------------------|-----------------------------|-------------------------------------| +| Notify completion supported: | | Yes | +| If yes | SignalID | Type of completion supported | +| | All Tones and Announcements | TO, EV, SD and NC | +| RequestID Parameter Supported: | NO | | +| NOTE: This field requires at least version 3 of the H.248.1 protocol. | | | + +Table A.7.4/5: Signals played simultaneously + +| | | +|---------------------------------------|----| +| Signals played simultaneously: | No | +|---------------------------------------|----| + +Table A.7.6/6: Keep active + +| | | +|-----------------------------------------------------------------|----------------------| +| Keepactive used on signals: | Conditional (NOTE 1) | +| NOTE 1: Required for 3GPP, not required for TISPAN NGN R2 TMGW. | | + +### A.7.5 DigitMap Descriptor + +**Table A.7.5/1: DigitMap Descriptor** + +| | | +|------------------------------|----| +| Digit Maps supported: | No | +|------------------------------|----| + +### A.7.6 Statistics Descriptor + +**Table A.7.6/1: Statistics Descriptor** + +| | | +|-------------------------------------------------|----------------------------------------------| +| Statistics reported on subtract: | No (for TDM Terminations) | +| | Optional For Ephemeral Terminations (NOTE 1) | +| NOTE 1: This is required for TISPAN NGN R2 TMGW | | + +### A.7.7 ObservedEvents Descriptor + +**Table A.7.7/1: Observed Events Descriptor** + +| | | +|----------------------------------------|----| +| Event detection time supported: | No | +|----------------------------------------|----| + +### A.7.8 Topology Descriptor + +**Table A.7.8/1: Topology Descriptor** + +| | | +|-----------------------------------------------------------------|-----------------------------------------------------------------------------| +| Allowed triples: | Optional (NOTE 1) :
(T1, T2, isolate) (T1, T2, oneway) (T1, T2, bothway) | +| NOTE 1: If not supported then error code 444 shall be returned. | | + +### A.7.9 Error Descriptor + +**Table A.7.9/1: Error Codes Sent by MGCF** + +| | | +|---------------------------------------------------|-------------------------------------------------------------------| +| Supported H.248.8 Error Codes: | FFS < list of individual numbers> | +| Supported Error Codes defined in packages: | All error codes defined in supported packages shall be supported. | + +**Table A.7.9/2: Error Codes Sent by MGW:** + +| | | +|---------------------------------------------------|-------------------------------------------------------------------| +| Supported H.248.8 Error Codes: | FFS< list of individual numbers> | +| Supported Error Codes defined in packages: | All error codes defined in supported packages shall be supported. | + +### A.7.10 TerminationState Descriptor + +**Table A.7.10/1: TerminationState Descriptor** + +| | | +|----------------------------------------------|------------------------| +| TerminationState: ServiceStates: | InService/OutOfService | +| TerminationState: EventBufferControl: | OFF | + +## A.8 Command API + +### A.8.1 Add + +**Table A.8.1/1: Descriptors used by Command Add Request** + +| | | +|-----------------------------------------|----------------------------------------------------------------| +| Descriptors used by Add Request: | Events, Signals, Media (LocalControl, Local And Remote), Audit | +|-----------------------------------------|----------------------------------------------------------------| + +**Table A.8.1/2: Descriptors used by Command Add Reply** + +| | | +|---------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Descriptors used by Add Reply: |

Events, Signals, Media (LocalControl, Local And Remote), Error, Audit

When command request excludes an Audit Descriptor, the MGW response shall only include descriptors which contained underspecified or overspecified properties in the command request. Furthermore, only those properties that were underspecified or overspecified in the request shall be sent in the reply. Exceptions to this rule are:

  • - The Error Descriptor
  • - SDP properties returned in "Reserve IMS Connection Point" and "Reserve IMS Connection Point and Configure Remote Resources" procedures, as specified in A.17.2.2 and A.17.2.4
| +|---------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +### A.8.2 Modify + +**Table A.8.2/1: Descriptors used by Command Modify Request** + +| | | +|--------------------------------------------|----------------------------------------------------------------| +| Descriptors used by Modify Request: | Events, Signals, Media (LocalControl, Local And Remote), Audit | +|--------------------------------------------|----------------------------------------------------------------| + +**Table A.8.2/2: Descriptors used by Command Modify Reply** + +| | | +|------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Descriptors used by Modify Reply: |

Events, Signals, Media (LocalControl, Local And Remote), Error, Audit

When command request excludes an Audit Descriptor, the MGW response shall only include descriptors which contained underspecified or overspecified properties in the command request. Furthermore, only those properties that were underspecified or overspecified in the request shall be sent in the reply. Exceptions to this rule are:

  • - The Error Descriptor
  • - SDP properties returned in "Configure IMS Resources" procedure as specified in A.17.2.3.
| +|------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +### A.8.3 Subtract + +**Table A.8.3/1: Descriptor used by Command Subtract Request** + +| | | +|----------------------------------------------|-----------------------| +| Descriptors used by Subtract Request: | AUDIT (empty) or NONE | +|----------------------------------------------|-----------------------| + +**Table A.8.3/2: Descriptor used by Command Subtract Reply** + +| | | +|--------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Descriptors used by Subtract Reply: | None or Statistics

When command request contains "Audit(empty)", then no statistics are returned. Otherwise, connection statistics are returned in the Subtract reply dependent on the supported packages (see clause A.14). | +|--------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +### A.8.4 Move + +**Table A.8.4/1: Command Move** + +| | | +|---------------------------|---------------------------------------------------------| +| Move command used: | Optional(NOTE) | +| NOTE: | If not supported then error code 443 shall be returned. | + +**Table A.8.4/2: Descriptors used by Move Request** + +| | | +|------------------------------------------|----------------------------------------------------------------| +| Descriptors used by Move Request: | Events, Signals, Media (LocalControl, Local And Remote), Audit | +|------------------------------------------|----------------------------------------------------------------| + +**Table A.8.4/3: Descriptors used by Move Reply** + +| | | +|---------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Descriptors used by Move Reply | Events, Signals, Media (LocalControl, Local And Remote), Error, Audit.
When command request excludes an Audit Descriptor, the MGW response shall only include descriptors which contained underspecified or overspecified properties in the command request, with the exception of the Error Descriptor. Furthermore, only those properties that were underspecified or overspecified in the request shall be sent in the reply. | +|---------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +### A.8.5 Auditvalue + +**Table A.8.5/1: Auditvalue** + +| Audited Properties: | Property Name and Identity | Descriptor | +|--------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------| +| Termination ID | TerminationState:
- TDM: ALL (indicating 1 TDM group NOTE3),
individual termination (NOTE 4)
- ATM/IP: individual termination
- Root (MGW Audit) | TerminationState Descriptor | +| Termination ID | MGC information (mgcinfo)
TDM: Individual Termination | LocalControl Descriptor | +| Termination ID | For Packages:
- Root
- TDM/ATM/IP: individual
termination (NOTE1) | Packages Descriptor (NOTE2) | +| Termination ID | None (MGW Audit) :
- Root | Audit (empty) Descriptor | +| Termination ID | SDPCapNeg Extensions:
- sdpe/* | TerminationState Descriptor | +| Audited Statistics: | None | | +| Audited Signals: | None | | +| Audited Events: | None | | +| Packages Audit Possible | Yes | | + +NOTE1: The purpose to audit an individual Termination is to retrieve MGC Information if supported. +NOTE2: Support of this capability is optional. +NOTE3: TDM Group equates to an E1 or T1 PCM System. +NOTE 4: Auditing a single termination of a TDM group is an alternative to the wildcarded audit (TDM: ALL) to derive the service state of the TDM group. All the terminations of the TDM group share the same service state. + +### A.8.6 Auditcapability + +**Table A.8.6/1: Auditcapability** + +| Audited Properties: | Property Name and Identity | Descriptor | +|----------------------------|-----------------------------------|-------------------| +| | FFS | FFS | +| Audited Statistics: | None | | +| Audited Signals: | None | | +| Audited Events: | None | | + +NOTE: AuditCapability command is not supported by the ETSI TISPAN profile. + +### A.8.7 Notify + +**Table A.8.7/1: Descriptors Used Notify** + +| | | +|-----------------------------------------------------|-----------------------------------------------------------| +| Descriptors used by Notify Request or Reply: | ObservedEvents, Error | +| NOTE : | The Error Descriptor shall not be used in Notify Request. | + +### A.8.8 Service Change + +**Table A.8.8/1: Service Change Methods and Reasons Sent By MGCF** + +| ServiceChange Methods supported: | ServiceChange Reasons supported: | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------| +| Restart (NOTE1) | "901 Cold Boot" (Optional)
"902 Warm Boot" (Optional) | +| Handoff (NOTE1, NOTE 2) | "903 MGC Directed Change" (Mandatory) | +| Forced (NOTE1) | "905 Termination Taken Out Of Service" (Optional) | +| Graceful (NOTE1) | "905 Termination Taken Out Of Service" (Optional) | +| NOTE : When a Service Change command on the Root termination with a method other than Graceful is sent, the command shall always be sent as the only command in a message. The sending node shall always wait for the reply to a Service Change command on the Root termination with a method other than Graceful before sending further command requests. A Service Change command on the Root termination with method Graceful may be combined with other commands in a single message.
NOTE 1: ROOT Only.
NOTE 2: Not involving more than 1 MGCF. No support of handoff relates to a network deployment scenario with "primary H.248 systems only", which translates to no geographic redundancy of the MGCF. | | + +**Table A.8.8/2: Service Change Methods and Reasons Sent By MGW** + +| ServiceChange Methods supported: | ServiceChange Reasons supported: | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Restart | "900 Service Restored" (Mandatory)
"901 Cold Boot" (Mandatory) (NOTE1)
"902 Warm Boot" (Mandatory) (NOTE1)
"910 Media Capability Failure " ALL except ROOT (Optional)
"913 Signal Capability Failure " ALL except ROOT (Optional)
"914 Event Capability Failure " ALL except ROOT (Optional)
"916 Packages Change (Optional)
"917 Capability Change (Optional) | +| Graceful | "904 Termination Malfunction" ,ALL except ROOT, (Mandatory)
"905 Termination Taken Out Of Service", (Mandatory)
"906 Loss Of Lower Layer Connectivity" , ALL except ROOT, (Mandatory)
"907 Transmission Failure" ALL except ROOT, (Mandatory)
"908 MG Impending Failure" ROOT only (Mandatory) | +| Forced | "904 Termination Malfunction" ,ALL except ROOT, (Mandatory)
"905 Termination Taken Out Of Service" (Mandatory)
"906 Loss Of Lower Layer Connectivity" ALL except ROOT, (Mandatory)
"907 Transmission Failure" ALL except ROOT, (Mandatory)
"908 MG Impending Failure" ROOT only (Mandatory) | +| Handoff (NOTE1, NOTE 2) | "903 MGC Directed Change" (Mandatory) | +| Disconnected (NOTE1) | "900 Service Restored" (Mandatory)
"916 Packages Change (Optional)
"917 Capability Change (Optional) | +| NOTE : When a Service Change command on the Root termination with a method other than Graceful is sent, the command shall always be sent as the only command in a message. The sending node shall always wait for the reply to a Service Change command on the Root termination with a method other than Graceful before sending further command requests. A Service Change command on the Root termination with method Graceful may be combined with other commands in a single message.
NOTE 1: ROOT Only.
NOTE 2: In response to a MGC Ordered Re-Register. | | + +**Table A.8.8/3: Service Change Address** + +| | | +|-----------------------------------|----| +| ServiceChangeAddress used: | No | +|-----------------------------------|----| + +**Table A.8.8/4: Service Change Delay** + +| | | +|---------------------------------|----| +| ServiceChangeDelay used: | No | +|---------------------------------|----| + +**Table A.8.8/5: Service Change Incomplete Flag** + +| | | +|-----------------------------------------------------------------------|----| +| ServiceChange Incomplete Flag used: | No | +| NOTE: This field requires at least version 3 of the H.248.1 protocol. | | + +**Table A.8.8/6: Service Change Version** + +| | | +|----------------------------------------------|---| +| Version used in ServiceChangeVersion: | 2 | +|----------------------------------------------|---| + +**Table A.8.8/6: Service Change Profile** + +| | | +|----------------------------------------|-----| +| ServiceChangeProfile mandatory: | Yes | +|----------------------------------------|-----| + +**Table A.8.8/8: H.248.18 Profile negotiation** + +| | | +|---------------------------------------------|----| +| Profile negotiation as per H.248.18: | No | +|---------------------------------------------|----| + +### A.8.9 Manipulating and auditing context attributes + +**Table A.8.9/1: Manipulating and auditing context attributes** + +| | | +|----------------------------------------|---------------------------------------------------------------| +| Context Attributes Manipulated: | Topology (Optional) , Emergency Indicator, Priority Indicator | +| Context Attributes Audited: | None | + +## A.9 Generic command syntax and encoding + +**Table A.9/1: Encodings** + +| | | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------| +| Supported Encodings: | Binary (optional) (NOTE 1)
Text (optional) (NOTE 2) :
The receiver shall support:
Short Token Notation
Long Token Notation | +| If binary encoding, is indefinite length encoding supported: | Yes (NOTE3) | +| NOTE 1: For 3GPP Mn interface binary encoding is strongly recommended if only one encoding is selected to ensure interoperability. | | +| NOTE 2: Text encoding is required by TISPAN NGN R2 TMGW. For implementations providing both 3GPP Mn and TISPAN functionality text encoding is required as a minimum. | | +| NOTE3: The binary encoding rules which are applicable to the defined Abstract Syntaxes are the Basic Encoding Rules for Abstract Syntax Notation One, defined in ITU-T Recommendation X.690 [61]. Specifically in accordance with ITU-T Recommendation X.690 [61] section 7.3, alternative encodings based on the definite and indefinite form of length are permitted by the basic encoding rules as a sender's option. Receivers shall support both alternatives. | | + +## A.10 Transactions + +**Table A.10/1: Transactions per Message** + +| | | +|----------------------------------------------------------------------------------------------------------------------|-------------------------| +| Maximum number of TransactionRequests / TransactionReplies / TransResponseAcks / Segment Replies per message: | 2(NOTE 1)
10(NOTE 2) | +| NOTE 1: Maximum required by TISPAN NGN R2 | | +| NOTE 2: Maximum required by 3GPP | | + +**Table A.10/2: Commands per Transaction Requests** + +| | | +|------------------------------------------------------------|----------------------------------| +| Maximum number of commands per Transaction request: | 2(NOTE 1)
Unspecified(NOTE 2) | +| NOTE 1: Maximum required by TISPAN NGN R2 | | +| NOTE 2: Not specified by 3GPP | | + +**Table A.10/3: Commands per Transaction Reply** + +| | | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------| +| Maximum number of commands per Transaction reply: | 2 (NOTE 1)
Unspecified (NOTE 2) | +| NOTE 1: Maximum required by TISPAN NGN R2 | | +| NOTE 2: Not specified by 3GPP however for auditing with wildcarded requests (e.g TDM E1) then the reply may include up to 32 commands to indicate the termination state. | | + +**Table A.10/4: Commands for Wildcarded Responses** + +| | | +|---------------------------------------------------|------------------------------| +| Wildcarded responses may be requested for: | Modify, Subtract, AuditValue | +|---------------------------------------------------|------------------------------| + +**Table A.10/5: Procedures for Wildcarded Responses** + +| | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------| +| Procedures that make use of wildcarded responses: | Release Bearer, Release Termination, Audit Value, Release IMS Termination, Release TDM Termination | +| NOTE: Used when multiple terminations are released with one command and in audit responses where multiple terminations are implied by the audit request. | | + +**Table A.10/6: Optional Commands** + +| | | +|-----------------------------------------------|-----| +| Commands able to be marked "Optional": | ALL | +|-----------------------------------------------|-----| + +**Table A.10/7: Transaction Timers** + +| Transaction Timer: | Value | +|---------------------------------|--------------| +| normalMGExecutionTime | Provisioned | +| normalMGCExecutionTime | Provisioned | +| MGOriginatedPendingLimit | Provisioned | +| MGOriginatedPendingLimit | Provisioned | +| MGProvisionalResponseTimerValue | Provisioned | +| MGProvisionalResponseTimerValue | Provisioned | + +## A.11 Messages + +The MGC/MGW may be named according to the naming structure of the underlying transport protocol which carries the H.248 protocol. + +It is however recommended that MGC and MG names are in the form of fully qualified domain names. For example the domain name of the MGC may be of the form mgc1.whatever.net and the name of the MG may be of the form mg1.whatever.net. + +The "Message Identifier" in the H.248 messages may be used by the MGC and MG to identify the originator of the message. + +## A.12 Transport + +**Table A.12/1: Transport** + +| | | +|-----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------| +| Supported Transports: | SCTP(recommended) (NOTE1).
SCTP/M3UA(optional) optional – as defined in IETF RFC 3332 [24] with options detailed in 3GPP TS 29.202 [25] (NOTE2). | +|-----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------| + +| | | +|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | UDP(optional). | +| NOTE:
NOTE1 | If using SCTP as defined in IETF RFC 2960 [15] the MGW shall always be the node to perform the "Initiation". H.248 is "SCTP user" in this case of H.248/SCTP/IP based transport according ITU-T Rec. H.248.4 [38]. The number of used SCTP Streams for traffic of the H.248 Control Association must be defined, see § 8/H.248.4 [38]. A single SCTP Stream is the default assumption ("Single-Stream Mode") in this Profile. | +| NOTE2 | This is slightly different with regards to SCTP encapsulation. H.248 is "M3UA user" in this case of H.248/M3UA/SCTP/IP based transport. H.248 Messages are corresponding to M3UA user protocol data units. "SCTP multistreaming" may be also applied (see § 1.4.7/RFC 3332). If not then the complete M3UA traffic is mapped on a single SCTP Stream, i.e., the Single-Stream Mode. | +| NOTE3 | Checksum calculation for SCTP shall be supported as specified in RFC 3309 [43] instead of the method specified in RFC 2960 [15]. | + +**Table A.12/2: Segmentation** + +| | | +|--------------------------------|-----------------------------------------------------------------| +| Segmentation Supported: | No | +| NOTE: | This field requires at least version 3 of the H.248.1 protocol. | + +**Table A.12/3: Support of Control Association Monitoring** + +| | | +|----------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Control Association Monitoring Supported: | Monitoring mechanism is dependent on used H.248 transport (see Table A.12/1):

SCTP: inherent capability of SCTP (NOTE 1)

SCTP/M3UA: inherent capability of SCTP

UDP:
  1. H.248.14 (MGW-driven monitoring)
  2. Empty AuditValue on ROOT (MGC-driven monitoring)
| +| NOTE 1: Use of H.248.14 [29] for this is FFS | | + +## A.13 Security + +**Table A.13/1: Security** + +| | | +|----------------------------|------| +| Supported Security: | None | +|----------------------------|------| + +## A.14 Packages + +**Table A.14/1: Mandatory packages** + +| Package Name | Package ID | Version | +|---------------------------------------------------------------------------------|-------------------|---------| +| Generic (see ITU-T Recommendation H.248.1 [9] Annex E.1); | g, (0x0001) | v1 | +| Base Root Package (see ITU-T Recommendation H.248.1 [9] Annex E.2); | root, (0x0002) | v2 | +| Basic Continuity Package (see ITU-T Recommendation H.248.1 [9] Annex E.10); | ct, (0x000a) | v1 | +| TDM Circuit Package (see ITU-T Recommendation H.248.1 [9] Annex E.13); | tdmc, (0x000d) | v1 | +| Hanging Termination Detection package (see ITU-T Recommendation H.248.36 [27]). | hangterm (0x0098) | v1 | + +###### **Table A.14/2: Optional packages** + +| Package Name | Package ID | Version | Support dependent on: | +|------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| Tone Detection Package (see ITU-T Recommendation H.248.1 [9] Annex E.4); | tonedet, (0x0004)
This package is "extension only". It must be supported if extended but shall not be published over the protocol. It is here for information only. | v1 | Mandatory for 3GPP | +| Basic DTMF Generator Package (see ITU-T Recommendation H.248.1 [9] Annex E.5); | dg, (0x0005) | v1 | Mandatory for 3GPP | +| DTMF Detection Package (see ITU-T Recommendation H.248.1 [9] Annex E.6); | dd, (0x0006) | v1 | Mandatory for 3GPP | +| Media Gateway Resource Congestion Handling Package (see ITU-T Recommendation H.248.10 [12]). | chp, (0x0029) | v1 | Mandatory for 3GPP | +| Generic Announcement Package (see ITU-T Recommendation H.248.7 [26]). Only Fixed Part is required. | an(0x001d) | v1 | 3GPP applications | +| Bearer Characteristics Package (see ITU-T Recommendation Q.1950 [14] annex A.3). | bcp (0x001e) | v2 | Terminations Towards BICC | +| Generic Bearer Connection Package (see ITU-T Recommendation Q.1950 [14] annex A.6). | Gb, (0x0021) | v1 | Interworking with BICC | +| Tone Generator Package (see ITU-T Recommendation H.248.1 [9] Annex E.3); | tongen, (0x0003) | v1 | This package is "extension only". It must be supported if extended but shall not be published over the protocol. It is here for information only. | +| Call Progress Tones Generator Package (see ITU-T Recommendation H.248.1 [9] annex E.7). | Cg, (0x0007) | v1 | | +| Basic Call Progress Tones Generator with Directionality, (see ITU-T Recommendation Q.1950 [14] annex A.8). | bcg, (0x0023) | v1 | Services provided by network | +| Expanded Call Progress tones Generator Package (see ITU-T Recommendation Q.1950 [14] annex A.9). | xcg, (0x0024) | v1 | Services provided by network | +| Basic Services Tones Generation Package, (see ITU-T Recommendation Q.1950 [14] annex A.10). | srvtn, (0x0025) | v1 | Services provided by network | +| Bearer Control Tunnelling Package (see ITU-T Recommendation Q.1950 [14] annex A.7). | Bt, (0x0022) | v1 | Interworking with BICC and IP transport | +| Expanded Services Tones Generation Package (see ITU-T Recommendation Q.1950 [14] annex A.11). | xsrvtn, (0x0026) | v1 | Services provided by network | +| Intrusion Tones Generation Package (see ITU-T Recommendation Q.1950 [14] annex A.12). | Int, (0x0027) | v1 | Services provided by network | +| 3GUP package (see subclause 15.1.1 of 3GPP TS 29.232 [5]) | threegup, (0x002f) | v1 | Interworking with BICN PLMN | +| Modification of Link Characteristics Bearer Capability (see subclause 15.1.5 of 3GPP TS 29.232 [5]) | threegmlc, (0x0046) | v1 | Interworking with BICN PLMN with Codec Modification | +| Inactivity timer package (see ITU-T Recommendation H.248.14 [29]) | it, (0x0045) | v1 | Only applicable for UDP transport. | +| TFO package (see subclause 15.2.2 of 3GPP TS 29.232 [5]) | threegtfoc, (0x0031) | v2 | | +| Media Gateway Overload Control Package (see ITU-T Recommendation H.248.11 [28]). | ocp, (0x0051) | v1 | | + +| | | | | +|----------------------------------------------------------------------------------------------------|---------------------|----|---------------------------------------------------------------------------------------------------------------------------------------------------------| +| MGC Information Package (see ITU-T Recommendation H.248.45 [30]) | mgcinfo, (0x00a0) | v1 | This package may be supported as an operator option. For this Profile the information string shall be limited to 32 octets in length. | +| RTP (ITU-T Recommendation H248.1 [9] Annex E.12) (NOTE 1) | rtp, (0x000c) | v1 | Used for connection statistics | +| H324 package (see ITU-T Recommendation H.248.12 [41]) | h324, (0x002c) | v1 | Multimedia calls | +| H.245 Transport Package (see ITU-T Recommendation H.248.12a2 [42]) | h245tp, (0x00b4) | v1 | Multimedia calls | +| IP Domain connection package (see ITU-T Recommendation H.248.41 [44]) | ipdc, (0x009d) | v1 | Multiple IP realms supported | +| H.245 Transport Package for SPC use (see ITU-T Recommendation H.248.72 [46] subclause 6) | h245tpspc, (0x00f7) | v1 | Multimedia calls with MONA | +| MONA preference package (see ITU-T Recommendation H.248.72 [46] subclause 7) | monapref, (0x00f8) | v1 | Multimedia calls with MONA | +| 3G Interface Type package (see subclause 15.2.11 of 3GPP TS 29.232 [5]) | threegint (0x00e3) | v1 | | +| RTCP Feedback Message package (see ITU-T Recommendation H.248.71 [49] subclause 8) | rtcpfb, (0x00f6) | v1 | Multimedia interworking between the H.245 messages in 3G-324M at the CS side and the corresponding RTCP messages used by MTSI terminals at the IMS side | +| Explicit Congestion Notification for RTP-over-UDP Support (see ITU-T Recommendation H.248.82 [66]) | ecnrous(0x010b) | v1 | Support of ECN feature | +| Diffserv (ITU-T Recommendation H.248.52 [64]) | ds, (0x008b) | v2 | Support of MPS | +| MG Act-as STUN Server (ITU-T Recommendation H.248.50 [67]) | mgastuns (0x00c2) | v1 | Support of incoming STUN connectivity checks. Applicable for ICE lite and full ICE | +| Originate STUN Continuity Check (see ITU-T Recommendation H.248.50 [67]) | ostuncc (0x00c3) | v1 | Support of originating STUN connectivity checks Only applicable for full ICE | +| Enhanced Revised Offer/Answer SDP Support ([ITU-T Recommendation H.248.80 [71]) | eroas, (0x0109) | v1 | Support of the SDP Capability Negotiation syntax | + +NOTE 1: support of RTP Package does not require support of Network Package. + +**Table A.14/3: Package Provisioning Information** + +| Package Name | Property, Parameter, Signal, Event ID | Provisioned Value: | +|--------------------------------------------------------------|---------------------------------------|--------------------| +| Generic Announcement (see ITU-T Recommendation H.248.7 [26]) | Fixed Announcement Play, AV | Provisioned | +| NOTE: This may not be required by TISPAN NGN R2 TMGW. | | | + +### A.14.1 Generic Package + +Table A.14.1/1: Package Usage Information For Generic Package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | +|------------------------------------------|--------------------------------------|---------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------| +| None | - | - | - | - | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | +| None | - | - | - | - | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | +| | - | - | - | - | +| Events | Mandatory/Optional | Used in command: | | | +| Cause (g/cause. 0x0001/0x0001) (NOTE) | M | ADD, MOD, NOTIFY | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | None | - | - | - | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | Generalcause | M | "NR" Normal Release (0x0001)
"UR" Unavailable Resources (0x0002)
"FT" Failure, Temporary (0x0003)
"FP" Failure, Permanent (0x0004)
"IW" Interworking Error (0x0005)
"UN" Unsupported (0x0006) | Not Applicable | +| | Failure Cause (FailureCause, 0x0002) | O | Octet String | Not Applicable | +| Events | Mandatory/Optional | Used in command: | | | +| Signal Completion. (g/sc, 0x0001/0x0002) | M | ADD, MOD, MOVE, NOTIFY | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | None | - | - | - | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | Signal Identity | M | pkgdName syntax | - | +| | Termination Method | M | "TO" (0x0001) Signal timed out or otherwise completed on its own
"EV" (0x0002) Interrupted by event
"SD" (0x0003) Halted by new Signals descriptor
"NC" (0x0004) Not completed, other cause | - | +| | Signal List Id | O | Integer | - | + +| Statistics | Mandatory/ Optional | Used in command: | Supported Values: | +|--------------------|----------------------------|------------------|-------------------| +| None | - | - | - | +| Error Codes | Mandatory/ Optional | | | +| - | - | | | + +NOTE: This event may also be used to report temporary errors in the MGW for both IMS, BICC and TDM connections where the termination is not out of service and thus sending a Service Change is inappropriate. On receipt of this event, the MGC is expected to release the connection in the MGW and force release the associated call. An example of such an error could be loss of RTP on an IMS termination. + +### A.14.2 Base Root Package + +**Table A.14.2/1: Package Usage Information For Base Root Package** + +| Properties | Mandatory/ Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|---------------------------------------|----------------------------|---------------------|-------------------------------------------------|-----------------------------|--|--| +| root/maxNumberOfContexts | O | AuditValue | 1 and up | Implementation on Specific | | | +| root/maxTerminationPerContext | O | AuditValue | See A.4 | Implementation on Specific | | | +| root/normalMGExecutionTime | O | MOD | Integer | Operator Defined | | | +| root/normalMGCExecutionTime | O | MOD | Integer | Operator Defined | | | +| root/MGProvisionalResponseTimerValue | O | MOD | Integer(NormalMGExecutionTime + networkdelay) | Operator Defined | | | +| root/MGCProvisionalResponseTimerValue | O | MOD | Integer( NormalMGCExecutionTime + networkdelay) | Operator Defined | | | +| root/MGCOriginatedPendingLimit | O | MOD | Integer | Operator Defined | | | +| root/MGOriginatedPendingLimit | O | MOD | Integer | Operator Defined | | | +| Signals | Mandatory/ Optional | Used in command: | | Duration Provisioned Value: | | | +| None | - | - | | - | | | +| | Signal Parameters | Mandatory/ Optional | Supported Values: | Duration Provisioned Value: | | | +| | - | - | - | - | | | +| Events | Mandatory/ Optional | Used in command: | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| Statistics | Mandatory/ Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +NOTE : All transaction timers specified in H.248 shall be supported for 3GPP + +### A.14.3 Basic DTMF Generator Package + +Table A.14.3/1: Package Usage Information For Basic DTMF Generator Package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|-----------------------------------------------------------------------------------------------|---------------------------------|---------------------------|--------------------------|------------------------------------|--|--| +| None | - | - | - | - | | | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | | | +| DTMF character 0
.d0 | M | ADD, MOD, MOVE | | | | | +| DTMF character 1
.d1 | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | | | +| DTMF character 2
.d2 | None | - | - | - | | | +| DTMF character 3
.d3 | | | | | | | +| DTMF character 4
.d4 | | | | | | | +| DTMF character 5
.d5 | | | | | | | +| DTMF character 6
.d6 | | | | | | | +| DTMF character 7
.d7 | | | | | | | +| DTMF character 8
.d8 | | | | | | | +| DTMF character 9
.d9 | | | | | | | +| DTMF character *
.ds | | | | | | | +| DTMF character #
.do | | | | | | | +| DTMF character A
.da | | | | | | | +| DTMF character B
.db | | | | | | | +| DTMF character C
.dc | | | | | | | +| DTMF character D
.dd | | | | | | | +| Events | Mandatory/Optional | Used in command: | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| Statistics | Mandatory/Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | +| NOTE: Only the DTMF Signal Ids shall be used, not the Tone Ids within the PlayTone Signal Id. | | | | | | | + +### A.14.4 Basic DTMF Detection Package + +Table A.14.4/1: Package Usage Information For Basic DTMF Generator Package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------|--------------------|-------------------|-----------------------------| +| None | - | - | - | - | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | +| None | - | - | - | - | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | +| | - | - | - | - | +| Events | Mandatory/Optional | Used in command: | | | +| d0, "0"
d1, "1"
d2, "2"
d3, "3"
d4, "4"
d5, "5"
d6, "6"
d7, "7"
d8, "8"
d9, "9"
ds, "*"
do, "#"
da, "A" or "a"
db, "B" or "b"
dc, "C" or "c"
dd, "D" or "d" | M | ADD, MOD, NOTIFY | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | None | - | - | - | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | None | - | - | - | +| Statistics | Mandatory/Optional | Used in command: | | Supported Values: | +| None | - | - | - | - | +| Error Codes | Mandatory/Optional | | | | +| None | - | | | | + +### A.14.5 TDM Circuit Package + +Table A.14.5/1: Package Usage Information For TDM Circuit Package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | +|----------------------------|--------------------------|--------------------|-------------------|-----------------------------| +| Echo Cancellation, tdmc/ec | M | ADD, MOD, MOVE | ALL | Default= Off (False) | +| Gain Control, tdmc/gc | Not Used | - | - | - | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | +| None | - | - | - | - | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | +| | - | - | - | - | +| Events | Mandatory/Optional | Used in command: | | | +| None | - | - | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | - | - | - | - | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | - | - | - | - | + +| Statistics | Mandatory/ Optional | Used in command: | Supported Values: | +|--------------------|----------------------------|------------------|-------------------| +| None | - | - | - | +| Error Codes | Mandatory/ Optional | | | +| None | - | | | + +### A.14.6 MGW Congestion Package + +Table A.14.6/1: Package Usage Information For Media Gateway Overload Control Package + +| Properties | Mandatory/ Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|----------------------------------|---------------------------------|----------------------------|--------------------------|------------------------------------|--|--| +| None | - | - | - | - | | | +| Signals | Mandatory/ Optional | Used in command: | | Duration Provisioned Value: | | | +| None | - | - | - | - | | | +| | Signal Parameters | Mandatory/ Optional | Supported Values: | Duration Provisioned Value: | | | +| | - | - | - | - | | | +| Events | Mandatory/ Optional | Used in command: | | | | | +| MG Congestion, chp/mgcon(0x0001) | M/ | MOD, NOTIFY | | | | | +| | Event Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | None | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | Reduction (0x0001) | M | 0-100 | Not Applicable | | | +| Statistics | Mandatory/ Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +### A.14.7 Continuity Package + +Table A.14.7.1: Package Usage Information For Basic Continuity Package + +| Properties | Mandatory/ Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|----------------------------------------|---------------------------------|----------------------------|--------------------------|------------------------------------|--|--| +| None | - | - | - | - | | | +| Signals | Mandatory/ Optional | Used in command: | | Duration Provisioned Value: | | | +| Continuity Test, ct/ct Respond, ct/rsp | M | ADD, MOD, MOVE | | Default | | | +| | Signal Parameters | Mandatory/ Optional | Supported Values: | Duration Provisioned Value: | | | +| | None | - | - | - | | | +| Events | Mandatory/ Optional | Used in command: | | | | | +| Completion, ct/cmp(0x0005) | M/ | ADD, MOD, MOVE, NOTIFY | | | | | +| | Event Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | None | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | result, res(0x0008) | M | success, failure | Not Applicable | | | +| Statistics | Mandatory/ Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +### A.14.8 Announcement Package + +Table A.14.8/1: Package Usage Information For Announcement Package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | +|--------------------------------------|------------------------------------|---------------------------|--------------------------|------------------------------------| +| None | - | - | - | - | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | +| Fixed Announcement Play, apf(0x0001) | M | ADD, MOD, MOVE | | | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | +| | Announcement name, an(0x0001) | M | enumeration | | +| | Number Of Cycles, noc(0x0002) | M | Any Integer | - | +| | Announcement Variant, av(0x0003) | O | string | - | +| None | Announcement Direction, di(0x0004) | M | Internal, External | - | +| | Mandatory/Optional | Used in command: | | | +| | - | - | - | - | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | - | - | - | - | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | - | - | - | - | +| Statistics | Mandatory/Optional | Used in command: | | Supported Values: | +| None | - | - | - | - | +| Error Codes | Mandatory/ Optional | | | | +| None | - | | | | + +### A.14.9 Bearer Characteristics Package + +Table A.14.9/1: Package Usage Information For Bearer Characteristics Package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | +|-----------------------------------------------|---------------------------------|---------------------------|--------------------------|------------------------------------| +| BNC Characteristics (BCP/BNCChar,0x001e/0x01) | M | ADD | AAL type 2 / IP/RTP | Not Applicable | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | +| None | - | - | - | - | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | +| | - | - | - | - | +| Events | Mandatory/Optional | Used in command: | | | +| None | - | - | - | - | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | - | - | - | - | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | - | - | - | - | +| Statistics | Mandatory/Optional | Used in command: | | Supported Values: | +| None | - | - | - | - | +| Error Codes | Mandatory/ Optional | | | | +| None | - | | | | + +### A.14.10 Generic Bearer Connection Package + +Table A.14.10/1: Package Usage Information For Generic Bearer Connection Package + +| Properties | Mandatory/ Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|------------------------------------------|---------------------------------------|----------------------------|-----------------------------------------------------------------------------------------------------------------------------|------------------------------------|--|--| +| None | - | - | - | - | | | +| Signals | Mandatory/ Optional | Used in command: | | Duration Provisioned Value: | | | +| Establish BNC
(GB/EstBNC,0x0021/0x01) | M | ADD, MOD | | Not Applicable | | | +| | Signal Parameters | Mandatory/ Optional | Supported Values: | Duration Provisioned Value: | | | +| | Not Applicable | - | - | Not Applicable | | | +| Modify BNC
(GB/ModBNC,0x0021/0x02) | O | MOD | | Not Applicable | | | +| | Signal Parameters | Mandatory/ Optional | Supported Values: | Duration Provisioned Value: | | | +| | Not Applicable | - | - | Not Applicable | | | +| Release BNC
(GB/RelBNC,0x0021/0x03) | M (NOTE 1) | MOD | | Not Applicable | | | +| | Signal Parameters | Mandatory/ Optional | Supported Values: | Duration Provisioned Value: | | | +| | General cause
(Generalcause,0x01 ) | O | Normal Release/
Unavailable Resources/
Failure Temporary/
Failure Permanent/
Interworking Error/
Unsupported | Not Applicable | | | +| | Failure Cause
(Failurecause,0x02) | O | OCTET STRING | Not Applicable | | | +| | Reset (Reset,0x03) | O | 0/ 1 | Not Applicable | | | +| Events | Mandatory/ Optional | Used in command: | | | | | +| BNC Change
(GB/BNCChange,0x0021/0x01) | M | ADD, MOD, NOTIFY | | | | | +| | Event Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | Type (Type ,0x01) | M | Bearer Established /
Bearer Modified/
Bearer Modification
Failure | Not Applicable | | | +| | ObservedEvent Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | Type (Type,0x01) | M/ | Bearer Established /
Bearer Modified/
Bearer Modification
Failure | Not Applicable | | | +| Statistics | Mandatory/ Optional | Used in command: | | Supported Values: | | | +| None | | | | | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | | | | | | | + +NOTE 1: Mandatory for BICC ATM Terminations, not used otherwise + +### A.14.11 Call Progress Tones Generator Package v1 + +Table A.14.11/1: Package Usage Information For Call Progress Tones Generator Package + +| Properties | Mandatory/ Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|------------------------|---------------------------------|----------------------------|--------------------------|------------------------------------|--|--| +| None | - | - | - | - | | | +| Signals | Mandatory/ Optional | Used in command: | | Duration Provisioned Value: | | | +| Ringing Tone, cg/rt | M | ADD, MOD, MOVE | | Not Applicable | | | +| | Signal Parameters | Mandatory/ Optional | Supported Values: | Duration Provisioned Value: | | | +| | - | - | - | - | | | +| Busy Tone, cg/bt | O | ADD, MOD, MOVE | | Not Applicable | | | +| | Signal Parameters | Mandatory/ Optional | Supported Values: | Duration Provisioned Value: | | | +| | - | - | - | - | | | +| Congestion Tone, cg/ct | O | ADD, MOD, MOVE | | Not Applicable | | | +| | Signal Parameters | Mandatory/ Optional | Supported Values: | Duration Provisioned Value: | | | +| | - | - | - | - | | | +| | - | - | - | - | | | +| Events | Mandatory/ Optional | Used in command: | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| Statistics | Mandatory/ Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +### A.14.12 Basic Call Progress Tones Generator with Directionality + +Table A.14.12/1: Package Usage Information For Basic Call Progress Tones Generator with Directionality Package + +| Properties | Mandatory/ Optional | Used in command: | Supported Values: | Provisioned Value: | +|------------------------------------|----------------------------|----------------------------|--------------------------|------------------------------------| +| None | - | - | - | - | +| Signals | Mandatory/ Optional | Used in command: | | Duration Provisioned Value: | +| Dial Tone (bcg/bdt, 0x0023/0x0040) | O | ADD, MOD, MOVE | | Value | +| | Signal Parameters | Mandatory/ Optional | Supported Values: | Duration Provisioned Value: | + +| | | | | | | | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------|--------------------------------|------------------------------|---------------------------|--|--| +| Ringing Tone
(bcg/brt,0x0023/0x0041)
Busy Tone
(bcg/bbt,0x0023/0x0042)
Congestion Tone
(bcg/bct,0x0023/0x0043)
Special Information Tone
(bcg/bsit,0x0023/0x0044)
Warning Tone
(bcg/bwt,0x0023/0x0045)
Payphone Recognition
Tone
(bcg/bpt,0x0023/0x0046)
Call Waiting Tone
(bcg/bcw,0x0023/0x0047)
Caller Waiting Tone
(bcg/bcr,0x0023/0x0048)
Pay Tone (bcg/bpy,
0x0023/0x0049) | Tone Direction
(btd, 0x0001) | M | Internal / External | Default=External | | | +| Events | Mandatory/
Optional
| Used in command: | | | | | +| None | - | - | - | - | | | +| | Event
Parameters
| Mandatory/
Optional
| Supported
Values:
| Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent
Parameters
| Mandatory/
Optional
| Supported
Values:
| Provisioned Value: | | | +| Statistics | Mandatory/
Optional
| Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +### A.14.13 Expanded Call Progress Tones Generator Package + +Table A.14.13/1: Package Usage Information For Expanded Call Progress Tones Generator Package + +| Properties | Mandatory/
Optional
| Used in
command:
| Supported
Values:
| Provisioned Value: | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------|--------------------------------|------------------------------|----------------------------------------| +| None | - | - | - | - | +| Signals | Mandatory/
Optional
| Used in command: | | Duration Provisioned
Value:
| +| Comfort Tone
(xcg/cmft,0x0024/0x004a)
Off-hook warning Tone
(xcg/roh, 0x0024/0x004b)
Negative
Acknowledgement
(xcg/nack,0x0024/0x004c)
Vacant Number Tone
(xcg/vac, 0x0024/0x004d)
Special Conditions Dial
Tone
(xcg/spec,0x0024/0x004e
) | O | ADD, MOD, MOVE | | Value | +| | Signal
Parameters
| Mandatory/
Optional
| Supported
Values:
| Duration Provisioned
Value:
| +| | Tone Direction
(btd, 0x0001) | M | Internal / External | Default=External | +| Events | Mandatory/
Optional
| Used in command: | | | +| None | - | - | - | - | +| | Event
Parameters
| Mandatory/
Optional
| Supported
Values:
| Provisioned Value: | +| | - | - | - | - | +| | ObservedEvent
Parameters
| Mandatory/
Optional
| Supported
Values:
| Provisioned Value: | +| | - | - | - | - | + +| Statistics | Mandatory/Optional | Used in command: | Supported Values: | +|--------------------|----------------------------|------------------|-------------------| +| None | - | - | - | +| Error Codes | Mandatory/ Optional | | | +| None | - | | | + +### A.14.14 Basic Services Tones Generation Package + +Table A.14.14/1: Package Usage Information For Basic Services Tones Generation Package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------|---------------------------|--------------------------|------------------------------------|--|--| +| None | - | - | - | - | | | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | | | +| Recall Dial Tone (srvtn/rdt,0x0025/0x004f)
Confirmation Tone (srvtn/conf,0x0025/0x0050)
Held Tone (srvtn/ht,0x0025/0x0051)
Message Waiting Tone (srvtn/mwt,0x0025/0x0052) | O | ADD, MOD, MOVE | | Value | | | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | | | +| | Tone Direction (btd, 0x0001) | M | Internal / External | Default=External | | | +| Events | Mandatory/Optional | Used in command: | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| Statistics | Mandatory/Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +### A.14.15 Bearer Control Tunnelling Package + +Table A.14.15/1: Package Usage Information For Bearer Control Tunnelling Package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | +|----------------------------------------------------|-----------------------------------------|---------------------------|--------------------------|------------------------------------| +| Tunneling Options (BT/TunOpt, 0x0022/0x01) | M | ADD, MOD | 1 /2 | Not Applicable | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | +| Bearer Information Transport (BT/BIT, 0x0022/0x01) | M | ADD, MOD | | Not Applicable | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | +| | Bearer Information Tunnel (BIT,0x01) | M | Octet String | Not Applicable | +| Events | Mandatory/Optional | Used in command: | | | +| Tunnel Indication (BT/TIND, 0x0022/0x01) | M | ADD, MOD, NOTIFY | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | Not applicable | - | - | - | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | Bearer Information transport (BIT,0x01) | M | Octet String | Not Applicable | + +| Statistics | Mandatory/ Optional | Used in command: | Supported Values: | +|--------------------|----------------------------|------------------|-------------------| +| None | - | - | - | +| Error Codes | Mandatory/ Optional | | | +| None | - | | | + +### A.14.16 Expanded Services Tones Generation Package + +Table A.14.16/1: Package Usage Information For Expanded Services Tones Generation Package + +| Properties | Mandatory/ Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------|----------------------------|--------------------------|------------------------------------|--|--| +| None | - | - | - | - | | | +| Signals | Mandatory/ Optional | Used in command: | | Duration Provisioned Value: | | | +| Call Transfer Dial Tone (xsvrtn/xferdt,0x0026/0x0053)
Call Forward Tone (xsvrtn/cft,0x0026/0x0054)
Credit Card service Tone (xsvrtn/ccst,0x0026/0x0055)
Special Recall Dial Tone (xsvrtn/srdt,0x0026/0x0056) | O | ADD, MOD, MOVE | | Value | | | +| | Signal Parameters | Mandatory/ Optional | Supported Values: | Duration Provisioned Value: | | | +| | Tone Direction (btd, 0x0001) | M | Internal / External | Default=External | | | +| Events | Mandatory/ Optional | Used in command: | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| Statistics | Mandatory/ Optional | Used in command: | Supported Values: | | | | +| None | | - | - | | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +### A.14.17 Intrusion Tones Generation Package + +Table A.14.17/1: Package Usage Information For Intrusion Tones Generation Package + +| Properties | Mandatory/ Optional | Used in command: | Supported Values: | Provisioned Value: | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|----------------------------|--------------------------|------------------------------------| +| None | - | - | - | - | +| Signals | Mandatory/ Optional | Used in command: | | Duration Provisioned Value: | +| Intrusion Pending Tone (int/pend,0x0027/0x0057)
Intrusion Tone (int/int,0x0027/0x0058)
Intrusion Reminder Tone (int/rem,0x0027/0x0059)
Toll Break-In Tone (int/tbi,0x0027/0x005a)
Intrusion Queue Tone (int/intque,0x0027/0x005b)
Busy Verification Tone (int/bv,0x0027/0x005c) | O | ADD, MOD, MOVE | | Value | +| | Signal Parameters | Mandatory/ Optional | Supported Values: | Duration Provisioned Value: | +| | Tone Direction (btd, 0x0001) | M | Internal / External | Default=External | + +| Events | Mandatory/Optional | Used in command: | | | | | +|-------------|--------------------------|--------------------|-------------------|--------------------|--|--| +| None | - | - | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| Statistics | Mandatory/Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +### A.14.18 3GUP Package + +Table A.14.18/1: Package Usage Information For 3GUP Package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|---------------------------------------------------------------|--------------------------|--------------------|--------------------|-----------------------------|--|--| +| UP Mode of operation (threegup/mode, 0x002f/0x0001) | M | ADD, MOD, MOVE | See 3GPP TS 29.232 | See 3GPP TS 29.232 | | | +| UP versions (threegup/upversions, 0x002f/0x0002) | M | ADD, MOD, MOVE | See 3GPP TS 29.232 | See 3GPP TS 29.232 | | | +| Delivery of erroneous SDUs (threegup/delerrsd, 0x002f/0x0003) | M | ADD, MOD, MOVE | See 3GPP TS 29.232 | See 3GPP TS 29.232 | | | +| Interface (threegup/interface, 0x002f/0x0004) | M | ADD, MOD, MOVE | See 3GPP TS 29.232 | See 3GPP TS 29.232 | | | +| Initialisation Direction (threegup/initdir, 0x002f/0x0005) | M | ADD, MOD, MOVE | See 3GPP TS 29.232 | See 3GPP TS 29.232 | | | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | | | +| None | - | - | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | | | +| | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command: | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| Statistics | Mandatory/Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +### A.14.19 Modification of Link Characteristics Bearer Capability + +Table A.14.19/1: Package Usage Information For Modification of Link Characteristics Package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | +|------------------------------------------------------------------------------|---------------------------------|---------------------------|--------------------------|------------------------------------| +| None | - | - | - | - | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | +| None | - | - | - | - | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | +| | - | - | - | - | +| Events | Mandatory/Optional | Used in command: | | | +| Bearer Modification Support Event. ( threegmlc/mod_link_supp, 0x0046/0x0001) | M | ADD, MOD, NOTIFY | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | None | - | - | - | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | None | - | - | - | +| Statistics | Mandatory/Optional | Used in command: | | Supported Values: | +| None | - | - | - | - | +| Error Codes | Mandatory/ Optional | | | | +| None | - | | | | + +### A.14.20 Hanging Termination Detection Package + +Table A.14.20/1: Package Usage Information For Hanging Termination Detection Package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | +|-----------------------|---------------------------------|------------------------------------|--------------------------|------------------------------------| +| None | - | - | - | - | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | +| None | - | - | - | - | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | +| | - | - | - | - | +| Events | Mandatory/Optional | Used in command: | | | +| Termination Heartbeat | M | ADD, MOD, MOVE, AUDITVALUE, NOTIFY | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | Timer X | M | ALL | 0 (no heartbeat message) | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | - | - | - | - | +| Statistics | Mandatory/Optional | Used in command: | | Supported Values: | +| None | - | - | - | - | +| Error Codes | Mandatory/ Optional | | | | +| | - | | | | + +### A.14.21 TFO package + +Table A.14.21/1: Package Usage Information For TFO + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | +|--------------------------------------------------------------------|---------------------------------|---------------------------|--------------------------|------------------------------------| +| TFO Activity Control (threegtfoc /tfoenable, (0x0031/0x0001)) | M | ADD, MOD, MOVE | See 3GPP TS 29.232 | See 3GPP TS 29.232 | +| TFO Codec List (threegtfoc /codeclist, (0x0031/0x0002)) | M | ADD, MOD, MOVE | See 3GPP TS 29.232 | See 3GPP TS 29.232 | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | +| None | | | | | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | +| | | | | | +| Events | Mandatory/Optional | Used in command: | | | +| Optimal Codec Event (threegtfoc /codec_modify, (0x0031/0x0010)) | O | ADD, MOD, MOVE, NOTIFY | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | None | | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| Codec List Event (threegtfoc /distant_codec_list, (0x0031/0x0012)) | O | ADD, MOD, MOVE, NOTIFY | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | None | | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| TFO Status Event (threegtfoc /TFO_status) (0x0031/0x0014) | O | ADD, MOD, MOVE, NOTIFY | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | None | | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| Statistics | Mandatory/Optional | Used in command: | | Supported Values: | +| None | | | | | +| Error Codes | Mandatory/ Optional | | | | +| | | | | | + +### A.14.22 Media Gateway Overload Control Package + +Table A.14.22/1: Media Gateway Overload Control Package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | +|----------------|---------------------------|---------------------------|--------------------------|------------------------------------| +| None | - | - | - | - | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | +| None | | | | | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | + +| | | | | | | | +|--------------------------------|---------------------------------|---------------------------|--------------------------|---------------------------|--|--| +| | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command: | | | | | +| MG_Overload
ocp/mg_overload | M | MOD, NOTIFY | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | None | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | None | - | - | - | | | +| Statistics | Mandatory/Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +### A.14.23 Inactivity Timer Package + +Table A.14.23/1: Inactivity Timer Package + +| | | | | | | | +|-------------------------------|---------------------------------|---------------------------|--------------------------|-------------------------------------------------------|--|--| +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | | | +| None | - | - | - | - | | | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | | | +| None | - | - | - | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | | | +| | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command: | | | | | +| Inactivity Timeout,
it/ito | M | MOD, NOTIFY | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | Maximum Inactivity Time,
mit | M | Any integer | Unspecified, if not sent a value must be provisioned. | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | None | - | - | - | | | +| Statistics | Mandatory/Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +### A.14.24 MGC Information Package + +Table A.14.24/1: MGC Information Package + +| | | | | | +|---------------------------|---------------------------|---------------------------|---------------------------|------------------------------------| +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | +| Data Block,
MGCInfo/db | M | ADD, MOD,
AUDITVALUE | A range of 0 to 32 octets | An empty string | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | +| None | - | - | - | - | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | +| | - | - | - | - | + +| Events | Mandatory/Optional | Used in command: | | | | | +|-------------|--------------------------|--------------------|-------------------|--------------------|--|--| +| None | - | - | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| Statistics | Mandatory/Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +### A.14.25 RTP Package + +Table A.14.25/1: RTP Package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|---------------------------------|---------------------------|--------------------|-----------------------|-----------------------------|--|--| +| None | - | - | - | - | | | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | | | +| None | - | - | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | | | +| | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command: | | | | | +| Payload Transition, rtp/pltrans | - | NA | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | 📋 1 None | 📋 2 - | 📋 3 - | 📋 4 - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | 📋 5 rtpplayload, rtpltype | 📋 6 - | A valid encoding name | - | | | +| Statistics | Mandatory/Optional | Used in command: | | Supported Values: | | | +| Packets Sent, rtp/ps | M | SUBTRACT REPLY | | ALL | | | +| Packets Received, rtp/pr | M | SUBTRACT REPLY | | ALL | | | +| Packet Loss, rtp/pl | M | SUBTRACT REPLY | | ALL | | | +| Jitter, rtp/jit | M | SUBTRACT REPLY | | ALL | | | +| Delay, rtp/delay | M | SUBTRACT REPLY | | ALL | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +### A.14.26 Tone Generator Package + +Table A.14.26/1: Package Usage Information For Tone Generator Package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | +|------------|--------------------|------------------|-------------------|--------------------| +| None | - | - | - | - | + +| Signals | Mandatory/ Optional | Used in command: | | Duration Provisioned Value: | | | +|-----------------------------------------|--------------------------|---------------------|-------------------|-----------------------------|--|--| +| Play Tone
(tonegen/pt,0x0003/0x0001) | Not Used | - | | - | | | +| | Signal Parameters | Mandatory/ Optional | Supported Values: | Duration Provisioned Value: | | | +| | - | - | - | - | | | +| Events | Mandatory/ Optional | Used in command: | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| Statistics | Mandatory/ Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +### A.14.27 Tone Detection Package + +Table C.14.27/1: Package Usage Information For Tone Detection Package + +| Properties | Mandatory/ Optional | Used in command: | Supported Values: | Provisioned Value: | +|-----------------------------------------------------|-----------------------------|------------------------|-------------------|-----------------------------| +| None | - | - | - | - | +| Signals | Mandatory/ Optional | Used in command: | | Duration Provisioned Value: | +| None | - | - | | - | +| | Signal Parameters | Mandatory/ Optional | Supported Values: | Duration Provisioned Value: | +| | - | - | - | - | +| Events | Mandatory/ Optional | Used in command: | | | +| Start tone detected
(tonedet/std, 0x0004/0x0001) | O | ADD, MOD, MOVE, NOTIFY | | | +| | Event Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | +| | Tone ID List
(tl,0x0001) | M | wildcard | Not Applicable | +| | ObservedEvent Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | +| | Tone ID
(tid,0x0003) | M | Value | Not Applicable | + +| Events | Mandatory/
Optional
| Used in command: | | | | | +|-------------------------------------------------------|-------------------------------------|--------------------------------|------------------------------|---------------------------|--|--| +| End Tone detected
(tonedet/etd,
0x0004/0x0002) | M | ADD, MOD, MOVE, NOTIFY | | | | | +| | Event
Parameters
| Mandatory/
Optional
| Supported
Values:
| Provisioned Value: | | | +| | Tone ID List
(tl,0x0001) | M | wildcard | Not Applicable | | | +| | ObservedEvent
Parameters
| Mandatory/
Optional
| Supported
Values:
| Provisioned Value: | | | +| | Tone ID
(tid,0x0003) | M | Value | Not Applicable | | | +| | Duration
(dur,0x0002) | O | Value | Not Applicable | | | +| Events | Mandatory/
Optional
| Used in command: | | | | | +| Long Tone detected
(tonedet/ltd,
0x0004/0x0003) | Not Used | - | | | | | +| | Event
Parameters
| Mandatory/
Optional
| Supported
Values:
| Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent
Parameters
| Mandatory/
Optional
| Supported
Values:
| Provisioned Value: | | | +| | - | - | - | - | | | +| Statistics | Mandatory/
Optional
| Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +### A.14.28 H324 Package + +Table A.14.28/1: Package Usage Information For H324 Package + +| Properties | Mandatory/ Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|----------------------------------------------------------|--------------------------|---------------------|-------------------|-------------------------------|--|--| +| Communication mode (h324/cmod,0x002c/0x0001) | Not used | - | - | - | | | +| Highest Multiplexing Level (h324/muxlv,0x002c/0x0002) | Not Used | - | - | Based on capability of IM-MGW | | | +| Demultiplex (h324/demux,0x002c/0x0003) | Not used | - | - | - | | | +| Remote H.223 capability (h324/h223capr,0x002c/0x0004) | M | MOD | OCTET STRING | Not Applicable | | | +| Incoming Multiplex Table (h324/muxtbl_in,0x002c/0x0005) | M | MOD | OCTET STRING | Not Applicable | | | +| Outgoing Multiplex Table (h324/muxtbl_out,0x002c/0x0006) | M | MOD | OCTET STRING | Not Applicable | | | +| Signals | Mandatory/ Optional | Used in command: | | Duration Provisioned Value: | | | +| None | - | - | | - | | | +| | Signal Parameters | Mandatory/ Optional | Supported Values: | Duration Provisioned Value: | | | +| | - | - | - | - | | | +| Events | Mandatory/ Optional | Used in command: | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| Statistics | Mandatory/ Optional | Used in command: | | Supported Values: | | | +| MUXPDU sent (h324/muxsent,0x002c/0x0001) | Not used | - | | - | | | +| MUXPDU received (h324/muxrec,0x002c/0x0002) | Not used | - | | - | | | +| MUXPDU error (h324/muxerr,0x002c/0x0003) | Not used | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +### A.14.29 H.245 Transport Package + +Table A.14.29/1: Package Usage Information For H.245 Transport Package + +| Properties | Mandatory/ Optional | Used in command: | Supported Values: | Provisioned Value: | +|-----------------------------------------------------------|-------------------------------------------|---------------------|-------------------|-----------------------------| +| None | - | - | - | - | +| Signals | Mandatory/ Optional | Used in command: | | Duration Provisioned Value: | +| Outgoing H.245 Message (h245tp/h245msgout, 0x00b4/0x0001) | M | MOD | | - | +| | Signal Parameters | Mandatory/ Optional | Supported Values: | Duration Provisioned Value: | +| | Contents of H.245 message (h245mc,0x0001) | M | OCTET STRING | - | + +| Events | Mandatory/
Optional | Used in command: | | | | | +|----------------------------------------------------------------|-------------------------------------------------|------------------------|----------------------|--------------------|--|--| +| Incoming H.245 message
(h245tp/h245msgin,
0x00b4/0x0001) | M | ADD, NOTIFY | | | | | +| | Event
Parameters | Mandatory/
Optional | Supported
Values: | Provisioned Value: | | | +| | None | - | - | - | | | +| | ObservedEvent
Parameters | Mandatory/
Optional | Supported
Values: | Provisioned Value: | | | +| | Contents of H.245
message
(h245mc,0x0001) | M | OCTET STRING | Not Applicable | | | +| Statistics | Mandatory/
Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +### A.14.30 IP domain connection + +Table C.14.30: Package usage information for IP domain connection package + +| Properties | Mandatory/
Optional | Used in command: | Supported Values: | Provisioned Value: | +|---------------------------------------------------------|-----------------------------|------------------------|----------------------|--------------------------------| +| IP Realm Identifier
(ipdc /realm,
0x009d /0x0001) | M | ADD | String | Operator Defined (NOTE1) | +| Signals | Mandatory/
Optional | Used in command: | | Duration Provisioned
Value: | +| None | - | - | | - | +| | Signal Parameters | Mandatory/
Optional | Supported Values: | Duration
Provisioned Value: | +| | - | - | - | - | +| Events | Mandatory/
Optional | Used in command: | | | +| None | - | - | | | +| | Event
Parameters | Mandatory/
Optional | Supported
Values: | Provisioned Value: | +| | - | - | - | - | +| | ObservedEvent
Parameters | Mandatory/
Optional | Supported
Values: | Provisioned Value: | +| | - | - | - | - | +| Statistics | Mandatory/
Optional | Used in command: | | Supported Values: | +| None | - | - | | - | +| Error Codes | Mandatory/ Optional | | | | + +| | | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---| +| None | - | +| NOTE1: A default IP realm may be configured such that if the MGW has not received the IP realm identifier and the MGW supports multiple IP realms then the default IP realm shall be used. | | + +### A.14.31 H.245 Transport Package for SPC use + +Table A.14.31/1: Package Usage Information For H.245 Transport Package for SPC use + +| Properties | Mandatory/
Optional
| Used in
command:
| Supported
Values:
| Provisioned Value: | +|--------------------|---------------------------------------------------------|--------------------------------|------------------------------|----------------------------------------| +| None | - | - | - | - | +| Signals | Mandatory/
Optional
| Used in command: | | Duration Provisioned
Value:
| +| None (NOTE 1) | M | MOD | | - | +| | Signal
Parameters
| Mandatory/
Optional
| Supported
Values:
| Duration
Provisioned Value:
| +| | Signalling
Preconfigured
Channel (spc,
0x0002) | O | ON
OFF | OFF | +| | Repetition (rep,
0x0003) | O | ON
OFF | ON | +| Events | Mandatory/
Optional
| Used in command: | | | +| None (NOTE 2) | M | ADD, NOTIFY | | | +| | Event
Parameters
| Mandatory/
Optional
| Supported
Values:
| Provisioned Value: | +| | Signalling
Preconfigured
Channel (spc,
0x0001) | O | H245, SPC,
Both | H245 | +| | ObservedEvent
Parameters
| Mandatory/
Optional
| Supported
Values:
| Provisioned Value: | +| | Signalling
Preconfigured
Channel (spc,
0x0002) | O | ON
OFF | OFF | +| Statistics | Mandatory/
Optional
| Used in command: | | Supported Values: | +| None | - | - | | - | +| Error Codes | Mandatory/ Optional | | | | +| None | - | | | | + +NOTE 1: The package does not define any new signal. The defined signal parameter can be used in the Outgoing H.245 Message signal (h245tpspc/h245msgout, 0x00f7/0x0001) defined in the base package (H.245 Transport package). + +NOTE 2: The package does not define any new event. The defined event and observed event parameters can be used in the Incoming H.245 Message event (h245tpspc/h245msgin, 0x00f7/0x0001) defined in the base package (H.245 Transport package). + +### A.14.32 MONA preference package + +Table A.14.32/1: Package Usage Information for MONA preference Package + +| Properties | Mandatory/
Optional | Used in
command: | Supported
Values: | Provisioned Value: | +|--------------------------------------------------------------------------------------|-------------------------------------------------------|------------------------|--------------------------|--------------------------------| +| MONA Class (monapref/class, 0x00f8/0x0001) | Not used | - | - | - | +| Supported Media Preconfigured Channels Receive (monapref/mpcrx, 0x00f8/0x0002) | Not used | - | - | - | +| Supported Media Preconfigured Channels Transmit (monapref/mpctx, 0x00f8/0x0003) | Not used | - | - | - | +| Signals | Mandatory/
Optional | Used in command: | | Duration
Provisioned Value: | +| Outgoing MONA preference message (monapref/monaprefmsgout, 0x00f8/0x0001) | M | MOD | | - | +| | Signal
Parameters | Mandatory/
Optional | Supported
Values: | Duration
Provisioned Value: | +| | Contents of MONA preference message (prefmsgc,0x0001) | M | OCTET STRING | - | +| Forward Media in Preconfigured Channel (monapref/Preconfchannelmedia, 0x00f8/0x0002) | O | MOD | | - | +| | Signal
Parameters | Mandatory/
Optional | Supported
Values: | Duration
Provisioned Value: | +| | Mux Code (muxcode,0x0003) | M | sub-list of OCTET STRING | - | +| Events | Mandatory/
Optional | Used in command: | | | +| MONA Preference reception (monapref/monaprefmsgin, 0x00f8/0x0001) | M | ADD, NOTIFY | | | +| | Event
Parameters | Mandatory/
Optional | Supported
Values: | Provisioned Value: | +| | None | - | - | - | +| | ObservedEvent
Parameters | Mandatory/
Optional | Supported
Values: | Provisioned Value: | +| | Contents of MONA preference message (prefmsgc,0x0001) | M | OCTET STRING | Not Applicable | +| MONA Preference negotiation completed (monapref/monaprefcompl, 0x00f8/0x0002) | M | ADD, NOTIFY | | | +| | Event
Parameters | Mandatory/
Optional | Supported
Values: | Provisioned Value: | + +| | | | | | | | +|--------------------------------------------------------|---------------------------------|----------------------------|--------------------------|---------------------------|--|--| +| | None | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | None | - | - | - | | | +| Legacy Detected
(monapref/legdet,
0x00f8/0x0003) | M | ADD, NOTIFY | | | | | +| | Event Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | None | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | None | - | - | - | | | +| MPC reception
(monapref/mpcrec,
0x00f8/0x0004) | O | ADD, NOTIFY | | | | | +| | Event Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | None | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | Mux Code
(muxcode,0x0001) | M | OCTET STRING | Not Applicable | | | +| Statistics | Mandatory/ Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +### A.14.33 3G Interface Type package + +Table A.14.31/1: Package Usage Information For 3G Interface Type + +| Properties | Mandatory/ Optional | Used in command: | Supported Values: | Provisioned Value: | +|-------------------------------------------------------------|---------------------------------|----------------------------|--------------------------------------|------------------------------------| +| IP Interface Type
(threegint /ipint,
(0x00e3/0x0001)) | M | ADD, MOD | "NbolP" (0x0001)
"MbolP" (0x0003) | None | +| Signals | Mandatory/ Optional | Used in command: | | Duration Provisioned Value: | +| None | - | - | | - | +| | Signal Parameters | Mandatory/ Optional | Supported Values: | Duration Provisioned Value: | +| | - | - | - | - | +| Events | Mandatory/ Optional | Used in command: | | | +| None | - | - | | | +| | Event Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | +| | - | - | - | - | +| | ObservedEvent Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | +| | - | - | - | - | + +| Statistics | Mandatory/Optional | Used in command: | Supported Values: | +|--------------------|----------------------------|------------------|-------------------| +| None | - | - | - | +| Error Codes | Mandatory/ Optional | | | +| None | - | | | + +### A.14.34 RTCP Feedback Message package + +Table A.14.34/1: Package Usage Information for RTCP Feedback Message package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|-------------------------------------------------------------|-------------------------------------|---------------------------|--------------------------|------------------------------------|--|--| +| None | - | - | - | - | | | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | | | +| Feedback Message Sending (rtcpfb/fbmesssend, 0x00f6/0x0001) | M | MOD | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | | | +| | Update Picture (upic,0x0001) | O | Enumeration | - | | | +| | Max Bitrate (mbr,0x0002) | O | Unsigned Integer | - | | | +| Events | Mandatory/Optional | Used in command: | | | | | +| RTCP Feedback Message Detection (rtcpfb/det, 0x00f6/0x0001) | M | MOD, NOTIFY | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | Feedback Message Type (type,0x0001) | M | Sub-list of String | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | Update Picture (upic,0x0001) | O | Enumeration | - | | | +| | Max Bitrate (mbr,0x0002) | O | Unsigned Integer | - | | | +| Statistics | Mandatory/Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +### A.14.35 Explicit Congestion Notification for RTP-over-UDP Support (ecnrous) + +**Table A.14.35.1: Explicit Congestion Notification for RTP-over-UDP Support package** + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | | | +|----------------------------------------------------------------|----------------------------------|---------------------------|-------------------------|---------------------------------------------------------------------------------------------|--|--| +| ECN Enabled (ecnrous/ecnen, 0x010b/0x0001) | M | ADD, MODIFY | True, False | - | | | +| Congestion Response Method (ecnrous/crm, 0x010b/0x0002) | Not Signalled | - | - | "RDCC"(0x0002)
NOTE | | | +| Initiation Method (ecnrous/initmethod, 0x010b/0x0003) | M | ADD, MODIFY | "leap" | "leap" | | | +| ECN Mode (ecnrous/mode, 0x010b/0x0004) | Not Signalled | - | - | "setonly" (0x0001) in the Remote Descriptor and "readonly" (0x0002) in the Local Descriptor | | | +| ECT Marking (ecnrous/ectmark, 0x010b/0x0005) | Not Signalled | - | - | "0" (0x0002) | | | +| ECN Congestion Marking (ecnrous/congestmark, 0x010b/0x0006) | Not Signalled | - | - | "nomark" (0x0003) | | | +| ECN SDP Usage (ecnrous/ecnsdp, 0x010b/0x0007) | Not Signalled | - | - | "P" (0x0001) | | | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | | | +| None | - | - | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | | | +| | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command | | | | | +| ECN Failure (ecnrous/fail, 0x010b/0x0001) | M | ADD, MODIFY, NOTIFY | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | Failure Type (type, 0x0001) | Mandatory | INIT, USE | - | | | +| | Media Sender SSRC (ssrc, 0x0002) | Not Supported | - | - | | | +| Statistics | Mandatory/Optional | Used in command | | Supported Values | | | +| Source (ecnrous/ssrc, 0x010b/0x0001) | Not Supported | - | | - | | | +| CE Counter (ecnrous/cecount, 0x010b/0x0002) | Not Supported | - | | - | | | +| ECT0 Counter (ecnrous/ectzero, 0x010b/0x0003) | Not Supported | - | | - | | | +| ECT1 Counter (ecnrous/ectone, 0x010b/0x0004) | Not Supported | - | | - | | | +| Not-ECT Counter (ecnrous/notect, 0x010b/0x0005) | Not Supported | - | | - | | | +| Lost Packets Counter (ecnrous/lost, 0x010b/0x0006) | Not Supported | - | | - | | | +| Extended Highest Sequence number (ecnrous/ehsn, 0x010b/0x0007) | Not Supported | - | | - | | | +| Duplication Counter (ecnrous/dup, 0x010b/0x0008) | Not Supported | - | | - | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +NOTE: Application Specific Rate Adaptation shall be applied in accordance with 3GPP TS 26.114 [62]. For speech this requires support of CMR and TMMBR for video. + +### A.14.36 Differentiated Services (ds) + +Table A.14.36.1: Differentiated Services package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | | | +|-------------------------------------------------------------|--------------------------|--------------------|------------------|----------------------------|--|--| +| Differentiated Services Code Point (ds/dscp, 0x008b/0x0001) | M | ADD, MODIFY | ALL | Yes | | | +| Tagging Behaviour (ds/tb, 0x008b/0x0002) | Not signalled | - | - | "MARK" (0x0000) | | | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | | | +| None | - | - | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | | | +| | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| Statistics | Mandatory/Optional | Used in command | Supported Values | | | | +| None | - | - | - | | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +### A.14.37 MG Act-as STUN Server (mgastuns) + +Table A.14.37.1: MG Act-as STUN Server + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | | | +|-----------------------------------------------------|--------------------------|--------------------|------------------|----------------------------|--|--| +| Act-as STUN Server (mgastuns/astuns, 0x00c2/0x0001) | M | ADD, MODIFY | ALL | - | | | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | | | +| None | - | - | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | | | +| | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| Statistics | Mandatory/Optional | Used in command | Supported Values | | | | +| None | - | - | - | | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +### A.14.38 Originate STUN Continuity Check (ostuncc) + +Table A.14.3.38.1: Originate STUN Continuity Check Package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | | | +|------------------------------------------------------------------|----------------------------------------|---------------------------|-----------------------------|-----------------------------------|--|--| +| Host Candidate Realm (ostuncc/hcr, 0x00c3/0x0001) | O | ADD, MODIFY | ALL | Yes | | | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | | | +| Send Connectivity Check (ostuncc/scc, 0x00c3/0x0001) | M | ADD, MODIFY | | Not Applicable | | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | | | +| | Control (cntrl, 0x0001) | O | "controlling", "controlled" | Not Applicable | | | +| Send Additional Connectivity Check (ostuncc/sacc, 0x00c3/0x0002) | Mandatory/Optional | Used in command | | Duration Provisioned Value | | | +| | M | MODIFY | | Not Applicable | | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | | | +| | Control (cntrl, 0x0001) | O | "controlling", "controlled" | Not Applicable | | | +| Events | Mandatory/Optional | Used in command | | | | | +| Connectivity Check Result (ostuncc/ccr, 0x00c3/0x0001) | M | ADD, MODIFY, NOTIFY | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | Candidate/Transport Pair (ctp, 0x0001) | M | ALL | Not applicable | | | +| New Peer Reflexive Candidate (ostuncc/nprc, 0x00c3/0x0002) | Mandatory/Optional | Used in command | | | | | +| | M | ADD, MODIFY, NOTIFY | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | Candidate (can, 0x0001) | M | ALL | Not applicable | | | +| Statistics | Mandatory/Optional | Used in command | | Supported Values | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +### A.14.39 Enhanced Revised Offer/Answer SDP Support (eroas) + +Table A.14.39/1: Enhanced Revised Offer/Answer SDP Support package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | | | +|--------------------------------------------------------|-------------------------------------|--------------------|------------------|-------------------------------|--|--| +| SDPCapNeg Extensions
(eroas/sdpe,
0x0109/0x0001) | M | AuditValue | "cap-v0" | "cap-v0" | | | +| Signals | Mandatory/Optional | Used in command | | Duration
Provisioned Value | | | +| None | - | - | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration
Provisioned Value | | | +| | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| | ObservedEvent
Parameters
| Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| Statistics | Mandatory/Optional | Used in command | Supported Values | | | | +| None | - | - | - | | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +## A.15 Mandatory support of SDP and H.248 Annex C information elements + +**Table A.15/1: Supported Annex C and SDP information elements** + +| Information Element | Annex C Support | SDP Support | +|---------------------|-----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| v-line | "SDP_V " | The value must always be equal to zero:
v=0. | +| m-line | "SDP_M " | and are required. Both static and dynamic payload types shall be supported.
The MGC may underspecify the subfield in place of a single dynamic payload type. In this case the mapping between the underspecified payload type and the / shall be provided in the rtpmap attribute.
For see table 5.15/2. | +| c-line | "SDP_C " | and are required
The network type shall be set to "IN".
The address type may be IPv4 or IPv6. The MGC may apply parameter underspecification to the
subfield. (NOTE 2) | +| a-line | "SDP_A " | For a dynamic RTP payload type, for each codec information on the codec type shall be provided in a separate SDP "a=rtpmap "-line and possibly additional SDP "a=fmtp "-line(s). See Clause 10.2.
For AVPF transport, the "rtcp-fb" SDP attribute defined in IETF RFC 4585 [60] may be used to provide the feedback message types the MG is allowed to send and to indicate RTCP timing information. (NOTE 3)
For T.38, additional SDP attributes listed in subclause 10.2.3.6 may be provided.
ICE support
The attributes "a=candidate", "a=ice-pwd", and "a=ice-ufrag" (see IETF RFC 5245 [68]) may be provided for an SDP m-line in the local and remote descriptor if the IM-MGW supports ICE, see also 3GPP TS 24.229 [69]. In the local descriptor, the MGC shall provide "a=ice-pwd", and "a=ice-ufrag" with wildcard sign "\$" to request the allocation of a password and user name fragment, and the "a=candidate" of type "host" with the transport, port and priority parameters with wildcard sign "\$" to request the allocation of a host candidate. The IM-MGW shall then reply with completed "a=ice-pwd", and "a=ice-ufrag" and "a=candidate" attributes in the local descriptor, and shall include "a=ice-lite" if it only supports ICE lite. In the remote descriptor, the MGC may provide the "a=candidate", "a=ice-pwd", and "a=ice-ufrag".

Rate adaptation for media endpoints:
If the IM-MGW performs media transcoding and if the rate adaptation for media endpoints using the enhanced bandwidth negotiation is supported by the IM-MGW, attribute(s) "a=bw-info" with direction "send" or "sendrecv" may be provided for an m-line and the selected IP payload type and applicable IP version in the remote descriptor.
The following bandwidth properties, as defined in 3GPP TS 26.114 [62], clause 19, may be included in "a=bw-info" line:
, , , and .

SDP Capability Negotiation:
The attributes of "a=acap", "a=tcap", "a=pcfg" and "a=acfg" (see IETF RFC 5939 [70]) may be provided in the local descriptor and/or remote descriptor. | + +| | | | +|--------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| b-line | "SDP_B " |

(NOTE1).
B:RS and b:RR bandwidth modifiers required
Bandwidth information shall be supplied by the MGC if the required bandwidth cannot be immediately derived from the information contained in the m= line. If the MGC is using parameter underspecification, the MG shall assume a reasonable default bandwidth value for well-known codecs and shall provide this value in the response sent to the MGC. The Modifier field shall be set to "AS". The Bandwidth Value field shall be set to the maximum bandwidth requirement of the media stream in kbit/s and shall take into account all headers down to the IP layer.

The MGC may also supply additional RTCP bandwidth modifiers (i.e. RR and RS, see IETF RFC 3556 [39]). If the RTCP modifiers are not supplied, the bandwidth value for the AS modifier shall take into account an extra 5% bandwidth for RTCP packets.

| +| o-line | "SDP_O" |

The origin line consists of 6 fields:
o= <user name> <session ID> <version> <network type> <address type> <address>.

The MGC is not required to supply this line but shall accept it.

The MG shall return the value received from the MGC or if there is no o-line sent by the MGC, the MG shall populate this line as follows:

  • - <user name> should contain an hyphen
  • - <session ID> and <version> should contain one or more digits as described in RFC 4566 [17]
  • - <network type> shall be set to IN
  • - <address type> shall be set to IP4 or IP6 The Address Type shall be set to "IP4" or "IP6" depending on the addressing scheme used by the network to which the MG is connected.
  • - <address> should contain the fully qualified domain name or IP address of the gateway.
| +| s-line | "SDP_S" |

The session name (s=) line contains a single field:
s= <session-name>.

The MGC is not required to supply a session name but shall accept one. This line may be used to convey correlation information for use in CDRs.

The MG shall return the value received from the MGC or if there is no s-line sent by the MGC, the MG shall populate this line as follows:

  • - "s=.."
| +| t-line | "SDP_T" |

The time (t=) line consists of two fields:
t= <start-time> <stop-time>.

The MGC is not required to supply a time description but shall accept one.

The MG shall return the value received from the MGC or if there is no t-line sent by the MGC, the MG shall populate this line as follows:

  • - "t=0 0"
| + +| | | +|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NOTE a: | SDP or SDP_equivalents are only used for terminations towards the IM CN Subsystem. | +| NOTE b: | For BICC terminations, mandatory support of SDP and Annex C information elements shall be in accordance with the subclause "Mandatory Support of SDP and H.248.1 annex C information elements" in ITU-T Recommendation Q.1950 [14]. For IP the IANA ICP IDI format of the NSAP addressing format as specified in X.213 [33] shall be used. For IPv4 networks the IPv4 format recommended by X.213 shall be adopted. The BIR length shall be fixed at 4 Octets and the NSAP length shall be fixed at 20 Octets.. | +| NOTE 1: | b-line is optional in TISPAN NGN R2. | +| NOTE 2: | The address type may be IPv4 or IPv6. The default IP version (i.e. IPv4 or IPv6) may be provisioned in the H.248 MG. The MGC may apply H.248 parameter underspecification. If the MGC does require a different IP version than the provisioned default, then the MGC applies complete H.248 parameter specification. | +| NOTE3: | Support is optional and dependent on RTCP-fb support as described in 3GPP TS 26.114 [62]. The list of feedback types supported by the MG is preconfigured in the MGC. The "rtcp-fb" SDP attribute shall be sent from MGC when applicable. | + +**Table A.15/2: Transport Protocol** + +| | | +|----------------------------------------------------|---------------------------------------------------------------------------------------------------------------| +| Transport Protocol <proto> in m-line: | If the MG does not support the requested transport protocol, it shall reject the command with error code 449. | +| TCP | (NOTE 1, NOTE 2) | +| RTP/AVP | RTP profile according IETF RFC 3551 [33]. | +| RTP/AVPF | Extended RTP profile for RTCP-based Feedback (RTP/AVPF) according IETF RFC 4585 [60]. (NOTE 1). | +| udptl | (NOTE 1) | +| NOTE 1: | support optional. | +| NOTE 2: | Upper case TCP is defined by IETF RFC 4145 [59] and registered by IANA. . | + +## A.16 Optional support of SDP and H.248 Annex C information elements + +**Table A.16/1: Optional Supported Annex C and SDP information elements** + +| Information Element | Annex C Support | SDP Support | +|---------------------|-----------------|-------------| +| | | | + +## A.17 Procedures + +### A.17.1 Call Independent Procedures + +Table A.17.1/1 shows the relationship between each non call-related procedure in 3GPP TS 29.232 [5] and the corresponding procedure defined in 3GPP TS 29.163 [4]. + +For further description of error codes and service change reasons, refer to ITU-T Recommendation H.248.8 [10]. + +**Table A.17.1/1: Non call-related transaction reused from 3GPP TS 29.232 [5]** + +| Procedure defined in 3GPP TS 29.163 [4] | Procedure defined in 3GPP TS 29.232 [5] | Support | Comment | +|--------------------------------------------------|-----------------------------------------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| IM-MGW Out of service | MGW Out of Service | Mandatory | | +| IM-MGW Communication Up | MGW Communication Up | Mandatory | | +| IM-MGW Restoration | MGW Restoration | Mandatory | | +| IM-MGW Register | MGW Register | Mandatory | | +| IM-MGW Re-register | MGW Re-register | Mandatory | | +| MGCF Ordered Re-register | (G)MSC Server Ordered Re-register | Mandatory | | +| MGCF Restoration | (G)MSC Server Restoration | Optional | | +| MGCF Out of Service | (G)MSC Server Out of Service | Optional | | +| Termination Out-of-Service | Termination Out-of-Service | Mandatory | | +| Termination Restoration | Termination Restoration | Mandatory | | +| Audit Value | Audit Value | Mandatory | Mandatory support only for audit of Termination Service State and for periodic audit of MGW (empty Audit descriptor).

Optional support for audit of Packages or to retrieve MGC Information. | +| Audit Capability | Audit Capability | Optional | | +| Command Rejected | Command Rejected | Mandatory | The "Command Rejected" procedure may be used in response both to call-related and non-call-related ITU-T Recommendation H.248 Commands | +| IM-MGW Capability Change | Capability Update | Optional | | +| IM-MGW Resource Congestion Handling - Activate | MGW Resource Congestion Handling - Activate | Mandatory | | +| IM-MGW Resource Congestion Handling - Indication | MGW Resource Congestion Handling - Indication | Mandatory | | +| Inactivity Timeout - Activate | Inactivity Timeout - Activate | Optional | | +| Inactivity Timeout - Indication | Inactivity Timeout - Indication | Optional | | + +#### A.17.1.2 Profile registration + +The following description is based on H.248.1 profile registration procedure with some clarifications. The reply to the ServiceChange Request containing the SCP parameter indicates if the MGCF supports the requested profile or if it does not support it and wants to propose an alternative profile. The profile (name and version) is only returned in the reply if the MGCF cannot support the specified profile in the ServiceChangeRequest. The returned reply shall indicate the profile and version supported. Upon reception of a profile in the reply, if the IM-MGW supports the indicated profile, it shall issue a new ServiceChange Request with the agreed profile to explicitly confirm the acceptance of the profile to the MGCF ; otherwise, if the IM-MGW does not support the indicated profile, it may continue the registration or re-registration procedure by issuing a new ServiceChange Request with an alternative profile ; until such procedure is successfully completed the IM-MGW shall remain out of service. If the profile is not returned the MGCF shall use the capabilities specified by the Profile indicated in the service change request. + +NOTE: It should be observed that the profile registration is not a "cold calling" negotiation; it is expected that the operator will have configured the network to support certain profiles and so the profile registration within the Mn interface permits network upgrade scenarios but otherwise is simply a means to confirm the connection of the profile to be used over the Mn interface between MGCF and IM-MGW. + +### A.17.2 IMS Terminations Procedures + +#### A.17.2.1 Summary of Procedures related to a termination towards IM CN Subsystem + +Table 1 shows the relationship between each call-related procedure in ITU-T Recommendation Q.1950 [14] (see 3GPP TS 29.205 [3]) or TS 29.232 [5] and the corresponding stage 2 procedure defined in 3GPP TS 29.163 [4]. + +**Table A.17.2.1/1: Correspondence between ITU-T Recommendation Q.1950 [14] or 29.232 [5] call-related transactions and 3GPP TS 29.163 [4] procedures** + +| Procedure defined in 3GPP TS 29.163 [4] | Transaction used in Q.1950 [14] | Transaction used in TS 29.232 [5] | Supported | Comment | +|-------------------------------------------------------------|---------------------------------|-----------------------------------|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Reserve IMS Connection point | Not defined | Not Defined | Mandatory | See A.17.2. 2 | +| Configure IMS Resources | Not Defined | Not Defined | Mandatory | See A.17.2. 3 | +| Reserve IMS Connection Point and configure remote resources | Not defined | Not Defined | Mandatory | See A.17.2. 4 | +| Release IMS termination | n. a. for reuse | Release Termination | Mandatory | See A.17.2. 5 | +| Change IMS ThroughConnection | n. a. for reuse | Change Through Connection | Mandatory | only the Explicit (MGC Controlled Cut-Through) procedure is supported | +| Detect IMS RTP Tel Event | n. a. for reuse | Detect DTMF | Optional | Only applicable if termination towards IMS is connected with a termination towards a BICC network. | +| End IMS RTP Tel Event | n. a. for reuse | Stop Detect DTMF | Optional | Only applicable if termination towards IMS is connected with a termination towards a BICC network. | +| Notify IMS RTP Tel Event | n. a. for reuse | Report DTMF | Optional | Only applicable if termination towards IMS is connected with a termination towards a BICC network. | +| Send IMS RTP Tel Event | n. a. for reuse | Send DTMF | FFS | | +| Stop IMS RTP Tel Event | n. a. for reuse | Stop DTMF | FFS | | +| IMS Send Tone | n. a. for reuse | Send Tone | Optional | | +| IMS Stop Tone | n. a. for reuse | Stop Tone | Optional | | +| IMS Tone Completed | n. a. for reuse | Tone Completed | Optional | | +| Termination heartbeat Indication | Not defined | Termination heartbeat Indication | Mandatory | To allow detection of hanging contexts and terminations in the MGW that may result e.g. from a loss of communication between the MGCF and the IM-MGW. | +| IMS Bearer Released | n. a. for reuse. | Bearer Released | Mandatory | | +| Request RTCP-Interworking | Not defined | Not defined | Optional | Only applicable if RTCP AVPF message to feedback on the quality of the media distribution from the IMS side is required to be interworked with corresponding H.245 message towards the CS side. | +| Notify of RTCP-Interworking | Not defined | Not defined | Optional | Only applicable if RTCP AVPF message to feedback on the quality of the media distribution from the IMS side is required to be interworked with corresponding H.245 message towards the CS side. | +| Signal H.245-Interworking | Not defined | Not defined | Optional | Only applicable if H.245 message to feedback on the quality of the media distribution from the CS side is required to be interworked with corresponding RTCP AVPF message towards the IMS side. | + +| | | | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|------------------------|----------|-----------------------------------------------------------| +| ECN Failure Indication | Not defined | ECN Failure Indication | Optional | Only applicable if ECN capability is supported. | +| ICE Connectivity Check Result Notification | Not defined | Optional | Optional | See A.17.2.11
Only applicable if full ICE is supported | +| ICE New Peer Reflexive Candidate Notification | Not defined | Optional | Optional | See A.17.2.12
Only applicable if full ICE is supported | +| NOTE 1: A procedure defined in table 13.2.1 can be combined with another procedure in the same table. This means that they can share the same contextID and termination ID(s) and that they can be combined in the same H.248 command. | | | | | + +#### A.17.2.2 Reserve IMS Connection Point + +When the procedure "Reserve IMS Connection Point" is required the following procedure is initiated: + +The MGCF sends an Add.req command with the following information. + +- 1 Add.req (Reserve IMS Connection Point) MGCF to IM-MGW + +**Table A.17.2.2/1: Reserve IMS Connection Point Request** + +| Address Information | Control information | Bearer information | +|--------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Stream ID
Local Descriptor {
Port = ?
IP Address = ?
} | Transaction ID = z
Termination ID = ?
If Context Requested:
Context ID = ?
If Context Provided:
Context ID = c1
If MPS call/session:
Priority Indicator = x
If IP Interface Type:
IP interface = "IP interface type"
If Resources for multiple Codecs shall be reserved:
Reserve_Value
NotificationRequested (Event ID = x, "termination heartbeat")
If indication on Bearer Released requested:
NotificationRequested (Event ID = x, "BNC Release (Cause)") – as defined in ITU-T Recommendation Q.1950
If multiple IP realms: IP realm Identifier = required IP realm identifier

If ECN Endpoint support required
ECN Enable = "True"
Initiation Method = "ECN Initiation Method"

If notification of ECN Failure Report:
NotificationRequested (Event ID = x, "ECN Failure")

If diffserv required:
Diffserv Code Point

If ICE is applied:
STUN server request | Stream ID
Local Descriptor {
Codec List
RTP Payloads
RtcpbwRS
RtcpbwRR
If ICE is applied:
ICE host candidate request
ICE password request
ICE Ufrag request

If SDPCapNeg is signalled to the gateway:
SDPCapNeg configuration
} | + +When the processing of command (1) is complete, the IM-MGW initiates the following procedure. + +##### 2 Add.resp (Reserve IMS Connection Point Ack) + +**Table A.17.2.2/2: Reserve IMS Connection Point Acknowledge** + +| Address Information | Control information | Bearer information | +|------------------------------------------------------------|------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Stream ID
Local Descriptor {
Port
IP Address
} | Transaction ID
Termination ID
Context ID | Stream ID
Local Descriptor {
Codec List
RTP Payloads
RtcpbwRS
RtcpbwRR

If ICE is applied:
ICE host candidate
ICE password
ICE Ufrag
If ICE lite implementation
ICE lite indication

If SDPCapNeg is signalled to the gateway:
SDPCapNeg configuration
} | + +#### A.17.2.3 Configure IMS Resources + +When the procedure "Configure IMS Resources" is required the following procedure is initiated: + +The MGCF sends a Mod.req command with the following information. + +- 1 Mod.req (Configure IMS Resources) MGCF to IM-MGW + +**Table A.17.2.3/1: Configure IMS Resources Request** + +| Address Information | Control information | Bearer information | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| If local resources are modified:
Stream ID
Local Descriptor {
Port
IP Address
}
If remote resources are modified:
Remote Descriptor {
Port
IP Address
} | Transaction ID
Termination ID
Context ID
If IP Interface Type:
IP interface = "IP interface type"(NOTE 1)
If Resources for multiple Codecs shall be reserved:
Reserve_Value
If ECN Endpoint support required
ECN Enable = "True"
Initiation Method = "ECN Initiation Method"
If notification of ECN Failure Report:
NotificationRequested (Event ID = x, "ECN Failure")
If full ICE is applied:
Send Connectivity Check ("Control")
If notification of ICE Connectivity Check Result Report:
NotificationRequested (Event ID= xx, "Connectivity Check Result")
If notification of New Peer Reflexive Candidate:
NotificationRequested (Event ID = xy, " New Peer Reflexive Candidate ")
Send Additional Connectivity Check ("Control") | If local resources are modified:
Stream ID
Local Descriptor {
Codec List
RTP Payloads
RtcpbwRS
RtcpbwRR
}
If SDPCapNeg is signalled to the gateway:
SDPCapNeg configuration
}
If remote resources are modified:
Remote Descriptor {
Codec List
RTP Payloads
If rate adaptation for media endpoints:
Additional Bandwidth Properties (NOTE 3)
RtcpbwRS
RtcpbwRR
}
If RTCP APP messages allowed
Allowed RTCP APP message types
If ICE is applied:
ICE received candidate
ICE received password
ICE received Ufrag (NOTE 2)
If SDPCapNeg is signalled to the gateway:
SDPCapNeg configuration
} | +| NOTE 1: If this property is included within the "Reserve IMS Connection Point" procedure or the "Reserve IMS Connection Point and configure remote resource" procedure then it shall not be modified by this procedure.
NOTE 2: The support of ICE received candidate, ICE received password, ICE received Ufrag are optional for ICE lite, as specified in 3GPP TS 23.232 [5].
NOTE 3: The support of rate adaptation for media endpoints using the additional bandwidth properties is optional for the IM-MGW. If media transcoding is required the MGCF may provide for the selected payload type and the used IP version the additional bandwidth properties. | | | + +When the processing of command (1) is complete, the IM-MGW initiates the following procedure. + +##### 2 Mod.resp (Configure IMS Resources Ack) + +**Table A.17.2.3/2: Configure IMS Resources Acknowledge** + +| Address Information | Control information | Bearer information | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| If local resources were provided in request:
Stream ID
Local Descriptor {
Port
IP Address
}
If remote resources were provided in request:
Remote Descriptor {
Port
IP Address
} | Transaction ID
Context ID
Termination ID | If local resources were provided in request:
Stream ID
Local Descriptor {
Codec List
RTP Payloads
RtcpbwRS
RtcpbwRR
}
If SDPCapNeg is signalled to the gateway:
SDPCapNeg configuration
}
If remote resources were provided in request:
Remote Descriptor {
Codec List
RTP Payloads
If rate adaptation for media endpoints:
Additional Bandwidth
Properties
RtcpbwRS
RtcpbwRR
}
If SDPCapNeg is signalled to the gateway:
SDPCapNeg configuration
} | + +#### A.17.2.4 Reserve IMS Connection Point and configure remote resources + +When the procedure "Reserve IMS Connection Point and configure remote resources" is required the following procedure is initiated: + +The MGCF sends an Add.req command with the following information. + +- 1 Add.req (Reserve IMS Connection Point and configure remote resources) MGCF to IM-MGW + +**Table A.17.2.4/1: Reserve IMS Connection Point and configure remote resources Request** + +| Address Information | Control information | Bearer information | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Stream ID
Local Descriptor {
Port = ?
IP Address = ?
}
Remote Descriptor {
Port
IP Address
} | Transaction ID
Termination ID = ?
If Context Requested:
Context ID = ?
If Context Provided:
Context ID = c1
If MPS call/session:
Priority Indicator = x
If IP Interface Type:
IP interface = "IP interface type"
If Resources for multiple Codecs shall be reserved:
Reserve_Value
NotificationRequested (Event ID = x, "termination heartbeat")
If indication on Bearer Released requested:
NotificationRequested (Event ID = x, "BNC Release (Cause)") – as defined in ITU-T Recommendation Q.1950
If multiple IP realms: IP realm Identifier = required IP realm identifier
If ECN Endpoint support required
ECN Enable = "True"
Initiation Method = "ECN Initiation Method"

If notification of ECN Failure Report:
NotificationRequested (Event ID = x, "ECN Failure")

If diffserv required:
Diffserv Code Point

If ICE is applied:
STUN server request
If full ICE is applied
Send Connectivity Check ("Control")
notification of ICE Connectivity Check Result Report:
NotificationRequested (Event ID = xx, "Connectivity Check Result")
If notification of New Peer Reflexive Candidate:
NotificationRequested (Event ID = xy, " New Peer Reflexive Candidate ") | Stream ID
Local Descriptor {
Codec List
RTP Payloads
RtcpbwRS
RtcpbwRR
If ICE is applied:
ICE host candidate request
ICE password request
ICE Ufrag request

If SDPCapNeg is signalled to the gateway:
SDPCapNeg configuration
}
Remote Descriptor {
Codec List
RTP Payloads
If rate adaptation for media endpoints:
Additional Bandwidth Properties (NOTE 2)
RtcpbwRS
RtcpbwRR

If RTCP APP messages allowed
Allowed RTCP APP message types

If ICE is applied:
ICE received candidate
ICE received password
ICE received Ufrag (NOTE 1)

If SDPCapNeg is signalled to the gateway:
SDPCapNeg configuration
} | +| NOTE 1: The support of ICE received candidate, ICE received password, ICE received Ufrag are optional for ICE lite, as specified in 3GPP TS 23.232 [5]. | | | +| NOTE 2: The support of rate adaptation for media endpoints using the additional bandwidth properties is optional for the IM-MGW. If media transcoding is required the MGCF may provide for the selected payload type and the used IP version the additional bandwidth properties. | | | + +When the processing of command (1) is complete, the IM-MGW initiates the following procedure. + +##### 2 Add.resp (Reserve IMS Connection Point and configure remote resources Ack) + +**Table A.17.2.4/2: Reserve IMS Connection Point and configure remote resources Acknowledge** + +| Address Information | Control information | Bearer information | +|--------------------------------------------------------------------------------------------------------------|------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Stream ID
Local Descriptor {
Port
IP Address
}
Remote Descriptor {
Port
IP Address
} | Transaction ID
Termination ID
Context ID | Stream ID
Local Descriptor {
Codec List
RTP Payloads
RtcpbwRS
RtcpbwRR
If ICE is applied:
ICE host candidate
ICE password
ICE Ufrag
If ICE lite implementation
ICE lite indication

If SDPCapNeg is signalled to the gateway:
SDPCapNeg configuration
}
Remote Descriptor {
Codec List
RTP Payloads
If rate adaptation for media endpoints:
Additional Bandwidth Properties
RtcpbwRS
RtcpbwRR

If SDPCapNeg is signalled to the gateway:
SDPCapNeg configuration
} | + +A.17.2.5 VOID + +A.17.2.6 Termination heartbeat indication + +When the procedure "Termination heartbeat indication" is required the following procedure is initiated: the MGW sends a NOT.req command with the following information. + +**Table A.17.2.6/1: NOT.req (Termination heartbeat) MGW to MGC** + +| Address Information | Control information | Bearer information | +|---------------------|------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = bearer1

Event_ID (Event ID = x,
"termination heartbeat") | | + +When the processing of command is complete, the MGC initiates the following procedure. + +**Table A.17.2.6/2: NOT.resp (Termination heartbeat) MGC to MGW** + +| Address Information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = bearer1 | | + +The heartbeat timer shall be configured to a value much greater than the mean call holding time. + +The MGCF is in charge of correcting any detected mismatch, by subtracting hanging terminations or clearing hanging contexts as specified for the hanging termination detection procedure in 3GPP TS 29.163 [4]. + +#### A.17.2.7 Request RTCP-Interworking + +When the procedure "Request RTCP-Interworking" is required the following procedure is initiated: + +the MGCF sends a Mod.req command with the following information. + +**Table A.17.2.7/1: Request RTCP-Interworking Request** + +| Address Information | Control information | Bearer information | +|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = bearer1

NotificationRequested (Event ID = x, "Incoming RTCP Interworking (RTCP Filter)") | | + +When the processing of command is complete, the IM-MGW initiates the following procedure. + +**Table A.17.2.7/2: Request RTCP-Interworking Acknowledge** + +| Address Information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = bearer1 | | + +#### A.17.2.8 Notify RTCP-Interworking + +When the procedure "Notify RTCP-Interworking" is required the following procedure is initiated: + +the IM-MGW sends a NOT.req command with the following information. + +**Table A.17.2.8/1: Notify RTCP-Interworking Request** + +| Address Information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = bearer1

if RTCP PLI message received and the interworking required:
Update Picture = UpdatePicture_Event

if RTCP TMMBR message received and the interworking required:
Max BitRate = MaxBitRate_Event | | + +When the processing of command is complete, the MGCF initiates the following procedure. + +**Table A.17.2.8/2: Notify RTCP-Interworking Acknowledge** + +| Address Information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = bearer1 | | + +The MGCF is in charge of sending the corresponding H.245 message to the CS side to request for the media adaption. as specified for the "Interworking between RTCP messages and H.245 messages" in 3GPP TS 29.163 [4]. + +#### A.17.2.9 Signal H.245-Interworking + +When the procedure "Signal H.245-Interworking" is required the following procedure is initiated: + +the MGCF sends a Mod.req command with the following information. + +**Table A.17.2.9/1: Signal H.245-Interworking Request** + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = bearer1

if H.245 VideoFastUpdatePicture message received and the interworking required:
Interwork H.245-RTCP (UpdatePicture_Signal)

if H.245 Flow Control Command received and the interworking required:
Interwork H.245-RTCP (MaxBitRate_Signal) | | + +When the processing of command is complete, the IM-MGW initiates the following procedure. + +**Table A.17.2.9/2: Signal H.245-Interworking Acknowledge** + +| Address Information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = bearer1 | | + +The IM-MGW is in charge of constructing and sending the corresponding RTCP message to the IMS side to request for the media adaption as specified for the "Interworking between RTCP messages and H.245 messages" in 3GPP TS 29.163 [4]. + +#### A.17.2.10 ECN Failure Indication + +The IM-MGW sends a NOTIFY request command as in Table A.17.2.10.1. + +**Table A.17.2.10.1: ECN Failure Indication** + +| Address Information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1

Event_ID (Event ID = x, "ECN Failure (ECN Failure Type ") | | + +The MGCF responds as in Table A.17.2.10.2 + +**Table A.17.2.10.2: ECN Failure Indication Ack** + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +#### A.17.2.11 ICE Connectivity Check Result Notification + +The IM-MGW sends a NOTIFY request command as defined in Table A.17.2.11.1. + +**Table A.17.2.11.1: ICE Connectivity Check Result Notification** + +| Address Information | Control information | Bearer information | +|----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------| +| | Transaction ID = x
Context ID= C1
Termination ID = T1

Event_ID (Event ID = x,
" Connectivity Check Result
(Candidate/Transport Pair)") | | + +The MGCF responds as defined in Table A.17.2.11.2 + +**Table A.17.2.11.2: ICE Connectivity Check Result Notification Ack** + +| Address Information | Control information | Bearer information | +|----------------------------|--------------------------------------------------------------|---------------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +#### A.17.2.12 ICE New Peer Reflexive Candidate Notification + +The IM-MGW sends a NOTIFY request command as defined in Table A.17.2.12.1. + +**Table A.17.2.12.1: ICE New Peer Reflexive Candidate Notification** + +| Address Information | Control information | Bearer information | +|----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|---------------------------| +| | Transaction ID = x
Context ID= C1
Termination ID = T1

Event_ID (Event ID = x,
" New Peer Reflexive Candidate
(Candidate)") | | + +The MGCF responds as defined in Table 5.17.2.12.2 + +**Table A.17.2.12.2: ICE New Peer Reflexive Candidate Ack** + +| Address Information | Control information | Bearer information | +|----------------------------|--------------------------------------------------------------|---------------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +### A.17.3 TDM Terminations Procedures + +#### A.17.3.1 Summary Procedures related to a termination towards ISUP + +**Table A.17.3.1/1: Correspondence between ITU-T Recommendation Q.1950 [14] or 29.232 [5] call-related transactions and 3GPP TS 29.163 [4] procedures related to a termination towards an ISUP network** + +| Procedure defined in 3GPP TS 29.163 [4] | Transaction used in ITU-T Q.1950 [14] | Transaction used in TS 29.232 [5] | Support | Comment | +|-----------------------------------------|---------------------------------------|---------------------------------------|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Reserve TDM Circuit | n. a. for reuse | n. a. for reuse, (NOTE 2) | Optional (NOTE 4) | See Clause A.17.3.2 | +| Change TDM Through-connection | n. a. for reuse | Change Through-connection | Optional (NOTE 4) | only the Explicit (MGC Controlled Cut-Through) procedure is supported | +| Activate TDM voice-processing function | n. a. for reuse | Activate Voice Processing Function | Optional (NOTE 4) | | +| Send TDM Tone | n. a. for reuse | Send Tone | Optional (NOTE 4) | | +| Stop TDM Tone | n. a. for reuse | Stop Tone | Optional (NOTE 4) | | +| TDM Tone Completed | n. a. for reuse | Tone Completed | Optional (NOTE 4) | | +| Play TDM Announcement | n. a. for reuse | Play Announcement | Optional (NOTE 4) | | +| TDM Announcement Completed | n. a. for reuse | Announcement Completed | Optional (NOTE 4) | | +| Stop TDM Announcement | n. a. for reuse | Stop Announcement | Optional (NOTE 4) | | +| Continuity Check | Continuity Check Tone | n. a. for reuse | Optional (NOTE 4) | The addition to "Prepare BNC Notify" defined in Annex B.7.1.1 of Q.1950 [14] shall be applied instead to "Reserve TDM Circuit", as defined in Clause A.17.3.2 | +| Continuity Check Verify | Continuity Check Verify | Continuity Check Verify | Optional (NOTE 4) | | +| Continuity Check Response | Continuity Check Response | n. a. for reuse | Optional (NOTE 4) | The addition to "Prepare BNC Notify" defined in Annex B.7.1.2 of Q.1950 [14] shall be applied instead to "Reserve TDM Circuit", as defined in Clause A.17.3.2 | +| Release TDM Termination | n. a. for reuse | n. a. for reuse | Optional (NOTE 4) | See Clause A.17.3.3 | +| Termination heartbeat Event | Not defined | Termination heartbeat Indication | Optional | See Clause A.17.3.4 | +| Not defined | Not defined | TFO Activation | Optional | See Clause A.14.21 | +| Not defined | Not defined | Codec Modify | Optional | See Clause A.14.21 | +| Not defined | Not defined | Optimal Codec and Distant List Notify | Optional | See Clause A.14.21 | +| Not defined | Not defined | Distant Codec List | Optional | See Clause A.14.21 | +| Not defined | Not defined | TFO status Notify | Optional | See Clause A.14.21 | +| Not defined | Not defined | TFO status | Optional | See Clause A.14.21 | +| Bearer Released | n. a. for reuse. | Bearer Released | Optional (NOTE 4) | | + +NOTE 1: A procedure defined in table 13.2.2 can be combined with another procedure in the same table. This means that they can share the same contextID and termination ID(s) and that they can be combined in the same H.248 command. + +NOTE 2: The reserve circuit procedure of 29.232 is not to be used only a reduced set of the parameters is required for reserve TDM circuit. + +NOTE 3: VOID + +NOTE 4: Required for TDM terminations towards an ISUP based network + +#### A.17.3.2 Reserve TDM Circuit + +When the procedure "Reserve TDM Circuit" is required the following procedure is initiated: + +The MGCF sends an Add.req command with the following information. + +**Table A.17.3.2/1: Add.req (Reserve TDM Circuit) MGCF to IM-MGW** + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------| +| | Transaction ID
Termination ID
If Context Requested:
Context ID = ?
If Context Provided:
Context ID = c1
If detection of hanging termination is requested:
NotificationRequested (Event ID = x, "termination heartbeat")
If indication on Bearer Released requested:
NotificationRequested (Event ID = x, "BNC Release (Cause)") – as defined in ITU-T Recommendation Q.1950 | Bearer Service Characteristics | + +When the processing of command (1) is complete, the IM-MGW initiates the following procedure. + +**Table A.17.3.2/2: Add.resp (Reserve TDM Circuit) IM-MGW to MGCF** + +| Address Information | Control information | Bearer information | +|---------------------|------------------------------------------------|--------------------| +| | Transaction ID
Termination ID
Context ID | | + +#### A.17.3.3 Release TDM Termination + +When the procedure "Release TDM Termination" is required the following procedure is initiated: + +The MGCF sends an Sub.req command with the following information. + +**Table A.17.3.3/1: Sub.req (Release TDM Termination) MGCF to IM-MGW** + +| Address Information | Control information | Bearer information | +|---------------------|------------------------------------------------|--------------------| +| | Transaction ID
Termination ID
Context ID | | + +When the processing of command (1) is complete, the IM-MGW initiates the following procedure. + +**Table A.17.3.3/2: Sub.resp (Release TDM Termination) IM-MGW to MGCF** + +| Address Information | Control information | Bearer information | +|---------------------|------------------------------------------------|--------------------| +| | Transaction ID
Termination ID
Context ID | | + +#### A.17.3.4 Termination heartbeat indication + +When the procedure "Termination heartbeat indication" is required the following procedure is initiated: the MGW sends a NOT.req command with the following information. + +**Table A.17.3.4/1: NOT.req (Termination heartbeat) MGW to MGC** + +| Address Information | Control information | Bearer information | +|----------------------------|------------------------------------------------------------------------------------------------------------------------------|---------------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = bearer1

Event_ID (Event ID = x,
"termination heartbeat") | | + +When the processing of command is complete, the MGC initiates the following procedure. + +**Table A.17.3.4/2: NOT.resp (Termination heartbeat) MGC to MGW** + +| Address Information | Control information | Bearer information | +|----------------------------|-------------------------------------------------------------------|---------------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = bearer1 | | + +The heartbeat timer shall be configured to a value much greater than the mean call holding time. + +The MGCF is in charge of correcting any detected mismatch, by subtracting hanging terminations or clearing hanging contexts as specified for the hanging termination detection procedure in 3GPP TS 29.163 [4]. + +### A.17.4 BICC Terminations Procedures + +#### A.17.4.1 Procedures related to a termination towards BICC + +**Table A.17.4.1/1: Correspondence between ITU-T Recommendation Q.1950 [14] or 3GPP TS 29.232 [5] call-related transactions and 3GPP TS 29.163 [4] procedures related to a termination towards a BICC network** + +| Procedure defined in 3GPP TS 29.163 [4] | Transaction used in Q.1950 [14] | Transaction used in TS 29.232 [5] | Support | Comment | +|-----------------------------------------|---------------------------------|-----------------------------------------|-------------------|-------------------------------------------------------------------------------------------------| +| Establish Bearer | Establish_BNC_Notify +(tunnel) | Establish Bearer (NOTE 1) | Optional (NOTE 5) | | +| Prepare Bearer | Prepare_BNC_Notify +(tunnel) | Prepare Bearer (NOTE 1), (NOTE 2) | Optional (NOTE 5) | | +| Change Through-Connection | n. a. for reuse | Change Through-Connection | Optional (NOTE 5) | only the Explicit (MGC Controlled Cut-Through) procedure is supported (NOTE 3) | +| Release Bearer | n. a. for reuse | Release Bearer | Optional (NOTE 5) | | +| Release Termination | n. a. for reuse | Release Termination | Optional (NOTE 5) | Includes Subtract in the transaction. Statistics about "Ctmbits" are not applicable in Sub.resp | +| Bearer Established | n. a. for reuse | Bearer Established | Optional (NOTE 5) | | +| Bearer Released | n. a. for reuse | Bearer Released | Optional (NOTE 5) | | +| Send Tone | n. a. for reuse | Send Tone | Optional (NOTE 5) | | +| Stop Tone | n. a. for reuse | Stop Tone | Optional (NOTE 5) | | +| Tone Completed | n. a. for reuse | Tone Completed | Optional (NOTE 5) | | +| Play Announcement | n. a. for reuse | Play Announcement | Optional (NOTE 5) | | +| Stop Announcement | n. a. for reuse | Stop Announcement | Optional (NOTE 5) | | +| Announcement Completed | n. a. for reuse | Announcement Completed n | Optional (NOTE 5) | | +| Bearer Modification Support | Not defined | Bearer Modification Support | Optional (NOTE 5) | | +| Confirm Char | Confirm_Char | Confirm Bearer Characteristics (NOTE 1) | Optional (NOTE 6) | | +| Modify Bearer Characteristics | Modify Char | Modify Bearer Characteristics (NOTE 1) | Optional (NOTE 6) | | +| Reserve Char | Reserve_Char_Notify | Reserve Bearer Characteristics (NOTE 1) | Optional (NOTE 6) | | +| Bearer Modified | BNC Modified | Bearer Modified | Optional (NOTE 6) | | +| Activate Voice Processing Function | n. a. for reuse | Activate Voice Processing Function | Optional (NOTE 5) | | +| Tunnel Information Down | Tunnel (MGC-MGW) | Tunnel Information Down | Optional (NOTE 7) | For IP Transport at BICC termination | +| Tunnel Information Up | Tunnel (MGW-MGC) | Tunnel Information Up | Optional (NOTE 7) | For IP Transport at BICC termination | +| Termination heartbeat | Not defined | Termination heartbeat indication | Mandatory | | +| Not defined | Not defined | TFO Activation | Optional | | +| Not defined | Not defined | Codec Modify | Optional | | +| Not defined | Not defined | Optimal Codec and Distant List_Notify | Optional | | +| Not defined | Not defined | Distant Codec List | Optional | | +| Not defined | Not defined | TFO status Notify | Optional | | +| Not defined | Not defined | TFO status | Optional | | + +| | | +|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NOTE 1: | The procedure is only applicable if the Nb framing protocol is applied at the BICC termination. Only requesting of Observed events defined in the corresponding TS 29.232 and parameters defined in the "3GUP" package of TS 29.232 are applicable in addition the parameters of the corresponding Q.1950 procedure. Those parameters shall be applies as follows: UP mode = Supported mode; UP versions = 2; interface = CN; | +| NOTE 2: | Parameters and Observed events defined for Cellular Text telephone Modem Text Transport in the corresponding procedure of TS 29.232 are not applicable. | +| NOTE 3: | VOID | +| NOTE 4: | VOID | +| NOTE 5: | Necessary for optional terminations towards BICC | +| NOTE 6: | Optional for optional terminations towards BICC | +| NOTE 7: | Necessary for optional terminations towards BICC network with IP transport | + +### A.17.5 Multiplex Termination Procedures + +#### A.17.5.1 Procedures related to a Multiplex termination + +**Table A.17.5.1/1: Correspondence between ITU-T Recommendation Q.1950 [14] or 3GPP TS 29.232 [5] call-related transactions and 3GPP TS 29.163 [4] procedures related to a multiplex termination** + +| Procedure defined in 3GPP TS 29.163 [4] | Transaction used in Q.1950 [14] | Transaction used in TS 29.232 [5] | Support | Comment | +|--------------------------------------------------------|---------------------------------|-----------------------------------|-------------------|---------------| +| Add Multiplex Termination | Not defined | Not defined | Optional (NOTE 1) | See A.17.5.2 | +| Configure Multiplex Termination | Not defined | Not defined | Optional (NOTE 1) | See A.17.5.3 | +| Signal H245 Message | Not defined | Not defined | Optional (NOTE 1) | See A.17.5.4 | +| Notify H245 message | Not defined | Not defined | Optional (NOTE 1) | See A.17.5.5 | +| Notify MONA Preference Reception | Not defined | Not defined | Optional (NOTE 1) | See A.17.5.6 | +| Notify MONA Preference Completed | Not defined | Not defined | Optional (NOTE 1) | See A.17.5.7 | +| Signal SPC | Not defined | Not defined | Optional (NOTE 1) | See A.17.5.8 | +| Notify SPC | Not defined | Not defined | Optional (NOTE 1) | See A.17.5.9 | +| Notify MPC | Not defined | Not defined | Optional (NOTE 1) | See A.17.5.10 | +| Notify Detection of Legacy Interworking | Not defined | Not defined | Optional (NOTE 1) | See A.17.5.11 | +| Stop MPC | Not defined | Not defined | Optional (NOTE 1) | See A.17.5.12 | +| Stop SPC | Not defined | Not defined | Optional (NOTE 1) | See A.17.5.13 | +| Stop MONA Negotiation | Not defined | Not defined | Optional (NOTE 1) | See A.17.5.14 | +| NOTE 1: Necessary for interworking of multimedia calls | | | | | + +#### A.17.5.2 Add Multiplex Termination + +When the procedure "Add Multiplex Termination" is required the following procedure is initiated: + +The MGCF sends an Add.req command with the following information. + +- 1 Add.req (Add Multiplex Termination) MGCF to IM-MGW + +**Table A.17.5.2/1: Add Multiplex Termination Request** + +| Address Information | Control information | Bearer information | +|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| |

Transaction ID = z
Context ID = c1
Termination ID = ?

Muxdescriptor

If MONA procedures not supported:
NotificationRequested (Event ID = x,
"Incoming H245 message")

If MONA procedures supported:
NotificationRequested (Event ID = x,
"Incoming H245 message
(SPC=Both)")

NotificationRequested (Event ID = x,
"termination heartbeat")

If indication on Bearer Released
requested:
NotificationRequested (Event ID = x,
"BNC Release (Cause)") – as
defined in ITU-T
Recommendation Q.1950

If MONA procedures supported:
Signal = Outgoing MONA
preferences
(Outgoing MONA preference
content) (NOTE)
NotificationRequested (Event ID
= x,
"MONA Preference recv")

NotificationRequested (Event ID
= x,
"MONA Preference completed")

NotificationRequested (Event ID
= x,
"Legacy Interworking Detected"
(Signal = Outgoing H245
message
(Outgoing H.245 message content)
) )

NotificationRequested (Event ID
= x,
"Mona Preference Channel
reception")

Signal = Forward media in MPC
(MPC MUX Code)

Incoming Multiplex Table

| | + +NOTE: The frequent retransmissions of MONA preference messages required by MONA procedures are to be performed by the IM-MGW autonomously to avoid unnecessary load at the Mn interface and the MGCF. + +On receipt of this procedure, and the setting of the muxdescriptor, the IM-MGW shall initiate the H.324 negotiation, with connection mode H.324M and predefined Highest Multiplexing Level. + +When the processing of command (1) is complete, the IM-MGW initiates the following procedure. + +##### 2 Add.resp (Add Multiplex Termination Ack) + +**Table A.17.5.2/2: Add Multiplex Termination Acknowledge** + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = mux1 | | + +#### A.17.5.3 Configure Multiplex Termination + +When the procedure "Configure Multiplex Termination" is required the following procedure is initiated: + +The MGCF sends an Mod.req command with the following information. + +##### 1 Mod.req (Configure Multiplex Termination) MGCF to IM-MGW + +**Table A.17.5.3/1: Configure Multiplex Termination Request** + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = mux1

If MONA completed or MONA not supported:
Remote H223 Capability
Incoming Multiplex table
Outgoing Multiplex table

If MONA MPC sending is requested:
Signal = Forward media in MPC
(MPC MUX Code) | | + +When the processing of command (1) is complete, the IM-MGW initiates the following procedure. + +##### 2 Mod.resp (Configure Multiplex Termination Ack) + +**Table A.17.5.3/2: Configure Multiplex Termination Acknowledge** + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = mux1 | | + +#### A.17.5.4 Signal H245 Message + +When the procedure "Signal H245 Message" is required the following procedure is initiated: + +The MGCF sends an Mod.req command with the following information. + +##### 1 Mod.req (Signal H245 Message) MGCF to IM-MGW + +**Table A.17.5.4/1: Signal H245 Message Request** + +| Address Information | Control information | Bearer information | +|---------------------|------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = mux1

Signal = Outgoing H245 message
(Outgoing H.245 message content) | | + +When the processing of command (1) is complete, the IM-MGW initiates the following procedure. + +##### 2 Mod.resp (Signal H245 Message Ack) + +**Table A.17.5.4/2: Signal H245 Message Acknowledge** + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = mux1 | | + +#### A.17.5.5 Notify H.245 Message + +When the procedure "Notify H.245 message" is required the following procedure is initiated: the IM-MGW sends a NOT.req command with the following information. + +##### 1 Not.req (Notify H245 Message) IM-MGW to MGCF + +**Table A.17.5.5/1: Notify H245 Message Request** + +| Address Information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = mux1
Event_ID (Event ID = x,
"Incoming H245 message
(H245 message content)") | | + +When the processing of command is complete, the MGCF initiates the following procedure. + +##### 2 Not.resp (Notify H245 Message Ack) MGCF to IM-MGW + +**Table A.17.5.5/2: Notify H245 Message Acknowledge** + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = mux1 | | + +#### A.17.5.6 Notify MONA Preference Reception + +When the procedure "Notify MONA Preference Reception" is required the following procedure is initiated: the IM-MGW sends a NOT.req command with the following information. + +##### 1 Not.req (Notify MONA Preference Reception) IM-MGW to MGCF + +**Table A.17.5.6/1: Notify MONA Preference Reception Request** + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = mux1
Event_ID (Event ID = x,
"MONA Preference recv
(MONA preference message
content)") | | + +When the processing of command is complete, the MGCF initiates the following procedure. + +2 Not.resp (Notify MONA Preference Reception) MGCF to IM-MGW + +**Table A.17.5.6/2: Notify MONA Preference Reception Acknowledge** + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = mux1 | | + +#### A.17.5.7 Notify MONA Preference Completed + +When the procedure "Notify MONA Preference Completed" is required the following procedure is initiated: the IM-MGW sends a NOT.req command with the following information. + +1 Not.req (Notify MONA Preference Completed) IM-MGW to MGCF + +**Table A.17.5.7/1: Notify MONA Preference Completed Request** + +| Address Information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = mux1
Event_ID (Event ID = x,
"MONA Preference
completed ") | | + +When the processing of command is complete, the MGCF initiates the following procedure. + +2 Not.resp (Notify MONA Preference Completed) MGCF to IM-MGW + +**Table A.17.5.7/2: Notify MONA Preference Completed Acknowledge** + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = mux1 | | + +#### A.17.5.8 Signal SPC + +When the procedure "Signal SPC" is required the following procedure is initiated: + +The MGCF sends an Mod.req command with the following information. + +1 Mod.req (Signal SPC) MGCF to IM-MGW + +**Table A.17.5.8/1: Signal SPC Request** + +| Address Information | Control information | Bearer information | +|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = mux1

Signal = Outgoing H245 message
(Outgoing H.245 message content,
SPC Out=ON) | | + +When the processing of command (1) is complete, the IM-MGW initiates the following procedure. + +##### 2 Mod.resp (Signal SPC Ack) + +**Table A.17.5.8/2: Signal SPC Acknowledge** + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = mux1 | | + +#### A.17.5.9 Notify SPC + +When the procedure "Notify SPC" is required the following procedure is initiated: the IM-MGW sends a NOT.req command with the following information. + +##### 1 Not.req (Notify SPC) IM-MGW to MGCF + +**Table A.17.5.9/1: Notify SPC Request** + +| Address Information | Control information | Bearer information | +|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = mux1
Event_ID (Event ID = x,
"Incoming H245 message
(H245 message content, SPC
In=ON)") | | + +When the processing of command is complete, the MGCF initiates the following procedure. + +##### 2 Not.resp (Notify SPC Ack) MGCF to IM-MGW + +**Table A.17.5.9/2: Notify SPC Acknowledge** + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = mux1 | | + +#### A.17.5.10 Notify MPC + +When the procedure "Notify MPC" is required the following procedure is initiated: the IM-MGW sends a NOT.req command with the following information. + +##### 1 Not.req (Notify MPC) IM-MGW to MGCF + +**Table A.17.5.10/1: Notify MPC Request** + +| Address Information | Control information | Bearer information | +|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = mux1
Event_ID (Event ID = x,
"Mona Preference Channel
reception (Muxcode)") | | + +When the processing of command is complete, the MGCF initiates the following procedure. + +2 Not.resp (Notify MPC Ack) MGCF to IM-MGW + +**Table A.17.5.10/2: Notify MPC Acknowledge** + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = mux1 | | + +#### A.17.5.11 Notify Detection of Legacy Interworking + +When the procedure "Notify Detection of Legacy Interworking " is required the following procedure is initiated: the IM-MGW sends a NOT.req command with the following information. + +1 Not.req (Notify Detection of Legacy Interworking) IM-MGW to MGCF + +**Table A.17.5.11/1: Notify Detection of Legacy Interworking Request** + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = mux1
Event_ID (Event ID = x,
"Legacy Interworking
Detected ") | | + +When the processing of command is complete, the MGCF initiates the following procedure. + +2 Not.resp (Notify Detection of Legacy Interworking ) MGCF to IM-MGW + +**Table A.17.5.11/2: Notify Detection of Legacy Interworking Acknowledge** + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = mux1 | | + +#### A.17.5.12 Stop MPC + +When the procedure "Stop MPC" is required the following procedure is initiated: + +The MGCF sends an Mod.req command with the following information. + +1 Mod.req (Stop MPC) MGCF to IM-MGW + +**Table A.17.5.12/1: Stop MPC Request** + +| Address Information | Control information | Bearer information | +|---------------------|---------------------|--------------------| +|---------------------|---------------------|--------------------| + +| | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | Transaction ID = z
Context ID = c1
Termination ID = mux1

Signal = x, NOTE 1

NotificationRequested (Event ID = x,
NOTE 2 ) | | +| NOTE 1: The signal descriptor shall not include the "Forward media in MPC" signal.
NOTE 2: The event descriptor shall not include the "Mona Preference Channel reception" event. | | | + +When the processing of command (1) is complete, the IM-MGW initiates the following procedure. + +##### 2 Mod.resp (Stop MPC Ack) + +**Table A.17.5.12/2: Stop MPC Acknowledge** + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = mux1 | | + +#### A.17.5.13 Stop SPC + +When the procedure "Stop SPC" is required the following procedure is initiated: + +The MGCF sends a Mod.req command with the following information. + +##### 1 Mod.req (Stop SPC)MGCF to IM-MGW + +**Table A.17.5.13/1: Stop SPC Request** + +| Address Information | Control information | Bearer information | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = mux1

If legacy H.245 or accelerated H.245 required:
Signal = Outgoing H245 message
(Outgoing H.245 message content, SPC Out=OFF)

NotificationRequested (Event ID =
x, "Incoming H245 message
(SPC=H245)") NOTE 3

If legacy H.245 or accelerated H.245 not required:
Signal = x, NOTE 1

NotificationRequested (Event ID =
x,
NOTE 2 ) | | +| NOTE 1: The signal descriptor shall not include the "Outgoing H.245 message" signal.
NOTE 2: The event descriptor shall not include the "Incoming H.245 message" event.
NOTE 3: SPC parameter may be omitted, as SPC=H245 is the default value. | | | + +When the processing of command (1) is complete, the IM-MGW initiates the following procedure. + +##### 2 Mod.resp (Stop SPC Ack) + +**Table A.17.5.13/2: Stop SPC Acknowledge** + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = mux1 | | + +#### A.17.5.14 Stop MONA Negotiation + +When the procedure "Stop MONA negotiation" is required the following procedure is initiated: + +The MGCF sends a Mod.req command with the following information. + +##### 1 Mod.req (Stop MONA Negotiation) MGCF to IM-MGW + +**Table A.17.5.14/1: Stop MONA Negotiation Request** + +| Address Information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = mux1

Signal = x, NOTE 1

NotificationRequested (Event ID = x, NOTE 2 )

If legacy H.245 or accelerated H.245 required:
Signal = Outgoing H245 message
(Outgoing H.245 message content, SPC Out=OFF)

NotificationRequested (Event ID =
x, "Incoming H245 message
(SPC=H245)") NOTE 3 | | + +NOTE 1: The signal descriptor shall not include any of the signals "Outgoing MONA preferences" and "Forward media in MPC". If legacy H.245 or accelerated H.245 is not required the signal descriptor shall also not include the "Outgoing H.245 message" signal. + NOTE 2: The event descriptor shall not include any of the events "MONA Preference recv", "MONA Preference completed" and "Mona Preference Channel reception". If legacy H.245 or accelerated H.245 is not required the event descriptor shall also not include the "Incoming H.245 message" event. + NOTE 3: SPC parameter may be omitted, as SPC=H245 is the default value. + +When the processing of command (1) is complete, the IM-MGW initiates the following procedure. + +##### 2 Mod.resp (Stop MONA Negotiation Ack) + +**Table A.17.5.14/2: Stop MONA Negotiation Acknowledge** + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = mux1 | | + +### A.17.6 SIP-I on Nc Terminations Procedures + +#### A.17.6.1 Summary of Procedures related to a termination towards SIP-I on Nc CN Subsystem + +The interworking between IMS domain and SIP-I on Nc is specified by 3GPP TS 29.235 [47] which requires the procedures for SIP-I on Nc as specified in 3GPP TS 23.231 [48] Clause 15.2. + +Table A.17.6.1/1 shows the relationship between each call-related procedure in ITU-T Recommendation Q.1950 [14] (see 3GPP TS 29.205 [3]) or TS 29.232 [5] and the corresponding stage 2 procedure defined in 3GPP TS 23.231 [48]. + +**Table A.17.6.1/1: Correspondence between ITU-T Recommendation Q.1950 [14] or 29.232 [5] call-related transactions and 3GPP TS 23.231 [48] procedures** + +| Procedure defined in 3GPP TS 23.231 [48] | Transaction used in Q.1950 [14] | Transaction used in TS 29.232 [5] | Supported | Comment | +|--------------------------------------------|---------------------------------|-----------------------------------------------------|-------------------|-------------------------------------------------------------------------------------------------| +| Reserve RTP Connection Point | Not defined | Reserve RTP Connection Point (NOTE 2) | Optional (NOTE1) | See A.17.2. 2 | +| Configure RTP Connection Point | Not Defined | Configure RTP Connection Point (NOTE 2) | Optional (NOTE1) | See A.17.2. 3 | +| Reserve and Configure RTP Connection Point | Not defined | Reserve and Configure RTP Connection Point (NOTE 2) | Optional (NOTE1) | See A.17.2. 4 | +| Release Termination | n. a. for reuse | Release Termination | Mandatory | Includes Subtract in the transaction. Statistics about "Ctmbits" are not applicable in Sub.resp | +| Change Through-Connection | n. a. for reuse | Change Through-Connection | Optional (NOTE 1) | only the Explicit (MGC Controlled Cut-Through) procedure is supported | +| Bearer Released | n. a. for reuse | Bearer Released | Optional (NOTE 1) | | +| Send Tone | n. a. for reuse | Send Tone | Optional (NOTE 1) | | +| Stop Tone | n. a. for reuse | Stop Tone | Optional (NOTE 1) | | +| Tone Completed | n. a. for reuse | Tone Completed | Optional (NOTE 1) | | +| Play Announcement | n. a. for reuse | Play Announcement | Optional (NOTE 1) | | +| Stop Announcement | n. a. for reuse | Stop Announcement | Optional (NOTE 1) | | +| Announcement Completed | n. a. for reuse | Announcement Completed n | Optional (NOTE 1) | | +| Activate Voice Processing Function | n. a. for reuse | Activate Voice Processing Function | Optional (NOTE 1) | | +| Termination heartbeat | Not defined | Termination heartbeat indication | Mandatory | | +| Not defined | Not defined | TFO Activation | Optional | | +| Not defined | Not defined | Codec Modify | Optional | | +| Not defined | Not defined | Optimal Codec and Distant List_Notify | Optional | | +| Not defined | Not defined | Distant Codec List | Optional | | +| Not defined | Not defined | TFO status Notify | Optional | | +| Not defined | Not defined | TFO status | Optional | | + +NOTE 1: Mandatory for connections towards SIP-I on Nc. + +NOTE 2: The existing IMS Connection Point Procedures are functionally similar to these 29.232 procedures as they were derived from the IMS ones. + +# --- Annex B (normative): Void + +--- + +# Annex C (normative): + +Void + +# --- Annex D (informative): Change history + +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | New | +|---------|-------|-----------|------|-----|------------------------------------------------------------------------------------------------|-------| +| 2004-09 | CN#25 | | | | Approved in CN#25 | 6.0.0 | +| 2005-03 | CN#27 | NP-050045 | 001 | 1 | Introduction Of Formal Profile | 6.1.0 | +| | | | 002 | 1 | Corrections to Mn Specification | | +| 2005-06 | CT#28 | CP-050208 | 0001 | 4 | Introduction Of Formal Profile | 6.2.0 | +| | | CP-050208 | 0005 | | Inclusion of Insert Digit Procedure at IMS termination | | +| 2005-09 | CT#29 | CP-050442 | 0007 | 3 | Alignment of Mn Profile with ITU template and Mc interface decisions | 6.3.0 | +| | | CP-050454 | 0008 | 3 | Alignment of Mn Profile with TISPAN TMGW | 7.0.0 | +| 2005-12 | CT#30 | CP-050630 | 0015 | 3 | Clean-up of hanging contexts and terminations | 7.1.0 | +| | | CP-050619 | 0017 | 1 | Addition of TFO procedure | | +| | | CP-050630 | 0019 | 2 | Add virtual media gateway function | | +| | | CP-050619 | 0022 | | Alignment with TISPAN | | +| | | CP-050619 | 0023 | | Open Mn | | +| 2006-03 | CT#31 | CP-060077 | 0024 | 1 | Add the UDPTL/TCPTL transport and mediatype for T.38 | 7.2.0 | +| | | CP-060077 | 0026 | 2 | Clarification the SDP used in the BICC termination | | +| | | CP-060077 | 0028 | | Remove the redundant symbols | | +| | | CP-060066 | 0030 | 1 | Bearer Released Event to Reserve TDM Circuit procedure | | +| | | CP-060066 | 0032 | 1 | BICC packages in Mn profile | | +| | | CP-060066 | 0034 | | Service Change Method "Disconnected" and "Failover" removal from Service Changes sent by MGCF | | +| 2006-06 | CT#32 | CP-060314 | 0037 | 1 | Alignment with TISPAN TGW profile | 7.3.0 | +| | | CP-060306 | 0036 | 1 | Corrections to Mn Specification for Inter Vendor Operability | | +| | | | 0041 | | Update of Mn profile with packages defined in 29.232 | | +| | | | 0044 | 1 | Adding of Bearer Released Event to Procedures related to a termination towards IM CN Subsystem | | +| | | | 0046 | 1 | Mode-change-period support on Mn interface | | +| 2006-09 | CT#33 | CP-060401 | 0048 | 1 | AuditValue procedure | 7.4.0 | +| | | CP-060410 | 0051 | | Alignment Mn towards TISPAN Endorsement | | +| | | CP-060410 | 0052 | 2 | Removal of duplicated functionality in body of specification | | +| | | CP-060401 | 0053 | 1 | Definition of the use of mandatory and optional in Mn Profile Template | | +| | | CP-060401 | 0054 | 1 | Missing Procedures Towards IMS | | +| | | CP-060410 | 0055 | 2 | Correction to Terminations chapter | | +| | | CP-060401 | 0058 | 1 | Corrections to Profile Description: Descriptors | | +| | | CP-060401 | 0060 | | Corrections to Profile Description: Command API | | +| | | CP-060401 | 0062 | 1 | Corrections to Profile Description: Packages | | +| 2006-12 | CT#34 | CP-060570 | 0068 | 1 | Alignment of Mn towards TISPAN Endorsement | 7.5.0 | +| | | CP-060570 | 0069 | 1 | Setting of 3GPP mandatory parameters to conditional | | +| | | CP-060570 | 0074 | | CR miss implementation Call independent procedures and packages | | +| | | CP-060570 | 0075 | 2 | Removal of TBD for Number of Commands Per Transaction | | +| | | CP-060570 | 0080 | | Missing Procedures Towards IMS | | +| | | CP-060725 | 0071 | 1 | Profile registration procedure | | +| | | CP-060725 | 0073 | 2 | Rules for SDP equivalents | | +| | | CP-060725 | 0077 | 3 | Codec Parameters | | +| 2007-03 | CT#35 | CP-070013 | 0081 | 1 | Further Alignment of Mn Towards TISPAN Endorsement | 7.6.0 | +| 2007-06 | CT#36 | CP-070323 | 0087 | 1 | Addition of missing references and text corrections | 7.7.0 | +| | | CP-070434 | 0088 | 3 | Multimedia interworking Mn procedures | | +| | | CP-070323 | 0089 | 1 | Wrong implementation of CP-060401 / C4-060998 (CR 0048r1 29.332 Rel-7) | | +| | | CP-070315 | 0091 | | RFC 3309 for SCTP checksum | | +| 2007-09 | CT#37 | CP-070538 | 0092 | 1 | Corrections to Multimedia Interworking | 7.8.0 | +| | | | 0094 | 3 | Service Change Methods and Reasons | | +| | | | 0095 | | Correction to Package Ids | | +| | | | 0097 | | Priority Indicator in Context Attributes | | +| | | | 0099 | 1 | H.248 Message Encoding | | +| | | | 0101 | 2 | Correction to Reuse of Procedures | | +| | | | 0103 | 1 | Correction to Signals Descriptor | | +| | | | 0105 | 1 | Correction to Events Descriptor | | +| | | | 0107 | 1 | Clarification of Message Identifier | | +| | | | 0110 | 1 | IP realm connection indication | | +| | | | 0111 | 2 | Correction of parameter in Sending H.245 Message | | +| | | | 0112 | 2 | Mn profile corrections | | +| | | | 0117 | 1 | Corrections to maxptime syntax in SDP of encoding of AMR codec | | +| 2007-12 | CT#38 | CP-070742 | 0123 | 1 | Properties returned in commands | 7.9.0 | +| | | CP-070746 | 0119 | 1 | Inactivity timeout procedures – Alignment to Mc profile | | +| | | CP-070746 | 0125 | 1 | Audit of individual TDM terminations | | +| 2007-12 | CT#38 | CP-070757 | 0118 | | Termination heartbeat – Alignment to Mc profile | 8.0.0 | +| 2008-03 | CT#39 | CP-080023 | 0126 | | IP version in SDP C | 8.1.0 | +| | | CP-080012 | 0129 | 1 | Correction on the Mn profile: BNC Release event | | +| 2008-06 | CT#40 | CP-080272 | 0130 | | Updating Mn interface profile "threegimsctiw" to version 3 | 8.2.0 | +| 2008-09 | CT#41 | CP-080469 | 0131 | 2 | Mona H.248 package definitions | 8.3.0 | + +| | | | | | | | +|---------|--------|-----------|------|----|--------------------------------------------------------------------------------------------|--------| +| | | CP-080454 | 0134 | | Service Change Reason in (G)MSC Server Out of Service | | +| 2008-12 | CT#42 | CP-080704 | 0135 | 1 | Mona H.248 package definitions update | 8.4.0 | +| | | CP-080704 | 0136 | | Mn profile update for Mona H.248 package definitions | | +| | | CP-080701 | 0137 | 1 | Clarification of RTCP messages usage in the interworking gateways | | +| | | CP-080686 | 0138 | 3 | Alignment of stage 3 MGCF-IM_MGW protocol with Stage 2 for SIP-I on Nc interworking to IMS | | +| 2009-03 | CT#43 | CP-090031 | 0139 | 1 | Mn profile update for H.245 and RTCP Interactions H.248 package definitions | 8.5.0 | +| | | | 0140 | | Updating H.248.12 amendment 2 to reference list | | +| 2009-06 | CT#44 | CP-090298 | 0141 | 1 | Update of stage 3 MONA to newest H.248.72 (ex. H.248.MONA) draft | 8.6.0 | +| | | | 0142 | | Update of MONA stage 3 due to MONA procedures stage 2 changes | | +| 2009-12 | CT#46 | CP-090967 | 0147 | | Correction to Profile for Commands marked optional | 8.7.0 | +| | | CP-090763 | 0148 | | Commands Using IP Interface Type | | +| 2009-12 | CT#46 | | | | Upgraded unchanged from Rel-8 | 9.0.0 | +| 2010-03 | CT#47 | CP-100028 | 0152 | | MONA H.248 package update | 9.1.0 | +| | | CP-100028 | 0154 | 1 | ASN.1 encoding of RTCP Feedback Message package | | +| | | CP-100028 | 0157 | | MONA alignments to H.324 | | +| | | CP-100037 | 0150 | 1 | Global Text Telephony Interworking between IMS and Circuit Switched | | +| | | CP-100037 | 0155 | 1 | Resolution of External TISPAN Referencing | | +| 2010-09 | CT#47 | CP-100450 | 0159 | - | ITU-T H.248.71 and H.248.72 publication | 9.2.0 | +| 2011-03 | CT#51 | CP-110276 | 0160 | 10 | ECN Support in Mn Interface | 10.0.0 | +| | | CP-110070 | 0161 | 1 | Complete Inactivity Timeout Indication Procedure | | +| | | CP-110058 | 0163 | 1 | Handling of rtcp-fb SDP attribute and SDP attribute for RTCP APP feedback messages | | +| 2011-06 | CT#52 | CP-110352 | 0168 | 1 | Missing Tone Completed procedures | 10.1.0 | +| | | CP-110368 | 0165 | 1 | ECN Failure improvements | | +| | | CP-110368 | 0170 | 1 | Alignment of 3GPP profiles with SG16 ECN package definition | | +| 2011-09 | CT#53 | CP-110568 | 0171 | 1 | Solving Incorrect references | 10.2.0 | +| 2011-12 | CT#54 | CP-110798 | 0172 | - | Explicit Congestion Notification | | +| | | CP-110789 | 0173 | 1 | Reference update: 26.114 | 10.3.0 | +| 2012-06 | CT#56 | CP-120226 | 0175 | 1 | Reference update: draft-ietf-avtcore-ecn-for-rtp | 10.4.0 | +| | | | | | Editorial fix to history table | 10.4.1 | +| 2012-09 | CT#57 | CP-120443 | 0181 | - | Reference alignment for RTP Payload Format for AMR and AMR-WB Audio Codecs | 10.5.0 | +| 2012-09 | CT#57 | CP-120478 | 0176 | 3 | Support of Multimedia Priority Service (MPS) over Mn Interface – Stage 3 | 11.0.0 | +| | | CP-120684 | 0178 | 1 | Support of T.38 related SDP attributes | | +| 2012-12 | CT#58 | CP-120723 | 0185 | - | Mn interface updates of ECN Support Package | 11.1.0 | +| | | CP-120738 | 0186 | - | T.38 default version | | +| 2013-03 | CT#59 | CP-130013 | 0192 | 1 | Support of RTCP-FB for MTSI | 11.2.0 | +| 2013-06 | CT#60 | CP-130294 | 0188 | 2 | ECN relying reference change | 11.3.0 | +| 2014-06 | CT#64 | CP-140248 | 0193 | 2 | ICE support in Mn interface | 12.0.0 | +| 2014-06 | CT#66 | CP-140788 | 0194 | 1 | Adding support for EVS codec | 12.1.0 | +| 2015-09 | CT#69 | CP-150430 | 0196 | 1 | Correction on SDP for Real-Time Text | 13.0.0 | +| 2016-03 | CT#71 | CP-160048 | 0197 | - | Removal of references to TS 26.236 | 13.1.0 | +| 2016-03 | CT#71 | CP-160034 | 0198 | 1 | Support of enhanced bandwidth negotiation mechanism for MTSI sessions | 13.1.0 | +| 2016-03 | CT#71 | CP-160021 | 0199 | 1 | Mn stage 3 to support SDP Capability Negotiation | 13.1.0 | +| 2016-06 | CT#72 | CP-160229 | 0200 | - | Rate adaptation clarification | 13.2.0 | +| 2016-06 | CT#72 | CP-160229 | 0201 | - | Clarifications related to the rate adaptation for media endpoints | 13.2.0 | +| 2017-03 | CT#75 | - | - | - | Update to Rel-14 version (MCC) | 14.0.0 | +| 2018-06 | CT#80 | - | - | - | Update to Rel-15 version (MCC) | 15.0.0 | +| 2020-07 | CT#88e | - | - | - | Update to Rel-16 version (MCC) | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29333/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-16/29_series/29333/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d49e3540a43446513db580cd9f1d809969a9fe31 --- /dev/null +++ b/marked/Rel-16/29_series/29333/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f7f715e2d2faf757f420c4ad8f2fce38c94b112a39a53de95d4ea00fab5f1712 +size 9421 diff --git a/marked/Rel-16/29_series/29333/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-16/29_series/29333/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b9b9fc27647616fa64392388e74933741f7837bd --- /dev/null +++ b/marked/Rel-16/29_series/29333/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e9454349a12d8273d142b6eb9eead27caf5fec389f57ab2e78a5f4cbbd1a10dc +size 6510 diff --git a/marked/Rel-16/29_series/29333/e2245b4865907ad1259fd155f4beb6cf_img.jpg b/marked/Rel-16/29_series/29333/e2245b4865907ad1259fd155f4beb6cf_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..70023a06d2833a1df574aa4945f7c8165ab18938 --- /dev/null +++ b/marked/Rel-16/29_series/29333/e2245b4865907ad1259fd155f4beb6cf_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e309b21c735aaf76c0d26e7187108b0ee25233ec708ce485fecc695812a83679 +size 157871 diff --git a/marked/Rel-16/29_series/29333/raw.md b/marked/Rel-16/29_series/29333/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..5d66fa0851726b8fa2faed819dad9e85ac24dd1f --- /dev/null +++ b/marked/Rel-16/29_series/29333/raw.md @@ -0,0 +1,4471 @@ + + +# 3GPP TS 29.333 V16.2.0 (2021-03) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Multimedia Resource Function Controller (MRFC) - Multimedia Resource Function Processor (MRFP) Mp Interface; Stage 3 (Release 16)** + +![LTE Advanced Pro logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for LTE Advanced Pro, featuring the letters 'lte' in a bold, lowercase font. Above the 'e' is the text 'Advanced Pro' in a smaller font. To the right of the 'e' is a green signal icon consisting of three curved lines. + +LTE Advanced Pro logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, featuring the letters '3GPP' in a stylized, bold font. Below the 'P' is a red signal icon consisting of three curved lines. Below the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, uppercase font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +# **3GPP** + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + +--- + + + +# --- ***Copyright Notification*** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2021, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTSTM is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|----------------------------------------------------------|----| +| Foreword ..... | 7 | +| 1 Scope..... | 8 | +| 2 References..... | 8 | +| 3 Definitions and symbols..... | 11 | +| 3.1 Definitions..... | 11 | +| 3.2 Symbols..... | 11 | +| 4. Abbreviations ..... | 12 | +| 5 Profile Description ..... | 13 | +| 5.1 Profile Identification ..... | 13 | +| 5.2 Summary ..... | 13 | +| 5.3 Gateway Control Protocol Version ..... | 13 | +| 5.4 Connection Model..... | 13 | +| 5.5 Context Attributes ..... | 14 | +| 5.6 Terminations..... | 14 | +| 5.6.1 Termination Names ..... | 14 | +| 5.6.1.1 General..... | 14 | +| 5.6.1.2 ASN.1 encoding..... | 14 | +| 5.6.1.3 ABNF encoding..... | 15 | +| 5.6.2 Multiplexed Terminations ..... | 15 | +| 5.7 Descriptors ..... | 15 | +| 5.7.1 Stream Descriptor ..... | 15 | +| 5.7.1.1 LocalControl Descriptor ..... | 15 | +| 5.7.2 Events Descriptor ..... | 16 | +| 5.7.3 EventBuffer Descriptor ..... | 17 | +| 5.7.4 Signals Descriptor ..... | 17 | +| 5.7.5 DigitMap Descriptor..... | 19 | +| 5.7.6 Statistics Descriptor..... | 19 | +| 5.7.7 ObservedEvents Descriptor ..... | 19 | +| 5.7.8 Topology Descriptor..... | 19 | +| 5.7.9 Error Descriptor ..... | 20 | +| 5.8 Command API..... | 20 | +| 5.8.1 Add ..... | 20 | +| 5.8.2 Modify ..... | 20 | +| 5.8.3 Subtract..... | 21 | +| 5.8.4 Move..... | 21 | +| 5.8.5 AuditValue ..... | 22 | +| 5.8.6 AuditCapabilities ..... | 22 | +| 5.8.7 Notify..... | 22 | +| 5.8.8 ServiceChange..... | 23 | +| 5.8.9 Manipulating and Auditing Context Attributes ..... | 24 | +| 5.9 Generic Command Syntax and Encoding ..... | 24 | +| 5.10 Transactions ..... | 24 | +| 5.11 Messages ..... | 25 | +| 5.12 Transport ..... | 25 | +| 5.13 Security..... | 26 | +| 5.14 Packages..... | 26 | +| 5.14.1 Mandatory Packages..... | 26 | +| 5.14.2 Optional Packages ..... | 27 | +| 5.14.3 Package Usage Information..... | 29 | +| 5.14.3.1 Generic Package ..... | 29 | +| 5.14.3.2 Base Root Package..... | 31 | +| 5.14.3.3 Overload Control Package ..... | 32 | +| 5.14.3.4 Network Package ..... | 32 | +| 5.14.3.5 RTP Package..... | 33 | + +| | | | +|-----------|---------------------------------------------------------------------------|----| +| 5.14.3.6 | DTMF Detection Package ..... | 34 | +| 5.14.3.7 | Call Progress Tones Generator Package ..... | 34 | +| 5.14.3.8 | Basic Services Tones Generator Package ..... | 35 | +| 5.14.3.9 | Expanded Call Progress Tones Generator Package ..... | 36 | +| 5.14.3.10 | Basic Announcement Syntax Package ..... | 36 | +| 5.14.3.11 | Voice Variable Syntax Package ..... | 37 | +| 5.14.3.12 | Announcement Set Syntax Package ..... | 37 | +| 5.14.3.13 | General Text Variable Type Package ..... | 38 | +| 5.14.3.14 | Advanced Audio Server Base Package ..... | 38 | +| 5.14.3.15 | Basic Call Progress Tones Generator with Directionality ..... | 39 | +| 5.14.3.16 | AAS Recording Package ..... | 40 | +| 5.14.3.17 | Multimedia Play Package ..... | 41 | +| 5.14.3.18 | Generic Announcement Package ..... | 41 | +| 5.14.3.19 | Intrusion Tones Generator Package ..... | 42 | +| 5.14.3.20 | Business Tones Generation Package ..... | 43 | +| 5.14.3.21 | Conferencing Tones Generation Package ..... | 43 | +| 5.14.3.22 | Inactivity Timer Package ..... | 44 | +| 5.14.3.23 | MGC Information Package ..... | 44 | +| 5.14.3.24 | Advanced audio server base package for TTS enhancement ..... | 45 | +| 5.14.3.25 | ASR Package ..... | 46 | +| 5.14.3.26 | Multimedia Recording Package ..... | 47 | +| 5.14.3.27 | Tone Generator Package ..... | 47 | +| 5.14.3.28 | Hanging Termination Detection Package ..... | 48 | +| 5.14.3.29 | MSRP Statistics Package ..... | 48 | +| 5.14.3.30 | Play Message Package ..... | 49 | +| 5.14.3.31 | Message Filtering Package ..... | 50 | +| 5.14.3.32 | Record Message Package ..... | 51 | +| 5.14.3.33 | Floor Control Package ..... | 52 | +| 5.14.3.34 | Floor Control Policy Package ..... | 52 | +| 5.14.3.35 | Floor Status Change Handling Package ..... | 53 | +| 5.14.3.36 | Floor Control Signalling Package ..... | 53 | +| 5.14.3.37 | Explicit Congestion Notification for RTP-over-UDP Support (ecnrous) ..... | 55 | +| 5.14.3.38 | Differentiated Services (ds) ..... | 56 | +| 5.14.3.39 | MG Act-as STUN Server (mgastuns) ..... | 56 | +| 5.14.3.40 | Originate STUN Continuity Check (ostuncc) ..... | 57 | +| 5.14.3.41 | TCP basic connection control (tcpbcc) ..... | 58 | +| 5.14.3.42 | TLS basic session control (tlsbcc) ..... | 59 | +| 5.14.3.45 | Remote Pause and Resume (rempr) ..... | 61 | +| 5.14.3.46 | Multi-stream Multiparty Conferencing Media Handling (mmcmh) ..... | 63 | +| 5.15 | Mandatory Support of SDP and Annex C Information Elements ..... | 63 | +| 5.16 | Optional support of SDP and Annex C information elements ..... | 69 | +| 5.17 | Procedures ..... | 69 | +| 5.17.1 | Formats and Codes ..... | 69 | +| 5.17.2 | Call Related Procedures ..... | 74 | +| 5.17.2.1 | General ..... | 74 | +| 5.17.2.2 | Reserve IMS Resources ..... | 76 | +| 5.17.2.3 | Configure IMS Resources ..... | 79 | +| 5.17.2.4 | Reserve and Configure IMS Resources ..... | 84 | +| 5.17.2.5 | Release IMS Termination ..... | 89 | +| 5.17.2.6 | Send Tone ..... | 90 | +| 5.17.2.7 | Stop Tone ..... | 91 | +| 5.17.2.8 | Tone Completed ..... | 92 | +| 5.17.2.9 | Start Announcement ..... | 92 | +| 5.17.2.10 | Stop Announcement ..... | 93 | +| 5.17.2.11 | Announcement Completed ..... | 93 | +| 5.17.2.12 | Start TTS ..... | 94 | +| 5.17.2.13 | Stop TTS ..... | 95 | +| 5.17.2.14 | TTS Completed ..... | 95 | +| 5.17.2.15 | Start Audio Record ..... | 95 | +| 5.17.2.16 | Stop Audio Record ..... | 96 | +| 5.17.2.17 | Audio Record Complete ..... | 97 | +| 5.17.2.18 | Detect DTMF ..... | 97 | + +| | | | +|-----------|-------------------------------------------------------------|-----| +| 5.17.2.19 | Report DTMF ..... | 98 | +| 5.17.2.20 | Stop DTMF Detection ..... | 98 | +| 5.17.2.21 | ASR Request..... | 99 | +| 5.17.2.22 | ASR Completed ..... | 100 | +| 5.17.2.23 | Stop ASR ..... | 100 | +| 5.17.2.24 | Start Playing Multimedia ..... | 101 | +| 5.17.2.25 | Stop Playing Multimedia ..... | 102 | +| 5.17.2.26 | Playing Multimedia Completed..... | 102 | +| 5.17.2.27 | Start Multimedia Record..... | 103 | +| 5.17.2.28 | Stop Multimedia Record..... | 104 | +| 5.17.2.29 | Multimedia Record Completed..... | 104 | +| 5.17.2.30 | Adhoc Audio Conference ..... | 105 | +| 5.17.2.31 | Multi-Media Conferencing ..... | 105 | +| 5.17.2.32 | Termination heartbeat indication ..... | 105 | +| 5.17.2.33 | Configure BFCP Termination..... | 106 | +| 5.17.2.34 | Configure Conference..... | 108 | +| 5.17.2.35 | Designate Floor Chair..... | 108 | +| 5.17.2.36 | Floor Request Decision..... | 109 | +| 5.17.2.37 | Report Floor Request Decision..... | 110 | +| 5.17.2.38 | Modify Media ..... | 110 | +| 5.17.2.39 | Confirm Media Update ..... | 111 | +| 5.17.2.40 | Start Playing Message..... | 111 | +| 5.17.2.41 | Stop Playing Message..... | 112 | +| 5.17.2.42 | Playing Message Completed..... | 112 | +| 5.17.2.43 | Start Message Record ..... | 113 | +| 5.17.2.44 | Stop Message Record..... | 114 | +| 5.17.2.45 | Message Record Completed ..... | 114 | +| 5.17.2.46 | Configure Granted Quota..... | 115 | +| 5.17.2.47 | Report Message Statistics ..... | 116 | +| 5.17.2.48 | Configure Filtering Rules ..... | 116 | +| 5.17.2.49 | ECN Failure Indication ..... | 117 | +| 5.17.2.50 | ICE Connectivity Check Result Notification..... | 118 | +| 5.17.2.51 | ICE New Peer Reflexive Candidate Notification ..... | 118 | +| 5.17.2.52 | Notify TCP connection establishment Failure Indication..... | 118 | +| 5.17.2.53 | Notify TLS session establishment Failure Indication..... | 119 | +| 5.17.3 | Non-Call Related Procedures ..... | 120 | +| 5.17.3.1 | General..... | 120 | +| 5.17.3.2 | MRFP Out Of Service..... | 121 | +| 5.17.3.3 | MRFP Communication Up ..... | 121 | +| 5.17.3.4 | MRFP Register ..... | 122 | +| 5.17.3.5 | MRFC Restoration..... | 122 | +| 5.17.3.6 | MRFP Re-Register..... | 123 | +| 5.17.3.7 | MRFC Ordered Re-register ..... | 123 | +| 5.17.3.8 | Audit Value..... | 124 | +| 5.17.3.9 | Audit Capabilities ..... | 125 | +| 5.17.3.10 | Capability Update ..... | 125 | +| 5.17.3.11 | MRFC Out of Service..... | 126 | +| 5.17.3.12 | MRFP Resource Congestion Handling – Activate ..... | 126 | +| 5.17.3.13 | MRFP Resource Congestion Handling – Indication..... | 127 | +| 5.17.3.14 | Command Rejected..... | 127 | +| 5.17.3.15 | MRFP Restoration ..... | 127 | + +| | | +|----------------------------------------------------------------------------------------------------------------|------------| +| Annex A (normative): The W3C SSML Profile for TTS function ..... | 128 | +| A.1 Introduction..... | 128 | +| A.2 TTS Profile..... | 128 | +| Annex B (normative): The W3C SRGS Profile for ASR function..... | 133 | +| B.1 Introduction..... | 133 | +| B.2 SRGS Profile..... | 133 | +| Annex C (normative): H.248 Package for Multi-stream Multiparty Conferencing Media Handling (MMCMH)..... | 135 | +| C.1 Introduction..... | 135 | +| C.2 Specification of Multi-party Multimedia Conference Media Handling Package ..... | 135 | +| C.2.1 Multi-party Multimedia Conference Media Handling Package..... | 135 | +| C.2.2 Properties..... | 136 | +| C.2.2.1 MMCMH Policy..... | 136 | +| C.2.3 Events ..... | 137 | +| C.2.4 Signals ..... | 137 | +| C.2.5 Statistics ..... | 137 | +| C.2.6 Error Codes ..... | 138 | +| C.2.7 Procedures ..... | 138 | +| Annex D (informative): Change history..... | 140 | + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document describes the protocol to be used on the Multimedia Resource Function Controller (MRFC) – Multimedia Resource Function Processor (MRFP) interface (Mp interface). The IMS architecture is described in 3GPP TS 23.228 [1], the functional requirements are described in 3G TS 23.333 [25] + +This specification defines a profile of the Gateway Control Protocol (H.248.1), for controlling Multimedia Resource Function Processor supporting in-band user interaction, conferencing and transcoding for multimedia-services. + +The present document is valid for a 3rd generation PLMN (UMTS) complying with Release 7 and later. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TS 23.228: "IP Multimedia Subsystem (IMS); Stage 2". +- [2] 3GPP TS 23.002: "Network architecture". +- [3] ITU-T Recommendation H.248.1 (05/2002), Gateway control protocol: Version 2 + Corrigendum 1 (03/2004) and ITU-T Recommendation H.248.1 (09/2005), Gateway control protocol: Version 3 for Floor Control requirements. +- [4] ITU-T Recommendation H.248.4 (11/2000), Gateway control protocol: Transport over Stream Control Transmission Protocol (SCTP) + Corrigendum 1 (03/2004). +- [5] ITU-T Recommendation H.248.7 (03/2004), Gateway control protocol: Generic announcement package. +- [6] ITU-T Recommendation H.248.9 (03/2002), Gateway control protocol: Advanced media server package. +- [7] ITU-T Recommendation H.248.11 (11/2002), Gateway control protocol: Media gateway overload control package. +- [8] IETF RFC 2960: "Stream Control Transmission Protocol". +- [9] ITU-T Recommendation H.248.14 (03/2002), Gateway control protocol: Inactivity timer package. +- [10] ITU-T Recommendation H.248.16 (11/2002), Gateway control protocol: Enhanced digit collection packages and procedures + Corrigendum 1 (03/2004). + +- [11] Void +- [12] ITU-T Recommendation H.248.27 (07/2003), Gateway control protocol: Supplemental Tones package +- [13] ITU-T Recommendation Q.1950 (12/2002), Bearer independent call bearer control protocol. +- [14] ITU-T Recommendation G.711 (11/1988), Pulse code modulation (PCM) of voice frequencies. +- [15] ITU-T Recommendation G.711 Appendix I (09/1999), A high quality low-complexity algorithm for packet loss concealment with G.711. +- [16] ITU-T Recommendation G.711 Appendix I (09/1999), A comfort noise payload definition for ITU-T G.711 use in packet-based multimedia communication systems. +- [17] ITU-T Recommendation E.180 (03/1998), Technical characteristics of tones for the telephone service. +- [18] TS 183 022: Telecommunication and Internet converged Services and Protocols for Advanced Networking (TISPAN); MGC Information Package. +- [19] ES 201 970 Access and Terminals (AT); Public Switched Telephone Networks (PSTN); Harmonized specification of physical and electrical characteristics at a 2-wire analogue presented Network Termination Point (NTP). +- [20] IETF RFC 2327 (1998): "SDP: Session Description Protocol". +- [21] IETF RFC 3551 (2003): "RTP Profile for Audio and Video Conferences with Minimal Control". +- [22] IETF RFC 2833 (2000): "RTP Payload for DTMF Digits, Telephony Tones and Telephony Signals". +- [23] IETF RFC 4040 (2005): "RTP payload format for a 64 kbit/s transparent call". +- [24] IETF RFC 3555 (2003): "MIME Type Registration of RTP Payload Formats". +- [25] 3GPP TS 23.333: "Multimedia Resource Function Controller (MRFC) – Multimedia Resource Function Processor (MRFP) Mp interface: Procedures Descriptions". +- [26] ITU-T Recommendation H.248.9a1 (03/2007), "Gateway control protocol: Advanced media server package (draft work in progress)". +- [27] 3GPP TS 29.163: "Interworking between the IM CN subsystem and CS networks – Stage 3". +- [28] W3C Recommendation (September 2004): "Speech Synthesis Markup Language (SSML) Version 1.0". +- [29] W3C Recommendation (September 2004): "Speech Recognition Grammar Specification (SRGS) Version 1.0". +- [30] ITU-T Recommendation H.248.36 (09/2005): "Hanging Termination Detection Package". +- [31] Void +- [32] IETF RFC 4583 (2006): "Session Description Protocol (SDP) Format for Binary Floor Control Protocol (BFCP) Streams". +- [33] ITU-T Recommendation H.248.19 (03/2013): "Gateway Control Protocol: Decomposed multipoint control unit, audio, video and data conferencing packages". +- [34] IETF RFC 4975 (2007): "The Message Session Relay Protocol (MSRP)". +- [35] ITU-T H.248.69 (03/2009): "Gateway control protocol: Packages for interworking between MSRP and H.248". +- [36] Void + +- [37] Void +- [38] Void +- [39] IETF RFC 4145 (2005): "TCP-Based Media Transport in the Session Description Protocol (SDP)". +- [40] IETF RFC 4585 (2006): "Extended RTP Profile for Real-time Transport Control Protocol (RTCP) - Based Feedback (RTP/AVPF)". +- [41] 3GPP TS 26.114: "IP Multimedia Subsystem (IMS); Multimedia Telephony; Media handling and interaction". +- [42] 3GPP TS 22.153: "Multimedia Priority Service". +- [43] ITU-T Recommendation H.248.52 (06/2008): "Gateway control protocol: QoS support packages". +- [44] ITU-T Recommendation H.248.82 (03/2013): "Gateway control protocol: Explicit Congestion Notification Support". +- [45] IETF RFC 5285: "A General Mechanism for RTP Header Extensions". +- [46] IETF RFC 6236: "Negotiation of Generic Image Attributes in the Session Description Protocol (SDP)". +- [47] ITU-T Recommendation H.248.50 (2010) and Corrigendum 1 (02/12): "Gateway control protocol: NAT traversal toolkit packages". +- [48] IETF RFC 5245: "Interactive Connectivity Establishment (ICE): A Protocol for Network Address Translator (NAT) Traversal for Offer/Answer Protocols". +- [49] 3GPP TS 24.229: "IP Multimedia Call Control Protocol based on SIP and SDP". +- [50] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [51] IETF RFC 3830: "MIKEY: Multimedia Internet KEYing". +- [52] IETF RFC 793: "Transmission Control Protocol - DARPA Internet Program - Protocol Specification". +- [53] IETF RFC 4582: "The Binary Floor Control Protocol (BFCP)". +- [54] ITU-T Recommendation H.248.89 (10/2014): "Gateway control protocol: TCP support packages". +- [55] ITU-T Recommendation H.248.90 (10/2014): "Gateway control protocol: H.248 packages for control of transport security using TLS". +- [56] IETF RFC 6043: "MIKEY-TICKET: Ticket-Based Modes of Key Distribution in Multimedia Internet KEYing (MIKEY)". +- [57] 3GPP TS 33.328: "IP Multimedia Subsystem (IMS) media plane security". +- [58] IETF RFC 4279: "Pre-Shared Key Ciphersuites for Transport Layer Security (TLS)". +- [59] 3GPP TS 33.310: "Network Domain Security (NDS); Authentication Framework (AF)". +- [60] 3GPP TS 24.103: "Telepresence using the IP Multimedia (IM) Core Network (CN) Subsystem (IMS); Stage 3". +- [61] IETF RFC 8841: "Session Description Protocol (SDP) Offer/Answer Procedures for Stream Control Transmission Protocol (SCTP) over Datagram Transport Layer Security (DTLS) Transport". +- [62] IETF RFC 8864: "Negotiation Data Channels Using the Session Description Protocol (SDP)". +- [63] ITU-T Recommendation H.248.93 (10/2014): "Gateway control protocol: ITU-T H.248 support for control of transport security using the datagram transport layer security (DTLS) protocol". + +- [64] IETF RFC 8122: "Connection-Oriented Media Transport over the Transport Layer Security (TLS) Protocol in the Session Description Protocol (SDP)". +- [65] ITU-T Recommendation H.248.78 (11/2015): "Gateway control protocol: Bearer-level message backhauling and application level gateway". +- [66] IETF RFC 4573: "MIME Type Registration for RTP Payload Format for H.224". +- [67] ITU-T Recommendation H.224 (01/2005): "A real time control protocol for simplex applications using the H.221 LSD/HSD/MLP channels". +- [68] ITU-T Recommendation H.281 (11/1994): "A far end camera control protocol for videoconferences using H.224". +- [69] IETF RFC 5939: "Session Description Protocol (SDP) Capability Negotiation". +- [70] ITU-T Recommendation H.248.80 (01/2014): "Gateway control protocol: Usage of the revised SDP offer/answer model with ITU-T H.248". +- [71] IETF RFC 5104: "Codec Control Messages in the RTP Audio-Visual Profile with Feedback (AVPF)". +- [72] IETF RFC 4796: "The Session Description Protocol (SDP) Content Attribute". +- [73] IETF RFC 8853: "Using Simulcast in Session Description Protocol (SDP) and RTP Session". +- [74] IETF RFC 8851: "RTP Payload Format Restrictions". +- [75] IETF RFC 7728: "RTP Stream Pause and Resume". +- [76] ITU-T Recommendation H.248.98 (02/2016): "Gateway control protocol: Support of remote media pause and resume". + +# --- 3 Definitions and symbols + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [50] and the following apply. + +**Media Gateway:** See ITU-T Recommendation H.248.1 [3]. + +**Media Gateway Controller:** See ITU-T Recommendation H.248.1 [3]. + +**MultiMedia Resource Function Controller:** See 3GPP TS 23.002 [2]. + +**MultiMedia Resource Function Processor:** See 3GPP TS 23.002 [2]. + +For the purposes of the present document, the following terms and definitions as defined in 3GPP TS 23.333 [25] apply: + +ICE lite + +Full ICE. + +For the purposes of the present document, the following terms and definitions given in IETF RFC 3830 [51] apply: + +**Crypto Session (CS)** + +**Traffic-Encrypting Key (TEK).** + +## 3.2 Symbols + +None. + +# 4. Abbreviations + +For the purposes of the present document, the following abbreviations apply: + +| | | +|-----------|------------------------------------------------------| +| BFCP | Binary Floor Control Protocol | +| CCM | Codec Control Messages | +| CDR | Call Data Record | +| CN | Comfort Noise | +| CRC | Cyclic Redundancy Check | +| CS | Crypto Session | +| CVO | Coordination of Video Orientation | +| DBI | Delay Budget Information | +| DNS | Domain Name System | +| DTLS | Datagram Transport Layer Security | +| DTMF | Dual Tone Multi Frequency | +| CE | Congestion Experienced | +| ECN | Explicit Congestion Notification | +| FEC | Forward Error Correction | +| FECC | Far End Camera Control | +| FIR | Full Intra Request | +| ICE | Interactive Connectivity Establishment | +| IP | Internet Protocol | +| IPsec | IP Security | +| MGC | Media Gateway Controller | +| MGW | Media Gateway | +| MID | Message Identifier | +| MMCMH | Multi-stream Multiparty Conferencing Media Handling | +| MPS | Multimedia Priority Service | +| MRFC | MultiMedia Resource Function Controller | +| MRFP | MultiMedia Resource Function Processor | +| MSRP | Message Session Relay Protocol | +| OAM | Operation, Administration and Maintenance | +| OoS | Out of Service | +| PLC | Packet Loss Concealment | +| PSK | Pre-Shared Key | +| PT | Payload Type | +| QoS | Quality of Service | +| ROI | Region of Interest | +| SCTP | Stream Control Transmission Protocol | +| SDP | Session Description Protocol | +| SDPCapNeg | SDP Capability Negotiation | +| SPNE | Signal Processing Network Equipment | +| SSRC | Synchronisation Source | +| STUN | Session Traversal Utilities for NAT | +| TCP | Transmission Control Protocol | +| TEK | Traffic-Encrypting Key | +| TLS | Transport Layer Security | +| TMMBN | Temporary Maximum Media Stream Bit Rate Notification | +| TMMBR | Temporary Maximum Media Stream Bit Rate Request | +| TTL | Time To Live | +| UDP | User Datagram Protocol | +| URN | Uniform Resource Name | +| VBD | Voiceband Data | + +# 5 Profile Description + +## 5.1 Profile Identification + +The name and version of the profile that is sent in the service change command are: + +**Table 5.1.1: Profile Identification** + +| | | +|----------------------|-----| +| Profile name: | MRF | +| Version: | 7 | + +## 5.2 Summary + +The profile defined in the present document enables the control of media resource function processors (MRFP) supporting in-band user interaction, conferencing and transcoding for multimedia services. + +This Profile describes the minimum mandatory settings and procedures required to fulfil the Media Gateway control requirements for the MRF. + +In addition optional settings and procedures are described which fulfil optional features and where supported, the minimum mandatory settings within the optional procedures and packages are identified that must be supported in order to support that feature. + +"Optional" or "O" means that it is optional for either the sender or the receiver to implement an element. If the receiving entity receives an optional element that it has not implemented it should send an Error Code (e.g. 445 "Unsupported or Unknown Property", 501 "Not Implemented", etc.). "Mandatory" or "M" means that it is mandatory for the receiver to implement an element. Whether it is mandatory for the sender to implement depends on specific functions; detail of whether elements of the core protocol are mandatory to be sent are defined in the stage 2 procedures, stage 3 procedures and/or the descriptions of individual packages. + +The setting or modification of elements described in the profile under the heading "Used in Command" has the meaning that the property can be set/modified with that command. The property may be present in other commands (in order to preserve its value in accordance with ITU-T H.248.1[3]) when those commands are used for other procedures that affect the same descriptor. + +This profile supports Explicit Congestion Notification and Multimedia Priority Service. + +## 5.3 Gateway Control Protocol Version + +**Version 2** shall be the minimum version supported. Support of this version implies conformance to ITU-T Recommendation H.248 Version 2 [3]. + +**Version 3** shall be supported for the optional MRFP based Floor Control Server functionality. + +## 5.4 Connection Model + +Media Resource Function Processors shall support ephemeral terminations that sink and source IP traffic. This type of H.248 Termination is denoted IP in the following clauses. + +**Table 5.4.1: Connection Model** + +| | | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| Maximum number of contexts: | Provisioned (NOTE 1) | +| Maximum number of terminations per context: | Unspecified(NOTE 2) | +| Allowed terminations type combinations in a context: | Not Applicable | +| NOTE 1: The actual number of supported contexts can be audited by the MRFC using the MaxNrOfContexts property defined in the Base Root Package.

NOTE 2: Support of 1 termination in a context is the basic requirement for the MRFP e.g. for voice record. 2 terminations in a context are required for transcoding or any inband media detection or insertion whilst an unspecified number terminations may be required if conferencing is supported. | | + +## 5.5 Context Attributes + +**Table 5.5.1: Context Attributes** + +| Context Attribute | Supported | Values Supported | +|------------------------------------|-------------------|---------------------------------------------------------------| +| Topology | Yes | See clause 5.7.8 | +| Priority Indicator | Optional (NOTE 1) | 0-15 (NOTE 2) | +| Emergency Indicator | No | Not Applicable | +| IEPS Indicator | No | | +| ContextAttribute Descriptor | Yes | If "yes" see clause 5.8.9 for details of supported attributes | +| ContextIDList Parameter | | NA | + +NOTE 1: This Context Attribute parameter is used for MPS as specified in 3GPP TS 22.153 [42]. +NOTE 2: Priority values 11 – 15 of the Priority Indicator are reserved for MPS. + +Is the AND/OR Select operation Context Attribute supported? + +| | | | +|---------------------------------|----------|---------------| +| AND/OR Context Attribute | | | +|---------------------------------|----------|---------------| + +## 5.6 Terminations + +### 5.6.1 Termination Names + +#### 5.6.1.1 General + +The Termination ID structure is provisioned in the MRFC and MRFP and is known by the MRFP and the MRFC at or before start up. + +With ephemeral IP endpoint bearer types the internal structure of Termination ID is irrelevant for MRFC and MRFP and therefore Termination ID is only a numeric identifier for the termination. + +#### 5.6.1.2 ASN.1 encoding + +The following general structure of TerminationID shall be used: + +4 octets shall be used for the termination ID. The following defines the general structure for the termination ID: + +**Table 5.6.1.2.1: Termination ID** + +| | | +|------------------|---| +| Termination type | X | +|------------------|---| + +Termination type: + +Length 3 bits + +Values: + +000 Reserved + +001 Ephemeral termination + +011 - 110 Reserved + +111 Reserved for ROOT termination Id (ROOT Termination Id = 0xFFFFFFFF) + +X: + +Length 29 bits. + +For IP termination, its usage is un-specified. + +#### 5.6.1.3 ABNF encoding + +The following general structure of termination ID shall be used: + +TerminationID = "ROOT" / pathName / "\$" / "\*" ; according to ITU-T H.248.1 [3] Annex B. + +### 5.6.2 Multiplexed Terminations + +**Table 5.6.2.1: Multiplexed Terminations** + +| | | +|------------------------------------------|----| +| Multiplex Terminations Supported? | NO | +|------------------------------------------|----| + +## 5.7 Descriptors + +### 5.7.1 Stream Descriptor + +**Table 5.7.1.1: Stream Descriptor** + +| | | | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----|--------------------| +| Maximum number of streams per termination type | ALL | Unspecified (NOTE) | +| NOTE: At least 1 stream for each media (e.g. video+audio = 2 streams). If only one stream is applicable, then the MRFC may omit the Stream Descriptor and the MRFP shall assume that StreamID =1. | | | + +#### 5.7.1.1 LocalControl Descriptor + +The following tables specify the level of support required with regard to the properties in the local control descriptor. + +**Table 5.7.1.1.1: Reserve Group and Reserve Value** + +| | | Termination Type | Stream Type | +|----------------------------|-----------------------------|------------------|--------------| +| Reserve group used: | NO (NOTE 1) | - | - | +| Reserve value used: | YES
(NOTE 2)
(NOTE 3) | IP | Audio, Video | + +NOTE 1: Support of Reserve Group in case of multiple p-time values requires further studies +NOTE 2: Used for audio streams where IETF RFC 2833 [22] is also specified and for conference where participants are invited to join the conference. +NOTE 3: Not used for TCP transport (see IETF RFC 793 [52]) and media types: +a) "message" for MSRP (see IETF RFC 4975 [34]) and +b) "application" for BFCP (see IETF RFC 4582 [53]) and ROI FECC (IETF RFC 4573 [66]) because the application control will not use them in a context ReserveValue. + +**Table 5.7.1.1.2: Stream Mode** + +| Termination Type | Stream Type | Allowed StreamMode Values | +|------------------|-------------|-------------------------------------------| +| ALL except ROOT | Any | Send, Receive, Send and Receive, Inactive | + +### 5.7.2 Events Descriptor + +**Table 5.7.2.1: Events Descriptor** + +| | | | | +|---------------------------------------------------------------|---------------------------------------------------------------------------------------------------|-------------------------|-----------------------------------| +| Events settable on termination types and stream types: | Yes | | | +| If yes | Event ID | Termination Type | Stream Type | +| | g/* | IP | Audio, Video | +| | nt/* | IP | Audio, Video | +| | rtp/* | IP | Audio, Video | +| | aasrec/* | IP | Audio, Video | +| | aasb/* | IP | Audio, Video | +| | dd/d0-dd | IP | Audio | +| | it/* | ROOT | Not Applicable | +| | ocp/mg_overload | ROOT | Not Applicable | +| | aastts/* | IP | Audio | +| | asr/* | IP | Audio | +| | mrp/* | IP | Audio, Video | +| | mpp/* | IP | Audio, Video | +| | vavsp/* | IP | Audio, Video | +| | Hangterm/thb | IP | Audio, Video | +| | msrpstat/mquota | IP | Message | +| | mess/* | IP | Message | +| | fschp/* | IP | Audio, Video | +| | ECN Failure (ecnrous/fail, 0x010b/0x0001) see clause 5.14.3.37 | IP | Audio, Video | +| | ICE New Peer Reflexive Candidate (ostuncc/nprc, 0x00c3/0x0002) – See clause 5.14.3.40 | IP | Any, only applicable for full ICE | +| | ICE Connectivity Check Result (ostuncc/ccr, 0x00c3/0x0001) – See clause 5.14.3.40 | IP | Any, only applicable for full ICE | +| | TCP connection state change ("BNC change") (tcpbcc/BNCChange, 0x0115/0x0001) see clause 5.14.3.41 | IP | TCP based | +| | TLS session state change ("BNC change") (tlsbsc/BNCChange, 0x0117/0x0001) see clause 5.14.3.42 | IP | TLS based | + +| | | | | +|--|--------------------------------------------------------------------------------|----|-------------| +| | Detect bearer level message (mcbalg/det, 0x0108/0x0001) – See clause 5.14.3.43 | IP | Application | +|--|--------------------------------------------------------------------------------|----|-------------| + +Table 5.7.2.2: Event Buffer Control + +| | | +|----------------------------|----| +| Event Buffer Control used: | No | +|----------------------------|----| + +Table 5.7.2.3: Keep Active + +| | | +|----------------------------|-----| +| Keepactive used on events: | Yes | +|----------------------------|-----| + +Table 5.7.2.4: Embedding in event + +| | | +|------------------------------------------|----| +| Embedded events in an event descriptor: | No | +| Embedded signals in an event descriptor: | No | + +Table 5.7.2.5: Notify Behaviour + +| | | +|---------------------------------|------------------------------------| +| NotifyBehaviour used on events: | No | +| If yes | Supported values
Not Applicable | + +### 5.7.3 EventBuffer Descriptor + +Table 5.7.3.1: Event Buffer + +| | | +|-------------------------------|----| +| Event Buffer descriptor used: | No | +|-------------------------------|----| + +### 5.7.4 Signals Descriptor + +Table 5.7.4.1: Signals dependant on termination or streams + +| | | | | +|-------------------------------------------------------------|------------------|-------------------------|-------------------------| +| Signals settable dependant on termination or streams types: | Yes | | | +| If yes | Signal ID | Termination Type | Stream Type / ID | +| | cg/* | IP | Audio | +| | srvtn/* | IP | Audio | +| | xcg/* | IP | Audio | +| | an/apf | IP | Audio, video | +| | int/* | IP | Audio | +| | biztn/* | IP | Audio | +| | aasrec/* | IP | Audio, video | +| | Aasdc | IP | Audio, video | +| | aasb/* | IP | Audio, video | +| | conftn/* | All except ROOT | Audio | +| | Tonegen/* | IP | Audio | +| | bcg/* | IP | Audio | +| | aastts/* | IP | Audio | +| | asr/* | IP | Audio | +| | mrp/* | IP | Audio, video | +| | mpp/* | IP | Audio, video | +| | mess/* | IP | Message | +| | recmess/* | IP | Message | +| | fschp/* | IP | Audio, video | + +| | | | +|-------------------------------------------------------------------------------|----|-----------------------------------------------------| +| Send Additional Connectivity Check (ostuncc/sacc, 0x00c3/0x0002) | IP | Message, audio, video, only applicable for full ICE | +| Send Connectivity Check (ostuncc/scc, 0x00c3/0x0001) | IP | Message, audio, video, only applicable for full ICE | +| Establish BNC (tcpbcc/EstBNC, 0x0115/0x0001) | IP | TCP based | +| Release BNC (tcpbcc/RelBNC, 0x0115/0x0002) | IP | TCP based | +| Establish BNC (tlbsc/EstBNC, 0x0117/0x0001) | IP | TLS based | +| Release BNC (tlbsc/RelBNC, 0x0117/0x0002) | IP | TLS based | +| Send bearer level message (mcbalg/sblm, 0x0108/0x0001) – See clause 5.14.3.43 | IP | Application | + +Table 5.7.4.2: Signal Lists + +| | | | +|---------------------------------|--------------------------------------------------|--------------| +| Signals Lists supported: | Yes | | +| If yes | Termination Type Supporting Lists | IP | +| | Stream Type Supporting lists | Audio, Video | +| | Maximum number of signals per signal list | Provisioned | + +Table 5.7.4.3: Signal type and duration + +| | | | +|--------------------------------------------|------------------|----------------------------------| +| Signal type and duration supported? | Yes | | +| If yes | Signal ID | Type or duration override | +| | ALL | Both | + +Table 5.7.4.4: Signal Direction + +| | | +|------------------------------------|----| +| Signal Direction supported: | No | +|------------------------------------|----| + +Table 5.7.4.5: Notify completion + +| | | | +|-------------------------------------|---------------------------------------------------------------------------------------------------------|-------------------------------------| +| Notify completion supported: | Yes | | +| If yes | Signal ID | Type of completion supported | +| | cg/*, svrtn/*, xcg/*, an/*, int/*, biztn/*, confn/*, tonegen/*, bcg/*, aasb/*, aastts/*, mpp/*, fschp/* | ALL | + +Table 5.7.4.6: RequestID Parameter + +| | | +|---------------------------------------|-----| +| RequestID Parameter Supported: | Yes | +|---------------------------------------|-----| + +Table 5.7.4.7: Signals played simultaneously + +| | | | +|--------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|---| +| Signals played simultaneously: | No (NOTE) | | +| If yes | Signal Ids that can be played simultaneously: | - | +| NOTE: Signal for recording audio or multimedia may be played simultaneously with signals for playing announcement. | | | + +Table 5.7.4.8: Keep Active + +| | | +|------------------------------------|-----| +| Keepactive used on signals: | Yes | +|------------------------------------|-----| + +### 5.7.5 DigitMap Descriptor + +Table 5.7.5.1: DigitMap Descriptor + +| | | | | +|-----------------------------|----------------------|------------------|---------------| +| DigitMaps supported: | NO | | | +| If yes | DigitMap Name | Structure | Timers | +| | | | | + +### 5.7.6 Statistics Descriptor + +Table 5.7.6.1: Statistics Descriptor + +| | | +|---------------------------------|------| +| Statistics supported on: | Both | +|---------------------------------|------| + +Table 5.7.6.2: Statistics reported on Subtract + +| | | | | +|-----------------------------------------|-------------------------------|-------------------------|--------------------| +| Statistics reported on Subtract: | Yes | | | +| If yes | Statistic IDs Reported | Termination Type | Stream Type | +| | msrpstat/* | IP | Message | + +### 5.7.7 ObservedEvents Descriptor + +Table 5.7.7.1: ObservedEvents Descriptor + +| | | +|----------------------------------------|-----| +| Event detection time supported: | Yes | +|----------------------------------------|-----| + +### 5.7.8 Topology Descriptor + +Table 5.7.8.1: Topology Descriptor + +| | | +|-------------------------|---------------------------------------------------------| +| Allowed triples: | (T1,T2, isolate)
(T1,T2, oneway)
(T1,T2, bothway) | +|-------------------------|---------------------------------------------------------| + +### 5.7.9 Error Descriptor + +**Table 5.7.9.1: Error codes sent by the MRFC** + +| | | +|---------------------------------------------------|-----------------------------------------------------------------------------------| +| Supported H.248.8 Error Codes: | 400-403, 406, 410, 411, 421, 422, 430, 431, 442, 443, 444, 446, 458, 501-506, 533 | +| Supported Error Codes defined in packages: | All error codes defined in supported packages are supported. | + +**Table 5.7.9.2: Error codes sent by the MRFP** + +| | | +|---------------------------------------------------|----------------------------------------------------------------------------------| +| Supported H.248.8 Error Codes: | 400-411, 412, 421, 422, 430, 431, 432-435, 440, 441, 442, 471, 500-517, 522-539. | +| Supported Error Codes defined in packages: | All error codes defined in supported packages are supported. | + +## 5.8 Command API + +### 5.8.1 Add + +**Table 5.8.1.1: Descriptors used by Add request** + +| | | +|-----------------------------------------|-----------------------------------------------------------------------------| +| Descriptors used by Add request: | - Events, Signals, Media (TerminationState, LocalControl, Local and Remote) | +|-----------------------------------------|-----------------------------------------------------------------------------| + +**Table 5.8.1.2: Descriptors used by Add reply** + +| | | +|---------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Descriptors used by Add reply: |

Events, Signals, Media (TerminationState, LocalControl, Local and Remote)Error

When command request excludes an Audit Descriptor, the MGW response shall only include descriptors which contained underspecified or overspecified properties in the command request. Furthermore, only those properties that were underspecified or overspecified in the request shall be sent in the reply. Exceptions to this rule are:

  • - The Error Descriptor
  • - SDP properties returned in "Reserve IMS Resources" and "Reserve and Configure IMS Resources" procedures, as specified in 15.17.2.2 and 15.17.2.4
| +|---------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +### 5.8.2 Modify + +**Table 5.8.2.1: Descriptors used by Modify request** + +| | | +|--------------------------------------------|---------------------------------------------------------------------------| +| Descriptors used by Modify request: | Events, Signals, Media (TerminationState, LocalControl, Local and Remote) | +|--------------------------------------------|---------------------------------------------------------------------------| + +**Table 5.8.2.2: Descriptors used by Modify reply** + +| | | +|------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Descriptors used by Modify reply: |

Events, Signals, Media (TerminationState, LocalControl, Local and Remote), Error

When command request excludes an Audit Descriptor, the MGW response shall only include descriptors which contained underspecified or overspecified properties in the command request. Furthermore, only those properties that were underspecified or overspecified in the request shall be sent in the reply. Exceptions to this rule are:

  • - -The Error Descriptor
  • - SDP properties returned in "Configure IMS Resources" procedure as specified in 15.17.2.3.
| +|------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +### 5.8.3 Subtract + +**Table 5.8.3.1: Descriptors used in Subtract request** + +| | | +|----------------------------------------------|-----------------------| +| Descriptors used by Subtract request: | Audit (empty) or None | +|----------------------------------------------|-----------------------| + +**Table 5.8.3.2: Descriptors used in Subtract reply** + +| | | +|--------------------------------------------|------| +| Descriptors used by Subtract reply: | None | +|--------------------------------------------|------| + +### 5.8.4 Move + +**Table 5.8.4.1: Command Move** + +| | | +|---------------------------|-----| +| Move command used: | Yes | +|---------------------------|-----| + +**Table 5.8.4.2: Descriptor used by Move command** + +| | | +|------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Descriptors used by Move Request: | Events, Signals, Media (TerminationState, LocalControl, Local and Remote) | +| Descriptors used by Move Reply: |

Events, Signals, Media (TerminationState, LocalControl, Local and Remote), Error

When command request excludes an Audit Descriptor, the MGW response shall only include descriptors which contained underspecified or overspecified properties in the command request. Furthermore, only those properties that were underspecified or overspecified in the request shall be sent in the reply. Exceptions to this rule are:

  • - -The Error Descriptor
| + +### 5.8.5 AuditValue + +**Table 5.8.5.1: Auditvalue** + +| Audited Properties: | Property Name and Identity | Descriptor | +|--------------------------------|--------------------------------------------------------------|------------------------------| +| Termination ID | ServiceState:
- Root (MGW Audit) | Termination State Descriptor | +| Termination ID | MGC information (mgcinfo)
- individualtermination (NOTE1) | LocalControl Descriptor | +| Termination ID | For Packages:
- Root | Packages Descriptor (NOTE2) | +| Termination ID | None (MGW Audit) :
- Root | Audit (empty) Descriptor | +| Termination ID | SDPCapNeg Extensions:
- sdpe/* | TerminationState Descriptor | +| Audited Statistics: | Supported Statistics (NOTE3) (NOTE2) | | +| Audited Signals: | ALL | | +| Audited Events: | ALL | | +| Package Audit possible: | Yes | | + +NOTE1: The purpose to audit an individual Termination is to retrieve MGC Information if supported. +NOTE2: Optional +NOTE3: The statistics defined in the MSRP Statistics Package can be obtained via the MRFC auditing the MRFP. The supported statistics are msrpstat/nms, msrpstat/nmr, msrpstat/vms and msrpstat/vmr. + +### 5.8.6 AuditCapabilities + +**Table 5.8.6.1: AuditCapabilities** + +| Audited Properties: | Property Name and Identity | Descriptor | +|----------------------------|-----------------------------------|-------------------| +| | FFS | FFS | +| Audited Statistics: | None | | +| Audited Signals: | None | | +| Audited Events: | None | | + +### 5.8.7 Notify + +**Table 5.8.7.1: Notify** + +| | | +|------------------------------------------------------------------|-----------------------| +| Descriptors used by Notify Request or Reply: | ObservedEvents, Error | +| NOTE : The Error Descriptor shall not be used in Notify Request. | | + +### 5.8.8 ServiceChange + +**Table 5.8.8.1: Service Change Methods and Reason sent by MRFC** + +| Service Change Methods Supported: | ServiceChange Reasons supported: | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------| +| Restart (NOTE 1) | "900 Service Restored"
"901 Cold Boot",
"902 Warm Boot". | +| Graceful (NOTE 1) | "905 Termination Taken Out Of Service" | +| Forced (NOTE 1) | "905 Termination Taken Out Of Service" | +| Handoff (NOTE 1, NOTE 2) | "903 MGC Directed Change" | +| NOTE : When a Service Change command on the Root termination with a method other than Graceful is sent, the command shall always be sent as the only command in a message. The sending node shall always wait for the reply to a Service Change command on the Root termination with a method other than Graceful before sending further command requests. A Service Change command on the Root termination with method Graceful may be combined with other commands in a single message. | | +| NOTE 1: ROOT Only. | | +| NOTE 2: Not involving more than 1 MRFC. No support of handoff relates to a network deployment scenario with "primary H.248 systems only", which translates to no geographic redundancy of the MRFC. | | + +**Table 5.8.8.2: Service Change Methods and Reason sent by MRFP:** + +| Service Change Methods Supported: | ServiceChange Reasons supported: | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------| +| Restart (NOTE 1) | "900 Service Restored",
"901 Cold Boot",
"902 Warm Boot",
"916 Packages Change" (Optional)
"917 Capability Change" (Optional). | +| Graceful (NOTE 1) | "908 MG Impending Failure " | +| Forced (NOTE 1) | "905 Termination Taken Out Of Service" | +| Handoff (NOTE 1, NOTE 2) | "903 MGC Directed Change" | +| Failover (NOTE 3) | "909 MGC Impending Failure" | +| Disconnected (NOTE 1) | "900 Service Restored"
"916 Packages Change" (Optional)
"917 Capability Change" (Optional) | +| NOTE : When a Service Change command on the Root termination with a method other than Graceful is sent, the command shall always be sent as the only command in a message. The sending node shall always wait for the reply to a Service Change command on the Root termination with a method other than Graceful before sending further command requests. A Service Change command on the Root termination with method Graceful may be combined with other commands in a single message. | | +| NOTE 1: ROOT only. | | +| NOTE 2: In response to a MGC Ordered Re-Register | | +| NOTE 3: Only for TISPAN NGN MRF. Not involving more than 1 MRFP. No support of handoff relates to a network deployment scenario with "primary H.248 systems only", which translates to no geographic redundancy of the MGW. | | + +**Table 5.8.8.3: Service Change Address** + +| | | +|-----------------------------------|----| +| ServiceChangeAddress used: | No | +|-----------------------------------|----| + +**Table 5.8.8.4: Service Change Delay** + +| | | +|---------------------------------|-----------------------------| +| ServiceChangeDelay used: | No | +| If yes | Valid time period: - | + +**Table 5.8.8.5: Service Change Incomplete Flag** + +| | | +|--------------------------------------------|----| +| ServiceChange Incomplete Flag used: | No | +|--------------------------------------------|----| + +**Table 5.8.8.6: Service Change Version** + +| | | +|----------------------------------------------|---| +| Version used in ServiceChangeVersion: | 2 | +|----------------------------------------------|---| + +**Table 5.8.8.7: Profile negotiation** + +| | | +|---------------------------------------------|----| +| Profile negotiation as per H.248.18: | No | +|---------------------------------------------|----| + +### 5.8.9 Manipulating and Auditing Context Attributes + +**Table 5.8.9.1: Manipulating and Auditing Context Attributes** + +| | | +|----------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Context Attributes Manipulated: | ALL supported attributes (See table 5.5.1.) (NOTE) | +| Context Attributes Audited: | ALL supported attributes except Priority Indicator (See table 5.5.1.) (NOTE) | +| NOTE: | For ContextAttribute Descriptor, the details of supported attribute include: Floor Control Algorithm (fcpoli/fca), Max Floor Users (fcpoli/mfu), Floor Control Conference Identity (fcsig/fconfid), Floor and Stream Association (fcsig/fsa) and MMCMH Policy (mmcmh/mmcmhp). | + +## 5.9 Generic Command Syntax and Encoding + +**Table 5.9.1: Encoding** + +| | | +|-----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Supported Encodings: | Binary (optional)
Text (optional)
The receiver shall support:
  • Short Token Notation
  • Long Token Notation
| +|-----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +## 5.10 Transactions + +**Table 5.10.1: Transactions** + +| | | +|------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Maximum number of Transaction Requests / Replies / TransResponseAcks / Segment Replies per message: | 10 | +| NOTE : | When more than one element are conveyed in one message, it is recommended that this message comprises a Transaction Request / Transaction Reply / Transaction Pending plus a Transaction Response Ack. | + +**Table 5.10.2: Segmentation** + +| | | +|--------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Segmentation Supported: | UDP : No
SCTP : Inherent in transport | +| NOTE: | The H.248 Segmentation Package according Annex E.14 of H.248.1 Version 3 is intended for H.248 transport technologies without the capability of automatic message segmentation. This method is not required for UDP- or SCTP-based H.248 signalling transport in this Profile. | + +**Table 5.10.3: Commands per Transaction Request** + +| | | +|------------------------------------------------------------|-----------| +| Maximum number of commands per Transaction request: | Unlimited | +|------------------------------------------------------------|-----------| + +**Table 5.10.4: Commands per Transaction Reply** + +| | | +|----------------------------------------------------------|-----------| +| Maximum number of commands per Transaction reply: | Unlimited | +|----------------------------------------------------------|-----------| + +**Table 5.10.5: Optional Commands** + +| | | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----| +| Commands able to be marked "Optional": | ALL | +| NOTE: The meaning of this table is that if one of the listed commands failed then the possibly present subsequent command within the same transaction will be processed. | | + +**Table 5.10.6: Transaction Timers** + +| | | +|-----------------------------------|--------------| +| Transaction Timer: | Value | +| NormalMGExecutionTime | Provisioned | +| NormalMGCEExecutionTime | Provisioned | +| MGOriginatedPendingLimit | Provisioned | +| MGCOOriginatedPendingLimit | Provisioned | +| MGProvisionalResponseTimerValue | Provisioned | +| MGCPProvisionalResponseTimerValue | Provisioned | + +## 5.11 Messages + +It is recommended that MRFP and MRFC names are in the form of fully qualified domain name. For example the domain name of the MRFC may be of the form MRFC1.whatever.net and the name of the MRFP may be of the form mg1.whatever.net. + +The fully qualified domain name will be used by the MRFP and MRFC as part of the "Message Identifier" in the H.248 messages which identifies the originator of the message. + +The MRFC domain name is provisioned in the MRFP or retrieved from the DNS using SRV records. + +The use of a domain name provides the following benefits: + +- MRFPs and MRFCs are identified by their domain name, not their network addresses. Several addresses can be associated with a domain name. If a command cannot be forwarded to one of the network addresses, implementations shall retry the transmission using another address. +- MRFPs and MRFCs may move to another platform. The association between a logical name (domain name) and the actual platform are kept in the Domain Name Service (DNS). MRFP and MRFC shall keep track of the record's time-to-live read from the DNS. They shall query the DNS to refresh the information if the time-to-live has expired. + +The domain name may be used by MRFC/MRFP for authentication purposes. + +## 5.12 Transport + +**Table 5.12.1: Transport** + +| | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Supported Transports: | Transport over SCTP shall be supported and shall conform to Recommendation H.248.4 [4]. Support of UDP is optional, dependent on a network operator's decision, based on the network configuration.
  • • SCTP(recommended) (NOTE1).
  • • UDP(optional).
| +| NOTE: If using SCTP as defined in IETF RFC 2960 [8], the MRFP shall always be the node to perform the "Initiation".
NOTE1: H.248 is "SCTP user" in this case of H.248/SCTP/IP based transport according ITU-T Rec. H.248.4. The number of used SCTP Streams for traffic of the H.248 Control Association must be defined, see clause 8/H.248.4. A single SCTP Stream is the default assumption ("Single-Stream Mode") in this Profile. | | + +**Table 5.12.2: Segmentation** + +| | | +|--------------------------------|----| +| Segmentation Supported: | No | +|--------------------------------|----| + +**Table 5.12.3: Control Association Monitoring** + +| | | +|--------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Control Association Monitoring Supported: | Monitoring mechanism is dependent on used H.248 transport
  • SCTP: inherent capability of SCTP (NOTE)
  • UDP:
    1. 1. H.248.14 (MRFP-driven monitoring)
    2. 2. Empty AuditValue on ROOT (MRFC-driven monitoring)
| +| NOTE: Use of H.248.14 for this is FFS. | | + +## 5.13 Security + +**Table 5.13.1: Security** + +| | | +|----------------------------------------------------------------------------------------------|------| +| Supported Security: | None | +| NOTE: Both the MRFC and MRFP are assumed to be within a secure IP zone of a single operator. | | + +## 5.14 Packages + +### 5.14.1 Mandatory Packages + +**Table 5.14.1: Mandatory packages** + +| Mandatory Packages | | | +|-------------------------------------------------------------------------|--------------------|----------------| +| Package Name / Reference | Package ID | Version | +| Generic (see ITU-T Recommendation H.248.1 [3]) | g, (0x0001) | 1 | +| Base Root (see ITU-T Recommendation H.248.1 [3]) | root, (0x0002) | 2 | +| Network (see ITU-T Recommendation H.248.1 [3]) | nt, (0x000b) | 1 | +| Hanging Termination Detection (see ITU-T Recommendation H.248.36 [30]). | hangterm, (0x0098) | 1 | + +### 5.14.2 Optional Packages + +Table 5.14.2: Optional packages + +| Optional Packages | | | | +|-----------------------------------------------------------------------------------------------|-------------------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| Package Name / Reference | Package ID | Version | Support dependent on: | +| DTMF Detection Package (see ITU-T Recommendation H.248.1 [3] Annex E.6); | dd, (0x0006) | 1 | Support is mandatory if DTMF Detection is supported. | +| Tone Generator Package (see ITU-T Recommendation H.248.1 [3]) | tonegen, (0x0003) | 1 | This package is "extension only". It must be supported if extended but shall not be published over the protocol. It is here for information only. | +| Basic Call Progress Tones Generator with Directionality(see ITU-T Recommendation Q.1950 [13]) | bcg, (0x0023) | 1 | If CS type Services provided by network | +| Call Progress Tones Generator (see ITU-T Recommendation H.248.1 [3]) | cpg, (0x0007) | 1 | If CS type Services provided by network | +| Basic Services Tones Generator (see ITU-T Recommendation Q.1950 [13]) | srvtng, (0x0025) | 1 | If CS type Services provided by network | +| Expanded Call Progress Tones Generator (see ITU-T Recommendation Q.1950 [13]) | xcg, (0x0024) | 1 | If CS type Services provided by network | +| Basic Announcement Syntax (see ITU-T Recommendation H.248.9 [6]) | bannsyx, (0x0047) | 1 | Support is optional if playing announcement is supported. | +| Voice Variable Syntax (see ITU-T Recommendation H.248.9 [6]) | vvsyx, (0x0048) | 1 | Support is optional if playing announcement is supported. | +| Announcement Set Syntax (see ITU-T Recommendation H.248.9 [6]) | setsyx, (0x0049) | 2 | Support is optional if playing announcement is supported. | +| General text Variable type (see ITU-T Recommendation H.248.9 [6]) | phrsyx, (0x004a) | 2 | Support is optional if playing announcement is supported. | +| Advanced Audio Server Base (see ITU-T Recommendation H.248.9 a1 [26]) | aasb, (0x0033) | 2 | Support is optional if playing announcement is supported. | +| AAS Recording package (see ITU-T Recommendation H.248.9 [6]) | aasrec, (0x0035) | 1 | Support is optional if Audio Record is supported. | +| AAS segment management (see ITU-T Recommendation H.248.9 [6]) | aassm, (0x0036) | 1 | | +| Generic Announcement (see ITU-T Recommendation H.248.7 [5]) | an, (0x001d) | 2 | Support is mandatory if playing announcement is supported. | +| Intrusion Tones Generation (see ITU-T Recommendation Q.1950 [13]) | int, (0x0027) | 1 | If CS type Services provided by network | +| Business Tones Generation (see ITU-T Recommendation Q.1950 [13]) | biztn, (0x0028) | 1 | If CS type Services provided by network | +| Conferencing Tones Generation (see ITU-T Recommendation H.248.27 [12]) | conftn, (0x0038) | 1 | Support is optional and may be used if Audio Conference is supported. | +| Inactivity Timer (see ITU-T Recommendation H.248.14 [9]) | it, (0x0045) | 1 | Support is mandatory if UDP transport is enabled for H.248 messages. | +| MGC Information Package (see ITU-T Recommendation H.248.45, | mgcinfo, (0x00a0) | 1 | This package may be supported as an operator option.
For this profile the information string shall be limited to 32 octets in length. | + +| | | | | +|----------------------------------------------------------------------------------------------------|--------------------|---|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Advanced audio server base package for TTS enhancement (see ITU-T Recommendation H.248.9 a1 [26]) | aastts, (0x00a8) | 1 | Support is mandatory if Text to Speech is supported. | +| ASR package (see ITU-T Recommendation H.248.9 a1 [26]) | asr, (0x00a6) | 1 | Support is mandatory if Automatic Speech Recognition is supported. | +| Multimedia Recording Package (see ITU-T Recommendation H.248.9 a1 [26]) | mrp, (0x00b3) | 1 | Support is mandatory if Multimedia recording is supported. | +| Multimedia play package (see ITU-T Recommendation H.248.9 a1 [26]) | mpp, (0x00a9) | 1 | Support is mandatory if Multimedia announcement file is supported. | +| Overload Control Package (see ITU-T Recommendation H.248.11 [7]) | ocp, (0x0051) | 1 | | +| RTP Package (see ITU-T Recommendation H.248.1 [3]) | rtp, (0x000c) | 1 | | +| MSRP Statistics Package (see ITU-T Recommendation H.248.69 [35]) | msrpstat, (0x00ea) | 1 | Support is mandatory if Message conference is supported. | +| Play Message Package (see ITU-T Recommendation H.248.69 [35]) | mess, (0x00ec) | 1 | Support is mandatory if Message conference is supported. | +| Message Filtering Package (see ITU-T Recommendation H.248.69 [35]) | mf, (0x00ef) | 1 | Support is mandatory if Message conference is supported. | +| Record Message Package (see ITU-T Recommendation H.248.69 [35]) | recmess, (0x00f1) | 1 | Support is mandatory if Message conference is supported. | +| Floor Control Package (see ITU-T Recommendation H.248.19 [33]) | fcp, (0x006e) | 2 | Support is mandatory if Floor control is supported. | +| Floor Control Policy Package (see ITU-T Recommendation H.248.19 [33]) | fcpoli, (0x00ab) | 1 | Support is mandatory if Floor control is supported. | +| Floor Status Change Handling Package (see ITU-T Recommendation H.248.19 [33]) | fschp, (0x00aa) | 1 | Support is mandatory if Floor control is supported. | +| Floor Control Signalling Package (see ITU-T Recommendation H.248.19 [33]) | fcsig, (0x00e5) | 1 | Support is mandatory if Floor control is supported. | +| Explicit Congestion Notification for RTP-over-UDP Support (see ITU-T Recommendation H.248.82 [44]) | ecnrous (0x010b) | 1 | Support of ECN feature | +| Diffserv (ITU-T Recommendation H.248.52 [43]) | ds, (0x008b) | 2 | Support of MPS | +| MG Act-as STUN Server (ITU-T Recommendation H.248.50 [47]) | mgastuns (0x00c2) | 1 | Support of incoming STUN connectivity checks.
Applicable for ICE lite and full ICE | +| Originate STUN Continuity Check (see ITU-T Recommendation H.248.50 [47]) | ostuncc (0x00c3) | 1 | Support of originating STUN connectivity checks
Only applicable for full ICE | +| TCP basic connection control (ITU-T Recommendation H.248.89 [54]) | tcpbcc, (0x0115) | 1 | Support of TCP based media. | +| TLS basic session control (ITU-T Recommendation H.248.90 [55]) | tlbsc, (0x0117) | 1 | Support of TCP based media using TLS. Support is mandatory if IMS media plane security using the pre-shared key (PSK) ciphersuites for TLS is supported. | +| MGC Controlled Bearer Level ALG (see ITU-T Recommendation H.248.78 [65]) | mcbaalg (0x0108) | 2 | Support of MGC controlled bearer level ALG functionality for CLUE message handling in telepresence. | +| Enhanced Revised Offer/Answer SDP Support ([ITU-T Recommendation H.248.80 [70]) | eroas, (0x0109) | 1 | Support of the SDP Capability Negotiation syntax | +| Remote Pause and Resume Package (see ITU-T Recommendation H.248.98 [76]) | rempr, (0x0123) | 1 | Support is mandatory if MMCMH feature is supported. Allows the MRFC to request that the MRFP issue a request to a remote endpoint to pause (and subsequently resume) the transmission of an RTP media stream. | + +| | | | | +|---------------------------------------------------------------------------|-----------------|---|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Multi-stream Multiparty Conferencing Media Handling Package (see Annex C) | mmcmh, (0x????) | 1 | Support is mandatory if MMCMH feature is supported. Defines functionality that allows the MRFP to interconnect video media flows with different StreamIDs and to autonomously determine the mix of a video streams in a conference dependent on the active speaker. For example, everyone sees the active speaker and he sees the previous speaker in a normal resolution, all other conference participants (or the most recent previous speakers) are seen in low resolution. | +|---------------------------------------------------------------------------|-----------------|---|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +### 5.14.3 Package Usage Information + +#### 5.14.3.1 Generic Package + +Table 5.14.3.1.1: Package Usage Information for Generic Package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | +|------------------------------------------|--------------------------------------|---------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------| +| None | - | - | - | - | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | +| None | - | - | - | - | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | +| | - | - | - | - | +| Events | Mandatory/Optional | Used in command: | | | +| Cause (g/cause, 0x0001/0x0001) | M | ADD, MOD, NOTIFY | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | None | - | - | - | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | General Cause (Generalcause, 0X0001) | M | "NR" Normal Release (0x0001)
"UR" Unavailable Resources (0x0002)
"FT" Failure, Temporary (0x0003)
"FP" Failure, Permanent (0x0004)
"IW" Interworking Error (0x0005)
"UN" Unsupported (0x0006) | - | +| | Failure Cause (FailureCause, 0x0002) | O | Octet String | - | +| Signal Completion. (g/sc, 0x0001/0x0002) | M | ADD, MOD, MOVE, NOTIFY | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | None | - | - | - | +| | | | | | + +| | ObservedEvent Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +|--------------------|-----------------------------------|----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------|--|--| +| | Signal Identity (SigID, 0x0001) | M | pkgdName syntax | - | | | +| | Termination Method (Meth, 0x0002) | M | "TO" (0x0001) Signal timed out or otherwise completed on its own
"EV" (0x0002) Interrupted by event
"SD" (0x0003) Halted by new Signals descriptor
"NC" (0x0004) Not completed, other cause | - | | | +| | Signal List Id (SLID, 0x0003) | O | Integer | Not Applicable | | | +| | Request ID (RID, 0x0004) | O | String indicating the Request ID | - | | | +| Statistics | Mandatory/ Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +#### 5.14.3.2 Base Root Package + +Table 5.14.3.2.1: Package Usage Information for Base Root Package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|-------------------------------------------------------------------------------------------|--------------------------|--------------------|----------------------------------------------------------|-----------------------------|--|--| +| MaxNrOfContexts
(root/maxNumberOfContexts, 0x0002/0x0001) | M | AuditValue | 1 and up | Implementation Specific | | | +| MaxTerminationsPerContext
(root/maxTerminationsPerContext, 0x0002/0x0002) | O | AuditValue | See 5.4 | Implementation Specific | | | +| normalMGExecutionTime
(root/normalMGExecutionTime, 0x0002/0x0003) | O | AuditValue | Integer | Operator Defined | | | +| normalMGExecutionTime
(root/normalMGExecutionTime, 0x0002/0x0004) | O | AuditValue | Integer | Operator Defined | | | +| MGProvisionalResponseTimerValue
(root/ MGProvisionalResponseTimerValue, 0x0002/0x0005) | O | AuditValue | Integer(NormalMGExecutionTime + networkdelay) | Operator Defined | | | +| MGProvisionalResponseTimerValue
(root/ MGProvisionalResponseTimerValue, 0x0002/0x0006) | O | AuditValue | Integer (initially NormalMGExecutionTime + networkdelay) | Operator Defined | | | +| MGOriginatedPendingLimit
(root/ MGOriginatedPendingLimit, 0x0002/0x0007) | O | AuditValue | Integer | Operator Defined | | | +| MGOriginatedPendingLimit
(root/ MGOriginatedPendingLimit, 0x0002/0x0008) | O | AuditValue | Integer | Operator Defined | | | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | | | +| None | - | - | | < - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | | | +| | - | - | | - | | | +| Events | Mandatory/Optional | Used in command: | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | - | - | | | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | - | - | | | | | +| Statistics | Mandatory/Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +#### 5.14.3.3 Overload Control Package + +Table 5.14.3.3.1: Package Usage Information for Overload Control Package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | +|---------------------------------------------------------|--------------------------|--------------------|-------------------|-----------------------------| +| None | - | - | - | - | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | +| None | - | - | - | - | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | +| | - | - | - | - | +| Events | Mandatory/Optional | Used in command: | | | +| MG_Overload.
(ocp/
mg_overload,
0x0051/0x0001) | M | ADD, MOD, NOTIFY | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | - | - | - | - | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| Statistics | Mandatory/Optional | Used in command: | | Supported Values: | +| None | - | - | - | - | +| Error Codes | Mandatory/ Optional | | | | +| None | - | | | | + +#### 5.14.3.4 Network Package + +Table 5.14.3.4.1: Package Usage Information for Network Package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | +|------------------------------------------------|--------------------------|------------------------|-------------------|-----------------------------| +| Maximum Jitter Buffer (nt /jit, 0x000b/0x0007) | M | ADD, MOD, MOVE | ALL | - | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | +| None | - | - | - | - | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | +| | - | - | - | - | +| Events | Mandatory/Optional | Used in command: | | | +| network failure(nt / netfail, 0x000b/0x0005) | M | ADD, MOD, MOVE, NOTIFY | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | none | - | - | - | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | cause(cs,0x0001) | M | ALL | - | +| quality alert (nt / qualert, 0x000b/0x0006) | M | ADD, MOD, MOVE, NOTIFY | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | Threshold(th,0x0001) | M | 0 to 99 | - | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | Threshold(th,0x0001) | M | 0 to 99 | - | + +| Statistics | Mandatory/Optional | Used in command: | Supported Values: | +|-----------------------------------------|----------------------------|------------------|-------------------| +| Duration(nt / dur, 0x000b/0x0001) | M | AUDITVALUE | ALL | +| Octets Sent (nt / os, 0x000b/0x0002) | M | AUDITVALUE | ALL | +| Octets Received(nt / or, 0x000b/0x0003) | M | AUDITVALUE | ALL | +| Error Codes | Mandatory/ Optional | | | +| - | - | | | + +#### 5.14.3.5 RTP Package + +Table 5.14.3.5.1: Package Usage Information for RTP Package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|--------------------------------------------------|---------------------------------|-----------------------------|--------------------------|------------------------------------|--|--| +| None | - | - | - | - | | | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | | | +| None | - | - | - | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | | | +| | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command: | | | | | +| Payload Transition, (rtp/pltrans, 0x000C/0x0001) | M | ADD, MOD, MOVE, NOTIFY | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | None | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | rtppayload (rtpltype, 0x0001) | M | A valid encoding name | - | | | +| Statistics | Mandatory/Optional | Used in command: | Supported Values: | | | | +| Packets Sent, (rtp/ps, 0x000C/0x0004) | O | AUDITVALUE, SUBTRACT REPLY | ALL | | | | +| Packets Received, (rtp/pr, 0x000C/0x0005) | O | AUDITVALUE , SUBTRACT REPLY | ALL | | | | +| Packet Loss, (rtp/pl, 0x000C/0x0006) | O | AUDITVALUE , SUBTRACT REPLY | ALL | | | | +| Jitter, (rtp/jit, 0x000C/0x0007) | O | AUDITVALUE , SUBTRACT REPLY | ALL | | | | +| Delay, (rtp/delay, 0x000C/0x0008) | O | AUDITVALUE , SUBTRACT REPLY | ALL | | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +#### 5.14.3.6 DTMF Detection Package + +Table 5.14.3.6.1: Package Usage Information for DTMF Detection Package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|-------------------------------------------|--------------------------|--------------------|-------------------|-----------------------------|--|--| +| None | - | - | - | - | | | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | | | +| None | - | - | - | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | | | +| | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command: | | | | | +| DTMF character 0
(dd/d0,0x0006/0x0010) | M | ADD, MOD, NOTIFY | | | | | +| DTMF character 1
(dd/d1,0x0006/0x0011) | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| DTMF character 2
(dd/d2,0x0006/0x0012) | - | - | - | - | | | +| DTMF character 3
(dd/d3,0x0006/0x0013) | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| DTMF character 4
(dd/d4,0x0006/0x0014) | - | - | - | - | | | +| DTMF character 5
(dd/d5,0x0006/0x0015) | | | | | | | +| DTMF character 6
(dd/d6,0x0006/0x0016) | | | | | | | +| DTMF character 7
(dd/d7,0x0006/0x0017) | | | | | | | +| DTMF character 8
(dd/d8,0x0006/0x0018) | | | | | | | +| DTMF character 9
(dd/d9,0x0006/0x0019) | | | | | | | +| DTMF character *
(dd/ds,0x0006/0x0020) | | | | | | | +| DTMF character #
(dd/do,0x0006/0x0021) | | | | | | | +| DTMF character A
(dd/da,0x0006/0x001a) | | | | | | | +| DTMF character B
(dd/db,0x0006/0x001b) | | | | | | | +| DTMF character C
(dd/dc,0x0006/0x001c) | | | | | | | +| DTMF character D
(dd/dd,0x0006/0x001d) | | | | | | | +| Statistics | Mandatory/Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +#### 5.14.3.7 Call Progress Tones Generator Package + +Table 5.14.3.7.1: Package Usage Information for Call Progress Tones Generator Package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | +|--------------------------------------|--------------------|--------------------|-------------------|-----------------------------| +| None | - | - | - | - | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | +| Dial Tone,
(cg/dt, 0x0007/0x0030) | M | ADD, MOD, MOVE | | Value | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | + +| | | | | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------|---------------------------|--------------------------|---------------------------| +| Ringing Tone, (cg/rt, 0x0007/0x031)
Busy Tone, (cg/bt, 0x0007/0x032)
Congestion Tone, (cg/ct, 0x0007/0x033)
Special Information Tone, (cg/sit, 0x0007/0x034)
Warning Tone, (cg/wt, 0x0007/0x035)
Payphone Recognition Tone, (cg/pt, 0x0007/0x036)
Call Waiting Tone, (cg/cw, 0x0007/0x037)
Caller Waiting Tone, (cg/cr, 0x0007/0x038) | - | - | - | - | +| Events | Mandatory/Optional | Used in command: | | | +| None | - | - | - | - | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | - | - | - | - | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| Statistics | Mandatory/Optional | Used in command: | | Supported Values: | +| None | - | - | - | - | +| Error Codes | Mandatory/ Optional | | | | +| None | - | | | | + +#### 5.14.3.8 Basic Services Tones Generator Package + +**Table 5.14.3.8.1: Package Usage Information for Basic Services Tones Generator Package** + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|---------------------------|--------------------------|------------------------------------| +| None | - | - | - | - | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | +| Recall Dial Tone (srvtn/rdt, 0x0025/0x004f)
Confirmation Tone (srvtn/conf, 0x0025/0x0050)
Held Tone (srvtn/ht, 0x0025/0x0051)
Message Waiting Tone (srvtn/mwt, 0x0025/0x0052) | O | ADD, MOD, MOVE | | Value | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | +| | Tone Direction (btd, 0x0001) | M | Internal / External | Default=External | +| Events | Mandatory/Optional | Used in command: | | | + +| | | | | | | | +|--------------------|---------------------------------|----------------------------|--------------------------|---------------------------|--|--| +| None | - | - | | | | | +| | Event Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| Statistics | Mandatory/ Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +#### 5.14.3.9 Expanded Call Progress Tones Generator Package + +**Table 5.14.3.9.1: Package Usage Information for Expanded Call Progress Tones Generator Package** + +| Properties | Mandatory/ Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------|----------------------------|--------------------------|------------------------------------|--|--| +| None | - | - | - | - | | | +| Signals | Mandatory/ Optional | Used in command: | | Duration Provisioned Value: | | | +| Comfort Tone
(xcg/cmft, 0x0024/0x004a)
Off-hook warning Tone
(xcg/roh, 0x0024/0x004b)
Negative Acknowledgement
(xcg/nack, 0x0024/0x004c)
Vacant Number Tone
(xcg/vac, 0x0024/0x004d)
Special Conditions Dial Tone
(xcg/spec, 0x0024/0x004e) | O | ADD, MOD, MOVE | | Value | | | +| | Signal Parameters | Mandatory/ Optional | Supported Values: | Duration Provisioned Value: | | | +| | Tone Direction
(btd, 0x0001) | M | Internal / External | Default=External | | | +| Events | Mandatory/ Optional | Used in command: | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| Statistics | Mandatory/ Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +#### 5.14.3.10 Basic Announcement Syntax Package + +**Table 5.14.3.10.1: Package Usage Information for Basic Announcement Syntax Package** + +| Properties | Mandatory/ Optional | Used in command: | Supported Values: | Provisioned Value: | +|-------------------|----------------------------|----------------------------|--------------------------|------------------------------------| +| None | - | - | - | - | +| Signals | Mandatory/ Optional | Used in command: | | Duration Provisioned Value: | +| None | - | - | | - | +| | Signal Parameters | Mandatory/ Optional | Supported Values: | Duration Provisioned Value: | + +| | | | | | | | +|--------------------|---------------------------------|---------------------------|--------------------------|---------------------------|--|--| +| | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command: | | | | | +| None | - | - | - | - | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| Statistics | Mandatory/Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +#### 5.14.3.11 Voice Variable Syntax Package + +Table 5.14.3.11.1: Package Usage Information for Voice Variable Syntax Package + +| | | | | | | | +|--------------------|---------------------------------|---------------------------|--------------------------|------------------------------------|--|--| +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | | | +| None | - | - | - | - | | | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | | | +| None | - | - | - | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | | | +| | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command: | | | | | +| None | - | - | - | - | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| Statistics | Mandatory/Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +#### 5.14.3.12 Announcement Set Syntax Package + +Table 5.14.3.12.1: Package Usage Information for Announcement Set Syntax Package + +| | | | | | +|-------------------|---------------------------|---------------------------|--------------------------|------------------------------------| +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | +| None | - | - | - | - | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | +| None | - | - | - | - | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | +| | - | - | - | - | +| Events | Mandatory/Optional | Used in command: | | | +| None | - | - | - | - | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | - | - | - | - | + +| | ObservedEvent Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | +|--------------------|--------------------------|---------------------|-------------------|--------------------| +| | - | - | - | - | +| Statistics | Mandatory/ Optional | Used in command: | | Supported Values: | +| None | - | - | - | - | +| Error Codes | Mandatory/ Optional | | | | +| None | - | | | | + +#### 5.14.3.13 General Text Variable Type Package + +Table 5.14.3.13.1: Package Usage Information for General Text Variable Type Package + +| Properties | Mandatory/ Optional | Used in command: | Supported Values: | Provisioned Value: | +|--------------------|--------------------------|---------------------|-------------------|-----------------------------| +| None | - | - | - | - | +| Signals | Mandatory/ Optional | Used in command: | | Duration Provisioned Value: | +| None | - | - | - | - | +| | Signal Parameters | Mandatory/ Optional | Supported Values: | Duration Provisioned Value: | +| | - | - | - | - | +| Events | Mandatory/ Optional | Used in command: | | | +| None | - | - | | | +| | Event Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | +| | - | - | - | - | +| | ObservedEvent Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | +| | - | - | - | - | +| Statistics | Mandatory/ Optional | Used in command: | | Supported Values: | +| None | - | - | - | - | +| Error Codes | Mandatory/ Optional | | | | +| None | - | | | | + +#### 5.14.3.14 Advanced Audio Server Base Package + +Table 5.14.3.14.1: Package Usage Information for Advanced Audio Server Base Package + +| Properties | Mandatory/ Optional | Used in command: | Supported Values: | Provisioned Value: | +|-----------------------------------------------------------|------------------------------------|-----------------------------|--------------------------|-----------------------------| +| None | - | - | - | - | +| Signals | Mandatory/ Optional | Used in command: | | Duration Provisioned Value: | +| Play
(aasb/play, 0x0033/0x0001) | M | ADD, MOD, MOVE, AUDITVALUE, | | - | +| | Signal Parameters | Mandatory/ Optional | Supported Values: | Duration Provisioned Value: | +| | Announcement (an, 0x0001) | M | Any String | - | +| | Iterations (it, 0x0002) | O | Any Integer | 1 | +| | Interval(iv, 0x0003) | O | 0 upwards | - | +| | Announcement Direction(di, 0x0006) | M | Ext (0x01)
Int (0x02) | Default=External | +| Events | Mandatory/ Optional | Used in command: | | | +| Audio operation failure
(aasb/audfail, 0x0033 /0x0001) | M | NOTIFY | | | +| | Event Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | +| | - | - | - | - | + +| | ObservedEvent Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +|--------------------|----------------------------|-------------------------|-------------------|--------------------------|--|--| +| | Return Code(rc, 0x0001) | M | FFS | - | | | +| Statistics | Mandatory/ Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +#### 5.14.3.15 Basic Call Progress Tones Generator with Directionality + +Table 5.14.3.15.1: Package Usage Information For Basic Call Progress Tones Generator with Directionality Package + +| Properties | Mandatory/ Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------|----------------------------|--------------------------|------------------------------------|--|--| +| None | - | - | - | - | | | +| Signals | Mandatory/ Optional | Used in command: | | Duration Provisioned Value: | | | +| Dial Tone (bcg/bdt, 0x0023/0x0040)
Ringing Tone (bcg/brt, 0x0023/0x0041)
Busy Tone (bcg/bbt, 0x0023/0x0042)
Congestion Tone (bcg/bct, 0x0023/0x0043)
Special Information Tone (bcg/bsit, 0x0023/0x0044)
Warning Tone (bcg/bwt, 0x0023/0x0045)
Payphone Recognition Tone (bcg/bpt, 0x0023/0x0046)
Call Waiting Tone (bcg/bcw, 0x0023/0x0047)
Caller Waiting Tone (bcg/bcr, 0x0023/0x0048)
Pay Tone (bcg/bpy, 0x0023/0x0049) | O | ADD, MOD, MOVE | | Value | | | +| | Signal Parameters | Mandatory/ Optional | Supported Values: | Duration Provisioned Value: | | | +| | Tone Direction (btd, 0x0001) | M | Internal / External | Default=External | | | +| Events | Mandatory/ Optional | Used in command: | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| Statistics | Mandatory/ Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +#### 5.14.3.16 AAS Recording Package + +Table 5.14.3.16.1: Package Usage Information for AAS Recording Package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|-------------------------------------------------------------|------------------------------------|---------------------------|--------------------------|------------------------------------|--|--| +| Maximum temporary record life (aasrec/maxtrl 0x0035/0x0003) | M | ADD, MOD, MOVE | ALL | - | | | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | | | +| PlayRecord (aasrec/playrec, 0x0035/0x0002) | M | ADD, MOD, MOVE | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | | | +| | Record Length Timer(rlt, 0x0008) | O | ALL | - | | | +| | Recording Identifier (rid, 0x0009) | M | ALL | - | | | +| | EndInputKey(eik, 0x0010) | O | ALL | | | | +| | record direction (rd, 0x0011) | O | Ext (0x01), Int(0x02) | Ext (0x01) | | | +| Make persistent (aasrec/makepers, 0x0035/0x0003) | Not Used | - | | | | | +| | Signal Parameters | Mandatory/Optional | Supported Values: | | | | +| | | | | | | | +| Events | Mandatory/Optional | Used in command: | | | | | +| Audio operation failure (aasrec/audfail, 0x0035/0x0001) | M | NOTIFY | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | None | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | Return Code(rc, 0x0001) | M | ALL | - | | | +| PlayRecord success(aasrec/precucc, 0x0035/0x0002)) | M | NOTIFY | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | None | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | Recording result (res, 0x0003) | M | ALL | - | | | +| | Recording id (ri, 0x0004) | M | ALL | - | | | +| | Record duration (rdur, 0x0005) | M | ALL | - | | | +| Statistics | Mandatory/Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +#### 5.14.3.17 Multimedia Play Package + +Table 5.14.3.17.1: Package Usage Information for Multimedia Play Package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|--------------------------------------|-------------------------------------------|---------------------------|------------------------------|------------------------------------|--|--| +| None | - | - | - | - | | | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | | | +| Play
(mpp/play,
0x00a9/0x0001) | M | ADD, MOD, MOVE | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | | | +| | Announcement
(an,0x0001) | M | ALL | - | | | +| | Iterations
(it,0x0002) | O | Any Integer | 1 | | | +| | Interval

(iv,0x0003) | O | 0 upwards | - | | | +| | Announcement
Direction
(di, 0x0006) | O | Ext (0x01)
Int (0x02) | Default=External | | | +| Events | Mandatory/Optional | Used in command: | | | | | +| None | - | - | | | | | +| | Event
Parameters
| Mandatory/Optional | Supported
Values:
| Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent
Parameters
| Mandatory/Optional | Supported
Values:
| Provisioned Value: | | | +| | - | - | - | - | | | +| Statistics | Mandatory/Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +#### 5.14.3.18 Generic Announcement Package + +Table 5.14.3.18.1: Package Usage Information for Generic Announcement Package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | +|-------------------------------------------------------------|-------------------------------------------|---------------------------|------------------------------|----------------------------------------| +| None | - | - | - | - | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | +| Fixed:
Announcement
play
(an/apf,
x001d/0x0001) | M | ADD, MOD, MOVE | | - | +| | Signal Parameters | Mandatory/Optional | Supported
Values:
| Duration Provisioned
Value:
| +| | Announcement
name
(an ,0x0001) | M | ALL | - | +| | Number of cycles
(noc ,0x0002) | O | Any Integer | - | +| | Announcement
Variant
(av ,0x0003) | O | ALL | - | +| | Announcement
Direction
(di ,0x0004) | O | Ext (0x01)
Int (0x02) | Default=External | + +| Events | Mandatory/ Optional | Used in command: | | | | | +|-------------|--------------------------|---------------------|-------------------|--------------------|--|--| +| | - | - | | | | | +| None | Event Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| Statistics | Mandatory/ Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +#### 5.14.3.19 Intrusion Tones Generator Package + +Table 5.14.3.19.1: Package Usage Information for Intrusion Tones Generator Package + +| Properties | Mandatory/ Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|---------------------|---------------------|-----------------------------|--|--| +| None | - | - | - | - | | | +| Signals | Mandatory/ Optional | Used in command: | | Duration Provisioned Value: | | | +| Intrusion Pending Tone (int/pend,0x0027/0x0057)
Intrusion Tone (int/int,0x0027/0x0058)
Intrusion Reminder Tone (int/rem,0x0027/0x0059)
Toll Break-In Tone (int/tbi,0x0027/0x005a)
Intrusion Queue Tone (int/intque,0x0027/0x005b)
Busy Verification Tone (int/bv,0x0027/0x005c) | O | ADD, MOD, MOVE | | - | | | +| | Signal Parameters | Mandatory/ Optional | Supported Values: | Duration Provisioned Value: | | | +| | Tone Direction (btd, 0x0001) | M | Internal / External | Default=External | | | +| Events | Mandatory/ Optional | Used in command: | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| Statistics | Mandatory/ Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +#### 5.14.3.20 Business Tones Generation Package + +Table 5.14.3.20.1: Package Usage Information for Business Tones Generation Package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------|---------------------------|--------------------------|------------------------------------|--|--| +| None | - | - | - | - | | | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | | | +| Off-Hook Queuing Tone (biztn/ofque,0x0028/0x005d)
Expensive Route Warning Tone (biztn/erwt,0x0028/0x005e)
Distinctive Dial Tone (biztn/ddt,0x0028/0x005f)
Internal Dial Tone (biztn/idt,0x0028/0x0060) | O | ADD, MOD, MOVE | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | | | +| | Tone Direction (btd, 0x0001) | M | Internal / External | Default=External | | | +| Events | Mandatory/Optional | Used in command: | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | - | - | | | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| Statistics | Mandatory/Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +#### 5.14.3.21 Conferencing Tones Generation Package + +Table 5.14.3.21.1: Package Usage Information for Conferencing Tones Generation Package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|---------------------------|--------------------------|------------------------------------| +| None | - | - | - | - | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | +| Conf. Entrance Tone (conftn/enter, 0x0038/0x0061)
Conf. Exit Tone (conftn/exit, 0x0038/0x0062)
Conf. Lock Tone (conftn/lock, 0x0038/0x0063)
Conf. Unlock Tone (conftn/unlock, 0x0038/0x0064)
Time Limit Warning Tone (conftn/timelim, 0x0038/0x0065) | O | ADD, MOD, MOVE | | - | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | +| | Tone Direction (btd, 0x0001) | M | Internal / External | Default=External | +| Events | Mandatory/Optional | Used in command: | | | +| None | - | - | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | + +| | | | | | | | +|--------------------|---------------------------------|----------------------------|--------------------------|---------------------------|--|--| +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| Statistics | Mandatory/ Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +#### 5.14.3.22 Inactivity Timer Package + +Table 5.14.3.22.1: Package Usage Information for Inactivity Timer Package + +| | | | | | | | +|-------------------------------------------|--------------------------------------|----------------------------|--------------------------|------------------------------------|--|--| +| Properties | Mandatory/ Optional | Used in command: | Supported Values: | Provisioned Value: | | | +| None | - | - | - | - | | | +| Signals | Mandatory/ Optional | Used in command: | | Duration Provisioned Value: | | | +| None | - | - | | - | | | +| | Signal Parameters | Mandatory/ Optional | Supported Values: | Duration Provisioned Value: | | | +| | - | - | - | - | | | +| Events | Mandatory/ Optional | Used in command: | | | | | +| Inactivity Timeout(it/ito, 0x0045/0x0001) | M | MOD, NOTIFY | | | | | +| | Event Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | Maximum Inactivity Time(mit, 0x0001) | M | Any integer | - | | | +| | ObservedEvent Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | None | - | - | - | | | +| Statistics | Mandatory/ Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +#### 5.14.3.23 MGC Information Package + +Table 5.14.3.23.1: Package Usage Information for MGC Information Package + +| | | | | | +|---------------------------------------|----------------------------|----------------------------|---------------------------|------------------------------------| +| Properties | Mandatory/ Optional | Used in command: | Supported Values: | Provisioned Value: | +| Data Block(MGCInfo/db, 0x00a0/0x0001) | M | ADD, MOD, AUDITVALUE | A range of 0 to 32 octets | An empty string | +| Signals | Mandatory/ Optional | Used in command: | | Duration Provisioned Value: | +| None | - | - | | - | +| | Signal Parameters | Mandatory/ Optional | Supported Values: | Duration Provisioned Value: | +| | - | - | - | - | +| Events | Mandatory/ Optional | Used in command: | | | +| None | - | - | | | +| | Event Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | +| | - | - | - | - | + +| | ObservedEvent Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +|--------------------|--------------------------|---------------------|-------------------|--------------------|--|--| +| | - | - | - | - | | | +| Statistics | Mandatory/ Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +#### 5.14.3.24 Advanced audio server base package for TTS enhancement + +Table 5.14.3.24.1: Package Usage Information for TTS enhancement package + +| Properties | Mandatory/ Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|---------------------------------------------------------|---------------------------------|----------------------------|--------------------------|------------------------------------|--|--| +| None | - | - | - | - | | | +| Signals | Mandatory/ Optional | Used in command: | | Duration Provisioned Value: | | | +| Play Segment Identifier (aastts/playsid, 0x00a8/0x0001) | M | ADD, MOD, MOVE | | - | | | +| | Signal Parameters | Mandatory/ Optional | Supported Values: | Duration Provisioned Value: | | | +| | Announcement (an, 0x0001) | M | ALL | - | | | +| | Iterations (it, 0x0003) | O | 0 upwards | 1 | | | +| | Interval (iv, 0x0004) | O | 0 upwards | - | | | +| | Direction (di, 0x0005) | O | Ext (0x01)
Int(0x02) | Default=External | | | +| Play script (aastts/playscript, 0x00a8/0x0002) | M | ADD, MOD, MOVE | | - | | | +| | Signal Parameters | Mandatory/ Optional | Supported Values: | Duration Provisioned Value: | | | +| | Script (script, 0x0001) | M | (NOTE 1) | - | | | +| | Iterations (it, 0x0003) | O | 0 upwards | 1 | | | +| | Interval (iv, 0x0004) | O | ALL | - | | | +| | Direction (di, 0x0005) | | Ext (0x01)
Int(0x02) | Default=External | | | +| Events | Mandatory/ Optional | Used in command: | | | | | +| TTS operation failure(aastts/ttsfail, 0x00a8/0x0001) | M | ADD, MOD, NOTIFY | | | | | +| | Event Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | None | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | Return Code (rc, 0x0001) | M | ALL | - | | | +| Statistics | Mandatory/ Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +NOTE 1: The value shall comply with the Annex A : "The W3C SSML Profile for TTS function". + +#### 5.14.3.25 ASR Package + +Table 5.14.3.25.1: Package Usage Information for ASR Package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|-------------------------------------------------------------------|--------------------------------------------------|---------------------------|-----------------------------------|------------------------------------|--|--| +| None | - | - | - | - | | | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | | | +| ASR recognition with grammar script(asr/asrwgs, 0x00a6/0x0001) | M | ADD, MOD, MOVE | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | | | +| | grammar file (rgs, 0x0002) | M | (NOTE 1) | - | | | +| | Recognition grammar script format (rgsf, 0x0004) | O | ABNF (0x0001), XML (0x0002) | ABNF (0x0001) | | | +| | recognition mode (rm, 0x0005) | O | Normal (0x0001), Hotword (0x0002) | Normal(0x0001) | | | +| | End Input Key (eik, 0x0006) | O | ALL | - | | | +| ASR recognition with grammar identifier(asr/asrid, 0x00a6/0x0002) | M | ADD, MOD, MOVE | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | | | +| | Recognition grammar identifier (rgid, 0x0002) | M | ALL | - | | | +| | Recognition grammar script type (rgst, 0x0003) | Not Used | | | | | +| | Recognition grammar script format (rgsf, 0x0004) | O | ABNF (0x0001), XML (0x0002) | ABNF (0x0001) | | | +| | recognition mode (rm, 0x0005) | O | Normal (0x0001), Hotword (0x0002) | Normal(0x0001) | | | +| | End Input Key (eik, 0x0006) | O | ALL | - | | | +| Events | Mandatory/Optional | Used in command: | | | | | +| ASR failure (asr/asrfail, 0x00a6/0x0001) | M | ADD, MOD, NOTIFY | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | None | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | Return Code (rc, 0x0001) | M | ALL | - | | | +| ASR success(asr/asrsucc, 0x00a6/0x0002) | M | ADD, MOD, NOTIFY | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | None | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | ASR result (asrr, 0x0001) | M | ALL | - | | | +| Statistics | Mandatory/Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +NOTE 1: The value shall comply with Annex B. "the W3C SRGS Profile for ASR function". + +#### 5.14.3.26 Multimedia Recording Package + +Table 5.14.3.26.1: Package Usage Information for Multimedia Recording Package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|--------------------------------------------|---------------------------------------|---------------------------|---------------------------|------------------------------------|--|--| +| None | - | - | - | - | | | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | | | +| PlayRecord
(mrp/playrec, 0x00b3/0x0002) | M | ADD, MOD, MOVE | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | | | +| | Record Length
Timer(rlt, 0x0008) | M | ALL | - | | | +| | Recording Identifier
(rid, 0x0009) | M | ALL | - | | | +| | EndInputKey(eik, 0x0010) | O | ALL | - | | | +| | record direction
(rd, 0x0011) | O | Ext (0x01) ,
Int(0x02) | Ext (0x01) | | | +| Events | Mandatory/Optional | Used in command: | | | | | +| none | - | - | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| Statistics | Mandatory/Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +#### 5.14.3.27 Tone Generator Package + +Table 5.14.3.27.1: Package Usage Information for Tone Generator Package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|------------------------------------------|---------------------------------|---------------------------|--------------------------|------------------------------------|--|--| +| None | - | - | - | - | | | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | | | +| Play Tone
(tonegen/pt, 0x0003/0x0001) | Not Used | - | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | | | +| | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command: | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| Statistics | Mandatory/Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +#### 5.14.3.28 Hanging Termination Detection Package + +Table 5.14.3.28.1: Package Usage Information for Hanging Termination Detection Package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | +|--------------------------------------------------------|---------------------------------|------------------------------------|--------------------------|------------------------------------| +| None | | | | | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | +| None | | | | | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | +| | | | | | +| Events | Mandatory/Optional | Used in command: | | | +| Termination Heartbeat (hangterm/ thb, (0x0098/0x0001)) | M | ADD, MOD, MOVE, AUDITVALUE, NOTIFY | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | Timer X | M | ALL | 0 (no heartbeat message) | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | | | | | +| Statistics | Mandatory/Optional | Used in command: | | Supported Values: | +| None | | | | | +| Error Codes | Mandatory/ Optional | | | | +| | | | | | + +#### 5.14.3.29 MSRP Statistics Package + +Table 5.14.3.29.1: Package Usage Information for MSRP Statistics Package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | +|--------------------------------------------------|------------------------------------------------|---------------------------|--------------------------|------------------------------------| +| None | - | - | - | - | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | +| None | - | - | - | - | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | +| | - | - | - | - | +| Events | Mandatory/Optional | Used in command: | | | +| Messaging Quota (msrpstat/mquota, 0x00ea/0x0001) | M | ADD, MOD, NOTIFY | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | Number of Messages Sent Quota(msq, 0x0001) | O | 0 and up | 0 | +| | Number of Messages Received Quota(mrq, 0x0002) | O | 0 and up | 0 | +| | Messages Sent Volume Quota(msv, 0x0003) | O | 0 and up | 0 | +| | Messages Received Volume Quota (mrv, 0x0004) | O | 0 and up | 0 | +| | Time Quota (tm, 0x0005) | O | Any Integer | 0 | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | + +| | | | | | | | +|---------------------------------------------------------------------|-------------------------------------------|----------------------------|--------------------------|---------------------------|--|--| +| | Quota Reached (qreach, 0x0001) | M | 0x0001 - 0x0005 | - | | | +| | Number of Messages Sent (nms, 0x0002) | O | 0 and up | - | | | +| | Number of Messages Received (nmr, 0x0003) | O | 0 and up | - | | | +| | Volume of Messages Sent (vms, 0x0004) | O | 0 and up | - | | | +| | Volume of Messages Received (vmr, 0x0005) | O | 0 and up | - | | | +| Events | Mandatory/ Optional | Used in command: | | | | | +| Individual Message Information (msrpstat/imi, 0x00ea/0x0002) | Not Used | - | | | | | +| | Event Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| Statistics | Mandatory/ Optional | Used in command: | | Supported Values: | | | +| Number of Messages Sent (msrpstat/nms, 0x00ea/0x0001) | O | AUDITVALUE | | 0 and up | | | +| Number of Messages Received (msrpstat/nmr, 0x00ea/0x0002) | O | AUDITVALUE | | 0 and up | | | +| Volume of Messages Sent (msrpstat/vms, 0x00ea/0x0003) | O | AUDITVALUE | | 0 and up | | | +| Volume of Messages Received (msrpstat/vmr, 0x00ea/0x0004) | O | AUDITVALUE | | 0 and up | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +#### 5.14.3.30 Play Message Package + +Table 5.14.3.30.1: Package Usage Information for Play Message Package + +| Properties | Mandatory/ Optional | Used in command: | Supported Values: | Provisioned Value: | +|---------------------------------------|---------------------------------------------|----------------------------|--------------------------|------------------------------------| +| None | - | - | - | - | +| Signals | Mandatory/ Optional | Used in command: | | Duration Provisioned Value: | +| Send Message (mess/sm, 0x00ec/0x0001) | M | ADD, MOD, MOVE | | - | +| | Signal Parameters | Mandatory/ Optional | Supported Values: | Duration Provisioned Value: | +| | Message Identity (mi, 0x0001) | M | Any String | - | +| | Message Contents by reference (mcr, 0x0002) | M | Any String | - | +| | Failure Report (fr, 0x0003) | O | yes/no | yes | + +| | | | | | | | +|------------------------------------------------------------|---------------------------------|---------------------------|--------------------------|---------------------------|--|--| +| | Success Report (sr, 0x0004) | O | yes/no | no | | | +| Events | Mandatory/Optional | Used in command: | | | | | +| Message Sending Response Status (mess/msrs, 0x00ec/0x0001) | M | ADD, MOD, NOTIFY | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | Message Identity (mi, 0x0001) | M | Any String | - | | | +| | Status Code (sc, 0x0002) | M | Any String | - | | | +| Statistics | Mandatory/Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +#### 5.14.3.31 Message Filtering Package + +Table 5.14.3.31.1: Package Usage Information for Message Filtering Package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | +|----------------------------------------------------------------|---------------------------------|---------------------------|--------------------------|------------------------------------| +| Incoming Message Filters (mf/imf, 0x00ef/0x0001) | O | ADD, MOD | (NOTE 1) | - | +| Incoming Message Filters by Reference (mf/imfr, 0x00ef/0x0002) | Not Used | - | - | - | +| Outgoing Message Filters (mf/omf, 0x00ef/0x0003) | O | ADD, MOD | (NOTE 1) | - | +| Outgoing Message Filters by Reference (mf/omfr, 0x00ef/0x0004) | Not Used | - | - | - | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | +| None | - | - | | - | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | +| | - | - | - | - | +| Events | Mandatory/Optional | Used in command: | | | +| Filed Message (mf/fm, 0x00ef/0x0001) | Not Used | - | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | - | - | - | - | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | - | - | - | - | +| Events | Mandatory/Optional | Used in command: | | | +| Filtering Runtime Error (mf/fre, 0x00??/0x0002) | FFS | - | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | - | - | - | - | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | + +| | | | | | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------|-------------------------|---|--------------------------|--|--| +| | - | - | - | - | | | +| Statistics | Mandatory/
Optional
| Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| Sieve Script
Syntax Error (700) | FFS | | | | | | +| Unsupported
Sieve Require
Error (701) | FFS | | | | | | +| Sieve Actions
Exceeded Error
(702) | FFS | | | | | | +| NOTE 1: The value shall comply with Sieve [IETF RFC5228] with the exceptions described in H.248.69 [35] Clause 13.6. Filtering rules and Message treatment for Filtered message are included in the parameter. | | | | | | | + +#### 5.14.3.32 Record Message Package + +Table 5.14.3.32.1: Package Usage Information for Record Message Package + +| Properties | Mandatory/
Optional
| Used in command: | Supported Values: | Provisioned Value: | | | +|----------------------------------------------------------------------|--------------------------------------|--------------------------------|------------------------------|----------------------------------------|--|--| +| None | - | - | - | - | | | +| Signals | Mandatory/
Optional
| Used in command: | | Duration Provisioned
Value:
| | | +| Record Message
(recmess/rm,
0x00f1/0x0001) | M | ADD, MOD, MOVE | | - | | | +| | Signal Parameters | Mandatory/
Optional
| Supported
Values:
| Duration Provisioned
Value:
| | | +| | Storage Location
(sl, 0x0001) | M | Any String | - | | | +| | Append (app,
0x0002) | Not Used | - | - | | | +| | Direction (dir,
0x0003) | O | EXT/INT | EXT | | | +| | Maximum Record
Size (mrs, 0x0004) | Not Used | | | | | +| Events | Mandatory/
Optional
| Used in command: | | | | | +| Record Operation
Failure
(recmess/messfail,
0x00f1/0x0001 ) | Not Used | - | | | | | +| | Event
Parameters
| Mandatory/
Optional
| Supported
Values:
| Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent
Parameters
| Mandatory/
Optional
| Supported
Values:
| Provisioned Value: | | | +| | - | - | - | - | | | +| Statistics | Mandatory/
Optional
| Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +#### 5.14.3.33 Floor Control Package + +Table 5.14.3.33.1: Package Usage Information for Floor Control Package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|------------------------------------------------------|---------------------------------|---------------------------|--------------------------|------------------------------------|--|--| +| Controller's Floor Identity (fcp/cfi, 0x006e/0x0002) | M | ADD, MOD | Sub-list of Integer | - | | | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | | | +| None | - | - | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | | | +| | - | - | | - | | | +| Events | Mandatory/Optional | Used in command: | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | - | - | | | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | - | - | | | | | +| Statistics | Mandatory/Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +#### 5.14.3.34 Floor Control Policy Package + +Table 5.14.3.34.1: Package Usage Information for Floor Control Policy Package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|-----------------------------------------------------|---------------------------------|---------------------------|---------------------------------------------------|------------------------------------|--|--| +| Floor Control Algorithm (fcpoli/fca, 0x00ab/0x0001) | M | ADD, MOD | Sub-list of String with (FloorID COLON Algorithm) | - | | | +| Max Floor Users (fcpoli/mfu, 0x00ab/0x0002) | M | ADD, MOD | Sub-list of String with (FloorID COLON NumUsers) | - | | | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | | | +| None | - | - | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | | | +| | - | - | | - | | | +| Events | Mandatory/Optional | Used in command: | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | - | - | | | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | - | - | | | | | +| Statistics | Mandatory/Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +#### 5.14.3.35 Floor Status Change Handling Package + +Table 5.14.3.35.1: Package Usage Information for Floor Status Change Handling Package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | | | +|------------------------------------------------------------------|---------------------------------|---------------------------|------------------------------------------------|------------------------------------|--|--| +| None | - | - | - | - | | | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | | | +| Confirm Media Update (fschp/cmu, 0x00aa/0x0001) | M | MOD | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | | | +| | Floor Status(fs, 0x0001) | M | Sub-list of String with (FloorID COLON Status) | - | | | +| | Result(res, 0x0002) | M | Success/Fail | Success | | | +| Events | Mandatory/Optional | Used in command: | | | | | +| Floor Status Detection and Reporting (fschp/fsdr, 0x00aa/0x0001) | M | ADD, MOD, NOTIFY | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | | | +| | Floor Status(fs, 0x0001) | M | Sub-list of String with (FloorID COLON Status) | - | | | +| Statistics | Mandatory/Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +#### 5.14.3.36 Floor Control Signalling Package + +Table 5.14.3.36.1: Package Usage Information for Floor Control Signalling Package + +| Properties | Mandatory/Optional | Used in command: | Supported Values: | Provisioned Value: | +|------------------------------------------------------------------|---------------------------------|---------------------------|--------------------------|------------------------------------| +| Floor Control Conference Identity (fcsig/fconfid, 0x00e5/0x0001) | M | ADD, MOD | Sub-list of Integer | - | +| Floor and Stream Association (fcsig/fsa, 0x00e5/0x0002) | M | ADD, MOD | Sub-list of String | - | +| Signals | Mandatory/Optional | Used in command: | | Duration Provisioned Value: | +| None | - | - | | - | +| | Signal Parameters | Mandatory/Optional | Supported Values: | Duration Provisioned Value: | +| | - | - | - | - | +| Events | Mandatory/Optional | Used in command: | | | +| Floor Control Association Timeout (fcsig/tout, 0x00e5/0x0001) | Not Used | - | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | +| | - | - | - | - | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values: | Provisioned Value: | + +| | | | | | | | +|-----------------------------------------------------------------|---------------------------------|----------------------------|--------------------------|---------------------------|--|--| +| | - | - | - | - | | | +| Floor Control Association Release
(fcsig/rel, 0x00e5/0x0002) | Not Used | | - | | | | +| | Event Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/ Optional | Supported Values: | Provisioned Value: | | | +| | - | - | - | - | | | +| Statistics | Mandatory/ Optional | Used in command: | | Supported Values: | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/ Optional | | | | | | +| None | - | | | | | | + +#### 5.14.3.37 Explicit Congestion Notification for RTP-over-UDP Support (ecnrous) + +Table 5.14.3.37.1: Explicit Congestion Notification for RTP-over-UDP Support package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | +|----------------------------------------------------------------|----------------------------------|---------------------|--------------------|---------------------------------------------------------------------------------------------| +| ECN Enabled (ecnrous/ecnen, 0x010b/0x0001) | M | ADD, MODIFY | True, False | - | +| Congestion Response Method (ecnrous/crm, 0x010b/0x0002) | Not Signalled | - | - | "RDCC"(0x0002)
NOTE | +| Initiation Method (ecnrous/initmethod, 0x010b/0x0003) | M | ADD, MODIFY | "leap", "inactive" | "leap" | +| ECN Mode (ecnrous/mode, 0x010b/0x0004) | Not Signalled | - | - | "setonly" (0x0001) in the Remote Descriptor and "readonly" (0x0002) in the Local Descriptor | +| ECT Marking (ecnrous/ectmark, 0x010b/0x0005) | Not Signalled | - | - | "0" (0x0002) | +| ECN Congestion Marking (ecnrous/congestmark, 0x010b/0x0006) | Not Signalled | - | - | "nomark" (0x0003) | +| ECN SDP Usage (ecnrous/ecnsdp, 0x010b/0x0007) | Not Signalled | - | - | "P" (0x0001) | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | +| None | - | - | | - | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | +| | - | - | - | - | +| Events | Mandatory/Optional | Used in command | | | +| ECN Failure (ecnrous/fail, 0x010b/0x0001) | M | ADD, MODIFY, NOTIFY | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | +| | - | - | - | - | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | +| | Failure Type (type,0x0001) | Mandatory | INIT, USE | - | +| | Media Sender SSRC (ssrc, 0x0002) | Not Supported | - | - | +| Statistics | Mandatory/Optional | Used in command | Supported Values | | +| Source (ecnrous/ssrc, 0x010b/0x0001) | Not Supported | - | - | | +| CE Counter (ecnrous/cecount, 0x010b/0x0002) | Not Supported | - | - | | +| ECT0 Counter (ecnrous/ectzero, 0x010b/0x0003) | Not Supported | - | - | | +| ECT1 Counter (ecnrous/ectone, 0x010b/0x0004) | Not Supported | - | - | | +| Not-ECT Counter (ecnrous/notect, 0x010b/0x0005) | Not Supported | - | - | | +| Lost Packets Counter (ecnrous/lost, 0x010b/0x0006) | Not Supported | - | - | | +| Extended Highest Sequence number (ecnrous/ehsn, 0x010b/0x0007) | Not Supported | - | - | | +| Duplication Counter (ecnrous/dup, 0x010b/0x0008) | Not Supported | - | - | | +| Error Codes | Mandatory/Optional | | | | +| None | - | | | | + +NOTE: Application Specific Rate Adaptation shall be applied in accordance with 3GPP TS 26.114 [41]. For speech this requires support of CMR and TMMBR (defined in IETF RFC 5104 [71]) for video. + +#### 5.14.3.38 Differentiated Services (ds) + +**Table 5.14.3.38.1: Differentiated Services package** + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | | | +|-------------------------------------------------------------|--------------------------|--------------------|------------------|----------------------------|--|--| +| Differentiated Services Code Point (ds/dscp, 0x008b/0x0001) | M | ADD, MODIFY | ALL | Yes | | | +| Tagging Behaviour (ds/tb, 0x008b/0x0002) | Not signalled | - | - | "MARK" (0x0000) | | | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | | | +| None | - | - | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | | | +| | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| Statistics | Mandatory/Optional | Used in command | Supported Values | | | | +| None | - | - | - | | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +#### 5.14.3.39 MG Act-as STUN Server (mgastuns) + +**Table 5.14.3.39.1: MG Act-as STUN Server** + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | | | +|-----------------------------------------------------|--------------------------|--------------------|------------------|----------------------------|--|--| +| Act-as STUN Server (mgastuns/astuns, 0x00c2/0x0001) | M | ADD, MODIFY | ALL | - | | | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | | | +| None | - | - | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | | | +| | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| Statistics | Mandatory/Optional | Used in command | Supported Values | | | | +| None | - | - | - | | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +#### 5.14.3.40 Originate STUN Continuity Check (ostuncc) + +Table 5.14.3.40.1: Originate STUN Continuity Check Package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | +|------------------------------------------------------------------|----------------------------------------|---------------------------|-----------------------------|-----------------------------------| +| Host Candidate Realm (ostuncc/hcr, 0x00c3/0x0001) | O | ADD, MODIFY | ALL | Yes | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | +| Send Connectivity Check (ostuncc/scc, 0x00c3/0x0001) | M | ADD, MODIFY | | Not Applicable | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | +| | Control (cntrl, 0x0001) | O | "controlling", "controlled" | Not Applicable | +| Send Additional Connectivity Check (ostuncc/sacc, 0x00c3/0x0002) | Mandatory/Optional | Used in command | | Duration Provisioned Value | +| | M | MODIFY | | Not Applicable | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | +| | Control (cntrl, 0x0001) | O | "controlling", "controlled" | Not Applicable | +| Events | Mandatory/Optional | Used in command | | | +| Connectivity Check Result (ostuncc/ccr, 0x00c3/0x0001) | M | ADD, MODIFY, NOTIFY | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | +| | - | - | - | - | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | +| | Candidate/Transport Pair (ctp, 0x0001) | M | ALL | Not applicable | +| New Peer Reflexive Candidate (ostuncc/nprc, 0x00c3/0x0002) | Mandatory/Optional | Used in command | | | +| | M | ADD, MODIFY, NOTIFY | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | +| | - | - | - | - | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | +| | Candidate (can, 0x0001) | M | ALL | Not applicable | +| Statistics | Mandatory/Optional | Used in command | | Supported Values | +| None | - | - | | - | +| Error Codes | Mandatory/Optional | | | | +| None | - | | | | + +##### 5.14.3.4.1 TCP basic connection control (tcpbcc) + +Table 5.14.3.4.1.1: TCP basic connection control package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | +|--------------------------------------------------------------------------------|-------------------------------------|---------------------|--------------------------------------------------------------|----------------------------| +| Incoming bearer connection establishment blocking (tcpbcc/bceb, 0x0115/0x0001) | O | ADD, MODIFY | ALL | "Unblocked" | +| Oneway Release Indicator (tcpbcc/ori, 0x0115/0x0002) | not supported | - | - | "False" | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | +| Establish BNC (tcpbcc/EstBNC, 0x0115/0x0001) | M | ADD, MODIFY | | - | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | +| | - | - | - | - | +| Release BNC (tcpbcc/RelBNC, 0x0115/0x0002) | O (NOTE 1) | ADD, MODIFY | | - | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | +| | - | - | - | - | +| Events | Mandatory/Optional | Used in command | | | +| TCP connection state change (tcpbcc/BNCChange, 0x0115/0x0001) | O (NOTE 2) | ADD, MODIFY, NOTIFY | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | +| | Type of state change (Type, 0x0001) | M | Est [0x01] Bearer Established,
Rel [0x05] Bearer Released | - | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | +| | Type of state change (Type, 0x0001) | M | Est [0x01] Bearer Established,
Rel [0x05] Bearer Released | - | +| Statistics | Mandatory/Optional | Used in command | Supported Values | | +| None | - | - | - | | +| Error Codes | Mandatory/Optional | | | | +| None | - | | | | + +NOTE 1: When the MRFC wants to explicitly trigger the TCP bearer connection release procedure (instead of the implicit trigger related to the removal of the H.248 stream via a MODify.request or SUBtract.request command). + +NOTE 2: When the MRFC wants to monitor the execution of TCP bearer control procedures. + +#### 5.14.3.42 TLS basic session control (tlsbsc) + +Table 5.14.3.42.1: TLS basic session control package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | +|-------------------------------------------------------------------------------|-------------------------------------|--------------------------------------------------------------|--------------------------------------------------------------|-----------------------------------| +| Incoming security session establishment blocking (tlsbsc/bceb, 0x0117/0x0001) | O | ADD, MODIFY | ALL | "Unblocked" | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | +| Establish BNC (tlsbsc/EstBNC, 0x0117/0x0001) | M | ADD, MODIFY | | - | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | +| | - | - | - | - | +| Release BNC (tlsbsc/RelBNC, 0x0117/0x0002) | O (NOTE 1) | ADD, MODIFY | | - | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | +| | - | - | - | - | +| Events | Mandatory/Optional | Used in command | | | +| TLS session state change (tlsbsc/BNCChange, 0x0117/0x0001) | O (NOTE 2) | ADD, MODIFY, NOTIFY | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | +| | Type of state change (Type, 0x0001) | M | Est [0x01] Bearer Established,
Rel [0x05] Bearer Released | - | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | +| Type of state change (Type, 0x0001) | M | Est [0x01] Bearer Established,
Rel [0x05] Bearer Released | | - | +| Statistics | Mandatory/Optional | Used in command | Supported Values | | +| None | - | - | - | | +| Error Codes | Mandatory/Optional | | | | +| None | - | | | | + +NOTE 1: When the MRFC wants to explicitly trigger the TLS bearer session release procedure (instead of the implicit trigger related to the removal of the H.248 stream via a MODIFY.request or SUBtract.request command). + +NOTE 2: When the MRFC wants to monitor the execution of TLS bearer control procedures. + +#### 5.14.3.43 MGC Controlled Bearer Level ALG (mcbalg) + +Table 5.14.3.43.1: MGC Controlled Bearer Level ALG Package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | | | +|---------------------------------------------------------|-----------------------------------------|---------------------------|-------------------------|-----------------------------------|--|--| +| None | - | - | - | - | | | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | | | +| Send Bearer Level Message (mcbalg/sblm, 0x0108/0x0001) | M | | MODIFY | Not Applicable | | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | | | +| | Message Content (mc, 0x0001) | M | ALL | Not applicable | | | +| | Sent Application Protocol (sap, 0x0002) | O | ALL | Not applicable | | | +| | Label (lbl, 0x0003) | O | ALL | Not applicable | | | +| Events | Mandatory/Optional | Used in command | | | | | +| Detect Bearer Level Message (mcbalg/det, 0x0108/0x0001) | M | | MODIFY, NOTIFY | | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | Protocol Filter (pf, 0x0001) | Not supported | - | - | | | +| | Message Filter (mf, 0x0002) | Not supported | - | - | | | +| | Forwarding Flag (ff, 0x0003) | Not supported | - | - | | | +| | Enhanced Protocol Filter (ehpf, 0x0004) | O | ALL | Not applicable | | | +| | Label (lbl, 0x0005) | O | ALL | Not applicable | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | Message Content (mc, 0x0001) | M | ALL | Not applicable | | | +| | Detected Protocol (dtp, 0x0002) | O | ALL | Not applicable | | | +| | Label (lbl, 0x0003) | O | ALL | Not applicable | | | +| Statistics | Mandatory/Optional | Used in command | Supported Values | | | | +| None | - | - | - | | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +#### 5.14.3.44 Enhanced Revised Offer/Answer SDP Support (eroas) + +**Table 5.14.3.44.1: Enhanced Revised Offer/Answer SDP Support package** + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | +|--------------------------------------------------|---------------------------------|---------------------------|-------------------------|-----------------------------------| +| SDPCapNeg Extensions (eroas/sdpe, 0x0109/0x0001) | M | AuditValue | "cap-v0" | "cap-v0" | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | +| None | - | - | | - | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | +| | - | - | - | - | +| Events | Mandatory/Optional | Used in command | | | +| None | - | - | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | +| | - | - | - | - | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | +| | - | - | - | - | +| Statistics | Mandatory/Optional | Used in command | Supported Values | | +| None | - | - | - | | +| Error Codes | Mandatory/Optional | | | | +| None | - | | | | + +#### 5.14.3.45 Remote Pause and Resume (rempr) + +**Table 5.14.3.45.1: Remote Pause and Resume package** + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | +|----------------------------------------------|----------------------------------|---------------------------|---------------------------------------------|-----------------------------------| +| Autonomous Response (rempr/ar 0x0123/0x0001) | M | ADD, MODIFY | "On MG autonomous",
"Off MGC controlled" | - | +| Autonomous Request (rempr/aq 0x0123/0x0002) | M | ADD, MODIFY | "On MG autonomous",
"Off MGC controlled" | - | +| Signals | Mandatory/Optional | Used in command | Duration Provisioned Value | | +| Local Pause (rempr/lpause 0x0123/0x0001) | Not Supported | - | - | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | +| | Pause Identity (pauseID, 0x0001) | - | - | - | +| | ssrc (ssrc, 0x0002) | - | - | - | +| Local Resume (rempr/lresume 0x0123/0x0002) | Not Supported | - | - | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | +| | Pause Identity (pauseID, 0x0001) | - | - | - | +| | ssrc (ssrc, 0x0002) | - | - | - | +| Refuse (rempr/refuse 0x0123/0x0003) | Not Supported | - | - | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | +| | Pause Identity (pauseID, 0x0001) | - | - | - | +| | ssrc (ssrc, 0x0002) | - | - | - | +| Remote Pause (rempr/rpause 0x0123/0x0004) | Not Supported | - | - | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | +| | Pause Identity (pauseID, 0x0001) | - | - | - | + +| | | | | | +|-------------------------------------------------------------------|-------------------------------------|---------------------------|-------------------------|-----------------------------------| +| | ssrc (ssrc, 0x0002) | - | - | - | +| Remote Resume
(rempr/rresume
0x0123/0x0005) | Not Supported | - | - | - | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | +| | Pause Identity
(pauseID, 0x0001) | - | - | - | +| | ssrc (ssrc, 0x0002) | - | - | - | +| Events | Mandatory/Optional | Used in command | | | +| RTP Pause State
(rempr/rtpps
0x0123/0x0001) | Not Supported | - | - | - | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | +| | State (state, 0x0001) | - | - | - | +| | ssrc (ssrc, 0x0002) | - | - | - | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | +| | Observed State
(obstate, 0x0001) | - | - | - | +| | ssrc (ssrc, 0x0002) | - | - | - | +| Detect Pause/Resume Request
(rempr/dprrq
0x0123/0x0002) | Not Supported | - | - | - | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | +| | ssrc (ssrc, 0x0001) | - | - | - | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | +| | Pause Identity
(pauseID, 0x0001) | - | - | - | +| | Request Type (reqt, 0x0002) | - | - | - | +| | ssrc (ssrc, 0x0003) | - | - | - | +| Detect Pause and Resume Result
(rempr/dppres
0x0123/0x0003) | Not Supported | - | - | - | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | +| | ssrc (ssrc, 0x0001) | - | - | - | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | +| | Pause Identity
(pauseID, 0x0001) | - | - | - | +| | Response Type (rest, 0x0002) | - | - | - | +| | ssrc (ssrc, 0x0003) | - | - | - | +| Statistics | Mandatory/Optional | Used in command | Supported Values | | +| Local Pause duration
(rempr/lpdur
0x0123/0x0001) | Not Supported | - | - | | +| Remote Local Pause duration
(rempr/rpdur
0x0123/0x0002) | Not Supported | - | - | | +| Error Codes | Mandatory/Optional | | | | +| None | - | - | - | - | + +#### 5.14.3.46 Multi-stream Multiparty Conferencing Media Handling (mmcmh) + +Table 5.14.3.46.1: Multi-stream Multiparty Conferencing Media Handling package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | +|-------------------------------------------|---------------------------------|---------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------| +| MMCMH policy (mmcmh/mmcmhp 0x????/0x0001) | M | ADD, MODIFY | mmcmhbp (0x0001) "MMCMH basic policy",

vadv (0x0002) "Voice activity detected video",

vada (0x0003) "Voice activity detected audio",

ma (0x0004) "Mix audio",

bfcpa (0x0005) "BFCP audio",

bfcpv (0x0006) "BFCP video",

bfcps (0x0007) "BFCP screenshare" | - | +| Signals | Mandatory/Optional | Used in command | Duration Provisioned Value | | +| None | - | - | - | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | +| | - | - | - | - | +| Events | Mandatory/Optional | Used in command | | | +| None | - | - | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | +| | - | - | - | - | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | +| | - | - | - | - | +| Statistics | Mandatory/Optional | Used in command | Supported Values | | +| None | - | - | - | | +| Error Codes | Mandatory/Optional | | | | +| None | - | | | | + +## 5.15 Mandatory Support of SDP and Annex C Information Elements + +The v=, o=, s=, m=, c=, t=, a= and b= lines of the SDP [20] syntax shall be supported. All other lines should be ignored if received. + +Table 5.15.1: Supported Annex C and SDP information elements + +| | +|--------------------------------------------------------| +| Supported Annex C and SDP information elements: | +|--------------------------------------------------------| + +| Information Element | Annex C Support | SDP Support | +|--------------------------|-----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Protocol version (v=) | "SDP_V " |

The protocol version (v=) line contains a single field:
v= <version>

and shall be used in accordance with IETF RFC 2327 [20] (i.e. v=0).

| +| Origin (o=) | "SDP_O " |

The origin line consists of 6 fields:
o= <user name> <session ID> <version> <network type> <address type> <address>.

The MRFC is not required to supply this line but shall accept it.

The MRFP should populate this line as follows or use the value received from the MRFC:

  • - <user name> should contain an hyphen
  • - <session ID> and <version> should contain one or more digits as described in IETF RFC 2327 [20]
  • - <network type> shall be set to IN
  • - <address type> shall be set to IP4 or IP6 The Address Type shall be set to "IP4" or "IP6" depending on the addressing scheme used by the network to which the MRFP is connected.
  • - <address> should contain the fully qualified domain name of the gateway.
| +| Session Name (s=) | "SDP_S " |

The session name (s=) line contains a single field:
s= <session-name>.

The MRFC is not required to supply a session name but shall accept one. This line may be used to convey correlation information for use in CDRs.

The MRFP shall use an hyphen "-" as a session name or the value received from the MRFC.

| +| Connection data (c=) | "SDP_C " |

The connection data line consists of 3 fields:
c= <network-type> <address-type> <connection-address>

  • - The <network-type> shall be set to "IN".
  • - The <address-type> shall be set to "IP4" or "IP6" depending on the addressing scheme used by the network to which the MRFP is connected.
  • - The <connection-address> sent by the MRFC in the remote descriptor is the address to which the MRFP shall send the media flows.
  • - The <connection-address> sent by the MRFC in local descriptors may be a unicast IPv4 or IPv6 address or it may be wildcarded to allow the MRFP to choose an address. In the second case, MGs shall fill this field with a unicast IP address at which they will receive the media stream. Thus a TTL value shall not be present and a "number of addresses" value shall not be present. The field shall not be filled with a fully-qualified domain name instead of an IP address.

When the <connection address> is wildcarded (i.e. choose wildcard) by the MRFC, the MRFP allocates an IP address based on the address type. The addressing space for which this address is taken may depend on the termination ID supplied by the MRFC.

| +| Media announcements (m=) | "SDP_M " |

Media Announcements (m=) lines consist of 3 fields:
m= <media> <port> <transport> <format>

  • - The <media> field shall be set to "audio" or "video" or "message" or "application" (NOTE 1).
  • - The <port> field in remote descriptors is provided by the MRFC and represents the port to which the MRFP shall send the media flows.
| + +| | | | +|--|--|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | |
  • - The <port> field in local descriptors may be provided by the MRFC or wildcarded (i.e. choose wildcard) to allow the MRFP to choose a value for the port on which it wishes to receive the media stream
  • - The <transport> field shall be according to table 5.15.2
  • - The <format> field may be explicitly supplied by the MRFC, wildcarded or overspecified. If the MRFC wishes to request the MRFP to choose which media formats it wishes to use for the call then the MRFC shall provide a "\$" wildcard. If the MRFC wishes to suggest that the MRFP selects a media format from a list of possible media formats then it shall provide a list of appropriate media types in accordance with SDP. All conforming gateways shall support at least the default narrowband AMR codec as defined in 3GPP TS 26.114 [41]. Optionally, other codecs defined in 3GPP TS 26.114 [41] and format "8" for RTP/AVP (i.e. G.711 A-Law).

Dynamic payloads shall not be used when a static RTP/AVP payload value is defined in IETF RFC 3551 [21].

| +|--|--|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +| | | | +|-----------------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Bandwidth (b=) | "SDP_B " |

The Bandwidth (b=) line consists of 2 fields:
b= <modifier>: <bandwidth-value>

Bandwidth information shall be supplied by the MRFC if the required bandwidth cannot be immediately derived from the information contained in the m= line. If absent, the MRFP shall assume a reasonable default bandwidth value for well-known codecs and shall provide this value in the response sent to the MRFC. The Modifier field shall be set to "AS".

The Bandwidth Value field shall be set to the maximum bandwidth requirement of the media stream in kbit/s. The bandwidth value shall take into account all headers down to the IP layer, including a 5% bandwidth for RTCP packets.

| +| Time (t=) | "SDP_T " |

The time (t=) line consists of two fields:
t= <start-time> <stop-time>.

This line is ignored by both the MRFC and the MRFP if received in local and remote descriptors.

The MRFC is not required to supply a time description but shall accept one.

When supplied, this line shall be set to 0 0.

| +| Attributes (a=) | "SDP_A " |

Attributes (a=) lines consist of two fields:
a= <attribute>: <value>

One or more of the "a" attribute lines specified below may be included, depending on the payload type.

An attribute line not specified below should not be used. Only the following attributes are understood by the MRFP. Other attributes are ignored.

a= rtpmap: <payload type> <encoding name>/<clock rate>
[/<encoding parameters>]

a= fmtp: <format> <format specific parameters>
a=ptime: <time>
a=userid: <token of user identifier> (NOTE 3)
a=floorid: <token of Floor identifier> (NOTE 3)
a=path:MSRP-URI (NOTE 4)
a=rtcp-fb: <...> (NOTE 5, NOTE 13, NOTE 14, NOTE 19)
a=extmap: <x> <CVO-URN or ROI URN> (NOTE 6)
a=imageattr: <payload type> <...> (NOTE 7)
a=scp-port: <port> (NOTE 8)
a=max-message-size: <value> (NOTE 8)
a=dcmap: <dcmap-stream-id> <subprotocol-opt> (NOTE 9)
a=fingerprint: <certificate fingerprint> (NOTE 10)
a=predefined_ROI: <...> (NOTE 11)
a=bw-info: <payload type> <dir> <MaxSupBw>;
<MaxDesBw>; <MinDesBw>; <MinSupBw>; <IpVer> (NOTE 12)

a=content: <mediacnt> (NOTE 15)
a=simulcast: <sc-dir> <rid-id-list> (NOTE 16)
a=rid: <rid-id> <dir> <payload type> (NOTE 17)
a=ccc_list: <codeclist> "1" <ccc-prof> (NOTE 18)

ICE support
The attributes "a=candidate", "a=ice-pwd", and "a=ice-ufrag" (see IETF RFC 5245 [48]) may be provided for an SDP m-line in the local and remote descriptor if the MRFP supports ICE, see also 3GPP TS 24.229 [49]. In the local descriptor, the MRFC shall provide "a=ice-pwd", and "a=ice-ufrag" with wildcard sign "\$" to request the allocation of a password and user name fragment, and the "a=candidate" of type "host" with the transport, port and priority parameters with wildcard sign "\$" to request the allocation of a host candidate. The MRFP shall then reply with completed "a=ice-pwd", and

| + +| | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | |

"a=ice-ufrag" and "a=candidate" attributes in the local descriptor, and shall include "a=ice-lite" if it only supports ICE lite. In the remote descriptor, the MRFC may provide the "a=candidate", "a=ice-pwd", and "a=ice-ufrag".

SDP Capability Negotiation support:
the attributes of "a=acap", "a=tcap", "a=pcfg" and "a=acfg" (see IETF RFC 5939 [69]) may be provided in the local descriptor and/or remote descriptor.

| +|

NOTE 1: The "application" media is used to describe H.248 stream for a BFCP stream or H.248 stream for an UDP/DTLS/SCTP stream to be created for a CLUE data channel in telepresence using IMS as specified in 3GPP TS 24.103 [60]. The way to generate an "m" line for a BFCP stream follows the format specified in IETF RFC 4583 [32], where the port is always a TCP port, the transport field is "TCP/TLS/BFCP" if IMS media plane security is applied or otherwise "TCP/BFCP", the fmt (format) list is ignored. When a CLUE data channel is created, the "m" line for a UDP/DTLS/SCTP stream follows the format specified in IETF RFC 8841 [61] and IETF RFC 8864 [62], where the transport field is "UDP/DTLS/SCTP", the fmt (format) indicates the usage of the SCTP association as "webrtc-datachannel".

NOTE 2: Void

NOTE 3: The "userid" and "floorid" are SDP media-level attributes. They are used in BFCP 'm' lines. The "floorid" defines a list of Floor identifiers, indicating the available Floor(s) for the user represented by the termination. The token representing the Floor identifier is the integer representation of the Floor ID. The "userid" attributes carry the integer representation of a user ID.

NOTE 4: An MSRP-URI is an "msrp" or "msrps" URI defined as "MSRP-URI = msrp-scheme ":" authority ["/" session-id] ";" transport *(";" URI-parameter)". The authority component contains a numeric IP address and port. The session-id part identifies a particular session of the participant allowing multiple sessions to share the same TCP connection.

NOTE 5: For AVPF transport, the "rtcp-fb" SDP attribute defined in IETF RFC 4585 [40] may be used to provide the feedback message types the MRFP is allowed to send and to indicate RTCP timing information. The support is optional and dependent on RTCP-fb support as described in 3GPP TS 26.114 [41]. The list of feedback messages supported by the MRFP is preconfigured in the MRFC. The "rtcp-fb" SDP attribute shall be sent from MRFC when applicable.

NOTE 6: Support of the RTP header extension to signal CVO or Sent ROI is optional. The attribute "a=extmap" (see IETF RFC 5285 [45]) may be provided for an m-line in the local and remote descriptor. CVO-URN is "urn:3gpp:video-orientation" for a 2 bit granularity of rotation or "urn:3gpp:video-orientation:6" for a higher granularity of rotation, and ROI-URNs are "urn:3gpp:roi-sent" for arbitrary ROI information and "urn:3gpp:predefined-roi-sent" for predefined ROI information respectively, as specified in 3GPP TS 26.114 [41] and "x" represents the local identifier of the RTP header extension element as specified in IETF RFC 5285 [45] and is any number in a range [1 - 14].

NOTE 7: The support of the generic image attribute to negotiate the image size is optional. The attribute "a=imageattr"

| | | + +(see IETF RFC 6236 [46]) may be provided for an m-line in the local and remote descriptor if the MRFP supports the generic image attributes, see also 3GPP TS 26.114 [41]. The local descriptor indicates the image sizes which the MRFP supports in the receiving direction for the selected payload type and corresponds to the "recv" keyword (see IETF RFC 6236 [46]) in the "a=imageattr" that the MRFC will send within the SDP body on the Mr interface. The remote descriptor indicates the image sizes which the MRFP supports in the sending direction for the selected payload type and corresponds to the "send" keyword (see IETF RFC 6236 [46]) in the "a=imageattr" that the MRFC will send within the SDP body on the Mr interface. + +- NOTE 8: The support of the "a=sctp-port" attribute to indicate the actual SCTP port is used only when the transport field of 'm' line is "UDP/DTLS/SCTP". The SDP "a=max-message-size" attribute may be used to indicate the maximum message size that an SCTP endpoint is willing to receive on the SCTP association associated with the 'm' line. +- NOTE 9: The support of the dcmap attribute to realize the CLUE data channel is used only when the transport field of 'm' line is "UDP/DTLS/SCTP", where the dcmap-stream-id field indicates the actual SCTP stream, and the subprotocol field indicates the protocol "CLUE". +- NOTE 10: The attribute(s) "a=fingerprint" (see IETF RFC 8122 [64]) shall be provided for an "m=" line in the local and remote descriptor if the MRFC requests the MRFP to establish the CLUE data channel. +- NOTE 11: The support of the predefined ROI attribute in the SDP is optional. The attribute "a=predefined\_ROI" (see TS 26.114 [41]) may be provided for an m-line in the local and remote descriptor if the MRFP supports the predefined ROI attributes, see also 3GPP TS 26.114 [41]. +- NOTE 12: If the MRFP performs media transcoding and if the rate adaptation for media endpoints using the enhanced bandwidth negotiation is supported by the MRFP, attribute(s) "a=bw-info" (defined in 3GPP TS 26.114 [41], clause 19) with direction "send" or "sendrecv" may be provided for an m-line and the selected IP payload type and applicable IP version in the remote descriptor. +- NOTE 13: The support of the "RTCP Codec Control Commands and Indications" signalling is optional. The "rtcp-fb" SDP attribute with the "ccm" feedback parameter and the "fir" and/or "tmmbr" ccm parameters as defined in IETF RFC 5104 [71] may be provided for an m-line in the local and remote descriptor to indicate that the MRFP shall be prepared to receive and is allowed to send, respectively, the RTCP CCM feedback messages FIR, and/or TMMBR and TMMBN (the usage of the messages have been agreed in the SDP offer/answer negotiation between the MRFC and the end user). +- NOTE 14: The "rtcp-fb" SDP attribute with the "ccm" feedback parameter and the "pause" ccm parameter may be provided for an m-line in the local and remote descriptor to request the MRFP to apply "RTP-level pause and resume" procedures as defined in IETF RFC 7728 [75] and to indicate to the MRFP which RTCP feedback "CCM PAUSE-RESUME" messages the MRFP may send to the end user. +- NOTE 15: The "content" SDP attribute (see IETF RFC 4796 [72]) may be provided for an m-line in the local and remote descriptor to indicate a content of the media stream. +- NOTE 16: The "simulcast" SDP attribute (see IETF RFC 8853 [73]) may be provided for an m-line in the local and remote descriptor to indicate the list of the supported simulcast RTP formats in the receiving direction and/or in the sending direction. Each simulcast RTP format is identified by a simulcast stream identifier which has the form of the RTP stream identifier. +- NOTE 17: The "rid" SDP attribute (see IETF RFC 8851 [74]) may be provided for an m-line in the local and remote descriptor to indicate the identity, directionality and the payload type of the simulcast RTP stream. +- NOTE 18: The support of "Compact Concurrent Codec Negotiation and Capabilities" is optional. The "ccc\_list" SDP attribute (defined in 3GPP TS 26.114 [41], clause S.5.7.2) may be provided in the remote descriptor to indicate to the MRFP the concurrent codec capabilities of an MMCMH conference participant in a compact representation. +- NOTE 19: The support of the "Delay Budget Information" signalling is optional. The "rtcp-fb" SDP attribute with the "3gpp-delay-budget" feedback parameter (as defined in 3GPP TS 26.114 [41] clause 6.2.8) may be provided for an m-line in the local and remote descriptor to indicate that the MRFP shall be prepared to receive and is allowed to send, respectively, the RTCP-FB messages for "DBI" signalling (as defined in 3GPP TS 26.114 [41] clause 7.3.8) (the usage of the messages have been agreed in the SDP offer/answer negotiation between the MRFC and the end user). + +**Table 5.15.2: Transport Protocol** + +| | | +|---------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| +| Transport Protocol <proto> in m-line: | If the MG does not support the requested transport protocol, it shall reject the command with error code 449. | +| RTP/AVP | RTP profile according IETF RFC 3551 [21]. For voice and video services | +| RTP/AVPF | Extended RTP profile for RTCP-based Feedback (RTP/AVPF) according IETF RFC 4585 [40]. For voice and video services (NOTE 1). | +| TCP/BFCP | For floor control service, see IETF RFC 4583 [32]. (NOTE 1) | +| TCP/MSRP | For message service, see IETF RFC 4975 [34]. (NOTE 1) | +| TCP/TLS/BFCP | For floor control service with IMS media plane security, see IETF RFC 4583 [32]. (NOTE 1) | +| TCP/TLS/MSRP | For message service with IMS media plane security, see IETF RFC 4975 [34]. (NOTE 1) | +| UDP/DTLS/SCTP | Data channel support using IETF RFC 8841 [61] and IETF RFC 8864 [62]. | +| NOTE 1: support optional. | | +| NOTE 2: Upper case TCP is defined by IETF RFC 4145 [39] and registered by IANA. | | + +## 5.16 Optional support of SDP and Annex C information elements + +*Specifies what SDP attributes and Annex C information elements may be supported.* + +**Table 5.16.1:** + +| Optional Annex C and SDP information elements: | | | | +|-------------------------------------------------------|------------------------|--------------------|------------------------------| +| Information Element | Annex C Support | SDP Support | Support Dependent on: | +| | | | | + +## 5.17 Procedures + +### 5.17.1 Formats and Codes + +Table 5.17.1.1 shows the parameters which are required for the procedures defined in the following clauses. + +The coding rules applied in ITU-T Recommendation H.248.1 [3] for the applicable coding technique shall be followed for the UMTS capability set. + +The binary encoding rules which are applicable to the defined Abstract Syntaxes are the Basic Encoding Rules for Abstract Syntax Notation One, defined in ITU-T Recommendation X.690 [41]. Specifically in accordance with ITU-T Recommendation X.690 [41] clause 7.3, alternative encodings based on the definite and indefinite form of length are permitted by the basic encoding rules as a sender's option. Receivers shall support both alternatives. + +Unsupported values of parameters or properties may be reported by the MGW and shall be supported by the MSC as such by using H.248.1 error code #449 "Unsupported or Unknown Parameter or Property Value". The unsupported or unknown value is included in the error text in the error descriptor. + +Table 5.17.1.1: Information Elements Used in Procedures + +| Signalling Object | H.248 Descriptor | Coding | +|---------------------------------|------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Additional Bandwidth Properties | Remote Descriptor | The "a=bw-info" SDP attribute defined in 3GPP TS 26.114 [41], see table 5.15.1. | +| Allowed RTCP APP message types | Remote Descriptor | The "a=3gpp_mtsi_app_adapt" SDP attribute defined in 3GPP TS 26.114 [41]. | +| Announcement Cause | Events
ObservedEvents | The "Meth" parameter in g/sc event per ITU-T Recommendation H.248.1 [3] Annex E.1.2 | +| Announcement Completed | Events
ObservedEvents | The g/sc event per ITU-T Recommendation H.248.1 [3] Annex E.1.2 | +| Announcement Cycles | Signal | The "noc" parameter as per ITU-T Recommendation H.248.7 [5], Clause 4.3.1 | +| Announcement Direction | Signal | The "di" parameter as per ITU-T Recommendation H.248.7 [5], Clause 4.3.1 | +| Announcement Variant | Signal | The "av" parameter as per ITU-T Recommendation H.248.7 [5], Clause 4.3.1 | +| Arbitrary ROI Sent | Local Descriptor | The "rtcp-fb" SDP attribute defined in IETF RFC 4585 [30] to indicate the " Arbitrary ROI" RTCP feedback message expressed by the "3gpp-roi-arbitrary" parameter, as described in 3GPP TS 26.114 [41]. | +| Arbitrary ROI Received | Remote Descriptor | The "rtcp-fb" SDP attribute defined in IETF RFC 4585 [30] to indicate the " Arbitrary ROI" RTCP feedback message expressed by the "3gpp-roi-arbitrary" parameter, as described in 3GPP TS 26.114 [41]. | +| ASR Cause | Events
ObservedEvents | The "rc" parameter in asr/asrfail event as per ITU-T Recommendation H.248.9a1 [26] Clause 12.2.1. | +| Autonomous response | LocalControl | Defined as "Autonomous Response" property ("rempr/ar") in ITU-T Recommendation H.248.98 [76]. | +| Autonomous request | LocalControl | Defined as "Autonomous Request" property ("rempr/aq") in ITU-T Recommendation H.248.98 [76]. | +| Cause | Events
ObservedEvents | Encoded as "Meth" parameter in g/sc event per ITU-T Recommendation H.248.1 [3] Annex E.1.2 | +| CCM BASE | Local Descriptor or
Remote Descriptor | "rtcp-fb" SDP attribute (defined in IETF RFC 4585 [30]) with the "ccm" feedback parameter and the "fir" and/or "tmmbr" ccm parameters as defined in IETF RFC 5104 [71]. | +| CCM pause-resume | Local Descriptor or
Remote Descriptor | The "rtcp-fb" SDP attribute (defined in IETF RFC 4585 [40]) with the "ccm" feedback parameter (defined in IETF RFC 5104 [71]) and the "pause" ccm parameter as defined in IETF RFC 7728 [75]. | +| Certificate Fingerprint | Local Descriptor or
Remote Descriptor | The "a=fingerprint" SDP attribute(s) as defined in IETF RFC 8122 [64], see table 5.15.1. | +| CLUE Message Send | Signal | Defined as the " mcbalg/sblm " signal with the application protocol indicating "CLUE" in ITU-T Recommendation H.248.78 [65]. | +| CLUE Message Received | Events
ObservedEvents | Defined according to Detect Bearer Level Message event with the application protocol indicating "CLUE" in ITU-T Recommendation H.248.78 [65]. | +| Codec List | Local Descriptor or
Remote Descriptor | in a single SDP m-line.
For a static RTP payload type, the codec type should be implied by the RTP payload type, if not then each codec type shall be provided in a separate SDP "a=rtpmap"-line and possibly additional SDP "a=fmtp"-line(s).
For a dynamic RTP payload type, for each codec information on the codec type shall be provided in a separate SDP "a=rtpmap"-line and possibly additional SDP "a=fmtp"-line(s). | +| Concurrent Codec Capabilities | Remote Descriptor | The "a=ccc_list" session level SDP attribute defined in 3GPP TS 26.114 [41], see table 5.15.1. | +| ConfID | ContextAttribute
Descriptor | The "fconfid" parameter as per ITU-T Recommendation H.248.19 [33], Clause 10.6.1.1. It is defined as type integer as used over BFCP. | +| Context ID | NA | Binary Encoding: As per ITU-T Recommendation H.248.1 [3] Annex A.
Textual Encoding: As per ITU-T Recommendation H.248.1 [3] Annex B. | +| ControlledByChair | TerminationState
Descriptor | List of Floor Ids controlled by this termination as a chair, specified by "cfi" as defined in Clause 10.1.1.2 of ITU-T Recommendation H.248.19 [33]. | + +| | | | +|----------------------------------------|---------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Diffserv Code Point | Local Control | Defined according to the Differentiated Services Code Point property in ITU-T Recommendation H.248.52 [43]. | +| DBI | Local Descriptor or Remote Descriptor | "rtcp-fb" SDP attribute defined in IETF RFC 4585 [30] with the "3gpp-delay-budget" feedback parameter as defined in 3GPP TS 26.114 [41] clause 6.2.8. | +| Digit | Observed Events | Encoding as per ITU-T Recommendation H.248.1 Annex E.6.2. Digits are reported individually by the MRFP. | +| DTMFTrigger | Signal Descriptor | "endinputkey, eik" see H.248.9a1 [26] Clause 16.3.1.1.16. | +| ECN Enabled | Local Descriptor or Remote Descriptor | Defined according to the "ECN Enabled" property in ITU-T Recommendation H.248.82 [44]. | +| ECN Failure | Events, Observed Events | Defined according to the "ECN Failure" Event in ITU-T Recommendation H.248.82 [44]. | +| ECN Failure Type | ObservedEvents Descriptor | As for the ObservedEventsDescriptor Parameter "Failure Type" in ITU-T Recommendation H.248.82 [44]. | +| ECN Initiation Method | Local Descriptor or Remote Descriptor | Defined according to "Initiation Method" property in ITU-T Recommendation H.248.82 [44]. | +| End of Recording Notification | Events ObservedEvents | Enables the MRFC to be informed of the end of a recording. Corresponds to aasrec/audfail (mrp/audfail) and aasrec/precucc, (mrp/precucc) events see ITU-T Recommendation H.248.9a1 [26] 12.2. | +| Establish TCP Connection | Signals | Defined according to the Establish BNC signal (tcpbcc/EstBNC) in ITU-T Recommendation H.248.89 [54]. | +| Establish (D)TLS session | Signals | Defined according to the Establish BNC signal (tlsbsc/EstBNC) in ITU-T Recommendation H.248.90 [55] and for DTLS usage in ITU-T Recommendation H.248.93 [63]. | +| Extended Header for CVO | Local Descriptor or Remote Descriptor | "extmap" attribute in SDP a-line as defined in IETF RFC 5285 [45], see table 5.15.1. | +| Extended RTP Header for Sent ROI | Local Descriptor or Remote Descriptor | "extmap" attribute in SDP a-line to pass on the ROI extended RTP header as defined by IETF RFC 5285 [45] for carriage of predefined and/or arbitrary ROI information, see table 5.15.1 | +| FloorControlAlgorithm | Context Attribute (NOTE 1) | Sub-list of (Floorid, Algorithm), "fca" as defined in Clause 10.4.1.2 of ITU-T Recommendation H.248.19 [33]. | +| FloorID | Local Descriptor | "a= floorid" SDP line as specified in Table 5.15.1. | +| FloorRequestResult | Signal Descriptor | The "res" parameter as per ITU-T Recommendation H.248.19 [33], Clause 10.5.3.1.1.2. It is defined as Boolean (success or fail) | +| FloorResAssociations | Context Attribute (NOTE 1) | The "fsa" parameter as per ITU-T Recommendation H.248.19 [33], Clause 10.6.1.2. It is defined as sub-list of (Floorid, StreamID). | +| FloorStatus | Observed Events | "Floor Status, fs" as defined in ITU-T Recommendation H.248.19 [33].
This is a list of FloorIds and status (e.g. granted, revoked) | +| Generic Image Attribute | Local Descriptor or Remote Descriptor | "imageattr" attribute in SDP a-line as defined in IETF RFC 6236 [46], see table 5.15.1. | +| ICE host candidate request | Local Descriptor | The "a=candidate" SDP attribute defined in IETF RFC 5245 [48] of type "host" with the transport, port and priority parameters with wildcard sign "\$" to request the allocation of a host candidate | +| ICE host candidate | Local Descriptor | The "a=candidate" SDP attribute defined in IETF RFC 5245 [48] | +| ICE lite indication | Local Descriptor | The "a=ice-lite" SDP attribute defined in IETF RFC 5245 [48]. | +| ICE password request | Local Descriptor | The "a=ice-pwd" SDP attribute defined in IETF RFC 5245 [48] with wildcard sign "\$". | +| ICE password | Local Descriptor | The "a=ice-pwd" SDP attribute defined in IETF RFC 5245 [48]. | +| ICE received candidate | Remote Descriptor | The "a=candidate" SDP attribute defined in IETF RFC 5245 [48] | +| ICE received password | Remote Descriptor | The "a=ice-pwd" SDP attribute defined in IETF RFC 5245 [48]. | +| ICE received Ufrag | Remote Descriptor | The "a=ice-ufrag" SDP attribute defined in IETF RFC 5245 [48]. | +| ICE Ufrag request | Local Descriptor | The "a=ice-ufrag" SDP attribute defined in IETF RFC 5245 [48] with wildcard sign "\$". | +| ICE Ufrag | Local Descriptor | The "a=ice-ufrag" SDP attribute defined in IETF RFC 5245 [48]. | +| ICE Connectivity Check Result | Events, Observed Events | Defined according to Connectivity Check Result event in ITU-T Recommendation H.248.50 [47]. | +| ICE Send Connectivity Check | Signals | Defined as the ostuncc/scc signal in ITU-T Recommendation H.248.50 [47]. | +| ICE New Peer Reflexive Candidate | Events, Observed Events | Defined according to New Peer Reflexive Candidate event in ITU-T Recommendation H.248.50 [47]. | +| ICE Send Additional Connectivity Check | Signals | Defined as the ostuncc/sacc signal in ITU-T Recommendation H.248.50 [47]. | +| IncMessageFilters | LocalControl Descriptor | "Incoming Message Filters, imf" parameter in H.248.69 [35] Clause 13.1.1, which is defined as string and complies with Sieve [IETF RFC5228] with the exceptions described in H.248.69 [35] Clause | + +| | | | +|-----------------------------|---------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | 13.6. | +| IP Address | Local Descriptor or Remote Descriptor | in SDP "c-line" | +| Iterations | Signal | " iterations, it" parameter in H.248.9a1 [26] Clause 13.3.1.1.3 or Clause 13.3.2.1.3 | +| MaxFloorHolder | Context Attribute (NOTE 1) | Sub-list of (FloorID, Number). "mfu" as defined in Clause 10.4.1.2 of ITU-T Recommendation H.248.19 [33]. | +| Maximum Record Time | Signal | "Record Length Timer, rlt" parameter in H.248.9a1 [26] Clause 16.3.1.1.8 for multimedia recording or Clause 10.3.1.1.8 for audio recording | +| Media Identifier | Signal | TBD | +| Mediatype | Local Descriptor or Remote Descriptor | in sdp m-line
"audio" for voice service, and "image" for T.38 service. | +| MessageContentType | | TBD as enumeration to indicate the content type of message. (e.g. video, audio) | +| MessageContentFmt | | TBD as enumeration to indicate the content format (e.g. mpeg, jpeg for picture) | +| MessageIdentifier | Signal | "mcr" parameter in the mess/sm signal in H.248.69 [35] Clause 10.3.1.1.2, which is defined as URI that points to the message data that shall be sent. | +| MessagePlayResultReport | Signal | "fr" or "sr" parameter in the mess/sm signal in H.248.69 [35], which is defined as Enumeration to indicate the request of report result of message play (Success Report, Failure Report, Both or None) | +| MessagePlayCause | ObservedEvents | "sc" parameter in the mess/msrs event in H.248.69 [35] Clause 10.2.1.2.2 , which is defined as Enumeration to notify the result of the message play. | +| MessageRecordFileIdentifier | Signal | "sl" parameter in the recmess/rm signal in H.248.69 [35] Clause 15.3.1.1.1, which is defined as a URI where the messages are to be stored. | +| MessagesReceivedNumQuota | Events | "mrq" parameter in the msrpstat/mquota event in H.248.69 [35] Clause 8.2.1.1.2, which is defined as integer to define the quota for number of messages that may be received on the termination for the messaging Stream. | +| MessagesReceivedVolQuota | Events | "mrv" parameter in the msrpstat/mquota event in H.248.69 [35] Clause 8.2.1.1.4, which is defined as integer to define the quota for cumulative total size of messages that may be received on the Termination for the messaging Stream. | +| MessagesreceivedNum | ObservedEvents Statistics | "nmr" parameter in the msrpstat/mquota event or statistics in H.248.69 [35], which is defined as integer to define the number of messages that have been received on the termination for the messaging Stream. | +| MessagesReceivedVol | ObservedEvents Statistics | "vmr" parameter in the msrpstat/mquota event or statistics in H.248.69 [35], which is defined as integer to define the cumulative total size of messages that have been received on the Termination for the messaging Stream. | +| MessagesSentNumQuota | Events | "msq" parameter in the msrpstat/mquota event in H.248.69 [35] Clause 8.2.1.1.1, which is defined as integer to define the quota for number of messages that may be sent from the termination for the messaging Stream. | +| MessagesSentVolQuota | Events | "msv" parameter in the msrpstat/mquota event in H.248.69 [35] Clause 8.2.1.1.3, which is defined as integer to define the quota for cumulative total size of messages that may be sent from the Termination for the messaging Stream. | +| MessagesSentNum | ObservedEvents Statistics | "nms" parameter in the msrpstat/mquota event or or statistics in H.248.69 [35], which is defined as integer to define the number of messages that have been sent from the termination for the messaging Stream. | +| MessagesSentVol | ObservedEvents Statistics | "vms" parameter in the msrpstat/mquota event or statistics in H.248.69 [35], which is defined as integer to define the cumulative total size of messages that may be sent from the Termination for the messaging Stream. | +| MMCMH policy | Context Attribute (NOTE 1) | Defined as "MMCMH policy" property in Annex C, clause C.2.2.1. | +| MSRP session identity | Local Descriptor or Remote Descriptor | in SDP "a= path:MSRP-URI"-line. | +| Notify TCP Connection | ObservedEvents | As for the ObservedEvent Parameter in clause E.1.2 of ITU- | + +| | | | +|---------------------------------------------------|---------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Establishment Failure Event | | T Recommendation H.248.1 [3] "General cause". | +| Notify (D)TLS session establishment Failure Event | ObservedEvents | As for the ObservedEvent Parameter in clause E.1.2 of ITU-T Recommendation H.248.1 [3] "General cause". | +| OutMessageFilters | LocalControl Descriptor | "Outgoing Message Filters, omf" parameter in H.248.69 [35] Clause 13.1.3, which is defined as string and complies with Sieve [IETF RFC5228] with the exceptions described in H.248.69 [35] Clause 13.6. | +| Port | Local Descriptor or Remote Descriptor | in SDP m-line. | +| Predefined ROI Sent | Local Descriptor | The "rtcp-fb" SDP attribute defined in IETF RFC 4585 [30] to indicate the "Predefined ROI" RTCP feedback message expressed by the "3gpp-roi-predefined" parameter, as described in 3GPP TS 26.114 [41]. | +| Predefined ROI Received | Remote Descriptor | The "rtcp-fb" SDP attribute defined in IETF RFC 4585 [30] to indicate the "Predefined ROI" RTCP feedback message expressed by the "3gpp-roi-predefined" parameter, as described in 3GPP TS 26.114 [41]. | +| Pre-Shared Key | LocalControl Descriptor | Traffic-Encrypting Key (TEK) associated with the Crypto Session (CS) as defined in IETF RFC 6043 [56] and Annex H of 3GPP TS 33.328 [57] that will be used in TLS handshake. (NOTE 2) | +| Priority Information | NA | Priority Indicator (clause 6.1.1 of ITU-T Recommendation H.248.1 [3])
Binary Encoding: Encoding as per ITU-T Recommendation H.248.1 [3] Annex A "priority" context attribute
Textual Encoding: Encoding as per ITU-T Recommendation H.248.1 [3] Annex B "priority" context attribute | +| Recognition Result | ObservedEvents | "asrr" parameter to "asrsucc" event in H.248.9a1 [26] Clause 12.2.2.2.1.
Each result may be able to be structured by multiple parts in time sequence with the input time, may be able to include the text token that the value will correspond to tokens as defined by the SRGS grammar, may be able to include the interpretation of application specific markup, may be able to include the confidence score that represents the recognition quality. | +| Record File Format | Signal | To Be Defined | +| Record File Identifier | Signal | "rid" parameter in playrec signal H.248.9a1 [26] Clause 16.3.1.1.9 for multimedia recording or Clause 10.3.1.1.9 for audio recording | +| Release TCP Connection | Signals | Defined according to the Release BNC signal (tcpbcc/RelBNC) in ITU-T Recommendation H.248.89 [54]. | +| Release TLS session | Signals | Defined according to the Release BNC signal (tlbsbc/RelBNC) in ITU-T Recommendation H.248.90 [55]. | +| Reserve_Value | Local Control | ITU-T Recommendation H.248.1 [3] Mode property.
Binary Encoding: Encoding as per ITU-T Recommendation H.248.1 Annex A "reserveValue"
Textual Encoding: Encoding as per ITU-T Recommendation H.248.1 Annex B "reservedValueMode". | +| RtcpbwRS | Local Descriptor or Remote Descriptor | in SDP "b:RS"-line. | +| RtcpbwRR | Local Descriptor or Remote Descriptor | in SDP "b:RR"-line. | +| RTPpayload | Local Descriptor or Remote Descriptor | in SDP m-line | +| SCTP Max Message Size | Local Descriptor or Remote Descriptor | The "a=max-message-size" SDP attribute as defined in IETF RFC 8841 [61], see table 5.15.1. | +| SCTP Port | Local Descriptor or Remote Descriptor | The "a=sctp-port" SDP attribute as defined in IETF RFC 8841 [61], see table 5.15.1. | +| SCTP Stream ID | Local Descriptor or Remote Descriptor | in SDP "a=dcmmap" line as defined in IETF RFC 8864 [62], see table 5.15.1. | +| SCTP Subprotocol | Local Descriptor or Remote Descriptor | in SDP "a=dcmmap" line as defined in IETF RFC 8864 [62], see table 5.15.1. | +| SDPCapNeg configuration | Local Descriptor or Remote Descriptor | The SDP attributes for SDP capability negotiation according to IETF RFC 5939 [69]. | +| SDPCapNeg Supported Capabilities | Termination State | Defined according to SDPCapNeg Extensions property in ITU-T Recommendation H.248.80 [70]. | +| SenderAddr | | TBD | + +| | | | +|-----------------------|---------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Simulcast desc | Local Descriptor or Remote Descriptor | The "a=simulcast" SDP attribute as defined in IETF RFC 8853 [73], see table 5.15.1. | +| Simulcast format | Local Descriptor or Remote Descriptor | The "a=rid" SDP attribute as defined in IETF RFC 8851 [74], see table 5.15.1. | +| SRGS Grammar | Signal | "grammar file, gf" parameter in asr/asr signal in H.248.9a1 [26] Clause 12.3.1.1.2 | +| SRGS grammar URI | Signal | " Recognition grammar identifier, rgid" parameter in asr/ asrid signal in H.248.9a1 [26] Clause 12.3.2.1.2 | +| SSML | Signal | "an" parameter in the aastts/play signal in H.248.9a1 [26] Clause 14.3.1.1.1 | +| StatRepReason | ObservedEvents | "qreach" parameter in the msrpstat/mquota event in H.248.69 [35] Clause 8.2.1.2.1, which is defined as enumeration to indicate the quota that has triggered the reporting of the event. | +| StatValTime | Events | "tm" parameter in the msrpstat/mquota event in H.248.69 [35] Clause 8.2.1.1.5, which is defined as integer to define how long for the quotas associated are active for. | +| Stream content | Local Descriptor or Remote Descriptor | The "a=content" SDP attribute as defined in IETF RFC 4796 [72], see table 5.15.1. | +| Stream Number | Stream | Encoding as per ITU-T Recommendation H.248.1 Annex B "Stream"/"ST".
For a single stream, this may be omitted by the MRFC. | +| STUN server request | LocalControl | Encoding as per ITU-T Recommendation H.248.50 [47] "MG Act-as STUN Server" (mgastuns) package "Act-as STUN Server" (astuns, 0x0001) property. | +| Termination heartbeat | Events
ObservedEvents | The hangterm/thb event as per ITU-T Recommendation H.248.36 [30] Clause 5.2.1. | +| Termination ID | NA | Binary Encoding: As per ITU-T Recommendation H.248.1 [3] Annex A.
Textual Encoding: As per ITU-T Recommendation H.248.1 [3] Annex B. | +| Timing | Events | As in dd package H.248.1 [3] Annex E.6.2, (end tone detected shall be used) | +| Tone Completed | Events
ObservedEvents | "g/sc" see H.248.1 [3] Annex E.1.2 | +| Tone Duration | Signal | As in the respective tone package | +| Tone Identity | Signal | Encoding as per ITU-T Recommendation H.248.1 Annex B and the package which defines the tone (Tone Signal Ids only). | +| Transaction ID | NA | Binary Encoding: As per ITU-T Recommendation H.248.1 [3] Annex A.
Textual Encoding: As per ITU-T Recommendation H.248.1 [3] Annex B. | +| TTS Completed | Events
ObservedEvents | "g/sc" see H.248.1 [3] Annex E.1.2 if successful, aastts/ttsfail H.248.9a1 [26] Clause 14.2.1 if not successful. | +| Transport | Local Descriptor or Remote Descriptor | in SDP m-line, see 5.15 | +| UserID | Local Descriptor | "a= userid" SDP line as specified in Table 5.15.1. | + +NOTE 1: H.248.1 version 3 required. + +NOTE 2: Pre-Shared Key information element needs to be specified in ITU-T Recommendation H.248.90 [55]. + +### 5.17.2 Call Related Procedures + +#### 5.17.2.1 General + +This clause describes the various call related procedures performed by the MRFP, which are listed in table 15.17.2.1. + +Table 5.17.2.1.1: MRFP Call Related Procedures + +| Transaction defined in 3GPP TS 23.333 [25] | Transaction used from TS 29.163 [27] | Supported | Comment | +|--------------------------------------------|-------------------------------------------------------------|-----------|-----------------------------------------------------------| +| Reserve IMS Resources | Reserve IMS Connection point | Mandatory | See 5.17.2.2 | +| Configure IMS Resources | Configure IMS Resources | Mandatory | See 5.17.2.3 | +| Reserve and Configure IMS Resources | Reserve IMS Connection Point and configure remote resources | Mandatory | See 5.17.2.4 | +| Release IMS termination | Release IMS termination | Mandatory | See 5.17.2.5 | +| Detect DTMF | Detect IMS RTP Tel Event | Optional | See 5.17.2.18 | +| Stop DTMF Detection | End IMS RTP Tel Event | Optional | See 5.17.2.20 | +| Report DTMF | Notify IMS RTP Tel Event | Optional | See 5.17.2.19 | +| Start Playing Multimedia | n.a for re-use | Optional | See 5.17.2.24 | +| Stop Playing Multimedia | n.a for re-use | Optional | See 5.17.2.25 | +| Playing Multimedia Completed | n.a for re-use | Optional | See 5.17.2.26 | +| Send Tone | n.a for re-use | Optional | See 5.17.2.6 | +| Stop Tone | IMS Stop Tone | Optional | See 5.17.2.7 | +| Tone Completed | IMS Tone Completed | Optional | See 5.17.2.8 | +| Start Announcement | n.a for re-use | Optional | See 5.17.2.9 | +| Stop Announcement | Stop Announcement | Optional | See 5.17.2.10 | +| Announcement Completed | Announcement Completed | Optional | See 5.17.2.11 | +| Start Audio Record | n.a for re-use | Optional | See 5.17.2.15 | +| Stop Audio Record | n.a for re-use | Optional | See 5.17.2.16 | +| Audio Record Complete | n.a for re-use | Optional | See 5.17.2.17 | +| Start Multimedia Record | n.a for re-use | Optional | See 5.17.2.27 | +| Stop Multimedia Record | n.a for re-use | Optional | See 5.17.2.28 | +| Multimedia Record Completed | n.a for re-use | Optional | See 5.17.2.29 | +| Start TTS | n.a for re-use | Optional | See 5.17.2.12 | +| Stop TTS | n.a for re-use | Optional | See 5.17.2.13 | +| TTS Completed | n.a for re-use | Optional | See 5.17.2.14 | +| Start ASR | n.a for re-use | Optional | See 5.17.2.21 | +| Stop ASR | n.a for re-use | Optional | See 5.17.2.23 | +| ASR Completed | n.a for re-use | Optional | See 5.17.2.22 | +| Adhoc Audio Conference | n.a for re-use | Optional | See 5.17.2.30 | +| Multi-Media Conferencing | n.a for re-use | Optional | See 5.17.2.31 | +| Termination heartbeat Indication | Termination heartbeat Indication | Mandatory | See 5.17.2.32 | +| Configure BFCP Termination | n.a for re-use | Optional | See 5.17.2.33 | +| Configure Conference For Floor Control | n.a for re-use | Optional | See 5.17.2.34 | +| Designate Floor Chair | n.a for re-use | Optional | See 5.17.2.35 | +| Floor Request Decision | n.a for re-use | Optional | See 5.17.2.36 | +| Report Floor Request Decision | n.a for re-use | Optional | See 5.17.2.37 | +| Modify Media | n.a for re-use | Optional | See 5.17.2.38 | +| Confirm Media Update | n.a for re-use | Optional | See 5.17.2.39 | +| Start Playing Message | n.a for re-use | Optional | See 5.17.2.40 | +| Stop Playing Message | n.a for re-use | Optional | See 5.17.2.41 | +| Playing Message Completed | n.a for re-use | Optional | See 5.17.2.42 | +| Start Message Record | n.a for re-use | Optional | See 5.17.2.43 | +| Stop Message Record | n.a for re-use | Optional | See 5.17.2.44 | +| Message Record Completed | n.a for re-use | Optional | See 5.17.2.45 | +| Configure Granted Quota | n.a for re-use | Optional | See 5.17.2.46 | +| Report Message Statistics | n.a for re-use | Optional | See 5.17.2.47 | +| Configure Filtering Rules | n.a for re-use | Optional | See 5.17.2.48 | +| ECN Failure Indication | n.a for re-use | Optional | See 5.17.2.49 | +| ICE Connectivity Check Result Notification | n.a for re-use | Optional | See 5.17.2.50
Only applicable if full ICE is supported | + +| | | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------|----------|-----------------------------------------------------------| +| ICE New Peer Reflexive Candidate Notification | n.a for re-use | Optional | See 5.17.2.51
Only applicable if full ICE is supported | +| Notify TCP connection establishment Failure Indication | n.a for re-use | Optional | See 5.17.2.52 | +| Notify TLS session establishment Failure Indication | n.a for re-use | Optional | See 5.17.2.53 | +| CLUE Message Send | n.a for re-use | Optional | See 5.17.2.54 | +| CLUE Message Received | n.a for re-use | Optional | See 5.17.2.55 | +| NOTE: A procedure defined in this table can be combined with another procedure in the table. This means that they can share the same contextID and termination ID(s) and that they can be combined in the same H.248 command. | | | | + +#### 5.17.2.2 Reserve IMS Resources + +The MRFC sends an ADD request command as in Table 5.17.2.2.1. + +Table 5.17.2.2.1: Reserve IMS Resources Request + +| Address Information | Control information | Bearer information | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Local Descriptor {
Port = \$
IP Address = \$
If media is "message":
MSRP session identity = \$
If media is "application":
If CLUE data channel required:
SCTP Port = \$
} | Transaction ID = x
Context ID= \$
If MPS call/session:
Priority Indicator = x
ContextAttribute Descriptor {
If MMCMH feature:
MMCMH policy
}
Termination ID = \$
If Stream Number specified:-
Stream Number
If Resources for multiple Codecs required:
Reserve_Value
NotificationRequested (Event ID = x, "termination heartbeat")
If ECN transparent support required:
ECN Enable = "True"
Initiation Method = "inactive"
If ECN Endpoint support required
ECN Enable = "True"
Initiation Method = "ECN Initiation Method" (NOTE 1)
If notification of ECN Failure Report:
NotificationRequested (Event ID = x, "ECN Failure")
If diffserv required:
Diffserv Code Point
If ICE is applied:
STUN server request
If indication on TCP connection establishment failure requested:
NotificationRequested (Event ID = x, "TCP connection establishment failure")
If indication on CLUE message received requested:
NotificationRequested (Event ID = x, "CLUE message received")
If MMCMH feature:
If RTP-level pause and resume:
Autonomous request
Autonomous response | Local Descriptor {
If media is "audio" or "video":
Codec List = Codec List
RTP Payloads = RTP Payload
Stream content
If MMCMH feature:
Simulcast format
Simulcast desc
If RTP-level pause and resume:
CCM pause-resume
If media is "video":
If CVO required:
Extended Header for CVO (NOTE 2)
If media is "video":
If imageattr negotiation:
Generic Image Attribute (NOTE 3)
If media is "video":
If Predefined ROI required:
Extended Header For Sent ROI
If termination towards ROI-sending client:
RTCP feedback for Predefined ROI Sent
If Arbitrary ROI required:
Extended Header For Sent ROI
If termination towards ROI-sending client:
RTCP feedback for Arbitrary ROI Sent
If media is "message":
If IMS media plane security required:
Transport = TCP/TLS/MSRP
Else
Transport = TCP/MSRP
If media is "application":
If CLUE data channel required:
Transport = UDP/DTLS/SCTP
Certificate fingerprint = \$
SCTP Stream ID
Subprotocol = CLUE
Max message size = \$
If ICE is applied:
ICE host candidate request
ICE password request
ICE Ufrag request
If SDPCapNeg is signalled to the gateway:
SDPCapNeg configuration
}
or
Local Descriptor {
RTP Payloads = \$
} | + +NOTE 1: This shall be set to a value other than "inactive". + +NOTE 2: If the MRFP supports the extended RTP header it shall pass any received extended RTP header with CVO bits on to succeeding RTP streams. If the MRFP transcodes between video payloads and it supports the extended RTP header with CVO bits it shall keep the video orientation unchanged during + +the transcoding and convey received RTP CVO header bytes on the succeeding RTP streams after transcoding associated packets as specified in 3GPP TS 26.114 [41], clause 7.4.5. + +NOTE 3: The support of the generic image attributes is optional for the MRFP. The list of image sizes per payload type supported by the MRFP is preconfigured in the MRFC. If none of the image sizes received within an SDP body on Mr interface is supported by the MRFP then the MRFC will not send the generic image attribute parameter to the MRFP. + +On reserving the IMS termination, the MRFP responds as in Table 5.17.2.2.2. + +Table 5.17.2.2.2: Reserve IMS Resources Request Acknowledge + +| Address Information | Control information | Bearer information | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Local Descriptor {
Port
IP Address
If media is "message":
MSRP session identity
If media is "application":
If CLUE data channel required:
SCTP Port
} | Transaction ID = x
Context ID = C1
Termination ID = T1
Stream Number | Local Descriptor {
If media is "audio" or "video":
Codec List
RTP Payloads
Stream content
If MMCMH feature:
Simulcast format
Simulcast desc
If RTP-level pause and resume:
CCM pause-resume

If media is "video":
If CVO extension header
provided in the request:
Extended Header for CVO
If media is "video":
If imageattr negotiation:
Generic Image Attribute
If media is "video":
If Predefined ROI provided in the
request:
Extended Header For Sent ROI
If termination towards ROI-
sending client:
RTCP feedback for Predefined
ROI Sent
If Arbitrary ROI provided in the
request:
Extended Header For Sent ROI
If termination towards ROI-
sending client:
RTCP feedback for Arbitrary
ROI Sent

If ICE is applied:
ICE host candidate
ICE password
ICE Ufrag
If ICE lite implementation
ICE lite indication

If media is "message":
If IMS media plane security
required:
Transport = TCP/TLS/MSRP
Else
Transport = TCP/MSRP
If media is "application":
If CLUE data channel required:
Transport = UDP/DTLS/SCTP
Certificate fingerprint
SCTP Stream ID
Subprotocol = CLUE
Max message size

If SDPCapNeg is signalled to the
gateway:
SDPCapNeg configuration
} | + +#### 5.17.2.3 Configure IMS Resources + +The MRFC sends a MODIFY request command as in Table 5.17.2.3.1. + +Table 5.17.2.3.1: Configure IMS Resources Request + +| Address Information | Control information | Bearer information | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| If local resources are modified:
Local Descriptor {
Port
IP Address
If media is "message":
MSRP session identity
}
If remote resources are modified:
Remote Descriptor {
Port
IP Address
If media is "message":
MSRP session identity
If media is "application":
If CLUE data channel required:
SCTP Port
} | Transaction ID = x
Context ID = C1
Termination ID = T1

If Stream Number specified:
Stream Number

If Resources for multiple Codecs required:
Reserve_Value

If detection of hanging termination is requested: (NOTE1)
NotificationRequested (Event ID = x, "termination heartbeat")
If ECN transparent support required:
ECN Enable = "True"
Initiation Method = "inactive"

If ECN Endpoint support required
ECN Enable = "True"
Initiation Method = "ECN Initiation Method" NOTE2

If notification of ECN Failure Report:
NotificationRequested (Event ID = x, "ECN failure")

If full ICE is applied:
Send Connectivity Check ("Control")
If notification of ICE Connectivity Check Result Report:
NotificationRequested (Event ID= xx, "Connectivity Check Result")
If notification of New Peer Reflexive Candidate:
NotificationRequested (Event ID = xy, " New Peer Reflexive Candidate ")
Send Additional Connectivity Check ("Control")

If TCP connection establishment required:
Establish TCP connection

If indication on TCP connection establishment failure requested:
NotificationRequested (Event ID = x, "TCP connection establishment failure")

f (D)TLS session establishment required:
Establish (D)TLS session

If indication on (D)TLS session establishment failure requested:
NotificationRequested (Event ID = x, "(D)TLS session establishment failure") | If local resources are modified:
Local Descriptor {
If media is "audio" or "video":
Codec List
RTP Payloads
Stream content
If MMCMH feature:
Simulcast format
Simulcast desc
If RTP-level pause and resume:
CCM pause-resume
If RTCP Codec Control Commands and Indications:
CCM BASE
If RTCP Delay Budget Information:
DBI

If media is "video":
If CVO required:
Extended Header for CVO (NOTE 3)
If media is "video":
If imageattr negotiation:
Generic Image Attribute (NOTE 4)
If media is "video":
If Predefined ROI required:
Extended Header For Sent ROI

If termination towards ROI-sending client:
RTCP feedback for Predefined ROI Sent

If Arbitrary ROI required:
Extended Header For Sent ROI

If termination towards ROI-sending client:
RTCP feedback for Arbitrary ROI Sent

If media is "message":
If IMS media plane security required:
Transport = TCP/TLS/MSRP
Else
Transport = TCP/MSRP

If media is "application":
If CLUE data channel required:
Transport = UDP/DTLS/SCTP
Certificate fingerprint
Max message size

If SDPCapNeg is signalled to the gateway:
SDPCapNeg configuration
}

If remote resources are modified:
Remote Descriptor {
If signalling of concurrent codec capabilities in compact form for MMCMH conference:
Concurrent Codec Capabilities | + +| | | | +|-------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| |

If IMS media plane security required:
Pre-Shared Key (NOTE 6)

If MMCMH feature:
If RTP-level pause and resume:
Autonomous request
Autonomous response

|

(NOTE 8)

If media is "audio" or "video":
Codec List
RTP Payloads
Stream content
If MMCMH feature:
Simulcast format
Simulcast desc
If RTP-level pause and resume:
CCM pause-resume
If rate adaptation for media endpoints:
Additional Bandwidth Properties (NOTE 7)
If RTCP Codec Control
Commands and Indications:
CCM BASE
If RTCP Delay Budget Information:
DBI

If media is "video":
If CVO required:
Extended Header for CVO (NOTE 3)

If media is "video":
If imageattr negotiation:
Generic Image Attribute (NOTE 4)

If media is "video":
If Predefined ROI required:
Extended Header For Sent ROI
If termination towards ROI-receiving client:
RTCP feedback for Predefined ROI Received
If Arbitrary ROI required:
Extended Header For Sent ROI
If termination towards ROI-receiving client:
RTCP feedback for Arbitrary ROI Received

If media is "message"
If IMS media plane security required:
Transport = TCP/TLS/MSRP
Else
Transport = TCP/MSRP

If RTCP APP messages allowed
Allowed RTCP APP message types

If ICE is applied:
ICE received candidate
ICE received password
ICE received Ufrag (NOTE 5)

If SDPCapNeg is signalled to the gateway:
SDPCapNeg configuration
}

| +| NOTE1: It is highly recommended to request termination heartbeat notification to detect hanging context and | | | + +| | | +|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | termination in the MRFP that may result e.g. from a loss of communication between the MRFC and the MRFP. | +| NOTE 2: | This shall be set to a value other than "inactive". | +| NOTE 3: | If the MRFP supports the extended RTP header it shall pass any received extended RTP header with CVO bits on to succeeding RTP streams. If the MRFP transcodes between video payloads and it supports the extended RTP header with CVO bits it shall keep the video orientation unchanged during the transcoding and convey received RTP CVO header bytes on the succeeding RTP streams after transcoding associated packets as specified in 3GPP TS 26.114 [41], clause 7.4.5. | +| NOTE 4: | The support of the generic image attributes is optional for the MRFP. The list of image sizes per payload type supported by the MRFP is preconfigured in the MRFC. If none of the image sizes received within an SDP body on Mr interface is supported by the MRFP then the MRFC will not send the generic image attribute parameter to the MRFP. | +| NOTE 5: | The support of ICE received candidate, ICE received password, ICE received Ufrag are optional for ICE lite, as specified in 3GPP TS 23.333 [25]. | +| NOTE 6: | The MRFC and the MRFP may support IMS media plane security i.e. end-to-end media security for session-based messaging (MSRP) using the pre-shared key (PSK) ciphersuites for TLS (specified in IETF RFC 4279 [58] and profiled as specified in Annex E of 3GPP TS 33.310 [59]). The list of PSK ciphersuites for TLS supported by the MRFP is preconfigured in the MRFC. | +| NOTE 7: | The support of rate adaptation for media endpoints using the additional bandwidth properties is optional for the MRFP. If media transcoding is required the MRFC may provide for the selected payload type and the used IP version the additional bandwidth properties. | +| NOTE 8: | The support of "Compact Concurrent Codec Negotiation and Capabilities" is optional. If the MRFC received from the MMCMH conference participant the session level "ccc_list" SDP attribute, the MRFC may indicate to the MRFP the concurrent codec capabilities of the conference participant in a compact representation. | + +The MRFP responds as in 5.17.2.3.2. + +Table 5.17.2.3.2: Configure IMS Resources Request Acknowledge + +| Address Information | Control information | Bearer information | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| If local resources were provided in request:
Local Descriptor {
Port
IP Address
If media is "message":
MSRP session identity
}
If remote resources are provided in request:
Remote Descriptor {
Port
IP Address
If media is "message":
MSRP session identity
} | Transaction ID = x
Context ID = C1
Termination ID = T1

If Stream Number Specified:
Stream Number | If local resources were provided in request:
Local Descriptor {
If media is "audio" or "video":
Codec List
RTP Payloads
Stream content
If MMCMH feature:
Simulcast format
Simulcast desc
If RTP-level pause and resume:
CCM pause-resume
If RTCP Codec Control Commands and Indications:
CCM BASE
If RTCP Delay Budget Information:
DBI

If media is "video":
If CVO extension header provided in the request:
Extended Header for CVO
If media is "video":
If imageattr negotiation:
Generic Image Attribute
If media is "video":
If Predefined ROI provided in the request:
Extended Header For Sent ROI
If termination towards ROI-sending client:
RTCP feedback for Predefined ROI Sent
If Arbitrary ROI provided in the request:
Extended Header For Sent ROI
If termination towards ROI-sending client:
RTCP feedback for Arbitrary ROI Sent

If media is "message":
If IMS media plane security required:
Transport = TCP/TLS/MSRP
Else
Transport = TCP/MSRP
}

If remote resources are provided in request:
Remote Descriptor {
If signalling of concurrent codec capabilities in compact form for MMCMH conference:
Concurrent Codec Capabilities

If media is "audio" or "video":
Codec List
RTP Payloads
Stream content
If MMCMH feature: | + +| | | | +|--|--|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | Simulcast format
Simulcast desc
If RTP-level pause and resume:
CCM pause-resume
If rate adaptation for media endpoints:
Additional Bandwidth Properties
If RTCP Codec Control Commands and Indications:
CCM BASE
If RTCP Delay Budget Information:
DBI

If media is "video":
If CVO extension header provided in the request:
Extended Header for CVO
If media is "video":
If imageattr negotiation:
Generic Image Attribute
If media is "video":
If Predefined ROI provided in the request:
Extended Header For Sent ROI

If termination towards ROI-receiving client:
RTCP feedback for Predefined ROI Received
If Arbitrary ROI provided in the request:
Extended Header For Sent ROI

If termination towards ROI-receiving client:
RTCP feedback for Arbitrary ROI Received

If media is "message":
If IMS media plane security required:
Transport = TCP/TLS/MSRP
Else
Transport = TCP/MSRP
If media is "application":
If CLUE data channel required:
Transport = UDP/DTLS/SCTP
} | +|--|--|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +#### 5.17.2.4 Reserve and Configure IMS Resources + +The MRFC sends an ADD request command as in Table 5.17.2.4.1. + +Table 5.17.2.4.1: Reserve and Configure IMSresources Request + +| Address Information | Control information | Bearer information | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Local Descriptor {
Port = \$
IP Address = \$
If media is "message":
MSRP session identity = \$
If media is "application":
If CLUE data channel required:
SCTP Port = \$
}
Remote Descriptor {
Port
IP Address
If media is "message":
MSRP session identity
If media is "application":
If CLUE data channel required:
SCTP Port
} | Transaction ID = x
Context ID = \$
If MPS call/session:
Priority Indicator = x
ContextAttribute Descriptor {
If MMCMH feature:
MMCMH policy
}
Termination ID = \$
If Stream Number Specified:
Stream Number
If Resources for multiple Codecs shall be reserved:
Reserve_Value
If detection of hanging termination is requested: (NOTE1)
NotificationRequested (Event ID = x, "termination heartbeat")
If ECN transparent support required:
ECN Enable = "True"
Initiation Method = "inactive"
If ECN Endpoint support required
ECN Enable = "True"
Initiation Method = "ECN Initiation Method" NOTE2
If notification of ECN Failure Report:
NotificationRequested (Event ID = x, "ECN Failure")
If diffserv required:
Diffserv Code Point
If ICE is applied:
STUN server request
If full ICE is applied
Send Connectivity Check ("Control")
If notification of ICE Connectivity Check Result Report:
NotificationRequested (Event ID = xx, "Connectivity Check Result")
If notification of New Peer Reflexive Candidate:
NotificationRequested (Event ID = xy, "New Peer Reflexive Candidate")
If TCP connection establishment required:
Establish TCP connection
If indication on TCP connection establishment failure requested:
NotificationRequested (Event ID = x, "TCP connection establishment failure") | Local Descriptor {
If media is "audio" or "video":
Codec List
RTP Payloads
Stream content
If MMCMH feature:
Simulcast format
Simulcast desc
If RTP-level pause and resume:
CCM pause-resume
If RTCP Codec Control Commands and Indications:
CCM BASE
If RTCP Delay Budget Information:
DBI
If media is "video":
If CVO required:
Extended Header for CVO (NOTE 3)
If media is "video":
If imageattr negotiation:
Generic Image Attribute (NOTE 4)
If media is "video":
If Predefined ROI required:
Extended Header For Sent ROI
If termination towards ROI-sending client:
RTCP feedback for Predefined ROI Sent
If Arbitrary ROI required:
Extended Header For Sent ROI
If termination towards ROI-sending client:
RTCP feedback for Arbitrary ROI Sent
If media is "message":
If IMS media plane security required:
Transport = TCP/TLS/MSRP
Else
Transport = TCP/MSRP
If media is "application":
If CLUE data channel required:
Transport = UDP/DTLS/SCTP
Certificate fingerprint = \$
SCTP Stream ID
Subprotocol = CLUE
Max message size = \$
If ICE is applied:
ICE host candidate request
ICE password request
ICE Ufrag request
If SDPCapNeg is signalled to the gateway:
SDPCapNeg configuration
}
Remote Descriptor { If signalling of concurrent codec capabilities in compact form for MMCMH | + +| | | | +|--|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| |

If (D)TLS session establishment required:
Establish (D)TLS session

If indication on (D)TLS session establishment failure requested:
NotificationRequested
(Event ID = x, "(D)TLS session establishment failure")

If IMS media plane security required:
Pre-Shared Key (NOTE 6)

If indication on CLUE message received requested:
NotificationRequested
(Event ID = x, "CLUE message received")

If MMCMH feature:
If RTP-level pause and resume:
Autonomous request
Autonomous response

|

conference:
Concurrent Codec Capabilities (NOTE 8)

If media is "audio" or "video":
Codec List
RTP Payloads
Stream content
If MMCMH feature:
Simulcast format
Simulcast desc
If RTP-level pause and resume:
CCM pause-resume
If rate adaptation for media endpoints:
Additional Bandwidth Properties (NOTE 7)
If RTCP Codec Control
Commands and Indications:
CCM BASE
If RTCP Delay Budget Information:
DBI

If media is "video":
If CVO required:
Extended Header for CVO (NOTE 3)

If media is "video":
If imageattr negotiation:
Generic Image Attribute (NOTE 4)

If media is "video":
If Predefined ROI required:
Extended Header For Sent ROI
If termination towards ROI-receiving client:
RTCP feedback for Predefined ROI Received
If Arbitrary ROI required:
Extended Header For Sent ROI
If termination towards ROI-receiving client:
RTCP feedback for Arbitrary ROI Received

If media is "message":
If IMS media plane security required:
Transport = TCP/TLS/MSRP
Else
Transport = TCP/MSRP

If media is "application":
If CLUE data channel required:
Transport = UDP/DTLS/SCTP
Certificate fingerprint
Max message size

If RTCP APP messages allowed
Allowed RTCP APP message types

If ICE is applied:
ICE received candidate
ICE received password
ICE received Ufrag (NOTE 5)

| +|--|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +| | | | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--|---------------------------------------------------------------------------| +| | | If SDPCapNeg is signalled to the gateway:
SDPCapNeg configuration
} | +|

NOTE1: It is highly recommended to request termination heartbeat notification to detect hanging context and termination in the MRFP that may result e.g. from a loss of communication between the MRFC and the MRFP.

NOTE 2: This shall be set to a value other than "inactive".

NOTE 3: If the MRFP supports the extended RTP header it shall pass any received extended RTP header with CVO bits on to succeeding RTP streams. If the MRFP transcodes between video payloads and it supports the extended RTP header with CVO bits it shall keep the video orientation unchanged during the transcoding and convey received RTP CVO header bytes on the succeeding RTP streams after transcoding associated packets as specified in 3GPP TS 26.114 [41], clause 7.4.5.

NOTE 4: The support of the generic image attributes is optional for the MRFP. The list of image sizes per payload type supported by the MRFP is preconfigured in the MRFC. If none of the image sizes received within an SDP body on Mr interface is supported by the MRFP then the MRFC will not send the generic image attribute parameter to the MRFP.

NOTE 5: The support of ICE received candidate, ICE received password, ICE received Ufrag are optional for ICE lite, as specified in 3GPP TS 23.333 [25].

NOTE 6: The MRFC and the MRFP may support IMS media plane security i.e. end-to-end media security for session-based messaging (MSRP) using the pre-shared key (PSK) ciphersuites for TLS (specified in IETF RFC 4279 [58] and profiled as specified in Annex E of 3GPP TS 33.310 [59]). The list of PSK ciphersuites for TLS supported by the MRFP is preconfigured in the MRFC.

NOTE 7: The support of rate adaptation for media endpoints using the additional bandwidth properties is optional for the MRFP. If media transcoding is required the MRFC may provide for the selected payload type and the used IP version the additional bandwidth properties.

NOTE 8: The support of "Compact Concurrent Codec Negotiation and Capabilities" is optional. If the MRFC received from the MMCMH conference participant the session level "ccc_list" SDP attribute, the MRFC may indicate to the MRFP the concurrent codec capabilities of the conference participant in a compact representation.

| | | + +The MRFP responds as in Table 5.17.2.4.2. + +Table 5.17.2.4.2: Reserve and Configure IMS Resources Request Acknowledge + +| Address Information | Control information | Bearer information | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Local Descriptor {
Port
IP Address
If media is "message":
MSRP session identity
If media is "application":
If CLUE data channel required:
SCTP Port
}
Remote Descriptor {
Port
IP Address
If media is "message":
MSRP session identity
} | Transaction ID = x
Context ID = C1
Termination ID = T1
Stream Number | Local Descriptor {
If media is "audio" or "video":
Codec List
RTP Payloads
Stream content
If MMCMH feature:
Simulcast format
Simulcast desc
If RTP-level pause and
resume:
CCM pause-resume
If RTCP Codec Control
Commands and Indications:
CCM BASE
If RTCP Delay Budget Information:
DBI

If media is "video":
If CVO extension header
provided in the request:
Extended Header for CVO
If media is "video":
If imageattr negotiation:
Generic Image Attribute
If media is "video":
If Predefined ROI provided in the
request:
Extended Header For Sent ROI
If termination towards ROI-
sending client:
RTCP feedback for Predefined
ROI Sent
If Arbitrary ROI provided in the
request:
Extended Header For Sent ROI
If termination towards ROI-
sending client:
RTCP feedback for Arbitrary
ROI Sent

If media is "message":
If IMS media plane security
required:
Transport = TCP/TLS/MSRP
Else
Transport = TCP/MSRP
If media is "application":
If CLUE data channel required:
Transport = UDP/DTLS/SCTP
Certificate fingerprint
SCTP Stream ID
Subprotocol = CLUE
Max message size

If ICE is applied:
ICE host candidate
ICE password
ICE Ufrag
If ICE lite implementation
ICE lite indication

If SDPCapNeg is signalled to the
gateway:
SDPCapNeg configuration
} | + +| | | | +|--|--|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | Remote Descriptor {
If signalling of concurrent codec capabilities in compact form for MMCMH conference:
Concurrent Codec Capabilities

If media is "audio" or "video":
Codec List
RTP Payloads
Stream content
If MMCMH feature:
Simulcast format
Simulcast desc
If RTP-level pause and resume:
CCM pause-resume
If rate adaptation for media endpoints:
Additional Bandwidth Properties
If RTCP Codec Control
Commands and Indications:
CCM BASE
If RTCP Delay Budget Information:
DBI

If media is "video":
If CVO extension header provided in the request:
Extended Header for CVO
If media is "video":
If imageattr negotiation:
Generic Image Attribute
If media is "video":
If Predefined ROI provided in the request:
Extended Header For Sent ROI
If termination towards ROI-receiving client:
RTCP feedback for Predefined ROI Received
If Arbitrary ROI provided in the request:
Extended Header For Sent ROI
If termination towards ROI-receiving client:
RTCP feedback for Arbitrary ROI Received

If media is "message":
If IMS media plane security required:
Transport = TCP/TLS/MSRP
Else
Transport = TCP/MSRP
If media is "application":
If CLUE data channel required:
Transport = UDP/DTLS/SCTP

If SDPCapNeg is signalled to the gateway:
SDPCapNeg configuration
} | +|--|--|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +#### 5.17.2.5 Release IMS Termination + +The MRFC sends a SUBTRACT command as in Table 5.17.2.5.1. + +**Table 5.17.2.5.1: Release IMS Termination Request** + +| Address Information | Control information | Bearer information | +|----------------------------|-------------------------------------------------------------|---------------------------| +| | Transaction ID = x
Context ID= C1
Termination ID = T1 | | + +On releasing the IMS termination, the MRFP responds as in Table 5.17.2.5.2 + +**Table 5.17.2.5.2: Release IMS Termination Request Acknowledge** + +| Address Information | Control information | Bearer information | +|----------------------------|--------------------------------------------------------------|---------------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +#### 5.17.2.6 Send Tone + +This procedure is used to play a tone. + +The MRFC sends an ADD or MODIFY command as in table 5.17.2.6.1. + +**Table 5.17.2.6.1: Send Tone** + +| Address information | Control information | Bearer information | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
If context already exists:
Context ID = C1
Else
Context = \$
If Termination exists:
Termination ID = T1
Else
Termination ID = \$

If Stream Number specified:
Stream Number

Signal ID = Tone Identity
If override Signal Direction
Direction = Signal Direction

If DTMF override
Override = DTMFTrigger

If MRFC wishes to override the default tone duration:
Tone Duration

If MRFC requires to be informed of the end of the tone :-
Request End Of Signal Notification
If detection of hanging termination is requested: (NOTE3)
NotificationRequested (Event ID = x, "termination heartbeat") | | +| NOTE1: Signal Direction shall be either "internal" or "external".
NOTE2: Only the Tone Signal Ids shall be used, not the Tone Ids within the PlayTone Signal Id.
NOTE3: The termination heartbeat event shall be configured when requesting a new bearer termination. | | | + +The MRFP responds as shown in Table 5.17.2.6.2. + +**Table 5.17.2.6.2: SendTone Acknowledge** + +| Address information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1
If local resources were provided in request:
Stream Number | | + +#### 5.17.2.7 Stop Tone + +This procedure is used to stop a tone. This procedure is the same as the procedure Start Tone however the signal descriptor shall not include the started tone signal. Note that a tone may also be stopped by releasing the IMS termination. + +#### 5.17.2.8 Tone Completed + +This procedure is used to report that a tone has ended. + +The MRFP sends a NOTIFY to the MRFC as shown in table 5.17.2.q.1. + +**Table 5.17.2.8.1: Tone Completed** + +| Address information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1
End Of Signal Notification = Tone
Completed
Cause | | + +The MRFC responds as shown in Table 5.17.2.8.2. + +**Table 5.17.2.8.2: Tone Completed Ack** + +| Address information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +#### 5.17.2.9 Start Announcement + +This procedure is used to play an announcement, which may be fixed or variable. + +The MRFC sends an ADD or MODIFY command as in Table 5.17.2.9.1. + +**Table 5.17.2.9.1: Start Announcement** + +| Address information | Control information | Bearer information | +|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
If context already exists:
Context ID = C1
Else
Context = \$
If Termination exists:
Termination ID = T1
Else
Termination ID = \$

If Stream number specified:
Stream Number

Announcement Identity
If override Signal Direction
Direction = Announcement
Direction

If DTMF override
Override = DTMFTrigger

If MRFC wishes to override the
default number of cycles:
Announcement Cycles | | + +| | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| |

If MRFC wishes to override the default announcement variant:
Announcement Variant

If MRFC requires to be informed of the end of the fixed announcement :-
Request End Of Signal Notification

If detection of hanging termination is requested: (NOTE4)
NotificationRequested (Event ID = x, "termination heartbeat")

| | +|

NOTE1: Signal Direction shall be either "internal" or "external".
NOTE2: Stream mode may be maintained as for the ongoing call or may be restricted to "send only".
NOTE3: Signal Lists shall be supported.
NOTE4: The termination heartbeat event shall be configured when requesting a new bearer termination.

| | | + +The MRFP responds as shown in Table 5.17.2.9.2. + +**Table 5.17.2.9.2: Start Announcement Acknowledge** + +| Address information | Control information | Bearer information | +|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| |

Transaction ID = x
Context ID = C1
Termination ID = T1

If local resources were provided in request:
Stream Number

| | + +#### 5.17.2.10 Stop Announcement + +This procedure is used to stop an announcement. This procedure is the same as the procedure Start Announcement however the signal descriptor shall not include the started announcement signal. Note that an announcement may also be stopped by releasing the IMS termination. + +#### 5.17.2.11 Announcement Completed + +This procedure is used to report that an announcement has ended. + +The MRFP sends a NOTIFY to the MRFC as shown in table 5.17.2.11.1. + +**Table 5.17.2.11.1: Announcement Completed** + +| Address information | Control information | Bearer information | +|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| |

Transaction ID = x
Context ID = C1
Termination ID = T1
End Of Signal Notification =
Announcement Completed
Cause = Announcement Cause

| | + +The MRFC responds as shown in Table 5.17.2.11.2. + +**Table 5.17.2.11.2: Announcement Completed Ack** + +| Address information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +#### 5.17.2.12 Start TTS + +This procedure is used to play out a text file as speech. + +The MRFC sends an ADD or MODIFY command as in Table 5.17.2.12.1. + +**Table 5.17.2.12.1: Start TTS request** + +| Address information | Control information | Bearer information | +|------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
If context already exists:
Context ID = C1
Else
Context = \$
If Termination exists:
Termination ID = T1
Else
Termination ID = \$

If Stream number specified:
Stream Number
If override Direction
TTS Direction = Signal Direction

If DTMF override
DTMF Stop TTS = DTMFTrigger

Text Block = SSML

If MRFC wishes to override the default number of cycles:
number of cycles = Iterations

If MRFC requires to be informed of the end of TTS:-
Request End Of Signal Notification

If detection of hanging termination is requested: (NOTE1)
NotificationRequested (Event ID = x, "termination heartbeat") | | +| NOTE1: The termination heartbeat event shall be configured when requesting a new bearer termination. | | | + +The MRFP responds as shown in Table 5.17.2.12.2. + +**Table 5.17.2.12.2: Start TTS Acknowledge** + +| Address information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +| | | | +|--|---------------------------------------------------------------|--| +| | If local resources were provided in request:
Stream Number | | +|--|---------------------------------------------------------------|--| + +#### 5.17.2.13 Stop TTS + +This procedure is used to stop TTS play. This procedure is the same as the procedure Start TTS however the signal descriptor shall not include the started TTS signal. Note that an TTS play may also be stopped by releasing the IMS termination. + +#### 5.17.2.14 TTS Completed + +This procedure is used to report that an TTS play has ended. + +The MRFP sends a NOTIFY to the MRFC as shown in table 5.17.2.14.1. + +**Table 5.17.2.14.1: TTS Completed** + +| Address information | Control information | Bearer information | +|---------------------|------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1
End Of Signal Notification = TTS
Completed
Cause | | + +The MRFC responds as shown in Table 5.17.2.14.2. + +**Table 5.17.2.14.2: TTS Completed Ack** + +| Address information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +#### 5.17.2.15 Start Audio Record + +This procedure enables a caller to leave/record a voice message (e.g. in a voice mail application). + +The MRFC sends an ADD or MODIFY command as in table 5.17.2.15.1. + +**Table 5.17.2.15.1: Start Audio Record** + +| Address information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
If context already exists:
Context ID = C1
Else
Context = \$
If Termination exists:
Termination ID = T1
Else
Termination ID = \$

If Stream Number specified:
Stream Number

If specific record file
Recording File Identity = Record | | + +| Address information | Control information | Bearer information | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | File Identifier

If request record file Identity
Recording File Identity = ?

If maximum record time
Maximum Recording Length =
Maximum Record Time
If MRFC requires to be informed
of the end of the recording :-
End Of Recording
Notification

If override Signal Direction
Direction = Signal Direction

If detection of hanging termination
is requested: (NOTE1)
NotificationRequested (Event ID =
x, "termination heartbeat") | | +| NOTE1: The termination heartbeat event shall be configured when requesting a new bearer termination.
NOTE2: Signal Direction shall be either "internal" or "external".
NOTE3: Multiple signals shall be supported. | | | + +The MRFP responds as shown in table 5.17.2.15.2. + +**Table 5.17.2.15.2: Start Audio Record acknowledge** + +| Address information | Control information | Bearer information | +|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1
If local resources were provided in
request:
Stream Number
If requested record file identity
Recording File Identity = Record
File Identifier | | + +#### 5.17.2.16 Stop Audio Record + +This procedure is used to stop recording of audio. Note that Audio Record may also be stopped by releasing the IMS termination. + +**Table 5.17.2.16.1: Stop Audio Record** + +| Address information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1

Stop Audio Record Indication

If End of Audio Record
Notification previously requested :
Stop End of Record
Notification | | + +The MRFP responds as shown in Table 5.17.2.16.2. + +**Table 5.17.2.16.2: Stop Audio Record Response** + +| Address information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +#### 5.17.2.17 Audio Record Complete + +This procedure enables the MRFP to inform the MRFC when an audio recording is complete. + +The MRFP sends a NOTIFY command as in table 5.17.2.17.1. + +**Table 5.17.2.17.1: Audio Record Complete** + +| Address information | Control information | Bearer information | +|---------------------|---------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1

End Of Recording Notification | | + +The MRFC responds as shown in table 5.17.2.17.2. + +**Table 5.17.2.17.2: Audio Record Complete Acknowledge** + +| Address information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +#### 5.17.2.18 Detect DTMF + +This procedure is used to collect DTMF digits. + +The MRFP applies the procedures defined in RFC 4733 [22] to receive DTMF digits at the user plane, however only complete single digits shall be reported, i.e. the MRFP shall wait until E-bit is set to 1 before reporting the digit to the MRFC. + +The MRFC sends an ADD or MODIFY command as in Table 5.17.2.18.1. + +**Table 5.17.2.18.1: Detect DTMF** + +| Address information | Control information | Bearer information | +|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
If context already exists:
Context ID = C1
Else
Context = \$
If Termination exists:
Termination ID = T1
Else
Termination ID = \$ | | + +| Address information | Control information | Bearer information | +|------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|--------------------| +| | If Stream Number specified:
Stream Number

NotificationRequested (Event ID = x, "Report_DTMF (Digit,Timing)") | | +| NOTE1: Only "end tone detected" shall be requested by the MRFC.
NOTE2: All digits shall be requested i.e. ToneId shall be wildcarded. | | | + +The MRFP responds as shown in Table 5.17.2.18.2. + +**Table 5.17.2.18.2: Detect DTMF acknowledge** + +| Address information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1
If local resources were provided in request:
Stream Number | | + +#### 5.17.2.19 Report DTMF + +This procedure is used to notify the MRFC of detected DTMF digits. + +The MRFP sends a NOTIFY command as in Table 5.17.2.19.1. + +**Table 5.17.2.19.1: Report DTMF** + +| Address information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1
Digit Notification = digit | | + +The MRFC responds as shown in Table 5.17.2.19.2. + +**Table 5.17.2.19.2: Report DTMF Digit Acknowledge** + +| Address information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +#### 5.17.2.20 Stop DTMF Detection + +This procedure is used to stop DTMF digit detection. + +The MRFC sends a MODIFY command as in Table 5.17.2.20.1. + +**Table 5.17.2.20.1: Stop DTMF Detection** + +| Address information | Control information | Bearer information | +|---------------------|------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1

Stop DTMF Digit Collection | | + +The MRFP responds as shown in Table 5.17.2.20.2. + +**Table 5.17.2.20.2: Stop DTMF Digit Detection acknowledge** + +| Address information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +#### 5.17.2.21 ASR Request + +This procedure enables the MRFC to request the MRFP to perform automatic speech recognition; an advanced interaction with the user involving guidance announcements and collection of user input via speech and also possibly DTMF. In turn, the MRFP attempts to recognize and match the detected speech to the specified grammar file and report this to the MRFC. + +The MRFC sends an ADD or MODIFY command as in table 5.17.2.21.1. + +**Table 5.17.2.21.1: ASR request** + +| Address information | Control information | Bearer information | +|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
If context already exists:
Context ID = C1
Else
Context = \$
If Termination exists:
Termination ID = T1
Else
Termination ID = \$

If Stream Number specified:
Stream Number

If recognition with grammar script
ASR Grammar = SRGS
grammar
Else recognition with grammar
identifier
ASR Grammar = SRGS
grammar URI

If MRFC requires to be informed
of the end of the ASR :-
NotificationRequested (Event ID
= x, "Notify ASR Completion
(recognition result)")

If detection of hanging termination
is requested: (NOTE1)
NotificationRequested (Event ID = | | + +| Address information | Control information | Bearer information | +|------------------------------------------------------------------------------------------------------|-----------------------------|--------------------| +| | x, "termination heartbeat") | | +| NOTE1: The termination heartbeat event shall be configured when requesting a new bearer termination. | | | + +The MRFP responds as shown in table 5.17.2.21.2. + +**Table 5.17.2.21.2: ASR request acknowledge** + +| Address information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1
If local resources were provided in request:
Stream Number | | + +#### 5.17.2.22 ASR Completed + +This procedure enables the MRFP to inform the MRFC of the result of an ASR request. + +The MRFP sends a NOTIFY command as in table 5.17.2.22.1. + +**Table 5.17.2.22.1: ASR Completed** + +| Address information | Control information | Bearer information | +|---------------------|------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1

If ASR fails:
ASR Cause
Else
recognition result | | + +The MRFP responds as shown in table 5.17.2.22.2. + +**Table 5.17.2.22.2: ASR Completed acknowledge** + +| Address information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +#### 5.17.2.23 Stop ASR + +This procedure is used to stop the ASR procedure. + +The MRFC sends a MODIFY command as in Table 5.17.2.23.1. + +**Table 5.17.2.23.1: Stop ASR** + +| Address information | Control information | Bearer information | +|----------------------------|------------------------------------------------------------------------------|---------------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1

Stop ASR | | + +The MRFP responds as shown in Table 5.17.2.23.2. + +**Table 5.17.2.23.2: Stop ASR acknowledge** + +| Address information | Control information | Bearer information | +|----------------------------|--------------------------------------------------------------|---------------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +#### 5.17.2.24 Start Playing Multimedia + +This procedure enables a caller to be connected to a playback of previously recorded multimedia segments. This procedure is similar to that of 5.17.2.9 with the difference that multiple H.248 streams will be used to reflect the multimedia content to be played out. + +The MRFC sends an ADD or MODIFY command as in Table 5.17.2.24.1. + +**Table 5.17.2.24.1: Start Playing Multimedia** + +| Address information | Control information | Bearer information | +|----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------| +| | Transaction ID = x
If context already exists:
Context ID = C1
Else
Context = \$
If Termination exists:
Termination ID = T1
Else
Termination ID = \$

If multiple media sources
Stream NumberX: Media IdentifierX
Stream numberY: Media IdentifierY
Else
Stream NumberX, Stream NumberY: Media Identifier

If override multimedia format
Format = Multimedia File Format

If override Signal Direction
Direction = Signal Direction

If DTMF override
Multimedia Override = DTMFTrigger

If MRFC wishes to override the | | + +| | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | default number of cycles:
play Cycles= iteration

If MRFC wishes to override the default announcement variant:
Announcement Variant

If MRFC requires to be informed of the end of the multimedia play
Request End Of Signal Notification

If detection of hanging termination is requested: (NOTE4)
NotificationRequested (Event ID = x, "termination heartbeat") | | +| NOTE1: Signal Direction shall be either "internal" or "external".
NOTE2: Stream mode may be maintained as for the ongoing call or may be changed be restricted to "send only".
NOTE3: Signal Lists shall be supported
NOTE4: The termination heartbeat event shall be configured when requesting a new bearer termination. | | | + +The MRFP responds as shown in Table 5.17.2.24.2. + +**Table 5.17.2.24.2: Start Playing Multimedia Acknowledge** + +| Address information | Control information | Bearer information | +|---------------------|-----------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1

If local resources were provided in request:
Stream Number | | + +#### 5.17.2.25 Stop Playing Multimedia + +This procedure is used to stop an announcement. This procedure is the same as the procedure Start Playing Multimedia however the signal descriptor shall not include the started multimedia signal. Note that playing multimedia may also be stopped by releasing the IMS termination. + +#### 5.17.2.26 Playing Multimedia Completed + +This procedure is used to report that a playing multimedia has ended. + +The MRFP sends a NOTIFY to the MRFC as shown in table 5.17.2.26.1. + +**Table 5.17.2.26.1: Playing Multimedia Completed** + +| Address information | Control information | Bearer information | +|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1
End Of Signal Notification =
Playing Multimedia Completed
Cause = Announcement Cause | | + +The MRFC responds as shown in Table 5.17.2.26.2. + +**Table 5.17.2.26.2: Playing Multimedia Completed Ack** + +| Address information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +#### 5.17.2.27 Start Multimedia Record + +This procedure enables a caller to leave/record a multimedia message. This procedure is similar to that of Audio Record (5.17.2.15) with the difference that multiple H.248 streams will be used and both audio and video codecs are specified for each participant in the conference. Any prompting "announcements" are played out in the appropriate format by the MRFP based on the fact that multimedia codecs are specified by the MRFC in the Remote Descriptor. Similarly, the MRFP records all received media streams that are consistent with the Local Descriptor of the termination. + +The MRFC sends an ADD or MODIFY command as in table 5.17.2.27.1. + +**Table 5.17.2.27.1 – Start Multimedia Record** + +| Address information | Control information | Bearer information | +|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
If context already exists:
Context ID = C1
Else
Context = \$
If Termination exists:
Termination ID = T1
Else
Termination ID = \$

If Stream Number specified:
Stream Number

If specific record file
Recording File Identity = Record
File Identifier

If override multimedia format
Format = Multimedia File
Format

If maximum record time
Maximum Recording Length =
Maximum Record Time

If MRFC requires to be informed
of the end of the recording :-
End Of Recording
Notification

If request record file identity
Recording File Identity = ?

If DTMF override
Override = DTMFTrigger

If detection of hanging termination
is requested: (NOTE1)
NotificationRequested (Event ID =
x, "termination heartbeat") | | + +| Address information | Control information | Bearer information | +|-----------------------------------------------------------------------------------------------------------------------------------------------------|---------------------|--------------------| +| | | | +| NOTE1: The termination heartbeat event shall be configured when requesting a new bearer termination.
NOTE2: Multiple signals shall be supported. | | | + +The MRFP responds as shown in table 5.17.2.27.2. + +**Table 5.17.2.27.2: Start Multimedia Record acknowledge** + +| Address information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1
If local resources were provided in request:
Stream Number

If requested record file identity
Recording File Identity = Record
File Identifier | | + +#### 5.17.2.28 Stop Multimedia Record + +This procedure is used to stop recording of multimedia. Note that Audio Record may also be stopped by releasing the IMS termination. + +**Table 5.17.2.28.1: Stop Multimedia Record** + +| Address information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1

Stop Multimedia Record
Indication

If End of Multimedia Record
Notification previously requested :
Stop End of Record
Notification | | + +The MRFP responds as shown in Table 5.17.2.28.2. + +**Table 5.17.2.28.2: Stop Multimedia Record Response** + +| Address information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +#### 5.17.2.29 Multimedia Record Completed + +This procedure enables the MRFP to inform the MRFC when multimedia recording is complete. + +The MRFP sends a NOTIFY command as in table 5.17.2.29.1. + +**Table 5.17.2.29.1: Multimedia Record Completed** + +| Address information | Control information | Bearer information | +|----------------------------|---------------------------------------------------------------------------------------------------|---------------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1

End Of Recording Notification | | + +The MRFC responds as shown in table 5.17.2.29.2. + +**Table 5.17.2.29.2: Multimedia Record Completed Acknowledge** + +| Address information | Control information | Bearer information | +|----------------------------|--------------------------------------------------------------|---------------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +#### 5.17.2.30 Adhoc Audio Conference + +This includes support for N-party conferences plus the support of audio transcoding. In this case, up to N ephemeral terminations may be placed in a context and appropriate audio transcoding performed by the MRFP between any codec differences between the terminations. In terms of the media mixing, the MRFP mixes audio from terminations N-1, N-2 etc plays to termination N and so forth. + +This procedure consists of the creation of the first ephemeral termination of a conference within a context using procedure "Reserve and Configure IMS Resources" and then subsequent parties are added using procedures "Reserve IMS Resources" and "Configure IMS Resources". + +#### 5.17.2.31 Multi-Media Conferencing + +This is similar to audio conferencing (5.17.2.y) with the difference that multiple H.248 streams will be used and both audio and video codecs are specified for each participant in the conference. The MRFP shall only transcode and mix between streams of the same media type. + +#### 5.17.2.32 Termination heartbeat indication + +When the procedure "Termination heartbeat indication" is required the following procedure is initiated: the MRFP sends a NOT.req command with the following information. + +**5.17.2.32.1 NOT.req (Termination heartbeat) MRFP to MRFC** + +| Address Information | Control information | Bearer information | +|----------------------------|----------------------------------------------------------------------------------------------------------------------|---------------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1

Event_ID (Event ID = x, "termination heartbeat") | | + +When the processing of command is complete, the MRFC initiates the following procedure. + +##### **5.17.2.32.2 NOT.resp (Termination heartbeat) MRFC to MRFP** + +| Address Information | Control information | Bearer information | +|----------------------------|--------------------------------------------------------------|---------------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +The heartbeat timer shall be configured to a value much greater than the mean call holding time. + +The MRFC is in charge of correcting any detected mismatch, by subtracting hanging terminations or clearing hanging contexts. + +#### **5.17.2.33 Configure BFCP Termination** + +This procedure configures a termination to support Binary Floor Control Protocol. + +The MRFC sends an ADD or MODIFY command as in Table 5.17.2.33.1. + +Table 5.17.2.33.1: Configure BFCP Termination MRFC to MRFP + +| Address Information | Control information | Bearer information | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Local Descriptor {
Port = \$
IP Address = \$
}
Remote Descriptor {
Port
IP Address
} | Transaction ID = x
If context already exists:
Context ID = C1
Else
Context = \$
If Termination exists:
Termination ID = T1
Else
Termination ID = \$

If Stream Number Specified:
Stream Number

If detection of hanging termination is requested: (NOTE 1)
NotificationRequested
(Event ID = x,
"termination heartbeat")

If TCP connection establishment required:
Establish TCP connection

If indication on TCP connection establishment failure requested:
NotificationRequested
(Event ID = x, "TCP connection establishment failure")

If indication on TLS session establishment failure requested:
NotificationRequested
(Event ID = x, "TLS session establishment failure")

If IMS media plane security required:
Pre-Shared Key (NOTE 3) | Local Descriptor {

If IMS media plane security required:
Transport = TCP/TLS/BFCP
Else
Transport = TCP/BFCP

User Identifier = UserID
Available Floors = FloorID-x, FloorID-y...(NOTE 2)
}

Remote Descriptor {

If IMS media plane security required:
Transport = TCP/TLS/BFCP
Else
Transport = TCP/ BFCP
} | +| NOTE 1: It is highly recommended to request termination heartbeat notification to detect hanging context and termination in the MRFP that may result e.g. from a loss of communication between the MRFC and the MRFP.
NOTE 2: Properties are configured against the local stream descriptor for BFCP but in fact applies to the whole termination (user), i.e. all streams.
NOTE 3: The MRFC and the MRFP may support IMS media plane security i.e. end-to-end media security for conferencing (BFCP) using the pre-shared key (PSK) ciphersuites for TLS (specified in IETF RFC 4279 [58] and profiled as specified in Annex E of 3GPP TS 33.310 [59]). The list of PSK ciphersuites for TLS supported by the MRFP is preconfigured in the MRFC. | | | + +The MRFP responds as in Table 5.17.2.33.2. + +**Table 5.17.2.33.2: Configure BFCP Termination Acknowledge MRFP to MRFC** + +| Address Information | Control information | Bearer information | +|-------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Local Descriptor {
Port
IP Address
}
Remote Descriptor {
Port
IP Address
} | Transaction ID = x
Context ID = C1
Termination ID = T1
Stream Number | Local Descriptor {
If IMS media plane security required:
Transport = TCP/TLS/BFCP
Else
Transport = TCP/ BFCP
}

Remote Descriptor {
If IMS media plane security required:
Transport = TCP/TLS/BFCP
Else
Transport = TCP/ BFCP
} | + +#### 5.17.2.34 Configure Conference + +This procedure configures or modifies Context properties required to support a MRFP based Floor Control Server. + +The MRFC sends an ADD or MODIFY command as in Table 5.17.2.34.1. + +**Table 5.17.2.34.1: Configure Conference MRFC to MRFP** + +| Address Information | Control information | Bearer information | +|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
If context already exists:
Context ID = C1
Else
Context = \$

ContextAttribute Descriptor {
Conference Identifier = ConflD

Floor Control Algorithm =
FloorControlAlgorithm

MaxNumber of Floor Holders =
MaxFloorHolder

Floor Resource Associations =
FloorResAssociations
} | | + +The MRFP responds as in Table 5.17.2.34.2. + +**Table 5.17.2.34.2: Configure Conference Acknowledge MRFP to MRFC** + +| Address Information | Control information | Bearer information | +|---------------------|---------------------|--------------------| +| | Context ID = C1 | | + +#### 5.17.2.35 Designate Floor Chair + +This procedure configures a termination to be Floor Chair support Binary Floor Control Protocol. + +Pre-requisites: + +- This procedure is dependent on "Configure Conference" procedure having been successfully completed or it may be combined in the same ADD command. +- This procedure is dependent on "Configure BFCP Termination" procedure having been successfully completed or it may be combined in the same command. + +The MRFC sends an ADD or MODIFY command as in Table 5.17.2.35.1. + +**Table 5.17.2.35.1: Designate Floor Chair MRFC to MRFP** + +| Address Information | Control information | Bearer information | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x

Context ID = C1

If Termination exists:
Termination ID = T1
Else
Termination ID = \$

If Stream Number Specified:
Stream Number

Floors Controlled by Chair =
ControlledByChair

If detection of hanging termination is requested: (NOTE1)
NotificationRequested (Event ID = x, "termination heartbeat") | | +| NOTE1: It is highly recommended to request termination heartbeat notification to detect hanging context and termination in the MRFP that may result e.g. from a loss of communication between the MRFC and the MRFP. | | | + +The MRFP responds as in Table 5.17.2.35.2. + +**Table 5.17.2.35.2: Designate Floor Chair Acknowledge MRFP to MRFC** + +| Address Information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1
Stream Number | | + +#### 5.17.2.36 Floor Request Decision + +This procedure requests the MRFP to notify the MRFC when a decision has been made by the FCS in response to a BFCP Floor Request. + +The MRFC sends an ADD or MODIFY command as in Table 5.17.2.yx.1. + +**Table 5.17.2.36.1: Floor Request Decision MRFC to MRFP** + +| Address Information | Control information | Bearer information | +|---------------------|-----------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1

NotificationRequested (Event ID = x, "FloorRequestDecision" ) | | + +The MRFP responds as in Table 5.17.2.36.2. + +**Table 5.17.2.36.2: Floor Request Decision Acknowledge MRFP to MRFC** + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +#### 5.17.2.37 Report Floor Request Decision + +This procedure indicates the decision made by the FCS in response to a BFCP Floor Request. The MRFP indicates the agreed Floor Permissions so that any required changes to the streams can be managed by the MRFC. + +The MGW sends a NOT.req command with the following information. + +**Table 5.17.2.37.1: NOT.req (FloorRequestDecision) MRFP to MRFC** + +| Address Information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = bearer1

Event_ID (Event ID = x, "
FloorRequestDecision (
Floor ID1 + FloorStatus1, Floor ID2
+ FloorStatus2) ") | | + +When the processing of command (1) is complete, the MGC initiates the following procedure. + +**Table 5.17.2.37.2: NOT.resp (FloorRequestDecision) MRFC to MRFP** + +| Address Information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1
Termination ID = bearer1 | | + +#### 5.17.2.38 Modify Media + +This procedure modifies the termination(s) in accordance with the agreed Floor Permissions granted by the FCS in response to a BFCP Floor Request (notified to the MRFC via the "Report Floor Request Decision" procedure). + +The MRFC sends a MODIFY command as in Table 5.17.2.38.1. + +**Table 5.17.2.38.1: Modify Media MRFC to MRFP** + +| Address Information | Control information | Bearer information | +|---------------------|---------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | Transaction ID = x
Context ID = C1
Termination ID | Local Descriptor {
If stream modified
Stream Mode = mode.
If attributes modified
[SDP...]
}

Remote Descriptor {
If stream modified
Stream Mode = mode.
If attributes modified
[SDP...]
} | + +The MRFP responds as in Table 5.17.2.38.2. + +**Table 5.17.2.38.2: Modify Media Acknowledge MRFP to MRFC** + +| Address Information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1
Stream Number | | + +#### 5.17.2.39 Confirm Media Update + +This procedure indicates to the MRFP when the media modification for a given Floor Request (notified to the MRFC via the "Report Floor Request Decision" procedure) has been performed. + +The MRFC sends a MODIFY command as in Table 5.17.2.39.1. + +**Table 5.17.2.39.1: Confirm Media Update MRFC to MRFP** + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID
If Stream Number Specified:
Stream Number

Floor Request Status = FloorStatus
Result = FloorRequestResult | | + +The MRFP responds as in Table 5.17.2.39.2. + +**Table 5.17.2.39.2: Confirm Media Update Acknowledge MRFP to MRFC** + +| Address Information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1
Stream Number | | + +#### 5.17.2.40 Start Playing Message + +This procedure enables a caller to be connected to a playback of previously recorded message segments. This procedure is similar to that of 5.17.2.24 with the difference that message streams will be used to reflect the message content to be played out. + +The MRFC sends an ADD or MODIFY command as in Table 5.17.2.40.1. + +**Table 5.17.2.40.1: Start Playing Message** + +| Address information | Control information | Bearer information | +|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
If context already exists:
Context ID = C1
Else
Context = \$
If Termination exists:
Termination ID = T1
Else
Termination ID = \$ | | + +| | | | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| |

If Stream Number specified:
Stream Number

Message identifier =
MessageIdentifier

If override Signal Direction
Direction = Signal Direction

If MRFC requires to be informed
of the end of the message play:
Result of message play =
MessagePlayResultReport

If detection of hanging termination
is requested: (NOTE4)
NotificationRequested (Event ID =
x, "termination heartbeat")

| | +|

NOTE1: Signal Direction shall be either "internal" or "external".
NOTE2: Stream mode may be maintained as for the ongoing call or may be changed be restricted to "send only".
NOTE3: Signal Lists shall be supported
NOTE4: The termination heartbeat event shall be configured when requesting a new bearer termination.

| | | + +The MRFP responds as shown in Table 5.17.2.40.2. + +**Table 5.17.2.40.2: Start Playing Message Acknowledge** + +| Address information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| |

Transaction ID = x
Context ID = C1
Termination ID = T1

If local resources were provided in
request:
Stream Number

| | + +#### 5.17.2.41 Stop Playing Message + +This procedure is used to stop an announcement. This procedure is the same as the procedure Start Playing Message however the signal descriptor shall not include the started message signal. Note that playing message may also be stopped by releasing the IMS termination. + +#### 5.17.2.42 Playing Message Completed + +This procedure is used to report that a playing message has ended. + +The MRFP sends a NOTIFY to the MRFC as shown in table 5.17.2.aa+3.1. + +**Table 5.17.2.42.1: Playing Message Completed** + +| Address information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| |

Transaction ID = x
Context ID = C1
Termination ID = T1
End Of Signal Notification =
Playing Message Completed
Cause = MessagePlayCause

| | + +The MRFC responds as shown in Table 5.17.2.42.2. + +**Table 5.17.2.42.2: Playing Message Completed Ack** + +| Address information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +#### 5.17.2.43 Start Message Record + +This procedure enables a caller to leave/record a messaging message. This procedure is similar to that of Multimedia Record (5.17.2.27) with the difference that messaging H.248 stream will be used. Similarly, the MRFP records all received media streams that are consistent with the Local Descriptor of the termination. + +The MRFC sends an ADD or MODIFY command as in table 5.17.2.43.1. + +**Table 5.17.2.43.1 – Start Message Record** + +| Address information | Control information | Bearer information | +|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
If context already exists:
Context ID = C1
Else
Context = \$
If Termination exists:
Termination ID = T1
Else
Termination ID = \$

If Stream Number specified:
Stream Number

If specific record file
Recording File Identity =
MessageRecordFileIdentifier
Else
Recording File Identity = ?

If maximum record time
Maximum Recording Length =
Maximum Record Time

If override Signal Direction
Direction = Signal Direction

If MRFC requires to be informed
of the end of the recording :-
End Of Recording Notification | | + +The MRFP responds as shown in table 5.17.2.43.2. + +**Table 5.17.2.43.2: Start Message Record acknowledge** + +| Address information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1
If local resources were provided in
request:
Stream Number | | + +| | | | +|--|-----------------------------------------------------------------------------------------------|--| +| | If requested record file identity
Recording File Identity =
MessageRecordFileIdentifier | | +|--|-----------------------------------------------------------------------------------------------|--| + +#### 5.17.2.44 Stop Message Record + +This procedure is used to stop recording of message. Note that Message Record may also be stopped by releasing the IMS termination. + +**Table 5.17.2.44.1: Stop Message Record** + +| Address information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1

Stop Multimedia Record
Indication

If End of Multimedia Record
Notification previously requested:
Stop End of Record Notification | | + +The MRFP responds as shown in Table 5.17.2.44.2. + +**Table 5.17.2.44.2: Stop Message Record Response** + +| Address information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +#### 5.17.2.45 Message Record Completed + +This procedure enables the MRFP to inform the MRFC when message recording is complete. + +The MRFP sends a NOTIFY command as in table 5.17.2.bb+3.1. + +**Table 5.17.2.45.1: Message Record Completed** + +| Address information | Control information | Bearer information | +|---------------------|---------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1

End Of Recording Notification | | + +The MRFC responds as shown in table 5.17.2.45.2. + +**Table 5.17.2.45.2: Message Record Completed Acknowledge** + +| Address information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +#### 5.17.2.46 Configure Granted Quota + +This procedure configures a termination of the granted quota to support message statistics. + +The MRFC sends an ADD or MODIFY command as in Table 5.17.2.46.1. + +**Table 5.17.2.46.1: Configure Granted Quota MRFC to MRFP** + +| Address Information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
If context already exists:
Context ID = C1
Else
Context = \$
If Termination exists:
Termination ID = T1
Else
Termination ID = \$

If Stream Number Specified:
Stream Number

If report of message statistics on quota is requested:
NotificationRequested (Event ID = x, "Messaging Quota" (
If Quota for number of messages sent specified:
Number of Messages Sent Quota = MessagesSentNumQuota

If Quota for number of messages received specified:
Number of Messages received Quota = MessagesreceivedNumQuota

If Quota for volume of messages sent specified:
Volume of Messages Sent Quota = MessagesSentVolQuota

If Quota for volume of messages received specified:
Volume of Messages Received Quota = MessagesReceivedVolQuota

If Valid Time specified:
Valid Time = StatValTime
)) | | + +The MRFP responds as in Table 5.17.2.46.2. + +**Table 5.17.2.46.2: Configure Granted Quota Acknowledge MRFP to MRFC** + +| Address Information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1
Stream Number | | + +#### 5.17.2.47 Report Message Statistics + +This procedure is used to notify the MRFC of message statistics. + +The MRFP sends a NOTIFY command as in Table 5.17.2.47.1. + +**Table 5.17.2.47.1: Report Message Statistics** + +| Address information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1

Reason For Report =
StatRepReason

If number of messages sent requested:
Number of Messages Sent =
MessagesSentNum

If number of messages received requested:
Number of Messages received =
MessagesreceivedNum

If volume of messages sent requested:
Volume of Messages Sent =
MessagesSentVol

If volume of messages received requested:
Volume of Messages Received =
MessagesReceivedVol | | + +The MRFC responds as shown in Table 5.17.2.47.2. + +**Table 5.17.2.47.2: Report Message Statistics Acknowledge** + +| Address information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +#### 5.17.2.48 Configure Filtering Rules + +This procedure configures a termination of the filtering rules to support message filtering. + +The MRFC sends an ADD or MODIFY command as in Table 5.17.2.48.1. + +**Table 5.17.2.48.1: Configure Filtering Rules MRFC to MRFP** + +| Address Information | Control information | Bearer information | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------| +| | Transaction ID = x
If context already exists:
Context ID = C1
Else
Context = \$
If Termination exists:
Termination ID = T1
Else
Termination ID = \$

If Stream Number Specified:
Stream Number

If requested message filtering on incoming messages:
Incoming Message Filters =
IncMessageFilters (NOTE)

If requested message filtering on outgoing messages:
Outgoing Message Filters =
OutMessageFilters (NOTE) | | +| NOTE: The value shall comply with Sieve [IETF RFC5228] with the exceptions described in H.248.69 [35] Clause 13.6. Filtering rules and Message treatment for Filtered message are included in the parameter. The filtering rules include Sender address, Message size, Message content type, Message content format and Message subject, and the filtering rules can be applied in different combination. The Message treatment for Filtered message include Block the delivery of the message, Store the message content and Redirect the message to another address. If the message treatment is "Store the message content" the Store URL should be specified, if the message treatment is "Redirect the message" the Redirect URL should be specified. | | | + +The MRFP responds as in Table 5.17.2.48.2. + +**Table 5.17.2.48.2: Configure Filtering Rules Acknowledge MRFP to MRFC** + +| Address Information | Control information | Bearer information | +|----------------------------|-------------------------------------------------------------------------------|---------------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1
Stream Number | | + +#### 5.17.2.49 ECN Failure Indication + +The MRFP sends a NOTIFY request command as in Table 5.17.2.49.1. + +**Table 5.17.2.49.1: ECN Failure Indication** + +| Address Information | Control information | Bearer information | +|----------------------------|----------------------------------------------------------------------------------------------------------------------------------|---------------------------| +| | Transaction ID = x
Context ID= C1
Termination ID = T1

Event_ID (Event ID = x,
" ECN Failure (ECN Failure Type)") | | +| | | | + +The MRFC responds as in Table 5.17.2.49.2 + +**Table 5.17.2.49.2: ECN Failure Indication Ack** + +| Address Information | Control information | Bearer information | +|----------------------------|---------------------------------------------------------------------|---------------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +#### 5.17.2.50 ICE Connectivity Check Result Notification + +The MRFP sends a NOTIFY request command as defined in Table 5.17.2.50.1. + +**Table 5.17.2.50.1: ICE Connectivity Check Result Notification** + +| Address Information | Control information | Bearer information | +|----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------| +| | Transaction ID = x
Context ID= C1
Termination ID = T1

Event_ID (Event ID = x,
" Connectivity Check Result
(Candidate/Transport Pair)") | | + +The MRFC responds as defined in Table 5.17.2.50.2 + +**Table 5.17.2.50.2: ICE Connectivity Check Result Notification Ack** + +| Address Information | Control information | Bearer information | +|----------------------------|--------------------------------------------------------------|---------------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +#### 5.17.2.51 ICE New Peer Reflexive Candidate Notification + +The MRFP sends a NOTIFY request command as defined in Table 5.17.2.51.1. + +**Table 5.17.2.51.1: ICE New Peer Reflexive Candidate Notification** + +| Address Information | Control information | Bearer information | +|----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|---------------------------| +| | Transaction ID = x
Context ID= C1
Termination ID = T1

Event_ID (Event ID = x,
" New Peer Reflexive Candidate
(Candidate)") | | + +The MRFC responds as defined in Table 5.17.2.51.2 + +**Table 5.17.2.51.2: ICE New Peer Reflexive Candidate Ack** + +| Address Information | Control information | Bearer information | +|----------------------------|--------------------------------------------------------------|---------------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +#### 5.17.2.52 Notify TCP connection establishment Failure Indication + +If the MRFC has requested reporting of TCP connection establishment failures the MRFP sends a NOTIFY request command as defined in table 5.17.2.52.1 when a TCP connection establishment failure occurs. + +**Table 5.17.2.52.1: Notify TCP connection establishment Failure Indication** + +| Address Information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1

Event_ID (Event ID = y,
"TCP connection establishment Error Indication") | | + +The MRFC responds as defined in table 5.17.2.52.2. + +**Table 5.17.2.52.2: Notify TCP connection establishment Failure Indication Ack** + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +#### 5.17.2.53 Notify TLS session establishment Failure Indication + +If the MRFC has requested reporting of TLS session establishment failures the MRFP sends a NOTIFY request command as defined in table 5.17.2.53.1 when an unsuccessful TLS session set-up occurs. + +**Table 5.17.2.53.1: Notify TLS session establishment Failure Indication** + +| Address Information | Control information | Bearer information | +|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1

Event_ID (Event ID = y,
"(TLS session establishment Error Indication") | | + +The MRFC responds as defined in table 5.17.2.53.2. + +**Table 5.17.2.53.2: Notify TLS session establishment Failure Indication Ack** + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +#### 5.17.2.54 CLUE Message Send + +This procedure is used in a telepresence session by the MRFC to request the MRFP to send a CLUE message. + +The MRFC sends a MODIFY command as in table 5.17.2.54.1. + +**Table 5.17.2.54.1: CLUE Message Send** + +| Address information | Control information | Bearer information | +|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1

CLUE Message Send (enhanced
protocol=CLUE,label, message
content) | | + +The MRFP responds as shown in table 5.17.2.54.2. + +**Table 5.17.2.54.2: CLUE Message Send acknowledge** + +| Address information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID= C1
Termination ID = T1 | | + +#### 5.17.2.55 CLUE Message Received + +This procedure enables the MRFP to inform the MRFC when a CLUE message received. + +The MRFP sends a NOTIFY command as in table 5.17.2.55.1. + +**Table 5.17.2.55.1: CLUE Message Received** + +| Address information | Control information | Bearer information | +|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1

Detect bearer level message
(protocol= CLUE, message
content) | | + +The MRFC responds as shown in table 5.17.2.55.2. + +**Table 5.17.2.55.2: CLUE Message Received Acknowledge** + +| Address information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +### 5.17.3 Non-Call Related Procedures + +#### 5.17.3.1 General + +This clause describes the various non-call related procedures which are listed in table 5.17.3.1.1 + +**Table 5.17.3.1.1: MRFP Non-Call Related Procedures** + +| Transaction defined in 3GPP TS 23.333 [25] | Support | Comment | +|---------------------------------------------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------| +| MRFP Out of service | Mandatory | 5.17.3.2 | +| MRFP Communication Up | Mandatory | 5.17.3.3 | +| MRFP Register | Mandatory | 5.17.3.4 | +| MRFP Re-register | Mandatory | 5.17.3.5 | +| MRFC Ordered Re-register | Mandatory | 5.17.3.6 | +| MRFC Restoration | Optional | 5.17.3.7 | +| MRFC Out of Service | Optional | 5.17.3.8 | +| Audit Value | Mandatory | 5.17.3.9 | +| Audit Capability | Optional | 5.17.3.10 | +| Capability Update | Optional | 5.17.3.11 | +| MRFP Resource Congestion Handling – Activate | Mandatory | 5.17.3.12 | +| MRFP Resource Congestion Handling – Indication | Mandatory | 5.17.3.13 | +| Command Rejected | Mandatory | 5.17.3.14

The "Command Rejected" procedure may be used in response both to call-related and non-call-related ITU-T Recommendation H.248 Commands | +| MRFP Restoration | Mandatory | 5.17.3.15 | + +#### 5.17.3.2 MRFP Out Of Service + +The MRFP sends a SERVICE CHANGE request command as in Table 5.17.3.2.1. + +**Table 5.17.3.2.1: MRFP Out Of Service Request** + +| Address Information | Control information | Bearer information | +|----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------| +| | Transaction ID = x
Context ID= -
Termination ID = ROOT
SC Method = FORCED or GRACEFUL
SC Reason = 905 Termination
Taken OOS or 908, MG Impending Failure | | + +The MRFC responds as in table 5.17.3.2.2. + +**Table 5.17.3.2.2: MRFP Out Of Service Request Ack** + +| Address Information | Control information | Bearer information | +|----------------------------|---------------------------------------------------------------|---------------------------| +| | Transaction ID = x
Context ID = -
Termination ID = ROOT | | + +#### 5.17.3.3 MRFP Communication Up + +The MRFP sends a SERVICE CHANGE request command as in Table 5.17.3.3.1 to the MRFC address to which the control link association was previously established. + +**Table 5.17.3.3.1: MRFP Communication Up** + +| Address Information | Control information | Bearer information | +|----------------------------|--------------------------------------------------------------------------------------------------------------------------------|---------------------------| +| | Transaction ID = x
Context ID= -
Termination ID = ROOT
SC Method = DISCONNECTED
SC Reason = 900 , Service Restored | | + +The MRFC may respond as in table 5.17.3.3.2. If a response is received, the control link association is re-established and the inactivity timer would be restarted. + +**Table 5.17.3.3.2: MRFP Communication Up Ack** + +| Address Information | Control information | Bearer information | +|----------------------------|---------------------------------------------------------------|---------------------------| +| | Transaction ID = x
Context ID = -
Termination ID = ROOT | | + +#### 5.17.3.4 MRFP Register + +The MRFP sends a SERVICE CHANGE request command as in Table 5.17.3.4.1. + +**Table 5.17.3.4.1: MRFP Register** + +| Address Information | Control information | Bearer information | +|----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------| +| | Transaction ID = x
Context ID= -
Termination ID = ROOT
SC Method = RESTART
SC Reason =901Cold Boot or 902, Warm Boot
H248 Profile Identity
H248 Protocol Version | | + +The MRFC responds as in table 5.17.3.4.2. + +**Table 5.17.3.4.2: MRFP Register Ack** + +| Address Information | Control information | Bearer information | +|----------------------------|------------------------------------------------------------------------------------------------------------------------------------|---------------------------| +| | Transaction ID = x
Context ID = -
Termination ID = ROOT
H248 Protocol Version
If applicable:-
H248 Profile Identity | | + +#### 5.17.3.5 MRFC Restoration + +When the MRFC has recovered, the MRFC sends a SERVICE CHANGE as in Table 5.17.3.5.1, + +The MRFP may respond as in Table 5.17.3.5.2. + +The MRFC sends a SERVICE CHANGE as in Table 5.17.3.5.1 + +**Table 5.17.3.5.1: MRFC Restoration** + +| Address Information | Control information | Bearer information | +|----------------------------|----------------------------------------------------------------------------------------------------------------------------------------|---------------------------| +| | Transaction ID = x
Context ID= -
Termination ID = ROOT
SC Method = RESTART
SC Reason = 901, Cold Boot OR
902, Warm Boot | | + +The MRFP responds as in table 5.17.3.5.2. + +**Table 5.17.3.5.2: MRFC Restoration Ack** + +| Address Information | Control information | Bearer information | +|----------------------------|---------------------------------------------------------------|---------------------------| +| | Transaction ID = x
Context ID = -
Termination ID = ROOT | | + +#### 5.17.3.6 MRFP Re-Register + +The MRFP sends a SERVICE CHANGE request command as in Table 5.17.3.6.1. + +**Table 5.17.3.6.1: Re-Registration** + +| Address Information | Control information | Bearer information | +|----------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------| +| | Transaction ID = x
Context ID= -
Termination ID = ROOT
SC Method = Handoff
SC Reason = 903, MGC Directed
Change
H248 Profile Identity
H248 Protocol Version | | + +The MRFC responds as in table 5.17.3.6.2. + +**Table 5.17.3.6.2: Re-Registration Ack** + +| Address Information | Control information | Bearer information | +|----------------------------|------------------------------------------------------------------------------------------------------------------------------------|---------------------------| +| | Transaction ID = x
Context ID = -
Termination ID = ROOT
H248 Protocol Version
If applicable:-
H248 Profile Identity | | + +#### 5.17.3.7 MRFC Ordered Re-register + +The MRFC sends a SERVICE CHANGE request command as in Table 5.17.3.7.1. + +**Table 5.17.3.7.1: MRFC Ordered Re-Register** + +| Address Information | Control information | Bearer information | +|---------------------|-----------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID= -
Termination ID = ROOT
SC Method = HANDOFF
SC Reason = 903, MGC Directed Change | | + +The MRFP responds as in table 5.17.3.7.2. + +**Table 5.17.3.7.2: MRFC Ordered Re-Register Ack** + +| Address Information | Control information | Bearer information | +|---------------------|---------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = -
Termination ID = ROOT | | + +The MRFP then performs an MRFP Re-Register procedure according to Clause 5.17.3.6. + +#### 5.17.3.8 Audit Value + +The MRFC sends an AUDIT VALUE request command as in Table 5.17.3.8.1. + +**Table 5.17.3.8.1: Audit Value** + +| Address Information | Control information | Bearer information | +|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID= -/ALL
Termination ID = ROOT/ALL/T1
Audit Packages (NOTE1)
Audit Descriptor =
Empty/IndAuditParameter:=
IndAudMediaDescriptor:=
streams
{
IndAudStreamParms:=
{
Stream Number,
IndAudStreamParms:=
IndAudLocalControlDescriptor:=
IndAudPropertyParm:=
mgcinfo
}
}

Audit Descriptor =
IndAuditParameter:=
IndAudMediaDescriptor:=
IndAudTerminationStateDescriptor:=
SDPCapNeg Supported Capabilities
(NOTE 2) | | + +NOTE 1: Packages are used for Null/Root Combination. +NOTE 2: Used for auditing SDPCapNeg Extensions when SDPCapNeg signalling to the gateway is supported. + +The MRFP responds as in table 5.17.3.8.2. + +**Table 5.17.3.8.2: Audit Value Ack** + +| Address Information | Control information | Bearer information | +|---------------------|---------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = -/Context ID
Termination ID = ROOT/T1
Packages List
Mgcinfo
SDPCapNeg Extensions | | + +Upon reception of the command in the MRFP: + +- The Service State returns the current Service State +- When Packages are requested, the Package Names and Versions are returned + +The following table illustrates the allowed combinations that can be obtained with the AuditValue Command: + +**Table 15.17.3.8.3: Combinations of AuditValue Command** + +| ContextID | TerminationID | Information Obtained | +|-----------|---------------|----------------------------------------------------------------| +| Specific | Wildcard | Audit of matching Terminations in a Context | +| Specific | Specific | Audit of a single Termination in a Context | +| Null | Root | Audit of Media Gateway state and events | +| All | Specific | (Non-null) ContextID in which the Termination currently exists | + +#### 5.17.3.9 Audit Capabilities + +The MRFC sends an AUDIT CAPABILITY request command as in Table 5.17.3.9.1. + +**Table 5.17.3.9.1: Audit Capability Request** + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID= -
Termination ID = ROOT
Audited Capabilities | | + +The MRFP responds as in table 5.17.3.9.2. + +**Table 5.17.3.8.2.2: Audit Capability Ack** + +| Address Information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = -
Termination ID = ROOT
Capabilities | | + +#### 5.17.3.10 Capability Update + +The MRFP sends a SERVICE CHANGE request command as in Table 5.17.3.10.1. + +**Table 5.17.3.10.1: Capability Update** + +| Address Information | Control information | Bearer information | +|----------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------| +| | Transaction ID = x
Context ID= -
Termination ID = ROOT
SC Method = RESTART or
DISCONNECTED
SC Reason = 916, Packages
Change or 917, Capability
Change | | + +The MRFC responds as in table 5.17.3.10.2. + +**Table 5.17.3.10.2 Capability Update Ack** + +| Address Information | Control information | Bearer information | +|----------------------------|---------------------------------------------------------------|---------------------------| +| | Transaction ID = x
Context ID = -
Termination ID = ROOT | | + +#### 5.17.3.11 MRFC Out of Service + +The MRFC sends a SERVICE CHANGE request command as in Table 5.17.3.11.1. + +**Table 5.17.3.11.1: MRFC Out Of Service** + +| Address Information | Control information | Bearer information | +|----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------| +| | Transaction ID = x
Context ID= -
Termination ID = ROOT
SC Method = FORCED or
GRACEFUL
SC Reason = 905, Termination
Taken OOS | | + +The MRFP responds as in table 5.17.3.11.2. + +**Table 5.17.3.11.2: MRFC Out Of Service Ack** + +| Address Information | Control information | Bearer information | +|----------------------------|---------------------------------------------------------------|---------------------------| +| | Transaction ID = x
Context ID = -
Termination ID = ROOT | | + +#### 5.17.3.12 MRFP Resource Congestion Handling – Activate + +The MRFC sends a MODIFY request command as in Table 5.17.3.12.1. + +**Table 5.17.3.12.1: MRFP Resource Congestion Handling – Activate** + +| Address Information | Control information | Bearer information | +|----------------------------|----------------------------------------------------------------------------------------------------------------------------------------|---------------------------| +| | Transaction ID = x
Context ID= -
Termination ID = ROOT
If required :
Set Inactivity Timer
Request Overload Notification | | + +The MRFP responds as in table 5.17.3.12.2. + +**Table 5.17.3.12.2: MRFP Resource Congestion Handling – Activate Ack** + +| Address Information | Control information | Bearer information | +|---------------------|---------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = -
Termination ID = ROOT | | + +#### 5.17.3.13 MRFP Resource Congestion Handling – Indication + +The MRFP sends a NOTIFY request command as in Table 5.17.3.13.1. + +**Table 5.17.3.13.1: MRFP Resource Congestion Handling – Indication** + +| Address Information | Control information | Bearer information | +|---------------------|---------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID= -
Termination ID = ROOT
Overload Notification | | + +The MRFC responds as in table 5.17.3.13.2. + +**Table 5.17.3.13.2: MRFP Resource Congestion Handling – Indication Ack** + +| Address Information | Control information | Bearer information | +|---------------------|---------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = -
Termination ID = ROOT | | + +#### 5.17.3.14 Command Rejected + +When the procedure "Command Reject" is required the following procedure is initiated: + +The MGW/MGC sends .resp to any command.req with the following information. + +**Table 5.17.3.14.1: NYcommand.resp (command reject ) MRFP/MRFC to MRFC/MRFP** + +| Address Information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1 or no context

Reason=Error | | + +#### 5.17.3.15 MRFP Restoration + +When the MRFP has recovered, the MRFP sends a SERVICE CHANGE as in Table 5.17.3.15.1, + +The MRFC may respond as in Table 5.17.3.15.2. + +The MRFP sends a SERVICE CHANGE as in Table 5.17.3.15.1 + +Table 5.17.3.15.1: MRFC Restoration + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID= -
Termination ID = ROOT
SC Method = RESTART
SC Reason = 900, Service Restored | | + +The MRFC responds as in table 5.17.3.15.2. + +Table 5.17.3.15.2: MRFC Restoration Ack + +| Address Information | Control information | Bearer information | +|---------------------|---------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = -
Termination ID = ROOT | | + +# --- Annex A (normative): The W3C SSML Profile for TTS function + +## A.1 Introduction + +This annex contains a profile to the W3C Speech Synthesis Markup Language (SSML) specification [28]. The SSML specification is a W3C Recommendation, and is designed to provide a rich, XML-based markup language for assisting the generation of synthetic speech in Web and other applications. The essential role of the markup language is to provide authors of synthesizable content a standard way to control aspects of speech such as pronunciation, volume, pitch, rate, etc. across different synthesis-capable platforms. + +This annex provides a profile for SSML according to the stage 2 specification of the Mp interface. This profile is referenced by the advanced audio server base package for TTS enhancement. + +## --- A.2 TTS Profile + +Table A.2.1: The profile of SSML + +| Element or attribute | Description | Support | +|----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------| +| speak | This is the root element that can contain text to be rendered and the following elements: audio, break, emphasis, lexicon, mark, meta, metadata, p, phoneme, say-as, sub, s, voice | Mandatory. | +| xml:lang | This attribute defines the language that applied to the element, subelements and its attributes. The phoneme, emphasis, break, p, and s elements are language specific dependent | Mandatory | +| xml:base | This attribute defines the base URI for resolving relative URI that may be used for the following elements:
- The optional src attribute of audio element
- The uri attribute of lexicon element | Optional | + +| | | | +|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------| +| lexicon | An SSML document may reference one or more external pronunciation documents, the lexicon element is used to identify the URI of this external document.
A lexicon document contains pronunciation for tokens that can appear in a text to be spoken. A lexicon element shall contain an uri. | Mandatory | +| meta and metadata | The metadata and meta elements are containers in which information about the document can be placed | Optional | +| p and s | A p element represents a paragraph and s element represents a sentence.
The use of p and s elements is optional. Where text occurs without an enclosing p or s element the synthesis processor should attempt to determine the structure using language-specific knowledge of the format of plain text.
The p element can only contain text to be rendered and the following elements: audio , break , emphasis , mark , phoneme , prosody , say-as , sub , s , voice .
The s element can only contain text to be rendered and the following elements: audio , break , emphasis , mark , phoneme , prosody , say-as , sub , voice . | Optional | +| say-as | The say-as element allows the author to indicate information on the type of text construct contained within the element and to help specify the level of detail for rendering the contained text. For example for English when "\$200" appears in a document it may be spoken as "two hundred dollars", similarly, "1/2" may be spoken as "half", "one of two"..
Defining a comprehensive set of text format types is difficult because of the variety of languages that have to be considered and because of the innate flexibility of written languages. SSML only specifies the say-as element, its attributes, and their purpose. It does not enumerate the possible values for the attributes. The Working Group expects to produce a separate document that will define standard values and associated normative behavior for these values.
The say-as element has three attributes: interpret-as, format and detail
The say-as element can only contain text to be rendered | Optional | + +| | | | +|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------| +| phoneme |

The phoneme element provides a phonemic/phonetic pronunciation for the contained text.

The ph attribute is a required attribute that specifies the phoneme/phone string.

The alphabet attribute is an optional attribute that specifies the phonemic/phonetic alphabet. An alphabet in this context refers to a collection of symbols to represent the sounds of one or more human languages. The only valid values for this attribute are "ipa" (see the next paragraph) and vendor-defined strings of the form "x-organization" or "x-organization-alphabet".

Example:
<phoneme alphabet="ipa" ph="t&#x259;mei&#x325;&#x27E;ou&#x325;"> tomato </phoneme>

| Optional | +| sub |

The sub element is employed to indicate that the text in the alias attribute value replaces the contained text for pronunciation. The required alias attribute specifies the string to be spoken instead of the enclosed string. The sub element can only contain text (no elements).

Example:
<sub alias="World Wide Web Consortium">W3C</sub>

| Optional | +| Voice |

The voice element indicates the characteristics of the voice rendering.

The voice element is commonly used to change the language

The following attributes are used:

  • - gender: male, female or neutral
  • - age
  • - variant: indicates a preferred variant of the other voice characteristics
  • - name indicates the processor-specific voice name
| Optional | +| emphasis |

The emphasis element requests that the contained text be spoken with emphasis (also referred to as prominence or stress).

the optional level attribute indicates the strength of emphasis to be applied. Defined values are "strong", "moderate", "none" and "reduced".

The emphasis element can only contain text to be rendered and the following elements: audio, break, emphasis, mark, phoneme, prosody, say-as, sub, voice.

| Optional | + +| | | | +|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------| +| break |

The break element is an empty element that controls the pausing or other prosodic boundaries between words.
The break element is most often used to override the typical automatic behaviour of a synthesis processor.
The following attributes are used on the break element:

  • - strength: "none", "x-weak", "weak" "medium", "strong", or "x-strong". It indicates the strength of the prosodic break in the speech output. For example, the breaks between paragraphs are typically much stronger than the breaks between words within a sentence.
  • - Time: the time attribute is an option attribute indicating the duration of a pause to be inserted in the output in seconds or milliseconds e.g. "250ms", "3s"
| Optional | +| prosody |

The prosody element permits control of the pitch, speaking rate and volume of the speech output, the optional attributes are:

  • - pith: this attribute indicates the baseline pitch. legal value are: a number followed by "Hz", a relative change (+10Hz or +5st, a semitone is half of a tone on the standard diatonic scale), or a "x-low", "low", "medium", high", x-high", or "default". The exact meaning of baseline pitch may vary across synthesis processors
  • - pitch contour: the pitch contour is a set of the form (time position,target), the first value is a percentage of the period of the contained text (a number followed by "%") and the second value is the value of the pitch attribute. e.g. (20%,"+10Hz) (40%, "+20Hz) means increase the pitch of 10Hz at 20% of the period of the contained text and 20Hz at 40% of the text duration.
  • - Range: the pitch range although the exact meaning may vary across synthesis processor. The same value as for pitch are legal value from SSML.
  • - Rate: change the speaking rate. Legal values are: a relative change or "x-slow", "slow", "medium", "fast", "x-fast" or "default".
  • - Duration: a value in seconds or milliseconds for the desired time to take to read the element contents.
  • - Volume: the volume for the contained text in the range 0.0 to 100.0. Legal values are: a number, a relative change or "silent", "x-soft", "soft", "medium", "loud", "x-loud", or "default".
| Optional | +| audio |

The audio element supports the insertion of recorded audio files.

| Optional | + +| | | | +|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------| +| Mark | The mark element is an empty element that places a marker into the text/tag sequence that the environment will be informed to detect the corresponding position within the rendered output and may report an event when encountered. This element has a name attribute. | Optional | +| Desc | The desc element can only occur within the content of the audio element. It describes the textual content of the audio source that may be used when text-only output is being produced by the synthesis processor. | Optional | + +# --- Annex B (normative): The W3C SRGS Profile for ASR function + +## B.1 Introduction + +This annex contains a profile to the W3C Speech Recognition Grammar Specification (SRGS) [29]. The SRGS are intended for use by speech recognizers and other grammar processors so that developers can specify the words and patterns of words to be listened for by a speech recognizer. + +This annex provides a profile for SRGS according to the stage 2 specification of the Mp interface. This profile is referenced by the ASR Package. + +## --- B.2 SRGS Profile + +Table B.2.1: The profile of SRGS + +| Declaration Item | Description | Support or not | +|------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------| +| Language | The language declaration of a grammar provides the language identifier that indicates the primary language contained by the document and optionally indicates a country or other variation. Additionally, any legal rule expansion may be labeled with a language identifier. The language declaration is required for all speech recognition grammars. | Mandatory | +| Mode | The mode of a grammar indicates the type of input that the user agent should be detecting. The default mode is " voice " for speech recognition grammars. An alternative input mode is " dtmf " input.

For the Mp interface, only voice mode is supported. | Mandatory | +| Root rule | Both the XML Form and ABNF Form permit the grammar header to optionally declare a single rule to be the root rule of the grammar. The rule declared as the root rule must be defined within the scope of the grammar. The rule declared as the root rule may be scoped as either public or private . | Mandatory | + +| | | | +|-----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------| +| Tag format |

The tag-format declaration is an optional declaration of a tag-format identifier that indicates the content type of all rule tags and header tags contained within a grammar. The tag-format identifier is a URI. It is recommended that the tag format identifier indicate both the content type and a version. Tags typically contain content for a semantic interpretation processor and in such cases the identifier, if present, should indicate the semantic processor to use. Tag-format identifier values beginning with the string "semantics/x.y" (where x and y are digits) are reserved for use by the W3C Semantic Interpretation for Speech Recognition specification [SEM] or future versions of the specification.

| Mandatory | +| Base URI |

Relative URIs are resolved according to a base URI, which may come from a variety of sources. The base URI declaration allows authors to specify a document's base URI explicitly. The path information specified by the base URI declaration only affects URIs in the document where the element appears. The base URI declaration is permitted but optional in both the XML Form and the ABNF Form.

| Optional | +| Pronunciation lexicon |

A grammar may optionally reference one or more external pronunciation lexicon documents. A lexicon document is identified by a URI with an optional media type. The pronunciation information contained within a lexicon document is used only for tokens defined within the enclosing grammar. The W3C Voice Browser Working Group is developing the Pronunciation Lexicon Markup Language [LEX]. The specification will address the matching process between tokens and lexicon entries and the mechanism by which a speech recognizer handles multiple pronunciations from internal and grammar-specified lexicons. Pronunciation handling with proprietary lexicon formats will necessarily be specific to the speech recognizer. Pronunciation lexicons are necessarily language-specific. Pronunciation lookup in a lexicon and pronunciation inference for any token may use an algorithm that is language-specific. (See Clause 2.1 for additional information on token handling and pronunciations.)

| Mandatory | +| Metadata |

Grammar documents let authors specify metadata — information about a document rather than document content — in a number of ways. A meta declaration in either the ABNF Form or XML Form may be used to express metadata information in both XML

| Not Applicable | + +| | | | +|-----|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------| +| | Form and ABNF Form grammars or to reference metadata available in an external resource. The XML Form also supports a metadata element that provides a more general and powerful treatment of metadata information than meta . Since metadata requires an XML metadata schema which cannot be expressed in ABNF, there is no equivalent of metadata in the ABNF Form of grammars. | | +| Tag | A grammar may optionally specify one or more tag declarations in the header. The content of a tag in the header, just like a tag in rule expansions, is an arbitrary string which may be used for semantic interpretation. | Mandatory | + +# --- Annex C (normative): H.248 Package for Multi-stream Multiparty Conferencing Media Handling (MMCMH) + +## C.1 Introduction + +This annex contains a Multi-party Multimedia Conference Media Handling Package that is required for the Multi-stream Multiparty Conferencing Media Handling (MMCMH) feature as specified in 3GPP TS 23.333 [25] clause 5.11.3. The MMCMH feature requires support of simulcast RTP media streams, see IETF RFC 8853 [73]. + +NOTE: The ID value of Packages, Properties, Events, Parameters, Signals, etc. are designated below by "textID" (a string representing its text ID) and by "0x?????" (the ID hexadecimal representation). + +## --- C.2 Specification of Multi-party Multimedia Conference Media Handling Package + +### C.2.1 Multi-party Multimedia Conference Media Handling Package + +| | | +|--------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Package name: | Multi-party Multimedia Conference Media Handling | +| Package ID: | mmcmh (0x?????) | +| Description: | This package defines functionality that allows the MP to interconnect video media flows with different StreamIDs and to autonomously determine the mix of video streams in a conference dependent on the active speaker. For example, everyone sees the active speaker and he sees the previous speaker in high resolution, and some or all other conference participants can be seen in low resolution ("thumbnail" videos). | +| Designed to be extended only: | No | + +**Version:** 1 +**Extends:** None + +### C.2.2 Properties + +#### C.2.2.1 MMCMH Policy + +**Property name:** MMCMH Policy +**Property ID:** mmcmhp (0x0001) +**Description:** This property indicates how the MP shall interconnect media streams. +**Type:** Sub-list of Enumeration +**Possible values:** mmcmhbp (0x0001) "MMCMH basic policy": + The StreamID of a received media stream does not determine on which outgoing media streams the media are to be forwarded. The MP shall not send media streams received on a termination towards that termination. The MP shall forward a received media stream of a particular media type (i.e. audio, main video or screenshare video) only towards outgoing media streams of the same media type. The MP shall select the video streams to be sent to a conference participant from among the videos received from the other conference participants in such a way that: + a) from each other conference participant at most one main video is sent to this conference participant; and + b) at most one screenshare video stream is sent to this conference participant. + +If the MP does not pass a received media stream to any conference participant and the "RTP-level pause resume" capability was configured for that media stream (using the "rtcp-fb" SDP attribute, defined in IETF RFC 4585 [40], with the "ccm" feedback parameter, defined in IETF RFC 5104 [71], and the "pause" ccm parameter as defined in IETF RFC 7728 [75]), the MP should signal to the sender of that media stream to pause sending that media stream in accordance with IETF RFC 7728 [75]. If the MP has previously signalled to a sender to pause sending a media stream and decides to pass that media stream to some conference participant(s), based on any of the criteria above, the MP shall signal to the sender to resume sending that media stream in accordance with IETF RFC 7728 [75]. + +**NOTE:** The media level SDP attribute "a=content" defined in IETF RFC 4796 [72] determines whether the video media stream is a main video or a screenshare video. + +vadv (0x0002) "Voice activity detected video": + The MP shall detect voice activity on audio streams. The MP shall forward the main video received from the active speaker (i.e. from the media sender from which an audio stream is received where voice activity is currently detected) to all other conference participant. If several video streams are simulcasted from the active speaker, the MP should select for each other conference participant the simulcast format that matches the configured encoding and resolution of the main video stream towards that conference participant to avoid transcoding. The MP should forward the main video of the previous speaker (i.e. received from the media sender from which an audio stream was received where the most recent past voice activity has been detected) to the active speaker (i.e. towards the media receiver associated with the media sender from which an audio stream is received where voice activity is currently detected). If several video streams are simulcasted from the previous speaker, the MP should select the simulcast format + +that matches the configured encoding and resolution of the main video stream towards the active speaker to avoid transcoding. The MP should forward received thumbnail video streams from the most recent previous speaker(s) (i.e. from the media sender(s) from which audio stream(s) was/were received where the most recent past voice activities have been detected). If several video streams are simulcasted from a previous speaker, the MP should select for each other conference participant the simulcast format that matches the configured encoding and resolution of a thumbnail video stream towards that conference participant to avoid transcoding. In order to avoid a too frequent switching of video images, the MP should wait for a short period when detecting voice activity from a new source before switching the video image. If the MP receives RTCP feedback about increased packet loss from a media receiver, the MP should reduce the number of video streams sent towards that media receiver and select only video streams with lower resolution (e.g. thumbnail video streams). The MP should select video streams received from the most recent speaker(s) (i.e. from the media sender(s) from which audio stream(s) are received where the most recent voice activities are or have been detected). + +vada (0x0003) "Voice activity detected audio": + +The MP shall detect voice activity on audio streams. The MP should forward the received audio stream of the active speaker (i.e. the audio stream where voice activity is detected) to all other conference participants. If simulcasted audio streams are received from the active speaker, the MP should select for each other conference participant an audio encoding among the received audio simulcast formats that is supported at the termination towards that participant to avoid transcoding. + +ma (0x0004) "Mix audio": + +The MP shall mix all the received audio streams from all other conference participants in the context and send the resulting audio stream(s) to each conference participant. If two audio streams were reserved towards a conference participant, the MP may distribute the received audio stream from each other conference participant in a specific way to render a stereo impression. + +bfcpa (0x0005) "BFCP audio": + +If the MP receives BFCP messages, the MP shall select received audio streams to forward or mix based on these BFCP messages. + +bfcpv (0x0006) "BFCP video": + +If the MP receives BFCP messages, the MP shall select received video streams to forward or mix based on these BFCP messages. + +bfcps (0x0007) "BFCP screenshot": + +If the MP receives BFCP messages, the MP shall select received screenshot streams to forward or mix based on these BFCP messages. + +| | | +|-------------------------|------------------| +| Default: | None | +| Defined in: | ContextAttribute | +| Characteristics: | Read/Write | + +### C.2.3 Events + +None. + +### C.2.4 Signals + +None. + +### C.2.5 Statistics + +None. + +### C.2.6 Error Codes + +None. + +### C.2.7 Procedures + +To enable the Multi-party Multimedia Conference Media Handling functionality, the MC: + +- a) shall reserve a context and indicate the applicable MMCMH policies via the *mmcmhp* property, including at least the "mmcmhbp" value; +- b) for each conference participant, shall allocate a termination within that context and place all streams towards/from that participant within that termination; and +- c) for each media stream: + - shall indicate the media type for each stream; + - may indicate the video media type via the "a=content" SDP attribute (defined in IETF RFC 4796 [72]) in the local descriptor and the remote descriptor; + - may provide the "a=simulcast" attribute (defined in IETF RFC 8853 [73]), and the corresponding "a=rid" attributes (defined in IETF RFC 8851 [74]) with the "pt" parameter defining the simulcast stream identification in the local descriptor and the remote descriptor; and + - may provide the "a=rtcp-fb" line (see IETF RFC 4585 [40]) with the "pause" CCM parameter (defined in IETF RFC 5104 [71]), the "nowait" pause attribute and the "config" pause attribute (defined in IETF RFC 7728 [75]) in the local descriptor and the remote descriptor and the "*Autonomous Response (rempr/ar)*" and the "*Autonomous Request (rempr/aq)*" properties defined in ITU-T Recommendation H.248.98 [76] in the LocalControl descriptor. + +NOTE: The SDP "a=rid" attribute lines with a "pt" parameter define the simulcast stream identifications within a single media description. + +Upon reception of the *mmcmhp* property, the MP shall execute the policies defined for the received values. + +![Diagram of MMCMH switching showing a central Media Point (MP) with 'Selective stream forwarding'. Four terminations (A, B, C, D) are connected to the MP. Termination A is the active speaker (green icons), Termination C is the previous speaker (blue icons), Termination B is a participant (red icons), and Termination D is a participant (pink icons). Arrows show stream forwarding: from A to C (main video), from C to A (main video), from C to B (thumbnail video), and from C to D (thumbnail video). Stream IDs 1-5 are shown at each termination, with colors indicating different stream types: 1 (Audio), 2 (Main Video), 3 (Slides), 4 (Thumbnail), 5 (Thumbnail).](e2245b4865907ad1259fd155f4beb6cf_img.jpg) + +**Termination A {** + Stream 1 [(Audio), Stream Mode (SendRecv)] + Stream 2 [(Video), Stream Mode (SendRecv), + (a=content:main), (a=rid:0 send pt=pt3), + (a=rid:1 send pt=pt4), (a=rid:2 recv pt=pt3), + (a=simulcast: send 0;1 recv 2)] + Stream 3 [(Video), (a=content:slides)] + Stream 4 [(Video), Stream Mode (SendOnly)] + Stream 5 [(Video), Stream Mode (SendOnly)] } + +Remote: stream 2      Local: stream 2, 4, 5 + +**Termination B {** + Stream 1 [(Audio), Stream Mode (SendRecv)] + Stream 2 [(Video), Stream Mode (SendRecv), (a=content:main), + (a=rid:3 send pt=pt3), (a=rid:4 send pt=pt4), (a=rid:5 recv pt=pt3), + (a=simulcast: send 3;4 recv 5)] + Stream 3 [(Video), (a=content:slides)] + Stream 4 [(Video), Stream Mode (SendOnly)] } + +Remote: stream 2      Local: stream 2, 4 + +**Context C [ mmcmh = + "mmcmhbp", "vadV" ]** + +**Termination C {** + Stream 1 [(Audio), Stream Mode (SendRecv)] + Stream 2 [(Video), Stream Mode (SendRecv), + (a=content:main), (a=rid:1 send pt=pt3), + (a=rid:2 send pt=pt4), (a=rid:4 recv pt=pt3), + (a=simulcast: send 1;2 recv 4)] + Stream 3 [(Video), (a=content:slides)] + Stream 4 [(Video), Stream Mode (SendOnly)] + Stream 5 [(Video), Stream Mode (SendOnly)] } + +Remote: stream 2      Local: stream 2, 4, 5 + +**Termination D {** + Stream 1 [(Audio), Stream Mode (SendRecv)] + Stream 2 [(Video), Stream Mode (SendRecv), (a=content:main), + (a=rid:1 send pt=pt3), (a=rid:2 send pt=pt4), (a=rid:3 recv pt=pt3), + (a=simulcast: send 1;2 recv 3)] + Stream 3 [(Video), (a=content:slides)] + Stream 4 [(Video), Stream Mode (SendOnly)] + Stream 5 [(Video), Stream Mode (SendOnly)] } + +Remote: stream 2      Local: stream 2, 4, 5 + +Diagram of MMCMH switching showing a central Media Point (MP) with 'Selective stream forwarding'. Four terminations (A, B, C, D) are connected to the MP. Termination A is the active speaker (green icons), Termination C is the previous speaker (blue icons), Termination B is a participant (red icons), and Termination D is a participant (pink icons). Arrows show stream forwarding: from A to C (main video), from C to A (main video), from C to B (thumbnail video), and from C to D (thumbnail video). Stream IDs 1-5 are shown at each termination, with colors indicating different stream types: 1 (Audio), 2 (Main Video), 3 (Slides), 4 (Thumbnail), 5 (Thumbnail). + +Figure C.2.7.1: Example of MMCMH switching + +Figure C.2.7.1 shows an example of MMCMH switching where video media flows with different StreamIDs can be interconnected. The context level *mmcmhbp* property is set to "mmcmhbp, vadV". Value "vadV" indicates that the MP shall detect voice activity on the incoming audio streams. The MP shall forward the main video received from the active speaker (i.e. from the media sender from which the audio stream is received where voice activity is currently detected) to all other conference participant. The MP should forward the main video of the previous speaker (i.e. received from the media sender from which an audio stream was received where the most recent past voice activity has been detected) to the active speaker (i.e. towards the media receiver associated with the media sender from which an audio stream is received where voice activity is currently detected). The MP should forward received thumbnail video streams from the most recent previous speaker(s) (i.e. from the media sender(s) from which audio stream(s) was/were received where the most recent past voice activities have been detected). The MP should select video streams received from the most recent speaker(s) (i.e. from the media sender(s) from which audio stream(s) are received where the most recent voice activities are or have been detected). + +Stream ID = 1 is an audio stream whose volume level on each termination is being monitored. Main video stream Stream ID = 2 is configured with a simulcast property on each termination: two simulcast RTP video streams with "recv" property and one RTP video stream with "send" property. Stream ID = 3 is a screenshare video stream. StreamID =4 and StreamID = 5 are thumbnail video streams with the *StreamMode* property set to "SendOnly". On termination B only one thumbnail video stream StreamID =4 can be sent. Termination A is the active speaker. Termination C was the previous speaker. As the *mmcmhbp* property is set to "mmcmhbp, vadV", the received incoming videos are sent as outgoing videos according to the figure C.2.7.1. Local image shows the simulcast streams of main video: one video stream in high resolution and the other video stream in low resolution (thumbnail-sized simulcast format of the main video) received by the MP on StreamID = 2 and the remote image shows the video streams sent to each user: main video stream of active speaker in high resolution on StreamID = 2, and thumbnail videos of the other participants on StreamID =4 and StreamID = 5. Active speaker A will receive the main video of the previous speaker C in high resolution on StreamID = 2. On termination B only the thumbnail video from the previous speaker C is sent. + +# Annex D (informative): Change history + +| Date | TSG # | TSG Doc. | CR | R ev | Subject/Comment | New | +|---------|-------|-----------|------|------|-----------------------------------------------------------------------------------------|--------| +| 06-2007 | CT#36 | CP-070336 | | | V7.0.0 approved in CT#36 | 7.0.0 | +| 09-2007 | CT#37 | CP-070539 | 0001 | 2 | Alignment of stage 3 to proposed stage 2 changes for Audio Record and Multimedia Record | 7.1.0 | +| 09-2007 | CT#37 | CP-070539 | 0002 | 1 | Completion of formats and codes | 7.1.0 | +| 09-2007 | CT#37 | CP-070539 | 0003 | 1 | Corrections to Stage 3 Profile | 7.1.0 | +| 09-2007 | CT#37 | CP-070539 | 0004 | 1 | Editorial corrections | 7.1.0 | +| 12-2007 | CT#38 | CP-070745 | 0005 | 1 | Properties returned in commands | 7.2.0 | +| 12-2007 | CT#38 | CP-070745 | 0007 | | Add the tone generator package | 7.2.0 | +| 12-2007 | CT#38 | CP-070745 | 0008 | 1 | Align parameters for configure remote IMS resources | 7.2.0 | +| 12-2007 | CT#38 | CP-070745 | 0009 | 1 | Amend iterations parameter in start TTS procedure | 7.2.0 | +| 12-2007 | CT#38 | CP-070745 | 0010 | 1 | Amendment of the ASR procedure | 7.2.0 | +| 12-2007 | CT#38 | CP-070745 | 0011 | 1 | Clean-up of hanging contexts and terminations | 7.2.0 | +| 12-2007 | CT#38 | CP-070745 | 0012 | 1 | Correct the usage information of the recording package | 7.2.0 | +| 12-2007 | CT#38 | CP-070745 | 0014 | 1 | Implementation of multiple signals played simultaneously | 7.2.0 | +| 12-2007 | CT#38 | CP-070745 | 0015 | 1 | Align the profile with stage 2 | 7.2.0 | +| 03-2008 | CT#39 | CP-080017 | 0016 | | Alignment of IMS resources procedures' title | 7.3.0 | +| 03-2008 | CT#39 | CP-080017 | 0018 | 1 | Amend the notify completion table | 7.3.0 | +| 03-2008 | CT#39 | CP-080021 | 0017 | 1 | Mandatory use termination heartbeat | 8.0.0 | +| 06-2008 | CT#40 | CP-080263 | 0019 | | Usage of H.248.45 MGC Information Package | 8.1.0 | +| 06-2008 | CT#40 | CP-080263 | 0022 | 1 | Alignment of 3GPP Mp Codec Requirements | 8.1.0 | +| 06-2008 | CT#40 | CP-080263 | 0023 | 2 | Introduction of stage 3 procedure for Messaging Conference | 8.1.0 | +| 06-2008 | CT#40 | CP-080273 | 0021 | 1 | Alignment of SDP usage | 8.1.0 | +| 09-2008 | CT#41 | CP-080465 | 0025 | 1 | Alignment of Supported Transports | 8.2.0 | +| 09-2008 | CT#41 | CP-080465 | 0026 | 2 | Floor Control Procedures, Stage 3 | 8.2.0 | +| 09-2008 | CT#41 | CP-080465 | 0027 | | Message Conference Procedure for Stage 3 | 8.2.0 | +| 12-2008 | CT#42 | CP-080694 | 0028 | 3 | Update stage 3 profile for Message conference | 8.3.0 | +| | | | 0029 | 1 | Update stage 3 profile for Floor control | | +| | | | 0030 | 1 | Alignment of Audit Value Procedure | | +| | | | 0032 | | Remove Editor's Note on MSRP Session Identity | | +| | | | 0033 | | Remove Editor's Note on Draft Version Indication | | +| 03-2009 | CT#43 | CP-090040 | 0034 | 2 | Alignment of Audit Value Procedure | 8.4.0 | +| | | | 0035 | 1 | Modification of Reference for eMp | | +| 03-2009 | | | | | CR 0034 was removed since it was Rel-7 only | 8.4.1 | +| 2009-12 | - | - | - | - | Update to Rel-9 version (MCC) | 9.0.0 | +| 2011-03 | CT#51 | CP-110275 | 0040 | 10 | ECN Support in Mp Interface | 10.0.0 | +| | | CP-110058 | 0041 | 1 | Handling of rtcp-fb SDP attribute and SDP attribute for RTCP APP feedback messages | | +| 2011-06 | CT#52 | CP-110368 | 0042 | 1 | ECN Failure improvements | 10.1.0 | +| | | CP-110368 | 0044 | 1 | Alignment of 3GPP profiles with SG16 ECN package definition | | +| 2011-12 | CT#54 | CP-110776 | 0048 | | Missing ASN.1 encoding of H.248.69 packages | 10.2.0 | +| | | CP-110798 | 0045 | | Explicit Congestion Notification | | +| | | CP-110796 | 0049 | | Missing ASN.1 encoding of mandatory and optional package tables | | +| | | CP-110789 | 0050 | 1 | ECN Improvements | | +| 2012-03 | CT#55 | CP-120015 | 0053 | | Missing Floor control signalling package ASN.1 encoding | 10.3.0 | +| 2012-06 | CT#56 | CP-120226 | 0054 | 1 | Reference update: draft-ietf-avtcore-ecn-for-rtp | 10.4.0 | +| 2012-09 | CT#57 | CP-120478 | 0055 | 3 | Support of Multimedia Priority Service (MPS) over Mp Interface – Stage 3 | 11.0.0 | +| 2012-12 | CT#58 | CP-120723 | 0061 | - | Mp interface updates of ECN Support Package | 11.1.0 | +| 2013-03 | CT#59 | CP-130013 | 0067 | 1 | Support of RTCP-FB for MTSI | 11.2.0 | +| 2013-06 | CT#60 | CP-130294 | 0063 | 2 | ECN relying reference change | 11.3.0 | +| 2013-09 | CT#61 | CP-130452 | 0068 | 3 | Introduction of support for Coordination of Video Orientation (CVO) | 12.0.0 | +| | | CP-130471 | 0069 | 3 | Introduction of support for Generic Image Attribute/signalling of image size | | +| 2013-12 | CT#62 | CP-130636 | 0070 | 1 | No indication of generic image attributes in Mp | 12.1.0 | +| 2014-06 | CT#64 | CP-140248 | 0071 | 2 | ICE support for MRF in Mp interface | 12.2.0 | +| 2014-09 | CT#65 | CP-140520 | 0072 | 1 | MRFP Capability Change | 12.3.0 | +| 2014-12 | CT#66 | CP-140788 | 0075 | 1 | Adding support for EVS codec | 12.4.0 | +| 2014-12 | CT#66 | CP-140786 | 0076 | 1 | E2e media security procedures for TCP based media (MSRP, BFCP) using TLS and KMS | 12.4.0 | +| 2015-03 | CT#67 | CP-150026 | 0077 | 2 | Support of CLUE bearer level signalling | 12.5.0 | +| | | CP-150026 | 0078 | 2 | CLUE carriage over Mp interface | | +| 2015-06 | CT#68 | CP-150255 | 0079 | 1 | Updates on IMS Telepresence | 12.6.0 | +| 2015-12 | CT#70 | CP-150753 | 0082 | 2 | Reference update: IETF drafts | 12.7.0 | +| 2015-12 | CT#70 | CP-150783 | 0081 | 4 | Support for Video Enhancements by Region-of-Interest Information Signalling | 13.0.0 | +| 2016-03 | CT#71 | CP-160048 | 0083 | - | Removal of references to TS 26.235 | 13.1.0 | + +| | | | | | | | +|---------|--------|-----------|------|---|-----------------------------------------------------------------------|--------| +| 2016-03 | CT#71 | CP-160034 | 0084 | 1 | Support of enhanced bandwidth negotiation mechanism for MTSI sessions | 13.1.0 | +| 2016-03 | CT#71 | CP-160021 | 0085 | 2 | Mp stage 3 to support SDP Capability Negotiation | 13.1.0 | +| 2016-06 | CT#72 | CP-160229 | 0086 | - | Clarifications related to the rate adaptation for media endpoints | 13.2.0 | +| 2017-03 | CT#75 | CP-170023 | 0087 | - | RFC 4572 obsoleted by draft-ietf-mmusic-4572-update | 13.3.0 | +| 2017-03 | CT#75 | CP-170051 | 0088 | 1 | RTCP Codec Control Commands and Indications | 14.0.0 | +| 2017-03 | CT#75 | CP-170051 | 0089 | 1 | Support of multi-party multimedia conference using simulcast | 14.0.0 | +| 2017-06 | CT#76 | CP-171015 | 0091 | - | Reference update: RFC 8122 | 14.1.0 | +| 2017-06 | CT#76 | CP-171037 | 0092 | - | Support of "Compact Concurrent Codec Negotiation and Capabilities" | 14.1.0 | +| 2017-06 | CT#76 | CP-171037 | 0093 | - | Reference update: ITU-T H.248.19 | 14.1.0 | +| 2017-06 | CT#76 | CP-171037 | 0094 | 2 | New H.248 MMCMH package | 14.1.0 | +| 2017-06 | CT#76 | CP-171014 | 0097 | - | Reference update: draft-ietf-mmusic-sctp-sdp | 14.1.0 | +| 2017-06 | CT#76 | CP-171037 | 0098 | - | Reference update: MMCMH related IETF drafts | 14.1.0 | +| 2018-06 | CT#80 | | | | Update to Rel-15 version (MCC) | 15.0.0 | +| 2019-06 | CT#84 | CP-191053 | 0099 | 3 | Mp interface enhancements to support DBI | 16.0.0 | +| 2020-12 | CT#90e | CP-203024 | 0104 | - | Update on draft references | 16.1.0 | +| 2021-03 | CT#91e | CP-210064 | 0109 | - | Reference update: RFC 8841 and RFC 8864 | 16.2.0 | +| 2021-03 | CT#91e | CP-210067 | 0112 | - | Reference update: RFC 8851 and RFC 8853 | 16.2.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29334/07b17a620c75522d53916a11e12d1bff_img.jpg b/marked/Rel-16/29_series/29334/07b17a620c75522d53916a11e12d1bff_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..bbfb3c2d37b2a1b1bfd4e094edfcb867935307d5 --- /dev/null +++ b/marked/Rel-16/29_series/29334/07b17a620c75522d53916a11e12d1bff_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9e93c96f988851a371a48dbb4a9ecf8e6103ab2e9b35016ce4008450ab6ea1de +size 58421 diff --git a/marked/Rel-16/29_series/29334/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-16/29_series/29334/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..bd218ff2e9a51426300af9c2a8928dff34faa856 --- /dev/null +++ b/marked/Rel-16/29_series/29334/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0dedbb210a8cbd8105ea585c016f8798489cbbea4b64e526a59558f4cb77fea0 +size 10081 diff --git a/marked/Rel-16/29_series/29334/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-16/29_series/29334/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..40f6aa6c179d12ae496ab55e858a3945c71a758b --- /dev/null +++ b/marked/Rel-16/29_series/29334/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:21faa0f86321170da9967936dea6fd3d5de928c7beb4e478eabcfa83996298aa +size 6427 diff --git a/marked/Rel-16/29_series/29334/c9d8a18a6137ad054b841d7a614afb48_img.jpg b/marked/Rel-16/29_series/29334/c9d8a18a6137ad054b841d7a614afb48_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8d91628e1b8b968e5158e62af8135d0d5a580d69 --- /dev/null +++ b/marked/Rel-16/29_series/29334/c9d8a18a6137ad054b841d7a614afb48_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c4ba8cb00de23b30a0a670d168ad50072269d3b82fab377122d8e77b3ee1b5f1 +size 29653 diff --git a/marked/Rel-16/29_series/29334/d0abac95583b52a3b35f74a215567334_img.jpg b/marked/Rel-16/29_series/29334/d0abac95583b52a3b35f74a215567334_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..68c5201125f480617a2ef87fc78010c06c98c7f5 --- /dev/null +++ b/marked/Rel-16/29_series/29334/d0abac95583b52a3b35f74a215567334_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1d6895cfe1cee4a0e06e536f4cf905a0000e6e9b87756d22d3022543a37f60e4 +size 64609 diff --git a/marked/Rel-16/29_series/29334/raw.md b/marked/Rel-16/29_series/29334/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..16d4d4ec3c018572d24789468ed42881c7b59ecf --- /dev/null +++ b/marked/Rel-16/29_series/29334/raw.md @@ -0,0 +1,3129 @@ + + +# 3GPP TS 29.334 V16.3.0 (2021-03) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; IMS Application Level Gateway (IMS-ALG) – IMS Access Gateway (IMS-AGW); Iq Interface; Stage 3 (Release 16)** + +![LTE Advanced Pro logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for LTE Advanced Pro, featuring the letters 'lte' in a bold, lowercase font. Above the 'e' is the text 'Advanced Pro' in a smaller font. To the right of the 'e' is a green signal icon with three bars. + +LTE Advanced Pro logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a stylized, bold font. Below the 'P' is a red signal icon with three bars. Below the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, uppercase font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +# --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2021, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTSTM is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|---------------------------------------------------------------|----| +| Foreword ..... | 6 | +| 1 Scope..... | 7 | +| 2 References..... | 8 | +| 3 Definitions, symbols and abbreviations ..... | 12 | +| 3.1 Definitions..... | 12 | +| 3.2 Symbols..... | 13 | +| 3.3 Abbreviations ..... | 13 | +| 4 Applicability..... | 14 | +| 4.1 Architecture..... | 14 | +| 5 Profile Description ..... | 14 | +| 5.1 Profile Identification ..... | 14 | +| 5.2 Summary ..... | 14 | +| 5.3 Gateway Control Protocol Version ..... | 15 | +| 5.4 Connection model ..... | 15 | +| 5.5 Context attributes ..... | 15 | +| 5.6 Terminations..... | 15 | +| 5.6.1 Termination names ..... | 15 | +| 5.6.1.1 IP Termination ..... | 15 | +| 5.6.1.1.1 ABNF Coding Overview and prose specification..... | 15 | +| 5.6.1.1.2 ASN.1 Coding Overview and prose specification ..... | 16 | +| 5.6.2 Multiplexed terminations..... | 17 | +| 5.7 Descriptors ..... | 17 | +| 5.7.1 TerminationState Descriptor ..... | 17 | +| 5.7.2 Stream Descriptor ..... | 18 | +| 5.7.2.0 General..... | 18 | +| 5.7.2.1 LocalControl Descriptor ..... | 18 | +| 5.7.3 Events descriptor ..... | 19 | +| 5.7.4 EventBuffer descriptor ..... | 21 | +| 5.7.5 Signals descriptor ..... | 21 | +| 5.7.6 DigitMap descriptor..... | 23 | +| 5.7.7 Statistics descriptor..... | 23 | +| 5.7.8 ObservedEvents descriptor ..... | 23 | +| 5.7.9 Topology descriptor..... | 23 | +| 5.7.10 Error descriptor..... | 24 | +| 5.8 Command API..... | 26 | +| 5.8.1 Add ..... | 26 | +| 5.8.2 Modify ..... | 26 | +| 5.8.3 Subtract..... | 27 | +| 5.8.4 Move..... | 27 | +| 5.8.5 AuditValue ..... | 27 | +| 5.8.6 AuditCapabilities ..... | 27 | +| 5.8.7 Notify..... | 28 | +| 5.8.8 ServiceChange..... | 28 | +| 5.8.9 Manipulating and auditing context attributes ..... | 30 | +| 5.9 Generic command syntax and encoding..... | 30 | +| 5.10 Transactions ..... | 30 | +| 5.11 Messages ..... | 31 | +| 5.12 Transport ..... | 31 | +| 5.13 Security..... | 32 | +| 5.14 Packages..... | 32 | +| 5.14.1 Mandatory Packages..... | 32 | +| 5.14.2 Optional Packages ..... | 34 | +| 5.14.3 Package usage information..... | 35 | +| 5.14.3.1 Generic (g) ..... | 35 | + +| | | | +|-----------|---------------------------------------------------------------------------|----| +| 5.14.3.2 | Base root (root) ..... | 36 | +| 5.14.3.3 | Differentiated Services (ds) ..... | 37 | +| 5.14.3.4 | Gate Management (gm) ..... | 37 | +| 5.14.3.5 | Traffic management (tman) ..... | 38 | +| 5.14.3.6 | Inactivity Timer (it) ..... | 39 | +| 5.14.3.7 | IP Domain Connection (ipdc) ..... | 39 | +| 5.14.3.8 | Media Gateway Overload Control Package (ocp) ..... | 40 | +| 5.14.3.9 | Hanging Termination Detection (hangterm) ..... | 40 | +| 5.14.3.10 | Media Gateway Resource Congestion handling Package (chp) ..... | 41 | +| 5.14.3.11 | IP Realm Availability (ipra) ..... | 41 | +| 5.14.3.12 | IP NAPT Traversal (ipnapt) ..... | 42 | +| 5.14.3.13 | RTCP Handling Package (rtcph) ..... | 42 | +| 5.14.3.14 | Application Data Inactivity Detection (adid) ..... | 43 | +| 5.14.3.15 | Explicit Congestion Notification for RTP-over-UDP Support (ecnrous) ..... | 43 | +| 5.14.3.16 | MG Act-as STUN Server (mgastuns) ..... | 45 | +| 5.14.3.17 | Originate STUN Continuity Check (ostuncc) ..... | 45 | +| 5.14.3.18 | TCP basic connection control (tcpbcc) ..... | 46 | +| 5.14.3.19 | TLS basic session control (tlsbsc) ..... | 47 | +| 5.14.3.20 | Stream endpoint interlinkage (seplink) ..... | 47 | +| 5.14.3.21 | MG located Bearer Level ALG (mgbalg) ..... | 48 | +| 5.14.3.22 | STUN Consent Freshness (stnconfres) ..... | 48 | +| 5.14.3.23 | Media Grouping (mgroup) ..... | 49 | +| 5.14.3.24 | SCTP basic connection control package (sctpbcc) ..... | 50 | +| 5.14.3.25 | SCTP Re-configuration Stream Reset (sctpreset) ..... | 51 | +| 5.15 | Mandatory support of SDP and Annex C information elements ..... | 53 | +| 5.16 | Optional support of SDP and Annex C information elements ..... | 55 | +| 5.17 | Procedures ..... | 59 | +| 5.17.1 | Formats and Codes ..... | 59 | +| 5.17.2 | Call Related Procedures ..... | 64 | +| 5.17.2.1 | General ..... | 64 | +| 5.17.2.2 | Reserve AGW Connection Point ..... | 64 | +| 5.17.2.3 | Configure AGW Connection Point ..... | 68 | +| 5.17.2.4 | Reserve and Configure AGW Connection Point ..... | 73 | +| 5.17.2.5 | Release AGW Termination ..... | 78 | +| 5.17.2.6 | Termination Heartbeat Indication ..... | 79 | +| 5.17.2.7 | IP Bearer Released ..... | 79 | +| 5.17.2.8 | Media Inactivity Notification ..... | 79 | +| 5.17.2.9 | Change Through Connection ..... | 80 | +| 5.17.2.10 | Change Flow Direction ..... | 80 | +| 5.17.2.11 | ECN Failure Indication ..... | 81 | +| 5.17.2.12 | ICE Connectivity Check Result Notification ..... | 81 | +| 5.17.2.13 | ICE New Peer Reflexive Candidate Notification ..... | 82 | +| 5.17.2.14 | Notify TCP connection establishment Failure Indication ..... | 82 | +| 5.17.2.15 | Notify (D)TLS session establishment Failure Indication ..... | 83 | +| 5.17.2.16 | STUN Consent Freshness Test Failure Notification ..... | 83 | +| 5.17.2.17 | Notify SCTP Stream Reset ..... | 84 | +| 5.17.2.18 | Notify SCTP Stream Reset Result ..... | 84 | +| 5.17.3 | Non-Call Related Procedures ..... | 84 | +| 5.17.3.1 | General ..... | 84 | +| 5.17.3.2 | IMS-AGW Out Of Service ..... | 85 | +| 5.17.3.3 | IMS-AGW Communication Up ..... | 86 | +| 5.17.3.4 | IMS-AGW Restoration ..... | 86 | +| 5.17.3.5 | IMS-AGW Register ..... | 87 | +| 5.17.3.6 | IMS-AGW Re-Register ..... | 87 | +| 5.17.3.7 | IMS-ALG Ordered Re-register ..... | 88 | +| 5.17.3.8 | IMS-ALG Restoration ..... | 88 | +| 5.17.3.9 | IMS-ALG Out of Service ..... | 89 | +| 5.17.3.10 | Audit Value ..... | 89 | +| 5.17.3.11 | Command Rejected ..... | 91 | +| 5.17.3.12 | AGW Capability Change ..... | 91 | +| 5.17.3.13 | IMS-AGW Resource Congestion Handling – Activate ..... | 91 | +| 5.17.3.14 | IMS-AGW Resource Congestion Handling – Indication ..... | 92 | + +5.17.3.15 Inactivity Timeout – Activation..... 92 +5.17.3.16 Inactivity Timeout – Indication ..... 93 +5.17.3.17 Realm Availability Change – Activation..... 93 +5.17.3.18 Realm Availability Change – Indication ..... 93 +5.17.3.19 Termination Out Of Service ..... 94 +**Annex A (informative): Change history..... 95** + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# 1 Scope + +The present document describes the protocol to be used on the IMS Application Level Gateway (ALG) – IMS Access Gateway (IMS-AGW) interface. The basis for this protocol is the H.248 protocol as specified in ITU-T. The IMS architecture is described in 3GPP TS 23.228 [2]. The underlying reference model and stage 2 information is described in Annex G of 3GPP TS 23.228 [2] and in 3GPP TS 23.334 [23]. + +This specification describes the application of H.248 on the Iq interface (see Figure 1). Required extensions use the H.248 standard extension mechanism. In addition certain aspects of the base protocol H.248 are not needed for this interface and thus excluded by this profile. + +![Figure 1: Reference model for IMS access. The diagram shows a UE connected to an IP-CAN, which is connected to a P-CSCF via a Gm interface. The P-CSCF contains an IMS-ALG. The IMS-ALG is connected to an IMS Access Gateway via an Iq interface. The IMS Access Gateway contains a NAT. A dashed box labeled 'Scope of this specification.' is around the IMS-ALG and the Iq interface. Media flows from the IP-CAN through the IMS Access Gateway.](c9d8a18a6137ad054b841d7a614afb48_img.jpg) + +``` +graph LR; UE[UE] --- IP_CAN((IP-CAN)); IP_CAN --- Media[Media]; Media --- IMS_AGW[IMS Access Gateway]; IMS_AGW --- NAT[NAT]; IMS_AGW --- Iq[Iq]; Iq --- IMS_ALG[IMS-ALG]; IMS_ALG --- P_CSCF[P-CSCF]; IP_CAN -.-> Gm[Gm]; Gm -.-> P_CSCF; subgraph Scope_of_this_specification [Scope of this specification.]; IMS_ALG; Iq; end +``` + +Figure 1: Reference model for IMS access. The diagram shows a UE connected to an IP-CAN, which is connected to a P-CSCF via a Gm interface. The P-CSCF contains an IMS-ALG. The IMS-ALG is connected to an IMS Access Gateway via an Iq interface. The IMS Access Gateway contains a NAT. A dashed box labeled 'Scope of this specification.' is around the IMS-ALG and the Iq interface. Media flows from the IP-CAN through the IMS Access Gateway. + +**Figure 1: Reference model for IMS access** + +The reference model for the IMS-ALG and the IMS-AGW supporting the ATCF/ATGW function is shown in Figure 1a below. + +![Figure 1a: Reference model for IMS-ALG/IMS-AGW with ATCF/ATGW function. The diagram shows a UE connected to CS and PS access networks. The CS access connects to an MSC Server and a CS-MGW. The PS access connects to a PS Access domain. Media from both domains is transferred via a PS-to-CS Access Transfer function to an IMS-AGW (ATGW) which contains a NAT. The IMS-AGW connects to a P-CSCF (containing IMS-ALG (ATCF)) via an 'Iq' interface. The P-CSCF connects to an IMS I/S-CSCF SCC AS via 'Mw/Mx' interfaces. A dashed box labeled 'Scope of this specification.' encompasses the IMS-AGW (ATGW) and the P-CSCF (IMS-ALG (ATCF)).](d0abac95583b52a3b35f74a215567334_img.jpg) + +Figure 1a: Reference model for IMS-ALG/IMS-AGW with ATCF/ATGW function. The diagram shows a UE connected to CS and PS access networks. The CS access connects to an MSC Server and a CS-MGW. The PS access connects to a PS Access domain. Media from both domains is transferred via a PS-to-CS Access Transfer function to an IMS-AGW (ATGW) which contains a NAT. The IMS-AGW connects to a P-CSCF (containing IMS-ALG (ATCF)) via an 'Iq' interface. The P-CSCF connects to an IMS I/S-CSCF SCC AS via 'Mw/Mx' interfaces. A dashed box labeled 'Scope of this specification.' encompasses the IMS-AGW (ATGW) and the P-CSCF (IMS-ALG (ATCF)). + +Figure 1a: Reference model for IMS-ALG/IMS-AGW with ATCF/ATGW function + +See 3GPP TS 23.237 [38] clause 5.2 for a comprehensive description of the reference model. + +The reference model for the P-CSCF enhanced for WebRTC (eP-CSCF) and the IMS-AGW enhanced for WebRTC (eIMS-AGW) to support WebRTC client access to IMS is shown in Figure 1b as below, see 3GPP TS 23.228 [2] Annex U for a comprehensive description of the reference model. + +![Figure 1b: Reference Architecture for eP-CSCF/eIMS-AGW supporting WebRTC access to IMS. The diagram shows a UE connected to a WIC. The WIC connects to a NAT, which connects to an IP-CAN, which connects to a PCEF. The PCEF connects to a WWSF via 'W1'. The WWSF connects to a WAF via 'W4'. The WAF connects to an eP-CSCF (containing IMS-ALG) via 'W5'. The eP-CSCF connects to an I/S-CSCF via 'Mw'. The eP-CSCF also connects to an eIMS-AGW via an 'Iq' interface. The UE connects to the eIMS-AGW via 'W3'. There are dashed lines labeled 'Rx' and 'Gx' between the PCEF and the eP-CSCF, and a dashed box labeled 'H/V-PCRF' between the PCEF and the eIMS-AGW.](07b17a620c75522d53916a11e12d1bff_img.jpg) + +Figure 1b: Reference Architecture for eP-CSCF/eIMS-AGW supporting WebRTC access to IMS. The diagram shows a UE connected to a WIC. The WIC connects to a NAT, which connects to an IP-CAN, which connects to a PCEF. The PCEF connects to a WWSF via 'W1'. The WWSF connects to a WAF via 'W4'. The WAF connects to an eP-CSCF (containing IMS-ALG) via 'W5'. The eP-CSCF connects to an I/S-CSCF via 'Mw'. The eP-CSCF also connects to an eIMS-AGW via an 'Iq' interface. The UE connects to the eIMS-AGW via 'W3'. There are dashed lines labeled 'Rx' and 'Gx' between the PCEF and the eP-CSCF, and a dashed box labeled 'H/V-PCRF' between the PCEF and the eIMS-AGW. + +Figure 1b: Reference Architecture for eP-CSCF/eIMS-AGW supporting WebRTC access to IMS + +NOTE: The presence of dashed elements in the figure depends on the configuration. + PCC functional elements are present only for EPC access with QoS. + The corresponding PCC elements for fixed access are also optionally supported but not shown. + The NAT in figure 1b is meant for non-cellular access to IMS. + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.228: "IP Multimedia Subsystem (IMS); Stage 2". +- [3] ETSI TS 183 018 V3.5.1 (2009-07): "Telecommunications and Internet converged Services and Protocols for Advanced Networking (TISPAN); Resource and Admission Control: H.248 Profile Version 3 for controlling Border Gateway Functions (BGF) in the Resource and Admission Control Subsystem (RACS); Protocol specification". +- [4] ITU-T Recommendation H.248.37 (06/2008): "Gateway control protocol: IP NAT traversal package". +- [5] ITU-T Recommendation H.248.57 (10/2014): "Gateway control protocol: RTP Control Protocol Package". +- [6] ITU-T Recommendation H.248.43 (06/2008): "Gateway control protocol: Gate Management and Gate Control packages". +- [7] ITU-T Recommendation H.248.53 (03/2009): "Gateway control protocol: Traffic management packages". +- [8] ITU-T Recommendation H.248.41 Amendment 1 (06/2008): "Gateway control protocol: IP domain connection package: IP Realm Availability Package". +- [9] ITU-T Recommendation H.248.36 (09/2005): "Gateway control protocol: Hanging Termination Detection package". +- [10] ITU-T Recommendation H.248.1 (05/2002): "Gateway Control Protocol: Version 2" including the Corrigendum1 for Version 2 (03/04). +- [11] ITU-T Recommendation H.248.14 (03/2009): "Gateway control protocol: Inactivity timer package". +- [12] ITU-T Recommendation H.248.52 (06/2008): "Gateway control protocol: QoS support packages". +- [13] ITU-T Recommendation H.248.11 (11/2002): "Gateway control protocol: Media gateway overload control package". +Inclusive Corrigendum 1 (06/2008) to H.248.11 " Gateway control protocol: Media gateway overload control package: Clarifying MG-overload event relationship to ADD commands". +- [14] ITU-T Recommendation H.248.10 (07/2001): "Media gateway resource congestion handling package". +- [15] IETF RFC 5234 (2008): "Augmented BNF for Syntax Specifications: ABNF". +- [16] IETF RFC 4960 (2007): "Stream control transmission protocol". +- [17] IETF RFC 4566 (2006): "SDP: Session Description Protocol". +- [18] IETF RFC 4975 (2007): "The Message Session Relay Protocol (MSRP)". +- [19] IETF RFC 3551 (2003): "RTP Profile for Audio and Video Conferences with Minimal Control". +- [20] IETF RFC 4145 (2005): "TCP-Based Media Transport in the Session Description Protocol (SDP)". +- [21] IETF RFC 3605 (2003): "Real Time Control Protocol (RTCP) attribute in Session Description Protocol (SDP)". + +- [22] ITU-T Recommendation X.690 (11/2008): "ASN.1 encoding rules: Specification of Basic Encoding Rules (BER), Canonical Encoding Rules (CER) and Distinguished Encoding Rules (DER)". +- [23] 3GPP TS 23.334: "IMS Application Level Gateway (IMS-ALG) – IMS Access Gateway (IMS-AGW) interface: Procedures Descriptions". +- [24] ITU-T Recommendation H.248.40 (01/2007): "Gateway control protocol: Application Data Inactivity Detection package". +- [25] IETF RFC 4585 (2006): "Extended RTP Profile for Real-time Transport Control Protocol (RTCP) - Based Feedback (RTP/AVPF)". +- [26] 3GPP TS 26.114: "IP Multimedia Subsystem (IMS); Multimedia telephony; Media handling and interaction". +- [27] 3GPP TS 33.210: "Technical Specification Group Services and System Aspects;3G Security; Network Domain Security; IP Network Layer Security". +- [28] IETF RFC 3556 (2003): "Session Description Protocol (SDP) Bandwidth Modifiers for RTP Control Protocol (RTCP) Bandwidth". +- [29] IETF RFC 4568 (2006): "Session Description Protocol (SDP) Security Descriptions for Media Streams". +- [30] IETF RFC 3711 (2004): "The Secure Real-time Transport Protocol (SRTP)". +- [31] IETF RFC 5124 (2008): "Extended Secure RTP Profile for Real-time Transport Control Protocol (RTCP)-Based Feedback (RTP/SAVPF)". +- [32] IETF RFC 2216 (1997): "Network Element Service Specification Template". +- [33] Supplement 7 to ITU-T H-series Recommendations H.Sup7 (05/2008):" Gateway control protocol: Establishment procedures for the H.248 MGC-MG control association". +- [34] 3GPP TS 33.328: "IMS Media Plane Security". +- [35] Void +- [36] Void +- [37] Void +- [38] 3GPP TS 23.237: "IP Multimedia subsystem (IMS) Service Continuity; Stage 2". +- [39] 3GPP TS 22.153: "Multimedia Priority Service". +- [40] ITU-T Recommendation H.248.82 (03/2013): "Gateway control protocol: Explicit Congestion Notification Support". +- [41] IETF RFC 5285 (2008): "A General Mechanism for RTP Header Extensions". +- [42] IETF RFC 6236: "Negotiation of Generic Image Attributes in the Session Description Protocol (SDP)". +- [43] ITU-T Recommendation H.248.50 (07/2016): "Gateway control protocol: NAT traversal toolkit packages". +- [44] IETF RFC 5245: "Interactive Connectivity Establishment (ICE): A Protocol for Network Address Translator (NAT) Traversal for Offer/Answer Protocols". +- [45] 3GPP TS 24.229: "IP Multimedia Call Control Protocol based on SIP and SDP". +- [46] ITU-T Recommendation H.248.84 (07/2012): "Gateway control protocol: NAT traversal for peer-to-peer services". +- [47] ITU-T Recommendation H.248.89 (10/2014): "Gateway control protocol: TCP support packages". + +- [48] ITU-T Recommendation H.248.90 (10/2014): "Gateway control protocol: ITU-T H.248 packages for control of transport security using transport layer security (TLS)". +- [49] ITU-T Recommendation H.248.92 (10/2014): "Gateway control protocol: Stream endpoint interlinkage package". +- [50] ITU-T Recommendation H.248.93 (10/2014): "Gateway control protocol: ITU-T H.248 support for control of transport security using the datagram transport layer security (DTLS) protocol". +- [51] IETF RFC 793: "Transmission Control Protocol – DARPA Internet Program – Protocol Specification". +- [52] IETF RFC 4582: "The Binary Floor Control Protocol (BFCP)". +- [53] IETF RFC 5246: "The Transport Layer Security (TLS) Protocol Version 1.2". +- [54] IETF draft-schwarz-mmusic-sdp-for-gw-05: "SDP codepoints for gateway control". + +**Editor's Note:** The above document cannot be formally referenced until it is published as an RFC. + +- [55] IETF RFC 8122: "Connection-Oriented Media Transport over the Transport Layer Security (TLS) Protocol in the Session Description Protocol (SDP)". +- [56] ITU-T Recommendation H.248.78 (11/2015): "Gateway control protocol: Bearer-level message backhauling and application level gateway". +- [57] IETF RFC 6714: "Connection Establishment for Media Anchoring (CEMA) for the Message Session Relay Protocol (MSRP)". +- [58] IETF RFC 7675: "Session Traversal Utilities for NAT (STUN) Usage for Consent Freshness". +- [59] IETF RFC 5761: "Multiplexing RTP Data and Control Packets on a Single Port". +- [60] IETF RFC 5763: "Framework for Establishing a Secure Real-time Transport Protocol (SRTP) Security Context Using Datagram Transport Layer Security (DTLS)". +- [61] IETF RFC 5764: "Datagram Transport Layer Security (DTLS) Extension to Establish Keys for the Secure Real-time Transport Protocol (SRTP)". +- [62] IETF RFC 4573: "MIME Type Registration for RTP Payload Format for H.224". +- [63] ITU-T Recommendation H.224 (01/2005): "A real time control protocol for simplex applications using the H.221 LSD/HSD/MLP channels". +- [64] ITU-T Recommendation H.281 (11/1994): "A far end camera control protocol for videoconferences using H.224". +- [65] ITU-T Recommendation H.248.96 (11/2015): "Gateway control protocol: H.248 support for control of SCTP bearer connections". +- [66] ITU-T Recommendation H.248.97 (11/2015): "Gateway control protocol: H.248 support for control of SCTP bearer connections". +- [67] ITU-T Recommendation H.248.94 (11/2015): "Gateway control protocol: Web-based real-time communication services – H.248 protocol support and profile guidelines". +- [68] IETF RFC 8841: "Session Description Protocol (SDP) Offer/Answer Procedures for Stream Control Transmission Protocol (SCTP) over Datagram Transport Layer Security (DTLS) Transport". +- [69] IETF RFC 8864: "Negotiation Data Channels Using the Session Description Protocol (SDP)". +- [70] IETF RFC 8873: "Message Session Relay Protocol (MSRP)". +- [71] ITU-T Recommendation H.248.88 (01/2014): "Gateway control protocol: RTP topology dependent RTCP handling by ITU-T H.248 media gateways with IP terminations". + +- [72] IETF RFC 5939: "Session Description Protocol (SDP) Capability Negotiation". +- [73] ITU-T Recommendation H.248.80 (01/2014): "Gateway control protocol: Usage of the revised SDP offer/answer model with ITU-T H.248". +- [74] IETF RFC 8858: "Indicating Exclusive Support of RTP and RTP Control Protocol (RTCP) Multiplexing Using the Session Description Protocol (SDP)". +- [75] ITU-T Recommendation T.140 (02/98): "Text conversation presentation protocol". +- [76] IETF RFC 4103: "RTP Payload for Text Conversation". +- [77] IETF RFC 8865: "T.140 Real-Time Text Conversation over WebRTC Data Channels". +- [78] IETF RFC 5104: "Codec Control Messages in the RTP Audio-Visual Profile with Feedback (AVPF)". +- [79] IETF RFC 7728: "RTP Stream Pause and Resume". + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the following terms and definitions apply. + +**Address:** term used for "network address" (IP address) + +**End-to-access edge security:** media protection extending between an IMS UE and the first IMS core network node in the media path without being terminated by any intermediary node. + +**Port:** term used for "transport port" (L4 port). + +**Transcoding:** transcoding in general is the translation from one type of encoded media format to another different media format, e.g. G.711 A-law to $\mu$ -law or vice versa, G.729 to AMR with 4.75 rate. + +NOTE 1: The definition of "transcoding" is according clause 3.10 of ITU-T Recommendation V.152 [23]. + +NOTE 2: Transcoding belongs to the category of "media aware" IP-to-IP interworking. + +**Transparent Forwarding:** media gateway packet forwarding behaviour with the characteristic of Lx-PDU integrity. This is a unidirectional characteristic of an Lx-PDU flow. + +NOTE 3: The definition is according clause 3.2.10 of ITU-T Recommendation H.248.88 [71]. + +NOTE 4: The semantic covers both traffic directions when applied on H.248 Streams (due to their inherent characteristic of bidirectionality). + +**Transport Address:** term used for the combination of a *Network Address* and a *Transport Port*. + +For the purposes of the present document, the following terms and definitions as defined in 3GPP TS 23.334 [23] apply: + +**ICE lite** + +**Full ICE.** + +## 3.2 Symbols + +For the purposes of the present document, the following symbols apply: + +| | | +|----|----------------------------------------------------------------------------------------------------------| +| Iq | Interface between the IMS Application Level Gateway (ALG) (IMS-ALG) and the IMS Access Gateway (IMS-AGW) | +|----|----------------------------------------------------------------------------------------------------------| + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations defined in 3GPP TR 21.905 [1] apply, with the following additions. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|-----------|------------------------------------------------------------------------------------------| +| ABNF | Augmented Backus-Naur Form | +| ATCF | Access Transfer Control Function | +| ATGW | Access Transfer Gateway | +| B-ALG | Bearer Level Application-Level Gateway | +| BFCP | Binary Floor Control Protocol | +| CCM | Codec Control Messages | +| CVO | Coordination of Video Orientation | +| DBI | Delay Budget Information | +| DSCP | Differentiated Service Code Point | +| e2ae | End-to-Access-Edge (security model) | +| ECN | Explicit Congestion Notification | +| eIMS-AGW | IMS Access Gateway enhanced for WebRTC | +| eP-CSCF | P-CSCF enhanced for WebRTC | +| FECC | Far End Camera Control | +| FIR | Full Intra Request | +| GTT | Global Text Telephony | +| ICE | Interactive Connectivity Establishment | +| IMS-AGW | IMS Access Gateway | +| IMS-ALG | IMS Application Level Gateway | +| IP | Internet Protocol | +| LD | Local Descriptor (H.248 protocol element) | +| MG | Media Gateway | +| MGC | Media Gateway Controller | +| MPS | Multimedia Priority Service | +| MSRP | Message Session Relay Protocol | +| MTSI | Multimedia Telephony Service for IMS | +| NA | Not Applicable | +| NAPT | Network Address and Port Translation | +| NAPT-PT | NAPT and Protocol Translation | +| NAT | Network Address Translation | +| RD | Remote Descriptor (H.248 protocol element) | +| ROI | Region of Interest | +| RTCP | RTP Control Protocol | +| SCTP | Stream Control Transport Protocol | +| SDP | Session Description Protocol | +| SDPCapNeg | SDP Capability Negotiation | +| SRVCC | Single Radio Voice Call Continuity | +| STUN | Session Traversal Utilities for NAT | +| TCP | Transmission Control Protocol | +| TLS | Transport Layer Security (protocol) | +| TMMBN | Temporary Maximum Media Stream Bit Rate Notification | +| TMMBR | Temporary Maximum Media Stream Bit Rate Request | +| ToS | Type-of-Service | +| TIISPAN | Telecommunications and Internet converged Services and Protocols for Advanced Networking | +| WebRTC | Web Real Time Communication | +| WIC | WebRTC IMS Client | +| WWSF | WebRTC Web Server Function | + +# 4 Applicability + +The support of the Iq interface capability set shall be identified by the H.248 Iq profile and support of this profile shall be indicated in H.248 ServiceChange procedure (during the (re-)registration phase(s)). + +## 4.1 Architecture + +See Annex G and Annex U of 3GPP TS 23.228 [2]. + +# 5 Profile Description + +## 5.1 Profile Identification + +**Table 5.1.1: Profile Identification** + +| | | +|----------------------|-----------------| +| Profile name: | threeglq | +| Version: | 6 | + +## 5.2 Summary + +This Profile describes the minimum mandatory settings and procedures required to fulfil the requirements of the Iq interface (see 3GPP TS 23.334 [23]): + +- allocation and translation of IP addresses and port numbers (NA(P)T and NA(P)T-PT); +- opening and closing gates (i.e. packets filtering depending on "IP address / port"); +- remote NA(P)T traversal; +- policing of incoming traffic; +- QoS packet marking for outgoing traffic; +- IP realm/domain indication; +- Hanging termination detection; and +- RTCP handling; + +and when ATCF/ATGW is supported: + +- handover of bearer connections between PS and CS access networks; +- IP version interworking; and +- audio transcoding; + +and when WebRTC is supported: + +- interworking for WebRTC audio, video and optionally MSRP data between WebRTC clients and non-WebRTC user equipment; and +- optionally transparent forwarding of WebRTC bearer traffic in case of end-to-end WebRTC calls between WebRTC IMS clients. + +In addition, optional settings and procedures are described which fulfil optional features and where supported, the minimum mandatory settings within the optional procedures and packages are identified that must be supported in order to support that feature. + +"Optional" or "O" means that it is optional for either the sender or the receiver to implement an element. If the receiving entity receives an optional element that it has not implemented it should send an Error Code (e.g. 445 "Unsupported or Unknown Property", 501 "Not Implemented", etc.). "Mandatory" or "M" means that it is mandatory for the receiver to implement an element. Whether it is mandatory for the sender to implement depends on specific functions; detail of whether elements of the core protocol are mandatory to be sent are defined in the stage 2 procedures, stage 3 procedures and/or the descriptions of individual packages. + +The setting or modification of elements described in the profile under the heading "Used in Command" has the meaning that the property can be set/modified with that command. The property may be present in other commands (in order to preserve its value in accordance with ITU-T Recommendation H.248.1 [10]) when those commands are used for other procedures that affect the same descriptor. + +## 5.3 Gateway Control Protocol Version + +Version 2 (ITU-T Recommendation H.248.1 [10]) shall be used as minimum protocol version. + +## 5.4 Connection model + +**Table 5.4.1: Connection Model** + +| | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------| +| Maximum number of contexts: | Provisioned | +| Maximum number of terminations per context: | 3 | +| Allowed terminations type combinations: | (IP,IP) ;
(IP,IP,IP) (NOTE) | +| NOTE: This is only a temporary context configuration, occurring during bearer access transfer phase (between PS to CS access networks or vice versa) or during the reservation of two sets of transport addresses/resources towards the access network to support the functionalities related to the Alternate Connectivity functionality (see 3GPP TS 23.334 [23]). | | + +## 5.5 Context attributes + +**Table 5.5.1: Context Attributes** + +| Context Attribute | Supported | Values Supported | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|-------------------------| +| Topology | Yes (NOTE 1) | See clause 5.7.9 | +| Priority Indicator | Optional (NOTE 2) | 0-15 (NOTE 3) | +| Emergency Indicator | Yes | YES/NO | +| IEPS Indicator | No | NA | +| ContextAttribute Descriptor | No | NA | +| ContextIdList Parameter | No | NA | +| AND/OR Context Attribute | No | NA | +| NOTE 1: Stream ID in Topology Descriptor shall not be supported (because only used for SRVCC service support, which is a monomedia type of call ("voice call"). | | | +| NOTE 2: This Context Attribute parameter is allowed in ETSI TISPAN Ia Profile version 3. It is also used for MPS as specified in 3GPP TS 22.153 [39]. | | | +| NOTE 3: Priority values 11 – 15 of the Priority Indicator are reserved for MPS. | | | + +## 5.6 Terminations + +### 5.6.1 Termination names + +#### 5.6.1.1 IP Termination + +##### 5.6.1.1.1 ABNF Coding Overview and prose specification + +The Termination ID structure shall follow the guidelines of H.248 and shall be based on four fields: + +- "ip///". + +The individual fields are described and defined in table 5.6.1.1.1.1. + +**Table 5.6.1.1.1.1: IP Termination Fields** + +| Name | Description | Values | CHOOSE Wildcard | ALL Wildcard | +|-----------|----------------------------------------------------------------------------------------------------------------------------|------------------------------------------|-----------------|--------------| +| ip | "ip" is a fixed prefix identifying the termination | "ip" | No | No | +| Group | Group of Interface and Id | Integer (0-65535) | Yes (NOTE 5) | Yes | +| Interface | Logical or physical interface to a network to/from which the termination will be sending/receiving media. (NOTE 1, NOTE 2) | String of max 51 alphanumeric characters | Yes (NOTE 4) | Yes | +| Id | Termination specific identifier (NOTE 3) | Non-zero 32 bit integer | Yes (NOTE 4) | Yes | + +NOTE 1: A specific may be used together with different groups. +NOTE 2: The generic field may relate specifically to an "IP interface", "protocol layer 2 interface" or others. +NOTE 3: The combination of Interface and Id is unique. +NOTE 4: The MGC shall always use CHOOSE in an ADD request command. If not, the MG shall reply with an error descriptor using error code #501 "Not Implemented". +NOTE 5: The CHOOSE wildcard on 'Group' is *not* allowed in ETSI TISPAN "Ia Profiles". + +NOTE: The IMS-ALG has the ability to choose the address space in which the IMS-AGW will allocate an IP address for the termination by using the *ipdc/realm* property defined in the ITU-T Recommendation H.248.41 IP domain connection package. + +H.248 wildcarding may be applied on IP Termination Identifiers. Wildcarding is limited according the two columns on the right hand side. + +The corresponding ABNF grammar is given below. + +ABNF (IETF RFC 5234 [15]) is used for the syntax specification. The ABNF for TerminationID and relation to pathNAME is defined in annex B.2/ ITU-T Recommendation H.248.1 [10]. + +``` + +pathNAME = EphToken SLASH EPHsystem +EphToken = "ip" ; prefix +EPHsystem = WildcardALL + / WildcardALL SLASH Interface + / Group SLASH WildcardALL + / (Group / WildcardCHOOSE) SLASH (Interface / WildcardCHOOSE) SLASH (Identifier + / WildcardALL / WildcardCHOOSE) +Group = %d0-65535 ; data type: INT16 +Interface = 1*51ALPHANUM +Identifier = %d1-4294967295 ; data type: INT32 +ALPHANUM = ALPHA / DIGIT +WildcardCHOOSE = "$" +WildcardALL = "*" + +``` + +##### 5.6.1.1.2 ASN.1 Coding Overview and prose specification + +The following general structure of termination ID shall be used: + +4 octets shall be used for the termination ID. The following defines the general structure for the termination ID: + +**Table 5.6.1.1.2.1: ASN.1 coding** + +| | | +|------------------|---| +| Termination type | X | +|------------------|---| + +Termination type: + +Length 3 bits + +Values: + +000 Reserved + +001 IP (Ephemeral) termination + +010 Reserved (in 3GPP Mc and Mn profile used for TDM termination) + +011 - 110 Reserved + +111 Reserved for ROOT termination Id (ROOT Termination ID = 0xFFFFFFFF) + +X: + +Length 29 bits. + +For IP termination, its usage is un-specified. + +### 5.6.2 Multiplexed terminations + +**Table 5.6.2.1: Multiplexed terminations** + +| | | +|------------------------------------------|----| +| Multiplex terminations supported? | No | +|------------------------------------------|----| + +*If yes, then:* + +**Table 5.6.2.2: Multiplex Types** + +| | | +|--------------------------------------------------------------|----| +| Multiplex types supported | NA | +| Maximum number of terminations connected to multiplex | NA | + +## 5.7 Descriptors + +### 5.7.1 TerminationState Descriptor + +**Table 5.7.1.1: ServiceState property** + +| | | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------| +| ServiceState property used: | Yes (InService/OutOfService) NOTE 1, NOTE 2 | +| NOTE 1: This is restricted to the ROOT termination (for MGW audit). | | +| NOTE 2: Ephemeral H.248 Terminations have a ServiceState property according to ITU-T Recommendation H.248.1 [10], but explicit usage of the TerminationState Descriptor ServiceState property is not required by this Profile. ServiceState changes can still occur, however, and can be indicated in ServiceChange Commands (i.e. this means that the value of the ServiceState property may be implicitly changed by ServiceChange procedures). | | + +**Table 5.7.1.2: EventBufferControl property** + +| | | +|------------------------------------------|----| +| EventBufferControl property used: | No | +|------------------------------------------|----| + +**Table 5.7.1.3: Group semantics property** + +| | | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----| +| Group semantics property used: | Yes | +| NOTE: This is restricted to ephemeral H.248 Terminations used for WebRTC service support. The property is used in conjunction with the media grouping package, see clause 5.14.3.23. | | + +**Table 5.7.1.4: SDPCapNeg Extensions property** + +| | | +|------------------------------------------------------------------------------------------------------------------------------------|-----| +| SDPCapNeg Extensions property used: | Yes | +| NOTE: The property is used in conjunction with the Enhanced Revised Offer/Answer SDP Support package, see clause 5.14.3.x1. | | + +### 5.7.2 Stream Descriptor + +#### 5.7.2.0 General + +**Table 5.7.2.1: Stream descriptors** + +| Maximum number of streams per termination type | IP | Unspecified (NOTE 1, NOTE 2) | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----|------------------------------| +| NOTE 1: At least one stream for each media component (e.g. video+audio = 2 streams). If only one stream is applicable, then the IMS-ALG may omit the Stream Descriptor and the IMS-AGW shall assume that StreamID = 1.
NOTE 2: An IP termination for WebRTC may carry additional H.248 (de-)aggregation streams besides the legacy H.248 component streams. | | | + +**Table 5.7.2.2: Stream configuration** + +| | | +|------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Stream configuration: | ALL configurations are allowed.
IP terminations for WebRTC may apply H.248 stream grouping principles, which leads to relationships of associated H.248 streams within such stream group configurations. | +|------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +#### 5.7.2.1 LocalControl Descriptor + +**Table 5.7.2.1.1: LocalControl Descriptor and Reserve properties** + +| | | Termination Type | Stream Type | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----|------------------|-------------------------------| +| ReserveGroup used: | No | NA | NA | +| ReserveValue used: | Yes | IP | Audio, Video (NOTE 1, NOTE 2) | +| NOTE 1: The value of the H.248 Stream Type is given here by the SDP "m=" line element media type (in contrast to the SDP "m=" line element transport protocol in Table 5.7.2.1.2). Usage of ReserveValue implies thus media type aware Local and Remote Descriptors.
NOTE 2: Not used (at this profile version (see clause 5.1 for the version number)) for TCP transport (IETF RFC 793 [51]) and media types:
a) "Message" (for MSRP (IETF RFC 4975 [18]) and
b) "Application" (for BFCP (IETF RFC 4582 [52]) and ROI FECC (IETF RFC 4573 [62])) because the application control will not use them in context ReserveValue. | | | | + +Table 5.7.2.1.2: Allowed Stream Modes + +| Termination Type | Stream Type | Allowed StreamMode Values | +|------------------|-------------------------------|----------------------------------------| +| IP | RTP/AVP | SendOnly, RecvOnly, SendRecv, Inactive | +| | RTP/SAVP | SendOnly, RecvOnly, SendRecv, Inactive | +| | RTP/AVPF | SendOnly, RecvOnly, SendRecv, Inactive | +| | RTP/SAVPF | SendOnly, RecvOnly, SendRecv, Inactive | +| | TCP (NOTE 1) | SendRecv, Inactive | +| | TCP/MSRP (NOTE 1) | SendRecv, Inactive | +| | TCP/TLS (NOTE 1) | SendOnly, RecvOnly, SendRecv, Inactive | +| | TCP/TLS/MSRP (NOTE 1, NOTE 2) | SendOnly, RecvOnly, SendRecv, Inactive | +| | UDPTL | SendRecv, Inactive | +| | UDP | SendOnly, RecvOnly, SendRecv, Inactive | +| | UDP/DTLS | SendOnly, RecvOnly, SendRecv, Inactive | +| | UDP/DTLS/SCTP (NOTE 3) | SendOnly, RecvOnly, SendRecv, Inactive | + +NOTE 1: The H.248 StreamMode does not affect protocol control information at the bearer interface. See clause 7.1.7.1.1 in ITU-T Recommendation H.248.1 [10] and: + +a) TCP: ITU-T Recommendation H.248.89 [47], clause 8.6.4.1, Table "Impact of StreamMode on TCP bearer traffic at external MG interface" + +b) TLS: ITU-T Recommendation H.248.90 [48], clause 8.6.4.1, Table "Impact of StreamMode on TLS bearer traffic at external MG interface". + +NOTE 2: Conditional support, dependent on support of application-aware interworking. + +NOTE 3: Conditional support, dependent on WebRTC service with data application(s). + +NOTE 4: Conditional support, dependent on WebRTC service and DTLS-based SRTP key exchange for audio or video. + +Table 5.7.2.1.3: LocalControl Descriptor and other properties + +| | | Termination Type | Stream Type | +|-----------------------------------------------------------------------------|-----|------------------|--------------------| +| Stream Aggregation used: | No | NA | NA | +| Stream De-aggregation used: | Yes | IP for WebRTC | WebRTC Data (NOTE) | +| NOTE: Conditional, dependent on WebRTC calls with multiple data components. | | | | + +### 5.7.3 Events descriptor + +Table 5.7.3.1: Events Descriptor + +| | | | | +|---------------------------------------------------------------|--------------------------------------------------------------------|-------------------------|--------------------| +| Events settable on termination types and stream types: | Yes | | | +| If yes | EventID | Termination Type | Stream Type | +| | Cause (g/cause, 0x0001/0x0001) - See clause 5.14.3.1 | ALL except ROOT | ANY | +| | Inactivity Timeout (it/ito, 0x0045/0x0001) - See clause 5.14.3.6 | only ROOT | Not applicable | +| | MG_Overload (ocp/mg_overload, 0x0051/0x0001) - See clause 5.14.3.8 | only ROOT | Not applicable | + +| | | | +|---------------------------------------------------------------------------------------------------|-----------------|-------------------------------------------------| +| Termination Heartbeat (hangterm/thb, 0x0098/0x0001) - See clause 5.14.3.9 | ALL except ROOT | ANY | +| MGCon (chp/mgcon, 0x0029/0x0001) - See clause 5.14.3.10 | only ROOT | Not Applicable | +| Available Realms Changed (ipra/arc, 0x00e0/0x0001) - See clause 5.14.3.11 | only ROOT | Not Applicable | +| IP Flow Stop Detection (adid/ipstop, 0x009c/0x0001) - See clause 5.14.3.14 | ALL except ROOT | Any | +| ECN Failure (ecnrous/fail, 0x010b/0x0001) see clause 5.14.3.15 | IP | RTP based | +| ICE New Peer Reflexive Candidate (ostuncc/nprc, 0x00c3/0x0002) - see clause 5.14.3.17 | IP | Any, only applicable for full ICE | +| ICE Connectivity Check Result (ostuncc/ccr, 0x00c3/0x0001) - see clause 5.14.3.17 | IP | Any, only applicable for full ICE | +| TCP connection state change ("BNC change") (tcpbcc/BNCChange, 0x0115/0x0001) see clause 5.14.3.18 | IP | TCP based | +| TLS session state change ("BNC change") (tlbsc/BNCChange, 0x0117/0x0001) see clause 5.14.3.19 | IP | TLS or DTLS based | +| STUN Consent Request Failure (stnconfres/constate, 0x0120/0x0002) see clause 5.14.3.22 | IP | TLS or DTLS based, only applicable for full ICE | +| SCTP connection state change (sctpcc/BNCChange, 0x0121/0x0001) see clause 5.14.3.24 | IP | SCTP based | +| Detect outgoing SCTP stream reset (sctpreset/detreset, 0x0122/0x0001) see clause 5.14.3.25 | IP | SCTP based | +| Outgoing SCTP stream reset result (sctpreset/result, 0x0122/0x0002) see clause 5.14.3.25 | IP | SCTP based | + +Table 5.7.3.2: Event Buffer Control + +| | | +|---------------------------|----| +| EventBuffer Control used: | No | +|---------------------------|----| + +Table 5.7.3.3: Keep active + +| | | +|-----------------------------------|----| +| KeepActive used on events: | No | +|-----------------------------------|----| + +Table 5.7.3.4: Embedded events and signals + +| | | +|--------------------------------------------------|----| +| Embedded events in an Events Descriptor: | No | +| Embedded signals in an Events Descriptor: | No | + +Table 5.7.3.5: Regulated Embedded events + +| | | +|----------------------------------------------------|------| +| Regulated Embedded events are triggered on: | None | +|----------------------------------------------------|------| + +Table 5.7.3.6: ResetEventsDescriptor + +| | | +|------------------------------------------------|------| +| ResetEventsDescriptor used with events: | None | +|------------------------------------------------|------| + +Table 5.7.3.7: Notification Behaviour + +| | | +|-------------------------|------------| +| NotifyImmediate: | ALL Events | +| NotifyRegulated: | None | +| NeverNotify: | None | + +### 5.7.4 EventBuffer descriptor + +Table 5.7.4.1: Event Buffer Descriptor + +| | | | +|-------------------------------------|-----------------|---| +| EventBuffer Descriptor used: | No | | +| If yes | EventIDs | - | + +### 5.7.5 Signals descriptor + +Table 5.7.5.1: Signals Descriptor + +| | | | | +|-----------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|-----------------------------------| +| The setting of signals is dependant on termination or streams types: | No
NOTE – "No" means that all signals can be played on any termination or stream. If "Yes", any signal not listed below may be played on any termination or stream, except Signals on ROOT termination shall not be supported. | | | +| If yes | SignalID | Termination Type | Stream Type / ID | +| | Latching (ipnapl/latch, 0x0099/0x0001) | ALL except ROOT | Any | +| | Send Additional Connectivity Check (ostuncc/sacc, 0x00c3/0x0002) | IP | Any, only applicable for full ICE | +| | Send Connectivity Check (ostuncc/scc, 0x00c3/0x0001) | IP | Any, only applicable for full ICE | +| | Establish BNC (tcpbcc/EstBNC, 0x0115/0x0001) see clause 5.14.3.18 | IP | TCP based | +| | Release BNC (tcpbcc/RelBNC, 0x0115/0x0002) see clause 5.14.3.18 | IP | TCP based | + +| | | | | +|--|-----------------------------------------------------------------------------------------------------------|----|-------------------| +| | Establish BNC
(tlsbsc/EstBNC,
0x0117/0x0001) see
clause 5.14.3.19 | IP | TLS or DTLS based | +| | Release BNC
(tlsbsc/RelBNC,
0x0117/0x0002) see
clause 5.14.3.19 | IP | TLS or DTLS based | +| | Consent Test
(stnconfres/contst,
0x0120/0x0001) see
clause 5.14.3.22 | IP | TLS or DTLS based | +| | Establish BNC
(sctpbc/EstBNC,
0x0121/0x0001) see
clause 5.14.3.24 | IP | SCTP based | +| | Release BNC
(sctpbc/RelBNC,
0x0121/0x0002) see
clause 5.14.3.24 | IP | SCTP based | +| | Initiate Outgoing SCTP
Stream Reset
(sctpreset/initreset,
0x0122/0x0001) see
clause 5.14.3.25 | IP | SCTP based | +| | Outgoing SCTP Stream
Reset Response
(sctpreset/resetresp,
0x0122/0x0002) see
clause 5.14.3.25 | IP | SCTP based | + +Table 5.7.5.2: Signal Lists + +| | | | +|---------------------------------|----------------------------------------------------|---| +| Signals Lists supported: | No | | +| If yes | Termination Type Supporting Lists: | - | +| | Stream Type Supporting lists: | - | +| | Maximum number of signals to a signal list: | - | +| | Intersignal delay parameter supported: | - | + +Table 5.7.5.3: Overriding Signal type and duration + +| | | | +|--------------------------------------------|-----------------|----------------------------------| +| Signal type and duration supported: | No | | +| If yes | SignalID | Type or duration override | +| | - | - | + +Table 5.7.5.4: Signal Direction + +| | | | +|------------------------------------|----|--| +| Signal Direction supported: | No | | +|------------------------------------|----|--| + +Table 5.7.5.5: Notify completion + +| | | | +|------------------------------------|-----------------|-------------------------------------| +| NotifyCompletion supported: | No | | +| If yes | SignalID | Type of completion supported | +| | - | - | + +Table 5.7.5.6: RequestID Parameter + +| | | +|--------------------------------|----| +| RequestID Parameter supported: | No | +|--------------------------------|----| + +Table 5.7.5.7: Signals played simultaneously + +| | | | +|--------------------------------|----------------------------------------------|--| +| Signals played simultaneously: | No | | +| If yes | SignalIDs that can be played simultaneously: | | + +Table 5.7.5.8: Keep active + +| | | +|-----------------------------|----| +| KeepActive used on signals: | No | +|-----------------------------|----| + +### 5.7.6 DigitMap descriptor + +Table 5.7.6.1: DigitMap Descriptor + +| | | | | +|----------------------|---------------|-----------|--------| +| DigitMaps supported: | No | | | +| If yes | DigitMap Name | Structure | Timers | + +### 5.7.7 Statistics descriptor + +Table 5.7.7.1: Statistics Descriptor support + +| | | +|--------------------------|---| +| Statistics supported on: | - | +|--------------------------|---| + +Table 5.7.7.2: Statistics Report on Subtract + +| | | | +|----------------------------------|------------------------|---| +| Statistics reported on Subtract: | No | | +| If yes | StatisticIDs reported: | - | + +### 5.7.8 ObservedEvents descriptor + +Table 5.7.8.1: ObservedEvents Descriptor + +| | | +|---------------------------------|----| +| Event detection time supported: | No | +|---------------------------------|----| + +### 5.7.9 Topology descriptor + +Table 5.7.9.1: Topology Descriptor + +| | | +|------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------| +| Allowed triples: | (T1, T2, isolate)
(T1, T2, bothway) | +| NOTE: The Topology Descriptor shall be supported by the MGW and MGC for handover only, when PS-to-CS access transfer is supported. | | + +### 5.7.10 Error descriptor + +**Table 5.7.10.1: Error Codes Sent by IMS-ALG** + +| | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Supported H.248.8 Error Codes: | #400 "Syntax error in message"
#401 "Protocol Error"
#402 "Unauthorized"
#403 "Syntax Error in TransactionRequest"
#406 "Version Not Supported"
#410 "Incorrect identifier"
#411 "The transaction refers to an unknown ContextID"
#413 "Number of transactions in message exceeds maximum"
#421 "Unknown action or illegal combination of actions"
#422 "Syntax Error in Action"
#430 "Unknown TerminationID"
#431 "No TerminationID matched a wildcard"
#442 "Syntax Error in Command"
#443 "Unsupported or Unknown Command"
#444 "Unsupported or Unknown Descriptor"
#445 "Unsupported or Unknown property"
#446 "Unsupported or Unknown Parameter"
#447 "Descriptor not legal in this command"
#448 "Descriptor appears twice in a command"
#449 "Unsupported parameter or property value"
#450 "No such property in this package"
#451 "No such event in this package"
#454 "No such parameter value in this package"
#455 "Property illegal in this Descriptor"
#456 "Property appears twice in this Descriptor"
#457 "Missing parameter in signal or event"
#458 "Unexpected Event/RequestID"
#501 "Not Implemented"
#502 "Not ready"
#505 "Transaction Request Received before a ServiceChange Reply has been received"
#506 "Number of TransactionPendings Exceeded"
#533 "Response exceeds maximum transport PDU size" | +| Supported Error Codes defined in packages: | All error codes defined in supported packages are supported. | +| NOTE: The error codes listed need not be supplied by the IMS-ALG to differentiate each and every error described by them. The IMS-AGW shall be able to receive the error codes listed. | | + +Table 5.7.10.2: Error Codes Sent by IMS-AGW: + +| | | +|---------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Supported H.248.8 Error Codes: | #400 "Syntax error in message"
#401 "Protocol Error"
#402 "Unauthorized"
#403 "Syntax Error in TransactionRequest"
#406 "Version Not Supported"
#410 "Incorrect identifier"
#411 "The transaction refers to an unknown ContextID"
#412 "No ContextIDs available"
#413 "Number of transactions in message exceeds maximum"
#421 "Unknown action or illegal combination of actions"
#422 "Syntax Error in Action"
#430 "Unknown TerminationID"
#431 "No TerminationID matched a wildcard"
#432 "Out of TerminationIDs or No TerminationID available"
#433 "TerminationID is already in a Context"
#434 "Max number of Terminations in a Context exceeded"
#435 "Termination ID is not in specified Context"
#440 "Unsupported or unknown Package"
#441 "Missing Remote or Local Descriptor"
#442 "Syntax Error in Command"
#443 "Unsupported or Unknown Command"
#444 "Unsupported or Unknown Descriptor"
#445 "Unsupported or Unknown property"
#446 "Unsupported or Unknown Parameter"
#447 "Descriptor not legal in this command"
#448 "Descriptor appears twice in a command"
#449 "Unsupported parameter or property value"
#450 "No such property in this package"
#451 "No such event in this package"
#452 "No such signal in this package"
#454 "No such parameter value in this package"
#455 "Property illegal in this Descriptor"
#456 "Property appears twice in this Descriptor"
#457 "Missing parameter in signal or event"
#471 "Implied Add for Multiplex failure"
#488 "Incorrect stream endpoint interlinkage"
#489 "Invalid aggregation and/or deaggregation"
#500 "Internal software Failure in MG or MGC"
#501 "Not Implemented"
#502 "Not ready"
#505 "Transaction Request Received before a ServiceChange Reply has been received"
#506 "Number of TransactionPendings Exceeded"
#510 "Insufficient resources"
#511 "Temporarily Busy"
#512 "Media Gateway unequipped to detect requested Event"
#513 "Media Gateway unequipped to generate requested Signals"
#515 "Unsupported Media Type"
#517 "Unsupported or invalid mode"
#522 "Functionality Requested in Topology Triple Not Supported"
#526 "Insufficient bandwidth"
#529 "Internal hardware failure in MG"
#530 "Temporary Network failure"
#531 "Permanent Network failure"
#532 "Audited Property, Statistic, Event or Signal does not exist"
#533 "Response exceeds maximum transport PDU size"
#534 "Illegal write of read only property"
#542 "Command is not allowed on this termination" | +| Supported Error Codes defined in packages: | All error codes defined in supported packages need to be | + +| | | +|-------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | supported. | +| NOTE: | The error codes listed need not be supplied by the IMS-AGW to differentiate each and every error described by them. The IMS-ALG shall be able to receive the error codes listed. | + +## 5.8 Command API + +### 5.8.1 Add + +**Table 5.8.1.1: Descriptors used by Command Add Request** + +| | | +|-----------------------------------------|-------------------------------------------------------------| +| Descriptors used by Add request: | Media (Stream(LocalControl, Local, Remote)), Event, Signals | +|-----------------------------------------|-------------------------------------------------------------| + +**Table 5.8.1.2: Descriptors used by Command Add Reply** + +| | | +|---------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Descriptors used by Add reply: |

Media (Stream (Local)), Error

When command request excludes an Audit Descriptor, the MGW response shall only include descriptors which contained underspecified or overspecified properties in the command request. Furthermore, only those properties that were underspecified or overspecified in the request shall be sent in the reply. Exceptions to this rule are:

  • - The Error Descriptor
  • - SDP properties returned in "Reserve AGW Connection Point" and "Reserve and Configure AGW Connection Point" procedures, as specified in 15.17.2.2 and 15.17.2.4.
| +|---------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +### 5.8.2 Modify + +**Table 5.8.2.1: Descriptors used by Command Modify Request** + +| | | +|--------------------------------------------|--------------------------------------------------------------------------------| +| Descriptors used by Modify request: | Media (TerminationState, Stream (LocalControl, Local, Remote)), Signals, Event | +|--------------------------------------------|--------------------------------------------------------------------------------| + +**Table 5.8.2.2: Descriptors used by Command Modify Reply** + +| | | +|------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Descriptors used by Modify reply: |

Media (Stream(Local)), Error

When command request excludes an Audit Descriptor, the MGW response shall only include descriptors which contained underspecified or overspecified properties in the command request. Furthermore, only those properties that were underspecified or overspecified in the request shall be sent in the reply. Exceptions to this rule are:

  • - The Error Descriptor
  • - SDP properties returned in "Configure AGW Connection Point" procedure as specified in 15.17.2.3.
| +|------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +### 5.8.3 Subtract + +**Table 5.8.3.1: Descriptor used by Command Subtract Request** + +| | | +|-----------------------------------------------------------|--------------------| +| Descriptors used by Subtract request: | None, Audit() NOTE | +| NOTE: This requests that no statistics are to be returned | | + +**Table 5.8.3.2: Descriptor used by Command Subtract Reply** + +| | | +|--------------------------------------------|-------------| +| Descriptors used by Subtract reply: | None, Error | +|--------------------------------------------|-------------| + +### 5.8.4 Move + +**Table 5.8.4.1: Command Move** + +| | | +|---------------------------|----| +| Move command used: | No | +|---------------------------|----| + +*If used:* + +**Table 5.8.4.2: Descriptor used by Move command** + +| | | +|------------------------------------------|---| +| Descriptors used by Move request: | - | +| Descriptors used by Move reply: | - | + +### 5.8.5 AuditValue + +**Table 5.8.5.1: Auditvalue** + +| Audited Properties: | Property Name and Identity | Descriptor | +|---------------------------------|--------------------------------------------|-----------------------------| +| | TerminationState:
- Root (MGW Audit) | TerminationState Descriptor | +| | For Packages:
Root | Packages Descriptor | +| | None (MGW Audit) :
- Root | Audit (empty) Descriptor | +| | IP Realm Availability :
- ipra/* (ROOT) | TerminationState Descriptor | +| | Base root properties:
- root/* (ROOT) | TerminationState Descriptor | +| | SDPCapNeg Extensions:
- sdpe/* | TerminationState Descriptor | +| Audited Statistics: | None | | +| Audited Signals: | None | | +| Audited Events: | None | | +| Packages Audit possible: | Yes | | + +### 5.8.6 AuditCapabilities + +**Table 5.8.6.1: Auditcapability** + +| Audited Properties: | Property Name and Identity | Descriptor | +|----------------------------|-----------------------------------|-------------------| +| | None | - | +| Audited Statistics: | None | | +| Audited Signals: | None | | +| Audited Events: | None | | + +Table 5.8.6.2: Scoped Auditing + +| | | +|------------------------------------------------------------------|------| +| Audited Properties / ContextAttributes used for a scoped audit : | None | +|------------------------------------------------------------------|------| + +### 5.8.7 Notify + +Table 5.8.7.1: Descriptors Used by Notify Request + +| | | +|------------------------------------|----------------| +| Descriptors used by Notify Request | ObservedEvents | +|------------------------------------|----------------| + +Table 5.8.7.2: Descriptors Used by Notify Reply + +| | | +|-----------------------------------|-------------| +| Descriptors used by Notify Reply: | None, Error | +|-----------------------------------|-------------| + +### 5.8.8 ServiceChange + +Table 5.8.8.1: ServiceChangeMethods and ServiceChangeReasons sent by IMS-ALG: + +| Service Change Methods Supported: | ServiceChange Reasons supported: | +|-----------------------------------|----------------------------------------------------------| +| Handoff (NOTE 2, NOTE 3) | "903 MGC Directed Change" (Optional, NOTE 4) | +| Restart (NOTE 2) | "901 Cold Boot" (Optional)
"902 Warm Boot" (Optional) | +| Forced (NOTE 2) | "905 Termination Taken Out Of Service" (Optional) | +| Graceful (NOTE 2) | "905 Termination Taken Out Of Service" (Optional) | + +NOTE 1: When a Service Change command on the Root termination with a method other than Graceful is sent, the command shall always be sent as the only command in a message. The sending node shall always wait for the reply to a Service Change command on the Root termination with a method other than Graceful before sending further command requests. A Service Change command on the Root termination with method Graceful may be combined with other commands in a single message. + +NOTE 2: ROOT Only. + +NOTE 3: Not involving more than 1 IMS-ALG. This does not preclude the use of the MGCId in a ServiceChange (Handoff) scenario, nor does it change the expected IMS-AGW behaviour upon receipt of such a message, as the IMS-AGW has actually no means to differentiate whether the ServiceChangeMgcId parameter that may be received in a ServiceChange (handoff) message relates to a logical IMS-ALG inside the same IMS-ALG server or is part of another IMS-ALG. + +NOTE 4: Support of this procedure is mandatory in the IMS-AGW. + +**Table 5.8.8.2: ServiceChangeMethods and ServiceChangeReasons sent by IMS-AGW:** + +| Service Change Methods Supported: | ServiceChange Reasons supported: | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Forced | "904 Termination Malfunction", ALL except ROOT (Optional, NOTE 4)
"905 Termination Taken Out Of Service" , ALL (Mandatory)
"906 Loss Of Lower Layer Connectivity" , ALL except ROOT (Optional, NOTE 4)
"907 Transmission Failure" , ALL except ROOT (Optional, NOTE 4)
"908 MG Impending Failure" ROOT only (Mandatory)
"910 Media Capability Failure" , ALL except ROOT (Optional, NOTE 4)
"915 State Loss" ROOT only (Optional, NOTE 4) | +| Graceful (NOTE 2) | "905 Termination Taken Out Of Service" , (Optional, NOTE 4)
"908 MG Impending Failure" (Optional, NOTE 4) | +| Disconnected (NOTE 2) | "900 Service Restored" (Mandatory)
"916 Packages Change" (Optional)
"917 Capability Change" (Optional) | +| Restart (NOTE 2) | "900 Service Restored" (Mandatory)
"901 Cold Boot" (Mandatory)
"902 Warm Boot" (Mandatory)
"916 Packages Change" (Optional)
"917 Capability Change "(Optional) | +| Handoff (NOTE 2, NOTE 3) | "903 MGC Directed Change" (Mandatory) | +| NOTE 1: When a Service Change command on the Root termination with a method other than Graceful is sent, the command shall always be sent as the only command in a message. The sending node shall always wait for the reply to a Service Change command on the Root termination with a method other than Graceful before sending further command requests. A Service Change command on the Root termination with method Graceful may be combined with other commands in a single message. | | +| NOTE 2: ROOT Only. | | +| NOTE 3: In response to a IMS-ALG Ordered Re-Register (clause 5.17.3.7). | | +| NOTE 4: Support of this procedure is mandatory in the IMS-ALG. | | + +**Table 5.8.8.3: Service Change Address** + +| | | +|-----------------------------------|----| +| ServiceChangeAddress used: | No | +|-----------------------------------|----| + +**Table 5.8.8.4: Service Change Delay** + +| | | +|---------------------------------|---------------------------| +| ServiceChangeDelay used: | No | +| If yes | Valid time period: | + +**Table 5.8.8.5: Service Change Incomplete Flag** + +| | | +|--------------------------------------------|----| +| ServiceChange Incomplete Flag used: | No | +|--------------------------------------------|----| + +**Table 5.8.8.6: Service Change Version** + +| | | +|-------------------------------------------------------------------------------------|--------| +| Version used in ServiceChangeVersion: | 2 or 3 | +| NOTE: Version 2 shall be supported as the minimum protocol version. See clause 5.3. | | + +**Table 5.8.8.7: ServiceChangeProfile** + +| | | +|-------------------------------------------------------------------------------------------------|-----| +| ServiceChangeProfile mandatory: | Yes | +| NOTE: The ServiceChangeProfile is mandatory in the AGW Register and AGW Re-Register procedures. | | + +**Table 5.8.8.8: Profile negotiation** + +| | | +|---------------------------------------------|----| +| Profile negotiation as per H.248.18: | No | +|---------------------------------------------|----| + +**Table 5.8.8.9: ServiceChangeMGCId** + +| | | +|---------------------------------|-----| +| ServiceChangeMGCId used: | Yes | +|---------------------------------|-----| + +### 5.8.9 Manipulating and auditing context attributes + +**Table 5.8.9.1: Manipulating and auditing context attributes** + +| | | +|----------------------------------------|---------------------------------------------------| +| Context Attributes Manipulated: | Emergency Indicator, Priority Indicator, Topology | +| Context Attributes Audited: | None | + +## 5.9 Generic command syntax and encoding + +**Table 5.9.1: Encodings** + +| | | +|---------------------------------------------------------------------------------------------------------------------------------------|----------------------------------| +| Supported Encodings: | Text (NOTE 1, NOTE 2) and Binary | +| NOTE 1: The receiver shall be capable of receiving both Short Token Notation and Long Token Notation on an H.248 control association. | | +| NOTE 2: The transmitter may select between long and short token forms per H.248 control association. | | +| NOTE 3: ETSI TISPAN "la Profile" [3] uses only text encoding. | | + +## 5.10 Transactions + +**Table 5.10.1: Transactions per Message** + +| | | +|----------------------------------------------------------------------------------------------------------------------|-----------| +| Maximum number of TransactionRequests / TransactionReplies / TransResponseAcks / Segment Replies per message: | 10 (NOTE) | +| NOTE: ETSI TISPAN "la Profile" [3] maximum is "1", this is foreseen to be the typical case. | | + +**Table 5.10.2: Commands per Transaction Requests** + +| | | +|---------------------------------------------------------------------------------------------|--------------------| +| Maximum number of commands per TransactionRequest: | Unspecified (NOTE) | +| NOTE: ETSI TISPAN "la Profile" [3] maximum is "2", this is foreseen to be the typical case. | | + +**Table 5.10.3: Commands per Transaction Reply** + +| | | +|---------------------------------------------------------------------------------------------|--------------------| +| Maximum number of commands per TransactionReply: | Unspecified (NOTE) | +| NOTE: ETSI TISPAN "la Profile" [3] maximum is "2", this is foreseen to be the typical case. | | + +**Table 5.10.4: Optional Commands** + +| | | +|-----------------------------------------------|--------------------------------------------------------------------------------------| +| Commands able to be marked "Optional": | | +|-----------------------------------------------|--------------------------------------------------------------------------------------| + +**Table 5.10.5: Commands marked for Wildcarded Responses** + +| | | +|---------------------------------------------------|----------| +| Wildcarded responses may be requested for: | Subtract | +|---------------------------------------------------|----------| + +**Table 5.10.6: Procedures for Wildcarded Responses** + +| | | +|----------------------------------------------------------|-------------------------| +| Procedures that make use of wildcarded responses: | Release AGW Termination | +|----------------------------------------------------------|-------------------------| + +**Table 5.10.7: Transaction Timers** + +| Transaction Timer: | Value | +|------------------------------------------|--------------| +| normalMGExecutionTime | Provisioned | +| normalMGCEExecutionTime | Provisioned | +| MGOriginatedPendingLimit | Provisioned | +| MGCOOriginatedPendingLimit | Provisioned | +| MGProvisionalResponseTimerValue | Provisioned | +| MGCPProvisionalResponseTimerValue | Provisioned | + +## 5.11 Messages + +It is recommended that IMS-AGW and IMS-ALG names are in the form of fully qualified domain name. For example the domain name of the IMS-ALG may be of the form: "ALG1.whatever.net." and the name of the IMS-AGW may be of the form: "mg1.whatever.net." + +The fully qualified domain name will be used by the IMS-AGW and IMS-ALG as part of the "Message Identifier" in the H.248 messages which identifies the originator of the message. + +The IMS-ALG domain name is provisioned in the IMS-AGW or retrieved from the DNS using SRV records. + +The use of a domain name provides the following benefits: + +- IMS-AGWs and IMS-ALGs are identified by their domain name, not their network addresses. Several addresses can be associated with a domain name. If a command cannot be forwarded to one of the network addresses, implementations shall retry the transmission using another address. + +NOTE: There are then e.g. multiple numerical address entries per single MGC entity in the "MG database of MGC entries"; see Table 5 in ITU-T H.Sup7 [29]. + +- IMS-AGWs and IMS-ALGs may move to another platform. The association between a logical name (domain name) and the actual platform are kept in the Domain Name Service (DNS). IMS-AGW and IMS-ALG shall keep track of the record's time-to-live read from the DNS. They shall query the DNS to refresh the information if the time-to-live has expired. + +The domain name may be used by IMS-ALG/IMS-AGW for authentication purposes. + +## 5.12 Transport + +Specifies what H.248 subseries transports are supported by the profile. + +Table 5.12.1: Transport + +| | | +|----------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Supported transports: | 1. IPv4-based network control plane:
- SCTP/IPv4 (Recommended)
- UDP/IPv4 (Optional)
2. IPv6-based network control plane:
- SCTP/IPv6 (Recommended)
- UDP/IPv6 (Optional) | +| NOTE 1: When using SCTP as defined in IETF RFC 4960 [16] the IMS-AGW shall always be the node to perform the "Initiation". | | + +Table 5.12.2: Segmentation + +| | | +|--------------------------------|----------------------------------------| +| Segmentation supported: | SCTP: Inherent in Transport
UDP: No | +|--------------------------------|----------------------------------------| + +Table 5.12.3: Control Association + +| | | +|--------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Control Association Monitoring supported: | Monitoring mechanism is dependent on used H.248 transport (see above table 5.12/1):
SCTP:
inherent capability of SCTP.
UDP:
H.248.14 (MG-driven monitoring).
Empty AuditValue on ROOT (MGC-driven monitoring). | +|--------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +## 5.13 Security + +Table 5.13.1: Security + +| | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------| +| Supported Security: | None | +| NOTE: IPsec shall not be used by the IMS-ALG or IMS-AGW for the Iq interface. Normally the Iq interface lies within a single operator's secure domain. If this is not the case then a Za interface (Security Gateway deploying IPsec) may be required, however this is a separate logical function/entity and thus is not applicable to the Iq profile, the IMS-ALG or the IMS-AGW. For further details see 3GPP TS 33.210 [27]. | | + +## 5.14 Packages + +### 5.14.1 Mandatory Packages + +Table 5.14.1.1: Mandatory Packages + +| Mandatory Packages: | | | +|-------------------------------------------------------------------|--------------------|----------------| +| Package Name | PackageID | Version | +| IP NAPT traversal (ITU-T Recommendation H.248.37 [4]) | ipnapt, (0x0099) | 1 | +| Generic (ITU-T Recommendation H.248.1 [10], annex E.1) | g, (0x0001) | 1 | +| Base root (ITU-T Recommendation H.248.1 [10], annex E.2) | root, (0x0051) | 2 | +| Gate management (ITU-T Recommendation H.248.43 [6], Appendix I) | gm, (0x008c) | 2 | +| Traffic management (ITU-T Recommendation H.248.53 [7]) | tman, (0x008d) | 1 | +| IP Domain Connection (ITU-T Recommendation H.248.41 [8]) | ipdc, (0x009d) | 1 | +| Hanging Termination Detection (ITU-T Recommendation H.248.36 [9]) | hangterm, (0x0098) | 1 | +| Diffserv (ITU-T Recommendation H.248.52 [12]) | ds, (0x008b) | 2 | +| RTP Control Protocol (ITU-T Recommendation H.248.57 [5]) | rtpcph, (0x00b5) | 1 | + +### 5.14.2 Optional Packages + +**Table 5.14.2.1: Optional Packages** + +| Optional Packages: | | | | +|----------------------------------------------------------------------------------------------------|--------------------|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Package Name | PackageID | Version | Support dependent on: | +| Inactivity Timer (ITU-T Recommendation H.248.14 [11]) | it, (0x0045) | 1 | MGC polling by MG.
Only applicable for UDP transport. | +| Media Gateway Overload Control (ITU-T Recommendation H.248.11 [13]) | ocp, (0x0051) | 1 | Support of message throttling, based on rate limitation, from MGC towards MG. | +| Media Gateway Resource Congestion Handling Package (see ITU-T Recommendation H.248.10 [14]) | chp, (0x0029) | 1 | Support of message throttling, based on percentage limitation, from MGC towards MG. | +| IP realm availability (ITU-T Recommendation H.248.41 Amendment 1) [8] | ipra (0x00e0) | 1 | Support of mechanisms allowing the MGC to discover the IP realms that are available at the MG at a certain time and allowing the MG to inform the MGC about any changes in the availability of realms. | +| Application Data Inactivity Detection (ITU-T Recommendation H.248.40 [24]) | adid (0x009c) | 1 | MGC requires to be explicitly informed of a cessation of an application data flow. | +| Explicit Congestion Notification for RTP-over-UDP Support (see ITU-T Recommendation H.248.82 [40]) | ecnrous (0x010b) | 1 | Support of Transparent forwarding of ECN packets | +| MG Act-as STUN Server (ITU-T Recommendation H.248.50 [43]) | mgastuns (0x00c2) | 1 | Support of incoming STUN connectivity checks.
Applicable for ICE lite and full ICE | +| Originate STUN Continuity Check (see ITU-T Recommendation H.248.50 [43]) | ostuncc (0x00c3) | 1 | Support of originating STUN connectivity checks
Only applicable for full ICE | +| TCP basic connection control (ITU-T Recommendation H.248.89 [47]) | tcpbcc, (0x0115) | 1 | Support of state-aware TCP handling (TCP proxy mode) (NOTE). | +| TLS basic session control (ITU-T Recommendation H.248.90 [48]) | tlsbsc, (0x0117) | 1 | Support of
a) TCP-based media using TLS
b) UDP-based media using DTLS,
c) SCTP-based media using DTLS (WebRTC) | +| Stream endpoint interlinkage (ITU-T Recommendation H.248.92 [49]) | seplink, (0x011b) | 1 | Support of state-aware TCP handling (TCP proxy mode) and of Forward Incoming TCP Connection Establishment Requests Indicator. | +| MG located Bearer Level ALG (ITU-T Recommendation H.248.78 [56]) | mgbalg (0x011d) | 1 | Support of a bearer level application gateway (B-ALG) function for application-aware MSRP interworking. | +| STUN Consent Freshness (ITU-T Recommendation H.248.50 [43]) | stnconfres(0x0120) | 1 | Support of STUN usage for consent freshness procedures.
Applicable for full ICE. | +| Media Grouping (ITU-T Recommendation H.248.96 [65]) | mgroup (0x011f) | 1 | Support of WebRTC data channels | +| SCTP basic connection control package (ITU-T Recommendation H.248.97 [66]) | sctpbcc (0x0121) | 1 | Support of WebRTC data channels: control of establishment and release of SCTP associations, and the allocation of local SCTP stream identifiers | + +| | | | | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------|---|-------------------------------------------------------------------------------------| +| SCTP Re-configuration Stream reset ([ITU-T Recommendation H.248.97 [66]]) | sctpreset, (0x0122) | 1 | Support of WebRTC data services: control of SCTP stream reset ("release") procedure | +| Enhanced Revised Offer/Answer SDP Support ([ITU-T Recommendation H.248.80 [73]]) | eroas, (0x0109) | 1 | Support of the SDP Capability Negotiation syntax | +| NOTE: Stateless TCP handling (i.e. TCP relay and TCP merge mode) are solely based on SDP indication (thus, package-less) according to ITU-T Recommendation H.248.84 [46], clause 13. | | | | + +### 5.14.3 Package usage information + +#### 5.14.3.1 Generic (g) + +Table 5.14.3.1.1: Generic package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | +|------------------------------------------|--------------------------------------|---------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------| +| None | - | - | - | - | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | +| None | - | - | | - | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | +| | - | - | - | - | +| Events | Mandatory/Optional | Used in command | | | +| Cause (g/cause, 0x0001/0x0001) | M | ADD, MOD, NOTIFY | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | +| | None | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | +| | General cause (Generalcause, 0x0001) | M | "NR" (0x0001) Normal Release
"UR" (0x0002) Unavailable Resources
"FT" (0x0003) Failure, Temporary
"FP" (0x0004) Failure, Permanent
"IW" (0x0005) Interworking Error
"UN" (0x0006) Unsupported | Not Applicable | +| | Failure cause (Failurecause, 0x0002) | O | Octet String | Not Applicable | +| Events | Mandatory/Optional | Used in command | | | +| Signal Completion. (g/sc, 0x0001/0x0002) | Not Used | - | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | +| | - | - | - | - | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | +| | - | - | - | - | +| Statistics | Mandatory/Optional | Used in command | | Supported Values | +| None | - | - | | - | +| Error Codes | Mandatory/Optional | | | | +| None | - | | | | + +#### 5.14.3.2 Base root (root) + +Table 5.14.3.2.1: Base root package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | | | +|--------------------------------------------------------------------------------------------|--------------------------|--------------------|------------------|----------------------------|--|--| +| MaxNrOfContexts
(root/maxNumberOfContexts, 0x0002/0x0001) | O | AUDITVALUE | ALL | YES | | | +| MaxTerminationsPerContext
(root/maxTerminationPerContext, 0x0002/0x0002) | O | AUDITVALUE | ALL | YES | | | +| normalMGExecutionTime
(root/normalMGExecutionTime, 0x0002/0x0003) | O | AUDITVALUE | ALL | YES | | | +| normalMGCEExecutionTime
(root/normalMGCEExecutionTime, 0x0002/0x0004) | O | AUDITVALUE | ALL | YES | | | +| MGProvisionalResponseTimerValue
(root/MGProvisionalResponseTimerValue, 0x0002/0x0005) | O | AUDITVALUE | ALL | YES | | | +| MGCProvisionalResponseTimerValue
(root/MGCProvisionalResponseTimerValue, 0x0002/0x0006) | O | AUDITVALUE | ALL | YES | | | +| MGCOriGINatedPendingLimit
(root/MGCOriGINatedPendingLimit, 0x0002/0x0007) | O | AUDITVALUE | ALL | YES | | | +| MGOrigiNatedPendingLimit
(root/MGOrigiNatedPendingLimit, 0x0002/0x0008) | O | AUDITVALUE | ALL | YES | | | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | | | +| None | - | - | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | | | +| | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| Statistics | Mandatory/Optional | Used in command | | Supported Values | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +#### 5.14.3.3 Differentiated Services (ds) + +Table 5.14.3.3.1: Differentiated Services package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | | | +|-------------------------------------------------------------|---------------------------------|---------------------------|-------------------------|-----------------------------------|--|--| +| Differentiated Services Code Point (ds/dscp, 0x008b/0x0001) | M | ADD, MODIFY | ALL | Yes | | | +| Tagging Behaviour (ds/tb, 0x008b/0x0002) | O | ADD, MODIFY | ALL | Yes | | | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | | | +| None | - | - | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | | | +| | - | - | | - | | | +| Events | Mandatory/Optional | Used in command | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | | - | | | +| Statistics | Mandatory/Optional | Used in command | Supported Values | | | | +| None | - | - | - | | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +#### 5.14.3.4 Gate Management (gm) + +Table 5.14.3.4.1: Gate Management Package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | +|----------------------------------------------------------|---------------------------|---------------------------|-------------------------|-----------------------------------| +| Remote Source Address Filtering (gm/saf, 0x008c/0x0001) | M | ADD, MODIFY | ALL | Not Applicable | +| Remote Source Address Mask (gm/sam, 0x008c/0x0002) | O | ADD, MODIFY | ALL | Not Applicable | +| Remote Source Port Filtering (gm/spf, 0x008c/0x0003) | M | ADD, MODIFY | ALL | Not Applicable | +| Remote Source Port (gm/spr, 0x008c/0x0004) | O | ADD, MODIFY | ALL | Not Applicable | +| Explicit Source Address Setting (gm/esas, 0x008c/0x0005) | Not Supported | NONE | - | Not Applicable | +| Local Source Address (gm/lsa, 0x008c/0x0006) | Not Supported | NONE | - | Not Applicable | +| Explicit Source Port Setting (gm/esps, 0x008c/0x0007) | Not Supported | NONE | - | Not Applicable | +| Local Source Port (gm/lsp, 0x008c/0x0008) | Not Supported | NONE | - | Not Applicable | +| Remote Source Port Range (gm/spr, 0x008c/0x000A) | O | ADD, MODIFY | ALL | Not Applicable | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | +| None | - | - | | - | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | +| | - | - | | - | + +| Events | Mandatory/Optional | Used in command | | | | | +|--------------------|---------------------------------|---------------------------|-------------------------|--------------------------|--|--| +| None | - | - | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| Statistics | Mandatory/Optional | Used in command | Supported Values | | | | +| Discarded Packets | NOT USED | - | - | | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +#### 5.14.3.5 Traffic management (tman) + +**Table 5.14.3.5.1: Traffic Management Package** + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | | | +|-----------------------------------------------------|---------------------------------|---------------------------|-------------------------|-----------------------------------|--|--| +| Policing (tman/pol, 0x008d/0x0005) | M | ADD, MODIFY | ALL | Not Applicable | | | +| Peak Data Rate (tman/pdr, 0x008d/0x0001) | O | ADD, MODIFY | ALL | Not Applicable | | | +| Delay Variation Tolerance (tman/dvt, 0x008d/0x0004) | O | ADD, MODIFY | ALL | ALL | | | +| Sustainable Data Rate (tman/sdr, 0x008d/0x0002) | M | ADD, MODIFY | ALL | Not Applicable | | | +| Maximum burst size (tman/mbs, 0x008d/0x0003) | M | ADD, MODIFY | ALL | Not Applicable | | | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | | | +| None | - | - | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | | | +| | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| Statistics | Mandatory/Optional | Used in command | Supported Values | | | | +| None | - | - | - | | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +NOTE: The data rate shall be calculated using the packet size from IP layer upwards. The Token Bucket method as described by ITU-T Recommendation H.248.53 [7] clause 9.4.3 (as per IETF RFC 2216 [32]) shall be followed where SDR = "r" and MBS = "b" (i.e. the additional "M" value does not apply). + +#### 5.14.3.6 Inactivity Timer (it) + +Table 5.14.3.6.1: Inactivity Timer Package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | | | +|--------------------------------------------------|--------------------|------------------|-------------------|-------------------------------|--|--| +| None | - | - | - | - | | | +| Signals | Mandatory/Optional | Used in command | | Duration
Provisioned Value | | | +| None | - | - | - | - | | | +| Signal Parameters | Mandatory/Optional | Supported Values | Duration | Provisioned Value | | | +| - | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command | | | | | +| Inactivity Timeout
(it/ito,
0x0045/0x0001) | M | MODIFY, NOTIFY | | | | | +| Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | | +| Maximum Inactivity
Time (mit, 0x0001) | O | ALL | Yes | | | | +| ObservedEvent
Parameters
| Mandatory/Optional | Supported Values | Provisioned Value | | | | +| None | - | - | - | | | | +| Statistics | Mandatory/Optional | Used in command | Supported Values | | | | +| None | - | - | - | | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +#### 5.14.3.7 IP Domain Connection (ipdc) + +Table 5.14.3.7.1: IP domain connection package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | | | +|-------------------------------------------------------|--------------------|-------------------------|-------------------|-------------------------------|--|--| +| IP Realm Identifier
(ipdc/realm,
0x009d/0x0001) | M | ADD,
MODIFY (NOTE 2) | ALL
(NOTE 1) | Yes | | | +| Signals | Mandatory/Optional | Used in command | | Duration
Provisioned Value | | | +| None | - | - | - | - | | | +| Signal Parameters | Mandatory/Optional | Supported Values | Duration | Provisioned Value | | | +| - | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command | | | | | +| None | - | - | | | | | +| Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | | +| - | - | - | - | | | | +| ObservedEvent
Parameters
| Mandatory/Optional | Supported Values | Provisioned Value | | | | +| - | - | - | - | | | | +| Statistics | Mandatory/Optional | Used in command | Supported Values | | | | +| None | - | - | - | | | | +| Error Codes | Mandatory/Optional | | | | | | +| No | - | | | | | | + +NOTE 1: If the MGC uses an IP Realm Identifier (*ipdc/realm*) property exceeding the maximum length limitation defined in ITU-T Recommendation H.248.41 [8], the MG shall reply with an error descriptor using error code #410: "Incorrect identifier". + +NOTE 2: The MODIFY command is listed due to the fact that subsequent Streams may be "added" by MODIFY requests in case of multi-Stream-per-Termination structures. The subsequent Streams shall then carry the same IP Realm Identifier (*ipdc/realm*) property value as the very first Stream. + +#### 5.14.3.8 Media Gateway Overload Control Package (ocp) + +Table 5.14.3.8.1: Media Gateway Overload Control Package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | +|----------------------------------------------------------------|---------------------------------|-------------------------|------------------|----------------------------| +| None | - | - | - | - | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | +| None | - | - | - | - | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | +| | - | - | - | - | +| Events | Mandatory/Optional | Used in command | | | +| MG_Overload
(ocp/mg_overload,
0x0051/0x0001)
(NOTE 1) | M | MODIFY, NOTIFY (NOTE 1) | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | +| | None | - | - | - | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | +| | None | - | - | - | +| Statistics | Mandatory/Optional | Used in command | | Supported Values | +| None | - | - | - | - | +| Error Codes | Mandatory/Optional | | | | +| None | - | | | | + +NOTE 1: When the MG is overloaded, overload Events may be sent **either** only following the **first ADD.request** which creates a new Context, **or** following **all ADD.request** commands (see ITU-T Recommendation H.248.11 [13] Corrigendum 1). +These two options result in different normalisations of the overload event rate as an indicator of the level of MG overload. + +#### 5.14.3.9 Hanging Termination Detection (hangterm) + +Table 5.14.3.9.1: Hanging Termination Detection Package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | +|-----------------------------------------------------------|---------------------------------|---------------------|------------------|----------------------------| +| None | - | - | - | - | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | +| None | - | - | - | - | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | +| | - | - | - | - | +| Events | Mandatory/Optional | Used in command | | | +| Termination Heartbeat
(hangterm/thb,
0x0098/0x0001) | M | ADD, MODIFY, NOTIFY | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | +| | Timer X
(timerx,0x0001) | M | ALL (NOTE1) | YES | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | +| | - | - | - | - | +| Statistics | Mandatory/Optional | Used in command | | Supported Values | +| None | - | - | - | - | +| Error Codes | Mandatory/Optional | | | | +| None | - | | | | + +NOTE1: The heartbeat timer shall be configured to a value much greater than the mean call holding time. + +#### 5.14.3.10 Media Gateway Resource Congestion handling Package (chp) + +Table 5.14.3.10.1: Media Gateway Resource Congestion handling Package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | +|----------------------------------------|---------------------------------|--------------------|------------------|----------------------------| +| None | - | - | - | - | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | +| None | - | - | - | - | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | +| | - | - | - | - | +| Events | Mandatory/Optional | Used in command | | | +| MGCon
(chp/mgcon,
0x0029/0x0001) | M | MODIFY, NOTIFY | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | +| | None | - | - | - | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | +| | Reduction
(reduction,0x0001) | M | 0-100 | Not Applicable | +| Statistics | Mandatory/Optional | Used in command | | Supported Values | +| None | - | - | - | - | +| Error Codes | Mandatory/Optional | | | | +| None | - | | | | + +#### 5.14.3.11 IP Realm Availability (ipra) + +Table 5.14.3.11.1: IP Realm Availability Package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | +|-----------------------------------------------------------|----------------------------------------------|--------------------|-------------------|----------------------------| +| Available Realms,
(ipra/ar,
0x00e0/0x0001) | M | AUDITVALUE | ALL | Not Applicable | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | +| None | - | - | - | - | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | +| | - | - | - | - | +| Events | Mandatory/Optional | Used in command | | | +| Available Realms
Changed, (ipra/arc,
0x00e0/0x0001) | M | MODIFY, NOTIFY | | | +| | Event Parameters | Mandatory/Optional | Supported Values: | Provisioned Value | +| | - | - | - | - | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | +| | Newly Available
Realms (nar,
0x0001) | M | ALL | Not applicable | +| | Newly Unavailable
Realms (nur,
0x0002) | M | ALL | Not applicable | +| Statistics | Mandatory/Optional | Used in command | | Supported Values | +| None | - | - | - | - | +| Error Codes | Mandatory/Optional | | | | +| None | - | | | | + +#### 5.14.3.12 IP NAPT Traversal (ipnapt) + +Table 5.14.3.12.1: IP NAPT Traversal Package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | | | +|------------------------------------------|------------------------------------------|--------------------|------------------|----------------------------|--|--| +| None | - | - | - | - | | | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | | | +| Latching (ipnapt/latch)
0x0099/0x0001 | M | ADD, MODIFY | | Not Applicable | | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | | | +| | NAPT Traversal Processing (napt, 0x0001) | M | ALL | Not Applicable | | | +| Events | Mandatory/Optional | Used in command | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| Statistics | Mandatory/Optional | Used in command | | Supported Values | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +#### 5.14.3.13 RTCP Handling Package (rtcph) + +Table 5.14.3.13.1: RTCP Handling Package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | | | +|---------------------------------------------------------------|---------------------------------|--------------------|------------------|----------------------------|--|--| +| RTCP Allocation Specific Behaviour (rtcph/rsb, 0x00b5/0x0009) | M | ADD, MODIFY | ALL | OFF | | | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | | | +| None | - | - | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | | | +| | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| Statistics | Mandatory/Optional | Used in command | | Supported Values | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +#### 5.14.3.14 Application Data Inactivity Detection (adid) + +Table 5.14.3.14.1: Application Data Inactivity Detection package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | +|-----------------------------------------------------|---------------------------|-------------------------|-----------------------------------|-----------------------------------| +| None | - | - | - | - | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | +| None | - | - | - | - | +| Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | | +| - | - | - | - | - | +| Events | Mandatory/Optional | Used in command | | | +| IP Flow Stop Detection (adid/ipstop, 0x009c/0x0001) | M | ADD, MODIFY, NOTIFY | | | +| Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | +| Detection time (dt, 0x0001) | M | ALL | Yes | | +| Direction (dir, 0x0002) | M | ALL | Yes | | +| ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | +| None | - | - | - | - | +| Statistics | Mandatory/Optional | Used in command | Supported Values | | +| None | - | - | - | - | +| Error Codes | Mandatory/Optional | | | | +| None | | | | | + +#### 5.14.3.15 Explicit Congestion Notification for RTP-over-UDP Support (ecnrous) + +Table 5.14.3.15.1: Explicit Congestion Notification for RTP-over-UDP Support package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | +|-------------------------------------------------------------|---------------------------|-------------------------|-----------------------------------|---------------------------------------------------------------------------------------------| +| ECN Enabled (ecnrous/ecnen, 0x010b/0x0001) | M | ADD, MODIFY | True, False | - | +| Congestion Response Method (ecnrous/crm, 0x010b/0x0002) | Not Signalled | - | - | "RDCC"(0x0002) (NOTE 1, NOTE 2) | +| Initiation Method (ecnrous/initmethod, 0x010b/0x0003) | M | ADD, MODIFY | "inactive", "leap" | "inactive" | +| ECN Mode (ecnrous/mode, 0x010b/0x0004) | Not Signalled | - | - | "setonly" (0x0001) in the Remote Descriptor and "readonly" (0x0002) in the Local Descriptor | +| ECT Marking (ecnrous/ectmark, 0x010b/0x0005) | Not Signalled | - | - | "0" (0x0002) (NOTE 2) | +| ECN Congestion Marking (ecnrous/congestmark, 0x010b/0x0006) | Not Signalled | - | - | "nomark" (0x0003) | +| ECN SDP Usage (ecnrous/ecnsdp, 0x010b/0x0007) | Not Signalled | - | - | "P" (0x0001) | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | +| None | - | - | - | - | +| Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | | +| - | - | - | - | - | + +| Events | Mandatory/Optional | Used in command | | | | | +|----------------------------------------------------------------|----------------------------------|---------------------------|-------------------------|--------------------------|--|--| +| ECN Failure (ecnrous/fail, 0x010b/0x0001) | O (NOTE 2) | ADD, MODIFY, NOTIFY | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | Failure Type (type, 0x0001) | Mandatory | INIT, USE | | | | +| | Media Sender SSRC (ssrc, 0x0002) | Not Supported | | | | | +| Statistics | Mandatory/Optional | Used in command | | Supported Values | | | +| Source (ecnrous/ssrc, 0x010b/0x0001) | Not Supported | - | | - | | | +| CE Counter (ecnrous/cecount, 0x010b/0x0002) | Not Supported | - | | - | | | +| ECT0 Counter (ecnrous/ectzero, 0x010b/0x0003) | Not Supported | - | | - | | | +| ECT1 Counter (ecnrous/ectone, 0x010b/0x0004) | Not Supported | - | | - | | | +| Not-ECT Counter (ecnrous/notect, 0x010b/0x0005) | Not Supported | - | | - | | | +| Lost Packets Counter (ecnrous/lost, 0x010b/0x0006) | Not Supported | - | | - | | | +| Extended Highest Sequence number (ecnrous/ehsn, 0x010b/0x0007) | Not Supported | - | | - | | | +| Duplication Counter (ecnrous/dup, 0x010b/0x0008) | Not Supported | - | | - | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +NOTE 1: Application Specific Rate Adaptation shall be applied in accordance with 3GPP TS 26.114 [26]. For speech this requires support of CMR and TMMBR for video. + +NOTE 2: Not used for ECN transparent. Mandatory for ECN endpoint. + +#### 5.14.3.16 MG Act-as STUN Server (mgastuns) + +Table 5.14.3.16.1: MG Act-as STUN Server + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | | | +|-----------------------------------------------------|--------------------------|--------------------|------------------|----------------------------|--|--| +| Act-as STUN Server (mgastuns/astuns, 0x00c2/0x0001) | M | ADD, MODIFY | ALL | - | | | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | | | +| None | - | - | - | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | | | +| | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command | | | | | +| None | - | - | | - | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| Statistics | Mandatory/Optional | Used in command | Supported Values | | | | +| None | - | - | - | | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +#### 5.14.3.17 Originate STUN Continuity Check (ostuncc) + +Table 5.14.3.17.1: Originate STUN Continuity Check Package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | +|------------------------------------------------------------------|--------------------------|---------------------|-----------------------------|----------------------------| +| Host Candidate Realm (ostuncc/hcr, 0x00c3/0x0001) | O | ADD, MODIFY | ALL | Yes | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | +| Send Connectivity Check (ostuncc/scc, 0x00c3/0x0001) | M | ADD, MODIFY | | Not Applicable | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | +| | Control (cntrl, 0x0001) | O | "controlling", "controlled" | Not Applicable | +| Send Additional Connectivity Check (ostuncc/sacc, 0x00c3/0x0002) | Mandatory/Optional | Used in command | | Duration Provisioned Value | +| | M | MODIFY | | Not Applicable | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | +| | Control (cntrl, 0x0001) | O | "controlling", "controlled" | Not Applicable | +| Events | Mandatory/Optional | Used in command | | | +| Connectivity Check Result (ostuncc/ccr, 0x00c3/0x0001) | M | ADD, MODIFY, NOTIFY | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | +| | - | - | - | - | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | +| New Peer Reflexive Candidate (ostuncc/nprc, 0x00c3/0x0001) | Mandatory/Optional | Used in command | | | +| | M | ADD, MODIFY, NOTIFY | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | + +| | | | | | | | +|--------------------|---------------------------------|---------------------------|-------------------------|--------------------------|--|--| +| 0x00c3/0x0002) | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | Candidate (can, 0x0001) | M | ALL | Not applicable | | | +| Statistics | Mandatory/Optional | Used in command | | Supported Values | | | +| None | - | - | | - | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +#### 5.14.3.18 TCP basic connection control (tcpbcc) + +Table 5.14.3.18.1: TCP basic connection control package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | | | +|--------------------------------------------------------------------------------|-------------------------------------|---------------------------|-----------------------------------------------------------|-----------------------------------|--|--| +| Incoming bearer connection establishment blocking (tcpbcc/bceb, 0x0115/0x0001) | O (NOTE 1) | ADD, MODIFY | ALL | "Unblocked" | | | +| Oneway Release Indicator (tcpbcc/ori, 0x0115/0x0002) | not supported | - | - | "False" | | | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | | | +| Establish BNC (tcpbcc/EstBNC, 0x0115/0x0001) | M | ADD, MODIFY | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | | | +| | - | - | - | - | | | +| Release BNC (tcpbcc/RelBNC, 0x0115/0x0002) | O (NOTE 2) | ADD, MODIFY- | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | | | +| | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command | | | | | +| TCP connection state change (tcpbcc/BNCChange, 0x0115/0x0001) | O (NOTE 3) | ADD, MODIFY, NOTIFY- | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | Type of state change (Type, 0x0001) | M | Est [0x01] Bearer Established, Rel [0x05] Bearer Released | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | Type of state change (Type, 0x0001) | M | Est [0x01] Bearer Established, Rel [0x05] Bearer Released | - | | | +| Statistics | Mandatory/Optional | Used in command | Supported Values | | | | +| None | - | - | - | | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +NOTE 1: Shall be supported if delayed TCP bearer connection establishment is required. + +NOTE 2: When the IMS-ALG wants to explicitly trigger the TCP bearer connection release procedure (instead of the implicit trigger related to the removal of the H.248 stream (via a MODIFY.request or SUBtract.request command)). + +NOTE 3: When the IMS-ALG wants to monitor the execution of TCP bearer control procedures. + +#### 5.14.3.19 TLS basic session control (tlsbsc) + +Table 5.14.3.19.1: TLS basic session control package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | | | +|-------------------------------------------------------------------------------|-------------------------------------|---------------------------|-----------------------------------------------------------|-----------------------------------|--|--| +| Incoming security session establishment blocking (tlsbsc/bceb, 0x0117/0x0001) | O (NOTE 1) | ADD, MODIFY | ALL | "Unblocked" | | | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | | | +| Establish BNC (tlsbsc/EstBNC, 0x0117/0x0001) | M | ADD, MODIFY | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | | | +| | - | - | - | - | | | +| Release BNC (tlsbsc/RelBNC, 0x0117/0x0002) | O (NOTE 2) | ADD, MODIFY- | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | | | +| | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command | | | | | +| TLS session state change (tlsbsc/BNCChange, 0x0117/0x0001) | O (NOTE 3) | ADD, MODIFY, NOTIFY- | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | Type of state change (Type, 0x0001) | M | Est [0x01] Bearer Established, Rel [0x05] Bearer Released | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | Type of state change (Type, 0x0001) | M | Est [0x01] Bearer Established, Rel [0x05] Bearer Released | - | | | +| Statistics | Mandatory/Optional | Used in command | Supported Values | | | | +| None | - | - | - | | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +NOTE 1: When the IMS-ALG wants to block incoming (D)TLS bearer session establishment requests. +NOTE 2: When the IMS-ALG wants to explicitly trigger the (D)TLS bearer session release procedure (instead of the implicit trigger related to the removal of the H.248 stream (via a MODify.request or SUBtract.request command)). +NOTE 3: When the IMS-ALG wants to monitor the execution of (D)TLS bearer control procedures. + +#### 5.14.3.20 Stream endpoint interlinkage (seplink) + +Table 5.14.3.20.1: Stream endpoint interlinkage package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | +|---------------------------------------------------------|---------------------------|---------------------------|-------------------------|-----------------------------------| +| Interlinkage topology (seplink/linktopo, 0x011b/0x0001) | M | ADD, MODIFY | only TCP endpoints | empty list | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | +| None | - | - | | - | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | +| | - | - | - | - | + +| Events | Mandatory/Optional | Used in command | | | | | +|-------------|--------------------------|--------------------|------------------|-------------------|--|--| +| None | - | - | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| Statistics | Mandatory/Optional | Used in command | Supported Values | | | | +| None | Not Supported | - | - | | | | +| Error Codes | Mandatory/Optional | | | | | | +| #488 | M | | | | | | + +#### 5.14.3.21 MG located Bearer Level ALG (mgbalg) + +Table 5.14.3.21.1: MG located Bearer Level ALG package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | | | +|----------------------------------------------------------------------------------------|--------------------------|--------------------|------------------|----------------------------|--|--| +| Protocol type bearer level ALG (mgbalg/ptbalg, 0x011d/0x0001) | M | ADD, MODIFY | ALL | "OFF" | | | +| Upper layer protocol filter (mgbalg/ulpf, 0x011d/0x0002) | O (NOTE) | ADD, MODIFY | 0 | "0" | | | +| Source of replaced source address information part (mgbalg/sosai, 0x011d/0x0003) | O (NOTE) | ADD, MODIFY | ALL | "SD" | | | +| Source of replaced destination address information part (mgbalg/sodaip, 0x011d/0x0004) | O (NOTE) | ADD, MODIFY | ALL | "SD" | | | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | | | +| None | - | - | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | | | +| | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command | | | | | +| None | - | - | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| Statistics | Mandatory/Optional | Used in command | Supported Values | | | | +| None | - | - | - | | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +NOTE: When B-ALG service configuration is provisioned in IMS-AGW. + +#### 5.14.3.22 STUN Consent Freshness (stnconfres) + +Table 5.14.3.22.1: STUN Consent Freshness package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | +|------------|--------------------|-----------------|------------------|-------------------| +| None | - | - | - | - | + +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | | | +|------------------------------------------------------------------------|--------------------------------------|---------------------------|-------------------------|-------------------------------------------|--|--| +| Consent Test
(stnconfres/const,
0x0120/0x0001) | M | ADD, MODIFY | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | | | +| | tstint (0x0001) | O | Integer | 0.8N and 1.2N
Default N=5000
(NOTE) | | | +| Events | Mandatory/Optional | Used in command | | | | | +| Consent State
(stnconfres/constate,
0x0120/0x0001) | Not supported | - | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | Request States
(reqstate, 0x0001) | Not supported | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | States (state, 0x0001) | Not supported | - | - | | | +| STUN Consent Request Failure
(stnconfres/confail,
0x0120/0x0002) | Mandatory/Optional | Used in command | | | | | +| | M | ADD, MOD, NOTIFY | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | - | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| Statistics | Mandatory/Optional | Used in command | Supported Values | | | | +| | None | - | - | | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +NOTE: The parameter "N" refers to the basic period of the consent check interval defined in IETF RFC 7675 [58]. + +#### 5.14.3.23 Media Grouping (mgroup) + +Table 5.14.3.23.1: Media Grouping package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | +|-------------------------------------------------------------|---------------------------------|---------------------------|-------------------------|-----------------------------------| +| Group Semantics
(mgroup/groupse,
0x011f/0x0001) | M | ADD, MODIFY | ALL (NOTE) | - | +| Stream Aggregation
(mgroup/stragg,
0x011f/0x0002) | Not supported | | | | +| Stream Deaggregation
(mgroup/strdeagg,
0x011f/0x0003) | M | ADD, MODIFY | ALL | - | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | +| None | - | - | | - | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | +| | - | - | - | - | +| Events | Mandatory/Optional | Used in command | | | +| None | - | - | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | +| | - | - | - | - | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | +| | - | - | - | - | + +| Statistics | Mandatory/Optional | Used in command | Supported Values | +|--------------------|---------------------------|-----------------|------------------| +| None | - | - | - | +| Error Codes | Mandatory/Optional | | | +| #489 | M | | | + +NOTE: Only semantics "SCTP" is required (for WebRTC data channels). + +#### 5.14.3.24 SCTP basic connection control package (sctpbcc) + +Table 5.14.3.24.1: SCTP basic connection control package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | | | +|---------------------------------------------------------------------------------|-------------------------------------|---------------------------|-----------------------------------------------------------|-----------------------------------|--|--| +| Incoming bearer connection establishment blocking (sctpbcc/bceb, 0x0121/0x0001) | Not supported | | | | | | +| SCTP StreamID (sctpbcc/sctpid, 0x0121/0x0002) | M | ADD, MODIFY | ALL | - | | | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | | | +| Establish BNC (sctpbcc/EstBNC, 0x0121/0x0001) | M | ADD, MODIFY | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | | | +| | - | - | - | - | | | +| Release BNC (sctpbcc/RelBNC, 0x0121/0x0002) | O (NOTE 1) | ADD, MODIFY | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | | | +| | - | - | - | - | | | +| Events | Mandatory/Optional | Used in command | | | | | +| SCTP connection state change (sctpbcc/BNCChange, 0x0121/0x0001) | O (NOTE 2) | ADD, MODIFY, NOTIFY- | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | Type of state change (Type, 0x0001) | M | Est [0x01] Bearer Established, Rel [0x05] Bearer Released | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| Statistics | Type of state change (Type, 0x0001) | M | Est [0x01] Bearer Established, Rel [0x05] Bearer Released | - | | | +| | Mandatory/Optional | Used in command | Supported Values | | | | +| | None | - | - | | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +NOTE 1: When the IMS-ALG wants to explicitly trigger the SCTP Association shutdown procedure (instead of the implicit trigger related to the removal of the H.248 Stream (via a MODify.request or SUBtract.request command)). + +NOTE 2: When the IMS-ALG wants to monitor the execution of SCTP bearer control procedures. + +#### 5.14.3.25 SCTP Re-configuration Stream Reset (sctpreset) + +Table 5.14.3.25.1: SCTP Re-configuration Stream Reset package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | | | +|--------------------------------------------------------------------------|---------------------------------|---------------------------|-------------------------|-----------------------------------|--|--| +| None. | - | - | - | - | | | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | | | +| Initiate Outgoing SCTP Stream Reset (sctpreset/initreset, 0x0122/0x0001) | M | ADD, MODIFY | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | | | +| | sctpid (0x0001) | M | ALL | - | | | +| Outgoing SCTP Stream Reset Response (sctpreset/resetresp, 0x0122/0x0002) | O (NOTE) | ADD, MODIFY | | - | | | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | | | +| | sctpid (0x0001) | M | ALL | - | | | +| | action (0x0002) | M | ALL | - | | | +| Events | Mandatory/Optional | Used in command | | | | | +| Detect outgoing SCTP stream reset (sctpreset/detreset, 0x0122/0x0001) | M | ADD, MODIFY, NOTIFY- | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | outresp (0x0001) | O | ALL | "accept" | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | sctpid (0x0001) | M | ALL | - | | | +| Outgoing SCTP stream reset result (sctpreset/result, 0x0122/0x0002) | O | ADD, MODIFY, NOTIFY- | | | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | None. | - | - | - | | | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | | | +| | sctpid (0x0001) | M | ALL | - | | | +| | result (0x0002) | M | ALL | - | | | +| Statistics | Mandatory/Optional | Used in command | Supported Values | | | | +| None | - | - | - | | | | +| Error Codes | Mandatory/Optional | | | | | | +| None | - | | | | | | + +NOTE: The signal is optional because dependent on an MGC determined or MG determined response behaviour (see also figures 10 and 11 in ITU-T Recommendation H.248.97 [66]). + +#### 5.14.3.26 Enhanced Revised Offer/Answer SDP Support (eroas) + +Table 5.14.3.26.1: Enhanced Revised Offer/Answer SDP Support package + +| Properties | Mandatory/Optional | Used in command | Supported Values | Provisioned Value | +|--------------------------------------------------|---------------------------------|---------------------------|-------------------------|-----------------------------------| +| SDPCapNeg Extensions (eroas/sdpe, 0x0109/0x0001) | M | AuditValue | "cap-v0" | "cap-v0" | +| Signals | Mandatory/Optional | Used in command | | Duration Provisioned Value | +| None | - | - | | - | +| | Signal Parameters | Mandatory/Optional | Supported Values | Duration Provisioned Value | +| | - | - | - | - | +| Events | Mandatory/Optional | Used in command | | | +| None | - | - | | | +| | Event Parameters | Mandatory/Optional | Supported Values | Provisioned Value | +| | - | - | - | - | +| | ObservedEvent Parameters | Mandatory/Optional | Supported Values | Provisioned Value | +| | - | - | - | - | + +| Statistics | Mandatory/Optional | Used in command | Supported Values | +|--------------------|---------------------------|-----------------|------------------| +| None | - | - | - | +| Error Codes | Mandatory/Optional | | | +| None | - | | | + +## 5.15 Mandatory support of SDP and Annex C information elements + +Table 5.15.1: Mandatory Annex C and SDP information elements + +| Information Element | Annex C Support | SDP Support | +|---------------------|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| v-line | "SDP_V " | The value must always be equal to zero: v=0 | +| c-line | "SDP_C " |

<nettype> <addrtype> and <connection address> are required.

The network type shall be set to "IN".

The address type may be IPv4 or IPv6.

The MGC may apply parameter underspecification to the <connection address> subfield.

| +| m-line | "SDP_M " |

There are four fields (or SDP values) <media>, <port>, <proto> and <fmt> in the "m=" line (see IETF RFC 4566 [17];NOTE 1).

The "m=" line may be omitted from SDP.

<media>, <port>, <proto> and <fmt-list> are required if the "m=" line is included.

Media type <media> :

The <media> field shall be set to "audio", "video", "message", "application", "text" or "-". When "-" is used for the media value then no media resources are required to be reserved at this stage (NOTE 1). If the MG does not support the requested media value it shall reject the command with error code 515.

Transport port <port>

The port value may be underspecified with CHOOSE wildcard.

Transport protocol <proto>

As in table 5.15.2.

Media format <fmt>

Various values may be used for media-format, dependent on the related <media> (NOTE 3).

"-" may be used for the format list value if no media reservation is required at this stage.

If the MG does not support the requested media format value the MG shall reject the command with error code 449.

| +| b-line | "SDP_B " |

Shall not be used without a "m=" line.

The modifier values shall be "AS", "RS" and "RR".

The AS modifier implies that the bandwidth-value represents the ""maximum bandwidth" (see clause 5.8/ IETF RFC 4566 [17]). The bandwidth-value relates therefore to the peak bitrate (NOTE 2).

The bandwidth-value value defines the IP layer bandwidth for the specific H.248 Stream.

For RTP flows, where RTCP resources are reserved together with the RTP resources using the "RTP Specific Behaviour" property of the Gate Management package (gm) property, the IMS-ALG may also supply additional RTCP bandwidth modifiers (i.e. RR and RS, see IETF RFC 3556 [28]). The AS bandwidth value will include the bandwidth used by RTP. In the absence of the RTCP bandwidth modifiers the IMS-AGW shall allow an additional 5% of the AS bandwidth value for the bandwidth for RTCP, in accordance with IETF RFC 3556 [28].

| + +| | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| o-line | "SDP_O" |

The origin line consists of six fields:
(<username>, <sess-id>, <sess-version>, <nettype>, <addrtype> and <unicast-address>).

The MGC is not required to supply this line but shall accept it (see clause 7.1.8/ITU-T Recommendation H.248.1 [10]).

The MG shall return the value received from the MGC or if there is no o-line sent by the MGC, the MG shall populate this line as follows:

  • - <user name> should contain an hyphen
  • - <session ID> and <version> should contain one or more digits as described in IETF RFC 4566 [17]
  • - <network type> shall be set to IN
  • - <address type> shall be set to IP4 or IP6 The Address Type shall be set to "IP4" or "IP6" depending on the addressing scheme used by the network to which the MG is connected.
  • - <address> should contain the fully qualified domain name or IP address of the gateway.
| +| s-line | "SDP_S" |

The session name "s=" line contains a single field
s= <session name>.

The MGC is not required to supply this line but shall accept it (see clause 7.1.8/ITU-T Recommendation H.248.1 [10]).

The MG shall return the value received from the MGC or if there is no s-line sent by the MGC, the MG shall populate this line as follows:
- "s=-"

| +| t-line | "SDP_T" |

The time "t=" line consists of two fields
t= <start time> and <stop time>.

The MGC is not required to supply this line but shall accept it (see clause 7.1.8/ITU-T Recommendation H.248.1 [10]).

The MG shall return the value received from the MGC or if there is no t-line sent by the MGC, the MG shall populate this line as follows:
"t=0 0"

| +|

NOTE 1: IETF RFC 4566 [17] enables "-" as a valid character.

NOTE 2: The unit for the bandwidth-value (peak bitrate) is "kbit/s". The "b=" line is not providing any information about the traffic characteristic, i.e. whether the traffic flow has a Constant BitRate (CBR) or Variable BitRate (VBR). The bandwidth-value is thus independent of the traffic characteristic and relates to the peak bitrate for CBR and VBR traffic.

NOTE 3: In particular, WebRTC uses value "webrtc-datachannel" in case of WebRTC data applications.

| | | + +Table 5.15.2: Transport Protocol + +| | | +|----------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------| +| Transport Protocol <proto> in m-line: | If the MG does not support the requested transport protocol, it shall reject the command with error code 449. | +| RTP/AVP | RTP profile according IETF RFC 3551 [19]. Allow only L4 protocol = UDP (see NOTE 1). | +| RTP/AVPF | Extended RTP profile for RTCP-based Feedback (RTP/AVPF) according IETF RFC 4585 [25]. See 3GPP TS 26.114 [26]. Allow only L4 protocol = UDP (see NOTE 1). | +| RTP/SAVP | SRTP profile according IETF RFC 3711 [30] (NOTE 3). Allow only L4 protocol = UDP (see NOTE 1). | +| RTP/SAVPF | Extended SRTP profile for RTCP-based Feedback (RTP/SAVPF) according IETF RFC 5124 [31] (NOTE 3). Allow only L4 protocol = UDP (see NOTE 1). | +| TCP | Allow only L4 protocol = TCP (NOTE 2) | +| TCP/MSRP | Message service using IETF RFC 4975 [18] (NOTE 6). | +| TCP/TLS | Application agnostic indication with L4 protocol = TCP (NOTE 4). | +| TCP/TLS/MSRP | Application-specific indication with L4 protocol = TCP and TLS-based transport security (SDP codepoint see IETF RFC 4975 [18]) (NOTE 6). | +| udptl | Allow only L4 protocol = UDP | + +| | | +|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| udp | Allow only L4 protocol = UDP (NOTE 1, NOTE 7). | +| UDP/DTLS | Application agnostic indication with L4 protocol = UDP and DTLS-based transport security (NOTE 5). | +| UDP/TLS/RTP/SAVP | Indication for WebRTC end-to-access edge transport security using DTLS-SRTP, where DTLS is used to establish keys for SRTP according to IETF RFC 5763 [60] and IETF RFC 5764 [61]. | +| UDP/TLS/RTP/SAVPF | Indication for WebRTC end-to-access edge transport security using DTLS-SRTP, where DTLS is used to establish keys for extended SRTP according to IETF RFC 5763 [60] and IETF RFC 5764 [61]. | +| UDP/DTLS/SCTP | See IETF RFC 8841 [68]. For WebRTC data channel support (for the indication of the protocol stack segment "SCTP-over-DTLS"). | +| NOTE 1: | Parameter "udp" is introduced by IETF RFC 4566 [17]. | +| NOTE 2: | Upper case TCP is defined by IETF RFC 4145 [20] and registered by IANA. | +| NOTE 3: | The IMS AGW does not need to reserve resources for end-to-access edge media (e2ae) security encryption/decryption at this stage if RTP profile identifiers "RTP/SAVP" or "RTP/SAVPF" are signalled without the "a=crypto" property for that stream. For e2e media security either "RTP/SAVP" is signalled at all terminations in a context, or "RTP/SAVPF" is signalled at all terminations in a context and no media attribute will be signalled; the IMS AGW shall then not terminate the SRTP / SRTCP protocol, but shall pass the encrypted media and control flows (as indicated with the rtcp/rsb property) transparently. | +| NOTE 4: | Parameter "TCP/TLS" is defined by IETF RFC 8122 [55] for the TLS protocol according to IETF RFC 5246 [53]. | +| NOTE 5: | Parameter "UDP/DTLS" is introduced by IETF draft-schwarz-mmusic-sdp-for-gw [54] (based on ITU-T Recommendation H.248.93 [50]). | +| NOTE 6: | Conditional support, dependent on application-aware interworking. | +| NOTE 7: | Codepoint used for e.g. "UDP payload transparent forwarding" (such as DTLS-encrypted end-to-end WebRTC bearer traffic). | + +## 5.16 Optional support of SDP and Annex C information elements + +*Specifies what SDP attributes and Annex C information elements may be supported.* + +Table 5.16.1: Optional Annex C and SDP information elements + +| Information Element | Annex C Support | SDP Support | +|---------------------|-----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| a-line | "SDP_A " |

1) Application "RTCP transport address control":

a) Default mode "without RTP/RTCP transport multiplexing":
The attribute "a=rtcp" line may either contain (a=rtcp: <port>) or (a=rtcp: <port> <network type> <address type> <connection address>) when the "a=" line is used for RTCP transport port and optionally network address transmission (see IETF RFC 3605 [21]). .
The MGC shall supply the "a=rtcp" line in the RD when non-default RTCP network address or transport port values are used by the peer media entity.
"RTCP transport address control" should be supported by MG (NOTE 2).

b) Optional extension mode "with RTP/RTCP transport multiplexing":
The attribute "a=rtcp-mux" (see IETF RFC 5761 [59]) is used for indicating RTP/RTCP transport multiplexing. Tables 4/1 to 4/5 in ITU-T Recommendation H.248.57 [5] define the appropriate RTCP port allocation rules.

2) Media related parameters in general:
The "a=" line provides the complementary information for the "m=" line with regards to a specified media type/format (e.g. an optional SDP „a=ptime" line for a particular media format).
For a dynamic RTP payload type, for each media information on the codec type shall be provided in a separate SDP "a=rtpmap" line and possibly additional SDP "a=fmtp"-line(s).

3) Application " Media interworking (transcoding)":
See "a=" line specification in (2). Media interworking is limited to audio transcoding only (NOTE 1).

4) IMS media plane security related parameters:
4.1) SRTP-specific security parameters:
The attribute "a=crypto" (see IETF RFC 4568 [29]) shall be provided for an m-line in the local and remote descriptor of an access network termination if the IMS-ALG wants that the corresponding media is encrypted, decrypted and/or integrity protected by the IMS-AGW (IMS end-to-access-edge media plane security). For each m-line, only a single "a=crypto" attribute shall be provisioned (i.e. only information related to a single crypto suite is provisioned to the IMS-AGW). The "a=crypto" attribute may contain several master keys. An IMS-AGW supporting end-to-access-edge media plane security shall support parameters within the "a=crypto" attribute in accordance with the profile in Annex of 3GPP TS 33.328 [34].

4.2) (D)TLS-specific security parameters:
The attribute(s) "a=fingerprint" (see IETF RFC 8122 [55]) shall be provided in accordance with ITU-T Recommendation H.248.90 [48] for an "m="-line in the local and remote descriptor of an access network termination if the IMS-ALG wants that the corresponding media is encrypted, decrypted and/or integrity protected by the IMS-AGW (IMS end-to-access-edge media plane security).

5) Coordination of Video Orientation
The attribute "a=extmap" (see IETF RFC 5285 [41]) may be provided for an m-line in the local and remote descriptor if the IMS-AGW supports the extended RTP header with Coordination of Video Orientation information, see also 3GPP TS 26.114 [26].

6) Generic Image Attribute
The attribute "a=imageattr" (see IETF RFC 6236 [42]) may be provided for an m-line in the local and remote descriptor if the IMS-AGW supports the generic image attributes, see also 3GPP TS 26.114 [26].
The local descriptor indicates the image sizes which the IMS-AGW supports in the receiving direction for the selected payload type and corresponds to the "recv" keyword (see IETF RFC 6236 [42]) in the "a=imageattr" that the IMS-ALG will send within the SDP body on the Mw/Mx interface. The remote descriptor indicates the image sizes

| + +| | | +|--|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| |

which the IMS-AGW supports in the sending direction for the selected payload type and corresponds to the "send" keyword (see IETF RFC 6236 [42]) in the "a=imageattr" that the IMS-ALG will send within the SDP body on the Mw/Mx interface.

7) ICE support
The attributes "a=candidate", "a=ice-pwd", and "a=ice-frag" (see IETF RFC 5245 [44]) may be provided for an SDP m-line in the local and remote descriptor if the IMS-AGW supports ICE, see also 3GPP TS 24.229 [45]. In the local descriptor, the IMS-ALG shall provide "a=ice-pwd", and "a=ice-frag" with wildcard sign "\$" to request the allocation of a password and user name fragment, and the "a=candidate" of type "host" with the transport, port and priority parameters with wildcard sign "\$" to request the allocation of a host candidate. The IMS-AGW shall then reply with completed "a=ice-pwd", and "a=ice-frag" and "a=candidate" attributes in the local descriptor, and shall include "a=ice-lite" if it only supports ICE lite. In the remote descriptor, the IMS-ALG may provide the "a=candidate", "a=ice-pwd", and "a=ice-frag".

8) state-agnostic and state-aware TCP handling:
The attribute "a=setup" (see IETF RFC 4145 [20]) shall be provided for TCP-based media, in accordance with ITU-T Recommendation H.248.84 [46], when triggering an end-to-end TCP simultaneous open (leading to a TCP merge mode in the IMS-AGW) or other TCP modes of operation.

9) Application-aware interworking for MSRP traffic:
The attribute "a=path" (see IETF RFC 4975 [11]) shall be provided, when enabling a bearer level application gateway (B-ALG) function for MSRP traffic, according to ITU-T Recommendation H.248.78 [56].

10) Handling of RTCP APP messages when transcoding between EVS and non EVS codecs:
The attribute "a=3gpp_mtsi_app_adapt" (see 3GPP TS 26.114 [26]) containing the allowed RTCP APP message types shall be provided when the IMS-AGW is allowed to send RTCP APP messages.

11) Pre-defined Video Region-of-Interest (ROI):
The attribute "a=rtcp-fb" with the "Predefined ROI" type expressed by the parameter "3gpp-roi-predefined" may be provided for an m-line in the local and remote descriptor if the IMS-AGW supports the Predefined ROI mode, see also 3GPP TS 26.114 [26]. In addition, the attribute "a=extmap" (see IETF RFC 5285 [41]) may be provided for an m-line in the local and remote descriptor if the IMS-AGW supports the extended RTP header for carriage of pre-defined video Region of Interest (ROI) information in the sent video, see also 3GPP TS 26.114 [26].

12) Arbitrary Video Region of Interest (ROI):
The attribute "a=rtcp-fb" with the "Arbitrary ROI" type expressed by the parameter "3gpp-roi-arbitrary" may be provided for an m-line in the local and remote descriptor if the IMS-AGW supports the Arbitrary ROI mode, see also 3GPP TS 26.114 [26]. In addition, the attribute "a=extmap" (see IETF RFC 5285 [41]) may be provided for an m-line in the local and remote descriptor if the IMS-AGW supports the extended RTP header for carriage of arbitrary video Region of Interest (ROI) information in the sent video, see also 3GPP TS 26.114 [26].

13) WebRTC data channel:
The attributes "a=sctp-port" and "a=max-message-size" shall be provided in the remote descriptor (see IETF RFC 8841 [68]). In the local descriptor, the IMS-ALG shall provide "a=sctp-port" with omission sign "-" to indicate that the IMS-ALG shall use the same port as for UDP, and "a=max-message-size" with wildcard sign "\$". The IMS-AGW shall then reply with completed "a=sctp-port" and "a=max-message-size" attributes in the local descriptor, The attribute "a=dcmmap" shall be provided in the local and remote descriptor, with the parameter

| +|--|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +| | | | +|-------------------------------------------------------------------------------------------------------------|--|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | |

"subprotocol" either set to "-" (Application-agnostic data channel configuration) or with real value (Application-aware data channel configuration).

14) Application aware interworking of traffic within a WebRTC data channel:
The attribute "a=dcspa" may be provided in the local descriptor and/or remote descriptor (see IETF RFC 8864 [69], NOTE 3).
T.140 (see ITU-T Recommendation T.140 [75]) is used for Global Text Telephony (GTT). Application aware interworking between the transport according to IETF RFC 8865 [77] within WebRTC data channels and the transport according to IETF RFC 4103 [76] in the IMS core network should be applied for T.140 according to ITU-T Recommendation H.248.94 [67] Appendix 2. For application aware T.140 interworking, the "a= rtpmap" attribute shall be provided with "t140" payload type for the termination towards the IMS core network and "t140" value of the "subprotocol" parameter of the SDP "a=dcmap" attribute shall be provided for the termination towards the served WIC.

15) SDP Capability Negotiation:
The attributes of "a=acap", "a=tcap", "a=pcfg" and "a=acfg" (see IETF RFC 5939 [72]) may be provided in the local descriptor and/or remote descriptor.

16) Rate adaptation for media endpoints:
If the IMS-AGW performs media transcoding and if the rate adaptation for media endpoints using the enhanced bandwidth negotiation is supported by the IMS-AGW, attribute(s) "a=bw-info" with direction "send" or "sendrecv" may be provided for an m-line and the selected IP payload type and applicable IP version in the remote descriptor.
The following bandwidth properties, as defined in 3GPP TS 26.114 [26], clause 19, may be included in "a=bw-info" line:
<payload type> <dir> <MaxSupBw>, <MaxDesBw>, <MinDesBw>, <MinSupBw> and <IpVer>.

17) "RTCP-level pause and resume" signalling:
The "rtcp-fb" SDP attribute with the "ccm" feedback parameter and the "pause" ccm parameter as defined in IETF RFC 7728 [79] may be provided for an m-line in the local and remote descriptor to indicate that the IMS-AGW shall forward RTCP feedback "CCM PAUSE-RESUME" messages transparently.

18) "RTCP Codec Control Commands and Indications" signalling:
The "rtcp-fb" SDP attribute with the "ccm" feedback parameter and the "fir" and/or "tmmbr" ccm parameters as defined in IETF RFC 5104 [78] may be provided for an m-line in the local and remote descriptor to indicate that the IMS-AGW shall be prepared to receive and is allowed to send, respectively, the RTCP CCM feedback messages FIR, and/or TMMBR and TMMBN.

19) DBI signalling:
The "rtcp-fb" SDP attribute with the "3gpp-delay-budget" feedback parameter (as defined in 3GPP TS 26.114 [26] clause 6.2.8) may be provided for an m-line in the local and remote descriptor to indicate that the IMS-AGW shall forward RTCP feedback "DBI" messages (as defined in 3GPP TS 26.114 [26] clause 7.3.8) transparently.

| +| NOTE 1: Media Interworking is optional. | | | +| NOTE 2: Table 1 in ITU-T Recommendation H.248.57 [5] provides the correspondent RTCP port allocation rules. | | | +| NOTE 3: See IETF RFC 8873 [70] for WebRTC data application 'MSRP'. | | | + +Editor's Note: The support for video transcoding is required for vSRVCC but should be changed from Rel-11, separate CRs would be required for this change. + +## 5.17 Procedures + +### 5.17.1 Formats and Codes + +Table 5.17.1.1 shows the parameters which are required for the procedures defined in the following clauses. + +The coding rules applied in ITU-T Recommendation H.248.1 [10] for the applicable coding technique shall be followed for the UMTS capability set. + +The binary encoding rules which are applicable to the defined Abstract Syntaxes are the Basic Encoding Rules for Abstract Syntax Notation One, defined in ITU-T Recommendation X.690 [22]. Specifically in accordance with ITU-T Recommendation X.690 [22] clause 7.3, alternative encodings based on the definite and indefinite form of length are permitted by the basic encoding rules as a sender's option. Receivers shall support both alternatives. + +Unsupported values of parameters or properties may be reported by the IMS-AGW and shall be supported by the IMS-ALG as such by using H.248.1 error code #449 "Unsupported or Unknown Parameter or Property Value ". The unsupported or unknown value is included in the error text in the error descriptor. + +Table 5.17.1.1: Information Elements Used in Procedures + +| Signalling Object | H.248 Descriptor | Coding | +|------------------------------------------------------------------|---------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Additional Bandwidth Properties | Remote Descriptor | The "a=bw-info" SDP attribute defined in 3GPP TS 26.114 [26], see table 5.16.1. | +| Allowed RTCP APP message types | Remote Descriptor | The "a=3gpp_mtsi_app_adapt" SDP attribute defined in 3GPP TS 26.114 [26]. | +| Alternate MGC Id | ServiceChange | The MGCIIdToTry parameter in ITU-T Recommendation H.248.1 [10]. | +| Arbitrary ROI | Local Descriptor or Remote Descriptor | The "rtcp-fb" SDP attribute defined in IETF RFC 4585 [21] to indicate the "Arbitrary ROI" RTCP feedback message expressed by the "3gpp-roi-arbitrary" parameter, as described in 3GPP TS 26.114 [26]. | +| Available Realms | Termination State | According to Available Realms property in ITU-T Recommendation H.248.41 [8]. | +| Application-aware MSRP interworking request | LocalControl | This is the ptbalg property from ITU-T Recommendation H.248.78 [56] concerning the configuration of a B-ALG service (for MSRP traffic). | +| BNC Release | Events, ObservedEvents | As for the Events/ObservedEvents Descriptor in clause E.1.2.1/ ITU-T Recommendation H.248.1 [10] "Cause" | +| CCM BASE | Local Descriptor or Remote Descriptor | "rtcp-fb" SDP attribute (defined in IETF RFC 4585 [25]) with the "ccm" feedback parameter and the "fir" and/or "tmmbr" ccm parameters as defined in IETF RFC 5104 [78]. | +| CCM pause-resume | Local Descriptor or Remote Descriptor | "rtcp-fb" SDP attribute (defined in IETF RFC 4585 [25]) with the "ccm" feedback parameter (defined in IETF RFC 5104 [78]) and the "pause" ccm parameter as defined in IETF RFC 7728 [79]. | +| Cause | ObservedEvents | As for the ObservedEvent Parameter in clause E.1.2.1/ ITU-T Recommendation H.248.1 [10] "General cause" | +| Changed Realms | Observed Events | According to Observed Events Parameters for Available Realms Changed event in ITU-T Recommendation H.248.41 [8]. | +| Codec List | Local Descriptor or Remote Descriptor | in a single SDP m-line.
For a static RTP payload type, the codec type should be implied by the RTP payload type, if not then each codec type shall be provided in a separate SDP "a=rtpmap"-line and possibly additional SDP "a=fmtp"-line(s).
For a dynamic RTP payload type, for each codec information on the codec type shall be provided in a separate SDP "a=rtpmap"-line and possibly additional SDP "a=fmtp"-line(s). | +| Connectivity Mode | LocalControl | ITU-T Recommendation H.248.1 [10] Mode property.
Binary Encoding: Encoding as per ITU-T Recommendation H.248.1 Annex A [10] "streamMode"
Textual Encoding: Encoding as per ITU-T Recommendation H.248.1 Annex B [10] "streamMode". | +| Context ID | NA | Binary Encoding: As per ITU-T Recommendation H.248.1 [10] Annex A.
Textual Encoding: As per ITU-T Recommendation H.248.1 [10] Annex B. | +| Cryptographic SDES Attribute | Local Descriptor or Remote Descriptor | "crypto" attribute in SDP a-line as defined in IETF RFC 4568 [29], see 5.16 | +| Delay Variation Tolerance | LocalControl | This is the tman/dvt property from ITU-T Recommendation H.248.53 [7]. | +| Diffserv Code Point | LocalControl | Defined according to the Differentiated Services Code Point property in ITU-T Recommendation H.248.52 [12]. | +| Diffserv Tagging Behaviour | LocalControl | Defined according to the Tagging Behaviour property in ITU-T Recommendation H.248.52 [12]. | +| Discard Incoming TCP Connection Establishment Requests Indicator | LocalControl | Defined according to the Incoming bearer connection establishment blocking property ( tcpbcc/bceb ) in ITU-T Recommendation H.248.89 [47]. | +| ECN Enabled | Local Descriptor or Remote Descriptor | Defined according to the "ECN Enabled" property in ITU-T Recommendation H.248.82 [40]. | +| DBI | Local Descriptor or Remote Descriptor | "rtcp-fb" SDP attribute defined in IETF RFC 4585 [25] with the "3gpp-delay-budget" feedback parameter (as defined in 3GPP TS 26.114 [26] clause 6.2.8). | +| ECN Failure | Events, Observed Events | Defined according to the "ECN Failure" Event in ITU-T Recommendation H.248.82 [40]. | +| ECN Failure Type | ObservedEvents | As for the ObservedEventsDescriptor Parameter "Failure Type" in | + +| | | | +|------------------------------------------------------------------|---------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | Descriptor | ITU-T Recommendation H.248.82 [40]. | +| ECN Initiation Method | Local Descriptor or Remote Descriptor | Defined according to "Initiation Method" property in ITU-T Recommendation H.248.82 [40]. | +| Emergency Call Indication | NA | ITU-T Recommendation H.248.1 [10] 6.1.1 Emergency Call Indicator Binary Encoding: Encoding as per ITU-T Recommendation H.248.1 [10] Annex A "Emergency" context attribute
Textual Encoding: Encoding as per ITU-T Recommendation H.248.1 [10] Annex B "EmergencyToken" context attribute | +| Establish (D)TLS session | Signals | Defined according to the Establish BNC signal ( tlsbsc/EstBNC ) in ITU-T Recommendation H.248.90 [48]. | +| Extended Header For CVO | Local Descriptor or Remote Descriptor | "extmap" attribute in SDP a-line as defined in IETF RFC 5285 [41], see 5.16 | +| Extended RTP Header for Sent ROI | Local Descriptor or Remote Descriptor | "extmap" attribute in SDP a-line to pass on the ROI extended RTP header as defined by IETF RFC 5285 [41] for carriage of predefined and/or arbitrary ROI information, see 5.16 | +| Forward Incoming TCP Connection Establishment Requests Indicator | LocalControl | Defined according to the Interlinkage topology property ( seplink/linktopo ) in ITU-T Recommendation H.248.93 [50]. | +| Generic Image Attribute | Local Descriptor or Remote Descriptor | "imageattr" attribute in SDP a-line as defined in IETF RFC 6236 [46], see table 5.16.1. | +| ICE host candidate request | Local Descriptor | The "a=candidate" SDP attribute defined in IETF RFC 5245 [44] of type "host" with the transport, port and priority parameters with wildcard sign "\$" to request the allocation of a host candidate | +| ICE host candidate | Local Descriptor | The "a=candidate" SDP attribute defined in IETF RFC 5245 [44] | +| ICE lite indication | Local Descriptor | The "a=ice-lite" SDP attribute defined in IETF RFC 5245 [44]. | +| ICE password request | Local Descriptor | The "a=ice-pwd" SDP attribute defined in IETF RFC 5245 [44] with wildcard sign "\$". | +| ICE password | Local Descriptor | The "a=ice-pwd" SDP attribute defined in IETF RFC 5245 [44]. | +| ICE received candidate | Remote Descriptor | The "a=candidate" SDP attribute defined in IETF RFC 5245 [44] | +| ICE received password | Remote Descriptor | The "a=ice-pwd" SDP attribute defined in IETF RFC 5245 [44]. | +| ICE received Ufrag | Remote Descriptor | The "a=ice-ufrag" SDP attribute defined in IETF RFC 5245 [44]. | +| ICE Ufrag request | Local Descriptor | The "a=ice-ufrag" SDP attribute defined in IETF RFC 5245 [44] with wildcard sign "\$". | +| ICE Ufrag | Local Descriptor | The "a=ice-ufrag" SDP attribute defined in IETF RFC 5245 [44]. | +| ICE Connectivity Check Result | Events, Observed Events | Defined according to Connectivity Check Result event in ITU-T Recommendation H.248.50 [43]. | +| ICE Send Connectivity Check | Signals | Defined as the ostuncc/scc signal in ITU-T Recommendation H.248.50 [43]. | +| ICE New Peer Reflexive Candidate | Events, Observed Events | Defined according to New Peer Reflexive Candidate event in ITU-T Recommendation H.248.50 [43], only applicable for full ICE. | +| ICE Send Additional Connectivity Check | Signals | Defined as the ostuncc/sacc signal in ITU-T Recommendation H.248.50 [43], only applicable for full ICE. | +| Consent freshness test request | Signals | Defined according to stnconfres/contest signal in ITU-T Recommendation H.248.50 [43]. | +| STUN consent freshness test failure | Events, Observed Events | Defined according to stnconfres/confail event in ITU-T Recommendation H.248.50 [43]. | +| Inactivity Timer | Events, Observed Events | Defined according to Inactivity Timeout event in ITU-T Recommendation H.248.14 [11]. | +| IP Address | Local Descriptor or Remote Descriptor | in SDP "c-line" | +| IP Realm | LocalControl | According to IP Realm Identifier property in ITU-T Recommendation H.248.41 [8]. | +| IP Version | Local Descriptor or Remote Descriptor |
in SDP "c-line", see 5.15 | +| Latching | Signals | This is the ipnapt/latch signal in ITU-T Recommendation H.248.37 [4]. | +| Local certificate fingerprint | Local Descriptor | "fingerprint" attribute in SDP "a=" line as defined in IETF RFC 8122 [55] see table 5.16.1. | +| Local certificate fingerprint Request | Local Descriptor | "fingerprint" attribute in SDP "a=" line as defined in IETF RFC 8122 [55] with wildcard choose "\$". | +| Local Dcmmap | Local Descriptor | The SDP attribute "a=dcmmap" (see IETF RFC 8864 [69]). | +| Local Dcsa | Local Descriptor | The SDP attribute "a=dcsa" (see IETF RFC 8864 [69]). | +| Local SCTP maximum message size Request | Local Descriptor | The SDP attribute "a= max-message-size" (see IETF RFC 8841 [68]) with wildcard sign "\$". | +| Local SCTP maximum | Local Descriptor | The SDP attribute "a= max-message-size" (see | + +| | | | +|---------------------------------------------------|---------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| message size | | IETF RFC 8841 [68]) | +| Local SCTP Port Request | Local Descriptor | The SDP attribute "a= sctp-port" (see IETF RFC 8841 [68]) with omission sign "-" to indicate that the same port as for UDP shall be used. | +| Local SCTP Port | Local Descriptor | The SDP attribute "a= sctp-port" (see IETF RFC 8841 [68]) | +| Maximum Burst Size | LocalControl | This is the tman/mbs property from ITU-T Recommendation H.248.53 [7] | +| Media Inactivity Detection | Events, Observed Events | Defined according to ipstop event in ITU-T Recommendation H.248.40 [24]. | +| Media Inactivity Detection Time | Events | As for the Event Parameter in ITU-T Recommendation H.248.40 [24] "Detection Time" | +| Media Inactivity Detection Direction | Events | As for the Event Parameter in ITU-T Recommendation H.248.40 [24] "Direction" | +| Media Type | Local Descriptor or Remote Descriptor | in SDP m-line "audio" or "video" or "-" | +| MSRP Path | Remote Descriptor | The "a=path" SDP attribute defined in IETF RFC 4975 [18]. | +| Notify (D)TLS session establishment Failure Event | ObservedEvents | As for the ObservedEvent Parameter in clause E.1.2.1/ ITU-T Recommendation H.248.1 [10] "General cause" | +| Notify TCP Connection Establishment Failure Event | ObservedEvents | As for the ObservedEvent Parameter in clause E.1.2.1/ ITU-T Recommendation H.248.1 [10] "General cause" | +| Overload Notification | Events, ObservedEvents | This is the chp/mgcon event from ITU-T Recommendation H.248.10 [14] or the ocp/mg_overload event from ITU-T Recommendation H.248.11 [13]. | +| Peak Data Rate | LocalControl | This is the tman/pdr property from ITU-T Recommendation H.248.53 [7]. | +| Policing Required | LocalControl | This is the tman/pol property from ITU-T Recommendation H.248.53 [7]. | +| Port | Local Descriptor or Remote Descriptor | in SDP m-line. | +| Predefined ROI | Local Descriptor or Remote Descriptor | The "rtcp-fb" SDP attribute defined in IETF RFC 4585 [25] to indicate the "Predefined ROI" RTCP feedback message expressed by the "3gpp-roipredefined" parameter, as described in 3GPP TS 26.114 [26]. | +| Priority Information | NA | Priority Indicator (clause 6.1.1 of ITU-T Recommendation H.248.1 [10])
Binary Encoding: Encoding as per ITU-T Recommendation H.248.1 [10] Annex A "priority" context attribute
Textual Encoding: Encoding as per ITU-T Recommendation H.248.1 [10] Annex B "priority" context attribute | +| Realm Availability Change | Events, Observed Events | According to Available Realms Changed event in ITU-T Recommendation H.248.41 [8]. | +| Received SCTP Stream Reset Request | Events, ObservedEvents | Defined according to the Detect outgoing SCTP Stream reset event ( sctpreset/detreset ) in ITU-T Recommendation H.248.97 [66]. | +| Received SCTP Stream Reset Response | Events, ObservedEvents | Defined according to the Outgoing SCTP Stream reset result event ( sctpreset/result ) in ITU-T Recommendation H.248.97 [66]. | +| Reduction | ObservedEvent Descriptor | As for the ObserverdEventDescriptor in clause 4.2.1/ ITU-T Recommendation H.248.10 [14] "MGCongestion". | +| Release (D)TLS session | Signals | Defined according to the Release BNC signal ( tlbsbc/RelBNC ) in ITU-T Recommendation H.248.90 [48]. | +| Remote certificate fingerprint | Remote Descriptor | "fingerprint" attribute in SDP "a="-line as defined in IETF RFC 8122 [55], see table 5.16.1. | +| Remote Dcmap | Remote Descriptor | The SDP attribute "a=dcmmap" (see IETF RFC 8864 [69]). | +| Remote Dcsa | Remote Descriptor | The SDP attribute "a=dcsa" (see IETF RFC 8864 [69]). | +| Remote SCTP maximum message size | RemoteDescriptor | The SDP attribute "a= max-message-size" (see IETF RFC 8841 [68]) | +| Remote SCTP Port | Remote Descriptor | The SDP attribute "a= sctp-port" (see IETF RFC 8841 [68]) | +| Remote Source Address Filtering | LocalControl | Defined according to Remote Source Address Filtering property in ITU-T Recommendation H.248.43 [6]. | +| Remote Source Address Mask | LocalControl | Defined according to Remote Source Address Mask property in ITU-T Recommendation H.248.43 [6]. | +| Remote Source Port Filtering | LocalControl | Defined according to Remote Source Port Filtering property in ITU-T Recommendation H.248.43 [6]. | +| Remote Source Port | LocalControl | Defined according to Remote Source Port property in ITU-T Recommendation H.248.43 [6]. | + +| | | | +|--------------------------------------------------------|---------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Remote Source Port Range | LocalControl | Defined according to Remote Source Port Range property in ITU-T Recommendation H.248.43 [6]. | +| Reserve_Value | LocalControl | ITU-T Recommendation H.248.1 [10] Reserve property.
Binary Encoding: Encoding as per ITU-T Recommendation H.248.1 [10] Annex A "reserveValue "
Textual Encoding: Encoding as per ITU-T Recommendation H.248.1 [10] Annex B "reservedValueMode". | +| ROOT Properties | Termination State | The properties in clause E.2.1/ ITU-T Recommendation H.248.1 [10] | +| RTCP allocation ((NOTE 1) | Local Control | Defined according to RTCP Allocation Specific Behaviour property in ITU-T Recommendation H.248.57 [5]. | +| RTP/RTCP transport multiplexing | Local Descriptor or Remote Descriptor | The SDP attribute "a=rtcp-mux" according to IETF RFC 5761 [59]. (NOTE 2) | +| explicit RTCP transport address | Remote Descriptor | The SDP attribute "a=rtcp:" according to IETF RFC 3605 [21]. | +| RtcpbwRR | Local Descriptor or Remote Descriptor | in SDP "b:RR"-line. see 5.15 | +| RtcpbwRS | Local Descriptor or Remote Descriptor | in SDP "b:RS"-line. see 5.15 | +| Rtpbw | Local Descriptor or Remote Descriptor | in SDP "b:AS"-line. see 5.15 | +| RTPpayload | Local Descriptor or Remote Descriptor | in SDP m-line. This may be set to CHOOSE (\$) in a LD sent from the IMS-ALG toward the IMS-AGW. | +| SCTP Group Semantics | Termination State | Group Semantics (mgroup/groupse) defined in ITU-T Recommendation H.248.96 [65] with semantics "SCTP" defined in ITU-T Recommendation H.248.97 [66] | +| SCTP stream deaggregation | LocalControl | Stream Deaggregation (mgroup/strdeagg) related semantics "SCTP" defined in ITU-T Recommendation H.248.96 [65] | +| SCTP stream ID | LocalControl | SCTP StreamID (sctpbcc/sctpid) defined in ITU-T Recommendation H.248.97 [66] | +| SDPCapNeg configuration | Local Descriptor or Remote Descriptor | The SDP attributes for SDP capability negotiation as defined in IETF RFC 5939 [72]. | +| SDPCapNeg Supported Capabilities | Termination State | Defined according to SDPCapNeg Extensions property in ITU-T Recommendation H.248.80 [73]. | +| Send SCTP Association Establishment Requests Indicator | Signals | Defined according to the Establish BNC signal ( sctpbcc/EstBNC ) in ITU-T Recommendation H.248.97 [66]. | +| Send SCTP Stream Reset Requests Indicator | Signals | Defined according to the Initiate Outgoing SCTP Stream Reset signal ( sctpres/Initreset ) in ITU-T Recommendation H.248.97 [66]. | +| Send SCTP Stream Reset Response Indicator | Signals | Defined according to the Outgoing SCTP Stream Reset Response signal ( sctpres/resetresp ) in ITU-T Recommendation H.248.97 [66]. | +| Send TCP Connection Establishment Requests Indicator | Signals | Defined according to the Establish BNC signal ( tcpbcc/EstBNC ) in ITU-T Recommendation H.248.89 [47]. | +| Stream Number | Stream | Encoding as per ITU-T Recommendation H.248.1 [10] Annex B "Stream"/"ST".
For a single stream, this may be omitted by the IMS-ALG. | +| STUN server request | LocalControl | Encoding as per ITU-T Recommendation H.248.50 [43] "MG Act-as STUN Server" (mgastuns) package "Act-as STUN Server" (astuns, 0x0001) property. | +| Sustainable Data Rate | LocalControl | This is the tman/sdr property from ITU-T Recommendation H.248.53 [7]. | +| TCP State-aware Handling Indicator and Setup Direction | Local Descriptor or Remote Descriptor | The "a=setup" SDP attribute as per clause 13.5.1 of ITU-T Recommendation H.248.84 [46]. | +| Termination heartbeat | Events ObservedEvents | As per Termination Heartbeat defined in ITU-T Recommendation H.248.36 [9] Clause 5.2.1. | +| Termination ID | NA | Binary Encoding: As per ITU-T Recommendation H.248.1 [10] Annex A.
Textual Encoding: As per ITU-T Recommendation H.248.1 [10] Annex B. | +| Transaction ID | NA | Binary Encoding: As per ITU-T Recommendation H.248.1 [10] Annex A.
Textual Encoding: As per ITU-T Recommendation H.248.1 [10] Annex B. | + +| | | | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------|-------------------------------------| +| Transport | Local Descriptor or Remote Descriptor | in SDP m-line, see 5.15 | +| NOTE 1: Signalling element "RTCP allocation" corresponds to the stage 2 information element "RTCP handling".
NOTE 2: RTP/RTCP transport multiplexing can be agreed with the served UE using the SDP attribute(s) "a=rtcp-mux" and/or "a=rtcp-mux-only" (defined in IETF RFC 8858 [74]), see 3GPP TS 23.334 [23]. However, the SDP attribute "rtcp-mux-only" is not used on Iq interface. | | | + +### 5.17.2 Call Related Procedures + +#### 5.17.2.1 General + +This clause describes the various call related procedures performed by the IMS-AGW, which are listed in table 5.17.2.1.1 + +**Table 5.17.2.1.1: IMS-AGW Call Related Procedures** + +| Transaction defined in 3GPP TS 23.334 [23] | Supported | Comment | +|--------------------------------------------------------|-----------|----------------------------------------------------------------------------------------| +| Reserve AGW Connection Point | Mandatory | See 5.17.2.2 | +| Configure AGW Connection Point | Mandatory | See 5.17.2.3 | +| Reserve and Configure AGW Connection Point | Mandatory | See 5.17.2.4 | +| Release AGW Termination | Mandatory | See 5.17.2.5 | +| Termination Heartbeat Indication | Mandatory | See 5.17.2.6 | +| IP Bearer Released | Mandatory | See 5.17.2.7 | +| Media Inactivity Notification | Optional | See 5.17.2.8 | +| Change Through Connection | Mandatory | See 5.17.2.9 | +| Change Flow Direction | Optional | See 5.17.2.10. | +| ECN Failure Indication | Optional | See 5.17.2.11
Only applicable if ECN endpoint capability is supported | +| ICE Connectivity Check Result Notification | Optional | See 5.17.2.12
Only applicable if full ICE is supported | +| ICE New Peer Reflexive Candidate Notification | Optional | See 5.17.2.13
Only applicable if full ICE is supported | +| Notify TCP connection establishment Failure Indication | Optional | See 5.17.2.14
Only applicable if state-aware TCP handling (proxy mode) is supported | +| Notify (D)TLS session establishment Failure Indication | Optional | See 5.17.2.15
Only applicable if IMS media security for TCP and/or UDP is supported | +| Notify SCTP Stream Reset | Optional | See 5.17.2.17
Only applicable if WebRTC data channels are supported | +| Notify SCTP Stream Reset Result | Optional | See 5.17.2.18
Only applicable if WebRTC data channels are supported | + +#### 5.17.2.2 Reserve AGW Connection Point + +The IMS-ALG sends an ADD request command as in Table 5.17.2.2.1. + +Table 5.17.2.2.1: Reserve AGW Connection Point Request + +| Address Information | Control information | Bearer information | +|--------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Local Descriptor {
Port = \$
IP Address = \$
IP Version = IPv4 or IPv6
} | Transaction ID = x
If Context Requested:
Context ID= \$
If Emergency Call:
Emergency Call Indication

If MPS call/session:
Priority Indicator = x

If Context Provided:
Context ID = c1

Termination ID = \$
If Stream Number specified:-
Stream Number
If Resources for multiple Codecs required:
Reserve_Value

If IP Interface Type:
IP interface = "IP interface type"

If indication on Bearer Released requested:
NotificationRequested (Event ID = x, "BNC Release")

If diffserv required:-
Diffserv Code Point
If tagging behaviour
Diffserv Tagging Behaviour

If Remote Source Address Filtering required:-
Remote Source Address Filtering
If Remote Source Address range required:
Remote Source Address Mask

If Remote Source Port Filtering required:-
Remote Source Port Filtering
If individual port:
Remote Source Port
If range of ports
Remote Source Port Range

NotificationRequested (Event ID = x, "termination heartbeat")

If IP Realm specified:-
IP Realm

If Latching Required:-
Latching

If Sustainable Data Rate Policing Required:-
Policing Required
Sustainable Data Rate
Maximum Burst Size

If Peak Data Rate Policing Required:
Policing Required | Local Descriptor {
If media is "audio" or "video":
Codec List = Codec List
RTP Payloads = RTP Payload
Rtpbw
If RTCP bandwidth
RtcpbwRS
RtcpbwRR
If RTCP handling required:
RTP/RTCP transport multiplexing (NOTE 5)
If IMS media plane security required:
Cryptographic SDES Attribute

If media is "video":
If CVO required:
Extended Header For CVO (NOTE3)
If imageattr negotiation:
Generic Image Attribute (NOTE 4)
If Predefined ROI required:
RTCP feedback for Predefined ROI
Extended Header for Sent ROI
If Arbitrary ROI required:
RTCP feedback for Arbitrary ROI
Extended Header for Sent ROI

If ICE is applied:
ICE host candidate request
ICE password request
ICE Ufrag request
If STUN consent freshness test required:
STUN consent freshness request
NotificationRequested(Event ID= x, "STUN consent freshness test failure")

If media is "message" or "application" or "-":
If IMS media plane security required:
Local certificate fingerprint Request
If TCP state-aware handling required:
TCP State-aware Handling Indicator and Setup Direction

If SCTP association for WebRTC data channels:
Local SCTP Port Request
Local SCTP maximum message size Request
Local Dcmmap
If application aware interworking
Local Dcsa

If SDPCapNeg is signalled to the gateway:
SDPCapNeg configuration | + +| | | | +|--|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---| +| | Peak Data Rate
If Delay Variation Required
Delay Variation Tolerance

If Media Inactivity Detection Required:
NotificationRequested (Event ID = x, "Media Inactivity Detection( Media Inactivity Detection Time, Media Inactivity Detection Direction) ") (NOTE 1)

If RTCP handling required:
RTCP allocation

If ECN transparent support required:
ECN Enable = "True"
Initiation Method = "inactive"

If ECN Endpoint support required
ECN Enable = "True"
Initiation Method = "ECN Initiation Method" (NOTE 2)

If notification of ECN Failure Report:
NotificationRequested (Event ID = x, "ECN Failure")

If ICE is applied:
STUN server request

If Discard Incoming TCP connection establishment request required:
Discard Incoming TCP Connection Establishment Requests Indicator

If Forward Incoming TCP connection establishment request required:
Forward Incoming TCP Connection Establishment Requests Indicator

If indication on TCP connection establishment failure requested:
NotificationRequested (Event ID = x, "TCP connection establishment failure")

If (D)TLS session establishment required:
Establish (D)TLS session

If indication on (D)TLS session establishment failure requested:
NotificationRequested (Event ID = x, "(D)TLS session establishment failure")

If media is "message":
If B-ALG for MSRP required:
Application-aware MSRP interworking request

If SCTP association for WebRTC data channels:
SCTP Group Semantics | } | +|--|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---| + +| | | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------|--| +| | SCTP stream deaggregation
SCTP stream ID
NotificationRequested
(Event ID = x,
"Received SCTP Stream Reset
Request") | | +| NOTE 1: The event parameters "Media Inactivity Detection Time" and "Media Inactivity Detection Direction" are optional.
NOTE 2: This shall be set to a value other than "inactive". See Table 5.14.3.15.1.
NOTE 3: If the IMS-AGW supports the extended RTP header with Coordination of Video Orientation information it shall pass any received extended RTP header with CVO bits on to outgoing RTP streams. If the IMS-AGW is transcoding between video payloads and it supports the extended RTP header with Coordination of Video Orientation information it shall convey received RTP header bytes on the outgoing RTP stream after transcoding associated packets as specified in 3GPP TS 26.114 [26], clause 7.4.5.
NOTE 4: The support of the generic image attributes is optional for the IMS-AGW. The list of image sizes per payload type supported by the IMS-AGW is preconfigured in the IMS-ALG. If none of the image sizes received within an SDP body on Mx/Mw interface is supported by the IMS-AGW then the IMS-ALG will not send the generic image attribute parameter to the IMS-AGW.
NOTE 5: This element is optional. The RTCP port allocation rules are specified in tables 4/1 to 4/5 in ITU-T Recommendation H.248.57 [5]. | | | + +On reserving the termination, the IMS-AGW responds as in Table 5.17.2.2.2. + +Table 5.17.2.2.2: Reserve AGW Connection Point Acknowledge + +| Address Information | Control information | Bearer information | +|-------------------------------------------------------------|-------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Local Descriptor {
Port
IP Address
IP Version
} | Transaction ID = x
Context ID = C1
Termination ID = T1
Stream Number | Local Descriptor {
If media is "audio" or "video":

Codec List
RTP Payloads
Rtpbw
If RTCP bandwidth
RtcpbwRS
RtcpbwRR
If IMS media plane security was provided in the request:
Cryptographic SDES Attribute

If media is "video":
If CVO extension header provided in the request:
Extended Header For CVO
If image attribute negotiation:
Generic Image Attribute
If Predefined ROI provided in the request:
RTCP feedback for Predefined ROI
Extended Header for Sent ROI
If Arbitrary ROI provided in the request:
RTCP feedback for Arbitrary ROI
Extended Header for Sent ROI

If ICE is applied:
ICE host candidate
ICE password
ICE Ufrag
If ICE lite implementation
ICE lite indication

If media is "message" or "application" or "-":
If Local certificate fingerprint was requested:
Local certificate fingerprint

If SCTP association for WebRTC data channels:
Local SCTP Port
Local SCTP maximum message size

If SDPCapNeg is signalled to the gateway:
SDPCapNeg configuration
} | + +#### 5.17.2.3 Configure AGW Connection Point + +This procedure is used to configure the AGW connection point during session establishment or to reconfigure it during session establishment or after the session is established + +The IMS-ALG sends a MODIFY request command as in Table 5.17.2.3.1. + +Table 5.17.2.3.1: Configure AGW Connection Point Request + +| Address Information | Control information | Bearer information | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| If local resources are modified:
Local Descriptor {
Port
IP Address
IP Version
}
If remote resources are modified:
Remote Descriptor {
Port
IP Address
IP Version
} | Transaction ID = x
Context ID = C1
Termination ID = T1

If MPS priority is modified:
Priority Indicator = x (NOTE 4)

If Stream Number specified:
Stream Number

If Resources for multiple Codecs required:
Reserve_Value

If diffserv required:-
Diffserv Code Point
If tagging behaviour
Diffserv Tagging Behaviour

If Remote Source Address Filtering required:-
Remote Source Address Filtering
If Remote Source Address range required:
Remote Source Address Mask

If Remote Source Port Filtering required:-
Remote Source Port Filtering
If individual port:
Remote Source Port
If range of ports
Remote Source Port Range

NotificationRequested (Event ID = x, "termination heartbeat")

If IP Realm specified:-
IP Realm (NOTE 1)

If Latching Required:-
Latching

If Sustainable Data Rate Policing Required:-
Policing Required
Sustainable Data Rate
Maximum Burst Size

If Peak Data Rate Policing Required:
Policing Required
Peak Data Rate
If Delay Variation Required
Delay Variation Tolerance

If Media Inactivity Detection Required:
NotificationRequested (Event ID = x, "Media Inactivity Detection( Media Inactivity Detection Time, Media Inactivity Detection Direction)") (NOTE 2)

If RTCP handling required: | If local resources are modified:
Local Descriptor {
If media is "audio" or "video":
Codec List
RTP Payloads
Rtpbw
If RTCP bandwidth
RtcpbwRS
RtcpbwRR
If RTCP handling required:
RTP/RTCP transport multiplexing (NOTE 9)
If IMS media plane security required:
Cryptographic SDES Attribute
If RTP-level pause and resume:
CCM pause-resume
If RTCP Codec Control
Commands and Indications:
CCM BASE
If RTCP Delay Budget Information:
DBI

If media is "video":
If CVO required:
Extended Header For CVO (NOTE 5)
If imageattr negotiation:
Generic Image Attribute (NOTE 6)
If Predefined ROI required:
RTCP feedback for Predefined ROI
Extended Header for Sent ROI
If Arbitrary ROI required:
RTCP feedback for Arbitrary ROI
Extended Header for Sent ROI

If TCP state-aware handling required:
TCP State-aware Handling Indicator and Setup Direction

If SCTP association for WebRTC data channels:
Local Dcmapping
If application aware interworking
Local Dcsa

If SDPCapNeg is signalled to the gateway:
SDPCapNeg configuration
}

If remote resources are modified:
Remote Descriptor {
If media is "audio" or "video":
Codec List
RTP Payloads
Rtpbw
If rate adaptation for media endpoints:
Additional Bandwidth Properties (NOTE 10) | + +| | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| RTCP allocation | If RTCP bandwidth
RtcpbwRS
RtcpbwRR
If RTCP handling required:
RTP/RTCP transport multiplexing
(NOTE 9)
If RTCP handling required:
explicit RTCP transport address
(NOTE 8)
If IMS media plane security
required:
Cryptographic SDES Attribute
If RTP-level pause and resume:
CCM pause-resume
If RTCP APP messages allowed
Allowed RTCP APP message
Types
If RTCP Codec Control
Commands and Indications:
CCM BASE
If RTCP Delay Budget Information:
DBI | +| If ECN transparent support required:
ECN Enable = "True"
Initiation Method = "inactive" | | +| If ECN Endpoint support required
ECN Enable = "True"
Initiation Method = "ECN Initiation
Method" (NOTE 3) | | +| If notification of ECN Failure
Report:
NotificationRequested (Event
ID
= x,"ECN Failure") | | +| If full ICE is applied:
Send Connectivity Check
("Control")
If notification of ICE Connectivity
Check Result Report:
NotificationRequested (Event
ID= xx,
"Connectivity Check Result")
If notification of New Peer
Reflexive Candidate:
NotificationRequested (Event
ID
= xy,"New Peer Reflexive
Candidate")
Send Additional Connectivity
Check ("Control") | If media is "message" or
"application" or "-":
If IMS media plane security
required:
Remote certificate fingerprint
If media is "video":
If CVO required:
Extended Header For CVO
(NOTE 5)
If imageattr negotiation:
Generic Image Attribute
(NOTE 6)
If Predefined ROI required:
RTCP feedback for Predefined
ROI
Extended Header for Sent ROI
If Arbitrary ROI required:
RTCP feedback for Arbitrary ROI
Extended Header for Sent ROI | +| If Discard Incoming TCP connection
establishment request required:
Discard Incoming TCP Connection
Establishment Requests Indicator | | +| If Forward Incoming TCP connection
establishment request required:
Forward Incoming TCP
Connection Establishment Requests
Indicator | | +| If TCP connection establishment
required:
Send TCP Connection
Establishment Request Indicator | If media is "message":
If B-ALG for MSRP required:
MSRP Path | +| If indication on TCP connection
establishment failure requested:
NotificationRequested (Event ID =
x, "TCP connection establishment
failure") | If ICE is applied:
ICE received candidate
ICE received password
ICE received Ufrag
(NOTE 7)
If STUN consent freshness test
required:
STUN consent freshness request
NotificationRequested(Event ID=
x, "STUN consent freshness test
failure") | +| If (D)TLS session establishment
required:
Establish (D)TLS session | If TCP state-aware handling
required:
TCP State-aware Handling
Indicator and Setup Direction | +| If indication on (D)TLS session
establishment failure requested:
NotificationRequested (Event ID =
x, "(D)TLS session establishment
failure") | If SCTP association for WebRTC
data channels:
Remote SCTP Port
Remote SCTP maximum message | +| If (D)TLS session release required:
Release (D)TLS session | | + +| | | | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| |

If media is "message":
If B-ALG for MSRP required:
Application-aware MSRP interworking request

If SCTP association for WebRTC data channels:
SCTP Group Semantics
SCTP stream deaggregation
SCTP stream ID
NotificationRequested
(Event ID = x,
"Received SCTP Stream Reset Response")

If reset of SCTP Stream for WebRTC data channels:
Send SCTP Stream Reset
Requests Indicator
If Notification of reset result desired:
NotificationRequested
(Event ID = x,
"Received SCTP Stream Reset Response")

|

size
Remote Dcmapping
If application aware interworking
Remote Dcsa

If SDPCapNeg is signalled to the gateway:
SDPCapNeg configuration

}

| +|

NOTE 1: This can only be set to the same realm as at the reservation stage. If a different realm is specified, the IMS-AGW shall return error 501 "Not Implemented".

NOTE 2: The event parameters "Media Inactivity Detection Time" and "Media Inactivity Detection Direction" are optional.

NOTE 3: This shall be set to a value other than "inactive". See Table 5.14.3.15.1.

NOTE 4: The support of the modification of the Priority Indicator value is optional for the IMS-AGW and depends on implementation solution for Priority call/session authorisation (see 3GPP TS 23.334 [23]).

NOTE 5: If the IMS-AGW supports the extended RTP header with Coordination of Video Orientation information it shall pass any received extended RTP header with CVO bits on to outgoing RTP streams. If the IMS-AGW is transcoding between video payloads and it supports the extended RTP header with Coordination of Video Orientation information it shall convey received RTP header bytes on the outgoing RTP stream after transcoding associated packets as specified in 3GPP TS 26.114 [26], clause 7.4.5.

NOTE 6: The support of the generic image attributes is optional for the IMS-AGW. The list of image sizes per payload type supported by the IMS-AGW is preconfigured in the IMS-ALG. If none of the image sizes received within an SDP body on Mx/Mw interface is supported by the IMS-AGW then the IMS-ALG will not send the generic image attribute parameter to the IMS-AGW.

NOTE 7: The support of ICE received candidate, ICE received password, ICE received Ufrag are optional for ICE lite, as specified in 3GPP TS 23.334 [23].

NOTE 8: The basic RTCP port allocation rules are defined by table 1 in ITU-T Recommendation H.248.57 [5], which summarizes all rules, with and without the "explicit RTCP transport address" element.

NOTE 9: This element is optional. The RTCP port allocation rules are specified in tables 4/1 to 4/5 in ITU-T Recommendation H.248.57 [5].

NOTE 10: The support of rate adaptation for media endpoints using the additional bandwidth properties is optional for the IMS-AGW. If media transcoding is required the IMS-ALG may provide for the selected payload type and the used IP version the additional bandwidth properties.

| | | + +The IMS-AGW responds as in Table 5.17.2.3.2. + +Table 5.17.2.3.2: Configure AGW Connection Point Request Acknowledge + +| Address Information | Control information | Bearer information | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| If local resources were provided in request:
Local Descriptor {
Port
IP Address
IP Version
}
If remote resources are provided in request:
Remote Descriptor {
Port
IP Address
IP Version
} NOTE | Transaction ID = x
Context ID = C1
Termination ID = T1

If Stream Number Specified:
Stream Number | If local resources were provided in request:
Local Descriptor {
If media is "audio" or "video":
Codec List
RTP Payloads
Rtpbw
If RTCP bandwidth
RtcpbwRS
RtcpbwRR
If IMS media plane security was provided in request:
Cryptographic SDES Attribute
If RTP-level pause and resume:
CCM pause-resume
If RTCP Codec Control
Commands and Indications:
CCM BASE
If RTCP Delay Budget
Information:
DBI

If media is "video":
If CVO extension header provided in the request:
Extended Header For CVO
If image attribute negotiation:
Generic Image Attribute
If Predefined ROI provided in the request:
RTCP feedback for Predefined ROI
Extended Header for Sent ROI
If Arbitrary ROI provided in the request:
RTCP feedback for Arbitrary ROI
Extended Header for Sent ROI

}
If remote resources are provided in request:
Remote Descriptor {
If media is "audio" or "video":
Codec List
RTP Payloads
Rtpbw
If rate adaptation for media endpoints:
Additional Bandwidth
Properties
If RTCP bandwidth
RtcpbwRS
RtcpbwRR
If IMS media plane security was provided in the request:
Cryptographic SDES Attribute
If RTP-level pause and resume:
CCM pause-resume
If RTCP Codec Control
Commands and Indications:
CCM BASE
If RTCP Delay Budget
Information:
DBI | + +| | | | +|-----------------------------------------------------|--|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | If media is "video":
If CVO extension header provided in the request:
Extended Header For CVO
If image attribute negotiation:
Generic Image Attribute
If Predefined ROI provided in the request:
RTCP feedback for Predefined ROI
Extended Header for Sent ROI
If Arbitrary ROI provided in the request:
RTCP feedback for Arbitrary ROI
Extended Header for Sent ROI

} NOTE | +| NOTE: Sending of the Remote Descriptor is optional. | | | + +#### 5.17.2.4 Reserve and Configure AGW Connection Point + +The IMS-ALG sends an ADD request command as in Table 5.17.2.4.1. + +Table 5.17.2.4.1: Reserve and Configure AGW Connection Point Request + +| Address Information | Control information | Bearer information | +|------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Local Descriptor {
Port = \$
IP Address = \$
IP Version = IPv4 or IPv6
}
Remote Descriptor {
Port
IP Address
IP Version
} | Transaction ID = x
If Context Requested:
Context ID = \$
If Emergency Call:
Emergency Call Indication

If MPS call/session:
Priority Indicator = x

If Context Provided:
Context ID = c1

Termination ID = \$

If Stream Number Specified:
Stream Number
If Resources for multiple Codecs
shall be reserved:
Reserve_Value

If IP Interface Type:
IP interface = "IP interface type"

If indication on Bearer Released
requested:
NotificationRequested (Event ID =
x, "BNC Release")

If diffserv required:-
Diffserv Code Point
If tagging behaviour
Diffserv Tagging Behaviour

If Remote Source Address Filtering
required:-
Remote Source Address Filtering
If Remote Source Address range
required:
Remote Source Address
Mask

If Remote Source Port Filtering
required:-
Remote Source Port Filtering
If individual port:
Remote Source Port
If range of ports
Remote Source Port Range

NotificationRequested (Event ID = x,
"termination heartbeat")

If IP Realm specified:-
IP Realm

If Latching Required:-
Latching

If Sustainable Data Rate Policing
Required:-
Policing Required
Sustainable Data Rate
Maximum Burst Size

If Peak Data Rate Policing Required: | Local Descriptor {
If media is "audio" or "video":
Codec List
RTP Payloads
Rtpbw
If RTCP bandwidth
RtcpbwRS
RtcpbwRR
If RTCP handling required:
RTP/RTCP transport multiplexing
(NOTE 7)
If IMS media plane security
required:
Cryptographic SDES Attribute
If RTP-level pause and resume:
CCM pause-resume
If RTCP Codec Control
Commands and Indications:
CCM BASE
If RTCP Delay Budget Information:
DBI

If media is "video":
If CVO required:
Extended Header For CVO
(NOTE 3)
If imageattr negotiation:
Generic Image Attribute
(NOTE 4) If Predefined ROI
required:
RTCP feedback for Predefined
ROI
Extended Header for Sent ROI
If Arbitrary ROI required:
RTCP feedback for Arbitrary ROI
Extended Header for Sent ROI

If ICE is applied:
ICE host candidate request
ICE password request
ICE Ufrag request

If media is "message" or
"application" or "-":
If IMS media plane security
required:
Local certificate fingerprint
Request

If TCP state-aware handling
required:
TCP State-aware Handling
Indicator and Setup Direction

If SCTP association for WebRTC
data channels:
Local SCTP Port Request
Local SCTP maximum message
size Request
Local Dcmmap
If application aware interworking
Local Dcsa

If SDPCapNeg is signalled to the
gateway: | + +| | | | +|--|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| |

Policing Required
Peak Data Rate
If Delay Variation Required
Delay Variation Tolerance

If Media Inactivity Detection Required:
NotificationRequested (Event ID = x, "Media Inactivity Detection( Media Inactivity Detection Time, Media Inactivity Detection Direction)")
(NOTE 1)

If RTCP handling required:
RTCP allocation

If ECN transparent support required:
ECN Enable = "True"
Initiation Method = "inactive"

If ECN Endpoint support required
ECN Enable = "True"
Initiation Method = "ECN Initiation Method" (NOTE 2)

If notification of ECN Failure Report:
NotificationRequested (Event ID = x,"ECN Failure")

If ICE is applied:
STUN server request
If full ICE is applied
Send Connectivity Check ("Control")
If notification of ICE Connectivity Check Result Report:
NotificationRequested (Event ID = xx, "Connectivity Check Result")
If notification of New Peer Reflexive Candidate:
NotificationRequested (Event ID = xy,"New Peer Reflexive Candidate")

If Discard Incoming TCP connection establishment request required:
Discard Incoming TCP Connection Establishment Requests Indicator

If Forward Incoming TCP connection establishment request required:
Forward Incoming TCP Connection Establishment Requests Indicator

If indication on TCP connection establishment failure requested:
NotificationRequested (Event ID = x, "TCP connection establishment failure")

If (D)TLS session establishment required:
Establish (D)TLS session

|

SDPCapNeg configuration

}

Remote Descriptor {
If media is "audio" or "video":
Codec List
RTP Payloads
Rtpbw
If rate adaptation for media endpoints:
Additional Bandwidth Properties (NOTE 8)
If RTCP bandwidth
RtcpbwRS
RtcpbwRR
If RTCP handling required:
RTP/RTCP transport multiplexing (NOTE 7)
If RTCP handling required:
explicit RTCP transport address (NOTE 6)
If IMS media plane security required:
Cryptographic SDES Attribute
If RTP-level pause and resume:
CCM pause-resume
If RTCP APP messages allowed
Allowed RTCP APP message types
If RTCP Codec Control Commands and Indications:
CCM BASE
If RTCP Delay Budget Information:
DBI

If media is "video":
If CVO required:
Extended Header For CVO (NOTE 3)
If imageattr negotiation:
Generic Image Attribute (NOTE 4)
If Predefined ROI required:
RTCP feedback for Predefined ROI
Extended Header for Sent ROI
If Arbitrary ROI required:
RTCP feedback for Arbitrary ROI
Extended Header for Sent ROI

If media is "message":
If B-ALG for MSRP required:
MSRP Path

If ICE is applied:
ICE received candidate
ICE received password
ICE received Ufrag (NOTE 5)
If STUN consent freshness test required:
STUN consent freshness request
NotificationRequested(Event ID= x, "STUN consent freshness test failure")

| +|--|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +| | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| |

If indication on (D)TLS session establishment failure requested:
NotificationRequested (Event ID = x, "(D)TLS session establishment failure")

If media is "message":
If B-ALG for MSRP required:
Application-aware MSRP interworking request

If SCTP association for WebRTC data channels:
SCTP Group Semantics
SCTP stream deaggregation
SCTP stream ID
NotificationRequested (Event ID = x, "Received SCTP Stream Reset Request")

|

If media is "message" or "application" or "-":
If IMS media plane security required:
Remote certificate fingerprint

If TCP state-aware handling required:
TCP State-aware Handling Indicator and Setup Direction

If SCTP association for WebRTC data channels:
Remote SCTP Port
Remote SCTP maximum message size
Remote Dcmap
If application aware interworking
Remote Dcsa

If SDPCapNeg is signalled to the gateway:
SDPCapNeg configuration

}

| +|

NOTE 1: The event parameters "Media Inactivity Detection Time" and "Media Inactivity Detection Direction" are optional.

NOTE 2: This shall be set to a value other than "inactive". See Table 5.14.3.15.1.

NOTE 3: If the IMS-AGW supports the extended RTP header with Coordination of Video Orientation information it shall pass any received extended RTP header with CVO bits on to outgoing RTP streams. If the IMS-AGW is transcoding between video payloads and it supports the extended RTP header with Coordination of Video Orientation information it shall convey received RTP header bytes on the outgoing RTP stream after transcoding associated packets as specified in 3GPP TS 26.114 [26], clause 7.4.5.

NOTE 4: The support of the generic image attributes is optional for the IMS-AGW. The list of image sizes per payload type supported by the IMS-AGW is preconfigured in the IMS-ALG. If none of the image sizes received within an SDP body on Mx/Mw interface is supported by the IMS-AGW then the IMS-ALG will not send the generic image attribute parameter to the IMS-AGW.

NOTE 5: The support of ICE received candidate, ICE received password, ICE received Ufrag are optional for ICE lite, as specified in 3GPP TS 23.334 [23].

NOTE 6: The basic RTCP port allocation rules are defined by table 1 in ITU-T Recommendation H.248.57 [5], which summarizes all rules, with and without the "explicit RTCP transport address" element.

NOTE 7: This element is optional. The RTCP port allocation rules are specified in tables 4/1 to 4/5 in ITU-T Recommendation H.248.57 [5].

NOTE 8: The support of rate adaptation for media endpoints using the additional bandwidth properties is optional for the IMS-AGW. If media transcoding is required the IMS-ALG may provide for the selected payload type and the used IP version the additional bandwidth properties.

| | | + +The IMS-AGW responds as in Table 5.17.2.4.2. + +Table 5.17.2.4.2: Reserve and Configure AGW Connection Point Request Acknowledge + +| Address Information | Control information | Bearer information | +|----------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Local Descriptor {
Port
IP Address
IP Version
}
Remote Descriptor {
Port
IP Address
IP Version
} NOTE | Transaction ID = x
Context ID = C1
Termination ID = T1
Stream Number | Local Descriptor {
If media is "audio" or "video":
Codec List
RTP Payloads
Rtpbw
If RTCP bandwidth
RtcpbwRS
RtcpbwRR
If IMS media plane security was provided in the request:
Cryptographic SDES Attribute
If RTP-level pause and resume:
CCM pause-resume
If RTCP Codec Control
Commands and Indications:
CCM BASE
If RTCP Delay Budget
Information:
DBI

If media is "video":
If CVO extension header provided in the request:
Extended Header For CVO
If image attribute negotiation:
Generic Image Attribute
If Predefined ROI provided in the request:
RTCP feedback for Predefined ROI
Extended Header for Sent ROI
If Arbitrary ROI provided in the request:
RTCP feedback for Arbitrary ROI
Extended Header for Sent ROI

If ICE is applied:
ICE host candidate
ICE password
ICE Ufrag
If ICE lite implementation
ICE lite indication

If media is "message" or "application" or "-":
If Local certificate fingerprint was requested:
Local certificate fingerprint

If SCTP association for WebRTC data channels:
Local SCTP Port
Local SCTP maximum message size

If SDPCapNeg is signalled to the gateway:
SDPCapNeg configuration

Remote Descriptor {
If media is "audio" or "video":
Codec List
RTP Payloads
Rtpbw
If rate adaptation for media | + +| | | | +|-----------------------------------------------------|--|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | endpoints:
Additional Bandwidth Properties
If RTCP bandwidth
RtcpbwRS
RtcpbwRR
If IMS media plane security was provided in the request:
Cryptographic SDES Attribute
If RTP-level pause and resume:
CCM pause-resume
If RTCP Codec Control
Commands and Indications:
CCM BASE
If RTCP Delay Budget
Information:
DBI

If media is "video":
If CVO extension header provided in the request:
Extended Header For CVO
If image attribute negotiation:
Generic Image Attribute
If Predefined ROI provided in the request:
RTCP feedback for Predefined ROI
Extended Header for Sent ROI
If Arbitrary ROI provided in the request:
RTCP feedback for Arbitrary ROI
Extended Header for Sent ROI

If SDPCapNeg is signalled to the gateway:
SDPCapNeg configuration

} NOTE | +| NOTE: Sending of the Remote Descriptor is optional. | | | + +#### 5.17.2.5 Release AGW Termination + +The IMS-ALG sends a SUBTRACT command as in Table 5.17.2.5.1. + +**Table 5.17.2.5.1: Release AGW Termination Request** + +| Address Information | Control information | Bearer information | +|---------------------|---------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID= C1/ALL
Termination ID = T1/ALL | | + +On releasing the termination, the IMS-AGW responds as in Table 5.17.2.5.2 + +**Table 5.17.2.5.2: Release AGW Termination Request Acknowledge** + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1/ALL
Termination ID = T1/ALL | | + +#### 5.17.2.6 Termination Heartbeat Indication + +When the procedure "Termination heartbeat indication" is required the following procedure is initiated: the IMS-AGW sends a NOT.req command with the following information. + +##### 5.17.2.6.1 NOT.req (Termination heartbeat) + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1

Event_ID (Event ID = x, "termination heartbeat") | | + +When the processing of command is complete, the IMS-ALG initiates the following procedure. + +##### 5.17.2.6.2 NOT.resp (Termination heartbeat) + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +The IMS-ALG shall correct any detected mismatch, by subtracting hanging terminations or clearing hanging contexts. + +#### 5.17.2.7 IP Bearer Released + +When the procedure "IP Bearer Released" is required the following procedure is initiated: the IMS-AGW sends a NOT.req command with the following information. + +##### 5.17.2.7.1 NOT.req (IP Bearer Released) + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1

Event_ID (Event ID = x, "BNC Release (Cause)") | | + +When the processing of command is complete, the IMS-ALG initiates the following procedure. + +##### 5.17.2.7.2 NOT.resp (IP Bearer Released) + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +#### 5.17.2.8 Media Inactivity Notification + +When the procedure "Media Inactivity Notification" is required the following procedure is initiated: the IMS-AGW sends a NOT.req command with the following information. + +##### 5.17.2.8.1 NOT.req (Media Inactivity) + +| Address Information | Control information | Bearer information | +|---------------------|---------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1

Event_ID (Event ID = x, "Media Inactivity Detection") | | + +When the processing of command is complete, the IMS-ALG initiates the following procedure. + +##### 5.17.2.8.2 NOT.resp (Media Inactivity) + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +#### 5.17.2.9 Change Through Connection + +The IMS-ALG sends an ADD or a MODIFY request command as in Table 5.17.2.9.1. + +##### 5.17.2.9.1 Change Through Connection Request + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
If Context Requested:
Context ID = \$
If Context Provided:
Context ID = c1

If Termination Requested:
Termination ID = \$
If Termination Provided:
Termination ID = T1

Through-Connection = Connectivity Mode | | + +The IMS-AGW responds as in Table 5.17.2.9.2. + +##### 5.17.2.9.2 Change Through Connection Request Acknowledge + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +#### 5.17.2.10 Change Flow Direction + +The IMS-ALG sends an ADD or a MODIFY request command as in Table 5.17.2.10.1. + +##### 5.17.2.10.1 Change Flow Direction + +| Address Information | Control information | Bearer information | +|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
If Context Requested:
Context ID = \$
If Context Provided:
Context ID = c1

If Termination Requested:
Termination ID = \$
If Termination Provided:
Termination ID = T1

Connection Configuration =
(TerminationID= x1,
TerminationID=x2,
[type = x]),... | | + +The IMS-AGW responds as in Table 5.17.2.10.2. + +##### 5.17.2.10.2 Change Flow Direction Acknowledge + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +#### 5.17.2.11 ECN Failure Indication + +The IMS-AGW sends a NOTIFY request command as in Table 5.17.2.11.1. + +**Table 5.17.2.11.1: ECN Failure Indication** + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID= C1
Termination ID = T1

Event_ID (Event ID = x,
" ECN Failure (ECN Failure Type)") | | + +The IMS-ALG responds as in Table 5.17.2.11.2 + +**Table 5.17.2.11.2: ECN Failure Indication Ack** + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +#### 5.17.2.12 ICE Connectivity Check Result Notification + +The IMS-AGW sends a NOTIFY request command as defined in Table 5.17.2.12.1. + +**Table 5.17.2.12.1: ICE Connectivity Check Result Notification** + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID= C1
Termination ID = T1

Event_ID (Event ID = x,
"Connectivity Check Result
(Candidate/Transport Pair)") | | + +The IMS-ALG responds as defined in Table 5.17.2.12.2 + +**Table 5.17.2.12.2: ICE Connectivity Check Result Notification Ack** + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +#### 5.17.2.13 ICE New Peer Reflexive Candidate Notification + +The IMS-AGW sends a NOTIFY request command as defined in Table 5.17.2.13.1. + +**Table 5.17.2.13.1: ICE New Peer Reflexive Candidate Notification** + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID= C1
Termination ID = T1

Event_ID (Event ID = x,
"New Peer Reflexive Candidate
(Candidate)") | | + +The IMS-ALG responds as defined in Table 5.17.2.13.2 + +**Table 5.17.2.13.2: ICE New Peer Reflexive Candidate Ack** + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +#### 5.17.2.14 Notify TCP connection establishment Failure Indication + +When the procedure "Notify TCP connection establishment Failure Indication" is required the following procedure is initiated: the IMS-AGW sends a NOT.req command with the following information. + +**5.17.2.14.1 NOT.req (TCP connection establishment Failure)** + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1

Event_ID (Event ID = y,
"TCP connection establishment
Error Indication") | | + +When the processing of command is complete, the IMS-ALG initiates the following procedure. + +##### 5.17.2.14.2 NOT.resp (TCP connection establishment Failure) + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +#### 5.17.2.15 Notify (D)TLS session establishment Failure Indication + +When the procedure "Notify (D)TLS session establishment Failure Indication" is required the following procedure is initiated: the IMS-AGW sends a NOT.req command with the following information. + +##### 5.17.2.15.1 NOT.req ((D)TLS session establishment Failure) + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1

Event_ID (Event ID = y,
"(D)TLS session establishment
Error Indication") | | + +When the processing of command is complete, the IMS-ALG initiates the following procedure. + +##### 5.17.2.15.2 NOT.resp ((D)TLS session establishment Failure) + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +#### 5.17.2.16 STUN Consent Freshness Test Failure Notification + +The eIMS-AGW sends a NOTIFY request command as defined in Table 5.17.2.16.1. + +**Table 5.17.2.16.1: STUN Consent Freshness Test Failure Notification** + +| Address Information | Control information | Bearer information | +|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID= C1
Termination ID = T1

Event_ID (Event ID = x,
"STUN Consent Freshness Test
Failure (STUN Consent
Freshness Test Failure Type)") | | + +The eP-CSCF responds as defined in Table 5.17.2.16.2 + +**Table 5.17.2.16.2: STUN Consent Freshness Test Failure Notification Ack** + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +#### 5.17.2.17 Notify SCTP Stream Reset + +The IMS-AGW sends a NOTIFY request command as defined in Table 5.17.2.17.1. + +**Table 5.17.2.17.1: Notify SCTP Stream Reset** + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID= C1
Termination ID = T1

Event_ID (Event ID = x,
" Received SCTP Stream Reset
Request (SCTP Stream ID)") | | + +The IMS-ALG responds as defined in Table 5.17.2.17.2 + +**Table 5.17.2.17.2: Notify SCTP Stream Reset Ack** + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +#### 5.17.2.18 Notify SCTP Stream Reset Result + +The IMS-AGW sends a NOTIFY request command as defined in Table 5.17.2.18.1. + +**Table 5.17.2.18.1: Notify SCTP Stream Reset Result** + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID= C1
Termination ID = T1

Event_ID (Event ID = x,
" Received SCTP Stream Reset
Result (SCTP Stream ID,
result)") | | + +The IMS-ALG responds as defined in Table 5.17.2.18.2 + +**Table 5.17.2.18.2: Notify SCTP Stream Reset Result Ack** + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1
Termination ID = T1 | | + +### 5.17.3 Non-Call Related Procedures + +#### 5.17.3.1 General + +This clause describes the various non-call related procedures which are listed in Table 5.17.3.1.1 + +**Table 5.17.3.1.1: IMS-AGW Non-Call Related Procedures** + +| Transaction in 3GPP TS 23.334 [23] | Support | Comment | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------| +| IMS-AGW Out of service | Mandatory | 5.17.3.2 | +| IMS-AGW Communication Up | Mandatory | 5.17.3.3 | +| IMS-AGW Restoration | Mandatory | 5.17.3.4 | +| IMS-AGW Register | Mandatory | 5.17.3.5 | +| IMS-AGW Re-register | Optional
(NOTE 3) | 5.17.3.6 | +| IMS-ALG Ordered Re-register | Optional
(NOTE 3) | 5.17.3.7 | +| IMS-ALG Restoration | Optional | 5.17.3.8 | +| IMS-ALG Out of Service | Optional | 5.17.3.9 | +| Audit Value | Optional
(NOTE 3) | 5.17.3.10 | +| Command Rejected | Mandatory | The "Command Rejected" procedure may be used in response both to call-related and non-call-related ITU-T Recommendation H.248 Commands – 5.17.3.11 | +| Capability Update | Optional | 5.17.3.12 | +| IMS-AGW Resource Congestion Handling – Activate | Optional | 5.17.3.13 | +| IMS-AGW Resource Congestion Handling – Indication | Optional | 5.17.3.14 | +| Inactivity timeout activation | Optional
(NOTE 4) | 5.17.3.15 | +| Inactivity timeout indication | Optional
(NOTE 4) | 5.17.3.16 | +| Realm Availability Change activation | Optional | 5.17.3.17 | +| Realm Availability Change indication | Optional | 5.17.3.18 | +| Termination Out of Service | Optional
(NOTE 1) | 5.17.3.19 (NOTE 2) | +| NOTE 1: Support of this procedure is mandatory in the IMS-ALG.
NOTE 2: The "Termination Out-of-Service procedure" is also used as a call-related H.248 command
NOTE 3: Support of this procedure is mandatory in the IMS-AGW.
NOTE 4: Support of this procedure is mandatory in the IMS-AGW if UDP transport is supported. | | | + +#### 5.17.3.2 IMS-AGW Out Of Service + +The IMS-AGW sends a SERVICE CHANGE request command as in Table 5.17.3.2.1. + +**Table 5.17.3.2.1: IMS-AGW Out Of Service Request** + +| Address Information | Control information | Bearer information | +|----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------| +| | Transaction ID = x
Context ID= -
Termination ID = ROOT
SC Method = FORCED or GRACEFUL
SC Reason = 905 Termination
Taken OOS or 908, MG Impending Failure, or 915 State Loss | | + +The IMS-ALG responds as in Table 5.17.3.2.2. + +**Table 5.17.3.2.2: IMS-AGW Out Of Service Request Ack** + +| Address Information | Control information | Bearer information | +|---------------------|---------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = -
Termination ID = ROOT | | + +#### 5.17.3.3 IMS-AGW Communication Up + +The IMS-AGW sends a SERVICE CHANGE request command as in Table 5.17.3.3.1 to the IMS-ALG address to which the control link association was previously established. + +**Table 5.17.3.3.1: IMS-AGW Communication Up** + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID= -
Termination ID = ROOT
SC Method = DISCONNECTED
SC Reason = 900 , Service Restored | | + +The IMS-ALG may respond as in table 5.17.3.3.2. If a response is received, the control link association is re-established and the inactivity timer would be restarted. + +**Table 5.17.3.3.2: IMS-AGW Communication Up Ack** + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = -
Termination ID = ROOT
If required to register to a new IMS-ALG:
Alternate MGC Id | | + +#### 5.17.3.4 IMS-AGW Restoration + +When the IMS-AGW has recovered, the IMS-AGW sends a SERVICE CHANGE as in Table 5.17.3.4.1, + +**Table 5.17.3.4.1: IMS-AGW Restoration** + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID= -
Termination ID = ROOT
SC Method = RESTART
SC Reason = 900, Service Restored | | + +The IMS-ALG responds as in Table 5.17.3.4.2. + +**Table 5.17.3.4.2: IMS-AGW Restoration Ack** + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = -
Termination ID = ROOT
If required to register to a new IMS-ALG:
Alternate MGC Id | | + +#### 5.17.3.5 IMS-AGW Register + +The IMS-AGW sends a SERVICE CHANGE request command as in Table 5.17.3.5.1. + +**Table 5.17.3.5.1: IMS-AGW Register** + +| Address Information | Control information | Bearer information | +|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID= -
Termination ID = ROOT
SC Method = RESTART
SC Reason =901, Cold Boot or 902, Warm Boot
H248 Profile Identity
H248 Protocol Version | | + +The IMS-ALG responds as in Table 5.17.3.5.2. + +**Table 5.17.3.5.2: IMS-AGW Register Ack** + +| Address Information | Control information | Bearer information | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = -
Termination ID = ROOT
If applicable (NOTE):
H248 Protocol Version
If applicable:-
H248 Profile Identity
If required to register to a new IMS-ALG:
Alternate MGC Id | | +| NOTE: The IMS-ALG shall include the H.248 Protocol Version if the protocol version it supports or offers is lower than that proposed by the IMS-AGW. The IMS-ALG may include the H.248 Protocol Version if the protocol version it supports or offers is the protocol version proposed by the IMS-AGW. | | | + +#### 5.17.3.6 IMS-AGW Re-Register + +The IMS-AGW sends a SERVICE CHANGE request command as in Table 5.17.3.6.1. + +**Table 5.17.3.6.1: IMS-AGW Re-Registration** + +| Address Information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID= -
Termination ID = ROOT
SC Method = Handoff
SC Reason = 903, MGC Directed Change
H248 Profile Identity
H248 Protocol Version | | + +The IMS-ALG responds as in Table 5.17.3.6.2. + +**Table 5.17.3.6.2: IMS-AGW Re-Registration Ack** + +| Address Information | Control information | Bearer information | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = -
Termination ID = ROOT
If applicable (NOTE):
H248 Protocol Version
If applicable:-
H248 Profile Identity
If required to register to a new IMS-ALG:
Alternate MGC Id | | +| NOTE: The IMS-ALG shall include the H.248 Protocol Version if the protocol version it supports or offers is lower than that proposed by the IMS-AGW. The IMS-ALG may include the H.248 Protocol Version if the protocol version it supports or offers is the protocol version proposed by the IMS-AGW. | | | + +#### 5.17.3.7 IMS-ALG Ordered Re-register + +The IMS-ALG sends a SERVICE CHANGE request command as in Table 5.17.3.7.1. + +**Table 5.17.3.7.1: IMS-ALG Ordered Re-Register** + +| Address Information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID= -
Termination ID = ROOT
SC Method = HANDOFF
SC Reason = 903, MGC Directed Change
Alternate MGC Id | | + +The IMS-AGW responds as in Table 5.17.3.7.2. + +**Table 5.17.3.7.2: IMS-ALG Ordered Re-Register Ack** + +| Address Information | Control information | Bearer information | +|---------------------|---------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = -
Termination ID = ROOT | | + +The IMS-AGW then performs an IMS-AGW Re-Register procedure according to Clause 5.17.3.6. + +#### 5.17.3.8 IMS-ALG Restoration + +When the IMS-ALG has recovered, the IMS-ALG sends a SERVICE CHANGE as in Table 5.17.3.8.1, + +**Table 5.17.3.8.1: IMS-ALG Restoration** + +| Address Information | Control information | Bearer information | +|---------------------|----------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID= -
Termination ID = ROOT
SC Method = RESTART
SC Reason = 901, Cold Boot OR
902, Warm Boot | | + +The IMS-AGW responds as in Table 5.17.3.8.2. + +**Table 5.17.3.8.2: IMS-ALG Restoration Ack** + +| Address Information | Control information | Bearer information | +|----------------------------|---------------------------------------------------------------|---------------------------| +| | Transaction ID = x
Context ID = -
Termination ID = ROOT | | + +#### 5.17.3.9 IMS-ALG Out of Service + +The IMS-ALG sends a SERVICE CHANGE request command as in Table 5.17.3.9.1. + +**Table 5.17.3.9.1: IMS-ALG Out Of Service** + +| Address Information | Control information | Bearer information | +|----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------| +| | Transaction ID = x
Context ID= -
Termination ID = ROOT
SC Method = FORCED or
GRACEFUL
SC Reason = 905, Termination
Taken OOS | | + +The IMS-AGW responds as in Table 5.17.3.9.2. + +**Table 5.17.3.9.2: IMS-ALG Out Of Service Ack** + +| Address Information | Control information | Bearer information | +|----------------------------|---------------------------------------------------------------|---------------------------| +| | Transaction ID = x
Context ID = -
Termination ID = ROOT | | + +#### 5.17.3.10 Audit Value + +The IMS-ALG sends an AUDIT VALUE request command as in Table 5.17.3.10.1. + +**Table 5.17.3.10.1: Audit Value** + +| Address Information | Control information | Bearer information | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID= -/ALL/C1
Termination ID =
ROOT/ALL/T1/PartialWildcard
(NOTE 4, NOTE 5)

Audit Packages (NOTE 1)

Audit Descriptor =
IndAuditParameter:=
IndAudMediaDescriptor:=
IndAudTerminationStateDescriptor:=
serviceState
Audit Descriptor = Empty (NOTE 2)

Audit Descriptor =
IndAuditParameter:=
IndAudMediaDescriptor:=
IndAudTerminationStateDescriptor:=
Available Realms (NOTE 3)

Audit Descriptor =
IndAuditParameter:=
IndAudMediaDescriptor:=
IndAudTerminationStateDescriptor:=
ROOT properties (NOTE 6)

Audit Descriptor =
IndAuditParameter:=
IndAudMediaDescriptor:=
IndAudTerminationStateDescriptor:=
SDPCapNeg Supported Capabilities
(NOTE 7) | | +| NOTE 1: Packages is for Null/Root Combination.
NOTE 2: Used for control association monitoring.
NOTE 3: Used for auditing available IP realms
NOTE 4: The partial wildcard termination is used for the context audit (see table 5.17.3.10.3) and specifies the "group" part of the termination identity (e.g. "ip/5/*").
NOTE 5: Partial wildcard shall only be used when text encoding is used on the H.248 interface.
NOTE 6: Used for auditing ROOT properties.
NOTE 7: Used for auditing SDPCapNeg Extensions when SDPCapNeg signalling to the gateway is supported. | | | + +The IMS-AGW responds as in Table 5.17.3.10.2. + +**Table 5.17.3.10.2: Audit Value Ack** + +| Address Information | Control information | Bearer information | +|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = -/C1
Termination ID = ROOT/T1
Packages List
serviceState
Available Realms
ROOT Properties
SDPCapNeg Extensions | | + +Upon reception of the command in the IMS-AGW: + +- The Service State returns the current Service State +- When Packages are requested, the Package Names and Versions are returned +- When realm availability is audited, the list of available realms is returned. + +- When root properties are audited, the values of root properties are returned. + +The following table illustrates the allowed combinations that can be obtained with the AuditValue Command: + +**Table 5.17.3.10.3: Combinations of AuditValue Command** + +| ContextID | TerminationID | Information Obtained | +|----------------------------------------------------------------------------------------------|------------------|------------------------------------------------------------------------------------------------------------------------| +| Specific | Wildcard | Audit of matching Terminations in a Context | +| Specific | Specific | Audit of a single Termination in a Context | +| Null | Root | Audit of Media Gateway state and/or control association or available realms, or supported packages or ROOT properties. | +| All | Specific | (Non-null) ContextID in which the Termination currently exists | +| All | Partial Wildcard | (Non-null) ContextIDs in which the Terminations currently exist | +| NOTE: Partial wildcard shall only be used when text encoding is used on the H.248 interface. | | | + +#### 5.17.3.11 Command Rejected + +When the procedure "Command Reject" is required the following procedure is initiated: + +The IMS-AGW / IMS-ALG sends a response to any command.req with the following information. + +**Table 5.17.3.11.1: ANYcommand.resp (command reject ) IMS-AGW / IMS-ALG to IMS-ALG/ IMS-AGW** + +| Address Information | Control information | Bearer information | +|---------------------|---------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = z
Context ID = c1 or no context
Termination ID = T1 or no termination ID

Reason=Error | | + +#### 5.17.3.12 AGW Capability Change + +The IMS-AGW sends a SERVICE CHANGE request command as in Table 5.17.3.12.1. + +**Table 5.17.3.12.1: AGW Capability Update** + +| Address Information | Control information | Bearer information | +|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID= -
Termination ID = ROOT
SC Method = RESTART or DISCONNECTED
SC Reason = 916, Packages Change or 917, Capability Change | | + +The IMS-ALG responds as in table 5.17.3.12.2. + +**Table 5.17.3.12.2 AGW Capability Update Ack** + +| Address Information | Control information | Bearer information | +|---------------------|---------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = -
Termination ID = ROOT | | + +#### 5.17.3.13 IMS-AGW Resource Congestion Handling – Activate + +The IMS-ALG sends a MODIFY request command as in Table 5.17.3.13.1 + +**Table 5.17.3.13.1: IMS-AGW Resource Congestion Handling – Activate** + +| Address Information | Control information | Bearer information | +|---------------------|-----------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID= -
Termination ID = ROOT

NotificationRequested (Event ID = x, "Overload Notification") | | + +The IMS-AGW responds as in Table 5.17.3.13.2. + +**Table 5.17.3.13.2: IMS-AGW Resource Congestion Handling – Activate Ack** + +| Address Information | Control information | Bearer information | +|---------------------|---------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = -
Termination ID = ROOT | | + +#### 5.17.3.14 IMS-AGW Resource Congestion Handling – Indication + +The IMS-AGW sends a NOTIFY request command as in Table 5.17.3.14.1 + +**Table 5.17.3.14.1: IMS-AGW Resource Congestion Handling – Indication** + +| Address Information | Control information | Bearer information | +|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID= -
Termination ID = ROOT

If H.248.11 used:
Event_ID (Event ID = x, "Overload Notification")

If H.248.10 used:
Event_ID (Event ID = x, "Overload Notification (Reduction)") | | + +The IMS-ALG responds as in Table 5.17.3.14.2 + +**Table 5.17.3.14.2: IMS-AGW Resource Congestion Handling – Indication Ack** + +| Address Information | Control information | Bearer information | +|---------------------|---------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = -
Termination ID = ROOT | | + +#### 5.17.3.15 Inactivity Timeout – Activation + +The IMS-ALG sends a MODIFY request command as in Table 5.17.3.15.1 + +**Table 5.17.3.15.1: Inactivity Timeout – Activation** + +| Address Information | Control information | Bearer information | +|---------------------|-----------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID= NULL
Termination ID = ROOT

NotificationRequested (Event ID = x, "Inactivity Timeout") | | + +The IMS-AGW responds as in Table 5.17.3.15.2. + +**Table 5.17.3.15.2: Inactivity Timeout – Activation Ack** + +| Address Information | Control information | Bearer information | +|---------------------|------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = NULL
Termination ID = ROOT | | + +#### 5.17.3.16 Inactivity Timeout – Indication + +The IMS-AGW sends a NOTIFY request command as in Table 5.17.3.16.1. + +**Table 5.17.3.16.1: Inactivity Timeout – Indication** + +| Address Information | Control information | Bearer information | +|---------------------|------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID= NULL
Termination ID = ROOT
Event_ID (Event ID = x, "Inactivity Timeout") | | + +The IMS-ALG responds as in Table 5.17.3.16.2 + +**Table 5.17.3.16.2: Inactivity Timeout – Indication Ack** + +| Address Information | Control information | Bearer information | +|---------------------|------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = NULL
Termination ID = ROOT | | + +#### 5.17.3.17 Realm Availability Change – Activation + +The IMS-ALG sends a MODIFY request command as in Table 5.17.3.17.1. + +**Table 5.17.3.17.1: Realm Availability Change – Activation** + +| Address Information | Control information | Bearer information | +|---------------------|---------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID= -
Termination ID = ROOT

NotificationRequested (Event ID = x, "Realm Availability Change") | | + +The IMS-AGW responds as in Table 5.17.3.17.2. + +**Table 5.17.3.17.2: Realm Availability Change – Activation Ack** + +| Address Information | Control information | Bearer information | +|---------------------|---------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = -
Termination ID = ROOT | | + +#### 5.17.3.18 Realm Availability Change – Indication + +The IMS-AGW sends a NOTIFY request command as in Table 5.17.3.18.1. + +**Table 5.17.3.18.1: Realm Availability Change – Indication** + +| Address Information | Control information | Bearer information | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID= -
Termination ID = ROOT

Event_ID (Event ID = x,
"Realm Availability Change
(Changed Realms)") | | +| NOTE: The ObservedEvent Parameters returned within the Changed Realms are defined as mandatory since it shall contain at minimum 1 parameter but may contain both Newly Available Realms and Newly Unavailable Realms. | | | + +The IMS-ALG responds as in Table 5.17.3.18.2 + +**Table 5.17.3.18.2: Realm Availability Change – Indication Ack** + +| Address Information | Control information | Bearer information | +|---------------------|---------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = -
Termination ID = ROOT | | + +#### 5.17.3.19 Termination Out Of Service + +This procedure only applies when text encoding is used on the H.248 interface. + +The IMS-AGW sends a SERVICE CHANGE request command as in Table 5.17.3.19.1. + +**Table 5.17.3.19.1: Termination Out Of Service Request** + +| Address Information | Control information | Bearer information | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID= C1/ALL
Termination ID = T1 or Wildcarded
Termination (NOTE)
SC Method = FORCED
SC Reason = 904 ("Termination
Malfunction") or 905 ("Termination
Taken OOS") or 906 ("Loss of Lower
Layer Connectivity"), or 907
("Transmission Failure") or 910
("Media Capability Failure") | | +| NOTE: This is set to a specific termination identity or a partially wildcarded identity (i.e. specifying the "interface" part of the termination ID and wildcarding the "group" and "Id" parts) or a wholly wildcarded identity (i.e. ip/*). | | | + +The IMS-ALG responds as in Table 5.17.3.19.2. + +**Table 5.17.3.19.2: Termination Out Of Service Request Ack** + +| Address Information | Control information | Bearer information | +|---------------------|---------------------------------------------------------------------------|--------------------| +| | Transaction ID = x
Context ID = C1/ALL
Termination ID = As received | | + +# Annex A (informative): Change history + +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | New | +|---------|-------|-----------|------|-----|------------------------------------------------------------------------------------|--------| +| 2009-12 | CT#46 | CP-090823 | | | 3GPP TS Presented for information and approval in CT#46 | 9.0.0 | +| 2010-03 | CT#47 | CP-100050 | 0001 | 2 | IMS media plane security stage 3 | 9.1.0 | +| | | CP-100044 | 0002 | 1 | Non-call Related Procedures Naming update | | +| | | CP-100044 | 0006 | 1 | Correction to table notes and references | | +| | | CP-100044 | 0007 | 1 | Termination Type Alignment | | +| | | CP-100044 | 0008 | | Returned SDP Properties | | +| | | CP-100044 | 0009 | 1 | Manipulating and Auditing Context Attributes | | +| | | CP-100044 | 0010 | 1 | Inactivity Timeout | | +| | | CP-100044 | 0011 | 1 | Clean-up Proposals | | +| 2010-06 | CT#48 | CP-100289 | 0012 | 1 | Transport protocol to be indicated to gateway for end-to-end media security | 9.2.0 | +| | | | 0015 | | Profiling of SDES crypto attribute for e2a media security | | +| | | CP-100284 | 0013 | 1 | Handling of Stream mode | | +| 2010-09 | CT#49 | CP-100461 | 0016 | | Procedures for Emergency indicator | 9.3.0 | +| | | CP-100461 | 0017 | 1 | Error Descriptor | | +| 2011-03 | CT#51 | CP-110278 | 0019 | 10 | ECN Support in Iq Interface | 10.0.0 | +| 2011-06 | CT#52 | CP-110368 | 0021 | 1 | Alignment of 3GPP profiles with SG16 ECN package definition | 10.1.0 | +| 2011-09 | CT#53 | CP-110573 | 0022 | 1 | Transcoding at ATCF/ATGW during eSRVCC | 10.2.0 | +| 2011-12 | CT#54 | CP-110798 | 0023 | 1 | Explicit Congestion Notification | 10.3.0 | +| | | CP-110796 | 0024 | 1 | Update of reference to H.248.52 | | +| 2012-06 | CT#56 | CP-120226 | 0025 | 1 | Reference update: draft-ietf-avtcore-ecn-for-rtp | 10.4.0 | +| 2012-09 | CT#57 | CP-120478 | 0026 | 3 | Support of Multimedia Priority Service (MPS) over Iq Interface – Stage 3 | 11.0.0 | +| 2012-12 | CT#58 | CP-120723 | 0036 | - | Iq interface updates of ECN Support Package | 11.1.0 | +| | | CP-120734 | 0037 | 3 | Support of Multimedia Priority Service (MPS) in Modify over Iq Interface – Stage 3 | | +| 2013-06 | CT#60 | CP-130294 | 0039 | 2 | ECN relying reference change | 11.2.0 | +| 2013-06 | CT#60 | CP-130299 | 0044 | 2 | Introduction of support for Coordination of Video Orientation (CVO) | 12.0.0 | +| 2013-09 | CT#61 | CP-130471 | 0045 | 3 | Introduction of support for Generic Image Attribute/signalling of image size | 12.1.0 | +| 2013-12 | CT#62 | CP-130636 | 0049 | 1 | No indication of generic image attributes in Iq | 12.2.0 | +| 2014-06 | CT#64 | CP-140248 | 0053 | 3 | Support for Interactive Connectivity Establishment (ICE) | 12.3.0 | +| | | CP-140234 | 0056 | - | Aligning Mandatory Features with stage 2 | | +| | | CP-140249 | 0059 | 1 | WebRTC support for Iq | | + +| | | | | | | | +|---------|-------|-----------|------|---|---------------------------------------------------------------------------------|--------| +| | | CP-140268 | 0060 | - | AGW Capability Change | | +| 2014-09 | CT#65 | CP-140504 | 0057 | 3 | IMS media security for TCP-based media using TLS and UDP-based media using DTLS | 12.4.0 | +| | | CP-140504 | 0058 | 3 | Bearer-level application level gateway (B-ALG) for TCP-based media | | +| 2014-12 | CT#66 | CP-140798 | 0063 | 1 | RTCP port allocation rules – Semantical clarification | 12.5.0 | +| | | CP-140777 | 0067 | 2 | WebRTC Architecture Update | | +| | | CP-140777 | 0071 | 2 | Support of Consent Freshness in WebRTC | | +| | | CP-140788 | 0070 | 1 | Adding support for EVS codec | | +| | | CP-140786 | 0072 | - | Reference update: draft-schwarz-mmusic-sdp-for-gw | | +| | | CP-140791 | 0073 | 1 | Alternative connection (ALTC) addresses management | | +| 2014-12 | CT#66 | CP-14079 | 0051 | 4 | Support of RTP transport multiplexing (Iq, stage 3) | 13.0.0 | +| 2015-03 | CT#67 | CP-150030 | 0075 | 1 | TCP basic connection control package | 13.1.0 | +| | | CP-150030 | 0077 | 1 | TLS basic session control package | | +| | | CP-150030 | 0079 | 1 | Stream endpoint interlinkage package | | +| | | CP-150030 | 0081 | 1 | MG located Bearer Level ALG package | | +| | | CP-150027 | 0085 | 1 | IMS WebRTC reference update | | +| 2015-06 | CT#68 | CP-150258 | 0087 | 1 | Updating ITU-T references | 13.2.0 | +| | | CP-150258 | 0089 | 1 | TCP descriptor correction | | +| | | CP-150258 | 0094 | 1 | Updating references to H.248.90 and IETF Draft | | +| | | CP-150256 | 0091 | 1 | WebRTC transport protocols | | +| 2015-12 | CT#70 | CP-150783 | 0098 | 3 | Support for Video Enhancements by Region-of-Interest Information Signalling | 13.3.0 | +| | | CP-150754 | 0100 | - | Update of IMS WebRTC reference | | +| | | CP-150758 | 0103 | - | Update of media security reference | | +| | | CP-150779 | 0104 | 2 | WebRTC Data Channels | | +| 2016-03 | CT#71 | CP-160028 | 0105 | 2 | WebRTC Data Channels | 13.4.0 | +| | | CP-160032 | 0106 | 1 | WebRTC gateway configuration for end-to-end WebRTC calls (stage 3) | | +| | | CP-160034 | 0107 | 1 | Support of enhanced bandwidth negotiation mechanism for MTSL sessions | | +| | | CP-160021 | 0108 | 2 | Iq stage 3 to support SDP Capability Negotiation | | +| 2016-06 | CT#72 | CP-160229 | 0109 | - | Clarifications related to the rate adaptation for media endpoints | 13.5.0 | +| 2016-09 | CT#73 | CP-160429 | 0111 | 1 | Mandatory support of RTP/RTCP multiplexing | 14.0.0 | +| 2016-09 | CT#73 | CP-160431 | 0112 | 1 | Transport of T.140 within data channels | 14.0.0 | +| 2016-12 | CT#74 | CP-160684 | 0113 | 1 | Support of RTP-level pause and resume functionality | 14.1.0 | +| 2017-03 | CT#75 | CP-170023 | 0115 | - | RFC 4572 obsoleted by draft-ietf-mmusic-4572-update | 14.2.0 | +| 2017-03 | CT#75 | CP-170051 | 0116 | 1 | RTCP Codec Control Commands and Indications | 14.2.0 | +| 2017-06 | CT#76 | CP-171015 | 0118 | - | Reference update: RFC 8122 | 14.3.0 | +| 2017-06 | CT#76 | CP-171027 | 0119 | - | Reference update: draft-ietf-mmusic-mux-exclusive | 14.3.0 | + +| | | | | | | | +|---------|--------|-----------|------|---|-------------------------------------------------------------|--------| +| 2017-06 | CT#76 | CP-171024 | 0121 | - | Reference update: draft-ietf-mmusic-sctp-sdp | 14.3.0 | +| 2018-10 | - | - | - | - | Update to Rel-15 version (MCC) | 15.0.0 | +| 2019-06 | CT#84 | CP-191053 | 0149 | 2 | lq interface enhancement to support DBI | 16.0.0 | +| 2019-12 | CT#86 | CP-193019 | 0133 | - | Reference update: draft-ietf-mmusic-msrp-usage-data-channel | 16.1.0 | +| 2019-12 | CT#86 | CP-193019 | 0129 | 1 | Reference update: draft-ietf-mmusic-t140-usage-data-channel | 16.1.0 | +| 2020-12 | CT#90e | CP-203024 | 0138 | - | Update on draft references | 16.2.0 | +| 2021-03 | CT#91e | CP-210066 | 0142 | - | Reference update: RFC 8841, RFC 8864 and RFC 8873 | 16.3.0 | +| 2021-03 | CT#91e | CP-210068 | 0145 | - | Reference update: RFC 8858 and RFC 8865 | 16.3.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29335/731f533b0599c8e42a063f06e4332045_img.jpg b/marked/Rel-16/29_series/29335/731f533b0599c8e42a063f06e4332045_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e3d67f6635edcadd7b0784083e6f7ebf2a88f51a --- /dev/null +++ b/marked/Rel-16/29_series/29335/731f533b0599c8e42a063f06e4332045_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0206dd401c8578d59b9a000bd1f8bd908c12f30c95e724e904a2a252ad5f1b5b +size 21447 diff --git a/marked/Rel-16/29_series/29335/740442c999390734911677f01af0316d_img.jpg b/marked/Rel-16/29_series/29335/740442c999390734911677f01af0316d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e7e672ebe71b8fa4c9c4d9f0c0cc480a55c0995d --- /dev/null +++ b/marked/Rel-16/29_series/29335/740442c999390734911677f01af0316d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:28672339cba607e8b9e6b53b1c144fc882abc446fe705c4907c27ee513cb9bf4 +size 24935 diff --git a/marked/Rel-16/29_series/29335/8307f6b04df072c9332f9987e034272c_img.jpg b/marked/Rel-16/29_series/29335/8307f6b04df072c9332f9987e034272c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9ee29b7cadff87e158726dff4abb16a6ff313333 --- /dev/null +++ b/marked/Rel-16/29_series/29335/8307f6b04df072c9332f9987e034272c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:171e3c64f39a45a39e491d93434b7bb28f0408122897ef05e8a029fa31764303 +size 74435 diff --git a/marked/Rel-16/29_series/29335/8592a32c2fdf17c1e562f0ba6b7e8e1a_img.jpg b/marked/Rel-16/29_series/29335/8592a32c2fdf17c1e562f0ba6b7e8e1a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a0f8d346866c4ec41358ad033679b4544cbceb38 --- /dev/null +++ b/marked/Rel-16/29_series/29335/8592a32c2fdf17c1e562f0ba6b7e8e1a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f477abf47231bf42115b29190c7c630943f066aebebd51853a357f281288f76c +size 59752 diff --git a/marked/Rel-16/29_series/29335/a83ba9e3e2c1e21dd69953a7b09e45b4_img.jpg b/marked/Rel-16/29_series/29335/a83ba9e3e2c1e21dd69953a7b09e45b4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8fb713f6d84584f75f06e29df7c1f5e6d7d7af75 --- /dev/null +++ b/marked/Rel-16/29_series/29335/a83ba9e3e2c1e21dd69953a7b09e45b4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0a057846667efab7e527c056a85a603954aa54a880a0b4cfdd2b6c6af91ff969 +size 73485 diff --git a/marked/Rel-16/29_series/29335/raw.md b/marked/Rel-16/29_series/29335/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..a5bcafa502dee81ac5f8375bb56e354315c7f024 --- /dev/null +++ b/marked/Rel-16/29_series/29335/raw.md @@ -0,0 +1,683 @@ + + + + +Error! No +text of + +Error! No text of specified style in +document. + +# Contents + +- Foreword ..... 5 +- 1 Scope..... 6 +- 2 References..... 6 +- 3 Definitions, symbols and abbreviations..... 7 + - 3.1 Definitions..... 7 + - 3.2 Symbols..... 7 + - 3.3 Abbreviations ..... 8 +- 4 Protocol Stack ..... 8 + - 4.1 General ..... 8 + - 4.2 Protocol Stack for Ud Data Access Messages ..... 8 + - 4.3 Protocol Stack for Ud Subscriptions/Notifications ..... 8 +- 5 General Messages ..... 9 + - 5.1 General ..... 9 + - 5.2 Open Link for a LDAP Session..... 9 + - 5.3 Close Link for a LDAP Session ..... 9 + - 5.4 Transactions ..... 9 + - 5.5 SOAP Authentication..... 10 +- 6 User Data Convergence Messages..... 10 + - 6.1 General ..... 10 + - 6.2 Query..... 10 + - 6.3 Create ..... 10 + - 6.4 Delete ..... 10 + - 6.5 Update ..... 10 + - 6.6 Subscribe ..... 11 + - 6.7 Notify ..... 11 + - 6.8 Abandon operation ..... 12 +- 7 Information Elements..... 12 + - 7.1 Information Element Types with LDAP..... 12 + - 7.2 Information Elements for Subscriptions and Notifications..... 13 + +8 Security ..... 13 + +**Annex A (normative): SOAP Subscription and Notification..... 14** + +A.1 XML schema for Subscribe Request ..... 14 + +A.2 XML schema for Subscribe Response..... 14 + +A.3 XML schema for Notify Request..... 15 + +A.4 XML schema for Notify Response ..... 16 + +**Annex B (informative): LDAP Message flows and Transaction flows for UDC ..... 17** + +B.1 General LDAP Message flow for UDC ..... 17 + +B.2 LDAP Transaction flows for UDC ..... 17 + +**Annex C (informative): Messages Based on SOAP..... 19** + +C.1 General..... 19 + +C.2 Protocol Stack for Messages Based on SOAP ..... 19 + +C.3 SOAP Based Query..... 20 + +C.4 SOAP Based Create ..... 20 + +C.5 SOAP Based Delete ..... 20 + +C.6 SOAP Based Update ..... 20 + +C.7 SOAP Based Abandon ..... 21 + +Annex D (informative): Change history..... 22 + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 1 Scope + +The present document specifies the stage 3 of the Ud interface between the Front-Ends (FEs) and the User Data Repository (UDR) in the User Data Convergence (UDC architecture). + +This 3GPP Technical Specification (TS) specifies the protocol and interactions between the FE and the UDR for Ud reference point, in particular: + +- The details of the LDAP protocol that are to be considered +- The details of the SOAP envelope that provide support for subscriptions to notifications and notifications about data changes service (S/N operations). + +The User Data Convergence Stage 2 description (architecture and information flows) is specified in 3GPP TS 23.335 [10]. + +The UDR data model used with LDAP (i.e. attributes, object classes and directory information tree) is implementation specific and is left outside the scope of 3GPP specifications. For multivendor interoperability between FEs and UDR specific integration projects are needed. Some examples of Ud data models are described in 3GPP TR 29.935 [19]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TR 41.001: "GSM Release specifications". +- [3] 3GPP TR 21 912 (V3.1.0): "Example 2, using fixed text". +- [4] IETF RFC 4510: "Lightweight Directory Access Protocol (v3)". +- [5] IETF RFC 5805: "Lightweight Directory Access Protocol (LDAP) Transactions". +- [6] W3C Recommendation "Simple Object Access Protocol (SOAP) 1.2" (27 April 2007). . +- [7] IETF RFC 2616 (June 1999): "Hypertext Transfer Protocol – HTTP/1.1". +- [8] IETF RFC 4511: "Lightweight Directory Access Protocol (LDAP): The Protocol". +- [9] IETF RFC 4528: "Lightweight Directory Access Protocol (LDAP) Assertion Control". +- [10] 3GPP TS 23.335: "User Data Convergence (UDC); Technical realization and information flows". +- [11] IETF RFC 4512: "Lightweight Directory Access Protocol (LDAP): Directory Information Models". +- [12] 3GPP TS 32.182: "Telecommunication management; User Data Convergence (UDC); Common Baseline Information Model". +- [13] Void +- [14] Void + +- [15] 3GPP TS 33.210: "3G Security; Network Domain Security; IP network layer security". +- [16] IETF RFC 4513: "Lightweight Directory Access Protocol (LDAP): Authentication Methods and Security Mechanisms". +- [17] National Institute of Standards and Technology, FIPS Pub 197: Advanced Encryption Standard (AES), 26 November 2001. . +- [18] OASIS "Directory Services Markup Language v2.0" (30 April 2002) . +- [19] 3GPP TR 29.935: "Study on UDC Data Model". +- [20] OASIS: "Web Services Security: SOAP Message Security 1.1 OASIS Standard Specification, 1 February 2006", . +- [21] OASIS: "Web Services Security: "UsernameToken Profile 1.1 OASIS Standard Specification, 1 February 2006", . + +# 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +**LDAP Session:** starts with LDAP Bind Operation and ends with LDAP Unbind Operation or Notice of Disconnection. + +**Front End:** a core network functional entity or service layer entity or provisioning entity that can access user data stored in a unique repository. + +**Front End Identifier:** A name that uniquely identifies an FE within the set of all FEs accessing an UDR. + +**Front End Cluster:** FEs handling the same application may be grouped in clusters to differentiate between them e.g. with regard to geographical location, feature support, vendor, or other characteristics. All FEs within a cluster are treated equally for required purposes (e.g. authorization, notifications, etc.). + +**Application type:** The application handled by a FE (e.g. HLR) determines the application type of the FE. The application type is derived from the name indicated by a FE. + +**Front End Cluster Identifier:** A name that identifies a cluster grouped with FEs supporting the same application. + +**User Data Repository:** facility where user data can be accessed stored and managed in a common way. + +## 3.2 Symbols + +For the purposes of the present document, the following symbols apply: + +| | | +|----|------------------------------------------| +| Ud | reference point between a FE and the UDR | +|----|------------------------------------------| + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|-----|-------------------------| +| FE | Front End | +| UDR | User Data Repository | +| NDS | Network Domain Security | + +# 4 Protocol Stack + +## 4.1 General + +Data access messages on the Ud interface shall make use of IETF RFC 4510 [4] and IETF RFC 4511 [8]. See section 4.2 for details. + +Subscription messages and Notification messages on the Ud interface shall make use of SOAP [6]. See section 4.3 for details. + +## 4.2 Protocol Stack for Ud Data Access Messages + +Figure 4.2-1 shows the protocol layering used for UDR data access. + +![Protocol layering diagram for Data Access between FE and UDR over the Ud interface.](731f533b0599c8e42a063f06e4332045_img.jpg) + +The diagram illustrates the protocol stack for data access over the Ud interface. It consists of two vertical protocol stacks, one for the FE (Front End) on the left and one for the UDR (User Data Repository) on the right, connected by a central vertical line labeled 'Ud'. Both stacks have five layers, which are aligned horizontally by lines. From top to bottom, the layers are: LDAP, TCP, IP, L2, and L1. The labels 'FE' and 'UDR' are placed below their respective stacks. + +Protocol layering diagram for Data Access between FE and UDR over the Ud interface. + +Figure 4.2-1 Protocol Layering for Data Access + +## 4.3 Protocol Stack for Ud Subscriptions/Notifications + +Figure 4.3-1 shows the protocol layering used for Ud Subscription/Notification. + +![Protocol layering diagram for Subscription/Notification between FE and UDR over the Ud interface.](740442c999390734911677f01af0316d_img.jpg) + +The diagram illustrates the protocol stack for subscription and notification messages over the Ud interface. It features two vertical protocol stacks, one for the FE on the left and one for the UDR on the right, separated by a central vertical line labeled 'Ud'. Both stacks consist of five layers, aligned horizontally. From top to bottom, the layers are: SOAP, HTTP / HTTPS, TCP/IP, L2, and L1. The labels 'FE' and 'UDR' are positioned below their respective stacks. + +Protocol layering diagram for Subscription/Notification between FE and UDR over the Ud interface. + +Figure 4.3-1 Protocol Layering for Subscription/Notification + +# 5 General Messages + +## 5.1 General + +This section describes common messages for UDC to establish sessions and administrate transactions. For an existing session, UDC messages are exchanged between the FE and the UDR. See figure B.1-1 in Annex B for general LDAP message flows. + +## 5.2 Open Link for a LDAP Session + +To initiate a LDAP session, a Front-End shall first establish a transport connection with the UDR. The transport connection shall be a TCP connection. The IP Layer may be secured according to section 8. When IPsec is used, an IPsec connection may support several TCP connections, each supporting a LDAP session. + +After establishment of the transport connection, the FE shall initiate a LDAP session by sending a LDAP BindRequest message. The establishment of the LDAP session shall comply with IETF RFC 4511 [8]. It shall be done before sending any other LDAP message. FE Identifier or FE Cluster Identifier shall be included in the BindRequest message. + +The UDR shall support the "unauthenticated authentication mechanism of simple Bind" and the "name/password authentication mechanism of simple Bind" in the "simple authentication method" specified in IETF RFC 4513 [16]. + +The UDR derives the application type from the FE Identifier or the FE Cluster Identifier. If the FE provided the Front End Identifier the UDR may also derive the Front End Cluster Identifier. + +NOTE: As security is handled at IP Layer (see section 8), optional security mechanisms (TLS, SASL) described in IETF RFC 4513 [16] specification are not required for Ud. + +## 5.3 Close Link for a LDAP Session + +Termination of the LDAP session may be initiated by the FE by sending an UnbindRequest message or by the UDR by sending a Notice of Disconnection message. The termination of the LDAP session shall comply with IETF RFC 4511 [8] + +## 5.4 Transactions + +In order to allow FEs to relate a number of update operations, such as Create (see 6.3), Delete (see 6.4), and Update (see 6.5), and have them performed in one unit of interaction, the transaction concept in IETF RFC 5805 "Lightweight Directory Access Protocol (LDAP) Transactions" [5] shall be supported. See figure B.2-1 in Annex B for LDAP Transaction flow. + +If used, they shall only be used for a single subscriber in order to decrease the complexity of transactions. + +LDAP server shall terminate the transaction if the timer is expired. + +## 5.5 SOAP Authentication + +The UDR may support the SOAP WS-Security extension [20] and "UsernameToken" authentication as specified by the Oasis Web Services Security [21]. + +The WS-Security Username field may be set to a value that is correlated with the username of the LDAP BindRequest (see clause 5.2). + +NOTE: As security is handled at the IP Layer (see clause 8), optional security mechanisms (i.e. signature, encryption and passwordDigest) as described in the Oasis Web Services Security specifications [20][21] are not required for the Ud interface. + +# 6 User Data Convergence Messages + +## 6.1 General + +The Query, Create, Delete and Update messages for UDC shall comply with IETF RFC 4511[8]. + +## 6.2 Query + +Query request messages shall be coded as LDAP SearchRequest messages. + +Query result messages shall be coded as LDAP SearchResultEntry, SearchResultReference, and SearchResultDone messages. + +## 6.3 Create + +Create request messages shall be coded as LDAP AddRequest messages or as LDAP ModifyRequest messages with the "operation" field set to "add", depending on the data to be created. + +Create result messages shall be coded as LDAP AddResponse messages or as LDAP ModifyResponse messages, depending on the used LDAP request message. + +## 6.4 Delete + +Delete request messages shall be coded as LDAP DelRequest messages or as LDAP ModifyRequest messages with the "operation" field set to "delete", depending on the data to be deleted. + +Delete result messages shall be coded as LDAP DelResponse messages or as LDAP ModifyResponse messages, depending on the used LDAP request message. + +The LDAP assertion control as specified in IETF RFC 4528 [9] may be used for conditional delete operation if the FE knows that the UDR supports the corresponding control. + +## 6.5 Update + +Update request messages shall be coded as LDAP ModifyRequest messages with "operation" field set to "replace". + +Update result messages shall be coded as LDAP ModifyResponse messages. + +The LDAP assertion control as specified in IETF RFC 4528 [9] may be used for conditional update operation if the FE knows that the UDR supports the corresponding control. + +## 6.6 Subscribe + +Subscribe request messages shall make use of the HTTP Post method and contain a SOAP message envelope. + +Subscribe response messages shall be coded as HTTP response message and shall contain a SOAP envelope. + +Subscribe request and response messages shall contain a SOAP message envelope header with a header block containing the following elements: + +- **msgId** +This element uniquely identifies the Subscribe message request – response pair within a connection. The msgId is of type integer. The FE shall allocate the value and use it together with the connId (if any) to correlate a received subscribe response with a sent subscribe request. +- **connId** +This optional element identifies the connection between FE and UDR. The connId is of type integer. If used, the value is allocated by the FE and is used together with the msgId to correlate a subscribe response with a subscribe request. + +Optionally, the Subscribe request SOAP message envelope may contain an authentication ws-security header block and a UsernameToken element containing the following elements: + +- Username +- Password + +An example of a SOAP envelope header for a Subscribe request message is given below: + +``` + + + + http://udfe.example.org:8080/UDRNotificationService + + password + + + + 25409 + 2 + + +``` + +The UDR shall copy the SOAP Envelope CorrelationHeader received in the Subscribe request and send it unmodified in the Subscribe response. + +Subscribe request messages shall contain a SOAP message envelope body formatted according to the XML schema defined in Annex A. + +Subscribe response messages shall contain an empty SOAP message envelope body, unless SOAP Fault element is included to indicate detailed error information. The HTTP status code in the Subscribe response message is used to indicate success or failure. + +A Subscribe request containing several subscriptions shall be managed in an atomic manner. In the event where at least one requestedData elements among several within a Subscribe request is rejected, the Subscribe response shall report a failure and none of the requestedData elements within this Subscribe request shall be accepted by the UDR. A SOAP Fault element may be included to indicate detailed error information relevant to the first error encountered. + +## 6.7 Notify + +Notify request messages shall make use of the HTTP Post method and contain a SOAP message envelope. + +Notify response messages shall be coded as HTTP response message and shall contain a SOAP message envelope. + +Notify request and response messages shall contain a SOAP message envelope header with a header block containing the following elements: + +- **serviceName** +This optional element identifies a service in the Front End. The value is copied from the Subscribe message or pre-configured in the UDR. The serviceName is of type string with up to 20 characters. +- **msgId** +This element uniquely identifies the Notify message request – response pair within a connection. The msgId is of type integer. The UDR shall allocate the value and use it together with the connId (if any) to correlate a received notify response with a sent notify request. +- **connId** +This optional element identifies the connection between the UDR and the FE. The connId is of type integer. If used, the value is allocated by the UDR and is used together with the msgId to correlate a notify response with a notify request. + +An example of a SOAP envelope header for a Notify request message is given below: + +``` + + + HLR-FE + 787627350 + 1 + + +``` + +``` + + +``` + +Application Front Ends shall copy the SOAP Envelope Header received in the Notify request and send it unmodified in the Notify response. + +Notify request messages shall contain a SOAP message envelope body formatted according to the XML schema defined in Annex A. + +Notify response messages shall contain an empty SOAP message envelope body, unless SOAP Fault element is included to indicate detailed error information. The HTTP status code in the Notify response message is used to indicate success or failure. + +## 6.8 Abandon operation + +When a FE wishes to abandon an uncompleted operation towards the UDR, it shall send a LDAP AbandonRequest message. + +# --- 7 Information Elements + +## 7.1 Information Element Types with LDAP + +Information elements and their type to be used in the messages on a given Ud interface for the LDAP Search, Add, Delete and Modify operations are dependent of the application type of the Ud interface. They are described in a LDAP Directory Schema associated to this application type. The general content and structure of a LDAP Directory Schema is described in IETF RFC 4512 [11]. + +NOTE: The LDAP Directory Schema associated to an application type relates to the application data view mentioned in 3GPP TS 23.335 [10]. + +When Information elements that are used on a given Ud interface are addressed in 3GPP TS 32.182 [12], their description in the LDAP Directory Schema associated to the application type of this Ud interface shall comply with 3GPP TS 32.182 [12]. + +## 7.2 Information Elements for Subscriptions and Notifications + +Information elements and their type to be used for subscriptions and notifications about data changes shall also follow the rules specified above in 7.1 and according to the formats/schemas defined in Annex A. + +# --- 8 Security + +Ud interface shall provide security with the methods specified in 3GPP TS 33.210 [15] + +Application sensitive data (e.g. permanent authentication keys K/Ki) shall be stored encrypted in the UDR and transferred encrypted over Ud. All FEs (e.g. HLR/HSS/AuC) handling sensitive data, accessing the same UDR and handling the same users (e.g. belonging to the same cluster) shall use the same mechanism and key for decrypting these data. The Application FEs shall support at least AES [17] as a common algorithm, and may support additional algorithms. The key for encryption/decryption is not subscriber-specific. + +Editor's note: details of AES (modes of operation, key lengths, data formats, etc.) are to be completed. + +Editor's note: statement above must be reviewed and confirmed by SA3 + +# Annex A (normative): SOAP Subscription and Notification + +## A.1 XML schema for Subscribe Request + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +The `serviceName` element is optional and, when present, identifies a service in the Front End. The `serviceName` is stored in the UDR and is used when the Notify message is sent. The `serviceName` is of type string with up to 20 characters. + +## A.2 XML schema for Subscribe Response + +The SOAP message envelope body shall be empty. + +## A.3 XML schema for Notify Request + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +## --- A.4 XML schema for Notify Response + +The SOAP message envelope body shall be empty. + +# Annex B (informative): LDAP Message flows and Transaction flows for UDC + +## B.1 General LDAP Message flow for UDC + +![Sequence diagram showing LDAP message flow between FE and UDR. The sequence includes LDAP Bind Request/Response, LDAP XXX Request/Response, LDAP Unbind Request/Response, and LDAP Notice of Disconnection. A bracket on the right side groups the messages from Bind Request to Unbind Response as an 'LDAP Session'.](a83ba9e3e2c1e21dd69953a7b09e45b4_img.jpg) + +``` +sequenceDiagram + participant FE + participant UDR + Note right of UDR: LDAP Session + FE->>UDR: LDAP Bind Request + UDR-->>FE: LDAP Bind Response + Note right of UDR: ..... + FE->>UDR: LDAP XXX Request + UDR-->>FE: LDAP XXX Response + Note right of UDR: ..... + FE->>UDR: LDAP Unbind Request + UDR-->>FE: LDAP Unbind Response + Note right of UDR: OR + UDR-->>FE: LDAP Notice of Disconnection +``` + +Sequence diagram showing LDAP message flow between FE and UDR. The sequence includes LDAP Bind Request/Response, LDAP XXX Request/Response, LDAP Unbind Request/Response, and LDAP Notice of Disconnection. A bracket on the right side groups the messages from Bind Request to Unbind Response as an 'LDAP Session'. + +Figure B.1-1. General LDAP Message flow + +Figure B.1-1 illustrates the general LDAP message flow associated to a LDAP session for UDC, in compliance with IETF RFC 4511[8]. + +## B.2 LDAP Transaction flows for UDC + +Figure B.2-1 illustrates the LDAP transaction flow for UDC. The procedures described in IETF RFC 5805 "Lightweight Directory Access Protocol (LDAP) Transactions" [5] are applied. + +![Sequence diagram showing LDAP Transaction flow between FE and UDR. The sequence includes: 1. Start Transaction Request (FE to UDR), 2. Start Transaction Response (Transaction ID) (UDR to FE), 3. LDAP XXX Request/Response (Transaction ID) (FE to UDR), 4. LDAP XXX Request/Response (Transaction ID) (FE to UDR), 5. End Transaction Request (Transaction ID) (FE to UDR), 6. End Transaction Response (UDR to FE). A bracket on the right side groups steps 2 through 5 as 'One Transaction'.](8307f6b04df072c9332f9987e034272c_img.jpg) + +``` + +sequenceDiagram + participant FE + participant UDR + FE->>UDR: 1. Start Transaction Request + UDR-->>FE: 2. Start Transaction Response (Transaction ID) + FE->>UDR: 3. LDAP XXX Request/Response (Transaction ID) + Note over FE,UDR: ...... + FE->>UDR: 4. LDAP XXX Request/Response (Transaction ID) + FE->>UDR: 5. End Transaction Request (Transaction ID) + UDR-->>FE: 6. End Transaction Response + Note right of UDR: One Transaction + +``` + +Sequence diagram showing LDAP Transaction flow between FE and UDR. The sequence includes: 1. Start Transaction Request (FE to UDR), 2. Start Transaction Response (Transaction ID) (UDR to FE), 3. LDAP XXX Request/Response (Transaction ID) (FE to UDR), 4. LDAP XXX Request/Response (Transaction ID) (FE to UDR), 5. End Transaction Request (Transaction ID) (FE to UDR), 6. End Transaction Response (UDR to FE). A bracket on the right side groups steps 2 through 5 as 'One Transaction'. + +**Figure B.2-1. LDAP Transaction flow** + +1. When the FE needs to bind more than one operation to the UDR in one FE session, the FE issues a Start Transaction Request to UDR to begin a transaction. +2. When receiving a Start Transaction Request, the UDR checks whether the transaction is allowed, e.g. check whether the number of the concurrent transaction exceeds the limit. If the transaction is allowed, the UDR returns a Start Transaction Response with an identity of the transaction assigned by the UDR to the FE and store the transaction identity temporarily until the transaction ends or expires. Otherwise, a Start Transaction Response with the failure code is returned. +- 3-4. If the result code indicates failure, the following steps are skipped and the procedure terminates. Otherwise, the FE issues the operations to the UDR with the transaction identity received in the Start Transaction Response message from the UDR. The operations with the same transaction identity are in the same transaction. +5. After all or some of the operations are performed, the FE sends an End Transaction Request with the transaction identity to the UDR to commit or rollback the transaction according to the application logic of the FE. +6. When commitment is indicated in the End Transaction Request, the UDR commits all the updates made. If all the updates are committed successfully, a success response is indicated in the End Transaction Response. Otherwise, all the updates are rolled back and the data remains as it was before the transaction and failure is indicated in the End Transaction Response. When rollback is indicated in the End Transaction Request, the UDR cancels all the updates made and return the End Transaction Response with the cancel result to the FE. + +# Annex C (informative): Messages Based on SOAP + +## C.1 General + +Some Front Ends which do not have high real time performance requirements would prefer to interact with the UDR on the basis of a SOAP protocol for data access (CRUD) as well as for Subscriptions and Notifications (S/N). A way to accomplish this is by means of a protocol converter that converts SOAP based data access messages into LDAP based data access messages. SOAP based Subscription and Notification messages need not be converted. The architectural options are shown in figure C.1/1: + +![Diagram showing data access options based on SOAP between various Front Ends (HLR/HSS FE, FE with no high real time requirements) and the UDR. It illustrates the use of Protocol Converters to translate between SOAP and LDAP protocols for CRUD and S/N messages.](8592a32c2fdf17c1e562f0ba6b7e8e1a_img.jpg) + +The diagram illustrates four architectural options for Front End (FE) connections to a Unified Data Repository (UDR): + +- HLR/HSS FE:** Connects directly to the UDR using LDAP (CRUD) and SOAP (S/N) protocols. +- FE (no high real time requirements):** Connects to the UDR via an internal Protocol Converter. The FE uses SOAP (CRUD) and SOAP (S/N), which are converted to LDAP (CRUD) and SOAP (S/N) respectively before reaching the UDR. +- FE (no high real time requirements):** Connects to the UDR via an external Protocol Converter. The FE uses SOAP (CRUD) and SOAP (S/N), which are converted to LDAP (CRUD) and SOAP (S/N) respectively before reaching the UDR. +- FE (no high real time requirements):** Connects to the UDR via a Protocol Converter integrated into the UDR. The FE uses SOAP (CRUD) and SOAP (S/N), which are converted to LDAP (CRUD) and SOAP (S/N) respectively before reaching the UDR. + +Diagram showing data access options based on SOAP between various Front Ends (HLR/HSS FE, FE with no high real time requirements) and the UDR. It illustrates the use of Protocol Converters to translate between SOAP and LDAP protocols for CRUD and S/N messages. + +Figure C.1/1: Data access options based on SOAP + +As shown in the Figure C.1/1, the Protocol Converter that converts SOAP based data access messages to LDAP based data access messages can be stand alone, be integrated into the FE or be integrated into the UDR. LDAP based data access (CRUD) messages and SOAP based Subscription and Notification (S/N) messages are specified in the normative part of this specification. A description of SOAP based data access messages which are exchanged between FEs without high realtime performance requirements and the Protocol Converter is given in this informative annex. + +NOTE: An application that does not have high real time requirements implies that it does not demand neither high values of traffic throughput nor small request/response latency values nor high demanding processing needs. + +## C.2 Protocol Stack for Messages Based on SOAP + +The protocol layering used for messages based on SOAP described in this informative annex is the same as shown in Figure 4.3-1 in the normative part of this specification. + +## C.3 SOAP Based Query + +SOAP Based Query request messages make use of the HTTP Post method and contain a SOAP message envelope. + +SOAP Based Query response messages are coded as HTTP response message and contain a SOAP envelope. + +Query request messages contain a SOAP message envelope body formatted according to the XML schema defined in OASIS DSML [18] related to SearchRequest. + +Query response messages contain a SOAP message envelope body formatted according to the XML schema defined in OASIS DSML [18] related to SearchResultEntry, SearchResultReference, and SearchResultDone. The HTTP status code in the Query response message is used to indicate success or failure. + +## --- C.4 SOAP Based Create + +SOAP Based Create request messages make use of the HTTP Post method and contain a SOAP message envelope. + +SOAP Based Create response messages are coded as HTTP response message and contain a SOAP envelope. + +Create request messages contain a SOAP message envelope body formatted according to the XML schema defined in OASIS DSML [18] related to AddRequest or ModifyRequest with the "operation" field set to "add". + +Create response messages contain a SOAP message envelope body formatted according to the XML schema defined in OASIS DSML [18] related to AddResponse or ModifyResponse depending on the used request message. The HTTP status code in the Create response message is used to indicate success or failure. + +## --- C.5 SOAP Based Delete + +SOAP Based Delete request messages make use of the HTTP Post method and contain a SOAP message envelope. + +SOAP Based Delete response messages are coded as HTTP response message and contain a SOAP envelope. + +Delete request messages contain a SOAP message envelope body formatted according to the XML schema defined in OASIS DSML [20] related to DelRequest or ModifyRequest with the "operation" field set to "delete". + +Delete response messages contain a SOAP message envelope body formatted according to the XML schema defined in OASIS DSML [20] related to DelResponse or ModifyResponse depending on the used request message. The HTTP status code in the Delete response message is used to indicate success or failure. + +## --- C.6 SOAP Based Update + +SOAP Based Update request messages make use of the HTTP Post method and contain a SOAP message envelope. + +SOAP Based Update response messages are coded as HTTP response message and contain a SOAP envelope. + +Update request messages contain a SOAP message envelope body formatted according to the XML schema defined in OASIS DSML [18] related to ModifyRequest with the "operation" field set to "replace". + +Update response messages contain a SOAP message envelope body formatted according to the XML schema defined in OASIS DSML [18] related to ModifyResponse. The HTTP status code in the Update response message is used to indicate success or failure. + +## --- C.7 SOAP Based Abandon + +SOAP Based Abandon request messages make use of the HTTP Post method and contain a SOAP message envelope. Abandon request messages contain a SOAP message envelope body formatted according to the XML schema defined in OASIS DSML [18] related to AbandonRequest. + +# Annex D (informative): Change history + +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | New | +|---------|--------|-----------|------|-----|---------------------------------------------------------------------------|--------| +| 2010-03 | CT#47 | CP-100052 | | | 3GPP TS presented for information and approval. | 9.0.0 | +| 2010-06 | CT#48 | CP-100282 | 0001 | 1 | Removal of not used references | 9.1.0 | +| | | | 0002 | 1 | Reference to draft removed | | +| | | | 0003 | 2 | Removal of security editor's note | | +| 2010-09 | CT#49 | CP-100459 | 0004 | 4 | Subscription and Notification Messages | 9.2.0 | +| 2011-03 | CT#51 | CP-110055 | 0007 | 4 | Messages Based on SOAP | 10.0.0 | +| 2011-06 | CT#52 | CP-110267 | 0010 | 1 | UDC Notifications and Service Name | 10.1.0 | +| | | | 0012 | 1 | UDC Notifications and original entity | | +| 2012-09 | CT#57 | CP-120469 | 0013 | 1 | UDC Data Model in TS 29.335 | 11.0.0 | +| 2012-12 | CT#58 | CP-120721 | 0017 | - | SOAP Fault in Subscribe and Notify Response messages | 11.1.0 | +| 2014-09 | - | - | - | - | Update to Rel-12 version (MCC) | 12.0.0 | +| 2015-12 | - | - | - | - | Update to Rel-13 version (MCC) | 13.0.0 | +| 2016-06 | CT#72 | CP-160235 | 0019 | 1 | Authentication on the Ud SOAP Interface | 13.1.0 | +| 2016-06 | CT#72 | CP-160235 | 0020 | 1 | SOAP Subscription Request containing several subscriptions error handling | 13.1.0 | +| 2016-06 | | | | | References [20] and [21] corrected | 13.1.1 | +| 2017-03 | CT#75 | - | - | - | Update to Rel-14 version (MCC) | 14.0.0 | +| 2018-06 | CT#80 | - | - | - | Update to Rel-15 version (MCC) | 15.0.0 | +| 2020-07 | CT#88e | - | - | - | Update to Rel-16 version (MCC) | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29337/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-16/29_series/29337/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8f2434f204301bdddd0d7051570639fd9c53ac6d --- /dev/null +++ b/marked/Rel-16/29_series/29337/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:238a4f1407b2e241873ee2724279180dfe051fb2635294aa2eb7d53a70a711a7 +size 9478 diff --git a/marked/Rel-16/29_series/29337/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-16/29_series/29337/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c53c4e92ed1e583a828cca6f9df92f9f4cd18665 --- /dev/null +++ b/marked/Rel-16/29_series/29337/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4167d3c213d049289d0c1b03fb9bfc081a92a3ec71168f52859cc0bfe2e65a44 +size 6424 diff --git a/marked/Rel-16/29_series/29337/raw.md b/marked/Rel-16/29_series/29337/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..ec9871d82cd24ac7d2b514edf414586e074b239f --- /dev/null +++ b/marked/Rel-16/29_series/29337/raw.md @@ -0,0 +1,912 @@ + + +# 3GPP TS 29.337 V16.1.0 (2021-03) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Diameter-based T4 interface for communications with packet data networks and applications (Release 16)** + +![LTE Advanced Pro logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for LTE Advanced Pro, featuring the letters 'lte' in a bold, lowercase font. Above the 'e' is the text 'Advanced Pro' in a smaller font. To the right of the 'e' is a green signal icon consisting of three curved lines. + +LTE Advanced Pro logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, featuring the letters '3GPP' in a stylized, bold font. Below the 'P' is a red signal icon consisting of three curved lines. Below the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, uppercase font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2021, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|---------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions and Abbreviations ..... | 7 | +| 3.1 Abbreviations ..... | 7 | +| 4 General Description ..... | 7 | +| 5 MTC-IWF – SMS-SC (T4)..... | 8 | +| 5.1 Introduction ..... | 8 | +| 5.2 Procedure Descriptions ..... | 8 | +| 5.2.1 Device Trigger Procedure..... | 8 | +| 5.2.1.1 General..... | 8 | +| 5.2.1.2 Detailed Behaviour of the MTC-IWF..... | 10 | +| 5.2.1.3 Detailed Behaviour of the SMS-SC..... | 10 | +| 5.2.2 Delivery Report of Device Trigger..... | 11 | +| 5.2.2.1 General..... | 11 | +| 5.2.2.2 Detailed Behaviour of the SMS-SC..... | 12 | +| 5.2.2.3 Detailed Behaviour of the MTC-IWF..... | 13 | +| 6 Protocol Specification and Implementation..... | 13 | +| 6.1 General ..... | 13 | +| 6.1.1 Use of Diameter Base Protocol ..... | 13 | +| 6.1.2 Securing Diameter Messages ..... | 13 | +| 6.1.3 Accounting Functionality ..... | 13 | +| 6.1.4 Use of Sessions..... | 13 | +| 6.1.5 Transport Protocol..... | 13 | +| 6.1.6 Routing Considerations ..... | 14 | +| 6.1.7 Advertising Application Support..... | 14 | +| 6.1.8 Diameter Application Identifier ..... | 14 | +| 6.1.9 Use of the Supported-Features AVP ..... | 14 | +| 6.2 Commands..... | 15 | +| 6.2.1 Introduction ..... | 15 | +| 6.2.2 Command-Code Values..... | 15 | +| 6.2.3 Device-Trigger-Request (DTR) Command..... | 15 | +| 6.2.4 Device-Trigger-Answer (DTA) Command..... | 16 | +| 6.2.5 Delivery-Report-Request (DRR) Command..... | 16 | +| 6.2.6 Delivery-Report-Answer (DRA) Command ..... | 16 | +| 6.3 AVPs ..... | 17 | +| 6.3.1 SM-Delivery-Outcome-T4 ..... | 18 | +| 6.3.2 Absent-Subscriber-Diagnostic-T4..... | 18 | +| 6.3.3 Serving-Node..... | 19 | +| 6.3.4 Additional-Serving-Node ..... | 20 | +| 6.3.5 Supported-Feature-List AVP for the T4 application ..... | 21 | +| 6.3.6 Trigger-Action..... | 21 | +| 6.3.7 MTC-Error-Diagnostic ..... | 21 | +| 6.3.8 DRMP..... | 22 | +| 7 Result-Code and Experimental-Result Values..... | 22 | +| 7.1 General ..... | 22 | +| 7.2 Success ..... | 22 | +| 7.3 Permanent Failures ..... | 22 | +| 7.3.1 DIAMETER_ERROR_USER_UNKNOWN (5001) ..... | 22 | +| 7.3.2 DIAMETER_ERROR_INVALID_SME_ADDRESS (5530) ..... | 22 | +| 7.3.3 DIAMETER_ERROR_SC_CONGESTION (5531) ..... | 22 | +| 7.3.4 Void..... | 22 | +| 7.3.5 DIAMETER_ERROR_TRIGGER_REPLACE_FAILURE (5533)..... | 22 | + +7.3.6 DIAMETER\_ERROR\_TRIGGER\_RECALL\_FAILURE (5534)..... 22 +7.3.7 DIAMETER\_ERROR\_ORIGINAL\_MESSAGE\_NOT\_PENDING (5535)..... 23 +**Annex A (normative): Diameter message priority mechanism..... 23** +A.1 General ..... 23 +A.2 T4 interface ..... 23 +A.2.1 General ..... 23 +A.2.2 SMS-SC and MTC-IWF behaviour..... 23 +**Annex B (informative): Change history ..... 24** + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document describes the Diameter based interface between the Machine Type Communications-InterWorking Function (MTC-IWF) and the Short Message Service-Service Centre (SMS-SC) for communications with packet data networks and applications. + +This specification defines the Diameter application for the T4 reference point between the MTC-IWF and the SMS-SC. The interactions between the MTC-IWF and the SMS-SC are specified. + +MTC-IWF and SMS-SC (SMS-IWMSC) may also support the Diameter application for the SGd reference point to exchange SGd-OFR and SGd-OFA commands via T4. The stage 3 description for the SGd Diameter application is specified in 3GPP TS 29.338 [13]. + +The stage 2 description for communications with packet data networks and applications (architecture and functionality) is specified in the 3GPP TS 23.682 [2]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.682: "Architecture enhancements to facilitate communications with packet data networks and applications". +- [3] Void. +- [4] 3GPP TS 33.210: "3G Security; Network Domain Security; IP Network Layer Security". +- [5] IETF RFC 4960: "Stream Control Transmission Protocol". +- [6] 3GPP TS 29.229: "Cx and Dx interfaces based on the Diameter protocol". +- [7] 3GPP TS 29.228: "IP multimedia (IM) Subsystem Cx and Dx Interfaces; Signalling flows and Message Elements". +- [8] 3GPP TS 23.003: "Numbering, addressing and identification". +- [9] 3GPP TS 23.040: "Technical realization of the Short Message Service (SMS)". +- [10] IETF RFC 5234: "Augmented BNF for Syntax Specifications: ABNF". + +- [11] 3GPP TS 29.329: "Sh Interface based on the Diameter protocol". +- [12] 3GPP TS 29.336: "Home Subscriber Server (HSS) diameter interfaces for interworking with packet data networks and applications". +- [13] 3GPP TS 29.338: "Diameter based protocols to support SMS capable MMEs". +- [14] 3GPP TS 29.173: "Diameter-based SLh interface for Control Plane LCS". +- [15] 3GPP TS 29.368: "Tsp interface protocol between the MTC Interworking Function (MTC-IWF) and Service Capability Server (SCS)". +- [16] 3GPP TS 29.272: "Mobility Management Entity (MME) and Serving GPRS Support Node (SGSN) related interfaces based on Diameter protocol". +- [17] IETF RFC 4006: "Diameter Credit-Control Application". +- [18] IETF RFC 7944: "Diameter Routing Message Priority". +- [19] IETF RFC 6733: "Diameter Base Protocol". + +# --- 3 Definitions and Abbreviations + +## 3.1 Abbreviations + +For the purposes of the present document, the abbreviations given in TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in TR 21.905 [1]. + +| | | +|---------|-------------------------------------| +| ABNF | Augmented Backus-Naur Form | +| AVP | Attribute-Value Pair | +| C | Conditional | +| DRMP | Diameter Routing Message Priority | +| DSCP | Differentiated Services Code Point | +| IANA | Internet Assigned Numbers Authority | +| MTC | Machine-Type Communications | +| MTC-IWF | MTC Interworking Function | +| O | Optional | +| SCS | Service Capability Server | +| SMSF | Short Message Service Function | +| UDM | Unified Data Management | + +# --- 4 General Description + +The T4 reference point between the MTC-IWF and the SMS-SC is an intra PLMN interface, as defined in the 3GPP TS 23.682 [7]. + +This document describes the T4 interface related procedures, message parameters and protocol specifications. + +The T4 interface allows transfer of device trigger from MTC-IWF to SMS-SC inside HPLMN domain, along with the serving SGSN/MME/MSC/SMSF identities, and allows SMS-SC to report to MTC-IWF the submission outcome of a device trigger and the success or failure of delivering the device trigger to the UE. + +# --- 5 MTC-IWF – SMS-SC (T4) + +## 5.1 Introduction + +This section describes the Diameter-based T4 interface related procedures and information elements exchanged between the MTC-IWF and the SMS-SC. For the use of SGd-OFR and SGd-OFA commands over T4 (i.e. between MTC-IWF and SMS-SC) see 3GPP TS 29.338 [13]. + +In the tables that describe the Information Elements transported by each Diameter command, each Information Element is marked as (M) Mandatory, (C) Conditional or (O) Optional in the "Cat." column. For the correct handling of the Information Element according to the category type, see the description detailed in clause 6 of the 3GPP TS 29.228 [7]. + +## 5.2 Procedure Descriptions + +### 5.2.1 Device Trigger Procedure + +#### 5.2.1.1 General + +This procedure shall be used between the MTC-IWF and the SMS-SC for device trigger. The procedure shall be invoked by the MTC-IWF and is used: + +- to transfer device trigger to SMS-SC inside HPLMN domain; +- to transfer to the SMS-SC the identities of the serving MSC or MME but not both, and/or SGSN, and/or SMSF (for 3GPP and non-3GPP accesses); and/or IP-SM-GW serving the user for SMS along with device trigger. +- to transfer device trigger replace/recall message to SMS-SC inside HPLMN domain. + +This procedure is mapped to the commands Device-Trigger-Request/Answer in the Diameter application specified in chapter 6. Tables 5.2.1.1/1 and 5.2.1.1/2 detail the involved information elements. + +Table 5.2.1.1/1: Device Trigger Request + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|---------------------------------------------------------------|-------------------------|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| User Identifier
(See 3GPP TS 29.336 [12]) | User-Identifier | M | This information element shall contain the IMSI of the UE the trigger is to be applied, formatted according to 3GPP TS 23.003 [8], clause 2.2.
This Information Element may contain the international ISDN number of the UE the device trigger was delivered, formatted according to 3GPP TS 23.003 [8], clause 3.3. The ISDN number shall be present if it is available to the MTC-IWF.
This Information Element may contain the external identifier of the UE the device trigger was delivered, formatted according to 3GPP TS 23.003 [8], clause 19.7.2. The external identifier shall be present if it is available to the MTC-IWF. | +| SM RP SMEA
(See 3GPP TS 29.338 [13]) | SM-RP-SMEA | M | This Information Element shall contain the SME address of the Service Capability Server that is requesting a device trigger to the UE. It shall be encoded according to the formatting rules of the address fields described in 3GPP TS 23.040 [9]. | +| Payload(See 3GPP TS 29.368 [15]) | Payload | M | This information element shall contain the device triggering payload as received over the Tsp.
For device trigger recall, this IE shall be empty. | +| Serving Node Identity
(See 3GPP TS 29.173 [14]) | Serving-Node | C | This information element shall contain the serving node identity, i.e. SGSN/MME/MSC/SMSF identity serving the UE.
It shall be present if it is available to the MTC-IWF, e.g. the MTC-IWF retrieved this information from the HSS/UDM. | +| Additional Serving Node Identity
(See 3GPP TS 29.173 [14]) | Additional-Serving-Node | C | This information element shall contain another serving node identity, e.g. SGSN/MME/MSC/SMSF identity, if there is any serving the UE.
There may be multiple instances of this information elements. | +| Trigger Reference Number
(See 3GPP TS 29.368 [15]) | Reference-Number | C | This information element shall contain the Reference Number related to the device trigger request.
It shall be present if it is available to the MTC-IWF, e.g. the MTC-IWF received this information over Tsp. | +| Old Trigger Reference Number
(See 3GPP TS 29.368 [15]) | Old-Reference-Number | C | This information element shall contain the Reference Number of the device trigger to be replaced.
It shall be present if it is available to the MTC-IWF, e.g. the MTC-IWF received this information over Tsp. | +| Validity Time
(See 3GPP TS 29.368 [15]) | Validity-Time | C | This information element shall contain the validity time of the device trigger request.
It shall be present if it is available to the MTC-IWF, e.g. the MTC-IWF received this information over Tsp. | +| Priority Indication
(See 3GPP TS 29.368 [15]) | Priority-Indication | C | This information element shall contain the priority of the device trigger request..
It shall be present if it is available to the MTC-IWF, e.g. the MTC-IWF received this information over Tsp. | +| SMS Application Port ID
(See 3GPP TS 29.368 [15]) | SMS-Application-Port-ID | C | This information element shall contain the Application Port ID of the triggering application for the device trigger request.
It shall be present if it is available to the MTC-IWF, e.g. the MTC-IWF received this information over Tsp. | +| Supported Features
(See 3GPP TS 29.229 [6]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Trigger-Action
(See 6.3.6) | Trigger-Action | C | This information element shall be present for device trigger action replace or recall.
This information element may be present for a normal device. | + +Table 5.2.1.1/2: Device Trigger Answer + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------------------------------------|-----------------------------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result (See 7) | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation.
The Result-Code AVP shall be used to indicate success / errors as defined in the Diameter base protocol (see IETF RFC 6733 [19]).
The Experimental-Result AVP shall be used for T4 errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP.
The following errors are applicable:
- Service Centre Congestion;
- Invalid Short Message Entity Address;
- Subscriber not Service Centre Subscriber;
- SM Protocol Error;
- Trigger Replace failed;
- Trigger Recall failed;
- Original Message not pending. | +| MTC-Error-Diagnostic | MTC-Error-Diagnostic | O | If the Experimental Result indicates either "DIAMETER_ERROR_TRIGGER_REPLACE_FAILURE" or "DIAMETER_ERROR_ORIGINAL_MESSAGE_NOT_PENDING", Error Diagnostic may be present to indicate the reason why the replace has failed. | +| Supported Features (See 3GPP TS 29.229 [6]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Old Trigger Reference Number (See 3GPP TS 29.368 [15]) | Old-Reference-Number | C | This information element shall be included if the SMS-SC was requested to perform device trigger recall or replace. It shall contain the Reference Number of the device trigger which was intended to be replaced or recalled in the request. | +| Trigger-Action (see 6.3.6) | Trigger-Action | C | This information element shall be present for device trigger action replace or recall.
This information element may be present for a normal device trigger. | + +#### 5.2.1.2 Detailed Behaviour of the MTC-IWF + +The MTC-IWF shall make use of this procedure to transfer device trigger request received over Tsp interface from SCS to the SMS-SC. + +If the MTC-IWF retrieved the IMSI and serving node identities of the UE from the HSS/UDM, the MTC-IWF shall include these identities in the request to the SMS-SC. + +The MTC-IWF shall include the External Identifier of the UE if received over Tsp interface from SCS. + +The MTC-IWF shall include the Old Trigger Reference Number if received over Tsp interface from SCS. + +#### 5.2.1.3 Detailed Behaviour of the SMS-SC + +When receiving a Device Trigger Request, the SMS-SC shall check the identity of the UE received (i.e. IMSI or MSISDN) if it serves this UE. If not, a Result Code of DIAMETER\_ERROR\_USER\_UNKNOWN shall be returned. + +If the SM-RP-SMEA AVP contains an invalid SME address, the SMS-SC shall return a Result Code of DIAMETER\_ERROR\_INVALID\_SME\_ADDRESS. + +If the SMS-SC cannot fulfil the received request due to congestion, it shall return a Result Code of DIAMETER\_ERROR\_SC\_CONGESTION. + +If there are routing information (i.e. MSC or MME, SGSN, SMSF for 3GPP access, SMSF for non-3GPP access, IP-SM-GW identities serving the UE for SMS) present in the request, the SMS-SC shall use the information for delivery of device trigger request for the UE. The SMS-SC shall return a Result Code of DIAMETER\_SUCCESS to the MTC-IWF. + +NOTE: If the IP-SM-GW address is received, the SMS-SC uses the IP-SM-GW as the serving node with highest priority for delivery of device trigger request for the UE. + +If there is no routing information (i.e. MSC or MME, SGSN, SMSF, IP-SM-GW identities serving the UE for SMS) present in the request, the SMS-SC shall send a Report-SM-Delivery-Status message to the HLR/UDM in order to update the MWD in the HLR/UDM (see 3GPP TS 23.040 [9]). + +If Trigger-Action is received from the MTC-IWF and set to TRIGGER (0), SMS-SC shall store the new trigger message received from MTC-IWF. + +If Trigger-Action is received from the MTC-IWF and set to RECALL (1), SMS-SC checks if message corresponding to Reference-Number is pending. If trigger message is pending then SMS-SC deletes the old trigger message. The SMS-SC shall return Old-Reference-Number and a Result Code of DIAMETER\_SUCCESS to the MTC-IWF. For the successful scenario the SMS-SC is not required to initiate a device trigger reporting to the device trigger of Old-Reference-Number. If trigger message is not pending then SMS-SC shall return a Result Code of DIAMETER\_ERROR\_ORIGINAL\_MESSAGE\_NOT\_PENDING to the MTC-IWF. + +If Trigger-Action is received from the MTC-IWF and set to REPLACE (2), SMS-SC checks if message corresponding to Old-Reference-Number is pending. If trigger message is pending then SMS-SC shall delete the old trigger message and store the new trigger message received from MTC-IWF. The SMS-SC shall return OLD-Reference-Number and a Result Code of DIAMETER\_SUCCESS to the MTC-IWF. For the successful scenario the SMS-SC is not required to initiate a device trigger reporting to the device trigger of Old-Reference-Number. If trigger message is not pending then SMS-SC shall return OLD-Reference-Number and a Result Code of DIAMETER\_ERROR\_ORIGINAL\_MESSAGE\_NOT\_PENDING to the MTC-IWF and shall interpret the trigger replace message as a new device trigger. If the SMS-SC fails to perform deletion of the old trigger or fails to store the new trigger, it shall not delete the old trigger and shall not store the new trigger and shall return result code of DIAMETER\_ERROR\_TRIGGER\_REPLACE\_FAILURE. + +The SMS SC shall use the most appropriate cause code indicating the real reason for the unsuccessful handling of the request message. + +If the SMS-SC cannot fulfil the received request for reasons not stated in the above steps, e.g. due to system failure, it shall stop processing the request and set Result-Code to DIAMETER\_UNABLE\_TO\_COMPLY. + +### 5.2.2 Delivery Report of Device Trigger + +#### 5.2.2.1 General + +This procedure shall be used between the SMS-SC and the MTC-IWF for Delivery Report of Device Trigger. The procedure shall be invoked by the SMS-SC and is used: + +- to report the success or failure of delivering the device trigger to the UE. + +This procedure is mapped to the commands Delivery-Report-Request/Answer in the Diameter application specified in chapter 6. Tables 5.2.2.1/1 and 5.2.2.1/2 detail the involved information elements. + +Table 5.2.2.1/1: Delivery Report Request + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|-------------------------------------------------------|---------------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| User Identifier
(See 3GPP TS 29.336 [12]) | User-Identifier | M | This information element shall contain the IMSI of the UE the device trigger was delivered, formatted according to 3GPP TS 23.003 [8], clause 2.2.
This Information Element may contain the international ISDN number of the UE the device trigger was delivered, formatted according to 3GPP TS 23.003 [8], clause 3.3. The ISDN number shall be present if it is available to the SMS-SC.
This Information Element may contain the external identifier of the UE the device trigger was delivered, formatted according to 3GPP TS 23.003 [8], clause 19.7.2. The external identifier shall be present if it is available to the SMS-SC. | +| SM RP SMEA
(See 3GPP TS 29.338 [13]) | SM-RP-SMEA | M | This Information Element shall contain the SME address of the Service Capability Server that is requesting a device trigger to the UE as received from the MTC-IWF. | +| SM Delivery Outcome
(See 6.3.1) | SM-Delivery-Outcome | M | This information element shall be present and indicate one of the following outcomes of the device trigger delivery:
  • - Absent subscriber;
  • - UE memory capacity exceeded;
  • - Successful transfer.
| +| Absent Subscriber Diagnostic SM
(See 6.3.2) | Absent-Subscriber-Diagnostic-SM | C | This information element shall indicate the reason why the subscriber is absent.
It shall be present if the device trigger failed to be delivered due to absent subscriber. | +| Trigger Reference Number
(See 3GPP TS 29.368 [15]) | Reference-Number | C | This information element shall contain the Trigger Reference Number as received from the MTC-IWF for the device trigger.
This information element shall be present if it is available in the SMS-SC. | +| Supported Features
(See 3GPP TS 29.229 [6]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | + +Table 5.2.2.1/2: Delivery Report Answer + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|-----------------------------------|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result
(See 7) | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation.
The Result-Code AVP shall be used to indicate success / errors as defined in the Diameter base protocol (see IETF RFC 6733 [19]).
The Experimental-Result AVP shall be used for T4 errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | +| Supported Features
(See 3GPP TS 29.229 [6]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | + +#### 5.2.2.2 Detailed Behaviour of the SMS-SC + +The SMS-SC shall make use of this procedure to report the success or failure of delivering the device trigger to the UE to the MTC-IWF. + +The SMS-SC shall include the IMSI of the UE and, if available, other identities of the UE, i.e. the MSISDN and the external identifier. + +The SMS-SC shall include the External Identifier of the UE if the SMS-SC received it from MTC-IWF in the device trigger request message. + +The SMS-SC shall include an SM-RP-SMEA AVP that contains the SME address of the Service Capability Server that requested the device trigger to the UE as received from the MTC-IWF in the device trigger request message. + +The SMS-SC shall include an SM-Delivery-Outcome-T4 AVP that contains the outcome of the success or failure of delivering the device trigger to the UE. + +The SMS-SC shall include an Absent-Subscriber-Diagnostic-T4 AVP that contains the reason why the subscriber is absent if the device trigger failed to be delivered due to absent subscriber. + +#### 5.2.2.3 Detailed Behaviour of the MTC-IWF + +The MTC-IWF shall return a Result Code of DIAMETER\_SUCCESS to the SMS-SC. + +# --- 6 Protocol Specification and Implementation + +## 6.1 General + +### 6.1.1 Use of Diameter Base Protocol + +The Diameter base protocol as specified in IETF RFC 6733 [19] shall apply except as modified by the defined support of the methods and the defined support of the commands and AVPs, result and error codes as specified in this specification. Unless otherwise specified, the procedures (including error handling and unrecognised information handling) shall be used unmodified. + +### 6.1.2 Securing Diameter Messages + +For secure transport of Diameter messages, see 3GPP TS 33.210 [4] + +### 6.1.3 Accounting Functionality + +Accounting functionality (Accounting Session State Machine, related command codes and AVPs) shall not be used on the T4 interface. + +### 6.1.4 Use of Sessions + +Between the MTC-IWF and the SMS-SC, Diameter sessions shall be implicitly terminated. An implicitly terminated session is one for which the server does not maintain state information. The client shall not send any re-authorization or session termination requests to the server. + +The Diameter base protocol specified in IETF RFC 6733 [19] includes the Auth-Session-State AVP as the mechanism for the implementation of implicitly terminated sessions. + +The client (server) shall include in its requests (responses) the Auth-Session-State AVP set to the value NO\_STATE\_MAINTAINED (1), as described in IETF RFC 6733 [19]. As a consequence, the server shall not maintain any state information about this session and the client shall not send any session termination request. Neither the Authorization-Lifetime AVP nor the Session-Timeout AVP shall be present in requests or responses. + +### 6.1.5 Transport Protocol + +Diameter messages over the T4 interface shall make use of SCTP, see IETF RFC 4960 [5]. + +### 6.1.6 Routing Considerations + +This clause specifies the use of the Diameter routing AVPs Destination-Realm and Destination-Host. + +The T4 reference point is defined as an intra-operator interface, and both MTC-IWF and the SMS-SC are located in the same network domain. If the MTC-IWF knows the address/name of the SMS-SC for a certain user, both the Destination-Realm and Destination-Host AVPs shall be present in the request. Otherwise, the Destination-Realm AVP shall be present and the command shall be routed to the next Diameter node. Consequently, the Destination-Host AVP is declared as optional in the ABNF for all requests initiated by the MTC-IWF. + +The SMS-SC obtains the Destination-Host AVP to use in requests towards the MTC-IWF, from the Origin-Host AVP received in previous requests from the MTC-IWF. Consequently, the Destination-Host AVP is declared as mandatory in the ABNF for all requests initiated by the SMS-SC. + +If the Vendor-Specific-Application-ID AVP is received in any of the commands defined in this specification, it shall be ignored by the receiving node, and it shall not be used for routing purposes. + +### 6.1.7 Advertising Application Support + +The MTC-IWF and SMS-SC shall advertise support of the Diameter T4 Application by including the value of the application identifier in the Auth-Application-Id AVP within the Vendor-Specific-Application-Id grouped AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands. + +The vendor identifier value of 3GPP (10415) shall be included in the Supported-Vendor-Id AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands, and in the Vendor-Id AVP within the Vendor-Specific-Application-Id grouped AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands. + +The Vendor-Id AVP included in Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands that is not included in the Vendor-Specific-Application-Id AVPs as described above shall indicate the manufacturer of the Diameter node as per IETF RFC 6733 [19]. + +### 6.1.8 Diameter Application Identifier + +The T4 interface protocol shall be defined as an IETF vendor specific Diameter application, where the vendor is 3GPP. The vendor identifier assigned by IANA to 3GPP () is 10415. + +The Diameter application identifier assigned to the T4 interface application is 16777311 (allocated by IANA). + +### 6.1.9 Use of the Supported-Features AVP + +When new functionality is introduced on the T4 interface, it should be defined as optional. If backwards incompatible changes cannot be avoided, the new functionality shall be introduced as a new feature and support advertised with the Supported-Features AVP. The usage of the Supported-Features AVP on the T4 interface is consistent with the procedures for the dynamic discovery of supported features as defined in clause 7.2 of 3GPP TS 29.229 [6]. + +When extending the application by adding new AVPs for a feature, the new AVPs shall have the M bit cleared and the AVP shall not be defined mandatory in the command ABNF. + +As defined in 3GPP TS 29.229 [6], the Supported-Features AVP is of type grouped and contains the Vendor-Id, Feature-List-ID and Feature-List AVPs. On the all reference points as specified in this specification, the Supported-Features AVP is used to identify features that have been defined by 3GPP and hence, for features defined in this document, the Vendor-Id AVP shall contain the vendor ID of 3GPP (10415). If there are multiple feature lists defined for the reference point, the Feature-List-ID AVP shall differentiate those lists from one another. + +The Table 6.3.5 defines the features applicable to the T4 reference point for the feature list with a Feature-List-ID of 1. + +## 6.2 Commands + +### 6.2.1 Introduction + +This section defines the Command code values and related ABNF for each command described in this specification. + +### 6.2.2 Command-Code Values + +This section defines Command-Code values for the T4 interface application as allocated by IANA. + +Every command is defined by means of the ABNF syntax IETF RFC 5234 [10], according to the Command Code Format (CCF) specification defined in IETF RFC 6733 [19]. In the case, the definition and use of an AVP is not specified in this document, the guidelines in IETF RFC 6733 [19] shall apply. + +The Vendor-Specific-Application-Id AVP shall not be included in any command sent by Diameter nodes supporting applications defined in this specification. If the Vendor-Specific-Application-Id AVP is received in any of the commands defined in this specification, it shall be ignored by the receiving node. + +NOTE: The Vendor-Specific-Application-Id is included as an optional AVP in all Command Code Format specifications defined in this specification in order to overcome potential interoperability issues with intermediate Diameter agents non-compliant with the IETF RFC 6733 [19]. + +The following Command Codes are defined in this specification: + +**Table 7.2.2/1: Command-Code values for T4** + +| Command-Name | Abbreviation | Code | Section | +|-------------------------|--------------|---------|---------| +| Device-Trigger-Request | DTR | 8388643 | 6.2.3 | +| Device-Trigger- Answer | DTA | 8388643 | 6.2.4 | +| Delivery-Report-Request | DRR | 8388644 | 6.2.5 | +| Delivery-Report-Answer | DRA | 8388644 | 6.2.6 | + +For these commands, the Application-ID field shall be set to 16777311 (application identifier of the T4 interface application, allocated by IANA). + +### 6.2.3 Device-Trigger-Request (DTR) Command + +The Device-Trigger-Request (DTR) command, indicated by the Command-Code field set to 8388643 and the "R" bit set in the Command Flags field, is sent from the MTC-IWF to the SMS-SC. + +Message Format + +``` +< Device-Trigger-Request > ::= < Diameter Header: 8388643, REQ, PXY, 16777311 > +< Session-Id > +[ DRMP ] +{ Auth-Session-State } +{ Origin-Host } +{ Origin-Realm } +[ Destination-Host ] +{ Destination-Realm } +{ User-Identifier } +{ SM-RP-SMEA } +{ Payload } +[ Serving-Node ] +*[ Additional-Serving-Node ] +[ Reference-Number ] +[ Validity-Time ] +[ Priority-Indication ] +[ SMS-Application-Port-ID ] +[ Old-Rference-Number ] +[ Trigger-Action ] +*[ Supported-Features ] +*[ AVP ] +*[ Proxy-Info ] +*[ Route-Record ] +``` + +### 6.2.4 Device-Trigger-Answer (DTA) Command + +The Device-Trigger-Answer (DTA) command, indicated by the Command-Code field set to 8388643 and the "R" bit cleared in the Command Flags field, is sent from the SMS-SC to the MTC-IWF. + +Message Format + +``` +< Device-Trigger-Answer > ::= < Diameter Header: 8388643, PXY, 16777311 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + [ Result-Code ] + [ Experimental-Result ] + [ MTC-Error-Diagnostic ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ Old-Reference-Number ] + [ Trigger-Action ] + *[ Supported-Features ] + *[ AVP ] + [ Failed-AVP ] + *[ Proxy-Info ] + *[ Route-Record ] +``` + +### 6.2.5 Delivery-Report-Request (DRR) Command + +The Delivery-Report-Request (DRR) command, indicated by the Command-Code field set to 8388644 and the "R" bit set in the Command Flags field, is sent from the SMS-SC to the MTC-IWF. + +Message Format + +``` +< Delivery-Report-Request > ::= < Diameter Header: 8388644, REQ, PXY, 16777311 > + < Session-Id > + [ DRMP ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + { Destination-Host } + { Destination-Realm } + { User-Identifier } + { SM-RP-SMEA } + { SM-Delivery-Outcome-T4 } + [ Absent-Subscriber-Diagnostic-T4 ] + [ Reference-Number ] + *[ Supported-Features ] + *[ AVP ] + *[ Proxy-Info ] + *[ Route-Record ] +``` + +### 6.2.6 Delivery-Report-Answer (DRA) Command + +The Delivery-Report-Answer (DRA) command, indicated by the Command-Code field set to 8388644 and the "R" bit cleared in the Command Flags field, is sent from the MTC-IWF to the SMS-SC. + +Message Format + +``` +< Delivery-Report-Answer > ::= < Diameter Header: 8388644, PXY, 16777311 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + [ Result-Code ] + [ Experimental-Result ] +``` + +``` + +{ Auth-Session-State } +{ Origin-Host } +{ Origin-Realm } +*[ Supported-Features ] +*[ AVP ] +[ Failed-AVP ] +*[ Proxy-Info ] +*[ Route-Record ] + +``` + +## 6.3 AVPs + +The following table specifies the Diameter AVPs defined for the T4 interface protocol, their AVP Code values, types, possible flag values and whether or not the AVP may be encrypted. The Vendor-ID header of all AVPs defined in this specification shall be set to 3GPP (10415). + +**Table 6.3.1/1: T4 specific Diameter AVPs** + +| Attribute Name | AVP Code | Section defined | Value Type | AVP Flag rules | | | | | +|---------------------------------|----------|-----------------|------------|----------------|-----|------------|----------|-----------| +| | | | | Must | May | Should not | Must not | May Encr. | +| SM-Delivery-Outcome-T4 | 3200 | 6.3.1 | Enumerated | M, V | | | | No | +| Absent-Subscriber-Diagnostic-T4 | 3201 | 6.3.2 | Enumerated | M, V | | | | No | +| Trigger-Action | 3202 | 6.3.6 | Unsigned32 | V | | | M | No | +| MTC-Error-Diagnostic | 3203 | 6.3.7 | Unsigned32 | V | | | M | No | + +NOTE 1: The AVP header bit denoted as "M", indicates whether support of the AVP is required. The AVP header bit denoted as "V", indicates whether the optional Vendor-ID field is present in the AVP header. For further details, see IETF RFC 6733 [19]. + +NOTE 2: If the M-bit is set for an AVP and the receiver does not understand the AVP, it shall return a rejection. If the M-bit is not set for an AVP, the receiver shall not return a rejection, whether or not it understands the AVP. If the receiver understands the AVP but the M-bit value does not match with the definition in this table, the receiver shall ignore the M-bit. + +The following table specifies the Diameter AVPs re-used by the T4 interface protocol from existing Diameter Applications, including a reference to their respective specifications and when needed, a short description of their use within T4. + +Any other AVPs from existing Diameter Applications, except for the AVPs from Diameter base protocol specified in IETF RFC 6733 [19], do not need to be supported. The AVPs from Diameter base protocol specified in IETF RFC 6733 [19] are not included in table 6.3.1/2, but they may be re-used for the T4 protocol. + +Table 6.3.1/2: T4 re-used Diameter AVPs + +| Attribute Name | Reference | Comments | M-bit | +|-------------------------|---------------------|------------------|--------------| +| User-Identifier | 3GPP TS 29.336 [12] | | | +| SM-RP-SMEA | 3GPP TS 29.338 [13] | | | +| Payload | 3GPP TS 29.368 [15] | | | +| Serving-Node | 3GPP TS 29.173 [14] | See 6.3.3 | | +| Additional-Serving-Node | 3GPP TS 29.173 [14] | See 6.3.4 | | +| Reference-Number | 3GPP TS 29.368 [15] | | | +| Old-Reference-Number | 3GPP TS 29.368 [15] | | | +| Validity-Time | IETF RFC 4006 [17] | | | +| Priority-Indication | 3GPP TS 29.368 [15] | | | +| SMS-Application-Port-ID | 3GPP TS 29.368 [15] | | | +| Supported-Features | 3GPP TS 29.229 [6] | | | +| Feature-List-ID | 3GPP TS 29.229 [6] | | | +| Feature-List | 3GPP TS 29.229 [6] | | | +| IP-SM-GW-Name | 3GPP TS 29.336 [12] | | | +| IP-SM-GW-Realm | 3GPP TS 29.336 [12] | | | +| IP-SM-GW-Number | 3GPP TS 29.336 [12] | | | +| MME-Number-for-MT-SMS | 3GPP TS 29.272 [16] | | | +| DRMP | IETF RFC 7944 [18] | see clause 6.3.8 | Must not set | +| SMSF-3GPP-Number | 3GPP TS 29.338 [13] | | | +| SMSF-Non-3GPP-Number | 3GPP TS 29.338 [13] | | | +| SMSF-3GPP-Name | 3GPP TS 29.338 [13] | | | +| SMSF-Non-3GPP-Name | 3GPP TS 29.338 [13] | | | +| SMSF-3GPP-Realm | 3GPP TS 29.338 [13] | | | +| SMSF-Non-3GPP-Realm | 3GPP TS 29.338 [13] | | | + +NOTE 1: The M-bit settings for re-used AVPs override those of the defining specifications that are referenced. Values include: "Must set", "Must not set". If the M-bit setting is blank, then the defining specification applies. + +NOTE 2: If the M-bit is set for an AVP and the receiver does not understand the AVP, it shall return a rejection. If the M-bit is not set for an AVP, the receiver shall not return a rejection, whether or not it understands the AVP. If the receiver understands the AVP but the M-bit value does not match with the definition in this table, the receiver shall ignore the M-bit. + +### 6.3.1 SM-Delivery-Outcome-T4 + +The SM-Delivery-Outcome-T4 AVP is of type Enumerated and indicates the outcomes of the device trigger delivery. The following values are defined: + +ABSENT\_SUBSCRIBER (0) + +This value is used when the device trigger delivery failed due to absent subscriber. + +UE\_MEMORY\_CAPACITY\_EXCEEDED (1) + +This value is used when the device trigger delivery failed due to UE memory capacity exceeded. + +SUCCESSFUL\_TRANSFER (2) + +This value is used when the device trigger delivery is successfully transferred to the UE. + +VALIDITY\_TIME\_EXPIRED (3) + +This value is used when the message was deleted in the SMS-SC due to expiration of the validity time. + +### 6.3.2 Absent-Subscriber-Diagnostic-T4 + +The Absent-Subscriber-Diagnostic-T4 AVP is of type Enumerated and indicates the reason why the subscriber is absent if the device trigger failed to be delivered due to absent subscriber. The following values are defined: + +NO\_PAGING\_RESPONSE (0) + +This value is used when there is no paging response via some of the serving nodes. + +UE\_DETACHED (1) + +This value is used when the UE is detached from all of the serving nodes. + +UE\_DEREGISTERED (2) + +This value is used when the UE is deregistered in the network. + +UE\_PURGED (3) + +This value is used when the UE is purged by some of the serving nodes. + +ROAMING\_RESTRICTION (4) + +This value is used when the UE is roaming restricted. + +UNIDENTIFIED\_SUBSCRIBER (5) + +This value is used when the user is unidentified in all of the serving nodes. + +### 6.3.3 Serving-Node + +The Serving-Node AVP is of type Grouped and it shall contain the name/number of the serving node to be used for T4-triggering. It is originally defined in 3GPP TS 29.173 [8]. + +Serving-Node ::= + +[ SMSF-3GPP-Name ] +[ SMSF-3GPP-Realm ] +[ SMSF-3GPP-Number ] +[ SMSF-Non-3GPP-Name ] +[ SMSF-Non-3GPP-Realm ] +[ SMSF-Non-3GPP-Number ] +[ SGSN-Name ] +[ SGSN-Realm ] +[ SGSN-Number ] +[ MME-Name ] +[ MME-Realm ] +[ MME-Number-for-MT-SMS ] +[ MSC-Number ] +[ IP-SM-GW-Number ] +[ IP-SM-GW-Name ] +[ IP-SM-GW-Realm ] +\*[AVP] + +The following combinations are allowed: + +- a) SGSN-Number + +- b) SGSN-Name & SGSN-Realm & SGSN-Number +- c) MME-Name & MME-Realm & MME-Number-for-MT-SMS +- d) MSC-Number +- e) MSC-Number & MME-Name & MME-Realm +- f) IP-SM-GW-Number +- g) IP-SM-GW-Number & IP-SM-GW-Name & IP-SM-GW-Realm +- h) SMSF-3GPP-Number +- i) SMSF-3GPP-Name & SMSF-3GPP-Realm & SMSF-3GPP-Number +- j) SMSF-Non-3GPP-Number +- k) SMSF-Non-3GPP-Name & SMSF-Non-3GPP-Realm & SMSF-Non-3GPP-Number + +### 6.3.4 Additional-Serving-Node + +The Additional Serving-Node AVP is of type Grouped and when present it shall contain the name/number of an additional serving node to be used for T4-triggering. It is originally defined in 3GPP TS 29.173 [8], + +Additional-Serving-Node ::= + +[ SMSF-3GPP-Name ] +[ SMSF-3GPP-Realm ] +[ SMSF-3GPP-Number ] +[ SMSF-Non-3GPP-Name ] +[ SMSF-Non-3GPP-Realm ] +[ SMSF-Non-3GPP-Number ] +[ SGSN-Name ] +[ SGSN-Realm ] +[ SGSN-Number ] +[ MME-Name ] +[ MME-Realm ] +[ MME-Number-for-MT-SMS ] +[ MSC-Number ] +\*[AVP] + +The following combinations are allowed: + +- a) SGSN-Number +- b) SGSN-Name & SGSN-Realm & SGSN-Number +- c) MME-Name & MME-Realm & MME-Number-for-MT-SMS +- d) MSC-Number +- e) MSC-Number & MME-Name & MME-Realm +- f) SMSF-3GPP-Number + +- g) SMSF-3GPP-Name & SMSF-3GPP-Realm & SMSF-3GPP-Number +- h) SMSF-Non-3GPP-Number +- i) SMSF-Non-3GPP-Name & SMSF-Non-3GPP-Realm & SMSF-Non-3GPP-Number + +### 6.3.5 Supported-Feature-List AVP for the T4 application + +The syntax of this AVP is defined in 3GPP TS 29.229 [6]. + +For the T4 application, the meaning of the bits shall be as defined in table 6.3.5 for the Supported-Feature-List-ID of 1. + +**Table 6.3.5: Features of Feature-List-ID 1 used in T4** + +| Feature bit | Feature | M/O | Description | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------|-----|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | Device-Trigger-Recall-Replace | O | This Feature indicates the support of the applicability to support the functionality for device trigger recall and and device trigger replace.
This Feature is applicable for the DTR/DTA command pair
For recall if an MTC-IWF or SMS-SC does not indicate the support of the feature the MTC-IWF shall not send device trigger recall requests to an SMS-SC and send a negative reply to the SCS.
For Replace if an MTC-IWF or SMS-SC does not indicate the support of the feature the MTC-IWF shall treat the device trigger replace as a new device trigger. | +| Feature bit: The order number of the bit within the Supported-Features AVP, e.g. "1".
Feature: A short name that can be used to refer to the bit and to the feature, e.g. " Device-Trigger-Recall-Replace ".
M/O: Defines if the implementation of the feature is mandatory ("M") or optional ("O").
Description: A clear textual description of the feature. | | | | + +### 6.3.6 Trigger-Action + +The Trigger Action AVP is of type Unsigned32 and indicates the type of the device trigger. The following values are defined: + +TRIGGER (0) + +This value is used when device trigger requests the storage and sending of a new device trigger. + +RECALL (1) + +This value is used when device trigger requests the removal of a pending device trigger. + +REPLACE (2) + +This value is used when device trigger requests the replacement of a pending device trigger. + +### 6.3.7 MTC-Error-Diagnostic + +The MTC-Error-Diagnostic AVP is of type Unsigned32. The following values are defined: + +- ORIGINAL\_MESSAGE\_NOT\_DELETED (0) + +This cause should be sent if the replace failed due to the fact that the old message is pending but could not be deleted in the SMS-SC. + +- NEW\_MESSAGE\_NOT\_STORED (1) + +This cause should be sent if the replace failed due to the fact that the new message could not be stored in the SMS-SC e.g. no resource available. + +### 6.3.8 DRMP + +The DRMP AVP is of type Enumerated and it is defined in IETF RFC 7944 [18]. This AVP allows the SMS-SC and the MTC-IWF to indicate the relative priority of Diameter messages. The DRMP AVP may be used to set the DSCP marking for transport of the associated Diameter message. + +# --- 7 Result-Code and Experimental-Result Values + +## 7.1 General + +This section defines result code values that shall be supported by all Diameter implementations that conform to this specification. + +## 7.2 Success + +Result codes that fall within the Success category shall be used to inform a peer that a request has been successfully completed. The Result-Code AVP values defined in the Diameter base protocol specified in IETF RFC 6733 [19] shall be applied. + +## 7.3 Permanent Failures + +Errors that fall within the Permanent Failures category shall be used to inform the peer that the request has failed, and should not be attempted again. The Result-Code AVP values defined in Diameter base protocol specified in IETF RFC 6733 [19] shall be applied. When one of the result codes defined here is included in a response, it shall be inside an Experimental-Result AVP and the Result-Code AVP shall be absent. + +### 7.3.1 DIAMETER\_ERROR\_USER\_UNKNOWN (5001) + +This result code shall be sent by the SMS-SC to indicate that the user identified by the IMSI or the MSISDN is unknown. + +### 7.3.2 DIAMETER\_ERROR\_INVALID\_SME\_ADDRESS (5530) + +This result code shall be sent by the SMS-SC to indicate that the SME address is invalid. + +### 7.3.3 DIAMETER\_ERROR\_SC\_CONGESTION (5531) + +This result code shall be sent by the SMS-SC to indicate that SC is congested and unable to deliver the device trigger request. + +### 7.3.4 Void + +### 7.3.5 DIAMETER\_ERROR\_TRIGGER\_REPLACE\_FAILURE (5533) + +This result code shall be sent by the SMS-SC to indicate that trigger replace has failed to delete the old message and/or to store the new message. + +### 7.3.6 DIAMETER\_ERROR\_TRIGGER\_RECALL\_FAILURE (5534) + +This result code shall be sent by the SMS-SC to indicate that trigger recall has failed. + +### 7.3.7 DIAMETER\_ERROR\_ORIGINAL\_MESSAGE\_NOT\_PENDING (5535) + +This result code shall be sent by the SMS-SC to indicate that trigger recall or replace has failed because the original message to be recalled or replaced is not stored any more in the SMS-SC. + +# --- Annex A (normative): Diameter message priority mechanism + +## A.1 General + +IETF RFC 7944 [18] specifies a Diameter routing message priority mechanism that allows Diameter nodes to indicate the relative priority of Diameter messages. With this information, other Diameter nodes may leverage the relative priority of Diameter messages into routing, resource allocation, set the DSCP marking for transport of the associated Diameter message, and also abatement decisions when overload control is applied. + +## A.2 T4 interface + +### A.2.1 General + +The Diameter message priority mechanism is an optional feature. + +### A.2.2 SMS-SC and MTC-IWF behaviour + +When the SMS-SC or the MTC-IWF support the Diameter message priority mechanism over the T4 interface, the SMS-SC or the MTC-IWF shall comply with IETF RFC 7944 [18]. + +The SMS-SC or the MTC-IWF sending a request shall determine the required priority according to its policies. When priority is required, the SMS-SC or the MTC-IWF shall include the DRMP AVP indicating the required priority level in the request it sends, and shall prioritise the request according to the required priority level. + +When the SMS-SC or the MTC-IWF receives the corresponding response, it shall prioritise the received response according to the priority level received within the DRMP AVP if present in the response, otherwise according to the priority level of the corresponding request. + +When the SMS-SC or the MTC-IWF receives a request, it shall handle the request according to the received DRMP AVP priority level. For the response, the SMS-SC or the MTC-IWF may modify the priority level received in the DRMP AVP according to its policies and shall handle the response according to the required priority level. If the required priority level is different from the priority level received in the request, the SMS-SC or the MTC-IWF shall include the DRMP AVP in the response. + +The SMS-SC and MTC-IWF decisions for a required priority and for the priority level value are implementation specific. + +If: + +- SMS-SC and the MTC-IWF supports using the Diameter message priority mechanism for DSCP marking purposes, +- the transport network utilizes DSCP marking, and +- message-dependant DSCP marking is possible for the protocol stack transporting Diameter, + +then the SMS-SC and the MTC-IWF shall set the DSCP marking for transport of the request or response according to the required priority level. + +Diameter requests related to high priority traffic shall contain a DRMP AVP with a high priority of which the level value is operator dependent. + +If the SMS-SC supporting the Diameter message priority mechanism receives a request message containing both the Priority-Indication AVP and the DRMP AVP, the SMS-SC shall prioritize the request according to priority level received within the DRMP AVP. + +# Annex B (informative): Change history + +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | New | +|---------|-------|-----------|------|-----|------------------------------------------------------------------------------|--------| +| 2012-09 | CT#57 | CP-120486 | | | TS presented for information and approval | 11.0.0 | +| 2012-12 | CT#58 | CP-120731 | 0001 | 2 | T4 Device Triggering via IMS | 11.1.0 | +| | | CP-120731 | 0002 | 1 | MWD update | | +| | | CP-120731 | 0003 | 1 | Add Reference for the Information Elements | | +| | | CP-120731 | 0004 | 3 | Removal of Editor's Notes | | +| 2013-03 | CT#59 | CP-130028 | 0005 | - | Application Port ID in T4 | 11.2.0 | +| 2013-06 | CT#60 | CP-130297 | 0006 | - | Delivery-Report-Request/Answer Description | 11.3.0 | +| 2013-06 | CT#60 | CP-130300 | 0007 | 1 | T4 complements related to Diameter for SMS with SGSN | 12.0.0 | +| 2014-03 | CT#63 | CP-140180 | 0008 | 3 | Protocol enhancements for the support of device recall and replace procedure | 12.1.0 | +| 2014-06 | CT#64 | CP-140251 | 0010 | 2 | Handling of error scenarios on trigger replace | 12.2.0 | +| | | CP-140251 | 0011 | 2 | Error handling, MTC error diagnostic | | +| 2014-09 | CT#65 | CP-140508 | 0012 | 1 | Reporting of Validity period of the trigger message expired in SMS-SC | 12.3.0 | +| 2014-12 | CT#66 | CP-140792 | 0014 | 1 | Trigger action in device trigger request | 12.4.0 | +| 2015-06 | CT#68 | CP-150247 | 0016 | - | Payload T4 parameter | 12.5.0 | +| | | CP-150247 | 0020 | - | SCS address for SMS over T4 | | +| | | CP-150248 | 0018 | 1 | IP-SM-GW-Realm | | +| 2015-09 | CT#69 | CP-150429 | 0023 | - | AVP names corrections | 12.6.0 | +| 2015-12 | CT#70 | CP-150746 | 0025 | 2 | Destination Host in the DTR command, IMSI presence | 12.7.0 | +| 2015-12 | CT#70 | | | | Automatic upgrade from previous Release version 12.7.0 | 13.0.0 | +| 2016-03 | CT#71 | CP-160023 | 0026 | 1 | Diameter message priority over T4 | 13.1.0 | +| 2016-12 | CT#74 | CP-160664 | 0027 | - | Correction to change IETF drmp draft version to official RFC 7944 | 13.2.0 | +| 2017-03 | CT#75 | CP-170036 | 0028 | - | SMS-MO over T4 | 14.0.0 | +| 2017-03 | CT#75 | CP-170048 | 0029 | - | Update of reference for the Diameter base protocol | 14.0.0 | +| 2017-03 | CT#75 | CP-170048 | 0030 | 1 | Handling of the Vendor-Specific-Application-Id AVP | 14.0.0 | +| 2017-03 | CT#75 | CP-170048 | 0031 | - | Cardinality of the Failed-AVP AVP in answer | 14.0.0 | + +| | | | | | | | +|---------|--------|-----------|------|---|------------------------------------------------------|--------| +| 2017-06 | CT#76 | CP-171018 | 0033 | 1 | Support for signaling transport level packet marking | 14.1.0 | +| 2017-09 | CT#77 | CP-172013 | 0035 | - | Correction of DRMP Procedures | 14.2.0 | +| 2018-06 | CT#80 | - | - | - | Update to Rel-15 version (MCC) | 15.0.0 | +| 2020-07 | CT#88e | - | - | - | Update to Rel-16 version (MCC) | 16.0.0 | +| 2021-03 | CT#91e | CP-210048 | 0036 | - | Device Trigger Request for 5G Devices | 16.1.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29364/294444660b1376c49aeca748b8184e77_img.jpg b/marked/Rel-16/29_series/29364/294444660b1376c49aeca748b8184e77_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b2a2197f88f47a230cb23d9f4288c18317ead4bd --- /dev/null +++ b/marked/Rel-16/29_series/29364/294444660b1376c49aeca748b8184e77_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6a74e7be833a04a3ffa37844f9b3967cf17288c1c8bffe86d0dcd54699423b7c +size 80424 diff --git a/marked/Rel-16/29_series/29364/91b12db3c85bbf466ad27eb3665a1b06_img.jpg b/marked/Rel-16/29_series/29364/91b12db3c85bbf466ad27eb3665a1b06_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0ac3c7f3c3f04e1232c0b5c49697301b4215581b --- /dev/null +++ b/marked/Rel-16/29_series/29364/91b12db3c85bbf466ad27eb3665a1b06_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a9270592ecc122ec289d7c5e70272b6fc2831dd5871c5eff01ab17417b33247b +size 94462 diff --git a/marked/Rel-16/29_series/29364/raw.md b/marked/Rel-16/29_series/29364/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..fa67147fafd225ebb620bfc10819f4ac540b65a4 --- /dev/null +++ b/marked/Rel-16/29_series/29364/raw.md @@ -0,0 +1,3530 @@ + + + + +. + +# Contents + +| | | +|--------------------------------------------------------------------------------------|----| +| Foreword ..... | 7 | +| Introduction ..... | 7 | +| 1 Scope..... | 7 | +| 2 References..... | 8 | +| 3 Definitions, symbols and abbreviations..... | 9 | +| 3.1 Definitions..... | 9 | +| 3.2 Abbreviations ..... | 9 | +| 4 General..... | 10 | +| 5 Architecture..... | 10 | +| 6 Specification with the binary option..... | 11 | +| 6.1 MMTEL service content with the binary option ..... | 11 | +| 6.1.1 List of IMS Multimedia Telephony supplementary services ..... | 11 | +| 6.1.2 Subset of MMTEL services matching PSTN/ISDN and CS supplementary services..... | 12 | +| 6.1.2.1 Originating Identification Presentation (OIP)..... | 12 | +| 6.1.2.2 Originating Identification Restriction (OIR) ..... | 12 | +| 6.1.2.3 Terminating Identification Presentation (TIP)..... | 12 | +| 6.1.2.4 Terminating Identification Restriction (TIR) ..... | 13 | +| 6.1.2.5 Malicious Communication IDentification (MCID)..... | 13 | +| 6.1.2.6 Anonymous Communication Rejection (ACR)..... | 13 | +| 6.1.2.7 Communication DIVersion (CDIV) ..... | 13 | +| 6.1.2.7.1 Subscription options for CDIV services..... | 14 | +| 6.1.2.7.2 Communication Forwarding Unconditional (CFU) ..... | 14 | +| 6.1.2.7.3 Communication Forwarding Busy (CFB)..... | 14 | +| 6.1.2.7.4 Communication Forwarding No Reply (CFNR)..... | 15 | +| 6.1.2.7.5 Communication Forwarding on Not Logged in (CFNL) ..... | 15 | +| 6.1.2.7.6 Communication Deflection (CD)..... | 15 | +| 6.1.2.7.7 Communication Forwarding on Subscriber Not Reachable (CFNRc)..... | 15 | +| 6.1.2.7.8 Void..... | 16 | +| 6.1.2.7.9 Network provider options for CDIV services ..... | 16 | +| 6.1.2.8 Communication Waiting (CW)..... | 16 | +| 6.1.2.9 Communication HOLD (HOLD)..... | 16 | +| 6.1.2.10 Communication Barring (CB) ..... | 16 | +| 6.1.2.11 Completion of Communications to Busy Subscriber (CCBS)..... | 16 | +| 6.1.2.12 Completion of Communications on No Reply (CCNR)..... | 17 | +| 6.1.2.13 Message Waiting Indication (MWI)..... | 17 | +| 6.1.2.14 CONference (CONF)..... | 17 | +| 6.1.2.15 Advice Of Charge (AOC)..... | 17 | +| 6.1.2.16 Explicit Communication Transfer (ECT) ..... | 17 | +| 6.1.2.17 Reverse Charging..... | 17 | +| 6.1.2.18 Closed User Group (CUG) ..... | 18 | +| 6.1.2.19 Three-Party (3PTY) ..... | 18 | +| 6.1.2.20 Flexible Alerting (FA) ..... | 18 | +| 6.1.2.21 Customized Alerting Tones (CAT)..... | 18 | +| 6.2 Datasets and Service Indications..... | 18 | +| 6.2.1 Introduction ..... | 18 | +| 6.2.2 Datasets..... | 19 | +| 6.2.3 Service Indications ..... | 19 | +| 6.3 Binary coding general ..... | 19 | +| 6.3.1 Introduction ..... | 19 | +| 6.3.2 Dataset layout..... | 19 | +| 6.3.3 Order..... | 20 | +| 6.3.4 Character representation..... | 20 | +| 6.3.5 Byte representation..... | 20 | +| 6.3.6 Variable size data ..... | 20 | +| 6.3.7 Variable length data constraints ..... | 20 | + +| | | | +|-----------|-------------------------------------------------|----| +| 6.4 | Binary coding of datasets ..... | 21 | +| 6.4.1 | Dataset Header..... | 21 | +| 6.4.2 | MMTEL-PSTN-ISDN-CS Dataset..... | 21 | +| 6.4.2.1 | MMTEL-PSTN-ISDN-CS Dataset content ..... | 21 | +| 6.4.2.2 | Dataset Header..... | 23 | +| 6.4.2.3 | service_authorisation ..... | 23 | +| 6.4.2.4 | service_activation ..... | 23 | +| 6.4.2.5 | identity_services_param ..... | 24 | +| 6.4.2.6 | CFU_param..... | 24 | +| 6.4.2.7 | CFB_param..... | 25 | +| 6.4.2.8 | CFNR_param..... | 25 | +| 6.4.2.9 | CFNRc_param ..... | 25 | +| 6.4.2.10 | CFNL_param ..... | 25 | +| 6.4.2.11 | CD_param..... | 26 | +| 6.4.2.12 | Subscription options of CDIV Services..... | 26 | +| 6.4.2.12A | CDIV_network_provider_options ..... | 27 | +| 6.4.2.13 | CW_param..... | 28 | +| 6.4.2.14 | ICB_param..... | 28 | +| 6.4.2.15 | OCB_param ..... | 28 | +| 6.4.2.16 | Void ..... | 29 | +| 6.4.3 | AOC Dataset..... | 29 | +| 6.4.3.1 | AOC Dataset content ..... | 29 | +| 6.4.3.2 | Dataset Header..... | 29 | +| 6.4.3.3 | AOC_service_type..... | 29 | +| 6.4.3.4 | AOC_service_obligatory_type ..... | 30 | +| 6.4.3.5 | Preferred_AOC_currency ..... | 30 | +| 6.4.3.6 | AOC_format ..... | 30 | +| 6.4.4 | FA Pilot Dataset ..... | 31 | +| 6.4.4.1 | FA Pilot Dataset contentTable ..... | 31 | +| 6.4.4.2 | Dataset Header..... | 31 | +| 6.4.4.3 | FA_pilot_param ..... | 32 | +| 6.4.4.4 | FA_members_list_pointer ..... | 32 | +| 6.4.4.5 | FA_members_number ..... | 32 | +| 6.4.4.6 | FA_members_list..... | 32 | +| 6.4.4.7 | FA_member_IMPU ..... | 32 | +| 6.4.5 | FA Member Dataset ..... | 33 | +| 6.4.5.1 | FA Member Dataset content ..... | 33 | +| 6.4.5.2 | Dataset Header..... | 33 | +| 6.4.5.3 | FA_member_param ..... | 33 | +| 6.4.5.4 | FA_groups_list_pointer ..... | 33 | +| 6.4.5.5 | FA_groups_number ..... | 33 | +| 6.4.5.6 | FA_groups_list..... | 34 | +| 6.4.5.7 | FA_group_param..... | 34 | +| 6.4.5.8 | FA_pilot_IMPU ..... | 34 | +| 6.5 | Compatibility mechanism ..... | 35 | +| 6.5.1 | General ..... | 35 | +| 6.5.2 | Reserved fields ..... | 35 | +| 6.5.3 | Addition of new datasets ..... | 35 | +| 7 | MMTEL service data definition based on XML..... | 35 | +| 7.1 | General principles ..... | 35 | +| 7.2 | MMTEL services specification ..... | 35 | +| 7.2.0 | Service Indications ..... | 35 | +| 7.2.1 | MMTEL services schema..... | 36 | +| 7.2.2 | OIP service ..... | 38 | +| 7.2.3 | OIR service..... | 38 | +| 7.2.3.1 | User defined data ..... | 38 | +| 7.2.3.2 | Operator defined data..... | 38 | +| 7.2.3.2.1 | Data semantics..... | 38 | +| 7.2.3.2.2 | XML Schema ..... | 38 | +| 7.2.4 | TIP service..... | 39 | +| 7.2.5 | TIR service ..... | 39 | + +| | | | +|------------|--------------------------------|----| +| 7.2.5.1 | User defined data ..... | 39 | +| 7.2.5.2 | Operator defined data..... | 39 | +| 7.2.5.2.1 | Data semantics..... | 39 | +| 7.2.5.2.2 | XML Schema ..... | 39 | +| 7.2.6 | MCID service ..... | 40 | +| 7.2.6.1 | User defined data ..... | 40 | +| 7.2.6.2 | Operator defined data..... | 40 | +| 7.2.6.2.1 | Data semantics..... | 40 | +| 7.2.6.2.2 | XML schema..... | 40 | +| 7.2.7 | ACR service..... | 41 | +| 7.2.8 | CDIV service..... | 41 | +| 7.2.8.1 | User defined data ..... | 41 | +| 7.2.8.2 | Operator defined data..... | 41 | +| 7.2.8.2.1 | Data semantics..... | 41 | +| 7.2.8.2.2 | XML Schema ..... | 41 | +| 7.2.9 | CW service ..... | 42 | +| 7.2.9.1 | User defined data ..... | 42 | +| 7.2.9.2 | Operator defined data..... | 42 | +| 7.2.9.2.1 | Data semantics..... | 42 | +| 7.2.9.2.2 | XML Schema ..... | 42 | +| 7.2.10 | HOLD service..... | 42 | +| 7.2.10.1 | User defined data ..... | 42 | +| 7.2.10.2 | Operator defined data..... | 43 | +| 7.2.10.2.1 | Data semantics..... | 43 | +| 7.2.10.2.2 | XML Schema ..... | 43 | +| 7.2.11 | CB service ..... | 43 | +| 7.2.11.1 | User defined data ..... | 43 | +| 7.2.11.2 | Operator defined data..... | 43 | +| 7.2.11.2.1 | Data semantics..... | 43 | +| 7.2.11.2.2 | XML Schema ..... | 43 | +| 7.2.12 | CCBS/CCNR service..... | 43 | +| 7.2.12.1 | User defined data ..... | 43 | +| 7.2.12.2 | Operator defined data..... | 44 | +| 7.2.12.2.1 | Data semantics..... | 44 | +| 7.2.12.2.1 | XML Schema ..... | 44 | +| 7.2.13 | MWI service ..... | 44 | +| 7.2.13.1 | User defined data ..... | 44 | +| 7.2.13.2 | Operator defined data..... | 44 | +| 7.2.13.2.1 | Data semantics..... | 44 | +| 7.2.13.2.2 | XML Schema ..... | 44 | +| 7.2.14 | CONF service ..... | 44 | +| 7.2.14.1 | User defined data ..... | 44 | +| 7.2.14.2 | Operator defined data..... | 45 | +| 7.2.14.2.1 | Data semantics..... | 45 | +| 7.2.14.2.2 | XML Schema ..... | 45 | +| 7.2.15 | AOC service ..... | 45 | +| 7.2.15.1 | User defined data ..... | 45 | +| 7.2.15.2 | Operator defined data..... | 45 | +| 7.2.15.2.1 | Data semantics..... | 45 | +| 7.2.15.2.2 | XML Schema ..... | 45 | +| 7.2.16 | ECT service ..... | 46 | +| 7.2.16.1 | User defined data ..... | 46 | +| 7.2.16.2 | Operator defined data..... | 46 | +| 7.2.16.2.1 | Data semantics..... | 46 | +| 7.2.16.2.2 | XML Schema ..... | 46 | +| 7.2.17 | Reverse charging service ..... | 47 | +| 7.2.18 | CUG service ..... | 47 | +| 7.2.18.1 | User defined data ..... | 47 | +| 7.2.18.2 | Operator defined data..... | 47 | +| 7.2.19 | 3PTY service ..... | 47 | +| 7.2.20 | FA service..... | 47 | +| 7.2.20.1 | User defined data ..... | 47 | + +| | | | +|-------------------------------|--------------------------------------------------------------------------------------------------------------|-----------| +| 7.2.20.1 | Operator defined data..... | 47 | +| 7.2.20.1.1 | Data semantics..... | 47 | +| 7.2.20.1.2 | XML schema..... | 47 | +| 7.2.21 | Void..... | 48 | +| 7.2.22 | CAT service..... | 48 | +| 7.2.22.1 | User defined data ..... | 48 | +| 7.2.22.2 | Operator defined data..... | 48 | +| 7.2.22.2.1 | Data semantics..... | 48 | +| 7.2.22.2.2 | XML Schema ..... | 48 | +| 8 | Mechanisms for transfer of Service Data between Application Server and the HSS for AS interoperability ..... | 50 | +| 8.1 | Sh procedures to transfer Service Data ..... | 50 | +| 8.2 | Base64 data encoding..... | 50 | +| 9 | IMS user group..... | 50 | +| 9.1 | General ..... | 50 | +| 9.2 | Group identification and service indications..... | 51 | +| 9.3 | Information elements..... | 51 | +| 9.3.1 | Information elements associated to a IMS user group ..... | 51 | +| 9.3.2 | Information elements associated to a IMS group member..... | 51 | +| 9.4 | XML schemas ..... | 51 | +| 9.4.1 | XML schema of the IMS group data..... | 51 | +| 9.4.2 | XML schema of the IMS group member data..... | 52 | +| 10 | ODB Information for IMS Oriented Services..... | 52 | +| 10.1 | Service Indication..... | 52 | +| 10.2 | IMS-ODB-Information schema..... | 53 | +| 11 | IMS CAMEL Services..... | 56 | +| 11.1 | General ..... | 56 | +| 11.2 | Service Indications ..... | 56 | +| 11.3 | XML schemas ..... | 56 | +| 11.3.1 | XML schema of IMS CAMEL Services ..... | 56 | +| 11.3.2 | XML schema of Common Data for IMS CAMEL Services ..... | 57 | +| 11.3.3 | XML schema for O-IM-CSI..... | 58 | +| 11.3.4 | XML schema for O-IM-BcsmCamelTDP-CriteriaList ..... | 59 | +| 11.3.5 | XML schema for D-IM-CSI..... | 60 | +| 11.3.6 | XML schema for VT-IM-CSI ..... | 60 | +| 11.3.7 | XML schema for VT-IM-BCSM-CAMEL-TDP-CriteriaList..... | 61 | +| 12 | Shared Repository Data identification ..... | 62 | +| 12.1 | General ..... | 62 | +| 12.2 | Description ..... | 62 | +| 12.3 | Service Indication..... | 63 | +| 12.4 | Information elements..... | 63 | +| 12.4.1 | Shared Repository Data reference ..... | 63 | +| 12.5 | XML schemas ..... | 64 | +| 12.5.1 | Shared Repository Data identification..... | 64 | +| Annex A (informative): | Dataset example with variable length data ..... | 65 | +| Annex B (informative): | Change history..... | 66 | + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# Introduction + +Application Servers can store their service data on the HSS through the Sh interface as transparent data, meaning that the HSS may not be aware of the structure and the semantics of this data, only the Application Server has this knowledge. Standardizing the data formats would facilitate interoperation among Application Servers supplied by the same, or different, vendors. These Application Server vendors may be primary and secondary suppliers of the same service provider within a service provider's IMS network. This is especially true for the Multimedia Telephony supplementary services that can achieve a wide deployment and are here addressed by this specification. + +IMS CAMEL subscription data may be transferred to the IM-SSF AS using Sh interface. + +# 1 Scope + +This specification standardizes + +- the structure and the coding of the service data that are transported over the Sh interface between an Application Server supporting Multimedia Telephony supplementary services as defined in 3GPP TS 22.173 [1] and the HSS. Two optional formats are specified. One is based on a binary coding of the service data and supports the subset of MMTEL services corresponding to PSTN/ISDN and CS supplementary services. The other uses an XML format and supports the full set of MMTEL Services. +- the structure and the coding of a set of generic IMS user group data over the Sh interface. +- the structure and the coding of the service data (ODB Information for IMS Oriented Services) that are transported over the Sh interface between an Application Server supporting services that are subject to IMS-ODB as defined in 3GPP TS 22.041[25] and the HSS. +- the structure and the coding of the IMS CAMEL subscription data transported using Sh interface. + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + +- For a specific reference, subsequent revisions do not apply. + - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. +- [1] 3GPP TS 22.173: "IP Multimedia Core Network Subsystem (IMS) Multimedia Telephony Service and supplementary services; Stage 1". +- [2] 3GPP TS 24.604: "Communication Diversion (CDIV); Protocol specification using IP Multimedia (IM) Core Network (CN) subsystem; Protocol specification ". +- [3] 3GPP TS 24.605: "Conference (CONF) using IP Multimedia (IM) Core Network (CN) subsystem; Protocol specification". +- [4] 3GPP TS 24.606: "Message Waiting Indication (MWI) using IP Multimedia (IM) Core Network (CN) subsystem; Protocol specification". +- [5] 3GPP TS 24.607: "Originating Identification Presentation (OIP) and Originating Identification Restriction (OIR) using IP Multimedia (IM) Core Network (CN) subsystem; Protocol specification". +- [6] 3GPP TS 24.608: "Terminating Identification Presentation (TIP) and Terminating Identification Restriction (TIR) using IP Multimedia (IM) Core Network (CN) subsystem; Protocol specification". +- [7] 3GPP TS 24.610: "Communication HOLD (HOLD) using IP Multimedia (IM) Core Network (CN) subsystem; Protocol specification". +- [8] 3GPP TS 24.611: "Anonymous Communication Rejection (ACR) and Communication Barring (CB) using IP Multimedia (IM) Core Network (CN) subsystem; Protocol specification". +- [9] 3GPP TS 24.615: "Communication Waiting (CW) using IP Multimedia (IM) Core Network (CN) subsystem; Protocol specification". +- [10] 3GPP TS 24.616: "Malicious Communication Identification (MCID) using IP Multimedia (IM) Core Network (CN) subsystem; Protocol specification". +- [11] 3GPP TS 24.629: "Explicit Communication Transfer (ECT) using IP Multimedia (IM) Core Network (CN) subsystem; Protocol specification". +- [12] 3GPP TS 24.642: "Completion of Communications to Busy Subscriber (CCBS), Completion of Communications by No Reply (CCNR) using IP Multimedia (IM) Core Network (CN) subsystem; Protocol specification". +- [13] 3GPP TS 24.647: "Advice Of Charge (AOC) using IP Multimedia (IM) Core Network (CN) subsystem; Protocol specification". +- [14] 3GPP TS 24.654: "Closed User Group (CUG) using IP Multimedia (IM) Core Network (CN) subsystem; Protocol specification". +- [15] 3GPP TS 24.239: "Flexible Alerting (FA) using IP Multimedia (IM) Core Network (CN) subsystem; Protocol specification". +- [16] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [17] 3GPP TS 29.328: "IP Multimedia (IM) Subsystem Sh interface; Signalling flows and message contents". +- [18] 3GPP TS 24.238: " Session Initiation Protocol (SIP) based user configuration; Stage 3". +- [19] IETF RFC 2045: "Multipurpose Internet Mail Extension (MIME) Part One: Format of Internet Message Bodies". +- [20] 3GPP TS 22.182: "Customized Alerting Tones (CAT) Requirements; Stage 1". + +- [21] 3GPP TS 24.182: " IP Multimedia Subsystem (IMS) Customized Alerting Tones (CAT); Protocol specification". +- [22] 3GPP TS 32.280: "Telecommunication management; Charging management; Advice of Charge (AoC) service". +- [23] ISO 4217: "Codes for the representation of currencies and funds ". +- [24] 3GPP TS 23.003: "Numbering, addressing and identification". +- [25] 3GPP TS 22.041: "Operator Determined Barring (ODB)". +- [26] 3GPP TS 23.278: "Customised Applications for Mobile network Enhanced Logic (CAMEL); IP Multimedia System (IMS) interworking; Stage 2". +- [27] 3GPP TS 29.002: "Mobile Application Part (MAP) specification". + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in TR 21.905 [16] apply. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in TR 21.905 [16]. + +| | | +|-------|---------------------------------------------------------| +| 3PTY | Three-Party Communication | +| ACR | Anonymous Communication Rejection | +| AOC-C | Advice Of Charge - Charging | +| AOC-D | Advice Of Charge - During the communication | +| AOC-E | Advice Of Charge - at the End of the communication | +| AOC-I | Advice Of Charge - for Information | +| AOC-S | Advice Of Charge - at communication Set-up time | +| AS | Application Server | +| CAT | Customized Alerting Tones | +| CB | Communication session Barring | +| CCBS | Completion of Communication sessions to Busy Subscriber | +| CCNR | Completion of Communication sessions on No Reply | +| CD | Communication Deflection | +| CDIV | Communication DIVersion | +| CFB | Communication Forwarding Busy | +| CFNL | Communication Forwarding on Not Logged-in | +| CFNR | Communication Forwarding No Reply | +| CFNRc | Communication Forwarding on Subscriber Not Reachable | +| CFU | Communication Forwarding Unconditional | +| CONF | CONFerence | +| CUG | Closed User Group | +| CW | Communication Waiting | +| ECT | Explicit Communication Transfer | +| FA | Flexible Alerting | +| GRUU | Globally Routable User agent URI | +| HOLD | Communication HOLD | +| ICB | Incoming Communications Barring | +| MCID | Malicious Communication IDentification | +| MMTEL | MultiMedia Telephony | +| MWI | Message Waiting Indication | +| OCB | Outgoing Communications Barring | +| OIP | Originating Identification Presentation | +| OIR | Originating Identification Restriction | + +| | | +|-----|-----------------------------------------| +| TIP | Terminating Identification Presentation | +| TIR | Terminating Identification Restriction | + +# 4 General + +MMTEL/IMS CAMEL Services are supported by Application Servers that may store the Service Data attached to each user in the HSS via the Sh Interface. This data is referred to as transparent data and is understood syntactically but not semantically by the HSS. + +Different ASs providing MMTEL/IMS CAMEL services for a given user may be required. Therefore several ASs should access, utilise and update the Service Data for the user stored in the HSS. The ASs should interoperate and share the Service Data attached to this user. + +To aid the interoperability between ASs, this specification defines: + +- the structure and the coding of the Service Data transferred over the Sh interface between the HSS and the ASs for MMTEL/IMS CAMEL services, +- the use of the Sh procedures to ensure the sharing and synchronization of these Service Data between ASs, +- additional transfer mechanism such as base64 encoding. + +Two optional formats are defined for the structure and the coding of the MMTEL Service Data: + +- A XML format supporting the Service Data for the complete MMTEL Services. +- A binary format supporting the Service Data for the subset of MMTEL Services corresponding to the PSTN/ISDN and CS supplementary services. + +An XML format is defined for the structure and the coding of the IMS CAMEL Subscription Data. + +# 5 Architecture + +Figure 5-1 presents the functional architecture for AS interoperability. + +**Figure 5-1: Functional architecture for AS interoperability** + +![Functional architecture diagram for AS interoperability showing UE, IMS, AS, and HSS components and their interfaces (Ut, Sh).](cd48273072c5c3a23e11fde892d1b6b6_img.jpg) + +The diagram illustrates the functional architecture for AS interoperability. On the left, a 'UE' (User Equipment) block is connected to an 'IMS' (IP Multimedia Subsystem) block. A 'Ut' interface line connects the UE to an 'AS' (Application Server) block. The IMS block is also connected to this 'AS' block. A second 'AS' block is shown below the first one, connected to the IMS via a dashed line. A 'Ut' interface line connects the UE to this second 'AS' block. Both 'AS' blocks are connected to an 'HSS' (Home Subscriber Server) block via 'Sh' interfaces. The HSS block is associated with 'Service data', represented by a cylinder icon. + +Functional architecture diagram for AS interoperability showing UE, IMS, AS, and HSS components and their interfaces (Ut, Sh). + +The MMTEL communications of a given user equipment are routed to an AS according to the content of the filter criteria. + +If AS interoperability is supported, the Service Data attached to a user shall be stored in the HSS and the AS shall access and update, when required, the Service Data via the Sh interface. + +The user may configure some of its Service Data via the Ut interface, via SIP based user configuration as described in 3GPP TS 24.238 [18], or via other means. + +Some Service Data is configured by the service provider e.g. from its OSS, either directly into the HSS or via an AS that will store these Service Data in the HSS. + +The AS associated to a given user for MMTEL services may vary over time. + +The same format of the Service Data stored in the HSS shall be supported for interoperability between ASs utilising the Service Data. + +# 6 Specification with the binary option + +## 6.1 MMTEL service content with the binary option + +### 6.1.1 List of IMS Multimedia Telephony supplementary services + +This list of MMTEL services refers to the list identified in 3GPP TS 22.173 [1] and mentions the associated 3GPP Technical Specifications: + +| | | +|--------------------------------------------------------|---------------------| +| Originating Identification Presentation (OIP) | 3GPP TS 24.607 [5] | +| Originating Identification Restriction (OIR) | 3GPP TS 24.607 [5] | +| Terminating Identification Presentation (TIP) | 3GPP TS 24.608 [6] | +| Terminating Identification Restriction (TIR) | 3GPP TS 24.608 [6] | +| Malicious Communication IDentification (MCID) | 3GPP TS 24.616 [10] | +| Anonymous Communication Rejection (ACR) | 3GPP TS 24.611 [8] | +| Communication DIVersion (CDIV) | 3GPP TS 24.604 [2] | +| Communication Waiting (CW) | 3GPP TS 24.615 [9] | +| Communication HOLD (HOLD) | 3GPP TS 24.610 [7] | +| Communication Barring (CB) | 3GPP TS 24.611 [8] | +| Completion of Communications to Busy Subscriber (CCBS) | 3GPP TS 24.642 [12] | +| Completion of Communications on No Reply (CCNR) | 3GPP TS 24.642 [12] | +| Message Waiting Indication (MWI) | 3GPP TS 24.606 [4] | +| CONFerence (CONF) | 3GPP TS 24.605 [3] | +| Advice Of Charge (AOC) | 3GPP TS 24.647 [13] | +| Explicit Communication Transfer (ECT) | 3GPP TS 24.629 [11] | +| Reverse charging | | +| Closed User Group (CUG) | 3GPP TS 24.654 [14] | +| Three-Party (3PTY) | 3GPP TS 24.605 [5] | +| Flexible Alerting (FA) | 3GPP TS 24.239 [15] | +| Customized Alerting Tones (CAT) | 3GPP TS 24.182 [21] | + +This list is taken as the reference to address the services and their content that the binary option shall support. + +### 6.1.2 Subset of MMTEL services matching PSTN/ISDN and CS supplementary services + +The binary option shall support the subset of MMTEL services matching PSTN/ISDN and CS supplementary services. + +The following subclauses indicate: + +- for each MMTEL Service how it matches the corresponding PSTN/ISDN and CS supplementary service, + +- the relevant information elements of the service as defined in 3GPP TS 22.173 [1] and 3GPP TS 24.6xxx series and that shall be coded in the Service Data. + +#### 6.1.2.1 Originating Identification Presentation (OIP) + +OIP is described in 3GPP TS 24.607 [5] and matches the corresponding PSTN/ISDN and CS supplementary service. + +- Information elements + - Service Authorized + - Service Activated + - Override Capability. + +#### 6.1.2.2 Originating Identification Restriction (OIR) + +OIR is described in 3GPP TS 24.607 [5] and matches the corresponding PSTN/ISDN and CS supplementary service. + +- Information elements + - Service Authorized + - Service Activated + - Mode: permanent mode; temporary mode + - Temporary mode default: presentation restricted; presentation not restricted + - Restriction: restrict the asserted identity; restrict all private information appearing in headers. + +#### 6.1.2.3 Terminating Identification Presentation (TIP) + +TIP is described in 3GPP TS 24.608 [6] and matches the corresponding PSTN/ISDN and CS supplementary service. + +- Information elements + - Service Authorized + - Service Activated + - Override Capability. + +#### 6.1.2.4 Terminating Identification Restriction (TIR) + +TIR is described in 3GPP TS 24.608 [6] and matches the corresponding PSTN/ISDN and CS supplementary service. + +- Information elements + - Service Authorized + - Service Activated + - Mode: permanent mode; temporary mode + - Temporary mode default: presentation restricted; presentation not restricted. + +#### 6.1.2.5 Malicious Communication Identification (MCID) + +MCID is described in 3GPP TS 24.616 [10] and matches the corresponding PSTN/ISDN and CS supplementary service. + +- Information elements + - Service Authorized + - Service Activated + - Mode: permanent mode; temporary mode. + +#### 6.1.2.6 Anonymous Communication Rejection (ACR) + +ACR is described in 3GPP TS 24.611 [8] and matches the corresponding PSTN/ISDN and CS supplementary service. + +ACR is identified as a supplementary service in 3GPP TS 22.173 [1]. Its stage 3 specification is a special case of the incoming Communication Barring (ICB) service (c.f. subclause 4.2.1 of 3GPP TS 24.611 [8]). + +- Information elements + - Service Authorized + - Service Activated + +#### 6.1.2.7 Communication DIVersion (CDIV) + +CDIV is described in 3GPP TS 24.604 [2] + +Subclause 8.2.7.1 in 3GPP TS 22.173 [1] defines the following Communication DIVersion services: + +- Communication Forwarding Unconditional (CFU) +- Communication Forwarding Busy (CFB) +- Communication Forwarding No Reply (CFNR) +- Communication Forwarding on Not Logged in (CFNL) +- Communication Deflection (CD) +- Communication Forwarding on Subscriber Not Reachable (CFNRc) + +The service content matching PSTN/ISDN and CS supplementary services and supported by the binary option is hereafter described for each of the CDIV services. + +##### 6.1.2.7.1 Subscription options for CDIV services + +3GPP TS 24.604 [2] Table 4.3.1.1 describes the following subscription options: + +**Table 6.1.2.7.1-1: Subscription options for CDIV services** + +| Subscription options | Value | Applicability | +|-----------------------------------------------------------------------------------------------------------------------------------------------|--------------------|-------------------------------------------| +| Served user receives indication that a communication has been forwarded (indication of communication diversion to the diverting user). | No (default) | CFU
CFB
CFNR
CFNRc | +| | Yes | | +| Originating user receives notification that his communication has been diverted (forwarded or deflected). | No | CFU
CFB
CFNR
CFNRc
CFNL
CD | +| | Yes (default) | | +| Served user allows the presentation of diverted to URI to originating user in diversion notification. | No | CFU
CFB
CFNR
CFNRc
CFNL
CD | +| | Not reveal as GRUU | | +| | Yes (default) | | +| Served user receives reminder indication on outgoing communication that CDIV is currently activated. | No (default) | CFU
CFB
CFNR
CFNRc
CFNL | +| | Yes | | +| Served user allows the presentation of his/her URI to diverted-to user . | No | CFU
CFB
CFNR
CFNRc
CFNL
CD | +| | Not reveal as GRUU | | +| | Yes (default) | | +| Served user allows the presentation of his/her URI to originating user in diversion notification. | No | CFU
CFB
CFNR
CFNRc
CFNL
CD | +| | Not reveal as GRUU | | +| | Yes (default) | | + +PSTN/ISDN and CS Call forwarding services have similar subscription options. + +##### 6.1.2.7.2 Communication Forwarding Unconditional (CFU) + +CFU fulfils the corresponding PSTN/ISDN and CS supplementary service, taking into account that the communication diversion rule conditions described in 3GPP TS 24.604 [2] subclause 4.9.1.3 shall not be used. + +- Information elements + - Service Authorized + - Service Activated + - Diverted-to destination + - Subscription options for CFU. + +##### 6.1.2.7.3 Communication Forwarding Busy (CFB) + +To fulfil the corresponding PSTN/ISDN and CS supplementary service, only the busy condition among the communication diversion rule conditions described in 3GPP TS 24.604 [2] subclause 4.9.1.3 is used. + +- Information elements + - Service Authorized + - Service Activated + - Diverted-to destination: A SIP URI or a TEL URI + +- Subscription options for CFB. + +##### 6.1.2.7.4 Communication Forwarding No Reply (CFNR) + +To fulfil the corresponding PSTN/ISDN and CS supplementary service, only the no-answer condition among the communication diversion rule conditions described in 3GPP TS 24.604 [2] subclause 4.9.1.3 is used. + +- Information elements + - Service Authorized + - Service Activated + - Diverted-to destination: A SIP URI or a TEL URI + - Subscription options for CFNR. + - Communication forwarding on no reply timer : Timer duration is a network provider option. + +##### 6.1.2.7.5 Communication Forwarding on Not Logged in (CFNL) + +To fulfil the corresponding CS supplementary service, only the not-registered condition among the communication diversion rule conditions described in 3GPP TS 24.604 [2] subclause 4.9.1.3 is used. + +- Information elements + - Service Authorized + - Service Activated + - Diverted-to destination: A SIP URI or a TEL URI + - Subscription options for CFNL. + +##### 6.1.2.7.6 Communication Deflection (CD) + +CD matches the corresponding PSTN/ISDN supplementary service. + +- Information elements + - Service Authorized + - Service Activated + - Subscription options for CD. + +##### 6.1.2.7.7 Communication Forwarding on Subscriber Not Reachable (CFNRc) + +To fulfil the corresponding CS supplementary service, only the not-reachable condition among the communication diversion rule conditions described in 3GPP TS 24.604 [2] subclause 4.9.1.3 is used. + +- Information elements + - Service Authorized + - Service Activated + - Diverted-to destination: A SIP URI or a TEL URI. + - Subscription options for CFNRc. + +##### 6.1.2.7.8 Void + +##### 6.1.2.7.9 Network provider options for CDIV services + +The network provider options for CDIV services supported with the binary option are those described in 3GPP TS 24.604 [2] Table 4.3.1.2. + +#### 6.1.2.8 Communication Waiting (CW) + +CW is described in 3GPP TS 24.615 [9] and matches the corresponding PSTN/ISDN and CS supplementary service. + +- Information elements + - Service Authorized + - Service Activated + - Subscription option: Served user subscribes to "calling user receives notification that his call is waiting". + +#### 6.1.2.9 Communication HOLD (HOLD) + +HOLD is described in 3GPP TS 24.610 [7] and matches the corresponding PSTN/ISDN and CS supplementary service. + +- Information elements + - Service Authorized + - Service Activated. + +#### 6.1.2.10 Communication Barring (CB) + +CB is described in 3GPP TS 24.611 [8] and comprises 2 services: Incoming Communication Barring (ICB) and Outgoing Communication Barring (OCB). + +CB partially matches the corresponding PSTN/ISDN and CS Call Barring supplementary service. As no one of the communication barring rule conditions described in 3GPP TS 24.611 [8] subclause 4.9.1.4 applies to the corresponding PSTN/ISDN and CS Call Barring service, ICB applies to all incoming communications and OCB applies to all outgoing communications. + +- Information elements for ICB + - Service Authorized + - Service Activated. +- Information elements for OCB + - Service Authorized + - Service Activated. + +#### 6.1.2.11 Completion of Communications to Busy Subscriber (CCBS) + +CCBS is described in 3GPP TS 24.642 [12] and matches the corresponding PSTN/ISDN and CS supplementary service. + +- Information elements + - Service Authorized + - Service Activated. + +#### 6.1.2.12 Completion of Communications on No Reply (CCNR) + +CCNR is described in 3GPP TS 24.642 [12] and matches the corresponding PSTN/ISDN and CS supplementary service. + +- Information elements + - Service Authorized + - Service Activated. + +#### 6.1.2.13 Message Waiting Indication (MWI) + +MWI is described in 3GPP TS 24.606 [4] and matches the corresponding PSTN/ISDN and CS supplementary service. + +- Information elements + - Service Authorized + - Service Activated. + +#### 6.1.2.14 CONFerence (CONF) + +CONF is described in 3GPP TS 24.605 [3] and matches the corresponding PSTN/ISDN and CS supplementary service. + +- Information elements + - Service Authorized + - Service Activated. + +#### 6.1.2.15 Advice Of Charge (AOC) + +AOC is described in 3GPP TS 32.280 [22] and in 3GPP TS 24.647 [13]. It comprises 3 services AOC-S, AOC-D, AOC-E. + +AOC matches the corresponding PSTN/ISDN and CS service. + +- Information elements + - Service Authorized (for each service AOC-S, AOC-D, AOC-E) + - Service Activated (for each service AOC-S, AOC-D, AOC-E). + - AOC service type: as described in 3GPP TS 32.280 [22] + - AOC service obligatory type: as described in 3GPP TS 32.280 [22] + - Preferred AOC currency: as described in 3GPP TS 32.280 [22] + - AOC format: as described in 3GPP TS 32.280 [22] + +#### 6.1.2.16 Explicit Communication Transfer (ECT) + +ECT is described in 3GPP TS 24.629 [11] and matches the corresponding PSTN/ISDN and CS supplementary service. + +- Information elements + - Service Authorized + - Service Activated. + +#### 6.1.2.17 Reverse Charging + +Reverse charging for the binary option is not supported in this release. + +#### 6.1.2.18 Closed User Group (CUG) + +CUG is described in 3GPP TS 24.654 [14]. + +CUG for the binary option is not supported in this release. + +#### 6.1.2.19 Three-Party (3PTY) + +3PTY is described in 3GPP TS 24.605 [3] as a particular case of CONF service and matches the corresponding PSTN/ISDN and CS supplementary service. + +#### 6.1.2.20 Flexible Alerting (FA) + +FA is described in 3GPP TS 24.239 [15]. + +- Information elements for the FA Pilot of a FA group + - Service Authorized + - Service Activated. + - Single user, Multiple users: as described in 3GPP TS 24.239 [15] + - Pilot/Member status: states if the FA Pilot identity is also a FA Member identity + - Membership: Demand or Permanent as described in 3GPP TS 24.239 [15] + - List of FA Members identities +- Information elements for the FA member + - Service Authorized + - List of FA groups to which the FA member belongs to + - FA Member status: Active / Inactive on a per FA group basis + - Default FA groups for the FA member + +#### 6.1.2.21 Customized Alerting Tones (CAT) + +CAT is described in 3GPP TS 24.182 [21] and matches the corresponding CS supplementary service. + +- Information elements + - Service Authorized + - Service Activated. + +## 6.2 Datasets and Service Indications + +### 6.2.1 Introduction + +The subclause 6.2 specifies the binary description of the service data of the subset of MMTEL service to be stored on the HSS and corresponding to the PSTN/ISDN and CS supplementary services. Care has been taken to define rules for extendibility, backward compatibility and compactness, since future data structures can evolve from this definition. + +The Service Data contained in the Repository Data of one Service Indication may be a complete service suite definition, or can be viewed as a portion of a service definition. The remaining portion of a service definition may be comprised of elements specific to a subsequent part of the standardised service or a later addition of elements due to new functionalities of a service in a new release, or proprietary extensions. + +To ensure these possibilities, Service Data for the binary option are grouped in a certain number of binary datasets hereafter presented. + +### 6.2.2 Datasets + +The structure of datasets described in subclause 6.3.2 allows to define different types of datasets. In this release, the following datasets are defined: + +- the MMTELPSTN-ISDN-CS dataset containing parameters associated to the subset of MMTEL services matching the PSTN/ISDN and CS supplementary services. +- the AOC dataset containing parameters for the AOC service, +- the FA pilot dataset containing parameters of the FA pilot in the FA service, + +- the FA member dataset containing parameters of the FA member in the FA service. + +Additional services (e.g. new MMTEL services or proprietary MMTEL services) may be defined using new datasets. + +### 6.2.3 Service Indications + +Dedicated Service Indications shall be used within the binary option for the subset of MMTEL services corresponding to the PSTN/ISDN and CS supplementary services. + +The Service indication with the value "MMTEL-PSTN-ISDN-CS-BINARY" shall have a Service Data field containing: + +- the MMTEL-PSTN-ISDN-CS dataset. +- the AOC dataset when the AOC service is configured for the user. + +The Service indication with the value "MMTEL-EXTENSION-BINARY-1" shall be used when the FA service is configured for a user and shall have a Service Data field containing the FA dataset. + +New Service Indications can be introduced in the future and associated to new types of datasets. + +Proprietary extensions shall use not standardized Service Indications. There is no constraint for the data structure of the proprietary Service Data. Nevertheless, the concept of dataset can be used with a proprietary content. + +## 6.3 Binary coding general + +### 6.3.1 Introduction + +The subclause 6.3 gives the general specifications to describe the MMTEL Service data in a binary coding. + +### 6.3.2 Dataset layout + +The datasets are defined with a compact structure. The compact structure shall consist: + +- of a tag-length-value format: this includes a defined 'dataset identifier' and 'length', +- followed by a fixed format structure, wherein defined bits, bytes, 4byte tuples represent known or reserved information elements of a MMTEL service, +- finally, to accommodate length variation of some data (e.g. SIP-URI), it accommodates a variable length section. + +A dataset shall be 4-byte aligned. + +Within a dataset structure, different common data forms are defined. These include some fairly standard terms and rules, derived from common practice for 32-bit processors: + +Byte == octet + +Long == 4 bytes (signed and unsigned) + +Short == 2 bytes (signed, unsigned) + +Data alignment is such that the size of the data set shall be a 4-byte multiple and be achieved with a padding feature at the end of the dataset. + +Bit fields take up only the number of bits they say they do. Alignment of bit fields is not across a 4-byte boundary. + +### 6.3.3 Order + +Network byte ordering means most significant byte first. + +Bit field order: Most significant bit first. + +### 6.3.4 Character representation + +Character representation uses UTF-8 representation. + +String representations should be displayable. + +### 6.3.5 Byte representation + +Byte structures can be variable in length. They use the tag-length value approach, wherein the length defines the end of a variable length byte definition. + +Variable byte structures interpreted as strings should not contain the null character. + +If no variable length data were defined, then a dataset would have fixed length. + +When there are variable length data, the dataset length will not remain constant from subscriber to subscriber, as each may have different variable length parameters. + +### 6.3.6 Variable size data + +Some data must remain flexibly defined regarding their length. Main example is strings, such as URIs, digit-strings, IMPUs. + +The fixed format part of the dataset contains the information that is used when identifying variable length data described in the dataset. This information comprises: + +- variable\_data\_offset (unsigned short ): byte offset from the dataset start +- variable\_data\_length (unsigned short ): number of bytes. + +The variable\_data\_offset is the offset (in bytes) from the beginning of dataset to the beginning of a variable data. The variable\_data\_length determines the end of the variable data. A variable\_data\_offset of 0 indicates a non-provided sequence. + +A specific dataset does not have a specific size, although it will at least have a minimum size (the size if no variable data are defined at all). + +The offset plus the length information shall verify: + +- i. offset >= fixed size of the fixed part of the dataset (unless offset == 0), and +- ii. offset+length <= total size of the dataset. +- iii. there is no overlap between variable data. + +### 6.3.7 Variable length data constraints + +The following complements the usage of the pointer references (offset and length): + +- a) The order of variable data values in the variable section of the dataset shall match the order of the offset + length elements in the fixed section of the dataset. Offsets to data shall have increasing values in the order the offsets are encountered in the fixed portion of the dataset. +- b) When the size of a variable length data field increases, the entire variable length section of the dataset must be realigned. +- c) When there is no variable data associated to an offset data, the length shall be 0, and the offset shall have a value equal to the value of the next offset encountered in the fixed portion of the dataset. +- d) If the same data value appears more than once in a given dataset, it shall not be implemented as two pointers to the same value. +- e) Holes should not occur between variable data values. + +If they do, then the AS is not responsible for maintaining the information in these holes and alternate ASs may remove them in subsequent write actions. + +- f) Space after the last variable data value is not significant, and may not be retained. + +An example of a dataset with variable length data is given for information in Annex A. + +## 6.4 Binary coding of datasets + +### 6.4.1 Dataset Header + +Each dataset shall start with a Dataset Header. + +- DATASET\_HEADER + +**Table 6.4.1-1: Dataset Header** + +| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +|--------------------|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|----------------|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---| +| 3 | 3 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | +| 1 | 0 | 9 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | 9 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | 9 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | +| dataset_identifier | | | | | | | | | | | | | | | | dataset_length | | | | | | | | | | | | | | | | + +- dataset\_identifier + +It differentiates the data sets contained in the Service Data of the same Service Indication. It identifies the data structure of the dataset. + +- dataset\_length + +Length in bytes of the dataset including the DATASET\_HEADER. + +### 6.4.2 MMTEL-PSTN-ISDN-CS Dataset + +#### 6.4.2.1 MMTEL-PSTN-ISDN-CS Dataset content + +**Table 6.4.2.1-1: MMTEL-PSTN-ISDN-CS Dataset fields** + +| 4-byte tuple | 3 | 3 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | +|--------------|-------------------------|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---| +| | 1 | 0 | 9 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | 9 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | 9 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | +| 0 | DATASET_HEADER | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| 4 | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| 8 | service_authorisation | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| 12 | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| 16 | service_activation | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| 20 | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| 24 | RESERVED | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| 28 | identity_services_param | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| 32 | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| 36 | CFU_param | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| 40 | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| 44 | CFB_param | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| 48 | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| 52 | CFNR_param | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| 56 | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | + +| | | +|-----|-------------------------------| +| 60 | CFNRc_param | +| 64 | | +| 68 | CFNL_param | +| 72 | | +| 76 | CD_param | +| 80 | | +| 84 | CDIV_network_provider_options | +| 88 | CW_param | +| 92 | | +| 96 | ICB_param | +| 100 | | +| 104 | OCB_param | +| 108 | | +| 112 | RESERVED | +| 116 | | +| 120 | RESERVED | +| 124 | | +| | Data with variable length | +| n | | + +NOTE: ACR, HOLD, CCBS, CCNR, MWI, CONF, AOC, ECT, CAT have no parameter field. + +#### 6.4.2.2 Dataset Header + +- dataset\_identifier + +The value of dataset\_identifier of the MMTEL-PSTN-ISDN-CS Dataset is 1. + +#### 6.4.2.3 service\_authorisation + +Bit field that can support up to 64 services. A bit is associated to a MMTEL Service and indicates if: + +- it is authorized: bit value 1, +- or not: bit value 0. + +| | | +|-------|----------| +| Bit-0 | Reserved | +| Bit-1 | OIP | +| Bit-2 | OIR | +| Bit-3 | TIP | +| Bit-4 | TIR | +| Bit-5 | MCID | + +Bit-6 ACR +Bit-7 CFU +Bit-8 CFB +Bit-9 CFNR +Bit-10 CFNRc +Bit-11 CFNL +Bit-12 CD +Bit-13 Reserved +Bit-14 CW +Bit-15 HOLD +Bit-16 Incoming CB +Bit-17 Outgoing CB +Bit-18 CCBS +Bit-19 CCNR +Bit-20 MWI +Bit-21 CONF +Bit-22 AOC-S +Bit-23 AOC-D +Bit-24 AOC-E +Bit-25 Reserved +Bit-26 Reserved +Bit-27 ECT +Bit-28 CAT +Bit-29 FA + +#### 6.4.2.4 service\_activation + +Bit field that can support up to 64 services. A bit is associated to a MMTEL Service and indicates if the MMTEL service is activated. Indexation is the same as for service\_authorization. + +#### 6.4.2.5 identity\_services\_param + +**Table 6.4.2.5-1: identity\_services\_param fields** + +| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +|--------------|-----|-----|-----|-----|-----|-----|-----|-----|-----|----------|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---| +| 4-byte tuple | 3 | 3 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | +| | 1 | 0 | 9 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | 9 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | 9 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | +| 28 | (a) | (b) | (c) | (d) | (e) | (f) | (g) | (h) | (i) | RESERVED | | | | | | | | | | | | | | | | | | | | | | | +| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | + +**Table 6.4.2.5-2: identity\_services\_param values** + +| Field | Identity services Parameters | Value | Binary value | | +|-------|------------------------------|-------------------------------------------------------|--------------|-------------| +| (a) | OIR mode | Permanent mode | Bit 31
0 | Bit 30
0 | +| | | Temporary mode | 0 | 1 | +| (b) | OIR Temporary Mode Default | Presentation restricted | Bit 29
0 | Bit 28
0 | +| | | Presentation not restricted | 0 | 1 | +| (c) | OIR restriction | Restrict the asserted identity | Bit 27
0 | Bit 26
0 | +| | | Restrict all private information appearing in headers | 0 | 1 | +| (d) | OIP Override capability | No | Bit 25
0 | Bit 24
0 | +| | | Yes | 0 | 1 | +| (e) | TIR Mode | Permanent mode | Bit 23
0 | Bit 22
0 | +| | | Temporary mode | 0 | 1 | +| (f) | TIR Temp Mode Default | Presentation restricted | Bit 21
0 | Bit 20
0 | +| | | Presentation not restricted | 0 | 1 | +| (g) | TIP Override capability | No | Bit 19
0 | Bit 18
0 | +| | | Yes | 0 | 1 | +| (h) | Reserved | | | | +| (i) | MCID Mode | Permanent | Bit 15
0 | Bit 14
0 | +| | | Temporary | 0 | 1 | + +#### 6.4.2.6 CFU\_param + +**Table 6.4.2.6-1: CFU\_param fields** + +| | | | | | | | | | | | | | | | | | +|--------------|-----------------------------------|----|----|----|----|----|----|----|-----------------------------------|-----|-----|-----|-----|-----|-----|-----| +| 4-byte tuple | 31 | 30 | 29 | 28 | 27 | 26 | 25 | 24 | 23 | 22 | 21 | 20 | 19 | 18 | 17 | 16 | +| | 15 | 14 | 13 | 12 | 11 | 10 | 9 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | +| 32 | RESERVED | | | | | | | | CFU_subscription_options | | | | | | | | +| | | | | | | | | | (a) | (b) | (c) | (d) | (e) | (f) | (g) | (h) | +| 36 | CFU_divertedto_destination_Offset | | | | | | | | CFU_divertedto_destination_Length | | | | | | | | + +- `CFU_divertedto_destination_offset` is the pointer to CFU diverted-to destination in the variable part of the MMTEL-PSTN-ISDN-CS Dataset. +- `CFU_subscription_options`: described in subclause 6.4.2.12. + +#### 6.4.2.7 CFB\_param + +**Table 6.4.2.7-1: CFB\_param fields** + +| | | | | | | | | | | | | | | | | | +|--------------|-----------------------------------|----|----|----|----|----|----|----|-----------------------------------|-----|-----|-----|-----|-----|-----|-----| +| 4-byte tuple | 31 | 30 | 29 | 28 | 27 | 26 | 25 | 24 | 23 | 22 | 21 | 20 | 19 | 18 | 17 | 16 | +| | 15 | 14 | 13 | 12 | 11 | 10 | 9 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | +| 40 | RESERVED | | | | | | | | CFB_subscription_options | | | | | | | | +| | | | | | | | | | (a) | (b) | (c) | (d) | (e) | (f) | (g) | (h) | +| 44 | CFB_divertedto_destination_Offset | | | | | | | | CFB_divertedto_destination_Length | | | | | | | | + +- `CFB_divertedto_destination_offset` is the pointer to CFB diverted-to destination in the variable part of the MMTEL-PSTN-ISDN-CS Dataset. + +- `CFB_subscription_options`: described in subclause 6.4.2.12. + +#### 6.4.2.8 CFNR\_param + +**Table 6.4.2.8-1: CFNR\_param fields** + +| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +|--------------|----------------------------------------|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|------------------------------------------------------------------------------|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---| +| 4-byte tuple | 3 | 3 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | +| | 1 | 0 | 9 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | 9 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | 9 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | +| 48 | no_reply_timer | | | | | | | | | | | | | | | | CFNR_subscription_options
(a) (b) (c) (d) (e) (f) (g) (h) | | | | | | | | | | | | | | | | +| 52 | CFNR_divertedto_destination_
Offset | | | | | | | | | | | | | | | | CFNR_divertedto_destination_
Length | | | | | | | | | | | | | | | | + +- `CFNR_divertedto_destination_offset` is the pointer to CFNR diverted-to destination in the variable part of the MMTEL-PSTN-ISDN-CS Dataset. +- `CFNR_subscription_options`: described in subclause 6.4.2.12. +- `no_reply_timer` is an integer with values between 0 and 180 seconds for communication forwarding on no reply timer. + +#### 6.4.2.9 CFNRc\_param + +**Table 6.4.2.9-1: CFNRc\_param fields** + +| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +|--------------|-----------------------------------------|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|-------------------------------------------------------------------------------|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---| +| 4-byte tuple | 3 | 3 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | +| | 1 | 0 | 9 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | 9 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | 9 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | +| 56 | RESERVED | | | | | | | | | | | | | | | | CFNRc_subscription_options
(a) (b) (c) (d) (e) (f) (g) (h) | | | | | | | | | | | | | | | | +| 60 | CFNRc_divertedto_destination_
Offset | | | | | | | | | | | | | | | | CFNRc_divertedto_destination_
Length | | | | | | | | | | | | | | | | + +- `CFNRc_divertedto_destination_offset` is the pointer to CFNRc diverted-to destination in the variable part of the MMTEL-PSTN-ISDN-CS Dataset. +- `CFNRc_subscription_options`: described in subclause 6.4.2.12. + +#### 6.4.2.10 CFNL\_param + +**Table 6.4.2.10-1: CFNL\_param fields** + +| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +|--------------|----------------------------------------|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|------------------------------------------------------------------------------|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---| +| 4-byte tuple | 3 | 3 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | +| | 1 | 0 | 9 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | 9 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | 9 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | +| 64 | RESERVED | | | | | | | | | | | | | | | | CFNL_subscription_options
(a) (b) (c) (d) (e) (f) (g) (h) | | | | | | | | | | | | | | | | +| 68 | CFNL_divertedto_destination_
Offset | | | | | | | | | | | | | | | | CFNL_divertedto_destination_
Length | | | | | | | | | | | | | | | | + +- `CFNL_divertedto_destination_offset` is the pointer to CFNL diverted-to destination in the variable part of the MMTEL-PSTN-ISDN-CS Dataset. +- `CFNL_subscription_options`: described in subclause 6.4.2.12. + +#### 6.4.2.11 CD\_param + +**Table 6.4.2.11-1: CD\_param fields** + +| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +|--------------|----------|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|----------------------------------------------------------------------------|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---| +| 4-byte tuple | 3 | 3 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | +| | 1 | 0 | 9 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | 9 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | 9 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | +| 72 | RESERVED | | | | | | | | | | | | | | | | CD_subscription_options
(a) (b) (c) (d) (e) (f) (g) (h) | | | | | | | | | | | | | | | | +| 76 | RESERVED | | | | | | | | | | | | | | | | RESERVED
| | | | | | | | | | | | | | | | + +- `CD_subscription_options`: described in subclause 6.4.2.12. + +#### 6.4.2.12 Subscription options of CDIV Services + +CFU\_subscription\_options, CFB\_subscription\_options, CFNR\_subscription\_options, CFNRc\_subscription\_options, CFNL\_subscription\_options, CD\_subscription\_options use the same format with bit fields according to the following tables: + +**Table 6.4.2.12-1: CDIV Subscription options bit field** + +| | | | | | | | | | | | | | | | | +|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------| +| 1
5 | 1
4 | 1
3 | 1
2 | 1
1 | 1
0 | 0
9 | 0
8 | 0
7 | 0
6 | 0
5 | 0
4 | 0
3 | 0
2 | 0
1 | 0
0 | +| | | | | | | | | | | | | | | | | +| (a) | | (b) | | (c) | | (d) | | (e) | | (f) | | (g) | | (h) | | + +**Table 6.4.2.12-2: CDIV Subscription options binary values** + +| Field | Subscription options | Value | Binary value | | Applicability | +|-------|------------------------------------------------------------------------------------------------------------------|---------------------------------|--------------|-------------|-------------------------------------------| +| | | | Bit 15 | Bit 14 | | +| (a) | Served user receives indication that a communication has been forwarded | No | 0 | 0 | CFU
CFB | +| | | Yes | 0 | 1 | CFNR
CFNRc | +| (b) | Originating user receives notification that his communication has been diverted (forwarded or deflected). | | Bit 13 | Bit 12 | | +| | | No
Yes | 0
0 | 0
1 | CFU
CFB
CFNR
CFNRc
CFNL
CD | +| (c) | Served user allows the presentation of diverted to URI to originating user in diversion notification. | | Bit 11 | Bit 10 | | +| | | No
Not reveal as GRUU
Yes | 0
1
0 | 0
0
1 | CFU
CFB
CFNR
CFNRc
CFNL
CD | +| | | | | | | +| (d) | Served user receives reminder indication on outgoing communication that CDIV is currently activated. | | Bit 9 | Bit 8 | | +| | | No
Yes | 0
0 | 0
1 | CFU
CFB
CFNR
CFNRc
CFNL | +| (e) | Served user allows the presentation of his/her URI to diverted-to user . | | Bit 7 | Bit 6 | | +| | | No
Not reveal as GRUU
Yes | 0
1
0 | 0
0
1 | CFU
CFB
CFNR
CFNRc
CFNL
CD | +| | | | | | | +| (f) | Served user allows the presentation of his/her URI to originating user in diversion notification. | | Bit 5 | Bit 4 | | +| | | No
Not reveal as GRUU
Yes | 0
1
0 | 0
0
1 | CFU
CFB
CFNR
CFNRc
CFNL
CD | +| | | | | | | +| (g) | Reserved | | | | | +| (h) | Reserved | | | | | + +#### 6.4.2.12A CDIV\_network\_provider\_options + +**Table 6.4.2.12A-1: CDIV\_network\_provider\_options fields** + +| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +|---------------------------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|----------------------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------| +| 4-byte
tuple

80 | 3
1 | 3
0 | 2
9 | 2
8 | 2
7 | 2
6 | 2
5 | 2
4 | 2
3 | 2
2 | 2
1 | 2
0 | 1
9 | 1
8 | 1
7 | 1
6 | 1
5 | 1
4 | 1
3 | 1
2 | 1
1 | 1
0 | 0
9 | 0
8 | 0
7 | 0
6 | 0
5 | 0
4 | 0
3 | 0
2 | 0
1 | 0
0 | +| | | | | | | | | | | | | | | | | | number_of_diversions | | | | | | | | | | | | | | | | +| | (a) | (b) | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | + +| | | | +|----|-----------------------|----------| +| 84 | CDIV_indication_timer | RESERVED | +|----|-----------------------|----------| + +- Fields (a) and (b) + +**Table 6.4.2.12A-2: CDIV\_network\_provider\_options values** + +| Field | Network provider option | Value | Binary value | | Applicability | +|-------|-------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------|--------------|-------------|---------------| +| (a) | Served user communication retention on invocation of diversion | Retain communication to the served user until alerting begins at the diverted-to user | Bit 31
0 | Bit 30
1 | CFNR
CD | +| | | Clear communication to the served user on invocation of call diversion | 0 | 0 | | +| (b) | Served user communication retention when diverting is rejected at diverted-to user. | Continue to alert the diverting user | Bit 29
0 | Bit 28
1 | CFNR
CD | +| | | No action at the diverting user | 0 | 0 | | + +- `number_of_diversions` is an integer giving the total number of all diversions for each communication +- `CDIV_indication_timer` is an integer with values between 0 and 60 seconds. + +#### 6.4.2.13 CW\_param + +**Table 6.4.2.13-1: CW\_param fields** + +| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +|--------------|-------------------------------------------------------------------------------------------------------------------------------|--|----------|--|--|--|--|--|--|--|--|--|--|--|--|--|----------|--|--|--|--|--|--|--|--|--|--|--|--|--|--|--| +| 4-byte tuple | 3 3 2 2 2 2 2 2 2 2 2 2 1 1 1 1 1 1 1 1 1 1 0 0 0 0 0 0 0 0 0 0 | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| | 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| 88 | (a) | | RESERVED | | | | | | | | | | | | | | RESERVED | | | | | | | | | | | | | | | | + +**Table 6.4.2.13-2: CW\_param values** + +| Field | CW Parameters | Value | Binary value | | +|-------|-------------------------------------------------------------|-------|--------------|--------| +| | | | Bit 31 | Bit 30 | +| (a) | calling user receives notification that his call is waiting | No | 0 | 0 | +| | | Yes | 0 | 1 | + +#### 6.4.2.14 ICB\_param + +**Table 6.4.2.14-1: ICB\_param fields** + +| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +|--------------|-------------------------------------------------------------------------------------------------------------------------------|--|--|--|--|--|--|--|--|--|--|--|--|--|--|--|----------|--|--|--|--|--|--|--|--|--|--|--|--|--|--|--| +| 4-byte tuple | 3 3 2 2 2 2 2 2 2 2 2 2 1 1 1 1 1 1 1 1 1 1 0 0 0 0 0 0 0 0 0 0 | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| | 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| 92 | RESERVED | | | | | | | | | | | | | | | | RESERVED | | | | | | | | | | | | | | | | +| 96 | RESERVED | | | | | | | | | | | | | | | | RESERVED | | | | | | | | | | | | | | | | + +In this release, as indicated in subclause 6.1.2.10, there is no parameter that applies to the ICB service; `ICB_param` fields are Reserved. + +#### 6.4.2.15 OCB\_param + +**Table 6.4.2.15-1: OCB\_param fields** + +| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +|--------------|-------------------------------------------------------------------------------------------------------------------------------|--|--|--|--|--|--|--|--|--|--|--|--|--|--|--|----------|--|--|--|--|--|--|--|--|--|--|--|--|--|--|--| +| 4-byte tuple | 3 3 2 2 2 2 2 2 2 2 2 2 1 1 1 1 1 1 1 1 1 1 0 0 0 0 0 0 0 0 0 0 | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| | 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| 100 | RESERVED | | | | | | | | | | | | | | | | RESERVED | | | | | | | | | | | | | | | | + +| | | | +|-----|----------|----------| +| 102 | RESERVED | RESERVED | +| | | | + +In this release, as indicated in subclause 6.1.2.10, there is no parameter that applies to the OCB service; `OCB_param` fields are Reserved. + +#### 6.4.2.16 Void + +### 6.4.3 AOC Dataset + +#### 6.4.3.1 AOC Dataset content + +**Table 6.4.3.1-1: AOC Dataset fields** + +| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +|-----------------|------------------------|---|---|---|---|---|---|---|---------------------------------|---|---|---|---|---|---|---|----------|---|---|---|---|---|---|---|------------|---|---|---|---|---|---|---| +| 4-byte
tuple | 3 | 3 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | +| | 1 | 0 | 9 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | 9 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | 9 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | +| 0 | DATASET_HEADER | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| 4 | AOC_service_
type | | | | | | | | AOC_service_obl
igatory_type | | | | | | | | RESERVED | | | | | | | | AOC_format | | | | | | | | +| 8 | Preferred_AOC_currency | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | + +#### 6.4.3.2 Dataset Header + +- dataset\_identifier + +The value of `dataset_identifier` of the AOC Dataset is 2. + +#### 6.4.3.3 AOC\_service\_type + +**Table 6.4.3.3-1: AOC\_service\_type fields** + +| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +|-----------------|-----|---|-----|---|-----|---|-----|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---| +| 4-byte
tuple | 3 | 3 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | +| | 1 | 0 | 9 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | 9 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | 9 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | +| 4 | (a) | | (b) | | (c) | | (d) | | | | | | | | | | | | | | | | | | | | | | | | | | + +**Table 6.4.a.3-2: AOC\_service\_type values** + +| Field | AOC service type | Value | Binary value | | +|-------|--------------------------|-------|--------------|-------------| +| (a) | AOC service type (AOC-S) | No | Bit 31
0 | Bit 30
0 | +| | | Yes | 0 | 1 | +| (b) | AOC service type (AOC-D) | No | Bit 29
0 | Bit 28
0 | +| | | Yes | 0 | 1 | +| (c) | AOC service type (AOC-E) | No | Bit 27
0 | Bit 26
0 | +| | | Yes | 0 | 1 | +| (d) | RESERVED | | Bit 25 | Bit 24 | + +#### 6.4.3.4 AOC\_service\_obligatory\_type + +**Table 6.4.3.4-1: AOC\_service\_obligatory\_type fields** + +| | | | | | | | | | | | | | | | | | | | | | | | | | | | +|--------------|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----| +| 4-byte tuple | 3 3 | 2 2 | 2 2 | 2 2 | 2 2 | 2 2 | 2 2 | 2 2 | 1 1 | 1 1 | 1 1 | 1 1 | 1 1 | 1 1 | 1 1 | 1 1 | 0 0 | 0 0 | 0 0 | 0 0 | 0 0 | 0 0 | 0 0 | 0 0 | | | +| | 1 0 | 9 8 | 7 6 | 5 4 | 3 2 | 1 0 | 9 8 | 7 6 | 5 4 | 3 2 | 1 0 | 9 8 | 7 6 | 5 4 | 3 2 | 1 0 | 9 8 | 7 6 | 5 4 | 3 2 | 1 0 | 9 8 | 7 6 | 5 4 | 3 2 | 1 0 | +| 4 | | | | | (a) | | (b) | | (c) | | (d) | | | | | | | | | | | | | | | | + +**Table 6.4.3.4-2: AOC\_service\_obligatory\_type values** + +| Field | AOC service obligatory type | Value | Binary value | | +|-------|---------------------------------------|-------|--------------|-------------| +| (a) | AOC service obligatory type for AOC-S | None | Bit 23
0 | Bit 22
0 | +| | | AOC-I | 0 | 1 | +| | | AOC-C | 1 | 0 | +| (b) | AOC service obligatory type for AOC-D | None | Bit 21
0 | Bit 20
0 | +| | | AOC-I | 0 | 1 | +| | | AOC-C | 1 | 0 | +| (c) | AOC service obligatory type for AOC-E | None | Bit 19
0 | Bit 18
0 | +| | | AOC-I | 0 | 1 | +| | | AOC-C | 1 | 0 | +| (d) | RESERVED | | Bit 17 | Bit 16 | + +#### 6.4.3.5 Preferred\_AOC\_currency + +`Preferred_AOC_currency` is of type `Unsigned32` and contains the currency numeric code as defined in ISO 4217 [23]. + +#### 6.4.3.6 AOC\_format + +**Table 6.4.3.6-1: AOC\_format fields** + +| | | | | | | | | | | | | | | | | | | | | | | | | | | | +|--------------|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----| +| 4-byte tuple | 3 3 | 2 2 | 2 2 | 2 2 | 2 2 | 2 2 | 2 2 | 2 2 | 1 1 | 1 1 | 1 1 | 1 1 | 1 1 | 1 1 | 1 1 | 1 1 | 0 0 | 0 0 | 0 0 | 0 0 | 0 0 | 0 0 | 0 0 | 0 0 | | | +| | 1 0 | 9 8 | 7 6 | 5 4 | 3 2 | 1 0 | 9 8 | 7 6 | 5 4 | 3 2 | 1 0 | 9 8 | 7 6 | 5 4 | 3 2 | 1 0 | 9 8 | 7 6 | 5 4 | 3 2 | 1 0 | 9 8 | 7 6 | 5 4 | 3 2 | 1 0 | +| 4 | | | | | (a) | | (b) | | (c) | | (d) | | | | | | | | | | | | | | | | + +**Table 6.4.3.6-2: AOC\_format values** + +| Field | AOC_format | Value | Binary value | | +|-------|----------------------|--------------|--------------|-------------| +| | | | Bit 23 | Bit 22 | +| (a) | AOC format for AOC-S | None | 0 | 0 | +| | | Monetary | 0 | 1 | +| | | Non Monetary | 1 | 0 | +| | | CAI | 1 | 1 | +| (b) | AOC format for AOC-D | None | Bit 21
0 | Bit 20
0 | +| | | Monetary | 0 | 1 | +| | | Non Monetary | 1 | 0 | +| | | CAI | 1 | 1 | +| (c) | AOC format for AOC-E | None | Bit 19
0 | Bit 18
0 | +| | | Monetary | 0 | 1 | +| | | Non Monetary | 1 | 0 | +| | | CAI | 1 | 1 | +| (d) | RESERVED | | Bit 17 | Bit 16 | + +### 6.4.4 FA Pilot Dataset + +#### 6.4.4.1 FA Pilot Dataset contentTable + +**6.4.4.1-1: FA Pilot Dataset fields** + +| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +|--------------|-------------------------|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|-------------------|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---| +| 4-byte tuple | 3 | 3 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | +| | 1 | 0 | 9 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | 9 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | 9 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | +| 0 | DATASET_HEADER | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| 4 | FA_pilot_param | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| 8 | FA_members_list_pointer | | | | | | | | | | | | | | | | FA_members_number | | | | | | | | | | | | | | | | +| 12 | FA members list | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| | FA member IMPU | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| | FA member IMPU | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | + +#### 6.4.4.2 Dataset Header + +- dataset\_identifier + +The value of dataset\_identifier of the FA Pilot Dataset is 3. + +#### 6.4.4.3 FA\_pilot\_param + +**Table 6.4.4.3-1: FA\_pilot\_param fields** + +| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +|--------------|----------|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|----------|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---| +| 4-byte tuple | 3 | 3 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | +| | 1 | 0 | 9 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | 9 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | 9 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | +| | Reserved | | | | | | | | | | | | | | | | Reserved | | | | | | | | | | | | | | | | + +**Table 6.4.4.3-2: FA\_pilot\_param values** + +| Field | FA Pilot Parameters | Value | Binary value | +|-------|----------------------|----------------------------------------------------------|------------------| +| (a) | Pilot/Member status | FA Pilot is not FA Member
FA Pilot is FA Member | Bit 31
0
1 | +| (b) | Single/multiple user | Single User
Multiple Users | Bit 30
0
1 | +| (c) | Membership | FA Membership is Permanent
FA Membership is on Demand | Bit 29
0
1 | + +#### 6.4.4.4 FA\_members\_list\_pointer + +The `FA_members_list_pointer` is an offset, as defined in clause 6.3.6, pointing to the beginning of `FA_members_list`. + +#### 6.4.4.5 FA\_members\_number + +`FA_members_number` indicates the number of FA members and is an integer. + +#### 6.4.4.6 FA\_members\_list + +**Table 6.4.4.6-1: FA\_members\_list fields** + +| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +|--------------|------------------|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|------------------|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---| +| 4-byte tuple | 3 | 3 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | +| | 1 | 0 | 9 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | 9 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | 9 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | +| | FA_member_offset | | | | | | | | | | | | | | | | FA_member_length | | | | | | | | | | | | | | | | +| | Reserved | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| | FA_member_offset | | | | | | | | | | | | | | | | FA_member_length | | | | | | | | | | | | | | | | +| | Reserved | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | + +`FA_members_list` comprises identical field sets of which the number is the number of FA members. + +Each field set comprises: + +- `FA_member_offset`: as defined in clause 6.3.6, it points to the beginning of the FA member IMPU field +- `FA_member_length`: it gives the length of the `FA_member_IMPU` field +- A Reserved field + +#### 6.4.4.7 FA\_member\_IMPU + +`FA_member_IMPU` gives the IMPU of a FA member and is a string of variable length. + +### 6.4.5 FA Member Dataset + +#### 6.4.5.1 FA Member Dataset content + +**Table 6.4.5.1-1: FA Member Dataset fields** + +| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +|--------------|------------------------|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|------------------|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---| +| 4-byte tuple | 3 | 3 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | +| | 1 | 0 | 9 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | 9 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | 9 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | +| 0 | DATASET_HEADER | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| 4 | FA_member_param | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| 8 | FA_groups_list_pointer | | | | | | | | | | | | | | | | FA_groups_number | | | | | | | | | | | | | | | | +| 12 | FA groups list | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| | FA pilot IMPU | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | + +| | +|---------------| +| FA pilot IMPU | +| | +| | + +#### 6.4.5.2 Dataset Header + +- `dataset_identifier` + +The value of `dataset_identifier` of the FA Member Dataset is 4. + +#### 6.4.5.3 FA\_member\_param + +**Table 6.4.5.3-1: FA\_member\_param fields** + +| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +|-----------------|----------|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|----------|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---| +| 4-byte
tuple | 3 | 3 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | +| | 1 | 0 | 9 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | 9 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | 9 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | +| | Reserved | | | | | | | | | | | | | | | | Reserved | | | | | | | | | | | | | | | | + +#### 6.4.5.4 FA\_groups\_list\_pointer + +The `FA_groups_list_pointer` is an offset, as defined in clause 6.3.6, pointing to the beginning of `FA_groups_list`. + +#### 6.4.5.5 FA\_groups\_number + +`FA_groups_number` indicates the number of FA groups which the FA member belongs to and is an integer. + +#### 6.4.5.6 FA\_groups\_list + +**Table 6.4.5.6-1: FA\_groups\_list fields** + +| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +|-----------------|-----------------|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|-----------------|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---| +| 4-byte
tuple | 3 | 3 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | +| | 1 | 0 | 9 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | 9 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | 9 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | +| | FA_group_offset | | | | | | | | | | | | | | | | FA_group_length | | | | | | | | | | | | | | | | +| | FA_group_param | | | | | | | | | | | | | | | | Reserved | | | | | | | | | | | | | | | | +| | FA_group_offset | | | | | | | | | | | | | | | | FA_group_length | | | | | | | | | | | | | | | | +| | FA_group_param | | | | | | | | | | | | | | | | Reserved | | | | | | | | | | | | | | | | + +`FA_groups_list` comprises identical field sets of which the number is the number of FA groups. + +Each field set comprises: + +- FA\_group\_offset: as defined in clause 6.3.6, it points to the beginning of the `FA_Pilot_IMPU` field +- FA\_member\_length: it gives the length of the `FA_pilot_IMPU` field +- FA\_group\_param +- A Reserved field + +#### 6.4.5.7 FA\_group\_param + +**Table 6.4.5.7-1: FA\_group\_param fields** + +| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +|-----------------|---|---|----------|---|---|---|---|---|---|---|---|---|---|---|---|---|----------|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---| +| 4-byte
tuple | 3 | 3 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | +| | 1 | 0 | 9 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | 9 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | 9 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | +| | a | b | Reserved | | | | | | | | | | | | | | Reserved | | | | | | | | | | | | | | | | + +**Table 6.4.5.7-2: FA\_group\_param values** + +| Field | FA Group Parameters | Value | Binary value | +|-------|----------------------------------|----------------------------------------------------------|--------------| +| (a) | FA Member status in the FA group | FA Member is inactive in the FA group | Bit 31
0 | +| | | FA Member is active in the FA group | 1 | +| (b) | Default FA group | The FA group is not a default FA group for the FA member | Bit 30
0 | +| | | The FA group is a default FA group for the FA member | 1 | + +#### 6.4.5.8 FA\_pilot\_IMPU + +FA\_pilot\_IMPU gives the IMPU of the FA pilot of the FA group and is a string of variable length. + +## 6.5 Compatibility mechanism + +### 6.5.1 General + +The subclause 6.5 describes the mechanism to aid compatibility of the binary format when introducing extensions to the binary option content given in subclause 6.1.2 for new features in the services supported or for new services. + +An AS supporting the new feature/service may generate transparent data where reserved fields of a dataset are allocated or new datasets are defined. This transparent data may be accessed by another AS that does not support the extensions which may cause interoperability issues. + +### 6.5.2 Reserved fields + +Reserved fields are defined in the datasets. An AS shall not modify the content of such reserved fields when updating a dataset in the HSS. + +### 6.5.3 Addition of new datasets + +As new datasets defined according to subclause 6.2.2 may be introduced in the same transparent data containing the MMTEL-PSTN-CS dataset and so associated to the same service indication, an AS that does not support these new datasets shall not modify the content of these datasets when rewriting the transparent data in the HSS. + +# 7 MMTEL service data definition based on XML + +## 7.1 General principles + +The general structure of the MMTEL service data document is shown in Figure 7.1-1 + +![Diagram showing the general structure of an MMTEL service document. It is a vertical container labeled 'MMTel Services' at the top. Inside, there are multiple service blocks. The first block is labeled 'Service 1' and contains two sub-boxes: 'User defined data' and 'Operator defined data'. Below this, there is a vertical dashed line indicating a separator. The last block is labeled 'Service n' and also contains two sub-boxes: 'User defined data' and 'Operator defined data'.](05eb72d372e4bf78e3d6a64949d77bcc_img.jpg) + +Diagram showing the general structure of an MMTEL service document. It is a vertical container labeled 'MMTel Services' at the top. Inside, there are multiple service blocks. The first block is labeled 'Service 1' and contains two sub-boxes: 'User defined data' and 'Operator defined data'. Below this, there is a vertical dashed line indicating a separator. The last block is labeled 'Service n' and also contains two sub-boxes: 'User defined data' and 'Operator defined data'. + +**Figure 7.1-1: General structure of MMTEL service document** + +The MMTEL document consists of the services. Each service consists of a user defined part and an operator defined part. The user defined data is found in each of the MMTEL supplementary service specifications. The operator defined part consists of authorization of the service, and of the subscription options for each of the services. + +## 7.2 MMTEL services specification + +### 7.2.0 Service Indications + +A dedicated Service Indication shall be used within the XML option for MMTEL services. The value of the Service Indication shall be "MMTEL-Services". + +Proprietary extensions shall use not standardized Service Indications. There is no constraint for the data structure of the proprietary Service Data. + +### 7.2.1 MMTEL services schema + +The following shows the MMTEL Services schema: + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +The file "operator-common-data.xsd" contains all the common types of the operator data. This schema is defined as + +``` + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + +``` + +### 7.2.2 OIP service + +The OIP service is specified together with OIR service in subclause 7.2.3. + +### 7.2.3 OIR service + +#### 7.2.3.1 User defined data + +The schema defined in subclause 4.10.2 of 3GPP TS 24.607 [5] shall be used. + +#### 7.2.3.2 Operator defined data + +##### 7.2.3.2.1 Data semantics + +The OIP and OIR services are authorized by the operator by setting the "authorized" attributes of and , respectively, to "true". + +##### 7.2.3.2.2 XML Schema + +``` + + + + + + Operator part of the Originating Identity Presentation (OIP) and Originating Identity + Restriction (OIR) services + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +### 7.2.4 TIP service + +The TIP service is specified together with TIR service, see subclause 7.2.5. + +### 7.2.5 TIR service + +#### 7.2.5.1 User defined data + +The schema defined in subclause 4.9.2 of 3GPP TS 24.608 [6] shall be used. + +#### 7.2.5.2 Operator defined data + +##### 7.2.5.2.1 Data semantics + +The TIP and TIR services are authorized by the operator by setting the "authorized" attributes of and , respectively, to "true". + +##### 7.2.5.2.2 XML Schema + +``` + + + + + Operator part of the Terminating Identity Presentation (TIP) and Terminating Identity + Restriction (TIR) services + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +### 7.2.6 MCID service + +#### 7.2.6.1 User defined data + +No user data associated with MCID service is defined in 3GPP TS 24.616 [10]. + +#### 7.2.6.2 Operator defined data + +##### 7.2.6.2.1 Data semantics + +The MCID service is authorized and activated by the operator by setting the "authorized" attribute of to "true". + +##### 7.2.6.2.2 XML schema + +``` + +``` + +``` + + + + + Operator part of the Malicious Communication Identification (MCID) service + + + + + + + + + + + + + + + + + + + + + + + +``` + +### 7.2.7 ACR service + +ACR is a subset of the ICB service, specified in subclause 7.2.11. + +### 7.2.8 CDIV service + +#### 7.2.8.1 User defined data + +The schema defined in subclause 4.9.2 of 3GPP TS 24.604 [2] shall be used. + +#### 7.2.8.2 Operator defined data + +##### 7.2.8.2.1 Data semantics + +The CDIV service is authorized by the operator by setting the "authorized" attribute of to "true". + +##### 7.2.8.2.2 XML Schema + +``` + + + + + + Operator part of the Communication Diversion (CDIV) services + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +### 7.2.9 CW service + +#### 7.2.9.1 User defined data + +The XML schema as defined in 3GPP TS 24.615 [9] subclause 4.8.3 shall be used. + +#### 7.2.9.2 Operator defined data + +##### 7.2.9.2.1 Data semantics + +The CW service is authorized by the operator by setting the "authorized" attribute of to "true". + +##### 7.2.9.2.2 XML Schema + +``` + + + + + + Operator part of the Communication Waiting (CW) service + + + + + + + + + + + + + + + + +``` + +``` + + +``` + +### 7.2.10 HOLD service + +#### 7.2.10.1 User defined data + +No user data is defined in 3GPP TS 24.610 [7] + +#### 7.2.10.2 Operator defined data + +##### 7.2.10.2.1 Data semantics + +The HOLD service is authorized and activated by the operator by setting the "authorized" attribute of to "true". + +##### 7.2.10.2.2 XML Schema + +``` + + + + + Operator part of the Hold service + + + + + + +``` + +### 7.2.11 CB service + +#### 7.2.11.1 User defined data + +The XML schema as defined in 3GPP TS 24.611 [8] subclause 4.9.2 shall be used. + +#### 7.2.11.2 Operator defined data + +##### 7.2.11.2.1 Data semantics + +The ICB and OCB services are authorized by the operator by setting the "authorized" attribute of and to "true". + +##### 7.2.11.2.2 XML Schema + +``` + + + + + Operator part of the Communication Barring (CB) service + + + + + + +``` + +### 7.2.12 CCBS/CCNR service + +#### 7.2.12.1 User defined data + +No user defined data specified in 3GPP TS 24.642 [12]. + +#### 7.2.12.2 Operator defined data + +##### 7.2.12.2.1 Data semantics + +The CCBS and CCNR service is authorized and activated by the operator by setting the "authorized" attribute of and , respectively, to "true". + +##### 7.2.12.2.1 XML Schema + +``` + + + + + Operator part of the Completion of Communication (CC) service + + + + + + +``` + +### 7.2.13 MWI service + +#### 7.2.13.1 User defined data + +No user data is defined in 3GPP TS 24.606 [4]. + +#### 7.2.13.2 Operator defined data + +##### 7.2.13.2.1 Data semantics + +The MWI service is authorized and activated by the operator by setting the "authorized" attribute of to "true". + +##### 7.2.13.2.2 XML Schema + +``` + + + + + Operator part of the Message Waiting Indication (MWI) service + + + + + + +``` + +### 7.2.14 CONF service + +#### 7.2.14.1 User defined data + +No user data is defined in 3GPP TS 24.605 [3] + +#### 7.2.14.2 Operator defined data + +##### 7.2.14.2.1 Data semantics + +The Conference service is authorized and activated by the operator by setting the "authorized" attribute of to "true". + +##### 7.2.14.2.2 XML Schema + +``` + + + + + Operator part of the Conference (CONF) service + + + + + +``` + +### 7.2.15 AOC service + +#### 7.2.15.1 User defined data + +No user data is defined in 3GPP TS 24.647 [13] + +#### 7.2.15.2 Operator defined data + +##### 7.2.15.2.1 Data semantics + +AOC service is described in 3GPP TS 32.280 [22] and in 3GPP TS 24.647 [13]. It consists of 3 services types AOC-S, AOC-D, AOC-E paired with an AOC Service obligatory type. + +Information elements + +- Service Authorized (for each service type AOC-S, AOC-D, AOC-E) +- AOC service type as described in 3GPP TS 32.280 [22] +- AOC service obligatory type as described in 3GPP TS 32.280 [22] +- Preferred AOC currency as described in 3GPP TS 32.280 [22] +- AOC format as described in 3GPP TS 32.280 [22] + +The AOC services are authorized and activated by the operator by setting the "authorized" attribute of , , to "true". + +##### 7.2.15.2.2 XML Schema + +``` + + + + + Operator part of the Advice of Charge (AOC) service + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +### 7.2.16 ECT service + +#### 7.2.16.1 User defined data + +No user data is defined in 3GPP TS 24.629 [11]. + +#### 7.2.16.2 Operator defined data + +##### 7.2.16.2.1 Data semantics + +The ECT service is authorized and activated by the operator by setting the "authorized" attribute of to "true". + +##### 7.2.16.2.2 XML Schema + +``` + + + + + + Operator part of the Explicit Communication Transfer (ECT) service + + + + + + +``` + +## 7.2.17 Reverse charging service + +NOTE: The reverse charging service is not defined + +## 7.2.18 CUG service + +### 7.2.18.1 User defined data + +CUG is not supported for the XML option. + +### 7.2.18.2 Operator defined data + +CUG is not supported for the XML option. + +## 7.2.19 3PTY service + +3PTY service is a subset of the CONF service specified in subclause 7.2.14. + +## 7.2.20 FA service + +### 7.2.20.1 User defined data + +The XML schema as defined in 3GPP TS 24.239 [15] subclause 4.8.3 shall be used. + +### 7.2.20.1 Operator defined data + +#### 7.2.20.1.1 Data semantics + +The FA service is authorized and activated by the operator by setting the "authorized" attribute of to true. + +#### 7.2.20.1.2 XML schema + +``` + + + + + + + Operator part of the Flexible Alerting (FA) service + + + + + + + + + + + + + + + + + Operator schema per Flexible Alerting (FA) group + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +## 7.2.21 Void + +## 7.2.22 CAT service + +### 7.2.22.1 User defined data + +No user data is defined in 3GPP TS 24.182 [21]. + +### 7.2.22.2 Operator defined data + +#### 7.2.22.2.1 Data semantics + +The CAT service is authorized and activated by the operator by setting the "authorized" attribute of to "true". + +#### 7.2.22.2.2 XML Schema + +``` + + + + + + Operator part of the Customized Alerting Tone (CAT) service + + + + + + +``` + +## 8 Mechanisms for transfer of Service Data between Application Server and the HSS for AS interoperability + +### 8.1 Sh procedures to transfer Service Data + +Standardized procedures of the Sh interface described in 3GPP TS 29.328 [18] are used between the AS and the HSS to access and update the Service Data attached to a user. + +To aid a proper interoperability between AS, a certain number of additional recommendations are hereafter described: + +- After an AS has created or modified Service Data, it shall update the Service Data in the HSS with the Sh-Update procedure. +- After an AS has downloaded Service Data from the HSS for a given user, it should subscribe to the notification of Service Data with the Sh-Subs-Notif +- If the AS has subscribed to the notification of Service Data, the AS shall support the Sh-Notif procedure to be informed of the changes in the Service Data. +- HSS and AS shall use Sequence Number information to ensure data synchronization + +### 8.2 Base64 data encoding + +As the Service Data for the binary option are in binary format, it shall be transcoded in a character mode to be transferred over the Sh interface. + +The standard used for this transcoding is the base64 encoding mechanism as described in IETF RFC 2045 [19]. + +In reference to 3GPP TS 29.328 [18], Annex D, Tables D.1 and D.2, MMTEL Service Data used for AS interoperability is defined according to Table 8.2-1 regarding the XML schema for the Sh user profile interface. + +**Table 8.2-1: Data type for Service Data in the XML schema for the Sh user profile interface** + +| Data type | Tag | Base type | Comments | +|--------------|-------------|-----------|-------------------------------------------| +| tServiceData | ServiceData | String | Base64 encoded according to RFC 2045 [19] | + +## 9 IMS user group + +### 9.1 General + +An IMS user group comprises a list of IMS users which are members of the group and for which a certain service is offered specific to the group. Some generic data with the same meaning may appear for any IMS user group, especially the ones related to the relations between the IMS user group and its members, e.g. the list of the users that are members of the group. This specification only addresses the case when this generic data is stored in the HSS and transferred to the HSS through Sh as transparent data. + +This specification standardizes the coding of a set of generic IMS user group data over the Sh interface within the repository data and the associated service indications. + +The generic IMS user group data is defined in clause 9.3 + +Data describing service or feature content supported by an IMS user group is not considered as generic data associated to this IMS user group or to a member of this IMS user group. Such data is outside the scope of this specification. + +### 9.2 Group identification and service indications + +An IMS user group may be identified by + +a Public Service Identity of which the form is described in 3GPP TS 23.003 [24] or + +a Public User Identity when the group is identified by one of its user (e.g. the group controller). + +The group identifier is handled as part of an IMS subscription but is used solely for Sh transparent data handling. The only intention of the IMS user group identifier is to identify a data container into HSS. IMS subscription management or traffic procedures of an IMS user group identifier do not apply to the group as such or any of its members. E.g. if IMPU1 is used to identify an IMS user group that consists of two users, identified by IMPU1 and IMPU2, if IMPU1 is registered, it does not have any effect in the group as such, i.e. IMPU2 registration status is not modified. The only intention of the usage of IMPU1 as the group identifier is to identify IMPU1 as the subscriber in HSS where the group transparent information (see 9.3.1) is stored. + +The generic IMS user group data associated to an IMS user group shall be contained in the Service Data of the Repository data with the Service Indication having the value "IMS-GROUP". + +The generic IMS group member data associated to an IMS user, identified by its public user identity, that is member of one or more IMS user groups shall be contained in the Service data of the Repository Data of this user with a Service Indication having the value "IMS-GROUP-MEMBER". + +When a user belongs to different IMS groups, the Service Data comprises different subsets of IMS group member data, each associated to an IMS user group. + +## 9.3 Information elements + +### 9.3.1 Information elements associated to a IMS user group + +The generic IMS user group data associated to an IMS user group comprises: + +- the list of members of the IMS user group that comprises the public user identity of each member + +Specific IMS user group data in particular parameters depending of the service content and attached to the group or to a member of the group is not standardised in this specification. It is implementation dependent to describe this data in repository data with specific AS dependent service indications. + +### 9.3.2 Information elements associated to a IMS group member + +The generic IMS user group member data of a user that is member of one or more IMS user groups associated comprises: + +- the identities of the IMS groups to which the user belongs to + +Specific group member data in particular parameters depending of the service content of the group for this member is not standardised in this specification. It is implementation dependent to describe this data in repository data with specific AS dependent service indications. + +## 9.4 XML schemas + +### 9.4.1 XML schema of the IMS group data + +The hereafter XML schema describes the structure and content of the IMS group data. It will allow future extensions for adding new generic IMS group data. + +``` + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + +``` + +## 9.4.2 XML schema of the IMS group member data + +The hereafter XML schema describes the structure and content of the IMS group data. It will allow future extensions for adding new generic IMS group data. + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +# 10 ODB Information for IMS Oriented Services + +## 10.1 Service Indication + +A dedicated Service Indication value shall be used for repository data containing ODB Information for IMS Oriented Services formatted according to the XML schema specified in clause 10.2. The value of the Service Indication shall be "IMS-ODB-Information". + +Proprietary extensions shall use not standardized Service Indications. There is no constraint for the data structure of the proprietary Service Data. + +## 10.2 IMS-ODB-Information schema + +The following shows the IMS-ODB-Information schema: + +``` + + + + + + + + + + +``` + +``` + + + + outgoing communication barred + + + + + + + + outgoing international communications barred + + + + + + + + outgoing international communications barred except those +directed to the home plmn country + + + + + + + + outgoing communications barred when roaming outside the hplmn +country + + + + + + + + + + + + + + incoming communication barred + + + + + + + + incoming communications barred when roaming outside the hplmn +country + + + + + + + + + + + + + + roaming outside hplmn barred + + + + + + + + roaming outside hplmn country barred + + + + + + +``` + +``` + + + + + + + + + + + registration of any communication diverted-to address +barred + + + + + + + + registration of any international communication diverted-to +address barred + + + + + + + + registration of any international communication diverted-to +address except addresses within the hplmn country barred + + + + + + + + + + + + + + invocation of communication transfer barred + + + + + + + + invocation of communication transfer where at least one of the +two communications is a communication charged to the served subscriber barred + + + + + + + + invocation of communication transfer where at least one of the +two communications is a communication charged to the served subscriber at international rates +barred + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +# 11 IMS CAMEL Services + +## 11.1 General + +IMS CAMEL related subscription data, including O-IM-CSI, D-IM-CSI and VT-IM-CSI, are provisioned in the HSS and downloaded to the IM-SSF AS to support Customized Applications for Mobile network Enhanced Logic (CAMEL) feature for the IP Multimedia Core Network (IM CN) Subsystem, as defined in the 3GPP TS 23.278 [26]. + +This specification standardizes the coding of the IMS CAMEL subscription data based on XML when transported via Sh interface within the repository data and the associated service indications. + +## 11.2 Service Indications + +A dedicated Service Indication shall be used for IMS CAMEL services. The value of the Service Indication shall be "IMS-CAMEL-Services". + +Proprietary extensions shall use not standardized Service Indications. There is no constraint for the data structure of the proprietary Service Data. + +## 11.3 XML schemas + +### 11.3.1 XML schema of IMS CAMEL Services + +The following XML schema describes the IMS CAMEL Subscription data. + +NOTE: The XML schema follows the encoding for IM CSI subscription data as defined in 3GPP TS 29.002 [27]. + +``` + + + + IM CSI Information + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +## 11.3.2 XML schema of Common Data for IMS CAMEL Services + +The file "im-ssf-comm.xsd" contains all the common types of IMS CAMEL Subscription data. This schema is defined as + +``` + + + + Common Data of Intelligent Network Subscriber Information + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +### 11.3.3 XML schema for O-IM-CSI + +The file "o-IM-CSI.xsd" contains the XML schema for O-IM-CSI. This schema is defined as + +``` + + + + + Intelligent Network Subscriber Information of o-IM-CSI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +### 11.3.4 XML schema for O-IM-BcsmCamelTDP-CriteriaList + +The file "o-IM-bcsm-camel-TDP-criteria-list.xsd" contains the XML schema for O-IM-BcsmCamelTDP-CriteriaList. This schema is defined as + +``` + + + + Intelligent Network Subscriber Information of o-IM-bcsm-camel- + TDP-criteria-list + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + +``` + +### 11.3.5 XML schema for D-IM-CSI + +The file "d-IM-CSI.xsd" contains the XML schema for D-IM-CSI. This schema is defined as + +``` + + + + Intelligent Network Subscriber Information of d-IM-CSII + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +### 11.3.6 XML schema for VT-IM-CSI + +The file "vt-IM-CSI.xsd" contains the XML schema for VT-IM-CSI. This schema is defined as + +``` + + + + Intelligent Network Subscriber Information of vt-IM-CSI + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + +``` + +### 11.3.7 XML schema for VT-IM-BCSM-CAMEL-TDP-CriteriaList + +The file "vt-bcsm-camel-TDP-criteria-list.xsd" contains the XML schema for VT-IM-BCSM-CAMEL-TDP-CriteriaList. This schema is defined as + +``` + + + + + Intelligent Network Subscriber Information of vt-bcsm-camel- + TDP-criteria-list + + + + + + + + + + + + + + + + + + + + + + + + +``` + +## 12 Shared Repository Data identification + +### 12.1 General + +This clause describes an optional solution to avoid potential large amount of update, and possible notification, operations in Sh when data is shared among multiple subscribers. Only Repository Data may be shared among multiple subscribers. + +### 12.2 Description + +Shared Repository Data among multiple subscribers may be supported in the HSS. Each shared Repository Data is uniquely identified by a distinct IMS Public Service Identity and a Service Indication. + +This PSI is only used for accessing the shared Repository Data via Sh interface. This PSI shall not exist from an IMS management point of view and thus it shall not be allowed to be unregistered or to be used as an IMS user in any way. The PSI Activation State shall be set to Inactive. + +The PSI(s) used to identify a shared Repository Data are contained in a specific Repository Data (identified by a dedicated Service Indication value "SHARED-REPOSITORY-DATA-IDENTIFICATION") stored for each subscriber to whom this shared Repository Data applies. + +One or multiple shared Repository Data may be stored in the HSS, while a subscriber may reference one or several of them. + +When an AS wants to read a shared Repository Data for a subscriber, the AS should retrieve first the PSI(s) contained in the Repository Data identified by the dedicated Service Indication value "SHARED-REPOSITORY-DATA-IDENTIFICATION" and the Public Identity of this subscriber. Then, the AS uses received PSI(s) to retrieve the shared Repository Data, using corresponding specific Service Indication. + +The AS should store the shared Repository Data locally and it should subscribe to notifications on changes. If shared Repository Data is modified, the HSS notifies the AS about it with a single Sh notification. + +See figure 12.2-1 for an example of shared Repository Data usage. + +![Diagram illustrating Shared Data example with columns for Public Identity, Repository Data, and Shared Repository Data.](91b12db3c85bbf466ad27eb3665a1b06_img.jpg) + +The diagram illustrates the relationship between Public Identity, Repository Data, and Shared Repository Data across four subscribers (IMPU1 to IMPU4). + +- Public Identity:** Contains four boxes labeled IMPU1, IMPU2, IMPU3, and IMPU4. +- Repository Data:** Contains four boxes, one for each subscriber. + - IMPU1's box contains: `SI=MMTEL-Services [XML]` and `SI=SHARED-REPOSITORY-DATA-IDENTIFICATION [PSI1]`. + - IMPU2's box contains: `SI=MMTEL-Services [XML]` and `SI=SHARED-REPOSITORY-DATA-IDENTIFICATION [PSI2]`. + - IMPU3's box contains: `SI=Y [XML]` and `SI=SHARED-REPOSITORY-DATA-IDENTIFICATION [PSI2]`. + - IMPU4's box contains: `SI=Y [XML]` and `SI=SHARED-REPOSITORY-DATA-IDENTIFICATION [PSI3, PSI4]`. +- Shared Repository Data:** Contains four boxes labeled PSI1, PSI2, PSI3, and PSI4. + - PSI1 contains: `SI=X [XML]` and `SI=Y [XML]`. + - PSI2 contains: `SI=X [XML]`. + - PSI3 contains: `SI=Y [XML]` and `SI=Z [XML]`. + - PSI4 contains: `SI=N [XML]`. + +Arrows indicate the following relationships: + +- IMPU1 points to its Repository Data box. +- IMPU2 points to its Repository Data box. +- IMPU3 points to its Repository Data box. +- IMPU4 points to its Repository Data box. +- From IMPU1's Repository Data box, an arrow points from the `SI=SHARED-REPOSITORY-DATA-IDENTIFICATION [PSI1]` element to the PSI1 box. +- From IMPU2's Repository Data box, an arrow points from the `SI=SHARED-REPOSITORY-DATA-IDENTIFICATION [PSI2]` element to the PSI2 box. +- From IMPU3's Repository Data box, an arrow points from the `SI=SHARED-REPOSITORY-DATA-IDENTIFICATION [PSI2]` element to the PSI3 box. +- From IMPU4's Repository Data box, an arrow points from the `SI=SHARED-REPOSITORY-DATA-IDENTIFICATION [PSI3, PSI4]` element to the PSI4 box. + +Diagram illustrating Shared Data example with columns for Public Identity, Repository Data, and Shared Repository Data. + +Figure 12.2-1: Shared Data example + +If the same Repository Data is defined for a subscriber both as individual Repository Data and shared Repository Data, the individual one shall take precedence. + +The same Repository Data shall not be defined as different shared Repository Data for the same subscriber. + +## 12.3 Service Indication + +The shared Repository Data identification shall be contained in the Service Data of the Repository Data with the Service Indication having the value "SHARED-REPOSITORY-DATA-IDENTIFICATION". + +## 12.4 Information elements + +### 12.4.1 Shared Repository Data reference + +A shared Repository Data identification is a distinct IMS Public Service Identity, as described in 3GPP TS 23.003 [24]. + +## 12.5 XML schemas + +### 12.5.1 Shared Repository Data identification + +The XML schema below describes the structure and content of the shared Repository Data identification. + +``` + + + + + + + +``` + +## Annex A (informative): Dataset example with variable length data + +This example illustrates the use of offset and length elements to point variable data in a dataset. + +Four variables are defined, each with the following values: + +Var1 = 012345678 + +Var2 empty + +Var3 = ABCD + +Var4= 12345678 + +The coding of the dataset is as follows: + +**Figure Annex A-1: Dataset example** + +![](294444660b1376c49aeca748b8184e77_img.jpg) + +| Byte order | | | | | | +|------------|-------------------------|-------|---|---|----------------------| +| 0 | Dataset header | | | | | +| | Other fixed format data | | | | | +| | Var1 | | | | | +| | Offset=60 | Len=9 | | | | +| | Var2 | | | | | +| | Offset=69 | Len=0 | | | | +| | Other fixed format data | | | | | +| | Var3 | | | | | +| | Offset=69 | Len=4 | | | | +| | Var4 | | | | | +| | Offset =73 | Len=8 | | | | +| | Other fixed format data | | | | | +| 60 | 0 | 1 | 2 | 3 | Variable length data | +| 64 | 4 | 5 | 6 | 7 | | +| 68 | 8 | A | B | C | | +| 72 | D | 1 | 2 | 3 | | +| 76 | 4 | 5 | 6 | 7 | | +| 80 | 8 | | | | | + +## Annex B (informative): Change history + +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | New | +|---------|--------|-----------|------|-----|---------------------------------------------------------------------------------------------------------|--------| +| 2008-12 | CT#42 | CP-080720 | | | V1.0.0 approved in CT#42 | 8.0.0 | +| 2009-03 | CT#43 | CP-090027 | 0001 | 1 | Network provider options for CDIV with binary option | 8.1.0 | +| | | | 0002 | 1 | Complement on NDUB parameter in the binary option | | +| | | | 0003 | 1 | IMS CAT description with binary option | | +| | | | 0004 | 1 | AOC parameters with binary option | | +| | | | 0005 | 2 | Editor's notes and Service names corrections | | +| | | | 0006 | | AOC Service with XML option | | +| | | | 0007 | | Service Indication for XML format | | +| | | | 0008 | | Addition of schema locations for XML files | | +| | | | 0009 | | Cleanup of XML files for operator common data | | +| | | | 0010 | 1 | NDUB parameter in XML option | | +| | | | 0011 | 1 | CUG not supported in XML option | | +| | | | 0012 | 2 | CAT parameters in XML option | | +| | | | 0013 | 1 | Reverse charging note in XML | | +| | | | 0014 | 1 | CC parameters in XML option | | +| 2009-06 | CT#44 | CP-090304 | 0016 | 1 | Document references in AOC subclause | 8.2.0 | +| | | | 0017 | 1 | Editorial Changes | | +| 2009-06 | | | | | Styles and format errors corrected in tables caused by implementation in v.8.2.0, e.g. bullets removed. | 8.2.1 | +| 2009-09 | CT#45 | CP-090551 | 0018 | 1 | Flexible Alerting with binary option | 8.3.0 | +| | | | 0019 | | CAT User configuration | | +| | | | 0020 | 1 | XML schema for Flexible Alerting | | +| 2009-12 | - | - | - | - | Update to Rel-9 version (MCC) | 9.0.0 | +| 2011-03 | - | - | - | - | Update to Rel-10 version (MCC) | 10.0.0 | +| 2011-09 | CT#53 | CP-110556 | 0023 | - | OIP/OIR data syntax | 10.1.0 | +| 2012-09 | CT#57 | CP-120482 | 0027 | - | IMS user group over Sh | 11.0.0 | +| 2012-12 | CT#58 | CP-120715 | 0028 | 1 | XML corrections | 11.1.0 | +| | | CP-120876 | 0029 | 2 | Transparent Data coding of IMS ODB info | | +| 2013-03 | CT#59 | CP-130012 | 0041 | - | XML document Version | 11.2.0 | +| 2013-03 | CT#59 | CP-130034 | 0030 | 2 | IM-SSF Service Data Definition based on XML | 12.0.0 | +| | | | 0031 | 2 | XML Schema for IM-SSF | | +| 2013-06 | CT#60 | CP-130302 | 0042 | - | Correction on XML Schema for IMS CAMEL Data | 12.1.0 | +| 2014-06 | CT#64 | CP-140240 | 0043 | 1 | Correction on XML Schema for IMS CAMEL Services | 12.2.0 | +| 2015-03 | CT#67 | CP-150016 | 0048 | - | Removal of CDIVN service | 12.3.0 | +| 2015-06 | CT#68 | CP-150273 | 0050 | 1 | Shared Repository Data reference | 13.0.0 | +| 2015-12 | CT#70 | CP-150750 | 0051 | - | Communication Barring wording correction | 13.1.0 | +| 2017-03 | CT#75 | - | - | - | Update to Rel-14 version (MCC) | 14.0.0 | +| 2018-06 | CT#80 | - | - | - | Update to Rel-15 version (MCC) | 15.0.0 | +| 2020-07 | CT#88e | - | - | - | Update to Rel-16 version (MCC) | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29368/0236eff05bcb8f3a343ea7933aaa306b_img.jpg b/marked/Rel-16/29_series/29368/0236eff05bcb8f3a343ea7933aaa306b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c57f802d96f2e52665d9a1e5cfe6acb8669dd03c --- /dev/null +++ b/marked/Rel-16/29_series/29368/0236eff05bcb8f3a343ea7933aaa306b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8a27f02ec07f8afb62b3810d69c51453856d8815ac96dae5c248dc2c57ca6a58 +size 51031 diff --git a/marked/Rel-16/29_series/29368/20136850feb70fd71c7d41cdae203ebb_img.jpg b/marked/Rel-16/29_series/29368/20136850feb70fd71c7d41cdae203ebb_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a6f19359f7b21bb357912dd1c5a25c46358ea83b --- /dev/null +++ b/marked/Rel-16/29_series/29368/20136850feb70fd71c7d41cdae203ebb_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:68c8548e020c4d45c1f15bc064ef0a067cf07af4afba52ed3888d78a25683b1b +size 41747 diff --git a/marked/Rel-16/29_series/29368/28d75f39a24203712ee907b32cf0bbe5_img.jpg b/marked/Rel-16/29_series/29368/28d75f39a24203712ee907b32cf0bbe5_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3a1f6f6a6bf7c932d29650f1efa2d911233a889d --- /dev/null +++ b/marked/Rel-16/29_series/29368/28d75f39a24203712ee907b32cf0bbe5_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:10ec18f47b255efc5c99ef40e718f0202ed7728feb24e07da4f6d9a452bb2a36 +size 83516 diff --git a/marked/Rel-16/29_series/29368/2ae3eae1bd80a90f192f568ae246a9a6_img.jpg b/marked/Rel-16/29_series/29368/2ae3eae1bd80a90f192f568ae246a9a6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..45efe3d009444a285a2570045c5f2fd2f50a9796 --- /dev/null +++ b/marked/Rel-16/29_series/29368/2ae3eae1bd80a90f192f568ae246a9a6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:637171bb73a2e6904a752deb720ff7c80387c286c46ce88b45c712e71ab07c85 +size 56733 diff --git a/marked/Rel-16/29_series/29368/5132b3a97ac70fe4765c1e07e66b72b3_img.jpg b/marked/Rel-16/29_series/29368/5132b3a97ac70fe4765c1e07e66b72b3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ceeb153583e9bfef0d101dff1eb147be43f96da8 --- /dev/null +++ b/marked/Rel-16/29_series/29368/5132b3a97ac70fe4765c1e07e66b72b3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ee36eec6ce154ba213e9095ac784d1513e4131abeb244b5a640a75f6350525b7 +size 34028 diff --git a/marked/Rel-16/29_series/29368/6f31cdb576d2f15c35c3f266e5f59211_img.jpg b/marked/Rel-16/29_series/29368/6f31cdb576d2f15c35c3f266e5f59211_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..662b9f41c68f18ca2faab57fddde4c2e37d11e6f --- /dev/null +++ b/marked/Rel-16/29_series/29368/6f31cdb576d2f15c35c3f266e5f59211_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2d897bc5914fe4189d7d13d4519b7f74057ba4f561397049eb511a06613abff0 +size 66884 diff --git a/marked/Rel-16/29_series/29368/7d2d1d3870cd224c4430d19334557716_img.jpg b/marked/Rel-16/29_series/29368/7d2d1d3870cd224c4430d19334557716_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ade759ab76ce6aa7b7b138ffb1f3f36849a559e5 --- /dev/null +++ b/marked/Rel-16/29_series/29368/7d2d1d3870cd224c4430d19334557716_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0b4547c135f0ae46e63121b1d89ec8a24df212b72bb298094fb6c615821d8b01 +size 59365 diff --git a/marked/Rel-16/29_series/29368/9c1d3678db4a12d5864cb2a4def1135d_img.jpg b/marked/Rel-16/29_series/29368/9c1d3678db4a12d5864cb2a4def1135d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6300f0519888e70c07e6fc383f8772a95058f4aa --- /dev/null +++ b/marked/Rel-16/29_series/29368/9c1d3678db4a12d5864cb2a4def1135d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:03b3143e44eb14c629a55d3c25b063a9e83002c740272686b372d39694a95f08 +size 60506 diff --git a/marked/Rel-16/29_series/29368/a0739aaf13fa5a632d4faa830f6b2708_img.jpg b/marked/Rel-16/29_series/29368/a0739aaf13fa5a632d4faa830f6b2708_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e18c0e57307f6d1bac7d8cc1a6d98ed9303f55f7 --- /dev/null +++ b/marked/Rel-16/29_series/29368/a0739aaf13fa5a632d4faa830f6b2708_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d3e8353b45157ea5c326ecb3ae1628142c7c41163a93b57b75c77a6aaf2f4779 +size 70928 diff --git a/marked/Rel-16/29_series/29368/raw.md b/marked/Rel-16/29_series/29368/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..fdd837b01d85f4b8830c7bc31159c91fb6e146d9 --- /dev/null +++ b/marked/Rel-16/29_series/29368/raw.md @@ -0,0 +1,1235 @@ + + + + +Error! No +text of + +Error! No text of specified style in +document. + +# Contents + +| | | +|------------------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Definitions, symbols and abbreviations..... | 6 | +| 3.1 Definitions..... | 6 | +| 3.2 Symbols..... | 6 | +| 3.3 Abbreviations ..... | 6 | +| 4 Tsp reference point..... | 7 | +| 4.1 Tsp Reference model..... | 7 | +| 4.2 Functional elements..... | 7 | +| 4.2.1 SCS ..... | 7 | +| 4.2.2 MTC-IWF..... | 7 | +| 5 Procedures over Tsp reference point..... | 8 | +| 5.1 General ..... | 8 | +| 5.2 Reference number handling ..... | 8 | +| 5.3 MTC-IWF selection ..... | 8 | +| 5.4 MTC-IWF load control ..... | 9 | +| 5.5 Request and confirmation of a device trigger ..... | 9 | +| 5.6 Notification of Device trigger ..... | 10 | +| 5.7 Request and confirmation of a device trigger recall request..... | 10 | +| 5.8 Request and confirmation of a device trigger replace request ..... | 11 | +| 5.9 Delivery of a MSISDN-less MO-SMS..... | 11 | +| 6 Tsp protocol ..... | 12 | +| 6.1 Protocol support ..... | 12 | +| 6.1.1 Use of Diameter base protocol ..... | 12 | +| 6.1.2 Transport protocol ..... | 12 | +| 6.1.3 Advertising Application Support..... | 12 | +| 6.2 Initialization and maintenance of connection and session ..... | 13 | +| 6.3 Security on the Tsp interface..... | 13 | +| 6.3.1 General ..... | 13 | +| 6.3.2 Mutual authentication..... | 13 | +| 6.3.3 Security profiles..... | 14 | +| 6.4 Tsp specific AVPs..... | 14 | +| 6.4.1 General ..... | 14 | +| 6.4.2 Device-Action AVP..... | 15 | +| 6.4.3 Device-Notification AVP ..... | 15 | +| 6.4.4 Trigger-Data AVP ..... | 16 | +| 6.4.5 Payload AVP ..... | 16 | +| 6.4.6 Action-Type AVP..... | 16 | +| 6.4.7 Priority-Indication AVP ..... | 16 | +| 6.4.8 Reference-Number AVP ..... | 17 | +| 6.4.9 Request-Status AVP ..... | 17 | +| 6.4.10 Delivery-Outcome AVP ..... | 18 | +| 6.4.11 Application-Port-Identifier AVP ..... | 19 | +| 6.4.12 Old-Reference-Number AVP ..... | 19 | +| 6.4.13 Feature-Supported-In-Final-Target AVP ..... | 19 | +| 6.5 Tsp re-used AVPs..... | 19 | +| 6.5.1 General ..... | 19 | +| 6.5.2 Supported-Feature-List AVP..... | 20 | +| 6.5.2.1 Use of the Supported-Features AVP..... | 20 | +| 6.5.2.2 Supported-Feature-List AVP for the Tsp application..... | 20 | +| 6.6 Tsp Messages ..... | 21 | +| 6.6.1 Command-Code Values..... | 21 | +| 6.6.2 Device-Action-Request (DAR) command..... | 21 | +| 6.6.3 Device-Action-Answer (DAA) command..... | 22 | + +6.6.4 Device-Notification-Request (DNR) command..... 22 +6.6.5 Device-Notification-Answer (DNA) command ..... 22 +**Annex A (informative): Tsp Message Flows..... 24** +A.1 General..... 24 +A.2 Tsp Submission, T4 Delivery..... 24 +A.3 Tsp failed Submission..... 25 +A.4 Tsp Submission, Failed T4 Delivery..... 26 +A.5 Tsp Recall Submission, Recall Success..... 27 +A.6 Tsp Recall Submission, Recall Failure ..... 28 +A.7 Tsp Replace Submission, Replace Success..... 28 +A.8 Tsp Replace Submission, Replace Failure ..... 29 +A.9 Delivery of a MSISDN-less MO-SMS ..... 31 +B.1 General ..... 32 +B.2 SCS behaviour..... 32 +B.3 MTC-IWF behaviour..... 32 +Annex C (informative): Change history..... 33 + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 1 Scope + +The present document provides the stage 3 specification of the Tsp reference point for the present release. The functional requirements and the stage 2 specifications of the Tsp reference point are contained in TS 23.682 [2]. The Tsp reference point lies between the Service Capability Server (SCS) and the Machine Type Communication Inter Working Function (MTC-IWF). + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.682: "Architecture enhancements to facilitate communications with packet data networks and applications". +- [3] 3GPP TS 29.329: "Sh Interface based on the Diameter protocol". +- [4] IETF RFC 791: "Transmission Control Protocol". +- [5] IETF RFC 2234: "Augmented BNF for syntax specifications". +- [6] IETF RFC 3588: "Diameter Base Protocol". +- [7] IETF RFC 4006: "Diameter Credit Control Application". +- [8] IETF RFC 4960: "Stream Control Transmission Protocol". + +- [9] IETF RFC 5719: "Updated IANA Considerations for Diameter Command Code Allocations". +- [10] 3GPP TS 33.210: "Network Domain Security (NDS); IP network layer security". +- [11] 3GPP TS 33.310: "Network Domain Security (NDS); Authentication Framework (AF)". +- [12] 3GPP TS 29.336: "Home Subscriber Server (HSS) diameter interfaces for interworking with packet data networks and applications". +- [13] 3GPP TS 29.303: "Domain Name System Procedures; Stage 3". +- [14] 3GPP TS 23.003: "Numbering, addressing and identification". +- [15] 3GPP TS 23.040: "Technical realization of the Short Message Service (SMS)". +- [16] 3GPP TS 29.229: "Cx and Dx interfaces based on the Diameter protocol". +- [17] 3GPP TS 29.337: "Diameter-based T4 interface for communications with packet data networks and applications". +- [18] IETF RFC 6733: "Diameter Base Protocol". +- [19] IETF RFC 8583: "Diameter Load Information Conveyance". +- [20] 3GPP TS 29.338: "Diameter based protocols to support SMS capable MMEs". + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in TR 21.905 [1]. + +## 3.2 Symbols + +For the purposes of the present document, no symbols are defined. + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in TR 21.905 [1]. + +| | | +|-----|--------------------------------| +| AVP | Attribute Value Pair | +| CEA | Capabilities-Exchange-Answer | +| CER | Capabilities-Exchange-Request | +| DAA | Device-Action-Answer | +| DAR | Device-Action-Request | +| DNA | Device-Notification-Answer | +| DNR | Device-Notification-Request | +| DNS | Domain Name System | +| ESP | Encapsulating Security Payload | +| IKE | Internet Key Exchange | +| IWF | Inter Working Function | +| MTC | Machine Type Communication | +| PKI | Public key infrastructure | +| SCS | Service Capability Server | +| TLS | Transport Layer Security | + +# 4 Tsp reference point + +## 4.1 Tsp Reference model + +The Tsp reference point is defined between the Service Capability Server (SCS) and the Machine Type Communication Inter Working Function (MTC-IWF). The relationships between the different functional entities involved are depicted in figure 4.1.1. + +![Figure 4.1.1: Tsp reference point at 3GPP Architecture for Machine-Type Communication. The diagram shows the flow of control and user plane traffic between various network elements. On the left, an MTC UE Application connects to a UE, which connects to a RAN (via Um/Uu/LTE-Uu interfaces). The RAN connects to a cloud representing the SGSN/MME/MSC. Above the cloud is the HSS, connected via an S6m interface. The SGSN/MME/MSC connects to the MTC-IWF via an S6m interface. The MTC-IWF is connected to the SMS-SC/GMSC/IWMSC via a T4 interface, to the CDF/CGF via an Rf/Ga interface, and to the Services Capability Server (SCS) via the Tsp reference point. The SCS is connected to an Application Server (AS). A legend indicates that dashed lines represent the control plane and solid lines represent the user plane.](0236eff05bcb8f3a343ea7933aaa306b_img.jpg) + +Figure 4.1.1: Tsp reference point at 3GPP Architecture for Machine-Type Communication. The diagram shows the flow of control and user plane traffic between various network elements. On the left, an MTC UE Application connects to a UE, which connects to a RAN (via Um/Uu/LTE-Uu interfaces). The RAN connects to a cloud representing the SGSN/MME/MSC. Above the cloud is the HSS, connected via an S6m interface. The SGSN/MME/MSC connects to the MTC-IWF via an S6m interface. The MTC-IWF is connected to the SMS-SC/GMSC/IWMSC via a T4 interface, to the CDF/CGF via an Rf/Ga interface, and to the Services Capability Server (SCS) via the Tsp reference point. The SCS is connected to an Application Server (AS). A legend indicates that dashed lines represent the control plane and solid lines represent the user plane. + +Figure 4.1.1: Tsp reference point at 3GPP Architecture for Machine -Type Communication + +## 4.2 Functional elements + +### 4.2.1 SCS + +The SCS is the entity which connects MTC application servers to the 3GPP network to enable them to communicate through specific 3GPP defined services with UEs used for MTC and with the MTC-IWF in the HPLMN. The SCS offers capabilities for use by one or multiple MTC application servers. + +An SCS can be connected to one or more MTC-IWFs. + +The SCS is controlled by the operator of the HPLMN or by a MTC Service Provider. + +### 4.2.2 MTC-IWF + +The MTC-IWF resides in the HPLMN. An MTC-IWF could be a standalone entity or a functional entity of another network element. The MTC-IWF hides the internal PLMN topology and relays or translates information sent over Tsp to invoke specific functionality in the PLMN. + +An MTC-IWF can be connected to one or more SCSs. + +The functionality of the MTC-IWF includes the following: + +- terminates the Tsp, S6m, T4 and Rf/Ga reference points; +- supports ability to authorize the SCS before communication establishment with the 3GPP network; +- supports ability to authorize control plane requests from an SCS; +- supports the following device trigger functionality: + +- reception of a device trigger request from SCS; +- reception of a device trigger recall/replace request from SCS; +- reporting to the SCS the acceptance or non-acceptance of the device trigger request; +- reporting to the SCS the acceptance or non-acceptance of the device trigger recall/replace request; +- reports to the SCS the success, failure or unconfirmed outcome of a device trigger delivery; +- reports to the SCS the success, failure or unconfirmed outcome of the device trigger recall/replace request; +- provides load control information to SCS as part of the response to trigger requests; +- for MSISDN-less MO-SMS, delivers a payload and application port ID and the external ID of the UE to the SCS; +- supports ability for secure communication between the 3GPP network and the SCS. + +The architecture allows the use of multiple MTC-IWFs within a HPLMN. + +# --- 5 Procedures over Tsp reference point + +## 5.1 General + +The following procedures apply over the Tsp reference point: + +- Request and confirmation of a device trigger +- Notification of a device trigger +- Recalling or replacing of an already submitted device trigger +- Delivery of a MSISDN-less MO-SMS + +## 5.2 Reference number handling + +The reference number shall be assigned by the SCS. The reference number shall be provided by the SCS to the MTC-IWF in the first procedure initiated for a specific target of a specific action request (e.g. for a device trigger request towards a specific MTC device). The MTC-IWF and SCS shall use this reference number for all consecutive related procedures (e.g. for a confirmation of device trigger and notification of device trigger). + +The reference number shall be kept in MTC-IWF and in SCS until all related procedures for a specific target of a specific action request initiated by the SCS are completed (e.g. until the notification of device trigger is completed). + +For each new specific action request other than Device Trigger Recall Request, the SCS shall assign a reference number, which is different from any other reference number it has previously assigned to any other another action request with not yet completed related procedures. + +## 5.3 MTC-IWF selection + +To discover the MTC-IWF with which to establish the Tsp session, the SCS may use: + +- a pre-configured MTC-IWF identity +- DNS +- Diameter routing + +For DNS, the Domain Name System procedures as specified in TS 29.303 [13] may be used by the SCS for MTC-IWF selection. The External Identifier is defined in TS 23.003 [14] and is composed of Domain Identifier and Local Identifier. The DNS query can be performed deriving the domain name to be resolved from the Domain Identifier part of the External Identifier. + +For Diameter Routing, the Destination Realm should be derived from the Domain Identifier part of the External Identifier. + +## 5.4 MTC-IWF load control + +Upon receiving a device action request from the SCS: + +- if the MTC-IWF determines that the SCS has reached or exceeded the quota of Tsp requests that it is allowed to send, the MTC-IWF may respond to the SCS with a Device-Action-Answer command containing the Request-Status AVP with the value set to QUOTAEXCEEDED. +- if the MTC-IWF determines that the SCS has exceeded its rate of initiating Tsp requests, the MTC-IWF may respond to the SCS with a Device-Action-Answer command containing the Request-Status AVP with a value set to RATEEXCEEDED. +- if the MTC-IWF is in an overload condition, the MTC-IWF may respond to the SCS with a Device-Action-Answer command containing the Result-Code AVP with the value set to DIAMETER\_TOO\_BUSY, see IETF RFC 6733 [18]. + +For the above cases, the SCS on receiving the response from MTC-IWF, may provide an indication of the failed request to the application requesting services to the SCS. + +Alternatively, for RATEEXCEEDED and DIAMETER\_TOO\_BUSY, the SCS may implement a backoff timer which when running the SCS does not initiate Tsp requests to the MTC-IWF. Once the timer expires, the SCS may attempt to use the MTC-IWF which was formerly in an overload condition or for which SCS had exceeded the rate of Tsp requests. The algorithm the SCS uses for the backoff timer is out of scope of the 3GPP specification. + +## 5.5 Request and confirmation of a device trigger + +In order to request the MTC-IWF to perform a device trigger, the SCS shall send a Device-Action-Request command with the following AVP values within the Device-Action AVP: + +- a) Action-Type AVP set to the value Device Trigger Request (1). +- b) Either MSISDN AVP or External-Id AVP set to the identifier of the MTC device to be triggered. +- c) SCS-Identity AVP, containing the identity of the SCS that is requesting a device trigger to the UE. +- d) Reference-Number AVP, containing a newly assigned reference number the SCS has assigned to the specific action request. +- e) Trigger-Data AVP containing data to be sent to the MTC device with the trigger by the MTC-IWF in the Payload AVP, priority of the trigger in the Priority-Indication AVP and the triggering application addressed in the device indicated in the Application-Port-Identifier AVP. +- f) Validity-Time AVP, indicating the validity time of the device trigger request since the time the device action request has been received by the MTC-IWF. + +After the MTC-IWF has received from the SCS a Device-Action-Request command with device action set to Device Trigger Request (1), after receiving the Device-Trigger-Answer from SMS-SC, the MTC-IWF shall confirm the status of a device trigger request to the SCS by sending a Device-Action-Answer command and shall include the following AVP values within the Device-Notification AVP: + +- a) Action-Type AVP set to the value Device Trigger Request (1). +- b) Reference-Number AVP, containing the reference number received from the SCS for the specific action request. +- c) Request-Status AVP set to value indicating the status of the device trigger request requested by the SCS. + +The MTC-IWF may also include the following AVP within the Device-Notification AVP: + +- a) Either MSISDN AVP or External-Id AVP set to the identifier of the MTC device to be triggered. +- b) SCS-Identity AVP, containing the identity of the SCS that requested a device trigger to the UE. + +If the MTC-IWF concludes that it needs to abort the device trigger, it shall indicate the unsuccessful outcome with the Request-Status AVP and may release the reference number received from the SCS for the specific action request. + +## 5.6 Notification of Device trigger + +The MTC-IWF shall notify the SCS of the outcome of a device trigger request by sending a Device-Notification-Request command to the SCS with the following AVP values set in the Device-Notification AVP: + +- a) Action-Type AVP set to the value Delivery Report (2). +- b) Either MSISDN AVP or External-Id AVP set to the identifier of the MTC device triggered. +- c) SCS-Identity AVP, containing the identity of the SCS that requested a device trigger to the UE. +- d) Reference-Number AVP as received in the corresponding Device-Action-Request command by the SCS. +- e) Delivery-Outcome AVP set to the proper value, depending on success, failure or unconfirmed outcome of the delivery of the trigger request by the MTC-IWF to the MTC device. + +The SCS shall acknowledge the receipt of the Device-Notification-Request command by sending to the MTC-IWF a Device-Notification-Answer command. + +When the procedure is completed in the MTC-IWF and the SCS the reference number shall be released. + +## 5.7 Request and confirmation of a device trigger recall request + +In order to request the MTC-IWF to perform a device trigger recall, the SCS shall send a Device-Action-Request command with the following AVP values within the Device-Action AVP: + +- a) Action-Type AVP set to the value Device Trigger Recall (3). +- b) Either MSISDN AVP or External-Id AVP set to the identifier of the MTC device to be triggered. +- c) SCS-Identity AVP, containing the identity of the SCS that is requesting a device trigger to the UE. +- d) Reference-Number AVP, containing the assigned reference number the SCS has assigned to the trigger message to be recalled. + +After the MTC-IWF has received from the SCS a Device-Action-Request command with device action set to Device Trigger Recall (3), after receiving the Device-Trigger-Answer from SMS-SC the MTC-IWF shall confirm the status of a device trigger recall request to the SCS by sending a Device-Action-Answer command and shall include the following AVP values within the Device-Notification AVP: + +- a) Action-Type AVP set to the value Device Trigger Recall (3). +- b) Reference-Number AVP, containing the reference number of the recalled trigger message from the SCS. +- c) Request-Status AVP set to value indicating the status of the device trigger recall. + +If the MTC-IWF concludes that it needs to abort the device trigger recall, it shall indicate the unsuccessful outcome with the Request-Status AVP. + +The MTC-IWF may release the reference number received from the SCS if the trigger to be recalled is indicated as successfully recalled. + +## 5.8 Request and confirmation of a device trigger replace request + +In order to request the MTC-IWF to perform a device trigger replace, the SCS shall send a Device-Action-Request command with the following AVP values within the Device-Action AVP: + +- a) Action-Type AVP set to the value Device Trigger Replace (4). +- b) Either MSISDN AVP or External-Id AVP set to the identifier of the MTC device to be triggered. +- c) SCS-Identity AVP, containing the identity of the SCS that is requesting a device trigger to the UE + +- d) Reference-Number AVP, containing a newly assigned reference number the SCS has assigned to the specific action request. +- e) Old-Reference-Number AVP, containing the assigned reference number by the SCS for the trigger to be replaced. +- f) Trigger-Data AVP containing data to be sent to the MTC device with the trigger by the MTC-IWF in the Payload AVP, priority of the trigger in the Priority-Indication AVP and the triggering application addressed in the device indicated in the Application-Port-Identifier AVP. +- g) Validity-Time AVP, indicating the validity time of the device trigger request since the time the device action request has been received by the MTC-IWF. + +After the MTC-IWF has received from the SCS a Device-Action-Request command with device action set to Device Trigger Replace (4), after receiving the Device-Trigger-Answer from SMS-SC the MTC-IWF shall confirm the status of a Device Trigger Replace Request to the SCS by sending a Device-Action-Answer command and shall include the following AVP values within the Device-Notification AVP: + +- a) Action-Type AVP set to the value Device Trigger Replace (4). +- b) Reference-Number AVP, containing the reference number received from the SCS for the specific action request. +- c) Old-Reference-Number AVP, containing the reference number previously received from the SCS for the trigger to be replaced. +- d) Request-Status AVP set to value indicating the status of the device trigger replace requested by the SCS. + +The MTC-IWF may also include the following AVP within the Device-Notification AVP: + +- a) Either MSISDN AVP or External-Id AVP set to the identifier of the MTC device to be triggered. +- b) SCS-Identity AVP, containing the identity of the SCS that requested a device trigger replace to the UE. + +The MTC-IWF may then release the "old" reference number previously received from the SCS if the trigger to be replaced is indicated as successfully replaced. + +If the MTC-IWF concludes that it needs to abort the device trigger replace, it shall indicate the unsuccessful outcome with the Request-Status AVP and may release the reference number received from the SCS for the requested trigger replace action, except for the status codes: ORIGINALMESSAGESENT. + +If the Request-Status indicates either " REPLACEFAIL " or " ORIGINALMESSAGESENT " and MTC error diagnostic is provided by the SMS-SC to the MTC-IWF, the MTC-IWF shall forward the MTC error diagnostic to the SCS. + +## 5.9 Delivery of a MSISDN-less MO-SMS + +If the MTC-IWF supports the "MSISDN-less MO-SMS Delivery" feature and receives an MSISDN-less MO-SMS via T4, the MTC-IWF will use the IMSI of the UE and application port ID received over T4 to query the HSS/HLR for an external ID, and the MTC-IWF shall then notify the SCS identified with the destination SME address (long/short code of the SCS/AS) received on the T4 interface by sending a Device-Notification-Request command to the SCS with the following AVPs in the Device-Notification AVP: + +- a) Action-Type AVP set to the value "MSISDN-less MO-SMS Delivery (5)". +- b) SM-RP-UI AVP containing the short message transfer protocol data unit as received on the T4 interface. +- c) Application-Port-Identifier AVP containing the Application Port as received on the T4 interface, and +- d) External-Id AVP set to the identifier of the UE that send the SMS, as received from the HSS/HLR. + +The SCS shall acknowledge the receipt of the Device-Notification-Request command by sending to the MTC-IWF a Device-Notification-Answer command. + +# 6 Tsp protocol + +## 6.1 Protocol support + +### 6.1.1 Use of Diameter base protocol + +The Diameter Base Protocol as specified in IETF RFC 6733 [18] shall apply except as modified by the defined support of the methods and the defined support of the commands and AVPs, result and error codes as specified in this specification. Unless otherwise specified, the procedures specified in IETF RFC 6733 [18] (including error handling and unrecognised information handling) shall be used unmodified. Only commands related to peer-to-peer connection are re-used from the Diameter Base Protocol, i.e. Capabilities-Exchange-Request (CER), Capabilities-Exchange-Answer (CEA), Disconnect-Peer-Request (DPR), Disconnect-Peer-Answer (DPA), Device-Watchdog-Request (DWR) and Device-Watchdog-Answer (DWA). + +With regards to the Diameter protocol defined over the Tsp interface, the MTC-IWF acts as the Diameter server, in the sense that it is the network element that handles action requests and sends notifications for a particular realm. The SCS acts as the Diameter client, in the sense that it is the network element requesting actions and handles notification from the MTC-IWF. + +A Diameter routing table entry can have a different destination based on the application identifier of the command. The application identifier stored in the command header must match the value of any application identifier AVPs in the command body. Diameter agents (relay, proxy, redirection, translation agents) should use the application identifier in the command header to route to a suitable destination. + +### 6.1.2 Transport protocol + +Diameter messages over the Tsp interface shall make use of SCTP IETF RFC 4960 [8] or TCP IETF RFC 791 [4]. + +### 6.1.3 Advertising Application Support + +The Diameter application identifier assigned to the Tsp interface application is 16777309. + +The SCS and MTC-IWF shall advertise support of the Diameter Tsp application by including the value of the Tsp application identifier in the Auth-Application-Id AVP within the Vendor-Specific-Application-Id grouped AVP of the CER and CEA commands. + +The vendor identifier value of 3GPP (10415) shall be included in the Supported-Vendor-Id AVP of the CER and CEA commands, and in the Vendor-Id AVP within the Vendor-Specific-Application-Id grouped AVP of the CER and CEA commands. + +The Vendor-Id AVP included in CER and CEA commands that is not included in the Vendor-Specific-Application-Id AVPs as described above shall indicate the manufacturer of the Diameter node as per IETF RFC 6733 [18]. + +## 6.2 Initialization and maintenance of connection and session + +A Tsp peer-to-peer connection is a connection between SCS and MTC-IWF. It has no associated meaning beyond this link - i.e. it has no meaning between communication endpoints such as MTC applications and the UEs. A Tsp peer-to-peer connection may carry commands associated with multiple MTC applications and/or multiple UEs. + +A Tsp Diameter session shall consist of a single request and answer pair. The Tsp Diameter session is terminated after each request and answer pair interaction, i.e. the Tsp Diameter session shall not keep the session state. In order to indicate that the session state is not to be maintained, the Diameter client and server shall include the Auth-Session-State AVP with the value set to NO\_STATE\_MAINTAINED (1), in the request and in the answer messages (see IETF RFC 6733 [18]). + +Communications between UE and MTC application may span multiple Tsp Diameter sessions. + +## 6.3 Security on the Tsp interface + +### 6.3.1 General + +The Diameter security mechanisms as specified in IETF RFC 6733 [18] shall apply to the Tsp reference point unless explicitly stated otherwise. + +NOTE: The use of Diameter is based on IETF RFC 3588 [6] in pre Release-14. Nevertheless, the security mechanism defined for the Tsp reference point rather aligns with the security mechanism in IETF RFC 6733 [18]. The only difference to the security in IETF RFC 6733 [18] is that the support for DTLS is made conditional on the support of SCTP. + +### 6.3.2 Mutual authentication + +The present document covers only Tsp interface security procedures for deployments where a DIAMETER message on the Tsp interface between MTC-IWF and SCS shall pass through at most one DIAMETER agent in the security domain, in which the MTC-IWF resides (called 'MTC-IWF-side agent' in the sequel), and one DIAMETER agent in the security domain, in which the SCS resides (called 'SCS-side agent' in the sequel). + +NOTE 1: Other deployments are possible, but they are not recommended for the purposes of the Tsp interface. + +Mutual authentication between a node in the security domain, in which the MTC-IWF resides, and a node in the security domain, in which the SCS resides, shall be performed using TLS or IPsec as specified in IETF RFC 6733 [18], with the exception that the security profiles specified in clause 6.3.3 of the present document shall apply. + +The following rules shall apply: + +- There shall be no intermediate DIAMETER agent in a third security domain between the security domain of the MTC-IWF and the security domain of the SCS. +- In the security domain of the MTC-IWF, the node performing the Tsp-related mutual authentication shall be the MTC-IWF-side agent, if present, and the MTC-IWF otherwise. +- In the security domain of the SCS, the node performing the Tsp-related mutual authentication shall be the SCS-side agent, if present, and the SCS otherwise. +- The peers shall verify the peer identity received in CER/CEA messages against the identity (e.g. name in the certificate) authenticated by means of TLS or IPsec. +- Domain authorization check: a suitable node in the security domain receiving a Tsp-related DIAMETER message shall check that the originator of this message, i.e the SCS (or MTC-IWF respectively), as identified at the application layer, is indeed authorized to send this message via the peer whose identity was verified in the previous step. This check may be performed through suitable local tables associating SCSs (or MTC-IWFs respectively) with nodes in the originating security domain whose identities can be verified by the receiving domain. The node performing this domain authorization check shall be either the MTC-IWF or the MTC-IWF-side agent for messages destined to the MTC-IWF and either the SCS or the SCS-side agent for messages destined to the SCS. + +NOTE 2: The MTC-IWF can perform the domain authorization check even in the presence of an MTC-IWF-side agent as the latter includes the verified peer identity in the Route-Record AVP. (Analogously for the SCS-side) The concept of domain authorization check is defined by the bullet above and not taken from another normative document. + +- The MTC-IWF-side agent (the SCS-side agent respectively) shall perform egress filtering in that it only forwards (Tsp-related) DIAMETER messages originating from MTC-IWFs (SCSs respectively) in its own security domain. + +### 6.3.3 Security profiles + +The support of TLS on Tsp is mandatory. The support of IKE/IPsec is optional. If SCTP is supported, then DTLS shall be supported. + +Security profiles for IKE, IPsec, and TLS shall be according to the following provisions: + +- The profile for TLS implementation and usage shall follow the provisions given in TS 33.310 [11], Annex E. The mutual authentication shall be based on certificates according to the profiles given in TS 33.310 [11], clauses 6.1.3a and 6.1.4a. The structure of the PKI used for these certificates is out of scope of the present document, thus the provisions in these clauses on issuers of the certificates do not apply. +- If IKE/IPsec is supported then the implementation of IKEv2 is mandatory with mutual authentication based on certificates according to the profile given in TS 33.310 [11]. The certificate profiles shall follow TS 33.310 [11], clauses 6.1.3 and 6.1.4. The structure of the PKI used for these certificates is out of scope of the present document, thus the provisions in these clauses on issuers of the certificates do not apply. +- If IKE/IPsec is supported then IPsec ESP shall be implemented according to the profile in TS 33.210 [10]. Tunnel mode is mandatory to support. Transport mode is optional to support. + +The security profile for DTLS is defined in TS 33.310 [11], Annex E. + +## 6.4 Tsp specific AVPs + +### 6.4.1 General + +Table 6.4.1.1 describes the Diameter AVPs defined for the Tsp reference point, their AVP Code values, types and possible flag values. The Vendor-Id header of all AVPs defined in the present document shall be set to 3GPP (10415). For all AVPs which contain bit masks and are of the type Unsigned32, bit 0 shall be the least significant bit. For example, to get the value of bit 0, a bit mask of 0x0001 should be used. + +**Table 6.4.1.1: Tsp specific Diameter AVPs** + +| Attribute Name | AVP Code | Clause defined | Value Type | AVP Flag rules (Note 1) | | | | Applicability (Note 2) | +|---------------------------------------|----------|----------------|-------------|-------------------------|-----|------------|----------|-------------------------------| +| | | | | Must | May | Should not | Must not | | +| Device-Action | 3001 | 6.4.2 | Grouped | M,V | P | | | | +| Device-Notification | 3002 | 6.4.3 | Grouped | M,V | P | | | | +| Trigger-Data | 3003 | 6.4.4 | Grouped | M,V | P | | | | +| Payload | 3004 | 6.4.5 | OctetString | M,V | P | | | | +| Action-Type | 3005 | 6.4.6 | Enumerated | M,V | P | | | | +| Priority-Indication | 3006 | 6.4.7 | Enumerated | M,V | P | | | | +| Reference-Number | 3007 | 6.4.8 | Unsigned32 | M,V | P | | | | +| Request-Status | 3008 | 6.4.9 | Enumerated | M,V | P | | | | +| Delivery-Outcome | 3009 | 6.4.10 | Enumerated | M,V | P | | | | +| Application-Port-Identifier | 3010 | 6.4.11 | Unsigned32 | M,V | P | | | | +| Old-Reference-Number | 3011 | 6.4.12 | Unsigned32 | V | P | | M | Device-Trigger-Recall-Replace | +| Feature-Supported-In-Final-Target AVP | 3012 | 6.4.13 | Unsigned32 | V | P | | M | Device-Trigger-Recall-Replace | + +NOTE 1: The AVP header bit denoted as 'M', indicates whether support of the AVP is required. The AVP header bit denoted as 'V', indicates whether the optional Vendor-ID field is present in the AVP header. For further details, see IETF RFC 6733 [18]. + +NOTE 2: AVPs marked with a supported feature (e.g. "Device-Trigger-Recall-Replace") are applicable as described in clause 6.4.12. + +### 6.4.2 Device-Action AVP + +The Device-Action AVP (AVP code 3001) is of type Grouped. It is used by the SCS to request a specific action for a device. + +AVP Format: + +``` + +Device-Action ::= < AVP Header: 3001 > + [ External-Id ] + [ MSISDN ] + [ SCS-Identity ] + +``` + +``` +{ Reference-Number } +[ Old-Reference-Number ] +{ Action-Type } +[ Trigger-Data ] +[ Validity-Time ] +*[ AVP ] +``` + +### 6.4.3 Device-Notification AVP + +The Device-Notification AVP (AVP code 3002) is of type Grouped. It is used by the MTC-IWF to report any action requested by the SCS. + +AVP Format: + +``` +Device-Notification ::= < AVP Header: 3002 > +[ External-Id ] +[ MSISDN ] +[ SCS-Identity ] +{ Reference-Number } +{ Action-Type } +[ Request-Status ] +[ MTC-Error-Diagnostic ] +[ Delivery-Outcome ] +[ SM-RP-UI ] +[ Application-Port-Identifier ] +*[ AVP ] +``` + +### 6.4.4 Trigger-Data AVP + +The Trigger-Data AVP (AVP code 3003) is of type Grouped. It is used by the SCS to supply all data required for a device trigger request. + +AVP Format: + +``` +Trigger-Data ::= < AVP Header: 3003 > +{ Payload } +[ Priority-Indication ] +[ Application-Port-Identifier ] +*[ AVP ] +``` + +### 6.4.5 Payload AVP + +The Payload AVP (AVP code 3004) is of type OctetString, and contains the payload to be transferred to the addressed device. + +### 6.4.6 Action-Type AVP + +The Action-Type AVP (AVP code 3005) is of type Enumerated, and informs the MTC-IWF of what action type is required in the request and also informs the SCS of what action type is reported. + +The following values are defined: + +#### Device Trigger Request (1) + +This value indicates a device trigger request and is used: + +- in the Device-Action AVP of the Device-Action-Request command; +- in the Device-Notification AVP of the Device-Action-Answer command. + +#### Delivery Report (2) + +This value indicates a delivery report sent from MTC-IWF to the SCS and is used: + +- in the Device-Notification AVP of the Device-Notification-Request command. + +#### Device Trigger Recall (3) + +This value indicates a device trigger recall request and is used: + +- in the Device-Action AVP of the Device-Action-Request command; +- in the Device-Notification AVP of the Device-Action-Answer command. + +#### Device Trigger Replace (4) + +This value indicates a device trigger replace request and is used: + +- in the Device-Action AVP of the Device-Action-Request command; +- in the Device-Notification AVP of the Device-Action-Answer command. + +#### MSISDN-less MO-SMS Delivery (5) + +This value indicates the delivery of an MSISDN-less MO-SMS and is used in the Device-Notification AVP of the Device-Notification-Request command. + +### 6.4.7 Priority-Indication AVP + +The Priority-Indication (AVP code 3006) is of type Enumerated, and identifies priority of the device trigger. + +The following values are defined: + +#### Non-Priority (0) + +This value indicates that the device trigger has non-priority. + +#### Priority (1) + +This value indicates that the device trigger has priority. + +### 6.4.8 Reference-Number AVP + +Reference-Number AVP (AVP code 3007) is of type Unsigned32, and is used to uniquely identify a transaction. The reference number is allocated by the initiator of a transaction and is used in all subsequent messages related to that transaction. + +### 6.4.9 Request-Status AVP + +The Request-Status AVP (AVP code 3008) is of type Enumerated, and informs the SCS of the status of a device action request. It can include the result of MTC-IWF checks, the HSS/HLR interrogation and the SMS-SC submission trigger. The Request-Status AVP can be included in the Device-Action-Answer command. + +The following values are defined: + +#### SUCCESS (0) + +This value indicates that device action requested is confirmed. + +#### TEMPORARYERROR (201) + +This value indicates any unspecified temporary errors. + +#### INVPAYLOAD (101) + +This value indicates an error with the payload, where the payload is valid according to Diameter AVP definition but an implementation limit such as maximum accepted length is exceeded. + +#### INVENTID (102) + +This value indicates an error with the External Identifier, where the identifier is valid according to Diameter AVP definition but the value is rejected by the 3GPP network for example because it is an unknown subscription. The result code specified in TS 29.336 [12], clause 6.3.3.1 shall be mapped to this value. + +#### INVSCSID (103) + +This value indicates an error with the SCS identity, where the identity is valid according to Diameter AVP definition but the value is rejected by the 3GPP network for example because it is an unexpected value for this SCS. + +#### INVPERIOD (104) + +This value indicates an error with the validity period, where the validity period is valid according to Diameter AVP definition but the value is rejected by the 3GPP network for example because a maximum allowed validity period is exceeded. + +#### NOTAUTHORIZED (105) + +This value indicates that the SCS is not authorized to perform the action requested for this UE. The result code specified in TS 29.336 [12], clause 6.3.3.2 shall be mapped to this value. + +#### SERVICEUNAVAILABLE (106) + +This value indicates that the trigger service is not available for this UE. The result code specified in TS 29.336 [12], clause 6.3.3.3 shall be mapped to this value. + +#### PERMANENTERROR (107) + +This value indicates a permanent error. Any result code specified in TS 29.337 [17], clause 7.3 shall be mapped to this value unless otherwise specified in this specification. + +#### QUOTAEXCEEDED (108) + +This value indicates that the SCS has exceeded allocated quota. + +#### RATEEXCEEDED (109) + +This value indicates that the rate at which the SCS is initiating Tsp requests has been exceeded. + +#### REPLACEFAIL (110) + +This value indicates that the device trigger replace request has failed to replace the device trigger indicated by the Old-Reference-Number in the SMS-SC for other reasons than ORIGINALMESSAGESSENT i.e. message could not be replaced and new message could not be stored as a new message. The result code DIAMETER\_ERROR\_TRIGGER\_REPLACE\_FAILURE specified in TS 29.337 [17], clause 7.3.5 shall be mapped to this value. + +#### RECALLFAIL (111) + +This value indicates that the device trigger recall request has failed for other reasons than ORIGINALMESSAGESSENT. The result code DIAMETER\_TRIGGER\_RECALL\_FAILURE specified in TS 29.337 [17], clause 7.3.6 shall be mapped to this value. + +#### ORIGINALMESSAGESSENT (112) + +This value indicates that the message which was intended to be recalled or replaced has already been sent. The result code DIAMETER\_ERROR\_ORIGINAL\_MESSAGE\_NOT\_PENDING specified in TS 29.337 [17], clause 7.3.7 shall be mapped to this value. + +### 6.4.10 Delivery-Outcome AVP + +The Delivery-Outcome AVP (AVP code 3009) is of type Enumerated, and informs the SCS of the outcome of the device action request. The Delivery-Outcome AVP can be included in Device-Notification-Request command. + +The following values are defined: + +#### SUCCESS (0) + +This value indicates that the device action request was successfully completed. The value SUCCESSFUL\_TRANSFER specified in TS 29.337 [17], clause 6.3.1 shall be mapped to this value. + +#### EXPIRED (1) + +This value indicates that the validity period expired before the trigger could be delivered. The value VALIDITY\_TIME\_EXPIRED specified in TS 29.337 [17], clause 6.3.1 shall be mapped to this value. (Temporary error) + +#### TEMPORARYERROR (2) + +This value indicates that this trigger encountered a temporary network error. + +#### UNDELIVERABLE (3) + +This value indicates that this trigger encountered a delivery error and is deemed permanently undeliverable. The values ABSENT\_SUBSCRIBER and UE\_MEMORY\_CAPACITY\_EXCEEDED specified in TS 29.337 [17], clause 6.3.1 shall be mapped to this value. + +#### UNCONFIRMED (4) + +This value indicates that the delivery of the device action request is not confirmed. + +NOTE: The Absent-Subscriber-Diagnostic-T4 AVP specified in TS 29.337 [17], clause 6.3.2 is connected with the ABSENT\_SUBSCRIBER value in the SM-Delivery-Outcome-T4 AVP. The Absent-Subscriber-Diagnostic-T4 AVP values will not be forwarded via the Tsp interface. + +### 6.4.11 Application-Port-Identifier AVP + +The Application-Port-Identifier AVP (AVP code 3010) is of type Unsigned32 and is used to uniquely identify the triggering application addressed in the device, see clause 9.2.3.24.4 in TS 23.040 [15] for further details. + +### 6.4.12 Old-Reference-Number AVP + +Old-Reference-Number AVP (AVP code 3011) is of type Unsigned32, and is used to uniquely identify a transaction which is intended to be replaced. + +### 6.4.13 Feature-Supported-In-Final-Target AVP + +Feature-Supported-In-Final-Target AVP (AVP code 3012) is of type Unsigned32 and contains a bitmask, and is used to indicate the features supported in target node. This AVP shall be present if any of the features are supported. + +**Table 6.4.13.1: Features supported by final target node** + +| Feature bit (Note 1) | Remote target Feature (Note 2) | Description (Note 3) | Applicability (Note 4) | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------| +| 0 | Device-Trigger-Recall-Replace supported in SMS-SC | This Feature indicates the support of the applicability to support the functionality for device trigger recall and device trigger replace by the SMS-SC
This Feature is applicable for the DAA command.
If an SMS-SC does not indicate the support of the feature the SCS shall not send device trigger recall requests to an MTC-IWF and SCS shall treat the device trigger replace as a new device trigger. | Device-Trigger-Recall-Replace | +| Note 1: Feature bit: The order number of the bit within the Feature-Supported-In-Final-Target AVP, e.g. "1". | | | | +| Note 2: Remote target feature: A short name that can be used to refer to the bit and to the feature in the target node, e.g. "Device-Trigger-Recall-Replace". | | | | +| Note 3: Description: A clear textual description of the feature. | | | | +| Note 4: Applicability: Bits marked with a supported feature (e.g. "Device-Trigger-Recall-Replace") are applicable as described in clause 6.4.12. | | | | + +## 6.5 Tsp re-used AVPs + +### 6.5.1 General + +Table 6.5.1.1 lists the Diameter AVPs re-used by the Tsp reference point from existing Diameter Applications, reference to their respective specifications and a short description of their usage within the Tsp reference point. Other AVPs from existing Diameter Applications, except for the AVPs from Diameter base protocol, do not need to be supported. The AVPs from Diameter base protocol are not included in table 6.5.1.1, but they are re-used for the Tsp reference point. Unless otherwise stated, re-used AVPs shall maintain their 'M', 'P' and 'V' flag settings. For all AVPs which contain bit masks and are of the type Unsigned32, bit 0 shall be the least significant bit. For example, to get the value of bit 0, a bit mask of 0x0001 should be used. + +**Table 6.5.1.1: Tsp re-used Diameter AVPs** + +| Attribute Name | Reference | Description | Applicability (Note 1) | +|----------------------|--------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------| +| MSISDN | TS 29.329 [3] | MSISDN of the device. | | +| External-Id | TS 29.336 [12] | External identifier has the form username@realm. | | +| SCS-Identity | TS 29.336 [12] | This Information Element shall contain the identity of the Service Capability Server that is requesting a device trigger to the UE. | | +| Validity-Time | IETF RFC 4006 [7] | The validity time in seconds for the specific action requested. | | +| Supported-Features | TS 29.229 [16] | If present, this AVP informs the destination host about the features that the origin host requires to successfully complete this command exchange. | | +| MTC-Error-Diagnostic | TS 29.337 [17] | If present, this AVP provides additional information about the failure occurred in the SMS-SC. | | +| Load | IETF RFC 8583 [19] | The AVP used to convey load information between Diameter nodes. This AVP and all AVPs within this grouped AVP shall have the 'M' bit cleared. | | +| SM-RP-UI | TS 29.338 [20] | This information element shall contain the short message transfer protocol data unit. | MSISDN-less MO-SMS Delivery | + +NOTE 1: AVPs marked with a supported feature are applicable as described in clause 6.4.12. + +### 6.5.2 Supported-Feature-List AVP + +#### 6.5.2.1 Use of the Supported-Features AVP + +When new functionality is introduced on the Tsp reference point, it should be defined as optional. If backwards incompatible changes cannot be avoided, the new functionality shall be introduced as a new feature and support advertised with the Supported-Features AVP. Unless otherwise stated, the use of the Supported-Features AVP on the Tsp reference point shall be compliant to the usage of the Supported-Features AVP on the Cx reference point and consistent with the procedures for the dynamic discovery of supported features as defined in clause 7.2 of TS 29.229 [16]. + +When extending the application by adding new AVPs for a feature, the new AVPs shall have the M bit cleared and the AVP shall not be defined mandatory in the command ABNF. + +As defined in TS 29.229 [16], the Supported-Features AVP is of type grouped and contains the Vendor-Id, Feature-List-ID and Feature-List AVPs. On all reference points as specified in this specification, the Supported-Features AVP is used to identify features that have been defined by 3GPP and hence, for features defined in this document, the Vendor-Id AVP shall contain the vendor ID of 3GPP (10415). If there are multiple feature lists defined for the reference point, the Feature-List-ID AVP shall differentiate those lists from one another. + +The Supported-Features AVP shall be included in every DAR and DAA command if supported by the SCS and MTC-IWF respectively. + +If the SCS supports post-Rel-12 Tsp functionality, the DAR shall include the features supported by the SCS within Supported-Features AVP(s) with the 'M' bit cleared. + +The Table 6.5.2.2/1 defines the features applicable to the Tsp reference point for the feature list with a Feature-List-ID of 1. + +#### 6.5.2.2 Supported-Feature-List AVP for the Tsp application + +The syntax of this AVP is defined in TS 29.229 [16]. + +For the Tsp application, the meaning of the bits shall be as defined in table 6.5.2.2/1 for the Supported-Feature-List-ID of 1. + +**Table 6.5.2.2/1: Features of Feature-List-ID 1 used in Tsp** + +| Feature bit | Feature | M/O | Description | +|-------------|-------------------------------|-----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | Device-Trigger-Recall-Replace | O | This Feature indicates the support of the applicability to support the functionality for device trigger recall and device trigger replace.
This Feature is applicable for the DAR/DAA command pair.
If an MTC-IWF or SCS does not indicate the support of the feature the SCS shall not send device trigger recall requests to an MTC-IWF and SCS shall treat the device trigger replace as a new device trigger. | +| 1 | MSISDN-less MO-SMS Delivery | O | This Feature indicates the support of the functionality for the delivery of a MSISDN-less MO-SMS.
This Feature is applicable for the DNR/DNA command pair. | + +Feature bit: The order number of the bit within the Supported-Features AVP, e.g. "1". +Feature: A short name that can be used to refer to the bit and to the feature, e.g. "Device-Trigger-Recall-Replace". +M/O: Defines if the implementation of the feature is mandatory ("M") or optional ("O"). +Description: A clear textual description of the feature. + +## 6.6 Tsp Messages + +### 6.6.1 Command-Code Values + +This section defines the Command-Code values for the Tsp interface application as allocated by IANA from the vendor-specific namespace defined in IETF RFC 5719 [9]. Every command is defined by means of the ABNF syntax IETF RFC 2234 [5], according to the rules in IETF RFC 6733 [18]. + +The following Command Codes are defined in this specification: + +**Table 6.6.1.1: Command-Code values for Tsp** + +| Command-Name | Abbreviation | Code | Section | +|-----------------------------|--------------|---------|---------| +| Device-Action-Request | DAR | 8388639 | 6. 6.2 | +| Device-Action-Answer | DAA | 8388639 | 6. 6.3 | +| Device-Notification-Request | DNR | 8388640 | 6. 6.4 | +| Device-Notification-Answer | DNA | 8388640 | 6. 6.5 | + +For the commands defined in this specification and reused commands, the Application-ID field shall be set to 16777309. + +### 6.6.2 Device-Action-Request (DAR) command + +The DAR command, indicated by the Command-Code field set to 8388639 and the 'R' bit set in the Command Flags field, is sent by the SCS to the MTC-IWF as part of the device action request procedure. + +Message Format: + +``` + ::= + < Session-Id > + { Auth-Application-Id } + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } +``` + +``` +{ Destination-Realm } +[ Destination-Host ] +[ Origin-State-Id ] +[ Device-Action ] +*[ Proxy-Info ] +*[ Route-Record ] +*[ Supported-Features ] +*[ AVP ] +``` + +### 6.6.3 Device-Action-Answer (DAA) command + +The DAA command, indicated by the Command-Code field set to 8388639 and the 'R' bit cleared in the Command Flags field, is sent by the MTC-IWF to the SCS as part of the device action request procedure. + +Message Format: + +``` + ::= < Diameter Header: 8388639, PXY > + < Session-Id > + { Auth-Application-Id } + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ Result-Code ] + [ Experimental-Result ] + [ Error-Message ] + [ Error-Reporting-Host ] + [ Failed-AVP ] + [ Origin-State-Id ] + { Device-Notification } + *[ Redirect-Host ] + [ Redirect-Host-Usage ] + [ Redirect-Max-Cache-Time ] + *[ Proxy-Info ] + *[ Supported-Features ] + [ Feature-Supported-In-Final-Target ] + *[ Load ] + *[ AVP ] +``` + +### 6.6.4 Device-Notification-Request (DNR) command + +The DNR command, indicated by the Command-Code field set to 8388640 and the 'R' bit set in the Command Flags field, is sent by the MTC-IWF to the SCS as part of the device notification report procedure. + +Message Format: + +``` + ::= < Diameter Header: 8388640, REQ, PXY > + < Session-Id > + { Auth-Application-Id } + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + { Destination-Host } + [ Origin-State-Id ] + [ Device-Notification ] + *[ Proxy-Info ] + *[ Route-Record ] + *[ AVP ] +``` + +### 6.6.5 Device-Notification-Answer (DNA) command + +The DNA command, indicated by the Command-Code field set to 8388640 and the 'R' bit cleared in the Command Flags field, is sent by the SCS to the MTC-IWF as part of the device notification report procedure. + +Message Format: + +``` + ::= < Diameter Header: 8388640, PXY > + < Session-Id > + { Auth-Application-Id } + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ Result-Code ] + [ Experimental-Result ] +``` + +``` +[ Origin-State-Id ] +[ Error-Message ] +[ Error-Reporting-Host ] +*[ Redirect-Host ] +[ Redirect-Host-Usage ] +[ Redirect-Max-Cache-Time ] +[ Failed-AVP ] +*[ Proxy-Info ] +*[ AVP ] +``` + +# Annex A (informative): Tsp Message Flows + +## A.1 General + +This Annex illustrates Tsp Message Flows. + +## A.2 Tsp Submission, T4 Delivery + +This sub clause illustrates the Tsp Message Sequence Diagram for trigger submissions over Tsp with subsequent trigger delivery over T4. + +![Sequence diagram showing Tsp Submission and T4 Delivery between UE, SMS-SC, MTC-IWF, and SCS.](6f31cdb576d2f15c35c3f266e5f59211_img.jpg) + +``` +sequenceDiagram + participant SCS + participant MTC-IWF + participant SMS-SC + participant UE + + Note right of SCS: 1. DAR + SCS->>MTC-IWF: 1. DAR + Note left of MTC-IWF: 2. T4 submission + MTC-IWF->>SMS-SC: 2. T4 submission + Note left of SMS-SC: 4. Delivery to UE + SMS-SC->>UE: 4. Delivery to UE + Note right of SMS-SC: 3. DAA + SMS-SC->>SCS: 3. DAA + Note left of MTC-IWF: 5. T4 Report + SMS-SC->>MTC-IWF: 5. T4 Report + Note right of MTC-IWF: 6. DNR + MTC-IWF->>SCS: 6. DNR + Note left of SCS: 7. DNA + SCS->>MTC-IWF: 7. DNA + Note left of MTC-IWF: 8. T4 Report Confirm + MTC-IWF->>SMS-SC: 8. T4 Report Confirm +``` + +The sequence diagram illustrates the interaction between four entities: UE, SMS-SC, MTC-IWF, and SCS. The sequence of messages is as follows: 1. SCS sends a DAR (Device-Action-Request) to MTC-IWF. 2. MTC-IWF sends a T4 submission to SMS-SC. 3. SMS-SC sends a DAA (Device-Action-Answer) to SCS. 4. SMS-SC sends a Delivery to UE. 5. SMS-SC sends a T4 Report to MTC-IWF. 6. MTC-IWF sends a DNR (Device-Notification-Request) to SCS. 7. SCS sends a DNA (Device-Notification-Answer) to MTC-IWF. 8. MTC-IWF sends a T4 Report Confirm to SMS-SC. + +Sequence diagram showing Tsp Submission and T4 Delivery between UE, SMS-SC, MTC-IWF, and SCS. + +**Figure A.2.1: Tsp Submission, T4 Delivery** + +The flow consists of the following operations: + +1. The SCS sends a Device-Action-Request command to the MTC-IWF with the Action-Type AVP set to the Value Device Trigger Request (1) and other AVPs as further specified in sub clause 5.5. +2. The MTC-IWF selects T4 for delivery performs the T4 submission procedures and is informed of the submission outcome. + +3. The MTC-IWF confirms the status of the device trigger request to the SCS by sending a Device-Action-Answer command with the Action-Type AVP set to the Value Device Trigger Request (1) and the Request-Status AVP set to value indicating the status of the device trigger request. Other AVPs as further specified in sub clause 5.5. +4. - 5. The SMS-SC performs delivery procedures and reports the outcome to the MTC-IWF. +6. The MTC-IWF notifies the SCS of the outcome of the device trigger request by sending a Device-Notification-Request command with Action-Type AVP set to the value Delivery Report (2), the Delivery-Outcome AVP set to the proper value. +7. The SCS acknowledges to the MTC-IWF that it has successfully received the outcome of the device trigger request by sending a Device-Notification-Answer command. +8. The MTC-IWF responds back to the SMS-SC that it has successfully transferred the report. + +NOTE: A SMS-SC will repeat the procedure from steps 5 to ensure the Deliver Report is received if a negative confirmation is received. + +## A.3 Tsp failed Submission + +This sub clause illustrates the Tsp Message Sequence Diagram for trigger submissions over Tsp with the trigger submission is rejected. + +![Sequence diagram for Tsp Submission, T4 Delivery. Lifelines: SMS-SC, MTC-IWF, SCS. 1. DAR from SCS to MTC-IWF. 2. Trigger submission rejected (dashed box). 3. DAA from MTC-IWF to SCS.](5132b3a97ac70fe4765c1e07e66b72b3_img.jpg) + +``` +sequenceDiagram + participant SCS + participant MTC-IWF + participant SMS-SC + Note right of MTC-IWF: 2. Trigger submission rejected + SCS->>MTC-IWF: 1. DAR + MTC-IWF->>SCS: 3. DAA +``` + +Sequence diagram for Tsp Submission, T4 Delivery. Lifelines: SMS-SC, MTC-IWF, SCS. 1. DAR from SCS to MTC-IWF. 2. Trigger submission rejected (dashed box). 3. DAA from MTC-IWF to SCS. + +Figure A.3.1: Tsp Submission, T4 Delivery + +The flow consists of the following operations: + +1. The SCS sends a Device-Action-Request command to the MTC-IWF with the Action-Type AVP set to the Value Device Trigger Request (1) and other AVPs as further specified in sub clause 5.5. +2. The MTC-IWF rejects the trigger request or it is informed as part of the T4 submission procedure that the trigger is rejected. Example reject reasons: Unknown subscription, SCS not authorized, Service not authorized for UE, Insufficient resources, QOS exceeded, Insufficient resources. Reject reasons may be temporary or permanent nature. +3. The MTC-IWF informs the SCS of the device trigger request outcome by sending a Device-Action-Answer command with the Action-Type AVP set to the Value Device Trigger Request (1) and the Request-Status AVP set to an appropriate error value indicating the rejection of the device trigger request. Other AVPs as further specified in sub clause 5.5. The device trigger request has reached a final status at this point and the procedure ends here. + +## A.4 Tsp Submission, Failed T4 Delivery + +This sub clause illustrates the Tsp Message Sequence Diagram for trigger submissions over Tsp with subsequent a failed trigger delivery over T4. + +![Sequence diagram showing the interaction between UE, SMS-SC, MTC-IWF, and SCS for Tsp Submission and Failed T4 Delivery. The sequence starts with SCS sending a DAR to MTC-IWF, followed by MTC-IWF sending a T4 submission to SMS-SC. SMS-SC then attempts delivery to UE, which fails. SMS-SC sends a T4 Report to MTC-IWF, which responds with a DNR to SCS. SCS then sends a DNA to MTC-IWF, which responds with a T4 Report Confirm to SMS-SC.](a0739aaf13fa5a632d4faa830f6b2708_img.jpg) + +``` +sequenceDiagram + participant SCS + participant MTC-IWF + participant SMS-SC + participant UE + + Note right of SCS: 1. DAR + SCS->>MTC-IWF: 1. DAR + Note right of MTC-IWF: 2. T4 submission + MTC-IWF->>SMS-SC: 2. T4 submission + Note right of MTC-IWF: 3. DAA + MTC-IWF->>SCS: 3. DAA + Note left of SMS-SC: 4. Delivery to UE failed + Note right of SMS-SC: 5. T4 Report + SMS-SC->>MTC-IWF: 5. T4 Report + Note right of MTC-IWF: 6. DNR + MTC-IWF->>SCS: 6. DNR + Note right of SCS: 7. DNA + SCS->>MTC-IWF: 7. DNA + Note right of MTC-IWF: 8. T4 Report Confirm + MTC-IWF->>SMS-SC: 8. T4 Report Confirm +``` + +Sequence diagram showing the interaction between UE, SMS-SC, MTC-IWF, and SCS for Tsp Submission and Failed T4 Delivery. The sequence starts with SCS sending a DAR to MTC-IWF, followed by MTC-IWF sending a T4 submission to SMS-SC. SMS-SC then attempts delivery to UE, which fails. SMS-SC sends a T4 Report to MTC-IWF, which responds with a DNR to SCS. SCS then sends a DNA to MTC-IWF, which responds with a T4 Report Confirm to SMS-SC. + +Figure A.4.1: Tsp Submission, T4 Delivery + +The flow consists of the following operations: + +1. The SCS sends a Device-Action-Request command to the MTC-IWF with the Action-Type AVP set to the Value Device Trigger Request (1) and other AVPs as further specified in sub clause 5.5. +2. The MTC-IWF selects T4 for delivery performs the T4 submission procedures and is informed of a positive submission outcome. +3. The MTC-IWF confirms the status of the device trigger request to the SCS by sending a Device-Action-Answer command with the Action-Type AVP set to the Value Device Trigger Request (1) and the Request-Status AVP set to value indicating the SUCCESS status of the device trigger request. Other AVPs as further specified in sub clause 5.5. +- 4 - 5. The SMS-SC concludes after one or more retries that the trigger is not deliverable to the UE (i.e trigger validity period exceeded, persistent error received from HSS, UE or network) and reports the outcome to the MTC-IWF. + +6. The MTC-IWF notifies the SCS of the negative outcome of the device trigger request by sending a Device-Notification-Request command with Action-Type AVP set to the value Delivery Report (2), the Delivery-Outcome AVP set to the appropriate error value. Delivery errors may be of temporary or permanent nature. +7. The SCS acknowledges to the MTC-IWF that is has received the out come of the device trigger request by sending a Device-Notification-Answer command. +8. The MTC-IWF responds back to the SMS-SC that is has successfully transferred the report. + +NOTE: A SMS-SC will repeat the procedure from steps 5 to ensure the Deliver Report is received if a negative confirmation is received. + +## A.5 Tsp Recall Submission, Recall Success + +This clause illustrates the message signalling flow for trigger recall submissions over Tsp with recall success over T4. + +![Sequence diagram for Tsp Recall Submission, Recall Success. Lifelines: UE, SMS-SC, MTC-IWF, SCS. 1. SCS sends Device-Action-Request to MTC-IWF (Action Type = Device trigger recall). 2. MTC-IWF sends T4 recall success to SMS-SC. 3. MTC-IWF sends Device-Action-Answer to SCS (Request Status = RECALLSUCCESS).](20136850feb70fd71c7d41cdae203ebb_img.jpg) + +``` +sequenceDiagram + participant SCS + participant MTC-IWF + participant SMS-SC + participant UE + Note right of SCS: 1. Device-Action-Request + SCS->>MTC-IWF: Device-Action-Request + Note right of MTC-IWF: Action Type = Device trigger recall + Note left of SMS-SC: 2. T4 recall success + MTC-IWF->>SMS-SC: T4 recall success + Note right of MTC-IWF: 3. Device-Action-Answer + MTC-IWF->>SCS: Device-Action-Answer + Note right of MTC-IWF: Request Status = RECALLSUCCESS +``` + +Sequence diagram for Tsp Recall Submission, Recall Success. Lifelines: UE, SMS-SC, MTC-IWF, SCS. 1. SCS sends Device-Action-Request to MTC-IWF (Action Type = Device trigger recall). 2. MTC-IWF sends T4 recall success to SMS-SC. 3. MTC-IWF sends Device-Action-Answer to SCS (Request Status = RECALLSUCCESS). + +Figure A.5.1: Tsp Recall Submission, T4 Recall Success + +The signalling flow consists of the following operations: + +1. The SCS sends a Device-Action-Request command to the MTC-IWF with the Action-Type AVP set to the Value Device Trigger Recall Request (3) and reference-number for the trigger to be recalled and other AVPs as further specified in clause 5.7. +2. The MTC-IWF selects T4 for trigger recall and performs the T4 recall procedures and is informed of the trigger recall outcome. +3. MTC-IWF sends Device-Action-Answer command to SCS with the Action-Type AVP set to the Value Device Trigger Recall Request (3) and the Request-Status AVP set to value indicating SUCCESS. Other AVPs as further specified in clause 5.7. + +## A.6 Tsp Recall Submission, Recall Failure + +This clause illustrates the message signalling flow for trigger recall submissions over Tsp with recall failure over T4. + +![Sequence diagram for Tsp Recall Submission, T4 Recall Failure](2ae3eae1bd80a90f192f568ae246a9a6_img.jpg) + +``` +sequenceDiagram + participant SCS + participant MTC-IWF + participant SMS-SC + participant UE + + Note right of SCS: 1. Device-Action-Request +Action Type = Device trigger recall + SCS->>MTC-IWF: 1. Device-Action-Request + Note left of MTC-IWF: 2. T4 recall failure + Note right of MTC-IWF: 3. Device-Action-Answer + MTC-IWF->>SCS: 3. Device-Action-Answer + Note left of SMS-SC: Delivery of old trigger + Note right of SMS-SC: 4. Delivery report for old trigger + SMS-SC->>MTC-IWF: 4. Delivery report for old trigger +``` + +The diagram illustrates a sequence of interactions between four entities: UE, SMS-SC, MTC-IWF, and SCS. The sequence starts with the SCS sending a '1. Device-Action-Request' to the MTC-IWF, with a note indicating 'Action Type = Device trigger recall'. The MTC-IWF responds with '2. T4 recall failure', shown in a dashed box. The MTC-IWF then sends a '3. Device-Action-Answer' to the SCS. Simultaneously, the SMS-SC performs a 'Delivery of old trigger' to the UE. Finally, the SMS-SC sends a '4. Delivery report for old trigger' to the MTC-IWF. + +Sequence diagram for Tsp Recall Submission, T4 Recall Failure + +**Figure A.6.1: Tsp Recall Submission, T4 Recall Failure** + +The signalling flow consists of the following operations: + +1. The SCS sends a Device-Action-Request command to the MTC-IWF with the Action-Type AVP set to the Value Device Trigger Recall Request (3) and reference-number for the trigger to be recalled and other AVPs as further specified in clause 5.7. +2. The MTC-IWF rejects the trigger recall request or it is informed as a part of the T4 recall procedure that the trigger recall is rejected. +3. MTC-IWF sends Device-Action-Answer command to SCS with the Action-Type AVP set to the Value Device Trigger Recall Request (3) and the Request-Status AVP set to value indicating applicable reason for the recall failure, see clause 6.4.9. Other AVPs as further specified in clause 5.7. +4. The SMS-SC reports the delivery outcome for the original trigger message to the MTC-IWF according to A.2, step 5 to 8 for successful case and A.4, step 5 to 8 for unsuccessful case. + +## A.7 Tsp Replace Submission, Replace Success + +This clause illustrates the message signalling flow for trigger replace submissions over Tsp with replace success over T4. + +![Sequence diagram for Tsp Replace Submission, T4 Replace Success](9c1d3678db4a12d5864cb2a4def1135d_img.jpg) + +``` + +sequenceDiagram + participant UE + participant SMS-SC + participant MTC-IWF + participant SCS + SCS->>MTC-IWF: 1. Device-Action-Request + Note over MTC-IWF: Action Type = Device trigger replace + Note over SMS-SC, MTC-IWF: 2. T4 replace success + MTC-IWF->>SCS: 3. Device-Action-Answer + Note over SCS: Request Status = REPLACESUCCESS + SMS-SC->>UE: 4. Delivery of new trigger to the UE + Note over SMS-SC, MTC-IWF: 5. Delivery report for new trigger + +``` + +Sequence diagram for Tsp Replace Submission, T4 Replace Success + +**Figure A.7.1: Tsp Replace Submission, T4 Replace Success** + +The signalling flow consists of the following operations: + +- The SCS sends a Device-Action-Request command to the MTC-IWF with the Action-Type AVP set to the Value Device Trigger Replace Request (4) and old-reference-number for the trigger to be replaced. The new trigger reference number is assigned by the SCS to the newly submitted trigger message. Other AVPs as further specified in clause 5.8. +- The MTC-IWF selects T4 for trigger replace and performs the T4 replace procedures and is informed of the trigger replace outcome. +- MTC-IWF sends Device-Action-Answer command to SCS with the Action-Type AVP set to the Value Device Trigger Replace Request (4) and the Request-Status AVP set to value indicating SUCCESS. Other AVPs as further specified in clause 5.8. +- The SMS-SC will attempt to deliver the new trigger. This step can happen anytime after step 2. +- The SMS-SC reports the delivery outcome for the new trigger message to the MTC-IWF according to A.2, step 5 to 8 for successful case and A.4, step 5 to 8 for unsuccessful case. + +## A.8 Tsp Replace Submission, Replace Failure + +This clause illustrates the message signalling flow for trigger replace submissions over Tsp with replace failure over T4. + +![Sequence diagram for Tsp Replace Submission, T4 Replace Failure. Lifelines: UE, SMS-SC, MTC-IWF, SCS. The sequence starts with SCS sending a Device-Action-Request to MTC-IWF. MTC-IWF responds with a T4 replace failure (dashed box) and a Device-Action-Answer. SMS-SC then performs delivery of old trigger, followed by a delivery report for old trigger. Finally, SMS-SC performs delivery of new trigger (dashed box) and a delivery report for new trigger (dashed box).](28d75f39a24203712ee907b32cf0bbe5_img.jpg) + +``` + +sequenceDiagram + participant SCS + participant MTC-IWF + participant SMS-SC + participant UE + + Note right of SCS: 1. Device-Action-Request +Action Type = Device trigger replace + SCS->>MTC-IWF: 1. Device-Action-Request + Note right of MTC-IWF: 2. T4 replace failure + MTC-IWF-->>SCS: 3. Device-Action-Answer + Note right of SMS-SC: Delivery of old trigger + SMS-SC->>UE: Delivery of old trigger + Note right of SMS-SC: 4. Delivery report for old trigger + SMS-SC->>MTC-IWF: 4. Delivery report for old trigger + Note right of SMS-SC: 5. Delivery of new trigger + SMS-SC->>UE: 5. Delivery of new trigger + Note right of SMS-SC: 6. Delivery report for new trigger + SMS-SC->>MTC-IWF: 6. Delivery report for new trigger + +``` + +Sequence diagram for Tsp Replace Submission, T4 Replace Failure. Lifelines: UE, SMS-SC, MTC-IWF, SCS. The sequence starts with SCS sending a Device-Action-Request to MTC-IWF. MTC-IWF responds with a T4 replace failure (dashed box) and a Device-Action-Answer. SMS-SC then performs delivery of old trigger, followed by a delivery report for old trigger. Finally, SMS-SC performs delivery of new trigger (dashed box) and a delivery report for new trigger (dashed box). + +**Figure A.8.1: Tsp Replace Submission, T4 Replace Failure** + +The signalling flow consists of the following operations: + +1. The SCS sends a Device-Action-Request command to the MTC-IWF with the Action-Type AVP set to the Value Device Trigger Replace Request (4) and old-reference-number for the trigger to be replaced. Other AVPs as further specified in clause 5.8. +2. The MTC-IWF rejects the trigger replace request or it is informed as a part of the T4 replace procedure that the trigger replace is rejected.3. MTC-IWF sends Device-Action-Answer command to SCS with the Action-Type AVP set to the Value Device Trigger Replace Request (4) and the Request-Status AVP set to value indicating applicable reason for the replace failure, see clause 6.4.9 . Other AVPs as further specified in clause 5.8. +4. The SMS-SC reports the delivery outcome for the original trigger message to the MTC-IWF according to A.2, step 5 to 8 for successful case and A.4, step 5 to 8 for unsuccessful case. Procedures ends if the Request-Status AVP value in step 3 was different from ORIGINALMESSAGESENT (112). +5. If the Request-Status AVP value in step 3 was ORIGINALMESSAGESENT (112), the SMS-SC will attempt to deliver the new trigger. This step can happen anytime after step 2. +6. The SMS-SC reports the delivery outcome for the new trigger message to the MTC-IWF according to A.2, step 5 to 8 for successful case and A.4, step 5 to 8 for unsuccessful case. + +## A.9 Delivery of a MSISDN-less MO-SMS + +This sub clause illustrates the Tsp Message Sequence Diagram for delivery of an MSISDN-less MO-SMS upon reception of such an SMS over T4. + +![Sequence diagram showing the delivery of a MSISDN-less MO-SMS between UE, SMS-SC, MTC-IWF, and SCS.](7d2d1d3870cd224c4430d19334557716_img.jpg) + +``` +sequenceDiagram + participant UE + participant SMS-SC + participant MTC-IWF + participant SCS + + Note left of UE: 1. UE send MSISDN-less SMS + SMS-SC->>MTC-IWF: 2. MO payload delivery Request + Note right of MTC-IWF: 3. HSS/HLR interaction + MTC-IWF->>SCS: 4. DNR + SCS->>MTC-IWF: 5. DNA + MTC-IWF->>SMS-SC: 6. MO payload delivery Response +``` + +The diagram illustrates the message sequence for delivering a MSISDN-less MO-SMS. It involves four main entities: UE (User Equipment), SMS-SC (SMS Service Center), MTC-IWF (MTC Interworking Function), and SCS (SCS). The sequence starts with the UE sending an MSISDN-less SMS to the SMS-SC. The SMS-SC then sends a 'MO payload delivery Request' to the MTC-IWF. The MTC-IWF performs an 'HSS/HLR interaction' to resolve the destination. It then sends a 'DNR' (Device-Notification-Request) to the SCS. The SCS responds with a 'DNA' (Device-Notification-Answer). Finally, the MTC-IWF sends a 'MO payload delivery Response' back to the SMS-SC. + +Sequence diagram showing the delivery of a MSISDN-less MO-SMS between UE, SMS-SC, MTC-IWF, and SCS. + +Figure A.9.1: Delivery of a MSISDN-less MO-SMS + +The flow consists of the following operations: + +1. For small data delivery, an UE without MSISDN sends an SMS that is forwarded to the SMS-SC. +2. The SMS-SC extracts the SMS payload, Application port ID, and IMSI of the UE and delivers them to MTC-IWF via T4 along with the destination SME address. +3. The MTC-IWF uses the IMSI of the UE and application port ID to query the HSS/HLR for external ID. +4. The MTC-IWF notifies the SCS of the received SMS by sending a Device-Notification-Request command with Action-Type AVP set to the value "MSISDN-less MO-SMS Delivery (5)", SM-RP-UI AVP, Application-Port-Identifier AVP, and External-Id AVP s. +5. The SCS acknowledges to the MTC-IWF that is has successfully received the outcome of the device trigger request by sending a Device-Notification-Answer command. +6. The MTC-IWF responds back to the SMS-SC that is has successfully transferred the SMS. + +# Annex B (normative): Diameter load control mechanism + +## B.1 General + +IETF RFC 8583 [19] specifies the Diameter load control mechanism. This includes the definition of Diameter Load AVP and the Diameter load related behaviour. + +The Diameter load control mechanism on the Tsp interface is optional to support for the SCS and the MTC-IWF. + +NOTE: The Diameter Load AVP will simply be ignored by peers not supporting Diameter load control. + +If the SCS and the MTC-IWF support the Diameter load control mechanism, they shall apply the procedures in the present Annex. + +## B.2 SCS behaviour + +The SCS shall act as a reacting node as defined in IETF RFC 8583 [19] and may use the load information in an implementation dependent manner, e.g. when deciding where to route requests for new Diameter sessions. + +## B.3 MTC-IWF behaviour + +The MTC-IWF shall act as endpoint reporting node as defined IETF RFC 8583 [19]. The MTC-IWF shall include load information in the the Load AVP within the Device-Action-Answer messages. + +When and in which frequency to include the Load AVP is implementation dependent and based on operator policy. + +How the MTC-IWF determines the specific contents of the Load-Value AVP within the Load AVP is implementation dependent and based on operator policy. + +# Annex C (informative): Change history + +| Change history | | | | | | | | +|----------------|--------|-----------|------|-----|----------------------------------------------------------------------------------|--------------------------------------------------------------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 2014-03 | CP#63 | CP-140092 | 0010 | 3 | Protocol enhancements for the support of device recall and replace procedure | 11.4.0 | 12.0.0 | +| 2014-03 | CP#63 | CP-140092 | 0011 | 2 | Introduction of device trigger recall/replace functions | 11.4.0 | 12.0.0 | +| 06/2014 | TSG#64 | CP-140392 | 0014 | - | Clarification on bitmask | 12.0.0 | 12.1.0 | +| 06/2014 | TSG#64 | CP-140392 | 0012 | 3 | Corrections to trigger recall and replace procedures | 12.0.0 | 12.1.0 | +| 09/2014 | CT-65 | CP-140540 | 0015 | - | Error handling, MTC error diagnostic | 12.1.0 | 12.2.0 | +| 12/2014 | CT-66 | CP-140897 | 0017 | - | Adding missing security profile for DTLS | 12.2.0 | 12.3.0 | +| 03/2015 | CT-67 | CP-150115 | 0018 | - | Protocol enhancements to indicate support of device recall and replace by SMS-SC | 12.3.0 | 12.4.0 | +| 06/2015 | CT-68 | CP-150343 | 0020 | 1 | SCS-Identity AVP | 12.4.0 | 12.5.0 | +| 06/2015 | CT-68 | CP-150363 | 0021 | 1 | Correction of Route-Record AVP name | 12.5.0 | 13.0.0 | +| 09/2015 | CT-69 | CP-150467 | 0024 | 1 | Usage of Delivery-Outcome AVP on Tsp interface | 13.0.0 | 13.1.0 | +| 09/2015 | CT-69 | CP-150467 | 0027 | 2 | Usage of Request-Status AVP on Tsp interface | 13.0.0 | 13.1.0 | +| Change history | | | | | | | | +| Date | TSG # | TSG Doc. | CR | Rev | Cat | Subject/Comment | New | +| 2016-12 | CT#74 | CP-160615 | 0028 | 1 | F | Correction to DNA messages in informative callflows | 14.0.0 | +| 2016-12 | CT#74 | CP-160615 | 0029 | 1 | B | Small Data delivery using MO SMS over Tsp | 14.0.0 | +| 2016-12 | CT#74 | CP-160615 | 0030 | 2 | F | Diameter base protocol specification update | 14.0.0 | +| 2016-12 | CT#74 | CP-160615 | 0031 | 1 | B | Diameter Load Control Mechanism | 14.0.0 | +| 2017-03 | CT#74 | CP-170076 | 0032 | - | F | Update instance number for the Failed-AVP in answer commands | 14.1.0 | +| 2017-06 | CT#76 | CP-171119 | 0034 | 2 | F | Reference update for draft-ietf-dime-load | 14.2.0 | +| 2017-12 | CT#76 | CP-173097 | 0035 | - | F | Correction for Feature-Supported-In-Final-Target AVP | 14.3.0 | +| 2018-06 | SA#80 | - | - | - | | Update to Rel-15 version (MCC) | 15.0.0 | +| 2019-09 | CT#85 | CP-192154 | 0037 | 1 | A | draft-ietf-dime-load published as RFC 8583 | 15.1.0 | +| 2020-07 | SA#88e | - | - | - | | Update to Rel-16 version (MCC) | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29379/16152cf1d84aea10848758f51a91ff6a_img.jpg b/marked/Rel-16/29_series/29379/16152cf1d84aea10848758f51a91ff6a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..636be46de49e8f446fb8da493f59be360bfa6eeb --- /dev/null +++ b/marked/Rel-16/29_series/29379/16152cf1d84aea10848758f51a91ff6a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:678b97382145ce6b620381419c11b97dbbe5216f1ccb4b9c16224e680b3e089c +size 18161 diff --git a/marked/Rel-16/29_series/29379/18722c46c9e8475524e634dedd08bac2_img.jpg b/marked/Rel-16/29_series/29379/18722c46c9e8475524e634dedd08bac2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f28e8daa2ee5e7073627c4d2163bd56a7602a875 --- /dev/null +++ b/marked/Rel-16/29_series/29379/18722c46c9e8475524e634dedd08bac2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2559a2467657c3ab5b2efb19640be0c8f79dc57220327adc958082d1f7f81ea0 +size 17329 diff --git a/marked/Rel-16/29_series/29379/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-16/29_series/29379/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6ebd801371326cd71505c1e9cb1cc713545498ed --- /dev/null +++ b/marked/Rel-16/29_series/29379/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:657dcd520adf32e692db86a59f427adf42adc57e390f07bcbcf51abd4dd92d0b +size 7626 diff --git a/marked/Rel-16/29_series/29379/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-16/29_series/29379/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b4074eb2148617c3041a7d4a8b585759f3bad9b1 --- /dev/null +++ b/marked/Rel-16/29_series/29379/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:64f0958b56960ec38ba378c80d097d14a8504ab506e76f1b1da9e96f248d390d +size 5809 diff --git a/marked/Rel-16/29_series/29379/66c2bf11a8f117cddf67eff92d4c736c_img.jpg b/marked/Rel-16/29_series/29379/66c2bf11a8f117cddf67eff92d4c736c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e61697bc003526fbb8bce362c4323ce595618dc0 --- /dev/null +++ b/marked/Rel-16/29_series/29379/66c2bf11a8f117cddf67eff92d4c736c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e46670e779cd503d6092591830eeb504a9c15d7467460d47b2d2aec7de4f6664 +size 17618 diff --git a/marked/Rel-16/29_series/29379/7efae06af3af43ffe5d4b956a679cf54_img.jpg b/marked/Rel-16/29_series/29379/7efae06af3af43ffe5d4b956a679cf54_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9887736950e1659c601a19a0ac631b7dd50d9abb --- /dev/null +++ b/marked/Rel-16/29_series/29379/7efae06af3af43ffe5d4b956a679cf54_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f8c254f9559d4735597dcf8e285b15426fee81d864ac4a869d0d70ded1578f33 +size 21548 diff --git a/marked/Rel-16/29_series/29379/9ae17964ddd9b814c7d905b1af2fddf2_img.jpg b/marked/Rel-16/29_series/29379/9ae17964ddd9b814c7d905b1af2fddf2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ca2459a5d3c194d219fe9fec0449750e6d0db099 --- /dev/null +++ b/marked/Rel-16/29_series/29379/9ae17964ddd9b814c7d905b1af2fddf2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:018cd3b28944f5b8be3dcd9439ae2776c77bed76ed448505dfa80fc7580c37cf +size 12636 diff --git a/marked/Rel-16/29_series/29379/a7c51c18111139f9aca2805114108565_img.jpg b/marked/Rel-16/29_series/29379/a7c51c18111139f9aca2805114108565_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3bbcb713a2b212b9d8409f41bd742e3fc9045e2d --- /dev/null +++ b/marked/Rel-16/29_series/29379/a7c51c18111139f9aca2805114108565_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b28816f02de064fc21dea52d10b0fdf43c7ae31474a88d1f4593bdf1ab69dd81 +size 12738 diff --git a/marked/Rel-16/29_series/29379/raw.md b/marked/Rel-16/29_series/29379/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..0cabe7861440c253036ca94ee2d9d6087f407586 --- /dev/null +++ b/marked/Rel-16/29_series/29379/raw.md @@ -0,0 +1,5160 @@ + + +# 3GPP TS 29.379 V16.5.0 (2022-06) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Mission Critical Push To Talk (MCPTT) call control interworking with Land Mobile Radio (LMR) systems; Stage-3 (Release 16)** + +![5G logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The 5G logo, featuring the text "5G" in a bold, black, sans-serif font. Above the "5" and "G" are three green curved lines representing signal waves. + +5G logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, featuring the text "3GPP" in a stylized, bold, black font. The "G" has a red signal wave icon below it. A small "TM" trademark symbol is located to the right of the "P". + +3GPP logo + +A GLOBAL INITIATIVE + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + +--- + + + +## --- ***Copyright Notification*** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|-----------------------------------------------------------------------------------------------------------------------------|----| +| Foreword ..... | 9 | +| 1 Scope..... | 10 | +| 2 References..... | 10 | +| 3 Definitions of terms, symbols and abbreviations..... | 12 | +| 3.1 Terms..... | 12 | +| 3.2 Abbreviations ..... | 12 | +| 4 General..... | 12 | +| 4.1 IWF overview..... | 12 | +| 4.2 Warning Header Field..... | 12 | +| 4.2.1 General ..... | 12 | +| 4.2.2 Warning texts..... | 13 | +| 4.3 MCPTT priority calls and alerts..... | 13 | +| 4.4 Media security at the IWF..... | 13 | +| 4.5 Broadcast group calls ..... | 13 | +| 5 Functional entities ..... | 13 | +| 5.1 General ..... | 13 | +| 5.2 Functional connectivity models ..... | 14 | +| 6 Call control common procedures ..... | 16 | +| 6.1 SDP..... | 16 | +| 6.1.1 SDP offer generation ..... | 16 | +| 6.1.2 SDP answer generation..... | 17 | +| 6.2 Commencement modes ..... | 17 | +| 6.2.1 Automatic commencement mode for private calls..... | 17 | +| 6.2.2 Manual commencement mode for private calls..... | 18 | +| 6.3 Receiving an MCPTT session release request ..... | 18 | +| 6.4 Priority call conditions ..... | 18 | +| 6.4.1 MCPTT emergency group call conditions ..... | 18 | +| 6.4.1.1 SIP INVITE request for originating MCPTT emergency group calls ..... | 18 | +| 6.4.1.2 Resource-Priority header field for MCPTT emergency group calls..... | 19 | +| 6.4.1.3 SIP re-INVITE request for cancelling MCPTT in-progress emergency group state..... | 20 | +| 6.4.1.4 Receiving a SIP 2xx response to a SIP request for a priority call ..... | 20 | +| 6.4.1.5 Receiving a SIP 4xx response, SIP 5xx response or SIP 6xx response to a SIP request for a priority group call ..... | 21 | +| 6.4.1.6 SIP request for originating MCPTT imminent peril group calls ..... | 21 | +| 6.4.1.7 SIP re-INVITE request for cancelling MCPTT in-progress imminent peril group state..... | 22 | +| 6.4.1.8 Resource-Priority header field for MCPTT imminent peril group calls..... | 22 | +| 6.4.1.9 Receiving a SIP INFO request in the dialog of a SIP request for a priority group call..... | 22 | +| 6.4.1.10 SIP re-INVITE request for cancelling the in-progress emergency group state of a group by a third-party ..... | 23 | +| 6.4.1.11 Resource-Priority header field values..... | 24 | +| 6.4.2 MCPTT emergency private call conditions..... | 24 | +| 6.4.2.1 SIP request for originating MCPTT emergency private calls..... | 24 | +| 6.4.2.2 Resource-Priority header field for MCPTT emergency private calls ..... | 24 | +| 6.4.2.3 SIP re-INVITE request for cancelling MCPTT emergency private call state ..... | 25 | +| 6.5 Location information..... | 25 | +| 6.5.1 Location information for location reporting ..... | 25 | +| 6.6 IWF server role procedures ..... | 26 | +| 6.6.1 Distinction of requests sent to the IWF ..... | 26 | +| 6.6.1.1 SIP INVITE request..... | 26 | +| 6.6.1.2 SIP MESSAGE request ..... | 26 | +| 6.6.2 IWF participating role ..... | 27 | +| 6.6.2.1 Requests initiated by a participant homed in the IWF..... | 27 | +| 6.6.2.1.1 SDP offer generation ..... | 27 | + +| | | | +|-------------|--------------------------------------------------------------------------------------------------------------------|----| +| 6.6.2.1.1.1 | On-demand session..... | 27 | +| 6.6.2.1.2 | Sending an INVITE request..... | 28 | +| 6.6.2.1.3 | IWF sending a SIP BYE request..... | 28 | +| 6.6.2.1.4 | Priority call conditions ..... | 29 | +| 6.6.2.1.4.1 | General ..... | 29 | +| 6.6.2.1.4.2 | Determining authorisation for originating a priority group call ..... | 29 | +| 6.6.2.1.4.3 | Determining authorisation for initiating or cancelling an MCPTT emergency alert ..... | 29 | +| 6.6.2.1.4.4 | Validate priority request parameters..... | 30 | +| 6.6.2.1.4.5 | Retrieving Resource-Priority header field values..... | 30 | +| 6.6.2.1.5 | Sending a SIP INVITE request on receipt of SIP 3xx response ..... | 30 | +| 6.6.2.2 | Requests terminated to the IWF..... | 31 | +| 6.6.2.2.1 | SDP offer generation..... | 31 | +| 6.6.2.2.2 | SIP BYE request towards the terminating IWF ..... | 31 | +| 6.6.2.2.2.1 | On-demand ..... | 31 | +| 6.6.3 | IWF controlling role ..... | 31 | +| 6.6.3.1 | Requests initiated by the IWF performing the controlling role ..... | 31 | +| 6.6.3.1.1 | Sending an INVITE request..... | 31 | +| 6.6.3.1.2 | Sending a SIP BYE request..... | 32 | +| 6.6.3.1.3 | Sending a SIP re-INVITE request for MCPTT emergency group call ..... | 32 | +| 6.6.3.1.4 | Sending a SIP INVITE request for MCPTT emergency group call..... | 33 | +| 6.6.3.1.5 | Sending a SIP UPDATE request for Resource-Priority header field correction..... | 34 | +| 6.6.3.1.6 | Generating a SIP re-INVITE request to cancel an in-progress emergency..... | 35 | +| 6.6.3.1.7 | Populate mcptt-info and location-info MIME bodies for emergency alert..... | 35 | +| 6.6.3.1.8 | Authorisations ..... | 35 | +| 6.6.3.1.8.1 | Determining authorisation for initiating an MCPTT emergency alert ..... | 35 | +| 6.6.3.1.8.2 | Determining authorisation for initiating an MCPTT emergency group or private call..... | 36 | +| 6.6.3.1.8.3 | Determining authorisation for cancelling an MCPTT emergency alert ..... | 36 | +| 6.6.3.1.8.4 | Determining authorisation for cancelling an MCPTT emergency group or private call..... | 37 | +| 6.6.3.1.8.5 | Determining authorisation for initiating an MCPTT imminent peril call ..... | 37 | +| 6.6.3.1.8.6 | Determining authorisation for cancelling an MCPTT imminent peril call ..... | 37 | +| 6.6.3.1.8.7 | Sending a SIP OPTIONS request to authorise an MCPTT user at a non-controlling MCPTT function of a MCPTT group..... | 37 | +| 6.6.3.1.9 | Generating a SIP 403 response for priority call request rejection..... | 39 | +| 6.6.3.1.10 | Handling the expiry of timer TNG2 (in-progress emergency group call timer) ..... | 39 | +| 6.6.3.1.11 | Sending a SIP INFO request in the dialog of a SIP request for a priority call..... | 40 | +| 6.6.3.1.12 | Retrieving Resource-Priority header field values ..... | 40 | +| 6.6.3.2 | Requests terminated by the IWF performing the controlling role ..... | 41 | +| 6.6.3.2.1 | Receiving a SIP BYE request..... | 41 | +| 6.6.3.3 | Handling of the acknowledged call setup timer (TNG1)..... | 41 | +| 6.6.3.4 | Generating a SIP NOTIFY request..... | 43 | +| 6.6.3.5 | Handling of the group call timer (TNG3) ..... | 44 | +| 6.6.3.5.1 | General ..... | 44 | +| 6.6.3.5.2 | Interaction with the in-progress emergency group call timer (TNG2)..... | 45 | +| 6.6.4 | IWF non-controlling role..... | 45 | +| 6.6.4.1 | Request initiated by the IWF performing the non-controlling role of a group..... | 45 | +| 6.6.4.1.1 | SDP offer generation ..... | 45 | +| 6.6.4.1.2 | Sending an INVITE request towards the MCPTT client ..... | 45 | +| 6.6.4.1.3 | Sending a SIP INFO request ..... | 46 | +| 6.6.4.1.4 | Sending an INVITE request towards the controlling MCPTT function ..... | 47 | +| 6.6.4.2 | Requests terminated by the non-controlling MCPTT function of an MCPTT group..... | 48 | +| 6.6.4.2.1 | SDP answer generation ..... | 48 | +| 6.6.4.2.2 | Sending a SIP response to the SIP INVITE request..... | 48 | +| 6.6.4.2.2.1 | Sending a SIP 183 (Session Progress) response..... | 48 | +| 6.6.4.2.2.2 | Sending a SIP 200 (OK) response ..... | 49 | +| 6.6.4.3 | Generating a SIP NOTIFY request..... | 49 | +| 6.6.5 | Retrieving and processing a group document..... | 50 | +| 6.6.5.1 | General ..... | 50 | +| 6.6.5.2 | Rules for joining a group session..... | 50 | +| 6.6.5.3 | Determining the group members to invite ..... | 50 | +| 6.6.6 | Error handling..... | 50 | +| 6.6.6.1 | Public service identity does not exist..... | 50 | +| 6.6.7 | Session release policy ..... | 50 | + +| | | | +|------------|-------------------------------------------------------------------------------------------|----| +| 6.6.7.1 | Session release policy for group call ..... | 50 | +| 6.6.7.2 | Session release policy for private call..... | 51 | +| 6.7 | Implicit floor request..... | 51 | +| 6.8 | Confidentiality and Integrity Protection..... | 51 | +| 6.8.1 | General ..... | 51 | +| 6.8.1.1 | Applicability and exclusions..... | 51 | +| 6.8.1.2 | Performing XML content encryption ..... | 51 | +| 6.8.1.3 | Performing integrity protection on an XML body..... | 52 | +| 6.8.1.4 | Keys used in confidentiality protection procedures..... | 52 | +| 6.8.2 | Confidentiality Protection ..... | 52 | +| 6.8.2.1 | Procedures for sending confidentiality protected content..... | 52 | +| 6.8.2.1.1 | IWF performing any role of an MCPTT server ..... | 52 | +| 6.8.2.2 | IWF copying received XML content..... | 52 | +| 6.8.3 | Integrity Protection of XML documents ..... | 53 | +| 6.8.3.1 | Keys used in integrity protection procedures ..... | 53 | +| 6.8.3.2 | Integrity protection at the IWF ..... | 53 | +| 6.9 | Priority sharing..... | 54 | +| 6.10 | Private call parameters ..... | 54 | +| 6.10.1 | Private call parameter check..... | 54 | +| 6.10.2 | Private call parameter response values..... | 54 | +| 7 | Registration and service authorisation ..... | 54 | +| 8 | Pre-established session..... | 54 | +| 9 | Affiliation..... | 55 | +| 9.1 | General ..... | 55 | +| 9.2 | Procedures ..... | 55 | +| 9.2.1 | IWF procedures towards the MCPTT system ..... | 55 | +| 9.2.1.1 | General..... | 55 | +| 9.2.1.2 | Procedures towards the MCPTT system of an IWF serving the user homed in the IWF ..... | 56 | +| 9.2.1.2.1 | General ..... | 56 | +| 9.2.1.2.2 | Stored information..... | 56 | +| 9.2.1.2.3 | Procedure for handling affiliation status change of a user homed in the IWF ..... | 56 | +| 9.2.1.2.4 | Receiving subscription to affiliation status procedure ..... | 58 | +| 9.2.1.2.5 | Sending notification of change of affiliation status procedure ..... | 59 | +| 9.2.1.2.6 | Sending affiliation status change towards MCPTT server owning MCPTT group procedure ..... | 59 | +| 9.2.1.2.7 | Affiliation status determination from MCPTT server owning MCPTT group procedure. .... | 61 | +| 9.2.1.2.8 | Affiliation status determination..... | 63 | +| 9.2.1.2.9 | Affiliation status change by implicit affiliation ..... | 64 | +| 9.2.1.2.10 | Implicit affiliation status change completion..... | 65 | +| 9.2.1.2.11 | Implicit affiliation status change cancellation..... | 66 | +| 9.2.1.2.12 | Automatic affiliation to configured groups procedure ..... | 66 | +| 9.2.1.3 | Procedures of MCPTT server owning the MCPTT group..... | 66 | +| 9.2.1.3.1 | General ..... | 66 | +| 9.2.1.3.2 | Stored information..... | 66 | +| 9.2.1.3.3 | Receiving group affiliation status change procedure ..... | 66 | +| 9.2.1.3.4 | Receiving subscription to affiliation status procedure ..... | 68 | +| 9.2.1.3.5 | Sending notification of change of affiliation status procedure ..... | 69 | +| 9.2.1.3.6 | Implicit affiliation eligibility check procedure..... | 69 | +| 9.2.1.3.7 | Affiliation status change by implicit affiliation procedure ..... | 70 | +| 9.2.1.3.8 | Affiliation eligibility check procedure ..... | 70 | +| 9.2.1.3.9 | Receiving subscription to group dynamic data procedure ..... | 71 | +| 9.2.1.3.10 | Sending notification of change of group dynamic data procedure..... | 71 | +| 10 | Call signalling - group call..... | 72 | +| 10.1 | Prearranged group call ..... | 72 | +| 10.1.2 | Client derived procedures..... | 72 | +| 10.1.2.1 | IWF originating procedures ..... | 72 | +| 10.1.2.2 | IWF performing the participating role terminating procedures..... | 73 | +| 10.1.2.3 | MCPTT upgrade to in-progress emergency or imminent peril..... | 74 | +| 10.1.2.4 | MCPTT in-progress emergency cancel ..... | 75 | +| 10.1.2.5 | MCPTT in-progress imminent peril cancel ..... | 76 | + +| | | | +|------------|--------------------------------------------------------------------------------------------------------------------|-----| +| 10.1.2.6 | Reception of SIP re-INVITE request..... | 77 | +| 10.1.3 | IWF participating role procedures..... | 78 | +| 10.1.3.1 | Originating procedures ..... | 78 | +| 10.1.3.1.1 | On demand prearranged group call..... | 78 | +| 10.1.3.1.2 | Sending of a SIP re-INVITE request towards MCPTT controlling function..... | 79 | +| 10.1.3.2 | Terminating Procedures..... | 80 | +| 10.1.3.3 | IWF participating role ending group call..... | 80 | +| 10.1.3.3.1 | IWF ending group call on-demand..... | 80 | +| 10.1.3.4 | End group call at the IWF performing the participating role ..... | 81 | +| 10.1.3.4.1 | Receipt of SIP BYE request for private call on-demand ..... | 81 | +| 10.1.3.5 | Re-join procedures..... | 81 | +| 10.1.3.5.1 | Originating procedures - on demand prearranged group call..... | 81 | +| 10.1.3.6 | Reception of a SIP re-INVITE request for terminating a priority call ..... | 81 | +| 10.1.4 | IWF Controlling role procedures..... | 81 | +| 10.1.4.1 | Originating Procedures ..... | 81 | +| 10.1.4.1.1 | INVITE targeted to an MCPTT client..... | 81 | +| 10.1.4.1.2 | INVITE targeted to the non-controlling MCPTT function of an MCPTT group ..... | 82 | +| 10.1.4.2 | Terminating Procedures..... | 84 | +| 10.1.4.3 | End group call at the IWF performing the terminating controlling role..... | 92 | +| 10.1.4.4 | End group call initiated by the IWF performing the controlling role ..... | 92 | +| 10.1.4.4.1 | General ..... | 92 | +| 10.1.4.4.2 | SIP BYE request for releasing MCPTT session for a group call ..... | 92 | +| 10.1.4.4.3 | SIP BYE request towards a MCPTT client..... | 92 | +| 10.1.4.5 | Re-join procedures..... | 92 | +| 10.1.4.5.1 | Terminating procedures..... | 92 | +| 10.1.4.6 | Late call entry initiated by IWF performing the controlling role ..... | 93 | +| 10.1.4.7 | Receipt of a SIP re-INVITE request..... | 94 | +| 10.1.4.8 | Handling of a SIP re-INVITE request for imminent peril session ..... | 97 | +| 10.1.5 | Non-controlling role procedures..... | 99 | +| 10.2 | Chat group (restricted) call..... | 99 | +| 10.2.1 | Client derived procedures..... | 99 | +| 10.2.1.1 | On-demand chat group call..... | 99 | +| 10.2.1.1.1 | Procedure for initiating an MCPTT chat group session and procedure for joining an MCPTT chat group session ..... | 99 | +| 10.2.1.1.2 | IWF performing the terminating participating role receives SIP re-INVITE request for an MCPTT chat group..... | 100 | +| 10.2.1.1.3 | MCPTT in-progress emergency cancel..... | 101 | +| 10.2.1.1.4 | MCPTT upgrade to in-progress emergency or imminent peril..... | 102 | +| 10.2.1.1.5 | MCPTT in-progress imminent peril cancel..... | 102 | +| 10.2.1.1.6 | IWF performing the terminating participating role receives a SIP INVITE request for an MCPTT chat group call..... | 103 | +| 10.2.2 | IWF performing the participating role procedures ..... | 104 | +| 10.2.2.1 | On-demand chat group call..... | 104 | +| 10.2.2.1.1 | MCPTT chat session establishment ..... | 104 | +| 10.2.2.1.2 | Sending of a SIP re-INVITE request towards the MCPTT controlling function..... | 105 | +| 10.2.2.1.3 | Reception of a SIP INVITE request by an IWF performing the terminating participating role ... | 106 | +| 10.2.2.1.4 | Reception of a SIP re-INVITE request by an IWF performing the terminating participating role..... | 106 | +| 10.2.2.2 | End group call at the originating participating IWF ..... | 107 | +| 10.2.2.2.1 | IWF ending on-demand chat session ..... | 107 | +| 10.2.2.3 | End group call at the terminating participating IWF ..... | 107 | +| 10.2.2.3.1 | Receipt of SIP BYE request for on-demand chat session ..... | 107 | +| 10.2.3 | IWF controlling role procedures ..... | 107 | +| 10.2.3.1 | On-demand chat group call..... | 107 | +| 10.2.3.1.1 | Procedure for establishing an MCPTT chat session and procedure for joining an established MCPTT chat session ..... | 107 | +| 10.2.3.1.2 | Receipt of a SIP re-INVITE request ..... | 111 | +| 10.2.3.1.3 | Handling of a SIP re-INVITE request for imminent peril session..... | 115 | +| 10.2.3.2 | End group call at the terminating IWF performing the controlling role..... | 117 | +| 10.2.3.3 | End group call initiated by the IWF performing the controlling role ..... | 117 | +| 10.2.3.3.1 | General ..... | 117 | +| 10.2.3.3.2 | SIP BYE request for releasing MCPTT session for a group call ..... | 117 | + +| | | | +|------------|-------------------------------------------------------------------------------------------------|-----| +| 10.2.3.3.3 | SIP BYE request towards a MCPTT client..... | 117 | +| 10.2.3.3.4 | Removal of participant homed in the IWF..... | 118 | +| 10.2.4 | Non-controlling role procedures..... | 118 | +| 10.3 | Subscription to the conference event package ..... | 118 | +| 10.4 | Remotely initiated group call..... | 118 | +| 10.4.1 | Participating MCPTT function procedures ..... | 118 | +| 10.4.1.1 | IWF performing the participating role..... | 118 | +| 10.4.1.1.1 | Originating procedures..... | 118 | +| 10.4.1.1.2 | Terminating procedures..... | 118 | +| 10.4.1.2 | IWF performing the controlling role ..... | 118 | +| 11 | Private call call control ..... | 119 | +| 11.1 | Private call with floor control..... | 119 | +| 11.1.1 | Client derived procedures..... | 119 | +| 11.1.1.1 | On-demand private call..... | 119 | +| 11.1.1.1.1 | Originating procedures..... | 119 | +| 11.1.1.1.2 | IWF terminating procedures..... | 120 | +| 11.1.1.1.3 | Terminating procedures for reception of SIP re-INVITE request..... | 121 | +| 11.1.1.1.4 | MCPTT in-progress emergency cancel..... | 122 | +| 11.1.1.1.5 | Upgrade to MCPTT emergency private call ..... | 123 | +| 11.1.2 | IWF participating role procedures..... | 124 | +| 11.1.2.1 | Originating procedures ..... | 124 | +| 11.1.2.1.1 | On-demand private call..... | 124 | +| 11.1.2.1.2 | SIP re-INVITE for MCPTT private call ..... | 124 | +| 11.1.2.2 | Terminating procedures ..... | 125 | +| 11.1.2.3 | Receipt of SIP re-INVITE request by terminating participating function..... | 126 | +| 11.1.3 | IWF controlling role procedures ..... | 126 | +| 11.1.3.1 | Originating procedures ..... | 126 | +| 11.1.3.2 | Terminating procedures ..... | 127 | +| 11.1.3.3 | Receiving a SIP re-INVITE for upgrade to emergency private call..... | 129 | +| 11.1.3.4 | Receiving a SIP re-INVITE for cancellation of emergency private call ..... | 130 | +| 11.1.3.5 | Sending a SIP re-INVITE for upgrade to emergency private call..... | 131 | +| 11.1.3.6 | Sending a SIP re-INVITE for cancellation of emergency private call ..... | 132 | +| 11.2 | Private call without floor control ..... | 133 | +| 11.2.1 | Participating role procedures..... | 133 | +| 11.2.1.1 | Originating procedures ..... | 133 | +| 11.2.1.2 | Terminating procedures ..... | 133 | +| 11.2.2 | Controlling role procedures..... | 133 | +| 11.2.2.1 | Originating procedures ..... | 133 | +| 11.3 | Ending the private call initiated by a client..... | 133 | +| 11.3.1 | IWF performing the participating role procedures ..... | 133 | +| 11.3.1.1 | Terminating procedures ..... | 133 | +| 11.3.1.1.1 | Receipt of SIP BYE request for private call on-demand ..... | 133 | +| 11.4 | Ending the private call initiated by the MCPTT server ..... | 134 | +| 11.4.1 | Client derived procedures..... | 134 | +| 11.4.1.1 | Receiving a SIP BYE request for private call session..... | 134 | +| 11.4.2 | IWF participating role procedures..... | 134 | +| 11.4.2.1 | Terminating procedures ..... | 134 | +| 11.4.2.1.1 | Receipt of SIP BYE request for private call on-demand ..... | 134 | +| 11.4.3 | IWF controlling role procedures ..... | 134 | +| 12 | Emergency alert ..... | 134 | +| 12.1 | IWF performing the participating role procedures..... | 134 | +| 12.1.1 | IWF to send SIP MESSAGE request for emergency notification..... | 134 | +| 12.1.2 | Receipt of a SIP MESSAGE request for emergency notification for terminating LMR user..... | 135 | +| 12.1.3 | Receipt of a SIP MESSAGE request indicating successful delivery of emergency notification ..... | 135 | +| 12.2 | IWF controlling role procedures ..... | 136 | +| 12.2.1 | Handling of a SIP MESSAGE request for emergency notification..... | 136 | +| 12.2.2 | Handling of a SIP MESSAGE request for emergency alert cancellation..... | 137 | +| 13 | Location procedures..... | 141 | +| 13.1 | General ..... | 141 | +| 13.2 | IWF participating role location procedures..... | 141 | + +| | | | +|-----------------------------------------------------------|-------------------------------------------------------------|------------| +| 13.2.1 | General ..... | 141 | +| 13.2.2 | Location reporting configuration..... | 141 | +| 13.2.3 | Location reporting request..... | 141 | +| 13.2.4 | Location information report ..... | 141 | +| 14 | Handling of Interworking Security Data messages..... | 142 | +| 14.1 | IWF..... | 142 | +| 14.1.1 | IWF originates Interworking Security Data message..... | 142 | +| 14.1.2 | IWF receives Interworking Security Data message ..... | 142 | +| 14.2 | Interworking Security Data message payload..... | 142 | +| 14.2.1 | Message definition..... | 142 | +| 14.2.2 | External network type..... | 143 | +| Annex A (normative): XML Schema..... | | 144 | +| A.1 | General..... | 144 | +| A.2 | mcpttinfo ..... | 144 | +| A.2.1 | XML schema..... | 144 | +| A.2.2 | Semantic ..... | 144 | +| Annex B (normative): IANA registration forms ..... | | 146 | +| B.1 | Media type for transporting interworking data content ..... | 146 | +| Annex C (informative): Change history..... | | 148 | + +## Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +--- + +## 1 Scope + +The present document specifies the call control protocols needed to support a Mission Critical Push To Talk (MCPTT) system interworking with a Land Mobile Radio (LMR) system. + +The IWF supports the basic group and other features as specified in 3GPP TS 23.283 [28]. The present document describes functionality modelled on 3GPP TS 24.379 [29]. + +--- + +## 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.379: "Functional architecture and information flows to support mission critical communication services; Stage 2". +- [3] 3GPP TS 24.229: "IP multimedia call control protocol based on Session Initiation Protocol (SIP) and Session Description Protocol (SDP); Stage 3". +- [4] 3GPP TS 24.380: "Mission Critical Push To Talk (MCPTT) floor control Protocol specification". +- [5] IETF RFC 3841 (August 2004): "Caller Preferences for the Session Initiation Protocol (SIP)". +- [6] IETF RFC 4028 (April 2005): "Session Timers in the Session Initiation Protocol (SIP)". +- [7] IETF RFC 6050 (November 2010): "A Session Initiation Protocol (SIP) Extension for the Identification of Services". +- [8] IETF RFC 4566 (July 2006): "Session Description Protocol". +- [9] IETF RFC 3840 (August 2004): "Indicating User Agent Capabilities in the Session Initiation Protocol (SIP)". +- [10] IETF RFC 5373 (November 2008): "Requesting Answering Modes for the Session Initiation Protocol (SIP)". +- [11] IETF RFC 5366 (October 2008): "Conference Establishment Using Request-Contained Lists in the Session Initiation Protocol (SIP)". + +- [12] IETF RFC 4488 (May 2006): "Suppression of Session Initiation Protocol (SIP) REFER Method Implicit Subscription". +- [13] IETF RFC 4538 (June 2006): "Request Authorization through Dialog Identification in the Session Initiation Protocol (SIP)". +- [14] IETF RFC 3261 (June 2002): "SIP: Session Initiation Protocol". +- [15] IETF RFC 4575 (August 2006): "A Session Initiation Protocol (SIP) Event Package for Conference State". +- [16] 3GPP TS 24.481: "Mission Critical Services (MCS) group management Protocol specification". +- [17] IETF RFC 4483 (May 2006): "A Mechanism for Content Indirection in Session Initiation Protocol (SIP) Messages". +- [18] IETF RFC 3428 (December 2002): "Session Initiation Protocol (SIP) Extension for Instant Messaging". +- [19] IETF RFC 4964 (October 2007): "The P-Answer-State Header Extension to the Session Initiation Protocol for the Open Mobile Alliance Push-to-talk over Cellular". +- [20] IETF RFC 5318 (December 2008): "The Session Initiation Protocol (SIP) P-Refused-URI-List Private-Header (P-Header)". +- [21] IETF RFC 3903 (October 2004): "Session Initiation Protocol (SIP) Extension for Event State Publication". +- [22] IETF RFC 4567 (July 2006): "Key Management Extensions for Session Description Protocol (SDP) and Real Time Streaming Protocol (RTSP)". +- [23] IETF RFC 8101 "IANA Registration of New Session Initiation Protocol (SIP) Resource-Priority Namespace for Mission Critical Push To Talk service". +- [24] IETF RFC 3856 (August 2004): "A Presence Event Package for the Session Initiation Protocol (SIP)". +- [25] IETF RFC 6665 (July 2012): "SIP-Specific Event Notification". +- [26] IETF RFC 6086 (January 2011): "Session Initiation Protocol (SIP) INFO Method and Package Framework". +- [27] 3GPP TS 33.180: "Security of the mission critical service". +- [28] 3GPP TS 23.283: "Mission Critical Communication Interworking with Land Mobile Radio Systems; Stage 2". +- [29] 3GPP TS 24.379: "Mission Critical Push To Talk (MCPTT) call control; Protocol specification". +- [30] 3GPP TS 24.282: "Mission Critical Data (MCData) signalling control; Protocol specification". +- [31] 3GPP TS 29.380: "Mission Critical Push To Talk (MCPTT) media plane control interworking with LMR systems". +- [32] IETF RFC 3986: "Uniform Resource Identifier (URI): Generic Syntax". +- [33] 3GPP TS 29.582: "Mission Critical Data (MCData) interworking with LMR systems". + +## 3 Definitions of terms, symbols and abbreviations + +### 3.1 Terms + +For the purposes of the present document, the terms given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +**IWF performing the controlling role:** an IWF role in which the IWF interacts with MCPTT participating functions and MCPTT non-controlling functions across the IWF-1 interface. + +**IWF performing the non-controlling role:** an IWF role in which the IWF interacts with MCPTT participating functions and MCPTT controlling functions across the IWF-1 interface + +**IWF performing the participating role:** an IWF role in which the IWF interacts with MCPTT controlling functions and MCPTT non-controlling functions across the IWF-1 interface. + +**Participant homed in the IWF:** same as "User homed in the IWF". + +**User homed in the IWF:** A user represented by an MCPTT ID in the IWF with the same domain as the IWF. + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 23.283 [28] apply: + +**Interworking Function (IWF)** + +### 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|-------|-------------------------------| +| IWF | InterWorking Function | +| KMS | Key Management Service | +| LMR | Land Mobile Radio | +| MC | Mission Critical | +| MCPTT | Mission Critical Push To Talk | +| URI | Uniform Resource Identifier | + +## 4 General + +### 4.1 IWF overview + +The IWF interacts with the controlling, participating and non-controlling MCPTT functions of an MCPTT system as a peer system via the IWF-1 interface and with MCData systems via the IWF-2 interface. The IWF supports a subset of the client-server group management interfaces defined in 3GPP TS 24.481 [16] required to support IWF-3, with the exceptions and additions defined in the present document. + +### 4.2 Warning Header Field + +#### 4.2.1 General + +An IWF can include a free text string in a SIP response to a SIP request. When the IWF includes a text string in a response to a SIP INVITE request the text string is included in a Warning header field as specified in IETF RFC 3261 [14]. The IWF includes the Warning code set to 399 (miscellaneous warning) and includes the host name set to the host name of the IWF. + +## 4.2.2 Warning texts + +Existing warning texts as specified in 3GPP TS 24.379 [29] will be used. + +## 4.3 MCPTT priority calls and alerts + +Clauses 4.6.1, 4.6.2, 4.6.3 and 4.6.4 in 3GPP TS 24.379 [29] describe the aspects and states that are key in managing priority calls and alerts. + +The IWF manages the states on behalf of its homed users. For states that are managed by clients, the IWF manages an instance of the state for each client homed in the IWF. + +## 4.4 Media security at the IWF + +With respect to LMR interworking, the IWF provides the interfaces as specified in 3GPP TS 23.283 [28] and 3GPP TS 33.180 [27] to key management and group management capabilities of the LMR system. + +## 4.5 Broadcast group calls + +See 3GPP TS 24.379 [29] for a description of broadcast group calls. + +--- + +# 5 Functional entities + +## 5.1 General + +An IWF can perform the controlling role for group calls and private calls. The controlling role serves as the group home, managing the floor and tracking group affiliations. + +An IWF can perform the participating role for group calls and private calls. The participating role serves as the user home, checking user authorizations and forwarding signalling and media between the controlling role and clients. + +An IWF can perform a non-controlling role for temporary group calls involving groups from multiple MCPTT systems. The non-controlling role serves as the controlling role for a constituent group of a regroup and coordinates with the controlling server of the temporary group. + +An IWF performing the participating role can serve an originating LMR user. How the IWF serves LMR users is out of scope of 3GPP. + +An IWF performing the participating role can serve a terminating LMR user. How the IWF serves LMR users is out of scope of 3GPP. + +The same IWF can perform the participating role and controlling role for the same group session. + +The same IWF can perform the participating role and non-controlling role for the same group session. + +When referring to the procedures in the present document for the IWF acting in a participating role, the term, "IWF performing the participating role" is used. + +When referring to the procedures in the present document for the IWF acting in a controlling role, the term "IWF performing the controlling role" is used. + +When referring to the procedures in the present document for the IWF acting in a non-controlling role for a group call, the term " IWF performing the non-controlling role " is used. + +To be compliant with the procedures in the present document, an IWF shall: + +- support the IWF procedures defined in 3GPP TS 23.283 [28]; + +- generate SDP offer and SDP answer in accordance with 3GPP TS 24.229 [3] and clause 6.3 of 3GPP TS 24.379 [29]; +- implement the role of a centralised floor control server and implement the on-network procedures for floor control as specified in 3GPP TS 29.380 [31]; +- for registration and service authorisation, IWF procedures are out of scope of the present document; +- for affiliation of users hosted in the MCPTT system, implement the procedures specified in the present document; for LMR users, the affiliation process is out of scope of the present document; +- for group call functionality (including broadcast, emergency and imminent peril), implement the procedures specified in the present document; and +- for private call functionality (including emergency), implement the procedures specified in the present document. + +To be compliant with the procedures in the present document requiring the distribution of private call keying material between MCPTT clients as specified in 3GPP TS 33.180 [27], an IWF shall behave as an encryption endpoint on behalf of its LMR users. + +NOTE: A scenario with the IWF acting as an encryption endpoint is not end to end encryption. End to end encryption with LMR users is out of scope of the present document, but some tools are provided to allow end to end encryption to be defined outside of 3GPP. + +To be compliant with the procedures for confidentiality protection of XML elements in the present document, the IWF shall implement the procedures specified in clause 6.6.2 of 3GPP TS 24.379 [29]. + +To be compliant with the procedures for integrity protection of XML MIME bodies in the present document, the IWF shall implement the procedures specified in clause 6.6.3 of 3GPP TS 24.379 [29]. + +## 5.2 Functional connectivity models + +The following figures give an overview of the connectivity between the IWF and the MCPTT system with the IWF in different roles as described in clause 5.1. + +NOTE: The MCPTT functional roles are not defined here. They are defined in 3GPP TS 24.379 [29] but are shown here to illustrate the relationship with the IWF. + +Figure 5.2-1 shows the role of the IWF relative to an MCPTT system. Here, the controlling MCPTT function is in the MCPTT system and the called user is homed in the IWF. The IWF plays the role of the terminating participating function. + +![Diagram showing the relationship between the IWF and an MCPTT system. The diagram consists of four boxes connected in a linear sequence from left to right: 'MCPTT Client', 'Originating Participating MCPTT Function', 'Controlling MCPTT Function', and 'IWF (terminating participating role)'.](66c2bf11a8f117cddf67eff92d4c736c_img.jpg) + +``` +graph LR; A[MCPTT Client] --- B[Originating Participating MCPTT Function]; B --- C[Controlling MCPTT Function]; C --- D[IWF (terminating participating role)]; +``` + +Diagram showing the relationship between the IWF and an MCPTT system. The diagram consists of four boxes connected in a linear sequence from left to right: 'MCPTT Client', 'Originating Participating MCPTT Function', 'Controlling MCPTT Function', and 'IWF (terminating participating role)'. + +**Figure 5.2-1: Relationship between the IWF and an MCPTT system with the controlling MCPTT function in the MCPTT system** + +Figure 5.2-2 shows the role of the IWF relative to an MCPTT system. Here, the controlling MCPTT function is in the MCPTT system and the calling user is homed in the IWF. The IWF plays the role of the originating participating function. + +![Figure 5.2-2: Relationship between the IWF and an MCPTT system with the controlling MCPTT function in the MCPTT system](7efae06af3af43ffe5d4b956a679cf54_img.jpg) + +``` +graph LR; MCPTT_Client[MCPTT Client] --- Terminating_Participating_MCPTT_Function[Terminating Participating MCPTT Function]; Terminating_Participating_MCPTT_Function --- Controlling_MCPTT_Function[Controlling MCPTT Function]; Controlling_MCPTT_Function --- IWF[IWF (originating participating role)]; +``` + +A block diagram showing four components connected in a linear sequence from left to right: 'MCPTT Client', 'Terminating Participating MCPTT Function', 'Controlling MCPTT Function', and 'IWF (originating participating role)'. The components are connected by straight lines. + +Figure 5.2-2: Relationship between the IWF and an MCPTT system with the controlling MCPTT function in the MCPTT system + +**Figure 5.2-2: Relationship between the IWF and an MCPTT system with the controlling MCPTT function in the MCPTT system** + +Figure 5.2-3 shows the role of the IWF relative to an MCPTT system. Here, the controlling MCPTT function is in the IWF and the called user is homed in the IWF. The IWF plays the role of the controlling function. + +![Figure 5.2-3: Relationship between the IWF and an MCPTT system with the controlling MCPTT function in the IWF](9ae17964ddd9b814c7d905b1af2fddf2_img.jpg) + +``` +graph LR; MCPTT_Client[MCPTT Client] --- Originating_Participating_MCPTT_Function[Originating Participating MCPTT Function]; Originating_Participating_MCPTT_Function --- IWF[IWF (controlling role)]; +``` + +A block diagram showing three components connected in a linear sequence from left to right: 'MCPTT Client', 'Originating Participating MCPTT Function', and 'IWF (controlling role)'. The components are connected by straight lines. + +Figure 5.2-3: Relationship between the IWF and an MCPTT system with the controlling MCPTT function in the IWF + +**Figure 5.2-3: Relationship between the IWF and an MCPTT system with the controlling MCPTT function in the IWF** + +Figure 5.2-4 shows the role of the IWF relative to an MCPTT system. Here, the controlling MCPTT function is in the IWF and the calling user is homed in the IWF. The IWF plays the role of the controlling function. + +![Figure 5.2-4: Relationship between the IWF and an MCPTT system with the controlling MCPTT function in the IWF](a7c51c18111139f9aca2805114108565_img.jpg) + +``` +graph LR; MCPTT_Client[MCPTT Client] --- Terminating_Participating_MCPTT_Function[Terminating Participating MCPTT Function]; Terminating_Participating_MCPTT_Function --- IWF[IWF (controlling role)]; +``` + +A block diagram showing three components connected in a linear sequence from left to right: 'MCPTT Client', 'Terminating Participating MCPTT Function', and 'IWF (controlling role)'. The components are connected by straight lines. + +Figure 5.2-4: Relationship between the IWF and an MCPTT system with the controlling MCPTT function in the IWF + +**Figure 5.2-4: Relationship between the IWF and an MCPTT system with the controlling MCPTT function in the IWF** + +Figure 5.2-5 shows the role of the IWF relative to an MCPTT system. Here, the controlling MCPTT function is in the MCPTT system, the non-controlling function is in the IWF and the called user is homed in the IWF. The IWF plays the role of the non-controlling function. + +![Figure 5.2-5: Relationship between the IWF and an MCPTT system with the controlling MCPTT function in the MCPTT system and a non-controlling function in the IWF](18722c46c9e8475524e634dedd08bac2_img.jpg) + +``` +graph LR; MCPTT_Client[MCPTT Client] --- Originating_Participating_MCPTT_Function[Originating Participating MCPTT Function]; Originating_Participating_MCPTT_Function --- Controlling_MCPTT_Function[Controlling MCPTT Function]; Controlling_MCPTT_Function --- IWF[IWF (non-controlling role)]; +``` + +A block diagram showing four components connected in a linear sequence from left to right: 'MCPTT Client', 'Originating Participating MCPTT Function', 'Controlling MCPTT Function', and 'IWF (non-controlling role)'. The components are connected by straight lines. + +Figure 5.2-5: Relationship between the IWF and an MCPTT system with the controlling MCPTT function in the MCPTT system and a non-controlling function in the IWF + +**Figure 5.2-5: Relationship between the IWF and an MCPTT system with the controlling MCPTT function in the MCPTT system and a non-controlling function in the IWF** + +Figure 5.2-6 shows the role of the IWF relative to an MCPTT system. Here, the controlling MCPTT function is in the MCPTT system, the non-controlling function is in the IWF and the calling user is homed in the IWF. The IWF plays the role of the non-controlling function. + +![Figure 5.2-6: Relationship between the IWF and an MCPTT system. The diagram shows four boxes connected in a linear sequence from left to right: 'MCPTT Client', 'Terminating Participating MCPTT Function', 'Controlling MCPTT Function', and 'IWF (non-controlling role)'.](16152cf1d84aea10848758f51a91ff6a_img.jpg) + +``` + +graph LR + A[MCPTT Client] --- B[Terminating Participating MCPTT Function] + B --- C[Controlling MCPTT Function] + C --- D[IWF (non-controlling role)] + +``` + +Figure 5.2-6: Relationship between the IWF and an MCPTT system. The diagram shows four boxes connected in a linear sequence from left to right: 'MCPTT Client', 'Terminating Participating MCPTT Function', 'Controlling MCPTT Function', and 'IWF (non-controlling role)'. + +**Figure 5.2-6: Relationship between the IWF and an MCPTT system with the controlling MCPTT function in the MCPTT system and a non-controlling function in the IWF** + +Other functional connectivity models can exist. + +## 6 Call control common procedures + +### 6.1 SDP + +#### 6.1.1 SDP offer generation + +The SDP offer shall contain only one SDP media-level clause for offered speech according to 3GPP TS 24.229 [3] and, if floor control shall be used during the session, shall contain one SDP media-level clause for a media-floor control entity according to 3GPP TS 29.380 [31]. + +When composing an SDP offer according to 3GPP TS 24.229 [3] the IWF: + +- 1) shall set the IP address of the IWF for the offered speech media stream and, if floor control shall be used, for the offered media-floor control entity; +- 2) shall include an "m=audio" media-level clause for the MCPTT media stream consisting of: + - a) the port number for the media stream selected; + - b) the codec(s) and media parameters and attributes with the following clarification: + - i) if the IWF is initiating a call to a group identity; + - ii) if the element is present in the group document as specified in 3GPP TS 24.481 [16] containing an element with a "name" attribute; and + - iii) if the IWF supports the encoding name indicated in the value of the "name" attribute; + then the IWF shall insert the value of the "name" attribute in the field of the "a=rtpmap" attribute as defined in IETF RFC 4566 [8]; and + - c) "i=" field set to "speech" according to 3GPP TS 24.229 [3]; +- 3) if floor control shall be used during the session, shall include an "m=application" media-level clause as specified in 3GPP TS 29.380 [31] clause 12 for a media-floor control entity, consisting of: + - a) the port number for the media-floor control entity selected as specified in 3GPP TS 29.380 [31]; and + - b) the 'fmt' attributes as specified in 3GPP TS 29.380 [31] clause 14; and + +- 4) if media security is required between the MCPTT client and the IWF for a private call, shall include the MIKEY-SAKKE\_I\_MESSAGE in an "a=key-mgmt" attribute as a "mikey" attribute value in the SDP offer as specified in IETF RFC 4567 [22]. + +## 6.1.2 SDP answer generation + +When the IWF receives an initial SDP offer for an MCPTT session, the IWF shall process the SDP offer and shall compose an SDP answer according to 3GPP TS 24.229 [3]. + +When composing an SDP answer, the IWF: + +- 1) shall accept the speech media stream in the SDP offer; +- 2) shall set the IP address of the IWF for the accepted speech media stream and, if included in the SDP offer, for the accepted media-floor control entity; + +NOTE: If the IWF is behind a NAT the IP address and port included in the SDP answer can be a different IP address and port than the actual IP address and port of the IWF depending on the NAT traversal method used by the SIP/IP Core. + +- 3) shall include an "m=audio" media-level clause for the accepted MCPTT speech media stream consisting of: + - a) the port number for the media stream; + - b) media-level attributes as specified in 3GPP TS 24.229 [3]; + - c) if the "a=recvonly" attribute is present in the SDP offer, include an "a=sendonly" attribute; + - d) if the "a=sendonly" attribute is present in the SDP offer, include an "a=recvonly" attribute; and + - e) "i=" field set to "speech" according to 3GPP TS 24.229 [3]; and +- 4) if included in the SDP offer, shall include the media-level clause of the offered media-floor control entity consisting of: + - a) an "m=application" media-level clause as specified in 3GPP TS 29.380 [31] clause 12; and + - b) 'fmt' attributes as specified in 3GPP TS 29.380 [31] clause 14. + +## 6.2 Commencement modes + +### 6.2.1 Automatic commencement mode for private calls + +When performing the automatic commencement mode procedures, the IWF performing the participating role: + +- 1) shall accept the SIP INVITE request and generate a SIP 200 (OK) response according to rules and procedures of 3GPP TS 24.229 [3]; +- 2) shall include the option tag "timer" in a Require header field of the SIP 200 (OK) response; +- 3) shall include the g.3gpp.mcptt media feature tag in the Contact header field of the SIP 200 (OK) response; +- 4) shall include the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcptt" in the Contact header field of the SIP 200 (OK) response; +- 5) shall include the Session-Expires header field in the SIP 200 (OK) response and start the SIP session timer according to IETF RFC 4028 [6]. The "refresher" parameter in the Session-Expires header field shall be set to "uas"; +- 6) shall include an SDP answer in the SIP 200 (OK) response to the SDP offer in the incoming SIP INVITE request according to 3GPP TS 24.229 [3] with the clarifications given in clause 6.1.2; +- 7) shall send the SIP 200 (OK) response towards the MCPTT server according to rules and procedures of 3GPP TS 24.229 [3]; + +- 8) shall interact with the media plane as specified in 3GPP TS 29.380 [31] clause 6.2. + +## 6.2.2 Manual commencement mode for private calls + +When performing the manual commencement mode procedures: + +- 1) if the user homed in the IWF declines the MCPTT session invitation the IWF performing the participating role shall send a SIP 480 (Temporarily Unavailable) response towards the MCPTT controlling function with the warning text set to: "110 user declined the call invitation" in a Warning header field as specified in clause 4.4, and not continue with the rest of the steps in this clause. + +The IWF performing the participating role: + +- 1) shall accept the SIP INVITE request and generate a SIP 180 (Ringing) response according to rules and procedures of 3GPP TS 24.229 [3]; +- 2) shall include the option tag "timer" in a Require header field of the SIP 180 (Ringing) response; +- 3) shall include the g.3gpp.mcptt media feature tag in the Contact header field of the SIP 180 (Ringing) response; +- 4) shall include the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcptt" in the Contact header field of the SIP 180 (Ringing) response; and +- 5) shall send the SIP 180 (Ringing) response to the controlling MCPTT function. + +When sending the SIP 200 (OK) response to the incoming SIP INVITE request, the IWF performing the participating role shall follow the procedures in clause 6.2.1. + +## 6.3 Receiving an MCPTT session release request + +Upon receiving a SIP BYE request, the IWF: + +- 1) shall interact with the media plane as specified in 3GPP TS 29.380 [31]; and +- 2) shall send a SIP 200 (OK) response towards the MCPTT server according to 3GPP TS 24.229 [3]. + +## 6.4 Priority call conditions + +### 6.4.1 MCPTT emergency group call conditions + +#### 6.4.1.1 SIP INVITE request for originating MCPTT emergency group calls + +This clause is referenced from other procedures. + +When the MCPTT emergency state is set, the IWF performing the participating role: + +- 1) shall include in the application/vnd.3gpp.mcptt-info+xml MIME body in the SIP INVITE request, an element set to "true" and if the MCPTT emergency group call state is set to "MEGC 1: emergency-gc-capable", shall set the MCPTT emergency group call state to "MEGC 2: emergency-call-requested"; +- 2) if the IWF has determined that an MCPTT emergency alert is to be sent, and the MCPTT emergency alert state is set to "MEA 1: no-alert", shall: + - a) set the element of the application/vnd.3gpp.mcptt-info+xml MIME body to "true" and set the MCPTT emergency alert state to "MEA 2: emergency-alert-confirm-pending"; and + - b) include in the SIP INVITE request the specific location information for MCPTT emergency alert as specified in clause 6.5.1; + +- 3) if the IWF has determined that an MCPTT emergency alert is not to be sent and the MCPTT emergency alert state is set to "MEA 1: no-alert", shall set the element of the application/vnd.3gpp.mcptt-info+xml MIME body to "false"; and +- 4) if the MCPTT client emergency group state of the user homed in the IWF of the group is set to a value other than "MEG 2: in-progress" set the MCPTT client emergency group state of the user homed in the IWF of the MCPTT group to "MEG 4: confirm-pending". + +NOTE 1: This is the case of a user homed in the IWF already being in the MCPTT emergency state it initiated previously while originating an MCPTT emergency group call or MCPTT emergency alert. All group calls the user homed in the IWF originates while in MCPTT emergency state will be MCPTT emergency group calls. + +When the MCPTT emergency state is clear and the MCPTT emergency group call state is set to "MEGC 1: emergency-gc-capable" and the IWF determines that the request for MCPTT emergency group call is authorized by local policy, the IWF performing the participating role shall set the MCPTT emergency state and perform the following actions: + +- 1) shall include in the application/vnd.3gpp.mcptt-info+xml MIME body in the SIP INVITE request an element set to "true" and set the MCPTT emergency group call state to "MEGC 2: emergency-call-requested" state; +- 2) if the user homed in the IWF has also requested an MCPTT emergency alert to be sent, shall: + - a) include in the application/vnd.3gpp.mcptt-info+xml MIME body the element set to "true" and set the MCPTT emergency alert state to "MEA 2: emergency-alert-confirm-pending"; and + - b) include in the SIP INVITE request the specific location information, if available, for MCPTT emergency alert as specified in clause 6.5.1; +- 3) if the IWF has determined that an MCPTT emergency alert is not to be sent, shall set the element of the application/vnd.3gpp.mcptt-info+xml MIME body to "false"; and +- 4) if the MCPTT client emergency group state of the user homed in the IWF of the group is set to a value other than "MEG 2: in-progress" shall set the MCPTT client emergency group state of the user homed in the IWF of the MCPTT group to "MEG 4: confirm-pending". + +NOTE 2: This is the case of an initial MCPTT emergency group call and optionally an MCPTT emergency alert being sent. As the MCPTT emergency state is not sent, there is no MCPTT emergency alert outstanding. + +NOTE 3: An MCPTT group call originated by an affiliated member of an MCPTT group which is in an in-progress emergency state (as tracked on the MCPTT client by the MCPTT client emergency group state) but is not in an MCPTT emergency state of their own will also be an MCPTT emergency group call. The and elements of the application/vnd.3gpp.mcptt-info+xml MIME body do not need to be included in this case and hence no action needs to be taken in this clause. + +#### 6.4.1.2 Resource-Priority header field for MCPTT emergency group calls + +This clause is referenced from other procedures. + +If the MCPTT emergency group call state is set to either "MEGC 2: emergency-call-requested" or "MEGC 3: emergency-call-granted", or the MCPTT client emergency group state of the group is set to "MEG 2: in-progress", the IWF performing the participating role shall include in the SIP INVITE request a Resource-Priority header field populated with the values for an MCPTT emergency group call as specified in clause 6.4.1.11. + +NOTE: The IWF performing the participating role ideally would not need to maintain knowledge of the in-progress emergency state of the group (as tracked for the client by the MCPTT client emergency group state by the IWF performing the participating role) but can use this knowledge to provide a Resource-Priority header field set to emergency level priority, which starts the infrastructure priority adjustment process sooner than otherwise would be the case. + +If the MCPTT client emergency group state of the group is "no-emergency" or "cancel-pending", the IWF performing the participating role shall include in the SIP INVITE request a Resource-Priority header field populated with the values for a normal MCPTT group call as specified in clause 6.4.1.11. + +#### 6.4.1.3 SIP re-INVITE request for cancelling MCPTT in-progress emergency group state + +This clause is referenced from other procedures. + +If the MCPTT emergency group call state is set to "MEGC 3: emergency-call-granted" and the MCPTT emergency alert state is set to "MEA 1: no-alert", the IWF performing the participating role shall generate a SIP re-INVITE request according to 3GPP TS 24.229 [3] with the clarifications given below. + +The IWF performing the participating role: + +- 1) shall include in the SIP re-INVITE request an application/vnd.3gpp.mcptt-info+xml MIME body as defined in 3GPP TS 24.379 [29], clause F.1 with the element set to "false"; +- 2) shall clear the MCPTT emergency state; and +- 3) shall set MCPTT emergency group state of the MCPTT group to "MEG 3: cancel-pending". + +NOTE 1: This is the case of a user homed in the IWF who has initiated an MCPTT emergency group call and wants to cancel it. + +If the MCPTT emergency group call state is set to "MEGC 3: emergency-call-granted" and the MCPTT emergency alert state is set to a value other than "MEA 1: no-alert" and only the MCPTT emergency group call is to be cancelled, the IWF performing the participating role: + +- 1) shall include in the SIP re-INVITE request an application/vnd.3gpp.mcptt-info+xml MIME body as defined in 3GPP TS 24.379 [29], clause F.1 with the element set to "false"; and +- 2) shall set the MCPTT emergency group state of the MCPTT group to "MEG 3: cancel-pending". + +NOTE 2: This is the case of a user homed in the IWF that has initiated both an MCPTT emergency group call and an MCPTT emergency alert and wishes to only cancel the MCPTT emergency group call. This leaves the MCPTT emergency state set. + +If the MCPTT emergency group call state is set to "MEGC 3: emergency-call-granted" and the MCPTT emergency alert state is set to a value other than "MEA 1: no-alert" and the user homed in the IWF has indicated that the MCPTT emergency alert on the MCPTT group should be cancelled in addition to the MCPTT emergency group call, the IWF performing the participating role: + +- 1) shall include in the SIP re-INVITE request an application/vnd.3gpp.mcptt-info+xml MIME body as defined in 3GPP TS 24.379 [29], clause F.1 with the element set to "false"; +- 2) shall: + - a) include in the application/vnd.3gpp.mcptt-info+xml MIME body an element set to "false"; + - b) set the MCPTT emergency alert state to "MEA 4: Emergency-alert-cancel-pending"; and + - c) clear the MCPTT emergency state; and +- 3) shall set the MCPTT emergency group state of the MCPTT group to "MEG 3: cancel-pending". + +NOTE 3: This is the case of a user homed in the IWF that has initiated both an MCPTT emergency group call and an MCPTT emergency alert and wishes to cancel both. + +#### 6.4.1.4 Receiving a SIP 2xx response to a SIP request for a priority call + +In the procedures in this clause, a priority group call refers to an MCPTT emergency group call or an MCPTT imminent peril group call. + +On receiving a SIP 2xx response to a SIP request for a priority group call, the IWF: + +- 1) if the MCPTT emergency group call state is set to "MEGC 2: emergency-call-requested" or "MEGC 3: emergency-call-granted": + +- a) shall set the emergency group state of the user homed in the IWF of the group to "MEG 2: in-progress" if it was not already set; + - b) if the MCPTT emergency alert state of the user homed in the IWF is set to "MEA 2: emergency-alert-confirm-pending" and the SIP 2xx response to the SIP request for a priority group call does not contain a Warning header field as specified in TS 24.379 [29] clause 4.4 with the warning text containing the mcptt-warn-code set to "149", shall set the MCPTT emergency alert state of the user homed in the IWF to "MEA 3: emergency-alert-initiated; + - c) shall set the MCPTT emergency group call state to "MEGC 3: emergency-call-granted"; and + - d) shall set the MCPTT imminent peril group call state to "MIGC 1: imminent-peril-capable" and the MCPTT imminent peril group state to "MIG 1: no-imminent-peril"; or +- 2) if the MCPTT imminent peril group call state is set to "MIGC 2: imminent-peril-call-requested" or "MIGC 3: imminent-peril-call-granted" and the SIP 2xx response to the SIP request for an imminent peril group call does not contain a Warning header field as specified in TS 24.379 [29] clause 4.4 with the warning text containing the mcptt-warn-code set to "149": + - a) set the MCPTT imminent peril group call state to "MIGC 3: imminent-peril-call-granted"; and + - b) set the MCPTT imminent peril group state to "MIG 2: in-progress". + +#### 6.4.1.5 Receiving a SIP 4xx response, SIP 5xx response or SIP 6xx response to a SIP request for a priority group call + +In the procedures in this clause, a priority group call refers to an MCPTT emergency group call or an MCPTT imminent peril group call. + +Upon receiving a SIP 4xx response, SIP 5xx response or a SIP 6xx response to a SIP request for a priority group call the IWF: + +- 1) if the MCPTT emergency group call state is set to "MEGC 2: emergency-call-requested" or "MEGC 3: emergency-call-granted": + - a) shall set the MCPTT emergency group call state to "MEGC 1: emergency-gc-capable"; + - b) if the emergency group state of the user homed in the IWF of the group is "MEG 4: confirm-pending" shall set the emergency group state of the user homed in the IWF of the group to "MEG 1: no-emergency"; and + - c) if the sent SIP request for a priority group call contained an application/vnd.3gpp.mcptt-info+xml MIME body with an element set to a value of "true", shall set the MCPTT emergency alert state of the user homed in the IWF to "MEA 1: "no-alert"; and +- 2) if the MCPTT imminent peril group call state is set to "MIGC 2: imminent-peril-call-requested" or "MIGC 3: imminent-peril-call-granted": + - a) shall set the MCPTT imminent peril group state to "MIG 1: no-imminent-peril"; and + - b) shall set the MCPTT imminent peril group call state to "MIGC 1: imminent-peril-gc-capable". + +#### 6.4.1.6 SIP request for originating MCPTT imminent peril group calls + +This clause is referenced from other procedures. + +When the IWF performing the participating role determines to originate an MCPTT imminent peril group call, the IWF performing the participating role: + +- 1) if the client homed in the IWF's imminent peril group state is set to "MIGC 1: imminent-peril-gc-capable" and the in-progress emergency state of the group is set to a value of "false": + - a) shall include in the SIP request an application/vnd.3gpp.mcptt-info+xml MIME body as defined in 3GPP TS 24.379 [29], clause F.1 with the element set to "true" and set the MCPTT emergency group call state to "MIGC 2: imminent-peril-call-requested" state; and + +- b) if the client homed in the IWF's imminent peril group state of the group is set to a value other than "MIG 2: in-progress" shall set the client homed in the IWF's emergency group state of the MCPTT group to "MIG 4: confirm-pending". + +NOTE: An MCPTT group call originated by an affiliated member of an MCPTT group which is in an in-progress imminent peril state (as tracked on the client by the client imminent peril group state) will also have the priority associated with MCPTT imminent peril group calls. The element of the application/vnd.3gpp.mcptt-info MIME body does not need to be included in this case, nor do any state changes result and hence no action needs to be taken in this clause. + +#### 6.4.1.7 SIP re-INVITE request for cancelling MCPTT in-progress imminent peril group state + +This clause is referenced from other procedures. + +If the MCPTT imminent peril group call state is set to "MIGC 3: imminent-peril-call-granted" or the MCPTT imminent peril group state of the MCPTT group is set to "MIG 2: in-progress", the IWF shall generate a SIP re-INVITE request according to 3GPP TS 24.229 [3] with the clarifications given below. + +The IWF: + +- 1) shall include in the SIP re-INVITE request an application/vnd.3gpp.mcptt-info+xml MIME body as defined in clause F.1 with the element set to "false"; and +- 2) shall set MCPTT imminent peril group state of the MCPTT group to "MIG 3: cancel-pending". + +NOTE: This is the case of a user who has initiated an MCPTT imminent peril group call and wants to cancel it, or another authorised member of the group who wishes to cancel the in-progress imminent peril state of the group. + +#### 6.4.1.8 Resource-Priority header field for MCPTT imminent peril group calls + +This clause is referenced from other procedures. + +When the MCPTT imminent peril group call state is set "MIGC 2: imminent-peril-call-requested" or "MIGC 3: imminent-peril-call-granted", or the client homed in the IWF's imminent peril state of the group is set to "MIG 2: in-progress", the IWF performing the participating role: + +- 1) shall include in the SIP INVITE request a Resource-Priority header field populated with the values for an MCPTT imminent peril group call as specified in clause 6.4.1.11. + +NOTE: The IWF performing the participating role ideally would not need to maintain knowledge of the in-progress imminent peril state of the group (as tracked for the client by the client imminent peril group state) but can use this knowledge to provide a Resource-Priority header field set to imminent peril level priority, which starts the infrastructure priority adjustment process sooner than otherwise would be the case. + +When the MCPTT imminent peril group call state is set to "MIGC 1: imminent-peril-gc-capable" and the IWF performing the participating role determines that cancellation of the MCPTT imminent peril group call is authorized, or the MCPTT client imminent peril group state of the group is "MIG 1: no-imminent-peril" or "MIG 3: cancel-pending", the IWF performing the participating role: + +- 1) shall include in the SIP INVITE request a Resource-Priority header field populated with the values for a normal MCPTT group call as specified in clause 6.4.1.11. + +#### 6.4.1.9 Receiving a SIP INFO request in the dialog of a SIP request for a priority group call + +This clause is referenced from other procedures. + +Upon receiving a SIP INFO request within the dialog of the SIP request for a priority group call: + +- with the Info-Package header field containing the g.3gpp.mcptt-info package name; + +- with the application/vnd.3gpp.mcptt-info+xml MIME body associated with the info package according to IETF RFC 6086 [26]; and +- with one or more of the , and elements set in the application/vnd.3gpp.mcptt-info+xml MIME body; + +the IWF: + +- 1) shall send a SIP 200 (OK) response to the SIP INFO request as specified in 3GPP TS 24.229 [3]; +- 2) if the MCPTT emergency group call state is set to "MEGC 3: emergency-call-granted": + - a) if the MCPTT emergency alert state of the user homed in the IWF is set to "MEA 2: emergency-alert-confirm-pending": + - i) if the element is set to a value of "false", shall set the MCPTT emergency alert state to "MEA 1: no-alert"; and + - ii) if the element is set to a value of "true", shall set the MCPTT emergency alert state of the user homed in the IWF to "MEA 3: emergency-alert-initiated"; +- 3) if the MCPTT imminent peril group call state is set to "MIGC 2: imminent-peril-call-requested" or "MIGC 3: imminent-peril-call-granted": + - a) if the element is set to a value of "false" and an element is set to a value of "true", shall: + - i) set the MCPTT imminent peril group state to "MIG 1: no-imminent-peril"; + - ii) set the MCPTT imminent peril group call state to "MIGC 1: imminent-peril-capable"; and + - iii) set the emergency group state of the user homed in the IWF of the group to "MEG 2: in-progress"; and + +NOTE 1: This is the case of an IWF attempting to make an imminent peril group call when the group is in an in-progress emergency group state. The IWF will then receive a notification that the imminent peril call request was denied, however the IWF will be participating at the emergency level priority of the group. + +NOTE 2: the emergency group state of the user homed in the IWF above is the view of the in-progress emergency state of the group for each user homed in the IWF. + +- 4) if the SIP request for a priority group call sent by the IWF did not contain an element and if the MCPTT emergency alert state of the user homed in the IWF is set to "MEA 4: Emergency-alert-cancel-pending": + - a) if the element contained in the SIP INFO request is set to a value of "true", shall set the MCPTT emergency alert state of the user homed in the IWF to "MEA 3: emergency-alert-initiated"; and + - b) if the element contained in the SIP INFO request is set to a value of "false", shall set the MCPTT emergency alert state of the user homed in the IWF to "MEA 1: no-alert". + +#### 6.4.1.10 SIP re-INVITE request for cancelling the in-progress emergency group state of a group by a third-party + +This clause is referenced from other procedures. + +Upon the need to cancel an in-progress emergency group state of a group, the IWF performing the participating role shall generate a SIP re-INVITE request according to 3GPP TS 24.229 [3] with the clarifications given below. + +The IWF performing the participating role: + +- 1) shall include in the SIP re-INVITE request an application/vnd.3gpp.mcptt-info+xml MIME body as defined in 3GPP TS 24.379 [29], clause F.1 with the element set to "false"; +- 2) shall set MCPTT emergency group state of the MCPTT group to "MEG 3: cancel-pending"; and +- 3) if the MCPTT emergency alert on the MCPTT group originated by a MCPTT user is to be cancelled: + +- a) shall include in the application/vnd.3gpp.mcptt-info+xml MIME body an element set a value of "false"; and +- b) shall include in the application/vnd.3gpp.mcptt-info+xml MIME body an element set to the MCPTT ID of the MCPTT user who originated the MCPTT emergency alert. + +NOTE: When an MCPTT emergency alert is cancelled by a user other than its originator, the element is needed to identify which MCPTT emergency alert is being cancelled, as more than one MCPTT user could have originated emergency alerts to the same group. + +#### 6.4.1.11 Resource-Priority header field values + +This clause is referenced from other procedures. + +The IWF performing the participating role may populate the Resource-Priority header as described for the IWF performing the controlling role in clause 6.6.3.1.12. + +### 6.4.2 MCPTT emergency private call conditions + +#### 6.4.2.1 SIP request for originating MCPTT emergency private calls + +This clause is referenced from other procedures. + +When the MCPTT emergency private call state is set to "MEPC 1: emergency-pc-capable", the IWF: + +- 1) shall set the MCPTT emergency state if not already set; +- 2) shall include in the application/vnd.3gpp.mcptt-info+xml MIME body in the SIP request an element set to "true" and set the MCPTT emergency private call state to "MEPC 2: emergency-pc-requested"; +- 3) if an MCPTT emergency alert is to be sent, shall: + - a) include in the application/vnd.3gpp.mcptt-info+xml MIME body the element set to "true" and set the MCPTT private emergency alert state to "MPEA 2: emergency-alert-confirm-pending"; and + - b) include in the SIP request the specific location information for MCPTT emergency alert as specified in clause 6.5.1; +- 4) if the IWF has determined not to request an MCPTT emergency alert to be sent, shall set the element of the application/vnd.3gpp.mcptt-info+xml MIME body to "false"; and +- 5) if the MCPTT emergency private priority state of this private call is set to a value other than "MEPP 2: in-progress" shall set the MCPTT emergency private priority state to "MEPP 3: confirm-pending". + +#### 6.4.2.2 Resource-Priority header field for MCPTT emergency private calls + +This clause is referenced from other procedures. + +If the MCPTT emergency private call state is set to either "MEPC 2: emergency-pc-requested" or "MEPC 3: emergency-pc-granted", or the MCPTT emergency private priority state of the call is set to "MEPP 2: in-progress", the IWF shall include in the SIP request a Resource-Priority header field populated with the values for an MCPTT emergency private call as specified in clause 6.4.1.11. + +NOTE: The IWF ideally would not need to maintain knowledge of the in-progress emergency state of the call (as tracked on the MCPTT client by the MCPTT client emergency private state) but can use this knowledge to provide a Resource-Priority header field set to emergency level priority, which starts the infrastructure priority adjustment process sooner than otherwise would be the case. + +If this is a request to cancel the MCPTT emergency private call and the MCPTT emergency private priority state of the private call is "MEPP 1: no-emergency" or "MEPP 3: cancel-pending", the IWF shall include in the SIP request a Resource-Priority header field populated with the values for a normal MCPTT private call as specified in clause 6.4.1.11. + +### 6.4.2.3 SIP re-INVITE request for cancelling MCPTT emergency private call state + +This clause is referenced from other procedures. + +When the MCPTT emergency private call state is set to "MEPC 3: emergency-pc-granted" and the MCPTT emergency alert state is set to "MPEA 1: no-alert", the IWF performing the participating role shall generate a SIP re-INVITE request according to 3GPP TS 24.229 [3] with the clarifications given below. + +The IWF performing the participating role: + +- 1) shall include in the SIP re-INVITE request an application/vnd.3gpp.mcptt-info+xml MIME body as defined in 3GPP TS 24.379 [29], 3GPP TS 24.379 [29], clause F.1 with the element set to "false"; +- 2) shall clear the MCPTT emergency state; and +- 3) shall set MCPTT emergency private priority state of the MCPTT emergency private call to "MEPP 3: cancel-pending". + +NOTE 1: This is the case where a private call is in emergency and the emergency is to be cancelled. + +When the MCPTT emergency private call state is set to "MEPPC 3: emergency-pc-granted" and the MCPTT emergency alert state is set to a value other than "MPEA 1: no-alert" and the IWF decides that only the MCPTT emergency private call should be cancelled, the IWF performing the participating role: + +- 1) shall include in the SIP re-INVITE request an application/vnd.3gpp.mcptt-info+xml MIME body as defined in 3GPP TS 24.379 [29], 3GPP TS 24.379 [29], clause F.1 with the element set to "false"; and +- 2) shall set the MCPTT emergency private priority state of the MCPTT emergency private call to "MEPP 3: cancel-pending"; + +NOTE 2: This is the case where both an MCPTT emergency private call and an MCPTT emergency alert have been initiated and only the MCPTT emergency on the private call is to be cancelled. This leaves the MCPTT emergency state set. + +When the MCPTT emergency private call state is set to "MEPC 3: emergency-pc-granted" and the MCPTT emergency alert state is set to a value other than "MPEA 1: no-alert" and the IWF performing the participating role has indicated that the MCPTT emergency alert on the MCPTT private call should be cancelled in addition to the MCPTT emergency private call, the IWF performing the participating role: + +- 1) shall include in the SIP re-INVITE request an application/vnd.3gpp.mcptt-info+xml MIME body as defined in 3GPP TS 24.379 [29], clause F.1 with the element set to "false"; +- 2) shall: + - a) include in the application/vnd.3gpp.mcptt-info+xml MIME body an element set to "false"; and + - b) set the MCPTT private emergency alert state to "MPEA 4: emergency-alert-cancel-pending"; +- 3) shall set the MCPTT emergency private priority state of the MCPTT to "MEPP 3: cancel-pending"; and +- 4) shall clear the MCPTT emergency state. + +NOTE 3: This is the case where both an MCPTT emergency private call and an MCPTT emergency alert have been initiated and both are to be cancelled. + +## 6.5 Location information + +### 6.5.1 Location information for location reporting + +This procedure is initiated by the IWF performing the participating role when it is including location report information as part of a SIP request containing an MCPTT emergency alert. + +NOTE 1: Location triggers are out of scope of the present document. + +The IWF performing the participating role: + +- 1) shall include an application/vnd.3gpp.mcptt-location-info+xml MIME body as specified in 3GPP TS 24.379 [29], clause F.3 with a element included in the root element; +- 2) shall set the element of the element to a value of "Emergency"; and +- 3) shall include in the element of the element of the application/vnd.3gpp.mcptt-location-info+xml MIME body a element populated as specified in 3GPP TS 24.379 [29], clause F.3.3. + +NOTE 2: According to local policy, additional location information elements specified in 3GPP TS 24.379 [29], clause F.3.3 can be included in the element. + +## 6.6 IWF server role procedures + +### 6.6.1 Distinction of requests sent to the IWF + +#### 6.6.1.1 SIP INVITE request + +The IWF needs to distinguish between the following initial SIP INVITE requests for originations and terminations: + +- SIP INVITE requests routed to the IWF performing the participating role as a result of processing initial filter criteria at the S-CSCF in accordance with the termination procedures as specified in 3GPP TS 24.229 [3] and the Request-URI contains a PSI of the IWF performing the terminating participating role. Such requests are known as "SIP INVITE request for terminating participating MCPTT function" in the procedures in the present document; +- SIP INVITE requests routed to the IWF performing the controlling role as a result of PSI routing on the originating side in accordance with the originating procedures as specified in 3GPP TS 24.229 [3], or as a result of direct PSI routing, in accordance with the termination procedures as specified in 3GPP TS 24.229 [3], the Request-URI is set to a public service identity for MCPTT private call and the Contact header field does not contain the isfocus media feature tag specified in IETF RFC 3840 [9]. Such requests are known as "SIP INVITE request for controlling MCPTT function of a private call" in the procedures in the present document; +- SIP INVITE requests routed to the IWF performing the controlling role as a result of PSI routing on the originating side in accordance with the originating procedures as specified in 3GPP TS 24.229 [3], or as a result of direct PSI routing, in accordance with the termination procedures as specified in 3GPP TS 24.229 [3], the Request-URI is set to a public service identity serving an MCPTT group and the Contact header field does not contain the isfocus media feature tag specified in IETF RFC 3840 [9]. Such requests are known as "SIP INVITE request for controlling MCPTT function of an MCPTT group" in the procedures in the present document; and +- SIP INVITE requests routed to the IWF performing the non-controlling role of an MCPTT group as a result of direct PSI routing, in accordance with the termination procedures as specified in 3GPP TS 24.229 [3], the Request-URI is set to a public service identity serving an MCPTT group and the Contact header field contains the isfocus media feature tag specified in IETF RFC 3840 [9]; Such requests are known as "SIP INVITE request for non-controlling MCPTT function of an MCPTT group" in the procedures in the present document. + +#### 6.6.1.2 SIP MESSAGE request + +The IWF needs to distinguish between the following SIP MESSAGE request for originations and terminations: + +- SIP MESSAGE requests routed to the IWF performing the controlling role and containing a Content-Type header field set to "application/vnd.3gpp.mcptt-info+xml" and includes an XML body containing a root element with a element containing an element with the element set to a value of "remotely-initiated-group-call-request". Such requests are known as "SIP MESSAGE request for remotely initiated group call request for controlling MCPTT function"; +- SIP MESSAGE requests routed to the IWF performing the controlling role and containing a Content-Type header field set to "application/vnd.3gpp.mcptt-info+xml" and includes an XML body containing a root element with a element containing an element with the element + +set to a value of "remotely-initiated-group-call-response". Such requests are known as "SIP MESSAGE request for remotely initiated group call response for controlling MCPTT function"; + +- SIP MESSAGE requests routed to the IWF performing the terminating participating role as a result of initial filter criteria with the Request-URI set to the public service identity of the IWF performing the terminating participating role and containing a Content-Type header field set to "application/vnd.3gpp.mcptt-info+xml" and includes an XML body containing a root element with a element containing an element with the element set to a value of "remotely-initiated-group-call-request" or with the element set to a value of "remotely-initiated-group-call-response". Such requests are known as "SIP MESSAGE request for remotely initiated group call for terminating participating MCPTT function"; +- SIP MESSAGE requests routed to the IWF performing the terminating participating role with the Request-URI set to the public service identity of the IWF and containing a Content-Type header field set to "application/vnd.3gpp.mcptt-info+xml" and includes an XML body containing a root element containing a element containing an element or an <>alert-ind> element. Such requests are known as "SIP MESSAGE request for emergency notification for terminating participating MCPTT function" in the procedures in the present document; and +- SIP MESSAGE requests routed to the IWF performing the controlling role with the Request-URI set to the public service identity of the IWF and containing a Content-Type header field set to "application/vnd.3gpp.mcptt-info+xml" and includes an XML body containing a root element containing a element containing an element or an <>alert-ind> element. Such requests are known as "SIP MESSAGE request for emergency notification for controlling MCPTT function" in the procedures in the present document. + +## 6.6.2 IWF participating role + +### 6.6.2.1 Requests initiated by a participant homed in the IWF + +#### 6.6.2.1.1 SDP offer generation + +##### 6.6.2.1.1.1 On-demand session + +This clause is referenced from other clauses. + +The SDP offer generated by the IWF performing the participating role: + +- 1) shall contain only one SDP media-level clause for speech; and +- 2) shall contain an SDP media-level clause for one media-floor control entity. + +When composing the SDP offer according to 3GPP TS 24.229 [3], the IWF performing the participating role: + +- 1) shall insert the IP address and port number selected by the IWF performing the participating role for the media stream in the SDP offer; + +NOTE 1: Requirements can exist for the IWF performing the participating role to be always included in the path of the offered media stream, for example: for the support of features such as lawful interception and recording. Other examples can exist. + +- 2) shall insert the IP address and port number selected by the IWF performing the participating role for the offered media floor control entity, if any, in the received SDP offer; and +- 3) shall include an "m=audio" media-level clause for the media stream consisting of: + - a) the port number for the media stream selected; and + - b) the codec(s) and media parameters and attributes with the following clarification: + - i) if a call is being initiated to a group identity; and + - ii) if the IWF performing the participating role determines one or more preferred codecs; + +then the IWF: + +- i) shall include the name of the chosen codec in the field of the "a=rtpmap" attribute as defined in IETF RFC 4566 [8]; + - c) "i=" field set to "speech" according to 3GPP TS 24.229 [3]; +- 4) if floor control shall be used during the session, shall include an "m=application" media-level clause as specified in 3GPP TS 29.380 [31] clause 12 for a media-floor control entity, consisting of: + - a) the port number for the media-floor control entity selected as specified in 3GPP TS 29.380 [31]; and + - b) the 'fmt' attributes as specified in 3GPP TS 29.380 [31] clause 14; + - 5) if security between the IWF and the MCPTT system is required for a private call, shall include the MIKEY-SAKKE I\_MESSAGE in an "a=key-mgmt" attribute as a "mikey" attribute value in the SDP offer as specified in IETF RFC 4567 [22]; and + - 6) shall contain an "a=key-mgmt" attribute field with a "mikey" attribute value. + +NOTE: End-to-end security of voice traffic is supported through the use of Interworking Security Data messages specified in 3GPP TS 29.582 [33]. Through the use of these messages, an LMR system can communicate security information to the LMR functionality of a device on the MCPTT system. This will allow the use of LMR algorithms and keys for encrypting and decrypting voice packets within the device that can be transmitted to and received from the LMR system. + +#### 6.6.2.1.2 Sending an INVITE request + +This clause is referenced from other procedures. + +When generating an initial SIP INVITE request according to 3GPP TS 24.229 [3] the IWF performing the participating role: + +- 1) should include the Session-Expires header field according to IETF RFC 4028 [6]. It is recommended that the "refresher" header field parameter is omitted. If included, the "refresher" header field parameter shall be set to "uac"; +- 2) shall include the option tag "timer" in the Supported header field; +- 3) shall include in the P-Asserted-Identity header field the public service identity of the IWF performing the participating role; +- 4) shall include the g.3gpp.mcptt media feature tag into the Contact header; and +- 5) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcptt" (coded as specified in 3GPP TS 24.229 [3]), into the P-Asserted-Service header field. + +#### 6.6.2.1.3 IWF sending a SIP BYE request + +When the IWF is ending participation in an MCPTT session and decides to send a SIP BYE request, the IWF: + +- 1) shall interact with the media plane as specified in clause 6.4 in 3GPP TS 29.380 [31]; +- 2) shall generate a SIP BYE request as specified in 3GPP TS 24.229 [3]; +- 3) shall set the Request-URI to the MCPTT session identity of the MCPTT session; +- 4) shall set the P-Asserted-Identity header field of the outgoing SIP BYE request to the public service identity of the IWF; +- 5) may insert an application/vnd.3gpp.mcptt-info+xml MIME body into the outgoing SIP BYE request; and +- 6) shall send the SIP BYE request towards the controlling MCPTT function, according to 3GPP TS 24.229 [3]. + +Upon receiving a SIP 200 (OK) response to the SIP BYE request the IWF should complete any further actions necessary to dissociate the LMR user from the MCPTT session and shall interact with the media plane to release any + +resources as specified in clause 6.4 in 3GPP TS 29.380 [31] for releasing media plane resources associated with the SIP session with the controlling MCPTT function. + +#### 6.6.2.1.4 Priority call conditions + +##### 6.6.2.1.4.1 General + +The clauses of the parent clause contain common procedures to be used for MCPTT emergency group calls and MCPTT imminent peril group calls. + +##### 6.6.2.1.4.2 Determining authorisation for originating a priority group call + +When the IWF performing the participating role needs to send a request to originate an MCPTT emergency group call and needs to determine if the request is an authorised request for an MCPTT emergency call, the IWF performing the participating role shall check the following: + +- 1) if the IWF determines that the calling user is authorized for emergency-group-call; and +- 2) if the IWF determines that emergency-group-calls for the selected group are allowed; + +then the IWF performing the participating role shall consider the MCPTT emergency group call request to be an authorised request for an MCPTT emergency group call; + +In all other cases, the IWF performing the participating role shall consider the request to originate an MCPTT emergency group call to be an unauthorised request to originate an MCPTT emergency group call. + +NOTE 1: How the IWF authorizes a user to originate a priority group call is out of scope of the present document. + +When the IWF performing the participating role needs to send a request to originate an MCPTT imminent peril group call and needs to determine if the request is an authorised request for an MCPTT imminent peril group call the IWF performing the participating role shall check the following: + +- 1) if the IWF determines that the calling user is authorized for imminent peril call; and +- 2) if the IWF determines that imminent peril calls for the selected group are allowed; + +then the IWF performing the participating role shall consider the MCPTT imminent peril group call request to be an authorised request for an imminent peril group call; + +In all other cases, the IWF performing the participating role shall consider the request to originate an MCPTT imminent peril group call to be an unauthorised request to originate an MCPTT imminent peril call. + +NOTE 2: How the IWF authorizes a user to originate an imminent peril call is out of scope of the present document. + +##### 6.6.2.1.4.3 Determining authorisation for initiating or cancelling an MCPTT emergency alert + +If the IWF performing the participating role needs to send a SIP request for an MCPTT emergency alert and: + +- 1) if the calling user is authorized by the IWF to activate emergency alert; and +- 2) if the IWF allows emergency alert for the selected group; + +then the MCPTT emergency alert request shall be considered to be an authorised request for an MCPTT emergency alert. In all other cases, it shall be considered to be an unauthorised request for an MCPTT emergency alert. + +NOTE 1: How the IWF authorizes a user to originate a request for an MCPTT emergency alert is out of scope of the present document. + +If the IWF performing the participating role needs to send a SIP request to cancel an MCPTT emergency alert to an MCPTT group, and if the calling user is authorized by the IWF to cancel an emergency alert, then the MCPTT emergency alert cancellation request shall be considered to be an authorised request to cancel an MCPTT emergency alert. In all other cases, it shall be considered to be an unauthorised request to cancel an MCPTT emergency alert. + +NOTE 2: How the IWF authorizes a user to cancel an MCPTT emergency alert is out of scope of the present document. + +#### 6.6.2.1.4.4 Validate priority request parameters + +This clause is referenced from other procedures. + +To validate the combinations of , and which need to be sent in SIP requests, the IWF performing the participating role shall follow the procedures specified in 3GPP TS 24.379 [29], clause 6.3.3.1.17, with the IWF acting as the controlling function. + +#### 6.6.2.1.4.5 Retrieving Resource-Priority header field values + +This clause is referenced from other procedures. + +The IWF performing the participating role shall follow the procedures specified in clause 6.6.3.1.12 with the clarification that references in that procedure to the IWF performing the controlling role should be replaced with references to the IWF participating role. + +#### 6.6.2.1.5 Sending a SIP INVITE request on receipt of SIP 3xx response + +This clause is referenced from other procedures. + +Upon: + +- 1) having sent a SIP INVITE request to the controlling MCPTT function; and +- 2) having received a SIP 302 (Moved Temporarily) response from the controlling MCPTT function sent to the SIP INVITE request in step 1) with: + - a) a Contact header field containing a SIP-URI; and + - b) an application/vnd.3gpp.mcptt-info+xml MIME body with an element; + +the IWF performing the participating role: + +- 1) shall generate a SIP INVITE request with the Request-URI set to the contents of the Contact header field of the SIP 302 (Moved Temporarily) response; +- 2) shall include in the SIP INVITE request all Accept-Contact header fields and all Reject-Contact header fields, with their feature tags and their corresponding values along with parameters according to rules and procedures of IETF RFC 3841 [5] included in the original SIP INVITE request sent to the controlling MCPTT function; +- 3) should include the Session-Expires header field according to IETF RFC 4028 [6]. It is recommended that the "refresher" header field parameter is omitted. If included, the "refresher" header field parameter shall be set to "uac"; +- 4) shall include the option tag "timer" in the Supported header field; +- 5) shall set the P-Asserted-Identity header field of the outgoing SIP INVITE request to the contents of the P-Asserted-Identity header field of the original SIP INVITE request sent to the controlling MCPTT function; +- 6) shall include the g.3gpp.mcptt media feature tag into the Contact header field of the outgoing SIP INVITE request; +- 7) shall include the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcptt" in the Contact header field of the outgoing SIP INVITE request; +- 8) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcptt" (coded as specified in 3GPP TS 24.229 [3]), into the P-Asserted-Service header field of the outgoing SIP INVITE request; +- 9) shall copy the contents of the application/vnd.3gpp.mcptt-info+xml MIME body of the original SIP INVITE request sent to the controlling MCPTT function into the outgoing SIP INVITE request; + +- 10) shall copy the contents of the element of the application/vnd.3gpp.mcptt-info+xml MIME body received in the SIP 302 (Moved Temporarily) response, to the element of the application/vnd.3gpp.mcptt-info+xml MIME body of the outgoing SIP INVITE request; +- 11) shall set the element of the application/vnd.3gpp.mcptt-info+xml MIME body of the SIP INVITE request to the MCPTT ID of the calling user that was determined by the IWF performing the participating role; and +- 12) if the element is received in the application/vnd.3gpp.mcptt-info+xml MIME body of the SIP 3xx response, shall set the element of the application/vnd.3gpp.mcptt-info+xml MIME body of the SIP INVITE request to the value of the element received in the SIP 3xx response. + +## 6.6.2.2 Requests terminated to the IWF + +### 6.6.2.2.1 SDP offer generation + +The IWF performing the participating role shall follow the procedure in clause 6.6.2.1.1. + +### 6.6.2.2.2 SIP BYE request towards the terminating IWF + +#### 6.6.2.2.2.1 On-demand + +Upon receiving a SIP BYE request from the controlling MCPTT function, the IWF performing the participating role: + +- 1) shall interact with the media plane as specified in clause 6.4 in 3GPP TS 29.380 [31] for releasing media plane resource associated with the SIP session; and +- 2) shall send a SIP 200 (OK) response to the SIP BYE request received from the controlling MCPTT function according to 3GPP TS 24.229 [3]. + +## 6.6.3 IWF controlling role + +### 6.6.3.1 Requests initiated by the IWF performing the controlling role + +#### 6.6.3.1.1 Sending an INVITE request + +This clause is referenced from other procedures. + +The IWF performing the controlling role shall generate an initial SIP INVITE request according to 3GPP TS 24.229 [3]. + +The IWF performing the controlling role: + +- 1) shall include in the Contact header field an MCPTT session identity for the MCPTT session with the g.3gpp.mcptt media feature tag, the isfocus media feature tag and the g.3gpp.icsi-ref media feature tag with the value of "urn:urn-7:3gpp-service.ims.icsi.mcptt" according to IETF RFC 3840 [9]; +- 2) shall include an Accept-Contact header field containing the g.3gpp.mcptt media feature tag along with the "require" and "explicit" header field parameters according to IETF RFC 3841 [5]; +- 3) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcptt" (coded as specified in 3GPP TS 24.229 [3]), in a P-Asserted-Service-Id header field according to IETF RFC 6050 [7] in the SIP INVITE request; +- 4) shall include an Accept-Contact header field with the media feature tag g.3gpp.icsi-ref with the value of "urn:urn-7:3gpp-service.ims.icsi.mcptt" along with parameters "require" and "explicit" according to IETF RFC 3841 [5]; +- 5) shall include a Referred-By header field with the public service identity of the IWF; +- 6) should include the Session-Expires header field according to rules and procedures of IETF RFC 4028 [6]. The refresher parameter shall be omitted; +- 7) shall include the Supported header field set to "timer"; + +- 9) may include an unmodified Priv-Answer-Mode header field; +- 10) if the request will not contain a Priv-Answer-Mode header field, shall include an Answer-Mode header field; and +- 11) may include an application/vnd.3gpp.mcptt-info+xml MIME body in the outgoing INVITE request. + +#### 6.6.3.1.2 Sending a SIP BYE request + +When the IWF performing the controlling role needs to remove an MCPTT participant: + +- 1) shall interact with the media plane as specified in 3GPP TS 29.380 [31] for the MCPTT session release; +- 2) shall generate a SIP BYE request according to 3GPP TS 24.229 [3]; and +- 3) shall send the SIP BYE request to the MCPTT participants according to 3GPP TS 24.229 [3]. + +If timer TNG3 (group call timer) has not expired, then when the last participant is removed from the MCPTT session, the IWF performing the controlling role shall stop timer TNG3 (group call timer). + +When the MCPTT group session needs to be released, the IWF performing the controlling role shall send SIP BYE requests as described in this clause, to all MCPTT participants of the group session. + +Upon receiving a SIP 200 (OK) response to a SIP BYE request the IWF performing the controlling role shall interact with the media plane as specified in clause 6.3 in 3GPP TS 29.380 [31] for releasing media plane resources associated with the session with the MCPTT clients. + +#### 6.6.3.1.3 Sending a SIP re-INVITE request for MCPTT emergency group call + +This clause is referenced from other procedures. + +The IWF performing the controlling role shall generate a SIP re-INVITE request according to 3GPP TS 24.229 [3]. + +The IWF performing the controlling role: + +- 1) shall include an SDP offer with the media parameters as currently established with the terminating MCPTT client according to 3GPP TS 24.229 [3]; +- 2) shall include an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to the MCPTT ID of the initiating MCPTT user; +- 3) if the in-progress emergency group state of the group is set to a value of "true" the IWF performing the controlling role: + - a) shall include a Resource-Priority header field with the namespace populated with the values for an MCPTT emergency group call as specified in clause 6.6.3.1.12; + - b) shall include in the application/vnd.3gpp.mcptt-info+xml MIME body the element set to a value of "true"; + - c) if the received request included a request for an emergency alert and MCPTT emergency alerts are authorised for this group and MCPTT user as determined by the procedures of clause 6.6.3.1.8.1, shall populate the application/vnd.3gpp.mcptt-info+xml MIME body and application/vnd.3gpp.mcptt-location-info+xml MIME body as specified in clause 6.6.3.1.7. Otherwise, shall set the <>alert-ind> element to a value of "false" in the application/vnd.3gpp.mcptt-info+xml MIME body; and + - d) if the in-progress imminent peril state of the group is set to a value of "true" shall include in the application/vnd.3gpp.mcptt-info+xml MIME body an element set to a value of "false"; and + +NOTE: If the imminent peril state of the group is true at this point, the controlling function will be setting it to false as part of the calling procedure. This is in effect an upgrade of an MCPTT imminent peril group call to an MCPTT emergency group call. + +- 4) if the in-progress emergency group state of the group is set to a value of "false": + +- a) shall include a Resource-Priority header field populated with the values for a normal MCPTT group call as specified in clause 6.6.3.1.12; and +- b) if the received SIP re-INVITE request contained an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "false" and this is an authorised request to cancel an MCPTT emergency group call as determined by the procedures of clause 6.6.3.1.8.4: + - i) shall include an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "false"; and + - ii) if the received SIP re-INVITE request contained an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "false" and this is an authorised request to cancel an MCPTT emergency alert as determined by the procedures of 3GPP TS 24.379 [29], clause 6.3.3.1.15 with the IWF acting as the controlling function, shall: + - A) include in the application/vnd.3gpp.mcptt-info+xml MIME body an element set to a value of "false"; and + - B) if the received SIP request contains an element in the application/vnd.3gpp.mcptt-info+xml MIME body, copy the contents of the received element to an element in the application/vnd.3gpp.mcptt-info+xml MIME body in the outgoing SIP re-INVITE request. + +#### 6.6.3.1.4 Sending a SIP INVITE request for MCPTT emergency group call + +This clause is referenced from other procedures. + +This clause describes the procedures for inviting an MCPTT user to an MCPTT session associated with an MCPTT emergency group call or MCPTT imminent peril group call. The procedure is initiated by the IWF performing the controlling role as the result of an action in clause 10.2.3.1.1. + +The IWF performing the controlling role: + +- 1) shall generate a SIP INVITE request as specified in clause 6.6.3.1.1; +- 2) shall set the Request-URI to the address of the terminating participating MCPTT function associated with the MCPTT ID of the targeted MCPTT user; +- 3) shall include an application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element populated as follows: + - a) the element set to the value of the MCPTT ID of the targeted MCPTT user; + - b) the element set to the value of the MCPTT ID of the calling user; and + - c) the element set to the value of the MCPTT group ID of the emergency group call. +- 4) shall include in the P-Asserted-Identity header field the public service identity of the IWF performing the controlling role; +- 5) shall include in the SIP INVITE request an SDP offer according to the procedures specified in 3GPP TS 24.379 [29], clause 6.3.3.1.1, with the IWF acting as the controlling function; and +- 6) if the in-progress emergency group state of the group is set to a value of "true" the IWF performing the controlling role: + - a) shall include a Resource-Priority header field populated with the values for an MCPTT emergency group call as specified in clause 6.6.3.1.12; + - b) shall include in the application/vnd.3gpp.mcptt-info+xml MIME body an element set to a value of "true"; + - c) if + - i) the element is set to "true" in the received SIP INVITE request and the requesting MCPTT user and MCPTT group are authorised for the initiation of MCPTT emergency alerts as determined by the + +procedures of clause 6.6.3.1.8.1, shall populate the application/vnd.3gpp.mcptt-info+xml MIME body and the application/vnd.3gpp.mcptt-location-info+xml MIME body as specified in clause 6.6.3.1.7. Otherwise, shall set the element to a value of "false" in the application/vnd.3gpp.mcptt-info+xml MIME body; or + +- ii) the call request originated from the IWF, and the IWF decides to indicate an emergency alert, shall populate the application/vnd.3gpp.mcptt-info+xml MIME body and the application/vnd.3gpp.mcptt-location-info+xml MIME body as specified in clause 6.6.3.1.7. Otherwise, shall set the element to a value of "false" in the application/vnd.3gpp.mcptt-info+xml MIME body; +- d) if the in-progress imminent peril state of the group is set to a value of "true" shall include in the application/vnd.3gpp.mcptt-info+xml MIME body an element set to a value of "false"; and + +NOTE: If the imminent peril state of the group is true at this point, the controlling function will set it to false as part of the calling procedure. + +- 7) if the in-progress emergency state of the group is set to a value of "false" and the in-progress imminent peril state of the group is set to a value of "true", the IWF performing the controlling role: + - a) shall include a Resource-Priority header field populated with the values for an MCPTT imminent peril group call as specified in clause 6.6.3.1.12; and + - b) shall include in the application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "true". + +#### 6.6.3.1.5 Sending a SIP UPDATE request for Resource-Priority header field correction + +This clause is referenced from other procedures. + +This clause describes the procedures for updating an MCPTT session associated with an MCPTT emergency group call or MCPTT imminent peril group call when the received SIP INVITE request did not include a correctly populated Resource-Priority header field. The procedure is initiated by the IWF performing the controlling role for the purpose of providing the correct Resource-Priority header field. + +- 1) shall generate a SIP 183 (Session Progress) response according to 3GPP TS 24.229 [3] with the clarifications provided specified in 3GPP TS 24.379 [29], clause 6.3.3.2.3.1, with the IWF acting as the controlling function; +- 2) shall include the option tag "100rel" in a Require header field in the SIP 183 (Session Progress) response; +- 3) shall include in the SIP 183 (Session Progress) response an SDP answer to the SDP offer in the incoming SIP INVITE request as specified in 3GPP TS 24.379 [29], clause 6.3.3.2.1, with the IWF acting as the controlling MCPTT function; and +- 4) shall send the SIP 183 (Session Progress) response towards the MCPTT client according to 3GPP TS 24.229 [3]. + +Upon receiving a SIP PRACK request to the SIP 183 (Session Progress) response the IWF performing the controlling role: + +- 1) shall send the SIP 200 (OK) response to the SIP PRACK request according to 3GPP TS 24.229 [3]. +- 2) shall generate a SIP UPDATE request according to 3GPP TS 24.229 [3] with the following clarifications: +- 3) shall include in the SIP UPDATE request an SDP offer based on the SDP offer in the received SIP INVITE request from the originating network according to the procedures specified in 3GPP TS 24.379 [29], clause 6.3.3.1.1, with the IWF acting as the controlling function; +- 4) if the in-progress emergency group state of the group is set to a value of "true" the IWF performing the controlling role shall include a Resource-Priority header field populated for an MCPTT emergency group call as specified in clause 6.6.3.1.12; and + +NOTE 1: This is the case when the sending MCPTT client did not send a Resource-Priority header field populated appropriately to receive emergency-level priority. In this case, the Resource-Priority header field is populated appropriately to provide emergency-level priority. + +- 5) if the in-progress emergency group state of the group is set to a value of "false" the IWF performing the controlling role: + - a) if the in-progress imminent peril state of the group is set to a value of "false", shall include a Resource-Priority header field populated for a normal priority MCPTT group call as specified in clause 6.6.3.1.12; and + - b) if the in-progress imminent peril state of the group is set to a value of "true", shall include a Resource-Priority header field populated for an MCPTT imminent peril group call as specified in clause 6.6.3.1.12. + +NOTE 2: This is the case when the sending MCPTT client incorrectly populated a Resource-Priority header field for emergency-level or imminent peril-level priority and the controlling MCPTT function re-populates it as appropriate to an imminent peril level priority or normal priority level. + +#### 6.6.3.1.6 Generating a SIP re-INVITE request to cancel an in-progress emergency + +This clause is referenced from other procedures. + +This clause describes the procedures for generating a SIP re-INVITE request to cancel the in-progress emergency state of a group. The procedure is initiated by the IWF performing the controlling role when it determines the cancellation of the in-progress emergency state of a group is required. + +The IWF performing the controlling role: + +- 1) shall generate a SIP re-INVITE request as specified in 3GPP TS 24.229 [3] with the clarifications specified in 3GPP TS 24.379 [29] clause 6.3.3.1.9, with the IWF acting as the controlling function; +- 2) shall include a Resource-Priority header field populated with the values for a normal MCPTT group call as specified in clause 6.6.3.1.12; and +- 3) shall include an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "false". + +#### 6.6.3.1.7 Populate mcptt-info and location-info MIME bodies for emergency alert + +This clause is referenced from other procedures. + +This clause describes the procedures for populating the application/vnd.3gpp.mcptt-info+xml and application/vnd.3gpp.mcptt-location-info+xml MIME bodies for an MCPTT emergency alert. The procedure is initiated by the IWF performing the controlling role when it has received request initiating an MCPTT emergency alert and generates a message containing the MCPTT emergency alert information required by 3GPP TS 23.379 [2]. + +The IWF performing the controlling role: + +- 1) shall include, if not already present, an application/vnd.3gpp.mcptt-info+xml MIME body as specified in 3GPP TS 24.379 [29], clause F.1, and set the element to a value of "true"; +- 2) shall determine the value of the user's Mission Critical Organization identity. + +NOTE: How the IWF determines the user's Mission Critical Organization identity is out of scope of the present document; + +- 3) shall include in the element containing the element containing an element set to the value of the user's Mission Critical Organization identity; and +- 4) shall include an application/vnd.3gpp.mcptt-location-info+xml MIME body in the outgoing SIP request. + +#### 6.6.3.1.8 Authorisations + +##### 6.6.3.1.8.1 Determining authorisation for initiating an MCPTT emergency alert + +If the IWF performing the controlling role has received a SIP request targeted to an MCPTT group with the element of the application/vnd.3gpp.mcptt-info+xml MIME body set to a value of "true", the IWF performing the controlling role shall check the following conditions: + +- 1) if the user is authorized by the IWF to initiate an emergency alert; and +- 2) if the IWF allows emergency alerts on the group; + +then the MCPTT emergency alert request shall be considered to be an authorised request for an MCPTT emergency alert targeted to an MCPTT group. In all other cases, the MCPTT emergency alert request shall be considered to be an unauthorised request for an MCPTT emergency alert targeted to an MCPTT group. + +NOTE 1: How the IWF authorizes a user to initiate alerts and how the IWF decides to allow emergency alerts on a group is out of scope of the present document. + +If the IWF performing the controlling role has received a SIP request targeted to a user with the element of the application/vnd.3gpp.mcptt-info+xml MIME body set to a value of "true", the IWF performing the controlling role shall check the following condition: + +- 1) if the calling user is authorized by the IWF for emergency alerts; + +then the MCPTT emergency alert request shall be considered to be an authorised request for an MCPTT emergency alert targeted to a user. In all other cases, it shall be considered to be an unauthorised request for an MCPTT emergency alert targeted to a user. + +NOTE 2: How the IWF authorizes a user to initiate alerts to other users is out of scope of the present document. + +NOTE 3: How the IWF determines relevant contents of the MCPTT user profile document is out of scope of the present document. + +NOTE 4: How and whether the IWF obtains user profile information for MCPTT users, and whether the MCPTT system needs access to IWF user profile information is not specified in the present document. + +#### 6.6.3.1.8.2 Determining authorisation for initiating an MCPTT emergency group or private call + +If the IWF performing the controlling role has received a SIP request for an MCPTT group call with the element of the application/vnd.3gpp.mcptt-info+xml MIME body set to a value of "true" and: + +- 1) if the MCPTT user is authorized by the IWF to initiate emergency calls and if the group is configured to allow emergency calls, then the IWF performing the controlling role shall consider the MCPTT emergency group call request to be an authorised request for an MCPTT emergency group call and skip the remaining step; or + +NOTE 1: How the IWF determines whether the user is authorized to initiate an emergency group call and whether the group supports emergency calls is out of scope of the current document. + +- 2) if the IWF performing the controlling role does not consider the MCPTT emergency group call request to be an authorised request for an MCPTT emergency group call by step 1) above, then the IWF performing the controlling role shall consider the MCPTT emergency group call request to be an unauthorised request for an MCPTT emergency group call. + +If the IWF performing the controlling role has received a SIP request for an MCPTT private call with the element of the application/vnd.3gpp.mcptt-info+xml MIME body set to a value of "true", the IWF performing the controlling role determines whether the user is authorized to initiate an emergency private call. + +NOTE 2: How the IWF determines whether the user is authorized to initiate an emergency private call is out of scope of the current document. + +NOTE 3: How the IWF determines relevant contents of the MCPTT user profile document is out of scope of the present document. + +NOTE 4: How and whether the IWF obtains user profile information for MCPTT users, and whether the MCPTT system needs access to IWF user profile information is not specified in the present document. + +#### 6.6.3.1.8.3 Determining authorisation for cancelling an MCPTT emergency alert + +If the IWF performing the controlling role has received a SIP request with the element of the application/vnd.3gpp.mcptt-info+xml MIME body set to a value of "false", the IWF may authorize the MCPTT emergency alert cancellation. + +NOTE: How the IWF determines whether to authorize a user to cancel an emergency alert is out of scope of the present document. + +#### 6.6.3.1.8.4 Determining authorisation for cancelling an MCPTT emergency group or private call + +If the IWF performing the controlling role has received a SIP request for an MCPTT group call with the element of the application/vnd.3gpp.mcptt-info+xml MIME body set to a value of "false", the IWF may authorize the MCPTT emergency group call cancellation request. + +NOTE 1: How the IWF determines whether to authorize a user to cancel a group call emergency is out of scope of the present document. + +If the IWF performing the controlling role has received a SIP request for an MCPTT private call with the element of the application/vnd.3gpp.mcptt-info+xml MIME body set to a value of "false", the IWF may authorize the MCPTT emergency private call cancellation request. + +NOTE 2: How the IWF determines whether to authorize a user to cancel a private call emergency is out of scope of the present document. + +#### 6.6.3.1.8.5 Determining authorisation for initiating an MCPTT imminent peril call + +If the IWF performing the controlling role has received a SIP request with the element of the application/vnd.3gpp.mcptt-info+xml MIME body set to a value of "true"; and + +- 1) if the MCPTT user is authorized by the IWF performing the controlling role to initiate an imminent peril call; and +- 2) if the IWF allows the group to support imminent peril calls; + +NOTE 1: How the IWF authorizes the user to initiate imminent peril calls and how the IWF determines whether to allow imminent peril calls on a group is out of scope of the present document. + +then the MCPTT imminent peril call request shall be considered to be an authorised request for an MCPTT imminent peril call. In all other cases, it shall be considered to be an unauthorised request for an MCPTT imminent peril call. + +NOTE 2: How the IWF determines relevant contents of the MCPTT user profile document is out of scope of the present document. + +NOTE 3: How and whether the IWF obtains user profile information for MCPTT users, and whether the MCPTT system needs access to IWF user profile information is not specified in the present document. + +#### 6.6.3.1.8.6 Determining authorisation for cancelling an MCPTT imminent peril call + +If the IWF performing the controlling role has received a SIP request with the element of the application/vnd.3gpp.mcptt-info+xml MIME body set to a value of "false", the IWF may authorize the MCPTT imminent peril call cancellation request. + +NOTE: How the IWF determines whether to authorize a user to cancel an imminent peril call is out of scope of the present document. + +#### 6.6.3.1.8.7 Sending a SIP OPTIONS request to authorise an MCPTT user at a non-controlling MCPTT function of a MCPTT group + +This clause is referenced from other procedures. + +The IWF performing the controlling role: + +- 1) if the element is included in the application/vnd.3gpp.mcptt-info+xml MIME body of the incoming SIP INVITE request, shall generate a SIP OPTIONS request according to 3GPP TS 24.229 [3] and the IETF RFC 3261 [14] populated as follows: + - a) shall set the Request-URI to the public service identity of the non-controlling MCPTT function associated with the MCPTT Group ID which was present in the element in the application/vnd.3gpp.mcptt-info+xml MIME body of the incoming SIP INVITE request; + +NOTE 1: How the IWF performing the controlling role finds the address of the non-controlling MCPTT function is out of the scope of the current release. + +- b) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcptt" (coded as specified in 3GPP TS 24.229 [3]), in a P-Asserted-Service-Id header field according to IETF RFC 6050 [7]; + - c) shall include in the P-Asserted-Identity header field, the public service identity of the IWF performing the controlling role; + - d) shall include an application/vnd.3gpp.mcptt-info+xml MIME body where: + - i) the element shall be set to the value of the element in the application/vnd.3gpp.mcptt-info+xml MIME body of the incoming SIP INVITE request; and + - ii) the element is set to the same value as in the element in the application/vnd.3gpp.mcptt-info+xml MIME body of the incoming SIP INVITE request; + - e) shall include the following in the Contact header field: + - i) the g.3gpp.mcptt media feature tag; and + - ii) the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcptt"; and + - f) send the SIP OPTIONS request as specified in 3GPP TS 24.229 [3]; and +- 2) if the element is not included in the application/vnd.3gpp.mcptt-info+xml MIME body of the incoming SIP INVITE request, shall for each constituent MCPTT group not homed in the IWF performing the controlling role generate a SIP OPTIONS request according to 3GPP TS 24.229 [3] and IETF RFC 3261 [14] populated as follows: +- a) shall set the Request-URI to the public service identity of the non-controlling MCPTT function associated with the MCPTT group ID of the constituent group; + +NOTE 2: How the IWF performing the controlling role finds the address of the non-controlling MCPTT function is out of the scope of the current release. + +- b) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcptt" (coded as specified in 3GPP TS 24.229 [3]), in a P-Asserted-Service-Id header field according to IETF RFC 6050 [7]; +- c) shall include in the P-Asserted-Identity header field, the public service identity of the IWF performing the controlling role; +- d) shall include an application/vnd.3gpp.mcptt-info+xml MIME body where: + - i) the element shall be set to the MCPTT group ID of the constituent group; and + - ii) the element is set to the same value as in the element in the application/vnd.3gpp.mcptt-info+xml MIME body of the incoming SIP INVITE request; +- e) shall include the following in the Contact header field: + - i) the g.3gpp.mcptt media feature tag; and + - ii) the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcptt"; and +- f) send the SIP OPTIONS request as specified in 3GPP TS 24.229 [3]. + +Upon receipt of the first SIP 200 (OK) response to the SIP OPTIONS request with the mcptt-warn-code set to "147" in a Warning header field as specified in 3GPP TS 24.379 [29] clause 4.4, the IWF acting as the controlling function shall return a SIP 302 (Moved Temporarily) response to the "SIP INVITE request for controlling MCPTT function of an MCPTT group" populated as follows: + +- 1) the URI in the Contact header field set to the P-Asserted-Identity received in the SIP 200 (OK) response; +- 2) an application/vnd.3gpp.mcptt-info MIME body with: + +- a) the element set to the same value as received in the in the SIP 2xx response to the SIP OPTIONS request; and + - b) the element set to the value received in the element in the application/vnd.3gpp.mcptt.info+xml MIME body of the received SIP 2xx response to the SIP OPTIONS request; and +- 3) if more than one OPTIONS request were sent, shall remove any cached SIP response and ignore any other responses to any other OPTIONS request. + +Upon receipt of a SIP 404 (Not Found) response to the SIP OPTIONS request such that the mcptt-warn-code set to "113" in a Warning header field as specified in 3GPP TS 24.379 [29] clause 4.4, with the IWF acting as the controlling function: + +- 1) if more than one SIP OPTIONS request were sent and if no other responses to SIP OPTIONS request are expected; shall send a SIP 404 (Not Found) response to "SIP INVITE request for controlling MCPTT function of an MCPTT group" and include the Warning header field received in the SIP 404 (Not Found) response; and +- 2) if more than one OPTIONS request were sent and other responses to SIP OPTIONS request are expected, shall cache the received SIP 404 (Not Found) response. + +Upon receipt of a SIP 403 (Forbidden) response to the SIP OPTIONS request, the mcptt-warn-code set to "106" or "109" in a Warning header field as specified in 3GPP TS 24.379 [29] clause 4.4, with the IWF acting as the MCPTT server, and if more than one OPTIONS request were sent and if no other responses to the SIP OPTIONS request are expected, the IWF performing the controlling role: + +- 1) if a SIP 404 (Not Found) response is cached, send a SIP 404 (Not Found) response to "SIP INVITE request for controlling MCPTT function of an MCPTT group" and include the Warning header field received in the SIP 404 (Not Found) response; and +- 2) if a SIP 404 (Not Found) response is not cached, shall return a SIP 403 (Forbidden) response to "SIP INVITE request for controlling MCPTT function of an MCPTT group" and include the Warning header field received in the SIP 403 (Forbidden) response. + +Upon receipt of any other response to the SIP OPTIONS response than specified above and if more than one OPTIONS request were sent and if no other responses to the SIP OPTIONS request are expected, the IWF performing the controlling role: + +- 1) if a SIP 404 (Not Found) response is cached, send a SIP 404 (Not Found) response to "SIP INVITE request for controlling MCPTT function of an MCPTT group" and include the Warning header field received in the SIP 404 (Not Found) response; and +- 2) if a SIP 404 (Not Found) response is not cached, shall return a SIP 403 (Forbidden) response to "SIP INVITE request for controlling MCPTT function of an MCPTT group". + +NOTE 3: The reason for selecting the SIP 404 (Not Found) response when a SIP 404 (Not Found) response is cached is to indicate that it was a valid request but the MCPTT user identified in the is not a member of any of the constituent MCPTT groups in the temporary group. + +#### 6.6.3.1.9 Generating a SIP 403 response for priority call request rejection + +If the IWF performing the controlling role has received a SIP request with the element of the application/vnd.3gpp.mcptt-info+xml MIME body is set to "true" and this is an unauthorised request for an MCPTT emergency call as determined by the procedures of clause 6.6.3.1.8.2, the controlling MCPTT function shall: + +- 1) include in the SIP 403 (Forbidden) response an application/vnd.3gpp.mcptt-info+xml MIME body as specified in 3GPP TS 24.379 [29], clause F.1 with the element containing the element with the . + +#### 6.6.3.1.10 Handling the expiry of timer TNG2 (in-progress emergency group call timer) + +Upon expiry of timer TNG2 (in-progress emergency group call timer) for an MCPTT group, the IWF performing the controlling role: + +- 1) shall set the in-progress emergency state of the group to a value of "false"; +- 2) shall, if an MCPTT group call or MCPTT group session is in progress on the indicated group, for each of the participating members: + - a) generate a SIP re-INVITE request as specified in clause 6.6.3.1.6; and + - b) send the SIP re-INVITE request towards the MCPTT client according to 3GPP TS 24.229 [3]; and +- 3) shall for each affiliated but non-participating member of the group: + - a) generate a SIP MESSAGE request according to 3GPP TS 24.379 [29] clause 6.3.3.1.11, with the IWF acting as the controlling function and include in the application/vnd.3gpp.mcptt-info+xml MIME body an element set to a value of "false"; + - b) shall include in the P-Asserted-Identity header field the public service identity of the controlling MCPTT function; + - c) include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcptt" (coded as specified in 3GPP TS 24.229 [3]), in a P-Asserted-Service-Id header field according to IETF RFC 6050 [7]; and + - d) send the SIP MESSAGE request towards the MCPTT client according to rules and procedures of 3GPP TS 24.229 [3]. + +Upon receiving a SIP 200 (OK) response to a re-SIP INVITE request the IWF performing the controlling role shall interact with the media plane as specified in 3GPP TS 29.380 [31]. + +#### 6.6.3.1.11 Sending a SIP INFO request in the dialog of a SIP request for a priority call + +This clause is referenced from other procedures and describes how the IWF performing the controlling role generates a SIP INFO request due to the receipt of a SIP request for a priority call. + +The IWF performing the controlling role: + +- 1) shall generate a SIP INFO request according to rules and procedures of 3GPP TS 24.229 [3] and IETF RFC 6086 [26]; +- 2) shall include the Info-Package header field set to g.3gpp.mcptt-info in the SIP INFO request; +- 3) shall include an application/vnd.3gpp.mcptt-info+xml MIME body in the SIP INFO request and: + - a) if the received SIP request contained application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "true" and this is an unauthorised request for an MCPTT emergency alert as specified in clause 6.6.3.1.8.1, shall set the element to a value of "true" and the element to a value of "false"; + - b) if the received SIP request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "false" and if this is an unauthorised request for an MCPTT emergency alert cancellation, shall set element to a value of "true"; and + - c) if the received SIP request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "true", this is an authorised request for an MCPTT imminent peril group call and the in-progress emergency state of the group is set to a value of "true", shall set the element to a value of "false" and the element set to a value of "true"; and +- 4) shall send the SIP INFO request towards the inviting MCPTT client in the dialog created by the SIP request from the inviting MCPTT client, as specified in 3GPP TS 24.229 [3]. + +#### 6.6.3.1.12 Retrieving Resource-Priority header field values + +This clause is referenced from other procedures. + +The IWF performing the controlling role may populate the Resource-Priority header field to assist interworked MC systems in setting bearer priorities. The IWF can set emergency, imminent peril and normal priorities for private and group calls. The priority values and namespaces are as specified in IETF RFC 8101 [23]. + +NOTE: How the IWF obtains the values for Resource-Priority header fields is out of scope of the present document. + +### 6.6.3.2 Requests terminated by the IWF performing the controlling role + +#### 6.6.3.2.1 Receiving a SIP BYE request + +Upon receiving a SIP BYE request the IWF performing the controlling role: + +- 1) shall interact with the media plane as specified in clause 6.3 in 3GPP TS 29.380 [31] for releasing the media plane resource associated with the SIP session towards the MCPTT client; + +NOTE: The IWF performing the non-controlling role is also regarded as a MCPTT client in a temporary MCPTT group session. + +- 2) shall generate a SIP 200 (OK) response and send the SIP response towards the MCPTT client according to 3GPP TS 24.229 [3]; +- 3) shall check the MCPTT session release policy as specified in clause 6.6.7.1 and clause 6.6.7.2 whether the MCPTT session needs to be released for each participant of the MCPTT session; +- 4) if release of the MCPTT session is required: + - a) shall perform the procedures as specified in the clause 6.6.3.1.2 with the clarification that if the received SIP BYE request contains an application/vnd.3gpp.mcptt-info+xml MIME body, copy the application/vnd.3gpp.mcptt-info+xml MIME body into the outgoing SIP BYE request; and +- 5) if a release of the MCPTT session is not required: + - a) shall send a SIP NOTIFY request to all remaining MCPTT clients in the MCPTT session with a subscription to the conference event package as specified in 3GPP TS 24.379 [29], clause 10.1.3.4.2 with the IWF acting as the controlling MCPTT function. + +Upon receiving a SIP 200 (OK) response to the SIP BYE request the IWF performing the controlling shall interact with the media plane as specified in clause 6.3 in 3GPP TS 29.380 [31] for releasing media plane resources associated with the SIP session with the MCPTT participant. + +### 6.6.3.3 Handling of the acknowledged call setup timer (TNG1) + +When the IWF performing the controlling role receives a SIP INVITE request to initiate a group session and there are members of the group that are affiliated and are deemed by the IWF to be required for the call, then the IWF performing the controlling role shall start timer TNG1 (acknowledged call setup timer), prior to sending out SIP INVITE requests inviting group members to the group session. + +NOTE 1: How the IWF obtains the value of the TNG1 timer is out of scope of the present document. + +NOTE 2: How the IWF determines the required participants for the call, whether to require certain participants for the call or whether to require a certain number of participants for the call is out of scope of the present document. + +When the IWF performing the controlling role receives all SIP 200 (OK) responses to the SIP INVITE requests, from all affiliated and required members then the IWF performing the controlling role shall stop timer TNG1 (acknowledged call setup timer) and if the local counter of the number of SIP 200 (OK) responses received from invited members is greater than or equal to the required number of participants, the IWF performing the controlling role shall send a SIP 200 (OK) response to the initiating MCPTT client and shall interact with the media plane as specified in 3GPP TS 29.380 [31]. + +NOTE 3: MCPTT clients that are affiliated but are not required members that have not yet responded will be considered as joining an ongoing session when the IWF performing the controlling role receives SIP 200 (OK) responses from these MCPTT clients. + +After expiry of timer TNG1 (acknowledged call setup timer) and the local counter of the number of SIP 200 (OK) responses received from invited members is less than the value required by the IWF performing the controlling role, then the IWF performing the controlling role shall wait until further responses have been received from invited clients and the value of the local counter of the number of SIP 200 (OK) responses received from invited members is equal to the number required by the IWF performing the controlling role, before continuing with the timer TNG1 expiry procedures in this clause. + +After expiry of timer TNG1 (acknowledged call setup timer) and the local counter of the number of SIP 200 (OK) responses received from invited members is greater or equal to the number required by the IWF performing the controlling role, the IWF performing the controlling role shall execute the steps described below: + +- 1) if the IWF is configured to "proceed" with the setup of the group call, then the IWF performing the controlling role: + - a) shall perform the following actions: + - i) generate a SIP 200 (OK) response to the SIP INVITE request as specified in the 3GPP TS 24.379 [29] clause 6.3.3.2.2 before continuing with the rest of the steps; + - ii) include in the SIP 200 (OK) response the warning text set to "111 group call proceeded without all required group members" in a Warning header field as specified in 3GPP TS 24.379 [29] clause 4.4, with the IWF acting as the MCPTT server MCPTT function; + - iii) include in the SIP 200 (OK) response an SDP answer to the SDP offer in the incoming SIP INVITE request as specified in the 3GPP TS 24.379 [29] clause 6.3.3.2.1, with the IWF acting as the controlling MCPTT function; + - iv) interact with the media plane as specified in 3GPP TS 29.380 [31]; and + +NOTE 4: Resulting media plane processing is completed before the next step is performed. + +- v) send a SIP 200 (OK) response to the inviting MCPTT client according to 3GPP TS 24.229 [3]; + - b) when a SIP 200 (OK) response to a SIP INVITE request is received from an invited MCPTT client the IWF performing the controlling role may send an in-dialog SIP MESSAGE request to the MCPTT client that originated the group session with the text "group call proceeded without all required group members"; + - c) when the IWF performing the controlling role receives a SIP BYE request from an invited MCPTT client, shall take the actions specified in clause 6.6.3.2.1 and may send an in-dialog SIP MESSAGE request to the MCPTT client that originated the group session with the text "group call proceeded without all required group members"; and + - d) shall generate a notification package as specified in clause 6.6.3.4 and send a SIP NOTIFY request according to 3GPP TS 24.229 [3] to the MCPTT clients which have subscribed to the conference event package; and + +- 2) if the IWF is configured to "abandon" the setup of the group call, then the IWF performing the controlling role shall: + - a) send a SIP 480 (Temporarily Unavailable) response to the MCPTT client that originated the group session with the warning text set to "112 group call abandoned due to required group members not part of the group session" in a Warning header field as specified in 3GPP TS 24.379 [29] clause 4.4, with the IWF acting as the MCPTT server; + - b) for each confirmed dialog at the IWF performing the controlling role, send a SIP BYE request towards the MCPTT clients invited to the group session in accordance with 3GPP TS 24.229 [3] and interact with the media plane as specified in 3GPP TS 29.380 [31]; and + - c) for each non-confirmed dialog at the IWF performing the controlling role, send a SIP CANCEL request towards the MCPTT clients invited to the group session in accordance with 3GPP TS 24.229 [3]. + +If the IWF performing the controlling role receives a final SIP 4xx, 5xx or 6xx response from an affiliated and required group member prior to expiry of timer TNG1 (acknowledged call setup timer) and based on policy, the IWF performing the controlling role decides not to continue with the establishment of the group call without the affiliated and required group member, then the IWF performing the controlling role: + +NOTE 5: It is expected that this action is taken if the policy is to abandon the call on expiry of timer TNG1 (acknowledged call setup timer). + +- 1) shall stop timer TNG1 (acknowledged call setup timer); and +- 2) shall forward the final SIP 4xx, 5xx or 6xx response towards the inviting MCPTT client with the warning text set to "112 group call abandoned due to required group member not part of the group session" in a Warning header field as specified in 3GPP TS 24.379 [29] clause 4.4, with the IWF acting as the MCPTT server. + +If: + +- 1) the IWF performing the controlling role receives a final SIP 4xx, 5xx or 6xx response from an affiliated and required group member prior to expiry of timer TNG1 (acknowledged call setup timer); +- 2) the local counter of the number of SIP 200 (OK) responses received from invited members is greater than or equal to the required number of participants; and +- 3) based on policy, the IWF performing the controlling role decides to continue with the establishment of the group call without the affiliated and required group member; + +then the IWF performing the controlling role: + +NOTE 6: It is expected that this action is taken if the policy is to proceed with the call on expiry of timer TNG1 (acknowledged call setup timer). + +- 1) if all other invited clients have not yet responded, shall continue running timer TNG1 (acknowledged call setup timer); and +- 2) if all other invited clients have responded with SIP 200 (OK) responses, shall + - a) stop timer TNG1 (acknowledged call setup timer); + - b) generate SIP 200 (OK) response to the SIP INVITE request as specified in the 3GPP TS 24.379 [29] clause 6.3.3.2.2 before continuing with the rest of the steps; + - c) include in the SIP 200 (OK) response the warning text set to "111 group call proceeded without all required group members" in a Warning header field as specified in 3GPP TS 24.379 [29] clause 4.4, with the IWF acting as the MCPTT server; + - d) include in the SIP 200 (OK) response an SDP answer to the SDP offer in the incoming SIP INVITE request as specified in the 3GPP TS 24.379 [29] clause 6.3.3.2.1, with the IWF acting as the controlling MCPTT function; + - e) interact with the media plane as specified in 3GPP TS 29.380 [31]; and + +NOTE 7: Resulting media plane processing is completed before the next step is performed. + +- f) send a SIP 200 (OK) response to the inviting MCPTT client according to 3GPP TS 24.229 [3]. + +#### 6.6.3.4 Generating a SIP NOTIFY request + +The IWF performing the controlling role shall generate a SIP NOTIFY request according to 3GPP TS 24.229 [3] with the clarification in this clause. + +In the SIP NOTIFY request, the IWF performing the controlling role: + +- 1) shall set the P-Asserted-Identity header field to the public service identity of the IWF performing the controlling role; +- 2) shall include an Event header field set to "conference"; +- 3) shall include an Expires header field set to 3600 seconds according to IETF RFC 4575 [15], as default value; +- 4) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcptt" (coded as specified in 3GPP TS 24.229 [3]), in a P-Preferred-Service header field according to IETF RFC 6050 [7]; and + +- 5) shall include an application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with: + - a) the set to the value of the MCPTT group ID; + - b) if the target is a MCPTT user, the value of element set to the value of MCPTT ID of the targeted MCPTT user; and + - c) if the target is the non-controlling MCPTT function, the value of element set to the constituent MCPTT group ID. + +In the SIP NOTIFY request, the IWF performing the controlling role shall include an application/conference-info+xml MIME body according to IETF RFC 4575 [15] with the following limitations: + +- 1) the IWF performing the controlling role shall include the MCPTT group ID of the MCPTT group in the "entity" attribute of the element; +- 2) for each non-IWF connected participant in the MCPTT session with the exception of non-controlling MCPTT functions, the IWF performing the controlling role shall include a element. The element: + +NOTE 1: Non-controlling MCPTT functions will appear as a participant in temporary group sessions. + +- a) shall include the "entity" attribute. The "entity" attribute: + - i) shall for the MCPTT client, which initiated, joined or re-joined an MCPTT session, include the MCPTT ID of the user that originated the request; and + - ii) shall for an invited MCPTT client include the MCPTT ID of the invited MCPTT user in case of a prearranged group call or chat group call; +- b) shall include a single element. The element: + - i) shall include the "entity" attribute; and + - ii) shall include the element indicating the status of the MCPTT session according to IETF RFC 4575 [14]; and +- c) may include the element. + +NOTE 2: The usage of is only applicable for human consumption. + +### 6.6.3.5 Handling of the group call timer (TNG3) + +#### 6.6.3.5.1 General + +When the IWF performing the controlling role receives a SIP INVITE request to initiate a group session, then after an MCPTT session identity has been allocated for the group session, the IWF performing the controlling role shall start timer TNG3 (group call timer). + +NOTE 1: How the IWF determines the value of the TNG3 timer is out of scope of the present document. + +If the IWF does not have a TNG3 timer value, then the IWF performing the controlling role shall not start timer TNG3 (group call timer). + +NOTE 2: The group call timer is mandated for a pre-arranged group and is optional for a chat group. + +When merging two or more active group calls into a temporary group call, if the IWF is hosting at least one of the active group calls shall stop timer TNG3 (group call timer) for each hosted group call, and the IWF performing the controlling role hosting the temporary group call shall start timer TNG3 (group call timer) for the temporary group call. + +NOTE 3: MCPTT server(s) other than the IWF that are hosting the independent active group calls become non-controlling MCPTT function(s) of an MCPTT group, for the temporary group call. + +When splitting a temporary group call into independent group calls, the IWF performing the controlling role hosting the temporary group call shall stop timer TNG3 (group call timer) and the controlling MCPTT function(s) hosting the independent group calls shall start TNG3 (group call timer) for each group call. + +When the last MCPTT client leaves the MCPTT session, the IWF performing the controlling role shall stop timer TNG3 (group call timer). + +On expiry of timer TNG3 (group call timer), the IWF performing the controlling role shall release the MCPTT session by following the procedures in clause 6.6.3.1.2; + +#### 6.6.3.5.2 Interaction with the in-progress emergency group call timer (TNG2) + +If the IWF performing the controlling role starts timer TNG2 (in-progress emergency group call timer), it shall not start timer TNG3 (group call timer). + +If timer TNG3 (group call timer) is running and the MCPTT group call is upgraded to an MCPTT emergency group call, then the IWF performing the controlling role shall stop timer TNG3 (group call timer) and shall start timer TNG2 (in-progress emergency group call timer). If timer TNG2 (in-progress emergency group call timer) is running and the MCPTT emergency group call is cancelled, then the IWF performing the controlling role shall stop timer TNG2 (in-progress emergency group call timer) and shall start timer TNG3 (group call timer). + +NOTE 1: How the IWF determines the value of the TNG2 and TNG3 timers is out of scope of the present document. + +If timer TNG2 (in-progress emergency group call timer) is running and sequentially expires, then the controlling MCPTT function shall start timer TNG3 (group call timer). + +NOTE 2: The above conditions for starting timer TNG2 (in-progress emergency group call timer) and timer TNG3 (group call timer) also apply in the case that these timers are re-started. For example: the case where the timer TNG3 was initially running, the MCPTT group call is upgraded to an MCPTT emergency group call and then the MCPTT emergency group call is cancelled. + +### 6.6.4 IWF non-controlling role + +#### 6.6.4.1 Request initiated by the IWF performing the non-controlling role of a group + +##### 6.6.4.1.1 SDP offer generation + +The SDP offer is generated based on the received SDP offer to be sent to MCPTT clients that are a member of the group homed in the IWF. The SDP offer generated by the IWF performing the non-controlling role of a group: + +- 1) shall include only one SDP media-level clause for speech as contained in the received SDP offer; and +- 2) shall include an SDP media-level clause for one media-floor control entity, if present in the received SDP offer. + +When composing the SDP offer according to 3GPP TS 24.229 [3], the IWF performing the non-controlling role of a group: + +- 1) shall replace the IP address and port number for the offered media stream in the received SDP offer with the IP address and port number of the IWF performing the non-controlling role; +- 2) shall include all media-level attributes from the received SDP offer; +- 3) shall replace the IP address and port number for the offered media floor control entity, if any, in the received SDP offer with the IP address and port number of the IWF performing the non-controlling role; and +- 4) shall include the offered media floor control entity 'fmtp' attributes as specified in 3GPP TS 29.380 [31] clause 14. + +##### 6.6.4.1.2 Sending an INVITE request towards the MCPTT client + +This clause is referenced from other procedures. + +This clause covers the situation where a group homed in the IWF is a constituent group of a group homed in an MCPTT system. + +If the IWF receives a "SIP INVITE request for non-controlling MCPTT function of an MCPTT group" and does not support group regroup procedures, the IWF shall reject the SIP INVITE request with a SIP 403 (Forbidden) response with the warning text set to "100 function not allowed due to local policy" in a Warning header field as specified in 3GPP TS 24.379 [29] clause 4.4, and shall not execute the remainder of this procedure. + +If there are MCPTT clients that are members of the group, the IWF performing the non-controlling role of a group shall generate initial SIP INVITE requests according to 3GPP TS 24.229 [3]. + +NOTE 1: How the IWF includes participants homed in the IWF is out of scope. + +For each SIP INVITE request, the IWF performing the non-controlling role of a group: + +- 1) shall generate a new MCPTT session identity for the MCPTT session with the invited MCPTT client and include it in the Contact header field together with the g.3gpp.mcptt media feature tag, the g.3gpp.icsi-ref media feature tag with the value of "urn:urn-7:3gpp-service.ims.icsi.mcptt", and the isfocus media feature tag according to IETF RFC 3840 [9]; +- 2) shall include an Accept-Contact header field containing the g.3gpp.mcptt media feature tag along with the "require" and "explicit" header field parameters according to IETF RFC 3841 [5]; +- 3) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcptt" (coded as specified in 3GPP TS 24.229 [3]), in a P-Asserted-Service-Id header field according to IETF RFC 6050 [7] in the SIP INVITE request; +- 4) shall include an Accept-Contact header field with the media feature tag g.3gpp.icsi-ref with the value of "urn:urn-7:3gpp-service.ims.icsi.mcptt" along with parameters "require" and "explicit" according to IETF RFC 3841 [5]; +- 5) shall set the Request-URI to the public service identity of the terminating participating MCPTT function associated to the MCPTT ID of the MCPTT user to be invited; + +NOTE 2: How the IWF finds the address of the terminating participating MCPTT function is out of the scope of the current release. + +NOTE 3: If the terminating MCPTT user is part of a partner MCPTT system, then the public service identity can identify an entry point in the partner network that is able to identify the terminating participating MCPTT function. + +- 6) shall copy the application/vnd.3gpp.mcptt-info+xml MIME body in the received SIP INVITE request to the outgoing SIP INVITE request; +- 7) shall update the application/vnd.3gpp.mcptt-info+xml MIME body with: a element set to the MCPTT ID of the invited MCPTT user; +- 8) shall include the public service identity of the IWF in the P-Asserted-Identity header field; +- 9) shall include the received Referred-By header field with the public service identity of the IWF; +- 10) should include the Session-Expires header field according to rules and procedures of IETF RFC 4028 [6]. The refresher parameter shall be omitted; +- 11) shall include the Supported header field set to "timer"; +- 12) shall include an unmodified Answer-Mode header field, if present in the incoming SIP INVITE request; and +- 13) shall include the warning text set to "148 MCPTT group is regrouped" in a Warning header field as specified in 3GPP TS 24.379 [29] clause 4.4. + +NOTE 4: As long as the MCPTT group is regrouped the floor control messages in the media plane includes a grouped regrouped indication as specified in 3GPP TS 29.380 [31]. + +#### 6.6.4.1.3 Sending a SIP INFO request + +This clause is referenced from other procedures. + +This clause covers the situation where a group homed in the IWF is a constituent group of a group homed in an MCPTT system. + +If the IWF performing the non-controlling role receives a "SIP INVITE request for non-controlling MCPTT function of an MCPTT group" and does not support group regroup procedures, the IWF shall reject the SIP INVITE request with a SIP 403 (Forbidden) response with the warning text set to "100 function not allowed due to local policy" in a Warning header field as specified in 3GPP TS 24.379 [29] clause 4.4, and shall not execute the remainder of this procedure. + +The IWF shall generate a SIP INFO request according to rules and procedures of 3GPP TS 24.229 [3] and IETF RFC 6086 [26]. + +The IWF: + +- 1) shall include the Info-Package header field set to g.3gpp.mcptt-floor-request; + - 2) shall include an application/vnd.3gpp.mcptt-info+xml MIME body with the set to the temporary MCPTT group ID and the element with the constituent MCPTT group ID; + - 3) shall include an application/vnd.3gpp.mcptt-floor-request+xml MIME body with the Content-Disposition header field set to "Info-Package". For each current speaker the application/vnd.3gpp.mcptt-floor-request+xml MIME body shall be populated as follows: + - a) the element set to "general" or "dual" as described in 3GPP TS 24.379 [29] clause F.5.3; + - b) the SSRC of the MCPTT client or participant homed in the IWF with the permission to send media in the element; + - c) the actual floor priority in the element; + - d) the MCPTT ID of the MCPTT user or participant homed in the IWF with the permission to send media in the element; + - e) the queueing capability in the element of the element; + - f) the participant type in the in the element; + - g) one or more elements in the element in the same order as the would appear in the Track Info field as specified in 3GPP TS 29.380 [31] clause 8.2.3.13; and + - h) if available, additional information in the element; and + - 4) if: + - a) the user with permission to send media is an MCPTT client, and if: + - i) the IWF has location information (see 3GPP TS 24.379 [29] clause 13.2.4) for the MCPTT client; + - ii) the location information for the MCPTT client either has not been sent to the controlling MCPTT function or has changed since last sent to the MCPTT controlling function; and + - iii) the IWF determines that the location of the MCPTT client is allowed to be sent when the MCPTT user is talking; or + - b) the user with permission to send media is a participant homed in the IWF, and if: + - i) location information for the user with permission to send media homed in the IWF is available; + - ii) the location information for the participant homed in the IWF has either not been sent to the controlling MCPTT function or has changed since last sent to the controlling MCPTT function; and + - iii) the IWF determines that the location of the participant homed in the IWF is allowed to be sent when the participant homed in the IWF is talking; +- then shall include an application/vnd.3gpp.mcptt-location-info+xml MIME body with a element included in the root element. + +#### 6.6.4.1.4 Sending an INVITE request towards the controlling MCPTT function + +This clause is referenced from other procedures. + +The IWF shall generate a SIP INVITE request according to rules and procedures of 3GPP TS 24.229 [3]. + +The IWF: + +- 1) shall include in the Contact header field the g.3gpp.mcptt media feature tag, the g.3gpp.icsi-ref media feature tag with the value of "urn:urn-7:3gpp-service.ims.icsi.mcptt", and the isfocus media feature tag according to IETF RFC 3840 [9]; +- 2) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcptt" (coded as specified in 3GPP TS 24.229 [3]), in a P-Asserted-Service-Id header field according to IETF RFC 6050 [7] in the SIP INVITE request; +- 3) shall set the Request-URI to the public service identity of the controlling MCPTT function; +- 4) shall include an application/vnd.3gpp.mcptt-info+xml MIME body with: + - a) the element set to the group identity; + - b) the element set to the MCPTT ID of the calling user; and + - c) the element set to "true", if the group document retrieved from the group management server contains group members as specified in 3GPP TS 24.481 [16]; +- 5) shall include the public service identity of the IWF in the P-Asserted-Identity header field; +- 6) should include the Session-Expires header field according to rules and procedures of IETF RFC 4028 [6]. The refresher parameter shall be omitted; and +- 7) shall include the Supported header field set to "timer". + +#### 6.6.4.2 Requests terminated by the non-controlling MCPTT function of an MCPTT group + +##### 6.6.4.2.1 SDP answer generation + +When composing the SDP answer according to 3GPP TS 24.229 [3], the IWF performing the non-controlling role of a group: + +- 1) for the accepted media stream in the received SDP offer: + - a) shall replace the IP address and port number in the received SDP offer with the IP address and port number of the IWF performing the non-controlling role; and +- 2) for the accepted media-floor control entity, if present in the received SDP offer: + - a) shall replace the IP address and port number in the received SDP offer with the IP address and port number of the IWF performing the non-controlling role; and + - b) shall include 'fmtp' attributes as specified in 3GPP TS 29.380 [31] clause 14. + +##### 6.6.4.2.2 Sending a SIP response to the SIP INVITE request + +###### 6.6.4.2.2.1 Sending a SIP 183 (Session Progress) response + +When sending a SIP 183 (Session Progress) the IWF performing the non-controlling role of a group: + +- 1) shall generate a SIP 183 (Session Progress) response according to 3GPP TS 24.229 [3]; +- 2) shall include the following in the Contact header field: + - a) the g.3gpp.mcptt media feature tag; and + - b) the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcptt"; +- 3) shall include the public service identity determined by the IWF performing the non-controlling role in the P-Asserted-Identity header field; and + +- 4) shall include the option tag "tdialog" in a Supported header field according to rules and procedures of IETF RFC 4538 [13]. + +#### 6.6.4.2.2.2 Sending a SIP 200 (OK) response + +When sending a SIP 200 (OK) response, the IWF performing the non-controlling role of a group homed in the IWF: + +- 1) shall generate the SIP 200 (OK) response according to rules and procedures of 3GPP TS 24.229 [3]; +- 2) shall include the Session-Expires header field and start supervising the SIP session according to rules and procedures of IETF RFC 4028 [6], "UAS Behaviour". The "refresher" parameter in the Session-Expires header field shall be set to "uac"; +- 3) shall include the option tag "timer" in a Require header field; +- 4) shall include the public service identity of the IWF performing the non-controlling role in the P-Asserted-Identity header field; +- 5) shall include the following in the Contact header field: + - a) the g.3gpp.mcptt media feature tag; and + - b) the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcptt"; +- 6) shall include Warning header field(s) received from MCPTT clients in incoming responses to the SIP INVITE request; +- 7) shall include the option tag "tdialog" in a Supported header field according to rules and procedures of IETF RFC 4538 [13]; and +- 8) shall include an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to the constituent MCPTT group ID and the element set to the state of the floor. + +#### 6.6.4.3 Generating a SIP NOTIFY request + +The IWF performing the non-controlling role shall generate a SIP NOTIFY request according to 3GPP TS 24.229 [3] with the clarification in this clause. + +In the SIP NOTIFY request, the IWF: + +- 1) shall set the P-Asserted-Identity header field to the public service identity of the IWF; +- 2) shall include an Event header field set to "conference"; +- 3) shall include an Expires header field set to 3600 seconds according to IETF RFC 4575 [15], as default value; +- 4) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcptt" (coded as specified in 3GPP TS 24.229 [3]), in a P-Preferred-Service header field according to IETF RFC 6050 [7]; and +- 5) shall include an application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with: + - a) the set to the value of the constituent MCPTT group ID; + - b) if the target is a MCPTT user, the value of element set to the MCPTT ID of the targeted MCPTT user; and + - c) if the target is the controlling MCPTT function the value of element set to the temporary MCPTT group ID. + +In the SIP NOTIFY request, the IWF shall include application/conference-info+xml MIME body according to IETF RFC 4575 [15] as specified in clause 6.6.3.4 with the following exceptions: + +- 1) the IWF performing the non-controlling role shall not regard the controlling MCPTT function as a participant and not include the controlling MCPTT function in a element; and + +NOTE: The controlling MCPTT function initiated the temporary group call and will appear as a participant in the group session. + +- 2) the IWF shall include stored conference status information received in SIP NOTIFY requests from the controlling MCPTT function in 3GPP TS 24.379 [29] clause 10.1.3.5.3 and status information about MCPTT participants that are members of the group. + +## 6.6.5 Retrieving and processing a group document + +### 6.6.5.1 General + +How an IWF performing the controlling role of a group or performing the non-controlling role of a group obtains information about the group is out of scope of the present document. + +NOTE: During the group regrouping operation as specified in 3GPP TS 24.481 [16], the IWF performing the controlling role is notified of the constituent MCPTT group identities associated with the TGI. + +### 6.6.5.2 Rules for joining a group session + +The following conditions shall be met for the IWF performing the controlling role to allow an MCPTT user to join an existing group session: + +- 1) the MCPTT user is a member of the group; and +- 2) the MCPTT user is authorized to join the group; + +If both of the above conditions are met, then the MCPTT user shall be authorised to join the group session. + +### 6.6.5.3 Determining the group members to invite + +The IWF shall only invite affiliated group members to a group session. The IWF determines whether MCPTT users are affiliated members of its group by following the procedures specified in 3GPP TS 24.379 [29], clause 6.3.6. + +NOTE 1: The term "affiliated group members" used above also includes those members that are implicitly affiliated by the IWF performing the controlling role. + +NOTE 2: The IWF need not store its group parameters in a GMS as described in 3GPP TS 24.481 [16] the IWF will have to respond to queries from other systems on its IWF-3 interface, which is based upon the CSC-16 interface described in 3GPP TS 23.283 [28]. + +The IWF may limit the maximum number of participants. + +## 6.6.6 Error handling + +### 6.6.6.1 Public service identity does not exist + +Upon receiving a request that includes the Request-URI set to a public service identity that is not allocated in the IWF, the IWF performing the participating role or the controlling role shall return a SIP 404 (Not Found) response. + +## 6.6.7 Session release policy + +### 6.6.7.1 Session release policy for group call + +If: + +- 1) the call is a pre-arranged group call and if the IWF performing the controlling role receives an indication from the media plane that the T4 (Inactivity) timer specified in 3GPP TS 29.380 [31] expired and if there is at least one participant of the prearranged group call that is an MCPTT user; + +- 2) there are only one or no participants in the call, including both MCPTT participants and participants homed in the IWF; +- 3) if the call is a pre-arranged group call and if it is according to local policy, the initiator of the group call leaves the call; +- 4) less than the minimum number of affiliated group members is present; +- 5) timer TNG3 (group call timer) expires; or +- 6) the call is a broadcast group call and if the controlling MCPTT function receives an indication from the media plane that the T4 (Inactivity) timer specified in 3GPP TS 29.380 [31] expired; + +then the IWF performing the controlling role; + +- 1) shall release the MCPTT session for the group call if any participants are MCPTT users. + +### 6.6.7.2 Session release policy for private call + +If: + +- 1) IWF performing the controlling role decides that a private call has been inactive for longer than a locally determined period; or +- 2) there are only one or no participants in the MCPTT session; + +the IWF performing the controlling role shall release the MCPTT session for a private call. + +## 6.7 Implicit floor request + +A SIP re-INVITE request fulfilling the following criteria shall be regarded by the IWF performing the controlling role as an implicit floor request when the originator of the request: + +- 1) performs an upgrade of: + - a) an MCPTT group call to an emergency MCPTT group call; + - b) an MCPTT private call to an emergency MCPTT private call; or + - c) an MCPTT group call to an imminent peril MCPTT group call; and +- 2) includes the "mc\_implicit\_request" 'fmtp' attribute in the associated UDP stream for the floor control in the SDP offer/answer as specified in 3GPP TS 29.380 [31] clause 12. + +In all other cases the SIP (re-)INVITE request shall be regarded as received without an implicit floor request. + +## 6.8 Confidentiality and Integrity Protection + +### 6.8.1 General + +#### 6.8.1.1 Applicability and exclusions + +The procedures in clause 6.8 apply in general to all procedures described in clause 9, clause 10, clause 11 and clause 12. + +#### 6.8.1.2 Performing XML content encryption + +Whenever the IWF includes XML elements or attributes pertaining to the data specified in 3GPP TS 24.379 [29] clause 4.8 in SIP requests or SIP responses, the IWF shall perform the procedures in clause 6.8.2.1.1, with the exception that when the IWF receives a SIP request with XML elements or attributes in an MIME body that need to be copied from the incoming SIP request to an outgoing SIP request without modification, the IWF shall perform the procedures specified in clause 6.8.2.2. + +NOTE: The procedure in clause 6.8.2.1.1 first determines (by referring to configuration) if confidentiality protection is enabled and then call the necessary procedures to encrypt the contents of the XML elements if confidentiality protection is enabled. + +### 6.8.1.3 Performing integrity protection on an XML body + +The IWF shall perform the procedures in clause 6.8.3.2 just prior to sending a SIP request or SIP response. + +NOTE: The procedure in clause 6.8.3.2 first determines if integrity protection of XML MIME bodies is required and then calls the necessary procedures to integrity protect each XML MIME body if integrity protection is required. Each XML MIME body has its own signature. + +### 6.8.1.4 Keys used in confidentiality protection procedures + +Confidentiality protection uses an XPK to encrypt the data which (depending on who is the sender and who is the receiver of the encrypted information) can be an SPK as specified in 3GPP TS 24.379 [29] clause 4.8. An XPK-ID (SPK-ID) is used to key the XPK (SPK). It is assumed that before the procedures in this clause are called, the SPK/SPK-ID is available on the sender and recipient of the encrypted content as described in 3GPP TS 24.379 [29] clause 4.8. + +The procedures in 3GPP TS 24.379 [29], clause 6.6.2.3 and 3GPP TS 24.379 [29] clause 6.6.2.4 are used with an XPK equal to the SPK and a XPK-ID equal to the SPK-ID in the following circumstances as described in 3GPP TS 33.180 [27]: + +- 1) IWF sends confidentiality protected content to an MCPTT server in the same domain; and +- 2) IWF sends confidentiality protected content to an MCPTT server in another domain. + +## 6.8.2 Confidentiality Protection + +### 6.8.2.1 Procedures for sending confidentiality protected content + +#### 6.8.2.1.1 IWF performing any role of an MCPTT server + +If the IWF performing any role of an MCPTT server determines locally that it needs to confidentiality protect content sent to an MCPTT server, then sending confidentiality protected content between MCPTT servers is enabled. + +When sending confidentiality protected content, the IWF: + +- 1) shall use the appropriate keying information specified in clause 6.8.1.4; +- 2) shall perform the procedures in 3GPP TS 24.379 [29] clause 6.6.2.3.3 to confidentiality protect XML elements containing the content described in 3GPP TS 24.379 [29] clause 4.8; and +- 3) shall perform the procedures in 3GPP TS 24.379 [29] clause 6.6.2.3.4 to confidentiality protect URIs in XML attributes for URIs described in 3GPP TS 24.379 [29] clause 4.8. + +If the IWF determines locally that it does not need to confidentiality protect content sent to an MCPTT server, then sending confidentiality protected content between MCPTT servers is disabled, and content is included in XML elements and attributes without encryption. + +### 6.8.2.2 IWF copying received XML content + +The following procedure is executed when an IWF receives a SIP request containing XML MIME bodies, where the content needs to be copied from the incoming SIP request to the outgoing SIP request. + +The IWF: + +- 1) shall copy the XML elements from the XML MIME body of the incoming SIP request that do not contain a XML element, to the same XML body in the outgoing SIP request; + +- 2) for each encrypted XML element in the XML MIME body of the incoming SIP request as determined by 3GPP TS 24.379 [29] clause 6.6.2.4.1: + - a) shall use the keying information described in clause 6.8.1.4 to decrypt the content within the XML element by following the procedures specified in 3GPP TS 24.379 [29] clause 6.6.2.4.2, and shall continue with the steps below if the encrypted XML element was successfully decrypted; + - b) if confidentiality protection is enabled as specified in clause 6.8.2.1.1, then for each decrypted XML element: + - i) shall re-encrypt the content within the XML element using the keying information described in clause 6.8.1.4 and by following the procedures specified in 3GPP TS 24.379 [29] clause 6.6.2.3.3; and + - ii) shall include the re-encrypted content into the same XML MIME body of the outgoing SIP request; and + - c) if confidentiality protection is disabled as specified in clause 6.8.2.1.1, shall include the decrypted content in the same XML MIME body of the outgoing SIP request. +- 3) for each encrypted XML URI attribute in the XML MIME body of the incoming SIP request as determined by 3GPP TS 24.379 [29] clause 6.6.2.4.1: + - a) shall use the keying information described in clause 6.8.1.4 to decrypt the URI value of the XML attribute by following the procedures specified in 3GPP TS 24.379 [29] clause 6.6.2.4.3, and shall continue with the steps below if the encrypted XML attribute value was successfully decrypted; + - b) if confidentiality protection is enabled as specified in clause 6.8.2.1.1, then for each decrypted XML element: + - i) shall re-encrypt the URI value of the XML attribute using the keying information described in clause 6.8.1.4 and by following the procedures specified in 3GPP TS 24.379 [29] clause 6.6.2.3.4; and + - ii) shall include the re-encrypted attribute value into the same XML MIME body of the outgoing SIP request; and + - c) if confidentiality protection is disabled as specified in clause 6.8.2.1.1, shall include the decrypted value in the same XML MIME body of the outgoing SIP request. + +## 6.8.3 Integrity Protection of XML documents + +### 6.8.3.1 Keys used in integrity protection procedures + +Integrity protection uses an XPK to sign the data which (depending on who is the sender and who is the receiver of the signed information) can be an SPK as specified in 3GPP TS 24.379 [29] clause 4.8. An XPK-ID (SPK-ID) is used to key the XPK (SPK). It is assumed that before the procedures in 3GPP TS 24.379 [29] clause 6.6.3.3 and 3GPP TS 24.379 [29] clause 6.6.3.4 are called, the SPK/SPK-ID are available on the sender and recipient of the integrity protected content, as described in 3GPP TS 24.379 [29] clause 4.8. + +The procedures in 3GPP TS 24.379 [29] clause 6.6.3.3 and 3GPP TS 24.379 [29] clause 6.6.3.4 shall be used with a XPK equal to the SPK and a XPK-ID equal to the SPK-ID in the following circumstances as described in 3GPP TS 33.180 [27]: + +- 1) IWF sends integrity protected content to an MCPTT server in the same domain; and +- 2) IWF sends integrity protected content to an MCPTT server in another domain. + +### 6.8.3.2 Integrity protection at the IWF + +The IWF determines locally whether sending integrity protected content from the IWF to an MCPTT server is enabled. + +NOTE 1: How the IWF determines whether to integrity protect content is out of scope of the present document. + +When sending integrity protected content, the IWF shall use the appropriate keying information specified in clause 6.8.3.1 and shall perform the procedures in 3GPP TS 24.379 [29] clause 6.6.3.3.3 to integrity protect XML MIME bodies. + +NOTE 2: Each XML MIME body is integrity protected separately. + +## 6.9 Priority sharing + +The IWF performing the participating role shall enable or disable priority sharing as specified in 3GPP TS 24.229 [3]. + +## 6.10 Private call parameters + +### 6.10.1 Private call parameter check + +Parameters of an incoming SIP INVITE are indicated as follows: + +- 1) floor control. Floor control operation is indicated by an SDP offer with a media-level clause for a media-floor control entity; +- 2) commencement mode. The requested commencement mode is according to the Answer-mode header, i.e. either "auto" or "manual"; and +- 3) implicit floor request. An implicit floor request is indicated by inclusion of the "mc\_implicit\_request" 'fmt' attribute for the floor control in the SDP offer/answer as specified in 3GPP TS 29.380 [31] clause 12. + +Additional LMR specific parameters, such as LMR encryption mode, are out of scope of the present document. The LMR specific parameters may be conveyed in the element of the element of the element of the MIME body root element as defined in 3GPP TS 24.379 [29], clause F.1. + +### 6.10.2 Private call parameter response values + +To reject a private call due to unsupported parameters, the IWF performing the participating role shall include in its response to the SIP INVITE a list of parameters from the incoming SIP INVITE that it does support. + +To indicate support for one or more private call parameters, in the element of the element of the root element in the XML body, the IWF: + +- 1) if floor control is requested in the incoming SIP INVITE and is supported, shall include the element; +- 2) if "without" floor control is requested in the incoming SIP INVITE and is supported by the IWF (i.e. full duplex is not supported), shall include the element; +- 3) if implicit floor is requested in the incoming SIP INVITE and is supported by the IWF (i.e. the IWF need not talk first), shall include the element; +- 4) if floor is not implicitly requested in the incoming SIP INVITE and the IWF supports floor not being implicitly requested (i.e. the IWF must talk first), shall include the element; +- 5) if manual commencement is requested in the incoming SIP INVITE and is supported by the IWF, shall include the <>manual-commencement> element; and +- 6) if automatic commencement is requested in the incoming SIP INVITE and is supported by the IWF, shall include the element. + +--- + +## 7 Registration and service authorisation + +The present document does not specify any registration or service authorization procedures for users homed in the IWF. + +--- + +## 8 Pre-established session + +The present document does not specify any pre-established session procedures for users homed in the IWF. + +## 9 Affiliation + +### 9.1 General + +Clause 9.2.1.2 contains the procedures for explicit and implicit affiliation of a user homed in the IWF at the IWF homing that user. + +Clauses in 9.2.1.2 also cover the case where the IWF manages affiliation to a group on behalf of the users homed in that IWF (i.e. having only one affiliation for a whole set of users homed in the IWF). In that case, the IWF needs to implement the same set of procedures but in those procedures, it shall use the MCPTT ID and the MCPTT client ID that are associated with the IWF itself instead of the ones associated with a user homed in the IWF. + +NOTE: How the MCPTT ID and MCPTT client ID associated with the IWF are determined is out of the scope of this specification. + +Clause 9.2.1.3 contains the procedures for explicit and implicit affiliation of an MCPTT user at the IWF owning the MCPTT group. + +The procedures for implicit affiliation in this clause are triggered at the IWF for a user homed in the IWF in the following circumstances: + +- when the IWF performing the participating role attempts to join an MCPTT chat group for a user homed in the IWF that is not already affiliated to the MCPTT group; +- when the IWF performing the participating role attempts to initiate an MCPTT emergency group call or MCPTT imminent peril group call for a user homed in the IWF that is not already affiliated to the MCPTT group; +- when the IWF performing the participating role attempts to initiate an MCPTT emergency alert targeted to an MCPTT group for a user homed in the IWF that is not already affiliated to the MCPTT group. + +The procedures for implicit affiliation in this clause are triggered at the IWF owning the MCPTT group in the following circumstances: + +- on receipt of a SIP INVITE request from an MCPTT server serving an MCPTT user where the MCPTT user wants to join an MCPTT chat group homed in the IWF and the MCPTT client is not already affiliated to the MCPTT group homed in the IWF; +- on receipt of a SIP INVITE request from an MCPTT server serving an MCPTT user where the MCPTT user initiates an MCPTT emergency group call or MCPTT imminent peril group call to a group homed in the IWF and the MCPTT client is not already affiliated to the MCPTT group homed in the IWF; and +- on receipt of a SIP MESSAGE request from an MCPTT server serving an MCPTT user when the MCPTT user initiates an MCPTT emergency alert targeted to an MCPTT group homed in the IWF and the MCPTT client is not already affiliated to the MCPTT group homed in the IWF. + +### 9.2 Procedures + +#### 9.2.1 IWF procedures towards the MCPTT system + +##### 9.2.1.1 General + +The IWF procedures towards the MCPTT system consist of: + +- procedures towards the MCPTT system of an IWF serving the user homed in the IWF; and +- procedures of an IWF owning a group that is visible to the MCPTT system. + +## 9.2.1.2 Procedures towards the MCPTT system of an IWF serving the user homed in the IWF + +### 9.2.1.2.1 General + +The procedures towards the MCPTT system of an IWF serving the user homed in the IWF consist of: + +- a receiving subscription to affiliation status procedure; +- a sending notification of change of affiliation status procedure; +- a sending affiliation status change towards MCPTT server owning MCPTT group procedure; +- an affiliation status determination from MCPTT server owning MCPTT group procedure; +- an affiliation status determination procedure; +- an affiliation status change by implicit affiliation procedure; +- an implicit affiliation status change completion procedure; +- an implicit affiliation status change cancellation procedure; and +- an automatic affiliation to configured groups procedure. + +### 9.2.1.2.2 Stored information + +The IWF maintains information equivalent to that defined in TS 24.379 [29] clause 9.2.2.2.2. + +NOTE: The virtual data structure referenced in this clause is for information only. Implementors may choose other means to track affiliation status for users homed in the IWF. References to the elements of this virtual data structure are made in other clauses with the understanding that implementors choosing not to use this virtual data structure will take other appropriate actions. + +### 9.2.1.2.3 Procedure for handling affiliation status change of a user homed in the IWF + +When the IWF determines that affiliation status should change for a user homed in the IWF, the IWF performing the participating role: + +- 1) shall determine the served MCPTT ID associated with the user homed in the IWF; +- 2) shall determine the candidate expiration interval for the affiliation according to IETF RFC 3903 [21]; +- 3) shall determine the served MCPTT client ID associated with the user homed in the IWF; +- 4) shall consider an MCPTT user information entry such that: + - a) the MCPTT user information entry is in the list of MCPTT user information entries described in clause 9.2.1.2.2; and + - b) the MCPTT ID of the MCPTT user information entry is equal to the served MCPTT ID;as the served MCPTT user information entry; +- 5) shall consider an MCPTT client information entry such that: + - a) the MCPTT client information entry is in the list of MCPTT client information entries of the served MCPTT user information entry; and + - b) the MCPTT client ID of the MCPTT client information entry is equal to the served MCPTT client ID;as the served MCPTT client information entry; +- 6) shall consider a copy of the list of the MCPTT group information entries of the served MCPTT client information entry as the served list of the MCPTT group information entries; + +- 7) if the candidate expiration interval is nonzero: +- a) shall construct the candidate list of the MCPTT group information entries as follows: + - i) for each MCPTT group ID which has an MCPTT group information entry in the served list of the MCPTT group information entries, such that the expiration time of the MCPTT group information entry has not expired yet, and which is determined by the IWF to be a group to which the user homed in the IWF is to be affiliated: + - A) shall copy the MCPTT group information entry into a new MCPTT group information entry of the candidate list of the MCPTT group information entries; + - B) if the affiliation status of the MCPTT group information entry is "deaffiliating" or "deaffiliated", shall set the affiliation status of the new MCPTT group information entry to the "affiliating" state and shall reset the affiliating p-id of the new MCPTT group information entry; and + - C) shall set the expiration time of the new MCPTT group information entry to the current time increased with the candidate expiration interval; + - ii) for each MCPTT group ID which has an MCPTT group information entry in the served list of the MCPTT group information entries, such that the expiration time of the MCPTT group information entry has not expired yet, and which is determined by the IWF to be a group to which the user homed in the IWF is not to be affiliated: + - A) shall copy the MCPTT group information entry into a new MCPTT group information entry of the candidate list of the MCPTT group information entries; and + - B) if the affiliation status of the MCPTT group information entry is "affiliated" or "affiliating": + - shall set the affiliation status of the new MCPTT group information entry to the "de-affiliating" state; and + - shall set the expiration time of the new MCPTT group information entry to the current time increased with twice the value of timer F; and + - iii) for each MCPTT group ID: + - A) which does not have an MCPTT group information entry in the served list of the MCPTT group information entries; or + - B) which has an MCPTT group information entry in the served list of the MCPTT group information entries, such that the expiration time of the MCPTT group information entry has already expired; and which is determined by the IWF to be a group to which the user homed in the IWF is to be affiliated: + - A) shall add a new MCPTT group information entry in the candidate list of the MCPTT group information list for the MCPTT group ID; + - B) shall set the affiliation status of the new MCPTT group information entry to the "affiliating" state; + - C) shall set the expiration time of the new MCPTT group information entry to the current time increased with the candidate expiration interval; and + - D) shall reset the affiliating p-id of the new MCPTT group information entry; + - b) determine the candidate number of MCPTT group IDs as the number of different MCPTT group IDs which have an MCPTT group information entry: + - i) in the candidate list of the MCPTT group information entries; or + - ii) in the list of the MCPTT group information entries of an MCPTT client information entry such that: + - A) the MCPTT client information entry is in the list of the MCPTT client information entries of the served MCPTT user information entry; and + - B) the MCPTT client ID of the MCPTT client information entry is not equal to the served MCPTT client ID; + +with the affiliation status set to the "affiliating" state or the "affiliated" state and with the expiration time which has not expired yet; and + +- c) if the candidate number of MCPTT group IDs is bigger than N2 value of the served MCPTT ID, shall be based on service provider policy reduce the candidate MCPTT group IDs to that equal to N2; + +NOTE: The service provider policy can determine to remove an MCPTT group ID based on the importance or priority of the MCPTT group or some other policy to determine which groups are preferred. + +- 8) if the candidate expiration interval is zero, constructs the candidate list of the MCPTT group information entries as follows: + - a) for each MCPTT group ID which has an entry in the served list of the MCPTT group information entries: + - i) shall copy the MCPTT group entry of the served list of the MCPTT group information into a new MCPTT group information entry of the candidate list of the MCPTT group information entries; + - ii) shall set the affiliation status of the new MCPTT group information entry to the "de-affiliating" state; and + - iii) shall set the expiration time of the new MCPTT group information entry to the current time increased with twice the value of timer F; +- 9) shall replace the list of the MCPTT group information entries stored in the served MCPTT client information entry with the candidate list of the MCPTT group information entries; +- 10) shall perform the procedures specified in clause 9.2.1.2.6 for the served MCPTT ID and each MCPTT group ID: + - a) which does not have an MCPTT group information entry in the served list of the MCPTT group information entries and which has an MCPTT group information entry in the candidate list of the MCPTT group information entries with the affiliation status set to the "affiliating" state; + - b) which has an MCPTT group information entry in the served list of the MCPTT group information entries with the expiration time already expired, and which has an MCPTT group information entry in the candidate list of the MCPTT group information entries with the affiliation status set to the "affiliating" state; + - c) which has an MCPTT group information entry in the served list of the MCPTT group information entries with the affiliation status set to the "deaffiliating" state or the "deaffiliated" state and with the expiration time not expired yet, and which has an MCPTT group information entry in the candidate list of the MCPTT group information entries with the affiliation status set to the "affiliating" state; or + - d) which has an MCPTT group information entry in the served list of the MCPTT group information entries with the affiliation status set to the "affiliated" state and with the expiration time not expired yet, and which has an MCPTT group information entry in the candidate list of the MCPTT group information entries with the affiliation status set to the "de-affiliating" state. + +#### 9.2.1.2.4 Receiving subscription to affiliation status procedure + +Upon receiving a SIP SUBSCRIBE request such that: + +- 1) the Request-URI of the SIP SUBSCRIBE request contains the public service identity identifying the IWF performing the terminating participating role serving the user homed in the IWF; +- 2) the SIP SUBSCRIBE request contains an application/vnd.3gpp.mcptt-info+xml MIME body containing the element which identifies an MCPTT ID associated with a user homed in the IWF performing the terminating participating role; +- 3) the SIP SUBSCRIBE request contains the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcptt" (coded as specified in 3GPP TS 24.229 [3]), in a P-Asserted-Service header field according to IETF RFC 6050 [7]; and +- 4) the Event header field of the SIP SUBSCRIBE request contains the "presence" event type; + +the IWF performing the terminating participating role: + +- 1) if the IWF does not support receiving a SIP SUBSCRIBE request to the affiliation status of a user homed in the IWF, the IWF shall generate and send a SIP 501 (Not Implemented) response to the SIP SUBSCRIBE request according to 3GPP TS 24.229 [3], IETF RFC 6665 [25], and shall skip the remainder of this procedure; + +- 2) shall identify the served MCPTT ID in the element of the application/vnd.3gpp.mcptt-info+xml MIME body of the SIP SUBSCRIBE request; +- 3) if the Request-URI of the SIP SUBSCRIBE request contains the public service identity identifying the IWF performing the terminating participating role serving the user homed in the IWF, shall identify the originating MCPTT ID in the element of the application/vnd.3gpp.mcptt-info+xml MIME body of the SIP SUBSCRIBE request; +- 4) if the originating MCPTT ID is not authorized to subscribe to the affiliation status of the user homed in the IWF, shall send a 403 (Forbidden) response and shall not continue with the rest of the steps; and +- 5) shall generate a 200 (OK) response to the SIP SUBSCRIBE request according to 3GPP TS 24.229 [3], IETF RFC 6665 [25]. + +For the duration of the subscription, the IWF performing the terminating participating role shall notify the subscriber about changes of the information of the served MCPTT ID, as described in clause 9.2.1.2.5. + +#### 9.2.1.2.5 Sending notification of change of affiliation status procedure + +In order to notify the subscriber about changes of the served MCPTT ID, the IWF: + +NOTE: the served MCPTT ID identifies the user homed in the IWF whose affiliation status has been subscribed. + +- 1) shall consider an MCPTT user information entry such that: + - a) the MCPTT user information entry is in the list of MCPTT user information entries described in clause 9.2.1.2.2; and + - b) the MCPTT ID of the MCPTT user information entry is equal to the served MCPTT ID;as the served MCPTT user information entry; +- 2) shall consider the list of the MCPTT client information entries of the served MCPTT user information entry as the served list of the MCPTT client information entries; +- 3) shall generate an application/pidf+xml MIME body indicating per-user affiliation information according to 3GPP TS 24.379 [29], clause 9.3.1 and the served list of the MCPTT client information entries with the following clarifications: + - a) the IWF shall not include information from an MCPTT group information entry with the expiration time already expired; + - b) the IWF shall not include information from an MCPTT group information entry with the affiliation status set to the "deaffiliated" state; and + - c) if the SIP SUBSCRIBE request creating the subscription of this notification contains an application/simple-filter+xml MIME body indicating per-client restrictions of presence event package notification information according to 3GPP TS 24.379 [29], clause 9.3.2, the IWF shall restrict the application/pidf+xml MIME body according to the application/simple-filter+xml MIME body; and +- 4) send a SIP NOTIFY request according to 3GPP TS 24.229 [3], and IETF RFC 6665 [25] for the subscription created in clause 9.2.1.2.4. In the SIP NOTIFY request, the IWF shall include the generated application/pidf+xml MIME body indicating per-user affiliation information. + +#### 9.2.1.2.6 Sending affiliation status change towards MCPTT server owning MCPTT group procedure + +NOTE 1: Usage of one SIP PUBLISH request to carry information about change of affiliation state of several users homed in the same IWF and/or to several MCPTT groups owned by the same MCPTT server is not supported in this version of the specification. + +In order: + +- to send an affiliation request of a user homed in the IWF to a handled MCPTT group ID; + +- to send a de-affiliation request of a user homed in the IWF from a handled MCPTT group ID; or +- to send an affiliation request of a user homed in the IWF to a handled MCPTT group ID due to near expiration of the previously published information; + +the IWF shall generate a SIP PUBLISH request according to 3GPP TS 24.229 [3], IETF RFC 3903 [21] and IETF RFC 3856 [24]. In the SIP PUBLISH request, the IWF: + +- 1) shall set the Request-URI to the public service identity of the controlling MCPTT function associated with the handled MCPTT group ID; +- 2) shall include an application/vnd.3gpp.mcptt-info+xml MIME body. In the application/vnd.3gpp.mcptt-info+xml MIME body, the MCPTT server: + - a) shall include the element set to the handled MCPTT group ID; and + - b) shall include the element set to MCPTT ID associated with the user homed in the IWF; +- 3) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcptt" (coded as specified in 3GPP TS 24.229 [3]), in a P-Asserted-Service header field according to IETF RFC 6050 [7]; +- 4) if sending an affiliation request, shall set the Expires header field according to IETF RFC 3903 [21], to 4294967295; + +NOTE 2: 4294967295, which is equal to $2^{32}-1$ , is the highest value defined for Expires header field in IETF RFC 3261 [14]. + +- 5) if sending a de-affiliation request, shall set the Expires header field according to IETF RFC 3903 [21], to zero; +- 6) shall include a P-Asserted-Identity header field set to the public service identity of the IWF according to 3GPP TS 24.229 [3]; +- 7) shall set the current p-id to a globally unique value; +- 8) shall consider an MCPTT user information entry such that: + +- a) the MCPTT user information entry is in the list of MCPTT user information entries described in clause 9.2.1.2.2; and +- b) the MCPTT ID of the MCPTT user information entry is equal to the MCPTT ID associated with the user homed in the IWF; + +as the served MCPTT user information entry; + +- 9) for each MCPTT group information entry such that: + +- a) the MCPTT group information entry has the "affiliating" affiliation status, the MCPTT group ID set to the handled MCPTT group ID, the expiration time has not expired yet and the affiliating p-id is not set; +- b) the MCPTT group information entry is in the list of the MCPTT group information entries of an MCPTT client information entry; and +- c) the MCPTT client information entry is in the list of the MCPTT client information entries of the served MCPTT user information entry; + +shall set the affiliating p-id of the MCPTT group information entry to the current p-id; and + +- 10) shall include an application/pidf+xml MIME body indicating per-group affiliation information for a user homed in the IWF constructed according to 3GPP TS 24.379 [29], clause 9.3.1.2. The IWF shall indicate all MCPTT client IDs associated with the user homed in the IWF, such that: + - a) the affiliation status is set to "affiliating" or "affiliated", and the expiration time has not expired yet in an MCPTT group information entry with the MCPTT group ID set to the handled MCPTT group; + - b) the MCPTT group information entry is in the list of the MCPTT group information entries of an MCPTT client information entry; + +- c) the MCPTT client information entry has the MCPTT client ID set to the served MCPTT client ID; and +- d) the MCPTT client information entry is in the list of the MCPTT client information entries of the served MCPTT user information entry. + +The IWF shall set the child element of the root element to the current p-id. + +The IWF shall not include the "expires" attribute in the element. + +The IWF shall send the SIP PUBLISH request according to 3GPP TS 24.229 [3]. + +If timer F expires for the SIP PUBLISH request sent for a (de)affiliation request of the user homed in the IWF to the MCPTT group ID or upon receiving a SIP 3xx, 4xx, 5xx or 6xx response to the SIP PUBLISH request, the IWF: + +- 1) shall remove each MCPTT group ID entry such that: + - a) the MCPTT group information entry has the MCPTT group ID set to the handled MCPTT group ID; + - b) the MCPTT group information entry is in the list of the MCPTT group information entries of an MCPTT client information entry; and + - c) the MCPTT client information entry is in the list of the MCPTT client information entries of the served MCPTT user information entry. + +#### 9.2.1.2.7 Affiliation status determination from MCPTT server owning MCPTT group procedure. + +NOTE 1: Usage of one SIP SUBSCRIBE request to subscribe for notification about change of affiliation state of several users homed in the same IWF is not supported in this version of the specification. + +In order to discover whether a user homed in the IWF was successfully affiliated to a handled MCPTT group in the MCPTT server owning the handled MCPTT group, the IWF shall generate an initial SIP SUBSCRIBE request according to 3GPP TS 24.229 [3], IETF RFC 3856 [24], and IETF RFC 6665 [25]. + +In the SIP SUBSCRIBE request, the IWF: + +- 1) shall set the Request-URI to the public service identity of the controlling MCPTT function associated with the handled MCPTT group ID; +- 2) shall include an application/vnd.3gpp.mcptt-info+xml MIME body. In the application/vnd.3gpp.mcptt-info+xml MIME body, the IWF: + - a) shall include the element set to the handled MCPTT group ID; and + - b) shall include the element set to the MCPTT ID associated with the user homed in the IWF; +- 3) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcptt" (coded as specified in 3GPP TS 24.229 [3]), in a P-Asserted-Service header field according to IETF RFC 6050 [7]; +- 4) if the IWF wants to receive the current status and later notification, shall set the Expires header field according to IETF RFC 6665 [25], to 4294967295; + +NOTE 2: 4294967295, which is equal to $2^{32}-1$ , is the highest value defined for Expires header field in IETF RFC 3261 [14]. + +- 5) if the IWF wants to fetch the current state only, shall set the Expires header field according to IETF RFC 6665 [25], to zero; +- 6) shall include an Accept header field containing the application/pidf+xml MIME type; and +- 7) shall include an application/simple-filter+xml MIME body indicating per-user restrictions of presence event package notification information according to 3GPP TS 24.379 [29], clause 9.3.2, indicating the MCPTT ID associated with the user homed in the IWF. + +The IWF shall send the SIP SUBSCRIBE request according to 3GPP TS 24.229 [3]. + +In order to re-subscribe or de-subscribe, the IWF shall generate an in-dialog SIP SUBSCRIBE request according to 3GPP TS 24.229 [3], IETF RFC 3856 [24], and IETF RFC 6665 [25]. In the SIP SUBSCRIBE request, the IWF: + +- 1) if the IWF wants to receive the current status and later notification, shall set the Expires header field according to IETF RFC 6665 [25], to 4294967295; + +NOTE 3: 4294967295, which is equal to $2^{32}-1$ , is the highest value defined for Expires header field in IETF RFC 3261 [14]. + +- 2) if the MCPTT server wants to de-subscribe, shall set the Expires header field according to IETF RFC 6665 [25], to zero; and +- 3) shall include an Accept header field containing the application/pidf+xml MIME type. + +Upon receiving a SIP NOTIFY request according to 3GPP TS 24.229 [3], IETF RFC 3856 [24], and IETF RFC 6665 [25], if the SIP NOTIFY request contains an application/pidf+xml MIME body indicating per-group affiliation information constructed according to 3GPP TS 24.379 [29], clause 9.3.1, then the IWF: + +- 1) for each served MCPTT ID and served MCPTT client ID such that the application/pidf+xml MIME body of SIP NOTIFY request contains: + +- a) a element of the root element; +- b) the "id" attribute of the element indicating the MCPTT ID associated with the user homed in the IWF; +- c) an child element of the element of the element; +- d) the "client" attribute of the element indicating the MCPTT client ID associated with the user homed in the IWF; and +- e) the "expires" attribute of the element indicating expiration of affiliation; + +perform the following: + +- a) if an MCPTT group information entry exists such that: + - i) the MCPTT group information entry has the "affiliating" affiliation status, the MCPTT group ID set to the handled MCPTT group ID, and the expiration time has not expired yet; + - ii) the MCPTT group information entry is in the list of the MCPTT group information entries of an MCPTT client information entry with the MCPTT client ID set to the MCPTT client ID associated with the user homed in the IWF; + - iii) the MCPTT client information entry is in the list of the MCPTT client information entries of a served MCPTT user information entry with the MCPTT ID set to the MCPTT ID associated with the user homed in the IWF; and + - iv) the MCPTT user information entry is in the list of MCPTT user information entries described in clause 9.2.1.2.2; and + - b) shall set the affiliation status of the MCPTT group information entry to "affiliated"; and + - c) shall set the next publishing time of the MCPTT group information entry to the current time and half of the time between the current time and the expiration of affiliation; +- 2) for each MCPTT group information entry such that: + - a) the MCPTT group information entry has the "affiliated" affiliation status or the "deaffiliating" affiliation status, the MCPTT group ID set to the handled MCPTT group ID, and the expiration time has not expired yet; + - b) the MCPTT group information entry is in the list of the MCPTT group information entries of an MCPTT client information entry with the MCPTT client ID set to the MCPTT client ID associated with the user homed in the IWF; + +- c) the MCPTT client information entry is in the list of the MCPTT client information entries of the served MCPTT user information entry with the MCPTT ID set to the MCPTT ID associated with the user homed in IWF; and +- d) the MCPTT user information entry is in the list of MCPTT user information entries described in clause 9.2.1.2.2; and + +for which the application/pidf+xml MIME body of SIP NOTIFY request does not contain + +- a) a element of the root element; +- b) the "id" attribute of the element indicating the MCPTT ID associated with the user homed in the IWF; +- c) an child element of the child element of the element; and +- d) the "client" attribute of the element indicating the MCPTT client ID associated with the user homed in the IWF; + +perform the following: + +- a) shall set the affiliation status of the MCPTT group information entry to "deaffiliated"; and + - b) shall set the expiration time of the MCPTT group information entry to the current time; and +- 3) if a element is included in the root element of the application/pidf+xml MIME body of the SIP NOTIFY request, then for each MCPTT group information entry such that: +- a) the MCPTT group information entry has the "affiliating" affiliation status, the MCPTT group ID set to the handled MCPTT group ID, the expiration time has not expired yet and with the affiliating p-id set to the value of the element; + - b) the MCPTT group information entry is in the list of the MCPTT group information entries of an MCPTT client information entry with the MCPTT client ID set to the MCPTT client ID associated with the user homed in the IWF; + - c) the MCPTT client information entry is in the list of the MCPTT client information entries of the served MCPTT user information entry with the MCPTT ID set to the MCPTT ID associated with the user homed in the IWF; and + - d) the MCPTT user information entry is in the list of MCPTT user information entries described in clause 9.2.1.2.2; and + +for which the application/pidf+xml MIME body of SIP NOTIFY request does not contain: + +- a) a element of the root element; +- b) the "id" attribute of the element indicating the MCPTT ID associated with the user homed in the IWF; +- c) an child element of the child element of the element; and +- d) the "client" attribute of the element indicating the MCPTT client ID associated with the user homed in the IWF; + +perform the following: + +- a) shall set the affiliation status of the MCPTT group information entry to "deaffiliated"; and +- b) shall set the expiration time of the MCPTT group information entry to the current time. + +#### 9.2.1.2.8 Affiliation status determination + +This clause is referenced from other procedures. + +If the IWF performing the participating role needs to determine the affiliation status of a user homed in the IWF to an MCPTT group, the IWF performing the participating role: + +- 1) shall determine the client and MCPTT client ID associated with the user homed in the IWF; +- 2) shall find the user information entry in the list of MCPTT user information entries described in clause 9.2.1.2.2 such that the MCPTT ID of the MCPTT user information entry is equal to the MCPTT ID associated with the user homed in the IWF; + - a) if the applicable MCPTT group information entry cannot be found, then the IWF performing the participating role shall determine that the user homed in the IWF is not affiliated to the MCPTT group at the determined client and the skip the rest of the steps; +- 3) shall find the MCPTT client information entry in the list of MCPTT client information entries of MCPTT user information entry found in step 1) in which the MCPTT client id matches the value of the determined MCPTT client ID; + - a) if the applicable MCPTT client information entry cannot be found, then the IWF performing the participating role shall determine that the user homed in the IWF is not affiliated to the MCPTT group at the determined client and the skip the rest of the steps; +- 4) shall find the MCPTT group information entry in the list of MCPTT group information entries of MCPTT client information entry found in step 2 such that the MCPTT group identity matches the value of the identity of the targeted MCPTT group; + - a) if the applicable MCPTT group information entry was found in step 3) and the affiliation status of the MCPTT group information entry is "affiliating" or "affiliated", shall determine that the user homed in the IWF at the determined client is affiliated to the targeted MCPTT group and skip the rest of the steps; + - b) if the applicable MCPTT group information entry was found in step 3) and the affiliation status of the MCPTT group information entry is "deaffiliating" or "deaffiliated", shall determine that the user homed in the IWF at the determined client to is not affiliated to the targeted MCPTT group and skip the rest of the steps; or + - c) if the applicable MCPTT group information entry was not found in step 3), shall determine that the user homed in the IWF at the determined client is not affiliated to the targeted MCPTT group. + +#### 9.2.1.2.9 Affiliation status change by implicit affiliation + +This clause is referenced from other procedures. + +Upon determining that a user homed in the IWF is to be implicitly affiliated to an MCPTT group as per the triggers defined in clause 9.1, the IWF performing the participating role: + +- 1) shall determine the served MCPTT client ID as being the MCPTT ID associated with the user homed in the IWF; +- 2) shall determine the MCPTT group ID to which the user homed in the IWF is to be implicitly affiliated; +- 3) shall determine the served MCPTT ID as being the MCPTT ID associated with the user homed in the IWF; +- 4) shall consider an MCPTT user information entry such that: + - a) the MCPTT user information entry is in the list of MCPTT user information entries described in clause 9.2.1.2.2; and + - b) the MCPTT ID of the MCPTT user information entry is equal to the served MCPTT ID;as the served MCPTT user information entry; +- 5) shall consider an MCPTT client information entry such that: + - a) the MCPTT client information entry is in the list of MCPTT client information entries of the served MCPTT user information entry; and + - b) the MCPTT client ID of the MCPTT client information entry is equal to the served MCPTT client ID; + +as the served MCPTT client information entry; + +- 6) shall consider a copy of the list of the MCPTT group information entries of the served MCPTT client information entry as the served list of the MCPTT group information entries; + - 7) shall construct the candidate list of the MCPTT group information entries as follows: + - a) for each MCPTT group ID which has an MCPTT group information entry in the served list of the MCPTT group information entries shall copy the MCPTT group information entry into a new MCPTT group information entry of the candidate list of the MCPTT group information entries; and + - b) if the determined MCPTT group ID does not have an MCPTT group information entry in the served list of the MCPTT group information entries or has an MCPTT group information entry in the served list of the MCPTT group information entries, such that the expiration time of the MCPTT group information entry has already expired: + - i) shall add a new MCPTT group information entry in the candidate list of the MCPTT group information list for the determined MCPTT group ID; + - ii) shall set the affiliation status of the new MCPTT group information entry to the "affiliating" state; and + - iii) shall set the expiration time of the new MCPTT group information entry to the current time increased with the candidate expiration interval; + - 8) determine the candidate number of MCPTT group IDs as the number of different MCPTT group IDs which have an MCPTT group information entry: + - a) in the candidate list of the MCPTT group information entries; or + - b) in the list of the MCPTT group information entries of an MCPTT client information entry such that: + - i) the MCPTT client information entry is in the list of the MCPTT client information entries of the served MCPTT user information entry; and + - ii) the MCPTT client ID of the MCPTT client information entry is not equal to the served MCPTT client ID;with the affiliation status set to the "affiliating" state or the "affiliated" state and with the expiration time which has not expired yet; and + - 9) if the candidate number of MCPTT group IDs is bigger than the N2 value of the served MCPTT ID, shall be based on MCPTT service provider policy reduce the candidate MCPTT group IDs to that equal to N2; +- NOTE: The MCPTT service provider policy can determine to remove an MCPTT group ID based on the importance or priority of other MCPTT groups, received SIP requests containing an authorised request for originating a priority call as determined by clause 6.6.2.1.4.2 or other policy to determine which MCPTT groups are preferred. +- 10) if the determined MCPTT group ID cannot be added to the candidate list of the MCPTT group information entries due to exceeding the N2 limit for the user homed in the IWF, shall discard the candidate list of the MCPTT group information entries and skip the remaining steps of the current procedure; and + - 11) shall replace the list of the MCPTT group information entries stored in the served MCPTT client information entry with the candidate list of the MCPTT group information entries. + +#### 9.2.1.2.10 Implicit affiliation status change completion + +This clause is referenced from other procedures. + +If the IWF performing the participating role has received a SIP 2xx response from the controlling MCPTT function to a SIP request that had triggered an affiliation status change by implicit affiliation as per clause 9.2.1.2.9, the IWF performing the participating role: + +- 1) shall set the affiliation status of the MCPTT group information entry added to the candidate list of the MCPTT group information entries by the procedures of clause 9.2.1.2.9 to "affiliated"; and + +- 2) shall perform the procedures specified in clause 9.2.1.2.5 for the MCPTT ID associated with the user homed in the IWF. + +#### 9.2.1.2.11 Implicit affiliation status change cancellation + +This clause is referenced from other procedures. + +If the IWF performing the participating role for a user homed in the IWF receives a SIP 4xx, 5xx or 6xx response from the controlling MCPTT function to a SIP request that had triggered an affiliation status change by implicit affiliation as per clause 9.2.1.2.9, the IWF performing the participating role: + +- 1) shall remove the MCPTT group ID entry added by the procedures of clause 9.2.1.2.9 such that: + - a) the MCPTT group information entry has the MCPTT group ID set to the MCPTT group ID of the MCPTT group targeted by the received SIP request; + - b) the MCPTT group information entry is in the list of the MCPTT group information entries of an MCPTT client information entry containing the MCPTT client ID associated with the user homed in the IWF; and + - c) the MCPTT client information entry is in the list of the MCPTT client information entries of the MCPTT user information entry containing the MCPTT ID associated with the user homed in the IWF. + +#### 9.2.1.2.12 Automatic affiliation to configured groups procedure + +This clause is referenced from other procedures. + +When the IWF determines that automatic affiliation of a user homed in the IWF to configured groups is needed, the IWF shall perform procedures 9.2.1.2.6 and 9.2.1.2.7 for the user homed in the IWF and the targeted groups. + +### 9.2.1.3 Procedures of MCPTT server owning the MCPTT group + +#### 9.2.1.3.1 General + +The procedures of the IWF owning the MCPTT group consist of: + +- receiving group affiliation status change procedure; +- receiving subscription to affiliation status procedure; +- sending notification of change of affiliation status procedure; +- affiliation eligibility check procedure; +- implicit affiliation eligibility check procedure; +- affiliation status change by implicit affiliation procedure; +- receiving subscription to group dynamic data procedure and; +- sending notification of change of group dynamic data procedure. + +#### 9.2.1.3.2 Stored information + +The IWF maintains information equivalent to that defined in clause 9.2.1.3.2. + +NOTE: The virtual data structure referenced in this clause is for information only. Implementors may choose other means to track affiliation status to groups owned by the IWF. References to the elements of this virtual data structure are made in other clauses with the understanding that implementors choosing not to use this virtual data structure will take other appropriate actions. + +#### 9.2.1.3.3 Receiving group affiliation status change procedure + +Upon receiving a SIP PUBLISH request such that: + +- 1) Request-URI of the SIP PUBLISH request contains the public service identity of the IWF owning the served MCPTT group; +- 2) the SIP PUBLISH request contains an application/vnd.3gpp.mcptt-info+xml MIME body containing the element and the element; +- 3) the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcptt" (coded as specified in 3GPP TS 24.229 [3]), in a P-Asserted-Service header field according to IETF RFC 6050 [7]; +- 4) the Event header field of the SIP PUBLISH request contains the "presence" event type; and +- 5) The SIP PUBLISH request contains an application/pidf+xml MIME body indicating per-group affiliation information constructed according to 3GPP TS 24.379 [29], clause 9.3.1.2, with the IWF acting as the controlling MCPTT function; + +then the IWF: + +- 1) shall identify the served MCPTT group ID in the element of the application/vnd.3gpp.mcptt-info+xml MIME body of the SIP PUBLISH request; +- 2) shall identify the handled MCPTT ID in the element of the application/vnd.3gpp.mcptt-info+xml MIME body of the SIP PUBLISH request; +- 3) if the Expires header field of the SIP PUBLISH request is not included or has nonzero value lower than 4294967295, shall send a SIP 423 (Interval Too Brief) response to the SIP PUBLISH request, where the SIP 423 (Interval Too Brief) response contains a Min-Expires header field set to 4294967295, and shall not continue with the rest of the steps; +- 4) if an MCPTT group for the served MCPTT group ID does not exist in the IWF, shall reject the SIP PUBLISH request with SIP 403 (Forbidden) response to the SIP PUBLISH request according to 3GPP TS 24.229 [3], IETF RFC 3903 [21] and IETF RFC 3856 [24] and skip the rest of the steps; +- 5) if the handled MCPTT ID is not a member of the MCPTT group identified by the served MCPTT group ID, shall reject the SIP PUBLISH request with SIP 403 (Forbidden) response to the SIP PUBLISH request according to 3GPP TS 24.229 [3], IETF RFC 3903 [21] and IETF RFC 3856 [24] and skip the rest of the steps; +- 6) shall respond with SIP 200 (OK) response to the SIP PUBLISH request according to 3GPP TS 24.229 [3], IETF RFC 3903 [21]. In the SIP 200 (OK) response, the IWF: + - a) shall set the Expires header field according to IETF RFC 3903 [21], to the selected expiration time; +- 7) if the "entity" attribute of the element of the application/pidf+xml MIME body of the SIP PUBLISH request is different than the served MCPTT group ID, shall not continue with the rest of the steps; +- 8) if the handled MCPTT ID is different from the MCPTT ID in the "id" attribute of the element of the root element of the application/pidf+xml MIME body of the SIP PUBLISH request, shall not continue with the rest of the steps; +- 9) shall consider an MCPTT group information entry such that: + - a) the MCPTT group information entry is in the list of MCPTT group information entries described in clause 9.2.1.3.2; and + - b) the MCPTT group ID of the MCPTT group information entry is equal to the served MCPTT group ID; +as the served MCPTT group information entry; +- 10) if the selected expiration time is zero: + - a) shall remove the MCPTT user information entry such that: + - i) the MCPTT user information entry is in the list of the MCPTT user information entries of the served MCPTT group information entry; and + - ii) the MCPTT user information entry has the MCPTT ID set to the handled MCPTT ID; +- 11) if the selected expiration time is not zero: + +- a) shall consider an MCPTT user information entry such that: + - i) the MCPTT user information entry is in the list of the MCPTT user information entries of the served MCPTT group information entry; and + - ii) the MCPTT ID of the MCPTT user information entry is equal to the handled MCPTT ID; + as the served MCPTT user information entry; + - b) if the MCPTT user information entry does not exist: + - i) shall insert an MCPTT user information entry with the MCPTT ID set to the handled MCPTT ID into the list of the MCPTT user information entries of the served MCPTT group information entry; and + - ii) shall consider the inserted MCPTT user information entry as the served MCPTT user information entry; and + - c) shall set the following information in the served MCPTT user information entry: + - i) set the MCPTT client ID list according to the "client" attributes of the elements of the element of the element of the root element of the application/pidf+xml MIME body of the SIP PUBLISH request; and + - ii) set the expiration time according to the selected expiration time; +- 12) shall identify the handled p-id in the child element of the root element of the application/pidf+xml MIME body of the SIP PUBLISH request; and +- 13) shall perform the procedures specified in clause 9.2.1.3.5 for the served MCPTT group ID. + +#### 9.2.1.3.4 Receiving subscription to affiliation status procedure + +NOTE: Usage of one SIP SUBSCRIBE request to subscribe for notification about change of affiliation state of several MCPTT users served by the same IWF is not supported in this version of the specification. + +Upon receiving a SIP SUBSCRIBE request such that: + +- 1) Request-URI of the SIP SUBSCRIBE request contains the public service identity of the IWF owning the served MCPTT group; +- 2) the SIP SUBSCRIBE request contains an application/vnd.3gpp.mcptt-info+xml MIME body containing the element and the element; +- 3) the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcptt" (coded as specified in 3GPP TS 24.229 [3]), in a P-Asserted-Service header field according to IETF RFC 6050 [7]; +- 4) the Event header field of the SIP SUBSCRIBE request contains the "presence" event type; and +- 5) the SIP SUBSCRIBE request contains an application/simple-filter+xml MIME body indicating per-user restrictions of presence event package notification information according to 3GPP TS 24.379 [29], clause 9.3.2 indicating the same MCPTT ID as in the element of the application/vnd.3gpp.mcptt-info+xml MIME body of the SIP SUBSCRIBE request; + +then the IWF: + +- 1) shall identify the served MCPTT group ID in the element of the application/vnd.3gpp.mcptt-info+xml MIME body of the SIP SUBSCRIBE request; +- 2) shall identify the handled MCPTT ID in the element of the application/vnd.3gpp.mcptt-info+xml MIME body of the SIP SUBSCRIBE request; +- 3) if the Expires header field of the SIP SUBSCRIBE request is not included or has nonzero value lower than 4294967295, shall send a SIP 423 (Interval Too Brief) response to the SIP SUBSCRIBE request, where the SIP 423 (Interval Too Brief) response contains a Min-Expires header field set to 4294967295, and shall not continue with the rest of the steps; + +- 4) if an MCPTT group for the served MCPTT group ID does not exist in the IWF, shall reject the SIP SUBSCRIBE request with SIP 403 (Forbidden) response to the SIP SUBSCRIBE request according to 3GPP TS 24.229 [3], IETF RFC 3903 [21] and IETF RFC 3856 [24] and skip the rest of the steps; +- 5) if the handled MCPTT ID is not a member of the MCPTT group identified by the served MCPTT group ID, shall reject the SIP SUBSCRIBE request with SIP 403 (Forbidden) response to the SIP SUBSCRIBE request according to 3GPP TS 24.229 [3], IETF RFC 3903 [21] and IETF RFC 3856 [24] and skip the rest of the steps; and +- 6) shall generate and send a SIP 200 (OK) response to the SIP SUBSCRIBE request according to 3GPP TS 24.229 [3], IETF RFC 6665 [25]. + +For the duration of the subscription, the IWF shall notify subscriber about changes of the information of the served MCPTT ID, as described in clause 9.2.1.3.5. + +#### 9.2.1.3.5 Sending notification of change of affiliation status procedure + +In order to notify the subscriber identified by the handled MCPTT ID about changes of the affiliation status of the served MCPTT group ID, the IWF: + +- 1) shall consider an MCPTT group information entry such that: + - a) the MCPTT group information entry is in the list of MCPTT group information entries described in clause 9.2.1.3.2; and + - b) the MCPTT group ID of the MCPTT group information entry is equal to the served MCPTT group ID; +- 2) shall consider an MCPTT user information entry such: + - a) the MCPTT user information entry is in the list of the MCPTT user information entries of the served MCPTT group information entry; and + - b) the MCPTT ID of the MCPTT user information entry is equal to the handled MCPTT ID;as the served MCPTT user information entry; +- 3) shall generate an application/pidf+xml MIME body indicating per-group affiliation information according to 3GPP TS 24.379 [29], clause 9.3.1 and the served list of the served MCPTT user information entry of the MCPTT group information entry with following clarifications: + - a) the MCPTT server shall include the "expires" attribute in the element; and + - b) if this procedure is invoked by procedure in clause 9.2.1.3.3 where the handled p-id was identified, the IWF shall set the child element of the root element of the application/pidf+xml MIME body of the SIP NOTIFY request to the handled p-id value; and +- 4) send a SIP NOTIFY request according to 3GPP TS 24.229 [3], and IETF RFC 6665 [25] for the subscription created in clause 9.2.1.3.4. In the SIP NOTIFY request, the IWF shall include the generated application/pidf+xml MIME body indicating per-group affiliation information. + +#### 9.2.1.3.6 Implicit affiliation eligibility check procedure + +This clause is referenced from other procedures. + +Upon receiving a SIP request for an MCPTT group that the MCPTT user is not currently affiliated to and that requires the IWF performing the controlling role to check on the eligibility of the MCPTT user to be implicitly affiliated to the MCPTT group, the IWF performing the controlling role: + +- 1) shall perform the procedures of clause 9.2.1.3.8 to determine if the MCPTT user is eligible to be affiliated to the MCPTT group; and +- 2) if the MCPTT user was determined eligible to be affiliated to the MCPTT group by the procedures of clause 9.2.1.3.8, shall consider the MCPTT user to be eligible for implicit affiliation to the MCPTT group. + +#### 9.2.1.3.7 Affiliation status change by implicit affiliation procedure + +This clause is referenced from other procedures. + +Upon receiving a SIP request for an MCPTT group that the MCPTT user is not currently affiliated to and that requires the IWF performing the controlling role to perform an implicit affiliation to, the IWF performing the controlling role: + +- 1) shall identify the served MCPTT group ID in the element of the application/vnd.3gpp.mcptt-info+xml MIME body of the SIP request; +- 2) shall identify the handled MCPTT ID in the element of the application/vnd.3gpp.mcptt-info+xml MIME body of the SIP request; +- 3) shall consider an MCPTT group information entry such that: + - a) the MCPTT group information entry is in the list of MCPTT group information entries described in clause 9.2.1.3.2 with the IWF acting as the controlling MCPTT function; and + - b) the MCPTT group ID of the MCPTT group information entry is equal to the served MCPTT group ID;as the served MCPTT group information entry; +- 4) shall consider an MCPTT user information entry such that: + - a) the MCPTT user information entry is in the list of the MCPTT user information entries of the served MCPTT group information entry; and + - b) the MCPTT ID of the MCPTT user information entry is equal to the handled MCPTT ID;as the served MCPTT user information entry; +- c) if the MCPTT user information entry does not exist: + - i) shall insert an MCPTT user information entry with the MCPTT ID set to the handled MCPTT ID into the list of the MCPTT user information entries of the served MCPTT group information entry; and + - ii) shall consider the inserted MCPTT user information entry as the served MCPTT user information entry; and +- d) shall make the following modifications in the served MCPTT user information entry: + - i) add the MCPTT client ID derived from the received SIP request to the MCPTT client ID list if not already present; and + - ii) set the expiration time as determined by local policy; + +- 5) shall perform the procedures specified in clause 9.2.1.3.5 for the served MCPTT group ID. + +#### 9.2.1.3.8 Affiliation eligibility check procedure + +This clause is referenced from other procedures. + +Upon receiving a SIP request for an MCPTT group that the MCPTT user is not currently affiliated to and that requires the IWF performing the controlling role to check on the eligibility of the MCPTT user to be affiliated to the MCPTT group, the IWF performing the controlling role: + +- 1) shall identify the served MCPTT group ID in the element of the application/vnd.3gpp.mcptt-info+xml MIME body of the SIP request; +- 2) shall identify the handled MCPTT ID in the element of the application/vnd.3gpp.mcptt-info+xml MIME body of the SIP request; +- 3) if an MCPTT group for the served MCPTT group ID does not exist in the IWF, shall consider the MCPTT user to be ineligible for affiliation and skip the rest of the steps; +- 4) if the handled MCPTT ID is not a member of the MCPTT group identified by the served MCPTT group ID, shall consider the MCPTT user to be ineligible for affiliation and skip the rest of the steps; + +- 5) if there is no MCPTT group information entry in the list of MCPTT group information entries described in clause 9.2.1.3.2, with the IWF acting as the controlling MCPTT function, with an MCPTT group identity matching the served MCPTT group ID, then shall consider the MCPTT user to be ineligible for affiliation and skip the rest of the steps; or +- 6) shall consider the MCPTT user to be eligible for affiliation. + +#### 9.2.1.3.9 Receiving subscription to group dynamic data procedure + +Upon receiving a SIP SUBSCRIBE request such that: + +- 1) Request-URI of the SIP SUBSCRIBE request contains the public service identity of the IWF owning the served MCPTT group; +- 2) the SIP SUBSCRIBE request contains an application/vnd.3gpp.mcptt-info+xml MIME body containing the element and the element; +- 3) the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcptt" (coded as specified in 3GPP TS 24.229 [3]), in a P-Asserted-Service header field according to IETF RFC 6050 [7]; +- 4) the Event header field of the SIP SUBSCRIBE request contains the "presence" event type; and +- 5) the SIP SUBSCRIBE request contains an application/simple-filter+xml MIME body indicating per-group dynamic data of presence event package notification information according to 3GPP TS 24.379 [29] clause 9.3.2 indicating the same MCPTT group ID as in the element of the application/vnd.3gpp.mcptt-info+xml MIME body of the SIP SUBSCRIBE request; + +then the IWF: + +- 1) shall identify the served MCPTT group ID in the element of the application/vnd.3gpp.mcptt-info+xml MIME body of the SIP SUBSCRIBE request; +- 2) shall identify the handled MCPTT ID in the element of the application/vnd.3gpp.mcptt-info+xml MIME body of the SIP SUBSCRIBE request; +- 3) if the Expires header field of the SIP SUBSCRIBE request is not included or has nonzero value lower than 4294967295, shall send a SIP 423 (Interval Too Brief) response to the SIP SUBSCRIBE request, where the SIP 423 (Interval Too Brief) response contains a Min-Expires header field set to 4294967295, and shall not continue with the rest of the steps; +- 4) if an MCPTT group for the served MCPTT group ID does not exist in the IWF, shall reject the SIP SUBSCRIBE request with SIP 403 (Forbidden) response to the SIP SUBSCRIBE request according to 3GPP TS 24.229 [3], IETF RFC 3903 [21] and IETF RFC 3856 [24] and skip the rest of the steps; +- 5) if the IWF does not support receiving a SIP SUBSCRIBE request to the group dynamic data of a group owned by the IWF, the IWF shall generate and send a SIP 501 (Not Implemented) response to the SIP SUBSCRIBE request according to 3GPP TS 24.229 [3], IETF RFC 6665 [25], and skip the rest of the steps; +- 6) if the handled MCPTT ID is not authorized to subscribe to group dynamic data of the MCPTT group identified by the served MCPTT group ID, shall reject the SIP SUBSCRIBE request with SIP 403 (Forbidden) response to the SIP SUBSCRIBE request according to 3GPP TS 24.229 [3], IETF RFC 3903 [21] and IETF RFC 3856 [24] and skip the rest of the steps; and +- 7) shall generate a SIP 200 (OK) response to the SIP SUBSCRIBE request according to 3GPP TS 24.229 [3], IETF RFC 6665 [25]. + +For the duration of the subscription, the MCPTT server shall notify subscriber about changes of the information of the served MCPTT ID, as described in clause 9.2.1.3.10. + +#### 9.2.1.3.10 Sending notification of change of group dynamic data procedure + +In order to notify the subscriber identified by the handled MCPTT ID about changes of the per-group dynamic data of the served MCPTT group ID, the IWF: + +- 1) shall consider an MCPTT group information entry such that: + +- a) the MCPTT group information entry is in the list of MCPTT group information entries described in clause 9.2.1.3.2; and + - b) the MCPTT group ID of the MCPTT group information entry is equal to the served MCPTT group ID; +- 2) shall generate an application/pidf+xml MIME body indicating per-group dynamic data according to 3GPP TS 24.379 [29], clause 9.3.1 with the following clarifications: + - a) the IWF shall include the "expires" attribute in the element; and + - 3) shall send a SIP NOTIFY request according to 3GPP TS 24.229 [3], and IETF RFC 6665 [25] for the subscription created in clause 9.2.1.3.8. In the SIP NOTIFY request, the IWF shall include the generated application/pidf+xml MIME body indicating per-group dynamic data. + +--- + +## 10 Call signalling - group call + +### 10.1 Prearranged group call + +#### 10.1.2 Client derived procedures + +##### 10.1.2.1 IWF originating procedures + +This clause is referred to by other clauses. + +To establish an MCPTT prearranged group session, the IWF performing the participating role shall generate an initial SIP INVITE request by following the UE originating session procedures specified in 3GPP TS 24.229 [3], with the clarifications given below. + +The IWF performing the participating role: + +- 1) if originating an MCPTT emergency group call or originating an MCPTT prearranged group call and the MCPTT emergency state is already set, the IWF performing the participating role shall comply with the procedures in clause 6.4.1.1; +- 2) if originating an MCPTT imminent peril group call, the IWF performing the participating role shall comply with the procedures in clause 6.4.1.6; +- 3) if originating a broadcast group call, the IWF performing the participating role shall include in the application/vnd.3gpp.mcptt-info+xml MIME body the element set to "true" as defined in 3GPP TS 24.379 [29], clause F.1; +- 4) shall include the g.3gpp.mcptt media feature tag and the g.3gpp.icsi-ref media feature tag with the value of "urn:urn-7:3gpp-service.ims.icsi.mcptt" in the Contact header field of the SIP INVITE request according to IETF RFC 3840 [9]; +- 5) shall include an Accept-Contact header field containing the g.3gpp.mcptt media feature tag along with the "require" and "explicit" header field parameters according to IETF RFC 3841 [5]; +- 6) shall include an Accept-Contact header field with the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcptt" along with the "require" and "explicit" header field parameters according to IETF RFC 3841 [5]; +- 7) should include the "timer" option tag in the Supported header field; +- 8) should include the Session-Expires header field according to IETF RFC 4028 [6]. It is recommended that the "refresher" header field parameter is omitted. If included, the "refresher" header field parameter shall be set to "uac"; + +- 9) if the emergency group state for this group is set to "MEG 2: in-progress" or "MEG 4: confirm-pending", the IWF performing the participating role shall include the Resource-Priority header field and comply with the procedures in clause 6.4.1.2; +- 10) if the imminent peril group state for this group is set to "MIG 2: in-progress" or "MIG 4: confirm-pending" shall include the Resource-Priority header field and comply with the procedures in clause 6.4.1.8; +- 11) shall contain an application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with: + - a) the element set to a value of "prearranged"; + - b) the element set to the group identity; + - c) the element set to a value determined by the IWF; and + +NOTE 1: How the IWF determines the value of the element is out of scope of the present document. + +- d) if the group identity can be determined to be a TGI and if the IWF performing the participating role can associate the TGI with a MCPTT group ID, the element set to the MCPTT group ID; + +NOTE 2: The MCPTT ID will be inserted into the body of the SIP INVITE request by the referring clause. + +NOTE 3: The text "can associate the TGI with a MCPTT group ID" means that the IWF performing the participating role is able to determine that there is a constituent group of the temporary group that it is a member of. + +NOTE 4: The IWF performing the participating role is informed about temporary groups and regrouping of MCPTT groups that the users homed in the IWF are members of as specified in 3GPP TS 24.481 [16]. + +NOTE 5: If the TGI has several MCPTT groups as constituent groups, where the user homed in the IWF is a member, the IWF performing the participating role selects one of those MCPTT groups. + +- 12) shall include an SDP offer according to 3GPP TS 24.229 [3] with the clarifications given in clause 6.1.1; and +- 13) if an implicit floor request is required, shall indicate this as specified in clause 6.7; and shall skip the rest of the steps. + +On receiving a SIP 2xx response to the SIP INVITE request, the IWF performing the participating role: + +- 1) shall interact with the user plane as specified in 3GPP TS 29.380 [31]; +- 2) if the MCPTT emergency group call state is set to "MEGC 2: emergency-call-requested" or "MEGC 3: emergency-call-granted" or the MCPTT imminent peril group call state is set to "MIGC 2: imminent-peril-call-requested" or "MIGC 3: imminent-peril-call-granted", the IWF performing the participating role shall perform the actions specified in clause 6.4.1.4; and +- 3) may subscribe to the conference event package as specified in clause 10.3. + +On receiving a SIP 4xx response, a SIP 5xx response or a SIP 6xx response to the SIP INVITE request: + +- 1) if the MCPTT emergency group call state is set to "MEGC 2: emergency-call-requested" or "MEGC 3: emergency-call-granted"; or +- 2) if the MCPTT imminent peril group call state is set to "MIGC 2: imminent-peril-call-requested" or "MIGC 3: imminent-peril-call-granted"; + +the IWF performing the participating role shall perform the actions specified in clause 6.4.1.5. + +On receiving a SIP INFO request where the Request-URI contains an MCPTT session ID identifying an ongoing group session, the IWF performing the participating role shall follow the actions specified in clause 6.4.1.9. + +## 10.1.2.2 IWF performing the participating role terminating procedures + +This clause is referenced from other procedures. + +In the procedures in this clause: + +- 1) emergency indication in an incoming SIP INVITE request refers to the element of the application/vnd.3gpp.mcptt-info+xml MIME body; and +- 2) imminent peril indication in an incoming SIP INVITE request refers to the element of the application/vnd.3gpp.mcptt-info+xml MIME body. + +The IWF performing the participating role: + +- 1) may reject the SIP INVITE request, + +NOTE: The conditions under which the IWF rejects the request are out of scope of the present document. + +- 2) if the SIP INVITE request is rejected in step 1), shall respond towards the controlling MCPTT function either with an appropriate reject code as specified in 3GPP TS 24.229 [3] and warning texts as specified in clause 4.2.2 or with a SIP 480 (Temporarily unavailable) response and skip the rest of the steps of this clause; +- 3) if the SIP INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with the element set to a value of "true": + - a) shall set the MCPTT emergency group state to "MEG 2: in-progress"; + - b) shall set the MCPTT imminent peril group state to "MIG 1: no-imminent-peril"; and + - c) shall set the MCPTT imminent peril group call state to "MIGC 1: imminent-peril-gc-capable"; otherwise +- 4) if the SIP INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with the element set to a value of "true", shall set the MCPTT imminent peril group state to "MIG 2: in-progress"; +- 5) shall perform the automatic commencement procedures specified in clause 6.2.1 if one of the following conditions are met: + - a) if the SIP INVITE request contains an Answer-Mode header field with the value "Auto" and IWF is configured for automatic commencement mode for receiving the call; + - b) if the SIP INVITE request contains an Answer-Mode header field with the value "Auto" and IWF is configured to allow automatic commencement mode for receiving the call; or + - c) SIP INVITE request contains an Answer-Mode header field with the value "Manual" and IWF is not configured to allow manual commencement mode for receiving the call; +- 6) shall perform the manual commencement procedures specified in clause 6.2.2 if one of the following conditions are met: + - a) if the SIP INVITE request contains an Answer-Mode header field with the value "Manual" and IWF is configured for manual commencement mode for receiving the call; + - b) if the SIP INVITE request contains an Answer-Mode header field with the value "Manual" and IWF is configured to allow manual commencement mode for receiving the call; or + - c) SIP INVITE request contains an Answer-Mode header field with the value "Automatic" and IWF is not configured to allow automatic commencement mode for receiving the call; and +- 7) when the SIP 200 (OK) response to the SIP INVITE request is sent, may subscribe to the conference event package as specified in clause 10.3. + +### 10.1.2.3 MCPTT upgrade to in-progress emergency or imminent peril + +This clause is referenced from other procedures. + +To upgrade the MCPTT group session to an emergency condition or an imminent peril condition on an MCPTT prearranged group, the IWF performing the participating role shall perform the steps below. + +- 1) if the request is to upgrade the MCPTT group session to an MCPTT emergency call, the IWF performing the participating role: + - a) shall include an application/vnd.3gpp.mcptt-info+xml MIME body populated as specified in clause 6.4.1.1; and + - b) shall include a Resource-Priority header field and comply with the procedures in clause 6.4.1.2. + - 2) if the MCPTT user has requested to upgrade the MCPTT group session to an MCPTT imminent peril call, the IWF performing the participating role: + - a) shall include an application/vnd.3gpp.mcptt-info+xml MIME body populated as specified in clause 6.4.1.6; and + - b) shall include a Resource-Priority header field and comply with the procedures in clause 6.4.1.8; + - 3) if the SIP re-INVITE request is to be sent within an on-demand session, shall include in the SIP re-INVITE request an SDP offer according to 3GPP TS 24.229 [3] with the clarifications specified in clause 6.1.1; +- NOTE: The SIP re-INVITE request can be sent within an on-demand session. +- 4) if an implicit floor request is required, shall indicate this as specified in clause 6.7; and + - 5) shall exit the procedure in the present clause. + +On receiving a SIP 2xx response to the SIP re-INVITE request the IWF performing the participating role: + +- 1) shall perform the actions specified in clause 6.4.1.4. + +On receiving a SIP INFO request where the Request-URI contains an MCPTT session ID identifying an ongoing group session, the IWF performing the participating role shall follow the actions specified in clause 6.4.1.9. + +On receiving a SIP 4xx response, SIP 5xx response or a SIP 6xx response to the SIP re-INVITE request the IWF performing the participating role shall perform the actions specified in clause 6.4.1.5. + +#### 10.1.2.4 MCPTT in-progress emergency cancel + +This clause is referenced from other procedures. + +To cancel the in-progress emergency condition on a prearranged MCPTT group, the IWF performing the participating role shall generate a SIP re-INVITE request by following the UE originating session procedures specified in 3GPP TS 24.229 [3], with the clarifications given below. + +The IWF performing the participating role: + +- 1) shall, if cancelling an in-progress emergency condition and optionally an MCPTT emergency alert originated by the user homed in the IWF, include an application/vnd.3gpp.mcptt-info+xml MIME body populated as specified in clause 6.4.1.3; +- 2) shall include in the application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with: + - a) the element set to a value of "prearranged"; and + - b) the element set to the group identity; +- 3) shall set the element of the application/vnd.3gpp.mcptt-info+xml MIME body of the SIP re-INVITE request to the MCPTT ID of the calling user; +- 4) shall include the g.3gpp.mcptt media feature tag in the Contact header field of the SIP re-INVITE request according to IETF RFC 3840 [9]; +- 5) shall include in the SIP re-INVITE request an SDP offer according to 3GPP TS 24.229 [3] with the clarifications specified in clause 6.1.1; +- 6) shall include a Resource-Priority header field and comply with the procedures in clause 6.4.1.2; and + +- 7) shall exit the procedure in the present clause. + +On receiving a SIP 2xx response to the SIP re-INVITE request, the IWF performing the participating role: + +- 1) shall interact with the user plane as specified in 3GPP TS 29.380 [31]; +- 2) shall set the MCPTT emergency group state of the group to "MEG 1: no-emergency"; +- 3) shall set the MCPTT emergency group call state of the group to "MEGC 1: emergency-gc-capable"; and +- 4) if the MCPTT emergency alert state is set to "MEA 4: Emergency-alert-cancel-pending", the sent SIP re-INVITE request did not contain an element in the application/vnd.3gpp.mcptt-info+xml MIME body and the SIP 2xx response to the SIP request for a priority group call does not contain a Warning header field as specified in clause 4.4 with the warning text containing the mcptt-warn-code set to "149", shall set the MCPTT emergency alert state to "MEA 1: no-alert". + +On receiving a SIP INFO request where the Request-URI contains an MCPTT session ID identifying an ongoing group session, the IWF performing the participating role shall follow the actions specified in clause 6.4.1.9 with the IWF acting as the MCPTT client. + +On receiving a SIP 4xx response, SIP 5xx response or SIP 6xx response to the SIP re-INVITE request: + +- 1) shall set the MCPTT emergency group state as "MEG 2: in-progress"; +- 2) if the SIP 4xx response, SIP 5xx response or SIP 6xx response contains an application/vnd.3gpp.mcptt-info+xml MIME body with an element set to a value of "true" and the sent SIP re-INVITE request did not contain an element in the application/vnd.3gpp.mcptt-info+xml MIME body, the IWF performing the participating role shall set the MCPTT emergency alert state to "MEA 3: emergency-alert-initiated"; and +- 3) if the SIP 4xx response, SIP 5xx response or SIP 6xx response did not contain an application/vnd.3gpp.mcptt-info+xml MIME body with an element and did not contain an element, the MCPTT emergency alert (MEA) state shall revert to its value prior to entering the current procedure. + +NOTE: If the in-progress emergency group state cancel request is rejected, the state of the session does not change, i.e. continues with MCPTT emergency group call level priority. + +### 10.1.2.5 MCPTT in-progress imminent peril cancel + +This clause is referenced from other procedures. + +To cancel the in-progress imminent peril condition on a prearranged MCPTT group, the IWF performing the participating role shall generate a SIP re-INVITE request by following the procedures specified in 3GPP TS 24.229 [3], with the clarifications given below. + +The IWF performing the participating role: + +- 1) shall include an application/vnd.3gpp.mcptt-info+xml MIME body populated as specified in clause 6.4.1.7; +- 2) shall include a Resource-Priority header field and comply with the procedures in clause 6.4.1.8; +- 3) shall include in the application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with: + - a) the element set to a value of "prearranged"; and + - b) the element set to the group identity; +- 4) shall set the element of the application/vnd.3gpp.mcptt-info+xml MIME body of the SIP re-INVITE request to the MCPTT ID of the calling user; +- 5) shall include the g.3gpp.mcptt media feature tag in the Contact header field of the SIP re-INVITE request according to IETF RFC 3840 [9]; +- 6) shall include in the SIP re-INVITE request an SDP offer according to 3GPP TS 24.229 [3] with the clarifications specified in clause 6.1.1; and + +- 7) shall exit the procedure in the present clause. + +On receiving a SIP 2xx response to the SIP re-INVITE request, the IWF performing the participating role: + +- 1) shall interact with the user plane as specified in 3GPP TS 29.380 [31]; +- 2) shall set the MCPTT imminent peril group state of the group to "MIG 1: no-imminent-peril"; and +- 3) shall set the MCPTT imminent peril group call state of the group to "MIGC 1: imminent-peril-gc-capable". + +On receiving a SIP 4xx, SIP 5xx response or SIP 6xx response to the SIP re-INVITE request: + +- 1) if the SIP 4xx response, SIP 5xx response or SIP 6xx response: + - a) contains an application/vnd.3gpp.mcptt-info+xml MIME body with an element set to a value of "true"; or + - b) does not contain an application/vnd.3gpp.mcptt-info+xml MIME body with an element; + +then the IWF performing the participating role shall set the MCPTT imminent peril group state as "MIG 2: in-progress". + +NOTE: This is the case where the IWF performing the participating role requested the cancellation of the MCPTT imminent peril in-progress state and was rejected. + +### 10.1.2.6 Reception of SIP re-INVITE request + +This clause is referred to by other clauses. + +The IWF: + +- 1) if the SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with the element set to a value of "true": + - a) shall set the MCPTT emergency group state to "MEG 2: in-progress"; + - b) shall set the MCPTT imminent peril group state to "MIG 1: no-imminent-peril"; and + - c) shall set the MCPTT imminent peril group call state to "MIGC 1: imminent-peril-gc-capable"; + - 2) if the SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with the element set to a value of "true": + - a) shall set the MCPTT imminent peril group state to "MIG 2: in-progress"; + - 3) if the SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with the element set to a value of "false": + - a) if the element containing the element contains an <>alert-ind> element set to "false": + - i) if the SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body including an element: + - A) if the MCPTT ID contained in the element is the MCPTT ID of the receiving user homed in the IWF, shall set the MCPTT emergency alert state to "MEA 1: no-alert"; + - b) shall set the MCPTT emergency group state to "MEG 1: no-emergency"; and + - c) if the MCPTT emergency group call state of the group is set to "MEGC 3: emergency-call-granted", shall set the MCPTT emergency group call state of the group to "MEGC 1: emergency-gc-capable"; +- 4) if the SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with the element set to a value of "false": + +- a) shall set the MCPTT imminent peril group state to "MIG 1: no-imminent-peril"; and + - b) shall set the MCPTT imminent peril group call state to "MIGC 1: imminent-peril-gc-capable"; +- 5) shall accept the SIP re-INVITE request and generate a SIP 200 (OK) response according to rules and procedures of 3GPP TS 24.229 [3]; + - 6) shall include the g.3gpp.mcptt media feature tag in the Contact header field of the SIP 200 (OK) response; + - 7) shall include the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcptt" in the Contact header field of the SIP 200 (OK) response; and + - 8) shall include an SDP answer in the SIP 200 (OK) response to the SDP offer in the incoming SIP re-INVITE request according to 3GPP TS 24.229 [3] with the clarifications given in clause 6.1.2. + +### 10.1.3 IWF participating role procedures + +#### 10.1.3.1 Originating procedures + +##### 10.1.3.1.1 On demand prearranged group call + +**Editor's Note:** Behaviour for cases where the IWF affiliates on behalf of its LMR users is FFS. + +In this clause, the IWF originates a prearranged group session on behalf of an LMR user. + +NOTE 1: How the IWF determines the MCPTT ID of the calling user is out of scope of the present document. + +The IWF, performing the originating participating function: + +- 1) if the user identified by the MCPTT ID is not affiliated to the group as determined by clause 9.2.1.2.8 and this is an authorised request for originating a priority call as determined by clause 6.6.2.1.4.2, shall perform the actions specified in clause 9.2.1.2.9 for implicit affiliation; +- 2) shall determine the public service identity of the controlling MCPTT function associated with the group identity of the group on which the call is to be originated; + +NOTE 2: How the IWF discovers the public service identity of the controlling MCPTT function associated with the group identity is out of scope of the present document. + +- 3) shall generate a SIP INVITE request as specified in clause 10.1.2.1; +- 4) shall modify the SIP INVITE request as specified in clause 6.6.2.1.2; +- 5) may insert the calling user's location information into an application/vnd.3gpp.mcptt-location-info+xml MIME body to be included in the outgoing SIP request; +- 6) shall set the Request-URI to the public service identity of the controlling MCPTT function associated with the group identity; +- 7) shall set the element of the application/vnd.3gpp.mcptt-info+xml MIME body of the SIP INVITE request to the MCPTT ID of the calling user; +- 8) shall update the SDP as specified in clause 6.6.2.1.1.1; and +- 9) shall send the SIP INVITE request to the controlling MCPTT function as specified in 3GPP TS 24.229 [3]. + +Upon receipt of a SIP 302 (Moved Temporarily) response to the above SIP INVITE request, the participating IWF function: + +- 1) shall generate a SIP INVITE request as specified in clause 6.6.2.1.5; +- 2) shall include an SDP offer based upon the SDP offer in the SIP INVITE request generated by the IWF in the step above; and +- 3) shall forward the SIP INVITE request according to 3GPP TS 24.229 [3]. + +Upon receipt of a SIP 2xx response in response to the above SIP INVITE request, the IWF performing the participating role: + +NOTE 3: If an element is received, the IWF ignores that element. + +- 1) if the procedures of clause 9.2.1.2.9 for implicit affiliation were performed in the present clause, shall complete the implicit affiliation by performing the procedures of clause 9.2.1.2.10; +- 2) shall start the SIP Session timer according to rules and procedures of IETF RFC 4028 [6]. +- 3) shall perform the steps for SIP 2xx as specified in clause 10.1.2.1. + +Upon receipt of a SIP 4xx, 5xx or 6xx response to the above SIP INVITE request, the participating IWF function: + +- 1) if the implicit affiliation procedures of clause 9.2.1.2.9 were invoked in this procedure, shall perform the procedures of clause 9.2.1.2.11; and +- 2) shall perform the steps for the received SIP 4xx, 5xx or 6xx as specified in clause 10.1.2.1. + +On receiving a SIP INFO request where the Request-URI contains an MCPTT session ID identifying an ongoing group session, the IWF shall perform the steps for the received SIP INFO in clause 10.1.2.1. + +#### 10.1.3.1.2 Sending of a SIP re-INVITE request towards MCPTT controlling function + +Upon a need to send a SIP re-INVITE request for an MCPTT session identifying an on-demand prearranged MCPTT group session, the IWF performing the participating role: + +- 1) if the request is for an upgrade to an in-progress emergency or an imminent peril, shall perform the steps in clause 10.1.2.3; +- 2) if the request is for a cancellation of an in-progress emergency, shall perform the steps in clause 10.1.2.4; +- 3) if the request is for a cancellation of an in-progress imminent peril, shall perform the steps in clause 10.1.2.5; +- 4) shall include the MCPTT ID of the originating user in element of the application/vnd.3gpp.mcptt-info+xml MIME body of the SIP re-INVITE request; + +NOTE 1: How the IWF determines the MCPTT ID of a user homed in the IWF is out of scope of the present document. + +- 5) shall include in the SIP re-INVITE request an SDP offer as specified in clause 6.6.2.1.1; +- 6) if the SIP re-INVITE requires a Resource-Priority header field, shall include a Resource-Priority header field according to 6.4.1.11; and +- 7) shall send the SIP re-INVITE request according to 3GPP TS 24.229 [3]. + +Upon receipt of a SIP 2xx response to the above SIP re-INVITE request, the IWF performing the participating role: + +- 1) shall interact with the media plane as specified in 3GPP TS 29.380 [31]; +- 2) if the request in the present clause above is for an upgrade for emergency or imminent peril, shall follow the procedures for SIP 200 (OK) response as specified in clause 10.1.2.3; +- 3) if the request in the present clause above is for an in-progress emergency cancel, shall follow the procedures for SIP 200 (OK) response as specified in clause 10.1.2.4; and +- 4) if the request in the present clause above is for an in-progress imminent peril cancel, shall follow the procedures for SIP 200 (OK) response as specified in clause 10.1.2.5. + +Upon receipt of a SIP 403 (Forbidden) response to the above SIP re-INVITE request, the IWF performing the participating role shall interact with the media plane as specified in 3GPP TS 29.380 [31]. + +On receiving a SIP 4xx response, a SIP 5xx response or a SIP 6xx response to the SIP re-INVITE request, the IWF performing the participating role: + +- 1) if the request in the present clause above is for an upgrade for emergency or imminent peril, shall follow the procedures for SIP 4xx, SIP 5xx and SIP 6xx responses as specified in clause 10.1.2.3; +- 2) if the request in the present clause above is for an in-progress emergency cancel, shall follow the procedures for SIP 4xx, SIP 5xx and SIP 6xx responses as specified in clause 10.1.2.4; or +- 3) if the request in the present clause above is for an in-progress imminent peril cancel, shall follow the procedures for SIP 4xx, SIP 5xx and SIP 6xx responses as specified in clause 10.1.2.5. + +Upon receiving a SIP INFO request where the Request-URI contains an MCPTT session ID identifying an ongoing session, the IWF performing the participating role: + +- 1) if the SIP re-INVITE request in the present clause above is for an upgrade for emergency or imminent peril, shall follow the procedures for SIP INFO as specified in clause 10.1.2.3; +- 2) if the SIP re-INVITE request in the present clause above is for an in-progress emergency cancel, shall follow the procedures for SIP INFO as specified in clause 10.1.2.4; or +- 3) if the SIP re-INVITE request in the present clause above is for an in-progress imminent peril cancel, shall follow the procedures for SIP INFO as specified in clause 10.1.2.5. + +### 10.1.3.2 Terminating Procedures + +In the procedures in this clause: + +- 1) emergency indication in an incoming SIP INVITE request refers to the element of the application/vnd.3gpp.mcptt-info+xml MIME body; and +- 2) imminent peril indication in an incoming SIP INVITE request refers to the element of the application/vnd.3gpp.mcptt-info+xml MIME body. + +Upon receipt of a "SIP INVITE request for terminating participating MCPTT function", the IWF performing the participating role: + +- 1) if unable to process the request due to a lack of resources or a risk of congestion exists, may reject the SIP INVITE request with a SIP 500 (Server Internal Error) response. The IWF performing the participating role may include a Retry-After header field to the SIP 500 (Server Internal Error) response as specified in IETF RFC 3261 [14], and shall not continue with the rest of the steps; +- 2) shall check the presence of the isfocus media feature tag in the URI of the Contact header field and if it is not present then the IWF performing the participating role shall reject the request with a SIP 403 (Forbidden) response with the warning text set to "104 isfocus not assigned" in a Warning header field as specified in clause 4.4, and shall not continue with the rest of the steps; +- 3) may reject the request with a SIP 480 (Temporarily Unavailable) response with the warning text set to "146 T-PF unable to determine the service settings for the called user" in a Warning header field as specified in 3GPP TS 24.379 [29], clause 4.4, with the IWF acting as the MCPTT server and shall not continue with the rest of the steps; and + +NOTE: If an element is received, the IWF ignores it. + +- 4) shall perform the steps in 3GPP TS 24.379 [29], clause 10.1.2.1.2. + +### 10.1.3.3 IWF participating role ending group call + +#### 10.1.3.3.1 IWF ending group call on-demand + +When the IWF performing the participating role determines it has to send a SIP BYE request, the IWF shall follow the procedures as specified in clause 6.6.2.1.3. + +### 10.1.3.4 End group call at the IWF performing the participating role + +#### 10.1.3.4.1 Receipt of SIP BYE request for private call on-demand + +Upon receiving a SIP BYE request from the controlling MCPTT function, the IWF performing the participating role shall follow the procedures as specified in clause 6.6.2.2.2.1. + +### 10.1.3.5 Re-join procedures + +#### 10.1.3.5.1 Originating procedures - on demand prearranged group call + +To rejoin an on demand prearranged group call, the IWF performing the participating role shall follow the procedures specified in clause 10.1.3.1.1 with the clarification that the Request-URI of the SIP INVITE request shall contain a URI of the MCPTT session identity to re-join. + +### 10.1.3.6 Reception of a SIP re-INVITE request for terminating a priority call + +In the procedures in this clause: + +- 1) emergency indication in an incoming SIP INVITE request refers to the element of the application/vnd.3gpp.mcptt-info+xml MIME body; and +- 2) imminent peril indication in an incoming SIP INVITE request refers to the element of the application/vnd.3gpp.mcptt-info+xml MIME body. + +Upon receipt of a SIP re-INVITE request for an MCPTT group containing an emergency indication or imminent peril indication, the IWF performing the participating role: + +- 1) shall perform the steps in clause 10.1.2.6; +- 2) shall interact with the media plane as specified in 3GPP TS 29.380 [31]; and +- 3) shall send the SIP 200 (OK) response according to 3GPP TS 24.229 [3]. + +## 10.1.4 IWF Controlling role procedures + +### 10.1.4.1 Originating Procedures + +#### 10.1.4.1.1 INVITE targeted to an MCPTT client + +This clause describes the procedures for inviting an MCPTT user to an MCPTT session. The procedure is initiated by the IWF performing the controlling role as the result of a request from the LMR system or an action in clause 10.1.4.2 or as the result of receiving a SIP 403 (Forbidden) response as described in this clause. + +The IWF performing the controlling role: + +- 1) shall generate a SIP INVITE request as specified in clause 6.6.3.1.1; +- 2) shall set the Request-URI to the public service identity of the terminating participating MCPTT function associated to the MCPTT user to be invited; + +NOTE 1: How the IWF performing the controlling role finds the address of the terminating MCPTT participating function is out of the scope of the current release. + +NOTE 2: If the terminating MCPTT user is part of a partner MCPTT system, then the public service identity can identify an entry point in the partner network that is able to identify the terminating participating MCPTT function. + +- 3) shall set the P-Asserted-Identity header field to the public service identity of the IWF performing the controlling role; +- 4) shall include in the application/vnd.3gpp.mcptt-info+xml MIME body in the outgoing SIP INVITE request: + +- a) the element set to the MCPTT ID of the terminating user; and +- b) the element set to the group identity; + +NOTE 3: The is already included in the MIME body as a result of calling clause 6.6.3.1.1 in step 1). + +- 5) shall include in the SIP INVITE request an SDP offer based on the SDP offer in the received SIP INVITE request from the originating network according to the procedures specified in TS 24.379 [29], clause 6.3.3.1.1, with the IWF acting as the controlling MCPTT function; +- 6) if the in-progress emergency state of the group is set to a value of "true" the IWF performing the controlling role: + - a) shall include a Resource-Priority header field populated with the values for an MCPTT emergency group call as specified in clause 6.6.3.1.12. + - b) if the IWF needs to set the group state to emergency: + - i) shall include in the outgoing SIP INVITE request in the application/vnd.3gpp.mcptt-info+xml MIME body an element set to a value of "true"; and + - ii) if the IWF needs to set an emergency alert and the MCPTT group is authorised for the initiation of MCPTT emergency alerts as determined by the procedures of clause 6.6.3.1.8.1, shall populate the application/vnd.3gpp.mcptt-info+xml MIME body and the application/vnd.3gpp.mcptt-location-info+xml MIME body as specified in clause 6.6.3.1.7. Otherwise, shall set the <>alert-ind> element to a value of "false"; and + - c) if the in-progress imminent peril state of the group is set to a value of "true" shall include in the application/vnd.3gpp.mcptt-info+xml MIME body an element set to a value of "false"; +- 7) if the in-progress emergency state of the group is set to a value of "false" and the in-progress imminent peril state of the group is set to a value of "true", the IWF performing the controlling role: + - a) shall include a Resource-Priority header field populated with the values for an MCPTT imminent peril group call as specified in clause 6.6.3.1.12; and + - b) shall include in the application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "true"; and +- 8) shall send the SIP INVITE request towards the terminating network in accordance with 3GPP TS 24.229 [3]. + +Upon receiving a SIP 183 (Session Progress) response containing a Require header field with the option tag "100rel" and containing a P-Answer-State header field with the value "Unconfirmed" in response to the SIP INVITE request the IWF performing the controlling role: + +- 1) shall send a SIP PRACK request towards the MCPTT client according to 3GPP TS 24.229 [3]. + +Upon receiving a SIP 200 (OK) response for the SIP INVITE request the IWF performing the controlling role: + +- 1) shall interact with the media plane as specified in 3GPP TS 29.380 [31] clause 6.3; +- 2) shall send a SIP NOTIFY request to all MCPTT participants with a subscription to the conference event package as specified in clause 10.3; and +- 3) shall increment the local counter of the number of SIP 200 (OK) responses received from invited members, by 1. + +#### 10.1.4.1.2 INVITE targeted to the non-controlling MCPTT function of an MCPTT group + +The IWF performing the controlling role: + +- 1) shall generate a SIP INVITE request as specified in clause 6.6.3.1.1; +- 2) shall set the Request-URI to the public service identity of the non-controlling MCPTT function serving the group identity of the MCPTT group owned by the partner MCPTT system; +- 3) shall set the P-Asserted-Identity to the public service identity of the IWF performing the controlling role; + +- 4) shall include in the application/vnd.3gpp.mcptt-info+xml MIME body in the outgoing SIP INVITE request: + - a) the element set to the group identity of the MCPTT group hosted by the non-controlling MCPTT function in the partner MCPTT system; and + - b) the element set to the group identity of the group served by the IWF performing the controlling role; +- 5) shall include the Recv-Info header field set to g.3gpp.mcptt-floor-request; +- 6) void +- 7) shall include in the SIP INVITE request an SDP offer; and +- 8) shall send the SIP INVITE request towards the partner MCPTT system in accordance with 3GPP TS 24.229 [3]. + +Upon receiving SIP 403 (Forbidden) response for the SIP INVITE request, if according to local policy and if: + +- 1) the response contains a Warning header field with the MCPTT warning code "128"; and +- 2) the response contains a P-Refused-URI-List header field and an application/resource-lists+xml MIME body as specified in IETF RFC 5318 [20]; + +NOTE 1: The application/resource-lists+xml MIME body contains MCPTT IDs identifying MCPTT users in a partner MCPTT system that need to be invited to the prearranged group call in case of group regrouping using interrogating method as specified in 3GPP TS 23.379 [2] clause 10.6.2.4.2. + +then the IWF performing the controlling role: + +- 1) shall check if the number of members of the MCPTT group exceeds the maximum participants allowed by the IWF performing the controlling role. If exceeded, the IWF performing the controlling role shall invite only enough members from the application/resource-lists+xml MIME body to reach the maximum allowed by the IWF performing the controlling role; and + +NOTE 2: The IWF determines the maximum number of participants allowed in the prearranged group session. It is operator policy that determines which participants in the application/resource-lists+xml MIME body are invited to the group call. + +- 2) shall invite MCPTT users as specified in this clause using the list of MCPTT IDs in URI-List. + +Upon receiving a SIP 200 (OK) response for the SIP INVITE request the IWF performing the controlling role: + +- 1) shall interact with the media plane as specified in 3GPP TS 29.380 [31] clause 6.3; + +NOTE 3: The procedures executed by the IWF performing the controlling role prior to sending a response to the inviting MCPTT client are specified in clause 10.1.4.2. + +- 2) if at least one of the invited MCPTT clients has subscribed to the conference package, shall subscribe to the conference event package in the non-controlling MCPTT function as specified in clause 10.3; and +- 3) if the 200 (OK) response includes the element set to "floor-taken", shall wait for a SIP INFO request containing a floor request from the non-controlling MCPTT function. + +Upon receiving a SIP INFO request containing a floor request where: + +- 1) the Request-URI contains an MCPTT session ID identifying an ongoing temporary group session; and +- 2) the application/vnd.3gpp.mcptt-info+xml MIME body contains the element with the MCPTT group ID of a MCPTT group invited to the temporary group session; + +then the IWF performing the controlling role: + +- 1) shall send a SIP 200 (OK) response to the SIP INFO request to the non-controlling MCPTT function as specified in 3GPP TS 24.229 [3]; and +- 2) shall interact with the media plane as specified in 3GPP TS 29.380 [31] clause 6.3. + +### 10.1.4.2 Terminating Procedures + +In this clause, the IWF is performing the controlling role and is terminating a call from an MCPTT participating function or an MCPTT non-controlling function destined for the IWF. For cases where both the call origination and termination are MCPTT functions, the IWF shall follow 3GPP TS 24.379 [29], clause 10.1.1.4.2, with the IWF acting as the controlling MCPTT function. + +In the procedures in this clause: + +- 1) MCPTT ID in an incoming SIP INVITE request refers to the MCPTT ID of the originating user from the element of the application/vnd.3gpp.mcptt-info+xml MIME body of the incoming SIP INVITE request; +- 2) group identity in an incoming SIP INVITE request refers to the group identity from the element of the application/vnd.3gpp.mcptt-info+xml MIME body of the incoming SIP INVITE request; +- 3) indication of required group members in a SIP 183 (Session Progress) response refers to the element of the application/vnd.3gpp.mcptt-info+xml MIME body set to "true" in a SIP 183 (Session Progress) sent by the non-controlling MCPTT function of an MCPTT group; +- 4) emergency indication in an incoming SIP INVITE request refers to the element of the application/vnd.3gpp.mcptt-info+xml MIME body; and +- 5) imminent peril indication in an incoming SIP INVITE request refers to the element of the application/vnd.3gpp.mcptt-info+xml MIME body. + +Upon receipt of a "SIP INVITE request for controlling MCPTT function of an MCPTT group", the IWF performing the controlling role: + +- 1) if unable to process the request due to a lack of resources or a risk of congestion exists, may reject the SIP INVITE request with a SIP 500 (Server Internal Error) response. The IWF performing the controlling role may include a Retry-After header field to the SIP 500 (Server Internal Error) response as specified in IETF RFC 3261 [14] and skip the rest of the steps; + +NOTE 1: If the SIP INVITE request contains an emergency indication or an imminent peril indication set to a value of "true" and this is an authorised request for originating an MCPTT emergency group call as determined by clause 6.6.3.1.8.2, or for originating an MCPTT imminent peril group call as determined by clause 6.6.3.1.8.5, the IWF performing the non-controlling role can, according to local policy, choose to accept the request. + +- 2) shall determine if the media parameters are acceptable and if not reject the request with a SIP 488 (Not Acceptable Here) response and skip the rest of the steps; +- 3) shall reject the SIP request with a SIP 403 (Forbidden) response and not process the remaining steps if: + - a) an Accept-Contact header field does not include the g.3gpp.mcptt media feature tag; or + - b) an Accept-Contact header field does not include the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcptt"; +- 4) if received SIP INVITE request includes an application/vnd.3gpp.mcptt-info+xml MIME body with an element included or an element included, shall validate the request as described in 3GPP TS 24.379 [29], clause 6.3.3.1.17 with the IWF acting as the controlling MCPTT function; +- 5) shall retrieve the necessary group document(s) and carry out initial processing as specified in 3GPP TS 24.379 [29], clause 6.3.5.2 with the IWF acting as the controlling MCPTT function; +- 6) if the result of the initial processing in 3GPP TS 24.379 [29], clause 6.3.5.2 was: + - a) that authorization of the MCPTT ID at a non-controlling MCPTT function of an MCPTT group is required, perform the actions in clause 6.6.3.1.8.7 and do not continue with the rest of the steps in this clause; and + - b) that a SIP 3xx, 4xx, 5xx or 6xx response to the "SIP INVITE request for controlling MCPTT function of an MCPTT group" has been sent, do not continue with the rest of the steps in this clause; + +- 7) shall perform the actions as described in 3GPP TS 24.379 [29], clause 6.3.3.2.2 with the IWF acting as the controlling MCPTT function; +- 8) shall maintain a local counter of the number of SIP 200 (OK) responses received from invited members and shall initialise this local counter to zero; +- 9) shall determine if an MCPTT group call for the group identity is already ongoing by determining if an MCPTT session identity has already been allocated for the group call and the MCPTT session is active; +- 10) if the SIP INVITE request contains an unauthorised request for an MCPTT emergency group call as determined by clause 6.6.3.1.8.2: + - a) shall reject the SIP INVITE request with a SIP 403 (Forbidden) response as specified in clause 6.6.3.1.9; and + - b) shall send the SIP 403 (Forbidden) response as specified in 3GPP TS 24.229 [3] and skip the rest of the steps; +- 11) if the SIP INVITE request contains an unauthorised request for an MCPTT imminent peril group call as determined by clause 6.6.3.1.8.5, shall reject the SIP INVITE request with a SIP 403 (Forbidden) response with the following clarifications: + - a) shall include in the SIP 403 (Forbidden) response an application/vnd.3gpp.mcptt-info+xml MIME body as specified in 3GPP TS 24.379 [29], clause F.1 with the element containing the element with the element set to a value of "false"; and + - b) shall send the SIP 403 (Forbidden) response as specified in 3GPP TS 24.229 [3] and skip the rest of the steps; +- 12) void +- 13) if the received SIP INVITE request contains an application/vnd.3gpp.mcptt-location-info+xml MIME body with a element included in the root element, the IWF performing the controlling role can remember the location information contained in the root element; +- 14) if the MCPTT group call is not ongoing then: + - a) if: + - i) the user identified by the MCPTT ID is not affiliated to the group identity contained in the SIP INVITE request as specified in 3GPP TS 24.379 [29], clause 6.3.6, with the IWF acting as the controlling MCPTT function; + - ii) the group identity contained in the SIP INVITE request is not a constituent MCPTT group ID; + - iii) the received SIP INVITE request does not contain an emergency indication or imminent peril indication; or + - iv) the received SIP INVITE request is an authorised request for an MCPTT emergency group call as determined by clause 6.6.3.1.8.2 or MCPTT imminent peril group call as determined by steps clause 6.6.3.1.8.5 and is determined to not be eligible for implicit affiliation as specified in clause 9.2.1.3.6; + +then shall return a SIP 403 (Forbidden) response with the warning text set to "120 user is not affiliated to this group" in a Warning header field as specified in 3GPP TS 24.379 [29] clause 4.4, with the IWF acting as the MCPTT server, and skip the rest of the steps below; + - b) if the user identified by the MCPTT ID is not authorised to initiate the prearranged group session, shall send a SIP 403 (Forbidden) response with the warning text set to: "119 user is not authorised to initiate the group call" in a Warning header field as specified in 3GPP TS 24.379 [29] clause 4.4, with the IWF acting as the MCPTT server and skip the rest of the steps below; + +NOTE 2: How the IWF determines whether the MCPTT user is authorized to initiate a prearranged group is out of scope of the present document. + +- c) if the received SIP INVITE request contains an authorised request for an MCPTT emergency group call as determined by clause 6.6.3.1.8.2 or MCPTT imminent peril group call as determined by clause 6.6.3.1.8.5 and the MCPTT user is eligible to be implicitly affiliated with the MCPTT group as determined as determined in step 13) a) iv) above, shall perform the implicit affiliation as specified in clause 9.2.1.3.7; + +- d) void + - e) shall create a prearranged group session and allocate an MCPTT session identity for the prearranged group call, and shall handle timer TNG3 (group call timer) as specified in clause 6.6.3.5; + - f) if the group identity in the "SIP INVITE request for controlling MCPTT function of an MCPTT group" is a TGI: + - i) shall for each of the constituent MCPTT groups homed in the IWF: + - A) invite each member of the IWF homed group to the group session; and + - B) interact with the media plane as specified in 3GPP TS 29.380 [31] clause 6.3; and + - ii) shall for each of the constituent MCPTT groups homed on the partner MCPTT system generate a SIP INVITE request for the MCPTT group identity homed on the partner MCPTT system as specified in clause 10.1.4.1.2; + - g) if the group identity in the "SIP INVITE request for controlling MCPTT function of an MCPTT group" is an MCPTT group ID: + - i) shall determine the members to invite to the prearranged MCPTT group call as specified in clause 6.6.5.3; + - ii) if necessary, shall start timer TNG1 (acknowledged call setup timer) according to the conditions stated in clause 6.6.3.3; + - iii) if the received SIP INVITE request includes an application/vnd.3gpp.mcptt-info+xml MIME body with an element set to a value of "true": + - A) shall cache the information that the MCPTT user has initiated an MCPTT emergency call; + - B) if the received SIP INVITE contains an alert indication set to a value of "true" and this is an authorised request for an MCPTT emergency alert meeting the conditions specified in clause 6.6.3.1.8.1, shall cache the information that the MCPTT user has initiated an MCPTT emergency alert; and + - C) if the in-progress emergency state of the group is set to a value of "false": + - I) shall set the value of the in-progress emergency state of the group to "true"; and + - II) shall start timer TNG2 (in-progress emergency group call timer) and handle its expiry as specified in clause 6.6.3.1.10; + - iv) if the in-progress emergency state of the group is set to a value of "false" and if the received SIP INVITE request contains an imminent peril indication set to a value of "true", the controlling MCPTT function: + - A) shall cache the information that the MCPTT user has initiated an MCPTT imminent peril call; and + - B) if the in-progress imminent peril state of the group is set to a value of "false", shall set the in-progress imminent peril state of the group to a value of "true"; + - v) shall invite each group member determined in step 13)g)i) above, to the group session, as specified in clause 10.1.4.1.1; and + - vi) shall interact with the media plane as specified in 3GPP TS 29.380 [31] clause 6.3; and +- 15) if the MCPTT group call is ongoing then: +- a) if: + - i) the user identified by the MCPTT ID in the SIP INVITE request is not affiliated to the group identity contained in the SIP INVITE request as specified in 3GPP TS 24.379 [29] clause 6.3.6; + - ii) the group identity contained in the SIP INVITE request is not a constituent MCPTT group ID; + - iii) the received SIP INVITE request does not contain an emergency indication or imminent peril indication; +or + +- iv) the received SIP INVITE request is an authorised request for an MCPTT emergency group call as determined by clause 6.6.3.1.8.2 or MCPTT imminent peril group call as determined by clause 6.6.3.1.8.5 and is determined to not be eligible for implicit affiliation as specified in clause 9.2.1.3.6; + +then shall return a SIP 403 (Forbidden) response with the warning text set to "120 user is not affiliated to this group" in a Warning header field as specified in 3GPP TS 24.379 [29] clause 4.4, with the IWF acting as the MCPTT server, and skip the rest of the steps below; + +- b) if the user identified by the MCPTT ID in the SIP INVITE request is not authorised to join the prearranged group session as specified in clause 6.6.5.2, shall send a SIP 403 (Forbidden) response with the warning text set to "121 user is not allowed to join the group call" in a Warning header field as specified in 3GPP TS 24.379 [29], clause 4.4, with the IWF acting as the MCPTT server and skip the rest of the steps below; +- c) void +- d) if the maximum number of participants allowed by the IWF performing the controlling role is already reached: + +- i) if, according to local policy, the user identified by the MCPTT ID in the SIP INVITE request is deemed to have a higher priority than an existing user in the group session, may remove a participant from the session by following clause 10.1.4.4.3, and skip the next step; and + +NOTE 3: The local policy for deciding whether to admit a user to a call that has reached its maximum amount of participants can include the user's priority and the participant type of the user as well as other information about the user. The local policy decisions can also include taking into account whether the imminent-peril indicator or emergency indicator was received in the SIP INVITE request. + +- ii) shall return a SIP 486 (Busy Here) response with the warning text set to "122 too many participants" to the originating network as specified in 3GPP TS 24.379 [29], clause 4.4, with the IWF acting as the MCPTT server and skip the rest of the steps; +- e) if the received SIP INVITE request contains an authorised request for an MCPTT emergency group call as determined by clause 6.6.3.1.8.2 or MCPTT imminent peril group call as determined by clause 6.6.3.1.8.5 and the MCPTT user is eligible to be implicitly affiliated with the MCPTT group as determined in step 14) a) iv) above, shall perform the implicit affiliation as specified in clause 9.2.1.3.7; +- f) if the received SIP INVITE request includes an application/vnd.3gpp.mcptt-info+xml MIME body with an element set to a value of "true": + - i) shall cache the information that the MCPTT user has initiated an MCPTT emergency call; + - ii) if the received SIP INVITE contains an alert indication set to a value of "true" and this is an authorised request for an MCPTT emergency alert meeting the conditions specified in clause 6.6.3.1.8.1, shall cache the information that the MCPTT user has initiated an MCPTT emergency alert; + - iii) if the in-progress emergency state of the group is set to a value of "false": + - A) shall set the value of the in-progress emergency state of the group to "true"; + - B) shall start timer TNG2 (in-progress emergency group call timer) and handle its expiry as specified in clause 6.6.3.1.10; and + - C) shall generate SIP re-INVITE requests for the MCPTT emergency group call to the other call participants of the MCPTT group as specified in clause 6.6.3.1.3; + - iv) if the in-progress imminent peril state of the group is set to a value of "true": + - A) for each of the other affiliated member of the group generate a SIP MESSAGE request notification of the MCPTT user's imminent peril indication as specified in 3GPP TS 24.379 [29], clause 6.3.3.1.11, with the IWF acting as the controlling MCPTT function, setting the element of the application/vnd.3gpp.mcptt-info+xml MIME body to a value of "true"; and + - B) send the SIP MESSAGE request as specified in 3GPP TS 24.229 [3]; and + +- v) upon receiving a SIP 200 (OK) response to the SIP re-INVITE request the IWF performing the controlling role shall interact with the media plane as specified in 3GPP TS 29.380 [31]; +- g) if the in-progress emergency state of the group is set to a value of "false" and if the SIP INVITE request contains an imminent peril indication set to a value of "true", the controlling MCPTT function: + - i) shall cache the information that the MCPTT user has initiated an MCPTT imminent peril call; and + - ii) if the in-progress imminent peril state of the group is set to a value of "false": + - A) shall set the in-progress imminent peril state of the group to a value of "true"; + - B) shall generate SIP re-INVITE requests for the MCPTT imminent peril group call to the other call participants of the MCPTT group as specified in 3GPP TS 24.379 [29], clause 6.3.3.1.15; and + - C) upon receiving a SIP 200 (OK) response to the SIP re-INVITE request the controlling MCPTT function shall interact with the media plane as specified in 3GPP TS 29.380 [31]; and + - iii) if the in-progress imminent peril state of the group is set to a value of "true": + - A) for each of the other affiliated member of the group generate a SIP MESSAGE request notification of the MCPTT user's imminent peril indication as specified in 3GPP TS 24.379 [29] clause 6.3.3.1.11, with the IWF acting as the controlling MCPTT function, setting the element of the application/vnd.3gpp.mcptt-info+xml MIME body to a value of "true"; and + - B) send the SIP MESSAGE request as specified in 3GPP TS 24.229 [3]; +- h) shall generate a SIP 200 (OK) response as specified in 3GPP TS 24.379 [29], clause 6.3.3.2.3.2; +- i) shall include in the SIP 200 (OK) response an SDP answer to the SDP offer in the incoming SIP INVITE request as specified in the 3GPP TS 24.379 [29] clause 6.3.3.2.1, with the IWF acting as the controlling MCPTT function; +- j) shall include in the SIP 200 (OK) response with the warning text set to "123 MCPTT session already exists" as specified in 3GPP TS 24.379 [29] clause 4.4, with the IWF acting as the MCPTT server; +- k) if the received SIP re-INVITE request contains an alert indication set to a value of "true" and this is an unauthorised request for an MCPTT emergency alert as specified in clause 6.6.3.1.8.1, shall include in the SIP 200 (OK) response the warning text set to "149 SIP INFO request pending" in a Warning header field as specified in 3GPP TS 24.379 [29] clause 4.4, with the IWF acting as the MCPTT server; +- l) if the received SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "true" and if the in-progress emergency state of the group is set to a value of "true", shall include in the SIP 200 (OK) response the warning text set to "149 SIP INFO request pending" in a Warning header field as specified in 3GPP TS 24.379 [29] clause 4.4, with the IWF acting as the MCPTT server; + +NOTE 4: In this case, the request was for an imminent peril call but a higher priority MCPTT emergency call was already in progress on the group. Hence, the imminent peril call request aspect of the request is denied but the request is granted with emergency level priority. + +- m) shall interact with media plane as specified in 3GPP TS 29.380 [31] clause 6.3; + +NOTE 5: Resulting media plane processing is completed before the next step is performed. + +- n) shall send the SIP 200 (OK) response towards the inviting MCPTT client or inviting non-controlling MCPTT function according to 3GPP TS 24.229 [3]; +- o) shall generate a notification to the MCPTT clients, which have subscribed to the conference event package that the inviting MCPTT User has joined in the MCPTT group session, as specified in clause 6.6.3.4; + +NOTE 6: As a group document can potentially have a large content, the IWF performing the controlling role can notify using content-indirection as defined in IETF RFC 4483 [17]. + +- p) shall send a SIP NOTIFY request to each MCPTT client according to 3GPP TS 24.229 [3]; + +- q) Upon receiving a SIP ACK to the above SIP 200 (OK) response and the SIP 200 (OK) response contained a Warning header field as specified in 3GPP TS 24.379 [29] clause 4.4, with the IWF acting as the MCPTT server with the warning text containing the mcptt-warn-code set to "149", shall follow the procedures in clause 6.6.3.1.11; and +- r) shall not continue with the rest of the clause. + +Upon receiving a SIP 183 (Session Progress) response to the SIP INVITE request specified in clause 10.1.4.1 containing a P-Answer-State header field with the value "Unconfirmed" as specified in IETF RFC 4964 [19], the timer TNG1 (acknowledged call setup timer) is not running, the controlling MCPTT function supports media buffering and the SIP final response is not yet sent to the inviting MCPTT client: + +- 1) shall generate a SIP 200 (OK) response to SIP INVITE request as specified in the 3GPP TS 24.379 [29] clause 6.3.3.2.3.2, with the IWF acting as the controlling MCPTT function; +- 2) shall include the warning text set to "122 too many participants" as specified in 3GPP TS 24.379 [29] clause 4.4 with the IWF acting as the MCPTT server, in the SIP 200 (OK) response, if the prearranged MCPTT group has more than the maximum number of members as allowed by the IWF; +- 3) shall include in the SIP 200 (OK) response an SDP answer to the SDP offer in the incoming SIP INVITE request as specified in the 3GPP TS 24.379 [29] clause 6.3.3.2.1, with the IWF acting as the controlling MCPTT function; +- 4) shall include a P-Answer-State header field with the value "Unconfirmed"; +- 5) if the SIP INVITE request contains an alert indication set to a value of "true" and this is an unauthorised request for an MCPTT emergency alert as specified in clause 6.6.3.1.8.1, shall include in the SIP 200 (OK) response the warning text set to "149 SIP INFO request pending" in a Warning header field as specified in 3GPP TS 24.379 [29] clause 4.4, with the IWF acting as the MCPTT server; +- 6) if the received SIP INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "true" and if the in-progress emergency state of the group is set to a value of "true", shall include in the SIP 200 (OK) response the warning text set to "149 SIP INFO request pending" in a Warning header field as specified in 3GPP TS 24.379 [29] clause 4.4, with the IWF acting as the MCPTT server; +- 7) shall interact with the media plane as specified in 3GPP TS 29.380 [31] clause 6.3; + +NOTE 7: Resulting user plane processing is completed before the next step is performed. + +- 8) shall send the SIP 200 (OK) response towards the inviting MCPTT client according to 3GPP TS 24.229 [3]; +- 9) shall generate a notification to the MCPTT clients, which have subscribed to the conference event package that the inviting MCPTT User has joined in the MCPTT group session, as specified in clause 6.6.3.4; and + +NOTE 8: As a group document can potentially have a large content, the controlling MCPTT function can notify using content-indirection as defined in IETF RFC 4483 [17]. + +- 10) shall send a SIP NOTIFY request to each MCPTT client according to 3GPP TS 24.229 [3]. + +Upon receiving a SIP 183 (Session Progress) response for a SIP INVITE request as specified in clause 10.1.4.1.2 containing an indication of required group members, the timer TNG1 (acknowledged call setup timer) is running and all SIP 200 (OK) responses have been received to all SIP INVITE requests sent to MCPTT clients specified in clause 10.1.4.1.1, then the IWF performing the controlling role shall wait until the SIP 200 (OK) response has been received to the SIP INVITE request specified in clause 10.1.4.1.2 before generating a SIP 200 (OK) response to the "SIP INVITE request for controlling MCPTT function of an MCPTT group". + +Upon receiving a SIP 200 (OK) response for a SIP INVITE request as specified in clause 10.1.4.1 that was sent to an affiliated and required group member; and + +- 1) if the MCPTT ID in the SIP 200 (OK) response matches to the MCPTT ID in the corresponding SIP INVITE request; +- 2) there are no outstanding SIP 200 (OK) responses to SIP INVITE requests which were sent to affiliated and required group members; and + +- 3) there is no outstanding SIP 200 (OK) response to a SIP INVITE request sent in clause 10.1.4.1.2 where the SIP 183 (Session Progress) response contained an indication of required group members; + +the IWF performing the controlling role: + +- 1) shall stop timer TNG1 (acknowledged call setup timer) as described in clause 6.6.3.3; +- 2) shall generate SIP 200 (OK) response to the SIP INVITE request as specified in the 3GPP TS 24.379 [29] clause 6.3.3.2.3.2, with the IWF acting as the controlling MCPTT function, before continuing with the rest of the steps; +- 3) shall include the warning text set to "122 too many participants" as specified in 3GPP TS 24.379 [29] clause 4.4, with the IWF acting as the MCPTT server in the SIP 200 (OK) response, if all members were not invited because the prearranged MCPTT group has been exceeded the maximum number of members as allowed by the IWF; +- 4) shall include in the SIP 200 (OK) response an SDP answer to the SDP offer in the incoming SIP INVITE request as specified in the 3GPP TS 24.379 [29] clause 6.3.3.2.1, with the IWF acting as the controlling MCPTT function; +- 5) shall interact with the media plane as specified in 3GPP TS 29.380 [31] clause 6.3; + +NOTE 9: Resulting media plane processing is completed before the next step is performed. + +- 6) shall send a SIP 200 (OK) response to the inviting MCPTT client according to 3GPP TS 24.229 [3]; +- 7) shall generate a notification to the MCPTT clients, which have subscribed to the conference event package that the inviting MCPTT user has joined in the MCPTT group session, as specified in clause 6.6.3.4; and + +NOTE 10: As a group document can potentially have a large content, the IWF performing the controlling role can notify using content-indirection as defined in IETF RFC 4483 [17]. + +- 8) shall send the SIP NOTIFY request to the MCPTT clients according to 3GPP TS 24.229 [3]. + +Upon: + +- 1) receiving a SIP 200 (OK) response for a SIP INVITE request as specified in clause 10.1.4.1; +- 2) the timer TNG1 (acknowledged call setup timer) is not running; +- 3) the local counter of the number of SIP 200 (OK) responses received from invited members is equal to the value of the minimum number of participants that the IWF requires to start a call; +- 4) the IWF performing the controlling role supports media buffering; and +- 5) the SIP final response has not yet been sent to the inviting MCPTT client; + +the IWF performing the controlling role according to local policy: + +- 1) shall generate SIP 200 (OK) response to the SIP INVITE request as specified in the 3GPP TS 24.379 [29] clause 6.3.3.2.2, with the IWF acting as the controlling MCPTT function; +- 2) shall include the warning text set to "122 too many participants" as specified in 3GPP TS 24.379 [29] clause 4.4, with the IWF acting as the MCPTT server in the SIP 200 (OK) response, if all members were not invited because the prearranged MCPTT group has exceeded the number of members as allowed by the IWF performing the controlling role; +- 3) shall include in the SIP 200 (OK) response an SDP answer to the SDP offer in the incoming SIP INVITE request as specified in the 3GPP TS 24.379 [29] clause 6.3.3.2.1, with the IWF acting as the controlling MCPTT function; +- 4) if the SIP INVITE request contains an alert indication set to a value of "true" and this is an unauthorised request for an MCPTT emergency alert as specified in clause 6.6.3.1.8.1, shall include in the SIP 200 (OK) response the warning text set to "149 SIP INFO request pending" in a Warning header field as specified in 3GPP TS 24.379 [29] clause 4.4, with the IWF acting as the MCPTT server; +- 5) if the received SIP INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "true" and if the in-progress emergency state of the group is set to + +a value of "true", shall include in the SIP 200 (OK) response the warning text set to "149 SIP INFO request pending" in a Warning header field as specified in 3GPP TS 24.379 [29] clause 4.4, with the IWF acting as the MCPTT server; + +- 6) shall interact with the media plane as specified in 3GPP TS 29.380 [31] clause 6.3; + +NOTE 11:Resulting media plane processing is completed before the next step is performed. + +- 7) shall send a SIP 200 (OK) response to the inviting MCPTT client according to 3GPP TS 24.229 [3]; +- 8) shall generate a notification to the MCPTT clients, which have subscribed to the conference event package that the inviting MCPTT user has joined in the MCPTT group session, as specified in clause 6.6.3.4; and + +NOTE 12:As a group document can potentially have a large content, the IWF performing the controlling role can notify using content-indirection as defined in IETF RFC 4483 [17]. + +- 9) shall send the SIP NOTIFY request to the MCPTT clients according to 3GPP TS 24.229 [3]. + +Upon expiry of timer TNG1 (acknowledged call setup timer), if there are outstanding SIP 200 (OK) responses to SIP INVITE requests sent to affiliated and required group members, the IWF performing the controlling role shall follow the procedures specified in clause 6.6.3.3. + +If timer TNG1 (acknowledged call setup timer) is running and a final SIP 4xx, 5xx or 6xx response is received from an affiliated and required group member, the IWF performing the controlling role shall follow the relevant procedures specified in clause 6.6.3.3. + +If: + +- 1) timer TNG1 (acknowledged call setup timer) is not running; +- 2) the local counter of the number of SIP 200 (OK) responses received from invited members is equal to the value of the minimum number of group members required by the IWF to start a call; and +- 3) a final SIP 4xx, 5xx or 6xx response is received from an invited MCPTT client; + +then the IWF performing the controlling role shall perform one of the following based on policy: + +- 1) send the SIP final response towards the inviting MCPTT client, according to 3GPP TS 24.229 [3], if a SIP final response was received from all the other invited MCPTT clients and the SIP 200 (OK) response is not yet sent; or +- 2) remove the invited MCPTT client from the MCPTT Session as specified in clause 6.6.3.1.2, if a SIP final response other than 2xx or 3xx was received from all the invited MCPTT clients and the SIP 200 (OK) response is already sent. The IWF performing the controlling role may invite an additional member of the prearranged MCPTT group as specified in clause 10.1.4.1 that has not already been invited, if the prearranged MCPTT group has less than the maximum number of members as allowed by the IWF, and all members have not yet been invited. + +If the group identity in the "SIP INVITE request for controlling MCPTT function of an MCPTT group" is a TGI and constituent MCPTT groups were invited as specified in clause 10.1.4.1.2 and, + +- 1) if all non-controlling MCPTT functions hosting the constituent MCPTT groups have responded with a SIP 2xx, SIP 3xx, SIP 4xx, SIP 5xx or SIP 6xx responses to the "SIP INVITE request for non-controlling MCPTT function of an MCPTT group"; and +- 2) if all expected SIP INFO requests containing a floor request are received; + +then the IWF performing the controlling role shall indicate to the media plane that all final responses are received. + +NOTE 13:If the SIP 200 (OK) response to the SIP INVITE request for non-controlling MCPTT function of an MCPTT group included the application/vnd.3gpp.mcptt-info+xml MIME body with the element set to "floor-taken", the controlling MCPTT function expects that the non-controlling MCPTT functions sends a SIP INFO request containing a floor request. + +Upon receiving a SIP ACK to the SIP 200 (OK) response sent towards the inviting MCPTT client, and the SIP 200 (OK) response was sent with the warning text set to "149 SIP INFO request pending" in a Warning header field as + +specified in 3GPP TS 24.379 [29] clause 4.4, with the IWF acting as the MCPTT server, the controlling MCPTT function shall follow the procedures in clause 6.6.3.1.11. + +#### 10.1.4.3 End group call at the IWF performing the terminating controlling role + +Upon receiving a SIP BYE request the IWF performing the controlling role shall follow the procedures as specified in clause 6.6.3.2.1. + +#### 10.1.4.4 End group call initiated by the IWF performing the controlling role + +##### 10.1.4.4.1 General + +This clause describes the procedures of each functional entity for ending the group call initiated by the IWF performing the controlling role. + +##### 10.1.4.4.2 SIP BYE request for releasing MCPTT session for a group call + +When the MCPTT session for group call needs to be released as specified in clause 6.6.7.1, the IWF performing the controlling role, shall follow the procedures in clause 6.6.3.1.2. + +##### 10.1.4.4.3 SIP BYE request towards a MCPTT client + +When an MCPTT client needs to be removed from the MCPTT session (e.g. due to de-affiliation or admitting a higher priority user), the IWF performing the controlling role shall follow the procedures in clause 6.6.3.1.2. + +After successful removing the MCPTT client from the MCPTT session, the IWF performing the controlling role may generate a notification to the MCPTT clients, which have subscribed to the conference event package that an MCPTT user has been removed from the MCPTT session, as specified in clause 6.6.3.4 and send the SIP NOTIFY request to the MCPTT client according to 3GPP TS 24.229 [3]. + +#### 10.1.4.5 Re-join procedures + +##### 10.1.4.5.1 Terminating procedures + +Upon receipt of a SIP INVITE request that includes an MCPTT session identity of an ongoing MCPTT session in the Request-URI the IWF performing the controlling role: + +- 1) if unable to process the request due to a lack of resources or a risk of congestion exists, may reject the SIP INVITE request with a SIP 500 (Server Internal Error) response. The IWF performing the controlling role may include a Retry-After header field to the SIP 500 (Server Internal Error) response as specified in IETF RFC 3261 [14]. Otherwise, continue with the rest of the steps; + +NOTE 1: if the SIP INVITE request contains an emergency indication or an imminent peril indication set to a value of "true" and this is an authorised request for originating an MCPTT emergency group call as determined by clause 6.6.3.1.8.2, or for originating an MCPTT imminent peril group call as determined by clause 6.6.3.1.8.5, with the IWF performing the controlling role can according to local policy choose to accept the request. + +- 2) shall reject the SIP request with a SIP 404 (Not Found) response if the MCPTT group call represented by the MCPTT session identity in Request-URI header is not present; +- 3) shall validate that the received SDP offer includes at least one media stream for which the media parameters and at least one codec or media format is acceptable by the IWF performing the controlling role and if not, reject the request with a SIP 488 (Not Acceptable Here) response and skip the rest of the steps Otherwise, continue with the rest of the steps; +- 4) shall reject the SIP request with a SIP 403 (Forbidden) response and not process the remaining steps if: + - a) an Accept-Contact header field does not include the g.3gpp.mcptt media feature tag; or + +- b) an Accept-Contact header field does not include the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcptt"; +- 5) shall determine the MCPTT ID of the calling user; + - 6) if the user identified by the MCPTT ID is not authorised to join the prearranged group session as specified in clause 6.6.5.2, shall send a SIP 403 (Forbidden) response with the warning text set to "121 user is not authorised to join the group call" in a Warning header field as specified in 3GPP TS 24.379 [29], clause 4.4, with the IWF acting as the controlling MCPTT function. Otherwise continue with the rest of the steps below; + - 7) shall perform the actions on receipt of an initial SIP INVITE request as described in 3GPP TS 24.379 [29], clause 6.3.3.2.2, with the IWF acting as the controlling MCPTT function; + - 8) if the user identified by the MCPTT ID is not affiliated to the MCPTT group ID associated with the MCPTT session identity as specified in clause 6.5.3.5, shall return a SIP 403 (Forbidden) response with the warning text set to "120 user is not affiliated to this group" in a Warning header field as specified in clause 4.4; + +Editor's Note: Clause 6.5.3.5 does not exist in the present document, the correct reference is FFS. + +- 9) shall check if a Resource-Priority header field is included in the incoming SIP INVITE request and may apply any preferential treatment to the SIP request as specified in 3GPP TS 24.229 [3]; + - 10) if as specified in 3GPP TS 24.481 [16] is already reached: + - a) if, according to local policy, the user identified by the MCPTT ID in the SIP INVITE request is deemed to have a higher priority than an existing user in the group session, may remove a participant from the session by following clause 10.1.4.4.3, and skip the next step; and +- NOTE 2: The local policy for deciding whether to admit a user to a call that has reached its maximum amount of participants can include the and the of the user as well as other information of the user from the group document as specified in 3GPP TS 24.481 [16]. The local policy decisions can also include taking into account whether the imminent-peril indicator or emergency indicator was received in the SIP INVITE request. +- b) shall return a SIP 486 (Busy Here) response with the warning text set to "122 too many participants" to the originating network as specified in 3GPP TS 24.379 [29], clause 4.4 with the IWF acting as the controlling MCPTT function. Otherwise, continue with the rest of the steps; +- 11) shall generate a SIP 200 (OK) response as specified in 3GPP TS 24.379 [29], clause 6.3.3.2.3.2, with the IWF acting as the controlling MCPTT function; + - 12) shall include in the SIP 200 (OK) response an SDP answer to the SDP offer in the incoming SIP INVITE request as specified in 3GPP TS 24.379 [29], clause 6.3.3.2.1, with the IWF acting as the controlling MCPTT function; + - 13) shall interact with media plane as specified in 3GPP TS 29.380 [31] clause 6.3; +- NOTE 3: Resulting media plane processing is completed before the next step is performed. +- 14) shall send the SIP 200 (OK) response towards the inviting MCPTT client according to 3GPP TS 24.229 [3]; + - 15) shall generate a notification to the MCPTT clients, which have subscribed to the conference event package that the inviting MCPTT User has joined in the MCPTT group session, as specified in clause 6.6.3.4; and +- NOTE 4: As a group document can potentially have a large content, the IWF performing the controlling role can notify using content-indirection as defined in IETF RFC 4483 [17]. +- 16) shall send a SIP NOTIFY request to each MCPTT client according to 3GPP TS 24.229 [3]. + +#### 10.1.4.6 Late call entry initiated by IWF performing the controlling role + +When the IWF performing the controlling role is notified that an MCPTT client is newly affiliated or comes back from out of coverage, the IWF performing the controlling role shall invite the MCPTT client to join an ongoing MCPTT group call by following the procedures specified in clause 10.1.4.1. + +NOTE: How the IWF is informed when an MCPTT client is coming back from out of coverage is out of scope of present document. + +#### 10.1.4.7 Receipt of a SIP re-INVITE request + +In the procedures in this clause: + +- 1) emergency indication in an incoming SIP INVITE request refers to the element of the application/vnd.3gpp.mcptt-info+xml MIME body; and +- 2) imminent peril indication in an incoming SIP INVITE request refers to the element of the application/vnd.3gpp.mcptt-info+xml MIME body. + +Upon receipt of a SIP re-INVITE request for an MCPTT session identity identifying an on-demand prearranged MCPTT group session, the IWF performing the controlling role: + +- 1) if unable to process the request due to a lack of resources or a risk of congestion exists, may reject the SIP re-INVITE request with a SIP 500 (Server Internal Error) response. The IWF performing the controlling role may include a Retry-After header field to the SIP 500 (Server Internal Error) response as specified in IETF RFC 3261 [14] and skip the rest of the steps; + +NOTE 1: If the SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "true", the IWF performing the controlling role can choose to accept the request. + +- 2) if received SIP re-INVITE request includes an application/vnd.3gpp.mcptt-info+xml MIME body with an element included or an element included, shall validate the request as described in 3GPP TS 24.379 [29], clause 6.3.3.1.17, with the IWF acting as the controlling MCPTT function; +- 3) if the received SIP re-INVITE request contains an unauthorised request for an MCPTT emergency call as determined by clause 6.6.3.1.8.2: + - a) shall reject the SIP re-INVITE request with a SIP 403 (Forbidden) response as specified in clause 6.6.3.1.9; and + - b) shall send the SIP 403 (Forbidden) response as specified in 3GPP TS 24.229 [3] and skip the rest of the steps; +- 4) if the received SIP re-INVITE request contains an imminent peril indication set to "true" for an MCPTT imminent peril group call and this is an unauthorised request for an MCPTT imminent peril group call as determined by clause 6.6.3.1.8.6, shall reject the SIP re-INVITE request with a SIP 403 (Forbidden) response with the following clarifications: + - a) shall include in the SIP 403 (Forbidden) response an application/vnd.3gpp.mcptt-info+xml MIME body as specified in 3GPP TS 24.379 [29], clause F.1 with the element containing the element with the element set to a value of "false"; and + - b) shall send the SIP 403 (Forbidden) response as specified in 3GPP TS 24.229 [3] and skip the rest of the steps; +- 5) if a Resource-Priority header field is included in the received SIP re-INVITE request: + - a) if the Resource-Priority header field is set to the value indicated for emergency calls and the SIP re-INVITE request does not contain an emergency indication and the in-progress emergency state of the group is set to a value of "false", shall reject the SIP re-INVITE request with a SIP 403 (Forbidden) response and skip the rest of the steps; and + - b) if the Resource-Priority header field is set to the value indicated for imminent peril calls and the SIP re-INVITE request does not contain an imminent peril indication and the in-progress imminent peril state of the group is set to a value of "false", shall reject the SIP INVITE request with a SIP 403 (Forbidden) response and skip the rest of the steps; +- 6) if the received SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "true" and is an authorised request to initiate an MCPTT emergency group call as determined by clause 6.6.3.1.8.2, the IWF performing the controlling role: + - i) shall cache the MCPTT ID of the MCPTT user that has initiated an MCPTT emergency call; + +- ii) if the received SIP INVITE contains an alert indication set to a value of "true" and this is an authorised request for an MCPTT emergency alert meeting the conditions specified in clause 6.6.3.1.8.1, shall cache the MCPTT ID of the MCPTT user that has initiated an MCPTT emergency alert; +- iii) if the in-progress emergency state of the group is set to a value of "true": + - A) for each of the other affiliated MCPTT members of the group generate a SIP MESSAGE request notification of the MCPTT user's emergency indication as specified in 3GPP TS 24.379 [29], clause 6.3.3.1.11, with the IWF acting as the controlling MCPTT function, setting the element of the application/vnd.3gpp.mcptt-info+xml MIME body to a value of "true"; + - B) send the SIP MESSAGE request as specified in 3GPP TS 24.229 [3]; and + - C) if the in-progress imminent peril state of the group is set to a value of "true", shall set it to a value of "false"; and +- iv) if the in-progress emergency state of the group is set to a value of "false": + - A) shall set the value of the in-progress emergency state of the group to "true"; + - B) shall start timer TNG2 (in-progress emergency group call timer) and handle its expiry as specified in clause 6.6.3.1.10; + +NOTE 2: The interactions of TNG2 with the TNG3 (group call timer) are explained in clause 6.6.3.5.2. + +- C) shall generate SIP re-INVITE requests for the MCPTT emergency group call to the other MCPTT participants of the MCPTT group call as specified in clause 6.6.3.1.3; + - D) shall send the SIP re-INVITEs towards the other MCPTT participants of the MCPTT group call; and + - E) upon receiving a SIP 200 (OK) response to the SIP re-INVITE request the IWF performing the controlling role shall interact with the media plane as specified in 3GPP TS 29.380 [31]; +- 7) if the received SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "false" and is an unauthorised request for an MCPTT emergency group call cancellation as determined by clause 6.6.3.1.8.4: + - a) shall reject the SIP re-INVITE request with a SIP 403 (Forbidden) response; + - b) shall include in the SIP 403 (Forbidden) response an application/vnd.3gpp.mcptt-info+xml MIME body as specified in 3GPP TS 24.379 [29], clause F.1 with an element set to a value of "true"; + - c) if an <>alert-ind> element of the application/vnd.3gpp.mcptt-info+xml MIME body is included in the SIP re-INVITE request set to "false", and there is an outstanding MCPTT emergency alert for the MCPTT user, shall include in the application/vnd.3gpp.mcptt-info+xml MIME body an <>alert-ind> element set to a value of "true"; and + - d) shall send the SIP 403 (Forbidden) response as specified in 3GPP TS 24.229 [3] and skip the rest of the steps; + - 8) if the received SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "false" and is determined to be an authorised request for an MCPTT emergency call cancellation as specified in clause 6.6.3.1.10 and the in-progress emergency state of the group to is set to a value of "true" the IWF performing the controlling role: + - a) shall set the in-progress emergency group state of the group to a value of "false"; + - b) shall clear the cache of the MCPTT ID of the MCPTT user as having an outstanding MCPTT emergency group call; + - c) if an <>alert-ind> element of the application/vnd.3gpp.mcptt-info+xml MIME body is included and set to "false" and is determined to be an authorised request for an MCPTT emergency alert cancellation as specified in clause 6.6.3.1.8.3 and there is an outstanding MCPTT emergency alert for the MCPTT user shall: + - i) if the received SIP re-INVITE request contains an element in the application/vnd.3gpp.mcptt-info+xml MIME body, clear the cache of the MCPTT ID of the MCPTT user identified by the element as having an outstanding MCPTT emergency alert; or + +- ii) if the received SIP re-INVITE request does not contain an element in the application/vnd.3gpp.mcptt-info+xml MIME body, clear the cache of the MCPTT ID of the sender of the SIP re-INVITE request as having an outstanding MCPTT emergency alert; +- d) shall generate SIP re-INVITE requests to the MCPTT participants in the group call as specified in clause 6.6.3.1.3. The MCPTT controlling function: + - i) for each of the other MCPTT participants in the group call shall send the SIP re-INVITE request towards the MCPTT client as specified in 3GPP TS 24.229 [3]; and + - ii) Upon receiving a SIP 200 (OK) response to the SIP re-INVITE request the IWF performing the controlling role shall interact with the media plane as specified in 3GPP TS 29.380 [31]; + +NOTE 3: Clause 6.6.3.1.3 will inform the group call (MCPTT) participants of the cancellation of the MCPTT group's in-progress emergency state and the cancellation of the MCPTT emergency alert if applicable. + +- e) shall stop timer TNG2 (in-progress emergency group call timer); and + +NOTE 4: The interactions of TNG2 with the TNG3 (group call timer) are explained in clause 6.6.3.5.2; + +- f) for each of the affiliated MCPTT members of the group that are not participating in the call: + - i) generate a SIP MESSAGE request notification of the cancellation of the MCPTT user's emergency call as specified in 3GPP TS 24.379 [29], clause 6.3.3.1.11, with the IWF acting as the controlling MCPTT function; + - ii) set the element of the application/vnd.3gpp.mcptt-info+xml MIME body to a value of "false"; + - iii) if indicated above in step 8) c), set the <>alert-ind> element of the application/vnd.3gpp.mcptt-info+xml MIME body to a value of "false"; and + - iv) send the SIP MESSAGE request according to 3GPP TS 24.229 [3]; +- 9) if the received SIP re-INVITE request contains an imminent peril indication and the in-progress emergency group state of the group is set to a value of "false", shall perform the procedures specified in clause 10.1.4.8 and skip the rest of the steps. + +Upon receiving a SIP 200 (OK) response to a SIP re-INVITE request the IWF performing the controlling role shall interact with the media plane as specified in 3GPP TS 29.380 [31]; + +- 1) shall generate a SIP 200 (OK) response according to rules and procedures of 3GPP TS 24.229 [3]; +- 2) shall include in the SIP 200 (OK) response an SDP answer according to 3GPP TS 24.229 [3] with the clarifications specified in 3GPP TS 24.379 [29], clause 6.3.3.2.1, with the IWF acting as the controlling MCPTT function; +- 3) shall include the "norefersub" option tag in a Supported header field according to IETF RFC 4488 [12]; +- 4) shall include the "tdialog" option tag in a Supported header field according to IETF RFC 4538 [13]; +- 5) if the received SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the <>alert-ind> element set to a value of "true" and if this is an unauthorised request for an MCPTT emergency alert as determined by clause 6.6.3.1.8.1, shall include in the SIP 200 (OK) response the warning text set to "149 SIP INFO request pending" in a Warning header field as specified in 3GPP TS 24.379 [29], clause 4.4, with the IWF acting as the controlling MCPTT function; +- 6) if the received SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the <>alert-ind> element set to a value of "false" and if this is an unauthorised request for an MCPTT emergency alert cancellation as determined by clause 6.6.3.1.8.3, shall include in the SIP 200 (OK) response the warning text set to "149 SIP INFO request pending" in a Warning header field as specified in 3GPP TS 24.379 [29], clause 4.4, with the IWF acting as the controlling MCPTT function; +- 7) if the received SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "true", this is an authorised request for an MCPTT imminent peril group call and the in-progress emergency state of the group is set to a value of "true", shall include in the SIP + +200 (OK) response the warning text set to "149 SIP INFO request pending" in a Warning header field as specified in 3GPP TS 24.379 [29], clause 4.4, with the IWF acting as the controlling MCPTT function; + +NOTE 5: In this case, the request was for an imminent peril call but a higher priority MCPTT emergency call was already in progress on the group. Hence, the imminent peril call request aspect of the request is denied but the request is granted with emergency level priority. + +- 8) shall interact with media plane as specified in 3GPP TS 29.380 [31]; and +- 9) shall send the SIP 200 (OK) response towards the MCPTT client according to 3GPP TS 24.229 [3]. + +Upon receiving a SIP ACK to the SIP 200 (OK) response sent towards the inviting MCPTT client, and the SIP 200 (OK) response was sent with the warning text set to "149 SIP INFO request pending" in a Warning header field as specified in 3GPP TS 24.379 [29], clause 4.4, with the IWF acting as the controlling MCPTT function, the IWF performing the controlling role shall follow the procedures in clause 6.6.3.1.11. + +Upon receipt of a SIP 2xx response for an outgoing SIP MESSAGE request, shall handle according to 3GPP TS 24.229 [3]. + +#### 10.1.4.8 Handling of a SIP re-INVITE request for imminent peril session + +This procedure is initiated by the IWF performing the controlling role as the result of an action in clause 10.1.4.7. + +In the procedures in this clause: + +- 1) imminent peril indication in an incoming SIP re-INVITE request refers to the element of the application/vnd.3gpp.mcptt-info+xml MIME body. + +When the IWF performing the controlling role receives a SIP re-INVITE request with an imminent peril indication set to "true", the IWF performing the controlling role: + +- 1) if the in-progress emergency state of the group is set to a value of "false" and if the SIP re-INVITE request contains an imminent peril indication set to a value of "true" or the in-progress imminent peril state of the group to "true", the IWF performing the controlling role shall: + +NOTE 1: The calling procedure has already determined that this is not an unauthorised request for an MCPTT imminent peril call, therefore that check does not need to be repeated in the current procedure. + +- a) if the in-progress imminent peril state of the group is set to a value of "true" and the MCPTT user is indicating a new imminent peril indication: + - i) for each of the other affiliated MCPTT member of the group generate a SIP MESSAGE request notification of the MCPTT user's imminent peril indication as specified in 3GPP TS 24.379 [29], clause 6.3.3.1.11, with the IWF acting as the controlling MCPTT function, with the following clarifications; + - A) set the element of the application/vnd.3gpp.mcptt-info+xml MIME body to a value of "true"; and + - B) send the SIP MESSAGE request as specified in 3GPP TS 24.229 [3]; +- b) if the in-progress imminent peril state of the group is set to a value of "false"; + - i) set the value of the in-progress imminent peril state of the group to "true"; + - ii) generate SIP re-INVITE requests for the MCPTT imminent peril group call to MCPTT participants in the MCPTT group call as specified in 3GPP TS 24.379 [29], clause 6.3.3.1.15, with the IWF acting as the controlling MCPTT function; + - iii) send the SIP re-INVITES to all of the other MCPTT participants in the MCPTT group call; + - iv) for each of the affiliated MCPTT members of the group not participating in the group call, generate a SIP MESSAGE request notification of the MCPTT user's imminent peril indication as specified in 3GPP TS 24.379 [29], clause 6.3.3.1.11, with the IWF acting as the controlling MCPTT function, with the following clarifications; + +- A) set the element of the application/vnd.3gpp.mcptt-info+xml MIME body to a value of "true"; and + - B) send the SIP MESSAGE request as specified in 3GPP TS 24.229 [3]; and + - c) cache the information that the MCPTT user has initiated an MCPTT imminent peril call; + - 2) if the SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "false" and is an unauthorised request for an MCPTT imminent peril group call cancellation as determined by clause 6.6.3.1.8.6 shall: + - a) reject the SIP re-INVITE request with a SIP 403 (Forbidden) response to the SIP re-INVITE request; and + - b) include in the SIP 403 (Forbidden) response an application/vnd.3gpp.mcptt-info+xml MIME body as specified in 3GPP TS 24.379 [29], clause F.1 with the element containing the element with the element set to a value of "false"; + - c) send the SIP 403 (Forbidden) response as specified in 3GPP TS 24.229 [3]; and + - d) skip the rest of the steps; + - 3) if the SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "false" and is determined to be an authorised request for an MCPTT imminent peril call cancellation as specified in clause 6.6.3.1.8.6 and the in-progress imminent peril state of the group to is set to a value of "true" the IWF performing the controlling role shall: + - a) set the in-progress imminent peril state of the group to a value of "false"; + - b) cache the information that the MCPTT user no longer has an outstanding MCPTT imminent peril group call; + - c) generate SIP re-INVITES requests to the other MCPTT participants in the MCPTT group call as specified in 3GPP TS 24.379 [29], clause 6.3.3.1.15, with the IWF acting as the controlling MCPTT function. The MCPTT controlling function: + - i) for each MCPTT participant shall send the SIP re-INVITE request towards the MCPTT client as specified in 3GPP TS 24.229 [3]; and + - ii) Upon receiving a SIP 200 (OK) response to the SIP re-INVITE request the IWF performing the controlling role interact with the media plane as specified in 3GPP TS 29.380 [31]; and +- NOTE 2: 3GPP TS 24.379 [29], clause 6.3.3.1.15, with the IWF acting as the controlling MCPTT function, will inform the affiliated and joined MCPTT members of the cancellation of the MCPTT group's in-progress emergency state and the cancellation of the MCPTT emergency alert if applicable. +- d) for each of the affiliated MCPTT members of the group not participating in the call shall: + - i) generate a SIP MESSAGE request notification of the cancellation of the MCPTT user's imminent peril call as specified in 3GPP TS 24.379 [29], clause 6.3.3.1.11, with the IWF acting as the controlling MCPTT function; + - ii) set the element of the application/vnd.3gpp.mcptt-info+xml MIME body to a value of "false"; and + - iii) send the SIP MESSAGE request according to 3GPP TS 24.229 [3]; + - 4) shall include in the SIP 200 (OK) response an SDP answer according to 3GPP TS 24.229 [3] with the clarifications specified in 3GPP TS 24.379 [29], clause 6.3.3.2.1, with the IWF acting as the controlling MCPTT function; + - 5) shall include the "norefersub" option tag in a Supported header field according to IETF RFC 4488 [12]; + - 6) shall include the "tdialog" option tag in a Supported header field according to IETF RFC 4538 [13]; + - 7) shall interact with media plane as specified in 3GPP TS 29.380 [31]; and + - 8) shall send the SIP 200 (OK) response towards the MCPTT client according to 3GPP TS 24.229 [3]. + +Upon receipt of a SIP 2xx response for an outgoing SIP MESSAGE request, shall handle according to 3GPP TS 24.229 [3]. + +## 10.1.5 Non-controlling role procedures + +Editor's note: Content to be added. + +## 10.2 Chat group (restricted) call + +### 10.2.1 Client derived procedures + +#### 10.2.1.1 On-demand chat group call + +##### 10.2.1.1.1 Procedure for initiating an MCPTT chat group session and procedure for joining an MCPTT chat group session + +This clause is referenced from other procedures. + +To initiate or join an MCPTT group session using an MCPTT group identity, identifying an MCPTT chat group, the IWF performing the participating role shall generate an initial SIP INVITE request by following the UE originating session procedures specified in 3GPP TS 24.229 [3], with the clarifications given below. + +The IWF performing the participating role: + +- 1) if the IWF is originating an MCPTT emergency group call shall comply with the procedures in clause 6.4.1.1; +- 2) if the IWF is originating an MCPTT imminent peril group call, shall comply with the procedures in clause 6.4.1.6; +- 3) shall include the g.3gpp.mcptt media feature tag and the g.3gpp.icsi-ref media feature tag with the value of "urn:urn-7:3gpp-service.ims.icsi.mcptt" in the Contact header field of the SIP INVITE request according to IETF RFC 3840 [9]; +- 4) shall include an Accept-Contact header field containing the g.3gpp.mcptt media feature tag along with the "require" and "explicit" header field parameters according to IETF RFC 3841 [5]; +- 5) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcptt" (coded as specified in 3GPP TS 24.229 [3]), in a P-Preferred-Service header field according to IETF RFC 6050 [7] in the SIP INVITE request; +- 6) shall include an Accept-Contact header field with the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcptt" along with the "require" and "explicit" header field parameters according to IETF RFC 3841 [5]; +- 7) if the emergency group state for this group is set to "MEG 2: in-progress" or "MEG 4: confirm-pending", shall comply with the procedures in clause 6.4.1.2; +- 8) if the imminent peril group state for this group is set to "MIG 2: in-progress" or "MIG 4: confirm-pending", shall include the Resource-Priority header field and comply with the procedures in clause 6.4.1.8; +- 9) shall contain an application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with: + - a) the element set to a value of "chat"; + - b) the element set to the group identity; and + - c) the element set to a value determined by the IWF; + +NOTE 1: How the IWF determines the value of the element is out of scope of the present document. + +NOTE 2: The will be inserted into the body of the SIP INVITE request by the referring clause. + +- 10) shall include an SDP offer according to 3GPP TS 24.229 [3] with the clarifications specified in clause 6.1.1; +- 11) if an implicit floor request is required, shall indicate this as specified in clause 6.7; and +- 12) shall not perform the remainder of this procedure. + +On receiving a SIP 2xx response to the SIP INVITE request, the IWF performing the participating role: + +- 1) shall interact with the media plane as specified in 3GPP TS 29.380 [31]; +- 2) if the MCPTT emergency group call state is set to "MEGC 2: emergency-call-requested" or "MEGC 3: emergency-call-granted" or the MCPTT imminent peril group call state is set to "MIGC 2: imminent-peril-call-requested" or "MIGC 3: imminent-peril-call-granted", shall perform the actions specified in clause 6.4.1.4, with the IWF acting as the MCPTT client on behalf of the IWF user homed in the IWF; and +- 3) may subscribe to the conference event package as specified in clause 10.3. + +On receiving a SIP 4xx response, a SIP 5xx response or a SIP 6xx response to the SIP INVITE request, the IWF performing the participating role: + +- 1) if the MCPTT emergency group call state is set to "MEGC 2: emergency-call-requested" or "MEGC 3: emergency-call-granted"; or +- 2) if the MCPTT imminent peril group call state is set to "MIGC 2: imminent-peril-call-requested" or "MIGC 3: imminent-peril-call-granted"; + +shall perform the actions specified in clause 6.4.1.5, with the IWF acting as the MCPTT client on behalf of the user homed in the IWF. + +On receiving a SIP INFO request where the Request-URI contains an MCPTT session ID identifying an ongoing group session, the IWF performing the participating role shall follow the actions specified in clause 6.4.1.9, with the IWF acting as the MCPTT client on behalf of the user homed in the IWF. + +#### 10.2.1.1.2 IWF performing the terminating participating role receives SIP re-INVITE request for an MCPTT chat group + +This clause is referenced from other procedures. + +Upon receipt of a SIP re-INVITE request the IWF performing the participating role: + +- 1) if the SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with the element set to a value of "true": + - a) shall set the MCPTT emergency group state to "MEG 2: in-progress"; + - b) shall set the MCPTT imminent peril group state to "MIG 1: no-imminent-peril"; and + - c) shall set the MCPTT imminent peril group call state to "MIGC 1: imminent-peril-gc-capable"; +- 2) if the SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with the element set to a value of "true", shall set the MCPTT imminent peril group state to "MIG 2: in-progress"; +- 3) if the SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with the element set to a value of "false": + - a) if the element containing the element contains an <>alert-ind> element set to "false": + - i) if the SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body including an element: + +- A) if the MCPTT ID contained in the element is the MCPTT ID associated with the targeted user, shall set the MCPTT emergency alert state to "MEA 1: no-alert"; + - b) shall set the MCPTT emergency group state to "MEG 1: no-emergency"; and + - c) if the MCPTT emergency group call state of the group is set to "MEGC 3: emergency-call-granted", shall set the MCPTT emergency group call state of the group to "MEGC 1: emergency-gc-capable"; +- 4) if the SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with the element set to a value of "false": + - a) shall set the MCPTT imminent peril group state to "MIG 1: no-imminent-peril"; and + - b) shall set the MCPTT imminent peril group call state to "MIGC 1: imminent-peril-gc-capable"; + - 5) shall accept the SIP re-INVITE request and generate a SIP 200 (OK) response according to rules and procedures of 3GPP TS 24.229 [3]; + - 6) shall include the g.3gpp.mcptt media feature tag in the Contact header field of the SIP 200 (OK) response; + - 7) shall include the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcptt" in the Contact header field of the SIP 200 (OK) response; + - 8) shall include an SDP answer in the SIP 200 (OK) response to the SDP offer in the incoming SIP re-INVITE request according to 3GPP TS 24.229 [3] with the clarifications given in clause 6.1.2; and + - 9) shall send the SIP 200 (OK) response towards the controlling MCPTT server according to rules and procedures of 3GPP TS 24.229 [3]. + +#### 10.2.1.1.3 MCPTT in-progress emergency cancel + +This clause is referenced from other procedures. + +To cancel an in-progress emergency state on an MCPTT chat group, the IWF performing the participating role shall generate a SIP re-INVITE request as specified in 3GPP TS 24.229 [3], with the clarifications given below. + +The IWF performing the participating role: + +- 1) shall, if cancelling an in-progress emergency state and optionally an MCPTT emergency alert originated by the user homed in the IWF, include an application/vnd.3gpp.mcptt-info+xml MIME body populated as specified in clause 6.4.1.3; +- 2) shall, if cancelling an in-progress emergency state and optionally an MCPTT emergency alert originated by another MCPTT user, include an application/vnd.3gpp.mcptt-info+xml MIME body populated as specified in clause 6.4.1.10; +- 3) shall include in the SIP re-INVITE request an SDP offer according to 3GPP TS 24.229 [3] with the clarifications specified in clause 6.1.1; +- 4) shall include a Resource-Priority header field and comply with the procedures in clause 6.4.1.2; and +- 5) shall exit the procedure in the present clause. + +On receiving a SIP 2xx response to the SIP re-INVITE request, the IWF performing the participating role: + +- 1) shall set the MCPTT emergency group state of the group to "MEG 1: no-emergency"; +- 2) shall set the MCPTT emergency group call state of the group to "MEGC 1: emergency-gc-capable"; and +- 3) if the MCPTT emergency alert state is set to "MEA 4: Emergency-alert-cancel-pending", the sent SIP re-INVITE request did not contain an element in the application/vnd.3gpp.mcptt-info+xml MIME body and the SIP 2xx response to the SIP request for a priority group call does not contain a Warning header field as specified in TS 24.379 [29], clause 4.4, with the IWF acting as the MCPTT server with the warning text containing the mcptt-warn-code set to "149", shall set the MCPTT emergency alert state to "MEA 1: no-alert". + +On receiving a SIP 4xx response, SIP 5xx response or SIP 6xx response to the SIP re-INVITE request: + +- 1) shall set the MCPTT emergency group state as "MEG 2: in-progress"; +- 2) if the SIP 4xx response, SIP 5xx response or SIP 6xx response contains an application/vnd.3gpp.mcptt-info+xml MIME body with an element set to a value of "true" and the sent SIP re-INVITE request did not contain an element in the application/vnd.3gpp.mcptt-info+xml MIME body, the IWF performing the participating role shall set the MCPTT emergency alert state to "MEA 3: emergency-alert-initiated"; and +- 3) if the SIP 4xx response, SIP 5xx response or SIP 6xx response did not contain an application/vnd.3gpp.mcptt-info+xml MIME body with an element and did not contain an element, the MCPTT emergency alert (MEA) state shall revert to its value prior to entering the current procedure. + +NOTE: If the in-progress emergency group state cancel request is rejected, the state of the session does not change, i.e. continues with MCPTT emergency group call level priority. + +On receiving a SIP INFO request where the Request-URI contains an MCPTT session ID identifying an ongoing group session, the IWF performing the participating role shall follow the actions specified in clause 6.4.1.9. + +#### 10.2.1.1.4 MCPTT upgrade to in-progress emergency or imminent peril + +This clause is referenced from other procedures. To upgrade the MCPTT group session to an emergency condition or an imminent peril condition on a MCPTT chat group, the IWF performing the participating role shall generate a SIP re-INVITE request as specified in 3GPP TS 24.229 [3], with the clarifications given below. + +- 1) if upgrading the MCPTT group session to an MCPTT emergency call, the IWF performing the participating role: + - a) shall include an application/vnd.3gpp.mcptt-info+xml MIME body populated as specified in clause 6.4.1.1; and + - b) shall include a Resource-Priority header field and comply with the procedures in clause 6.4.1.2 +- 2) if upgrading the MCPTT group session to an MCPTT imminent peril call, the IWF performing the participating role: + - a) shall include an application/vnd.3gpp.mcptt-info+xml MIME body populated as specified in clause 6.4.1.6; and + - b) shall include a Resource-Priority header field and comply with the procedures in clause 6.4.1.8; +- 3) if the SIP re-INVITE request is to be sent within an on-demand session, the IWF performing the participating role shall include in the SIP re-INVITE request an SDP offer according to 3GPP TS 24.229 [3] with the clarifications specified in clause 6.1.1; +- 4) if an implicit floor request is required, shall indicate this as specified in clause 6.7; and +- 5) shall skip the rest of the steps. + +On receiving a SIP 2xx response to the SIP re-INVITE request the IWF performing the participating role: + +- 1) shall interact with the user plane as specified in 3GPP TS 29.380 [31]; and +- 2) shall perform the actions specified in clause 6.4.1.4, with the IWF acting as the MCPTT client. + +On receiving a SIP 4xx response, SIP 5xx response or SIP 6xx response to the SIP re-INVITE request the IWF performing the participating role shall perform the actions specified in clause 6.4.1.5, with the IWF acting as the MCPTT client. + +On receiving a SIP INFO request where the Request-URI contains an MCPTT session ID identifying an ongoing group session, the IWF performing the participating role shall follow the actions specified in clause 6.4.1.9. + +#### 10.2.1.1.5 MCPTT in-progress imminent peril cancel + +This clause is referenced from other procedures. + +To cancel the in-progress imminent peril state on a MCPTT chat group, the IWF performing the participating role shall generate a SIP re-INVITE request by following the procedures specified in 3GPP TS 24.229 [3], with the clarifications given below. + +The IWF performing the participating role: + +- 1) shall include an application/vnd.3gpp.mcptt-info+xml MIME body populated as specified in clause 6.4.1.7; +- 2) shall include a Resource-Priority header field and comply with the procedures in clause 6.4.1.8; +- 3) shall include in the application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with: + - a) the element set to a value of "chat"; and + - b) the element set to the group identity; +- 4) shall include the g.3gpp.mcptt media feature tag in the Contact header field of the SIP re-INVITE request according to IETF RFC 3840 [9]; +- 5) if the SIP re-INVITE request is to be sent within an on-demand session, shall include in the SIP re-INVITE request an SDP offer according to 3GPP TS 24.229 [3] with the clarifications specified in clause 6.1.1; and +- 6) shall exit the procedure in the present clause. + +On receiving a SIP 2xx response to the SIP re-INVITE request, the IWF performing the participating role: + +- 1) shall interact with the user plane as specified in 3GPP TS 29.380 [31]; +- 2) shall set the MCPTT imminent peril group state of the group to "MIG 1: no-imminent-peril"; and +- 3) shall set the MCPTT imminent peril group call state of the group to "MIGC 1: imminent-peril-gc-capable". + +On receiving a SIP 4xx response, SIP 5xx response or SIP 6xx response to the SIP re-INVITE request: + +- 1) if the SIP 4xx response, SIP 5xx response or SIP 6xx response: + - a) contains an application/vnd.3gpp.mcptt-info+xml MIME body with an element set to a value of "true"; or + - b) does not contain an application/vnd.3gpp.mcptt-info+xml MIME body with an element; + +then the IWF performing the participating role shall set the MCPTT imminent peril group state as "MIG 2: in-progress". + +NOTE: This is the case where the IWF performing the participating role requested the cancellation of the MCPTT imminent peril in-progress state and was rejected. + +#### 10.2.1.1.6 IWF performing the terminating participating role receives a SIP INVITE request for an MCPTT chat group call + +This clause is referenced from other procedures. + +This procedure is used for MCPTT emergency and MCPTT imminent peril calls when the targeted client is affiliated but not joined to the chat group. + +In the procedures in this clause: + +- 1) emergency indication in an incoming SIP INVITE request refers to the element of the application/vnd.3gpp.mcptt-info+xml MIME body; and +- 2) imminent peril indication in an incoming SIP INVITE request refers to the element of the application/vnd.3gpp.mcptt-info+xml MIME body. + +Upon receipt of an initial SIP INVITE request, the IWF performing the participating role: + +- 1) may reject the SIP INVITE request for any reason outside the scope of this specification; + +- 2) if the SIP INVITE request is rejected in step 1), shall respond towards controlling MCPTT function either with appropriate reject code as specified in 3GPP TS 24.229 [3] and warning texts as specified in clause 4.2.2 or with SIP 480 (Temporarily unavailable) and skip the rest of the steps of this clause; +- 3) if the SIP INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with the element set to a value of "true": + - a) shall set the MCPTT emergency group state to "MEG 2: in-progress"; + - b) shall set the MCPTT imminent peril group state to "MIG 1: no-imminent-peril"; and + - c) shall set the MCPTT imminent peril group call state to "MIGC 1: imminent-peril-gc-capable"; otherwise +- 4) if the SIP INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with the element set to a value of "true", shall set the MCPTT imminent peril group state to "MIG 2: in-progress"; +- 5) shall accept the SIP INVITE request and generate a SIP 200 (OK) response according to rules and procedures of 3GPP TS 24.229 [3]; +- 6) shall include the option tag "timer" in a Require header field of the SIP 200 (OK) response; +- 7) shall include the g.3gpp.mcptt media feature tag in the Contact header field of the SIP 200 (OK) response; +- 8) shall include the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcptt" in the Contact header field of the SIP 200 (OK) response; +- 9) shall include the Session-Expires header field in the SIP 200 (OK) response and start the SIP session timer according to IETF RFC 4028 [6]. If no "refresher" parameter was included in the received SIP INVITE request the "refresher" parameter in the Session-Expires header field shall be set to "uas", otherwise shall include a "refresher" parameter set to the value received in the Session-Expires header field the received SIP INVITE request; +- 10) shall include an SDP answer in the SIP 200 (OK) response to the SDP offer in the incoming SIP INVITE request according to 3GPP TS 24.229 [3] with the clarifications given in clause 6.1.2; +- 11) shall send the SIP 200 (OK) response towards the controlling MCPTT server according to rules and procedures of 3GPP TS 24.229 [3]; and +- 12) shall interact with the media plane as specified in 3GPP TS 29.380 [31]. + +## 10.2.2 IWF performing the participating role procedures + +### 10.2.2.1 On-demand chat group call + +#### 10.2.2.1.1 MCPTT chat session establishment + +**Editor's Note:** Behaviour for cases where the IWF affiliates on behalf of users homed in the IWF is FFS. + +In this clause, the IWF originates a chat group session on behalf of a user homed in the IWF. + +NOTE 1: How the IWF determines the public user identity and the MCPTT ID of the calling user is out of scope of the present document. + +The IWF, performing the originating participating role: + +- 1) shall determine the public service identity of the controlling MCPTT function associated with the group identity of the group on which the call is to be originated; + +NOTE 2: How the IWF discovers the public service identity of the controlling MCPTT function associated with the group identity is out of scope of the current document. + +- 2) if the calling user identified by the MCPTT ID is not affiliated to the group on which the call is to be originated, as determined by clause 9.2.1.2.8, shall perform the actions specified in clause 9.2.1.2.9 for implicit affiliation; + +- 3) shall generate a SIP INVITE request as specified in clause 10.2.1.1.1; +- 4) if step 3 was performed successfully, shall complete the SIP INVITE request as specified in clause 6.6.2.1.2; +- 5) if steps 3 and 4 were performed successfully: + - a) shall set the Request-URI to the public service identity of the controlling MCPTT function; + - b) shall set the element of the application/vnd.3gpp.mcptt-info+xml MIME body to the MCPTT ID of the calling user; + - c) may insert the calling user's location information into an application/vnd.3gpp.mcptt-location-info+xml MIME body; + - d) shall send the SIP INVITE request to the controlling MCPTT function as specified in 3GPP TS 24.229 [3]. + +Upon receipt of a SIP 302 (Moved Temporarily) response to the above SIP INVITE request, the IWF, performing the originating participating role: + +- 1) shall generate a SIP INVITE request as specified in clause 6.6.2.1.5; +- 2) shall include an SDP offer based upon the SDP offer in the SIP INVITE request generated by the IWF in the step above; and +- 3) shall send the SIP INVITE request to the controlling MCPTT function according to 3GPP TS 24.229 [3]; + +Upon receipt of a SIP 2xx response to the above SIP INVITE request in step 3) the IWF performing the participating role: + +- 1) shall perform the procedures for receiving a SIP 2xx response as specified in clause 10.2.1.1.1; +- 2) if the procedures of clause 9.2.1.2.9 for implicit affiliation were performed in the present clause, shall complete the implicit affiliation by performing the procedures of clause 9.2.1.2.10. +- 3) shall start the SIP Session timer according to rules and procedures of IETF RFC 4028 [6]. + +Upon receipt of a SIP 4xx, 5xx or 6xx response to the above SIP INVITE request in step 14) the IWF performing the participating role: + +- 1) shall perform the procedures for receiving a SIP 4xx response, a SIP 5xx response or a SIP 6xx response as specified in clause 10.2.1.1.1; +- 2) if the implicit affiliation procedures of clause 9.2.1.2.9 were invoked in the current procedure, shall perform the procedures of clause 9.2.1.2.10. + +On receiving a SIP INFO request where the Request-URI contains an MCPTT session ID identifying an ongoing group session, the IWF performing the participating role shall follow the actions for SIP INFO as specified in clause 10.2.1.1.1. + +#### 10.2.2.1.2 Sending of a SIP re-INVITE request towards the MCPTT controlling function + +Upon a need to send a SIP re-INVITE request for an MCPTT session identifying an on-demand MCPTT chat group session, the IWF performing the participating role: + +- 1) if the request is for an upgrade to an in-progress emergency group state or an imminent peril group state, the IWF performing the participating role shall perform the steps in clause 10.2.1.1.4; +- 2) if the request is for a cancellation of an in-progress emergency group state, the IWF performing the participating role shall perform the steps in clause 10.2.1.1.3; +- 3) if the request is for a cancellation of an in-progress imminent peril group state, the IWF performing the participating role shall perform the steps in clause 10.2.1.1.5; +- 4) shall include the MCPTT ID of the originating user in the element of the application/vnd.3gpp.mcptt-info+xml MIME body of the SIP re-INVITE request; + +NOTE: How the IWF determines the MCPTT ID of a user homed in the IWF is out of scope of the present document. + +- 5) shall include in the SIP re-INVITE request an SDP offer as specified in clause 6.6.2.1.1.1; and +- 6) shall send the SIP re-INVITE request according to 3GPP TS 24.229 [3]. + +Upon receipt of a SIP 2xx response to the above SIP re-INVITE request, the participating MCPTT function: + +- 1) if the SIP re-INVITE request above is for an upgrade for emergency or imminent peril, follow the procedures for SIP 2xx response as specified in clause 10.2.1.1.4; +- 2) if the SIP re-INVITE request above is for an in-progress emergency cancel, follow the procedures for SIP 2xx response as specified in clause 10.2.1.1.3; or +- 3) if the SIP re-INVITE request above is for an in-progress imminent peril cancel, follow the procedures for SIP 2xx response as specified in clause 10.2.1.1.5. + +Upon receipt of a SIP 403 (Forbidden) response to the sent SIP re-INVITE request the participating MCPTT function, the IWF action is out of scope of the present document. + +On receiving a SIP 4xx response, SIP 5xx response or SIP 6xx response to the SIP re-INVITE request the IWF: + +- 1) if the SIP re-INVITE request above is for an upgrade for emergency or imminent peril, follow the procedures for SIP 4xx, 5xx or 6xx response as specified in clause 10.2.1.1.4; +- 2) if the SIP re-INVITE request above is for an in-progress emergency cancel, follow the procedures for SIP 4xx, 5xx or 6xx response as specified in clause 10.2.1.1.3; or +- 3) if the SIP re-INVITE request above is for an in-progress imminent peril cancel, follow the procedures for SIP 4xx, 5xx or 6xx response as specified in clause 10.2.1.1.5. + +Upon receiving a SIP INFO request where the Request-URI contains an MCPTT session ID identifying an ongoing session, the IWF performing the participating role shall: + +- 1) if the SIP re-INVITE request above is for an upgrade for emergency or imminent peril, follow the procedures for SIP INFO as specified in clause 10.2.1.1.4; or +- 2) if the SIP re-INVITE request above is for an in-progress emergency cancel, follow the procedures for SIP INFO as specified in clause 10.2.1.1.3. + +#### 10.2.2.1.3 Reception of a SIP INVITE request by an IWF performing the terminating participating role + +Upon receipt of a "SIP INVITE request for terminating participating MCPTT function", targeting a user homed in the IWF for an MCPTT chat group, the IWF performing the participating role: + +- 1) if unable to process the request due to a lack of resources or a risk of congestion exists, may reject the "SIP INVITE request for terminating participating MCPTT function" with a SIP 500 (Server Internal Error) response. The IWF performing the participating role may include a Retry-After header field to the SIP 500 (Server Internal Error) response as specified in IETF RFC 3261 [14]. Otherwise, continue with the rest of the steps; +- 2) shall check the presence of the isfocus media feature tag in the Contact header field and if it is not present then the IWF performing the participating role shall reject the request with a SIP 403 (Forbidden) response with the warning text set to "104 isfocus not assigned" in a Warning header field as specified in clause 4.4. Otherwise, continue with the rest of the steps; and +- 3) shall perform the steps in 10.2.1.1.6. + +#### 10.2.2.1.4 Reception of a SIP re-INVITE request by an IWF performing the terminating participating role + +Upon receipt of a SIP re-INVITE targeting a user homed in the IWF for an MCPTT chat group, the IWF performing the participating role shall perform the steps in 10.2.1.1.2. + +## 10.2.2.2 End group call at the originating participating IWF + +### 10.2.2.2.1 IWF ending on-demand chat session + +When the IWF performing the participating role determines a need to send a SIP BYE request, the IWF shall follow the procedures as specified in clause 6.6.2.1.3. + +## 10.2.2.3 End group call at the terminating participating IWF + +### 10.2.2.3.1 Receipt of SIP BYE request for on-demand chat session + +Upon receiving a SIP BYE request from the controlling MCPTT function, the IWF performing the participating role shall follow the procedures as specified in clause 6.6.2.2.2.1. + +## 10.2.3 IWF controlling role procedures + +### 10.2.3.1 On-demand chat group call + +#### 10.2.3.1.1 Procedure for establishing an MCPTT chat session and procedure for joining an established MCPTT chat session + +In the procedures in this clause: + +- 1) MCPTT ID in an incoming SIP INVITE request refers to the MCPTT ID of the originating user from the element of the application/vnd.3gpp.mcptt-info+xml MIME body of the incoming SIP INVITE request; +- 2) group identity in an incoming SIP INVITE request refers to the group identity from the element of the application/vnd.3gpp.mcptt-info+xml MIME body of the incoming SIP INVITE request; +- 3) MCPTT ID in an outgoing SIP INVITE request refers to the MCPTT ID of the called user in the element of the application/vnd.3gpp.mcptt-info+xml MIME body of the outgoing SIP INVITE request; +- 4) emergency indication in an incoming SIP INVITE request refers to the element of the application/vnd.3gpp.mcptt-info+xml MIME body; and +- 5) alert indication in an incoming SIP INVITE request refers to the element of the application/vnd.3gpp.mcptt-info+xml MIME body. + +Upon receipt of a "SIP INVITE request for controlling MCPTT function of an MCPTT group" containing a group identity identifying a MCPTT chat group, the IWF performing the controlling role: + +- 1) if unable to process the request due to a lack of resources or a risk of congestion exists, may reject the SIP INVITE request with a SIP 500 (Server Internal Error) response. The IWF performing the controlling role may include a Retry-After header field to the SIP 500 (Server Internal Error) response as specified in IETF RFC 3261 [14] and skip the rest of the steps; + +NOTE 1: If the SIP INVITE request contains an emergency indication set to a value of "true", the IWF performing the controlling role can by means beyond the scope of this specification choose to accept the request. + +- 2) shall reject the SIP request with a SIP 403 (Forbidden) response and not process the remaining steps if: + - a) an Accept-Contact header field does not include the g.3gpp.mcptt media feature tag; + - b) an Accept-Contact header field does not include the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcptt"; or + - c) the isfocus media feature tag is present in the Contact header field; +- 3) if received SIP INVITE request includes an application/vnd.3gpp.mcptt-info+xml MIME body with an element included or an element included, shall validate the request as described in 3GPP TS 24.379 [29], clause 6.3.3.1.17, with the IWF acting as the controlling MCPTT function; + +- 4) shall retrieve the necessary group document(s) from the group management server for the group identity contained in the SIP INVITE request and carry out initial processing as specified in 3GPP TS 24.379 [29], clause 6.3.5.2, with the IWF acting as the participating MCPTT function and continue with the rest of the steps if the checks in 3GPP TS 24.379 [29], clause 6.3.5.2 succeed; +- 5) if the MCPTT user identified by the MCPTT ID in the SIP INVITE request is not affiliated with the MCPTT group identified by the group identity in the SIP INVITE request as determined by the procedures of 3GPP TS 24.379 [29], clause 6.3.6, with the IWF acting as the controlling MCPTT function: + - a) shall check if the MCPTT user is eligible to be implicitly affiliated with the MCPTT chat group as determined by clause 9.2.1.3.6; and + - b) if the MCPTT user is not eligible for implicit affiliation, shall reject the SIP INVITE request with a SIP 403 (Forbidden) response with the warning text set to "120 user is not affiliated to this group" in a Warning header field as specified in 3GPP TS 24.379 [29], clause 4.4, with the IWF acting as the controlling MCPTT function and skip the rest of the steps below; +- 6) if the SIP INVITE request contains unauthorised request for an MCPTT emergency group call as determined by clause 6.6.3.1.8.2: + - a) shall reject the SIP INVITE request with a SIP 403 (Forbidden) response as specified in clause 6.6.3.1.9; and + - b) shall send the SIP 403 (Forbidden) response as specified in 3GPP TS 24.229 [3] and skip the rest of the steps; +- 7) if the SIP INVITE request contains an unauthorised request for an MCPTT imminent peril group call as determined by clause 6.6.3.1.8.6, shall reject the SIP INVITE request with a SIP 403 (Forbidden) response with the following clarifications: + - a) shall include in the SIP 403 (Forbidden) response an application/vnd.3gpp.mcptt-info+xml MIME body as specified in 3GPP TS 24.379 [29], clause F.1 with the element containing the element with the element set to a value of "false"; and + - b) shall send the SIP 403 (Forbidden) response as specified in 3GPP TS 24.229 [3] and skip the rest of the steps; +- 8) if a Resource-Priority header field is included in the SIP INVITE request: + - a) if the Resource-Priority header field is set to the value indicated for emergency calls and the SIP INVITE request does not contain an emergency indication and the in-progress emergency state of the group is set to a value of "false", shall reject the SIP INVITE request with a SIP 403 (Forbidden) response and skip the remaining steps; and + - b) if the Resource-Priority header field is set to the value indicated for imminent peril calls and the SIP INVITE request does not contain an imminent peril indication and the in-progress imminent peril state of the group is set to a value of "false", shall reject the SIP INVITE request with a SIP 403 (Forbidden) response; and skip the remaining steps; +- 9) shall validate that the received SDP offer includes at least one media stream for which the media parameters and at least one codec or media format is acceptable by the IWF performing the controlling role and if not, reject the request with a SIP 488 (Not Acceptable Here) response and skip the rest of the steps; +- 10) shall create a chat group session and allocate an MCPTT session identity for the chat group session if the MCPTT chat group session identity does not already exist, and may handle timer TNG3 (group call timer) as specified in clause 6.6.3.5; +- 11) if the chat group session is ongoing and the as specified in 3GPP TS 24.481 [16] is already reached: + - a) if, according to local policy, the user identified by the MCPTT ID in the SIP INVITE request is deemed to have a higher priority than an existing user in the chat group session, may remove a participant from the session by following clause 10.1.4.4.3, and skip the next step; and + +NOTE 2: The local policy for deciding whether to admit a user to a call that has reached its maximum amount of participants can include the and the of the user as well as other information of the user from the group document as specified in 3GPP TS 24.481 [16]. The local policy decisions can also include taking into account whether the imminent-peril indicator or emergency indicator was received in the SIP INVITE request. + +- b) shall return a SIP 486 (Busy Here) response with the warning text set to "122 too many participants" to the originating network as specified in 3GPP TS 24.379 [29], clause 4.4, with the IWF acting as the controlling MCPPTT function. Otherwise, continue with the rest of the steps; +- 12) if the received SIP INVITE request was determined to be eligible for implicit affiliation in step 5) and if clause 9.2.1.3.7 was not previously invoked in the present clause, shall perform the implicit affiliation as specified in clause 9.2.1.3.7; + - 13) if the SIP INVITE request contains an emergency indication set to a value of "true" or the in-progress emergency state of the group to "true" the IWF performing the controlling role shall: + - a) validate that the SIP INVITE request includes a Resource-Priority header field populated with the values for an MCPPTT emergency group call as specified in clause 6.6.3.1.12, and if not: + - i) perform the actions specified in clause 6.6.3.1.5; + - ii) send the SIP UPDATE request generated in clause 6.6.3.1.5 towards the initiator of the SIP INVITE request according to 3GPP TS 24.229 [3]; and + - iii) upon receiving a SIP 200 (OK) response to the SIP UPDATE request sent in clause 6.6.3.1.5, proceed with the rest of the steps. + +NOTE 3: Verify that the Resource-Priority header is included and properly populated for both ongoing and newly-entered in-progress emergency states of the specified group. + +- b) if the in-progress emergency state of the group is set to a value of "true" and the MCPPTT user is indicating a new emergency indication: + - i) for each of the other affiliated MCPPTT members of the group generate a SIP MESSAGE request notification of the MCPPTT user's emergency indication as specified in 3GPP TS 24.379 [29], clause 6.3.3.1.11, with the IWF acting as the controlling MCPPTT function, with the following clarifications: + - A) set the element of the application/vnd.3gpp.mcptt-info+xml MIME body to a value of "true"; + - B) if the received SIP INVITE contains an alert indication set to a value of "true" and this is an authorised request for an MCPPTT emergency alert meeting the conditions specified in clause 6.6.3.1.8.1, perform the procedures specified in clause 6.6.3.1.7; and + - C) send the SIP MESSAGE request as specified in 3GPP TS 24.229 [3]; + - ii) cache the information that the MCPPTT user has initiated an MCPPTT emergency call; and + - iii) if the SIP INVITE request contains an authorised request for an MCPPTT emergency alert as determined in step i) B) above, cache the information that the MCPPTT user has initiated an MCPPTT emergency alert; and +- c) if the in-progress emergency state of the group is set to a value of "false": + - i) shall set the value of the in-progress emergency state of the group to "true"; + - ii) shall start timer TNG2 (in-progress emergency group call timer) and handle its expiry as specified in clause 6.6.3.1.10; + - iii) shall generate SIP re-INVITE requests for the MCPPTT emergency group call to the other MCPPTT affiliated and joined participants of the MCPPTT chat group as specified in clause 6.6.3.1.3; + - iv) shall generate SIP INVITE requests for the MCPPTT emergency group call to the affiliated but not joined MCPPTT members of the MCPPTT chat group as specified in clause 6.6.3.1.4; + +- A) for each affiliated but not joined MCPTT member shall send the SIP INVITE request towards the MCPTT client as specified in 3GPP TS 24.229 [3]; and + - B) upon receiving a SIP 200 (OK) response to the SIP INVITE request the IWF performing the controlling role shall interact with the media plane as specified in 3GPP TS 29.380 [31]; +- v) shall cache the information that the MCPTT user has initiated an MCPTT emergency call; and + - vi) if the element of the application/vnd.3gpp.mcptt-info+xml MIME body is set to "true" and is an authorised request for an MCPTT emergency alert as specified in clause 6.6.3.1.8.1, shall cache the information that the MCPTT user has initiated an MCPTT emergency alert; and + - vii) if the in-progress imminent peril state of the group is set to a value of "true", shall set it to a value of "false"; +- 14) if the in-progress emergency state of the group is set to a value of "false" and if the SIP INVITE request contains an imminent peril indication set to a value of "true" or the in-progress imminent peril state of the group is set to "true", the IWF performing the controlling role shall: +- a) validate that the SIP INVITE request includes a Resource-Priority header field populated with the values for an MCPTT imminent peril group call as specified in clause 6.6.3.1.12, and if not: + - i) perform the actions specified in clause 6.6.3.1.5; + - ii) send the SIP UPDATE request generated in clause 6.6.3.1.5 towards the initiator of the SIP INVITE request according to 3GPP TS 24.229 [3]; and + - iii) upon receiving a SIP 200 (OK) response to the SIP UPDATE request sent in clause 6.6.3.1.5 proceed with the rest of the steps. + +NOTE 4: Verify that the Resource-Priority header is included and properly populated for both ongoing and newly-entered in-progress imminent peril states of the specified group. + +- b) if the in-progress imminent peril state of the group is set to a value of "true" and the MCPTT user is indicating a new imminent peril indication: + - i) for each of the other affiliated MCPTT member of the group generate a SIP MESSAGE request notification of the MCPTT user's imminent peril indication as specified in 3GPP TS 24.379 [29], clause 6.3.3.1.11, with the IWF acting as the controlling MCPTT function, with the following clarifications: + - A) set the element of the application/vnd.3gpp.mcptt-info+xml MIME body to a value of "true"; and + - B) send the SIP MESSAGE request as specified in 3GPP TS 24.229 [3]; and + - ii) cache the information that the MCPTT user has initiated an MCPTT imminent peril call; and +- c) if the in-progress imminent peril state of the group is set to a value of "false": + - i) shall set the value of the in-progress imminent peril state of the group to "true"; + - ii) shall generate SIP re-INVITE requests for the MCPTT imminent peril group call to the other MCPTT affiliated and joined participants of the MCPTT chat group as specified in 3GPP TS 24.379 [29], clause 6.3.3.1.15, with the IWF acting as the controlling MCPTT function; + - iii) shall generate SIP INVITE requests for the MCPTT imminent peril call to the affiliated but not joined MCPTT members of the MCPTT chat group as specified in clause 6.6.3.1.4; + - A) for each affiliated but not joined MCPTT member shall send the SIP INVITE request towards the MCPTT client as specified in 3GPP TS 24.229 [3]; and + - B) Upon receiving a SIP 200 (OK) response to the SIP INVITE request the IWF performing the controlling role shall interact with the media plane as specified in 3GPP TS 29.380 [31]; and + - iv) shall cache the information that the MCPTT user has initiated an MCPTT imminent peril call; + +- 15) shall accept the SIP request and generate a SIP 200 (OK) response to the SIP INVITE request according to 3GPP TS 24.229 [3]; +- 16) shall include in the SIP 200 (OK) response an SDP answer according to 3GPP TS 24.229 [3] with the clarifications specified in 3GPP TS 24.379 [29], clause 6.3.3.2.1, with the IWF acting as the controlling MCPTT function, unless the procedures of clause 6.6.3.1.5 were performed in step 13)a) or step 14)a) above; +- 17) should include the Session-Expires header field and start supervising the SIP session according to IETF RFC 4028 [6]. It is recommended that the "refresher" header field parameter is omitted. If included, the "refresher" header field parameter shall be set to "uac"; +- 18) shall include the "timer" option tag in a Require header field; +- 19) shall include the following in a Contact header field: + - a) the g.3gpp.mcptt media feature tag; + - b) the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcptt"; + - c) the MCPTT session identity; and + - d) the media feature tag isfocus; +- 20) shall include the "tdialog" option tag in a Supported header field according to IETF RFC 4538 [13]; +- 21) if the SIP INVITE request contains an alert indication set to a value of "true" and this is an unauthorised request for an MCPTT emergency alert as specified in clause 6.6.3.1.8.1, shall include in the SIP 200 (OK) response the warning text set to "149 SIP INFO request pending" in a Warning header field as specified in 3GPP TS 24.379 [29], clause 4.4, with the IWF acting as the controlling MCPTT function; +- 22) if the received SIP INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "true" and if the in-progress emergency state of the group is set to a value of "true", shall include in the SIP 200 (OK) response the warning text set to "149 SIP INFO request pending" in a Warning header field as specified in 3GPP TS 24.379 [29], clause 4.4, with the IWF acting as the controlling MCPTT function; + +NOTE 5: In this case, the request was for an imminent peril call but a higher priority MCPTT emergency call was already in progress on the group. Hence, the imminent peril call request aspect of the request is denied but the request is granted with emergency level priority. + +- 23) shall interact with media plane as specified in 3GPP TS 29.380 [31]; +- 24) shall send the SIP 200 (OK) response to the MCPTT client according to 3GPP TS 24.229 [3]; and +- 25) if the chat group session was already ongoing and if at least one of the MCPTT participants has subscribed to the conference event package, shall send a SIP NOTIFY request to all MCPTT participants with a subscription to the conference event package as specified in 3GPP TS 24.379 [29], clause 10.1.3.4.2 with the IWF acting as the controlling MCPTT function. + +Upon receiving a SIP ACK to the SIP 200 (OK) response sent towards the inviting MCPTT client, and the SIP 200 (OK) response was sent with the warning text set to "149 SIP INFO request pending" in a Warning header field as specified in clause 4.4, the IWF performing the controlling role shall follow the procedures in clause 6.6.3.1.11. + +#### 10.2.3.1.2 Receipt of a SIP re-INVITE request + +In the procedures in this clause: + +- 1) emergency indication in an incoming SIP re-INVITE request refers to the element of the application/vnd.3gpp.mcptt-info+xml MIME body; and +- 2) imminent peril indication in an incoming SIP re-INVITE request refers to the element of the application/vnd.3gpp.mcptt-info+xml MIME body. + +Upon receipt of a SIP re-INVITE request for an MCPTT session identity identifying a MCPTT chat group session, the IWF performing the controlling role: + +- 1) if unable to process the request due to a lack of resources or a risk of congestion exists, may reject the SIP re-INVITE request with a SIP 500 (Server Internal Error) response. The IWF performing the controlling role may include a Retry-After header field to the SIP 500 (Server Internal Error) response as specified in IETF RFC 3261 [14] and skip the rest of the steps; + +NOTE 1: if the SIP re-INVITE request contains an emergency indication or an imminent peril indication set to a value of "true" and this is an authorised request for originating an MCPTT emergency group call as determined by clause 6.6.3.1.8.2, or for originating an MCPTT imminent peril group call as determined by clause 6.6.3.1.8.5, the IWF performing the controlling role can according to local policy choose to accept the request. + +- 2) if the received SIP re-INVITE request includes an application/vnd.3gpp.mcptt-info+xml MIME body with an element included or an element included, shall validate the request as described in 3GPP TS 24.379 [29], clause 6.3.3.1.17, with the IWF acting as the controlling MCPTT function; +- 3) if the SIP re-INVITE request contains an unauthorised request for an MCPTT emergency call as determined by clause 6.6.3.1.8.2: + - a) shall reject the SIP re-INVITE request with a SIP 403 (Forbidden) response as specified in clause 6.6.3.1.9; and + - b) shall send the SIP 403 (Forbidden) response as specified in 3GPP TS 24.229 [3] and skip the rest of the steps; +- 4) if the SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "true" and is an authorised request to initiate an MCPTT emergency group call as determined by clause 6.6.3.1.8.2, the IWF performing the controlling role shall: + - a) validate that the SIP re-INVITE request includes a Resource-Priority header field is populated correctly for an MCPTT emergency group call as specified in clause 6.6.3.1.12, and if not: + - i) shall perform the actions specified in clause 6.6.3.1.5; and + - ii) upon receiving a SIP 200 (OK) response to the SIP UPDATE request sent in clause 6.6.3.1.5 shall proceed with the rest of the steps. + +NOTE 2: Verify that the Resource-Priority header is included and properly populated for both ongoing and newly-entered in-progress emergency states of the specified group. + +- b) if the in-progress emergency state of the group is set to a value of "true" and the MCPTT user is indicating a new emergency indication: + - i) shall cache the MCPTT ID of the MCPTT user that has initiated an MCPTT emergency call; + - ii) if the SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the <>alert-ind> element set to a value of "true" and is an authorised request for an MCPTT emergency alert as determined by clause 6.6.3.1.8.1, shall cache the MCPTT ID of the MCPTT user that has initiated an MCPTT emergency alert; and + - iii) for each of the other affiliated members of the group, generate a SIP MESSAGE request notification of the MCPTT user's emergency indication as specified in 3GPP TS 24.379 [29], clause 6.3.3.1.11, with the IWF acting as the controlling MCPTT function, with the following clarifications: + - A) set the element of the application/vnd.3gpp.mcptt-info+xml MIME body to a value of "true"; + - B) if the received SIP re-INVITE contains an alert indication set to a value of "true" and this is an authorised request for an MCPTT emergency alert meeting the conditions specified in clause 6.6.3.1.8.1, perform the procedures specified in clause 6.6.3.1.7; and + - C) send the SIP MESSAGE request as specified in 3GPP TS 24.229 [3]; and +- c) if the in-progress emergency state of the group is set to a value of "false": + - i) shall set the value of the in-progress emergency state of the group to "true"; + - ii) shall cache the MCPTT ID of the MCPTT user that has initiated an MCPTT emergency call; + +- iii) if the SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "true" and this is an authorised request for an MCPTT emergency alert as specified in clause 6.6.3.1.8.1, shall cache the MCPTT ID of the MCPTT user that has initiated an MCPTT emergency alert; + - iv) shall start timer TNG2 (in-progress emergency group call timer) and handle its expiry as specified in clause 6.6.3.1.10; + - v) shall generate SIP re-INVITE requests for the MCPTT emergency group call to the other affiliated and joined participants of the MCPTT chat group as specified in clause 6.6.3.1.3. The IWF performing the controlling role: + - A) for each affiliated and joined member shall send the SIP re-INVITE request towards the MCPTT client as specified in 3GPP TS 24.229 [3]; and + - B) Upon receiving a SIP 200 (OK) response to the SIP re-INVITE request the IWF performing the controlling role shall interact with the media plane as specified in 3GPP TS 29.380 [31]; and + - vi) shall generate SIP INVITE requests for the MCPTT emergency group call to the affiliated but not joined MCPTT members of the MCPTT chat group as specified in clause 6.6.3.1.4. The IWF performing the controlling role: + - A) for each affiliated but not joined MCPTT member shall send the SIP INVITE request towards the MCPTT client as specified in 3GPP TS 24.229 [3]; and + - B) Upon receiving a SIP 200 (OK) response to the SIP INVITE request the IWF performing the controlling role shall interact with the media plane as specified in 3GPP TS 29.380 [31]; and + - vii) if the in-progress imminent peril state of the group is set to a value of "true", shall set it to a value of "false"; +- 5) if the SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "false" and is an unauthorised request for an MCPTT emergency group call cancellation as determined by clause 6.6.3.1.8.4: + - a) shall reject the SIP re-INVITE request with a SIP 403 (Forbidden) response; + - b) shall include in the SIP 403 (Forbidden) response an application/vnd.3gpp.mcptt-info+xml MIME body as specified in 3GPP TS 24.379 [29], clause F.1 with an element set to a value of "true"; + - c) if an element of the application/vnd.3gpp.mcptt-info+xml MIME body is included set to "false" and there is an outstanding MCPTT emergency alert for the MCPTT user, shall include in the application/vnd.3gpp.mcptt-info+xml MIME body and element set to a value of "true"; and + - d) shall send the SIP 403 (Forbidden) response as specified in 3GPP TS 24.229 [3] and skip the rest of the steps; + - 6) if the SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "false" and is determined to be an authorised request for an MCPTT emergency call cancellation as specified in clause 6.6.3.1.8.4 and the in-progress emergency state of the group to is set to a value of "true" the IWF performing the controlling role shall: + - a) validate that the SIP re-INVITE request includes a Resource-Priority header field is populated correctly for a normal priority MCPTT group call as specified in clause 6.6.3.1.12, and if not: + - i) shall perform the actions specified in clause 6.6.3.1.5; and + - ii) upon receiving a SIP 200 (OK) response to the SIP UPDATE request sent in clause 6.6.3.1.5 shall proceed with the rest of the steps; + +NOTE 3: Verify that the Resource-Priority header is included and properly populated for an in-progress emergency state cancellation of the specified group. + +- b) set the in-progress emergency group state of the group to a value of "false"; +- c) clear the cache of the MCPTT ID of the MCPTT user identified by the element as having an outstanding MCPTT emergency group call; + +- d) if an element of the application/vnd.3gpp.mcptt-info+xml MIME body is included and set to "false" and is determined to be an authorised request for an MCPTT emergency alert cancellation as specified in clause 6.6.3.1.8.3 and there is an outstanding MCPTT emergency alert for the MCPTT user shall: + - i) if the received SIP re-INVITE request contains an element in the application/vnd.3gpp.mcptt-info+xml MIME body, clear the cache of the MCPTT ID of the MCPTT user identified by the element as having an outstanding MCPTT emergency alert; and + - ii) if the received SIP re-INVITE request does not contain an element in the application/vnd.3gpp.mcptt-info+xml MIME body, clear the cache of the MCPTT ID of the sender of the SIP re-INVITE request as having an outstanding MCPTT emergency alert; +- e) generate SIP re-INVITE requests to the other affiliated and joined members of the MCPTT group as specified in clause 6.6.3.1.3. The IWF performing the controlling role: + - i) for each affiliated and joined member shall send the SIP re-INVITE request towards the MCPTT client as specified in 3GPP TS 24.229 [3]; and + - ii) Upon receiving a SIP 200 (OK) response to the SIP re-INVITE request the IWF performing the controlling role shall interact with the media plane as specified in 3GPP TS 29.380 [31]; and + +NOTE 4: Clause 6.6.3.1.3 will inform the affiliated and joined members of the cancellation of the MCPTT group's in-progress emergency state and the cancellation of the MCPTT emergency alert if applicable. + +- f) for each of the affiliated but not joined members of the group shall: + - i) generate a SIP MESSAGE request notification of the cancellation of the MCPTT user's emergency call as specified in 3GPP TS 24.379 [29], clause 6.3.3.1.11, with the IWF acting as the controlling MCPTT function; + - ii) set the element of the application/vnd.3gpp.mcptt-info+xml MIME body to a value of "false"; + - iii) if indicated above in step d), set the element of the application/vnd.3gpp.mcptt-info+xml MIME body to a value of "false"; and + - iv) send the SIP MESSAGE request according to 3GPP TS 24.229 [3]; +- 7) if a Resource-Priority header field is included in the SIP re-INVITE request: + - a) if the Resource-Priority header field is set to the value indicated for emergency calls and the received SIP re-INVITE request does not contain an authorised request for an MCPTT emergency call as determined in step 4) above and the in-progress emergency state of the group is set to a value of "false", shall reject the SIP re-INVITE request with a SIP 403 (Forbidden) response and skip the remaining steps; or + - b) if the Resource-Priority header field is set to the value indicated for imminent peril calls and the received SIP re-INVITE request does not contain an authorised request for an MCPTT imminent peril call as determined by the procedures of clause 6.6.3.1.8.5 and the in-progress imminent peril state of the group is set to a value of "false", shall reject the SIP re-INVITE request with a SIP 403 (Forbidden) response and skip the remaining steps; +- 8) if the received SIP re-INVITE request contains an imminent peril indication, shall perform the procedures specified in clause 10.2.3.1.3 and skip the rest of the steps; +- 9) shall include in the SIP 200 (OK) response an SDP answer according to 3GPP TS 24.229 [3] with the clarifications specified in 3GPP TS 24.379 [29], clause 6.3.3.2.1, with the IWF acting as the controlling MCPTT function, unless the procedures of clause 6.6.3.1.5 were performed in step 6) a) i) above; +- 10) shall include the "tdialog" option tag in a Supported header field according to IETF RFC 4538 [13]; +- 11) if the received SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "true" and if this is an unauthorised request for an MCPTT emergency alert as determined by clause 6.6.3.1.8.1, shall include in the SIP 200 (OK) response the warning text set to "149 SIP INFO request pending" in a Warning header field as specified in 3GPP TS 24.379 [29], clause 4.4, with the IWF acting as the controlling MCPTT function; + +12) if the received SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "false" and if this is an unauthorised request for an MCPTT emergency alert cancellation as determined by clause 6.6.3.1.8.3, shall include in the SIP 200 (OK) response the warning text set to "149 SIP INFO request pending" in a Warning header field as specified in 3GPP TS 24.379 [29], clause 4.4, with the IWF acting as the controlling MCPTT function; + +13) if the received SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "true", this is an authorised request for an MCPTT imminent peril group call and if the in-progress emergency state of the group is set to a value of "true", shall include in the SIP 200 (OK) response the warning text set to "149 SIP INFO request pending" in a Warning header field as specified in 3GPP TS 24.379 [29], clause 4.4, with the IWF acting as the controlling MCPTT function; + +NOTE 5: In this case, the request was for an imminent peril call but a higher priority MCPTT emergency call was already in progress on the group. Hence, the imminent peril call request aspect of the request is denied but the request is granted with emergency level priority. + +14) shall interact with media plane as specified in 3GPP TS 29.380 [31]; and + +15) shall send the SIP 200 (OK) response towards the MCPTT client according to 3GPP TS 24.229 [3]. + +Upon receiving a SIP ACK to the SIP 200 (OK) response sent towards the inviting MCPTT client, and the SIP 200 (OK) response was sent with the warning text set to "149 SIP INFO request pending" in a Warning header field as specified in 3GPP TS 24.379 [29], clause 4.4, with the IWF acting as the controlling MCPTT function, the IWF performing the controlling role shall follow the procedures in clause 6.6.3.1.11. + +#### 10.2.3.1.3 Handling of a SIP re-INVITE request for imminent peril session + +In the procedures in this clause: + +1) imminent peril indication in an incoming SIP INVITE request refers to the element of the application/vnd.3gpp.mcptt-info+xml MIME body. + +When the IWF performing the controlling role receives a SIP re-INVITE request with an imminent peril indication, the IWF performing the controlling role: + +- 1) if the SIP re-INVITE request contains an unauthorised request for an MCPTT imminent peril group call as determined by clause 6.6.3.1.8.5, shall reject the SIP re-INVITE request with a SIP 403 (Forbidden) response with the following clarifications: + - a) shall include in the SIP 403 (Forbidden) response an application/vnd.3gpp.mcptt-info+xml MIME body as specified in 3GPP TS 24.379 [29], clause F.1 with the element containing the element with the element set to a value of "false"; and + - b) shall send the SIP 403 (Forbidden) response as specified in 3GPP TS 24.229 [3] and skip the rest of the steps; +- 2) if the in-progress emergency group state of the group is set to a value of "false" and if the SIP re-INVITE request contains an imminent peril indication set to a value of "true" or the in-progress imminent peril state of the group to "true", the IWF performing the controlling role shall: + - a) validate that the SIP re-INVITE request includes a Resource-Priority header field with the namespace set to the MCPTT-specific namespace specified in IETF RFC 8101 [23] and the priority set to the priority designated for imminent peril calls and if not: + - i) perform the actions specified in clause 6.6.3.1.5; + - ii) send the SIP UPDATE request generated in clause 6.6.3.1.5 towards the initiator of the SIP re-INVITE request according to 3GPP TS 24.229 [3]; and + - iii) upon receiving a SIP 200 (OK) response to the SIP UPDATE request sent in clause 6.6.3.1.5 proceed with the rest of the steps. + +NOTE 1: Verify that the Resource-Priority header is included and properly populated for both ongoing and newly-entered in-progress imminent peril states of the specified group. + +- b) if the in-progress imminent peril state of the group is set to a value of "true" and the MCPTT user is indicating a new imminent peril indication: + - i) for each of the other affiliated member of the group generate a SIP MESSAGE request notification of the MCPTT user's imminent peril indication as specified in 3GPP TS 24.379 [29], clause 6.3.3.1.11, with the IWF acting as the controlling function, with the following clarifications; + - A) set the element of the application/vnd.3gpp.mcptt-info+xml MIME body to a value of "true"; and + - B) send the SIP MESSAGE request as specified in 3GPP TS 24.229 [3]; and + - ii) cache the information that the MCPTT user has initiated an MCPTT imminent peril call; and + - c) if the in-progress imminent peril state of the group is set to a value of "false": + - i) shall set the value of the in-progress imminent peril state of the group to "true"; + - ii) shall generate SIP re-INVITE requests for the MCPTT imminent peril group call to the other affiliated and joined participants of the MCPTT chat group as specified in 3GPP TS 24.379 [29], clause 6.3.3.1.15, with the IWF acting as the controlling MCPTT function; + - iii) shall generate SIP INVITE requests for the MCPTT imminent peril group call to the affiliated but not joined members of the MCPTT chat group as specified in clause 6.6.3.1.4; + - A) for each affiliated but not joined member shall send the SIP INVITE request towards the MCPTT client as specified in 3GPP TS 24.229 [3]; and + - B) Upon receiving a SIP 200 (OK) response to the SIP INVITE request the IWF performing the controlling role shall interact with the media plane as specified in 3GPP TS 29.380 [31]; and + - iv) shall cache the information that the MCPTT user has initiated an MCPTT imminent peril call; +- 3) if the SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "false" and is an unauthorised request for an MCPTT imminent peril group call cancellation as determined by clause 6.6.3.1.8.6 shall: +- a) reject the SIP re-INVITE request with a SIP 403 (Forbidden) response to the SIP re-INVITE request; and + - b) include in the SIP 403 (Forbidden) response: + - i) include in the SIP 403 (Forbidden) response an application/vnd.3gpp.mcptt-info+xml MIME body as specified in 3GPP TS 24.379 [29], clause F.1 with the element containing the element with the element set to a value of "false"; + - ii) send the SIP 403 (Forbidden) response as specified in 3GPP TS 24.229 [3]; and + - iii) skip the rest of the steps; +- 4) if the SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "false" and is determined to be an authorised request for an MCPTT imminent peril call cancellation as specified in clause 6.6.3.1.8.6 and the in-progress imminent peril state of the group to is set to a value of "true" the IWF performing the controlling role shall: +- a) validate that the SIP re-INVITE request includes a Resource-Priority header field with the namespace set to the MCPTT-specific namespace specified in IETF RFC 8101 [23], and the priority set to the priority level designated for a normal priority MCPTT group call, and if not: + - i) perform the actions specified in clause 6.6.3.1.5; and + - ii) upon receiving a SIP 200 (OK) response to the SIP UPDATE request sent in clause 6.6.3.1.5, proceed with the rest of the steps; +- NOTE 2: verify that the Resource-Priority header is included and properly populated for an in-progress emergency group state cancellation of the specified group. +- b) set the in-progress imminent peril state of the group to a value of "false"; + +- c) cache the information that the MCPTT user no longer has an outstanding MCPTT imminent peril group call; +- d) generate SIP re-INVITES requests to the other affiliated and joined members of the MCPTT group as specified in 3GPP TS 24.379 [29], clause 6.3.3.1.15, with the IWF acting as the controlling MCPTT function. The IWF performing the controlling role: + - i) for each affiliated and joined member shall send the SIP re-INVITE request towards the MCPTT client as specified in 3GPP TS 24.229 [3]; and + - ii) Upon receiving a SIP 200 (OK) response to the SIP re-INVITE request the IWF performing the controlling role shall interact with the media plane as specified in 3GPP TS 29.380 [31]; and + +NOTE 3: 3GPP TS 24.379 [29], clause 6.3.3.1.15, with the IWF acting as the controlling MCPTT function, will inform the affiliated and joined members of the cancellation of the MCPTT group's in-progress emergency group state and the cancellation of the MCPTT emergency alert if applicable. + +- e) for each of the affiliated but not joined MCPTT members of the group: + - i) generate a SIP MESSAGE request notification of the cancellation of the MCPTT user's imminent peril call as specified in 3GPP TS 24.379 [29], clause 6.3.3.1.11, with the IWF acting as the controlling MCPTT function; + - ii) set the element of the application/vnd.3gpp.mcptt-info+xml MIME body to a value of "false"; and + - iii) send the SIP MESSAGE request according to 3GPP TS 24.229 [3]; +- 5) include in the SIP 200 (OK) response an SDP answer according to 3GPP TS 24.229 [3] with the clarifications specified in 3GPP TS 24.379 [29], clause 6.3.3.2.1 unless the procedures of clause 6.6.3.1.5 were performed in step 2) or 4) above; +- 6) include the "norefersub" option tag in a Supported header field according to IETF RFC 4488 [12]; +- 7) include the "tdialog" option tag in a Supported header field according to IETF RFC 4538 [13]; +- 8) interact with media plane as specified in 3GPP TS 29.380 [31]; and +- 9) send the SIP 200 (OK) response towards the MCPTT client according to 3GPP TS 24.229 [3]. + +### 10.2.3.2 End group call at the terminating IWF performing the controlling role + +Upon receiving a SIP BYE request the IWF performing the controlling role shall follow the procedures as specified in clause 6.6.3.2.1. + +### 10.2.3.3 End group call initiated by the IWF performing the controlling role + +#### 10.2.3.3.1 General + +This clause describes the procedures of each functional entity for ending the group call initiated by the IWF performing the controlling role. + +#### 10.2.3.3.2 SIP BYE request for releasing MCPTT session for a group call + +When the MCPTT session for group call needs to be released as specified in clause 6.6.7.1, the IWF performing the controlling role shall follow the procedures in clause 6.6.3.1.2. + +#### 10.2.3.3.3 SIP BYE request towards a MCPTT client + +When an MCPTT client needs to be removed from the MCPTT session (e.g. due to de-affiliation or admitting a higher priority user), the IWF performing the controlling role shall follow the procedures in clause 6.6.3.1.2. + +After successfully removing the MCPTT client from the MCPTT session, the IWF performing the controlling role may generate a notification to the MCPTT clients, which have subscribed to the conference event package that an MCPTT + +user has been removed from the MCPTT session, as specified in clause 6.6.3.4 and send the SIP NOTIFY request to the MCPTT client according to 3GPP TS 24.229 [3]. + +#### 10.2.3.3.4 Removal of participant homed in the IWF + +After successfully removing a participant homed in the IWF from the MCPTT session, the IWF performing the controlling role may generate a notification to any MCPTT clients in the session, which have subscribed to the conference event package that a user has been removed from the MCPTT session, as specified in clause 6.6.3.4 and send the SIP NOTIFY request to the MCPTT client according to 3GPP TS 24.229 [3]. + +### 10.2.4 Non-controlling role procedures + +*Editor's note: Content to be added.* + +## 10.3 Subscription to the conference event package + +*Editor's note: Content to be added.* + +## 10.4 Remotely initiated group call + +### 10.4.1 Participating MCPTT function procedures + +#### 10.4.1.1 IWF performing the participating role + +##### 10.4.1.1.1 Originating procedures + +Originating procedures are not supported in this version of the specification. + +##### 10.4.1.1.2 Terminating procedures + +Upon receiving a "SIP MESSAGE request for remotely initiated group call for terminating participating function" the IWF performing the participating role shall reject the SIP MESSAGE request with a SIP 501 (Not Implemented) response. + +#### 10.4.1.2 IWF performing the controlling role + +Upon receiving: + +- a "SIP MESSAGE request for remotely initiated group call request for controlling MCPTT function"; or +- a "SIP MESSAGE request for remotely initiated group call response for controlling MCPTT function"; + +the IWF performing the controlling role shall reject the SIP MESSAGE request with a SIP 501 (Not Implemented) response. + +# 11 Private call call control + +## 11.1 Private call with floor control + +### 11.1.1 Client derived procedures + +#### 11.1.1.1 On-demand private call + +##### 11.1.1.1.1 Originating procedures + +This clause is referenced from other procedures. + +To establish an MCPTT private call the IWF performing the participating role shall generate an initial SIP INVITE request by following the UE originating session procedures specified in 3GPP TS 24.229 [3], with the clarifications given below. + +The IWF performing the participating role: + +- 1) if originating an MCPTT emergency private call or originating an MCPTT private call and the MCPTT emergency state is already set, the IWF performing the participating role, shall comply with the procedures in clause 6.4.2.1; +- 2) shall include the g.3gpp.mcptt media feature tag and the g.3gpp.icsi-ref media feature tag with the value of "urn:urn-7:3gpp-service.ims.icsi.mcptt" in the Contact header field of the SIP INVITE request according to IETF RFC 3840 [9]; +- 3) shall include an Accept-Contact header field containing the g.3gpp.mcptt media feature tag along with the "require" and "explicit" header field parameters according to IETF RFC 3841 [5]; +- 4) shall include an Accept-Contact header field with the media feature tag g.3gpp.icsi-ref contain with the value of "urn:urn-7:3gpp-service.ims.icsi.mcptt" along with parameters "require" and "explicit" according to IETF RFC 3841 [5]; +- 5) for the establishment of a private call shall insert in the SIP INVITE request a MIME resource-lists body with the MCPTT ID of the invited MCPTT user, according to rules and procedures of IETF RFC 5366 [11]; +- 6) if a security context needs to be established between the IWF and the MCPTT client and if the user homed in the IWF is initiating a private call then: + - a) if necessary, request keying material from the key management server as described in 3GPP TS 33.180 [27]; + - b) shall use the keying material to generate a PCK as described in 3GPP TS 33.180 [27]; + - c) shall use the PCK to generate a PCK-ID with the four most significant bits set to "0000" to indicate that the purpose of the PCK is to protect private call communications and with the remaining twenty-eight bits being randomly generated as described in 3GPP TS 33.180 [27]; + - d) shall encrypt the PCK to a UID associated to the MCPTT client using the MCPTT ID and KMS URI of the invited user and a time related parameter as described in 3GPP TS 33.180 [27]; + +NOTE 1: How the IWF obtains the KMS URI of the invited user is out of scope of the present document. + +- e) shall generate a MIKEY-SAKKE I\_MESSAGE using the encapsulated PCK and PCK-ID as specified in 3GPP TS 33.180 [27]; and +- f) shall add the MCPTT ID of the originating user homed in the IWF to the initiator field (IDRi) of the I\_MESSAGE as described in 3GPP TS 33.180 [27]; and +- g) shall sign the MIKEY-SAKKE I\_MESSAGE using the originating user homed in the IWF's signing key provided in the keying material together with a time related parameter, and add this to the MIKEY-SAKKE payload, as described in 3GPP TS 33.180 [27]; + +- 7) shall include an SDP offer according to 3GPP TS 24.229 [3] with the clarification given in clause 6.1.1 and with a media stream of the offered media-floor control entity; +- 8) if implicit floor control is required, shall comply with the conditions specified in clause 6.7; +- 9) if force of automatic commencement mode at the invited MCPTT client is requested by the user homed in the IWF, shall include in the SIP INVITE request a Priv-Answer-Mode header field with the value "Auto" according to the rules and procedures of IETF RFC 5373 [10]; +- 10) if force of automatic commencement mode at the invited MCPTT client is not requested by the user homed in the IWF: + - a) if automatic commencement mode at the invited MCPTT client is requested by the user homed in the IWF, shall include in the SIP INVITE request an Answer-Mode header field with the value "Auto" according to the rules and procedures of IETF RFC 5373 [10]; and + - b) if manual commencement mode at the invited MCPTT client is requested by the user homed in the IWF, shall include in the SIP INVITE request an Answer-Mode header field with the value "Manual" according to the rules and procedures of IETF RFC 5373 [10]; and +- 11) shall contain an application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with the element set to a value of "private"; and +- 12) if the MCPTT emergency private call state of the user homed in the IWF is set to either "MEPC 2: emergency-pc-requested" or "MEPC 3: emergency-pc-granted" or the MCPTT emergency private priority state for this private call is set to "MEPP 2: in-progress", the IWF shall comply with the procedures in clause 6.4.2.2. + +NOTE 2: Upon receiving a SIP 183(Session Progress) response to the SIP INVITE request the IWF performing the participating role's actions are out of scope of the present document. + +Upon receiving a SIP 200 (OK) response to the SIP INVITE request the IWF performing the participating role: + +- 1) shall interact with the media plane as specified in 3GPP TS 29.380 [31]; +- 2) if the MCPTT emergency private call state is set to "MEPC 2: emergency-pc-requested" or "MEPC 3: emergency-pc-granted", shall perform the actions specified in 3GPP TS 24.379 [29], clause 6.2.8.3.4, with the IWF acting as the MCPTT client on behalf of the IWF user homed in the IWF; and +- 3) shall consider the call successfully established. + +On receiving a SIP 4xx response, a SIP 5xx response or a SIP 6xx response to the SIP INVITE request: + +- 1) if the MCPTT emergency private call state is set to "MEPC 2: emergency-pc-requested"; or +- 2) if the MCPTT emergency private call state is set to "MEPC 3: emergency-pc-granted"; + +the IWF performing the participating role shall perform the actions specified in 3GPP TS 24.379 [29], clause 6.2.8.3.5, with the IWF acting as the MCPTT client on behalf of the IWF user homed in the IWF. + +On receiving a SIP INFO request where the Request-URI contains an MCPTT session ID identifying an ongoing session, the IWF performing the participating role shall follow the actions specified in 3GPP TS 24.379 [29], clause 6.2.8.3.7 with the IWF acting as the MCPTT client on behalf of the IWF user homed in the IWF. + +#### 11.1.1.1.2 IWF terminating procedures + +This clause is referenced from other procedures. + +The IWF performing the participating role: + +- 1) may reject the SIP INVITE request for any other reason outside the scope of this specification otherwise, continue with the rest of the steps. +- 2) if the SIP INVITE request is rejected in step 1), shall respond towards the controlling MCPTT function either with appropriate reject code as specified in 3GPP TS 24.229 [3] and warning texts as specified in clause 4.2.2 or with SIP 480 (Temporarily unavailable) response and skip the rest of the steps of this clause; + +- 3) if the SIP INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with the element set to a value of "true": + - c) shall set the MCPTT emergency private priority state to "MEPP 2: in-progress" for this private call; + - 4) if the SDP offer of the SIP INVITE request contains an "a=key-mgmt" attribute field with a "mikey" attribute value containing a MIKEY-SAKKE I\_MESSAGE: + - a) shall extract the MCPTT ID of the originating MCPTT from the initiator field (IDRi) of the I\_MESSAGE as described in 3GPP TS 33.180 [27]; + - b) shall convert the MCPTT ID to a UID as described in 3GPP TS 33.180 [27]; + - c) shall use the UID to validate the signature of the MIKEY-SAKKE I\_MESSAGE as described in 3GPP TS 33.180 [27]; + - d) if authentication verification of the MIKEY-SAKKE I\_MESSAGE fails, shall reject the SIP INVITE request with a SIP 488 (Not Acceptable Here) response as specified in IETF RFC 4567 [22], and include warning text set to "136 authentication of the MIKEY-SAKKE I\_MESSAGE failed" in a Warning header field as specified in clause 4.4; and + - e) if the signature of the MIKEY-SAKKE I\_MESSAGE was successfully validated: + - i) shall extract and decrypt the encapsulated PCK using the terminating user's (KMS provisioned) UID key as described in 3GPP TS 33.180 [27]; and + - ii) shall extract the PCK-ID, from the payload as specified in 3GPP TS 33.180 [27]; +- NOTE: With the PCK successfully shared between the originating and the terminating parties, the IWF and the MCPTT client are able to use SRTP/SRTCP to create a secure session. +- 5) shall perform the automatic commencement procedures specified in clause 6.2.1 if one of the following conditions are met: + - a) SIP INVITE request contains an Answer-Mode header field with the value "Auto" and the IWF is configured for automatic commencement mode for the user receiving the call; + - c) SIP INVITE request contains a Priv-Answer-Mode header field with the value of "Auto" and the IWF is able to process an automatic commencement; and + - 6) shall perform the manual commencement procedures specified in clause 6.2.2 if either of the following conditions are met: + - a) SIP INVITE request contains an Answer-Mode header field with the value "Manual" and the IWF is configured for manual commencement mode for the user receiving the call; + - b) SIP INVITE request contains a Priv-Answer-Mode header field with the value of "Manual" and the IWF is able to process a manual commencement. + +Upon receiving the SIP CANCEL request cancelling a SIP INVITE request for which a dialog exists at the IWF performing the participating role and a SIP 200 (OK) response has not yet been sent to the SIP INVITE request then the IWF performing the participating role: + +- 1) shall send a SIP 200 (OK) response to the SIP CANCEL request according to 3GPP TS 24.229 [3]; and +- 2) shall send a SIP 487 (Request Terminated) response to the SIP INVITE request according to 3GPP TS 24.229 [3]. + +Upon receiving a SIP BYE request for an established dialog, the IWF performing the participating role: + +- 1) shall follow the procedures in clause 11.4.1.1. + +#### 11.1.1.1.3 Terminating procedures for reception of SIP re-INVITE request + +This clause is referenced from other procedures. + +Upon receipt of a SIP re-INVITE request for an existing private call session, the IWF performing the participating role shall: + +- 1) if the SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with the element set to a value of "true": + - b) shall set the MCPTT emergency private priority state to "MEPP 2: in-progress" for this private call; +- 2) if the SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with the element set to a value of "false": + - a) if the SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body including an element: + - i) if the MCPTT ID contained in the element is the MCPTT ID of the receiving MCPTT user, shall set the MCPTT emergency alert state to "MPEA 1: no-alert"; + - b) shall set the MCPTT emergency private priority state to "MEPP 1: no-emergency" for this private call; and + - c) if the MCPTT emergency private call state of the call is set to "MEPC 3: emergency-call-granted", shall set the MCPTT emergency private call state of the call to "MEPC 1: emergency-pc-capable"; +- 3) may check if a Resource-Priority header field is included in the incoming SIP INVITE request and may perform further actions outside the scope of this specification to act upon an included Resource-Priority header field as specified in 3GPP TS 24.229 [3]; and + +NOTE: As this is a re-INVITE for an existing MCPTT private call session, there is no attempt made to change the answer-mode from its current state. + +- 4) include an SDP answer in the SIP 200 (OK) response to the SDP offer in the incoming SIP INVITE request according to 3GPP TS 24.229 [3] with the clarifications given in clause 6.1.2 with the IWF acting as the MCPTT client. + +#### 11.1.1.1.4 MCPTT in-progress emergency cancel + +This clause is referenced from other procedures. + +To cancel the in-progress emergency condition on an MCPTT emergency private call, the IWF performing the participating role shall generate a SIP re-INVITE request by following the UE session procedures specified in 3GPP TS 24.229 [3], with the clarifications given below. + +The IWF performing the participating role: + +- 1) shall, if cancelling an in-progress emergency condition and optionally an MCPTT emergency alert originated for the user homed in the IWF, include an application/vnd.3gpp.mcptt-info+xml MIME body populated as specified in clause 6.4.2.3; +- 2) shall include a Resource-Priority header field and comply with the procedures in clause 6.4.2.2; +- 3) shall include in the SIP re-INVITE request an SDP offer with the media parameters as currently established; +- 4) if an implicit floor request is required, shall indicate this as specified in clause 6.7; and +- 5) shall send the SIP re-INVITE request according to 3GPP TS 24.229 [3]. + +On receiving a SIP 2xx response to the SIP re-INVITE request, the IWF performing the participating role: + +- 1) shall interact with the user plane as specified in 3GPP TS 29.380 [31]; +- 2) shall set the MCPTT emergency private priority state of the MCPTT private call to "MEPP 1: no-emergency"; +- 3) shall set the MCPTT emergency private call state of the call to "MEPC 1: emergency-pc-capable"; and + +- 4) if the MCPTT emergency alert state is set to "MPEA 4: Emergency-alert-cancel-pending", the sent SIP re-INVITE request did not contain an element in the application/vnd.3gpp.mcptt-info+xml MIME body and the SIP 2xx response to the SIP request for a priority group call does not contain a Warning header field as specified in 3GPP TS 24.379 [29], clause 4.4 with the warning text containing the mcptt-warn-code set to "149", shall set the MCPTT emergency alert state to "MPEA 1: no-alert". + +On receiving a SIP 4xx response, SIP 5xx response or SIP 6xx response to the SIP re-INVITE request: + +- 1) if the SIP 4xx response, SIP 5xx response or SIP 6xx response contains an application/vnd.3gpp.mcptt-info+xml MIME body with an element set to a value of "true", the IWF performing the participating role shall set the MCPTT emergency private priority state as "MEPP 2: in-progress"; +- 2) if the SIP 4xx response, SIP 5xx response or SIP 6xx response contains an application/vnd.3gpp.mcptt-info+xml MIME body with an <>alert-ind> element set to a value of "true" and the sent SIP re-INVITE request did not contain an element in the application/vnd.3gpp.mcptt-info+xml MIME body, the IWF performing the participating role shall set the MCPTT emergency alert state to "MPEA 3: emergency-alert-initiated"; and +- 3) if the SIP 4xx response, SIP 5xx response or SIP 6xx response did not contain an application/vnd.3gpp.mcptt-info+xml MIME body, the IWF performing the participating role shall set the MCPTT emergency private priority state as "MEPP 2: in-progress" and the MCPTT emergency alert (MPEA) state shall revert to its value prior to entering the current procedure. + +NOTE: If the in-progress emergency private priority state cancel request is rejected, the state of the session does not change, i.e. continues with MCPTT emergency private call level priority. + +On receiving a SIP INFO request where the Request-URI contains an MCPTT session ID identifying an ongoing group session, the IWF performing the participating role shall follow the actions specified in 3GPP TS 24.379 [29], clause 6.2.8.3.7 with the IWF acting as the MCPTT client. + +#### 11.1.1.1.5 Upgrade to MCPTT emergency private call + +This clause is referenced by other clauses. + +To upgrade the ongoing MCPTT private call to an MCPTT emergency private call, the IWF performing the participating role shall generate a SIP re-INVITE request as specified in 3GPP TS 24.229 [3], with the clarifications given below. + +- 1) shall include an application/vnd.3gpp.mcptt-info+xml MIME body populated as specified in clause 6.4.2.1; +- 2) shall include a Resource-Priority header field and comply with the procedures in clause 6.4.2.2. +- 3) shall include an SDP offer with the media parameters as currently established according to 3GPP TS 24.229 [3]; +- 4) if an implicit floor request is required, shall indicate this as specified in clause 6.7; and +- 5) shall send the SIP re-INVITE request according to 3GPP TS 24.229 [3]. + +On receiving a SIP 2xx response to the SIP re-INVITE request the IWF performing the participating role: + +- 1) shall interact with the user plane as specified in 3GPP TS 29.380 [31]; and +- 2) shall perform the actions specified in 3GPP TS 24.379 [29], clause 6.2.8.3.4 with the IWF acting as the MCPTT client. + +On receiving a SIP 4xx response, SIP 5xx response or SIP 6xx response to the SIP re-INVITE request, the IWF performing the participating role shall perform the actions specified in 3GPP TS 24.379 [29], clause 6.2.8.3.5 with the IWF acting as MCPTT client. + +On receiving a SIP INFO request where the Request-URI contains an MCPTT session ID identifying an ongoing group session, the IWF performing the participating role shall follow the actions specified in 3GPP TS 24.379 [29], clause 6.2.8.3.7 with the IWF acting as the MCPTT client. + +## 11.1.2 IWF participating role procedures + +### 11.1.2.1 Originating procedures + +#### 11.1.2.1.1 On-demand private call + +In the present clause, the IWF performing the participating role initiates an on-demand private call. The IWF performing the participating role: + +- 1) shall determine the MCPTT ID of the calling user; + +NOTE: How the IWF determines the MCPTT ID of a user homed in the IWF is out of scope of the present document. + +- 2) shall determine the public service identity of the controlling MCPTT function for the private call service associated with the originating user's MCPTT ID identity; +- 3) shall generate a SIP INVITE request as specified in clause 11.1.1.1.1; +- 4) shall modify the SIP INVITE as specified in clause 6.6.2.1.2; +- 5) shall set the Request-URI to the public service identity of the controlling MCPTT function hosting the private call service as determined by step 3; +- 6) shall set the element in an application/vnd.3gpp.mcptt-info+xml MIME body of the SIP INVITE request to the MCPTT ID of the calling user; +- 7) if the SIP INVITE request contains an emergency indication set to a value of "true", may include a Resource-Priority header field populated with the values for an emergency call as specified in clause 6.4.1.11; otherwise, may include a Resource-Priority header field populated with the values for a normal call as specified in clause 6.4.1.11; and +- 8) shall forward the SIP INVITE request, according to 3GPP TS 24.229 [3]. + +Upon receiving a SIP 180 (Ringing) response, the IWF performing the participating role's action are out of scope of the present document. + +Upon receiving a SIP 200 (OK) response, the IWF performing the participating role: + +- 1) shall perform the procedures for receiving a SIP 200 ok as specified in clause 11.1.1.1.1; and +- 2) shall start the SIP session timer according to rules and procedures of IETF RFC 4028 [6]. + +On receiving a SIP 4xx response, a SIP 5xx response or a SIP 6xx response to the SIP INVITE request, the IWF performing the participating role shall follow the procedures for SIP 4xx, SIP 5xx and SIP 6xx responses as specified in clause 11.1.1.1.1. + +Upon receiving a SIP INFO request where the Request-URI contains an MCPTT session ID identifying an ongoing session, the IWF performing the participating role shall follow the procedures for SIP INFO as specified in clause 11.1.1.1.1. + +#### 11.1.2.1.2 SIP re-INVITE for MCPTT private call + +Upon deciding to send a SIP re-INVITE for an existing private call session, the IWF performing the participating role: + +- 1) shall determine the MCPTT ID of the calling user; + +NOTE 1: How the IWF determines the MCPTT ID of a user homed in the IWF is out of scope of the present document. + +- 2) if the SIP re-INVITE is to upgrade the call to an emergency call, shall generate a SIP re-INVITE request as specified in clause 11.1.1.1.5; + +- 3) if the SIP re-INVITE is to cancel the emergency on the call, shall generate a SIP re-INVITE request as specified in clause 11.1.1.1.4; +- 4) shall set the element in an application/vnd.3gpp.mcptt-info+xml MIME body of the SIP re-INVITE request to the MCPTT ID of the calling user homed in the IWF; + +NOTE 2: How the IWF determines the MCPTT ID of a user homed in the IWF is out of scope of the present document. + +- 5) shall, if the SIP re-INVITE is to be sent within an on-demand session include in the SIP re-INVITE request an SDP containing the current media parameters used by the existing session; +- 6) shall include a Resource-Priority header field as specified in clause 6.4.1.11; and +- 7) shall forward the SIP re-INVITE request, according to 3GPP TS 24.229 [3]. + +Upon receiving a SIP 200 (OK) response, the IWF performing the participating role: + +- 1) shall interact with the media plane as specified in 3GPP TS 29.380 [31]; and +- 2) shall follow the procedures for SIP 200 (OK) response as specified in clause 11.1.1.1.4 if an emergency is being cancelled in the present clause or as specified in clause 11.1.1.1.5 if the call is being upgraded to emergency in the present clause. The IWF performing the participating role shall forward any other SIP response that does not contain SDP, including any MIME bodies contained therein, along the signalling path to the originating network according to 3GPP TS 24.229 [3]. + +On receiving a SIP 4xx response, a SIP 5xx response or a SIP 6xx response to the SIP INVITE request, the IWF performing the participating role shall follow the procedures for SIP 4xx, SIP 5xx and SIP 6xx responses as specified in clause 11.1.1.1.4 if an emergency is being cancelled in the present clause or as specified in clause 11.1.1.1.5 if the call is being upgraded to emergency in the present clause. + +Upon receiving a SIP INFO request where the Request-URI contains an MCPTT session ID identifying an ongoing session, the IWF performing the participating role shall follow the procedures for SIP INFO as specified in clause 11.1.1.1.4 if an emergency is being cancelled in the present clause or as specified in clause 11.1.1.1.5 if the call is being upgraded to emergency in the present clause. + +### 11.1.2.2 Terminating procedures + +Upon receipt of a "SIP INVITE request for terminating participating MCPTT function", the IWF performing the participating role: + +- 1) shall respond with a SIP 488 (not acceptable here) with a body part as described in clause 6.10.2 if the IWF does not support one or more parameters of the call as described in clause 6.10.1; +- 2) if unable to process the request due to a lack of resources or a risk of congestion exists, may reject the "SIP INVITE request for terminating participating MCPTT function" with a SIP 500 (Server Internal Error) response. The IWF may include a Retry-After header field to the SIP 500 (Server Internal Error) response as specified in IETF RFC 3261 [14], and shall not continue with the rest of the steps; + +NOTE: If the received SIP INVITE request contains an emergency indication set to a value of "true", the IWF can choose to accept the request. + +- 3) shall check the presence of the isfocus media feature tag in the URI of the Contact header field and if it is not present then the IWF shall reject the request with a SIP 403 (Forbidden) response with the warning text set to "104 isfocus not assigned" in a Warning header field as specified in 3GPP TS 24.379 [29], clause 4.4, and shall not continue with the rest of the steps; +- 4) shall use the MCPTT ID present in the element of the application/vnd.3gpp.mcptt-info+xml MIME body of the incoming SIP INVITE request to retrieve the binding between the MCPTT ID and public user identity; and +- 5) the IWF may reject the "SIP INVITE request for terminating participating MCPTT function" with a SIP 403 (Forbidden) response including warning text set to "127 user not authorised to be called in private call" in a Warning header field as specified in 3GPP TS 24.379 [29], clause 4.4. + +The IWF performing the participating role sends the SIP 200 (OK) response to the originating network: + +- 1) shall generate a SIP 200 (OK) response as described in 3GPP TS 24.379 [29], clause 6.3.2.2.4.2; +- 2) shall include in the SIP 200 (OK) response an SDP answer based on the SDP answer in the received SIP 200 (OK) response as specified in 3GPP TS 24.379 [29], clause 6.3.2.2.2.1; +- 3) shall copy the P-Asserted-Identity header field from the incoming SIP 200 (OK) response to the outgoing SIP 200 (OK) response; +- 4) shall interact with the media plane as specified in 3GPP TS 29.380 [31] clause 6.4; and +- 5) shall forward the SIP 200 (OK) response according to 3GPP TS 24.229 [3]. + +### 11.1.2.3 Receipt of SIP re-INVITE request by terminating participating function + +This clause covers the on-demand session case only. + +Upon receipt of a SIP re-INVITE request for an existing MCPTT private call session the IWF performing the participating role: + +- 1) if unable to process the request due to a lack of resources or a risk of congestion exists, shall reject the SIP re-INVITE with a SIP 500 (Server Internal Error) response. The IWF performing the participating role may include a Retry-After header field to the SIP 500 (Server Internal Error) response as specified in IETF RFC 3261 [14] and shall skip the rest of the steps; + +NOTE 1: If the SIP re-INVITE request contains an emergency indication, the IWF performing the participating role can choose to accept the request. + +NOTE 2: As this is the modification of an in-progress MCPTT private call, this procedure does not attempt modification of the existing answer-mode of the call. + +- 2) shall generate a SIP 200 (OK) response as described in 3GPP TS 24.379 [29], clause 6.3.2.2.4.2, with the IWF acting as the participating MCPTT function; +- 3) shall perform the procedures in clause 11.1.1.1.3; +- 4) shall modify the SDP answer in the received SIP 200 (OK) response as specified in 3GPP TS 24.379 [29], clause 6.3.2.2.2.1 with the IWF acting as the participating function; +- 5) shall interact with the media plane as specified in 3GPP TS 29.380 [31]; and +- 6) shall forward the SIP 200 (OK) response according to 3GPP TS 24.229 [3]. + +## 11.1.3 IWF controlling role procedures + +### 11.1.3.1 Originating procedures + +This clause describes the procedures for inviting an MCPTT user to an MCPTT session. The procedure is initiated by the IWF performing the controlling role. + +The IWF performing the controlling role: + +- 1) shall generate a SIP INVITE request as specified in clause 6.6.3.1.1; +- 2) shall set the to the calling user's MCPTT ID in the outgoing SIP INVITE; +- 3) if the received request is for an MCPTT emergency private call as determined by clause 6.6.3.1.8.2: + - a) shall set the element of the application/vnd.3gpp.mcptt-info+xml MIME body to a value of "true"; + - b) if the request is for an MCPTT emergency alert, shall perform the procedures specified in clause 6.6.3.1.7; and + +- c) if the request is not for an MCPTT emergency alert, shall set the element of the application/vnd.3gpp.mcptt-info+xml MIME body to a value of "false"; +- 4) shall copy the MCPTT ID of the called MCPTT user into the element in the application/vnd.3gpp.mcptt-info+xml MIME body of the outgoing SIP INVITE request; + - 5) shall set the Request-URI to the public service identity of the terminating participating MCPTT function associated to the MCPTT user to be invited; +- NOTE 1: How the IWF performing the controlling role finds the address of the terminating MCPTT participating function is out of the scope of the current release. +- NOTE 2: The terminating MCPTT user is part of a partner MCPTT system, therefore the public service identity can identify an entry point in the partner network that is able to identify the terminating participating MCPTT function. +- 6) shall include a Resource-Priority header field populated with the values for an MCPTT emergency private call as specified in clause 6.6.3.1.12, if either of the following conditions is met: + - a) if the request is for an MCPTT emergency private call as determined in step 2 above; or + - b) the originating user homed in the IWF is in an in-progress emergency private call state with the targeted MCPTT user; + - 7) shall include an SDP offer according to 3GPP TS 24.229 [3] with the clarification given in clause 6.1.1 and with a media stream of the offered media-floor control entity and according to the procedures specified in 3GPP TS 24.379 [29], clause 6.3.3.1.1 with the IWF acting as the controlling MCPTT function; + - 8) shall send the SIP INVITE request towards the core network according to 3GPP TS 24.229 [3]; and + - 9) shall start a private call timer with a value set to the configured max private call duration for the user. + +Upon receiving SIP 200 (OK) response for the SIP INVITE request the IWF performing the controlling role: + +- 1) shall cache the contact received in the Contact header field; and +- 2) shall interact with the media plane as specified in 3GPP TS 29.380 [31]. + +Upon expiry of the private call timer, the IWF performing the controlling role shall follow the procedure for releasing private call session as specified in clause 11.4.3. + +### 11.1.3.2 Terminating procedures + +In the procedures in this clause: + +- 1) refers to the element of the application/vnd.3gpp.mcptt-info+xml MIME body; +- 2) refers to the element of the application/vnd.3gpp.mcptt-info+xml MIME body; and +- 3) refers to the element of an application/vnd.3gpp.mcptt-info+xml MIME body. + +Upon receipt of a "SIP INVITE request for controlling MCPTT function of a private call", the IWF performing the controlling role: + +- 1) if the in the SIP INVITE request is set to "private": + - a) shall check whether the public service identity contained in the Request-URI is allocated for private call and perform the actions specified in clause 6.6.6.1 if it is not allocated and skip the rest of the steps; and + - b) shall perform actions to verify the MCPTT ID of the inviting MCPTT user in the element of the application/vnd.3gpp.mcptt-info+xml MIME body of the SIP INVITE request, and authorise the request according to local policy, and if it is not authorised the IWF performing the controlling role shall return a SIP 403 (Forbidden) response with the warning text as specified in "Warning header field" and skip the rest of the steps; + +- 2) if the incoming SIP INVITE request does not contain an application/resource-lists MIME body shall reject the SIP INVITE request with a SIP 403 (Forbidden) response including warning text set to "145 unable to determine called party" in a Warning header field as specified in 3GPP TS 24.379 [29], clause 4.4, and shall not continue with the rest of the steps; +- 3) if the is set to "private" and the application/resource-lists MIME body contains more than one element, shall reject the "SIP INVITE request for controlling MCPTT function of a private call" with a SIP 403 (Forbidden) response including warning text set to "145 unable to determine called party" in a Warning header field as specified in 3GPP TS 24.379 [29], clause 4.4, and shall not continue with the rest of the steps; +- 4) shall validate that the received SDP offer includes at least one media stream for which the media parameters and at least one codec or media format is acceptable by the IWF performing the controlling role and if not, reject the request with a SIP 488 (Not Acceptable Here) response and skip the rest of the steps; +- 5) if received SIP INVITE request includes an , shall validate the request as described in 3GPP TS 24.379 [29], clause 6.3.3.1.17, with the IWF acting as the controlling function; +- 6) if the received SIP INVITE request contains an unauthorised request for an MCPTT emergency private call as determined by clause 6.6.3.1.8.2: + - a) shall reject the SIP INVITE request with a SIP 403 (Forbidden) response as specified in clause 6.6.3.1.9; and + - b) shall send the SIP 403 (Forbidden) response as specified in 3GPP TS 24.229 [3] and skip the rest of the steps; +- 7) if a Resource-Priority header field is included in the received SIP INVITE request and if the Resource-Priority header field is set to the value indicated for emergency calls, shall reject the SIP INVITE request with a SIP 403 (Forbidden) response and skip the remaining steps if neither one of the following conditions are true: + - a) the SIP INVITE request does not contain an authorised request for an MCPTT emergency call as determined in step 4 above; or + - b) the originating MCPTT user is not in an in-progress emergency private call state with the targeted MCPTT user; +- 8) if: + - a) the received SIP INVITE request contains an emergency indication set to a value of "true"; + - b) the originating MCPTT user is not in an in-progress emergency private call state with the targeted user homed in the IWF; and + - c) if the in the SIP INVITE request is set to "private";then: + - a) shall cache the information that the MCPTT user has initiated an MCPTT emergency private call to the targeted user; and + - b) shall cache the information that the MCPTT user is in an in-progress emergency private call state with the targeted user homed in the IWF; +- 9) shall perform actions as described in 3GPP TS 24.379 [29], clause 6.3.3.2.2, with the IWF acting as the controlling MCPTT function; +- 10) shall allocate an MCPTT session identity for the MCPTT session; and +- 11) shall set up a private call with the targeted user homed in the IWF (the user whose MCPTT ID is listed in the MIME resource-lists body of received SIP INVITE request). + +NOTE 1: How the IWF sets up calls internally is out of scope of the present document. + +Upon deciding to send a SIP 180 (Ringing) response and if the SIP 180 (Ringing) response or the SIP final response has not yet been sent to the inviting MCPTT client, the IWF performing the controlling role shall generate a SIP 180 (Ringing) response to the SIP INVITE request and send the SIP 180 (Ringing) response towards the inviting MCPTT client according to 3GPP TS 24.229 [3]. + +Upon deciding to accept the call, the IWF performing the controlling role: + +- 1) shall generate a SIP 200 (OK) response to the SIP INVITE request as specified in the 3GPP TS 24.379 [29] clause 6.3.3.2.3.2, with the IWF acting as the MCPTT controlling function, before continuing with the rest of the steps; +- 2) shall include in the SIP 200 (OK) response an SDP answer to the SDP offer in the incoming SIP INVITE request as specified in the 3GPP TS 24.379 [29] clause 6.3.3.2.2, with the IWF acting as the controlling MCPTT function; +- 3) if the received SIP INVITE request contains an alert indication set to a value of "true" and this is an unauthorised request for an MCPTT emergency alert as specified in clause 6.6.3.1.8.1, shall include in the SIP 200 (OK) response the warning text set to "149 SIP INFO request pending" in a Warning header field as specified in 3GPP TS 24.379 [29], clause 4.4, with the IWF acting as the controlling function; + +NOTE 2: This is the case when the MCPTT user's request for an MCPTT emergency private call was granted but the request for the MCPTT emergency alert was denied. + +- 4) shall interact with the media plane as specified in 3GPP TS 29.380 [31]; and + +NOTE 3: Resulting media plane processing is completed before the next step is performed. + +- 5) shall send a SIP 200 (OK) response towards the inviting MCPTT client according to 3GPP TS 24.229 [3]. + +Upon receiving a SIP ACK to the SIP 200 (OK) response sent towards the inviting MCPTT client, where the SIP 200 (OK) response was sent with a Warning header field as specified in 3GPP TS 24.379 [29], clause 4.4, with the IWF acting as the controlling function with the warning text containing the mcptt-warn-code set to "149", the IWF performing the controlling role shall follow the procedures in clause 6.6.3.1.11. + +Upon receiving a SIP BYE request from the originating MCPTT client containing an application/vnd.3gpp.mcptt-info+xml MIME body containing a element set to a value of "authentication of the MIKEY-SAKE I\_MESSAGE failed", the IWF performing the controlling role shall follow the procedures in clause 6.6.3.2.1. + +### 11.1.3.3 Receiving a SIP re-INVITE for upgrade to emergency private call + +In the procedures in this clause: + +- 1) emergency indication in an incoming SIP re-INVITE request refers to the element of the application/vnd.3gpp.mcptt-info+xml MIME body; and +- 2) alert indication in an incoming SIP re-INVITE request refers to the element of the application/vnd.3gpp.mcptt-info+xml MIME body. + +Upon receiving a SIP re-INVITE request with an emergency indication set to a value of "true", the IWF performing the controlling role: + +- 1) shall validate that the received SDP offer includes at least one media stream for which the media parameters and at least one codec or media format is acceptable by the IWF performing the controlling role and if not, reject the request with a SIP 488 (Not Acceptable Here) response and skip the rest of the steps; +- 2) shall validate the request as described in 3GPP TS 24.379 [29], clause 6.3.3.1.17 with the IWF acting as the MCPTT server; +- 3) if the SIP re-INVITE request contains an unauthorised request for an MCPTT emergency private call as determined by clause 6.6.3.1.8.2: + - a) shall reject the SIP INVITE request with a SIP 403 (Forbidden) response as specified in clause 6.6.3.1.9; and + - b) shall send the SIP 403 (Forbidden) response as specified in 3GPP TS 24.229 [3] and skip the rest of the steps; +- 4) if the SIP re-INVITE request contains an emergency indication set to a value of "true" and the originating MCPTT user is not in an in-progress emergency private call state with the targeted user: + - a) shall cache the information that the MCPTT user is in an in-progress emergency private call state with the targeted user; and + +- b) if the SIP re-INVITE request contains an alert indication set to "true", shall cache the information that the MCPTT user has sent an MCPTT emergency alert to the targeted user; and +- 5) shall perform the steps in clause 11.1.2.3 with the IWF performing the participating role but shall not forward the SIP 200 (OK) response. + +If the SIP response has not yet been sent towards the inviting MCPTT client, the IWF performing the controlling role: + +- 1) shall modify the SIP 200 (OK) response to the SIP re-INVITE request as specified in 3GPP TS 24.379 [29], clause 6.3.3.2.3.2 with the IWF acting as the controlling function before continuing with the rest of the steps; +- 2) if the received SIP re-INVITE request contains an alert indication set to a value of "true" and this is an unauthorised request for an MCPTT emergency alert as specified in clause 6.6.3.1.8.1, shall include in the SIP 200 (OK) response the warning text set to "149 SIP INFO request pending" in a Warning header field as specified in 3GPP TS 24.379 [29], clause 4.4 with the IWF acting as the MCPTT server. + +NOTE: When a SIP 200 (OK) response sent towards the originator as a response to a SIP INVITE request that contained authorised request(s) for an MCPTT emergency private call and optionally an MCPTT emergency alert, the originator will consider a SIP 200 (OK) response populated in this manner as confirmation that its request(s) for an upgrade to an MCPTT emergency private call and optionally an MCPTT emergency alert were accepted by the IWF performing the controlling role. + +- 3) shall interact with the media plane as specified in 3GPP TS 29.380 [31]; and +- 4) shall send the SIP 200 (OK) response towards the inviting MCPTT client according to 3GPP TS 24.229 [3]. + +Upon receiving a SIP ACK to the SIP 200 (OK) response sent towards the inviting MCPTT client, and the SIP 200 (OK) response was sent with the warning text set to "149 SIP INFO request pending" in a Warning header field as specified in 3GPP TS 24.379 [29], clause 4.4 with the IWF acting as the MCPTT server, the IWF performing the controlling role shall follow the procedures in clause 6.6.3.1.11. + +### 11.1.3.4 Receiving a SIP re-INVITE for cancellation of emergency private call + +In the procedures in this clause: + +- 1) emergency indication in an incoming SIP INVITE request refers to the element of the application/vnd.3gpp.mcptt-info+xml MIME body; and +- 2) alert indication in an incoming SIP INVITE request refers to the element of the application/vnd.3gpp.mcptt-info+xml MIME body. + +Upon receiving a SIP re-INVITE request with an emergency indication set to a value of "false", the IWF performing the controlling role: + +- 1) shall validate that the received SDP offer includes at least one media stream for which the media parameters and at least one codec or media format is acceptable by the IWF performing the controlling role and if not, reject the request with a SIP 488 (Not Acceptable Here) response and skip the rest of the steps; +- 2) shall validate the request as described in 3GPP TS 24.379 [29], clause 6.3.3.1.17 with the IWF acting as the controlling function; +- 3) if the SIP re-INVITE request contains an unauthorised request for an MCPTT emergency private call cancellation as determined by local policy: + - a) shall reject the SIP re-INVITE request with a SIP 403 (Forbidden) response; + - b) shall include in the SIP 403 (Forbidden) response an application/vnd.3gpp.mcptt-info+xml MIME body as specified in 3GPP TS 24.379 [29], clause F.1 with an element set to a value of "true"; + - c) if the SIP re-INVITE request contains an alert indication set to "false" and this is an unauthorised request for an MCPTT emergency alert cancellation as determined by local policy, shall include in the SIP 403 (Forbidden) response an application/vnd.3gpp.mcptt-info+xml MIME body with an element set to "true"; and + - d) shall send the SIP 403 (Forbidden) response as specified in 3GPP TS 24.229 [3] and skip the rest of the steps; + +- 4) if the SIP re-INVITE request contains an authorised request for an MCPTT emergency private call cancellation as determined by clause 6.6.3.1.8.4: + - a) shall clear the cache of the MCPTT ID of the originator of the MCPTT emergency private call that is no longer in an in-progress emergency private call state with the targeted user; and + - b) if the SIP re-INVITE request contains an alert indication set to "false" and this is an authorised request for an MCPTT emergency alert cancellation meeting the conditions specified in clause 6.6.3.1.8.3: + - i) if the received SIP re-INVITE request contains an element in the application/vnd.3gpp.mcptt-info+xml MIME body, shall clear the cache of the MCPTT ID of user identified by the element as having an outstanding MCPTT emergency alert; and + - ii) if the received SIP re-INVITE request does not contain an element in the application/vnd.3gpp.mcptt-info+xml MIME body, clear the cache of the MCPTT ID of the sender of the SIP re-INVITE request as having an outstanding MCPTT emergency alert; and +- 5) shall perform the steps in clause 11.1.2.3 but shall not forward the SIP 200 (OK) response. + +If the SIP response has not yet been sent towards the inviting MCPTT client, the IWF performing the controlling role: + +- 1) shall modify the SIP 200 (OK) response to the SIP re-INVITE request as specified in 3GPP TS 24.379 [29], clause 6.3.3.2.3.2 with the IWF acting as the controlling function before continuing with the rest of the steps; +- 2) if the received SIP re-INVITE request contains an alert indication set to a value of "false" and this is an unauthorised request for an MCPTT emergency alert cancellation as specified in clause 6.6.3.1.8.3, shall include in the SIP 200 (OK) response the warning text set to "149 SIP INFO request pending" in a Warning header field as specified in 3GPP TS 24.379 [29], clause 4.4 with the IWF acting as the MCPTT server. + +NOTE: When a SIP 200 (OK) response sent towards the originator as a response to a SIP INVITE request that contained authorised request(s) for an MCPTT emergency private call cancellation and optionally an MCPTT emergency alert cancellation, the originator will consider a SIP 200 (OK) response populated in this manner as confirmation that its request(s) for cancellation of an MCPTT emergency private call and optionally an MCPTT emergency alert were accepted by the IWF performing the controlling role. + +- 3) shall interact with the media plane as specified in 3GPP TS 29.380 [31]; and +- 4) shall send the SIP 200 (OK) response towards the inviting MCPTT client according to 3GPP TS 24.229 [3]. + +Upon receiving a SIP ACK to the SIP 200 (OK) response sent towards the inviting MCPTT client, and the SIP 200 (OK) response was sent with the warning text set to "149 SIP INFO request pending" in a Warning header field as specified in 3GPP TS 24.379 [29], clause 4.4 with the IWF acting as the MCPTT server, with the IWF acting as the controlling function shall follow the procedures in clause 6.6.3.1.11. + +### 11.1.3.5 Sending a SIP re-INVITE for upgrade to emergency private call + +This clause describes the procedures for sending a re-INVITE request to an MCPTT user in an MCPTT private call for the purpose of upgrading the session to an emergency private call session. The procedure is initiated by the IWF performing the controlling role. + +The IWF performing the controlling role: + +- 1) shall generate a SIP re-INVITE request as specified in 3GPP TS 24.379 [29], clause 6.3.3.1.9, with the IWF acting as the controlling function; +- 2) if the originating user homed in the IWF is not in an in-progress emergency private call state with the targeted MCPTT user: + - a) shall cache the information that the user homed in the IWF is in an in-progress emergency private call state with the targeted MCPTT user; and + - b) if this is a request for an MCPTT emergency alert, shall cache the information that the user homed in the IWF has sent an MCPTT emergency alert to the targeted user; +- 3) shall include an application/vnd.3gpp.mcptt-info+xml MIME body populated as specified in clause 6.4.2.1; + +- 4) if an implicit floor request is required, shall indicate this as specified in clause 6.7 and may include an application/vnd.3gpp.mcptt-location-info+xml MIME body with a element included in the root element; +- 5) shall set the element in an application/vnd.3gpp.mcptt-info+xml MIME body of the SIP re-INVITE request to the MCPTT ID of the calling user homed in the IWF; + +NOTE 1: How the IWF determines the MCPTT ID of a user homed in the IWF is out of scope of the present document. + +- 6) shall include in the SIP re-INVITE request an SDP containing the current media parameters used by the existing session; +- 7) if this is a request for an MCPTT emergency alert: + - a) shall determine the value of the user's Mission Critical Organization identity; and. + +NOTE 2: How the IWF determines the user's Mission Critical Organization identity is out of scope of the present document; + +- b) shall include in the element containing the element containing an element set to the value of the user's Mission Critical Organization identity; +- 8) shall include a Resource-Priority header field populated with the values for an MCPTT emergency private call as specified in clause 6.6.3.1.12; and +- 9) shall send the SIP re-INVITE request towards the core network according to 3GPP TS 24.229 [3]. + +Upon receiving SIP 200 (OK) response for the SIP re-INVITE request the IWF performing the controlling role: + +- 1) shall cache the contact received in the Contact header field; +- 2) shall interact with the user plane as specified in 3GPP TS 29.380 [31]; and +- 3) shall perform the actions specified in 3GPP TS 24.379 [29], clause 6.2.8.3.4 with the IWF acting as the MCPTT client. + +### 11.1.3.6 Sending a SIP re-INVITE for cancellation of emergency private call + +This clause describes the procedures for sending a re-INVITE request to an MCPTT user in an MCPTT emergency private call for the purpose of downgrading the session to a normal priority private call session. The procedure is initiated by the IWF performing the controlling role. + +The IWF performing the controlling role: + +- 1) shall generate a SIP re-INVITE request as specified 3GPP TS 24.379 [29], clause 6.3.3.1.9, with the IWF acting as the controlling function; +- 2) shall clear the cache of the MCPTT ID of the originator of the MCPTT emergency private call that is no longer in an in-progress emergency private call state with the targeted user; +- 3) if this is a request for an MCPTT emergency alert cancellation, shall clear the cache of the MCPTT ID of user homed in the IWF as having an outstanding MCPTT emergency alert; +- 4) shall include an application/vnd.3gpp.mcptt-info+xml MIME body populated as specified in clause 6.4.2.3; +- 5) if an implicit floor request is required, shall indicate this as specified in clause 6.7; +- 6) shall set the element in an application/vnd.3gpp.mcptt-info+xml MIME body of the SIP re-INVITE request to the MCPTT ID of the calling user homed in the IWF; + +NOTE: How the IWF determines the MCPTT ID of a user homed in the IWF is out of scope of the present document. + +- 7) shall include in the SIP re-INVITE request an SDP containing the current media parameters used by the existing session; + +- 8) shall include a Resource-Priority header field populated with the values for a normal MCPTT private call as specified in clause 6.6.3.1.12; and +- 9) shall send the SIP re-INVITE request towards the core network according to 3GPP TS 24.229 [3]. + +Upon receiving SIP 200 (OK) response for the SIP re-INVITE request the IWF performing the controlling role: + +- 1) shall cache the contact received in the Contact header field; +- 2) shall set the MCPTT emergency private priority state of the MCPTT private call to "MEPP 1: no-emergency"; +- 3) shall set the MCPTT emergency private call state of the call to "MEPC 1: emergency-pc-capable"; and +- 4) shall interact with the user plane as specified in 3GPP TS 29.380 [31]. + +## 11.2 Private call without floor control + +### 11.2.1 Participating role procedures + +#### 11.2.1.1 Originating procedures + +To request a private call without floor control, the IWF performing the participating role shall follow the procedures as specified in clause 11.1.2.1.1 for an on-demand session but with an SDP offer not including media-level clause for media-floor control entity. + +#### 11.2.1.2 Terminating procedures + +Upon receipt of a "SIP INVITE request for terminating participating MCPTT function" for the private call with SDP offer not including media-level clause for media-floor control entity, the IWF performing the participating role consider it as the request for the private call without floor control and shall follow the procedures as specified in clause 11.1.2.2. + +### 11.2.2 Controlling role procedures + +#### 11.2.2.1 Originating procedures + +The IWF performing the controlling role shall follow the procedures as specified in clause 11.1.3.1. + +## 11.3 Ending the private call initiated by a client + +### 11.3.1 IWF performing the participating role procedures + +#### 11.3.1.1 Terminating procedures + +##### 11.3.1.1.1 Receipt of SIP BYE request for private call on-demand + +Upon receiving a SIP BYE request from the controlling MCPTT function, the IWF performing the participating role shall follow the procedures as specified in clause 6.6.2.2.2.1. + +## 11.4 Ending the private call initiated by the MCPTT server + +### 11.4.1 Client derived procedures + +#### 11.4.1.1 Receiving a SIP BYE request for private call session + +Upon receiving a SIP BYE request for private call session, the IWF shall follow the procedures as specified in clause 6.3. + +### 11.4.2 IWF participating role procedures + +#### 11.4.2.1 Terminating procedures + +##### 11.4.2.1.1 Receipt of SIP BYE request for private call on-demand + +Upon receiving a SIP BYE request from the controlling MCPTT function, the IWF performing the participating role shall follow the procedures as specified in clause 6.6.2.2.2.1. + +### 11.4.3 IWF controlling role procedures + +When the MCPTT session for private call needs to be released as specified in clause 6.6.7.2 with the IWF acting as the controlling MCPTT function, the IWF performing the controlling role shall follow the procedures in clause 6.6.3.1.2. + +--- + +## 12 Emergency alert + +### 12.1 IWF performing the participating role procedures + +#### 12.1.1 IWF to send SIP MESSAGE request for emergency notification + +When the IWF performing originating participating role needs to send a SIP MESSAGE request for emergency notification, the IWF: + +- 1) void; +- 2) if the MCPTT ID for which the SIP MESSAGE is sent is not affiliated with the MCPTT group as determined by clause 9.2.1.2.8, shall perform the actions specified in clause 9.2.1.2.9 for implicit affiliation; +- 3) if the actions for implicit affiliation specified in step 2) above were performed but not successful, shall skip the rest of the steps. +- 4) shall determine the public service identity of the controlling MCPTT function associated with the group identity in the received request for emergency notification; +- 5) shall generate a SIP MESSAGE request in accordance with 3GPP TS 24.229 [3] and IETF RFC 3428 [18]; +- 6) shall set the Request-URI of the outgoing SIP MESSAGE request to the public service identity of the controlling MCPTT function associated with the MCPTT group; +- 7) shall include an application/vnd.3gpp.mcptt-info+xml MIME body as specified in 3GPP TS 24.379 [29], clause F.1 included in the outgoing SIP MESSAGE request based on information received from signalling received from the originating LMR user and its network entities; +- 8) shall set the element of the element containing the element to the MCPTT ID of the user homed in the IWF; + +- 9) if location information is available in the received request for emergency notification, include an application/vnd.3gpp.mcptt-location-info+xml MIME body as specified in 3GPP TS 24.379 [29], clause F.3 in the outgoing SIP MESSAGE request; +- 10) shall set the P-Asserted-Identity in the outgoing SIP MESSAGE request to the public service identity of the IWF; and +- 11) shall send the SIP MESSAGE request as specified to 3GPP TS 24.229 [3]. + +Upon receipt of a SIP 2xx response to the SIP MESSAGE request: + +- 1) if the procedures of clause 9.2.1.2.9 for implicit affiliation were performed in the present clause, shall complete the implicit affiliation by performing the procedures of clause 9.2.1.2.10. + +Upon receipt of a SIP 4xx, 5xx or 6xx response to the sent SIP MESSAGE request and if the implicit affiliation procedures of clause 9.2.1.2.9 were invoked in the present clause, the IWF shall perform the procedures of clause 9.2.1.2.11. + +## 12.1.2 Receipt of a SIP MESSAGE request for emergency notification for terminating LMR user + +In the procedures in this clause: + +- 1) emergency indication in an incoming SIP MESSAGE request refers to the element of the application/vnd.3gpp.mcptt-info+xml MIME body; and +- 2) alert indication in an incoming SIP MESSAGE request refers to the element of the application/vnd.3gpp.mcptt-info+xml MIME body. + +Upon receipt of a "SIP MESSAGE request for emergency notification for terminating participating MCPTT function", the IWF performing the participating role: + +- 1) if unable to process the request due to a lack of resources or a risk of congestion exists, may reject the SIP MESSAGE request with a SIP 500 (Server Internal Error) response. The IWF performing the participating role may include a Retry-After header field to the SIP 500 (Server Internal Error) response as specified in IETF RFC 3261 [14] and skip the rest of the steps; + +NOTE 1: if the SIP MESSAGE request contains an emergency indication set to a value of "true" or an alert indication set to a value of "true", the IWF can by means beyond the scope of this specification choose to accept the request. + +- 2) shall use the MCPTT ID present in the element of the application/vnd.3gpp.mcptt-info+xml MIME body of the incoming SIP MESSAGE request to determine the terminating target; and +- 3) if the terminating target is not served by the IWF the IWF shall reject the SIP MESSAGE request with a SIP 404 (Not Found) response. + +NOTE 2: LMR specific signalling is outside the scope of this specification. + +The IWF shall generate a SIP 2xx response and follow the procedures specified in 3GPP TS 24.229 [3]. + +## 12.1.3 Receipt of a SIP MESSAGE request indicating successful delivery of emergency notification + +Upon receipt of an indication for successful delivery of an emergency notification, internal actions performed by the IWF performing the terminating participating role are out of scope of the present document. + +## 12.2 IWF controlling role procedures + +### 12.2.1 Handling of a SIP MESSAGE request for emergency notification + +Upon receipt of a "SIP MESSAGE request for emergency notification for controlling MCPTT function", the IWF performing the controlling role: + +- 1) if unable to process the request due to a lack of resources or a risk of congestion exists, may reject the SIP MESSAGE request with a SIP 500 (Server Internal Error) response. The controlling MCPTT function may include a Retry-After header field to the SIP 500 (Server Internal Error) response as specified in IETF RFC 3261 [14]. Otherwise, continue with the rest of the steps; + +NOTE: If the SIP MESSAGE request contains an alert indication set to a value of "true", the controlling MCPTT function can, according to local policy, choose to accept the request. + +- 2) shall reject the SIP request with a SIP 403 (Forbidden) response and not process the remaining steps if an Accept-Contact header field does not include the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcptt"; +- 3) if the received SIP MESSAGE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "false", shall perform the procedures specified in clause 12.2.2 and skip the rest of the steps; +- 4) if the received SIP MESSAGE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "true": + - a) if the received SIP MESSAGE request is an unauthorised request for an MCPTT emergency alert as specified in clause 6.6.3.1.8.1 shall reject the SIP MESSAGE request with a SIP 403 (Forbidden) response to the SIP MESSAGE request as specified in 3GPP TS 24.229 [3] with the following clarifications: + - i) shall include in the SIP 403 (Forbidden) response an application/vnd.3gpp.mcptt-info+xml MIME body as specified in 3GPP TS 24.379 [29], clause F.1 of 3GPP TS 24.379 [29] with the element containing the element with the element set to a value of "false"; and + - ii) shall send the SIP 403 (Forbidden) response as specified in 3GPP TS 24.229 [3] and skip the rest of the steps; and + - b) if the received SIP MESSAGE request is an authorised request for an MCPTT emergency alert as specified in clause 6.6.3.1.8.1: + - i) if the sending MCPTT user identified by the element included in the application/vnd.3gpp.mcptt-info+xml MIME body is not affiliated with the MCPTT group identified by the element of the MIME body as determined by the procedures of 3GPP TS 24.379 [29], clause 6.3.6, with the IWF acting as the MCPTT server: + - I) shall check if the MCPTT user is eligible to be implicitly affiliated with the MCPTT group as determined by clause 9.2.1.3.6; + - II) if the MCPTT user is determined not to be eligible to be implicitly affiliated to the MCPTT group shall reject the SIP MESSAGE request with a SIP 403 (Forbidden) response with the warning text set to "120 user is not affiliated to this group" in a Warning header field as specified in clause 4.4 and skip the rest of the steps below; or + - III) if the procedures of clause 9.2.1.3.6 determined the MCPTT user to be eligible to be implicitly affiliated to the MCPTT group shall, perform the implicit affiliation as specified in clause 9.2.1.3.7; + - ii) for each of the other affiliated members of the group: + - A) generate an outgoing SIP MESSAGE request notification of the MCPTT user's emergency alert indication as specified in 3GPP TS 24.379 [29], clause 6.3.3.1.11, with the IWF acting as the controlling MCPTT function, with the clarifications of clause 6.6.3.1.7; + +- B) shall include in the application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with the element set to the value of the element in the received SIP MESSAGE request; and + - C) send the SIP MESSAGE request according to according to rules and procedures of 3GPP TS 24.229 [3]; +- iii) shall generate a SIP 200 (OK) response to the received SIP MESSAGE request as specified in 3GPP TS 24.229 [3] with the following clarifications: + - A) shall cache the information that the MCPTT user has initiated an MCPTT emergency alert; + - iv) shall send the SIP 200 (OK) response to the received SIP MESSAGE according to rules and procedures of 3GPP TS 24.229 [3]. + - v) shall generate a SIP MESSAGE request as described in 3GPP TS 24.379 [29], clause 6.3.3.1.20, with the IWF acting as the controlling MCPTT function, to indicate successful receipt of an emergency alert, and shall include in the application/vnd.3gpp.mcptt-info+xml MIME body: + - A) the element set to a value of "true"; + - B) the element set to a value of true; and + - C) the element with the MCPTT client ID that was included in the incoming SIP MESSAGE request; and + - vi) shall send the SIP MESSAGE request according to according to rules and procedures of 3GPP TS 24.229 [3]. + +Upon receipt of SIP 2xx responses to the outgoing SIP MESSAGE requests, the controlling MCPTT function shall follow the procedures specified in 3GPP TS 24.229 [3]. + +If the IWF performing the controlling role needs to generate a SIP MESSAGE request for emergency notification, the IWF performing the controlling role: + +- 1) for each of the affiliated MCPTT group members: + - a) shall generate an outgoing SIP MESSAGE request notification of the MCPTT user's emergency alert indication as specified in 3GPP TS 24.379 [29], clause 6.3.3.1.11 with the IWF acting as the controlling MCPTT function, with the clarifications of clause 6.6.3.1.7; + - b) shall include in the application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with the element; and + - c) shall send the SIP MESSAGE request according to according to rules and procedures of 3GPP TS 24.229 [3]; + +## 12.2.2 Handling of a SIP MESSAGE request for emergency alert cancellation + +Upon receipt of a "SIP MESSAGE request for emergency notification for controlling MCPTT function" containing an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "false", the IWF performing the controlling role: + +- 1) if the received SIP MESSAGE request is an unauthorised request for an MCPTT emergency alert cancellation as specified in clause 6.6.3.1.8.1: + - a) and if the received SIP MESSAGE request does not contain an element or is an unauthorised request for an MCPTT emergency call cancellation as specified in clause 6.6.3.1.8.4, shall reject the SIP MESSAGE request with a SIP 403 (Forbidden) response to the SIP MESSAGE request as specified in 3GPP TS 24.229 [3] with the following clarifications: + - i) shall include in the SIP 403 (Forbidden) response an application/vnd.3gpp.mcptt-info+xml MIME body as specified in 3GPP TS 24.379 [29] clause F.1 with the element containing the element with the element set to a value of "true"; + +- ii) if the received SIP MESSAGE request contains an element of the element set to a value of "false" and if the in-progress emergency state of the group is set to a value of "true" and this is an unauthorised request for an MCPTT emergency call cancellation as determined in step i) above, shall include an element set to a value of "true" in the application/vnd.3gpp.mcptt-info+xml MIME body in the SIP 403 (Forbidden) response; and + - iii) shall send the SIP 403 (Forbidden) response according to rules and procedures of 3GPP TS 24.229 [3] and skip the rest of the steps; and +- b) and if the received SIP MESSAGE request contains an element and is an authorised request for an MCPTT emergency call cancellation as specified in 3GPP TS 24.379 [29] clause 6.6.3.1.8.4 and the in-progress emergency state of the MCPTT group is set to a value of "true": + - i) shall set the in-progress emergency state of the group to a value of "false"; + - ii) shall clear the cache of the MCPTT ID of the MCPTT user that triggered the setting of the in-progress emergency state of the MCPTT group to "true"; + - iii) shall generate SIP re-INVITE request to the other affiliated and joined members of the MCPTT group as specified in clause 6.6.3.1.3. The IWF performing the controlling role: + - A) for each affiliated and joined member shall send the SIP re-INVITE request towards the MCPTT client as specified in 3GPP TS 24.229 [3]; and + - B) upon receiving a SIP 200 (OK) response to the SIP re-INVITE request shall interact with the media plane as specified in 3GPP TS 29.380 [31]; + - iv) for each of the affiliated but not joined members of the group: + - A) generate a SIP MESSAGE request notification of the cancellation of the MCPTT user's emergency call as specified in 3GPP TS 24.379 [29], clause 6.3.3.1.11 with the IWF acting as the controlling MCPTT function; + - B) shall include in the application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with the element set to the value of the element in the received SIP MESSAGE request; and + - C) shall include an element set to a value of "false" in the application/vnd.3gpp.mcptt-info+xml MIME body in the outgoing SIP MESSAGE request; + - v) shall generate a SIP 200 (OK) response to the received SIP MESSAGE request as specified in 3GPP TS 24.229 [3]; + - vi) shall send the SIP 200 (OK) response to the received SIP MESSAGE as specified in 3GPP TS 24.229 [3] and skip the rest of the steps; + - vii) shall generate a SIP MESSAGE request as described in 3GPP TS 24.379 [29], clause 6.3.3.1.20 with the IWF acting as the controlling MCPTT function to indicate successful receipt of the request for emergency alert cancellation + - viii) shall include in the application/vnd.3gpp.mcptt-info+xml MIME body of the SIP MESSAGE request: + - A) the <>alert-ind> element set to a value of "true"; + - B) the <>alert-ind-rcvd> element set to a value of true; + - C) the element set to a value of "false"; and + - D) the element with the MCPTT client ID that was included in the incoming SIP MESSAGE request; and + - ix) shall send the SIP MESSAGE request according to rules and procedures of 3GPP TS 24.229 [3]; and +- 2) if the received SIP MESSAGE request is an authorised request for an MCPTT emergency alert cancellation as specified in clause 6.6.3.1.8.1: + +- a) if the received SIP MESSAGE request contains an element in the application/vnd.3gpp.mcptt-info+xml MIME body, shall clear the cache of the MCPTT ID of the MCPTT user identified by the element as having an outstanding MCPTT emergency alert; +- b) if the received SIP MESSAGE request does not contain an element in the application/vnd.3gpp.mcptt-info+xml MIME body, clear the cache of the MCPTT ID of the sender of the SIP MESSAGE request as having an outstanding MCPTT emergency alert; +- c) if the received SIP MESSAGE request does not contain an element or is an unauthorised request for an MCPTT emergency call cancellation as specified in clause 6.6.3.1.8.4, for each of the affiliated but not joined members of the group: + - i) shall generate a SIP MESSAGE request notification of the cancellation of the MCPTT user's emergency alert as specified in 3GPP TS 24.379 [29], clause 6.3.3.1.11 with the IWF acting as the controlling MCPTT function; + - ii) shall include in the application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with the element set to the value of the element in the received SIP MESSAGE request; + - iii) if the received SIP MESSAGE request contains an element in the application/vnd.3gpp.mcptt-info+xml MIME body, shall copy the contents of the received element to an element in the application/vnd.3gpp.mcptt-info+xml MIME body in the outgoing SIP MESSAGE request; + - iv) shall include an <>alert-ind> element set to a value of "false" in the application/vnd.3gpp.mcptt-info+xml MIME body in the outgoing SIP MESSAGE request; and + - v) send the SIP MESSAGE request as specified in 3GPP TS 24.229 [3]; +- d) if the received SIP MESSAGE request contains an element and is an authorised request for an MCPTT emergency call cancellation as specified in clause 6.6.3.1.8.4 and the in-progress emergency state of the MCPTT group is set to a value of "true": + - i) shall set the in-progress emergency state of the group to a value of "false"; + - ii) cache the information that the MCPTT user has cancelled the outstanding in-progress emergency state of the group; + - iii) shall generate SIP re-INVITES requests to the other affiliated and joined members of the MCPTT group as specified in clause 6.6.3.1.3. The MCPTT controlling function: + - A) for each affiliated and joined member shall send the SIP re-INVITE request towards the MCPTT client as specified in 3GPP TS 24.229 [3]; and + - B) Upon receiving a SIP 200 (OK) response to the SIP re-INVITE request shall interact with the media plane as specified in 3GPP TS 29.380 [31]; and + - iv) for each of the affiliated but not joined members of the group shall: + - A) generate a SIP MESSAGE request notification of the cancellation of the MCPTT user's emergency call as specified in 3GPP TS 24.379 [29], clause 6.3.3.1.11 with the IWF acting as the controlling MCPTT function; + - B) include in the application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with the element set to the value of the element in the received SIP MESSAGE request; + - C) if the received SIP MESSAGE request contains an element in the application/vnd.3gpp.mcptt-info+xml MIME body, copy the contents of the received element to an element in the application/vnd.3gpp.mcptt-info+xml MIME body in the outgoing SIP MESSAGE request; + - D) include in the application/vnd.3gpp.mcptt-info+xml MIME body an <>alert-ind> element set to a value of "false"; and + +- E) shall include an element set to a value of "false" in the application/vnd.3gpp.mcptt-info+xml MIME body in the outgoing SIP MESSAGE request; +- e) shall generate a SIP 200 (OK) response to the received SIP MESSAGE request as specified in 3GPP TS 24.229 [3]; +- f) shall send the SIP 200 (OK) response to the received SIP MESSAGE as specified in 3GPP TS 24.229 [3]. +- g) shall generate a SIP MESSAGE request as described in 3GPP TS 24.379 [29], clause 6.3.3.1.20 with the IWF acting as the controlling MCPTT function to indicate successful receipt of the request for emergency alert cancellation; +- h) shall include in the application/vnd.3gpp.mcptt-info+xml MIME body, the element set to a value of "false" and the set to "true"; +- i) shall populate the element with the MCPTT client ID that was included in the incoming SIP MESSAGE request; +- j) if the received SIP MESSAGE request contains an element of the element set to a value of "false": + - i) if this is an authorised request for an MCPTT emergency call cancellation as specified in clause 6.6.3.1.8.4, shall include an element set to a value of "false" in the application/vnd.3gpp.mcptt-info+xml MIME body in the outgoing SIP MESSAGE request; and +- B) otherwise, if this is an unauthorised request for an MCPTT emergency call cancellation as specified in clause 6.6.3.1.8.4, and the in-progress emergency state of the group is set to a value of "true", shall include an element set to a value of "true" in the application/vnd.3gpp.mcptt-info+xml MIME body in the outgoing SIP MESSAGE request; and +- k) shall send the SIP MESSAGE request according to the rules and procedures of 3GPP TS 24.229 [3]. + +Upon receipt of SIP 2xx responses to the outgoing SIP MESSAGE requests, the IWF performing the controlling role shall follow the procedures specified in 3GPP TS 24.229 [3]. + +If the IWF performing the controlling role needs to generate a SIP MESSAGE for emergency alert cancellation, the IWF performing the controlling role: + +- 1) if the in-progress emergency state of the MCPTT group is set to a value of "false", for each of the affiliated but not joined MCPTT members of the group: + - a) shall generate a SIP MESSAGE request notification of the cancellation of the MCPTT user's emergency alert as specified in 3GPP TS 24.379 [29], clause 6.3.3.1.11 with the IWF acting as the controlling MCPTT function; + - b) shall include an element in the application/vnd.3gpp.mcptt-info+xml MIME body in the outgoing SIP MESSAGE request set to the MCPTT ID of the user homed in the IWF; + - c) shall include an element set to a value of "false" in the application/vnd.3gpp.mcptt-info+xml MIME body in the outgoing SIP MESSAGE request; and + - d) shall send the SIP MESSAGE request as specified in 3GPP TS 24.229 [3]; +- 2) if the in-progress emergency state of the MCPTT group is set to a value of "true": + - a) shall set the in-progress emergency state of the group to a value of "false"; + - b) cache the information that the outstanding in-progress emergency state of the group has been cancelled; + - c) shall generate SIP re-INVITE requests to the other affiliated and joined MCPTT members of the MCPTT group as specified in clause 6.6.3.1.3. The IWF performing the controlling function: + - i) for each affiliated and joined MCPTT member shall send the SIP re-INVITE request towards the MCPTT client as specified in 3GPP TS 24.229 [3]; and + +- ii) Upon receiving a SIP 200 (OK) response to the SIP re-INVITE request shall interact with the media plane as specified in 3GPP TS 29.380 [31]; and +- d) for each of the affiliated but not joined MCPTT members of the group shall: + - i) generate a SIP MESSAGE request notification of the cancellation of the MCPTT user's emergency call as specified in 3GPP TS 24.379 [29], clause 6.3.3.1.11 with the IWF acting as the controlling MCPTT function; + - ii) include in the application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with the element set to MCPTT ID of the user home in the IWF; + - iii) include in the application/vnd.3gpp.mcptt-info+xml MIME body an element set to a value of "false"; and + - iv) shall include an element set to a value of "false" in the application/vnd.3gpp.mcptt-info+xml MIME body in the outgoing SIP MESSAGE request; and +- 3) shall send the SIP MESSAGE requests according to the rules and procedures of 3GPP TS 24.229 [3]. + +Upon receipt of SIP 2xx responses to the outgoing SIP MESSAGE requests, the IWF performing the controlling role shall follow the procedures specified in 3GPP TS 24.229 [3]. + +--- + +## 13 Location procedures + +### 13.1 General + +It is outside the scope of this specification how the IWF performing the participating role configures a participant homed in the IWF to provide location information or how the IWF performing the participating role explicitly request a participant homed in the IWF to provide location information. + +### 13.2 IWF participating role location procedures + +#### 13.2.1 General + +The IWF performing participating role provides procedures to send a location information report from a participant homed in the IWF. + +#### 13.2.2 Location reporting configuration + +Procedures for configuration of location reporting of participants homed in the IWF are out of scope of the current document. + +#### 13.2.3 Location reporting request + +Procedures for requesting participants homed in the IWF to report location information are out of scope of the current document. + +#### 13.2.4 Location information report + +The IWF performing the participating role uses location information of users homed in the IWF as appropriate. + +## 14 Handling of Interworking Security Data messages + +### 14.1 IWF + +#### 14.1.1 IWF originates Interworking Security Data message + +Upon deciding to send an Interworking Security Data message, the IWF: + +- 1) shall generate a SIP MESSAGE request in accordance with 3GPP TS 24.229 [3] and IETF RFC 3428 [18]; +- 2) shall include an Accept-Contact header field containing the g.3gpp.mcptt media feature tag along with the "require" and "explicit" header field parameters according to IETF RFC 3841 [5]; +- 3) the IWF shall include an Accept-Contact header field with the media feature tag g.3gpp.icsi-ref with the value of "urn:urn-7:3gpp-service.ims.icsi.mcptt" along with parameters "require" and "explicit" according to IETF RFC 3841 [5]; +- 4) shall include an application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with the element set to the value of the MCPTT ID of the targeted MCPTT user; and +- 5) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcptt" (coded as specified in 3GPP TS 24.229 [3]), in a P-Asserted-Service-Id header field according to IETF RFC 6050 [7]; +- 6) shall set the Request-URI to the address of the terminating participating function associated with the MC service ID of the targeted MC service user; +- 7) shall include a P-Asserted-Identity header field set to the public service identity of the IWF; +- 8) shall include an application/vnd.3gpp.interworking-data MIME body with the Interworking Security Data message payload as defined in clause 14.2.1; +- 9) if a security context between the MCPTT client and the IWF needs to be established and the security context does not exist or if the existing security context has expired, procedures in clause 11.2.2 in 3GPP TS 33.180 [29] shall be followed; and +- 10) send the SIP MESSAGE request according to rules and procedures of 3GPP TS 24.229 [3]. + +#### 14.1.2 IWF receives Interworking Security Data message + +Upon receiving a "SIP MESSAGE request for Interworking Security Data message for participating function", the actions performed by the IWF are out of scope of the present document. The received message, described in clause 14.2, contains an opaque payload, the contents of which are out of scope of the present document. + +## 14.2 Interworking Security Data message payload + +### 14.2.1 Message definition + +This clause specifies the payload to be used when sending an Interworking Security Data message between the IWF and MCPTT clients. The Interworking Security Data (InterSD) message is defined as a MONP message. + +Message type: InterSD-MESSAGE + +Direction: IWF to MCPTT client, MCPTT client to IWF + +**Table 14.2.1-1: Interworking Security Data message content** + +| IEI | Information Element | Type/Reference | Presence | Format | Length | +|-----|---------------------------------------------|-------------------------------------------------------------------------------------|----------|--------|--------| +| | SDS signalling payload message identity | Message type
3GPP TS 24.282 [30] | M | V | 1 | +| | External network type | 14.2.2 | M | V | 1 | +| 7D | URI of LMR key management functional entity | URI encoded as specified in
IETF RFC 3986 [32] | O | TLV-E | 3-x | +| 78 | Payload | 3GPP TS 24.282 [30], clause 15.2.13
with Payload content type set to
'BINARY' | O | TLV-E | 3-x | + +## 14.2.2 External network type + +The purpose of the external network type information element is to identify the type of the network represented by the IWF. + +The value part of the external network type information element is coded as shown in Table 14.2.2-1. + +The external network type information element is a type 3 information element with a length of 1 octet. + +**Table 14.2.2-1: External network type** + +| | | | | | | | | | +|--------------------------------|---|---|---|---|---|---|---|-------| +| Bits | | | | | | | | | +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +| 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | P25 | +| 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | TETRA | +| All other values are reserved. | | | | | | | | | + +## Annex A (normative): XML Schema + +### A.1 General + +The XML schema elements defined in the present clause extend those in 3GPP TS 24.379 [29] or other 3GPP technical specifications as noted. + +### A.2 mcpttinfo + +#### A.2.1 XML schema + +The XML schema elements for private call parameters in the present clause extend the mcpttinfo schema in 3GPP TS 24.379 [29]. + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +**Editor's Note:** Need to register and add a namespace to the schema that's specific to interworking. + +#### A.2.2 Semantic + +The `` element may be included in the `` element of the `` element, when responding to a SIP INVITE for a private call, with the following elements: + +- 1) an element indicating support for the type of floor control: + - a) if the client supports private calls with floor control and the offer is for floor control, shall include a `` element; + +- b) if the client supports private calls without floor control and the offer is for no floor control, shall include a element; +- 2) an element indicating support for type of first talker: + - a) if the client supports not talking first and the offer is for the caller to talk first, shall include an element; or + - b) if the client supports talking first and the offer is for the receiver to talk first, shall include a element; and +- 3) an element indicating support for type of commencement mode: + - a) if the client supports private calls with automatic commencement mode and the offer is for automatic commencement mode, shall include a element; or + - b) if the client supports private calls with manual commencement mode and the offer is for manual commencement mode, shall include a element. + +NOTE: The element is only included in responses only from the IWF, not from the MCPTT system. + +The element can be included with the following element not declared in the XML schema: + +- a of type "xs:string": set to value of "Interworking Security Data message" when a requesting an Interworking Security Data message. + +--- + +## Annex B (normative): IANA registration forms + +### B.1 Media type for transporting interworking data content + +Your Name: + + + +Your Email Address: + + + +Media Type Name: + +Application + +Subtype name: + +vnd.3gpp.interworking-data + +Required parameters: + +None + +Optional parameters: + +None + +Encoding considerations: + +binary. + +Security considerations: + +General mechanisms for privacy and integrity protection of protocol parameters exist. Those mechanisms as well as authentication and further security mechanisms are described in 3GPP TS 24.229. + +Security mechanisms specific to this media type are dependent upon the business and trust relationship between the Interworking function operator, the mission critical services operator and the SIP carrier operator. Mission critical services operators may wish to encrypt and integrity protect the content transported by this media type independently of mechanisms provided by the transport layer. Such mechanisms have been specified by 3GPP SA3. + +The information transported in this media type does not include active or executable content. + +This media type may include provisions for directives that institute actions on a recipient's files or other resources. + +This media type does not include provisions for directives that institute actions that, while not directly harmful to the recipient, may result in disclosure of information that either facilitates a subsequent attack or else violates a recipient's privacy in any way. + +This media type does not employ compression. + +Interoperability considerations: + +The content transported within this media type does not need to be interpreted by a server as specific decisions are made based on the signalling content (e.g. store disposition history). The final destination point of the content is the terminating UE. Each UE and server that handles the content transported using this media type shall understand the definition of the messages and protocol elements as defined in 3GPP TS 29.379. Any messages and protocol elements not defined by 3GPP TS 29.379 shall be ignored by the recipient UE or server. + +Published specification: + +3GPP TS 29.379 "Mission Critical Push To Talk (MCPTT) call control interworking with LMR systems; Protocol specification", available via . + +Application Usage: + +Applications supporting the mission critical interworking with LMR systems procedures as described in the published specification. This media type shall contain LMR specific content that is related to the payload that is delivered to a terminating user or an application of the terminating user. + +Fragment identifier considerations: + +None. + +Restrictions on usage: + +None + +Provisional registration? (standards tree only): + +N/A + +Additional information: + +1. Deprecated alias names for this type: none +2. Magic number(s): none +3. File extension(s): none +4. Macintosh File Type Code(s): none +5. Object Identifier(s) or OID(s): none + +Intended usage: + +Common + +Person to contact for further information: + +- Name: +- Email: +- Author/Change controller: + - i) Author: 3GPP CT1 Working Group/3GPP\_TSG\_CT\_WG1@LIST.ETSI.ORG + - ii) Change controller: / + +## Annex C (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2019-04 | | | | | | Initial version | 0.0.0 | +| 2019-05 | | | | | | Contains agreed P-CRs from CT1#117: C1-193606, C1-193609, C1-193085, C1-193093, C1-193611, C1-193612, C1-193613, C1-193614, C1-193615, C1-193616, C1-193674, C1-193675, C1-193676 | 0.1.0 | +| 2019-06 | CT#84 | CP-191150 | | | | Presentation to TSG CT for information | 1.0.0 | +| 2019-06 | | | | | | Rapporteur's fixes to bad references and editorials. | 1.0.1 | +| 2019-08 | | | | | | Contains agreed P-CRs from CT1#117: C1-194202, C1-194204, C1-194206, C1-194208, C1-194209, C1-194212, C1-194802, C1-194804, C1-195016. | 1.1.0 | +| 2019-10 | | | | | | Contains agreed P-CRs from CT1#120: C1-196207, C1-196870 | 1.2.0 | +| 2019-11 | | | | | | Contains agreed P-CRs from CT1#121: C1-198208, C1-198238, C1-198662, C1-198663, C1-198845 | 1.3.0 | +| 2019-12 | CT#86 | CP-193150 | | | | Presentation to TSG CT for approval | 2.0.0 | +| 2019-12 | CT#86 | CP-193298 | | | | A title corrected | 2.0.1 | +| 2019-12 | CT#86 | | | | | Version 16.0.0 created after approval | 16.0.0 | +| 2020-09 | CT#89e | CP-202161 | 0004 | | F | Correct XML schema | 16.1.0 | +| 2020-09 | CT#89e | CP-202162 | 0007 | 1 | F | Correct MIME Subtype name in Annex B.1 | 16.1.0 | +| 2020-10 | CT#89e | | | | | Correction to table of contents | 16.1.1 | +| 2020-12 | CT#90e | CP-203195 | 0011 | | F | Inter-SD message payload format alignment across domains | 16.2.0 | +| 2020-12 | CT#90e | CP-203195 | 0013 | | F | Remove EN in Annex B.1 | 16.2.0 | +| 2021-09 | CT#93e | CP-212121 | 0018 | - | F | Remove EN on end-to-end security | 16.3.0 | +| 2021-09 | CT#93e | CP-212121 | 0019 | - | F | Remove ENs | 16.3.0 | +| 2022-03 | CT#95e | CP-220230 | 0022 | - | F | Removal of Editor's Notes | 16.4.0 | +| 2022-06 | CT#96 | CP-221201 | 0023 | 2 | F | Removal of ENs | 16.5.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29413/raw.md b/marked/Rel-16/29_series/29413/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..b8d9da876a67e1dfcf8ed4dbf0d2ae0db7a7bc1d --- /dev/null +++ b/marked/Rel-16/29_series/29413/raw.md @@ -0,0 +1,391 @@ + + +# 3GPP TS 29.413 V16.4.0 (2022-06) --- + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Radio Access Network; Application of the NG Application Protocol (NGAP) to non-3GPP access (Release 16)** --- + +## **3GPP** + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTSTM is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# --- Contents + +| | | +|--------------------------------------------------------------------------------------------------------------------|-----------| +| Foreword ..... | 4 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Abbreviations ..... | 5 | +| 4 Principles for the use of NGAP for non-3GPP access ..... | 5 | +| 4.1 General ..... | 5 | +| 5 Non-3GPP access..... | 6 | +| 5.1 Use of the NGAP for non-3GPP access ..... | 6 | +| 5.2 NGAP messages used for non-3GPP access ..... | 7 | +| 5.3 Exceptions for NGAP message contents and information element coding when used for non-3GPP access..... | 8 | +| 5.4 Handling of NGAP messages not specified to be applicable between the Non-3GPP access network node and AMF..... | 12 | +| Annex A (informative): Change history..... | 13 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 1 Scope + +The present document describes the applicability of NG Application Protocol (NGAP) messages and procedures, defined in 3GPP TS 38.413 [2], to non-3GPP access. A general description for non-3GPP access can be found in 3GPP TS 23.501 [3], 3GPP TS 23.502 [4], and 3GPP TS 23.316 [6]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 38.413: "NG-RAN; NG Application Protocol (NGAP)". +- [3] 3GPP TS 23.501: "System Architecture for the 5G System". +- [4] 3GPP TS 23.502: "Procedures for the 5G System". +- [5] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [6] 3GPP TS 23.316: "Wireless and wireline convergence access support for the 5G System (5GS)". +- [7] 3GPP TS 24.502: "Access to the 3GPP 5G Core Network (5GCN) via Non-3GPP Access Networks (N3AN)". + +# --- 3 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|-------|------------------------------------| +| 5G-RG | 5G Residential Gateway | +| FN-RG | Fixed Network Residential Gateway | +| N3IWF | Non-3GPP InterWorking Function | +| TNAP | Trusted Non-3GPP Access Point | +| TNGF | Trusted Non-3GPP Gateway Function | +| TWIF | Trusted WLAN Interworking Function | +| W-AGF | Wireline Access Gateway Function | + +# --- 4 Principles for the use of NGAP for non-3GPP access + +## 4.1 General + +TS 23.501 [3] specifies the NGAP used between the Non-3GPP access network node and the AMF. The Non-3GPP access network node is either a Non-3GPP InterWorking Function (N3IWF), or a Trusted Non-3GPP Gateway Function (TNGF), or a Trusted WLAN Interworking Function (TWIF), or a Wireline Access Gateway Function (W-AGF). + +NGAP is used as specified in TS 38.413 [2] with clarifications or additions as specified in Clause 5. + +# 5 Non-3GPP access + +## 5.1 Use of the NGAP for non-3GPP access + +The following NGAP procedures are used between the Non-3GPP access network node and the AMF: + +- PDU Session Management Procedures + - PDU Session Resource Setup + - PDU Session Resource Release + - PDU Session Resource Modify + - PDU Session Resource Notify +- UE Context Management Procedures + - Initial Context Setup + - UE Context Release Request + - UE Context Release + - UE Context Modification +- Transport of NAS Messages Procedures + - Initial UE Message + - Downlink NAS Transport + - Uplink NAS Transport + - NAS Non Delivery Indication + - Reroute NAS Request +- Interface Management Procedures + - NG Setup + - RAN Configuration Update + - AMF Configuration Update + - NG Reset + - Error Indication + - AMF Status Indication + - Overload Start + - Overload Stop +- UE TNLA Binding Procedures + - UE TNLA Binding Release + +For the NGAP procedures used between the Non-3GPP access network node and the AMF, the Non-3GPP access network node fulfils the behaviour of the NG-RAN node as specified in clause 8 of TS 38.413 [2], with clarifications as specified in Clause 5.3. The text in clause 8 of TS 38.413 [2] referring to Uu should be understood as referring to the Y2 reference point as specified in TS 23.501 [3]. + +## 5.2 NGAP messages used for non-3GPP access + +The list given below shows the NGAP messages, as specified in TS 38.413 [2] subclause 9.2 (tabular format) and 9.4 (ASN.1 notation) that are used between the Non-3GPP access network node and the AMF. + +- PDU SESSION RESOURCE SETUP REQUEST +- PDU SESSION RESOURCE SETUP RESPONSE +- PDU SESSION RESOURCE RELEASE COMMAND +- PDU SESSION RESOURCE RELEASE RESPONSE +- PDU SESSION RESOURCE MODIFY REQUEST +- PDU SESSION RESOURCE MODIFY RESPONSE +- PDU SESSION RESOURCE NOTIFY +- INITIAL CONTEXT SETUP REQUEST +- INITIAL CONTEXT SETUP RESPONSE +- INITIAL CONTEXT SETUP FAILURE +- UE CONTEXT RELEASE REQUEST +- UE CONTEXT RELEASE COMMAND +- UE CONTEXT RELEASE COMPLETE +- UE CONTEXT MODIFICATION REQUEST +- UE CONTEXT MODIFICATION RESPONSE +- UE CONTEXT MODIFICATION FAILURE +- INITIAL UE MESSAGE +- DOWNLINK NAS TRANSPORT +- UPLINK NAS TRANSPORT +- NAS NON DELIVERY INDICATION +- REROUTE NAS REQUEST +- NG SETUP REQUEST +- NG SETUP RESPONSE +- NG SETUP FAILURE +- RAN CONFIGURATION UPDATE +- RAN CONFIGURATION UPDATE ACKNOWLEDGE +- RAN CONFIGURATION UPDATE FAILURE +- AMF CONFIGURATION UPDATE +- AMF CONFIGURATION UPDATE ACKNOWLEDGE +- AMF CONFIGURATION UPDATE FAILURE +- NG RESET +- NG RESET ACKNOWLEDGE + +- ERROR INDICATION +- AMF STATUS INDICATION +- OVERLOAD START +- OVERLOAD STOP +- UE TNLA BINDING RELEASE REQUEST + +## 5.3 Exceptions for NGAP message contents and information element coding when used for non-3GPP access + +For the NGAP messages transferred between the Non-3GPP access network node and the AMF, the following exceptions to the specification in TS 38.413 [2] shall be applied: + +PDU SESSION RESOURCE SETUP REQUEST message: + +- the following IEs shall be ignored, when received: + - *RAN Paging Priority* IE + - *UE Aggregate Maximum Bit Rate* IE (except for non-trusted non-3GPP access, trusted non-3GPP access and trusted WLAN access as specified in TS 23.501 [3]). + - *Notification Control* IE included in the *QoS Flow Level QoS Parameters* IE + - *Alternative QoS Parameters Set List* IE included in the *QoS Flow Level QoS Parameters* IE + +PDU SESSION RESOURCE RELEASE COMMAND message: + +- the following IEs shall be ignored, when received: + - *RAN Paging Priority* IE + +PDU SESSION RESOURCE MODIFY REQUEST message: + +- the following IEs shall be ignored, when received: + - *RAN Paging Priority* IE + - *Notification Control* IE included in the *QoS Flow Level QoS Parameters* IE + - *Alternative QoS Parameters Set List* IE included in the *QoS Flow Level QoS Parameters* IE + +INITIAL CONTEXT SETUP REQUEST message: + +- the following IEs shall be ignored, when received: + - *Core Network Assistance Information for RRC INACTIVE* IE + - *Trace Activation* IE + - *Mobility Restriction List* IE + - *UE Radio Capability* IE + - *Index to RAT/Frequency Selection Priority* IE + - *Emergency Fallback Indicator* IE + - *RRC Inactive Transition Report Request* IE + - *UE Radio Capability for Paging* IE + - *Redirection for Voice EPS Fallback* IE + +- *Location Reporting Request Type IE* +- *CN Assisted RAN Parameters Tuning IE* +- *SRVCC Operation Possible IE* +- *IAB Authorized IE* +- *Enhanced Coverage Restriction IE* +- *Extended Connected Time IE* +- *UE Differentiation Information IE* +- *NR V2X Services Authorized IE* +- *LTE V2X Services Authorized IE* +- *NR UE Sidelink Aggregate Maximum Bit Rate IE* +- *LTE UE Sidelink Aggregate Maximum Bit Rate IE* +- *PC5 QoS Parameters IE* +- *CE-mode-B Restricted IE* +- *UE User Plane CIoT Support Indicator IE* +- *Management Based MDT PLMN List IE* +- *UE Radio Capability ID IE* +- *UE Aggregate Maximum Bit Rate IE* (except for non-trusted non-3GPP access, trusted non-3GPP access and trusted WLAN access as specified in TS 23.501 [3]) +- *UE Security Capabilities IE* +- *RG Level Wireline Access Characteristics IE*: the information given within this IE between the W-AGF and the AMF shall be stored in the UE context by the W-AGF as specified in TS 23.316 [6]. +- *Notification Control IE* included in the *QoS Flow Level QoS Parameters IE* +- *Alternative QoS Parameters Set List IE* included in the *QoS Flow Level QoS Parameters IE* + +UE CONTEXT RELEASE COMPLETE message: + +- the following IEs shall be ignored, when received: + - *Information on Recommended Cells and RAN Nodes for Paging IE* + - *Paging Assistance Data for CE Capable UE IE* + +UE CONTEXT MODIFICATION REQUEST message: + +- the following IEs shall be ignored, when received: + - *RAN Paging Priority IE* + - *Index to RAT/Frequency Selection Priority IE* + - *Core Network Assistance Information IE* + - *Emergency Fallback Indicator IE* + - *RRC Inactive Transition Report Request IE* + - *CN Assisted RAN Parameters Tuning IE* + - *SRVCC Operation Possible IE* + +- *IAB Authorized IE* +- *NR V2X Services Authorized IE* +- *LTE V2X Services Authorized IE* +- *NR UE Sidelink Aggregate Maximum Bit Rate IE* +- *LTE UE Sidelink Aggregate Maximum Bit Rate IE* +- *PC5 QoS Parameters IE* +- *UE Radio Capability ID IE* +- *UE Aggregate Maximum Bit Rate IE* (except for non-trusted non-3GPP access, trusted non-3GPP access and trusted WLAN access as specified in TS 23.501 [3]) +- *UE Security Capabilities IE* +- if this is the first message received from a new AMF, the N3IWF shall identify the old AMF and the UE using the received *RAN UE NGAP ID*, release the UE-associated logical NG-connection to the old AMF and create a new UE-associated logical NG-connection to the new AMF. +- *RG Level Wireline Access Characteristics IE*: the information given within this IE between the W-AGF and the AMF shall be stored in the UE context by the W-AGF as specified in TS 23.316 [6]. + +UE CONTEXT MODIFICATION RESPONSE message: + +- the following IEs shall be ignored, when received: + - *RRC State IE* + +INITIAL UE MESSAGE message: + +- the following IEs shall be ignored, when received: + - *IAB Node Indication IE* + - *CE-mode-B Support Indicator IE* + - *LTE-M Indication IE* + - *EDT Session IE* + - *NPN Access Information IE* +- *RRC Establishment Cause IE*: the information given within this IE is to indicate the Establishment cause for non-3GPP access as specified in TS 24.502 [7]. +- *Selected PLMN Identity IE*: the information given within this IE provides the selected PLMN ID for untrusted non-3GPP access as specified in TS 23.502 [4]. +- *Authenticated Indication IE*: the information given within this IE between the W-AGF and the AMF is to indicate that the FN-RG has been authenticated by the wireline 5G access network as specified in TS 23.316 [6]. +- *Selected PLMN Identity IE*: the information given within this IE contains the PLMN Identity for wireline access as specified in TS 23.316 [6], or for trusted non-3GPP access as specified in TS 23.502 [4]. + +DOWNLINK NAS TRANSPORT message: + +- the following IEs shall be ignored, when received: + - *RAN Paging Priority IE* + - *Mobility Restriction List IE* + - *Index to RAT/Frequency Selection Priority IE* + +- *SRVCC Operation Possible IE* +- *Enhanced Coverage Restriction IE* +- *Extended Connected Time IE* +- *UE Differentiation Information IE* +- *CE-mode-B Restricted IE* +- *UE Radio Capability IE* +- *UE Capability Info Request IE* +- *End Indication IE* +- *UE Radio Capability ID IE* +- *UE Aggregate Maximum Bit Rate IE* (except for non-trusted non-3GPP access, trusted non-3GPP access and trusted WLAN access as specified in TS 23.501 [3]) + +UPLINK NAS TRANSPORT message: + +- *TNGF Identity Information IE*: the information given within this IE between the TNGF and the AMF contains a list of identifiers of NG-U terminations at TNGF as specified in TS 23.502 [4]. +- *TWIF Identity Information IE*: the information given within this IE between the TWIF and the AMF contains a list of identifiers of NG-U terminations at TWIF as specified in TS 23.502 [4]. +- *W-AGF Identity Information IE*: the information given within this IE between the W-AGF and the AMF contains a list of identifiers of NG-U terminations at W-AGF as specified in TS 23.316 [6]. + +NG SETUP REQUEST message: + +- the following IEs shall be ignored, when received: + - *Default Paging DRX IE* + - *NB-IoT Default Paging DRX IE* + +NG SETUP RESPONSE message: + +- the following IEs shall be ignored, when received: + - *IAB Supported IE* + +RAN CONFIGURATION UPDATE message: + +- the following IEs shall be ignored, when received: + - *Default Paging DRX IE* + - *NB-IoT Default Paging DRX IE* + +OVERLOAD START message: + +- *AMF Overload Response IE*: if the *Overload Action IE* is included, the contained information is used to identify the related signalling traffic corresponding to the Establishment cause for non-3GPP access as specified in TS 24.502 [7]. +- *Slice Overload Response IE*: if the *Overload Action IE* is included, the contained information is used to identify the related signalling traffic corresponding to the Establishment cause for non-3GPP access as specified in TS 24.502 [7]. + +The *Global RAN Node ID IE* in the applicable NGAP messages includes the following IEs as specified in TS 38.413 [2]: + +- *Global N3IWF ID IE* for the untrusted non-3GPP access. + +- *Global TNGF ID* IE for the trusted non-3GPP access. +- *Global TWIF ID* IE for the trusted WLAN access. +- *Global W-AGF ID* IE for the wireline 5G access. + +The *User Location Information* IE in the applicable NGAP messages includes the following IEs as specified in TS 38.413 [2]: + +- *IP address* IE and *port number* IE for the untrusted non-3GPP access. +- *TNGF User Location Information* IE for the trusted non-3GPP access. +- *TWIF User Location Information* IE for the trusted WLAN access. +- *W-AGF User Location Information* IE for the wireline 5G access. + +The *Security Key* IE in the applicable NGAP messages includes the $K_{N3IWF}$ , or the $K_{TNGF}$ , or the $K_{TWIF}$ , or the $K_{WAGF}$ as specified in TS 33.501 [5]. + +The *RAN UE NGAP ID* IE in the applicable NGAP messages identifies the UE association over the NG interface within the N3IWF node, or the TNGF node, or the TWIF node, or the W-AGF node, as specified in TS 38.413 [2]. + +## 5.4 Handling of NGAP messages not specified to be applicable between the Non-3GPP access network node and AMF + +If the Non-3GPP access network node or the AMF receive an NGAP message not listed in section 5.2 as being applicable between the Non-3GPP access network node and AMF, the receiving node shall act according to the criticality defined for the elementary procedure and ignore the message or discard the message and send an ERROR INDICATION message indicating that the procedure is not supported, as specified in in TS 38.413 [2]. + +# Annex A (informative): Change history + +| Change history | | | | | | | | | +|----------------|----------|-----------|------|-----|-----|---------------------------------------------------------------------------|--|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | | New version | +| 2018-04 | R3#99bis | R3-181817 | - | - | - | TS skeleton | | 0.0.1 | +| 2018-04 | R3#99bis | R3-182522 | - | - | - | covering agreements of RAN3#99Bis | | 0.1.0 | +| 2018-05 | RAN#100 | R3-183589 | - | - | - | covering agreements of RAN3#100 | | 0.2.0 | +| 2018-06 | RAN#80 | RP-180755 | - | - | - | For approval | | 1.0.0 | +| 2018-06 | RAN#80 | | - | - | - | Specification approved at TSG-RAN and placed under change control | | 15.0.0 | +| 2018-12 | RP-82 | RP-182447 | 0001 | - | F | Add the UE TNLA Binding release and overload control procedures | | 15.1.0 | +| 2019-07 | RP-84 | RP-191394 | 0002 | 1 | F | N2 AMF mobility | | 15.2.0 | +| 2019-09 | RP-85 | RP-192166 | 0004 | 1 | F | Correction of N3IWF key | | 15.3.0 | +| 2020-07 | RP-88-e | RP-201092 | 0005 | - | F | Selected PLMN ID for untrusted non-3GPP access | | 15.4.0 | +| 2020-07 | RP-88-e | RP-201081 | 0003 | 11 | B | CR for introducing WWC in RAN | | 16.0.0 | +| 2020-09 | RP-89-e | RP-201954 | 0007 | 1 | A | Update the list of IEs that is not applicable to non-3GPP access | | 16.1.0 | +| 2020-12 | RP-90-e | RP-202310 | 0008 | 1 | F | Add the support for updating RG Level Wireline Access Characteristics | | 16.2.0 | +| 2020-12 | RP-90-e | RP-202313 | 0010 | 1 | F | Handling OVERLOAD START message in the N3IWF | | 16.2.0 | +| 2021-09 | RP-93-e | RP-211872 | 0011 | 1 | F | Ignoring the notification control for WWC | | 16.3.0 | +| 2022-06 | RP-96 | RP-221150 | 0012 | | F | Clarify the UE Security Capabilities IE not applicable to non-3GPP access | | 16.4.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29414/12de9b926df0384ec07702671827c9cd_img.jpg b/marked/Rel-16/29_series/29414/12de9b926df0384ec07702671827c9cd_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..eff847157d304075f0d8d44e40a3282c5e83ab63 --- /dev/null +++ b/marked/Rel-16/29_series/29414/12de9b926df0384ec07702671827c9cd_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:39a2142e99b9ddab813d5b54f6080d390bf3166ba06a6187d3497383397e79ee +size 25726 diff --git a/marked/Rel-16/29_series/29414/29f586959675cafdf81cf934954908eb_img.jpg b/marked/Rel-16/29_series/29414/29f586959675cafdf81cf934954908eb_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8c88be11c9115121c2c8aa3e2eb3d9851e6a551b --- /dev/null +++ b/marked/Rel-16/29_series/29414/29f586959675cafdf81cf934954908eb_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:869d315f71eb5d5f940049f32c2b86cc20926d2faaa8c4e7a5c8e3d02f433f9c +size 79463 diff --git a/marked/Rel-16/29_series/29414/3ad00ce93ad9dea9ee0f47535e5355e6_img.jpg b/marked/Rel-16/29_series/29414/3ad00ce93ad9dea9ee0f47535e5355e6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9615d7c2d7aba0f63b579dcc21b3209382d6e5e7 --- /dev/null +++ b/marked/Rel-16/29_series/29414/3ad00ce93ad9dea9ee0f47535e5355e6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9c3f9127e781befdfa0c5488a4ac8dc01b788b92d873c73796ac2887c75718c3 +size 51385 diff --git a/marked/Rel-16/29_series/29414/573c8f9e728e343b6864e1070c14b8cf_img.jpg b/marked/Rel-16/29_series/29414/573c8f9e728e343b6864e1070c14b8cf_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..47fb68c664fb8233273be5298157e1fa7b983452 --- /dev/null +++ b/marked/Rel-16/29_series/29414/573c8f9e728e343b6864e1070c14b8cf_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:964374c6ff2ffd6d9212c2edf591a6ab269a6aba836744d732bfa1f35b313bb8 +size 41790 diff --git a/marked/Rel-16/29_series/29414/65550960f5c5afd9d27706aaeddb0638_img.jpg b/marked/Rel-16/29_series/29414/65550960f5c5afd9d27706aaeddb0638_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b2aad508f9259494c142d64819b930dc0b919d89 --- /dev/null +++ b/marked/Rel-16/29_series/29414/65550960f5c5afd9d27706aaeddb0638_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:804994e4b9f18fa296b290173b94f076f7b256057eaea7a15cc513342e7be57b +size 10075 diff --git a/marked/Rel-16/29_series/29414/d26959f4514c26ca19c3d6f00da85956_img.jpg b/marked/Rel-16/29_series/29414/d26959f4514c26ca19c3d6f00da85956_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..83059bc171b1051f82ddf638d8f702ba42ac352d --- /dev/null +++ b/marked/Rel-16/29_series/29414/d26959f4514c26ca19c3d6f00da85956_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1534b9bab2834b7aef6a65a54a025b7c470b048c2b018a5348ac0e2828676f9c +size 9925 diff --git a/marked/Rel-16/29_series/29414/e6df2733626a85205c1db682e6259c46_img.jpg b/marked/Rel-16/29_series/29414/e6df2733626a85205c1db682e6259c46_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e928f2601d24b597aeeae49c05644c877d31a622 --- /dev/null +++ b/marked/Rel-16/29_series/29414/e6df2733626a85205c1db682e6259c46_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1c0dbf7400fad7622a45a2f939e1219cc6d6b0baaf86c75c2c654b96cf5ca7c3 +size 25141 diff --git a/marked/Rel-16/29_series/29414/e7c6a6e4c3047dac05a3b92e396e9794_img.jpg b/marked/Rel-16/29_series/29414/e7c6a6e4c3047dac05a3b92e396e9794_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..60dfd59bf27e5e6ca2e31ffd24f57075ce4dd940 --- /dev/null +++ b/marked/Rel-16/29_series/29414/e7c6a6e4c3047dac05a3b92e396e9794_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fa48d7a397dfb5f667ac068d32cf46c5e361db58aa2cd1d45b16f959eddc3b8c +size 23652 diff --git a/marked/Rel-16/29_series/29414/f01303b7b88af0e266cbfb69e57e24a4_img.jpg b/marked/Rel-16/29_series/29414/f01303b7b88af0e266cbfb69e57e24a4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9160904c80539dacda844f64cf682b842c0cf240 --- /dev/null +++ b/marked/Rel-16/29_series/29414/f01303b7b88af0e266cbfb69e57e24a4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d55d82e7cfb9b95c0cd917e3eee8cc52015682de737aff3d250e2792780491d4 +size 7809 diff --git a/marked/Rel-16/29_series/29414/raw.md b/marked/Rel-16/29_series/29414/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..e4dd201f8a27348b03ebb1d34c0e2e964e8b7511 --- /dev/null +++ b/marked/Rel-16/29_series/29414/raw.md @@ -0,0 +1,1134 @@ + + + + + + +# Contents + +| | | +|--------------------------------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions and abbreviations ..... | 8 | +| 3.1 Definitions..... | 8 | +| 3.2 Abbreviations ..... | 8 | +| 4 General..... | 9 | +| 5 Transport over ATM for BICC-based Nc ..... | 9 | +| 5.1 General ..... | 9 | +| 5.2 Transport network user plane..... | 9 | +| 5.2.1 General ..... | 9 | +| 5.2.2 ATM Adaptation Layer 2 ..... | 9 | +| 5.2.2.1 AAL2-Segmentation and Reassembly Service Specific Convergence Sublayer ..... | 9 | +| 5.2.2.2 AAL2-specification ..... | 10 | +| 5.3 Transport network control plane ..... | 10 | +| 5.3.1 General ..... | 10 | +| 5.3.2 Signalling protocol ..... | 10 | +| 5.3.2.1 AAL2 Signalling Protocol ..... | 10 | +| 5.3.3 Signalling transport converter ..... | 10 | +| 5.3.3.1 AAL2 MTP3B Signalling Transport Converter ..... | 10 | +| 5.3.4 MTP3b..... | 10 | +| 5.3.5 SSCF-NNI ..... | 10 | +| 5.3.6 SSCOP..... | 10 | +| 5.3.7 ATM Adaptation Layer Type 5..... | 11 | +| 6 Transport over IP for BICC based Nc..... | 11 | +| 6.1 General ..... | 11 | +| 6.2 Bearer Transport without multiplexing ..... | 11 | +| 6.2.0 Introduction ..... | 11 | +| 6.2.1 IP..... | 11 | +| 6.2.2 UDP..... | 11 | +| 6.2.3 RTP..... | 11 | +| 6.2.3.1 RTP Header..... | 12 | +| 6.2.3.1.1 Version ..... | 12 | +| 6.2.3.1.2 Padding..... | 12 | +| 6.2.3.1.3 Extension..... | 12 | +| 6.2.3.1.4 Contributing Source (CSRC) count..... | 12 | +| 6.2.3.1.5 Marker Bit..... | 12 | +| 6.2.3.1.6 Payload Type..... | 12 | +| 6.2.3.1.7 Sequence Number ..... | 12 | +| 6.2.3.1.8 Timestamp..... | 12 | +| 6.2.3.1.9 Synchronisation Source (SSRC) ..... | 12 | +| 6.2.3.1.10 CSRC list..... | 12 | +| 6.2.3.2 RTP Payload ..... | 12 | +| 6.2.4 RTCP ..... | 13 | +| 6.3 Bearer Control Protocol ..... | 13 | +| 6.3.1 Transport..... | 13 | +| 6.3.2 Procedures ..... | 14 | +| 6.3.2.1 Bearer Establishment..... | 14 | +| 6.3.2.2 Bearer Modification..... | 14 | +| 6.3.2.3 Bearer Release ..... | 14 | +| 6.3.3 Use of IPBCP message fields..... | 15 | +| 6.3.3.1 Origin..... | 15 | +| 6.3.3.2 Session Name..... | 15 | +| 6.3.3.3 Connection Data ..... | 15 | +| 6.3.3.4 Media Announcement..... | 15 | + +| | | | +|------------------------|-------------------------------------------------------------------------------------------|----| +| 6.3.3.5 | Media Attributes ..... | 15 | +| 6.4 | Bearer Transport with multiplexing ..... | 16 | +| 6.4.1 | Introduction ..... | 16 | +| 6.4.2 | Transport format ..... | 16 | +| 6.4.2.1 | IP ..... | 16 | +| 6.4.2.2 | UDP ..... | 16 | +| 6.4.2.3 | Transport Format for multiplexing without RTP Header Compression ..... | 16 | +| 6.4.2.4 | Transport Format for multiplexing with RTP header compression ..... | 18 | +| 6.4.3 | RTCP ..... | 20 | +| 6.4.3.1 | General ..... | 20 | +| 6.4.3.2 | Multiplex negotiation via RTCP ..... | 20 | +| 6.4.3.3 | RTCP Multiplexing packet ..... | 21 | +| 7 | Transport over IP for SIP-I based Nc ..... | 23 | +| 7.1 | General ..... | 23 | +| 7.2 | Bearer Transport without multiplexing ..... | 23 | +| 7.2.0 | Introduction ..... | 23 | +| 7.2.1 | IP ..... | 23 | +| 7.2.2 | UDP ..... | 23 | +| 7.2.3 | RTP ..... | 23 | +| 7.2.3.1 | RTP Header ..... | 23 | +| 7.2.3.1.1 | Version ..... | 23 | +| 7.2.3.1.2 | Padding ..... | 23 | +| 7.2.3.1.3 | Extension ..... | 23 | +| 7.2.3.1.4 | Contributing Source (CSRC) count ..... | 23 | +| 7.2.3.1.5 | Marker Bit ..... | 23 | +| 7.2.3.1.6 | Payload Type ..... | 24 | +| 7.2.3.1.7 | Sequence Number ..... | 24 | +| 7.2.3.1.8 | Timestamp ..... | 24 | +| 7.2.3.1.9 | Synchronisation Source (SSRC) ..... | 24 | +| 7.2.3.1.10 | CSRC list ..... | 24 | +| 7.2.3.2 | RTP Payload ..... | 24 | +| 7.2.4 | RTCP ..... | 24 | +| 7.3 | Bearer Transport with multiplexing ..... | 24 | +| 7.3.1 | Introduction ..... | 24 | +| 7.3.2 | Transport format ..... | 24 | +| 7.3.2.1 | IP ..... | 24 | +| 7.3.2.2 | UDP ..... | 24 | +| 7.3.2.3 | Transport Format for multiplexing without RTP Header Compression ..... | 24 | +| 7.3.2.4 | Transport Format for multiplexing with RTP header compression ..... | 25 | +| 7.3.3 | RTCP ..... | 26 | +| 7.4 | Transcoder-less Interworking with the Iu Framing Protocol ..... | 26 | +| 7.4.1 | Introduction ..... | 26 | +| 7.4.2 | Initialisation ..... | 26 | +| 7.4.3 | Time alignment ..... | 26 | +| 7.4.4 | Rate control ..... | 27 | +| 7.4.4.1 | General ..... | 27 | +| 7.4.4.2 | Rate control for AMR and AMR-WB ..... | 27 | +| 7.4.4.3 | Rate and Mode control for EVS ..... | 27 | +| 7.4.4.4 | Interworking of rate control between compatible AMR-WB and EVS codec configurations ..... | 28 | +| 7.4.5 | Frame quality indication ..... | 28 | +| 7.4.6 | Framing ..... | 29 | +| 7.4.7 | Transcoding ..... | 29 | +| 7.4.8 | Discontinuous transmission ..... | 29 | +| 7.4.9 | Timing and sequence information ..... | 29 | +| Annex A (informative): | Change history ..... | 30 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# 1 Scope + +The present document specifies the bearer data transport and bearer control protocols used between MGWs within the CS core network across the Nb Interface. The present document assumes that the implementation of the split of the call control and the bearer transport and control, as specified in 3GPP TS 23.205 [1] with BICC-based Nc, and in 3GPP TS 23.231 [30] with SIP-I based Nc,, see figure 1. For BICC-based Nc, the User Plane protocol that uses this bearer data transport (Nb UP) is described in 3GPP TS 29.415 [3]. The transport format for the Nb interface with IP transport can optionally allow RTP multiplexing. Note that the present document does not preclude an implementation of a combined MSC Server and MGW. + +![Figure 1: CS core network logical architecture diagram. The diagram shows a UTRAN/GERAN Iu mode connected to an MGW via an Iu interface. A GERAN A/Gb mode is connected to an MSC server via an A interface. The MGW and MSC server are connected by an Mc interface. The MGW is also connected to a PSTN/Legacy/External network via an Nb interface. The MSC server and GMSC server are connected by an Nc interface. The MGW and GMSC server are connected by an Mc interface. The legend indicates that dashed lines represent Signalling Interfaces and solid lines represent Signalling and Data Transfer Interfaces.](573c8f9e728e343b6864e1070c14b8cf_img.jpg) + +The diagram illustrates the CS core network logical architecture. On the left, two external entities are shown: 'UTRAN \ GERAN Iu mode' and 'GERAN A/Gb mode'. The 'UTRAN \ GERAN Iu mode' connects to an 'MGW' (Media Gateway) via an 'Iu' interface (solid line). The 'GERAN A/Gb mode' connects to an 'MSC server' via an 'A' interface (solid line). The 'MGW' and 'MSC server' are connected by an 'Mc' interface (dashed line). The 'MGW' is also connected to a 'PSTN/ Legacy/External' network via an 'Nb' interface (solid line). The 'MSC server' and 'GMSC server' are connected by an 'Nc' interface (dashed line). The 'MGW' and 'GMSC server' are connected by an 'Mc' interface (dashed line). A legend at the bottom left indicates that dashed lines represent 'Signalling Interface' and solid lines represent 'Signalling and Data Transfer Interface'. + +Figure 1: CS core network logical architecture diagram. The diagram shows a UTRAN/GERAN Iu mode connected to an MGW via an Iu interface. A GERAN A/Gb mode is connected to an MSC server via an A interface. The MGW and MSC server are connected by an Mc interface. The MGW is also connected to a PSTN/Legacy/External network via an Nb interface. The MSC server and GMSC server are connected by an Nc interface. The MGW and GMSC server are connected by an Mc interface. The legend indicates that dashed lines represent Signalling Interfaces and solid lines represent Signalling and Data Transfer Interfaces. + +Figure 1: CS core network logical architecture + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document in the same Release as the present document. + +- [1] 3GPP TS 23.205: "Bearer Independent CS Core Network; Stage 2". +- [2] 3GPP TS 25.414: "UTRAN Iu Interface Data Transport and Transport Signalling". +- [3] 3GPP TS 29.415: "Core Network Nb Interface User Plane Protocols". +- [4] 3GPP TS 29.232: "Media Gateway Controller (MGC) – Media Gateway (MGW) Interface; Stage 3". +- [5] ITU-T Recommendation E.164 (5/1997): "Numbering Plan for the ISDN Era". +- [6] ITU-T Recommendation I.361 (2/1999): "B-ISDN ATM Layer Specification". +- [7] ITU-T Recommendation I.363.2 (11/2000): "B-ISDN ATM Adaptation Layer Type 2 Specification". +- [8] ITU-T Recommendation I.363.5 (8/1996): "B-ISDN ATM Adaptation Layer Type 5 Specification". + +- [9] ITU-T Recommendation I.366.1 (6/1998): "Segmentation and Reassembly Service Specific Convergence Sublayer for the AAL Type 2". +- [10] ITU-T Recommendation H.248 (6/2000)"Media Gateway Control Protocol". +- [11] 3GPP TS 29.205: "Application of Q.1900 Series to Bearer Independent CS Core Network Architecture". +- [12] (Void) +- [13] (Void) +- [14] ITU-T Recommendation Q.2110 (7/1994): "B-ISDN ATM Adaptation Layer-Service Specific Connection Oriented Protocol (SSCOP)". +- [15] ITU-T Recommendation Q.2140 (2/1995): "B-ISDN ATM Adaptation Layer-Service Specific Coordination Function for Support of Signalling at the Network Node Interface (SSCF-NNI)". +- [16] ITU-T Recommendation Q.2150.1 (1999): "B-ISDN ATM Adaptation Layer-Signalling Transport Converter for the MTP3b". +- [17] ITU-T Recommendation Q.2210 (7/1996): "Message Transfer Part level 3 functions and messages using the services of ITU-T Recommendation Q.2140". +- [18] ITU-T Implementor's guide (12/99) for recommendation Q.2210 (07/96). +- [19] ITU-T Recommendation Q.2630.2 (12/2000): "AAL type 2 Signalling Protocol (Capability Set 2)". +- [20] ITU-T Recommendation Q.2931 (2/1995): "Digital Subscriber Signalling System No. 2 (DSS 2) – User-Network Interface (UNI) layer 3 specification for basic call/connection control". +- [21] ITU-T Recommendation X.213 (8/1997): "Information Technology-Open Systems Interconnection-Network Service Definitions". +- [22] IETF RFC 768: "User Datagram Protocol. (UDP)". +- [23] IETF RFC 791: "Internet Protocol (IP)". +- [24] IETF RFC 1889: "RTP: A Transport Protocol for Real Time Applications". +- [25] IETF RFC 1890: "RTP Profile for Audio and Video Conferences with Minimal Control". +- [26] IETF RFC 2327: "SDP: Session Description Protocol". +- [27] IETF RFC 2460: "Internet Protocol, Version 6 (IPv6)". +- [28] 3GPP TR 29.814: "Feasibility Study on Bandwidth Savings at Nb Interface with IP transport". +- [29] IETF RFC 3550: "RTP: A Transport Protocol for Real-Time Applications". +- [30] 3GPP TS 23.231: " SIP-I based circuit-switched core network; Stage 2". +- [31] 3GPP TS 25.415: "UTRAN Iu Interface User Plane Protocols" +- [32] 3GPP TS 26.102: "Adaptive Multi-Rate (AMR) speech codec; Interface to Iu and Uu". +- [33] IETF RFC 3551: "RTP Profile for Audio and Video Conferences with Minimal Control". +- [34] IETF RFC 3555: "MIME Type Registration of RTP Payload Formats". +- [35] IETF RFC 4867: "Real-Time Transport Protocol (RTP) payload format and file storage format for the Adaptive Multi-Rate (AMR) Adaptive Multi-Rate Wideband (AMR-WB) audio codecs". +- [36] 3GPP TS 29.007: "General requirements on interworking between the Public Land Mobile Network (PLMN) and the Integrated Services Digital Network (ISDN) or Public Switched Telephone Network (PSTN)" . + +- [37] 3GPP TS 26.445:"Codec for Enhanced Voice Services (EVS); Detailed Algorithmic Description". +- 38] 3GPP TS 26.453: "Codec for Enhanced Voice Services (EVS); Speech codec frame structure". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the following terms and definitions apply. + +## 3.2 Abbreviations + +For the purposes of the present document, the following abbreviations apply: + +| | | +|----------|-----------------------------------------------------------------| +| AAL | ATM Adaptation Layer | +| AAL2 | ATM Adaptation Layer Type 2 | +| AAL5 | ATM Adaptation Layer Type 5 | +| AESA | ATM End System Address | +| ALC | AAL2 Link Characteristics | +| ARP | Address Resolution Protocol | +| ATM | Asynchronous Transfer Mode | +| AVP | Audio Video Profile | +| BICC | Bearer Independent Call Control | +| CMR | Codec Mode Request | +| CN | Core Network | +| CSRC | Contributing Source | +| DSS2 | Digital Subscriber Signalling 2 | +| EVS | Enhanced Voice Services | +| EVS-CMR | Codec Mode Request for EVS | +| IANA | Internet Assigned Numbering Authority | +| IP | Internet Protocol | +| IPv4 | Internet Protocol version 4 | +| IPv6 | Internet Protocol version 6 | +| IPBCP | IP Bearer Control Protocol | +| ITU-T | International Telecommunications Union-Telecommunication sector | +| IuFP | Iu Framing protocol | +| MGW | Media GateWay | +| MIME | Multi purpose Internet Mail Extension | +| MTP3b | Message Transfer Part level 3 for Q.2140 [15] | +| NNI | Network Node Interface | +| NSAP | Network Service Access Point | +| PDU | Protocol Data Unit | +| PVC | Permanent Virtual Circuit | +| RFC | Request For Comment | +| RTP | Real-Time Transport Protocol | +| RTCP | Real-Time Transport Control Protocol | +| SAR | Segmentation and Reassembly | +| SCCF-NNI | Service Specific Coordination Function-Network Node Interface | +| SDP | Session Description Protocol | +| SDU | Service Data Unit | +| SID | Silence Insertion Descriptor | +| SPVC | Switched PVC | +| SSSAR | Service Specific Segmentation and Re-assembly sublayer | +| SSCOP | Service Specific Connection Oriented Protocol | +| SSCS | Service Specific Convergence Sublayer | +| SSRC | Synchronisation Source | +| SVC | Switched Virtual Circuit | +| TrFO | Transcoder Free Operation | +| UDP | User Datagram Protocol | +| UNI | User Network Interface | + +| | | +|----|-----------------| +| UP | User Plane | +| VC | Virtual Circuit | + +# 4 General + +The Nb UP shall be transported either over an ATM or IP bearer. + +# 5 Transport over ATM for BICC-based Nc + +## 5.1 General + +Clause 5 is only applicable in combination with BICC-based Nc. + +ATM shall be used in the transport network user plane and the transport network control plane according to ITU-T Recommendation I.361 [6]. The structure of the ATM cell header used across the Nb interface shall be the cell header format and encoding at the NNI (see Figure 3 in I.361 [6]). + +## 5.2 Transport network user plane + +### 5.2.1 General + +Figure 2 shows the ATM protocol stack used for the transport network user plane on the Nb interface. + +![](65550960f5c5afd9d27706aaeddb0638_img.jpg) + +| | +|---------------------------------| +| AAL-2 SAR SSCS (I.366.1) | +| AAL2 (I.363.2) | +| ATM | + +**Figure 2: ATM protocol stack used for the transport network user plane** + +ATM AAL2 connections shall be transported over a VC which may either be a PVC, an SPVC or an SVC. For every ATM implementation of the Nb interface, a PVC shall be supported. The support of an SPVC or an SVC is optional. An ATM implementation may either support SPVCs only, SVCs only, or both. + +If SPVCs or SVCs are supported, DSS2 signalling [20] shall be used for the establishment and tear down of these VCs. The network element that generated a given switched VC shall be the only network element that is allowed to tear down this VC. + +### 5.2.2 ATM Adaptation Layer 2 + +#### 5.2.2.1 AAL2-Segmentation and Reassembly Service Specific Convergence Sublayer + +Service Specific Segmentation and Reassembly (SSSAR) sublayer of ITU-T Recommendation I.366.1 [9] shall be used for the segmentation and reassembly of AAL2 SDUs (i.e. only SSSAR is used from I.366.1 [9]). + +#### 5.2.2.2 AAL2-specification + +AAL2 shall be used according to ITU-T Recommendation I.363.2 [7]. + +## 5.3 Transport network control plane + +### 5.3.1 General + +Figure 3 shows the protocol stack for the transport network control plane on the Nb interface. + +![](e6df2733626a85205c1db682e6259c46_img.jpg) + +| | +|---------------------------------------------------------------------| +| AAL2 connection signalling
(Q.2630.2)
| +| AAL2 Signalling Transport
Converter for MTP3b (Q.2150.1)
| +| MTP3b | +| SSCF-NNI | +| SSCOP | +| AAL5 | +| ATM | + +**Figure 3: ATM protocol stack for the transport network control plane** + +Tunnelling, as described in 3GPP TS 23.205 [1], is currently not specified to transport the ATM transport network control plane. + +### 5.3.2 Signalling protocol + +#### 5.3.2.1 AAL2 Signalling Protocol + +ITU-T Q.2630.2 [19] shall be used for the establishment of AAL2 connections. The AAL2 transport layer uses the embedded E.164 [5] or AESA variants of the NSAP addressing formats [21]. Native E.164 addressing shall not be used. + +The MGW which issues a given ESTABLISH request [19] provides a Binding Reference (see 3GPP TS 23.205 [1]), This binding reference shall be copied into the SUGR parameter of the corresponding ESTABLISH request primitive [19]. + +The AAL2 Link Characteristics parameter (ALC) in the Establish Request message of the AAL2 signalling protocol shall be used. + +### 5.3.3 Signalling transport converter + +#### 5.3.3.1 AAL2 MTP3B Signalling Transport Converter + +The AAL2 MTP3b Signalling Transport Converter shall be used according to ITU-T Recommendation Q.2150.1 [16]. + +### 5.3.4 MTP3b + +MTP3b shall be used according to ITU-T Recommendation Q.2210 [17 & 18]. + +### 5.3.5 SSCF-NNI + +SSCF-NNI shall be used according to ITU-T Recommendation Q.2140 [15]. + +### 5.3.6 SSCOP + +SSCOP shall be used according to ITU-T Recommendation Q.2110 [14]. + +### 5.3.7 ATM Adaptation Layer Type 5 + +AAL5 shall be used according to ITU-T Recommendation I.363.5 [8] + +# 6 Transport over IP for BICC based Nc + +## 6.1 General + +Clause 6 is only applicable in combination with BICC-based Nc. + +RTP (RFC 1889 [24] or RFC 3550 [29]) over UDP (RFC 768 [22]) over either IPv4 (RFC 791 [23]) or IPv6 (RFC 2460 [27]) shall be used in the transport network user plane. The present specification takes the role of an RTP profile in describing the transport of the Nb UP protocol by RTP. Figure 4 shows the protocol stack for the transport network user plane on the Nb interface. + +![Figure 4: IP Protocol stack for the transport network user plane. The diagram shows a vertical stack of three protocol layers. The top layer is labeled 'RTP', the middle layer is labeled 'UDP', and the bottom layer is labeled 'IPv4 or IPv6'.](d26959f4514c26ca19c3d6f00da85956_img.jpg) + +| | +|---------------------| +| RTP | +| UDP | +| IPv4 or IPv6 | + +Figure 4: IP Protocol stack for the transport network user plane. The diagram shows a vertical stack of three protocol layers. The top layer is labeled 'RTP', the middle layer is labeled 'UDP', and the bottom layer is labeled 'IPv4 or IPv6'. + +**Figure 4: IP Protocol stack for the transport network user plane** + +Tunnelling, as described in 3GPP TS 23.205 [1], shall be used to transport the IP bearer control protocol IPBCP conform the ITU-T Recommendation Q.1970 "BICC IP Bearer Control Protocol" (IPBCP) (see 3GPP TS 29.205 [11]). + +## 6.2 Bearer Transport without multiplexing + +## 6.2.0 Introduction + +The support of bearer transport without multiplexing shall be supported. It shall be applied unless a bearer transport with multiplexing is negotiated via RTCP, as described in sub-clause 6.4.3. + +### 6.2.1 IP + +Either IPv4 (RFC 791 [23]) or IPv6 (RFC 2460 [27]) shall be used. + +One MGW may have several IP interfaces with different IP addresses. + +### 6.2.2 UDP + +The UDP Protocol (see RFC 768 [22]) shall be applied. + +Two consecutive port numbers shall be used at each MGW for the RTP bearer and for the optional RTCP connection that transport a single Nb UP connection. Two such consecutive port numbers are termed "port number block" in what follows. The first port number shall be even and shall be assigned to the RTP protocol. At a given MGW, the same port shall be used to send and to receive RTP PDUs. The next port number shall be assigned to the RTCP protocol. This port shall be reserved even if the optional RTCP protocol is not used. + +Each MGW shall administer the port numbers it intends to use for RTP/RTCP port number blocks. + +### 6.2.3 RTP + +RTP (see RFC 1889 [24] or RFC 3550 [29]) shall be applied. + +#### 6.2.3.1 RTP Header + +The RTP Header Fields shall be used as described in the following subclauses: + +##### 6.2.3.1.1 Version + +RTP Version 2 shall be used. + +##### 6.2.3.1.2 Padding + +Padding shall not be used. + +##### 6.2.3.1.3 Extension + +The RTP Header shall not have an extension. + +##### 6.2.3.1.4 Contributing Source (CSRC) count + +There are zero CSRCs. + +##### 6.2.3.1.5 Marker Bit + +The marker bit is ignored. + +##### 6.2.3.1.6 Payload Type + +A dynamic Payload Type (see RFC 1890 [25]) shall be used. Values between 96 and 127 shall be used. The value shall be negotiated by means of the bearer control protocol. + +##### 6.2.3.1.7 Sequence Number + +The sequence number shall be supplied by the source MGW of a RTP PDU. The sink MGW of a RTP PDU may ignore the sequence number or it may use it to obtain statistics about the link quality and / or to correct out-of-sequence delivery, e.g. by dropping out-of-sequence packets. + +##### 6.2.3.1.8 Timestamp + +The timestamp shall be supplied by the source MGW of a RTP PDU. A clock frequency of 16000 Hz shall be used. The definition of the RTP timestamp is specified in IETF RFC 1889 [24] which states that RTP timestamp is based on the sampling instant of the source encoder. However for the present application the source MGW is not mandated to set the RTP timestamp according to the sampling instant of the payload PDU. Although the RTP timestamp can reflect the sampling instant in some scenarios, the sink MGW cannot rely upon the accuracy of the RTP Timestamp. The sink MGW of a RTP PDU may ignore the timestamp. + +NOTE: An application can use the time based NbFP frame number to obtain end-to-end timing information. + +##### 6.2.3.1.9 Synchronisation Source (SSRC) + +The source MGW of a RTP PDU shall supply a SSRC. The sink MGW of a RTP PDU may ignore the SSRC if it does not use RTCP. + +##### 6.2.3.1.10 CSRC list + +This list is empty. + +#### 6.2.3.2 RTP Payload + +A single UP PDU, as described in 3GPP TS 29.415 [3], shall be transported as a RTP payload. + +### 6.2.4 RTCP + +RTCP (see RFC 1889 [24]) may be applied. The use of the RTCP protocol is optional. + +A MGW may ignore incoming RTCP PDUs. + +Figure 5 shows the protocol stack for the transport of RTCP. The above Sections about IP and UDP shall also apply for the transport of RTCP. + +![](f01303b7b88af0e266cbfb69e57e24a4_img.jpg) + +| | +|---------------------| +| RTCP | +| UDP | +| IPv4 or IPv6 | + +**Figure 5: RTCP Protocol stack for the transport network user plane** + +## 6.3 Bearer Control Protocol + +The ITU-T Recommendation Q.1970 "BICC IP Bearer Control Protocol" (IPBCP) (see 3GPP TS 29.205 [11]) shall be applied. + +The use of Iu FP as RTP payload shall be indicated within IPBCP. IuFP shall transport either speech or data in a bearer independent way as described in 3GPP TS 23.205 and 3GPP TS 29.205. The negotiation of the type of payload within IuFP is outside the scope of IPBCP and described in the above specifications. + +NOTE: The IuFP is registered with IANA as the MIME type "VND.3GPP.IuFP" of the "audio" category, however, this registration does not preclude the use of IuFP to transport "data". + +### 6.3.1 Transport + +IPBCP shall be transported over the Mc and Nc interface by means of the ITU-T Recommendation Q.1990 "BICC Bearer Control Tunnelling Protocol" ( see 3GPP TS 29.205 [11]). The transport of the Q.1990 "BICC Bearer Control Tunnelling Protocol" on the Mc interface is described in 3GPP TS 29.232 [4]. The transport of the "BICC Bearer Control Tunnelling Protocol" on the Nc interface is described in ITU-T Recommendation Q.765.5 (see 3GPP TS 29.205 [11]). + +![Diagram illustrating the transport of IPBCP over Mc, Nc, and Nb interfaces between MSC-Server and MGW components.](3ad00ce93ad9dea9ee0f47535e5355e6_img.jpg) + +The diagram shows two MSC-Server units at the top, connected by an Nc interface. Below each MSC-Server is an MGW unit, connected by an Mc interface. The two MGW units are connected by an Nb interface. The transport stack is shown as nested rectangles between the MSC-Server and MGW. From the outermost to the innermost, the layers are: + + +- IPBCP: Q.1970** (Red layer) +- Tunnel: Q.1990** (Green layer) +- BICC: Q.765.5** (Blue layer) +- TS 29.232** (Yellow layer) + + The diagram indicates that the transport of IPBCP over the Mc interface uses the TS 29.232 protocol, while over the Nc interface it uses the BICC: Q.765.5 protocol. + +Diagram illustrating the transport of IPBCP over Mc, Nc, and Nb interfaces between MSC-Server and MGW components. + +Figure 6: Transport of IPBCP + +### 6.3.2 Procedures + +The IPBCP procedures shall be used as described in the ITU-T Recommendation Q.1970 "BICC IP Bearer Control Protocol" (IPBCP) (see 3GPP TS 29.205 [11]). + +#### 6.3.2.1 Bearer Establishment + +The forward and backward RTP bearers used to transport one Nb UP connection shall be set up together after an IPBCP handshake with a Request message and an Accepted message has succeeded. + +Each MGW shall signal its peer MGW with the RTP port number. The RTCP port number shall be the next higher number. + +If the optional 20 ms packetisation time is supported for PCM encoded speech over Nb and if its use is authorized by local configuration setting, the MGW shall also negotiate with its peer MGW the packetisation time to be used for PCM encoded speech over Nb, even if the codec configured on the bearer is still unknown or differs from PCM. This is done by including the "pcmptime=20" parameter in the IPBCP Request as defined in sub-clause 6.3.3.5. A MGW receiving the "pcmptime=20" parameter ignores it if the 20 ms packetisation time is not supported for PCM encoded speech over Nb. A MGW receiving the "pcmptime=20" parameter shall return the "pcmptime=20" parameter in the IPBCP Accept message only if the 20 ms packetisation is supported for PCM encoded speech over Nb and if its use is authorized by local configuration setting. Receipt of the "pcmptime=20" parameter in the IPBCP Accept shall indicate to the originating MGW that it shall apply the 20 ms packetisation time when PCM encoded speech is sent over the Nb bearer. Otherwise the default 5 ms packetisation time shall be used for PCM encoded speech over Nb. The result of the negotiation is only used if PCM is selected on the bearer. + +#### 6.3.2.2 Bearer Modification + +A modification of existing RTP bearers is not permitted. The IPBCP Request message shall not be used to modify bearers. + +#### 6.3.2.3 Bearer Release + +When the H.248 Termination [10] of an Nb UP connection on a MGW is deleted by means of signalling over the Mc interface, which are outside the scope of IPBCP (see 3GPP TS 29.232 [4]), the used resources shall be freed as follows: + +The MGW shall discard any packets arriving at the port pair used for the old Nb UP connection until it sets up a new Nb UP connection on these ports. The MGW shall only reuse these ports after a time that is long enough to avoid that packets from the old connection still arrive. + +### 6.3.3 Use of IPBCP message fields + +The IPBCP message fields shall be used as described in the ITU-T Recommendation Q.1970 "BICC IP Bearer Control Protocol" (IPBCP) (see 3GPP TS 29.205 [11]) and SDP (RFC 2327 [26]). Moreover, the following subclauses shall be applied: + +#### 6.3.3.1 Origin + +*
* shall be the IP address assigned to the IP interface used for the RTP bearer on the source MGW of the present IPBCP message. + +#### 6.3.3.2 Session Name + +The source MGW shall supply an arbitrary string as **. The sink MGW shall ignore this string. + +#### 6.3.3.3 Connection Data + +The ** shall be identical to the above origin *
* + +#### 6.3.3.4 Media Announcement + +** shall always be set to "audio" irrespective of the payload type within IuFP. + +** shall be set to the port number assigned to the RTP bearer on the source MGW of the present IPBCP message + +** shall be set to "RTP/AVP". + +** shall be set to the chosen dynamic payload number. The MGW that initiates the bearer establishment may choose any value between 96 and 127. The peer MGW shall echo this value. + +#### 6.3.3.5 Media Attributes + +The following media attribute shall be supplied: "a=rtpmap:** VND.3GPP.IUFP/16000", where:** is the same dynamic payload type number as in the above media announcement **. + +The media attribute "a=fmtp:** pcmptime=20" shall also be set: + +- in the IPBCP Request if the optional 20 ms packetisation time is supported for PCM encoded speech over Nb and if its use is authorized by local configuration setting; +- in the IPBCP Accept message if received in the IPBCP Request and if the optional 20 ms packetisation time is supported for PCM encoded speech over Nb and if its use is authorized by local configuration setting. + +Other media attributes shall not be used. They shall be ignored in the MGW receiving an IPBCP message. + +Example of IPBCP Request / Accept exchange where both MGWs support the 20 ms packetisation time for PCM encoded speech over Nb: + +``` +IPBCP Request (MGW1 -> MGW2) +m=audio 49170 RTP/AVP 97 +a=rtpmap:97 VND.3GPP.IUFP/16000 +``` + +``` +a=fmtp:97 pcmptime=20 +IPBCP Accept (MGW2 -> MGW1) +m=audio 49320 RTP/AVP 97 +a=rtpmap:97 VND.3GPP.IUFP/16000 +a=fmtp:97 pcmptime=20 +``` + +## 6.4 Bearer Transport with multiplexing + +### 6.4.1 Introduction + +This sub-clause specifies an optional transport format for the Nb interface and IP transport that allows transporting several RTP/NbFP/codec payload PDUs of different user plane connections within one packet, and the corresponding backward compatible signalling extensions required to negotiate the use of this transport option. Use of this transport format saves bandwidth in the IP network (bandwidth gains are evaluated in 3GPP TR 29.814 [28]). + +Bandwidth saving is achieved by multiplexing several NbFP PDUs within one UDP/IP packet. As an option, the RTP header may be compressed in addition. Two transport formats are specified accordingly. + +### 6.4.2 Transport format + +#### 6.4.2.1 IP + +Either IPv4 (RFC 791 [23]) or IPv6 (RFC 2460 [27]) shall be used. + +One MGW may have several IP interfaces with different IP addresses. + +#### 6.4.2.2 UDP + +The UDP Protocol (see RFC 768 [22]) shall be applied. If multiplexing is applied with or without header compression, the source UDP port number shall indicate the local termination used to combine the multiplexed packet and the destination UDP port number shall indicate the remote port number where PDUs are demultiplexed. The negotiation if multiplexing is applied and of the destination UDP port is described in sub-clause 6.4.3. If multiplexing was negotiated for a Nb UP user plane connection, the MGW may apply multiplexing by sending all packets of the user plane connection towards the negotiated destination UDP port. + +#### 6.4.2.3 Transport Format for multiplexing without RTP Header Compression + +Several RTP/NbFP/codec payload PDUs sent to the same IP address are multiplexed within one single UDP/IP packet over the Nb interface between MGWs. If DiffServ is applied, all multiplexed PDUs also need to share the same Diffserv class. The multiplexing shall only be used with RTP packets. RTCP shall be transported normally by UDP/IP packets. + +Use of multiplexing shall be negotiated between MGWs, as specified in sub-clause 6.4.3. + +Before each multiplexed RTP/NbFP/codec payload PDU inserted into the UDP/IP packet a Multiplex Header, which identifies the multiplexed packet, shall be inserted. + +| Bits | | | | | | | | Number of Octets | | | | | | | | | +|----------------------------------------------------|--------------------------------------------------------|---|---|---|---|---|---|------------------|------------------|--|--|--|--|--|--|--| +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | | | | | | | | | | +| Source IP, Dest IP, ... | | | | | | | | 20/40 | IP | | | | | | | | +| Source Port, Dest Port=, Length, ... | | | | | | | | 8 | UDP | | | | | | | | +| T=0 | Mux ID = (Destination UDP Port of multiplexed PDU) / 2 | | | | | | | 2 | Multiplex Header | | | | | | | | +| Length Indicator (LI) = n | | | | | | | | 1 | | | | | | | | | +| R | Source ID = (Source UDP Port of multiplexed PDU) / 2 | | | | | | | 2 | | | | | | | | | +| Full RTP packet | | | | | | | | n | RTP header | | | | | | | | +| | | | | | | | | | RTP NbFP Payload | | | | | | | | +| Multiplex Header | | | | | | | | 5 | Multiplex Header | | | | | | | | +| Full RTP packet | | | | | | | | m | RTP header | | | | | | | | +| | | | | | | | | | RTP NbFP Payload | | | | | | | | +| ... | | | | | | | | | | | | | | | | | + +**Figure 7: UDP/IP Packet with multiplexed RTP/NbFP payload PDUs without RTP header compression** + +The Multiplex Header includes : + +- T bit. + +The field has two possible values, 0 for indicating full packet and 1 for indicating compressed packet. Value 0 shall be used for an uncompressed RTP header, as described in the present sub-clause. + +- Mux ID, 15 bits. + +For identification of different user plane connections. The value shall be the UDP destination port of the corresponding non-multiplexed RTP/NbFP PDU packet divided by two (only even numbered ports are used for RTP sessions). + +- Length Indicator (LI), 8 bits, unsigned integer. + +Gives the length of the multiplexed RTP/NbFP PDU packet (RTP header + RTP Payload = RTP header + NbFP header + NbFP payload) in bytes (the last byte of the RTP/NbFP PDU is padded to the next byte boundary if necessary). Maximum length is 255 bytes. This LI allows to calculate where the next Multiplex Header for the next multiplexed RTP/NbFP PDU packet starts. + +- R bit. + +Reserved for future use. Shall be set to 0 by the sending entity and be ignored by the receiving entity. + +- Source ID, 15 bits. + +For identification of the different connections. The value shall be the source UDP port of the corresponding non-multiplexed RTP/NbFP/codec PDU packet divided by two (only even numbered ports are used for RTP sessions). This information is transferred to permit the receiving node to optionally detect and filter illegitimate packets (e.g. packets received from the peer termination precedingly associated to the receiving termination). + +The multiplexed RTP/NbFP payload PDU shall be inserted in the IP/UDP packet directly after the corresponding Multiplex Header. The multiplexed RTP/NbFP payload PDU shall follow the rules in sub-clause 6.2.3 and consists of the full RTP header, the full NbFP header and the NbFP payload. If the multiplexed RTP/NbFP payload PDU does not end at a byte boundary, then the remaining bits of its last byte shall be padded with zeros. + +The multiplexing method does not limit the number of packets being multiplexed and it is thus the data link layer protocol that defines the maximum frame size. E.g. an IP datagram has a maximum length of 65 535 bytes and Ethernet 1 518 bytes. In order to avoid additional delay in the network the packets should not be delayed more than 1 ms to 2 ms, which also effectively limits the number of multiplexed packets and makes the multiplexing-jitter low. + +![Figure 8: Example of multiplexed packet with two RTP frames. The diagram illustrates the structure of two multiplexed packets. Each packet contains an IP header (20/40 bytes), a UDP header (8 bytes), a Multiplex Header (5 bytes), an RTP header (12 bytes), and an NbUP frame (9... bytes). The first packet is associated with 'Dest. & Source UDP Port: xxxx' and the second with 'Dest. & Source UDP Port: yyyy'. A 'Common header' is shown for the first packet, and a 'Negotiated UDP MUX port.' is indicated. A double-headed arrow at the bottom indicates a maximum length of 255 bytes for the combined headers and payloads.](29f586959675cafdf81cf934954908eb_img.jpg) + +The diagram shows the structure of two multiplexed packets. Each packet consists of an IP header (20/40 bytes), a UDP header (8 bytes), a Multiplex Header (5 bytes), an RTP header (12 bytes), and an NbUP frame (9... bytes). The first packet is associated with 'Dest. & Source UDP Port: xxxx' and the second with 'Dest. & Source UDP Port: yyyy'. A 'Common header' is shown for the first packet, and a 'Negotiated UDP MUX port.' is indicated. A double-headed arrow at the bottom indicates a maximum length of 255 bytes for the combined headers and payloads. + +Figure 8: Example of multiplexed packet with two RTP frames. The diagram illustrates the structure of two multiplexed packets. Each packet contains an IP header (20/40 bytes), a UDP header (8 bytes), a Multiplex Header (5 bytes), an RTP header (12 bytes), and an NbUP frame (9... bytes). The first packet is associated with 'Dest. & Source UDP Port: xxxx' and the second with 'Dest. & Source UDP Port: yyyy'. A 'Common header' is shown for the first packet, and a 'Negotiated UDP MUX port.' is indicated. A double-headed arrow at the bottom indicates a maximum length of 255 bytes for the combined headers and payloads. + +**Figure 8: Example of multiplexed packet with two RTP frames** + +#### 6.4.2.4 Transport Format for multiplexing with RTP header compression + +To achieve even better bandwidth savings, the RTP header may optionally be compressed. This is possible since the RTP header includes many static fields that remain unchanged during an RTP session if NbFP is used as payload (see sub-clause 6.3.2). + +Use of RTP header compression shall be negotiated between MGWs, as specified in sub-clause 6.4.3. + +At least the first two RTP packets of each RTP session shall be sent with their full RTP header to allow the receiver to store the full header and use it in decompression. RTP packets shall also be sent with their full RTP header till receipt of a RTCP packet from the peer indicating support of RTP header compression. Subsequent packets may be sent with a compressed RTP header. If a MGW does not receive any of the initial RTP packets with a full RTP header, the MGW shall assume that the fields of the RTP header other than those present in the compressed RTP header are set as defined in sub-clause 6.2.3.1, and shall therefore not consider this as an error. + +Before each multiplexed RTP/NbFP/codec payload PDU inserted into the UDP/IP packet a Multiplex Header, which identifies the multiplexed packet, shall be inserted + +| Bits | | | | | | | | Number of Octets | | | | | | | | | +|----------------------------------------------------|--------------------------------------------------------|---|---|---|---|---|---|------------------|-----------------------|--|--|--|--|--|--|--| +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | | | | | | | | | | +| Source IP, Dest IP, ... | | | | | | | | 20/40 | IP | | | | | | | | +| Source Port, Dest Port=, Length, ... | | | | | | | | 8 | UDP | | | | | | | | +| T=1 | Mux ID = (Destination UDP Port of multiplexed PDU) / 2 | | | | | | | 2 | Multiplex Header | | | | | | | | +| Length Indicator (LI) = n+ 3 | | | | | | | | 1 | | | | | | | | | +| R | Source ID = (Source UDP Port of multiplexed PDU) / 2 | | | | | | | 2 | | | | | | | | | +| Sequence Number (SN) | | | | | | | | 1 | Compressed RTP header | | | | | | | | +| Timestamp (TS) | | | | | | | | 2 | | | | | | | | | +| RTP payload | | | | | | | | n | RTP NbFP Payload | | | | | | | | +| Multiplex Header | | | | | | | | 5 | Multiplex Header | | | | | | | | +| Compressed RTP header | | | | | | | | 3 | Compressed RTP header | | | | | | | | +| RTP payload | | | | | | | | m | RTP NbFP Payload | | | | | | | | + +**Figure 9: UDP/IP Packet with multiplexed RTP/NbFP payload PDUs with RTP header compression** + +The Multiplex Header shall be used as described in sub-clause 6.4.2.3. However, the T bit shall be set for a compressed RTP header, as described in the present sub-clause. The Length Indicator gives the length of the multiplexed RTP/NbFP PDU packet in bytes (compressed RTP header + RTP Payload ). + +The multiplexed RTP/NbFP payload PDU shall be inserted in the IP/UDP packet directly after the corresponding Multiplex Header. The multiplexed RTP/NbFP payload PDU shall consist of the compressed RTP header described below followed by the full NbFP header and the NbFP payload, as described in 3GPP TS 29.415 [3]. If the multiplexed RTP/NbFP payload PDU does not end at a byte boundary, then the remaining bits of its last byte shall be padded with zeros. + +The compressed RTP header shall include the following two fields taken from the uncompressed RTP header: + +- Sequence number (SN), 8 bits. + +The field changes as the original sequence number (RFC 3550 [29]) but is shortened from 16 bits to 8 bits (256 packets). The least significant byte of the RTP sequence number shall be included. Sub-clause 6.2.3.1.7 is applicable. + +- Timestamp (TS), 16 bits. + +The TS field changes as the original timestamp (RFC 3550 [29]) but the length is half of the original resulting in modulo of 4 seconds with 16 kHz clock reference. The least significant two bytes of the RTP timestamp shall be included. Sub-clause 6.2.3.1.8 is applicable. + +NOTE: These RTP fields change during a connection and thus need to be transferred within each packet for NbFP payload. All other RTP fields do not change (see sub-clause 6.2.3). + +![Diagram illustrating the structure of multiplexed packets. It shows two consecutive packets, labeled '1. MUX packet' and '2. MUX packet'. Each packet consists of an IP header (20/40 bytes), a UDP header (8 bytes), a Compressed RTP header (3 bytes), a MUX field (5 bytes), and an NbUP frame (9.. bytes). The IP and UDP headers are labeled as a 'Common header'. An arrow points from a box labeled 'Negotiated UDP MUX port' to the UDP header of the first packet.](12de9b926df0384ec07702671827c9cd_img.jpg) + +Diagram illustrating the structure of multiplexed packets. It shows two consecutive packets, labeled '1. MUX packet' and '2. MUX packet'. Each packet consists of an IP header (20/40 bytes), a UDP header (8 bytes), a Compressed RTP header (3 bytes), a MUX field (5 bytes), and an NbUP frame (9.. bytes). The IP and UDP headers are labeled as a 'Common header'. An arrow points from a box labeled 'Negotiated UDP MUX port' to the UDP header of the first packet. + +**Figure 10: Example of multiplexed packet with two RTP frames and compressed RTP headers** + +### 6.4.3 RTCP + +#### 6.4.3.1 General + +A MGW wishing to apply Bearer Transport with multiplexing shall use RTCP (see RFC 3550 [29]) to negotiate multiplexing. + +RTCP shall be used separately for each user plane connection. RTCP shall be transported by UDP/IP packets as described in sub-clause 6.2.4. and not included included in IP/UDP packets using the multiplexing format described above. + +#### 6.4.3.2 Multiplex negotiation via RTCP + +RTCP shall be used to negotiate the use of multiplexing. A new 3GPP-specific RTCP Multiplexing packet is specified in sub-clause 6.4.3.3 for this purpose, and may be added to compound RTCP packets following the principles of RFC 3550 [29]. The Multiplexing RTCP packet indicates: + +- if multiplexing without RTP header compression is supported ; +- if multiplexing with RTP header compression is supported ; +- the local UDP port where to receive multiplexed data streams, +- if multiplexing is selected.. + +When setting up a new user plane connection, both peer MGWs of a NbUP connection shall start to send data without applying multiplexing and may indicate their readiness to receive multiplexed data streams by including the new RTCP Multiplexing packet in the initial and all subsequent RTCP packets they send. A MGW shall always announce the same multiplexing capabilities and the same UDP port where to receive multiplexed data streams in all the RTCP Multiplexing packets it sends for a given RTP session. MGWs should preferably send their initial RTCP packet at the very beginning of the RTP session to be able to apply multiplexing as soon as possible. A MGW sending a Multiplexing packet indicating support of multiplexing shall be ready to receive multiplexed packets at the announced UDP port. A single UDP port for multiplexing shall be used per destination IP address. + +A MGW receiving an RTCP packet, where the peer indicated its readiness to receive multiplexed data streams, may apply multiplexing to send the corresponding RTP data streams towards the sender of the RTCP packet. If the MGW decides to apply multiplexing, it can immediately start sending multiplexed data streams towards the corresponding UDP multiplexing port announced in the received RTCP Multiplexing packet. The MGW shall indicate in subsequent RTCP Multiplexing packets if it applies multiplexing with or without header compression for the given user connection + +A MGW that does not receive RTCP or receives RTCP without the RTCP Multiplexing packet shall continue to send data for the user connection without applying multiplexing. + +A MGW that does not support multiplexing will ignore the unknown received RTCP Multiplexing package according to RTCP procedures and will continue to send data for the user connection without applying multiplexing. + +Sending of a RTCP Multiplexing packet indicating readiness to receive multiplexed data streams does not necessarily mean that the MGW is ready to send multiplexed data streams, i.e. multiplexing may be applied on a single or on both directions for a given RTP session. + +The applicable compressed header format is not negotiated using RTCP, but is determined by the fact if the Nb bearer is controlled via a SIP-I based Nc interface or a BICC based Nc interface. A MGW may support multiplexing of both RTP header compression formats on a same IP interface. + +#### 6.4.3.3 RTCP Multiplexing packet + +The format of the RTCP Multiplexing packet is specified in figure 11. + +| Bits | | | | | | | | Number of Octets | | | | +|-------------------|------------------------|-----------|---------|---------------|---|---|---|------------------|----------------------------|--|--| +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | | | | | +| V=2 | | P | subtype | | | | | 1 | APP packet header | | | +| PT=APP=204 | | | | | | | | 1 | | | | +| Length | | | | | | | | 2 | | | | +| SSRC/CSRC | | | | | | | | 4 | | | | +| Name(ASCII) | | | | | | | | 4 | | | | +| MUX | CP | Selection | | Reserved=0000 | | | | 2 | Application dependent data | | | +| Reserved=00000000 | | | | | | | | | | | | +| Reserved=0 | Local MUX UDP port / 2 | | | | | | | 2 | | | | + +Figure 11: RTCP Multiplexing packet + +The APP packet header includes : + +- version (V), 2 bits + +Identifies the version of RTP, which is the same in RTCP packets as in RTP data packets. RTP Version 2 shall be used. + +- padding (P), 1 bit + +As specified in RFC 3550 [4]. + +- subtype, 5 bits. + +The following subtype value shall be used : + +00001 : RTCP Multiplexing packet + +- packet type (PT), 8 bits. + +Shall contains the constant 204 to identify this as an RTCP APP packet + +- length, 16 bits. + +As specified in RFC 3550 [4]. The length of this RTCP packet in 32-bit words minus one, including the header and any padding. (The offset of one makes zero a valid length and avoids a possible infinite loop in scanning a compound RTCP packet, while counting 32-bit words avoids a validity check for a multiple of 4.) + +- SSRC/CSRC, 32 bits. + +As specified in RFC 3550 [4]. + +- name, 32 bits. + +Shall be set to "3GPP" + +The application-dependent data includes : + +- multiplexing bit (MUX), 1 bit + +Indicates whether multiplexing without RTP header compression is supported or not by the sender of the RTCP packet : set to 0 if not supported, set to 1 if supported. + +- multiplexing with RTP header compression bit (CP), 1 bit + +Indicates whether multiplexing with RTP header compression is supported or not by the sender of the RTCP packet : set to 0 if not supported, set to 1 if supported. + +- Selection bits, 2 bits + +Indicates whether the sender of the RTCP packet has selected to apply multiplexing with or without header compression for the user plane packets that it sends on this connection. The following values are defined: + +00: no multiplexing is applied + +01: multiplexing is applied without RTP header compression + +10: multiplexing is applied with RTP header compression + +11: reserved + +- Local MUX UDP port, 15 bits : + +Local UDP port where the sender demands to receive multiplexed data streams. The value shall be the same as the local MUX UDP port divided by two. This parameter shall be ignored by the receiver of the RTCP Multiplexing packet if the MUX and CP bits indicate that multiplexing is not supported. + +- Reserved bits: + +Extension bits may be added in the RTCP Multiplexing packet in future releases. Reserved bits shall be set to 0 in sent RTCP Multiplexing packet of this release and shall be ignored in incoming RTCP Multiplexing packets. + +Extension fields may be added in the RTCP Multiplexing packet in future releases. They shall be ignored by a MGW implementing an earlier version of the specification. + +# --- 7 Transport over IP for SIP-I based Nc + +## 7.1 General + +Clause 7 is only applicable in combination with SIP-I based Nc. + +IPv4 (RFC 791 [23]) shall be supported. IPv6 (RFC 2460 [27]) may be supported. + +RTP (RFC 1889 [24] or RFC 3551 [29]) over UDP (RFC 768 [22]) over either IPv4 (RFC 791 [23]) or IPv6 (RFC 2460 [27]) shall be used in the transport network user plane. Figure 4 in Clause 6.1 shows the protocol stack for the transport network user plane on the Nb interface. + +## 7.2 Bearer Transport without multiplexing + +### 7.2.0 Introduction + +See 6.2.0 + +### 7.2.1 IP + +See 6.2.1 + +### 7.2.2 UDP + +See 7.2.2 + +### 7.2.3 RTP + +RTP (see RFC 1889 [24] or RFC 3550 [30]) shall be applied. + +#### 7.2.3.1 RTP Header + +The RTP Header Fields shall be used as described in the following subclauses: + +##### 7.2.3.1.1 Version + +RTP Version 2 shall be used. + +##### 7.2.3.1.2 Padding + +Padding shall not be used. + +##### 7.2.3.1.3 Extension + +The extension bit shall be used as specified for the RTP profile applicable for the used payload. + +##### 7.2.3.1.4 Contributing Source (CSRC) count + +There are zero CSRCs. + +##### 7.2.3.1.5 Marker Bit + +The marker bit shall be used as specified for the RTP profile applicable for the used payload. + +##### 7.2.3.1.6 Payload Type + +The payload type shall be set as negotiated by means of SIP-I and supplied over the Mc interface. + +##### 7.2.3.1.7 Sequence Number + +The sequence number shall be supplied by the source MGW of a RTP PDU. + +##### 7.2.3.1.8 Timestamp + +The timestamp shall be supplied by the source MGW of a RTP PDU. + +##### 7.2.3.1.9 Synchronisation Source (SSRC) + +The source MGW of a RTP PDU shall supply a SSRC. + +##### 7.2.3.1.10 CSRC list + +This list is empty. + +#### 7.2.3.2 RTP Payload + +Speech in various encodings packed in corresponding RTP payload types may be transported as RTP Payload, as further specified in TS 26.102 [32]. Data and fax packed in corresponding RTP payload types may also be transported as RTP Payload, as further specified in 3GPP TS 29.007 [36]. + +NOTE: The Nb framing protocol specified in 3GPP TS 29.415 [3] is not applicable. + +### 7.2.4 RTCP + +The use of the RTCP (see RFC 1889 [24] or RFC 3551 [29]) protocol is optional, unless the RTP payload profile of the transported payload requires RTCP. + +A MGW may ignore incoming RTCP PDUs, unless the RTP payload profile of the transported payload requires some usage of RTCP + +Figure 5 in Clause 6.2.4 shows the protocol stack for the transport of RTCP. The above Sections about IP and UDP shall also apply for the transport of RTCP. + +## 7.3 Bearer Transport with multiplexing + +### 7.3.1 Introduction + +See Clause 6.4.1 + +### 7.3.2 Transport format + +#### 7.3.2.1 IP + +See Clause 6.4.2.1 + +#### 7.3.2.2 UDP + +See Clause 6.4.2.2 + +#### 7.3.2.3 Transport Format for multiplexing without RTP Header Compression + +See Clause 6.4.2.3. + +However, instead of RTP/NbFP/codec payload PDUs, RTP/codec payload PDUs shall be transported. The RTP header and the RTP payload shall follow the rules in sub-clause 7.2.3. + +#### 7.3.2.4 Transport Format for multiplexing with RTP header compression + +RTP header compression for Nb bearers with SIP-I based Nc shall be applied as specified in sub-clause 6.4.2.4 for Nb bearers with BICC-based Nc, with the exceptions specified in the present Clause. + +The transport format additionally includes the marker bit (bit M) and the payload type (PT), which can vary dependent on the transported payload. + +| Bits | | | | | | | | Number of Octets | | | | | | | | | +|----------------------------------------------------|--------------------------------------------------------|---|---|---|---|---|---|------------------|------------------------------|--|--|--|--|--|--|--| +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | | | | | | | | | | +| Source IP, Dest IP, ... | | | | | | | | 20/40 | IP | | | | | | | | +| Source Port, Dest Port=, Length, ... | | | | | | | | 8 | UDP | | | | | | | | +| T=1 | Mux ID = (Destination UDP Port of multiplexed PDU) / 2 | | | | | | | 2 | Multiplex Header | | | | | | | | +| Length Indicator (LI) = n+ 4 | | | | | | | | 1 | | | | | | | | | +| R | Source ID = (Source UDP Port of multiplexed PDU) / 2 | | | | | | | 2 | | | | | | | | | +| Sequence Number (SN) | | | | | | | | 1 | Compressed RTP header | | | | | | | | +| Timestamp (TS) | | | | | | | | 2 | | | | | | | | | +| M | Payload Type (PT) | | | | | | | 1 | | | | | | | | | +| RTP payload | | | | | | | | n | RTP NbFP Payload | | | | | | | | +| Multiplex Header | | | | | | | | 5 | Multiplex Header | | | | | | | | +| Compressed RTP header | | | | | | | | 4 | Compressed RTP header | | | | | | | | +| RTP payload | | | | | | | | m | RTP NbFP Payload | | | | | | | | +| ... | | | | | | | | | | | | | | | | | + +**Figure 12: UDP/IP Packet with multiplexed RTP/Nb payload PDUs with RTP header compression** + +The compressed RTP header shall include the following fields taken from the uncompressed RTP header: + +- Sequence number (SN), 8 bits. +- Timestamp (TS), 16 bits. +- Marker bit (M), 1 bit. +- Payload Type (PT), 7 bits + +The usage of these header fields shall follow Clause 7.2.3 + +The Transport Format for multiplexing with RTP header compression shall not be applied for RTP payload types that use an RTP header extension. For RTP payload types that use an RTP header extension, this transport format shall not be offered or accepted in the RTCP multiplexing negotiation. + +### 7.3.3 RTCP + +See Clause 6.4.3 + +## 7.4 Transcoder-less Interworking with the Iu Framing Protocol + +### 7.4.1 Introduction + +![Diagram of Transcoder-less user plane interworking between RTP and Iu FP. The diagram shows a stack of protocols: RTP and UDP on the left, Iu FP on the right, IP and L3, L2 and L2, and L1 and L1. The stack is connected to an Nb interface on the left and an Iu interface on the right, with an MGW (Media Gateway) in the center.](e7c6a6e4c3047dac05a3b92e396e9794_img.jpg) + +| | | +|-----------------------------------------|-------| +| Transcoder-less user plane interworking | | +| RTP | Iu FP | +| UDP | | +| IP | L3 | +| L2 | L2 | +| L1 | L1 | + +The diagram illustrates the protocol stack for Transcoder-less user plane interworking. At the top is a box labeled "Transcoder-less user plane interworking". Below it, the stack consists of two columns. The left column contains RTP, UDP, IP, L2, and L1. The right column contains Iu FP, L3, L2, and L1. The stack is connected to an Nb interface on the left and an Iu interface on the right. A box labeled "MGW" (Media Gateway) is positioned below the stack, between the Nb and Iu interfaces. + +Diagram of Transcoder-less user plane interworking between RTP and Iu FP. The diagram shows a stack of protocols: RTP and UDP on the left, Iu FP on the right, IP and L3, L2 and L2, and L1 and L1. The stack is connected to an Nb interface on the left and an Iu interface on the right, with an MGW (Media Gateway) in the center. + +**Figure 13: Transcoder-less Interworking between IuFP and RTP (optional in the event the codecs on both sides are the same)** + +If no transcoder is inserted, the MGW shall interwork the procedures between the RTP at the Nb interface of the SIP-I based CS CN and the Iu framing protocol (see 3GPP TS 25.415 [31]) at the Iu interface as described in the following Clauses. + +### 7.4.2 Initialisation + +There is no need to interwork IuFP initialisation procedures between Iu interface and the RTP at the Nb interface of the SIP-I based CS CN. + +### 7.4.3 Time alignment + +The purpose of the time alignment procedure on the Iu interface is to minimise the buffer delay in the RNC for downlink transmissions by adjusting the vocoder time reference within the network. No such procedure exists within RTP, so the MGW shall return NACK indication time alignment not supported according to 3GPP TS 25.415 [31]. + +### 7.4.4 Rate control + +#### 7.4.4.1 General + +The rate control procedure signals to the peer entity the maximum rate among the currently allowed rates at which it can receive codec frames. Rate control only applies to AMR, AMR-WB and EVS codec configurations with multiple active modes. For the EVS codec, the rate control procedure also signals to the peer entity the maximum mode among the currently allowed modes at which it can receive codec frames. + +#### 7.4.4.2 Rate control for AMR and AMR-WB + +For AMR and AMR-WB codecs: + +- On the Iu interface, IuFP provides for rate control via the exchange of RATE CONTROL and RATE CONTROL ACK PDUs. +- On the Nb interface of the SIP-I based CS CN, RFC 4867 [35] provides for in-band rate control via the Codec Mode Request (CMR) field of every codec frame. +- Interworking of rate control procedures at an MGW between an Nb interface and a corresponding Iu interface only applies when the MGW bridges compatible codec configurations between the interfaces without applying a transcoding function. +- An MGW receiving a CMR from an Nb interface shall initiate the IuFP rate control procedure on the corresponding Iu interface. +- An MGW receiving a rate control request on an Iu interface shall adjust the CMR field of outgoing speech frames on the corresponding Nb interface. + +#### 7.4.4.3 Rate and Mode control for EVS + +For the EVS codec: + +- On the Iu interface, IuFP provides for rate control via the exchange of RATE CONTROL and RATE CONTROL ACK PDUs. +- On the Iu interface, CMR for EVS (EVS-CMR) as specified in 3GPP TS 26.453 [38] subclause 4.5 provides for in-band rate and mode control via the Codec Mode Request (CMR) field of every codec frame (Speech or SID) and CMR-Only frame. +- On the Nb interface of the SIP-I based CS CN, EVS-CMR as specified in 3GPP TS 26.453 [38] subclause 4.5 provides for in-band rate control via the Codec Mode Request (CMR) field of every codec frame. +- Interworking of rate control procedures at an MGW between an Nb interface and a corresponding Iu interface only applies when the MGW bridges compatible codec configurations between the interfaces without applying a transcoding function. +- An MGW receiving an EVS-CMR from an Nb interface may modify its contents based on local policies and include the resulting contents into the EVS-CMR field of the outgoing speech frame on the corresponding Iu interface. +- An MGW receiving a rate control request and an EVS-CMR on an Iu interface shall determine the lower limit of the maximum bit rates contained in each request and include the resulting limit into the EVS-CMR field of the outgoing speech frame on the corresponding Nb interface, with possible further modifications to the EVS-CMR contents based on configured policies. +- The rules by which the MGW may filter and modify the EVS-CMR contents consist of the following: + - 1) The MGW shall not modify the EVS-CMR to increase the maximum bit rate; + - 2) If the MGW observes the incoming stream of speech frames or packets and determines that a lower EVS mode is more appropriate, the MGW may modify the EVS-CMRs sent in the opposite direction of the observed speech flow; + - 3) If the MGW modifies the EVS-CMR to decrease the maximum bit rate and the resulting maximum bit rate no longer support the originally requested maximum audio bandwidth, then the maximum audio bandwidth may be reduced by the MGW to the next lower one that fits to the reduced maximum bit rate; + - 4) The MGW shall not modify the EVS-CMR in a way that results in a change of the major operation mode (EVS primary mode or EVS AMR-WB IO mode); + +NOTE: The MGW can be forced to change the major operation mode of an incoming EVS-CMR when interworking between EVS and AMR-WB, during handover or after handover. + +- 5) When channel-aware mode is used, if the MGW observes the incoming stream of speech frames or packets and determines that other channel-aware mode parameters are more appropriate, the MGW may modify the EVS-CMRs, flowing in the opposite direction of the observed speech flow to change the received channel-aware offset to a bigger one (e.g. from 2 to 3) and the received channel-aware depth to a lower, more robust one; + +- 6) When channel-aware mode is used, the MGW shall not reduce the received channel-aware offset or modify the received channel-aware depth a less robust one; +- 7) The MGW should not block the channel-aware mode; +- 8) The MGW may modify the EVS primary mode in the received EVS-CMR to the EVS Variable Bit Rate mode. + +#### 7.4.4.4 Interworking of rate control between compatible AMR-WB and EVS codec configurations + +The EVS codec includes the EVS AMR-WB IO major operation mode and is therefore TrFO-compatible to the AMR-WB codec, if the mode-set and mode-change-period parameters are TrFO-compatible. For example, AMR-WB on one MGW termination and EVS on the other MGW termination are TrFO-compatible codecs, if the mode-set parameters are TrFO-compatible and mode-change-period=2 on both sides. + +If the MGW bridges compatible EVS codec configurations and AMR-WB codec configurations: + +- If the codec of the incoming termination is EVS and the codec of the outgoing termination is AMR-WB, then the rate control procedure for AMR-WB shall apply at the outgoing termination, with the maximum rate equal to or lower than the maximum rate received in the EVS-CMR. The MGW shall map received EVS-CMRs to the selected mode-set of the outgoing AMR-WB termination. + +NOTE: In this interworking scenario, the incoming EVS-CMR should request AMR-WB IO mode of operation. + +- If the codec of the incoming termination is AMR-WB and the codec of the outgoing termination is EVS, then the rate control procedure for AMR-WB shall apply on the incoming termination and shall determine the maximum rate included in the CMR sent by the MGW. The MGW shall request the EVS AMR-WB IO major operation mode in the outgoing CMR. +- The MGW may filter and modify the CMR contents according to the following rules: + - 1) The MGW shall not modify the EVS-CMR to increase the maximum bit rate; + - 2) If the MGW observes the incoming stream of speech frames or packets and determines that a lower EVS mode is more appropriate, the MGW may modify the EVS-CMRs sent in the opposite direction of the observed speech flow. + +If the MGW bridges EVS codec configurations and AMR-WB codec configurations which are not compatible, the MGW shall apply transcoding and shall handle the independent rate and mode control procedures towards the incoming and the outgoing networks. + +### 7.4.5 Frame quality indication + +The Iu framing protocol signals frame quality with the Frame Quality Classification (FQC) field of each speech frame PDU. See 3GPP TS 26.102 [32] and 3GPP TS 25.415 [31] for details. The FQC may have possible values: 0=frame\_good; 1=frame\_bad; 2=frame\_bad\_due\_to\_radio; and 3=spare. The RTP AMR, AMR-WB or EVS payload at the Nb interface signals frame quality with the Q bit (frame quality indicator) field of each speech frame, as defined in RFC 4867 [35]. The Q bit may have values: 1=speech\_good; and 0=speech\_bad or sid\_bad. + +Tables 1 and 2 provide the mapping between Nb and Iu interfaces. + +**Table 1: Mapping of Nb RTP profile Qbit onto Iu FQC** + +| Nb RTP profile Qbit | Nb RTP profile FT | Iu - FQC | +|---------------------|-------------------|----------| +| 1 | x | 0 | +| 0 | x | 1 | + +**Table 2: Mapping Iu FQC onto Nb RTP profile Qbit** + +| Iu - FQC | Nb RTP profile Qbit | Nb RTP profile FT | +|-----------------|----------------------------|--------------------------| +| 0 | 1 | NC | +| 1 | 0 | NO DATA | +| 2 | 0 | NC | + +### 7.4.6 Framing + +Even when the MGW bridges compatible codec configurations between the Nb and Iu interfaces, the MGW shall perform translation between the frame formats defined for the two interfaces, since all codec configurations have different framing procedures for the two interfaces. The framing details for Iu are defined in 3GPP TS 26.102 [32] and 3GPP TS 25.415 [31], although they do not describe the framing for ITU-T codecs other than G.711. The framing details for Nb are defined in IETF RFC 4867 [35], IETF RFC 3550 [29], IETF RFC 3551 [33] and IETF RFC 3555 [34]. + +### 7.4.7 Transcoding + +Transcoding at the MGW is avoided when the MGW bridges compatible codec configurations between the Nb and Iu interfaces. Otherwise transcoding is necessary, which eliminates the need to interwork other user plane procedures between the interfaces. + +### 7.4.8 Discontinuous transmission + +When the MGW bridges compatible codec configurations between the Nb and Iu interfaces, the DTX procedures are normally interworked transparently by translating between the framing formats on the interfaces. All the ITU-T. AMR, AMR-WB and EVS codecs have configurations that are compatible between the Iu and Nb interfaces. + +For the AMR, AMR-WB and EVS codecs, DTX is always enabled on the CS radio Interface in the uplink direction and the transport channel for DTX in the downlink is always provided. + +### 7.4.9 Timing and sequence information + +The MGW shall always correct out-of-sequence delivery between Nb and Iu interfaces, either by re-ordering frames, or by dropping frames that are out of sequence. + +When the IuFP frame numbers are based on time and if the MGW bridges compatible codec configurations between the Nb and Iu interfaces, it shall either correct jitter before forwarding PDUs or interwork the RTP timestamp (see RFC 3550 [29]) with the IuFP Frame Number (see 3GPP TS 25.415 [31]) so that both the RTP timestamp and IuFP frame number similarly reflect the nominal sampling instant of the user data in the packet. + +NOTE: Correcting jitter may cause additional delay. + +The RTP sequence number (see RFC 3550 [29]) is handled independently on Nb, i.e. it is not interworked with the IuFP Frame Number (see 3GPP TS 25.415 [31]). + +# Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|--------|-----------|------|------|-------------------------------------------------------------|--------------------------------------------------|--------| +| Date | TSG # | TSG Doc. | CR | R ev | Subject/Comment | Old | New | +| 03-2001 | TSG#11 | NP-010215 | | | Approved as Version 4.0.0 to be placed under Change Control | 2.1.0 | 4.0.0 | +| 06-2001 | TSG#12 | NP-010257 | 001 | | Editorial Clarifications in 29.414 and IANA registration | 4.0.0 | 4.1.0 | +| 09-2001 | TSG#13 | NP-010439 | 003 | 2 | Transport of data in the luFP | 4.1.0 | 4.2.0 | +| 12-2001 | TSG#14 | NP-010573 | 004 | | Correction of inconsistency regarding RTP clock frequency | 4.2.0 | 4.3.0 | +| 12-2001 | TSG#14 | NP-010573 | 005 | 1 | Correction to Scope clause | 4.2.0 | 4.3.0 | +| 03-2002 | TSG#15 | NP-020082 | 006 | | Update Reference to I.363.2 | 4.3.0 | 4.4.0 | +| 03-2002 | TSG#15 | NP-020085 | 007 | | Add GERAN lu mode to scope | 4.3.0 | 5.0.0 | +| 04-2004 | TSG#26 | | | | Upgraded to v6.0.0 | 5.0.0 | 6.0.0 | +| 12-2005 | TSG#30 | CP-050517 | 018 | 2 | 20 ms packetisation time for PCM coded speech over IP Nb | 6.0.0 | 7.0.0 | +| 12-2006 | TSG#34 | CP-060620 | 026 | 2 | RTP Timestamp | 7.0.0 | 7.1.0 | +| 03-2007 | TSG#35 | CP-070106 | 027 | 3 | Multiplexing at Nb interface with IP transport | 7.1.0 | 7.2.0 | +| 03-2008 | TSG#39 | CP-080044 | 033 | 2 | Adding RTP Transport used by SIP-I | 7.2.0 | 8.0.0 | +| 05-2008 | TSG#40 | CP-080308 | 034 | 2 | Mandatory support of IPv4 on SIP-I based Nb interface | 8.0.0 | 8.1.0 | +| 05-2008 | TSG#40 | CP-080309 | 035 | 2 | Framing Protocol Interworking | 8.0.0 | 8.1.0 | +| 12-2008 | TSG#42 | CP-080754 | 036 | 1 | Reference to RTP payload types | 8.1.0 | 8.2.0 | +| 03-2009 | TSG#43 | CP-090076 | 038 | | Corrections on description of multiplexing | 8.2.0 | 8.3.0 | +| 12-2009 | TSG#46 | | | | Automatic upgrade from previous Release | 8.3.0 | 9.0.0 | +| 03-2011 | TSG#51 | | | | Automatic upgrade from previous Release version 9.0.0 | 9.0.0 | 10.0.0 | +| 03-2011 | TSG#51 | | | | Correction of heading and numbering made by MCC | 10.0.0 | 10.0.1 | +| 04-2011 | TSG#51 | | | | Further corrections | 10.0.1 | 10.0.2 | +| 09-2012 | TSG#57 | | | | Automatic upgrade from previous Release version 10.0.2 | 10.0.2 | 11.0.0 | +| 2014-10 | | | | | Automatic upgrade from previous Release | 11.0.0 | 12.0.0 | +| 2015-12 | TSG#70 | CP-150648 | 0039 | 3 | Update of TS 29.414 to support EVS over UMTS CS | 12.0.0 | 13.0.0 | +| Change history | | | | | | | | +| Date | TSG # | TSG Doc. | CR | Rev | Cat | Subject/Comment | New | +| 2016-03 | CT#71 | CP-160112 | 0040 | 1 | B | Resolution of Editor's notes on EVS over UMTS CS | 13.1.0 | +| 2016-12 | CT#74 | CP-160617 | 0041 | 1 | F | Updates to EVS over CS aspects | 13.2.0 | +| 2017-03 | CT#75 | | | | | Automatic upgrade from previous Release | 14.0.0 | +| 2018-06 | SA#80 | - | - | - | | Automatic upgrade from previous Release | 15.0.0 | +| 2020-07 | SA#88e | - | - | - | | Update to Rel-16 version (MCC) | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29415/573c8f9e728e343b6864e1070c14b8cf_img.jpg b/marked/Rel-16/29_series/29415/573c8f9e728e343b6864e1070c14b8cf_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..aecc7bfd7d1228a9d75406421fb9c559887127d8 --- /dev/null +++ b/marked/Rel-16/29_series/29415/573c8f9e728e343b6864e1070c14b8cf_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:66ccd9c21a3eb29bdbbd8a5993a0efd8b3c3cbbcfc1a1ec29ec5e16049c61f7d +size 41589 diff --git a/marked/Rel-16/29_series/29415/65550960f5c5afd9d27706aaeddb0638_img.jpg b/marked/Rel-16/29_series/29415/65550960f5c5afd9d27706aaeddb0638_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1c7468645845b5221ce3d6767899c79701fc30cf --- /dev/null +++ b/marked/Rel-16/29_series/29415/65550960f5c5afd9d27706aaeddb0638_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:85a4f6dd51dede00627789ee445e365a09341fa3fa7eaf6c110e315fe9b2fb76 +size 46565 diff --git a/marked/Rel-16/29_series/29415/d0abac95583b52a3b35f74a215567334_img.jpg b/marked/Rel-16/29_series/29415/d0abac95583b52a3b35f74a215567334_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f65ea1b1adb27b4ca75568dafdf25978a255ac87 --- /dev/null +++ b/marked/Rel-16/29_series/29415/d0abac95583b52a3b35f74a215567334_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:dc34741a495c3512df68743e1c055cf31bc5898b63b029bca369300e04797a2f +size 53459 diff --git a/marked/Rel-16/29_series/29415/raw.md b/marked/Rel-16/29_series/29415/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..6dcb6c9f03d593b7054c4625269852b4bcb81900 --- /dev/null +++ b/marked/Rel-16/29_series/29415/raw.md @@ -0,0 +1,468 @@ + + + + + + +# Contents + +| | | +|----------------------------------------------------------------------------------------------------|----| +| Foreword ..... | 5 | +| Introduction ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions, symbols and abbreviations..... | 7 | +| 3.1 Definitions..... | 7 | +| 3.2 Symbols..... | 7 | +| 3.3 Abbreviations ..... | 7 | +| 4 User Plane ..... | 7 | +| 4.1 General aspects..... | 7 | +| 4.2 Operational and Functional Aspects ..... | 8 | +| 5 Transparent Mode ..... | 8 | +| 6 Support mode for predefined SDU sizes..... | 8 | +| 6.1 General ..... | 8 | +| 6.2 Nb UP protocol layer services in Support Mode..... | 8 | +| 6.3 Services expected from the Transport Network Layer..... | 8 | +| 6.4 Functions of the Nb UP protocol layer in Support Mode ..... | 9 | +| 6.4.1 Functional model of the Nb UP protocol layer in Support Mode ..... | 9 | +| 6.4.2 Frame handler function..... | 9 | +| 6.4.3 Procedure control functions..... | 9 | +| 6.4.4 Non Access Stratum data streams specific functions ..... | 9 | +| 6.4.4.1 Frame quality classification ..... | 9 | +| 6.4.4.1.1 General ..... | 9 | +| 6.4.4.1.2 Handling of FQC information ..... | 10 | +| 6.5 Elementary procedures..... | 10 | +| 6.5.1 Transfer of User Data procedure ..... | 10 | +| 6.5.1.1 Successful operation ..... | 10 | +| 6.5.1.2 Unsuccessful operation ..... | 10 | +| 6.5.2 Initialisation procedure ..... | 10 | +| 6.5.2.1 Successful operation ..... | 10 | +| 6.5.2.2 Unsuccessful operation..... | 11 | +| 6.5.3 Rate Control..... | 11 | +| 6.5.3.1 Successful operation ..... | 11 | +| 6.5.3.1.1 Rate control for codecs other than the EVS codec..... | 11 | +| 6.5.3.1.2 Rate and mode control for the EVS codec ..... | 11 | +| 6.5.3.1.3 Interworking of rate control between compatible AMR-WB and EVS codec configurations..... | 12 | +| 6.5.3.2 Unsuccessful operation ..... | 12 | +| 6.5.4 Time Alignment..... | 13 | +| 6.5.4.1 Successful operation ..... | 13 | +| 6.5.4.2 Unsuccessful operation..... | 13 | +| 6.5.5 Handling of Error Event procedure ..... | 13 | +| 6.5.5.1 Successful operation ..... | 13 | +| 6.5.5.2 Unsuccessful operation..... | 13 | +| 6.6 Elements for Nb UP communication in Support mode..... | 13 | +| 6.7 Handling of unknown, unforeseen and erroneous protocol data..... | 13 | +| 7 Communication Primitives for the Nb UP protocol layer..... | 13 | +| 7.1 Modelling Principle..... | 13 | +| 7.2 Primitives towards the upper layers at the CNL-SAP..... | 13 | +| 7.3 Primitives towards the transport layers at TNL-SAP..... | 13 | +| 7.3.1 General ..... | 13 | +| 7.3.2 ATM/AAL2 based Transport Layer..... | 14 | +| 7.3.2.1 General..... | 14 | +| 7.3.2.2 AAL2 Service Primitives used by the Nb UP protocol ..... | 14 | +| 7.3.3 GTP-U based Transport Layer ..... | 14 | + +7.3.4 RTP/UDP/IP based Transport Layer ..... 14 +8 Evolution of Nb UP Protocol ..... 14 +Annex A (informative): Change history..... 15 + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +The present document specifies the user plane protocol used between two Media Gateways in the CS core network. Through out the present document this protocol shall be referred to as the Nb UP protocol. The Nb UP protocol is for a large part identical to the Iu UP protocol (see 3GPP TS 25.415 [2]), and only the differences between the two protocols are specified. This specification defines the applicability of the UP, as defined in 3GPP TS 25.415 [2], for the Nb interface only. + +Given that the Nb UP uses the same PDU types as the Iu UP, the term IuFP is used to refer to the common framing. + +For the purpose of the present document, any occurrence of the term "Iu UP" in the corresponding sections of 3GPP TS 25.415 [2], shall be interpreted as "Nb UP". + +# 1 Scope + +The present document specifies the user plane protocol of the bearer used between two MGWs within the BICC-based CS core network, called the Nb UP protocol. The present document assumes the implementation of the split between call control and the bearer transport and control, as specified in 3GPP TS 23.205 [1], see figure 1. Note that the present document does not preclude an implementation of a combined MSC Server and MGW. + +![Figure 1: CS core network logical architecture diagram. The diagram shows a UTRAN/GERAN Iu mode connected to an MGW via an Iu interface. A GERAN A/Gb mode is connected to an MSC server via an A interface. The MGW and MSC server are connected by a dashed line labeled 'Mc'. The MGW is connected to another MGW via an Nb interface. The second MGW is connected to a PSTN/Legacy/External network. The second MGW and a GMSC server are connected by a dashed line labeled 'Mc'. The MSC server and GMSC server are connected by a dashed line labeled 'Nc'. A legend indicates that dashed lines represent 'Signalling Interface' and solid lines represent 'Signalling and Data Transfer Interface'.](573c8f9e728e343b6864e1070c14b8cf_img.jpg) + +Figure 1: CS core network logical architecture diagram. The diagram shows a UTRAN/GERAN Iu mode connected to an MGW via an Iu interface. A GERAN A/Gb mode is connected to an MSC server via an A interface. The MGW and MSC server are connected by a dashed line labeled 'Mc'. The MGW is connected to another MGW via an Nb interface. The second MGW is connected to a PSTN/Legacy/External network. The second MGW and a GMSC server are connected by a dashed line labeled 'Mc'. The MSC server and GMSC server are connected by a dashed line labeled 'Nc'. A legend indicates that dashed lines represent 'Signalling Interface' and solid lines represent 'Signalling and Data Transfer Interface'. + +Figure 1: CS core network logical architecture + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TS 23.205: "Bearer Independent CS Core Network; Stage 2" +- [2] 3GPP TS 25.415: "UTRAN Iu Interface User Plane Protocols" +- [3] 3GPP TS 29.232: "Media Gateway Controller; Media Gateway interface; Stage 3" +- [4] 3GPP TS 29.414: "Core Network Nb Data Transport and Transport Signalling" +- [5] 3GPP TR 41.001: "GSM Release specifications" +- [6] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications" +- [7] IETF RFC 1889: "RTP A Transport Protocol for Real Time Applications" +- [8] ITU-T I.366.1 (06/98): "Segmentation and Reassembly Service Specific Convergence Sublayer for the AAL type 2" +- [9] 3GPP TS 26.445: "Codec for Enhanced Voice Services (EVS); Detailed Algorithmic Description". +- [10] 3GPP TS 26.453: "Codec for Enhanced Voice Services (EVS); Speech codec frame structure". +- [11] 3GPP TS 26.454: "Codec for Enhanced Voice Services (EVS); Interface to Iu, Uu, Nb and Mb". + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +Definitions used in the present document are listed in 3GPP TR 21.905 [6]. + +## 3.2 Symbols + +For the purposes of the present document, the following symbols apply: + +| | | +|------|---------------------------------------------------------------------------------------------| +| Iu | Interface between the RNS and the core network. It is also considered as a reference point. | +| Nb | Interface between media gateways. | +| IuFP | Iu Framing protocol | + +## 3.3 Abbreviations + +For the purposes of the present document, the following abbreviations apply: + +| | | +|---------|----------------------------------| +| AAL | ATM Adaptation Layer | +| AAL2 | AAL Type 2 | +| ATM | Asynchronous Transfer Mode | +| CMR | Codec Mode Request | +| CN | Core Network | +| CNL | Core Network Layer | +| CS | Circuit Switched | +| EVS | Enhanced Voice Services | +| EVS-CMR | Codec Mode Request for EVS | +| FFS | For Further Study | +| IPTI | Inter PDU Transmission Interval | +| Iu UP | Iu interface User Plane | +| MGW | Media GateWay | +| PDU | Protocol Data Unit | +| RTP | Real-time Transmission Protocol | +| SAP | Service Access Point | +| SDU | Service Data Unit | +| SRNC | Serving Radio Network Controller | + +# --- 4 User Plane + +## 4.1 General aspects + +The Nb UP is located in the user plane of the CS core network over the Nb interface. It is used to convey data between MGWs. + +The Nb UP protocol shall be initiated at one MGW and acknowledged by the adjoining MGW. + +The Nb UP framing is identical to the Iu UP framing, i.e., the same PDU types are valid for both protocols. + +Figure 2 shows the logical location of the Nb UP protocol layer in relation to the Nb interface. + +![Figure 2: Nb UP protocol layer occurrence in overall architecture. The diagram shows three vertical sections representing network elements: SRNC, MGW, and MGW. The SRNC section contains 'Radio Protocols' and 'Iu UP'. The first MGW section contains 'Iu UP' and 'Nb UP'. The second MGW section contains 'Nb UP'. Vertical dashed lines labeled 'Iu' and 'Nb' separate the sections. A vertical double-headed arrow on the right is labeled 'Transport Layer'.](d0abac95583b52a3b35f74a215567334_img.jpg) + +Figure 2: Nb UP protocol layer occurrence in overall architecture. The diagram shows three vertical sections representing network elements: SRNC, MGW, and MGW. The SRNC section contains 'Radio Protocols' and 'Iu UP'. The first MGW section contains 'Iu UP' and 'Nb UP'. The second MGW section contains 'Nb UP'. Vertical dashed lines labeled 'Iu' and 'Nb' separate the sections. A vertical double-headed arrow on the right is labeled 'Transport Layer'. + +**Figure 2: Nb UP protocol layer occurrence in overall architecture.** + +## 4.2 Operational and Functional Aspects + +There are two modes of operation for the Nb UP: + +- Transparent mode; +- Support mode for predefined SDU size. + +The two modes of operation follow the definition of the corresponding Iu UP modes of operation, as described in 3GPP TS 25.415 [2]. + +Support mode version 2 is mandatory on the NbUP interface. Support mode version 1 is not required at the Nb but may be used if both MGWs support it, as a result of the version negotiation during the Initialisation procedure. + +# --- 5 Transparent Mode + +This mode of operation is identical to that of the Iu UP protocol, see the corresponding section in 3GPP TS 25.415 [2]. + +# --- 6 Support mode for predefined SDU sizes + +## 6.1 General + +See the corresponding section in 3GPP TS 25.415 [2]. + +## 6.2 Nb UP protocol layer services in Support Mode + +See the corresponding section in 3GPP TS 25.415 [2]. + +## 6.3 Services expected from the Transport Network Layer + +See the corresponding section in 3GPP TS 25.415 [2]. + +## 6.4 Functions of the Nb UP protocol layer in Support Mode + +### 6.4.1 Functional model of the Nb UP protocol layer in Support Mode + +See the corresponding section in 3GPP TS 25.415 [2]. + +### 6.4.2 Frame handler function + +See the corresponding section in 3GPP TS 25.415 [2]. + +### 6.4.3 Procedure control functions + +See the corresponding section in 3GPP TS 25.415 [2]. + +### 6.4.4 Non Access Stratum data streams specific functions + +See the corresponding section in 3GPP TS 25.415 [2]. + +#### 6.4.4.1 Frame quality classification + +##### 6.4.4.1.1 General + +On the Nb UP in Support Mode the frames are classified with the Frame Quality Classifier (FQC). This classifying is based on frame classification on the preceding link and the setting of the attribute "Delivery of erroneous SDUs". The MSC server shall indicate the value of the attribute "Delivery of erroneous SDUs" see 3GPP TS 29.232 [3]. + +Figure 4 shows the main input and output information for the frame quality classification function on the Nb UP. + +![Diagram of frame quality classification in Nb UP showing data flow between two MGW units via an Nb interface.](65550960f5c5afd9d27706aaeddb0638_img.jpg) + +The diagram illustrates the frame quality classification process across two Media Gateway (MGW) units connected via an Nb interface. Each MGW contains a 'Support mode functions' block. Data flows from an upper entity through a CNL-SAP into the 'Support mode functions' block, and then through a TNL-SAP into the Nb interface. The Nb interface carries 'FQC, CRC' information between the two MGWs. On the receiving MGW, data flows from the Nb interface through a TNL-SAP, then through the 'Support mode functions' block, and finally out through a CNL-SAP as 'SDU, and new FQC = result of (old FQC; CRC)'. + +Diagram of frame quality classification in Nb UP showing data flow between two MGW units via an Nb interface. + +Figure 4: Frame quality classification in Nb UP + +##### 6.4.4.1.2 Handling of FQC information + +The handling of FQC shall be as specified in Table 1. + +**Table 1. FQC handling in Nb UP protocol, receiving side** + +| Input | | | Action | +|------------------------------------|-----------------------|-------------|---------------------------------------------------------| +| Delivery of erroneous SDUs | FQC in received PDU | Payload CRC | | +| 'yes' or 'no' | 'good' | OK | Leave FQC unchanged. Forward SDU and FQC to upper layer | +| 'yes' | 'bad radio' | OK | Leave FQC unchanged. Forward SDU and FQC to upper layer | +| 'yes' | 'good' or 'bad radio' | Not OK | Set FQC to 'bad'. Forward SDU and FQC to upper layer | +| 'yes' | 'bad' | Any | Leave FQC unchanged. Forward SDU and FQC to upper layer | +| 'no' | 'good' | Not OK | Drop SDU | +| 'no' | 'bad' or 'bad radio' | Any | Not applicable. SDUs are dropped at a previous link. | +| 'no-error-detection-consideration' | Any | Any | Leave FQC unchanged. Forward SDU and FQC to upper layer | + +The FQC handling in the Nb UP protocol entity on the sending side is as follows: + +- When the upper layer indicates an FQC value in the Nb-UP-DATA-Request message, an FQC shall be set in the PDU as indicated by the upper layer. If the upper layer does not indicate an FQC value, the FQC in the PDU shall be set to 'good'. +- When the upper layer indicates an FQC with the value 'bad' to the Nb UP protocol layer, the Nb UP support functions may generate an erroneous payload CRC. + +An MGW may ignore the settings of the "delivery of erroneous SDUs" property of the 3GUP package if the MGW passes frames transparently through the UP entities as described in 3GPP TS 29.232 [3]. + +## 6.5 Elementary procedures + +### 6.5.1 Transfer of User Data procedure + +#### 6.5.1.1 Successful operation + +See the corresponding section in 3GPP TS 25.415 [2]. For the purpose of the present document, the MGW replaces the function of the SRNC and the CN, and the Nb replaces the function of the Iu. + +When the MGW provides the Frame Number IE it shall be based on time according to the handling on Iu (see 3GPP TS 25.415 [2]) for conversational and streaming traffic class. + +NOTE: The IuUP Frame Number IE is based on time also and therefore no interworking of this IE is required. + +#### 6.5.1.2 Unsuccessful operation + +See the corresponding section in 3GPP TS 25.415 [2]. For the purpose of the present document, the MGW replaces the function of the SRNC and the CN, and the Nb replaces the function of the Iu. + +### 6.5.2 Initialisation procedure + +#### 6.5.2.1 Successful operation + +See the corresponding section in 3GPP TS 25.415 [2]. + +For the EVS codec, Equal Error Protection (EEP) is applied on the radio interface. Only class A bits are defined. Class B and Class C bits are not present. Consequently each RAB sub-flow Combination Indication (RFCI) corresponds to one bit rate of the selected EVS Configuration, as described in 3GPP TS 26.454 [11] subclause 5. + +When an Nb UP layer protocol entity receives an initialisation status request from the upper layer, it shall start the initialisation procedure. See 3GPP TS 29.232 [3], concerning the overall initialisation process. When an Nb UP layer protocol entity receives an initialisation message it shall acknowledge this message and indicate to the upper layer that + +an initialisation message has been received. When an Nb UP layer protocol entity receives a positive initialisation acknowledgement it shall indicate to the upper layer that a positive initialisation acknowledgement has been received. + +#### 6.5.2.2 Unsuccessful operation + +See the corresponding section in 3GPP TS 25.415 [2]. A negative acknowledgement triggers a repetition of the initialisation message. After NINIT unsuccessful repetitions, the initialisation procedure is terminated. + +### 6.5.3 Rate Control + +#### 6.5.3.1 Successful operation + +##### 6.5.3.1.1 Rate control for codecs other than the EVS codec + +See the corresponding section in 3GPP TS 25.415 [2]. When an Nb UP protocol entity receives a rate control message over the Nb interface, it shall provide an indication of the rate control to the upper layer. The rate control indication is acknowledged on request from the upper layer. + +##### 6.5.3.1.2 Rate and mode control for the EVS codec + +For the EVS codec: + +- On the Iu interface, IuFP provides for rate control via the exchange of RATE CONTROL and RATE CONTROL ACK PDUs. +- On the Iu interface, CMR for EVS (EVS-CMR) as specified in 3GPP TS 26.453 [10] subclause 4.5 provides for in-band rate and mode control via the Codec Mode Request (CMR) field of every codec frame (Speech or SID) and CMR-Only frame. +- On the Nb interface of the BICC-based CS CN, EVS-CMR as specified in 3GPP TS 26.453 [10] subclause 4.5 provides for in-band rate and mode control via the Codec Mode Request (CMR) field of every codec frame. +- A MGW receiving an EVS-CMR over an Nb interface may modify its contents based on local policies and include the resulting contents into the EVS-CMR field of the outgoing speech frame on the Nb interface. +- Interworking of rate control procedures at an MGW between an Nb interface and a corresponding Iu interface only applies when the MGW bridges compatible codec configurations between the interfaces without applying a transcoding function. +- A MGW receiving an EVS-CMR from an Nb interface may modify its contents based on local policies and include the resulting contents into the EVS-CMR field of the outgoing speech frame on the corresponding Iu interface. +- An MGW receiving a rate control request and an EVS-CMR on an Iu interface shall determine the lower limit of the maximum bit rates contained in each request and include the resulting limit into the EVS-CMR field of the outgoing speech frame on the corresponding Nb interface, with possible further modifications to the EVS-CMR contents based on configured policies. +- The rules by which the MGW may filter and modify the EVS-CMR contents consist of the following: + - 1) The MGW shall not modify the EVS-CMR to increase the maximum bit rate; + - 2) If the MGW observes the incoming stream of speech frames or packets and determines that a lower EVS mode is more appropriate, the MGW may modify the EVS-CMRs sent in the opposite direction of the observed speech flow; + - 3) If the MGW modifies the EVS-CMR to decrease the maximum bit rate and the resulting maximum bit rate no longer support the originally requested maximum audio bandwidth, then the maximum audio bandwidth may be reduced by the MGW to the next lower one that fits to the reduced maximum bit rate; + - 4) The MGW shall not modify the EVS-CMR in a way that results in a change of the major operation mode (EVS primary mode or EVS AMR-WB IO mode); + +NOTE: The MGW can be forced to change the major operation mode of an incoming EVS-CMR when interworking between EVS and AMR-WB, during handover or after handover. + +- 5) When channel-aware mode is used, if the MGW observes the incoming stream of speech frames or packets and determines that other channel-aware mode parameters are more appropriate, the MGW may modify the EVS-CMRs, flowing in the opposite direction of the observed speech flow to change the received channel-aware offset to a bigger one (e.g. from 2 to 3) and the received channel-aware depth to a lower, more robust one; +- 6) When channel-aware mode is used, the MGW shall not reduce the received channel-aware offset or modify the received channel-aware depth a less robust one; +- 7) The MGW should not block the channel-aware mode; +- 8) The MGW may modify the EVS primary mode in the received EVS-CMR to the EVS Variable Bit Rate mode. + +##### 6.5.3.1.3 Interworking of rate control between compatible AMR-WB and EVS codec configurations + +The EVS codec includes the EVS AMR-WB IO major operation mode and is therefore TrFO-compatible to the AMR-WB codec, if the configurations are TrFO-compatible. For example, AMR-WB on one MGW termination and EVS on the other MGW termination are TrFO-compatible codecs, if the configurations are TrFO-compatible. + +If the MGW bridges compatible EVS codec configurations and AMR-WB codec configurations: + +- If the codec of the incoming termination is EVS and the codec of the outgoing termination is AMR-WB, then the rate control procedure for AMR-WB shall apply at the outgoing termination, with the maximum rate equal to or lower than the maximum rate received in the EVS-CMR. The MGW shall map received EVS-CMRs to the selected configuration of the outgoing AMR-WB termination. +- If the codec of the incoming termination is AMR-WB and the codec of the outgoing termination is EVS, then the rate control procedure for AMR-WB shall apply on the incoming termination and shall determine the maximum rate included in the EVS-CMR sent by the MGW. The MGW shall request the EVS AMR-WB IO major operation mode in the outgoing EVS-CMR. +- The MGW may filter and modify the CMR contents according to the following rules: + - 1) The MGW shall not modify the EVS-CMR to increase the maximum bit rate; + - 2) If the MGW observes the incoming stream of speech frames or packets and determines that a lower EVS mode is more appropriate, the MGW may modify the EVS-CMRs sent in the opposite direction of the observed speech flow. + +If the MGW bridges EVS codec configurations and AMR-WB codec configurations which are not compatible, the MGW shall apply transcoding and shall handle the independent rate and mode control procedures towards the incoming and the outgoing networks. + +#### 6.5.3.2 Unsuccessful operation + +For codecs other than the EVS codec, see the corresponding section in 3GPP TS 25.415 [2]. Depending on the error cause, a negative acknowledgement is either reported in a status indication to the upper layer, or it triggers a repetition of the control command. After $N_{RC}$ unsuccessful repetitions, the rate control procedure is terminated. + +### 6.5.4 Time Alignment + +#### 6.5.4.1 Successful operation + +See the corresponding section in 3GPP TS 25.415 [2]. When an Nb UP protocol entity receives a time alignment command over the Nb interface, it shall indicate the time alignment to the upper layer. The time alignment is acknowledged on request from the upper layer. + +#### 6.5.4.2 Unsuccessful operation + +See the corresponding section in 3GPP TS 25.415 [2]. Depending on the error cause, a negative acknowledgement is either reported in a status indication to the upper layer, or it triggers a repetition of the control command. After $N_{TA}$ unsuccessful repetitions, the time alignment procedure is terminated. + +### 6.5.5 Handling of Error Event procedure + +#### 6.5.5.1 Successful operation + +See the corresponding section in 3GPP TS 25.415 [2]. + +#### 6.5.5.2 Unsuccessful operation + +See the corresponding section in 3GPP TS 25.415 [2]. + +## 6.6 Elements for Nb UP communication in Support mode + +See the corresponding section in 3GPP TS 25.415 [2]. + +## 6.7 Handling of unknown, unforeseen and erroneous protocol data + +See the corresponding section in 3GPP TS 25.415 [2]. + +# --- 7 Communication Primitives for the Nb UP protocol layer + +## 7.1 Modelling Principle + +See the corresponding section in 3GPP TS 25.415 [2]. + +## 7.2 Primitives towards the upper layers at the CNL-SAP + +See the corresponding section in 3GPP TS 25.415 [2]. + +## 7.3 Primitives towards the transport layers at TNL-SAP + +### 7.3.1 General + +Access to the Transport network Layer is performed through a generic SAP: TNL-SAP. + +When the Transport Network upper layer consists of AAL2, the TNL SAP maps to the AAL-SAP which allows communication to be performed using specific AAL primitives. + +When the Transport Network upper layer consists of RTP/UDP/IP, the TNL-SAP maps to the services provided by IETF RFC 1889 [7]. + +The choice of communication, specific or generic, through the TNL-SAP is fixed by the Core Network Layer control plane logic. This choice of communication is based on the requirements placed by, e.g. the RAB characteristics, the core network domain requesting the RAB establishment or other operator's choice. + +### 7.3.2 ATM/AAL2 based Transport Layer + +#### 7.3.2.1 General + +When the Nb UP protocol layer uses the services of an ATM/AAL2 transport, it shall use an established AAL2 connection for transferring frames between the peer TNL-SAPs at both ends of the Nb User plane access points. The Transport Network Control Plane over the Nb interface handles the signalling to establish and release the AAL2 call connections. + +#### 7.3.2.2 AAL2 Service Primitives used by the Nb UP protocol + +AAL2 services and primitives used at the Service Access Point from the AAL2 layer are shown in table 3. + +**Table 4: AAL2 primitives and parameters** + +| Primitive | Type | Parameters | Comments | +|----------------------------------------------------------------------------------------------------------|------------|------------|-----------------| +| SSSAR-UNITDATA | Request | SSSAR-INFO | | +| | | SSSAR-UUI | Not used (note) | +| SSSAR-UNITDATA | Indication | SSSAR-INFO | | +| | | SSSAR-UUI | Not used (note) | +| NOTE: The setting of this field is set to not used i.e. decimal value 26 according to ITU-T Q.366.1 [8]. | | | | + +These primitives are to be used in the Nb UP. + +The Transport Network control plane is as specified in 3GPP TS 29.414 [4]. + +### 7.3.3 GTP-U based Transport Layer + +Not applicable. + +### 7.3.4 RTP/UDP/IP based Transport Layer + +When the Nb UP protocol layer uses the services of an RTP-based transport, it shall use a dynamic payload type that was negotiated for the connection for transferring Nb UP frames between the two endpoints at both ends of the Nb User plane access points. This dynamic payload type is negotiated using the specified bearer control protocol, 3GPP TS 29.414 [4]. + +# 8 Evolution of Nb UP Protocol + +See the corresponding section in 3GPP TS 25.415 [2]. + +# Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|--------|-----------|------|-----|-----------------------------------------------------------------------|--------------------------------------------------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 03-2001 | TSG#11 | NP-010037 | | | Approved as Version 4.0.0 to be placed under Change Control | 2.0.0 | 4.0.0 | +| 09-2001 | TSG#13 | NP-010438 | 001 | 1 | Clarification on FQC handling and alignment with TS 25.415 | 4.0.0 | 4.1.0 | +| 12-2001 | TSG#14 | NP-010573 | 002 | 1 | Correction to Scope clause | 4.1.0 | 4.2.0 | +| 12-2001 | TSG#14 | NP-010573 | 004 | 1 | Reference to Iu UP | 4.1.0 | 4.2.0 | +| 03-2002 | TSG#15 | NP-020085 | 005 | | Add GERAN Iu mode to scope | 4.1.0 | 5.0.0 | +| 03-2003 | TSG#19 | NP-030076 | 007 | 1 | No backward compatibility to Nb UP FP support mode version 1 required | 5.0.0 | 5.1.0 | +| 12-2004 | CN#26 | | | | Upgraded to v6.0.0 | 5.1.0 | 6.0.0 | +| 01-2005 | | | | | Correct typo in version number on cover | 6.0.0 | 6.0.1 | +| 12-2006 | TSG#34 | CP-060619 | 012 | 2 | Time based Nb frame number | 6.0.1 | 6.1.0 | +| 06-2007 | TSG#36 | | | | Upgraded to v7.0.0 | 6.1.0 | 7.0.0 | +| 05-2008 | TSG#40 | CP-080310 | 013 | 2 | NbFP not used for SIP-I based CS CN | 7.0.0 | 8.0.0 | +| 12-2009 | TSG#46 | | | | Automatic upgrade from previous Release | 8.0.0 | 9.0.0 | +| 09-2010 | TSG#49 | CP-100555 | 016 | | Correcting unspecific external reference | 9.0.0 | 9.1.0 | +| 03-2011 | TSG#51 | | | | Automatic upgrade from previous Release version 9.1.0 | 9.1.0 | 10.0.0 | +| 03-2011 | TSG#51 | | | | Correction of heading and numbering made by MCC | 10.0.0 | 10.0.1 | +| 09-2012 | TSG#57 | | | | Automatic upgrade from previous Release version 10.0.1 | 10.0.1 | 11.0.0 | +| 2014-10 | | | | | Automatic upgrade from previous Release | 11.0.0 | 12.0.0 | +| 2015-12 | TSG#70 | CP-150648 | 0017 | 3 | Update of TS 29.415 to support EVS over UMTS CS | 12.0.0 | 13.0.0 | +| Change history | | | | | | | | +| Date | TSG # | TSG Doc. | CR | Rev | Cat | Subject/Comment | New | +| 2016-03 | CT#71 | CP-160112 | 0018 | 1 | B | Resolution of Editor's notes on EVS over UMTS CS | 13.1.0 | +| 2016-12 | CT#74 | CP-160617 | 0019 | 1 | F | Updates to EVS over CS aspects | 13.2.0 | +| 2017-03 | CT#75 | | | | | Automatic upgrade from previous Release | 14.0.0 | +| 2018-06 | SA#80 | - | - | - | - | Automatic upgrade from previous Release | 15.0.0 | +| 2020-07 | SA#88e | - | - | - | | Update to Rel-16 version (MCC) | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29501/26d664119ad25250780f554633444e54_img.jpg b/marked/Rel-16/29_series/29501/26d664119ad25250780f554633444e54_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9818811bf1d391f0c8be46622cd04911389650e7 --- /dev/null +++ b/marked/Rel-16/29_series/29501/26d664119ad25250780f554633444e54_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:46099d9c51238dad77b2dc731620d2d995bcc0fa4e0756272864406dabdcf1b8 +size 42095 diff --git a/marked/Rel-16/29_series/29501/2876be3592c7b4878400b85f209b2b6a_img.jpg b/marked/Rel-16/29_series/29501/2876be3592c7b4878400b85f209b2b6a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0e27455e942ca8be8b68c1c909771bc93578b537 --- /dev/null +++ b/marked/Rel-16/29_series/29501/2876be3592c7b4878400b85f209b2b6a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2be3114cca573624f475856006fda9166bfc26f6bd3ee775342041e3ea46d71a +size 29005 diff --git a/marked/Rel-16/29_series/29501/2ae3eae1bd80a90f192f568ae246a9a6_img.jpg b/marked/Rel-16/29_series/29501/2ae3eae1bd80a90f192f568ae246a9a6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..fa40c50f74505a9bbd3d9fde3b0981337af98e3a --- /dev/null +++ b/marked/Rel-16/29_series/29501/2ae3eae1bd80a90f192f568ae246a9a6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:612845fc9c60b7bae122578d36488719277d65ba769f102bde4ce2e3263fa699 +size 28433 diff --git a/marked/Rel-16/29_series/29501/49a49278cad196bdfe0db6b4dd1be7fd_img.jpg b/marked/Rel-16/29_series/29501/49a49278cad196bdfe0db6b4dd1be7fd_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..32ce2cf161772f65d9ba529f260ab5c90d26f3a2 --- /dev/null +++ b/marked/Rel-16/29_series/29501/49a49278cad196bdfe0db6b4dd1be7fd_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4d69c003fd1f38fe5bd5cc3d2cae2ebaa4e5f2b930dc8d5b2c6703c78548ce91 +size 34350 diff --git a/marked/Rel-16/29_series/29501/55136bc716146672fc680fa05989f1d2_img.jpg b/marked/Rel-16/29_series/29501/55136bc716146672fc680fa05989f1d2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3fbbd426d8c438c569234533450c01844efa481e --- /dev/null +++ b/marked/Rel-16/29_series/29501/55136bc716146672fc680fa05989f1d2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:20e4d5f0915a6ed589976d68db362314bbd94c9b6c4e422bb952ff58d5620e2f +size 26027 diff --git a/marked/Rel-16/29_series/29501/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-16/29_series/29501/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0f664cb858c3f5b6b6a3cfed45c36205a3fe844f --- /dev/null +++ b/marked/Rel-16/29_series/29501/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:943cfd88ab564575e0bfd2b9918b67ea7be3e48eec186f5b8c4398d3b731cdee +size 7762 diff --git a/marked/Rel-16/29_series/29501/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-16/29_series/29501/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..514d743eb6374b107e4dd9dcb15cd5f40f572475 --- /dev/null +++ b/marked/Rel-16/29_series/29501/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:92c8c495f957dbd698a10316c1d6b9f0f0d90fb8045e5a81cb134ab4d0d0feb3 +size 5794 diff --git a/marked/Rel-16/29_series/29501/6629e8a87e7552e2454b7c3e9f6d73a0_img.jpg b/marked/Rel-16/29_series/29501/6629e8a87e7552e2454b7c3e9f6d73a0_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..53cb26bc6f55972ad0886101b5a759ec242564a3 --- /dev/null +++ b/marked/Rel-16/29_series/29501/6629e8a87e7552e2454b7c3e9f6d73a0_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0c76ab18934db766de8bcfcbef158bf94b9cd75a4197677eeec9521ab2b45b51 +size 177580 diff --git a/marked/Rel-16/29_series/29501/9c1d3678db4a12d5864cb2a4def1135d_img.jpg b/marked/Rel-16/29_series/29501/9c1d3678db4a12d5864cb2a4def1135d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..788fcd63460efbd487c8b8f6e43c7af6c9a1401f --- /dev/null +++ b/marked/Rel-16/29_series/29501/9c1d3678db4a12d5864cb2a4def1135d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c7035e0ef9e5c5a4aa41d5350bdfa8eba3170e44ba7c209765dde9eb79b11b78 +size 33288 diff --git a/marked/Rel-16/29_series/29501/a3472689858b068ef469213682965325_img.jpg b/marked/Rel-16/29_series/29501/a3472689858b068ef469213682965325_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f7b847f11033672899748a40e6ca0eb82ca2e850 --- /dev/null +++ b/marked/Rel-16/29_series/29501/a3472689858b068ef469213682965325_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:09aac2940cc88bffb27301a22eb732c06df31c13dc7b88c31a370c3ff09197bd +size 27106 diff --git a/marked/Rel-16/29_series/29501/a3953dce8dbd7ef15d61a314dbef2cf9_img.jpg b/marked/Rel-16/29_series/29501/a3953dce8dbd7ef15d61a314dbef2cf9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e774bb55d6b43a5b1ab576be432c84a589a7354e --- /dev/null +++ b/marked/Rel-16/29_series/29501/a3953dce8dbd7ef15d61a314dbef2cf9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d869c0e72429cf400ddba716a7dc0b98186e7fe10715261a2993da938751e4dd +size 41635 diff --git a/marked/Rel-16/29_series/29501/aa9441a5971655a79987d70fc551b26a_img.jpg b/marked/Rel-16/29_series/29501/aa9441a5971655a79987d70fc551b26a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e491cbe82487eac74cb54612cc377e900c3f7608 --- /dev/null +++ b/marked/Rel-16/29_series/29501/aa9441a5971655a79987d70fc551b26a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:189a4d261cf339e723b0bc27f26cc36a6d4f339e3a1ab0f81ff45bf16b380c25 +size 31754 diff --git a/marked/Rel-16/29_series/29501/ab846b81e78dbc8da2a6f9511e2f248a_img.jpg b/marked/Rel-16/29_series/29501/ab846b81e78dbc8da2a6f9511e2f248a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..02af5319242bad924671f2ce8e9ccb01b4c997bd --- /dev/null +++ b/marked/Rel-16/29_series/29501/ab846b81e78dbc8da2a6f9511e2f248a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:66117ce12f7cf31a46888f4d112829f547ac1c380160c9b2533c7df027a53c56 +size 24921 diff --git a/marked/Rel-16/29_series/29501/cdd4dfacab004e9979caed3fffea69e5_img.jpg b/marked/Rel-16/29_series/29501/cdd4dfacab004e9979caed3fffea69e5_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..77a63f59727e46f4c6650adaaaefba799e591007 --- /dev/null +++ b/marked/Rel-16/29_series/29501/cdd4dfacab004e9979caed3fffea69e5_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:95d3c69248000c23580e2bc361a0cb52a5491eb1a8228eb97aa7cc3a63fbd013 +size 30221 diff --git a/marked/Rel-16/29_series/29501/d79d33da852cb7bca3e87b400a15c3e8_img.jpg b/marked/Rel-16/29_series/29501/d79d33da852cb7bca3e87b400a15c3e8_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..204b3b6e0dedb9ba42b6289b94048e3b7f1e836d --- /dev/null +++ b/marked/Rel-16/29_series/29501/d79d33da852cb7bca3e87b400a15c3e8_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0885cf9ede38bd44c04087b9091e30b875cd52b953a1759862688321d294d3a4 +size 29563 diff --git a/marked/Rel-16/29_series/29501/db7cb51aac8519daab50e2171cecae82_img.jpg b/marked/Rel-16/29_series/29501/db7cb51aac8519daab50e2171cecae82_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..35fb2a1112dc9319cb9129e1d5e04c4b29b0a8c2 --- /dev/null +++ b/marked/Rel-16/29_series/29501/db7cb51aac8519daab50e2171cecae82_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8cd2cb6c4aaaff105e0fc6ddb4624bb8515026fc9a9c7816b33cca76e1c28485 +size 29738 diff --git a/marked/Rel-16/29_series/29501/dd5771673aececa53d42ece89218299d_img.jpg b/marked/Rel-16/29_series/29501/dd5771673aececa53d42ece89218299d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a42efff246884434bcf3be4c77d079a1226d71c5 --- /dev/null +++ b/marked/Rel-16/29_series/29501/dd5771673aececa53d42ece89218299d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e546e7f5dc33f7ff975b54ce28ca8f6fa93c88529f534c9557cc62bc6e8846ff +size 39314 diff --git a/marked/Rel-16/29_series/29501/ddee3e67e0dfc22e25188fa635a19558_img.jpg b/marked/Rel-16/29_series/29501/ddee3e67e0dfc22e25188fa635a19558_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..af378e3f5b995f52f93726b23fa658602bf1a5ca --- /dev/null +++ b/marked/Rel-16/29_series/29501/ddee3e67e0dfc22e25188fa635a19558_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e5daa3ba1ba76a0baf7e3d807f4273404431091589bbe32fbe8992e193a4c4a6 +size 38413 diff --git a/marked/Rel-16/29_series/29501/raw.md b/marked/Rel-16/29_series/29501/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..af1e1af5a75b57294e329a4f33dc5fcdc6f2c280 --- /dev/null +++ b/marked/Rel-16/29_series/29501/raw.md @@ -0,0 +1,3448 @@ + + +# 3GPP TS 29.501 V16.7.0 (2022-09) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Principles and Guidelines for Services Definition; Stage 3 (Release 16)** + +![5G logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The 5G logo, consisting of the text "5G" in a bold, black, sans-serif font. Above the "5" and "G" are three green curved lines representing signal waves. + +5G logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, featuring the letters "3GPP" in a stylized, bold, black font. The "P" is larger and has a red signal wave icon at its base. + +3GPP logo + +A GLOBAL INITIATIVE + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|-----------------------------------------------------------------------------------------------|----| +| Foreword ..... | 6 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions and abbreviations ..... | 8 | +| 3.1 Definitions..... | 8 | +| 3.2 Abbreviations ..... | 9 | +| 3.3 Special characters, operators and delimiters ..... | 9 | +| 3.3.1 General ..... | 9 | +| 3.3.2 ABNF operators..... | 9 | +| 3.3.3 URI reserved and special characters..... | 9 | +| 3.3.4 SBI specific usage of delimiters..... | 10 | +| 4 Design Principles for 5GC SBI APIs..... | 10 | +| 4.1 General Principles ..... | 10 | +| 4.2 API Design Style and REST Implementation Levels ..... | 11 | +| 4.2.1 General ..... | 11 | +| 4.2.2 API Design Principles for Query Operation..... | 11 | +| 4.2.3 API Design Principles for Delete Operation ..... | 11 | +| 4.3 Version Control..... | 12 | +| 4.3.0 General ..... | 12 | +| 4.3.1 Structure of API version numbers ..... | 12 | +| 4.3.1.1 API version number format ..... | 12 | +| 4.3.1.2 Rules for incrementing field values ..... | 12 | +| 4.3.1.3 Visibility of the API version number fields ..... | 15 | +| 4.3.1.4 Relation to the Technical Specification version number ..... | 15 | +| 4.3.1.5 Discovery of the supported versions..... | 15 | +| 4.3.1.6 Withdrawing API versions..... | 16 | +| 4.4 URI Structure ..... | 16 | +| 4.4.1 Resource URI structure ..... | 16 | +| 4.4.2 Custom operations URI structure ..... | 16 | +| 4.4.3 Callback URI structure ..... | 17 | +| 4.5 Resource Representation and Content Format Negotiation ..... | 17 | +| 4.5.1 Resource Representation ..... | 17 | +| 4.5.2 Content Format Negotiation ..... | 17 | +| 4.6 Use of HTTP Methods ..... | 18 | +| 4.6.1 Use of Request/Response Communication ..... | 18 | +| 4.6.1.1 CRUD ..... | 18 | +| 4.6.1.1.1 Creating a Resource ..... | 18 | +| 4.6.1.1.1.1 General ..... | 18 | +| 4.6.1.1.1.2 Creating a Resource using POST ..... | 18 | +| 4.6.1.1.1.3 Creating a Resource using PUT ..... | 19 | +| 4.6.1.1.2 Reading a Resource..... | 20 | +| 4.6.1.1.2.1 Reading a Single Resource..... | 20 | +| 4.6.1.1.2.2 Querying a Set of Resources ..... | 20 | +| 4.6.1.1.3 Updating a Resource ..... | 21 | +| 4.6.1.1.3.1 Usage of HTTP PUT ..... | 21 | +| 4.6.1.1.3.2 Usage of HTTP PATCH..... | 22 | +| 4.6.1.1.4 Deleting a Resource ..... | 23 | +| 4.6.1.1.5 Query Parameters ..... | 23 | +| 4.6.1.1.5.1 General ..... | 23 | +| 4.6.1.1.5.2 Complex query expression ..... | 23 | +| 4.6.1.2 Custom Operations ..... | 24 | +| 4.6.1.3 Use of Asynchronous Operations ..... | 25 | +| 4.6.1.4 Special provisions to support the seamless change of AMF as NF service producer ..... | 25 | +| 4.6.2 Use of Subscribe/Notify Communication ..... | 26 | +| 4.6.2.1 General..... | 26 | + +| | | | +|-------------|---------------------------------------------------------------------------------------|----| +| 4.6.2.2 | Management of Subscriptions ..... | 26 | +| 4.6.2.2.1 | General ..... | 26 | +| 4.6.2.2.2 | Creation of a Subscription..... | 26 | +| 4.6.2.2.3 | Modify a subscription..... | 27 | +| 4.6.2.2.3.1 | Modification of a Subscription Using HTTP PUT..... | 27 | +| 4.6.2.2.3.2 | Modification of a Subscription Using HTTP PATCH ..... | 28 | +| 4.6.2.2.4 | Delete a subscription ..... | 29 | +| 4.6.2.3 | Notifications..... | 29 | +| 4.6.2.4 | Special provisions to support the seamless change of AMF as NF service consumer ..... | 30 | +| 4.7 | HATEOAS ..... | 30 | +| 4.7.1 | General ..... | 30 | +| 4.7.2 | 3GPP hypermedia format ..... | 31 | +| 4.7.2.1 | Basic 3GPP hypermedia format..... | 31 | +| 4.7.2.2 | Extended 3GPP hypermedia format ..... | 32 | +| 4.7.3 | Advertising legitimate application state transitions..... | 32 | +| 4.7.4 | Inferring link relation semantic ..... | 32 | +| 4.7.5 | Common Relation Types..... | 32 | +| 4.7.5.1 | Introduction..... | 32 | +| 4.7.5.2 | Registered relation types..... | 33 | +| 4.7.5.3 | Extension relation types..... | 33 | +| 4.7.6 | Negotiating the support of optional HATEOAS features..... | 33 | +| 4.8 | Error Responses..... | 34 | +| 4.8.1 | Error Response Status Code ..... | 34 | +| 4.8.2 | Error Response Body..... | 34 | +| 4.8.3 | Extending ProblemDetails for API Backward Compatibility ..... | 35 | +| 4.9 | Transferring multiple resources to a NF Service Consumer ..... | 36 | +| 4.9.1 | General ..... | 36 | +| 4.9.2 | Direct Delivery ..... | 36 | +| 4.9.3 | Direct Delivery with Iterations ..... | 36 | +| 4.9.4 | Indirect Delivery..... | 37 | +| 4.9.5 | Indirect Delivery with HTTP/2 Server Push ..... | 37 | +| 4.9.6 | Criteria for choosing the transfer method..... | 39 | +| 5 | Documenting 5GC SBI APIs ..... | 39 | +| 5.1 | Naming Conventions..... | 39 | +| 5.1.1 | Case Conventions ..... | 39 | +| 5.1.2 | API Naming Conventions..... | 41 | +| 5.1.3 | Conventions for URI Parts ..... | 41 | +| 5.1.3.1 | Introduction..... | 41 | +| 5.1.3.2 | URI Path Segment Naming Conventions ..... | 41 | +| 5.1.3.3 | URI Query Naming Conventions ..... | 42 | +| 5.1.4 | Conventions for Names in Data Structures ..... | 42 | +| 5.2 | API Definition ..... | 42 | +| 5.2.1 | Resource Structure..... | 42 | +| 5.2.2 | Resources and HTTP Methods ..... | 43 | +| 5.2.3 | Representing RPC as Custom Operations on Resources..... | 46 | +| 5.2.3A | Notifications ..... | 47 | +| 5.2.4 | Data Models..... | 49 | +| 5.2.4.1 | General ..... | 49 | +| 5.2.4.2 | Structured data types..... | 49 | +| 5.2.4.3 | Simple data types and enumerations..... | 51 | +| 5.2.4.4 | Binary Data ..... | 51 | +| 5.2.4.5 | Data types describing alternative data types or combinations of data types ..... | 51 | +| 5.2.5 | Relation types ..... | 52 | +| 5.3 | OpenAPI specification files ..... | 52 | +| 5.3.1 | General ..... | 52 | +| 5.3.2 | Formatting of OpenAPI specification files..... | 53 | +| 5.3.3 | Info ..... | 53 | +| 5.3.4 | externalDocs ..... | 53 | +| 5.3.5 | Servers ..... | 54 | +| 5.3.6 | References to other 3GPP-defined OpenAPI specification files ..... | 54 | +| 5.3.7 | Server-initiated communication ..... | 55 | + +| | | | +|----------------------------------------------------------------------------------------|----------------------------------------------------------------------------------|-----------| +| 5.3.8 | Describing the body of HTTP PATCH requests ..... | 55 | +| 5.3.8.1 | General..... | 55 | +| 5.3.8.2 | JSON Merge Patch..... | 55 | +| 5.3.8.3 | JSON PATCH..... | 56 | +| 5.3.9 | Structured data types ..... | 56 | +| 5.3.10 | Data types describing alternative data types or combinations of data types ..... | 58 | +| 5.3.11 | Error Responses..... | 60 | +| 5.3.12 | Enumerations ..... | 61 | +| 5.3.13 | Formatting of structured data types in query parameters ..... | 61 | +| 5.3.14 | Attribute Presence Conditions..... | 62 | +| 5.3.15 | Usage of the "tags" field..... | 64 | +| 5.3.16 | Security ..... | 64 | +| 5.3.17 | Reuse of Structured Data Types..... | 65 | +| 6 | Requirements for secure API design..... | 66 | +| 6.1 | Introduction ..... | 66 | +| 6.2 | General ..... | 66 | +| 6.3 | SBA-specific requirements ..... | 67 | +| Annex A (informative): TS Skeleton Template ..... | | 68 | +| Annex B (informative): Backward Incompatible Changes ..... | | 68 | +| Annex C (Informative): Resource modelling..... | | 69 | +| C.0 | General ..... | 69 | +| C.1 | Document ..... | 69 | +| C.2 | Collection ..... | 69 | +| C.3 | Store ..... | 70 | +| C.4 | Custom operation ..... | 70 | +| Annex D (informative): Example of an OpenAPI specification file for Patch ..... | | 70 | +| Annex E (Informative): Considerations for handling of JSON arrays ..... | | 73 | +| Annex F (informative): Change history ..... | | 75 | + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document defines design principles and documentation guidelines for 5GC SBI APIs. These principles and guidelines should be followed when drafting the 5G System SBI Stage 3 specifications. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [3] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [4] OpenAPI: "OpenAPI 3.0.0 Specification", . +- [5] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces Stage 3". +- [6] IETF RFC 7231: "Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content" +- [7] IETF RFC 7396: "JSON Merge Patch". +- [8] IETF RFC 6902: "JavaScript Object Notation (JSON) Patch". +- [9] IETF RFC 3986: "Uniform Resource Identifier (URI): Generic Syntax" +- [10] IETF RFC 5789: "PATCH Method for HTTP" +- [11] IETF RFC 8288: "Web Linking". +- [12] IANA: "HTTP Status Code Registry at IANA", +- [13] IETF RFC 7540: "Hypertext Transfer Protocol Version 2 (HTTP/2)" +- [14] Fielding, Roy Thomas. Architectural Styles and the Design of Network-based Software Architectures. Doctoral dissertation, University of California, Irvine, 2000. +- [15] Erik Wilde, Cesare Pautasso, REST: From Research to Practice, Springer +- [16] YAML 1.2: "YAML Ain't Markup Language", . + +- [17] Semantic Versioning Specification: +- [18] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". +- [19] IETF RFC 7807: "Problem Details for HTTP APIs". +- [20] 3GPP TS 29.502: "5G System; Session Management Services; Stage 3". +- [21] 3GPP TS 29.509: "Authentication Server Services; Stage 3". +- [22] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [23] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [24] 3GPP TS 29.573: "5G System; Public Land Mobile Network (PLMN) Interconnection; Stage 3". +- [25] 3GPP TR 21.900: "Technical Specification Group working methods". +- [26] IETF RFC 5234: "Augmented BNF for Syntax Specifications: ABNF". +- [27] 3GPP TS 23.003: "Numbering, addressing and identification". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +**Absolute URI:** Absolute URI follows generic URI syntax and consists of a hierarchical sequence of the following components: the "scheme", "authority", "path" and "query", i.e. excluding the "fragment" component. See clause 4.3 in IETF RFC 3986 [9]. + +**apiRoot:** apiRoot follows an absolute URI syntax, but excludes the following absolute URI identifiers: the "query" and "fragment" components. The API root contains the "scheme" and the "authority" components and may also contain an API prefix subcomponent. See clause 4.4.1. + +**API Prefix:** API prefix is an optional, deployment-specific string, which is a subcomponent of the "apiRoot". API prefix format follows "path-absolute" syntax and that starts with a "/" reserved character (see clause 4.4.1 and also clause 3.3 in IETF RFC 3986 [9]). + +**API URI:** API URI has the following format: {apiRoot}//. For more details see clause 4.4.1. + +**Base URI:** Base URI is used as a reference against which the relative URI reference is applied. See clause 4.6.1.1.1.2 and also clause 5.1 in IETF RFC 3986 [9]. + +**Callback URI:** Callback URI follows an absolute URI syntax, but excludes the following absolute URI identifiers: "userinfo" subcomponent of the "authority" component and also the "query" component ("fragment" component is already excluded from the absolute URI). Therefore, callback URI contains the "scheme", "authority" (excluding "userinfo" subcomponent) and the "path" components. See clause 4.4.3. + +**Relative URI:** Relative URI is a part of a URI to be used on top of a base URI, i.e. the base URI is a reference against which the relative URI is used. See clause 1.2.3 in IETF RFC 3986 [9]. + +**Resource URI:** Resource URI identifies an abstract or a physical resource. See the Abstract of the IETF RFC 3986 [9]. In this specification this generally means "an URI of a resource". + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|---------|-----------------------------------------------| +| 5GC | 5G Core Network | +| CNF | Conjunctive Normal Form | +| CRUD | Create, Read, Update, Delete | +| DNF | Disjunctive Normal Form | +| HAL | Hypertext Application Language | +| HATEOAS | Hypermedia as the Engine of Application State | +| REST | REpresentational State Transfer | +| RPC | Remote-Procedure-Call | +| SBI | Service Based Interface | +| YAML | YAML Ain't Markup Language | + +## 3.3 Special characters, operators and delimiters + +### 3.3.1 General + +A number of characters have special meaning and are used as delimiters in this document and also in other stage 3 SBI specifications. Below clauses specify the usage of a selected set of the special characters. Full set of these special characters are specified in the respective IETF specifications. + +### 3.3.2 ABNF operators + +Special characters that are used as delimiters in ABNF syntax have somewhat different purpose from the same characters when used by URI syntax. See clause 3.3.2 in 3GPP TS 29.500 [2]. + +### 3.3.3 URI reserved and special characters + +| | | +|----|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| / | Reserved character. The forward slash character is a delimiter, which precedes an URI path component and also separates a sequence of path segments. See clauses 2.2 and 3.3 in IETF RFC 3986 [9]. | +| # | Reserved character. The number sign (hash) character is a delimiter, which terminates either an URI path component, or an authority component, or a query component and starts a fragment component. See clauses 2.2, 3.2, 3.3 and 3.5 in IETF RFC 3986 [9]. | +| ? | Reserved character. The question mark character is a delimiter, which terminates either an URI path component, or an authority component and starts a query component/parameter. See clauses 2.2, 3.2, 3.3 and 3.4 in IETF RFC 3986 [9]. | +| = | Reserved character. The equal sign character is a delimiter, which separates a parameter name and its value, e.g. in an URI query. See clauses 1.2.3 and 3.3 in IETF RFC 3986 [9]. | +| [] | Reserved character. The square bracket characters enclose an IPv6 literal address. This is the only place where square bracket characters are allowed in the URI syntax. See clause 3.2.2 in IETF RFC 3986 [9]. | +| <> | Special characters. The angle bracket characters are delimiters and enclose a complete URI or an URI component or a subcomponent. See Appendix C in IETF RFC 3986 [9]. | +| ; | Reserved character. The semicolon character is a delimiter, which is often used to separates a parameter name and its value in a path segment. See clause 3.3 in IETF RFC 3986 [9]. | +| : | Reserved character. The colon character is a delimiter, which either terminates an URI scheme component, or userinfo subcomponent, or separates host subcomponent from the port subcomponent, an authority component, or a query component and starts a fragment component. See clauses 2.2, and 3.2 in IETF RFC 3986 [9]. | + +NOTE: The same characters, like "/", "#", etc. lead to different processing in ABNF and URI grammars. For instance, in URI syntax, ";" character separates parameter and its value, while in ABNF ";" starts a comment. + +### 3.3.4 SBI specific usage of delimiters + +The braces (curly brackets) are used as delimiters across the SBI specifications, but have somewhat different purpose as specified below. + +- { } Delimiters. The braces (curly brackets) characters enclose a name of a variable in an URI path segment (see clause 5.1.3.2). Example: .../subscriber-data/{supi}. +- { } Delimiters. The braces (curly brackets) characters enclose a parameter value in a query (see clause 5.1.3.3). Example: ?nf-id={chooseAValue} + +NOTE: In SBI specifications, "<>" is a generic placeholder, while "{ }" enclose specifically a variable. + +# --- 4 Design Principles for 5GC SBI APIs + +## 4.1 General Principles + +Each 5GC SBI API specification should include the following information for each specified service: + +- Purpose of the API; +- URIs of resources; +- Supported HTTP methods for a given resource; +- Supported representations (e.g. JSON, see IETF RFC 8259 [3]); +- Request body schema(s) (where applicable); +- Response body schema(s) (where applicable); +- Supported response status codes; +- Relation types supported if HATEOAS is implemented by the API; +- A reference in the resource description clause to one of the archetypes defined in Annex C if the resource design matches one of them; and +- A list defining identifiers of optional features (see clause 6.6 of 3GPP TS 29.500 [2] for related procedures). + +For each specified service a clause to a normative Annex should be provided containing the OpenAPI definitions according to OpenAPI Specification [4] for the service. The specifications should state that content of this normative annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods. + +NOTE: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +The TS Skeleton Template as provided in Annex A should be used as a starting point when drafting 5GC SBI API specifications. + +Common procedures, HTTP extensions and error handling applicable to several 5GC SBI API specifications should be defined in 3GPP TS 29.500 [2] and should be referenced from individual 5GC SBI API specifications. + +Common data types applicable to several 5GC SBI API specifications should be defined in 3GPP TS 29.571 [5] and should be referenced from individual 5GC SBI API specifications. + +## 4.2 API Design Style and REST Implementation Levels + +### 4.2.1 General + +5GC SBI API specifications should apply a protocol design framework as follows: + +- a) REST-style service operations should implement the Level 2 of the Richardson maturity model, with standard HTTP methods, whenever it is a good match for the style of interaction to model, e.g. service operations that can naturally map to one of the standard methods (CRUD operations), this should be the preferred modelling attempt; +- b) service operations may use custom API operations (RPC-style interaction), when it is seen a better fit for the style of interaction to model, e.g. non-CRUD service operations; +- c) it is possible to mix REST-style operations and RPC-style operations in the same API. + +NOTE: Level 3 (HATEOAS) of the Richardson maturity model in the 5G Service-Based Architecture can be implemented by an API but is optional. Hypermedia usage guidelines are provided in clause 4.7 of the present specification. + +### 4.2.2 API Design Principles for Query Operation + +When designing a query operation API, i.e. the NF service consumer invokes the API aiming to retrieve certain information from the NF service producer, the following principles should be applied: + +- a) if the query operation does not require any input parameter for the NF service producer, then the REST-style service operation with standard HTTP GET method should be used (see clause 4.6.1.1.2); +- b) if + - the query operation requires input parameter(s) for the NF service producer; and + - all the required input parameter(s) are used to identify a particular resource and/or control the content of the result of the query operation;then the REST-style service operation with standard HTTP GET method should be used (see clause 4.6.1.1.2); +- c) standard HTTP GET method shall not be used for non-safe operations and non-idempotent operations. + +### 4.2.3 API Design Principles for Delete Operation + +When designing a delete operation API, i.e. the NF service consumer invokes the API aiming to delete certain resource on the NF service producer, the following principles should be applied: + +- a) if the delete operation does not require any input parameter for the NF service producer, then the REST-style service operation with standard HTTP DELETE method should be used (see clause 4.6.1.1.4); +- b) if + - the delete operation requires input parameter(s) for the NF service producer; and + - all the required input parameter(s) are used to identify a particular resource and/or control the content of the result of the delete operation;then the REST-style service operation with standard HTTP DELETE method should be used (see clause 4.6.1.1.4); +- c) standard HTTP DELETE method shall not be used for non-idempotent operations. + +## 4.3 Version Control + +### 4.3.0 General + +The version control mechanism in the present clause allows the management of changes to an API and provides a version number that is incremented whenever changes to the API are applied. + +NOTE: The version number does not reflect the usage of optional features. A mechanism to negotiate the usage of optional features is defined in clause 6.6 of 3GPP TS 29.500 [2]. + +### 4.3.1 Structure of API version numbers + +#### 4.3.1.1 API version number format + +API version numbers shall consist of at least 3 fields, following a MAJOR.MINOR.PATCH pattern according to the Semantic Versioning Specification [17] with exceptions for 3GPP Releases under development. A fourth DRAFT field is added to denote an OpenAPI version under development i.e., prior to the freeze of the corresponding OpenAPI description for a given 3GPP Release. Optionally, additional fields can be added after those fields based on operator policy. + +The 1st field (MAJOR), the 2nd field (MINOR), and the 3rd field (PATCH) shall contain unsigned integer numbers. + +During the development of an API (i.e. before the freeze of a given 3GPP Release), the 4th field is called DRAFT, and it shall have the format "alpha-*n*", where "*n*" is an unsigned integer number. + +After the freeze of a 3GPP Release, the optional 4th field shall not be considered as DRAFT and it may contain any string, with a format other than "alpha-*n*"; any additional optional field(s), when present, may contain any string. + +The fields shall be separated by ".". + +EXAMPLE: "1.0.0.alpha-1". + +#### 4.3.1.2 Rules for incrementing field values + +The first version of a new API under development shall obtain the version number "1.0.0.alpha-1". At the first publication of the 3GPP Technical Specification defining the API after the OpenAPI freeze of the first 3GPP Release that contains the API, the version number of the API shall be set to "1.0.0". + +When a new version of the 3GPP TS containing OpenAPI file(s) is published, the fields of the corresponding API version number(s) shall be incremented according to the following rules: + +##### 1st Field (MAJOR): + +- This numerical field shall be incremented when: + - a) there are one or more backward incompatible changes to the API after the OpenAPI freeze for a given 3GPP Release; and + - b) there are the first backward incompatible change(s) to the existing API with respect to the latest version in the previous 3GPP Release while a 3GPP Release is under development (i.e. prior to the OpenAPI freeze for a given 3GPP Release). + +EXAMPLE 1: Assuming that 3GPP Rel-16 under development contains API version "1.1.0.alpha-2", and a backward incompatible change with respect to the latest version in the previous 3GPP Release is applied to that API before the OpenAPI freeze, the new Rel-16 API version is "2.0.0.alpha-1". + +NOTE 1: Subsequent changes in a given 3GPP Release under development do not lead to increment of the 1st field (MAJOR) and 2nd field (MINOR). + +NOTE 2: Rules for determining backward incompatible changes are provided in Annex B. + +NOTE 3: It is recommended to avoid backward incompatible change to the API after the OpenAPI freeze whenever possible, especially after OpenAPI freeze of a succeeding Release. It is preferable to introduce such changes only in the 3GPP Release under development. + +- If a backward incompatible change needs to be applied to several 3GPP Releases the following applies: + +- a) If the 3GPP Releases contain different MAJOR versions of the same API, a new MAJOR API version shall be assigned to each 3GPP Release in the order of those 3GPP Releases in such a manner that the lowest of those 3GPP Releases shall obtain the first unassigned MAJOR version value. + +EXAMPLE 2: Assuming that 3GPP Rel-15 contains API version "1.0.0", and Rel-16 contains API version "2.0.0", and that the same backward incompatible change is applied to that API in both Releases, the new Rel-15 API version is "3.0.0" and the new Rel-16 API version is "4.0.0". + +- b) If the 3GPP Releases contain the same MAJOR version but different MINOR versions of the same API, a single new MAJOR API version value shall be assigned for all those 3GPP Releases, unless other backward incompatible changes only applied to some of those Releases require the creation of separate MAJOR versions. + +NOTE 4: For each such Release a new MINOR version is assigned. + +EXAMPLE 3: Assuming that 3GPP Rel-15 and Rel-16 contain API version "1.0.0", and Rel-17 contains API version "1.2.0", and that the same backward incompatible change is applied to that API in all 3GPP Releases, the new 3GPP Rel-15 and Rel-16 API version is "2.0.0" and the new 3GPP Rel-17 API version is "2.2.0". + +- c) If the 3GPP Releases contain the same API versions, a single new API version shall be assigned for all those 3GPP Releases, unless other changes only applied to some of those Releases require the creation of separate versions. + +EXAMPLE 4: Assuming that 3GPP Rel-15 and 3GPP Rel-16 contain API version "1.0.0", and that only the same backward incompatible change is applied to that API in both 3GPP Releases, the new 3GPP Rel-15 and Rel-16 API version is "2.0.0". + +EXAMPLE 5: Assuming that 3GPP Rel-15 and Rel-16 contain API version "1.0.0", and that the same backward incompatible change is applied to that API in both Releases and an additional backward compatible change is applied in 3GPP Rel-16, the new 3GPP Rel-15 API version is "2.0.0", and the 3GPP Rel-16 API version is "2.1.0". + +EXAMPLE 6: Assuming that 3GPP Rel-15 and Rel-16 contain API version "1.0.0", and that the same backward incompatible change is applied to that API in both Releases and an additional backward incompatible change is applied in 3GPP Rel-16, the new 3GPP Rel-15 API version is "2.0.0", and the 3GPP Rel-16 API version is "3.0.0". + +##### 2nd Field (MINOR): + +- This numerical field shall be incremented when: + +- a) there are the first one or more backward compatible changes not corresponding to changes to earlier 3GPP Releases (i.e. changes introduced by 3GPP CR with other categories than "mirror") to the same API in a given 3GPP Release without any prior backward incompatible changes in that Release. If the same 1st field (MAJOR) and the 2nd field (MINOR) are assigned to $n$ previous 3GPP Releases, a MINOR version number shall be reserved for each intermediate 3GPP Release for possible subsequent changes in that Release and the MINOR version number shall be incremented by $n$ ; and + +EXAMPLE 7: Assuming that 3GPP Rel-15 and Rel-16 contain API version "1.0.0" (because there were no changes to the API in Rel-16), and in Rel-17 the first backward compatible new feature is added before the OpenAPI freeze, the API version "1.2.0.alpha-1" is assigned to Rel-17. + +- b) there are one or more subsequent backward compatible additions of features not corresponding to changes to previous 3GPP Releases to the API in a frozen 3GPP Release before a higher MINOR number has been allocated for the same MAJOR version (for a subsequent Release). + +- This field shall be reset to "0" if the 1st field (MAJOR) is changed, unless a backward incompatible change needs to be applied to several 3GPP Releases that already contain the same MAJOR but different MINOR API + +versions. In that case a single new major API version is assigned, and for each such 3GPP Release with an own MINOR version, a new MINOR version shall be assigned, starting with MINOR version "0" for the lowest such Release, and reserving a MINOR version number for each intermediate Release without an own MINOR version. (see Example 3) + +NOTE 5: In most cases the MINOR version is incremented when new backward compatible features are added in a 3GPP Release. In rare cases, where only backward compatible changes not corresponding to changes to previous 3GPP Releases are applied to a 3GPP Release, the MINOR version is also incremented. It is recommended to avoid such changes in 3GPP Releases without added functionality whenever possible. + +NOTE 6: Subsequent backward compatible changes in a given 3GPP Release before OpenAPI freeze do not lead to an increment of the 2nd field (MINOR). + +NOTE 7: Changes corresponding to changes in previous 3GPP Releases do not lead to an increment of the 2nd field (MINOR). + +NOTE 8: If two 3GPP Releases are under parallel development (because the work on Rel-*X+1* has commenced before the OpenAPI freeze of Rel-*X*), the corresponding APIs will obtain distinct values of the 1st field (MAJOR) or 2nd field (MINOR). + +EXAMPLE 8: Assuming that an API was introduced with version "1.0.0" in Rel-15, and that the Rel-16 version is "1.1.0.alpha-5" because the OpenAPI is not yet frozen in Rel-16, and that a new backward compatible Rel-17 feature is added, the Rel-17 API version is "1.2.0.alpha-1". + +##### 3rd Field (PATCH): + +- This numerical field shall be incremented: + - a) if the changes are only one or more backward-compatible corrections (but no changes requiring an update of the 1st field (MAJOR) or of the 2nd field (MINOR) are made to the API after the OpenAPI freeze of a 3GPP Release; and + - b) if one or more backward compatible additions of features, but no changes requiring an update of the 1st field (MAJOR) or of the 2nd field (MINOR), are made to the API after the OpenAPI freeze of a 3GPP Release and after the assignment of a MINOR version to a higher 3GPP Release. +- This field shall be reset to "0" if the 1st field (MAJOR) or 2nd field (MINOR) is changed. + +NOTE 9: Before the OpenAPI freeze for a given 3GPP Release, the 3rd field will not be incremented. + +NOTE 10: If the 1st field (MAJOR) and 2nd field (MINOR) were not incremented between 3GPP Releases (because there were no added features and no backward incompatible changes), and the same backward compatible changes are then applied to those 3GPP Releases, the API files in those 3GPP Releases are identical and will obtain the same API version number. + +NOTE 11: In rare cases for which a new backward compatible functionality needs to be added in an older 3GPP Release after the OpenAPI freeze and work on that API already started in a later Release, the new functionality is exceptionally introduced as a PATCH correction and a new supported feature could be defined accordingly. + +##### 4th Field: + +- Before the OpenAPI freeze of a 3GPP Release, the 4th field (DRAFT) shall be supplied as follows: + - a) When the 1st or 2nd field is incremented before the OpenAPI freeze of a 3GPP Release, this field shall obtain the value "alpha-1". + - b) The numerical value "n" within the field value "alpha-n" shall be incremented if one or more subsequent changes are made to the API under development. +- After the OpenAPI freeze of a 3GPP Release, the 4th field is not managed anymore by 3GPP. + +After the OpenAPI freeze of a 3GPP Release, additional fields may be supplied based on operator policy after the 3rd field. The rules for setting, or incrementing, such fields are out of the scope of 3GPP. + +If no change is applied to an API in a new published TS version, the API version number shall not be incremented unless the draft field needs to be removed at OpenAPI freeze. This also applies if the TS is published in a new 3GPP Release. + +NOTE 12: OpenAPI files can contain references to other OpenAPI files. Changes to referenced parts of such other OpenAPI files need to be considered when determining if and how to update an API version. + +NOTE 13: The API version number of those version fields managed by 3GPP is incremented using 3GPP change requests. + +#### 4.3.1.3 Visibility of the API version number fields + +The API version shall be indicated in the resource URI of every API, as described in clause 4.4.1. + +The API version shall be indicated as the concatenation of the letter "v" and the 1st field of the API version number. + +The other fields shall not be included in the resource URI. + +NOTE: Including these digits in the URI would force the NF service consumer to select a specific sub-version, at the risk of seeing the request rejected if the NF service provider does not support it, while the request could have been served by ignoring unknown elements. + +The full API version number (i.e., containing all the fields) shall be visible in the OpenAPI specifications, in the "version" subfield of the "info" field, as described in clause 5.3.3. + +#### 4.3.1.4 Relation to the Technical Specification version number + +There is no one-to-one mapping between an API version number and the version number of the 3GPP Technical Specification defining this API. + +A 3GPP Technical Specification specifies one or more APIs, which may have different versions. + +A change in the 3rd field of a 3GPP TS version number (i.e. an editorial change) should not lead to a change in the version number of the APIs specified in the 3GPP TS. + +A change in the 1st and 2nd fields of the 3GPP TS version number is likely to lead to at least a change in the minor version number of the APIs specified in the 3GPP TS. + +EXAMPLE: If version 15.4.1 of a 3GPP TS contains version "1.1.1" of API A, B and C, and a version 16.0.0 of this 3GPP TS is derived from version 15.4.1, TS version 16.0.0 can contain version "1.2.0.alpha-1" of API A (if all changes made are backward compatible), version "2.0.0.alpha-1" of API B (if some changes are not backward compatible) and version "1.1.1" of API C (if no changes were made). + +The 3GPP TS defining the API is indicated in the OpenAPI specification of the API, as described in clause 5.3.4. + +#### 4.3.1.5 Discovery of the supported versions + +The NF service consumer may discover the API version(s) supported by an NF service producer using the following mechanisms: + +- NRF query: The NF service consumer may retrieve from the NRF the NF profile of a given NF Instance. This NF profile contains the full version number(s) of the API(s) supported by an NF Service Instance, as described in the clause 6.2.6.2.4 of 3GPP TS 29.510 [18] and the planned retirement date. +- NF profile change notifications: The NF service consumer may subscribe for NF status change notifications with the NRF as specified in clause 5.2.2.5 of 3GPP TS 29.510 [18]. The NRF shall notify as specified in clause 5.2.2.6 of 3GPP TS 29.510 [18], any change to the NF profile which may include updated NF service profile containing the current list of NF services and their versions supported by the NF. + +When a new major version is created, the NF service producer shall continue supporting at least the previous major version until a retirement date unless all API versions (except for draft API versions published prior to the OpenAPI freeze) with that previous major version are withdrawn (see clause 4.3.1.6); this enables NF service consumers to migrate to the new version. After expiration of the retirement date, the old major version should be deprecated. The + +retirement date of an old major version supported by a NF service instance may be updated in the NF profile in the NRF. + +#### 4.3.1.6 Withdrawing API versions + +If it is discovered that one or several previous API versions are not providing the basic mandatory functionality of an API due to severe functional or encoding deficits (for instance, there is no or very limited interoperability between the NF service consumer and NF service producer when such an API version is used, or the API is hardly implementable because of severe deficits in the OpenAPI file that cannot easily be fixed by implementers in an interoperable manner), those API versions shall be listed as withdrawn in subsequent versions of the TS defining the corresponding API; any withdrawn API versions from the same or previous 3GPP releases shall be listed. API versions published before the OpenAPI freeze of the corresponding 3GPP Release, i.e. with a 4th Field (DRAFT) as part of the version number, shall not be withdrawn. + +NOTE 1: It is recommended to avoid withdrawing API versions whenever possible. It is expected that a need to withdraw API versions is most likely detected when discussing corrections soon after the OpenAPI freeze of a new API. + +NOTE 2: Corrections to optional or minor parts of the API functionality do not lead to the withdrawal of API versions. However, if severe functional or encoding deficits of the functionality related to an optional functionality with a corresponding supported feature (see 3GPP TS 29.500 [2] clause 6.6.2) are discovered, a new supported feature can be introduced to enable a negotiation of the support of the correction, and the old corresponding supported feature can be marked as "withdrawn" in the table defining the supported features of an API. + +Withdrawn API versions should not be deployed. + +## 4.4 URI Structure + +### 4.4.1 Resource URI structure + +Resources are either individual resources, or structured resources that can contain child resources. It is recommended to design each resource following one of the archetypes provided in the Annex C. + +A URI uniquely identifies a resource. In the 5GC SBI APIs, when a resource URI is an absolute URI, its structure shall be specified as follows: + +**{apiRoot}** + +"apiRoot" shall be a concatenation of the following parts: + +- scheme ("http" or "https") + +NOTE: In this release of the specification both http and https scheme URIs are allowed. See clause 13.1 of 3GPP TS 33.501[22] for further details on security of Service Based Interfaces. + +- the fixed string "://" +- authority (host and optional port) as defined in IETF RFC 3986 [9] +- an optional deployment-specific string (API prefix) that starts with a "/" character. + +"apiName" shall define the name of the API. + +"apiVersion" shall indicate the 1st Field (MAJOR) of the version of the API. See also clause 4.3.1.3. + +While "apiRoot", "apiName" and "apiVersion" together define the API URI of the corresponding API, each "apiSpecificResourceUriPart" defines a resource URI of the API relative to the API URI. + +### 4.4.2 Custom operations URI structure + +The custom operation definition is in Annex C. + +The URI of a custom operation which is associated with a resource shall have the following structure: + +**{apiRoot}** + +Custom operations can also be associated with the service instead of a resource. The URI of a custom operation which is not associated with a resource shall have the following structure: + +**{apiRoot}** + +In the above URI structures, "apiRoot", "apiName", "apiVersion" and "apiSpecificResourceUriPart" are as defined in clause 4.4.1 and "custOpName" represents the name of the custom operation as defined in clause 5.1.3.2. + +### 4.4.3 Callback URI structure + +The purpose of the callback URI is to enable NF service consumer to provide the URI to be used by an NF Service Producer to send notification or callback requests. + +The callback URI shall be in the form of an absolute URI as defined in clause 4.3 of IETF RFC 3986 [9], including an authority, and excluding any query component, any fragment component and any userinfo subcomponent. + +Therefore, callback URI consists of the following components, specified with ABNF syntax (see IETF RFC 5234 [26]): + +URI = scheme ":" "/" host [ ":" port ] / path + +Where 'host' is either an FQDN or an IP address and the 'path' is a path to an NF consumer resource. + +## 4.5 Resource Representation and Content Format Negotiation + +### 4.5.1 Resource Representation + +A resource representation is a serialization of the resource state in a particular content format. It's included in the data frame of an HTTP/2 request or response. Representation header fields provide metadata about the representation. When a message includes a data frame, the representation data enclosed in the data frame. HTTP/2 reuses the definition of Representation header as HTTP 1.1 in IETF RFC 7231 [6]. Content-type field in HTTP/2 header performs as representation header fields and describes the representation data that would have been enclosed in the data frame, e.g. if content-type is application/json, resource representation in data frame is serialized in JSON format. + +Server supports the content format of the representation received in the data frame of the request and returns the "200 OK" response code. + +### 4.5.2 Content Format Negotiation + +IETF RFC 7231 [6] provides a mechanism to negotiate the content format of a representation. + +In HTTP/2 requests and responses, the "Content-Type" HTTP/2 header field is used to signal the format of the actual representation included in the data frame. If the format of the representation in an HTTP/2 request is not supported by the server, it responds with the "415 Unsupported Media Type" response code. + +For GET method, the "Accept" HTTP header of the HTTP/2 request signals the content formats that a client supports. If the server cannot provide any of the accepted formats, it returns the "406 Not Acceptable" response code. + +## 4.6 Use of HTTP Methods + +### 4.6.1 Use of Request/Response Communication + +#### 4.6.1.1 CRUD + +##### 4.6.1.1.1 Creating a Resource + +###### 4.6.1.1.1.1 General + +Procedures that allow an NF service consumer to create a new resource at the NF service producer shall be specified to either use the HTTP POST method with procedures according to clause 4.6.1.1.1.2 or the HTTP PUT method with procedures according to clause 4.6.1.1.1.3. + +###### 4.6.1.1.1.2 Creating a Resource using POST + +The HTTP POST method (see IETF RFC 7231 [6]) allows an NF service consumer to create a new child resource at the NF service producer in such a manner that the NF service producer selects the child resource identifier and the URI for the child resource. + +Figure 4.6.1.1.1.2-1 illustrates creating a resource using POST. + +![Sequence diagram illustrating the creation of a resource using POST. The diagram shows two lifelines: 'NF service consumer' on the left and 'NF service producer' on the right. The consumer sends a POST request to the producer, and the producer responds with a 201 Created status.](aa9441a5971655a79987d70fc551b26a_img.jpg) + +``` +sequenceDiagram + participant Consumer as NF service consumer + participant Producer as NF service producer + Note left of Consumer: + Consumer->>Producer: 1. POST .../parent-resource (ResourceRepresentation) + Note right of Producer: + Producer-->>Consumer: 2. 201 Created (ResourceRepresentation) + Note left of Consumer: + Note right of Producer: +``` + +Sequence diagram illustrating the creation of a resource using POST. The diagram shows two lifelines: 'NF service consumer' on the left and 'NF service producer' on the right. The consumer sends a POST request to the producer, and the producer responds with a 201 Created status. + +**Figure 4.6.1.1.1.2-1: Creating a resource using POST** + +1. The parent resource of which the new resource is to be created as a child is identified by the request URI. The payload body of the POST request shall contain a representation of the resource to be created without a child resource identifier. For forward compatibility, the NF service producer ignores unknown attributes in the received resource representation unless specified otherwise by the particular application. +2. The NF service producer generates a child resource identifier and constructs the URI for the created resource by appending that child resource identifier to the parent resource URI received as request URI of the POST request (e.g. ".../parent-resource/childresource1"). + +On success, "201 Created" shall be returned, the payload body of the POST response should contain a representation of the created resource, and the "Location" header shall be present and shall contain the URI of the created resource. The created resource shall be served by the same NF (service) instance that received the service request, unless the 5GC SBI API specifications explicitly specified that in specific use cases the created resource may be served by another NF (service) instance. If in such specific use cases the resource is created in a different NF (service) instance, the identifier of the serving NF (service) instance shall be included in the response message. + +If the HTTP scheme used in the returned URI is "https", then the authority of the URI included in the Location header shall be an FQDN, and not an IP address. + +The URI included in the "Location" header may be an absolute URI or a relative URI reference (see IETF RFC 3986 [9]); when the URI is in relative form, the base URI used to resolve the URI reference is the target URI included in the received POST request. + +NOTE: The representations of the resource in the request and response can differ, e.g. the representation of the resource in the response can be empty or can contain a subset of the representation as received in the request possibly with modified attributes, and in addition can contain additional attributes. Exact details will be specified by the application. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body (see clause 4.8). + +A collection may be used to model a resource that serves as a directory of resources that may be distributed on different processing instances or hosts. If so: + +- the authority and/or deployment-specific string of the apiRoot of the created resource URI returned by the NF Service Producer in the "Location" header may differ from the authority and/or deployment-specific string of the apiRoot of the request URI received in the POST request. +- the NF Service Consumer shall be capable to receive and process an authority and/or deployment-specific string in the apiRoot of the created resource URI that differs from the authority and/or deployment-specific string of the apiRoot of the Request URI. + +It needs to be clearly stated in the 5GC SBI API specifications when a NF Service Producer may return a different authority and/or deployment-specific string in the apiRoot of the created resource URI for a collection resource. + +###### 4.6.1.1.1.3 Creating a Resource using PUT + +The HTTP PUT method (see IETF RFC 7231 [6]) allows an NF service consumer to create a new resource at the NF service producer in such a manner that the NF service consumer selects the resource identifier and the URI for the resource. + +Figure 4.6.1.1.1.3-1 illustrates creating a resource using HTTP PUT. + +![Sequence diagram showing the interaction between an NF service consumer and an NF service producer to create a resource using HTTP PUT.](cdd4dfacab004e9979caed3fffea69e5_img.jpg) + +``` +sequenceDiagram + participant Consumer as NF service consumer + participant Producer as NF service producer + Note left of Consumer: + Consumer->>Producer: 1. PUT ../resource (ResourceRepresentation) + Note right of Producer: + Producer-->>Consumer: 2. 201 Created (ResourceRepresentation) + Note left of Consumer: +``` + +The diagram illustrates a sequence of two messages between an NF service consumer and an NF service producer. The consumer sends a PUT request to the producer, and the producer responds with a 201 Created status. The message details are: 1. PUT ../resource (ResourceRepresentation) from consumer to producer, and 2. 201 Created (ResourceRepresentation) from producer to consumer. + +Sequence diagram showing the interaction between an NF service consumer and an NF service producer to create a resource using HTTP PUT. + +**Figure 4.6.1.1.1.3-1: Creating a Resource using HTTP PUT** + +1. The NF service consumer selects a resource identifier and constructs the URI for the resource to be created by appending that resource identifier to the parent resource URI. The resource that is to be created is identified by that URI as request URI. The payload body of the PUT request shall contain a representation of the resource to be created. For forward compatibility, the NF service producer ignores unknown attributes in the received resource representation unless specified otherwise by the particular application. +2. On success, "201 Created" shall be returned, the payload body of the PUT response should contain the representation of the created resource, and the "Location" header shall be present and shall contain the URI of the created resource. The created resource shall be served by the same NF (service) instance that received the service request, unless the 5GC SBI API specifications explicitly specified that in specific use cases the created resource may be served by another NF (service) instance. If in such specific use cases the resource is created in a different NF (service) instance, the identifier of the serving NF (service) instance shall be included in the response message. + +If the HTTP scheme used in the returned URI is "https", then the authority of the URI included in the Location header shall be an FQDN, and not an IP address. + +NOTE: The representations of the resource in the request and response can differ, e.g. the representation of the resource in the response can be empty or can contain a subset of the representation as received in the request possibly with modified attributes, and in addition can contain additional attributes. Exact details will be specified by the application. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PUT response body (see clause 4.8). + +If the resource that is to be created already exists at the NF service producer, the following applies: + +- 1) If the update of that resource by PUT is supported, the existing representation of the resource is replaced with the representation received in the PUT request body; see clause 4.6.1.1.3.1. +- 2) If the update of that resource by PUT is not supported, the "403 Forbidden" HTTP status code shall be returned and appropriate additional error information should be returned in the PUT response body (see clause 4.8). + +##### 4.6.1.1.2 Reading a Resource + +###### 4.6.1.1.2.1 Reading a Single Resource + +Procedures that allow a service consumer NF (client) to read information from the server shall be specified to use the HTTP GET method (see IETF RFC 7231 [6]) to obtain the current representation of a resource. + +Figure 4.6.1.1.2-1 illustrates reading a resource. + +![Sequence diagram illustrating the interaction for reading a resource. An NF service consumer sends a GET request to an NF service producer, and the producer responds with a 200 OK status and the resource representation.](d79d33da852cb7bca3e87b400a15c3e8_img.jpg) + +``` + +sequenceDiagram + participant Consumer as NF service consumer + participant Producer as NF service producer + Note left of Consumer: + Consumer->>Producer: 1. GET .../resource?query-parameter=value () + Note right of Producer: + Producer-->>Consumer: 2. 200 OK (ResourceRepresentation) + Note left of Consumer: + +``` + +Sequence diagram illustrating the interaction for reading a resource. An NF service consumer sends a GET request to an NF service producer, and the producer responds with a 200 OK status and the resource representation. + +**Figure 4.6.1.1.2.1-1: Reading a resource** + +1. The resource of which a representation is to be obtained is identified by the request URI. Query parameters may be used to control the content of the result. + +**Editor's Note:** Exact limits for number and length of query parameters are ffs. + +**Editor's Note:** Alternatives to the GET method for cases where the limits for number and length of query parameters are exceeded are ffs. + +The payload body of the GET request shall be empty. + +2. On success, "200 OK" shall be returned and the payload body of the GET response shall contain the obtained resource representation. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body (see clause 4.8). + +###### 4.6.1.1.2.2 Querying a Set of Resources + +Procedures that allow a service consumer NF (client) to query a set of resources from the server shall be specified to use HTTP GET method towards a resource modelled as Collection or Store archetype. + +Query parameters (see clause 4.6.1.1.5) may be provided when querying a set of resources. The query component contains non-hierarchical data that, along with data in the path component, to filter the resources identified within the scope of the URI's scheme to a subset of the resources matching the query parameters. The query component is + +indicated by the first question mark ("?") character and terminated by a number sign ("#") character or by the end of the URI. + +![Sequence diagram showing a client sending a GET request to a server and receiving a 200 OK or 404 Not Found response.](a3472689858b068ef469213682965325_img.jpg) + +``` + +sequenceDiagram + participant client + participant server + Note left of client: client + Note right of server: server + client->>server: 1. GET .../resource?query-parameters + server-->>client: 2. 200 OK (ResourceRepresentation) +or +404 Not Found + +``` + +Sequence diagram showing a client sending a GET request to a server and receiving a 200 OK or 404 Not Found response. + +**Figure 4.6.1.1.2.2-1: Query of a collection of resources by using query parameters.** + +Step 1. The client shall send a HTTP GET request using the URI of a resource modelled as Collection or Store archetype, optionally with query parameters, to the server. + +Step 2. On success, the server shall return a set of sub-resources that includes only those entries filtered by the query parameters. If no sub-resource is matched for the querying service operation, the server shall return "200 OK" with an empty array (e.g. "[ ]" in JSON) in response body. If the resource in the URI doesn't exist on the server, the server shall return "404 Not Found" with optionally the cause information in response body. + +NOTE: The result array/empty array can be defined as an attribute of an object, if the service operation returns an object in the response payload for extensibility consideration. + +Clause 4.9 specifies some possible options for an NF Service Producer to return the representations of multiple resources to a NF Service Consumer. + +##### 4.6.1.1.3 Updating a Resource + +###### 4.6.1.1.3.1 Usage of HTTP PUT + +Procedures that allow a service consumer NF (client) to update information stored at the server by means of a complete replacement shall be specified to use the HTTP PUT method to replace the current representation of a resource with a new representation. + +Figure 4.6.1.1.3.1-1 illustrates updating a resource using HTTP PUT. + +![Sequence diagram showing an NF service consumer sending a PUT request to an NF service producer and receiving a 204 No Content or 200 OK response.](2876be3592c7b4878400b85f209b2b6a_img.jpg) + +``` + +sequenceDiagram + participant consumer as NF service consumer + participant producer as NF service producer + Note left of consumer: NF service consumer + Note right of producer: NF service producer + consumer->>producer: 1. PUT .../resource (ResourceRepresentation) + producer-->>consumer: 2. 204 No Content () +or +200 OK + +``` + +Sequence diagram showing an NF service consumer sending a PUT request to an NF service producer and receiving a 204 No Content or 200 OK response. + +**Figure 4.6.1.1.3.1-1: Updating a Resource using HTTP PUT** + +1. The resource that is to be updated is identified by the request URI. The payload body of the PUT request shall contain the new representation of the resource. For forward compatibility, the NF service producer ignores unknown attributes in the received resource representation unless specified otherwise by the particular application. +2. On success, "204 No Content" or "200 OK" shall be returned. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PUT response body (see clause 4.8). + +If the resource that is to be updated does not exist at the NF service producer, the following applies: + +1. If the creation of that resource by PUT is supported, the resource is created according to the procedure in clause 4.6.1.1.1.3. +2. If the creation of that resource by PUT is not supported, the "403 Forbidden" HTTP status code shall be returned and appropriate additional error information should be returned in the PUT response body (see clause 4.8). + +###### 4.6.1.1.3.2 Usage of HTTP PATCH + +Procedures that allow a service consumer NF (client) to update information stored at the server by means of a partial replacement shall be specified to use the HTTP PATCH method (see IETF RFC 5789 [10]) to modify the current representation of a resource according to given modification instructions. The format of the PATCH message body shall be specified for each resource where the PATCH method is supported using one or several of the following encodings: + +- If no modification of individual elements within an array needs to be supported, the "JSON Merge Patch" encoding of changes defined in IETF RFC 7396 [7] should be used. +- If a modification of individual elements within an array needs to be supported, the "JSON Patch" encoding of changes defined in IETF RFC 6902 [8] shall be used. + +A single of the above encodings shall be specified for each resource where the PATCH method is supported unless backward compatibility considerations necessitate the support of both encodings. + +NOTE 1: In Rel-15 a single encoding will be selected for each resource as backward compatibility considerations do not yet apply. + +NOTE 2: "JSON Merge Patch" does not support the modification of individual elements within an array. However, it supports the modification of individual elements within maps (see clause 5.2.4.2). Collections of elements can be modelled as maps, instead of arrays, if a partial modification using PATCH is desired. + +NOTE 3: The Open API description of the body of HTTP PATCH requests is specified in clause 5.3.8. + +Figure 4.6.1.1.3.2-1 illustrates updating a resource using HTTP PATCH. + +![Sequence diagram illustrating the interaction between an NF service consumer and an NF service producer for updating a resource using HTTP PATCH.](db7cb51aac8519daab50e2171cecae82_img.jpg) + +``` +sequenceDiagram + participant Consumer as NF service consumer + participant Producer as NF service producer + Note left of Consumer: + Consumer->>Producer: 1. PATCH .../resource (ModificationInstructions) + Note right of Producer: + Producer-->>Consumer: 2. 204 No Content () or 200 OK + Note left of Consumer: + Note right of Producer: +``` + +The diagram shows a sequence of two messages between an NF service consumer and an NF service producer. The consumer sends a PATCH request to the producer, and the producer responds with a 204 No Content or 200 OK status. The lifelines are represented by dashed vertical lines, and the messages are shown as horizontal arrows. + +Sequence diagram illustrating the interaction between an NF service consumer and an NF service producer for updating a resource using HTTP PATCH. + +**Figure 4.6.1.1.3.2-1: Updating a Resource using HTTP PATCH** + +1. The resource that is to be updated is identified by the request URI. The payload body of the PATCH request shall contain a description of the requested modifications of the resource. For the "JSON Merge Patch" encoding defined in IETF RFC 7396 [7] and the "Content-Type" header shall be set to "application/merge-patch+json". For the "JSON Patch" encoding of changes defined in IETF RFC 6902 [8] the "Content-Type" header shall be set to "application/json-patch+json". For forward compatibility, the NF service producer shall ignore received modification instructions of unknown attributes in the resource unless specified otherwise by the particular application. +2. On success, "204 No Content" or "200 OK" shall be returned. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PATCH response body (see clause 4.8). + +##### 4.6.1.1.4 Deleting a Resource + +Procedures that allow a service consumer NF (client) to delete a resource from the server shall be specified to use the HTTP DELETE method (see IETF RFC 7231 [6]). + +Figure 4.6.1.1.4-1 illustrates deleting a resource. + +![Sequence diagram illustrating the interaction for deleting a resource. An NF service consumer sends a 1. DELETE .../resource () request to an NF service producer. The producer responds with a 2. 204 No Content () response.](ab846b81e78dbc8da2a6f9511e2f248a_img.jpg) + +``` + +sequenceDiagram + participant Consumer as NF service consumer + participant Producer as NF service producer + Note left of Consumer: + Consumer->>Producer: 1. DELETE .../resource () + Note right of Producer: + Producer-->>Consumer: 2. 204 No Content () + Note left of Consumer: + +``` + +Sequence diagram illustrating the interaction for deleting a resource. An NF service consumer sends a 1. DELETE .../resource () request to an NF service producer. The producer responds with a 2. 204 No Content () response. + +**Figure 4.6.1.1.4-1: Deleting a resource** + +The resource that is to be deleted is identified by the request URI. + +The payload body of the DELETE request shall be empty. + +On success, "204 No Content" should be returned and then the payload body of the DELETE response shall be empty. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the DELETE response body (see clause 4.8). + +##### 4.6.1.1.5 Query Parameters + +###### 4.6.1.1.5.1 General + +The query component in the URI contains non-hierarchical data that, along with data in the path component, to filter the resources identified within the scope of the URI's scheme to a subset of the resources matching the query parameters. The query component is indicated by the first question mark ("?") character and terminated by a number sign ("#") character or by the end of the URI. The syntax of the query component is specified in IETF RFC 3986 [9]. + +When a server receives a request with a query component, it shall parse the query string in order to identify filters. The first question mark is used to be a separator and is not part of the query string. A query string is composed of a series of "key=value" pairs, separated by "&". If one query parameter contains more than one value, i.e. an array of data elements, different values shall be separated by comma (","). + +The behaviour of the server, when receiving an HTTP/2 method with a query parameter which is of type array and only some of the members in the array can be matched, depends on each API and the behaviour shall be clearly described. + +If multiple query parameters are defined for a method on the resource, the default logical relationship of the query parameters shall be clearly described. + +###### 4.6.1.1.5.2 Complex query expression + +The complex query expression is used when there are multiple query parameters in the URI and the query condition needs to be expressed by a logical combination of multiple query parameters which overrides the default logical relationship of the query parameters. The complex query expression is either a Conjunctive Normal Form (CNF) or a Disjunctive Normal Form (DNF) which is equivalent to the logical combination of query parameters reflecting the query condition. + +The "complex-query" query parameter may be used when a complex query expression is needed to express a query condition. The value of the "complex-query" query parameter is of type "ComplexQuery" which is a JSON object, the corresponding CNF or DNF is encoded into that JSON object (see 3GPP TS 29.571 [5] for the details of the data type "ComplexQuery"). The use of "complex-query" shall be negotiated using the feature negotiation procedure as defined in 3GPP TS 29.500 [2]. + +If a query parameter is included in the "complexQuery" then the same query parameter shall not be included outside the "complexQuery" in the same request message. + +NOTE 1: It is not assumed that all APIs support "complex-query", the API supports this feature only when it is described in the corresponding specification. + +NOTE 2: The logical relationship between "complex-query" and the other query parameters defined for a particular API is described in the corresponding specification of that API. + +NOTE 3: The "complex-query" is not an additional explanation of the other query parameters, the condition expressed in the "complex-query" is evaluated along with the other queries. + +#### 4.6.1.2 Custom Operations + +Custom Operations provide procedures that allow a service consumer NF (client) to interact with an NF service producer in other ways than what is supported by the CRUD methods described in clause 4.6.1.1. + +Custom Operation can be related to a resource or can be related to an entire service and be independent of a resource. + +Figure 4.6.1.2-1 illustrates the use of a custom operation related to a resource. + +![Sequence diagram showing a custom operation request and response between an NF service consumer and an NF service producer.](a3953dce8dbd7ef15d61a314dbef2cf9_img.jpg) + +``` +sequenceDiagram + participant Consumer as NF service consumer + participant Producer as NF service producer + Note left of Consumer: 1. POST .../resource/custom-operation-name (Custom Operation Parameters) + Consumer->>Producer: Request + Note right of Producer: 2. 200 OK (Data related to Custom Operation) or 204 No Content() + Producer-->>Consumer: Response +``` + +The diagram illustrates a sequence of interactions between an NF service consumer and an NF service producer. The consumer sends a POST request to a specific resource URI with custom operation parameters. The producer responds with either a 200 OK status containing data related to the custom operation, or a 204 No Content status. + +Sequence diagram showing a custom operation request and response between an NF service consumer and an NF service producer. + +**Figure 4.6.1.2-1: Custom Operation on a Resource using HTTP POST** + +1. The request URI identifies the custom operation to be executed and the resource the custom operation relates to and is constructed by adding a verb as name for the custom operation at the end of the resource URI (see clauses 4.4.2 and 5.1.3.2). Parameters for the custom operation are included in the request body. +2. On success, "204 No Content" or "200 OK" shall be returned. "200 OK" shall contain a body with data related to the custom operation. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body (see clause 4.8). + +Figure 4.6.1.2-2 illustrates the use of a custom operation related to a service. + +![Sequence diagram showing a custom operation between an NF service consumer and an NF service producer. The consumer sends a POST request to a custom operation name with parameters. The producer responds with a 200 OK or 204 No Content.](26d664119ad25250780f554633444e54_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant NF service producer + Note right of NF service consumer: 1. POST .../custom-operation-name (Custom Operation Parameters) + NF service consumer->>NF service producer: Request + Note left of NF service producer: 2. 200 OK (Data related to Custom Operation) or 204 No Content() + NF service producer-->>NF service consumer: Response + +``` + +Sequence diagram showing a custom operation between an NF service consumer and an NF service producer. The consumer sends a POST request to a custom operation name with parameters. The producer responds with a 200 OK or 204 No Content. + +**Figure 4.6.1.2-2: Custom Operation related to Service using HTTP POST** + +1. The request URI identifies the custom operation to be executed and is constructed by adding a verb as name for the custom operation at the end of the service URI (see clauses 4.4.2 and 5.1.3.2). Parameters for the custom operation are included in the request body. +2. On success, "204 No Content" or "200 OK" shall be returned. "200 OK" shall contain a body with data related to the custom operation. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body (see clause 4.8). + +#### 4.6.1.3 Use of Asynchronous Operations + +Certain service operations may be designed to allow the invocation of a request so that the response can be received asynchronously: if the NF service consumer when sending a request cannot expect to receive an immediate final response, the service consumer may provide a callback reference for final result notification. The service provider, when receiving a request that contains a callback reference for final result notification, may then return an immediate "202 Accepted", and notify the service consumer about the final result using the received callback reference at a later point in time. + +#### 4.6.1.4 Special provisions to support the seamless change of AMF as NF service producer + +Services provided by the AMF can be transferred seamlessly to a new AMF when the corresponding UE context is transferred to that AMF. + +To support a seamless change of the AMF as NF service producer, the procedures in clause 4.6.1 are applied with the following special provisions: + +1. When becoming aware that a new AMF is serving the resource, the NF service consumer shall exchange the authority part of resource URIs with the address of a new NF service producer and shall use that URI in subsequent communication. +- NOTE: An NF service consumer can become aware of an AMF change via Namf\_Communication service AMFStatusChange Notifications, via Error response from old AMF, via link level failures (e.g. no response from the AMF), or via a notification from the NRF that the AMF has deregistered and can then determine the new AMF either via information received within those services or by selecting an AMF from an earlier received AMF set or the backup AMF. +2. Each AMF within a set of AMFs supporting seamless changes shall be prepared to receive updates for resource URIs constructed according to bullet 1 with the own IP address as authority part from the NF service consumer, by either handling the updates, or by replying with an HTTP "307 temporary redirect" error response pointing to new NF service producer, or by replying with another HTTP error such as an "404 Not found". + 3. For a service that includes notifications from the AMF, the NF service consumer shall be prepared to receive notifications for the that service from any NF service producer within a set of NF service producers supporting seamless changes. + +### 4.6.2 Use of Subscribe/Notify Communication + +#### 4.6.2.1 General + +Subscribe/Notify communication between 5GC NFs can be used to keep involved NFs (consumers of a service) informed of data changes or events that occur at another NF (producer of the service). A notification is a message that contains information about the event. + +Service consumer NFs (clients) need to subscribe to notifications at the service provider NF (server). This either happens explicitly by means of creating a new subscription resource (see clause 4.6.2.2), or implicitly by updating a relevant resource. + +When the change/event occurs at the service producer NF, notifications (see clause 4.6.2.3) are sent from the service producer NF to the service consumer NFs. This communication initiated by the service producer to the service consumers requires that the service consumer NF (client) takes the role of an HTTP server and the service producer NF (server) takes the role of an HTTP client. + +During the explicit subscription the service consumer NF (client) provides a callback URI and possibly additional filter criteria to the service producer NF (server). When the data-change/event occurs that matches the filter criteria in the subscription, the service producer NF (taking the role of an HTTP client) uses the provided callback URI to notify the service consumer NF (taking the role of an HTTP server) about the change. + +#### 4.6.2.2 Management of Subscriptions + +##### 4.6.2.2.1 General + +The HTTP method to create a subscription shall be POST. The HTTP method to modify a subscription shall be PUT or PATCH. The HTTP method to delete a subscription (i.e. to unsubscribe) shall be DELETE (see IETF RFC 7231 [6]). + +Subscriptions may be implicit, i.e. exist without being explicitly created by a dedicated subscribe operation. + +Two types of implicit subscriptions exist: + +1. The subscription is implied by an explicit operation different from the subscribe operation, which does not use the GET method. The subscription implied by the explicit operation and the corresponding notification shall be part of the same service. +2. The subscription exists without any explicit operation. + +As an example for the first type, at the UDM the registered AMF (as long as it is registered) is implicitly subscribed to notification about de-registration and (possibly) P-CSCF restoration as side effect of the registration. + +As another example for the first type, at the SMF, the AMF that created a SM Context for a PDU session is implicitly subscribed for SM Context Status notification. At AMF change the new AMF updates the SMF with its callback URI for receiving subsequent SM Context Status notification. + +As an example for the second type, at the UDR any available UDM is implicitly subscribed to notification about changes of provisioned subscriber data. When provisioned subscriber data are modified at the UDR by means of provisioning, the UDR selects one of the available UDMs (i.e. one of the implicitly subscribed UDMs) and notifies it about the subscriber data change. + +In the OpenAPI specification file, notifications for the second type of implicit subscriptions shall be specified as part of an explicit subscription. + +##### 4.6.2.2.2 Creation of a Subscription + +Figure 4.6.2.2.2-1 illustrates explicit creation of a subscription. + +![Sequence diagram showing the creation of a subscription. An NF service consumer sends a POST request to an NF service producer, and the producer responds with a 201 Created status.](2ae3eae1bd80a90f192f568ae246a9a6_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant NF service producer + Note left of NF service consumer: + Note right of NF service producer: + NF service consumer->>NF service producer: 1. POST .../xyz-subscriptions (XyzSubscription) + NF service producer-->>NF service consumer: 2. 201 Created (XyzSubscription) +``` + +Sequence diagram showing the creation of a subscription. An NF service consumer sends a POST request to an NF service producer, and the producer responds with a 201 Created status. + +**Figure 4.6.2.2.2-1: Creation of a subscription** + +The parent resource (collection of subscriptions) is identified by the request URI. + +The data structure in the payload body of the POST request shall contain a callback URI, and may contain additional criteria to filter the set of events that trigger a notification. The request may contain an expiry time, suggested by the NF Service Consumer as a hint, representing the time up to which the subscription is desired to be kept active and the time after which the subscribed event shall stop generating notifications. + +On success, "201 Created" shall be returned, the payload body of the POST response shall contain a representation of the created subscription, and the "Location" header shall contain the URI of the created resource. The created resource shall be served by the same NF (service) instance that received the service request, unless the 5GC SBI API specifications explicitly specified that in specific use cases the created resource may be served by another NF (service) instance. If in such specific use cases the resource is created in a different NF (service) instance, the identifier of the serving NF (service) instance shall be included in the response message. + +If the HTTP scheme used in the returned URI is "https", then the authority of the URI included in the Location header shall be an FQDN, and not an IP address. + +The response based on operator policies and taking into account the expiry time included in the request, may contain an expiry time (i.e. a future timestamp), as determined by the NF Service Producer, after which the subscription becomes invalid. If an expiry time was included in the request, then the expiry time returned in the response should be less than or equal to that value. Once the subscription expires, if the NF Service Consumer wants to keep receiving notifications, it shall create a new subscription in the NF Service Producer. The NF Service Producer shall not provide the same expiry time (i.e. a future timestamp) for many subscriptions in order to avoid all of them expiring and recreating the subscription at the same time. If the expiry time is not included in the response, the NF Service Consumer shall consider the subscription to be valid without an expiry time. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body (see clause 4.9). + +##### 4.6.2.2.3 Modify a subscription + +###### 4.6.2.2.3.1 Modification of a Subscription Using HTTP PUT + +Procedures that allow a NF service consumer to update the subscription at the server by means of a complete replacement shall use the HTTP PUT method to replace the current subscription with a new representation. + +Figure 4.6.2.2.3.1-1 illustrates modification a subscription using HTTP PUT. + +![Sequence diagram for modification a subscription using HTTP PUT](9c1d3678db4a12d5864cb2a4def1135d_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant NF service producer + Note left of NF service consumer: 1. PUT .../{subscriptionId} (XyzSubscription) + NF service consumer->>NF service producer: 1. PUT .../{subscriptionId} (XyzSubscription) + Note right of NF service producer: 2. 204 No Content () or 200 OK(XyzSubscription) + NF service producer-->>NF service consumer: 2. 204 No Content () or 200 OK(XyzSubscription) +``` + +The diagram illustrates the interaction between an NF service consumer and an NF service producer for modifying a subscription using HTTP PUT. The consumer sends a PUT request to the resource URI representing the individual subscription, with a payload body containing the subscription information to be replaced. The producer responds with either a 204 No Content status code or a 200 OK status code with a response body providing the current resource representation. + +Sequence diagram for modification a subscription using HTTP PUT + +**Figure 4.6.2.2.3.1-1: Modification a subscription using HTTP PUT** + +1. The NF Service Consumer shall send a PUT request to the resource URI representing the individual subscription. The payload body of the PUT request shall contain the subscription information to be replaced including the criteria to filter the set of events that trigger a notification. The request may contain an updated expiry time, suggested by the NF Service Consumer as a hint, to extend the subscription lifetime, representing the time upto which the subscription is desired to be kept active and the time after which the subscribed event shall stop generating notifications. +2. On success, "204 No Content" without any response body or "200 OK" with a response body providing current resource representation shall be returned. When "200 OK" is returned, the response based on operator policies and taking into account the expiry time included in the request, may contain an expiry time (i.e a future timestamp), as determined by the NF Service Producer, after which the subscription becomes invalid. If an expiry time was included in the request, then the expiry time returned in the response should be less than or equal to that value. Once the subscription expires, if the NF Service Consumer wants to keep receiving notifications, it shall create a new subscription in the NF Service Producer, as specified in clause 4.6.2.2.2. The NF Service Producer shall not provide the same expiry time (i.e. a future timestamp) for many subscriptions in order to avoid all of them expiring and recreating the subscription at the same time. If the expiry time is not included in the response, the NF Service Consumer shall consider the subscription to be valid without an expiry time. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PUT response body (see clause 4.8). + +If the NF Service Consumer is not allowed to update the subscription information, the "403 Forbidden" HTTP status code shall be returned and appropriate additional error information should be returned in the PUT response body (see clause 4.8). + +If the resource that is to be updated does not exist at the NF service producer, the "404 Not Found" HTTP status code shall be returned. + +###### 4.6.2.2.3.2 Modification of a Subscription Using HTTP PATCH + +Procedures that allow a NF service consumer to update subscription at the server by means of a partial replacement shall use the HTTP PATCH method (see IETF RFC 5789 [10]) to modify the current subscription according to given modification instructions. + +Figure 4.6.2.2.3.2-1 illustrates updating a resource using HTTP PATCH. + +![Sequence diagram for modification a subscription using HTTP PATCH](49a49278cad196bdfe0db6b4dd1be7fd_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant NF service producer + Note left of NF service consumer: 1. PATCH .../{subscriptionId}(ModificationXyzSubscription) + NF service consumer->>NF service producer: 1. PATCH .../{subscriptionId}(ModificationXyzSubscription) + Note right of NF service producer: 2. 204 No Content () or 200 OK(ModifiedXyzSubscription) + NF service producer-->>NF service consumer: 2. 204 No Content () or 200 OK(ModifiedXyzSubscription) +``` + +The diagram illustrates the interaction between an NF service consumer and an NF service producer for modifying a subscription using HTTP PATCH. The consumer sends a PATCH request to the resource URI representing the individual subscription, with a payload body containing the modification instructions. The producer responds with either a 204 No Content status code or a 200 OK status code with a response body providing the current resource representation. + +Sequence diagram for modification a subscription using HTTP PATCH + +**Figure 4.6.2.2.3.2-1: Modification a subscription using HTTP PATCH** + +1. The NF Service Consumer shall send a PATCH request to the resource URI representing the individual subscription. The payload body of the PATCH request shall contain the modification instructions. The request may contain an expiry time (i.e. a future timestamp), requested by the NF Service Consumer, representing the time upto which the subscription is desired to be kept active and the time after which the subscribed event shall stop generating notifications. +2. On success, "204 No Content" without any response body or "200 OK" with a response body containing the modified subscription information shall be returned. When "204 No Content" is returned and if the request included an expiry time, then the requested expiry time shall be accepted by the NF Service Producer. When "200 OK" is returned and if the request included an expiry time then the response based on operator policies and taking into account the expiry time included in the request, shall contain an expiry time (i.e. a future timestamp), as determined by the NF Service Producer, after which the subscription becomes invalid. If an expiry time was included in the request, then the expiry time returned in the response should be less than or equal to that value. Once the subscription expires, if the NF Service Consumer wants to keep receiving notifications, it shall create a new subscription in the NF Service Producer, as specified in clause 4.6.2.2.2. The NF Service Producer shall not provide the same expiry time (i.e. a future timestamp) for many subscriptions in order to avoid all of them expiring and recreating the subscription at the same time. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PATCH response body (see clause 4.8). + +##### 4.6.2.2.4 Delete a subscription + +Figure 4.6.2.2.4-1 illustrates explicit deletion of a subscription. + +![Sequence diagram showing the deletion of a subscription. The NF service consumer sends a DELETE request to the NF service producer, and the producer responds with a 204 No Content.](55136bc716146672fc680fa05989f1d2_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant NF service producer + Note left of NF service consumer: + Note right of NF service producer: + NF service consumer->>NF service producer: 1. DELETE .../{subscriptionId} () + NF service producer-->>NF service consumer: 2. 204 No Content () +``` + +Sequence diagram showing the deletion of a subscription. The NF service consumer sends a DELETE request to the NF service producer, and the producer responds with a 204 No Content. + +Figure 4.6.2.2.4-1: Deletion of a subscription + +1. The NF Service Consumer shall send a DELETE request to the resource URI representing the individual subscription. The request body shall be empty. +2. On success, "204 No Content" shall be returned. The response body shall be empty. + +On failure, the appropriate HTTP status code indicating the error shall be returned in the DELETE response body (see clause 4.8). + +#### 4.6.2.3 Notifications + +The HTTP method for the notification that corresponds to an explicit subscription shall be POST (see IETF RFC 7231 [6]). + +NOTE: Clause 5.3.7 describes how to encode Notifications in OpenAPI specification files. + +Figure 4.6.2.3-1 illustrates a notification. + +![Sequence diagram illustrating the Notification process between an NF service consumer (HTTP server) and an NF service producer (HTTP client).](dd5771673aececa53d42ece89218299d_img.jpg) + +``` + +sequenceDiagram + participant NFSC as NF service consumer +(taking the role of a +HTTP server) + participant NSP as NF service producer +(taking the role of a +HTTP client) + Note left of NFSC: + Note right of NSP: + NSP->>NFSC: 1. POST {callback_ref} (Notification) + NFSC-->>NSP: 2. 200 OK or 204 No Content + +``` + +The diagram shows two participants: 'NF service consumer (taking the role of a HTTP server)' on the left and 'NF service producer (taking the role of a HTTP client)' on the right. A solid arrow labeled '1. POST {callback\_ref} (Notification)' points from the producer to the consumer. A dashed arrow labeled '2. 200 OK or 204 No Content' points from the consumer back to the producer. + +Sequence diagram illustrating the Notification process between an NF service consumer (HTTP server) and an NF service producer (HTTP client). + +**Figure 4.6.2.3-1: Notification** + +1. The callback reference provided during creation of the subscription resource, or otherwise known from implicit subscription, is used as the request URI. The callback reference for implicit subscriptions are obtained from the NRF. When an NF / NF service registers with the NRF, the default notification subscriptions along with the callback URI for receiving those notifications may be provided (see clause 6.1.6.2.3 of 3GPP TS 29.510 [18]). + +The payload body of the POST request shall contain the notification payload. + +2. On success, "200 OK" shall be returned if any information needs to be included in the payload body of the POST response; otherwise, "204 No Content" shall be returned and the payload body of the POST response shall be empty. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body (see clause 4.8). + +#### 4.6.2.4 Special provisions to support the seamless change of AMF as NF service consumer + +Services consumed by an AMF can be transferred seamlessly to a new AMF when the corresponding UE context is transferred to that AMF. + +To support a seamless change of AMF as NF service consumer, the procedures in clause 4.6.2 are applied with the following special provisions: + +1. When becoming aware that a new AMF is requiring notifications related to a subscription resource, the NF service producer shall exchange the authority part of the corresponding Notification URI with the address of that new NF service consumer and shall use that URI in subsequent communication. + +**NOTE:** An NF service producer can become aware of an AMF change via Namf\_Communication service AMFStatusChange Notifications, via Error response from old AMF, via link level failures (e.g. no response from the AMF), or via a notification from the NRF that the AMF has deregistered and can then determine the new AMF either via information received within those services or selecting an AMF from an earlier received AMF set or the backup AMF. + +2. Each AMF within a set of AMFs supporting seamless changes shall be prepared to receive notifications at the Notification URI constructed according to bullet 1 with the own IP address as authority part from the NF service producer, by either handling the notifications, or by replying with an HTTP "307 temporary redirect" error response pointing to new NF service consumer, or by replying with another HTTP error such as an "404 Not found". + +## 4.7 HATEOAS + +### 4.7.1 General + +As defined in [14], HATEOAS stands for Hypermedia As The Engine Of Application State. It means that the hypermedia models application state transitions and describe application protocols. + +As defined in [15] chapter 3 RESTful Domain Application Protocols, an application is a software implementation defined to achieve a particular goal. It consists of a set of constrained interactions between NF Service Consumer and Producer performed at run-time that are guided by an application specific set of rules. The application transits across some intermediate states until the application's goal is achieved. The application has then reached its final state. + +An application state is a snapshot of an application instance. + +On each interaction, the NF Service Consumer and Producer exchange representations of resource state. According to [14], "REST concentrates all of the control state into the representations received in response to interactions." and "The model application is therefore an engine that moves from one state to the next by examining and choosing from among the alternative state transitions in the current set of representations." After each interaction the NF Service Consumer is then presented with control state options to interact with additional resources. These control states are in the form of hypermedia markups embedded in the returned resource representation. The application state changes when an NF Service Consumer examines and chooses which control to operate and subsequently interacts with the resources identified in the selected control state. + +HATEOAS support is optional. If HATEOAS is supported, the procedure in the present clause 4.7 shall apply. + +### 4.7.2 3GPP hypermedia format + +#### 4.7.2.1 Basic 3GPP hypermedia format + +NOTE 1: Basic 3GPP hypermedia format is derived from Hypertext Application Language (HAL). HAL is specified in an expired internet draft available at "https://tools.ietf.org/html/draft-kelly-json-hal-08". + +Basic 3GPP hypermedia format specifies the following optional reserved properties (see 3GPP TS 29.571 [5] for the complete list and definition of objects and object members): + +- "\_links": contains links to other resources and expresses valid state transitions. + +A NF service producer shall construct a basic 3GPP hypermedia document by taking a 3GPP defined JSON object attribute list and then adding a "\_links" attribute. + +**Table 4.7.2.1-1: \_links attribute** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------------|---|-------------|-------------------------------------------------------------------------| +| _links | map(LinksValueSchema) | C | 0..N | _links attribute to be added into the JSON hypermedia object definition | + +The LinksValueSchema data type shall be added to the list of re-used data types of the hypermedia enabled API (see 3GPP TS 29.509 [21] for an example of implementation of a hypermedia API). + +NOTE 2: Depending of the applicable situation, the presence condition and the cardinality can be changed in accordance. LinksValueSchema data type is defined in 3GPP TS 29.571 [5]. + +The "\_links" member names are link relation types (as defined by IETF RFC 8288 [11]) and values are either a "link" object or an array of "link" objects. + +Basic 3GPP hypermedia format specifies the following "link" attribute: + +- "href": contains the URI of the linked resource. + +A NF service producer shall set the Content-Type HTTP header to "application/3gppHal+json" when returning an HTTP payload with a basic 3GPP hypermedia enabled document. + +A NF service consumer supporting HATEOAS shall advertise it by adding an "Accept" HTTP header with "application/3gppHal+json" as media type. + +NOTE 3: The HATEOAS principle relies on NF Service Producer providing control state options (\_links objects) embedded in the returned resource representation to the NF Service Consumer. An NF Service Consumer may decide to use the format of the \_links attribute in HTTP requests to transfer URIs. This is beyond the scope of HATEOAS and another content type than "3gppHal+json" such as "application/json" can be used. + +#### 4.7.2.2 Extended 3GPP hypermedia format + +NOTE 1: Extended 3GPP hypermedia format is derived from HAL-FORMS media type, see ["https://rwcbbook.github.io/hal-forms/"](https://rwcbbook.github.io/hal-forms/). + +Extended 3GPP hypermedia format specifies the following optional reserved properties (see 3GPP TS 29.571 [5] for the complete list and definition of objects and object members): + +- "`_links`": contains links to other resources and expresses valid state transitions; +- "`_templates`": contains the HAL templates corresponding to the `_links` attribute. + +A NF service producer shall construct a extended 3GPP hypermedia document by taking a 3GPP defined JSON object attribute list and then adding "`_links`" attribute and "`_templates`" attribute. + +**Table 4.7.2.2-1: `_halForms` attribute** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------|-------------------------------|---|-------------|-----------------------------------------------------------------------------------------------------| +| links | map(Link) | C | 1..N | The key is the name of the link relation type. | +| _templates | map(HalTemplate) | C | 1..N | The key is the name of the corresponding link relation type to which the template is to be applied. | + +The Link data type and HalTemplate data type shall be added to the list of re-used data types of the hypermedia enabled API. + +NOTE 2: Depending of the applicable situation, the presence condition can be changed in accordance. Link and HalTemplate data types are defined in 3GPP TS 29.571 [5]. A NF service producer shall set the Content-Type HTTP header to "`application/3gppHalForms+json`" when returning an HTTP payload with Extended 3GPP hypermedia enabled document. + +A NF service consumer supporting HATEOAS and extended 3GPP hypermedia shall advertise it by adding an "Accept" HTTP header with "`application/3gppHalForms+json`" as media type. + +### 4.7.3 Advertising legitimate application state transitions + +When a NF service producer responds to a NF service consumer and there is one or more application state transition possible, the NF service producer shall advertise them by adding a "`_links`" property in the returned resource representation. When there are multiple state transitions with different relation types, then one member per relation type shall be added to the "`_links`" object which name is equal to the relation type. If there is only one state transition for a given relation type then the value of the member is a "link" object otherwise it is an array of "link" objects. + +A NF service producer shall include a link into the returned resource representation with a registered relation type "`self`" when it is expected further actions upon it (for instance reading it again or replacing the resource state). + +NOTE 1: For a hypermedia application, a returned representation without any link denotes for the NF service consumers the end of the interaction with the NF service producer. 3GPP APIs does not fulfil this rule. + +### 4.7.4 Inferring link relation semantic + +When a NF service consumer receives a response with linked resources then it shall infer the link relation semantic from the relation type. It shall not infer it from the linked resource URI format. + +In 3GPP hypermedia, relation types are the name of "`_links`" object members. + +### 4.7.5 Common Relation Types + +#### 4.7.5.1 Introduction + +This clause contains the list of relation types supported in 3GPP Service Based Interface APIs. + +As defined in IETF RFC 8288 [11] clause 2.1, a link relation type identifies the semantics of a link. It describes how resources are related to each other. It may also be used to indicate that the target resource of a link has particular attributes, or exhibits particular behaviours. Relation types shall not be confused with media types. It does not identify the format of the representation that results when the link is dereferenced. + +There are two kinds of relation types: + +- Registered relation types; +- Extension relation types. + +Registered relation types are identified by a token (for instance "self") and can be reused by other applications such as 3GPP SBI APIs. They are registered by IANA. Registered relation types shall be preferred against extension relation types when expressing the link relation between two resources. + +If there is a need to define a relation type that does not correspond to a registered one but it is not wanted to register it then an extension relation type shall be used instead. + +#### 4.7.5.2 Registered relation types + +The "Link Relations" registry is located at: . + +Table 4.7.5.2-1 specifies the list of registered relation types supported by all hypermedia enabled 3GPP APIs. + +Table 4.7.5.2-2 specifies the list of registered relation types that can be used by some hypermedia enabled 3GPP APIs, depending on the API design. + +**Table 4.7.5.2-1: mandatory registered relation types** + +| Relation name | +|---------------| +| self | + +**Table 4.7.5.2-2: optional registered relation types** + +| Relation name | +|---------------| +| next | +| first | +| previous | +| last | +| item | + +#### 4.7.5.3 Extension relation types + +When no registered relation exists to express the relation between two resources, an extension relation type shall be used instead. It may be defined as a string token or as a URI as defined in IETF RFC 8288 [11]. + +An API specification using extension relation types shall contain a clause "Relation types" in the clause "Simple data types and enumerations" (see 3GPP TS 29.509 [21] for an example of implementation of a hypermedia API). The clause shall contain a table listing the token or the URI of the created relation types. It shall also contain a detailed specification of the semantic of the relation types defining the conditions that the NF Service Consumer shall match to follow a link. + +### 4.7.6 Negotiating the support of optional HATEOAS features + +The supported feature mechanism in clause 6.6.2 of 3GPP TS 29.500 [2] should be used to negotiate the usage of optional HATEOAS features in addition to negotiating the content type "3gppHal+json" and "3gppHalForms+json". Separate supported features can be defined for link relation types related to different use cases. + +## 4.8 Error Responses + +### 4.8.1 Error Response Status Code + +When an error occurs that prevents the NF/NF service acting as an HTTP server from successfully fulfilling the HTTP request, the NF/NF service shall map an application error to the most similar 4xx/5xx HTTP status code as defined in clause 5.2.7 of 3GPP TS 29.500 [2]. + +### 4.8.2 Error Response Body + +When the HTTP status code is not enough for the NF/NF service acting as an HTTP client to determine the cause of the error, the NF/NF service acting as an HTTP server should provide additional application related error information, by including in the response body a representation of a "ProblemDetails" data structure according to IETF RFC 7807 [19] that provides additional details of the error. + +NOTE 1: The response body with the "ProblemDetails" data structure does not need to be sent on a 3GPP 5GC API for a particular HTTP status code if that HTTP status code itself provides enough information of the error, or if there are security concerns disclosing detailed error information. + +The definition of the general "ProblemDetails" data structure from IETF RFC 7807 [19] is specified in clause 5.2.4.1 of 3GPP TS 29.571 [5]. The "ProblemDetails" data structure is a JSON object, as defined in IETF RFC 7807 [19], and contains the following attributes: + +- a) "type" - a URI reference according to IETF RFC 3986 [9] that identifies the problem type; +- b) "title" - a short, human-readable summary of the problem type that should not change from occurrence to occurrence of the problem; +- c) "status" - the HTTP status code for this occurrence of the problem; +- d) "detail" - a human-readable explanation specific to this occurrence of the problem; and +- e) "instance" - a URI reference that identifies the specific occurrence of the problem. + +A particular API may define additional attributes that provide more information about the error. + +NOTE 2: IETF RFC 7807 [19] allows adding of new properties in the "ProblemDetails" object. + +The following additional attributes are generic extensions defined for the 3GPP 5GC APIs: + +- a) "cause"- a machine-readable application error cause specific to this occurrence of the problem; and +- b) "invalidParams" - invalid parameters causing a request to be rejected. + +The "cause" attribute should be included and provide application-related error information, if available. Application error causes should be defined in 5GC SBI APIs specifications, using the UPPER\_WITH\_UNDERSCORE case convention specified in clause 5.1.1. + +EXAMPLE 1: "OUT\_OF\_LADN\_SA". + +The "invalidParams" attribute should be used to report invalid parameters when a request is rejected due to invalid parameters. + +All the application error causes supported by an API should be defined in a specific clause "Application Errors" under the "Error Handling" clause specified for the API. The application error causes that a specific service operation may respond should be further listed in the table defining the data structure supported by the response body, with the associated HTTP error status code. + +For service operations that require to provide additional, non-error related, application information in an error response (e.g. SMF returning a NAS SM message to be sent to the UE within an error response to the AMF), an application-specific data structure should be defined for the corresponding service operation's response, including one "error" attribute defined with the "ProblemDetails" data structure, and the other application-specific attributes as required for the API. + +EXAMPLE 2: See "SmContextCreateError" data type in 3GPP TS 29.502 [20]. + +The NF/NF service that generates the HTTP response shall include in the HTTP response a "Content-Type" header field set to: + +- "application/problem+json", if the response includes a payload body containing the "ProblemDetails" data structure; or +- "application/json", if the response includes a payload body containing an application-specific data structure. + +### 4.8.3 Extending ProblemDetails for API Backward Compatibility + +For a service operation that returns "ProblemDetails" in error responses in a given release, if in a later release it is required to provide additional application specific information in the error responses, the API should be modified to return an Extended-ProblemDetails data type by reusing the "ProblemDetails" common data type, as specified in clause 5.3.17, to keep the API backward compatibility. + +The "Content-Type" header shall be set to "application/problem+json" for the error response with the payload body containing the Extended-ProblemDetails data type define above. + +EXAMPLE: + +- an "AdditionInfo" structured data type containing the additional information to be returned, as specified in clause 5.2.4.2: + +**Table 4.8.3-1 Definition of type AdditionInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------------------------|------------------------------------------------------------|-----------------|-----------------------|----------------------|---------------| +| | "" or "array()" or "map()" or "Any Type" | "M", "C" or "O" | "0..1", "1" or "M..N" | | | + +- a "ProblemDetails" data type as combination of "ProblemDetails" common data type and "AdditionInfo" data type define above, as specified in clause 5.2.4.5: + +**Table 4.8.3-2 Definition of type ProblemDetails as a list of to be combined data types** + +| Data type | Cardinality | Description | Applicability | +|--------------------------------|-------------|----------------------|---------------| +| ProblemDetails | 1 | | | +| AdditionInfo | 1 | | | + +Example OpenAPI specification of ProblemDetails data type, as specified in clause 5.3.10: + +``` +components: + schemas: + ProblemDetails: + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + - $ref: '#/components/schemas/AdditionInfo' +``` + +Example OpenAPI specification of an error response returning ProblemDetails data type: + +``` +responses: + '504': + description: Gateway Timeout + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' +``` + +## 4.9 Transferring multiple resources to a NF Service Consumer + +### 4.9.1 General + +This clause describes some possible options that an API may implement when a NF Service Producer needs to return the representations of multiple resources to a NF Service Consumer, e.g. during the query of a large collection of resources (see clause 4.6.1.1.2.2). + +Which options an API may support is defined in the respective stage 3 specification of the API. + +### 4.9.2 Direct Delivery + +A NF Service Producer may return the representations of the resources directly in the response body, i.e. the response body contains an array of the resource representations. + +### 4.9.3 Direct Delivery with Iterations + +If a large number of resource representations need to be returned, the NF Service Producer may return a representation containing a partial list of the requested resources in the response body, with link(s) containing URI(s) allowing the client to retrieve the remaining part(s) of the resources. + +The returned representation containing a partial list of the requested resource is a "3gppHal+json" document. The document is a JSON object with two members whose names are below. + +- `_links`. +- `child`: contains the resources of the partial list. + +The member whose name is "`_links`" shall contain a member whose name is "`self`" and whose value is a "`link`" object that contains the URI of the returned representation. It shall also contain a member whose name is "`next`" and whose value is a "`link`" object that contains the URI of the next partial list of the collection if the returned partial list is not the last one. + +The member whose name is "`_links`" should also contain members whose names are "`first`", "`previous`" and "`last`" and whose values contain a "`link`" object that contains the URIs of the first, previous and last partial lists of the collection if such lists exist. + +The returned representation shall have a member whose name is "`child`" and whose value is an array of objects. Each of the individual resource representations returned in the partial list shall be embedded in an object of that array. Each object shall also have a member whose name is "`_links`". The later shall contain a member whose name is "`self`" and whose value is a "`link`" object that contains the URI of the embedded representation. + +The table below provides a template to be added in the chapter describing the GET operation of a 3GPP API using the direct delivery with iteration mechanism. + +**Table 4.9.3-1: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------|---|-------------|----------------|-------------------------------------------------------------------------------------------------------------------------------| +| PartialList | M | 1 | 200 OK | This case represents a successful return of a partial list for the corresponding request with direct delivery with iteration. | + +The following data types shall be added to the list of specific data types and described as below in the structured data type chapter. + +Table 4.7.2-1: PartialList + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------------------------------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| _links | map(LinksValueSchema) | M | 1..N | contains the pagination links | +| child | array(ApiSpecificHypermediaEnabledIndividualResource) | M | 1..N | contains the individual resources with a self link.
The data type in the array is specific to the API and is a hypermedia enabled version of the individual resource data type. | + +Table 4.7.2-1: ApiSpecificHypermediaEnabledIndividualResource + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-----------------------------| +| attribute1 | | | | | +| attribute2 | | | | | +| ... | | | | | +| attribute N | | | | | +| _links | selfLink | M | 1 | contains the link to itself | + +NOTE 1: attributes 1 to N are the attributes of the original individual resource. + +The LinksValueSchema and SelfLink data types shall be added to the list of re-used data types of the 3GPP API. + +A NF Service Consumer that receives link(s) in the response body may retrieve the remaining part(s) of the resources by sending GET requests towards the URI(s) contained in the link(s). + +### 4.9.4 Indirect Delivery + +A NF Service Producer may not return any requested resource representation and instead may return a representation containing only a list of links to the requested resources in the response body. + +The returned representation containing the list is a "3gppHal+json" document. The document is a JSON object with one member whose name is: + +- \_links. + +This member shall contain a member whose name is "item" and whose value is an array of "link" objects. Each of the link objects contains one requested resource URI. There shall be one link object per requested resource. + +It shall also contain a member whose name is "self" and whose value is a "link" object that contains the URI of the returned representation. + +A NF Service Consumer that receives such a response may then send a GET request per resource URI to retrieve the requested resources from the NF Service Producer. + +### 4.9.5 Indirect Delivery with HTTP/2 Server Push + +A NF Service Producer may use HTTP/2 Server Push, if HTTP/2 Server Push is supported in the PLMN. + +To use HTTP/2 Server Push, the NF Service Producer shall send PUSH\_PROMISE frames in the HTTP response, with each PUSH\_PROMISE frame containing a GET request targeting the URI of one resource to be transferred and the reserved stream identifier to be used for transferring the resource. Then the NF Service Producer shall send Push Responses via the corresponding reserved streams, with each Push Response containing the representation of the associated resource. The NF Service Producer shall also send links with the URIs of the resources in DATA frame(s) of the response message. + +A NF Service Consumer may disable HTTP/2 Server Push by sending SETTINGS\_ENABLE\_PUSH parameter with value "0" on HTTP level, as specified in IETF RFC 7540 [13]. + +![Sequence diagram illustrating Indirect Delivery with HTTP/2 Server Push between an NF Service Consumer and an NF Service Producer.](6629e8a87e7552e2454b7c3e9f6d73a0_img.jpg) + +``` + +sequenceDiagram + participant Consumer as NF Service Consumer + participant Producer as NF Service Producer + Note right of Producer: 2. Detects of sending multiple resources and choose to use Server Push + Consumer->>Producer: 1. Ask for resources (HTTP GET /resource-path?query-parameters) + Producer-->>Consumer: 3. HTTP 200 OK + Note left of Consumer: PUSH_PROMISE frame 1 +(:path=,stream id=) +PUSH_PROMISE frame 2 +(:path=,stream id=) +... +PUSH_PROMISE frame N +(:path=,stream id=) +Response HEADERS frame & DATA frames +(List of URIs of the resources) + Note left of Consumer: 4.1 Push response +(body: data representation of ) ————— Stream: + Note left of Consumer: 4.2 Push response +(body: data representation of ) ————— Stream: + Note left of Consumer: ... +4.n Push response +(body: data representation of ) ————— Stream: + Note left of Consumer: 5. Get Single Resource Request +(:path=) - - - - -> Producer + Note left of Consumer: 5.a. Get Single Resource Response +(body: data representation of ) - - - - -> Consumer + +``` + +The diagram illustrates the interaction between an NF Service Consumer and an NF Service Producer for indirect delivery using HTTP/2 Server Push. The sequence of messages is as follows: + +- The NF Service Consumer sends a request (HTTP GET /resource-path?query-parameters) to the NF Service Producer. +- The NF Service Producer detects that multiple resources need to be sent and decides to use the Server Push mechanism. +- The NF Service Producer responds with an HTTP 200 OK status. Before the response headers and data frames, it sends multiple PUSH\_PROMISE frames (1 to N). Each PUSH\_PROMISE frame contains a path (resource URI) and a stream ID. +- Following the PUSH\_PROMISE frames, the NF Service Producer sends the response headers and data frames, which include a list of URIs of the resources. +- The NF Service Consumer receives individual push responses (4.1 to 4.n) for each resource, each associated with a specific stream ID. +- The NF Service Consumer then sends a request for a single resource (5. Get Single Resource Request). +- The NF Service Producer responds with the single resource data (5.a. Get Single Resource Response). + +Sequence diagram illustrating Indirect Delivery with HTTP/2 Server Push between an NF Service Consumer and an NF Service Producer. + +Figure 4.9.5-1 Indirect Delivery with HTTP/2 Server Push + +1. A NF Service Consumer sends a HTTP request to get resources(s) to the NF Service Producer, e.g. a query of a collection of resources. +2. The NF Service Producer detects that multiple resources are to be returned and choose to indirectly deliver the resources with the Server Push mechanism. +3. The NF Service Producer returns multiple PUSH\_PROMISE Requests before HEADERS frame and DATA frames(s) to the NF Service Consumer. Each PUSH\_PROMISE Request contains the URI of one resource to be + +transferred and the identifier of the reserved stream used for transferring the resource. The NF Service Producer shall also send links with the URIs of the resources in DATA frame(s) of the response message. + +- 4.1-4.n. The NF Service Producer sends Push Responses via corresponding reserved streams. Each Push Response contains the representation of the associated resource. +- 5. If the NF Service Consumer does not successfully receive a resource in time, it may send a request to get that resource, using the resource URI previously received from the Push Request. +- 5.a. The NF Service Producer returns the data of the requested resource in the response. + +### 4.9.6 Criteria for choosing the transfer method + +The following considerations may be used to determine which method to use transfer multiple resources to a NF Service Consumer. + +If the size of the representation of each resource is small, direct delivery is preferred. If the number of resources to be returned is large, the NF Service Producer may choose iterative delivery. + +NOTE 1: For this release of this specification, a JSON payload size less than 64000 octets is considered as not large and a JSON payload size larger than 64000 octets is considered as large. + +If the size of the representation of each resource is large, indirect delivery is preferred. If the NF Service Producer supports HTTP/2 Server Push, then: + +- when SETTINGS\_ENABLE\_PUSH parameter with value "1" has been received from the NF Service Consumer, as specified in IETF RFC 7540 [13], it should choose HTTP/2 Server Push to deliver the resource. +- when SETTINGS\_ENABLE\_PUSH parameter with value "0" has been received from the NF Service Consumer, as specified in IETF RFC 7540 [13], it must not choose HTTP/2 Server Push to deliver the resources. +- when SETTINGS\_ENABLE\_PUSH parameter has not been received from the NF Service Consumer, as specified in IETF RFC 7540 [13], it may decide whether to use HTTP/2 Server push or not, depending on other factors, e.g. operator policy, whether the client and server pertain to the same PLMN, etc. + +An NF Service Producer shall use Indirect Delivery with HTTP/2 Server Push only if the NF Service Consumer (client) indicated support for accepting server pushed resource representations, via the Supported Features negotiation as specified in clause 6.6.2 of 3GPP TS 29.500 [2]. + +NOTE 2: In this release the Indirect Delivery with HTTP/2 Server Push is not used by 3GPP service based interface APIs. + +# --- 5 Documenting 5GC SBI APIs + +## 5.1 Naming Conventions + +### 5.1.1 Case Conventions + +The following case conventions for names and strings are used in the 5GC SBI service APIs. + +#### 1) UPPER\_WITH\_UNDERSCORE + +All letters of a string are capital letters. Digits are allowed. Word boundaries are represented by the underscore "\_" character. No other characters are allowed. + +Example 1: + +- a) DATA\_MANAGEMENT +- b) CELL\_CHANGE + +#### 2) lower\_with\_underscore + +All letters of a string are lowercase letters. Digits are allowed. Word boundaries are represented by the underscore "\_" character. No other characters are allowed. + +Example 2: + +- a) data\_management; +- b) cell\_change. + +#### 3) UPPER-WITH-HYPHEN + +All letters of a string are capital letters. Digits are allowed. Word boundaries are represented by the hyphen "-" character. No other characters are allowed. + +Example 3: + +- a) DATA-MANAGEMENT +- b) CELL-CHANGE + +#### 4) lower-with-hyphen + +All letters of a string are lowercase letters. Digits are allowed. Word boundaries are represented by the hyphen "-" character. No other characters are allowed. + +Example 4: + +- a) data-management; +- b) cell-change. + +#### 5) UpperCamel + +A string is formed by concatenating words. Each word starts with a letter or a digit. The first letter of each word shall be an uppercase letter; all other characters in the word shall be lowercase letters or digits. + +Abbreviations follow the same scheme (i.e. first letter uppercase, all other letters lowercase). + +Example 5: + +- a) DataManagement. +- b) CellChange +- c) 5QiPriorityLevel +- d) Amf3GppAccessRegistration + +#### 6) lowerCamel + +A string is formed by concatenating words. Each word starts with a letter or a digit. The first letter of the first word shall be a lowercase letter; the first letter of the rest of the words shall be an uppercase letter. All other characters in the words shall be lowercase letters or digits. + +Abbreviations follow the same scheme. + +Example 6: + +- a) dataManagement +- b) cellChange +- c) 5qiPriorityLevel + +NOTE: These naming conventions are used as guidelines, to provide some uniformity in the specification of the different 5GC APIs. However, for different reasons, sometimes exceptions can be made. In any case, the OpenAPI specifications are mandatory, and the different network elements cannot determine that a certain message, that otherwise complies to the OpenAPI specification, is incorrect based only on the fact that it does not follow a given naming convention in a certain data element. + +### 5.1.2 API Naming Conventions + +An API shall take the name of the corresponding service (e.g. Nudm\_SubscriberDataManagement). When used in URIs the name shall be converted to lower-with-hyphen and may use an abbreviated form (e.g. nudm-sdm). + +### 5.1.3 Conventions for URI Parts + +#### 5.1.3.1 Introduction + +The parts of the URI syntax that are relevant in the context of the 5GC SBI service APIs are as follows: + +- Path, consisting of segments, separated by "/" (e.g. segment1/segment2/segment3). +- Query, consisting of pairs of parameter name and value (e.g., ?mcc=262&mnc=01, where two pairs are presented). + +#### 5.1.3.2 URI Path Segment Naming Conventions + +- a) All path segments of a resource URI which represent a string constant shall use lower-with-hyphen (this implies that a path cannot end with "/"). + +Example 1: + +subscriber-data + +- b) If a resource represents a collection of entities and the last path segment of the resource URI is a string constant, that last path segment shall be plural. + +Example 2: + +.../prefix/api/v1/users + +- c) For resources where the last path segment of the resource URI is a string constant, that last path segment shall be a noun or a composite noun. + +Example 3: + +.../prefix/api/v1/users + +Example 4: + +.../prefix/api/v1/user-session + +- d) For custom operations, the last path segment of the URI via which the operation is invoked shall be a verb, or shall start with a verb. + +Example 5: + +.../app\_instances/{appInstanceId}/instantiate + +Example 6: + +.../sessions/terminate-all + +- e) All path segments of a URI which are variable names shall use lowerCamel, and shall be surrounded by curly brackets. + +Example 7: + +.../subscriber-data/{supi} + +- f) Once a variable is replaced at runtime by an actual string, the string shall follow the rules for a path segment defined in IETF RFC 3986 [9]. IETF RFC 3986 [9] disallows certain characters from use in a path segment. Each actual 5GC SBI service API specification shall define this restriction to be followed when generating values for path segment variables, or propose a suitable encoding (such as percent-encoding according to IETF RFC 3986 [9]), to escape such characters if they can appear in input strings intended to be substituted for a path segment variable. + +#### 5.1.3.3 URI Query Naming Conventions + +- a) URI query parameter names in queries shall use lower-with-hyphen. + +Example 1: + +?nf-type=AMF + +- b) Variables that represent actual parameter values in queries shall use lowerCamel and shall be surrounded by curly brackets. + +Example 2: + +?nf-id={chooseAValue} + +- c) When a variable is replaced at runtime by an actual string, the convention defined in clause 5.1.3.2 item f) applies to that string. + +### 5.1.4 Conventions for Names in Data Structures + +The following syntax conventions apply when defining the names for attributes in the 5GC SBI service API data structures, carried in the payload body of http requests and responses. + +- a) Names of attributes shall be represented using lowerCamel. + +Example 1: + +attributeName + +- b) Names of arrays (i.e. those with cardinality 1..N or 0..N) shall be plural rather than singular. + +Example 2: + +users + +- c) Each value of an enumeration type shall be represented using UPPER\_WITH\_UNDERSCORE. + +Example 3: + +BLACK\_LISTED + +- d) The names of data types shall be represented using UpperCamel. + +Example 4: + +ResourceHandle + +## 5.2 API Definition + +### 5.2.1 Resource Structure + +Resource structure shall define the structure of the resource URIs, the resources, the associated HTTP methods and custom operations used for the service. + +Figure 5.2.1-1 provides an example of the resource URI structure (i.e. resource tree) of an API. Table 5.2.1-1 provides an example of an overview of the resources defined for the service, and their applicable HTTP methods and custom operations. + +![Figure 5.2.1-1: Resource URI structure of the API. The diagram shows a hierarchical tree of resource URIs. The root is {apiRoot}/nudm_sdm/{apiVersion}. It branches to /resources, which then branches to /{supi}. The /{supi} node has several children: /nssai, /amf_data, /smf_data, /smsf_data, and /release. The /smf_data node further branches to /{dnn}. The /release node is shown with a dashed border, indicating it supports specific custom operations.](ddee3e67e0dfc22e25188fa635a19558_img.jpg) + +``` + +graph TD + Root["{apiRoot}/nudm_sdm/{apiVersion}"] --> Resources["/resources"] + Resources --> Supi["/{supi}"] + Supi --> Nssai["/nssai"] + Supi --> AmfData["/amf_data"] + Supi --> SmfData["/smf_data"] + Supi --> SmsfData["/smsf_data"] + Supi --> Release["/release"] + SmfData --> Dnn["/{dnn}"] + style Release stroke-dasharray: 5 5 + +``` + +Figure 5.2.1-1: Resource URI structure of the API. The diagram shows a hierarchical tree of resource URIs. The root is {apiRoot}/nudm\_sdm/{apiVersion}. It branches to /resources, which then branches to /{supi}. The /{supi} node has several children: /nssai, /amf\_data, /smf\_data, /smsf\_data, and /release. The /smf\_data node further branches to /{dnn}. The /release node is shown with a dashed border, indicating it supports specific custom operations. + +**Figure 5.2.1-1: Resource URI structure of the API** + +In figure 5.2.1-1 a child node with a solid-line frame represents a resource-URI that has at least one supported HTTP method associated, and a child node with a dashed-line frame represents a sub-URI under a resource which supports specific custom operation. All child node names are examples only. + +**Table 5.2.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|-----------------|-----------------------------------|---------------------------------|------------------------------------------| +| | | GET | | +| | | PUT | | +| | | PATCH | | +| | | POST | | +| | /release | DELETE | | +| | | release (POST) | | + +### 5.2.2 Resources and HTTP Methods + +Resources and HTTP methods shall specify the resource URI, resource URI variables for the resource and the standard HTTP methods supported by the resource. + +Example: + +Resource URI: {apiRoot}/// + +The resource URI variables supported by the resource shall be defined as table 5.2.2-1 illustrates. + +**Table 5.2.2-1: Resource URI variables for the resource** + +| Name | Definition | +|------------------------------------------------|-------------------------------------------------------| +| apiRoot | See clause 4.4.1 | +| < Name of resource URI variables for resource> | < Definition of resource URI variables for resource > | + +The {apiRoot} URI variable should be defined in clauses and this definition should be referenced to ease a possible update of the apiVersion value. + +Each method supported by the resource shall be described including the URI query parameters supported by the method, data structures supported by the request body, and the data structures supported by the response body. + +URI query parameters supported by the method shall be defined as table 5.2.2-2 illustrates. + +**Table 5.2.2-2: URI query parameters supported by a method on the resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|---------------|-------------------------|-------------|--------------------------------------------|----------------------|---------------| +| or n/a | or | | 0..1 or 1 or 0..N or 1..N or | | | + +**Name:** Name of query parameter in URI. If no query parameters are defined for the URI, the name should be marked as "n/a". + +**Data type:** Data type of URI query parameters, i.e. a data type defined in the specification. If no query parameter is defined for the URI, the column is left empty. + +**P:** Presence condition of URI query parameters. It shall be one of "M" (for Mandatory), "C" (for Conditional) and "O" (for Optional). If no query parameter is defined for the URI, the column is left empty. + +**Cardinality:** Defines the allowed number of occurrence. It shall be "0..1", "1", "0..N", "1..N". If no query parameter is defined for the URI, the column is left empty. + +**Description:** Additional information for URI query parameter, i.e. describes the use of the parameter or the presence condition of the parameter and so on. + +**Applicability:** If the URI query parameter is only applicable for optional feature(s) negotiated using the mechanism defined in clause 6.6.2 of 3GPP TS 29.500 [2], the name of the corresponding feature(s) shall be indicated in this column. If no feature is indicated, the attribute can be used with any feature. + +NOTE 1: If no optional features are defined for an API, the applicability column can be omitted for that API. + +Data structures supported by the request body of the method shall be specified as table 5.2.2-3 illustrates. + +**Table 5.2.2-3: Data structures supported by the request body on the resource** + +| Data type | P | Cardinality | Description | +|-----------------------------------------------------|-----------------|------------------------------------------|----------------------| +| "" or "array()" or "map()" or n/a | "M", "C" or "O" | "0..1", "1", or "M..N", or | | + +**Data type:** Data type of the data structure in the request body. If the data type is indicated as "", the request body shall be of data type . If the data type is indicated as "array()", the request body shall be an array (see IETF RFC 8259 [3]) that contains elements of data type . If the data type is indicated as "map()", the request body shall be an object (see IETF RFC 8259 [3]) encoding a map (see clause 5.2.4.2) that contains as values elements of data type . can either be "integer", "number", "string" or "boolean" (as defined in the OpenAPI specification [4]), or a data type defined in a 3GPP specification. If no request body is allowed, the Data type shall be marked as "n/a". + +**P:** Presence condition of a data structure in request body. It shall be one of "M" (for Mandatory), "C" (for Conditional) and "O" (for Optional). + +**Cardinality:** Defines the allowed number of occurrence of data type . A cardinality of "M..N", is only allowed for data types "array()" and "map()" and indicates the number of elements within the array or map; the values M and N can either be the characters "M" and "N", respectively, or integer numbers with M being greater than or equal 0, and N being greater than 0 and M. For data type "", the cardinality shall be set to "0..1" if the Presence condition is "C" or "O", and to "1" if the Presence condition is "M". The Cardinality shall be left empty if no request body is allowed. + +**Description:** Additional information for a data structure, i.e. describes the use of the data structure or the presence condition of the data structure and so on. + +NOTE 2: The cardinality of "0..N" does not imply that the presence condition of the array or map is optional or conditional, i.e. the presence condition can be "M" while the cardinality is "0..N", the presence condition can be "O" or "C" while the cardinality is "1..N". + +Data structures supported by the response body of the method shall be specified as table 5.2.2-4 illustrates. + +**Table 5.2.2-4: Data structures supported by the response body on the resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------|-----------------|------------------------------------------|------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------| +| "" or "array()" or "map()" or n/a | "M", "C" or "O" | "0..1", "1", or "M..N", or | | or | + +**Data type:** Data type of the data structure in the response body. If the data type is indicated as "", the response body shall be of data type . If the data type is indicated as "array()", the response body shall be an array (see IETF RFC 8259 [3]) that contains elements of data type . If the data type is indicated as "map()", the response body shall be an object (see IETF RFC 8259 [3]) encoding a map (see clause 5.2.4.2) that contains as values elements of data type . can either be "integer", "number", "string" or "boolean" (as defined in the OpenAPI specification [4]), or a data type defined in a 3GPP specification. If no response body is allowed, the Data type shall be marked as "n/a". + +**P:** Presence condition of a data structure in response body. It shall be one of "M" (for Mandatory), "C" (for Conditional) and "O" (for Optional). + +**Cardinality:** Defines the allowed number of occurrence of data type . A cardinality of "M..N", is only allowed for data types "array()" and "map()" and indicates the number of elements within the array or map; the values M and N can either be the characters "M" and "N", respectively, or integer numbers with M being greater than or equal 0, and N being greater than 0 and M. For data type "", the cardinality shall be set to "0..1" if the Presence condition is "C" or "O", and to "1" if the Presence condition is "M". The Cardinality shall be left empty if no response body is allowed. + +**Response codes:** Lists applicable response codes with name from HTTP Status Code Registry at IANA [12]. Mandatory HTTP status codes listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [2] for the corresponding HTTP method shall only be included if specific clarifications in the description part or special data types of the response body are required. Applicable HTTP status codes in addition to the mandatory HTTP status codes listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [2] for the corresponding HTTP method shall be included. + +**Description:** Additional information for a response, i.e. describes the meaning of the success case or meaning of the error case with additional statement regarding error handling. + +NOTE 3: The cardinality of "0..N" does not imply that the presence condition of the array or map is optional or conditional, i.e. the presence condition can be "M" while the cardinality is "0..N", the presence condition can be "O" or "C" while the cardinality is "1..N". + +### 5.2.3 Representing RPC as Custom Operations on Resources + +Custom operations (RPC-style interaction) may be used on a resource. The description of each custom operation contains the custom operation URI, the HTTP method on which the operation is mapped (typically POST), data structures supported by the request body and the data structures supported by the response body. + +An overview of the custom operations on a resource is illustrated in table 5.2.3-1. + +**Table 5.2.3-1: Custom operation** + +| Custom operation URI | Mapped HTTP method | Description | +|------------------------|--------------------|------------------------------------------| +| | e.g. POST | | + +Data structures supported by the request body of the method shall be specified as table 5.2.3-2 illustrates. + +**Table 5.2.3-2: Data structures supported by the mapped HTTP method request body on the resource** + +| Data type | P | Cardinality | Description | +|----------------------------------------------------|--------------------|---------------------------------------------|----------------------| +| "" or
"array()" or
"map()" | "M", "C"
or "O" | "0..1", "1", or
"M..N", or | | + +**Data type:** Data type of the data structure in the request body. If the data type is indicated as "", the request body shall be of data type . If the data type is indicated as "array()", the request body shall be an array (see IETF RFC 8259 [3]) that contains elements of data type . If the data type is indicated as "map()", the request body shall be an object (see IETF RFC 8259 [3]) encoding a map (see clause 5.2.4.2) that contains as values elements of data type . can either be "integer", "number", "string" or "boolean" (as defined in the OpenAPI specification [4]), or a data type defined in a 3GPP specification. If no request body is allowed, the Data type shall be marked as "n/a". + +**P:** Presence condition of a data structure in request body. It shall be one of "M" (for Mandatory), "C" (for Conditional) and "O" (for Optional). + +**Cardinality:** Defines the allowed number of occurrence of data type . A cardinality of "M..N", is only allowed for data types "array()" and "map()" and indicates the number of elements within the array or map; the values M and N can either be the characters "M" and "N", respectively, or integer numbers with M being greater than or equal 0, and N being greater than 0 and M. For data type "", the cardinality shall be set to "0..1" if the Presence condition is "C" or "O", and to "1" if the Presence condition is "M". The Cardinality shall be left empty if no request body is allowed. + +**Description:** Additional information for a data structure, i.e. describes the use of the data structure or the presence condition of the data structure and so on. + +NOTE 1: The cardinality of "0..N" does not imply that the presence condition of the array or map is optional or conditional, i.e. the presence condition can be "M" while the cardinality is "0..N", the presence condition can be "O" or "C" while the cardinality is "1..N". + +Data structures supported by the response body of the method shall be specified as table 5.2.3-3 illustrates. + +**Table 5.2.3-3: Data structures supported by the mapped HTTP method response body on the resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------|-----------------|-----------------------------------------|------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------| +| "" or "array()" or "map()" | "M", "C" or "O" | "0..1", "1" or "M..N", or | | or | + +**Data type:** Data type of the data structure in the response body. If the data type is indicated as "", the response body shall be of data type . If the data type is indicated as "array()", the response body shall be an array (see IETF RFC 8259 [3]) that contains elements of data type . If the data type is indicated as "map()", the response body shall be an object (see IETF RFC 8259 [3]) encoding a map (see clause 5.2.4.2) that contains as values elements of data type . can either be "integer", "number", "string" or "boolean" (as defined in the OpenAPI specification [4]), or a data type defined in a 3GPP specification. If no response body is allowed, the Data type shall be marked as "n/a". + +**P:** Presence condition of a data structure in response body. It shall be one of "M" (for Mandatory), "C" (for Conditional) and "O" (for Optional). + +**Cardinality:** Defines the allowed number of occurrence of data type . A cardinality of "M..N", is only allowed for data types "array()" and "map()" and indicates the number of elements within the array or map; the values M and N can either be the characters "M" and "N", respectively, or integer numbers with M being greater than or equal 0, and N being greater than 0 and M. For data type "", the cardinality shall be set to "0..1" if the Presence condition is "C" or "O", and to "1" if the Presence condition is "M". The Cardinality shall be left empty if no response body is allowed. + +**Response codes:** Lists applicable response codes with name from HTTP Status Code Registry at IANA [12]. Mandatory HTTP status codes listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [2] for the corresponding HTTP method shall only be included if specific clarifications in the description part or special data types of the response body are required. Applicable HTTP status codes in addition to the mandatory HTTP status codes listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [2] for the corresponding HTTP method shall be included. + +**Description:** Additional information for a response, i.e. describes the meaning of the success case or meaning of the error case with additional statement regarding error handling. + +NOTE 2: The cardinality of "0..N" does not imply that the presence condition of the array or map is optional or conditional, i.e. the presence condition can be "M" while the cardinality is "0..N", the presence condition can be "O" or "C" while the cardinality is "1..N". + +### 5.2.3A Notifications + +Notifications based on the Callback URI as specified in clause 4.6.2.3 and clause 6.2 of 3GPP TS 29.500 [4] may be supported. The description of each notification contains the Callback URI, the HTTP method (typically POST), data structures supported by the request body and the data structures supported by the response body. + +An overview of the notifications is illustrated in table 5.2.3A-1. + +**Table 5.2.3A-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|-----------------------------------------------------|----------------------------------------------|---------------------------------|---------------------------------| +|
e.g. Status Change Notification | < Callback URI >
e.g. {StatusCallbackUri} | e.g POST | e.g. Notify Event | + +Example: + +Callback URI: {notifUri} + +The callback URI variables shall be defined as table 5.2.3A-2 illustrates. + +**Table 5.2.3A-2: Callback URI variables** + +| Name | Definition | +|----------|-----------------------------------------------| +| notifUri | String formatted as URI with the Callback Uri | + +Data structures supported by the request body of the method shall be specified as table 5.2.3A-3 illustrates. + +**Table 5.2.3A-3: Data structures supported by the HTTP method request body** + +| Data type | P | Cardinality | Description | +|----------------------------------------------|-----------------|------------------------------------------|----------------------| +| "" or "array()" or "map()" | "M", "C" or "O" | "0..1", "1", or "M..N", or | | + +**Data type:** Data type of the data structure in the request body. If the data type is indicated as "", the request body shall be of data type . If the data type is indicated as "array()", the request body shall be an array (see IETF RFC 8259 [3]) that contains elements of data type . If the data type is indicated as "map()", the request body shall be an object (see IETF RFC 8259 [3]) encoding a map (see clause 5.2.4.2) that contains as values elements of data type . can either be "integer", "number", "string" or "boolean" (as defined in the OpenAPI specification [4]), or a data type defined in a 3GPP specification. If no request body is allowed, the Data type shall be marked as "n/a". + +**P:** Presence condition of a data structure in request body. It shall be one of "M" (for Mandatory), "C" (for Conditional) and "O" (for Optional). + +**Cardinality:** Defines the allowed number of occurrence of data type . A cardinality of "M..N", is only allowed for data types "array()" and "map()" and indicates the number of elements within the array or map; the values M and N can either be the characters "M" and "N", respectively, or integer numbers with M being greater than or equal 0, and N being greater than 0 and M. For data type "", the cardinality shall be set to "0..1" if the Presence condition is "C" or "O", and to "1" if the Presence condition is "M". The Cardinality shall be left empty if no request body is allowed. + +**Description:** Additional information for a data structure, i.e. describes the use of the data structure or the presence condition of the data structure and so on. + +NOTE 1: The cardinality of "0..N" does not imply that the presence condition of the array or map is optional or conditional, i.e. the presence condition can be "M" while the cardinality is "0..N", the presence condition can be "O" or "C" while the cardinality is "1..N". + +Data structures supported by the response body of the method shall be specified as table 5.2.3A-4 illustrates. + +**Table 5.2.3A-4: Data structures supported by the mapped HTTP method response body** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------|-----------------|-----------------------------------------|------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------| +| "" or "array()" or "map()" | "M", "C" or "O" | "0..1", "1" or "M..N", or | | or | + +**Data type:** Data type of the data structure in the response body. If the data type is indicated as "", the response body shall be of data type . If the data type is indicated as "array()", the response body shall be an array (see IETF RFC 8259 [3]) that contains elements of data type . If the data type is indicated as "map()", the response body shall be an object (see IETF RFC 8259 [3]) encoding a map (see clause 5.2.4.2) that contains as values elements of data type . can either be "integer", "number", "string" or "boolean" (as defined in the + +OpenAPI specification [4]), or a data type defined in a 3GPP specification. If no response body is allowed, the Data type shall be marked as "n/a". + +**P:** Presence condition of a data structure in response body. It shall be one of "M" (for Mandatory), "C" (for Conditional) and "O" (for Optional). + +**Cardinality:** Defines the allowed number of occurrence of data type **. A cardinality of "*M..N*", is only allowed for data types "array(**)" and "map(**)" and indicates the number of elements within the array or map; the values *M* and *N* can either be the characters "M" and "N", respectively, or integer numbers with *M* being greater than or equal 0, and *N* being greater than 0 and *M*. For data type "**", the cardinality shall be set to "0..1" if the Presence condition is "C" or "O", and to "1" if the Presence condition is "M". The Cardinality shall be left empty if no response body is allowed. + +**Response codes:** Lists applicable response codes with name from HTTP Status Code Registry at IANA [12]. Mandatory HTTP status codes listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [2] for the corresponding HTTP method shall only be included if specific clarifications in the description part or special data types of the response body are required. Applicable HTTP status codes in addition to the mandatory HTTP status codes listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [2] for the corresponding HTTP method shall be included. + +**Description:** Additional information for a response, i.e. describes the meaning of the success case or meaning of the error case with additional statement regarding error handling. + +NOTE 2: The cardinality of "0..N" does not imply that the presence condition of the array or map is optional or conditional, i.e. the presence condition can be "M" while the cardinality is "0..N", the presence condition can be "O" or "C" while the cardinality is "1..N". + +### 5.2.4 Data Models + +#### 5.2.4.1 General + +The application data model supported by the API shall be specified with the following data types: + +1. Structured data types +2. Simple data types +3. Enumerations +4. Binary data +5. Data types describing alternative data types +6. Data types describing combinations of data types + +Each data type can be specific for the API or common to multiple APIs (offered by the same or different NFs). The common data types shall be specified in 3GPP TS 29.571 [5]. Characters in an enumeration or string data type in both simple and structured/combination data types specific for the API or common to multiple APIs shall be handled as case sensitive by default, unless explicitly specified the IE is case insensitive in specifications, e.g. DNN in 3GPP TS 23.003 [27]. + +#### 5.2.4.2 Structured data types + +The structured data types shall represent an object (see IETF RFC 8259 [3]). The structured data types shall contain attributes that are simple data types, structured data types, arrays (see below), maps (as defined below), enumerations, data types describing alternative data types, data types describing combinations of data types or "Any Type" (as described below). + +An array (see IETF RFC 8259 [3]) shall represent a list of values without keys and with significance in the order of sequence. All values shall be of the same type. + +A map shall represent an object (see IETF RFC 8259 [3]) with a list of key-value pairs (with no significance in the order of sequence), where all keys are of type string and shall be unique identifiers assigned by the application rather than by the schema, and where all values shall be of the same type. + +NOTE 1: Maps are supported by the OpenAPI specification [4] as described at . Maps can enable a faster lookup of elements identified by some key in huge data structures compared to arrays that contain the key within the elements. Maps can also be used instead of arrays to modify individual elements when modification instructions of the PATCH method are compliant to IETF RFC 7396 [7]. + +Each structured data type shall be specified in a separate clause as illustrated in table 5.2.4.2-1. + +**Table 5.2.4.2-1: Definition of type ** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|------------------------------------------------------------|-----------------|-----------------------|----------------------|---------------| +| | "" or "array()" or "map()" or "Any Type" | "M", "C" or "O" | "0..1", "1" or "M..N" | | | + +**Table 5.2.4.2-2: Definition of type with nested structures** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|----------------------------------------------------------------------------------------------|-----------------|------------------|----------------------|---------------| +| | "array(map())" or "map(array())" or "array(array())" or "map(map())" | "M", "C" or "O" | "M1..N1(M2..N2)" | | | + +**Attribute name:** Name of attributes that belong to the specified data type. The attribute names within a structured data type shall be unique, and their relative order inside the structured data type shall not imply any specific ordering of the corresponding JSON elements in a JSON object. + +NOTE 2: The JSON specification (IETF RFC 8259 [3]) allows duplicate keys in a JSON object, but its usage is discouraged, since it makes interoperability more difficult, and makes the behavior of the JSON parsing software unpredictable. Similarly, that RFC encourages to make implementations not dependent on attribute ordering. + +**Data type:** Data type of the attribute. If the data type is indicated as "", the attribute shall be of data type . If the data type is indicated as "array()", the attribute shall be an array (see IETF RFC 8259 [3]) that contains elements of data type . If the data type is indicated as "map()", the attribute shall be an object (see IETF RFC 8259 [3]) encoding a map that contains as values elements of data type . can either be "integer", "number", "string" or "boolean" (as defined in the OpenAPI specification [4]), or a data type defined in a 3GPP specification. If the data type is indicated as "Any Type", the attribute can either be "integer", "number", "string", "boolean", "array" or "object" (as defined in the OpenAPI specification [4]), or a data type defined in a 3GPP specification. + +**P:** Presence condition of a data structure in request body. It shall be one of "M" (for Mandatory), "C" (for **Cardinality**: Defines the allowed number of occurrence of data type . A cardinality of "M..N", is only allowed for data types "array()" and "map()" and indicates the number of elements within the array or map; the values M and N can either be the characters "M" and "N", respectively, or integer numbers; with M being greater than or equal 0, and N being greater than 0 and M. For data type with nested structures, the cardinality is expressed in a nested manner, each level of the M and N values describe the cardinality of the corresponding level of the data structure. For data type "" and "Any Type", the cardinality shall be set to "0..1" if the Presence condition is "C" or "O", and to "1" if the Presence condition is "M". + +**Description:** Describes the meaning and use of the attribute and may contain normative statements. + +**Applicability:** If the attribute is only applicable for optional feature(s) negotiated using the mechanism defined in clause 6.6 of 3GPP TS 29.500 [2], the name of the corresponding feature(s) shall be indicated in this column. If no feature is indicated, the attribute can be used with any feature. + +NOTE 3: The cardinality of "0..N" does not imply that the presence condition of the array or map is optional or conditional, i.e. the presence condition can be "M" while the cardinality is "0..N", the presence condition can be "O" or "C" while the cardinality is "1..N". + +NOTE 4: If no optional features are defined for an API, the applicability column can be omitted for that API. + +#### 5.2.4.3 Simple data types and enumerations + +The simple data types and enumerations can be referenced from data structures. All simple data types and enumerations should map to base types supported by IDL. Simple data types shall be specified as illustrated in table 5.2.4.3-1. + +**Table 5.2.4.3-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|------------------------------------------------------------------|-------------|---------------| +| | | | | + +**Type Name:** The name of the simple data type. + +**Type Definition:** Base types supported by IDL, i.e. Boolean, integer, string and so on. + +**Description:** Additional descriptions for simple data types like range, string length and so on. + +**Applicability:** If the type is only applicable for optional feature(s) negotiated using the mechanism defined in clause 6.6 of 3GPP TS 29.500 [2], the name of the corresponding feature(s) shall be indicated in this column. If no feature is indicated, the type can be used with any feature. + +NOTE 1: If no optional features are defined for an API, the applicability column can be omitted for that API. + +Each enumeration type shall be respectively specified for their elements sets as illustrated in table 5.2.4.3-2. + +**Table 5.2.4.3-2: Enumeration ** + +| Enumeration value | Description | Applicability | +|---------------------|------------------------------------------|---------------| +| Enumeration value 1 | The description of this enum value | | +| Enumeration value 2 | The description of this other enum value | | + +**Enumeration value:** Defines the valid values, which can be integer, string or boolean, it is suggested to keep the same value style in one API specification. + +**Description:** Additional descriptions for enumeration attributes, like the meaning and usage of enumeration elements. + +**Applicability:** If the enumeration value is only applicable for optional feature(s) negotiated using the mechanism defined in clause 6.6 of 3GPP TS 29.500 [2], the name of the corresponding feature(s) shall be indicated in this column. If no feature is indicated, the enumeration value can be used with any feature. + +NOTE 2: If no optional features are defined for an API, the applicability column can be omitted for that API. + +#### 5.2.4.4 Binary Data + +#### 5.2.4.5 Data types describing alternative data types or combinations of data types + +The data types describing alternative data types or combinations of data types shall represent an OpenAPI schema object using the "oneOf", "anyOf" or "allOf" keyword to list alternative or to be combined data types (see the OpenAPI specification [4] and ). + +An instance (i.e. a corresponding part of a JSON file to be evaluated against the schema) matches a list of mutually exclusive alternative data types, as described using the OpenAPI "oneOf" keyword, if the instance matches against one and only one of the alternative data types. + +NOTE 1: Data types with the same simple data type but different format and/or pattern attributes are mutually exclusive if the corresponding formats and/or patterns are mutually exclusive. + +An instance (i.e. a corresponding part of a JSON file to be evaluated against the schema) matches a list of non-exclusive alternative data types, as described using the OpenAPI "anyOf" keyword, if the instance matches against one or more of the alternative data types. + +An instance (i.e. a corresponding part of a JSON file to be evaluated against the schema) matches a list of to be combined data types, as described using the OpenAPI "allOf" keyword, if the instance matches against all of the to be combined data types. + +The alternative or to be combined data types shall be simple data types, structured data types, arrays (see clause 5.2.4.2), maps (see clause 5.2.4.2), enumerations, data types describing alternative data types, or data types describing combinations of data types. + +Each structured data type shall be specified in a separate clause as illustrated in table 5.2.4.2-1. + +**Table 5.2.4.2-1: Definition of type as a list of <"mutually exclusive alternatives" / "non-exclusive alternatives" / "to be combined data types">** + +| Data type | Cardinality | Description | Applicability | +|----------------------------------------------------|--------------------|----------------------|----------------------| +| "" or
"array()" or
"map()" | "1" or "M..N" | | | + +**Data type:** Data type of the alternative or to be combined data type. If the data type is indicated as "", the alternative or to be combined data type shall be of data type . If the data type is indicated as "array()", the alternative or to be combined data type shall be an array (see IETF RFC 8259 [3]) that contains elements of data type . If the data type is indicated as "map()", the alternative or to be combined data type shall be an object (see IETF RFC 8259 [3]) encoding a map (see clause 5.2.4.2) that contains as values elements of data type . can either be "integer", "number", "string" or "boolean" (as defined in the OpenAPI specification [4]), or a data type defined in a 3GPP specification. + +**Cardinality:** Defines the allowed number of occurrence of data type . A cardinality of "M..N", is only allowed for data types "array()" and "map()" and indicates the number of elements within the array or map; the values M and N can either be the characters "M" and "N", respectively, or integer numbers; with M being greater than or equal 0, and N being greater than 0. For data type "", the cardinality shall be set to "1". + +**Description:** Describes the meaning and use of the attribute and may contain normative statements. + +**Applicability:** If the type is only applicable for optional feature(s) negotiated using the mechanism defined in clause 6.6 of 3GPP TS 29.500 [2], the name of the corresponding feature(s) shall be indicated in this column. If no feature is indicated, the type can be used with any feature. + +NOTE 2: If no optional features are defined for an API, the applicability column can be omitted for that API. + +NOTE 3: Data types describing alternative data types or combinations of data types can only be extended with additional data types in a backward compatible manner if the new data types are associated with an optional feature and the mechanism defined in clause 6.6 of 3GPP TS 29.500 [2] is used to negotiate the support of that optional feature before that new data type is used. + +### 5.2.5 Relation types + +## 5.3 OpenAPI specification files + +### 5.3.1 General + +5GC SBI APIs' OpenAPI specification files shall comply with the OpenAPI specification [4] and with the present clause 5.3. + +Each API shall be described in one OpenAPI specification file contained in an Annex of the 3GPP specification that describes the corresponding API. In addition, 3GPP specifications may contain OpenAPI specification file with common data types. + +Informative copies of all OpenAPI specification files contained in 3GPP Technical Specifications are available on a Git-based repository hosted in 3GPP Forge, that uses the GitLab software version control system. + +The repository is named "5G APIs" and is publicly accessible via the following URI: + +[https://forge.3gpp.org/rep/all/5G\\_APIs](https://forge.3gpp.org/rep/all/5G_APIs) + +### 5.3.2 Formatting of OpenAPI specification files + +The following guidelines shall be used when documenting OpenAPI specification files: + +- OpenAPI specification files shall be documented using YAML format (see YAML 1.2 [16]). For specific restrictions on the usage of YAML in OpenAPI, see OpenAPI 3.0.0 Specification [4]. +- The style used for the specification shall be "PL" (Programming Language). +- The different scopes in the YAML data structures representing collections (objects, arrays...) shall use an indentation of two white spaces. +- Comments may be added by following the standard YAML syntax ("#"). + +### 5.3.3 Info + +The OpenAPI specification file of an API shall contain an "info" object with the title that should be set to the same value as chosen for the API name in the heading of Annex A.x of the corresponding 3GPP TS, and with the version set as described in clause 4.3. + +The "info" object shall also include a "description" field, containing the name of the service that the API implements, and the same copyright notice as included in the front page of the corresponding 3GPP TS that specifies the API. The content of the "description" field shall be formatted using the YAML block notation for scalars (i.e. using the "|" character). + +EXAMPLE: "info" object with the title, version and description of the API. + +``` +info: + title: 'Nsmf_PDUSession' + version: '1.0.0' + description: | + SMF PDUSession Service. + © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +``` + +### 5.3.4 externalDocs + +Each OpenAPI specification file shall provide an "externalDocs" object as illustrated in the example below that shall contain: + +- within the "description" field the 3GPP TS number, the version number and the name of the 3GPP TS describing the API, and +- within the "url" field a reference to the folder of that TS within the specification archive of the public 3GPP fileserver (i.e. "//>"). + +The version number in the "externalDocs" object shall be updated each time when the TS version contains new changes to the OpenAPI specification file. + +NOTE 1: If a new TS version is provided without any changes to the OpenAPI specification file, the TS version number included in the "description" field of the "externalDocs" field in the OpenAPI specification file is not updated. + +NOTE 2: If a new TS version is provided with changes to the OpenAPI specification file, the TS version number included in the "description" field of the "externalDocs" object is updated. However, if the API version in a given release is still the same as in a previous release, the first TS version in the first release that contains that API version is provided as TS version within the "externalDocs" object also in the TS versions of the subsequent releases. + +EXAMPLE: "externalDocs" object. + +``` +externalDocs: + description: 3GPP TS 29.503 V15.1.0; 5G System; Unified Data Management Services + url: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.503/' +``` + +### 5.3.5 Servers + +As defined in clause 4.4.1, the API URI consists of {apiRoot}//. It shall be encoded in the corresponding OpenAPI specification file as "servers" field with {apiRoot} as variable. + +Example: + +``` +servers: + - url: '{apiRoot}/nxxx-yyyy/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4.1 of 3GPP TS 29.501 +``` + +### 5.3.6 References to other 3GPP-defined OpenAPI specification files + +Open API specification files may contain references to fragments of other 3GPP-defined Open API specification files. + +Such references shall be formatted to refer to local files stored on the same folder. + +NOTE 1: For the purpose of referencing, it is assumed that each OpenAPI specification file contained in a 3GPP specification is stored as separate physical file and that all OpenAPI specification files are stored in the same directory on the local server. + +The referenced file names for other 3GPP-defined Open API specification files shall comply with the following convention, unless a specific file name is indicated in the Annex of a 3GPP specification defining an OpenAPI specification file. The file name shall consist of (in the order below): + +- the 3GPP specification number in the format "TSxxyyy"; +- an "\_" character; +- if the OpenAPI specification file contains an API definition: the API name which shall be taken from the heading of the relevant annex A.x as defined in the corresponding 3GPP TS of that API. +- if the OpenAPI specification file contains a definition of CommonData: the string "CommonData"; and +- the string ".yaml". + +NOTE 2: The informative copies of OpenAPI specification files contained in 3GPP Technical Specifications at the public 3GPP file server (see clause 5.3.1) follow the above conventions and can be copied into a local folder in order to resolve references. + +Such a reference to another OpenAPI specification file shall be interpreted as referring to the related OpenAPI specification file contained in the version of the corresponding 3GPP TS indicated in the reference clause of the specification, i.e. for a non-specific reference the latest version of that 3GPP TS in the same Release as the specification. + +EXAMPLE: Reference to Data Type "Xxx" defined in the same file + +``` +$ref: '#/components/schemas/Xxx' +``` + +EXAMPLE: Reference to Data Type "Xxx" defined as Common Data in 3GPP TS 29.571: + +``` +$ref: 'TS29571_CommonData.yaml#/components/schemas/Xxx' +``` + +EXAMPLE: Reference to Data Type "Xxx" defined within API "Nudm\_UEAU" in 3GPP "TS 29.503": + +``` +$ref: 'TS29503_Nudm_UEAU.yaml#/components/schemas/Xxx' +``` + +### 5.3.7 Server-initiated communication + +If an API contains server-initiated communication (see clause 6.2 of 3GPP TS 29.500 [2]), e.g. for notifications as described in clause 4.6.2.3, it should be described as "callbacks" in OpenAPI specification files. + +Example: + +``` +paths: + /subscriptions: + post: + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + callbackUrl: # Callback URL + type: string + format: uri + responses: + '201': + description: Success + callbacks: + myNotification: # arbitrary name + '{$request.body#/callbackUrl}': # refers The callback URL in the POST + post: + requestBody: # Contents of the callback message + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationBody' + responses: # Expected responses to the callback message + '204': + description: xxx +``` + +### 5.3.8 Describing the body of HTTP PATCH requests + +#### 5.3.8.1 General + +As described in clause 4.6.1.1.3.2, the bodies of HTTP PATCH requests either use a "JSON Merge Patch" encoding as defined in IETF RFC 7396 [7], or a "JSON Patch" encoding as defined IETF RFC 6902 [8]. + +It is possible to allow both encodings in a OpenAPI Specification [4] offering both schemas as alternative contents. + +NOTE: In Rel-15 a single encoding will be selected for each resource as backward compatibility considerations do not yet apply. + +An example OpenAPI specification file offering both PATCH encodings is included in Annex D. + +#### 5.3.8.2 JSON Merge Patch + +In the OpenAPI Specification [4] file, the content field key of the Request Body Object shall contain "application/merge-patch+json". The content field value is a Media Type Object identifying the applicable patch body Schema Object. The patch body Schema Object may contain structured data types derived from the data types used in + +the schema to describe a complete representation of the resource in such a manner that attributes that are allowed to be modified are listed in the "properties" validation keyword. + +NOTE 1: A derived structured data type is beneficial if the data types used to describe a complete representation of the resource contains mandatory attributes, if attributes are allowed to be removed by the PATCH operation, or if a checking by the OpenAPI tooling that only allowed modifications are done via the "additionalProperties: false" keyword is desired. It also provides a clear description in the OpenAPI specification file to developers which modifications need to be supported. + +As an alternative, the data types used in the schema to describe a complete representation of the resource may be used if any attributes that are allowed to be removed are marked as "nullable: true" in that schema. + +Any attributes that are allowed to be removed shall be marked as "nullable: true" in the patch body Schema Object. + +The "additionalProperties: false" keyword may be set. + +NOTE 2: The "additionalProperties: false" keyword enables the OpenAPI tooling to check that only allowed modifications are done. Extensions of the object in future releases are still possible under the assumption that the supported features mechanism is used to negotiate the usage of any new attribute prior to the PATCH invocation. If new optional attributes are expected to be introduced without corresponding supported feature or if PATCH can be used as first operation in an API, the usage of the "additionalProperties: false" keyword is not appropriate. + +#### 5.3.8.3 JSON PATCH + +In the OpenAPI Specification [4] file, the content field of the key Request Body Object shall contain "application/json-patch+json". The content field value is a Media Type Object identifying the applicable patch body. It may contain a mutually exclusive list (using the "oneOf" keyword) of all allowed modifications as tuples, where "path" is a string containing a JSON Pointer value referring to a JSON object that is allowed to be modified, "op" is an enumeration of allowed JSON PATCH operations on the JSON object identified by "path" and "value" representing the schema/type of the value that will be updated or added at the JSON object identified by "path". In addition, an open alternative containing an object with no properties may be added using the "anyOf" keyword. + +NOTE 1: A mutually exclusive list provides a clear description in the OpenAPI specification file to developers which modifications need to be supported. This is of particular interest if only a limited number of modifications need to be supported. If no open alternative is included, the OpenAPI tooling will also check that only allowed modifications are done. + +NOTE 2: The open alternative allows for extensions of the PATCH in scenarios where new optional attributes are expected to be introduced without corresponding supported feature or if PATCH can be used as first operation in an API. + +### 5.3.9 Structured data types + +For a structured data type, as defined in clause 5.2.4.2, the OpenAPI specification [4] file shall contain a definition in the components/schemas clause defining a schema with the name of the structured data type as key. + +The schema shall contain: + +- "type: object"; +- if any attributes in the structured data type are marked as mandatory, a "required" keyword listing those attributes; and +- a "properties" keyword containing for each attribute in the structured data type an entry with the attribute name as key and: + 1. if the data type is "": + - a. if the data type of the attribute is "string", "number", "integer", or "boolean"; + - i) a type definition using that data type as value ("type: "); and + +- ii) optionally "description: ", where is the description of the attribute in the table defining the structured data type; or + - b. otherwise a reference to the data type schema for the data type of the attribute, i.e. "\$ref: '#/components/schemas/'" if that data type schema is contained in the same OpenAPI specification file and "\$ref: '/#/components/schemas/'" if that data type schema is contained in file in the same directory on the same server; +2. if the data type is "array()": + - a. a type definition "type: array"; + - b. an "items:" definition containing: + - i. if the data type of the attribute is "string", "number", "integer", or "boolean", a type definition using that data type as value ("type: "); or + - ii. otherwise a reference to the data type schema for the data type of the attribute, i.e. "\$ref: '#/components/schemas/'" if that data type schema is contained in the same OpenAPI specification file and "\$ref: '/#/components/schemas/'" if that data type schema is contained in file in the same directory on the same server; + - c. if the cardinality contained an integer value as lower boundary, "minItems: "; and + - d. if the cardinality contained an integer value as upper boundary, "maxItems: "; and + - e. optionally "description: ", where is the description of the attribute in the table defining the structured data type; + 3. if the data type is "map()": + - a. a type definition "type: object"; and + - b. an "additionalProperties:" definition containing: + - i. if the data type of the attribute is "string", "number", "integer", or "boolean", a type definition using that data type as value ("type: "); or + - ii. otherwise a reference to the data type schema for the data type of the attribute, i.e. "\$ref: '#/components/schemas/'" if that data type schema is contained in the same OpenAPI specification file and "\$ref: '/#/components/schemas/'" if that data type schema is contained in file in the same directory on the same server; + - c. if the cardinality contained an integer value as lower boundary, "minProperties: "; and + - d. if the cardinality contained an integer value as upper boundary, "maxProperties: "; and + - e. "description: ", where is the description of the attribute in the table defining the structured data type. +- NOTE: An omission of the "minProperties", and "maxProperties" keywords indicates that no lower or upper boundaries respectively, for the number of properties in an object are defined. An omission of the "minItems", and "maxItems" keywords indicates that no lower or upper boundaries, respectively, for the number of items in an array are defined. +4. if the data type is "Any Type": + - a. if no properties to be defined, a pair of curly braces after the attribute name key ": {}", which is shorthand syntax for an arbitrary-type schema; or + - b. at least one of the following properties: + - i) if null value is allowed, "nullable: true"; or + - ii). "description: ", where is the description of the attribute in the table defining the structured data type. + +Example: + +**Table 5.3.9-1: Definition of type ExampleStructuredType** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------------|--------------------|---|-------------|------------------------------------------------|---------------| +| exSimple | ExSimple | M | 1 | exSimple attribute description | | +| exArrayElements | array(string) | O | 0..10 | exArrayElements attribute description | | +| exMapElements | map(ExStructure) | M | 1..N | exMapElements attribute description | | +| exNestedArray | array(map(string)) | M | 0..N(1..M) | exNestedArray attribute description | | +| exNestedMap | map(array(string)) | O | 1..N(2..M) | exNestedMap attribute description | | +| exAnyTypeNullableElement | Any Type | O | 0..1 | exAnyTypeNullableElement attribute description | | +| exAnyTypeNoDescription | Any Type | O | 0..1 | n/a | | + +The data structure in table 5.3.9-1 is described in an OpenAPI specification file as follows: + +``` + +components: + schemas: + ExampleStructuredType: + type: object + required: + - exSimple + - exMapElements + properties: + exSimple: + $ref: '#/components/schemas/ExSimple' + exArrayElements: + type: array + items: + type: string + minItems: 0 + maxItems: 10 + description: exArrayElements attribute description + exMapElements: + type: object + additionalProperties: + $ref: '#/components/schemas/ExStructure' + minProperties: 1 + description: exMapElements attribute description + exNestedArray: + type: array + items: + type: object + additionalProperties: + type: string + minProperties: 1 + description: exNestedArray attribute description + exNestedMap: + type: object + additionalProperties: + type: array + items: + type: string + minItems: 2 + minProperties: 1 + description: exNestedMap attribute description + exAnyTypeNullableElement: + nullable: true + description: exAnyTypeNullableElement attribute description + exAnyTypeNoDescription: {} + +``` + +### 5.3.10 Data types describing alternative data types or combinations of data types + +For a data type describing alternatives, as defined in clause 5.2.4.5, the OpenAPI specification [4] file shall contain a definition in the components/schemas clause defining a schema with the name of the data type describing alternatives as key. + +The schema shall contain: + +- the "oneOf", "anyOf" or "allOf" keyword selected as follows: + 1. for table caption "Definition of type as a list of mutually exclusive alternatives", the "oneOf" keyword; + 2. for table caption "Definition of type as a list of non-exclusive alternatives", the "anyOf" keyword; + 3. for table caption "Definition of type as a list of to be combined data types", the "allOf" keyword; +- a list of alternatives, containing for each line in the table describing the data type a separate line starting with "-": + 1. if the data type is "": + - a. if the data type of the attribute is "string", "number", "integer", or "boolean"; + - i) a type definition using that data type as value ("type: "); and + - ii) optionally "description: ", where is the description of the attribute in the table defining the structured data type; or + - b. otherwise a reference to the data type schema for the data type of the attribute, i.e. "\$ref: '#/components/schemas/'" if that data type schema is contained in the same OpenAPI specification file and "\$ref: '#/components/schemas/'" if that data type schema is contained in file in the same directory on the same server; + 2. if the data type is "array()": + - a. a type definition "type: array"; + - b. an "items:" definition containing: + - i). if the data type of the attribute is "string", "number", "integer", or "boolean", a type definition using that data type as value ("type: "); or + - ii). otherwise a reference to the data type schema for the data type of the attribute, i.e. "\$ref: '#/components/schemas/'" if that data type schema is contained in the same OpenAPI specification file and "\$ref: '#/components/schemas/'" if that data type schema is contained in file in the same directory on the same server; + - c. if the cardinality contained an integer value as lower boundary, "minItems: "; and + - d. if the cardinality contained an integer value as upper boundary, "maxItems: "; and + - e. optionally "description: ", where is the description of the attribute in the table defining the structured data type; + 3. if the data type is "map()": + - a. a type definition "type: object"; and + - b. an "additionalProperties:" definition containing: + - i). if the data type of the attribute is "string", "number", "integer", or "boolean", a type definition using that data type as value ("type: "); or + - ii). otherwise a reference to the data type schema for the data type of the attribute, i.e. "\$ref: '#/components/schemas/'" if that data type schema is contained in the same OpenAPI specification file and "\$ref: '#/components/schemas/'" if that data type schema is contained in file in the same directory on the same server; + - c. if the cardinality contained an integer value as lower boundary, "minProperties: "; and + - d. if the cardinality contained an integer value as upper boundary, "maxProperties: "; and + - e. optionally "description: ", where is the description of the attribute in the table defining the structured data type. + +NOTE: An omission of the "minProperties", and "maxProperties" keywords indicates that no lower or upper boundaries respectively, for the number of properties in an object are defined. An omission of the "minItems", and "maxItems" keywords indicates that no lower or upper boundaries, respectively, for the number of items in an array are defined. + +Example: + +**Table 5.3.10-1: Definition of type ExampleAlternativesType as a list of mutually exclusive alternatives** + +| Data type | Cardinality | Description | Applicability | +|------------------|-------------|---------------------------------------|---------------| +| ExSimple | 1 | exSimple attribute description | | +| array(string) | 0..10 | exArrayElements attribute description | | +| map(ExStructure) | 1..N | exMapElements attribute description | | + +The data structure in table 5.3.10-1 is described in an OpenAPI specification file as follows: + +``` +components: + schemas: + ExampleAlternativesType: + oneOf: + - $ref: '#/components/schemas/ExSimple' + - type: array + items: + type: string + minItems: 0 + maxItems: 10 + description: exArrayElements attribute description + - type: object + additionalProperties: + $ref: '#/components/schemas/ExStructure' + minProperties: 1 + description: exMapElements attribute description +``` + +### 5.3.11 Error Responses + +As described in clause 4.8 of the present specification and clause 5.2.7 of 3GPP TS 29.500 [2], 5GC SBI APIs use valid HTTP response codes as error codes in HTTP responses and may include a "ProblemDetails" data structure specified in clause 5.2.4.1 of 3GPP TS 29.571 [5] or an application-specific data structure. + +Table 5.2.7.1-1 of 3GPP TS 29.500 [2] specifies HTTP status code per HTTP method. For each HTTP method of an API, HTTP status codes shall be specified using response code tables as described in clauses 5.2.2 and 5.2.3. OpenAPI specification files shall include in the description of an HTTP method in the "paths" segment the mandatory HTTP status codes in Table 5.2.7.1-1 of 3GPP TS 29.500 [2] and the HTTP status codes listed in response codes table of that HTTP method. + +For the purpose of referencing, HTTP error responses with "ProblemDetails" data structure are specified as part of the CommonData OpenAPI specification file in Annex A of 3GPP TS 29.571 [5]. + +Example: + +In the example below, the 400, 500 and default error response descriptions defined in 3GPP TS 29.571 [5] are referenced. + +``` +paths: + /users: + get: + responses: + '200': + content: + application/json + schema: + $ref: '#/components/schemas/ExampleGetBody' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +``` + +The following definitions provided in Annex A of 3GPP TS 29.571 [5] are used in that example: + +``` +components: + responses: + '400': + description: Bad request + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '500': + description: Internal Server Error + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + default: + description: Generic Error +``` + +### 5.3.12 Enumerations + +For enumerations, as defined in clause 5.2.4.3, the OpenAPI specification [4] file shall contain a definition in the components/schemas clause defining a schema with the name of the enumeration as key. + +The schema + +- shall contain the "anyOf" keyword listing as alternatives: + 1. the "type: string" keyword and the "enum" keyword with a list of all defined values for the enumeration; and + 2. the "type: string" keyword and the "description" keyword with a description stating that the string is only provided for extensibility and is not used to encode contents defined in the present version of the specification. and +- may contain a description listing the defined values of the enumeration together with explanations of those values. + +NOTE: The "enum" keyword restricts the permissible values of the string to the enumerated ones. This can lead to extensibility problems when new values need to be introduced. + +Example: + +**Table 5.3.12-1: Enumeration ExampleEnumeration** + +| Enumeration value | Description | Applicability | +|-------------------|-----------------------|---------------| +| One | Value One description | | +| Two | Value Two description | | + +The data structure in table 5.3.12-1 is described in an OpenAPI specification file as follows: + +``` +components: + schemas: + ExampleEnumeration: + anyOf: + - type: string + enum: + - One + - Two + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + - type: string + description: > + Possible values are + - One: Value One description + - Two: Value Two description +``` + +### 5.3.13 Formatting of structured data types in query parameters + +Structured data types shall represent JSON objects or arrays. + +When used in query parameters of a URI, the following formatting shall be used: + +- JSON objects and arrays of JSON objects: they shall be formatted using the JSON syntax, which is specified in OpenAPI [4] by including a "content:" block, and specifying the "application/json" media type, followed by the OpenAPI definition of the object. + +#### EXAMPLE: + +``` +- name: plmn-id + in: query + content: + application/json: + schema: + type: object + properties: + mcc: + type: string + mnc: + type: string +``` + +This results in the following formatting: + +``` +.../resource?plmn-id={"mcc":"123","mnc":"456"} +``` + +- Arrays of simple types: they shall be formatted using the OpenAPI "style" keyword set to "form" and the "explode" keyword set to "false". + +#### EXAMPLE: + +``` +- name: service-names + in: query + style: form + explode: false + schema: + type: array + items: + type: string +``` + +This results in the following formatting: + +``` +.../resource?service-names=service1,service2,service3 +``` + +### 5.3.14 Attribute Presence Conditions + +In an OpenAPI specification [4], presence conditions for attributes in a JSON schema definition shall be expressed by using the "required" keyword, indicating a list (array) of attributes that shall always be present in an object conforming to such schema. + +The "required" keyword may be used as part of any of the expressions defined by OpenAPI to combine schemas ("oneOf", "anyOf", "allOf", "not"). + +#### EXAMPLES: + +- JSON object defining attributes "a" and "b", of type integer, where attribute "a" shall always be present: + +``` +components: + schemas: + ExampleType1: + type: object + required: [ a ] + properties: + a: + type: integer + b: + type: integer +``` + +- JSON object defining attributes "a" and "b", of type integer, where at least one of them, or both, shall be present: + +``` +components: +``` + +``` +schemas: + ExampleType2: + type: object + anyOf: + - required: [ a ] + - required: [ b ] + properties: + a: + type: integer + b: + type: integer +``` + +- JSON object defining attributes "a" and "b", of type integer, where at least one of them shall be present, but not both: + +``` +components: + schemas: + ExampleType3: + type: object + oneOf: + - required: [ a ] + - required: [ b ] + properties: + a: + type: integer + b: + type: integer +``` + +- JSON object defining attributes "a" and "b", of type integer, where "a" and "b" can be both absent but, if one of them is present, the other shall be absent: + +``` +components: + schemas: + ExampleType4: + type: object + not: + required: [ a, b ] + properties: + a: + type: integer + b: + type: integer +``` + +- JSON object defining attributes "a" and "b", of type integer, where "b" shall be present if "a" takes a given value (e.g., value 1), but may be absent otherwise: + +``` +components: + schemas: + ExampleType5: + type: object + properties: + a: + type: integer + b: + type: integer + anyOf: + - not: + required: [ a ] + properties: + a: + type: integer + enum: [ 1 ] + - required: [ b ] +``` + +- JSON object defining attributes "a" and "b", of type integer, where "b" shall be present if and only if "a" takes a given value (e.g., value 1): + +``` +components: + schemas: + ExampleType6: + type: object + properties: + a: + type: integer + b: + type: integer +``` + +``` + +oneOf: + - required: [ a ] + properties: + a: + type: integer + enum: [ 1 ] + - not: + required: [ b ] + +``` + +### 5.3.15 Usage of the "tags" field + +In an OpenAPI specification, all HTTP operations belonging to the same resource should include a "tags" field containing a same value, briefly describing that resource (e.g. using the name of the resource and its archetype). This results in all operations being grouped by the User Interface of OpenAPI tools, which helps with readability of the API documentation. + +#### EXAMPLE: + +``` + +openapi: 3.0.0 +(...) +paths: + /nf-instances/{nfInstanceID}: + get: + summary: Read the profile of a given NF Instance + operationId: GetNFInstance + tags: + - NF Instance ID (Document) + (...) + put: + summary: Register a new NF Instance + operationId: RegisterNFInstance + tags: + - NF Instance ID (Document) + (...) + patch: + summary: Update NF Instance profile + operationId: UpdateNFInstance + tags: + - NF Instance ID (Document) + (...) + +``` + +### 5.3.16 Security + +As indicated in 3GPP TS 33.501 [22] and 3GPP TS 29.500 [2], the access to an 5GC API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [n3]), based on local configuration. 5GC APIs thus need to support the OAuth2 protocol. + +To reflect this, the OpenAPI specification file of an API shall contain: + +- a top-level "security" field, that applies to the overall API unless overridden by a resource/operation-level "security" field, listing as alternatives: + - i) "{}" to indicate that usage of security is optional; and + - ii) the name of the security scheme for oAuth2, including in the array of scopes the name of the API as the only scope; and optionally +- a resource/operation-level "security" field, that applies to a specific operation on a specific resource, and overrides the top-level "security" field, listing as alternatives: + - i) "{}" to indicate that usage of security is optional; and + - ii) the name of the security scheme for oAuth2, including in the array of scopes the name of the API as the only scope, and + - iii) the name of the security scheme for oAuth2, including in the array of scopes the name of the API and the name of the scope to be used to invoke the specific resource/operation, and +- a "securitySchemes" field in the "components" clause defining a security schema for oAuth2 as follows: + +- i) to be of type "oauth2"; and +- ii) with a "flows" field containing a "clientCredentials" field that contains: + - 1) a "tokenUrl" field pointing to the Access Token Request service provided by the NRF (see 3GPP TS 29.510 [18]); and + - 2) a "scopes" field defining all the different scopes applicable to this API, which includes the name of the corresponding API (using the format used within URIs of that API) to be used as the scope required to get access to the overall API, and also including those resource/operation-level scopes to be used as scopes required to invoke a specific operation on a specific resource. + +The naming of the resource/operation-level scopes should consist of the concatenation of the service name, a string or sequence of strings representing a resource name or set of resource names or custom operation, and optionally a string indicating the type of access (e.g. read/modify/create), separated by the ":" (colon) character. + +Such last string component of the resource/operation-level scope, that represents the type of access for a resource, should comply with the following principles: + +- "read": for GET operations for any resource archetype, +- "create": for POST or PUT operations that result in a creation of new resources from a collection or store resource, +- "modify": for PUT, PATCH or DELETE operations that result on an update or deletion of a document resource, +- "invoke": for POST operations that result in the invocation of a custom operation +- "write": for any operation that results in creation, modification or deletion of resource representations. + +Example: + +``` +security: + - {} + - oAuth2ClientCredentials: + - nnrf-nfm + +paths: + /nf-instances: + get: + security: + - {} + - oAuth2ClientCredentials: + - nnrf-nfm + - oAuth2ClientCredentials: + - nnrf-nfm + - nnrf-nfm:nf-instances:read + parameters: + (...) + responses: + (...) + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nnrf-nfm: Access to the Nnrf_NFManagement API + nnrf-nfm:nf-instances:read: Read access to the NF Instances (Collection) resource +``` + +### 5.3.17 Reuse of Structured Data Types + +As indicated in clause 5.2.4.1, common data types can be defined in 3GPP TS 29.571 [5], in order to avoid the duplication of data type definitions across multiple APIs. + +When such data types are of type object, a given API may require that the common data type is extended with additional attributes, on top of those from the original definition in 3GPP TS 29.571 [5]. + +In such case, the new data type in that API should not re-define entirely the common data type, and instead, it should use appropriate constructs in OpenAPI (i.e. the "allOf" keyword) to indicate that the new data type contains all the attributes from the common data type, by referencing to it, and indicate the additional attributes needed in the new data type. + +#### EXAMPLE: + +The ProblemDetails data type is defined in 3GPP TS 29.571 [5] as: + +``` +ProblemDetails: + type: object + properties: + type: + $ref: '#/components/schemas/Uri' + title: + type: string + status: + type: integer + detail: + type: string + instance: + $ref: '#/components/schemas/Uri' + cause: + type: string + invalidParams: + type: array + items: + $ref: '#/components/schemas/InvalidParam' + minItems: 1 +``` + +Then, if a given API needs to extend ProblemDetails with an additional attribute, e.g. "action" of type string, it should define, e.g. an ExtendedProblemDetails data type as follows: + +``` +ExtendedProblemDetails: + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + - $ref: '#/components/schemas/ProblemDetailsExtension' + +ProblemDetailsExtension: + type: object + properties: + action: + type: string +``` + +# --- 6 Requirements for secure API design + +## 6.1 Introduction + +This clause contains a list of security requirements for API design provided by SA3. + +## 6.2 General + +The following requirements are intended as general guidance for 3GPP Stage 3 work in order to specify secure protocols and APIs. As such, these guidelines are independent of the specific technology and shall be followed at all times. + +- The valid format and range of values (when applicable) for each IE shall be defined unambiguously. + +NOTE 1: Explicitly defining format and range of values not only helps to improve the security of a certain implementation, but also allows for reliable interoperability between different protocol implementations. Example: Defining a "lowercase string variable of length 10 and range [a..z]" is much more explicit than just defining a "string of length 10". There are known vulnerabilities such as a denial of service (resulting in the parser converting from a string representing an integer – an attacker can pass in an arbitrarily large integer and trigger an unhandled exception) and such leading to a heap corruption and crash (proof-of-concept available), or potentially remote code execution (no proof-of-concept known). Unicode literals also require special treatment when doing string comparisons to ensure that equivalent strings return true when compared. + +- For each message the number of leaf IEs shall not exceed 16K. If a leaf IE is an array of a simple data type, then the whole array shall count as one leaf. If a leaf IE is a data structure or an array of data structures, then it shall be considered a branch, i.e. it shall not be counted as a leaf. The data structure's (branch) attributes determine the number of leaves. For instance, a data structure with e.g. three attributes will count as three leaves. +- The maximum size of the JSON body of any HTTP request/response shall not exceed 16 million octets before compression is applied, if any. + +NOTE 2: APIs need to be designed taking care to avoid a too large HTTP payload size for performance reasons. + +- The maximum nesting depth of leaves shall not exceed 32. If a leaf IE is an array of a simple data type, then the whole array shall be considered as the first level of nesting. If a leaf IE is a data structure or an array of data structures, then it shall be considered a branch and the first level of nesting. The data structure's attributes (leaves) shall be considered as the second level of nesting. For instance, a data structure with e.g. one attribute-A, which is also a data structure with e.g. one attribute-B, then attribute-B will make the third level of nesting. + +NOTE 3: There are resource exhaustion attacks on JSON parsers. Defined maximum numbers of IEs, sizes and nesting depths allow implementations to know an upper bound of required resources. It also allows validation of incoming messages. Recursively processing nested objects leads to stack exhaustion and a denial of service bug. + +- For data structures where values are accessible using names (sometimes referred to as keys), e.g. a JSON object, the name shall be unique. The occurrence of the same name (or key) twice within such a structure shall be an error and the message shall be rejected. + +NOTE 4: Serialization schemes (e.g. JSON) can leave the handling of repeated names (keys) up to the implementer's discretion. For example, for a repeated name an error can be raised, the pair can be ignored, or the first or last value read can be used, though there is no canonical order in which a parser should treat the data it receives. Failure to adhere to consistent handling rules can lead to vulnerabilities. From a security perspective rejecting objects with repeated names, rather than accepting according to some rule, is the more robust solution, and aids in identification of potentially malicious activity. There are known attacks with specially crafted malicious messages that are designed to confuse implementations of NFs to get fraudulent messages into a PLMN. + +## 6.3 SBA-specific requirements + +The following requirements shall be considered for every network function that implements a service-based interface. + +- OpenAPI specifications are machine-readable JSON objects and can be used as the basis for re-configuring an NFs action when an API or message structure changes. Therefore, each OpenAPI specifications shall contain all necessary information to correctly and unambiguously parse the contents of the message body. + +NOTE: Attacks often exploit corner cases and unspecified behavior in order to exploit a system. Traffic normalization counters this by either dropping traffic that is malformed or by forcing certain information elements to a "normal" value. Typically, this relates to inconsistent fields. + +- 3GPP TS 33.501 [22] documents which type of information shall be confidentiality protected on the N32 interface. The fields where these types of information (e.g. SUPI) is contained may have different names. Even if the field names are different, the mechanism specified in clause 5.2.3.3 of 3GPP TS 29.573 [24] shall clearly identify the type of information carried in each IE and which information types shall be confidentiality protected. + +# --- Annex A (informative): TS Skeleton Template + +A TS Skeleton Template to be used as a starting point of drafting a 5G System SBI Stage 3 specification is available at the following location: + +[https://www.3gpp.org/ftp/information/All\\_Templates/29.xxx-SBI-Stage3-Template.zip](https://www.3gpp.org/ftp/information/All_Templates/29.xxx-SBI-Stage3-Template.zip) + +# --- Annex B (informative): Backward Incompatible Changes + +This Annex provides information about the changes in the API that are considered as backwards compatible and those that are considered as backwards incompatible. This list is to be considered informative and it may be expanded in future releases, when necessary. + +Backward compatible changes are additions or changes in the API that do not break the existing Service Consumer behaviour. Examples of backward compatible changes include: + +- Adding a new, optional child resource/URI; +- Supporting a new HTTP method; +- Adding new elements to a resource representation; +- Changing the order of fields in a resource representation; +- Addition of a new status code: + +NOTE 1: When a NF / NF Service receives a HTTP status code that it cannot recognize it will treat it as the corresponding x00 status code as specified in clause 5.2.7.3 of 3GPP TS 29.500 [2]. + +- Corrections of obvious errors in an OpenAPI file required to enable a correct parsing of the file such as misspelled references; +- Corrections that only relate to smaller and optional parts of the functionality (e.g. a supported feature, see 3GPP TS 29.500 [2] clause 6.6.2), even if the changes are backward incompatible with respect to that part of the functionality; and + +NOTE 2: It is recommended to only apply corrections which are also backward compatible with respect to such smaller and optional parts of the functionality. If this is not possible a new supported feature can be introduced to enable a negotiation of the support of the correction, and the old corresponding supported feature can be marked as "withdrawn" in the table defining the supported features of an API. + +- Backward-compatible changes related to the semantics (i.e. functional behaviour) specified for an API. + +Backward incompatible changes are additions or changes in the API that break the existing Service Consumer behaviour. Here is a list of backward incompatible changes that shall require incrementing the 1st field (MAJOR) of the API version number unless they only relate to smaller and optional parts of the functionality (see above): + +- Removing a resource/URI; +- Removing support for an HTTP method; +- Renaming a field in a resource representation; +- Adding mandatory parameters to a resource URI or resource representation; +- Attribute data type changes; +- Cardinality changes (NOTE 3); and + +NOTE 3: Whether attribute cardinality changes are backward compatible depend on the type of change. Examples of non-backward compatibility changes include decreasing the upper bound of a cardinality range for attributes sent by the NF service consumer, changing the meaning of the default behavior associated to the absence of an attribute of cardinality 0..N, etc. + +- Backward incompatible changes related to the semantics (i.e. functional behaviour) specified for an API. + +# --- Annex C (Informative): Resource modelling + +## C.0 General + +When designing an API, one shall first think of defining the set of resources consumed. Resources represent objects that are modified by standard HTTP methods and that can be modelled with one of 4 archetypes detailed below. Resource archetypes help API designers to structure the resources. In this process the designer should refer to the appropriate archetype when the resource definition perfectly matches the archetype one. Referring to an archetype immediately defines what operations and HTTP methods are supported by the resource. + +The archetypes provided hereafter don't preclude the existence of resources of different types. + +## --- C.1 Document + +The document archetype is the conceptual base archetype of the other ones. Any resource that is not identified with one of the other resource archetypes is a document. + +A document may have child resources that represent its specific subordinate concepts. + +The archetype does not place any restriction on HTTP methods when acting on a document. + +Only CRUD operations are performed directly on a document resource, i.e. by sending an HTTP request to the URI of that resource. Custom methods are not performed directly on the resource, but by sending an HTTP request to a URI that is associated by a convention (see clause X.4) with the URI of the resource. + +## --- C.2 Collection + +The collection archetype can be used to model a resource that serves as a directory of resources. A collection is NF Service Provider-managed so the NF Service Provider decides the URIs of each resource that is created in the collection. + +NOTE: Even though a collection resource typically contains child resources, it is allowed that a particular collection resource does not contain any child resource at a particular point in time ("empty collection"). + +The Create and Read operations are performed on a collection directly. + +More specifically: + +- A collection child resource is created by sending a POST with the collection URI if accepted by the collection; +- A collection is read by sending a GET with the collection URI; +- The PUT and PATCH methods with the collection URI are not allowed; +- The DELETE method with the collection URI is only allowed if the collection resource has been created dynamically based on a request from the NF Service Consumer. +- The authorized operations on a collection child resource depend on that resource's archetype. + +## C.3 Store + +The store archetype can also be used to model a resource that serves as a directory of resources but a store is NF Service Consumer-managed. The NF Service Consumer solely decides what resource shall be added to / deleted from a store. The NF Service Consumer decides what the URI of the added resource is. + +NOTE: Even though a store resource typically contains child resources, it is allowed that a particular store resource does not contain any child resource at a particular point in time ("empty store"). + +The Read operation is performed on a store directly, and the Create operation is performed on store child resources. + +More specifically: + +- A store child resource is created by sending a PUT with the URI of the child resource to be created. +- A store is read by sending a GET with the store URI; +- The POST, PUT and PATCH methods with the store URI are not allowed; +- The DELETE method with the store URI is only allowed if the store resource has been created dynamically based on a request from the NF Service Consumer. +- Apart from Create (PUT), the authorized operations on a store child resource depend on that resource's archetype. + +## C.4 Custom operation + +The custom operation archetype can be used to model an unsafe and non-idempotent operation that is not a Create on a collection. + +A custom operation does not operate directly on the resource that would be identified by the custom operation URI. Instead, when the custom operation is associated with a resource, the operation is performed on this associated resource. For instance, a custom operation may modify the associated resource in a special way. This associated resource is identified by stripping the suffix string "" from the custom operation URI template in clause 4.4.2. + +When the custom operation is not associated with any resource but with the service, it acts as an executable function with input parameters and returns the result of the executed function in the response body, not modifying any resource. + +POST is the only method allowed with a custom operation URI. + +The semantic of the custom operation is encoded in the last segment of the URI template in chapter 4.4.2: `/{custOpName}`. + +# Annex D (informative): Example of an OpenAPI specification file for Patch + +As described in clause 4.6.1.1.3.2, the bodies of HTTP PATCH requests will either use a "JSON Merge Patch" encoding as defined in IETF RFC 7396 [7], or a "JSON Patch" encoding as defined IETF RFC 6902 [8]. This annex provides an example OpenAPI Specification [4] allowing both encodings. + +NOTE: Both encoding possibilities are shown in this example for illustrative purposes. However, only a single of the above encodings will be specified for each resource where the PATCH method is supported unless backward compatibility considerations necessitate the support of both encodings. + +``` +openapi: 3.0.0 +info: + version: "1.0.0" + title: PATCH Example +paths: + /inventory: + post: +``` + +``` +summary: adds an inventory item +operationId: addInventory +description: Adds an item to the system +responses: + '201': + description: item created + '400': + description: 'invalid input, object invalid' + '409': + description: an existing item already exists +requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InventoryItem' + description: Inventory item to add +/inventory/{id}: + get: + summary: read inventory item + parameters: + - name: id + in: path + required: true + schema: + type: integer + responses: + '200': + description: search results matching criteria + content: + application/json: + schema: + $ref: '#/components/schemas/InventoryItem' + '400': + description: bad input parameter + patch: + summary: patch inventory item + parameters: + - name: id + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/PatchInventoryItem' + application/merge-patch+json: + schema: + $ref: '#/components/schemas/MergePatchInventoryItem' + responses: + '200': + description: Patch was successful and updated Inventory Item is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/InventoryItem' + '204': + description: Patch was successful + '400': + description: bad input parameter +components: + schemas: + InventoryItem: + type: object + required: + - name + - manufacturer + properties: + id: + type: integer + name: + type: string + manufacturer: + $ref: '#/components/schemas/Manufacturer' + customers: + type: array +``` + +``` + + items: + type: string +Manufacturer: + type: object + required: + - name + properties: + name: + type: string + homePage: + type: string + format: url + phone: + type: string +PatchInventoryItem: + type: array + description: A JSON PATCH body schema to Patch selected parts of an Inventory Item + items: + anyOf: + - oneOf: + - type: object + description: Modifies the URL of a Manufacturer + properties: + op: + type: string + enum: + - "add" + - "remove" + - "replace" + path: + type: string + pattern: '^\/manufacturer\/homePage$' + value: + type: string + format: url + required: + - "op" + - "path" + - type: object + description: Modifies a Manufacturer + properties: + op: + type: string + enum: + - "replace" + path: + type: string + pattern: '^\/manufacturer$' + value: + $ref: '#/components/schemas/Manufacturer' + required: + - "op" + - "path" + - "value" + - type: object + description: Modifies a Customer + properties: + op: + type: string + enum: + - "add" + - "remove" + - "replace" + path: + type: string + pattern: '^\/customers\/(-|\d+)$' + value: + type: string + required: + - "op" + - "path" + - type: object + description: Open Alternative + minItems: 1 +MergePatchInventoryItem: + description: A JSON Merge PATCH body schema to Patch selected parts of an Inventory Item + type: object + properties: + +``` + +``` +manufacturer: + $ref: '#/components/schemas/Manufacturer' + nullable: true +customers: + type: array + description: Allows to replace the entire array, but not to modify individual elements. + items: + type: string +``` + +# --- Annex E (Informative): Considerations for handling of JSON arrays + +This Annex provides guidelines on the use of JSON arrays on the SBI APIs of the 5GC. + +As described in clause 5.2.4, the data model of an API definition in a 5GC API consists of any of the different data types supported by OpenAPI, corresponding to the different data structures found in the JSON data format. One of these structures is the "array", representing a set of ordered values. + +It should be noted that, while JSON allows that the value of the elements of an array may be of different types, in OpenAPI 3.0.0 this is further restricted, and all elements of an array shall be of the same type. + +Also, it is important to note that the JSON format itself, as specified in IETF RFC 8259, does not define any syntax to refer to specific array elements. + +However, there are certain conventions to specify mechanisms to refer to array elements, e.g. based on the position a given element has in the array. + +In particular, the JSON Pointer syntax defines a string syntax for identifying a specific value within a JSON document. This syntax consists of a number of tokens separated by the "/" character; in order to refer to a specific element in an array, then token shall contain an unsigned decimal value, indicating the zero-based index of the element in the array. + +### EXAMPLE: + +JSON document: + +``` +{ + "attr1": 0, + "attr2": true, + "attr3": [ 1, 2, 3 ] +} +``` + +JSON Pointer expression "/attr3/0" evaluated on such JSON document: 1 + +There are several scenarios, frequently employed in the 5GC APIs, that make use of the JSON Pointer mechanism to refer to specific elements in an array: + +- Update of resources using the PATCH method, as described in clause 4.6.1.1.3.2. If the syntax used in the PATCH request payload is based on the "JSON Patch" format, then the JSON Pointer mechanism is used to specify patch operations applied to specific array elements. +- Notifications of events (such as data changes), as described in clause 4.6.2.3, using as notification payload the notation defined in "NotifyItem" / "Changeltem" data types defined in 3GPP TS 29.571 [xx]. This notation is similar to "JSON Patch", so it also makes use of the JSON Pointer syntax to refer to specific array elements. +- Explicit usage of attributes containing JSON Pointer expressions in request or response payloads. + +In these scenarios, it is critical that any JSON Pointer expression is applied by both client and server on the exact same array representation, since otherwise the indexes may vary, and the JSON Pointer will give unexpected results. + +A typical scenario that may create issues could be as follows: + +1. NF Service Consumer sends a first GET request towards a NF Service Producer, including certain query parameters in the HTTP request, that result into retrieving a resource representation that contains a subset of the data that the NF Service Producer holds under such resource. When such subset refers to returning just some of + +the elements of an array, rather than the entire array, then the content of the array will differ between consumer and producer. + +- 2a. The NF Service Consumer sends a subsequent PATCH request towards the NF Service Producer, with the intention to modify a given element of the array (specified by the array index, per the JSON Pointer syntax). This results into the server modifying a wrong element in the array, given that the NF Service Producer contains a different array. +- 2b. Alternatively, the NF Service Consumer may subscribe to be notified by the NF Service Producer when a given resource representation has changed. When the NF Service Producer detects such a change, it sends a notification that may include a reference to an array index, which may be different than the array index kept by the NF Service Producer. + +Another scenario that may lead to incorrect array updates is: + +1. Two different NF Service Consumer sends a GET request towards a NF Service Producer to retrieve the representation of a certain resource. +2. A first NF Service Consumer NF1 sends a PATCH request towards the NF Service Producer, with the intention to delete a given element of the array (specified by the array index, per the JSON Pointer syntax). This results in some of the array indexes being changed (of those elements placed after the deleted element) +3. A second NF Service Consumer NF2, sends another PATCH request towards the NF Service Producer, to modify any of the elements of the array whose index was affected by the previous operation done by NF1. This results in modifying unintentionally the wrong array element. + +The design of 5GC SBI APIs should take into account these scenarios and provide mechanisms to avoid unintended modifications of array elements, when they are referred by their position index in the array. + +To achieve these, both NF Service Consumer and Producer (taking the role of HTTP client and server) should ensure that any resource update takes place on a known and current resource representation, based on the content of ETag values sent along with resource representations by the resource owner. + +If an NF Service Consumer needs to cache a resource representation received from an NF Service Producer (i.e. the JSON information received in an HTTP response message), it shall use the exact same representation of arrays as received from the service producer. + +When sending notifications or modifications whose semantics is based on the JSON Pointer syntax, the sending NF shall use the exact same representation of arrays as previously signalled in a previous interaction with the receiver of such notifications/modifications. + +# Annex F (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----|---------|-----|-----------------------------------------------|----------------| +| Date | Meeting | TDoc | CR | R
ev | Cat | Subject/Comment | New
version | +| 2017-10 | CT4#80 | C4-175250 | | | | TS skeleton | 0.1.0 | +| 2017-10 | CT4#80 | C4-175358
C4-175252
C4-175253
C4-175254
C4-175255
C4-175331
C4-175332
C4-175333
C4-175334
C4-175359
C4-175327
C4-175328
C4-175360
C4-175330
C4-175336
C4-175337 | | | | Inclusion of pCRs agreed at CT4#80 | 0.2.0 | +| 2017-12 | CT4#81 | C4-176414
C4-176372
C4-176447
C4-176415
C4-176416
C4-176417
C4-176418
C4-176250
C4-176419
C4-176422 | | | | Inclusion of pCRs agreed at CT4#81 | 0.3.0 | +| 2018-01 | CT4#82 | C4-181179
C4-181384 | | | | Inclusion of pCRs agreed at CT4#82 | 0.4.0 | +| 2018-03 | CT4#83 | C4-182396
C4-182397
C4-182394
C4-182395
C4-182399
C4-182261
C4-182184
C4-182330
C4-182398
C4-182332 | | | | Inclusion of pCRs agreed at CT4#83 | 0.5.0 | +| 2018-03 | CT#79 | CP-180029 | | | | Presented for information | 1.0.0 | +| 2018-04 | CT4#84 | C4-183238
C4-183288
C4-183289
C4-183291
C4-183292
C4-183385
C4-183387
C4-183388
C4-183477
C4-183478 | | | | Inclusion of pCRs agreed at CT4#84 | 1.1.0 | +| 2018-05 | | | | | | 29.xxx-SBI-Stage3 Template added in zip-file. | 1.1.1 | +| 2018-05 | CT4#85 | C4-184492
C4-184493
C4-184494
C4-184495
C4-184496
C4-184544
C4-184614
C4-184503
C4-184497
C4-184592 | | | | Inclusion of pCRs agreed at CT4#85 | 1.2.0 | +| 2018-06 | CT#80 | CP-181099 | | | | Presented for approval | 2.0.0 | +| 2018-06 | CT#80 | | | | | Approved in CT#80. | 15.0.0 | +| 2018-07 | | | | | | TS template added in zip-file | 15.0.1 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|--------------------------------------------------------------------------------------------------------------|--------| +| 2018-09 | CT#81 | CP-182054 | 0001 | 4 | B | Security requirements for API design | 15.1.0 | +| 2018-09 | CT#81 | CP-182054 | 0002 | | F | Example URIs in figures | 15.1.0 | +| 2018-09 | CT#81 | CP-182054 | 0003 | 2 | F | Clarification on the use of API version number | 15.1.0 | +| 2018-09 | CT#81 | CP-182054 | 0004 | 2 | F | External Docs Clause in OpenAPI file | 15.1.0 | +| 2018-09 | CT#81 | CP-182054 | 0006 | 1 | B | JSON Structures in Query Parameters | 15.1.0 | +| 2018-09 | CT#81 | CP-182054 | 0008 | 1 | F | Servers Selection in OpenAPI | 15.1.0 | +| 2018-09 | CT#81 | CP-182054 | 0009 | | F | Query Parameter | 15.1.0 | +| 2018-09 | CT#81 | CP-182054 | 0010 | | F | yaml file names | 15.1.0 | +| 2018-09 | CT#81 | CP-182054 | 0011 | | F | OpenAPI servers field | 15.1.0 | +| 2018-09 | CT#81 | CP-182054 | 0012 | 1 | F | Query parameter | 15.1.0 | +| 2018-09 | CT#81 | CP-182054 | 0013 | 1 | F | presence condition and cardinality | 15.1.0 | +| 2018-09 | CT#81 | CP-182054 | 0014 | 1 | F | Clarification on Naming Conventions and Digits | 15.1.0 | +| 2018-09 | CT#81 | CP-182054 | 0015 | 1 | F | URIs of created resources | 15.1.0 | +| 2018-09 | CT#81 | CP-182054 | 0016 | 1 | F | Custom operation in resource structure presentation | 15.1.0 | +| 2018-12 | CT#82 | CP-183012 | 0018 | 2 | F | Attribute Presence Conditions | 15.2.0 | +| 2018-12 | CT#82 | CP-183012 | 0019 | 1 | F | Version addressed by references within OpenAPI files | 15.2.0 | +| 2018-12 | CT#82 | CP-183012 | 0020 | 2 | F | Resolve Editor's Note | 15.2.0 | +| 2018-12 | CT#82 | CP-183012 | 0021 | | F | Attribute with Any Type | 15.2.0 | +| 2018-12 | CT#82 | CP-183012 | 0022 | | F | Incorrect resource URI structure presentation | 15.2.0 | +| 2018-12 | CT#82 | CP-183012 | 0023 | 1 | F | Storage of OpenAPI files within a central directory | 15.2.0 | +| 2018-12 | CT#82 | CP-183012 | 0025 | 3 | F | Complex query expression | 15.2.0 | +| 2018-12 | CT#82 | CP-183012 | 0031 | 1 | F | Correction and Clarification on Security Requirements | 15.2.0 | +| 2018-12 | CT#82 | CP-183012 | 0032 | 2 | R | Subscription Lifetime for Subscribe / Notify operations | 15.2.0 | +| 2018-12 | CT#82 | CP-183012 | 0033 | | F | Usage of the "tags" field in OpenAPI | 15.2.0 | +| 2018-12 | CT#82 | CP-183012 | 0035 | 2 | F | Corrections to API versioning | 15.2.0 | +| 2018-12 | CT#82 | CP-183012 | 0036 | 1 | F | Security in Open API specification files | 15.2.0 | +| 2018-12 | CT#82 | CP-183012 | 0037 | 1 | F | Custom Operations | 15.2.0 | +| 2019-03 | CT#83 | CP-190017 | 0039 | 2 | F | Address Editor's Note on implicit subscriptions | 15.3.0 | +| 2019-03 | CT#83 | CP-190017 | 0040 | | F | Address Editor's Note on partial representation in POST response | 15.3.0 | +| 2019-03 | CT#83 | CP-190017 | 0041 | 1 | F | Maximum HTTP payload size | 15.3.0 | +| 2019-03 | CT#83 | CP-190017 | 0042 | 1 | F | HTTP Scheme | 15.3.0 | +| 2019-03 | CT#83 | CP-190017 | 0043 | 2 | F | Resolve Editor's Notes | 15.3.0 | +| 2019-03 | CT#83 | CP-190017 | 0044 | | F | Correction to Minor Field Increment Rules in API Versioning | 15.3.0 | +| 2019-03 | CT#83 | CP-190017 | 0045 | 1 | F | Handling of unknown attributes during resource creation and modification | 15.3.0 | +| 2019-03 | CT#83 | CP-190017 | 0046 | 1 | F | Correct use of "OpenAPI" name | 15.3.0 | +| 2019-03 | CT#83 | CP-190017 | 0047 | 1 | F | Resolution of Editor's Notes in Annex C | 15.3.0 | +| 2019-03 | CT#83 | CP-190017 | 0048 | 2 | F | IANA registration of "3gppHal+json" media type | 15.3.0 | +| 2019-03 | CT#83 | CP-190017 | 0049 | 1 | F | Addition of applicability column to query parameters table | 15.3.0 | +| 2019-03 | CT#83 | CP-190017 | 0050 | 1 | F | Removing multiple redundant appearances of major version number in TS template to ease update of that number | 15.3.0 | +| 2019-03 | CT#83 | CP-190017 | 0051 | 2 | F | Storage of OpenAPI specification files | 15.3.0 | +| 2019-03 | CT#83 | CP-190017 | 0052 | - | F | Use of Relative URI in Location Header | 15.3.0 | +| 2019-06 | CT#84 | CP-191028 | 0053 | 2 | F | Criteria for non-backward compatible changes | 15.4.0 | +| 2019-06 | CT#84 | CP-191028 | 0056 | 1 | F | Reuse of Structured Data Types | 15.4.0 | +| 2019-06 | CT#84 | CP-191028 | 0057 | 1 | F | Delete editor's note on complex query | 15.4.0 | +| 2019-06 | CT#84 | CP-191028 | 0059 | - | F | Correction on Notifications | 15.4.0 | +| 2019-06 | CT#84 | CP-191028 | 0060 | 1 | F | Copyright Note in YAML files | 15.4.0 | +| 2019-06 | CT#84 | CP-191028 | 0055 | 2 | F | Precedence of OpenAPI file | 15.4.0 | +| 2019-06 | CT#84 | CP-191028 | 0054 | 4 | F | Withdrawing API versions | 15.4.0 | +| 2019-06 | CT#84 | CP-191057 | 0061 | 2 | F | Updates to TS Template for SBI | 16.0.0 | +| 2019-09 | CT#85 | CP-192101 | 0065 | 1 | F | Externaldoc version number change | 16.1.0 | +| 2019-12 | CT#86 | CP-193025 | 0069 | 2 | A | Fourth field of API versions | 16.2.0 | +| 2019-12 | CT#86 | CP-193036 | 0070 | 1 | F | Add Corresponding API descriptions in clause 5.1 | 16.2.0 | +| 2019-12 | CT#86 | CP-193063 | 0066 | 2 | B | HAL-forms media type | 16.2.0 | +| 2019-12 | CT#86 | CP-193063 | 0067 | 1 | F | Extending ProblemDetails for Backward Compatibility | 16.2.0 | +| 2020-03 | CT#87e | CP-200054 | 0072 | 1 | F | Storage of YAML files in ETSI Forge | 16.3.0 | +| 2020-03 | CT#87e | CP-200039 | 0073 | 1 | F | New tables in 29.501 template | 16.3.0 | +| 2020-06 | CT#88e | CP-201034 | 0074 | 2 | F | Clarifications to callback URI | 16.4.0 | +| 2020-06 | CT#88e | CP-201034 | 0075 | 1 | B | Resource-Level Authorization | 16.4.0 | +| 2020-06 | CT#88e | CP-201034 | 0077 | 2 | F | Delimiters - URI and SBI specific | 16.4.0 | +| 2020-06 | CT#88e | CP-201034 | 0078 | 2 | F | URI types | 16.4.0 | +| 2020-06 | CT#88e | CP-201034 | 0080 | - | F | Correct the Resource Tree Example | 16.4.0 | +| 2020-06 | CT#88e | CP-201034 | 0081 | 1 | F | Requirements for secure API design | 16.4.0 | +| 2020-06 | CT#88e | CP-201034 | 0079 | 1 | F | API URI correction and template update | 16.4.0 | +| 2020-06 | CT#88e | CP-201034 | 0082 | 1 | F | Maximum JSON payload size | 16.4.0 | +| 2020-06 | CT#88e | CP-201071 | 0076 | - | F | Correction of the method used for Notification | 16.4.0 | +| 2020-06 | CT#88e | CP-201071 | 0083 | 1 | F | Missing abbreviations | 16.4.0 | +| 2020-09 | CT#89e | CP-202043 | 0093 | - | A | Storage of YAML files in 3GPP Forge | 16.5.0 | +| 2020-09 | CT#89e | CP-202109 | 0085 | 2 | D | Editorial fixes | 16.5.0 | +| 2020-09 | CT#89e | CP-202110 | 0086 | 2 | F | Handling of JSON Arrays | 16.5.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|----------------------------------------------------------|--------| +| 2020-09 | CT#89e | CP-202110 | 0087 | - | F | Naming requirements for resource/operation-level scopes | 16.5.0 | +| 2020-09 | CT#89e | CP-202110 | 0088 | 1 | F | Data types with string type | 16.5.0 | +| 2020-09 | CT#89e | CP-202110 | 0089 | - | F | Content of Location header when TLS is used | 16.5.0 | +| 2020-09 | CT#89e | CP-202110 | 0090 | - | F | Miscellaneous corrections | 16.5.0 | +| 2020-09 | CT#89e | CP-202110 | 0091 | 1 | F | API URI correction and template update | 16.5.0 | +| 2021-06 | CT#92e | CP-211065 | 0104 | - | F | Nested cardinality | 16.6.0 | +| 2022-09 | CT#97e | CP-222070 | 0128 | 1 | F | Essential Correction for Location Header in 201 Response | 16.7.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29511/0bf9346902e9a3bdabf05ceacc1947f5_img.jpg b/marked/Rel-16/29_series/29511/0bf9346902e9a3bdabf05ceacc1947f5_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7dff12e60c7c4a691353e1dbf6d9cf76aa6fab8c --- /dev/null +++ b/marked/Rel-16/29_series/29511/0bf9346902e9a3bdabf05ceacc1947f5_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6542a2fb95fa099144b4224c4578982e99ed0c7e6f3b9087f765eee84788f529 +size 34522 diff --git a/marked/Rel-16/29_series/29511/3f1987804d7d78bc3b3bc560e974280a_img.jpg b/marked/Rel-16/29_series/29511/3f1987804d7d78bc3b3bc560e974280a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..44bc0efeb4f44a01d71e91915bc3d1f1cf2e2513 --- /dev/null +++ b/marked/Rel-16/29_series/29511/3f1987804d7d78bc3b3bc560e974280a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cd642ba65794d4c85dabeca86be604726476263642147bca1627218bbbd91eee +size 12501 diff --git a/marked/Rel-16/29_series/29511/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-16/29_series/29511/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..60907a5d6c423b093940ed296c836ae1c6271997 --- /dev/null +++ b/marked/Rel-16/29_series/29511/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fe7588415845c33734431788080c91863218fb2ad20867910cfc185bd5d74380 +size 7692 diff --git a/marked/Rel-16/29_series/29511/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-16/29_series/29511/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7927f61b1239d261225220b410e3ffed88c5ef0b --- /dev/null +++ b/marked/Rel-16/29_series/29511/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bf1b852352c70ae4b6507e4a2cd8bd48142366a142f3f00a430c18206dfedd57 +size 5817 diff --git a/marked/Rel-16/29_series/29511/7f01b16d5b24d18555e9af849c410fbc_img.jpg b/marked/Rel-16/29_series/29511/7f01b16d5b24d18555e9af849c410fbc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c380e30c70176b7f1dd6665eb8cc6991697d64f6 --- /dev/null +++ b/marked/Rel-16/29_series/29511/7f01b16d5b24d18555e9af849c410fbc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d05a77eac532564a073b925fab5d7ec95cbc04c752b3b7f1d885527694af9c25 +size 10285 diff --git a/marked/Rel-16/29_series/29511/ba9d6e1a75eb6672d04e61a86e1b8a61_img.jpg b/marked/Rel-16/29_series/29511/ba9d6e1a75eb6672d04e61a86e1b8a61_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..bb70a61ffa3aee3d906f4227b4636c94ca3c0ca5 --- /dev/null +++ b/marked/Rel-16/29_series/29511/ba9d6e1a75eb6672d04e61a86e1b8a61_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:42414ab93575539cab77ddb81a96ac7d82927da1e943674875ad3388190f8603 +size 11905 diff --git a/marked/Rel-16/29_series/29511/raw.md b/marked/Rel-16/29_series/29511/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..83d85bd69fa03cd15f83eca29b6cd27480bd3a65 --- /dev/null +++ b/marked/Rel-16/29_series/29511/raw.md @@ -0,0 +1,774 @@ + + +# 3GPP TS 29.511 V16.6.0 (2021-09) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Equipment Identity Register Services; Stage 3 (Release 16)** + +![5G logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The 5G logo, featuring the text "5G" in a bold, black, sans-serif font. Above the "5G" text are three green curved lines representing signal waves. + +5G logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, featuring the text "3GPP" in a bold, black, stylized font. The "3" and "G" are connected at the top, and the "P" and "P" are connected at the top. Below the "G" is a red signal wave icon. + +3GPP logo + +A GLOBAL INITIATIVE + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2021, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|-----------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions and abbreviations ..... | 7 | +| 3.1 Definitions..... | 7 | +| 3.2 Abbreviations ..... | 7 | +| 4 Overview..... | 7 | +| 4.1 Introduction ..... | 7 | +| 5 Services offered by the 5G-EIR NF..... | 8 | +| 5.1 Introduction ..... | 8 | +| 5.2 N5g-eir_EquipmentIdentityCheck Service ..... | 8 | +| 5.2.1 Service Description ..... | 8 | +| 5.2.2 Service Operations..... | 9 | +| 5.2.2.1 Introduction..... | 9 | +| 5.2.2.2 CheckEquipmentIdentity ..... | 9 | +| 5.2.2.2.1 General ..... | 9 | +| 5.2.2.2.2 Procedure using CheckEquipmentIdentity Operation..... | 9 | +| 6 API Definitions ..... | 9 | +| 6.1 N5g-eir_EquipmentIdentityCheck Service API..... | 9 | +| 6.1.1 API URI..... | 9 | +| 6.1.2 Usage of HTTP..... | 10 | +| 6.1.2.1 General..... | 10 | +| 6.1.2.2 HTTP standard headers..... | 10 | +| 6.1.2.2.1 General ..... | 10 | +| 6.1.2.2.2 Content type ..... | 10 | +| 6.1.2.3 HTTP custom headers..... | 10 | +| 6.1.2.3.1 General ..... | 10 | +| 6.1.3 Resources..... | 10 | +| 6.1.3.1 Overview..... | 10 | +| 6.1.3.2 Resource: equipmentStatus..... | 11 | +| 6.1.3.2.1 Description ..... | 11 | +| 6.1.3.2.2 Resource Definition..... | 11 | +| 6.1.3.2.3 Resource Standard Methods..... | 11 | +| 6.1.4 Data Model ..... | 12 | +| 6.1.4.1 General..... | 12 | +| 6.1.4.2 Structured data types..... | 13 | +| 6.1.4.2.1 Introduction ..... | 13 | +| 6.1.4.2.2 Type: EirResponseData..... | 13 | +| 6.1.4.3 Simple data types and enumerations..... | 13 | +| 6.1.4.3.1 Introduction ..... | 13 | +| 6.1.4.3.2 Simple data types ..... | 13 | +| 6.1.4.3.3 Enumeration: EquipmentStatus..... | 14 | +| 6.1.5 Error Handling ..... | 14 | +| 6.1.5.1 General..... | 14 | +| 6.1.5.2 Protocol Errors ..... | 14 | +| 6.1.5.3 Application Errors..... | 14 | +| 6.1.6 Feature Negotiation ..... | 14 | +| 6.1.7 Security ..... | 15 | +| 6.1.7.1 General..... | 15 | +| 6.1.7.2 Transport Layer Security Protection of Messages..... | 15 | +| 6.1.7.3 Authorization of 5G-EIR NF Service Access..... | 15 | +| 6.1.8 HTTP redirection..... | 16 | +| A.1 General ..... | 16 | + +A.2 N5g-eir\_EquipmentIdentityCheck Service API..... 16 + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document describes the stage 3 protocol and data model for the N5g-eir Service Based Interface between the 5G-EIR and its consumers over which the service to check the equipment identity as described in 3GPP TS 23.501 [2] is performed. It provides the stage 3 protocol definitions and message flows, and specifies the API for each service offered by the 5G-EIR. + +The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". +- [7] IETF RFC 7540: "Hypertext Transfer Protocol Version 2 (HTTP/2)". +- [8] OpenAPI Initiative, "OpenAPI 3.0.0 Specification", . +- [9] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [10] IETF RFC 7807: "Problem Details for HTTP APIs". +- [11] 3GPP TS 33.501: "Security Architecture and Procedures for 5G System". +- [12] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [13] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". + +- [14] 3GPP TR 21.900: "Technical Specification Group working methods". +- [15] 3GPP TS 29.524: "5G System; Cause codes mapping between 5GC interfaces; Stage 3". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +**N5g-eir:** Service-based interface exhibited by 5G-EIR + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|--------|--------------------------------| +| 5G-EIR | 5G-Equipment Identity Register | +| EIR | Equipment Identity Register | +| PEI | Permanent Equipment Identifier | + +# --- 4 Overview + +## 4.1 Introduction + +N5g-eir is a Service-based interface exhibited by 5G-EIR (5G-Equipment Identity Register) which is an optional network function that supports the following functionality: + +- Check the status of Equipment's identity (e.g. to check that it has not been blacklisted). + +The reference point N17 (see Fig 4-1 below) shows the interaction between the 5G-Equipment Identity Register 5G-EIR and the AMF (Access and Mobility Management Function) enabling the check of the status of the mobile equipment identity. + +![Diagram showing the interaction between AMF and 5G-EIR via the N17 / N5g-eir interface.](ba9d6e1a75eb6672d04e61a86e1b8a61_img.jpg) + +``` +graph LR; AMF[AMF] --- N17_N5g_eir[N17 / N5g-eir] --- 5G_EIR[5G-EIR]; +``` + +Diagram showing the interaction between AMF and 5G-EIR via the N17 / N5g-eir interface. + +**Figure 4-1: Reference Model – N5g-eir** + +During any procedure establishing a signalling connection with the UE the network may optionally perform an ME identity check with 5G-EIR via the N5g-eir\_Equipment Identity Check Service exhibited by 5G-EIR. + +# 5 Services offered by the 5G-EIR NF + +## 5.1 Introduction + +The following NF service is offered by the N5g-eir to check the ME whether it is black-listed or not: + +- N5g-eir\_EquipmentIdentityCheck + +**Table 5.1-1: NF Services provided by 5G-EIR** + +| Service Name | Description | Consumer | +|--------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|----------| +| N5g-eir_EquipmentIdentityCheck | This service offered by the 5G-EIR allows the consumer to check the Permanent Equipment Identifier (PEI) and check whether the PEI is in the black list or not. | AMF | + +The N5g-eir\_Equipment Identity Check service is specified in 3GPP TS 23.502 [3], clause 4.2.2.2.2 + +Table 5.1-2 summarizes the corresponding APIs defined for this specification. + +**Table 5.1-2: API Descriptions** + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex | +|--------------------------------|--------|-----------------------------------------|---------------------------------------------|-------------|-------| +| N5g-eir_EquipmentIdentityCheck | 6.1 | 5G-EIR Equipment Identity Check Service | TS29511_N5g-eir_EquipmentIdentityCheck.yaml | n5g-eir-eic | A.2 | + +The N5g-eir\_Equipment Identity Check service is specified in 3GPP TS 23.502 [3], clause 4.2.2.2.2 + +## 5.2 N5g-eir\_EquipmentIdentityCheck Service + +### 5.2.1 Service Description + +The N5g-eir\_Equipment Identity Check service is provided by the 5G-EIR to check the Permanent Equipment Identifier (PEI) whether it is in the black list or not. The service can be consumed by AMF which initiates ME identity check by invoking the N5g-eirEquipmentIdentityCheckGet service operation (see clause 5.2.4.2. of 3GPP TS 23.502 [3]). + +During the initial registration the Permanent Equipment Identifier is obtained from the UE. The AMF operator may check the PEI with an EIR. + +### 5.2.2 Service Operations + +#### 5.2.2.1 Introduction + +#### 5.2.2.2 CheckEquipmentIdentity + +##### 5.2.2.2.1 General + +The CheckEquipmentIdentity operation shall be used to check the PEI and determine whether the subscriber is allowed to use the equipment, in the following procedures: + +- ME Identity check procedure (see clause 4.7 of 3GPP TS 23.502 [3]); + +##### 5.2.2.2.2 Procedure using CheckEquipmentIdentity Operation + +The NF Service Consumer (e.g. AMF) shall check the PEI by using the HTTP GET method as shown in Figure 5.2.2.2.2-1. + +![Sequence diagram showing the PEI status check procedure. An NF service consumer sends a GET request to 5G-EIR. 5G-EIR responds with either a 200 OK (EirResponseData) or a 4xx/5xx (ProblemDetails) or 3xx response.](0bf9346902e9a3bdabf05ceacc1947f5_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant 5G-EIR + Note left of NF service consumer: 1. GET .../equipment-status?pei={pei}&supi={supi}&gpsi={gpsi} + NF service consumer->>5G-EIR: Request + Note right of 5G-EIR: 2a. 200 OK (EirResponseData) or 2b. 4xx/5xx (ProblemDetails) or 3xx + 5G-EIR-->>NF service consumer: Response + +``` + +Sequence diagram showing the PEI status check procedure. An NF service consumer sends a GET request to 5G-EIR. 5G-EIR responds with either a 200 OK (EirResponseData) or a 4xx/5xx (ProblemDetails) or 3xx response. + +**Figure 5.2.2.2.2-1: PEI status check by the NF Service Consumer** + +1. The NF Service Consumer (e.g. AMF) sends a GET request to the resource representing the PEI equipment Status. It shall include the PEI as a query parameter and, optionally, the SUPI and/or GPSI may also be included. +- 2a. On success, "200 OK" with the message body containing the equipment status of the PEI. +- 2b. If the PEI is not known, "404 Not Found" with the message body containing a ProblemDetails object, with the "details" attribute set to "ERROR\_EQUIPMENT\_UNKNOWN". When receiving the response from the 5G-EIR, the NF Service Consumer (e.g. AMF) shall check the equipment Status and the detailed problem. Dependent upon the result, the NF Service Consumer will decide its subsequent actions (e.g. sending a Registration Reject if the 5G-EIR indicates that the PEI is unknown or blacklisted). + +The definition of the equipment-status resource is specified in clause 6.1.3. + +# 6 API Definitions + +## 6.1 N5g-eir\_EquipmentIdentityCheck Service API + +### 6.1.1 API URI + +URIs of this API shall have the following root: + +{apiRoot}/{apiName}/{apiVersion}/ + +where "apiRoot" is defined in clause 4.4.1 of 3GPP TS 29.501 [5], the "apiName" shall be set to "n5g-eir-eic" and the "apiVersion" shall be set to "v1" for the current version of this specification. + +### 6.1.2 Usage of HTTP + +#### 6.1.2.1 General + +HTTP/2, as defined in IETF RFC 7540 [7], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +HTTP messages and bodies for the N5g-eir\_EquipmentIdentityCheck Service shall comply with the OpenAPI [8] specification contained in Annex A. + +#### 6.1.2.2 HTTP standard headers + +##### 6.1.2.2.1 General + +The usage of HTTP standard headers shall be supported as specified in clause 5.2.2 of 3GPP TS 29.500 [4]. + +##### 6.1.2.2.2 Content type + +The following content types shall be supported: + +- JSON, as defined in IETF RFC 8259 [9]. The use of the JSON format shall be signalled by the content type "application/json". See also clause 5.4 of 3GPP TS 29.500 [4]. +- The Problem Details JSON Object (IETF RFC 7807 [10]). The use of the Problem Details JSON object in a HTTP response body shall be signalled by the content type "application/problem+json". + +#### 6.1.2.3 HTTP custom headers + +##### 6.1.2.3.1 General + +In this release of this specification, no custom headers specific to the N5g-eir\_EquipmentIdentityCheck Service are defined. For 3GPP specific HTTP custom headers used across all service based interfaces, see clause 5.2.3 of 3GPP TS 29.500 [4]. + +### 6.1.3 Resources + +#### 6.1.3.1 Overview + +![Diagram showing the resource URI structure of the n5g-eir-eic API. The base URI is //{apiRoot}/n5g-eir-eic/v1. A line branches from the base URI to a rounded rectangle containing the resource path /equipment-status.](7f01b16d5b24d18555e9af849c410fbc_img.jpg) + +``` +graph TD; Base[" //{apiRoot}/n5g-eir-eic/v1"] --> Resource["/equipment-status"]; +``` + +Diagram showing the resource URI structure of the n5g-eir-eic API. The base URI is //{apiRoot}/n5g-eir-eic/v1. A line branches from the base URI to a rounded rectangle containing the resource path /equipment-status. + +**Figure 6.1.3.1-1: Resource URI structure of the n5g-eir-eic API** + +Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.1.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|-----------------|-------------------|---------------------------------|------------------------------------------| +| equipmentStatus | /equipment-status | GET | Retrieve the equipment status of the PEI | + +#### 6.1.3.2 Resource: equipmentStatus + +##### 6.1.3.2.1 Description + +This resource represents the equipmentStatus for a PEI. + +##### 6.1.3.2.2 Resource Definition + +Resource URI: {apiRoot}/n5g-eir-eic/v1/equipment-status + +This resource shall support the resource URI variables defined in table 6.1.3.2.2-1. + +**Table 6.1.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 6.1.1 | + +##### 6.1.3.2.3 Resource Standard Methods + +###### 6.1.3.2.3.1 GET + +This method shall support the URI query parameters specified in table 6.1.3.2.3.1-1. + +**Table 6.1.3.2.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------| +| pei | Pei | M | 1 | The PEI of the UE shall be included for equipment identify checking | +| supi | Supi | O | 0..1 | The SUPI of the UE | +| gpsi | Gpsi | O | 0..1 | The GPSI of the UE | +| supported-features | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.6 is supported. | + +This method shall support the request data structures specified in table 6.1.3.2.3.1-2 and the response data structures and response codes specified in table 6.1.3.2.3.1-3. + +**Table 6.1.3.2.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.2.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| EirResponseData | M | 1 | 200 OK | Upon success, a response body containing the Equipment Status shall be returned | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if this is a redirection triggered by an SCP to the same target resource via another SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same 5G-EIR or 5G-EIR (service) set. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if this is a redirection triggered by an SCP to the same target resource via another SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same 5G-EIR or 5G-EIR (service) set. (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | The equipment identify checking has failed.
The "cause" attribute may be used to indicate one of the following application errors:
- ERROR_EQUIPMENT_UNKNOWN
See table 6.1.5.3-1 for the description of this error. | + +NOTE 1: The mandatory HTTP error status codes for the GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type when needed (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponses may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.2.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same 5G-EIR or 5G-EIR (service) set.
Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.2.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same 5G-EIR or 5G-EIR (service) set.
Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +### 6.1.4 Data Model + +#### 6.1.4.1 General + +This clause specifies the application data model supported by the API. + +Table 6.1.4.1-1 specifies the data types defined for the n5g-eir-eic service based interface protocol. + +**Table 6.1.4.1-1: n5g-eir-eic specific Data Types** + +| Data type | Clause defined | Description | +|-----------------|----------------|--------------------------------------------------------| +| EirResponseData | 6.1.4.2.2 | | +| EquipmentStatus | 6.1.4.3.3 | Equipment status of the PEI, this data type is string. | + +Table 6.1.6.1-2 specifies data types re-used by the NNF service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the NNF service based interface. + +**Table 6.1.4.1-2: 5g-eir-eic re-used Data Types** + +| Data type | Reference | Comments | +|-------------------|--------------------|---------------------------------------------------------------------------------------------------------------| +| Pei | 3GPP TS 29.571[6] | Data type representing the PEI of the UE. | +| Supi | 3GPP TS 29.571 [6] | Data type representing the SUPI of the subscriber.
pattern: See pattern of type Supi in 3GPP TS 29.571 [6] | +| ProblemDetails | 3GPP TS 29.571 [6] | Common data type for error responses | +| Gpsi | 3GPP TS 29.571 [6] | Data type representing the GPSI of the subscriber. | +| SupportedFeatures | 3GPP TS 29.571 [6] | Supported Features | +| RedirectResponse | 3GPP TS 29.571 [6] | Response body of the redirect response message. | + +#### 6.1.4.2 Structured data types + +##### 6.1.4.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.1.4.2.2 Type: EirResponseData + +**Table 6.1.4.2.2-1: Definition of type EirResponseData** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------|---|-------------|------------------| +| status | EquipmentStatus | M | 1 | Status of the UE | + +#### 6.1.4.3 Simple data types and enumerations + +##### 6.1.4.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 6.1.4.3.2 Simple data types + +The simple data types defined in table 6.1.4.3.2-1 shall be supported. + +**Table 6.1.4.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | +|-----------|---------------------------------------------------------------------|-------------| +| | | | + +##### 6.1.4.3.3 Enumeration: EquipmentStatus + +**Table 6.1.4.3.3-1: Enumeration EquipStatus** + +| Enumeration value | Description | +|-------------------|----------------------------------| +| "WHITELISTED" | Indicates the PEI is whitelisted | +| "BLACKLISTED" | Indicates the PEI is blacklisted | +| "GREYLISTED" | Indicates the PEI is greylisted | + +### 6.1.5 Error Handling + +#### 6.1.5.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +The Cause codes mapping performed by AMF between the following HTTP responses returned by the EIR services to the AMF and the 5GMM related values is specified in clause 4.5.2 of 3GPP TS 29.524 [15]. + +#### 6.1.5.2 Protocol Errors + +Protocol Error Handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +#### 6.1.5.3 Application Errors + +The common application errors defined in the Table 5.2.7.2-1 in 3GPP TS 29.500 [4] may also be used for the N5g-eir\_EquipmentIdentityCheck service, and the following application errors listed in Table 6.1.5.3-1 are specific for the N5g-eir\_EquipmentIdentityCheck service. + +**Table 6.1.5.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------------|------------------|--------------------------------------------------------| +| ERROR_EQUIPMENT_UNKNOWN | 404 Not Found | Indicate the mobile equipment is not known in the EIR. | + +### 6.1.6 Feature Negotiation + +The optional features in table 6.1.6-1 are defined for the N5g-eir\_EquipmentIdentityCheck API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.1.6-1: Supported Features** + +| Feature number | Feature Name | M/O | Description | +|----------------|--------------|-----|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | ES3XX | M |

Extended Support of HTTP 307/308 redirection

An NF Service Consumer (e.g. AMF) that supports this feature shall support handling of HTTP 307/308 redirection for any service operation of the EquipmentIdentityCheck service. An NF Service Consumer that does not support this feature does only support HTTP redirection as specified for 3GPP Release 15.

| + +### 6.1.7 Security + +#### 6.1.7.1 General + +The security mechanisms for service based interfaces are specified in clause 13 of 3GPP TS 33.501 [11] and in clause 6.7.3 of 3GPP TS 29.500 [4]. The access to the N5g-eir\_EquipmentIdentityCheck API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [12]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [13]) plays the role of the authorization server. + +The N5g-eir\_EquipmentIdentityCheck API defines scopes for OAuth2 authorization as specified in 3GPP TS 33.501 [11]; it defines a single scope consisting on the name of the service (i.e., "n5g-eir-eic"), and it does not define any additional scopes at resource or operation level. + +Security Protection Edge Proxy (SEPP), as specified in 3GPP TS 33.501 [11], shall be used between service based interfaces across PLMNs. The NFs in a PLMN shall use the SEPP as a HTTP/2 proxy for the HTTP/2 messages that carry ":authority" pseudo header with a uri-host formatted as specified in clause 6.1.4.3 of 3GPP TS 29.500 [4] + +#### 6.1.7.2 Transport Layer Security Protection of Messages + +As specified in clause 13.1 of 3GPP TS 33.501 [11], TLS shall be used for the security protection of messages at the transport layer for the N5g-eir service based interface if network security is not provided by other means. + +The protocol stack for the N5g-eir service based interface is shown on Figure 6.1.7.2-1. + +![Figure 6.1.7.2-1: SBI Protocol Stack diagram showing a vertical stack of layers: Application, HTTP/2, TLS, TCP, IP, and L2.](3f1987804d7d78bc3b3bc560e974280a_img.jpg) + +| | +|-------------| +| Application | +| HTTP/2 | +| TLS | +| TCP | +| IP | +| L2 | + +Figure 6.1.7.2-1: SBI Protocol Stack diagram showing a vertical stack of layers: Application, HTTP/2, TLS, TCP, IP, and L2. + +Figure 6.1.7.2-1: SBI Protocol Stack + +The N5g-eir service based interface uses HTTP/2 protocol (see clause 5.2) with JSON (see clause 5.4) as the application layer serialization protocol. For the security protection at the transport layer, 5G-EIR NF shall support TLS and TLS shall be used within a PLMN if network security is not provided by other means, as specified in 3GPP TS 33.501 [11]. + +#### 6.1.7.3 Authorization of 5G-EIR NF Service Access + +As specified in clause 13.4.1 of 3GPP TS 33.501 [11] OAuth 2.0 (see IETF RFC 6749 [12]) may be used for authorization of N5g-eir\_EquipmentIdentityCheck service access. The 5G-EIR NF and the NRF (as defined in 3GPP TS 29.510 [13]) shall support the OAuth 2.0 authorization framework with "Client Credentials" grant type as specified in clause 4.4 of IETF RFC 6749 [12]. The NRF shall act as the Authorization Server providing the access tokens to the NF service consumers to access the service provided by the 5G-EIR. If the 5G-EIR NF receives an OAuth 2.0 authorization token in the "Authorization" HTTP request header field, the N5g-eir\_EquipmentIdentityCheck service shall validate the access token, its expiry and its access scope before allowing access to the requested resource, as specified in clause 7 of IETF RFC 6749 [12]. + +### 6.1.8 HTTP redirection + +An HTTP request may be redirected to a different 5G-EIR service instance, within the same 5G-EIR or a different 5G-EIR of an 5G-EIR set, e.g. when an 5G-EIR service instance is part of an 5G-EIR (service) set or when using indirect communications (see 3GPP TS 29.500 [4]). See also the ES3XX feature in clause 6.1.6. + +An SCP that reselects a different 5G-EIR producer instance will return the NF Instance ID of the new 5G-EIR producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an 5G-EIR within an 5G-EIR set redirects a service request to a different 5G-EIR of the set using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new 5G-EIR towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +# --- Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex specifies the formal definition of the N5g-eir\_EquipmentIdentityCheck Service API. It consists of an OpenAPI 3.0.0 specification, in YAML format. + +This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository that uses the GitLab software version control system (see 3GPP TS 29.501 [5] clause 5.3.1 and 3GPP TR 21.900 [14] clause 5B). + +## A.2 N5g-eir\_EquipmentIdentityCheck Service API + +``` +openapi: 3.0.0 + +info: + version: '1.1.2' + title: '5G-EIR Equipment Identity Check' + + description: | + 5G-EIR Equipment Identity Check Service. + © 2021, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.511 V16.5.0; 5G System; Equipment Identity Register Services; Stage 3 + url: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.511/' + +servers: + - url: '{apiRoot}/n5g-eir-eic/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} +``` + +``` +- oAuth2ClientCredentials: + - n5g-eir-eic + +paths: + /equipment-status: + get: + summary: Retrieves the status of the UE + operationId: GetEquipmentStatus + tags: + - Equipment Status (Document) + parameters: + - name: pei + in: query + description: PEI of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' + - name: supi + in: query + description: SUPI of the UE + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: gpsi + in: query + description: GPSI of the UE + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + - name: supported-features + in: query + description: supported features of the NF consumer + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/EirResponseData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '404': + description: PEI Not Found + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + n5g-eir-eic: Access to the N5g-eir_EquipmentIdentityCheck API + schemas: + EirResponseData: + type: object +``` + +``` +required: + - status +properties: + status: + $ref: '#/components/schemas/EquipmentStatus' +EquipmentStatus: + type: string + enum: + - WHITELISTED + - BLACKLISTED + - GREYLISTED +``` + +# Annex B (informative): Change history + +| Change history | | | | | | | | | +|----------------|---------|-----------|-------|-----|-----|----------------------------------------------------------------------------------|-------------|--| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | | +| 2017-10 | CT4#80 | C4-175323 | | | | Initial Draft. | 0.1.0 | | +| 2017-10 | CT4#80 | C4-175396 | | | | At CT4#80 approved pCRs C4-175323, C4-175324, C4-175325, C4-175326 incorporated. | 0.2.0 | | +| 2017-12 | CT4#81 | C4-176439 | | | | At CT4#81 approved pCRs C4-176428, C4-176429 incorporated | 0.3.0 | | +| 2018-03 | CT4#83 | C4-182436 | | | | At CT4#83 approved pCRs C4-182368, C4-182369, C4-182384 incorporated. | 0.4.0 | | +| 2018-03 | CT#79 | CP-180032 | | | | Presented for information | 1.0.0 | | +| 2018-05 | CT4#85 | C4-184627 | | | | At CT4#85 approved pCRs C4-184475, C4-184476, C4-184628 incorporated. | 1.1.0 | | +| 2018-06 | CT#80 | CP-181106 | | | | Presented for approval | 2.0.0 | | +| 2018-06 | CT#80 | | | | | Approved in CT#80. | 15.0.0 | | +| 2018-09 | CT#81 | CP-182061 | 0001 | - | F | Error Handling | 15.1.0 | | +| 2018-09 | CT#81 | CP-182061 | 0002 | - | F | Description of Structured data types | 15.1.0 | | +| 2018-09 | CT#81 | CP-182061 | 0003 | - | F | Update of Resource Figure | 15.1.0 | | +| 2018-09 | CT#81 | CP-182061 | 0004 | - | F | API Version Number Update | 15.1.0 | | +| 2018-12 | CT#82 | CP-183178 | 0005 | 2 | F | 5G-EIR OpenAPI Updates | 15.2.0 | | +| 2018-12 | CT#82 | CP-183019 | 0007 | - | F | APIRoot Clarification | 15.2.0 | | +| 2018-12 | CT#82 | CP-183019 | 0008 | - | F | Common Status codes | 15.2.0 | | +| 2018-12 | CT#82 | CP-183019 | 0009 | 1 | F | API Version Update | 15.2.0 | | +| 2018-12 | CT#82 | CP-183198 | 00010 | 1 | F | Correction of "externalDocs" for N5g-eir_EquipmentIdentityCheck Service | 15.2.0 | | +| 2019-03 | CT#83 | CP-190024 | 0012 | 1 | F | GPSI | 15.3.0 | | +| 2019-03 | CT#83 | CP-190024 | 0014 | 1 | F | Reuse of data types in EIR OpenAPI | 15.3.0 | | +| 2019-03 | CT#83 | CP-190024 | 0015 | - | F | API Version Update | 15.3.0 | | +| 2019-06 | CT#84 | CP-191035 | 0017 | 2 | F | Storage of OpenAPI specification files | 15.4.0 | | +| 2019-06 | CT#84 | CP-191035 | 0018 | - | F | Copyright Note in YAML file | 15.4.0 | | +| 2019-06 | CT#84 | CP-191035 | 0019 | - | F | Wrong formatting in OpenAPI annex | 15.4.0 | | +| 2019-06 | CT#84 | CP-191035 | 0020 | - | F | 3GPP TS 29.511 API version update | 15.4.0 | | +| 2019-11 | CT#84 | CP-193036 | 0022 | 1 | F | Add reference to TS 29.524 | 16.0.0 | | +| 2019-12 | CT#84 | CP-193121 | 0024 | - | F | ExternalDocs field and API version change in the OpenAPI | 16.0.0 | | +| 2020-03 | CT#87e | CP-200039 | 0025 | 2 | F | Add Corresponding API descriptions in clause 5.1 | 16.1.0 | | +| 2020-03 | CT#87e | CP-200039 | 0028 | 2 | D | Editorial corrections | 16.1.0 | | +| 2020-03 | CT#87e | CP-200020 | 0029 | 1 | B | Optionality of ProblemDetails | 16.1.0 | | +| 2020-03 | CT#87e | CP-200035 | 0030 | - | B | SUPI pattern | 16.1.0 | | +| 2020-04 | CT#88e | CP-201064 | 0032 | 1 | F | Datatype column in Resource URI variables Table | 16.2.0 | | +| 2020-06 | CT#88e | CP-201034 | 0033 | - | B | Storage of YAML files | 16.2.0 | | +| 2020-06 | CT#88e | CP-201332 | 0034 | 1 | F | API Version and ExternalDoc Version Update | 16.2.0 | | +| 2020-12 | CT#90e | CP-203035 | 0036 | - | F | Storage of YAML files in 3GPP Forge | 16.3.0 | | +| 2021-03 | CT#91e | CP-210037 | 0038 | | F | HTTP 3xx redirection | 16.4.0 | | +| 2021-03 | CT#91e | CP-210054 | 0041 | | F | 29.511 Rel-16 API version and External doc update | 16.4.0 | | +| 2021-06 | CT#92e | CP-210059 | 0043 | 2 | F | Redirect Responses | 16.5.0 | | +| 2021-06 | CT#92e | CP-210073 | 0046 | - | F | 29.511 Rel-16 API version and External doc update | 16.5.0 | | +| 2021-09 | CT#93e | CP-212060 | 0047 | | F | 3xx description correction for SCP | 16.6.0 | | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29517/1b5a812c8aa20fd5cba28e97001d32de_img.jpg b/marked/Rel-16/29_series/29517/1b5a812c8aa20fd5cba28e97001d32de_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e13c97b63fc5b7aa9a6436d06fd7bf3c2dfc1896 --- /dev/null +++ b/marked/Rel-16/29_series/29517/1b5a812c8aa20fd5cba28e97001d32de_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:12fd972029543969ac519b91276051e4fe2ac5413fea64191221e41a67d73f4c +size 32338 diff --git a/marked/Rel-16/29_series/29517/2ba086df3506f81bae3a9b53725dcfea_img.jpg b/marked/Rel-16/29_series/29517/2ba086df3506f81bae3a9b53725dcfea_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..83feb1dfa361b7c78649bcb36ee40e5cd35271db --- /dev/null +++ b/marked/Rel-16/29_series/29517/2ba086df3506f81bae3a9b53725dcfea_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:42fe33bef89e06cda929e0a2b9fc3acda29f7d94722756787e74bca4afe00b03 +size 9644 diff --git a/marked/Rel-16/29_series/29517/33a8f3f01dfa8bce75d23017855a13c5_img.jpg b/marked/Rel-16/29_series/29517/33a8f3f01dfa8bce75d23017855a13c5_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..eaa498416abfd893b671022771ef8bc4fb37be32 --- /dev/null +++ b/marked/Rel-16/29_series/29517/33a8f3f01dfa8bce75d23017855a13c5_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:00949d0cb4b3e716b574d5733f15e18393ba8253cdd723bb120c3c988f8df916 +size 20947 diff --git a/marked/Rel-16/29_series/29517/5a24ac755b962fd5f0183f13de0726de_img.jpg b/marked/Rel-16/29_series/29517/5a24ac755b962fd5f0183f13de0726de_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ebd7ca289a75cfd5d4993d5625233fa3681eb75e --- /dev/null +++ b/marked/Rel-16/29_series/29517/5a24ac755b962fd5f0183f13de0726de_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f0d77c9df3c018750706c7680536a8d6aebd51e8d85aef198e188f536fdd3c9f +size 9657 diff --git a/marked/Rel-16/29_series/29517/5e92d9e8e9ce204e405bff2367f88176_img.jpg b/marked/Rel-16/29_series/29517/5e92d9e8e9ce204e405bff2367f88176_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..57edc432992e64a4b493fe0d7d70166fa11d49b6 --- /dev/null +++ b/marked/Rel-16/29_series/29517/5e92d9e8e9ce204e405bff2367f88176_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:561fcc734faab3871f7068684c5c2e850fb947db72874272e9585204c053dd81 +size 29100 diff --git a/marked/Rel-16/29_series/29517/7efae06af3af43ffe5d4b956a679cf54_img.jpg b/marked/Rel-16/29_series/29517/7efae06af3af43ffe5d4b956a679cf54_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..09d971ca32a52221f120a0b7368420483998625d --- /dev/null +++ b/marked/Rel-16/29_series/29517/7efae06af3af43ffe5d4b956a679cf54_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:77959e0aee6796a5d2cd949c56a8a6d78a3b7095e9f1863b3eea21ea47fe892b +size 30638 diff --git a/marked/Rel-16/29_series/29517/ff0952ef692c9d960ce5f6708bcc9711_img.jpg b/marked/Rel-16/29_series/29517/ff0952ef692c9d960ce5f6708bcc9711_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..406271671edbabe5045b0dd7d6c5ec22da1ad2c0 --- /dev/null +++ b/marked/Rel-16/29_series/29517/ff0952ef692c9d960ce5f6708bcc9711_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3d40db9372181233e32693022f6008733ef3451e07e714ca29ff825eedfd41e8 +size 31647 diff --git a/marked/Rel-16/29_series/29517/raw.md b/marked/Rel-16/29_series/29517/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..3cf8ad9485de09fa238e65065ae172e7e2850f30 --- /dev/null +++ b/marked/Rel-16/29_series/29517/raw.md @@ -0,0 +1,1849 @@ + + + + +# ***Copyright Notification*** + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2021, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTSTM is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|-----------------------------------------------------------------|----| +| Contents..... | 3 | +| Foreword ..... | 5 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions of terms, symbols and abbreviations..... | 8 | +| 3.1 Terms..... | 8 | +| 3.2 Symbols..... | 8 | +| 3.3 Abbreviations ..... | 8 | +| 4 Naf_EventExposure Service ..... | 9 | +| 4.1 Service Description ..... | 9 | +| 4.1.1 Overview ..... | 9 | +| 4.1.2 Service Architecture ..... | 9 | +| 4.1.3 Network Functions ..... | 10 | +| 4.1.3.1 Application Function (AF)..... | 10 | +| 4.1.3.2 NF Service Consumers ..... | 10 | +| 4.2 Service Operations ..... | 10 | +| 4.2.1 Introduction ..... | 10 | +| 4.2.2 Naf_EventExposure_Subscribe service operation..... | 11 | +| 4.2.2.1 General..... | 11 | +| 4.2.2.2 Creating a new subscription..... | 11 | +| 4.2.2.3 Modifying an existing subscription ..... | 13 | +| 4.2.3 Naf_EventExposure_Unsubscribe service operation ..... | 14 | +| 4.2.3.1 General..... | 14 | +| 4.2.3.2 Unsubscription from event notifications..... | 14 | +| 4.2.4 Naf_EventExposure_Notify service operation..... | 15 | +| 4.2.4.1 General..... | 15 | +| 4.2.4.2 Notification about subscribed events ..... | 15 | +| 5 Naf_EventExposure Service API..... | 16 | +| 5.1 Introduction ..... | 16 | +| 5.2 Usage of HTTP..... | 16 | +| 5.2.1 General ..... | 16 | +| 5.2.2 HTTP standard headers ..... | 16 | +| 5.2.2.1 General..... | 16 | +| 5.2.2.2 Content type ..... | 17 | +| 5.2.3 HTTP custom headers ..... | 17 | +| 5.2.3.1 General..... | 17 | +| 5.3 Resources ..... | 17 | +| 5.3.1 Resource Structure..... | 17 | +| 5.3.2 Resource: Application Event Subscriptions ..... | 18 | +| 5.3.2.1 Description..... | 18 | +| 5.3.2.2 Resource definition..... | 18 | +| 5.3.2.3 Resource Standard Methods ..... | 18 | +| 5.3.2.3.1 POST ..... | 18 | +| 5.3.3 Resource: Individual Application Event Subscription ..... | 19 | +| 5.3.3.1 Description..... | 19 | +| 5.3.3.2 Resource definition..... | 19 | +| 5.3.3.3 Resource Standard Methods ..... | 19 | +| 5.3.3.3.1 GET ..... | 19 | +| 5.3.3.3.2 PUT ..... | 20 | +| 5.3.3.3.3 DELETE..... | 21 | +| 5.4 Custom Operations without associated resources ..... | 22 | +| 5.5 Notifications ..... | 22 | +| 5.5.1 General ..... | 22 | +| 5.5.2 Application Event Notification..... | 22 | +| 5.5.2.1 Description..... | 22 | + +- 5.5.2.2 Target URI ..... 22 +- 5.5.2.3 Standard Methods ..... 22 +- 5.5.2.3.1 POST ..... 22 +- 5.6 Data Model..... 23 + - 5.6.1 General ..... 23 + - 5.6.2 Structured data types ..... 24 + - 5.6.2.1 Introduction..... 24 + - 5.6.2.2 Type AfEventExposureSubsc ..... 25 + - 5.6.2.3 Type AfEventExposureNotif ..... 25 + - 5.6.2.4 Type EventsSubs..... 25 + - 5.6.2.5 Type EventFilter ..... 26 + - 5.6.2.6 Type AfEventNotification ..... 27 + - 5.6.2.7 Type ServiceExperienceInfoPerApp ..... 27 + - 5.6.2.8 Type ServiceExperienceInfoPerFlow ..... 28 + - 5.6.2.9 Type SvcExperience ..... 28 + - 5.6.2.10 Type UeMobilityCollection..... 28 + - 5.6.2.11 Type UeCommunicationCollection ..... 28 + - 5.6.2.12 Type UeTrajectoryCollection ..... 29 + - 5.6.2.13 Type CommunicationCollection..... 29 + - 5.6.2.14 Type ExceptionInfo ..... 29 + - 5.6.3 Simple data types and enumerations ..... 29 + - 5.6.3.1 Introduction..... 29 + - 5.6.3.2 Simple data types..... 29 + - 5.6.3.3 Enumeration: AfEvent ..... 30 +- 5.7 Error handling ..... 30 + - 5.7.1 General ..... 30 + - 5.7.2 Protocol Errors..... 30 + - 5.7.3 Application Errors ..... 30 +- 5.8 Feature negotiation..... 30 +- 5.9 Security..... 31 + +**Annex A (normative): OpenAPI specification..... 32** + +- A.1 General..... 32 +- A.2 Naf\_EventExposure API..... 32 + +Annex B (informative): Change history..... 40 + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, certain modal verbs have the following meanings: + +**shall** indicates a mandatory requirement to do something + +**shall not** indicates an interdiction (prohibition) to do something + +NOTE 1: The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +NOTE 2: The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +**should** indicates a recommendation to do something + +**should not** indicates a recommendation not to do something + +**may** indicates permission to do something + +**need not** indicates permission not to do something + +NOTE 3: The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +**can** indicates that something is possible + +**cannot** indicates that something is impossible + +NOTE 4: The constructions "can" and "cannot" shall not to be used as substitutes for "may" and "need Not". + +**will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document + +**will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document + +**might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +NOTE 5: The constructions "is" and "is not" do not indicate requirements. + +# 1 Scope + +The present document specifies the stage 3 protocol and data model for the Application Function Event Exposure Service of the 5G System. It provides stage 3 protocol definitions, message flows and specifies the API for the Naf\_EventExposure service. + +The 5G System stage 2 architecture and the procedures are specified in 3GPP TS 23.501 [2], 3GPP TS 23.502 [3], and 3GPP TS 23.288 [4]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [5] and 3GPP TS 29.501 [6]. + +The Application Function Event Exposure Service is provided by the Application Function (AF). This service exposes service experience events observed at the AF. + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 23.288: "Architecture enhancements for 5G System (5GS) to support network data analytics services". +- [5] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [6] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [7] IETF RFC 7540: "Hypertext Transfer Protocol Version 2 (HTTP/2)". +- [8] OpenAPI: "OpenAPI 3.0.0 Specification", . +- [9] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [10] IETF RFC 7807: "Problem Details for HTTP APIs". +- [11] 3GPP TR 21.900: "Technical Specification Group working methods". +- [12] 3GPP TS 29.523: "5G System; Policy Control Event Exposure Service; Stage 3". +- [13] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces Stage 3". +- [14] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [15] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [16] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". +- [17] 3GPP TS 29.122: "T8 reference point for northbound Application Programming Interfaces (APIs)". + +- [18] 3GPP TS 29.514: "5G System; Policy Authorization Service; Stage 3". +- [19] 3GPP TS 29.520: "5G System; Network Data Analytics Services; Stage 3". +- [20] IETF RFC 5246, "The Transport Layer Security (TLS) Protocol Version 1.2". +- [21] IETF RFC 7230: "Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing". +- [22] IETF RFC 7231: "Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content". +- [23] IETF RFC 7232: "Hypertext Transfer Protocol (HTTP/1.1): Conditional Requests". +- [24] IETF RFC 7233: "Hypertext Transfer Protocol (HTTP/1.1): Range Requests". +- [25] IETF RFC 7234: "Hypertext Transfer Protocol (HTTP/1.1): Caching". +- [26] IETF RFC 7235: "Hypertext Transfer Protocol (HTTP/1.1): Authentication". +- [27] 3GPP TS 29.503: "5G System; Unified Data Management Services; Stage 3". + +# --- 3 Definitions of terms, symbols and abbreviations + +## 3.1 Terms + +For the purposes of the present document, the terms given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +(None) + +## 3.2 Symbols + +For the purposes of the present document, the following symbols apply: + +(None) + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|-------|----------------------------------------| +| AF | Application Function | +| DNAI | DN Access Identifier | +| GPSI | Generic Public Subscription Identifier | +| NEF | Network Exposure Function | +| NF | Network Function | +| NWDAF | Network Data Analytics Function | +| SUPI | Subscription Permanent Identifier | +| URI | Uniform Resource Identifier | + +# --- 4 Naf\_EventExposure Service + +## 4.1 Service Description + +### 4.1.1 Overview + +The Application Function Exposure Service, as defined in 3GPP TS 23.502 [3] and 3GPP TS 23.288 [4], is provided by the Application Function (AF). + +This service: + +- allows NF service consumers to subscribe, modify and unsubscribe for application events; and +- notifies NF service consumers with a corresponding subscription about observed events on the AF. + +The types of observed events include: + +- Service Experience information for an application; +- UE mobility information; +- UE communication information; and +- Exceptions information. + +When the event to which the NF service consumer has subscribed occurs, the AF reports the requested information to the NF service consumer based on the event reporting information definition requested by the NF service consumer (see 3GPP TS 23.502 [3]). + +### 4.1.2 Service Architecture + +The Data Analytics Architecture is defined in 3GPP TS 23.288 [4]. + +The Application Function Exposure Service (Naf\_EventExposure) is part of the Naf service-based interface exhibited by the Application Function (AF). + +The known NF service consumers of the Naf\_EventExposure service are the Network Exposure Function (NEF) and the Network Data Analytics Function (NWDAF). + +The Naf\_EventExposure service is provided by the AF and consumed by NF service consumers (e.g. NEF, NWDAF), as shown in figure 4.1.2-1 for the SBI representation model and in figure 4.1.2-2 for reference point representation model. + +![Figure 4.1.2-1: Naf_EventExposure service Architecture, SBI representation. The diagram shows an Application Function (AF) box containing a circle labeled 'Naf'. A vertical line labeled 'Naf_EventExposure' extends from the 'Naf' circle down to a horizontal line. From this horizontal line, two vertical lines branch out downwards to two separate boxes labeled 'NWDAF' and 'NEF'.](2ba086df3506f81bae3a9b53725dcfea_img.jpg) + +``` +graph TD; subgraph AF [AF]; Naf((Naf)); end; Naf -- "Naf_EventExposure" --> SBI[Service Based Interface]; SBI --- NWDAF[NWDAF]; SBI --- NEF[NEF]; +``` + +Figure 4.1.2-1: Naf\_EventExposure service Architecture, SBI representation. The diagram shows an Application Function (AF) box containing a circle labeled 'Naf'. A vertical line labeled 'Naf\_EventExposure' extends from the 'Naf' circle down to a horizontal line. From this horizontal line, two vertical lines branch out downwards to two separate boxes labeled 'NWDAF' and 'NEF'. + +Figure 4.1.2-1: Naf\_EventExposure service Architecture, SBI representation + +![Figure 4.1.2-2: Naf_EventExposure service Architecture, reference point representation. The diagram shows an AF box at the top. Two diagonal lines branch out from the bottom of the AF box to two boxes below: NWDAF on the left and NEF on the right. Each diagonal line has a small horizontal tick mark near the bottom box.](5a24ac755b962fd5f0183f13de0726de_img.jpg) + +``` +graph TD; AF[AF] --> NWDAF[NWDAF]; AF --> NEF[NEF]; +``` + +Figure 4.1.2-2: Naf\_EventExposure service Architecture, reference point representation. The diagram shows an AF box at the top. Two diagonal lines branch out from the bottom of the AF box to two boxes below: NWDAF on the left and NEF on the right. Each diagonal line has a small horizontal tick mark near the bottom box. + +Figure 4.1.2-2: Naf\_EventExposure service Architecture, reference point representation + +### 4.1.3 Network Functions + +#### 4.1.3.1 Application Function (AF) + +The AF is a functional element that provides service or application related information to NF service consumers. + +The AF allows NF service consumers to subscribe to and unsubscribe from periodic notifications and/or notifications related to the detection of subscribed event. + +#### 4.1.3.2 NF Service Consumers + +The Network Data Analytics Function (NWDAF): + +- supports (un)subscribing to notifications of subscribed event(s) from the AF; +- supports receiving the notifications of subscribed event(s) from the AF. + +The Network Exposure Function (NEF): + +- supports (un)subscribing to notifications of service experience information from the AF; +- supports receiving the notifications of subscribed event(s) from the AF. + +## 4.2 Service Operations + +### 4.2.1 Introduction + +Service operations defined for the Naf\_EventExposure Service are shown in table 4.2.1-1. + +**Table 4.2.1-1: Naf\_EventExposure Service Operations** + +| Service Operation Name | Description | Initiated by | +|-------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------| +| Naf_EventExposure_Subscribe | This service operation is used by an NF service consumer to subscribe to, or modify a subscription in the AF for event notifications on a specified application related event for one or more UE(s) or any UE. | NF Consumer (NWDAF, NEF) | +| Naf_EventExposure_Unsubscribe | This service operation is used by an NF service consumer to unsubscribe from event notifications. | NF Consumer (NWDAF, NEF) | +| Naf_EventExposure_Notify | This service operation is used by the AF to report application related event(s) to the NF service consumer which has subscribed to the event report service. | AF | + +### 4.2.2 Naf\_EventExposure\_Subscribe service operation + +#### 4.2.2.1 General + +This service operation is used by an NF service consumer to subscribe for event notifications on specific event(s), or to modify an existing subscription. + +The following are the types of events for which a subscription can be made: + +- Service Experience information for an application; +- UE mobility information; +- UE communication information; and +- Exceptions information. + +The following procedures using the Naf\_EventExposure\_Subscribe service operation are supported: + +- creating a new subscription; + +- modifying an existing subscription. + +#### 4.2.2.2 Creating a new subscription + +Figure 4.2.2.2-1 illustrates the creation of a subscription. + +![Sequence diagram showing the creation of a subscription. An NF service consumer sends a POST request to an AF, and the AF responds with a 201 Created status.](5e92d9e8e9ce204e405bff2367f88176_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant AF + Note right of NF service consumer: 1. POST .../subscriptions + NF service consumer->>AF: Request + Note left of AF: 2. "201 Created" + AF-->>NF service consumer: Response +``` + +Sequence diagram showing the creation of a subscription. An NF service consumer sends a POST request to an AF, and the AF responds with a 201 Created status. + +**Figure 4.2.2.2-1: Creation of a subscription** + +To subscribe to event notifications, the NF service consumer shall send an HTTP POST request to the AF with: "{apiRoot}/naf-eventexposure//subscriptions" as request URI as shown in step 1 of figure 4.2.2.2-1, and the "AfEventExposureSubsc" data structure as request body. + +The "AfEventExposureSubsc" data structure shall include: + +- description of subscribed event information as "eventsSubs" attribute by using one or more "EventsSubs" data; +- description of the event reporting information as "eventsRepInfo" attribute; +- a URI where to receive the requested notifications as "notifUri" attribute; +- a Notification Correlation Identifier assigned by the NF service consumer for the requested notifications as "notifId" attribute. + +The "EventsSubs" data shall include: + +- a event to subscribe as a "event" attribute; and +- event filter information as "eventFilter" attribute associated with the event. + +The "eventsRepInfo" attribute may include: + +- event notification method (periodic, one time, on event detection) as "notifMethod" attribute; +- Maximum Number of Reports as "maxReportNbr" attribute; +- Monitoring Duration as "monDur" attribute; +- repetition period for periodic reporting as "repPeriod" attribute; +- immediate reporting indication as "immRep" attribute; +- sampling ratio as "sampRatio" attribute; and/or +- group reporting guard time as "grpRepTime" attribute. + +The "eventFilter" shall include: + +- identification of target UE(s) to which the subscription applies via : + - 1) identification of individual UE(s) via "gpsi" attribute or "supi" attribute; or + - 2) identification of group(s) of UE(s) via "exterGroupIds" attribute or "interGroupIds" attribute; or + +- 3) identification of any UE via "anyUeInd" attribute. + +Depending on the event type: + +- if the feature "ServiceExperience" is supported and the event is "SVC\_EXPERIENCE", the "eventFilter" attribute may provide: + - 1) identification of application to which the subscription applies via "appIds" attribute; + - 2) an area of interest via "locArea" attribute. +- if the feature "Exceptions" is supported and the event is "EXCEPTIONS", the "eventFilter" attribute may provide: + - 1) identification of application to which the subscription applies via "appIds" attribute; + - 2) an area of interest via "locArea" attribute; +- if the feature "UeCommunication" is supported and the event is "UE\_COMM", the "eventFilter" attribute may provide: + - 1) identification of application to which the subscription applies via "appIds" attribute; + - 2) an area of interest via "locArea" attribute. +- if the feature "UeMobility" is supported and the event is "UE\_MOBILITY", the "eventFilter" attribute may provide: + - 1) identification of application to which the subscription applies via "appIds" attribute; + - 2) an area of interest via "locArea" attribute. + +If the AF cannot successfully fulfil the received HTTP POST request due to an internal error or an error in the HTTP POST request, the AF shall send the HTTP error response as specified in clause 5.7. + +Upon successful reception of the HTTP POST request with "{apiRoot}/naf-eventexposure//subscriptions" as request URI and "AfEventExposureSubsc" data structure as request body, the AF shall create a new "Individual Application Event Subscription" resource, store the subscription and send an HTTP "201 Created" response as shown in step 2 of figure 4.2.2.2-1, containing: + +- a Location header field; and +- an "AfEventExposureSubsc" data type in the payload body. + +The Location header field shall contain the URI of the created individual application session context resource i.e. "{apiRoot}/naf-eventexposure//subscriptions/{subscriptionId}". + +The "AfEventExposureSubsc" data type payload body shall contain the representation of the created "Individual Application Event Subscription". + +When the "monDur" attribute is included in the response by the AF, it represents AF selected expiry time that is equal or less than the expiry time received in the request. + +When the "immRep" attribute is included and sets to "true" in the subscription and the subscribed events are available, the AF shall include the reports of the events subscribed, if available, in the HTTP POST response. + +When the sampling ratio as, "sampRatio" attribute, is included in the subscription, the AF shall select a random subset of UEs among the target UEs according to the sampling ratio and only report the event(s) related to the selected subset of UEs. + +When the group reporting guard time as the "grpRepTime" attribute is included in the subscription, the AF shall accumulate all the event reports for the target UEs until the group reporting guard time expires. Then the AF shall notify the NF service consumer using the Naf\_EventExposure\_Notify service operation, as described in clause 4.2.4.2. + +#### 4.2.2.3 Modifying an existing subscription + +Figure 4.2.2.3-1 illustrates the modification of an existing subscription. + +![Sequence diagram showing the modification of an existing subscription. An NF service consumer sends a PUT request to an AF. The AF responds with either a 200 OK or a 204 No Content.](ff0952ef692c9d960ce5f6708bcc9711_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant AF + Note right of NF service consumer: 1. PUT .../subscriptions/{subscriptionId} + NF service consumer->>AF: 1. PUT .../subscriptions/{subscriptionId} + Note left of AF: 2a. 200 OK +2b. 204 No Content + AF-->>NF service consumer: 2a. 200 OK / 2b. 204 No Content + +``` + +Sequence diagram showing the modification of an existing subscription. An NF service consumer sends a PUT request to an AF. The AF responds with either a 200 OK or a 204 No Content. + +**Figure 4.2.2.3-1: Modification of an existing subscription** + +To modify an existing subscription to event notifications, the NF service consumer shall send an HTTP PUT request with: "{apiRoot}/naf-eventexposure//subscriptions/{subscriptionId}" as request URI, as shown in step 1 of figure 4.2.2.3-1, where "{subscriptionId}" is the subscription correlation ID of the existing subscription. The "AfEventExposureSubsc" data structure is included as request body as described in clause 4.2.2.2. + +NOTE 1: An alternate NF service consumer than the one that requested the generation of the subscription resource can send the PUT request. + +NOTE 2: The "notifiUri" attribute within the AfEventExposureSubsc data structure can be modified to request that subsequent notifications are sent to a new NF service consumer. + +NOTE 3: The "monDur" attribute within the AfEventExposureSubsc data structure can be modified to extend the expiry time to keep receiving notifications. + +If the AF cannot successfully fulfil the received HTTP PUT request due to an internal error or an error in the HTTP PUT request, the AF shall send an HTTP error response as specified in clause 5.7. + +If the feature "ES3XX" is supported, and the AF determines the received HTTP PUT request needs to be redirected, the AF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [5]. + +Upon successful reception of an HTTP PUT request with: "{apiRoot}/naf-eventexposure//subscriptions/{subscriptionId}" as request URI and "AfEventExposureSubsc" data structure as request body, the AF shall update the subscription and send either a HTTP "200 OK" response with the "AfEventExposureSubsc" data structure as response body containing the representation of the modified "Individual Application Event Subscription", or an HTTP "204 No Content" response, as shown in step 2 of figure 4.2.2.3-1. + +When the "monDur" attribute is included in the response by the AF, it represents AF selected expiry time that is equal or less than the expiry time received in the request. + +When the "immRep" attribute is included and sets to "true" in the subscription and the subscribed events are available, the AF shall include the reports of the events subscribed, if available, in the HTTP PUT response. + +When the sampling ratio, as "sampRatio" attribute, is included in the subscription, the AF shall select a random subset of UEs among the target UEs according to the sampling ratio and only report the event(s) related to the selected subset of UEs. + +When the group reporting guard time, as "grpRepTime" attribute, is included in the subscription, the AF shall accumulate all the event reports for the target UEs until the group reporting guard time expires. Then, the AF shall notify the NF service consumer using the Naf\_EventExposure\_Notify service operation, as described in clause 4.2.4.2. + +### 4.2.3 Naf\_EventExposure\_Unsubscribe service operation + +#### 4.2.3.1 General + +This service operation is used by an NF service consumer to unsubscribe from event notifications. + +The following procedure using the Naf\_EventExposure\_Unsubscribe service operation is supported: + +- unsubscription from event notifications. + +#### 4.2.3.2 Unsubscription from event notifications + +Figure 4.2.3.2-1 illustrates the unsubscription from event notifications. + +![Sequence diagram illustrating the unsubscription from event notifications. The NF service consumer sends a DELETE request to the AF, and the AF responds with a 204 No Content.](1b5a812c8aa20fd5cba28e97001d32de_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant AF + Note right of NF service consumer: 1. DELETE .../subscriptions/{subscriptionId} + NF service consumer->>AF: Request + Note left of AF: 2. "204 No Content" + AF-->>NF service consumer: Response +``` + +Sequence diagram illustrating the unsubscription from event notifications. The NF service consumer sends a DELETE request to the AF, and the AF responds with a 204 No Content. + +**Figure 4.2.3.2-1: Unsubscription from event notifications** + +To unsubscribe from event notifications, the NF service consumer shall send an HTTP DELETE request with "{apiRoot}/naf-eventexposure//subscriptions/{subscriptionId}" as request URI, as shown in step 1 of figure 4.2.3.2-1, where "{subscriptionId}" is the subscription correlation identifier of the existing resource subscription that is to be deleted. + +If the AF cannot successfully fulfil the received HTTP DELETE request due to an internal error or an error in the HTTP DELETE request, the AF shall send an HTTP error response as specified in clause 5.7. + +If the feature "ES3XX" is supported, and the AF determines the received HTTP DELETE request needs to be redirected, the AF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [5]. + +Upon successful reception of the HTTP DELETE request with: "{apiRoot}/naf-eventexposure//subscriptions/{subscriptionId}" as request URI, the AF shall remove the corresponding subscription and send an HTTP "204 No Content" response as shown in step 2 of figure 4.2.3.2-1. + +### 4.2.4 Naf\_EventExposure\_Notify service operation + +#### 4.2.4.1 General + +The Naf\_EventExposure\_Notify service operation enables the AF to notify to the NF service consumer(s) that the previously subscribed application related event occurred. + +The following procedure using the Naf\_EventExposure\_Notify service operation is supported: + +- notification about subscribed events. + +#### 4.2.4.2 Notification about subscribed events + +Figure 4.2.4.2-1 illustrates the notification about subscribed events. + +![Sequence diagram showing notification from AF to NF service consumer. Step 1: AF sends a POST {notifUri} request to the NF service consumer. Step 2: The NF service consumer responds with a 204 No Content status.](7efae06af3af43ffe5d4b956a679cf54_img.jpg) + +``` + +sequenceDiagram + participant AF + participant NF as NF service consumer + Note right of AF: 1. POST {notifUri} + AF->>NF: Request + Note right of NF: 2. "204 No Content" + NF-->>AF: Response + +``` + +Sequence diagram showing notification from AF to NF service consumer. Step 1: AF sends a POST {notifUri} request to the NF service consumer. Step 2: The NF service consumer responds with a 204 No Content status. + +**Figure 4.2.4.2-1: Notification about subscribed events** + +If the AF observes application related event(s) for which an NF service consumer has subscribed, the AF shall send an HTTP POST request as shown in step 1 of figure 4.2.4.2-1, with the "{notifUri}" as request URI containing the value previously provided by the NF service consumer within the corresponding subscription, and the "AfEventExposureNotif" data structure. + +The "AfEventExposureNotif" data structure shall include: + +- a) the notification correlation ID provided by the NF service consumer during the subscription as "notifId" attribute; and +- b) information about the observed event(s) within the "eventNotifs" attribute that shall contain for each observed event an "AfEventNotification" data structure that shall include: + - 1) the application related event as "event" attribute; + - 2) the time at which the event was observed encoded as "timeStamp" attribute; + - 3) if the "event" attribute is "SVC\_EXPERIENCE": + - service experience information about the application involved in the reported event in the "svcExprcInfos" attribute; + - 4) if the "event" attribute is "UE\_MOBILITY": + - UE mobility information associated with the application as "ueMobilityInfos" attribute; + - 5) if the "event" attribute is "UE\_COMM": + - application communication information associated with the application as "ueCommInfos" attribute; and + - 6) if the "event" attribute is "EXCEPTIONS": + - exceptions information associated with a service flow as "excepInfos" attribute. + +If the NF service consumer cannot successfully fulfil the received HTTP POST request due to an internal error or an error in the HTTP POST request, the NF service consumer shall send an HTTP error response as specified in clause 5.7. + +If the feature "ES3XX" is supported, and the NF service consumer determines the received HTTP POST request needs to be redirected, the NF service consumer shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [5]. + +Upon successful reception of the HTTP POST request with "{notifUri}" as request URI and "AfEventExposureNotif" data structure as request body, the NF service consumer shall send a "204 No Content" HTTP response, as shown in step 2 of figure 4.2.4.2-1. + +# 5 Naf\_EventExposure Service API + +## 5.1 Introduction + +The Naf\_EventExposure Service shall use the Naf\_EventExposure API. + +The API URI of the Naf\_EventExposure API shall be: + +**{apiRoot}
/** + +The request URIs used in HTTP requests from the NF service consumer towards the AF shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [6], i.e.: + +**{apiRoot}
** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [6]. +- The shall be "naf-eventexposure". +- The shall be "v1". +- The shall be set as described in clause 5.3. + +## 5.2 Usage of HTTP + +### 5.2.1 General + +If the AF is untrusted, support of HTTP/1.1 (IETF RFC 7230 [21], IETF RFC 7231 [22], IETF RFC 7232 [23], IETF RFC 7233 [24], IETF RFC 7234 [25] and IETF RFC 7235 [26]) over TLS (IETF RFC 5246 [20]) is mandatory and support of HTTP/2 (IETF RFC 7540 [7]) over TLS (IETF RFC 5246 [20]) is recommended. + +If the AF is trusted, HTTP/2, IETF RFC 7540 [7], shall be used as specified in clause 5.2 of 3GPP TS 29.500 [5]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [5]. + +The OpenAPI [8] specification of HTTP messages and content bodies for the Naf\_EventExposure is contained in Annex A. + +### 5.2.2 HTTP standard headers + +#### 5.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [5] for the usage of HTTP standard headers. + +#### 5.2.2.2 Content type + +JSON, IETF RFC 8259 [9], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [5]. The use of the JSON format shall be signalled by the content type "application/json". + +"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 7807 [10]. + +### 5.2.3 HTTP custom headers + +#### 5.2.3.1 General + +The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [5] shall be applicable. + +In this Release of the specification, no specific custom headers are defined for the Naf\_EventExposure API. + +## 5.3 Resources + +### 5.3.1 Resource Structure + +![Diagram showing the resource URI structure of the Naf_EventExposure API. It starts with {apiRoot}/naf-eventexposure/, which branches to /subscriptions, which in turn branches to /{subscriptionId}.](33a8f3f01dfa8bce75d23017855a13c5_img.jpg) + +{apiRoot}/naf-eventexposure/ + +``` + +graph TD + Root["{apiRoot}/naf-eventexposure/"] --> Subscriptions["/subscriptions"] + Subscriptions --> SubscriptionId["/{subscriptionId}"] + +``` + +Diagram showing the resource URI structure of the Naf\_EventExposure API. It starts with {apiRoot}/naf-eventexposure/, which branches to /subscriptions, which in turn branches to /{subscriptionId}. + +**Figure 5.3.1-1: Resource URI structure of the Naf\_EventExposure API** + +Table 5.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 5.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|-------------------------------------------|---------------------------------|---------------------------------|-------------------------------------------------------------------------------------------------------------------------------| +| Application Event Subscriptions | /subscriptions | POST | Subscription to the notification of application events and creation of an Individual Application Event Subscription resource. | +| Individual Application Event Subscription | /subscriptions/{subscriptionId} | GET | Reads an Individual Application Event Subscription resource. | +| | | PUT | Modifies an Individual Application Event Subscription. | +| | | DELETE | Cancels an individual subscription to notifications of application event. | + +### 5.3.2 Resource: Application Event Subscriptions + +#### 5.3.2.1 Description + +The Application Event Subscriptions resource represents all subscriptions of the Naf\_EventExposure service at a given AF. + +#### 5.3.2.2 Resource definition + +Resource URI: {apiRoot}/naf-eventexposure//subscriptions + +This resource shall support the resource URI variables defined in table 5.3.2.2-1. + +**Table 5.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|------------|-----------|----------------| +| apiRoot | string | See clause 5.1 | +| apiVersion | string | See clause 5.1 | + +#### 5.3.2.3 Resource Standard Methods + +##### 5.3.2.3.1 POST + +This method shall support the URI query parameters specified in table 5.3.2.3.1-1. + +**Table 5.3.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.3.2.3.1-2 and the response data structures and response codes specified in table 5.3.2.3.1-3. + +**Table 5.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------------|---|-------------|--------------------------------------------------------------------------------------------------------| +| AfEventExposure
Subsc | M | 1 | Contains the information required for the creation of a new individual application event subscription. | + +**Table 5.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------------|-----------------------------------------------------------------------------------------------------------------------|-------------|----------------|----------------------------------------------------------------------------------------| +| AfEventExposure
Subsc | M | 1 | 201 Created | Contains the representation of the Individual Application Event Subscription resource. | +| NOTE: | The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [5] also apply. | | | | + +**Table 5.3.2.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure: {apiRoot}/naf-eventexposure//subscriptions/{subscriptionId} | + +### 5.3.3 Resource: Individual Application Event Subscription + +#### 5.3.3.1 Description + +The Individual Application Event Subscription resource represents a single subscription of the Naf\_EventExposure service at a given AF. + +#### 5.3.3.2 Resource definition + +Resource URI: {apiRoot}/naf-eventexposure//subscriptions/{subscriptionId} + +This resource shall support the resource URI variables defined in table 5.3.3.2-1. + +**Table 5.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------------|-----------|-------------------------------------------------------------| +| apiRoot | string | See clause 5.1 | +| apiVersion | string | See clause 5.1 | +| subscriptionId | string | Identifies a subscription to the AF event exposure service. | + +#### 5.3.3.3 Resource Standard Methods + +##### 5.3.3.3.1 GET + +This method shall support the URI query parameters specified in table 5.3.3.3.1-1. + +**Table 5.3.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------|-------------------|---|-------------|----------------------------------------------------| +| supp-feat | SupportedFeatures | O | 0..1 | The features supported by the NF service consumer. | + +This method shall support the request data structures specified in table 5.3.3.3.1-2 and the response data structures and response codes specified in table 5.3.3.3.1-3. + +**Table 5.3.3.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.3.3.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| AfEventExposureSubsc | M | 1 | 200 OK | Contains the representation of the Individual Application Event Subscription resource. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative AF (service) instance. Applicable if the feature "ES3XX" is supported. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative AF (service) instance. Applicable if the feature "ES3XX" is supported. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [5] also apply. + +**Table 5.3.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative AF (service) instance. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the request is redirected. | + +**Table 5.3.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative AF (service) instance. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the request is redirected. | + +##### 5.3.3.3.2 PUT + +This method shall support the URI query parameters specified in table 5.3.3.3.2-1. + +**Table 5.3.3.3.2-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.3.3.3.2-2 and the response data structures and response codes specified in table 5.3.3.3.2-3. + +**Table 5.3.3.3.2-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------|---|-------------|---------------------------------------------------------------------------| +| AfEventExposureSubsc | M | 1 | Modifies the existing Individual Application Event Subscription resource. | + +**Table 5.3.3.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| AfEventExposureSubsc | M | 1 | 200 OK | Successful case.
The Individual Application Event Subscription resource was modified and a representation is returned. | +| n/a | | | 204 No Content | Successful case.
The Individual Application Event Subscription resource was modified. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative AF (service) instance.
Applicable if the feature "ES3XX" is supported. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative AF (service) instance.
Applicable if the feature "ES3XX" is supported. | + +NOTE: The mandatory HTTP error status codes for the PUT method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [5] also apply. + +**Table 5.3.3.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative AF (service) instance. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the request is redirected. | + +**Table 5.3.3.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative AF (service) instance. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the request is redirected. | + +##### 5.3.3.3.3 DELETE + +This method shall support the URI query parameters specified in table 5.3.3.3.3-1. + +**Table 5.3.3.3.3-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.3.3.3.3-2 and the response data structures and response codes specified in table 5.3.3.3.3-3. + +**Table 5.3.3.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.3.3.3-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful case. The Individual Application Event Subscription resource matching the subscriptionId was deleted. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during subscription termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative AF (service) instance. Applicable if the feature "ES3XX" is supported. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during subscription termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative AF (service) instance. Applicable if the feature "ES3XX" is supported. | + +NOTE: The mandatory HTTP error status code for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [5] also apply. + +**Table 5.3.3.3-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative AF (service) instance. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the request is redirected. | + +**Table 5.3.3.3-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative AF (service) instance. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the request is redirected. | + +## 5.4 Custom Operations without associated resources + +No custom operation is defined in this Release of the specification. + +## 5.5 Notifications + +### 5.5.1 General + +Notifications shall comply with clause 6.2 of 3GPP TS 29.500 [5] and clause 4.6.2.3 of 3GPP TS 29.501 [6]. + +**Table 5.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|--------------------------------|--------------|---------------------------------|------------------------------------------------------| +| Application Event Notification | {notifUri} | POST | Notification of application related event reporting. | + +### 5.5.2 Application Event Notification + +#### 5.5.2.1 Description + +The Application Event Notification is used by the AF to report one or several observed application related events to the NF service consumer that has subscribed to such notifications. + +#### 5.5.2.2 Target URI + +The callback URI "{**notifUri**}" shall be used with the callback URI variables defined in table 5.5.2.2-1. + +**Table 5.5.2.2-1: Callback URI variables** + +| Name | Data type | Definition | +|----------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notifUri | Uri | The Notification Uri as assigned by the NF service consumer during the subscription service operation and described within the AfEventExposureSubsc data type (see table 5.6.2.2-1). | + +#### 5.5.2.3 Standard Methods + +##### 5.5.2.3.1 POST + +This method shall support the URI query parameters specified in table 5.5.2.3.1-1. + +**Table 5.5.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.5.2.3.1-2 and the response data structures and response codes specified in table 5.5.2.3.1-3. + +**Table 5.5.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------|---|-------------|----------------------------------------------------------------| +| AfEventExposureNotif | M | 1 | Provides Information about observed application related events | + +**Table 5.5.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The receipt of the Notification is acknowledged. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during event notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative NF consumer (service) instance where the notification should be sent. Applicable if the feature "ES3XX" is supported. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during event notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative NF consumer (service) instance where the notification should be sent. Applicable if the feature "ES3XX" is supported. | + +NOTE: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [5] for the POST method shall also apply. + +**Table 5.5.2.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected. | + +**Table 5.5.2.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected. | + +## 5.6 Data Model + +### 5.6.1 General + +This clause specifies the application data model supported by the API. + +Table 5.6.1-1 specifies the data types defined for the Naf\_EventExposure service based interface protocol. + +**Table 5.6.1-1: Naf\_EventExposure specific Data Types** + +| Data type | Section defined | Description | Applicability | +|------------------------------|-----------------|-------------------------------------------------------------------------------------------------------------------------|---------------| +| AfEvent | 5.6.3.3 | Application Events. | | +| AfEventExposureSubsc | 5.6.2.2 | Represents an Individual Application Event Subscription resource. | | +| AfEventExposureNotif | 5.6.2.3 | Describes notifications about application event that occurred in an Individual Application Event Subscription resource. | | +| AfEventNotification | 5.6.2.6 | AfEventNotification | | +| CommunicationCollection | 5.6.2.13 | | | +| EventFilter | 5.6.2.5 | Represents event filter information | | +| EventsSubs | 5.6.2.4 | | | +| ExceptionInfo | 5.6.2.14 | Describes the exceptions information provided by AF. | | +| SvcExperience | 5.6.2.9 | Mean opinion score with the customized range. | | +| ServiceExperienceInfoPerApp | 5.6.2.7 | Contains service experience associated with the application | | +| ServiceExperienceInfoPerFlow | 5.6.2.8 | Contains service experience associated with the service flow | | +| UeCommunicationCollection | 5.6.2.11 | Contains UE communication information associated with the application. | | +| UeMobilityCollection | 5.6.2.10 | Contains UE mobility information associated with the application. | | +| UeTrajectoryCollection | 5.6.2.12 | | | + +Table 5.6.1-2 specifies data types re-used by the Naf\_EventExposure service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Naf\_EventExposure service based interface. + +**Table 5.6.1-2: Naf\_EventExposure re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|----------------------|---------------------|-------------------------------------------|---------------| +| ApplicationId | 3GPP TS 29.571 [13] | | | +| DateTime | 3GPP TS 29.571 [13] | | | +| Dnai | 3GPP TS 29.571 [13] | | | +| EthFlowDescription | 3GPP TS 29.514 [18] | | | +| Exception | 3GPP TS 29.520 [19] | | | +| Float | 3GPP TS 29.571 [13] | | | +| FlowInfo | 3GPP TS 29.122 [17] | | | +| Gpsi | 3GPP TS 29.571 [13] | | | +| GroupId | 3GPP TS 29.571 [13] | | | +| LocationArea5G | 3GPP TS 29.122 [17] | | | +| RedirectResponse | 3GPP TS 29.571 [13] | Contains redirection related information. | ES3XX | +| ReportingInformation | 3GPP TS 29.523 [12] | | | +| SupportedFeatures | 3GPP TS 29.571 [13] | | | +| TimeWindow | 3GPP TS 29.122 [17] | | | +| Uri | 3GPP TS 29.571 [13] | | | +| Volume | 3GPP TS 29.122 [17] | | | +| Supi | 3GPP TS 29.571 [13] | | | +| ExtGroupId | 3GPP TS 29.503 [27] | | | + +### 5.6.2 Structured data types + +#### 5.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +#### 5.6.2.2 Type AfEventExposureSubsc + +**Table 5.6.2.2-1: Definition of type AfEventExposureSubsc** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| eventsSubs | array(EventsSubs) | M | 1..N | Subscribed events and the related event filters. | | +| eventsReplInfo | ReportingInformation | M | 1 | Represents the reporting requirements of the subscription. | | +| notifUri | Uri | M | 1 | Notification URI for event reporting. | | +| notifId | string | M | 1 | Notification Correlation ID assigned by the NF service consumer. | | +| eventNotifs | array(AfEventNotification) | C | 1..N | Represents the Events to be reported.
Shall only be present if the immediate reporting indication in the "immRep" attribute within the "eventsReplInfo" attribute sets to true in the event subscription, and the reports are available. | | +| suppFeat | SupportedFeatures | C | 0..1 | This IE represents a list of Supported features used as described in clause 5.8.
Shall be present in the HTTP POST request/response; or in the HTTP GET response if the "supp-feat" attribute query parameter is included in the HTTP GET request.
(NOTE) | | + +NOTE: In the HTTP POST request it represents the set of NF service consumer supported features. In the HTTP POST and GET responses it represents the set of features supported by both the NF service consumer and the AF. + +#### 5.6.2.3 Type AfEventExposureNotif + +**Table 5.6.2.3-1: Definition of type AfEventExposureNotif** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------|---------------| +| notifId | string | M | 1 | Notification Correlation ID assigned by the NF service consumer. | | +| eventNotifs | array(AfEventNotification) | M | 1..N | Represents the Events to be reported according to the subscription corresponding to the Notification Correlation ID. | | + +#### 5.6.2.4 Type EventsSubs + +**Table 5.6.2.4-1: Definition of type EventsSubs** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------|---|-------------|---------------------------------------------------------------------|---------------| +| event | AfEvent | M | 1 | Subscribed event. | | +| eventFilter | EventFilter | M | 1 | Represents the event filter information associated with each event. | | + +#### 5.6.2.5 Type EventFilter + +**Table 5.6.2.5-1: Definition of type EventFilter** + +| Attribute name | Data type | P | Cardinality | Description | Applicability
(NOTE 4) | +|----------------|----------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------| +| gpsi | array(Gpsi) | O | 1..N | Each element represents external UE identifier.
(NOTE 1, NOTE 2) | | +| supi | array(Supi) | O | 1..N | Each element represents a SUPI identifying a UE (NOTE 1, NOTE 2) | | +| exterGroupIds | array(ExtGroupId) | O | 1..N | Each element represents a group of UEs identified by an External Group Identifier.
(NOTE 1, NOTE 2) | | +| interGroupIds | array(GroupId) | O | 1..N | Each element represents a group of UEs identified by an Internal Group Identifier (NOTE 1, NOTE 2) | | +| anyUeInd | boolean | O | 0..1 | Identifies whether the request applies to any UE.
This attribute shall set to "true" if applicable for any UE, otherwise, set to "false".
May only be present and sets to "true" if "AfEvent" sets to "SVC_EXPERIENCE" or "EXCEPTIONS".
(NOTE 2) | ServiceExperience Exceptions | +| appIds | array(ApplicationId) | O | 1..N | Each element indicates an application identifier.
If absent, the EventFilter data applies to any application (i.e. all applications)
(NOTE 3) | | +| locArea | LocationArea5G | O | 0..1 | Represents area of interest. | | + +NOTE 1: For untrusted AF, only gpsi and exterGroupIds are applicable. For trusted AF, only supi and interGroupIds are applicable. + +NOTE 2: For an applicable feature, only one attribute identifying the target UE shall be provided. + +NOTE 3: For event "UE\_COMM", "UE\_MOBILITY" and "EXCEPTIONS", the "appIds" attribute, if present, shall include only one element. + +NOTE 4: Properties marked with a feature as defined in clause 5.8 are applicable as described in clause 6.6 of 3GPP TS 29.500 [5]. If no features are indicated, the related property applies for all the features. + +#### 5.6.2.6 Type AfEventNotification + +**Table 5.6.2.6-1: Definition of type AfEventNotification** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|------------------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| event | AfEvent | M | 1 | Reported application related event. | | +| timeStamp | DateTime | M | 1 | Time at which the event is observed. | | +| svcExprInfos | array(ServiceExperienceInfoPerApp) | C | 1..N | Contains the service experience information. Shall be present if the "event" attribute sets to "SVC_EXPERIENCE" | ServiceExperience | +| ueMobilityInfos | array(UeMobilityCollection) | C | 1..N | Contains the UE mobility information. Shall be present if the "event" attribute sets to "UE_MOBILITY" | UeMobility | +| ueCommInfos | array(UeCommunicationCollection) | C | 1..N | Contains the application communication information. Shall be present if the "event" attribute sets to "UE_COMM" | UeCommunication | +| excepInfos | array(ExceptionInfo) | C | 1..N | Each element represents the exception information for a service flow. Shall be present if the "event" attribute sets to "EXCEPTIONS". | Exceptions | + +#### 5.6.2.7 Type ServiceExperienceInfoPerApp + +**Table 5.6.2.7-1: Definition of type ServiceExperienceInfoPerApp** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------|---------------| +| appId | ApplicationId | C | 0..1 | Indicates an application identifier. Shall be present if the AF event exposure service request applies to more than one application. | | +| svcExpPerFlows | array(ServiceExperienceInfoPerFlow) | M | 1..N | Each element represents service experience for each service flow. | | +| gpsi | array(Gpsi) | O | 1..N | Each element represents external UE identifier. (NOTE) | | +| supi | array(Supi) | O | 1..N | SUPI identifying a UE. (NOTE) | | + +NOTE: Either gpsi or supi shall be present. For untrusted AF, only gpsi is applicable. For trusted AF, only supi is applicable. + +#### 5.6.2.8 Type ServiceExperienceInfoPerFlow + +**Table 5.6.2.8-1: Definition of type ServiceExperienceInfoPerFlow** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|--------------------|---|-------------|-------------------------------------------------------------------------------------------|---------------| +| svcExpr | SvcExperience | M | 1 | Service experience | | +| timeIntev | TimeWindow | M | 1 | Represents a start and stop time of the measurement period for the AF service experience. | | +| dnai | Dnai | O | 0..1 | Indicates the DN Access Identifiers representing location of the service flow. | | +| ipTrafficFilter | FlowInfo | O | 0..1 | Identifies IP packet filter.(NOTE) | | +| ethTrafficFilter | EthFlowDescription | O | 0..1 | Identifies Ethernet packet filter.(NOTE) | | + +NOTE: Either "ipTrafficFilter" or "ethTrafficFilter" shall be provided. + +#### 5.6.2.9 Type SvcExperience + +**Table 5.6.2.9-1: Definition of type SvcExperience** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|---------------------------------------------------------------|---------------| +| mos | Float | M | 1 | Mean opinion score. | | +| upperRange | Float | M | 1 | The upper value within the rating scale range | | +| lowerRange | Float | M | 1 | The lower value within the rating scale range | | + +#### 5.6.2.10 Type UeMobilityCollection + +**Table 5.6.2.10-1: Definition of type UeMobilityCollection** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------------------|---|-------------|----------------------------------------------|---------------| +| gpsi | Gpsi | O | 0..1 | Identifies a UE. (NOTE) | | +| supi | Supi | O | 0..1 | SUPI identifying a UE. (NOTE) | | +| appld | ApplicationId | M | 1 | Identifies an application identifier. | | +| ueTrajs | array(UeTrajectory Collection) | M | 1..N | Identifies a list of UE moving trajectories. | | + +NOTE: Either gpsi or supi shall be present. For untrusted AF, only gpsi is applicable. For trusted AF, only supi is applicable. + +#### 5.6.2.11 Type UeCommunicationCollection + +**Table 5.6.2.11-1: Definition of type UeCommunicationCollection** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------------------|---|-------------|--------------------------------------------------------------|---------------| +| gpsi | Gpsi | O | 0..1 | Identifies a UE. (NOTE 1) | | +| supi | Supi | O | 0..1 | SUPI identifying a UE. (NOTE 1) | | +| exterGroupId | ExtGroupId | O | 0..1 | Identifies an external group of UEs. (NOTE 2) | | +| interGroupId | GroupId | O | 0..1 | Identifies an internal group of UEs. (NOTE 2) | | +| appld | ApplicationId | M | 1 | Identifies an application identifier. | | +| comms | array(CommunicationCollection) | M | 1..N | This attribute contains a list of communication information. | | + +NOTE 1: Either gpsi or supi shall be present. For untrusted AF, only gpsi is applicable. For trusted AF, only supi is applicable. +NOTE 2: "interGroupId" attribute only applies to trusted AF and "exterGroupId" only applies to untrusted AF. + +#### 5.6.2.12 Type UeTrajectoryCollection + +**Table 5.6.2.12-1: Definition of type UeTrajectoryCollection** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------|---|-------------|--------------------------------------------------------------------------|---------------| +| ts | DateTime | M | 1 | This attribute identifies the timestamp when the UE enters the location. | | +| locArea | LocationArea5G | M | 1 | This attribute includes the location information of the UE. | | + +#### 5.6.2.13 Type CommunicationCollection + +**Table 5.6.2.13-1: Definition of type CommunicationCollection** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|-----------------------------------------------------|---------------| +| startTime | DateTime | M | 1 | Identifies the timestamp this communication starts. | | +| endTime | DateTime | M | 1 | Identifies the timestamp this communication stops. | | +| ulVol | Volume | O | 0..1 | Identifies the uplink traffic volume. (NOTE) | | +| dlVol | Volume | O | 0..1 | Identifies the downlink traffic volume. (NOTE) | | + +NOTE: At least one of ulVol or dlVol shall be provided. + +#### 5.6.2.14 Type ExceptionInfo + +**Table 5.6.2.14-1: Definition of type ExceptionInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|--------------------|---|-------------|-------------------------------------------------------------------------|---------------| +| ipTrafficFilter | FlowInfo | O | 0..1 | Identifies IP flow.(NOTE 1) | | +| ethTrafficFilter | EthFlowDescription | O | 0..1 | Identifies Ethernet flow.(NOTE 1) | | +| excepts | array(Exception) | M | 1..N | Contains the description of one or more exception information. (NOTE 2) | | + +NOTE 1: Either "ipTrafficFilter" or "ethTrafficFilter" shall be provided. +NOTE 2: Only "exceptId", "exceptLevel" and "exceptTrend" within the Exception data type as defined in 3GPP TS 29.520 [19] apply to the ExceptionInfo data type. + +### 5.6.3 Simple data types and enumerations + +#### 5.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +#### 5.6.3.2 Simple data types + +The simple data types defined in table 5.6.3.2-1 shall be supported. + +**Table 5.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| | | | | + +#### 5.6.3.3 Enumeration: AfEvent + +The enumeration AfEvent represents the application events that can be subscribed. It shall comply with the provisions defined in table 5.6.3.3-1. + +**Table 5.6.3.3-1: Enumeration AfEvent** + +| Enumeration value | Description | Applicability | +|-------------------|------------------------------------------------------------------------------------|-------------------| +| SVC_EXPERIENCE | Indicates that the event subscribed is service experience data for an application. | ServiceExperience | +| UE_MOBILITY | Indicates that the event subscribed is UE mobility information. | UeMobility | +| UE_COMM | Indicates that the event subscribed is UE communication information. | UeCommunication | +| EXCEPTIONS | Indicates that the event subscribed is exceptions information. | Exceptions | + +## 5.7 Error handling + +### 5.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [5]. + +For the Naf\_EventExposure API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [6]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [5] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [5]. + +In addition, the requirements in the following clauses are applicable for the Naf\_EventExposure API. + +### 5.7.2 Protocol Errors + +In this Release of the specification, there are no service specific protocol errors applicable for the Naf\_EventExposure API. + +### 5.7.3 Application Errors + +The application errors defined for the Naf\_EventExposure service are listed in table 5.7.3-1. + +**Table 5.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|------------------|-------------| +| | | | + +## 5.8 Feature negotiation + +The optional features in table 5.8-1 are defined for the Naf\_EventExposure API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [5]. + +**Table 5.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | ServiceExperience | This feature indicates support for the event related to service experience. | +| 2 | UeMobility | This feature indicates support for the event related to UE mobility. | +| 3 | UeCommunication | This feature indicates support for the event related to UE communication information. | +| 4 | Exceptions | This feature indicates support for the event related to exception information. | +| 5 | ES3XX | Extended Support for 3xx redirections. This feature indicates the support of redirection for any service operation, according to Stateless NF procedures as specified in subclauses 6.5.3.2 and 6.5.3.3 of 3GPP TS 29.500 [5] and according to HTTP redirection principles for indirect communication, as specified in subclause 6.10.9 of 3GPP TS 29.500 [5]. | + +## 5.9 Security + +TLS (IETF RFC 5246 [20]) shall be used to support the security communication between the NF Service Consumer and the AF as defined in clause 12.3 and clause 13.1 of 3GPP TS 33.501 [14]. + +If the AF is trusted, as indicated in 3GPP TS 33.501 [14] and 3GPP TS 29.500 [5], the access to the Naf\_EventExposure API may be authorized by means of the OAuth 2.0 protocol (see IETF RFC 6749 [15]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [16]) plays the role of the authorization server. + +If OAuth 2.0 is used, an NF Service Consumer, prior to consuming services offered by the Naf\_EventExposure API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [16], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Naf\_EventExposure service. + +The Naf\_EventExposure API defines a single scope "naf-eventexposure" for the entire service, and it does not define any additional scopes at resource or operation level. + +If the AF is untrusted, the access to Naf\_EventExposure API shall be authorized by means of OAuth2 protocol (see IETF RFC 6749 [15]), based on local configuration, using the "Client Credentials" authorization grant. If OAuth2 is used, a NF Service Consumer (e.g. NEF), prior to consuming services offered by the Naf\_EventExposure API, shall obtain a "token" from the authorization server. + +# Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex is based on the OpenAPI 3.0.0 specification [8] and provides corresponding representations of all APIs defined in the present specification. + +NOTE 1: An OpenAPIs representation embeds JSON Schema representations of HTTP message bodies. + +This Annex shall take precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE 2: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository that uses the GitLab software version control system (see clause 5B of the 3GPP TR 21.900 [11] and clause 5.3.1 of the 3GPP TS 29.501 [6] for further information). + +The security scheme defined below for the Naf\_EventExposure API shows the case when the AF is in untrusted domain and the "scopes" and "tokenUrl" are undefined. For the trusted AF, the "scopes" definition shall use "naf-eventexposure" and the "tokenUrl" definition shall use "{nrfApiRoot}/oauth2/token". + +## A.2 Naf\_EventExposure API + +``` +openapi: 3.0.0 +info: + version: 1.0.3 + title: Naf_EventExposure + description: | + AF Event Exposure Service. + © 2021, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.517 V16.5.0; 5G System; Application Function Event Exposure Service; Stage 3. + url: http://www.3gpp.org/ftp/Specs/archive/29_series/29.517/ + +servers: + - url: '{apiRoot}/naf-eventexposure/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: [] + +paths: + /subscriptions: + post: + summary: Creates a new Individual Application Event Exposure Subscription resource + operationId: PostAfEventExposureSubsc + tags: + - Application Event Subscription (Collection) + requestBody: + required: true + content: + application/json: + schema: +``` + +``` + + $ref: '#/components/schemas/AfEventExposureSubsc' +responses: + '201': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AfEventExposureSubsc' + headers: + Location: + description: 'Contains the URI of the created individual application event +subscription resource' + required: true + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +callbacks: + AfEventExposureNotif: + '{ $request.body# / notifUri }': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AfEventExposureNotif' + responses: + '204': + description: No Content, Notification was successful + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +/subscriptions/{subscriptionId}: + get: + +``` + +``` +summary: "Reads an existing Individual Application Event Subscription" +operationId: GetAfEventExposureSubsc +tags: + - Individual Application Event Subscription (Document) +parameters: + - name: subscriptionId + in: path + description: Application Event Subscription ID + required: true + schema: + type: string + - name: supp-feat + in: query + description: Features supported by the NF service consumer + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: + '200': + description: OK. Resource representation is returned + content: + application/json: + schema: + $ref: '#/components/schemas/AfEventExposureSubsc' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +put: + summary: "Modifies an existing Individual Application Event Subscription " + operationId: PutAfEventExposureSubsc + tags: + - Individual Application Event Subscription (Document) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AfEventExposureSubsc' + parameters: + - name: subscriptionId + in: path + description: Application Event Subscription ID + required: true + schema: + type: string + responses: + '200': + description: OK. Resource was successfully modified and representation is returned + content: + application/json: + schema: + $ref: '#/components/schemas/AfEventExposureSubsc' + '204': + description: No Content. Resource was successfully modified + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +delete: + summary: "Cancels an existing Individual Application Event Subscription " + operationId: DeleteAfEventExposureSubsc + tags: + - Individual Application Event Subscription (Document) + parameters: + - name: subscriptionId + in: path + description: Application Event Subscription ID + required: true + schema: + type: string + responses: + '204': + description: No Content. Resource was successfully deleted + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUri}' + scopes: {} + description: for trusted AF, the 'naf-eventexposure' shall be used as 'scopes' and + '{nrfApiRoot}/oauth2/token' shall be used as 'tokenUri'. + +schemas: + AfEventExposureNotif: + type: object + properties: + notifId: + type: string + eventNotifs: + type: array + items: + $ref: '#/components/schemas/AfEventNotification' + +``` + +``` + minItems: 1 + required: + - notifId + - eventNotifs +AfEventExposureSubsc: + type: object + properties: + eventsSubs: + type: array + items: + $ref: '#/components/schemas/EventsSubs' + minItems: 1 + eventsRepInfo: + $ref: 'TS29523_Npcf_EventExposure.yaml#/components/schemas/ReportingInformation' + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + notifId: + type: string + eventNotifs: + type: array + items: + $ref: '#/components/schemas/AfEventNotification' + minItems: 1 + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - eventsSubs + - eventsRepInfo + - notifId + - notifUri +AfEventNotification: + type: object + properties: + event: + $ref: '#/components/schemas/AfEvent' + timeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + svcExprcInfos: + type: array + items: + $ref: '#/components/schemas/ServiceExperienceInfoPerApp' + minItems: 1 + ueMobilityInfos: + type: array + items: + $ref: '#/components/schemas/UeMobilityCollection' + minItems: 1 + ueCommInfos: + type: array + items: + $ref: '#/components/schemas/UeCommunicationCollection' + minItems: 1 + excepInfos: + type: array + items: + $ref: '#/components/schemas/ExceptionInfo' + minItems: 1 + required: + - event + - timeStamp +EventsSubs: + type: object + properties: + event: + $ref: '#/components/schemas/AfEvent' + eventFilter: + $ref: '#/components/schemas/EventFilter' + required: + - event + - eventFilter +EventFilter: + type: object + properties: + gpsis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + minItems: 1 +``` + +``` +supis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + extGroupIds: + type: array + items: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId' + minItems: 1 + interGroupIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + anyUeInd: + type: boolean + appIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + minItems: 1 + locArea: + $ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G' +ServiceExperienceInfoPerApp: + type: object + properties: + appId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + svcExpPerFlows: + type: array + items: + $ref: '#/components/schemas/ServiceExperienceInfoPerFlow' + minItems: 1 + gpsis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + minItems: 1 + supis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + required: + - svcExpPerFlows +ServiceExperienceInfoPerFlow: + type: object + properties: + svcExprc: + $ref: '#/components/schemas/SvcExperience' + timeIntev: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + dnai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + ipTrafficFilter: + $ref: 'TS29122_CommonData.yaml#/components/schemas/FlowInfo' + ethTrafficFilter: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EthFlowDescription' +SvcExperience: + type: object + properties: + mos: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + upperRange: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + lowerRange: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' +UeMobilityCollection: + type: object + properties: + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + appId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + ueTrajs: + type: array +``` + +----- + +----- + +``` + + items: + $ref: '#/components/schemas/UeTrajectoryCollection' + minItems: 1 + required: + - appId + - ueTrajs + UeCommunicationCollection: + type: object + properties: + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + exterGroupId: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId' + interGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + appId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + comms: + type: array + items: + $ref: '#/components/schemas/CommunicationCollection' + minItems: 1 + required: + - appId + - comms + UeTrajectoryCollection: + type: object + properties: + ts: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + locArea: + $ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G' + required: + - ts + - locArea + CommunicationCollection: + type: object + properties: + startTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + endTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + ulVol: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' + dlVol: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' + required: + - startTime + - endTime + - ulVol + - dlVol + ExceptionInfo: + type: object + properties: + ipTrafficFilter: + $ref: 'TS29122_CommonData.yaml#/components/schemas/FlowInfo' + ethTrafficFilter: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EthFlowDescription' + excepts: + type: array + items: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/Exception' + minItems: 1 + +``` + +# Simple data types and Enumerations + +``` + +AfEvent: + anyOf: + - type: string + enum: + - SVC_EXPERIENCE + - UE_MOBILITY + - UE_COMM + - EXCEPTIONS + - type: string + +``` + +# Annex B (informative): Change history + +| Change history | | | | | | | | | +|----------------|----------|-----------|------|-----|-----|-----------------------------------------------------------------------------------|--------|--| +| Date | TSG # | TSG Doc. | CR | Rev | Cat | Subject/Comment | New | | +| 2019-03 | | | | | | TS skeleton of Application Function Event Exposure Service | 0.0.0 | | +| 2019-04 | CT3#102 | | | | | Inclusion of C3-191230, C3-191374 and editorial change from Rapporteur. | 0.1.0 | | +| 2019-05 | CT3#103 | | | | | Inclusion of C3-192194, C3-192393, C3-192260 and C3-192261. | 0.2.0 | | +| 2019-08 | CT3#105 | | | | | Inclusion of C3-193373, C3-193440, C3-193441 and C3-193446. | 0.3.0 | | +| 2019-10 | CT3#106 | | | | | Inclusion of C3-194263, C3-194264, C3-194393 and C3-194439. | 0.4.0 | | +| 2019-11 | CT3#107 | | | | | Inclusion of C3-195068, C3-195226, C3-195238. | 0.5.0 | | +| 2019-12 | CT#86 | CP-193178 | | | | Presented for information | 1.0.0 | | +| 2019-12 | CT#86 | CP-193295 | | | | A title corrected | 1.0.1 | | +| 2020-02 | CT3#108e | | | | | Inclusion of C3-201297, C3-201369, C3-201385, C3-201399, C3-201440 and C3-201466. | 1.1.0 | | +| 2020-03 | CT#87e | CP-200188 | | | | TS sent to plenary for approval | 2.0.0 | | +| 2020-03 | CT#87e | CP-200188 | | | | TS approved by plenary | 16.0.0 | | +| 2020-06 | CT#88e | CP-201234 | 0001 | - | F | Update service operation for Ue Communication | 16.1.0 | | +| 2020-06 | CT#88e | CP-201234 | 0002 | - | F | Corrections in TS 29.517 | 16.1.0 | | +| 2020-06 | CT#88e | CP-201234 | 0003 | - | F | Definition of AfEventExposureSubsc in OpenAPI | 16.1.0 | | +| 2020-06 | CT#88e | CP-201234 | 0004 | 1 | D | Unsubscribe service operation | 16.1.0 | | +| 2020-06 | CT#88e | CP-201234 | 0005 | 1 | F | Correction to event description | 16.1.0 | | +| 2020-06 | CT#88e | CP-201234 | 0006 | 1 | F | Correction to target UE description | 16.1.0 | | +| 2020-06 | CT#88e | CP-201244 | 0007 | 1 | F | Storage of YAML files in ETSI Forge | 16.1.0 | | +| 2020-06 | CT#88e | CP-201234 | 0008 | - | F | Service operation description for UE mobility | 16.1.0 | | +| 2020-06 | CT#88e | CP-201256 | 0009 | 1 | F | URI of the Naf_EventExposure service | 16.1.0 | | +| 2020-06 | CT#88e | CP-201234 | 0010 | - | F | Support of immediate reporting | 16.1.0 | | +| 2020-06 | CT#88e | CP-201077 | 0012 | 1 | F | Supported features definition | 16.1.0 | | +| 2020-06 | CT#88e | CP-201234 | 0013 | 1 | F | Target UE information | 16.1.0 | | +| 2020-06 | CT#88e | CP-201234 | 0014 | 1 | F | Supported headers, Resource Data type and yaml mapping | 16.1.0 | | +| 2020-06 | CT#88e | CP-201255 | 0015 | - | F | Update of OpenAPI version and TS version in externalDocs field | 16.1.0 | | +| 2020-09 | CT#89e | CP-202066 | 0017 | 1 | F | Missed data type definition | 16.2.0 | | +| 2020-09 | CT#89e | CP-202066 | 0018 | - | F | Corrections on UE Mobility | 16.2.0 | | +| 2020-09 | CT#89e | CP-202066 | 0019 | - | F | Missed response code | 16.2.0 | | +| 2020-09 | CT#89e | CP-202066 | 0020 | 1 | F | Any UE indication applies to EXCEPTIONS | 16.2.0 | | +| 2020-12 | CT#90e | CP-203139 | 0021 | 1 | F | Essential Corrections and alignments | 16.3.0 | | +| 2020-12 | CT#90e | CP-203139 | 0022 | - | F | Storage of YAML files in 3GPP Forge | 16.3.0 | | +| 2020-12 | CT#90e | CP-203129 | 0023 | 1 | F | Removal of trailing forward slash in resource URI | 16.3.0 | | +| 2020-12 | CT#90e | CP-203139 | 0024 | 1 | F | Callback URI correction | 16.3.0 | | +| 2020-12 | CT#90e | CP-203152 | 0027 | - | F | Update of OpenAPI version and TS version in externalDocs field | 16.3.0 | | +| 2021-03 | CT#91e | CP-210206 | 0028 | - | F | Correction to anyUeInd attribute | 16.4.0 | | +| 2021-03 | CT#91e | CP-210191 | 0030 | - | F | Support Stateless NFs | 16.4.0 | | +| 2021-03 | CT#91e | CP-210206 | 0035 | - | F | Resource URI correction | 16.4.0 | | +| 2021-03 | CT#91e | CP-210239 | 0037 | - | F | Update of OpenAPI version and TS version in externalDocs field | 16.4.0 | | +| 2021-06 | CT#92e | CP-211200 | 0042 | 1 | F | Redirection responses | 16.5.0 | | +| 2021-06 | CT#92e | CP-211264 | 0044 | - | F | Update of OpenAPI version and TS version in externalDocs field | 16.5.0 | | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29526/5a4e62bead259c258d069fd3663ea670_img.jpg b/marked/Rel-16/29_series/29526/5a4e62bead259c258d069fd3663ea670_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3be2d8604b430a7e8e95963be663ec9f4846c876 --- /dev/null +++ b/marked/Rel-16/29_series/29526/5a4e62bead259c258d069fd3663ea670_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cb9b421d8877383d30835cc198c225725d48687dde2cd444d7f56faa45adaff1 +size 115421 diff --git a/marked/Rel-16/29_series/29526/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-16/29_series/29526/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2ea547e7b1b5c0c0a3df27b9c232e12fae079fef --- /dev/null +++ b/marked/Rel-16/29_series/29526/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c644bcc786e0b18f2fa0419e4ee4da6059c93341b0c65fdae4ac044a8e83d281 +size 7594 diff --git a/marked/Rel-16/29_series/29526/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-16/29_series/29526/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8ae42123ca1bf664c74a4589d703b557b5423dee --- /dev/null +++ b/marked/Rel-16/29_series/29526/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:669674ec123a72fd40d710baac0b94f8c4e298500d32915ef521877b4acd7370 +size 5772 diff --git a/marked/Rel-16/29_series/29526/7efae06af3af43ffe5d4b956a679cf54_img.jpg b/marked/Rel-16/29_series/29526/7efae06af3af43ffe5d4b956a679cf54_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2545bcfd0bcef4511e51f0c80175f4fb3ee9e358 --- /dev/null +++ b/marked/Rel-16/29_series/29526/7efae06af3af43ffe5d4b956a679cf54_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ec6944a427ff71c244669a7d82223cfcca3cfb7a66c2363e41fbaca11313d52c +size 36809 diff --git a/marked/Rel-16/29_series/29526/8307f6b04df072c9332f9987e034272c_img.jpg b/marked/Rel-16/29_series/29526/8307f6b04df072c9332f9987e034272c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0a65ae427ea24aa03718a37d7cec5306c5d1df0e --- /dev/null +++ b/marked/Rel-16/29_series/29526/8307f6b04df072c9332f9987e034272c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d7a35b41fc636a6ed809b72f5ea6e2f01aaa32dbe46efc613f37f61358ce295c +size 12647 diff --git a/marked/Rel-16/29_series/29526/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg b/marked/Rel-16/29_series/29526/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6ac965ef043753b6bc504887941702d8e8b3dc72 --- /dev/null +++ b/marked/Rel-16/29_series/29526/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c20439b01aa01a0b05357b1c071e2c60cd0fa0609d3801f90104885077ce6ce6 +size 8019 diff --git a/marked/Rel-16/29_series/29526/ea37ab05b033e59cfdf7b074161aaf5a_img.jpg b/marked/Rel-16/29_series/29526/ea37ab05b033e59cfdf7b074161aaf5a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8d9c413ea4a78dda220c9cbbf5f29937f26801b3 --- /dev/null +++ b/marked/Rel-16/29_series/29526/ea37ab05b033e59cfdf7b074161aaf5a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9d33a00da9d6c236306afb6028dfa3cda42d8b2cb629902a8378cd8b1e234b00 +size 35835 diff --git a/marked/Rel-16/29_series/29526/raw.md b/marked/Rel-16/29_series/29526/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..c39d6a5bac4398047e150faf3246d8e675854d5c --- /dev/null +++ b/marked/Rel-16/29_series/29526/raw.md @@ -0,0 +1,1507 @@ + + +# 3GPP TS 29.526 V16.7.0 (2022-03) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Network Slice-Specific Authentication and Authorization (NSSAA) services; Stage 3 (Release 16)** + +![5G logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The 5G logo, consisting of the text "5G" in a bold, black, sans-serif font. Above the "5G" text is a green graphic element consisting of three curved lines of increasing length, resembling a signal strength indicator or a stylized wave. + +5G logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, featuring the letters "3GPP" in a stylized, bold, black font. The "3" and "G" are connected at the top by a single horizontal line. The "P" and "P" are also connected at the top by a single horizontal line. Below the "G" and the first "P" are three small red curved lines, resembling a signal strength indicator or a stylized wave. + +3GPP logo + +A GLOBAL INITIATIVE + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions, symbols and abbreviations ..... | 8 | +| 3.1 Definitions..... | 8 | +| 3.2 Symbols..... | 8 | +| 3.3 Abbreviations ..... | 8 | +| 4 Overview..... | 8 | +| 4.1 Introduction ..... | 8 | +| 5 Services offered by the NSSAAF ..... | 9 | +| 5.1 Introduction ..... | 9 | +| 5.2 NnssAAF_NSSAAF Service..... | 9 | +| 5.2.1 Service Description ..... | 9 | +| 5.2.2 Service Operations..... | 10 | +| 5.2.2.1 Introduction..... | 10 | +| 5.2.2.2 Authenticate ..... | 10 | +| 5.2.2.2.1 General ..... | 10 | +| 5.2.2.3 Re-Authentication Notification..... | 13 | +| 5.2.2.3.1 General ..... | 13 | +| 5.2.2.4 Revocation Notification..... | 14 | +| 5.2.2.4.1 General ..... | 14 | +| 6 API Definitions ..... | 15 | +| 6.1 NnssAAF_NSSAAF Service API ..... | 15 | +| 6.1.1 Introduction ..... | 15 | +| 6.1.2 Usage of HTTP..... | 16 | +| 6.1.2.1 General..... | 16 | +| 6.1.2.2 HTTP standard headers..... | 16 | +| 6.1.2.2.1 General ..... | 16 | +| 6.1.2.2.2 Content type ..... | 16 | +| 6.1.2.3 HTTP custom headers..... | 16 | +| 6.1.3 Resources..... | 16 | +| 6.1.3.1 Overview..... | 16 | +| 6.1.3.2 Resource: slice-authentications (Collection) ..... | 17 | +| 6.1.3.2.1 Description ..... | 17 | +| 6.1.3.2.2 Resource Definition..... | 17 | +| 6.1.3.2.3 Resource Standard Methods..... | 17 | +| 6.1.3.2.4 Resource Custom Operations..... | 19 | +| 6.1.3.3 Resource: slice-authentication (Document)..... | 19 | +| 6.1.3.3.1 Description ..... | 19 | +| 6.1.3.3.2 Resource Definition..... | 19 | +| 6.1.3.3.3 Resource Standard Methods..... | 19 | +| 6.1.3.3.4 Resource Custom Operations ..... | 21 | +| 6.1.4 Custom Operations without associated resources ..... | 21 | +| 6.1.4.1 Overview..... | 21 | +| 6.1.5 Notifications ..... | 21 | +| 6.1.5.1 General..... | 21 | +| 6.1.5.2 Re-authentication Notification..... | 22 | +| 6.1.5.2.1 Description ..... | 22 | +| 6.1.5.2.2 Target URI..... | 22 | +| 6.1.5.2.3 Standard Methods..... | 22 | +| 6.1.5.3 Revocation Notification..... | 23 | +| 6.1.5.3.1 Description ..... | 23 | +| 6.1.5.3.2 Target URI..... | 23 | +| 6.1.5.3.3 Standard Methods..... | 23 | + +| | | | +|---------------------------------------------------------|----------------------------------------------------------------------------------|-----------| +| 6.1.6 | Data Model ..... | 24 | +| 6.1.6.1 | General ..... | 24 | +| 6.1.6.2 | Structured data types ..... | 25 | +| 6.1.6.2.1 | Introduction ..... | 25 | +| 6.1.6.2.2 | Type: SliceAuthInfo ..... | 25 | +| 6.1.6.2.3 | Type: SliceAuthContext ..... | 25 | +| 6.1.6.2.4 | Type: SliceAuthConfirmationData ..... | 26 | +| 6.1.6.2.5 | Type: SliceAuthConfirmationResponse ..... | 26 | +| 6.1.6.2.6 | Type: SliceAuthReauthNotification ..... | 26 | +| 6.1.6.2.7 | Type: SliceAuthRevokeNotification ..... | 26 | +| 6.1.6.3 | Simple data types and enumerations ..... | 26 | +| 6.1.6.3.1 | Introduction ..... | 26 | +| 6.1.6.3.2 | Simple data types ..... | 26 | +| 6.1.6.3.3 | Enumeration: SliceAuthNotificationType ..... | 27 | +| 6.1.6.4 | Data types describing alternative data types or combinations of data types ..... | 27 | +| 6.1.6.5 | Binary data ..... | 27 | +| 6.1.7 | Error Handling ..... | 27 | +| 6.1.7.1 | General ..... | 27 | +| 6.1.7.2 | Protocol Errors ..... | 27 | +| 6.1.7.3 | Application Errors ..... | 27 | +| 6.1.8 | Feature negotiation ..... | 28 | +| 6.1.9 | Security ..... | 28 | +| Annex A (normative): OpenAPI specification ..... | | 29 | +| A.1 | General ..... | 29 | +| A.2 | Nnssaaaf_NSSAA API ..... | 29 | +| Annex B (informative): Change history ..... | | 34 | + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# 1 Scope + +The present document specifies the stage 3 protocol and data model for the NnssAAF Service Based Interface. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the NSSAAF. + +The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5]. + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] OpenAPI: "OpenAPI 3.0.0 Specification", . +- [7] 3GPP TR 21.900: "Technical Specification Group working methods". +- [8] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [9] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [10] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". +- [11] IETF RFC 7540: "Hypertext Transfer Protocol Version 2 (HTTP/2)". +- [12] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [13] IETF RFC 7807: "Problem Details for HTTP APIs". +- [14] IETF RFC 4648: "The Base16, Base32 and Base64 Data Encodings". +- [15] 3GPP TS 29.503: "5G System; Unified Data Management Services; Stage 3". +- [16] 3GPP TS 29.518: "5G System; Access and Mobility Management Services; Stage 3". + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +*Definition format (Normal)* + +****: . + +**example:** text used to clarify abstract rules by applying them literally. + +## 3.2 Symbols + +For the purposes of the present document, the following symbols apply: + +*Symbol format (EW)* + +| | | +|----------|---------------| +| | | +|----------|---------------| + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|--------|---------------------------------------------------------| +| NSSAA | Network Slice-Specific Authentication and Authorization | +| NSSAAF | NSSAAF Function | + +# --- 4 Overview + +## 4.1 Introduction + +Within the 5GC, the NSSAAF offers services to the AMF via the NnssAAF service based interface. + +The AMF shall make use of the NSSAAF service when it needs to invoke network slice-specific authentication and authorization for a specific UE and a specific S-NSSAI (see 3GPP TS 23.502 [3] clause 4.2.9.2, and 3GPP TS 33.501 [14] clause 16.2 and 16.3). + +The NSSAAF service shall also be used by the AMF to receive slice re-authentication notification or slice authorization revocation notification sent from the AAA-S (see 3GPP TS 23.502 [3] clause 4.2.9.3, 4.2.9.4 and 3GPP TS 33.501 [14] clause 16.3 and 16.4). + +Figure 4.1-1 provides the reference model with focus on the NSSAAF. + +![Figure 4.1-1: Reference model – NSSAAF. A diagram showing the AMF (Access and Management Function) connected to the NSSAAF (Network Slice Selection Function) via the NnssAAF interface. The AMF is represented by a white box on the left, and the NSSAAF is represented by a green box on the right. A line connects the AMF to the NSSAAF, with the label 'NnssAAF' next to it. The connection point on the NSSAAF side is indicated by a small circle.](b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg) + +Figure 4.1-1: Reference model – NSSAAF. A diagram showing the AMF (Access and Management Function) connected to the NSSAAF (Network Slice Selection Function) via the NnssAAF interface. The AMF is represented by a white box on the left, and the NSSAAF is represented by a green box on the right. A line connects the AMF to the NSSAAF, with the label 'NnssAAF' next to it. The connection point on the NSSAAF side is indicated by a small circle. + +Figure 4.1-1: Reference model – NSSAAF + +# 5 Services offered by the NSSAAF + +## 5.1 Introduction + +The NSSAAF offers the following services via the NnssAAF interface: + +- NnssAAF\_NSSAA Service + +Table 5.1-1 summarizes the corresponding APIs defined for this specification. + +Table 5.1-1: API Descriptions + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex | +|---------------|--------|---------------------------------------------------------|----------------------------|---------------|-------| +| NnssAAF_NSSAA | 5.2 | slice-Specific authentication and authorization service | NnssAAF_NSSAA.yaml | nnssAAF-nssaa | A.2 | + +## 5.2 NnssAAF\_NSSAA Service + +### 5.2.1 Service Description + +The NnssAAF\_NSSAA service provides slice-specific authentication and authorization for a given UE. The NSSAAF is acting as NF Service Producer, while the AMF is the NF Service Consumer. + +Following functionalities are provided by the NnssAAF service: + +- Perform slice-specific authentication and authorization for a given UE; +- Trigger slice-specific re-authentication to a given UE; +- Revoke the slice-specific authentication and authorization for a given UE. + +The NnssAAF\_NSSAA service supports the following service operations. + +**Table 5.2.1-1: Service operations supported by the Nnssaaaf\_NSSAA service** + +| Service Operations | Description | Operation Semantics | Example Consumer(s) | +|--------------------------------|----------------------------------------------------------------------------------------------|----------------------------|----------------------------| +| Authenticate | Perform slice-specific authentication and authorization for a given UE. | Request/Response | AMF | +| Re-Authentication Notification | Request slice-specific re-authentication and re-authorization for a given UE. | Callback | AMF | +| Revocation Notification | Request revocation of slice-specific authentication and authorization result for a given UE. | Callback | AMF | + +### 5.2.2 Service Operations + +#### 5.2.2.1 Introduction + +See Table 5.2.1-1 for an overview of the service operations supported by the Nnssaaaf\_NSSAA service. + +#### 5.2.2.2 Authenticate + +##### 5.2.2.2.1 General + +The Authenticate service operation permits the NF Service Consumer (i.e. the AMF) to initiate slice-specific authentication and authorization, e.g. during a UE Registration procedure or upon reception of a re-authentication notification from the NSSAAF (see clause 5.2.2.3). The NSSAAF may relay the EAP message to an AAA-S and collect the result of slice-specific authentication and authorization from the AAA-S, as specified in clause 4.2.9.2 of 3GPP TS 23.502 [3], and clause 16.3 of 3GPP TS 33.501 [8]. + +The NF Service Consumer (i.e. the AMF) shall send a POST request to the resource representing slice authentication collection (i.e. .../v1/slice-authentications) to request the NSSAAF to create the corresponding resource context and perform slice-specific authentication and authorization. + +![Sequence diagram for Slice-Specific Authentication and Authorization between NF Service Consumer (AMF) and NSSAAF. The diagram shows two main authentication flows. In the first flow, the AMF sends a POST request to slice-authentications, the NSSAAF forwards the EAP ID to AAA-S, and returns a response (201 Created, 4xx/5xx ProblemDetails, or 3xx RedirectResponse). In the second flow, the AMF sends a PUT request for a specific authCtxId confirmation, the NSSAAF forwards the EAP message to AAA-S, and returns a response (200 OK, 4xx/5xx ProblemDetails, or 3xx RedirectResponse).](5a4e62bead259c258d069fd3663ea670_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant NSSAAF + Note right of NSSAAF: AAA-S + Note right of NSSAAF: AAA-S + + NF Service Consumer->>NSSAAF: 1. POST ../slice-authentications (SliceAuthInfo) + Note right of NSSAAF: 2. Forward EAP ID to AAA-S + Note right of NSSAAF: -3a. 201 Created (SliceAuthContext) + Note right of NSSAAF: -3b. 4xx/5xx (ProblemDetails) + Note right of NSSAAF: -3c. 3xx (RedirectResponse) + NF Service Consumer->>NSSAAF: 4. PUT ../slice-authentications/{authCtxId}/confirmation(SliceAuthConfirmationData) + Note right of NSSAAF: 5. Forward EAP message to AAA-S + Note right of NSSAAF: -6a. 200 OK (SliceAuthConfirmationResponse) + Note right of NSSAAF: -6b. 4xx/5xx (ProblemDetails) + Note right of NSSAAF: -6c. 3xx (RedirectResponse) + NF Service Consumer-->>NSSAAF: 7. PUT ../slice-authentications/{authCtxId}/confirmation(SliceAuthConfirmationData) + Note right of NSSAAF: 8. Forward EAP message to AAA-S + Note right of NSSAAF: -9a. 200 OK (SliceAuthConfirmationResponse) + Note right of NSSAAF: -9b. 4xx/5xx (ProblemDetails) + Note right of NSSAAF: -9c. 3xx (RedirectResponse) + +``` + +Sequence diagram for Slice-Specific Authentication and Authorization between NF Service Consumer (AMF) and NSSAAF. The diagram shows two main authentication flows. In the first flow, the AMF sends a POST request to slice-authentications, the NSSAAF forwards the EAP ID to AAA-S, and returns a response (201 Created, 4xx/5xx ProblemDetails, or 3xx RedirectResponse). In the second flow, the AMF sends a PUT request for a specific authCtxId confirmation, the NSSAAF forwards the EAP message to AAA-S, and returns a response (200 OK, 4xx/5xx ProblemDetails, or 3xx RedirectResponse). + +**Figure 5.2.2.2.1-1: Slice-Specific Authentication and Authorization** + +- The NF Service Consumer (AMF) shall send a POST request to the NSSAAF, targeting the resource of slice authentication collection (i.e. .../v1/slice-authentications), to perform slice-specific authentication and authorization. + +The payload of the body shall contain the slice authentication information, which includes: + +- UE ID (i.e. GPSI) +- S-NSSAI +- EAP ID Response message (if it is received from the UE), or the EAP ID Response message with EAP ID stored, or the EAP ID Response message with Null value (if EAP ID is not requested or received); +- optionally, the callback URI of the AMF to receive re-authentication notification from the NSSAAF; +- optionally, the callback URI of the AMF to receive revocation notification from the NSSAAF. + +Based on local policy, the AMF may determine to provide callback URI(s) for receiving re-authentication notification or revocation notification. For example, the callback URIs are provided for an UE identified with low mobility characteristic. + +If Slice-Specific Authentication and Authorization is triggered by the AMF during a Registration procedure as described in clause 4.2.9.2 of 3GPP TS 23.502 [3], the AMF shall set "status" attribute for the given slice listed in "nssaaStatusList" attribute to "PENDING" (See 3GPP TS 29.518 [16]). + +- The NSSAAF creates slice authentication context for the UE, and starts the slice-specific authentication and authorization procedure. If the AAA-S is involved in slice-specific authentication and authorization procedure, the NSSAAF shall forward the EAP ID Response message to the AAA-S if the EAP ID Response message does not contain the Null value. Depending on the result, either step 3a or step 3b is performed. The NSSAAF obtains the AAA-S address from local configuration, based on S-NSSAI. + +- 3a. On success, "201 Created" shall be returned. The "Location" header shall contain the URI of the created resource (e.g. .../v1/slice-authentications/{authCtxId}). The payload body shall contain the slice authentication context, which includes the EAP message generated by the NSSAAF or from the AAA-S. The NF Service Consumer (i.e. the AMF) shall forward the received EAP message to the UE in NAS message, as specified in clause 4.2.9.2 of 3GPP TS 23.502 [3]. +- 3b. On failure, one of the HTTP status code listed in Table 6.1.7.3-1 shall be returned with the message body containing a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.7.3-1. If the slice is not authorized, the NSSAAF shall use the "SLICE\_AUTH\_REJECTED" application error code. +- 3c. On redirection, the appropriate HTTP status code (e.g. "307 Temporary Redirect") shall be returned. A RedirectResponse IE may be included in the payload body of POST response, as specified in table 6.1.3.2.3.1-3. +4. Once receiving EAP message from the UE, the NF Service Consumer (i.e. the AMF) shall send a PUT request to the NSSAAF, targeting the resource of the slice authentication context (i.e. .../v1/slice-authentications/{authCtxId}). + +The payload body shall carry the slice authentication confirmation data which includes: + +- UE ID (i.e. GPSI) + - S-NSSAI + - AAA-S address + - EAP Message (which is received from the UE) +5. The NSSAAF checks and confirms the slice-specific authentication and authorization. If the AAA-S is involved, the NSSAAF shall forward the EAP Message to the AAA-S to confirm the slice-specific authentication and authorization. Depending on the result, either step 6a or step 6b is performed. + - 6a. On success, "200 OK" shall be returned. The payload body shall contain the slice authentication confirmation response, which includes the EAP message (e.g. EAP success/failure message) generated by the NSSAAF or from the AAA-S. The NF Service Consumer (i.e. the AMF) shall forward the EAP message to the UE in NAS message. + +If the UE is authenticated, the NSSAAF shall set the "authResult" attribute to "EAP\_SUCCESS". If failed to authenticate the UE, the "authResult" attribute shall be set to "EAP\_FAILURE". + +If subsequent EAP message exchange is needed between the UE and the NSSAAF(AAA-S), the NSSAAF shall not include SliceAuthResult in the response message. + +- 6b. On failure, one of the HTTP status codes listed in Table 6.1.7.3-1 shall be returned with the message body containing a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.7.3-1. +- 6c. On redirection, the appropriate HTTP status code (e.g. "307 Temporary Redirect") shall be returned. A RedirectResponse IE may be included in the payload body of POST response, as specified in table 6.1.3.3.3.1-3. +- 7-9. If subsequent EAP message exchange is needed between the UE and the NSSAAF to finish the EAP based authentication, step 7-9 are performed. On failure, one of the HTTP status codes listed in Table 6.1.7.3-1 shall be returned with the message body containing a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.7.3-1. On redirection, the appropriate HTTP status code (e.g. "307 Temporary Redirect") shall be returned, and a RedirectResponse IE may be included in the message body, as specified in table 6.1.3.3.3.1-3. + +In above steps, if the AAA-S is involved in the slice-specific authentication and authorization procedure while there is no expected response from the AAA-S in the case of time out, the NSSAAF shall return HTTP status code "504 Gateway Timeout", with the message body containing a ProblemDetails structure with the "cause" attribute set to "TIMED\_OUT\_REQUEST". + +After the completion of slice-specific authentication and authorization procedure, it is up to implementation whether the NSSAAF stores the slice authentication context and related resources for a configured period, or + +deletes the context and resource immediately, e.g. depending on the potential need for AAA-S initiated slice-specific re-authentication/revocation notification. + +If the slice-specific authentication and authorization was successful (i.e. "authResult" attribute received from NSSAAF in step 6a is set to "EAP\_SUCCESS"), the AMF shall set "status" attribute for the given slice listed in "nssaaStatusList" attribute to "EAP\_SUCCESS" (see 3GPP TS 29.518 [16]). + +If the slice-specific authentication and authorization finally fails (i.e. "authResult" attribute received from NSSAAF in step 6a is set to "EAP\_FAILURE"), the AMF shall set "status" attribute for the given slice listed in "nssaaStatusList" attribute to "EAP\_FAILURE" (see 3GPP TS 29.518 [16]). In this case, if there are PDU sessions previously established corresponding to the S-NSSAIs required to be authenticated, the AMF should additionally trigger the release of those PDU sessions. + +If the slice-specific authentication and authorization cannot be completed, then: + +- If it is due to receiving a response with HTTP status code "504 Gateway Timeout" or due to lack of response from the NSSAAF during an NSSAA procedure, the AMF may later re-initiate slice-specific authentication and authorization procedure based on its policy. The AMF should wait for a configured period before re-initiating slice-specific authentication and authorization procedure. If the retry attempts are exhausted, the AMF stops the slice-specific authentication and authorization procedure. + +NOTE 1: It is recommended to limit the number of retry attempts as described in 3GPP TS 29.500 [4]. + +- If it is due to the UE becoming unreachable during an NSSAA procedure, the AMF stops the slice-specific authentication and authorization procedure. +- If the AMF stops the slice-specific authentication and authorization procedure (i.e. after exhausting the retry attempts or when the UE becomes unreachable), the AMF shall keep the "status" attribute set to "PENDING", for the given slice(s) listed in "nssaaStatusList" attribute (see 3GPP TS 29.518 [16]). + +NOTE 2: The AMF initiates the slice-specific authentication and authorization for S-NSSAIs in "PENDING" status at next UE uplink activity. + +#### 5.2.2.3 Re-Authentication Notification + +##### 5.2.2.3.1 General + +The Re-Authentication Notification service operation shall be used by the NSSAAF to notify the AMF to re-initiate slice-specific authentication and authorization for a given UE, as specified in clause 4.2.9.3 of 3GPP TS 23.502 [3], and clause 16.4 of 3GPP TS 33.501 [8]. + +If there are two different AMFs serving the UE (e.g. the NSSAAF retrieves two different AMFs from the UDM), the NSSAAF may determine to send the re-authentication notification to both AMFs. Or, the NSSAAF may first send re-authentication notification to one of the AMF, and then send revocation notification to another AMF if EAP authentication fails in first AMF. If EAP authentication succeeds in first AMF then NSSAAF does not notify the other AMF. + +The NSSAAF shall notify the NF Service Consumer (i.e. the AMF) by using the HTTP POST method as shown in Figure 5.2.2.3.1-1. + +![Sequence diagram showing the Re-authentication Notification process between an NF Service Consumer and an NSSAAF. The NF Service Consumer sends a POST {reauthNotifUri} (SliceAuthReauthNotification) message to the NSSAAF. The NSSAAF responds with one of three options: 2a. 204 No Content, 2b. 3xx/4xx/5xx (ProblemDetails), or 2c. 3xx (RedirectResponse).](ea37ab05b033e59cfdf7b074161aaf5a_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant NSSAAF + Note left of NF Service Consumer: NF Service Consumer + NF Service Consumer->>NSSAAF: 1. POST {reauthNotifUri} (SliceAuthReauthNotification) + Note right of NSSAAF: NSSAAF + NSSAAF-->>NF Service Consumer: 2a. 204 No Content + Note right of NSSAAF: NSSAAF + NSSAAF-->>NF Service Consumer: 2b. 3xx/4xx/5xx (ProblemDetails) + Note right of NSSAAF: NSSAAF + NSSAAF-->>NF Service Consumer: 2c. 3xx (RedirectResponse) + +``` + +Sequence diagram showing the Re-authentication Notification process between an NF Service Consumer and an NSSAAF. The NF Service Consumer sends a POST {reauthNotifUri} (SliceAuthReauthNotification) message to the NSSAAF. The NSSAAF responds with one of three options: 2a. 204 No Content, 2b. 3xx/4xx/5xx (ProblemDetails), or 2c. 3xx (RedirectResponse). + +Figure 5.2.2.3.1-1: Re-authentication Notification + +1. The NSSAAF shall send a POST request to the callback URI used to receiving re-authentication notification, which is either provided by the NF Service Consumer (i.e. the AMF), or retrieved from the AMF profile stored in the NRF. + +The HTTP payload body of the POST request shall contain the SliceAuthReauthNotification data structure, within which: + +- the notificationType set to the SliceAuthNotificationType of "SLICE\_RE\_AUTH"; +- the gpsi set to the GPSI of the given UE required to be re-authenticated; +- the snssai set to the S-NSSAI required to be re-authenticated; +- the supi set to the SUPI of the given UE required to be re-authenticated. + +NOTE: The NSSAAF can obtain the SUPI of the UE in the response of a previous Nudm\_UECM\_Get used by the NSSAAF to retrieve the AMF ID. + +- 2a. On success, "204 No Content" shall be returned and the payload body of the POST response shall be empty. + +After responding the request, the NF Service Consumer (i.e. the AMF) shall send NAS message to the UE to trigger re-authentication and re-authorization for the given slice. + +The AMF then decides to execute the Slice-Specific Authentication and Authorization if needed as described in clause 5.2.2.2.1. + +- 2b. On failure, one of the HTTP status code (e.g. "404 Not Found") listed in Table 6.1.7.3-1 shall be returned. + +For a 4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.7.3-1. + +- 2c. On redirection, the appropriate HTTP status code (e.g. "307 Temporary Redirect") shall be returned. A RedirectResponse IE may be included in the payload body of POST response, as specified in table 6.1.5.2.3.1-3. + +If the NF Service Consumer (i.e. the AMF) is not able to handle the request, but knows that another NF Service Consumer (i.e. the AMF) is able to handle it, it shall reply with an HTTP 3xx redirect error response pointing to the URI of the new NF Service Consumer (i.e. the AMF). + +#### 5.2.2.4 Revocation Notification + +##### 5.2.2.4.1 General + +The Revocation Notification service operation shall be used by the NSSAAF to notify the AMF to revoke slice-specific authentication and authorization result, as specified in clause 4.2.9.4 of 3GPP TS 23.502 [3], and clause 16.5 of 3GPP TS 33.501 [8], and may trigger the AMF to release the corresponding PDU sessions associated to the indicated slice. + +If there are two different AMFs serving the UE (e.g. the NSSAAF retrieves two different AMFs from the UDM), the NSSAAF may determine to send revocation notification to both AMFs. + +The NSSAAF shall notify the NF Service Consumer (i.e. the AMF) by using the HTTP POST method as shown in Figure 5.2.2.4.1-1. + +![Sequence diagram showing the Revocation Notification process between an NF Service Consumer and an NSSAAF. The NSSAAF sends a POST request to the NF Service Consumer. The NF Service Consumer responds with either a 204 No Content, a 4xx/5xx ProblemDetails, or a 3xx RedirectResponse.](7efae06af3af43ffe5d4b956a679cf54_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant NSSAAF + Note left of NF Service Consumer: NF Service Consumer + Note right of NSSAAF: NSSAAF + NSSAAF->>NF Service Consumer: 1. POST {revocNotifUri} (SliceAuthRevocNotification) + NF Service Consumer-->>NSSAAF: 2a. 204 No Content + NF Service Consumer-->>NSSAAF: 2b. 4xx/5xx (ProblemDetails) + NF Service Consumer-->>NSSAAF: 2c. 3xx (RedirectResponse) + +``` + +Sequence diagram showing the Revocation Notification process between an NF Service Consumer and an NSSAAF. The NSSAAF sends a POST request to the NF Service Consumer. The NF Service Consumer responds with either a 204 No Content, a 4xx/5xx ProblemDetails, or a 3xx RedirectResponse. + +**Figure 5.2.2.4.1-1: Revocation Notification** + +1. The NSSAAF shall send a POST request to the revocation notification callback URI, which is either provided by the NF Service Consumer (i.e. the AMF), or retrieved from the AMF profile stored in the NRF. + +The HTTP payload body of the POST request shall contain the SliceAuthRevocNotification data structure, within which: + +- the notificationType set to the SliceAuthNotificationType of "SLICE\_REVOCATION"; +- the gpsi set to the GPSI of the given UE for whom the slice-specific authorization revocation is required; +- the snssai set to the S-NSSAI for which the slice-specific authorization revocation is required; +- the supi set to the SUPI of the given UE for whom the slice-specific authorization revocation is required. + +NOTE: The NSSAAF can obtain the SUPI of the UE in the response of a previous Nudm\_UECM\_Get used by the NSSAAF to retrieve the AMF ID. + +- 2a. On success, "204 No Content" shall be returned and the payload body of the POST response shall be empty. + +On receiving the request, the NF Service Consumer (i.e. the AMF) shall revoke the slice-specific authentication and authorization result for the given UE. If there is PDU session associated to the given slice, the AMF shall trigger the PDU session release to the SMF, with appropriate cause value. + +The AMF shall remove the "status" for the given slice in "nssaaStatusList" attribute (see 3GPP TS 29.518 [16]). + +- 2b. On failure, one of the HTTP status code (e.g. "404 Not Found") listed in Table 6.1.7.3-1 shall be returned. + +For a 4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.7.3-1. + +- 2c. On redirection, the appropriate HTTP status code (e.g. "307 Temporary Redirect") shall be returned. A RedirectResponse IE may be included in the payload body of POST response, as specified in table 6.1.5.3.3.1-2. + +If the NF Service Consumer (i.e. the AMF) is not able to handle the request, but knows that another NF Service Consumer (i.e. the AMF) is able to handle it, it shall reply with an HTTP 3xx redirect error response pointing to the URI of the new NF Service Consumer (i.e. the AMF). + +# 6 API Definitions + +## 6.1 Nnssaaaf\_NSSAA Service API + +### 6.1.1 Introduction + +The Nnssaaaf\_NSSAA service shall use the Nnssaaaf\_NSSAA API. + +The API URI of the API shall be: + +**{apiRoot}///** + +The request URIs used in HTTP request from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}///** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nnssaaf-nssaa". +- The shall be "v1". +- The shall be set as described in clause 5.3. + +### 6.1.2 Usage of HTTP + +#### 6.1.2.1 General + +HTTP/2, IETF RFC 7540 [11], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +The OpenAPI [6] specification of HTTP messages and content bodies for the Nnssaaf\_NSSAA API is contained in Annex A. + +#### 6.1.2.2 HTTP standard headers + +##### 6.1.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers. + +##### 6.1.2.2.2 Content type + +JSON, IETF RFC 8259 [12], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [4]. The use of the JSON format shall be signalled by the content type "application/json". + +"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 7807 [13]. + +#### 6.1.2.3 HTTP custom headers + +The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] shall be applicable. + +### 6.1.3 Resources + +#### 6.1.3.1 Overview + +The structure of the Resource URIs of the Nnssaaf\_NSSAA service is shown in Figure 6.1.3.1-1 + +![Diagram showing the resource URI structure of the NSSAA API. The root path is //{apiRoot}/nnssaaf-nssaa/. A line branches down to a box containing /slice-authentications. From this box, another line branches down to a box containing /{authCtxId}.](8307f6b04df072c9332f9987e034272c_img.jpg) + +``` + + graph TD + Root[" //{apiRoot}/nnssaaf-nssaa/"] --> SliceAuth[" /slice-authentications"] + SliceAuth --> AuthCtxId[" /{authCtxId}"] + +``` + +Diagram showing the resource URI structure of the NSSAA API. The root path is //{apiRoot}/nnssaaf-nssaa/. A line branches down to a box containing /slice-authentications. From this box, another line branches down to a box containing /{authCtxId}. + +**Figure 6.1.3.1-1: Resource URI structure of the NSSAA API** + +Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.1.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|------------------------------------|---------------------------------------|---------------------------------|----------------------------------------------------------------------------------------------------------------------------------| +| slice-authentications (Collection) | /v1/slice-authentications | POST | Initiate the slice-specific authentication and authorization process by providing inputs related to the UE and a specific slice. | +| slice-authentication (Document) | /v1/slice-authentications/{authCtxId} | PUT | Put the UE response from the EAP process. | + +#### 6.1.3.2 Resource: slice-authentications (Collection) + +##### 6.1.3.2.1 Description + +This resource represents a collection of the slice-authentication resources generated by the NSSAAF. + +##### 6.1.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nnssaaf-nssaa //slice-authentications + +This resource shall support the resource URI variables defined in table 6.1.3.2.2-1. + +**Table 6.1.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|------------|-----------|------------------| +| apiRoot | string | See clause 6.1.1 | +| apiVersion | string | See clause 6.1.1 | + +##### 6.1.3.2.3 Resource Standard Methods + +###### 6.1.3.2.3.1 POST + +This method shall support the URI query parameters specified in table 6.1.3.2.3.1-1. + +**Table 6.1.3.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.2.3.1-2 and the response data structures and response codes specified in table 6.1.3.2.3.1-3. + +**Table 6.1.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------|---|-------------|-------------------------------------------------------------------| +| SliceAuthInfo | M | 1 | Contains the GPSI, S-NSSAI, and EAP ID Response from the UE, etc. | + +**Table 6.1.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SliceAuthContext | M | 1 | 201 Created | This case indicates the corresponding resource has been created by the NSSAAF for the requested slice-specific authentication and authorization, and further EAP process is required.
The HTTP response shall include a "Location" header that contains the resource URI of the created resource. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if this is a redirection triggered by an SCP to the same target resource via another SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same NSSAAF or NSSAAF (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if this is a redirection triggered by an SCP to the same target resource via another SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same NSSAAF or NSSAAF (service) set.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 400 Bad Request | This case represents the failure to start slice-specific authentication and authorization because of input parameter error. | +| ProblemDetails | O | 0..1 | 403 Forbidden | This case represents when the UE or the slice is not allowed to be authenticated.
The "cause" attribute may be used to indicate one of the following application errors:
- SLICE_AUTH_REJECTED | +| ProblemDetails | O | 0..1 | 404 Not Found | This case represents the user or user context is not found.
The "cause" attribute may be used to indicate one of the following application errors:
- CONTEXT_NOT_FOUND
- USER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 504 Gateway Time out | This case represents network error or remote peer (i.e. AAA-S) error, e.g. not reachable, no response and time out.
The "cause" attribute may be used to indicate one of the following application errors:
- NETWORK_FAILURE
- UPSTREAM_SERVER_ERROR
- TIME_OUT_REQUEST | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.2.3.1-4: Headers supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +**Table 6.1.3.2.3.1-5: Headers supported by the 201 response code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------| +| Location | URI | M | 1 | URI of created resource for the slice authentication context.
The URI structure is defined in clause 6.1.3.3.1. | + +**Table 6.1.3.2.3.1-6: Links supported by the 201 Response Code on this endpoint** + +| Name | Resource name | HTTP method or custom operation | Link parameter(s) | Description | +|------|---------------|---------------------------------|-------------------|-------------| +| n/a | | | | | + +**Table 6.1.3.2.3.1-7: Headers supported by the 307 Response Code on this endpoint** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | URI pointing to the resource of another NF service producer to which the request should be sent.
Or the same URI, if a request is redirected to the same target resource via a different SCP. | + +**Table 6.1.3.2.3.1-8: Headers supported by the 308 Response Code on this endpoint** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | URI pointing to the resource of another NF service producer to which the request should be sent.
Or the same URI, if a request is redirected to the same target resource via a different SCP. | + +##### 6.1.3.2.4 Resource Custom Operations + +There is no Resource Custom Operations in the current version of this API. + +#### 6.1.3.3 Resource: slice-authentication (Document) + +##### 6.1.3.3.1 Description + +The sub-resource "slice-authentication" is generated by the NSSAAF. This subresource should not persist after the slice-specific authentication and authorization process finishes. + +##### 6.1.3.3.2 Resource Definition + +Resource URI: {apiRoot}/nnssaaf-nssaa//slice-authentications/{authCtxId} + +This resource shall support the resource URI variables defined in table 6.1.3.3.2-1. + +**Table 6.1.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|------------|-----------|--------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| apiVersion | string | See clause 6.1.1 | +| authCtxId | string | The slice authentication context ID, which is of data type SliceAuthCtxId defined in clause 6.1.6.3.2. | + +##### 6.1.3.3.3 Resource Standard Methods + +###### 6.1.3.3.3.1 PUT + +This method shall support the URI query parameters specified in table 6.1.3.3.3.1-1. + +**Table 6.1.3.3.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.3.3.1-2 and the response data structures and response codes specified in table 6.1.3.3.3.1-3. + +**Table 6.1.3.3.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------------------|---|-------------|-----------------------------------------------------------------------| +| SliceAuthConfirmationData | M | 1 | Contains the EAP message generated by the UE and provided to the AMF. | + +**Table 6.1.3.3.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SliceAuthConfirmationResponse | M | 1 | 200 OK | This case indicates that the NSSAAF has performed the slice-specific authentication. The response body shall contain the result of the slice-specific authentication and authorization. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if this is a redirection triggered by an SCP to the same target resource via another SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same NSSAAF or NSSAAF (service) set. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if this is a redirection triggered by an SCP to the same target resource via another SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same NSSAAF or NSSAAF (service) set. (NOTE 2) | +| ProblemDetails | O | 0..1 | 400 Bad Request | This case represents a slice-specific authentication failure because of input parameter error. This indicates that the NSSAAF was not able to process the slice-specific authentication. | +| ProblemDetails | O | 0..1 | 403 Forbidden | This case represents when the UE or the slice is not allowed to be authenticated.
The "cause" attribute may be used to indicate one of the following application errors:
- SLICE_AUTH_REJECTED | +| ProblemDetails | O | 0..1 | 404 Not Found | This case represents the UE or UE related context is not found.
The "cause" attribute may be used to indicate one of the following application errors:
- CONTEXT_NOT_FOUND
- USER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 504 Gateway Time out | This case represents network error or remote peer (i.e. AAA-S) error, e.g. not reachable, no response when time out.
The "cause" attribute may be used to indicate one of the following application errors:
- NETWORK_FAILURE
- UPSTREAM_SERVER_ERROR
- TIMED_OUT_REQUEST | + +NOTE 1: The mandatory HTTP error status code for the PUT method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +Table 6.1.3.3.3.1-4: Headers supported by the PUT method on this resource + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +Table 6.1.3.3.3.1-5: Headers supported by the 200 response code on this resource + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +Table 6.1.3.3.3.1-6: Links supported by the 200 Response Code on this endpoint + +| Name | Resource name | HTTP method or custom operation | Link parameter(s) | Description | +|------|---------------|---------------------------------|-------------------|-------------| +| n/a | | | | | + +Table 6.1.3.3.3.1-7: Headers supported by the 307 Response Code on this endpoint + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | URI pointing to the resource of another NF service producer to which the request should be sent.
Or the same URI, if a request is redirected to the same target resource via a different SCP. | + +Table 6.1.3.3.3.1-8: Headers supported by the 308 Response Code on this endpoint + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | URI pointing to the resource of another NF service producer to which the request should be sent.
Or the same URI, if a request is redirected to the same target resource via a different SCP. | + +##### 6.1.3.3.4 Resource Custom Operations + +There is no Resource Custom Operations in the current version of this API. + +### 6.1.4 Custom Operations without associated resources + +#### 6.1.4.1 Overview + +There is no Custom Operation in the current version of this API. + +### 6.1.5 Notifications + +#### 6.1.5.1 General + +Notifications shall comply to clause 6.2 of 3GPP TS 29.500 [4] and clause 4.6.2.3 of 3GPP TS 29.501 [5]. + +**Table 6.1.5.1-1: Notifications overview** + +| Notification | Resource URI | HTTP method or custom operation | Description (service operation) | +|--------------------------------|-----------------------------------------------------------------------|---------------------------------|---------------------------------| +| Re-authentication Notification | {reauthNotifUri}
(NF Service Consumer provided callback reference) | POST | Re-authentication Notification | +| Revocation Notification | {revocNotifUri}
(NF Service Consumer provided callback reference) | POST | Revocation Notification | + +#### 6.1.5.2 Re-authentication Notification + +##### 6.1.5.2.1 Description + +The Re-authentication Notification is used by the NSSAAF to trigger the NF Service Consumer (i.e. the AMF) to re-initiate slice-specific authentication and authorization for a given UE. + +##### 6.1.5.2.2 Target URI + +The Notification URI "{reauthNotifUri}" shall be used with the resource URI variables defined in table 6.1.5.2.2-1. + +**Table 6.1.5.2.2-1: Resource URI variables for this resource** + +| Name | Definition | +|----------------|-------------------------------------------------------------------------------| +| reauthNotifUri | String formatted as URI which carries the re-authentication notification URI. | + +##### 6.1.5.2.3 Standard Methods + +###### 6.1.5.2.3.1 POST + +This method shall support the request data structures specified in table 6.1.5.2.3.1-1 and the response data structures and response codes specified in table 6.1.5.2.3.1-2. + +**Table 6.1.5.2.3.1-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------------|---|-------------|----------------------------------------------------------------------------------------------| +| SliceAuthReauthNotification | M | 1 | SliceAuthReauthNotification which carries the re-authentication notification for a given UE. | + +Table 6.1.5.2.3.1-2: Data structures supported by the POST Response Body on this resource + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | | | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The NF service consumer shall generate a Location header field containing a URI pointing to the endpoint of another NF service consumer to which the notification should be sent. If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service consumer to which the notification should be sent.

(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The NF service consumer shall generate a Location header field containing a URI pointing to the endpoint of another NF service consumer to which the notification should be sent. If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service consumer to which the notification should be sent.

(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +#### 6.1.5.3 Revocation Notification + +##### 6.1.5.3.1 Description + +The Revocation Notification is used by the NSSAAF to trigger the NF Service Consumer (i.e. the AMF) to revoke the slice-specific authentication and authorization result for a given UE. + +##### 6.1.5.3.2 Target URI + +The Notification URI "{revocNotifUri}" shall be used with the resource URI variables defined in table 6.1.5.3.2-1. + +Table 6.1.5.3.2-1: Resource URI variables for this resource + +| Name | Definition | +|---------------|------------------------------------------------------------------------| +| revocNotifUri | String formatted as URI which carries the revocation notification URI. | + +##### 6.1.5.3.3 Standard Methods + +###### 6.1.5.3.3.1 POST + +This method shall support the request data structures specified in table 6.1.5.3.3.1-1 and the response data structures and response codes specified in table 6.1.5.3.3.1-2. + +Table 6.1.5.3.3.1-1: Data structures supported by the POST Request Body on this resource + +| Data type | P | Cardinality | Description | +|----------------------------|---|-------------|---------------------------------------------------------------------------------| +| SliceAuthRevocNotification | M | 1 | SliceAuthNotification which carries the revocation notification for a given UE. | + +Table 6.1.5.3.3.1-2: Data structures supported by the POST Response Body on this resource + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | | | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The NF service consumer shall generate a Location header field containing a URI pointing to the endpoint of another NF service consumer to which the notification should be sent. If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service consumer to which the notification should be sent.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The NF service consumer shall generate a Location header field containing a URI pointing to the endpoint of another NF service consumer to which the notification should be sent. If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service consumer to which the notification should be sent.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +### 6.1.6 Data Model + +#### 6.1.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.1.6.1-1 specifies the data types defined for the Nnssaaaf service based interface protocol. + +Table 6.1.6.1-1: Nnssaaaf specific Data Types + +| Data type | Clause defined | Description | Applicability | +|-------------------------------|----------------|-------------------------------------------------------------------------------------------------------|---------------| +| SliceAuthInfo | 6.1.6.2.2 | Contains the GPSI, S-NSSAI, EAP ID Response, etc. | | +| SliceAuthContext | 6.1.6.2.3 | Contains the information of the resource created for slice-specific authentication and authorization. | | +| SliceAuthConfirmationData | 6.1.6.2.4 | Contains the EAP message from the UE for EAP process. | | +| SliceAuthConfirmationResponse | 6.1.6.2.5 | Contains the slice-specific authentication and authorization result from the NSSAAF to the UE. | | +| SliceAuthReauthNotification | 6.1.6.2.6 | Contains the re-authentication notification for slice-specific authentication and authorization. | | +| SliceAuthRevocNotification | 6.1.6.2.7 | Contains the revocation notification for slice-specific authentication and authorization. | | +| SliceAuthCxtId | 6.1.6.3.2 | Contains the resource ID of slice authentication context. | | +| EapMessage | 6.1.6.3.2 | Contains the string formatted EAP message. | | +| SliceNotificationType | 6.1.6.3.3 | Notification type of slice-specification authentication and authorization. | | + +Table 6.1.6.1-2 specifies data types re-used by the NnssAAF service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the NnssAAF service based interface. + +**Table 6.1.6.1-2: NnssAAF re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|------------------|---------------------|------------------------------------------|---------------| +| ProblemDetails | 3GPP TS 29.571 [10] | Common Data Type used in response bodies | | +| RedirectResponse | 3GPP TS 29.571 [10] | Redirect Response | | +| Gpsi | 3GPP TS 29.571 [10] | GPSI | | +| Snssai | 3GPP TS 29.571 [10] | S-NSSAI | | +| AuthStatus | 3GPP TS 29.571 [10] | Slice Authentication Status | | +| Supi | 3GPP TS 29.571 [10] | SUPI of the UE | | + +#### 6.1.6.2 Structured data types + +The following clause defines the structures to be used in resource representations. + +##### 6.1.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.1.6.2.2 Type: SliceAuthInfo + +**Table 6.1.6.2.2-1: Definition of type SliceAuthInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| gpsi | Gpsi | M | 1 | Contains the GPSI of the UE. | | +| snssai | Snssai | M | 1 | Contains the S-NSSAI for authentication. | | +| eapIdRsp | EapMessage | M | 1 | Contains the EAP ID Responses message from the UE.
If no EAP ID Responses message is received or requested, it shall contain the Null value. | | +| amfInstanceId | NfInstanceId | O | 0..1 | This IE may be present, if the AMF determines to provide the re-authentication/revocation notification URI to the NSSAAF.
When present, it shall contain the NF Instance Id of the AMF. | | +| reauthNotifUri | Uri | O | 0..1 | This IE may be present, e.g. if the AMF determines the UE with low mobility characteristic.
When present, it shall contain the re-authentication notification URI. | | +| revocNotifUri | Uri | O | 0..1 | This IE may be present, e.g. if the AMF determines the UE with low mobility characteristic.
When present, it shall contain the revocation notification URI. | | + +##### 6.1.6.2.3 Type: SliceAuthContext + +**Table 6.1.6.2.3-1: Definition of type SliceAuthContext** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------|---|-------------|-----------------------------------------------------------------------------------------------------------|---------------| +| gpsi | Gpsi | M | 1 | Contains the GPSI of the UE. | | +| snssai | Snssai | M | 1 | Contains the S-NSSAI for authentication. | | +| authCtxId | SliceAuthCtxId | M | 1 | Indicates the resource ID uniquely identifying the slice authentication context, generated by the NSSAAF. | | +| eapMessage | EapMessage | M | 1 | Contains the EAP message to be sent to the UE. | | + +##### 6.1.6.2.4 Type: SliceAuthConfirmationData + +Table 6.1.6.2.4-1: Definition of type SliceAuthConfirmationData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------|---|-------------|------------------------------------------------|---------------| +| gpsi | Gpsi | M | 1 | Contains the GPSI of the UE. | | +| snssai | Snssai | M | 1 | Contains the S-NSSAI for authentication. | | +| eapMessage | EapMessage | M | 1 | Contains the EAP message received from the UE. | | + +##### 6.1.6.2.5 Type: SliceAuthConfirmationResponse + +Table 6.1.6.2.5-1: Definition of type SliceAuthConfirmationResponse + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------|---|-------------|------------------------------------------------------------------------------------------------|---------------| +| gpsi | Gpsi | M | 1 | Contains the GPSI of the UE. | | +| snssai | Snssai | M | 1 | Contains the S-NSSAI for authentication. | | +| eapMessage | EapMessage | M | 1 | Contains the EAP success/failure message needs to be sent to the UE. | | +| authResult | AuthStatus | O | 0..1 | When present, it shall indicate the result of slice-specific authentication and authorization. | | + +##### 6.1.6.2.6 Type: SliceAuthReauthNotification + +Table 6.1.6.2.6-1: Definition of type SliceAuthReauthNotification + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|---------------------------|---|-------------|----------------------------------------------------------------|---------------| +| notificationType | SliceAuthNotificationType | M | 1 | Indicate the type of slice authentication notification. | | +| gpsi | Gpsi | M | 1 | Contains the GPSI of the UE. | | +| snssai | Snssai | M | 1 | Contains the S-NSSAI for authentication. | | +| supi | Supi | C | 0..1 | This IE should be sent by the NSSAAF to the AMF, if available. | | + +##### 6.1.6.2.7 Type: SliceAuthRevocNotification + +Table 6.1.6.2.7-1: Definition of type SliceAuthRevocNotification + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|---------------------------|---|-------------|----------------------------------------------------------------|---------------| +| notificationType | SliceAuthNotificationType | M | 1 | Indicate the type of slice authentication notification. | | +| gpsi | Gpsi | M | 1 | Contains the GPSI of the UE. | | +| snssai | Snssai | M | 1 | Contains the S-NSSAI for authentication. | | +| supi | Supi | C | 0..1 | This IE should be sent by the NSSAAF to the AMF, if available. | | + +#### 6.1.6.3 Simple data types and enumerations + +##### 6.1.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 6.1.6.3.2 Simple data types + +The simple data types defined in table 6.1.6.3.2-1 shall be supported. + +**Table 6.1.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|----------------|-----------------|----------------------------------------------------------------------------------------------------------------|---------------| +| SliceAuthCtxId | string | The resource ID uniquely identifying the slice authentication context, generated by the NSSAAF. | | +| EapMessage | string | The EAP packet is encoded using base64 (see IETF RFC 4648 [14]) and represented as a String.
Format: base64 | | + +##### 6.1.6.3.3 Enumeration: SliceAuthNotificationType + +The enumeration SliceAuthNotificationType represents the notification type of slice-specific authentication and authorization. It shall comply with the provisions defined in table 6.1.6.3.3-1. + +**Table 6.1.6.3.3-1: Enumeration SliceAuthNotificationType** + +| Enumeration value | Description | Applicability | +|-------------------|---------------------------------------------------------------------------------------------------------------|---------------| +| SLICE_RE_AUTH | This value is used to indicate the re-authentication is needed | | +| SLICE_REVOCATION | This value is used to indicate the previous slice-specific authentication and authorization shall be revoked. | | + +#### 6.1.6.4 Data types describing alternative data types or combinations of data types + +There is no alternative data types defined in this specification. + +#### 6.1.6.5 Binary data + +There is no binary data type defined in this specification. + +### 6.1.7 Error Handling + +#### 6.1.7.1 General + +For the Nnssaaaf\_NSSAA API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [4] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [4]. + +In addition, the requirements in the following clauses are applicable for the Nnssaaaf\_NSSAA API. + +#### 6.1.7.2 Protocol Errors + +No specific procedures for the Nnssaaaf\_NSSAA service are specified. + +#### 6.1.7.3 Application Errors + +The application errors defined for the Nnssaaaf\_NSSAA service are listed in Table 6.1.7.3-1. + +**Table 6.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-----------------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| RESOURCE_TEMP_MOVED | 307 Temporary Redirect | Indicates that the NSSAAF is not able to handle the request, but points to the URI of another NSSAAF. | +| RESOURCE_MOVED | 308 Permanent Redirect | Indicates that the NSSAAF is not able to handle the request, but points to the URI of another NSSAAF. | +| SLICE_AUTH_REJECTED | 403 Forbidden | The user cannot be authenticated, e.g. authentication request rejected by the AAA-S. | +| CONTEXT_NOT_FOUND | 404 Not Found | The NSSAAF cannot find the resource corresponding to the URI provided by the NF Service Consumer, i.e. the resource identified by the authCtxId does not exist in the NSSAAF. | +| USER_NOT_FOUND | 404 Not Found | The user does not exist in the HPLMN. | +| UPSTREAM_SERVER_ERROR | 504 Gateway Timeout | Error happens in reaching the remote peer (i.e. the AAA-S). | +| NETWORK_FAILURE | 504 Gateway Timeout | The request is rejected due to a network problem. | +| TIMED_OUT_REQUEST | 504 Gateway Timeout | No response is received from the remote peer (i.e. the AAA-S) when time out. | + +### 6.1.8 Feature negotiation + +The optional features in table 6.1.8-1 are defined for the Nnssaaaf\_NSSAA API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.1.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +### 6.1.9 Security + +As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Nnssaaaf\_NSSAA API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [9]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [10]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nnssaaaf\_NSSAA API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [10], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nnssaaaf\_NSSAA service. + +The Nnssaaaf\_NSSAA API defines a single scope "nssaaaf-nssaa" for the entire service, and it does not define any additional scopes at resource or operation level. + +# Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex specifies the formal definition of the API(s) defined in the present specification. It consists of OpenAPI 3.0.0 specifications in YAML format. + +This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE : The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository hosted, that uses the GitLab software version control system (see 3GPP TS 29.501 [5] clause 5.3.1 and 3GPP TR 21.900 [7] clause 5B). + +## A.2 Nnssaaf\_NSSAA API + +``` + +openapi: 3.0.0 + +info: + title: Nnssaaf_NSSAA + version: 1.0.5 + description: | + Network Slice-Specific Authentication and Authorization Service. + © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS29.526, NSSAA Service, version 16.7.0. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.526/ + +servers: + - url: '{apiRoot}/nnssaaf-nssaa/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - nnssaaf-nssaa + +paths: + /slice-authentications: + post: + summary: Create slice authentication context + operationId: CreateSliceAuthenticationContext + tags: + - Slice Authentication Context Creation + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SliceAuthInfo' + required: true + responses: + '201': + description: SliceAuthContext + content: + application/json: + schema: + $ref: '#/components/schemas/SliceAuthContext' + headers: + Location: + +``` + +``` + description: 'Contains the URI of the newly created resource according to the +structure: {apiRoot}/nssaaaf-nssaa/v1/slice-authentications/{authCtxId}' + required: true + schema: + type: string +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + description: Bad Request from the AMF + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' +'403': + description: Forbidden due to slice authentication rejected + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' +'404': + description: User does not exist + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' +'504': + description: Network error or remote peer error + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' +callbacks: + reauthenticationNotification: + '{request.body#/reauthNotifUri}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SliceAuthReauthNotification' +responses: + '204': + description: slice re-authentication notification response + '307': + description: Temporary Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: 'The URI pointing to the resource located on the redirect target' + required: true + schema: + type: string + '308': + description: Permanent Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: 'The URI pointing to the resource located on the redirect target' + required: true + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +``` + +``` + default: + description: Unexpected error + revocationNotification: + '{request.body#/revocNotifUri}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SliceAuthRevocNotification' + responses: + '204': + description: slice revocation notification response + '307': + description: Temporary Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: 'The URI pointing to the resource located on the redirect target' + required: true + schema: + type: string + '308': + description: Permanent Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: 'The URI pointing to the resource located on the redirect target' + required: true + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +/slice-authentications/{authCtxId}: + put: + summary: Confirm the slice authentication result + operationId: ConfirmSliceAuthentication + tags: + - Confirm Slice Authentication + parameters: + - name: authCtxId + in: path + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SliceAuthConfirmationData' + responses: + '200': + description: Request processed (EAP success or Failure) + content: + application/json: + schema: + $ref: '#/components/schemas/SliceAuthConfirmationResponse' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': +``` + +``` + description: Bad Request + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '500': + description: Internal Server Error + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '504': + description: Network error or remote peer error + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + +components: + + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nnssaaaf-nssaa: Access to the nnssaaaf-nssaa API + +schemas: + +# +# COMPLEX TYPES: +# + + SliceAuthInfo: + type: object + properties: + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + eapIdRsp: + $ref: '#/components/schemas/EapMessage' + amfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + reauthNotifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + revocNotifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + required: + - gpsi + - snssai + - eapIdRsp + + SliceAuthContext: + type: object + properties: + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + authCtxId: + $ref: '#/components/schemas/SliceAuthCtxId' + eapMessage: + $ref: '#/components/schemas/EapMessage' + required: + - gpsi + - snssai + - authCtxId + - eapMessage + + SliceAuthConfirmationData: + type: object + properties: + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + snssai: +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + eapMessage: + $ref: '#/components/schemas/EapMessage' + required: + - gpsi + - snssai + - eapMessage + +SliceAuthConfirmationResponse: + type: object + properties: + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + eapMessage: + $ref: '#/components/schemas/EapMessage' + authResult: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AuthStatus' + required: + - gpsi + - snssai + - eapMessage + +SliceAuthReauthNotification: + type: object + properties: + notifType: + $ref: '#/components/schemas/SliceAuthNotificationType' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + required: + - notifType + - gpsi + - snssai + +SliceAuthRevocNotification: + type: object + properties: + notifType: + $ref: '#/components/schemas/SliceAuthNotificationType' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + required: + - notifType + - gpsi + - snssai + +# +# SIMPLE TYPES: +# + +SliceAuthCtxId: + type: string + description: contains the resource ID of slice authentication context + nullable: false + +SliceAuthNotificationType: + type: string + enum: + - SLICE_RE_AUTH + - SLICE_REVOCATION + +EapMessage: + type: string + format: base64 + description: contains an EAP packet + nullable: true +``` + +# Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|---------------------------------------------------------------|------|-----|-----|---------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2020-06 | CT4#98E | C4-203683 | | | | TS skeleton. | 0.1.0 | +| 2020-06 | CT4#98E | C4-202084
C4-202085
C4-202086
C4-203709
C4-203710 | | | | Implementation of pCRs agreed in CT4#98E | 0.2.0 | +| 2020-06 | CT#88e | CP-201193 | | | | TS presented for information and approval. | 1.0.0 | +| 2020-06 | CT#88e | | | | | TS approved at CT#88e | 16.0.0 | +| 2020-09 | CT#89 | CP-202104 | 0005 | 1 | F | Update References | 16.1.0 | +| 2020-09 | CT#89 | CP-202104 | 0007 | 1 | F | Release PDU Session if NSSAA Re-Authentication and Re-Authorization Fails | 16.1.0 | +| 2020-09 | CT#89 | CP-202104 | 0008 | 1 | F | NSSAA status management | 16.1.0 | +| 2020-12 | CT#90 | CP-203054 | 0009 | 2 | F | Amendments for stateless NF support | 16.2.0 | +| 2020-12 | CT#90 | CP-203040 | 0010 | - | F | Remove Editor's Notes on AAA Server Address | 16.2.0 | +| 2020-12 | CT#90 | CP-203048 | 0011 | 1 | F | Storage of YAML files in 3GPP Forge | 16.2.0 | +| 2020-12 | CT#90 | CP-203040 | 0012 | 1 | F | AMF behaviour for NSSAA procedure due to temporal NW failure | 16.2.0 | +| 2020-12 | CT#90 | CP-203036 | 0013 | - | F | API version and External doc update | 16.2.0 | +| 2021-03 | CT#91 | CP-210049 | 0014 | - | F | Incorrect Media Type | 16.3.0 | +| 2021-03 | CT#91 | CP-210054 | 0016 | - | F | 29.526 Rel-16 API version and External doc update | 16.3.0 | +| 2021-06 | CT#92 | CP-211068 | 0017 | 1 | F | Rel-16 Unsuccessful cases for handling of NSSAA status in AMF | 16.4.0 | +| 2021-06 | CT#92 | CP-211068 | 0020 | 1 | F | Rel-16 SUPI in Notifications from NSSAAF | 16.4.0 | +| 2021-06 | CT#92 | CP-211059 | 0022 | 1 | F | Redirect Response | 16.4.0 | +| 2021-06 | CT#92 | CP-211073 | 0025 | - | F | 29.526 Rel-16 API version and External doc update | 16.4.0 | +| 2021-09 | CT#93 | CP-212070 | 0027 | 1 | F | NSSAA procedure from two different AMFs | 16.5.0 | +| 2021-09 | CT#93 | CP-212060 | 0030 | - | F | 3xx description correction for SCP | 16.5.0 | +| 2021-09 | CT#93 | CP-212080 | 0035 | - | F | 29.526 Rel-16 API version and External doc update | 16.5.0 | +| 2021-12 | CT#94 | CP-213139 | 0038 | 1 | F | Correction to Re-Authentication / Revocation Notification Procedure | 16.6.0 | +| 2021-12 | CT#94 | CP-213139 | 0040 | 1 | F | Remove AMF behaviour related to back-off timer from NSSAA procedure | 16.6.0 | +| 2022-03 | CT#95 | CP-220026 | 0052 | 1 | F | 3xx Redirect Response | 16.7.0 | +| 2022-03 | CT#95 | CP-220075 | 0056 | - | F | EAP ID Response message | 16.7.0 | +| 2022-03 | CT#95 | CP-220067 | 0059 | - | F | 29.526 Rel-16 API version and External doc update | 16.7.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29542/0bf9346902e9a3bdabf05ceacc1947f5_img.jpg b/marked/Rel-16/29_series/29542/0bf9346902e9a3bdabf05ceacc1947f5_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..39ffb7f21aeb0112efa4c9b1f720c73e8f72abc1 --- /dev/null +++ b/marked/Rel-16/29_series/29542/0bf9346902e9a3bdabf05ceacc1947f5_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:61fc7cd5bab099556756b363c7d2475176a8f15464fc4c6e1294caee1a6089a4 +size 36106 diff --git a/marked/Rel-16/29_series/29542/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-16/29_series/29542/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..87795019b6a8a8f99cdffe4db14bf49a3882c570 --- /dev/null +++ b/marked/Rel-16/29_series/29542/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:55d9b4603af9184b01c1f4ded15c25aaa29291c6d8ee66fa36a55ac69521f410 +size 9440 diff --git a/marked/Rel-16/29_series/29542/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-16/29_series/29542/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..451f765f142cbc70ccf72e59a4fb25bb9d70a083 --- /dev/null +++ b/marked/Rel-16/29_series/29542/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:372212fbc0a23fe92ee2a59cf7c138e2c3bced180516cd3f351c2fa302ab9e44 +size 5808 diff --git a/marked/Rel-16/29_series/29542/990567efebf979be51f56d1150012c9d_img.jpg b/marked/Rel-16/29_series/29542/990567efebf979be51f56d1150012c9d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1d00b98bd2795eebf6d4207e29a1b8a61b96f4da --- /dev/null +++ b/marked/Rel-16/29_series/29542/990567efebf979be51f56d1150012c9d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1f5a82f94c95dea4295f3fe6cbb44e7617ed2073afac0b7b7ddbf349d8fdabfa +size 22014 diff --git a/marked/Rel-16/29_series/29542/c78c2eefd86269d1740ab85a916f24f2_img.jpg b/marked/Rel-16/29_series/29542/c78c2eefd86269d1740ab85a916f24f2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a406e80a707e045b2a21ccf2a2a853c61f031be0 --- /dev/null +++ b/marked/Rel-16/29_series/29542/c78c2eefd86269d1740ab85a916f24f2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9ddc2aa9f4783c25341961e5e80899953f5208858171358a6bde24401177f982 +size 12135 diff --git a/marked/Rel-16/29_series/29542/raw.md b/marked/Rel-16/29_series/29542/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..cb06e2157acff17f7701fbe536f7e4cb561f22f4 --- /dev/null +++ b/marked/Rel-16/29_series/29542/raw.md @@ -0,0 +1,837 @@ + + +# 3GPP TS 29.542 V16.6.0 (2021-09) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Session Management Services for Non-IP Data Delivery (NIDD); Stage 3 (Release 16)** + +![5G logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The 5G logo, consisting of the text "5G" in a bold, black, sans-serif font. Above the "5" and "G" are three green, curved lines representing signal waves. + +5G logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, featuring the letters "3GPP" in a stylized, bold, black font. The "P" is larger and has a red signal wave icon at its base. Below the logo, the text "A GLOBAL INITIATIVE" is written in a smaller, all-caps, sans-serif font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis + +Valbonne - FRANCE + +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + +--- + + + +# --- ***Copyright Notification*** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2021, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|------------------------------------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions, symbols and abbreviations ..... | 7 | +| 3.1 Terms..... | 7 | +| 3.2 Symbols..... | 7 | +| 3.3 Abbreviations ..... | 7 | +| 4 Overview..... | 7 | +| 4.1 Introduction ..... | 7 | +| 5 Services offered by the SMF for NIDD ..... | 8 | +| 5.1 Introduction ..... | 8 | +| 5.2 Nsmf_NIDD Service ..... | 8 | +| 5.2.1 Service Description ..... | 8 | +| 5.2.2 Service Operations..... | 9 | +| 5.2.2.1 Introduction..... | 9 | +| 5.2.2.2 Delivery ..... | 9 | +| 5.2.2.2.1 General ..... | 9 | +| 6 API Definitions ..... | 9 | +| 6.1 Nsmf_NIDD Service API..... | 9 | +| 6.1.1 Introduction ..... | 9 | +| 6.1.2 Usage of HTTP..... | 10 | +| 6.1.2.1 General..... | 10 | +| 6.1.2.2 HTTP standard headers..... | 10 | +| 6.1.2.2.1 General ..... | 10 | +| 6.1.2.2.2 Content type ..... | 10 | +| 6.1.2.3 HTTP custom headers..... | 11 | +| 6.1.3 Resources..... | 11 | +| 6.1.3.1 Overview..... | 11 | +| 6.1.3.2 Resource: Individual PDU session ..... | 11 | +| 6.1.3.2.1 Description ..... | 11 | +| 6.1.3.2.2 Resource Definition..... | 11 | +| 6.1.3.2.3 Resource Standard Methods..... | 12 | +| 6.1.3.2.4 Resource Custom Operations..... | 12 | +| 6.1.3.2.4.1 Overview ..... | 12 | +| 6.1.3.2.4.2 Operation: deliver..... | 12 | +| 6.1.3.2.4.2.1 Description..... | 12 | +| 6.1.3.2.4.2.2 Operation Definition ..... | 12 | +| 6.1.4 Custom Operations without associated resources ..... | 13 | +| 6.1.5 Notifications ..... | 13 | +| 6.1.6 Data Model ..... | 14 | +| 6.1.6.1 General..... | 14 | +| 6.1.6.2 Structured data types..... | 14 | +| 6.1.6.2.1 Introduction ..... | 14 | +| 6.1.6.2.2 Type: DeliverReqData..... | 14 | +| 6.1.6.2.3 Type: DeliverAddInfo..... | 14 | +| 6.1.6.3 Simple data types and enumerations..... | 15 | +| 6.1.6.3.1 Introduction ..... | 15 | +| 6.1.6.3.2 Simple data types ..... | 15 | +| 6.1.6.4 Data types describing alternative data types or combinations of data types ..... | 15 | +| 6.1.6.4.1 Type: DeliverError ..... | 15 | +| 6.1.6.5 Binary data..... | 15 | +| 6.1.6.5.1 Mobile Terminated Data ..... | 15 | +| 6.1.7 Error Handling ..... | 15 | + +6.1.7.1 General..... 15 +6.1.7.2 Protocol Errors ..... 15 +6.1.7.3 Application Errors..... 16 +6.1.8 Feature negotiation ..... 16 +6.1.9 Security..... 16 +6.1.10 HTTP redirection..... 16 +**Annex A (normative): OpenAPI specification..... 17** +A.1 General ..... 17 +A.2 Nsmf\_NIDD API..... 17 +**Annex B (informative): Change history ..... 20** + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document specifies the stage 3 protocol and data model for the Nsmf Service Based Interfaces for Non-IP Data Delivery (NIDD). It provides stage 3 protocol definitions and message flows, and specifies the API for the service offered by the SMF. + +The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] OpenAPI: "OpenAPI 3.0.0 Specification", . +- [7] 3GPP TR 21.900: "Technical Specification Group working methods". +- [8] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [9] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [10] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". +- [11] IETF RFC 7540: "Hypertext Transfer Protocol Version 2 (HTTP/2)". +- [12] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [13] IETF RFC 7807: "Problem Details for HTTP APIs". + +- [14] 3GPP TS 29.541: "5G System (5GS); Network Exposure (NE) function services for Non-IP Data Delivery (NIDD); Stage 3". +- [15] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Terms + +Void. + +## 3.2 Symbols + +Void. + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|-------|-----------------------------------------| +| 5GC | 5G Core Network | +| AMF | Access and Mobility Management Function | +| H-SMF | Home SMF | +| I-SMF | Intermediate SMF | +| NEF | Network Exposure Function | +| NIDD | Non-IP Data Delivery | +| MT | Mobile Terminated | +| SMF | Session Management Function | +| V-SMF | Visited SMF | + +# --- 4 Overview + +## 4.1 Introduction + +Within the 5GC, the SMF offers services to the AMF, other SMF (V-SMF, H-SMF or I-SMF), PCF and NEF via the Nsmf service based interface (see 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]). + +Figure 4.1-1 provides the reference model (in service based interface representation and in reference point representation), with focus on the SMF and the scope of the present specification. + +![Figure 4.1-1: Reference model – SMF. This diagram shows the SMF (Session Management Function) as a central green box. To its left, four other network functions (AMF, SMF, PCF, and NEF) are shown as boxes. Lines connect each of these four boxes to the central SMF box. The connections are labeled: N11 between AMF and SMF; N16, N16a, and N38 between the left SMF and the central SMF; N7 between PCF and SMF; and N29 between NEF and SMF. The central SMF box has a small circle on its left side labeled 'Nsmf', indicating the service interface.](990567efebf979be51f56d1150012c9d_img.jpg) + +Figure 4.1-1: Reference model – SMF. This diagram shows the SMF (Session Management Function) as a central green box. To its left, four other network functions (AMF, SMF, PCF, and NEF) are shown as boxes. Lines connect each of these four boxes to the central SMF box. The connections are labeled: N11 between AMF and SMF; N16, N16a, and N38 between the left SMF and the central SMF; N7 between PCF and SMF; and N29 between NEF and SMF. The central SMF box has a small circle on its left side labeled 'Nsmf', indicating the service interface. + +**Figure 4.1-1: Reference model – SMF** + +N29 is the reference point between the (H-)SMF and the NEF. + +The functionalities supported by the SMF are listed in clause 6.2.2 of 3GPP TS 23.501 [2]. + +# 5 Services offered by the SMF for NIDD + +## 5.1 Introduction + +The SMF supports the following service(s) for NIDD. + +**Table 5.1-1: NF Service(s) provided by SMF for NIDD** + +| Service Name | Description | Example Consumer | +|--------------|---------------------------------------------------------------------------------|------------------| +| Nsmf_NIDD | This service allows the NF consumer NF to deliver NIDD MT data to PDU sessions. | NEF | + +## 5.2 Nsmf\_NIDD Service + +### 5.2.1 Service Description + +The Nsmf\_NIDD service operates on the PDU Sessions. The service operations exposed by this service allow an NF consumer (i.e. NEF) to deliver NEF anchored Mobile Terminated (MT) data for a given PDU session of a UE towards the SMF. + +The Nsmf\_NIDD service supports the following service operations: + +**Table 5.2.1-1: Service operations supported by the Nsmf\_NIDD service** + +| Service Operations | Description | Operation Semantics | Example Consumer(s) | +|--------------------|---------------------------------------------------------|---------------------|---------------------| +| Delivery | Deliver MT NIDD user data to the PDU session of the UE. | Request/Response | NEF | + +### 5.2.2 Service Operations + +#### 5.2.2.1 Introduction + +See Table 5.2.1-1 for an overview of the service operations supported by the Nsmf\_NIDD service. + +#### 5.2.2.2 Delivery + +##### 5.2.2.2.1 General + +The Delivery service operation shall be used to transfer NEF anchored MT data for a given PDU session. + +It is used in the following procedures: + +- NEF anchored Mobile Terminated Data Transport (see clause 4.25.5 of 3GPP TS 23.502 [3]). + +The NF Service Consumer (i.e. NEF) shall deliver MT data to the SMF by using the HTTP POST method ("deliver" custom operation) as shown in Figure 5.2.2.2.1-1. + +![Sequence diagram showing the transfer of MT data from NF Service Consumer to SMF. Step 1: POST request with DeliverReqData. Step 2a: 204 No Content response. Step 2b: 4xx/5xx (DeliverError/ProblemDetails) or 3xx response.](0bf9346902e9a3bdabf05ceacc1947f5_img.jpg) + +``` + +sequenceDiagram + participant NFSC as NF Service Consumer + participant SMF + Note left of NFSC: 1. POST ../pdu-sessions/{pduSessionRef}/deliver (DeliverReqData) + NFSC->>SMF: Request + Note right of SMF: 2a. 204 No Content + SMF-->>NFSC: Response 2a + Note right of SMF: 2b. 4xx/5xx (DeliverError/ProblemDetails) or 3xx + SMF-->>NFSC: Response 2b + +``` + +Sequence diagram showing the transfer of MT data from NF Service Consumer to SMF. Step 1: POST request with DeliverReqData. Step 2a: 204 No Content response. Step 2b: 4xx/5xx (DeliverError/ProblemDetails) or 3xx response. + +Figure 5.2.2.2.1-1: Transfer MT Data + +1. The NF Service Consumer shall send a POST request to the URI of "deliver" custom operation on an Individual PDU session resource in the SMF. The payload body of the POST request shall contain the MT data to be delivered. + +NOTE: The URI of the individual PDU session resource is provided by SMF to the NEF during SMF-NEF connection creation (see clause 5.2.2.2.1 of 3GPP TS 29.541 [14]). + +- 2a. On success, "204 No Content" shall be returned. + +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.2.4.2.2-2 shall be returned. For a 4xx/5xx response, the message body may contain a DeliverError or ProblemDetails object, with the "cause" attribute indicating the cause of the failure. If Estimated Maximum Waiting Time is received from AMF, the SMF shall include it in the message body. + +# 6 API Definitions + +## 6.1 Nsmf\_NIDD Service API + +### 6.1.1 Introduction + +The Nsmf\_NIDD service shall use the Nsmf\_NIDD API. + +The API URI of the Nsmf\_NIDD API shall be: + +{apiRoot}
// + +The request URI used in HTTP request from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}///** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nsmf-nidd". +- The shall be "v1". +- The shall be set as described in clause 6.1.3. + +### 6.1.2 Usage of HTTP + +#### 6.1.2.1 General + +HTTP/2, IETF RFC 7540 [11], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +The OpenAPI [6] specification of HTTP messages and content bodies for the Nsmf\_NIDD API is contained in Annex A. + +#### 6.1.2.2 HTTP standard headers + +##### 6.1.2.2.1 General + +The usage of HTTP standard headers shall be supported as specified in clause 5.2.2 of 3GPP TS 29.500 [4]. + +##### 6.1.2.2.2 Content type + +The following content types shall be supported: + +- the JSON format (IETF RFC 8259 [12]). The use of the JSON format shall be signalled by the content type "application/json". See also clause 5.4 of 3GPP TS 29.500 [4]. +- the Problem Details JSON Object (IETF RFC 7807 [13]). The use of the Problem Details JSON object in a HTTP response body shall be signalled by the content type "application/problem+json". + +NOTE: "application/json" is used in a response that includes a payload body containing an application-specific data structure, see clause 4.8 of 3GPP TS 29.501 [5]. + +Multipart messages shall also be supported (see clause 6.1.2.4) using the content type "multipart/related", comprising: + +- one JSON body part with the "application/json" content type; and +- one or two binary body parts with 3gpp vendor specific content subtypes. + +The 3gpp vendor specific content subtypes defined in Table 6.1.2.2.2-1 shall be supported. + +**Table 6.1.2.2.2-1: 3GPP vendor specific content subtypes** + +| content subtype | Description | +|-----------------|-------------------------------------------------------------------------------------------------------| +| vnd.3gpp.5gnas | Binary encoded payload, encoding a 5GS NAS message or 5G NAS IEs, as specified in 3GPP TS 24.501 [7]. | + +See clause 6.1.6.5 for the binary payloads supported in the binary body part of multipart messages. + +#### 6.1.2.3 HTTP custom headers + +In this release of the specification, no specific custom headers are defined for the Nsmf\_NIDD service. + +For 3GPP specific HTTP custom headers used across all service based interfaces, see clause 5.2.3 of 3GPP TS 29.500 [4]. + +### 6.1.3 Resources + +#### 6.1.3.1 Overview + +Figure 6.1.3.1-1 describes the resource URI structure of the Nsmf\_NIDD API. + +![Figure 6.1.3.1-1: Resource URI structure of the Nsmf_NIDD API. The diagram shows a hierarchical tree structure of URI paths. The root is {apiRoot}/nsmf-nidd/. It branches to /pdu-sessions, which branches to /{pduSessionRef}, which in turn branches to /deliver. The /deliver path is enclosed in a dashed box.](c78c2eefd86269d1740ab85a916f24f2_img.jpg) + +``` + + {apiRoot}/nsmf-nidd/ + | + +-- /pdu-sessions + | + +-- /{pduSessionRef} + | + +-- /deliver + +``` + +Figure 6.1.3.1-1: Resource URI structure of the Nsmf\_NIDD API. The diagram shows a hierarchical tree structure of URI paths. The root is {apiRoot}/nsmf-nidd/. It branches to /pdu-sessions, which branches to /{pduSessionRef}, which in turn branches to /deliver. The /deliver path is enclosed in a dashed box. + +**Figure 6.1.3.1-1: Resource URI structure of the Nsmf\_NIDD API** + +Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.1.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|------------------------|---------------------------------------|---------------------------------|----------------------------| +| Individual PDU session | /pdu-sessions/{pduSessionRef}/deliver | deliver (POST) | Delivery Service Operation | + +#### 6.1.3.2 Resource: Individual PDU session + +##### 6.1.3.2.1 Description + +This resource represents an individual PDU session created in SMF for NIDD. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [5]). + +##### 6.1.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nsmf-nidd//pdu-sessions/{pduSessionRef} + +This resource shall support the resource URI variables defined in table 6.1.3.2.2-1. + +**Table 6.1.3.2.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------------|-------------------------------------------------------------------------------| +| apiRoot | See clause 6.1.1 | +| apiVersion | See clause 6.1.1 | +| pduSessionRef | PDU session reference assigned by the SMF during SMF-NEF Connection creation. | + +##### 6.1.3.2.3 Resource Standard Methods + +None. + +##### 6.1.3.2.4 Resource Custom Operations + +###### 6.1.3.2.4.1 Overview + +**Table 6.1.3.2.4.1-1: Custom operations** + +| Custom operation URI | Mapped HTTP method | Description | +|-----------------------|--------------------|-----------------------------| +| {resourceUri}/deliver | POST | Delivery service operation. | +| | | | + +###### 6.1.3.2.4.2 Operation: deliver + +###### 6.1.3.2.4.2.1 Description + +This custom operation enables to deliver NEF anchored MT data for a given PDU session towards the SMF. + +###### 6.1.3.2.4.2.2 Operation Definition + +This operation shall support the request data structures specified in table 6.1.3.2.4.2.2-1 and the response data structure and response codes specified in table 6.1.3.2.4.2.2-2. + +**Table 6.1.3.2.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------|---|-------------|----------------------------------------------------| +| DeliverReqData | M | 1 | Representation of the payload of a Deliver Request | + +**Table 6.1.3.2.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful delivery of MT data. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same SMF or SMF (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same SMF or SMF (service) set. | +| DeliverError | O | 0..1 | 504 Gateway Timeout | The "cause" attribute may be used to indicate the following application errors:
- UE_NOT_REACHABLE, if the UE is not reachable to deliver the mobile terminated data; if Estimated Maximum Waiting Time shall be included if available;

See table 6.1.7.3-1 for the description of these errors. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type when needed (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +**Table 6.1.3.2.4.2.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same SMF or SMF (service) set. Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.2.4.2.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same SMF or SMF (service) set. Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +### 6.1.4 Custom Operations without associated resources + +None + +### 6.1.5 Notifications + +None. + +### 6.1.6 Data Model + +#### 6.1.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.1.6.1-1 specifies the data types defined for the Nsmf\_NIDD service based interface protocol. + +**Table 6.1.6.1-1: Nsmf\_NIDD specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|----------------|----------------|-----------------------------------------------|---------------| +| DeliverReqData | 6.1.6.2.2 | Information within Deliver Request | | +| DeliverAddInfo | 6.1.6.2.3 | Deliver Error Response Additional Information | | +| DeliverError | 6.1.6.4.1 | Deliver Error Response | | + +Table 6.1.6.1-2 specifies data types re-used by the N service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the N service based interface. + +**Table 6.1.6.1-2: Nsmf\_NIDD re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|------------------|---------------------|------------------------------------------------------------------------------------------------|---------------| +| RefToBinaryData | 3GPP TS 29.571 [15] | Cross-Reference to binary data encoded within a binary body part in an HTTP multipart message. | | +| ProblemDetails | 3GPP TS 29.571 [15] | Error description | | +| DurationSec | 3GPP TS 29.571 [15] | Duration in units of seconds | | +| RedirectResponse | 3GPP TS 29.571 [15] | Redirect Response | | + +#### 6.1.6.2 Structured data types + +##### 6.1.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.1.6.2.2 Type: DeliverReqData + +**Table 6.1.6.2.2-1: Definition of type DeliverReqData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------|---|-------------|----------------------------------------------------------------------------|---------------| +| mtData | RefToBinaryData | M | 1 | This IE shall reference the Mobile Terminated Data (see clause 6.1.6.5.1). | | + +##### 6.1.6.2.3 Type: DeliverAddInfo + +**Table 6.1.6.2.3-1: Definition of type DeliverAddInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------|---|-------------|-----------------------------------------------------------------------------------------------|---------------| +| maxWaitingTime | DurationSec | C | 0..1 | This IE shall contain the estimated maximum wait time (see clause 4.25.5 of 3GPP 23.502 [3]). | | + +#### 6.1.6.3 Simple data types and enumerations + +##### 6.1.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 6.1.6.3.2 Simple data types + +The simple data types defined in table 6.1.6.3.2-1 shall be supported. + +**Table 6.1.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| | | | | + +#### 6.1.6.4 Data types describing alternative data types or combinations of data types + +##### 6.1.6.4.1 Type: DeliverError + +**Table 6.1.6.4.1-1: Definition of type DeliverError as a list of "to be combined data types"** + +| Data type | Cardinality | Description | Applicability | +|-----------------|-------------|----------------------------------------------------------|---------------| +| ProblemDetails | 1 | Detail information of the problem | | +| DeliverAddlInfo | 1 | Additional information to be returned in error response. | | + +#### 6.1.6.5 Binary data + +##### 6.1.6.5.1 Mobile Terminated Data + +Mobile Terminated Data shall encode the Data Contents of the Payload Container specified in 3GPP TS 24.501 [7], using the vnd.3gpp.5gnas content-type, as summarized in Table 6.1.6.5.1-1. + +**Table 6.1.6.5.1-1: Mobile Terminated Data** + +| Mobile Terminated Data | Reference (3GPP TS 24.501 [7]) | Related NAS SM message | +|---------------------------------------------|--------------------------------|------------------------| +| Payload container contents in octets 4 to n | 9.11.3.39 | DL NAS Transport | + +### 6.1.7 Error Handling + +#### 6.1.7.1 General + +For the Nsmf\_NIDD API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [4] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [4]. + +In addition, the requirements in the following clauses are applicable for the Nsmf\_NIDD API. + +#### 6.1.7.2 Protocol Errors + +No specific procedures for the Nsmf\_NIDD service are specified. + +#### 6.1.7.3 Application Errors + +The common application errors defined in Table 5.2.7.2-1 of 3GPP TS 29.500 [4] may be used for the Nsmf\_NIDD service. + +The application errors defined for the Nsmf\_NIDD service are listed in Table 6.1.7.3-1. + +**Table 6.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|---------------------|------------------------------------------| +| UE_NOT_REACHABLE | 504 Gateway Timeout | The UE is not reachable for the service. | + +### 6.1.8 Feature negotiation + +The optional features in table 6.1.8-1 are defined for the Nsmf\_NIDD API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.1.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +### 6.1.9 Security + +As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Nsmf\_NIDD API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [9]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [10]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nsmf\_NIDD API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [10], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nsmf\_NIDD service. + +The Nsmf\_NIDD API defines scopes for OAuth2 authorization as specified in 3GPP TS 33.501 [15]; it defines a single scope consisting on the name of the service (i.e., "nsmf-nidd"), and it does not define any additional scopes at resource or operation level. + +### 6.1.10 HTTP redirection + +An HTTP request may be redirected to a different SMF service instance, within the same SMF or a different SMF of an SMF set, e.g. when an SMF service instance is part of an SMF (service) set or when using indirect communications (see 3GPP TS 29.500 [4]). + +An SCP that reselects a different SMF producer instance will return the NF Instance ID of the new SMF producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an SMF within an SMF set redirects a service request to a different SMF of the set using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new SMF towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +# Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex specifies the formal definition of the Nsmf\_NIDD Service API. It consists of OpenAPI 3.0.0 specifications, in YAML format. + +This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository, that uses the GitLab software version control system (see 3GPP TS 29.501 [5] clause 5.3.1 and 3GPP TR 21.900 [7] clause 5B). + +## A.2 Nsmf\_NIDD API + +``` +openapi: 3.0.0 + +info: + version: '1.0.2' + title: 'Nsmf_NIDD' + description: | + SMF NIDD Service. + © 2021, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.542 V16.5.0; 5G System; Session Management Services for Non-IP Data + Delivery (NIDD); Stage 3 + url: http://www.3gpp.org/ftp/Specs/archive/29_series/29.542/ + +servers: + - url: '{apiRoot}/nsmf-nidd/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. + +security: + - {} + - oAuth2ClientCredentials: + - nsmf-nidd + +paths: + '/pdu-sessions/{pduSessionRef}/deliver': + post: + summary: Delivery Service Operation + tags: + - Individual PDU session + operationId: Deliver + parameters: + - name: pduSessionRef + in: path + description: PDU session reference + required: true + schema: + type: string + requestBody: + description: representation of the payload of Deliver Request + required: true + content: + multipart/related: # message with a binary body part +``` + +``` + + schema: + type: object + properties: + jsonData: + $ref: '#/components/schemas/DeliverReqData' + binaryMtData: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryMtData: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + responses: + '204': + description: successful transfering of Delivery + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + description: unsuccessful delivery of mobile terminated data - gateway timeout + content: + application/json: + schema: + $ref: '#/components/schemas/DeliverError' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nsmf-nidd: Access to the nsmf-nidd API + +schemas: +# +# STRUCTURED DATA TYPES +# + + DeliverReqData: + type: object + properties: + mtData: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + required: + - mtData + + DeliverAddInfo: + type: object + +``` + +``` +properties: + maxWaitingTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' +``` + +``` +# +# DATA TYPES DESCRIBING ALTERNATIVE OR COMBINATION OF DATA TYPES +# +``` + +``` +DeliverError: + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + - $ref: '#/components/schemas/DeliverAddInfo' +``` + +# Annex B (informative): Change history + +| Change history | | | | | | | | | +|----------------|----------|-----------|------|-----|-----|---------------------------------------------------|--|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | | New version | +| 2020-03 | CT4#96-e | C4-201267 | | | | Initial Draft. | | 0.1.0 | +| 2020-03 | CT#87e | CP-200093 | | | | Presented for information and approval | | 1.0.0 | +| 2020-03 | CT#87e | | | | | Approved at CT#87e | | 16.0.0 | +| 2020-06 | CT#88e | CP-201071 | 0001 | 2 | F | Storage of YAML files in ETSI Forge | | 16.1.0 | +| 2020-06 | CT#88e | CP-201046 | 0003 | | F | Miscellaneous Corrections | | 16.1.0 | +| 2020-06 | CT#88e | CP-201073 | 0004 | | F | 29.542 Rel-16 API version and External doc update | | 16.1.0 | +| 2020-09 | CT#89e | CP-202105 | 0005 | | F | Optionality of DeliverError | | 16.2.0 | +| 2020-12 | CT#90e | CP-203032 | 0007 | | F | YAML files in 3GPP Forge | | 16.3.0 | +| 2021-03 | CT#91e | CP-210037 | 0010 | 1 | F | HTTP 3xx redirection | | 16.4.0 | +| 2021-03 | CT#91e | CP-210054 | 0013 | - | F | 29.542 Rel-16 API version and External doc update | | 16.4.0 | +| 2021-06 | CT#92e | CP-210059 | 0016 | 1 | F | Redirect Response | | 16.5.0 | +| 2021-06 | CT#92e | CP-210073 | 0019 | | F | 29.542 Rel-16 API version and External doc update | | 16.5.0 | +| 2021-09 | CT#93e | CP-212060 | 0020 | - | F | 3xx description correction for SCP | | 16.6.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29544/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-16/29_series/29544/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..555b7eeb04d7ce96b8e7b1bdeaa53187010fe6f2 --- /dev/null +++ b/marked/Rel-16/29_series/29544/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4380fcea70d59cdbc693a86433b08c3ce4371663e824fcb121f6869bc51a0939 +size 7613 diff --git a/marked/Rel-16/29_series/29544/6078636a87fbe0e699aab4a6fddd15d7_img.jpg b/marked/Rel-16/29_series/29544/6078636a87fbe0e699aab4a6fddd15d7_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9dbd4e1ad0ff40329e67eab5b23ba098139cd60c --- /dev/null +++ b/marked/Rel-16/29_series/29544/6078636a87fbe0e699aab4a6fddd15d7_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3b29ac30b665a06f80b9284c81d50c0321732ab49eb2c9d5636651ae2276ae8a +size 12775 diff --git a/marked/Rel-16/29_series/29544/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-16/29_series/29544/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..97c6eddb41716196348ba84d7e050c79c1628a1b --- /dev/null +++ b/marked/Rel-16/29_series/29544/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5a32a38d007dfdd63c7288a35e36672be5f03ddbbdd3df4a02e20acb60a47b3a +size 5795 diff --git a/marked/Rel-16/29_series/29544/ca7c7526ec57cd5a2f278c194c0a6a00_img.jpg b/marked/Rel-16/29_series/29544/ca7c7526ec57cd5a2f278c194c0a6a00_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..077bfa96569f13cd828fb839792d06386d1f24b5 --- /dev/null +++ b/marked/Rel-16/29_series/29544/ca7c7526ec57cd5a2f278c194c0a6a00_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b8387b98967669d6384e0e14bc1f3f882d94d44b773edf7b0f2382367ae967e8 +size 16666 diff --git a/marked/Rel-16/29_series/29544/e6df2733626a85205c1db682e6259c46_img.jpg b/marked/Rel-16/29_series/29544/e6df2733626a85205c1db682e6259c46_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..470e6b2e6482d945865263a469f5c8bb4c2a8a86 --- /dev/null +++ b/marked/Rel-16/29_series/29544/e6df2733626a85205c1db682e6259c46_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a9099345621baf6f111c97a367a34e7cc402b562bf389ba4a6beba5e1635cb7e +size 32950 diff --git a/marked/Rel-16/29_series/29544/raw.md b/marked/Rel-16/29_series/29544/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..c4b190c781a610af9996c943032c8670fbbc4200 --- /dev/null +++ b/marked/Rel-16/29_series/29544/raw.md @@ -0,0 +1,698 @@ + + +# 3GPP TS 29.544 V16.3.0 (2020-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Secured Packet Application Function (SP-AF) Services; Stage 3 (Release 16)** + +![5G logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The 5G logo, consisting of the text "5G" in a bold, black, sans-serif font. Above the "5G" text is a green graphic element consisting of three curved lines, resembling a signal strength indicator or a stylized wave. + +5G logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, featuring the letters "3GPP" in a stylized, bold, black font. The "3" and "G" are connected at the top by a horizontal line. Below the "P" is a red graphic element consisting of three curved lines, resembling a signal strength indicator or a stylized wave. To the right of the "P" is a small "TM" symbol. + +3GPP logo + +A GLOBAL INITIATIVE + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + +--- + + + +# --- ***Copyright Notification*** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions, symbols and abbreviations ..... | 8 | +| 3.1 Terms..... | 8 | +| 3.2 Symbols..... | 8 | +| 3.3 Abbreviations ..... | 8 | +| 4 Overview..... | 8 | +| 4.1 Introduction ..... | 8 | +| 5 Services offered by the SP-AF..... | 9 | +| 5.1 Introduction ..... | 9 | +| 5.2 Nspaf_SecuredPacket Service..... | 9 | +| 5.2.1 Service Description ..... | 9 | +| 5.2.2 Service Operations..... | 9 | +| 5.2.2.1 Introduction..... | 9 | +| 5.2.2.2 Provide ..... | 9 | +| 5.2.2.2.1 General ..... | 9 | +| 5.2.2.2.2 Secured Packet Retrieval..... | 9 | +| 6 API Definitions ..... | 10 | +| 6.1 Nspaf_SecuredPacket Service API ..... | 10 | +| 6.1.1 Introduction ..... | 10 | +| 6.1.2 Usage of HTTP..... | 10 | +| 6.1.2.1 General..... | 10 | +| 6.1.2.2 HTTP standard headers..... | 11 | +| 6.1.2.2.1 General ..... | 11 | +| 6.1.2.2.2 Content type ..... | 11 | +| 6.1.2.3 HTTP custom headers..... | 11 | +| 6.1.3 Resources..... | 11 | +| 6.1.3.1 Overview..... | 11 | +| 6.1.3.2 Resource: SecuredPacket..... | 12 | +| 6.1.3.2.1 Description ..... | 12 | +| 6.1.3.2.2 Resource Definition..... | 12 | +| 6.1.3.2.3 Resource Standard Methods..... | 12 | +| 6.1.3.2.4 Resource Custom Operations..... | 12 | +| 6.1.3.2.4.1 Overview ..... | 12 | +| 6.1.3.2.4.2 Operation: provide-secured-packet..... | 12 | +| 6.1.3.2.4.2.1 Description..... | 12 | +| 6.1.3.2.4.2.2 Operation Definition..... | 12 | +| 6.1.4 Custom Operations without associated resources ..... | 13 | +| 6.1.5 Notifications ..... | 13 | +| 6.1.6 Data Model ..... | 13 | +| 6.1.6.1 General..... | 13 | +| 6.1.6.2 Structured data types..... | 13 | +| 6.1.6.2.1 Introduction ..... | 13 | +| 6.1.6.2.2 Type: UiccConfigurationParameter ..... | 14 | +| 6.1.6.3 Simple data types and enumerations..... | 14 | +| 6.1.6.3.1 Introduction ..... | 14 | +| 6.1.6.3.2 Simple data types ..... | 14 | +| 6.1.7 Error Handling..... | 14 | +| 6.1.7.1 General..... | 14 | +| 6.1.7.2 Protocol Errors ..... | 14 | +| 6.1.7.3 Application Errors..... | 14 | +| 6.1.8 Feature negotiation..... | 14 | + +| | | | +|-------------------------------|------------------------------------|-----------| +| 6.1.9 | Security..... | 15 | +| Annex A (normative): | OpenAPI specification ..... | 16 | +| A.1 | General ..... | 16 | +| A.2 | Nspaf_SecuredPacket API ..... | 16 | +| Annex B (informative): | Change history ..... | 18 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document specifies the stage 3 protocol and data model for the Nspaf Service Based Interface. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the SP-AF. + +The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] OpenAPI: "OpenAPI 3.0.0 Specification", . +- [7] 3GPP TR 21.900: "Technical Specification Group working methods". +- [8] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [9] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [10] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". +- [11] IETF RFC 7540: "Hypertext Transfer Protocol Version 2 (HTTP/2)". +- [12] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [13] IETF RFC 7807: "Problem Details for HTTP APIs". +- [14] 3GPP TS 29.503: "Unified Data Management Services"; Stage 3. +- [15] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces Stage 3". +- [16] 3GPP TS 31.115: "Secured packet structure for (Universal) Subscriber Identity Module (U)SIM Toolkit applications". +- [17] 3GPP TS 29.509: "Authentication Server Services; Stage 3". +- [18] 3GPP TS 23.040: "Technical realization of the Short Message Service (SMS)" + +# 3 Definitions, symbols and abbreviations + +## 3.1 Terms + +Void. + +## 3.2 Symbols + +Void. + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|--------|------------------------------------------| +| OTA | Over The Air | +| SOR-AF | Steering Of Roaming Application Function | +| SP-AF | Secured Packet Application Function | +| UDM | Unified Data Management | + +# 4 Overview + +## 4.1 Introduction + +Within the 5GC, the SP-AF offers services to the UDM and to the SOR-AF via the Nspaf service based interface. + +The UDM or SOR-AF shall make use of the SP-AF services when it needs to protect UE parameters for which the final consumer is the USIM (see 3GPP TS 33.501 [8] clause 6.15.2.1). + +Figure 4.1-1 provides the reference model with focus on the SP-AF. + +NOTE: The generation of the secured packet and the definition of the storage and handling of OTA keys or other sensitive data are out of scope of this document. For more details, refer to 3GPP TS 23.040 [18] and 3GPP TS 31.115 [16]. + +![Reference model diagram showing UDM and SOR-AF connected to SP-AF via the Nspaf interface.](6078636a87fbe0e699aab4a6fddd15d7_img.jpg) + +``` +graph LR; UDM[UDM] --- Nspaf((Nspaf)); SOR-AF[SOR-AF] --- Nspaf; Nspaf --- SP-AF[SP-AF]; style SP-AF fill:#90EE90,stroke:#000 +``` + +The diagram illustrates the reference model for the SP-AF. On the left, two rectangular boxes represent the UDM (Unified Data Management) and the SOR-AF (Steering Of Roaming Application Function). Lines from both boxes converge to a central point labeled 'Nspaf', which is represented by a small circle. From this 'Nspaf' circle, a line extends to a larger rectangular box on the right labeled 'SP-AF' (Secured Packet Application Function). The 'SP-AF' box is highlighted with a light green fill. + +Reference model diagram showing UDM and SOR-AF connected to SP-AF via the Nspaf interface. + +Figure 4.1-1: Reference model – SP-AF + +# 5 Services offered by the SP-AF + +## 5.1 Introduction + +The SP-AF offers the following services via the Nspaf interface: + +- Nspaf\_SecuredPacket Service + +Table 5.1-1 summarizes the corresponding APIs defined for this specification. + +**Table 5.1-1: API Descriptions** + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Anne
x | +|---------------------|--------|------------------------------|-----------------------------------|----------------------|-----------| +| Nspaf_SecuredPacket | 6.1 | Nspaf Secured Packet Service | TS29544_Nspaf_SecuredPacket .yaml | nspaf-secured-packet | A.2 | + +## 5.2 Nspaf\_SecuredPacket Service + +### 5.2.1 Service Description + +The Nspaf\_SecuredPacket Service may be consumed by the NF consumer (e.g. UDM or SOR-AF) when it has detected that a UICC configuration parameter (e.g. Routing ID data or Steering of Roaming information) needs to be updated, and the new value is not available in secured packet format. + +For the list of service operations see clause 5.2.2.1 + +### 5.2.2 Service Operations + +#### 5.2.2.1 Introduction + +For the Nspaf\_SecuredPacket service the following service operations are defined: + +- Provide + +The Nspaf\_SecuredPacket Service is used by Consumer NFs (e.g. UDM or SOR-AF) to request the SP-AF to provide a secured packet that contains an UICC configuration parameter as sent in the request by means of the Provide service operation + +#### 5.2.2.2 Provide + +##### 5.2.2.2.1 General + +This service operation is used by the NF Service Consumer (e.g. UDM or SOR-AF) to request construction of a secured packet that contains the provided UICC configuration information (e.g. Routing Indicator or Steering of Roaming information). + +The following procedures using the Provide service operation are supported: + +- Secured Packet Retrieval + +##### 5.2.2.2.2 Secured Packet Retrieval + +Figure 5.2.2.2.2-1 shows a scenario where the NF consumer (e.g. UDM or SOR-AF) sends a request to the SP-AF to provide a secured packet. + +The request contains the UE's identity (/{supi}) and the UICC configuration parameter. + +![Sequence diagram showing the interaction between an NF-consumer and an SP-AF. The NF-consumer sends a POST request to the SP-AF. The SP-AF responds with either a 200 OK (SecuredPacket) or a 404 Not Found.](e6df2733626a85205c1db682e6259c46_img.jpg) + +``` + +sequenceDiagram + participant NF-consumer + participant SP-AF + Note left of NF-consumer: 1. POST.../{supi}/provide-secured-packet (UiccConfigurationParameter) + NF-consumer->>SP-AF: Request + Note right of SP-AF: 2a. 200 OK (SecuredPacket) +2b. 404 Not Found + SP-AF-->>NF-consumer: Response + +``` + +Sequence diagram showing the interaction between an NF-consumer and an SP-AF. The NF-consumer sends a POST request to the SP-AF. The SP-AF responds with either a 200 OK (SecuredPacket) or a 404 Not Found. + +**Figure 5.2.2.2.2-1: NF consumer requests the SP-AF to provide a secured packet** + +1. The NF consumer sends a POST request (custom method: provide-secured-packet) to the resource representing the SUPI. +- 2a. On success, the SP-AF responds with "200 OK", containing the requested SecuredPacket. +- 2b. If the resource does not exist (the supi is unknown in the SP-AF), the SP-AF returns the HTTP status code "404 Not Found", and additional error information should be included in the response body (in "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +# 6 API Definitions + +## 6.1 Nspaf\_SecuredPacket Service API + +### 6.1.1 Introduction + +The Nspaf\_SecuredPacket service shall use the Nspaf\_SecuredPacket API. + +The request URI used in HTTP request from the NF service consumer towards the NF service producer shall have the structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}
** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nspaf-secured-packet". +- The shall be "v1". +- The shall be set as described in clause 6.1.3. + +### 6.1.2 Usage of HTTP + +#### 6.1.2.1 General + +HTTP/2, IETF RFC 7540 [11], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +The OpenAPI [6] specification of HTTP messages and content bodies for the Nspaf\_SecuredPacket API is contained in Annex A. + +#### 6.1.2.2 HTTP standard headers + +##### 6.1.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers. + +##### 6.1.2.2.2 Content type + +JSON, IETF RFC 8259 [12], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [4]. The use of the JSON format shall be signalled by the content type "application/json". + +"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 7807 [13]. + +#### 6.1.2.3 HTTP custom headers + +The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] shall be applicable. + +### 6.1.3 Resources + +#### 6.1.3.1 Overview + +![Figure 6.1.3.1-1: Resource URI structure of the nspaf-secured-packet API. The diagram shows a hierarchical tree structure of URI components. The root node is '{apiRoot}/nspaf-secured-packet/'. A line descends from this root to a second-level node, which is '{/supi}'. From this second-level node, a line descends to a third-level node, which is '/provide-secured-packet'. This third-level node is enclosed in a dashed rectangular box, indicating it is the specific resource being defined.](ca7c7526ec57cd5a2f278c194c0a6a00_img.jpg) + +Figure 6.1.3.1-1: Resource URI structure of the nspaf-secured-packet API. The diagram shows a hierarchical tree structure of URI components. The root node is '{apiRoot}/nspaf-secured-packet/'. A line descends from this root to a second-level node, which is '{/supi}'. From this second-level node, a line descends to a third-level node, which is '/provide-secured-packet'. This third-level node is enclosed in a dashed rectangular box, indicating it is the specific resource being defined. + +**Figure 6.1.3.1-1: Resource URI structure of the nspaf-secured-packet API** + +Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.1.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|----------------------------------|---------------------------------|---------------------------------|--------------------------------------------------------------------------------------------| +| SecuredPacket (Custom operation) | /{/supi}/provide-secured-packet | Provide-secured-packet (POST) | The SP-AF generates a secured packet containing the presented UICC configuration parameter | + +#### 6.1.3.2 Resource: SecuredPacket + +##### 6.1.3.2.1 Description + +This resource represents the information that is needed to construct secured packets for the SUPI. + +##### 6.1.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nspaf-secured-packet/v1/{supi}/provide-secured-packet + +This resource shall support the resource URI variables defined in table 6.1.3.2.2-1. + +**Table 6.1.3.2.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|-------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.1.1 | +| supi | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: "^(imsi-[0-9]{5,15} nai-.[+])\$" | + +##### 6.1.3.2.3 Resource Standard Methods + +No Standard Methods are supported for this resource. + +##### 6.1.3.2.4 Resource Custom Operations + +###### 6.1.3.2.4.1 Overview + +**Table 6.1.3.2.4.1-1: Custom operations** + +| Custom operation URI | Mapped HTTP method | Description | +|-------------------------|--------------------|-------------------------------------------------------------------------------------------------------------| +| /provide-secured-packet | POST | The SP-AF generates a secured packet for the SUPI that contains the presented UICC configuration parameter. | + +###### 6.1.3.2.4.2 Operation: provide-secured-packet + +###### 6.1.3.2.4.2.1 Description + +This custom operation is used by the NF service consumer (e.g. UDM) to request a secured packet for the SUPI containing the presented UICC configuration parameter. The returned secured packet shall be constructed as an SMS-Deliver as specified in 3GPP TS 23.040 [18] and protected as specified in 3GPP TS 31.115 [16]. + +###### 6.1.3.2.4.2.2 Operation Definition + +This operation shall support the request data structures specified in table 6.1.3.2.4.2.2-1 and the response data structure and response codes specified in table 6.1.3.2.4.2.2-2. + +**Table 6.1.3.2.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------------|---|-------------|----------------------------------------------------------| +| UiccConfiguration Parameter | M | 1 | Contains the parameter that is to be updated in the UICC | + +**Table 6.1.3.2.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------| +| SecuredPacket | M | 1 | 200 OK | Upon success, a response body containing the generated secured packet shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to convey the following application error:
- USER NOT FOUND | +| NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +### 6.1.4 Custom Operations without associated resources + +In this release of this specification, no custom operations without associated resources are defined for the Nspaf\_SecuredPacket Service. + +### 6.1.5 Notifications + +In this release of this specification, no notifications are defined for the Nspaf\_SecuredPacket Service. + +### 6.1.6 Data Model + +#### 6.1.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.1.6.1-1 specifies the data types defined for the Nspaf service based interface protocol. + +**Table 6.1.6.1-1: Nspaf specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|----------------------------|----------------|-------------------------------|---------------| +| UiccConfigurationParameter | 6.1.6.2.2 | UICC Configuration Parameters | | +| RoutingId | 6.1.6.3.2 | Routing ID | | + +Table 6.1.6.1-2 specifies data types re-used by the Nspaf service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nspaf service based interface. + +**Table 6.1.6.1-2: Nspaf re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|----------------|---------------------|----------------------|---------------| +| SecuredPacket | 3GPP TS 29.503 [14] | Secured Packet | | +| ProblemDetails | 3GPP TS 29.571 [15] | | | +| SteeringInfo | 3GPP TS 29.509 [17] | Steering Information | | + +#### 6.1.6.2 Structured data types + +##### 6.1.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.1.6.2.2 Type: UiccConfigurationParameter + +**Table 6.1.6.2.2-1: Definition of type UiccConfigurationParameter** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|---------------------|---|-------------|-----------------------------------------------------------------------------------|---------------| +| routingId | RoutingId | C | 0..1 | The Routing Id that needs to be updated in the USIM. | | +| steeringContainer | array(SteeringInfo) | C | 1..N | List of PLMN/AccessTechnologies combinations that need to be updated in the USIM. | | + +Note: Exactly one attribute shall be present + +#### 6.1.6.3 Simple data types and enumerations + +##### 6.1.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 6.1.6.3.2 Simple data types + +The simple data types defined in table 6.1.6.3.2-1 shall be supported. + +**Table 6.1.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------------------|---------------| +| RoutingId | string | Pattern: "[0-9]{1,4}\$" | | + +### 6.1.7 Error Handling + +#### 6.1.7.1 General + +For the Nspaf\_SecuredPacket API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [4] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [4]. + +In addition, the requirements in the following clauses are applicable for the Nspaf\_SecuredPacket API. + +#### 6.1.7.2 Protocol Errors + +No specific procedures for the Nspaf\_SecuredPacket service are specified. + +#### 6.1.7.3 Application Errors + +The application errors defined for the Nspaf\_SecuredPacket service are listed in Table 6.1.7.3-1. + +**Table 6.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|------------------|-------------------------| +| USER_NOT_FOUND | 404 Not Found | The user does not exist | + +### 6.1.8 Feature negotiation + +The optional features in table 6.1.8-1 are defined for the Nspaf\_SecuredPacket API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.1.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +### 6.1.9 Security + +As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Nspaf\_SecuredPacket API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [9]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [10]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nspaf\_SecuredPacket API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [10], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nspaf\_SecuredPacket service. + +The Nspaf\_SecuredPacket API defines a single scope "nspaf-secured-packet" for the entire service, and it does not define any additional scopes at resource or operation level. + +# Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex specifies the formal definition of the API(s) defined in the present specification. It consists of OpenAPI 3.0.0 specifications in YAML format. + +This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository, that uses the GitLab software version control system (see 3GPP TS 29.501 [5] clause 5.3.1 and 3GPP TR 21.900 [7] clause 5B). + +## A.2 Nspaf\_SecuredPacket API + +``` +openapi: 3.0.0 +info: + title: 'Nspaf_SecuredPacket' + version: '1.0.1' + description: | + Nspaf Secured Packet Service. + © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 29.544, SP-AF Services, version V16.2.0 + url: http://www.3gpp.org/ftp/Specs/archive/29_series/29.544/ +servers: + - url: '{apiRoot}/nspaf-secured-packet/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 +security: + - {} + - oAuth2ClientCredentials: + - nspaf-secured-packet +paths: + /{supi}/provide-secured-packet: + post: + summary: request generation of a secured packet + operationId: ProvideSecuredPacket + tags: + - SecuredPacket Generation (Custom Operation) + parameters: + - name: supi + in: path + description: SUPI of the user + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UiccConfigurationParameter' + responses: + '200': + description: Success + content: + application/json: +``` + +``` + schema: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/SecuredPacket' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nspaf-secured-packet: Access to the nspaf-secured-packet API + schemas: + +# COMPLEX TYPES: + + UiccConfigurationParameter: + type: object + oneOf: + - required: [routingId ] + - required: [steeringContainer ] + properties: + routingId: + $ref: '#/components/schemas/RoutingId' + steeringContainer: + type: array + items: + $ref: 'TS29509_Nausf_SoRProtection.yaml#/components/schemas/SteeringInfo' + minItems: 1 + +# SIMPLE TYPES: + + RoutingId: + type: string + pattern: '^[0-9]{1,4}$' + +# ENUMS: +``` + +# Annex B (informative): Change history + +| Change history | | | | | | | | | +|----------------|---------|-----------|------|-----|-----|--------------------------------------------------------------------------|--|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | | New version | +| 2019-10 | CT4#94 | C4-194013 | | | | Initial Draft. | | 0.1.0 | +| 2019-10 | CT4#94 | C4-194367 | | | | Notaf Overview | | 0.2.0 | +| 2019-10 | CT4#94 | C4-194488 | | | | Notaf_SecuredPacket-Provide service operation | | 0.2.0 | +| 2019-10 | CT4#94 | C4-194492 | | | | Resources | | 0.2.0 | +| 2019-10 | CT4#94 | C4-194516 | | | | Data Model | | 0.2.0 | +| 2019-10 | CT4#94 | C4-194490 | | | | OpenAPI Specification | | 0.2.0 | +| 2019-11 | CT4#95 | C4-195481 | | | | Clean Up | | 0.3.0 | +| 2019-12 | CT#86 | CP-193071 | | | | TS presented for information | | 1.0.0 | +| 2019-12 | CT#86 | CP-193285 | | | | A title updated | | 1.0.1 | +| 2020-03 | CT4#96e | C4-201119 | | | | Pseudo-CR on SOR | | 1.1.0 | +| 2020-03 | CT4#96e | C4-201123 | | | | Pseudo-CR on Clean Up | | 1.1.0 | +| 2020-03 | CT4#96e | C4-201217 | | | | Pseudo-CR on the necessary modifications to change OTAF NF name to SP-AF | | 1.1.0 | +| 2020-03 | CT4#96e | C4-201314 | | | | Pseudo-CR on API descriptions table in clause 5.1 | | 1.1.0 | +| 2020-03 | CT#87e | CP-200062 | | | | TS presented for approval | | 2.0.0 | +| 2020-03 | CT#87e | | | | | Approved at CT#87e | | 16.0.0 | +| 2020-07 | CT#88e | CP-201040 | 0001 | 1 | C | Clarification on Secured Packet format provided by SP-AF | | 16.1.0 | +| 2020-07 | CT#88e | CP-201040 | 0002 | | F | Storage of YAML files in ETSI Forge | | 16.1.0 | +| 2020-07 | CT#88e | CP-201040 | 0003 | 1 | F | Miscellaneous Corrections | | 16.1.0 | +| 2020-07 | CT#88e | CP-201073 | 0005 | | F | 3GPP TS 29.544 API Version and External doc Update | | 16.1.0 | +| 2020-09 | CT#89e | CP-202110 | 0006 | 1 | F | Miscellaneous corrections | | 16.2.0 | +| 2020-09 | CT#89e | CP-202096 | 0007 | | F | API version and External doc update | | 16.2.0 | +| 2020-12 | CT#90e | CP-203048 | 0008 | | F | Storage of yaml files | | 16.3.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29550/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-16/29_series/29550/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..581bf2b50551cd47a155aef9d468a153b36da5c1 --- /dev/null +++ b/marked/Rel-16/29_series/29550/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ae4628c1a19bed6e101c1aec2b50305c506d7cf3297a48795d6dc00a4b6d772a +size 7692 diff --git a/marked/Rel-16/29_series/29550/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-16/29_series/29550/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..67c33db1429fab3853fb4095107fcf8a1fdc4d6f --- /dev/null +++ b/marked/Rel-16/29_series/29550/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:57d5ef5b61a7be0040fe8221bab48a727e24e9eab0a20957ce3f8b9e30bf8d03 +size 5800 diff --git a/marked/Rel-16/29_series/29550/a234352dfaccdc24745c88eef7724cc6_img.jpg b/marked/Rel-16/29_series/29550/a234352dfaccdc24745c88eef7724cc6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b1d0233c461ea6435e7cffec2a957eb4a5caeb62 --- /dev/null +++ b/marked/Rel-16/29_series/29550/a234352dfaccdc24745c88eef7724cc6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e81737b8659502ebfdb3577c8cee566690d4c78bc0f4b48caad1c704f35e30b1 +size 30891 diff --git a/marked/Rel-16/29_series/29550/d0abac95583b52a3b35f74a215567334_img.jpg b/marked/Rel-16/29_series/29550/d0abac95583b52a3b35f74a215567334_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..99f15bddc930d368d5fae7140e36c972055dd467 --- /dev/null +++ b/marked/Rel-16/29_series/29550/d0abac95583b52a3b35f74a215567334_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c0eb2d67e5fbc0e9ae83a04db7b6ec6d37b4f0b0866c5cb0581a4c3dc26f078c +size 8948 diff --git a/marked/Rel-16/29_series/29550/e58a867750e4ae01604318506b79df7a_img.jpg b/marked/Rel-16/29_series/29550/e58a867750e4ae01604318506b79df7a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..95b444ad559589d6a534d9cfcebe77cec2aa584f --- /dev/null +++ b/marked/Rel-16/29_series/29550/e58a867750e4ae01604318506b79df7a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7794e24ac442e7d2d1ae79239e9f660ce87b332693f83f3715fae6ee484e4655 +size 30699 diff --git a/marked/Rel-16/29_series/29550/e6df2733626a85205c1db682e6259c46_img.jpg b/marked/Rel-16/29_series/29550/e6df2733626a85205c1db682e6259c46_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..39040d7c0e5a6f8a959233bf6201a9a4e1d7fd02 --- /dev/null +++ b/marked/Rel-16/29_series/29550/e6df2733626a85205c1db682e6259c46_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:add4090d6f62948900ee5fa10a332111f5866cce72d28f93d46c8dee44ad2f22 +size 29506 diff --git a/marked/Rel-16/29_series/29550/raw.md b/marked/Rel-16/29_series/29550/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..5de2c8cbf272f9adb84a22f95ba336798773d654 --- /dev/null +++ b/marked/Rel-16/29_series/29550/raw.md @@ -0,0 +1,951 @@ + + +# 3GPP TS 29.550 V16.5.0 (2022-06) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Steering of roaming application function services; Stage 3 (Release 16)** + +![5G logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The 5G logo, featuring the text "5G" in a bold, black, sans-serif font. Above the "5G" text are three green curved lines representing signal waves. + +5G logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, featuring the text "3GPP" in a bold, black, sans-serif font. Below the "3GPP" text are three red curved lines representing signal waves. + +3GPP logo + +A GLOBAL INITIATIVE + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions, symbols and abbreviations ..... | 7 | +| 3.1 Terms..... | 7 | +| 3.2 Symbols..... | 7 | +| 3.3 Abbreviations ..... | 7 | +| 4 Overview..... | 7 | +| 4.1 Introduction ..... | 7 | +| 5 Services offered by the SOR-AF ..... | 8 | +| 5.1 Introduction ..... | 8 | +| 5.2 Nsoraf_SteeringOfRoaming Service..... | 8 | +| 5.2.1 Service Description ..... | 8 | +| 5.2.2 Service Operations..... | 8 | +| 5.2.2.1 Introduction..... | 8 | +| 5.2.2.2 Get..... | 8 | +| 5.2.2.2.1 General ..... | 8 | +| 5.2.2.2.2 SoR Information Retrieval ..... | 9 | +| 5.2.2.3 Info..... | 9 | +| 5.2.2.3.1 General ..... | 9 | +| 5.2.2.3.2 SoR Acknowledgment Reception Notification ..... | 9 | +| 6 API Definitions ..... | 10 | +| 6.1 Nsoraf_SteeringOfRoaming Service API ..... | 10 | +| 6.1.1 Introduction ..... | 10 | +| 6.1.2 Usage of HTTP..... | 10 | +| 6.1.2.1 General..... | 10 | +| 6.1.2.2 HTTP standard headers..... | 11 | +| 6.1.2.2.1 General ..... | 11 | +| 6.1.2.2.2 Content type ..... | 11 | +| 6.1.2.2.3 Cache-Control ..... | 11 | +| 6.1.2.3 HTTP custom headers..... | 11 | +| 6.1.3 Resources..... | 11 | +| 6.1.3.1 Overview..... | 11 | +| 6.1.3.2 Resource: sor-information ..... | 12 | +| 6.1.3.2.1 Description ..... | 12 | +| 6.1.3.2.2 Resource Definition..... | 12 | +| 6.1.3.2.3 Resource Standard Methods..... | 12 | +| 6.1.3.2.3.1 GET ..... | 12 | +| 6.1.3.3 Resource: sor-ack..... | 13 | +| 6.1.3.3.1 Description ..... | 13 | +| 6.1.3.3.2 Resource Definition..... | 13 | +| 6.1.3.3.3 Resource Standard Methods..... | 14 | +| 6.1.3.3.3.1 PUT..... | 14 | +| 6.1.4 Custom Operations without associated resources ..... | 14 | +| 6.1.5 Notifications ..... | 15 | +| 6.1.5.1 General..... | 15 | +| 6.1.6 Data Model ..... | 15 | +| 6.1.6.1 General..... | 15 | +| 6.1.6.2 Structured data types..... | 15 | +| 6.1.6.2.1 Introduction ..... | 15 | +| 6.1.6.2.2 Type: SorInformation..... | 16 | +| 6.1.6.2.3 Type: SorAckInfo..... | 16 | +| 6.1.6.3 Simple data types and enumerations..... | 16 | +| 6.1.6.3.1 Introduction ..... | 16 | + +| | | | +|---------------------------------------------------------|---------------------------------|-----------| +| 6.1.6.3.2 | Simple data types ..... | 16 | +| 6.1.6.3.3 | Enumeration: SorAckStatus ..... | 17 | +| 6.1.7 | Error Handling ..... | 17 | +| 6.1.7.1 | General ..... | 17 | +| 6.1.7.2 | Protocol Errors ..... | 17 | +| 6.1.7.3 | Application Errors ..... | 17 | +| 6.1.8 | Feature negotiation ..... | 17 | +| 6.1.9 | Security ..... | 18 | +| Annex A (normative): OpenAPI specification ..... | | 19 | +| A.1 | General ..... | 19 | +| A.2 | Nsoraf_SOR API ..... | 19 | +| Annex B (informative): Change history ..... | | 22 | + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document specifies the stage 3 protocol and data model for the Nsoraf Service Based Interface. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the SOR-AF. + +The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]. The stage 2 architecture and procedures for 5G Steering of Roaming are specified in 3GPP TS 23.122 [14]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] OpenAPI: "OpenAPI 3.0.0 Specification", . +- [7] 3GPP TR 21.900: "Technical Specification Group working methods". +- [8] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [9] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [10] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". +- [11] IETF RFC 7540: "Hypertext Transfer Protocol Version 2 (HTTP/2)". +- [12] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [13] IETF RFC 7807: "Problem Details for HTTP APIs". +- [14] 3GPP TS 23.122: "Non-Access-Stratum (NAS) functions related to Mobile Station (MS) in idle mode". + +- [15] 3GPP TS 29.503: "5G System; Unified Data Management Services; Stage 3". +- [16] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces Stage 3". +- [17] 3GPP TS 31.115: "Secured packet structure for (Universal) Subscriber Identity Module (U)SIM Toolkit applications". + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Terms + +**SoR Information:** In this specification, this refers to the following HPLMN information: + +- a) an indication of whether the SOR-AF requires the UDM to request an acknowledgement from the UE for successful reception of the Steering of Roaming information; and +- b) one of the following: + - a list of preferred PLMN/access technology combinations with an indication that it is included; + - a secured packet with an indication that it is included; or + - the HPLMN indication that 'no change of the "Operator Controlled PLMN Selector with Access Technology" list stored in the UE is needed and thus no list of preferred PLMN/access technology combinations is provided'. + +**NOTE:** The secured packet contains the list of preferred PLMN/access technology combinations encapsulated with a security mechanism as described in 3GPP TS 31.115 [17]. + +## 3.2 Symbols + +Void. + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|--------|------------------------------------------| +| NF | Network Function | +| JSON | Javascript Object Notation | +| SOR-AF | Steering Of Roaming Application Function | +| SoR | Steering of Roaming | +| SUPI | Subscription Permanent Identifier | +| UE | User Equipment | +| UDM | Unified Data Management | + +# --- 4 Overview + +## 4.1 Introduction + +Within the 5GC, the Steering Of Roaming Application Function (SOR-AF) provides services (see 3GPP TS 23.122 [14]) to NF service consumers (e.g. UDM) via the Nsoraf service based interface. + +**NOTE:** The generation and calculation of the SoR information and associated roaming business logic are out of scope of this document. + +Figure 4.1-1 depicts the reference architecture of the SOR-AF. + +![Figure 4.1-1: Reference model – SOR-AF. A diagram showing an 'NF Service Consumer' connected to an 'SOR-AF' via an 'Nsoraf' interface. The SOR-AF is represented by a green rectangle.](d0abac95583b52a3b35f74a215567334_img.jpg) + +``` + +graph LR + NFSC[NF Service Consumer] ---|Nsoraf| SORAF[SOR-AF] + style SORAF fill:#90EE90,stroke:#000 + +``` + +Figure 4.1-1: Reference model – SOR-AF. A diagram showing an 'NF Service Consumer' connected to an 'SOR-AF' via an 'Nsoraf' interface. The SOR-AF is represented by a green rectangle. + +Figure 4.1-1: Reference model – SOR-AF + +# 5 Services offered by the SOR-AF + +## 5.1 Introduction + +The SOR-AF offers the following services to NF consumers (e.g. UDM) via the Nsoraf service based interface: + +- Nsoraf\_SteeringOfRoaming + +Table 5.1-1 summarizes the corresponding APIs defined for this specification. + +Table 5.1-1: APIs Description + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex | +|--------------------------|--------|------------------------------------|----------------------------|------------|-------| +| Nsoraf_SteeringOfRoaming | 6.1 | Nsoraf Steering Of Roaming Service | TS29550_Nsoraf_SOR.yaml | nsoraf-sor | A.2 | + +## 5.2 Nsoraf\_SteeringOfRoaming Service + +### 5.2.1 Service Description + +The Nsoraf\_SteeringOfRoaming (Nsoraf\_SOR) service provides Steering of Roaming services to NF consumers (e.g. UDM) to enable the retrieval of SoR information (i.e. the list of preferred PLMN/access technology combinations or an indication that no update to the list of preferred PLMN/access technology combinations is needed) to be conveyed to the UE, as specified in Annex C of 3GPP TS 23.122 [14]. The latter specifies the 5GS control plane mechanism for Steering of Roaming that aims at allowing the HPLMN to update the "Operator Controlled PLMN Selector with Access Technology" list in the UE by providing and updating this list of preferred PLMN/access technology combinations. + +### 5.2.2 Service Operations + +#### 5.2.2.1 Introduction + +For the Nsoraf\_SteeringOfRoaming service, the following service operations are defined: + +- Get +- Info + +#### 5.2.2.2 Get + +##### 5.2.2.2.1 General + +This service operation is used by a NF consumer (e.g. UDM) to retrieve SoR information. + +The returned information can consist of either: + +- a list of preferred PLMN/access technology combinations; +- a secured packet; +- neither of them. + +NOTE: The secured packet contains the list of preferred PLMN/access technology combinations encapsulated with a security mechanism as described in 3GPP TS 31.115 [17]. + +The following procedures are supported using the "Get" service operation: + +- SoR Information Retrieval + +##### 5.2.2.2.2 SoR Information Retrieval + +Figure 5.2.2.2.2-1 depicts a scenario where a NF consumer (e.g. UDM) sends a request to the SOR-AF to retrieve the SoR information for a UE (see also clause C.2 in Annex C of 3GPP TS 23.122 [14]). + +The request contains the UE's identity (/{supi}) and a set of query parameters (e.g. PLMN ID of the visited PLMN the UE is roaming in). + +![Sequence diagram illustrating the SoR Information Retrieval Procedure. The diagram shows two lifelines: 'NF service consumer' on the left and 'SOR-AF' on the right. Step 1: The NF service consumer sends a GET request to the SOR-AF with the path .../{supi}/sor-information and query parameters. Step 2a: The SOR-AF responds with a 200 OK status code and a SorInformation message body. Step 2b: Alternatively, the SOR-AF responds with a 404 Not Found status code.](a234352dfaccdc24745c88eef7724cc6_img.jpg) + +``` + +sequenceDiagram + participant NF as NF service consumer + participant SOR-AF as SOR-AF + Note left of NF: + NF->>SOR-AF: 1. GET .../{supi}/sor-information? + SOR-AF-->>NF: 2a. 200 OK (SorInformation) + SOR-AF-->>NF: 2b. 404 Not Found + +``` + +Sequence diagram illustrating the SoR Information Retrieval Procedure. The diagram shows two lifelines: 'NF service consumer' on the left and 'SOR-AF' on the right. Step 1: The NF service consumer sends a GET request to the SOR-AF with the path .../{supi}/sor-information and query parameters. Step 2a: The SOR-AF responds with a 200 OK status code and a SorInformation message body. Step 2b: Alternatively, the SOR-AF responds with a 404 Not Found status code. + +**Figure 5.2.2.2.2-1: SoR Information Retrieval Procedure** + +1. The NF service consumer (e.g. UDM) sends a GET request to the resource representing the SoR information (sor-information), with query parameters indicating the PLMN ID and other relevant information (e.g. Access type). +- 2a. On success, the SOR-AF responds with the HTTP status code "200 OK" with the message body containing the SoR information for the concerned UE. The response also contains a Cache-Control HTTP header set to the value "no-cache" instructing the NF consumer (e.g. UDM) to not cache the received SoR information. +- 2b. If there is no valid SoR information for the UE (e.g. the resource does not exist, the SUPI is unknown to the SOR-AF), the SOR-AF responds with the HTTP status code "404 Not Found" including additional error information in the response body (within the "ProblemDetails" IE). + +**NOTE:** An operator configurable timer shall be used by the NF Service Consumer (e.g. UDM) to control the acceptable time during which it shall wait for the GET response from the SOR-AF, as specified in clause C.2 of 3GPP TS 23.122 [14] (step 3d of the procedure description). The default value and range of this timer is operator specific and shall take into account the importance of the related procedure (e.g. registration procedure). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +#### 5.2.2.3 Info + +##### 5.2.2.3.1 General + +This service operation is used by a NF consumer (e.g. UDM) to provide the SOR-AF with the reception status of the acknowledgment on successful reception of SoR information by the UE, in case an acknowledgment was requested to the UE. + +The following procedures are supported using the "Info" service operation: + +- SoR Acknowledgment Reception Notification + +##### 5.2.2.3.2 SoR Acknowledgment Reception Notification + +Figure 5.2.2.3.2-1 depicts a scenario where a NF consumer (e.g. UDM) sends an indication to the SOR-AF on the reception status of SoR information by the UE (see also clauses C.2 and C.3 in Annex C of 3GPP TS 23.122 [14]). + +The request contains the UE's identity (/{supi}), the type of acknowledgment (/sor-information/sor-ack) and the indication (SorAckInfo). + +![Sequence diagram showing the SoR Acknowledgment Reception Notification procedure. An NF service consumer sends a PUT request to the SOR-AF. The SOR-AF responds with either a 204 No Content or a 404 Not Found status code.](e6df2733626a85205c1db682e6259c46_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant SOR-AF + Note left of NF service consumer: 1. PUT.../{supi}/sor-information/sor-ack (SorAckInfo) + NF service consumer->>SOR-AF: 1. PUT.../{supi}/sor-information/sor-ack (SorAckInfo) + Note right of SOR-AF: 2a. 204 No Content + SOR-AF-->>NF service consumer: 2a. 204 No Content + Note right of SOR-AF: 2b. 404 Not Found + SOR-AF-->>NF service consumer: 2b. 404 Not Found + +``` + +Sequence diagram showing the SoR Acknowledgment Reception Notification procedure. An NF service consumer sends a PUT request to the SOR-AF. The SOR-AF responds with either a 204 No Content or a 404 Not Found status code. + +**Figure 5.2.2.3.2-1: SoR Acknowledgment Reception Notification procedure** + +1. The NF service consumer (e.g. UDM) sends a PUT request to the resource representing the SoR information acknowledgment (/{supi}/sor-information/sor-ack) with the SorAckInfo containing an indication on the reception status of SoR information by the UE. +- 2a. The SOR-AF responds with the HTTP status code "204 No Content". +- 2b. If there is an error (e.g. the SUPI is unknown to the SOR-AF), the SOR-AF shall respond with the HTTP status code "404 Not Found" including additional error information in the response body (within the "ProblemDetails" IE). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PUT response body. + +# 6 API Definitions + +## 6.1 Nsoraf\_SteeringOfRoaming Service API + +### 6.1.1 Introduction + +The Nsoraf\_SOR service shall use the Nsoraf\_SOR service API. + +The request URI used in HTTP request from the NF service consumer towards the NF service producer shall have the structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}///** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nsoraf-sor". +- The shall be "v1". +- The shall be set as described in clause 6.1.3. + +### 6.1.2 Usage of HTTP + +#### 6.1.2.1 General + +HTTP/2, IETF RFC 7540 [11], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +The OpenAPI [6] specification of HTTP messages and content bodies for the Nsoraf\_SOR API is contained in Annex A. + +#### 6.1.2.2 HTTP standard headers + +##### 6.1.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers. + +##### 6.1.2.2.2 Content type + +JSON, IETF RFC 8259 [12], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [4]. The use of the JSON format shall be signalled by the content type "application/json". + +"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 7807 [13]. + +##### 6.1.2.2.3 Cache-Control + +The "Cache-Control" header set to the value "no-cache" shall be included in HTTP responses for resources that shall not be cached (e.g. SorInformation). + +#### 6.1.2.3 HTTP custom headers + +The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] shall be applicable. + +### 6.1.3 Resources + +#### 6.1.3.1 Overview + +The structure of the Resource URIs of the "Nsoraf\_SOR" service is depicted in Figure 6.1.3.1-1. + +![Figure 6.1.3.1-1: Resource URI structure of the Nsoraf_SOR API. The diagram shows a hierarchical tree structure of URIs. The root is {apiRoot}/nsoraf-sor/v1. It branches to /{supi}, which branches to /sor-information, which branches to /sor-ack.](e58a867750e4ae01604318506b79df7a_img.jpg) + +``` +graph TD; A["{apiRoot}/nsoraf-sor/v1"] --> B["/{supi}"]; B --> C["/sor-information"]; C --> D["/sor-ack"]; +``` + +Figure 6.1.3.1-1: Resource URI structure of the Nsoraf\_SOR API. The diagram shows a hierarchical tree structure of URIs. The root is {apiRoot}/nsoraf-sor/v1. It branches to /{supi}, which branches to /sor-information, which branches to /sor-ack. + +**Figure 6.1.3.1-1: Resource URI structure of the Nsoraf\_SOR API** + +Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods. + +Table 6.1.3.1-1: Resources and methods overview + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|----------------------------|---------------------------------|---------------------------------|-----------------------------------------------------------------------------------------------------------------------| +| sor-information (Document) | /{supi}/sor-information | GET | Retrieve the SoR information. | +| sor-ack (Document) | /{supi}/sor-information/sor-ack | PUT | Inform the SOR-AF of the reception status of the Acknowledgment of successful reception of SoR information by the UE. | + +#### 6.1.3.2 Resource: sor-information + +##### 6.1.3.2.1 Description + +This resource represents the SoR information for a SUPI. It is used by NF consumers (e.g. UDM) to: + +- request the retrieval of the SoR information during registration in a VPLMN as specified in clause C.2 in Annex C of 3GPP TS 23.122°[14]. + +##### 6.1.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nsoraf-sor/v1/{supi}/sor-information + +This resource shall support the resource URI variables defined in table 6.1.3.2.2-1. + +Table 6.1.3.2.2-1: Resource URI variables for this resource + +| Name | Data type | Definition | +|---------|-----------|--------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| supi | Supi | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: "^(imsi-[0-9]{5,15} nai-.[ +])\$" | + +##### 6.1.3.2.3 Resource Standard Methods + +###### 6.1.3.2.3.1 GET + +This method shall support the URI query parameters specified in table 6.1.3.2.3.1-1. + +Table 6.1.3.2.3.1-1: URI query parameters supported by the GET method on this resource + +| Name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------|---|-------------|-------------------------------------------|---------------| +| supported-features | SupportedFeatures | O | 0..1 | See 3GPP TS 29.500 [4] clause 6.6. | | +| plmn-id | PlmnId | M | 1 | PLMN identity of the PLMN serving the UE. | | +| access-type | AccessType | O | 0..1 | Access type used by the UE. | | + +This method shall support the request data structures specified in table 6.1.3.2.3.1-2 and the response data structures and response codes specified in table 6.1.3.2.3.1-3. + +Table 6.1.3.2.3.1-2: Data structures supported by the GET Request Body on this resource + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.2.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SorInformation | M | 1 | 200 OK | Upon success, a response with "200 OK" status code and a response body containing the SoR information as requested by the NF consumer (e.g. UDM) shall be returned by the SOR-AF. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a URI pointing to a resource located on alternative SOR-AF or the initial target SOR-AF when this is a redirection triggered by an SCP via another SCP. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a URI pointing to a resource located on alternative SOR-AF or the initial target SOR-AF when this is a redirection triggered by an SCP via another SCP. (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be set to one of the following application errors:
- USER_NOT_FOUND | + +NOTE 1: The mandatory HTTP error status code for the GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +NOTE 2: RedirectResponses may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.2.3.1-4: Headers supported by the 200 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|---------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------| +| Cache-Control | string | M | 1 | The Cache-Control HTTP header is set to the value "no-cache" instructing the NF consumer (e.g. UDM) to not cache the received SoR information. | + +**Table 6.1.3.2.3.1-5: Headers supported by the 307 Response Code on this endpoint** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to a resource located on alternative SOR-AF or the initial target SOR-AF when this is a redirection triggered by an SCP via another SCP. | + +**Table 6.1.3.2.3.1-6: Headers supported by the 308 Response Code on this endpoint** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to a resource located on alternative SOR-AF or the initial target SOR-AF when this is a redirection triggered by an SCP via another SCP. | + +#### 6.1.3.3 Resource: sor-ack + +##### 6.1.3.3.1 Description + +This resource represents the notification from the NF consumer (e.g. UDM) of the reception status of the acknowledgment of successful reception of SoR information by the UE as specified in in Annex C of 3GPP TS 23.122 [14]. + +##### 6.1.3.3.2 Resource Definition + +Resource URI: {apiRoot}/nsoraf-sor/v1/{supi}/sor-information/sor-ack + +This resource shall support the resource URI variables defined in table 6.1.3.3.2-1. + +**Table 6.1.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|--------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| supi | Supi | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: "^(imsi-[0-9]{5,15} nai-\.+\+)\$" | + +##### 6.1.3.3.3 Resource Standard Methods + +###### 6.1.3.3.3.1 PUT + +This method shall support the URI query parameters specified in table 6.1.3.3.3.1-1. + +**Table 6.1.3.3.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.3.3.1-2 and the response data structures and response codes specified in table 6.1.3.3.3.1-3. + +**Table 6.1.3.3.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------| +| SorAckInfo | M | 1 | Contains an indication on the reception status of the acknowledgment of successful reception of SoR information by the UE. | + +**Table 6.1.3.3.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, a response with "204 No Content" status code shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a URI pointing to a resource located on alternative SOR-AF or the initial target SOR-AF when this is a redirection triggered by an SCP via another SCP.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a URI pointing to a resource located on alternative SOR-AF or the initial target SOR-AF when this is a redirection triggered by an SCP via another SCP.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be set to the following application error:
- USER_NOT_FOUND | + +NOTE 1: The mandatory HTTP error status code for the PUT method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: RedirectResponses may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.3.3.1-4: Headers supported by the 307 Response Code on this endpoint** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to a resource located on alternative SOR-AF or the initial target SOR-AF when this is a redirection triggered by an SCP via another SCP. | + +### 6.1.4 Custom Operations without associated resources + +No custom operations without associated resources are defined for the Nsoraf\_SOR Service. + +### 6.1.5 Notifications + +#### 6.1.5.1 General + +In this release of this specification, no notifications are defined for the Nsoraf\_SOR Service. + +### 6.1.6 Data Model + +#### 6.1.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.1.6.1-1 specifies the data types defined for the Nsoraf\_SOR service based interface protocol. + +**Table 6.1.6.1-1: Nsoraf specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|----------------|----------------|------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| SorInformation | 6.1.6.2.2 | Contains the SoR information to be conveyed to the UE. | | +| SorAckInfo | 6.1.6.2.3 | Contains an indication to the SOR-AF on the reception status of the acknowledgment of successful reception of SoR Information by the UE. | | +| SorAckStatus | 6.1.6.3.3 | Contains the reception status of the acknowledgment of successful reception of SoR Information by the UE. | | + +Table 6.1.6.1-2 specifies data types re-used by the Nsoraf\_SOR service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nsoraf service based interface. + +**Table 6.1.6.1-2: Nsoraf re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-------------------|---------------------|------------------------------------------|---------------| +| PlmnId | 3GPP TS 29.571 [16] | PLMN Identity | | +| ProblemDetails | 3GPP TS 29.571 [16] | Common data type used in response bodies | | +| RedirectResponse | 3GPP TS 29.571 [10] | Redirect Response | | +| SupportedFeatures | 3GPP TS 29.571 [16] | see 3GPP TS 29.500 [4] clause 6.6 | | +| SteeringContainer | 3GPP TS 29.503 [15] | Contains the SoR Information | | +| Supi | 3GPP TS 29.571 [16] | Contains the SUPI information. | | +| DateTime | 3GPP TS 29.571 [16] | Date Time | | +| AccessType | 3GPP TS 29.571 [16] | Access type (e.g. 3GPP) | | + +#### 6.1.6.2 Structured data types + +##### 6.1.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.1.6.2.2 Type: SorInformation + +Table 6.1.6.2.2-1: Definition of type SorInformation + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|-------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| steeringContainer | SteeringContainer | C | 0..1 | When present, this attribute contains the information needed to update the "Operator Controlled PLMN Selector with Access Technology" list stored in the UE, either as an array of preferred PLMN/Access Technologies combinations in priority order (with the first entry in the array indicating the highest priority and the last entry indicating the lowest) or a secured packet. If no change of the "Operator Controlled PLMN Selector with Access Technology" list stored in the UE is needed, then this attribute shall be absent. | | +| sorAckIndication | Boolean | M | 1 | This attribute indicates to the NF consumer (e.g. UDM) whether an Acknowledgment of successful reception of SoR information shall be requested to the UE (when set to "True") or not (when set to "False"). | | +| sorSendingTime | DateTime | M | 1 | Contains the date and time at which SOR-AF returns SorInformation. It is used to correlate the SoR acknowledgement with the associated SoR information. | | + +##### 6.1.6.2.3 Type: SorAckInfo + +Table 6.1.6.2.3-1: Definition of type SorAckInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------|---|-------------|----------------------------------------------------------------------------------------------------------------|---------------| +| sorAckStatus | SorAckStatus | M | 1 | Contains the reception status of the acknowledgment of successful reception of SoR Information by the UE. | | +| sorSendingTime | DateTime | M | 1 | Contains the date and time at which SOR-AF sent the SorInformation to which the acknowledgment status relates. | | + +#### 6.1.6.3 Simple data types and enumerations + +##### 6.1.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 6.1.6.3.2 Simple data types + +The simple data types defined in table 6.1.6.3.2-1 shall be supported. + +**Table 6.1.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| n/a | | | | + +##### 6.1.6.3.3 Enumeration: SorAckStatus + +The enumeration SorAckStatus represents an indication to the SOR-AF on whether the acknowledgment of successful reception of SoR information was received from the UE. It shall comply with the provisions defined in table 6.1.6.3.3-1. + +**Table 6.1.6.3.3-1: Enumeration SorAckStatus** + +| Enumeration value | Description | Applicability | +|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| "ACK_SUCCESSFUL" | Indicates to the SOR-AF that the acknowledgment of successful reception of SoR information was received from the UE and the integrity check was successful. | | +| "ACK_NOT_RECEIVED" | Indicates to the SOR-AF that the acknowledgment of successful reception of SoR information was NOT received from the UE. | | +| "ACK_NOT_SUCCESSFUL" | Indicates to the SOR-AF that the acknowledgment of successful reception of SoR information was received from the UE and the integrity check was NOT successful. | | + +### 6.1.7 Error Handling + +#### 6.1.7.1 General + +For the Nsoraf\_SOR API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [4] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [4]. + +In addition, the requirements in the following clauses are applicable for the Nsoraf\_SOR API. + +#### 6.1.7.2 Protocol Errors + +No specific procedures for the Nsoraf\_SOR service are specified. + +#### 6.1.7.3 Application Errors + +The application errors defined for the Nsoraf\_SOR service are listed in Table 6.1.7.3-1. + +**Table 6.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|------------------|-----------------------------------------------------------------------------------| +| USER_NOT_FOUND | 404 Not Found | The user does not exist
This error is applicable to all Nsoraf_SOR operations. | + +### 6.1.8 Feature negotiation + +The optional features in table 6.1.8-1 are defined for the Nsoraf\_SOR API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.1.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| n/a | | | + +### 6.1.9 Security + +As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Nsoraf\_SOR API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [9]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [10]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nsoraf\_SOR API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [10], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nsoraf\_SOR service. + +The Nsoraf\_SOR API defines a single scope "nsoraf-sor" for the entire service, and it does not define any additional scopes at resource or operation level. + +# Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex specifies the formal definition of the API(s) defined in the present specification. It consists of OpenAPI 3.0.0 specifications in YAML format. + +This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based , that uses the GitLab software version control system (see 3GPP TS 29.501 [5] clause 5.3.1 and 3GPP TR 21.900 [7] clause 5B). + +## A.2 Nsoraf\_SOR API + +``` +openapi: 3.0.0 +info: + title: 'Nsoraf_SOR' + version: 1.0.2 + description: | + Nsoraf Steering Of Roaming Service. + © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 29.550 V16.5.0; Steering Of Roaming Application Function Services. + url: http://www.3gpp.org/ftp/Specs/archive/29_series/29.550/ +servers: + - url: '{apiRoot}/nsoraf-sor/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 +security: + - {} + - oAuth2ClientCredentials: + - nsoraf-sor +paths: + /{supi}/sor-information: + get: + summary: retrieve the steering of roaming information for a UE + operationId: GetSorInformation + tags: + - SoR Information Retrieval + parameters: + - name: supi + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: plmn-id + in: query + description: serving PLMN ID + required: true + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' +``` + +``` +- name: access-type + in: query + description: Access type used by the UE + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SorInformation' + headers: + Cache-Control: + description: Cache-Control (as described in RFC 7234) with value "no-cache" to + indicate that the returned SoR information should not be cached + schema: + type: string + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +/{supi}/sor-information/sor-ack: + put: + summary: SoR Acknowledgment Reception Notification + operationId: SorAckInfo + tags: + - Providing the reception status of the acknowledgement of Steering of Roaming information + reception by the UE + parameters: + - name: supi + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SorAckInfo' + responses: + '204': + description: Successful reception of the indication + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nsoraf-sor: Access to the Nsoraf_SOR API +``` + +``` +schemas: + # API specific definitions + SorInformation: + type: object + required: + - sorAckIndication + - sorSendingTime + properties: + steeringContainer: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/SteeringContainer' + sorAckIndication: + type: boolean + sorSendingTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + SorAckInfo: + type: object + required: + - sorAckStatus + - sorSendingTime + properties: + sorAckStatus: + $ref: '#/components/schemas/SorAckStatus' + sorSendingTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + SorAckStatus: + anyOf: + - type: string + enum: + - ACK_SUCCESSFUL + - ACK_NOT_RECEIVED + - ACK_NOT_SUCCESSFUL + - type: string +``` + +# Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|----------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2019-11 | CT4#95 | C4-195242 | | | | Initial Draft. | 0.1.0 | +| 2020-03 | CT4#96e | C4-200833 | | | | Pseudo-CR on the scope part of SOR-AF API | 0.2.0 | +| 2020-03 | CT4#96e | C4-201197 | | | | Pseudo-CR on the overview part of SOR-AF API | 0.2.0 | +| 2020-03 | CT4#96e | C4-201198 | | | | Pseudo-CR on the definition of Nsoraf service | 0.2.0 | +| 2020-03 | CT4#96e | C4-201206 | | | | Pseudo-CR on the resources part of SOR-AF API | 0.2.0 | +| 2020-03 | CT4#96e | C4-201208 | | | | Pseudo-CR on the data model aspects of SOR-AF API | 0.2.0 | +| 2020-03 | CT4#96e | C4-201209 | | | | Pseudo-CR on the OpenAPI part of SOR-AF API | 0.2.0 | +| 2020-03 | CT-87e | CP-200063 | | | | TS presented for information and approval | 1.0.0 | +| 2020-03 | CT-87e | | | | | Approved at CT#87e | 16.0.0 | +| 2020-07 | CT#88e | CP-201042 | 0001 | | F | SoR Information wording clarification | 16.1.0 | +| 2020-07 | CT#88e | CP-201042 | 0002 | 1 | F | Storage of YAML files in ETSI Forge | 16.1.0 | +| 2020-07 | CT#88e | CP-201042 | 0003 | | F | Miscellaneous Corrections | 16.1.0 | +| 2020-07 | CT#88e | CP-201042 | 0006 | 1 | F | Add Data type column in the URI variables tables | 16.1.0 | +| 2020-07 | CT#88e | CP-201042 | 0007 | 1 | F | Add supported headers tables | 16.1.0 | +| 2020-07 | CT#88e | CP-201042 | 0008 | | F | Add API descriptions table | 16.1.0 | +| 2020-07 | CT#88e | CP-201042 | 0009 | 2 | B | Remaining input parameters to Nsoraf_SOR_Get service operation | 16.1.0 | +| 2020-07 | CT#88e | CP-201042 | 0010 | 1 | B | SoR retrieval response timing control | 16.1.0 | +| 2020-07 | CT#88e | CP-201073 | 0011 | | F | 29.550 Rel-16 API version and External doc update | 16.1.0 | +| 2020-09 | CT#89e | CP-202115 | 0012 | | F | Miscellaneous Corrections | 16.2.0 | +| 2020-12 | CT#90e | CP-203035 | 0015 | | F | Removal of the reference to ETSI forge | 16.3.0 | +| 2021-09 | CT#93e | CP-212246 | 0025 | 1 | F | Redirection answers | 16.4.0 | +| 2022-06 | CT#96 | CP-221064 | 0029 | | F | access-type query parameter format | 16.5.0 | +| 2022-06 | CT#96 | CP-221303 | 0033 | 1 | F | 29.550 Rel-16 API version and External doc update | 16.5.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29554/18f841ac4f2ef28f34a026f1bdc5af9a_img.jpg b/marked/Rel-16/29_series/29554/18f841ac4f2ef28f34a026f1bdc5af9a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..95e677930a399f9d150a261c2b3f250dcc66fae7 --- /dev/null +++ b/marked/Rel-16/29_series/29554/18f841ac4f2ef28f34a026f1bdc5af9a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ea5731bf7fc7920b8fb2daab92ca16df1df224e0fde1c230f570e9bde9b67de1 +size 13734 diff --git a/marked/Rel-16/29_series/29554/54fabc351eda5228d2fa28cd9ba07971_img.jpg b/marked/Rel-16/29_series/29554/54fabc351eda5228d2fa28cd9ba07971_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..489f1a80f798beed7c9fc41175324ef4edf71f86 --- /dev/null +++ b/marked/Rel-16/29_series/29554/54fabc351eda5228d2fa28cd9ba07971_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a6ceac8d4c4a639d60b7266307a1ed23af0297502931daeec807ba9b70f97c86 +size 27461 diff --git a/marked/Rel-16/29_series/29554/853f59c89931a666c07903b31d098277_img.jpg b/marked/Rel-16/29_series/29554/853f59c89931a666c07903b31d098277_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..687096ce384c103581b00406d0f3466dc5a8a576 --- /dev/null +++ b/marked/Rel-16/29_series/29554/853f59c89931a666c07903b31d098277_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ddac075b12504f3cdd1d3525af2ea493ee6a10385575e17e804d1022ac302e10 +size 32286 diff --git a/marked/Rel-16/29_series/29554/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg b/marked/Rel-16/29_series/29554/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f31a26743f721b3dac958c76ba35b1b213fcbdbf --- /dev/null +++ b/marked/Rel-16/29_series/29554/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:443a67b2f8f905ff89382a8996e738a9586cdc4e89ff2ce052ec94ee53367406 +size 27728 diff --git a/marked/Rel-16/29_series/29554/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg b/marked/Rel-16/29_series/29554/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..bf8c201d01d5e47a38afee31ea4008ed0a17eaeb --- /dev/null +++ b/marked/Rel-16/29_series/29554/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a74c1b6a803e2c86529c1889ef7761b67403b1ba63d0b328c1a66c0b3c521099 +size 7253 diff --git a/marked/Rel-16/29_series/29554/b90144cfbb81a2d610d920240fda689d_img.jpg b/marked/Rel-16/29_series/29554/b90144cfbb81a2d610d920240fda689d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..de82311a2d2c56143984b44009077bcea292dc61 --- /dev/null +++ b/marked/Rel-16/29_series/29554/b90144cfbb81a2d610d920240fda689d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4718f78fbdbbb6076b5fae6f87da81456a3fe62b5f086ea8cb40ac7c042d2d86 +size 18694 diff --git a/marked/Rel-16/29_series/29554/raw.md b/marked/Rel-16/29_series/29554/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..315649457aca9d77e96cc6791cbd1827afb2840b --- /dev/null +++ b/marked/Rel-16/29_series/29554/raw.md @@ -0,0 +1,1626 @@ + + + + +# ***Copyright Notification*** + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTSTM is a Trade Mark of ETSI registered for the benefit of its members + +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners + +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners + +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|---------------------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions and abbreviations ..... | 7 | +| 3.1 Definitions..... | 7 | +| 3.2 Abbreviations ..... | 7 | +| 4 Background Data Transfer Policy Control Service..... | 8 | +| 4.1 Service Description ..... | 8 | +| 4.1.1 Overview ..... | 8 | +| 4.1.2 Service Architecture ..... | 8 | +| 4.1.3 Network Functions ..... | 9 | +| 4.1.3.1 Policy Control Function (PCF) ..... | 9 | +| 4.1.3.2 NF Service Consumers ..... | 9 | +| 4.2 Service Operations ..... | 9 | +| 4.2.1 Introduction ..... | 9 | +| 4.2.2 Npcf_BDTPolicyControl_Create service operation..... | 10 | +| 4.2.2.1 General..... | 10 | +| 4.2.2.2 Retrieval of BDT policies ..... | 10 | +| 4.2.3 Npcf_BDTPolicyControl_Update service operation..... | 12 | +| 4.2.3.1 General..... | 12 | +| 4.2.3.2 Indication about selected transfer policy ..... | 12 | +| 4.2.3.3 Modification of BDT warning notification request indication ..... | 13 | +| 4.2.4 Npcf_BDTPolicyControl_Notify service operation..... | 13 | +| 4.2.4.1 General..... | 13 | +| 4.2.4.2 Sending the BDT warning notification..... | 13 | +| 5 Npcf_BDTPolicyControl API..... | 15 | +| 5.1 Introduction ..... | 15 | +| 5.2 Usage of HTTP..... | 15 | +| 5.2.1 General ..... | 15 | +| 5.2.2 HTTP standard headers ..... | 15 | +| 5.2.2.1 General..... | 15 | +| 5.2.2.2 Content type ..... | 15 | +| 5.2.3 HTTP custom headers ..... | 16 | +| 5.3 Resources ..... | 16 | +| 5.3.1 Resource Structure..... | 16 | +| 5.3.2 Resource: BDT policies (Collection) ..... | 16 | +| 5.3.2.1 Description..... | 16 | +| 5.3.2.2 Resource definition..... | 16 | +| 5.3.2.3 Resource Standard Methods ..... | 17 | +| 5.3.2.3.1 POST ..... | 17 | +| 5.3.2.4 Resource Custom Operations..... | 17 | +| 5.3.3 Resource: Individual BDT policy (Document) ..... | 18 | +| 5.3.3.1 Description..... | 18 | +| 5.3.3.2 Resource definition..... | 18 | +| 5.3.3.3 Resource Standard Methods ..... | 18 | +| 5.3.3.3.1 GET ..... | 18 | +| 5.3.3.3.2 PATCH..... | 19 | +| 5.4 Custom Operations without associated resources ..... | 20 | +| 5.5 Notifications ..... | 20 | +| 5.5.1 General ..... | 20 | +| 5.5.2 BDT Notification..... | 21 | +| 5.5.2.1 Description..... | 21 | +| 5.5.2.2 Target URI ..... | 21 | +| 5.5.2.3 Standard Methods ..... | 21 | +| 5.5.2.3.1 POST ..... | 21 | +| 5.6 Data Model..... | 22 | + +- 5.6.1 General ..... 22 +- 5.6.2 Structured data types ..... 23 + - 5.6.2.1 Introduction..... 23 + - 5.6.2.2 Type BdtPolicy ..... 23 + - 5.6.2.3 Type BdtReqData ..... 24 + - 5.6.2.4 Type BdtPolicyData..... 25 + - 5.6.2.5 Type TransferPolicy ..... 25 + - 5.6.2.6 Type BdtPolicyDataPatch..... 25 + - 5.6.2.7 Void ..... 26 + - 5.6.2.8 Type NetworkAreaInfo ..... 26 + - 5.6.2.9 Void ..... 26 + - 5.6.2.10 Type Notification..... 26 + - 5.6.2.11 Type PatchBdtPolicy ..... 26 + - 5.6.2.12 Type BdtReqDataPatch..... 27 +- 5.6.3 Simple data types and enumerations ..... 27 + - 5.6.3.1 Introduction..... 27 + - 5.6.3.2 Simple data types ..... 27 +- 5.7 Error handling ..... 27 + - 5.7.1 General ..... 27 + - 5.7.2 Protocol Errors..... 27 + - 5.7.3 Application Errors ..... 27 +- 5.8 Feature negotiation..... 28 +- 5.9 Security..... 28 + +**Annex A (normative): OpenAPI specification ..... 29** + +- A.1 General..... 29 +- A.2 Npcf\_BDTPolicyControl API..... 29 + +**Annex B (informative): Change history..... 36** + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 1 Scope + +The present specification provides the stage 3 definition of the Background Data Transfer (BDT) Policy Control Service (Npcf\_BDTPolicyControl) of the 5G System. + +The 5G System Architecture is defined in 3GPP TS 23.501 [2]. The stage 2 definition and related procedures for BDT Policy Control Service are specified in 3GPP TS 23.502 [3] and 3GPP TS 23.503 [4]. + +The 5G System stage 3 call flows are provided in 3GPP TS 29.513 [5]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [6] and 3GPP TS 29.501 [7]. + +The Policy Control Function (PCF) provides the BDT Policy Control Service. This service provides background data transfer policy negotiation function. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 23.503: "Policy and Charging Control Framework for the 5G System; Stage 2". +- [5] 3GPP TS 29.513: "5G System; Policy and Charging Control signalling flows and QoS parameter mapping; Stage 3". +- [6] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [7] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [8] IETF RFC 7540: "Hypertext Transfer Protocol Version 2 (HTTP/2)". +- [9] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [10] OpenAPI: "OpenAPI 3.0.0 Specification", . +- [11] 3GPP TS 29.504: "5G System; Unified Data Repository Services; Stage 3". +- [12] 3GPP TS 29.519: "5G System; Usage of the Unified Data Repository service for Policy Data, Application Data and Structured Data for exposure; Stage 3". +- [13] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". +- [14] 3GPP TS 29.122: "T8 reference point for Northbound APIs". +- [15] IETF RFC 7396: "JSON Merge Patch". +- [16] IETF RFC 3986: "Uniform Resource Identifier (URI): Generic Syntax". + +- [17] IETF RFC 7807: "Problem Details for HTTP APIs". +- [18] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [19] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [20] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". +- [21] 3GPP TR 21.900: "Technical Specification Group working methods". +- [22] 3GPP TS 29.520: "5G System; Network Data Analytics Services; Stage 3". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +**Background data transfer:** feature that enables a 3rd party service provider to keep their costs lower by favouring time windows for data transfer to specific UEs in a geographical area during non-busy hours that are less costly and able to handle larger bitrates. + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 23.501 [2], subclause 3.1 apply: + +**5G System** + +**Network Function** + +**NF service** + +**NF service operation** + +**Service based interface** + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|---------|-------------------------------------------------------| +| AF | Application Function | +| ASP | Application Service Provider | +| BDT | Background Data Transfer | +| DNN | Data Network Name | +| JSON | JavaScript Object Notation | +| NEF | Network Exposure Function | +| NG-RAN | Next Generation - Radio Access Network | +| NRF | Network Repository Function | +| NWDAF | Network Data Analytics Function | +| PCF | Policy Control Function | +| SBI | Service Based Interface | +| S-NSSAI | Single Network Slice Selection Assistance Information | +| TAI | Tracking Area Identity | +| UDR | Unified Data Repository | + +# 4 Background Data Transfer Policy Control Service + +## 4.1 Service Description + +### 4.1.1 Overview + +The BDT Policy Control Service, as defined in 3GPP TS 23.502 [3] and 3GPP TS 23.503 [4], is provided by the Policy Control Function (PCF). + +This service enables the NF service consumer to negotiate policy for a future background data transfer and offers the following functionalities: + +- get background data transfer policies based on the request from the NEF; +- update background data transfer policies based on the selection provided by the NEF; and +- provide background data transfer warning notification to trigger renegotiation of background data transfer policy. + +### 4.1.2 Service Architecture + +The 5G System Architecture is defined in 3GPP TS 23.501 [2]. The Policy and Charging related 5G architecture is also described in 3GPP TS 29.513 [5]. + +The BDT Policy Control Service (Npcf\_BDTPolicyControl) is part of the Npcf service-based interface exhibited by the Policy Control Function (PCF). + +The only known NF service consumer of the Npcf\_BDTPolicyControl service is the Network Exposure Function (NEF). + +The NEF accesses the BDT Policy Control Service at the PCF via the N30 Reference point. In the roaming scenario, the N30 reference point is located between the PCF and the NEF in the home network only. + +![Reference Architecture for the Npcf_BDTPolicyControl Service; SBI representation](18f841ac4f2ef28f34a026f1bdc5af9a_img.jpg) + +The diagram illustrates the service-based interface (SBI) representation for the Npcf\_BDTPolicyControl service. At the top, a rectangular box labeled 'PCF' contains an oval labeled 'Npcf', representing the service provided by the PCF. At the bottom, a rectangular box is labeled 'NEF', representing the network function that consumes the service. A vertical line connects the 'Npcf' oval to the 'NEF' box, with the label 'Npcf\_BDTPolicyControl' placed to the right of the line, indicating the specific service interface. + +Reference Architecture for the Npcf\_BDTPolicyControl Service; SBI representation + +Figure 4.1.2-1: Reference Architecture for the Npcf\_BDTPolicyControl Service; SBI representation + +![Reference Architecture for the Npcf_BDTPolicyControl Service; reference point representation. The diagram shows a PCF (Policy Control Function) connected to an NEF (Network Exposure Function) via the N30 reference point.](b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg) + +``` + +graph TD + PCF[PCF] --- N30((N30)) + N30 --- NEF[NEF] + +``` + +Reference Architecture for the Npcf\_BDTPolicyControl Service; reference point representation. The diagram shows a PCF (Policy Control Function) connected to an NEF (Network Exposure Function) via the N30 reference point. + +**Figure 4.1.2-2: Reference Architecture for the Npcf\_BDTPolicyControl Service; reference point representation** + +### 4.1.3 Network Functions + +#### 4.1.3.1 Policy Control Function (PCF) + +The Policy Control Function (PCF): + +- Provides background data transfer policies based on the request from the NEF. The PCF determines, based on information provided by the NEF and other available information (e.g. network policy, load status estimation for the requested time window, network area, etc.) one or more transfer policies. +- Updates background data transfer policy based on the selection provided by the NEF. +- Sends the background data transfer warning notification to the NEF. + +#### 4.1.3.2 NF Service Consumers + +The Network Exposure Function (NEF): + +- requests the PCF to provide background data transfer policies; +- provides the selected background data transfer policy to the PCF; and +- indicates to the PCF whether to provide a BDT warning notification. + +## 4.2 Service Operations + +### 4.2.1 Introduction + +**Table 4.2.1-1: Operations of the Npcf\_BDTPolicyControl Service** + +| Service operation name | Description | Initiated by | +|------------------------------|-----------------------------------------------------------------------------------------------|---------------------------| +| Npcf_BDTPolicyControl_Create | Provides the requested background data transfer policies to the NF service consumer. | NF service consumer (NEF) | +| Npcf_BDTPolicyControl_Update | Updates the PCF with the background data transfer policy selected by the NF service consumer. | NF service consumer (NEF) | +| Npcf_BDTPolicyControl_Notify | Sends the BDT notification to the NF service consumer. | PCF | + +### 4.2.2 Npcf\_BDTPolicyControl\_Create service operation + +#### 4.2.2.1 General + +The Npcf\_BDTPolicyControl\_Create service operation is used by an NF service consumer to retrieve BDT policies from the PCF. + +The following procedure using the Npcf\_BDTPolicyControl\_Create service operation is supported: + +- retrieval of BDT policies. + +#### 4.2.2.2 Retrieval of BDT policies + +This procedure is used by the NEF to request BDT policies from the PCF, as defined in 3GPP TS 23.501 [2], 3GPP TS 23.502 [3] and 3GPP TS 23.503 [4]. + +Figure 4.2.2.2-1 illustrates a retrieval of BDT policies. + +![Sequence diagram illustrating the retrieval of BDT policies between NEF and PCF.](54fabc351eda5228d2fa28cd9ba07971_img.jpg) + +``` +sequenceDiagram + participant NEF + participant PCF + Note right of NEF: 1. POST .../bdtpolicies + NEF->>PCF: Request + Note left of PCF: 2. "201 Created" + PCF-->>NEF: Response +``` + +The diagram shows a sequence of two messages between the NEF and the PCF. The NEF sends a message labeled "1. POST .../bdtpolicies" to the PCF. The PCF responds with a message labeled "2. '201 Created'" to the NEF. + +Sequence diagram illustrating the retrieval of BDT policies between NEF and PCF. + +**Figure 4.2.2.2-1: Retrieval of BDT policies** + +Upon reception of a Background Data Transfer request from the AF indicating a transfer policy request, the NEF shall invoke the Npcf\_BDTPolicyControl\_Create service operation by sending an HTTP POST request to the URI representing a "BDT policies" collection resource of the PCF (as shown in figure 4.2.2.2-1, step 1). The NEF shall include a "BdtReqData" data type in a payload body of the HTTP POST request. The "BdtReqData" data type shall contain: + +- an ASP identifier in the "aspId" attribute; +- a volume of data per UE in the "volPerUe" attribute; +- an expected number of UEs in the "numOfUes" attribute; +- a desired time window in the "desTimeInt" attribute; and +- if "BdtNotification\_5G" feature is supported a notification URI in the "notifUri" attribute, + +and may include: + +- a network area information (e.g. list of TAIs and/or NG-RAN nodes and/or cells identifiers) in the "nwAreaInfo" attribute; +- an identification of a group of UE(s) via an "interGroupId" attribute; +- a traffic descriptor of background data within the "trafficDes" attribute; +- if "BdtNotification\_5G" feature is supported an indication that BDT warning notification is requested in the "warnNotifReq" attribute; and +- a DNN and an S-NSSAI, corresponding to the ASP identifier, in the "dnn" attribute and the "snssai" attribute respectively. + +If the PCF cannot successfully fulfil the received HTTP POST request due to the internal PCF error or due to the error in the HTTP POST request, the PCF shall send the HTTP error response as specified in subclause 5.7. + +Otherwise, upon the reception of the HTTP POST request from the NEF indicating a BDT policies request, the PCF: + +- may invoke the Nudr\_DataRepository\_Query service operation, as described in 3GPP TS 29.504 [11] and 3GPP TS 29.519 [12], to request from the UDR all stored transfer policies; + +NOTE 1: In case only one PCF is deployed in the network, transfer policies can be locally stored in the PCF and the interaction with the UDR is not required. + +- shall determine one or more acceptable transfer policies based on: + - a) information provided by the NEF; and + - b) other available information (e.g. the existing transfer policies, network policy, load status estimation for the desired time window); and +- shall create a BDT Reference ID. + +The PCF shall send to the NEF a "201 Created" response to the HTTP POST request, as shown in figure 4.2.2.2-1, step 2. The PCF shall include in the "201 Created" response: + +- a Location header field; and +- a "BdtPolicy" data type in the payload body containing the BDT Reference ID in the "bdtRefId" attribute and acceptable transfer policy/ies in the "transfPolicies" attribute. + +The Location header field shall contain the URI of the created individual BDT policy resource i.e. "{apiRoot}/npcf-bdtpolicycontrol/v1/bdtpolicies/{bdtPolicyId}". + +For each included transfer policy, the PCF shall provide: + +- a transfer policy ID in the "transPolicyId" attribute; +- a recommended time window in the "recTimeInt" attribute; and +- a reference to charging rate for the recommended time window in the "ratingGroup" attribute, + +and may provide a maximum aggregated bitrate for the uplink direction in the "maxBitRateUl" attribute and/or a maximum aggregated bitrate for the downlink direction in the "maxBitRateDl" attribute. + +If the BdtNotification\_5G feature is supported the PCF shall not assign value "0" for any transfer policy ID. + +NOTE 2: As specified in subclause 4.2.3.2, value "0" of transfer policy ID is reserved and indicates that no transfer policy is selected. + +The PCF may map the ASP identifier into a target DNN and S-NSSAI based on local configuration if the NEF did not provide the DNN and S-NSSAI to the PCF. + +If the PCF included in the "BdtPolicy" data type: + +- more than one transfer policy, the PCF shall wait for the transfer policy selected by the NEF as described in subclause 4.2.3; or +- only one transfer policy, the PCF may invoke the Nudr\_DataRepository\_Update service operation, as described in 3GPP TS 29.504 [11] and 3GPP TS 29.519 [12] subclause 5.2.9.3.2, to update the UDR with the selected transfer policy, the corresponding BDT Reference ID, the volume of data per UE, the expected number of UEs and, if available, a network area information, the associated DNN and S-NSSAI for the provided ASP identifier. + +NOTE 3: In case only one PCF is deployed in the network, transfer policies can be locally stored in the PCF and the interaction with the UDR is not required. + +### 4.2.3 Npcf\_BDTPolicyControl\_Update service operation + +#### 4.2.3.1 General + +The Npcf\_BDTPolicyControl\_Update service operation is used by an NF service consumer to update a BDT policy to the PCF. + +The following procedure using the Npcf\_BDTPolicyControl\_Update service operation are supported: + +- indication about selected transfer policy; and +- modification of a BDT warning notification request indication. + +#### 4.2.3.2 Indication about selected transfer policy + +When the feature "PatchCorrection" is supported, this procedure is used by the NEF to inform the PCF about selected transfer policy, as defined in 3GPP TS 23.501 [2], 3GPP TS 23.502 [3] and 3GPP TS 23.503 [4], if the AF selected the transfer policy from the received transfer policy list after: + +- retrieval of the BDT policies as described in subclause 4.2.2; or +- reception of the BDT warning notification as described in subclause 4.2.4. + +Figure 4.2.3.2-1 illustrates an indication about selected transfer policy. + +![Sequence diagram showing the interaction between NEF and PCF for indicating a selected transfer policy. The NEF sends a PATCH request to the PCF, and the PCF responds with either a 204 No Content or a 200 OK status.](853f59c89931a666c07903b31d098277_img.jpg) + +``` + +sequenceDiagram + participant NEF + participant PCF + Note right of NEF: 1. PATCH .../bdtpolicies/{bdtpolicyId} + NEF->>PCF: Request + Note left of PCF: 2a. "204 No Content" or +2b. "200 OK" + PCF-->>NEF: Response + +``` + +Sequence diagram showing the interaction between NEF and PCF for indicating a selected transfer policy. The NEF sends a PATCH request to the PCF, and the PCF responds with either a 204 No Content or a 200 OK status. + +**Figure 4.2.3.2-1: Indication about selected transfer policy** + +Upon reception of a Background Data Transfer request from the AF indicating transfer policy selection, the NEF shall invoke the Npcf\_BDTPolicyControl\_Update service operation by sending an HTTP PATCH request to the PCF, as shown in figure 4.2.3.2-1, step 1. The NEF shall set the request URI to "{apiRoot}/npcf-bdtpolicycontrol/v1/bdtpolicies/{bdtpolicyId}". + +The NEF shall include a "PatchBdtPolicy" data type in a payload body of the HTTP PATCH request. When the AF selects a transfer policy, the "PatchBdtPolicy" data type shall contain a "bdtPolData" attribute which shall encode the transfer policy ID of the selected transfer policy in the "selTransPolicyId" attribute. In the case of transfer policy re-negotiation and if the BdtNotification\_5G feature is supported and the AF did not select any transfer policy, the NEF shall set the "selTransPolicyId" attribute to value "0" to indicate no transfer policy is selected. + +If the PCF cannot successfully fulfil the received HTTP PATCH request due to the internal PCF error or due to the error in the HTTP PATCH request, the PCF shall send the HTTP error response as specified in subclause 5.7. + +If the feature "ES3XX" is supported, and the PCF determines the received HTTP PATCH request needs to be redirected, the PCF shall send an HTTP redirect response as specified in subclause 6.10.9 of 3GPP TS 29.500 [6]. + +Otherwise, upon the reception of the HTTP PATCH request from the NEF, the PCF: + +- in case of the initial transfer policy negotiation may invoke the Nudr\_DataRepository\_Update service operation, as described in 3GPP TS 29.504 [11] and 3GPP TS 29.519 [12] subclause 5.2.9.3.2, to update the UDR with the selected transfer policy, the corresponding BDT Reference ID, the volume of data per UE, the expected number of UEs and, if available, a network area information, the associated DNN and S-NSSAI for the provided ASP identifier; or +- in case of transfer policy re-negotiation may invoke: + - if a transfer policy is selected the Nudr\_DataRepository\_Update service operation, as described in 3GPP TS 29.504 [11] and 3GPP TS 29.519 [12] subclause 5.2.9.3.4, to update the UDR with the selected candidate transfer policy and set the "bdtpStatus" attribute to value "VALID" within the BdtDataPatch data type; or + - if no transfer policy is selected the Nudr\_DataRepository\_Delete service operation, as described in 3GPP TS 29.504 [11] and 3GPP TS 29.519 [12] subclause 5.2.9.3.3, to remove the transfer policy from the UDR; and + +NOTE: In case only one PCF is deployed in the network, transfer policies can be locally stored in the PCF and the interaction with the UDR is not required. + +- shall send: + - a) a "204 No Content" response (as shown in figure 4.2.3.2-1, step 2a); or + - b) a "200 OK" response (as shown in figure 4.2.3.2-1, step 2b) with a "BdtPolicy" data type in the payload body, +- to the HTTP PATCH request to the NEF. + +#### 4.2.3.3 Modification of BDT warning notification request indication + +This procedure is used by an AF to modify a BDT warning notification request indication when the feature "BdtNotification\_5G" and the feature "PatchCorrection" are supported. + +Upon reception of a request from the AF to modify the BDT warning notification request indication, the NEF shall invoke the Npcf\_BDTPolicyControl\_Update service operation by sending an HTTP PATCH request to the PCF, as described in subclause 4.2.3.2. The NEF shall indicate whether a BDT warning notification shall be enabled or disabled by including the "warnNotifReq" attribute in the "bdtReqData" attribute of the "PatchBdtPolicy" data type. + +If the BDT warning notification is not required anymore the NEF shall set the value of the "warnNotifReq" attribute to "false". + +If the BDT warning notification is again required the NEF shall set the value of the "warnNotifReq" attribute to "true". + +Upon the reception of the HTTP PATCH request from the NEF indicating a modification of the BDT warning notification request indication, the PCF shall acknowledge that request by sending an HTTP response message as described in subclause 4.2.3.2. + +### 4.2.4 Npcf\_BDTPolicyControl\_Notify service operation + +#### 4.2.4.1 General + +The Npcf\_BDTPolicyControl\_Notify service operation is used by the PCF to send the BDT notification to the NF service consumer. + +The following procedure using the Npcf\_BDTPolicyControl\_Notify service operation is supported: + +- sending the BDT warning notification to the NF service consumer. + +#### 4.2.4.2 Sending the BDT warning notification + +This procedure is used by the PCF to inform the NF service consumer that network performance in the area of interest goes below the criteria set by the operator, as defined in subclause 6.1.2.4 of 3GPP TS 23.503 [4]. + +Figure 4.2.4.2-1 illustrates a BDT warning notification from the PCF. + +![Sequence diagram showing BDT warning notification between PCF and NEF.](a33da0f14e456f92539ce3e9b7d81f9a_img.jpg) + +``` +sequenceDiagram + participant PCF + participant NEF + Note left of PCF: Error! No + Note right of NEF: Error! No text of specified style in + PCF->>NEF: 1. POST {notifUri} + NEF-->>PCF: 2. "204 No Content" +``` + +The diagram illustrates a sequence of two messages between a PCF (Policy Control Function) and an NEF (Network Exposure Function). The PCF sends a '1. POST {notifUri}' message to the NEF, and the NEF responds with a '2. "204 No Content"' message. The diagram is framed by two boxes labeled 'PCF' and 'NEF' at the top, with vertical lines extending downwards from each. The first message is a solid arrow pointing from the PCF's line to the NEF's line. The second message is a solid arrow pointing from the NEF's line back to the PCF's line. + +Sequence diagram showing BDT warning notification between PCF and NEF. + +**Figure 4.2.4.2-1: BDT warning notification** + +When the PCF knows that the network performance in the area of interest goes below the criteria set by the operator from the NWDAF as described in 3GPP TS 29.520 [22] and if the BDT warning notification is enabled, the PCF may try to re-negotiate the affected BDT policies with the affected AFs. To do this, the PCF retrieves all the background transfer policies together with their additionally stored AF provided information for BDT policy decision (e.g. their corresponding desired time window, the number of UEs, the volume of data per UE, etc.) from the UDR, identifies the BDT policy(ies) that are not desirable anymore due to the degradation of the network performance and tries to calculate one or more new candidate BDT policies based on the AF provided information, the background transfer policies retrieved from the UDR and the current network performance as follows: + +- If the BDT policies retrieved from the UDR include the "bdtpStatus" attribute indicating the BDT policy is invalid, the PCF may calculate one or more new candidate BDT policies without considering the invalid BDT policy. +- If the PCF does not find any new candidate BDT policies, the previously negotiated BDT policy shall be kept and no interaction with the AF shall occur. + +If one or more new candidate BDT policies are calculated, the PCF shall: + +- if the PCF has not locally stored the background transfer policies, invoke the Nudr\_DataRepository\_Update service operation, as described in 3GPP TS 29.504 [11] and 3GPP TS 29.519 [12] subclause 5.2.9.3.4, to invalidate the affected background transfer policy stored in the UDR by including the "bdtpStatus" attribute set to value "INVALID" within the BdtdDataPatch data type; and +- invoke the Npcf\_BDTPolicyControl\_Notify service operation by sending the HTTP POST request with the BDT warning notification to the NEF so that the NEF can notify the AF. + +The PCF shall include a "Notification" data type in a payload body of the HTTP POST request. + +The "Notification" data type provided in the request body: + +- shall contain the BDT Reference ID of the impacted transfer policy within the "bdtRefId" attribute; +- may contain the time window when the network performance will go below the criteria set by the operator within the "timeWindow" attribute; +- may contain the network area where the network performance will go below the criteria set by the operator within the "nwAreaInfo" attribute; and +- may contain the list of candidate transfer policies in the "candPolicies" attribute. + +**NOTE:** The AF might select a new background transfer policy or might not select any new background transfer policy from the offered candidate list when receives the BDT warning notification. + +Upon the reception of the HTTP POST request from the PCF, the NEF shall acknowledge that request by sending an HTTP response message with the corresponding status code. + +If the HTTP POST request from the PCF is accepted, the NEF shall acknowledge the receipt of the notification with a "204 No Content" response to HTTP POST request, as shown in figure 4.2.4.2-1, step 2. + +If the HTTP POST request from the PCF is not accepted, the NEF shall send an HTTP error response as specified in subclause 5.7. + +If the feature "ES3XX" is supported, and the NEF determines the received HTTP POST request needs to be redirected, the NEF shall send an HTTP redirect response as specified in subclause 6.10.9 of 3GPP TS 29.500 [6]. + +# --- 5 Npcf\_BDTPolicyControl API + +## 5.1 Introduction + +The BDT Policy Control Service shall use the Npcf\_BDTPolicyControl API. + +The API URI of the Npcf\_BDTPolicyControl API shall be: + +**{apiRoot}
//** + +The request URI used in each HTTP request from the NF service consumer towards the PCF shall have the structure defined in subclause 4.4.1 of 3GPP TS 29.501 [7], i.e.: + +**{apiRoot}
//** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [7]. +- The shall be "npcf-bdtpolicycontrol". +- The shall be "v1". +- The shall be set as described in subclause 5.3. + +## 5.2 Usage of HTTP + +### 5.2.1 General + +HTTP/2, IETF RFC 7540 [8], shall be used as specified in subclause 5.2 of 3GPP TS 29.500 [6]. + +HTTP/2 shall be transported as specified in subclause 5.3 of 3GPP TS 29.500 [6]. + +The OpenAPI [10] specification of HTTP messages and content bodies for the Npcf\_BDTPolicyControl is contained in Annex A. + +### 5.2.2 HTTP standard headers + +#### 5.2.2.1 General + +See subclause 5.2.2 of 3GPP TS 29.500 [6] for the usage of HTTP standard headers. + +#### 5.2.2.2 Content type + +JSON, IETF RFC 8259 [9], shall be used as content type of the HTTP bodies specified in the present specification as specified in subclause 5.4 of 3GPP TS 29.500 [6]. The use of the JSON format shall be signalled by the content type "application/json". + +JSON object used in the HTTP PATCH request shall be encoded according to "JSON Merge Patch" and shall be signalled by the content type "application/merge-patch+json", as defined in IETF RFC 7396 [15]. + +"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 7807 [17]. + +### 5.2.3 HTTP custom headers + +The Npcf\_BDTPolicyControl API shall support HTTP custom header fields specified in subclause 5.2.3.2 of 3GPP TS 29.500 [6]. + +In this Release of the specification, no specific custom headers are defined for the Npcf\_BDTPolicyControl API. + +## 5.3 Resources + +### 5.3.1 Resource Structure + +![Diagram showing the resource URI structure of the Npcf_BDTPolicyControl API. The root URI is {apiRoot}/npcf-bdtpolicycontrol/v1. A line branches down to a box containing /bdtpolicies. From this box, another line branches down to a box containing /{bdtpolicyId}.](b90144cfbb81a2d610d920240fda689d_img.jpg) + +``` + +graph TD + Root["{apiRoot}/npcf-bdtpolicycontrol/v1"] --> Policies["/bdtpolicies"] + Policies --> PolicyId["/{bdtpolicyId}"] + +``` + +Diagram showing the resource URI structure of the Npcf\_BDTPolicyControl API. The root URI is {apiRoot}/npcf-bdtpolicycontrol/v1. A line branches down to a box containing /bdtpolicies. From this box, another line branches down to a box containing /{bdtpolicyId}. + +**Figure 5.3.1-1: Resource URI structure of the Npcf\_BDTPolicyControl API** + +Table 5.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 5.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|-----------------------|----------------------------|---------------------------------|-------------------------------------------------------------------------------------------------------------------------------------| +| BDT policies | /bdtpolicies | POST | Npcf_BDTPolicyControl_Create.
Creates a new Individual BDT policy resource. | +| Individual BDT policy | /bdtpolicies/{bdtpolicyId} | GET | Reads an Individual BDT policy resource. | +| | | PATCH | Npcf_BDTPolicyControl_Update.
Modifies an existing Individual BDT policy resource by selecting or reselecting a transfer policy. | + +### 5.3.2 Resource: BDT policies (Collection) + +#### 5.3.2.1 Description + +The BDT policies resource represents all the transfer policies that exist in the BDT Policy Control service at a given PCF instance. + +#### 5.3.2.2 Resource definition + +Resource URI: {apiRoot}/npcf-bdtpolicycontrol/v1/bdtpolicies + +This resource shall support the resource URI variables defined in table 5.3.2.2-1. + +**Table 5.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|--------------------| +| apiRoot | string | See subclause 5.1. | + +#### 5.3.2.3 Resource Standard Methods + +##### 5.3.2.3.1 POST + +This method shall support the URI query parameters specified in table 5.3.2.3.1-1. + +**Table 5.3.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.3.2.3.1-2 and the response data structures and response codes specified in table 5.3.2.3.1-3. + +**Table 5.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------|---|-------------|--------------------------------------------------------------------------------| +| BdtReqData | M | 1 | Contains information for the creation of a new Individual BDT policy resource. | + +**Table 5.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response Codes | Description | +|----------------------------------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| BdtPolicy | M | 1 | 201 Created | Successful case.
The creation of an Individual BDT policy resource is confirmed and a representation of that resource is returned. | +| n/a | | | 303 See Other | The result of the HTTP POST request would be equivalent to the existing Individual BDT policy resource. The HTTP response shall contain a Location header field set to the URI of the existing individual BDT policy resource. | +| NOTE: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [6] for the POST method shall also apply. | | | | | + +**Table 5.3.2.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure: {apiRoot}/npcf-bdtpolicycontrol/v1/bdtpolicies/{bdtpolicyId}. | + +**Table 5.3.2.3.1-5: Headers supported by the 303 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the existing individual BDT policy resource. | + +#### 5.3.2.4 Resource Custom Operations + +None. + +### 5.3.3 Resource: Individual BDT policy (Document) + +#### 5.3.3.1 Description + +The Individual BDT policy resource represents the transfer policies that exist in the BDT Policy Control service at a given PCF instance. + +#### 5.3.3.2 Resource definition + +Resource URI: {apiRoot}/npcf-bdtpolicycontrol/v1/bdtpolicies/{bdtpolicyId} + +This resource shall support the resource URI variables defined in table 5.3.3.2-1. + +**Table 5.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|-------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See subclause 5.1. | +| bdtpolicyId | string | Identifies the individual BDT policy resource in the PCF.
To enable the value to be used as part of a URI, the string shall only contain allowed characters according to the "lower-with-hyphen" naming convention defined in subclause 5.1.3 of 3GPP TS 29.501 [7] and rules for a path segment defined in IETF RFC 3986 [16]. | + +#### 5.3.3.3 Resource Standard Methods + +##### 5.3.3.3.1 GET + +This method shall support the URI query parameters specified in table 5.3.3.3.1-1. + +**Table 5.3.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.3.3.3.1-2 and the response data structures and response codes specified in table 5.3.3.3.1-3. + +**Table 5.3.3.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.3.3.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| BdtPolicy | M | 1 | 200 OK | A representation of an Individual BDT policy resource is returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative PCF (service) instance.
Applicable if the feature "ES3XX" is supported. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative PCF (service) instance.
Applicable if the feature "ES3XX" is supported. | +| ProblemDetails | O | 0..1 | 404 Not Found | (NOTE 2) | + +NOTE 1: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [6] for the GET method shall also apply. +NOTE 2: Failure cases are described in subclause 5.7. + +**Table 5.3.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative PCF (service) instance. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the request is redirected. | + +**Table 5.3.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative PCF (service) instance. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the request is redirected. | + +##### 5.3.3.3.2 PATCH + +This method shall support the URI query parameters specified in table 5.3.3.3.2-1. + +**Table 5.3.3.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.3.3.3.2-2 and the response data structures and response codes specified in table 5.3.3.3.2-3. + +**Table 5.3.3.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| PatchBdtPolicy | M | 1 | Contains modification instructions to be performed on the BdtPolicy data structure to select a transfer policy and in addition, may indicate whether the BDT warning notification is enabled or disabled. | + +**Table 5.3.3.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response Codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| BdtPolicy | M | 1 | 200 OK | Successful case.
The Individual BDT Policy resource is modified and a representation of that resource is returned. | +| n/a | | | 204 No Content | Successful case.
The Individual BDT Policy resource is modified. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during resource modification.
The response shall include a Location header field containing an alternative URI of the resource located in an alternative PCF (service) instance.
Applicable if the feature "ES3XX" is supported. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during resource modification.
The response shall include a Location header field containing an alternative URI of the resource located in an alternative PCF (service) instance.
Applicable if the feature "ES3XX" is supported. | +| ProblemDetails | O | 0..1 | 404 Not Found | (NOTE 2) | + +NOTE 1: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [6] for the PATCH method shall also apply. + +NOTE 2: Failure cases are described in subclause 5.7. + +**Table 5.3.3.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative PCF (service) instance. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the request is redirected. | + +**Table 5.3.3.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative PCF (service) instance. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the request is redirected. | + +## 5.4 Custom Operations without associated resources + +No custom operation is defined in this Release of the specification. + +## 5.5 Notifications + +### 5.5.1 General + +Notifications shall comply to subclause 6.2 of 3GPP TS 29.500 [6] and subclause 4.6.2.3 of 3GPP TS 29.501 [7]. + +**Table 5.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|------------------|--------------|---------------------------------|---------------------------------| +| BDT Notification | {notifUri} | POST | Provides BDT notification. | + +### 5.5.2 BDT Notification + +#### 5.5.2.1 Description + +The BDT Notification is used by the PCF to notify the NF service consumer about changed conditions for background data transfer e.g. that a network performance in the area of interest goes below the criteria set by the operator. + +#### 5.5.2.2 Target URI + +The Callback URI "{notifUri}" shall be used with the callback URI variables defined in table 5.5.2.2-1. + +**Table 5.5.2.2-1: Callback URI variables** + +| Name | Data type | Definition | +|----------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notifUri | Uri | It contains the URI of the recipient of BDT notification as assigned by the NF service consumer during the Create service operation and described within the BdtReqData (see table 5.6.2.3-1). | + +#### 5.5.2.3 Standard Methods + +##### 5.5.2.3.1 POST + +This method shall support the URI query parameters specified in table 5.5.2.3.1-1. + +**Table 5.5.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.5.2.3.1-2 and the response data structures and response codes specified in table 5.5.2.3.1-3. + +**Table 5.5.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------|---|-------------|----------------------------| +| Notification | M | 1 | Provides BDT notification. | + +**Table 5.5.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful case.
The reception of the BDT notification is acknowledged. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative NF consumer (service) instance where the notification should be sent. Applicable if the feature "ES3XX" is supported. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative NF consumer (service) instance where the notification should be sent. Applicable if the feature "ES3XX" is supported. | + +NOTE: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [6] for the POST method shall also apply. + +**Table 5.5.2.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected. | + +**Table 5.5.2.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected. | + +## 5.6 Data Model + +### 5.6.1 General + +This subclause specifies the application data model supported by the API. + +Table 5.6.1-1 specifies the data types defined for the Npcf\_BDTPolicyControl service based interface protocol. + +**Table 5.6.1-1: Npcf\_BDTPolicyControl specific Data Types** + +| Data type | Section defined | Description | Applicability | +|--------------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| BdtPolicy | 5.6.2.2 | Represents an Individual BDT policy resource. | | +| BdtPolicyData | 5.6.2.4 | Describes an Individual BDT policy resource. | | +| BdtPolicyDataPatch | 5.6.2.6 | Contains modification instructions to be performed on the "bdtPolData" property of the BdtPolicy data structure to select a transfer policy. | | +| BdtReqData | 5.6.2.3 | Contains information for creation a new Individual BDT policy resource. | | +| BdtReqDataPatch | 5.6.2.12 | Describes the modifications to the BDT request data of an Individual BDT policy resource. | PatchCorrection | +| NetworkAreaInfo | 5.6.2.8 | Describes a network area information in which the NF service consumer requests the number of UEs. | | +| Notification | 5.6.2.10 | Contains the BDT notification information. | BdtNotification_5G | +| PatchBdtPolicy | 5.6.2.11 | Describes the modifications to the BDT Policy Data and BDT Policy Request data of an Individual BDT policy resource. | PatchCorrection | +| TransferPolicy | 5.6.2.5 | Describes a transfer policy. | | + +Table 5.6.1-2 specifies data types re-used by the Npcf\_BDTPolicyControl service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Npcf\_BDTPolicyControl service based interface. + +**Table 5.6.1-2: Npcf\_BDTPolicyControl re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-------------------|---------------------|--------------------------------------------------------------------------------------|----------------------| +| BdtReferenceId | 3GPP TS 29.122 [14] | Identifies transfer policy of background data transfer for provided ASP. | | +| BitRate | 3GPP TS 29.571 [13] | Specifies bitrate in kbits per second. | | +| Dnn | 3GPP TS 29.571 [13] | Identifies a Data Network Name. | | +| Ecgi | 3GPP TS 29.571 [13] | Represents an EUTRA cell identifier. | | +| GlobalRanNodeId | 3GPP TS 29.571 [13] | Represents an identity of the NG-RAN node. | | +| GroupId | 3GPP TS 29.571 [13] | Identifies a group of UEs. | | +| Ncgi | 3GPP TS 29.571 [13] | Represents an NR cell identifier. | | +| ProblemDetails | 3GPP TS 29.571 [13] | Used in error responses to provide more detailed information about an error. | | +| RedirectResponse | 3GPP TS 29.571 [13] | Contains redirection related information. | ES3XX | +| Snsai | 3GPP TS 29.571 [13] | Identifies a Single Network Slice Selection Assistance Information. | | +| SupportedFeatures | 3GPP TS 29.571 [13] | Used to negotiate the applicability of the optional features defined in table 5.8-1. | | +| Tai | 3GPP TS 29.571 [13] | Represents a tracking area identity. | | +| TimeWindow | 3GPP TS 29.122 [14] | Specifies a time interval. | | +| TrafficDescriptor | 3GPP TS 29.122 [14] | Represents a traffic descriptor. | | +| Uri | 3GPP TS 29.571 [13] | String providing an URI. | BdtNotification_5G | +| UsageThreshold | 3GPP TS 29.122 [14] | Represents a data volume expected to be transferred per UE. | | + +### 5.6.2 Structured data types + +#### 5.6.2.1 Introduction + +This subclause defines the structures to be used in resource representations. + +#### 5.6.2.2 Type BdtPolicy + +**Table 5.6.2.2-1: Definition of type BdtPolicy** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| bdtpolData | BdtPolicyData | C | 0..1 | Describes the authorization data of an Individual BDT Policy created by the PCF.
It shall be present in the response to the POST request that requests a creation of an Individual BDT Policy resource and in the response to GET request. | | +| bdtpReqData | BdtReqData | C | 0..1 | Identifies the service requirements of an Individual BDT Policy.
It shall be present in the POST request that requests a creation of an Individual BDT Policy resource and in the response to GET request. | | + +#### 5.6.2.3 Type BdtReqData + +**Table 5.6.2.3-1: Definition of type BdtReqData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| aspId | AspId | M | 1 | This IE contains an identity of an application service provider. | | +| desTimeInt | TimeWindow | M | 1 | This IE indicates a desired time window for BDT. | | +| dnn | Dnn | O | 0..1 | This IE identifies a DNN. | | +| interGroupId | GroupId | O | 0..1 | Represents an internal group identifier and identifies a group of UEs. | | +| notifUri | Uri | O | 0..1 | This IE indicates that the NF service consumer requests a BDT notification from the PCF. It contains an URI of the recipient of BDT notification. | BdtNotification_5G | +| nwAreaInfo | NetworkAreaInfo | O | 0..1 | This IE represents a network area information in which the NF service consumer requests a number of UEs.
It may be present in the POST request that requests a creation of an Individual BDT Policy and in the response to GET request. | | +| numOfUes | integer | M | 1 | This IE indicates a number of UEs. | | +| snssai | Snssai | O | 0..1 | This IE identifies a slice. | | +| suppFeat | SupportedFeatures | C | 0..1 | This IE represents a list of Supported features used as described in subclause 5.8. It shall be supplied by the NF service consumer in the POST request that request a creation of an Individual BDT Policy resource. | | +| trafficDes | TrafficDescriptor | O | 0..1 | Contains the traffic descriptor of the background data. | | +| volPerUe | UsageThreshold | M | 1 | This IE indicates a data volume expected to be transferred per UE. | | +| warnNotifReq | boolean | O | 0..1 | This IE indicates whether the BDT warning notification is enabled or disabled.
It may be present:
- in the POST request that requests a creation of an Individual BDT Policy and in the corresponding response; and
- in responses to GET and PATCH requests.

true: enabled;
false: disabled (default). | BdtNotification_5G | + +#### 5.6.2.4 Type BdtPolicyData + +**Table 5.6.2.4-1: Definition of type BdtPolicyData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|-----------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| bdtRefId | BdtReferenceId | M | 1 | This IE indicates transfer policies of background data transfer for provided ASP. | | +| selTransPolicyId | integer | C | 0..1 | This IE contains the identity of the selected transfer policy. It shall be present in the response to the PATCH request that modifies an Individual BDT Policy resource to indicate a selected transfer policy. | | +| suppFeat | SupportedFeatures | C | 0..1 | This IE represents a list of Supported features used as described in subclause 5.8. It shall be supplied by the PCF in the response to the POST request that requests a creation of an Individual BDT Policy resource. | | +| transfPolicies | array(TransferPolicy) | M | 1..N | This IE contains transfer policies. It shall be supplied by the PCF in the response to the POST request that requests a creation of an Individual BDT Policy resource. | | + +#### 5.6.2.5 Type TransferPolicy + +**Table 5.6.2.5-1: Definition of type TransferPolicy** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------|---|-------------|-------------------------------------------------------------------------------------------------|---------------| +| maxBitRateDl | BitRate | O | 0..1 | This IE indicates a maximum aggregated bitrate in the downlink direction authorized by the PCF. | | +| maxBitRateUpl | BitRate | O | 0..1 | This IE indicates a maximum aggregated bitrate in the uplink direction authorized by the PCF. | | +| ratingGroup | integer | M | 1 | This IE indicates a rating group for the recommended time window. | | +| recTimeInt | TimeWindow | M | 1 | This IE indicates a recommended time window of a transfer policy. | | +| transPolicyId | integer | M | 1 | This IE contains an identity of a transfer policy. | | + +#### 5.6.2.6 Type BdtPolicyDataPatch + +**Table 5.6.2.6-1: Definition of type BdtPolicyDataPatch** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| selTransPolicyId | integer | M | 1 | This IE contains an identity (i.e. the transPolicyId value) of a selected transfer policy.
If the BdtNotification_5G feature is supported value "0" indicates that no transfer policy is selected. | | + +#### 5.6.2.7 Void + +#### 5.6.2.8 Type NetworkAreaInfo + +Table 5.6.2.8-1: Definition of type NetworkAreaInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------|---------------| +| ecgis | array(Ecgi) | O | 1..N | This IE contains a list of E-UTRA cell identities. | | +| ncgis | array(Ncgi) | O | 1..N | This IE contains a list of NR cell identities. | | +| gRanNodeIds | array(GlobalRanNodeId) | O | 1..N | This IE contains a list of the NG-RAN nodes.
The "n3lwfl" attribute within the "GlobalRanNodeId" data type shall not be supplied. | | +| tais | array(Tai) | O | 1..N | This IE contains a list of tracking area identities. | | + +NOTE: The NetworkAreaInfo data type allows any combination of defined properties. + +#### 5.6.2.9 Void + +#### 5.6.2.10 Type Notification + +Table 5.6.2.10-1: Definition of type Notification + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| bdRefId | BdtReferenceId | M | 1 | This IE indicates transfer policies of background data transfer which the notification corresponds to. | | +| candPolicies | array(TransferPolicy) | O | 1..N | This IE contains a list of the candidate transfer policies from which the AF may select a new transfer policy due to a network performance is below the criteria set by the operator. | | +| nwAreaInfo | NetworkAreaInfo | O | 0..1 | This IE represents a network area where a network performance will go below the criteria set by the operator. | | +| timeWindow | TimeWindow | O | 0..1 | This IE indicates a time window when a network performance will go below the criteria set by the operator. | | + +#### 5.6.2.11 Type PatchBdtPolicy + +Table 5.6.2.11-1: Definition of type PatchBdtPolicy + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| bdPolData | BdtPolicyDataPatch | O | 0..1 | Describes the updates in BDT policy data of an Individual BDT Policy resource, e.g., describes the selected BDT policy. | | +| bdReqData | BdtReqDataPatch | O | 0..1 | Describes the updates in BDT policy request data of an Individual BDT Policy resource, e.g., describes the updates in warning notification requirements. | | + +#### 5.6.2.12 Type BdtReqDataPatch + +**Table 5.6.2.12-1: Definition of type BdtReqDataPatch** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|--------------------------------------------------------------------------------|--------------------| +| warnNotifReq | boolean | O | 0..1 | This IE indicates whether the BDT warning notification is enabled or disabled. | BdtNotification_5G | + +### 5.6.3 Simple data types and enumerations + +#### 5.6.3.1 Introduction + +This subclause defines simple data types and enumerations that can be referenced from data structures defined in the previous subclauses. + +#### 5.6.3.2 Simple data types + +The simple data types defined in table 5.6.3.2-1 shall be supported. + +**Table 5.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|------------------------------------------------------------------|---------------| +| Aspld | string | This IE contains an identity of an application service provider. | | + +## 5.7 Error handling + +### 5.7.1 General + +HTTP error handling shall be supported as specified in subclause 5.2.4 of 3GPP TS 29.500 [6]. + +For the Npcf\_BDTPolicyControl API, HTTP error responses shall be supported as specified in subclause 4.8 of 3GPP TS 29.501 [7]. + +Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [6] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [6]. + +In addition, the requirements in the following subclauses shall apply. + +### 5.7.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the Npcf\_BDTPolicyControl API. + +### 5.7.3 Application Errors + +The application errors defined for the Npcf\_BDTPolicyControl API are listed in table 5.7.3-1. + +**Table 5.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|---------------------------------------------------------------------------------------------------------------| +| BDT_POLICY_NOT_FOUND | 404 Not Found | The HTTP request is rejected because the specified Individual BDT policy resource does not exist.
(NOTE 1) | +| NOTE 1: This application error is included in the responses to the GET and PATCH requests. | | | +| NOTE 2: Including a "ProblemDetails" data structure with the "cause" attribute in the HTTP response is optional unless explicitly mandated in the service operation subclauses. | | | + +## 5.8 Feature negotiation + +The optional features in table 5.8-1 are defined for the Npcf\_BDTPolicyControl API. They shall be negotiated using the extensibility mechanism defined in subclause 6.6.2 of 3GPP TS 29.500 [6]. + +When requesting the PCF to create an Individual BDT policy resource the NF service consumer shall indicate the optional features the NF service consumer supports for the Npcf\_BDTPolicyControl service by including the "suppFeat" attribute in the "BdtReqData" data type of the HTTP POST request. + +The PCF shall determine the supported features for the created Individual BDT policy resource as specified in subclause 6.6.2 of 3GPP TS 29.500 [6]. The PCF shall indicate the supported features in the HTTP response confirming the creation of the Individual BDT policy resource by including the "suppFeat" attribute in the "BdtPolicyData" data type. + +**Table 5.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | BdtNotification_5G | This feature indicates the support of sending the BDT notification to the NF service consumer.
This feature includes sending of the BDT warning notification to the NF service consumer. | +| 2 | ES3XX | Extended Support for 3xx redirections.
This feature indicates the support of redirection for any service operation, according to Stateless NF procedures as specified in subclauses 6.5.3.2 and 6.5.3.3 of 3GPP TS 29.500 [6] and according to HTTP redirection principles for indirect communication, as specified in subclause 6.10.9 of 3GPP TS 29.500 [6]. | +| 3 | PatchCorrection | Indicates support of the correction to the PATCH method.
When this feature is not supported, the interoperability between a NF service consumer and the PCF can only be ensured when it is not required the update of the Individual BDT policy resource. | + +## 5.9 Security + +As indicated in 3GPP TS 33.501 [18] and 3GPP TS 29.500 [6], the access to the Npcf\_BDTPolicyControl API, based on local configuration, may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [19]), using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [20]) plays the role of the authorization server. + +If OAuth2 authorization is used, an NF Service Consumer, prior to consuming services offered by the Npcf\_BDTPolicyControl API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [20], subclause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Npcf\_BDTPolicyControl service. + +The Npcf\_BDTPolicyControl API defines a single scope "npcf-bdtpolicycontrol" for OAuth2 authorization (as specified in 3GPP TS 33.501 [18]) for the entire API, and it does not define any additional scopes at resource or operation level. + +# Annex A (normative): OpenAPI specification + +## A.1 General + +The present Annex contains an OpenAPI [10] specification of HTTP messages and content bodies used by the Npcf\_BDTPolicyControl API. + +This Annex shall take precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API. + +NOTE: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification file contained in this 3GPP Technical Specification are available on a Git-based repository that uses the GitLab software version control system (see clause 5B of the 3GPP TR 21.900 [21] and subclause 5.3.1 of the 3GPP TS 29.501 [7] for further information). + +## A.2 Npcf\_BDTPolicyControl API + +``` + +openapi: 3.0.0 +info: + title: Npcf_BDTPolicyControl Service API + version: 1.1.3 + description: | + PCF BDT Policy Control Service. + © 2021, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +# +externalDocs: + description: 3GPP TS 29.554 V16.7.0; 5G System; Background Data Transfer Policy Control Service. + url: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.554/' +# +servers: + - url: '{apiRoot}/npcf-bdtpolicycontrol/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in subclause 4.4 of 3GPP TS 29.501. +security: + - {} + - oAuth2ClientCredentials: + - npcf-bdtpolicycontrol +paths: + /bdtpolicies: + post: + summary: Create a new Individual BDT policy + operationId: CreateBDTPolicy + tags: + - BDT policies (Collection) + requestBody: + description: Contains information for the creation of a new Individual BDT policy resource. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/BdtReqData' + responses: + '201': + description: Background data transfer policies offered to an ASP. + content: + application/json: + schema: + $ref: '#/components/schemas/BdtPolicy' + headers: + Location: + description: 'Contains the URI of the created individual BDT policy resource, +according to the structure: {apiRoot}/npcf-bdtpolicycontrol/v1/bdtpolicies/{bdtPolicyId}' + required: true + schema: + type: string +# +# Error scenarios POST +# + '303': + description: See Other. The result of the POST request would be equivalent to the existing +Individual BDT policy resource. + headers: + Location: + description: 'Contains the URI of the existing individual BDT policy resource.' + required: true + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + +``` + +``` + + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +# +# End error scenarios POST +# + callbacks: + BdtNotification: + '{ $request.body#/notifUri }': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Notification' + responses: + '204': + description: No Content, a reception of the BDT notification was successful. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +# +/bdtpolicies/{bdtpolicyId}: + get: + summary: Read an Individual BDT policy + operationId: GetBDTPolicy + tags: + - Individual BDT policy (Document) + parameters: + - name: bdtpolicyId + description: String identifying the individual BDT policy resource in the PCF. + in: path + required: true + schema: + type: string + responses: + '200': + +``` + +----- + +----- + +``` + description: Background data transfer policies offered to and selected by an ASP. + content: + application/json: + schema: + $ref: '#/components/schemas/BdtPolicy' +# +# Redirection scenarios GET +# +# '307': +# $ref: 'TS29571_CommonData.yaml#/components/responses/307' +# '308': +# $ref: 'TS29571_CommonData.yaml#/components/responses/308' +# +# Error scenarios GET +# +# '400': +# $ref: 'TS29571_CommonData.yaml#/components/responses/400' +# '401': +# $ref: 'TS29571_CommonData.yaml#/components/responses/401' +# '403': +# $ref: 'TS29571_CommonData.yaml#/components/responses/403' +# '404': +# $ref: 'TS29571_CommonData.yaml#/components/responses/404' +# '406': +# $ref: 'TS29571_CommonData.yaml#/components/responses/406' +# '429': +# $ref: 'TS29571_CommonData.yaml#/components/responses/429' +# '500': +# $ref: 'TS29571_CommonData.yaml#/components/responses/500' +# '503': +# $ref: 'TS29571_CommonData.yaml#/components/responses/503' +# default: +# $ref: 'TS29571_CommonData.yaml#/components/responses/default' +# +# End error scenarios GET +# +patch: + summary: Update an Individual BDT policy + operationId: UpdateBDTPolicy + tags: + - Individual BDT policy (Document) + parameters: + - name: bdtPolicyId + description: String identifying the individual BDT policy resource in the PCF. + in: path + required: true + schema: + type: string + requestBody: + description: Contains modification instruction to be performed on the BdtPolicy data + structure to select a transfer policy and in addition, may indicate whether the BDT warning + notification is enabled or disabled. + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/PatchBdtPolicy' + responses: + '200': + description: The Individual BDT Policy resource is modified and a representation of that + resource is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/BdtPolicy' + '204': + description: The Individual BDT Policy resource is modified. +# +# Redirection scenarios PATCH +# +# '307': +# $ref: 'TS29571_CommonData.yaml#/components/responses/307' +# '308': +# $ref: 'TS29571_CommonData.yaml#/components/responses/308' +# +# Error scenarios PATCH +# +# '400': +``` + +----- + +----- + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +# +# End error scenarios PATCH +# +# +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + npcf-bdtpolicycontrol: Access to the Npcf_BDTPolicyControl API + schemas: +# +# Structured data types +# + BdtPolicy: + description: Represents an Individual BDT policy resource. + type: object + properties: + bdtPolData: + $ref: '#/components/schemas/BdtPolicyData' + bdtReqData: + $ref: '#/components/schemas/BdtReqData' +# + BdtReqData: + description: Contains service requirements for creation a new Individual BDT policy resource. + type: object + required: + - aspId + - desTimeInt + - numOfUes + - volPerUe + properties: + aspId: + $ref: '#/components/schemas/AspId' + desTimeInt: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + interGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + nwAreaInfo: + $ref: '#/components/schemas/NetworkAreaInfo' + numOfUes: + description: Indicates a number of UEs. + type: integer + volPerUe: + $ref: 'TS29122_CommonData.yaml#/components/schemas/UsageThreshold' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + trafficDes: +``` + +----- + +----- + +``` + $ref: 'TS29122_ResourceManagementOfBdt.yaml#/components/schemas/TrafficDescriptor' + warnNotifReq: + description: Indicates whether the BDT warning notification is enabled or disabled. + type: boolean + default: false +# + BdtPolicyData: + description: Describes the authorization data of an Individual BDT policy resource. + type: object + required: + - bdtRefId + - transfPolicies + properties: + bdtRefId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/BdtReferenceId' + transfPolicies: + description: Contains transfer policies. + type: array + items: + $ref: '#/components/schemas/TransferPolicy' + minItems: 1 + selTransPolicyId: + description: Contains an identity of the selected transfer policy. + type: integer + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +# + PatchBdtPolicy: + description: Describes the updates in authorization data of an Individual BDT Policy created +by the PCF. + type: object + properties: + bdtPolData: + $ref: '#/components/schemas/BdtPolicyDataPatch' + bdtReqData: + $ref: '#/components/schemas/BdtReqDataPatch' +# + BdtPolicyDataPatch: + description: A JSON Merge Patch body schema containing modification instruction to be +performed on the bdtPolData attribute of the BdtPolicy data structure to select a transfer policy. +Adds selTransPolicyId to BdtPolicyData data structure. + type: object + required: + - selTransPolicyId + properties: + selTransPolicyId: + description: Contains an identity (i.e. transPolicyId value) of the selected transfer +policy. If the BdtNotification_5G feature is supported value 0 indicates that no transfer policy is +selected. + type: integer +# + BdtReqDataPatch: + description: A JSON Merge Patch body schema containing modification instruction to be +performed on the bdtReqData attribute of the BdtPolicy data structure to indicate whether the BDT +warning notification is enabled or disabled. Modifies warnNotifReq from BdtReqData data structure. + type: object + properties: + warnNotifReq: + description: Indicates whether the BDT warning notification is enabled or disabled. + type: boolean +# + TransferPolicy: + description: Describes a transfer policy. + type: object + required: + - ratingGroup + - recTimeInt + - transPolicyId + properties: + maxBitRateDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + maxBitRateUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + ratingGroup: + description: Indicates a rating group for the recommended time window. + type: integer + recTimeInt: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' +``` + +``` + transPolicyId: + description: Contains an identity of a transfer policy. + type: integer + NetworkAreaInfo: + description: Describes a network area information in which the NF service consumer requests +the number of UEs. + type: object + properties: + ecgis: + description: Contains a list of E-UTRA cell identities. + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi' + minItems: 1 + ncgis: + description: Contains a list of NR cell identities. + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi' + minItems: 1 + gRanNodeIds: + description: Contains a list of NG RAN nodes. + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GlobalRanNodeId' + minItems: 1 + tais: + description: Contains a list of tracking area identities. + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 +# + Notification: + description: Describes a BDT notification. + type: object + required: + - bdtRefId + properties: + bdtRefId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/BdtReferenceId' + candPolicies: + description: Contains a list of the candidate transfer policies from which the AF may +select a new transfer policy due to a network performance is below the criteria set by the operator. + type: array + items: + $ref: '#/components/schemas/TransferPolicy' + minItems: 1 + nwAreaInfo: + $ref: '#/components/schemas/NetworkAreaInfo' + timeWindow: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' +# +# Simple data types +# + AspId: + description: Contains an identity of an application service provider. + type: string +# +# +``` + +# --- Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|--------|-----------|------|-----|-----|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------| +| Date | TSG # | TSG Doc. | CR | Rev | Cat | Subject/Comment | New version | +| 2018-01 | | | | | | TS skeleton | 0.0.0 | +| 2018-01 | CT3#94 | C3-180369 | | | | Inclusion of C3-180188 agreed in CT3#94. | 0.1.0 | +| 2018-03 | CT3#95 | C3-181376 | | | | Inclusion of documents agreed in CT3#95:
C3-181055, C3-181091, C3-181268, C3-181269,
C3-181270. | 0.2.0 | +| 2018-04 | CT3#96 | C3-182524 | | | | Inclusion of documents agreed in CT3#96:
C3-182048, C3-182428, C3-182427, C3-182051,
C3-182052, C3-182053, C3-182429, C3-182454,
C3-182430, C3-182232. | 0.3.0 | +| 2018-06 | CT3#97 | C3-183915 | | | | Inclusion of documents agreed in CT3#97:
C3-183241, C3-183280, C3-183289, C3-183291,
C3-183292, C3-183297, C3-183298, C3-183562,
C3-183563, C3-183564, C3-183565, C3-183714,
C3-183869. | 0.4.0 | +| 2018-06 | CT#80 | CP-181028 | | | | TS sent to plenary for approval | 1.0.0 | +| 2018-06 | CT#80 | CP-181028 | | | | TS approved by plenary | 15.0.0 | +| 2018-09 | CT#81 | CP-182015 | 0001 | 1 | B | Format of bdtPolicyId | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0002 | 4 | B | Network area information | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0003 | 1 | F | Description of Structured data types | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0004 | 1 | F | Resource structure presentation | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0005 | 1 | F | Removal of externalDoc field | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0006 | | F | Corrections related to Feature negotiation | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0007 | | F | "404 Not found" response in OpenAPI | 15.1.0 | +| 2018-12 | CT#82 | CP-183205 | 0008 | 1 | F | Correction of apiName | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0010 | | F | Supported content types | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0011 | | F | Definition of BdtPolicyData structure | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0012 | | F | Non-empty arrays in OpenAPI file | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0013 | 1 | F | Adding the externalDocs field in the OpenAPI | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0014 | | F | Adding HTTP status code "200 OK" | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0015 | 1 | F | Error indicating "Unspecified resource URI structure" | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0016 | 3 | F | Npcf_BDTPolicyControl API Authorization based on OAuth2 | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0017 | 1 | F | API version update | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0018 | | F | Default value for apiRoot | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0019 | 1 | F | OpenAPI: HTTP status codes alignment | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0020 | 1 | F | NgRanNodeId definition in OpenAPI | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0021 | | F | OpenAPI: usage of the "tags" keyword | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0022 | | F | Location header field in OpenAPI | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0023 | 1 | F | Data structure used in PATCH request | 15.2.0 | +| 2019-03 | CT#83 | CP-190112 | 0024 | | F | Alignment of the BDT procedures | 15.3.0 | +| 2019-05 | CT#84 | CP-191084 | 0025 | 1 | F | Storage and precedence of OpenAPI specification file | 15.4.0 | +| 2019-06 | CT#84 | CP-191084 | 0028 | 1 | F | Copyright Note in YAML file | 15.4.0 | +| 2019-06 | CT#84 | CP-191084 | 0030 | | F | OpenAPI version number update | 15.4.0 | +| 2019-06 | CT#84 | CP-191105 | 0026 | 2 | B | Support of Npcf_BDTPolicyControl_Notify service operation | 16.0.0 | +| 2019-06 | CT#84 | CP-191090 | 0027 | 1 | B | Add External group Id | 16.0.0 | +| 2019-06 | CT#84 | CP-191101 | 0031 | 2 | F | OpenAPI version number update | 16.0.0 | +| 2019-09 | CT#85 | CP-192157 | 0032 | 1 | B | Modification of BDT warning notification request indication | 16.1.0 | +| 2019-09 | CT#85 | CP-192173 | 0034 | | F | OpenAPI version update for TS 29.554 Rel-16 | 16.1.0 | +| 2019-12 | CT#86 | CP-193198 | 0035 | 1 | F | Indication of "BdtNotification_5G" feature | 16.2.0 | +| 2019-12 | CT#86 | CP-193212 | 0037 | | F | Update of API version and TS version in OpenAPI file | 16.2.0 | +| 2020-03 | CT#87e | CP-200208 | 0036 | 2 | B | BDT renegotiation upon the network conditions change | 16.3.0 | +| 2020-03 | CT#87e | CP-200219 | 0038 | 2 | B | map ASPid to DNN and SNSSAI for xBDT | 16.3.0 | +| 2020-03 | CT#87e | CP-200216 | 0039 | | F | Update of OpenAPI version and TS version in externalDocs field | 16.3.0 | +| 2020-06 | CT#88e | CP-201234 | 0040 | 1 | F | Removal of not valid BDT policy from UDR | 16.4.0 | +| 2020-06 | CT#88e | CP-201244 | 0041 | 1 | F | Storage of YAML files in ETSI Forge | 16.4.0 | +| 2020-06 | CT#88e | CP-201256 | 0043 | 1 | F | URI of the Npcf_BDTPolicyControl service | 16.4.0 | +| 2020-06 | CT#88e | CP-201276 | 0045 | 1 | F | Traffic descriptor for xBDT | 16.4.0 | +| 2020-06 | CT#88e | CP-201225 | 0047 | | A | OpenAPI: adding Location header field in 303 response | 16.4.0 | +| 2020-06 | CT#88e | CP-201244 | 0048 | 1 | F | Optionality of ProblemDetails | 16.4.0 | +| 2020-06 | CT#88e | CP-201244 | 0049 | 1 | F | Supported headers, Resource Data type and yaml mapping | 16.4.0 | +| 2020-06 | CT#88e | CP-201255 | 0051 | | F | Update of OpenAPI version and TS version in externalDocs field | 16.4.0 | +| 2020-12 | CT#90e | CP-203139 | 0053 | 1 | F | TS 29.554 Essential Corrections and alignments | 16.5.0 | +| 2020-12 | CT#90e | CP-203129 | 0054 | 1 | F | Correction to the BDT policy re-negotiation | 16.5.0 | +| 2020-12 | CT#90e | CP-203139 | 0055 | 1 | F | Storage of YAML files in ETSI Forge | 16.5.0 | +| 2020-12 | CT#90e | CP-203110 | 0056 | 1 | F | Correction to support redirection codes and the update of the Callback URI | 16.5.0 | +| 2020-12 | CT#90e | CP-203152 | 0057 | | F | Update of OpenAPI version and TS version in externalDocs field | 16.5.0 | +| 2021-03 | CT#91e | CP-210191 | 0058 | | F | Supported feature number of ES3XX | 16.6.0 | +| 2021-03 | CT#91e | CP-210206 | 0062 | 1 | F | set bdtStatus to VALID | 16.6.0 | +| 2021-03 | CT#91e | CP-210201 | 0064 | 1 | A | Correction to PATCH method | 16.6.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|----------------------------------------------------------------|--------| +| 2021-03 | CT#91e | CP-210239 | 0066 | | F | Update of OpenAPI version and TS version in externalDocs field | 16.6.0 | +| 2021-06 | CT#92e | CP-211200 | 0067 | 1 | F | Redirect responses with "application/json" media type | 16.7.0 | +| 2021-06 | CT#92e | CP-211264 | 0069 | | | Update of OpenAPI version and TS version in externalDocs field | 16.7.0 | +| 2022-03 | CT#95e | CP-220176 | 0074 | 1 | F | Alignment of "Application Errors" clause with SBI TS template | 16.8.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29561/0236eff05bcb8f3a343ea7933aaa306b_img.jpg b/marked/Rel-16/29_series/29561/0236eff05bcb8f3a343ea7933aaa306b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..718c33dbd25765667b76f51ebbc491c8e7cacc71 --- /dev/null +++ b/marked/Rel-16/29_series/29561/0236eff05bcb8f3a343ea7933aaa306b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3a8d04ec4f3f0f0ebc374cfc51deb5853cdef244a2654d593650a510c8015b19 +size 33870 diff --git a/marked/Rel-16/29_series/29561/07b17a620c75522d53916a11e12d1bff_img.jpg b/marked/Rel-16/29_series/29561/07b17a620c75522d53916a11e12d1bff_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f7f800ec888a1f6a9691c4deeec1f03c0df57364 --- /dev/null +++ b/marked/Rel-16/29_series/29561/07b17a620c75522d53916a11e12d1bff_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f827d07e4535cbaca87deadf9f93efda8ca61fb626a0517cce9c17130474bf35 +size 30128 diff --git a/marked/Rel-16/29_series/29561/09955ff8214ffb6947951fc0f60eb6ab_img.jpg b/marked/Rel-16/29_series/29561/09955ff8214ffb6947951fc0f60eb6ab_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b7c574acb9a173c87c208ed3b5d0f36a5aa9e419 --- /dev/null +++ b/marked/Rel-16/29_series/29561/09955ff8214ffb6947951fc0f60eb6ab_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d982f7937cf8453a03a91846321ea8cd49bbf833be39735be23eb41955a10888 +size 97742 diff --git a/marked/Rel-16/29_series/29561/10781f43062bf3e9601a1e086710556c_img.jpg b/marked/Rel-16/29_series/29561/10781f43062bf3e9601a1e086710556c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b1c7e8c5090787a96de857f6d3d9485f189a2835 --- /dev/null +++ b/marked/Rel-16/29_series/29561/10781f43062bf3e9601a1e086710556c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:03b6352d88761b9663b5a20a723cfde2186d90c3e49f560d05cc27930a4819ca +size 14695 diff --git a/marked/Rel-16/29_series/29561/18f841ac4f2ef28f34a026f1bdc5af9a_img.jpg b/marked/Rel-16/29_series/29561/18f841ac4f2ef28f34a026f1bdc5af9a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..34c5e1a376b702e3ffe915e2893e330eb347c20f --- /dev/null +++ b/marked/Rel-16/29_series/29561/18f841ac4f2ef28f34a026f1bdc5af9a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1e083aa605c821f2fb100266ad27ff9c7e03dc15c0bed8624fb3309fa4f4541b +size 25517 diff --git a/marked/Rel-16/29_series/29561/2ae3eae1bd80a90f192f568ae246a9a6_img.jpg b/marked/Rel-16/29_series/29561/2ae3eae1bd80a90f192f568ae246a9a6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..03bd810a23aa6248af1be88ccda6a59e021f5b32 --- /dev/null +++ b/marked/Rel-16/29_series/29561/2ae3eae1bd80a90f192f568ae246a9a6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a0ff4ecd8d288fd3129d3a96ed8d6615addec7f345787d2a16396c1332537ffc +size 119143 diff --git a/marked/Rel-16/29_series/29561/3a33f3d9710df2b4c805247cd69facc3_img.jpg b/marked/Rel-16/29_series/29561/3a33f3d9710df2b4c805247cd69facc3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..62bd35823e4863a5fc09e8af4857e855aca19cb8 --- /dev/null +++ b/marked/Rel-16/29_series/29561/3a33f3d9710df2b4c805247cd69facc3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1b9e7b2c588672d29fdd72bb451758e011e75f5cd3e151c13593529920d9fb0c +size 29103 diff --git a/marked/Rel-16/29_series/29561/3da1a07cb87051bf616c9876db958cf0_img.jpg b/marked/Rel-16/29_series/29561/3da1a07cb87051bf616c9876db958cf0_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..feab989e0f0d938efb7c919f45c1754373d641c7 --- /dev/null +++ b/marked/Rel-16/29_series/29561/3da1a07cb87051bf616c9876db958cf0_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e3b70364a6bfb010543a431012f0f6d34e004a1ae66410d825d34cc241fa2532 +size 84638 diff --git a/marked/Rel-16/29_series/29561/55136bc716146672fc680fa05989f1d2_img.jpg b/marked/Rel-16/29_series/29561/55136bc716146672fc680fa05989f1d2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..223de820ad38e3fc105a5a3e0d035d1e5d380b17 --- /dev/null +++ b/marked/Rel-16/29_series/29561/55136bc716146672fc680fa05989f1d2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a80328b8d294bac3458f301fa6abdbfa36bb30a14328293b11175e829e39de67 +size 30799 diff --git a/marked/Rel-16/29_series/29561/63e0c22852c26699d0bd095a2d796bab_img.jpg b/marked/Rel-16/29_series/29561/63e0c22852c26699d0bd095a2d796bab_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5920878f1031d6cef7f71bf129d63bb37d18c5fc --- /dev/null +++ b/marked/Rel-16/29_series/29561/63e0c22852c26699d0bd095a2d796bab_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3ce4add0fffb31fd271c05107d10e56c19e80629c84030ffbd72112a2e5a5e7b +size 25296 diff --git a/marked/Rel-16/29_series/29561/68ca7669d38a3c31f5a2c3a06fa802e3_img.jpg b/marked/Rel-16/29_series/29561/68ca7669d38a3c31f5a2c3a06fa802e3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7f8e86fb23464ac7de67ea2ad16d12f3e5730531 --- /dev/null +++ b/marked/Rel-16/29_series/29561/68ca7669d38a3c31f5a2c3a06fa802e3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a1cb060d395c091a00cb87df90529bccc653d69aaa8fd976a802832caf2cf9da +size 114619 diff --git a/marked/Rel-16/29_series/29561/78d5774278a3f4a614f8c0ae485ce8d9_img.jpg b/marked/Rel-16/29_series/29561/78d5774278a3f4a614f8c0ae485ce8d9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a24634e86ee4855a0e548e3b2c1ec64229e9e808 --- /dev/null +++ b/marked/Rel-16/29_series/29561/78d5774278a3f4a614f8c0ae485ce8d9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d6b132e2643908409c2581765d976d9e4dc476b8304c13807b559225f2c38de0 +size 31127 diff --git a/marked/Rel-16/29_series/29561/79e1709a7317ead45379cbb8ff3ba802_img.jpg b/marked/Rel-16/29_series/29561/79e1709a7317ead45379cbb8ff3ba802_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..eb2a4ebf6cd67460aaef4cda50e0e45a985b7a9b --- /dev/null +++ b/marked/Rel-16/29_series/29561/79e1709a7317ead45379cbb8ff3ba802_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0fcf2b4e81c9240e578a0f32e17f4e5d0297d4ce45b4d19910d86271bbef52fa +size 36037 diff --git a/marked/Rel-16/29_series/29561/7a02de7ed198501f7a4f6ca37c3f28c5_img.jpg b/marked/Rel-16/29_series/29561/7a02de7ed198501f7a4f6ca37c3f28c5_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3071a43f14748ed420c4d33075cbb71d079e8ef2 --- /dev/null +++ b/marked/Rel-16/29_series/29561/7a02de7ed198501f7a4f6ca37c3f28c5_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:717dd46073c96a84af92d648ca348c15dac45b389e328dd1bc992b261fda32e8 +size 32310 diff --git a/marked/Rel-16/29_series/29561/7f17c430b9598e4d748a8041457810b3_img.jpg b/marked/Rel-16/29_series/29561/7f17c430b9598e4d748a8041457810b3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2791aa1b1178864823d6cc0a68098ad59befd83e --- /dev/null +++ b/marked/Rel-16/29_series/29561/7f17c430b9598e4d748a8041457810b3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cf70a173a21fe9811a4c52244e2f0127504edf4cfd8450b98d74f9a0e54469f5 +size 30167 diff --git a/marked/Rel-16/29_series/29561/90ddb84c323b956e2d50a54d3f870566_img.jpg b/marked/Rel-16/29_series/29561/90ddb84c323b956e2d50a54d3f870566_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2f92e73277f4a6c6c131cb0eea209466984257e6 --- /dev/null +++ b/marked/Rel-16/29_series/29561/90ddb84c323b956e2d50a54d3f870566_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:eacbfaa69c53704541c6322d3e8346c879eb0098294ecb3153330da68bf7d1ec +size 94651 diff --git a/marked/Rel-16/29_series/29561/96b0240f56d14453b5da05ec30fd5c6e_img.jpg b/marked/Rel-16/29_series/29561/96b0240f56d14453b5da05ec30fd5c6e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9eda2e596a1f09ef27c8b680b493422b1a12b1cd --- /dev/null +++ b/marked/Rel-16/29_series/29561/96b0240f56d14453b5da05ec30fd5c6e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6f2d73b8b2f0a6825881a2b6748f542bfc6b00e37c2541872b0d6a1480dd545c +size 33844 diff --git a/marked/Rel-16/29_series/29561/9b686adccf125267a013fa25721231a3_img.jpg b/marked/Rel-16/29_series/29561/9b686adccf125267a013fa25721231a3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..16dd2f7da62c15dda47e8e788cf7fe7ff92975c1 --- /dev/null +++ b/marked/Rel-16/29_series/29561/9b686adccf125267a013fa25721231a3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e5babf23884c9bdfe9ce1b18d2519c928e57eb1ab4f86955e045f6ab2b7a9f66 +size 33129 diff --git a/marked/Rel-16/29_series/29561/9c1d3678db4a12d5864cb2a4def1135d_img.jpg b/marked/Rel-16/29_series/29561/9c1d3678db4a12d5864cb2a4def1135d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a0ec04bb7066ad88c1b9447c5381095025cefed0 --- /dev/null +++ b/marked/Rel-16/29_series/29561/9c1d3678db4a12d5864cb2a4def1135d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d81f9e8c877af8872a79c8d7cff786ee3d5ffb7d687fa16993a0cb8ba5ff8754 +size 35145 diff --git a/marked/Rel-16/29_series/29561/cdd4dfacab004e9979caed3fffea69e5_img.jpg b/marked/Rel-16/29_series/29561/cdd4dfacab004e9979caed3fffea69e5_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..031979e3b627f6ae07847b0c34995b26f7e4a462 --- /dev/null +++ b/marked/Rel-16/29_series/29561/cdd4dfacab004e9979caed3fffea69e5_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a2b80b7b306f755026c46f20a0151c3a7a018ed4c3aa1d6fdccde2224f79214a +size 44702 diff --git a/marked/Rel-16/29_series/29561/e29665b8abcea967ef289c6aff07ae4c_img.jpg b/marked/Rel-16/29_series/29561/e29665b8abcea967ef289c6aff07ae4c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1b762220e50fe84f3cd42f1a7723b1ea6ce3b698 --- /dev/null +++ b/marked/Rel-16/29_series/29561/e29665b8abcea967ef289c6aff07ae4c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f8b0c313ad3e05e35d4489b0909024c7bcd950c44fc51eae21f233c26097f576 +size 47286 diff --git a/marked/Rel-16/29_series/29561/e636d7ccca0ad14c6b95201404324823_img.jpg b/marked/Rel-16/29_series/29561/e636d7ccca0ad14c6b95201404324823_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b7e7fb843fa6341305f4519bac8dfacab16c37eb --- /dev/null +++ b/marked/Rel-16/29_series/29561/e636d7ccca0ad14c6b95201404324823_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:36f59e2c08dbbbcd4cb4a4ff5bb6aabb94029ab121f63de670d59e0e8e54b870 +size 24647 diff --git a/marked/Rel-16/29_series/29561/e928f4874ed492d3ad4c6fa2d29aedbc_img.jpg b/marked/Rel-16/29_series/29561/e928f4874ed492d3ad4c6fa2d29aedbc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..888ff160f700830e04f3eedc99e4fd2b8e79bfb9 --- /dev/null +++ b/marked/Rel-16/29_series/29561/e928f4874ed492d3ad4c6fa2d29aedbc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:89581c91b89b1bc25834950e18a9d92d7f90017d5bcab714aa2f6bc099978884 +size 24245 diff --git a/marked/Rel-16/29_series/29561/eb03559a4d92ea9ebd63ea9be663c50a_img.jpg b/marked/Rel-16/29_series/29561/eb03559a4d92ea9ebd63ea9be663c50a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d7347034a17b2888844263c9faa706bb3463ec47 --- /dev/null +++ b/marked/Rel-16/29_series/29561/eb03559a4d92ea9ebd63ea9be663c50a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:347441da204413d0049873cb778bc7c46726d50089dbbd2236cb77edb7d707f5 +size 34987 diff --git a/marked/Rel-16/29_series/29561/f14e75bd1c6e2f234db4775dbf0dbf1a_img.jpg b/marked/Rel-16/29_series/29561/f14e75bd1c6e2f234db4775dbf0dbf1a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a6eff9673fcb1e9c46ce5f011f58d93994c89257 --- /dev/null +++ b/marked/Rel-16/29_series/29561/f14e75bd1c6e2f234db4775dbf0dbf1a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b9828d712bdb40cc623ee431339dd7f0c7b5d3ad24785f3ee99e158d53198322 +size 32156 diff --git a/marked/Rel-16/29_series/29561/f8e6ecfa485e4c866b137407e0de01c5_img.jpg b/marked/Rel-16/29_series/29561/f8e6ecfa485e4c866b137407e0de01c5_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5fef9f1a81700fd6fe6ac4b47132d0fcac34ae9c --- /dev/null +++ b/marked/Rel-16/29_series/29561/f8e6ecfa485e4c866b137407e0de01c5_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0b49947839c3a515a12ca8b9fe0ab758d782edc016db785a7e8cf59ccd84e70e +size 29021 diff --git a/marked/Rel-16/29_series/29561/raw.md b/marked/Rel-16/29_series/29561/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..1e732643be7f5048c8e86d82abd257559bb40938 --- /dev/null +++ b/marked/Rel-16/29_series/29561/raw.md @@ -0,0 +1,2807 @@ +Error! No +text of + +Error! No text of specified style in +document. + +# Contents + +| | | +|---------------------------------------------------------------------------------------------|----| +| Foreword ..... | 6 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions and abbreviations ..... | 9 | +| 3.1 Definitions..... | 9 | +| 3.2 Abbreviations ..... | 9 | +| 4 Network Characteristics..... | 10 | +| 4.1 Key characteristics of PLMN..... | 10 | +| 4.2 Key characteristics of IP Networks..... | 10 | +| 4.3 Key characteristics of Ethernet ..... | 10 | +| 5 Interworking Classifications ..... | 10 | +| 5.1 Service Interworking..... | 10 | +| 5.2 Network Interworking..... | 10 | +| 6 Reference Architecture ..... | 10 | +| 7 Interface to 5G Network services (User Plane) ..... | 11 | +| 8 Interworking with DN (IP)..... | 11 | +| 8.1 General ..... | 11 | +| 8.2 DN Interworking Model..... | 11 | +| 8.2.1 General ..... | 11 | +| 8.2.2 Access to DN through 5G Network..... | 12 | +| 8.2.2.1 Transparent access to DN ..... | 12 | +| 8.2.2.2 IPv4 Non-transparent access to DN..... | 13 | +| 8.2.2.3 IPv6 Non-transparent access to DN..... | 14 | +| 9 Interworking with DN (Unstructured) ..... | 16 | +| 9.1 General ..... | 16 | +| 9.2 N6 PtP tunnelling based on UDP/IP ..... | 16 | +| 9.3 Other N6 tunnelling mechanism ..... | 17 | +| 10 Interworking with DN (DHCP)..... | 17 | +| 10.1 General ..... | 17 | +| 10.2 DN interworking Model of SMF for DHCP ..... | 18 | +| 10.2.1 Introduction ..... | 18 | +| 10.2.2 IPv4 Address allocation and IPv4 parameter configuration via DHCPv4 ..... | 18 | +| 10.2.3 IPv6 Prefix allocation via IPv6 stateless address autoconfiguration via DHCPv6 ..... | 20 | +| 10.2.4 IPv6 parameter configuration via stateless DHCPv6 ..... | 21 | +| 10.2.5 IPv6 Prefix Delegation via DHCPv6..... | 22 | +| 10.3 3GPP Vendor-Specific Options ..... | 22 | +| 11 Interworking with DN-AAA (RADIUS) ..... | 23 | +| 11.1 RADIUS procedures ..... | 23 | +| 11.1.1 RADIUS Authentication and Authorization ..... | 23 | +| 11.1.2 RADIUS Accounting..... | 24 | +| 11.2 Message flows on N6 interface..... | 25 | +| 11.2.1 Authentication, Authorization and Accounting procedures ..... | 25 | +| 11.2.2 Accounting Update..... | 28 | +| 11.2.3 DN-AAA initiated QoS flow termination ..... | 29 | +| 11.2.4 DN-AAA initiated re-authorization..... | 30 | +| 11.3 List of RADIUS attributes..... | 30 | +| 11.3.1 General ..... | 30 | +| 11.3.2 Change-of-Authorization Request (optionally sent from DN-AAA server to SMF) ..... | 42 | +| 11.3.3 Access-Challenge (sent from DN-AAA server to SMF)..... | 43 | +| 12 Interworking with DN-AAA (Diameter) ..... | 43 | +| 12.1 Diameter Procedures ..... | 43 | + +| | | | +|----------|-------------------------------------------------------------------|----| +| 12.1.1 | Diameter Authentication and Authorization..... | 43 | +| 12.1.2 | Diameter Accounting..... | 44 | +| 12.2 | Message flows on N6 interface ..... | 45 | +| 12.2.1 | Authentication, Authorization and Accounting procedures ..... | 45 | +| 12.2.2 | Accounting Update ..... | 48 | +| 12.2.3 | DN-AAA initiated QoS flow termination ..... | 48 | +| 12.2.4 | DN-AAA initiated re-authorization..... | 49 | +| 12.2.5 | DN-AAA initiated re-authentication and re-authorization..... | 49 | +| 12.3 | N6 specific AVPs..... | 50 | +| 12.4 | N6 re-used AVPs..... | 50 | +| 12.4.0 | General ..... | 50 | +| 12.4.1 | Use of the Supported-Features AVP on the N6 reference point..... | 52 | +| 12.5 | N6 specific Experimental-Result-Code AVP..... | 53 | +| 12.6 | N6 Diameter messages ..... | 53 | +| 12.6.1 | General ..... | 53 | +| 12.6.2 | DER Command ..... | 54 | +| 12.6.3 | DEA Command ..... | 55 | +| 12.6.4 | RAR Command ..... | 56 | +| 12.6.5 | RAA Command..... | 56 | +| 13 | Interworking with IMS..... | 57 | +| 13.1 | General ..... | 57 | +| 13.2 | IMS interworking Model..... | 57 | +| 13.2.1 | Introduction ..... | 57 | +| 13.2.2 | IMS specific configuration in the SMF ..... | 57 | +| 13.2.3 | IMS specific procedures in the SMF ..... | 58 | +| 13.2.3.1 | Provisioning of Signalling Server Address..... | 58 | +| 13.2.3.2 | Failure of Signalling Server Address..... | 58 | +| 14 | Interworking with DN (Ethernet)..... | 59 | +| 15 | Interworking with DN (Multicast Routing Protocol)..... | 60 | +| 15.1 | General ..... | 60 | +| 15.2 | DN interworking Model of UPF for PIM..... | 60 | +| 16 | Interworking with NSS-AAA (RADIUS)..... | 61 | +| 16.1 | RADIUS procedures ..... | 61 | +| 16.1.1 | General ..... | 61 | +| 16.1.2 | RADIUS Authentication and Authorization ..... | 61 | +| 16.2 | Message flows for network slice specific authentication..... | 61 | +| 16.2.1 | Authentication and Authorization procedures..... | 61 | +| 16.2.2 | NSS-AAA initiated revocation of network slice authorization ..... | 63 | +| 16.3 | List of RADIUS attributes..... | 63 | +| 16.3.1 | General ..... | 63 | +| 17 | Interworking with NSS-AAA (Diameter)..... | 64 | +| 17.1 | Diameter procedures ..... | 64 | +| 17.1.1 | General ..... | 64 | +| 17.1.2 | Diameter Authentication and Authorization..... | 64 | +| 17.2 | Message flows for network slice specific authentication..... | 65 | +| 17.2.1 | Authentication and Authorization procedures..... | 65 | +| 17.2.2 | NSS-AAA initiated revocation of network slice authorization ..... | 66 | +| 17.2.3 | NSS-AAA initiated re-authentication and re-authorization ..... | 67 | +| 17.3 | Specific AVPs ..... | 67 | +| 17.4 | re-used AVPs..... | 68 | +| 17.4.1 | General ..... | 68 | +| 17.4.2 | Use of the Supported-Features AVP ..... | 68 | +| 17.5 | Specific Experimental-Result-Code AVP..... | 69 | +| 17.6 | Diameter messages ..... | 69 | +| 17.6.1 | General ..... | 69 | + +**Annex A (normative): Rate control related to 5G Cellular Internet of Things (CIoT) optimisations..... 69** + +A.1 General..... 69 + +A.2 Support of rate control of user data..... 69 + +A.2.1 General ..... 69 + +A.2.2 Small Data Rate Control ..... 70 + +A.2.3 Serving PLMN Rate Control information handling ..... 70 + +**Annex B (informative): Change history..... 72** + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# 1 Scope + +The present specification defines the stage 3 interworking procedures for 5G Network interworking between PLMN and external DN or Network Slice Specific AAA. + +The stage 2 requirements and procedures are contained in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]. + +For interworking between 5G PLMN and external DNs, the present document is valid for both 3GPP accesses and non-3GPP accesses. + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.281: "General Packet Radio System (GPRS) Tunnelling Protocol User Plane (GTPv1-U)". +- [5] 3GPP TS 29.061: "Interworking between the Public Land Mobile Network (PLMN) supporting packet based services and Packet Data Networks (PDN)". +- [6] IETF RFC 3748: "Extensible Authentication Protocol (EAP)". +- [7] IETF RFC 3579: "RADIUS (Remote Authentication Dial In User Service) Support For Extensible Authentication Protocol (EAP)". +- [8] IETF RFC 2865: "Remote Authentication Dial In User Service (RADIUS)". +- [9] IETF RFC 3162: "RADIUS and IPv6". +- [10] IETF RFC 4818: "RADIUS Delegated-IPv6-Prefix Attribute". +- [11] IETF RFC 5216: "The EAP-TLS Authentication Protocol". +- [12] 3GPP TS 23.228: "IP Multimedia Subsystem (IMS); Stage 2". +- [13] 3GPP TS 24.229: "IP Multimedia Call Control Protocol based on SIP and SDP; Stage 3". +- [14] IETF RFC 2132: "DHCP Options and BOOTP Vendor Extensions". +- [15] IETF RFC 3361: "Dynamic Host Configuration Protocol (DHCP-for-IPv4) Option for Session Initiation Protocol (SIP) Servers". +- [16] IETF RFC 3646: "DNS Configuration options for Dynamic Host Configuration Protocol for IPv6 (DHCPv6)". +- [17] IETF RFC 3319: "Dynamic Host Configuration Protocol (DHCPv6) Options for Session Initiation Protocol (SIP) Servers". +- [18] IETF RFC 2131: "Dynamic Host Configuration Protocol". + +- [19] IETF RFC 1542: "Clarification and Extensions for the Bootstrap Protocol". +- [20] IETF RFC 4039: "Rapid Commit Option for the Dynamic Host Configuration Protocol version 4 (DHCPv4)". +- [21] IETF RFC 3315: "Dynamic Host Configuration Protocol for IPv6 (DHCPv6)". +- [22] IETF RFC 3736: "Stateless Dynamic Host Configuration Protocol (DHCP) Service for IPv6". +- [23] IETF RFC 7155: "Diameter Network Access Server Application". +- [24] IETF RFC 6733: "Diameter Base Protocol". +- [25] IETF RFC 4072: "Diameter Extensible Authentication Protocol (EAP) Application". +- [26] IETF RFC 2866: "RADIUS Accounting". +- [27] IETF RFC 5176: "Dynamic Authorization Extensions to Remote Authentication Dial In User Service (RADIUS)". +- [28] 3GPP TS 23.003: "Numbering, addressing and identification". +- [29] IETF RFC 1825: "Security Architecture for the Internet Protocol". +- [30] IETF RFC 1826: "IP Authentication Header". +- [31] IETF RFC 1827: "IP Encapsulating Security Payload (ESP)". +- [32] IETF RFC 4291: "IP Version 6 Addressing Architecture". +- [33] IETF RFC 4861: "Neighbor Discovery for IP Version 6 (IPv6)". +- [34] IETF RFC 4862: "IPv6 Stateless Address Autoconfiguration". +- [35] IETF RFC 1027: "Using ARP to Implement Transparent Subnet Gateways". +- [36] 802.3-2015 - IEEE Standard for Ethernet. +- [37] IETF RFC 5281: "Extensible Authentication Protocol Tunneled Transport Layer Security Authenticated Protocol Version 0 (EAP-TTLSv0)". +- [38] 3GPP TS 23.380: "IMS Restoration Procedures". +- [39] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". +- [40] 3GPP TS 29.502: "5G System; Session Management Services; Stage 3". +- [41] 3GPP TS 29.229: "Cx and Dx interfaces based on Diameter protocol; Protocol details". +- [42] 3GPP TS 24.501: "Non-Access-Stratum (NAS) protocol for 5G System (5GS); Stage 3". +- [43] 3GPP TS 23.316: "Wireless and wireline convergence access support for the 5G System (5GS)". +- [44] IETF RFC 7761: "Protocol Independent Multicast - Sparse Mode (PIM-SM): Protocol Specification (Revised)". +- [45] IETF RFC 3973: "Protocol Independent Multicast - Dense Mode (PIM-DM): Protocol Specification (Revised)". +- [46] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces Stage 3". +- [47] IETF RFC 2132: "DHCP Options and BOOTP Vendor Extensions". +- [48] IETF RFC 3925: "Vendor-Identifying Vendor Options for Dynamic Host Configuration Protocol version 4 (DHCPv4)". +- [49] IETF RFC 8415: "Dynamic Host Configuration Protocol for IPv6 (DHCPv6)". + +- [50] 3GPP TS 29.274: "3GPP Evolved Packet System. Evolved GPRS Tunnelling Protocol for EPS (GTPv2)". +- [51] CableLabs WR-TR-5WWC-ARCH: "5G Wireless Wireline Converged Core Architecture". +- [52] BBF WT-470: "5G FMC Architecture". +- [53] CableLabs DOCSIS MULPI: "Data-Over-Cable Service Interface Specifications DOCSIS 3.1, MAC and Upper Layer Protocols Interface Specification". +- [54] IETF RFC 7542: "The Network Access Identifier". + +# 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|---------|------------------------------------------------------------------| +| 5G-BRG | 5G Broadband Residential Gateway | +| 5G-CRG | 5G Cable Residential Gateway | +| BBF | Broadband Forum | +| CSMA/CD | Carrier Sense Multiple Access/Collision Detection | +| DHCPv4 | Dynamic Host Configuration Protocol version 4 | +| DHCPv6 | Dynamic Host Configuration Protocol version 6 | +| DN | Data Network | +| DR | Designated Router | +| DSL | Digital Subscriber Line | +| FN-BRG | Fixed Network Broadband RG | +| FN-CRG | Fixed Network Cable RG | +| GPSI | Generic Public Subscription Identifier | +| GCI | Global Cable Identifier | +| GLI | Global Line Identifier | +| HFC | Hybrid Fiber Coax | +| N3IWF | Non-3GPP InterWorking Function | +| NGAP | NG Application Protocol | +| NSS | Network Slice Specific | +| NSSAAF | Network Slice-Specific Authentication and Authorization Function | +| PIM | Protocol-Independent Multicast | +| PIM-DM | Protocol-Independent Multicast- Dense Mode | +| PIM-SM | Protocol-Independent Multicast- Sparse Mode | +| PON | Passive Optical Network | +| PtP | Point-to-Point | +| RG | Residential Gateway | +| RP | Rendezvous Point | +| SD | Slice Differentiator | +| SFD | Start Frame Delimiter | +| SMF | Session Management Function | +| S-NSSAI | Single Network Slice Selection Assistance Information | +| SNPN | Stand-alone Non-Public Network | +| SSC | Session and Service Continuity | +| SST | Slice/Service Type | +| TNAP | Trusted Non-3GPP Access Point | +| TWAP | Trusted WLAN Access Point | + +| | | +|-----|---------------------| +| UPF | User Plane Function | +| WAN | Wide Area Network | + +# 4 Network Characteristics + +## 4.1 Key characteristics of PLMN + +The PLMN is fully defined in the 3GPP technical specifications. The 5G Network related key characteristics are defined in 3GPP TS 23.501 [2]. + +## 4.2 Key characteristics of IP Networks + +The Internet is a conglomeration of networks utilising a common set of protocols. IP protocols are defined in the relevant IETF RFCs. The networks topologies may be based on LANs (e.g. Ethernet), Point to Point leased lines, PSTN, ISDN, X.25 or WANs using switched technology (e.g. SMDS, ATM). + +## 4.3 Key characteristics of Ethernet + +The Ethernet is a family of computer networking technologies commonly used in LAN and is often used to refer to all Carrier Sense Multiple Access/Collision Detection (CSMA/CD) LANs that generally conform to Ethernet Specifications, including IEEE 802.3 [36]. The key characteristics for Ethernet are defined in IEEE 802.3 [36]. + +# 5 Interworking Classifications + +## 5.1 Service Interworking + +Service interworking is required when the Teleservice at the calling and called terminals are different. No service interworking is specified in this specification. + +## 5.2 Network Interworking + +Network interworking is required whenever a PLMN is involved in communications with another network to provide end-to-end communications. The PLMN shall interconnect in a manner consistent with that of a normal Data Network (type defined by the requirements e.g. IP). Interworking appears exactly like that of Data Networks. + +# 6 Reference Architecture + +Figure 6-1 shows the access interfaces for the 5G Network. The 5G Network includes both the 3GPP access and the non-3GPP access. + +The NSS-AA may belong to the H-PLMN in the 5G Network (without AAA-P interworking) or a 3rd party (with AAA-P interworking). + +![Figure 6-1: Reference Architecture for 5G Network Interworking. The diagram shows a 5G network (shaded blue circle) containing UE, NG-RAN, SMF, AMF, UPF, and NSSAAF/AAA-P. The UE is connected to the NG-RAN. The NG-RAN is connected to the SMF and the AMF. The SMF is connected to the UPF. The AMF is connected to the NSSAAF/AAA-P. The UPF is connected to the Data Networks via the N6 interface. The NSSAAF/AAA-P is connected to the NSS-AA. The N6 interface is shown as a dashed line between the UPF and the Data Networks.](f8e6ecfa485e4c866b137407e0de01c5_img.jpg) + +``` + +graph LR + subgraph 5G_network [5G network] + UE[UE] --- NG-RAN[NG-RAN] + NG-RAN --- SMF[SMF] + NG-RAN --- AMF[AMF] + SMF --- UPF[UPF] + AMF --- NSSAAF[ NSSAAF / AAA-P ] + end + UPF -- N6 --> DN((Data Networks)) + NSSAAF --- NSS-AA[NSS-AA] + +``` + +Figure 6-1: Reference Architecture for 5G Network Interworking. The diagram shows a 5G network (shaded blue circle) containing UE, NG-RAN, SMF, AMF, UPF, and NSSAAF/AAA-P. The UE is connected to the NG-RAN. The NG-RAN is connected to the SMF and the AMF. The SMF is connected to the UPF. The AMF is connected to the NSSAAF/AAA-P. The UPF is connected to the Data Networks via the N6 interface. The NSSAAF/AAA-P is connected to the NSS-AA. The N6 interface is shown as a dashed line between the UPF and the Data Networks. + +Figure 6-1: Reference Architecture for 5G Network Interworking + +NOTE: The SMF represents the H-SMF in the home routed scenario. + +# 7 Interface to 5G Network services (User Plane) + +The user plane for 5G Network services is defined in subclause 8.3 of 3GPP TS 23.501 [2] and 3GPP TS 29.281 [4]. + +# 8 Interworking with DN (IP) + +## 8.1 General + +5GS shall support interworking with DNs based on the Internet Protocol (IP). These interworked networks may be either intranets or the Internet. + +## 8.2 DN Interworking Model + +### 8.2.1 General + +When interworking with the IP networks, the 5GS can operate IPv4 and/or IPv6. The interworking point is shown in clause 6. + +The UPF for interworking with the IP network is the 5GS access point (see figure 8.2.1-1). + +![Diagram showing the protocol stacks of UPF for IP network interworking. The UPF box contains '5G protocol layers' on the left and a stack of 'IP', 'L2', and 'L1' on the right. The 'N6' reference point is shown as a vertical line to the right of the UPF box.](f14e75bd1c6e2f234db4775dbf0dbf1a_img.jpg) + +The diagram illustrates the protocol stack within the UPF (User Plane Function) for interworking with an IP network. The UPF is represented by a large rectangle. Inside this rectangle, on the left, is a block labeled '5G protocol layers'. On the right, there is a vertical stack of three layers: 'IP' at the top, 'L2' in the middle, and 'L1' at the bottom. Above the 'IP' layer, there is a symbol representing a router or gateway, consisting of two triangles meeting at a point. To the right of the UPF rectangle, a vertical dashed line represents the 'N6' reference point, which separates the UPF from the external IP network. + +Diagram showing the protocol stacks of UPF for IP network interworking. The UPF box contains '5G protocol layers' on the left and a stack of 'IP', 'L2', and 'L1' on the right. The 'N6' reference point is shown as a vertical line to the right of the UPF box. + +Figure 8.2.1-1: The protocol stacks of UPF for the IP network interworking + +Typically, in the IP networks, the interworking with subnetworks is done via IP routers. The N6 reference point is between the UPF and the external IP network. From the external IP network's point of view, the UPF is seen as a normal IP router. The L2 and L1 layers are operator specific. + +It is out of the scope of the present document to standardise the router functions and the used protocols in the N6 reference point. + +Interworking with user defined ISPs and private/public IP networks is subject to interconnect agreements between the network operators. + +### 8.2.2 Access to DN through 5G Network + +#### 8.2.2.1 Transparent access to DN + +![Figure 8.2.2.1-1: Example of the DN Interworking Model, transparent case. The diagram shows a 5GS (5G System) connected to a UPF (User Plane Function). The UPF is connected to an Operator specific IP Network. The Operator specific IP Network is connected to a Firewall / Proxy, which is connected to an External IP Network. The UPF is also connected to a DHCP server and a DNS server. The N6 reference point is indicated between the UPF and the Operator specific IP Network.](7f17c430b9598e4d748a8041457810b3_img.jpg) + +Figure 8.2.2.1-1: Example of the DN Interworking Model, transparent case. The diagram shows a 5GS (5G System) connected to a UPF (User Plane Function). The UPF is connected to an Operator specific IP Network. The Operator specific IP Network is connected to a Firewall / Proxy, which is connected to an External IP Network. The UPF is also connected to a DHCP server and a DNS server. The N6 reference point is indicated between the UPF and the Operator specific IP Network. + +**Figure 8.2.2.1-1: Example of the DN Interworking Model, transparent case** + +In figure 8.2.2.1-1, an example DN interworking model for transparent access to the Internet is provided for an UPF in the 5GS and its N6 reference point. + +In transparent access to the Internet case: + +- the UE is given an IPv4 address and/or an IPv6 prefix belonging to the operator addressing space. The IPv4 address and/or IPv6 prefix is assigned either at subscription in which case it is a static address or at PDU session establishment in which case it is a dynamic address. This IPv4 address and/or IPv6 prefix if applicable is used for packet forwarding between the Internet and the UPF and within the 5GS. With IPv6, Stateless Address Autoconfiguration shall be used to assign an IPv6 address to the UE. These procedures are as described in the IPv6 non-transparent access case except that the addresses belong to the operator addressing space. +- the UE need not send any authentication request at PDU session establishment procedure and the SMF/UPF need not take any part in the user authentication/authorization process. + +The transparent case provides at least a basic ISP service. As a consequence of this it may therefore provide a QoS flow service for a tunnel to a private Intranet. The user level configuration may be carried out between the UE and the intranet, the 5GS is transparent to this procedure. The used protocol stack is depicted in figure 8.2.2.1-2. + +![Figure 8.2.2.1-2: Transparent access to an Intranet. The diagram shows the protocol stack for a UE, UPF, and Intranet. The UE has an Intranet protocol stack (Intranet protocol, IP) on top of 5G protocol layers. The UPF has an IP stack on top of L2/L1 layers. The Intranet has an Intranet protocol stack (Intranet protocol, IP) on top of L2/L1 layers. Arrows indicate the flow of traffic from the UE through the UPF to the Intranet.](63e0c22852c26699d0bd095a2d796bab_img.jpg) + +Figure 8.2.2.1-2: Transparent access to an Intranet. The diagram shows the protocol stack for a UE, UPF, and Intranet. The UE has an Intranet protocol stack (Intranet protocol, IP) on top of 5G protocol layers. The UPF has an IP stack on top of L2/L1 layers. The Intranet has an Intranet protocol stack (Intranet protocol, IP) on top of L2/L1 layers. Arrows indicate the flow of traffic from the UE through the UPF to the Intranet. + +**Figure 8.2.2.1-2: Transparent access to an Intranet** + +The communication between the PLMN and the Intranet may be performed over any network, even an insecure network e.g. the Internet. There is no specific security protocol between the UPF and the Intranet because security is ensured on an end to end basis between the UE and the intranet by the "Intranet Protocol". + +User authentication and encryption of user data are done within the "Intranet Protocol" if either of them is needed. This "Intranet Protocol" may also carry private (IP) addresses belonging to the address space of the Intranet. + +An example of an "Intranet Protocol" is IPsec (see IETF RFC 1825 [29]). If IPsec is used for this purpose, then IPsec authentication header or security header may be used for user (data) authentication and for the confidentiality of user data (see IETF RFC 1826 [30] and IETF RFC 1827 [31]). In this case private IP tunnelling within public IP takes place. + +#### 8.2.2.2 IPv4 Non-transparent access to DN + +In this case: + +- a static or a dynamic IPv4 address belonging to the Intranet/ISP addressing space is allocated to a UE at PDU session establishment. The methods of allocating IP address to the UE are specified in 3GPP TS 23.501 [2]. The allocated IPv4 address is used for packet forwarding within the UPF and for packet forwarding on the Intranet/ISP; +- as a part of the PDU session establishment, the SMF may request user authentication from an external DN-AAA server (i.e. RADIUS, Diameter) belonging to the Intranet/ISP; +- the IPv4 address allocation to the UE may be performed based on the subscription or a local address pool, which belongs to the Intranet/ISP addressing space, provisioned in the SMF; or via the address allocation servers (i.e. DHCPv4, RADIUS DN-AAA, Diameter DN-AAA) belonging to the Intranet/ISP; +- if requested by the UE at PDU session establishment, the SMF may retrieve the Protocol Configuration Options or IPv4 configuration parameters from a locally provisioned database in SMF and/or from some external server (i.e. DHCPv4, RADIUS DN-AAA, Diameter DN-AAA) belonging to the Intranet/ISP; +- the communication between the 5GS and the Intranet/ISP may be performed over any network, even an insecure network, e.g. the Internet. In case of an insecure connection between the UPF and the Intranet/ISP, there may be a specific security protocol in between. This security protocol is defined by mutual agreement between PLMN operator and Intranet/ISP administrator. + +Table 8.2.2.2-1 summarizes the IPv4 address allocation and parameter configuration use cases between the UE and the SMF that may lead the SMF to interwork with the external DHCPv4, DN-AAA servers. For detailed description of the signalling flows between the UE and the SMF, see the references in the table. + +**Table 8.2.2.2-1: IPv4 address allocation and parameter configuration use cases** + +| Signalling use cases between UE and SMF | Signalling use cases between SMF and external servers | | | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------| +| | Authentication via RADIUS or Diameter DN-AAA server (clauses 11 or 12)
(NOTE 1 NOTE 2 and NOTE 4) | IPv4 Address allocation via DHCPv4 or RADIUS or Diameter DN-AAA server (clauses 10, 11 or 12)
(NOTE 1 and NOTE 2) | IPv4 parameter configuration via DHCPv4 or RADIUS or Diameter DN-AAA server (clauses 10, 11 or 12)
(NOTE 1 and NOTE 2) | +| (1) IPv4 address allocation and parameter configuration via activation of QoS flow associated with the default QoS rule
(2) IPv4 address allocation and parameter configuration via DHCPv4 signalling from UE towards SMF (NOTE 3) | X | X | X | +| (3) IPv4 address allocation and parameter configuration in untrusted non-3GPP IP access | X | X | X | +| NOTE 1: When the SMF interworks with AAA servers, the DNN may be configured to interwork with either Diameter DN-AAA or RADIUS DN-AAA server. | | | | +| NOTE 2: If RADIUS DN-AAA or Diameter DN-AAA server is used, the authentication, IPv4 address allocation and parameter configuration signalling may be combined. Similarly, if DHCPv4 server is used for IPv4 address allocation and parameter configuration, the signalling towards the DHCPv4 server may be combined. | | | | +| NOTE 3: If the authentication and authorization procedure towards RADIUS DN-AAA or Diameter DN-AAA is required, it is performed by the SMF before the DHCPv4 signalling when it receives the initial access request (i.e. Nsmf_PDUSession_CreateSMContext). | | | | +| NOTE 4: The N1 mode UE can provide PAP/CHAP user credentials in the ePCO IE when accessing to 5GS on 3GPP and non-3GPP IP accesses. If such information is provided to the SMF, the SMF can perform user authentication with the DN-AAA server based on these credentials, How to perform authentication by the SMF and the DN-AAA server is not specified in this release. | | | | + +NOTE: External network operators intending to use PAP/CHAP without proper underlying protection for authentication are warned about the respective vulnerabilities of PAP and CHAP protocols from a security point of view. It's up to the external network operator to perform the risk assessment if PAP/CHAP is used for authentication. + +#### 8.2.2.3 IPv6 Non-transparent access to DN + +When using IPv6 Address Autoconfiguration, the process of setting up the access to an Intranet or ISP involves two signalling phases. The first signalling phase is done in the control plane and consists of the PDU session establishment for 5GS 3GPP or non-3GPP based access, followed by a second signalling phase done in the user plane. + +The user plane signalling phase shall be stateless. The stateless procedure, which involves only the UE and the SMF, is described in subclause 10.2.3. + +For DNNs that are configured for IPv6 address allocation, the SMF shall only use the Prefix part of the IPv6 address for forwarding of mobile terminated IP packets. The size of the prefix shall be according to the maximum prefix length for a global IPv6 address as specified in the IPv6 Addressing Architecture, see IETF RFC 4291 [32]. + +The SMF indicates to the UE that Stateless Autoconfiguration shall be performed by sending Router Advertisements as described in subclause 10.2.3 and according to the principles defined in IETF RFC 4861 [33] and IETF RFC 4862 [34]. + +For UE supporting IPv6, IPv6 Stateless Address Autoconfiguration is mandatory. + +In this case, the SMF provides the UE with an IPv6 Prefix belonging to the Intranet/ISP addressing space. A dynamic IPv6 address is given using stateless address autoconfiguration. This IPv6 address is used for packet forwarding within the UPF and for packet forwarding on the Intranet/ISP. + +When an SMF receives an initial access request (i.e. Nsmf\_PDUSession\_CreateSMContext) message, the SMF deduces from local configuration data associated with the DNN: + +- The source of IPv6 Prefixes (SMF internal prefix pool, or external address allocation server); +- Any server(s) to be used for address allocation, authentication and/or protocol configuration options retrieval (e.g. IMS related configuration, see 3GPP TS 24.229 [13]); +- The protocol, i.e. RADIUS, Diameter or DHCPv6, to be used with the server(s); +- The communication and security feature needed to communicate with the server(s). + +As an example, the SMF may use one of the following options: + +- SMF internal Prefix pool for IPv6 prefixes allocation and no authentication; +- SMF internal Prefix pool for IPv6 prefixes allocation and RADIUS for authentication. The RADIUS DN-AAA server responds with either an Access-Accept or an Access-Reject to the RADIUS client in the SMF; +- RADIUS for authentication and IPv6 prefix allocation. The RADIUS DN-AAA server responds with either an Access-Accept or an Access-Reject to the RADIUS client in the SMF. + +The SMF includes the IPv6 address composed of a Prefix and an Interface-Identifier in the initial access response (Namf\_Communication\_NIN2MessageTransfer). The Interface-Identifier may have any value and it does not need to be unique within or across DNNs. It shall however not conflict with the Interface-Identifier that the SMF has selected for its own side of the UE-SMF link. The Prefix assigned by the SMF or the external DN-AAA server shall be globally or site-local unique (see the Note in subclause 11.3 of this document regarding the usage of site-local addresses). + +Table 8.2.2.3-1 summarizes the IPv6 prefix allocation and parameter configuration use cases between the UE and the SMF that may lead the SMF to interwork with the external RADIUS DN-AAA, Diameter DN-AAA and DHCPv6 servers. For detailed description of the signalling flows between the UE and the SMF, see the references in the table. + +**Table 8.2.2.3-1: IPv6 prefix allocation and parameter configuration use cases** + +| Signalling use cases between UE and SMF | Signalling use cases between SMF and external servers | | | +|-----------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------| +| | Authentication via RADIUS or Diameter DN-AAA server (clauses 11 or 12)

(NOTE 1
NOTE 2 and
NOTE 3) | IPv6 prefix allocation via DHCPv6 or RADIUS or Diameter DN-AAA server (clauses 10, 11 or 12)

(NOTE 1 and
NOTE 2) | IPv6 parameter configuration via DHCPv6 or RADIUS or Diameter DN-AAA server (clauses 10, 11 or 12)

(NOTE 1 and
NOTE 2) | +| (1) IPv6 address allocation and parameter configuration | X | X | X | +| (2) IPv6 parameter configuration via stateless DHCPv6 | | | | +| (3) IPv6 address allocation and parameter configuration in untrusted non-3GPP IP access | X | X | X | + +NOTE 1: When the SMF interworks with DN-AAA servers, the DNN may be configured to interwork with either Diameter DN-AAA or RADIUS DN-AAA server. + +NOTE 2: If RADIUS DN-AAA or Diameter DN-AAA server is used, the authentication, IPv6 prefix allocation and parameter configuration signalling may be combined. Similarly, if DHCPv6 server is used for IPv6 prefix allocation and parameter configuration, the signalling towards the DHCPv6 server may be combined. + +NOTE 3: The N1 mode UE can provide PAP/CHAP user credentials in the ePCO IE when accessing to 5GS on 3GPP and non-3GPP IP accesses. If such information is provided to the SMF, the SMF can perform user authentication with the DN-AAA server based on these credentials, How to perform authentication by the SMF and the DN-AAA server is not specified in this release. + +NOTE: External network operators intending to use PAP/CHAP without proper underlying protection for authentication are warned about the respective vulnerabilities of PAP and CHAP protocols from a security point of view. It's up to the external network operator to perform the risk assessment if PAP/CHAP is used for authentication. + +For IPv6 the PDU session establishment phase is followed by an address autoconfiguration phase. IPv6 prefix is delivered to UE in Router Advertisement message from the SMF which acts as an access router, in the process of IPv6 Stateless Address Autoconfiguration as described in subclause 10.2.2. Besides DHCPv6 protocol, the SMF may also use RADIUS or Diameter protocol for the retrieval of an IPv6 prefix from external DN. + +# 9 Interworking with DN (Unstructured) + +## 9.1 General + +When support of unstructured PDU type data is provided at the N6 interface, different Point-to-Point (PtP) tunneling techniques may be used. When using PtP tunneling by UDP/IPv6 encapsulation subclause 9.2 below shall be followed. Other techniques as described in subclause 9.3 below may be used. + +In the following subclauses, the AS is used as an example for the destination in the external DN. + +## 9.2 N6 PtP tunnelling based on UDP/IP + +N6 PtP tunnelling based on UDP/IPv6 may be used to deliver unstructured PDU type data to the AS. + +The PtP tunnel is set up by configuration of tunnel parameters in both end of the tunnel. The following parameters are pre-configured in the UPF per DNN: + +- the UDP destination port number to use when sending unstructured PDU type data; +- the UDP port number it wants to receive unstructured PDU type data; +- the destination IP address to be used for sending unstructured PDU type data. + +The following is pre-configured in the AS: + +- the UDP destination port number to use when sending unstructured PDU type data; +- the UDP port number it wants to receive unstructured PDU type data. + +NOTE 1: The UPF as well as the AS can use any UDP port numbers not assigned by IANA. The port numbers used need to be aligned between peers. + +IP address allocation procedures for the UE (i.e. PDU session) are performed by the SMF as described in subclause 6.3.2, but the IPv6 prefix is not provided to the UE, i.e. Router Advertisements and DHCPv6 are not performed. The SMF assigns a suffix (i.e. IPv6 Interface Identifier) for the PDU session. For the N6 PtP tunnel, the IPv6 prefix allocated for the PDU session plus suffix assigned for the PtP tunnel is used as source address for the uplink data and as destination address for the downlink data. + +During the PDU session establishment, the UPF associates the GTP-U tunnel for the PDU session with the N6 PtP tunnel. + +The UPF acts as a transparent forwarding node between the UE and the AS. + +For uplink delivery, if the uplink data is received from the GTP-U tunnel, the UPF shall forward the received data to the AS over the N6 PtP tunnel associated with the GTP-U tunnel with the destination address of the AS and the configured UDP destination port number for unstructured PDU type data. + +For downlink delivery, the AS shall send the data using UDP/IP encapsulation with the IPv6 prefix plus suffix as destination address and the configured UDP destination port number for unstructured PDU type data. + +NOTE 2: The UPF decapsulates the received data (i.e. removes the UDP/IPv6 headers) and forwards the data on the GTP-U tunnel identified by the IPv6 prefix of the UE (i.e. PDU session) for delivery to the UE. + +![Protocol configuration diagram for unstructured PDU type data (user plane) using N6 UDP/IPv6 PtP tunneling. The diagram shows data flow between the UPF (User Plane Function) and the DN (Data Network) across the N6 interface. On the DN side, data is encapsulated in layers: Unstructured data, UDP, IP, L2, and L1. On the UPF side, the data is decapsulated through layers: L1, L2, IP, UDP/IP, and GTP-U. The GTP-U layer is connected to the N3 interface. A 'Relay' box at the top of the UPF indicates the forwarding function between the N3 and N6 interfaces.](96b0240f56d14453b5da05ec30fd5c6e_img.jpg) + +Protocol configuration diagram for unstructured PDU type data (user plane) using N6 UDP/IPv6 PtP tunneling. The diagram shows data flow between the UPF (User Plane Function) and the DN (Data Network) across the N6 interface. On the DN side, data is encapsulated in layers: Unstructured data, UDP, IP, L2, and L1. On the UPF side, the data is decapsulated through layers: L1, L2, IP, UDP/IP, and GTP-U. The GTP-U layer is connected to the N3 interface. A 'Relay' box at the top of the UPF indicates the forwarding function between the N3 and N6 interfaces. + +**Figure 9.2-1: Protocol configuration for unstructured PDU type data (user plane) using N6 UDP/IPv6 PtP tunneling** + +## 9.3 Other N6 tunnelling mechanism + +N6 PtP tunnelling mechanisms such as PMIPv6/GRE, L2TP, etc, may be used to deliver unstructured PDU type data to AS. The general handling of such delivery mechanisms is as described below. + +A PtP tunnel is established by the UPF towards the AS. Depending on the type of protocol employed on the N6 PtP tunnel, the N6 PtP tunnel setup may be done at the time of PDU Session establishment or at the time of first MO datagram being sent by the UE. The UPF selects the AS based on its configuration (e.g. per DNN, or per PtP tunnel type, etc). However, IP address allocation procedures for the UE (according to subclause 6.3.2) are not performed by the SMF. + +NOTE: An AS can be dedicated for handling a specific protocol for unstructured PDU type data. + +The UPF acts as a transparent forwarding node between the UE and the AS. + +For uplink delivery, the UPF forwards the received data to the AS over the established N6 PtP tunnel. + +For downlink delivery, the AS locates the right N6 PtP tunnel for the UE (using information such as UE identifiers in the unstructured PDU type protocol itself, etc) to forward the data. The AS sends the data to UPF over the established N6 PtP tunnel. The UPF in turn sends the data on the GTP-U tunnel identified by the associated N6 PtP tunnel for delivery to the UE. + +# 10 Interworking with DN (DHCP) + +## 10.1 General + +In current LAN environments the most commonly used configuration protocol is DHCP (Dynamic Host Configuration Protocol, RFC 2131 [18]) and DHCPv6 (Dynamic Host Configuration Protocol for IPv6, IETF RFC 3315 [21]). It provides a mechanism for passing a large set of configuration parameters to hosts connected to a TCP/IP network (IP address, sub-net mask, domain name, MTU, etc.) in an automatic manner. Moreover, DHCP may assign IP addresses to clients for a finite lease time, allowing for sequential reassignment of addresses to different users. + +The lease time is chosen by the administrator of the DHCP server (in the external network), and is therefore out of the scope of the present document. + +The 3GPP network may obtain IP address via external DHCP server during the PDU establishment procedure, the SMF acts a DHCP server towards the UE and it acts as a DHCP client towards the external DHCP server. + +In the following cases the PDU session associated with the allocated IPv4 address or IPv6 prefix shall be released: + +- if the DHCP lease expires; +- if the DHCP renewal is rejected by the DHCP server; +- if the IP address is changed during the renewal process. Usually when the lease is renewed, the IP address remains unchanged. However, if for any reason (e.g. poor configuration of the DHCP server), a different IP address is allocated during the lease renewal process the associated PDU session shall be released. + +## 10.2 DN interworking Model of SMF for DHCP + +### 10.2.1 Introduction + +A DHCP client shall be located in the SMF used for interworking with the IP network as illustrated in figure 10.2.1-1. + +![Diagram illustrating the protocol stacks for the N6 reference point for DHCP. The SMF (Service Management Function) contains a stack of layers: DHCP Client, UDP, IP, L2, and L1. The UPF (User Plane Function) is shown as a separate entity. The N6 reference point is indicated by a vertical line on the right. The diagram shows the flow of data from the SMF through the UPF to the N6 reference point.](3a33f3d9710df2b4c805247cd69facc3_img.jpg) + +The diagram shows the protocol stack for the N6 reference point. On the left, the SMF (Service Management Function) is represented by a large box containing five stacked layers: DHCP Client, UDP, IP, L2, and L1. A large arrow points from the SMF towards the right, passing through a box labeled UPF (User Plane Function). The arrow then points to a vertical line on the right labeled N6, representing the reference point to the Data Network. Below the UPF box, there is another horizontal line that connects to the N6 line. + +Diagram illustrating the protocol stacks for the N6 reference point for DHCP. The SMF (Service Management Function) contains a stack of layers: DHCP Client, UDP, IP, L2, and L1. The UPF (User Plane Function) is shown as a separate entity. The N6 reference point is indicated by a vertical line on the right. The diagram shows the flow of data from the SMF through the UPF to the N6 reference point. + +Figure 10.2.1-1: The protocol stacks for the N6 reference point for DHCP + +The DHCP client function in the SMF shall be used to allocate IPv4 address or IPv6 prefix to the UE and/or to configure associated parameters via external DHCP servers. The SMF shall have both DHCPv4 and DHCPv6 client functions. + +The procedures where the DHCP client function in the SMF is used are further described in 3GPP TS 23.501 [2]. The procedures are IPv4 address allocation and IPv4 parameter configuration via an external DHCPv4 server; IPv6 Prefix allocation via stateless address autoconfiguration; and IPv6 parameter configuration via stateless DHCPv6. These procedures are detailed in the subclauses below. + +### 10.2.2 IPv4 Address allocation and IPv4 parameter configuration via DHCPv4 + +The UE may obtain the IPv4 address and/or its configuration parameters at or after the initial access signalling (i.e. Nsmf\_PDUSession\_CreateSMContext) to the 3GPP network. The request for IPv4 address and/or configuration parameters from the UE may trigger the SMF acting as a DHCPv4 client to request the IPv4 address and/or configuration parameters from an external DHCPv4 server and deliver them to the UE. The DHCPv4 functions in the SMF, the UE and the external DHCPv4 server shall be compliant to IETF RFC 2131 [18], IETF RFC 1542 [19] and IETF RFC 4039 [20]. + +The following system procedure describes the successful IPv4 address allocation and parameter configuration signalling flow between the SMF and the external DHCPv4 server as depicted in figure 10.2.2-1. For a detailed description of the DHCPv4 messages, refer to IETF RFC 2131 [18], IETF RFC 1542 [19] and IETF RFC 4039 [20]. + +- 1) The DHCPv4 client function in the SMF sends a DHCPDISCOVER as an IP limited broadcast message, i.e. the destination address 255.255.255.255, towards the external DN. If the SMF has the DHCPv4 server IP addresses configured for the DNN, the DHCPDISCOVER shall be sent as unicast (or even multicast) to the external DHCPv4 servers. +- 2) Upon receiving the DHCPDISCOVER request message, the external DHCPv4 servers reply by sending a DHCPOFFER message including an offered IP address. Several DHCPOFFER messages may be received by the SMF if multiple DHCPv4 servers respond to the DHCPDISCOVER. +- 3) The DHCPv4 client function in the SMF processes the messages and sends a DHCPREQUEST towards the selected external DHCPv4 server. + +NOTE: If the optimized signalling (Rapid Commit Option) is used as per IETF RFC 4039 [20], the messages 2-3 can be eliminated. + +- 4) Upon receiving the DHCPREQUEST message, the selected external DHCPv4 server acknowledges the address allocation by sending a DHCPACK containing the lease period (T1), the time-out time (T2) and the configuration information requested in DHCPREQUEST. The SMF stores the allocated IPv4 address, the lease timers and the configuration parameters. The SMF shall further deliver the IPv4 address and the configuration parameters to the UE by SM NAS message. + +![Sequence diagram showing the signalling flow for IPv4 address allocation and parameter configuration using DHCPv4 between the SMF (DHCPv4 Client) and the DHCPv4 Server.](e928f4874ed492d3ad4c6fa2d29aedbc_img.jpg) + +``` +sequenceDiagram + participant SMF as SMF (DHCPv4 Client) + participant DHCPv4Server as DHCPv4 Server + Note left of SMF: UE requests IPv4 address + SMF->>DHCPv4Server: 1. DHCPDISCOVER + DHCPv4Server-->>SMF: 2. DHCPOFFER + SMF->>DHCPv4Server: 3. DHCPREQUEST + DHCPv4Server-->>SMF: 4. DHCPACK + Note right of DHCPv4Server: SMF delivers to UE via SM NAS +``` + +Sequence diagram showing the signalling flow for IPv4 address allocation and parameter configuration using DHCPv4 between the SMF (DHCPv4 Client) and the DHCPv4 Server. + +**Figure 10.2.2-1: The signalling flow for IPv4 address allocation and parameter configuration using DHCPv4** + +Figure 10.2.2-2 is a signalling flow for IPv4 address lease renew by using DHCPv4 protocol as specified in IETF RFC 2131 [18]. + +- 1) The DHCPv4 client function in the SMF sends a unicast DHCPREQUEST towards the external DHCPv4 server to extend the lease period of the allocated IPv4 address. +- 2) The external DHCPv4 server replies with a DHCPACK message confirming the renewed lease and the T1 and T2 timers are restarted. + +![Sequence diagram showing the signalling flow for IPv4 address lease renew using DHCPv4. The diagram shows two vertical lifelines: SMF (DHCPv4 Client) on the left and DHCPv4 Server on the right. A horizontal arrow labeled '1. DHCPREQUEST' points from the SMF to the Server. A horizontal arrow labeled '2. DHCPACK' points from the Server back to the SMF.](10781f43062bf3e9601a1e086710556c_img.jpg) + +``` + +sequenceDiagram + participant SMF as SMF (DHCPv4 Client) + participant Server as DHCPv4 Server + Note left of SMF: DHCPREQUEST + SMF->>Server: 1. DHCPREQUEST + Note right of Server: DHCPACK + Server-->>SMF: 2. DHCPACK + +``` + +Sequence diagram showing the signalling flow for IPv4 address lease renew using DHCPv4. The diagram shows two vertical lifelines: SMF (DHCPv4 Client) on the left and DHCPv4 Server on the right. A horizontal arrow labeled '1. DHCPREQUEST' points from the SMF to the Server. A horizontal arrow labeled '2. DHCPACK' points from the Server back to the SMF. + +**Figure 10.2.2-2: The signalling flow for IPv4 address lease renew using DHCPv4** + +### 10.2.3 IPv6 Prefix allocation via IPv6 stateless address autoconfiguration via DHCPv6 + +When the IPv6 prefix is allocated from the external DN, the SMF is responsible to obtain the IPv6 prefix for external DN, allocate and release the IPv6 prefix. The SMF may use DHCPv6 to obtain the IPv6 prefix from the external DN. In this context, the SMF shall act as a DHCP client as per IETF RFC 3315 [21] towards the external DHCPv6 server. + +The SMF may allocate a second IPv6 prefix for routing traffic via a second UPF to enable simultaneous access via remote and local networks or to enable SSC mode 3 (i.e. make-before-break) mobility, as described in subclause 4.3.5.3 of 3GPP TS 23.502 [3]. + +The following system procedure describes the signalling flows for the IPv6 Stateless Address Autoconfiguration procedures for 5G system. The procedures are based on the descriptions in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]. + +1. UE initiates the PDU Session Establishment procedure, indicating IPv6 address is required. +2. The AMF sends PDU Session Establishment Request in Nsmf\_PDUSession\_CreateSMContext to the SMF. +3. The SMF may retrieve IPv6 prefix using DHCPv6 mechanism. This procedure is performed when an external DN allocates an IPv6 prefix, the signaling between the SMF and external DN is exchanged via UPF which is omitted in the figure 10.2.3-1. +4. The SMF sends PDU Session Establishment Accept included in Namf\_Communication\_N1N2MessageTransfer to the AMF. It includes the IPv6 prefix. +5. The AMF sends PDU Session Establishment Accept message to the UE without the IPv6 prefix. The UE shall ignore the IPv6 prefix if it receives it in the message. +6. The UE may send a Router Solicitation to the SMF via the UPF to solicit a Router Advertisement message. +7. The SMF sends a Router Advertisement message to the UE via the UPF, solicited or unsolicited. It shall include an IPv6 prefix in Prefix Information option field of the message. The prefix is the same as the one in the PDU Session Establishment Accept message, if it is provided during the previous PDU Session Establishment procedure. +8. At any time after PDU session establishment, the SMF may trigger the establishment on an alternative route via UPF2 for access to a local data network or for SSC mode 3 mobility. +9. Like step 3, the SMF may retrieve a second IPv6 prefix using DHCPv6 mechanism. +10. The SMF sends a Router Advertisement to the UE via UPF2 to update the UE. Note that this will occur without a Router Solicitation since the UE is unaware of the network's decision to form an alternative Route. +11. Specific to the case of SSC mode 3 mobility, the SMF sends a Router Advertisement to the UE via UPF1 with zero value in the preferred lifetime field and a value in the valid lifetime field according to IETF RFC 4862 [34]. + +The UE shall update the valid lifetime of the old IPv6 prefix to the signalled value, regardless of the remaining lifetime. The signalled lifetime value indicates how long the SMF is willing to keep the old IPv6 prefix. + +NOTE: Alternative routes can be established repeatedly through additional UPFs and old routes can be terminated when required by the SMF. More complex scenarios are not described here for the sake of simplicity. + +![Sequence diagram for Figure 10.2.3-1: IPv6 Stateless Address Autoconfiguration showing interactions between UE, AMF, UPF1, UPF2, SMF, and External PDN.](3da1a07cb87051bf616c9876db958cf0_img.jpg) + +``` + +sequenceDiagram + participant UE + participant AMF + participant UPF1 + participant UPF2 + participant SMF + participant External PDN + + UE->>AMF: 1. PDU Session Establishment Request + AMF->>SMF: 2. Nsmf_PDUSession_CreateSMContext (PDU Session Establishment Request) + SMF-->>External PDN: 3. DHCPv6 + SMF->>AMF: 4. Namf_Communication_N1N2MessageTransfer (PDU Session Establishment Accept) + AMF->>UE: 5. PDU Session Establishment Accept + UE-->>SMF: 6. Router Solicitation (through UPF1) + SMF->>UE: 7. Router Advertisement (through UPF1) + Note over UPF2, SMF: 8. Create a 2nd IPv6 Prefix +tunneled through UPF2 for +the existing PDU session + SMF-->>External PDN: 9. DHCPv6 + SMF->>UE: 10. Router Advertisement (through UPF2) + SMF->>UE: 11. Router Advertisement (through UPF1) + +``` + +Sequence diagram for Figure 10.2.3-1: IPv6 Stateless Address Autoconfiguration showing interactions between UE, AMF, UPF1, UPF2, SMF, and External PDN. + +**Figure 10.2.3-1: IPv6 Stateless Address Autoconfiguration** + +### 10.2.4 IPv6 parameter configuration via stateless DHCPv6 + +A UE that has obtained an IPv6 address may use stateless DHCP to request other configuration information such as a list of DNS recursive name servers or SIP servers. + +For 3GPP networks, when an external DHCPv6 server in a DN is used to obtain the requested parameters, the SMF acts as a DHCPv6 client towards the external DHCPv6 server while acting a DHCPv6 server towards the UE. + +The IPv6 parameter configuration via stateless DHCPv6 function in the UE, the SMF and the external DHCPv6 Server shall be compliant to IETF RFC 3736 [22]. The following system procedure describes the signalling flows for the IPv6 parameter configuration via stateless DHCPv6 procedures for 5G system. All messages in the following steps between the UE and the SMF are sent via the UPF. + +- 1) A Router Advertisement with the O-flag set, is sent from SMF to UE to indicate to it to retrieve other configuration information. +- 2) The UE sends an INFORMATION-REQUEST message with the IP destination address set to the All\_DHCP\_Relay\_Agents\_and\_Servers multicast address defined in the DHCPv6 IETF RFC 3315 [21]. The source address shall be the link-local address of the UE. The DHCP relay agent in the SMF shall forward the message. +- 3) DHCP servers receiving the forwarded INFORMATION-REQUEST message, reply by sending a RELAY-REPLY message, with the "Relay Message" option including a REPLY message with the requested configuration parameters. + +The UE chooses one of the possibly several REPLY messages and extracts the configuration information. + +![Sequence diagram showing DHCPv6 Other configuration signal flow between UE, SMF DHCP Relay Agent, and Intranet or ISP DHCP Server(s).](79e1709a7317ead45379cbb8ff3ba802_img.jpg) + +``` + +sequenceDiagram + participant UE + participant SMF as SMF DHCP Relay Agent + participant ISP as Intranet or ISP DHCP Server(s) + Note left of UE: ---- f + Note right of ISP: ---- f + UE->>SMF: 1. Router Advertisement ( O-flag=1 ) + SMF->>UE: + UE->>SMF: 2. INFORMATION-REQUEST + SMF->>ISP: RELAY-FORWARD( INFORMATION-REQUEST ) + ISP->>SMF: 3. REPLY (maybe several) + SMF->>UE: RELAY-REPLY( REPLY ) + +``` + +Sequence diagram showing DHCPv6 Other configuration signal flow between UE, SMF DHCP Relay Agent, and Intranet or ISP DHCP Server(s). + +**Figure 10.2.4-1: DHCPv6 Other configuration signal flow** + +### 10.2.5 Ipv6 Prefix Delegation via DHCPv6 + +A RG may request Ipv6 prefix allocation for UE behind the RG as specified in 3GPP TS 23.316 [43]. A SMF may receive both DHCP options for IA\_NA and IA\_PD together in a single DHCPv6 message, the SMF may provide a reply to both IA\_NA and IA\_PD in the same message or alternatively process the DHCPv6 IA\_NA before the DHCPv6 IA\_PD. + +Optionally, a single network prefix shorter than the default /64 prefix may be assigned to a PDU Session. In this case, the /64 default prefix used for Ipv6 stateless autoconfiguration will be allocated from this network prefix; the remaining address space from the network prefix can be delegated to the PDU Session using prefix delegation after the PDU session Setup/default QoS flow establishment and Ipv6 prefix allocation via Ipv6 stateless address autoconfiguration as defined in subclause 10.2.3. When PLMN based parameter configuration is used, the SMF provides the requested Ipv6 prefix from a locally provisioned pool. When external DN based Ipv6 prefix allocation is used, the SMF may obtain the prefix from the external DN. + +For the detailed description of the RG uses DHCPv6 to request additional Ipv6 prefixes refer to 3GPP TS 23.316 [43]. The use of prefix exclude option is optional, and it is possible for SMF to assign a /64 prefix using stateless address autoconfiguration and a completely different shorter prefix using DHCPv6 Prefix Delegation. + +## 10.3 3GPP Vendor-Specific Options + +This clause describes 3GPP Vendor-Specific Options that will be included in DHCP messages exchanged between SMF and DHCP Server. Other DHCP options may be used as defined in DHCP RFC(s). Unless otherwise stated, when the encoding scheme of an attribute is specified as UTF-8 encoding, this shall be interpreted as UTF-8 hexadecimal encoding. + +The DHCPv4 vendor specific option is encoded as per IETF RFC 2132 [47] or IETF RFC 3925 [48]. The DHCPv6 vendor specific option is encoded as per IETF RFC 8415 [49]. For DHCP vendor specific option code 17 or 125, the Enterprise Number shall be set to value 10415. + +The table 10.3-1 lists the encapsulated 3GPP Vendor-Specific Options in DHCP vendor specific option (17/43/125). + +**Table 10.3-1: List of the encapsulated 3GPP Vendor-Specific sub-options** + +| Sub-opt # | Sub-option Name | Presence | +|-----------|-------------------|----------| +| 1 | 3GPP-IP-Pool-Info | Optional | + +### 1 – 3GPP-IP-Pool-Info + +| Octets | Bits | | | | | | | | +|--------|--------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | VS option code = 1 | | | | | | | | +| 2 | VS option length | | | | | | | | +| 3-m | IP address pool ID | | | | | | | | + +| Octets | DHCPv6 Bits | | | | | | | | +|--------|--------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1-2 | VS option code = 1 | | | | | | | | +| 3-4 | VS option length | | | | | | | | +| 5-m | IP address pool ID | | | | | | | | + +VS option code: 1 + +Length: m-2 or m-4 + +The IP address pool ID is of Octet String type. + +The SMF may determine an IP address pool ID based on UPF ID, S-NSSAI, DNN, and IP version as described in subclause 5.8.2.2.1 in 3GPP TS 23.501 [2] and includes the IP address pool ID within 3GPP Vendor-Specific-Option and send it to the DHCP server. The DHCP server assigns IPv6 prefix or IPv4 address from the requested IP address pool. Multiple 3GPP-IP-Pool-Info sub-options may be sent in a DHCP request message. The DHCP server shall return the selected IP address pool ID within 3GPP Vendor-Specific-Option to the SMF in the DHCP successful response message (e.g. DHCPACK). + +# 11 Interworking with DN-AAA (RADIUS) + +## 11.1 RADIUS procedures + +### 11.1.1 RADIUS Authentication and Authorization + +The SMF also represents the H-SMF in the home routed scenario in this subclause unless specified otherwise. + +RADIUS Authentication and Authorization shall be used according to IETF RFC 2865 [8], IETF RFC 3162 [9] and IETF RFC 4818 [10]. In 5G, multiple authentication methods using Extensible Authentication Protocol (EAP) may be used such as EAP-TLS (see IETF RFC 5216 [11]), EAP-TTLS (see IETF RFC 5281 [37]). The SMF shall implement the RADIUS extension to support EAP as specified in IETF RFC 3579 [7]. + +The RADIUS client function may reside in an SMF. When the SMF receives an initial access request (i.e. the SMF receives the Nsmf\_PDUSession\_CreateSMContext request with type "Initial request" for non-roaming case or local breakout case, or the H-SMF receives the Nsmf\_PDUSession\_Create Request with type "Initial request" for home routed case), the RADIUS client function may send the authentication information to a DN-AAA server, which is identified during the DNN provisioning. + +The DN-AAA server performs authentication and authorization. The response (when positive) may contain network information, such as an IPv4 address and/or IPv6 prefix for the user when the SMF is interworking with the DN-AAA server. + +The information delivered during the RADIUS authentication can be used to automatically correlate the user identity (e.g. SUPI) to the IPv4 address and/or IPv6 prefix, if applicable, assigned/confirmed by the SMF or the DN-AAA server respectively. The same procedure applies, in case of sending the authentication to a 'proxy' DN-AAA server. + +For 5G, RADIUS Authentication is applicable to the initial access request. When the SMF receives an Access-Accept message from the DN-AAA server it shall complete the initial access procedure. If Access-Reject or no response is received, the SMF shall reject the initial access procedure with a suitable cause code. + +When DN-AAA server authorizes the PDU Session Establishment, it may send DN authorization data for the established PDU Session to the SMF. The DN authorization data for the established PDU Session may include one or more of the following: + +- a reference to authorization data for policy and charging control locally configured in the SMF or PCF; +- a list of allowed MAC addresses (maximum 16) for the Ethernet PDU Session; +- a list of allowed VLAN Ids (maximum 16) for the Ethernet PDU Session; and +- Session-AMBR for the PDU Session. + +SMF policies may require DN authorization without DN authentication. In that case, when contacting the DN-AAA server for authorization, the SMF shall provide the GPSI of the UE if available. + +The SMF may also use the RADIUS re-authorization procedure for the purpose of IPv4 address and/or IPv6 prefix allocation to the UE. The use cases that may lead this procedure are: + +- IPv4 address and/or IPv6 prefix allocation after UPF selection during PDU session establishment procedure. +- IPv6 prefix allocation during adding additional PDU Session Anchor procedure for IPv6 multi-homing. +- IPv4 address allocation via DHCPv4 procedure after successful PDU session establishment procedure. + +The SMF may also trigger request for DN authentication/authorization and/or IP address/prefix allocation based on UE subscription data retrieve from the UDM as defined in subclause 5.2.2.2.5 of 3GPP TS 29.503. + +When an IPv4 address and/or IPv6 prefix (including any additional IPv6 prefix of IPv6 multi-homing) is (re-)allocated or de-allocated (not causing the PDU session to be released) by using a method not via the DN-AAA server and if the SMF was required by the DN-AAA server to report such change during authentication procedure or by local configuration, the SMF shall, if applicable, use the authentication session that was established before to inform the DN-AAA server by sending RADIUS Access-Request with the latest list of IPv4 address and/or IPv6 prefix(es). + +When the SMF is notified by the UPF regarding the UE MAC address change (a new one is detected or a used one is inactive), if the SMF was required by the DN-AAA server to report such change during authentication procedure or by local configuration, the SMF shall, if applicable, use the authentication session that was established before to inform the DN-AAA server by sending RADIUS Access-Request with the latest list of UE MAC addresses in use. + +DN-AAA may initiate QoS flow termination and re-authorization, see details in clause 11.2.3 and clause 11.2.4. In the present release, the DN-AAA initiated re-authentication is not supported. + +For the 5GS interworking with EPS scenario, EAP based secondary authentication and re-authentication is not applicable to the PDN connection when the UE is in EPS in this release. Secondary authorization (without authentication of the UE) with a DN-AAA server is supported when the UE is in EPS. + +In case EAP based authentication and authorization has been performed for the PDU Session while the UE was in 5GS, and if SMF+PGW-C determines that the UE has moved to the EPS (i.e. the SMF+PGW-C receives the modify bearer request or create session request from the S-GW), how to handle the following procedure is implementation specific. + +NOTE: The SMF+PGW-C can initiate RADIUS re-authorization procedure without re-authentication with the DN-AAA server based on local policy. The DN-AAA server decides the actions to take (e.g. to request another re-authorization without the association with EAP based re-authentication or release the session) is out of 3GPP scope. + +### 11.1.2 RADIUS Accounting + +RADIUS Accounting shall be used according to IETF RFC 2866 [26], IETF RFC 3162 [9] and IETF RFC 4818 [10]. + +The RADIUS accounting client function may reside in an SMF. The RADIUS accounting client may send information to a DN-AAA server, which is identified during the DNN provisioning. The DN-AAA server may store this information and use it to automatically identify the user. This information can be trusted because the 3GPP network has authenticated the subscriber (i.e. USIM card and possibly other authentication methods). + +The SMF may use the RADIUS Accounting-Request Start and Stop messages during QoS flow (e.g. QoS flow associated with the default QoS rule) establishment and termination procedures, respectively. + +The use of Accounting-Request STOP and in addition the Accounting ON and Accounting OFF messages may be used to ensure that information stored in the DN-AAA server is synchronised with the SMF information. + +If the DN-AAA server is used for IPv4 address and/or IPv6 prefix assignment, then, upon reception of a RADIUS Accounting-Request STOP message for all QoS flows associated to a PDU session defined by DNN and SUPI or GPSI, the DN-AAA server may make the associated IPv4 address and/or IPv6 prefix available for assignment. + +When an IPv4 address and/or IPv6 prefix (including any additional IPv6 prefix of IPv6 multi-homing) is (re-)allocated or de-allocated (not causing the PDU session to be released) by using a method not via the DN-AAA server and if the SMF was required by the DN-AAA server to report such change during authentication procedure or by local configuration, the SMF shall, if applicable, use the accounting session that was established before to inform the DN- + +AAA server by sending RADIUS Accounting-Request Interim-Update with the latest list of IPv4 address and/or IPv6 prefix(es). + +When the SMF is notified by the UPF regarding the UE MAC address change (a new one is detected or a used one is inactive), if the SMF was required by the DN-AAA server to report such change during authentication procedure or by local configuration, the SMF shall, if applicable, use the accounting session that was established before to inform the DN-AAA server by sending RADIUS Accounting-Request Interim-Update with the latest list of UE MAC addresses in use. + +In order to avoid race conditions, the SMF shall include a 3GPP Vendor-Specific sub-attribute "Session Stop indicator" when it sends the Accounting-Request STOP for the last QoS flow of a PDU session and the PDU session is terminated (i.e. the IPv4 address and/or IPv6 prefix and any associated GTP tunnel can be released). The DN-AAA server shall not assume the PDU session terminated until an Accounting-Request STOP with the Session Stop indicator is received. + +## 11.2 Message flows on N6 interface + +### 11.2.1 Authentication, Authorization and Accounting procedures + +The SMF also represents the H-SMF in the home routed scenario in this subclause unless specified otherwise. + +When an SMF receives an initial access request (i.e. the SMF receives the Nsmf\_PDUSession\_CreateSMContext request with type "Initial request" for non-roaming case or local breakout case, or the H-SMF receives the Nsmf\_PDUSession\_Create Request with type "Initial request" for home routed case) message for a given DNN, the SMF may (depending on the configuration for this DNN) send a RADIUS Access-Request message with EAP extension to an DN-AAA server. Upon receipt of the Access-Request message, the DN-AAA server shall respond with an Access-Challenge message. Multi-round authentication using the Access-Challenge (sent by DN-AAA) and Access-Request messages may be used. The DN-AAA server finally authenticates and authorizes the user by replying with an Access Accept message. If the DN-AAA server is also responsible for IPv4 address and/or IPv6 prefix allocation, the DN-AAA server shall return the allocated IPv4 address and/or IPv6 prefix in the Access-Accept message. + +For re-authentication and re-authorization, the SMF shall send a RADIUS Access-Request message with EAP extension and the DN-AAA shall respond with an Access-Challenge message. Multi-round authentication using the Access-Challenge (sent by DN-AAA) and Access-Request messages may be used. The DN-AAA server finally authenticates and authorizes the user by replying with an Access Accept message. + +The SMF may initiate RADIUS re-authorization procedures for the purpose of IPv4 address and/or IPv6 prefix allocation (or renew the lease). In this case, the SMF shall set the Service-Type attribute to "Authorize Only" and the 3GPP-Allocate-IP-Type subattribute to the type of IP address to be allocated in the Access-Request message sent to the DN-AAA server. If the SMF is using DHCP signalling towards the UE and the DN-AAA server includes the Session-Timeout attribute in the Access-Accept, the SMF may use the Session-Timeout value as the DHCP lease time. The SMF shall not set the DHCP lease time value higher than the Session-Timeout value. The SMF may renew the DHCP lease to the UE without re-authorization towards the DN-AAA server providing that the new lease expiry is no later than the Session-Timeout timer expiry. If the SMF wishes to extend the lease time beyond the current Session-Timeout expiry, it shall initiate a new AAA re-authorization. + +Even if the SMF was not involved in user authentication, it may send a RADIUS Accounting-Request (START) message to a DN-AAA server. This message may contain parameters, e.g. the tuple which includes the user ID and IPv4 address and/or IPv6 prefix, to be used by application servers (e.g. WAP gateway) in order to identify the user. This message also indicates to the AAA server that the user session has started. The user session is uniquely identified by the Acct-Session-Id that is composed of the Charging ID and the SMF IP address. + +**NOTE:** If the accounting session is required by the DN-AAA server to be created per QoS flow, how to identify the different accounting sessions is implementation specific. The SMF can include the Acct-Session-Id which is extended to include the QFI of the QoS flow or the Acct-Session-Id without QFI extension and with 3GPP-NSAPI combination in the RADIUS Accounting-Request (START). + +If some external applications require RADIUS Accounting-Request (START) information before they can process user packets, then the selected DNN (SMF) may be configured in such a way that the UPF is instructed to drop user data until the Accounting-Response (START) is received from the AAA server. The SMF may wait for the Accounting-Response (START) before sending the final authentication response message in Namf\_Communication\_N1N2MessageTransfer service operation. The SMF may reject the initial access request if the Accounting-Response (START) is not received. The authentication and accounting servers may be separately configured for each DNN. + +For IPv4 PDU type, if IPv4 address is allocated via DHCPv4 signalling between the UE and the DN-AAA after PDU session establishment, the SMF may wait to send the Accounting-Request (START) message until the UE receives its IPv4 address in a DHCPACK. + +When the SMF receives a message indicating a QoS flow or PDU session release request and providing a RADIUS Accounting-Request (START) message was sent previously, the SMF shall send a RADIUS Accounting-Request (STOP) message to the DN-AAA server, which indicates the termination of this particular QoS flow or PDU session. The SMF shall immediately send the corresponding response (e.g. Nsmf\_PDUSession\_UpdateSMContext response) to the AMF, without waiting for an Accounting-Response (STOP) message from the DN-AAA server. + +The DN-AAA server shall deallocate the IPv4 address and/or IPv6 prefix initially allocated to the subscriber, if there is no session for the subscriber. + +Accounting-Request (ON) and Accounting-Request (OFF) messages may be sent from the SMF to the DN-AAA server to ensure the correct synchronization of the session information in the SMF and the DN-AAA server. + +The SMF may send an Accounting-Request (ON) message to the DN-AAA server to indicate that a restart has occurred. The DN-AAA server may then release the associated resources. + +Prior to a scheduled restart, the SMF may send Accounting-Request (OFF) message to the DN-AAA server. The DN-AAA server may then release the associated resources. + +The following figure 11.2.1-1 is an example message flow to show the procedure of RADIUS Authentication and Accounting between an SMF and a DN-AAA server: + +1. UE initiates the PDU Session Establishment procedure, including authentication/authorization information. +2. The AMF sends Nsmf\_PDUSession\_CreateSMContext Request including the authentication/authorization information to the SMF and the SMF responds to the service operation. + + +According to the configuration in the SMF, step 6 to step 9 are executed before step 3 if the SMF needs to send an EAP-Request message to the UE. + +In the case of home routed, the AMF sends Nsmf\_PDUSession\_CreateSMContext Request including the authentication/authorization information to the V-SMF and the V-SMF sends Nsmf\_PDUSession\_Create Request including the authentication/authorization information to the H-SMF. +3. If the N4 session has not been established before, the SMF triggers the N4 Session Establishment procedure to the UPF. + + +In the case of home routed, the V-SMF triggers the N4 Session Establishment procedure to the V-UPF and the H-SMF triggers the N4 Session Establishment procedure to the H-UPF. +4. The SMF sends the Access-Request message to the DN-AAA via the UPF, the message is forwarded from the SMF to the DN-AAA by the UPF in N4 user plane message. + + +In the case of home routed, the H-SMF sends the Access-Request message to the DN-AAA via the H-UPF, the message is forwarded from the H-SMF to the DN-AAA by the H-UPF in N4 user plane message. +- 5-10. The DN-AAA responds with the Access-Challenge message to the SMF via the UPF, the message is forwarded from the DN-AAA to the SMF by the UPF in N4 user plane message. The authentication/authorization information is further transferred to UE via Namf\_Communication\_N1N2MessageTransfer service and NAS SM Transport message. UE responds to the received authentication/authorization data and such information is transferred in NAS SM Transport message and Nsmf\_PDUSession\_UpdateSMContext service, then finally sent to the DN-AAA by the SMF, via the UPF, in the Access-Request message. + + +In the case of home routed, the DN-AAA responds with the Access-Challenge message to the H-SMF via the H-UPF, the message is forwarded from the DN-AAA to the H-SMF by the H-UPF in N4 user plane message. The authentication/authorization information is transferred to V-SMF via Nsmf\_PDUSession\_Update service and is further transferred to UE via Namf\_Communication\_N1N2MessageTransfer service and NAS SM Transport message. UE responds to the received authentication/authorization data and such information is transferred in NAS SM Transport message, Nsmf\_PDUSession\_UpdateSMContext service and Nsmf\_PDUSession\_Update service, then finally sent to the DN-AAA by the H-SMF, via the H-UPF, in the Access-Request message. + +NOTE: Step 5 to step 10 can be repeated depending on the authentication/authorization mechanism used (e.g. EAP-TLS). + +11. The SMF receives the final result of authentication/authorization from the DN-AAA in the Access-Accept message, via the UPF. +12. The SMF requests to start accounting by sending the Accounting-Request (START) message to the DN-AAA via the UPF. +13. The SMF proceeds with the PDU session establishment procedure and includes the authentication/authorization information in Namf\_Communication\_N1N2MessageTransfer service. + +In the case of home routed, the H-SMF proceeds with the PDU session establishment procedure and includes the authentication/authorization information is transferred to V-SMF via Nsmf\_PDUSession\_Update service and is further transferred to the AMF via Namf\_Communication\_N1N2MessageTransfer service. + +14. The DN-AAA responds with the Accounting-Response (START) message. The SMF may wait for the Accounting-Response (START) before sending the Namf\_Communication\_N1N2MessageTransfer request in step 13. + +In the case of home routed, the H-SMF may wait for the Accounting-Response (START) before sending the Nsmf\_PDUSession\_Update service in step 13. + +15. The AMF sends the NAS PDU Session Establishment Request with the authentication/authorization information to the UE. +16. The UE sends a NAS message Deregistration Request to the AMF. +17. The AMF sends Nsmf\_PDUSession\_ReleaseSMContext Request to the SMF and the SMF responds to the service operation. + +In the case of home routed, the AMF sends Nsmf\_PDUSession\_ReleaseSMContext Request to the V-SMF and the V-SMF sends the Nsmf\_PDUSession\_Release Request to the H-SMF. + +- 18-19. The SMF requests to stop accounting by sending the Accounting-Request (STOP) message to the DN-AAA via the UPF and the DN-AAA responds with the Accounting-Response (STOP) message. + +![Sequence diagram showing RADIUS Authentication and Accounting example (successful case) between UE, AMF, SMF, UPF, and DN-AAA.](2ae3eae1bd80a90f192f568ae246a9a6_img.jpg) + +``` + +sequenceDiagram + participant UE + participant AMF + participant SMF + participant UPF + participant DN-AAA + + Note left of UE: 1.NAS PDU Session Establishment Request (Authentication message) + UE->>AMF: 1.NAS PDU Session Establishment Request (Authentication message) + AMF->>SMF: 2.Nsmf_PDUSession_CreateSMContext (Authentication message) + SMF-->>UPF: 3.N4 Session Establishment + SMF->>DN-AAA: 4.Access-Request + DN-AAA-->>SMF: 5.Access-Challenge + SMF->>AMF: 6.Namf_Communication_N1N2MessageTransfer (Authentication message) + AMF->>UE: 7.NAS SM Transport (Authentication message) + UE->>AMF: 8.NAS SM Transport (Authentication message) + AMF->>SMF: 9.Nsmf_PDUSession_UpdateSMContext (Authentication message) + SMF->>DN-AAA: 10.Access-Request + DN-AAA-->>SMF: 11.Access-Accept + SMF->>AMF: 13.Namf_Communication_N1N2MessageTransfer (Authentication message) + AMF->>UE: 15.NAS PDU Session Establishment Accept (Authentication message) + Note right of SMF: User data + SMF->>DN-AAA: 12.Accounting-Request (START) + DN-AAA-->>SMF: 14.Accounting-Response (START) + UE->>AMF: 16.NAS Deregistration Request + AMF->>SMF: 17.Nsmf_PDUSession_ReleaseSMContext + SMF->>DN-AAA: 18.Accounting-Request (STOP) + DN-AAA-->>SMF: 19.Accounting-Response (STOP) + +``` + +Sequence diagram showing RADIUS Authentication and Accounting example (successful case) between UE, AMF, SMF, UPF, and DN-AAA. + +Figure 11.2.1-1: RADIUS Authentication and Accounting example (successful case) + +### 11.2.2 Accounting Update + +During the life of a QoS flow some information related to this QoS flow may change. The SMF may send RADIUS Accounting Request Interim-Update to the DN-AAA server upon occurrence of a chargeable event, e.g. RAT change or QoS change. Interim updates are also used when the IPv4 address and/or IPv6 prefix is allocated/released/re-allocated. + +When the SMF receives a signalling request (i.e. Nsmf\_PDUSession\_UpdateSMContext) that indicates the occurrence of one of these chargeable events, the SMF may send an Accounting Request Interim-Update to the DN-AAA server to update the necessary information related to this QoS flow. It is not necessary for the SMF to wait for the RADIUS AccountingResponse message from the DN-AAA server before sending the response for the triggering signalling message (i.e. Namf\_Communication\_N1N2MessageTransfer). The SMF may delete the QoS flow if the AccountingResponse is not received from the DN-AAA server. + +The SMF may also send interim updates at the expiry of an operator configured time limit. + +Figure 11.2.2-1 is an example message flow to show the procedure of RADIUS accounting update, messages between the SMF and DN-AAA are forwarded by the UPF in N4 user plane message. + +![Sequence diagram for RADIUS accounting update. Lifelines: AMF, SMF, UPF, DN-AAA. The sequence starts with Nsmf_PDUSession_UpdateSMContext between AMF and SMF. Then, SMF sends Accounting-Request (Interim-Update) to DN-AAA via UPF. DN-AAA responds with Accounting-Response (Interim-Update) to SMF via UPF. Finally, SMF sends Namf_Communication_N1N2MessageTransfer to AMF.](9c1d3678db4a12d5864cb2a4def1135d_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant SMF + participant UPF + participant DN-AAA + Note left of AMF: Nsmf_PDUSession_UpdateSMContext + AMF->>SMF: Nsmf_PDUSession_UpdateSMContext + SMF->>DN-AAA: Accounting-Request (Interim-Update) + DN-AAA-->>SMF: Accounting-Response (Interim-Update) + SMF->>AMF: Namf_Communication_N1N2MessageTransfer + +``` + +Sequence diagram for RADIUS accounting update. Lifelines: AMF, SMF, UPF, DN-AAA. The sequence starts with Nsmf\_PDUSession\_UpdateSMContext between AMF and SMF. Then, SMF sends Accounting-Request (Interim-Update) to DN-AAA via UPF. DN-AAA responds with Accounting-Response (Interim-Update) to SMF via UPF. Finally, SMF sends Namf\_Communication\_N1N2MessageTransfer to AMF. + +Figure 11.2.2-1: RADIUS accounting update + +### 11.2.3 DN-AAA initiated QoS flow termination + +RADIUS is used as the protocol between the SMF and the DN-AAA server or proxy for applications (e.g. MMS) to deliver information related to user session. However some IP applications could need to interwork with the SMF to release the corresponding resource (e.g. terminate a particular QoS flow). For this purpose, the DN-AAA server or proxy may send a RADIUS Disconnect-Request to the SMF. On receipt of the Disconnect-Request from the DN-AAA server, the SMF shall release the corresponding resources and reply with a Disconnect-ACK. If the SMF is unable to release the corresponding resources, it shall reply to the DN-AAA server with a Disconnect-NAK. For more information on RADIUS Disconnect, see IETF RFC 5176 [27]. If the SMF deletes the corresponding QoS flow, it is not necessary for the SMF to wait for the response (i.e. Nsmf\_PDUSession\_UpdateSMContext) from the AMF before sending the RADIUS Disconnect-ACK to the DN-AAA server. The DN-AAA shall include the identification of the QoS flow to be disconnected within the Disconnect-Request. How to identify the QoS flow to be deleted is implementation specific. + +NOTE: The QoS flow can be identified by the Acct-Session-Id which is extended to include QFI or by the Acct-Session-Id and 3GPP-NSAPI combination if provided by the SMF. + +The Teardown-Indicator in the RADIUS Disconnect Request message indicates to the SMF that all QoS flows for this particular user and sharing the same user session shall be deleted. The QoS flows that belong to the same PDU session can be identified by the Acct-Session-Id. The SMF is able to find out all the related QoS flows sharing the same user session once it has found the exact QoS flow from the Acct-Session-Id. If a user has the same user IP address for different sets of QoS flows towards different networks, only the QoS flows linked to the one identified by the Acct-Session-Id shall be deleted. If the value of Teardown-Indicator is set to "0" or if TI is missing, and if the Acct-Session-Id and 3GPP-NSAPI if provided identifies the QoS flow associated with the default QoS rule, the SMF shall tear down all the QoS flows that share the same user session identified by the Acct-Session-Id. + +Figure 11.2.3-1 is an example message flow to show the procedure of DN-AAA initiated QoS flow termination, messages between the SMF and DN-AAA are forwarded by the UPF in N4 user plane message. + +![Sequence diagram for DN-AAA initiated QoS flow termination. Lifelines: AMF, SMF, UPF, DN-AAA. The sequence starts with DN-AAA sending a Disconnect Request to SMF via UPF. SMF responds with a Disconnect Response to DN-AAA via UPF. SMF then sends Nsmf_PDUSession_UpdateSMContext to AMF. Finally, SMF sends Namf_Communication_N1N2MessageTransfer to AMF.](7a02de7ed198501f7a4f6ca37c3f28c5_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant SMF + participant UPF + participant DN-AAA + DN-AAA->>SMF: Disconnect Request + SMF-->>DN-AAA: Disconnect Response + SMF->>AMF: Nsmf_PDUSession_UpdateSMContext + SMF->>AMF: Namf_Communication_N1N2MessageTransfer + +``` + +Sequence diagram for DN-AAA initiated QoS flow termination. Lifelines: AMF, SMF, UPF, DN-AAA. The sequence starts with DN-AAA sending a Disconnect Request to SMF via UPF. SMF responds with a Disconnect Response to DN-AAA via UPF. SMF then sends Nsmf\_PDUSession\_UpdateSMContext to AMF. Finally, SMF sends Namf\_Communication\_N1N2MessageTransfer to AMF. + +Figure 11.2.3-1: DN-AAA initiated QoS flow termination with RADIUS + +### 11.2.4 DN-AAA initiated re-authorization + +Some IP applications could need to interwork with the SMF to update the PDU session authorization attributes. For this purpose, the DN-AAA server or proxy may send a RADIUS CoA-Request to the SMF. On receipt of the CoA-Request from the DN-AAA server, if the service-type value of "Authorize Only" is not included, the SMF shall update the corresponding PDU session authorization attributes and reply with a CoA-ACK; otherwise it shall follow the procedure described in IETF RFC 5176 [27]. DN-AAA may also use CoA procedure to revoke the authorization of a PDU session, or to update the authorization data (e.g. allowed UE MAC addresses). + +If the SMF updates/deletes the corresponding PDU session, it is not necessary for the SMF to wait for Nsmf\_PDUSession\_UpdateSMContext from the AMF before sending the RADIUS CoA-ACK to the DN-AAA server. + +Figure 11.2.4-1 is an example message flow to show the procedure of DN-AAA initiated re-authorization, messages between the SMF and DN-AAA are forwarded by the UPF in N4 user plane message. + +![Sequence diagram showing DN-AAA initiated re-authorization with RADIUS. Lifelines: AMF, SMF, UPF, DN-AAA. The sequence starts with a CoA Request from DN-AAA to SMF. The SMF then sends a Nsmf_PDUSession_UpdateSMContext message to the AMF. The AMF responds with a Namf_Communication_N1N2MessageTransfer to the SMF. Finally, the SMF sends a CoA Response back to the DN-AAA.](55136bc716146672fc680fa05989f1d2_img.jpg) + +``` +sequenceDiagram + participant AMF + participant SMF + participant UPF + participant DN-AAA + Note right of DN-AAA: CoA Request + DN-AAA->>SMF: CoA Request + Note right of SMF: Nsmf_PDUSession_UpdateSMContext + SMF->>AMF: Nsmf_PDUSession_UpdateSMContext + Note right of AMF: Namf_Communication_N1N2MessageTransfer + AMF->>SMF: Namf_Communication_N1N2MessageTransfer + Note right of SMF: CoA Response + SMF->>DN-AAA: CoA Response +``` + +Sequence diagram showing DN-AAA initiated re-authorization with RADIUS. Lifelines: AMF, SMF, UPF, DN-AAA. The sequence starts with a CoA Request from DN-AAA to SMF. The SMF then sends a Nsmf\_PDUSession\_UpdateSMContext message to the AMF. The AMF responds with a Namf\_Communication\_N1N2MessageTransfer to the SMF. Finally, the SMF sends a CoA Response back to the DN-AAA. + +Figure 11.2.4-1: DN-AAA initiated re-authorization with RADIUS + +## 11.3 List of RADIUS attributes + +### 11.3.1 General + +RADIUS attributes as defined in subclause 16.4 of 3GPP TS 29.061 [5] are re-used in 5G with the following differences: + +- SMF replaces P-GW. GGSN and PPP PDP type related description are not applicable for 5G. +- 5G QoS flow replaces IP-CAN bearer and PDU session replaces IP-CAN session. +- N6 replaces Gi/Sgi and UE replaces MS. +- DNN replaces APN. +- Detailed information needed for 5G compared to 3GPP TS 29.061 [5] is described below. + +**Table 11.3-1: Additional information needed for 5G compared to the RADIUS attributes defined in 3GPP TS 29.061 [5]** + +| Attr # | Attribute Name | Description | Content | Presence Requirement | Applicable message | +|--------|-----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|---------|----------------------|---------------------------------------------------------------------------------------------------------------------------------| +| 79 | EAP-Message | This attribute encapsulates EAP message (as defined in IETF RFC 3748 [6]) exchanged between the SMF and DN-AAA, see IETF RFC 3579 [7] for details. | String | Conditional NOTE | Access-Request, Access-Accept, Access-Reject, CoA-Request, CoA-ACK, Disconnect-Request, Disconnect-ACK | +| | | | | Mandatory | Access-Challenge | +| 80 | Message-Authenticator | This attribute includes the message authenticator, see IETF RFC 3579 [7] for details. | String | Conditional NOTE | Access-Request, Access-Accept, Access-Reject, CoA-Request, CoA-ACK, CoA-NAK, Disconnect-Request, Disconnect-ACK, Disconnect-NAK | +| | | | | Mandatory | Access-Challenge | + +NOTE: Shall be present if EAP is used. + +**Table 11.3-2: Different information needed for 5G compared to the RADIUS VSA defined in subclause 16.4.7 of 3GPP TS 29.061 [5]** + +| Sub-attr # | Sub-attribute Name | Differences | +|------------------------------------------------------|----------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | 3GPP-IMSI | Re-used. | +| 2 | 3GPP-Charging-Id | Charging ID for this PDU Session. | +| 3 | 3GPP-PDP-Type | Re-used. For SMF, this sub-attribute represents PDU session type and only the values "0", "2", "3", "5" and "6" are applicable. | +| 4 | 3GPP-CG-Address | Re-used. | +| 5 | 3GPP-GPRS-Negotiated-QoS-Profile | Re-used. For SMF, it uses the format for Release indicator value "15" as defined in 3GPP TS 29.061 [5]. | +| 6 | 3GPP-SGSN-Address | Re-used. It includes AMF, I-SMF or V-SMF control plane IPv4 address. | +| 7 | 3GPP-GGSN-Address | Re-used. It includes (home) SMF control plane IPv4 address providing the Nsmf_PDUSession service. | +| 8 | 3GPP-IMSI-MCC-MNC | Re-used. | +| 9 | 3GPP-GGSN-MCC-MNC | Re-used. MCC and MNC of the network the (home) SMF belongs to. | +| 10 | 3GPP-NSAPI | Re-used. It identifies QFI with value range 0-255. | +| 11 | 3GPP-Session-Stop-Indicator | Re-used. | +| 12 | 3GPP-Selection-Mode | Re-used. SMF maps the selection mode value from the enumeration value of DnnSelectionMode in 3GPP TS 29.502 [40]. | +| 13 | 3GPP-Charging-Characteristics | Re-used. | +| 14 | 3GPP-CG-Ipv6-Address | Re-used. | +| 15 | 3GPP-SGSN-Ipv6-Address | Re-used. It includes AMF, I-SMF or V-SMF control plane IPv6 address. | +| 16 | 3GPP-GGSN-Ipv6-Address | Re-used. It includes (home) SMF control plane IPv6 address providing the Nsmf_PDUSession service. | +| 17 | 3GPP-Ipv6-DNS-Servers | Re-used. | +| 18 | 3GPP-SGSN-MCC-MNC | Re-used. MCC and MNC of the network the AMF belongs to | +| 19 | 3GPP-Teardown-Indicator | Re-used. | +| 20 | 3GPP-IMEISV | Re-used. | +| 21 | 3GPP-RAT-Type | Re-used. For SMF, it uses the sub-attribute definition for P-GW and only the values "3", "6" - "9", and "51" - "57" are applicable. | +| 22 | 3GPP-User-Location-Info | Re-used. For SMF, only the values "128", "129", "130", "135" and "136" of Geographic Location Type are applicable. | +| 23 | 3GPP-MS-TimeZone | Re-used. | +| 24 | 3GPP-CAMEL-Charging-Info | Not applicable. | +| 25 | 3GPP-Packet-Filter | Re-used. | +| 26 | 3GPP-Negotiated-DSCP | Re-used. | +| 27 | 3GPP-Allocate-IP-Type | Re-used. | +| 28 | External-Identifier | Re-used. | +| 29 | TWAN-Identifier | Re-used by TWAP Identifier field, supporting ssid, bssid and/or civicAddress. | +| 30 | 3GPP-User-Location-Info-Time | Re-used. | +| 31 | 3GPP-Secondary-RAT-Usage | Re-used. For SMF, the RAT values "0", "1", "2" and "3" are applicable, and the SESS field is used to indicate secondary RAT usage of the PDU session. | +| 110 | 3GPP-Notification | Added. | +| 111 | 3GPP-UE-MAC-Address | Added. | +| 112 | 3GPP-Authorization-Reference | Added. | +| 113 | 3GPP-Policy-Reference | Added. It is not used in this release. | +| 114 | 3GPP-Session-AMBR | Added. | +| 115 | 3GPP-NAI | Added. | +| 116 | 3GPP-Session-AMBR-v2 | Added. | +| 117 | 3GPP-Supported-Features | Added. | +| 118 | 3GPP-IP-Address-Pool-Info | Added. | +| 119 | 3GPP-VLAN-Id | Added. | +| 120 | 3GPP-TNAP-Identifier | Added. | +| 121 | 3GPP-HFC-NodeId | Added. | +| 122 | 3GPP-GLI | Added. | +| 123 | 3GPP-Line-Type | Added. | +| 124 | 3GPP-NID | Added. | +| 129 | 3GPP-GCI | Added. | +| NOTE: 5G specific RADIUS VSAs are numbered from 110. | | | + +#### 110 – 3GPP-Notification + +| Octets | Bits | | | | | | | | +|--------|-----------------|---|---|---|---|---|-----|------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 110 | | | | | | | | +| 2 | 3GPP Length= 3 | | | | | | | | +| 3 | Spare | | | | | | ACC | AUTH | + +3GPP Type: 110 + +Length: 3 + +Octet 3 is Octet String type. + +For bit 1 AUTH, + +- if the value of AUTH is set to "1", and there is IPv4 address and/or IPv6 prefix change (not allocated/de-allocated by the DN-AAA itself) and the PDU session is not terminated, the SMF shall send Access-Request message to the DN-AAA with GPSI in Calling-Station-Id or External-Identifier attribute and IP address in: + - 1) Framed-IP-Address and Framed-Ipv6-Prefix, if both IPv4 address and IPv6 prefix(es) exist for the PDU session; or + - 2) Framed-IP-Address, if only IPv4 address exists for the PDU session; or + - 3) Framed-Ipv6-Prefix, if only IPv6 prefix(es) exists for the PDU session. + +For Ethernet PDU session, if there is UE MAC address change, the SMF shall send Access-Request message to the DN-AAA with GPSI in Calling-Station-Id or External-Identifier attribute and the complete list of used UE MAC addresses in the 3GPP-UE-MAC-Address attribute. + +- if the value is set to "0", the SMF may notify authentication DN-AAA with the UE address and GPSI based on local configuration. + +For bit 2 ACC, + +- if the value is set to "1", and there is IPv4 address and/or IPv6 prefix change (not allocated/de-allocated by the DN-AAA itself) and the PDU session is not terminated, the SMF shall send Accounting-Request Interim-Update message to the DN-AAA with GPSI in Calling-Station-Id or External-Identifier attribute and IP address in: + - 1) Framed-IP-Address and Framed-Ipv6-Prefix, if both IPv4 address and IPv6 prefix(es) exist for the PDU session; or + - 2) Framed-IP-Address, if only IPv4 address exists for the PDU session; or + - 3) Framed-Ipv6-Prefix, if only IPv6 prefix(es) exists for the PDU session. + +For Ethernet PDU session, if there is UE MAC address change, the SMF shall send Accounting-Request Interim-Update message to the DN-AAA with GPSI in Calling-Station-Id or External-Identifier attribute and the complete list of used UE MAC addresses in the 3GPP-UE-MAC-Address attribute. + +- if the value is set to "0", the SMF may notify accounting DN-AAA with the UE address and GPSI based on local configuration. + +#### 111 – 3GPP-UE-MAC-Address + +| Octets | Bits | | | | | | | | +|--------|----------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 111 | | | | | | | | +| 2 | 3GPP Length= 8 | | | | | | | | +| 3-8 | MAC Address (octet string) | | | | | | | | + +3GPP Type: 111 + +Length: 8 + +It is sent from the DN-AAA to authorize UE MAC addresses. Multiple 3GPP-MAC-Address sub-attributes (maximum 16) may be sent in one RADIUS CoA or Access-Accept message. The DN-AAA shall always provide the full list of allowed MAC addresses, and SMF shall replace the existing list with the newly received one. When omitted, there is no restriction and all UE MAC addresses are permitted for the Ethernet PDU session. + +When sending from the SMF to the DN-AAA, it indicates UE MAC addresses in use. Multiple 3GPP-MAC-Address sub-attributes may be sent in one RADIUS Access-Request or Accounting-Request Interim-Update message. + +MAC address is Octet String type. The encoding is defined as MacAddr48 in 3GPP TS 29.571 [39] without dashes as delimiter, encoded as 12-digit hexadecimal numbers. + +#### ***112 – 3GPP-Authorization-Reference*** + +| Octets | Bits | | | | | | | | +|--------|---------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 112 | | | | | | | | +| 2 | 3GPP Length= m | | | | | | | | +| 3-m | Authorization Data Reference (octet string) | | | | | | | | + +3GPP Type: 112 + +Length: m + +Authorization Data Reference: Octet String. It is sent from the DN-AAA to refer to the local authorization data in the SMF or PCF. + +#### ***113 – 3GPP-Policy-Reference*** + +| Octets | Bits | | | | | | | | +|--------|--------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 113 | | | | | | | | +| 2 | 3GPP Length= m | | | | | | | | +| 3-m | Policy Data Reference (octet string) | | | | | | | | + +3GPP Type: 113 + +Length: m + +Policy Data Reference: Octet String. It is sent from the DN-AAA and used by the SMF to retrieve the SM or QoS policy data from the PCF. It is not used in this release. + +#### ***114 – 3GPP-Session-AMBR*** + +| Octets | Bits | | | | | | | | +|--------|-----------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 114 | | | | | | | | +| 2 | 3GPP Length= m | | | | | | | | +| 3-m | Session AMBR (octet string) | | | | | | | | + +3GPP Type: 114 + +Length: m + +Session AMBR: Octet String. It is sent from the DN-AAA to authorize the PDU Session AMBR in the downlink and uplink direction. The encoding is defined as BitRate in 3GPP TS 29.571 [39]. Same value is applied to downlink and uplink via this VSA. + +#### 115 – 3GPP-NAI + +| Octets | Bits | | | | | | | | +|--------|--------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 115 | | | | | | | | +| 2 | 3GPP Length= m | | | | | | | | +| 3-m | NAI (octet string) | | | | | | | | + +3GPP Type: 115 + +Length: m + +NAI: Octet String. It shall be formatted according to subclause 14.3 of 3GPP TS 23.003 [28] that describes an NAI. + +#### 116 – 3GPP-Session-AMBR-v2 + +| Octets | Bits | | | | | | | | +|-------------|---------------------------------------|---|---|---|---|---|----|----| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 116 | | | | | | | | +| 2 | 3GPP Length= m | | | | | | | | +| 3 | Spare | | | | | | DL | UL | +| 4-5 | UL Session-AMBR length (octet string) | | | | | | | | +| 6-m | UL Session-AMBR (octet string) | | | | | | | | +| (m+1)-(m+2) | DL Session-AMBR length (octet string) | | | | | | | | +| (m+3)-n | DL Session-AMBR (octet string) | | | | | | | | + +3GPP Type: 116 + +Length: m + +Octet 3 is Octet String type. + +Bit 1 UL and bit 2 DL indicate if the corresponding UL and DL Session-AMBR shall be present in a respective field or not. If one of these bits is set to "0", the corresponding field shall not be present at all. + +UL/DL Session AMBR: Octet String. It is sent from the DN-AAA to authorize the PDU Session AMBR. The encoding is defined as BitRate in 3GPP TS 29.571 [39]. + +If the feature eSessionAMBR is supported and if applicable, the DN-AAA shall send this VSA; otherwise, the DN-AAA shall send the VSA 3GPP-Session-AMBR. + +#### 117 – 3GPP-Supported-Features + +| Octets | Bits | | | | | | | | +|--------|--------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 117 | | | | | | | | +| 2 | 3GPP Length= m | | | | | | | | +| 3-6 | Vendor ID (octet string) | | | | | | | | +| 7-10 | Feature List ID (octet string) | | | | | | | | +| 11-14 | Feature List (octet string) | | | | | | | | + +3GPP Type: 117 + +Length: m + +This VSA may be present in the Access-Request (initial one) message and either the Access-Challenge (initial one) or the Access-Accept message. If present, this VSA informs the destination entity about the features that the origin entity requires to successfully complete the message exchange. The Vendor ID, Feature List ID and Feature List are encoded according to 3GPP TS 29.229 [41]. See clause 12.4.1 for more detailed information regarding the general principle of the feature negotiation with the difference that RADIUS terms replace Diameter terms. The table 12.4.1-1 defines the features applicable to the RADIUS N6 interfaces for the feature lists with a Feature-List-ID of 1. + +#### 118 – 3GPP-IP-Address-Pool-Info + +| Octets | Bits | | | | | | | | +|--------|------------------------------------------|---|---|---|---|---|------------|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 118 | | | | | | | | +| 2 | 3GPP Length= m | | | | | | | | +| 3 | Spare | | | | | | IP version | | +| 4-5 | IP address pool id length (octet string) | | | | | | | | +| 6-m | IP address pool id (octet string) | | | | | | | | + +3GPP Type: 118 + +Length: m + +Octet 3 is Octet String type. + +For bit 1 and bit 2 IP version:- if the value is set to "0", it indicates the IP address pool id is applicable for both IPv4 and IPv6; + +- if the value is set to "1", it indicates the IP address pool id is applicable for IPv4; +- if the value is set to "2", it indicates the IP address pool id is applicable for IPv6; and +- value "3" is reserved. + +The SMF may determine an IP address pool ID based on UPF ID, S-NSSAI, DNN, and IP version as described in subclause 5.8.2.2.1 in 3GPP TS 23.501 [2] and includes the IP address pool ID within 3GPP-IP-Address-Pool-Info and send it to the DN-AAA. The DN-AAA assigns IPv6 prefix or IPv4 address from the requested IP address pool. Multiple 3GPP-IP-Address-Pool-Info sub-attributes may be sent in the RADIUS Access-Request message. The DN-AAA shall include the selected IP address pool in the 3GPP-IP-Address-Pool-Info sub-attribute of the RADIUS Access-Accept message. For accounting, if Framed-IP-Address or Framed-Ipv6-Prefix attribute is included in RADIUS Accounting-Request (START/Interim-Update/STOP), the SMF shall also include the 3GPP-IP-Address-Pool-Info sub-attribute. + +#### 119 – 3GPP-VLAN-Id + +| Octets | Bits | | | | | | | | +|--------|-----------------|---|---|---|-------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 119 | | | | | | | | +| 2 | 3GPP Length= 4 | | | | | | | | +| 3 | VID value | | | | Spare | | | | +| 4 | VID value | | | | | | | | + +3GPP Type: 119 + +Length: 4 + +VLAN Id: Octet String. Octet 3/ Bit 1 to Bit 4 shall be zero, Octet 3 / Bit 8 shall be the most significant bit of the VLAN Id and Octet 4 / Bit 1 shall be the least significant bit. + +It is sent from the DN-AAA to authorize the allowed VLAN Ids for the Ethernet PDU session. Multiple 3GPP-VLAN-Id sub-attributes (maximum 16) may be sent in one RADIUS CoA or Access-Accept message. The DN-AAA shall always provide the full list of allowed VLAN Ids, and SMF shall replace the existing list with the newly received one. When omitted, there is no restriction and all VLAN Ids are permitted for the Ethernet PDU session. + +#### **120 – 3GPP-TNAP-Identifier** + +| Octets | Bits | | | | | | | | +|--------|--------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 120 | | | | | | | | +| 2 | 3GPP Length= m | | | | | | | | +| 3-m | TNAP Identifier (octet string) | | | | | | | | + +3GPP Type: 120 + +Length=m, where m depends on the type of location that is present as described in 3GPP TS 29.274 [50]. + +TNAP Identifier field is used to convey the location information in a Trusted Non-3GPP Access Network. The coding of this field shall be the same as for the GTP TWAN Identifier starting with Octet 5, till Octet (q+r) +2 as per clause 8.100 in 3GPP TS 29.274 [50], with LAII flag, OPNAI flag and PLMNI flag in Octet 5 shall be set as zero. + +TNAP Identifier field is Octet String type. + +The SMF may indicate the UE location in a Trusted Non-3GPP Access Network, in Access-Request, Accounting-Request START, Accounting-Request STOP, or Accounting-Request Interim-Update messages. + +#### **121 – 3GPP-HFC-NodeId** + +| Octets | Bits | | | | | | | | +|--------|--------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 121 | | | | | | | | +| 2 | 3GPP Length= n | | | | | | | | +| 3-n | HFCNodeId (octet string) | | | | | | | | + +3GPP Type: 121 + +Length: $n \leq 6+2$ + +HFCNodeId field is the identifier of the HFC node Id as specified in CableLabs WR-TR-5WWC-ARCH [51]. It is provisioned by the wireline operator as part of wireline operations and may contain up to six characters. + +HFCNodeId field is Octet String type. + +The SMF may indicate the HFC Node Identifier received over NGAP. Present for a 5G-CRG accessing the 5GC via wireline access network, in Access-Request, Accounting-Request START, Accounting-Request STOP, or Accounting-Request Interim-Update messages. Present for a FN-CRG accessing the 5GC via wireline access network, in Accounting-Request START, Accounting-Request STOP, or Accounting-Request Interim-Update messages. + +#### **122 – 3GPP-GLI** + +| Octets | Bits | | | | | | | | +|--------|--------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 122 | | | | | | | | +| 2 | 3GPP Length= n | | | | | | | | +| 3-n | GLI (octet string) | | | | | | | | + +3GPP Type: 122 + +Length: $n \leq 150+2$ + +GLI field is the Global Line Identifier uniquely identifying the line connecting the 5G-BRG or FN-BRG to the 5GS. See clause 28.16.3 of 3GPP TS 23.003 [28]. Shall be encoded as a string with format "byte", i.e. base64-encoded characters, representing the GLI value (up to 150 bytes) encoded as specified in BBF WT-470 [52]. + +GLI field is Octet String type. + +The SMF may indicate the Global Line Identifier. Present for a 5G-BRG accessing the 5GC via wireline access network, in Access-Request, Accounting-Request START, Accounting-Request STOP, or Accounting-Request Interim-Update messages. Present for a FN-BRG accessing the 5GC via wireline access network, in Accounting-Request START, Accounting-Request STOP, or Accounting-Request Interim-Update messages. + +#### 123 – 3GPP-Line-Type + +| Octets | Bits | | | | | | | | +|--------|--------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 123 | | | | | | | | +| 2 | 3GPP Length= 3 | | | | | | | | +| 3 | Line-Type (octet string) | | | | | | | | + +3GPP Type: 123 + +The Line-Type sub-attribute may be present for a 5G-BRG/FN-BRG accessing the 5GC via wireline access network. + +When present, it shall indicate the type of the wireline (DSL or PON). + +Line-Type field is Octet String type. It shall be coded as follows: + +0 (DSL): + +This value shall be used to indicate DSL line. + +1 (PON): + +This value shall be used to indicate PON line. + +The SMF may indicate the type of the wireline (DSL or PON). Present for a 5G-BRG accessing the 5GC via wireline access network, in Access-Request, Accounting-Request START, Accounting-Request STOP, or Accounting-Request Interim-Update messages. Present for a FN-BRG accessing the 5GC via wireline access network, in Accounting-Request START, Accounting-Request STOP, or Accounting-Request Interim-Update messages. + +#### 124 – 3GPP-NID + +| Octets | Bits | | | | | | | | +|--------|---------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 124 | | | | | | | | +| 2 | 3GPP Length= 13 | | | | | | | | +| 3-13 | Network ID (octet string) | | | | | | | | + +3GPP Type: 124 + +Length: 13 + +The Network ID field is Octet String type. The encoding is defined as Nid in 3GPP TS 29.571 [39]. + +Table 11.3-3 describes the sub-attributes of the 3GPP Vendor-Specific attribute described above in different RADIUS messages. + +#### 129 – 3GPP-GCI + +| Octets | Bits | | | | | | | | +|--------|--------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 129 | | | | | | | | +| 2 | 3GPP Length= m | | | | | | | | +| 3-m | GCI (octet string) | | | | | | | | + +3GPP Type: 129 + +Length: m + +GCI field is Octet String type. + +The GCI is the Global Cable Identifier uniquely identifies the line connecting the 5G-CRG or FN-CRG to the 5GS. See clause 28.15.4 of 3GPP TS 23.003 [28]. + +The GCI is a variable length opaque identifier, shall be encoded as specified in CableLabs WR-TR-5WWC-ARCH [51] and CableLabs DOCSIS MULPI [53]. It shall comply with the syntax specified in clause 2.2 of IETF RFC 7542 [54] for the username part of a NAI. + +The SMF may indicate the Global Cable Identifier. Present for a 5G-CRG accessing the 5GC via wireline access network, in Access-Request, Accounting-Request START, Accounting-Request STOP, or Accounting-Request Interim-Update messages. Present for a FN-CRG accessing the 5GC via wireline access network, in Accounting-Request START, Accounting-Request STOP, or Accounting-Request Interim-Update messages. + +**Table 11.3-3: List of the 3GPP Vendor-Specific sub-attributes for N6** + +| Sub-attr # | Sub-attribute Name | Description | Presence Requirement | Associated attribute (Location of Sub-attr) | Applicability | +|------------|------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------|----------------------|------------------------------------------------------------------------------------------------------|---------------| +| 110 | 3GPP-Notification | It includes all notifications that the DN-AAA wants to receive from the SMF. | Optional | Access-Accept | | +| 111 | 3GPP-UE-MAC-Address | It is sent from the DN-AAA to authorize UE MAC addresses, or it indicates UE MAC addresses in use when sending from the SMF to the DN-AAA. | Optional | Access-Request, Access-Response, Accounting-Request Interim-Update, Change-of-Authorization | | +| 112 | 3GPP-Authorization-Reference | It is sent from the DN-AAA to refer to the local authorization data in the SMF. | Optional | Access-Accept, Change-of-Authorization | | +| 113 | 3GPP-Policy-Reference | It is sent from the DN-AAA and used by the SMF to retrieve the SM or QoS policy data from the PCF. It is not used in this release. | Optional | Access-Accept, Change-of-Authorization | | +| 114 | 3GPP-Session-AMBR | It is sent from the DN-AAA to authorize the PDU Session AMBR in the downlink and uplink. | Optional | Access-Accept, Change-of-Authorization | | +| 115 | 3GPP-NAI | The Network Access Identifier identifying the UE. | Optional | Access-Request, Accounting-Request START, Accounting-Request STOP, Accounting-Request Interim-Update | | +| 116 | 3GPP-Session-AMBR-v2 | It is sent from the DN-AAA to authorize the | Optional | Access-Accept, | eSession AMBR | + +| Sub-attr # | Sub-attribute Name | Description | Presence Requirement | Associated attribute (Location of Sub-attr) | Applicability | +|------------|---------------------------|---------------------------------------------------------------------------------------------------------------------------------|----------------------|---------------------------------------------------------------------------------------------------------------------|---------------| +| | | PDU Session AMBR, it includes separate session AMBR for UL and DL. | | Change-of-Authorization | | +| 117 | 3GPP-Supported-Features | It indicates the supported features as specified in clause 12.4.1. | Optional | Access-Request, Access-Accept, Access-Challenge, Accounting-Request START, Accounting-Response START | | +| 118 | 3GPP-IP-Address-Pool-Info | It indicates the IP address pool identifier. | Optional | Access-Request, Access-Accept, Accounting-Request START, Accounting-Request STOP, Accounting-Request Interim-Update | | +| 119 | 3GPP-VLAN-Id | It is sent from the DN-AAA to authorize the allowed VLAN Id for the Ethernet PDU session. | Optional | Access-Accept, Change-of-Authorization | | +| 120 | 3GPP-TNAP-Identifier | Indicates the UE location in a Trusted Non-3GPP Access Network. | Optional | Access-Request, Accounting-Request START, Accounting-Request STOP, Accounting-Request Interim-Update | | +| 121 | 3GPP-HFC-NodeId | Indicates the HFC Node Identifier received over NGAP. Present for a 5G-CRG/FN-CRG accessing the 5GC via wireline access network | Optional | Access-Request (NOTE), Accounting-Request START, Accounting-Request STOP, Accounting-Request Interim-Update | | +| 122 | 3GPP-GLI | Indicates the Global Line Identifier. Present for a 5G-BRG/FN-BRG accessing the 5GC via wireline access network. | Optional | Access-Request (NOTE), Accounting-Request START, Accounting-Request STOP, Accounting-Request Interim-Update | | +| 123 | 3GPP-Line-Type | Indicates the type of the wireline (DLS or PON). Present for a 5G-BRG/FN-BRG accessing the 5GC via wireline access network. | Optional | Access-Request (NOTE), Accounting-Request START, Accounting-Request STOP, Accounting-Request Interim-Update | | +| 124 | 3GPP-NID | Indicate the network identifier. It shall only be present together with 3GPP-SGSN-MCC-MNC to identify an SNPN. | Optional | Access-Request, Accounting-Request START, Accounting-Request STOP, Accounting-Request Interim-Update | | +| 129 | 3GPP-GCI | Indicates the line connecting the 5G- | Optional | Access-Request (NOTE), | | + +| Sub-attr # | Sub-attribute Name | Description | Presence Requirement | Associated attribute (Location of Sub-attr) | Applicability | +|--------------------------------------------------------------|--------------------|--------------------------|----------------------|--------------------------------------------------------------------------------------------|---------------| +| | | CRG or FN-CRG to the 5GS | | Accounting-Request START,
Accounting-Request STOP,
Accounting-Request Interim-Update | | +| NOTE: Access-Request is not applicable for FN-CRG or FN-BRG. | | | | | | + +RADIUS attributes related to the DN-AAA initiated re-authorization and authentication challenge are described in the following subclauses. + +### 11.3.2 Change-of-Authorization Request (optionally sent from DN-AAA server to SMF) + +Table 11.3.2-1 describes the attributes of the Change-of-Authorization Request message. Other RADIUS attributes may be used as defined in IETF RFC 5176 [27]. + +**Table 11.3.2-1: The attributes of the Change-of-Authorization Request message** + +| Attr # | Attribute Name | Description | Content | Presence Requirement | +|--------------|-----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------|---------------------------------| +| 1 | User-Name | Username provided by the user (extracted from the PCO field received during PDN connection establishment). If no username is available a generic username, configurable on a per DNN basis, shall be present. If the User-Name has been sent in the Access-Accept message, this username shall be used in preference to the above | String | Optional | +| 6 | Service-Type | Indicates the type of service for this user. | 17 (Authorize Only) | Optional | +| 8 | Framed-IP-Address | User IPv4 address | Ipv4 | Conditional
NOTE 2 | +| 10 | 3GPP-NSAPI | identifies QFI with value range 0-255 in this user session. | UTF-8 encoded character | Optional | +| 30 | Called-Station-Id | Identifier for the target network | DNN (UTF-8 encoded characters) | Optional | +| 31 | Calling-Station-Id | This attribute is the identifier for the UE, and it shall be configurable on a per DNN basis. | MSISDN in international format according to 3GPP TS 23.003 [28], UTF-8 encoded decimal character. (NOTE 5) | Optional | +| 96 | Framed-Interface-Id | User IPv6 Interface Identifier | Ipv6 | Conditional
NOTE 1
NOTE 2 | +| 44 | Acct-Session-Id | User session identifier. | SMF IP address (IPv4 or IPv6) and Charging-ID concatenated in a UTF-8 encoded hexadecimal characters. (NOTE 6) | Mandatory | +| 79 | EAP-Message | This attribute encapsulates EAP message (as defined in IETF RFC 3748 [6]) exchanged between the SMF and DN-AAA, see IETF RFC 3579 [7] for details. | String | Conditional
NOTE 3 | +| 80 | Message-Authenticator | This attribute includes the message authenticator, see IETF RFC 3579 [7] for details. | String | Conditional
NOTE 3 | +| 97 | Framed-Ipv6-Prefix | User IPv6 prefix | Ipv6 | Conditional
NOTE 2 | +| 123 | Delegated-IPv6-Prefix | Delegated IPv6 prefix to the user. | Ipv6 | Conditional
NOTE 4 | +| 26/10
415 | 3GPP Vendor-Specific | Sub-attributes according clause 11.3, the encoding of this attribute is specified in 3GPP TS 29.061 [5]. | See clause 11.3 | Optional | + +NOTE 1: Included if the prefix alone is not unique for the user. This may be the case, for example, if a static IPv6 address is assigned. + +NOTE 2: If the 3GPP-PDP-Type is IPv4, IPv6, or IPv4v6, either IPv4 or IPv6 address/prefix attribute shall be present. The IP protocol version for end-user and network may be different. + +NOTE 3: Shall be present if EAP is used. + +NOTE 4: The delegated IPv6 prefix shall be present if IPv6 prefix delegation is required from the external DN-AAA server. + +NOTE 5: There are no leading characters in front of the country code. + +NOTE 6: If the accounting session is created per QoS flow, Acct-Session-Id may be extended to include the QFI of the QoS flow. + +### 11.3.3 Access-Challenge (sent from DN-AAA server to SMF) + +Table 11.3.3-1 describes the attributes of the Access-Challenge Request message. Other RADIUS attributes may be used as defined in IETF RFC 2865 [8]. + +**Table 11.3.3-1: The attributes of the Access-Challenge message** + +| Attr # | Attribute Name | Description | Content | Presence Requirement | +|--------|-----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|----------------------| +| 27 | Session-Timeout | Indicates the timeout value (in seconds) for the user session | 32 bit unsigned Integer | Optional | +| 79 | EAP-Message | This attribute encapsulates EAP message (as defined in IETF RFC 3748 [6]) exchanged between the SMF and DN-AAA, see IETF RFC 3579 [7] for details. | String | Mandatory | +| 80 | Message-Authenticator | This attribute includes the message authenticator, see IETF RFC 3579 [7] for details. | String | Mandatory | + +NOTE: Included if the prefix alone is not unique for the user. This may be the case, for example, if a static IPv6 address is assigned. + +# 12 Interworking with DN-AAA (Diameter) + +## 12.1 Diameter Procedures + +### 12.1.1 Diameter Authentication and Authorization + +The SMF also represents the H-SMF in the home routed scenario in this subclause unless specified otherwise. + +Diameter Authentication and Authorization shall be used according to IETF RFC 7155 [23]. In 5G, multiple authentication methods using Extensible Authentication Protocol (EAP) may be used such as EAP-TLS (see IETF RFC 5216 [11]), EAP-TTLS (see IETF RFC 5281 [37]). The SMF shall support Diameter EAP application as specified in IETF RFC 4072 [25]. + +The SMF and the DN-AAA shall advertise the support of the Diameter NASREQ and EAP applications by including the value (1 and 5) of the application identifier in the Auth-Application-Id AVP (as specified in IETF RFC 4072 [25]) and the value of the 3GPP (10415) in the Vendor-Id AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands as specified in IETF RFC 6733 [24], i.e. as part of the Vendor-Specific-Application-Id AVP. + +The Diameter client function may reside in an SMF. When the SMF receives an initial access request (i.e. the SMF receives the Nsmf\_PDUSession\_CreateSMContext request with type "Initial request" for non-roaming case or local breakout case, or the H-SMF receives the Nsmf\_PDUSession\_Create Request with type "Initial request" for home routed case), the Diameter client function may send the authentication information to a DN-AAA server, which is identified during the DNN provisioning. + +The DN-AAA server performs authentication and authorization. The response (when positive) may contain network information, such as an IPv4 address and/or IPv6 prefix for the user when the SMF is interworking with the DN-AAA server. + +The information delivered during the Diameter authentication can be used to automatically correlate the user identity (e.g. SUPI) to the IPv4 address and/or IPv6 prefix, if applicable, assigned/confirmed by the SMF or the DN-AAA server respectively. The same procedure applies, in case of sending the authentication to a 'proxy' DN-AAA server. + +For 5G, Diameter Authentication is applicable to the initial access request. When the SMF receives a positive response from the DN-AAA server it shall complete the initial access procedure. If Access-Reject or no response is received, the SMF shall reject the initial access procedure with a suitable cause code. + +When DN-AAA server authorizes the PDU Session Establishment, it may send DN authorization data for the established PDU Session to the SMF. The DN authorization data for the established PDU Session may include one or more of the following: + +- a reference to authorization data for policy and charging control locally configured in the SMF; + +- a list of allowed MAC addresses (maximum 16) for the Ethernet PDU Session; +- a list of allowed VLAN Ids (maximum 16) for the Ethernet PDU Session; and +- Session-AMBR for the PDU Session. + +SMF policies may require DN authorization without DN authentication. In that case, when contacting the DN-AAA server for authorization, the SMF shall provide the GPSI of the UE if available. + +The SMF may also use the Diameter re-authorization procedure for the purpose of IPv4 address and/or IPv6 prefix allocation to the UE. The use cases that may lead this procedure are: + +- IPv4 address and/or IPv6 prefix allocation after UPF selection during PDU session establishment procedure. +- IPv6 prefix allocation during adding additional PDU Session Anchor procedure for IPv6 multi-homing. +- IPv4 address allocation via DHCPv4 procedure after successful PDU session establishment procedure. + +The SMF may also trigger request for DN authentication/authorization and/or IP address/prefix allocation based on UE subscription data retrieve from the UDM as defined in subclause 5.2.2.2.5 of 3GPP TS 29.503. + +When an IPv4 address and/or IPv6 prefix (including any additional IPv6 prefix of IPv6 multi-homing) is (re-)allocated or de-allocated (not causing the PDU session to be released) by using a method not via the DN-AAA server and if the SMF was required by the DN-AAA server to report such change during authentication procedure or by local configuration, the SMF shall, if applicable, use the authentication session that was established before to inform the DN-AAA server by sending Diameter DER or AAR with the latest list of IPv4 address and/or IPv6 prefix(es). + +When the SMF is notified by the UPF regarding the UE MAC address change (a new one is detected or a used one is inactive), if the SMF was required by the DN-AAA server to report such change during authentication procedure or by local configuration, the SMF shall, if applicable, use the authentication session that was established before to inform the DN-AAA server by sending Diameter DER or AAR with the latest list of UE MAC addresses in use. + +DN-AAA may initiate QoS flow termination, see details in clause 12.2.3. DN-AAA may initiate re-authorization and optional re-authentication, see details in clause 12.2.4 and 12.2.5. + +For the 5GS interworking with EPS scenario, EAP based secondary authentication and re-authentication is not applicable to the PDN connection when the UE is in EPS in this release. Secondary authorization (without authentication of the UE) with a DN-AAA server is supported when the UE is in EPS. + +In case EAP based authentication and authorization has been performed for the PDU Session while the UE was in 5GS, and if SMF+PGW-C determines that the UE has moved to the EPS (i.e. the SMF+PGW-C receives the modify bearer request or create session request from the S-GW), how to handle the following procedure is implementation specific. + +NOTE: The SMF+PGW-C can initiate Diameter re-authorization procedure without re-authentication with the DN-AAA server based on local policy. The DN-AAA server decides the actions to take (e.g. to request another re-authorization without the association with EAP based re-authentication or release the session) is out of 3GPP scope. + +### 12.1.2 Diameter Accounting + +Diameter Accounting shall be used according to IETF RFC 7155 [23]. + +The SMF and the DN-AAA may advertise the support of the Diameter base accounting application by including the value (3) of the application identifier in the Acct-Application-Id AVP and the value of the 3GPP (10415) in the Vendor-Id AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands as specified in IETF RFC 6733 [24], i.e. as part of the Vendor-Specific-Application-Id AVP. + +The Diameter accounting client function may reside in an SMF. The Diameter accounting client may send information to a DN-AAA server, which is identified during the DNN provisioning. The DN-AAA server may store this information and use it to automatically identify the user. This information can be trusted because the 3GPP network has authenticated the subscriber (i.e. USIM card and possibly other authentication methods). + +The SMF may use the Diameter Accounting messages during QoS flow (e.g. QoS flow associated with the default QoS rule) establishment and termination procedures, respectively. + +If the DN-AAA server is used for IPv4 address and/or IPv6 prefix assignment, then, upon reception of a Diameter Accounting-Request STOP message for all QoS flows associated to a PDU session defined by DNN and SUPI or GPSI, the DN-AAA server may make the associated IPv4 address and/or IPv6 prefix available for assignment. + +When an IPv4 address and/or IPv6 prefix (including any additional IPv6 prefix of IPv6 multi-homing) is (re-)allocated or de-allocated (not causing the PDU session to be released) by using a method not via the DN-AAA server and if the SMF was required by the DN-AAA server to report such change during authentication procedure or by local configuration, the SMF shall, if applicable, use the accounting session that was established before to inform the DN-AAA server by sending Diameter Accounting-Request Interim-Update with the latest list of IPv4 address and/or IPv6 prefix(es). + +When the SMF is notified by the UPF regarding the UE MAC address change (a new one is detected or a used one is inactive), if the SMF was required by the DN-AAA server to report such change during authentication procedure or by local configuration, the SMF shall, if applicable, use the accounting session that was established before to inform the DN-AAA server by sending Diameter Accounting-Request Interim-Update with the latest list of UE MAC addresses in use. + +## 12.2 Message flows on N6 interface + +### 12.2.1 Authentication, Authorization and Accounting procedures + +The SMF also represents the H-SMF in the home routed scenario in this subclause unless specified otherwise. + +When an SMF receives an initial access request (i.e. the SMF receives the Nsmf\_PDUSession\_CreateSMContext request with type "Initial request" for non-roaming case or local breakout case, or the H-SMF receives the Nsmf\_PDUSession\_Create Request with type "Initial request" for home routed case) message for a given DNN, the SMF may (depending on the configuration for this DNN) send a Diameter DER message to a DN-AAA server. Upon receipt of the DER message, the DN-AAA server shall respond with an DEA message. Multi-round authentication using the DEA and DER messages may be used. The DN-AAA server finally authenticates and authorizes the user by replying with the DEA message. If the DN-AAA server is also responsible for IPv4 address and/or IPv6 prefix allocation, the DN-AAA server shall return the allocated IPv4 address and/or IPv6 prefix in the DEA message. + +For re-authentication and re-authorization, the SMF shall send a DER message to the DN-AAA server and the DN-AAA server shall respond with a DEA message. Multi-round authentication using the DEA and DER messages may be used. The DN-AAA server finally authenticates and authorizes the user by replying with the DEA message. + +The SMF may initiate Diameter re-authorization procedures for the purpose of IPv4 address and/or IPv6 prefix allocation (or renew the lease). In this case, the SMF shall set the Session-Id to the value used in the initial request, the Auth-Request-Type AVP to "AUTHORIZE\_ONLY" and the 3GPP-Allocate-IP-Type AVP to the type of IP address to be allocated in the AA-Request message sent to the AAA server. If the SMF is using DHCP signalling towards the UE and the DN-AAA server includes the Session-Timeout attribute in the Access-Accept, the SMF may use the Session-Timeout value as the DHCP lease time. The SMF shall not set the DHCPv4 lease time value higher than the Session-Timeout value. The SMF may renew the DHCP lease to the UE without re-authorization towards the DN-AAA server providing that the new lease expiry is no later than the Session-Timeout timer expiry. If the SMF wishes to extend the lease time beyond the current Session-Timeout expiry, it shall initiate a new AAA re-authorization. + +Even if the SMF was not involved in user authentication, it may send a Diameter Accounting-Request (START) message to a DN-AAA server. If no Diameter session is already open for the same PDU session a Diameter session needs to be activated, otherwise the existing Diameter session is used to send the Accounting-Request (START). If accounting is used per QoS flow, the QFI will identify the particular bearer this accounting message refers to. This message contains parameters, e.g. the tuple which includes the user ID and IPv4 address and/or IPv6 prefix, to be used by application servers (e.g. WAP gateway) in order to identify the user. This message also indicates to the DN-AAA server that the user session has started. + +If some external applications require Diameter Accounting-Request (START) information before they can process user packets, then the selected DNN (SMF) may be configured in such a way that the SMF drops user data until an Accounting-Answer (START) indicating success is received from the DN-AAA server. The SMF may wait for the Accounting-Answer (START) before sending the final authentication response message in Namf\_Communication\_N1N2MessageTransfer service operation. The SMF may reject the initial access request if the Accounting-Answer (START) is not received. The authentication and accounting servers may be separately configured for each DNN. + +For IPv4 PDU type, if IPv4 address is allocated via DHCPv4 signalling between the UE and the DN-AAA after PDU session establishment, the SMF may wait to send the Accounting-Request START message until the UE receives its IPv4 address in a DHCPACK. + +When the SMF receives a message indicating a QoS flow or PDU session release request and providing a Diameter Accounting-Request START message was sent previously, the SMF shall send a Diameter Accounting-Request (STOP) message to the DN-AAA server, which indicates the termination of this particular QoS flow or PDU session. The SMF shall immediately send the corresponding response (e.g. Nsmf\_PDUSession\_UpdateSMContext response) to the AMF, without waiting for an Accounting-Answer (STOP) message from the DN-AAA server. + +If the last QoS flow of a PDU session is deactivated, the SMF shall additionally send an STR message to the DN-AAA server. The DN-AAA server shall reply with an STA message and shall deallocate the IPv4 address and/or IPv6 prefix initially allocated to the subscriber. + +The following figure 12.2.1-1 is an example message flow to show the procedure of Diameter Authentication and Accounting between an SMF and a DN-AAA server: + +1. UE initiates the PDU Session Establishment procedure, including authentication/authorization information. +2. The AMF sends Nsmf\_PDUSession\_CreateSMContext Request including the authentication/authorization information to the SMF and the SMF responds to the service operation. + +According to the configuration in the SMF, step 6 to step 9 are executed before step 3 if the SMF needs to send an EAP-Request message to the UE. + +In the case of home routed, the AMF sends Nsmf\_PDUSession\_CreateSMContext Request including the authentication/authorization information to the V-SMF and the V-SMF sends Nsmf\_PDUSession\_Create Request including the authentication/authorization information to the H-SMF. + +3. If the N4 session has not been established before, the SMF triggers the N4 Session Establishment procedure to the UPF. + +In the case of home routed, the V-SMF triggers the N4 Session Establishment procedure to the V-UPF and the H-SMF triggers the N4 Session Establishment procedure to the H-UPF. + +4. The SMF sends the DER message to the DN-AAA via the UPF, the message is forwarded from the SMF to the DN-AAA by the UPF in N4 user plane message. + +In the case of home routed, the H-SMF sends the Access-Request message to the DN-AAA via the H-UPF, the message is forwarded from the H-SMF to the DN-AAA by the H-UPF in N4 user plane message. + +- 5-10. The DN-AAA responds with the DEA message to the SMF via the UPF, the message is forwarded from the DN-AAA to the SMF by the UPF in N4 user plane message. The authentication/authorization information is further transferred to UE via Namf\_Communication\_N1N2MessageTransfer service and NAS SM Transport message. UE responds to the received authentication/authorization data and such information is transferred in NAS SM Transport message and Nsmf\_PDUSession\_UpdateSMContext service, then finally sent to the DN-AAA by the SMF, via the UPF, in the DER message. + +In the case of home routed, the DN-AAA responds with the Access-Challenge message to the H-SMF via the H-UPF, the message is forwarded from the DN-AAA to the H-SMF by the H-UPF in N4 user plane message. The authentication/authorization information is transferred to V-SMF via Nsmf\_PDUSession\_Update service and is further transferred to UE via Namf\_Communication\_N1N2MessageTransfer service and NAS SM Transport message. UE responds to the received authentication/authorization data and such information is transferred in NAS SM Transport message, Nsmf\_PDUSession\_UpdateSMContext service and Nsmf\_PDUSession\_Update service, then finally sent to the DN-AAA by the H-SMF, via the H-UPF, in the Access-Request message. + +NOTE: Step 5 to step 10 can be repeated depending on the authentication/authorization mechanism used (e.g. EAP-TLS). + +11. The SMF receives final result of authentication/authorization from the DN-AAA in the DEA message, via the UPF. +12. The SMF requests to start accounting by sending the Accounting-Request (START) message to the DN-AAA via the UPF. + +- 13. The SMF proceeds with the PDU session establishment procedure and includes the authentication/authorization information in Namf\_Communication\_N1N2MessageTransfer service. + +In the case of home routed, the H-SMF proceeds with the PDU session establishment procedure and includes the authentication/authorization information is transferred to V-SMF via Nsmf\_PDUSession\_Update service and is further transferred to the AMF via Namf\_Communication\_N1N2MessageTransfer service. + +- 14. The DN-AAA responds with the Accounting-Response (START) message. The SMF may wait for the Accounting-Response (START) before sending the Namf\_Communication\_N1N2MessageTransfer request in step 13. + +In the case of home routed, the H-SMF may wait for the Accounting-Response (START) before sending the Nsmf\_PDUSession\_Update service in step 13. + +- 15. The AMF sends the NAS PDU Session Establishment Request with the authentication/authorization information to the UE. + +- 16. The UE sends a NAS message Deregistration Request to the AMF. + +- 17. The AMF sends Nsmf\_PDUSession\_ReleaseSMContext Request to the SMF and the SMF responds to the service operation. + +In the case of home routed, the AMF sends Nsmf\_PDUSession\_ReleaseSMContext Request to the V-SMF and the V-SMF sends the Nsmf\_PDUSession\_Release Request to the H-SMF. + +- 18-19. The SMF requests to stop accounting by sending the Accounting-Request (STOP) message to the DN-AAA via the UPF and the DN-AAA responds with the Accounting-Response (STOP) message. + +![Sequence diagram showing Diameter Authentication and Accounting example (successful case) between UE, AMF, SMF, UPF, and DN-AAA. The diagram illustrates the flow of messages for PDU session establishment, authentication, accounting start, and subsequent deregistration and accounting stop.](68ca7669d38a3c31f5a2c3a06fa802e3_img.jpg) + +``` + +sequenceDiagram + participant UE + participant AMF + participant SMF + participant UPF + participant DN-AAA + + Note left of UE: 1.NAS PDU Session Establishment Request (Authentication message) + UE->>AMF: 1.NAS PDU Session Establishment Request (Authentication message) + AMF->>SMF: 2.Nsmf_PDUSession_CreateSMContext (Authentication message) + SMF->>UPF: 3.N4 Session Establishment + SMF->>DN-AAA: 4.DER + DN-AAA-->>SMF: 5.DEA + SMF->>AMF: 6.Namf_Communication_N1N2MessageTransfer (Authentication message) + AMF->>UE: 7.NAS SM Transport (Authentication message) + UE->>AMF: 8.NAS SM Transport (Authentication message) + AMF->>SMF: 9.Nsmf_PDUSession_UpdateSMContext (Authentication message) + SMF->>DN-AAA: 10.DER + DN-AAA-->>SMF: 11.DEA + SMF->>AMF: 13.Namf_Communication_N1N2MessageTransfer (Authentication message) + SMF->>DN-AAA: 12.Accounting-Request (START) + DN-AAA-->>SMF: 14.Accounting-Response (START) + Note right of SMF: User data + UE->>AMF: 15.NAS PDU Session Establishment Accept (Authentication message) + AMF->>UE: 16.NAS Deregistration Request + AMF->>SMF: 17.Nsmf_PDUSession_ReleaseSMContext + SMF->>DN-AAA: 18.Accounting-Request (STOP) + DN-AAA-->>SMF: 19.Accounting-Response (STOP) + +``` + +Sequence diagram showing Diameter Authentication and Accounting example (successful case) between UE, AMF, SMF, UPF, and DN-AAA. The diagram illustrates the flow of messages for PDU session establishment, authentication, accounting start, and subsequent deregistration and accounting stop. + +Figure 12.2.1-1: Diameter Authentication and Accounting example (successful case) + +### 12.2.2 Accounting Update + +During the life of a QoS flow some information related to this QoS flow may change. The SMF may send an Accounting Request (Interim) to the DN-AAA server upon occurrence of a chargeable event, e.g. RAT change or QoS change. Interim updates are also used when the IPv4 address and/or IPv6 prefix is allocated/released/re-allocated. + +When the SMF receives a signalling request (i.e. Nsmf\_PDUSession\_UpdateSMContext) that indicates the occurrence of one of these chargeable events, the SMF may send an Accounting Request Interim-Update to the DN-AAA server to update the necessary information related to this QoS flow. It is not necessary for the SMF to wait for the Diameter Accounting Answer message from the DN-AAA server before sending the response for the triggering signalling message (i.e. Namf\_Communication\_N1N2MessageTransfer). The SMF may delete the QoS flow if the Accounting Answer is not received from the DN-AAA server. + +The SMF may also send interim updates at the expiry of an operator configured time limit. + +Figure 12.2.2-1 is an example message flow to show the procedure of Diameter accounting update, messages between the SMF and DN-AAA are forwarded by the UPF in N4 user plane message. + +![Sequence diagram for Figure 12.2.2-1: Diameter accounting update. Lifelines: AMF, SMF, UPF, DN-AAA. The sequence starts with AMF sending Nsmf_PDUSession_UpdateSMContext to SMF. SMF responds with Namf_Communication_N1N2MessageTransfer. Simultaneously, SMF sends an Accounting Request (Interim) to DN-AAA via UPF. DN-AAA responds with an Accounting Answer (Interim) via UPF to SMF.](0236eff05bcb8f3a343ea7933aaa306b_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant SMF + participant UPF + participant DN-AAA + Note left of AMF: Nsmf_PDUSession_UpdateSMContext + AMF->>SMF: Nsmf_PDUSession_UpdateSMContext + SMF-->>AMF: Namf_Communication_N1N2MessageTransfer + SMF->>DN-AAA: Accounting Request (Interim) + DN-AAA-->>SMF: Accounting Answer (Interim) + +``` + +Sequence diagram for Figure 12.2.2-1: Diameter accounting update. Lifelines: AMF, SMF, UPF, DN-AAA. The sequence starts with AMF sending Nsmf\_PDUSession\_UpdateSMContext to SMF. SMF responds with Namf\_Communication\_N1N2MessageTransfer. Simultaneously, SMF sends an Accounting Request (Interim) to DN-AAA via UPF. DN-AAA responds with an Accounting Answer (Interim) via UPF to SMF. + +Figure 12.2.2-1: Diameter accounting update + +### 12.2.3 DN-AAA initiated QoS flow termination + +Diameter is used as the protocol between the SMF and the DN-AAA server or proxy for applications (e.g. MMS) to deliver information related to user session. However some IP applications could need to interwork with the SMF to release the corresponding resource (e.g. terminate a particular QoS flow). For this purpose, the DN-AAA server or proxy may send a Diameter ASR along with the QoS flow Identifier in 3GPP-NSAPI, if available, to identify the particular QoS flow to be terminated to the SMF. The SMF should react by deleting the corresponding QoS flow and reply with ASA. If the SMF deletes the corresponding QoS flow, it is not necessary for the SMF to wait for the response (i.e. Nsmf\_PDUSession\_UpdateSMContext) from the AMF before sending the ASA to the DN-AAA server. + +The absence of the QoS flow Identifier in the Diameter ASR message indicates to the SMF that all QoS flows for this particular user and sharing the same user session shall be deleted. The QoS flows belonging to the same PDU session are identified by the Diameter Session-Id. If a user has the same user IP address for different sets of QoS flows towards different networks, only the QoS flows linked to the one identified by the Diameter Session-Id shall be deleted. + +Figure 12.2.3-1 is an example message flow to show the procedure of DN-AAA initiated QoS flow termination, messages between the SMF and DN-AAA are forwarded by the UPF in N4 user plane message. + +![Sequence diagram for Figure 12.2.3-1: DN-AAA initiated QoS flow termination with Diameter. Lifelines: AMF, SMF, UPF, DN-AAA. The sequence starts with DN-AAA sending a Diameter ASR to SMF via UPF. SMF responds with Namf_Communication_N1N2MessageTransfer to AMF. SMF then sends a Diameter ASA to DN-AAA via UPF. Finally, SMF sends Nsmf_PDUSession_UpdateSMContext to AMF.](78d5774278a3f4a614f8c0ae485ce8d9_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant SMF + participant UPF + participant DN-AAA + DN-AAA->>SMF: Diameter ASR + SMF-->>AMF: Namf_Communication_N1N2MessageTransfer + SMF->>DN-AAA: Diameter ASA + SMF-->>AMF: Nsmf_PDUSession_UpdateSMContext + +``` + +Sequence diagram for Figure 12.2.3-1: DN-AAA initiated QoS flow termination with Diameter. Lifelines: AMF, SMF, UPF, DN-AAA. The sequence starts with DN-AAA sending a Diameter ASR to SMF via UPF. SMF responds with Namf\_Communication\_N1N2MessageTransfer to AMF. SMF then sends a Diameter ASA to DN-AAA via UPF. Finally, SMF sends Nsmf\_PDUSession\_UpdateSMContext to AMF. + +Figure 12.2.3-1: DN-AAA initiated QoS flow termination with Diameter + +### 12.2.4 DN-AAA initiated re-authorization + +Some IP applications could need to interwork with the SMF to update the PDU session authorization attributes. For this purpose, the DN-AAA server or proxy may send a Diameter RAR with Re-Auth-Request-Type value "AUTHORIZE\_ONLY" to the SMF. On receipt of the RAR from the DN-AAA server, the SMF shall update the corresponding PDU session authorization attributes and reply with RAA. DN-AAA may also use such procedure to revoke the authorization of a PDU session, or to update the authorization data (e.g. allowed UE MAC addresses). + +If the SMF updates/deletes the corresponding PDU session, it is not necessary for the SMF to wait for Nsmf\_PDUSession\_UpdateSMContext from the AMF before sending the RAA to the DN-AAA server. + +Figure 12.2.4-1 is an example message flow to show the procedure of DN-AAA initiated re-authorization, messages between the SMF and DN-AAA are forwarded by the UPF in N4 user plane message. + +![Sequence diagram for DN-AAA initiated re-authorization. Lifelines: AMF, SMF, UPF, DN-AAA. The sequence starts with a Diameter RAR from DN-AAA to SMF (via UPF). SMF responds with a Diameter RAA to DN-AAA (via UPF). SMF then sends an Nsmf_PDUSession_UpdateSMContext to AMF. AMF responds with a Namf_Communication_N1N2MessageTransfer to SMF.](07b17a620c75522d53916a11e12d1bff_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant SMF + participant UPF + participant DN-AAA + Note right of DN-AAA: Diameter RAR + DN-AAA->>SMF: Diameter RAR (via UPF) + Note right of SMF: Diameter RAA + SMF->>DN-AAA: Diameter RAA (via UPF) + Note right of SMF: Nsmf_PDUSession_UpdateSMContext + SMF->>AMF: Nsmf_PDUSession_UpdateSMContext + Note right of AMF: Namf_Communication_N1N2MessageTransfer + AMF->>SMF: Namf_Communication_N1N2MessageTransfer + +``` + +Sequence diagram for DN-AAA initiated re-authorization. Lifelines: AMF, SMF, UPF, DN-AAA. The sequence starts with a Diameter RAR from DN-AAA to SMF (via UPF). SMF responds with a Diameter RAA to DN-AAA (via UPF). SMF then sends an Nsmf\_PDUSession\_UpdateSMContext to AMF. AMF responds with a Namf\_Communication\_N1N2MessageTransfer to SMF. + +Figure 12.2.4-1: DN-AAA initiated re-authorization with Diameter + +### 12.2.5 DN-AAA initiated re-authentication and re-authorization + +Some IP applications could need to interwork with the SMF to request re-authentication and re-authorization for the PDU session. For this purpose, the DN-AAA server or proxy may send a Diameter RAR with Re-Auth-Request-Type value "AUTHORIZE\_AUTHENTICATE" to the SMF. The RAR should not include any authorization attribute. + +NOTE: Since the SMF will initiate authentication procedure upon receipt of the RAR and in the end the DN-AAA will authorize the session, the DN-AAA does not have to apply authorization change immediately. + +On receipt of the RAR from the DN-AAA server, the SMF shall reply with RAA and start authentication and authorization procedure as described in figure 12.2.1-1, from step 4 to step 11, and step 13. The Auth-Request-Type in the DER is set to "AUTHORIZE\_AUTHENTICATE". + +Figure 12.2.5-1 is an example message flow to show the procedure of DN-AAA initiated re-authentication and re-authorization, messages between the SMF and DN-AAA are forwarded by the UPF in N4 user plane message. + +![Sequence diagram for DN-AAA initiated re-authentication and re-authorization. Lifelines: AMF, SMF, UPF, DN-AAA. The sequence starts with a Diameter RAR from DN-AAA to SMF (via UPF). SMF responds with a Diameter RAA to DN-AAA (via UPF). SMF then initiates its own authentication and authorization procedure, shown as a horizontal bar spanning all lifelines.](18f841ac4f2ef28f34a026f1bdc5af9a_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant SMF + participant UPF + participant DN-AAA + Note right of DN-AAA: Diameter RAR + DN-AAA->>SMF: Diameter RAR (via UPF) + Note right of SMF: Diameter RAA + SMF->>DN-AAA: Diameter RAA (via UPF) + Note over AMF, SMF, UPF, DN-AAA: SMF initiated authentication and authorization + +``` + +Sequence diagram for DN-AAA initiated re-authentication and re-authorization. Lifelines: AMF, SMF, UPF, DN-AAA. The sequence starts with a Diameter RAR from DN-AAA to SMF (via UPF). SMF responds with a Diameter RAA to DN-AAA (via UPF). SMF then initiates its own authentication and authorization procedure, shown as a horizontal bar spanning all lifelines. + +Figure 12.2.5-1: DN-AAA initiated re-authentication and re-authorization with Diameter + +## 12.3 N6 specific AVPs + +There is no specific AVP defined in the present release. + +## 12.4 N6 re-used AVPs + +### 12.4.0 General + +Table 12.4-1 lists the Diameter AVPs re-used by the N6 reference point from existing Diameter Applications, reference to the respective specifications and a short description of the usage within the N6 reference point. + +**Table 12.4-1: N6 re-used Diameter AVPs** + +| Attribute Name | AVP Code | Section defined | Value Type (NOTE 2) | AVP Flag rules (NOTE 1) | | | | May Encr. | Appli cabili ty | +|----------------------------------|----------|-----------------------------|---------------------|-------------------------|-----|------------|----------|-----------|-----------------| +| | | | | Must | May | Should not | Must not | | | +| 3GPP-IMSI | 1 | 3GPP TS 29.061 [5] (NOTE 3) | UTF8String | V | P | | M | Y | | +| 3GPP-Charging-Id | 2 | 3GPP TS 29.061 [5] (NOTE 3) | OctetString | V | P | | M | Y | | +| 3GPP-PDP-Type | 3 | 3GPP TS 29.061 [5] (NOTE 3) | Enumerated | V | P | | M | Y | | +| 3GPP-CG-Address | 4 | 3GPP TS 29.061 [5] (NOTE 3) | OctetString | V | P | | M | Y | | +| 3GPP-GPRS-Negotiated-QoS-Profile | 5 | 3GPP TS 29.061 [5] (NOTE 3) | UTF8String | V | P | | M | Y | | +| 3GPP-SGSN-Address | 6 | 3GPP TS 29.061 [5] (NOTE 3) | OctetString | V | P | | M | Y | | +| 3GPP-GGSN-Address | 7 | 3GPP TS 29.061 [5] (NOTE 3) | OctetString | V | P | | M | Y | | +| 3GPP-IMSI-MCC-MNC | 8 | 3GPP TS 29.061 [5] (NOTE 3) | UTF8String | V | P | | M | Y | | +| 3GPP-GGSN-MCC-MNC | 9 | 3GPP TS 29.061 [5] (NOTE 3) | UTF8String | V | P | | M | Y | | +| 3GPP-NSAPI | 10 | 3GPP TS 29.061 [5] (NOTE 3) | OctetString | V | P | | M | Y | | +| 3GPP-Selection-Mode | 12 | 3GPP TS 29.061 [5] (NOTE 3) | UTF8String | V | P | | M | Y | | +| 3GPP-Charging-Characteristics | 13 | 3GPP TS 29.061 [5] (NOTE 3) | UTF8String | V | P | | M | Y | | +| 3GPP-CG-Ipv6-Address | 14 | 3GPP TS 29.061 [5] (NOTE 3) | OctetString | V | P | | M | Y | | +| 3GPP-SGSN-Ipv6-Address | 15 | 3GPP TS 29.061 [5] (NOTE 3) | OctetString | V | P | | M | Y | | +| 3GPP-GGSN-Ipv6-Address | 16 | 3GPP TS 29.061 [5] (NOTE 3) | OctetString | V | P | | M | Y | | +| 3GPP-Ipv6-DNS-Servers | 17 | 3GPP TS 29.061 [5] (NOTE 3) | OctetString | V | P | | M | Y | | +| 3GPP-SGSN-MCC-MNC | 18 | 3GPP TS 29.061 [5] (NOTE 3) | UTF8String | V | P | | M | Y | | +| 3GPP-IMEISV | 20 | 3GPP TS 29.061 [5] (NOTE 3) | OctetString | V | P | | M | Y | | +| 3GPP-RAT-Type | 21 | 3GPP TS 29.061 [5] (NOTE 3) | OctetString | V | P | | M | Y | | +| 3GPP-User-Location-Info | 22 | 3GPP TS 29.061 [5] (NOTE 3) | OctetString | V | P | | M | Y | | +| 3GPP-MS-TimeZone | 23 | 3GPP TS 29.061 [5] (NOTE 3) | OctetString | V | P | | M | Y | | +| 3GPP-Packet-Filter | 25 | 3GPP TS 29.061 [5] (NOTE 3) | OctetString | V | P | | M | Y | | +| 3GPP-Negotiated-DSCP | 26 | 3GPP TS 29.061 [5] (NOTE 3) | OctetString | V | P | | M | Y | | +| 3GPP-Allocate-IP-Type | 27 | 3GPP TS 29.061 [5] (NOTE 3) | OctetString | V | P | | M | Y | | +| External-Identifier | 28 | 3GPP TS 29.061 [5] (NOTE 3) | OctetString | V | P | | M | Y | | +| TWAN-Identifier | 29 | 3GPP TS 29.061 [5] (NOTE 3) | OctetString | V | P | | M | Y | | +| 3GPP-User-Location-Info-Time | 30 | 3GPP TS 29.061 [5] (NOTE 3) | OctetString | V | P | | M | Y | | +| 3GPP-Secondary-RAT-Usage | 31 | 3GPP TS 29.061 [5] (NOTE 3) | OctetString | V | P | | M | Y | | +| 3GPP-Notification | 110 | 11.3.1 | OctetString | V | P | | M | Y | | +| 3GPP-UE-MAC-Address | 111 | 11.3.1 | OctetString | V | P | | M | Y | | +| 3GPP-Authorization-Reference | 112 | 11.3.1 | OctetString | V | P | | M | Y | | + +| | | | | | | | | | | +|---------------------------|-----|---------------------|-------------|---|---|--|---|---|--------------| +| 3GPP-Policy-Reference | 113 | 11.3.1 | OctetString | V | P | | M | Y | NOTE 4 | +| 3GPP-Session-AMBR | 114 | 11.3.1 | OctetString | V | P | | M | Y | | +| 3GPP-NAI | 115 | 11.3.1 | OctetString | V | P | | M | Y | | +| 3GPP-Session-AMBR-v2 | 116 | 11.3.1 | OctetString | V | P | | M | Y | eSessionAMBR | +| 3GPP-IP-Address-Pool-Info | 118 | 11.3.1 | OctetString | V | P | | M | Y | | +| 3GPP-VLAN-Id | 119 | 11.3.1 | OctetString | V | P | | M | Y | | +| 3GPP-TNAP-Identifier | 120 | 11.3.1 | OctetString | V | P | | M | Y | | +| 3GPP-HFC-NodeId | 121 | 11.3.1 | OctetString | V | P | | M | Y | | +| 3GPP-GLI | 122 | 11.3.1 | OctetString | V | P | | M | Y | | +| 3GPP-Line-Type | 123 | 11.3.1 | OctetString | V | P | | M | Y | | +| 3GPP-NID | 124 | 11.3.1 | OctetString | V | P | | M | Y | | +| 3GPP-GCI | 129 | 11.3.1 | OctetString | V | P | | M | Y | | +| Supported-Features | 628 | 3GPP TS 29.229 [41] | Grouped | V | M | | | N | | + +NOTE 1: The AVP header bit denoted as 'M', indicates whether support of the AVP is required. The AVP header bit denoted as 'V', indicates whether the optional Vendor-ID field is present in the AVP header. For further details, see IETF RFC 6733 [24]. + +NOTE 2: The value types are defined in IETF RFC 6733 [24]. + +NOTE 3: The use of Radius VSA as a Diameter vendor AVP is described in Diameter NASREQ (IETF RFC 7155 [23]) and the P flag may be set. + +NOTE 4: It is not used in this release. + +NOTE 1: Attribute 3GPP-CAMEL-Charging-Info (24) is not applicable for 5G in the present specification. + +NOTE 2: Table 11.3-2 lists the differences between the RADIUS VSAs used in 5G and the VSAs defined in subclause 16.4.7 of 3GPP TS 29.061 [5]. + +### 12.4.1 Use of the Supported-Features AVP on the N6 reference point + +The Supported-Features AVP is used during session establishment to inform the destination host about the required and optional features that the origin host supports. The client shall, in the first request in a Diameter session indicate the set of supported features. The server shall, in the first answer within the Diameter session indicate the set of features that it has in common with the client and that the server shall support within the same Diameter session. Any further command messages shall always be compliant with the list of supported features indicated in the Supported-Features AVPs during session establishment. Features that are not advertised as supported shall not be used to construct the command messages for that Diameter session. Unless otherwise stated, the use of the Supported-Features AVP on the N6 reference point shall be compliant with the requirements for dynamic discovery of supported features and associated error handling on the Cx reference point as defined in clause 7.2.1 of 3GPP TS 29.229 [41]. + +The base functionality for the N6 reference point is the 3GPP Rel-15 standard and a feature is an extension to that functionality. If the origin host does not support any features beyond the base functionality, the Supported-Features AVP may be absent from the N6 commands. As defined in clause 7.1.1 of 3GPP TS 29.229 [41], when extending the application by adding new AVPs for a feature, the new AVPs shall have the M bit cleared and the AVP shall not be defined mandatory in the command ABNF. + +As defined in 3GPP TS 29.229 [41], the Supported-Features AVP is of type grouped and contains the Vendor-Id, Feature-List-ID and Feature-List AVPs. On the N6 reference point, the Supported-Features AVP is used to identify features that have been defined by 3GPP and hence, for features defined in this document, the Vendor-Id AVP shall contain the vendor ID of 3GPP (10415). If there are multiple feature lists defined for the N6 reference point, the Feature-List-ID AVP shall differentiate those lists from one another. + +On receiving an initial request application message, the destination host shall act as defined in clause 7.2.1 of 3GPP TS 29.229 [41]. + +Once the SMF and DN-AAA have negotiated the set of supported features during session establishment, the set of common features shall be used during the lifetime of the Diameter session. + +The table below defines the features applicable to the N6 interfaces for the feature lists with a Feature-List-ID of 1. + +**Table 12.4.1-1: Features of Feature-List-ID 1 used in N6** + +| Feature bit | Feature | M/O | Description | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------|-----|-------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | eSessionAMBR | M | This feature indicates the support of enhanced Session AMBR function. If supported, the DN-AAA authorizes DL and/or UL Session AMBR separately. | +| Feature bit: The order number of the bit within the Feature-List AVP where the least significant bit is assigned number "0".
Feature: A short name that can be used to refer to the bit and to the feature, e.g. "5GC".
M/O: Defines if the implementation of the feature is mandatory ("M") or optional ("O") in this 3GPP Release.
Description: A clear textual description of the feature. | | | | + +## 12.5 N6 specific Experimental-Result-Code AVP + +Diameter Base IETF RFC 6733 [24] defines a number of Result-Code AVP values that are used to report protocol errors and how those are used. Those procedures and values apply for the present specification. + +Due to the N6 specific AVPs, new application results can occur and the Experimental-Result AVP is used to transfer the 3GPP-specific result codes. The Experimental-Result AVP is a grouped AVP containing the Vendor-Id AVP set to the value of 3GPP's vendor identifier (10415) and an Experimental-Result-Code AVP. + +The following N6 specific Experimental-Result-Code value is defined: + +DIAMETER\_QOS\_FLOW\_DELETION\_INDICATION (2421) + +For SMF this is an indication to the server that the requested 5G QoS flow or PDU session has been deleted. + +## 12.6 N6 Diameter messages + +### 12.6.1 General + +This clause describes the N6 Diameter messages. + +The relevant AVPs that are of use for the N6 interface are detailed in this subclause. Other Diameter AVPs as defined in IETF RFC 4072 [25] and IETF RFC 7155 [23], even if their AVP flag rules are marked with "M", are not required for being compliant with the current specification. + +Diameter messages as defined in subclause 16.4 of 3GPP TS 29.061 [5] are re-used in 5G with the following differences: + +- SMF replaces GGSN/P-GW. +- 5G QoS flow replaces IP-CAN/EPS bearer and PDU session replaces IP-CAN session. +- N6 replaces Gi/Sgi. + +NOTE: N6 re-used and specific AVPs are specified in subclause 12.3 and subclause 12.4. + +- 3GPP-NAI AVP may be included in the AAR and ACR command. +- 3GPP-NID AVP may be included together with 3GPP-SGSN-MCC-MNC AVP in the AAR and ACR command. +- Multiple 3GPP-IP-Address-Pool-Info AVPs may be included in the AAR command and one or two 3GPP-IP-Address-Pool-Info AVPs may be included in the AAA and ACR command. +- Multiple 3GPP-UE-MAC-Address AVPs may be included in the AAR and ACR command. +- For indicating user location, TWAN-Identifier AVP, 3GPP-TNAP-Identifier AVP, 3GPP-HFC-NodeId AVP, 3GPP-GLI AVP, 3GPP-Line-Type AVP may be included in the AAR and ACR command. +- Acct-Application-Id AVP shall be included in the ACR and ACA command as specified in IETF RFC 7155 [23]. +- Additional Diameter messages needed for 5G compared to the 3GPP TS 29.061 [5] are described in the following subclauses. + +- Multiple Supported-Features AVPs may be included in the ACR and ACA command. + +### 12.6.2 DER Command + +The DER command, defined in IETF RFC 4072 [25], is indicated by the Command-Code field set to 268 and the 'R' bit set in the Command Flags field. It is sent by the SMF to the DN-AAA server upon reception of an initial access request (e.g. Nsmf\_PDUSession\_CreateSMContext) message for a given DNN to request user authentication and authorization. + +The relevant AVPs that are of use for the N6 interface are detailed in the ABNF description below. Other valid AVPs for this command are not used for N6 purposes and should be ignored by the receiver or processed according to the relevant specifications. + +The bold marked AVPs in the message format indicate new optional AVPs for N6, or modified existing AVPs. + +Message Format: + +``` + ::= < Diameter Header: 268, REQ, PXY > + < Session-Id > + { Auth-Application-Id } + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + { Auth-Request-Type } + [ Destination-Host ] + [ NAS-Port ] + [ NAS-Port-Id ] + [ NAS-Port-Type ] + [ Origin-State-Id ] + [ Port-Limit ] + [ User-Name ] + { EAP-Payload } + [ EAP-Key-Name ] + [ Service-Type ] + [ Authorization-Lifetime ] + [ Auth-Grace-Period ] + [ Auth-Session-State ] + [ Callback-Number ] + [ Called-Station-Id ] + [ Calling-Station-Id ] + [ Originating-Line-Info ] + [ Connect-Info ] + * [ Framed-Compression ] + [ Framed-Interface-Id ] + [ Framed-IP-Address ] + * [ Framed-Ipv6-Prefix ] + * [ Delegated-IPv6-Prefix ] + [ Framed-IP-Netmask ] + [ Framed-MTU ] + [ Framed-Protocol ] + * [ Tunneling ] + * [ Proxy-Info ] + * [ Route-Record ] + [ External-Identifier ] + [ 3GPP-IMSI ] + [ 3GPP-NAI ] + * [ 3GPP-UE-MAC-Address ] + [ 3GPP-Charging-ID ] + [ 3GPP-PDP-Type ] + [ 3GPP-CG-Address ] + [ 3GPP-GPRS-Negotiated-QoS-Profile ] + [ 3GPP-SGSN-Address ] + [ 3GPP-GGSN-Address ] + [ 3GPP-IMSI-MCC-MNC ] + [ 3GPP-GGSN-MCC-MNC ] + [ 3GPP-NSAPI ] + [ 3GPP-Selection-Mode ] + [ 3GPP-Charging-Characteristics ] + [ 3GPP-CG-Ipv6-Address ] + [ 3GPP-SGSN-Ipv6-Address ] + [ 3GPP-GGSN-Ipv6-Address ] + [ 3GPP-SGSN-MCC-MNC ] + [ 3GPP-NID ] + [ 3GPP-User-Location-Info ] + [ 3GPP-RAT-Type ] + [ 3GPP-Negotiated-DSCP ] +``` + +``` + + [ 3GPP-Allocate-IP-Type ] + [ TWAN-Identifier ] + [ 3GPP-TNAP-Identifier ] + [ 3GPP-HFC-NodeId ] + [ 3GPP-GCI ] + [ 3GPP-GLI ] + [ 3GPP-Line-Type ] + * [ 3GPP-IP-Address-Pool-Info ] + * [ Supported-Features ] + * [ AVP ] + +``` + +### 12.6.3 DEA Command + +The DEA command, defined in IETF RFC 4072 [25], is indicated by the Command-Code field set to 268 and the 'R' bit cleared in the Command Flags field. It is sent by the DN-AAA server to the SMF in response to the DER command. + +The relevant AVPs that are of use for the N6 interface are detailed in the ABNF description below. Other valid AVPs for this command are not used for N6 purposes and should be ignored by the receiver or processed according to the relevant specifications. + +The bold marked AVPs in the message format indicate new optional AVPs for N6, or modified existing AVPs. + +Message Format: + +``` + + ::= < Diameter Header: 268, PXY > + < Session-Id > + { Auth-Application-Id } + { Auth-Request-Type } + { Result-Code } + { Origin-Host } + { Origin-Realm } + [ User-Name ] + [ EAP-Payload ] + [ EAP-Reissued-Payload ] + [ EAP-Master-Session-Key ] + [ EAP-Key-Name ] + [ Multi-Round-Time-Out ] + [ Accounting-EAP-Auth-Method ] + [ Service-Type ] + * [ Class ] + [ Acct-Interim-Interval ] + [ Error-Message ] + [ Error-Reporting-Host ] + [ Failed-AVP ] + [ Idle-Timeout ] + [ Authorization-Lifetime ] + [ Auth-Grace-Period ] + [ Auth-Session-State ] + [ Re-Auth-Request-Type ] + [ Session-Timeout ] + * [ Reply-Message ] + [ Origin-State-Id ] + * [ Filter-Id ] + [ Port-Limit ] + [ Callback-Id ] + [ Callback-Number ] + * [ Framed-Compression ] + [ Framed-Interface-Id ] + [ Framed-IP-Address ] + * [ Framed-Ipv6-Prefix ] + [ Framed-Ipv6-Pool ] + * [ Framed-Ipv6-Route ] + * [ Delegated-IPv6-Prefix ] + [ Framed-IP-Netmask ] + * [ Framed-Route ] + [ Framed-Pool ] + [ Framed-IPX-Network ] + [ Framed-MTU ] + [ Framed-Protocol ] + [ Framed-Routing ] + * [ NAS-Filter-Rule ] + * [ QoS-Filter-Rule ] + * [ Tunneling ] + * [ Redirect-Host ] + [ Redirect-Host-Usage ] + [ Redirect-Max-Cache-Time ] + +``` + +``` + + * [ Proxy-Info ] + * [ External-Identifier ] + [ 3GPP-Ipv6-DNS-Servers ] + [ 3GPP-Notification ] +0*16 [ 3GPP-UE-MAC-Address ] +0*16 [ 3GPP-VLAN-Id ] +[ 3GPP-Authorization-Reference ] +[ 3GPP-Policy-Reference ] +[ 3GPP-Session-AMBR ] +[ 3GPP-Session-AMBR-v2 ] +0*2 [ 3GPP-IP-Address-Pool-Info ] +* [ Supported-Features ] +* [ AVP ] + +``` + +### 12.6.4 RAR Command + +The RAR command, defined in IETF RFC 7155 [23], is indicated by the Command-Code field set to 258 and the 'R' bit set in the Command Flags field. It is sent by the DN-AAA server to the SMF to initiate re-authorization and optional re-authentication service. + +The relevant AVPs that are of use for the N6 interface are detailed in the ABNF description below. Other valid AVPs for this command are not used for N6 purposes and should be ignored by the receiver or processed according to the relevant specifications. + +The bold marked AVPs in the message format indicate new optional AVPs for N6, or modified existing AVPs. + +Message Format: + +``` + + ::= < Diameter Header: 258, REQ, PXY > + < Session-Id > + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + [ Destination-Host ] + { Auth-Application-Id } + { Re-Auth-Request-Type } + [ User-Name ] + [ Origin-State-Id ] + [ NAS-Port ] + [ NAS-Port-Id ] + [ NAS-Port-Type ] + [ Service-Type ] + [ Framed-IP-Address ] + [ Framed-Ipv6-Prefix ] + [ Framed-Interface-Id ] + [ Called-Station-Id ] + [ Calling-Station-Id ] + [ Originating-Line-Info ] + [ Acct-Session-Id ] + * [ Class ] + [ Reply-Message ] + * [ Proxy-Info ] + * [ Route-Record ] +0*16 [ 3GPP-UE-MAC-Address ] +0*16 [ 3GPP-VLAN-Id ] +[ 3GPP-Authorization-Reference ] +[ 3GPP-Policy-Reference ] +[ 3GPP-Session-AMBR ] +[ 3GPP-Session-AMBR-v2 ] +* [ AVP ] + +``` + +### 12.6.5 RAA Command + +The RAA command, defined in IETF RFC 7155 [23], is indicated by the Command-Code field set to 258 and the 'R' bit set in the Command Flags field. It is sent by the SMF to the DN-AAA server in response to the RAR command. + +The relevant AVPs that are of use for the N6 interface are detailed in the ABNF description below. Other valid AVPs for this command are not used for N6 purposes and should be ignored by the receiver or processed according to the relevant specifications. + +Message Format: + +``` + + ::= < Diameter Header: 258, PXY > + < Session-Id > + +``` + +``` +{ Result-Code } +{ Origin-Host } +{ Origin-Realm } +[ User-Name ] +[ Origin-State-Id ] +[ Error-Message ] +[ Error-Reporting-Host ] +[ Failed-AVP ] +* [ Redirect-Host ] +[ Redirect-Host-Usage ] +[ Redirect-Max-Cache-Time ] +[ Service-Type ] +[ Idle-Timeout ] +[ Authorization-Lifetime ] +[ Auth-Grace-Period ] +[ Re-Auth-Request-Type ] +* [ Class ] +* [ Reply-Message ] +* [ Proxy-Info ] +* [ AVP ] +``` + +# 13 Interworking with IMS + +## 13.1 General + +Interworking with the IP Multimedia Core Network Subsystem (IMS) puts specific requirements on the SMF. + +The SMF shall use the following mechanisms to support the interworking with the IMS: + +- the P-CSCF discovery; +- N7 interface for the policy and charging control of QoS flows for IMS media flows; and +- the P-CSCF restoration. + +These mechanisms are however not restricted only to the interworking with the IMS and may be used for other services that could benefit from these mechanisms. + +If the PDU Session is used for IMS (identified by DNN), the SMF shall not modify the fields Type of Service (IPv4) and Traffic Class (IPv6). + +NOTE: The P-CSCF can support paging policy differentiation for different traffic or service types over NG-RAN by marking the fields Type of Service (IPv4) and Traffic Class (IPv6) (see subclause L.3.2.4 of 3GPP TS 24.229 [13]). + +## 13.2 IMS interworking Model + +### 13.2.1 Introduction + +The signalling interface between the UE and the P-CSCF is a logical interface, i.e. it uses 5GC as a QoS flow. The Npcf\_SMPolicyControl services, offered via N7 interface, are used for network communication between the SMF and the PCF. For a description of the IMS architecture, refer to 3GPP TS 23.228 [12]. + +### 13.2.2 IMS specific configuration in the SMF + +The SMF shall have a list of preconfigured addresses of signalling servers (the P-CSCF servers). This list shall be provided to the UE at PDU session establishment. It shall be possible to preconfigure the list of preconfigured addresses of signalling servers per DNN. + +The SMF/UPF may have the locally preconfigured packet filters, and/or the applicable PCC rules, to be applied on the QoS flow. The packet filters shall filter up-link and down-link packets, and shall only allow traffic to/from the signalling servers and to the DNS and the DHCP servers. It shall be possible to locally preconfigure the packet filters per DNN. + +It shall be possible to enable/disable the use of the services offered via N7 interface per DNN. + +The SMF shall support IPv4 and/or IPv6 addresses and protocol for IMS signalling and IMS QoS flows. + +The methods for the UE to discover the P-CSCF address(es) may vary depending on the access technology that the UE is on. The details of the P-CSCF discovery mechanisms for various accesses are specified in 3GPP TS 23.228 [12] and 3GPP TS 24.229 [13]. The P-CSCF discovery mechanisms are: + +- a 5GC procedure for the P-CSCF discovery; +- via DHCP servers i.e. the SMF shall provide the functionality of a DHCP relay agent; and +- if the UE has a P-CSCF FQDN locally configured and request the DNS IP address(es) from the SMF (via 5GC mechanism or DHCP procedures), the SMF shall be able to provide DNS IP address(es) to the UE. + +The SMF shall have similar functional support depending on the P-CSCF discovery methods supported by the UE on the access technology. For example, for the UE in 3GPP 5G access network the SMF shall have DHCP server function towards the UE while acting as a DHCP client towards external DHCP server, if the SMF is configured to request DNS and/or P-CSCF IP addresses from the external DHCP servers. + +The SMF shall be able to deliver DNS and/or P-CSCF addresses to the UE if requested by the UE via the 5G network or via DHCP procedures using the relevant DHCP options for IPv4/IPv6 DNS and SIP servers (see IETF RFC 2132 [14], IETF RFC 3361 [15], IETF RFC 3646 [16] and IETF RFC 3319 [17]). + +On DNNs providing IMS services, the information advertised in Router Advertisements from the SMF to the UEs shall be configured in the same manner as for other DNNs providing IPv6 services except that the "O-flag" shall be set. + +The "O-flag" shall be set in IPv6 Router Advertisement messages sent by the SMF for DNNs used for IMS services. This will trigger a DHCP capable UE to start a DHCPv6 session to retrieve server addresses and other configuration parameters. The UE which doesn't support DHCP shall ignore the "O-flag" and shall request the IMS specific configuration (e.g. the P-CSCF address) via other discovery methods supported in the UE (i.e. via locally configured P-CSCF address/FQDN in the UE or via 5G procedure, if applicable). + +The SMF shall have configurable policy rules for controlling QoS flows used for signalling. + +### 13.2.3 IMS specific procedures in the SMF + +#### 13.2.3.1 Provisioning of Signalling Server Address + +At a PDU Session establishment procedure related to the IMS, the SMF shall support the capability to send the P-CSCF address(es) to the UE. The P-CSCF address information is sent by the visited SMF if LBO is used. For Home routed, the P-CSCF address information is sent by the SMF in the HPLMN. The P-CSCF address(es) shall be sent transparently through the AMF, and in case of Home Routed also through the SMF in the VPLMN. + +NOTE 1: The SMF is located in the VPLMN if LBO is used. + +NOTE 2: Other options to provide the P-CSCF address(es) to the UE as defined in 3GPP TS 23.228 [12] is not excluded. + +NOTE 3: A PDU session for IMS is identified by "APN" or "DNN". + +#### 13.2.3.2 Failure of Signalling Server Address + +If the SMF detects a failure: + +- upon receiving the N4 session report from the UPF for the monitored P-CSCF address being used by the UE (as specified in 3GPP TS 23.380 [38], subclause 5.8.3); or +- upon receiving a P-CSCF restoration indication from the UDM or the PCF, + +then the SMF shall act as specified in 3GPP TS 23.380 [38], subclause 5.8. + +# --- 14 Interworking with DN (Ethernet) + +When support of Ethernet PDU type data is provided at the N6 interface, the SMF and UPF may support ARP proxying as specified in IETF RFC 1027 [35] and/or IPv6 Neighbour Solicitation Proxying as specified in IETF RFC 4861 [33] + +functionality. Based on operator configuration, during the PDU session establishment, the SMF may request the UPF acting as the PDU Session Anchor to proxy ARP/IPv6 Neighbour Solicitation or to forward the ARP/IPv6 Neighbour Solicitation traffic from the UPF to the SMF. + +Ethernet Preamble, Start Frame Delimiter (SFD) and Frame Check Sequence (FCS) are not sent over 5GS: + +- For UL traffic the UE strips the Preamble, SFD and FCS from the Ethernet frame, those fields shall be added by the UPF acting as the PDU Session Anchor. +- For DL traffic the UPF acting as the PDU Session Anchor shall strip the Preamble, SFD and FCS from the Ethernet frame. + +IP address is not allocated by the SMF to the UE for this PDU Session. The UPF shall store the MAC addresses, received from the UE, and associate those with the appropriate PDU Session. + +NOTE 1: The UE can operate in bridge mode with regard to a LAN it is connecting to the 5GS, thus different MAC addresses can be used as source address of different frames sent UL over a single PDU Session (and destination MAC address of different frames sent DL over the same PDU Session) + +NOTE 2: Entities on the LAN connected to the 5GS by the UE can have an IP address allocated by the external DN, but the IP layer is considered as an application layer which is not part of the Ethernet PDU Session. + +NOTE 3: In this Release of the specification, only the UE connected to the 5GS is authenticated, not the devices behind such UE. + +When a PDU Session of Ethernet PDU type is authorized by a DN, the DN-AAA server may, as part of authorization data, provide the SMF with a list of allowed MAC addresses (maximum 16) for this PDU Session. When such a list has been provided for a PDU Session, the SMF sets corresponding filtering rules in the UPF(s) acting as PDU Session Anchor for the PDU Session and the UPF discards any UL traffic that does not contain any of these MAC addresses as a source address. + +![Diagram showing protocol stacks for Ethernet PDU type data (user plane) for N6 reference point. The diagram illustrates the encapsulation of Ethernet frames within 5G protocol layers and L1 for transmission over the N6 interface. The UPF (PDU Session Anchor) is shown as a dashed box containing the Ethernet User Payload (e.g. ARP, IP), which is encapsulated into an Ethernet Frame (without Preamble, SFD, FCS). This frame is then encapsulated into 5G protocol layers, which are further encapsulated into L1 for transmission over the N6 interface.](cdd4dfacab004e9979caed3fffea69e5_img.jpg) + +| | | | | +|--------------------------|--------------------|------------------------------------------------------|----------------| +| UPF (PDU Session Anchor) | | Ethernet User Payload (e.g. ARP, IP) | | +| | | Ethernet Frame
(without
Preamble, SFD,
FCS) | Ethernet Frame | +| N3/N4/N9 | 5G protocol layers | L1 | N6 | + +Diagram showing protocol stacks for Ethernet PDU type data (user plane) for N6 reference point. The diagram illustrates the encapsulation of Ethernet frames within 5G protocol layers and L1 for transmission over the N6 interface. The UPF (PDU Session Anchor) is shown as a dashed box containing the Ethernet User Payload (e.g. ARP, IP), which is encapsulated into an Ethernet Frame (without Preamble, SFD, FCS). This frame is then encapsulated into 5G protocol layers, which are further encapsulated into L1 for transmission over the N6 interface. + +Figure 14-1: Protocol stacks for Ethernet PDU type data (user plane) for N6 reference point + +# 15 Interworking with DN (Multicast Routing Protocol) + +## 15.1 General + +The 3GPP network support IPTV multicast packets transmission over PDU Session as specified in 3GPP TS 23.316 [43] subclause 7.7.1. When support of multicast routing protocol is provided at the N6 interface, different techniques may be used. + +## 15.2 DN interworking Model of UPF for PIM + +If PIM (Protocol-Independent Multicast) is used as Multicast Routing Protocol, including PIM-SM (Protocol-Independent Multicast-Sparse Mode, IETF RFC 7761 [44]) and PIM-DM (Protocol-Independent Multicast- Dense Mode, IETF RFC 3973 [45]), are commonly used to efficiently routing multicast groups that may span wide-area (and inter-domain) internets. + +UPF acts as the PIM router which is closest to UE and receive multicast packets originated from multicast source via perform PIM function. Based on local policy, UPF support either PIM-SM or PIM-DM or both. + +UPF shall acts as PIM router used for interworking with the IP network as illustrated in figure 15.2-1. + +![Diagram showing the protocol stacks for the N6 reference point for PIM. The UPF (User Plane Function) contains a stack of protocols: PIM, UDP, IP, L2, and L1. The PIM layer is connected to the N6 interface, which is represented by a vertical line. A large arrow points from the PIM layer in the UPF stack towards the N6 interface, indicating the flow of multicast traffic.](e636d7ccca0ad14c6b95201404324823_img.jpg) + +Diagram showing the protocol stacks for the N6 reference point for PIM. The UPF (User Plane Function) contains a stack of protocols: PIM, UDP, IP, L2, and L1. The PIM layer is connected to the N6 interface, which is represented by a vertical line. A large arrow points from the PIM layer in the UPF stack towards the N6 interface, indicating the flow of multicast traffic. + +**Figure 15.2-1: The protocol stacks for the N6 reference point for PIM** + +PIM function in UPF shall interacts with PIM routers in IP network. + +- In case of PIM-SM, PIM router in UPF acts as DR (Designated Router) which is closest to UE and send register message to RP (Rendezvous Point). It receive multicast packets over shared tree from RP. Refer to IETF RFC 7761 [44] for more details. +- In case of PIM-DM, PIM router in UPF sends Upstream Prune Messages to indicate that designated multicast traffic is not desired, It sends Upstream Graft message to re-join a previously pruned branch to the delivery tree. Refer to IETF RFC 3973 [45] for more details. + +# 16 Interworking with NSS-AAA (RADIUS) + +## 16.1 RADIUS procedures + +### 16.1.1 General + +The Network Slice Specific Authentication and Authorization procedure is triggered for a network slice requiring Network Slice Specific Authentication and Authorization with an NSS-AAA server which may be hosted by the H-PLMN operator or by a third party which has a business relationship with the H-PLMN. An AAA Proxy (AAA-P) in the HPLMN may be involved e.g. if the NSS-AAA Server belongs to a third party. + +### 16.1.2 RADIUS Authentication and Authorization + +RADIUS Authentication and Authorization shall be used according to IETF RFC 2865 [8], IETF RFC 3162 [9] and IETF RFC 4818 [10]. In 5G, multiple authentication methods using Extensible Authentication Protocol (EAP) may be used such as EAP-TLS (see IETF RFC 5216 [11]), EAP-TTLS (see IETF RFC 5281 [37]). The NSSAAFor AAA-P shall implement the RADIUS extension to support EAP as specified in IETF RFC 3579 [7]. + +The RADIUS client function may reside in an NSSAAF. When the NSSAAF receives Nnssaaf\_NSSAA\_Authenticate request from AMF, the RADIUS client function shall send the authentication information with network slice information to a NSS-AAA server directly or via an AAA-P. + +The NSS-AAA server performs authentication and authorization for the user and requested network slice information. When the NSSAAF receives an Access-Accept message from the NSS-AAA server or AAA-P, it shall complete the network slice specific authentication procedure. If Access-Reject or no response is received, the NSSAAF shall reject the network slice specific authentication procedure with a suitable cause code. + +The NSS-AAA may revoke the authorization for the network slice, see details in clause 16.2.2. In the present release, the NSS-AAA initiated re-authentication is not supported. + +## 16.2 Message flows for network slice specific authentication + +### 16.2.1 Authentication and Authorization procedures + +When the NSSAAF receives Nnssaaf\_NSSAA\_Authenticate request from AMF, it shall send a RADIUS Access-Request message with EAP extension to an NSS-AAA server directly or via an AAA-P if AAA-P is involved. The Access-Request message shall include GPSI in Calling-Station-Id or External-Identifier attribute and network slice information in 3GPP-S-NSSAI attribute. Upon receipt of the Access-Request message, the NSS-AAA server shall respond with an Access-Challenge message. Multi-round authentication using the Access-Challenge (sent by NSS-AAA) and Access-Request messages may be used. The NSS-AAA server finally authenticates and authorizes the user and the network slice by replying with an Access Accept message. + +For re-authentication and re-authorization, the NSSAAF shall send a RADIUS Access-Request message with EAP extension to the NSS-AAA server directly or via the AAA-P if AAA-P is used and the NSS-AAA shall respond with an Access-Challenge message. Multi-round authentication using the Access-Challenge (sent by NSS-AAA) and Access-Request messages may be used. The NSS-AAA server finally authenticates and authorizes the user and the network slice by replying with an Access Accept message. + +The following figure 16.2.1-1 is an example message flow to show the procedure of RADIUS Authentication and Authorization between an AMF and a NSS-AAA server: + +1. AMF decides to trigger the start of the Network Slice Specific Authentication and Authorization procedure. + 2. The AMF may send an EAP Identity Request in a NAS Network Slice-Specific Authentication Command message. + 3. The UE provides the EAP Identity Response in a NAS Network Slice-Specific Authentication Complete message towards the AMF. + 4. The AMF sends Nnssaaf\_NSSAA\_Authenticate Request to the NSSAAF including the authentication/authorization information. + - 5-6. If the AAA-P is present (e.g. because the NSS-AAA belongs to a third party and the operator deploys a proxy towards third parties), the NSSAAF sends the Access-Request message to the NSS-AAA via the AAA-P to forward the authentication/authorization information, otherwise the NSSAAF sends the Access-Request message directly to the NSS-AAA. + - 7-14. The NSS-AAA responds with the Access-Challenge message to the NSSAAF directly or via the AAA-P. The authentication/authorization information is further transferred to UE via AMF by Nnssaaf\_NSSAA\_Authenticate service and NAS Network Slice-Specific Authentication Command message. UE responds to the received authentication/authorization data and such information is transferred in NAS Network Slice-Specific Authentication Complete message and Nnssaaf\_NSSAA\_Authenticate service, then finally sent to the NSS-AAA by the NSSAAF, via the AAA-P if the AAA-P is used, in the Access-Request message. +- NOTE: Step 7 to step 14 can be repeated depending on the authentication/authorization mechanism used (e.g. EAP-TLS). +- 15-16. If the AAA-P is used, the NSS-AAA sends a Access-Accept message with the final result of authentication/authorization to the NSSAAF via the AAA-P, otherwise the NSS-AAA sends the Access-Accept message directly to the NSSAAF. + +17. The NSSAAF sends a Nnssaaaf\_NSSAA\_Authenticate Response with the final result of authentication/authorization information to the AMF. +18. The AMF transfers the final result of authentication/authorization information in a NAS Network Slice-Specific Authentication Result message to the UE. + +![Sequence diagram of Network slice specific authentication and Authorization procedure (RADIUS)](09955ff8214ffb6947951fc0f60eb6ab_img.jpg) + +``` + +sequenceDiagram + participant UE + participant AMF + participant NSSAAF + participant AAA-P + participant NSS-AAA + + Note right of UE: 1. trigger to perform Network Slice-Specific Authentication and Authorization + UE->>AMF: 2. NAS Network Slice-Specific Authentication Command + AMF-->>UE: 3. NAS Network Slice-Specific Authentication Complete + AMF->>NSSAAF: 4. Nnssaaaf_NSSAA_Authenticate request + NSSAAF->>AAA-P: 5. Access-Request + AAA-P->>NSS-AAA: 6. Access-Request + NSS-AAA->>AAA-P: 7. Access-Challenge + AAA-P-->>NSSAAF: 8. Access-Challenge + NSSAAF->>AMF: 9. Nnssaaaf_NSSAA_Authenticate response + AMF->>UE: 10. NAS Network Slice-Specific Authentication Command + UE->>AMF: 11. NAS Network Slice-Specific Authentication Complete + AMF->>NSSAAF: 12. Nnssaaaf_NSSAA_Authenticate request + NSSAAF->>AAA-P: 13. Access-Request + AAA-P->>NSS-AAA: 14. Access-Request + NSS-AAA->>AAA-P: 15. Access-Accept + AAA-P-->>NSSAAF: 16. Access-Accept + NSSAAF->>AMF: 17. Nnssaaaf_NSSAA_Authenticate response + AMF->>UE: 18. NAS Network Slice-Specific Authentication Result + +``` + +Sequence diagram of Network slice specific authentication and Authorization procedure (RADIUS) + +Figure 16.2.1-1: Network slice specific authentication and Authorization procedure (RADIUS) + +### 16.2.2 NSS-AAA initiated revocation of network slice authorization + +The NSS-AAA server may send a RADIUS Disconnect-Request to the NSSAAF directly or via AAA-P (if AAA-P is used) asking for revocation of network slice authorization. On receipt of the Disconnect-Request from the NSS-AAA server, the NSSAAF shall release the resources, interact with its succeeding Network Function AMF which is got from the UDM by Nudm\_UECM\_GET service operation with GPSI and reply with a Disconnect-ACK. If the NSSAAF is unable to release the corresponding resources, it shall reply to the NSS-AAA server with a Disconnect-NAK. For more information on RADIUS Disconnect, see IETF RFC 5176 [27]. It is not necessary for the NSSAAF to wait for the response (i.e. Nudm\_UECM\_GET or Nnssaaaf\_NSSAA\_Notify response) from the succeeding Network Function before sending the RADIUS Disconnect-ACK to the NSS-AAA server or AAA-P (if AAA-P is used). + +Figure 16.2.2-1 is an example message flow to show the procedure of NSS-AAA initiated revocation of network slice authorization. If the AAA-P is not used, the Disconnect Request and Response messages are exchanged between the NSS-AAA and the NSSAAF. + +![Sequence diagram showing NSS-AAA initiated revocation of network slice authorization with RADIUS. The diagram involves five entities: AMF, UDM, NSSAAF, AAA-P, and NSS-AAA. The sequence starts with NSS-AAA sending a Disconnect-Request to AAA-P. AAA-P sends a Disconnect-Request to NSSAAF. NSSAAF sends a Nudm_UECM_GET to UDM. UDM responds with a Nausf_NSSAA_Notify to AMF. AMF sends a Disconnect-Response to NSSAAF. NSSAAF sends a Disconnect-Response to AAA-P. AAA-P sends a Disconnect-Response to NSS-AAA.](eb03559a4d92ea9ebd63ea9be663c50a_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant UDM + participant NSSAAF + participant AAA-P + participant NSS-AAA + Note right of AAA-P: [AAA-P] + NSS-AAA->>AAA-P: Disconnect-Request + AAA-P-->>NSSAAF: Disconnect-Request + NSSAAF->>UDM: Nudm_UECM_GET + UDM-->>AMF: Nausf_NSSAA_Notify + AMF->>NSSAAF: Disconnect-Response + NSSAAF-->>AAA-P: Disconnect-Response + AAA-P->>NSS-AAA: Disconnect-Response + +``` + +Sequence diagram showing NSS-AAA initiated revocation of network slice authorization with RADIUS. The diagram involves five entities: AMF, UDM, NSSAAF, AAA-P, and NSS-AAA. The sequence starts with NSS-AAA sending a Disconnect-Request to AAA-P. AAA-P sends a Disconnect-Request to NSSAAF. NSSAAF sends a Nudm\_UECM\_GET to UDM. UDM responds with a Nausf\_NSSAA\_Notify to AMF. AMF sends a Disconnect-Response to NSSAAF. NSSAAF sends a Disconnect-Response to AAA-P. AAA-P sends a Disconnect-Response to NSS-AAA. + +Figure 16.2.2-1: NSS-AAA initiated revocation of network slice authorization with RADIUS + +## 16.3 List of RADIUS attributes + +### 16.3.1 General + +Information defined in clause 11.3 are re-used for network slice specific authentication with the following differences: + +- NSSAAF replaces SMF. +- IP, Ethernet and PDU session related descriptions and attributes are not applicable. +- RADIUS messages for accounting function (Accounting Request/Response) are not applicable. +- Additional detailed information needed for network slice specific authentication are described below. + +Table 16.3-1: Additional information needed for network slice specific authentication + +| Sub-attr # | Sub-attribute Name | Differences | +|------------|------------------------------------------------------------------------------------------|-------------| +| 200 | 3GPP-S-NSSAI | Added. | +| NOTE: | 5G specific RADIUS VSAs for network slice specific authentication are numbered from 200. | | + +###### 200 – 3GPP-S-NSSAI + +| Octets | Bits | | | | | | | | +|--------|-------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 200 | | | | | | | | +| 2 | 3GPP Length= m | | | | | | | | +| 3 | SST | | | | | | | | +| 4-6 | SD (octet string) | | | | | | | | + +3GPP Type: 200 + +Length: 3 or 6 + +SST: the Slice/Service Type with value range 0 to 255. + +SD: 3-octet string, representing the Slice Differentiator, the encoding follows sd attribute specified in subclause 5.4.4.2 of 3GPP TS 29.571 [46]. Its presence depends on the Length field. + +Table 16.3-2 describes the sub-attributes of the 3GPP Vendor-Specific attribute described above in different RADIUS messages. + +**Table 16.3-2: List of the 3GPP Vendor-Specific sub-attributes for network slice specific authentication** + +| Sub-attr # | Sub-attribute Name | Description | Presence Requirement | Associated attribute (Location of Sub-attr) | Applicability | +|------------|-------------------------------------------------------------------|--------------------------|----------------------|---------------------------------------------|---------------| +| 200 | 3GPP-S-NSSAI | It includes the S-NSSAI. | Conditional (NOTE) | Access-Request | | +| NOTE: | This VSA shall be included in the initial Access-Request message. | | | | | + +# 17 Interworking with NSS-AAA (Diameter) + +## 17.1 Diameter procedures + +### 17.1.1 General + +The Network Slice Specific Authentication and Authorization procedure is triggered for a network slice requiring Network Slice Specific Authentication and Authorization with an NSS-AAA server which may be hosted by the H-PLMN operator or a third party which has a business relationship with the H-PLMN. An AAA Proxy (AAA-P) in the HPLMN may be involved e.g. if the NSS-AAA Server belongs to a third party. + +### 17.1.2 Diameter Authentication and Authorization + +Diameter Authentication and Authorization shall be used according to IETF RFC 7155 [23]. In 5G, multiple authentication methods using Extensible Authentication Protocol (EAP) may be used such as EAP-TLS (see IETF RFC 5216 [11]), EAP-TTLS (see IETF RFC 5281 [37]). The NSSAAF or AAA-P shall support Diameter EAP application as specified in IETF RFC 4072 [25]. + +The NSSAAF or AAA-P and the NSS-AAA shall advertise the support of the Diameter NASREQ and EAP applications by including the value (1 and 5) of the application identifier in the Auth-Application-Id AVP (as specified in IETF RFC 4072 [25]) and the value of the 3GPP (10415) in the Vendor-Id AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands as specified in IETF RFC 6733 [24], i.e. as part of the Vendor-Specific-Application-Id AVP. + +The Diameter client function may reside in an NSSAAF. When the NSSAAF receives Nnssaaf\_NSSAA\_Authenticate request from AMF, the Diameter client function shall send the authentication information with network slice information to a NSS-AAA server directly or via an AAA-P (if AAA-P is used). + +The NSS-AAA server performs authentication and authorization for the requested network slice information. When the Nnssaaf receives a positive response from the NSS-AAA server or AAA-P (if AAA-P is used), it shall complete the network slice specific authentication procedure. If negative response or no response is received, the NSSAAF shall reject the network slice specific authentication procedure with a suitable cause code. + +The NSS-AAA may revoke the authorization for the network slice, see details in clause 17.2.2. NSS-AAA may initiate re-authentication and re-authorization, see details in clause 17.2.3. + +## 17.2 Message flows for network slice specific authentication + +### 17.2.1 Authentication and Authorization procedures + +For network slice specific authentication and authorization, when the NSSAAF receives Nnssaaf\_NSSAA\_Authenticate request from AMF, it shall send a Diameter DER message with GPSI in Calling-Station-Id or External-Identifier attribute and network slice information in 3GPP-S-NSSAI attribute to a NSS-AAA server directly or via AAA-P if AAA-P is involved. Upon receipt of the DER message, the DN-AAA server shall respond with an DEA message. Multi-round authentication using the DEA and DER messages may be used. The NSS-AAA server finally authenticates and authorizes the user and the network slice by replying with a Diameter DEA message. + +For re-authentication and re-authorization, the NSSAAF shall send a DER message to the NSS-AAA server directly or via AAA-P if AAA-P is used and the NSS-AAA server shall respond with a DEA message. Multi-round authentication + +using the DEA and DER messages may be used. The NSS-AAA server finally authenticates and authorizes the user and the network slice by replying with a Diameter DEA message. + +If the network slice specific authentication is not required, the NSSAAF shall send a Diameter STR message to the NSS-AAA server directly or via AAA-P if AAA-P is involved. The NSS-AAA server shall reply with a Diameter STA message. The following figure 17.2.1-1 is an example message flow to show the procedure of Diameter Authentication and Authorization between an AMF and a NSS-AAA server: + +1. AMF decides to trigger the start of the Network Slice Specific Authentication and Authorization procedure. + 2. The AMF may send an EAP Identity Request in a NAS Network Slice-Specific Authentication Command message. + 3. The UE provides the EAP Identity Response in a NAS Network Slice-Specific Authentication Complete message towards the AMF. + 4. The AMF sends NnssAAF\_NSSAAF\_Authenticate Request to the NSSAAF including the authentication/authorization information. + - 5-6. If the AAA-P is present (e.g. because the NSS-AAA belongs to a third party and the operator deploys a proxy towards third parties), the NSSAAF sends the DER message to the NSS-AAA via the AAA-P to forward the authentication/authorization information, otherwise the NSSAAF sends the DER message directly to the NSS-AAA. + - 7-14. The NSS-AAA responds with the DEA message to the NSSAAF directly or via the AAA-P. The authentication/authorization information is further transferred to UE via AMF by NnssAAF\_NSSAAF\_Authenticate service and NAS MM Transport message. UE responds to the received authentication/authorization data and such information is transferred in NAS Network Slice-Specific Authentication Complete message and NnssAAF\_NSSAAF\_Authenticate service, then finally sent to the NSS-AAA by the NSSAAF, via the AAA-P if the AAA-P is used, in the DER message. +- NOTE: Step 7 to step 14 can be repeated depending on the authentication/authorization mechanism used (e.g. EAP-TLS). +- 15-16. If the AAA-P is used, the NSS-AAA sends a DEA message with the final result of authentication/authorization to the NSSAAF via the AAA-P, otherwise the NSS-AAA sends the DEA message directly to the NSSAAF. + 17. The NSSAAF sends a NnssAAF\_NSSAAF\_Authenticate Response with the final result of authentication/authorization information to the AMF. + 18. The AMF transfers the final result of authentication/authorization information in a NAS Network Slice-Specific Authentication Result message to the UE. + +![Sequence diagram of network slice specific authentication and authorization procedure (Diameter).](90ddb84c323b956e2d50a54d3f870566_img.jpg) + +``` + +sequenceDiagram + participant UE + participant AMF + participant NSSAAF + participant AAA-P + participant NSS-AAA + + Note over UE, AMF: 1. trigger to perform Network Slice-Specific Authentication and Authorization + AMF->>UE: 2. NAS Network Slice-Specific Authentication Command + UE-->>AMF: 3. NAS Network Slice-Specific Authentication Complete + AMF->>NSSAAF: 4. Nnssaaaf_NSSAA_Authenticate request + NSSAAF->>AAA-P: 5. DER + AAA-P->>NSS-AAA: 6. DER + NSS-AAA->>AAA-P: 7. DEA + AAA-P-->>NSSAAF: 8. DEA + NSSAAF-->>AMF: 9. Nnssaaaf_NSSAA_Authenticate response + AMF->>UE: 10. NAS Network Slice-Specific Authentication Command + UE-->>AMF: 11. NAS Network Slice-Specific Authentication Complete + AMF->>NSSAAF: 12. Nnssaaaf_NSSAA_Authenticate request + NSSAAF->>AAA-P: 13. DER + AAA-P->>NSS-AAA: 14. DER + NSS-AAA->>AAA-P: 15. DEA + AAA-P-->>NSSAAF: 16. DEA + NSSAAF-->>AMF: 17. Nnssaaaf_NSSAA_Authenticate response + AMF->>UE: 18. NAS Network Slice-Specific Authentication Result + +``` + +Sequence diagram of network slice specific authentication and authorization procedure (Diameter). + +Figure 17.2.1-1: Network slice specific authentication and Authorization procedure (Diameter) + +### 17.2.2 NSS-AAA initiated revocation of network slice authorization + +The NSS-AAA server may send a Diameter ASR message to the NSSAAF directly or via AAA-P (if AAA-P is used) asking for revocation of network slice authorization. On receipt of the ASR message from the NSS-AAA server, the NSSAAF shall release the corresponding resources, interact with its succeeding Network Function AMF which is got from the UDM by Nudm\_UECM\_GET service operation with GPSI and reply with a Diameter ASA message. It is not necessary for the NSSAAF to wait for the response (i.e. Nudm\_UECM\_GET or Nnssaaaf\_NSSAA\_Notify response) from its succeeding Network Function before sending the ASA message to the NSS-AAA server or AAA-P. + +Figure 17.2.2-1 is an example message flow to show the procedure of NSS-AAA initiated revocation of network slice authorization. If the AAA-P is not used, the ASR and ASA messages are exchanged between the NSS-AAA and the NSSAAF. + +![Sequence diagram of NSS-AAA initiated revocation of network slice authorization with Diameter.](9b686adccf125267a013fa25721231a3_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant UDM + participant NSSAAF + participant AAA-P + participant NSS-AAA + + NSS-AAA->>AAA-P: Diameter ASR + AAA-P-->>NSSAAF: Diameter ASR + NSSAAF->>UDM: Nudm_UECM_GET + UDM-->>NSSAAF: + NSSAAF->>AMF: Nausf_NSSAA_Notify + AMF-->>NSSAAF: + NSSAAF-->>AAA-P: Diameter ASA + AAA-P->>NSS-AAA: Diameter ASA + +``` + +Sequence diagram of NSS-AAA initiated revocation of network slice authorization with Diameter. + +Figure 17.2.2-1: NSS-AAA initiated revocation of network slice authorization with Diameter + +### 17.2.3 NSS-AAA initiated re-authentication and re-authorization + +The NSS-AAA server may send a Diameter RAR message to the NSSAAF directly or via AAA-P (if AAA-P is used) asking for re-authentication and re-authorization. On receipt of the RAR message from the NSS-AAA server, the NSSAAF shall interact with its succeeding Network Function AMF which is got from the UDM by Nudm\_UECM\_GET service operation with GPSI and reply with a Diameter RAA message. It is not necessary for the NSSAAF to wait for the response (i.e. Nudm\_UECM\_GET or NnssAAF\_NSSAA\_Notify response) from its succeeding Network Function before sending the RAA message to the NSS-AAA server or AAA-P. + +After replying NnssAAF\_NSSAA\_Notify response, the AMF shall start authentication and authorization procedure as described in clause 17.2.1. The Auth-Request-Type in the DER is set to "AUTHORIZE\_AUTHENTICATE". + +Figure 17.2.3-1 is an example message flow to show the procedure of NSS-AAA initiated re-authentication and re-authorization. If the AAA-P is not used, the RAR and RAA messages are exchanged between the NSS-AAA and the NSSAAF. + +![Sequence diagram showing NSS-AAA initiated re-authentication and re-authorization. Lifelines: AMF, UDM, NSSAAF, AAA-P (dashed), NSS-AAA. The process starts with a Diameter RAR from NSS-AAA to AAA-P, then to NSSAAF. NSSAAF sends Nudm_UECM_GET to UDM, which responds. NSSAAF then sends Diameter RAA to AAA-P, which forwards it to NSS-AAA. Finally, NSSAAF sends Nausf_NSSAA_Notify to AMF, which triggers the 'AMF initiated Network Slice-Specific Authentication and Authorization'.](e29665b8abcea967ef289c6aff07ae4c_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant UDM + participant NSSAAF + participant AAA-P as AAA-P + participant NSS-AAA + + Note right of AMF: AMF initiated Network Slice-Specific Authentication and Authorization + + NSS-AAA->>AAA-P: Diameter RAR + AAA-P-->>NSSAAF: Diameter RAR + NSSAAF->>UDM: Nudm_UECM_GET + UDM-->>NSSAAF: + NSSAAF-->>AAA-P: Diameter RAA + AAA-P->>NSS-AAA: Diameter RAA + NSSAAF->>AMF: Nausf_NSSAA_Notify + +``` + +Sequence diagram showing NSS-AAA initiated re-authentication and re-authorization. Lifelines: AMF, UDM, NSSAAF, AAA-P (dashed), NSS-AAA. The process starts with a Diameter RAR from NSS-AAA to AAA-P, then to NSSAAF. NSSAAF sends Nudm\_UECM\_GET to UDM, which responds. NSSAAF then sends Diameter RAA to AAA-P, which forwards it to NSS-AAA. Finally, NSSAAF sends Nausf\_NSSAA\_Notify to AMF, which triggers the 'AMF initiated Network Slice-Specific Authentication and Authorization'. + +Figure 17.2.3-1: NSS-AAA initiated re-authentication and re-authorization with Diameter + +## 17.3 Specific AVPs + +There is no specific AVP defined in the present release. + +## 17.4 re-used AVPs + +### 17.4.1 General + +Information defined in clause 12.4.0 are re-used for network slice specific authentication with the following differences: + +- NSSAAF replaces SMF. +- IP, Ethernet and PDU session related descriptions and AVPs are not applicable. +- Additional detailed information needed for network slice specific authentication are described below. + +**Table 17.4-1: Additional information needed for network slice specific authentication** + +| Attribute Name | AVP Code | Section defined | Value Type (NOTE 2) | AVP Flag rules (NOTE 1) | | | | May Encr. | Applicability | +|----------------|----------|-----------------|---------------------|-------------------------|-----|------------|----------|-----------|---------------| +| | | | | Must | May | Should not | Must not | | | +| 3GPP-S-NSSAI | 200 | X.3.1 (NOTE 3) | UTF8String | V | P | | M | Y | | + +NOTE 1: The AVP header bit denoted as 'M', indicates whether support of the AVP is required. The AVP header bit denoted as 'V', indicates whether the optional Vendor-ID field is present in the AVP header. For further details, see IETF RFC 6733 [24]. + +NOTE 2: The value types are defined in IETF RFC 6733 [24]. + +NOTE 3: The use of Radius VSA as a Diameter vendor AVP is described in Diameter NASREQ (IETF RFC 7155 [23]) and the P flag may be set. + +### 17.4.2 Use of the Supported-Features AVP + +The Supported-Features AVP is used during the network slice specific authentication procedure to inform the destination host about the required and optional features that the origin host supports. The client shall, in the first request in a Diameter session indicate the set of supported features. The server shall, in the first answer within the Diameter session indicate the set of features that it has in common with the client and that the server shall support within the same Diameter session. Any further command messages shall always be compliant with the list of supported features indicated in the Supported-Features AVPs during session establishment. Features that are not advertised as supported shall not be used to construct the command messages for that Diameter session. Unless otherwise stated, the use of the Supported-Features AVP shall be compliant with the requirements for dynamic discovery of supported features and associated error handling on the Cx reference point as defined in clause 7.2.1 of 3GPP TS 29.229 [41]. + +The base functionality is the 3GPP Rel-16 standard and a feature is an extension to that functionality. If the origin host does not support any features beyond the base functionality, the Supported-Features AVP may be absent in the DER command. As defined in clause 7.1.1 of 3GPP TS 29.229 [41], when extending the application by adding new AVPs for a feature, the new AVPs shall have the M bit cleared and the AVP shall not be defined mandatory in the command ABNF. + +As defined in 3GPP TS 29.229 [41], the Supported-Features AVP is of type grouped and contains the Vendor-Id, Feature-List-ID and Feature-List AVPs. The Supported-Features AVP is used to identify features that have been defined by 3GPP and hence, for features defined in this document, the Vendor-Id AVP shall contain the vendor ID of 3GPP (10415). If there are multiple feature lists defined, the Feature-List-ID AVP shall differentiate those lists from one another. + +On receiving an initial request application message, the destination host shall act as defined in clause 7.2.1 of 3GPP TS 29.229 [41]. + +Once the NSSAAF or AAA-P and NSS-AAA have negotiated the set of supported features during session establishment, the set of common features shall be used during the lifetime of the Diameter session. + +The table below defines the features applicable for the network slice specific authentication, for the feature lists with a Feature-List-ID of 1. + +**Table 17.4.2-1: Features of Feature-List-ID 1** + +| Feature bit | Feature | M/O | Description | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|-----|-------------| +| Feature bit: The order number of the bit within the Feature-List AVP where the least significant bit is assigned number "0".
Feature: A short name that can be used to refer to the bit and to the feature, e.g. "5GC".
M/O: Defines if the implementation of the feature is mandatory ("M") or optional ("O") in this 3GPP Release.
Description: A clear textual description of the feature. | | | | + +## 17.5 Specific Experimental-Result-Code AVP + +There is no specific experimental result code AVP defined in the present release. + +## 17.6 Diameter messages + +### 17.6.1 General + +Diameter messages as defined in subclause 12.6 are re-used for network slice specific authentication with the following differences: + +- NSSAAF or AAA-P replaces SMF. +- IP, Ethernet and PDU session related descriptions and AVPs are not applicable. +- Diameter commands for accounting function (ACR and ACA) are not applicable. +- AAR and AAA commands are not applicable. +- 3GPP-S-NSSAI is included in the DER command. + +NOTE: The presence of 3GPP-S-NSSAI in the DER command is optional but it is mandatory for the NSSAAF or AAA-P to include it for the network slice specific authentication. + +# --- Annex A (normative): Rate control related to 5G Cellular Internet of Things (CIoT) optimisations + +## A.1 General + +The present annex defines specific requirements for rate control related to 5G CIoT optimisations. + +## --- A.2 Support of rate control of user data + +### A.2.1 General + +The rate of user data sent to and from a UE (e.g. a UE using 5G CIoT Optimizations) can be controlled in two different ways: + +- Serving PLMN rate control +- Small data rate control + +Serving PLMN rate control is further described in 3GPP TS 23.501 [2]. + +Small data rate control allows HPLMN operators on per user to control the amount of user data sent DL and UL. This is done with help of policing user data on a maximum number of user data packets per time unit both DL and UL. Small data DL rate control policing is done in the UPF or the NEF and the small data UL rate control policing is done in the UE. The UPF or NEF can also do small data UL rate control policing. + +For further information on small data rate control in the UE, see 3GPP TS 24.501 [42]. + +NOTE 1: Existing Session-AMBR mechanisms are not suitable for such a service since, for radio efficiency and UE battery life reasons, an AMBR of e.g. > 100kbit/s is desirable and such an AMBR translates to a potentially large daily data volume. + +NOTE 2: For serving PLMN rate control and small data rate control, whether the UPF or the NEF is used for data policing depends on the CIoT Optimizations mode that UE and network support (CP or UP Optimizations) and the UE subscription data. + +### A.2.2 Small Data Rate Control + +The small data rate control is configured in the (H-)SMF. + +The small data rate control parameters, if configured, shall consist of: + +- the maximum number of DL user data packets per time unit, +- the maximum number of UL user data packets per time unit, and +- the maximum number of additional UL exception reports per time unit. + +Possible time units shall be, minute, hour, day or week. + +If the small data rate control is supported by the UE as indicated in the Extended Protocol Configuration Options (ePCO) IE included in the PDU session establishment request and if the (H-)SMF is configured to use small data rate control, the (H-)SMF shall include the configured small data UL rate control parameters in the ePCO IE of the PDU session establishment reply, and send the configured small data DL rate control parameters and optionally the UL rate control parameters to the UPF or the NEF. The small data rate control parameters sent to UE, UPF or NEF may include a remaining small data rate control with validity time information that shall be applied first before applying the configured small data rate control parameters. + +NOTE 1: The (H-)SMF can receive small data rate control parameters from the AMF. + +See 3GPP TS 24.501 [42] for ePCO IE definition. + +If the small data UL rate control parameters are modified, the (H-)SMF shall initiate a PDU session modification procedure and include the small data UL rate control parameters in the ePCO IE. The (H-)SMF may also send the updated small data UL rate control parameters to the UPF or the NEF. + +If the small data DL rate control parameters are modified, the (H-)SMF shall send the updated small data DL rate control parameters to the UPF or the NEF. + +The UPF or the NEF shall enforce the small data DL rate control and may enforce the small data UL rate control per UE. + +NOTE 2: The UE locally enforces this uplink small data rate control instruction. The UE considers this small data rate control instruction as valid until it receives a new one from the (H-)SMF. + +### A.2.3 Serving PLMN Rate Control information handling + +The serving PLMN rate control is configured in the (V-)SMF and it applies per PDU session. + +This rate control is operator configurable and expressed as "X NAS Data PDUs per deci hour" where X is an integer that shall not be less than 10. There are separate limits for uplink and downlink NAS Data PDUs: + +If serving PLMN rate control information is received from the SMF, the UPF or the NEF shall store this information and use that for DL rate control enforcement for this UE. + +The UE shall enforce the serving PLMN UL rate control based on the rate control information received from the (V-)SMF. + +The (V-)SMF may also enforce the serving PLMN UL and/or DL rate control. + +If the UPF or the NEF previously have received Serving PLMN rate control information, it shall behave as follows: + +- If the UPF or the NEF receives new Serving PLMN rate control information from the SMF, it shall replace the old Serving PLMN rate control information with the new Serving PLMN rate control information and use that for DL rate control enforcement for this UE. +- If the UPF or the NEF receives no Serving PLMN rate control information from the SMF, it shall still consider the latest received Serving PLMN rate control information from the SMF as valid. +- If UPF or the NEF receives an indication that Serving PLMN rate control does not apply from the SMF, it shall remove the rate control information based on Serving PLMN rate control information. + +Small data rate control, if configured, also applies for the same PDU session, see subclause A.2.2. + +# Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|--------|-----------|------|-----|-----|------------------------------------------------------------------------------------------------------------------------------------------------------------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | Cat | Subject/Comment | New | +| 2017-10 | | | | | | TS skeleton of interworking between 5G Network and external Data Networks | 0.0.0 | +| 2017-11 | CT3#92 | C3-175380 | | | | Update after CT3#92; inclusion of C3-175241, C3-175286, C3-175287, C3-175288, C3-175289. | 0.1.0 | +| 2017-12 | CT3#93 | C3-176400 | | | | Update after CT3#93; TS number changed to 29.561 and inclusion of C3-176265, C3-176266. | 0.2.0 | +| 2018-01 | CT3#94 | C3-180365 | | | | Update after CT3#94; inclusion of C3-180264, C3-180126, C3-180348, C3-180129, C3-180130. | 0.3.0 | +| 2018-03 | CT3#95 | C3-181371 | | | | Update after CT3#95; inclusion of C3-181043, C3-181044, C3-181261, C3-181047, C3-181099. | 0.4.0 | +| 2018-04 | CT3#96 | C3-182519 | | | | Update after CT3#96; inclusion of C3-182183, C3-182381, C3-182382, C3-182383. | 0.5.0 | +| 2018-06 | CT3#97 | C3-183917 | | | | Update after CT3#97; inclusion of C3-183308, C3-183309, C3-183310, C3-183318, C3-183319, C3-183717, C3-183321, C3-183325, C3-183326, C3-183327, C3-183729. | 0.6.0 | +| 2018-06 | CT#80 | CP-181027 | | | | TS sent to plenary for approval | 1.0.0 | +| 2018-06 | CT#80 | CP-181027 | | | | TS approved by plenary | 15.0.0 | +| 2018-09 | CT#81 | CP-182015 | 0001 | 2 | F | Add multihoming support in IPv6 stateless address autoconfiguration | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0002 | 1 | F | IP address change | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0003 | 1 | F | MAC address change | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0004 | - | F | Final result of authentication/authorization from the DN-AAA – Receiving entity | 15.1.0 | +| 2019-06 | CT#84 | CP-191188 | 0006 | 4 | F | Correct session AMBR | 15.2.0 | +| 2019-06 | CT#84 | CP-191070 | 0005 | - | B | Rate control for 5G CIoT | 16.0.0 | +| 2019-09 | CT#85 | CP-192150 | 0008 | | A | 3GPP VSA presence for RADIUS | 16.1.0 | +| 2019-09 | CT#85 | CP-192169 | 0010 | 1 | B | Add DN-AAA re-authentication | 16.1.0 | +| 2019-09 | CT#85 | CP-192150 | 0012 | | A | Correct DN-AAA authentication | 16.1.0 | +| 2019-09 | CT#85 | CP-192150 | 0014 | 2 | A | Correct DN-AAA authorization | 16.1.0 | +| 2019-09 | CT#85 | CP-192137 | 0017 | 1 | F | Correct small data rate control status | 16.1.0 | +| 2019-09 | CT#85 | CP-192159 | 0018 | 2 | B | IP address allocation via DHCP/AAA Server | 16.1.0 | +| 2019-09 | CT#85 | CP-192152 | 0019 | 1 | B | DN interworking of UPF for PIM | 16.1.0 | +| 2019-12 | CT#86 | CP-193200 | 0022 | 1 | B | Support Slice Specific authentication | 16.2.0 | +| 2020-03 | CT#87e | CP-200210 | 0023 | 2 | B | Call flows of NSSAA procedures | 16.3.0 | +| 2020-03 | CT#87e | CP-200198 | 0024 | - | F | Resolve editor note for PLMN rate control | 16.3.0 | +| 2020-03 | CT#87e | CP-200211 | 0025 | - | F | IP address pool id encoding | 16.3.0 | +| 2020-06 | CT#88e | CP-201226 | 0027 | 1 | A | Correct access challenge | 16.4.0 | +| 2020-06 | CT#88e | CP-201247 | 0028 | - | B | Support secondary RAT data usage report | 16.4.0 | +| 2020-06 | CT#88e | CP-201236 | 0030 | - | F | Replacing AUSF by NSSAAF to support NSSAA | 16.4.0 | +| 2020-06 | CT#88e | CP-201237 | 0031 | - | F | IP address pool id in accounting and its IP version | 16.4.0 | +| 2020-06 | CT#88e | CP-201247 | 0033 | 1 | F | Correct AMF and SMF address | 16.4.0 | +| 2020-06 | CT#88e | CP-201274 | 0034 | 1 | B | Subscription trigger request UE IP address from DN-AAA server | 16.4.0 | +| 2020-06 | CT#88e | CP-201228 | 0035 | 1 | B | Ipv6 Prefix Delegation via DHCPv6 | 16.4.0 | +| 2020-06 | CT#88e | CP-201331 | 0036 | 1 | F | Remove the feature for ip address pool | 16.4.0 | +| 2020-09 | CT#89e | CP-202057 | 0040 | 1 | A | Correction to 3GPP-UE-MAC-Address | 16.5.0 | +| 2020-09 | CT#89e | CP-202057 | 0042 | 1 | A | Correction on the authentication and authorization procedure | 16.5.0 | +| 2020-09 | CT#89e | CP-202057 | 0046 | - | A | Correction to the Session-AMBR | 16.5.0 | +| 2020-09 | CT#89e | CP-202067 | 0049 | - | F | Add missing applicable messages for IP pool info | 16.5.0 | +| 2020-09 | CT#89e | CP-202081 | 0048 | 1 | F | List of allowed VLAN Ids within DN authorization data | 16.5.0 | +| 2020-09 | CT#89e | CP-202057 | 0054 | - | A | Correction on the authorization data | 16.5.0 | +| 2020-09 | CT#89e | CP-202060 | 0055 | - | F | RAT Type extension for 5WWC | 16.5.0 | +| 2020-09 | CT#89e | CP-202059 | 0056 | - | F | User Location extension for 5WWC | 16.5.0 | +| 2020-12 | CT#90e | CP-203121 | 0060 | - | A | Correction on the Acct-Session-Id | 16.6.0 | +| 2020-12 | CT#90e | CP-203143 | 0064 | 1 | F | Correct SGSN address | 16.6.0 | +| 2020-12 | CT#90e | CP-203123 | 0066 | 1 | F | Correct applicability for User Location extension | 16.6.0 | +| 2020-12 | CT#90e | CP-203150 | 0067 | - | F | Correct network identifier for SNPn | 16.6.0 | +| 2020-12 | CT#90e | CP-203123 | 0069 | - | F | Updates to IPv6 Prefix Delegation | 16.6.0 | +| 2020-12 | CT#90e | CP-203099 | 0072 | 2 | A | Correction on PAP/CHAP supporting Rel-15 N1 mode UE | 16.6.0 | +| 2021-03 | CT#91e | CP-210202 | 0095 | - | F | Reporting GCI to RADIUS DN-AAA server | 16.7.0 | +| 2021-03 | CT#91e | CP-210202 | 0096 | - | F | Reporting GCI to Diameter DN-AAA server | 16.7.0 | +| 2021-06 | CT#92e | CP-211237 | 0099 | 1 | F | Clarify 5GS interworking with EPS for EAP based secondary AUTH in RADIUS message flow | 16.8.0 | +| 2021-06 | CT#92e | CP-211237 | 0101 | 1 | F | Clarify EPS interworking for EAP based secondary AUTH in Diameter message flow | 16.8.0 | +| 2021-06 | CT#92e | CP-211209 | 0104 | 1 | A | Correction to Framed IP | 16.8.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29562/05d8710f69c476939295486ab1440350_img.jpg b/marked/Rel-16/29_series/29562/05d8710f69c476939295486ab1440350_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..33e95cf3c0a0d28e22ee7c54fa46711c834d369e --- /dev/null +++ b/marked/Rel-16/29_series/29562/05d8710f69c476939295486ab1440350_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:32fd5c27424bcf30eb5b8d63a8826febac1202c2b750e9574d37a5a5b74b127a +size 37774 diff --git a/marked/Rel-16/29_series/29562/09955ff8214ffb6947951fc0f60eb6ab_img.jpg b/marked/Rel-16/29_series/29562/09955ff8214ffb6947951fc0f60eb6ab_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..afed819c623e58f5651f2a359e16dfdac7ddcdc9 --- /dev/null +++ b/marked/Rel-16/29_series/29562/09955ff8214ffb6947951fc0f60eb6ab_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6a3403665abf84564aef269547ccd5336bba4578011c8d4b26e57757dd1b75dc +size 24289 diff --git a/marked/Rel-16/29_series/29562/187d05bf7ead21e1394b61320d8b3632_img.jpg b/marked/Rel-16/29_series/29562/187d05bf7ead21e1394b61320d8b3632_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2a77d294ceaa60e0dbe3fa856bbab8a0e95ceb9f --- /dev/null +++ b/marked/Rel-16/29_series/29562/187d05bf7ead21e1394b61320d8b3632_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:aebc46c9a93bda7265a875a47d7c8c387beae9c02331fadcd934e99475c403a9 +size 27702 diff --git a/marked/Rel-16/29_series/29562/18e519d1f91133e080347562f681dfb5_img.jpg b/marked/Rel-16/29_series/29562/18e519d1f91133e080347562f681dfb5_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a6abc91fb2ea1119fdda06134924945f43a54fb7 --- /dev/null +++ b/marked/Rel-16/29_series/29562/18e519d1f91133e080347562f681dfb5_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:05084801830ee2006c24308f79c89bc51aef9d4fcc9cb18559d36b33778b4ce6 +size 28838 diff --git a/marked/Rel-16/29_series/29562/28d75f39a24203712ee907b32cf0bbe5_img.jpg b/marked/Rel-16/29_series/29562/28d75f39a24203712ee907b32cf0bbe5_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..fc236c31a3856066346242c7a10cac90a118c2da --- /dev/null +++ b/marked/Rel-16/29_series/29562/28d75f39a24203712ee907b32cf0bbe5_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d6828fa01d6320cc3246d5c0799a4e59cd2b6d4e1ab6b8e279e847d4e9e48d55 +size 35538 diff --git a/marked/Rel-16/29_series/29562/2beb95006f1933bed737cfe1e6598db8_img.jpg b/marked/Rel-16/29_series/29562/2beb95006f1933bed737cfe1e6598db8_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0fa6e446cbe4cd5f66ede24a4bf8b5bb3eac4f5c --- /dev/null +++ b/marked/Rel-16/29_series/29562/2beb95006f1933bed737cfe1e6598db8_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:90f1b922441996d218549de1665e2675b686df2f2e31813dd4f20d78944e05df +size 31031 diff --git a/marked/Rel-16/29_series/29562/329c96049bb432e9c2cbda4e224a0c9c_img.jpg b/marked/Rel-16/29_series/29562/329c96049bb432e9c2cbda4e224a0c9c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9818291133dfb32f5bba57522e47e7f6ef664849 --- /dev/null +++ b/marked/Rel-16/29_series/29562/329c96049bb432e9c2cbda4e224a0c9c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:357fa6d5f95a2fd3c954bc21fb8b8b87d8759c4f8ec3f71317ad32a5f48b2b18 +size 35074 diff --git a/marked/Rel-16/29_series/29562/32ff77da4286b58c4778033acaa10836_img.jpg b/marked/Rel-16/29_series/29562/32ff77da4286b58c4778033acaa10836_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f4285a4fbcdb3aba31ee4308d3dd85888b775e69 --- /dev/null +++ b/marked/Rel-16/29_series/29562/32ff77da4286b58c4778033acaa10836_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d7ba260173a6390da1ad4dd75c8125a8c9e12da8df77f3e381bc9576643862c7 +size 34141 diff --git a/marked/Rel-16/29_series/29562/409498e57b1f988b2b604d12cd997002_img.jpg b/marked/Rel-16/29_series/29562/409498e57b1f988b2b604d12cd997002_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9005fa23c2a0edd6f81ef08b33c81d0f071d6d83 --- /dev/null +++ b/marked/Rel-16/29_series/29562/409498e57b1f988b2b604d12cd997002_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8b50d78ea558962adc5d252463accc8db063736f208a849a0014748fbcf541c6 +size 26232 diff --git a/marked/Rel-16/29_series/29562/40f30e4d577a17052f8b1e6dc802a0d8_img.jpg b/marked/Rel-16/29_series/29562/40f30e4d577a17052f8b1e6dc802a0d8_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d358ae981356295a09565bd12dbc2b1519f18421 --- /dev/null +++ b/marked/Rel-16/29_series/29562/40f30e4d577a17052f8b1e6dc802a0d8_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0c467316249ffcaf7a195d0e7911e95c861e52797f728e0c83d11afadd6bba3d +size 37764 diff --git a/marked/Rel-16/29_series/29562/42e18c25bfd455a5a57f207bacfcb970_img.jpg b/marked/Rel-16/29_series/29562/42e18c25bfd455a5a57f207bacfcb970_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6f772fe33d88e5db49cdedbead191a69c0f6f262 --- /dev/null +++ b/marked/Rel-16/29_series/29562/42e18c25bfd455a5a57f207bacfcb970_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ca09e12e8899b918b6db8cbaacd86eeb4240b69ac1ee4fafb7720692ae364aff +size 32837 diff --git a/marked/Rel-16/29_series/29562/4af57aad638888edf2062306f8a54a6c_img.jpg b/marked/Rel-16/29_series/29562/4af57aad638888edf2062306f8a54a6c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9f3f4f67197eb2163b6932312a7bd4f3df2d80ef --- /dev/null +++ b/marked/Rel-16/29_series/29562/4af57aad638888edf2062306f8a54a6c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:73b124cb82743e758c4a64bc9948aea72b4d573f2580d65db44cb3b6895d8c26 +size 27696 diff --git a/marked/Rel-16/29_series/29562/4c9ba399ca7df11cbe9b6322cd9aee0a_img.jpg b/marked/Rel-16/29_series/29562/4c9ba399ca7df11cbe9b6322cd9aee0a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..757610278fd7442e5b561004f47514e6fd7cec6f --- /dev/null +++ b/marked/Rel-16/29_series/29562/4c9ba399ca7df11cbe9b6322cd9aee0a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:34dfacf5f7afc78dac3d008ef03871df8c862b31a533756dad5c48c83bb183fc +size 30297 diff --git a/marked/Rel-16/29_series/29562/4cc7cdce3d498d8b0ba033a9be24ade5_img.jpg b/marked/Rel-16/29_series/29562/4cc7cdce3d498d8b0ba033a9be24ade5_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4b4b9b1e3cef2d8447e2e530ab24136392697b6a --- /dev/null +++ b/marked/Rel-16/29_series/29562/4cc7cdce3d498d8b0ba033a9be24ade5_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1c3b22c327246906bca2670aeb580d6cc3f1a8428896fd43538bcbf95854d33e +size 35364 diff --git a/marked/Rel-16/29_series/29562/4cde160bcc69b7b6c81b648dd0e4252e_img.jpg b/marked/Rel-16/29_series/29562/4cde160bcc69b7b6c81b648dd0e4252e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d47438bb1fe83c990d5217eebe983c8fc62cf525 --- /dev/null +++ b/marked/Rel-16/29_series/29562/4cde160bcc69b7b6c81b648dd0e4252e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:daf43f12e749ed886e22326c80e11d59feda711abd430a2f4ff015ea26ae1930 +size 31405 diff --git a/marked/Rel-16/29_series/29562/4e85fe330de2c4f5eea6de4b2a53c77f_img.jpg b/marked/Rel-16/29_series/29562/4e85fe330de2c4f5eea6de4b2a53c77f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..764a3330f336bcb8d76e085688f48592e6dba32f --- /dev/null +++ b/marked/Rel-16/29_series/29562/4e85fe330de2c4f5eea6de4b2a53c77f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9225629280c70ce0cda69742773a308a6e5b2cbe331493b3661ef3c3bbb93419 +size 39347 diff --git a/marked/Rel-16/29_series/29562/57939c16065211317c5442cf2a4009e0_img.jpg b/marked/Rel-16/29_series/29562/57939c16065211317c5442cf2a4009e0_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a9cdb285c4eca443d4ee56b822f7c4cd058783e3 --- /dev/null +++ b/marked/Rel-16/29_series/29562/57939c16065211317c5442cf2a4009e0_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:dfd85edc3b12a02f689468204baf4ea2f1dde19d796179697dcef2fe600d59d6 +size 96381 diff --git a/marked/Rel-16/29_series/29562/5879500ca01e1a2521654beff6c289a4_img.jpg b/marked/Rel-16/29_series/29562/5879500ca01e1a2521654beff6c289a4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..292e5d17cbed79cb4b71b2b0a8f2936f77ad7026 --- /dev/null +++ b/marked/Rel-16/29_series/29562/5879500ca01e1a2521654beff6c289a4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ea8f701c574ab44a3c462cf1074d22c18c4ed68a5c877197306204461241f16d +size 35168 diff --git a/marked/Rel-16/29_series/29562/5c3dd31372f59e15250f0ab1613ca485_img.jpg b/marked/Rel-16/29_series/29562/5c3dd31372f59e15250f0ab1613ca485_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2f8e8d5b97c18b092a6ee9a5819ccfe6f860f897 --- /dev/null +++ b/marked/Rel-16/29_series/29562/5c3dd31372f59e15250f0ab1613ca485_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fbc8926da873db9d05a4d7fc575eedfe0d3c56bb4fc3fe1b11edfdba9f6261fb +size 26576 diff --git a/marked/Rel-16/29_series/29562/5cb74e3ca5034698d7eab12de06f8763_img.jpg b/marked/Rel-16/29_series/29562/5cb74e3ca5034698d7eab12de06f8763_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..035516a033cd0ad694abe557b5bb193d9d99f3cc --- /dev/null +++ b/marked/Rel-16/29_series/29562/5cb74e3ca5034698d7eab12de06f8763_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:87ea72fa0831864269dfa61b9a2895a124b2a70bc33e6255e8c976da4ca96e3b +size 25175 diff --git a/marked/Rel-16/29_series/29562/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-16/29_series/29562/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c953d2ae8f6ab27e4f9d751dad1c66f129192ebf --- /dev/null +++ b/marked/Rel-16/29_series/29562/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f8f9a8e3bbaffa3899f4e5812a3ee8479c8b87ff268b1210b69c4487dcfee91d +size 9500 diff --git a/marked/Rel-16/29_series/29562/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-16/29_series/29562/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ef78a7d23955f9865e402be795120880a38bf4a0 --- /dev/null +++ b/marked/Rel-16/29_series/29562/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2c0ab614cba997728feceaabf0fb7093965b5c37587101802148182ab06cdd36 +size 5672 diff --git a/marked/Rel-16/29_series/29562/6584b95e34ea1f0b67144aa841db0863_img.jpg b/marked/Rel-16/29_series/29562/6584b95e34ea1f0b67144aa841db0863_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4a501700680ef4c2c7682c1a2dee3834ebad24ae --- /dev/null +++ b/marked/Rel-16/29_series/29562/6584b95e34ea1f0b67144aa841db0863_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5e549956ee85abca5f5e7beae7a7adb81d588c9890b6521228bea7162866b52f +size 24506 diff --git a/marked/Rel-16/29_series/29562/6929132b4964d52244da61d4614bc4d6_img.jpg b/marked/Rel-16/29_series/29562/6929132b4964d52244da61d4614bc4d6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4f1189121081d243c0b5d6c9d87809f0b24d3246 --- /dev/null +++ b/marked/Rel-16/29_series/29562/6929132b4964d52244da61d4614bc4d6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:44c461f73c240ca661490aef3e374f430cdb8218ac5b66daa041c4c694ea0447 +size 31015 diff --git a/marked/Rel-16/29_series/29562/6a555cff11e140861ce08db72b01a6a2_img.jpg b/marked/Rel-16/29_series/29562/6a555cff11e140861ce08db72b01a6a2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2a82c2d161d65724b6cd3f42108a12b4d2c06d5f --- /dev/null +++ b/marked/Rel-16/29_series/29562/6a555cff11e140861ce08db72b01a6a2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4d923666fa072cd46055835eb6967d1be2c970ad6813db90932c6fc9a4971fe5 +size 24301 diff --git a/marked/Rel-16/29_series/29562/6c6d2bce2630f62fb3a5345c9ec84f68_img.jpg b/marked/Rel-16/29_series/29562/6c6d2bce2630f62fb3a5345c9ec84f68_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e1340b22f49da12234d4825e48a2f238b62b459d --- /dev/null +++ b/marked/Rel-16/29_series/29562/6c6d2bce2630f62fb3a5345c9ec84f68_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e169ff18b5eb03180aff31679c98871460f25abf79682ced67a275c42259970b +size 28479 diff --git a/marked/Rel-16/29_series/29562/6e15fc9ea763541c5913d26f85072ae1_img.jpg b/marked/Rel-16/29_series/29562/6e15fc9ea763541c5913d26f85072ae1_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7d32c73d4c5fb3da21e0b7b837071701f389e31e --- /dev/null +++ b/marked/Rel-16/29_series/29562/6e15fc9ea763541c5913d26f85072ae1_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e0a7a446473d251189cb2fd16a2cb43fac65f92a400c59aac95575f25f761e63 +size 29055 diff --git a/marked/Rel-16/29_series/29562/6efcea66501271e9ea36cf33982f08d5_img.jpg b/marked/Rel-16/29_series/29562/6efcea66501271e9ea36cf33982f08d5_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..252dd597ec403f10c6db2035c2194da2ec138a74 --- /dev/null +++ b/marked/Rel-16/29_series/29562/6efcea66501271e9ea36cf33982f08d5_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d8faf0f5a86c8019f65526ffc7596bf361018c1618ea45574ca3ae66a2c0d47a +size 23523 diff --git a/marked/Rel-16/29_series/29562/78ff716475b2f65bf01c3a4d02d89fc4_img.jpg b/marked/Rel-16/29_series/29562/78ff716475b2f65bf01c3a4d02d89fc4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..954d4bf709bbfd86eddd7fb36e0cef7bb13a652e --- /dev/null +++ b/marked/Rel-16/29_series/29562/78ff716475b2f65bf01c3a4d02d89fc4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4a1dbe6348861e6608fd47328746da9ccb009233c837ec2de956dc84fd3b3a20 +size 30183 diff --git a/marked/Rel-16/29_series/29562/7d2d1d3870cd224c4430d19334557716_img.jpg b/marked/Rel-16/29_series/29562/7d2d1d3870cd224c4430d19334557716_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e1b16b42277d439a431a7cea5b557c4990339ff1 --- /dev/null +++ b/marked/Rel-16/29_series/29562/7d2d1d3870cd224c4430d19334557716_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c5dd59a3373d5b696e54e0ea31d23b1ba13a60bb8ce4e78420bc52e7fd094e2c +size 29876 diff --git a/marked/Rel-16/29_series/29562/822e033872d5ab16e861571f47b81ba7_img.jpg b/marked/Rel-16/29_series/29562/822e033872d5ab16e861571f47b81ba7_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..960b1a5071b8531e69aaf53e579a03d859cf08a5 --- /dev/null +++ b/marked/Rel-16/29_series/29562/822e033872d5ab16e861571f47b81ba7_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:93d97b95c056a72e3a704771091eb877d901de96af998d2b231252e82a032db6 +size 39462 diff --git a/marked/Rel-16/29_series/29562/8307f6b04df072c9332f9987e034272c_img.jpg b/marked/Rel-16/29_series/29562/8307f6b04df072c9332f9987e034272c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..80a1f214437c931754cfcd0a1dc5071b7cd0e946 --- /dev/null +++ b/marked/Rel-16/29_series/29562/8307f6b04df072c9332f9987e034272c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c1f6089698734093767946b887c6101c54e93b6876445cc042c1374e97ab4045 +size 18754 diff --git a/marked/Rel-16/29_series/29562/836b0790cef5469a167fa8931df4e408_img.jpg b/marked/Rel-16/29_series/29562/836b0790cef5469a167fa8931df4e408_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a82492354f391efa54ff9c15fb401f708b9472b4 --- /dev/null +++ b/marked/Rel-16/29_series/29562/836b0790cef5469a167fa8931df4e408_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7833e7092c8a75f0cdc8fbaeddd15a9d5a9ccad02ba218a67ff28b0fa0f7fd5d +size 27620 diff --git a/marked/Rel-16/29_series/29562/84e5b251aa38db522f76f5cc3afcb853_img.jpg b/marked/Rel-16/29_series/29562/84e5b251aa38db522f76f5cc3afcb853_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8bf648b79774da1af0c8362911eedae8217197fc --- /dev/null +++ b/marked/Rel-16/29_series/29562/84e5b251aa38db522f76f5cc3afcb853_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fd88a989c10ef1afa54bf2f69370005fa4953835d58e969415777d89c4e1fa55 +size 28767 diff --git a/marked/Rel-16/29_series/29562/896e86ed12aff206d302c64f2e3091fa_img.jpg b/marked/Rel-16/29_series/29562/896e86ed12aff206d302c64f2e3091fa_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..32d6a2b4c40c3384b7df0b44438de05480ab895a --- /dev/null +++ b/marked/Rel-16/29_series/29562/896e86ed12aff206d302c64f2e3091fa_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a19c19ae7013c814cce2fca333a05f697d242117ce953cc406def2830c726e71 +size 27522 diff --git a/marked/Rel-16/29_series/29562/8d29ec5c528f84817da9cac1e9e9f3f1_img.jpg b/marked/Rel-16/29_series/29562/8d29ec5c528f84817da9cac1e9e9f3f1_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..cdd74031868f024b905cdcfda3e8764c14f9094f --- /dev/null +++ b/marked/Rel-16/29_series/29562/8d29ec5c528f84817da9cac1e9e9f3f1_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cd33829114c88bbcb493ee8c511d3ba5b47a1e4c64d5976cea07322f1474a40c +size 5093 diff --git a/marked/Rel-16/29_series/29562/8d8c758885b4f754ff071bf3b572ab3c_img.jpg b/marked/Rel-16/29_series/29562/8d8c758885b4f754ff071bf3b572ab3c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..25de7cd6de40c9965ceda73781224aea7bbeb2e5 --- /dev/null +++ b/marked/Rel-16/29_series/29562/8d8c758885b4f754ff071bf3b572ab3c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:38d435d8804efa2c011c253f450643de9f15d971f506fe24fb0bba04d4fb527c +size 31416 diff --git a/marked/Rel-16/29_series/29562/8dd83c9e4e123aaaf3d521db1c4c416d_img.jpg b/marked/Rel-16/29_series/29562/8dd83c9e4e123aaaf3d521db1c4c416d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..32cdcb06e2f26dbc0c35613058f1c809e4daf072 --- /dev/null +++ b/marked/Rel-16/29_series/29562/8dd83c9e4e123aaaf3d521db1c4c416d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c097c0bb0fa1c395640003196b7bd1afe5ea4d28fa438ae31aa673351ba0edec +size 26959 diff --git a/marked/Rel-16/29_series/29562/901800172164e0494762ffa57a09993f_img.jpg b/marked/Rel-16/29_series/29562/901800172164e0494762ffa57a09993f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..eeeb922c6ae9b3191bfb213819462af381ce2492 --- /dev/null +++ b/marked/Rel-16/29_series/29562/901800172164e0494762ffa57a09993f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:99878bec757cd9d93f2f4d11ee1ea1a351be0685c82142adc738a98ab03f7e5f +size 32061 diff --git a/marked/Rel-16/29_series/29562/9252ccfbbe9e34cb108f0060f2b563f1_img.jpg b/marked/Rel-16/29_series/29562/9252ccfbbe9e34cb108f0060f2b563f1_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e02785b47b4c116e15e4a53708647771b1761fdb --- /dev/null +++ b/marked/Rel-16/29_series/29562/9252ccfbbe9e34cb108f0060f2b563f1_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:91a849fd494b8e4f1847c5ea676620a2c01a863b13fdd778e7e445b3ab0c4351 +size 40970 diff --git a/marked/Rel-16/29_series/29562/9b686adccf125267a013fa25721231a3_img.jpg b/marked/Rel-16/29_series/29562/9b686adccf125267a013fa25721231a3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..53cf33d2e8d5b4c723f6028d1257a6726233ae7b --- /dev/null +++ b/marked/Rel-16/29_series/29562/9b686adccf125267a013fa25721231a3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3915924fcff0c485ee93167e4ec9bff65beb761a29c8b5d31b081b025c5695a3 +size 37997 diff --git a/marked/Rel-16/29_series/29562/a3b3abbf6d0b18f3dd4a83680b5e3e42_img.jpg b/marked/Rel-16/29_series/29562/a3b3abbf6d0b18f3dd4a83680b5e3e42_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..382fc2a6cd26ef638d86719a031ac51cff56e068 --- /dev/null +++ b/marked/Rel-16/29_series/29562/a3b3abbf6d0b18f3dd4a83680b5e3e42_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:72a76877dab9c3af055419494a2ac1d419cf33910298a13494cab7fb189bf51a +size 24331 diff --git a/marked/Rel-16/29_series/29562/a51105b2031bad93b818b82f071c6add_img.jpg b/marked/Rel-16/29_series/29562/a51105b2031bad93b818b82f071c6add_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a546aab77a9193f484798c783fa475f6ee1eec58 --- /dev/null +++ b/marked/Rel-16/29_series/29562/a51105b2031bad93b818b82f071c6add_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:75cb85243d767467844aea463dfcd36cb6a9daa5641021ab6b8be1b65d626b00 +size 35069 diff --git a/marked/Rel-16/29_series/29562/a89d151b67109378baed0c117830cf78_img.jpg b/marked/Rel-16/29_series/29562/a89d151b67109378baed0c117830cf78_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..cd3a83ffb2ab93640e257c1680421b7ce3d597f5 --- /dev/null +++ b/marked/Rel-16/29_series/29562/a89d151b67109378baed0c117830cf78_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:07d3dbbd9bcc0f64c148683d618cebcf15b4eae39b5ab23c54d40ff42ef4b076 +size 27502 diff --git a/marked/Rel-16/29_series/29562/adc59ed6840bcb2d392ea323abfccedc_img.jpg b/marked/Rel-16/29_series/29562/adc59ed6840bcb2d392ea323abfccedc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..70fb38fa53b9f01b4bc21fcdc088d45f439fdda2 --- /dev/null +++ b/marked/Rel-16/29_series/29562/adc59ed6840bcb2d392ea323abfccedc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cc11d6bea166044c0dd108fe21741ef286f06107cf1838d4afaa03a5e08fadf5 +size 26183 diff --git a/marked/Rel-16/29_series/29562/b0e32f17c90ce1db73135488888ce558_img.jpg b/marked/Rel-16/29_series/29562/b0e32f17c90ce1db73135488888ce558_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..27b5b3c24d64d222f8005b606be62efa79c6d6e7 --- /dev/null +++ b/marked/Rel-16/29_series/29562/b0e32f17c90ce1db73135488888ce558_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ecb14cdb88b3472e12690e564e4d76ba49660f8fd831effd1a212a02a7cc9016 +size 23448 diff --git a/marked/Rel-16/29_series/29562/b5335262987c819d7f71ce40f99cb71b_img.jpg b/marked/Rel-16/29_series/29562/b5335262987c819d7f71ce40f99cb71b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6017da6fe895df8bd4f162ee77046a17291c2c55 --- /dev/null +++ b/marked/Rel-16/29_series/29562/b5335262987c819d7f71ce40f99cb71b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bfb658f00344626b54c40095d02d6435dbefc2d63171fd91c1fbb1b378dd755a +size 31971 diff --git a/marked/Rel-16/29_series/29562/c468d53e877568cd7d8c5ba1632c2e65_img.jpg b/marked/Rel-16/29_series/29562/c468d53e877568cd7d8c5ba1632c2e65_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0e190cab8e15bada21ec36b93b54fbbad1e23ca9 --- /dev/null +++ b/marked/Rel-16/29_series/29562/c468d53e877568cd7d8c5ba1632c2e65_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7d13bfa036e95a490119b7d0c8e9cce3318a32094907778b7e27c6918dc9175e +size 36463 diff --git a/marked/Rel-16/29_series/29562/cad89c017c9e7c1785bcd104fde4e737_img.jpg b/marked/Rel-16/29_series/29562/cad89c017c9e7c1785bcd104fde4e737_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c6221e81653722b8810a56606c914559240bad26 --- /dev/null +++ b/marked/Rel-16/29_series/29562/cad89c017c9e7c1785bcd104fde4e737_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ad4ea7a80554d80f2f38bdea42753429c576bb966cfe75ee6b91386f5a280c8d +size 39177 diff --git a/marked/Rel-16/29_series/29562/d116934392360da963e91d840d1e45a8_img.jpg b/marked/Rel-16/29_series/29562/d116934392360da963e91d840d1e45a8_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..26cea0ae135a40bffe5e2b0a91d8145065cd83f9 --- /dev/null +++ b/marked/Rel-16/29_series/29562/d116934392360da963e91d840d1e45a8_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:758a91531860d80387eedf1259f045c246524a45f69adeb1b533faa7fa184322 +size 35924 diff --git a/marked/Rel-16/29_series/29562/dc1f232cfd39be5c20b21374ad4c04c0_img.jpg b/marked/Rel-16/29_series/29562/dc1f232cfd39be5c20b21374ad4c04c0_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..42f4daa4f19c4b46efb9fe5f7ec73afceeb97c7b --- /dev/null +++ b/marked/Rel-16/29_series/29562/dc1f232cfd39be5c20b21374ad4c04c0_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5c58512138f5231cdb1169b620059cf84da7fcb7350a11017d1191978b59bbe2 +size 34735 diff --git a/marked/Rel-16/29_series/29562/e38206fcefa2045af01d494b2956775a_img.jpg b/marked/Rel-16/29_series/29562/e38206fcefa2045af01d494b2956775a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8a8b81e25f6925501690fdd3ff517c13b5f812a9 --- /dev/null +++ b/marked/Rel-16/29_series/29562/e38206fcefa2045af01d494b2956775a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9ea156e81f09091afdd716480d60daaa82f594f77d830e9ed1bc54ed05ec5178 +size 25855 diff --git a/marked/Rel-16/29_series/29562/f0b7abcb093621bb310bf61fbe0f0d2d_img.jpg b/marked/Rel-16/29_series/29562/f0b7abcb093621bb310bf61fbe0f0d2d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7779274b04fdf63f39f1892d177338b04a490aaa --- /dev/null +++ b/marked/Rel-16/29_series/29562/f0b7abcb093621bb310bf61fbe0f0d2d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:789704414c2a8b59abc607abf6a7697006e29466ff99855c32e8916e320d26e2 +size 26037 diff --git a/marked/Rel-16/29_series/29562/f1091147d93cee4dfa88498610e395a7_img.jpg b/marked/Rel-16/29_series/29562/f1091147d93cee4dfa88498610e395a7_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b644a6bdda44b9f749a7edf7132683e51743d27a --- /dev/null +++ b/marked/Rel-16/29_series/29562/f1091147d93cee4dfa88498610e395a7_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5679e6cfc33c3e4190288ac47992c6f308b08e5d028907272780c1466914249a +size 26971 diff --git a/marked/Rel-16/29_series/29562/f24f909d837b5476783e1bbea2dfc143_img.jpg b/marked/Rel-16/29_series/29562/f24f909d837b5476783e1bbea2dfc143_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e2f5b24d90bd98cba6d7f50b61a8873c5d0639d7 --- /dev/null +++ b/marked/Rel-16/29_series/29562/f24f909d837b5476783e1bbea2dfc143_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9e2d33b83b33aac7441c4a0cc5ab101c23d08d84de30e2ec74284712142ef4e5 +size 41663 diff --git a/marked/Rel-16/29_series/29562/f324fbc5d5af1e4da9cd932389f0064c_img.jpg b/marked/Rel-16/29_series/29562/f324fbc5d5af1e4da9cd932389f0064c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e7fbd4793f4b47039f903b6862582197bbbe3029 --- /dev/null +++ b/marked/Rel-16/29_series/29562/f324fbc5d5af1e4da9cd932389f0064c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a120983b350f825897a444e1dab4a4db929dc3bae0dfb0d00cc6468f68fae30b +size 39642 diff --git a/marked/Rel-16/29_series/29562/ffb6acd27b8e3a54392840948a75869f_img.jpg b/marked/Rel-16/29_series/29562/ffb6acd27b8e3a54392840948a75869f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..850bddab319e4123f9b6df02514ee4d4fb7f1b5f --- /dev/null +++ b/marked/Rel-16/29_series/29562/ffb6acd27b8e3a54392840948a75869f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5d7824477bc630117e7e56470197ceeb634c20bfcd9aca9d449554f07ff40c7e +size 107810 diff --git a/marked/Rel-16/29_series/29562/raw.md b/marked/Rel-16/29_series/29562/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..ef7d90960e4135d31bd46f5d73f2349eb5297551 --- /dev/null +++ b/marked/Rel-16/29_series/29562/raw.md @@ -0,0 +1,12056 @@ +# 3GPP TS 29.562 V16.8.0 (2022-09) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Home Subscriber Server (HSS) services; Stage 3 (Release 16)** + +![5G logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The 5G logo, consisting of the text "5G" in a bold, black, sans-serif font. Above the "5G" text is a green graphic element consisting of three curved lines of increasing height, resembling a signal strength indicator or a stylized wave. + +5G logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, featuring the letters "3GPP" in a stylized, bold, black font. The "3" and "G" are connected at the top by a single horizontal line. Below the "P" is a red graphic element consisting of three curved lines of increasing height, similar to the 5G logo. Below the logo, the text "A GLOBAL INITIATIVE" is written in a smaller, all-caps, sans-serif font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|--------------------------------------------------------------------|----| +| Foreword..... | 12 | +| 1 Scope..... | 13 | +| 2 References..... | 13 | +| 3 Definitions of terms, symbols and abbreviations..... | 15 | +| 3.1 Terms..... | 15 | +| 3.2 Symbols..... | 15 | +| 3.3 Abbreviations..... | 16 | +| 4 Overview..... | 16 | +| 4.1 Introduction..... | 16 | +| 5 Services offered by the HSS..... | 17 | +| 5.1 Introduction..... | 17 | +| 5.2 Nhss_imsUEContextManagement Service..... | 18 | +| 5.2.1 Service Description..... | 18 | +| 5.2.2 Service Operations..... | 18 | +| 5.2.2.1 Introduction..... | 18 | +| 5.2.2.2 Registration..... | 18 | +| 5.2.2.2.1 General..... | 18 | +| 5.2.2.2.2 S-CSCF Registration..... | 19 | +| 5.2.2.3 DeregistrationNotification..... | 20 | +| 5.2.2.3.1 General..... | 20 | +| 5.2.2.3.2 HSS initiated Deregistration..... | 20 | +| 5.2.2.4 Deregistration..... | 20 | +| 5.2.2.4.1 General..... | 20 | +| 5.2.2.4.2 S-CSCF deregistration..... | 21 | +| 5.2.2.5 Authorize..... | 21 | +| 5.2.2.5.1 General..... | 21 | +| 5.2.2.5.2 Authorization request..... | 21 | +| 5.2.2.6 RestorationInfoGet..... | 22 | +| 5.2.2.6.1 General..... | 22 | +| 5.2.2.6.2 Restoration Information Retrieval..... | 22 | +| 5.2.2.7 RestorationInfoUpdate..... | 23 | +| 5.2.2.7.1 General..... | 23 | +| 5.2.2.7.2 Restoration Information Update..... | 23 | +| 5.2.2.8 RestorationInfoDelete..... | 24 | +| 5.2.2.8.1 General..... | 24 | +| 5.2.2.8.2 Restoration Information Delete..... | 24 | +| 5.3 Nhss_imsSubscriberDataManagement Service..... | 24 | +| 5.3.1 Service Description..... | 24 | +| 5.3.2 Service Operations..... | 25 | +| 5.3.2.1 Introduction..... | 25 | +| 5.3.2.2 Get..... | 25 | +| 5.3.2.2.1 General..... | 25 | +| 5.3.2.2.2 Identity Data..... | 26 | +| 5.3.2.2.2.1 IMS Identity Data Retrieval..... | 26 | +| 5.3.2.2.2.2 MSISDN(s) Retrieval..... | 27 | +| 5.3.2.2.2.3 Private Identities Retrieval..... | 27 | +| 5.3.2.2.2.4 IMEI(SV) Retrieval..... | 28 | +| 5.3.2.2.3 IMS Location Data and Status..... | 28 | +| 5.3.2.2.3.1 S-CSCF Capabilities Retrieval..... | 28 | +| 5.3.2.2.3.2 Server Name Retrieval..... | 29 | +| 5.3.2.2.3.3 IMS Registration Status Retrieval..... | 30 | +| 5.3.2.2.3.4 S-CSCF Selection Assistance Information Retrieval..... | 30 | +| 5.3.2.2.4 IMS Profile Data..... | 31 | +| 5.3.2.2.4.1 IMS User Profile Retrieval..... | 31 | +| 5.3.2.2.4.2 Service Priority Level Information Retrieval..... | 31 | + +| | | | +|-------------|----------------------------------------------------------------------------|----| +| 5.3.2.2.4.3 | Initial Filter Criteria Retrieval..... | 32 | +| 5.3.2.2.4.4 | Service Trace Level Information Retrieval..... | 32 | +| 5.3.2.2.5 | Access Data..... | 33 | +| 5.3.2.2.5.1 | Location Information Retrieval for CS/PS Domains..... | 33 | +| 5.3.2.2.5.2 | IP Address Information Retrieval..... | 34 | +| 5.3.2.2.5.3 | T-ADS Information Retrieval..... | 34 | +| 5.3.2.2.5.4 | User State Retrieval for CS/PS Domains..... | 35 | +| 5.3.2.2.5.5 | CSRN Retrieval..... | 36 | +| 5.3.2.2.5.6 | Reference Location Information Retrieval..... | 36 | +| 5.3.2.2.6 | SRVCC Data..... | 37 | +| 5.3.2.2.6.1 | SRVCC Data Retrieval..... | 37 | +| 5.3.2.2.7 | Service Data..... | 38 | +| 5.3.2.2.7.1 | PSI Activation State Retrieval..... | 38 | +| 5.3.2.2.7.2 | SMS Registration Information retrieval..... | 38 | +| 5.3.2.2.7.3 | DSAI Information retrieval..... | 39 | +| 5.3.2.2.8 | Repository Data..... | 39 | +| 5.3.2.2.8.1 | Repository Data Retrieval..... | 39 | +| 5.3.2.2.9 | Shared Subscription Data..... | 40 | +| 5.3.2.2.9.1 | Shared Subscription Data Retrieval..... | 40 | +| 5.3.2.3 | Subscribe..... | 41 | +| 5.3.2.3.1 | General..... | 41 | +| 5.3.2.3.2 | Subscription to notifications of data change..... | 41 | +| 5.3.2.3.3 | Subscription to notifications of shared data change..... | 41 | +| 5.3.2.3.4 | Subscriptions to notification of UE Reachability for IP..... | 42 | +| 5.3.2.4 | Unsubscribe..... | 43 | +| 5.3.2.4.1 | General..... | 43 | +| 5.3.2.4.2 | Unsubscribe to notifications of data change..... | 43 | +| 5.3.2.4.3 | Unsubscribe to notifications of shared data change..... | 43 | +| 5.3.2.4.4 | Unsubscribe to notification of UE Reachability for IP..... | 44 | +| 5.3.2.5 | ModifySubscription..... | 45 | +| 5.3.2.5.1 | General..... | 45 | +| 5.3.2.5.2 | Modification of a subscription to notifications of data change..... | 45 | +| 5.3.2.5.3 | Modification of a subscription to notifications of shared data change..... | 45 | +| 5.3.2.5.4 | Modification of a subscription to notifications of data change..... | 46 | +| 5.3.2.6 | Notification..... | 47 | +| 5.3.2.6.1 | General..... | 47 | +| 5.3.2.6.2 | Data Change Notification To NF..... | 47 | +| 5.3.2.6.3 | UE Reachability for IP Notification to NF..... | 47 | +| 5.3.2.7 | Update..... | 48 | +| 5.3.2.7.1 | General..... | 48 | +| 5.3.2.7.2 | Repository Data Creation or Update..... | 48 | +| 5.3.2.7.3 | Repository Data Deletion..... | 49 | +| 5.3.2.7.4 | STN-SR update..... | 49 | +| 5.3.2.7.5 | PSI activation state update..... | 50 | +| 5.3.2.7.6 | SMS Registration Information Creation or Update..... | 50 | +| 5.3.2.7.7 | SMS Registration Information Deletion..... | 51 | +| 5.3.2.7.8 | DSAI tag activation state update..... | 52 | +| 5.4 | Nhss_imsUEAuthentication Service..... | 52 | +| 5.4.1 | Service Description..... | 52 | +| 5.4.2 | Service Operations..... | 52 | +| 5.4.2.1 | Introduction..... | 52 | +| 5.4.2.2 | Get..... | 53 | +| 5.4.2.2.1 | General..... | 53 | +| 5.4.2.2.2 | Authentication Information Retrieval..... | 53 | +| 6 | API Definitions..... | 53 | +| 6.1 | Nhss_imsUEContextManagement Service API..... | 53 | +| 6.1.1 | Introduction..... | 53 | +| 6.1.2 | Usage of HTTP..... | 54 | +| 6.1.2.1 | General..... | 54 | +| 6.1.2.2 | HTTP standard headers..... | 54 | +| 6.1.2.2.1 | General..... | 54 | + +| | | | +|-------------|---------------------------------------------------------------------------------|----| +| 6.1.2.2.2 | Content type..... | 54 | +| 6.1.2.3 | HTTP custom headers..... | 54 | +| 6.1.2.3.1 | General..... | 54 | +| 6.1.3 | Resources..... | 55 | +| 6.1.3.1 | Overview..... | 55 | +| 6.1.3.2 | Resource: Scscf Registration..... | 55 | +| 6.1.3.2.1 | Description..... | 55 | +| 6.1.3.2.2 | Resource Definition..... | 55 | +| 6.1.3.2.3 | Resource Standard Methods..... | 56 | +| 6.1.3.2.3.1 | PUT..... | 56 | +| 6.1.3.2.4 | Resource Custom Operations..... | 57 | +| 6.1.3.3 | Resource: Scscf Restoration Information..... | 57 | +| 6.1.3.3.1 | Description..... | 57 | +| 6.1.3.3.2 | Resource Definition..... | 57 | +| 6.1.3.3.3 | Resource Standard Methods..... | 58 | +| 6.1.3.3.3.1 | GET..... | 58 | +| 6.1.3.3.3.2 | PUT..... | 59 | +| 6.1.3.3.3.3 | DELETE..... | 60 | +| 6.1.4 | Custom Operations without associated resources..... | 61 | +| 6.1.4.1 | Overview..... | 61 | +| 6.1.4.2 | Operation: Authorize..... | 61 | +| 6.1.4.2.1 | Description..... | 61 | +| 6.1.4.2.2 | Operation Definition..... | 61 | +| 6.1.5 | Notifications..... | 62 | +| 6.1.5.1 | General..... | 62 | +| 6.1.5.2 | Deregistration Notification..... | 62 | +| 6.1.6 | Data Model..... | 63 | +| 6.1.6.1 | General..... | 63 | +| 6.1.6.2 | Structured data types..... | 64 | +| 6.1.6.2.1 | Introduction..... | 64 | +| 6.1.6.2.2 | Type: AuthorizationRequest..... | 65 | +| 6.1.6.2.3 | Type: AuthorizationResponse..... | 65 | +| 6.1.6.2.4 | Type: ScscfRestorationInfo..... | 65 | +| 6.1.6.2.5 | Type: ScscfRestorationInfoRequest..... | 66 | +| 6.1.6.2.6 | Type: ScscfRestorationInfoResponse..... | 66 | +| 6.1.6.2.7 | Type: RestorationInfo..... | 66 | +| 6.1.6.2.8 | Type: UeSubscriptionInfo..... | 66 | +| 6.1.6.2.9 | Type: PscfSubscriptionInfo..... | 67 | +| 6.1.6.2.10 | Type: ScscfRegistration..... | 68 | +| 6.1.6.2.11 | Type: ExtendedProblemDetails..... | 70 | +| 6.1.6.2.12 | Type: AdditionalInfo..... | 70 | +| 6.1.6.2.13 | Type: DeregistrationData..... | 71 | +| 6.1.6.2.14 | Type: DeregistrationReason..... | 71 | +| 6.1.6.2.15 | Type: EmergencyRegisteredIdentity..... | 71 | +| 6.1.6.3 | Simple data types and enumerations..... | 71 | +| 6.1.6.3.1 | Introduction..... | 71 | +| 6.1.6.3.2 | Simple data types..... | 71 | +| 6.1.6.3.3 | Enumeration: AuthorizationType..... | 72 | +| 6.1.6.3.4 | Enumeration: AuthorizationResult..... | 72 | +| 6.1.6.3.5 | Enumeration: ImsRegistrationType..... | 72 | +| 6.1.6.3.6 | Enumeration: LooseRouteIndication..... | 72 | +| 6.1.6.3.7 | Enumeration: DeregistrationReasonCode..... | 73 | +| 6.1.6.4 | Data types describing alternative data types or combinations of data types..... | 73 | +| 6.1.7 | Error Handling..... | 74 | +| 6.1.7.1 | General..... | 74 | +| 6.1.7.2 | Protocol Errors..... | 74 | +| 6.1.7.3 | Application Errors..... | 74 | +| 6.1.8 | Feature negotiation..... | 74 | +| 6.1.9 | Security..... | 74 | +| 6.2 | Nhss_imsSubscriberDataManagement Service API..... | 75 | +| 6.2.1 | API URI..... | 75 | + +| | | | +|--------------|----------------------------------------------------|----| +| 6.2.2 | Usage of HTTP..... | 75 | +| 6.2.2.1 | General..... | 75 | +| 6.2.2.2 | HTTP standard headers..... | 75 | +| 6.2.2.2.1 | General..... | 75 | +| 6.2.2.2.2 | Content type..... | 75 | +| 6.2.2.3 | HTTP custom headers..... | 75 | +| 6.2.2.3.1 | General..... | 75 | +| 6.2.3 | Resources..... | 76 | +| 6.2.3.1 | Overview..... | 76 | +| 6.2.3.2 | Resource: IMS Associated Identities..... | 79 | +| 6.2.3.2.1 | Description..... | 79 | +| 6.2.3.2.2 | Resource Definition..... | 80 | +| 6.2.3.2.3 | Resource Standard Methods..... | 80 | +| 6.2.3.2.3.1 | GET..... | 80 | +| 6.2.3.3 | Resource: MSISDNs..... | 81 | +| 6.2.3.3.1 | Description..... | 81 | +| 6.2.3.3.2 | Resource Definition..... | 81 | +| 6.2.3.3.3 | Resource Standard Methods..... | 81 | +| 6.2.3.3.3.1 | GET..... | 81 | +| 6.2.3.4 | Resource: S-CSCF Capabilities..... | 82 | +| 6.2.3.4.1 | Description..... | 82 | +| 6.2.3.4.2 | Resource Definition..... | 82 | +| 6.2.3.4.3 | Resource Standard Methods..... | 83 | +| 6.2.3.4.3.1 | GET..... | 83 | +| 6.2.3.5 | Resource: IMS Profile Data..... | 84 | +| 6.2.3.5.1 | Description..... | 84 | +| 6.2.3.5.2 | Resource Definition..... | 84 | +| 6.2.3.5.3 | Resource Standard Methods..... | 84 | +| 6.2.3.5.3.1 | GET..... | 84 | +| 6.2.3.6 | Resource: Subscriptions..... | 85 | +| 6.2.3.6.1 | Description..... | 85 | +| 6.2.3.6.2 | Resource Definition..... | 85 | +| 6.2.3.6.3 | Resource Standard Methods..... | 86 | +| 6.2.3.6.3.1 | POST..... | 86 | +| 6.2.3.7 | Resource: Individual subscription..... | 87 | +| 6.2.3.7.1 | Description..... | 87 | +| 6.2.3.7.2 | Resource Definition..... | 87 | +| 6.2.3.7.3 | Resource Standard Methods..... | 87 | +| 6.2.3.7.3.1 | DELETE..... | 87 | +| 6.2.3.7.3.2 | PATCH..... | 88 | +| 6.2.3.8 | Resource: SharedDataSubscriptions..... | 89 | +| 6.2.3.8.1 | Description..... | 89 | +| 6.2.3.8.2 | Resource Definition..... | 89 | +| 6.2.3.8.3 | Resource Standard Methods..... | 90 | +| 6.2.3.8.3.1 | POST..... | 90 | +| 6.2.3.9 | Resource: Shared Data Individual subscription..... | 91 | +| 6.2.3.9.1 | Description..... | 91 | +| 6.2.3.9.2 | Resource Definition..... | 91 | +| 6.2.3.9.3 | Resource Standard Methods..... | 91 | +| 6.2.3.9.3.1 | DELETE..... | 91 | +| 6.2.3.9.3.2 | PATCH..... | 92 | +| 6.2.3.10 | Resource: IMS Registration Status..... | 93 | +| 6.2.3.10.1 | Description..... | 93 | +| 6.2.3.10.2 | Resource Definition..... | 93 | +| 6.2.3.10.3 | Resource Standard Methods..... | 94 | +| 6.2.3.10.3.1 | GET..... | 94 | +| 6.2.3.11 | Resource: Service Priority Information..... | 95 | +| 6.2.3.11.1 | Description..... | 95 | +| 6.2.3.11.2 | Resource Definition..... | 95 | +| 6.2.3.11.3 | Resource Standard Methods..... | 95 | +| 6.2.3.11.3.1 | GET..... | 95 | + +| | | | +|--------------|------------------------------------------------|-----| +| 6.2.3.12 | Resource: Initial Filter Criteria..... | 96 | +| 6.2.3.12.1 | Description..... | 96 | +| 6.2.3.12.2 | Resource Definition..... | 96 | +| 6.2.3.12.3 | Resource Standard Methods..... | 97 | +| 6.2.3.12.3.1 | GET..... | 97 | +| 6.2.3.13 | Resource: IMS Location Data..... | 98 | +| 6.2.3.13.1 | Description..... | 98 | +| 6.2.3.13.2 | Resource Definition..... | 98 | +| 6.2.3.13.3 | Resource Standard Methods..... | 98 | +| 6.2.3.13.3.1 | GET..... | 98 | +| 6.2.3.14 | Resource: Service Level Trace Information..... | 99 | +| 6.2.3.14.1 | Description..... | 99 | +| 6.2.3.14.2 | Resource Definition..... | 99 | +| 6.2.3.14.3 | Resource Standard Methods..... | 100 | +| 6.2.3.14.3.1 | GET..... | 100 | +| 6.2.3.15 | Resource: PS location Information..... | 101 | +| 6.2.3.15.1 | Description..... | 101 | +| 6.2.3.15.2 | Resource Definition..... | 101 | +| 6.2.3.15.3 | Resource Standard Methods..... | 101 | +| 6.2.3.15.3.1 | GET..... | 101 | +| 6.2.3.16 | Resource: CS location Information..... | 103 | +| 6.2.3.16.1 | Description..... | 103 | +| 6.2.3.16.2 | Resource Definition..... | 103 | +| 6.2.3.16.3 | Resource Standard Methods..... | 104 | +| 6.2.3.16.3.1 | GET..... | 104 | +| 6.2.3.17 | Resource: SRVCC data..... | 105 | +| 6.2.3.17.1 | Description..... | 105 | +| 6.2.3.17.2 | Resource Definition..... | 105 | +| 6.2.3.17.3 | Resource Standard Methods..... | 106 | +| 6.2.3.17.3.1 | GET..... | 106 | +| 6.2.3.17.3.2 | PATCH..... | 107 | +| 6.2.3.18 | Resource: PSI activation state..... | 108 | +| 6.2.3.18.1 | Description..... | 108 | +| 6.2.3.18.2 | Resource Definition..... | 108 | +| 6.2.3.18.3 | Resource Standard Methods..... | 109 | +| 6.2.3.18.3.1 | GET..... | 109 | +| 6.2.3.18.3.2 | PATCH..... | 110 | +| 6.2.3.19 | Resource: Repository Data..... | 111 | +| 6.2.3.19.1 | Description..... | 111 | +| 6.2.3.19.2 | Resource Definition..... | 111 | +| 6.2.3.19.3 | Resource Standard Methods..... | 111 | +| 6.2.3.19.3.1 | GET..... | 111 | +| 6.2.3.19.3.2 | PUT..... | 112 | +| 6.2.3.19.3.3 | DELETE..... | 113 | +| 6.2.3.20 | Resource: SharedData..... | 114 | +| 6.2.3.20.1 | Description..... | 114 | +| 6.2.3.20.2 | Resource Definition..... | 114 | +| 6.2.3.20.3 | Resource Standard Methods..... | 115 | +| 6.2.3.20.3.1 | GET..... | 115 | +| 6.2.3.21 | Resource: ImeiSvInformation..... | 116 | +| 6.2.3.21.1 | Description..... | 116 | +| 6.2.3.21.2 | Resource Definition..... | 116 | +| 6.2.3.21.3 | Resource Standard Methods..... | 116 | +| 6.2.3.21.3.1 | GET..... | 116 | +| 6.2.3.22 | Resource: IP Address..... | 117 | +| 6.2.3.22.1 | Description..... | 117 | +| 6.2.3.22.2 | Resource Definition..... | 117 | +| 6.2.3.22.3 | Resource Standard Methods..... | 118 | +| 6.2.3.22.3.1 | GET..... | 118 | +| 6.2.3.23 | Resource: T-ADS Info..... | 119 | +| 6.2.3.23.1 | Description..... | 119 | + +| | | | +|--------------|--------------------------------------------------------|-----| +| 6.2.3.23.2 | Resource Definition..... | 119 | +| 6.2.3.23.3 | Resource Standard Methods..... | 119 | +| 6.2.3.23.3.1 | GET..... | 119 | +| 6.2.3.24 | Resource: UeReachabilitySubscriptions..... | 120 | +| 6.2.3.24 | Description..... | 120 | +| 6.2.3.24.2 | Resource Definition..... | 120 | +| 6.2.3.24.3 | Resource Standard Methods..... | 121 | +| 6.2.3.24.3.1 | POST..... | 121 | +| 6.2.3.25 | Resource: UE reachability Individual subscription..... | 122 | +| 6.2.3.25.1 | Description..... | 122 | +| 6.2.3.25.2 | Resource Definition..... | 122 | +| 6.2.3.25.3 | Resource Standard Methods..... | 122 | +| 6.2.3.25.3.1 | DELETE..... | 122 | +| 6.2.3.25.3.2 | PATCH..... | 123 | +| 6.2.3.26 | Resource: PS User State..... | 124 | +| 6.2.3.26.1 | Description..... | 124 | +| 6.2.3.26.2 | Resource Definition..... | 124 | +| 6.2.3.26.3 | Resource Standard Methods..... | 125 | +| 6.2.3.26.3.1 | GET..... | 125 | +| 6.2.3.27 | Resource: CS User State..... | 126 | +| 6.2.3.27.1 | Description..... | 126 | +| 6.2.3.27.2 | Resource Definition..... | 126 | +| 6.2.3.27.3 | Resource Standard Methods..... | 127 | +| 6.2.3.27.3.1 | GET..... | 127 | +| 6.2.3.28 | Resource: Csrn..... | 128 | +| 6.2.3.28.1 | Description..... | 128 | +| 6.2.3.28.2 | Resource Definition..... | 128 | +| 6.2.3.28.3 | Resource Standard Methods..... | 128 | +| 6.2.3.28.3.1 | GET..... | 128 | +| 6.2.3.29 | Resource: ReferenceAccessLocation..... | 130 | +| 6.2.3.29.1 | Description..... | 130 | +| 6.2.3.29.2 | Resource Definition..... | 130 | +| 6.2.3.29.3 | Resource Standard Methods..... | 130 | +| 6.2.3.29.3.1 | GET..... | 130 | +| 6.2.3.30 | Resource: SMSRegistrationInfo..... | 131 | +| 6.2.3.30.1 | Description..... | 131 | +| 6.2.3.30.2 | Resource Definition..... | 132 | +| 6.2.3.30.3 | Resource Standard Methods..... | 132 | +| 6.2.3.30.3.1 | GET..... | 132 | +| 6.2.3.30.3.2 | PUT..... | 133 | +| 6.2.3.30.3.3 | DELETE..... | 134 | +| 6.2.3.31 | Resource: Dsai..... | 135 | +| 6.2.3.31.1 | Description..... | 135 | +| 6.2.3.31.2 | Resource Definition..... | 135 | +| 6.2.3.31.3 | Resource Standard Methods..... | 136 | +| 6.2.3.31.3.1 | GET..... | 136 | +| 6.2.3.31.3.2 | PATCH..... | 137 | +| 6.2.3.32 | Resource: Private Identities..... | 138 | +| 6.2.3.32.1 | Description..... | 138 | +| 6.2.3.32.2 | Resource Definition..... | 138 | +| 6.2.3.32.3 | Resource Standard Methods..... | 139 | +| 6.2.3.32.3.1 | GET..... | 139 | +| 6.2.3.33 | Resource: S-CSCF Selection Assistance Information..... | 140 | +| 6.2.3.33.1 | Description..... | 140 | +| 6.2.3.33.2 | Resource Definition..... | 140 | +| 6.2.3.33.3 | Resource Standard Methods..... | 140 | +| 6.2.3.33.3.1 | GET..... | 140 | +| 6.2.3.34 | Resource: Charging Information..... | 141 | +| 6.2.3.34.1 | Description..... | 141 | +| 6.2.3.34.2 | Resource Definition..... | 141 | +| 6.2.3.34.3 | Resource Standard Methods..... | 142 | + +| | | | +|--------------|------------------------------------------------|-----| +| 6.2.3.34.3.1 | GET..... | 142 | +| 6.2.5 | Notifications..... | 142 | +| 6.2.5.1 | General..... | 142 | +| 6.2.5.2 | Data Change Notification..... | 142 | +| 6.2.6 | Data Model..... | 143 | +| 6.2.6.1 | General..... | 143 | +| 6.2.6.2 | Structured data types..... | 145 | +| 6.2.6.2.1 | Introduction..... | 145 | +| 6.2.6.2.2 | Type: ScscfCapabilityList..... | 145 | +| 6.2.6.2.3 | Type: Capabilities..... | 145 | +| 6.2.6.2.4 | Type: ImsProfileData..... | 146 | +| 6.2.6.2.5 | Type: SharedData..... | 146 | +| 6.2.6.2.6 | Type: ImsDataSets..... | 146 | +| 6.2.6.2.7 | Type: RepositoryData..... | 146 | +| 6.2.6.2.8 | Type: MsisdnList..... | 146 | +| 6.2.6.2.9 | Type: PublicIdentities..... | 147 | +| 6.2.6.2.10 | Type: PublicIdentity..... | 147 | +| 6.2.6.2.11 | Type: ImsSdmSubscription..... | 147 | +| 6.2.6.2.12 | Type: ImsRegistrationStatus..... | 147 | +| 6.2.6.2.13 | Type: PriorityLevels..... | 148 | +| 6.2.6.2.14 | Type: Ifcs..... | 148 | +| 6.2.6.2.15 | Type: Ifc..... | 148 | +| 6.2.6.2.16 | Type: TriggerPoint..... | 148 | +| 6.2.6.2.17 | Type: Spt..... | 149 | +| 6.2.6.2.18 | Type: HeaderSipRequest..... | 149 | +| 6.2.6.2.19 | Type: SdpDescription..... | 149 | +| 6.2.6.2.20 | Type: ApplicationServer..... | 150 | +| 6.2.6.2.21 | Type: ImsLocationData..... | 150 | +| 6.2.6.2.22 | Type: ServiceLevelTraceInformation..... | 150 | +| 6.2.6.2.23 | Type: PsLocation..... | 150 | +| 6.2.6.2.24 | Type: SgsnLocationData..... | 151 | +| 6.2.6.2.25 | Type: MmeLocationData..... | 151 | +| 6.2.6.2.26 | Type: AmfLocationData..... | 151 | +| 6.2.6.2.27 | Type: TwanLocationData..... | 152 | +| 6.2.6.2.28 | Type: CsLocation..... | 152 | +| 6.2.6.2.29 | Type: CsgInformation..... | 152 | +| 6.2.6.2.30 | Type: SrvccData..... | 153 | +| 6.2.6.2.31 | Type: PsiActivationState..... | 153 | +| 6.2.6.2.32 | Type: ImsServiceProfile..... | 153 | +| 6.2.6.2.33 | Type: PublicIdentifier..... | 153 | +| 6.2.6.2.34 | Type: ImeiSvInformation..... | 153 | +| 6.2.6.2.35 | Type: IpAddress..... | 154 | +| 6.2.6.2.36 | Type: TadsInformation..... | 154 | +| 6.2.6.2.37 | Type: UeReachabilitySubscription..... | 154 | +| 6.2.6.2.38 | Type: UeReachabilityNotification..... | 154 | +| 6.2.6.2.39 | Type: PsUserState..... | 154 | +| 6.2.6.2.40 | Type: CsUserState..... | 155 | +| 6.2.6.2.41 | Type: Csrn..... | 155 | +| 6.2.6.2.42 | Type: ReferenceLocationInformation..... | 155 | +| 6.2.6.2.43 | Type: SmsRegistrationInfo..... | 155 | +| 6.2.6.2.44 | Type: IpSmGwAddress..... | 155 | +| 6.2.6.2.45 | Type: ImsAssociatedIdentities..... | 156 | +| 6.2.6.2.46 | Type: DsaiTagInformation..... | 156 | +| 6.2.6.2.47 | Type: DsaiTagStatus..... | 156 | +| 6.2.6.2.48 | Type: CreatedUeReachabilitySubscription..... | 156 | +| 6.2.6.2.49 | Type: PrivateIdentities..... | 156 | +| 6.2.6.2.50 | Type: PrivateIdentity..... | 156 | +| 6.2.6.2.51 | Type: ScscfSelectionAssistanceInformation..... | 157 | +| 6.2.6.2.52 | Type: ChargingInfo..... | 157 | +| 6.2.6.3 | Simple data types and enumerations..... | 157 | +| 6.2.6.3.1 | Introduction..... | 157 | + +| | | | +|---------------|-----------------------------------------------------|-----| +| 6.2.6.3.2 | Simple data types..... | 157 | +| 6.2.6.3.3 | Enumeration: DataSetName..... | 158 | +| 6.2.6.3.4 | Enumeration: IdentityType..... | 158 | +| 6.2.6.3.5 | Enumeration: ImsRegistrationState..... | 159 | +| 6.2.6.3.6 | Enumeration: TypeOfCondition..... | 159 | +| 6.2.6.3.7 | Enumeration: RegistrationType..... | 159 | +| 6.2.6.3.8 | Enumeration: RequestDirection..... | 159 | +| 6.2.6.3.9 | Enumeration: ServiceInformation..... | 160 | +| 6.2.6.3.10 | Enumeration: RequestedNode..... | 160 | +| 6.2.6.3.11 | Enumeration: SrvccCapability..... | 160 | +| 6.2.6.3.12 | Enumeration: ActivationState..... | 160 | +| 6.2.6.3.13 | Enumeration: ImsVoiceOverPsSessionSupport..... | 161 | +| 6.2.6.3.14 | Enumeration: AccessType..... | 161 | +| 6.2.6.3.15 | Enumeration: UserStatePs..... | 161 | +| 6.2.6.3.16 | Enumeration: UserStateCs..... | 161 | +| 6.2.6.3.17 | Enumeration: PrivateIdentityType..... | 162 | +| 6.2.7 | Error Handling..... | 162 | +| 6.2.7.1 | General..... | 162 | +| 6.2.7.2 | Protocol Errors..... | 162 | +| 6.2.7.3 | Application Errors..... | 162 | +| 6.2.8 | Feature negotiation..... | 162 | +| 6.2.9 | Security..... | 163 | +| 6.3 | Nhss_imsUEAuthentication Service API..... | 164 | +| 6.3.1 | API URI..... | 164 | +| 6.3.2 | Usage of HTTP..... | 165 | +| 6.3.2.1 | General..... | 165 | +| 6.3.2.2 | HTTP standard headers..... | 165 | +| 6.3.2.2.1 | General..... | 165 | +| 6.3.2.2.2 | Content type..... | 165 | +| 6.3.2.3 | HTTP custom headers..... | 165 | +| 6.3.2.3.1 | General..... | 165 | +| 6.3.3 | Resources..... | 165 | +| 6.3.3.1 | Overview..... | 165 | +| 6.3.3.2 | Resource: SecurityInformation..... | 166 | +| 6.3.3.2.1 | Description..... | 166 | +| 6.3.3.2.2 | Resource Definition..... | 166 | +| 6.3.3.2.3 | Resource Standard Methods..... | 166 | +| 6.3.3.2.4 | Resource Custom Operations..... | 166 | +| 6.3.3.2.4.1 | Overview..... | 166 | +| 6.3.3.2.4.2 | Operation: generate-sip-auth-data..... | 167 | +| 6.3.3.2.4.2.1 | Description..... | 167 | +| 6.3.3.2.4.2.2 | Operation Definition..... | 167 | +| 6.3.4 | Custom Operations without associated resources..... | 168 | +| 6.3.5 | Notifications..... | 168 | +| 6.3.6 | Data Model..... | 168 | +| 6.3.6.1 | General..... | 168 | +| 6.3.6.2 | Structured data types..... | 168 | +| 6.3.6.2.1 | Introduction..... | 168 | +| 6.3.6.2.2 | Type: SipAuthenticationInfoRequest..... | 169 | +| 6.3.6.2.3 | Type: SipAuthenticationInfoResult..... | 169 | +| 6.3.6.2.4 | Type: ResynchronizationInfo..... | 169 | +| 6.3.6.2.5 | Type: 3GAkaAv..... | 169 | +| 6.3.6.2.6 | Type: DigestAuthentication..... | 170 | +| 6.3.6.2.7 | Type: IpAddress..... | 170 | +| 6.3.6.3 | Simple data types and enumerations..... | 170 | +| 6.3.6.3.1 | Introduction..... | 170 | +| 6.3.6.3.2 | Simple data types..... | 170 | +| 6.3.6.3.3 | Enumeration: SipAuthenticationScheme..... | 170 | +| 6.3.6.3.4 | Enumeration: SipDigestAlgorithm..... | 171 | +| 6.3.6.3.5 | Enumeration: SipDigestQop..... | 171 | +| 6.3.7 | Error Handling..... | 171 | + +| | | | +|-----------------------------------------------------------|--------------------------|------------| +| 6.3.7.1 | General..... | 171 | +| 6.3.7.2 | Protocol Errors..... | 171 | +| 6.3.7.3 | Application Errors..... | 171 | +| 6.3.8 | Feature Negotiation..... | 171 | +| 6.3.9 | Security..... | 172 | +| Annex A (normative): OpenAPI specification..... | | 172 | +| A.1 | General..... | 172 | +| A.2 | Nhss_imsUECM API..... | 172 | +| A.3 | Nhss_imsSDM API..... | 180 | +| A.4 | Nhss_imsUEAU API..... | 224 | +| Annex B (informative): Withdrawn API versions..... | | 227 | +| B.1 | General..... | 227 | +| Annex C (informative): Change history..... | | 228 | + +## Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +--- + +## 1 Scope + +The present document specifies the stage 3 protocol, including message flows and API specification details, for the Nhss services, as part of the 5G Service-Based Architecture, offered by the HSS for interworking with the IP Multimedia Subsystem (IMS). + +The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]. + +The IP Multimedia Subsystem (IMS) stage 2 architecture and procedures are specified in 3GPP TS 23.228 [6]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5]. + +--- + +## 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] 3GPP TS 23.228: "IP Multimedia Subsystem (IMS); Stage 2". +- [7] 3GPP TS 29.335: "User Data Repository Access Protocol over the Ud interface; Stage 3". +- [8] IETF RFC 7540: "Hypertext Transfer Protocol Version 2 (HTTP/2)". +- [9] OpenAPI Initiative, "OpenAPI 3.0.0 Specification", +- [10] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [11] IETF RFC 7807: "Problem Details for HTTP APIs". +- [12] IETF RFC 6902: "JavaScript Object Notation (JSON) Patch". + +- [13] 3GPP TS 23.003: "Numbering, addressing and identification". +- [14] 3GPP TS 33.203: "Access security for IP-based services". +- [15] 3GPP TS 29.503: "Unified Data Management Services; Stage 3". +- [16] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces Stage 3". +- [17] IETF RFC 4740: "Diameter Session Initiation Protocol (SIP) Application". +- [18] 3GPP TS 24.229: "IP multimedia call control protocol based on Session Initiation Protocol (SIP) and Session Description Protocol (SDP); Stage 3". +- [19] IETF RFC 4412: "Communications Resource Priority for the Session Initiation Protocol". +- [20] 3GPP TS 29.228: "IP Multimedia (IM) Subsystem Cx and Dx interfaces; Signalling flows and message contents". +- [21] 3GPP TS 29.218: "IP Multimedia (IM) session handling; IM call model; Stage 2". +- [22] IETF RFC 3261: "SIP: Session Initiation Protocol". +- [23] IETF RFC 8497: "Marking SIP messages to be logged". +- [24] 3GPP TS 24.323: "3GPP IP Multimedia Subsystem (IMS) service level tracing Management Object (MO)". +- [25] 3GPP TS 23.060: "General Packet Radio Service (GPRS); Service description; Stage 2". +- [26] 3GPP TS 29.273: "Evolved Packet System (EPS); 3GPP EPS AAA interfaces". +- [27] IETF RFC 4776: "Dynamic Host Configuration Protocol (DHCPv4 and DHCPv6) Option for Civic Addresses Configuration Information". +- [28] IETF RFC 2045: "Multipart Internet Mail Extensions(MIME) Part One: Format of Internet Message Bodies". +- [29] ETSI ES 283 034: "Network Attachment Sub-System (NASS); e4 interface based on the DIAMETER protocol". +- [30] 3GPP TS 29.002: "Mobile Application Part (MAP) specification". +- [31] 3GPP TS 23.078: "Customised Applications for Mobile network Enhanced Logic (CAMEL) Phase 3 - Stage 2". +- [32] 3GPP TS 29.272: "Evolved Packet System; MME and SGSN Related Interfaces Based on Diameter Protocol". +- [33] 3GPP TS 29.518: "5G System; Access and Mobility Management Services; Stage 3". +- [34] 3GPP TR 21.900: "Technical Specification Group working methods". +- [35] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [36] 3GPP TS 29.510: "Network Function Repository Services; Stage 3". +- [37] 3GPP TS 23.380: "IP Multimedia Subsystem (IMS); IMS Restoration Procedures". +- [38] 3GPP TS 29.328: "IP Multimedia (IM) Subsystem Sh interface; Signalling flows and message contents". + +## 3 Definitions of terms, symbols and abbreviations + +### 3.1 Terms + +The following terms and definitions given in TS 23.003 [13] apply: + +**Distinct Public Service Identity** + +**Distinct Public User Identity** + +**Public Service Identity** + +**Public User Identity** + +**Wildcarded Public Service Identity** + +**Wildcarded Public User Identity** + +In the present document, the following terms and definitions apply. + +**Common Part** (of a user profile): Contains Initial Filter Criteria instances that should be evaluated both for registered and unregistered Public User Identities, or for unregistered Public Service Identities in the S-CSCF. + +**Complete user profile**: Contains the Initial Filter Criteria instances of all three different user profile parts; registered part, unregistered part and common part. + +**IP Multimedia session**: IP Multimedia session and IP Multimedia call are treated as equivalent in this specification. + +**Authentication pending flag**: A flag that indicates that the authentication of a Public User Identity - Private User Identity pair is pending and waiting for confirmation. + +**Implicitly registered Public User Identity set**: A set of Public User Identities, which are registered and de-registered simultaneously when any of the Public User Identities belonging to that set is registered or de-registered. + +**Not Registered State**: Public Identity is not Registered and has no S-CSCF assigned. + +**Private Identity**: Either a Private User Identity or a Private Service Identity. + +**Public Identity**: Either a Public User Identity or a Public Service Identity. + +**Registered State**: Public User Identity is Registered at the request of the user and has an S-CSCF assigned. + +**Unregistered State**: Public Identity is not Registered but has a serving S-CSCF assigned to execute Unregistered state services as a consequence of a terminating request, or an originating request from an AS on behalf of a user, or there is an S-CSCF keeping the user profile stored. + +**User information**: The user related data that the S-CSCF requests from the HSS or HSS pushes to the S-CSCF, e.g. user profile, charging information, allowed WAF and/or WWSF identities and authentication information. + +**User profile**: Data that is sent in the resource associated to the complete user's subscription data. + +**IP Multimedia session**: IP Multimedia session and IP Multimedia call are treated as equivalent in this specification. + +**Transparent data**: Data that is understood syntactically but not semantically by the HSS. It is data that an AS may store in the HSS to support its service logic. One example is data that an AS stores in the HSS, using it as a repository. + +**Non-transparent data**: Data that is understood both syntactically and semantically by the HSS. + +**AS (Application Server)**: a term used to denote either of a SIP Application Server or an OSA Service Capability Server. + +## 3.2 Symbols + +Void + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|--------|------------------------------------------------| +| 5GC | 5G Core Network | +| AS | Application Server | +| AMF | Access and Mobility Management Function | +| CSCF | Call Session Control Function | +| CSG | Closed Subscriber Group | +| FQDN | Fully Qualified Domain Name | +| GIBA | GPRS-IMS-Bundled-Authentication | +| GPSI | Generic Public Subscription Identifier | +| HSS | Home Subscriber Server | +| IMS | IP Multimedia Subsystem | +| I-CSCF | Interrogating CSCF | +| JSON | Javascript Object Notation | +| MPS | Multimedia Priority Service | +| NAI | Network Access Identifier | +| NRF | Network Repository Function | +| NSSAI | Network Slice Selection Assistance Information | +| NWDAF | Network Data Analytics Function | +| P-CSCF | Proxy CSCF | +| SBI | Service Based Interface | +| SIP | Session Initiation Protocol | +| SPT | Service Point Trigger | +| S-CSCF | Serving CSCF | +| UDR | Unified Data Repository | + +--- + +## 4 Overview + +### 4.1 Introduction + +Within the 5GC, the HSS offers services to the S-CSCF, I-CSCF and IMS-AS via the Nhss service based interface (see 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]). + +Figure 4.1-1 provides the reference model in service-based interface representation with focus on the HSS. + +![Figure 4.1-1: Reference model – HSS. The diagram shows three network functions (S-CSCF, I-CSCF, and IMS-AS) connected to a central HSS (Home Subscriber Server) via an Nhss interface. The HSS is represented by a green rectangle, and the Nhss interface is indicated by a small circle on its left side. Lines connect each of the three network functions to this circle.](8307f6b04df072c9332f9987e034272c_img.jpg) + +Figure 4.1-1: Reference model – HSS. The diagram shows three network functions (S-CSCF, I-CSCF, and IMS-AS) connected to a central HSS (Home Subscriber Server) via an Nhss interface. The HSS is represented by a green rectangle, and the Nhss interface is indicated by a small circle on its left side. Lines connect each of the three network functions to this circle. + +**Figure 4.1-1: Reference model – HSS** + +## 5 Services offered by the HSS + +### 5.1 Introduction + +The SBI capable HSS offers the following services via the Nhss\_ims interface: + +- Nhss\_imsUEContextManagement Service +- Nhss\_imsSubscriberDataManagement Service +- Nhss\_imsUEAuthentication Service + +Table 5.1-1 summarizes the corresponding APIs defined for this specification. + +**Table 5.1-1: API Descriptions** + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex | +|----------------------------------|--------|-------------------------------------------------|----------------------------|---------------|-------| +| Nhss_imsUEContextManagement | 6.1 | Nhss UE Context Management Service for IMS | TS29562_Nhss_imsUECM.yaml | nhss-ims-uecm | A.2 | +| Nhss_imsSubscriberDataManagement | 6.2 | Nhss Subscriber Data Management Service for IMS | TS29562_Nhss_imsSDM.yaml | nhss-ims-sdm | A.3 | +| Nhss_imsUEAuthentication | 6.3 | Nhss UE Authentication Service for IMS | TS29562_Nhss_imsUEAU.yaml | nhss-ims-ueau | A.4 | + +All scenarios shown in the following clauses assume that the SBI capable HSS is stateful and stores information in local memory. However, the SBI capable HSS may be stateless and store information externally in the UDR. If so, the stateless SBI capable HSS may use Ud interface as specified in 3GPP TS 29.335 [7] to retrieve required data from the UDR and store them locally before processing an incoming request. Processing the incoming request may then include updating data in the UDR. After processing the incoming request, the SBI capable HSS may delete the locally stored data. When data stored in UDR is then shared among the different SBI capable HSS instances of the same group, as identified by HSS Group ID (see 3GPP TS 23.501 [2], clause 6.2.6), bulk subscriptions, as described in + +clause 4.15.3.2.4 of 3GPP TS 23.502 [3], are not applicable, i.e. an NF consumer (e.g. IMS-AS) only subscribes towards one of the SBI capable HSS instances within the group. + +**Editor's Note:** It is FFS if an informative Annex needs to be included to show how an IMS-AS/I-CSCF/S-CSCF can interact with a group of stateless SBI capable HSS instances. + +## 5.2 Nhss\_imsUEContextManagement Service + +### 5.2.1 Service Description + +See 3GPP TS 23.228 [6], clause AA.2.1.2. + +### 5.2.2 Service Operations + +#### 5.2.2.1 Introduction + +For the Nhss\_imsUEContextManagement service the following service operations are defined: + +- Registration +- DeregistrationNotification +- Deregistration +- Authorize +- Update +- RestorationInfoGet +- RestorationInfoUpdate + +IMS restoration procedures are specified in 3GPP TS 23.380 [37]. + +The Nhss\_imsUEContextManagement Service is used by Consumer NFs (I-CSCF/S-CSCF) to: + +- register at the HSS by means of the Registration service operation (S-CSCF) +- get notified by means of the DeregistrationNotification service operation when HSS decides to deregister the registered consumer NF (S-CSCF) +- deregister from the HSS by means of the Deregistration service operation (S-CSCF) +- request registration authorization from HSS by means of the Authorize service operation (I-CSCF) +- update registration information stored at the HSS by means of the Update service operation (S-CSCF) +- retrieve Restoration Information stored at the HSS by means of the RestorationInfoGet service operation (S-CSCF) +- update Restoration Information stored at the HSS by means of the RestorationInfoUpdate service operation (S-CSCF) + +#### 5.2.2.2 Registration + +##### 5.2.2.2.1 General + +The Registration service operation is invoked by a NF that has been selected to provide service to the UE to store related IMS UE Context Management information in HSS. + +NF Consumer is S-CSCF. + +As part of this procedure, the HSS updates the registration state of the requested IMS Public Identity and IMS Private Identity. The state of the IMS Public Identities in the same Implicit Registration Set is also updated. + +The following procedures using the Registration service operation are supported: + +- S-CSCF registration + +#### 5.2.2.2.2 S-CSCF Registration + +Figure 5.2.2.2.2-1 shows a scenario where the S-CSCF sends a request to register at the HSS (see also 3GPP TS 23.228 [6] clause 5.2). The request contains the IMS UE's identity (`{imsUId}`) which shall be an IMPU, the S-CSCF Registration Information and the Registration Type. + +![Sequence diagram showing S-CSCF registration. The S-CSCF sends a PUT request to the HSS. The HSS responds with one of four possible status codes: 2a. 204 No Content, 2b. 201 Created, 2c. 403 Forbidden, or 2d. 3xx Redirect.](40f30e4d577a17052f8b1e6dc802a0d8_img.jpg) + +``` + +sequenceDiagram + participant S-CSCF + participant HSS + Note left of S-CSCF: 1. PUT « ^imsUId}/scscf-registration (ScscfRegistration) + S-CSCF->>HSS: Request + Note right of HSS: 2a. 204 No Content +2b. 201 Created +2c. 403 Forbidden +2d. 3xx Redirect + HSS-->>S-CSCF: Response + +``` + +Sequence diagram showing S-CSCF registration. The S-CSCF sends a PUT request to the HSS. The HSS responds with one of four possible status codes: 2a. 204 No Content, 2b. 201 Created, 2c. 403 Forbidden, or 2d. 3xx Redirect. + +**Figure 5.2.2.2.2-1: S-CSCF registration** + +1. The S-CSCF sends a PUT request to the resource representing the UE's S-CSCF registration to update or create S-CSCF registration information. The S-CSCF shall check whether there is a reg-id parameter in the Contact header in the SIP REGISTER message. If a reg-id parameter exists, the S-CSCF shall indicate to the HSS that the registration is related to a multiple registration as specified in clause 4.2.3 of 3GPP TS 23.380 [37]. If the S-CSCF received a S-CSCF reselection indicator from the I-CSCF, the S-CSCF shall include that indicator to the HSS. +- 2a. If the resource already exists, and if the S-CSCF registered is the same or if another S-CSCF is registered and S-CSCF reselection indication is received, the HSS updates the scscfRegistration resource by replacing it with the received resource information (e.g. S-CSCF name, state of the related IMS public identity based on the imsRegistrationType received) and responds with "204 No Content" or "200 OK" with the updated resource information and HSS supported features. + +Additionally, if the S-CSCF is reselected, the HSS shall invoke the Deregistration Notification service operation towards the old S-CSCF using the callback URI provided by the old S-CSCF with deregistration reason set to "NEW SERVER ASSIGNED". + +When receiving the "200 OK" response and if a multiple registration indicator has indicated to the HSS, the S-CSCF shall retrieve and update the restoration information as specified in clause 5.2.2.6 and clause 5.2.2.7. + +- 2b. If the resource does not exist (there is no previous S-CSCF information stored in HSS), HSS stores the received S-CSCF registration data and responds with HTTP Status Code "201 created". A response body is included with the created resource and the features supported by HSS. +- 2c. If the operation is not authorized due to e.g. received IMS identities do not exist or do not match, or a different S-CSCF is registered and S-CSCF reselection is not authorized, HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PUT response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +### 5.2.2.3 DeregistrationNotification + +#### 5.2.2.3.1 General + +The following procedure using the DeregistrationNotification service operation is supported: + +- HSS initiated Deregistration + +#### 5.2.2.3.2 HSS initiated Deregistration + +Figure 5.2.2.3.2-1 shows a scenario where the HSS notifies the registered NF about the deregistration of one or more IMS Public Identities (see also 3GPP TS 23.228 [6] clause 5.3.2.2.1). The request contains the callback URI for deregistration notification as received by the HSS during registration, and Deregistration Data. + +![Sequence diagram showing HSS initiated NF Deregistration. The HSS sends a POST request to the NF Consumer. The NF Consumer responds with either 2a. 204 No Content, 2b. 4xx/5xx Client or Server Error, or 2c. 3xx Redirect.](a51105b2031bad93b818b82f071c6add_img.jpg) + +``` + +sequenceDiagram + participant NF Consumer + participant HSS + HSS->>NF Consumer: 1. POST {callbackReference} (DeregistrationData) + NF Consumer-->>HSS: 2a. 204 No Content + NF Consumer-->>HSS: 2b. 4xx/5xx Client or Server Error + NF Consumer-->>HSS: 2c. 3xx Redirect + +``` + +Sequence diagram showing HSS initiated NF Deregistration. The HSS sends a POST request to the NF Consumer. The NF Consumer responds with either 2a. 204 No Content, 2b. 4xx/5xx Client or Server Error, or 2c. 3xx Redirect. + +**Figure 5.2.2.3.2-1: HSS initiated NF Deregistration** + +1. The HSS determines the need to deregister one or more public identities and sends a POST request to the callbackReference as provided by the NF service consumer (S-CSCF) during the registration. + +NOTE: The callbackReference identifies a public identity or an IRS or a Wildcarded PSI that shall be deregistered. + +HSS includes DeregistrationData with the Deregistration Reason that triggered the notification and additional information about the public identities that shall be deregistered such as: + +- Private Identity of the public identity to be deregistered, +- if several Private Identities with all associated Public Identities need to be deregistered, the Associated Private Identities. + +- 2a. On success, the NF service consumer responds with "204 No Content" or with "200 OK" including additional information about the deregistration result such as: + +- Associated Private Identities: it contains all Private Identities that have been deregistered together with the one in the Private User Identity received in the request, +- Identities with Emergency Registration: This information element indicates a list of pairs of private and public user identities which have not been de-registered due to emergency registration. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +In the case of redirection, the NF Service Consumer shall return 3xx status code, which shall contain a Location header with an URI pointing to an alternative notification endpoint. + +### 5.2.2.4 Deregistration + +#### 5.2.2.4.1 General + +The following procedures using the Deregistration service operation are supported: + +- S-CSCF deregistration + +#### 5.2.2.4.2 S-CSCF deregistration + +Figure 5.2.2.4.2-1 shows a scenario where the S-CSCF sends a request to the HSS to deregister a user (see also 3GPP TS 23.228 [6] clause 5.3.1). The request contains the IMS UE's identity (`{imsUeId}`) which shall be an IMPI or an IMPU and the deregistration information. + +![Sequence diagram showing S-CSCF sending a PUT request to HSS for deregistration, and HSS responding with 204, 403/404, or 3xx status codes.](4cc7cdce3d498d8b0ba033a9be24ade5_img.jpg) + +``` + +sequenceDiagram + participant S-CSCF + participant HSS + Note right of HSS: 2a. 204 No Content +2b. 403 Forbidden / 404 Not Found +2c. 3xx Redirect + S-CSCF->>HSS: 1. PUT « ^imsUeId}/scscf-registration (ScscfRegistration) + HSS-->>S-CSCF: + +``` + +Sequence diagram showing S-CSCF sending a PUT request to HSS for deregistration, and HSS responding with 204, 403/404, or 3xx status codes. + +**Figure 5.2.2.4.2-1: S-CSCF deregistering** + +- The S-CSCF sends a PUT request to the resource representing the UE's CSCF registration. +- The HSS shall check whether the received S-CSCF name matches the stored S-CSCF. If the S-CSCF name is different, the HSS shall check whether the S-CSCF reassignment is allowed (i.e. S-CSCF reassignment pending flag is set). + If an IMPI is received as ImsUeId, HSS shall deregister all IMPUs associated to that IMPI. + If an IMPU is received as ImsUeId, HSS shall deregister the IMPU and related IMPUs in the Implicit Registration Set for the related IMPI. + On success, HSS shall respond "204 No Content" or "200 OK". +- Otherwise the HSS responds with "403 Forbidden" (e.g. S-CSCF is not the current S-CSCF assigned) or "404 Not Found" (e.g. IMPU or IMPI do not exist). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PUT response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.2.2.5 Authorize + +##### 5.2.2.5.1 General + +The Authorize service operation is invoked by a NF to request UE authorization to register or establish terminating /originating sessions in the IMS network. + +NF Consumer is I-CSCF for IMS service. + +As part of this procedure, the HSS authorizes or rejects the subscriber to use the IMS service based on the authorization information provided in the request and subscription data (e.g. roaming restrictions, barrings). + +The following procedures using the Authorize service operation are supported: + +- Authorization request + +##### 5.2.2.5.2 Authorization request + +Figure 5.2.2.5.2-1 shows a scenario where the I-CSCF sends a request to the HSS to authorize the UE to register in a given PLMN's P-CSCF or initiate a session for unregistered services (see also 3GPP TS 23.228 [6] clause 5.2.2.3 or + +5.12.2). The request contains the IMS UE's identity (`{imsUeId}`) which shall be an IMPU, and the `AuthorizationRequest`. + +![Sequence diagram for Authorization. I-CSCF sends a POST request to HSS. HSS responds with 2a. 403 Forbidden, 2b. 200 OK (AuthorizationResponse), or 2c. 3xx Redirect.](09955ff8214ffb6947951fc0f60eb6ab_img.jpg) + +``` + +sequenceDiagram + participant I-CSCF + participant HSS + Note right of HSS: 2a. 403 Forbidden +2b. 200 OK (AuthorizationResponse) +2c. 3xx Redirect + I-CSCF->>HSS: 1. POST « ^imsUeId}/authorize (AuthorizationRequest) + HSS-->>I-CSCF: 2a. 403 Forbidden + HSS-->>I-CSCF: 2b. 200 OK (AuthorizationResponse) + HSS-->>I-CSCF: 2c. 3xx Redirect + +``` + +Sequence diagram for Authorization. I-CSCF sends a POST request to HSS. HSS responds with 2a. 403 Forbidden, 2b. 200 OK (AuthorizationResponse), or 2c. 3xx Redirect. + +**Figure 5.2.2.5.2-1: Authorization** + +1. The I-CSCF sends a POST request (custom method: authorize) to request for UE's authorization to register or establish an originating/terminating session. +- 2a. If the operation cannot be authorized due to e.g. UE does not have required subscription data, HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in "ProblemDetails" element). +- 2b. If successful, HSS responds with HTTP Status Code "200 OK" and may provide the S-CSCF identity which is serving the user, if any. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +## 5.2.2.6 RestorationInfoGet + +### 5.2.2.6.1 General + +The RestorationInfoGet service operation is invoked by a NF to retrieve restoration information in HSS. + +NF Consumer is S-CSCF. + +The following procedures using the RestorationInfoGet service operation are supported: + +- Restoration Information Retrieval + +### 5.2.2.6.2 Restoration Information Retrieval + +Figure 5.2.2.6.2-1 shows a scenario where the NF service consumer (S-CSCF) sends a request to the HSS to retrieve the information related to a specific registration for a registered user (e.g. during a registration procedure, or during a terminating request procedure). The request contains the IMS UE's identity (`{imsUeId}`) which shall be an IMPU. + +![Sequence diagram for Restoration Information Retrieval. S-CSCF sends a GET request to HSS. HSS responds with 2a. 200 OK (ScscfRestorationInfo), 2b. 404 Not Found, or 2c. 3xx Redirect.](6efcea66501271e9ea36cf33982f08d5_img.jpg) + +``` + +sequenceDiagram + participant S-CSCF + participant HSS + Note right of HSS: 2a. 200 OK (ScscfRestorationInfo) +2b. 404 Not Found +2c. 3xx Redirect + S-CSCF->>HSS: 1. GET « ^imsUeId}/scscf-registration/scscf-restoration-info + HSS-->>S-CSCF: 2a. 200 OK (ScscfRestorationInfo) + HSS-->>S-CSCF: 2b. 404 Not Found + HSS-->>S-CSCF: 2c. 3xx Redirect + +``` + +Sequence diagram for Restoration Information Retrieval. S-CSCF sends a GET request to HSS. HSS responds with 2a. 200 OK (ScscfRestorationInfo), 2b. 404 Not Found, or 2c. 3xx Redirect. + +**Figure 5.2.2.6.2-1: Restoration Information Retrieval** + +1. The NF service consumer (S-CSCF) sends a GET request to the resource representing the UE's S-CSCF restoration information. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the UE's S-CSCF restoration information. The S-CSCF shall send a request to the HSS to retrieve the UE's IMS profile as specified in clause 5.3.2.2.4. +- 2b. If there is no valid restoration data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +## 5.2.2.7 RestorationInfoUpdate + +### 5.2.2.7.1 General + +The RestorationInfoUpdate service operation is invoked by a NF to update restoration information in HSS. + +NF Consumer is S-CSCF. + +The following procedures using the RestorationInfoUpdate service operation are supported: + +- Restoration Information Update + +### 5.2.2.7.2 Restoration Information Update + +S-CSCF backup and update of S-CSCF restoration information in HSS is specified in clause 4.6 of 3GPP TS 23.380 [37]. + +Figure 5.2.2.7.2-1 shows a scenario where the S-CSCF sends a request to update restoration information at the HSS (see also 3GPP TS 23.228 [6] clause 4.24). The request contains the IMS UE's identity (`{imsUeId}`) which shall be an IMPU. + +![Sequence diagram showing the Restoration Information Update process between S-CSCF and HSS. The S-CSCF sends a PUT request to the HSS. The HSS responds with a message containing possible status codes: 200 OK / 204 No Content, 201 Created, 403 Forbidden, or 3xx Redirect.](b0e32f17c90ce1db73135488888ce558_img.jpg) + +``` + +sequenceDiagram + participant S-CSCF + participant HSS + Note left of S-CSCF: 1. PUT request + S-CSCF->>HSS: 1. PUT « ^imsUeId}/scscf-registration/scscf-restoration-info + Note right of HSS: 2a. 200 OK / 204 No Content +2b. 201 Created +2c. 403 Forbidden +2d. 3xx Redirect + HSS-->>S-CSCF: Response + +``` + +Sequence diagram showing the Restoration Information Update process between S-CSCF and HSS. The S-CSCF sends a PUT request to the HSS. The HSS responds with a message containing possible status codes: 200 OK / 204 No Content, 201 Created, 403 Forbidden, or 3xx Redirect. + +**Figure 5.2.2.7.2-1: Restoration Information Update** + +1. The S-CSCF sends a PUT request to the resource representing the UE's S-CSCF restoration information to update or create S-CSCF restoration information. +- 2a. If there are S-CSCF restoration information related to the IMS Public Identity stored in the HSS, the HSS updates the Sscf Restoration Information resource by replacing it with the received restoration information and responds with "200 OK" or "204 No Content". +- 2b. If the resource does not exist (there is no previous S-CSCF restoration information stored in HSS for that user), HSS stores the received S-CSCF restoration data and responds with HTTP Status Code "201 created". +- 2c. If the request can't be accepted (e.g. the S-CSCF is not allowed to create/update the restoration information), HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PUT response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +## 5.2.2.8 RestorationInfoDelete + +### 5.2.2.8.1 General + +The RestorationInfoDelete service operation is invoked by a NF to delete restoration information in HSS. + +NF Consumer is S-CSCF. + +The following procedures using the RestorationInfoDelete service operation are supported: + +- Restoration Information Delete + +### 5.2.2.8.2 Restoration Information Delete + +Figure 5.2.2.Z.2-1 shows a scenario where the S-CSCF sends a request to delete restoration information at the HSS. The request contains the IMS UE's identity (`{imsUeId}`) which shall be an IMPU. + +![Sequence diagram showing the Restoration Information Delete procedure between S-CSCF and HSS. The S-CSCF sends a DELETE request to the HSS. The HSS responds with one of the following options: 2a. 204 No Content, 2b. 403 Forbidden, 2c. 404 Not Found, or 2d. 3xx Redirect.](6a555cff11e140861ce08db72b01a6a2_img.jpg) + +``` + +sequenceDiagram + participant S-CSCF + participant HSS + Note left of S-CSCF: 1. DELETE request + S-CSCF->>HSS: 1. DELETE « ^imsUeId}/scscf-registration/scscf-restoration-info + Note right of HSS: 2a. 204 No Content +2b. 403 Forbidden +2c. 404 Not Found +2d. 3xx Redirect + HSS-->>S-CSCF: Response + +``` + +Sequence diagram showing the Restoration Information Delete procedure between S-CSCF and HSS. The S-CSCF sends a DELETE request to the HSS. The HSS responds with one of the following options: 2a. 204 No Content, 2b. 403 Forbidden, 2c. 404 Not Found, or 2d. 3xx Redirect. + +**Figure 5.2.2.8.2-1: Restoration Information Delete** + +1. The S-CSCF sends a DELETE request to the resource representing the UE's S-CSCF restoration information to delete S-CSCF restoration information. +- 2a. If there are S-CSCF restoration information related to the IMS Public Identity stored in the HSS, the HSS deletes the Sscf Restoration Information resource by replacing it with the received restoration information and responds with "204 No Content". +- 2b. If the request can't be accepted (e.g. the S-CSCF is not allowed to delete the restoration information), HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in the "ProblemDetails" element). +- 2c. If there is no valid S-CSCF restoration information, HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the DELETE response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +## 5.3 Nhss\_imssubscriberDataManagement Service + +### 5.3.1 Service Description + +See 3GPP TS 23.228 [6], clause AA.2.1.3. + +## 5.3.2 Service Operations + +### 5.3.2.1 Introduction + +For the Nhss\_imsSubscriberDataManagement service the following service operations are defined: + +- Get +- Subscribe to notification of data changes and UE reachability for IP +- Unsubscribe to notification of data changes and UE reachability for IP +- Notification of data changes and UE reachability for IP +- Update + +The Nhss\_imsSubscriberDataManagement Service is used by Consumer NFs (S-CSCF, IMS-AS) to retrieve the UE's individual subscription data relevant to the consumer NF, or by I-CSCF to retrieve S-CSCF capabilities or the assigned S-CSCF, from the SBI capable HSS by means of the Get service operation. If the consumer NF supports the feature "sharedData", the retrieved individual subscription data for the UE may contain shared data identifier identifying additional parts of subscription data shared by several UEs. If so, the Nhss\_imsSubscriberDataManagement Service is also used by Consumer NFs to: + +- retrieve shared subscription data from the HSS by means of the Get service operation. + +The Nhss\_imsSubscriberDataManagement Service is also used by Consumer NFs to: + +- subscribe to notifications of data change by means of the Subscribe service operation. If the consumer NF supports the feature "sharedData", the consumer NF may also subscribe to notifications of shared data change by means of the Subscribe service operation. +- to unsubscribe from notifications of data changes by means of the Unsubscribe service operation. If the feature "sharedData" is supported, it may also be used to unsubscribe from notifications of shared data changes by means of the Unsubscribe service operation. +- get notified by means of the Notification service operation when HSS decides to modify the subscribed data. If the feature "sharedData" is supported by the consumer NF and the consumer NF has previously subscribed to notifications of shared data change, it is also used by the consumer NF to get notified by means of the Notification service operation when the HSS decides to modify the subscribed shared data. + +It is also used by Consumer NFs to: + +- provide the information about the status of the subscription data management procedures. +- update information (e.g. transparent data) associated to the subscription data management. + +### 5.3.2.2 Get + +#### 5.3.2.2.1 General + +The following procedures using the Get service operation are supported: + +- Repository Data Retrieval +- IMS Identity Data (e.g. IMS associated identities including Implicit Registration Set and Alias Group) Retrieval +- IMS Profile Data (e.g. IFCs) Retrieval +- IMS Location Data Retrieval +- IMS Registration Status Data Retrieval +- Access Data (e.g. T-ADS) Retrieval +- SRVCC Data (e.g. STN-SR) Retrieval + +- Service Data (e.g. DSAI) Retrieval +- Retrieval Of Multiple Data Sets +- Shared Subscription Data Retrieval +- Trace Data Retrieval +- PSI Activation State Retrieval +- DSAI information Retrieval +- S-CSCF Selection Assistance Information Retrieval + +When the feature SharedData is supported and the retrieved UE-individual data (i.e. data other than Shared Subscription Data) contain SharedDataIds, the NF service consumer shall also retrieve the shared data identified by the received shared data Ids unless the identified shared data are already available at the NF service consumer. The order of sequence of sharedDataIds within UE-individual data is significant: Individual data take precedence over shared data; shared data "SharedDataX" identified by a sharedDataId X takes precedence over shared data "SharedDataY" identified by a sharedDataId Y if X appears before Y within the list of SharedDataIds in the UE-individual data. + +### 5.3.2.2.2 Identity Data + +#### 5.3.2.2.2.1 IMS Identity Data Retrieval + +Figure 5.3.2.2.2.1-1 shows a scenario where the NF service consumer (IMS-AS) sends a request to the HSS to receive the UE's IMS Identity Data for the IMS associated Identities (IRS and Alias group information). The request contains the UE's identity (/imsUeId), the type of the requested information (/identities/ims-associated-identities) and query parameters (e.g. supported-features). + +![Sequence diagram showing IMS Identity Data Retrieval between IMS-AS and HSS. The IMS-AS sends a GET request to the HSS. The HSS responds with either 200 OK (containing ImplicitRegistrationSet and AliasGroupInformation), 404 Not Found, or a 3xx Redirect.](9b686adccf125267a013fa25721231a3_img.jpg) + +``` + +sequenceDiagram + participant IMS-AS + participant HSS + Note left of IMS-AS: 1. GET request + IMS-AS->>HSS: 1. GET « ^imsUeId}/identities/ims-associated-identities + Note right of HSS: 2a. 200 OK (ImplicitRegistrationSet, AliasGroupInformation) +2b. 404 Not Found +2c. 3xx Redirect + HSS-->>IMS-AS: 2a. 200 OK (ImplicitRegistrationSet, AliasGroupInformation) + Note right of HSS: 2b. 404 Not Found + Note right of HSS: 2c. 3xx Redirect + +``` + +Sequence diagram showing IMS Identity Data Retrieval between IMS-AS and HSS. The IMS-AS sends a GET request to the HSS. The HSS responds with either 200 OK (containing ImplicitRegistrationSet and AliasGroupInformation), 404 Not Found, or a 3xx Redirect. + +**Figure 5.3.2.2.2.1-1: IMS Identity Data Retrieval** + +1. The NF service consumer (IMS-AS) sends a GET request to the resource representing the UE's Identity Data for the IMS associated identities with query parameters indicating the supported-features. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the UE's Implicit Registration Set (if any) and the Alias Group information (if any) which the UE's identity belongs to as relevant for the requesting NF service consumer. Additional information (e.g. distinct or wildcarded type of identity, registration state of the IRS) is also included in the response. +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.2.2.2 MSISDN(s) Retrieval + +Figure 5.3.2.2.2.2-1 shows a scenario where the NF service consumer (IMS-AS) sends a request to the HSS to receive the UE's MSISDN(s). The request contains the UE's identity (/{imsUeId}), the type of the requested information (/identities/msisdns) and query parameters (e.g. supported-features). + +![Sequence diagram for MSISDN(s) Retrieval showing IMS-AS sending a GET request to HSS and receiving a response.](4cde160bcc69b7b6c81b648dd0e4252e_img.jpg) + +``` + +sequenceDiagram + participant IMS-AS + participant HSS + Note right of HSS: 1. GET « ^imsUeId}/identities/msisdns + IMS-AS->>HSS: Request + Note left of IMS-AS: 2a. 200 OK (MsisdnList) +2b. 404 Not Found +2c. 3xx Redirect + HSS-->>IMS-AS: Response + +``` + +Sequence diagram for MSISDN(s) Retrieval showing IMS-AS sending a GET request to HSS and receiving a response. + +**Figure 5.3.2.2.2.2-1: MSISDN(s) Retrieval** + +1. The NF service consumer (IMS-AS) sends a GET request to the resource representing the UE's MSISDN(s) with query parameters indicating the supported-features. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the UE's MSISDN(s) as relevant for the requesting NF service consumer. The type of MSISDN (basic/C-MSISDN or additional MSISDN) is included in the response. +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.2.2.3 Private Identities Retrieval + +Figure 5.3.2.2.2.3-1 shows a scenario where the NF service consumer (IMS-AS) sends a request to the HSS to receive the UE's Private Identities (IMS Private User Identity, IMSI). The request contains the UE's identity (/{imsUeId}), the type of the requested information (/identities/private-identities) and query parameters (e.g. supported-features). + +![Sequence diagram for Private Identities Retrieval showing IMS-AS sending a GET request to HSS and receiving a response.](6929132b4964d52244da61d4614bc4d6_img.jpg) + +``` + +sequenceDiagram + participant IMS-AS + participant HSS + Note right of HSS: 1. GET « ^imsUeId}/identities/private-identities + IMS-AS->>HSS: Request + Note left of IMS-AS: 2a. 200 OK (PrivateIdentities) +2b. 404 Not Found +2c. 3xx Redirect + HSS-->>IMS-AS: Response + +``` + +Sequence diagram for Private Identities Retrieval showing IMS-AS sending a GET request to HSS and receiving a response. + +**Figure 5.3.2.2.2.3-1: Private Identities Retrieval** + +1. The NF service consumer (IMS-AS) sends a GET request to the resource representing the UE's Private Identities with query optional parameters indicating the supported-features and/or impi. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the UE's Private Identities as relevant for the requesting NF service consumer. The type of Private Identity (e.g. IMPI, IMSI) is included in the response. If an impi was provided as query parameter in the GET request, only the Private Identity of type IMSI that is associated with the provided impi shall be returned. + +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.2.2.4 IMEI(SV) Retrieval + +Figure 5.3.2.2.2.4-1 shows a scenario where the NF service consumer (e.g. IMS AS) sends a request to the HSS to receive the IMEI(SV) for the UE. The request contains the UE's identity (/{imsUeId}), the type of the requested information (/identities/imeisv) and query parameters (e.g. supported-features). + +![Sequence diagram for IMEI(SV) Retrieval](4af57aad638888edf2062306f8a54a6c_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant HSS + NF Service Consumer->>HSS: 1. GET « ^imsUeId}/Identities/imeisv + Note over NF Service Consumer,HSS: 2a. 200 OK (ImeiSvInformation) +2b. 404 Not Found +2c. 3xx Redirect + HSS-->>NF Service Consumer: + +``` + +Sequence diagram for IMEI(SV) Retrieval + +**Figure 5.3.2.2.2.4-1: IMEI(SV) Retrieval** + +1. The NF service consumer (e.g. IMS AS) sends a GET request to the resource representing the UE's IMEI(SV) information with query parameters indicating the supported-features. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the last known IMEI(SV) associated to the UE. +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +### 5.3.2.2.3 IMS Location Data and Status + +#### 5.3.2.2.3.1 S-CSCF Capabilities Retrieval + +Figure 5.3.2.2.3.1-1 shows a scenario where the NF service consumer (I-CSCF), after authorization information has been performed without obtaining an S-CSCF name, sends a request to the HSS to receive the UE's S-CSCF capabilities (mandatory and/or optional). The request contains the UE's identity (/{imsUeId}), the type of the requested information (/ims-data/location-data/scscf-capabilities) and query parameters (e.g. supported-features). + +![Sequence diagram for S-CSCF Capabilities Retrieval. The diagram shows two lifelines: I-CSCF and HSS. The I-CSCF sends a GET request to the HSS for the resource ^imsUId}/ims-data/location-data/scscf-capabilities. The HSS responds with one of three options: 2a. 200 OK (ScscfCapabilityList), 2b. 404 Not Found, or 2c. 3xx Redirect.](28d75f39a24203712ee907b32cf0bbe5_img.jpg) + +``` + +sequenceDiagram + participant I-CSCF + participant HSS + Note right of HSS: 2a. 200 OK (ScscfCapabilityList) +2b. 404 Not Found +2c. 3xx Redirect + I-CSCF->>HSS: 1. GET « ^imsUId}/ims-data/location-data/scscf-capabilities + HSS-->>I-CSCF: 2a. 200 OK (ScscfCapabilityList) +2b. 404 Not Found +2c. 3xx Redirect + +``` + +Sequence diagram for S-CSCF Capabilities Retrieval. The diagram shows two lifelines: I-CSCF and HSS. The I-CSCF sends a GET request to the HSS for the resource ^imsUId}/ims-data/location-data/scscf-capabilities. The HSS responds with one of three options: 2a. 200 OK (ScscfCapabilityList), 2b. 404 Not Found, or 2c. 3xx Redirect. + +**Figure 5.3.2.2.3.1-1: S-CSCF Capabilities Retrieval** + +1. The NF service consumer (I-CSCF) sends a GET request to the resource representing the UE's S-CSCF capabilities with query parameters indicating the supported-features. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the UE's S-CSCF capabilities relevant for the requesting NF service consumer. The type of S-CSCF capabilities (mandatory and/or optional) is included in the response. +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.2.3.2 Server Name Retrieval + +Figure 5.3.2.2.3.2-1 shows a scenario where the NF service consumer (e.g. AS) sends a request to the HSS to receive the Server Name (S-CSCF name) associated to the UE. The request contains the UE's identity (/{imsUeId}), the type of the requested information (ims-data/location-data/server-name) and query parameters (e.g. supported-features). + +![Sequence diagram for Server Name Retrieval. The diagram shows two lifelines: NF Service Consumer and HSS. The NF Service Consumer sends a GET request to the HSS for the resource ^imsUId}/ims-data/location-data/server-name. The HSS responds with one of three options: 2a. 200 OK (ImLocationData), 2b. 404 Not Found, or 2c. 3xx Redirect.](84e5b251aa38db522f76f5cc3afcb853_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant HSS + Note right of HSS: 2a. 200 OK (ImLocationData) +2b. 404 Not Found +2c. 3xx Redirect + NF Service Consumer->>HSS: 1. GET « ^imsUId}/ims-data/location-data/server-name + HSS-->>NF Service Consumer: 2a. 200 OK (ImLocationData) +2b. 404 Not Found +2c. 3xx Redirect + +``` + +Sequence diagram for Server Name Retrieval. The diagram shows two lifelines: NF Service Consumer and HSS. The NF Service Consumer sends a GET request to the HSS for the resource ^imsUId}/ims-data/location-data/server-name. The HSS responds with one of three options: 2a. 200 OK (ImLocationData), 2b. 404 Not Found, or 2c. 3xx Redirect. + +**Figure 5.3.2.2.3.2-1: Server Name Retrieval** + +1. The NF service consumer (e.g. AS) sends a GET request to the resource representing the UE's IMS location information with query parameters indicating the supported-features. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the IMS location information (S-CSCF name) as relevant for the service consumer. +- 2b. If there is no valid data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +### 5.3.2.2.3.3 IMS Registration Status Retrieval + +Figure 5.3.2.2.3.3-1 shows a scenario where the NF service consumer (e.g. AS) sends a request to the HSS to IMS registration status of a user. The request contains the UE's identity (`{imsUeId}`), the type of the requested information (`ims-data/registration-status`) and query parameters (e.g. `supported-features`). + +![Sequence diagram for IMS Registration Status Retrieval](7d2d1d3870cd224c4430d19334557716_img.jpg) + +The diagram shows a sequence between an "NF Service Consumer" and an "HSS". + 1. The NF Service Consumer sends a GET request to the HSS: `GET « ^imsUeId}/ims-data/registration-status`. + 2. The HSS responds with one of the following: + - 2a. `200 OK (ImsRegistrationStatus)` + - 2b. `404 Not Found` + - 2c. `3xx Redirect` + +Sequence diagram for IMS Registration Status Retrieval + +**Figure 5.3.2.2.3.3-1: IMS Registration Status Retrieval** + +1. The NF service consumer (e.g. AS) sends a GET request to the resource representing the UE's IMS registration status with query parameters indicating the supported-features. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the IMS registration status (e.g. unregistered) as relevant for the service consumer. +- 2b. If there is no valid data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +### 5.3.2.2.3.4 S-CSCF Selection Assistance Information Retrieval + +Figure 5.3.2.2.3.4-1 shows a scenario where the NF service consumer (I-CSCF), sends a request to the HSS to receive the UE's S-CSCF Selection Assistance Information. The request contains the UE's identity (`{imsUeId}`), the type of the requested information (`/ims-data/location-data/scscf-selection-assistance-info`) and query parameters (e.g. `supported-features`). + +![Sequence diagram for S-CSCF Selection Assistance Information Retrieval](cad89c017c9e7c1785bcd104fde4e737_img.jpg) + +The diagram shows a sequence between an "I-CSCF" and an "HSS". + 1. The I-CSCF sends a GET request to the HSS: `GET « ^imsUeId}/ims-data/location-data/scscf-selection-assistance-info`. + 2. The HSS responds with one of the following: + - 2a. `200 OK (ScscfSelectionAssistanceInformation)` + - 2b. `404 Not Found` + - 2c. `3xx Redirect` + +Sequence diagram for S-CSCF Selection Assistance Information Retrieval + +**5.3.2.2.3.4-1: S-CSCF Selection assistance Information Retrieval** + +1. The NF service consumer (I-CSCF) sends a GET request to the resource representing the UE's S-CSCF Selection Assistance Information with query parameters indicating the supported-features. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the UE's S-CSCF Selection Assistance Information. +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.2.4 IMS Profile Data + +##### 5.3.2.2.4.1 IMS User Profile Retrieval + +Figure 5.3.2.2.4.1-1 shows a scenario where the NF service consumer (S-CSCF) sends a request to the HSS to receive the UE's IMS profile data. The request contains the UE's identity (`{imsUeId}`), the type of the requested information (`/ims-data/profile-data`) and query parameters (e.g. `supported-features`). + +![Sequence diagram for IMS User Profile Retrieval](dc1f232cfd39be5c20b21374ad4c04c0_img.jpg) + +``` +sequenceDiagram + participant NF Service Consumer + participant HSS + Note left of NF Service Consumer: 1. GET « ^imsUeId}/ims-data/profile-data + NF Service Consumer->>HSS: Request + Note right of HSS: 2a. 200 OK (ImsProfileData) + Note right of HSS: 2b. 404 Not Found + Note right of HSS: 2c. 3xx Redirect + HSS-->>NF Service Consumer: Response +``` + +The diagram illustrates the interaction between an NF Service Consumer and an HSS for IMS User Profile Retrieval. The NF Service Consumer sends a GET request to the HSS. The HSS responds with one of three possible outcomes: 2a. 200 OK (ImsProfileData), 2b. 404 Not Found, or 2c. 3xx Redirect. + +Sequence diagram for IMS User Profile Retrieval + +Figure 5.3.2.2.4.1-1: IMS User Profile Retrieval + +1. The NF service consumer (S-CSCF) sends a GET request to the resource representing the UE's IMS profile with query parameters indicating the supported-features. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the UE's Profile Data as relevant for the requesting NF service consumer. The Initial Filter Criteria (IFC) is included in the response. Additional information (e.g. service priority information), if any, may also be included. +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +##### 5.3.2.2.4.2 Service Priority Level Information Retrieval + +Figure 5.3.2.2.4.2-1 shows a scenario where the NF service consumer (e.g. AS) sends a request to the HSS to receive the Service Priority levels allowed for the UE. The request contains the UE's identity (`{imsUeId}`), the type of the requested information (`/ims-data/profile-data/priority-levels`) and query parameters (e.g. `supported-features`). + +![Sequence diagram for Service Priority Level Information Retrieval](8dd83c9e4e123aaaf3d521db1c4c416d_img.jpg) + +``` +sequenceDiagram + participant NF Service Consumer + participant HSS + Note left of NF Service Consumer: 1. GET « ^imsUeId}/ims-data/profile-data/priority-levels + NF Service Consumer->>HSS: Request + Note right of HSS: 2a. 200 OK (PriorityLevels) + Note right of HSS: 2b. 404 Not Found + Note right of HSS: 2c. 3xx Redirect + HSS-->>NF Service Consumer: Response +``` + +The diagram illustrates the interaction between an NF Service Consumer and an HSS for Service Priority Level Information Retrieval. The NF Service Consumer sends a GET request to the HSS. The HSS responds with one of three possible outcomes: 2a. 200 OK (PriorityLevels), 2b. 404 Not Found, or 2c. 3xx Redirect. + +Sequence diagram for Service Priority Level Information Retrieval + +Figure 5.3.2.2.4.2-1: Service Priority Level Information Retrieval + +1. The NF service consumer (e.g. AS) sends a GET request to the resource representing the UE's Service Priority Level with query parameters indicating the supported-features. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the Namespaces and priority levels allowed for the user. +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.2.4.3 Initial Filter Criteria Retrieval + +Figure 5.3.2.2.4.3-1 shows a scenario where the NF service consumer (e.g. AS, S-CSCF) sends a request to the HSS to receive the UE's Initial Filter Criteria. The request contains the UE's identity (/{imsUeId}), the type of the requested information (ims-data/profile-data/ifcs) and query parameters (e.g. supported-features). + +![Sequence diagram for Initial Filter Criteria Retrieval. The NF Service Consumer sends a GET request to the HSS. The HSS responds with one of three options: 2a. 200 OK (Ifcs), 2b. 404 Not Found, or 2c. 3xx Redirect.](f0b7abcb093621bb310bf61fbe0f0d2d_img.jpg) + +``` +sequenceDiagram + participant NF Service Consumer + participant HSS + Note left of NF Service Consumer: 1. GET « ^imsUeId}/ims-data/profile-data/ifcs + NF Service Consumer->>HSS: Request + Note right of HSS: 2a. 200 OK (Ifcs) +2b. 404 Not Found +2c. 3xx Redirect + HSS-->>NF Service Consumer: Response +``` + +Sequence diagram for Initial Filter Criteria Retrieval. The NF Service Consumer sends a GET request to the HSS. The HSS responds with one of three options: 2a. 200 OK (Ifcs), 2b. 404 Not Found, or 2c. 3xx Redirect. + +**Figure 5.3.2.2.4.3-1: Initial Filter Criteria Retrieval** + +1. The NF service consumer (e.g. AS) sends a GET request to the resource representing the UE's IMS profile with query parameters indicating the supported-features. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the UE's Initial Filter Criteria (possibly containing S-CSCF-Specific IFC Set Identifiers, if supported and configured in S-CSCF) as relevant for the requesting NF service consumer. +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.2.4.4 Service Trace Level Information Retrieval + +Figure 5.3.2.2.4.4-1 shows a scenario where the NF service consumer (e.g. AS) sends a request to the HSS to receive the UE's IMS service level trace information associated to the UE. The request contains the UE's identity (/{imsUeId}), the type of the requested information (ims-data/profile-data/ service-level-trace-info) and query parameters (e.g. supported-features). + +![Sequence diagram for Service Trace Level Information Retrieval. The NF Service Consumer sends a GET request to the HSS for ^imsUeId}/ims-data/profile-data/service-level-trace-info. The HSS responds with 200 OK (ServiceLevelTraceInformation), 404 Not Found, or 3xx Redirect.](b5335262987c819d7f71ce40f99cb71b_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant HSS + Note right of HSS: 2a. 200 OK (ServiceLevelTraceInformation) +2b. 404 Not Found +2c. 3xx Redirect + NF Service Consumer->>HSS: 1. GET « ^imsUeId}/ims-data/profile-data/service-level-trace-info + HSS-->>NF Service Consumer: + +``` + +Sequence diagram for Service Trace Level Information Retrieval. The NF Service Consumer sends a GET request to the HSS for ^imsUeId}/ims-data/profile-data/service-level-trace-info. The HSS responds with 200 OK (ServiceLevelTraceInformation), 404 Not Found, or 3xx Redirect. + +**Figure 5.3.2.2.4.4-1: Service Trace Level Information Retrieval** + +1. The NF service consumer (e.g. AS) sends a GET request to the resource representing the UE's IMS service level trace information with query parameters indicating the supported-features. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the IMS service level trace information (see 3GPP TS 24.323 [24]) so that the service consumer performs logging at IMS service level as described in IETF RFC 8497 [23]. +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +## 5.3.2.2.5 Access Data + +### 5.3.2.2.5.1 Location Information Retrieval for CS/PS Domains + +Figure 5.3.2.2.5.1-1 shows a scenario where the NF service consumer (e.g. AS) sends a request to the HSS to receive the Location Information associated to the UE. The request contains the UE's identity (/imsUeId), the type of the requested information, the domain (cs-domain or ps-domain) requested (e.g. ims-data/access-data/ps-domain/location-data) and query parameters (e.g. supported-features, requested-nodes). + +![Sequence diagram for Location Information Retrieval for CS/PS Domains. The NF Service Consumer sends two GET requests to the HSS: 1a. GET ^imsUeId}/access-data/ps-domain/location-data and 1b. GET ^imsUeId}/access-data/cs-domain/location-data. The HSS responds with 200 OK (PsLocation), 200 OK (CsLocation), 404 Not Found, or 3xx Redirect.](f324fbc5d5af1e4da9cd932389f0064c_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant HSS + Note right of HSS: 2a. 200 OK (PsLocation) +2b. 200 OK (CsLocation) +2c. 404 Not Found +2d. 3xx Redirect + NF Service Consumer->>HSS: 1a. GET « ^imsUeId}/access-data/ps-domain/location-data + NF Service Consumer->>HSS: 1b. GET « ^imsUeId}/access-data/cs-domain/location-data + HSS-->>NF Service Consumer: + +``` + +Sequence diagram for Location Information Retrieval for CS/PS Domains. The NF Service Consumer sends two GET requests to the HSS: 1a. GET ^imsUeId}/access-data/ps-domain/location-data and 1b. GET ^imsUeId}/access-data/cs-domain/location-data. The HSS responds with 200 OK (PsLocation), 200 OK (CsLocation), 404 Not Found, or 3xx Redirect. + +**Figure 5.3.2.2.5.1-1: Location Information Retrieval for CS/PS Domains** + +- 1a. The NF service consumer (e.g. AS) sends a GET request to the resource representing the UE's location information at PS domain with query parameters indicating the supported-features and optionally the requested nodes (e.g. MME, AMF) +- 1b. The NF service consumer (e.g. AS) sends a GET request to the resource representing the UE's location information at CS domain with query parameters indicating the supported-features. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the location information for the requested domain (PS) and the requested nodes or all nodes (if no requested nodes were present in the request) + +- 2b. On success, the HSS responds with "200 OK" with the message body containing the location information for the requested domain (CS). +- 2c. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.2.5.2 IP Address Information Retrieval + +Figure 5.3.2.2.5.2-1 shows a scenario where the NF service consumer (e.g. SCC-AS) sends a request to the HSS to receive the IP Address of the UE. The request contains the UE's identity (`{imsUeId}`), the type of the requested information (`/access-data/ps-domain/ip-address`) and query parameters (e.g. `supported-features`). + +![Sequence diagram for IP Address Information Retrieval. The NF Service Consumer sends a GET request to the HSS. The HSS responds with one of three options: 2a. 200 OK (IpAddress), 2b. 404 Not Found, or 2c. 3xx Redirect.](836b0790cef5469a167fa8931df4e408_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant HSS + NF Service Consumer->>HSS: 1. GET « ^imsUeId}/access-data/ps-domain/ip-address + HSS-->>NF Service Consumer: 2a. 200 OK (IpAddress) + HSS-->>NF Service Consumer: 2b. 404 Not Found + HSS-->>NF Service Consumer: 2c. 3xx Redirect + +``` + +Sequence diagram for IP Address Information Retrieval. The NF Service Consumer sends a GET request to the HSS. The HSS responds with one of three options: 2a. 200 OK (IpAddress), 2b. 404 Not Found, or 2c. 3xx Redirect. + +**Figure 5.3.2.2.5.2-1: IP Address Information Retrieval** + +1. The NF service consumer (e.g. SCC-AS) sends a GET request to the resource representing the UE's IP address information with query parameters indicating the supported-features. +- 2a. On success, the HSS responds with "200 OK" with the message body containing either an IPv4 address, IPv6 address or IPv6 prefix and/or IPv6 interface identifier. +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.2.5.3 T-ADS Information Retrieval + +Figure 5.3.2.2.5.3-1 shows a scenario where the NF service consumer (e.g. SCC-AS) sends a request to the HSS to receive the T-ADS information for the UE. The request contains the UE's identity (`{imsUeId}`), the type of the requested information (`/access-data/ps-domain/tads-info`) and query parameters (e.g. `supported-features`). + +![Sequence diagram for T-ADS Information Retrieval. An NF Service Consumer sends a GET request to an HSS. The HSS responds with one of three options: 2a. 200 OK (TadsInformation), 2b. 404 Not Found, or 2c. 3xx Redirect.](6e15fc9ea763541c5913d26f85072ae1_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant HSS + Note left of NF Service Consumer: 1. GET « ^imsUeld}/access-data/ps-domain/tads-info + NF Service Consumer->>HSS: Request + Note right of HSS: 2a. 200 OK (TadsInformation) +2b. 404 Not Found +2c. 3xx Redirect + HSS-->>NF Service Consumer: Response + +``` + +Sequence diagram for T-ADS Information Retrieval. An NF Service Consumer sends a GET request to an HSS. The HSS responds with one of three options: 2a. 200 OK (TadsInformation), 2b. 404 Not Found, or 2c. 3xx Redirect. + +**Figure 5.3.2.2.5.3-1: T-ADS Information Retrieval** + +1. The NF service consumer (e.g. SCC-AS) sends a GET request to the resource representing the UE's T-ADS information with query parameters indicating the supported-features. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the most recent IMS Voice over PS Sessions support indication as indicated by the serving nodes for the user. +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.2.5.4 User State Retrieval for CS/PS Domains + +Figure 5.3.2.2.5.4-1 shows a scenario where the NF service consumer (e.g. AS) sends a request to the HSS to receive the User State associated to the UE. The request contains the UE's identity (`{imsUeld}`), the type of the requested information, the domain (cs-domain or ps-domain) requested (e.g. `ims-data/access-data/ps-domain/user-state`) and query parameters (e.g. supported-features, requested-nodes). + +![Sequence diagram for User State Retrieval for CS/PS Domains. An NF Service Consumer sends two possible GET requests to an HSS. The HSS responds with one of four options: 2a. 200 OK (PsUserState), 2b. 200 OK (CsUserState), 2c. 404 Not Found, or 2d. 3xx Redirect.](05d8710f69c476939295486ab1440350_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant HSS + Note left of NF Service Consumer: 1a. GET « ^imsUeld}/access-data/ps-domain/user-state +1b. GET « ^imsUeld}/access-data/cs-domain/user-state + NF Service Consumer->>HSS: Request + Note right of HSS: 2a. 200 OK (PsUserState) +2b. 200 OK (CsUserState) +2c. 404 Not Found +2d. 3xx Redirect + HSS-->>NF Service Consumer: Response + +``` + +Sequence diagram for User State Retrieval for CS/PS Domains. An NF Service Consumer sends two possible GET requests to an HSS. The HSS responds with one of four options: 2a. 200 OK (PsUserState), 2b. 200 OK (CsUserState), 2c. 404 Not Found, or 2d. 3xx Redirect. + +**Figure 5.3.2.2.5.4-1: User State Retrieval for CS/PS Domains** + +- 1a. The NF service consumer (e.g. AS) sends a GET request to the resource representing the UE's user state information at PS domain with query parameters indicating the supported-features and optionally the requested nodes (e.g. MME, AMF) +- 1b. The NF service consumer (e.g. AS) sends a GET request to the resource representing the UE's User State information at CS domain with query parameters indicating the supported-features. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the User State information for the requested domain (PS) and the requested nodes or all nodes (if no requested nodes were present in the request) +- 2b. On success, the HSS responds with "200 OK" with the message body containing the User State information for the requested domain (CS). + +- 2c. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.2.5.5 CSRN Retrieval + +Figure 5.3.2.2.5.5-1 shows a scenario where the NF service consumer (e.g. SCC-AS) sends a request to the HSS to receive a CS Domain Routing Number (CSRN, see 3GPP TS 23.003 [13]) for the UE. The request contains the UE's identity (/{imsUeId}), the type of the requested information (/access-data/cs-domain/csrn) and query parameters (e.g. supported-features, pre-paging). + +![Sequence diagram for CSRN Retrieval. The NF Service Consumer sends a GET request to the HSS. The HSS responds with one of three options: 2a. 200 OK (Csrn), 2b. 404 Not Found, or 2c. 3xx Redirect.](409498e57b1f988b2b604d12cd997002_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant HSS + Note left of NF Service Consumer: 1. GET « ^imsUeId}/access-data/cs-domain/csrn + NF Service Consumer->>HSS: Request + Note right of HSS: 2a. 200 OK (Csrn) +2b. 404 Not Found +2c. 3xx Redirect + HSS-->>NF Service Consumer: Response + +``` + +Sequence diagram for CSRN Retrieval. The NF Service Consumer sends a GET request to the HSS. The HSS responds with one of three options: 2a. 200 OK (Csrn), 2b. 404 Not Found, or 2c. 3xx Redirect. + +**Figure 5.3.2.2.5.5-1: T-ADS Information Retrieval** + +1. The NF service consumer (e.g. SCC-AS) sends a GET request to the resource representing the UE's CSRN information with query parameters indicating the supported-features and/or pre-paging indication. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the CSRN as provided by the MSC/VLR. +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.2.5.6 Reference Location Information Retrieval + +Figure 5.3.2.2.5.6-1 shows a scenario where the NF service consumer (e.g. IMS-AS) sends a request to the HSS to receive the reference location information for the UE. The request contains the UE's identity (/{imsUeId}), the type of the requested information (/access-data/wireline-domain/reference-location) and query parameters (e.g. supported-features). + +![Sequence diagram for Reference Location Information Retrieval. The NF Service Consumer sends a GET request to the HSS. The HSS responds with 200 OK, 404 Not Found, or 3xx Redirect.](78ff716475b2f65bf01c3a4d02d89fc4_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant HSS + Note right of NF Service Consumer: 1. GET « ^imsUeId}/access-data/wireline-domain/reference-location + NF Service Consumer->>HSS: 1. GET « ^imsUeId}/access-data/wireline-domain/reference-location + Note right of HSS: 2a. 200 OK (ReferenceLocationInformation) +2b. 404 Not Found +2c. 3xx Redirect + HSS-->>NF Service Consumer: 2a. 200 OK (ReferenceLocationInformation) +2b. 404 Not Found +2c. 3xx Redirect + +``` + +Sequence diagram for Reference Location Information Retrieval. The NF Service Consumer sends a GET request to the HSS. The HSS responds with 200 OK, 404 Not Found, or 3xx Redirect. + +**Figure 5.3.2.2.5.6-1: Reference Location Information Retrieval** + +1. The NF service consumer (e.g. IMS-AS) sends a GET request to the resource representing the UE's reference location information with query parameters indicating the supported-features. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the access type and/or the access info and associated value (line identifier in fixed access networks). +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +## 5.3.2.2.6 SRVCC Data + +### 5.3.2.2.6.1 SRVCC Data Retrieval + +Figure 5.3.2.2.6.1-1 shows a scenario where the NF service consumer (e.g. AS) sends a request to the HSS to retrieve the SRVCC data for the UE. The request contains the UE's identity (/imsUeId), the type of the requested information (/srvcc-data) and query parameters (e.g. supported-features). + +![Sequence diagram for SRVCC Data Retrieval. The NF Service Consumer sends a GET request to the HSS. The HSS responds with 200 OK, 404 Not Found, or 3xx Redirect.](e38206fcefa2045af01d494b2956775a_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant HSS + Note right of NF Service Consumer: 1. GET « ^imsUeId}/srvcc-data + NF Service Consumer->>HSS: 1. GET « ^imsUeId}/srvcc-data + Note right of HSS: 2a. 200 OK (SrvccData) +2b. 404 Not Found +2c. 3xx Redirect + HSS-->>NF Service Consumer: 2a. 200 OK (SrvccData) +2b. 404 Not Found +2c. 3xx Redirect + +``` + +Sequence diagram for SRVCC Data Retrieval. The NF Service Consumer sends a GET request to the HSS. The HSS responds with 200 OK, 404 Not Found, or 3xx Redirect. + +**Figure 5.3.2.2.6.2-1: SRVCC Data Retrieval** + +1. The NF service consumer (e.g. AS) sends a GET request to the resource representing the UE's SRVCC data information with query parameters indicating the supported-features. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the STN-SR and the UE SRVCC capability for the user. +- 2b. If there is no valid SRVCC data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +### 5.3.2.2.7 Service Data + +#### 5.3.2.2.7.1 PSI Activation State Retrieval + +Figure 5.3.2.2.7.1-1 shows a scenario where the NF service consumer (e.g. AS) sends a request to the HSS to retrieve the PSI activation state. The request contains the Public Service Identity (/{imsUeId}), the type of the requested information (/service-data/psi-status) and query parameters (e.g. supported-features). + +![Sequence diagram for PSI Activation State Retrieval showing a GET request from NF Service Consumer to HSS and subsequent responses: 200 OK, 404 Not Found, or 3xx Redirect.](896e86ed12aff206d302c64f2e3091fa_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant HSS + NF Service Consumer->>HSS: 1. GET /{imsUeId}/service-data/psi-status + HSS-->>NF Service Consumer: 2a. 200 OK (PsiActivationState) + HSS-->>NF Service Consumer: 2b. 404 Not Found + HSS-->>NF Service Consumer: 2c. 3xx Redirect + +``` + +Sequence diagram for PSI Activation State Retrieval showing a GET request from NF Service Consumer to HSS and subsequent responses: 200 OK, 404 Not Found, or 3xx Redirect. + +**Figure 5.3.2.2.7.1-1: PSI Activation State Retrieval** + +- 1. The NF service consumer (e.g. AS) sends a GET request to the resource representing the PSI activation state with query parameters indicating the supported-features. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the PSI activation state (active or inactive). +- 2b. If there is no valid activation state for the PSI, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.2.7.2 SMS Registration Information retrieval + +Figure 5.3.2.2.7.2-1 shows a scenario where the NF service consumer (e.g. IP-SM-GW) sends a request to the HSS to retrieve the SMS registration information associated to a UE. The request contains the UE identity (/{imsUeId}), the type of the requested information (/service-data/sms-registration-info) and query parameters (e.g. supported-features). + +![Sequence diagram for SMS Registration Information Retrieval showing a GET request from NF Service Consumer to HSS and subsequent responses: 200 OK, 404 Not Found, or 3xx Redirect.](6c6d2bce2630f62fb3a5345c9ec84f68_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant HSS + NF Service Consumer->>HSS: 1. GET /{imsUeId}/service-data/sms-registration-info + HSS-->>NF Service Consumer: 2a. 200 OK (SmsRegistrationInfo) + HSS-->>NF Service Consumer: 2b. 404 Not Found + HSS-->>NF Service Consumer: 2c. 3xx Redirect + +``` + +Sequence diagram for SMS Registration Information Retrieval showing a GET request from NF Service Consumer to HSS and subsequent responses: 200 OK, 404 Not Found, or 3xx Redirect. + +**Figure 5.3.2.2.7.2-1: SMS Registration Information Retrieval** + +- 1. The NF service consumer (e.g. IP-SM-GW) sends a GET request to the resource representing the SMS registration information with query parameters indicating the supported-features. + +- 2a. On success, the HSS responds with "200 OK" with the message body containing the IP-SM-GW number and optionally the SC address. +- 2b. If there is no valid SMS registration information, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.2.7.3 DSAI Information retrieval + +Figure 5.3.2.2.7.3-1 shows a scenario where the NF service consumer (e.g. IMS-AS) sends a request to the HSS to retrieve the DSAI information associated to an Application Server. The request contains the UE identity (/{imsUeId}), the type of the requested information (/service-data/dsai) and query parameters (e.g. Application Server Name). + +![Sequence diagram for DSAI Information Retrieval. The NF Service Consumer sends a GET request to the HSS. The HSS responds with one of three options: 2a. 200 OK (DsaiTagInformation), 2b. 404 Not Found, or 2c. 3xx Redirect.](f1091147d93cee4dfa88498610e395a7_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant HSS + Note left of NF Service Consumer: 1. GET « ^imsUeId}/service-data/dsai + NF Service Consumer->>HSS: 1. GET « ^imsUeId}/service-data/dsai + Note right of HSS: 2a. 200 OK (DsaiTagInformation) +2b. 404 Not Found +2c. 3xx Redirect + HSS-->>NF Service Consumer: 2a. 200 OK (DsaiTagInformation) +2b. 404 Not Found +2c. 3xx Redirect + +``` + +Sequence diagram for DSAI Information Retrieval. The NF Service Consumer sends a GET request to the HSS. The HSS responds with one of three options: 2a. 200 OK (DsaiTagInformation), 2b. 404 Not Found, or 2c. 3xx Redirect. + +**Figure 5.3.2.2.7.3-1: DSAI Information Retrieval** + +1. The NF service consumer (e.g. IMS-AS) sends a GET request to the resource representing the DSAI information with query parameter indicating the Application Server Name. Additional query parameters (e.g. supported-features) may be included. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the DSAI tags and their respective status associated to the received Application Server Name. +- 2b. If there are no DSAI tags for the Application Server, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.2.8 Repository Data + +##### 5.3.2.2.8.1 Repository Data Retrieval + +Figure 5.3.2.2.8.1-1 shows a scenario where the NF service consumer (IMS-AS) sends a request to the HSS to receive the UE's Repository Data for a given Service Indication. The request contains the UE's identity (/{imsUeId}), the type of the requested information (/repository-data/{serviceIndication}) and query parameters (e.g. supported-features). + +![Sequence diagram for Repository Data Retrieval between IMS-AS and HSS.](329c96049bb432e9c2cbda4e224a0c9c_img.jpg) + +``` + +sequenceDiagram + participant IMS-AS + participant HSS + IMS-AS->>HSS: 1. GET « ^{imsUeld}/repository-data/{serviceIndication} » + HSS-->>IMS-AS: 2a. 200 OK (RepositoryData) + HSS-->>IMS-AS: 2b. 404 Not Found + HSS-->>IMS-AS: 2c. 3xx Redirect + +``` + +The diagram illustrates the interaction for Repository Data Retrieval. It starts with the IMS-AS sending a GET request to the HSS. The HSS responds with one of three possible outcomes: 2a. 200 OK (RepositoryData), 2b. 404 Not Found, or 2c. 3xx Redirect. + +Sequence diagram for Repository Data Retrieval between IMS-AS and HSS. + +**Figure 5.3.2.2.8.1-1: Repository Data Retrieval** + +- 1. The NF service consumer (IMS-AS) sends a GET request to the resource representing the UE's Repository Data for a given Service Indication, with query parameters indicating the supported-features. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the UE's Repository Data for the requested Service Indication as relevant for the requesting NF service consumer. +- 2b. If there is no valid subscription data or Repository Data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +## 5.3.2.2.9 Shared Subscription Data + +### 5.3.2.2.9.1 Shared Subscription Data Retrieval + +Figure 5.3.2.2.9.1-1 shows a scenario where the NF service consumer (e.g. S-CSCF) sends a request to the HSS to receive the shared subscription data. The request contains the type of the requested information (/shared-data) and query parameters (supportedFeatures, shared-data-id). + +![Sequence diagram for Shared Subscription Data Retrieval between NF service consumer and UDM.](c468d53e877568cd7d8c5ba1632c2e65_img.jpg) + +``` + +sequenceDiagram + participant NF as NF service consumer + participant UDM + NF->>UDM: 1. GET « shared-data?shared-data-id=, » + UDM-->>NF: 2a. 200 OK (SharedData) + UDM-->>NF: 2b. 404 Not Found + UDM-->>NF: 2c. 3xx Redirect + +``` + +The diagram illustrates the interaction for Shared Subscription Data Retrieval. It starts with the NF service consumer sending a GET request to the UDM. The UDM responds with one of three possible outcomes: 2a. 200 OK (SharedData), 2b. 404 Not Found, or 2c. 3xx Redirect. + +Sequence diagram for Shared Subscription Data Retrieval between NF service consumer and UDM. + +**Figure 5.3.2.2.9.1-1: Shared Subscription Data Retrieval** + +- 1. The NF service consumer (e.g. S-CSCF) sends a GET request to the resource representing the SharedData, with query parameters indicating the supportedFeatures and shared-data-id. +- 2a. On success, the HSS responds with "200 OK" with the message body containing the SharedData. +- 2b. If there is no valid shared data for one or more of the shared-data-ids, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +### 5.3.2.3 Subscribe + +#### 5.3.2.3.1 General + +The following procedures using the Subscribe service operation are supported: + +- Subscription to notification of data change +- Subscription to notification of UE reachability for IP + +#### 5.3.2.3.2 Subscription to notifications of data change + +Figure 5.3.2.3.2-1 shows a scenario where the NF service consumer (e.g. S-CSCF) sends a request to the HSS to subscribe to notifications of data change. The request contains a callback URI and the URI of the monitored resource. + +![Sequence diagram showing the interaction between an NF service consumer and an HSS for subscribing to notifications of data change. The consumer sends a POST request to the HSS. The HSS responds with one of four possible status codes: 2a. 201 Created, 2b. 404 Not Found, 2c. 501 Not Implemented, or 2d. 3xx Redirect.](f24f909d837b5476783e1bbea2dfc143_img.jpg) + +``` + +sequenceDiagram + participant NF as NF service consumer + participant HSS as HSS + Note right of HSS: 2a. 201 Created (ImsSdmSubscription) +2b. 404 Not Found +2c. 501 Not Implemented +2d. 3xx Redirect + NF->>HSS: 1. POST « ^imsUeId}/subscriptions (ImsSdmSubscription) + HSS-->>NF: 2a. 201 Created (ImsSdmSubscription) +2b. 404 Not Found +2c. 501 Not Implemented +2d. 3xx Redirect + +``` + +Sequence diagram showing the interaction between an NF service consumer and an HSS for subscribing to notifications of data change. The consumer sends a POST request to the HSS. The HSS responds with one of four possible status codes: 2a. 201 Created, 2b. 404 Not Found, 2c. 501 Not Implemented, or 2d. 3xx Redirect. + +**Figure 5.3.2.3.2-1: NF service consumer subscribes to notifications** + +1. The NF service consumer sends a POST request to the parent resource (collection of subscriptions) (`.../{imsUeId}/sdm-subscriptions`), to create a subscription as present in message body. +- 2a. On success, the HSS responds with "201 Created" with the message body containing a representation of the created subscription. The Location HTTP header shall contain the URI of the created subscription. +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). +- 2c. If the UE subscription data exist, but the requested subscription to data change notification cannot be created (e.g. due to an invalid/unsupported data reference to be monitored, contained in the ImsSdmSubscription parameter), HTTP status code "501 Not Implemented" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.3.3 Subscription to notifications of shared data change + +Figure 5.3.2.3.3-1 shows a scenario where the NF service consumer sends a request to the HSS to subscribe to notifications of shared data change. The request contains a callback URI and the URI of the monitored resource. + +![Sequence diagram showing the NF service consumer subscribing to notifications of shared data change. The NF service consumer sends a POST request for shared-data-subscriptions (ImsSdmSubscription) to the HSS. The HSS responds with 2a. 201 Created (ImsSdmSubscription), 2b. 4xx/5xx Client or Server Error, or 2c. 3xx Redirect.](9252ccfbbe9e34cb108f0060f2b563f1_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant HSS + Note right of HSS: 2a. 201 Created (ImsSdmSubscription) +2b. 4xx/5xx Client or Server Error +2c. 3xx Redirect + NF service consumer->>HSS: 1. POST « shared-data-subscriptions (ImsSdmSubscription) » + HSS-->>NF service consumer: 2a. 201 Created (ImsSdmSubscription) +2b. 4xx/5xx Client or Server Error +2c. 3xx Redirect + +``` + +Sequence diagram showing the NF service consumer subscribing to notifications of shared data change. The NF service consumer sends a POST request for shared-data-subscriptions (ImsSdmSubscription) to the HSS. The HSS responds with 2a. 201 Created (ImsSdmSubscription), 2b. 4xx/5xx Client or Server Error, or 2c. 3xx Redirect. + +**Figure 5.3.2.3.3-1: NF service consumer subscribes to notifications of shared data change** + +1. The NF service consumer sends a POST request to the parent resource (collection of subscriptions) (.../shared-data-subscriptions), to create a subscription as present in message body. +- 2a. On success, the HSS responds with "201 Created" with the message body containing a representation of the created subscription. The Location HTTP header shall contain the URI of the created subscription. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.3.4 Subscriptions to notification of UE Reachability for IP + +Figure 5.3.2.3.4-1 shows a scenario where the NF service consumer (e.g. IP-SM-GW) sends a request to the HSS to subscribe to UE reachability for IP. The request contains the UE's identity ( $\{/imsUeId\}$ ), the resource to be monitored (/access-data/ps-domain/ue-reach-subscriptions), an expiry time, a callback URI and query parameters (e.g. supported-features). + +Subscriptions to notification on UE Reachability for IP are requests for a one-time notification, i.e. after notification the subscription becomes invalid. + +![Sequence diagram showing the subscription to notification of UE reachability for IP. The NF Service Consumer sends a POST request for ^imsUeId}/access-data/ps-domain/ue-reach-subscriptions (UeReachabilitySubscription) to the HSS. The HSS responds with 2a. 201 Created (UeReachabilitySubscription), 2b. 404 Not Found, or 2c. 3xx Redirect.](4c9ba399ca7df11cbe9b6322cd9aee0a_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant HSS + Note right of HSS: 2a. 201 Created (UeReachabilitySubscription) +2b. 404 Not Found +2c. 3xx Redirect + NF Service Consumer->>HSS: 1. POST « ^imsUeId}/access-data/ps-domain/ue-reach-subscriptions (UeReachabilitySubscription) » + HSS-->>NF Service Consumer: 2a. 201 Created (UeReachabilitySubscription) +2b. 404 Not Found +2c. 3xx Redirect + +``` + +Sequence diagram showing the subscription to notification of UE reachability for IP. The NF Service Consumer sends a POST request for ^imsUeId}/access-data/ps-domain/ue-reach-subscriptions (UeReachabilitySubscription) to the HSS. The HSS responds with 2a. 201 Created (UeReachabilitySubscription), 2b. 404 Not Found, or 2c. 3xx Redirect. + +**Figure 5.3.2.3.4-1: Subscription to notification of UE reachability for IP** + +1. The NF service consumer (e.g. IP-SM-GW) sends a POST request to the parent resource (collection of UE reachability subscriptions) (.../{ueIdentity}/ue-reach-subscriptions), to create a subscription to UE reachability for IP. The request contains an expiry time, suggested by the NF Service Consumer, representing the time upto which the subscription is desired to be kept active and the time after which the UE reachability event shall not generate a notification. +- 2a. On success, the HSS sets the URRP flag for the relevant serving nodes and may contact UDM (see 3GPP TS 23.632, clause 5.4.5). The HSS responds with "201 Created" with the message body containing a representation of the created subscription. The Location HTTP header shall contain the URI of the created subscription. + +The response contains the expiry time, as determined by the HSS (possible based on operator policy) after which the subscription becomes invalid. Once the subscription expires, if the NF Service Consumer wants to keep receiving notifications, it shall create a new subscription in the HSS. The NF Service Producer shall not provide + +the same expiry time for many subscriptions in order to avoid all of them expiring and recreating the subscription at the same time. + +- 2b. If the user does not exist, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.4 Unsubscribe + +##### 5.3.2.4.1 General + +The following procedures using the Unsubscribe service operation are supported: + +- Unsubscribe to notification of data change +- Unsubscribe to notification of UE reachability for IP + +##### 5.3.2.4.2 Unsubscribe to notifications of data change + +Figure 5.3.2.4.2-1 shows a scenario where the NF service consumer (e.g. S-CSCF) sends a request to the HSS to unsubscribe from notifications of data changes. The request contains the URI previously received in the Location HTTP header of the response to the subscription. + +![Sequence diagram showing the interaction between an NF service consumer and an HSS for unsubscribing to notifications of data change. The consumer sends a DELETE request to a specific subscription URI. The HSS responds with one of three possible status codes: 204 No Content (success), 404 Not Found (if no valid subscription), or 3xx Redirect (if redirection is needed).](5879500ca01e1a2521654beff6c289a4_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant HSS + Note right of HSS: 1. DELETE « ^imsUeId}/subscriptions/{subscriptionId} + NF service consumer->>HSS: 1. DELETE request + Note left of NF service consumer: 2a. 204 No Content +2b. 404 Not Found +2c. 3xx Redirect + HSS-->>NF service consumer: 2. Response + +``` + +Sequence diagram showing the interaction between an NF service consumer and an HSS for unsubscribing to notifications of data change. The consumer sends a DELETE request to a specific subscription URI. The HSS responds with one of three possible status codes: 204 No Content (success), 404 Not Found (if no valid subscription), or 3xx Redirect (if redirection is needed). + +**Figure 5.3.2.4.2-1: NF service consumer unsubscribes to notifications** + +1. The NF service consumer sends a DELETE request to the resource identified by the URI previously received during subscription creation. +- 2a. On success, the HSS responds with "204 No Content". +- 2b. If there is no valid subscription available (e.g. due to an unknown subscriptionId value), HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the DELETE response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +##### 5.3.2.4.3 Unsubscribe to notifications of shared data change + +Figure 5.3.2.4.3-1 shows a scenario where the NF service consumer sends a request to the HSS to unsubscribe from notifications of shared data changes. The request contains the URI previously received in the Location HTTP header of the response to the subscription. + +![Sequence diagram showing the NF service consumer unsubscribing to notifications for shared data. The consumer sends a DELETE request to the HSS, and the HSS responds with 204 No Content, 404 Not Found, or 3xx Redirect.](32ff77da4286b58c4778033acaa10836_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant HSS + Note left of NF service consumer: 1. DELETE« shared-data-subscriptions/{subscriptionId} + NF service consumer->>HSS: 1. DELETE« shared-data-subscriptions/{subscriptionId} + Note right of HSS: 2a. 204 No Content +2b. 404 Not Found +2c. 3xx Redirect + HSS-->>NF service consumer: 2a. 204 No Content +2b. 404 Not Found +2c. 3xx Redirect + +``` + +Sequence diagram showing the NF service consumer unsubscribing to notifications for shared data. The consumer sends a DELETE request to the HSS, and the HSS responds with 204 No Content, 404 Not Found, or 3xx Redirect. + +**Figure 5.3.2.4.3-1: NF service consumer unsubscribes to notifications for shared data** + +1. The NF service consumer sends a DELETE request to the resource identified by the URI previously received during subscription creation. +- 2a. On success, the HSS responds with "204 No Content". +- 2b. If there is no valid subscription available (e.g. due to an unknown subscriptionId value), HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the DELETE response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.4.4 Unsubscribe to notification of UE Reachability for IP + +Figure 5.3.2.4.4-1 shows a scenario where the NF service consumer (e.g. IP-SM-GW) sends a request to the HSS to unsubscribe from notifications of UE Reachability for IP. The request contains the URI previously received in the Location HTTP header of the response to the subscription. + +![Sequence diagram showing the NF service consumer unsubscribing to notification of UE reachability for IP. The consumer sends a DELETE request to the HSS, and the HSS responds with 204 No Content, 404 Not Found, or 3xx Redirect.](8d8c758885b4f754ff071bf3b572ab3c_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant HSS + Note left of NF service consumer: 1. DELETE« ^imsUeId}/access-data/ps-domain/ue-reach-subscriptions/{subscriptionId} + NF service consumer->>HSS: 1. DELETE« ^imsUeId}/access-data/ps-domain/ue-reach-subscriptions/{subscriptionId} + Note right of HSS: 2a. 204 No Content +2b. 404 Not Found +2c. 3xx Redirect + HSS-->>NF service consumer: 2a. 204 No Content +2b. 404 Not Found +2c. 3xx Redirect + +``` + +Sequence diagram showing the NF service consumer unsubscribing to notification of UE reachability for IP. The consumer sends a DELETE request to the HSS, and the HSS responds with 204 No Content, 404 Not Found, or 3xx Redirect. + +**Figure 5.3.2.4.4-1: Unsubscription to notification of UE reachability for IP** + +1. The NF service consumer sends a DELETE request to the resource identified by the URI previously received during subscription creation. +- 2a. On success, the HSS responds with "204 No Content". +- 2b. If there is no valid subscription available (e.g. due to an unknown subscriptionId value), HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the DELETE response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +### 5.3.2.5 ModifySubscription + +#### 5.3.2.5.1 General + +The following procedures using the ModifySubscription service operation are supported: + +- Modification of a Subscription to notification of data change (for UE individual data) +- Modification of a Subscription to notification of shared data change +- Modification of a Subscription to notification of UE Reachability for IP + +The ModifySubscription service operation can be used for the following purpose: + +- Extend the expiry time of ImsSdmSubscription; +- Extend the expiry time of UeReachabilitySubscription; +- Modify the resource URIs to be monitored, e.g. add/remove resource URIs to/from the monitored resource URI list. + +#### 5.3.2.5.2 Modification of a subscription to notifications of data change + +Figure 5.3.2.5.2-1 shows a scenario where the NF service consumer sends a request to the HSS to modify a subscription to notifications of data changes. The request contains the URI previously received in the Location HTTP header of the response to the subscription. + +![Sequence diagram showing the interaction between an NF service consumer and an HSS to modify a subscription. The consumer sends a PATCH request to the HSS. The HSS responds with either a 200 OK (containing ImsSdmSubscription), a 404 Not Found, or a 3xx Redirect.](822e033872d5ab16e861571f47b81ba7_img.jpg) + +``` + +sequenceDiagram + participant NF as NF service consumer + participant HSS as HSS + Note right of NF: 1. PATCH « ^imsUeId}/subscriptions/{subscriptionId} ([PatchItems]) + NF->>HSS: 1. PATCH request + Note left of HSS: 2a. 200 OK (ImsSdmSubscription) +2b. 404 Not Found +2c. 3xx Redirect + HSS-->>NF: 2. Response + +``` + +Sequence diagram showing the interaction between an NF service consumer and an HSS to modify a subscription. The consumer sends a PATCH request to the HSS. The HSS responds with either a 200 OK (containing ImsSdmSubscription), a 404 Not Found, or a 3xx Redirect. + +**Figure 5.3.2.5.2-1: NF service consumer modifies a subscription to notifications** + +1. The NF service consumer sends a PATCH request to the resource identified by the URI previously received during subscription creation. + +The NF service consumer may include "monitoredResourceUris" to replace the existing monitored resource URIs, e.g. to add/remove specific resource URIs from the monitored resource URI list. + +- 2a. On success, the HSS responds with "200 OK". +- 2b. If there is no valid subscription available (e.g. due to an unknown subscriptionId value), HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PATCH response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.5.3 Modification of a subscription to notifications of shared data change + +Figure 5.3.2.z.3-1 shows a scenario where the NF service consumer sends a request to the HSS to modify a subscription to notifications of shared data changes. The request contains the URI previously received in the Location HTTP header of the response to the subscription. + +![Sequence diagram for Figure 5.3.2.5.3-1: NF service consumer modifies a subscription to notifications for shared data. The diagram shows a PATCH request from the NF service consumer to the HSS, and the HSS responding with 200 OK, 404 Not Found, or 3xx Redirect.](4e85fe330de2c4f5eea6de4b2a53c77f_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant HSS + Note right of NF service consumer: 1. PATCH « shared-data-subscriptions/{subscriptionId} ([PatchItems]) » + NF service consumer->>HSS: 1. PATCH « shared-data-subscriptions/{subscriptionId} ([PatchItems]) » + Note right of HSS: 2a. 200 OK (ImsSdmSubscription) +2b. 404 Not Found +2c. 3xx Redirect + HSS-->>NF service consumer: 2a. 200 OK (ImsSdmSubscription) +2b. 404 Not Found +2c. 3xx Redirect + +``` + +Sequence diagram for Figure 5.3.2.5.3-1: NF service consumer modifies a subscription to notifications for shared data. The diagram shows a PATCH request from the NF service consumer to the HSS, and the HSS responding with 200 OK, 404 Not Found, or 3xx Redirect. + +**Figure 5.3.2.5.3-1: NF service consumer modifies a subscription to notifications for shared data** + +1. The NF service consumer sends a PATCH request to the resource identified by the URI previously received during subscription creation. + +The NF service consumer may include "monitoredResourceUris" to replace the existing monitored resource URIs, e.g. for the purposes to add/remove specific resource URIs from the monitored resource URI list. + +- 2a. On success, the HSS responds with "200 OK". + +- 2b. If there is no valid subscription available (e.g. due to an unknown subscriptionId value), HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PATCH response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.5.4 Modification of a subscription to notifications of data change + +Figure 5.3.2.5.4-1 shows a scenario where the NF service consumer sends a request to the HSS to modify a subscription to notifications of data changes. The request contains the URI previously received in the Location HTTP header of the response to the subscription. + +![Sequence diagram for Figure 5.3.2.5.4-1: NF service consumer modifies a subscription to notifications of data change. The diagram shows a PATCH request from the NF service consumer to the HSS, and the HSS responding with 200 OK, 404 Not Found, or 3xx Redirect.](2beb95006f1933bed737cfe1e6598db8_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant HSS + Note right of NF service consumer: 1. PATCH « ^imsUeId}/access-data/ps-domain/ue-reach-subscriptions/{subscriptionId} ([PatchItems]) » + NF service consumer->>HSS: 1. PATCH « ^imsUeId}/access-data/ps-domain/ue-reach-subscriptions/{subscriptionId} ([PatchItems]) » + Note right of HSS: 2a. 200 OK (UeReachabilitySubscription) +2b. 404 Not Found +2c. 3xx Redirect + HSS-->>NF service consumer: 2a. 200 OK (UeReachabilitySubscription) +2b. 404 Not Found +2c. 3xx Redirect + +``` + +Sequence diagram for Figure 5.3.2.5.4-1: NF service consumer modifies a subscription to notifications of data change. The diagram shows a PATCH request from the NF service consumer to the HSS, and the HSS responding with 200 OK, 404 Not Found, or 3xx Redirect. + +**Figure 5.3.2.5.4-1: NF service consumer modifies a subscription to notifications** + +1. The NF service consumer sends a PATCH request to the resource identified by the URI previously received during subscription creation. + +The NF service consumer includes a new expiry time, e.g. to extend the monitoring time of the event. + +- 2a. On success, the HSS responds with "200 OK". + +- 2b. If there is no valid subscription available (e.g. due to an unknown subscriptionId value), HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PATCH response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +### 5.3.2.6 Notification + +#### 5.3.2.6.1 General + +The following procedures using the Notification service operation are supported: + +- Data change notification to NF; +- UE Reachability for IP notification to NF. + +#### 5.3.2.6.2 Data Change Notification To NF + +Figure 5.3.2.6.2-1 shows a scenario where the HSS notifies the NF service consumer (that has subscribed to receive such notification) about subscription data change. The request contains the callbackReference URI as previously received in the ImsSdmSubscription. + +![Sequence diagram for Subscription Data Change Notification](d116934392360da963e91d840d1e45a8_img.jpg) + +``` +sequenceDiagram + participant HSS + participant NF as NF service consumer + Note right of HSS: 1. POST {callbackReference} (Notification) + HSS->>NF: 1. POST {callbackReference} (Notification) + Note left of NF: 2a. 204 No Content +2b. 4xx/5xx Client or Server Error +2c. 3xx Redirect + NF-->>HSS: 2a. 204 No Content + Note right of HSS: 2b. 4xx/5xx Client or Server Error + HSS-->>NF: 2b. 4xx/5xx Client or Server Error + Note right of HSS: 2c. 3xx Redirect + HSS-->>NF: 2c. 3xx Redirect +``` + +The diagram illustrates the interaction between an HSS and an NF service consumer for a subscription data change notification. The HSS sends a POST request with a callbackReference to the NF service consumer. The NF service consumer responds with one of three possible status codes: 204 No Content, 4xx/5xx Client or Server Error, or 3xx Redirect. + +Sequence diagram for Subscription Data Change Notification + +**Figure 5.3.2.6.2-1: Subscription Data Change Notification** + +1. The HSS sends a POST request to the callbackReference as provided by the NF service consumer during the subscription. +2. The NF service consumer responds with "204 No Content". + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +In the case of redirection, the NF Service Consumer shall return 3xx status code, which shall contain a Location header with an URI pointing to an alternative notification endpoint. + +#### 5.3.2.6.3 UE Reachability for IP Notification to NF + +Figure 5.3.2.6.3-1 shows a scenario where the HSS notifies the NF service consumer (that has subscribed to receive such notification) about subscription data change. The request contains the callbackReference URI as previously received in the UeReachabilitySubscription. + +![Sequence diagram for UE Reachability for IP Notification](5cb74e3ca5034698d7eab12de06f8763_img.jpg) + +``` +sequenceDiagram + participant HSS + participant NF as NF service consumer + Note right of HSS: 1. POST {callbackReference} (UeReachabilityNotification) + HSS->>NF: 1. POST {callbackReference} (UeReachabilityNotification) + Note left of NF: 2a. 204 No Content +2b. 4xx/5xx Client or Server Error +2c. 3xx Redirect + NF-->>HSS: 2a. 204 No Content + Note right of HSS: 2b. 4xx/5xx Client or Server Error + HSS-->>NF: 2b. 4xx/5xx Client or Server Error + Note right of HSS: 2c. 3xx Redirect + HSS-->>NF: 2c. 3xx Redirect +``` + +The diagram illustrates the interaction between an HSS and an NF service consumer for a UE reachability for IP notification. The HSS sends a POST request with a callbackReference to the NF service consumer. The NF service consumer responds with one of three possible status codes: 204 No Content, 4xx/5xx Client or Server Error, or 3xx Redirect. + +Sequence diagram for UE Reachability for IP Notification + +**Figure 5.3.2.6.3-1: UE Reachability for IP Notification** + +1. The HSS sends a POST request to the callbackReference as provided by the NF service consumer during the subscription. The notification includes information about UE reachability for IP event detected. +2. The NF service consumer responds with "204 No Content". + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +In the case of redirection, the NF Service Consumer shall return 3xx status code, which shall contain a Location header with an URI pointing to an alternative notification endpoint. + +### 5.3.2.7 Update + +#### 5.3.2.7.1 General + +The following procedures using the Update service operation are supported: + +- Repository Data Create/Update/Delete +- STN-SR update +- SMS registration information Create/Update/Delete +- PSI activation state Update +- DSAI-tag activation state Update + +#### 5.3.2.7.2 Repository Data Creation or Update + +Figure 5.3.2.7.2-1 shows a scenario where the IMS-AS sends a request to the HSS to create or update the repository data for a given service indication. The request contains the UE's identity (`{imsUeId}`) which shall be an IMS Public Identity, the service indication and repository data with the associated version (sequence number). + +![Sequence diagram showing the interaction between IMS AS and HSS for repository data creation or update. The IMS AS sends a PUT request to the HSS, and the HSS responds with a status code.](a89d151b67109378baed0c117830cf78_img.jpg) + +``` + +sequenceDiagram + participant IMS AS + participant HSS + Note right of IMS AS: 1. PUT « ^ueId}/repository-data/{serviceIndication} (RepositoryData) + IMS AS->>HSS: Request + Note left of HSS: 2a. 200 OK / 204 No Content +2b. 201 Created +2c. 403 Forbidden +2d. 3xx Redirect + HSS-->>IMS AS: Response + +``` + +Sequence diagram showing the interaction between IMS AS and HSS for repository data creation or update. The IMS AS sends a PUT request to the HSS, and the HSS responds with a status code. + +**Figure 5.3.2.7.2-1: IMS AS creating or updating repository data** + +1. The IMS AS sends a PUT request to the resource representing the UE's Repository Data for a requested Service Indication. + +The IMS AS may request the creation of the Repository Data (sequence number equal to zero) or may request the update of the Repository Data (sequence number greater than zero) + +- 2a. On success, the HSS updates the RepositoryData resource by replacing it with the received resource information, and responds with "200 OK" or "204 No Content". +- 2b. If the resource does not exist (there is no repository data associated to the requested service indication), HSS stores the received Repository Data and responds with HTTP Status Code "201 created". A response body may be included to convey additional information to the NF consumer (e.g., features supported by HSS). +- 2c. If the operation is not authorized due to e.g IMS AS does not have the required permissions for the service indication and the operation requested, HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PUT response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +### 5.3.2.7.3 Repository Data Deletion + +Figure 5.3.2.7.3-1 shows a scenario where the IMS-AS sends a request to the HSS to delete the repository data for a given service indication. The request contains the UE's identity (`{imsUeId}`) which shall be an IMS Public Identity and the service indication. + +![Sequence diagram for IMS AS deleting repository data. The IMS AS sends a DELETE request to the HSS. The HSS responds with one of the following: 2a. 204 No Content, 2b. 404 Not Found, 2c. 403 Forbidden, or 2d. 3xx Redirect.](a3b3abbf6d0b18f3dd4a83680b5e3e42_img.jpg) + +``` + +sequenceDiagram + participant IMS AS + participant HSS + Note right of HSS: 2a. 204 No Content +2b. 404 Not Found +2c. 403 Forbidden +2d. 3xx Redirect + IMS AS->>HSS: 1. DELETE « ^{imsUeId}/repository-data/{serviceIndication} » + HSS-->>IMS AS: Response (2a-2d) + +``` + +Sequence diagram for IMS AS deleting repository data. The IMS AS sends a DELETE request to the HSS. The HSS responds with one of the following: 2a. 204 No Content, 2b. 404 Not Found, 2c. 403 Forbidden, or 2d. 3xx Redirect. + +Figure 5.3.2.7.3-1: IMS AS deleting repository data + +1. The IMS AS sends a DELETE request to the resource representing the UE's Repository Data for a requested Service Indication. +- 2a. On success, the HSS deletes the resource and responds with "204 No Content". +- 2b. If the repository data does not exist in the HSS, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). +- 2c. If the operation is not authorized due to e.g IMS AS does not have the required permissions for the service indication and operation requested, HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the DELETE response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +### 5.3.2.7.4 STN-SR update + +Figure 5.3.2.7.4-1 shows a scenario where the IMS-AS sends a request to the HSS to update the STN-SR. The request contains the UE's identity (`{imsUeId}`) which shall be an IMS Public Identity or a Private Identity and an instruction to modify the STN-SR. + +![Sequence diagram for IMS AS updating STN-SR. The IMS AS sends a PATCH request to the HSS. The HSS responds with one of the following: 2a. 204 No Content, 2b. 404 Not Found, 2c. 403 Forbidden, or 2d. 3xx Redirect.](901800172164e0494762ffa57a09993f_img.jpg) + +``` + +sequenceDiagram + participant IMS AS + participant HSS + Note right of HSS: 2a. 204 No Content +2b. 404 Not Found +2c. 403 Forbidden +2d. 3xx Redirect + IMS AS->>HSS: 1. PATCH « ^{imsUeId}/srvcc-data (Modification instruction) » + HSS-->>IMS AS: Response (2a-2d) + +``` + +Sequence diagram for IMS AS updating STN-SR. The IMS AS sends a PATCH request to the HSS. The HSS responds with one of the following: 2a. 204 No Content, 2b. 404 Not Found, 2c. 403 Forbidden, or 2d. 3xx Redirect. + +Figure 5.3.2.7.4-1: IMS AS updating STN-SR + +1. The IMS AS sends a PATCH request to the resource representing the UE's SRVCC Data. +- 2a. On success, the HSS responds with "204 No Content". +- 2b. If the resource does not exist (i.e. the user is not subscribed to SRVCC), HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element). +- 2c. If the operation is not authorized due to e.g IMS AS does not have the required permissions for the operation requested, HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PATCH response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.7.5 PSI activation state update + +Figure 5.3.2.7.5-1 shows a scenario where the IMS-AS sends a request to the HSS to update the PSI activation state. The request contains the Public Service Identity (/{imsUeId}) and an instruction to modify the activation state. + +![Sequence diagram showing the interaction between IMS AS and HSS for updating a PSI activation state. The IMS AS sends a PATCH request to the HSS. The HSS responds with one of the following: 2a. 204 No Content, 2b. 404 Not Found, 2c. 403 Forbidden, or 2d. 3xx Redirect.](5c3dd31372f59e15250f0ab1613ca485_img.jpg) + +``` +sequenceDiagram + participant IMS AS + participant HSS + Note right of IMS AS: 1. PATCH « ^ ueld}/service-data/psi-state (Modification instruction) » + IMS AS->>HSS: 1. PATCH request + Note right of HSS: 2a. 204 No Content +2b. 404 Not Found +2c. 403 Forbidden +2d. 3xx Redirect + HSS-->>IMS AS: Response +``` + +Sequence diagram showing the interaction between IMS AS and HSS for updating a PSI activation state. The IMS AS sends a PATCH request to the HSS. The HSS responds with one of the following: 2a. 204 No Content, 2b. 404 Not Found, 2c. 403 Forbidden, or 2d. 3xx Redirect. + +**Figure 5.3.2.7.5-1: IMS AS updating a PSI activation state** + +1. The IMS AS sends a PATCH request to the resource representing the PSI activation state. +- 2a. On success, the HSS responds with "204 No Content". +- 2b. If the resource does not exist (i.e. the service does not exist), HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element). +- 2c. If the operation is not authorized due to e.g IMS AS does not have the required permissions for the operation requested, HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PATCH response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.7.6 SMS Registration Information Creation or Update + +Figure 5.3.2.7.6-1 shows a scenario where the IMS-AS sends a request to the HSS to create or update the SMS registration information. The request contains the UE's identity (/{imsUeId}) which shall be an IMS Public Identity and the SMS registration information (IP-SM-GW number). + +![Sequence diagram for Figure 5.3.2.7.6-1: IMS AS creating or updating the SMS registration information. The diagram shows a PUT request from IMS AS to HSS, and a response from HSS to IMS AS.](187d05bf7ead21e1394b61320d8b3632_img.jpg) + +``` + +sequenceDiagram + participant IMS AS + participant HSS + Note right of HSS: 1. PUT « ^ueId}/service-data/sms-registration-info (IpSmGwAddress) + HSS-->>IMS AS: 2a. 200 OK / 204 No Content + Note left of IMS AS: 2b. 201 Created + Note left of IMS AS: 2c. 403 Forbidden + Note left of IMS AS: 2d. 3xx Redirect + +``` + +Sequence diagram for Figure 5.3.2.7.6-1: IMS AS creating or updating the SMS registration information. The diagram shows a PUT request from IMS AS to HSS, and a response from HSS to IMS AS. + +**Figure 5.3.2.7.6-1: IMS AS creating or updating the SMS registration information** + +1. The IMS AS sends a PUT request to the resource representing the UE's SMS registration information. The request contains the IP-SM-GW number and, if s6c is supported, the Diameter Identity and Diameter Realm of the IP-SM-GW. +- 2a. On success, the HSS updates the SMS registration information resource by replacing it with the received resource information and responds with "200 OK" or "204 No Content". +- 2b. If the resource does not exist (there is no IP-SM-GW number associated to the user), HSS stores the received SMS registration information and responds with HTTP Status Code "201 created". A response body may be included to convey additional information to the NF consumer (e.g., features supported by HSS). +- 2c. If the operation is not authorized due to e.g IMS AS does not have the required permissions or the IP-SM-GW number is pre-configured and cannot be overwritten, HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PUT response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +### 5.3.2.7.7 SMS Registration Information Deletion + +Figure 5.3.2.7.7-1 shows a scenario where the IMS-AS sends a request to the HSS to delete the SMS registration information. The request contains the UE's identity (/{imsUeId}) which shall be an IMS Public Identity. + +![Sequence diagram for Figure 5.3.2.7.7-1: IMS AS deleting SMS registration information. The diagram shows a DELETE request from IMS AS to HSS, and a response from HSS to IMS AS.](6584b95e34ea1f0b67144aa841db0863_img.jpg) + +``` + +sequenceDiagram + participant IMS AS + participant HSS + Note right of HSS: 1. DELETE « ^ueId}/service-data/sms-registration-info + HSS-->>IMS AS: 2a. 204 No Content + Note left of IMS AS: 2b. 404 Not Found + Note left of IMS AS: 2c. 403 Forbidden + Note left of IMS AS: 2d. 3xx Redirect + +``` + +Sequence diagram for Figure 5.3.2.7.7-1: IMS AS deleting SMS registration information. The diagram shows a DELETE request from IMS AS to HSS, and a response from HSS to IMS AS. + +**Figure 5.3.2.7.7-1: IMS AS deleting SMS registration information** + +1. The IMS AS sends a DELETE request to the resource representing the UE's SMS registration information. +- 2a. On success, the HSS deletes the resource and responds with "204 No Content". +- 2b. If the SMS registration information does not exist in the HSS, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). +- 2c. If the operation is not authorized due to e.g IMS AS does not have the required permissions or the IP-SM-GW number is pre-configured and cannot be deleted, HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the DELETE response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +### 5.3.2.7.8 DSAI tag activation state update + +Figure 5.3.2.7.8-1 shows a scenario where the IMS-AS sends a request to the HSS to update the DSAI tag activation state. The request contains the Public Service Identity (/imsUeId) and an instruction to modify the activation state of DSAI tag. + +![Sequence diagram showing IMS AS sending a PATCH request to HSS for DSAI tag activation state update. The request is '1. PATCH « ^ueId}/service-data/dsai (Modification instruction)'. The HSS responds with one of four options: '2a. 204 No Content', '2b. 404 Not Found', '2c. 403 Forbidden', or '2d. 3xx Redirect'.](adc59ed6840bcb2d392ea323abfccedc_img.jpg) + +``` + +sequenceDiagram + participant IMS AS + participant HSS + Note right of IMS AS: 1. PATCH « ^ueId}/service-data/dsai +(Modification instruction) + IMS AS->>HSS: Request + Note right of HSS: 2a. 204 No Content +2b. 404 Not Found +2c. 403 Forbidden +2d. 3xx Redirect + HSS-->>IMS AS: Response + +``` + +Sequence diagram showing IMS AS sending a PATCH request to HSS for DSAI tag activation state update. The request is '1. PATCH « ^ueId}/service-data/dsai (Modification instruction)'. The HSS responds with one of four options: '2a. 204 No Content', '2b. 404 Not Found', '2c. 403 Forbidden', or '2d. 3xx Redirect'. + +**Figure 5.3.2.7.8-1: IMS AS updating DSAI tag activation state** + +1. The IMS AS sends a PATCH request to the resource representing the DSAI tag activation state. +- 2a. On success, the HSS responds with "204 No Content". +- 2b. If the resource does not exist (i.e. the service does not exist), HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element). +- 2c. If the operation is not authorized due to e.g IMS AS does not have the required permissions for the operation requested, HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PATCH response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +## 5.4 Nhss\_imsUEAuthentication Service + +### 5.4.1 Service Description + +See 3GPP TS 23.228 [6], clause AA.2.1.4. + +### 5.4.2 Service Operations + +#### 5.4.2.1 Introduction + +For the Nhss\_imsUEAuthentication service the following service operation is defined: + +- Get + +The Nhss\_imsUEAuthentication Service is used by the S-CSCF to request the SBI capable HSS to select an authentication method, calculate a fresh authentication vector (AV) if required for the selected method, and provide it to the S-CSCF by means of the Get service operation. + +## 5.4.2.2 Get + +### 5.4.2.2.1 General + +The following procedures using the Get service operation are supported: + +- Authentication Information Retrieval + +### 5.4.2.2.2 Authentication Information Retrieval + +Figure 5.4.2.2.2-1 shows a scenario where the NF service consumer (S-CSCF) retrieves authentication information for the UE from the HSS. The request contains the UE's identity (IMS Private Identity) and the SIP authentication scheme and may contain resynchronization info. + +![Sequence diagram showing the interaction between an NF service consumer and an HSS for authentication information retrieval. The consumer sends a POST request to the HSS, and the HSS responds with an OK, Forbidden, or Redirect status.](42e18c25bfd455a5a57f207bacfcb970_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant HSS + Note left of NF service consumer: 1. POST « {impi}/security-information/generate-sip-auth-data (SipAuthenticationInfoRequest) » + NF service consumer->>HSS: Request + Note right of HSS: 2a. 200 OK (SipAuthenticationInfoResult) +2b. 403 Forbidden +2c. 3xx Redirect + HSS-->>NF service consumer: Response + +``` + +Sequence diagram showing the interaction between an NF service consumer and an HSS for authentication information retrieval. The consumer sends a POST request to the HSS, and the HSS responds with an OK, Forbidden, or Redirect status. + +**Figure 5.4.2.2.2-1: NF service consumer requesting authentication information** + +1. The NF service consumer sends a POST request (custom method: generate-sip-auth-data) to the resource representing the UE's security information. The payload shall contain the S-CSCF name, SIP authentication scheme and the resynchronization info. +- 2a. The HSS responds with "200 OK" with the message body containing the authentication data information. +- 2b. If the operation cannot be authorized due to e.g UE does not have required subscription data, HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +## 6 API Definitions + +### 6.1 Nhss\_imsUEContextManagement Service API + +#### 6.1.1 Introduction + +URIs of this API shall have the following root: + +{apiRoot}/{apiName}/{apiVersion}/ + +where "apiRoot" is defined in clause 4.4.1 of 3GPP TS 29.501 [5], the "apiName" shall be set to "nhss-ims-uecm" and the "apiVersion" shall be set to "v1" for the current version of this specification. + +## 6.1.2 Usage of HTTP + +### 6.1.2.1 General + +HTTP/2, as defined in IETF RFC 7540 [8], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +HTTP messages and bodies for the Nhss\_imsUECM service shall comply with the OpenAPI [9] specification contained in Annex A.2. + +### 6.1.2.2 HTTP standard headers + +#### 6.1.2.2.1 General + +The usage of HTTP standard headers shall be supported as specified in clause 5.2.2 of 3GPP TS 29.500 [4]. + +#### 6.1.2.2.2 Content type + +The following content types shall be supported: + +- JSON, as defined in IETF RFC 8259 [10], signalled by the content type "application/json". +- The Problem Details JSON Object (IETF RFC 7807 [11]) signalled by the content type "application/problem+json". +- JSON Patch, as defined in IETF RFC 6902 [12], signalled by the content type "application/json-patch+json". + +### 6.1.2.3 HTTP custom headers + +#### 6.1.2.3.1 General + +The usage of HTTP custom headers shall be supported as specified in clause 5.2.3 of 3GPP TS 29.500 [4]. + +## 6.1.3 Resources + +### 6.1.3.1 Overview + +![Figure 6.1.3.1-1: Resource URI structure of the Nhss_imsUECM API. The diagram shows a hierarchical tree structure starting from {apiRoot}/nhss-ims-uecm/v1. It branches into two main paths: /{imsUeId} and /{impu}. The /{imsUeId} path further branches into /scscf-registration, which then branches into /scscf-restoration-info. The /{impu} path branches into /authorize, which is shown with a dashed border.](18e519d1f91133e080347562f681dfb5_img.jpg) + +``` + +graph TD + Root["{apiRoot}/nhss-ims-uecm/v1"] --> imsUeId["/{imsUeId}"] + Root --> impu["/{impu}"] + imsUeId --> scscfRegistration["/scscf-registration"] + scscfRegistration --> scscfRestorationInfo["/scscf-restoration-info"] + impu --> authorize["/authorize"] + style authorize stroke-dasharray: 5 5 + +``` + +Figure 6.1.3.1-1: Resource URI structure of the Nhss\_imsUECM API. The diagram shows a hierarchical tree structure starting from {apiRoot}/nhss-ims-uecm/v1. It branches into two main paths: /{imsUeId} and /{impu}. The /{imsUeId} path further branches into /scscf-registration, which then branches into /scscf-restoration-info. The /{impu} path branches into /authorize, which is shown with a dashed border. + +**Figure 6.1.3.1-1: Resource URI structure of the Nhss\_imsUECM API** + +Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.1.3.1-1: Resources and methods overview** + +| Resource name (Archetype) | Resource URI | HTTP method or custom operation | Description | +|------------------------------------------|------------------------------------------------------|---------------------------------|----------------------------------------------------------| +| ScscfRegistration (Document) | /{imsUeId}/scscf-registration | PUT | Create or update the S-CSCF registration state of the UE | +| Authorize (Custom operation) | /{impu}/authorize | authorize (POST) | Authorize the requested operation for the UE | +| Scscf Restoration Information (Document) | /{imsUeId}/scscf-registration/scscf-restoration-info | GET | Retrieve the S-CSCF restoration information. | +| | | PUT | Update the S-CSCF restoration information. | +| | | DELETE | Delete the S-CSCF restoration information. | + +### 6.1.3.2 Resource: Scscf Registration + +#### 6.1.3.2.1 Description + +This resource represents the registered S-CSCF. + +#### 6.1.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-uecm/{apiVersion}/{imsUeId}/scscf-registration + +This resource shall support the resource URI variables defined in table 6.1.3.2.2-1. + +**Table 6.1.3.2.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.1.1 | +| apiVersion | See clause 6.1.1 | +| imsUeId | Represents the IMS Subscription Identifier, either the IMS Public Identity (i.e. IMPU or Public PSI) or the Private Identity (i.e. IMPI or PSI). See 3GPP TS 23.228 [6] clause 4.3).
IMS Public Identity is used with the PUT method;
IMS Public Identity or IMS Private Identity is used with the PATCH methods.

Pattern: " ^(impu-sip:\{[a-zA-Z0-9 _\-\!~*()&=+\\$,:?V]+\}@([A-Za-z0-9]+\-[A-Za-z0-9]+\+\.)+[a-z]{2,}\ impu-tel:\+\{0-9\}{5,15}\ impi-\+\.+\+\.+\\$)" | + +### 6.1.3.2.3 Resource Standard Methods + +#### 6.1.3.2.3.1 PUT + +This method shall support the URI query parameters specified in table 6.1.3.2.3.1-1. + +**Table 6.1.3.2.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.2.3.1-2 and the response data structures and response codes specified in table 6.1.3.2.3.1-3. + +**Table 6.1.3.2.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------|---|-------------|-------------------------------------------------------------------------------------------------| +| ScscfRegistration | M | 1 | S-CSCF registration for indicated IMS Public Identity is updated with the received information. | + +**Table 6.1.3.2.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------|---|-------------|---------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ScscfRegistration | M | 1 | 201
Created | A response body containing a representation of the created individual scscfRegistration resource for the received IMS Public Identity shall be returned. | +| ScscfRegistration | M | 1 | 200 OK | A response body containing a representation of the updated individual scscfRegistration resource for the received IMS Public Identity shall be returned. | +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- USER_NOT_FOUND | +| ExtendedProblem Details | O | 0..1 | 403
Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- IDENTITY_ALREADY_REGISTERED In this case include invalidParams with cscfServerName as param and with value of the currently assigned S-CSCF name in the AdditionalInfo
- IDENTITIES_DO_NOT_MATCH
- ERROR_IN_REGISTRATION_TYPE | + +**Table 6.1.3.2.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.1.3.2.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +#### 6.1.3.2.4 Resource Custom Operations + +There are no custom operations associated to resources. + +#### 6.1.3.3 Resource: Scscf Restoration Information + +##### 6.1.3.3.1 Description + +This resource represents the IMS restoration information. It is queried by the service consumer (S-CSCF) to retrieve the information required for an S-CSCF to handle the requests for a user. + +##### 6.1.3.3.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-uecm/{apiVersion}/{imsUeId}/scscf-registration/scscf-restoration-info + +This resource shall support the resource URI variables defined in table 6.1.3.3.2-1. + +**Table 6.1.3.3.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.1.1 | +| apiVersion | See clause 6.1.1 | +| imsUId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)

pattern: "^(impu-sip:([a-zA-Z0-9_\-.!~*()&=+\$;,?V]+)@([A-Za-z0-9]+([-A-Za-z0-9]+)*\.)+[a-z]{2,} impu-tel:\+[0-9]{5,15} impi-.+@.+)\$" | + +### 6.1.3.3.3 Resource Standard Methods + +#### 6.1.3.3.3.1 GET + +This method shall support the URI query parameters specified in table 6.1.3.3.3.1-1. + +**Table 6.1.3.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.3.3.1-2 and the response data structures and response codes specified in table 6.1.3.3.3.1-3. + +**Table 6.1.3.3.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.3.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ScscfRestorationInfoResponse | M | 1 | 200 OK | A response body containing information for the S-CSCF to handle the requests for a user. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- DATA_NOT_FOUND

NOTE: DATA_NOT_FOUND indicates that there is no restoration info stored under the scscf-registration resource. | + +**Table 6.1.3.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.1.3.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +#### 6.1.3.3.3.2 PUT + +This method shall support the URI query parameters specified in table 6.1.3.3.3.2-1. + +**Table 6.1.3.3.3.2-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.3.3.2-2 and the response data structures and response codes specified in table 6.1.3.3.3.2-3. + +**Table 6.1.3.3.3.2-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------------|---|-------------|------------------------------------------------------------------------------------------------------------| +| ScscfRestorationInfoRequest | M | 1 | S-CSCF restoration information for indicated IMS Public Identity is updated with the received information. | + +**Table 6.1.3.3.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ScscfRestorationInfoResponse | M | 1 | 201 Created | Upon success, a response body containing a representation of the created individual ScscfRestorationInfo resource for the received IMS Public Identity shall be returned. | +| ScscfRestorationInfoResponse | M | 1 | 200 OK | Upon success, a response body containing a representation of the updated individual ScscfRestorationInfo resource shall be returned. | +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- OPERATION_NOT_ALLOWED

NOTE: OPERATION_NOT_ALLOWED indicates the S-CSCF is not allowed to create/update the restoration information. | + +**Table 6.1.3.3.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.1.3.3.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +#### 6.1.3.3.3.3 DELETE + +This method shall support the URI query parameters specified in table 6.1.3.3.3.3-1. + +**Table 6.1.3.3.3.3-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.3.3.3-2 and the response data structures and response codes specified in table 6.1.3.3.3.3-3. + +**Table 6.1.3.3.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|----------------------------------| +| n/a | M | 1 | The request body shall be empty. | + +**Table 6.1.3.3.3.3-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- OPERATION_NOT_ALLOWED

NOTE: OPERATION_NOT_ALLOWED indicates the S-CSCF is not allowed to delete the restoration information stored in the HSS. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- DATA_NOT_FOUND

NOTE: DATA_NOT_FOUND indicates that there is no restoration info stored under the scscf-registration resource. | + +**Table 6.1.3.3.3.3-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.1.3.3.3.3-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.1.4 Custom Operations without associated resources + +### 6.1.4.1 Overview + +**Table 6.1.4.1-1: Custom operations without associated resources** + +| Custom operation URI | Mapped HTTP method | Description | +|----------------------|--------------------|----------------------------------------------| +| /{impu}/authorize | POST | Authorize the requested operation for the UE | + +### 6.1.4.2 Operation: Authorize + +#### 6.1.4.2.1 Description + +This resource represents the information that is needed to authorize a UE to register or establish sessions in the IMS domain. See 3GPP TS 23.228 [6]. + +#### 6.1.4.2.2 Operation Definition + +This resource shall support the resource URI variables defined in table 6.1.4.2.2-1. + +**Table 6.1.4.2.2-1: URI variables for this resource** + +| Name | Definition | +|------------|---------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.1.1 | +| apiVersion | See clause 6.1.1 | +| impu | Represents the IMS Public Identity (i.e. IMPU or Public PSI). See 3GPP TS 23.228 [6] clause 4.3). | + +This operation shall support the request data structures specified in table 6.1.4.2.2-1 and the response data structure and response codes specified in table 6.1.4.2.2-2. + +**Table 6.1.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------|---|-------------|-----------------------------------------------------------------------------------------------------| +| AuthorizationRequest | M | 1 | Contains input for authorization, such as the authorization type or the visited network identifier. | + +**Table 6.1.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| AuthorizationResponse | M | 1 | 200 OK | A response body containing result information or the registered S-CSCF shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- IDENTITY_NOT_REGISTERED | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- AUTHORIZATION_REJECTED
- IDENTITIES_DONT_MATCH | + +**Table 6.1.4.2.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.1.4.2.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.1.5 Notifications + +### 6.1.5.1 General + +### 6.1.5.2 Deregistration Notification + +The POST method shall be used for Deregistration Notifications and the URI shall be as provided during the registration procedure. + +Resource URI: {callbackReference} + +Support of URI query parameters is specified in table 6.1.5.2-1. + +**Table 6.1.5.2-1: URI query parameters supported by the POST method** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +Support of request data structures is specified in table 6.1.5.2-2 and of response data structures and response codes is specified in table 6.1.5.2-3. + +**Table 6.1.5.2-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|--------------------|---|-------------|------------------------------------------------------------------| +| DeregistrationData | M | 1 | Includes Deregistration Reason and identities to be deregistered | + +**Table 6.1.5.2-3: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| DeregistrationData | | | 200 OK | Upon success or partial success, DeregistrationData shall be returned including additional information about the result of the procedure. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the notification endpoint of the subscribing NF Service Consumer. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the notification endpoint of the subscribing NF Service Consumer. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- CONTEXT_NOT_FOUND | + +**Table 6.1.5.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the notification endpoint of the subscribing NF Service Consumer. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.1.5.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the notification endpoint of the subscribing NF Service Consumer. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.1.6 Data Model + +### 6.1.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.1.6.1-1 specifies the data types defined for the Nhss\_imsUECM service-based interface protocol. + +**Table 6.1.6.1-1: Nhss\_imsUECM specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|------------------------------|----------------|----------------------------------------------------------------------------------------------------------|---------------| +| AuthorizationRequest | 6.1.6.2.2 | Information for the type of authorization requested and the visited PLMN-ID | | +| AuthorizationResponse | 6.1.6.2.3 | Result of the authorization requested for registration. | | +| ScscfRestorationInfo | 6.1.6.2.4 | Information required for an S-CSCF to handle the requests for a user. | | +| ScscfRestorationInfoRequest | 6.1.6.2.5 | Scscf restoration information request. | | +| ScscfRestorationInfoResponse | 6.1.6.2.6 | Result of the scscf restoration information request. | | +| RestorationInfo | 6.1.6.2.7 | Information related to a specific registration required for an S-CSCF to handle the requests for a user. | | +| UeSubscriptionInfo | 6.1.6.2.8 | UE's subscription information. | | +| PscsfSubscriptionInfo | 6.1.6.2.9 | P-CSCF's subscription information. | | +| ScscfRegistration | 6.1.6.2.10 | Registration information of the S-CSCF for the registered UE. | | +| ExtendedProblemDetails | 6.1.6.2.11 | | | +| AdditionalInfo | 6.1.6.2.12 | | | +| DeregistrationData | 6.1.6.2.13 | | | +| DeregistrationReason | 6.1.6.2.14 | | | +| EmergencyRegisteredIdentity | 6.1.6.2.15 | | | + +Table 6.1.6.1-2 specifies data types re-used by the Nhss\_imsUECM service-based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nhss\_imsUECM service-based interface. + +**Table 6.1.6.1-2: Nhss\_imsUECM re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-------------------------------------|---------------------|-----------------------------------------------------------------------------|---------------| +| Uri | 3GPP TS 29.571 [16] | Uniform Resource Identifier | | +| SupportedFeatures | 3GPP TS 29.571 [16] | see 3GPP TS 29.500 [4] clause 6.6 | | +| DateTime | 3GPP TS 29.571 [16] | String with format "date-time" as defined in OpenAPI Specification [9] | | +| ProblemDetails | 3GPP TS 29.571 [16] | Response body of error response messages. | | +| RedirectResponse | 3GPP TS 29.571 [16] | Response body of redirect response messages. | | +| ScscfSelectionAssistanceInformation | 6.2.6.2.51 | This information shall be used by the I-CSCF to select an S-CSCF for the UE | | + +## 6.1.6.2 Structured data types + +### 6.1.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +## 6.1.6.2.2 Type: AuthorizationRequest + +Table 6.1.6.2.2-1: Definition of type AuthorizationRequest + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------------|-------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| authorizationType | AuthorizationType | M | 1 | Contains the type of the authorization requested | | +| impi | Impi | O | 1 | Contains an IMS Private User Identity. It shall be present when the authorization requested is for a registration or de-registration. | | +| visitedNetworkIdentifier | string | O | 1 | Contains the identifier of the visited network where the P-CSCF is located. It shall be present when the authorization requested is for a registration or de-registration. | | + +## 6.1.6.2.3 Type: AuthorizationResponse + +Table 6.1.6.2.3-1: Definition of type AuthorizationResponse + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------------|------------------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| authorizationResult | AuthorizationResult | M | 1 | Contains the details of the granted authorization. | | +| cscfServerName | string | C | 0..1 | Contains the stored S-CSCF name in SIP URI format. It shall be present if there is a S-CSCF name stored for the associated IMS subscription. | | +| sccfSelectionAssistanceInfo | SccfSelectionAssistanceInformation | C | 0..1 | Contains information needed by the I-CSCF to select an S-CSCF for the UE. Shall be present if cscfServerName is absent. | | + +## 6.1.6.2.4 Type: SccfRestorationInfo + +Table 6.1.6.2.4-1: Definition of type SccfRestorationInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------|-------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| userName | Uri | O | 0..1 | Registered Private Identity of the user for whom the data is required. If the userName is NULL, it means that an S-CSCF request all registrations for all the private identities registered in the S-CSCF. | | +| restorationInfo | array(RestorationInfo) | O | 0..N | This IE shall contain the information related to a specific registration required for an S-CSCF to handle the requests for a user. | | +| registrationTimeout | DateTime | O | 1 | This IE indicates the point of time at which the UE's registration expires. | | +| sipAuthenticationScheme | SipAuthenticationScheme | O | 1 | This IE indicates the authentication scheme to be used in the authentication of SIP requests. | | + +## 6.1.6.2.5 Type: ScscfRestorationInfoRequest + +Table 6.1.6.2.5-1: Definition of type ScscfRestorationInfoRequest + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------------|----------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------|---------------| +| scscfRestorationInfoRequest | ScscfRestorationInfo | M | 1 | This IE shall contain the information related to a specific registration required for an S-CSCF to handle the requests for the users. | | + +## 6.1.6.2.6 Type: ScscfRestorationInfoResponse + +Table 6.1.6.2.6-1: Definition of type ScscfRestorationInfoResponse + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------------------|-----------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------|---------------| +| scscfRestorationInfoResponse | array(ScscfRestorationInfo) | M | 1..N | This IE shall contain the response information related to a specific or all registrations required for an S-CSCF. | | + +## 6.1.6.2.7 Type: RestorationInfo + +Table 6.1.6.2.7-1: Definition of type RestorationInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------------|-------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------|---------------| +| path | string | M | 1 | This IE shall contain a comma separated list of SIP proxies in the Path header. | | +| contact | string | M | 1 | This IE shall contain the Contact Addresses and Parameters in the Contact header. | | +| initialCSeqSequenceNumber | Uint32 | O | 1 | This IE contains the sequence number of the CSeq header field contained in the initial successful REGISTER request. | | +| callIdSipHeader | string | O | 1 | This IE contains the information in the Call-ID header. | | +| uesubscriptionInfo | UeSubscriptionInfo | O | 1 | This IE contains the UE's subscription information. | | +| pcscfSubscriptionInfo | PcscfSubscriptionInfo | O | 1 | This IE contains the P-CSCF's subscription information. | | +| imsSdmSubscriptions | map(ImsSdmSubscription) | O | 1..N | A map (list of key-value pairs where subscriptionId serves as key) of imsSdmSubscriptions. | | + +## 6.1.6.2.8 Type: UeSubscriptionInfo + +Table 6.1.6.2.8-1: Definition of type UeSubscriptionInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-----------|---|-------------|-----------------------------------------------------------------------------------|---------------| +| callIdSipHeader | string | M | 1 | This IE contains the information in the Call-ID header. | | +| fromSipHeader | string | M | 1 | This IE shall contain the information in the From header. | | +| toSipHeader | string | M | 1 | This IE shall contain the information in the To header. | | +| recordRoute | string | M | 1 | This IE shall contain a comma separated list of Record Route header(s). | | +| contact | string | M | 1 | This IE shall contain the Contact Addresses and Parameters in the Contact header. | | + +## 6.1.6.2.9 Type: PscfSubscriptionInfo + +**Table 6.1.6.2.9-1: Definition of type PscfSubscriptionInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-----------|---|-------------|-----------------------------------------------------------------------------------|---------------| +| callIdSipHeader | string | M | 1 | This IE contains the information in the Call-ID header. | | +| fromSipHeader | string | M | 1 | This IE shall contain the information in the From header. | | +| toSipHeader | string | M | 1 | This IE shall contain the information in the To header. | | +| contact | string | M | 1 | This IE shall contain the Contact Addresses and Parameters in the Contact header. | | + +## 6.1.6.2.10 Type: ScscfRegistration + +**Table 6.1.6.2.10-1: Definition of type ScscfRegistration** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------------|----------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| imsRegistrationType | ImsRegistrationType | M | 1 | Contains the type of the registration/deregistration requested. | | +| impi | Impi | C | 1 | Contains an IMS Private Identity. It may be absent during the originating or terminating request to an unregistered Public Identity (imsRegistrationType shall contain the value UNREGISTERED_USER) | | +| cscfServerName | String | M | 1 | Contains the S-CSCF name in SIP URI format. | | +| cscfInstanceId | NfInstanceId | M | 1 | The NF instance id of the S-CSCF. | | +| deregCallbackUri | Uri | C | 1 |

A URI provided by the S-CSCF to receive (implicitly subscribed) notifications on deregistration. The deregistration callback URI shall have unique information within S-CSCF set to identify the IMS Public Identity to be deregistered.

If there are implicitly identities registered (i.e. the identity belongs to an IRS) in the response, the deregistration callback URI identifies the IRS to be deregistered.

If there is a wildcarded PSI unregistered received in the response, the deregistration callback URI identifies the wildcarded PSI to be deregistered.

| | +| associatedImpis | array(Impi) | O | 1..N | Associated IMS private identities in the subscription. If the IMS subscription contains only single Private Identity this attribute shall not be present.
(NOTE) | | +| associatedRegisteredImpis | array(Impi) | O | 1..N | Associated registered IMS private identities in the subscription.
(NOTE) | | +| irsImpus | array(Impu) | O | 1..N | List of non barred IMS Public User Identities (distinct or wildcarded) which are in the Implicit Registration Set. This attribute shall be present when the received public identity belongs to an IRS.
(NOTE) | | +| wildcardedPui | Impu | O | 1 | It shall be present when the Public Identity in the request fell within the range of a Wildcarded Public User Identity present in the IRS.
(NOTE) | | +| wildcardedPsi | Impu | O | 1 |

It shall be present if the Public Identity in the request fell within the range of a Wildcarded Public Service Identity in the HSS whose state is unregistered.

If this element is present, it shall be used by the S-CSCF to identify the identity affected by the request.
(NOTE)

| | +| looseRouteIndicator | LooseRouteIndication | O | 1 | Loose Routing Indicator
(NOTE) | | +| supportedFeatures | SupportedFeatures | O | 0..1 | See clause 6.2.8 | | +| multipleRegistrationIndicator | boolean | C | 1 | Contains the multiple registration indication. If included, when it is set to true it indicates multiple registration. | | + +| | | | | | | +|----------------------------------------------------------------|---------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| pcscfRestorationIndicator | boolean | C | 0..1 | true: indicates that the P-CSCF-Restoration-mechanism shall be executed by the HSS.
false or absent: P-CSCF-Restoration is not requested.
May be present if imsRegistrationType is "UNREGISTERED_USER" or "ADMINISTRATIVE_DEREGISTRATION"; otherwise shall be absent. | | +| scscfReselectionIndicator | boolean | C | 0..1 | true: indicates that the S-CSCF has been selected due to, e.g. failure of the previously assigned S-CSCF.
false or absent: no S-CSCF reselection requested | | +| NOTE: Optional attribute applicable in response messages only. | | | | | | + +#### 6.1.6.2.11 Type: ExtendedProblemDetails + +**Table 6.1.6.2.11-1: Definition of type ExtendedProblemDetails** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|----------------|---|-------------|-------------------------------------------------------------------------------------------------------------| +| problemDetails | ProblemDetails | M | 1 | More information on the error shall be provided in the "cause" attribute of the "ProblemDetails" structure. | +| additionalInfo | AdditionalInfo | O | 1 | Contains the currently assigned S-CSCF name in SIP URI format. | + +#### 6.1.6.2.12 Type: AdditionalInfo + +**Table 6.1.6.2.12-1: Definition of type AdditionalInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------| +| scscfServerName | String | O | 1 | Current S-CSCF assigned to the user (in SIP URI format). This attribute shall be included when "cause" is IDENTITY_ALREADY_REGISTERED. | + +#### 6.1.6.2.13 Type: DeregistrationData + +**Table 6.1.6.2.13-1: Definition of type DeregistrationData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------------|------------------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| deregReason | DeregistrationReason | M | 1 | Indicates the reason for the deregistration. | | +| impi | Impi | M | 1 | Contains the IMS Private User Identity known by the S-CSCF. | | +| associatedImpis | Array(Impi) | O | 0..N | Associated IMS private Identities in the subscription that are deregistered.

This attribute may be present in responses, otherwise, it shall be absent. | | +| emergencyRegisteredIdentities | array(EmergencyRegisteredIdentity) | O | 1..N | A list of pairs of private and public user identities which have not been deregistered due to emergency registration.

This attribute may be present in responses, otherwise, it shall be absent. | | + +## 6.1.6.2.14 Type: DeregistrationReason + +**Table 6.1.6.2.14-1: Definition of type DeregistrationReason** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------------|---|-------------|----------------------------------------------------------------------------------------|---------------| +| reasonCode | DeregistrationReasonCode | M | 1 | Defines the reason for the network initiated de-registration | | +| reasonText | string | O | 0..1 | Contains textual information to inform the user about the reason for a de-registration | | + +## 6.1.6.2.15 Type: EmergencyRegisteredIdentity + +**Table 6.1.6.2.15-1: Definition of type EmergencyRegisteredIdentity** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|---------------------------|---------------| +| impi | Impi | M | 1 | IMS Private User Identity | | +| impu | Impu | M | 1 | IMS Public User Identity | | + +## 6.1.6.3 Simple data types and enumerations + +## 6.1.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +## 6.1.6.3.2 Simple data types + +The simple data types defined in table 6.1.6.3.2-1 shall be supported. + +**Table 6.1.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|---------------------------------------|---------------| +| Impu | string | Contains an IMS Public Identity | | +| Impi | string | Contains an IMS Private User Identity | | + +## 6.1.6.3.3 Enumeration: AuthorizationType + +The enumeration AuthorizationType represents the type of authorization requested. It shall comply with the provisions defined in table 6.1.6.3.3-1. + +**Table 6.1.6.3.3-1: Enumeration AuthorizationType** + +| Enumeration value | Description | Applicability | +|-------------------|----------------------------------------------------------------------------------|---------------| +| "REGISTRATION" | The authorization requested if for a user's IMS registration or re-registration. | | +| "DEREGISTRATION" | The authorization requested if for a user's IMS de-registration. | | + +## 6.1.6.3.4 Enumeration: AuthorizationResult + +The enumeration AuthorizationResult represents the details of the granted authorization. It shall comply with the provisions defined in table 6.1.6.3.4-1. + +**Table 6.1.6.3.4-1: AuthorizationResult** + +| Enumeration value | Description | +|---------------------------|---------------------------------------------------------------------------------| +| "FIRST_REGISTRATION" | The registration is an initial registration for the IMS Public User Identity | +| "SUBSEQUENT_REGISTRATION" | The registration is an subsequent registration for the IMS Public User Identity | + +#### 6.1.6.3.5 Enumeration: ImsRegistrationType + +The enumeration ImsRegistrationType represents the type of registration associated to the REGISTER request. + +**Table 6.1.6.3.5-1: Enumeration ImsRegistrationType** + +| Enumeration value | Description | Applicability | +|---------------------------------|----------------------------------------------------------------------------------------------------------------|---------------| +| "INITIAL_REGISTRATION" | The request is related to an initial registration | | +| "RE_REGISTRATION" | The request is related to a re-registration | | +| "TIMEOUT_DEREGISTRATION" | The registration timer of an identity has expired. | | +| "USER_DEREGISTRATION" | The S-CSCF has received a user initiated de-registration request | | +| "ADMINISTRATIVE_DEREGISTRATION" | The S-CSCF, due to administrative reasons or network issues, has performed the de-registration of an identity. | | +| "AUTHENTICATION_FAILURE" | The authentication of a user has failed. | | +| "AUTHENTICATION_TIMEOUT" | Authentication timeout has occurred. | | +| "UNREGISTERED_USER" | The request is related to a request for a Public Identity that is not registered. | | + +#### 6.1.6.3.6 Enumeration: LooseRouteIndication + +The enumeration LooseRouteIndication represents the type of registration associated to the REGISTER request. + +**Table 6.1.6.3.6-1: Enumeration LooseRouteIndication** + +| Enumeration value | Description | Applicability | +|----------------------------|-----------------------------------------------------------------------------------|---------------| +| "LOOSE_ROUTE_NOT_REQUIRED" | indicates whether loose route mechanism is not required to serve the user. | | +| "LOOSE_ROUTE_REQUIRED " | indicates the S-CSCF whether loose route mechanism is required to serve the user. | | + +#### 6.1.6.3.7 Enumeration: DeregistrationReasonCode + +The enumeration DeregistrationReasonCode indicates the reason for the network initiated de-registration. + +**Table 6.1.6.3.7-1: Enumeration DeregistrationReasonCode** + +| Enumeration value | Description | Applicability | +|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| "PERMANENT_TERMINATION" | The HSS indicates to the S-CSCF that the S-CSCF will no longer be assigned to the Public Identity and associated implicitly registered/unregistered Public Identities (if any) for the Private Identity(ies) indicated in the request (e.g. due to an IMS subscription cancellation, or modification, or a removal of IP-address secure binding information when GIBA is used). | | +| "NEW_SERVER_ASSIGNED" | The HSS indicates to the S-CSCF that a new S-CSCF has been allocated to the IMS Subscription e.g. because the previous assigned S-CSCF was unavailable during a registration procedure. The S-CSCF shall remove all information for all of the Public Identities indicated in the request. | | +| "SERVER_CHANGE" | The HSS indicates to the S-CSCF that the de-registration is requested to force the selection of new S-CSCF to assign to the IMS Subscription (e.g. when the S-CSCF capabilities are changed in the HSS or when the S-CSCF indicates that it has not enough memory for the updated User Profile). If the S-CSCF does not indicate in the response all the associated Private Identities, the HSS shall repeat this request for each of the remaining Private Identities in the IMS Subscription that are known to the S-CSCF. The S-CSCF should start the network initiated de-registration towards the user, i.e. all registrations within the IMS Subscription are de-registered and the user is asked to re-register to all existing registrations. | | +| "REMOVE_S-CSCF" | The HSS indicates to the S-CSCF that the S-CSCF will no longer be assigned to an unregistered Public Identity(ies) (i.e registered as a consequence of an originating or terminating request or there is a S-CSCF keeping the user profile stored) for a given IMS Subscription. | | + +#### 6.1.6.4 Data types describing alternative data types or combinations of data types + +There are no alternative data types, neither combinations of data types + +### 6.1.7 Error Handling + +#### 6.1.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +#### 6.1.7.2 Protocol Errors + +Protocol errors handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +#### 6.1.7.3 Application Errors + +The common application errors defined in the Table 5.2.7.2-1 in 3GPP TS 29.500 [4] may also be used for the Nhss\_imsUECM service. The following application errors listed in Table 6.1.7.3-1 are specific for the Nhss\_imsUECM service. + +**Table 6.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-----------------------------|------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| USER_NOT_FOUND | 404 Not Found | The received IMS UE identity is unknown. | +| CONTEXT_NOT_FOUND | 404 Not Found | The context identified by the callback reference is not found | +| IDENTITIES_DO_NOT_MATCH | 403 Forbidden | A message was received with a public identity and a private identity for a user, and the server determines that the public identity does not correspond to the private identity. | +| ERROR_IN_REGISTRATION_TYPE | 403 Forbidden | The requested registrationType is not allowed or the Public Identity type received in the request is not allowed for the requested registrationType. | +| IDENTITY_ALREADY_REGISTERED | 403 Forbidden | The identity has already a server assigned, and the registration information cannot be overwritten. | + +## 6.1.8 Feature negotiation + +The optional features in table 6.1.8-1 are defined for the XXX API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.1.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +## 6.1.9 Security + +As indicated in 3GPP TS 33.501 [5], the access to the Nhss\_imsUECM API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [35]), using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [36]) plays the role of the authorization server. + +If OAuth2 authorization is used, an NF Service Consumer, prior to consuming services offered by the Nhss\_imsUECM API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [36], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nhss\_imsUECM service. + +The Nhss\_imsUECM API defines the following scopes for OAuth2 authorization: + +**Table 6.1.9-1: OAuth2 scopes defined in Nhss\_imsUECM API** + +| Scope | Description | +|-------------------------------------|----------------------------------------------------------------| +| "nhss-ims-uecm" | Access to the Nhss IMS UE Context Management API | +| "nhss-ims-uecm:authorize:invoke" | Access to invoke the Authorize custom operation | +| "nhss-ims-uecm:registration:create" | Access to create S-CSCF Registration resources | +| "nhss-ims-uecm:restoration:read" | Access to read the S-CSCF Restoration resource | +| "nhss-ims-uecm:restoration:modify" | Access to create/update/delete the S-CSCF Restoration resource | + +## 6.2 Nhss\_imsSubscriberDataManagement Service API + +### 6.2.1 API URI + +URIs of this API shall have the following root: + +{apiRoot}/{apiName}/{apiVersion}/ + +where "apiRoot" is defined in clause 4.4.1 of 3GPP TS 29.501 [5], the "apiName" shall be set to "nhss-ims-sdm" and the "apiVersion" shall be set to "v1" for the current version of this specification. + +### 6.2.2 Usage of HTTP + +#### 6.2.2.1 General + +HTTP/2, as defined in IETF RFC 7540 [8], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +HTTP messages and bodies for the Nhss\_imsSubscriberDataManagement service shall comply with the OpenAPI [9] specification contained in Annex A.3. + +#### 6.2.2.2 HTTP standard headers + +##### 6.2.2.2.1 General + +The usage of HTTP standard headers shall be supported as specified in clause 5.2.2 of 3GPP TS 29.500 [4]. + +##### 6.2.2.2.2 Content type + +The following content types shall be supported: + +- JSON, as defined in IETF RFC 8259 [10], signalled by the content type "application/json". +- The Problem Details JSON Object (IETF RFC 7807 [11]) signalled by the content type "application/problem+json" +- JSON Patch, as defined in IETF RFC 6902 [12], signalled by the content type "application/json-patch+json" + +#### 6.2.2.3 HTTP custom headers + +##### 6.2.2.3.1 General + +The usage of HTTP custom headers shall be supported as specified in clause 5.2.3 of 3GPP TS 29.500 [4]. + +## 6.2.3 Resources + +### 6.2.3.1 Overview + +![Resource URI structure of the Nhss_imsSDM API](57939c16065211317c5442cf2a4009e0_img.jpg) + +``` +graph TD; apiRoot["{apiRoot}/nhss-ims-sdm/v1"] --> imsUeId["/{imsUeId}"]; imsUeId --> repositoryData["/repository-data"]; repositoryData --> serviceIndication["/{serviceIndication}"]; imsUeId --> identities["/identities"]; identities --> imsAssociatedIdentities["/ims-associated-identities"]; identities --> msisdns["/msisdns"]; identities --> privateIdentities["/private-identities"]; identities --> imeiSv["/imeiSv"]; imsUeId --> imsData["/ims-data"]; imsData --> profileData["/profile-data"]; profileData --> ifcs["/ifcs"]; profileData --> serviceLevelTraceInfo["/service-level-trace-info"]; profileData --> priorityLevels["/priority-levels"]; profileData --> chargingInfo["/charging-info"]; imsData --> locationData["/location-data"]; locationData --> serverName["/server-name"]; locationData --> scscfCapabilities["/scscf-capabilities"]; locationData --> scscfSelectionAssistanceInfo["/scscf-selection-assistance-info"]; imsData --> registrationStatus["/registration-status"]; imsUeId --> subscriptions["/subscriptions"]; subscriptions --> subscriptionId["/{subscriptionId}"]; +``` + +The diagram illustrates the hierarchical structure of the Nhss\_imsSDM API. It starts with the root path `{apiRoot}/nhss-ims-sdm/v1`. The first level of sub-resources is `/{imsUeId}`, which branches into `/repository-data`, `/identities`, `/ims-data`, and `/subscriptions`. `/repository-data` further branches into `/{serviceIndication}`. `/identities` branches into `/ims-associated-identities`, `/msisdns`, `/private-identities`, and `/imeiSv`. `/ims-data` branches into `/profile-data`, `/location-data`, and `/registration-status`. `/profile-data` branches into `/ifcs`, `/service-level-trace-info`, `/priority-levels`, and `/charging-info`. `/location-data` branches into `/server-name`, `/scscf-capabilities`, and `/scscf-selection-assistance-info`. Finally, `/subscriptions` branches into `/{subscriptionId}`. + +Resource URI structure of the Nhss\_imsSDM API + +Figure 6.2.3.1-1: Resource URI structure of the Nhss\_imsSDM API + +![A hierarchical tree diagram showing the Resource URI structure of the Nhss_imsSDM API. The root is {apiRoot}/nhss-ims-sdm/v1. It branches into /{imsUeId}, /shared-data, /shared-data-subscriptions, /access-data, /srvcc-data, and /service-data. Further sub-paths include /ps-domain, /cs-domain, /wireline-domain under /access-data; /psi-status, /dsai, /sms-registration-info under /service-data; and various user-state, location-data, and subscription-related endpoints.](ffb6acd27b8e3a54392840948a75869f_img.jpg) + +``` +graph TD; Root["{apiRoot}/nhss-ims-sdm/v1"]; Root --> imsUeId["/{imsUeId}"]; Root --> sharedData["/shared-data"]; Root --> sharedDataSubscriptions["/shared-data-subscriptions"]; Root --> accessData["/access-data"]; Root --> srvccData["/srvcc-data"]; Root --> serviceData["/service-data"]; imsUeId --> psDomain["/ps-domain"]; imsUeId --> csDomain["/cs-domain"]; imsUeId --> wirelineDomain["/wireline-domain"]; psDomain --> psUserState["/user-state"]; psDomain --> psLocationData["/location-data"]; psDomain --> psTadsInfo["/tads-info"]; psDomain --> psIpAddress["/ip-address"]; psDomain --> psUeReachSubscriptions["/ue-reach-subscriptions"]; psUeReachSubscriptions --> psSubscriptionId["/{subscriptionId}"]; csDomain --> csUserState["/user-state"]; csDomain --> csLocationData["/location-data"]; csDomain --> csCsm["/csm"]; wirelineDomain --> wirelineReferenceLocation["/reference-location"]; sharedData --> sharedDataId["/{sharedDataId}"]; sharedDataSubscriptions --> sharedDataSubscriptionsId["/{subscriptionId}"]; serviceData --> psiStatus["/psi-status"]; serviceData --> dsai["/dsai"]; serviceData --> smsRegistrationInfo["/sms-registration-info"]; +``` + +A hierarchical tree diagram showing the Resource URI structure of the Nhss\_imsSDM API. The root is {apiRoot}/nhss-ims-sdm/v1. It branches into /{imsUeId}, /shared-data, /shared-data-subscriptions, /access-data, /srvcc-data, and /service-data. Further sub-paths include /ps-domain, /cs-domain, /wireline-domain under /access-data; /psi-status, /dsai, /sms-registration-info under /service-data; and various user-state, location-data, and subscription-related endpoints. + +Figure 6.2.3.1-2: Resource URI structure of the Nhss\_imsSDM API + +Table 6.2.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.2.3.1-1: Resources and methods overview** + +| Resource name
(Archetype) | Resource URI | HTTP method or
custom operation | Description | +|-------------------------------------------------------|-----------------------------------------------------------------------------|------------------------------------|----------------------------------------------------------------------------------------------------| +| Repository Data
(Document) | /{imsUId}/repository-data/
{serviceIndication} | GET | Retrieve repository data for a service indication | +| | | DELETE | Delete repository data for a service indication | +| | | PUT | Update repository data for a service indication | +| IMS Associated Identities
(Document) | /{imsUId}/identities/ims-associated-identities | GET | Retrieve the UE's IMS associated identities (implicit and alias) | +| MSISDNs
(Document) | /{imsUId}/identities/msisdns | GET | Retrieve the UE's MSISDNs (basic and additional) | +| PrivateIdentities
(Document) | /{imsUId}/identities/private-identities | GET | Retrieve the UE's Private Identities (IMPI and IMSI) | +| ImeiSvnInformation
(Document) | /{imsUId}/identities/imeiSvn | GET | Retrieve the UE's IMEISV | +| IMS Profile Data
(Document) | /{imsUId}/ims-data/profile-data | GET | Retrieve the UE's subscribed Profile | +| Initial Filter Criteria
(Document) | /{imsUId}/ims-data/profile-data/ifcs | GET | Retrieve the UE's subscribed Initial Filter Criteria | +| Service Level Trace Information
(Document) | /{imsUId}/ims-data/profile-data/service-level-trace-info | GET | Retrieve the UE's subscribed Service Level Trace Information | +| Service Priority Information
(Document) | /{imsUId}/ims-data/profile-data/priority-levels | GET | Retrieve the UE's subscribed Service Priority Levels | +| Charging Information
(Document) | /{imsUId}/ims-data/profile-data/chargingInfo | GET | Retrieve the UE's subscribed Charging Information | +| IMS Location Data
(Document) | /{imsUId}/ims-data/location-data/server-name | GET | Retrieve the UE's S-CSCF name | +| S-CSCF Capabilities
(Document) | /{imsUId}/ims-data/location-data/scscf-capabilities | GET | Retrieve the UE's S-CSCF capabilities (mandatory and/or optional) | +| S-CSCF Selection Assistance Information
(Document) | /{imsUId}/ims-data/location-data/scscf-selection-assistance-info | GET | Retrieve the UE's S-CSCF Selection Assistance Information | +| IMS Registration Status
(Document) | /{imsUId}/ims-data/registration-status | GET | Retrieve the UE's IMS registration status. | +| Subscriptions
(Collection) | /{imsUId}/subscriptions | POST | Create a subscription | +| Individual subscription
(Document) | /{imsUId}/subscriptions/
{subscriptionId} | DELETE | Delete the subscription identified by {subscriptionId}, i.e. unsubscribe | +| | | PATCH | Modify the sdm-subscription identified by {subscriptionId} | +| PS Location Information
(Document) | /{imsUId}/access-data/ps-domain/location-data | GET | Retrieve the UE's location in PS domain | +| CS Location Information
(Document) | /{imsUId}/access-data/cs-domain/location-data | GET | Retrieve the UE's location in CS domain | +| PsUserState
(Document) | /{imsUId}/access-data/ps-domain/user-state | GET | Retrieve the UE's state in PS domain | +| CsUserState
(Document) | /{imsUId}/access-data/cs-domain/user-state | GET | Retrieve the UE's state in CS domain | +| TadsInfo
(Document) | /{imsUId}/access-data/ps-domain/tads-info | GET | Retrieve the UE's T-ADS information | +| UeReachabilityIpSubscriptions
(Collection) | /{imsUId}/access-data/ps-domain/ue-reach-subscriptions | POST | Create a subscription to UE Reachability for IP | +| UE reachability individual subscription
(Document) | /{imsUId}/access-data/ps-domain/ue-reach-subscriptions/
{subscriptionId} | DELETE | Delete the subscription to UE reachability for IP identified by {subscriptionId}, i.e. unsubscribe | + +| | | | | +|------------------------------------------------|-----------------------------------------------------------|--------|------------------------------------------------------------------------------------| +| | | PATCH | Modify the subscription to UE reachability for IP identified by {subscriptionId} | +| IpAddress (Document) | /{imsUeId}/access-data/ps-domain/ip-address | GET | Retrieve the UE's stored IP Address Secure Binding Information | +| Csrn (Document) | /{imsUeId}/access-data/cs-domain/csrn | GET | Retrieve a CSRN for the UE | +| ReferenceAccessLocation (Document) | /{imsUeId}/access-data/wireline-domain/reference-location | GET | Retrieve the UE's subscribed Reference Access Location | +| SRVCC Data (Document) | /{imsUeId}/srvcc-data | GET | Retrieve the UE's STN-SR and SRVCC capability | +| | | PATCH | Update the UE's STN-SR. | +| PSI Activation State (Document) | /{imsUeId}/service-data/psi-status | GET | Retrieve a PSI activation status | +| | | PATCH | Update a PSI activation status | +| Dsai (Document) | /{imsUeId}/service-data/dsai | GET | Retrieve DSAI data (i.e. DSAI tags and status) associated to an Application Server | +| | | PATCH | Update DSAI data associated to an Application Server | +| SMSRegistrationInfo (Document) | /{imsUeId}/service-data/sms-registration-info | GET | Retrieve the SMS Registration Information (e.g. IP-SM-GW address) | +| | | PUT | Creates or updates the SMS Registration Information (e.g. IP-SM-GW address) | +| | | DELETE | Deletes the SMS Registration Information (e.g. IP-SM-GW address) | +| SharedData (Collection) | /shared-data | GET | Retrieve shared data | +| SharedDataSubscriptions (Collection) | /shared-data-subscriptions | POST | Create a subscription | +| Shared Data Individual Subscription (Document) | /shared-data-subscriptions/{subscriptionId} | DELETE | Delete the subscription identified by {subscriptionId}, i.e. unsubscribe | +| | | PATCH | Modify the subscription identified by {subscriptionId} | + +### 6.2.3.2 Resource: IMS Associated Identities + +#### 6.2.3.2.1 Description + +This resource represents the IMS associated identities. It is queried by the service consumer (IMS-AS) to retrieve the list of identities in the same Implicit Registration Set, together with the Alias Group Information and additional information (e.g. identity type) + +#### 6.2.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/identities/ims-associated-identities + +This resource shall support the resource URI variables defined in table 6.2.3.2.2-1. + +**Table 6.2.3.2.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)

pattern: "^(impu-sip:\{([a-zA-Z0-9_-\.!~*()&=+;\$,;?V +])\}@([A-Za-z0-9]+\-[A-Za-z0-9]+\.[a-z]{2,} impu-tel:\+[0-9]{5,15} impi-\.[+\.]+\+)" | + +### 6.2.3.2.3 Resource Standard Methods + +#### 6.2.3.2.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.2.3.1-1. + +**Table 6.2.3.2.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.2.3.2.3.1-2 and the response data structures and response codes specified in table 6.2.3.2.3.1-3. + +**Table 6.2.3.2.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.2.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| lmsAssociatedIdentities | M | 1 | 200 OK | A response body containing the list of identities belonging to the same Implicit Registration Set shall be returned, together with the related information (Alias Group, if any, identity type, IRS default identity, registration state of the IRS). | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- USER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.2.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.2.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +### 6.2.3.3 Resource: MSISDNS + +#### 6.2.3.3.1 Description + +This resource represents the MSISDNs associated to the UE. It is queried by the service consumer (IMS-AS) to retrieve the list of MSISDNs (basic and additional). If the UE is shared among multiple IMS Private Identities and the consumer queries for the basic MSISDN (C-MSISDN), the URI query parameter Private Identity (IMPI) shall be included. + +#### 6.2.3.3.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/identities/msisdns + +This resource shall support the resource URI variables defined in table 6.2.3.3.2-1. + +**Table 6.2.3.3.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)

pattern: "^(impu-sip\:[a-zA-Z0-9_-\.!~*()&=+\$_;?V]+\@[A-Za-z0-9]+([A-Za-z0-9]+\.[a-z]{2,} impu-tel\:[0-9]{5,15} impi-\.[a-z]+\.[a-z]{2,} impi-tel\:[0-9]{5,15}))\$" | + +#### 6.2.3.3.3 Resource Standard Methods + +##### 6.2.3.3.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.3.3.1-1. + +**Table 6.2.3.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| private-id | PrivatId | O | 0..1 | IMS Private Identity (IMPI) of the UE. It shall be included if there are multiple Private Identities associated to the Public Identity received and the basic MSISDN (C-MSISDN) is requested. | + +This method shall support the request data structures specified in table 6.2.3.3.3.1-2 and the response data structures and response codes specified in table 6.2.3.3.3.1-3. + +**Table 6.2.3.3.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.3.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| MsisdnList | M | 1 | 200 OK | A response body containing the list of MSISDNs associated to the UE and all Private Identities shall be returned. If the response is for a basic MSISDN (C-MSISDN) query (query parameter IMPI was present), only one MSISDN shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.4 Resource: S-CSCF Capabilities + +### 6.2.3.4.1 Description + +This resource represents the S-CSCF capabilities. It is queried by the service consumer (I-CSCF) to retrieve S-CSCF capabilities associated to the UE (mandatory capabilities and/or optional capabilities). + +### 6.2.3.4.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/ims-data/location-data/scscf-capabilities + +This resource shall support the resource URI variables defined in table 6.2.3.4.2-1. + +**Table 6.2.3.4.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)

pattern: " ^(impu-sip:\{[a-zA-Z0-9 \-\.!~*()\&=+\$,;:?\v]+\}@([A-Za-z0-9]+([A-Za-z0-9]+\.)+[a-z]{2,} impu-tel:\+[0-9]{5,15} impi-\+\.+\+)\$" | + +### 6.2.3.4.3 Resource Standard Methods + +#### 6.2.3.4.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.4.3.1-1. + +**Table 6.2.3.4.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.2.3.4.3.1-2 and the response data structures and response codes specified in table 6.2.3.4.3.1-3. + +**Table 6.2.3.4.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.4.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ScscfCapabilityList | M | 1 | 200 OK | A response body containing the list mandatory and/or optional capabilities shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND

NOTE: DATA_NOT_FOUND indicates that any S-CSCF can be selected, e.g. based on I-CSCF local policy. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.4.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.4.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +#### 6.2.3.5 Resource: IMS Profile Data + +#### 6.2.3.5.1 Description + +This resource represents the IMS Profile Data. It is queried by the service consumer (S-CSCF) to retrieve the user's IMS profile data, containing the required information to handle the multimedia sessions (e.g. Initial Filter Criteria) + +#### 6.2.3.5.2 Resource Definition + +Resource URI: *{apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/ims-data/profile-data* + +This resource shall support the resource URI variables defined in table 6.2.3.5.2-1. + +**Table 6.2.3.5.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId |

Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)

pattern: "^((impu-sip:([a-zA-Z0-9\-_\.!~*()&=+\\$,;?V]+)@([A-Za-z0-9]+\-[A-Za-z0-9]+\.)+[a-z]{2,}) (impu-tel:\+[0-9]{5,15}) impi-.+)\$"

| + +### 6.2.3.5.3 Resource Standard Methods + +#### 6.2.3.5.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.5.3.1-1. + +**NOTE:** The retrieval of these data sets can also be achieved by sending individual GET requests to the corresponding sub-resources under the {imsUeId} resource. When multiple data sets need to be retrieved by the NF Service consumer, it is recommended to use a single GET request with query parameters rather than issuing multiple GET requests. + +**Table 6.2.3.5.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|--------------------|---|-------------|-----------------------------------| +| dataset-names | array(DataSetName) | O | 1..N | Datasets to be retrieved | +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +This method shall support the request data structures specified in table 6.2.3.5.3.1-2 and the response data structures and response codes specified in table 6.2.3.5.3.1-3. + +**Table 6.2.3.5.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.5.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| imsProfileData | M | 1 | 200 OK | Upon success, a response body containing the User's Profile Data shall be included. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application errors:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.5.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.5.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.6 Resource: Subscriptions + +### 6.2.3.6.1 Description + +This resource is used to represent subscriptions to notifications of data change. + +### 6.2.3.6.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/subscriptions + +This resource shall support the resource URI variables defined in table 6.2.3.6.2-1. + +**Table 6.2.3.6.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)

pattern: "^(impu-sip:\{[a-zA-Z0-9 \-\.!~*()&=+;\$,;?V]+\}@([A-Za-z0-9]+\-[A-Za-z0-9]+\+\.)+[a-z]{2,} impu-tel:\+\{0-9\}{5,15} impi-\+\.+\+\.+\\$)" | + +### 6.2.3.6.3 Resource Standard Methods + +#### 6.2.3.6.3.1 POST + +This method shall support the URI query parameters specified in table 6.2.3.6.3.1-1. + +**Table 6.2.3.6.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.2.3.6.3.1-2 and the response data structures and response codes specified in table 6.2.3.6.3.1-3. + +**Table 6.2.3.6.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------|---|-------------|-----------------------------------------| +| ImsSdmSubscription | M | 1 | The subscription that is to be created. | + +**Table 6.2.3.6.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ImsSdmSubscription | M | 1 | 201 Created | Upon success, a response body containing a representation of the created Individual subscription resource shall be returned.

The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- USER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 501 Not Implemented | The "cause" attribute may be used to indicate the following application error:
- UNSUPPORTED_RESOURCE_URI

This response shall not be cached. | + +**Table 6.2.3.6.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.6.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +### 6.2.3.7 Resource: Individual subscription + +#### 6.2.3.7.1 Description + +This resource is used to represent an individual subscription to notifications of data change. + +#### 6.2.3.7.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/subscriptions/{subscriptionId} + +This resource shall support the resource URI variables defined in table 6.2.3.7.2-1. + +**Table 6.2.3.7.2-1: Resource URI variables for this resource** + +| Name | Definition | +|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)
pattern: " ^ (impu-sip\:(a-zA-Z0-9 \-\.!~*()&=+,\$,;?V +)\@([A-Za-z0-9]+([A-Za-z0-9]+\.)+[a-z]{2,} impu-tel\:(+[0-9]{5,15} impi-\+ \.+\+)\$" | +| subscriptionId | The subscriptionId identifies an individual subscription to notifications. | + +#### 6.2.3.7.3 Resource Standard Methods + +##### 6.2.3.7.3.1 DELETE + +This method shall support the URI query parameters specified in table 6.2.3.7.3.1-1. + +**Table 6.2.3.7.3.1-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.2.3.7.3.1-2 and the response data structures and response codes specified in table 6.2.3.7.3.1-3. + +**Table 6.2.3.7.3.1-2: Data structures supported by the Delete Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|----------------------------------| +| n/a | | | The request body shall be empty. | + +**Table 6.2.3.7.3.1-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- SUBSCRIPTION_NOT_FOUND, see 3GPP TS 29.500 [4] table 5.2.7.2-1. | + +**Table 6.2.3.7.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.7.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +### 6.2.3.7.3.2 PATCH + +This method shall support the URI query parameters specified in table 6.2.3.7.3.2-1. + +**Table 6.2.3.7.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.2.3.7.3.2-2 and the response data structures and response codes specified in table 6.2.3.7.3.2-3. + +**Table 6.2.3.7.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| array(PatchItem) | M | 1 | It contains the list of changes to be made to the resource representing the individual subscription, according to the JSON PATCH format specified in IETF RFC 6902 [12]. | + +**Table 6.2.3.7.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, a response with no content is returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- SUBSCRIPTION_NOT_FOUND, see 3GPP TS 29.500 [4] table 5.2.7.2-1. | +| ProblemDetails | O | 0..1 | 403 Forbidden | One or more attributes are not allowed to be modified.

The "cause" attribute may be used to indicate the following application error:
- MODIFICATION_NOT_ALLOWED, see 3GPP TS 29.500 [4] table 5.2.7.2-1. | + +**Table 6.2.3.7.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.7.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.8 Resource: SharedDataSubscriptions + +### 6.2.3.8.1 Description + +This resource is used to represent subscriptions to notifications for shared data. + +### 6.2.3.8.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/shared-data-subscriptions + +This resource shall support the resource URI variables defined in table 6.2.3.8.2-1. + +**Table 6.2.3.8.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | + +### 6.2.3.8.3 Resource Standard Methods + +#### 6.2.3.8.3.1 POST + +This method shall support the URI query parameters specified in table 6.2.3.8.3.1-1. + +**Table 6.2.3.8.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.2.3.8.3.1-2 and the response data structures and response codes specified in table 6.2.3.8.3.1-3. + +**Table 6.2.3.8.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------|---|-------------|-----------------------------------------| +| ImsSdmSubscription | M | 1 | The subscription that is to be created. | + +**Table 6.2.3.8.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ImsSdmSubscription | M | 1 | 201 Created | Upon success, a response body containing a representation of the created Individual subscription resource shall be returned.

The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| ProblemDetails | O | 0..1 | 501 Not Implemented | The "cause" attribute may be used to indicate the following application error:
- UNSUPPORTED_RESOURCE_URI

This response shall not be cached. | + +**Table 6.2.3.8.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.8.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +### 6.2.3.9 Resource: Shared Data Individual subscription + +#### 6.2.3.9.1 Description + +This resource is used to represent an individual subscription to notifications for shared data. + +#### 6.2.3.9.2 Resource Definition + +Resource URI: **{apiRoot}/nhss-sdm/{apiVersion}/shared-data-subscriptions/{subscriptionId}** + +This resource shall support the resource URI variables defined in table 6.2.3.9.2-1. + +**Table 6.2.3.9.2-1: Resource URI variables for this resource** + +| Name | Definition | +|----------------|----------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| subscriptionId | The subscriptionId identifies an individual subscription to notifications. | + +#### 6.2.3.9.3 Resource Standard Methods + +##### 6.2.3.9.3.1 DELETE + +This method shall support the URI query parameters specified in table 6.2.3.9.3.1-1. + +**Table 6.2.3.9.3.1-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.2.3.zz.3.1-2 and the response data structures and response codes specified in table 6.2.3.zz.3.1-3. + +**Table 6.2.3.9.3.1-2: Data structures supported by the Delete Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|----------------------------------| +| n/a | | | The request body shall be empty. | + +**Table 6.2.3.9.3.1-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| ProblemDetails | O | 0..1 | 404 Not Found |

The resource corresponding to the SubscriptionId can't be found.

The "cause" attribute may be used to indicate the following application error:
- SUBSCRIPTION_NOT_FOUND, see 3GPP TS 29.500 [4] table 5.2.7.2-1.

| + +**Table 6.2.3.9.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.9.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +### 6.2.3.9.3.2 PATCH + +This method shall support the URI query parameters specified in table 6.2.3.9.3.2-1. + +**Table 6.2.3.9.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.2.3.9.3.2-2 and the response data structures and response codes specified in table 6.2.3.9.3.2-3. + +**Table 6.2.3.9.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| array(PatchItem) | M | 1 | It contains the list of changes to be made to the resource representing the individual subscription, according to the JSON PATCH format specified in IETF RFC 6902 [12]. | + +**Table 6.2.3.9.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ImsSdmSubscription | M | 1 | 200 OK | Upon success, the modified ImsSdmSubscription shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| ProblemDetails | O | 0..1 | 404 Not Found | The resource corresponding to the SubscriptionId can't be found.

The "cause" attribute may be used to indicate the following application error:
- SUBSCRIPTION_NOT_FOUND, see 3GPP TS 29.500 [4] table 5.2.7.2-1. | +| ProblemDetails | O | 0..1 | 403 Forbidden | One or more attributes are not allowed to be modified.

The "cause" attribute may be used to indicate the following application error:
- MODIFICATION_NOT_ALLOWED, see 3GPP TS 29.500 [4] table 5.2.7.2-1. | + +**Table 6.2.3.9.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.9.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.10 Resource: IMS Registration Status + +### 6.2.3.10.1 Description + +This resource represents the IMS Registration Status. It is queried by the service consumer (e.g. AS) to retrieve the IMS registration status of the user. + +### 6.2.3.10.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/ims-data/registration-status + +This resource shall support the resource URI variables defined in table 6.2.3.10.2-1. + +**Table 6.2.3.10.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)
pattern: " ^ (impu-sip:\{[a-zA-Z0-9_-\.!~*()&=+\$,;?V ]+\}@([A-Za-z0-9]+\-[A-Za-z0-9]+\.[a-z]{2,} impu-tel:\+[0-9]{5,15} impi-\.[\.]+\.[a-z]{2,} impi-tel:\+[0-9]{5,15} impi-\.[\.]+\.[a-z]{2,} impi-tel:\+[0-9]{5,15})\$" | + +### 6.2.3.10.3 Resource Standard Methods + +#### 6.2.3.10.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.10.3.1-1. + +**Table 6.2.3.10.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------|---|-------------|-----------------------------------|---------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | | + +This method shall support the request data structures specified in table 6.2.3.10.3.1-2 and the response data structure and response codes specified in table 6.2.3.10.3.1-3. + +**Table 6.2.3.10.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.10.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ImsRegistrationStatus | M | 1 | 200 OK | A response body containing the IMS registration status of the user. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND

DATA_NOT_FOUND indicates the user has not performed yet any IMS registration. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.10.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.10.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.11 Resource: Service Priority Information + +### 6.2.3.11.1 Description + +This resource represents the Service Priority Levels. It is queried by the service consumer (e.g. AS) to retrieve the Namespaces and priority levels allowed for the user. + +### 6.2.3.11.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/ims-data/profile-data/priority-levels + +This resource shall support the resource URI variables defined in table 6.2.3.11.2-1. + +**Table 6.2.3.11.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)

pattern: "^(impu-sip:([a-zA-Z0-9_\-\.\!\~*()\&\=\+\\$,;\?V]+)@([A-Za-z0-9]+([\-A-Za-z0-9]+)*\.)+[a-z]{2,} impu-tel:\+[0-9]{5,15} impi-.+ .+)\$" | + +### 6.2.3.11.3 Resource Standard Methods + +#### 6.2.3.11.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.11.3.1-1. + +**Table 6.2.3.11.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------|---|-------------|-----------------------------------|---------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | | + +This method shall support the request data structures specified in table 6.2.3.11.3.1-2 and the response data structures and response codes specified in table 6.2.3.11.3.1-3. + +**Table 6.2.3.11.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.11.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| PriorityLevels | M | 1 | 200 OK | A response body containing the service priority information (priority namespaces and associated levels) allowed for the user shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND

DATA_NOT_FOUND indicates that the user does not have priority service. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.11.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.11.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.12 Resource: Initial Filter Criteria + +### 6.2.3.12.1 Description + +This resource represents the Initial Filter Criteria (IFCs). It is queried by the service consumer (e.g. S-CSCF, AS) to retrieve the list of IFCs associated to the UE (including Shared IFC Set Identifiers, if provisioned). + +### 6.2.3.12.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/ims-data/profile-data/ifcs + +This resource shall support the resource URI variables defined in table 6.2.3.12.2-1. + +**Table 6.2.3.12.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)
pattern: " ^ (impu-sip:\{[a-zA-Z0-9_\-\.!~*()&=+\$,;?V +]\}@([A-Za-z0-9]+\-[A-Za-z0-9]+\+\.)+[a-z]{2,}\ impu-tel:\+\[0-9]{5,15}\ impi-\+\.+\+)" | + +### 6.2.3.12.3 Resource Standard Methods + +#### 6.2.3.12.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.12.3.1-1. + +**Table 6.2.3.12.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|-------------------------|-------------------|---|-------------|------------------------------------------------------------------|---------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | | +| application-server-name | SipServerName | O | 0..1 | This information element indicates application server's SIP URI. | | + +This method shall support the request data structures specified in table 6.2.3.12.3.1-2 and the response data structures and response codes specified in table 6.2.3.12.3.1-3. + +**Table 6.2.3.12.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.12.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| lfcs | M | 1 | 200 OK | A response body containing the list of complete IFCs and/or shared IFC set identifiers shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND

DATA_NOT_FOUND indicates that there is no Initial Filter Criteria associated to the user (i.e. no AS is triggered by S-CSCF for the user) | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.12.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.12.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.13 Resource: IMS Location Data + +### 6.2.3.13.1 Description + +This resource represents the IMS location data. It is queried by the service consumer (e.g. AS) to retrieve the S-CSCF name stored for the user. + +### 6.2.3.13.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/ims-data/location-data/server-name + +This resource shall support the resource URI variables defined in table 6.2.3.13.2-1. + +**Table 6.2.3.13.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)
pattern: " ^(impu-sip:\{[a-zA-Z0-9 \-\.!~*()&=+;\$,;?V]+\}@([A-Za-z0-9]+\-[A-Za-z0-9]+\.[a-z]{2,} impu-tel:\+[0-9]{5,15} impi-\.[a-z]+\.[a-z]{2,} impu-tel:\+[0-9]{5,15} impi-\.[a-z]+\.[a-z]{2,} )\$" | + +## 6.2.3.13.3 Resource Standard Methods + +### 6.2.3.13.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.13.3.1-1. + +**Table 6.2.3.13.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------|---|-------------|-----------------------------------|---------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | | + +This method shall support the request data structures specified in table 6.2.3.13.3.1-2 and the response data structure and response codes specified in table 6.2.3.13.3.1-3. + +**Table 6.2.3.13.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.13.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ImLocationData | M | 1 | 200 OK | A response body containing the S-CSCF name stored for the user. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND

DATA_NOT_FOUND indicates the user has not performed yet any IMS registration. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.13.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.13.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.14 Resource: Service Level Trace Information + +### 6.2.3.14.1 Description + +This resource represents the Service Level Trace Information. It is queried by the service consumer (e.g. AS) to retrieve the Trace Level information so that the consumer can perform logging for the user as described in IETF RFC 8497 [23]. + +### 6.2.3.14.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/ims-data/profile-data/service-trace-level-information + +This resource shall support the resource URI variables defined in table 6.2.3.14.2-1. + +**Table 6.2.3.14.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)
pattern: " ^ (impu-sip:\{[a-zA-Z0-9_-\.!~*()&=+\$,;?V ]+\}@([A-Za-z0-9]+\-[A-Za-z0-9]+\+\. \. )+[a-z]{2,} impu-tel:\+ +[0-9]{5,15} impi-\+ \. +\+)" | + +### 6.2.3.14.3 Resource Standard Methods + +#### 6.2.3.14.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.14.3.1-1. + +**Table 6.2.3.14.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------|---|-------------|-----------------------------------|---------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | | + +This method shall support the request data structures specified in table 6.2.3.14.3.1-2 and the response data structures and response codes specified in table 6.2.3.14.3.1-3. + +**Table 6.2.3.14.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.14.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ServiceLevelTraceInformation | M | 1 | 200 OK | A response body containing the IMS service level trace information shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND

DATA_NOT_FOUND indicates that the service level tracing is disabled for the user. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.14.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.14.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.15 Resource: PS location Information + +### 6.2.3.15.1 Description + +This resource represents the Location Information in PS domain. It is queried by the service consumer (e.g. AS) to retrieve the location information in PS domain as retrieved from the serving node(s). The service consumer may indicate the requested nodes for which the request is applicable (e.g. AMF only) + +### 6.2.3.15.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/access-data/ps-domain/location-data + +This resource shall support the resource URI variables defined in table 6.2.3.15.2-1. + +**Table 6.2.3.15.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity) or the IMS private Identity. If both the IMS Public Identity and the IMS Private Identity are available at the service consumer, the imsUeId represents the IMS Public Identity.

pattern: "^(impu-sip:\{[a-zA-Z0-9_-\.!~*()&=+\$_;?V]+\}@([A-Za-z0-9]+\-[A-Za-z0-9]+\.)\.[a-z]{2,} impu-tel:\+[0-9]{5,15} impi-\.[\.]+\+)" | + +## 6.2.3.15.3 Resource Standard Methods + +### 6.2.3.15.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.15.3.1-1. + +**Table 6.2.3.15.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|----------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| requested-nodes | array(RequestedNode) | O | 1..N | Indicates the serving node(s) for which the request is applicable. | +| serving-node | boolean | O | 0..1 | Indicates that only the stored NF id/address of the serving node(s) requested and PLMN identity are required, that is, other location data (e.g. Global Cell ID) is not required.

It shall be absent if current-location is present with value true.

true: only the requested node(s) address(es) are requested
false or absent: location data as retrieved from the requested node(s) is requested. | +| local-time | boolean | O | 0..1 | Indicates that only the Local Time Zone information (Time Zone and Daylight Saving Time) and the PLMN identity of the location in the visited network where the UE is attached is requested, that is, other location data (e.g. Global Cell ID) is not required.

true: only the local time is requested
false or absent: location data as retrieved from the requested node(s) is requested. | +| current-location | boolean | O | 0..1 | Indicates whether an active location retrieval has to be initiated by the requested node(s).

true: active location retrieval is requested
false or absent: active location retrieval is not requested | +| rat-type | boolean | O | 0..1 | Indicates whether retrieval of RAT type is requested.
true: requested
false: not requested | +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | +| private-identity | Privateld | C | 0..1 | Represents the IMS Private Identity. Shall be present if the imsUeId variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities. | + +If "requested-nodes" is not included, HSS shall return location information as retrieved from all the nodes (AMF, MME and SGSN) + +This method shall support the request data structures specified in table 6.2.3.15.3.1-2 and the response data structures and response codes specified in table 6.2.3.15.3.1-3. + +**Table 6.2.3.15.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.15.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|---------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| PsLocation | M | 1 | 200 OK | A response body containing the PS location information as requested shall be returned. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND

DATA_NOT_FOUND indicates that the location information is unknown or unavailable. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.15.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.15.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.16 Resource: CS location Information + +### 6.2.3.16.1 Description + +This resource represents the Location Information in CS domain. It is queried by the service consumer (e.g. AS) to retrieve the location information in CS domain as retrieved from the MSC/VLR. + +### 6.2.3.16.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/access-data/cs-domain/location-data + +This resource shall support the resource URI variables defined in table 6.2.3.16.2-1. + +**Table 6.2.3.16.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId |

Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity) or the IMS private Identity. If both the IMS Public Identity and the IMS Private Identity are available at the service consumer, the imsUeId represents the IMS Public Identity.

pattern: "^((impu-sip):([a-zA-Z0-9_\-.!~*'()&=+\$,;?V/]+)@([A-Za-z0-9]+([\-A-Za-z0-9]+)*\.)+[a-z]{2,} impu-tel:\+[0-9]{5,15} impi-.+)\$"

| + +### 6.2.3.16.3 Resource Standard Methods + +#### 6.2.3.16.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.16.3.1-1. + +**Table 6.2.3.16.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| serving-node | boolean | O | 0..1 | Indicates that only the MSC/VLR address and PLMN identity are required, that is, other location data (e.g. Global Cell ID) is not required.

It shall be absent if current-location is present.

true: only the MSC/VLR number requested
false or absent: location data as retrieved from the MSC/VLR is requested. | +| local-time | boolean | O | 0..1 | Indicates that only the Local Time Zone information (Time Zone and Daylight Saving Time) and the PLMN identity of the location in the visited network where the UE is attached is requested, that is, other location data (e.g. Global Cell ID) is not required.

It shall be absent if current-location is present. | +| current-location | boolean | O | 0..1 | Indicates whether an active location retrieval has to be initiated by the MSC/VLR. | +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | +| private-identity | PrivateId | C | 0..1 | Represents the IMS Private Identity. Shall be present if the imsUeId variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities. | + +If "serving-node" is not included, HSS shall return the location data as retrieved from the MSC/VLR. + +If "local-time" is not included, HSS shall return the location data as retrieved from the MSC/VLR. + +This method shall support the request data structures specified in table 6.2.3.16.3.1-2 and the response data structures and response codes specified in table 6.2.3.16.3.1-3. + +**Table 6.2.3.16.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.16.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| CsLocation | M | 1 | 200 OK | A response body containing the CS location information as requested shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND

DATA_NOT_FOUND indicates that the location information is unknown or unavailable. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.16.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.16.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.17 Resource: SRVCC data + +### 6.2.3.17.1 Description + +This resource represents the SRVCC data. It is queried by the service consumer (e.g. AS) to retrieve the UE SRVCC capability and the STN-SR for the user. + +### 6.2.3.17.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/srvcc-data + +This resource shall support the resource URI variables defined in table 6.2.3.17.2-1. + +**Table 6.2.3.17.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity) or the IMS private Identity. If both the IMS Public Identity and the IMS Private Identity are available at the service consumer, the imsUeId represents the IMS Public Identity.

pattern: "^(impu-sip:\{[a-zA-Z0-9_-\.!~*()&=+\$_;?V]+\}@([A-Za-z0-9]+\-[A-Za-z0-9]+\.[a-z]{2,} impu-tel:\+[0-9]{5,15} impi-\.[\.]+\+))\$" | + +## 6.2.3.17.3 Resource Standard Methods + +### 6.2.3.17.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.17.3.1-1. + +**Table 6.2.3.17.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | | +| private-identity | PrivateId | C | 0..1 | Represents the IMS Private Identity. Shall be present if the imsUeId variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities. | | + +This method shall support the request data structures specified in table 6.2.3.17.3.1-2 and the response data structures and response codes specified in table 6.2.3.17.3.1-3. + +**Table 6.2.3.17.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.17.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SrvccData | M | 1 | 200 OK | A response body containing the STN-SR and the UE SRVCC capabilities for the user shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND

DATA_NOT_FOUND indicates that the user is not subscribed to SRVCC. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.17.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.17.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +### 6.2.3.17.3.2 PATCH + +This method shall support the URI query parameters specified in table 6.2.3.17.3.2-1. + +**Table 6.2.3.17.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | +| private-identity | PrivateId | C | 0..1 | Represents the IMS Private Identity. Shall be present if the imsUeId variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities. | + +This method shall support the request data structures specified in table 6.2.3.17.3.2-2 and the response data structures and response codes specified in table 6.2.3.17.3.2-3. + +**Table 6.2.3.17.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| array(PatchItem) | M | 1..N | Items describe the modifications to the SRVCC data.
Modification are not applicable to UE SRVCC capabilities. | + +**Table 6.2.3.17.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. (NOTE 1) | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. (NOTE 1) | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND

DATA_NOT_FOUND indicates that the user is not subscribed to SRVCC. | +| ProblemDetails | O | 0..1 | 403 Forbidden | One or more attributes are not allowed to be modified.

The "cause" attribute may be used to indicate one of the following application errors:
- MODIFICATION_NOT_ALLOWED, see GPP TS 29.500 [4] table 5.2.7.2-1.
- OPERATION_NOT_ALLOWED | + +NOTE 1: If all the modification instructions in the PATCH request have been implemented, the HSS shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the HSS shall respond with PatchResult. + +**Table 6.2.3.17.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.17.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.18 Resource: PSI activation state + +### 6.2.3.18.1 Description + +This resource represents the PSI activation state. It is queried by the service consumer (e.g. AS) to retrieve the activation state for the IMS Public Service Identity. + +### 6.2.3.18.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/psi-status + +This resource shall support the resource URI variables defined in table 6.2.3.18.2-1. + +**Table 6.2.3.18.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUId | Represents the IMS Public Service Identity

pattern: "^(impu-sip:([a-zA-Z0-9_\-\.!~*()\&=+\$;,?V]+)@([A-Za-z0-9]+\-[A-Za-z0-9]+\+\. \+)[a-z]{2,} impu-tel:\+[0-9]{5,15} impi-.* .+)\$" | + +### 6.2.3.18.3 Resource Standard Methods + +#### 6.2.3.18.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.18.3.1-1. + +**Table 6.2.3.18.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------|---|-------------|-----------------------------------|---------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | | + +This method shall support the request data structures specified in table 6.2.3.18.3.1-2 and the response data structures and response codes specified in table 6.2.3.18.3.1-3. + +**Table 6.2.3.18.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.18.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| PsiActivationState | M | 1 | 200 OK | A response body containing the PSI activation state shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- SERVICE_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.18.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.18.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +### 6.2.3.18.3.2 PATCH + +This method shall support the URI query parameters specified in table 6.2.3.18.3.2-1. + +**Table 6.2.3.18.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| Supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +This method shall support the request data structures specified in table 6.2.3.18.3.2-2 and the response data structures and response codes specified in table 6.2.3.18.3.2-3. + +**Table 6.2.3.18.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|---------------------------------------------------------------| +| array(PatchItem) | M | 1..N | Items describe the modifications to the PSI activation state. | + +**Table 6.2.3.18.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. (NOTE 1) | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. (NOTE 1) | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- SERVICE_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | One or more attributes are not allowed to be modified.

The "cause" attribute may be used to indicate one of the following application errors:
- MODIFICATION_NOT_ALLOWED, see GPP TS 29.500 [4] table 5.2.7.2-1.
- OPERATION_NOT_ALLOWED | + +NOTE 1: If all the modification instructions in the PATCH request have been implemented, the HSS shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the HSS shall respond with PatchResult. + +**Table 6.2.3.18.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.18.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.19 Resource: Repository Data + +### 6.2.3.19.1 Description + +This resource represents the Repository Data. It is used by the service consumer (e.g. IMS-AS) to create, retrieve, update or delete the repository data for a given service indication. + +### 6.2.3.19.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/repository-data/{serviceIndication} + +This resource shall support the resource URI variables defined in table 6.2.3.19.2-1. + +**Table 6.2.3.19.2-1: Resource URI variables for this resource** + +| Name | Definition | +|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)
pattern: " ^ (impu-sip:\{[a-zA-Z0-9_-\.!~*()&=+\$,;?V]+\})@[([A-Za-z0-9]+\-[A-Za-z0-9]+\+\.]+\+)[a-z]{2,}\+impur-tel:\+{0-9}{5,15}\+impi-\+\.+\+)" | +| serviceIndication | Represents the identifier of a service related data. | + +### 6.2.3.19.3 Resource Standard Methods + +#### 6.2.3.19.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.19.3.1-1. + +**Table 6.2.3.19.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +This method shall support the request data structures specified in table 6.2.3.19.3.1-2 and the response data structures and response codes specified in table 6.2.3.19.3.1-3. + +**Table 6.2.3.19.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.19.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| RepositoryData | M | 1 | 200 OK | A response body containing the Repository Data for the requested Service Indication. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.19.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.19.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +### 6.2.3.19.3.2 PUT + +This method shall support the URI query parameters specified in table 6.2.3.19.3.2-1. + +**Table 6.2.3.19.3.2-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.2.3.19.3.2-2 and the response data structures and response codes specified in table 6.2.3.19.3.2-3. + +**Table 6.2.3.19.3.2-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------|---|-------------|------------------------------------------------| +| RepositoryData | M | 1 | The Repository Data to be created or replaced. | + +**Table 6.2.3.19.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|---------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| RepositoryData | M | 1 | 201
Created | Upon success, a response body containing a representation of the created Individual RepositoryData resource shall be returned. | +| RepositoryData | M | 1 | 200 OK | Upon success, a response body containing a representation of the updated Individual RepositoryData resource shall be returned. | +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- USER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | +| ProblemDetails | O | 0..1 | 409 Conflict | The "cause" attribute may be used to indicate the following application error:
- OUT_OF_SYNC | +| ProblemDetails | O | 0..1 | 413
Payload Too Large | The "cause" attribute may be used to indicate the following application error:
- TOO_MUCH_DATA | + +**Table 6.2.3.19.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.19.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +### 6.2.3.19.3.3 DELETE + +This method shall support the URI query parameters specified in table 6.2.3.19.3.3-1. + +**Table 6.2.3.19.3.3-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.2.3.19.3.3-2 and the response data structures and response codes specified in table 6.2.3.19.3.3-3. + +**Table 6.2.3.19.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|----------------------------------| +| n/a | | | The request body shall be empty. | + +**Table 6.2.3.19.3.3-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND

DATA_NOT_FOUND indicates that no repository data exists for the requested service indication. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.19.3.3-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.19.3.3-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.20 Resource: SharedData + +### 6.2.3.20.1 Description + +This resource represents the collection of data that can be shared by multiple UEs. + +### 6.2.3.20.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm//shared-data + +This resource shall support the resource URI variables defined in table 6.2.3.20.2-1. + +**Table 6.2.3.20.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | + +## 6.2.3.20.3 Resource Standard Methods + +### 6.2.3.20.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.20.3.1-1. + +**Table 6.2.3.20.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------|---------------------|---|-------------|-------------| +| shared-data-ids | array(SharedDataId) | M | 1..N | | + +This method shall support the request data structures specified in table 6.2.3.20.3.1-2 and the response data structures and response codes specified in table 6.2.3.20.3.1-3. + +**Table 6.2.3.20.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.20.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| array(SharedData) | M | 1..N | 200 OK | Upon success, a response body containing a list of SharedData shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- DATA_NOT_FOUND | + +**Table 6.2.3.20.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.20.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.21 Resource: ImeiSvInformation + +### 6.2.3.21.1 Description + +This resource represents the IMEI(SV) information. It is queried by the service consumer (e.g. IMS AS) to retrieve the IMEI(SV) for the user. + +### 6.2.3.21.2 Resource Definition + +Resource URI: **{apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/identities/imeisv** + +This resource shall support the resource URI variables defined in table 6.2.3.21.2-1. + +**Table 6.2.3.21.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId |

Represents the IMS Public Identity (i.e. IMS Public User identity) or the IMS Private Identity. If both the IMS Public Identity and the IMS Private Identity are available at the service consumer, the imsUeId represents the IMS Public Identity.

pattern: "^(impu-sip:([a-zA-Z0-9_\-.!~*'()&=+\$,;?V]+)@([A-Za-z0-9]+([-A-Za-z0-9]+)*\.)+[a-z]{2,} impu-tel:\+[0-9]{5,15} impi-.+)\$"

| + +### 6.2.3.21.3 Resource Standard Methods + +#### 6.2.3.21.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.21.3.1-1. + +**Table 6.2.3.21.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | | +| private-identity | PrivateId | C | 0..1 | Represents the IMS Private Identity. Shall be present if the imsUeId variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities. | | + +This method shall support the request data structures specified in table 6.2.3.21.3.1-2 and the response data structures and response codes specified in table 6.2.3.21.3.1-3. + +**Table 6.2.3.21.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.21.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinali
y | Response codes | Description | +|-------------------|---|----------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ImeiSvInformation | M | 1 | 200 OK | A response body containing the IMEI(SV) information for the user shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.21.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.21.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +### 6.2.3.22 Resource: IP Address + +#### 6.2.3.22.1 Description + +This resource represents the IP Address Information. It is queried by the service consumer (e.g. SCC-AS) to retrieve the IP Address Information for the user. + +#### 6.2.3.22.2 Resource Definition + +Resource URI: **{apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/access-data/ps-domain/ip-address** + +This resource shall support the resource URI variables defined in table 6.2.3.22.2-1. + +**Table 6.2.3.22.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId |

Represents the IMS Public Identity (i.e. non-shared IMS Public User identity) or the IMS Private Identity.

pattern: "^(impu-sip:\([a-zA-Z0-9_\-.!~*()&=+\$,;?V]+\))@([A-Za-z0-9]+([-A-Za-z0-9+])*\.)+[a-z]{2,} impu-tel:\+[0-9]{5,15} impi-.+@.+\$"

| + +## 6.2.3.22.3 Resource Standard Methods + +### 6.2.3.22.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.22.3.1-1. + +**Table 6.2.3.22.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------|---|-------------|-----------------------------------|---------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | | + +This method shall support the request data structures specified in table 6.2.3.22.3.1-2 and the response data structures and response codes specified in table 6.2.3.22.3.1-3. + +**Table 6.2.3.22.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.22.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| IpAddress | M | 1 | 200 OK | A response body containing the IP address (IPv4, IPv6, IPv6 prefix and/or IPv6 interface identifier) for the user shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND

DATA_NOT_FOUND indicates that no IP Address is currently allocated for the user. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.22.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.22.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.23 Resource: T-ADS Info + +### 6.2.3.23.1 Description + +This resource represents the T-ADS Information. It is queried by the service consumer (e.g. SCC-AS) to retrieve the T-ADS Information for the user. + +### 6.2.3.23.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/access-data/ps-domain/tads-info + +This resource shall support the resource URI variables defined in table 6.2.3.23.2-1. + +**Table 6.2.3.23.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity) or the IMS Private Identity. If both the IMS Public Identity and the IMS Private Identity are available at the service consumer, the imsUeId represents the IMS Public Identity.

pattern: "^(impu-sip:\{[a-zA-Z0-9 \-\.!~*()&=+\$,;?:V]+\}@([A-Za-z0-9]+([A-Za-z0-9]+\.)+[a-z]{2,} impu-tel:\+[0-9]{5,15} impi-\+\.+\+))\$" | + +### 6.2.3.23.3 Resource Standard Methods + +#### 6.2.3.23.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.23.3.1-1. + +**Table 6.2.3.23.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | | +| private-identity | Privateld | C | 0..1 | Represents the IMS Private Identity. Shall be present if the imsUeId variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities. | | + +This method shall support the request data structures specified in table 6.2.3.23.3.1-2 and the response data structures and response codes specified in table 6.2.3.23.3.1-3. + +**Table 6.2.3.23.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.23.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| TadsInformation | M | 1 | 200 OK | A response body containing the T-ADS information (most recent VoPS support) for the user shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.23.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.23.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.24 Resource: UeReachabilitySubscriptions + +### 6.2.3.24 Description + +This resource is used to represent subscriptions to notifications of UE Reachability for IP. + +### 6.2.3.24.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/access-data/ps-domain/ue-reach-subscriptions + +This resource shall support the resource URI variables defined in table 6.2.3.24.2-1. + +**Table 6.2.3.24.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)

pattern: "^(impu-sip:\{[a-zA-Z0-9_-\.!~*()&=+\$_;?V]+\}@\{[A-Za-z0-9]+\{[A-Za-z0-9]+\}+\.[a-z]{2,}\} impu-tel:\{[0-9]{5,15}\} impi-\{+\.[+\}+\}+\)" | + +### 6.2.3.24.3 Resource Standard Methods + +#### 6.2.3.24.3.1 POST + +This method shall support the URI query parameters specified in table 6.2.3.24.3.1-1. + +**Table 6.2.3.24.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| private-identity | Privateld | C | 0..1 | Represents the IMS Private Identity.
Shall be present if the imsUeld variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities. | + +This method shall support the request data structures specified in table 6.2.3.24.3.1-2 and the response data structures and response codes specified in table 6.2.3.24.3.1-3. + +**Table 6.2.3.24.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------------|---|-------------|-------------------------------------------------------------------| +| UeReachabilitySubscription | M | 1 | The subscription to UE reachability for IP that is to be created. | + +**Table 6.2.3.24.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------|---|-------------|---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| CreatedUeReachabilitySubscription | M | 1 | 201
Created | Upon success, a response body containing a representation of the created Individual subscription resource shall be returned.

The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- USER_NOT_FOUND | + +**Table 6.2.3.24.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.24.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +#### 6.2.3.25 Resource: UE reachability Individual subscription + +### 6.2.3.25.1 Description + +This resource is used to represent an individual subscription to notification of UE reachability for IP. + +### 6.2.3.25.2 Resource Definition + +Resource URI: **{apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/access-data/ps-domain/ue-reach-subscriptions/{subscriptionId}** + +This resource shall support the resource URI variables defined in table 6.2.3.25.2-1. + +**Table 6.2.3.25.2-1: Resource URI variables for this resource** + +| Name | Definition | +|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)

pattern: "^((impu-sip:([a-zA-Z0-9_\-.!~*'()&=+\$,;?%\/]+)@([A-Za-z0-9]+([-A-Za-z0-9+]*[A-Za-z0-9]+)\.)+[a-z]{2,}) (impu-tel:\+[0-9]{5,15}) (impi-.+) .+)\$" | +| subscriptionId | The subscriptionId identifies an individual subscription to notification of UE reachability for IP. | + +### 6.2.3.25.3 Resource Standard Methods + +#### 6.2.3.25.3.1 DELETE + +This method shall support the URI query parameters specified in table 6.2.3.25.3.1-1. + +**Table 6.2.3.25.3.1-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| private-identity | PrivateId | C | 0..1 | Represents the IMS Private Identity.
Shall be present if the imsUeId variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities. | + +This method shall support the request data structures specified in table 6.2.3.25.3.1-2 and the response data structures and response codes specified in table 6.2.3.25.3.1-3. + +**Table 6.2.3.25.3.1-2: Data structures supported by the Delete Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|----------------------------------| +| n/a | | | The request body shall be empty. | + +**Table 6.2.3.25.3.1-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- SUBSCRIPTION_NOT_FOUND, see 3GPP TS 29.500 [4] table 5.2.7.2-1. | + +**Table 6.2.3.25.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.25.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +### 6.2.3.25.3.2 PATCH + +This method shall support the URI query parameters specified in table 6.2.3.25.3.2-1. + +**Table 6.2.3.25.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| private-identity | Privateld | C | 0..1 | Represents the IMS Private Identity.
Shall be present if the imsUeId variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities. | + +This method shall support the request data structures specified in table 6.2.3.25.3.2-2 and the response data structures and response codes specified in table 6.2.3.25.3.2-3. + +**Table 6.2.3.25.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| array(PatchItem) | M | 1 | It contains the list of changes to be made to the resource representing the individual subscription, according to the JSON PATCH format specified in IETF RFC 6902 [12]. | + +**Table 6.2.3.25.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, a response with no content is returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- SUBSCRIPTION_NOT_FOUND, see 3GPP TS 29.500 [4] table 5.2.7.2-1. | +| ProblemDetails | O | 0..1 | 403 Forbidden | One or more attributes are not allowed to be modified.

The "cause" attribute may be used to indicate the following application error:
- MODIFICATION_NOT_ALLOWED, see 3GPP TS 29.500 [4] table 5.2.7.2-1. | + +**Table 6.2.3.25.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.25.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.26 Resource: PS User State + +### 6.2.3.26.1 Description + +This resource represents the User State information in PS domain. It is queried by the service consumer (e.g. AS) to retrieve the User State information in PS domain as retrieved from the serving node(s). The service consumer may indicate the requested nodes for which the request is applicable (e.g. AMF only) + +### 6.2.3.26.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/access-data/ps-domain/user-state + +This resource shall support the resource URI variables defined in table 6.2.3.26.2-1. + +**Table 6.2.3.26.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity) or the IMS private Identity. If both the IMS Public Identity and the IMS Private Identity are available at the service consumer, the imsUId represents the IMS Public Identity.

pattern: "^(impu-sip:\{[a-zA-Z0-9_-\.!~*()&=+\$,;?V]+\}@([A-Za-z0-9]+\{[-A-Za-z0-9]+\}\.)+[a-z]{2,} impu-tel:\{+[0-9]{5,15} impi-\{+\}\.+\}+\$)" | + +## 6.2.3.26.3 Resource Standard Methods + +### 6.2.3.26.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.26.3.1-1. + +**Table 6.2.3.26.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|----------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| requested-nodes | array(RequestedNode) | O | 1..N | Indicates the serving node(s) for which the request is applicable. | +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | +| private-identity | PrivateId | C | 0..1 | Represents the IMS Private Identity. Shall be present if the imsUId variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities. | + +If "requested-nodes" is not included, HSS shall return the user state as retrieved from all the nodes (AMF, MME and SGSN) + +This method shall support the request data structures specified in table 6.2.3.26.3.1-2 and the response data structures and response codes specified in table 6.2.3.26.3.1-3. + +**Table 6.2.3.26.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.26.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| PsUserState | M | 1 | 200 OK | A response body containing the PS user state information as requested shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND

DATA_NOT_FOUND indicates that the user state information is unknown or unavailable. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.26.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.26.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.27 Resource: CS User State + +### 6.2.3.27.1 Description + +This resource represents the User State information in CS domain. It is queried by the service consumer (e.g. AS) to retrieve the User State information in CS domain as retrieved from the MSC/VLR. + +### 6.2.3.27.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/access-data/cs-domain/user-state + +This resource shall support the resource URI variables defined in table 6.2.3.27.2-1. + +**Table 6.2.3.27.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUId |

Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity) or the IMS private Identity. If both the IMS Public Identity and the IMS Private Identity are available at the service consumer, the imsUId represents the IMS Public Identity.

pattern: "^(impu-sip:([a-zA-Z0-9_\-.!~*'()&=+\$,;?V]+)@([A-Za-z0-9]+([-A-Za-z0-9]+)*\.)+[a-z]{2,} impu-tel:\+[0-9]{5,15} impi-.+ .+)\$"

| + +### 6.2.3.27.3 Resource Standard Methods + +#### 6.2.3.27.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.27.3.1-1. + +**Table 6.2.3.27.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | +| private-identity | PrivateId | C | 0..1 | Represents the IMS Private Identity. Shall be present if the imsUId variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities. | + +This method shall support the request data structures specified in table 6.2.3.27.3.1-2 and the response data structures and response codes specified in table 6.2.3.27.3.1-3. + +**Table 6.2.3.27.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.27.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| CsUserState | M | 1 | 200 OK | A response body containing the CS user state information as requested shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.27.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.27.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**6.2.3.28      Resource: Csrn** + +### 6.2.3.28.1 Description + +This resource represents the CSRN. It is queried by the service consumer (e.g. SCC-AS) to retrieve a CSRN for the user. + +### 6.2.3.28.2 Resource Definition + +Resource URI: **{apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/access-data/cs-domain/csrn** + +This resource shall support the resource URI variables defined in table 6.2.3.28.2-1. + +**Table 6.2.3.28.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity) or the IMS Private Identity. If both the IMS Public Identity and the IMS Private Identity are available at the service consumer, the imsUeId represents the IMS Public Identity.

pattern: "^(impu-sip\:([a-zA-Z0-9_\-\.\!\~\*'()&=+\\$,;?\/]+)@([a-zA-Z0-9\-]+([\-a-zA-Z0-9\.]+)*\.[a-z]{2,} impu-tel\:\+[0-9]{5,15} impi-.+ .+)\$" | + +### 6.2.3.28.3 Resource Standard Methods + +#### 6.2.3.28.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.28.3.1-1. + +**Table 6.2.3.28.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|---------------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | | +| pre-paging | PrePaging | O | 0..1 | Indicates if pre-paging is supported

true: pre-paging is supported
false or absent: pre-paging is not supported | | +| private-identity | PrivateId | C | 0..1 | Represents the IMS Private Identity.
Shall be present if the imsUId variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities. | | +| call-reference-info | CallReferenceInfo | O | 0..1 | Contains a Call Reference Number and the AS-Number. It allows a later retry of the call setup in the context of MTRR.
See 3GPP TS 29.328 [38] | | + +This method shall support the request data structures specified in table 6.2.3.28.3.1-2 and the response data structures and response codes specified in table 6.2.3.28.3.1-3. + +**Table 6.2.3.28.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.28.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Csrn | M | 1 | 200 OK | A response body containing the CSRN for the user shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND

DATA_NOT_FOUND indicates that CSRN retrieval from MSC/VLR failed. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.28.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.28.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.29 Resource: ReferenceAccessLocation + +### 6.2.3.29.1 Description + +This resource represents the Reference Location Information. It is queried by the service consumer (e.g. IMS-AS) to retrieve the reference location information for the user (e.g. line identifier in fixed access networks). + +### 6.2.3.29.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/access-data/wireline-domain/reference-location + +This resource shall support the resource URI variables defined in table 6.2.3.29.2-1. + +**Table 6.2.3.29.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity) or the IMS Private Identity. If both the IMS Public Identity and the IMS Private Identity are available at the service consumer, the imsUeId represents the IMS Public Identity.

pattern: "^(impu-sip:\{[a-zA-Z0-9_\-\.!~*()&=+\$\;,?V]+\}@([A-Za-z0-9]+\-[A-Za-z0-9]+\.[a-z]{2,} impu-tel:\+[0-9]{5,15} impi\-[\.+\-]+\.[a-z]{2,} impitel:\+[0-9]{5,15} impi\-[\.+\-]+\.[a-z]{2,} )" | + +### 6.2.3.29.3 Resource Standard Methods + +#### 6.2.3.29.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.29.3.1-1. + +**Table 6.2.3.29.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | | +| private-identity | PrivateId | C | 0..1 | Represents the IMS Private Identity. Shall be present if the imsUeId variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities. | | + +This method shall support the request data structures specified in table 6.2.3.29.3.1-2 and the response data structures and response codes specified in table 6.2.3.29.3.1-3. + +**Table 6.2.3.29.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.29.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ReferenceLocationInformation | M | 1 | 200 OK | A response body containing the reference location information (e.g. access type, line identifier) for the user shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND

DATA_NOT_FOUND indicates that no reference location information exist for the user. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.29.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.29.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.30 Resource: SMSRegistrationInfo + +### 6.2.3.30.1 Description + +This resource represents the SMS registration information. It is used by the service consumer (e.g. IP-SM-GW) to create, retrieve, update or delete the SMS registration information. + +### 6.2.3.30.2 Resource Definition + +Resource URI: **{apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/service-data/sms-registration-info** + +This resource shall support the resource URI variables defined in table 6.2.3.30.2-1. + +**Table 6.2.3.30.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity) or the IMS private Identity. If both the IMS Public Identity and the IMS Private Identity are available at the service consumer, the imsUeId represents the IMS Public Identity.

pattern: "^(impu-sip:([a-zA-Z0-9_\-.!~*'()&=+\$,;?V]+)@([A-Za-z0-9]+([-A-Za-z0-9]+\.)+)[a-z]{2,} impu-tel:\+[0-9]{5,15} impi-.+)\$" | + +### 6.2.3.30.3 Resource Standard Methods + +#### 6.2.3.30.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.30.3.1-1. + +**Table 6.2.3.30.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | +| private-identity | PrivateId | C | 0..1 | Represents the IMS Private Identity. Shall be present if the imsUeId variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities. | + +This method shall support the request data structures specified in table 6.2.3.30.3.1-2 and the response data structures and response codes specified in table 6.2.3.30.3.1-3. + +**Table 6.2.3.30.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.30.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------|---|-------------|---------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SmsRegistrationInfo | M | 1 | 200 OK | A response body containing the SMS registration information. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- USER_NOT_FOUND
- DATA_NOT_FOUND

DATA_NOT_FOUND indicates that no IP-SM-GW number is preconfigured or created previously for the user. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.30.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.30.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +### 6.2.3.30.3.2 PUT + +This method shall support the URI query parameters specified in table 6.2.3.30.3.2-1. + +**Table 6.2.3.30.3.2-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| private-identity | Privateld | C | 0..1 | Represents the IMS Private Identity. Shall be present if the imsUeId variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities. | + +This method shall support the request data structures specified in table 6.2.3.30.3.2-2 and the response data structures and response codes specified in table 6.2.3.30.3.2-3. + +**Table 6.2.3.30.3.2-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------|---|-------------|-------------------------------------------------------------| +| lpSmGwAddress | M | 1 | The SMS Registration Information to be created or replaced. | + +**Table 6.2.3.30.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------|---|-------------|---------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SmsRegistrationInfo | M | 1 | 201
Created | Upon success, a response body containing a representation of the created Individual RepositoryData resource shall be returned. | +| SmsRegistrationInfo | M | 1 | 200 OK | Upon success, a response body containing a representation of the updated Individual RepositoryData resource shall be returned. | +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- USER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | +| ProblemDetails | O | 0..1 | 409 Conflict | The "cause" attribute may be used to indicate the following application error:
- IP_SM_GW_CANNOT_BE_MODIFIED | + +**Table 6.2.3.30.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.30.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +### 6.2.3.30.3.3 DELETE + +This method shall support the URI query parameters specified in table 6.2.3.30.3.3-1. + +**Table 6.2.3.30.3.3-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| private-identity | Privateld | C | 0..1 | Represents the IMS Private Identity. Shall be present if the imsUeld variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities. | + +This method shall support the request data structures specified in table 6.2.3.30.3.3-2 and the response data structures and response codes specified in table 6.2.3.30.3.3-3. + +**Table 6.2.3.30.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|----------------------------------| +| n/a | | | The request body shall be empty. | + +**Table 6.2.3.30.3.3-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND

DATA_NOT_FOUND indicates that no SMS registration information exists for the user. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | +| ProblemDetails | O | 0..1 | 409 Conflict | The "cause" attribute may be used to indicate the following application error:
- IP_SM_GW_CANNOT_BE_MODIFIED | + +**Table 6.2.3.30.3.3-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.30.3.3-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.31 Resource: Dsai + +### 6.2.3.31.1 Description + +This resource represents the DSAI Tag Information for the requested Application Server Name. It is used by the service consumer (e.g. IMS-AS) to retrieve or update the DSAI Tag Status. + +### 6.2.3.31.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/service-data/dsai + +This resource shall support the resource URI variables defined in table 6.2.3.31.2-1. + +**Table 6.2.3.31.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. non-shared IMS Public User identity) or the IMS private Identity.

pattern: " ^ (impu-sip:\{[a-zA-Z0-9_-\.!~*()&=+\$_;?V]+\})@([A-Za-z0-9]+\-[A-Za-z0-9]+\.[a-z]{2,} impu-tel:\+[0-9]{5,15} impi-\.[a-z]+\.[a-z]{2,} impi-tel:\+[0-9]{5,15} impi-\.[a-z]+\.[a-z]{2,} )" | + +## 6.2.3.31.3 Resource Standard Methods + +### 6.2.3.31.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.31.3.1-1. + +**Table 6.2.3.31.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------| +| application-server-name | SipServerName | M | 1 | The requested Application Server Name. | +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | +| dsai-tag | string | O | 0..1 | This information element identify the requested instance of Dynamic Service Activation Info (DSAI). | + +This method shall support the request data structures specified in table 6.2.3.31.3.1-2 and the response data structures and response codes specified in table 6.2.3.31.3.1-3. + +**Table 6.2.3.31.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.31.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| DsaiTagInformation | M | 1 | 200 OK | A response body containing the DSAI information for the requested Application Server. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND

DATA_NOT_FOUND indicates that no DSAI Tag was found for the requested Application Server. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.31.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.31.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +### 6.2.3.31.3.2 PATCH + +This method shall support the URI query parameters specified in table 6.2.3.31.3.2-1. + +**Table 6.2.3.31.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| Supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +This method shall support the request data structures specified in table 6.2.3.31.3.2-2 and the response data structures and response codes specified in table 6.2.3.31.3.2-3. + +**Table 6.2.3.31.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|-----------------------------------------------------------------------| +| array(PatchItem) | M | 1..N | Items describe the modifications to the DSAI tag(s) activation state. | + +**Table 6.2.3.31.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. (NOTE 1) | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. (NOTE 1) | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- DSAI_TAG_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | One or more attributes are not allowed to be modified.

The "cause" attribute may be used to indicate one of the following application errors:
- MODIFICATION_NOT_ALLOWED, see GPP TS 29.500 [4] table 5.2.7.2-1.
- OPERATION_NOT_ALLOWED | + +NOTE 1: If all the modification instructions in the PATCH request have been implemented, the HSS shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the HSS shall respond with PatchResult. + +**Table 6.2.3.31.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.31.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.32 Resource: Private Identities + +### 6.2.3.32.1 Description + +This resource represents the private identities. It is queried by the service consumer (IMS-AS) to retrieve the list of private identities. + +### 6.2.3.32.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/identities/private-identities + +This resource shall support the resource URI variables defined in table 6.2.3.32.2-1. + +**Table 6.2.3.32.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)

pattern: "^(impu-sip:([a-zA-Z0-9_\-.!~*()&=+\$;,?V]+)@([A-Za-z0-9]+([\-A-Za-z0-9]+)*\.)+[a-z]{2,} impu-tel:\+[0-9]{5,15} impi-.+ .+)\$" | + +### 6.2.3.32.3 Resource Standard Methods + +6.2.3.32.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.32.3.1-1. + +**Table 6.2.3.32.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------|---|-------------|-----------------------------------|---------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | | +| impi | PrivateId | O | 0..1 | Private Identity of type IMPI | | + +This method shall support the request data structures specified in table 6.2.3.32.3.1-2 and the response data structures and response codes specified in table 6.2.3.32.3.1-3. + +**Table 6.2.3.32.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.32.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| PrivateIdentities | M | 1 | 200 OK | A response body containing the list of private identities belonging to the IMS UE. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- USER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.32.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.32.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +### 6.2.3.33 Resource: S-CSCF Selection Assistance Information + +#### 6.2.3.33.1 Description + +This resource represents the S-CSCF selection assistance information. It is queried by the service consumer (I-CSCF) before S-CSCF selection. + +#### 6.2.3.33.2 Resource Definition + +Resource URI: **{apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/ims-data/location-data/scscf-selection-assistance-info** + +This resource shall support the resource URI variables defined in table 6.2.3.33.2-1. + +**Table 6.2.3.33.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUeId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)

pattern: "^(impu-sip:([a-zA-Z0-9_\-.!~*()&=+\$,:;?V]+)@([A-Za-z0-9]+([-A-Za-z0-9]+)*\.)+[a-z]{2,} impu-tel:\+[0-9]{5,15} impi-.+).+\$" | + +#### 6.2.3.33.3 Resource Standard Methods + +##### 6.2.3.33.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.33.3.1-1. + +**Table 6.2.3.33.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.2.3.33.3.1-2 and the response data structures and response codes specified in table 6.2.3.33.3.1-3. + +**Table 6.2.3.33.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.33.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ScscfSelectionAssistanceInformation | M | 1 | 200 OK | A response body containing the S-CSCF Selection Assistance Information. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND

NOTE: DATA_NOT_FOUND indicates that any S-CSCF can be selected, e.g. based on I-CSCF local policy. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +**Table 6.2.3.33.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.33.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.3.34 Resource: Charging Information + +### 6.2.3.34.1 Description + +This resource represents the Charging Information. It is queried by the service consumer (e.g. AS) to retrieve the Diameter addresses Charging Functions for the user. + +### 6.2.3.34.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/ims-data/profile-data/charging-info + +This resource shall support the resource URI variables defined in table 6.2.3.34.2-1. + +**Table 6.2.3.34.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| imsUId | Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)

pattern: "^(impu-sip:([a-zA-Z0-9_\-.!~*()&=+\$;,?V]+)@([A-Za-z0-9]+([-A-Za-z0-9]+)*\.)+[a-z]{2,} impu-tel:\+[0-9]{5,15} impi-.+ .+)\$" | + +### 6.2.3.34.3 Resource Standard Methods + +#### 6.2.3.34.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.34.3.1-1. + +**Table 6.2.3.34.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------|---|-------------|-----------------------------------|---------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | | + +This method shall support the request data structures specified in table 6.2.3.34.3.1-2 and the response data structures and response codes specified in table 6.2.3.34.3.1-3. + +**Table 6.2.3.34.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.34.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------| +| ChargingInfo | M | 1 | 200 OK | A response body containing the Charging Information for the user shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application error:
- OPERATION_NOT_ALLOWED | + +## 6.2.5 Notifications + +### 6.2.5.1 General + +This clause specifies the use of notifications and corresponding protocol details. + +### 6.2.5.2 Data Change Notification + +The POST method shall be used for Data Change Notifications and the URI shall be as provided during the subscription procedure. + +Resource URI: {callbackReference} + +Support of URI query parameters is specified in table 6.2.5.2-1. + +**Table 6.2.5.2-1: URI query parameters supported by the POST method** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +Support of request data structures is specified in table 6.2.5.2-2 and of response data structures and response codes is specified in table 6.2.5.2-3. + +**Table 6.2.5.2-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|--------------------------|---|-------------|-------------| +| ModificationNotification | M | 1 | | + +**Table 6.2.5.2-3: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the notification endpoint of the subscribing NF Service Consumer. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the notification endpoint of the subscribing NF Service Consumer. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- CONTEXT_NOT_FOUND

See table 6.2.7.3-1 for the description of this error. | + +**Table 6.2.5.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the notification endpoint of the subscribing NF. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.5.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the notification endpoint of the subscribing NF. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.2.6 Data Model + +### 6.2.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.2.6.1-1 specifies the data types defined for the Nhss\_imsSDM service API. + +**Table 6.2.6.1-1: Nhss\_imsSDM specific Data Types** + +| Data type | Clause defined | Description | +|-------------------------------------|-----------------------|--------------------------------------------------------------------------------------------------------------------------| +| ScscfCapabilityList | 6.2.6.2.2 | Information about mandatory and optional S-CSCF capabilities | +| ImsProfileData | 6.2.6.2.4 | User's IMS profile data | +| RepositoryData | 6.2.6.2.7 | Repository Data for the requested Service Indication | +| MsisdnList | 6.2.6.2.8 | List of MSISDNs associated to the IMS public Identity | +| PublicIdentities | 6.2.6.2.9 | IMS Public Identities which belong to the same Implicit Registration Set (if any) than the requested IMS Public Identity | +| PublicIdentity | 6.2.6.2.10 | IMS Public Identity and the related data (Alias Group Id, IRS default indication, Identity Type) | +| ImsSdmSubscription | 6.2.6.2.11 | A subscription to notifications of data change | +| ImsRegistrationStatus | 6.2.6.2.12 | Registration status of the user. | +| PriorityLevels | 6.2.6.2.13 | Namespaces and priority levels allowed for the IMS public Identity. | +| Ifcs | 6.2.6.2.14 | List of IFCs associated to the IMS public Identity | +| Ifc | 6.2.6.2.15 | | +| TriggerPoint | 6.2.6.2.16 | | +| Spt | 6.2.6.2.17 | | +| HeaderSipRequest | 6.2.6.2.18 | | +| SdpDescription | 6.2.6.2.19 | | +| ApplicationServer | 6.2.6.2.20 | | +| ImsLocationData | 6.2.6.2.21 | IMS Location Data (S_CSCF name) | +| ServiceLevelTraceInformation | 6.2.6.2.22 | IMS Service Level Trace Information | +| PsLocation | 6.2.6.2.23 | Location data in PS domain. | +| SgsnLocationData | 6.2.6.2.24 | | +| MmeLocationData | 6.2.6.2.25 | | +| AmfLocationData | 6.2.6.2.26 | | +| TwanLocationData | 6.2.6.2.27 | | +| CsLocation | 6.2.6.2.28 | Location data in CS domain. | +| CsglInformation | 6.2.6.2.29 | | +| SrvccData | 6.2.6.2.30 | UE SRVCC capability (if available) and STN-SR (if subscribed) | +| PsiActivationState | 6.2.6.2.31 | Public Service Identity activation state | +| ImeiSvInformation | 6.2.6.2.34 | IMEI(SV) information | +| IpAddress | 6.2.6.2.35 | IPv4 address, IPv6 address or IPv6 prefix and/or IPv6 interface identifier | +| TadsInformation | 6.2.6.2.36 | T-ADS Information | +| UeReachabilitySubscription | 6.2.6.2.37 | A subscription to notifications of UE reachability for IP. | +| UeReachabilityNotification | 6.2.6.2.38 | A notification of UE reachability for IP. | +| PsUserState | 6.2.6.2.39 | User state in PS domain | +| CsUserState | 6.2.6.2.40 | User state in CS domain | +| Csm | 6.2.6.2.41 | CS domain routeing number | +| ReferenceLocationInformation | 6.2.6.2.42 | Reference Location Information for the user in fixed access networks. | +| SmsRegistrationInfo | 6.2.6.2.43 | SMS Registration Information (IP-SM-GW number and SC address) | +| IpSmGwAddress | 6.2.6.2.44 | IP-SM-GW number and diameter URI/realm | +| ImsAssociatedIdentities | 6.2.6.2.45 | | +| DsaiTagInformation | 6.2.6.2.46 | DSAI tag information (list of DSAI tags activation state for an Application Server) | +| DsaiTagStatus | 6.2.6.2.47 | DSAI tag status (DSAI tag and activation state) | +| CreatedUeReachabilitySubscription | 6.2.6.2.48 | A subscription to notifications of UE reachability for IP. | +| PrivateIdentities | 6.2.6.2.49 | IMS Private Identities | +| PrivateIdentity | 6.3.6.2.50 | IMS Private Identity and the related data (e.g. Identity Type) | +| ScscfSelectionAssistanceInformation | 6.2.6.2.51 | This information shall be used by the I-CSCF to select an S-CSCF for the UE | +| ChargingInfo | 6.2.6.2.52 | Diameter addresses of the charging function | + +Table 6.2.6.1-2 specifies data types re-used by the Nhss\_imsSDM service API from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nhss\_imsSDM. + +**Table 6.2.6.1-2: Nhss\_imsSDM re-used Data Types** + +| Data type | Reference | Comments | +|--------------------------|---------------------|-------------------------------------------------| +| Uri | 3GPP TS 29.571 [16] | Uniform Resource Identifier | +| SupportedFeatures | 3GPP TS 29.571 [16] | see 3GPP TS 29.500 [4] clause 6.6 | +| ModificationNotification | 3GPP TS 29.503 [15] | Payload of the notification after a data change | +| EutraLocation | 3GPP TS 29.571 [16] | E-UTRAN user location | +| NrLocation | 3GPP TS 29.571 [16] | NR user location | +| PlmnId | 3GPP TS 29.571 [16] | PLMN Identity | +| TimeZone | 3GPP TS 29.571 [16] | Time Zone and Daylight Saving Time | +| UtraLocation | 3GPP TS 29.571 [16] | UTRAN user location | +| GeraLocation | 3GPP TS 29.571 [16] | GERAN user location | +| DiameterIdentity | 3GPP TS 29.571 [16] | Diameter URI | +| NfInstanceId | 3GPP TS 29.571 [16] | String uniquely identifying a NF instance | +| RatType | 3GPP TS 29.571 [16] | RAT type | +| StnSr | 3GPP TS 29.571 [16] | Session Transfer Number for SRVCC | +| PatchItem | 3GPP TS 29.571 [16] | Patch Item | +| PatchResult | 3GPP TS 29.571 [16] | Patch Result | +| Ipv4Addr | 3GPP TS 29.571 [16] | IPv4 address | +| Ipv6Addr | 3GPP TS 29.571 [16] | IPv6 address | +| Ipv6Prefix | 3GPP TS 29.571 [16] | IPv6 address prefix | +| DateTime | 3GPP TS 29.571 [16] | UTC time | +| AccessType | 3GPP TS 29.571 [16] | Type of access | +| ProblemDetails | 3GPP TS 29.571 [16] | Response body of error response messages. | +| RedirectResponse | 3GPP TS 29.571 [16] | Response body of redirect response messages. | +| Ecgi | 3GPP TS 29.571 [16] | E-UTRAN Cell Global Identity | +| Tai | 3GPP TS 29.571 [16] | Tracking Area Identity | + +## 6.2.6.2 Structured data types + +### 6.2.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +### 6.2.6.2.2 Type: SscfCapabilityList + +**Table 6.2.6.2.2-1: Definition of type SscfCapabilityList** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------|--------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| mandatoryCapabilityList | Capabilities | O | 1 | List of S-CSCF capabilities which are mandatory to be supported by the S-CSCF allocated to the subscription the user belongs to. | +| optionalCapabilityList | Capabilities | O | 1 | List of S-CSCF capabilities which are optional or preferred (but not mandatory) to be supported by the S-CSCF allocated to the subscription the user belongs to. | + +NOTE 1: At least one of mandatory or optional capabilities shall be present. + +### 6.2.6.2.3 Type: Capabilities + +**Table 6.2.6.2.3-1: Definition of type Capabilities** + +| Type Name | Type Definition | Description | +|--------------|-------------------|-----------------------------------------| +| Capabilities | array(Capability) | This IE contains a list of capabilities | + +## 6.2.6.2.4 Type: ImsProfileData + +Table 6.2.6.2.4-1: Definition of type ImsProfileData + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------|--------------------------|---|-------------|-------------------------------------------------------------------------------------| +| supportedFeatures | SupportedFeatures | O | 0..1 | See clause 6.1.8 | +| imsServiceProfiles | array(ImsServiceProfile) | M | 1..N | IMS service profile shared by several public identities when they belong to an IRS. | +| chargingInfo | ChargingInfo | O | 0..1 | A response body containing the Charging Information for the user. | +| serviceLevelTraceInfo | string | O | 0..1 | IMS Service Level Trace information. Syntax described in 3GPP TS 24.323 [24]. | +| servicePriorityLevelList | array(NamespacePriority) | O | 0..N | List of namespaces and their associated priorities allowed for the user. | +| maxAllowedSimulReg | integer | O | 0..1 | Maximum number of allowed simultaneous registrations for the Public User Identity. | + +## 6.2.6.2.5 Type: SharedData + +Table 6.2.6.2.5-1: SharedData + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|--------------|---|-------------|-------------------------------| +| sharedDataId | SharedDataId | M | 1 | Identifier of the shared data | +| sharedImsIfcData | Ifcs | O | 0..1 | Shared IFC Subscription Data | + +NOTE 1: The attribute sharedImsIfcData shall not contain sharedDataIds. +NOTE 2: When shared data clash with individual data, individual data shall take precedence. + +## 6.2.6.2.6 Type: ImsDataSets + +Table 6.2.6.2.6-1: ImsDataSets + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-------------| +| ifcData | IfcData | O | 0..1 | IFC Data | + +## 6.2.6.2.7 Type: RepositoryData + +Table 6.2.6.2.7-1: Definition of type RepositoryData + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|----------------|---|-------------|---------------------------------------------------------------------------| +| serviceData | string | M | 1 | The Repository Data for the requested Service Indication. Base64 encoded. | +| sequenceNumber | SequenceNumber | M | 1 | The sequence number associated to the current version of Repository Data. | + +## 6.2.6.2.8 Type: MsisdnList + +Table 6.2.6.2.8-1: Definition of type MsisdnList + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|---------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------| +| basicMsisdn | Msisdn | M | 1 | The basic (or correlation) MSISDN associated to the IMS Public Identity for the IMS Private Identity indicated (if any) | +| additionalMsisdns | array(Msisdn) | O | 1..N | Additional MSISDNs | + +## 6.2.6.2.9 Type: Publicidentities + +**Table 6.2.6.2.9-1: Definition of type Publicidentities** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|-----------------------|---|-------------|------------------------------------------| +| publicidentities | array(PublicIdentity) | M | 1..N | List of IMS Public Identities associated | + +## 6.2.6.2.10 Type: PublicIdentity + +**Table 6.2.6.2.10-1: Definition of type PublicIdentity** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|--------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| imsPublicId | ImsPublicId | M | 1 | IMS Public Identity (distinct or wildcarded) | +| identityType | IdentityType | M | 1 | Type of IMS Public Identity (e.g. Wildcarded Public Service Identity type) | +| irIsDefault | boolean | O | 0..1 | Indicates whether the IMS Public Identity is the default within the Implicit Registration Set. Absence and false indicates "non-default".
Only one identity in SIP URI format and one identity in TEL URI format (if any) shall have value True for this attribute. | +| aliasGroupId | string | O | 0..1 | Indicates the Alias Public User Identity Group to which the Public User Identity belongs. Absence indicates that the identity does not belong to any Alias Group | + +## 6.2.6.2.11 Type: ImsSdmSubscription + +**Table 6.2.6.2.11-1: ImsSdmSubscription** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|---------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| nflInstanceId | NflInstanceId | M | 1 | Identity of the NF Instance creating the subscription. | +| callbackReference | Uri | M | 1 | URI provided by the NF service consumer to receive notifications | +| monitoredResourceUris | array(Uri) | M | 1..N | A set of URIs that identify the resources for which a change triggers a notification.
The URI shall take the form of either an absolute URI or an absolute-path reference as defined in IETF RFC 3986 [31].
See NOTE. | +| expires | DateTime | C | 0..1 | If present, indicates the point in time at which the subscription expires.
Within a POST request the proposed expiry time is conveyed whereas in a POST response or PATCH response the confirmed expiry time is returned. | + +NOTE: The HSS should handle only the relative-path part (apiSpecificResourceUriPart, see 3GPP TS 29.501 [5] clause 4.4.1) and ignore possible inconsistencies in the base URI part. + +## 6.2.6.2.12 Type: ImsRegistrationStatus + +**Table 6.2.6.2.12-1: Definition of type ImsRegistrationStatus** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|----------------------|---|-------------|---------------------------------------------------------------------------------------------------------------| +| imsUserStatus | ImsRegistrationState | M | 1 | It contains the registration state of the user or the IRS, as described in 3GPP TS 29.328 [38], clause 7.6.3. | + +## 6.2.6.2.13 Type: PriorityLevels + +**Table 6.2.6.2.13-1: Definition of type PriorityLevels** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------|--------------------------|---|-------------|--------------------------------------------------------------------------| +| servicePriorityLevelList | array(NameSpacePriority) | M | 1..N | List of namespaces and their associated priorities allowed for the user. | + +## 6.2.6.2.14 Type: Ifcs + +**Table 6.2.6.2.14-1: Definition of type Ifcs** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------------------------------------------------------|------------------------|---|-------------|---------------------------------------------------------| +| ifcList | array(Ifc) | C | 1..N | List of complete IFCs which are associated to the user. | +| cscfFilterSetIdList | array(cscfFilterSetId) | C | 1..N | List of S-CSCF specific filter set identifiers. | +| NOTE: At least one of IfcList or cscfFilterSetIdList shall be present. | | | | | + +## 6.2.6.2.15 Type: Ifc + +**Table 6.2.6.2.15-1: Definition of type Ifc** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| priority | integer | M | 1 | Contains the priority of the IFC. The higher the Priority Number the lower the priority of the Filter Criteria is.
Minimum: 1 | +| trigger | TriggerPoint | O | 1 | Contains the conditions that should be checked in order to find out if the indicated Application Server should be contacted or not. The absence of this attribute will indicate an unconditional triggering to Application Server. | +| appServer | ApplicationServer | M | 1 | Contains the Application Server which shall be triggered if the conditions are met and its associated data (e.g. default handling) | +| NOTE : See 3GPP TS 29.228 [20], Annex B.2.2 for more details on the terms and concepts associated to Initial Filter Criteria. The ProfilePartIndicator attribute described in Annex B.2.2 is removed and it shall be derived from the SessionCase attribute described in Annex B.2.3. | | | | | + +## 6.2.6.2.16 Type: TriggerPoint + +**Table 6.2.6.2.16-1: Definition of type TriggerPoint** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| conditionType | TypeOfCondition | M | 1 | Indicates how the set of SPTs are expressed, i.e. either an Ored set of ANDed sets of SPT statements or an ANDed set of Ored sets of statements. These combinations are termed, respectively, Disjunctive Normal Form (DNF) and Conjunctive Normal Form (CNF) for the SPT (see 3GPP TS 29.228 [20], Annex C). | +| sptList | array(Spt) | M | 1..N | Contains the list of Service Point Triggers | + +## 6.2.6.2.17 Type: Spt + +Table 6.2.6.2.17-1: Definition of type Spt + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|-------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| conditionNegated | boolean | M | 1 | Indicates if the Service Point Trigger instance is negated (i.e. NOT logical expression) | +| sptGroup | array(SptGroupId) | M | 1..N | Contains the SPT group or list of SPT groups assigned to the SPT. | +| regType | array(RegistrationType) | O | 1..2 | Indicates the type of registration. If included, it shall contain the values that define whether the SPT matches to REGISTER messages that are related to initial registrations, re-registrations, and/or de-registrations. This attribute shall be included only if the SPT is for SIP method with a value "REGISTER" and only if it does not apply to all types of registration; otherwise, it shall be absent (i.e. the SIP Method SPT matches to all REGISTER messages).
The attribute regType shall be discarded if it is present in an SPT other than SIP Method with value "REGISTER". | +| requestURI | string | C | 1 | Contains the request-URI of the SIP request (NOTE 2) | +| sipMethod | string | C | 1 | Contains the method of the SIP request (NOTE 2) | +| sipHeader | HeaderSipRequest | C | 1 | Contains a header (and optionally value of the header) in the SIP request (NOTE 2) | +| sessionCase | RequestDirection | O | 1 | Contains the direction of the SIP request as evaluated by the S-CSCF. | +| sessionDescription | SdpDescription | C | 1 | Contains a SDP line (and optionally the value in the line) within the body (if any) of a SIP request (NOTE 2) | + +NOTE 1: See 3GPP TS 29.228 [20], Annex B.2.3 for more details on the terms and concepts associated to Service Point Trigger. The ProfilePartIndicator attribute described in Annex B.2.2 is removed and it shall be derived from the SessionCase attribute described in Annex B.2.3. + +NOTE 2: Exactly one of requestURI, method, header and sessionDescription shall be present. See TS 29.228 [20], Annex F for the definition of these attributes. + +## 6.2.6.2.18 Type: HeaderSipRequest + +Table 6.2.6.2.18-1: Definition of type HeaderSipRequest + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| header | string | M | 1 | Contains a SIP header | +| content | string | O | 1 | Contains the content of the SIP header. If this attribute is absent, it shall indicate that the SPT is the presence (if conditionNegated="FALSE") or absence (if conditionNegated="TRUE") of the SIP header. | + +## 6.2.6.2.19 Type: SdpDescription + +Table 6.2.6.2.19-1: Definition of type SdpDescription + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| line | string | M | 1 | Contains a line in the session description | +| content | string | O | 1 | Contains the content of the SDP line. If this attribute is absent, it shall indicate that the SPT is the presence (if conditionNegated="FALSE") or absence (if conditionNegated="TRUE") of the SDP line. | + +## 6.2.6.2.20 Type: ApplicationServer + +**Table 6.2.6.2.20-1: Definition of type ApplicationServer** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|---------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| asUri | string | M | 1 | Contains the Application Server SIP URI, as described in IETF RFC 3261 [22] or 3GPP TS 23.003 [13]. | +| sessionContinue | boolean | O | 1 | This IE indicates whether the SIP dialog shall be continued or released if the Application Server could not be reached.

true: indicates that the session shall be continued

false or absent: indicates that the session shall be released | +| serviceInfoList | array(ServiceInformation) | O | 1..N | Indicates a list of service information that shall be sent to the Application Server. | + +## 6.2.6.2.21 Type: ImsLocationData + +**Table 6.2.6.2.21-1: Definition of type ImsLocationData** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------| +| scscfName | string | M | 1 | S-CSCF name assigned to the IMS subscription the UE belongs to in the form of a SIP URI, as defined in IETF RFC 3261 [22]. | + +## 6.2.6.2.22 Type: ServiceLevelTraceInformation + +**Table 6.2.6.2.22-1: Definition of type ServiceLevelTraceInformation** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------| +| serviceLevelTraceInfo | string | M | 1 | IMS Service Level Trace information. Syntax described in 3GPP TS 24.323 [24] | + +## 6.2.6.2.23 Type: PsLocation + +**Table 6.2.6.2.23-1: Definition of type PsLocation** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|------------------|---|-------------|------------------------------------------------| +| sgsnLocation | SgsnLocationData | O | 0..1 | Location information as retrieved from SGSN | +| mmeLocation | MmeLocationData | O | 0..1 | Location information as retrieved from MME | +| amfLocation | AmfLocationData | O | 0..1 | Location information as retrieved from AMF | +| twanLocation | TwanLocationData | O | 0..1 | 3GPP AAA Server for TWAN Location information. | + +NOTE: At least one of the "sgsnLocation", "mmeLocation", "amfLocation" or "twanLocation" shall be included. + +## 6.2.6.2.24 Type: SgsnLocationData + +Table 6.2.6.2.24-1: Definition of type SgsnLocationData + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|----------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------| +| sgsnNumber | string | M | 1 | SGSN number. See 3GPP TS 23.003 [13] clause 5.1. | +| plmnId | PlmnId | M | 1 | PLMN identity | +| sgsnLocation | UtraLocation | O | 0..1 | User location as retrieved from SGSN. | +| csgInformation | CsgInformation | O | 0..1 | Closed Subscriber Group Information. See 3GPP TS 23.060 [25]. | +| timeZone | TimeZone | O | 0..1 | Local Time Zone information (Time Zone and Daylight Saving Time) of the location in the visited network where the UE is located. | +| ratType | RatType | O | 0..1 | RAT type | + +## 6.2.6.2.25 Type: MmeLocationData + +Table 6.2.6.2.25-1: Definition of type MmeLocationData + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------| +| mmeAddress | DiameterIdentity | M | 1 | MME diameter identity | +| plmnId | PlmnId | M | 1 | PLMN identity | +| mmeLocation | EutraLocation | O | 0..1 | User location as retrieved from MME. | +| csgInformation | CsgInformation | O | 0..1 | Closed Subscriber Group Information. See 3GPP TS 23.060 [25]. | +| timeZone | TimeZone | O | 0..1 | Local Time Zone information (Time Zone and Daylight Saving Time) of the location in the visited network where the UE is located. | +| ratType | RatType | O | 0..1 | RAT type | + +## 6.2.6.2.26 Type: AmfLocationData + +Table 6.2.6.2.26-1: Definition of type AmfLocationData + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|--------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------| +| amfAddress | NfInstanceId | M | 1 | AMF identity. | +| plmnId | PlmnId | M | 1 | PLMN identity | +| amfLocation | NrLocation | O | 0..1 | User location as retrieved from AMF. | +| smsfAddress | NfInstanceId | O | 0..1 | SMSF identity | +| timeZone | TimeZone | O | 0..1 | Local Time Zone information (Time Zone and Daylight Saving Time) of the location in the visited network where the UE is located. | +| ratType | RatType | O | 0..1 | RAT type | + +## 6.2.6.2.27 Type: TwanLocationData + +**Table 6.2.6.2.27-1: Definition of type TwanLocationData** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------| +| twanSsid | string | M | 1 | TWAN SSID, as defined in 3GPP TS 29.273 [26]. | +| plmnId | PlmnId | M | 1 | PLMN identity of the TWAN | +| twanBssid | string | O | 0..1 | TWAN BSSID, as defined in 3GPP TS 29.273 [26]. | +| civicAddress | string | O | 0..1 | Defined in clause 3.4 of IETF RFC 4776 [27] excluding the first 3 octets. Base64 encoded, according to IETF RFC 2045 [28]. | +| twanOperatorName | string | O | 0..1 | TWAN Operator Name, as defined in clause 19.8 of 3GPP TS 23.003 [13]. | +| timeZone | TimeZone | O | 0..1 | Local Time Zone information (Time Zone and Daylight Saving Time) of the location in the visited network where the UE is located. | +| logicalAccessId | string | O | 0..1 | Logical Access ID, as defined in ETSI ES 283 034 [29]. | + +## 6.2.6.2.28 Type: CsLocation + +**Table 6.2.6.2.28-1: Definition of type CsLocation** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|----------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------| +| mscNumber | string | M | 0..1 | MSC number. See 3GPP TS 23.003 [13] clause 5.1. | +| vlrNumber | string | M | 0..1 | VLR number. See 3GPP TS 23.003 [13] clause 5.1. | +| plmnId | PlmnId | M | 0..1 | PLMN identity | +| vlrLocation | GeraLocation | O | 0..1 | User location as retrieved from MSC/VLR. | +| csgInformation | CsgInformation | O | 0..1 | Closed Subscriber Group Information. See 3GPP TS 23.060 [25]. | +| timeZone | TimeZone | O | 0..1 | Local Time Zone information (Time Zone and Daylight Saving Time) of the location in the visited network where the UE is located. | +| eUtranCgi | Ecgi | O | 0..1 | E-UTRAN Cell Global Identity | +| tai | Tai | O | 0..1 | Tracking Area ID | + +## 6.2.6.2.29 Type: CsgInformation + +**Table 6.2.6.2.29-1: Definition of type CsgInformation** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| csgId | string | M | 1 | CSG Identity. Syntax described in 3GPP TS 29.002 [30] i.e. 5 octets BER encoded value of 27-bit BIT STRING (Base64 encoded according to IETF RFC 2045 [28]). Length = 8. | +| accessMode | string | O | 0..1 | CSG Access Mode. Syntax described in 3GPP TS 29.002 [30] (Base64 encoded according to IETF RFC 2045 [28]). Length = 4. | +| cMi | boolean | O | 0..1 | CSG Membership Indication
0: CSG membership
1: non CSG membership | + +## 6.2.6.2.30 Type: SrvccData + +Table 6.2.6.2.30-1: Definition of type SrvccData + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------| +| stnSr | StnSr | M | 1 | Indicates the STN-SR (Session Transfer Number for SRVCC) of the UE. | +| ueSrvccCapabilities | array(SrvccCapability) | O | 1..N | List of accesses supported by UE SRVCC capability (e.g. 4G, 5G).
Absence of this attribute indicates that UE is not SRVCC capable. | + +## 6.2.6.2.31 Type: PsiActivationState + +Table 6.2.6.2.31-1: Definition of type PsiActivationState + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|-----------------|---|-------------|-------------------------------------------------| +| activationState | ActivationState | M | 1 | Indicates whether the PSI is active or inactive | + +## 6.2.6.2.32 Type: ImsServiceProfile + +Table 6.2.6.2.32-1: Definition of type ImsServiceProfile + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------|-------------------------|---|-------------|------------------------------------------------------------------------------------| +| publicIdentifierList | array(PublicIdentifier) | M | 1..N | List of public identities sharing the same service profile and its individual data | +| ifcs | Ifcs | O | 1 | List of IFCs and/or shared IFC set identifiers | + +## 6.2.6.2.33 Type: PublicIdentifier + +Table 6.2.6.2.33-1: Definition of type PublicIdentifier + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|-----------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| publicIdentity | PublicIdentity | M | 1 | Public identity information | +| displayName | string | O | 1 | Name associated with the public identity | +| imsServicePriority | PriorityLevels | O | 1 | Multimedia service priority | +| serviceLevelTraceInfo | ServiceLevelTraceInfo | O | 1 | Service Level Tracing Information | +| barringIndicator | boolean | O | 1 | Indicates whether the identity is barred, i.e. it can not be used in any IMS communication except registrations, re-registrations and de-registrations.

true: identity is barred
false or absent: identity is not barred | +| wildcardedImpu | String | O | 1 | When identityType is wildcarded IMPU it contains the wildcard id as stored by HSS | + +## 6.2.6.2.34 Type: ImeiSvInformation + +Table 6.2.6.2.34-1: Definition of type ImeiSvInformation + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------------------------------|-----------|---|-------------|----------------------| +| imei | string | C | 1 | Indicates the IMEI | +| imeiSv | string | C | 1 | Indicates the IMEISV | +| NOTE: Either imei or imeiSv shall be present. | | | | | + +## 6.2.6.2.35 Type: IpAddress + +**Table 6.2.6.2.35-1: Definition of type IpAddressInformation** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|------------|---|-------------|---------------------| +| ipv4Addr | Ipv4Addr | C | 0..1 | IPv4 address | +| ipv6Addr | Ipv6Addr | C | 0..1 | IPv6 address | +| ipv6Prefix | Ipv6Prefix | C | 0..1 | IPv6 address prefix | + +NOTE: Either ipv4Addr, or ipv6Addr, or ipv6Prefix shall be present. + +## 6.2.6.2.36 Type: TadsInformation + +**Table 6.2.6.2.36-1: Definition of type TadsInformation** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------|-----------------------------|---|-------------|-----------------------------------------------------------| +| voiceOverPsSessionSupport | ImVoiceOverPsSessionSupport | M | 1 | Indicates the support for Voice over PS | +| accessType | AccessType | O | 0..1 | Indicates the type of access | +| ratType | RatType | O | 0..1 | Indicates the RAT Type | +| lastUeActivityTime | DateTime | O | 0..1 | Indicates the time of the last radio contact with the UE. | + +## 6.2.6.2.37 Type: UeReachabilitySubscription + +**Table 6.2.6.2.37-1: Definition of type UeReachabilitySubscription** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------| +| expiry | DateTime | M | 1 | Indicates the suggested time at which monitoring should cease and the subscription should become invalid. | +| callbackReference | Uri | M | 1 | Callback URI provided by the subscribing NF service consumer. | + +## 6.2.6.2.38 Type: UeReachabilityNotification + +**Table 6.2.6.2.38-1: Definition of type UeReachabilityNotification** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|---------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------| +| reachabilityIndicator | boolean | M | 1 | Indicates that the UE has been detected reachable for IP. | +| detectingNode | RequestedNode | M | 1 | Indicates the serving node which detected the UE reachability for IP (NOTE 1) | +| accessType | AccessType | C | 1 | Indicates the access type (e.g. non 3GPP) where the reachability was detected. It shall be present when the serving node is AMF. | + +NOTE 1: Value "3GPP\_AAA\_SERVER\_TWAN" is not applicable + +## 6.2.6.2.39 Type: PsUserState + +**Table 6.2.6.2.39-1: Definition of type PsUserState** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------|---|-------------|-----------------------------------| +| sgsnUserState | UserStatePs | C | 0..1 | User state as retrieved from SGSN | +| mmeUserState | UserStatePs | C | 0..1 | User state as retrieved from MME | +| amfUserState | UserStatePs | C | 0..1 | User state as retrieved from AMF | + +NOTE: At least one of the "sgsnUserState", "mmeUserState" or "amfUserState" shall be included. + +## 6.2.6.2.40 Type: CsUserState + +**Table 6.2.6.2.40-1: Definition of type PsUserState** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|-------------|---|-------------|--------------------------------------| +| mscVlrUserState | UserStateCs | M | 1 | User state as retrieved from MSC/VLR | + +## 6.2.6.2.41 Type: Csrn + +**Table 6.2.6.2.41-1: Definition of type CsrnInformation** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|----------------------------------------------------------------| +| csrn | Msisdn | M | 1 | Contains a CS domain routeing number as retrieved from MSC/VLR | + +## 6.2.6.2.42 Type: ReferenceLocationInformation + +**Table 6.2.6.2.42-1: Definition of type ReferenceLocationInformation** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------| +| accessType | string | C | 1 | Indicates the type of access for which the reference location of the user is defined (e.g. ADSL). | +| accessInfo | string | C | 1 | Indicates the type of the access information defined for the reference location of the user (e.g. dsl-location). | +| accessValue | string | C | 1 | It contains the location information (e.g. line identifier in fixed access networks) as configured by the operator. | + +NOTE 1: At least one of accessType or accessInfo or accessValue shall be present. +NOTE 2: The syntax of accessType, accessInfo and accessValue is as described in 3GPP TS 24.229 [18] for P-Access-Network-Info header fields: accessType corresponds to the "access-type" field whereas accessInfo and accessValue correspond to the type and associated value defined for the "access-info" field. + +## 6.2.6.2.43 Type: SmsRegistrationInfo + +**Table 6.2.6.2.43-1: Definition of type SmsRegistrationInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|--------------------------------------| +| ipSmGwNumber | Msisdn | M | 1 | IP-SM-GW number | +| scAddress | Msisdn | O | 0..1 | Short Message Service Centre Address | + +## 6.2.6.2.44 Type: IpSmGwAddress + +**Table 6.2.6.2.44-1: Definition of type IpSmGwAddress** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|------------------|---|-------------|-------------------------------------------------------------------| +| ipSmGwNumber | Msisdn | M | 1 | IP-SM-GW number | +| ipSmGwDiaUri | DiameterIdentity | O | 0..1 | IP-SM-GW Diameter Uri. It shall be present if s6c is supported. | +| ipSmGwDiaRealm | DiameterIdentity | O | 0..1 | IP-SM-GW Diameter Realm. It shall be present if s6c is supported. | + +## 6.2.6.2.45 Type: ImsAssociatedIdentities + +**Table 6.2.6.2.45-1: Definition of type ImsAssociatedIdentities** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|----------------------|---|-------------|----------------------------------------------------------------------| +| irsState | ImsRegistrationState | M | 1 | It contains the registration state of the Implicit Registration Set. | +| publicIdentities | PublicIdentities | M | 1 | List of IMS Public Identities associated. | + +## 6.2.6.2.46 Type: DsaiTagInformation + +**Table 6.2.6.2.46-1: Definition of type DsaiTagInformation** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|----------------------|---|-------------|--------------------------------------------------------------| +| dsaiTagStatusList | array(DsaiTagStatus) | M | 1..N | List of DSAI Tags associated to the Application Server Name. | + +## 6.2.6.2.47 Type: DsaiTagStatus + +**Table 6.2.6.2.47-1: Definition of type DsaiTagStatus** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------|---|-------------|-----------------------------------------------------| +| dsaiTag | string | M | 1 | DSAI tag associated to the Application Server Name. | +| dsaiStatus | ActivationState | M | 1 | Status of DSAI tag | + +## 6.2.6.2.48 Type: CreatedUeReachabilitySubscription + +**Table 6.2.6.2.48-1: Definition of type CreatedUeReachabilitySubscription** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------| +| expiry | DateTime | M | 1 | Indicates the granted time at which monitoring will cease and the subscription becomes invalid. | + +## 6.2.6.2.49 Type: PrivateIdentities + +**Table 6.2.6.2.49-1: Definition of type PrivateIdentities** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|------------------------|---|-------------|--------------------------------------------| +| privateIdentities | array(PrivateIdentity) | M | 1..N | List of IMS Private Identities associated. | + +## 6.2.6.2.50 Type: PrivateIdentity + +**Table 6.2.6.2.50-1: Definition of type PrivateIdentity** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|---------------------|---|-------------|---------------------------------------------------| +| privateIdentity | PrivateId | M | 1 | IMS Private Identity. | +| privateIdentityType | PrivateIdentityType | M | 1 | Type of IMS Private Identity (e.g. IMPI or IMSI). | + +#### 6.2.6.2.51 Type: SscfSelectionAssistanceInformation + +**Table 6.2.6.2.51-1: Definition of type SscfSelectionAssistanceInformation** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|--------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| sscfCapabilityList | SscfCapabilityList | C | 0..1 | Information about mandatory and optional S-CSCF capabilities.
Shall be present if sscfNames is absent; may be present otherwise. | +| sscfNames | array(string) | C | 1..N | a list of S-CSCF names the UE can be steered to. Each strings shall contain a SIP-URL as defined in IETF RFC 3261 [22] to identify a SIP server (S-CSCF)
Shall be present if sscfCapabilityList is absent; may be present otherwise. | + +#### 6.2.6.2.52 Type: ChargingInfo + +**Table 6.2.6.2.52-1: Definition of type ChargingInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------------------------|------------------|---|-------------|--------------------| +| primaryEventChargingFunctionName | DiameterIdentity | C | 0..1 | See 3GPP TS 29.328 | +| secondaryEventChargingFunctionName | DiameterIdentity | O | 0..1 | See 3GPP TS 29.328 | +| primaryChargingCollectionFunctionName | DiameterIdentity | C | 0..1 | See 3GPP TS 29.328 | +| secondaryChargingCollectionFunctionName | DiameterIdentity | O | 0..1 | See 3GPP TS 29.328 | + +NOTE: At least primaryEventChargingFunctionName or primaryChargingCollectionFunctionName shall be present + +### 6.2.6.3 Simple data types and enumerations + +#### 6.2.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +#### 6.2.6.3.2 Simple data types + +The simple data types defined in table 6.2.6.3.2-1 shall be supported. + +**Table 6.2.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | +|-------------------|-----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Capability | integer | S-CSCF capability | +| SequenceNumber | integer | Unsigned integer containing the sequence number associated to the current version of Repository Data | +| ServiceIndication | string | String containing the Service Indication or Service Identifier | +| Msisdn | string | String containing an additional or basic MSISDN
Pattern: "[0-9]{5,15}\$" | +| PrivateId | string | String containing a Private User Identity or a Private Service Identity. | +| ImsPublicId | string | String containing an IMS Public Identity in SIP URI format or TEL URI format, as specified 3GPP TS 23.003 [13]
Pattern: "^(sip:\{[a-zA-Z0-9_\-\.!~*()&=+\$;,?:V]+\}@([A-Za-z0-9]+\{[-A-Za-z0-9]+\}\.)+[a-z]{2,}\}tel:\{[0-9]{5,15}\}\$)" | +| NameSpacePriority | string | String containing the namespace and priority. It shall be formatted as "r-value" parameter described in IETF RFC 4412 [19]. See also 3GPP TS 24.229 [18].
Pattern: "^[0-9a-zA-Z-!%]*\ _\+\'~\}+\.[0-9a-zA-Z-!%]*\ _\+\'~\}+\$" | +| CscfFilterSetId | integer | Contains the identifier of a specific filter set in the S-CSCF.
Minimum=0 | +| SptGroupId | integer | Contains the identifier of the Group of SPTs.
Minimum=0 | +| SharedDataId | string | Identifies globally and uniquely a piece of subscription data shared by multiple UEs. The value shall start with the HPLMN id (MCC/MNC) followed by a hyphen followed by a local Id as allocated by the home network operator.
Pattern: "[0-9]{5,6}\-\.+" | +| PrePaging | boolean | Indicates the support of pre-paging. | +| SipServerName | string | Server Name (e.g. AS name, CSCF name) in SIP URI format
Pattern: "^(sip:\{[a-zA-Z0-9_\-\.!~*()&=+\$;,?:V]+\}@([A-Za-z0-9]+\{[-A-Za-z0-9]+\}\.)+[a-z]{2,}\}\$)" | + +### 6.2.6.3.3 Enumeration: DataSetName + +The enumeration DataSetName represents a Set of Data within the IMS User Profile. It shall comply with the provisions defined in table 6.2.6.3.3-1. + +**Table 6.2.6.3.3-1: Enumeration DataSetName** + +| Enumeration value | Description | +|-------------------|-------------------------------------| +| "CHARGING_DATA" | Charging Information Data | +| "IFC_DATA" | Initial Filter Criteria Data | +| "TRACE_DATA" | IMS service level trace information | +| "PRIORITY_DATA" | Service Priority Levels | + +### 6.2.6.3.4 Enumeration: IdentityType + +The enumeration IdentityType represents the type of IMS Public Identity. It shall comply with the provisions defined in table 6.2.6.3.4-1. + +**Table 6.2.6.3.4-1: Enumeration IdentityType** + +| Enumeration value | Description | +|-------------------|-----------------------------------------------------------| +| "DISTINCT_IMPU" | The identity is an IMS Public User Identity | +| "DISTINCT_PSI" | The identity is an IMS Public Service Identity | +| "WILDCARDED_IMPU" | The identity is an IMS Wildcarded Public User Identity | +| "WILDCARDED_PSI" | The identity is an IMS Wildcarded Public Service Identity | + +#### 6.2.6.3.5 Enumeration: ImsRegistrationState + +The enumeration ImsRegistrationState represents the IMS status of the user or Public Identity or the IRS. It shall comply with the provisions defined in table 6.2.6.3.5-1 + +**Table 6.2.6.3.5-1: Enumeration ImsRegistrationState** + +| Enumeration value | Description | +|-----------------------------|---------------------------------------------------------------------------------------------------------------| +| "REGISTERED" | The identity is explicitly registered by the user. | +| "NOT_REGISTERED" | The identity is not registered. | +| "AUTHENTICATION_PENDING" | The identity initiated a registration and its authentication is ongoing (authentication pending flag is set). | +| "REGISTERED_UNREG_SERVICES" | The identity is not registered but has an S-CSCF assigned. | +| NOTE: | See clause 3.1 for more details on the IMS registration states and terms. | + +#### 6.2.6.3.6 Enumeration: TypeOfCondition + +The enumeration TypeOfCondition represents the type of condition to be applied to the logical expression of SPT groups and SPTs. See 3GPP TS 29.228 [20], Annex C. + +**Table 6.2.6.3.6-1: Enumeration TypeOfCondition** + +| Enumeration value | Description | Applicability | +|-------------------|------------------|---------------| +| "CNF" | Conjunctive form | | +| "DNF" | Disjunctive form | | + +#### 6.2.6.3.7 Enumeration: RegistrationType + +The enumeration RegistrationType represents the type of registration associated to the REGISTER request. + +**Table 6.2.6.3.7-1: Enumeration RegistrationType** + +| Enumeration value | Description | Applicability | +|------------------------|---------------------------------------------------|---------------| +| "INITIAL_REGISTRATION" | The request is related to an initial registration | | +| "RE_REGISTRATION" | The request is related to a re-registration | | +| "DE_REGISTRATION" | The request is related to a de-registration | | + +#### 6.2.6.3.8 Enumeration: RequestDirection + +The enumeration RequestDirection represents the direction of the request in combination with the registration status of the user as evaluated in the S-CSCF. + +**Table 6.2.6.3.8-1: Enumeration RequestDirection** + +| Enumeration value | Description | Applicability | +|----------------------------|--------------------------------------------------------------------------------------------------------------------------------|---------------| +| "ORIGINATING_REGISTERED" | The request is originated by an explicitly registered user. | | +| "ORIGINATING_UNREGISTERED" | The request is originated by a non-registered user. | | +| "ORIGINATING_CDIV " | The REGISTER request is related to an originating request after call diversion service (regardless of the registration state). | | +| "TERMINATING_REGISTERED" | The request is targeted to an explicitly registered user. | | +| "TERMINATING_UNREGISTERED" | The request is targeted to a non-registered user. | | + +#### 6.2.6.3.9 Enumeration: ServiceInformation + +The enumeration ServiceInformation indicates the type of additional information to be included in the body of the SIP request towards the Application Server. + +**Table 6.2.6.3.9-1: Enumeration ServiceInformation** + +| Enumeration value | Description | Applicability | +|----------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| "INCLUDE_REGISTER_REQUEST" | Indicates to the S-CSCF that the incoming SIP REGISTER request is to be transferred to the Application Server. | | +| "INCLUDE_REGISTER_RESPONSE" | Indicates to the S-CSCF that the final SIP response to the incoming SIP REGISTER request is to be transferred to the Application Server. | | +| NOTE: See 3GPP TS 23.218 [xy] for the use of this information. | | | + +#### 6.2.6.3.10 Enumeration: RequestedNode + +The enumeration RequestedNode represents serving node requested. It shall comply with the provisions defined in table 6.2.6.3.10-1. + +**Table 6.2.6.3.10-1: Enumeration RequestedNode** + +| Enumeration value | Description | Applicability | +|------------------------|--------------------------------------------|---------------| +| "SGSN" | The requested node is SGSN. | | +| "MME" | The requested node is MME. | | +| "AMF" | The requested node is AMF. | | +| "3GPP_AAA_SERVER_TWAN" | The requested node is 3GPP-AAA-SERVER-TWAN | | + +#### 6.2.6.3.11 Enumeration: SrvccCapability + +The enumeration SrvccCapability represents the type of UE support for SRVCC. It shall comply with the provisions defined in table 6.2.6.3.11-1. + +**Table 6.2.6.3.11-1: Enumeration IdentityType** + +| Enumeration value | Description | +|-----------------------|------------------------| +| "UE_4G_SRVCC_CAPABLE" | UE is 4G SRVCC capable | +| "UE_5G_SRVCC_CAPABLE" | UE is 5G SRVCC capable | + +#### 6.2.6.3.12 Enumeration: ActivationState + +The enumeration ActivationState represents the activation state of a PSI or DSAI tag. It shall comply with the provisions defined in table 6.2.6.3.12-1. + +**Table 6.2.6.3.12-1: Enumeration ActivationState** + +| Enumeration value | Description | +|-------------------|-------------| +| "ACTIVE" | | +| "INACTIVE" | | + +#### 6.2.6.3.13 Enumeration: ImsVoiceOverPsSessionSupport + +The enumeration ImsVoiceOverPsSessionSupport represents the support for Voice over PS associated to the UE. + +**Table 6.2.6.3.13-1: Enumeration ImsVoiceOverPsSessionSupport** + +| Enumeration value | Description | Applicability | +|-------------------------------------|---------------------------------------------|---------------| +| "IMS VOICE OVER PS NOT_SUPPORTED" | Voice over PS is supported for the UE | | +| "IMS VOICE OVER PS_SUPPORTED" | Voice over PS is not supported for the UE | | +| "IMS_VOICE_OVER_PS_SUPPORT_UNKNOWN" | Voice over PS support for the UE is unknown | | + +#### 6.2.6.3.14 Enumeration: AccessType + +The enumeration AccessType represents the type of access. It shall comply with the provisions defined in table 6.2.6.3.14-1. + +**Table 6.2.6.3.14-1: Enumeration AccessType** + +| Enumeration value | Description | Applicability | +|-------------------|-------------|---------------| +| "3GPP_ACCESS" | | | +| "NON_3GPP_ACCESS" | | | + +#### 6.2.6.3.15 Enumeration: UserStatePs + +The enumeration UserStatePs represents the user state in PS domain. + +**Table 6.2.6.3.15-1: Enumeration ImsVoiceOverPsSessionSupport** + +| Enumeration value | Description | Applicability | +|----------------------------------------------------------------------------------------------------|-------------|---------------| +| "DETACHED" | | | +| "ATTACHED_NOT_REACHABLE_FOR_PAGING" | | | +| "ATTACHED_REACHABLE_FOR_PAGING" | | | +| "CONNECTED_NOT_REACHABLE_FOR_PAGING" | | | +| "CONNECTED_REACHABLE_FOR_PAGING" | | | +| "NOT_PROVIDED_FROM_SGSN_OR_MME_OR_AMF" | | | +| "NETWORK_DETERMINED_NOT_REACHABLE" | | | +| NOTE: See 3GPP TS 29.272 [32] for PS/EPS User State and 3GPP TS 29.518 [33] for the 5GS User State | | | + +#### 6.2.6.3.16 Enumeration: UserStateCs + +The enumeration UserStateCs represents the user state in CS domain. + +**Table 6.2.6.3.16-1: Enumeration ImsVoiceOverPsSessionSupport** + +| Enumeration value | Description | Applicability | +|-------------------------------------------------------|-------------|---------------| +| "CAMEL_BUSY" | | | +| "NETWORK_DETERMINED_NOT_REACHABLE" | | | +| "ASSUMED_IDLE" | | | +| "NOT_PROVIDED_FROM_VLR" | | | +| NOTE: See 3GPP TS 23.078 [31] for CS Subscriber State | | | + +### 6.2.6.3.17 Enumeration: PrivateIdentityType + +The enumeration PrivateIdentityType represents the type of IMS Private Identity. It shall comply with the provisions defined in table 6.2.6.3.17-1. + +**Table 6.2.6.3.17-1: Enumeration PrivateIdentityType** + +| Enumeration value | Description | +|-------------------|-----------------------------------------------| +| "IMPI" | The identity is an IMS Private User Identity. | +| "IMSI" | The identity is an IMSI. | + +## 6.2.7 Error Handling + +### 6.2.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +### 6.2.7.2 Protocol Errors + +Protocol errors handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +### 6.2.7.3 Application Errors + +The common application errors defined in the Table 5.2.7.2-1 in 3GPP TS 29.500 [4] may also be used for the Nhss\_imsSDM service. The following application errors listed in Table 6.2.7.3-1 are specific for the Nhss\_imsSDM service. + +**Table 6.2.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-----------------------|-----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| USER_NOT_FOUND | 404 Not Found | The user does not exist in the HPLMN | +| SERVICE_NOT_FOUND | 404 Not Found | The service (PSI) does not exist in the HPLMN | +| DATA_NOT_FOUND | 404 Not Found | The requested data is not found/does not exist. Additional information (if any) about this application error is indicated for each specific resource. | +| CONTEXT_NOT_FOUND | 404 Not Found | It is used during the modification of an existing subscription when no corresponding context exists. | +| OPERATION_NOT_ALLOWED | 403 Forbidden | The requested data is not allowed to be accessed by the service consumer, e.g. the IMS-AS does not have permissions for the requested resource and/or HTTP method. | +| OUT_OF_SYNC | 409 Conflict | The request could not be completed due to a conflict with the current state of the target resource (wrong version or sequence number) | +| TOO_MUCH_DATA | 413 Payload Too Large | The request could not be completed due to large amount of data (e.g. size of repository data is too large). This response may be due to constraints applied by the service producer, e.g. based on local policy. | + +## 6.2.8 Feature negotiation + +The optional features in table 6.2.8-1 are defined for the Nhss\_imsSDM API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.2.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | SharedData | When receiving a Nhss_ismSDM_Get service operation request to retrieve a UE's IMS profile data, and the request does not contain a supported-features query parameter indicating support of this feature, the HSS shall not include Shared Data Ids in the response. Instead the HSS may – based on operator policy – take no further action (i.e. allow the UE to get services based on only the UE's individual IMS profile data), or send the shared data as individual data (this may result in notifications of individual subscription data change – if so subscribed – when shared data, which are sent as individual data, are modified, and/or when the UE's Shared Data IDs are modified). | +| 2 | PatchReport | If some of the modifications included in the PATCH request are not successfully implemented, the HSS reports the result of PATCH request execution to the consumer. See clause 5.2.7.2 of 3GPP TS 29.500 [4]. | + +## 6.2.9 Security + +As indicated in 3GPP TS 33.501 [5], the access to the Nhss\_imsSDM API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [35]), using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [36]) plays the role of the authorization server. + +If OAuth2 authorization is used, an NF Service Consumer, prior to consuming services offered by the Nhss\_imsSDM API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [36], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nhss\_imsSDM service. + +The Nhss\_imsSDM API defines the following scopes for OAuth2 authorization: + +**Table 6.2.9-1: Oauth2 scopes defined in Nhss\_imsSDM API** + +| Scope | Description | +|--------------------------------------------------------|---------------------------------------------------------------------------| +| "nhss-ims-sdm" | Access to the Nhss IMS Subscription Data Management API | +| "nhss-ims-sdm:registration-status:read" | Access to read the Registration Status resource | +| "nhss-ims-sdm:profile-data:read" | Access to read the Profile Data resource | +| "nhss-ims-sdm:priority-levels:read" | Access to read the Priority Levels resource | +| "nhss-ims-sdm:ifcs:read" | Access to read the Initial Filter Criteria resource | +| "nhss-ims-sdm:service-level-trace-information:read" | Access to read the Service Level Trace Information resource | +| "nhss-ims-sdm:server-name:read" | Access to read the Server Name resource | +| "nhss-ims-sdm:scscf-capabilities:read" | Access to read the S-CSCF Capabilities resource | +| "nhss-ims-sdm:ps-domain:location-data:read" | Access to read the PS-Domain Location Data resource | +| "nhss-ims-sdm:ps-domain:ip-address:read" | Access to read the PS-Domain IP Address resource | +| "nhss-ims-sdm:ps-domain:tads-info:read" | Access to read the PS-Domain TADS Info resource | +| "nhss-ims-sdm:ps-domain:ue-reach-subscriptions:create" | Access to create PS-Domain UE Reachability Subscriptions resources | +| "nhss-ims-sdm:ps-domain:ue-reach-subscriptions:modify" | Access to update/delete a PS-Domain UE Reachability Subscription resource | +| "nhss-ims-sdm:ps-domain:user-state:read" | Access to read the PS-Domain User State resource | +| "nhss-ims-sdm:cs-domain:location-data:read" | Access to read the CS-Domain Location Data resource | +| "nhss-ims-sdm:cs-domain:user-state:read" | Access to read the CS-Domain User State resource | +| "nhss-ims-sdm:cs-domain:csrn:read" | Access to read the CS-Domain CSRN resource | +| "nshh-ims-sdm:wireline-domain:reference-location:read" | Access to read the Wireline-Domain Reference Location resource | +| "nhss-ims-sdm:repository-data:modify" | Access to create/update/delete the Repository Data resource | +| "nhss-ims-sdm:repository-data:read" | Access to read the Repository Data resource | +| "nhss-ims-sdm:identities:read" | Access to read the Identities resource | +| "nhss-ims-sdm:srvcc:read" | Access to read the SRVCC resource | +| "nhss-ims-sdm:srvcc:modify" | Access to update the SRVCC resource | +| "nhss-ims-sdm:psi-status:read" | Access to read the PSI Status resource | +| "nhss-ims-sdm:psi-status:modify" | Access to update the PSI Status resource | +| "nhss-ims-sdm:dsai:read" | Access to read the DSAI resource | +| "nhss-ims-sdm:dsai:modify" | Access to update the DSAI resource | +| "nhss-ims-sdm:sms-registration-info:read" | Access to read the SMS Registration Info resource | +| "nhss-ims-sdm:sms-registration-info:modify" | Access to create/update/delete the SMS Registration Info resource | +| "nhss-ims-sdm:subscriptions:create" | Access to create Subscriptions resources | +| "nhss-ims-sdm:subscriptions:modify" | Access to update/delete a Subscription resource | +| "nhss-ims-sdm:shared-subscriptions:create" | Access to create a Shared-Data Subscriptions resource | +| "nhss-ims-sdm:shared-subscriptions:modify" | Access to update/delete a Shared-Data Subscription resource | +| "nhss-ims-sdm:shared-subscriptions:read" | Access to read the Shared-Data resource | +| "nhss-ims-sdm:charging-info:read" | Access to read the Charging-Information resource | + +## 6.3 Nhss\_imsUEAuthentication Service API + +### 6.3.1 API URI + +URIs of this API shall have the following root: + +{apiRoot}/{apiName}/{apiVersion}/ + +where "apiRoot" is defined in clause 4.4.1 of 3GPP TS 29.501 [5], the "apiName" shall be set to "nhss-ims-ueau" and the "apiVersion" shall be set to "v1" for the current version of this specification. + +## 6.3.2 Usage of HTTP + +### 6.3.2.1 General + +HTTP/2, as defined in IETF RFC 7540 [8], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +HTTP messages and bodies for the Nhss\_imsUEAU service shall comply with the OpenAPI [9] specification contained in Annex A.3. + +### 6.3.2.2 HTTP standard headers + +#### 6.3.2.2.1 General + +The usage of HTTP standard headers shall be supported as specified in clause 5.2.2 of 3GPP TS 29.500 [4]. + +#### 6.3.2.2.2 Content type + +The following content types shall be supported: + +- JSON, as defined in IETF RFC 8259 [10], signalled by the content type "application/json". +- The Problem Details JSON Object (IETF RFC 7807 [11]) signalled by the content type "application/problem+json" +- JSON Patch, as defined in IETF RFC 6902 [12], signalled by the content type "application/json-patch+json" + +### 6.3.2.3 HTTP custom headers + +#### 6.3.2.3.1 General + +The usage of HTTP custom headers shall be supported as specified in clause 5.2.3 of 3GPP TS 29.500 [4]. + +## 6.3.3 Resources + +### 6.3.3.1 Overview + +![Diagram showing the resource URI structure of the Nhss_imsUEAU API. The root is {apiRoot}/nhss-ims-ueau/v1. It branches to /fimpi, which further branches to /security-information.](8d29ec5c528f84817da9cac1e9e9f3f1_img.jpg) + +``` + +graph TD + Root["{apiRoot}/nhss-ims-ueau/v1"] --> Fimpi["/fimpi"] + Fimpi --> SecurityInformation["/security-information"] + +``` + +Diagram showing the resource URI structure of the Nhss\_imsUEAU API. The root is {apiRoot}/nhss-ims-ueau/v1. It branches to /fimpi, which further branches to /security-information. + +**Figure 6.3.3.1-1: Resource URI structure of the Nhss\_imsUEAU API** + +Table 6.3.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.3.3.1-1: Resources and methods overview** + +| Resource name (Archetype) | Resource URI | HTTP method or custom operation | Description | +|----------------------------------------|-----------------------------------------------------|---------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SecurityInformation (Custom operation) | /{impi}/security-information/generate-sip-auth-data | generate-sip-auth-data (POST) | The HSS takes the variable {impi} and, if applicable, fetches the corresponding SUPI. The HSS calculates a fresh authentication vector based on the received information and the stored security information, if IMS-AKA is selected. Otherwise, the HSS provides the corresponding authentication information. | + +### 6.3.3.2 Resource: SecurityInformation + +#### 6.3.3.2.1 Description + +This resource represents the information that is needed together with the SIP authentication scheme to calculate a fresh authentication vector. + +#### 6.3.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ims-ueau/v1/{impi}/security-information + +This resource shall support the resource URI variables defined in table 6.3.3.2.2-1. + +**Table 6.3.3.2.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|-------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.3.1 | +| impi | Represents the IMS Private Identity (see 3GPP TS 23.003 [13] clause 13.3).
Pattern: "^(impi-\.+\+\.+)\$" | + +#### 6.3.3.2.3 Resource Standard Methods + +No Standard Methods are supported for this resource. + +#### 6.3.3.2.4 Resource Custom Operations + +##### 6.3.3.2.4.1 Overview + +**Table 6.3.3.2.4.1-1: Custom operations** + +| Custom operation URI | Mapped HTTP method | Description | +|-------------------------|--------------------|----------------------------------------------------------------------------------------------------------------------------------------| +| /generate-sip-auth-data | POST | Select the authentication method and calculate a fresh AV if IMS-AKA is selected or provides corresponding authentication information. | + +### 6.3.3.2.4.2 Operation: generate-sip-auth-data + +#### 6.3.3.2.4.2.1 Description + +This custom operation is used by the NF service consumer (S-CSCF) to request authentication information data for the IMPI from the HSS. The HSS calculates an authentication vector taking into account the information received from the NF service consumer (S-CSCF) and the current representation of this resource if IMS AKA is selected. For details see 3GPP TS 33.203 [14]. + +#### 6.3.3.2.4.2.2 Operation Definition + +This operation shall support the request data structures specified in table 6.3.3.2.4.2.2-1 and the response data structure and response codes specified in table 6.3.3.2.4.2.2-2. + +**Table 6.3.3.2.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------| +| SipAuthenticationInfoRequest | M | 1 | Contains the SIP Authentication Scheme, the number of authentication items and Resynchronization Information | + +**Table 6.3.3.2.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SipAuthenticationInfoResult | M | 1 | 200 OK | Upon success, a response body containing the selected authentication method and an authentication vector if IMS AKA has been selected shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- USER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- AUTHENTICATION_REJECTED
- UNSUPPORTED_SIP_AUTH_SCHEME | + +**Table 6.3.3.2.4.2.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.3.3.2.4.2.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +## 6.3.4 Custom Operations without associated resources + +In this release of this specification, no custom operations without associated resources are defined for the Nhss\_imsUEAuthentication Service. + +## 6.3.5 Notifications + +In this release of this specification, no notifications are defined for the Nhss\_imsUEAuthentication Service. + +## 6.3.6 Data Model + +### 6.3.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.3.6.1-1 specifies the structured data types defined for the Nhss\_imsUEAU service API. + +**Table 6.3.6.1-1: Nhss\_imsUEAU specific Data Types** + +| Data type | Clause defined | Description | +|------------------------------|----------------|--------------------------------------------------------------------------------------------| +| SipAuthenticationInfoRequest | 6.3.6.2.2 | Contains SIP Authentication Schema, Authentication Items and Resynchronization Information | +| SipAuthenticationInfoResult | 6.3.6.2.3 | Contains authentication information (e.g. authentication vectors, line id) | +| ResynchronizationInfo | 6.3.6.2.4 | Contains RAND and AUTS | +| 3GAKaAv | 6.3.6.2.5 | Contains RAND, XRES, AUTN, CK, and IK | + +Table 6.3.6.1-2 specifies data types re-used by the Nhss\_imsUEAU service API from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nhss\_imsUEAU. + +**Table 6.3.6.1-2: Nhss\_imsUEAU re-used Data Types** + +| Data type | Reference | Comments | +|------------------|---------------------|----------------------------------------------| +| ProblemDetails | 3GPP TS 29.571 [16] | Response body of error response messages. | +| RedirectResponse | 3GPP TS 29.571 [16] | Response body of redirect response messages. | +| Autn | 3GPP TS 29.503 [15] | | +| Auts | 3GPP TS 29.503 [15] | | +| Rand | 3GPP TS 29.503 [15] | | +| Xres | 3GPP TS 29.503 [15] | | + +### 6.3.6.2 Structured data types + +#### 6.3.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +## 6.3.6.2.2 Type: SipAuthenticationInfoRequest + +Table 6.3.6.2.3-1: Definition of type AuthenticationInfoRequest + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------|-------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| cscfServerName | string | M | 1 | S-CSCF name in SIP URI format | +| sipAuthenticationScheme | SipAuthenticationScheme | M | 1 | SIP Authentication Scheme requested by service consumer (S-CSCF) | +| sipNumberAuthItems | SipNumberAuthItems | O | 0..1 | Number of authentication items (AVs). Absence indicates that only one AV is requested. This attribute shall be absent for authentication schemes other than IMS AKA. | +| resynchronizationInfo | ResynchronizationInfo | O | 0..1 | Contains RAND and AUTS; see 3GPP TS 33.203 [14]. This attribute shall be included only if a resynchronization procedure needs to be triggered. This attribute shall be absent for authentication schemes other than IMS AKA. | + +## 6.3.6.2.3 Type: SipAuthenticationInfoResult + +Table 6.3.6.2.3-1: Definition of type AuthenticationInfoResult + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------|-------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------| +| sipAuthenticationScheme | SipAuthenticationScheme | M | 1 | SIP Authentication Scheme used by service producer (HSS) | +| 3gAkaAvs | array(3GAkaAv) | O | 1..N | If IMS AKA is requested, it shall be present and will contain Authentication Vectors. | +| digestAuth | DigestAuthentication | O | 0..1 | If SIP Digest is used, it shall be present and shall contain the digest realm, algorithm, QoP and HA1. | +| lineIdentifierList | array(LineIdentifier) | O | 0..N | If NBA is used, it shall be present and shall contain a list of fixed broadband access line identifiers associated to the user. | +| ipAddress | IpAddress | O | 0..1 | If GIBA is used, it shall be present and shall contain an IP address (IPv4, or IPv6, or IPv6 prefix) | + +## 6.3.6.2.4 Type: ResynchronizationInfo + +Table 6.3.6.2.4-1: Definition of type ResynchronizationInfo + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-------------| +| rand | Rand | M | 1 | | +| auts | Auts | M | 1 | | + +## 6.3.6.2.5 Type: 3GAkaAv + +Table 6.3.6.2.5-1: Definition of type 3gAkaAv + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-------------| +| rand | Rand | M | 1 | | +| xres | Xres | M | 1 | | +| autn | Autn | M | 1 | | +| ck | Ck | M | 1 | | +| ik | Ik | M | 1 | | + +### 6.3.6.2.6 Type: DigestAuthentication + +**Table 6.3.6.2.6-1: Definition of type DigestAuthentication** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|--------------------|---|-------------|------------------------------------------------| +| digestRealm | string | M | 1 | Digest realm. See IETF RFC 4740 [17]. | +| digestAlgorithm | SipDigestAlgorithm | M | 1 | Digest Algorithm. See IETF RFC 4740 [17]. | +| digestQop | SipDigestQop | M | 1 | Quality of Protection. See IETF RFC 4740 [17]. | +| ha1 | string | M | 1 | Hash H(A1). See IETF RFC 4740 [17]. | + +### 6.3.6.2.7 Type: IpAddress + +The type IpAddress represents the IP address for GIBA scheme. It shall comply with the provisions defined in table 6.3.6.2.7-1. + +**Table 6.3.6.2.7-1: Definition of type IpAddress** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------------------------------------------------|------------|---|-------------|-------------| +| ipv4Addr | Ipv4Addr | C | 0..1 | | +| ipv6Addr | Ipv6Addr | C | 0..1 | | +| ipv6Prefix | Ipv6Prefix | C | 0..1 | | +| NOTE: Either ipv4Addr, or ipv6Addr, or ipv6Prefix shall be present. | | | | | + +### 6.3.6.3 Simple data types and enumerations + +#### 6.3.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +#### 6.3.6.3.2 Simple data types + +The simple data types defined in table 6.3.6.3.2-1 shall be supported. + +**Table 6.3.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | +|--------------------|-----------------|----------------------------------------------| +| SipNumberAuthItems | integer | Number of authentication items
Minimum: 1 | +| Impi | string | IMS Private User Identity | +| Ck | string | pattern: "^[A-Fa-f0-9]{32}\$" | +| Ik | string | pattern: "^[A-Fa-f0-9]{32}\$" | +| LineIdentifier | string | Line Identifier for the wireline access | + +#### 6.3.6.3.3 Enumeration: SipAuthenticationScheme + +The enumeration SipAuthenticationScheme represents an IMS authentication scheme. It shall comply with the provisions defined in table 6.3.6.3.3-1. + +**Table 6.3.6.3.3-1: Enumeration SipAuthenticationScheme** + +| Enumeration value | Description | +|--------------------|---------------------------------------------------------------------| +| "DIGEST-AKAV1-MD5" | IMS-AKA authentication scheme | +| "DIGEST-HTTP" | SIP Digest authentication scheme | +| "NBA" | NASS Bundled authentication scheme | +| "GIBA" | GPRS-IMS-Bundled authentication scheme | +| "UNKNOWN" | Authentication scheme to be used is unknown by the service consumer | + +#### 6.3.6.3.4 Enumeration: SipDigestAlgorithm + +The enumeration SipDigestAlgorithm represents the algorithm for SIP Digest scheme. It shall comply with the provisions defined in table 6.3.6.3.4-1. + +**Table 6.3.6.3.4-1: Enumeration SipDigestAlgorithm** + +| Enumeration value | Description | +|-------------------|-------------| +| "MD5" | | +| "MD5_SESS" | | + +#### 6.3.6.3.5 Enumeration: SipDigestQop + +The enumeration SipDigestQop represents the quality of protection for SIP Digest scheme. It shall comply with the provisions defined in table 6.3.6.3.5-1. + +**Table 6.3.6.3.5-1: Enumeration SipDigestQop** + +| Enumeration value | Description | +|-------------------|----------------------------------------------------| +| "AUTH" | Indicates authentication | +| "AUTH_INT" | Indicates authentication with integrity protection | + +### 6.3.7 Error Handling + +#### 6.3.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +#### 6.3.7.2 Protocol Errors + +Protocol errors handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +#### 6.3.7.3 Application Errors + +The common application errors defined in the Table 5.2.7.2-1 in 3GPP TS 29.500 [4] may also be used for the Nhss\_imsUEAuthentication service. The following application errors listed in Table 6.3.7.3-1 are specific for the Nhss\_imsUEAuthentication service. + +**Table 6.3.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|---------------------------------------|------------------------|------------------------------------------------------------------| +| AUTHENTICATION_REJECTED | 403
Forbidden | The user cannot be authenticated with this authentication method | +| USER_NOT_FOUND | 404 Not
Found | The user does not exist in the HPLMN | +| UNSUPPORTED_SIP_AUTHENTICATION_SCHEME | 501 Not
implemented | The received SIP authentication scheme is not supported by HPLMN | + +### 6.3.8 Feature Negotiation + +## 6.3.9 Security + +As indicated in 3GPP TS 33.501 [5], the access to the Nhss\_imsUEAU API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [35]), using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [36]) plays the role of the authorization server. + +If OAuth2 authorization is used, an NF Service Consumer, prior to consuming services offered by the Nhss\_imsUEAU API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [36], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nhss\_imsUEAU service. + +The Nhss\_imsUEAU API defines the following scopes for OAuth2 authorization: + +**Table 6.3.9-1: OAuth2 scopes defined in Nhss\_imsUEAU API** + +| Scope | Description | +|-----------------------------------------------|-----------------------------------------------------------| +| "nhss-ims-ueau" | Access to the Nhss IMS UE Context Management API | +| "nhss-ims-ueau:generate-sip-auth-data:invoke" | Access to invoke the Generate SIP Auth Data custom method | + +--- + +## Annex A (normative): OpenAPI specification + +### A.1 General + +This Annex specifies the formal definition of the Nhss IMS API(s). It consists of OpenAPI 3.0.0 specifications in YAML format. + +This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository, that uses the GitLab software version control system (see 3GPP TS 29.501 [5] clause 5.3.1 and 3GPP TR 21.900 [34] clause 5B). + +--- + +### A.2 Nhss\_imsUECM API + +``` +openapi: 3.0.0 + +info: + version: '1.0.4' + title: 'Nhss_imsUECM' + description: | + Nhss UE Context Management Service for IMS. + © 2021, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.562 HSS Services for interworking with IMS, version 16.5.0 + url: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.562/' + +servers: + - url: '{apiRoot}/nhss-ims-uecm/v1' +``` + +``` +variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. + +security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-uecm + +paths: + + /{impu}/authorize: + post: + summary: Authorize IMS Identities to register in the network or establish multimedia sessions +and return CSCF location if it is stored + operationId: Authorize + tags: + - Authorize Ims identities + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-uecm + - oAuth2ClientCredentials: + - nhss-ims-uecm + - nhss-ims-uecm:authorize:invoke + parameters: + - name: impu + in: path + description: Public identity of the user. + required: true + schema: + $ref: '#/components/schemas/Impu' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AuthorizationRequest' + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/AuthorizationResponse' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + callbacks: + deregistrationNotification: + '{request.body#/deregCallbackUri}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DeregistrationData' + responses: + '204': + description: Successful Notification response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/scscf-registration: + put: + summary: SCSCF registration information + operationId: SCSCF registration + tags: + - SCSCF registration and deregistration + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-uecm + - oAuth2ClientCredentials: + - nhss-ims-uecm + - nhss-ims-uecm:registration:create + parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ScscfRegistration' + required: true + responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/ScscfRegistration' + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ScscfRegistration' + '204': + description: No content + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '403': + description: Forbidden + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ExtendedProblemDetails' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{impu}/scscf-registration/scscf-restoration-info: + put: + summary: Update the S-CSCF restoration information of the UE + operationId: UpdateScscfRestorationInfo + tags: + - Update the S-CSCF restoration information of the UE + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-uecm + - oAuth2ClientCredentials: + - nhss-ims-uecm +``` + +``` + + - nhss-ims-uecm:restoration:modify +parameters: + - name: impu + in: path + description: Public identity of the user. + required: true + schema: + $ref: '#/components/schemas/Impu' +requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ScscfRestorationInfoRequest' + required: true +responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/ScscfRestorationInfoResponse' + headers: + Location: + description: 'Contains the URI of the newly created resource, according to the +structure: {apiRoot}/nhss_imsUECM/v1/{impu}/scscf-registration/scscf-restoration-info' + required: true + schema: + type: string + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ScscfRestorationInfoResponse' + '204': + description: No content + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +get: + summary: Retrieve the S-CSCF restoration + operationId: GetScscfRestorationInfo + tags: + - S-CSCF Restoration Info Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-uecm + - oAuth2ClientCredentials: + - nhss-ims-uecm + - nhss-ims-uecm:restoration:read + parameters: + - name: impu + in: path + description: Public identity of the user. + required: true + schema: + $ref: '#/components/schemas/Impu' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ScscfRestorationInfoResponse' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + default: + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +delete: + summary: Delete the S-CSCF restoration + operationId: DeleteScscfRestorationInfo + tags: + - S-CSCF Restoration Info Delete + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-uecm + - oAuth2ClientCredentials: + - nhss-ims-uecm + - nhss-ims-uecm:restoration:modify + parameters: + - name: impu + in: path + description: Public identity of the user. + required: true + schema: + $ref: '#/components/schemas/Impu' + responses: + '204': + description: No content + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nhss-ims-uecm: Access to the Nhss IMS UE Context Management API + nhss-ims-uecm:authorize:invoke: Access to invoke the Authorize custom operation + nhss-ims-uecm:registration:create: Access to create S-CSCF Registration resources + nhss-ims-uecm:restoration:read: Access to read the S-CSCF Restoration resource + nhss-ims-uecm:restoration:modify: Access to create/update/delete the S-CSCF Restoration + +resource + + schemas: + +# COMPLEX TYPES: + + AuthorizationRequest: + description: Ims authorization request data + type: object + required: + - authorizationType + properties: + impi: + $ref: '#/components/schemas/Impi' + authorizationType: + description: authorization type + $ref: '#/components/schemas/AuthorizationType' + visitedNetworkIdentifier: + type: string + emergencyIndicator: + type: boolean + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + + AuthorizationResponse: + description: Ims Registration authorization information result + type: object + properties: + authorizationResult: + +``` + +``` + + $ref: '#/components/schemas/AuthorizationResult' + cscfServerName: + type: string + scscfSelectionAssistanceInfo: + $ref: 'TS29562_Nhss_imsSDM.yaml#/components/schemas/ScscfSelectionAssistanceInformation' + required: + - authorizationResult + oneOf: + - required: + - cscfServerName + - required: + - scscfSelectionAssistanceInfo + +ScscfRegistration: + description: Scscf Registration + type: object + required: + - imsRegistrationType + - cscfServerName + properties: + impi: + $ref: '#/components/schemas/Impi' + imsRegistrationType: + description: Ims registration type + $ref: '#/components/schemas/ImsRegistrationType' + cscfServerName: + type: string + scscfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + deregCallbackUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + associatedImpis: + type: array + items: + $ref: '#/components/schemas/Impi' + associatedRegisteredImpis: + type: array + items: + $ref: '#/components/schemas/Impi' + irsImpus: + type: array + items: + $ref: '#/components/schemas/Impu' + minItems: 1 + uniqueItems: true + wildcardedPui: + $ref: '#/components/schemas/Impu' + looseRouteIndicator: + $ref: '#/components/schemas/LooseRouteIndication' + wildcardedPsi: + $ref: '#/components/schemas/Impu' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + multipleRegistrationIndicator: + type: boolean + pscfRestorationIndicator: + type: boolean + default: false + scscfReselectionIndicator: + type: boolean + default: false + +ExtendedProblemDetails: + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + - $ref: '#/components/schemas/AdditionalInfo' + +AdditionalInfo: + type: object + properties: + scscfServerName: + type: string + +ScscfRestorationInfo: + description: S-CSCF restoration information + type: object + properties: + userName: + +``` + +``` +$ref: '#/components/schemas/Impi' +restorationInfo: + type: array + items: + $ref: '#/components/schemas/RestorationInfo' +registrationTimeout: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +sipAuthenticationScheme: + $ref: '#/components/schemas/SipAuthenticationScheme' + +ScscfRestorationInfoRequest: + description: S-CSCF restoration information request + type: object + properties: + scscfRestorationInfoRequest: + $ref: '#/components/schemas/ScscfRestorationInfo' + +ScscfRestorationInfoResponse: + description: S-CSCF restoration information response + type: object + properties: + scscfRestorationInfoResponse: + type: array + items: + $ref: '#/components/schemas/ScscfRestorationInfo' + +RestorationInfo: + description: The information relevant to a specific registration required for an S-CSCF to +handle the requests for a user + type: object + required: + - path + - contact + properties: + path: + type: string + contact: + type: string + initialCSeqSequenceNumber: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + callIdSipHeader: + type: string + uesubscriptionInfo: + $ref: '#/components/schemas/UeSubscriptionInfo' + pscsfSubscriptionInfo: + $ref: '#/components/schemas/PscsfSubscriptionInfo' + imsSdmSubscriptions: + description: A map (list of key-value pairs where subscriptionId serves as key) of +ImsSdmSubscription + type: object + additionalProperties: + $ref: 'TS29562_Nhss_imsSDM.yaml#/components/schemas/ImsSdmSubscription' + +UeSubscriptionInfo: + type: object + required: + - callIdSipHeader + - fromSipHeader + - toSipHeader + - recordRoute + - contact + properties: + callIdSipHeader: + type: string + fromSipHeader: + type: string + toSipHeader: + type: string + recordRoute: + type: string + contact: + type: string + +PscsfSubscriptionInfo: + type: object + required: + - callIdSipHeader + - fromSipHeader +``` + +``` + - toSipHeader + - contact +properties: + callIdSipHeader: + type: string + fromSipHeader: + type: string + toSipHeader: + type: string + contact: + type: string + +DeregistrationData: +type: object +required: +- deregReason +- impi +properties: + deregReason: + $ref: '#/components/schemas/DeregistrationReason' + impi: + $ref: '#/components/schemas/Impi' + associatedImpis: + type: array + items: +``` + +``` + + $ref: '#/components/schemas/Impi' + emergencyRegisteredIdentities: + type: array + items: + $ref: '#/components/schemas/EmergencyRegisteredIdentity' + minItems: 1 + +EmergencyRegisteredIdentity: + type: object + required: + - impi + - impu + properties: + impi: + $ref: '#/components/schemas/Impi' + impu: + $ref: '#/components/schemas/Impu' + +DeregistrationReason: + type: object + required: + - reasonCode + - reasonText + properties: + reasonCode: + $ref: '#/components/schemas/DeregistrationReasonCode' + reasonText: + type: string + +# SIMPLE TYPES + +ImsUserId: + type: string + pattern: '^(impu-sip\:( [a-zA-Z0-9_\-\.\!\~*() &=+$, ;?\/\] +) \@( [A-Za-z0-9] + ( [ -A-Za-z0-9] +) \.) + [a-z]{2,} |impu-tel\:\+[0-9]{5,15} |impi-\.\+\.\+\.)$' + +Impu: + type: string +Impi: + type: string + +# ENUMS: + +AuthorizationType: + anyOf: + - type: string + enum: + - REGISTRATION + - DEREGISTRATION + - type: string + +AuthorizationResult: + anyOf: + - type: string + enum: + - FIRST_REGISTRATION + - SUBSEQUENT_REGISTRATION + - type: string + +SipAuthenticationScheme: + anyOf: + - type: string + enum: + - DIGEST-AKAV1-MD5 + - DIGEST-HTTP + - NBA + - GIBA + - UNKNOWN + - type: string + +ImsRegistrationType: + anyOf: + - type: string + enum: + - INITIAL_REGISTRATION + - RE_REGISTRATION + - TIMEOUT_DEREGISTRATION + - USER_DEREGISTRATION + +``` + +``` + + - ADMINISTRATIVE_DEREGISTRATION + - AUTHENTICATION_FAILURE + - AUTHENTICATION_TIMEOUT + - UNREGISTERED_USER + - type: string + +LooseRouteIndication: + anyOf: + - type: string + enum: + - LOOSE_ROUTE_NOT_REQUIRED + - LOOSE_ROUTE_REQUIRED + - type: string + +DeregistrationReasonCode: + anyOf: + - type: string + enum: + - PERMANENT_TERMINATION + - NEW_SERVER_ASSIGNED + - REMOVE_S-CSCF + - SERVER_CHANGE + - type: string + +``` + +## --- A.3 Nhss\_imsSDM API + +openapi: 3.0.0 + +``` + +info: + version: '1.0.6' + title: 'Nhss_imsSDM' + description: | + Nhss Subscriber Data Management Service for IMS. + © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.562 HSS Services for interworking with IMS, version 16.8.0 + url: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.562/' + +servers: + - url: '{apiRoot}/nhss-ims-sdm/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. + +security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + +paths: + /{imsUeId}/ims-data/registration-status: + get: + summary: Retrieve the registration status of a user + operationId: GetRegistrationStatus + tags: + - Registration Status retrieval + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:registration-status:read + parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: supported-features + in: query + +``` + +``` + + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ImsRegistrationStatus' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + + /{imsUeId}/ims-data/profile-data: + get: + summary: Retrieve the complete IMS profile for a given IMS public identity (and public + identities in the same IRS) + operationId: GetProfileData + tags: + - IMS Profile Data Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:profile-data:read + parameters: + - name: imsUeId + in: path + description: IMS Identity. In this case it shall be an IMS public identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: dataset-names + in: query + description: Datasets to be retrieved + schema: + $ref: '#/components/schemas/DataSetNames' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ImsProfileData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + + /{imsUeId}/ims-data/profile-data/priority-levels: + +``` + +``` +get: + summary: Retrieve the service priority levels associated to the user + operationId: GetPriorityInfo + tags: + - Priority Info Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:priority-levels:read + parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/PriorityLevels' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/ims-data/profile-data/ifcs: +get: + summary: Retrieve the Initial Filter Criteria for the associated IMS subscription + operationId: GetIfcs + tags: + - IFCs Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:ifcs:read + parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: application-server-name + in: query + description: SIP URI of the Application Server Name + schema: + $ref: '#/components/schemas/SipServerName' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +``` + +``` +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/Ifcs' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/ims-data/profile-data/service-level-trace-information: + get: + summary: Retrieve the IMS service level trace information for the associated user + operationId: GetServiceTraceInfo + tags: + - Service Trace Info Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:service-level-trace-information:read + parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceLevelTraceInformation' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/ims-data/profile-data/charging-info: + get: + summary: Retrieve the charging information for to the user + operationId: GetChargingInfo + tags: +``` + +``` +- Charging Info Retrieval +security: +- {} +- oAuth2ClientCredentials: +- nhss-ims-sdm +- oAuth2ClientCredentials: +- nhss-ims-sdm +- nhss-ims-sdm:charging-info:read +parameters: +- name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' +- name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: +'200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ChargingInfo' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +'504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/ims-data/location-data/server-name: +get: + summary: Retrieve the server name for the associated user + operationId: GetServerName + tags: + - Server Name retrieval + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:server-name:read + parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ImsLocationData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +``` + +``` + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/ims-data/location-data/scscf-capabilities: + get: + summary: Retrieve the S-CSCF capabilities for the associated IMS subscription + operationId: GetScscfCapabilities + tags: + - Retrieval of the S-CSCF capabilities for the IMS subscription + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:scscf-capabilities:read + parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ScscfCapabilityList' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/ims-data/location-data/scscf-selection-assistance-info: + get: + summary: Retrieve the S-CSCF selection assistance info + operationId: GetScscfSelectionAssistanceInfo + tags: + - Retrieval of the S-CSCF selection assistance information for the IMS subscription + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:scscf-selection-assistance-info:read + parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + responses: + '200': + description: Expected response to a valid request +``` + +``` + +content: + application/json: + schema: + $ref: '#/components/schemas/ScscfSelectionAssistanceInformation' +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +'504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/access-data/ps-domain/location-data: + get: + summary: Retrieve the location data in PS domain + operationId: GetLocPsDomain + tags: + - PS location retrieval + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:ps-domain:location-data:read + parameters: + - name: imsUeId + in: path + description: IMS Public Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: requested-nodes + in: query + description: Indicates the serving node(s) for which the request is applicable. + style: form + explode: false + schema: + type: array + items: + $ref: '#/components/schemas/RequestedNode' + - name: serving-node + in: query + description: Indicates that only the stored NF id/address of the serving node(s) is +required + schema: + type: boolean + - name: local-time + in: query + description: Indicates that only the Local Time Zone information of the location in the +visited network where the UE is attached is requested + schema: + type: boolean + - name: current-location + in: query + description: Indicates whether an active location retrieval has to be initiated by the +requested node + schema: + type: boolean + - name: rat-type + in: query + description: Indicates whether RAT Type retrieval is requested + schema: + type: boolean + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +``` + +``` + +- name: private-identity + in: query + description: IMS Private Identity + schema: + $ref: '#/components/schemas/PrivateId' +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/PsLocation' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/access-data/cs-domain/location-data: + get: + summary: Retrieve the location data in CS domain + operationId: GetLocCsDomain + tags: + - CS location retrieval + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:cs-domain:location-data:read + parameters: + - name: imsUeId + in: path + description: IMS Public Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: serving-node + in: query + description: Indicates that only the stored NF id/address of the serving node(s) is +required + schema: + $ref: '#/components/schemas/ServingNode' + - name: local-time + in: query + description: Indicates that only the Local Time Zone information of the location in the +visited network where the UE is attached is requested + schema: + $ref: '#/components/schemas/LocalTime' + - name: current-location + in: query + description: Indicates whether an active location retrieval has to be initiated by the +requested node + schema: + $ref: '#/components/schemas/CurrentLocation' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: private-identity + in: query + description: IMS Private Identity + schema: + $ref: '#/components/schemas/PrivateId' + responses: + +``` + +``` +'200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/CsLocation' +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +/{imsUeId}/repository-data/{serviceIndication}: + put: + summary: Update the repository data associated to an IMPU and service indication + operationId: UpdateRepositoryDataServInd + tags: + - Update repository data + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:repository-data:modify + parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: serviceIndication + in: path + description: Identifier of a service related data + required: true + schema: + $ref: '#/components/schemas/ServiceIndication' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RepositoryData' + required: true + responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/RepositoryData' + headers: + Location: + description: 'Contains the URI of the newly created resource, according to the +structure: {apiRoot}/nhss-ims-sdm/v1/{imsUeId}/repository-data/{serviceIndication}' + required: true + schema: + type: string + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/RepositoryData' + '204': + description: No content + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +``` + +``` +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'409': + $ref: 'TS29571_CommonData.yaml#/components/responses/409' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error +delete: + summary: delete the Repository Data for a Service Indication + operationId: DeleteRepositoryDataServInd + tags: + - Delete repository data + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:repository-data:modify + parameters: + - name: imsUeId + in: path + description: Identifier of the UE + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: serviceIndication + in: path + description: Identifier of a service related data + required: true + schema: + $ref: '#/components/schemas/ServiceIndication' + responses: + '204': + description: Expected response to a valid request + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +get: + summary: Retrieve the repository data associated to an IMPU and service indication + operationId: GetRepositoryDataServInd + tags: + - Repository data + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:repository-data:read + parameters: + - name: supported-features + in: query + description: Supported Features +``` + +``` + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: serviceIndication + in: path + description: Identifier of a service related data + required: true + schema: + $ref: '#/components/schemas/ServiceIndication' +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/RepositoryData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/identities/msisdns: + get: + summary: retrieve the Msisdns associated to requested identity + operationId: GetMsisdns + tags: + - Retrieval of the associated Msisdns + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:identities:read + parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: private-id + in: query + description: Private identity + schema: + $ref: '#/components/schemas/PrivateId' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/MsisdnList' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +``` + +``` + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/identities/ims-associated-identities: + get: + summary: Retrieve the associated identities to the IMS public identity included in the service +request + operationId: GetImsAssocIds + tags: + - Retrieval of associated IMS public identities + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:identities:read + parameters: + - name: imsUeId + in: path + description: IMS Public Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ImsAssociatedIdentities' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/identities/private-identities: + get: + summary: Retrieve the associated private identities to the IMS public identity included in the +service request + operationId: GetImsPrivateIds + tags: + - Retrieval of associated IMS private identities + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:identities:read + parameters: + - name: imsUeId + in: path + description: IMS Public Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: supported-features + in: query + description: Supported Features +``` + +``` + + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +- name: impi + in: query + description: Private Identity of type IMPI + schema: + $ref: '#/components/schemas/PrivateId' +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/PrivateIdentities' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/srvcc-data: + get: + summary: Retrieve the srvcc data + operationId: GetSrvccData + tags: + - Retrieval of UE SRVCC capability and STN-SR + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:srvcc:read + parameters: + - name: imsUeId + in: path + description: IMS Public Identity or IMS Private Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: private-identity + in: query + description: IMS Private Identity + schema: + $ref: '#/components/schemas/PrivateId' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SrvccData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +``` + +``` +patch: + summary: Patch + operationId: UpdateSrvccData + tags: + - Update SRVCC data + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:srvcc:modify + parameters: + - name: imsUeId + in: path + description: IMS Public Identity or IMS Private Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: private-identity + in: query + description: IMS Private Identity + schema: + $ref: '#/components/schemas/PrivateId' + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + minItems: 1 + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '204': + description: Successful response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + default: + description: Unexpected error + +/{imsUeId}/service-data/psi-status: + get: + summary: Retrieve the PSI activation state data + operationId: GetPsiState + tags: + - Retrieval of PSI activation state + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:psi-status:read + parameters: + - name: imsUeId + in: path + description: IMS Private Identity + required: true + schema: +``` + +``` + $ref: '#/components/schemas/ImsUeId' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/PsiActivationState' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +patch: + summary: Patch + operationId: UpdatePsiState + tags: + - Update PSI state data + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:psi-status:modify + parameters: + - name: imsUeId + in: path + description: IMS Public Service Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + minItems: 1 + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '204': + description: Successful response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +``` + +``` +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +default: + description: Unexpected error + +/{imsUeId}/service-data/dsai: + get: + summary: Retrieve the DSAI information associated to an Application Server + operationId: GetDsaiInfo + tags: + - DSAI registration information + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:dsai:read + parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: application-server-name + in: query + description: SIP URI of the Application Server Name + required: true + schema: + $ref: '#/components/schemas/SipServerName' + - name: dsai-tag + in: query + description: The requested instance of Dynamic Service Activation Info + schema: + type: string + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/DsaiTagInformation' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + + patch: + summary: Patch + operationId: UpdateDsaiState + tags: + - Update Dsai State + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:dsai:modify + parameters: +``` + +``` +- name: imsUeId + in: path + description: IMS Public Service Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' +- name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + minItems: 1 + required: true +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '204': + description: Successful response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + default: + description: Unexpected error + +/{imsUeId}/service-data/sms-registration-info: + put: + summary: Update the SMS registration information associated to a user + operationId: UpdateSmsRegistrationInfo + tags: + - Update SMS registration info + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:sms-registration-info:modify + parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: private-identity + in: query + description: IMS Private Identity + schema: + $ref: '#/components/schemas/PrivateId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/IpSmGwAddress' + required: true + responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/SmsRegistrationInfo' +``` + +``` +headers: + Location: + description: 'Contains the URI of the newly created resource, according to the +structure: {apiRoot}/nhss-ims-sdm/v1/{imsUeId}/service-data/sms-registration-info' + required: true + schema: + type: string +'200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/SmsRegistrationInfo' +'204': + description: No content +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'409': + $ref: 'TS29571_CommonData.yaml#/components/responses/409' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error +delete: + summary: delete the SMS registration information + operationId: DeleteSmsRegistrationInfo + tags: + - Delete SMS registration information + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:sms-registration-info:modify + parameters: + - name: imsUeId + in: path + description: Identifier of the UE + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: private-identity + in: query + description: IMS Private Identity + schema: + $ref: '#/components/schemas/PrivateId' + responses: + '204': + description: Expected response to a valid request + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +``` + +``` +get: + summary: Retrieve the SMS registration information associated to a user + operationId: GetSmsRegistrationInfo + tags: + - SMS registration information + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:sms-registration-info:read + parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: private-identity + in: query + description: IMS Private Identity + schema: + $ref: '#/components/schemas/PrivateId' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SmsRegistrationInfo' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/identities/imeisv: + get: + summary: Retrieve the IMEISV information + operationId: GetIMEISVInfo + tags: + - IMEISV Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:identities:read + parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: private-identity + in: query + description: IMS Private Identity + schema: + $ref: '#/components/schemas/PrivateId' + responses: + '200': + description: Expected response to a valid request + content: + application/json: +``` + +``` + schema: + $ref: '#/components/schemas/ImeiSvInformation' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/access-data/ps-domain/ip-address: + get: + summary: Retrieve the IP address information + operationId: GetIpAddressInfo + tags: + - IP address Info Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:ps-domain:ip-address:read + parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/IpAddress' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/access-data/ps-domain/tads-info: + get: + summary: Retrieve the T-ADS information + operationId: GetTadsInfo + tags: + - TADS Info Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:ps-domain:tads-info:read + parameters: + - name: imsUeId +``` + +``` + + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: private-identity + in: query + description: IMS Private Identity + schema: + $ref: '#/components/schemas/PrivateId' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/TadsInformation' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/access-data/ps-domain/ue-reach-subscriptions: + post: + summary: subscribe to notifications of UE reachability + operationId: UeReachIpSubscribe + tags: + - UE IP reachability Subscription Creation + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:ps-domain:ue-reach-subscriptions:create + parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: private-identity + in: query + description: IMS Private Identity + schema: + $ref: '#/components/schemas/PrivateId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UeReachabilitySubscription' + required: true + responses: + '201': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/CreatedUeReachabilitySubscription' + headers: + Location: + description: 'Contains the URI of the newly created resource, according to the +structure: {apiRoot}/nhss-ims-sdm//{imsUeId}/access-data/ps-domain/ue-reach- +subscriptions/{subscriptionId}' + required: true + +``` + +``` + + schema: + type: string + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + callbacks: + ueReachabilityNotification: + '{request.body#/callbackReference}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UeReachabilityNotification' + responses: + '204': + description: Successful Notification response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +/{imsUeId}/access-data/ps-domain/ue-reach-subscriptions/{subscriptionId}: + delete: + summary: unsubscribe from notifications to UE reachability + operationId: UeReachUnsubscribe + tags: + - Reachability Subscription Deletion + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:ps-domain:ue-reach-subscriptions:modify + parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: subscriptionId + in: path + description: Id of the Subscription + required: true + schema: + type: string + - name: private-identity + in: query + description: IMS Private Identity + schema: + $ref: '#/components/schemas/PrivateId' + responses: + +``` + +``` +'204': + description: Successful response +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error +patch: + summary: modify the subscription + operationId: UeReachSubsModify + tags: + - Reachability Subscription Modification + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:ps-domain:ue-reach-subscriptions:modify + parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: subscriptionId + in: path + description: Id of the Subscription + required: true + schema: + type: string + - name: private-identity + in: query + description: IMS Private Identity + schema: + $ref: '#/components/schemas/PrivateId' + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + minItems: 1 + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/UpdatedUeReachabilitySubscription' + '204': + description: Successful modification + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +``` + +``` + default: + description: Unexpected error + +/{imsUeId}/access-data/ps-domain/user-state: + get: + summary: Retrieve the user state information in PS domain + operationId: GetPsUserStateInfo + tags: + - PS User State Info Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:ps-domain:user-state:read + parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: requested-nodes + in: query + description: Indicates the serving node(s) for which the request is applicable. + style: form + explode: false + schema: + type: array + items: + $ref: '#/components/schemas/RequestedNode' + minItems: 1 + - name: private-identity + in: query + description: IMS Private Identity + schema: + $ref: '#/components/schemas/PrivateId' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/PsUserState' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/access-data/cs-domain/user-state: + get: + summary: Retrieve the user state information in CS domain + operationId: GetCsUserStateInfo + tags: + - CS User State Info Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:cs-domain:user-state:read + parameters: + - name: imsUeId + in: path +``` + +``` + + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: private-identity + in: query + description: IMS Private Identity + schema: + $ref: '#/components/schemas/PrivateId' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/CsUserState' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/access-data/cs-domain/csrn: + get: + summary: Retrieve the routeing number in CS domain + operationId: GetCsrn + tags: + - CSRN retrieval + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:cs-domain:csrn:read + parameters: + - name: imsUeId + in: path + description: IMS Public Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: pre-paging + in: query + description: Indicates pre-paging support + schema: + $ref: '#/components/schemas/PrePaging' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: private-identity + in: query + description: IMS Private Identity + schema: + $ref: '#/components/schemas/PrivateId' + - name: call-reference-info + in: query + description: Indicates Call-Reference Number and AS-Number + content: + application/json: + schema: + $ref: '#/components/schemas/CallReferenceInfo' + responses: + '200': + description: Expected response to a valid request +``` + +``` +content: + application/json: + schema: + $ref: '#/components/schemas/Csrn' +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/access-data/wireline-domain/reference-location: + get: + summary: Retrieve the reference location information + operationId: GetReferenceLocationInfo + tags: + - Reference Location Info Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:wireline-domain:reference-location:read + parameters: + - name: imsUeId + in: path + description: IMS Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: private-identity + in: query + description: IMS Private Identity + schema: + $ref: '#/components/schemas/PrivateId' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ReferenceLocationInformation' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/subscriptions: + post: + summary: subscribe to notifications +``` + +``` +operationId: ImsSdmSubscribe +tags: + - SDM Subscription Creation +security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:subscriptions:create +parameters: + - name: imsUeId + in: path + description: IMS Public Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' +requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ImsSdmSubscription' + required: true +responses: + '201': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ImsSdmSubscription' + headers: + Location: + description: 'Contains the URI of the newly created resource, according to the +structure: {apiRoot}/nhss-ims-sdm/{apiVersion}/{imsUeId}/subscriptions/{subscriptionId}' + required: true + schema: + type: string + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +callbacks: + datachangeNotification: + '{request.body#/callbackReference}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ModificationNotification' + responses: + '204': + description: Successful Notification response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +``` + +``` + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{imsUeId}/subscriptions/{subscriptionId}: + delete: + summary: unsubscribe from notifications + operationId: ImsSdmUnsubscribe + tags: + - SDM Subscription Deletion + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:subscription:modify + parameters: + - name: imsUeId + in: path + description: IMS Public Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: subscriptionId + in: path + description: Id of the Subscription + required: true + schema: + type: string + responses: + '204': + description: Successful response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + + patch: + summary: modify the subscription + operationId: ImsSdmSubsModify + tags: + - SDM Subscription Modification + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:subscription:modify + parameters: + - name: imsUeId + in: path + description: IMS Public Identity + required: true + schema: + $ref: '#/components/schemas/ImsUeId' + - name: subscriptionId + in: path + description: Id of the Subscription + required: true + schema: + type: string + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' +``` + +``` + minItems: 1 + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ImsSdmSubscription' + '204': + description: Successful modification + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/shared-data-subscriptions: + post: + summary: subscribe to notifications for shared data + operationId: SubscribeToSharedData + tags: + - Subscription Creation for shared data + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:shared-subscriptions:create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ImsSdmSubscription' + required: true + responses: + '201': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ImsSdmSubscription' + headers: + Location: + description: 'Contains the URI of the newly created resource, according to the +structure: {apiRoot}/nhss-ims-dm//shared-data-subscriptions/{subscriptionId}' + required: true + schema: + type: string + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + callbacks: + datachangeNotification: + '{request.body#/callbackReference}': + post: + requestBody: + required: true + content: +``` + +``` + application/json: + schema: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ModificationNotification' + responses: + '204': + description: Successful Notification response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/shared-data-subscriptions/{subscriptionId}: + delete: + summary: unsubscribe from notifications for shared data + operationId: UnsubscribeForSharedData + tags: + - Subscription Deletion for shared data + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:shared-subscription:modify + parameters: + - name: subscriptionId + in: path + description: Id of the Shared data Subscription + required: true + schema: + type: string + responses: + '204': + description: Successful response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + patch: + summary: modify the subscription + operationId: ModifySharedDataSubs + tags: + - Subscription Modification + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:shared-subscription:modify + parameters: + - name: subscriptionId + in: path + description: Id of the SDM Subscription + required: true + schema: + type: string + requestBody: +``` + +``` +content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + minItems: 1 + required: true +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ImsSdmSubscription' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/shared-data: + get: + summary: retrieve shared data + operationId: GetSharedData + tags: + - Retrieval of shared data + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-sdm + - oAuth2ClientCredentials: + - nhss-ims-sdm + - nhss-ims-sdm:shared-data:read + parameters: + - name: shared-data-ids + in: query + description: List of shared data ids + required: true + style: form + explode: false + schema: + type: array + items: + $ref: '#/components/schemas/SharedDataId' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/SharedData' + minItems: 1 + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +``` + +``` + + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nhss-ims-sdm: Access to the Nhss IMS Subscription Data Management API + nhss-ims-sdm:registration-status:read: Access to read the Registration Status resource + nhss-ims-sdm:profile-data:read: Access to read the Profile Data resource + nhss-ims-sdm:priority-levels:read: Access to read the Priority Levels resource + nhss-ims-sdm:ifcs:read: Access to read the Initial Filter Criteria resource + nhss-ims-sdm:service-level-trace-information:read: Access to read the Service Level Trace Information resource + nhss-ims-sdm:server-name:read: Access to read the Server Name resource + nhss-ims-sdm:scscf-capabilities:read: Access to read the S-CSCF Capabilities resource + nhss-ims-sdm:ps-domain:location-data:read: Access to read the PS-Domain Location Data resource + nhss-ims-sdm:ps-domain:ip-address:read: Access to read the PS-Domain IP Address resource + nhss-ims-sdm:ps-domain:tads-info:read: Access to read the PS-Domain TADS Info resource + nhss-ims-sdm:ps-domain:ue-reach-subscriptions:create: Access to create PS-Domain UE Reachability Subscriptions resources + nhss-ims-sdm:ps-domain:ue-reach-subscriptions:modify: Access to update/delete a PS-Domain UE Reachability Subscription resource + nhss-ims-sdm:ps-domain:user-state:read: Access to read the PS-Domain User State resource + nhss-ims-sdm:cs-domain:location-data:read: Access to read the CS-Domain Location Data resource + nhss-ims-sdm:cs-domain:user-state:read: Access to read the CS-Domain User State resource + nhss-ims-sdm:cs-domain:csrn:read: Access to read the CS-Domain CSRN resource + nhss-ims-sdm:wireline-domain:reference-location:read: Access to read the Wireline-Domain Reference Location resource + nhss-ims-sdm:repository-data:modify: Access to create/update/delete the Repository Data resource + nhss-ims-sdm:repository-data:read: Access to read the Repository Data resource + nhss-ims-sdm:identities:read: Access to read the Identities resource + nhss-ims-sdm:srvcc:read: Access to read the SRVCC resource + nhss-ims-sdm:srvcc:modify: Acess to update the SRVCC resource + nhss-ims-sdm:psi-status:read: Access to read the PSI Status resource + nhss-ims-sdm:psi-status:modify: Acess to update the PSI Status resource + nhss-ims-sdm:dsai:read: Access to read the DSAI resource + nhss-ims-sdm:dsai:modify: Acess to update the DSAI resource + nhss-ims-sdm:sms-registration-info:read: Access to read the SMS Registration Info resource + nhss-ims-sdm:sms-registration-info:modify: Acess to create/update/delete the SMS Registration Info resource + nhss-ims-sdm:subscriptions:create: Access to create Subscriptions resources + nhss-ims-sdm:subscription:modify: Access to update/delete a Subscription resource + nhss-ims-sdm:shared-subscriptions:create: Access to create a Shared-Data Subscriptions resource + nhss-ims-sdm:shared-subscription:modify: Access to update/delete a Shared-Data Subscription resource + nhss-ims-sdm:shared-data:read: Access to read the Shared-Data resource + nhss-ims-sdm:charging-info:read: Access to read the ChargingInfo resource + + schemas: + +# COMPLEX TYPES: + + ScscfCapabilityList: + type: object + properties: + mandatoryCapabilityList: + $ref: '#/components/schemas/Capabilities' + optionalCapabilityList: + $ref: '#/components/schemas/Capabilities' + anyOf: + - required: [mandatoryCapabilityList] + - required: [optionalCapabilityList] + + Capabilities: + type: array + items: + $ref: '#/components/schemas/Capability' +``` + +``` +minItems: 1 +uniqueItems: true + +RepositoryData: + type: object + required: + - serviceData + - sequenceNumber + properties: + sequenceNumber: + $ref: '#/components/schemas/SequenceNumber' + serviceData: + type: string + format: byte + +MsisdnList: + type: object + required: + - basicMsisdn + properties: + basicMsisdn: + $ref: '#/components/schemas/Msisdn' + additionalMsisdns: + type: array + minItems: 1 + items: + $ref: '#/components/schemas/Msisdn' + +PublicIdentities: + type: object + required: + - publicIdentities + properties: + publicIdentities: + type: array + items: + $ref: '#/components/schemas/PublicIdentity' + minItems: 1 + uniqueItems: true + +PrivateIdentities: + type: object + required: + - privateIdentities + properties: + privateIdentities: + type: array + items: + $ref: '#/components/schemas/PrivateIdentity' + minItems: 1 + uniqueItems: true + +PublicIdentity: + type: object + required: + - imsPublicId + - identityType + properties: + imsPublicId: + $ref: '#/components/schemas/ImsPublicId' + identityType: + $ref: '#/components/schemas/IdentityType' + irsIsDefault: + type: boolean + aliasGroupId: + type: string + +PrivateIdentity: + type: object + required: + - privateIdentity + - privateIdentityType + properties: + privateIdentity: + $ref: '#/components/schemas/PrivateId' + privateIdentityType: + $ref: '#/components/schemas/PrivateIdentityType' +``` + +``` +ImsAssociatedIdentities: + type: object + required: + - irsState + - publicIdentities + properties: + irsState: + $ref: '#/components/schemas/ImsRegistrationState' + publicIdentities: + $ref: '#/components/schemas/PublicIdentities' + +ImsSdmSubscription: + type: object + required: + - nfInstanceId + - callbackReference + - monitoredResourceUris + properties: + nfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + callbackReference: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + monitoredResourceUris: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + minItems: 1 + expires: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + +ImsRegistrationStatus: + type: object + required: + - imsUserStatus + properties: + imsUserStatus: + $ref: '#/components/schemas/ImsRegistrationState' + +PriorityLevels: + type: object + required: + - servicePriorityLevelList + properties: + servicePriorityLevelList: + type: array + items: + $ref: '#/components/schemas/NameSpacePriority' + minItems: 1 + uniqueItems: true + +Ifcs: + type: object + properties: + ifcList: + type: array + items: + $ref: '#/components/schemas/Ifc' + minItems: 1 + cscfFilterSetIdList: + type: array + items: + $ref: '#/components/schemas/CscfFilterSetId' + minItems: 1 + anyOf: + - required: [ ifcList ] + - required: [ cscfFilterSetIdList ] + +Ifc: + type: object + required: + - priority + - appServer + properties: + priority: + type: integer + minimum: 1 + trigger: + $ref: '#/components/schemas/TriggerPoint' +``` + +``` +appServer: + $ref: '#/components/schemas/ApplicationServer' + +TriggerPoint: + type: object + required: + - conditionType + - sptList + properties: + conditionType: + $ref: '#/components/schemas/TypeOfCondition' + sptList: + type: array + items: + $ref: '#/components/schemas/Spt' + minItems: 1 + +Spt: + type: object + required: + - conditionNegated + - sptGroup + properties: + conditionNegated: + type: boolean + sptGroup: + type: array + items: + $ref: '#/components/schemas/SptGroupId' + minItems: 1 + regType: + items: + $ref: '#/components/schemas/RegistrationType' + minItems: 1 + maxItems: 2 + requestUri: + type: string + sipMethod: + type: string + sipHeader: + $ref: '#/components/schemas/HeaderSipRequest' + sessionCase: + $ref: '#/components/schemas/RequestDirection' + sessionDescription: + $ref: '#/components/schemas/SdpDescription' + +HeaderSipRequest: + type: object + required: + - header + properties: + header: + type: string + content: + type: string + +SdpDescription: + type: object + required: + - line + properties: + line: + type: string + content: + type: string + +ApplicationServer: + type: object + required: + - asUri + properties: + asUri: + type: string + sessionContinue: + type: boolean + serviceInfoList: + type: array + items: +``` + +``` + $ref: '#/components/schemas/ServiceInformation' + minItems: 1 + +ImsLocationData: + type: object + required: + - scscfName + properties: + scscfName: + type: string + +PsLocation: + type: object + oneOf: + - required: + - sgsnLocationData + - required: + - mmeLocationData + - required: + - amfLocationData + - required: + - twanLocationData + properties: + sgsnLocationData: + $ref: '#/components/schemas/SgsnLocationData' + mmeLocationData: + $ref: '#/components/schemas/MmeLocationData' + amfLocationData: + $ref: '#/components/schemas/AmfLocationData' + twanLocationData: + $ref: '#/components/schemas/TwanLocationData' + +SgsnLocationData: + type: object + required: + - sgsnNumber + - plmnId + properties: + sgsnNumber: + type: string + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + sgsnLocation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UtraLocation' + csgInformation: + $ref: '#/components/schemas/CsgInformation' + timeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' + ratType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + +MmeLocationData: + type: object + required: + - mmeAddress + - plmnId + properties: + mmeAddress: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + mmeLocation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/EutraLocation' + csgInformation: + $ref: '#/components/schemas/CsgInformation' + timeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' + ratType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + +AmfLocationData: + type: object + required: + - amfAddress + - plmnId + properties: + amfAddress: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' +``` + +``` +plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' +amfLocation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NrLocation' +smssfAddress: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' +timeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' +ratType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + +TwanLocationData: + type: object + required: + - twanSsid + - plmnId + properties: + twanSsid: + type: string + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + twanBssid: + type: string + civicAddress: + type: string + format: byte + twanOperatorName: + type: string + timeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' + logicalAccessId: + type: string + +CsLocation: + type: object + required: + - mscNumber + - vlrNumber + - plmnId + properties: + mscNumber: + type: string + vlrNumber: + type: string + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + vlrLocation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GeraLocation' + csgInformation: + $ref: '#/components/schemas/CsgInformation' + timeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' + eUtranCgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi' + tai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + +CsgInformation: + type: object + required: + - csgId + properties: + csgId: + type: string + format: byte + accessMode: + type: string + format: byte + cMi: + type: boolean + +SrvccData: + type: object + required: + - stnSr + properties: + stnSr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/StnSr' +``` + +``` +ueSrvccCapabilities: + type: array + items: + $ref: '#/components/schemas/SrvccCapability' + minItems: 1 + uniqueItems: true + +PsiActivationState: + type: object + required: + - activationState + properties: + activationState: + $ref: '#/components/schemas/ActivationState' + +SharedData: + type: object + required: + - sharedDataId + properties: + sharedDataId: + $ref: '#/components/schemas/SharedDataId' + sharedImsiIfcData: + $ref: '#/components/schemas/Ifcs' + minProperties: 1 + +ImsProfileData: + type: object + required: + - imsServiceProfiles + properties: + imsServiceProfiles: + type: array + items: + $ref: '#/components/schemas/ImsServiceProfile' + chargingInfo: + $ref: '#/components/schemas/ChargingInfo' + serviceLevelTraceInfo: + $ref: '#/components/schemas/ServiceLevelTraceInformation' + servicePriorityLevelList: + type: array + items: + $ref: '#/components/schemas/NameSpacePriority' + minItems: 1 + uniqueItems: true + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + maxAllowedSimulReg: + type: integer + +ImsServiceProfile: + type: object + required: + - publicIdentifierList + properties: + publicIdentifierList: + type: array + items: + $ref: '#/components/schemas/PublicIdentifier' + ifcs: + $ref: '#/components/schemas/Ifcs' + +PublicIdentifier: + type: object + required: + - publicIdentity + properties: + publicIdentity: + $ref: '#/components/schemas/PublicIdentity' + displayName: + type: string + imsServicePriority: + $ref: '#/components/schemas/PriorityLevels' + serviceLevelTraceInfo: + $ref: '#/components/schemas/ServiceLevelTraceInformation' + barringIndicator: + type: boolean + wildcardedImpu: +``` + +``` +type: string + +ServiceLevelTraceInformation: + type: object + properties: + serviceLevelTraceInfo: + type: string + +ImeiSvInformation: + type: object + oneOf: + - required: + - imei + - required: + - imeiSv + properties: + imei: + $ref: '#/components/schemas/Imei' + imeiSv: + $ref: '#/components/schemas/ImeiSv' + +IpAddress: + type: object + oneOf: + - required: + - ipv4Addr + - required: + - ipv6Addr + - required: + - ipv6Prefix + properties: + ipv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + ipv6Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + ipv6Prefix: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + +TadsInformation: + type: object + required: + - voiceOverPsSessionSupport + properties: + voiceOverPsSessionSupport: + $ref: '#/components/schemas/ImsVoiceOverPsSessionSupport' + accessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + ratType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + lastUeActivityTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + +UeReachabilitySubscription: + type: object + required: + - expiry + - callbackReference + properties: + expiry: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + callbackReference: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + +CreatedUeReachabilitySubscription: + type: object + required: + - expiry + properties: + expiry: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + +UpdatedUeReachabilitySubscription: + type: object + required: + - expiry + properties: + expiry: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +``` + +``` +UeReachabilityNotification: + type: object + required: + - reachabilityIndicator + - detectingNode + - accessType + properties: + reachabilityIndicator: + type: boolean + detectingNode: + $ref: '#/components/schemas/DetectingNode' + accessType: + $ref: '#/components/schemas/AccessType' + +PsUserState: + type: object + oneOf: + - required: + - sgsnUserState + - required: + - mmeUserState + - required: + - amfUserState + properties: + sgsnUserState: + $ref: '#/components/schemas/UserStatePs' + mmeUserState: + $ref: '#/components/schemas/UserStatePs' + amfUserState: + $ref: '#/components/schemas/UserStatePs' + +CsUserState: + type: object + required: + - mscVlrUserState + properties: + mscVlrUserState: + $ref: '#/components/schemas/UserStateCs' + +Csrn: + type: object + required: + - csrn + properties: + csrn: + $ref: '#/components/schemas/Msisdn' + +ReferenceLocationInformation: + type: object + properties: + accessType: + type: string + accessInfo: + type: string + accessValue: + type: string + anyOf: + - required: [accessType] + - required: [accessInfo] + - required: [accessValue] + +SmsRegistrationInfo: + type: object + required: + - ipSmGwNumber + properties: + ipSmGwNumber: + $ref: '#/components/schemas/Msisdn' + scAddress: + $ref: '#/components/schemas/Msisdn' + +IpSmGwAddress: + type: object + required: + - ipSmGwNumber + properties: + ipSmGwNumber: +``` + +``` +$ref: '#/components/schemas/Msisdn' +ipSmGwDiaUri: +$ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' +ipSmGwDiaRealm: +$ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' + +DsaiTagInformation: +type: object +required: +- dsaiTagStatusList +properties: +dsaiTagStatusList: +type: array +items: +$ref: '#/components/schemas/DsaiTagStatus' +minItems: 1 +uniqueItems: true + +DsaiTagStatus: +type: object +required: +- dsaiTag +- dsaiState +properties: +dsaiTag: +type: string +dsaiState: +$ref: '#/components/schemas/ActivationState' + +ScscfSelectionAssistanceInformation: +type: object +properties: +scscfCapabilityList: +$ref: '#/components/schemas/ScscfCapabilityList' +scscfNames: +type: array +items: +type: string +minItems: 1 +anyOf: +- required: [scscfCapabilityList] +- required: [scscfNames] + +ChargingInfo: +type: object +anyOf: +- required: +- primaryEventChargingFunctionName +- required: +- primaryChargingCollectionFunctionName +properties: +primaryEventChargingFunctionName: +$ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' +secondaryEventChargingFunctionName: +$ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' +primaryChargingCollectionFunctionName: +$ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' +secondaryChargingCollectionFunctionName: +$ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' + +CallReferenceInfo: +type: object +required: +- callRefNumber +- asNumber +properties: +callRefNumber: +type: string +format: byte +description: > +The content is according to CallReferenceNumber type described in 3GPP TS 29.002 [30]. +Base64 encoded according to IETF RFC 2045 [28] +asNumber: +type: string +format: byte +description: > +The content is according to ISDN-AddressString type described in 3GPP TS 29.002 [30]. +Base64 encoded according to IETF RFC 2045 [28] +``` + +``` + +DataSetNames: + type: array + items: + $ref: '#/components/schemas/DataSetName' + minItems: 1 + uniqueItems: true + +# SIMPLE TYPES: + +Capability: + type: integer + +ImsUserId: + type: string + pattern: '^(impu-sip\:( [a-zA-Z0-9_\-\.\!~*() &=+$, ;?\/\+] ) \@ ( [A-Za-z0-9] + ( [ -A-Za-z0-9] + ) \. ) + [a-z]{2,} | impu-tel\:\+[0-9]{5,15} | impi-\.\+\.\+\.)$' + +SequenceNumber: + type: integer + minimum: 0 + +ServiceIndication: + type: string + +Msisdn: + type: string + pattern: '[0-9]{5,15}$' + +PrivateId: + type: string + +ImsPublicId: + type: string + pattern: '^(sip\:( [a-zA-Z0-9_\-\.\!~*() &=+$, ;?\/\+] ) \@ ( [A-Za-z0-9] + ( [ -A-Za-z0-9] + ) \. ) + [a-z]{2,} | tel\:\+[0-9]{5,15})$' + +NameSpacePriority: + type: string + pattern: '^[0-9a-zA-Z-\!\%\*_\+\`\'\'~]+\.[0-9a-zA-Z-\!\%\*_\+\`\'\'~]+\+$' + +CscfFilterSetId: + type: integer + minimum: 0 + +SptGroupId: + type: integer + minimum: 0 + +ServingNode: + type: boolean + +LocalTime: + type: boolean + +CurrentLocation: + type: boolean + +SharedDataId: + type: string + pattern: '^[0-9]{5,6}-.\+$' + +Imei: + type: string + pattern: '^[0-9]{15}$' + +ImeiSv: + type: string + pattern: '^[0-9]{16}$' + +PrePaging: + type: boolean + +SipServerName: + type: string + pattern: '^(sip\:( [a-zA-Z0-9_\-\.\!~*() &=+$, ;?\/\+] ) \@ ( [A-Za-z0-9] + ( [ -A-Za-z0-9] + ) \. ) + [a-z]{2,})$' + +``` + +### # ENUMS: + +IdentityType: +anyOf: +- type: string +enum: +- DISTINCT\_IMPU +- DISTINCT\_PSI +- WILDCARDED\_IMPU +- WILDCARDED\_PSI +- type: string + +PrivateIdentityType: +anyOf: +- type: string +enum: +- IMPI +- IMSI +- type: string + +ImsRegistrationState: +anyOf: +- type: string +enum: +- REGISTERED +- NOT\_REGISTERED +- AUTHENTICATION\_PENDING +- REGISTERED\_UNREG\_SERVICES +- type: string + +TypeOfCondition: +anyOf: +- type: string +enum: +- CNF +- DNF +- type: string + +RegistrationType: +anyOf: +- type: string +enum: +- INITIAL\_REGISTRATION +- RE\_REGISTRATION +- DE\_REGISTRATION +- type: string + +RequestDirection: +anyOf: +- type: string +enum: +- ORIGINATING\_REGISTERED +- ORIGINATING\_UNREGISTERED +- ORIGINATING\_CDIV +- TERMINATING\_REGISTERED +- TERMINATING\_UNREGISTERED +- type: string + +ServiceInformation: +anyOf: +- type: string +enum: +- INCLUDE\_REGISTER\_REQUEST +- INCLUDE\_REGISTER\_RESPONSE +- type: string + +RequestedNode: +anyOf: +- type: string +enum: +- SGSN +- MME +- AMF +- 3GPP\_AAA\_SERVER\_TWAN +- type: string + +SrvccCapability: +anyOf: + +``` +- type: string +enum: +- UE_4G_SRVCC_CAPABLE +- UE_5G_SRVCC_CAPABLE +- type: string + +ActivationState: +anyOf: +- type: string +enum: +- ACTIVE +- INACTIVE +- type: string + +ImsVoiceOverPsSessionSupport: +anyOf: +- type: string +enum: +- IMS_VOICE_OVER_PS_NOT_SUPPORTED +- IMS_VOICE_OVER_PS_SUPPORTED +- IMS_VOICE_OVER_PS_SUPPORT_UNKNOWN +- type: string + +DetectingNode: +anyOf: +- type: string +enum: +- SGSN +- MME +- AMF +- type: string + +AccessType: +anyOf: +- type: string +enum: +- 3GPP_ACCESS +- NON_3GPP_ACCESS +- type: string + +UserStatePs: +anyOf: +- type: string +enum: +- DETACHED +- ATTACHED_NOT_REACHABLE_FOR_PAGING +- ATTACHED_REACHABLE_FOR_PAGING +- CONNECTED_NOT_REACHABLE_FOR_PAGING +- CONNECTED_REACHABLE_FOR_PAGING +- NOT_PROVIDED_FROM_SGSN_OR_MME_OR_AMF +- NETWORK_DETERMINED_NOT_REACHABLE +- type: string + +UserStateCs: +anyOf: +- type: string +enum: +- CAMEL_BUSY +- NETWORK_DETERMINED_NOT_REACHABLE +- ASSUMED_IDLE +- NOT_PROVIDED_FROM_VLR +- type: string + +DataSetName: +anyOf: +- type: string +enum: +- CHARGING_DATA +- IFC_DATA +- TRACE_DATA +- PRIORITY_DATA +- type: string +``` + +## A.4 Nhss\_imsUEAU API + +``` +openapi: 3.0.0 + +info: + version: '1.0.2' + title: 'Nhss_imsUEAU' + description: | + Nhss UE Authentication Service for IMS. + © 2021, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.562 HSS Services for Interworking with IMS, version 16.5.0 + url: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.562/' + +servers: + - url: '{apiRoot}/nhss-ims-ueau/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. + +security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-ueau + +paths: + + /{impi}/security-information/generate-sip-auth-data: + post: + summary: Generate authentication data for the UE based on the Auth-Scheme provided + operationId: GenerateSipAuthData + tags: + - Generate Auth Data + security: + - {} + - oAuth2ClientCredentials: + - nhss-ims-ueau + - oAuth2ClientCredentials: + - nhss-ims-ueau + - nhss-ims-ueau:generate-sip-auth-data:invoke + parameters: + - name: impi + in: path + description: IMS Private Identity for the UE (IMPI) + required: true + schema: + $ref: '#/components/schemas/Impi' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SipAuthenticationInfoRequest' + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SipAuthenticationInfoResult' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nhss-ims-ueau: Access to the Nhss IMS UE Authentication API + nhss-ims-ueau:generate-sip-auth-data:invoke: Access to invoke the Generate SIP Auth Data + custom operation + + schemas: + +# COMPLEX TYPES: + + SipAuthenticationInfoRequest: + type: object + required: + - cscfServerName + - sipAuthenticationScheme + properties: + cscfServerName: + type: string + sipAuthenticationScheme: + $ref: '#/components/schemas/SipAuthenticationScheme' + sipNumberAuthItems: + $ref: '#/components/schemas/SipNumberAuthItems' + resynchronizationInfo: + $ref: '#/components/schemas/ResynchronizationInfo' + + ResynchronizationInfo: + type: object + required: + - rand + - autos + properties: + rand: + $ref: 'TS29503_Nudm_UEAU.yaml#/components/schemas/Rand' + autos: + $ref: 'TS29503_Nudm_UEAU.yaml#/components/schemas/Auts' + + SipAuthenticationInfoResult: + type: object + required: + - impi + properties: + impi: + $ref: '#/components/schemas/Impi' + 3gAkaAvs: + type: array + items: + $ref: '#/components/schemas/3GAkaAv' + minItems: 1 + digestAuth: + $ref: '#/components/schemas/DigestAuthentication' + lineIdentifierList: + type: array + items: + $ref: '#/components/schemas/LineIdentifier' + minItems: 1 + ipAddress: + $ref: '#/components/schemas/IpAddress' + + 3GAkaAv: +``` + +``` +type: object +required: +- rand +- xres +- autn +- ck +- ik +properties: +rand: + $ref: 'TS29503_Nudm_UEAU.yaml#/components/schemas/Rand' +xres: + $ref: 'TS29503_Nudm_UEAU.yaml#/components/schemas/Xres' +autn: + $ref: 'TS29503_Nudm_UEAU.yaml#/components/schemas/Autn' +ck: + $ref: '#/components/schemas/Ck' +ik: + $ref: '#/components/schemas/Ik' + +DigestAuthentication: +type: object +required: +- digestRealm +- digestAlgorithm +- digestQop +- hal +properties: +digestRealm: +type: string +digestAlgorithm: + $ref: '#/components/schemas/SipDigestAlgorithm' +digestQop: + $ref: '#/components/schemas/SipDigestQop' +hal: +type: string + +IpAddress: +type: object +oneOf: +- required: +- ipv4Addr +- required: +- ipv6Addr +- required: +- ipv6Prefix +properties: +ipv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' +ipv6Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' +ipv6Prefix: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + +# SIMPLE TYPES: + +SipNumberAuthItems: +type: integer +minimum: 1 + +Impi: +type: string + +Ck: +type: string +pattern: '^[A-Fa-f0-9]{32}$' + +Ik: +type: string +pattern: '^[A-Fa-f0-9]{32}$' + +LineIdentifier: +type: string + +# ENUMS: + +SipAuthenticationScheme: +anyOf: +- type: string +``` + +``` +enum: + - DIGEST-AKAV1-MD5 + - DIGEST-HTTP + - NBA + - GIBA + - UNKNOWN +- type: string + +SipDigestAlgorithm: +anyOf: + - type: string + enum: + - MD5 + - MD5_SESS + - type: string + +SipDigestQop: +anyOf: + - type: string + enum: + - AUTH + - AUTH_INT + - type: string +``` + +# --- Annex B (informative): Withdrawn API versions + +## B.1 General + +This Annex lists withdrawn API versions of the APIs defined in the present specification. 3GPP TS 29.501 [5] clause 4.3.1.6 describes the withdrawal of API versions. + +# --- Annex C (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2019-09 | CT4#93 | C4-193851 | | | | Initial Draft (C4-193264) and incorporation of agreed pCRs at CT4#93: C4-193576, C4-193272, C4-193273, C4-193579, C4-193706, C4-193838. | 0.1.0 | +| 2019-10 | CT4#94 | C4-194525 | | | | Incorporation of agreed pCRs at CT4#94: C4-194361, C4-194362, C4-194364, C4-194365, C4-194556 | 0.2.0 | +| 2019-11 | CT4#95 | C4-195640 | | | | Incorporation of agreed pCRs at CT4#95: C4-195468, C4-195469, C4-195475, C4-195478, C4-195583, C4-195650 | 0.3.0 | +| 2020-03 | CT4#96 | C4-201270 | | | | Incorporation of agreed pCRs at CT4#96: C4-200572, C4-200578, C4-200582, C4-200803, C4-200804, C4-200927, C4-200929, C4-200963, C4-200977, C4-201098, C4-201104, C4-201105, C4-201106, C4-201107, C4-201108, C4-201109, C4-201110, C4-201111, C4-201112, C4-201113, C4-201114, C4-201115, C4-201116 | 0.4.0 | +| 2020-03 | CT#87 | CP-200064 | | | | TS presented for information and approval | 1.0.0 | +| 2020-03 | CT#87 | | | | | Approved at CT#87 | 16.0.0 | +| 2020-07 | CT#88 | CP-201038 | 0001 | - | B | IMEISV retrieval | 16.1.0 | +| 2020-07 | CT#88 | CP-201038 | 0002 | - | B | IP address retrieval | 16.1.0 | +| 2020-07 | CT#88 | CP-201038 | 0003 | - | B | T-ADS info retrieval | 16.1.0 | +| 2020-07 | CT#88 | CP-201038 | 0004 | - | B | UE Reachability subscription | 16.1.0 | +| 2020-07 | CT#88 | CP-201038 | 0005 | - | B | User State retrieval | 16.1.0 | +| 2020-07 | CT#88 | CP-201038 | 0006 | - | B | Storage of YAML files in ETSI Forge | 16.1.0 | +| 2020-07 | CT#88 | CP-201038 | 0007 | - | B | Resource-Level Authorization | 16.1.0 | +| 2020-07 | CT#88 | CP-201038 | 0008 | - | F | Common data structures in the response body | 16.1.0 | +| 2020-07 | CT#88 | CP-201038 | 0009 | - | B | CSRn retrieval | 16.1.0 | +| 2020-07 | CT#88 | CP-201038 | 0010 | 1 | B | Wireline domain info retrieval | 16.1.0 | +| 2020-07 | CT#88 | CP-201038 | 0011 | - | B | SDM SMS Registration Info | 16.1.0 | +| 2020-07 | CT#88 | CP-201038 | 0012 | 1 | F | Miscellaneous corrections | 16.1.0 | +| 2020-07 | CT#88 | CP-201038 | 0013 | 1 | F | IMS restoration amendments | 16.1.0 | +| 2020-07 | CT#88 | CP-201038 | 0014 | 1 | F | Support of Multiple Registration | 16.1.0 | +| 2020-07 | CT#88 | CP-201038 | 0015 | 2 | F | IMS Identity Data Retrieval amendments | 16.1.0 | +| 2020-07 | CT#88 | CP-201038 | 0016 | - | F | SDM Wireline-domain Line-Id Removal | 16.1.0 | +| 2020-07 | CT#88 | CP-201038 | 0017 | 1 | B | SDM - DSAI handling | 16.1.0 | +| 2020-07 | CT#88 | CP-201038 | 0018 | 1 | F | Cleanup of TS | 16.1.0 | +| 2020-07 | CT#88 | CP-201038 | 0019 | - | F | Miscellaneous Corrections | 16.1.0 | +| 2020-07 | CT#88 | CP-201073 | 0020 | - | F | 29.562 Rel-16 API version and External doc update | 16.1.0 | +| 2020-09 | CT#89 | CP-202118 | 0021 | - | F | P-CSCF Restoration | 16.2.0 | +| 2020-09 | CT#89 | CP-202118 | 0022 | - | F | Missing Resource Scopes | 16.2.0 | +| 2020-09 | CT#89 | CP-202118 | 0023 | 1 | F | IMS restoration amendments II | 16.2.0 | +| 2020-09 | CT#89 | CP-202118 | 0024 | - | F | Miscellaneous Corrections | 16.2.0 | +| 2020-09 | CT#89 | CP-202096 | 0025 | - | F | 29.562 Rel-16 API version and External doc update | 16.2.0 | +| 2020-12 | | | | | | Corrupted figures fixed | 16.2.1 | +| 2020-12 | CT#90 | CP-203053 | 0027 | - | F | Storage of YAML files in 3GPP Forge | 16.3.0 | +| 2020-12 | CT#90 | CP-203053 | 0028 | - | F | RAT type retrieval | 16.3.0 | +| 2020-12 | CT#90 | CP-203053 | 0029 | - | F | Resource ImsServerNameAndCapabilities | 16.3.0 | +| 2020-12 | CT#90 | CP-203053 | 0030 | - | F | S-CSCF Restoration | 16.3.0 | +| 2020-12 | CT#90 | CP-203053 | 0031 | 1 | F | S-CSCF Selection | 16.3.0 | +| 2020-12 | CT#90 | CP-203053 | 0032 | - | F | S-CSCF name | 16.3.0 | +| 2020-12 | CT#90 | CP-203053 | 0033 | - | F | Text alignment with yaml definitions | 16.3.0 | +| 2020-12 | CT#90 | CP-203053 | 0034 | - | F | Type name alignments | 16.3.0 | +| 2020-12 | CT#90 | CP-203053 | 0035 | - | F | UE-Reachability subscription | 16.3.0 | +| 2020-12 | CT#90 | CP-203066 | 0039 | 1 | F | Private identities | 16.3.0 | +| 2020-12 | CT#90 | CP-203067 | 0040 | 1 | F | Authorization Response | 16.3.0 | +| 2020-12 | CT#90 | CP-203036 | 0041 | - | F | 29.562 Rel-16 API version and External doc update | 16.3.0 | +| 2021-03 | CT#91 | CP-210038 | 0044 | - | F | Authorization Response | 16.4.0 | +| 2021-03 | CT#91 | CP-210054 | 0047 | - | F | 29.562 Rel-16 API version and External doc update | 16.4.0 | +| 2021-06 | CT#92 | CP-211060 | 0043 | 2 | F | Charging Information retrieval | 16.5.0 | +| 2021-06 | CT#92 | CP-211060 | 0048 | 1 | F | Alias Group Id | 16.5.0 | +| 2021-06 | CT#92 | CP-211060 | 0050 | 2 | F | IMSI retrieval | 16.5.0 | +| 2021-06 | CT#92 | CP-211060 | 0055 | - | F | Shared IMPU | 16.5.0 | +| 2021-06 | CT#92 | CP-211060 | 0058 | - | F | S-CSCF reselection in eIMS | 16.5.0 | +| 2021-06 | CT#92 | CP-211060 | 0060 | - | F | CSRn retrieval | 16.5.0 | +| 2021-06 | CT#92 | CP-211059 | 0062 | - | F | Redirect Responses | 16.5.0 | +| 2021-06 | CT#92 | CP-211060 | 0068 | 1 | F | Correction to schema of requested-nodes | 16.5.0 | +| 2021-06 | CT#92 | CP-211060 | 0069 | - | F | DSAI resource query parameters | 16.5.0 | +| 2021-06 | CT#92 | CP-211060 | 0070 | - | F | Initial Filter Criteria resource query parameter | 16.5.0 | +| 2021-06 | CT#92 | CP-211171 | 0071 | 1 | F | Correction to IMS User Profile | 16.5.0 | +| 2021-06 | CT#92 | CP-211073 | 0074 | - | F | 29.562 Rel-16 API version and External doc update | 16.5.0 | +| 2021-09 | CT#93 | CP-212066 | 0052 | 2 | F | Query parameter name alignment | 16.6.0 | +| 2021-09 | CT#93 | CP-212066 | 0077 | - | F | imsUeld pattern | 16.6.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|---|---------------------------------------------------|--------| +| 2021-09 | CT#93 | CP-212066 | 0081 | - | F | RequestedNodes data type definition | 16.6.0 | +| 2021-09 | CT#93 | CP-212080 | 0087 | - | F | 29.562 Rel-16 API version and External doc update | 16.6.0 | +| 2021-09 | CT#93 | CP-212066 | 0089 | - | F | Correction to shared IMPU | 16.6.0 | +| 2021-12 | CT#94 | CP-213132 | 0091 | - | F | Monitored resource URI | 16.7.0 | +| 2021-12 | CT#94 | CP-213132 | 0093 | - | F | Supported Feature | 16.7.0 | +| 2021-12 | CT#94 | CP-213146 | 0098 | - | F | 29.562 Rel-16 API version and External doc update | 16.7.0 | +| 2022-09 | CT#97 | CP-222060 | 0110 | - | F | Obvious yaml error correction | 16.8.0 | +| 2022-09 | CT#97 | CP-222060 | 0119 | - | F | CsLocation | 16.8.0 | +| 2022-09 | CT#97 | CP-222060 | 0121 | - | F | CallReferenceInfo | 16.8.0 | +| 2022-09 | CT#97 | CP-222072 | 0124 | - | F | 29.562 Rel-16 API version and External doc update | 16.8.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29563/0055c3ab42ae5f3af4a8c9399d401df5_img.jpg b/marked/Rel-16/29_series/29563/0055c3ab42ae5f3af4a8c9399d401df5_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4c669ff5f5e0b427475d1e852ea90568f9ee91d4 --- /dev/null +++ b/marked/Rel-16/29_series/29563/0055c3ab42ae5f3af4a8c9399d401df5_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4a4b8c0efc1a9a1a6502d9388437efa5c14b7d15691d799e7decce6c0089f332 +size 15346 diff --git a/marked/Rel-16/29_series/29563/2bc39576969969ffe6d3f3d5264bba75_img.jpg b/marked/Rel-16/29_series/29563/2bc39576969969ffe6d3f3d5264bba75_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..52fa280b0849a892c6c9141469456708f60dfc8e --- /dev/null +++ b/marked/Rel-16/29_series/29563/2bc39576969969ffe6d3f3d5264bba75_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:45fda5292a89c8b7a2bdf8beda5879da20872fb1d95d18c5249b40f56684a0da +size 28459 diff --git a/marked/Rel-16/29_series/29563/410562339ce067fdc6fa41940c118658_img.jpg b/marked/Rel-16/29_series/29563/410562339ce067fdc6fa41940c118658_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e0a4def8b00fb8ab6f0fa8705e83e37cd6057ec8 --- /dev/null +++ b/marked/Rel-16/29_series/29563/410562339ce067fdc6fa41940c118658_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d04eb06a545efc38c15e465c5643b471db3524b1d816e95b56ecceaa7dad5664 +size 37900 diff --git a/marked/Rel-16/29_series/29563/426efb7efdc753a13f2fa16f7bff9429_img.jpg b/marked/Rel-16/29_series/29563/426efb7efdc753a13f2fa16f7bff9429_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0c4e46604690bb0cbdfc73b6345efa8684620045 --- /dev/null +++ b/marked/Rel-16/29_series/29563/426efb7efdc753a13f2fa16f7bff9429_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9288cb41835187238e707ae1384db20fc3fd944b624ef6c28141574158f1da8d +size 32905 diff --git a/marked/Rel-16/29_series/29563/4356776ca004ecba5d599667a155d7d4_img.jpg b/marked/Rel-16/29_series/29563/4356776ca004ecba5d599667a155d7d4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3a834cab55e60d3d35365086d942c85096c328a1 --- /dev/null +++ b/marked/Rel-16/29_series/29563/4356776ca004ecba5d599667a155d7d4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5b99aa29700ec54a6c6f99c5deb2422476107fd4a07ac296880dea6156338ca0 +size 37233 diff --git a/marked/Rel-16/29_series/29563/4cde160bcc69b7b6c81b648dd0e4252e_img.jpg b/marked/Rel-16/29_series/29563/4cde160bcc69b7b6c81b648dd0e4252e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3e79c8ee1be40e08749605231ae3a3107c5356e4 --- /dev/null +++ b/marked/Rel-16/29_series/29563/4cde160bcc69b7b6c81b648dd0e4252e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:137f0825ef27edfade07007d7b99bbe8bef6a8ebafe720bb3e82fadaa7e2358e +size 20384 diff --git a/marked/Rel-16/29_series/29563/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-16/29_series/29563/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f080157cf133889f7c2a179554a7432e96e231e8 --- /dev/null +++ b/marked/Rel-16/29_series/29563/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d9cf2587660a8307675764fa5cb02db92bad1c263f4844c0a46982a4e821dce0 +size 7652 diff --git a/marked/Rel-16/29_series/29563/61a1c017e34df13360be6319539570df_img.jpg b/marked/Rel-16/29_series/29563/61a1c017e34df13360be6319539570df_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..999b7ad4a7f56f156f5e4558b04c86bf2e304e57 --- /dev/null +++ b/marked/Rel-16/29_series/29563/61a1c017e34df13360be6319539570df_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bff62d2e71b8d19bb435dcc5eca9ae144dc209dcb09e95c3403e25d6b47390c2 +size 29035 diff --git a/marked/Rel-16/29_series/29563/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-16/29_series/29563/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a875c1e967573c7cdf6b85cfbe651a0933fdc93e --- /dev/null +++ b/marked/Rel-16/29_series/29563/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b466e63ab430422b262fecde3d350d5d09624dfcc009901dfe9364e3272b6fba +size 5767 diff --git a/marked/Rel-16/29_series/29563/7d3d5fb5d09c0cd35a9d637be241651e_img.jpg b/marked/Rel-16/29_series/29563/7d3d5fb5d09c0cd35a9d637be241651e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..bd34532aa32ceac956d282f434bf5d75260917cc --- /dev/null +++ b/marked/Rel-16/29_series/29563/7d3d5fb5d09c0cd35a9d637be241651e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b5a391f9a806729409d0193c18cf2156877893dd7247716fa204ad0566dcbef2 +size 11644 diff --git a/marked/Rel-16/29_series/29563/8fa679f79a1bb1f527cba9f29e784e89_img.jpg b/marked/Rel-16/29_series/29563/8fa679f79a1bb1f527cba9f29e784e89_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..13651994aeb6d867d813a56293a39991d3fd323c --- /dev/null +++ b/marked/Rel-16/29_series/29563/8fa679f79a1bb1f527cba9f29e784e89_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:660b25e4e50eb7017e337a16a49557185f90b1ae2f6b18bb6e06f78de6769bcf +size 33199 diff --git a/marked/Rel-16/29_series/29563/95cd9f56a54683029052b8c644228506_img.jpg b/marked/Rel-16/29_series/29563/95cd9f56a54683029052b8c644228506_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d120fcd0c23bfcda01a8a9c20d9656e65f5c8db5 --- /dev/null +++ b/marked/Rel-16/29_series/29563/95cd9f56a54683029052b8c644228506_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7f690707daf7457bc6c7320e7519a0be09a329531c9471672f8fc4da4813136d +size 33070 diff --git a/marked/Rel-16/29_series/29563/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg b/marked/Rel-16/29_series/29563/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4420d409c68c5c64db72d84deaa176aa2eca2476 --- /dev/null +++ b/marked/Rel-16/29_series/29563/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c6ec6970f536ee3464994ba9f1db2c5bf386b439e4e648d525c7a12af9a0dae8 +size 32597 diff --git a/marked/Rel-16/29_series/29563/a97518a839da75f8379c578562b01bc2_img.jpg b/marked/Rel-16/29_series/29563/a97518a839da75f8379c578562b01bc2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d907d0fe80b58030c5494a8710d37e9f8248d243 --- /dev/null +++ b/marked/Rel-16/29_series/29563/a97518a839da75f8379c578562b01bc2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:db5d329e055ca33cdc3f2110b9f103a7e3b765e285c18ad9dd43a4cb29fd92f6 +size 17147 diff --git a/marked/Rel-16/29_series/29563/b3c108e7145f2017957569d06ea359cb_img.jpg b/marked/Rel-16/29_series/29563/b3c108e7145f2017957569d06ea359cb_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..11ebae928ec9c3948e4420b6bdf83cf3cbcb278f --- /dev/null +++ b/marked/Rel-16/29_series/29563/b3c108e7145f2017957569d06ea359cb_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:696c1620495905d3fb2442abe54e45082fe4f246d334dc261cdf19fc064e3078 +size 38022 diff --git a/marked/Rel-16/29_series/29563/d79d33da852cb7bca3e87b400a15c3e8_img.jpg b/marked/Rel-16/29_series/29563/d79d33da852cb7bca3e87b400a15c3e8_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3948ae1598fd9c6f7dbac2d305057e9911dc903b --- /dev/null +++ b/marked/Rel-16/29_series/29563/d79d33da852cb7bca3e87b400a15c3e8_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7fa8cde3100fdcb4fe43dbbc5eb978865f163b14b30d7aaba3b10dfca59e2a50 +size 34304 diff --git a/marked/Rel-16/29_series/29563/e6df2733626a85205c1db682e6259c46_img.jpg b/marked/Rel-16/29_series/29563/e6df2733626a85205c1db682e6259c46_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a21533ed61b85e0c1693b93963977de10a783abe --- /dev/null +++ b/marked/Rel-16/29_series/29563/e6df2733626a85205c1db682e6259c46_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6e2ae31c67438d76190cc9bd7406ea93784753c3ac7445fdd6b55134fc8a49ec +size 7971 diff --git a/marked/Rel-16/29_series/29563/ecad02fdc2408197e954e3e07feb350c_img.jpg b/marked/Rel-16/29_series/29563/ecad02fdc2408197e954e3e07feb350c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4529fce22d1949c61a76a9dd62c7ae081813a44c --- /dev/null +++ b/marked/Rel-16/29_series/29563/ecad02fdc2408197e954e3e07feb350c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6c0a6fd89e6dc4baf0e89d67f07369498970d120e3aec18d206e481b846a067d +size 31717 diff --git a/marked/Rel-16/29_series/29563/raw.md b/marked/Rel-16/29_series/29563/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..9274f5062805f82818cd8de3602a232e24241829 --- /dev/null +++ b/marked/Rel-16/29_series/29563/raw.md @@ -0,0 +1,3613 @@ + + +# 3GPP TS 29.563 V16.7.0 (2022-03) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Home Subscriber Server (HSS) services for interworking with Unified Data Management (UDM); Stage 3; (Release 16)** + +![5G logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The 5G logo, featuring the text "5G" in a bold, black, sans-serif font. Above the "5G" text are three green curved lines representing signal waves. + +5G logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, featuring the text "3GPP" in a stylized, bold, black, sans-serif font. Below the "3GPP" text are three red curved lines representing signal waves. + +3GPP logo + +A GLOBAL INITIATIVE + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + + + +## --- **Copyright Notification** + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTSTM is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|------------------------------------------------------------------|----| +| Foreword ..... | 7 | +| 1 Scope..... | 8 | +| 2 References..... | 8 | +| 3 Definitions of terms, symbols and abbreviations..... | 9 | +| 3.1 Terms..... | 9 | +| 3.2 Symbols..... | 9 | +| 3.3 Abbreviations ..... | 9 | +| 4 Overview..... | 9 | +| 4.1 Introduction ..... | 9 | +| 5 Services offered by the HSS ..... | 10 | +| 5.1 Introduction ..... | 10 | +| 5.2 Nhss_UEAuthentication Service..... | 10 | +| 5.2.1 Service Description ..... | 10 | +| 5.2.2 Service Operations..... | 10 | +| 5.2.2.1 Introduction..... | 10 | +| 5.2.2.2 Get..... | 11 | +| 5.2.2.2.1 General ..... | 11 | +| 5.2.2.2.2 Authentication Vector Retrieval..... | 11 | +| 5.3 Nhss_SubscriberDataManagement Service ..... | 11 | +| 5.3.1 Service Description ..... | 11 | +| 5.3.2 Service Operations..... | 12 | +| 5.3.2.1 Introduction..... | 12 | +| 5.3.2.2 Get..... | 12 | +| 5.3.2.2.1 General ..... | 12 | +| 5.3.2.2.2 UE Context In PGW Data Retrieval ..... | 12 | +| 5.3.2.3 Subscribe..... | 12 | +| 5.3.2.3.1 General ..... | 12 | +| 5.3.2.3.2 Subscription to notifications of data change ..... | 13 | +| 5.3.2.4 Unsubscribe ..... | 13 | +| 5.3.2.4.1 General ..... | 13 | +| 5.3.2.4.2 Unsubscribe to notifications of data change ..... | 13 | +| 5.3.2.5 Notification ..... | 14 | +| 5.3.2.5.1 General ..... | 14 | +| 5.3.2.5.2 Data Change Notification To NF ..... | 14 | +| 5.4 Nhss_UEContextManagement Service..... | 15 | +| 5.4.1 Service Description ..... | 15 | +| 5.4.2 Service Operations..... | 15 | +| 5.4.2.1 Introduction..... | 15 | +| 5.4.2.2 SnDeregistration ..... | 15 | +| 5.4.2.2.1 General ..... | 15 | +| 5.4.2.2.2 SN Deregistration..... | 15 | +| 5.4.2.2.3 IMEI Update..... | 16 | +| 5.5 Nhss_EventExposure Service ..... | 17 | +| 5.5.1 Service Description ..... | 17 | +| 5.5.2 Service Operations..... | 17 | +| 5.5.2.1 Introduction..... | 17 | +| 5.5.2.2 Subscribe..... | 17 | +| 5.5.2.2.1 General ..... | 17 | +| 5.5.2.2.2 Subscription to Notification of event occurrence..... | 17 | +| 5.5.2.3 Unsubscribe ..... | 18 | +| 5.5.2.3.1 General ..... | 18 | +| 5.5.2.3.2 Unsubscribe to notifications of event occurrence ..... | 18 | +| 5.5.2.4 Notify ..... | 19 | +| 5.5.2.4.1 General ..... | 19 | + +| | | | +|-------------|------------------------------------------------------|----| +| 5.5.2.4.2 | Event Occurrence Notification..... | 19 | +| 5.5.2.5 | ModifySubscription ..... | 20 | +| 5.5.2.5.1 | General ..... | 20 | +| 5.5.2.5.2 | Modification of a subscription ..... | 20 | +| 6 | API Definitions ..... | 20 | +| 6.1 | Nhss_UEAuthentication Service API ..... | 20 | +| 6.1.1 | Introduction ..... | 20 | +| 6.1.2 | Usage of HTTP..... | 21 | +| 6.1.2.1 | General..... | 21 | +| 6.1.2.2 | HTTP standard headers..... | 21 | +| 6.1.2.2.1 | General ..... | 21 | +| 6.1.2.2.2 | Content type ..... | 21 | +| 6.1.2.3 | HTTP custom headers..... | 21 | +| 6.1.2.3.1 | General ..... | 21 | +| 6.1.3 | Resources..... | 22 | +| 6.1.3.1 | Overview..... | 22 | +| 6.1.4 | Custom Operations without associated resources ..... | 22 | +| 6.1.4.1 | Overview..... | 22 | +| 6.1.4.2 | Operation: Generate AV ..... | 22 | +| 6.1.4.2.1 | Description ..... | 22 | +| 6.1.4.2.2 | Operation Definition ..... | 22 | +| 6.1.5 | Notifications ..... | 23 | +| 6.1.6 | Data Model ..... | 23 | +| 6.1.6.1 | General..... | 23 | +| 6.1.6.2 | Structured data types..... | 24 | +| 6.1.6.2.1 | Introduction ..... | 24 | +| 6.1.6.2.2 | Type: AvGenerationRequest..... | 24 | +| 6.1.6.2.3 | Type: AvGenerationResponse..... | 24 | +| 6.1.6.3 | Simple data types and enumerations..... | 25 | +| 6.1.6.3.1 | Introduction ..... | 25 | +| 6.1.6.3.2 | Simple data types ..... | 25 | +| 6.1.7 | Error Handling..... | 25 | +| 6.1.7.1 | General..... | 25 | +| 6.1.7.2 | Protocol Errors ..... | 25 | +| 6.1.7.3 | Application Errors..... | 25 | +| 6.1.8 | Feature negotiation ..... | 25 | +| 6.2 | Nhss_SubscriberDataManagement Service API..... | 25 | +| 6.2.1 | API URI..... | 25 | +| 6.2.2 | Usage of HTTP..... | 26 | +| 6.2.2.1 | General..... | 26 | +| 6.2.2.2 | HTTP standard headers..... | 26 | +| 6.2.2.2.1 | General ..... | 26 | +| 6.2.2.2.2 | Content type ..... | 26 | +| 6.2.2.3 | HTTP custom headers..... | 26 | +| 6.2.2.3.1 | General ..... | 26 | +| 6.2.3 | Resources..... | 27 | +| 6.2.3.1 | Overview..... | 27 | +| 6.2.3.2 | Resource: UeContextInPgwData ..... | 27 | +| 6.2.3.2.1 | Description ..... | 27 | +| 6.2.3.2.2 | Resource Definition..... | 27 | +| 6.2.3.2.3 | Resource Standard Methods..... | 28 | +| 6.2.3.2.3.1 | GET ..... | 28 | +| 6.2.3.3 | Resource: Subscriptions..... | 29 | +| 6.2.3.3.1 | Description ..... | 29 | +| 6.2.3.3.2 | Resource Definition..... | 29 | +| 6.2.3.3.3 | Resource Standard Methods..... | 29 | +| 6.2.3.3.3.1 | POST ..... | 29 | +| 6.2.3.4 | Resource: Individual subscription ..... | 30 | +| 6.2.3.4.1 | Description ..... | 30 | +| 6.2.3.4.2 | Resource Definition..... | 31 | +| 6.2.3.4.3 | Resource Standard Methods..... | 31 | + +| | | | +|-------------|------------------------------------------------------|----| +| 6.2.3.4.3.1 | DELETE ..... | 31 | +| 6.2.3.4.3.2 | PATCH ..... | 32 | +| 6.2.5.1 | General ..... | 34 | +| 6.2.5.2 | Data Change Notification ..... | 34 | +| 6.2.6 | Data Model ..... | 35 | +| 6.2.6.1 | General ..... | 35 | +| 6.2.6.2 | Structured data types ..... | 35 | +| 6.2.6.2.1 | Introduction ..... | 35 | +| 6.2.6.2.2 | Type: UeContextInPgwData ..... | 36 | +| 6.2.6.2.3 | Type: SubscriptionData ..... | 36 | +| 6.2.6.2.4 | Type: SubscriptionDataSets ..... | 36 | +| 6.2.6.3 | Simple data types and enumerations ..... | 36 | +| 6.2.6.3.1 | Introduction ..... | 36 | +| 6.2.6.3.2 | Simple data types ..... | 37 | +| 6.2.7 | Error Handling ..... | 37 | +| 6.2.7.1 | General ..... | 37 | +| 6.2.7.2 | Protocol Errors ..... | 37 | +| 6.2.7.3 | Application Errors ..... | 37 | +| 6.2.8 | Feature Negotiation ..... | 37 | +| 6.3 | Nhss_UEContextManagement Service API ..... | 37 | +| 6.3.1 | Introduction ..... | 37 | +| 6.3.2 | Usage of HTTP ..... | 38 | +| 6.3.2.1 | General ..... | 38 | +| 6.3.2.2 | HTTP standard headers ..... | 38 | +| 6.3.2.2.1 | General ..... | 38 | +| 6.3.2.2.2 | Content type ..... | 38 | +| 6.3.2.3 | HTTP custom headers ..... | 38 | +| 6.3.2.3.1 | General ..... | 38 | +| 6.3.3 | Resources ..... | 38 | +| 6.3.3.1 | Overview ..... | 38 | +| 6.3.4 | Custom Operations without associated resources ..... | 39 | +| 6.3.4.1 | Overview ..... | 39 | +| 6.3.4.2 | Operation: deregister-sn ..... | 39 | +| 6.3.4.2.1 | Description ..... | 39 | +| 6.3.4.2.2 | Operation Definition ..... | 39 | +| 6.3.4.3 | Operation: imei-update ..... | 40 | +| 6.3.4.3.1 | Description ..... | 40 | +| 6.3.4.3.2 | Operation Definition ..... | 40 | +| 6.3.5 | Notifications ..... | 41 | +| 6.3.6 | Data Model ..... | 41 | +| 6.3.6.1 | General ..... | 41 | +| 6.3.6.2 | Structured data types ..... | 42 | +| 6.3.6.2.1 | Introduction ..... | 42 | +| 6.3.6.2.2 | Type: DeregistrationRequest ..... | 42 | +| 6.3.6.2.3 | Type: ImeiUpdateInfo ..... | 42 | +| 6.3.6.3 | Simple data types and enumerations ..... | 43 | +| 6.3.6.3.1 | Introduction ..... | 43 | +| 6.3.6.3.2 | Simple data types ..... | 43 | +| 6.3.6.3.3 | Enumeration: DeregistrationReason ..... | 43 | +| 6.3.7 | Error Handling ..... | 43 | +| 6.3.7.1 | General ..... | 43 | +| 6.3.7.2 | Protocol Errors ..... | 43 | +| 6.3.7.3 | Application Errors ..... | 43 | +| 6.3.8 | Feature Negotiation ..... | 44 | +| 6.4 | Nhss_EventExposure Service API ..... | 44 | +| 6.4.1 | API URI ..... | 44 | +| 6.4.2 | Usage of HTTP ..... | 44 | +| 6.4.2.1 | General ..... | 44 | +| 6.4.2.2 | HTTP standard headers ..... | 44 | +| 6.4.2.2.1 | General ..... | 44 | +| 6.4.2.2.2 | Content type ..... | 44 | +| 6.4.2.3 | HTTP custom headers ..... | 45 | + +| | | | +|------------------------------------------------------------|------------------------------------------------------|-----------| +| 6.4.2.3.1 | General ..... | 45 | +| 6.4.3 | Resources..... | 45 | +| 6.4.3.1 | Overview..... | 45 | +| 6.4.3.2 | Resource: EeSubscriptions (Collection) ..... | 45 | +| 6.4.3.2.1 | Description ..... | 45 | +| 6.4.3.2.2 | Resource Definition..... | 45 | +| 6.4.3.2.3 | Resource Standard Methods..... | 46 | +| 6.4.3.2.3.1 | POST ..... | 46 | +| 6.4.3.3 | Resource: Individual subscription (Document) ..... | 47 | +| 6.4.3.3.1 | Resource Definition..... | 47 | +| 6.4.3.3.2 | Resource Standard Methods..... | 48 | +| 6.4.3.3.2.1 | DELETE ..... | 48 | +| 6.4.3.3.2.2 | PATCH..... | 49 | +| 6.4.4 | Custom Operations without associated resources ..... | 50 | +| 6.4.5 | Notifications ..... | 51 | +| 6.4.5.1 | General..... | 51 | +| 6.4.5.2 | Event Occurrence Notification ..... | 51 | +| 6.4.6 | Data Model ..... | 52 | +| 6.4.6.1 | General..... | 52 | +| 6.4.6.2 | Structured data types..... | 53 | +| 6.4.6.2.1 | Introduction ..... | 53 | +| 6.4.6.2.2 | Type: EeSubscription ..... | 53 | +| 6.4.6.2.3 | Type: CreatedEeSubscription..... | 54 | +| 6.4.6.2.4 | Type: MonitoringConfiguration ..... | 54 | +| 6.4.6.2.5 | Type: MonitoringReport ..... | 55 | +| 6.4.6.2.6 | Type: Report..... | 55 | +| 6.4.6.2.7 | Type: ReportingOptions..... | 56 | +| 6.4.6.2.8 | Type: LocationReportingConfiguration..... | 56 | +| 6.4.6.2.9 | Type: ReachabilityForSmsReport ..... | 56 | +| 6.4.6.2.10 | Type: LossConnectivityConfiguration ..... | 57 | +| 6.4.6.2.11 | Type: ReachabilityForDataConfiguration..... | 57 | +| 6.4.6.2.12 | Type: PduSessionStatusCfg ..... | 57 | +| 6.4.6.2.13 | Type: ReachabilityForDataReport ..... | 57 | +| 6.4.6.3 | Simple data types and enumerations..... | 57 | +| 6.4.6.3.1 | Introduction ..... | 57 | +| 6.4.6.3.2 | Simple data types ..... | 57 | +| 6.4.6.3.3 | Enumeration: EventType..... | 58 | +| 6.4.6.3.4 | Enumeration: LocationAccuracy..... | 58 | +| 6.4.7 | Error Handling ..... | 58 | +| 6.4.7.1 | General..... | 58 | +| 6.4.7.2 | Protocol Errors ..... | 58 | +| 6.4.7.3 | Application Errors..... | 59 | +| 6.4.8 | Feature Negotiation ..... | 59 | +| 6.4.9 | Security ..... | 59 | +| Annex A (normative): OpenAPI specification..... | | 60 | +| A.1 | General ..... | 60 | +| A.2 | Nhss_UEAuthentication API ..... | 60 | +| A.3 | Nhss_SubscriberDataManagement API..... | 61 | +| A.4 | Nhss_UEContextManagement API..... | 65 | +| A.5 | Nhss_EE API..... | 67 | +| Annex B (informative): Withdrawn API versions ..... | | 72 | +| B.1 | General..... | 72 | +| Annex C (informative): Change history..... | | 73 | + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document specifies the stage 3 protocol, including message flows and API specification details, for the Nhss services, as part of the 5G Service-Based Architecture, offered by the HSS for interworking with the 5G UDM Network Function. + +The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]. + +The User Data Interworking, Coexistence and Migration stage 2 architecture and procedures are specified in 3GPP TS 23.632 [8]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] 3GPP TS 23.335: "User Data Convergence (UDC); Technical realization and information flows". +- [7] 3GPP TS 29.335: "User Data Convergence (UDC); User Data Repository Access Protocol over the Ud interface". +- [8] 3GPP TS 23.632: "User Data Interworking, Coexistence and Migration". +- [9] IETF RFC 7540: "Hypertext Transfer Protocol Version 2 (HTTP/2)". +- [10] OpenAPI Initiative, "OpenAPI 3.0.0 Specification", +- [11] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". + +- [12] IETF RFC 7807: "Problem Details for HTTP APIs". +- [13] 3GPP TS 29.503: "5G System; Unified Data Management Services; Stage 3". +- [14] 3GPP TR 21.900: "Technical Specification Group working methods". +- [15] 3GPP TS 23.003: "Numbering, addressing and identification". +- [16] 3GPP TS 29.303: "Domain Name System Procedures; Stage 3". +- [17] 3GPP TS 29.272: "Evolved Packet System; MME and SGSN Related Interfaces Based on Diameter Protocol". +- [18] 3GPP TS 23.682: "Architecture enhancements to facilitate communications with packet data networks and applications". +- [19] 3GPP TS 29.002: "Mobile Application Part (MAP) specification". + +# --- 3 Definitions of terms, symbols and abbreviations + +## 3.1 Terms + +Void. + +## 3.2 Symbols + +Void. + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|------|----------------------------| +| 5GC | 5G Core Network | +| HSS | Home Subscriber Server | +| JSON | Javascript Object Notation | +| SBI | Service Based Interface | +| UDM | Unified Data Management | +| UDR | Unified Data Repository | + +# --- 4 Overview + +## 4.1 Introduction + +Within the 5GC, the HSS offers services to the UDM via the Nhss service-based interface (see 3GPP TS 23.501 [2], 3GPP TS 23.502 [3] and 3GPP TS 23.632 [8]). + +Figure 4.1-1 provides the reference model in service-based interface representation with focus on the HSS. + +![Figure 4.1-1: Reference model – HSS. A diagram showing a UDM (User Data Management) block connected to an HSS (Home Subscriber Server) block via an interface labeled Nhss. The HSS block is highlighted in green.](e6df2733626a85205c1db682e6259c46_img.jpg) + +``` + +graph LR + UDM[UDM] --- Nhss((Nhss)) + Nhss --- HSS[HSS] + style HSS fill:#90EE90,stroke:#000 + +``` + +Figure 4.1-1: Reference model – HSS. A diagram showing a UDM (User Data Management) block connected to an HSS (Home Subscriber Server) block via an interface labeled Nhss. The HSS block is highlighted in green. + +Figure 4.1-1: Reference model – HSS + +# 5 Services offered by the HSS + +## 5.1 Introduction + +The HSS offers the following services via the Nhss interface: + +- Nhss\_UEAuthentication Service +- Nhss\_SubscriberDataManagement Service +- Nhss\_UEContextManagement service + +All scenarios shown in the following clauses assume that the HSS is stateful and stores information in local memory. However, the HSS may be stateless and stores information externally in the EPS-UDR. If so, the stateless HSS makes use of Ud interface as specified in 3GPP TS 23.335 [6] and 3GPP TS 29.335 [7] to retrieve required data from the EPS-UDR and store them locally before processing an incoming request. Processing the incoming request may then include updating data in the EPS-UDR or subscribing to data change notifications at the EPS-UDR by using the Ud interface. After processing the incoming request, the HSS may delete the locally stored data. + +Table 5.1-1 summarizes the corresponding APIs defined for this specification. + +Table 5.1-1: API Descriptions + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex | +|---------------------------------------|--------|--------------------------------|----------------------------|-----------|-------| +| Nhss_UEAuthentication Service | 6.1 | HSS UE Authentication Service | TS29563_Nhss_UEAU.yaml | nhss-ueau | A.2 | +| Nhss_SubscriberDataManagement Service | 6.2 | HSS Subscriber Data Management | TS29563_Nhss_SDM.yaml | nhss-sdm | A.3 | +| Nhss_UEContextManagement Service | 6.3 | HSS UE Context Management | TS29563_Nhss_UECM.yaml | nhss-uecm | A.4 | + +## 5.2 Nhss\_UEAuthentication Service + +### 5.2.1 Service Description + +The Nhss\_UEAuthentication service allows a NF consumer (UDM) to request calculation of a fresh Authentication Vector (AV) for 5G\_AKA or EAP\_AKA\_PRIME and provide the calculated AV to the requesting NF. + +### 5.2.2 Service Operations + +#### 5.2.2.1 Introduction + +For the Nhss\_UEAuthentication service the following service operation is defined: + +- Get + +The Nhss\_UEAuthentication service is used by the UDM to request the HSS to, calculate a fresh authentication vector (AV) for authentication the method 5G\_AKA or EAP\_AKA\_PRIME, and provide it to the UDM by means of the Get service operation. See 3GPP TS 23.632 [8] clause 4.2.2. + +#### 5.2.2.2 Get + +##### 5.2.2.2.1 General + +The following procedure using the Get service operation is supported: + +- Authentication Vector Retrieval + +##### 5.2.2.2.2 Authentication Vector Retrieval + +Figure 5.2.2.2.2-1 shows a scenario where the NF service consumer (UDM) retrieves an Authentication Vector for the UE from the HSS (see also 3GPP TS 23.632 [8] clause 4.2.2). The request contains the UE's identity (imsi), the serving network name, the authentication method (5G\_AKA or EAP\_AKA\_PRIME) and may contain resynchronization info. + +![Sequence diagram showing the interaction between an NF service consumer and an HSS for Authentication Vector Retrieval. The consumer sends a POST request with parameters (imsi, serving network name, authentication method, resync. info) to the HSS. The HSS responds with either a 200 OK containing the Authentication Vector, a 403 Forbidden, or a 3xx Redirect.](b3c108e7145f2017957569d06ea359cb_img.jpg) + +``` + +sequenceDiagram + participant NF as NF service consumer + participant HSS as HSS + Note right of NF: 1. POST .../generate-av +(imsi, serving network name, authentication method, resync. info) + NF->>HSS: Request + Note left of HSS: 2a. 200 OK (Authentication Vector) +2b. 403 Forbidden +2c. 3xx Redirect + HSS-->>NF: Response + +``` + +Sequence diagram showing the interaction between an NF service consumer and an HSS for Authentication Vector Retrieval. The consumer sends a POST request with parameters (imsi, serving network name, authentication method, resync. info) to the HSS. The HSS responds with either a 200 OK containing the Authentication Vector, a 403 Forbidden, or a 3xx Redirect. + +Figure 5.2.2.2.2-1: NF service consumer requesting an Authentication Vector + +1. The NF service consumer sends a POST request (custom method: generate-av) to the HSS. +- 2a. The HSS responds with "200 OK" with the message body containing the authentication vector. +- 2b. If the operation cannot be authorized due to e.g. UE does not have required subscription data, HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +## 5.3 Nhss\_SubscriberDataManagement Service + +### 5.3.1 Service Description + +This service is used to retrieve the subscriber data indicated by the requested data type from HSS. In this release, only the PGW-C+SMF FQDN for S5/S8 interface information is supported as requested data type. See 3GPP TS 23.632 [8], clause 6.1.4. + +### 5.3.2 Service Operations + +#### 5.3.2.1 Introduction + +For the Nhss\_SubscriberDataManagement service the following service operations are defined: + +- Get + +The Nhss\_SubscriberDataManagement service is used by Consumer NF (UDM) to retrieve the UE data from the HSS due to IRAT mobility. + +#### 5.3.2.2 Get + +##### 5.3.2.2.1 General + +The following procedure using the Get service operation is supported: + +- UE Context In PGW Data Retrieval + +##### 5.3.2.2.2 UE Context In PGW Data Retrieval + +Figure 5.3.2.2.2-1 shows a scenario where the NF service consumer (UDM) sends a request to the HSS to retrieve the UE's Context In PGW data. The request contains the UE's identity (which shall be an IMSI) and the requested information. + +![Sequence diagram showing the interaction between an NF service consumer and an HSS for requesting UE context in PGW data. The consumer sends a GET request to the HSS. The HSS responds with either a 200 OK (containing the data), a 404 Not Found, or a 3xx Redirect.](426efb7efdc753a13f2fa16f7bff9429_img.jpg) + +``` + +sequenceDiagram + participant NF as NF service consumer + participant HSS as HSS + Note left of NF: + NF->>HSS: 1. GET .../{ueid}/ue-context-in-pgw-data () + Note right of HSS: + HSS-->>NF: 2a. 200 OK (UeContextInPgwData) + Note right of HSS: + HSS-->>NF: 2b. 404 Not Found + Note right of HSS: + HSS-->>NF: 2c. 3xx Redirect + +``` + +Sequence diagram showing the interaction between an NF service consumer and an HSS for requesting UE context in PGW data. The consumer sends a GET request to the HSS. The HSS responds with either a 200 OK (containing the data), a 404 Not Found, or a 3xx Redirect. + +**Figure 5.3.2.2.2-1: Requesting a UE's Context in PGW Data** + +1. The NF service consumer (e.g. UDM) shall send a GET request to the resource representing the UE's Context In PGW Data. + +2a. On Success, the HSS shall respond with "200 OK" with the message body containing the UE's Context In PGW Data as relevant for the requesting NF service consumer. + +2b. If there is no valid data for the UE, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.3 Subscribe + +##### 5.3.2.3.1 General + +The following procedures using the Subscribe service operation are supported: + +- Subscription to notification of data change + +##### 5.3.2.3.2 Subscription to notifications of data change + +Figure 5.3.2.3.2-1 shows a scenario where the NF service consumer (e.g. UDM) sends a request to the HSS to subscribe to notifications of data change. The request contains a callback URI and the URI of the monitored resource. + +![Sequence diagram showing the interaction between an NF service consumer and an HSS for subscribing to notifications. The consumer sends a POST request to the HSS. The HSS responds with one of the following: 2a. 201 Created (SubscriptionData), 2b. 404 Not Found, 2c. 501 Not Implemented, or 2d. 3xx Redirect.](410562339ce067fdc6fa41940c118658_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant HSS + Note left of NF service consumer: 1. POST .../{ueId}/subscriptions (SubscriptionData) + NF service consumer->>HSS: Request + Note right of HSS: 2a. 201 Created (SubscriptionData) +2b. 404 Not Found +2c. 501 Not Implemented +2d. 3xx Redirect + HSS-->>NF service consumer: Response + +``` + +Sequence diagram showing the interaction between an NF service consumer and an HSS for subscribing to notifications. The consumer sends a POST request to the HSS. The HSS responds with one of the following: 2a. 201 Created (SubscriptionData), 2b. 404 Not Found, 2c. 501 Not Implemented, or 2d. 3xx Redirect. + +**Figure 5.3.2.3.2-1: NF service consumer subscribes to notifications** + +1. The NF service consumer sends a POST request to the parent resource (collection of subscriptions) (.../{ueId}/subscriptions), to create a subscription as present in message body. +- 2a. On success, the HSS responds with "201 Created" with the message body containing a representation of the created subscription. The Location HTTP header shall contain the URI of the created subscription. +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). +- 2c. If the UE subscription data exist, but the requested subscription to data change notification cannot be created (e.g. due to an invalid/unsupported data reference to be monitored, contained in the SubscriptionData parameter), HTTP status code "501 Not Implemented" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.4 Unsubscribe + +##### 5.3.2.4.1 General + +The following procedures using the Unsubscribe service operation are supported: + +- Unsubscribe to notification of data change + +##### 5.3.2.4.2 Unsubscribe to notifications of data change + +Figure 5.3.2.4.2-1 shows a scenario where the NF service consumer sends a request to the HSS to unsubscribe from notifications of data changes. The request contains the URI previously received in the Location HTTP header of the response to the subscription. + +![Sequence diagram showing the NF service consumer unsubscribing to notifications from the HSS.](a33da0f14e456f92539ce3e9b7d81f9a_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant HSS + NF service consumer->>HSS: 1. DELETE.../{ueId}/subscriptions/{subscriptionId} + HSS-->>NF service consumer: 2a. 204 No Content + HSS-->>NF service consumer: 2b. 404 Not Found + HSS-->>NF service consumer: 2c. 3xx Redirect +``` + +Sequence diagram showing the NF service consumer unsubscribing to notifications from the HSS. + +**Figure 5.3.2.4.2-1: NF service consumer unsubscribes to notifications** + +1. The NF service consumer sends a DELETE request to the resource identified by the URI previously received during subscription creation. +- 2a. On success, the HSS responds with "204 No Content". +- 2b. If there is no valid subscription available (e.g. due to an unknown subscriptionId value), HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the DELETE response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.3.2.5 Notification + +##### 5.3.2.5.1 General + +The following procedures using the Notification service operation are supported: + +- Data change notification to NF. + +##### 5.3.2.5.2 Data Change Notification To NF + +Figure 5.3.2.5.2-1 shows a scenario where the HSS notifies the NF service consumer (that has subscribed to receive such notification) about subscription data change. The request contains the callbackReference URI as previously received in the SubscriptionData. + +![Sequence diagram showing the HSS sending a subscription data change notification to the NF service consumer.](2bc39576969969ffe6d3f3d5264bba75_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant HSS + HSS->>NF service consumer: 1. POST {callbackReference} (Notification) + NF service consumer-->>HSS: 2a. 204 No Content + NF service consumer-->>HSS: 2b. 3xx Redirect +``` + +Sequence diagram showing the HSS sending a subscription data change notification to the NF service consumer. + +**Figure 5.3.2.5.2-1: Subscription Data Change Notification** + +1. The HSS sends a POST request to the callbackReference as provided by the NF service consumer during the subscription. +- 2a. The NF service consumer responds with "204 No Content". + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +In the case of redirection, the NF Service Consumer shall return 3xx status code, which shall contain a Location header with an URI pointing to an alternative notification endpoint. + +## 5.4 Nhss\_UEContextManagement Service + +### 5.4.1 Service Description + +The service allows an NF consumer (UDM) to trigger the cancellation of any previous registered serving node due to IRAT mobility. See 3GPP TS 23.632 [8], clause 6.1.3. + +### 5.4.2 Service Operations + +#### 5.4.2.1 Introduction + +For the Nhss\_UEContextManagement service the following service operations are defined: + +- SnDeregistration +- ImeiUpdate + +The Nhss\_UEContextManagement service is used by Consumer NF (UDM) to request HSS to deregister the MME/SGSN via cancel location procedure and to update the IMEI of the UE in the HSS. + +#### 5.4.2.2 SnDeregistration + +##### 5.4.2.2.1 General + +The following procedure using the SnDeregistration service operation is supported: + +- SN Deregistration + +##### 5.4.2.2.2 SN Deregistration + +Figure 5.4.2.2.2-1 shows a scenario where the NF service consumer (UDM) requests HSS to initiate Cancel Location procedure towards the MME/SGSN due to IRAT mobility. The request contains the UE's identity which shall be an IMSI. + +![Sequence diagram for SN Deregistration showing the interaction between an NF service consumer and the HSS.](95cd9f56a54683029052b8c644228506_img.jpg) + +``` +sequenceDiagram + participant NF as NF service consumer + participant HSS + Note left of NF: + NF->>HSS: 1. POST .../deregister-sn (DeregistrationRequest) + Note right of HSS: + HSS-->>NF: 2a. 204 No Content () + Note right of HSS: + HSS-->>NF: 2b. 404 Not Found + Note right of HSS: + HSS-->>NF: 2c. 3xx Redirect +``` + +The diagram illustrates the interaction between an NF service consumer and the HSS for SN Deregistration. The NF service consumer sends a POST request (custom method: deregister-sn) to the HSS. The HSS responds with one of three possible status codes: 204 No Content, 404 Not Found, or 3xx Redirect. + +Sequence diagram for SN Deregistration showing the interaction between an NF service consumer and the HSS. + +Figure 5.4.2.2.2-1: SN Deregistration + +1. The NF service consumer sends a POST request (custom method: deregister-sn) to the HSS; the request body contains the UE identity (IMSI) and the deregistration reason. + +The HSS, based on the value indicated in the deregistration reason, initiates a Cancel Location towards the serving node, including a Cancellation Type value (see 3GPP TS 29.272 [17] and 3GPP TS 29.002 [19]) as follows: + +- "UE\_INITIAL\_AND\_SINGLE\_REGISTRATION": S6a/S6d/Gr(S4/Gn/Gp) Cancel Location sent towards MME/SGSN, with a Cancellation-Type set to + +MME\_UPDATE\_PROCEDURE/SGSN\_UPDATE\_PROCEDURE; the HSS shall delete the stored MME/SGSN address and MME/SGSN number. + +Additionally, a MAP D Cancel Location (IMSI) shall be sent towards MSC/VLR if a VLR number was found in the HSS/HLR for the user; the HSS/HLR shall delete the stored MSC/VLR number. + +- "UE\_INITIAL\_AND\_DUAL\_REGISTRATION": S6d/Gr(S4) Cancel Location sent towards SGSN, with a Cancellation-Type set to SGSN\_UPDATE\_PROCEDURE; the HSS shall delete the stored SGSN address and SGSN number. + +NOTE 1: As described in 3GPP TS 23.502 [3], a UE operating in dual-registration mode indicates that it is moving from EPS, which implies that there is an MME registered in HSS. + +- "EPS\_TO\_5GS\_MOBILITY": S6a Cancel Location sent towards MME, with a Cancellation-Type set to MME\_UPDATE\_PROCEDURE; the HSS shall delete the stored MME address and MME number. + +Additionally, a MAP D Cancel Location (IMSI) shall be sent towards MSC/VLR if a VLR number was found in the HSS/HLR for the user; the HSS/HLR shall delete the stored MSC/VLR number. + +- "EPS\_TO\_5GS\_MOBILITY": S6d/Gr(S4) Cancel Location sent towards SGSN, with a Cancellation-Type set to SGSN\_UPDATE\_PROCEDURE; the HSS shall delete the stored SGSN address and SGSN number. + +NOTE 2: Based on operator policy, and the presence of GUAMI in the DeregistrationRequest, the HSS can decide whether a registered VLR in the VPLMN needs to be cancelled. It should be noted that keeping the VLR registration can impact terminating services (e.g. T-ADS, MT-SMS...) causing failed paging attempts. + +2a. On success, the HSS responds with "204 No Content". If the HSS has a valid subscription for the UE, but the UE is not registered in EPS network, the HSS shall respond with "204 No Content". + +2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +##### 5.4.2.2.3 IMEI Update + +Figure 5.4.2.2.3-1 shows a scenario where the NF service consumer (UDM) requests HSS to update the IMEI of the UE stored in the HSS. The request contains the UE's identity which shall be an IMSI, and the new IMEI of the UE. + +![Sequence diagram for IMEI Update. The diagram shows two lifelines: 'NF service consumer' on the left and 'HSS' on the right. A solid arrow labeled '1. POST .../imei-update (ImeiUpdateInfo)' points from the consumer to the HSS. From the HSS, three dashed arrows point back to the consumer, labeled '2a. 204 No Content ()', '2b. 404 Not Found', and '2c. 3xx Redirect'.](ecad02fdc2408197e954e3e07feb350c_img.jpg) + +``` + +sequenceDiagram + participant NF as NF service consumer + participant HSS as HSS + Note left of NF: Request IMEI Update + NF->>HSS: 1. POST .../imei-update (ImeiUpdateInfo) + Note right of HSS: Possible Responses + HSS-->>NF: 2a. 204 No Content () + HSS-->>NF: 2b. 404 Not Found + HSS-->>NF: 2c. 3xx Redirect + +``` + +Sequence diagram for IMEI Update. The diagram shows two lifelines: 'NF service consumer' on the left and 'HSS' on the right. A solid arrow labeled '1. POST .../imei-update (ImeiUpdateInfo)' points from the consumer to the HSS. From the HSS, three dashed arrows point back to the consumer, labeled '2a. 204 No Content ()', '2b. 404 Not Found', and '2c. 3xx Redirect'. + +Figure 5.4.2.2.3-1: IMEI Update + +1. The NF service consumer sends a POST request (custom method: imei-update) to the HSS; the request body contains the UE identity (IMSI) and the new IMEI of the UE. + +2a. On success, the HSS responds with "204 No Content". + +2b. If there is no valid subscription data for the UE, or the UE is not registered in EPS network for 3GPP access, HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +## 5.5 Nhss\_EventExposure Service + +### 5.5.1 Service Description + +See 3GPP TS 23.632 [8]. + +### 5.5.2 Service Operations + +#### 5.5.2.1 Introduction + +For the Nhss\_EventExposure service the following service operations are defined: + +- Subscribe +- Unsubscribe +- Notify +- ModifySubscription + +The Nhss\_EventExposure service is used by consumer NFs (e.g. UDM) to subscribe to notifications of event occurrence by means of the Subscribe service operation. + +The Nhss\_EventExposure service is also used by the consumer NFs (e.g. UDM) that have previously subscribed to notifications, to unsubscribe by means of the Unsubscribe service operation. + +The Nhss\_EventExposure service is also used by the subscribed consumer NFs (e.g. UDM) to modify an existing subscription by means of the ModifySubscription service operation. + +#### 5.5.2.2 Subscribe + +##### 5.5.2.2.1 General + +The following procedures using the Subscribe service operation are supported: + +- Subscribe to Notification of event occurrence + +##### 5.5.2.2.2 Subscription to Notification of event occurrence + +Figure 5.5.2.2.2-1 shows a scenario where the NF service consumer sends a request to the HSS to subscribe to notifications of event occurrence. The request contains a callback URI, the type of event that is monitored and additional information e.g. SCEF Id, event filters and reporting options. + +![Sequence diagram showing the NF service consumer subscribing to notifications from the HSS. The consumer sends a POST request to {ueId}/ee-subscriptions. The HSS responds with 2a. 201 Created, 2b. 404 Not Found, 2c. 403 Forbidden, or 2d. 3xx Redirect.](4356776ca004ecba5d599667a155d7d4_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant HSS + Note left of NF service consumer: 1. POST.../{ueId}/ee-subscriptions (EeSubscription) + NF service consumer->>HSS: Request + Note right of HSS: 2a. 201 Created (CreatedEeSubscription) +2b. 404 Not Found +2c. 403 Forbidden +2d. 3xx Redirect + HSS-->>NF service consumer: Response + +``` + +Sequence diagram showing the NF service consumer subscribing to notifications from the HSS. The consumer sends a POST request to {ueId}/ee-subscriptions. The HSS responds with 2a. 201 Created, 2b. 404 Not Found, 2c. 403 Forbidden, or 2d. 3xx Redirect. + +**Figure 5.5.2.2.2-1: NF service consumer subscribes to notifications** + +1. The NF service consumer sends a POST request to the parent resource (collection of subscriptions) (.../{ueId}/ee-subscriptions), to create a subscription as present in message body. The request may contain an expiry time, suggested by the NF Service Consumer, representing the time upto which the subscription is desired to be kept active and the time after which the subscribed event(s) shall stop generating notifications. Additionally, the request may include an SCEF Id if Common Network Exposure is used (i.e. if combined SCEF+NEF requested the event(s) to be subscribed/monitored in EPC) +- 2a. On success, the HSS responds with "201 Created" with the message body containing a representation of the created subscription. The Location HTTP header shall contain the URI of the created subscription. If both HSS and NF consumer has indicated supporting of ERIR feature (see clause 6.4.8), the HSS shall include available immediate event reports, i.e. reports already received from MME, in the response body. +- 2b. If the user does not exist, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). +- 2c. If there is no valid subscription data for the UE, i.e. based on the UE's subscription information monitoring of the requested EventType is not allowed, or the requested EventType is not supported, HTTP status code "403 Forbidden" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.5.2.3 Unsubscribe + +##### 5.5.2.3.1 General + +The following procedures using the Unsubscribe service operation are supported: + +- Unsubscribe to Notifications of event occurrence + +##### 5.5.2.3.2 Unsubscribe to notifications of event occurrence + +Figure 5.5.2.3.2-1 shows a scenario where the NF service consumer sends a request to the HSS to unsubscribe from notifications of event occurrence. The request contains the URI previously received in the Location HTTP header of the response to the subscription. + +![Sequence diagram showing the NF service consumer unsubscribing to notifications from the HSS.](8fa679f79a1bb1f527cba9f29e784e89_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant HSS + NF service consumer->>HSS: 1. DELETE.../{ueId}/ee-subscriptions/{subscriptionId} + HSS-->>NF service consumer: 2a. 204 No Content + HSS-->>NF service consumer: 2b. 404 Not Found + HSS-->>NF service consumer: 2c. 3xx Redirect + +``` + +Sequence diagram showing the NF service consumer unsubscribing to notifications from the HSS. + +**Figure 5.5.2.3.2-1: NF service consumer unsubscribes to notifications** + +1. The NF service consumer sends a DELETE request to the resource identified by the URI previously received during subscription creation. +- 2a. On success, the HSS responds with "204 No Content". +- 2b. If there is no valid subscription available (e.g. due to an unknown SubscriptionId value), HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the DELETE response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +#### 5.5.2.4 Notify + +##### 5.5.2.4.1 General + +The following procedures using the Notify service operation are supported: + +- Event Occurrence Notification + +##### 5.5.2.4.2 Event Occurrence Notification + +Figure 5.5.2.4.2-1 shows a scenario where the HSS notifies the NF service consumer (that has subscribed to receive such notification) about occurrence of an event. The request contains the callbackReference URI as previously received in the EeSubscription. + +![Sequence diagram showing the HSS sending an event occurrence notification to the NF service consumer.](61a1c017e34df13360be6319539570df_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant HSS + HSS->>NF service consumer: 1. POST {callbackReference} (MonitoringReport) + NF service consumer-->>HSS: 2a. 204 No Content + NF service consumer-->>HSS: 2b. 3xx Redirect + +``` + +Sequence diagram showing the HSS sending an event occurrence notification to the NF service consumer. + +**Figure 5.5.2.4.2-1: Event Occurrence Notification** + +1. The HSS sends a POST request to the callbackReference as provided by the NF service consumer during the subscription. +- 2a. The NF Service Consumer responds with "204 No Content". + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +In the case of redirection, the NF Service Consumer shall return 3xx status code, which shall contain a Location header with an URI pointing to an alternative notification endpoint. + +#### 5.5.2.5 ModifySubscription + +##### 5.5.2.5.1 General + +The following procedures using the ModifySubscription service operation are supported: + +- Modification of an EE-Subscription to notification of events + +##### 5.5.2.5.2 Modification of a subscription + +The service operation is invoked by a NF Service Consumer, e.g. UDM, towards the HSS, when it needs to modify an existing subscription previously created by itself at the HSS. + +The NF Service Consumer shall modify the subscription by using HTTP method PATCH with the URI of the individual subscription resource to be modified. + +![Sequence diagram showing the interaction between an NF service consumer and an HSS for modifying a subscription. The NF service consumer sends a PATCH request to the HSS. The HSS responds with one of the following: 2a. 204 No Content (), 2b. 404 Not Found, 2c. 403 Forbidden, or 2d. 3xx Redirect.](d79d33da852cb7bca3e87b400a15c3e8_img.jpg) + +``` + +sequenceDiagram + participant NF as NF service consumer + participant HSS as HSS + Note left of NF: 1. PATCH .../{ueId}/ee-subscriptions/{subscriptionId} + NF->>HSS: Request + Note right of HSS: 2a. 204 No Content () +2b. 404 Not Found +2c. 403 Forbidden +2d. 3xx Redirect + HSS-->>NF: Response + +``` + +Sequence diagram showing the interaction between an NF service consumer and an HSS for modifying a subscription. The NF service consumer sends a PATCH request to the HSS. The HSS responds with one of the following: 2a. 204 No Content (), 2b. 404 Not Found, 2c. 403 Forbidden, or 2d. 3xx Redirect. + +**Figure 5.5.2.5.2-1: NF service consumer updates subscription** + +1. The NF service consumer (e.g. NEF) shall send a PATCH request to the resource representing a subscription. The modification may be for the events subscribed or for updating the event report options. +- 2a. On success, the request is accepted, the HSS shall respond with "204 No Content". +- 2b. If the resource does not exist e.g. the subscriptionId cannot be found, HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element). +- 2c. If the modification can't be accepted, HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PATCH response body. + +In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance. + +# 6 API Definitions + +## 6.1 Nhss\_UEAuthentication Service API + +### 6.1.1 Introduction + +The Nhss\_UEAuthentication service shall use the Nhss\_UEAuthentication API. + +The request URI used in HTTP request from the NF service consumer towards the NF service producer shall have the structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +{apiRoot}
+ +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nhss-ueau". +- The shall be "v1". +- The shall be set as described in clause 6.1. + +### 6.1.2 Usage of HTTP + +#### 6.1.2.1 General + +HTTP/2, as defined in IETF RFC 7540 [9], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +HTTP messages and bodies for the Nhss\_UEAuthentication service shall comply with the OpenAPI [10] specification contained in Annex A. + +#### 6.1.2.2 HTTP standard headers + +##### 6.1.2.2.1 General + +The usage of HTTP standard headers shall be supported as specified in clause 5.2.2 of 3GPP TS 29.500 [4]. + +##### 6.1.2.2.2 Content type + +The following content types shall be supported: + +- JSON, as defined in IETF RFC 8259 [11], signalled by the content type "application/json". +- The Problem Details JSON Object (IETF RFC 7807 [12]) signalled by the content type "application/problem+json". + +#### 6.1.2.3 HTTP custom headers + +##### 6.1.2.3.1 General + +In this release of the specification, no specific custom headers are defined for the Nhss\_UEAuthentication service. + +For 3GPP specific HTTP custom headers used across all service based interfaces, see clause 5.2.3 of 3GPP TS 29.500 [4]. + +### 6.1.3 Resources + +#### 6.1.3.1 Overview + +![Diagram showing the resource URI structure of the nhss-ueau API. A dashed box contains '/generate-av', connected by a line to the base URI path.](7d3d5fb5d09c0cd35a9d637be241651e_img.jpg) + +{apiRoot}/nhss-ueau/ + +``` + +graph TD + Base["{apiRoot}/nhss-ueau/"] --> Resource["/generate-av"] + style Resource stroke-dasharray: 5 5 + +``` + +Diagram showing the resource URI structure of the nhss-ueau API. A dashed box contains '/generate-av', connected by a line to the base URI path. + +**Figure 6.1.3.1-1: Resource URI structure of the nhss-ueau API** + +Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.1.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|---------------|--------------|---------------------------------|--------------------------------| +| n/a | generate-av | generate-av (POST) | Generate Authentication Vector | + +### 6.1.4 Custom Operations without associated resources + +#### 6.1.4.1 Overview + +**Table 6.1.4.1-1: Custom operations without associated resources** + +| Custom operation URI | Mapped HTTP method | Description | +|----------------------------------------------|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| {apiRoot}/nhss-ueau//generate-av | POST | The HSS calculates a fresh Authentication Vector taking into account the received information (imsi, serving network name, authentication method) | + +#### 6.1.4.2 Operation: Generate AV + +##### 6.1.4.2.1 Description + +This custom operation is used by the NF service consumer (UDM) to request calculation of an authentication vector for the provided imsi. + +##### 6.1.4.2.2 Operation Definition + +This operation shall support the response data structures and response codes specified in tables 6.1.4.2.2-1 and 6.1.4.2.2-2. + +**Table 6.1.4.2.2-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|---------------------|---|-------------|-----------------------------------------------------------------| +| AvGenerationRequest | M | 1 | Contains input parameters for Authentication Vector calculation | + +**Table 6.1.4.2.2-2: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| AvGenerationResponse | M | 1 | 200 OK | Upon success, a response body containing the generated authentication vector shall be returned | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- AUTHENTICATION_REJECTED | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND | + +**Table 6.1.4.2.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.
Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.1.4.2.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.
Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +### 6.1.5 Notifications + +In this release of this specification, no notifications are defined for the Nhss\_UEAuthentication Service. + +### 6.1.6 Data Model + +#### 6.1.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.1.6.1-1 specifies the data types defined for the Nhss service based interface protocol. + +**Table 6.1.6.1-1: Nhss specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|----------------------|----------------|------------------------------------------------------------------------------------|---------------| +| AvGenerationRequest | 6.1.6.2.2 | Contains imsi, authentication method, serving network name, resynchronization info | | +| AvGenerationResponse | 6.1.6.2.3 | Contains the calculated Authentication Vector | | + +Table 6.1.6.1-2 specifies data types re-used by the Nhss service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nhss service based interface. + +**Table 6.1.6.1-2: Nhss re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-----------------------|---------------------|----------------------------------------------|---------------| +| AuthType | 3GPP TS 29.503 [13] | | | +| ServingNetworkName | 3GPP TS 29.503 [13] | | | +| ResynchronizationInfo | 3GPP TS 29.503 [13] | | | +| AvEapAkaPrime | 3GPP TS 29.503 [13] | | | +| Av5GHeAka | 3GPP TS 29.503 [13] | | | +| ProblemDetails | 3GPP TS 29.571 [7] | Response body of error response messages. | | +| RedirectResponse | 3GPP TS 29.571 [7] | Response body of redirect response messages. | | + +#### 6.1.6.2 Structured data types + +##### 6.1.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.1.6.2.2 Type: AvGenerationRequest + +**Table 6.1.6.2.2-1: Definition of type AvGenerationRequest** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------|-----------------------|---|-------------|------------------------------------------------------------------|---------------| +| imsi | string | M | 1 | pattern: "[0-9]{5,15}" | | +| authType | AuthType | M | 1 | Indicates the authentication method; "EAP_AKA_PRIME" or "5G_AKA" | | +| servingNetworkName | ServingNetworkName | M | 1 | | | +| resynchronizationInfo | ResynchronizationInfo | O | 0..1 | | | + +##### 6.1.6.2.3 Type: AvGenerationResponse + +**Table 6.1.6.2.3-1: Definition of type AvGenerationResponse** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|-------------------------------------------------------------------------|---------------| +| avEapAkaPrime | AvEapAkaPrime | C | 0..1 | shall be present if av5GHeAka is absent, otherwise shall be absent. | | +| av5GHeAka | Av5GHeAka | C | 0..1 | shall be present if avEapAkaPrime is absent, otherwise shall be absent. | | + +#### 6.1.6.3 Simple data types and enumerations + +##### 6.1.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 6.1.6.3.2 Simple data types + +The simple data types defined in table 6.1.6.3.2-1 shall be supported. + +**Table 6.1.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| | | | | + +### 6.1.7 Error Handling + +#### 6.1.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +#### 6.1.7.2 Protocol Errors + +Protocol errors handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +#### 6.1.7.3 Application Errors + +The application errors defined for the Nhss\_UEAuthentication service are listed in table 6.1.7.3-1. + +**Table 6.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------------|------------------|--------------------------------------| +| AUTHENTICATION_REJECTED | 403 Forbidden | The user cannot be authenticated | +| USER_NOT_FOUND | 404 Not Found | The user does not exist in the HPLMN | + +### 6.1.8 Feature negotiation + +The optional features in table 6.1.8-1 are defined for the Nhss\_UEAuthentication API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.1.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +## 6.2 Nhss\_SubscriberDataManagement Service API + +### 6.2.1 API URI + +The Nhss\_SubscriberDataManagement service shall use the Nhss\_SubscriberDataManagement API. + +The request URI used in HTTP request from the NF service consumer towards the NF service producer shall have the structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +{apiRoot}
// + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nhss-sdm". +- The shall be "v1". +- The shall be set as described in clause 6.2.3. + +### 6.2.2 Usage of HTTP + +#### 6.2.2.1 General + +HTTP/2, as defined in IETF RFC 7540 [9], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +HTTP messages and bodies for the Nhss\_SubscriberDataManagement service shall comply with the OpenAPI [10] specification contained in Annex A. + +#### 6.2.2.2 HTTP standard headers + +##### 6.2.2.2.1 General + +The usage of HTTP standard headers shall be supported as specified in clause 5.2.2 of 3GPP TS 29.500 [4]. + +##### 6.2.2.2.2 Content type + +The following content types shall be supported: + +- JSON, as defined in IETF RFC 8259 [11], signalled by the content type "application/json". +- The Problem Details JSON Object (IETF RFC 7807 [12]) signalled by the content type "application/problem+json". + +#### 6.2.2.3 HTTP custom headers + +##### 6.2.2.3.1 General + +In this release of the specification, no specific custom headers are defined for the Nhss\_SubscriberDataManagement service. + +For 3GPP specific HTTP custom headers used across all service-based interfaces, see clause 5.2.3 of 3GPP TS 29.500 [4]. + +### 6.2.3 Resources + +#### 6.2.3.1 Overview + +![Figure 6.2.3.1-1: Resource URI structure of the nhss-sdm API. The diagram shows a hierarchical tree structure starting with {apiRoot}/nhss-sdm/. It branches to /{ueId}, which then branches to /ue-context-in-pgw-data and /subscriptions. The /subscriptions path further branches to /{subscriptionId}.](4cde160bcc69b7b6c81b648dd0e4252e_img.jpg) + +``` + +graph TD + Root["{apiRoot}/nhss-sdm/"] --> ueId["/{ueId}"] + ueId --> ueContext["/ue-context-in-pgw-data"] + ueId --> subscriptions["/subscriptions"] + subscriptions --> subscriptionId["/{subscriptionId}"] + +``` + +Figure 6.2.3.1-1: Resource URI structure of the nhss-sdm API. The diagram shows a hierarchical tree structure starting with {apiRoot}/nhss-sdm/. It branches to /{ueId}, which then branches to /ue-context-in-pgw-data and /subscriptions. The /subscriptions path further branches to /{subscriptionId}. + +**Figure 6.2.3.1-1: Resource URI structure of the nhss-sdm API** + +Table 6.2.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.2.3.1-1: Resources and methods overview** + +| Resource name (Archetype) | Resource URI | HTTP method or custom operation | Description | +|------------------------------------|----------------------------------------|---------------------------------|--------------------------------------------------------------------------| +| UeContextInPgwData (Document) | /{ueId}/ue-context-in-pgw-data | GET | Retrieve the UE's Context in PGW Data | +| Subscriptions (Collection) | /{ueId}/subscriptions | POST | Create a subscription | +| Individual Subscription (Document) | /{ueId}/subscriptions/{subscriptionId} | DELETE | Delete the subscription identified by {subscriptionId}, i.e. unsubscribe | +| | | PATCH | Modify the subscription identified by {subscriptionId} | + +#### 6.2.3.2 Resource: UeContextInPgwData + +##### 6.2.3.2.1 Description + +This resource represents the allocated PGWs for the UE. + +##### 6.2.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nhss-sdm///ue-context-in-pgw-data + +This resource shall support the resource URI variables defined in table 6.2.3.2.2-1. + +**Table 6.2.3.2.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| apiVersion | See clause 6.2.1 | +| ueId | Represents the UE identifier with type IMSI.
pattern: "^(imsi-[0-9]{5,15}.+)\$" | + +##### 6.2.3.2.3 Resource Standard Methods + +###### 6.2.3.2.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.2.3.1-1. + +**Table 6.2.3.2.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.2.3.2.3.1-2 and the response data structures and response codes specified in table 6.2.3.2.3.1-3. + +**Table 6.2.3.2.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.2.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------------------------------------------------------------------------------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| UeContextInPgwData | M | 1 | 200 OK | A response body containing the UeContextInPgwData shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND | +| NOTE: In addition, common data structures as listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +**Table 6.2.3.2.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.
Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.2.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.
Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +#### 6.2.3.3 Resource: Subscriptions + +##### 6.2.3.3.1 Description + +This resource is used to represent subscriptions to notifications. + +##### 6.2.3.3.2 Resource Definition + +Resource URI: {apiRoot}/nhss-sdm///subscriptions + +This resource shall support the resource URI variables defined in table 6.2.3.3.2-1. + +**Table 6.2.3.3.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|----------------------------------------------------------------------------| +| apiRoot | See clause 6.1.1 | +| apiVersion | See clause 6.1.1 | +| ueId | Represents the IMSI of the subscriber.
pattern: "^(imsi-[0-9]{5,15})\$" | + +##### 6.2.3.3.3 Resource Standard Methods + +###### 6.2.3.3.3.1 POST + +This method shall support the URI query parameters specified in table 6.2.3.3.3.1-1. + +**Table 6.2.3.3.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.2.3.3.3.1-2 and the response data structures and response codes specified in table 6.2.3.3.3.1-3. + +**Table 6.2.3.3.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|-----------------------------------------| +| SubscriptionData | M | 1 | The subscription that is to be created. | + +Table 6.2.3.3.3.1-3: Data structures supported by the POST Response Body on this resource + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|---------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SubscriptionData | M | 1 | 201
Created | Upon success, a response body containing a representation of the created Individual subscription resource shall be returned.

The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:

- USER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 501 Not Implemented | The "cause" attribute may be used to indicate one of the following application errors:

- UNSUPPORTED_RESOURCE_URI

This response shall not be cached. | + +NOTE: In addition, common data structures as listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. + +Table 6.2.3.3.3.1-4: Headers supported by the 307 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.
Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +Table 6.2.3.3.3.1-5: Headers supported by the 308 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.
Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +#### 6.2.3.4 Resource: Individual subscription + +##### 6.2.3.4.1 Description + +This resource is used to represent an individual subscription to notifications. + +##### 6.2.3.4.2 Resource Definition + +Resource URI: {apiRoot}/nhss-sdm///subscriptions/ + +This resource shall support the resource URI variables defined in table 6.2.3.4.2-1. + +**Table 6.2.3.4.2-1: Resource URI variables for this resource** + +| Name | Definition | +|----------------|----------------------------------------------------------------------------| +| apiRoot | See clause 6.1.1 | +| apiVersion | See clause 6.1.1 | +| ueId | Represents the IMSI of the subscriber
pattern: "^(imsi-[0-9]{5,15})\$" | +| subscriptionId | The subscriptionId identifies an individual subscription to notifications. | + +##### 6.2.3.4.3 Resource Standard Methods + +###### 6.2.3.4.3.1 DELETE + +This method shall support the URI query parameters specified in table 6.2.3.4.3.1-1. + +**Table 6.2.3.4.3.1-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.2.3.4.3.1-2 and the response data structures and response codes specified in table 6.2.3.4.3.1-3. + +**Table 6.2.3.4.3.1-2: Data structures supported by the Delete Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|----------------------------------| +| n/a | | | The request body shall be empty. | + +**Table 6.2.3.4.3.1-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:

- USER_NOT_FOUND
- SUBSCRIPTION_NOT_FOUND (see 3GPP TS 29.500 [4] table 5.2.7.2-1) | + +NOTE: In addition, common data structures as listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. + +**Table 6.2.3.4.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.
Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.4.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.
Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +###### 6.2.3.4.3.2 PATCH + +This method shall support the URI query parameters specified in table 6.2.3.4.3.2-1. + +**Table 6.2.3.4.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.2.3.4.3.2-2 and the response data structures and response codes specified in table 6.2.3.4.3.2-3. + +**Table 6.2.3.4.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| array(PatchItem) | M | 1 | It contains the list of changes to be made to the resource representing the individual subscription, according to the JSON PATCH format specified in IETF RFC 6902 [13]. | + +**Table 6.2.3.4.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, a response with no content is returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:

- USER_NOT_FOUND
- SUBSCRIPTION_NOT_FOUND (see 3GPP TS 29.500 [4] table 5.2.7.2-1) | +| ProblemDetails | O | 0..1 | 403 Forbidden | One or more attributes are not allowed to be modified.

The "cause" attribute may be used to indicate one of the following application errors:

- MODIFICATION_NOT_ALLOWED (see 3GPP TS 29.500 [4] table 5.2.7.2-1) | + +NOTE: In addition, common data structures as listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. + +**Table 6.2.3.4.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.
Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.3.4.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.
Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +### 6.2.4 Custom Operations without associated resources + +In this release of this specification, no custom operations without associated resources are defined for the Nhss\_SubscriberDataManagement Service. + +### 6.2.5 Notifications + +#### 6.2.5.1 General + +This clause specifies the use of notifications and corresponding protocol details. + +#### 6.2.5.2 Data Change Notification + +The POST method shall be used for Data Change Notifications and the URI shall be as provided during the subscription procedure. + +Resource URI: {callbackReference} + +Support of URI query parameters is specified in table 6.2.5.2-1. + +**Table 6.2.5.2-1: URI query parameters supported by the POST method** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +Support of request data structures is specified in table 6.2.5.2-2 and of response data structures and response codes is specified in table 6.2.5.2-3. + +**Table 6.2.5.2-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|--------------------------|---|-------------|-------------| +| ModificationNotification | M | 1 | | + +**Table 6.2.5.2-3: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the notification endpoint of the subscribing NF Service Consumer.
If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service consumer to which the notification should be sent. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the notification endpoint of the subscribing NF Service Consumer.
If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service consumer to which the notification should be sent. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:

- CONTEXT_NOT_FOUND

See table 6.2.7.3-1 for the description of this error. | + +NOTE: In addition, common data structures as listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. + +**Table 6.2.5.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.2.5.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +### 6.2.6 Data Model + +#### 6.2.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.2.6.1-1 specifies the data types defined for the Nhss\_SubscriberDataManagement service API. + +**Table 6.2.6.1-1: Nhss\_SubscriberDataManagement specific Data Types** + +| Data type | Clause defined | Description | +|----------------------|----------------|---------------------------| +| UeContextInPgwData | 6.2.6.2.2 | | +| SubscriptionData | 6.2.6.2.3 | Subscription Data | +| SubscriptionDataSets | 6.2.6.2.4 | UE Subscription Data Sets | + +Table 6.2.6.1-2 specifies data types re-used by the Nhss\_SubscriberDataManagement service API from other APIs, including a reference and when needed, a short description of their use within the Nhss\_SubscriberDataManagement service API. + +**Table 6.2.6.1-2: Nhss\_SubscriberDataManagement re-used Data Types** + +| Data type | Reference | Comments | +|--------------------------|---------------------|----------------------------------------------| +| PgwInfo | 3GPP TS 29.503 [13] | | +| ModificationNotification | 3GPP TS 29.503 [13] | | +| NfInstanceId | 3GPP TS 29.571 [7] | Network Function Instance Identifier | +| Uri | 3GPP TS 29.571 [7] | Uniform Resource Identifier | +| DateTime | 3GPP TS 29.571 [7] | | +| ProblemDetails | 3GPP TS 29.571 [7] | Response body of error response messages. | +| RedirectResponse | 3GPP TS 29.571 [7] | Response body of redirect response messages. | + +#### 6.2.6.2 Structured data types + +##### 6.2.6.2.1 Introduction + +This clause defines the data structures to be used in resource representations. + +##### 6.2.6.2.2 Type: UeContextInPgwData + +Table 6.2.6.2.2-1: Definition of type UeContextInPgwData + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|----------------|---|-------------|------------------------------------------------------------------------------| +| pgwInfo | array(PgwInfo) | O | 1..N | Information about the APNs and PGW-C+SMF FQDNs used in interworking with UDM | +| emergencyFqdn | string | O | 0..1 | PGW-C+SMF FQDN for emergency session | + +Note: At least one of pgwInfo and emergencyFqdn shall be present. The format of PGW-C+SMF FQDN is specified in clause 5.12.3.2, 3GPP TS 29.303 [16]. + +##### 6.2.6.2.3 Type: SubscriptionData + +Table 6.2.6.2.3-1: Definition of type SubscriptionData + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|----------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| nflInstanceId | NflInstanceId | M | 1 | Identity of the NF Instance creating the subscription. | +| callbackReference | Uri | M | 1 | URI provided by the NF service consumer to receive notifications | +| monitoredResourceUris | array(Uri) | M | 1..N | A set of URIs that identify the resources for which a change triggers a notification.
The URI shall take the form of either an absolute URI or an absolute-path reference as defined in IETF RFC 3986 [31].
See NOTE 1. | +| expires | DateTime | O | 0..1 | If present in a POST request, it indicates the point in time at which the subscription expires.

Within a POST request the proposed expiry time is conveyed whereas in a POST response or PATCH response the confirmed expiry time is returned. | +| immediateReport | boolean | O | 0..1 | This IE indicates whether immediate report is needed or not.

When present, this IE shall be set as following:
- true: immediate report is required
- false (default) immediate report is not required | +| report | SubscriptionDataSets | C | 0..1 | This IE shall be present in Subscribe response, if the immediateReport attribute is set to "true" in Subscribe request.

When present, this IE shall contain the representation of subscription data sets that to be monitored, i.e. listed in monitoredResourceUris attribute. | + +NOTE 1: The HSS should handle only the relative-path part (apiSpecificResourceUriPart, see 3GPP TS 29.501 [5] clause 4.4.1) and ignore possible inconsistencies (caused by e.g. an SCP) in the base URI part. + +##### 6.2.6.2.4 Type: SubscriptionDataSets + +Table 6.2.6.2.4-1: Definition of type SubscriptionDataSets + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|--------------------|---|-------------|------------------------| +| ueContextInPgwData | UeContextInPgwData | O | 0..1 | UE Context in PGW Data | + +#### 6.2.6.3 Simple data types and enumerations + +##### 6.2.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 6.2.6.3.2 Simple data types + +The simple data types defined in table 6.2.6.3.2-1 shall be supported. + +**Table 6.2.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | +|-----------|-----------------|-------------| +| | | | + +### 6.2.7 Error Handling + +#### 6.2.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +#### 6.2.7.2 Protocol Errors + +Protocol errors handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +#### 6.2.7.3 Application Errors + +The common application errors defined in the Table 5.2.7.2-1 in 3GPP TS 29.500 [4] may also be used for the Nhss\_SubscriberDataManagement service. The following application errors listed in Table 6.2.7.3-1 are specific for the Nhss\_SubscriberDataManagement service. + +**Table 6.2.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|------------------|------------------------------------------------------------------------------------------------------| +| USER_NOT_FOUND | 404 Not Found | The user does not exist. | +| DATA_NOT_FOUND | 404 Not Found | The requested data is not found/does not exist. | +| CONTEXT_NOT_FOUND | 404 Not Found | It is used during the modification of an existing subscription when no corresponding context exists. | + +### 6.2.8 Feature Negotiation + +The optional features in table 6.2.8-1 are defined for the Nhss\_SubscriberDataManagement API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.2.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +## 6.3 Nhss\_UEContextManagement Service API + +### 6.3.1 Introduction + +The Nhss\_UEContextManagement service shall use the Nhss\_UEContextManagement API. + +The request URI used in HTTP request from the NF service consumer towards the NF service producer shall have the structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}
** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nhss-uecm". +- The shall be "v1". +- The shall be set as described in clause 6.1. + +### 6.3.2 Usage of HTTP + +#### 6.3.2.1 General + +HTTP/2, as defined in IETF RFC 7540 [9], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +HTTP messages and bodies for the Nhss\_UEContextManagement service shall comply with the OpenAPI [10] specification contained in Annex A. + +#### 6.3.2.2 HTTP standard headers + +##### 6.3.2.2.1 General + +The usage of HTTP standard headers shall be supported as specified in clause 5.2.2 of 3GPP TS 29.500 [4]. + +##### 6.3.2.2.2 Content type + +The following content types shall be supported: + +- JSON, as defined in IETF RFC 8259 [11], signalled by the content type "application/json". +- The Problem Details JSON Object (IETF RFC 7807 [12]) signalled by the content type "application/problem+json". + +#### 6.3.2.3 HTTP custom headers + +##### 6.3.2.3.1 General + +In this release of the specification, no specific custom headers are defined for the Nhss\_UEContextManagement service. + +For 3GPP specific HTTP custom headers used across all service-based interfaces, see clause 5.2.3 of 3GPP TS 29.500 [4]. + +### 6.3.3 Resources + +#### 6.3.3.1 Overview + +![Diagram showing the resource URI structure of the nhss-uecm API. The root URI is {apiRoot}/nhss-uecm/. Below this root, two sub-URIs are shown in dashed boxes: /deregister-sn and /imei-update, both connected by a vertical line from the root.](0055c3ab42ae5f3af4a8c9399d401df5_img.jpg) + +``` +graph TD; Root["{apiRoot}/nhss-uecm/"] --- Dashed1["/deregister-sn"]; Root --- Dashed2["/imei-update"]; +``` + +Diagram showing the resource URI structure of the nhss-uecm API. The root URI is {apiRoot}/nhss-uecm/. Below this root, two sub-URIs are shown in dashed boxes: /deregister-sn and /imei-update, both connected by a vertical line from the root. + +Figure 6.3.3.1-1: Resource URI structure of the nhss-uecm API + +Table 6.3.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.3.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|---------------|---------------|---------------------------------|---------------------------------------------------------| +| n/a | deregister-sn | deregister-sn (POST) | Requesting MME/SGSN deregistration | +| n/a | imei-update | imei-update (POST) | Requests the update of the IMEI of the UE stored in HSS | + +### 6.3.4 Custom Operations without associated resources + +#### 6.3.4.1 Overview + +**Table 6.3.4.1-1: Custom operations without associated resources** + +| Custom operation URI | Mapped HTTP method | Description | +|------------------------------------------------|--------------------|-------------------------------------| +| {apiRoot}/nhss-uecm//deregister-sn | POST | Requesting MME/SGSN deregistration. | + +#### 6.3.4.2 Operation: deregister-sn + +##### 6.3.4.2.1 Description + +This custom operation is used by the NF service consumer (UDM) to request MME/SGSN deregistration. + +##### 6.3.4.2.2 Operation Definition + +This operation shall support the data structures and response codes specified in tables 6.3.4.2.2-1 and 6.3.4.2.2-2. + +**Table 6.3.4.2.2-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|-----------------------|---|-------------|-------------| +| DeregistrationRequest | M | 1 | | + +**Table 6.3.4.2.2-2: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND | + +**Table 6.3.4.2.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.
Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.3.4.2.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.
Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +#### 6.3.4.3 Operation: imei-update + +##### 6.3.4.3.1 Description + +This custom operation is used by the NF service consumer (UDM) to request the update of the IMEI of the UE. + +##### 6.3.4.3.2 Operation Definition + +This operation shall support the data structures and response codes specified in tables 6.3.4.3.2-1 and 6.3.4.3.2-2. + +**Table 6.3.4.3.2-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|----------------|---|-------------|-------------| +| ImeiUpdateInfo | M | 1 | | + +**Table 6.3.4.3.2-2: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- CONTEXT_NOT_FOUND | + +**Table 6.3.4.3.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.
Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.3.4.3.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.
Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +### 6.3.5 Notifications + +In this release of this specification, no notifications are defined for the Nhss\_UEContextManagement Service. + +### 6.3.6 Data Model + +#### 6.3.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.3.6.1-1 specifies the structured data types defined for the Nhss\_UECM service API. + +**Table 6.3.6.1-1: Nhss\_UECM specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|-----------------------|----------------|--------------------------------------|---------------| +| DeregistrationRequest | 6.3.6.2.2 | Contains IMSI, deregistration reason | | +| ImeiUpdateInfo | 6.3.6.2.3 | Contains IMSI, new IMEI | | + +Table 6.3.6.1-2 specifies data types re-used by the Nhss\_UECM service API from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nhss\_UECM service API. + +**Table 6.3.6.1-2: Nhss\_UECM re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|------------------|--------------------|----------------------------------------------|---------------| +| Guami | 3GPP TS 29.571 [7] | | | +| ProblemDetails | 3GPP TS 29.571 [7] | Response body of error response messages. | | +| RedirectResponse | 3GPP TS 29.571 [7] | Response body of redirect response messages. | | + +#### 6.3.6.2 Structured data types + +##### 6.3.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.3.6.2.2 Type: DeregistrationRequest + +**Table 6.3.6.2.2-1: Definition of type DeregistrationRequest** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| imsi | string | M | 1 | pattern: "^[0-9]{5,15}\$" | | +| deregReason | DeregistrationReason | M | 1 | String, see clause 6.3.6.3.3 | | +| guami | Guami | O | 0..1 | The GUAMI identifying the AMF where the UE is registered. May be used by the HSS based on operator policy to decide whether a registered VLR shall be cancelled. | | + +##### 6.3.6.2.3 Type: ImeiUpdateInfo + +**Table 6.3.6.2.3-1: Definition of type ImeiUpdateInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------------------------------------------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------| +| imsi | string | M | 1 | IMSI of the subscriber.
pattern: "^[0-9]{5,15}\$" | +| imei | string | C | 0..1 | IMEI of the UE as described in 3GPP TS 23.003 [15], clause 6.2.1; it shall not include the Check Digit.
pattern: "^[0-9]{14}\$" | +| imeisv | string | C | 0..1 | IMEISV of the UE as described in 3GPP TS 23.003 [15], clause 6.2.2.
pattern: "^[0-9]{16}\$" | +| NOTE: Exactly one of attributes "imei" or "imeisv" shall be present. | | | | | + +#### 6.3.6.3 Simple data types and enumerations + +##### 6.3.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 6.3.6.3.2 Simple data types + +The simple data types defined in table 6.3.6.3.2-1 shall be supported. + +**Table 6.3.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | +|-----------|-----------------|-------------| +| | | | + +##### 6.3.6.3.3 Enumeration: DeregistrationReason + +**Table 6.3.6.3.3-1: Enumeration DeregistrationReason** + +| Enumeration value | Description | +|--------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "UE_INITIAL_AND_SINGLE_REGISTRATION" | This value is used when the UDM needs to indicate to HSS that the MME/SGSN, if any, shall be cancelled due to an initial registration for single registration. | +| "UE_INITIAL_AND_DUAL_REGISTRATION" | This value is used when the UDM needs to indicate to HSS that an SGSN shall be cancelled (due to initial registration), but the MME shall not be cancelled (due to dual registration). | +| "EPS_TO_5GS_MOBILITY" | This value is used when the UDM needs to indicate to HSS that the MME/SGSN, if any, shall be cancelled due to a mobility event (i.e. for single registration which is not an initial registration). | + +### 6.3.7 Error Handling + +#### 6.3.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +#### 6.3.7.2 Protocol Errors + +Protocol errors handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +#### 6.3.7.3 Application Errors + +The common application errors defined in the Table 5.2.7.2-1 in 3GPP TS 29.500 [4] may also be used for the Nudm\_UEContextManagement service. The application errors defined for the Nhss\_UEContextManagement service are listed in Table 6.3.7.3-1. + +**Table 6.3.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|------------------|-----------------------------------------------------| +| USER_NOT_FOUND | 404 Not Found | The user does not exist. | +| CONTEXT_NOT_FOUND | 404 Not Found | It is used when no corresponding UE context exists. | + +### 6.3.8 Feature Negotiation + +The optional features in table 6.3.8-1 are defined for the Nhss\_UEContextManagement API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.3.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +## 6.4 Nhss\_EventExposure Service API + +### 6.4.1 API URI + +URIs of this API shall have the following root: + +{apiRoot}/// + +where "apiRoot" is defined in clause 4.4.1 of 3GPP TS 29.501 [5], the "apiName" shall be set to "nhss-ee" and the "apiVersion" shall be set to "v1" for the current version of this specification. + +### 6.4.2 Usage of HTTP + +#### 6.4.2.1 General + +HTTP/2, as defined in IETF RFC 7540 [13], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +HTTP messages and bodies for the Nhss\_EE service shall comply with the OpenAPI [14] specification contained in Annex A5. + +#### 6.4.2.2 HTTP standard headers + +##### 6.4.2.2.1 General + +The usage of HTTP standard headers shall be supported as specified in clause 5.2.2 of 3GPP TS 29.500 [4]. + +##### 6.4.2.2.2 Content type + +The following content types shall be supported: + +JSON, as defined in IETF RFC 8259 [15], signalled by the content type "application/json". + +The Problem Details JSON Object (IETF RFC 7807 [16]) signalled by the content type "application/problem+json" + +JSON Patch (IETF RFC 6902 [41]). The use of the JSON Patch format in a HTTP request body shall be signalled by the content type "application/json-patch+json". + +#### 6.4.2.3 HTTP custom headers + +##### 6.4.2.3.1 General + +The usage of HTTP custom headers shall be supported as specified in clause 5.2.3 of 3GPP TS 29.500 [4]. + +### 6.4.3 Resources + +#### 6.4.3.1 Overview + +![Figure 6.4.3.1-1: Resource URI structure of the Nhss_EE API. The diagram shows a hierarchical tree structure of URI paths. The root is //{apiRoot}/nhss-ee/v1. A branch from the root leads to /{ueId}. From /{ueId}, a branch leads to /ee-subscriptions. From /ee-subscriptions, a branch leads to /{subscriptionId}.](a97518a839da75f8379c578562b01bc2_img.jpg) + +``` + +graph TD + Root["//{apiRoot}/nhss-ee/v1"] --> ueId["/{ueId}"] + ueId --> eeSubscriptions["/ee-subscriptions"] + eeSubscriptions --> subscriptionId["/{subscriptionId}"] + +``` + +Figure 6.4.3.1-1: Resource URI structure of the Nhss\_EE API. The diagram shows a hierarchical tree structure of URI paths. The root is //{apiRoot}/nhss-ee/v1. A branch from the root leads to /{ueId}. From /{ueId}, a branch leads to /ee-subscriptions. From /ee-subscriptions, a branch leads to /{subscriptionId}. + +**Figure 6.4.3.1-1: Resource URI structure of the Nhss\_EE API** + +Table 6.4.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.4.3.1-1: Resources and methods overview** + +| Resource name (Archetype) | Resource URI | HTTP method or custom operation | Description | +|------------------------------------|-------------------------------------------|---------------------------------|--------------------------------------------------------------------------| +| EeSubscriptions (Collection) | /{ueId}/ee-subscriptions | POST | Create a subscription | +| Individual subscription (Document) | /{ueId}/ee-subscriptions/{subscriptionId} | PATCH | Update the subscription identified by {subscriptionId} | +| | | DELETE | Delete the subscription identified by {subscriptionId}, i.e. unsubscribe | + +#### 6.4.3.2 Resource: EeSubscriptions (Collection) + +##### 6.4.3.2.1 Description + +This resource is used to represent subscriptions to notifications. + +##### 6.4.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nhss-ee//{ueId}/ee-subscriptions + +This resource shall support the resource URI variables defined in table 6.4.3.2.2-1. + +**Table 6.4.3.2.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|---------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.4.1 | +| ueId | Represents the identity of the UE in the HSS (IMSI)
pattern: See type lmsi in clause 6.4.6.3.2 of this document. | + +##### 6.4.3.2.3 Resource Standard Methods + +###### 6.4.3.2.3.1 POST + +This method shall support the URI query parameters specified in table 6.4.3.2.3.1-1. + +**Table 6.4.3.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.4.3.2.3.1-2 and the response data structures and response codes specified in table 6.4.3.2.3.1-3. + +**Table 6.4.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------|---|-------------|----------------------------------------| +| EeSubscription | M | 1 | The subscription that is to be created | + +Table 6.4.3.2.3.1-3: Data structures supported by the POST Response Body on this resource + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| CreatedEeSubscription | M | 1 | 201 Created | Upon success, a response body containing a representation of the created Individual subscription resource shall be returned, along with event reports that might be immediately available at the HSS.

The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- MONITORING_NOT_ALLOWED
- MAXIMUM_RESOURCES_EXCEEDED | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 501 Not Implemented | The "cause" attribute may be used to indicate one of the following application errors:
- UNSUPPORTED_MONITORING_EVENT_TYPE
- UNSUPPORTED_MONITORING_REPORT_OPTIONS

This response shall not be cached. | + +Table 6.4.3.2.3.1-4: Headers supported by the 307 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.
Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +Table 6.4.3.2.3.1-5: Headers supported by the 308 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.
Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +#### 6.4.3.3 Resource: Individual subscription (Document) + +##### 6.4.3.3.1 Resource Definition + +Resource URI: {apiRoot}/nhss-ee///ee-subscriptions/ + +This resource shall support the resource URI variables defined in table 6.4.3.3.1-1. + +**Table 6.4.3.3.1-1: Resource URI variables for this resource** + +| Name | Definition | +|----------------|---------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.4.1 | +| ueId | Represents the identity of the UE in the HSS (IMSI)
pattern: See type Imsi in clause 6.4.6.3.2 of this document. | +| subscriptionId | The subscriptionId identifies an individual subscription to notifications
The type is string. | + +##### 6.4.3.3.2 Resource Standard Methods + +###### 6.4.3.3.2.1 DELETE + +This method shall support the URI query parameters specified in table 6.4.3.3.2.1-1. + +**Table 6.4.3.3.1.1-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.4.3.3.2.1-2 and the response data structures and response codes specified in table 6.4.3.3.2.1-3. + +**Table 6.4.3.3.2.1-2: Data structures supported by the Delete Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|----------------------------------| +| n/a | | | The request body shall be empty. | + +**Table 6.4.3.3.2.1-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- SUBSCRIPTION_NOT_FOUND, see 3GPP TS 29.500 [4] table 5.2.7.2-1. | + +**Table 6.4.3.3.2.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.
Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.4.3.3.2.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.
Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +###### 6.4.3.3.2.2 PATCH + +This method shall support the URI query parameters specified in table 6.4.3.3.2.2-1. + +**Table 6.4.3.3.2.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +This method shall support the request data structures specified in table 6.4.3.3.2.2-2 and the response data structures and response codes specified in table 6.4.3.3.2.2-3. + +**Table 6.4.3.3.2.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|------------------------------------------------------------| +| array(PatchItem) | M | 1..N | Items describe the modifications to the Event Subscription | + +**Table 6.4.3.3.2.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- SUBSCRIPTION_NOT_FOUND, see 3GPP TS 29.500 [4] table 5.2.7.2-1. | +| ProblemDetails | O | 0..1 | 403 Forbidden | One or more attributes are not allowed to be modified.

The "cause" attribute may be used to indicate one of the following application errors:
- MODIFICATION_NOT_ALLOWED, see 3GPP TS 29.500 [4] table 5.2.7.2-1. | + +**Table 6.4.3.3.2.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.
Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.4.3.3.2.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.
Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +### 6.4.4 Custom Operations without associated resources + +In this release of this specification, no custom operations without associated resources are defined for the Nhss\_EventExposure Service. + +### 6.4.5 Notifications + +#### 6.4.5.1 General + +This clause will specify the use of notifications and corresponding protocol details if required for the specific service. When notifications are supported by the API, it will include a reference to the general description of notifications support over the 5G SBIs specified in TS 29.500 / TS 29.501. + +#### 6.4.5.2 Event Occurrence Notification + +The POST method shall be used for Event Occurrence Notifications and the URI shall be as provided during the subscription procedure. + +Resource URI: {callbackReference} + +Support of URI query parameters is specified in table 6.4.5.2-1. + +**Table 6.4.5.2-1: URI query parameters supported by the POST method** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +Support of request data structures is specified in table 6.4.5.2-2 and of response data structures and response codes is specified in table 6.4.5.2-3. + +**Table 6.4.5.2-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|-------------------------|---|-------------|---------------------------------------------------------------------------------------------| +| array(MonitoringReport) | M | 1..N | A list of MonitoringReports each of which contains information regarding the occurred event | + +**Table 6.4.5.2-3: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the notification endpoint of the subscribing NF Service Consumer.
If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service consumer to which the notification should be sent. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the notification endpoint of the subscribing NF Service Consumer.
If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service consumer to which the notification should be sent. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- CONTEXT NOT FOUND | + +NOTE: In addition, common data structures as listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. + +**Table 6.4.5.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.4.5.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +### 6.4.6 Data Model + +#### 6.4.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.4.6.1-1 specifies the data types defined for the Nhss\_EE service API. + +**Table 6.4.6.1-1: Nhss\_EE specific Data Types** + +| Data type | Clause defined | Description | +|----------------------------------|----------------|-----------------------------------------------------------------------| +| EeSubscription | 6.4.6.2.2 | A subscription to Notifications | +| CreatedEeSubscription | 6.4.6.2.3 | | +| MonitoringConfiguration | 6.4.6.2.4 | Monitoring Configuration | +| MonitoringReport | 6.4.6.2.5 | Monitoring Report | +| Report | 6.4.6.2.6 | | +| ReportingOptions | 6.4.6.2.7 | | +| LocationReportingConfiguration | 6.4.6.2.8 | | +| ReachabilityForSmsReport | 6.4.6.2.9 | | +| LossConnectivityConfiguration | 6.4.6.2.10 | | +| ReachabilityForDataConfiguration | 6.4.6.2.11 | | +| PduSessionStatusCfg | 6.4.6.2.12 | Reporting configuration for events related to PDN connectivity Status | +| ReachabilityForDataReport | 6.4.6.2.13 | Report of "UE_REACHABILITY_FOR_DATA" event | +| EventType | 6.4.6.3.3 | | +| LocationAccuracy | 6.4.6.3.4 | | + +Table 6.4.6.1-2 specifies data types re-used by the Nhss\_EE service API from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nhss\_EE service API. + +**Table 6.4.6.1-2: Nhss\_EE re-used Data Types** + +| Data type | Reference | Comments | +|---------------------------|---------------------|-------------------------------------------------| +| Uri | 3GPP TS 29.571 [7] | Uniform Resource Identifier | +| SupportedFeatures | 3GPP TS 29.571 [7] | See 3GPP TS 29.500 [4] clause 6.6 | +| DateTime | 3GPP TS 29.571 [7] | | +| PatchResult | 3GPP TS 29.571 [7] | | +| DurationSec | 3GPP TS 29.571 [7] | | +| DiameterIdentity | 3GPP TS 29.571 [7] | | +| Dnn | 3GPP TS 29.571 [7] | Data Network Name with Network Identifier only. | +| ProblemDetails | 3GPP TS 29.571 [7] | Response body of error response messages. | +| RedirectResponse | 3GPP TS 29.571 [7] | Response body of redirect response messages. | +| LossConnectivityReport | 3GPP TS 29.503 [13] | Report of "LOSS_OF_CONNECTIVITY" event | +| LocationReport | 3GPP TS 29.503 [13] | Report of "LOCATION_REPORTING" event | +| PdnConnectivityStatReport | 3GPP TS 29.503 [13] | Report of "PDN_CONNECTIVITY_STATUS" event | + +#### 6.4.6.2 Structured data types + +##### 6.4.6.2.1 Introduction + +This clause defines the data structures to be used in resource representations. + +### 6.4.6.2.2 Type: EeSubscription + +**Table 6.4.6.2.2-1: Definition of type EeSubscription** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------|------------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| callbackReference | Uri | M | 1 | URI provided by the NF service consumer to receive notifications | +| monitoringConfigurations | map(MonitoringConfiguration) | O | 1..N | A map (list of key-value pairs where referencedId converted from integer to string serves as key) of MonitoringConfigurations | +| scefId | DiameterIdentity | O | 0..1 | Diameter Identity (FQDN) of the SCEF | +| supportedFeatures | SupportedFeatures | O | 0..1 | See clause 6.4.8 | +| reportingOptions | ReportingOptions | O | 0..1 | This IE may be included if the NF service consumer wants to describe how the reports of the event are to be generated.
If this attribute is not present in the request, it means that the NF service consumer does not specify any maximum number of reports or any expiry time for the subscription; still, the NF service producer (HSS) may set an expiry time in the response to the subscription creation (see clause 6.4.6.2.7). | + +## 6.4.6.2.3 Type: CreatedEeSubscription + +Table 6.4.6.2.3-1: Definition of type CreatedEeSubscription + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|-------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| eeSubscription | EeSubscription | M | 1 | This IE shall contain the representation of the created event subscription. | | +| eventReports | array(MonitoringReport) | O | 1..N | This IE may be included when the NF consumer has indicated supporting of ERIR feature in the subscription creation request (see clause 6.4.8).

This IE when present, shall contain the status of events that are requested for immediate reporting as well, if those events are available at the time of subscription. | ERIR | +| supportedFeatures | SupportedFeatures | O | 0..1 | See clause 6.4.8 | | + +## 6.4.6.2.4 Type: MonitoringConfiguration + +Table 6.4.6.2.4-1: Definition of type MonitoringConfiguration + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------------------|----------------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| eventType | EventType | M | 1 | Event type | +| immediateFlag | boolean | O | 0..1 | Indicates if an immediate event report in the subscription response indicating current value / status of the event is required, if available. If the flag is not present, then immediate reporting may be skipped. | +| locationReportingConfiguration | LocationReportingConfiguration | C | 0..1 | Shall be present if eventType is "LOCATION_REPORTING" | +| lossConnectivityConfiguration | LossConnectivityConfiguration | O | 0..1 | May be present if eventType is "LOSS_OF_CONNECTIVITY". | +| reachabilityForDataConfiguration | ReachabilityForDataConfiguration | O | 0..1 | May be present if eventType is "UE_REACHABILITY_FOR_DATA" | +| pduSessionStatusCfg | PduSessionStatusCfg | O | 0..1 | may be present if eventType is "PDN_CONNECTIVITY_STATUS" | +| idleStatusInd | boolean | O | 0..1 | Idle Status Indication request.

May be present if eventType is "UE_REACHABILITY_FOR_DATA" or "AVAILABILITY_AFTER_DDN_FAILURE"

When present, this IE shall be set as following:
- true: Idle status indication is requested
- false (default): Idle status indication is not requested | + +## 6.4.6.2.5 Type: MonitoringReport + +Table 6.4.6.2.5-1: Definition of type MonitoringReport + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| referenceId | ReferenceId | M | 1 | Shall contain the Reference ID which was provided as the key of the associated monitoring configuration in subscription request. The consumer can use this IE to uniquely associate the report with the corresponding event that was requested to be monitored. | +| eventType | EventType | M | 1 | String; see clause 6.4.6.3.3
only the following values are allowed:
"UE_REACHABILITY_FOR_SMS"
"UE_REACHABILITY_FOR_DATA"
"LOSS_OF_CONNECTIVITY"
"LOCATION_REPORTING"
"PDN_CONNECTIVITY_STATUS" | +| timeStamp | DateTime | M | 1 | Point in time at which the event occurred | +| report | Report | O | 0..1 | Shall be present if eventType is
"UE_REACHABILITY_FOR_SMS"
"UE_REACHABILITY_FOR_DATA"
"LOSS_OF_CONNECTIVITY"
"LOCATION_REPORTING"
"PDN_CONNECTIVITY_STATUS" | + +## 6.4.6.2.6 Type: Report + +Table 6.4.6.2.6-1: Definition of type Report + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------|----------------------------|---|-------------|--------------------------------------| +| reachabilityForSmsReport | ReachabilityForSms Report | O | 0..1 | Reports the UE reachability for SMS | +| reachabilityForDataReport | ReachabilityForData Report | O | 0..1 | Reports the UE reachability for Data | +| lossConnectivityReport | LossConnectivityReport | O | 0..1 | Reports the Loss of Connectivity | +| locationReport | LocationReport | O | 0..1 | Reports the UE Location | +| pdnConnectivityStatReport | PdnConnectivityStat Report | O | 0..1 | Reports the PDN Connectivity Status | + +## 6.4.6.2.7 Type: ReportingOptions + +Table 6.4.6.2.7-1: Definition of type ReportingOptions + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|-----------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| maxNumOfReports | MaxNumOfReports | O | 0..1 | Maximum number of reports. If not present, the NF service consumer does not specify any maximum number of reports to be received.
(NOTE) | +| expiry | DateTime | C | 0..1 | This IE shall be included in an event subscription response, if, based on operator policy, the HSS needs to include an expiry time, and may be included in an event subscription request. When present, this IE shall represent the time at which monitoring shall cease and the subscription becomes invalid. If the maxNumOfReports included in an event subscription response is 1 and if an event report is included in the subscription response then the value of the expiry included in the response shall be an immediate timestamp.
(NOTE) | +| reportPeriod | DurationSec | C | 0..1 | Indicates the interval time between which the event notification is reported, may be present if event type is "LOCATION REPORTING" | + +NOTE: If parameter "maxNumOfReports" and "expiry" are included at the same time, the subscription will expire as soon as one of the conditions is met. + +## 6.4.6.2.8 Type: LocationReportingConfiguration + +Table 6.4.6.2.8-1: Definition of type LocationReportingConfiguration + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------| +| currentLocation | boolean | M | 1 | true: Indicates that current location is requested.
false: Indicates that last known location is requested. | +| accuracy | LocationAccuracy | C | 0..1 | Indicates whether Cell-level or TA-level accuracy is requested. Shall be present when current location is requested. | + +## 6.4.6.2.9 Type: ReachabilityForSmsReport + +Table 6.4.6.2.9-1: Definition of type ReachabilityForSmsReport + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| reachabilitySmsStatus | boolean | M | 1 | true: UE is reachable for SMS
false: UE is not reachable for SMS | +| maxAvailabilityTime | DateTime | O | 0..1 | Indicates the time (in UTC) until which the UE is expected to be reachable.

This information may be used by the SMS Service Center to prioritize the retransmission of pending Mobile Terminated Short Message to UEs using a power saving mechanism (eDRX, PSM etc.). | + +6.4.6.2.10 Type: LossConnectivityConfiguration + +**Table 6.4.6.2.10-1: Definition of type LossConnectivityConfiguration** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|-------------|---|-------------|------------------------------------------------------------------| +| maxDetectionTime | DurationSec | O | 0..1 | When present, it indicates the configured Maximum Detection Time | + +6.4.6.2.11 Type: ReachabilityForDataConfiguration + +**Table 6.4.6.2.11-1: Definition of type ReachabilityForDataConfiguration** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------|-------------|---|-------------|----------------------------------------------------------------------------------------| +| maximumLatency | DurationSec | O | 0..1 | When present, it indicates the configured Maximum Latency. (NOTE) | +| maximumResponseTime | DurationSec | O | 0..1 | When present, it indicates the configured Maximum Response Time. (NOTE) | +| suggestedPacketNumDI | integer | O | 0..1 | When present, it indicates the configured Suggested number of downlink packets. (NOTE) | + +NOTE: At least one of maximumLatency, maximumResponseTime or suggestedPacketNumDI shall be present + +6.4.6.2.12 Type: PduSessionStatusCfg + +**Table 6.4.6.2.12-1: Definition of type PduSessionStatusCfg** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|----------------------------------------------------------------------| +| apn | Dnn | O | 0..1 | When present, it indicates the APN for which the event is monitored. | + +6.4.6.2.13 Type: ReachabilityForDataReport + +**Table 6.4.6.2.13-1: Definition of type ReachabilityForDataReport** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| reachabilityDataStatus | boolean | M | 1 | true: UE is reachable for Data
false: UE is not reachable for Data | +| maxAvailabilityTime | DateTime | O | 0..1 | Indicates the time (in UTC) until which the UE is expected to be reachable.

This information may be used by the SMS Service Center to prioritize the retransmission of pending Mobile Terminated Short Message to UEs using a power saving mechanism (eDRX, PSM etc.). | + +6.4.6.3 Simple data types and enumerations + +6.4.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +6.4.6.3.2 Simple data types + +The simple data types defined in table 6.4.6.3.2-1 shall be supported. + +**Table 6.4.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | +|-----------------|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ReferenceId | integer | ReferenceId is used as key in a map of MonitoringConfigurations; see clause 6.4.6.2.4.
The numeric value should not be higher than $2^{64}-1$ (i.e. it should be possible to convey it in an unsigned 64 integer Information Element, used in other protocols), if interworking with the Event Exposure framework in EPC is required. | +| imsi | string | IMSI
pattern: '^(imsi-[0-9]{5,15})\$' | +| MaxNumOfReports | integer | Maximum number of reports.
Minimum: 1 | + +#### 6.4.6.3.3 Enumeration: EventType + +**Table 6.4.6.3.3-1: Enumeration EventType** + +| Enumeration value | Description | +|----------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "LOSS_OF_CONNECTIVITY" | Loss of connectivity | +| "UE_REACHABILITY_FOR_DATA" | UE reachability for Data, implements the "UE Reachability for Data" event as specified in 3GPP TS 23.682 [18].

When this event is subscribed by an NF service consumer, the HSS shall send an Insert Subscriber Data Request message to the MME/SGSN for the UE with the Monitoring-Type AVP set to the value UE_REACHABILITY and the Reachability-Information AVP set to the value REACHABLE_FOR_DATA, see clause 5.2.2.1.3 of 3GPP TS 29.272 [17]. | +| "UE_REACHABILITY_FOR_SMS" | UE reachability for SMS, implements the "UE Reachability for SMS Delivery" event as specified in 3GPP TS 23.682 [18].

This event only supports One-Time reporting. | +| "LOCATION_REPORTING" | Location Reporting | +| "COMMUNICATION_FAILURE" | Communication Failure | +| "AVAILABILITY_AFTER_DDN_FAILURE" | Availability after DDN failure | +| "PDN_CONNECTIVITY_STATUS" | PDN_CONNECTIVITY_STATUS | + +#### 6.4.6.3.4 Enumeration: LocationAccuracy + +**Table 6.4.6.3.4-1: Enumeration LocationAccuracy** + +| Enumeration value | Description | +|-------------------|----------------------------------| +| "CELL_LEVEL" | Change of cell shall be reported | +| "TA_LEVEL" | Change of TA shall be reported | + +### 6.4.7 Error Handling + +#### 6.4.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +#### 6.4.7.2 Protocol Errors + +Protocol errors handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +### 6.4.7.3 Application Errors + +The common application errors defined in the Table 5.2.7.2-1 in 3GPP TS 29.500 [4] may also be used for the Nhss\_EventExposure service. The following application errors listed in Table 6.4.7.3-1 are specific for the Nhss\_EventExposure service. + +**Table 6.4.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|---------------------------------------|---------------------|-------------------------------------------------------------------------------------------------------| +| MONITORING_NOT_ALLOWED | 403 Forbidden | The subscriber does not have the necessary subscription for monitoring with the requested Event Type. | +| USER_NOT_FOUND | 404 Not Found | The user does not exist | +| CONTEXT_NOT_FOUND | 404 Not Found | It is used when no corresponding context exists. | +| UNSUPPORTED_MONITORING_EVENT_TYPE | 501 Not Implemented | The monitoring configuration contains unsupported event type. | +| UNSUPPORTED_MONITORING_REPORT_OPTIONS | 501 Not Implemented | The monitoring configuration contains unsupported report options. | + +### 6.4.8 Feature Negotiation + +The optional features in table 6.4.8-1 are defined for the Nhss\_EE API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.4.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | ERIR | Event Reports in Response

An NF consumer supporting this feature shall be able to handle the event reports within the Event Subscription Create Response, as specified in clause 5.5.2.2.2. | + +### 6.4.9 Security + +As indicated in 3GPP TS 33.501 [6] and 3GPP TS 29.500 [4], the access to the Nhss\_EE API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [18]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [19]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nhss\_EE API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [19], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nhss\_EE service. + +The Nhss\_EE API defines a single scope "nhss-ee" for OAuth2 authorization (as specified in 3GPP TS 33.501 [6]) for the entire API, and it does not define any additional scopes at resource or operation level. + +# Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex specifies the formal definition of the Nhss Service API(s). It consists of OpenAPI 3.0.0 specifications in YAML format. + +This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository, that uses the GitLab software version control system (see 3GPP TS 29.501 [5] clause 5.3.1 and 3GPP TR 21.900 [14] clause 5B). + +## A.2 Nhss\_UEAuthentication API + +``` +openapi: 3.0.0 +info: + version: '1.0.1' + title: 'NhssUEAU' + description: | + HSS UE Authentication Service. + © 2021, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.563 HSS Services for Interworking With UDM, version 16.5.0 + url: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.563/' + +servers: + - url: '{apiRoot}/nhss-ueau/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. + +security: + - oAuth2ClientCredentials: + - nhss-ueau + - {} + +paths: + /generate-av: + post: + summary: Generate authentication vector for the UE + operationId: GenerateAV + tags: + - Generate Auth Vector + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AvGenerationRequest' + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/AvGenerationResponse' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nhss-ueau: Access to the nhss-ueau API + +schemas: + +# COMPLEX TYPES: + + AvGenerationRequest: + type: object + required: + - imsi + - authType + - servingNetworkName + properties: + imsi: + type: string + pattern: '^[0-9]{5,15}$' + authType: + $ref: 'TS29503_Nudm_UEAU.yaml#/components/schemas/AuthType' + servingNetworkName: + $ref: 'TS29503_Nudm_UEAU.yaml#/components/schemas/ServingNetworkName' + resynchronizationInfo: + $ref: 'TS29503_Nudm_UEAU.yaml#/components/schemas/ResynchronizationInfo' + + AvGenerationResponse: + type: object + oneOf: + - required: + - avEapAkaPrime + - required: + - av5GHeAka + properties: + avEapAkaPrime: + $ref: 'TS29503_Nudm_UEAU.yaml#/components/schemas/AvEapAkaPrime' + av5GHeAka: + $ref: 'TS29503_Nudm_UEAU.yaml#/components/schemas/Av5GHeAka' + +# SIMPLE TYPES: + +# ENUMS: +``` + +## A.3 Nhss\_SubscriberDataManagement API + +``` +openapi: 3.0.0 + +info: + version: '1.0.2' + title: 'Nhss_SDM' +``` + +``` +description: | + HSS Subscriber Data Management. + © 2021, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.563 HSS Services for Interworking With UDM, version 16.5.0 + url: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.563/' + +servers: + - url: '{apiRoot}/nhss-sdm/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. + +security: + - oAuth2ClientCredentials: + - nhss-sdm + - {} + +paths: + /{ueId}/ue-context-in-pgw-data: + get: + summary: Retrieve the UE Context In PGW + operationId: GetUeCtxInPgwData + tags: + - UE Context In PGW Data Retrieval + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + type: string + pattern: '^(imsi-[0-9]{5,15})$' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/UeContextInPgwData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + + /{ueId}/subscriptions: + post: + summary: subscribe to notifications + operationId: Subscribe + tags: + - Subscription Creation + parameters: + - name: ueId + in: path + description: IMSI of the user + required: true + schema: + type: string + pattern: '^(imsi-[0-9]{5,15})$' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SubscriptionData' + required: true +``` + +``` + +responses: + '201': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SubscriptionData' + headers: + Location: + description: 'Contains the URI of the newly created resource, according to the +structure: {apiRoot}/nhss-sdm//{ueId}/subscriptions/{subscriptionId}' + required: true + schema: + type: string + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +callbacks: + datachangeNotification: + '{request.body#/callbackReference}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ModificationNotification' + responses: + '204': + description: Successful Notification response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +/{ueId}/subscriptions/{subscriptionId}: + delete: + summary: unsubscribe from notifications + operationId: Unsubscribe + tags: + - Subscription Deletion + parameters: + - name: ueId + in: path + description: IMSI of the user + required: true + schema: + type: string + pattern: '^(imsi-[0-9]{5,15})$' + - name: subscriptionId + in: path + description: Id of the Subscription + required: true + schema: + type: string + +``` + +``` +responses: + '204': + description: Successful response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +patch: + summary: modify the subscription + operationId: Modify + tags: + - Subscription Modification + parameters: + - name: ueId + in: path + description: IMSI of the user + required: true + schema: + type: string + pattern: '^([imsi-[0-9]{5,15})$' + - name: subscriptionId + in: path + description: Id of the Subscription + required: true + schema: + type: string + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + minItems: 1 + required: true + responses: + '204': + description: Successful modification + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nhss-sdm: Access to the nhss-sdm API + +schemas: +``` + +## # COMPLEX TYPES: + +``` +UeContextInPgwData: + type: object + properties: + pgwInfo: + type: array + items: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/PgwInfo' + minItems: 1 + emergencyFqdn: + type: string + +SubscriptionData: + type: object + required: + - nfInstanceId + - callbackReference + - monitoredResourceUris + properties: + nfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + callbackReference: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + monitoredResourceUris: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + minItems: 1 + expires: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + immediateReport: + type: boolean + default: false + report: + $ref: '#/components/schemas/SubscriptionDataSets' + +SubscriptionDataSets: + type: object + properties: + ueContextInPgwData: + $ref: '#/components/schemas/UeContextInPgwData' +``` + +## # SIMPLE TYPES: + +## # ENUMS: + +## A.4 Nhss\_UEContextManagement API + +openapi: 3.0.0 + +``` +info: + version: '1.0.2' + title: 'Nhss_UECM' + description: | + HSS UE Context Management + © 2021, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.563 HSS Services for Interworking With UDM, version 16.5.0 + url: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.563/' + +servers: + - url: '{apiRoot}/nhss-uecm/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. + +security: + - oAuth2ClientCredentials: + - nhss-uecm + - {} +``` + +``` +paths: + /deregister-sn: + post: + summary: MME/SGSN Deregistration + operationId: DeregisterSN + tags: + - MME/SGSN Deregistration + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeregistrationRequest' + required: true + responses: + '204': + description: No content + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + + /imei-update: + post: + summary: IMEI Update + operationId: IMEIUpdate + tags: + - IMEI Update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ImeiUpdateInfo' + required: true + responses: + '204': + description: No content + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nhss-uecm: Access to the nhss-uecm API + +schemas: + +# COMPLEX TYPES: +``` + +``` +DeregistrationRequest: + type: object + required: + - imsi + - deregReason + properties: + imsi: + type: string + pattern: '^[0-9]{5,15}$' + deregReason: + $ref: '#/components/schemas/DeregistrationReason' + guami: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + +ImeiUpdateInfo: + type: object + required: + - imsi + oneOf: + - required: [ imei ] + - required: [ imeisv ] + properties: + imsi: + type: string + pattern: '^[0-9]{5,15}$' + imei: + type: string + pattern: '^[0-9]{14,15}$' + imeisv: + type: string + pattern: '^[0-9]{16}$' +``` + +# SIMPLE TYPES: + +# ENUMS: + +``` +DeregistrationReason: + anyOf: + - type: string + enum: + - UE_INITIAL_AND_SINGLE_REGISTRATION + - UE_INITIAL_AND_DUAL_REGISTRATION + - EPS_TO_5GS_MOBILITY + - type: string +``` + +## A.5 Nhss\_EE API + +openapi: 3.0.0 + +``` +info: + version: '1.0.5' + title: 'Nhss_EE' + description: | + HSS Event Exposure. + © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +``` + +``` +externalDocs: + description: 3GPP TS 29.563 HSS Services for Interworking With UDM, version 16.7.0 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.563/' +``` + +``` +servers: + - url: '{apiRoot}/nhss-ee/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. +``` + +``` +security: + - {} + - oAuth2ClientCredentials: + - nhss-ee +``` + +paths: + +``` + +/{ueId}/ee-subscriptions: + post: + summary: Subscribe + operationId: CreateEeSubscription + tags: + - EE Subscription (Collection) + parameters: + - name: ueId + in: path + description: IMSI of the subscriber + required: true + schema: + $ref: '#/components/schemas/Imsi' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EeSubscription' + required: true + responses: + '201': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/CreatedEeSubscription' + headers: + Location: + description: 'Contains the URI of the newly created resource, according to the +structure: {apiRoot}/nhss-ee/v1/{ueId}/ee-subscriptions/{subscriptionId}' + required: true + schema: + type: string + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + callbacks: + eventOccurrenceNotification: + '{request.body#/callbackReference}': + post: + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/MonitoringReport' + minItems: 1 + responses: + '204': + description: Successful Notification response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +/{ueId}/ee-subscriptions/{subscriptionId}: + delete: + summary: Unsubscribe + operationId: DeleteEeSubscription + tags: + - Delete EE Subscription + parameters: + - name: ueId + in: path + description: IMSI of the subscriber + required: true + schema: + $ref: '#/components/schemas/Imsi' + - name: subscriptionId + in: path + description: Id of the EE Subscription + required: true + schema: + type: string + responses: + '204': + description: Successful response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + patch: + summary: Patch + operationId: UpdateEeSubscription + tags: + - Update EE Subscription + parameters: + - name: ueId + in: path + description: IMSI of the subscriber + required: true + schema: + $ref: '#/components/schemas/Imsi' + - name: subscriptionId + in: path + description: Id of the EE Subscription + required: true + schema: + type: string + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + minItems: 1 + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '204': + description: Successful response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +``` + +``` +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +default: + description: Unexpected error + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nhss-ee: Access to the nhss-ee API + +schemas: + +# COMPLEX TYPES: + +EeSubscription: + type: object + required: + - callbackReference + properties: + callbackReference: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + sceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' + monitoringConfigurations: + description: A map (list of key-value pairs where ReferenceId serves as key) of +MonitoringConfigurations + type: object + additionalProperties: + $ref: '#/components/schemas/MonitoringConfiguration' + minProperties: 1 + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + reportingOptions: + $ref: '#/components/schemas/ReportingOptions' + +CreatedEeSubscription: + type: object + required: + - eeSubscription + properties: + eeSubscription: + $ref: '#/components/schemas/EeSubscription' + eventReports: + type: array + items: + $ref: '#/components/schemas/MonitoringReport' + minItems: 1 + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +MonitoringConfiguration: + type: object + required: + - eventType + properties: + eventType: + $ref: '#/components/schemas/EventType' + immediateFlag: + type: boolean + locationReportingConfiguration: + $ref: '#/components/schemas/LocationReportingConfiguration' + lossConnectivityConfiguration: + $ref: '#/components/schemas/LossConnectivityConfiguration' + reachabilityForDataConfiguration: + $ref: '#/components/schemas/ReachabilityForDataConfiguration' + pduSessionStatusCfg: + $ref: '#/components/schemas/PduSessionStatusCfg' + idleStatusInd: + type: boolean +``` + +``` +default: false + +MonitoringReport: + type: object + required: + - referenceId + - eventType + - timeStamp + properties: + referenceId: + $ref: '#/components/schemas/ReferenceId' + eventType: + $ref: '#/components/schemas/EventType' + timeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + report: + $ref: '#/components/schemas/Report' + +ReportingOptions: + type: object + properties: + maxNumOfReports: + $ref: '#/components/schemas/MaxNumOfReports' + expiry: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + reportPeriod: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + +Report: + type: object + properties: + reachabilityForSmsReport: + $ref: '#/components/schemas/ReachabilityForSmsReport' + reachabilityForDataReport: + $ref: '#/components/schemas/ReachabilityForDataReport' + lossConnectivityReport: + $ref: 'TS29503_Nudm_EE.yaml#/components/schemas/LossConnectivityReport' + locationReport: + $ref: 'TS29503_Nudm_EE.yaml#/components/schemas/LocationReport' + pdnConnectivityStatReport: + $ref: 'TS29503_Nudm_EE.yaml#/components/schemas/PdnConnectivityStatReport' + +ReachabilityForSmsReport: + type: object + required: + - reachabilitySmsStatus + properties: + reachabilitySmsStatus: + type: boolean + maxAvailabilityTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + +ReachabilityForDataReport: + description: Contains data for a Monitoring Event Report, specific to the 'Reachability For +Data' event type + type: object + required: + - reachabilityDataStatus + properties: + reachabilityDataStatus: + type: boolean + maxAvailabilityTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + +LossConnectivityConfiguration: + type: object + properties: + maxDetectionTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + +LocationReportingConfiguration: + type: object + required: + - currentLocation + properties: + currentLocation: + type: boolean + accuracy: +``` + +``` +$ref: '#/components/schemas/LocationAccuracy' + +ReachabilityForDataConfiguration: + type: object + anyOf: + - required: [ maximumLatency ] + - required: [ maximumResponseTime ] + - required: [ suggestedPacketNumDl ] + properties: + maximumLatency: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + maximumResponseTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + suggestedPacketNumDl: + type: integer + minimum: 1 + +PduSessionStatusCfg: + type: object + properties: + apn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + +# SIMPLE TYPES: + +ReferenceId: + type: integer + +Imsi: + type: string + pattern: '^(imsi-[0-9]{5,15})$' + +MaxNumOfReports: + type: integer + minimum: 1 + +# ENUMS: + +EventType: + anyOf: + - type: string + enum: + - LOSS_OF_CONNECTIVITY + - UE_REACHABILITY_FOR_DATA + - UE_REACHABILITY_FOR_SMS + - LOCATION_REPORTING + - COMMUNICATION_FAILURE + - AVAILABILITY_AFTER_DDN_FAILURE + - PDN_CONNECTIVITY_STATUS + - type: string + +LocationAccuracy: + anyOf: + - type: string + enum: + - CELL_LEVEL + - TA_LEVEL + - type: string +``` + +--- + +## Annex B (informative): Withdrawn API versions + +### B.1 General + +This Annex lists withdrawn API versions of the APIs defined in the present specification. 3GPP TS 29.501 [5] clause 4.3.1.6 describes the withdrawal of API versions. + +## Annex C (informative): Change history + +| Change history | | | | | | | | | +|----------------|---------|-----------|------|-----|-----|---------------------------------------------------------------------------------------|--|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | | New version | +| 2019-05 | CT4#91 | C4-192407 | | | | Initial Draft. | | 0.1.0 | +| 2019-09 | CT4#93 | C4-193847 | | | | Incorporation of pCRs agreed at CT4#93 in C4-193553, C4-193624. | | 0.2.0 | +| 2019-10 | CT4#94 | C4-194521 | | | | Incorporation of pCRs agreed at CT4#94 in C4-194346. | | 0.3.0 | +| 2019-11 | CT4#95 | C4-195636 | | | | Incorporation of pCRs agreed at CT4#95 in C4-195579. | | 0.4.0 | +| 2019-12 | CT#86 | CP-193067 | | | | TS presented for information | | 1.0.0 | +| 2020-03 | CT4#96 | C4-201271 | | | | Incorporation of pCRs agreed at CT4#96 in C4-200880, C4-200917, C4-200964, C4-201100. | | 1.1.0 | +| 2020-03 | CT#87 | CP-200065 | | | | TS presented for approval | | 2.0.0 | +| 2020-03 | CT#87 | | | | | Approved at CT#87 | | 16.0.0 | +| 2020-07 | CT#88 | CP-201033 | 0001 | - | B | Storage of YAML files in ETSI Forge | | 16.1.0 | +| 2020-07 | CT#88 | CP-201033 | 0002 | - | F | PGW-C+SMF FQDN for Emergency Session | | 16.1.0 | +| 2020-07 | CT#88 | CP-201033 | 0003 | 1 | B | Initial Registration | | 16.1.0 | +| 2020-07 | CT#88 | CP-201033 | 0004 | 1 | B | HSS Event Exposure | | 16.1.0 | +| 2020-07 | CT#88 | CP-201033 | 0005 | 1 | F | Serving Node Deregistration | | 16.1.0 | +| 2020-07 | CT#88 | CP-201073 | 0006 | - | F | 29.563 Rel-16 API version and External doc update | | 16.1.0 | +| 2020-09 | CT#89 | CP-202111 | 0007 | - | F | UE Id Correction for EE Subscription | | 16.2.0 | +| 2020-09 | CT#89 | CP-202111 | 0008 | 1 | F | Correction of HSS Event Exposure data types | | 16.2.0 | +| 2020-09 | CT#89 | CP-202096 | 0009 | - | F | 29.563 Rel-16 API version and External doc update | | 16.2.0 | +| 2020-12 | CT#90 | CP-205049 | 0010 | 1 | F | Config APN for PDN connectivity status | | 16.3.0 | +| 2020-12 | CT#90 | CP-205049 | 0011 | 1 | F | Definition of SubscriptionData | | 16.3.0 | +| 2020-12 | CT#90 | CP-205049 | 0012 | - | F | References and Cardinality errors clean up | | 16.3.0 | +| 2020-12 | CT#90 | CP-205048 | 0013 | - | F | Storage of YAML files in GitLab | | 16.3.0 | +| 2020-12 | CT#90 | CP-205049 | 0014 | - | F | Reference ID | | 16.3.0 | +| 2020-12 | CT#90 | CP-205036 | 0015 | - | F | 29.563 Rel-16 API version and External doc update | | 16.3.0 | +| 2021-03 | CT#91 | CP-210042 | 0018 | - | F | GUAMI in Deregistration Request | | 16.4.0 | +| 2021-03 | CT#91 | CP-210054 | 0022 | - | F | 29.563 Rel-16 API version and External doc update | | 16.4.0 | +| 2021-03 | CT#91 | CP-210042 | 0023 | - | F | Cancellation Type sent to MME/SGSN when UE registers in 5G | | 16.4.0 | +| 2021-06 | CT#92 | CP-211064 | 0024 | - | F | Serving Node Deregistration | | 16.5.0 | +| 2021-06 | CT#92 | CP-211065 | 0030 | 2 | F | Monitored Resource URI | | 16.5.0 | +| 2021-06 | CT#92 | CP-211059 | 0032 | - | F | Redirect Responses | | 16.5.0 | +| 2021-06 | CT#92 | CP-211064 | 0034 | 1 | F | VLR Cancellation | | 16.5.0 | +| 2021-06 | CT#92 | CP-211073 | 0038 | - | F | 29.563 Rel-16 API version and External doc update | | 16.5.0 | +| 2021-09 | CT#93 | CP-212060 | 0039 | - | F | 3xx description correction for SCP | | 16.6.0 | +| 2021-09 | CT#93 | CP-212069 | 0042 | 1 | F | Immediate Report in Response | | 16.6.0 | +| 2021-09 | CT#93 | CP-212069 | 0044 | - | F | Missing Event Reports | | 16.6.0 | +| 2021-09 | CT#93 | CP-212080 | 0051 | - | F | 29.563 Rel-16 API version and External doc update | | 16.6.0 | +| 2022-03 | CT#95 | CP-220074 | 0054 | - | F | Essential Correction on Monitoring Events | | 16.7.0 | +| 2022-03 | CT#95 | CP-220074 | 0056 | - | F | Idle Status Indication | | 16.7.0 | +| 2022-03 | CT#95 | CP-220067 | 0060 | - | F | 29.563 Rel-16 API version and External doc update | | 16.7.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29572/053f1077d592e6622cd21dc4bb4cb366_img.jpg b/marked/Rel-16/29_series/29572/053f1077d592e6622cd21dc4bb4cb366_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..88b95115b8eff0983d597298b761cee5b5778af0 --- /dev/null +++ b/marked/Rel-16/29_series/29572/053f1077d592e6622cd21dc4bb4cb366_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4504febc2a53fe3f51df8ae9508c7493a7ca236d67078240a10d1b47a0393b51 +size 18133 diff --git a/marked/Rel-16/29_series/29572/40a8c30f7ea5ecea4912e040c97c5b9c_img.jpg b/marked/Rel-16/29_series/29572/40a8c30f7ea5ecea4912e040c97c5b9c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c2e8cfbdebb1be308875156e755537b1e2c78732 --- /dev/null +++ b/marked/Rel-16/29_series/29572/40a8c30f7ea5ecea4912e040c97c5b9c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e458a89776b7c567e8426ec44cddfc4da21288cfc53180a75cf5d95538e33f0a +size 14429 diff --git a/marked/Rel-16/29_series/29572/41a438d7e4adc17c3a4005e7c9500091_img.jpg b/marked/Rel-16/29_series/29572/41a438d7e4adc17c3a4005e7c9500091_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0949c97d72e539277501a067d0be4f74bb0667cd --- /dev/null +++ b/marked/Rel-16/29_series/29572/41a438d7e4adc17c3a4005e7c9500091_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:63d29bf828eb8e94e2e78f5279e4e04596de6153d4039249850d5774512b96a7 +size 32844 diff --git a/marked/Rel-16/29_series/29572/5dfc130b129ace4df375839020a5700d_img.jpg b/marked/Rel-16/29_series/29572/5dfc130b129ace4df375839020a5700d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8e49c80577ebd54b3d39ff0eaed3635c22b8f51a --- /dev/null +++ b/marked/Rel-16/29_series/29572/5dfc130b129ace4df375839020a5700d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:daf5f7ae4ee792038a2e905b9e1621f412404c5205992bf62469496a64bb2ff4 +size 29080 diff --git a/marked/Rel-16/29_series/29572/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-16/29_series/29572/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a19bb1d15f310d4383bcd2f2c7121758b8b1c549 --- /dev/null +++ b/marked/Rel-16/29_series/29572/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b52c3ae126f1f292d67354fbd4f023d5419d2ca7c9639b668580698f62c94185 +size 10064 diff --git a/marked/Rel-16/29_series/29572/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-16/29_series/29572/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..26fd53abef53f6006c18b37e7980ad7d9fc921af --- /dev/null +++ b/marked/Rel-16/29_series/29572/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6c809a272a0875e9ab4896d0496e46dd775d4ff800da817a9e1c51203f5d3c05 +size 5792 diff --git a/marked/Rel-16/29_series/29572/7f17c430b9598e4d748a8041457810b3_img.jpg b/marked/Rel-16/29_series/29572/7f17c430b9598e4d748a8041457810b3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ddb195874ba21258e335db809227701b9b6d21ae --- /dev/null +++ b/marked/Rel-16/29_series/29572/7f17c430b9598e4d748a8041457810b3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ef028b9d70377dbfdb42ac1ed3e750d3a3caa63835b262c551e6be13e7cb3c5e +size 32690 diff --git a/marked/Rel-16/29_series/29572/aa9441a5971655a79987d70fc551b26a_img.jpg b/marked/Rel-16/29_series/29572/aa9441a5971655a79987d70fc551b26a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..aa68efad6d522ac33626fd04b1742adb92365b71 --- /dev/null +++ b/marked/Rel-16/29_series/29572/aa9441a5971655a79987d70fc551b26a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:23e097e071af22159a1afc445cb9251ca28f671fa78e2e198492395708e90db0 +size 30114 diff --git a/marked/Rel-16/29_series/29572/d17f75945bbb3feb84a153ecfedb9b81_img.jpg b/marked/Rel-16/29_series/29572/d17f75945bbb3feb84a153ecfedb9b81_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..528bcf38967803c3363c9762e46bad60bc1fb003 --- /dev/null +++ b/marked/Rel-16/29_series/29572/d17f75945bbb3feb84a153ecfedb9b81_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8bfe85a9bcd3daf232292ec4a0e2f49945d04e285202f49494dfa2b2f7176936 +size 30986 diff --git a/marked/Rel-16/29_series/29572/df0bcbfa8f8e1937e071445426c28022_img.jpg b/marked/Rel-16/29_series/29572/df0bcbfa8f8e1937e071445426c28022_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5c99f638c61ed9e2742fd2bbdb749c6c1fc008e5 --- /dev/null +++ b/marked/Rel-16/29_series/29572/df0bcbfa8f8e1937e071445426c28022_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4b2a5fb45d1b40fc15ae96f0ca70a3fae0160af3bd2d287da52ec4daad06e7ee +size 32477 diff --git a/marked/Rel-16/29_series/29572/f14e75bd1c6e2f234db4775dbf0dbf1a_img.jpg b/marked/Rel-16/29_series/29572/f14e75bd1c6e2f234db4775dbf0dbf1a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..fbd7b179821d18e2f721da8698c89d11ec63dd36 --- /dev/null +++ b/marked/Rel-16/29_series/29572/f14e75bd1c6e2f234db4775dbf0dbf1a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1e1fb1ad5cff7e1e3134b1e72bff4c0c31a255926c6ba65f646ce31a5d029221 +size 30162 diff --git a/marked/Rel-16/29_series/29572/ff0952ef692c9d960ce5f6708bcc9711_img.jpg b/marked/Rel-16/29_series/29572/ff0952ef692c9d960ce5f6708bcc9711_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4a6e637d393c6be4d2e61211ab9915ab1b013aa3 --- /dev/null +++ b/marked/Rel-16/29_series/29572/ff0952ef692c9d960ce5f6708bcc9711_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d829d4605cb8ca7cd0ce73811baceae70a8692df4bb0a0714e207e8839355813 +size 30176 diff --git a/marked/Rel-16/29_series/29572/raw.md b/marked/Rel-16/29_series/29572/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..e64d4fbc2e3b6dcd4c6442f53f39bf934e73b2be --- /dev/null +++ b/marked/Rel-16/29_series/29572/raw.md @@ -0,0 +1,3965 @@ + + +# 3GPP TS 29.572 V16.9.0 (2022-03) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Location Management Services; Stage 3 (Release 16)** + +![5G logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The 5G logo, consisting of the text "5G" in a bold, black, sans-serif font. Above the "5G" text are three green curved lines representing signal waves. + +5G logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, featuring the letters "3GPP" in a stylized, bold, black font. Below the "3GPP" text is a red signal icon consisting of three curved lines. Below the icon, the text "A GLOBAL INITIATIVE" is written in a smaller, black, sans-serif font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|------------------------------------------------------------|----| +| Foreword ..... | 7 | +| 1 Scope..... | 8 | +| 2 References..... | 8 | +| 3 Definitions and abbreviations ..... | 9 | +| 3.1 Definitions..... | 9 | +| 3.2 Abbreviations ..... | 9 | +| 4 Overview..... | 9 | +| 5 Services Offered by the LMF..... | 10 | +| 5.1 Introduction ..... | 10 | +| 5.2 Nlmf_Location Service ..... | 10 | +| 5.2.1 Service Description ..... | 10 | +| 5.2.2 Service Operations..... | 11 | +| 5.2.2.1 Introduction..... | 11 | +| 5.2.2.2 DetermineLocation ..... | 11 | +| 5.2.2.2.1 General ..... | 11 | +| 5.2.2.2.2 Retrieve UE Location..... | 11 | +| 5.2.2.2.3 Retrieve UE Location for 5G-MO-LR ..... | 12 | +| 5.2.2.3 EventNotify..... | 12 | +| 5.2.2.3.1 General ..... | 12 | +| 5.2.2.3.2 Periodic or Triggered Event Notification ..... | 12 | +| 5.2.2.4 CancelLocation ..... | 13 | +| 5.2.2.4.1 General ..... | 13 | +| 5.2.2.4.2 Cancel Periodic or Triggered Location ..... | 13 | +| 5.2.2.5 LocationContextTransfer ..... | 14 | +| 5.2.2.5.1 General ..... | 14 | +| 5.2.2.5.2 Transfer Location Context ..... | 14 | +| 5.3 Nlmf_Broadcast Service ..... | 14 | +| 5.3.1 Service Description ..... | 14 | +| 5.3.2 Service Operations..... | 15 | +| 5.3.2.1 Introduction..... | 15 | +| 5.3.2.2 CipheringKeyData ..... | 15 | +| 5.3.2.2.1 General ..... | 15 | +| 5.3.2.2.2 Request Ciphering Key Information ..... | 15 | +| 5.3.2.2.3 Provide Ciphering Key Information..... | 15 | +| 6 API Definitions ..... | 16 | +| 6.1 Nlmf_Location Service API..... | 16 | +| 6.1.1 API URI..... | 16 | +| 6.1.2 Usage of HTTP..... | 17 | +| 6.1.2.1 General..... | 17 | +| 6.1.2.2 HTTP Standard Headers ..... | 17 | +| 6.1.2.2.1 General ..... | 17 | +| 6.1.2.2.2 Content type ..... | 17 | +| 6.1.2.3 HTTP custom headers..... | 17 | +| 6.1.2.3.1 General ..... | 17 | +| 6.1.2.4 HTTP multipart messages..... | 17 | +| 6.1.3 Resources..... | 18 | +| 6.1.3.1 Overview..... | 18 | +| 6.1.4 Custom Operations without associated resources ..... | 18 | +| 6.1.4.1 Overview..... | 18 | +| 6.1.4.2 Operation: determine-location ..... | 19 | +| 6.1.4.2.1 Description ..... | 19 | +| 6.1.4.2.2 Operation Definition ..... | 19 | +| 6.1.4.3 Operation: cancel-location..... | 21 | + +| | | | +|------------|----------------------------------------------------------|----| +| 6.1.4.3.1 | Description ..... | 21 | +| 6.1.4.3.2 | Operation Definition ..... | 21 | +| 6.1.4.4 | Operation: location-context-transfer ..... | 22 | +| 6.1.4.4.1 | Description ..... | 22 | +| 6.1.4.4.2 | Operation Definition ..... | 22 | +| 6.1.5 | Notifications ..... | 23 | +| 6.1.5.1 | EventNotify ..... | 24 | +| 6.1.5.1.1 | Description ..... | 24 | +| 6.1.5.1.2 | Notification Definition ..... | 24 | +| 6.1.5.1.3 | Notification Standard Methods ..... | 24 | +| 6.1.6 | Data Model ..... | 25 | +| 6.1.6.1 | General ..... | 25 | +| 6.1.6.2 | Structured data types ..... | 27 | +| 6.1.6.2.1 | Introduction ..... | 27 | +| 6.1.6.2.2 | Type: InputData ..... | 28 | +| 6.1.6.2.3 | Type: LocationData ..... | 29 | +| 6.1.6.2.4 | Type: GeographicalCoordinates ..... | 30 | +| 6.1.6.2.5 | Type: GeographicArea ..... | 30 | +| 6.1.6.2.6 | Type: Point ..... | 30 | +| 6.1.6.2.7 | Type: PointUncertaintyCircle ..... | 31 | +| 6.1.6.2.8 | Type: PointUncertaintyEllipse ..... | 31 | +| 6.1.6.2.9 | Type: Polygon ..... | 31 | +| 6.1.6.2.10 | Type: PointAltitude ..... | 31 | +| 6.1.6.2.11 | Type: PointAltitudeUncertainty ..... | 32 | +| 6.1.6.2.12 | Type: EllipsoidArc ..... | 32 | +| 6.1.6.2.13 | Type: LocationQoS ..... | 32 | +| 6.1.6.2.14 | Type: CivicAddress ..... | 33 | +| 6.1.6.2.15 | Type: PositioningMethodAndUsage ..... | 34 | +| 6.1.6.2.16 | Type: GnssPositioningMethodAndUsage ..... | 35 | +| 6.1.6.2.17 | Type: VelocityEstimate ..... | 35 | +| 6.1.6.2.18 | Type: HorizontalVelocity ..... | 35 | +| 6.1.6.2.19 | Type: HorizontalWithVerticalVelocity ..... | 35 | +| 6.1.6.2.20 | Type: HorizontalVelocityWithUncertainty ..... | 36 | +| 6.1.6.2.21 | Type: HorizontalWithVerticalVelocityAndUncertainty ..... | 36 | +| 6.1.6.2.22 | Type: UncertaintyEllipse ..... | 36 | +| 6.1.6.2.23 | Type: UeLcsCapability ..... | 36 | +| 6.1.6.2.24 | Type: PeriodicEventInfo ..... | 37 | +| 6.1.6.2.25 | Type: AreaEventInfo ..... | 37 | +| 6.1.6.2.26 | Type: ReportingArea ..... | 37 | +| 6.1.6.2.27 | Type: MotionEventInfo ..... | 38 | +| 6.1.6.2.28 | Void ..... | 38 | +| 6.1.6.2.29 | Type: CancelLocData ..... | 38 | +| 6.1.6.2.30 | Type: LocContextData ..... | 39 | +| 6.1.6.2.31 | Type: EventReportMessage ..... | 39 | +| 6.1.6.2.32 | Type: EventReportingStatus ..... | 40 | +| 6.1.6.2.33 | Type: UELocationInfo ..... | 40 | +| 6.1.6.2.34 | Type: EventNotifyData ..... | 41 | +| 6.1.6.2.35 | Type: UeConnectivityState ..... | 41 | +| 6.1.6.3 | Simple data types and enumerations ..... | 42 | +| 6.1.6.3.1 | Introduction ..... | 42 | +| 6.1.6.3.2 | Simple data types ..... | 42 | +| 6.1.6.3.3 | Enumeration: ExternalClientType ..... | 44 | +| 6.1.6.3.4 | Enumeration: SupportedGADShapes ..... | 44 | +| 6.1.6.3.5 | Enumeration: ResponseTime ..... | 44 | +| 6.1.6.3.6 | Enumeration: PositioningMethod ..... | 45 | +| 6.1.6.3.7 | Enumeration: PositioningMode ..... | 45 | +| 6.1.6.3.8 | Enumeration: GnssId ..... | 46 | +| 6.1.6.3.9 | Enumeration: Usage ..... | 46 | +| 6.1.6.3.10 | Enumeration: LcsPriority ..... | 46 | +| 6.1.6.3.11 | Enumeration: VelocityRequested ..... | 46 | +| 6.1.6.3.12 | Enumeration: AccuracyFulfilmentIndicator ..... | 47 | +| 6.1.6.3.13 | Enumeration: VerticalDirection ..... | 47 | + +| | | | +|------------|------------------------------------------------------|----| +| 6.1.6.3.14 | Enumeration: LdrType ..... | 47 | +| 6.1.6.3.15 | Enumeration: ReportingAreaType ..... | 47 | +| 6.1.6.3.16 | Enumeration: OccurrenceInfo ..... | 47 | +| 6.1.6.3.17 | Enumeration: ReportingAccessType..... | 48 | +| 6.1.6.3.18 | Enumeration: EventClass ..... | 48 | +| 6.1.6.3.19 | Enumeration: ReportedEventType ..... | 48 | +| 6.1.6.3.20 | Enumeration: TerminationCause..... | 48 | +| 6.1.6.3.21 | Enumeration: LcsQosClass ..... | 49 | +| 6.1.6.3.22 | Enumeration: UeLocationServiceInd..... | 49 | +| 6.1.6.4 | Binary data ..... | 49 | +| 6.1.6.4.1 | Introduction ..... | 49 | +| 6.1.6.4.2 | LPP Message ..... | 49 | +| 6.1.7 | Error Handling ..... | 49 | +| 6.1.7.1 | General ..... | 49 | +| 6.1.7.2 | Protocol Errors ..... | 49 | +| 6.1.7.3 | Application Errors ..... | 49 | +| 6.1.8 | Security ..... | 50 | +| 6.1.9 | Feature Negotiation ..... | 50 | +| 6.1.10 | HTTP redirection..... | 50 | +| 6.2 | Nlmf_Broadcast Service API..... | 50 | +| 6.2.1 | API URI ..... | 50 | +| 6.2.2 | Usage of HTTP ..... | 51 | +| 6.2.2.1 | General ..... | 51 | +| 6.2.2.2 | HTTP Standard Headers ..... | 51 | +| 6.2.2.2.1 | General ..... | 51 | +| 6.2.2.2.2 | Content type ..... | 51 | +| 6.2.2.3 | HTTP custom headers..... | 51 | +| 6.2.2.3.1 | General ..... | 51 | +| 6.2.3 | Resources ..... | 51 | +| 6.2.3.1 | Overview ..... | 51 | +| 6.2.4 | Custom Operations without associated resources ..... | 52 | +| 6.2.4.1 | Overview ..... | 52 | +| 6.2.4.4 | Operation: cipher-key-data ..... | 52 | +| 6.2.4.4.1 | Description ..... | 52 | +| 6.2.4.4.2 | Operation Definition ..... | 52 | +| 6.2.5 | Notifications ..... | 53 | +| 6.2.5.1 | CipheringKeyData ..... | 53 | +| 6.2.5.1.1 | Description ..... | 53 | +| 6.2.5.1.2 | Notification Definition ..... | 54 | +| 6.2.5.1.3 | Notification Standard Methods ..... | 54 | +| 6.2.6 | Data Model ..... | 55 | +| 6.2.6.1 | General ..... | 55 | +| 6.2.6.2 | Structured data types..... | 56 | +| 6.2.6.2.1 | Introduction ..... | 56 | +| 6.2.6.2.2 | Type: CipheringKeyInfo ..... | 56 | +| 6.2.6.2.3 | Type: CipheringKeyResponse..... | 56 | +| 6.2.6.2.4 | Type: CipheringDataSet..... | 57 | +| 6.2.6.2.5 | Type: CipheringSetReport..... | 60 | +| 6.2.6.2.6 | Type: CipherRequestData ..... | 60 | +| 6.2.6.2.7 | Type: CipherResponseData..... | 60 | +| 6.2.6.3 | Simple data types and enumerations..... | 60 | +| 6.2.6.3.1 | Introduction ..... | 60 | +| 6.2.6.3.2 | Simple data types ..... | 60 | +| 6.2.6.3.3 | Enumeration: StorageOutcome ..... | 61 | +| 6.2.6.3.4 | Enumeration: DataAvailability ..... | 61 | +| 6.2.7 | Error Handling ..... | 61 | +| 6.2.7.1 | General ..... | 61 | +| 6.2.7.2 | Protocol Errors ..... | 61 | +| 6.2.7.3 | Application Errors ..... | 61 | +| 6.2.8 | Security ..... | 62 | +| 6.2.9 | Feature Negotiation ..... | 62 | +| 6.2.10 | HTTP redirection..... | 62 | + +**Annex A (normative): OpenAPI specification ..... 62** +A.1 General ..... 62 +A.2 Nlmf\_Location API..... 63 +A.3 Nlmf\_Broadcast API..... 78 +**Annex B (informative): Change history..... 82** + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document specifies the stage 3 protocol and data model for the Nlmf Service Based Interface. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the LMF. + +The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] IETF RFC 4776: "Dynamic Host Configuration Protocol (DHCPv4 and DHCPv6) Option for Civic Addresses Configuration Information". +- [7] IETF RFC 5139: "Revised Civic Location Format for Presence Information Data Format Location Object (PIDF-LO)". +- [8] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". +- [9] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [10] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [11] 3GPP TS 29.510: "Network Function Repository Services; Stage 3". +- [12] IETF RFC 7540: "Hypertext Transfer Protocol Version 2 (HTTP/2)". +- [13] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". + +- [14] OpenAPI Initiative, "OpenAPI 3.0.0 Specification", . +- [15] IETF RFC 7807: "Problem Details for HTTP APIs". +- [16] 3GPP TR 21.900: "Technical Specification Group working methods". +- [17] 3GPP TS 22.071: "Location Services (LCS); Service description; Stage 1". +- [18] 3GPP TS 29.002: "Mobile Application Part (MAP) specification". +- [19] 3GPP TS 23.273: "5G System (5GS) Location Services (LCS); Stage 2". +- [20] 3GPP TS 24.080: "Mobile radio interface layer 3 Supplementary services specification; Formats and coding". +- [21] 3GPP TS 36.355: "Evolved Universal Terrestrial Radio Access (E-UTRA); LTE Positioning Protocol (LPP)". +- [22] 3GPP TS 24.501: "Non-Access-Stratum (NAS) protocol for 5G System (5GS); Stage 3". +- [23] 3GPP TS 29.518: "Access and Mobility Management Services". +- [24] 3GPP TS 29.171: "Location Services (LCS); LCS Application Protocol (LCS-AP) between the Mobile Management Entity (MME) and Evolved Serving Mobile Location Centre (E-SMLC); SLs interface". +- [25] IETF RFC 4119: "A Presence-based GEOPRIV Location Object Format". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|-----|------------------------------| +| LDR | Location Deferred Request | +| LMF | Location Management Function | + +# --- 4 Overview + +The Location Management Function (LMF) is the network entity in the 5G Core Network (5GC) supporting the following functionality: + +- Supports location determination for a UE. +- Obtains downlink location measurements or a location estimate from the UE. +- Obtains uplink location measurements from the NG RAN. +- Obtains non-UE associated assistance data from the NG RAN. + +- Provides broadcast assistance data to UEs and forwards associated ciphering keys to an AMF. + +Other functions of an LMF are listed in clause 4.3.8 of 3GPP TS 23.273 [19]. + +Figure 4-1 provides the reference model (in service based interface representation and in reference point representation), with focus on the LMF: + +![Figure 4-1: Reference model – LMF. The diagram shows three network functions (NFs) on the left: LMF, AMF, and GMLC. The LMF is connected to the AMF via the NL7 interface. The AMF is connected to the GMLC via the NL1 interface. The GMLC is connected to the LMF via the Nlmf interface. The LMF is represented by a green rectangle, the AMF by a green rectangle, and the GMLC by a green rectangle. The Nlmf interface is represented by a circle on the LMF side.](053f1077d592e6622cd21dc4bb4cb366_img.jpg) + +Figure 4-1: Reference model – LMF. The diagram shows three network functions (NFs) on the left: LMF, AMF, and GMLC. The LMF is connected to the AMF via the NL7 interface. The AMF is connected to the GMLC via the NL1 interface. The GMLC is connected to the LMF via the Nlmf interface. The LMF is represented by a green rectangle, the AMF by a green rectangle, and the GMLC by a green rectangle. The Nlmf interface is represented by a circle on the LMF side. + +Figure 4-1: Reference model – LMF + +# 5 Services Offered by the LMF + +## 5.1 Introduction + +The LMF offers to other NFs the following services: + +- Nlmf\_Location +- Nlmf\_Broadcast + +Table 5.1-1 summarizes the corresponding APIs defined for this specification. + +Table 5.1-1: API Descriptions + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex | +|----------------|--------|-----------------------|-----------------------------|----------------|-------| +| Nlmf_Location | 6.1 | LMF Location Service | TS29572_Nlmf_Location.yaml | nlmf-loc | A.2 | +| Nlmf_Broadcast | 6.2 | LMF Broadcast Service | TS29572_Nlmf_Broadcast.yaml | nlmf-broadcast | A.3 | + +## 5.2 Nlmf\_Location Service + +### 5.2.1 Service Description + +The Nlmf\_Location service enables an NF to request location determination (current geodetic and optionally civic location) for a target UE or to request periodic or triggered location for a target UE. + +### 5.2.2 Service Operations + +#### 5.2.2.1 Introduction + +The service operations defined for the Nlmf\_Location service are as follows: + +- DetermineLocation: It provides UE location information to the consumer NF. +- EventNotify: It notifies the consumer NF of an event for periodic or triggered location for a target UE. +- CancelLocation: It enables a consumer NF to cancel an ongoing periodic or triggered location for a target UE. +- LocationContextTransfer: It enables a consumer NF to transfer location context information for periodic or triggered location of a target UE to a new LMF. + +#### 5.2.2.2 DetermineLocation + +##### 5.2.2.2.1 General + +The following procedures are defined, using the "DetermineLocation" service operation: + +- Retrieve UE Location +- Retrieve UE Location for 5G-MO-LR + +##### 5.2.2.2.2 Retrieve UE Location + +This procedure allows a consumer NF to request the location information (geodetic location and, optionally, civic location) for a target UE or to activate periodic or triggered deferred location for a target UE. + +![Sequence diagram illustrating the DetermineLocation Request procedure between an NF Service Consumer and an LMF.](f14e75bd1c6e2f234db4775dbf0dbf1a_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant LMF + Note left of NF Service Consumer: + NF Service Consumer->>LMF: 1. POST ../determine-location (InputData) + Note right of LMF: + LMF-->>NF Service Consumer: 2a. 200 OK (LocationData) + Note right of LMF: + LMF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +The diagram shows a sequence of interactions between an NF Service Consumer and an LMF. + 1. The NF Service Consumer sends a POST request to the LMF with the URI ../determine-location and InputData. + 2. The LMF responds with either a 200 OK (LocationData) or a 4xx/5xx (ProblemDetails) or 3xx status code. + +Sequence diagram illustrating the DetermineLocation Request procedure between an NF Service Consumer and an LMF. + +Figure 5.2.2.2.2-1: DetermineLocation Request + +1. The NF Service Consumer shall send an HTTP POST request to the resource URI associated with the "determine-location" custom operation. The input parameters for the request (external client type, LCS correlation identifier, serving cell identifier, location QoS, supported GAD shapes, LDR Type, H-GMLC address, LDR Reference, UE connectivity state per access type ...) may be included in the HTTP POST request body. + +If UE LCS Capability is received in the request indicating LPP is not supported by the UE, the LMF shall not send LPP messages to the UE in subsequent positioning procedures. + +- 2a. On success, "200 OK" shall be returned. The response body shall contain the parameters related to the determined position of the UE if any (geodetic position, civic location, positioning methods...). +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.4.2.2-2 shall be returned. For a 4xx/5xx response, the message body should contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.4.2.2-2. + +##### 5.2.2.2.3 Retrieve UE Location for 5G-MO-LR + +This procedure allows a consumer NF (i.e. an AMF) to request the location information or location assistance data for a target UE which initiates MO-LR procedure (see 3GPP TS 23.273 [19]). + +![Sequence diagram for DetermineLocation Request for 5G-MO-LR. The diagram shows two lifelines: 'NF Service Consumer' on the left and 'LMF' on the right. Step 1: A solid arrow points from the NF Service Consumer to the LMF with the message '1. POST .../determine-location (InputData)'. Step 2a: A solid arrow points from the LMF back to the NF Service Consumer with the message '2a. 200 OK (LocationData) or 204 No Content'. Step 2b: A dashed arrow points from the LMF back to the NF Service Consumer with the message '2b. 4xx/5xx (ProblemDetails) or 3xx'.](7f17c430b9598e4d748a8041457810b3_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant LMF + Note left of NF Service Consumer: + Note right of LMF: + NF Service Consumer->>LMF: 1. POST .../determine-location (InputData) + LMF-->>NF Service Consumer: 2a. 200 OK (LocationData) or 204 No Content + LMF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram for DetermineLocation Request for 5G-MO-LR. The diagram shows two lifelines: 'NF Service Consumer' on the left and 'LMF' on the right. Step 1: A solid arrow points from the NF Service Consumer to the LMF with the message '1. POST .../determine-location (InputData)'. Step 2a: A solid arrow points from the LMF back to the NF Service Consumer with the message '2a. 200 OK (LocationData) or 204 No Content'. Step 2b: A dashed arrow points from the LMF back to the NF Service Consumer with the message '2b. 4xx/5xx (ProblemDetails) or 3xx'. + +**Figure 5.2.2.2.3-1: DetermineLocation Request for 5G-MO-LR** + +The same requirements in clause 5.2.2.2.2 shall be applied with following modifications: + +1. Same as step 1 of figure 5.2.2.2.2-1, the request body shall include the following additional information: + - The indication received from UE indicating whether a location estimate or location assistance data is required. + - An LPP message if it is received in MO-LR Request from UE +- 2a. Same as step 2a of figure 5.2.2.2.2-1 if a consumer NF requests the location information for a target UE. If a NF consumer requests location assistance data for a target UE and LMF has successfully delivered location assistance data to the UE, 204 No Content shall be returned. +- 2b. Same as step 2b of figure 5.2.2.2.2-1. + +#### 5.2.2.3 EventNotify + +##### 5.2.2.3.1 General + +The following procedures are defined, using the "EventNotify" service operation: + +- Periodic or Triggered Event Notification + +##### 5.2.2.3.2 Periodic or Triggered Event Notification + +This procedure notifies the NF Service Consumer (i.e. GMLC) about event information related to periodic or triggered location of a target UE. The notification is delivered to: + +- the callback URI of an H-GMLC received (from an AMF) during an earlier DetermineLocation service operation if still available and if the LMF is configured for direct access to the H-GMLC; +- the callback URI of an H-GMLC received (from another LMF) during an earlier LocationContextTransfer service operation if still available and if the LMF is configured for direct access to the H-GMLC; +- the callback URI of an H-GMLC received (from the target UE) in a supplementary services event report if the LMF is configured for direct access to the H-GMLC; + +otherwise (if not available), + +- the callback URI of a V-GMLC registered in the NRF, if the V-GMLC registered to the NRF with notification endpoints for periodic or triggered event notifications; or + +otherwise (if not available), + +- the URI of a V-GMLC locally provisioned in the LMF. + +![Sequence diagram for EventNotify Request. The LMF sends a POST request to the NF Service Consumer. The NF Service Consumer responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection) status code.](ff0952ef692c9d960ce5f6708bcc9711_img.jpg) + +``` + +sequenceDiagram + participant LMF + participant NF Service Consumer + Note left of LMF: 1. POST {hgmlcCallbackURI}(EventNotifyData) + LMF->>NF Service Consumer: 1. POST {hgmlcCallbackURI}(EventNotifyData) + Note right of NF Service Consumer: 2a. 204 No Content + NF Service Consumer-->>LMF: 2a. 204 No Content + Note right of NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + NF Service Consumer-->>LMF: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram for EventNotify Request. The LMF sends a POST request to the NF Service Consumer. The NF Service Consumer responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection) status code. + +Figure 5.2.2.3.2-1: EventNotify Request + +1. The LMF shall send a POST request to the GMLC callback URI determined as described above. The request body shall include a notification correlation ID (LDR reference), the UE identification (SUPI and if available GPSI), the type of event and may include a geodetic location, civic location, position methods used, and other available parameters related to the position if any (e.g. Velocity, Altitude etc.), H-GMLC callback URI (if the NF consumer is a V-GMLC) and serving LMF identification. +- 2a. On success, "204 No content" shall be returned by the NF Service Consumer. +- 2b. On failure or redirection, the appropriate HTTP status code (e.g. "403 Forbidden") indicating the error shall be returned and the message body should contain a ProblemDetails structure indicating appropriate additional error information. + +#### 5.2.2.4 CancelLocation + +##### 5.2.2.4.1 General + +The following procedures are defined, using the "CancelLocation" service operation: + +- Cancel Periodic or Triggered Location + +##### 5.2.2.4.2 Cancel Periodic or Triggered Location + +This procedure allows a consumer NF to cancel periodic or triggered location for a target UE. The cancellation is delivered to a resource URI on the serving LMF identified by the serving LMF identification provided to the consumer NF (i.e. AMF) by a V-GMLC or H-GMLC (see 3GPP TS 23.273 [19]). + +![Sequence diagram for CancelLocation Request. The NF Service Consumer sends a POST request to the LMF. The LMF responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection) status code.](5dfc130b129ace4df375839020a5700d_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant LMF + Note left of NF Service Consumer: 1. POST {servingLMFURI} (CancelLocData) + NF Service Consumer->>LMF: 1. POST {servingLMFURI} (CancelLocData) + Note right of LMF: 2a. 204 No Content + LMF-->>NF Service Consumer: 2a. 204 No Content + Note right of LMF: 2b. 4xx/5xx (ProblemDetails) or 3xx + LMF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram for CancelLocation Request. The NF Service Consumer sends a POST request to the LMF. The LMF responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection) status code. + +Figure 5.2.2.4.2-1: CancelLocation Request + +1. The NF Service Consumer shall send an HTTP POST request to the resource URI of "cancel-location" custom operation on the serving LMF. The request body shall include a notification correlation ID (LDR reference) and an H-GMLC callback URI. +- 2a. On success, "204 No content" shall be returned by the LMF. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.4.3.2-2 shall be returned. For a 4xx/5xx response, the message body should contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.1.4.3.2-2. + +#### 5.2.2.5 LocationContextTransfer + +##### 5.2.2.5.1 General + +The following procedures are defined, using the "LocationContextTransfer" service operation: + +- Transfer Location Context + +##### 5.2.2.5.2 Transfer Location Context + +This procedure allows a NF service consumer (e.g. the old LMF) to transfer location context information for periodic or triggered location for a target UE (see clause 6.4 and clause 6.7.2 of 3GPP TS 23.273 [19]). The NF service consumer discovers the service URI of the new LMF by performing a discovery via NRF using: + +- the identification of the LMF received (from an AMF) during an earlier Namf\_Communication\_N1MessageNotify service operation to the consumer NF; +- otherwise (if not available), +- the identification of an LMF locally provisioned in the consumer NF. + +![Sequence diagram showing the LocationContextTransfer Request. An NF Service Consumer sends a POST request to an LMF. The LMF responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection) response.](d17f75945bbb3feb84a153ecfedb9b81_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant LMF + Note left of NF Service Consumer: Request + NF Service Consumer->>LMF: 1. POST ../location-context-transfer (LocContextData) + Note right of LMF: Success? + LMF-->>NF Service Consumer: 2a. 204 No Content + Note right of LMF: Failure? + LMF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing the LocationContextTransfer Request. An NF Service Consumer sends a POST request to an LMF. The LMF responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection) response. + +**Figure 5.2.2.5.2-1: LocationContextTransfer Request** + +1. The NF Service Consumer shall send an HTTP POST request to the Custom operation URI ("/location-context-transfer") on the Service URI discovered as described above. The request body shall include an AMF identity, Deferred location type, Deferred location parameters, Notification Target Address (H-GMLC callback URI), Notification Correlation ID (LDR reference), an embedded event report message and may include an event reporting status and UE location information, and shall include an indication of Control Plane CIoT 5GS Optimisation if N1 message is received from the UE with Control Plane CIoT 5GS Optimisation. +- 2a. On success, "204 No content" shall be returned by the LMF. +- 2b. On failure or redirection, one of the HTTP status codes listed in Table 6.1.4.4.2-2 shall be returned. For a 4xx/5xx response, the message body should contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.4.4.2-2. + +## 5.3 Nlmf\_Broadcast Service + +### 5.3.1 Service Description + +The Nlmf\_Broadcast service enables an NF to obtain ciphering keys and associated parameters applicable to location assistance data that is broadcast to subscribed UEs in ciphered form. + +### 5.3.2 Service Operations + +#### 5.3.2.1 Introduction + +The service operations defined for the Nlmf\_Broadcast service are as follows: + +- CipheringKeyData: It provides the ciphering key information to the consumer NF. + +#### 5.3.2.2 CipheringKeyData + +##### 5.3.2.2.1 General + +The following procedures are defined, using the "CipheringKeyData" service operation: + +- Request Ciphering Key Information +- Provide Ciphering Key Information + +NOTE: The Request Ciphering Key procedure is included in order to provide a valid context in OpenAPI version 3 for the Provide Ciphering Key Information procedure. The Request Ciphering Key procedure is not used for support of ciphering key transfer in 3GPP TS 23.273 [19] and hence need not be supported by an NF Service Consumer or by an LMF. + +##### 5.3.2.2.2 Request Ciphering Key Information + +This procedure allows a consumer NF to request ciphering key information. + +![Sequence diagram showing the Request Ciphering Key Information procedure. The NF Service Consumer sends a POST request to the LMF, and the LMF responds with a 200 OK or an error status code.](df0bcbfa8f8e1937e071445426c28022_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant LMF + Note left of NF Service Consumer: Request Ciphering Key Information + NF Service Consumer->>LMF: 1. POST .../cipher-key-data (CipherRequestData) + LMF-->>NF Service Consumer: 2a. 200 OK (CipherResponseData) + LMF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing the Request Ciphering Key Information procedure. The NF Service Consumer sends a POST request to the LMF, and the LMF responds with a 200 OK or an error status code. + +**Figure 5.3.2.2.2-1: CipheringKeyData Request** + +1. The NF Service Consumer shall send an HTTP POST request to the resource URI associated with the "cipher-key-data" custom operation. The request body shall include a notification callback URI. +- 2a. On success, "200 OK" shall be returned. The response body shall indicate whether the LMF has ciphering key data. If the LMF has ciphering key data, the Provide Ciphering Key Information procedure is used to provide the ciphering key data to the NF Service Consumer. +- 2b. On failure or redirection, one of the HTTP status codes listed in Table 6.2.4.4.2-2 shall be returned. For a 4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.2.7.3-1. + +##### 5.3.2.2.3 Provide Ciphering Key Information + +This procedure notifies the NF Service Consumer (i.e. AMF) about updated ciphering key information applicable to broadcast of location assistance data in ciphered form to subscribed UEs. The notification is delivered to: + +- the callback URI of an AMF received during an earlier CipheringKeyData request service operation if still available; or +- a callback URI registered in the NRF, if the AMF registered to the NRF with notification endpoints for ciphering key data notifications; + +Otherwise (if not available), + +- an AMF callback URI locally provisioned in the LMF. + +The procedure is invoked by issuing a POST request to the callback URI of the NF Service Consumer. See figure 5.3.2.2.3-1. + +![Sequence diagram showing the interaction between LMF and NF Service Consumer for CipheringKeyData Notify. The LMF sends a POST request with amfCallBackURI and CipheringKeyInfo to the NF Service Consumer. The NF Service Consumer responds with either a 200 OK with CipheringKeyResponse, or a 4xx/5xx with ProblemDetails, or a 3xx status code.](41a438d7e4adc17c3a4005e7c9500091_img.jpg) + +``` + +sequenceDiagram + participant LMF + participant NFSC as NF Service Consumer + Note left of LMF: LMF + Note right of NFSC: NF Service Consumer + LMF->>NFSC: 1. POST {amfCallBackURI} (CipheringKeyInfo) + NFSC-->>LMF: 2a. 200 OK (CipheringKeyResponse) + NFSC-->>LMF: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing the interaction between LMF and NF Service Consumer for CipheringKeyData Notify. The LMF sends a POST request with amfCallBackURI and CipheringKeyInfo to the NF Service Consumer. The NF Service Consumer responds with either a 200 OK with CipheringKeyResponse, or a 4xx/5xx with ProblemDetails, or a 3xx status code. + +Figure 5.3.2.2.3-1: CipheringKeyData Notify + +1. The LMF shall send an HTTP POST request to the callback URI for the NF service consumer determined as described above. The request body shall include one or more ciphering keys and for each ciphering key may include a ciphering key value, ciphering key identifier, validity period and set of applicable types of broadcast assistance data. +- 2a. On success or partial success, "200 OK" shall be returned. The response body shall indicate which ciphering key information was successfully stored by the NF service consumer. +- 2b. On failure or redirection to store any ciphering key information, one of the HTTP status codes listed in table 6.2.5.1.3.1-2 shall be returned. For a 4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in table 6.2.5.1.3.1-2. + +# 6 API Definitions + +## 6.1 Nlmf\_Location Service API + +### 6.1.1 API URI + +The Nlmf\_Location service shall use the Nlmf\_Location API. + +The API URI of the Nlmf\_Location API shall be: + +**{apiRoot}
//** + +The request URI used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}
//** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nlmf-loc". +- The shall be "v1". +- The shall be set as described in clause 6.1.3. + +### 6.1.2 Usage of HTTP + +#### 6.1.2.1 General + +HTTP/2, as defined in IETF RFC 7540 [12], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +HTTP messages and bodies for the Nlmf\_Location service shall comply with the OpenAPI [14] specification contained in Annex A. + +#### 6.1.2.2 HTTP Standard Headers + +##### 6.1.2.2.1 General + +##### 6.1.2.2.2 Content type + +The following content types shall be supported: + +- JSON, as defined in IETF RFC 8259 [13], shall be used as content type of the HTTP bodies specified in the present specification as indicated in clause 5.4 of 3GPP TS 29.500 [4]. +- The Problem Details JSON Object (IETF RFC 7807 [15]). The use of the Problem Details JSON object in a HTTP response body shall be signalled by the content type "application/problem+json". + +Multipart messages shall also be supported (see clause 6.1.2.4) using the content type "multipart/related", comprising: + +- one JSON body part with the "application/json" content type; and +- one or more binary body parts with 3gpp vendor specific content subtypes. + +The 3gpp vendor specific content subtypes defined in Table 6.1.2.2.2-1 shall be supported. + +**Table 6.1.2.2.2-1: 3GPP vendor specific content subtypes** + +| content subtype | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------| +| vnd.3gpp.lpp | Binary encoded payload, encoding LTE Positioning Protocol (LPP) IEs, as specified in 3GPP TS 36.355 [21]. | +| NOTE: Using 3GPP vendor content subtypes allows to describe the nature of the opaque payload (e.g. LPP information) without having to rely on metadata in the JSON payload. | | + +See clause 6.1.2.4 for the binary payloads supported in the binary body part of multipart messages. + +#### 6.1.2.3 HTTP custom headers + +##### 6.1.2.3.1 General + +The following HTTP custom headers shall be supported: + +- 3gpp-Sbi-Message-Priority: See 3GPP TS 29.500 [4], clause 5.2.3.2.2. + +This API does not define any new HTTP custom headers. + +#### 6.1.2.4 HTTP multipart messages + +HTTP multipart messages shall be supported, to transfer opaque LPP Information, in the following service operations (and HTTP messages): + +- DetermineLocation Request (POST); + +HTTP multipart messages shall include one JSON body part and one or more binary body parts comprising: + +- one LPP payload (see clause 6.1.6.4). + +The JSON body part shall be the "root" body part of the multipart message. It shall be encoded as the first body part of the multipart message. The "Start" parameter does not need to be included. + +The multipart message shall include a "type" parameter (see IETF RFC 2387 [9]) specifying the media type of the root body part, i.e. "application/json". + +NOTE: The "root" body part (or "root" object) is the first body part the application processes when receiving a multipart/related message, see IETF RFC 2387 [9]. The default root is the first body within the multipart/related message. The "Start" parameter indicates the root body part, e.g. when this is not the first body part in the message. + +For each binary body part in a HTTP multipart message, the binary body part shall include a Content-ID header (see IETF RFC 2045 [10]), and the JSON body part shall include an attribute, defined with the RefToBinaryData type, that contains the value of the Content-ID header field of the referenced binary body part. + +### 6.1.3 Resources + +#### 6.1.3.1 Overview + +The structure of the Resource URIs of the Nlmf\_Location service is shown in figure 6.1.3.1-1. + +![Diagram showing the Resource URI structure of the Nlmf_Location API. The root URI is {apiRoot}/nlmf-loc/. It branches into three sub-URIs: /determine-location, /cancel-location, and /location-context-transfer, each enclosed in a dashed box.](aa9441a5971655a79987d70fc551b26a_img.jpg) + +``` + +graph TD + Root["{apiRoot}/nlmf-loc/"] --- Dashed1["/determine-location"] + Root --- Dashed2["/cancel-location"] + Root --- Dashed3["/location-context-transfer"] + +``` + +Diagram showing the Resource URI structure of the Nlmf\_Location API. The root URI is {apiRoot}/nlmf-loc/. It branches into three sub-URIs: /determine-location, /cancel-location, and /location-context-transfer, each enclosed in a dashed box. + +Figure 6.1.3.1-1: Resource URI structure of the Nlmf\_Location API + +### 6.1.4 Custom Operations without associated resources + +#### 6.1.4.1 Overview + +Table 6.1.4.1-1: Custom operations without associated resources + +| Operation Name | Custom operation URI | Mapped HTTP method | Description (Service Operation) | +|---------------------------|----------------------------|--------------------|---------------------------------| +| determine-location | /determine-location | POST | Determine Location | +| cancel-location | /cancel-location | POST | Cancel Location | +| location-context-transfer | /location-context-transfer | POST | Transfer Location Context | + +#### 6.1.4.2 Operation: determine-location + +##### 6.1.4.2.1 Description + +This subclause will describe the custom operation and what it is used for, and the custom operation's URI. + +##### 6.1.4.2.2 Operation Definition + +This operation shall support the response data structures and response codes specified in tables 6.1.4.2.2-1 and 6.1.4.2.2-2. + +**Table 6.1.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|--------------------------------------------------------| +| InputData | M | 1 | Input parameters to the "Determine Location" operation | + +Table 6.1.4.2.2-2: Data structures supported by the POST Response Body on this resource + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|---------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| LocationData | M | 1 | 200 OK | This case represents the successful retrieval of the location of the UE or successful activation of periodic or triggered location in the UE.

Upon success, a response body is returned containing the different parameters of the location data if obtained, such as:
  • - Geographic Area
  • - Civic Location
  • - Positioning methods
| +| n/a | | | 204 No Content | This case represents the successful delivery of location assistance data to the UE, during MO-LR requesting for location assistance data for the UE. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same LMF or LMF (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same LMF or LMF (service) set. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application errors:
  • - POSITIONING_DENIED
  • - UNSPECIFIED
  • - UNSUPPORTED_BY_UE
See table 6.1.7.3-1 for the description of these errors. | +| ProblemDetails | O | 0..1 | 500 Internal Server Error | The "cause" attribute may be used to indicate the following application error:
  • - POSITIONING_FAILED
See table 6.1.7.3-1 for the description of these errors. | +| ProblemDetails | O | 0..1 | 504 Gateway Timeout | The "cause" attribute may be used to indicate the following application error:
  • - UNREACHABLE_USER
See table 6.1.7.3-1 for the description of this error. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +Table 6.1.4.2.2-3: Headers supported by the 307 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same LMF or LMF (service) set. Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.4.2.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same LMF or LMF (service) set. Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +#### 6.1.4.3 Operation: cancel-location + +##### 6.1.4.3.1 Description + +This clause describes the custom operation and what it is used for. + +##### 6.1.4.3.2 Operation Definition + +This operation shall support the request and response data structures and response codes specified in table 6.1.4.3.2-1 and table 6.1.4.3.2-2. + +**Table 6.1.4.3.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------|---|-------------|------------------------------------------| +| CancelLocData | M | 1 | The information used to cancel location. | + +**Table 6.1.4.3.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | This case represents successful cancellation of location. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same LMF or LMF (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same LMF or LMF (service) set. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application errors:
- UNSPECIFIED
- LOCATION_SESSION_UNKNOWN

See table 6.1.7.3-1 for the description of this error. | +| NOTE: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). | | | | | + +**Table 6.1.4.3.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same LMF or LMF (service) set. Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.4.3.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same LMF or LMF (service) set. Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +#### 6.1.4.4 Operation: location-context-transfer + +##### 6.1.4.4.1 Description + +This clause will describe the custom operation and what it is used for. + +##### 6.1.4.4.2 Operation Definition + +This operation shall support the request and response data structures and response codes specified in table 6.1.4.4.2-1 and table 6.1.4.4.2-2. + +**Table 6.1.4.4.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------|---|-------------|---------------------------------------------------------------| +| LocContextData | M | 1 | Input parameters to the "Location Context Transfer" operation | + +**Table 6.1.4.4.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | This case represents successful transfer of the location context. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same LMF or LMF (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same LMF or LMF (service) set. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application errors:
  • - UNSPECIFIED
  • - LOCATION_TRANSFER_NOT_SUPPORTED
  • - INSUFFICIENT_RESOURCES
  • - EVENT_REPORT_UNRECOGNIZED
See table 6.1.7.3-1 for the description of this error. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +**Table 6.1.4.4.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same LMF or LMF (service) set. Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.4.4.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same LMF or LMF (service) set. Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +### 6.1.5 Notifications + +This clause specifies the notifications provided by the Nlmf\_Location service. + +**Table 6.1.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|--------------|--------------------|---------------------------------|---------------------------------| +| EventNotify | {hgmlcCallBackURI} | POST | | + +#### 6.1.5.1 EventNotify + +##### 6.1.5.1.1 Description + +The EventNotify operation is used to notify the occurrence of periodic or triggered location event for a target UE to a consumer NF (e.g. GMLC). + +##### 6.1.5.1.2 Notification Definition + +Callback URI: {hgmlcCallBackURI} + +See clause 5.2.2.1.2 for the description of how the LMF obtains the Callback URI of the NF Service Consumer (e.g. GMLC). + +##### 6.1.5.1.3 Notification Standard Methods + +###### 6.1.5.1.3.1 POST + +This method sends a Location event notify to the NF Service Consumer. + +This method shall support the request and response data structures and response codes specified in table 6.1.5.1.3.1-1 and table 6.1.5.1.3.1-2. + +**Table 6.1.5.1.3.1-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|-----------------|---|-------------|-----------------------------------------------------------| +| EventNotifyData | M | 1 | Input parameters to the "Location Event Notify" operation | + +**Table 6.1.5.1.3.1-2: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | This case represents successful notification of the event. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The NF service consumer shall generate a Location header field containing a URI pointing to the endpoint of another NF service consumer to which the notification should be sent.
If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service consumer to which the notification should be sent. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The NF service consumer shall generate a Location header field containing a URI pointing to the endpoint of another NF service consumer to which the notification should be sent.
If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service consumer to which the notification should be sent. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application errors:
- UNSPECIFIED
- LOCATION_SESSION_UNKNOWN

See table 6.1.7.3-1 for the description of this error. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +**Table 6.1.5.1.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of NF service consumer to which the notification should be sent | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the notification is redirected | + +**Table 6.1.5.1.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of NF service consumer to which the notification should be sent | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the notification is redirected | + +### 6.1.6 Data Model + +#### 6.1.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.1.6.1-1 specifies the data types defined for the NImf\_Location service based interface protocol. + +Table 6.1.6.1-1: Nlmf\_Location specific Data Types + +| Data type | Clause defined | Description | +|----------------------------------------------|----------------|---------------------------------------------------------------------------------------| +| InputData | 6.1.6.2.2 | Information within Determine Location Request | +| LocationData | 6.1.6.2.3 | Information within Determine Location Response | +| GeographicalCoordinates | 6.1.6.2.4 | Geographical coordinates | +| GeographicArea | 6.1.6.2.5 | Geographic area specified by different shape | +| Point | 6.1.6.2.6 | Ellipsoid Point | +| PointUncertaintyCircle | 6.1.6.2.7 | Ellipsoid point with uncertainty circle | +| PointUncertaintyEllipse | 6.1.6.2.8 | Ellipsoid point with uncertainty ellipse | +| Polygon | 6.1.6.2.9 | Polygon | +| PointAltitude | 6.1.6.2.10 | Ellipsoid point with altitude | +| PointAltitudeUncertainty | 6.1.6.2.11 | Ellipsoid point with altitude and uncertainty ellipsoid | +| EllipsoidArc | 6.1.6.2.12 | Ellipsoid Arc | +| LocationQoS | 6.1.6.2.13 | QoS of Location request | +| CivicAddress | 6.1.6.2.14 | Indicates a Civic address | +| PositioningMethodAndUsage | 6.1.6.2.15 | Indicates the usage of a positioning method | +| GnssPositioningMethodAndUsage | 6.1.6.2.16 | Indicates the usage of a Global Navigation Satellite System (GNSS) positioning method | +| VelocityEstimate | 6.1.6.2.17 | Velocity estimate | +| HorizontalVelocity | 6.1.6.2.18 | Horizontal velocity | +| HorizontalWithVerticalVelocity | 6.1.6.2.19 | Horizontal and vertical velocity | +| HorizontalVelocityWithUncertainty | 6.1.6.2.20 | Horizontal velocity with speed uncertainty | +| HorizontalWithVerticalVelocityAndUncertainty | 6.1.6.2.21 | Horizontal and vertical velocity with speed uncertainty | +| UncertaintyEllipse | 6.1.6.2.22 | Ellipse with uncertainty | +| UeLcsCapability | 6.1.6.2.23 | Indicates the LCS capability supported by the UE. | +| PeriodicEventInfo | 6.1.6.2.24 | Indicates the information of periodic event reporting | +| AreaEventInfo | 6.1.6.2.25 | Indicates the information of area based event reporting | +| ReportingArea | 6.1.6.2.26 | Indicates an area for event reporting | +| MotionEventInfo | 6.1.6.2.27 | Indicates the information of motion based event reporting | +| CancelLocData | 6.1.6.2.29 | Information within Cancel Location Request | +| LocContextData | 6.1.6.2.30 | Information within Transfer Location Context Request | +| EventReportMessage | 6.1.6.2.31 | Indicates an event report message | +| EventReportingStatus | 6.1.6.2.32 | Indicates the status of event reporting | +| UELocationInfo | 6.1.6.2.33 | Indicates location information of a UE | +| EventNotifyData | 6.1.6.2.34 | Information within Event Notify Request | +| UeConnectivityState | 6.1.6.2.35 | Indicates the connectivity state of a UE | +| Altitude | 6.1.6.3.2 | Indicates value of altitude | +| Angle | 6.1.6.3.2 | Indicates value of angle | +| Uncertainty | 6.1.6.3.2 | Indicates value of uncertainty | +| Orientation | 6.1.6.3.2 | Indicates value of orientation angle | +| Confidence | 6.1.6.3.2 | Indicates value of confidence | +| Accuracy | 6.1.6.3.2 | Indicates value of accuracy | +| InnerRadius | 6.1.6.3.2 | Indicates value of the inner radius | +| CorrelationID | 6.1.6.3.2 | LCS Correlation ID | +| AgeOfLocationEstimate | 6.1.6.3.2 | Indicates value of the age of the location estimate | +| HorizontalSpeed | 6.1.6.3.2 | Indicates value of horizontal speed | +| VerticalSpeed | 6.1.6.3.2 | Indicates value of vertical speed | +| SpeedUncertainty | 6.1.6.3.2 | Indicates value of speed uncertainty | +| BarometricPressure | 6.1.6.3.2 | Specifies the measured uncompensated atmospheric pressure | +| LcsServiceType | 6.1.6.3.2 | LCS service type | +| LdrReference | 6.1.6.3.2 | LDR Reference | +| ReportingAmount | 6.1.6.3.2 | Number of required periodic event reports | +| ReportingInterval | 6.1.6.3.2 | Event reporting periodic interval | +| MinimumInterval | 6.1.6.3.2 | Minimum interval between event reports | +| MaximumInterval | 6.1.6.3.2 | Maximum interval between event reports | + +| | | | +|-----------------------------|------------|----------------------------------------------------------------------------------| +| SamplingInterval | 6.1.6.3.2 | Maximum time interval between consecutive evaluations by a UE of a trigger event | +| ReportingDuration | 6.1.6.3.2 | Maximum duration of event reporting | +| LinearDistance | 6.1.6.3.2 | Minimum straight line distance moved by a UE to trigger a motion event report | +| LMFIdentification | 6.1.6.3.2 | LMF identification | +| EventReportCounter | 6.1.6.3.2 | Number of event reports received from the target UE | +| EventReportDuration | 6.1.6.3.2 | Duration of event reporting | +| ExternalClientType | 6.1.6.3.3 | Indicates types of External Clients | +| SupportedGADShapes | 6.1.6.3.4 | Indicates supported GAD shapes | +| ResponseTime | 6.1.6.3.5 | Indicates acceptable delay of location request | +| PositioningMethod | 6.1.6.3.6 | Indicates supported positioning methods | +| PositioningMode | 6.1.6.3.7 | Indicates supported modes used for positioning method | +| GnssId | 6.1.6.3.8 | Global Navigation Satellite System (GNSS) ID | +| Usage | 6.1.6.3.9 | Indicates usage made of the location measurement | +| LcsPriority | 6.1.6.3.10 | Indicates priority of the LCS client | +| VelocityRequested | 6.1.6.3.11 | Indicates velocity requirement | +| AccuracyFulfilmentIndicator | 6.1.6.3.12 | Indicates fulfilment of requested accuracy | +| VerticalDirection | 6.1.6.3.13 | Indicates direction of vertical speed | +| LdrType | 6.1.6.3.14 | Indicates LDR types | +| ReportingAreaType | 6.1.6.3.15 | Indicates type of event reporting area | +| OccurrenceInfo | 6.1.6.3.16 | Specifies occurrence of event reporting | +| ReportingAccessType | 6.1.6.3.17 | Specifies access types of event reporting | +| EventClass | 6.1.6.3.18 | Specifies event classes | +| ReportedEventType | 6.1.6.3.19 | Specifies type of event reporting | +| TerminationCause | 6.1.6.3.20 | Specifies causes of event reporting termination | +| LcsQosClass | 6.1.6.3.21 | Specifies LCS QoS class | +| UeLocationServiceInd | 6.1.6.3.22 | Specifies location service types requested by UE | + +Table 6.1.6.1-2 specifies data types re-used by the Nlmf\_Location service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nlmf service based interface. + +**Table 6.1.6.1-2: Nlmf\_Location re-used Data Types** + +| Data type | Reference | Comments | +|-------------------|---------------------|----------------------------------------| +| Supi | 3GPP TS 29.571 [8] | Subscription Permanent Identifier | +| Pei | 3GPP TS 29.571 [8] | Permanent Equipment Identifier | +| Gpsi | 3GPP TS 29.571 [8] | Generic Public Subscription Identifier | +| Ecgi | 3GPP TS 29.571 [8] | E-UTRA Cell Identity | +| Ncgi | 3GPP TS 29.571 [8] | NR Cell Identity | +| NfInstanceId | 3GPP TS 29.571 [8] | Network Function Instance ID | +| Uri | 3GPP TS 29.571 [8] | Uniform Resource Identifier | +| RefToBinaryData | 3GPP TS 29.571 [8] | Reference to binary data | +| AccessType | 3GPP TS 29.571 [8] | Access type | +| CmState | 3GPP TS 29.518 [23] | Connection Management State | +| Guami | 3GPP TS 29.571 [8] | GUAMI | +| SupportedFeatures | 3GPP TS 29.571 [8] | Supported Features | +| RedirectResponse | 3GPP TS 29.571 [8] | Redirect Response | + +#### 6.1.6.2 Structured data types + +##### 6.1.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.1.6.2.2 Type: InputData + +Table 6.1.6.2.2-1: Definition of type InputData + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------|----------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| externalClientType | ExternalClientType | O | 0..1 | When present, this IE shall carry the external client type of the requester. | +| correlationID | CorrelationID | O | 0..1 | When present, this IE shall carry the correlation ID of the request. | +| amfId | NfInstanceId | O | 0..1 | Indicates the AMF Instance serving the UE. LMF shall use the AMF Instance to forward LCS related N1/N2 messages to the UE/RAN. | +| locationQoS | LocationQoS | O | 0..1 | When present, this IE shall carry the QoS of the location request. | +| supportedGADShapes | array(SupportedGADShapes) | O | 1..N | When present, this IE shall carry the GAD shapes supported by the requester. | +| supi | Supi | O | 0..1 | Indicates the SUPI of the target UE. | +| pei | Pei | O | 0..1 | Indicates the PEI of the target UE. | +| gpsi | Gpsi | O | 0..1 | Indicates the GPSI of the target UE. | +| ecgi | Ecgi | O | 0..1 | When present, this IE shall indicate the identifier of the E-UTRAN cell serving the UE or the serving cell identifier of the Primary Cell in the Master RAN Node that is an E-UTRAN node on Dual Connectivity scenarios.
(NOTE 2) | +| ecgiOnSecondNode | Ecgi | O | 0..1 | When present, the serving cell identifier of the Primary Cell in the Secondary RAN Node that is an E-UTRAN node when available on Dual Connectivity scenarios.
(NOTE 3) (NOTE 4) | +| ncgi | Ncgi | O | 0..1 | When present, this IE shall indicate the identifier of the NR cell serving the UE or the serving cell identifier of the Primary Cell in the Master RAN Node that is a NR node on Dual Connectivity scenarios.
(NOTE 2) | +| ncgiOnSecondNode | Ncgi | O | 0..1 | When present, the serving cell identifier of the Primary Cell in the Secondary RAN Node that is a NR node when available on Dual Connectivity scenarios.
(NOTE 3) (NOTE 4) | +| priority | LcsPriority | O | 0..1 | When present, this IE shall indicate the priority of the location request. | +| velocityRequested | VelocityRequested | O | 0..1 | When present, this IE shall indicate whether velocity is requested or not. | +| ueLcsCap | UeLcsCapability | O | 0..1 | When present, this IE shall indicate the LCS capability supported by the UE. | +| lcsServiceType | LcsServiceType | O | 0..1 | The LCS service type | +| ldrType | LdrType | O | 0..1 | The type of LDR | +| hgmlcCallbackURI | Uri | C | 0..1 | Callback URI of the H-GMLC

It shall be present, if attribute LdrType is present. | +| vgmlcAddress | Uri | C | 0..1 | V-GMLC address that corresponds to the V-GMLC that receives Location Request
It shall be present, if attribute LdrType is present and the target UE is in roaming case. | +| ldrReference | LdrReference | C | 0..1 | LDR Reference Number

It shall be present, if attribute LdrType is present. | +| periodicEventInfo | PeriodicEventInfo | C | 0..1 | Information for periodic event reporting | +| areaEventInfo | AreaEventInfo | C | 0..1 | Information for area event reporting | +| motionEventInfo | MotionEventInfo | C | 0..1 | Information for motion event reporting | +| reportingAccessTypes | array(ReportingAccessType) | O | 1..N | Allowed access types for event reporting | +| ueConnectivityStates | array(UeConnectivityS) | O | 1..N | When present, this IE shall indicate the UE | + +| | | | | | +|----------------------|----------------------|---|------|------------------------------------------------------------------------------------------------------------------------| +| | tate) | | | connectivity state per access type | +| ueLocationServiceInd | UeLocationServiceInd | C | 0..1 | If UE sends an MO-LR Request message, this IE shall be present and indicate the request type for a 5GC-MO-LR. | +| lppMessage | RefToBinaryData | C | 0..1 | If UE includes the LPP message in MO-LR Request, this IE shall be present and Indicate the binary data of LPP message. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.9 is supported. | + +NOTE 1: At least one of the attributes defined in this table shall be present in the InputData structure. +NOTE 2: Attribute "ecgi" and "ncgi" shall not be present at the same time. +NOTE 3: Attribute "ecgiOnSecondNode" and "ncgiOnSecondNode" shall not be present at the same time. +NOTE 4: Attribute "ecgiOnSecondNode" or "ncgiOnSecondNode" shall not be present if neither attribute "ecgi" nor "ncgi" is present. + +##### 6.1.6.2.3 + +Type: LocationData + +Table 6.1.6.2.3-1: Definition of type LocationData + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------------|--------------------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------| +| locationEstimate | GeographicArea | M | 1 | For a request for triggered location where location estimates are not required, the location estimate can be based on current serving cell. | +| accuracyFulfilmentIndicator | AccuracyFulfilmentIndicator | O | 0..1 | When present, this IE shall indicate fulfilment of required accuracy. | +| ageOfLocationEstimate | AgeOfLocationEstimate | O | 0..1 | When present, this IE shall indicate age of the location estimate. | +| velocityEstimate | VelocityEstimate | O | 0..1 | When present, this IE shall indicate velocity estimate. | +| civicAddress | CivicAddress | O | 0..1 | When present, this IE shall indicate a civic address. | +| positioningDataList | array(PositioningMethodAndUsage) | O | 1..N | When present, this IE shall include a list of data related to positioning methods. | +| gnssPositioningDataList | array(GNSSPositioningMethodAndUsage) | O | 1..N | When present, this IE shall include a list of data related to GNSS positioning methods. | +| ecgi | Ecgi | O | 0..1 | When present, this IE shall indicate the ID of the E-UTRAN cell serving the UE. | +| ncgi | Ncgi | O | 0..1 | When present, this IE shall indicate the ID of the NR cell serving the UE. | +| altitude | Altitude | O | 0..1 | Altitude of the positioning estimate. When the shape used in "locationEstimate" supports conveying the altitude parameter, this IE shall be absent. | +| barometricPressure | BarometricPressure | O | 0..1 | If present, this IE contains the barometric pressure measurement as reported by the target UE. | +| servingLMFIdentification | LMFIdentification | O | 0..1 | When present, this IE shall indicate the identity of the serving LMF | + +##### 6.1.6.2.4 Type: GeographicalCoordinates + +Table 6.1.6.2.4-1: Definition of type GeographicalCoordinates + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|----------------------------------------------------------------------------------------------| +| lon | number | M | 1 | Longitude (Double-precision float value):
Format: double
Minimum: -180
Maximum: 180 | +| lat | number | M | 1 | Latitude (Double-precision float value):
Format: double
Minimum: -90
Maximum: 90 | + +##### 6.1.6.2.5 Type: GeographicArea + +Table 6.1.6.2.5-1: Definition of type GeographicArea as a list of mutually exclusive alternatives + +| Data type | Cardinality | Discriminator property name | Discriminator mapping | Description | +|--------------------------|-------------|-----------------------------|----------------------------|----------------------------------------------------------------------------------------------| +| Point | 1 | shape | POINT | Geographical area consisting of a single point, represented by its longitude and latitude. | +| PointUncertaintyCircle | 1 | shape | POINT_UNCERTAINTY_CIRCLE | Geographical area consisting of a point and an uncertainty value. | +| PointUncertaintyEllipse | 1 | shape | POINT_UNCERTAINTY_ELLIPSE | Geographical area consisting of a point, plus an uncertainty ellipse and a confidence value. | +| Polygon | 1 | shape | POLYGON | Geographical area consisting of a list of points (between 3 to 15 points). | +| PointAltitude | 1 | shape | POINT_ALTITUDE | Geographical area consisting of a point and an altitude value. | +| PointAltitudeUncertainty | 1 | shape | POINT_ALTITUDE_UNCERTAINTY | Geographical area consisting of a point, an altitude value and an uncertainty value. | +| EllipsoidArc | 1 | shape | ELLIPSOID_ARC | Geographical are consisting of an ellipsoid arc. | + +NOTE: The "anyOf" keyword (instead of "oneOf" keyword which is normally used for mutually exclusive alternatives) is used for GeographicArea type in yaml file to avoid validation failure of OpenAPI. According to current definition, a PointUncertaintyCircle object will always pass the validation with both PointUncertaintyCircle and Point, which fails the qualification of "oneOf" keyword. + +##### 6.1.6.2.6 Type: Point + +Table 6.1.6.2.6-1: Definition of type Point + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------------------|---|-------------|-------------------------------------------------------------------------| +| shape | SupportedGADShapes | M | 1 | It shall take the value "POINT". | +| point | GeographicalCoordinates | M | 1 | Indicates a geographic point represented by its longitude and latitude. | + +##### 6.1.6.2.7 Type: PointUncertaintyCircle + +**Table 6.1.6.2.7-1: Definition of type PointUncertaintyCircle** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------------------|---|-------------|-------------------------------------------------------------------------| +| shape | SupportedGADShapes | M | 1 | It shall take the value "POINT_UNCERTAINTY_CIRCLE". | +| point | GeographicalCoordinates | M | 1 | Indicates a geographic point represented by its longitude and latitude. | +| uncertainty | Uncertainty | M | 1 | Indicates the uncertainty value. | + +##### 6.1.6.2.8 Type: PointUncertaintyEllipse + +**Table 6.1.6.2.8-1: Definition of type PointUncertaintyEllipse** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|-------------------------|---|-------------|-------------------------------------------------------------------------| +| shape | SupportedGADShapes | M | 1 | It shall take the value "POINT_UNCERTAINTY_ELLIPSE". | +| point | GeographicalCoordinates | M | 1 | Indicates a geographic point represented by its longitude and latitude. | +| uncertaintyEllipse | UncertaintyEllipse | M | 1 | Indicates an uncertainty ellipse. | +| confidence | Confidence | M | 1 | Indicates the value of confidence. | + +##### 6.1.6.2.9 Type: Polygon + +**Table 6.1.6.2.9-1: Definition of type Polygon** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|--------------------------------|---|-------------|----------------------------------------------------------| +| shape | SupportedGADShapes | M | 1 | It shall take the value "POLYGON". | +| pointList | array(GeographicalCoordinates) | M | 3..15 | Array with up to 15 items, where each item is a "point". | + +##### 6.1.6.2.10 Type: PointAltitude + +**Table 6.1.6.2.10-1: Definition of type PointAltitude** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------------------|---|-------------|-------------------------------------------------------------------------| +| shape | SupportedGADShapes | M | 1 | It shall take the value "POINT_ALTITUDE". | +| point | GeographicalCoordinates | M | 1 | Indicates a geographic point represented by its longitude and latitude. | +| altitude | Altitude | M | 1 | Indicates the value of altitude. | + +##### 6.1.6.2.11 Type: PointAltitudeUncertainty + +Table 6.1.6.2.11-1: Definition of type PointAltitudeUncertainty + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|-------------------------|---|-------------|-------------------------------------------------------------------------| +| shape | SupportedGADShapes | M | 1 | It shall take the value "POINT_ALTITUDE_UNCERTAINTY". | +| point | GeographicalCoordinates | M | 1 | Indicates a geographic point represented by its longitude and latitude. | +| altitude | Altitude | M | 1 | Indicates the value of altitude. | +| uncertaintyEllipse | UncertaintyEllipse | M | 1 | Indicates the uncertainty ellipse | +| uncertaintyAltitude | Uncertainty | M | 1 | Indicates the uncertainty of the altitude. | +| confidence | Confidence | M | 1 | Indicates the value of confidence. | + +##### 6.1.6.2.12 Type: EllipsoidArc + +Table 6.1.6.2.12-1: Definition of type EllipsoidArc + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-------------------------|---|-------------|-------------------------------------------------------------------------| +| shape | SupportedGADShapes | M | 1 | It shall take the value "ELLIPSOID_ARC". | +| point | GeographicalCoordinates | M | 1 | Indicates a geographic point represented by its longitude and latitude. | +| innerRadius | InnerRadius | M | 1 | Indicates the value of inner radius of the Ellipsoid Arc. | +| uncertaintyRadius | Uncertainty | M | 1 | Indicates the uncertainty radius of the Ellipsoid Arc. | +| offsetAngle | Angle | M | 1 | Indicates the offset angle of the Ellipsoid Arc. | +| includedAngle | Angle | M | 1 | Indicates the included angle of the Ellipsoid Arc. | +| confidence | Confidence | M | 1 | Indicates the value of confidence. | + +##### 6.1.6.2.13 Type: LocationQoS + +Table 6.1.6.2.13-1: Definition of type LocationQoS + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|--------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------| +| hAccuracy | Accuracy | O | 0..1 | Horizontal accuracy | +| vAccuracy | Accuracy | O | 0..1 | Vertical accuracy | +| vertRequested | boolean | O | 0..1 | Vertical accuracy requested (yes/no) | +| responseTime | ResponseTime | O | 0..1 | No delay, Low delay or Delay tolerant | +| lcsQoSClass | LcsQoSClass | C | 0..1 | LCS QoS Class, see clause 4.1b of 3GPP TS 23.273 [19].
This IE shall be absent if neither hAccuracy nor vAccuracy is included. | + +##### 6.1.6.2.14 Type: CivicAddress + +Table 6.1.6.2.14-1: Definition of type CivicAddress + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------| +| country | string | M | 1 | The two-letter ISO 3166 country code in capital ASCII letters, e.g., DE or US
IETF RFC 4776 [6] | +| A1 | string | O | 0..1 | National subdivisions (state, canton, region, province, prefecture)
IETF RFC 4776 [6] | +| A2 | string | O | 0..1 | County, parish, gun (JP), district (IN)
IETF RFC 4776 [6] | +| A3 | string | O | 0..1 | City, township, shi (JP)
IETF RFC 4776 [6] | +| A4 | string | O | 0..1 | City division, borough, city district, ward, chou (JP)
IETF RFC 4776 [6] | +| A5 | string | O | 0..1 | Neighbourhood, block
IETF RFC 4776 [6] | +| A6 | string | O | 0..1 | Group of streets below the neighbourhood level
IETF RFC 4776 [6] | +| PRD | string | O | 0..1 | Leading street direction
IETF RFC 4776 [6] | +| POD | string | O | 0..1 | Trailing street suffix
IETF RFC 4776 [6] | +| STS | string | O | 0..1 | Street suffix or type
IETF RFC 4776 [6] | +| HNO | string | O | 0..1 | House number
IETF RFC 4776 [6] | +| HNS | string | O | 0..1 | House number suffix
IETF RFC 4776 [6] | +| LMK | string | O | 0..1 | Landmark or vanity address
IETF RFC 4776 [6] | +| LOC | string | O | 0..1 | Additional location information
IETF RFC 4776 [6] | +| NAM | string | O | 0..1 | Name (residence and office occupant)
IETF RFC 4776 [6] | +| PC | string | O | 0..1 | Postal/zip code
IETF RFC 4776 [6] | +| BLD | string | O | 0..1 | Building (structure)
IETF RFC 5139 [7] | +| UNIT | string | O | 0..1 | Unit (apartment, suite)
IETF RFC 5139 [7] | +| FLR | string | O | 0..1 | Floor
IETF RFC 4776 [6] | +| ROOM | string | O | 0..1 | Room
IETF RFC 5139 [7] | +| PLC | string | O | 0..1 | Place-type
IETF RFC 5139 [7] | +| PCN | string | O | 0..1 | Postal community name
IETF RFC 5139 [7] | +| POBOX | string | O | 0..1 | Post office box (P.O. box)
IETF RFC 5139 [7] | +| ADDCODE | string | O | 0..1 | Additional code
IETF RFC 5139 [7] | +| SEAT | string | O | 0..1 | Seat (desk, cubicle, workstation)
IETF RFC 5139 [7] | +| RD | string | O | 0..1 | Primary road or street
IETF RFC 5139 [7] | +| RDSEC | string | O | 0..1 | Road clause
IETF RFC 5139 [7] | +| RDBR | string | O | 0..1 | Road branch
IETF RFC 5139 [7] | +| RDSUBBR | string | O | 0..1 | Road sub-branch
IETF RFC 5139 [7] | +| PRM | string | O | 0..1 | Road pre-modifier
IETF RFC 5139 [7] | + +| | | | | | +|------------|--------|---|------|----------------------------------------------------------------------------------------------------------------------------------------------| +| POM | string | O | 0..1 | Road post-modifier
IETF RFC 5139 [7] | +| usageRules | string | O | 0..1 | When present, this IE shall carry the value of "usage-rules" Element of the PIDL-LO XML document, with UTF-8 encoding.
IETF RFC 4119 [25] | +| method | string | O | 0..1 | When present, this IE shall contain the method token, carried by the "method" Element of the PIDL-LO XML document.
IETF RFC 4119 [25] | +| providedBy | string | O | 0..1 | When present, this IE shall carry the value of "provided-by" Element of the PIDL-LO XML document, with UTF-8 encoding.
IETF RFC 4119 [25] | + +EXAMPLE: The above structure follows the same label naming as in the XML schema shown in IETF RFC 5139 [7]. The same example shown in XML in that RFC, in clause 5, would be equivalent to the following JSON document: + +``` +{ + "country": "AU", + "A1": "NSW", + "A3": "Wollongong", + "A4": "North Wollongong", + "RD": "Flinders", + "STS": "Street", + "RDBR": "Campbell Street", + "LMK": "Gilligan's Island", + "LOC": "Corner", + "NAM": "Video Rental Store", + "PC": "2500", + "ROOM": "Westerns and Classics", + "PLC": "store", + "POBOX": "Private Box 15" +} +``` + +##### 6.1.6.2.15 Type: PositioningMethodAndUsage + +**Table 6.1.6.2.15-1: Definition of type PositioningMethodAndUsage** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| method | PositioningMethod | M | 1 | Indicates the related positioning method | +| mode | PositioningMode | M | 1 | Indicates the mode of the location measurement from the related positioning method. | +| usage | Usage | M | 1 | Indicates the usage of the location measurement from the related positioning method. | +| methodCode | integer | C | 0..1 | This IE shall be present when the method IE is with value "NETWORK_SPECIFIC".

When present, this IE shall carry the code value of the network specific positioning method in decimal which encodes the binary value "10000 to 11111" (bits 8-4 of " Positioning Method and Usage " IE within " Positioning Data " parameter, as specified in clause 7.4.13 of 3GPP TS 29.171 [24].)

Minimum: 16
Maximum: 31 | + +6.1.6.2.16 Type: GnssPositioningMethodAndUsage + +**Table 6.1.6.2.16-1: Definition of type GnssPositioningMethodAndUsage** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------|---|-------------|---------------------------------------------------------------------------------------| +| mode | PositioningMode | M | 1 | Indicates the mode of location measurement from the related GNSS positioning method. | +| gnss | GnssId | M | 1 | Indicates the related GNSS positioning method | +| usage | Usage | M | 1 | Indicates the usage of the location measurement from related GNSS positioning method. | + +6.1.6.2.17 Type: VelocityEstimate + +**Table 6.1.6.2.17-1: Definition of type VelocityEstimate as a list of mutually exclusive alternatives** + +| Data type | Cardinality | Description | +|----------------------------------------------|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| HorizontalVelocity | 1 | Velocity estimate including horizontal speed and bearing. | +| HorizontalWithVerticalVelocity | 1 | Velocity estimate including horizontal speed and bearing, and also vertical speed and vertical direction. | +| HorizontalVelocityWithUncertainty | 1 | Velocity estimate including horizontal speed and bearing; it also includes an uncertainty value. | +| HorizontalWithVerticalVelocityAndUncertainty | 1 | Velocity estimate including horizontal speed and bearing, and also vertical speed and vertical direction; it also includes uncertainty value for horizontal and vertical speeds. | + +6.1.6.2.18 Type: HorizontalVelocity + +**Table 6.1.6.2.18-1: Definition of type HorizontalVelocity** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------|---|-------------|----------------------------------------------------------| +| hSpeed | HorizontalSpeed | M | 1 | Horizontal speed in kilometres per hour. | +| bearing | Angle | M | 1 | Bearing angle in degrees, measured clockwise from North. | + +6.1.6.2.19 Type: HorizontalWithVerticalVelocity + +**Table 6.1.6.2.19-1: Definition of type HorizontalWithVerticalVelocity** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------------|---|-------------|----------------------------------------------------------| +| hSpeed | HorizontalSpeed | M | 1 | Horizontal speed in kilometres per hour. | +| bearing | Angle | M | 1 | Bearing angle in degrees, measured clockwise from North. | +| vSpeed | VerticalSpeed | M | 1 | Vertical speed in kilometres per hour. | +| vDirection | VerticalDirection | M | 1 | Vertical Direction: upward or downward. | + +6.1.6.2.20 Type: HorizontalVelocityWithUncertainty + +**Table 6.1.6.2.20-1: Definition of type HorizontalVelocityWithUncertainty** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|------------------|---|-------------|----------------------------------------------------------| +| hSpeed | HorizontalSpeed | M | 1 | Speed in kilometres per hour. | +| bearing | Angle | M | 1 | Bearing angle in degrees, measured clockwise from North. | +| uncertainty | SpeedUncertainty | M | 1 | Uncertainty of horizontal speed in kilometres per hour. | + +6.1.6.2.21 Type: HorizontalWithVerticalVelocityAndUncertainty + +**Table 6.1.6.2.21-1: Definition of type HorizontalWithVerticalVelocityAndUncertainty** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------------|---|-------------|----------------------------------------------------------| +| hspeed | HorizontalSpeed | M | 1 | Speed in kilometres per hour. | +| bearing | Angle | M | 1 | Bearing angle in degrees, measured clockwise from North. | +| vSpeed | VerticalSpeed | M | 1 | Vertical Speed in kilometres per hour. | +| vDirection | VerticalDirection | M | 1 | Vertical Direction: upwards or downwards. | +| hUncertainty | SpeedUncertainty | M | 1 | Uncertainty of horizontal speed in kilometres per hour. | +| vUncertainty | SpeedUncertainty | M | 1 | Uncertainty of vertical speed in kilometres per hour. | + +6.1.6.2.22 Type: UncertaintyEllipse + +**Table 6.1.6.2.22-1: Definition of type UncertaintyEllipse** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|-------------|---|-------------|-----------------------------------------------------------| +| semiMajor | Uncertainty | M | 1 | Indicates the semi-major axis of the uncertainty ellipse. | +| semiMinor | Uncertainty | M | 1 | Indicates the semi-minor axis of the uncertainty ellipse. | +| orientationMajor | Orientation | M | 1 | Indicates the orientation angle of the major axis. | + +6.1.6.2.23 Type: UeLcsCapability + +**Table 6.1.6.2.23-1: Definition of type UeLcsCapability** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| lppSupport | boolean | O | 0..1 | Indicates whether the UE supports LPP or not.

- true (default): LPP supported by the UE
- false: LPP not supported by the UE | +| ciotOptimisation | boolean | O | 0..1 | Indicates whether the UE supports and is allowed to use Control Plane CLoT 5GS Optimisation to send an event report for periodic or triggered location or not. Refer to 3GPP TS 23.273 [19] clause 6.7 for more detail.

- true: Control Plane CLoT 5GS Optimisation is supported by the UE and allowed
- false (default): Control Plane CLoT 5GS Optimisation not supported by the UE or not allowed | + +##### 6.1.6.2.24 Type: PeriodicEventInfo + +Table 6.1.6.2.24-1: Definition of type PeriodicEventInfo + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-------------------|---|-------------|---------------------------| +| reportingAmount | ReportingAmount | M | 1 | Number of event reports | +| reportingInterval | ReportingInterval | M | 1 | Interval of event reports | + +NOTE: reportingAmount x reportingInterval shall not exceed 8639999 (99 days, 23 hours, 59 minutes and 59 seconds) for compatibility with OMA MLP and RLP. + +##### 6.1.6.2.25 Type: AreaEventInfo + +Table 6.1.6.2.25-1: Definition of type AreaEventInfo + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------|----------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------| +| areaDefinition | array(ReportingArea) | M | 1..250 | One or more reporting areas | +| occurrenceInfo | OccurrenceInfo | O | 0..1 | One time only report indication | +| minimumInterval | MinimumInterval | C | 0..1 | Minimum interval between event reports.
This IE shall not be included if occurrenceInfo is present and set to one time event. | +| maximumInterval | MaximumInterval | C | 0..1 | Maximum interval between event reports.
This IE shall not be included if occurrenceInfo is present and set to one time event. | +| samplingInterval | SamplingInterval | O | 0..1 | Maximum time interval between consecutive evaluations by a UE of a trigger event. | +| reportingDuration | ReportingDuration | O | 0..1 | Maximum duration of event reporting. | +| reportingLocationReq | boolean | C | 0..1 | This IE shall be present and set to true if a location estimate is required for each event report. | + +##### 6.1.6.2.26 Type: ReportingArea + +Table 6.1.6.2.26-1: Definition of type ReportingArea + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------------|---|-------------|---------------------------------------------------------------------------------------------------| +| areaType | ReportingAreaType | M | 1 | Type of reporting area. | +| tai | Tai | C | 1 | TAI for EPS or 5GS.
This IE shall be present if the reporting area type is EPS TAI or 5GS TAI. | +| ecgi | Ecgi | C | 1 | ECGI.
This IE shall be present if the reporting area type is ECGI. | +| ncgi | Ncgi | C | 1 | NCGI.
This IE shall be present if the reporting area type is NCGI. | + +NOTE: One of tai, ecgi or ncgi shall be included. + +6.1.6.2.27 Type: MotionEventInfo + +**Table 6.1.6.2.27-1: Definition of type MotionEventInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------|-------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------| +| linearDistance | LinearDistance | M | 1 | Minimum linear (straight line) distance for motion event reports. | +| occurrenceInfo | OccurrenceInfo | O | 0..1 | One time only report indication | +| minimumInterval | MinimumInterval | C | 0..1 | Minimum interval between event reports.
This IE shall not be included if occurrenceInfo is present and set to one time event. | +| maximumInterval | MaximumInterval | C | 0..1 | Maximum interval between event reports.
This IE shall not be included if occurrenceInfo is present and set to one time event. | +| samplingInterval | SamplingInterval | O | 0..1 | Maximum time interval between consecutive evaluations by a UE of a trigger event. | +| reportingDuration | ReportingDuration | O | 0..1 | Maximum duration of event reporting. | +| reportingLocationReq | boolean | C | 0..1 | This IE shall be present and set to true if a location estimate is required for each event report. | + +6.1.6.2.28 Void + +6.1.6.2.29 Type: CancelLocData + +**Table 6.1.6.2.29-1: Definition of type CancelLocData** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------| +| hgmlcCallbackURI | Uri | M | 1 | Callback URI of the H-GMLC | +| ldrReference | LdrReference | M | 1 | LDR Reference | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.9 is supported. | + +##### 6.1.6.2.30 Type: LocContextData + +Table 6.1.6.2.30-1: Definition of type LocContextData + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------|---------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| amfId | NfInstanceId | M | 1 | Indicates the AMF Instance serving the UE. LMF shall use the AMF Instance to forward LCS related N1/N2 messages to the UE/RAN. | +| locationQoS | LocationQoS | C | 0..1 | This IE shall contain the location QoS if available. | +| supportedGADShapes | array(SupportedGADShapes) | C | 0..N | This IE shall contain the supported GAD shapes if available. | +| supi | Supi | C | 0..1 | This IE shall contain the SUPI if available. | +| gpsi | Gpsi | C | 0..1 | This IE shall contain the GPSI if available. | +| ldrType | LdrType | M | 1 | The type of LDR | +| hgmlcCallbackURI | Uri | M | 1 | Callback URI of the H-GMLC | +| ldrReference | LdrReference | M | 1 | LDR Reference | +| periodicEventInfo | PeriodicEventInfo | C | 0..1 | Information for periodic event reporting | +| areaEventInfo | AreaEventInfo | C | 0..1 | Information for area event reporting | +| motionEventInfo | MotionEventInfo | C | 0..1 | Information for motion event reporting | +| eventReportMessage | EventReportMessage | M | 1 | Contains an embedded event report | +| eventReportingStatus | EventReportingStatus | O | 0..1 | Status of event reporting | +| ueLocationInfo | UELocationInfo | O | 0..1 | Location information for the target UE | +| cloT5GSOptimisation | boolean | C | 0..1 | This IE shall be present if it was received from AMF. When present, it shall be set as follows:
- true: Control Plane CLoT 5GS Optimisation was used and no signalling or data is currently pending for the UE at the AMF.
- false (default): Control Plane CLoT 5GS Optimisation was not used or signalling or data is currently pending for the UE at the AMF. | +| ecgi | Ecgi | C | 0..1 | When present, this IE shall indicate the identifier of the E-UTRAN cell serving the UE. This IE shall be present if it was received from AMF. | +| ncgi | Ncgi | C | 0..1 | When present, this IE shall indicate the identifier of the NR cell serving the UE. This IE shall be present if it was received from AMF | +| guami | Guami | C | 0..1 | This IE shall be present if it was received from AMF.

When present, it shall contain the GUAMI serving the UE. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.9 is supported. | + +NOTE: At least one of periodicEventInfo, areaEventInfo or motionEventInfo shall be present in the LocContextData structure. + +##### 6.1.6.2.31 Type: EventReportMessage + +Table 6.1.6.2.31-1: Definition of type EventReportMessage + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------|---|-------------|------------------------------------------------------------------------------------------| +| eventClass | EventClass | M | 1 | This IE shall contain the event class for the message content specified in eventContent. | +| eventContent | RefToBinaryData | M | 1 | This IE shall reference the event report binary data corresponding to the eventClass. | + +6.1.6.2.32 Type: EventReportingStatus + +**Table 6.1.6.2.32-1: Definition of type EventReportingStatus** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|---------------------|---|-------------|--------------------------------------------------------| +| eventReportCounter | EventReportCounter | O | 0..1 | This IE shall contain a count of event reports. | +| eventReportDuration | EventReportDuration | O | 0..1 | This IE shall contain the duration of event reporting. | + +6.1.6.2.33 Type: UELocationInfo + +**Table 6.1.6.2.33-1: Definition of type UELocationInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|-----------------------|---|-------------|-----------------------------------------------| +| locationEstimate | GeographicArea | O | 0..1 | Previous location estimate for the target UE. | +| ageOfLocationEstimate | AgeOfLocationEstimate | O | 0..1 | Age of previous location estimate. | +| velocityEstimate | VelocityEstimate | O | 0..1 | Previous velocity estimate for the target UE. | +| ageOfVelocityEstimate | AgeOfVelocityEstimate | O | 0..1 | Age of previous velocity estimate. | + +##### 6.1.6.2.34 Type: EventNotifyData + +Table 6.1.6.2.34-1: Definition of type EventNotifyData + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------|--------------------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| reportedEventType | ReportedEventType | M | 1 | This IE shall contain the type of event being reported. | +| supi | Supi | C | 0..1 | This IE shall contain the SUPI if available. | +| gpsi | Gpsi | C | 0..1 | This IE shall contain the GPSI if available. | +| hgmlcCallBackURI | Uri | C | 0..1 | Callback URI of the H-GMLC (NOTE 1) | +| ldrReference | LdrReference | M | 1 | LDR Reference | +| locationEstimate | GeographicArea | O | 0..1 | If present, this IE shall contain an estimate of the location of the UE in universal coordinates and the accuracy of the estimate. | +| ageOfLocationEstimate | AgeOfLocationEstimate | O | 0..1 | If present, this IE shall contain an indication of how long ago the location estimate was obtained. | +| civicAddress | CivicAddress | O | 0..1 | If present, this IE shall contain a civic address. | +| positioningDataList | array(PositioningMethodAndUsage) | O | 1..N | If present, this IE shall indicate the usage of each non-GNSS positioning method that was attempted to determine the location estimate, either successfully or unsuccessfully. | +| gnssPositioningDataList | array(GNSSPositioningMethodAndUsage) | O | 1..N | If present, this IE shall indicate the usage of each GNSS positioning method that was attempted to determine the location estimate, either successfully or unsuccessfully. | +| servingLMFIdentification | LMFIdentification | C | 0..1 | This IE shall be included to identify an LMF which acts as a serving LMF if a serving LMF is used. | +| terminationCause | TerminationCause | C | 0..1 | This IE shall be included if event reporting has been terminated | +| velocityEstimate | VelocityEstimate | O | 0..1 | If present, this IE shall contain an estimate of the velocity of the target UE, composed by horizontal speed, vertical speed, and their respective uncertainty. | +| altitude | Altitude | O | 0..1 | If present, this IE indicates the altitude of the positioning estimate. When the shape used in "locationEstimate" supports conveying the altitude parameter, this IE shall be absent. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.9 is supported. | + +NOTE 1: The hgmlcCallBackURI shall be included when the consumer NF is not the H-GMLC. + +##### 6.1.6.2.35 Type: UeConnectivityState + +Table 6.1.6.2.35-1: Definition of type UeConnectivityState + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|------------|---|-------------|-----------------------------------------------------------------------------------------| +| accessType | AccessType | M | 1 | Shall indicate the access type of the UE. | +| connectivitystate | CmState | O | 0..1 | When present, it shall indicate the UE connectivity state in the indicated access type. | + +#### 6.1.6.3 Simple data types and enumerations + +##### 6.1.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 6.1.6.3.2 Simple data types + +The simple data types defined in table 6.1.6.3.2-1 shall be supported. + +Table 6.1.6.3.2-1: Simple data types + +| Type Name | Type Definition | Description | +|-----------------------|-----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Altitude | number | Double-precision float value of the altitude, expressed in meters.
Minimum: -32767. Maximum: 32767.
Format: double. | +| Angle | integer | Integer value of the angle, expressed in degrees.
Minimum: 0. Maximum: 360. | +| Uncertainty | number | Float value of uncertainty, expressed in meters.
Minimum: 0
Format: float. | +| Orientation | integer | Integer value of the orientation angle, expressed in degrees.
Minimum: 0. Maximum: 180. | +| Confidence | integer | Integer value of the confidence, expressed in percentage value.
Minimum: 0. Maximum: 100. | +| Accuracy | number | Float value of accuracy, expressed in meters.
Minimum: 0
Format: float. | +| InnerRadius | integer | Integer value of the inner radius, expressed in meters.
Minimum: 0. Maximum: 327675.
Format: int32. | +| CorrelationID | string | LCS Correlation ID. The correlation ID shall be of a minimum length of 1 character and maximum length of 255 characters. | +| AgeOfLocationEstimate | integer | Integer value of the age of the location estimate, expressed in minutes.
Minimum: 0. Maximum: 32767. | +| HorizontalSpeed | number | Float value of horizontal speed, expressed in kilometres per hour.
Minimum: 0. Maximum: 2047.
Format: float. | +| VerticalSpeed | number | Float value of horizontal speed, expressed in kilometres per hour.
Minimum: 0. Maximum: 255.
Format: float. | +| SpeedUncertainty | number | Float value of speed uncertainty, expressed in kilometres per hour.
Minimum: 0. Maximum: 255.
Format: float. | +| BarometricPressure | integer | This IE specifies the measured uncompensated atmospheric pressure in units of Pascal (Pa).
Minimum: 30000. Maximum: 115000. | +| LcsServiceType | integer | The LCS service type as defined in 3GPP TS 22.071 [17] and clause 17.7.8 of 3GPP TS 29.002 [18].
Minimum: 0. Maximum: 127. | +| LdrReference | string | LDR Reference encoded as a string of hexadecimal characters.
The LdrReference shall be of a minimum length of 2 characters and maximum length of 510 characters. | +| ReportingAmount | integer | Number of required periodic event reports.
Minimum: 1. Maximum: 8639999. | +| ReportingInterval | integer | Event reporting periodic interval in seconds.
Minimum: 1. Maximum: 8639999.
ReportingInterval x ReportingAmount shall not exceed 8639999. | +| MinimumInterval | integer | Minimum interval between event reports in seconds.
Minimum: 1. Maximum: 32767. | +| MaximumInterval | integer | Maximum interval between event reports in seconds.
Minimum: 1. Maximum: 86400. | +| SamplingInterval | integer | Maximum time interval between consecutive evaluations by a UE of a trigger event, in seconds.
Minimum: 1. Maximum: 3600 | +| ReportingDuration | integer | Maximum duration of event reporting, in seconds.
Minimum: 1. Maximum: 8640000. | +| LinearDistance | integer | The minimum straight line distance moved by a UE to trigger a motion event report, in meters.
Minimum: 1. Maximum: 10000. | +| LMFIdentification | string | The serving LMF identification as defined in 3GPP TS 23.273 [19], encoded as a string of hexadecimal characters. | + +| | | | +|---------------------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| EventReportCounter | integer | Number of event reports received from the target UE.
Minimum: 1. Maximum: 8640000.
Note: the current event report is included in the count. | +| EventReportDuration | integer | Duration of event reporting, in seconds.
Minimum: 0. Maximum: 8640000.
Note: the duration starts when event reporting is activated in the UE and extends to the current time. | + +##### 6.1.6.3.3 Enumeration: ExternalClientType + +The enumeration ExternalClientType represents the different types of clients of the location service. + +**Table 6.1.6.3.3-1: Enumeration ExternalClientType** + +| Enumeration value | Description | +|-------------------------------------------|-------------------------------------------------------------| +| "EMERGENCY_SERVICES" | External client for emergency services | +| "VALUE_ADDED_SERVICES" | External client for value added services | +| "PLMN_OPERATOR_SERVICES" | External client for PLMN operator services | +| "LAWFUL_INTERCEPT_SERVICES" | External client for Lawful Intercept services | +| "PLMN_OPERATOR_BROADCAST_SERVICES" | External client for PLMN Operator Broadcast services | +| "PLMN_OPERATOR_OM" | External client for PLMN Operator O&M | +| "PLMN_OPERATOR_ANONYMOUS_STATISTICS" | External client for PLMN Operator anonymous statistics | +| "PLMN_OPERATOR_TARGET_MS_SERVICE_SUPPORT" | External client for PLMN Operator target MS service support | + +##### 6.1.6.3.4 Enumeration: SupportedGADShapes + +The enumeration SupportedGADShapes represents the different types, or shapes, of geographic areas supported by the system. + +**Table 6.1.6.3.4-1: Enumeration SupportedGADShapes** + +| Enumeration value | Description | +|------------------------------|---------------------------------------------------------| +| "POINT" | Ellipsoid Point | +| "POINT UNCERTAINTY CIRCLE" | Ellipsoid point with uncertainty circle | +| "POINT UNCERTAINTY ELLIPSE" | Ellipsoid point with uncertainty ellipse | +| "POLYGON" | Polygon | +| "POINT_ALTITUDE" | Ellipsoid point with altitude | +| "POINT_ALTITUDE UNCERTAINTY" | Ellipsoid point with altitude and uncertainty ellipsoid | +| "ELLIPSOID ARC" | Ellipsoid Arc | + +##### 6.1.6.3.5 Enumeration: ResponseTime + +The enumeration ResponseTime represents the acceptable delay in the determination of the location of the UE. + +**Table 6.1.6.3.5-1: Enumeration ResponseTime** + +| Enumeration value | Description | +|-------------------|----------------------------------------------------| +| "LOW_DELAY" | Location request is expected with low delay level. | +| "DELAY_TOLERANT" | Location request is delay tolerant. | +| "NO_DELAY " | Location request is expected with no delay (NOTE) | + +NOTE: The value is only used in the interface between GMLC and AF/LCS client via NEF, not further delivered to other NFs in the network. After receiving the enumeration value, the GMLC shall immediately return any location estimate or civic location that it currently has. The GMLC shall return either the Initial or Last Known Location of the Target UE. If no location estimate or Dispatchable Location is available, the GMLC shall return the failure indication and may optionally initiate procedures to obtain a location estimate or Dispatchable Location (e.g. to be available for a later request). + +##### 6.1.6.3.6 Enumeration: PositioningMethod + +The enumeration PositioningMethod represents the method used to determine the location of the UE. + +**Table 6.1.6.3.6-1: Enumeration PositioningMethod** + +| Enumeration value | Description | +|-----------------------|-----------------------------------------------------------------------------------------------------------------------------------| +| "CELLID" | Cell ID positioning method | +| "ECID" | Enhanced cell ID methods based on LTE signals | +| "OTDOA" | Observed time difference of arrival positioning based on LTE signals | +| "BAROMETRIC_PRESSURE" | Positioning method based on barometric Pressure Sensor | +| "WLAN" | WLAN positioning | +| "BLUETOOTH" | Bluetooth positioning | +| "MBS" | Terrestrial Beacon System (TBS) positioning based on MBS signals | +| "MOTION_SENSOR" | Positioning method based on motion Sensor | +| "DL_TDOA" | Downlink Time Difference of Arrival (DL-TDOA) based on NR signals | +| "DL_AOD" | Downlink Angle-of-Departure (DL-AoD) based on NR signals | +| "MULTI-RTT" | Multi-Round Trip Time Positioning (Multi-RTT based on NR signals). | +| "NR_ECID" | NR enhanced cell ID methods (NR E-CID) based on NR signals. | +| "UL_TDOA" | Uplink Time Difference of Arrival (UL-TDOA) based on NR signals | +| "UL_AOA" | Uplink Angle of Arrival (UL-AoA), including the Azimuth of Arrival (A-AoA) and the Zenith of Arrival (Z-AoA) based on NR signals. | +| "NETWORK_SPECIFIC" | Network specific position methods. | + +##### 6.1.6.3.7 Enumeration: PositioningMode + +The enumeration PositioningMode represents the mode used to determine the location of the UE when a certain positioning method is used. + +**Table 6.1.6.3.7-1: Enumeration PositioningMode** + +| Enumeration value | Description | +|-------------------|-------------------| +| "UE_BASED" | UE-based mode | +| "UE_ASSISTED" | UE-assisted mode | +| "CONVENTIONAL" | Conventional mode | + +##### 6.1.6.3.8 Enumeration: GnssId + +The enumeration GnssId represents the different GNSS systems. + +**Table 6.1.6.3.8-1: Enumeration GnssId** + +| Enumeration value | Description | +|-------------------|--------------------------------------| +| "GPS" | GPS | +| "GALILEO" | Galileo | +| "SBAS" | Space Based Augmentation Systems | +| "MODERNIZED_GPS" | Modernized GPS | +| "QZSS" | Quasi Zenith Satellite System | +| "GLONASS" | Global Navigation Satellite System | +| "BDS" | BeiDou Navigation Satellite System | +| "NAVIC" | Navigation with Indian Constellation | + +##### 6.1.6.3.9 Enumeration: Usage + +The enumeration Usage represents the type of usage made of the location measurement from the UE. + +**Table 6.1.6.3.9-1: Enumeration Usage** + +| Enumeration value | Description | +|---------------------------------------------|----------------------------------------------------------| +| "UNSUCCESS" | Not successful | +| "SUCCESS_RESULTS_NOT_USED" | Successful result not used | +| "SUCCESS_RESULTS_USED_TO_VERIFY_LOCATION" | Successful result used to verify the location estimate | +| "SUCCESS_RESULTS_USED_TO_GENERATE_LOCATION" | Successful result used to generate the location estimate | +| "SUCCESS_METHOD_NOT_DETERMINED" | Successful method not determined | + +##### 6.1.6.3.10 Enumeration: LcsPriority + +The enumeration LcsPriority represents the priority of the LCS client. + +**Table 6.1.6.3.10-1: Enumeration LcsPriority** + +| Enumeration value | Description | +|--------------------|----------------------------------| +| "HIGHEST_PRIORITY" | LCS client with highest priority | +| "NORMAL_PRIORITY" | LCS client with normal priority | + +##### 6.1.6.3.11 Enumeration: VelocityRequested + +The enumeration VelocityRequested represents the indication of velocity requirement. + +**Table 6.1.6.3.11-1: Enumeration VelocityRequested** + +| Enumeration value | Description | +|-----------------------------|-----------------------------------| +| "VELOCITY IS NOT REQUESTED" | velocity estimate is required | +| "VELOCITY IS REQUESTED" | velocity estimate is not required | + +##### 6.1.6.3.12 Enumeration: AccuracyFulfilmentIndicator + +The enumeration AccuracyFulfilmentIndicator represents whether the requested accuracy was fulfilled or not. + +**Table 6.1.6.3.12-1: Enumeration AccuracyFulfilmentIndicator** + +| Enumeration value | Description | +|------------------------------------|-------------------------------------| +| "REQUESTED ACCURACY FULFILLED" | requested accuracy is fulfilled | +| "REQUESTED_ACCURACY_NOT_FULFILLED" | requested accuracy is not fulfilled | + +##### 6.1.6.3.13 Enumeration: VerticalDirection + +The enumeration VerticalDirection represents the direction (upward/downward) of the vertical speed. + +**Table 6.1.6.3.13-1: Enumeration VerticalDirection** + +| Enumeration value | Description | +|-------------------|----------------------------| +| "UPWARD" | Vertical speed is upward | +| "DOWNWARD" | Vertical speed is downward | + +##### 6.1.6.3.14 Enumeration: LdrType + +**Table 6.1.6.3.14-1: Enumeration LdrType** + +| Enumeration value | Description | +|----------------------|-------------------------| +| "UE_AVAILABLE" | UE available event | +| "PERIODIC" | Periodic event | +| "ENTERING INTO AREA" | Entering area event | +| "LEAVING FROM AREA" | Leaving area event | +| "BEING_INSIDE_AREA" | Being inside area event | +| "MOTION" | Motion event | + +##### 6.1.6.3.15 Enumeration: ReportingAreaType + +The enumeration ReportingAreaType indicates the type of a reporting area. + +**Table 6.1.6.3.15-1: Enumeration ReportingAreaType** + +| Enumeration value | Description | +|--------------------------------------|-------------| +| "EPS_TRACKING_AREA_IDENTITY" | EPS TAI | +| "E-UTRAN_CELL_GLOBAL_IDENTIFICATION" | ECGI | +| "5GS_TRACKING_AREA_IDENTITY" | 5GS TAI | +| "NR_CELL_GLOBAL_IDENTITY" | NCGI | + +##### 6.1.6.3.16 Enumeration: OccurrenceInfo + +The enumeration OccurrenceInfo indicates whether event reporting is one time. + +**Table 6.1.6.3.16-1: Enumeration AreaType** + +| Enumeration value | Description | +|-----------------------|-------------------------------------| +| "ONE_TIME_EVENT" | Event to be reported one-time only | +| "MULTIPLE_TIME_EVENT" | Event to be reported multiple times | + +##### 6.1.6.3.17 Enumeration: ReportingAccessType + +The enumeration ReportingAccessType indicates an allowed access type for event reporting. + +**Table 6.1.6.3.17-1: Enumeration ReportingAccessType** + +| Enumeration value | Description | +|-----------------------------|----------------------------------| +| "NR" | NG Radio access | +| "EUTRA_CONNECTED_TO_5GC" | E-UTRAN access connected to 5GC | +| "NON_3GPP_CONNECTED_TO_5GC" | Non-3GPP access connected to 5GC | + +##### 6.1.6.3.18 Enumeration: EventClass + +**Table 6.1.6.3.18-1: Enumeration EventClass** + +| Enumeration value | Description | +|--------------------------|-----------------------------------------------------------------------------------------------------------------------------| +| "SUPPLEMENTARY_SERVICES" | A supplementary services message containing an argument for an Ics-EventReport operation as defined in 3GPP TS 24.080 [20]. | + +##### 6.1.6.3.19 Enumeration: ReportedEventType + +**Table 6.1.6.3.19-1: Enumeration ReportedEventType** + +| Enumeration value | Description | +|-------------------------------------|------------------------------------------------| +| "PERIODIC_EVENT" | Periodic reporting event | +| "ENTERING_AREA_EVENT" | Entering area reporting event | +| "LEAVING_AREA_EVENT" | Leaving area reporting event | +| "BEING_INSIDE_AREA_EVENT" | Being inside area reporting event | +| "MOTION_EVENT" | Motion reporting event | +| "MAXIMUM_INTERVAL_EXPIRATION_EVENT" | Expiration of maximum reporting interval event | +| "LOCATION_CANCELLATION_EVENT" | Cancellation of location reporting event | + +##### 6.1.6.3.20 Enumeration: TerminationCause + +**Table 6.1.6.3.20-1: Enumeration TerminationCause** + +| Enumeration value | Description | +|--------------------------|---------------------------------------| +| "TERMINATION_BY_UE" | Event reporting terminated by UE | +| "TERMINATION_BY_NETWORK" | Event reporting terminated by Network | +| "NORMAL_TERMINATION" | Normal Termination | + +##### 6.1.6.3.21 Enumeration: LcsQosClass + +Table 6.1.6.3.21-1: Enumeration LcsQosClass + +| Enumeration value | Description | +|-------------------|-------------------| +| "BEST EFFORT" | Best Effort Class | +| "ASSURED" | Assured Class | + +##### 6.1.6.3.22 Enumeration: UeLocationServiceInd + +Table 6.1.6.3.22-1: Enumeration UeLocationServiceInd + +| Enumeration value | Description | +|----------------------------|----------------------------------| +| "LOCATION ESTIMATE" | Request location estimate | +| "LOCATION ASSISTANCE DATA" | Request location assistance data | + +#### 6.1.6.4 Binary data + +##### 6.1.6.4.1 Introduction + +This clause defines the binary data that shall be supported in a binary body part in an HTTP multipart message (see clauses 6.1.2.2.2 and 6.1.2.4). + +##### 6.1.6.4.2 LPP Message + +LPP Message shall encode a LPP message as specified in 3GPP TS 36.355 [21], using the vnd.3gpp.lpp content-type. + +### 6.1.7 Error Handling + +#### 6.1.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +#### 6.1.7.2 Protocol Errors + +Protocol errors handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +#### 6.1.7.3 Application Errors + +The application errors defined for the Nlmf\_Location service are listed in Table 6.1.7.3-1. + +Table 6.1.7.3-1: Application errors + +| Application Error | HTTP status code | Description | +|---------------------------------|---------------------------|--------------------------------------------------------------------------| +| POSITIONING_DENIED | 403 Forbidden | The positioning procedure was denied. | +| UNSPECIFIED | 403 Forbidden | The request is rejected due to unspecified reasons. | +| UNSUPPORTED_BY_UE | 403 Forbidden | A request for periodic or triggered location is not supported by the UE. | +| LOCATION_SESSION_UNKNOWN | 403 Forbidden | The location context was not found. | +| LOCATION_TRANSFER_NOT_SUPPORTED | 403 Forbidden | Transfer of a location context is not supported | +| INSUFFICIENT_RESOURCES | 403 Forbidden | Insufficient resources for location context transfer | +| EVENT_REPORT_UNRECOGNIZED | 403 Forbidden | The event report is unrecognizable or cannot be parsed. | +| POSITIONING_FAILED | 500 Internal Server Error | The positioning procedure failed. | +| UNREACHABLE_USER | 504 Gateway Timeout | The user could not be reached in order to perform positioning procedure. | + +### 6.1.8 Security + +As indicated in 3GPP TS 33.501 [9], the access to the Nlmf\_Location API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [10]), using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [11]) plays the role of the authorization server. + +If OAuth2 authorization is used, an NF Service Consumer, prior to consuming services offered by the Nlmf\_Location API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [11], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nlmf\_Location service. + +The Nlmf\_Location API defines scopes for OAuth2 authorization as specified in 3GPP TS 33.501 [9]; it defines a single scope consisting on the name of the service (i.e., "nlmf-loc"), and it does not define any additional scopes at resource or operation level. + +### 6.1.9 Feature Negotiation + +The optional features in table 6.1.9-1 are defined for the Nlmf\_Location API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.1.9-1: Supported Features** + +| Feature number | Feature Name | M/O | Description | +|----------------|--------------|-----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | ES3XX | M | Extended Support of HTTP 307/308 redirection

An NF Service Consumer (e.g. AMF) that supports this feature shall support handling of HTTP 307/308 redirection for any service operation of the Location service. An NF Service Consumer that does not support this feature does only support HTTP redirection as specified for 3GPP Release 15. | + +### 6.1.10 HTTP redirection + +An HTTP request may be redirected to a different LMF service instance, within the same LMF or a different LMF of an LMF set, e.g. when an LMF service instance is part of an LMF (service) set or when using indirect communications (see 3GPP TS 29.500 [4]). See also the ES3XX feature in clause 6.1.9. + +An SCP that reselects a different LMF producer instance will return the NF Instance ID of the new LMF producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an LMF within an LMF set redirects a service request to a different LMF of the set using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new LMF towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +## 6.2 Nlmf\_Broadcast Service API + +### 6.2.1 API URI + +The Nlmf\_Broadcast service shall use the Nlmf\_Broadcast API. + +The API URI of the Nlmf\_Broadcast API shall be: + +{apiRoot}
/ + +The request URI used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}
** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nlmf-broadcast". +- The shall be "v1". +- The shall be set as described in clause 6.2.3. + +### 6.2.2 Usage of HTTP + +#### 6.2.2.1 General + +HTTP/2, as defined in IETF RFC 7540 [12], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +HTTP messages and bodies for the Nlmf\_Location service shall comply with the OpenAPI [14] specification contained in Annex A. + +#### 6.2.2.2 HTTP Standard Headers + +##### 6.2.2.2.1 General + +##### 6.2.2.2.2 Content type + +The following content types shall be supported: + +- JSON, as defined in IETF RFC 8259 [13], shall be used as content type of the HTTP bodies specified in the present specification as indicated in clause 5.4 of 3GPP TS 29.500 [4]. +- The Problem Details JSON Object (IETF RFC 7807 [15]). The use of the Problem Details JSON object in a HTTP response body shall be signalled by the content type "application/problem+json". + +#### 6.2.2.3 HTTP custom headers + +##### 6.2.2.3.1 General + +The following HTTP custom headers shall be supported: + +- 3gpp-Sbi-Message-Priority: See 3GPP TS 29.500 [4], clause 5.2.3.2.2. + +This API does not define any new HTTP custom headers. + +### 6.2.3 Resources + +#### 6.2.3.1 Overview + +The structure of the Resource URIs of the Nlmf\_Broadcast service is shown in figure 6.2.3.1-1. + +![Diagram showing the resource URI structure of the Nlmf_Broadcast API. A solid line descends from the base URI '{apiRoot}/nlmf-broadcast/' to a dashed box containing the path '/cipher-key-data'.](40a8c30f7ea5ecea4912e040c97c5b9c_img.jpg) + +{apiRoot}/nlmf-broadcast/ + +Diagram showing the resource URI structure of the Nlmf\_Broadcast API. A solid line descends from the base URI '{apiRoot}/nlmf-broadcast/' to a dashed box containing the path '/cipher-key-data'. + +Figure 6.2.3.1-1: Resource URI structure of the Nlmf\_Broadcast API + +### 6.2.4 Custom Operations without associated resources + +#### 6.2.4.1 Overview + +Table 6.2.4.1-1: Custom operations without associated resources + +| Operation Name | Custom operation URI | Mapped HTTP method | Description | +|-----------------|----------------------|--------------------|--------------------| +| cipher-key-data | /cipher-key-data | POST | Ciphering Key Data | + +#### 6.2.4.4 Operation: cipher-key-data + +##### 6.2.4.4.1 Description + +This clause describes the custom operation and what it is used for. + +##### 6.2.4.4.2 Operation Definition + +This operation shall support the request and response data structures and response codes specified in table 6.2.4.4.2-1 and table 6.2.4.4.2-2. + +Table 6.2.4.4.2-1: Data structures supported by the POST Request Body on this resource + +| Data type | P | Cardinality | Description | +|-------------------|---|-------------|--------------------------------------------------------| +| CipherRequestData | M | 1 | Input parameters to the "Ciphering Key Data" operation | + +**Table 6.2.4.4.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| CipherResponseData | M | 1 | 200 OK | This case represents a successful request for ciphering key data.

Upon success, a response body is returned indicating whether the LMF has ciphering key data. The ciphering key data is returned separately in a CipheringKeyData notification. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same LMF or LMF (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same LMF or LMF (service) set. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be set to one of the following application errors:
- UNSPECIFIED
- BROADCAST_CIPHERING_KEYS_NOT_SUPPORTED

See table 6.2.7.3-1 for the description of this error. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +**Table 6.2.4.4.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same LMF or LMF (service) set. Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.2.4.4.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same LMF or LMF (service) set. Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +### 6.2.5 Notifications + +#### 6.2.5.1 CipheringKeyData + +##### 6.2.5.1.1 Description + +The CipheringKeyData operation is used to notify the occurrence of new ciphering key information to a consumer NF (e.g. AMF). + +##### 6.2.5.1.2 Notification Definition + +Callback URI: {amfCallBackURI} + +See clause 5.3.2.2.2 for the description of how the LMF obtains the Callback URI of the NF Service Consumer (i.e. AMF). + +##### 6.2.5.1.3 Notification Standard Methods + +###### 6.2.5.1.3.1 POST + +This method sends a ciphering key data notify to the NF Service Consumer. + +This method shall support the request and response data structures and response codes specified in table 6.2.5.1.3.1-1 and table 6.2.5.1.3.1-2. + +**Table 6.2.5.1.3.1-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|--------------------------------------------------------| +| CipheringKeyInfo | M | 1 | Input parameters to the "Ciphering Key Data" operation | + +**Table 6.2.5.1.3.1-2: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| CipheringKeyResponse | M | 1 | 200 OK | This case represents successful or partially successful storage of ciphering key information by the service consumer NF.

A response body is returned containing the following parameters:
- List of Ciphering Set IDs successfully stored
- List of Ciphering Set IDs not successfully stored | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The NF service consumer shall generate a Location header field containing a URI pointing to the endpoint of another NF service consumer to which the notification should be sent.

If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service consumer to which the notification should be sent. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The NF service consumer shall generate a Location header field containing a URI pointing to the endpoint of another NF service consumer to which the notification should be sent.

If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service consumer to which the notification should be sent. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be set to one of the following application errors:
- UNSPECIFIED
- UNABLE_TO_STORE_CIPHERING_KEY_DATA

See table 6.2.7.3-1 for the description of this error. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +**Table 6.2.5.1.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of NF service consumer to which the notification should be sent | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the notification is redirected | + +**Table 6.2.5.1.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of NF service consumer to which the notification should be sent | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the notification is redirected | + +### 6.2.6 Data Model + +#### 6.2.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.2.6.1-1 specifies the data types defined for the Nlmf\_Broadcast service based interface protocol. + +**Table 6.2.6.1-1: Nlmf\_Broadcast specific Data Types** + +| Data type | Clause defined | Description | +|----------------------|----------------|-------------------------------------------------------------| +| CipheringKeyInfo | 6.2.6.2.2 | Information within Ciphering Key Data Notification request | +| CipheringKeyResponse | 6.2.6.2.3 | Information within Ciphering Key Data Notification Response | +| CipheringDataSet | 6.2.6.2.4 | Represents a Ciphering Data Set | +| CipheringSetReport | 6.2.6.2.5 | Represents a report of Ciphering Data Set storage | +| CipherRequestData | 6.2.6.2.6 | Information within Ciphering Key Data request | +| CipherResponseData | 6.2.6.2.7 | Information within Ciphering Key Data Response | +| CipheringSetID | 6.2.6.3.2 | Ciphering Data Set ID | +| CipheringKey | 6.2.6.3.2 | Ciphering Key | +| C0 | 6.2.6.3.2 | First component of the initial ciphering counter | +| ValidityDuration | 6.2.6.3.2 | Validity Duration of the Ciphering Data Set | +| StorageOutcome | 6.2.6.3.3 | Indicates the result of Ciphering Data Set storage | +| DataAvailability | 6.2.6.3.4 | Indicates availability of ciphering key data at an LMF | + +Table 6.2.6.1-2 specifies data types re-used by the Nlmf\_Broadcast service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nlmf service based interface. + +**Table 6.2.6.1-2: Nlmf\_Broadcast re-used Data Types** + +| Data type | Reference | Comments | +|-------------------|--------------------|--------------------------------------------------| +| Bytes | 3GPP TS 29.571 [8] | Binary data encoded as a base64 character string | +| DateTime | 3GPP TS 29.571 [8] | Date and Time | +| Uri | 3GPP TS 29.571 [8] | Uniform Resource Identifier | +| SupportedFeatures | 3GPP TS 29.571 [8] | Supported Features | +| RedirectResponse | 3GPP TS 29.571 [8] | Redirect Response | + +#### 6.2.6.2 Structured data types + +##### 6.2.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.2.6.2.2 Type: CipheringKeyInfo + +**Table 6.2.6.2.2-1: Definition of type CipheringKeyInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------| +| cipheringData | array(CipheringDataSet) | M | 1..N | This IE contains one or more ciphering data sets, where each ciphering data set contains information for one ciphering key. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.2.9 is supported. | + +##### 6.2.6.2.3 Type: CipheringKeyResponse + +**Table 6.2.6.2.3-1: Definition of type CipheringKeyResponse** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|---------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| cipheringDataReport | Array(CipheringSetReport) | O | 1..N |

This IE indicates the ciphering data sets which were successfully stored or not stored.

The absence of this IE indicates that all ciphering data sets were successfully stored.

| + +##### 6.2.6.2.4 Type: CipheringDataSet + +Table 6.2.6.2.4-1: Definition of type CipheringDataSet + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|----------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| cipheringSetID | CipheringSetID | M | 1 | Identification of a ciphering data set | +| cipheringKey | CipheringKey | M | 1 | A ciphering key value | +| c0 | C0 | M | 1 | First component of the initial ciphering counter as defined in clause 7.4.2 of 3GPP TS 36.355 [21] | +| ltePosSibTypes | Bytes | O | 0..1 |

This IE contains a bitmap indicating the LTE positioning SIB types for which the ciphering data set is applicable:

  • - a bit set to 0 indicates that the ciphering data set is not applicable to the corresponding LTE positioning SIB type
  • - a bit set to 1 indicates that the ciphering data set is applicable to the corresponding LTE positioning SIB type

The mapping of the bits to the LTE positioning SIB types is as follows:

  • -- bit 8 in the first octet maps to positioning SIB Type 1-1
  • -- bit 7 in the first octet maps to positioning SIB Type 1-2
  • -- bit 6 in the first octet maps to positioning SIB Type 1-3
  • -- bit 5 in the first octet maps to positioning SIB Type 1-4
  • -- bit 4 in the first octet maps to positioning SIB Type 1-5
  • -- bit 3 in the first octet maps to positioning SIB Type 1-6
  • -- bit 2 in the first octet maps to positioning SIB Type 1-7
  • -- bit 1 in the first octet maps to positioning SIB Type 1-8
  • -- bit 8 in the second octet maps to positioning SIB Type 2-1
  • -- bit 7 in the second octet maps to positioning SIB Type 2-2
  • -- bit 6 in the second octet maps to positioning SIB Type 2-3
  • -- bit 5 in the second octet maps to positioning SIB Type 2-4
  • -- bit 4 in the second octet maps to positioning SIB Type 2-5
  • -- bit 3 in the second octet maps to positioning SIB Type 2-6
  • -- bit 2 in the second octet maps to positioning SIB Type 2-7
  • -- bit 1 in the second octet maps to positioning SIB Type 2-8
  • -- bit 8 in the third octet maps to positioning SIB Type 2-9
  • -- bit 7 in the third octet maps to positioning SIB Type 2-10
  • -- bit 6 in the third octet maps to positioning SIB Type 2-11
  • -- bit 5 in the third octet maps to positioning SIB Type 2-12
| + +| | | | | | +|---------------|-------|---|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | |
  • -- bit 4 in the third octet maps to positioning SIB Type 2-13
  • -- bit 3 in the third octet maps to positioning SIB Type 2-14
  • -- bit 2 in the third octet maps to positioning SIB Type 2-15
  • -- bit 1 in the third octet maps to positioning SIB Type 2-16

  • -- bit 8 in the fourth octet maps to positioning SIB Type 2-17
  • -- bit 7 in the fourth octet maps to positioning SIB Type 2-18
  • -- bit 6 in the fourth octet maps to positioning SIB Type 2-19
  • -- bit 5 in the fourth octet maps to positioning SIB Type 2-20
  • -- bit 4 in the fourth octet maps to positioning SIB Type 2-21
  • -- bit 3 in the fourth octet maps to positioning SIB Type 2-22
  • -- bit 2 in the fourth octet maps to positioning SIB Type 2-23
  • -- bit 1 in the fourth octet maps to positioning SIB Type 2-24

  • -- bit 8 in the fifth octet maps to positioning SIB Type 2-25
  • -- bit 7 in the fifth octet maps to positioning SIB Type 3-1
  • -- bit 6 in the fifth octet maps to positioning SIB Type 4-1
  • -- bit 5 in the fifth octet maps to positioning SIB Type 5-1

Any unassigned bits are spare and shall be coded as zero. Non-included bits shall be treated as being coded as zero.
(NOTE 1)

| +| nrPosSibTypes | Bytes | O | 0..1 |

This IE contains a bitmap indicating the NR positioning SIB types for which the ciphering data set is applicable:

  • - a bit set to 0 indicates that the ciphering data set is not applicable to the corresponding NR positioning SIB type
  • - a bit set to 1 indicates that the ciphering data set is applicable to the corresponding NR positioning SIB type

The mapping of the bits to the NR positioning SIB types is as follows:

  • -- bit 8 in the first octet maps to positioning SIB Type 1-1
  • -- bit 7 in the first octet maps to positioning SIB Type 1-2
  • -- bit 6 in the first octet maps to positioning SIB Type 1-3
  • -- bit 5 in the first octet maps to positioning SIB Type 1-4
  • -- bit 4 in the first octet maps to positioning SIB Type 1-5
  • -- bit 3 in the first octet maps to positioning SIB Type 1-6
  • -- bit 2 in the first octet maps to positioning SIB Type 1-7
| + +| | | | | +|--|--|--|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | positioning SIB Type 1-7
-- bit 1 in the first octet maps to positioning SIB Type 1-8

-- bit 8 in the second octet maps to positioning SIB Type 2-1
-- bit 7 in the second octet maps to positioning SIB Type 2-2
-- bit 6 in the second octet maps to positioning SIB Type 2-3
-- bit 5 in the second octet maps to positioning SIB Type 2-4
-- bit 4 in the second octet maps to positioning SIB Type 2-5
-- bit 3 in the second octet maps to positioning SIB Type 2-6
-- bit 2 in the second octet maps to positioning SIB Type 2-7
-- bit 1 in the second octet maps to positioning SIB Type 2-8

-- bit 8 in the third octet maps to positioning SIB Type 2-9
-- bit 7 in the third octet maps to positioning SIB Type 2-10
-- bit 6 in the third octet maps to positioning SIB Type 2-11
-- bit 5 in the third octet maps to positioning SIB Type 2-12
-- bit 4 in the third octet maps to positioning SIB Type 2-13
-- bit 3 in the third octet maps to positioning SIB Type 2-14
-- bit 2 in the third octet maps to positioning SIB Type 2-15
-- bit 1 in the third octet maps to positioning SIB Type 2-16

-- bit 8 in the fourth octet maps to positioning SIB Type 2-17
-- bit 7 in the fourth octet maps to positioning SIB Type 2-18
-- bit 6 in the fourth octet maps to positioning SIB Type 2-19
-- bit 5 in the fourth octet maps to positioning SIB Type 2-20
-- bit 4 in the fourth octet maps to positioning SIB Type 2-21
-- bit 3 in the fourth octet maps to positioning SIB Type 2-22
-- bit 2 in the fourth octet maps to positioning SIB Type 2-23
-- bit 1 in the fourth octet maps to positioning SIB Type 3-1

-- bit 8 in the fifth octet maps to positioning SIB Type 4-1
-- bit 7 in the fifth octet maps to positioning SIB Type 5-1
-- bit 6 in the fifth octet maps to positioning SIB Type 6-1
-- bit 5 in the fifth octet maps to positioning SIB Type 6-2
-- bit 4 in the fifth octet maps to positioning SIB Type 6-3

Any unassigned bits are spare and shall be coded as zero. Non-included | +|--|--|--|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +| | | | | | +|-------------------|------------------|---|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | | bits shall be treated as being coded as zero.
(NOTE 1) | +| validityStartTime | DateTime | M | 1 | This IE contains the UTC time when the ciphering data set becomes valid. | +| validityDuration | ValidityDuration | M | 1 | The validity duration of the ciphering data set. | +| tailList | Bytes | O | 0..1 | This IE contains the TAs of the tracking areas for which the ciphering data set is applicable. It is encoded as octets 2 to n of the 5GS tracking area identity list IE specified in clause 9.11.3.9 of 3GPP TS 24.501 [22].

If this IE is omitted, the ciphering data set is valid in the entire PLMN. | + +NOTE 1: At least one of ltesibTypes IE and nrsibTypes IE shall be included. + +##### 6.2.6.2.5 Type: CipheringSetReport + +**Table 6.2.6.2.5-1: Definition of CipheringSetReport** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|----------------|---|-------------|-----------------------------------------------------------------------------------------| +| cipheringSetID | CipheringSetID | M | 1 | Identification of a ciphering data set | +| storageOutcome | StorageOutcome | M | 1 | Indication of whether the ciphering data set was successfully stored or was not stored. | + +##### 6.2.6.2.6 Type: Cipher requestData + +**Table 6.2.6.2.6-1: Definition of Cipher requestData** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------| +| amfCallBackURI | Uri | M | 1 | Callback URI of the NF Service Consumer | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.2.9 is supported. | + +##### 6.2.6.2.7 Type: CipherResponseData + +**Table 6.2.6.2.7-1: Definition of CipherResponseData** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|------------------|---|-------------|---------------------------------------------------------------------------------------------------------| +| dataAvailability | DataAvailability | M | 1 | An indication of whether the LMF currently has ciphering key data applicable to the NF Service Consumer | + +#### 6.2.6.3 Simple data types and enumerations + +##### 6.2.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 6.2.6.3.2 Simple data types + +The simple data types defined in table 6.2.6.3.2-1 shall be supported. + +**Table 6.2.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | +|------------------|-----------------|-------------------------------------------------------------------| +| CipheringSetID | integer | The ciphering set ID
Minimum = 0. Maximum = 65535 | +| CipheringKey | Bytes | A 128 bit ciphering key encoded as a base64 character string | +| C0 | Bytes | A 128 bit value for C0 encoded as a base64 character string | +| ValidityDuration | integer | The validity duration in minutes.
Minimum = 1. Maximum = 65535 | + +##### 6.2.6.3.3 Enumeration: StorageOutcome + +The enumeration StorageOutcome represents the outcome of cipher set data storage at the service consumer NF. + +**Table 6.2.6.3.3-1: Enumeration StorageOutcome** + +| Enumeration value | Description | +|----------------------|-----------------------------------------------------------| +| "STORAGE_SUCCESSFUL" | Indicates storage of Ciphering Data Set is successful | +| "STORAGE_FAILED" | Indicates storage of Ciphering Data Set is not successful | + +##### 6.2.6.3.4 Enumeration: DataAvailability + +The enumeration DataAvailability represents the availability of ciphering key data at an LMF. + +**Table 6.2.6.3.4-1: Enumeration DataAvailability** + +| Enumeration value | Description | +|------------------------------------|------------------------------------------------------| +| "CIPHERING_KEY_DATA_AVAILABLE" | Indicates Ciphering Data Set is available in LMF | +| "CIPHERING_KEY_DATA_NOT_AVAILABLE" | Indicates Ciphering Data Set is not available in LMF | + +### 6.2.7 Error Handling + +#### 6.2.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +#### 6.2.7.2 Protocol Errors + +Protocol errors handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +#### 6.2.7.3 Application Errors + +The application errors defined for the Nlmf\_Broadcast service are listed in table 6.2.7.3-1. + +Table 6.2.7.3-1: Application errors + +| Application Error | HTTP status code | Description | +|----------------------------------------|------------------|-----------------------------------------------------------------| +| UNSPECIFIED | 403
Forbidden | The request is rejected due to unspecified reasons. | +| UNABLE_TO_STORE_CIPHERING_KEY_DATA | 403
Forbidden | The service consumer NF was unable to store ciphering key data. | +| BROADCAST_CIPHERING_KEYS_NOT_SUPPORTED | 403
Forbidden | Ciphering keys for broadcast are not supported. | + +### 6.2.8 Security + +The Nlmf\_Broadcast API does not define service operations for which additional security is needed in this version of the specification. + +### 6.2.9 Feature Negotiation + +The optional features in table 6.2.9-1 are defined for the Nlmf\_Broadcast API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +Table 6.2.9-1: Supported Features + +| Feature number | Feature Name | M/O | Description | +|----------------|--------------|-----|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | ES3XX | M | Extended Support of HTTP 307/308 redirection

An NF Service Consumer (e.g. AMF) that supports this feature shall support handling of HTTP 307/308 redirection for any service operation of the Broadcast service. An NF Service Consumer that does not support this feature does only support HTTP redirection as specified for 3GPP Release 15. | + +### 6.2.10 HTTP redirection + +An HTTP request may be redirected to a different LMF service instance, within the same LMF or a different LMF of an LMF set, e.g. when an LMF service instance is part of an LMF (service) set or when using indirect communications (see 3GPP TS 29.500 [4]). See also the ES3XX feature in clause 6.2.9. + +An SCP that reselects a different LMF producer instance will return the NF Instance ID of the new LMF producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an LMF within an LMF set redirects a service request to a different LMF of the set using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new LMF towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +# --- Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex specifies the formal definition of the Nlmf Service APIs. It consists of an OpenAPI 3.0.0 specification, in YAML format. + +This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository, that uses the GitLab software version control system (see 3GPP TS 29.501 [5] clause 5.3.1 and 3GPP TR 21.900 [7] clause 5B). + +## A.2 Nlmf\_Location API + +``` +openapi: 3.0.0 + +info: + version: '1.1.5' + title: 'LMF Location' + description: | + LMF Location Service. + © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.572 V16.9.0; 5G System; Location Management Services; Stage 3 + url: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.572/' + +servers: + - url: '{apiRoot}/nlmf-loc/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - nlmf-loc + +paths: + /determine-location: + post: + summary: Determine Location of an UE + operationId: DetermineLocation + tags: + - Determine Location + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InputData' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/InputData' + binaryDataLppMessage: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataLppMessage: + contentType: application/vnd.3gpp.lpp + headers: + Content-Id: + schema: + type: string + required: true + responses: + '200': + description: Expected response to a valid request + content: +``` + +``` + + application/json: + schema: + $ref: '#/components/schemas/LocationData' + '204': + description: Expected response for MO-LR requesting location assistance data. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + callbacks: + EventNotify: + '{ $request.body#/hgmlcCallBackURI }': + post: + requestBody: + description: UE Event Notification + content: + application/json: + schema: + $ref: '#/components/schemas/EventNotifyData' + responses: + '204': + description: Expected response to a valid notification + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/cancel-location: + post: + summary: request cancellation of periodic or triggered location + operationId: CancelLocation + +``` + +``` +tags: + - Cancel Location +requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CancelLocData' + required: true +responses: + '204': + description: Expected response to a successful cancellation + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +/location-context-transfer: + post: + summary: transfer context information for periodic or triggered location + operationId: LocationContextTransfer + tags: + - Location Context Transfer + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LocContextData' + required: true + responses: + '204': + description: Expected response to successful location context transfer + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +``` + +``` +'504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nlmf-loc: Access to the Nlmf_Location API + schemas: +# +# COMPLEX TYPES +# + InputData: + type: object + not: + required: [ ecgi, ncgi ] + properties: + externalClientType: + $ref: '#/components/schemas/ExternalClientType' + correlationID: + $ref: '#/components/schemas/CorrelationID' + amfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + locationQoS: + $ref: '#/components/schemas/LocationQoS' + supportedGADShapes: + type: array + items: + $ref: '#/components/schemas/SupportedGADShapes' + minItems: 1 + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + pei: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + ecgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi' + ecgiOnSecondNode: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi' + ncgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi' + ncgiOnSecondNode: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi' + priority: + $ref: '#/components/schemas/LcsPriority' + velocityRequested: + $ref: '#/components/schemas/VelocityRequested' + ueLcsCap: + $ref: '#/components/schemas/UeLcsCapability' + lcsServiceType: + $ref: '#/components/schemas/LcsServiceType' + ldrType: + $ref: '#/components/schemas/LdrType' + hgmlcCallBackURI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + vgmlcAddress: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + ldrReference: + $ref: '#/components/schemas/LdrReference' + periodicEventInfo: + $ref: '#/components/schemas/PeriodicEventInfo' + areaEventInfo: + $ref: '#/components/schemas/AreaEventInfo' + motionEventInfo: + $ref: '#/components/schemas/MotionEventInfo' + reportingAccessTypes: + type: array + items: + $ref: '#/components/schemas/ReportingAccessType' + minItems: 1 + ueConnectivityStates: +``` + +``` +$ref: '#/components/schemas/UeConnectivityState' +ueLocationServiceInd: + $ref: '#/components/schemas/UeLocationServiceInd' +lppMessage: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' +supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +LocationData: + type: object + required: + - locationEstimate + properties: + locationEstimate: + $ref: '#/components/schemas/GeographicArea' + accuracyFulfilmentIndicator: + $ref: '#/components/schemas/AccuracyFulfilmentIndicator' + ageOfLocationEstimate: + $ref: '#/components/schemas/AgeOfLocationEstimate' + velocityEstimate: + $ref: '#/components/schemas/VelocityEstimate' + civicAddress: + $ref: '#/components/schemas/CivicAddress' + positioningDataList: + type: array + items: + $ref: '#/components/schemas/PositioningMethodAndUsage' + minItems: 1 + gnssPositioningDataList: + type: array + items: + $ref: '#/components/schemas/GNSSPositioningMethodAndUsage' + minItems: 1 + ecgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi' + ncgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi' + altitude: + $ref: '#/components/schemas/Altitude' + barometricPressure: + $ref: '#/components/schemas/BarometricPressure' + servingLMFIdentification: + $ref: '#/components/schemas/LMFIdentification' + +GeographicArea: + anyOf: + - $ref: '#/components/schemas/Point' + - $ref: '#/components/schemas/PointUncertaintyCircle' + - $ref: '#/components/schemas/PointUncertaintyEllipse' + - $ref: '#/components/schemas/Polygon' + - $ref: '#/components/schemas/PointAltitude' + - $ref: '#/components/schemas/PointAltitudeUncertainty' + - $ref: '#/components/schemas/EllipsoidArc' + +GADShape: + type: object + required: + - shape + properties: + shape: + $ref: '#/components/schemas/SupportedGADShapes' + discriminator: + propertyName: shape + mapping: + POINT: '#/components/schemas/Point' + POINT_UNCERTAINTY_CIRCLE: '#/components/schemas/PointUncertaintyCircle' + POINT_UNCERTAINTY_ELLIPSE: '#/components/schemas/PointUncertaintyEllipse' + POLYGON: '#/components/schemas/Polygon' + POINT_ALTITUDE: '#/components/schemas/PointAltitude' + POINT_ALTITUDE_UNCERTAINTY: '#/components/schemas/PointAltitudeUncertainty' + ELLIPSOID_ARC: '#/components/schemas/EllipsoidArc' + +Point: + allOf: + - $ref: '#/components/schemas/GADShape' + - type: object + required: + - point + properties: + point: + $ref: '#/components/schemas/GeographicalCoordinates' +``` + +``` +PointUncertaintyCircle: + allOf: + - $ref: '#/components/schemas/GADShape' + - type: object + required: + - point + - uncertainty + properties: + point: + $ref: '#/components/schemas/GeographicalCoordinates' + uncertainty: + $ref: '#/components/schemas/Uncertainty' +PointUncertaintyEllipse: + allOf: + - $ref: '#/components/schemas/GADShape' + - type: object + required: + - point + - uncertaintyEllipse + - confidence + properties: + point: + $ref: '#/components/schemas/GeographicalCoordinates' + uncertaintyEllipse: + $ref: '#/components/schemas/UncertaintyEllipse' + confidence: + $ref: '#/components/schemas/Confidence' +Polygon: + allOf: + - $ref: '#/components/schemas/GADShape' + - type: object + required: + - pointList + properties: + pointList: + $ref: '#/components/schemas/PointList' +PointAltitude: + allOf: + - $ref: '#/components/schemas/GADShape' + - type: object + required: + - point + - altitude + properties: + point: + $ref: '#/components/schemas/GeographicalCoordinates' + altitude: + $ref: '#/components/schemas/Altitude' +PointAltitudeUncertainty: + allOf: + - $ref: '#/components/schemas/GADShape' + - type: object + required: + - point + - altitude + - uncertaintyEllipse + - uncertaintyAltitude + - confidence + properties: + point: + $ref: '#/components/schemas/GeographicalCoordinates' + altitude: + $ref: '#/components/schemas/Altitude' + uncertaintyEllipse: + $ref: '#/components/schemas/UncertaintyEllipse' + uncertaintyAltitude: + $ref: '#/components/schemas/Uncertainty' + confidence: + $ref: '#/components/schemas/Confidence' +EllipsoidArc: + allOf: + - $ref: '#/components/schemas/GADShape' + - type: object + required: + - point + - innerRadius + - uncertaintyRadius + - offsetAngle +``` + +``` +- includedAngle +- confidence +properties: + point: + $ref: '#/components/schemas/GeographicalCoordinates' + innerRadius: + $ref: '#/components/schemas/InnerRadius' + uncertaintyRadius: + $ref: '#/components/schemas/Uncertainty' + offsetAngle: + $ref: '#/components/schemas/Angle' + includedAngle: + $ref: '#/components/schemas/Angle' + confidence: + $ref: '#/components/schemas/Confidence' +GeographicalCoordinates: + type: object + required: + - lon + - lat + properties: + lon: + type: number + format: double + minimum: -180 + maximum: 180 + lat: + type: number + format: double + minimum: -90 + maximum: 90 +UncertaintyEllipse: + type: object + required: + - semiMajor + - semiMinor + - orientationMajor + properties: + semiMajor: + $ref: '#/components/schemas/Uncertainty' + semiMinor: + $ref: '#/components/schemas/Uncertainty' + orientationMajor: + $ref: '#/components/schemas/Orientation' +PointList: + type: array + items: + $ref: '#/components/schemas/GeographicalCoordinates' + minItems: 3 + maxItems: 15 +LocationQoS: + type: object + properties: + hAccuracy: + $ref: '#/components/schemas/Accuracy' + vAccuracy: + $ref: '#/components/schemas/Accuracy' + verticalRequested: + type: boolean + responseTime: + $ref: '#/components/schemas/ResponseTime' + lcsQoSClass: + $ref: '#/components/schemas/LcsQoSClass' +PositioningMethodAndUsage: + type: object + required: + - method + - mode + - usage + properties: + method: + $ref: '#/components/schemas/PositioningMethod' + mode: + $ref: '#/components/schemas/PositioningMode' + usage: + $ref: '#/components/schemas/Usage' + methodCode: + type: integer +``` + +``` + minimum: 16 + maximum: 31 +GnssPositioningMethodAndUsage: + type: object + required: + - mode + - gnss + - usage + properties: + mode: + $ref: '#/components/schemas/PositioningMode' + gnss: + $ref: '#/components/schemas/GnssId' + usage: + $ref: '#/components/schemas/Usage' +CivicAddress: + type: object + properties: + country: + type: string + A1: + type: string + A2: + type: string + A3: + type: string + A4: + type: string + A5: + type: string + A6: + type: string + PRD: + type: string + POD: + type: string + STS: + type: string + HNO: + type: string + HNS: + type: string + LMK: + type: string + LOC: + type: string + NAM: + type: string + PC: + type: string + BLD: + type: string + UNIT: + type: string + FIR: + type: string + ROOM: + type: string + PLC: + type: string + PCN: + type: string + POBOX: + type: string + ADDCODE: + type: string + SEAT: + type: string + RD: + type: string + RDSEC: + type: string + RDBR: + type: string + RDSUBBR: + type: string + PRM: + type: string +``` + +``` +POM: + type: string +usageRules: + type: string +method: + type: string +providedBy: + type: string + +VelocityEstimate: + oneOf: + - $ref: '#/components/schemas/HorizontalVelocity' + - $ref: '#/components/schemas/HorizontalWithVerticalVelocity' + - $ref: '#/components/schemas/HorizontalVelocityWithUncertainty' + - $ref: '#/components/schemas/HorizontalWithVerticalVelocityAndUncertainty' + +HorizontalVelocity: + type: object + required: + - hSpeed + - bearing + properties: + hSpeed: + $ref: '#/components/schemas/HorizontalSpeed' + bearing: + $ref: '#/components/schemas/Angle' + +HorizontalWithVerticalVelocity: + type: object + required: + - hSpeed + - bearing + - vSpeed + - vDirection + properties: + hSpeed: + $ref: '#/components/schemas/HorizontalSpeed' + bearing: + $ref: '#/components/schemas/Angle' + vSpeed: + $ref: '#/components/schemas/VerticalSpeed' + vDirection: + $ref: '#/components/schemas/VerticalDirection' + +HorizontalVelocityWithUncertainty: + type: object + required: + - hSpeed + - bearing + - hUncertainty + properties: + hSpeed: + $ref: '#/components/schemas/HorizontalSpeed' + bearing: + $ref: '#/components/schemas/Angle' + hUncertainty: + $ref: '#/components/schemas/SpeedUncertainty' + +HorizontalWithVerticalVelocityAndUncertainty: + type: object + required: + - hSpeed + - bearing + - vSpeed + - vDirection + - hUncertainty + - vUncertainty + properties: + hSpeed: + $ref: '#/components/schemas/HorizontalSpeed' + bearing: + $ref: '#/components/schemas/Angle' + vSpeed: + $ref: '#/components/schemas/VerticalSpeed' + vDirection: + $ref: '#/components/schemas/VerticalDirection' + hUncertainty: + $ref: '#/components/schemas/SpeedUncertainty' + vUncertainty: + $ref: '#/components/schemas/SpeedUncertainty' + +UeLcsCapability: + type: object +``` + +``` +properties: + lppSupport: + type: boolean + default: true + ciotOptimisation: + type: boolean + default: false +PeriodicEventInfo: + type: object + required: + - reportingAmount + - reportingInterval + properties: + reportingAmount: + $ref: '#/components/schemas/ReportingAmount' + reportingInterval: + $ref: '#/components/schemas/ReportingInterval' +AreaEventInfo: + type: object + required: + - areaDefinition + properties: + areaDefinition: + type: array + items: + $ref: '#/components/schemas/ReportingArea' + minItems: 1 + maxItems: 250 + occurrenceInfo: + $ref: '#/components/schemas/OccurrenceInfo' + minimumInterval: + $ref: '#/components/schemas/MinimumInterval' + maximumInterval: + $ref: '#/components/schemas/MaximumInterval' + samplingInterval: + $ref: '#/components/schemas/SamplingInterval' + reportingDuration: + $ref: '#/components/schemas/ReportingDuration' + reportingLocationReq: + type: boolean + default: true +ReportingArea: + type: object + required: + - areaType + properties: + areaType: + $ref: '#/components/schemas/ReportingAreaType' + tai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + ecgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi' + ncgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi' +MotionEventInfo: + type: object + required: + - linearDistance + properties: + linearDistance: + $ref: '#/components/schemas/LinearDistance' + occurrenceInfo: + $ref: '#/components/schemas/OccurrenceInfo' + minimumInterval: + $ref: '#/components/schemas/MinimumInterval' + maximumInterval: + $ref: '#/components/schemas/MaximumInterval' + samplingInterval: + $ref: '#/components/schemas/SamplingInterval' + reportingDuration: + $ref: '#/components/schemas/ReportingDuration' + reportingLocationReq: + type: boolean + default: true +CancelLocData: + type: object + required: +``` + +``` + + - hgmlcCallBackURI + - ldrReference +properties: + hgmlcCallBackURI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + ldrReference: + $ref: '#/components/schemas/LdrReference' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +LocContextData: + type: object + required: + - amfId + - ldrType + - hgmlcCallBackURI + - ldrReference + - eventReportMessage + properties: + amfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + locationQoS: + $ref: '#/components/schemas/LocationQoS' + supportedGADShapes: + type: array + items: + $ref: '#/components/schemas/SupportedGADShapes' + minItems: 1 + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + ldrType: + $ref: '#/components/schemas/LdrType' + hgmlcCallBackURI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + ldrReference: + $ref: '#/components/schemas/LdrReference' + periodicEventInfo: + $ref: '#/components/schemas/PeriodicEventInfo' + areaEventInfo: + $ref: '#/components/schemas/AreaEventInfo' + motionEventInfo: + $ref: '#/components/schemas/MotionEventInfo' + eventReportMessage: + $ref: '#/components/schemas/EventReportMessage' + eventReportingStatus: + $ref: '#/components/schemas/EventReportingStatus' + ueLocationInfo: + $ref: '#/components/schemas/UELocationInfo' + cIoT5GSOptimisation: + type: boolean + default: false + ecgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi' + ncgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi' + guami: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +EventReportMessage: + type: object + required: + - eventClass + - eventContent + properties: + eventClass: + $ref: '#/components/schemas/EventClass' + eventContent: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' +EventReportingStatus: + type: object + properties: + eventReportCounter: + $ref: '#/components/schemas/EventReportCounter' + eventReportDuration: + $ref: '#/components/schemas/EventReportDuration' +UELocationInfo: + +``` + +``` + type: object + properties: + locationEstimate: + $ref: '#/components/schemas/GeographicArea' + ageOfLocationEstimate: + $ref: '#/components/schemas/AgeOfLocationEstimate' + velocityEstimate: + $ref: '#/components/schemas/VelocityEstimate' + ageOfVelocityEstimate: + $ref: '#/components/schemas/AgeOfLocationEstimate' + + EventNotifyData: + type: object + required: + - reportedEventType + - ldrReference + properties: + reportedEventType: + $ref: '#/components/schemas/ReportedEventType' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + hgmlcCallbackURI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + ldrReference: + $ref: '#/components/schemas/LdrReference' + locationEstimate: + $ref: '#/components/schemas/GeographicArea' + ageOfLocationEstimate: + $ref: '#/components/schemas/AgeOfLocationEstimate' + civicAddress: + $ref: '#/components/schemas/CivicAddress' + positioningDataList: + type: array + items: + $ref: '#/components/schemas/PositioningMethodAndUsage' + minItems: 1 + gnssPositioningDataList: + type: array + items: + $ref: '#/components/schemas/GnssPositioningMethodAndUsage' + minItems: 1 + servingLMFIdentification: + $ref: '#/components/schemas/LMFIdentification' + terminationCause: + $ref: '#/components/schemas/TerminationCause' + velocityEstimate: + $ref: '#/components/schemas/VelocityEstimate' + altitude: + $ref: '#/components/schemas/Altitude' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + + UeConnectivityState: + type: object + required: + - accessType + properties: + accessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + connectivityState: + $ref: 'TS29518_Namf_EventExposure.yaml#/components/schemas/CmState' + +# +# +# SIMPLE TYPES +# + Altitude: + type: number + format: double + minimum: -32767 + maximum: 32767 + Angle: + type: integer + minimum: 0 + maximum: 360 + Uncertainty: + type: number +``` + +format: float +minimum: 0 +Orientation: +type: integer +minimum: 0 +maximum: 180 +Confidence: +type: integer +minimum: 0 +maximum: 100 +Accuracy: +type: number +format: float +minimum: 0 +InnerRadius: +type: integer +format: int32 +minimum: 0 +maximum: 327675 +CorrelationID: +type: string +minLength: 1 +maxLength: 255 +AgeOfLocationEstimate: +type: integer +minimum: 0 +maximum: 32767 +HorizontalSpeed: +type: number +format: float +minimum: 0 +maximum: 2047 +VerticalSpeed: +type: number +format: float +minimum: 0 +maximum: 255 +SpeedUncertainty: +type: number +format: float +minimum: 0 +maximum: 255 +BarometricPressure: +type: integer +minimum: 30000 +maximum: 115000 +LcsServiceType: +type: integer +minimum: 0 +maximum: 127 +LdrReference: +type: string +minLength: 2 +maxLength: 510 +ReportingAmount: +type: integer +minimum: 1 +maximum: 8639999 +ReportingInterval: +type: integer +minimum: 1 +maximum: 8639999 +MinimumInterval: +type: integer +minimum: 1 +maximum: 32767 +MaximumInterval: +type: integer +minimum: 1 +maximum: 86400 +SamplingInterval: +type: integer +minimum: 1 +maximum: 3600 +ReportingDuration: +type: integer +minimum: 1 +maximum: 8640000 + +``` +LinearDistance: + type: integer + minimum: 1 + maximum: 10000 +LMFIdentification: + type: string +EventReportCounter: + type: integer + minimum: 1 + maximum: 8640000 +EventReportDuration: + type: integer + minimum: 1 + maximum: 8640000 + +# +# ENUMS +# + +ExternalClientType: + anyOf: + - type: string + enum: + - EMERGENCY_SERVICES + - VALUE_ADDED_SERVICES + - PLMN_OPERATOR_SERVICES + - LAWFUL_INTERCEPT_SERVICES + - PLMN_OPERATOR_BROADCAST_SERVICES + - PLMN_OPERATOR_OM + - PLMN_OPERATOR_ANONYMOUS_STATISTICS + - PLMN_OPERATOR_TARGET_MS_SERVICE_SUPPORT + - type: string +SupportedGADShapes: + anyOf: + - type: string + enum: + - POINT + - POINT_UNCERTAINTY_CIRCLE + - POINT_UNCERTAINTY_ELLIPSE + - POLYGON + - POINT_ALTITUDE + - POINT_ALTITUDE_UNCERTAINTY + - ELLIPSOID_ARC + - type: string +ResponseTime: + anyOf: + - type: string + enum: + - LOW_DELAY + - DELAY_TOLERANT + - NO_DELAY + - type: string +PositioningMethod: + anyOf: + - type: string + enum: + - CELLID + - ECID + - OTDOA + - BAROMETRIC_PRESSURE + - WLAN + - BLUETOOTH + - MBS + - MOTION_SENSOR + - DL_TDOA + - DL_AOD + - MULTI-RTT + - NR_ECID + - UL_TDOA + - UL_AOA + - NETWORK_SPECIFIC + - type: string +PositioningMode: + anyOf: + - type: string + enum: + - UE_BASED + - UE_ASSISTED + - CONVENTIONAL + - type: string +``` + +GnssId: +anyOf: +- type: string +enum: +- GPS +- GALILEO +- SBAS +- MODERNIZED\_GPS +- QZSS +- GLONASS +- BDS +- NAVIC +- type: string +Usage: +anyOf: +- type: string +enum: +- UNSUCCESS +- SUCCESS\_RESULTS\_NOT\_USED +- SUCCESS\_RESULTS\_USED\_TO\_VERIFY\_LOCATION +- SUCCESS\_RESULTS\_USED\_TO\_GENERATE\_LOCATION +- SUCCESS\_METHOD\_NOT\_DETERMINED +- type: string +LcsPriority: +anyOf: +- type: string +enum: +- HIGHEST\_PRIORITY +- NORMAL\_PRIORITY +- type: string +VelocityRequested: +anyOf: +- type: string +enum: +- VELOCITY\_IS\_NOT\_REQUESTED +- VELOCITY\_IS\_REQUESTED +- type: string +AccuracyFulfilmentIndicator: +anyOf: +- type: string +enum: +- REQUESTED\_ACCURACY\_FULFILLED +- REQUESTED\_ACCURACY\_NOT\_FULFILLED +- type: string +VerticalDirection: +type: string +enum: +- UPWARD +- DOWNWARD +LdrType: +anyOf: +- type: string +enum: +- UE\_AVAILABLE +- PERIODIC +- ENTERING\_INTO\_AREA +- LEAVING\_FROM\_AREA +- BEING\_INSIDE\_AREA +- MOTION +- type: string +ReportingAreaType: +anyOf: +- type: string +enum: +- EPS\_TRACKING\_AREA\_IDENTITY +- E-UTRAN\_CELL\_GLOBAL\_IDENTIFICATION +- 5GS\_TRACKING\_AREA\_IDENTITY +- NR\_CELL\_GLOBAL\_IDENTITY +- type: string +OccurrenceInfo: +anyOf: +- type: string +enum: +- ONE\_TIME\_EVENT +- MULTIPLE\_TIME\_EVENT +- type: string +ReportingAccessType: +anyOf: + +``` +- type: string +enum: +- NR +- EUTRA_CONNECTED_TO_5GC +- NON_3GPP_CONNECTED_TO_5GC +- type: string +EventClass: +anyOf: +- type: string +enum: +- SUPPLEMENTARY_SERVICES +- type: string +ReportedEventType: +anyOf: +- type: string +enum: +- PERIODIC_EVENT +- ENTERING_AREA_EVENT +- LEAVING_AREA_EVENT +- BEING_INSIDE_AREA_EVENT +- MOTION_EVENT +- MAXIMUM_INTERVAL_EXPIRATION_EVENT +- LOCATION_CANCELLATION_EVENT +- type: string +TerminationCause: +anyOf: +- type: string +enum: +- TERMINATION_BY_UE +- TERMINATION_BY_NETWORK +- NORMAL_TERMINATION +- type: string +LcsQosClass: +anyOf: +- type: string +enum: +- BEST_EFFORT +- ASSURED +- type: string + +UeLocationServiceInd: +anyOf: +- type: string +enum: +- LOCATION_ESTIMATE +- LOCATION_ASSISTANCE_DATA +- type: string +``` + +## A.3 NImf\_Broadcast API + +openapi: 3.0.0 + +``` +info: + version: '1.0.3' + title: 'LMF Broadcast' + description: | + LMF Broadcast Service. + © 2021, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.572 V16.8.0; 5G System; Location Management Services; Stage 3 + url: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.572/' + +servers: +- url: '{apiRoot}/nImf-broadcast/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +paths: +/cipher-key-data: + post: + summary: Request ciphering key data +``` + +``` +operationId: CipheringKeyData +tags: + - Request Ciphering Key Data +requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Cipher requestData' + required: true +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/CipherResponseData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +callbacks: + CipheringKeyData: + '{$request.body#/amfCallBackURI}': + post: + requestBody: + description: Ciphering Key Data Notification + content: + application/json: + schema: + $ref: '#/components/schemas/CipheringKeyInfo' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/CipheringKeyResponse' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + schemas: +# +# COMPLEX TYPES +# + CipheringKeyInfo: + type: object + required: + - cipheringData + properties: + cipheringData: + type: array + items: + $ref: '#/components/schemas/CipheringDataSet' + minItems: 1 + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + CipheringKeyResponse: + type: object + properties: + cipheringDataReport: + type: array + items: + $ref: '#/components/schemas/CipheringSetReport' + minItems: 1 + CipheringDataSet: + type: object + required: + - cipheringSetID + - cipheringKey + - c0 + - validityStartTime + - validityDuration + properties: + cipheringSetID: + $ref: '#/components/schemas/CipheringSetID' + cipheringKey: + $ref: '#/components/schemas/CipheringKey' + c0: + $ref: '#/components/schemas/C0' + ltePosSibTypes: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + nrPosSibTypes: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + validityStartTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + validityDuration: + $ref: '#/components/schemas/ValidityDuration' + tailList: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + CipheringSetReport: + type: object + required: + - cipheringSetID + - storageOutcome + properties: + cipheringSetID: + $ref: '#/components/schemas/CipheringSetID' + storageOutcome: + $ref: '#/components/schemas/StorageOutcome' + Cipher requestData: + type: object + required: + - amfCallBackURI + properties: + amfCallBackURI: +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + CipherResponseData: + type: object + required: + - dataAvailability + properties: + dataAvailability: + $ref: '#/components/schemas/DataAvailability' + +# +# +# SIMPLE TYPES +# + + CipheringSetID: + type: integer + minimum: 0 + maximum: 65535 + CipheringKey: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + C0: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + ValidityDuration: + type: integer + minimum: 1 + maximum: 65535 + +# +# ENUMS +# + + StorageOutcome: + anyOf: + - type: string + enum: + - STORAGE_SUCCESSFUL + - STORAGE_FAILED + DataAvailability: + anyOf: + - type: string + enum: + - CIPHERING_KEY_DATA_AVAILABLE + - CIPHERING_KEY_DATA_NOT_AVAILABLE +``` + +# Annex B (informative): Change history + +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +|---------|---------|-----------|------|-----|-----|----------------------------------------------------------------------------------------------------------------------------------|-------------| +| 2018-01 | CT4#82 | | | | | TS Skeleton agreed in CT4#82 | 0.0.0 | +| 2018-01 | CT4#82 | C4-181398 | | | | Initial draft (C4-181119)
Incorporation of agreed pCRs from CT4#82: C4-181121, C4-181233, C4-181234 | 0.1.0 | +| 2018-03 | CT4#83 | C4-182444 | | | | Incorporation of agreed pCRs from CT4#83: C4-182181, C4-182427 | 0.2.0 | +| 2018-03 | CT#79 | CP-180034 | | | | Presented for information | 1.0.0 | +| 2018-04 | CT4#84 | C4-183524 | | | | Incorporation of agreed pCRs from CT4#84: C4-183184, C4-183363, C4-183510 | 1.1.0 | +| 2018-05 | CT4#85 | C4-184640 | | | | Incorporation of agreed pCRs from CT4#85: C4-184195, C4-184197, C4-184198, C4-184199, C4-184202, C4-184443, C4-184446, C4-184547 | 1.2.0 | +| 2018-06 | CT#80 | CP-181111 | | | | Presented for approval | 2.0.0 | +| 2018-06 | CT#80 | | | | | Approved in CT#80 | 15.0.0 | +| 2018-09 | CT#81 | CP-182066 | 0002 | 2 | | Error Cases | 15.1.0 | +| 2018-09 | CT#81 | CP-182066 | 0003 | - | | Custom Headers | 15.1.0 | +| 2018-09 | CT#81 | CP-182066 | 0004 | - | | Overall Clean-up | 15.1.0 | +| 2018-09 | CT#81 | CP-182066 | 0005 | - | | Description of Structured data types | 15.1.0 | +| 2018-09 | CT#81 | CP-182066 | 0006 | 1 | | Resource structure presentation | 15.1.0 | +| 2018-09 | CT#81 | CP-182066 | 0007 | 1 | | LMF servers clause in OpenAPI | 15.1.0 | +| 2018-09 | CT#81 | CP-182066 | 0008 | - | | API Version Update | 15.1.0 | +| 2018-12 | CT#82 | CP-183025 | 0010 | 1 | F | Cardinality | 15.2.0 | +| 2018-12 | CT#82 | CP-183025 | 0011 | - | F | APIRoot Clarification | 15.2.0 | +| 2018-12 | CT#82 | CP-183025 | 0012 | - | F | AMF Id | 15.2.0 | +| 2018-12 | CT#82 | CP-183025 | 0013 | - | F | Barometric Pressure in Location Data | 15.2.0 | +| 2018-12 | CT#82 | CP-183025 | 0014 | 1 | F | Clarify Serving Cell in Input Data | 15.2.0 | +| 2018-12 | CT#82 | CP-183025 | 0015 | 1 | F | Oauth2 Corrections | 15.2.0 | +| 2018-12 | CT#82 | CP-183025 | 0016 | - | F | API Version | 15.2.0 | +| 2018-12 | CT#82 | CP-183179 | 0017 | - | F | ExternalDocs Update | 15.2.0 | +| 2019-03 | CT#83 | CP-190030 | 0018 | 1 | F | OpenAPI Corrections | 15.3.0 | +| 2019-03 | CT#83 | CP-190030 | 0019 | 1 | F | Application Errors | 15.3.0 | +| 2019-03 | CT#83 | CP-190030 | 0020 | 1 | F | Essential Correction to InnerRadius | 15.3.0 | +| 2019-03 | CT#83 | CP-190030 | 0021 | 1 | F | Mandatory Response Codes | 15.3.0 | +| 2019-03 | CT#83 | CP-190030 | 0022 | 1 | F | Essential correction to OpenAPI definition of GeographicArea | 15.3.0 | +| 2019-03 | CT#83 | CP-190030 | 0023 | - | F | API version update | 15.3.0 | +| 2019-06 | CT#84 | CP-191042 | 0024 | 2 | F | UE Capabilities | 15.4.0 | +| 2019-06 | CT#84 | CP-191042 | 0025 | 2 | F | Storage of OpenAPI specification files | 15.4.0 | +| 2019-06 | CT#84 | CP-191042 | 0027 | 1 | F | Copyright Note in OpenAPI Spec | 15.4.0 | +| 2019-06 | CT#84 | CP-191042 | 0028 | 1 | F | Major API version | 15.4.0 | +| 2019-06 | CT#84 | CP-191042 | 0030 | - | F | Open API Version | 15.4.0 | +| 2019-09 | CT#85 | CP-192113 | 0031 | 1 | F | Missing attribute FLR in Civic Address | 16.0.0 | +| 2019-09 | CT#85 | CP-192192 | 0033 | 2 | B | LMF service operations for a deferred 5GC-MT-LR | 16.0.0 | +| 2019-09 | CT#85 | CP-192192 | 0034 | 1 | B | LMF service operations for a commercial 5GC-MT-LR | 16.0.0 | +| 2019-09 | CT#85 | CP-192192 | 0035 | - | F | High Accuracy Support | 16.0.0 | +| 2019-09 | CT#85 | CP-192113 | 0037 | 1 | D | Correct type Polygon | 16.0.0 | +| 2019-09 | CT#85 | CP-192120 | 0039 | - | F | 3GPP TS 29.572 API version update | 16.0.0 | +| 2019-12 | CT#86 | CP-193033 | 0041 | 1 | A | Motion Sensor Position Method | 16.1.0 | +| 2019-12 | CT#86 | CP-193165 | 0042 | 3 | B | Addition of the LMF Broadcast Service Operations | 16.1.0 | +| 2019-12 | CT#86 | CP-193055 | 0043 | 1 | B | LCS QoS Class | 16.1.0 | +| 2019-12 | CT#86 | CP-193036 | 0045 | 1 | F | ExternalDoc Clause | 16.1.0 | +| 2019-12 | CT#86 | CP-193036 | 0046 | 1 | F | ProblemDetails Optional in Error Response | 16.1.0 | +| 2019-12 | CT#86 | CP-193044 | 0048 | - | F | 3GPP TS 29.572 API version update | 16.1.0 | +| 2020-03 | CT#87 | CP-200039 | 0049 | 2 | F | Add Corresponding API descriptions in clause 5.1 | 16.2.0 | +| 2020-03 | CT#87 | CP-200039 | 0050 | 2 | D | Editorial corrections | 16.2.0 | +| 2020-03 | CT#87 | CP-200039 | 0051 | 1 | F | Correction - formatting consistency | 16.2.0 | +| 2020-03 | CT#87 | CP-200018 | 0052 | - | B | Connectivity state per access type | 16.2.0 | +| 2020-03 | CT#87 | CP-200018 | 0053 | - | B | Primary Cell in the Secondary RAN node | 16.2.0 | +| 2020-03 | CT#87 | CP-200052 | 0055 | - | F | 3GPP TS 29.572 Rel16 API External doc update | 16.2.0 | +| 2020-03 | CT#87 | CP-200180 | 0054 | 4 | B | Request Type and embedded LPP message | 16.2.0 | +| 2020-06 | CT#88e | CP-201060 | 0056 | 1 | F | Add a new Notifications Overview Table | 16.3.0 | +| 2020-06 | CT#88e | CP-201060 | 0057 | 1 | F | Add custom operation Name | 16.3.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|------------------------------------------------------------------------------|--------| +| 2020-06 | CT#88e | CP-201032 | 0058 | | F | Location Context Transfer | 16.3.0 | +| 2020-06 | CT#88e | CP-201032 | 0059 | 1 | B | Network Specific Positioning Methods | 16.3.0 | +| 2020-06 | CT#88e | CP-201032 | 0060 | | B | Positioning Methods Support | 16.3.0 | +| 2020-06 | CT#88e | CP-201032 | 0061 | 2 | F | Storage of YAML files in ETSI Forge | 16.3.0 | +| 2020-06 | CT#88e | CP-201032 | 0062 | 1 | F | Resolve Editor Notes | 16.3.0 | +| 2020-06 | CT#88e | CP-201032 | 0063 | 1 | F | LDRreference | 16.3.0 | +| 2020-06 | CT#88e | CP-201032 | 0065 | 1 | F | Resolution of EN on NR positioning SIBs | 16.3.0 | +| 2020-06 | CT#88e | CP-201032 | 0068 | 1 | F | Adding ResponseTime enumeration value | 16.3.0 | +| 2020-06 | CT#88e | CP-201060 | 0069 | | F | Missing Descriptions | 16.3.0 | +| 2020-06 | CT#88e | CP-201073 | 0070 | | F | 29.572 Rel-16 API version and External doc update | 16.3.0 | +| 2020-09 | CT#89e | CP-202112 | 0071 | 1 | F | Optionality of ProblemDetails in TS29.572 cleanup | 16.4.0 | +| 2020-09 | CT#89e | CP-202112 | 0073 | 1 | F | Adding missing navigation satellite systems for positioning | 16.4.0 | +| 2020-09 | CT#89e | CP-202112 | 0074 | 1 | F | Including VGMLC address towards LMF when requesting LMF's Location service | 16.4.0 | +| 2020-09 | CT#89e | CP-202112 | 0075 | 1 | F | Corrections on EventNotify service operation | 16.4.0 | +| 2020-09 | CT#89e | CP-202043 | 0077 | 1 | F | Correct mismatch on GeographicArea between table and yaml | 16.4.0 | +| 2020-09 | CT#89e | CP-202096 | 0078 | - | F | 29.572 Rel-16 API version and External doc update | 16.4.0 | +| 2020-12 | CT#90e | CP-203050 | 0080 | 1 | F | Essential corrections in clause 5.2.2.4 CancelLocation | 16.5.0 | +| 2020-12 | CT#90e | CP-203050 | 0081 | 1 | F | Indication of control plane CIoT 5GS optimization in LocationContextTransfer | 16.5.0 | +| 2020-12 | CT#90e | CP-203035 | 0082 | 1 | F | YAML files in 3GPP Forge | 16.5.0 | +| 2020-12 | CT#90e | CP-203036 | 0085 | 1 | F | 29.572 Rel-16 API version and External doc update | 16.5.0 | +| 2021-03 | CT#91e | CP-210041 | 0087 | - | F | Missing PIDL-LO elements in Location Information | 16.6.0 | +| 2021-03 | CT#91e | CP-210037 | 0088 | 1 | F | HTTP 3xx redirection | 16.6.0 | +| 2021-03 | CT#91e | CP-210054 | 0091 | - | F | 29.572 Rel-16 API version and External doc update | 16.6.0 | +| 2021-06 | CT#92e | CP-210059 | 0097 | | F | 3xx description correction for SCP | 16.7.0 | +| 2021-06 | CT#92e | CP-210059 | 0101 | 1 | F | Redirect Response | 16.7.0 | +| 2021-06 | CT#92e | CP-210073 | 0104 | | F | 29.572 Rel-16 API version and External doc update | 16.7.0 | +| 2021-09 | CT#93e | CP-212064 | 0110 | | F | Encoding of binary attributes in JSON objects | 16.8.0 | +| 2021-09 | CT#93e | CP-212080 | 0116 | | F | 29.572 Rel-16 API version and External doc update | 16.8.0 | +| 2022-03 | CT#95e | CP-220226 | 0129 | 1 | F | Corrections on attributes | 16.9.0 | +| 2022-03 | CT#95e | CP-220216 | 0132 | | F | 29.572 Rel-16 API version and External doc update | 16.9.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29591/16c1175b5f05a4b55e6d396fc51b15b3_img.jpg b/marked/Rel-16/29_series/29591/16c1175b5f05a4b55e6d396fc51b15b3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ff1ef85fd78d789ab06d336c266d0ea0a42a29ec --- /dev/null +++ b/marked/Rel-16/29_series/29591/16c1175b5f05a4b55e6d396fc51b15b3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:38f0c710dd0b33febd87fd806db656b617cac896efb2f2a75f1ded1b8baa84ba +size 33369 diff --git a/marked/Rel-16/29_series/29591/2a0f333f04f8e672bebf288c511c1db5_img.jpg b/marked/Rel-16/29_series/29591/2a0f333f04f8e672bebf288c511c1db5_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a414a9cb85279547032f128ab94be5494bb2f65c --- /dev/null +++ b/marked/Rel-16/29_series/29591/2a0f333f04f8e672bebf288c511c1db5_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:08f58bb297d00e836dde0122307b1f6163b20d6c7c0cdecab132cd496bb6850c +size 13355 diff --git a/marked/Rel-16/29_series/29591/33a8f3f01dfa8bce75d23017855a13c5_img.jpg b/marked/Rel-16/29_series/29591/33a8f3f01dfa8bce75d23017855a13c5_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..99f77a4a7eab6557155d62a665e1b4ba3a66f946 --- /dev/null +++ b/marked/Rel-16/29_series/29591/33a8f3f01dfa8bce75d23017855a13c5_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:313a186dac291bd5d48a2631655b9fdf65927d2ae7b140aacae37d3d292b3bc1 +size 20907 diff --git a/marked/Rel-16/29_series/29591/7efae06af3af43ffe5d4b956a679cf54_img.jpg b/marked/Rel-16/29_series/29591/7efae06af3af43ffe5d4b956a679cf54_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..77b706112ec89dc452bde6e1df30c510e8f562bb --- /dev/null +++ b/marked/Rel-16/29_series/29591/7efae06af3af43ffe5d4b956a679cf54_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f6b426c8d1ae40eccdfbae8206558bc495e9f705940fe24abe78212fea9e348c +size 30928 diff --git a/marked/Rel-16/29_series/29591/ca7c7526ec57cd5a2f278c194c0a6a00_img.jpg b/marked/Rel-16/29_series/29591/ca7c7526ec57cd5a2f278c194c0a6a00_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c9530c584e1b09553b37e02fa6abf27cec79527a --- /dev/null +++ b/marked/Rel-16/29_series/29591/ca7c7526ec57cd5a2f278c194c0a6a00_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a3e65186415ad9810eced5d87612c5c11b770f48ad36b8f12e10e2ca185651f7 +size 30867 diff --git a/marked/Rel-16/29_series/29591/e6df2733626a85205c1db682e6259c46_img.jpg b/marked/Rel-16/29_series/29591/e6df2733626a85205c1db682e6259c46_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..59e734ef89ffb3a567aabe35d443b0b3ca9ae427 --- /dev/null +++ b/marked/Rel-16/29_series/29591/e6df2733626a85205c1db682e6259c46_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6fd5afc42bf622c58afb71e8562a6d006082e89ffc30d8e614189044fc0d176d +size 6720 diff --git a/marked/Rel-16/29_series/29591/ff0952ef692c9d960ce5f6708bcc9711_img.jpg b/marked/Rel-16/29_series/29591/ff0952ef692c9d960ce5f6708bcc9711_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0c360241f60a6e2013b89ced611eefcca609d1e0 --- /dev/null +++ b/marked/Rel-16/29_series/29591/ff0952ef692c9d960ce5f6708bcc9711_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5dc475fb688f19c3f7533c92fb73788475cc08a9cb2c14afb46ffa019ba1b790 +size 35893 diff --git a/marked/Rel-16/29_series/29591/raw.md b/marked/Rel-16/29_series/29591/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..562e3f2f14e204c819c0e884fbe12cddc0402f79 --- /dev/null +++ b/marked/Rel-16/29_series/29591/raw.md @@ -0,0 +1,1694 @@ + + + + +# ***Copyright Notification*** + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTSTM is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|------------------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions, symbols and abbreviations..... | 8 | +| 3.1 Definitions..... | 8 | +| 3.2 Symbols..... | 8 | +| 3.3 Abbreviations ..... | 8 | +| 4 Services offered by the NEF ..... | 8 | +| 4.1 Introduction ..... | 8 | +| 4.2 Nnef_EventExposure Service ..... | 9 | +| 4.2.1 Service Description ..... | 9 | +| 4.2.1.1 Overview..... | 9 | +| 4.2.1.2 Service Architecture ..... | 9 | +| 4.2.1.3 Network Functions..... | 10 | +| 4.2.1.3.1 Network Exposure Function (NEF) ..... | 10 | +| 4.2.1.3.2 NF Service Consumers..... | 10 | +| 4.2.2 Service Operations..... | 10 | +| 4.2.2.1 Introduction..... | 10 | +| 4.2.2.2 Nnef_EventExposure_Subscribe service operation..... | 11 | +| 4.2.2.2.1 General ..... | 11 | +| 4.2.2.2.2 Creating a new subscription ..... | 11 | +| 4.2.2.2.3 Modifying an existing subscription..... | 12 | +| 4.2.2.3 Nnef_EventExposure_Unsubscribe service operation..... | 13 | +| 4.2.2.3.1 General ..... | 13 | +| 4.2.2.3.2 Unsubscription from event notifications ..... | 14 | +| 4.2.2.4 Nnef_EventExposure_Notify service operation ..... | 14 | +| 4.2.2.4.1 General ..... | 14 | +| 4.2.2.4.2 Notification about subscribed events ..... | 14 | +| 5 API Definitions ..... | 16 | +| 5.1 Nnef_EventExposure Service API ..... | 16 | +| 5.1.1 Introduction ..... | 16 | +| 5.1.2 Usage of HTTP..... | 16 | +| 5.1.2.1 General..... | 16 | +| 5.1.2.2 HTTP standard headers..... | 16 | +| 5.1.2.2.1 General ..... | 16 | +| 5.1.2.2.2 Content type ..... | 16 | +| 5.1.2.3 HTTP custom headers..... | 16 | +| 5.1.3 Resources..... | 17 | +| 5.1.3.1 Overview..... | 17 | +| 5.1.3.2 Resource: Network Exposure Event Subscriptions ..... | 17 | +| 5.1.3.2.1 Description ..... | 17 | +| 5.1.3.2.2 Resource Definiton..... | 17 | +| 5.1.3.2.3 Resource Standard Methods..... | 18 | +| 5.1.3.2.3.1 POST ..... | 18 | +| 5.1.3.3 Resource: Individual Network Exposure Event Subscription ..... | 18 | +| 5.1.3.3.1 Description ..... | 18 | +| 5.1.3.3.2 Resource Definiton..... | 18 | +| 5.1.3.3.3 Resource Standard Methods..... | 19 | +| 5.1.3.3.3.1 GET ..... | 19 | +| 5.1.3.3.3.2 PUT..... | 19 | +| 5.1.3.3.3.3 DELETE ..... | 20 | +| 5.1.4 Custom Operations without associated resources ..... | 21 | +| 5.1.5 Notifications ..... | 21 | +| 5.1.5.1 General..... | 21 | +| 5.1.5.2 Network Exposure Event Notification..... | 22 | +| 5.1.5.2.1 Description ..... | 22 | + +5.1.5.2.2 Target URI..... 22 + +5.1.5.2.3 Standard Methods..... 22 + +5.1.5.2.3.1 POST ..... 22 + +5.1.6 Data Model ..... 23 + +5.1.6.1 General..... 23 + +5.1.6.2 Structured data types..... 24 + +5.1.6.2.1 Introduction ..... 24 + +5.1.6.2.2 Type: NefEventExposureSubsc..... 24 + +5.1.6.2.3 Type: NefEventExposureNotif..... 25 + +5.1.6.2.4 Type: NefEventNotification..... 25 + +5.1.6.2.5 Type NefEventSubs..... 25 + +5.1.6.2.6 Type UeCommunicationInfo..... 26 + +5.1.6.2.7 Type NefEventFilter..... 26 + +5.1.6.2.8 Type TargetUeIdentification ..... 26 + +5.1.6.2.9 Type: ServiceExperienceInfo..... 27 + +5.1.6.2.10 Type: UeMobilityInfo ..... 27 + +5.1.6.2.11 Type: UeTrajectoryInfo..... 27 + +5.1.6.3 Simple data types and enumerations..... 27 + +5.1.6.3.1 Introduction ..... 27 + +5.1.6.3.2 Simple data types ..... 27 + +5.1.6.3.3 Enumeration: NefEvent..... 27 + +5.1.7 Error Handling ..... 28 + +5.1.7.1 General..... 28 + +5.1.7.2 Protocol Errors ..... 28 + +5.1.7.3 Application Errors..... 28 + +5.1.8 Feature negotiation ..... 28 + +5.1.9 Security..... 28 + +**Annex A (normative): OpenAPI specification ..... 30** + +A.1 General..... 30 + +A.2 Nnef\_EventExposure API..... 30 + +Annex B (informative): Change history..... 37 + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, certain modal verbs have the following meanings: + +**shall** indicates a mandatory requirement to do something + +**shall not** indicates an interdiction (prohibition) to do something + +NOTE 1: The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +NOTE 2: The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +**should** indicates a recommendation to do something + +**should not** indicates a recommendation not to do something + +**may** indicates permission to do something + +**need not** indicates permission not to do something + +NOTE 3: The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +**can** indicates that something is possible + +**cannot** indicates that something is impossible + +NOTE 4: The constructions "can" and "cannot" shall not to be used as substitutes for "may" and "need not". + +**will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document + +**will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document + +**might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +NOTE 5: The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document specifies the stage 3 protocol and data model for the Nnef southbound Service Based Interface. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the Network Exposure Function (NEF). + +The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2], 3GPP TS 23.502 [3] and 3GPP TS 23.288 [14]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] OpenAPI: "OpenAPI 3.0.0 Specification", . +- [7] 3GPP TR 21.900: "Technical Specification Group working methods". +- [8] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [9] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [10] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". +- [11] IETF RFC 7540: "Hypertext Transfer Protocol Version 2 (HTTP/2)". +- [12] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [13] IETF RFC 7807: "Problem Details for HTTP APIs". +- [14] 3GPP TS 23.288: "Architecture enhancements for 5G System (5GS) to support network data analytics services". +- [15] 3GPP TS 29.522: "5G System; Network Exposure Function Northbound APIs; Stage 3". +- [16] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". +- [17] 3GPP TS 29.520: "5G System; Network Data Analytics Services; Stage 3". +- [18] 3GPP TS 29.517: "5G System; Application Function Event Exposure Service; Stage 3". +- [19] 3GPP TS 29.551: "5G System; Packet Flow Description Management Service; Stage 3". + +- [20] 3GPP TS 29.541: "5G System; Network Exposure (NE) function services for Non-IP Data Delivery (NIDD); Stage 3". +- [21] 3GPP TS 29.554: "5G System; Background Data Transfer Policy Control Service; Stage 3". +- [22] 3GPP TS 29.523: "5G System; Policy Control Event Exposure Service; Stage 3". +- + +# 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +## 3.2 Symbols + +For the purposes of the present document, the following symbols apply: + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|-------|-----------------------------------| +| API | Application Programming Interface | +| NEF | Network Exposure Function | +| NF | Network Function | +| NWDAF | Network Data Analytics Function | +| SUPI | Subscription Permanent Identifier | +| URI | Uniform Resource Identifier | + +--- + +# 4 Services offered by the NEF + +## 4.1 Introduction + +The NEF offers to other NFs the following southbound services: + +- Nnef\_EventExposure +- Nnef\_PFDManagement +- Nnef\_SMContext + +NOTE 1: The northbound services offered by the NEF are defined in 3GPP TS 29.522 [15], e.g. the northbound requirement of Nnef\_EventExposure service. + +NOTE 2: The services offered by the NEF (e.g. Nnef\_EventExposure service) as specified in the present specification are only applicable for Nnef southbound services. + +NOTE 3: The Nnef\_PFDManagement service offered by the NEF southbound is defined in 3GPP TS 29.551 [19]. + +NOTE 4: The Nnef\_SMContext service offered by the NEF southbound is defined in 3GPP TS 29.541 [20]. + +## 4.2 Nnef\_EventExposure Service + +### 4.2.1 Service Description + +#### 4.2.1.1 Overview + +The Nnef\_EventExposure service, as defined in 3GPP TS 23.502 [3], is provided by the Network Exposure Function (NEF). + +This service: + +- allows NF service consumers to subscribe, modify and unsubscribe for application events; and +- notifies NF service consumers with a corresponding subscription about observed events on the NEF. + +The types of observed events applicable for NEF include: + +- Service experience; +- UE mobility; +- UE communication; and +- Exceptions. + +The target of the event reporting may include one or more UE(s), a group of UEs or any UE (i.e. all UEs). When an event to which the NF service consumer has subscribed occurs, the NEF reports the requested information to the NF service consumer based on the event reporting information definition requested by the NF service consumer. + +#### 4.2.1.2 Service Architecture + +The 5G System Architecture is defined in 3GPP TS 23.501 [2]. The Network Data Analytics Exposure architecture is defined in 3GPP TS 23.288 [14]. + +The Nnef\_EventExposure service is part of the Nnef service-based interface exhibited by the Network Exposure Function (NEF). + +Known consumers of the Nnef\_EventExposure service are: + +- Network Data Analytics Function (NWDAF) + +![Reference Architecture for the Nnef_EventExposure Service; SBI representation diagram](2a0f333f04f8e672bebf288c511c1db5_img.jpg) + +The diagram illustrates the service-based interface (SBI) representation for the Nnef\_EventExposure service. At the top, a rectangular box labeled 'NEF' contains an oval labeled 'Nnef', representing the Network Exposure Function. At the bottom, a rectangular box is labeled 'NWDAF', representing the Network Data Analytics Function. A vertical line connects the 'Nnef' oval to the 'NWDAF' box, and this line is labeled 'Nnef\_EventExposure', indicating the specific service interface. + +Reference Architecture for the Nnef\_EventExposure Service; SBI representation diagram + +**Figure 4.2.1.2-1: Reference Architecture for the Nnef\_EventExposure Service; SBI representation** + +![Reference Architecture for the Nnef_EventExposure Service: reference point representation. The diagram shows a box labeled 'NEF' connected by a vertical line to a box labeled 'NWDAF'. There is a small horizontal tick mark on the vertical line between the two boxes.](e6df2733626a85205c1db682e6259c46_img.jpg) + +``` + +graph TD + NEF[NEF] --- NWDAF[NWDAF] + +``` + +Reference Architecture for the Nnef\_EventExposure Service: reference point representation. The diagram shows a box labeled 'NEF' connected by a vertical line to a box labeled 'NWDAF'. There is a small horizontal tick mark on the vertical line between the two boxes. + +**Figure 4.2.1.2-2: Reference Architecture for the Nnef\_EventExposure Service: reference point representation** + +#### 4.2.1.3 Network Functions + +##### 4.2.1.3.1 Network Exposure Function (NEF) + +The Network Exposure Function (NEF) is a functional element that provides application or user related information to the NF service consumers as defined in this specification. + +The NEF allows the NF consumer(s) to (un)subscribe to notifications of monitoring observed event, and sends the notification to the NF consumer(s) when a subscribed event is detected. + +##### 4.2.1.3.2 NF Service Consumers + +The known NF service consumers are as follows: + +The Network Data Analytics Function (NWDAF): + +- supports (un)subscribing to notifications of subscribed event(s) from the NEF; +- supports receiving the notifications of subscribed event(s) from the NEF. + +### 4.2.2 Service Operations + +#### 4.2.2.1 Introduction + +Service operations defined for the Nnef\_EventExposure Service are shown in table 4.2.2.1-1. + +**Table 4.2.2.1-1: Nnef\_EventExposure Service Operations** + +| Service Operation Name | Description | Initiated by | +|--------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------| +| Nnef_EventExposure_Subscribe | This service operation is used by an NF service consumer to subscribe to, or modify a subscription in the NEF for event notifications on a specified application or user related event. | NF service consumer | +| Nnef_EventExposure_Unsubscribe | This service operation is used by an NF service consumer to unsubscribe from event notifications. | NF service consumer | +| Nnef_EventExposure_Notify | This service operation is used by the NEF to report application or user related event(s) to the NF service consumer which has subscribed to the event report service. | NEF | + +#### 4.2.2.2 Nnef\_EventExposure\_Subscribe service operation + +##### 4.2.2.2.1 General + +This service operation is used by an NF service consumer to subscribe to notifications on specified event(s) or modify an existing subscription. + +The following are the types of events for which a subscription to notifications can be created: + +- Service experience; +- UE mobility; +- UE communication; and +- Exceptions; + +The following procedures using the Nnef\_EventExposure\_Subscribe service operation are supported: + +- creating a new subscription; +- modifying an existing subscription. + +##### 4.2.2.2.2 Creating a new subscription + +Figure 4.2.2.2.2-1 illustrates the creation of a Network Exposure Event Subscription. + +![Sequence diagram showing the creation of a subscription. An NF service consumer sends a POST request to the NEF, and the NEF responds with a 201 Created status.](ca7c7526ec57cd5a2f278c194c0a6a00_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant NEF + Note right of NF service consumer: 1. POST .../subscriptions + NF service consumer->>NEF: Request + Note left of NEF: 2. "201 Created" + NEF-->>NF service consumer: Response +``` + +Sequence diagram showing the creation of a subscription. An NF service consumer sends a POST request to the NEF, and the NEF responds with a 201 Created status. + +**Figure 4.2.2.2.2-1: Creation of a subscription** + +To subscribe to event notifications, the NF service consumer shall send an HTTP POST request to the NEF with: "{apiRoot}/nnef-eventexposure//subscriptions" as request URI as shown in step 1 of figure 4.2.2.2.2-1, and the "NefEventExposureSubsc" data structure as request body. + +The "NefEventExposureSubsc" data structure shall include: + +- a URI where to receive the requested notifications as "notifUri" attribute; and +- a Notification Correlation Identifier assigned by the NF service consumer for the requested notifications as "notifId" attribute. +- description of subscribed event information as "eventsSubs" attribute by using one or more "NefEventSubs" data. + +The "NefEventExposureSubsc" data structure may also include: + +- the description of the event reporting information as "eventsRepInfo" attribute. + +The "NefEventSubs" data structure shall include: + +- an event to subscribe to as a "event" attribute; and + +- event filter information as "eventFilter" attribute associated with the event. + +The "eventsRepInfo" attribute may include: + +- event notification method (periodic, one time, on event detection) as "notifMethod" attribute; +- Maximum Number of Reports as "maxReportNbr" attribute; +- Monitoring Duration as "monDur" attribute; +- repetition period for periodic reporting as "repPeriod" attribute; +- immediate reporting indication as "immRep" attribute; +- sampling ratio as "sampRatio" attribute; and/or +- group reporting guard time as "grpRepTime" attribute. + +If the NEF cannot successfully fulfil the received HTTP POST request due to an internal error or an error in the HTTP POST request, the NEF shall send an HTTP error response as specified in clause 5.1.7. + +Upon successful reception of an HTTP POST request with "{apiRoot}/nnef-eventexposure//subscriptions" as request URI and "NefEventExposureSubsc" data structure as request body, the NEF shall create a new "Individual Event Exposure Subscription" resource, store the subscription and send an HTTP "201 Created" response, as shown in step 2 of figure 4.2.2.2-1. The NEF shall include in the "201 Created" response: + +- a Location header field; and +- an "NefEventExposureSubsc" data type in the payload body. + +The Location header field shall contain the URI of the created individual application session context resource i.e. "{apiRoot}/nnef-eventexposure//subscriptions/{subscriptionId}". + +The "NefEventExposureSubsc" data type payload body shall contain the representation of the created "Individual Network Exposure Event Subscription". + +When the "monDur" attribute is included in the response by the NEF, it represents NEF selected expiry time that is equal or less than the expiry time received in the request. + +When the "immRep" attribute is included and sets to "true" in the subscription and the subscribed events are available, the NEF shall include the reports of the events subscribed, if available, in the HTTP POST response. + +When the sampling ratio attribute, as "sampRatio", is included in the subscription, the NEF shall select a random subset of UEs among the target UEs according to the sampling ratio and only report the event(s) related to the selected subset of UEs. + +When the group reporting guard time, as "grpRepTime" attribute, is included in the subscription, the NEF shall accumulate all the event reports for the target UEs until the group reporting guard time expires. Then, the NEF shall notify the NF service consumer using the Nnef\_EventExposure\_Notify service operation, as described in clause 4.2.2.4. + +##### 4.2.2.2.3 Modifying an existing subscription + +Figure 4.2.2.2.3-1 illustrates the modification of an existing subscription. + +![Sequence diagram showing the modification of an existing subscription. An NF service consumer sends a PUT request to the NEF. The NEF responds with either a 200 OK or a 204 No Content.](ff0952ef692c9d960ce5f6708bcc9711_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant NEF + Note right of NF service consumer: 1. PUT .../subscriptions/{subscriptionId} + NF service consumer->>NEF: 1. PUT .../subscriptions/{subscriptionId} + Note left of NEF: 2a. 200 OK +2b. 204 No Content + NEF-->>NF service consumer: 2a. 200 OK / 2b. 204 No Content + +``` + +Sequence diagram showing the modification of an existing subscription. An NF service consumer sends a PUT request to the NEF. The NEF responds with either a 200 OK or a 204 No Content. + +**Figure 4.2.2.3-1: Modification of an existing subscription** + +To modify an existing subscription to event notifications, the NF service consumer shall send an HTTP PUT request with: "{apiRoot}/nnef-eventexposure//subscriptions/{subscriptionId}" as request URI, as shown in step 1 of figure 4.2.2.3-1, where "{subscriptionId}" is the subscription correlation ID of the existing subscription. The "NefEventExposureSubsc" data structure is included as request body as described in clause 4.2.2.2.2. + +NOTE 1: An alternate NF service consumer than the one that requested the generation of the subscription resource can send the PUT request. + +NOTE 2: The "notifUri" attribute within the NefEventExposureSubsc data structure can be modified to request that subsequent notifications are sent to a new NF service consumer. + +NOTE 3: The "monDur" attribute within the NefEventExposureSubsc data structure can be modified to extend the expiry time to keep receiving notifications. + +If the NEF cannot successfully fulfil the received HTTP PUT request due to an internal error or an error in the HTTP PUT request, the NEF shall send an HTTP error response as specified in clause 5.1.7. + +If the feature "ES3XX" is supported, and the NEF determines the received HTTP PUT request needs to be redirected, the NEF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +Upon successful reception of an HTTP PUT request with: "{apiRoot}/nnef-eventexposure//subscriptions/{subscriptionId}" as request URI and "NefEventExposureSubsc" data structure as request body, the NEF shall update the subscription and send an HTTP "200 OK" response with the "NefEventExposureSubsc" data structure as response body containing the representation of the modified "Individual Network Exposure Event Subscription", or an HTTP "204 No Content" response, as shown in step 2 of figure 4.2.2.3-1. + +When the "monDur" attribute is included in the response by the NEF, it represents NEF selected expiry time that is equal or less than the expiry time received in the request. + +When the "immRep" attribute is included and sets to "true" in the subscription and the subscribed events are available, the NEF shall include the reports of the events subscribed, if available, in the HTTP PUT response. + +When the sampling ratio, as "sampRatio" attribute, is included in the subscription, the NEF shall select a random subset of UEs among the target UEs according to the sampling ratio and only report the event(s) related to the selected subset of UEs. + +When the group reporting guard time, as "grpRepTime" attribute, is included in the subscription, the NEF shall accumulate all the event reports for the target UEs until the group reporting guard time expires. Then, the NEF shall notify the NF service consumer using the Nnef\_EventExposure\_Notify service operation, as described in clause 4.2.2.4. + +#### 4.2.2.3 Nnef\_EventExposure\_Unsubscribe service operation + +##### 4.2.2.3.1 General + +This service operation is used by an NF service consumer to unsubscribe from event notifications. + +The following procedure using the Nnef\_EventExposure\_Unsubscribe service operation is supported: + +- unsubscription from event notifications. + +##### 4.2.2.3.2 Unsubscription from event notifications + +Figure 4.2.2.3.2-1 illustrates the unsubscription from event notifications. + +![Sequence diagram illustrating the unsubscription from event notifications between an NF service consumer and the NEF.](16c1175b5f05a4b55e6d396fc51b15b3_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant NEF + Note right of NF service consumer: 1. DELETE .../subscriptions/{subscriptionId} + NF service consumer->>NEF: Request + Note right of NEF: 2. "204 No Content" + NEF-->>NF service consumer: Response +``` + +The diagram shows a sequence of two messages between an 'NF service consumer' and an 'NEF'. Step 1 is a request from the consumer to the NEF, labeled '1. DELETE .../subscriptions/{subscriptionId}'. Step 2 is a response from the NEF to the consumer, labeled '2. "204 No Content"'. The arrows indicate the direction of the messages: a solid arrow for the request and a hollow arrow for the response. + +Sequence diagram illustrating the unsubscription from event notifications between an NF service consumer and the NEF. + +**Figure 4.2.2.3.2-1: Unsubscription from event notifications** + +To unsubscribe from event notifications, the NF service consumer shall send an HTTP DELETE request with "{apiRoot}/nnef-eventexposure//subscriptions/{subscriptionId}" as request URI, as shown in step 1 of figure 4.2.2.3.2-1, where "{subscriptionId}" is the subscription correlation identifier of the existing subscription resource that is to be deleted. + +If the NEF cannot successfully fulfil the received HTTP DELETE request due to an internal error or an error in the HTTP DELETE request, the NEF shall send an HTTP error response as specified in clause 5.1.7. + +If the feature "ES3XX" is supported, and the NEF determines the received HTTP DELETE request needs to be redirected, the NEF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +Upon successful reception of an HTTP DELETE request with: "{apiRoot}/nnef-eventexposure//subscriptions/{subscriptionId}" as request URI, the NEF shall remove the corresponding subscription and send an HTTP "204 No Content" response, as shown in step 2 of figure 4.2.2.3.2-1. + +#### 4.2.2.4 Nnef\_EventExposure\_Notify service operation + +##### 4.2.2.4.1 General + +The Nnef\_EventExposure\_Notify service operation enables the NEF to notify the NF service consumer(s) that the previously subscribed application related event occurred. + +The following procedure using the Nnef\_EventExposure\_Notify service operation is supported: + +- notification about subscribed events. + +##### 4.2.2.4.2 Notification about subscribed events + +Figure 4.2.2.4.2-1 illustrates the notification about subscribed events. + +![Sequence diagram showing the notification process between NEF and NF service consumer.](7efae06af3af43ffe5d4b956a679cf54_img.jpg) + +``` +sequenceDiagram + participant NEF + participant NF_service_consumer as NF service consumer + Note right of NEF: 1. POST {notifUri} + NEF->>NF_service_consumer: 1. POST {notifUri} + Note left of NF_service_consumer: 2. "204 No Content" + NF_service_consumer-->>NEF: 2. "204 No Content" +``` + +The diagram illustrates a sequence of interactions between two entities: NEF (Network Exposure Function) and NF service consumer. The interaction consists of two steps: 1. The NEF sends a POST request with the URI {notifUri} to the NF service consumer. 2. The NF service consumer responds with a "204 No Content" status code. + +Sequence diagram showing the notification process between NEF and NF service consumer. + +**Figure 4.2.2.4.2-1: Notification about subscribed events** + +If the NEF observes application related event(s) for which an NF service consumer has subscribed, the NEF shall send an HTTP POST request as shown in step 1 of figure 4.2.2.4.2-1, with the "{notifUri}" as request URI containing the value previously provided by the NF service consumer within the corresponding subscription, and the "NefEventExposureNotif" data structure. + +The "NefEventExposureNotif" data structure shall include: + +- notification correlation ID provided by the NF service consumer during the subscription as "notifId" attribute; and +- information about the observed event(s) within the "eventNotifs" attribute that shall contain for each observed event an "NefEventNotification" data structure that shall include: + - the application related event as "event" attribute; + - the time at which the event was observed encoded as "timeStamp" attribute; + - if the "event" attribute is "SVC\_EXPERIENCE", service experience information about the application involved in the reported event in the "svcExprInfos" attribute; + - if the "event" attribute is "UE\_MOBILITY", UE mobility information associated with the application as "ueMobilityInfos" attribute; + - if the "event" attribute is "UE\_COMM", UE communication information associated with the application as "ueCommInfos" attribute; and + - if the "event" attribute is "EXCEPTIONS", exceptions information associated with a service flow as "excepInfos" attribute. + +If the NF service consumer cannot successfully fulfil the received HTTP POST request due to an internal error or an error in the HTTP POST request, the NF service consumer shall send an HTTP error response as specified in clause 5.1.7. + +If the feature "ES3XX" is supported, and the NF service consumer determines the received HTTP POST request needs to be redirected, the NF service consumer shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +Upon successful reception of an HTTP POST request with "{notifUri}" as request URI and "NefEventExposureNotif" data structure as request body, the NF service consumer shall send an HTTP "204 No Content" response, as shown in step 2 of figure 4.2.2.4.2-1, in case of a successful processing. + +# 5 API Definitions + +## 5.1 Nnef\_EventExposure Service API + +### 5.1.1 Introduction + +The Nnef\_EventExposure service shall use the Nnef\_EventExposure API. + +The API URI of the Nnef\_EventExposure API shall be: + +**{apiRoot}
/** + +The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nnef-eventexposure". +- The shall be "v1". +- The shall be set as described in clause 5.1.3. + +### 5.1.2 Usage of HTTP + +#### 5.1.2.1 General + +HTTP/2, IETF RFC 7540 [11], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +The OpenAPI [6] specification of HTTP messages and content bodies for the Nnef\_EventExposure API is contained in Annex A. + +#### 5.1.2.2 HTTP standard headers + +##### 5.1.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers. + +##### 5.1.2.2.2 Content type + +JSON, IETF RFC 8259 [12], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [4]. The use of the JSON format shall be signalled by the content type "application/json". + +"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 7807 [13]. + +#### 5.1.2.3 HTTP custom headers + +The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] shall be applicable. + +In this Release of the specification, no specific custom headers are defined for the Nnef\_EventExposure API. + +### 5.1.3 Resources + +#### 5.1.3.1 Overview + +![Figure 5.1.3.1-1: Resource URI structure of the Nnef_EventExposure API. The diagram shows a hierarchical tree structure starting with {apiRoot}/nnef-eventexposure/. A line branches down to a box containing /subscriptions. From this box, another line branches down to a box containing /{subscriptionId}.](33a8f3f01dfa8bce75d23017855a13c5_img.jpg) + +``` + +graph TD + Root["{apiRoot}/nnef-eventexposure/"] --> Subscriptions["/subscriptions"] + Subscriptions --> SubscriptionId["/{subscriptionId}"] + +``` + +Figure 5.1.3.1-1: Resource URI structure of the Nnef\_EventExposure API. The diagram shows a hierarchical tree structure starting with {apiRoot}/nnef-eventexposure/. A line branches down to a box containing /subscriptions. From this box, another line branches down to a box containing /{subscriptionId}. + +**Figure 5.1.3.1-1: Resource URI structure of the Nnef\_EventExposure API** + +Table 5.1.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 5.1.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|------------------------------------------------|---------------------------------|---------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Network Exposure Event Subscriptions | /subscriptions | POST | Creates a subscription to notifications on application or user related event(s), i.e. creation of an Individual Network Exposure Event Subscription resource. | +| Individual Network Exposure Event Subscription | /subscriptions/{subscriptionId} | GET | Reads an Individual Network Exposure Event Subscription resource. | +| | | PUT | Modifies an Individual Network Exposure Event Subscription. | +| | | DELETE | Cancels an individual subscription to notifications of subscribed event. | + +#### 5.1.3.2 Resource: Network Exposure Event Subscriptions + +##### 5.1.3.2.1 Description + +The resource represents the collection of Network Exposure Event subscriptions of the Nnef\_EventExposure service. It allows NF service consumers to create a new subscription to notifications on application or user related event(s). + +##### 5.1.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nnef-eventexposure//subscriptions + +This resource shall support the resource URI variables defined in table 5.1.3.2.2-1. + +**Table 5.1.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|------------|-----------|------------------| +| apiRoot | string | See clause 5.1.1 | +| apiVersion | string | See clause 5.1.1 | + +##### 5.1.3.2.3 Resource Standard Methods + +###### 5.1.3.2.3.1 POST + +This method shall support the URI query parameters specified in table 5.1.3.2.3.1-1. + +**Table 5.1.3.2.3.1-1: URI query parameters supported by the method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 5.1.3.2.3.1-2 and the response data structures and response codes specified in table 5.1.3.2.3.1-3. + +**Table 5.1.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------| +| NefEventExposureSubsc | M | 1 | Contains the information required for the creation of a new Individual Network Exposure Event Subscription resource. | + +**Table 5.1.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------------------------------------------| +| NefEventExposureSubsc | M | 1 | 201
Created | Contains the representation of the Individual Network Exposure Event Subscription resource. | +| NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +**Table 5.1.3.2.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure: {apiRoot}/nnef-eventexposure//subscriptions/{subscriptionId} | + +#### 5.1.3.3 Resource: Individual Network Exposure Event Subscription + +##### 5.1.3.3.1 Description + +The resource represents an individual Network Exposure Event subscription of the Nnef\_EventExposure service. It allows NF service consumers to read/modify/cancel a subscription to notifications on application or user related event(s). + +##### 5.1.3.3.2 Resource Definition + +Resource URI: {apiRoot}/nnef-eventexposure//subscriptions/{subscriptionId} + +This resource shall support the resource URI variables defined in table 5.1.3.3.2-1. + +**Table 5.1.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------------|-----------|--------------------------------------------------------------| +| apiRoot | string | See clause 5.1.1 | +| apiVersion | string | See clause 5.1.1 | +| subscriptionId | string | Identifies a subscription to the NEF event exposure service. | + +##### 5.1.3.3.3 Resource Standard Methods + +###### 5.1.3.3.3.1 GET + +This method shall support the URI query parameters specified in table 5.1.3.3.3.1-1. + +**Table 5.1.3.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------|-------------------|---|-------------|----------------------------------------------------| +| supp-feat | SupportedFeatures | O | 0..1 | The features supported by the NF service consumer. | + +This method shall support the request data structures specified in table 5.1.3.3.3.1-2 and the response data structures and response codes specified in table 5.1.3.3.3.1-3. + +**Table 5.1.3.3.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.1.3.3.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NefEventExposureS
ubsc | M | 1 | 200 OK | Contains the representation of the Individual Network Exposure Event Subscription resource. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF (service) instance. Applicable if the feature "ES3XX" is supported. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF (service) instance. Applicable if the feature "ES3XX" is supported. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +**Table 5.1.3.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative NEF (service) instance. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the request is redirected. | + +**Table 5.1.3.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative NEF (service) instance. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the request is redirected. | + +###### 5.1.3.3.3.2 PUT + +This method shall support the URI query parameters specified in table 5.1.3.3.3.2-1. + +**Table 5.1.3.3.3.2-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.1.3.3.3.2-2 and the response data structures and response codes specified in table 5.1.3.3.3.2-3. + +**Table 5.1.3.3.3.2-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------|---|-------------|--------------------------------------------------------------------------------| +| NefEventExposureSubsc | M | 1 | Modifies the existing Individual Network Exposure Event Subscription resource. | + +**Table 5.1.3.3.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NefEventExposureSubsc | M | 1 | 200 OK | Successful case.
The Individual Network Exposure Event Subscription resource was modified and a representation is returned. | +| n/a | | | 204 No Content | Successful case.
The Individual Network Exposure Event Subscription resource was modified. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF (service) instance.
Applicable if the feature "ES3XX" is supported. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF (service) instance.
Applicable if the feature "ES3XX" is supported. | + +NOTE: The mandatory HTTP error status codes for the PUT method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +**Table 5.1.3.3.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative NEF (service) instance. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the request is redirected. | + +**Table 5.1.3.3.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative NEF (service) instance. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the request is redirected. | + +###### 5.1.3.3.3.3 DELETE + +This method shall support the URI query parameters specified in table 5.1.3.3.3.3-1. + +**Table 5.1.3.3.3.3-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.1.3.3.3.3-2 and the response data structures and response codes specified in table 5.1.3.3.3.3-3. + +**Table 5.1.3.3.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.1.3.3.3.3-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful case. The Individual Network Exposure Event Subscription resource matching the subscriptionId was deleted. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during subscription termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF (service) instance. Applicable if the feature "ES3XX" is supported. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during subscription termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF (service) instance. Applicable if the feature "ES3XX" is supported. | + +NOTE: The mandatory HTTP error status code for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +**Table 5.1.3.3.3.3-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative NEF (service) instance. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the request is redirected. | + +**Table 5.1.3.3.3.3-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative NEF (service) instance. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the request is redirected. | + +### 5.1.4 Custom Operations without associated resources + +None. + +### 5.1.5 Notifications + +#### 5.1.5.1 General + +Notifications shall comply to clause 6.2 of 3GPP TS 29.500 [4] and clause 4.6.2.3 of 3GPP TS 29.501 [5]. + +**Table 5.1.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|-------------------------------------|--------------|---------------------------------|---------------------------------------------| +| Network Exposure Event Notification | {notifUri} | POST | Provides Information about observed events. | + +#### 5.1.5.2 Network Exposure Event Notification + +##### 5.1.5.2.1 Description + +The Network Exposure Event Notification is used by the NEF to report one or several observed Events to a NF service consumer that has subscribed to such Notifications. + +##### 5.1.5.2.2 Target URI + +The Notification URI "{notifUri}" shall be used with the callback URI variables defined in table 5.1.5.2.2-1. + +**Table 5.1.5.2.2-1: Callback URI variables for this resource** + +| Name | Data type | Definition | +|----------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notifUri | Uri | The Notification Uri as assigned by the NF service consumer during the subscription service operation and described within the NefEventExposureSubsc data type (see table 5.1.6.2.2-1). | + +##### 5.1.5.2.3 Standard Methods + +###### 5.1.5.2.3.1 POST + +This method shall support the request data structures specified in table 5.1.5.2.3.1-1 and the response data structures and response codes specified in table 5.1.5.2.3.1-1. + +**Table 5.1.5.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------|---|-------------|--------------------------------------------| +| NefEventExposureNotif | M | 1 | Provides Information about observed events | + +**Table 5.1.5.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The receipt of the Notification is acknowledged. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during event notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative NF consumer (service) instance where the notification should be sent.
Applicable if the feature "ES3XX" is supported. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during event notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative NF consumer (service) instance where the notification should be sent.
Applicable if the feature "ES3XX" is supported. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +**Table 5.1.5.2.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected. | + +**Table 5.1.5.2.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected. | + +### 5.1.6 Data Model + +#### 5.1.6.1 General + +This clause specifies the application data model supported by the API. + +Table 5.1.6.1-1 specifies the data types defined for the Nnef\_EventExposure service based interface protocol. + +**Table 5.1.6.1-1: Nnef\_EventExposure specific Data Types** + +| Data type | Section defined | Description | Applicability | +|------------------------|-----------------|-------------|---------------| +| NefEvent | 5.1.6.3.3 | | | +| NefEventExposureNotif | 5.1.6.2.3 | | | +| NefEventExposureSubs | 5.1.6.2.2 | | | +| NefEventFilter | 5.1.6.2.7 | | | +| NefEventNotification | 5.1.6.2.4 | | | +| NefEventSubs | 5.1.6.2.5 | | | +| ServiceExperienceInfo | 5.1.6.2.9 | | | +| TargetUeIdentification | 5.1.6.2.8 | | | +| UeCommunicationInfo | 5.1.6.2.6 | | | +| UeMobilityInfo | 5.1.6.2.10 | | | +| UeTrajectoryInfo | 5.1.6.2.11 | | | + +Table 5.1.6.1-2 specifies data types re-used by the Nnef\_EventExposure service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nnef\_EventExposure service based interface. + +**Table 5.1.6.1-2: Nnef\_EventExposure re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|------------------------------|---------------------|-------------------------------------------|---------------| +| ApplicationId | 3GPP TS 29.571 [16] | | | +| ReportingInformation | 3GPP TS 29.523 [22] | | | +| CommunicationCollection | 3GPP TS 29.517 [18] | | | +| DateTime | 3GPP TS 29.571 [16] | | | +| ExceptionInfo | 3GPP TS 29.517 [18] | | | +| GroupId | 3GPP TS 29.571 [16] | | | +| NetworkAreaInfo | 3GPP TS 29.554 [21] | | | +| RedirectResponse | 3GPP TS 29.571 [16] | Contains redirection related information. | ES3XX | +| Supi | 3GPP TS 29.571 [16] | | | +| SupportedFeatures | 3GPP TS 29.571 [16] | | | +| ServiceExperienceInfoPerFlow | 3GPP TS 29.517 [18] | | | +| UserLocation | 3GPP TS 29.571 [16] | | | +| Uri | 3GPP TS 29.571 [16] | | | + +#### 5.1.6.2 Structured data types + +##### 5.1.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 5.1.6.2.2 Type: NefEventExposureSubsc + +Table 5.1.6.2.2-1: Definition of type NefEventExposureSubsc + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| eventsSubs | array(NefEvent Subs) | M | 1..N | Subscribed events and the related event filters. | | +| eventsRepInfo | ReportingInformation | O | 0..1 | Represents the reporting requirements of the subscription. If omitted, the default values within the ReportingInformation data type apply. | | +| notifUri | Uri | M | 1 | Notification URI for event reporting. | | +| eventNotifs | array(NefEvent Notification) | C | 1..N | Represents the Events to be reported. Shall only be present if the immediate reporting indication in the "immRep" attribute within the "eventsRepInfo" attribute sets to true in the event subscription, and the reports are available. | | +| notifId | string | M | 1 | Notification Correlation ID assigned by the NF service consumer. | | +| suppFeat | SupportedFeatures | C | 0..1 | This IE represents a list of Supported features used as described in clause 5.8. Shall be present in the HTTP POST request/response; or in the HTTP GET response if the "supp-feat" attribute query parameter is included in the HTTP GET request. (NOTE) | | + +NOTE: In the HTTP POST request it represents the set of NF service consumer supported features. In the HTTP POST and GET responses it represents the set of features supported by both the NF service consumer and the NEF. + +##### 5.1.6.2.3 Type: NefEventExposureNotif + +Table 5.1.6.2.3-1: Definition of type NefEventExposureNotif + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------|---------------| +| notifId | string | M | 1 | Notification Correlation ID assigned by the NF service consumer. | | +| eventNotifs | array(NefEvent Notification) | M | 1..N | Represents the Events to be reported according to the subscription corresponding to the Notification Correlation ID. | | + +##### 5.1.6.2.4 Type: NefEventNotification + +Table 5.1.6.2.4-1: Definition of type NefEventNotification + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|------------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| event | NefEvent | M | 1 | Reported application related event. | | +| timeStamp | DateTime | M | 1 | Time at which the event is observed. | | +| svcExprInfos | array(ServiceExperienceInfo) | C | 1..N | Contains the service experience information.
Shall be present if the "event" attribute sets to "SVC_EXPERIENCE" | ServiceExperience | +| ueMobilityInfos | array(UeMobilityInfo) | C | 1..N | Contains the UE mobility information.
Shall be present if the "event" attribute sets to "UE_MOBILITY" | UeMobility | +| ueCommInfos | array(UeCommunicationInfo) | C | 1..N | Contains the application communication information.
Shall be present if the "event" attribute sets to "UE_COMM" | UeCommunication | +| excepInfos | array(ExceptionInfo) | C | 1..N | Each element represents the exception information for a service flow.
Shall be present if the "event" attribute sets to "EXCEPTIONS". | Exceptions | + +##### 5.1.6.2.5 Type NefEventSubs + +Table 5.1.6.2.5-1: Definition of type NefEventSubs + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------| +| event | NefEvent | M | 1 | Subscribed event. | | +| eventFilter | NefEventFilter | C | 0..1 | Represents the event filter information associated with each event.
Shall be present if "event" sets to "SVC_EXPERIENCE", "UE_MOBILITY", "UE_COMM" or "EXCEPTIONS". | ServiceExperience
UeCommunication
UeMobility
Exceptions | + +##### 5.1.6.2.6 Type UeCommunicationInfo + +Table 5.1.6.2.6-1: Definition of type UeCommunicationInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------------------|---|-------------|--------------------------------------------------------------------------------------------------|---------------| +| supi | Supi | C | 0..1 | Identifies an UE.
Shall be present if the event exposure request applies to more than one UE. | | +| interGroupId | GroupId | O | 0..1 | Identifies an UE group. | | +| appId | ApplicationId | O | 0..1 | Identifies an application identifier. | | +| comms | array(CommunicationCollection) | M | 1..N | This attribute contains a list of communication information. | | + +##### 5.1.6.2.7 Type NefEventFilter + +Table 5.1.6.2.7-1: Definition of type NefEventFilter + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------| +| tgtUe | TargetUeIdentification | M | 1 | Represents the UE information to which the request applies. | (NOTE 1) | +| appIds | array(ApplicationId) | C | 1..N | Each element indicates an application identifier.
If absent, the NefEventFilter data applies to any application (i.e. all applications).
(NOTE 2) | ServiceExperience
Exceptions
UeCommunication
UeMobility | +| locArea | NetworkAreaInfo | O | 0..1 | Represents an area of interest. | ServiceExperience
Exceptions
UeCommunication
UeMobility | + +NOTE 1: Applicability is further described in the corresponding data type. +NOTE 2: For the events "EXCEPTIONS", "UE\_MOBILITY" and "UE\_COMM", if present, the "appIds" attribute shall include only one element. + +##### 5.1.6.2.8 Type TargetUeIdentification + +Table 5.1.6.2.8-1: Definition of type TargetUeIdentification + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------| +| supis | array(Supi) | O | 1..N | Each element identifies a SUPI for an UE. | ServiceExperience
Exceptions
UeMobility
UeCommunication | +| interGroupIds | array(GroupId) | O | 1..N | Each element represents an internal group identifier which identifies a group of UEs. | ServiceExperience
Exceptions
UeMobility
UeCommunication | +| anyUeld | boolean | O | 0..1 | Identifies whether the request applies to any UE.
This attribute shall set to "true" if applicable for any UE, otherwise, set to "false". | ServiceExperience
Exceptions | + +NOTE: For an applicable feature, only one attribute identifying the target UE shall be provided. + +##### 5.1.6.2.9 Type: ServiceExperienceInfo + +Table 5.1.6.2.9-1: Definition of type ServiceExperienceInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| appId | ApplicationId | C | 0..1 | Identifies an application identifier.
Shall be present if the event exposure service request applies to more than one application. | ServiceExperience | +| supis | array(Supi) | C | 1..N | Each element represents the internal UE identifier. | ServiceExperience | +| svcExpPerFlows | array(ServiceExperienceInfoPerFlow) | M | 1..N | Each element indicates service experience for each service flow. | ServiceExperience | + +##### 5.1.6.2.10 Type: UeMobilityInfo + +Table 5.1.6.2.10-1: Definition of type UeMobilityInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------------|---|-------------|--------------------------------------------------------------------------------------------------|---------------| +| supi | Supi | M | 1 | Identifies an UE.
Shall be present if the event exposure request applies to more than one UE. | | +| appId | ApplicationId | O | 0..1 | Identifies an application identifier. | | +| ueTrajs | array(UeTrajectoryInfo) | M | 1..N | Identifies an UE moving trajectory. | | + +##### 5.1.6.2.11 Type: UeTrajectoryInfo + +Table 5.1.6.2.11-1: Definition of type UeTrajectoryInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------|---|-------------|--------------------------------------------------------|---------------| +| ts | DateTime | M | 1 | Identifies the timestamp when the UE enters this area. | | +| location | UserLocation | M | 1 | Includes the location of the UE. | | + +#### 5.1.6.3 Simple data types and enumerations + +##### 5.1.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 5.1.6.3.2 Simple data types + +The simple data types defined in table 5.1.6.3.2-1 shall be supported. + +Table 5.1.6.3.2-1: Simple data types + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| | | | | + +##### 5.1.6.3.3 Enumeration: NefEvent + +The enumeration NefEvent represents the observed event requested by the NF service consumer to be monitored. It shall comply with the provisions defined in table 5.1.6.3.3-1. + +Table 5.1.6.3.3-1: Enumeration NefEvent + +| Enumeration value | Description | Applicability | +|-------------------|--------------------------------------------------------------|-------------------| +| SVC_EXPERIENCE | Indicates that the observed event is service experience. | ServiceExperience | +| UE_COMM | Indicates that the observed event is UE communication. | UeCommunication | +| UE_MOBILITY | Indicates that the observed event is UE mobility. | UeMobility | +| EXCEPTIONS | Indicates that the observed event is exceptions information. | Exceptions | + +### 5.1.7 Error Handling + +#### 5.1.7.1 General + +For the Nnef\_EventExposure API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [4] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [4]. + +In addition, the requirements in the following clauses are applicable for the Nnef\_EventExposure API. + +#### 5.1.7.2 Protocol Errors + +No specific procedures for the Nnef\_EventExposure service are specified. + +#### 5.1.7.3 Application Errors + +The application errors defined for the Nnef\_EventExposure service are listed in Table 5.1.7.3-1. + +**Table 5.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|------------------|-------------| +| | | | + +### 5.1.8 Feature negotiation + +The optional features in table 5.1.8-1 are defined for the Nnef\_EventExposure API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 5.1.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | ServiceExperience | This feature indicates support for the "SVC_EXPERIENCE" event. | +| 2 | UeMobility | This feature indicates support for the "UE_MOBILITY" event. | +| 3 | UeCommunication | This feature indicates support for the "UE_COMM" event. | +| 4 | Exceptions | This feature indicates support for the "EXCEPTIONS" event. | +| 5 | ES3XX | Extended Support for 3xx redirections. This feature indicates the support of redirection for any service operation, according to Stateless NF procedures as specified in subclauses 6.5.3.2 and 6.5.3.3 of 3GPP TS 29.500 [4] and according to HTTP redirection principles for indirect communication, as specified in subclause 6.10.9 of 3GPP TS 29.500 [4]. | + +### 5.1.9 Security + +As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Nnef\_EventExposure API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [9]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [10]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nnef\_EventExposure API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [10], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nnef\_EventExposure service. + +The Nnef\_EventExposure API defines a single scope "nnef-eventexposure" for the entire service, and it does not define any additional scopes at resource or operation level. + +# Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex specifies the formal definition of the API(s) defined in the present specification. It consists of OpenAPI 3.0.0 specifications in YAML format. + +This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository that uses the GitLab software version control system (see clause 5B of the 3GPP TR 21.900 [7] and clause 5.3.1 of the 3GPP TS 29.501 [5] for further information). + +## A.2 Nnef\_EventExposure API + +``` +openapi: 3.0.0 +info: + title: Nnef_EventExposure + version: 1.0.6 + description: | + NEF Event Exposure Service. + © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 29.591 V16.7.0; 5G System; Network Exposure Function Southbound Services; Stage 3. + url: http://www.3gpp.org/ftp/Specs/archive/29_series/29.591/ +servers: + - url: '{apiRoot}/nnef-eventexposure/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 +security: + - {} + - oAuth2ClientCredentials: + - nnef-eventexposure +paths: + + /subscriptions: + post: + summary: subscribe to notifications + operationId: CreateIndividualSubscription + tags: + - Subscriptions (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NefEventExposureSubsc' + responses: + '201': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/NefEventExposureSubsc' + headers: + Location: + description: 'Contains the URI of the newly created resource, according to the' +structure: {apiRoot}/nnef-eventexposure/{apiVersion}/subscriptions/{subscriptionId}' + required: true +``` + +``` + + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + callbacks: + myNotification: + '{ $request.body# /notifUri }': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NefEventExposureNotif' + responses: + '204': + description: No Content, Notification was successful + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +/subscription/{subscriptionId}: + get: + summary: retrieve subscription + operationId: GetIndividualSubscription + tags: + - IndividualSubscription (Document) + parameters: + - name: subscriptionId + in: path + description: Event Subscription ID + required: true + schema: + type: string + - name: supp-feat + in: query + +``` + +``` + +description: Features supported by the NF service consumer +required: false +schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: + '200': + description: OK. Resource representation is returned + content: + application/json: + schema: + $ref: '#/components/schemas/NefEventExposureSubsc' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +put: + summary: update subscription + operationId: ReplaceIndividualSubscription + tags: + - IndividualSubscription (Document) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NefEventExposureSubsc' + parameters: + - name: subscriptionId + in: path + description: Event Subscription ID + required: true + schema: + type: string + responses: + '200': + description: OK. Resource was successfully modified and representation is returned + content: + application/json: + schema: + $ref: '#/components/schemas/NefEventExposureSubsc' + '204': + description: No Content. Resource was successfully modified + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + +``` + +``` + + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +delete: + summary: unsubscribe from notifications + operationId: DeleteIndividualSubscription + tags: + - IndividualSubscription (Document) + parameters: + - name: subscriptionId + in: path + description: Event Subscription ID + required: true + schema: + type: string + responses: + '204': + description: No Content. Resource was successfully deleted + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nnef-eventexposure: Access to the Nnef_EventExposure API +schemas: + NefEventExposureSubsc: + type: object + properties: + eventsSubs: + type: array + items: + $ref: '#/components/schemas/NefEventSubs' + minItems: 1 + eventsRepInfo: + $ref: 'TS29523_Npcf_EventExposure.yaml#/components/schemas/ReportingInformation' + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + notifId: + type: string + eventNotifs: + type: array + items: + $ref: '#/components/schemas/NefEventNotification' + minItems: 1 + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - eventsSubs + - notifId + - notifUri + +``` + +``` +NefEventExposureNotif: + type: object + properties: + notifId: + type: string + eventNotifs: + type: array + items: + $ref: '#/components/schemas/NefEventNotification' + minItems: 1 + required: + - notifId + - eventNotifs +NefEventNotification: + type: object + properties: + event: + $ref: '#/components/schemas/NefEvent' + timeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + svcExprcInfos: + type: array + items: + $ref: '#/components/schemas/ServiceExperienceInfo' + minItems: 1 + ueMobilityInfos: + type: array + items: + $ref: '#/components/schemas/UeMobilityInfo' + minItems: 1 + ueCommInfos: + type: array + items: + $ref: '#/components/schemas/UeCommunicationInfo' + minItems: 1 + excepInfos: + type: array + items: + $ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/ExceptionInfo' + minItems: 1 + required: + - event + - timeStamp +NefEventSubs: + type: object + properties: + event: + $ref: '#/components/schemas/NefEvent' + eventFilter: + $ref: '#/components/schemas/NefEventFilter' + required: + - event +NefEventFilter: + type: object + properties: + tgtUe: + $ref: '#/components/schemas/TargetUeIdentification' + appIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + minItems: 1 + locArea: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' + required: + - tgtUe +TargetUeIdentification: + type: object + properties: + supis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + interGroupIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' +``` + +----- + +----- + +``` + + minItems: 1 + anyUeId: + type: boolean +ServiceExperienceInfo: + type: object + properties: + appId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + supis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + svcExpPerFlows: + type: array + items: + $ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/ServiceExperienceInfoPerFlow' + minItems: 1 + required: + - svcExpPerFlows +UeMobilityInfo: + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + appId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + ueTrajs: + type: array + items: + $ref: '#/components/schemas/UeTrajectoryInfo' + minItems: 1 + required: + - supi + - ueTrajs +UeCommunicationInfo: + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + interGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + appId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + comms: + type: array + items: + $ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/CommunicationCollection' + minItems: 1 + required: + - comms +UeTrajectoryInfo: + type: object + properties: + ts: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + location: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + required: + - ts + - location + +``` + +###### # Simple data types and Enumerations + +``` + +NefEvent: + anyOf: + - type: string + enum: + - SVC_EXPERIENCE + - UE_MOBILITY + - UE_COMM + - EXCEPTIONS + - type: string + +``` + +# Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|----------|-----------|------|-----|-----|--------------------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2019-10 | CT3#106 | | | | | TS Skeleton | 0.0.0 | +| 2019-10 | CT3#106 | C3-194392 | | | | Removed some subclauses and editorial changes | 0.1.0 | +| 2019-10 | CT3#106 | | | | | Inclusion of C3-194271, C3-194396, C3-194397 and C3-194399. | 0.2.0 | +| 2019-11 | CT3#107 | | | | | Inclusion of C3-195234, C3-195235, C3-195236 and C3-195274. | 0.3.0 | +| 2020-02 | CT3#108e | | | | | Inclusion of C3-201284, C3-201288, C3-201367, C3-201368, C3-201370, C3-201407, C3-201409, C3-201413 and C3-201516. | 0.4.0 | +| 2020-03 | CT#87e | CP-200187 | | | | TS sent to plenary for approval | 1.0.0 | +| 2020-03 | CT#87e | CP-200187 | | | | TS approved by plenary | 16.0.0 | +| 2020-06 | CT#88e | CP-201234 | 0001 | 1 | F | Correction on resource usage | 16.1.0 | +| 2020-06 | CT#88e | CP-201234 | 0002 | | F | Data type used during event subscription | 16.1.0 | +| 2020-06 | CT#88e | CP-201234 | 0007 | 1 | F | Correction to service operation description | 16.1.0 | +| 2020-06 | CT#88e | CP-201244 | 0008 | 1 | F | Storage of YAML files in ETSI Forge | 16.1.0 | +| 2020-06 | CT#88e | CP-201210 | 0009 | 1 | F | Removal of Ninef_EventExposure service | 16.1.0 | +| 2020-06 | CT#88e | CP-201256 | 0011 | 1 | F | URI of the Nnef_EventExposure service | 16.1.0 | +| 2020-06 | CT#88e | CP-201234 | 0012 | | F | Event Reporting Information data usage | 16.1.0 | +| 2020-06 | CT#88e | CP-201234 | 0013 | | F | Support of immediate reporting | 16.1.0 | +| 2020-06 | CT#88e | CP-201234 | 0014 | | F | Supported features definition | 16.1.0 | +| 2020-06 | CT#88e | CP-201234 | 0015 | | F | Correction on the ueCommInfos | 16.1.0 | +| 2020-06 | CT#88e | CP-201234 | 0016 | | F | Applicabilities for UE communication | 16.1.0 | +| 2020-06 | CT#88e | CP-201234 | 0017 | 1 | F | Supported headers, Resource Data type and yaml mapping | 16.1.0 | +| 2020-06 | CT#88e | CP-201255 | 0018 | | F | Update of OpenAPI version and TS version in externalDocs field | 16.1.0 | +| 2020-09 | CT#89e | CP-202066 | 0019 | 1 | F | Default value for eventsReplInfo attribute | 16.2.0 | +| 2020-09 | CT#89e | CP-202066 | 0022 | | F | Missed response code | 16.2.0 | +| 2020-09 | CT#89e | CP-202066 | 0023 | | F | Applicabilities of appIds and locArea | 16.2.0 | +| 2020-09 | CT#89e | CP-202084 | 0024 | | F | Update of OpenAPI version and TS version in externalDocs field | 16.2.0 | +| 2020-12 | CT#90e | CP-203139 | 0025 | 1 | F | Essential Corrections and alignments | 16.3.0 | +| 2020-12 | CT#90e | CP-203139 | 0026 | | F | Storage of YAML files in 3GPP Forge | 16.3.0 | +| 2020-12 | CT#90e | CP-203139 | 0028 | 1 | F | Callback URI correction | 16.3.0 | +| 2020-12 | CT#90e | CP-203152 | 0030 | | F | Update of OpenAPI version and TS version in externalDocs field | 16.3.0 | +| 2021-03 | CT#91e | CP-210191 | 0031 | | F | Support Stateless NFs | 16.4.0 | +| 2021-03 | CT#91e | CP-210206 | 0039 | | F | Resource URI correction | 16.4.0 | +| 2021-03 | CT#91e | CP-210239 | 0041 | | F | Update of OpenAPI version and TS version in externalDocs field | 16.4.0 | +| 2021-06 | CT#92e | CP-211220 | 0045 | 1 | F | Presence condition of eventsReplInfo attribute | 16.5.0 | +| 2021-06 | CT#92e | CP-211200 | 0047 | 1 | F | Redirection responses | 16.5.0 | +| 2021-06 | CT#92e | CP-211264 | 0050 | | F | Update of OpenAPI version and TS version in externalDocs field | 16.5.0 | +| 2021-09 | CT#93e | CP-212222 | 0056 | | F | Update of OpenAPI version and TS version in externalDocs field | 16.6.0 | +| 2022-03 | CT#95e | CP-220177 | 0076 | | F | Update of info and externalDocs fields | 16.7.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29598/18442e4e239480f0c3c95b547aa8fde2_img.jpg b/marked/Rel-16/29_series/29598/18442e4e239480f0c3c95b547aa8fde2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..aa01be230bfccea52d6f86d2a3ddfb6cf4eaac87 --- /dev/null +++ b/marked/Rel-16/29_series/29598/18442e4e239480f0c3c95b547aa8fde2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6f627120f25c05e5c882bd77a6b198c01de07107391f8fbae6e3fb6c5264a9c3 +size 26761 diff --git a/marked/Rel-16/29_series/29598/21ad58fee90f2be50708ff541d225507_img.jpg b/marked/Rel-16/29_series/29598/21ad58fee90f2be50708ff541d225507_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..30858f09c94d9c08352d2ae1ed4377b9f56cb7c0 --- /dev/null +++ b/marked/Rel-16/29_series/29598/21ad58fee90f2be50708ff541d225507_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f9cb064f012450d662b9291e95ec096a823914e18b323b5a022f4c16fc7f3fd7 +size 35865 diff --git a/marked/Rel-16/29_series/29598/27b06ec9f42b5d727a2630f61a5f1861_img.jpg b/marked/Rel-16/29_series/29598/27b06ec9f42b5d727a2630f61a5f1861_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f6e9392b590065073d134c119fc0caa78af0182c --- /dev/null +++ b/marked/Rel-16/29_series/29598/27b06ec9f42b5d727a2630f61a5f1861_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:49b8d75c2e8ee4347af28a8107b3c2596db6cbc1d6a9de98c85a19adb220dfec +size 27373 diff --git a/marked/Rel-16/29_series/29598/2e399449b7f62d40167a65ca88888917_img.jpg b/marked/Rel-16/29_series/29598/2e399449b7f62d40167a65ca88888917_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e5d230a69f4ef592e90079861621a5e2871bdb23 --- /dev/null +++ b/marked/Rel-16/29_series/29598/2e399449b7f62d40167a65ca88888917_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:14d5ea9e3b0c7d4bd6359197f294b9b5a5c791dcb70e1552beabb568fe74eb62 +size 26740 diff --git a/marked/Rel-16/29_series/29598/4cde160bcc69b7b6c81b648dd0e4252e_img.jpg b/marked/Rel-16/29_series/29598/4cde160bcc69b7b6c81b648dd0e4252e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8a60eb24641fa43881c3fdf954eeae6815c933bf --- /dev/null +++ b/marked/Rel-16/29_series/29598/4cde160bcc69b7b6c81b648dd0e4252e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f4bec1ae463c701df8be7387161fe8617b93340686493cfbecaaeabf95505831 +size 30734 diff --git a/marked/Rel-16/29_series/29598/57939c16065211317c5442cf2a4009e0_img.jpg b/marked/Rel-16/29_series/29598/57939c16065211317c5442cf2a4009e0_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..91ffe96cc79aa84ea90f05f5f78a9db87593c7e0 --- /dev/null +++ b/marked/Rel-16/29_series/29598/57939c16065211317c5442cf2a4009e0_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7e1ef0e0d4d78d2c6366fc84632a1e21dc728278941d0f1b3276be72845e53a7 +size 5339 diff --git a/marked/Rel-16/29_series/29598/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-16/29_series/29598/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4160dee77b15caee0d84b640c9b327d95431f17c --- /dev/null +++ b/marked/Rel-16/29_series/29598/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:652a60eab146559880e82139684502043b347c1be4cc2d29c09a086e89ca2468 +size 10145 diff --git a/marked/Rel-16/29_series/29598/608f1b5ef8f3dc0723f2b4ea1fb72be2_img.jpg b/marked/Rel-16/29_series/29598/608f1b5ef8f3dc0723f2b4ea1fb72be2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1255cb7bc63e1d2f20228e705ba016535a7cb34c --- /dev/null +++ b/marked/Rel-16/29_series/29598/608f1b5ef8f3dc0723f2b4ea1fb72be2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e8fa47b85a4f946ec2ae8420a06f794cdac3dcec9f8995576a19b916ee575143 +size 25081 diff --git a/marked/Rel-16/29_series/29598/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-16/29_series/29598/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..546e6eb065f115807b227114f720a2325008b82a --- /dev/null +++ b/marked/Rel-16/29_series/29598/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3e9c2913da159f249ef131721b56c74886b6b5698b7a1196f8ea709b7a356adc +size 5486 diff --git a/marked/Rel-16/29_series/29598/6984a27b2b89e0995d5216ec29b41d1c_img.jpg b/marked/Rel-16/29_series/29598/6984a27b2b89e0995d5216ec29b41d1c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c75dd8ae54ff646dc586012425660a14542f597c --- /dev/null +++ b/marked/Rel-16/29_series/29598/6984a27b2b89e0995d5216ec29b41d1c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5f387edb23ac881ddb1f6f6a8ab6792d267adc56f51bfae9ba36d5e5131e285d +size 16709 diff --git a/marked/Rel-16/29_series/29598/77464a47f104d0d647b2414591137b64_img.jpg b/marked/Rel-16/29_series/29598/77464a47f104d0d647b2414591137b64_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1fac3bd84bb67dac6b44fc0a639174e9d50bc9fc --- /dev/null +++ b/marked/Rel-16/29_series/29598/77464a47f104d0d647b2414591137b64_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6afce8f4880925a4e2efa681d6e92362946aebffd09eaaf604f29ad68533e5cf +size 31142 diff --git a/marked/Rel-16/29_series/29598/79e1709a7317ead45379cbb8ff3ba802_img.jpg b/marked/Rel-16/29_series/29598/79e1709a7317ead45379cbb8ff3ba802_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4a559db2b3fb154ff435c986fe5975980b3e3810 --- /dev/null +++ b/marked/Rel-16/29_series/29598/79e1709a7317ead45379cbb8ff3ba802_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:30b855cb4429d023ea77d086ea8d5758aead963a11bec2971a42c91bd3bc9715 +size 25704 diff --git a/marked/Rel-16/29_series/29598/7b8b192e2853ef28d28eff0241ebe86b_img.jpg b/marked/Rel-16/29_series/29598/7b8b192e2853ef28d28eff0241ebe86b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ea6be591a0b9d87a508d71cc8e65d11a3392a3fe --- /dev/null +++ b/marked/Rel-16/29_series/29598/7b8b192e2853ef28d28eff0241ebe86b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ae9a215d2e670a3941e15e0686eb4c0a1b899f8a362a743a707a9792ff306e25 +size 39293 diff --git a/marked/Rel-16/29_series/29598/8ed7f57cc317f6574bec781d01ae6ad2_img.jpg b/marked/Rel-16/29_series/29598/8ed7f57cc317f6574bec781d01ae6ad2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9217f2be318ce2552e0e8ca9e3df04d8f9dbba2a --- /dev/null +++ b/marked/Rel-16/29_series/29598/8ed7f57cc317f6574bec781d01ae6ad2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f8bcc46583be5400e33c3ca10e5f22a8326b1dc161ee95e7fc5ba8135df9e6de +size 49215 diff --git a/marked/Rel-16/29_series/29598/9ae17964ddd9b814c7d905b1af2fddf2_img.jpg b/marked/Rel-16/29_series/29598/9ae17964ddd9b814c7d905b1af2fddf2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..84617725c49f56bbc0fb86aeace7647d5aef7135 --- /dev/null +++ b/marked/Rel-16/29_series/29598/9ae17964ddd9b814c7d905b1af2fddf2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:785899b3283aae5f421ad1eb8c43ce3cc4df61c1dfd1bc94a7dec6fcdcc64991 +size 26885 diff --git a/marked/Rel-16/29_series/29598/9b62a616c7a1097c5da57f001ab6dd64_img.jpg b/marked/Rel-16/29_series/29598/9b62a616c7a1097c5da57f001ab6dd64_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..dfd8eeee461c59f86dd7f227dd1df1ddbbbbfcc6 --- /dev/null +++ b/marked/Rel-16/29_series/29598/9b62a616c7a1097c5da57f001ab6dd64_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0f431d848406d682ea415fd8c4249aaee5fb7a32714eaf8ad312c8c2d63926e4 +size 31248 diff --git a/marked/Rel-16/29_series/29598/9c63078ad5b9dbe6d2822eca121fae77_img.jpg b/marked/Rel-16/29_series/29598/9c63078ad5b9dbe6d2822eca121fae77_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5e16b8a3468b771453e62eb86e159ea73d3b1388 --- /dev/null +++ b/marked/Rel-16/29_series/29598/9c63078ad5b9dbe6d2822eca121fae77_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5cb3b7e427bf4a015ae8674e0cc099dfaeb28d8935cdabdfbf9d118394901760 +size 3614 diff --git a/marked/Rel-16/29_series/29598/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg b/marked/Rel-16/29_series/29598/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b2c34104af558c079a6ad7849552f446b69d47c0 --- /dev/null +++ b/marked/Rel-16/29_series/29598/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f1c1ee70ee614007967969f12963449e16166d267d4ee40f00c4d2936939c779 +size 26375 diff --git a/marked/Rel-16/29_series/29598/b882c54d92390b4ca523f230e3e07617_img.jpg b/marked/Rel-16/29_series/29598/b882c54d92390b4ca523f230e3e07617_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2a1bd21eea91d024c78a3e0ecf57efca04d88c27 --- /dev/null +++ b/marked/Rel-16/29_series/29598/b882c54d92390b4ca523f230e3e07617_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:924a306a16350b07a0e4d647d31a7ccde3f00e5bfeb18ad793f34e607c137020 +size 8517 diff --git a/marked/Rel-16/29_series/29598/c036e2540a94b31357ceb0002f0cacab_img.jpg b/marked/Rel-16/29_series/29598/c036e2540a94b31357ceb0002f0cacab_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0ca039796d30402baa51be78182db957c88d3d7b --- /dev/null +++ b/marked/Rel-16/29_series/29598/c036e2540a94b31357ceb0002f0cacab_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:221c454b4b2012b35e9e1e5694306ece9ae44e5f90eba7cca3100b57d5442190 +size 29226 diff --git a/marked/Rel-16/29_series/29598/df1d0e45191302de72176e4390224c16_img.jpg b/marked/Rel-16/29_series/29598/df1d0e45191302de72176e4390224c16_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6a210afb711706f063f6aa67f3ca39d2d01ff8f0 --- /dev/null +++ b/marked/Rel-16/29_series/29598/df1d0e45191302de72176e4390224c16_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:20c46988eb54b76d583f43fd9c04df0a24a9a67ccc9dc99ae1f330c5289d65a5 +size 34376 diff --git a/marked/Rel-16/29_series/29598/e180f2b5fcbe8001554a7c0677cd3f82_img.jpg b/marked/Rel-16/29_series/29598/e180f2b5fcbe8001554a7c0677cd3f82_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..fec1f8e7f7cd7ef3f19c37420cf1345f806edb69 --- /dev/null +++ b/marked/Rel-16/29_series/29598/e180f2b5fcbe8001554a7c0677cd3f82_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5f085f85766e1044f9cc980f0e832bf51513e53b4541bfa1bd27a326928efe01 +size 36242 diff --git a/marked/Rel-16/29_series/29598/e4c6fa93821e3546ee9fcae897ae2771_img.jpg b/marked/Rel-16/29_series/29598/e4c6fa93821e3546ee9fcae897ae2771_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d15c72c96a16f16aec9072615e546988f7f75a1c --- /dev/null +++ b/marked/Rel-16/29_series/29598/e4c6fa93821e3546ee9fcae897ae2771_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f1439c63644509f446e17c3f8b43e915a7ef24315165471aa8ba817c5e40bd10 +size 26321 diff --git a/marked/Rel-16/29_series/29598/e636d7ccca0ad14c6b95201404324823_img.jpg b/marked/Rel-16/29_series/29598/e636d7ccca0ad14c6b95201404324823_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..60635c3e281217dc30092918291bca26dd447c56 --- /dev/null +++ b/marked/Rel-16/29_series/29598/e636d7ccca0ad14c6b95201404324823_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2c6374a27709e6fa604b44ab91354a97a5bf3c07fa3fb0ad41e520ba46ca80c4 +size 39386 diff --git a/marked/Rel-16/29_series/29598/e6df2733626a85205c1db682e6259c46_img.jpg b/marked/Rel-16/29_series/29598/e6df2733626a85205c1db682e6259c46_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e06388b6298cdadb70bbcf9e66b7e5f0dcf048af --- /dev/null +++ b/marked/Rel-16/29_series/29598/e6df2733626a85205c1db682e6259c46_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d96d858183e7fceb2100d0290eae0a584cb73c0147b98f0af8709398f7380ddd +size 8605 diff --git a/marked/Rel-16/29_series/29598/f388cbdae6f0ef3aeb96fdf9984d1284_img.jpg b/marked/Rel-16/29_series/29598/f388cbdae6f0ef3aeb96fdf9984d1284_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..fe7aa381d2b97aae6c1e671a2716c85f86279c69 --- /dev/null +++ b/marked/Rel-16/29_series/29598/f388cbdae6f0ef3aeb96fdf9984d1284_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:31bcdceacee0644ec33a35dd60d6ea44c603e4bdf74646b1f1d41aeb2a7d29ba +size 39153 diff --git a/marked/Rel-16/29_series/29598/fbfa653853daf5541118a9ddecb92284_img.jpg b/marked/Rel-16/29_series/29598/fbfa653853daf5541118a9ddecb92284_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ab4874cd169311285b6c7f4903d14f693673f699 --- /dev/null +++ b/marked/Rel-16/29_series/29598/fbfa653853daf5541118a9ddecb92284_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4db161af7dc0860130b4989fb5596e04099f4065a90d3047b1ffc25fe551dbab +size 29958 diff --git a/marked/Rel-16/29_series/29598/ff0952ef692c9d960ce5f6708bcc9711_img.jpg b/marked/Rel-16/29_series/29598/ff0952ef692c9d960ce5f6708bcc9711_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..bd5cc994b3499501857e77f8bc243e38f6d67d17 --- /dev/null +++ b/marked/Rel-16/29_series/29598/ff0952ef692c9d960ce5f6708bcc9711_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7b6493cc0df60c47e5d5af2cdf9ba4b44c78edb75627e954c6526b294c882247 +size 29565 diff --git a/marked/Rel-16/29_series/29598/raw.md b/marked/Rel-16/29_series/29598/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..bd0e14733541510588ec2e33b0e1524f9bc7bcc8 --- /dev/null +++ b/marked/Rel-16/29_series/29598/raw.md @@ -0,0 +1,4435 @@ + + +# 3GPP TS 29.598 V16.6.0 (2021-09) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Unstructured Data Storage Services Stage 3; (Release 16)** + +![5G logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The 5G logo, featuring the text "5G" in a bold, black, sans-serif font. Above the "5G" text are three green curved lines representing signal waves. + +5G logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, featuring the text "3GPP" in a bold, black, sans-serif font. Below the "3GPP" text is a red signal icon consisting of three curved lines. Below the icon, the text "A GLOBAL INITIATIVE" is written in a smaller, black, sans-serif font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + + + +## --- **Copyright Notification** + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2021, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTSTM is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|----------------------------------------------------------------|----| +| Foreword ..... | 6 | +| 1 Scope..... | 8 | +| 2 References..... | 8 | +| 3 Definitions of terms, symbols and abbreviations..... | 9 | +| 3.1 Terms..... | 9 | +| 3.2 Symbols..... | 9 | +| 3.3 Abbreviations ..... | 9 | +| 4 Overview..... | 9 | +| 5 Services offered by the UDSF ..... | 10 | +| 5.1 Introduction ..... | 10 | +| 5.2 Nudsf_DataRepository Service..... | 10 | +| 5.2.1 Service Description ..... | 10 | +| 5.2.2 Service Operations..... | 10 | +| 5.2.2.1 Introduction..... | 10 | +| 5.2.2.2 Query ..... | 11 | +| 5.2.2.2.1 General ..... | 11 | +| 5.2.2.2.2 Record Retrieval..... | 11 | +| 5.2.2.2.3 Meta Retrieval..... | 11 | +| 5.2.2.2.4 Blocks Retrieval ..... | 12 | +| 5.2.2.2.5 Block Retrieval..... | 12 | +| 5.2.2.2.6 Search..... | 13 | +| 5.2.2.2.7 Subscriptions Retrieval ..... | 13 | +| 5.2.2.2.8 Individual Subscription Retrieval..... | 14 | +| 5.2.2.3 Create ..... | 14 | +| 5.2.2.3.1 General ..... | 14 | +| 5.2.2.3.2 Record Create..... | 15 | +| 5.2.2.3.3 Block Create..... | 15 | +| 5.2.2.4 Update..... | 16 | +| 5.2.2.4.1 General ..... | 16 | +| 5.2.2.4.2 Record Update..... | 16 | +| 5.2.2.4.3 Block Update..... | 17 | +| 5.2.2.4.4 Meta Update..... | 17 | +| 5.2.2.4.5 Subscription Notification Update..... | 18 | +| 5.2.2.4.6 Subscription Notification Update using PUT..... | 18 | +| 5.2.2.5 Delete..... | 19 | +| 5.2.2.5.1 General ..... | 19 | +| 5.2.2.5.2 Record Delete..... | 19 | +| 5.2.2.5.3 Block Delete..... | 20 | +| 5.2.2.6 Notify ..... | 20 | +| 5.2.2.6.1 General ..... | 20 | +| 5.2.2.6.2 Record Expiry Notify ..... | 20 | +| 5.2.2.6.3 Notification due to Data Change..... | 21 | +| 5.2.2.7 Subscribe..... | 21 | +| 5.2.2.7.1 General ..... | 21 | +| 5.2.2.7.2 Subscription to notifications of data change ..... | 21 | +| 5.2.2.8 Unsubscribe ..... | 22 | +| 5.2.2.8.1 General ..... | 22 | +| 5.2.2.8.2 Unsubscription to notifications of data change ..... | 22 | +| 6 API Definitions ..... | 23 | +| 6.1 Nudsf_DataRepository Service API..... | 23 | +| 6.1.1 Introduction ..... | 23 | +| 6.1.2 Usage of HTTP..... | 23 | +| 6.1.2.1 General..... | 23 | + +| | | | +|-------------|-------------------------------------------------------|----| +| 6.1.2.2 | HTTP standard headers..... | 24 | +| 6.1.2.2.1 | General ..... | 24 | +| 6.1.2.2.2 | Content type ..... | 24 | +| 6.1.2.2.3 | Cache-Control ..... | 24 | +| 6.1.2.2.4 | ETag ..... | 24 | +| 6.1.2.2.5 | If-None-Match..... | 24 | +| 6.1.2.2.6 | If-Match..... | 24 | +| 6.1.2.2.7 | Last-Modified..... | 24 | +| 6.1.2.2.8 | If-Modified-Since..... | 25 | +| 6.1.2.2.9 | When to Use Entity-Tags and Last-Modified Dates ..... | 25 | +| 6.1.2.2.10 | Content-Location..... | 25 | +| 6.1.2.3 | HTTP custom headers..... | 25 | +| 6.1.2.4 | HTTP multipart messages..... | 25 | +| 6.1.2.4.1 | General ..... | 25 | +| 6.1.2.4.2 | Record ..... | 25 | +| 6.1.2.4.3 | BlockCollection..... | 26 | +| 6.1.2.4.4 | RecordNotification ..... | 26 | +| 6.1.3 | Resources..... | 27 | +| 6.1.3.1 | Overview..... | 27 | +| 6.1.3.2 | Resource: RecordCollection (Collection)..... | 28 | +| 6.1.3.2.1 | Description ..... | 28 | +| 6.1.3.2.2 | Resource Definition..... | 28 | +| 6.1.3.2.3 | Resource Standard Methods..... | 29 | +| 6.1.3.2.3.1 | GET ..... | 29 | +| 6.1.3.3 | Resource: Record (Document)..... | 29 | +| 6.1.3.3.1 | Description ..... | 29 | +| 6.1.3.3.2 | Resource Definition..... | 30 | +| 6.1.3.3.3 | Resource Standard Methods..... | 30 | +| 6.1.3.3.3.1 | GET ..... | 30 | +| 6.1.3.3.3.2 | PUT..... | 30 | +| 6.1.3.3.3.3 | DELETE ..... | 31 | +| 6.1.3.4 | Resource: Meta (Document)..... | 32 | +| 6.1.3.4.1 | Description ..... | 32 | +| 6.1.3.4.2 | Resource Definition..... | 32 | +| 6.1.3.4.3 | Resource Standard Methods..... | 33 | +| 6.1.3.4.3.1 | GET ..... | 33 | +| 6.1.3.4.3.2 | PATCH..... | 33 | +| 6.1.3.5 | Resource: BlockCollection (Collection)..... | 34 | +| 6.1.3.5.1 | Description ..... | 34 | +| 6.1.3.5.2 | Resource Definition..... | 34 | +| 6.1.3.5.3 | Resource Standard Methods..... | 34 | +| 6.1.3.5.3.1 | GET ..... | 34 | +| 6.1.3.6 | Resource: Block (Document)..... | 35 | +| 6.1.3.6.1 | Description ..... | 35 | +| 6.1.3.6.2 | Resource Definition..... | 35 | +| 6.1.3.6.3 | Resource Standard Methods..... | 35 | +| 6.1.3.6.3.1 | GET ..... | 35 | +| 6.1.3.6.3.2 | PUT..... | 36 | +| 6.1.3.6.3.3 | DELETE ..... | 37 | +| 6.1.3.7 | Resource: NotificationSubscriptions ..... | 38 | +| 6.1.3.7.1 | Description ..... | 38 | +| 6.1.3.7.2 | Resource Definition..... | 38 | +| 6.1.3.7.3 | Standard Methods..... | 38 | +| 6.1.3.7.3.2 | GET ..... | 38 | +| 6.1.3.8 | Resource: IndividualNotificationSubscription ..... | 39 | +| 6.1.3.8.1 | Description ..... | 39 | +| 6.1.3.8.2 | Resource Definition..... | 39 | +| 6.1.3.8.3 | Resource Standard Methods..... | 39 | +| 6.1.3.8.3.1 | DELETE ..... | 39 | +| 6.1.3.8.3.2 | PATCH..... | 40 | +| 6.1.3.8.3.3 | GET ..... | 41 | +| 6.1.3.8.3.4 | PUT..... | 41 | + +| | | | +|-------------------------------------------------------------|----------------------------------------------------------------------------------|-----------| +| 6.1.4 | Custom Operations without associated resources ..... | 42 | +| 6.1.5 | Notifications ..... | 42 | +| 6.1.5.1 | General..... | 42 | +| 6.1.5.2 | Timer Expiry Notification ..... | 42 | +| 6.1.5.2.1 | Description ..... | 42 | +| 6.1.5.2.2 | Target URI..... | 42 | +| 6.1.5.2.3 | Standard Methods..... | 43 | +| 6.1.5.2.3.1 | POST ..... | 43 | +| 6.1.5.3 | Notification due to Data Change ..... | 43 | +| 6.1.5.3.1 | Description ..... | 43 | +| 6.1.5.3.2 | Target URI..... | 43 | +| 6.1.5.3.3 | Standard Methods..... | 43 | +| 6.1.5.3.3.1 | POST ..... | 43 | +| 6.1.6 | Data Model ..... | 44 | +| 6.1.6.1 | General..... | 44 | +| 6.1.6.2 | Structured data types..... | 44 | +| 6.1.6.2.1 | Introduction ..... | 44 | +| 6.1.6.2.2 | Type: RecordSearchResult..... | 45 | +| 6.1.6.2.3 | Type: RecordMeta..... | 45 | +| 6.1.6.2.4 | Type: RecordBody ..... | 45 | +| 6.1.6.2.5 | Type: Record ..... | 45 | +| 6.1.6.2.6 | Type: BlockBody ..... | 45 | +| 6.1.6.2.7 | Type: Block..... | 46 | +| 6.1.6.2.8 | Type: SearchCondition..... | 46 | +| 6.1.6.2.9 | SearchComparison ..... | 46 | +| 6.1.6.2.10 | Type: NotificationSubscription ..... | 47 | +| 6.1.6.2.11 | Type: RecordNotification..... | 47 | +| 6.1.6.2.12 | Type: NotificationDescription..... | 47 | +| 6.1.6.2.13 | Type: SubscriptionFilter..... | 48 | +| 6.1.6.2.14 | Type: ClientId ..... | 48 | +| 6.1.6.3 | Simple data types and enumerations..... | 48 | +| 6.1.6.3.1 | Introduction ..... | 48 | +| 6.1.6.3.2 | Simple data types ..... | 49 | +| 6.1.6.3.3 | Enumeration: ComparisonOperator ..... | 49 | +| 6.1.6.3.4 | Enumeration: ConditionOperator..... | 49 | +| 6.1.6.3.5 | Enumeration: RecordOperation..... | 49 | +| 6.1.6.4 | Data types describing alternative data types or combinations of data types ..... | 50 | +| 6.1.6.4.1 | Type: SearchExpression..... | 50 | +| 6.1.7 | Error Handling ..... | 50 | +| 6.1.7.1 | General..... | 50 | +| 6.1.7.2 | Protocol Errors ..... | 50 | +| 6.1.7.3 | Application Errors..... | 50 | +| 6.1.8 | Feature negotiation..... | 50 | +| 6.1.9 | Security..... | 51 | +| Annex A (normative): OpenAPI specification..... | | 52 | +| A.1 | General ..... | 52 | +| A.2 | Nudsf_DataRepository API..... | 52 | +| Annex B (informative): Search Examples..... | | 76 | +| Annex C (informative): HTTP Multipart Examples ..... | | 77 | +| C.1 | General ..... | 77 | +| C.2 | Example HTTP multipart Record ..... | 77 | +| C.3 | Example HTTP multipart BlockCollection..... | 77 | +| C.4 | Example HTTP multipart RecordNotification ..... | 78 | +| Annex D (informative): Change history..... | | 79 | + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document specifies the stage 3 protocol and data model for the Nudsf Service Based Interface. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the UDSF. + +The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] OpenAPI: "OpenAPI 3.0.0 Specification", +- [7] 3GPP TR 21.900: "Technical Specification Group working methods". +- [8] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [9] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [10] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". +- [11] IETF RFC 7540: "Hypertext Transfer Protocol Version 2 (HTTP/2)". +- [12] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [13] IETF RFC 7807: "Problem Details for HTTP APIs". +- [14] IETF RFC 6902: "JavaScript Object Notation (JSON) Patch". +- [15] IETF RFC 7231: "Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content". +- [16] IETF RFC 7232: "Hypertext Transfer Protocol (HTTP/1.1): Conditional Requests". +- [17] IETF RFC 7234: "Hypertext Transfer Protocol (HTTP/1.1): Caching". +- [18] ISO/IEC 14977: "Information technology – Syntactic metalanguage - Extended BNF". +- [19] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". + +- [20] IETF RFC 2045: "Multipart Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies". +- [21] IETF RFC 2046: "Multipart Internet Mail Extensions (MIME) Part Two: Media Types". +- [22] IETF RFC 3986: "Uniform Resource Identifier (URI): Generic Syntax". + +# --- 3 Definitions of terms, symbols and abbreviations + +## 3.1 Terms + +void + +## 3.2 Symbols + +void + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|------|---------------------------------------| +| 5GC | 5G Core Network | +| BNF | Backus-Naur Form | +| EBNF | Extended BNF | +| CP | Control Plane | +| MIME | Multipurpose Internet Mail Extensions | +| NF | Network Function | +| UDSF | Unstructured Data Storage Function | + +# --- 4 Overview + +The UDSF, as depicted in Figure 4.1-1 below, is described in clause 4.2.5 of 3GPP TS 23.501 [2]. Any of the 5GS NFs can make use of the UDSF to store and retrieve unstructured data, i.e., data that is not defined in 3GPP specifications. The UDSF is deployed in the same network where the CP NF is located and the same UDSF may be shared by all the NFs in the PLMN to store/retrieve their respective data or an NF may have its own UDSF depending on operator configuration. + +NOTE 1: Structured data in this specification refers to data for which the structure is defined in 3GPP specifications. Unstructured data refers to data for which the structure is not defined in 3GPP specifications. + +![Reference model diagram showing Any NF connected to UDSF via N18/Nudsf interface.](e6df2733626a85205c1db682e6259c46_img.jpg) + +``` + +graph LR + AnyNF[Any NF] --- N18Nudsf((N18/Nudsf)) + N18Nudsf --- UDSF[UDSF] + +``` + +Reference model diagram showing Any NF connected to UDSF via N18/Nudsf interface. + +Figure 4.1-1: Reference model – UDSF + +# 5 Services offered by the UDSF + +## 5.1 Introduction + +The UDSF offers the following services via the Nudsf service based interface: + +- Nudsf\_DataRepository Service + +NOTE: This service corresponds to the Nudsf\_UnstructuredDataManagement service in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]. + +Table 5.1-1 summarizes the corresponding APIs defined for this specification. + +Table 5.1-1: API Descriptions + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex | +|----------------------|--------|------------------------------|-----------------------------------|----------|-------| +| Nudsf_DataRepository | 6.1 | UDSF Data Repository Service | TS29598_Nudsf_DataRepository.yaml | nudsf-dr | A.2 | + +## 5.2 Nudsf\_DataRepository Service + +### 5.2.1 Service Description + +The UDSF is acting as an NF Service Producer. It provides UDSF data repository service to the NF service consumer. Any NF may use the UDSF to store unstructured data. + +NOTE 1: Structured data in this specification refers to data for which the structure is defined in 3GPP specifications. Unstructured data refers to data for which the structure is not defined in 3GPP specifications. + +### 5.2.2 Service Operations + +#### 5.2.2.1 Introduction + +For the Nudsf\_DataRepository service, the following service operations are defined: + +- Query +- Create + +- Update +- Delete +- Notify +- Subscribe +- Unsubscribe + +#### 5.2.2.2 Query + +##### 5.2.2.2.1 General + +The following procedures using the Query service operation are supported: + +- Record Retrieval +- Meta Retrieval +- Blocks Retrieval +- Block Retrieval +- Search +- Subscriptions Retrieval +- Individual Subscription Retrieval + +##### 5.2.2.2.2 Record Retrieval + +Figure 5.2.2.2.2-1 shows a scenario where the NF service consumer sends a request to the UDSF to retrieve a record that matches the provided recordId and optionally includes the query parameter supported-features. + +![Sequence diagram showing the interaction between an NF service consumer and a UDSF for Record Retrieval. The consumer sends a GET request to the UDSF, and the UDSF responds with either a 200 OK (Record) or a 404 Not Found.](18442e4e239480f0c3c95b547aa8fde2_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant UDSF + Note left of NF service consumer: + NF service consumer->>UDSF: 1. GET.../records/{recordId} + Note right of UDSF: + UDSF-->>NF service consumer: 2a. 200 OK (Record) + UDSF-->>NF service consumer: 2b. 404 Not Found +``` + +Sequence diagram showing the interaction between an NF service consumer and a UDSF for Record Retrieval. The consumer sends a GET request to the UDSF, and the UDSF responds with either a 200 OK (Record) or a 404 Not Found. + +**Figure 5.2.2.2.2-1: Requesting a Record** + +1. The NF service consumer (any NF) sends a GET request to the resource indicated by recordId. +- 2a. On success, the UDSF responds with "200 OK" with the message body containing the record. +- 2b. If the record for the given recordId does not exist in the UDSF, the HTTP status code "404 Not Found" shall be returned optionally including additional error information in the response body (in the ProblemDetails element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +##### 5.2.2.2.3 Meta Retrieval + +Figure 5.2.2.2.3-1 shows a scenario where the NF service consumer sends a request to the UDSF to retrieve meta data associated with the provided recordId and optionally includes the query parameter supported-features. + +![Sequence diagram for Requesting Meta for a Record](27b06ec9f42b5d727a2630f61a5f1861_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant UDSF + Note left of NF service consumer: + NF service consumer->>UDSF: 1. GET.../records/{recordId}/meta + Note right of UDSF: + UDSF-->>NF service consumer: 2a. 200 OK (RecordMeta) + Note right of UDSF: + UDSF-->>NF service consumer: 2b. 404 Not Found +``` + +The diagram illustrates a sequence of interactions between an NF service consumer and a UDSF. The consumer sends a GET request to the meta resource for a specific record. The UDSF responds with either a 200 OK status containing the RecordMeta or a 404 Not Found status if the record does not exist. + +Sequence diagram for Requesting Meta for a Record + +**Figure 5.2.2.2.3-1: Requesting Meta for a Record** + +1. The NF service consumer (any NF) sends a GET request to the meta resource associated with the record indicated by recordId. +- 2a. On success, the UDSF responds with "200 OK" with the message body containing the RecordMeta. +- 2b. If the record for the given recordId and thus the RecordMeta does not exist in the UDSF, the HTTP status code "404 Not Found" shall be returned optionally including additional error information in the response body (in the ProblemDetails element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +##### 5.2.2.2.4 Blocks Retrieval + +Figure 5.2.2.2.4-1 shows a scenario where the NF service consumer sends a request to the UDSF to retrieve (all) the blocks associated with the provided recordId and optionally includes the query parameter supported-features. + +![Sequence diagram for Requesting Blocks](fbfa653853daf5541118a9ddecb92284_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant UDSF + Note left of NF service consumer: + NF service consumer->>UDSF: 1. GET.../records/{recordId}/blocks + Note right of UDSF: + UDSF-->>NF service consumer: 2a. 200 OK (BlockBody [1..n]) + Note right of UDSF: + UDSF-->>NF service consumer: 2b. 204 No Content +``` + +The diagram illustrates a sequence of interactions between an NF service consumer and a UDSF. The consumer sends a GET request to the blocks resource for a specific record. The UDSF responds with either a 200 OK status containing the BlockBody (a list of blocks) or a 204 No Content status if the record does not exist. + +Sequence diagram for Requesting Blocks + +**Figure 5.2.2.2.4-1: Requesting Blocks** + +1. The NF service consumer (any NF) sends a GET request to the resource indicated by recordId. +- 2a. On success, the UDSF responds with "200 OK" with the message body containing the Blocks associated with the record. +- 2b. If a Block for the given recordId does not exist in the UDSF, the HTTP status code "204 No Content" shall be returned. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +##### 5.2.2.2.5 Block Retrieval + +Figure 5.2.2.2.5-1 shows a scenario where the NF service consumer sends a request to the UDSF to retrieve a single block associated with the provided recordId and blockId and optionally includes the query parameter supported-features. + +![Sequence diagram for Requesting a Block](ff0952ef692c9d960ce5f6708bcc9711_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant UDSF + NF service consumer->>UDSF: 1. GET../records/{recordId}/blocks/{blockId} + UDSF-->>NF service consumer: 2a. 200 OK (BlockBody) + UDSF-->>NF service consumer: 2b. 404 Not Found + +``` + +The diagram shows a sequence where an NF service consumer sends a GET request for a specific block identified by recordId and blockId to the UDSF. The UDSF responds with either a 200 OK containing the BlockBody or a 404 Not Found error. + +Sequence diagram for Requesting a Block + +**Figure 5.2.2.2.5-1: Requesting a Block** + +1. The NF service consumer (any NF) sends a GET request to the resource indicated by recordId and blockId. +- 2a. On success, the UDSF responds with "200 OK" with the message body containing the Block associated with the blockId. +- 2b. If the Block for the given recordId and blockId does not exist in the UDSF, the HTTP status code "404 Not Found" shall be returned optionally including additional error information in the response body (in the ProblemDetails element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +##### 5.2.2.2.6 Search + +Figure 5.2.2.2.6-1 shows a scenario where the NF service consumer sends a request to the UDSF to search a record that matches the provided search criteria. + +The request contains the query parameters filter and optionally supported-features, limit-range, and count-indicator. + +![Sequence diagram for Searching for Records](2e399449b7f62d40167a65ca88888917_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant UDSF + NF service consumer->>UDSF: 1. GET../records?filter + UDSF-->>NF service consumer: 2a. 200 OK (RecordSearchResult) + UDSF-->>NF service consumer: 2b. 204 No Content + +``` + +The diagram shows a sequence where an NF service consumer sends a GET request with a filter query parameter to the UDSF. The UDSF responds with either a 200 OK containing a RecordSearchResult or a 204 No Content status. + +Sequence diagram for Searching for Records + +**Figure 5.2.2.2.6-1: Searching for Records** + +1. The NF service consumer (any NF) sends a GET request to the Records resource with the filter query parameter indicating the search criteria. +- 2a. On success, the UDSF responds with "200 OK" with the message body containing the RecordSearchResult. +- 2b. If the UDSF is not able to return any record for the given search criteria, the HTTP status code "204 No Content" shall be returned. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +##### 5.2.2.2.7 Subscriptions Retrieval + +Figure 5.2.2.2.7-1 shows a scenario where the NF service consumer sends a request to the UDSF to retrieve all subscriptions associated with the provided storageId and optionally includes the query parameter supported-features and limit-range. + +![Sequence diagram for Requesting Subscriptions](a33da0f14e456f92539ce3e9b7d81f9a_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant UDSF + Note left of NF service consumer: + NF service consumer->>UDSF: 1. GET.../{storageId}/subs-to-notify + UDSF-->>NF service consumer: 2. 200 OK (NotificationSubscriptions) +``` + +A sequence diagram showing the interaction between an NF service consumer and a UDSF. The NF service consumer sends a GET request to the UDSF for the resource {storageId}/subs-to-notify. The UDSF responds with a 200 OK status and a NotificationSubscriptions message body. + +Sequence diagram for Requesting Subscriptions + +**Figure 5.2.2.2.7-1: Requesting Subscriptions** + +1. The NF service consumer (any NF) sends a GET request to the resource indicated by the storageId. +2. On success, the UDSF responds with "200 OK" with the message body containing the NotificationSubscriptions associated with the storageId (if any). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +##### 5.2.2.2.8 Individual Subscription Retrieval + +Figure 5.2.2.2.8-1 shows a scenario where the NF service consumer sends a request to the UDSF to retrieve a subscription associated with the provided storageId and subscriptionId. + +![Sequence diagram for Requesting an Individual Subscription](c036e2540a94b31357ceb0002f0cacab_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant UDSF + Note left of NF service consumer: + NF service consumer->>UDSF: 1. GET.../{storageId}/subs-to-notify/{subscriptionId} + UDSF-->>NF service consumer: 2. 200 OK (NotificationSubscription) +``` + +A sequence diagram showing the interaction between an NF service consumer and a UDSF. The NF service consumer sends a GET request to the UDSF for the resource {storageId}/subs-to-notify/{subscriptionId}. The UDSF responds with a 200 OK status and a NotificationSubscription message body. + +Sequence diagram for Requesting an Individual Subscription + +**Figure 5.2.2.2.8-1: Requesting an Individual Subscription** + +1. The NF service consumer (any NF) sends a GET request to the resource indicated by the storageId and the subscriptionId. +- 2a. On success, the UDSF responds with "200 OK" with the message body containing the NotificationSubscription. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +#### 5.2.2.3 Create + +##### 5.2.2.3.1 General + +The following procedures using the Create service operation are supported: + +- Record Create +- Block Create + +##### 5.2.2.3.2 Record Create + +Figure 5.2.2.3.2-1 shows a scenario where the NF service consumer sends a request to the UDSF to create a record with the provided recordId. + +The request contains the recordId and optionally the query parameters supported-features and get-previous. + +![Sequence diagram for Record Create](9ae17964ddd9b814c7d905b1af2fddf2_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant UDSF + Note left of NF service consumer: + NF service consumer->>UDSF: 1. PUT../records/{recordId}/(Record) + Note right of UDSF: + UDSF-->>NF service consumer: 2a. 201 Created (RecordBody) +``` + +The diagram illustrates the interaction for Record Create. It features two lifelines: 'NF service consumer' on the left and 'UDSF' on the right. A solid arrow labeled '1. PUT../records/{recordId}/(Record)' points from the consumer to the UDSF. A return arrow labeled '2a. 201 Created (RecordBody)' points from the UDSF back to the consumer. + +Sequence diagram for Record Create + +**Figure 5.2.2.3.2-1: Create a Record** + +1. The NF service consumer (any NF) sends a PUT request to create the resource indicated by recordId. The request body contains the meta, zero or more blocks. The record meta information is mandatory and shall be the first part and the remaining parts of the request body (if any) shall be child blocks. If the record meta information is received with record expiry details, UDSF shall create an implicit subscription locally and notify the NF service consumer on record expiry. +- 2a. On success, "201 Created" shall be returned, the payload body of the PUT response should contain the representation of the created resource, and the "Location" header shall be present and shall contain the URI of the created resource. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PUT response body. + +##### 5.2.2.3.3 Block Create + +Figure 5.2.2.3.3-1 shows a scenario where the NF service consumer sends a request to the UDSF to create a block with the provided blockId. + +The request contains the blockId and optionally the query parameters supported-features and get-previous. + +![Sequence diagram for Block Create](e4c6fa93821e3546ee9fcae897ae2771_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant UDSF + Note left of NF service consumer: + NF service consumer->>UDSF: 1. PUT../records/{recordId}/blocks/{blockId} (data) + Note right of UDSF: + UDSF-->>NF service consumer: 2a. 201 Created +``` + +The diagram illustrates the interaction for Block Create. It features two lifelines: 'NF service consumer' on the left and 'UDSF' on the right. A solid arrow labeled '1. PUT../records/{recordId}/blocks/{blockId} (data)' points from the consumer to the UDSF. A return arrow labeled '2a. 201 Created' points from the UDSF back to the consumer. + +Sequence diagram for Block Create + +**Figure 5.2.2.3.3-1: Create a Block** + +1. The NF service consumer (any NF) sends a PUT request to create the resource indicated by blockId. +- 2a. On success, "201 Created" shall be returned, the payload body of the PUT response should contain the representation of the created resource, and the "Location" header shall be present and shall contain the URI of the created resource. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PUT response body. + +#### 5.2.2.4 Update + +##### 5.2.2.4.1 General + +The following procedures using the Update service operation are supported: + +- Record Update +- Block Update +- Meta Update +- Subscription Notification Update + +##### 5.2.2.4.2 Record Update + +Figure 5.2.2.4.2-1 shows a scenario where the NF service consumer sends a request to the UDSF to update a record with the provided recordId. + +The request contains the recordId and optionally the query parameters supported-features and get-previous. + +The update shall include meta, zero or more blocks. The record meta information shall be the first part and is mandatory and the remaining parts of the body (if any) shall be interpreted as child blocks. Existing record, meta and blocks shall be discarded and the new record, meta and blocks (if any) shall be created. + +NOTE: The order of the returned blocks in the response is not guaranteed and can be different from the order used to create them. + +![Sequence diagram showing the interaction between an NF service consumer and a UDSF for updating a record. The consumer sends a PUT request to the UDSF. The UDSF responds with one of three options: 2a. 204 No Content, 2b. 200 OK (RecordBody), or 2c. 412 Precondition Failed (RecordBody).](df1d0e45191302de72176e4390224c16_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant UDSF + Note left of NF service consumer: + NF service consumer->>UDSF: 1. PUT../records/{recordId} (new data) + Note right of UDSF: + UDSF-->>NF service consumer: 2a. 204 No Content + UDSF-->>NF service consumer: 2b. 200 OK (RecordBody) + UDSF-->>NF service consumer: 2c. 412 Precondition Failed (RecordBody) + +``` + +Sequence diagram showing the interaction between an NF service consumer and a UDSF for updating a record. The consumer sends a PUT request to the UDSF. The UDSF responds with one of three options: 2a. 204 No Content, 2b. 200 OK (RecordBody), or 2c. 412 Precondition Failed (RecordBody). + +Figure 5.2.2.4.2-1: Update a record + +1. The NF service consumer shall send a PUT request to the resource representing the record that is to be updated, and may include meta, zero or more blocks. The record meta information is mandatory and shall be the first part and the remaining parts of the request body (if any) shall be child blocks. An existing record, i.e., meta and blocks shall be discarded and the new record, meta and blocks (if any) shall be created. +- 2a. On success, the UDSF shall respond with "204 No Content" if no record is returned, i.e. the get-previous query parameter was not included in the request. +- 2b. On success, the UDSF shall respond with "200 OK" if a record is returned, i.e. the get-previous query parameter was included in the request, or due to operator's policy, the ttl value in the request exceeded the maximum value allowed. +- 2c. On failure, the UDSF shall respond with "412 Precondition Failed" if one or more conditions given in the request header fields evaluated to false. The RecordBody shall include the stored Record if the get-previous query parameter was included in the request. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PUT response body. + +##### 5.2.2.4.3 Block Update + +Figure 5.2.2.4.3-1 shows a scenario where the NF service consumer sends a request to the UDSF to update a block with the provided blockId. + +The request contains the recordId, blockId and the optional query parameters supported-features, get-previous and the data that is to be updated. + +![Sequence diagram for Block Update](21ad58fee90f2be50708ff541d225507_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant UDSF + Note right of UDSF: 2a. 204 No Content + Note right of UDSF: 2b. 200 OK (BlockBody) + Note right of UDSF: 2c. 412 Precondition Failed (BlockBody) + NF service consumer->>UDSF: 1. PUT.../records/{recordId}/blocks/{blockId} (new data) + UDSF-->>NF service consumer: 2a. 204 No Content + UDSF-->>NF service consumer: 2b. 200 OK (BlockBody) + UDSF-->>NF service consumer: 2c. 412 Precondition Failed (BlockBody) +``` + +The diagram illustrates the interaction for a Block Update. It starts with the NF service consumer sending a PUT request to the UDSF. The request path is PUT.../records/{recordId}/blocks/{blockId} with new data. The UDSF then responds with one of three possible status codes: 2a. 204 No Content, 2b. 200 OK (BlockBody), or 2c. 412 Precondition Failed (BlockBody). + +Sequence diagram for Block Update + +Figure 5.2.2.4.3-1: Update a block + +1. The NF service consumer shall send a PUT request to the resource representing the block that is to be updated. +- 2a. On success, the UDSF shall respond with "204 No Content" if no record is returned, i.e. the get-previous query parameter was not included in the request. +- 2b. On success, the UDSF shall respond with "200 OK" if a record is returned, i.e. the get-previous query parameter was included in the request. +- 2c. On failure, the UDSF shall respond with "412 Precondition Failed" if one or more conditions given in the request header fields evaluated to false. The BlockBody shall be included with the stored Block if the get-previous query parameter was included in the request. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PUT response body. + +##### 5.2.2.4.4 Meta Update + +Figure 5.2.2.4.4-1 shows a scenario where the NF service consumer sends a request to the UDSF to update the meta data associated with the provided recordId and optionally the query parameter supported-features and the data that is to be updated. + +![Sequence diagram for Meta Update](9b62a616c7a1097c5da57f001ab6dd64_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant UDSF + Note right of UDSF: 2a. 204 No Content + Note right of UDSF: 2b. 200 OK (PatchResult) + Note right of UDSF: 2c. 404 Not Found + NF service consumer->>UDSF: 1. PATCH.../records/{recordId}/meta + UDSF-->>NF service consumer: 2a. 204 No Content + UDSF-->>NF service consumer: 2b. 200 OK (PatchResult) + UDSF-->>NF service consumer: 2c. 404 Not Found +``` + +The diagram illustrates the interaction for a Meta Update. It starts with the NF service consumer sending a PATCH request to the UDSF. The request path is PATCH.../records/{recordId}/meta. The UDSF then responds with one of three possible status codes: 2a. 204 No Content, 2b. 200 OK (PatchResult), or 2c. 404 Not Found. + +Sequence diagram for Meta Update + +Figure 5.2.2.4.4-1: Update meta + +1. The NF service consumer shall send a PATCH request to the resource representing the meta of the record. +- 2a. On success, if all the modification instructions in the PATCH request have been implemented, the UDSF shall respond with "204 No Content". +- 2b. On partial success, i.e. if one or more modification instructions have been discarded, "200 OK" with the execution report, shall be returned. + +- 2c. On failure, the UDSF shall respond with "404 Not Found" if the record indicated by the recordId and thus the meta does not exist and may shall include the ProblemDetails. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PUT response body. + +##### 5.2.2.4.5 Subscription Notification Update + +Figure 5.2.2.4.5-1 shows a scenario where the NF service consumer sends a request to the UDSF to update the Individual Subscription Notification identified with the storageId and subscriptionId and optionally the query parameter supported-features and the data that is to be updated. + +![Sequence diagram for Figure 5.2.2.4.5-1: Update Subscription Notification. The diagram shows a message flow between an NF service consumer and a UDSF. The consumer sends a PATCH request to the UDSF. The UDSF responds with either a 204 No Content or a 200 OK (PatchResult).](77464a47f104d0d647b2414591137b64_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant UDSF + Note left of NF service consumer: 1. PATCH.../{storageId}/subs-to-notify/{subscriptionId} + NF service consumer->>UDSF: 1. PATCH.../{storageId}/subs-to-notify/{subscriptionId} + Note right of UDSF: 2a. 204 No Content +2b. 200 OK (PatchResult) + UDSF-->>NF service consumer: 2a. 204 No Content +2b. 200 OK (PatchResult) + +``` + +Sequence diagram for Figure 5.2.2.4.5-1: Update Subscription Notification. The diagram shows a message flow between an NF service consumer and a UDSF. The consumer sends a PATCH request to the UDSF. The UDSF responds with either a 204 No Content or a 200 OK (PatchResult). + +**Figure 5.2.2.4.5-1: Update Subscription Notification** + +1. The NF service consumer shall send a PATCH request to the resource representing the subscriptionId. +- 2a. On success, if all the modification instructions in the PATCH request have been implemented, the UDSF shall respond with "204 No Content". +- 2b. On partial success, i.e. if one or more modification instructions have been discarded, "200 OK" with the execution report, shall be returned. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PATCH response body. + +##### 5.2.2.4.6 Subscription Notification Update using PUT + +Figure 5.2.2.4.6-1 shows a scenario where the NF service consumer sends a request to the UDSF to update a subscription to notifications of data change using PUT. The request contains the subscriptionId and the NotificationSubscription and optionally the query parameter supported-features. + +![Sequence diagram for Figure 5.2.2.4.6-1: NF service consumer updates subscription to notifications. The diagram shows a message flow between an NF service consumer and a UDSF. The consumer sends a PUT request to the UDSF. The UDSF responds with either a 200 OK (NotificationSubscription), a 409 Conflict (Uris), or a 403 Forbidden.](7b8b192e2853ef28d28eff0241ebe86b_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant UDSF + Note left of NF service consumer: 1. PUT .../{storageId}/subs-to-notify/{subscriptionId} +(NotificationSubscription) + NF service consumer->>UDSF: 1. PUT .../{storageId}/subs-to-notify/{subscriptionId} +(NotificationSubscription) + Note right of UDSF: 2a. 200 OK (NotificationSubscription) +2b. 409 Conflict (Uris) +2c. 403 Forbidden + UDSF-->>NF service consumer: 2a. 200 OK (NotificationSubscription) +2b. 409 Conflict (Uris) +2c. 403 Forbidden + +``` + +Sequence diagram for Figure 5.2.2.4.6-1: NF service consumer updates subscription to notifications. The diagram shows a message flow between an NF service consumer and a UDSF. The consumer sends a PUT request to the UDSF. The UDSF responds with either a 200 OK (NotificationSubscription), a 409 Conflict (Uris), or a 403 Forbidden. + +**Figure 5.2.2.4.6-1: NF service consumer updates subscription to notifications** + +1. The NF service consumer sends a PUT request to the resource indicated by the storageId and the subscriptionId. The parameter clientId shall be included. If the resource indicated in URI exists and was created by the Client identified by the clientId, the UDSF shall apply the update of the subscription. + +- 2a. On success, the UDSF shall respond with "200 OK" and include the updated NotificationSubscription. The expiry attribute of the received NotificationSubscription may indicate a value or a value different from the request, if due to an operator policy, an expiry time is enforced or if the value in the request exceeded a maximum allowed expiry time. +- 2b. On failure, if one or more monitoredResourceUris from the request don't exist in the UDSF, 409 Conflict shall be returned together with the non-existing monitoredResourceUris. +- 2c. On failure, if the service operation cannot be authorized due to e.g. the resource indicated in URI exists but the clientId in the PUT request does not match the clientId of the existing resource, the UDSF shall respond with "403 Forbidden" and optionally including additional error information in the response body (in "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PUT response body. + +#### 5.2.2.5 Delete + +##### 5.2.2.5.1 General + +The following procedures using the Delete service operation are supported: + +- Record Delete +- Block Delete + +##### 5.2.2.5.2 Record Delete + +Figure 5.2.2.5.2-1 shows a scenario where the NF service consumer sends a request to the UDSF to Delete a record with the provided recordId. + +The request contains the record id and optionally the query parameters supported-features and get-previous. + +![Sequence diagram showing the interaction between an NF service consumer and a UDSF for deleting a record. The consumer sends a DELETE request to the UDSF. The UDSF responds with one of four possible status codes: 2a. 204 No Content, 2b. 200 OK (RecordBody), 2c. 404 Not Found (ProblemDetails), or 2d. 412 Precondition Failed (RecordBody).](f388cbdae6f0ef3aeb96fdf9984d1284_img.jpg) + +``` + +sequenceDiagram + participant NF as NF service consumer + participant UDSF as UDSF + Note right of UDSF: 1. DELETE.../records/{recordId} + UDSF-->>NF: 2a. 204 No Content + Note right of UDSF: 2b. 200 OK (RecordBody) + UDSF-->>NF: 2c. 404 Not Found (ProblemDetails) + Note right of UDSF: 2d. 412 Precondition Failed (RecordBody) + UDSF-->>NF: + +``` + +Sequence diagram showing the interaction between an NF service consumer and a UDSF for deleting a record. The consumer sends a DELETE request to the UDSF. The UDSF responds with one of four possible status codes: 2a. 204 No Content, 2b. 200 OK (RecordBody), 2c. 404 Not Found (ProblemDetails), or 2d. 412 Precondition Failed (RecordBody). + +Figure 5.2.2.5.2-1: Delete a record + +1. The NF service consumer shall send a DELETE request to the resource representing the record. The UDSF shall delete any resource associated with the resource (meta and block(s)). +- 2a. On success, the UDSF shall respond with "204 No Content" if no record is returned, i.e. the get-previous query parameter was not included in the request. +- 2b. On success, the UDSF shall respond with "200 OK" if a record is returned, i.e. the get-previous query parameter was included in the request. +- 2c. On failure, the UDSF shall respond with "404 Not Found" if the record does not exist and may include the ProblemDetails. +- 2d. On failure, the UDSF shall respond with "412 Precondition Failed" if one or more conditions given in the request header fields evaluated to false and the get-previous query parameter was included in the request. The RecordBody shall be included if the get-previous query parameter was included in the request. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the DELETE response body. + +##### 5.2.2.5.3 Block Delete + +Figure 5.2.2.5.3-1 shows a scenario where the NF service consumer sends a request to the UDSF to Delete a block with the provided blockId. + +The request contains the recordId, blockId and optionally the query parameters supported-features and get-previous. + +![Sequence diagram for Figure 5.2.2.5.3-1: Delete a block. The diagram shows the interaction between an NF service consumer and a UDSF. The consumer sends a DELETE request to the UDSF. The UDSF responds with one of four possible status codes: 2a. 204 No Content, 2b. 200 OK (BlockBody), 2c. 404 Not Found (ProblemDetails), or 2d. Precondition Failed (BlockBody).](e636d7ccca0ad14c6b95201404324823_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant UDSF + Note right of NF service consumer: 1. DELETE.../records/{recordId}/blocks/{blockId} + NF service consumer->>UDSF: 1. DELETE.../records/{recordId}/blocks/{blockId} + Note right of UDSF: 2a. 204 No Content + UDSF-->>NF service consumer: 2a. 204 No Content + Note right of UDSF: 2b. 200 OK (BlockBody) + UDSF-->>NF service consumer: 2b. 200 OK (BlockBody) + Note right of UDSF: 2c. 404 Not Found (ProblemDetails) + UDSF-->>NF service consumer: 2c. 404 Not Found (ProblemDetails) + Note right of UDSF: 2d. Precondition Failed (BlockBody) + UDSF-->>NF service consumer: 2d. Precondition Failed (BlockBody) + +``` + +Sequence diagram for Figure 5.2.2.5.3-1: Delete a block. The diagram shows the interaction between an NF service consumer and a UDSF. The consumer sends a DELETE request to the UDSF. The UDSF responds with one of four possible status codes: 2a. 204 No Content, 2b. 200 OK (BlockBody), 2c. 404 Not Found (ProblemDetails), or 2d. Precondition Failed (BlockBody). + +**Figure 5.2.2.5.3-1: Delete a block** + +1. The NF service consumer shall send a DELETE request to the resource representing the block. +- 2a. On success, the UDSF shall respond with "204 No Content" if no block is returned, i.e. the get-previous query parameter was not included in the request. +- 2b. On success, the UDSF shall respond with "200 OK" if a block is returned, i.e. the get-previous query parameter was included in the request. +- 2c. On failure, the UDSF shall respond with "404 Not Found" if the block does not exist and may include the ProblemDetails. +- 2d. On failure, the UDSF shall respond with "412 Precondition Failed" if one or more conditions given in the request header fields evaluated to false. The BlockBody shall be included if the get-previous query parameter was included in the request. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the DELETE response body. + +#### 5.2.2.6 Notify + +##### 5.2.2.6.1 General + +The following procedures using the Notify service operation are supported: + +- Record Expiry Notify +- Notification due to Data Change + +##### 5.2.2.6.2 Record Expiry Notify + +Figure 5.2.2.6.2-1 shows a scenario where the UDSF notifies the NF service consumer of the expired record. + +The Notify is sent by the UDSF to the NF Service Consumer when the record expires as indicated by the time to live (ttl) attribute of RecordMeta. + +![Sequence diagram for Record Expiry Notify](79e1709a7317ead45379cbb8ff3ba802_img.jpg) + +``` +sequenceDiagram + participant UDSF + participant NFSC as NF Service Consumer + Note left of NFSC: + UDSF->>NFSC: 1. POST {callbackReference} (RecordBody) + NFSC-->>UDSF: 2a. 204 No Content () +``` + +The diagram shows a sequence of messages between the UDSF and the NF Service Consumer. The UDSF sends a POST request with {callbackReference} (RecordBody) to the NF Service Consumer. The NF Service Consumer responds with a 204 No Content () message. + +Sequence diagram for Record Expiry Notify + +**Figure 5.2.2.6.2-1: Record Expiry Notify** + +1. The UDSF shall send a POST request to the callback URI. The request shall contain the record details. +- 2a. On success, "204 No content" shall be returned by the NF Service Consumer to UDSF. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +##### 5.2.2.6.3 Notification due to Data Change + +Figure 5.2.2.6.3-1 shows a scenario where the UDSF notifies the NF service consumer of a change to data associated with a block or a record triggered by one or more a Subscription to Notification. + +![Sequence diagram for Notification due to Data Change](608f1b5ef8f3dc0723f2b4ea1fb72be2_img.jpg) + +``` +sequenceDiagram + participant UDSF + participant NFSC as NF Service Consumer + Note left of NFSC: + UDSF->>NFSC: 1. POST {callbackReference} (RecordNotification) + NFSC-->>UDSF: 2. 204 No Content +``` + +The diagram shows a sequence of messages between the UDSF and the NF Service Consumer. The UDSF sends a POST request with {callbackReference} (RecordNotification) to the NF Service Consumer. The NF Service Consumer responds with a 204 No Content message. + +Sequence diagram for Notification due to Data Change + +**Figure 5.2.2.6.3-1: Notification due to Data Change** + +1. The UDSF shall send a POST request to the callback URI. The request shall contain the RecordNotification details. +2. On success, "204 No content" shall be returned by the NF Service Consumer to UDSF. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +#### 5.2.2.7 Subscribe + +##### 5.2.2.7.1 General + +The following procedures using the Subscribe service operation are supported: + +- Subscription to notification of data change + +##### 5.2.2.7.2 Subscription to notifications of data change + +Figure 5.2.2.7.2-1 shows a scenario where the NF service consumer sends a request to the UDSF to subscribe to notifications of data change. The request contains the subscriptionId, the NotificationSubscription and optionally the query parameter supported-features. + +![Sequence diagram showing the NF service consumer subscribing to notifications from the UDSF. The consumer sends a PUT request to {storageId}/subs-to-notify/{subscriptionId} with a NotificationSubscription body. The UDSF responds with either a 201 Created (NotificationSubscription) or a 409 Conflict (Uris).](e180f2b5fcbe8001554a7c0677cd3f82_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant UDSF + Note right of NF service consumer: 1. PUT.../{storageId}/subs-to-notify/{subscriptionId}/ +(NotificationSubscription) + NF service consumer->>UDSF: 1. PUT.../{storageId}/subs-to-notify/{subscriptionId}/ +(NotificationSubscription) + Note left of UDSF: 2a. 201 Created (NotificationSubscription) +2b. 409 Conflict (Uris) + UDSF-->>NF service consumer: 2a. 201 Created (NotificationSubscription) +2b. 409 Conflict (Uris) + +``` + +Sequence diagram showing the NF service consumer subscribing to notifications from the UDSF. The consumer sends a PUT request to {storageId}/subs-to-notify/{subscriptionId} with a NotificationSubscription body. The UDSF responds with either a 201 Created (NotificationSubscription) or a 409 Conflict (Uris). + +**Figure 5.2.2.7.2-1: NF service consumer subscribes to notifications** + +1. The NF service consumer sends a PUT request to the resource indicated by the storageId and the subscriptionId. The parameter clientId shall be included. If the resource indicated in URI doesn't exist, the UDSF shall trigger the creation of the subscription. +- 2a. On success, the UDSF responds with "201 Created" with the message body containing the NotificationSubscription. The expiry attribute of the received NotificationSubscription may indicate a value or a value different from the request, if due to an operator policy, an expiry time is enforced or if the value in the request exceeded a maximum allowed expiry time. +- 2b. On failure, if one or more monitoredResourceUris from the request don't exist in the UDSF, 409 Conflict shall be returned together with the non-existing monitoredResourceUris. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PUT response body. + +#### 5.2.2.8 Unsubscribe + +##### 5.2.2.8.1 General + +The following procedures using the Unsubscribe service operation are supported: + +- Unsubscription to notification of data change + +##### 5.2.2.8.2 Unsubscription to notifications of data change + +Figure 5.2.2.8.2-1 shows a scenario where the NF service consumer sends a request to the UDSF to Unsubscribe to notifications of data change. The request contains the subscriptionId, and query parameter client-id, optionally query parameters supported-features and get-previous. + +![Sequence diagram showing the NF service consumer unsubscribing from notifications from the UDSF. The consumer sends a DELETE request to {storageId}/subs-to-notify/{subscriptionId}. The UDSF responds with one of the following status codes: 204 No Content, 200 OK (NotificationSubscription), 403 Forbidden (ProblemDetails), 404 Not Found (ProblemDetails), or 412 Precondition Failed (BlockBody).](8ed7f57cc317f6574bec781d01ae6ad2_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant UDSF + Note right of NF service consumer: 1. DELETE .../{storageId}/subs-to-notify/{subscriptionId} + NF service consumer->>UDSF: 1. DELETE .../{storageId}/subs-to-notify/{subscriptionId} + Note left of UDSF: 2a. 204 No Content +2b. 200 OK (NotificationSubscription) +2c. 403 Forbidden (ProblemDetails) +2d. 404 Not Found (ProblemDetails) +2e. 412 Precondition Failed (BlockBody) + UDSF-->>NF service consumer: 2a. 204 No Content +2b. 200 OK (NotificationSubscription) +2c. 403 Forbidden (ProblemDetails) +2d. 404 Not Found (ProblemDetails) +2e. 412 Precondition Failed (BlockBody) + +``` + +Sequence diagram showing the NF service consumer unsubscribing from notifications from the UDSF. The consumer sends a DELETE request to {storageId}/subs-to-notify/{subscriptionId}. The UDSF responds with one of the following status codes: 204 No Content, 200 OK (NotificationSubscription), 403 Forbidden (ProblemDetails), 404 Not Found (ProblemDetails), or 412 Precondition Failed (BlockBody). + +**Figure 5.2.2.8.2-1: NF service consumer unsubscribes to notifications** + +1. The NF service consumer sends a DELETE request to the resource representing the subscription to notification of data change which is indicated by the subscriptionId. + +- 2a. On success, the UDSF shall respond with "204 No Content" if an empty response body is returned, i.e. the get-previous query parameter was not included in the request. +- 2b. On success, the UDSF shall respond with "200 OK" with NotificationSubscription containing the NotificationSubscription value before the delete if get-previous was indicated in the request. +- 2c. If the service operation cannot be authorized due to e.g. the client-id query parameter does not match the clientId of the existing resource, the UDSF shall respond with "403 Forbidden" with including additional error information in the response body (in "ProblemDetails" element). +- 2d. If there is no valid subscription to notification of data change which is indicated by the request, the UDSF shall respond with "404 Not Found" with including additional error information in the response body (in "ProblemDetails" element). +- 2e. If one or more conditions given in the request header fields evaluated to false, the UDSF shall respond with "412 Precondition Failed". NotificationSubscription shall be included in the response if get-previous was indicated in the request. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PUT response body. + +# --- 6 API Definitions + +## 6.1 Nudsf\_DataRepository Service API + +### 6.1.1 Introduction + +The Nudsf\_DataRepository service shall use the Nudsf\_DataRepository API. + +The API URI of the Nudsf\_DataRepository API shall be: + +**{apiRoot}
/** + +The request URI used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nudsf-dr". +- The shall be "v1". +- The shall be set as described in clause 6.1.3. + +### 6.1.2 Usage of HTTP + +#### 6.1.2.1 General + +HTTP/2, IETF RFC 7540 [11], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +The OpenAPI [6] specification of HTTP messages and content bodies for the Nudsf\_DataRepository API is contained in Annex A. + +#### 6.1.2.2 HTTP standard headers + +##### 6.1.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers. + +##### 6.1.2.2.2 Content type + +The following content types shall be supported: + +- JSON, IETF RFC 8259 [12], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [4]. The use of the JSON format shall be signalled by the content type "application/json". +- "Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 7807 [13]. +- JSON Patch (IETF RFC 6902 [14]). The use of the JSON Patch format in a HTTP request body shall be signalled by the content type "application/json-patch+json". + +Multipart messages shall also be supported possibly indicating other content-types as described in clause 6.1.2.4. + +##### 6.1.2.2.3 Cache-Control + +As described in IETF RFC 7234 [17] clause 5.2, a "Cache-Control" header should be included in HTTP responses carrying a representation of cacheable resources. If it is included, it shall contain a "max-age" value, indicating the amount of time in seconds after which the received response is considered stale. + +The "max-age" value shall be configurable by operator policy. + +##### 6.1.2.2.4 ETag + +As described in IETF RFC 7232 [16] clause 2.3, an "ETag" (entity-tag) header should be included in HTTP responses carrying a representation of cacheable or modifiable resources to allow an NF Service Consumer performing a conditional GET request with an "If-None-Match" header or a conditional PUT/PATCH/DELETE request with an "If-Match" header. If it is included, it shall contain a server-generated strong validator, that allows further matching of this value (included in subsequent client requests) with a given resource representation stored in the server or in a cache. + +##### 6.1.2.2.5 If-None-Match + +As described in IETF RFC 7232 [16] clause 3.2, an NF Service Consumer may issue conditional GET or PUT requests towards UDSF by including an "If-None-Match" header in HTTP requests containing one or several entity tags received in previous responses for the same resource. + +If the If-None-Match header is included with the PUT method, it shall be used with a value of "\*" to prevent the inadvertent modification of an existing representation of the target resource when the client believes that the resource does not have a current representation. + +##### 6.1.2.2.6 If-Match + +As described in IETF RFC 7232 [16] clause 3.1, an NF Service Consumer may issue conditional PUT/PATCH/DELETE request towards UDSF by including an "If-Match" header in HTTP requests containing an entity tag received in previous responses for the same resource. + +##### 6.1.2.2.7 Last-Modified + +As described in IETF RFC 7232 [16] clause 2.2, a "Last-Modified" header should be included in HTTP responses carrying a representation of cacheable resources to allow an NF Service Consumer performing a conditional request with "If-Modified-Since" header. + +##### 6.1.2.2.8 If-Modified-Since + +As described in IETF RFC 7232 [16] clause 3.3, an NF Service Consumer may issue conditional GET request towards UDSF, by including an "If-Modified-Since" header in HTTP requests. + +##### 6.1.2.2.9 When to Use Entity-Tags and Last-Modified Dates + +Both "ETag" and "Last-Modified" headers should be sent in the same HTTP response as stated in IETF RFC 7232 [16] clause 2.4. + +NOTE: "ETag" is a stronger validator than the "Last-Modified" and is preferred. + +If the UDSF included an "ETag" header with the resource then a conditional GET request for this resource shall be performed with the "If-None-Match" header, and a PUT/PATCH/DELETE request for this resource shall be performed with the "If-Match" header. + +##### 6.1.2.2.10 Content-Location + +As described in IETF RFC 7231 [15] clause 3.1.4.2, the UDSF shall include the Content-Location header set to the URI of the expired Record when sending a Notification to an NF Consumer. + +#### 6.1.2.3 HTTP custom headers + +The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] shall be applicable. + +#### 6.1.2.4 HTTP multipart messages + +##### 6.1.2.4.1 General + +HTTP multipart messages shall be supported to transfer the opaque Record and Block Information in the following service operations (and HTTP messages): + +- Record (PUT/GET/DELETE) +- BlockCollection (GET) +- RecordNotification (POST) + +NOTE: In the clauses below, this specification deviates in the definition of the Content-ID header from IETF RFC 2045 [20] in that there is no need for the Content-ID to be "world unique", as in this specification the Content-ID is only required to be unique within the context of a Record, BlockCollection or RecordNotification. + +##### 6.1.2.4.2 Record + +The Record is encoded as an HTTP multipart message with the multipart/mixed content-type as described in IETF RFC 2046 [21]. + +The boundary parameter is used to delimit each part (Start of parts to RecordMeta, RecordMeta to Block, Block to Block and Block to End of parts) and shall be set to a value as in accordance with IETF RFC 2046 [21]. + +The RecordMeta part shall be the first part, and shall always be present. It shall include a Content-ID header that may be set to an unquoted value of "meta" or any other suitable value, for example as described in IETF RFC 2045 [20], the Content-Type (see IETF RFC 2045 [20]) header set to "application/json" and include JSON content for the RecordMeta. + +Zero or more Block parts may follow the RecordMeta Part. For each Block part in the HTTP multipart/mixed message, the Block part shall include a Content-ID header identifying the Block with the value of the blockId, a Content-Type (see IETF RFC 2045 [20]) header indicating the MIME type of the Block (any value), e.g. application/octet-stream, application/json or another applicable MIME type and the Content-Transfer-Encoding (see IETF RFC 2045 [20]) header with an appropriate value. + +##### 6.1.2.4.3 BlockCollection + +The BlockCollection is encoded as an HTTP multipart message with the multipart/parallel content-type as described in IETF RFC 2046 [21]. + +The boundary parameter is used to delimit each part (Start of parts to Block, Block to Block and Block to End of parts) and shall be set to a value as in accordance with IETF RFC 2046 [21]. + +For the BlockCollection, zero or more Block parts may be included. For each Block part in the HTTP multipart/parallel message, the Block part shall include a Content-ID header identifying the Block with the value of the blockId, a Content-Type header indicating the MIME type of the Block (any value) e.g. application/octet-stream, application/json or another applicable MIME type and the Content-Transfer-Encoding (see IETF RFC 2045 [20]) header with an appropriate value. + +##### 6.1.2.4.4 RecordNotification + +The RecordNotification is encoded as an HTTP multipart message with the multipart/mixed content-type as described in IETF RFC 2046 [21]. + +The boundary parameter is used to delimit each part (Start of parts to RecordNotification, RecordNotification to RecordMeta, RecordMeta to Block, Block to Block and Block to End of parts) and shall be set to a value in accordance with IETF RFC 2046 [21]. + +The RecordNotification shall be the first part, and shall always be present. It shall include a Content-ID header set to an unquoted value (see IETF RFC 2045 [20]), of "recordnotification" or any other suitable value, for example as described in IETF RFC 2045 [20], the Content-Type (see IETF RFC 2045 [20]) header set to "application/json" and include JSON content for the NotificationDescription. + +The RecordMeta part shall be the second part, and shall always be present. It shall include a Content-ID header set to an unquoted value of "meta" or any other suitable value, for example as described in IETF RFC 2045 [20], the Content-Type (see IETF RFC 2045 [20]) header set to "application/json" and include JSON content for the RecordMeta. + +Zero or more Block parts may follow the RecordMeta Part. For each Block part in the HTTP multipart/mixed message, the Block part shall include a Content-ID header identifying the Block with the value of the blockId, a Content-Type (see IETF RFC 2045 [20]) header indicating the MIME type of the Block (any value), e.g. application/octet-stream, application/json or another applicable MIME type and the Content-Transfer-Encoding (see IETF RFC 2045 [20]) header with an appropriate value. + +### 6.1.3 Resources + +#### 6.1.3.1 Overview + +![Resource URI structure of the nudsf-dr API](4cde160bcc69b7b6c81b648dd0e4252e_img.jpg) + +``` +graph TD; Root["{apiRoot}/nudsf-dr/v1"] --> Realm["/{realmId}"]; Realm --> Storage["/{storageId}"]; Storage --> Records["/records"]; Records --> RecordId["/{recordId}"]; RecordId --> Blocks["/blocks"]; RecordId --> Meta["/meta"]; Blocks --> BlockId["/{blockId}"]; Storage --> Subs["/subs-to-notify"]; Subs --> SubId["/{subscriptionId}"]; +``` + +The diagram illustrates the hierarchical structure of the nudsf-dr API. It starts with the root path {apiRoot}/nudsf-dr/v1, which branches into /{realmId}. This path further branches into /{storageId}. From /{storageId}, the path splits into /records and /subs-to-notify. The /records path further branches into /{recordId}, which then branches into /blocks and /meta. The /blocks path further branches into /{blockId}. The /subs-to-notify path further branches into /{subscriptionId}. + +Resource URI structure of the nudsf-dr API + +**Figure 6.1.3.1-1: Resource URI structure of the nudsf-dr API** + +Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods. + +Table 6.1.3.1-1: Resources and methods overview + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|------------------------------------------------|------------------------------------------------------------|---------------------------------|-------------------------------------------------------------------------------------------------------------| +| RecordCollection (Collection) | /{realmId}/{storageId}/records | GET | Search for records | +| Record (Document) | /{realmId}/{storageId}/records/{recordId} | GET | Retrieve a record | +| | | PUT | Create or update a record | +| | | DELETE | Delete a record | +| Meta (Document) | /{realmId}/{storageId}/records/{recordId}/meta | GET | Retrieve the meta of a record | +| | | PATCH | Modify the meta of a record | +| BlockCollection (Collection) | /{realmId}/{storageId}/records/{recordId}/blocks | GET | Retrieve all the blocks of a record | +| Block (Document) | /{realmId}/{storageId}/records/{recordId}/blocks/{blockId} | GET | Retrieve a block | +| | | PUT | Create or update a block | +| | | DELETE | Delete a block | +| NotificationSubscriptions (Collection) | /{realmId}/{storageId}/subs-to-notify | GET | Retrieve existing subscriptions | +| Individual NotificationSubscription (Document) | /{realmId}/{storageId}/subs-to-notify/{subscriptionId} | DELETE | Delete the subscription identified by {subscriptionId}, i.e. unsubscribe to notification for change of data | +| | | PATCH | Update an individual Subscription to notification | +| | | PUT | Create or update a subscription to notification, | +| | | GET | Retrieve an individual Subscription to notification | + +#### 6.1.3.2 Resource: RecordCollection (Collection) + +##### 6.1.3.2.1 Description + +This resource represents the collection of records within a storage. It can be used to search for specific records matching specific filter criteria. + +##### 6.1.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nudsf-dr//{realmId}/{storageId}/records + +This resource shall support the resource URI variables defined in table 6.1.3.2.2-1. + +**Table 6.1.3.2.2-1: Resource URI variables for this resource** + +| Name | Definition | +|-----------|----------------------------| +| apiRoot | See clause 6.1.1 | +| realmId | Represents the realm Id. | +| storageId | Represents the storage Id. | + +##### 6.1.3.2.3 Resource Standard Methods + +###### 6.1.3.2.3.1 GET + +This method shall support the URI query parameters specified in table 6.1.3.2.3.1-1. + +**Table 6.1.3.2.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | | +| filter | SearchExpression | O | 0..1 | The filter criteria for searching the records of the storage. | | +| limit-range | Uinteger | C | 0..1 | When set, the returned response shall contain at the most the number of record references specified by the parameter value.

If the count-indicator parameter is set in the request, this parameter shall be ignored. | | +| count-indicator | boolean | O | 0..1 | If this parameter is set, the number of records that matched the criteria shall be returned and no record references shall be returned. | | + +This method shall support the request data structures specified in table 6.1.3.2.3.1-2 and the response data structures and response codes specified in table 6.1.3.2.3.1-3. + +**Table 6.1.3.2.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.2.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-------------------------------------------------------------------------| +| RecordSearchResult | M | 1 | 200 OK | The search result containing the record references matching the filter. | +| n/a | | | 204 No Content | The search did not result in any matching record references. | +| NOTE: The mandatory HTTP error status code for the GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +#### 6.1.3.3 Resource: Record (Document) + +##### 6.1.3.3.1 Description + +This resource represents a record within a storage. + +##### 6.1.3.3.2 Resource Definition + +Resource URI: {apiRoot}/nudsf-dr/{apiVersion}/{realmId}/{storageId}/records/{recordId} + +This resource shall support the resource URI variables defined in table 6.1.3.3.2-1. + +**Table 6.1.3.3.2-1: Resource URI variables for this resource** + +| Name | Definition | +|-----------|------------------------------------------------------| +| apiRoot | See clause 6.1.1 | +| realmId | Represents the realm Id where the record is stored | +| storageId | Represents the storage Id where the record is stored | +| recordId | Represents the record Id of the record | + +##### 6.1.3.3.3 Resource Standard Methods + +###### 6.1.3.3.3.1 GET + +This method shall support the URI query parameters specified in table 6.1.3.3.3.1-1. + +**Table 6.1.3.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------|---|-------------|------------------------------------|---------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6. | | + +This method shall support the request data structures specified in table 6.1.3.3.3.1-2 and the response data structures and response codes specified in table 6.1.3.3.3.1-3. + +**Table 6.1.3.3.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.3.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------| +| RecordBody | M | 1 | 200 OK | A response body containing the record. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
-REALM_NOT_FOUND
-STORAGE_NOT_FOUND
-RECORD_NOT_FOUND | +| NOTE: The mandatory HTTP error status code for the GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +###### 6.1.3.3.3.2 PUT + +This method shall support the URI query parameters specified in table 6.1.3.3.3.2-1. + +**Table 6.1.3.3.3.2-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------|---------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | | +| get-previous | boolean | O | 0..1 | Request to return the previous record content if a record already exists in the targeted storage for the same record identifier. | | + +When creating or replacing the record, meta and zero or more blocks shall be included. The record meta information shall be the first part and is mandatory. The remaining parts of the body (if any) shall be the blocks to be updated or created. See clause 6.1.2.4 for details on the encoding. + +If the operation updates an existing record, then the existing record and its blocks shall be discarded and replaced by the meta and blocks supplied with the request. This also applies to the case when no new blocks are included, i.e. the old blocks (if any) shall be deleted from the record. + +This method shall support the request data structures specified in table 6.1.3.3.3.2-2 and the response data structures and response codes specified in table 6.1.3.3.3.2-3. + +**Table 6.1.3.3.3.2-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|--------------------------------------------------------------------------| +| Record | M | 1 | The record that is to be created including meta and zero or more blocks. | + +**Table 6.1.3.3.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------------------------------------------------------------------------------------------------------------|---|-------------|-------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| RecordBody | M | 1 | 200 OK | Upon successful update of a record, a response body containing the previous record value (if get-previous was indicated in the request, and if one exists) will be returned | +| RecordBody | O | 0..1 | 201 Created | Upon successful creation of a record, a response body of the created record shall be returned. If due to operator's policy the value of the ttl (if any) in the request exceeded a maximum allowed ttl value with the ttl set to the value applied by the UDSF. | +| n/a | | | 204 No Content | Upon successful update of a record, an empty response is returned or if no previous record value was requested. | +| ProblemDetails | O | 0..1 | 403 FORBIDDEN | If the UDSF (based on operator policy), determines to apply a ttl value of the recordMeta different from the ttl value (if any) of the request, the get-previous query-parameter is present in the request and the request applies to a record that already exists in the UDSF, the "cause" attribute shall be set to one of the following application errors:
-TTL_VALUE_NOT_ALLOWED | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
-REALM_NOT_FOUND
-STORAGE_NOT_FOUND | +| RecordBody | O | 0..1 | 412 Precondition Failed | If one or more conditions given in the request header fields evaluated to false and get-previous was indicated in the request, the UDSF shall include the RecordBody in the response. | +| NOTE: The mandatory HTTP error status code for the PUT method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +###### 6.1.3.3.3.3 DELETE + +This method shall support the URI query parameters specified in table 6.1.3.3.3.3-1. + +**Table 6.1.3.3.3.3-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------|---------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | | +| get-previous | boolean | O | 0..1 | Request to return the record content if a record exists in the targeted storage for the same record identifier. | | + +This method shall support the request data structures specified in table 6.1.3.3.3.3-2 and the response data structures and response codes specified in table 6.1.3.3.3.3-3. + +**Table 6.1.3.3.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.3.3.3-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------|---|-------------|-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| RecordBody | O | 0..1 | 200 OK | Upon success, and a response body containing the record value with meta and associated blocks (if any), if get-previous was indicated in the request. | +| n/a | | | 204 No Content | Upon success and no response body containing the record was requested. | +| RecordBody | O | 0..1 | 412 Precondition Failed | If one or more conditions given in the request header fields evaluated to false and get-previous was indicated in the request, the UDSF shall include the RecordBody in the response. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
-REALM_NOT_FOUND
-STORAGE_NOT_FOUND
-RECORD_NOT_FOUND | + +NOTE: The mandatory HTTP error status code for the DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +#### 6.1.3.4 Resource: Meta (Document) + +##### 6.1.3.4.1 Description + +This resource represents the meta associated with a record. + +##### 6.1.3.4.2 Resource Definition + +Resource URI: {apiRoot}/nudsf-dr/{apiVersion}/{realmId}/{storageId}/records/{recordId}/meta + +This resource shall support the resource URI variables defined in table 6.1.3.4.2-1. + +**Table 6.1.3.4.2-1: Resource URI variables for this resource** + +| Name | Definition | +|-----------|------------------------------------------------------| +| apiRoot | See clause 6.1.1 | +| realmId | Represents the realm Id where the record is stored | +| storageId | Represents the storage Id where the record is stored | +| recordId | Represents the record Id of the record | + +##### 6.1.3.4.3 Resource Standard Methods + +###### 6.1.3.4.3.1 GET + +This method shall support the URI query parameters specified in table 6.1.3.4.3.1-1. + +**Table 6.1.3.4.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------|---|-------------|-----------------------------------|---------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | | + +This method shall support the request data structures specified in table 6.1.3.4.3.1-2 and the response data structures and response codes specified in table 6.1.3.4.3.1-3. + +**Table 6.1.3.4.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.4.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------| +| RecordMeta | M | 1 | 200 OK | A response body containing the record meta will be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute shall be set to one of the following application errors:
-REALM_NOT_FOUND
-STORAGE_NOT_FOUND
-RECORD_NOT_FOUND | +| NOTE: The mandatory HTTP error status code for the GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +###### 6.1.3.4.3.2 PATCH + +This method shall support the URI query parameters specified in table 6.1.3.4.3.2-1. + +**Table 6.1.3.4.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------|---|-------------|-----------------------------------|---------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | | + +This method shall support the request data structures specified in table 6.1.3.4.3.2-2 and the response data structures and response codes specified in table 6.1.3.4.3.2-3. + +**Table 6.1.3.4.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|----------------------------------------------------------| +| array(patchItem) | M | 1..N | A collection of patch items to apply on the record meta. | + +**Table 6.1.3.4.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------|---|-------------|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon successful modification, there is no body in the response message. (NOTE 2) | +| PatchResult | M | 1 | 200 OK | If one or more modification instructions have been discarded, the execution report is returned. (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute maybe used to indicate one of the following application errors:
-REALM_NOT_FOUND
-STORAGE_NOT_FOUND
-RECORD_NOT_FOUND | + +NOTE 1: In addition common data structures as listed in table 6.1.7.3-1 are supported. +NOTE 2: If all the modification instructions in the PATCH request have been implemented, the UDSF shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, the UDSF shall respond with PatchResult. + +#### 6.1.3.5 Resource: BlockCollection (Collection) + +##### 6.1.3.5.1 Description + +This resource represents the collection of blocks of associated with a record. + +##### 6.1.3.5.2 Resource Definition + +Resource URI: {apiRoot}/nudsf-dr//{realmId}/{storageId}/records/{recordId}/blocks + +This resource shall support the resource URI variables defined in table 6.1.3.5.2-1. + +**Table 6.1.3.5.2-1: Resource URI variables for this resource** + +| Name | Definition | +|-----------|------------------------------------------------------| +| apiRoot | See clause 6.1.1 | +| realmId | Represents the realm Id where the record is stored | +| storageId | Represents the storage Id where the record is stored | +| recordId | Represents the record Id of the record | + +##### 6.1.3.5.3 Resource Standard Methods + +###### 6.1.3.5.3.1 GET + +This method shall support the URI query parameters specified in table 6.1.3.5.3.1-1. + +**Table 6.1.3.5.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------|---|-------------|-----------------------------------|---------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | | + +This method shall support the request data structures specified in table 6.1.3.5.3.1-2 and the response data structures and response codes specified in table 6.1.3.5.3.1-3. + +**Table 6.1.3.5.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.5.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-------------------------------------------------| +| array(Block) | M | 1..N | 200 OK | A response body containing one or more blocks. | +| n/a | | | 204 No Content | The BlockCollection did not contain any blocks. | +| NOTE: The mandatory HTTP error status code for the GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +#### 6.1.3.6 Resource: Block (Document) + +##### 6.1.3.6.1 Description + +This resource represents a record within a storage. + +##### 6.1.3.6.2 Resource Definition + +Resource URI: {apiRoot}/nudsf-dr//{realmId}/{storageId}/records/{recordId}/blocks/{blockId} + +This resource shall support the resource URI variables defined in table 6.1.3.6.2-1. + +**Table 6.1.3.6.2-1: Resource URI variables for this resource** + +| Name | Definition | +|-----------|------------------------------------------------------| +| apiRoot | See clause 6.1.1 | +| realmId | Represents the realm Id where the record is stored | +| storageId | Represents the storage Id where the record is stored | +| recordId | Represents the record Id of the record | +| blockId | Represents the block Id of the block | + +##### 6.1.3.6.3 Resource Standard Methods + +###### 6.1.3.6.3.1 GET + +This method shall support the URI query parameters specified in table 6.1.3.6.3.1-1. + +**Table 6.1.3.6.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------|---|-------------|-----------------------------------|---------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | | + +This method shall support the request data structures specified in table 6.1.3.6.3.1-2 and the response data structures and response codes specified in table 6.1.3.6.3.1-3. + +**Table 6.1.3.6.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.6.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| BlockBody | M | 1 | 200 OK | Upon success, a response body containing the requested block is returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute maybe used to indicate one of the following application errors:
-REALM_NOT_FOUND
-STORAGE_NOT_FOUND
-RECORD_NOT_FOUND
-BLOCK_NOT_FOUND | +| NOTE: The mandatory HTTP error status code for the GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +###### 6.1.3.6.3.2 PUT + +This method shall support the URI query parameters specified in table 6.1.3.6.3.2-1. + +**Table 6.1.3.6.3.2-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------|---------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | | +| get-previous | boolean | O | 0..1 | Request to return the previous block content if a block already exists in the targeted storage for the same block identifier. | | + +If the operation updates an existing block, then the existing block shall be discarded and replaced by the block supplied with the request. + +This method shall support the request data structures specified in table 6.1.3.6.3.2-2 and the response data structures and response codes specified in table 6.1.3.6.3.2-3. + +**Table 6.1.3.6.3.2-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Block | M | 1 | The block definition that shall be created. A Content-Type http header can be set to specify the media type of the block's opaque content. If the media-type is not included, the media-type shall be set to application/octet-stream. | + +**Table 6.1.3.6.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------------------------------------------------------------------------------------------------------------|---|-------------|-------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| BlockBody | M | 1 | 200 OK | Upon successful update of a block, a response body containing the previous record value ((if get-previous was indicated in the request and if one exists) will be returned | +| n/a | | | 201 Created | Upon successful creation of a record, an empty response shall be returned. | +| n/a | | | 204 No Content | Upon successful update of a record, an empty response is returned if no previous record value was requested. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
-REALM_NOT_FOUND
-STORAGE_NOT_FOUND
-RECORD_NOT_FOUND | +| BlockBody | O | 0..1 | 412 Precondition Failed | If one or more conditions given in the request header fields evaluated to false and get-previous was indicated in the request, the UDSF shall include the BlockBody in the response. | +| NOTE: The mandatory HTTP error status code for the PUT method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +###### 6.1.3.6.3.3 DELETE + +This method shall support the URI query parameters specified in table 6.1.3.6.3.3-1. + +**Table 6.1.3.6.3.3-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------|---|-------------|--------------------------------------------------------|---------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | | +| get-previous | boolean | O | 0..1 | Request to return the previous block content (if any). | | + +This method shall support the request data structures specified in table 6.1.3.6.3.3-2 and the response data structures and response codes specified in table 6.1.3.6.3.3-3. + +**Table 6.1.3.6.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.6.3.3-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------------------------|---|-------------|-------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| BlockBody | O | 0..1 | 200 OK | Upon success, and a response body containing the block was requested. | +| n/a | | | 204 No Content | Upon success, and no response body containing the block was requested. | +| BlockBody | O | 0..1 | 412 Precondition Failed | If one or more conditions given in the request header fields evaluated to false and get-previous was indicated in the request, the UDSF shall include the BlockBody in the response. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
-REALM_NOT_FOUND
-STORAGE_NOT_FOUND
-RECORD_NOT_FOUND
-BLOCK_NOT_FOUND | +| NOTE: The mandatory HTTP error status code for the DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +#### 6.1.3.7 Resource: NotificationSubscriptions + +##### 6.1.3.7.1 Description + +This resource is used to represent notification subscriptions. + +##### 6.1.3.7.2 Resource Definition + +Resource URI: {apiRoot}/nudsf-dr//{realmId}/{storageId}/subs-to-notify + +This resource shall support the resource URI variables defined in table 6.1.3.7.2-1. + +**Table 6.1.3.7.2-1: Resource URI variables for this resource** + +| Name | Definition | +|-----------|----------------------------| +| apiRoot | See clause 6.1.1 | +| realmId | Represents the realm Id. | +| storageId | Represents the storage Id. | + +##### 6.1.3.7.3 Standard Methods + +###### 6.1.3.7.3.2 GET + +This method shall support the URI query parameters specified in table 6.1.3.7.3.2-1. + +**Table 6.1.3.7.3.2-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | +| limit-range | UInteger | C | 0..1 | When set, the returned response shall contain at the most the number of Notification Subscriptions specified by the parameter value. | + +This method shall support the request data structures specified in table 6.1.3.7.3.2-2 and the response data structures and response codes specified in table 6.1.3.7.3.2-3. + +**Table 6.1.3.7.3.2-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.7.3.2-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------| +| array(NotificationSubscription) | M | 0..N | 200 OK | Upon success, a response body containing the individual subscriptions shall be returned. | +| ProblemDetails | O | 0..1 | 404 NOT FOUND | The "cause" attribute shall be set to one of the following application errors:
-REALM_NOT_FOUND
-STORAGE_NOT_FOUND | +| NOTE: The mandatory HTTP error status code for the GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +#### 6.1.3.8 Resource: IndividualNotificationSubscription + +##### 6.1.3.8.1 Description + +This resource is used to represent an individual subscriber data subscriptions to notifications. + +##### 6.1.3.8.2 Resource Definition + +Resource URI: {apiRoot}/nudsf-dr//{realmId}/{storageId}/subs-to-notify/{subscriptionId} + +This resource shall support the resource URI variables defined in table 6.1.3.8.2-1. + +**Table 6.1.3.8.2-1: Resource URI variables for this resource** + +| Name | Definition | +|----------------|-----------------------------------------------------------------------| +| apiRoot | See clause 6.1.1 | +| realmId | Represents the realm Id. | +| storageId | Represents the storage Id. | +| subscriptionId | The subscriptionId identifies an individual NotificationSubscription. | + +##### 6.1.3.8.3 Resource Standard Methods + +###### 6.1.3.8.3.1 DELETE + +This method shall support the URI query parameters specified in table 6.1.3.8.3.1-1. + +**Table 6.1.3.8.3.1-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------| +| client-id | ClientId | M | 1 | The client-id is used by the UDSF to guard against deletion of notification subscriptions that do not belong to the same NF or NFSet. | +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | +| get-previous | boolean | O | 0..1 | Request to return the associated NotificationSubscription if it exist. | + +This method shall support the request data structures specified in table 6.1.3.8.3.1-2 and the response data structures and response codes specified in table 6.1.3.8.3.1-3. + +**Table 6.1.3.8.3.1-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|----------------------------------| +| n/a | | | The request body shall be empty. | + +**Table 6.1.3.8.1-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------------------------|---|-------------|-------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NotificationSubscription | O | 0..1 | 200 OK | Upon successful delete of a NotificationSubscription, a response body containing the NotificationSubscription value before the delete shall be returned if get-previous was indicated in the request. | +| n/a | | | 204 NO CONTENT | Upon success, an empty response body shall be returned. | +| ProblemDetails | O | 0..1 | 403 FORBIDDEN | If the client-id query parameter does not match the clientId of the existing resource, 403 FORBIDDEN shall be returned and the "cause" attribute may be used to indicate one of the following application errors:
- SUBSCRIPTION_EXISTS | +| ProblemDetails | O | 0..1 | 404 NOT FOUND | The "cause" attribute shall be set to one of the following application errors:
-REALM_NOT_FOUND
-STORAGE_NOT_FOUND
-SUBSCRIPTION_NOT_FOUND | +| NotificationSubscription | O | 0..1 | 412 PRECONDITION FAILED | 412 PRECONDITION FAILED is returned if one or more conditions given in the request header fields evaluated to false. If get-previous was indicated in the request, the UDSF shall include the NotificationSubscription in the response. | +| NOTE: The mandatory HTTP error status code for the DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +###### 6.1.3.8.3.2 PATCH + +This method shall support the URI query parameters specified in table 6.1.3.8.3.2-1. + +**Table 6.1.3.8.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +This method shall support the request data structures specified in table 6.1.3.8.3.2-2 and the response data structures and response codes specified in table 6.1.3.8.3.2-3. + +**Table 6.1.3.8.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|-------------------------------------------------------------------------| +| array(PatchItem) | M | 1..N | Contains the delta data of the Notification Subscription to be updated. | + +**Table 6.1.3.8.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------|---|-------------|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 NO CONTENT | Upon successful modification, there is no body in the response message. (NOTE 2) | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 NOT FOUND | The "cause" attribute shall be set to one of the following application errors:
-REALM_NOT_FOUND
-STORAGE_NOT_FOUND
-SUBSCRIPTION_NOT_FOUND | + +NOTE 1: In addition common data structures as listed in table 6.1.7.3-1 are supported. +NOTE 2: If all the modification instructions in the PATCH request have been implemented, the UDSF shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, the UDSF shall respond with 200 OK and include the PatchResult. + +###### 6.1.3.8.3.3 GET + +This method shall support the URI query parameters specified in table 6.1.3.8.3.3-1. + +**Table 6.1.3.8.3.3-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|------------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6. | + +This method shall support the request data structures specified in table 6.1.3.8.3.3-2 and the response data structures and response codes specified in table 6.1.3.8.3.3-3. + +**Table 6.1.3.8.3.3-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|----------------------------------| +| n/a | | | The request body shall be empty. | + +**Table 6.1.3.8.3.3-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------------|---|-------------|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------| +| NotificationSubscription | M | 1 | 200 OK | Upon success, a response body containing the individual subscriptions shall be returned. | +| ProblemDetails | O | 0..1 | 404 NOT FOUND | The "cause" attribute shall be set to one of the following application errors:
-REALM_NOT_FOUND
-STORAGE_NOT_FOUND
-SUBSCRIPTION_NOT_FOUND | + +NOTE: The mandatory HTTP error status code for the GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +###### 6.1.3.8.3.4 PUT + +This method shall support the URI query parameters specified in table 6.1.3.8.3.4-1. + +**Table 6.1.3.8.3.4-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------|---|-------------|-----------------------------------|---------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | | + +This method shall support the request data structures specified in table 6.1.3.8.3.4-2 and the response data structures and response codes specified in table 6.1.3.8.3.4-3. + +**Table 6.1.3.8.3.4-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------------|---|-------------|--------------------------------| +| NotificationSubscription | M | 1 | The Notification Subscription. | + +**Table 6.1.3.8.3.4-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------------|---|-------------|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NotificationSubscription | M | 1 | 201 CREATED | Upon success, the created NotificationSubscription is returned.

The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource. | +| NotificationSubscription | M | 1 | 200 OK | Upon success, the updated NotificationSubscription is returned. | +| ProblemDetails | O | 0..1 | 404 NOT FOUND | The "cause" attribute shall be set to one of the following application errors:
-REALM_NOT_FOUND
-STORAGE_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 FORBIDDEN | If the clientId of the PUT request does not match the clientId of the existing resource, 403 FORBIDDEN shall be returned and the "cause" attribute may be used to indicate one of the following application errors:
- SUBSCRIPTION_EXISTS | +| array(Uri) | O | 1..N | 409 CONFLICT | If one or more monitoredResourceUris from the request don't exist in the UDSF, 409 CONFLICT shall be returned together with the non-existing monitoredResourceUris. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +### 6.1.4 Custom Operations without associated resources + +None. + +### 6.1.5 Notifications + +#### 6.1.5.1 General + +Notifications shall comply to clause 6.2 of 3GPP TS 29.500 [4] and clause 4.6.2.3 of 3GPP TS 29.501 [5]. + +#### 6.1.5.2 Timer Expiry Notification + +##### 6.1.5.2.1 Description + +The Timer Expiry Notification is used by the NF service producer to report to an NF Consumer that the Record has expired as indicated by the ttl attribute (if set) of RecordMeta and if a callbackReference was set in the RecordMeta. + +##### 6.1.5.2.2 Target URI + +The Callback URI "{callbackReference}" shall be used with the callback URI variables defined in table 6.1.5.2.2-1. + +**Table 6.1.5.2.2-1: Target URI variables for this resource** + +| Name | Definition | +|-------------------|-----------------------------------------------| +| callbackReference | string formatted as URI with the Callback Uri | + +##### 6.1.5.2.3 Standard Methods + +###### 6.1.5.2.3.1 POST + +This method shall support the request data structures specified in table 6.1.5.2.3.1-1 and the response data structures and response codes specified in table 6.1.5.2.3.1-1. + +**Table 6.1.5.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------|---|-------------|------------------------------------------------| +| RecordBody | M | 1 | The RecordBody of the record that was deleted. | + +**Table 6.1.5.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| NOTE: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +#### 6.1.5.3 Notification due to Data Change + +##### 6.1.5.3.1 Description + +The Notification due to Data Change is used by the UDSF to report to an NF Consumer that a Record that is part of a NotificationSubscription has been updated or deleted. + +##### 6.1.5.3.2 Target URI + +The Callback URI "{callbackReference}" shall be used with the callback URI variables defined in table 6.1.5.3.2-1. + +**Table 6.1.5.3.2-1: Callback URI variables for this resource** + +| Name | Definition | +|-------------------|-----------------------------------------------| +| callbackReference | String formatted as URI with the Callback Uri | + +##### 6.1.5.3.3 Standard Methods + +###### 6.1.5.3.3.1 POST + +This method shall support the request data structures specified in table 6.1.5.3.3.1-1 and the response data structures and response codes specified in table 6.1.5.3.3.1-1. + +**Table 6.1.5.3.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------|---|-------------|-----------------------------------------------| +| RecordNotification | M | 1 | The notification with the record information. | + +**Table 6.1.5.3.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------| +| n/a | | | 204 NO CONTENT | Upon success, an empty response body shall be returned. | +| NOTE: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +### 6.1.6 Data Model + +#### 6.1.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.1.6.1-1 specifies the data types defined for the Nudsf service based interface protocol. For simple data types defined for the Nudsf\_DataRepository service API see table 6.1.6.3.2-1. + +**Table 6.1.6.1-1: Nudsf specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|--------------------------|----------------|---------------------------|---------------| +| RecordSearchResult | 6.1.6.2.2 | Record Search Result | | +| RecordMeta | 6.1.6.2.3 | Record Meta | | +| RecordBody | 6.1.6.2.4 | Record Body | | +| Record | 6.1.6.2.5 | Record | | +| BlockBody | 6.1.6.2.6 | Block Body | | +| Block | 6.1.6.2.7 | Block | | +| SearchCondition | 6.1.6.2.8 | Search Condition | | +| SearchComparison | 6.1.6.2.9 | Search Comparison | | +| ComparisonOperator | 6.1.6.3.3 | Comparison Operator | | +| ConditionOperator | 6.1.6.3.4 | Condition Operator | | +| SearchExpression | 6.1.6.4.1 | Search Expression | | +| NotificationSubscription | 6.1.6.2.10 | Notification Subscription | | +| RecordNotification | 6.1.6.2.11 | Record Notification | | +| NotificationDescription | 6.1.6.2.12 | Notification Description | | +| SubscriptionFilter | 6.1.6.2.13 | Subscription Filter | | +| ClientId | 6.1.6.2.14 | Client Identity | | +| RecordOperation | 6.1.6.3.5 | Record Operation | | + +Table 6.1.6.1-2 specifies data types re-used by the Nudsf service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nudsf service based interface. + +**Table 6.1.6.1-2: Nudsf re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-------------------|---------------------|-------------------------------------|---------------| +| SupportedFeatures | 3GPP TS 29.571 [19] | see 3GPP TS 29.500 [4] clause 6.6. | | +| PatchItem | 3GPP TS 29.571 [19] | Data structure used for JSON patch. | | +| PatchResult | 3GPP TS 29.571 [19] | | | +| Uri | 3GPP TS 29.571 [19] | | | +| DateTime | 3GPP TS 29.571 [19] | | | +| NfInstanceId | 3GPP TS 29.571 [19] | | | +| NfSetId | 3GPP TS 29.571 [19] | | | + +#### 6.1.6.2 Structured data types + +##### 6.1.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.1.6.2.2 Type: RecordSearchResult + +Table 6.1.6.2.2-1: Definition of type RecordSearchResult + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|-------------------|---|-------------|--------------------------------------------|---------------| +| count | UInteger | M | 1 | The number of records found by the search. | | +| references | array(Uri) | O | 1..N | The Record references found by the search. | | +| supportedFeatures | SupportedFeatures | O | 0..1 | See clause 6.1.8 | | + +##### 6.1.6.2.3 Type: RecordMeta + +Table 6.1.6.2.3-1: Definition of type RecordMeta + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|--------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| tags | map(array(string)) | O | 1..N(1..M) | A map of tag name/values pairs, where the tag name is a unique string name that is the primary key of the map and is paired with an array of string values. | | +| ttl | DateTime | O | 0..1 | ttl refers to the lifetime of the record. After the expiry, the record shall be deleted. | | +| callbackReference | Uri | O | 0..1 | The Uri where the NF Service Consumer shall receive notification on the expiry of the Record as indicated by the ttl attribute if desired. | | + +##### 6.1.6.2.4 Type: RecordBody + +Table 6.1.6.2.4-1: Definition of type RecordBody + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|-------------|---------------| +| record | Record | M | 1 | The record. | | + +##### 6.1.6.2.5 Type: Record + +Table 6.1.6.2.5-1: Definition of type Record + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------|---|-------------|---------------------------------------------|---------------| +| meta | RecordMeta | M | 1 | The meta of a record. | | +| blocks | array(Block) | O | 1..N | The block(s) (if any) making up the record. | | + +##### 6.1.6.2.6 Type: BlockBody + +Table 6.1.6.2.6-1: Definition of type BlockBody + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|-------------|---------------| +| n/a | Block | M | 1 | The block. | | + +##### 6.1.6.2.7 Type: Block + +Table 6.1.6.2.7-1: Definition of type Block + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|-----------------------------------|---------------| +| value | Any Type | M | 1 | The block value of any data type. | | + +##### 6.1.6.2.8 Type: SearchCondition + +Table 6.1.6.2.8-1: Definition of type SearchCondition + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| cond | ConditionOperator | M | 1 | Logical operator ("AND", "OR" or "NOT") | | +| units | array(SearchExpression) | M | 1..N |

For the logical "NOT" operator indicated in the cond attribute, only one member shall be present in the array.

For the logical "AND" or "OR" operators indicated in the cond attribute, at least two members shall be present in the array and all the members in the array shall be interpreted as logically concatenated with the logical operator.

| | + +##### 6.1.6.2.9 SearchComparison + +Table 6.1.6.2.9-1: Definition of type SearchComparison + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------|---|-------------|----------------------------------------------------------------------------------------------|---------------| +| op | ComparisonOperator | M | 1 | Comparison operator | | +| tag | string | M | 1 | This attribute contains the tag name of an array of strings. | | +| value | string | M | 1 | The array of strings indicated in the tag attribute compares to the value of this attribute. | | + +##### 6.1.6.2.10 Type: NotificationSubscription + +Table 6.1.6.2.10-1: Definition of type NotificationSubscription + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|--------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| clientId | ClientId | M | 1 | Identity of the NF or NFSet for which the subscription applies. | | +| callbackReference | Uri | M | 1 | Identifies the NF or NF pool where the notification shall be sent. | | +| expiry | DateTime | C | 0..1 | This IE shall be included in a subscription response, if, based on operator policy and taking into account the expiry time included in the request, the UDSF needs to include an expiry time. The expiry time, based on operator policy, may indicate a value that is sooner than the NF consumer requested. The absence of this attribute in the subscription response indicates that the subscription does not have an expiry time. | | +| subFilter | SubscriptionFilter | O | 0..1 | If not included, the subscription applies to all Create, Delete and Update events of the storage. | | +| supportedFeatures | SupportedFeatures | O | 0..1 | Used to negotiate the applicability of optional features | | + +##### 6.1.6.2.11 Type: RecordNotification + +Table 6.1.6.2.11-1: Definition of type RecordNotification + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------------|---|-------------|---------------------------------------------|---------------| +| descriptor | NotificationDescription | M | 1 | The block value of any data type. | | +| meta | RecordMeta | M | 1 | The meta of a record. | | +| blocks | array(Block) | O | 1..n | The block(s) (if any) making up the record. | | + +##### 6.1.6.2.12 Type: NotificationDescription + +Table 6.1.6.2.12-1: Definition of type NotificationDescription + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------|---------------| +| recordRef | Uri | M | 1 | The reference of the record triggering the Notification. | | +| operationType | RecordOperation | M | 1 | The operation type. | | +| subscriptionId | string | O | 0..1 | This IE shall contain the subscriptionId that uniquely identifies the subscription to notification within a storage when present. | | + +##### 6.1.6.2.13 Type: SubscriptionFilter + +Table 6.1.6.2.13-1: Definition of type SubscriptionFilter + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------|------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| monitoredResourceUris | array(Uri) | O | 1..N |

A set of URIs that identify the records for which a modification of the representation triggers a notification.

The URI shall take the form of either an absolute URI or an absolute-path reference as defined in IETF RFC 3986 [22], also see NOTE 1.

The monitored resource shall indicate an existing record.

If not present, the subscription is applied to all records within the storage and a modification of the representation of any record within the storage triggers a notification.

| | +| operations | array(RecordOperation) | O | 0..3 |

The operations that shall generate a notification.

If the monitoredResourceUris is present, only "UPDATED" and "DELETED" are allowed values, any other value shall be ignored.

If the attribute is not present, all applicable operations shall apply to the subscription.

| | + +NOTE 1: The UDSF should handle only the relative-path part (apiSpecificResourceUriPart, see 3GPP TS 29.501 [5] clause 4.4.1) and ignore possible inconsistencies (caused by e.g. an SCP) in the base URI part. + +##### 6.1.6.2.14 Type: ClientId + +Table 6.1.6.2.14-1: Definition of type ClientId + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------|---|-------------|-------------------------------------------------------------------------------------------------------------------|---------------| +| nfId | NfInstanceId | C | 0..1 |

The NF Instance Id uniquely identifying the NF Consumer.

Shall be present if the nfSetId is absent.

| | +| nfSetId | NfSetId | C | 0..1 |

The NF Set Id of the NF Consumer.

Shall be present if the nfId is absent.

| | + +#### 6.1.6.3 Simple data types and enumerations + +##### 6.1.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 6.1.6.3.2 Simple data types + +The simple data types defined in table 6.1.6.3.2-1 shall be supported. + +**Table 6.1.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| | | | | + +##### 6.1.6.3.3 Enumeration: ComparisonOperator + +The enumeration ComparisonOperator represents the comparison of an array of strings to a string value. The comparison shall be based on lexicographical order. It shall comply with the provisions defined in table 6.1.6.3.3-1. + +**Table 6.1.6.3.3-1: Enumeration ComparisonOperator** + +| Enumeration value | Description | Applicability | +|-------------------|--------------------------------------------------------------------------------|---------------| +| "EQ" | The array contains the string value. | | +| "NEQ" | The array does not contain the string value. | AdvancedQuery | +| "GT" | The array contains a string that is greater than the string value. | AdvancedQuery | +| "GTE" | The array contains a string that is greater than or equal to the string value. | AdvancedQuery | +| "LT" | The array contains a string that is less than the string value. | AdvancedQuery | +| "LTE" | The array contains a string that is less than or equal to the string value. | AdvancedQuery | + +NOTE: It's recommended to use GT/GTE/LT/LTE on single value tags. If not, the logical operator "NOT" applied over the comparison operator "GT" evaluates to "true" if **there are no members** in the array that are greater than the value. + +##### 6.1.6.3.4 Enumeration: ConditionOperator + +**Table 6.1.6.3.4-1: Enumeration ConditionOperator** + +| Enumeration value | Description | Applicability | +|-------------------|---------------|---------------| +| "AND" | Logical "AND" | | +| "OR" | Logical "OR" | | +| "NOT" | Logical "NOT" | | + +##### 6.1.6.3.5 Enumeration: RecordOperation + +**Table 6.1.6.3.5-1: Enumeration RecordOperation** + +| Enumeration value | Description | Applicability | +|-------------------|--------------------------------------|---------------| +| "CREATED" | Indicates a Create record operation | | +| "UPDATED" | Indicates an Update record operation | | +| "DELETED" | Indicates a Delete record operation | | + +#### 6.1.6.4 Data types describing alternative data types or combinations of data types + +##### 6.1.6.4.1 Type: SearchExpression + +**Table 6.1.6.4.1-1: Definition of type SearchExpression as a list of mutually exclusive alternatives** + +| Data type | Cardinality | Description | Applicability | +|------------------|-------------|------------------------------------------|---------------| +| SearchCondition | 1 | A search expression with logic operators | AdvancedQuery | +| SearchComparison | 1 | A minimum unit of the search expression | | + +### 6.1.7 Error Handling + +#### 6.1.7.1 General + +For the Nudsf\_DataRepository API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [4] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [4]. + +In addition, the requirements in the following clauses are applicable for the Nudsf\_DataRepository API. + +#### 6.1.7.2 Protocol Errors + +Protocol errors handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +#### 6.1.7.3 Application Errors + +The application errors defined for the Nudsf\_DataRepository service are listed in Table 6.1.7.3-1. + +**Table 6.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|------------------------|------------------|---------------------------------------------------------------------------------------| +| TTL_VALUE_NOT_ALLOWED | 403 Forbidden | The ttl value indicated in the request exceeds the maximum value allowed in the UDSF. | +| SUBSCRIPTION_EXISTS | 403 Forbidden | The subscription indicated in the HTTP/2 request is not authorized to be operated. | +| REALM_NOT_FOUND | 404 Not Found | The realm indicated in the HTTP/2 request is unavailable in the UDSF. | +| STORAGE_NOT_FOUND | 404 Not Found | The storage indicated in the HTTP/2 request is unavailable in the UDSF. | +| RECORD_NOT_FOUND | 404 Not Found | The record indicated in the HTTP/2 request is unavailable in the UDSF. | +| BLOCK_NOT_FOUND | 404 Not Found | The block indicated in the HTTP/2 request is unavailable in the UDSF. | +| SUBSCRIPTION_NOT_FOUND | 404 Not Found | The subscription indicated in the HTTP/2 request is unavailable in the UDSF. | + +### 6.1.8 Feature negotiation + +The optional features in table 6.1.8-1 are defined for the Nudsf\_DataRepository API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.1.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | AdvancedQuery |

If an NF consumer detects that the UDSF supports the AdvancedQuery feature, it may use values of the ComparisonOperator besides "EQ" and may also use the cond attribute of the SearchCondition.

If an NF consumer detects that the UDSF does not support the AdvancedQuery feature, it shall only use a value of "EQ" of the ComparisonOperator and shall not use the cond attribute of the SearchCondition.

| + +### 6.1.9 Security + +As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Nudsf\_DataRepository API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [9]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [10]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [10], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nudsf\_DataRepository service. + +The Nudsf\_DataRepository API defines a single scope "nudsf-dr" for the entire service, and it does not define any additional scopes at resource or operation level. + +# Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex specifies the formal definition of the API(s) defined in the present specification. It consists of OpenAPI 3.0.0 specifications in YAML format. + +This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository that uses the GitLab software version control system (see 3GPP TS 29.501 [5] clause 5.3.1 and 3GPP TR 21.900 [7] clause 5B). + +## A.2 Nudsf\_DataRepository API + +``` +openapi: 3.0.0 +info: + title: Nudsf_DataRepository + version: 1.0.4 + description: | + Nudsf Data Repository Service. + © 2021, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.598 UDSF Services, V16.6.0. + url: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.598/' + +servers: + - url: '{apiRoot}/nudsf-dr/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - nudsf-dr + +paths: + + /{realmId}/{storageId}/records: + summary: Access to all Records of a Storage + description: >- + root of all Records of a Storage + get: + summary: Records search with get + description: Retrieve one or multiple Records based on filter + operationId: SearchRecord + tags: + - Record CRUD + parameters: + - name: realmId + in: path + description: Identifier of the Realm + required: true + schema: + type: string + example: Realm01 + - name: storageId +``` + +``` + +in: path +description: Identifier of the Storage +required: true +schema: + type: string + example: Storage01 +- name: limit-range +in: query +description: The most number of record references to fetch +schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' +- name: filter +in: query +description: Query filter using conditions on tags +content: + application/json: + schema: + $ref: '#/components/schemas/SearchExpression' +- name: count-indicator +in: query +description: Indicates whether the number of records that matched the criteria shall be +returned. +schema: + type: boolean + default: false +- name: supported-features +in: query +description: Features required to be supported by the target NF +schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: + '200': + description: Successful case. Response contains result of the search. + content: + application/json: + schema: + $ref: '#/components/schemas/RecordSearchResult' + '204': + description: >- + The search condition does not match any Record. + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{realmId}/{storageId}/records/{recordId}: + summary: Access to a specific Record, identified by its RecordId + description: >- + Access to a specific Record + get: + summary: Record access + description: retrieve one specific Record + operationId: GetRecord + tags: + - Record CRUD + parameters: + - name: realmId + in: path + description: Identifier of the Realm + required: true + schema: + type: string + example: Realm01 + - name: storageId + +``` + +``` +in: path +description: Identifier of the Storage +required: true +schema: + type: string + example: Storage01 +- name: recordId + in: path + description: Identifier of the Record + required: true + schema: + type: string + example: 'UserRecordValue000000001' +- name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 7232, 3.2 + schema: + type: string +- name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 7232, 3.3 + schema: + type: string +- name: supported-features + in: query + description: Features required to be supported by the target NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: + '200' : #result ok + $ref: '#/components/responses/RecordBody' + '304': + $ref: '#/components/responses/304' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +put: + summary: Create/Modify Record + description: Create or Modify a Record with a user provided RecordId + operationId: CreateOrModifyRecord + tags: + - Record CRUD + parameters: + - name: realmId + in: path + description: Identifier(name) of the Realm + required: true + schema: + type: string + example: Realm01 + - name: storageId + in: path + description: Identifier of the Storage + required: true + schema: + type: string + example: Storage01 + - name: recordId + in: path + description: Identifier of the Record + required: true + schema: + type: string + example: UserRecordValue000000001 + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 7232, 3.2 +``` + +``` + + schema: + type: string +- name: If-Match + in: header + description: Record validator for conditional requests, as described in RFC 7232, 3.2 + schema: + type: string +- name: get-previous + in: query + description: Retrieve the Record before update + required: false + schema: + type: boolean + default: false +- name: supported-features + in: query + description: Features required to be supported by the target NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +requestBody: + $ref: '#/components/requestBodies/RecordBody' +callbacks: + recordExpired: + '{$request.body#/callbackReference}': + post: + parameters: + - name: Content-Location + in: header + description: The expired record URI + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + requestBody: + $ref: '#/components/requestBodies/RecordBody' + responses: + '204': + description: Callback executed successfully + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +responses: + '200' : # Update with return + $ref: '#/components/responses/RecordBody' + '201': + description: >- + Create case. The resource has been successfully created, location header indicates + the URI of the created Record. + $ref: '#/components/responses/RecordBody' + headers: + Location: + $ref: '#/components/headers/Location' + Cache-Control: + $ref: '#/components/headers/Cache-Control' + ETag: + $ref: '#/components/headers/ETag' + Last-Modified: + $ref: '#/components/headers/Last-Modified' + '204': # Update without return + description: >- + Update case. The resource has been successfully updated and no + additional content is included in the response message. + headers: + Cache-Control: + $ref: '#/components/headers/Cache-Control' + ETag: + $ref: '#/components/headers/ETag' + Last-Modified: + $ref: '#/components/headers/Last-Modified' + '304': + $ref: '#/components/responses/304' + +``` + +``` +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'408': + $ref: 'TS29571_CommonData.yaml#/components/responses/408' +'412': # Return Record value if get-previous=true + $ref: '#/components/responses/RecordBody' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +delete: + summary: Delete a Record with an user provided RecordId + operationId: DeleteRecord + tags: + - Record CRUD + parameters: + - name: realmId + in: path + description: Identifier(name) of the Realm + required: true + schema: + type: string + example: Realm01 + - name: storageId + in: path + description: Identifier of the Storage + required: true + schema: + type: string + example: Storage01 + - name: recordId + in: path + description: Identifier of the Record + required: true + schema: + type: string + example: UserRecordValue000000001 + - name: If-Match + in: header + description: Record validator for conditional requests, as described in RFC 7232, 3.2 + schema: + type: string + - name: get-previous + in: query + description: Retrieve the Record before delete + required: false + schema: + type: boolean + default: false + - name: supported-features + in: query + description: Features required to be supported by the target NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + $ref: '#/components/responses/RecordBodyDelete' + '204': + description: Successful case. + headers: + ETag: + $ref: '#/components/headers/ETag' + Last-Modified: + $ref: '#/components/headers/Last-Modified' + '304': + $ref: '#/components/responses/304' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +``` + +``` + + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '408': + $ref: 'TS29571_CommonData.yaml#/components/responses/408' + '412': # Return return value if get-previous=true + $ref: '#/components/responses/RecordBody' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{realmId}/{storageId}/records/{recordId}/meta: + summary: Access to the meta of a specific Record, identified by its RecordId + description: >- + Access to the meta of a specific Record + get: + summary: Record's meta access + description: retrieve meta of a specific Record + operationId: GetMeta + tags: + - Record CRUD + parameters: + - name: realmId + in: path + description: Identifier of the Realm + required: true + schema: + type: string + example: Realm01 + - name: storageId + in: path + description: Identifier of the Storage + required: true + schema: + type: string + example: Storage01 + - name: recordId + in: path + description: Identifier of the Record + required: true + schema: + type: string + example: 'UserRecordValue000000001' + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 7232, 3.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 7232, 3.3 + schema: + type: string + - name: supported-features + in: query + description: Features required to be supported by the target NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Expected response to a valid request + headers: + Cache-Control: + $ref: '#/components/headers/Cache-Control' + ETag: + $ref: '#/components/headers/ETag' + Last-Modified: + $ref: '#/components/headers/Last-Modified' + content: + application/json: + schema: + $ref: '#/components/schemas/RecordMeta' + +``` + +``` + + '304': + $ref: '#/components/responses/304' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +patch: # patch meta data + summary: Record's meta update + description: update meta of a specific Record + operationId: UpdateMeta + tags: + - Record CRUD + parameters: + - name: realmId + in: path + description: Identifier of the Realm + required: true + schema: + type: string + example: Realm01 + - name: storageId + in: path + description: Identifier of the Storage + required: true + schema: + type: string + example: Storage01 + - name: recordId + in: path + description: Identifier of the Record + required: true + schema: + type: string + example: 'UserRecordValue000000001' + - name: If-Match + in: header + description: Record validator for conditional requests, as described in RFC 7232, 3.2 + schema: + type: string + - name: supported-features + in: query + description: Features required to be supported by the target NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + requestBody: + description: Meta data to patch + content: + application/json-patch+json: + example: '[{ "op": "replace", "path": "/tags/ueId", "value": "450005" }, { "op": "remove", "path": "/tags/recordId" }]' + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + minItems: 1 + required: true + responses: + '200': + description: >- + One or more modification instructions have been discarded, the execution report is returned in response PatchResult. + content: + application/json: + example: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + headers: + Cache-Control: + +``` + +``` + + $ref: '#/components/headers/Cache-Control' + ETag: + $ref: '#/components/headers/ETag' + Last-Modified: + $ref: '#/components/headers/Last-Modified' +'204': + description: >- + Successful case. The meta has been successfully updated and no return is expected. + headers: + Cache-Control: + $ref: '#/components/headers/Cache-Control' + ETag: + $ref: '#/components/headers/ETag' + Last-Modified: + $ref: '#/components/headers/Last-Modified' +'304': + $ref: '#/components/responses/304' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'408': + $ref: 'TS29571_CommonData.yaml#/components/responses/408' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{realmId}/{storageId}/records/{recordId}/blocks: + summary: Access to the Blocks of a specific Record, identified by its RecordId + description: >- + Access to the Blocks of a specific Record + get: + summary: Record's Blocks access + description: retrieve all Blocks of a specific Record + operationId: GetBlockList + tags: + - Block CRUD + parameters: + - name: realmId + in: path + description: Identifier of the Realm + required: true + schema: + type: string + example: Realm01 + - name: storageId + in: path + description: Identifier of the Storage + required: true + schema: + type: string + example: Storage01 + - name: recordId + in: path + description: Identifier of the Record + required: true + schema: + type: string + example: 'UserRecordValue000000001' + - name: supported-features + in: query + description: Features required to be supported by the target NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Expected response to a successful request + headers: + Cache-Control: + $ref: '#/components/headers/Cache-Control' + ETag: + +``` + +``` + + $ref: '#/components/headers/ETag' + Last-Modified: + $ref: '#/components/headers/Last-Modified' +content: + multipart/parallel: + schema: + type: object + properties: + blocks: + type: array + description: >- + an array of Block parts, can be empty + items: + $ref: '#/components/schemas/Block' +encoding: + blocks: + contentType: '*/*' # Block content type can be of any type. + headers: + Content-ID: # Block identifier is defined by the Content-Id header. + schema: + type: string + required: true + Content-Transfer-Encoding: + schema: + type: string + required: true +'204': + description: Successful response, the record contains no blocks +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{realmId}/{storageId}/records/{recordId}/blocks/{blockId}: + summary: Access to a Block of a specific Record, identified by its BlockId + description: >- + Access to a specific Block of a specific Record + get: + summary: Retrieve a specific Block + description: retrieve a specific Block + operationId: GetBlock + tags: + - Block CRUD + parameters: + - name: realmId + in: path + description: Identifier of the Realm + required: true + schema: + type: string + example: Realm01 + - name: storageId + in: path + description: Identifier of the Storage + required: true + schema: + type: string + example: Storage01 + - name: recordId + in: path + description: Identifier of the Record + required: true + schema: + type: string + example: 'UserRecordValue000000001' + - name: blockId + in: path + description: Id of the Block + +``` + +``` + required: true + schema: + type: string + example: 'userDefjson01' +- name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 7232, 3.2 + schema: + type: string +- name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 7232, 3.3 + schema: + type: string +- name: supported-features + in: query + description: Features required to be supported by the target NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: + '200': + $ref: '#/components/responses/BlockBody' + '304': + $ref: '#/components/responses/304' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +put: + summary: Create or Update a specific Block in a Record. + description: Create or update a specific Block, related to a Record + operationId: CreateOrModifyBlock + tags: + - Block CRUD + parameters: + - name: realmId + in: path + description: Identifier of the Realm + required: true + schema: + type: string + example: Realm01 + - name: storageId + in: path + description: Identifier of the Storage + required: true + schema: + type: string + example: Storage01 + - name: recordId + in: path + description: Identifier of the Record + required: true + schema: + type: string + example: 'UserRecordValue0000000001' + - name: blockId + in: path + description: Id of the Block + required: true + schema: + type: string + example: 'userDefjson01' + - name: get-previous + in: query + description: Retrieve the Block before update + required: false + schema: +``` + +``` + + type: boolean + default: false +- name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 7232, 3.2 + schema: + type: string +- name: If-Match + in: header + description: Record validator for conditional requests, as described in RFC 7232, 3.2 + schema: + type: string +- name: supported-features + in: query + description: Features required to be supported by the target NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +requestBody: + description: information on the Block to create + required: true + content: + '*/*': + schema: + $ref: '#/components/schemas/Block' +responses: + '200': + $ref: '#/components/responses/BlockBody' + '201': + description: >- + Creation case. The Block has been successfully created. Location header indicates the + URI of the created Block. + headers: + Location: + $ref: '#/components/headers/Location' + Cache-Control: + $ref: '#/components/headers/Cache-Control' + ETag: + $ref: '#/components/headers/ETag' + Last-Modified: + $ref: '#/components/headers/Last-Modified' + '204': + description: >- + Successful case. The resource has been successfully updated. + headers: + Cache-Control: + $ref: '#/components/headers/Cache-Control' + ETag: + $ref: '#/components/headers/ETag' + Last-Modified: + $ref: '#/components/headers/Last-Modified' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '408': + $ref: 'TS29571_CommonData.yaml#/components/responses/408' + '412': # Return previous Block value if get-previous=true + $ref: '#/components/responses/BlockBody' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +delete: + summary: Delete a specific Block. Then update the Record + description: delete a specific Block, related to a Record + operationId: DeleteBlock + tags: + - Block CRUD + parameters: + - name: realmId + +``` + +``` + +in: path +description: Identifier of the Realm +required: true +schema: + type: string + example: Realm01 +- name: storageId +in: path +description: Identifier of the Storage +required: true +schema: + type: string + example: Storage01 +- name: recordId +in: path +description: Identifier of the Record +required: true +schema: + type: string + example: 'UserRecordValue000000001' +- name: blockId +in: path +description: Id of the Block +required: true +schema: + type: string + example: 'userDefjson01' +- name: get-previous +in: query +description: Retrieve the Block before delete +required: false +schema: + type: boolean + default: false +- name: If-Match +in: header +description: Record validator for conditional requests, as described in RFC 7232, 3.2 +schema: + type: string +- name: supported-features +in: query +description: Features required to be supported by the target NF +schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: + '200': + $ref: '#/components/responses/BlockBodyDelete' + '204': + description: >- + Successful case. The Block has been successfully deleted. + headers: + ETag: + $ref: '#/components/headers/ETag' + Last-Modified: + $ref: '#/components/headers/Last-Modified' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '408': + $ref: 'TS29571_CommonData.yaml#/components/responses/408' + '412': # Return previous Block value if get-previous=true + $ref: '#/components/responses/BlockBody' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{realmId}/{storageId}/subs-to-notify: + summary: The notification subscription collection resource + description: >- + Access to the subscription resource + +``` + +``` +get: + summary: Notification subscription retrieval + description: retrieve all notification subscriptions of the storage + operationId: GetNotificationSubscriptions + tags: + - NotificationSubscriptions CRUD + parameters: + - name: realmId + in: path + description: Identifier of the Realm + required: true + schema: + type: string + example: Realm01 + - name: storageId + in: path + description: Identifier of the Storage + required: true + schema: + type: string + example: Storage01 + - name: limit-range + in: query + description: The maximum number of NotificationSubscriptions to fetch + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + - name: supported-features + in: query + description: Features required to be supported by the target NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/NotificationSubscription' + '304': + $ref: '#/components/responses/304' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{realmId}/{storageId}/subs-to-notify/{subscriptionId}: + summary: The notification subscription resource + description: >- + Access to the subscription resource + get: + summary: Notification subscription retrieval + description: retrieve a single notification subscription of the storage + operationId: GetNotificationSubscription + tags: + - NotificationSubscription CRUD + parameters: + - name: realmId + in: path + description: Identifier of the Realm + required: true + schema: + type: string + example: Realm01 + - name: storageId + in: path + description: Identifier of the Storage +``` + +``` + required: true + schema: + type: string + example: Storage01 +- name: subscriptionId + in: path + description: Identifier of the NotificationSubscription + required: true + schema: + type: string + example: Subscription01 +- name: supported-features + in: query + description: Features required to be supported by the target NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +- name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 7232, 3.2 + schema: + type: string +- name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 7232, 3.3 + schema: + type: string +responses: + '200': + description: Expected response to a valid request + headers: + Cache-Control: + $ref: '#/components/headers/Cache-Control' + ETag: + $ref: '#/components/headers/ETag' + Last-Modified: + $ref: '#/components/headers/Last-Modified' + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationSubscription' + '304': + $ref: '#/components/responses/304' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +delete: + summary: Delete a Notification Subscription of the storage + description: delete a single subscriptions of the storage + operationId: DeleteNotificationSubscription + tags: + - NotificationSubscription CRUD + parameters: + - name: realmId + in: path + description: Identifier of the Realm + required: true + schema: + type: string + example: Realm01 + - name: storageId + in: path + description: Identifier of the Storage + required: true + schema: + type: string + example: Storage01 +``` + +``` +- name: subscriptionId + in: path + description: Identifier of the NotificationSubscription + required: true + schema: + type: string + example: Subscription01 +- name: client-id + in: query + description: Identifies the NF or NFSet + required: true + schema: + $ref: '#/components/schemas/ClientId' +- name: get-previous + in: query + description: Retrieve the NotificationSubscription before delete + required: false + schema: + type: boolean + default: false +- name: If-Match + in: header + description: Record validator for conditional requests, as described in RFC 7232, 3.2 + schema: + type: string +- name: supported-features + in: query + description: Features required to be supported by the target NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: + '200': + description: Deleted NotificationSubscription if requested with get-previous + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/NotificationSubscription' + '204': + description: >- + Successful case. The SubscriptionNotification has been successfully deleted. + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '408': + $ref: 'TS29571_CommonData.yaml#/components/responses/408' + '412': + description: Return previous NotificationSubscription value if get-previous=true + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationSubscription' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +patch: # patch NotificationSubscription data + summary: NotificationSubscription update + description: update a specific NotificationSubscription + operationId: UpdateNotificationSubscription + tags: + - NotificationSubscription CRUD + parameters: + - name: realmId + in: path + description: Identifier of the Realm + required: true + schema: + type: string +``` + +``` + example: Realm01 +- name: storageId + in: path + description: Identifier of the Storage + required: true + schema: + type: string + example: Storage01 +- name: subscriptionId + in: path + description: Identifier of the NotificationSubscription + required: true + schema: + type: string + example: Subscription01 +- name: If-Match + in: header + description: Validator for conditional requests, as described in RFC 7232, 3.2 + schema: + type: string +- name: supported-features + in: query + description: Features required to be supported by the target NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +requestBody: + description: data to patch + content: + application/json-patch+json: + example: 'TBD' + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + minItems: 1 + required: true +responses: + '200': + description: >- + One or more modification instructions have been discarded, the execution report is +returned in response PatchResult. + content: + application/json: + example: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + headers: + Cache-Control: + $ref: '#/components/headers/Cache-Control' + ETag: + $ref: '#/components/headers/ETag' + Last-Modified: + $ref: '#/components/headers/Last-Modified' + '204': + description: >- + Successful case. The meta has been successfully updated and no return is expected. + headers: + Cache-Control: + $ref: '#/components/headers/Cache-Control' + ETag: + $ref: '#/components/headers/ETag' + Last-Modified: + $ref: '#/components/headers/Last-Modified' + '304': + $ref: '#/components/responses/304' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '408': + $ref: 'TS29571_CommonData.yaml#/components/responses/408' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +put: + summary: NotificationSubscription Create/Update + operationId: CreateAndUpdateNotificationSubscription + tags: + - NotificationSubscription CRUD + parameters: + - name: realmId + in: path + description: Identifier of the Realm + required: true + schema: + type: string + example: Realm01 + - name: storageId + in: path + description: Identifier of the Storage + required: true + schema: + type: string + example: Storage01 + - name: subscriptionId + in: path + description: Identifier of the NotificationSubscription + required: true + schema: + type: string + example: Subscription01 + - name: supported-features + in: query + description: Features required to be supported by the target NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 7232, 3.2 + schema: + type: string + - name: If-Match + in: header + description: Record validator for conditional requests, as described in RFC 7232, 3.2 + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationSubscription' + required: true + responses: + '200' : # Update + description: Expected response to a valid update request + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationSubscription' + '201': + description: Expected response to a valid create request + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationSubscription' + headers: + Location: + description: 'Contains the URI of the newly created resource according to the +structure: {apiRoot}/nudsf-dr//{realmId}/{storageId}/subs-to-notify/{subscriptionId}' + required: true + schema: + type: string + Cache-Control: + $ref: '#/components/headers/Cache-Control' + ETag: + $ref: '#/components/headers/ETag' + Last-Modified: + $ref: '#/components/headers/Last-Modified' +``` + +``` + + '304': + $ref: '#/components/responses/304' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '408': + $ref: 'TS29571_CommonData.yaml#/components/responses/408' + '409': + description: Conflict + content: + application/json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + '412': + $ref: 'TS29571_CommonData.yaml#/components/responses/412' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + callbacks: + onDataChange: + '{request.body#/callbackReference}': + post: + requestBody: + $ref: '#/components/requestBodies/RecordNotificationBody' + responses: + '204': + description: Callback executed successfully + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nudsf-dr: Access to the nudsf-dr API + +schemas: + RecordSearchResult: + description: Count and collection of Record references matching the providing filter. + type: object + properties: + count: + # The total number of elements found. + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + references: + # The Record references found. If count-indicator is true, no references are +sent back. + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + minItems: 1 + supportedFeatures: + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - count +RecordMeta: + description: Meta data of a Record + type: object + properties: + ttl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + callbackReference: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + tags: + type: object # dictionary type + description: >- + A dictionary of { "tagName": [ "tagValue", ... ] }. A tag name can be used to retrieve a + Record. The tagValue are unique. + additionalProperties: + type: array + items: + type: string + uniqueItems: true + minItems: 1 + minProperties: 1 + example: '{ "ueId" : [ "455345", "455346" ], "recordId" : [ "1000106" ] }' + example: >- + { "tags" : { "ueId" : [ "455345", "455346" ], "recordId" : [ "1000106" ] } } + +Record: + description: Definition of a Record + type: object + properties: + meta: + # json representation of the Meta Data + $ref: '#/components/schemas/RecordMeta' + blocks: + # List of multipart data + type: array + description: list of opaque Block's in this Record + items: + $ref: '#/components/schemas/Block' + minItems: 1 + required: + - meta + example: >- + { "meta": { "tags" : { "tag1" : [ "value1" ], "tag2" : [ "value2" ] } }, "blocks": [ { "Content-ID": + "userDefBinaryBlob", "Content-Type": "text/plain", "content": "QmxvY2sgY29udGVudA==", { "Content- + Id": "userDefJsonBlob", "Content-Type": "application/json", "content": { "key": "ftsimpletype- + 99955000000002", "value": "A3E71A78377179B5B91A;imsi-999550000000123" } } ] } } + +Block: + description: A Block can be of any type + example: >- + "QmxvY2sgY29udGVudA==" + +NotificationSubscription: + description: Definition of a notification subscription + type: object + properties: + clientId: + $ref: '#/components/schemas/ClientId' + callbackReference: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + expiry: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + subFilter: + $ref: '#/components/schemas/SubscriptionFilter' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - clientId + - callbackReference + +RecordNotification: + description: Definition of a notification on a record + type: object + properties: + descriptor: + # json representation of the notification description + $ref: '#/components/schemas/NotificationDescription' + +``` + +``` + +meta: + # json representation of the Meta Data + $ref: '#/components/schemas/RecordMeta' +blocks: + # List of multipart data + type: array + description: list of opaque Block's in this Record + items: + $ref: '#/components/schemas/Block' +required: + - descriptor + - meta +example: >- + {"descriptor": { "recordRef" : "...", "operationType" : "DELETED"}, "meta": { "tags" : +{"tag1" : ["value1"], "tag2" : ["value2"]} }, "blocks": [{"Content-ID": "userDefBinaryBlob", +"Content-Type": "text/plain", "content": "QmxvY2sgY29udGVudA=="}, {"Content-Id": "userDefJsonBlob", +"Content-Type": "application/json", "content": "{"key": "ftsimpletype-9995500000000002", "value": +"A3E71A78377179B5B91A;imsi-99955000000000123"}}] +NotificationDescription: + description: Description of a record notification + type: object + properties: + recordRef: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + operationType: + $ref: '#/components/schemas/RecordOperation' + subscriptionId: + # unique identifier of the NotificationSubscription + type: string + required: + - recordRef + - operationType + example: >- + { "record" : "...", "operationType" : "DELETED"} + +SubscriptionFilter: + description: A subscription filter + type: object + properties: + monitoredResourceUris: + type: array + description: list of resources applicable to the subscription + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + minItems: 1 + operations: + type: array + description: list of resources applicable to the subscription + items: + $ref: '#/components/schemas/RecordOperation' + maxItems: 3 + +ClientId: + description: Defines the identity of the NF Consumer + type: object + properties: + nfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + nfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + +RecordOperation: + description: Indicate operation made on a record + anyOf: + - type: string + enum: + - CREATED + - UPDATED + - DELETED + - type: string + +ConditionOperator: + description: TBD + anyOf: + - type: string + enum: + - AND + +``` + +``` + + - OR + - NOT + - type: string + +ComparisonOperator: + description: TBD + anyOf: + - type: string + enum: + # Equals + - EQ + # Not Equal + - NEQ + # Greater Than + - GT + # Greater Than or Equal + - GTE + # Less Than + - LT + # Less Than or Equal + - LTE + - type: string + +SearchExpression: + description: A logical expression element + type: object + oneOf: + - $ref: '#/components/schemas/SearchCondition' + - $ref: '#/components/schemas/SearchComparison' + example: + { "cond": "OR", "units": [ { "op": "EQ", "tag" : "ueId", "value" : "455345" }, { "op": "EQ", "tag" : "supi", "value" : "imsi-999559807001001" } ] } + +SearchCondition: + description: A logical condition + type: object + properties: + cond: + $ref: '#/components/schemas/ConditionOperator' + units: + type: array + items: + $ref: '#/components/schemas/SearchExpression' + minItems: 1 + required: + - cond + - units + example: + { "cond": "OR", "units": [ { "op": "EQ", "tag" : "ueId", "value" : "455345" }, { "op": "EQ", "tag" : "supi", "value" : "imsi-999559807001001" } ] } + +SearchComparison: + description: A comparison to apply on tag/values pairs. + type: object + properties: + op: + $ref: '#/components/schemas/ComparisonOperator' + tag: + type: string + value: + type: string + required: + - op + - tag + - value + example: + { "op": "EQ", "tag" : "supi", "value" : "imsi-999559807001001" } + +headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 7234, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 7232, 2.3 + schema: + type: string + +``` + +``` +Last-Modified: + description: Timestamp for last modification of the resource, as described in RFC 7232, 2.2 + schema: + type: string +Location: + description: Contains the URI of the newly created resource + required: true + schema: + type: string +Retry-After: + description: 'Indicates the time the NF Consumer has to wait before making a new request. It +can be a non-negative integer (decimal number) indicating the number of seconds the NF Consumer has +to wait before making a new request or an HTTP-date after which the AF can retry a new request.' + schema: + anyOf: + - type: integer + - type: string + +requestBodies: +RecordBody: + description: The record multipart request body. The meta part shall be the first part and is +mandatory but can be empty and zero or more block parts may follow the meta part. + required: true + content: + multipart/mixed: + schema: + $ref: '#/components/schemas/Record' + encoding: + meta: # The meta part shall be the first part and is mandatory but can be empty + contentType: application/json + headers: + Content-ID: + schema: + type: string + required: true + blocks: # 0 or more block parts may follow the meta part + contentType: '*/*' # Block part can be of any type + headers: + Content-ID: # Block identifier is defined by the Content-ID header. + schema: + type: string + required: true + Content-Transfer-Encoding: + schema: + type: string + required: true + +RecordNotificationBody: + description: The record notification multipart request body. The descriptor part shall be the +first one, followed by record meta part and by zero or more block parts. + required: true + content: + multipart/mixed: + schema: + $ref: '#/components/schemas/RecordNotification' + encoding: + descriptor: # The descriptor part shall be the first part and is mandatory + contentType: application/json + headers: + Content-ID: + schema: + type: string + required: true + meta: # The meta part shall be the second part and is mandatory but can be empty + contentType: application/json + headers: + Content-ID: + schema: + type: string + required: true + blocks: # 0 or more block parts may follow the meta part + contentType: '*/*' # Block part can be of any type + headers: + Content-ID: # Block identifier is defined by the Content-ID header. + schema: + type: string + required: true + Content-Transfer-Encoding: +``` + +``` + + schema: + type: string + required: true + +responses: + '304': # Etag response if the value might differ from that sent + description: Not Modified + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + headers: + Cache-Control: + $ref: '#/components/headers/Cache-Control' + ETag: + $ref: '#/components/headers/ETag' + Retry-After: + $ref: '#/components/headers/Retry-After' + + 'RecordBody': # Record value with associated headers + description: >- + - 200 Update. The resource has been successfully updated and previous value must be sent in + the response message if requested. + - 200 Get. The resource exists, its value must be sent in the response message + - 412 Precondition Failed, the previous value must be sent in response message if + requested. + content: + multipart/mixed: + schema: + $ref: '#/components/schemas/Record' + encoding: + meta: # The meta part shall be the first part and is mandatory but can be empty. + contentType: application/json + headers: + Content-Id: # The meta part is identified by the 'meta' Content-Id header. + schema: + type: string + required: true + blocks: # Zero or more block parts may follow the meta part + contentType: '*/*' # Block parts can be of any type. + headers: + Content-Id: # Block identifier is defined by the Content-Id header. + schema: + type: string + required: true + Content-Transfer-Encoding: + schema: + type: string + required: true + headers: + Cache-Control: + $ref: '#/components/headers/Cache-Control' + ETag: + $ref: '#/components/headers/ETag' + Last-Modified: + $ref: '#/components/headers/Last-Modified' + + 'RecordBodyDelete': # Record value with associated headers + description: >- + - 200 Delete. The resource has been successfully delete and previous value must be sent in + the response message if requested. + content: + multipart/mixed: + schema: + $ref: '#/components/schemas/Record' + encoding: + meta: # The meta part shall be the first par and is mandatory but can be empty. + contentType: application/json + headers: + Content-ID: # The meta part is identified by the Content-Id header. + schema: + type: string + required: true + blocks: # Zero or more block parts may follow the meta part. + contentType: '*/*' # Block parts can be of any type. + headers: + Content-ID: # Block identifier is defined by the Content-Id header. + schema: + +``` + +``` + type: string + required: true + Content-Transfer-Encoding: + schema: + type: string + required: true +headers: + ETag: + $ref: '#/components/headers/ETag' + Last-Modified: + $ref: '#/components/headers/Last-Modified' + +'BlockBody': # Block value with associated headers + description: >- + - 200 Update: The resource has been successfully updated and previous value must be sent in +the response message if requested. + - 200 Get: The resource exists, its value must be sent in the response message + - 412 Precondition Failed: the previous value must be sent in response message if +requested. + content: + '*/*': + schema: + $ref: '#/components/schemas/Block' + headers: + Cache-Control: + $ref: '#/components/headers/Cache-Control' + ETag: + $ref: '#/components/headers/ETag' + Last-Modified: + $ref: '#/components/headers/Last-Modified' + +'BlockBodyDelete': # Block value with associated headers + description: >- + - 200 Delete: The resource has been successfully delete and previous value must be sent in +the response message if requested. + content: + '*/*': + schema: + $ref: '#/components/schemas/Block' + headers: + ETag: + $ref: '#/components/headers/ETag' + Last-Modified: + $ref: '#/components/headers/Last-Modified' +``` + +# Annex B (informative): Search Examples + +The conditional expression is defined by the following Extended Backus-Naur Form (EBNF) [18]. + +![Figure B-1: Search Expression diagram showing a flow from Search_Comparison to Search_Condition.](57939c16065211317c5442cf2a4009e0_img.jpg) + +``` + +graph LR + Start(( )) --> Search_Comparison[Search_Comparison] + Search_Comparison --> Search_Condition[Search_Condition] + Search_Condition --> End(( )) + +``` + +Figure B-1: Search Expression diagram showing a flow from Search\_Comparison to Search\_Condition. + +Figure B-1: Search Expression + +Search\_Expression ::= Search\_Comparison | Search\_Condition + +![Figure B-2: Search Comparison diagram showing a flow from 'The name of a record tag' through comparison operators (EQ, NEQ, GT, GTE, LT, LTE) to 'The tag value to search for'.](6984a27b2b89e0995d5216ec29b41d1c_img.jpg) + +``` + +graph LR + Tag[The name of a record tag] --> EQ[EQ] + Tag --> NEQ[NEQ] + Tag --> GT[GT] + Tag --> GTE[GTE] + Tag --> LT[LT] + Tag --> LTE[LTE] + EQ --> Value[The tag value to search for] + NEQ --> Value + GT --> Value + GTE --> Value + LT --> Value + LTE --> Value + +``` + +Figure B-2: Search Comparison diagram showing a flow from 'The name of a record tag' through comparison operators (EQ, NEQ, GT, GTE, LT, LTE) to 'The tag value to search for'. + +Figure B-2: Search Comparison + +Search\_Comparison ::= Tag ('EQ' | 'NEQ' | 'GT' | 'GTE' | 'LT' | 'LTE') Value + +![Figure B-3: Search Condition diagram showing a flow from Search_Expression through AND/OR operators to another Search_Expression.](b882c54d92390b4ca523f230e3e07617_img.jpg) + +``` + +graph LR + Search_Expression1[Search_Expression] --> AND[AND] + Search_Expression1 --> OR[OR] + AND --> Search_Expression2[Search_Expression] + OR --> Search_Expression2 + +``` + +Figure B-3: Search Condition diagram showing a flow from Search\_Expression through AND/OR operators to another Search\_Expression. + +Figure B-3: Search Condition + +Search\_Condition ::= Search\_Expression ( ('AND' | 'OR') Search\_Expression )+ + +![Figure B-4: Search ConditionNot diagram showing a flow from NOT operator to Search_Expression.](9c63078ad5b9dbe6d2822eca121fae77_img.jpg) + +``` + +graph LR + NOT[NOT] --> Search_Expression[Search_Expression] + +``` + +Figure B-4: Search ConditionNot diagram showing a flow from NOT operator to Search\_Expression. + +Figure B-4: Search ConditionNot + +Search\_ConditionNot ::= 'NOT' Search\_Expression + +Example: + +Find all records where the tag "ueId" is equal to "455345" OR the tag "supi" is equal to "imsi-999559807001001": + +``` + +{ + "cond": "OR", + "items": [ + { + "op": "EQ", + "tag" : "ueId", + "value" : "455345" + } + ] +} + +``` + +``` + + }, + { + "op": "EQ", + "tag" : "supi", + "value" : "imsi-999559807001001" + } + ] +} + +``` + +# Annex C (informative): HTTP Multipart Examples + +## C.1 General + +This clause provides examples of the HTTP multipart messages. The examples do not aim to be a complete representation of the HTTP message, e.g. additional information or headers can be included. + +This Annex is informative and the normative descriptions in this specification prevail over the description in this Annex if there is any difference. + +## C.2 Example HTTP multipart Record + +Content-Type: multipart/mixed; boundary=partboundary + +``` + +--partboundary +Content-ID: meta +Content-Type: application/json; charset=UTF-8 + +{"tags": { "ueId" : ["455345"], "supi" : ["imsi-999559807001001"] } } +--partboundary + +Content-ID: block1 +Content-Type: application/json; charset=UTF-8 +Content-Transfer-Encoding: binary + +{ "firstName": "John", "lastName": "Doe" } +--partboundary + +Content-ID: block2 +Content-Type: image/png +Content-Transfer-Encoding: binary + + + +--partboundary--' + +``` + +## C.3 Example HTTP multipart BlockCollection + +Content-Type: multipart/parallel; boundary=partboundary + +``` + +--partboundary +Content-ID: block1 +Content-Type: application/json; charset=UTF-8 +Content-Transfer-Encoding: binary + +{ "firstName": "John", "lastName": "Doe" } +--partboundary + +Content-ID: block2 +Content-Type: image/png +Content-Transfer-Encoding: base64 + +``` + +``` + +iVBORw0KGgoAAAANSUhEUGAAADIAAAAEcAYAAABuUU38AAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAACJehZcwAADsMA +AA7DacdvqGQAAAAdEVYdENyZWV0aW9uIFRpbWUAMjAyMDowMjoyMiAxMTowMT0xNelKX7MAAAUTSURBVfh7Zh5qFVVFI dv2XsN +2qRZZoWUPWnSbHrEwwYapMQKbKCRNJ+GmpEN9EdBhCIVRHMEYKWIWqWYTQpKZZmEZTaHPIpcGyySzN9PvuuyS2h3PvPcW70B/v +Bx/33DPss/faa6+19ulRRqbdIO7dUfn9X2mXym+e9o0x0FqhJ2yE9+BZeB3+hkZpfzgZjoXe8Bu8C8thGxTSQfAlaP1qzIFm6Epp +rKvgDdgCvmczfAu/VP47mOhkKZCdPgPeAgeh58q54I7INQCl8PNMAHOhl5QRN53G3wPtrsG7oZTYS/QtTXa8TALvoIBUFCxg26z +HSZ6oqKTwPMxkBUwGF6F9HzwKzwIh0ItXQve/z6cAbVcXt0KK6HQGh8EWjnVCEg7/DP8mfyvxu9wL+wLQ+AyuB3uhydgBnjf86Cl + +``` + +``` +6w3EGVoLo8r//oWa4DpwwWU7WRQH7dpbl/z/Gj6Fz8DZ87xesBiOglrSCE91HtYfeR+4AG6BtOG/QKukshMfwhL4HFykPq+FD4EX +4RnQfTbApeBsRuSz/Q9ANz0GDocZyBXkaQF8A67HqroQjFpZtzFijIYfk3OIVc+EeoZRr4CulKcX4CVwgc8F3SdvHbhW7ZvvrKpd +YROkHRUfvBMeSM6JFjbnFNVsMPLkaTgYdp3JPeATuAhSmdOciahruF0pfWwFdJOZzFB6jbKRnluHjwHdjilIdQw7j150vodcH35 +X6k0GeaDaITX89kf4C4oWpWUZ6YfXAFvQl54nQQh/TrvnkBL+/L7wKogTyZER30Hrqd3QE94ufJ/HDhb/1kOygSVdszFnCY8F6ew +znNLMck5a1PAHJAnA0h/cDA3gm71FnSptJb5IDpmhMqTITYdQPAk6CK6n9Gplk4EQ7MRy2RZVlq6qE6B3TsPy3KK8553sHlaBHuD +s3g0uI6sq0y6DjBkFWDUDGaOANDWIE0D+q3rYcAcA2k0MBvfAFG0Ba6HMZDVCRDXrVI91t3CCA7eBelAroGHwTVg9DP/eM2c48y5 +Pk6DQrIgzHbQSgeJoRWz2Xw1RPHoArYui4HhScOii6aB1zw2J6RyDRSxtG3Zl0KyAItOlsKK0wJSNxgJkSwd+Ntgxeyss6SY09w +Fty7WFimsrxY2HLYUwPBoFKo0jUkPgbWOGnHxdlw2q+E7N7jdIi6KcUklsKoe7OJOJITzR7zm7qrdZsbpCJ6BB7tPKyutHEXnbWN +a8b18BG4G9R9gsns64KNuMEpzKLTJtIeZMvz+R3ElK05sFR6jZc5UGV21m2yM5Wng8EodxS4YzR66gFutv5ROpAuk9Znh9TO7wBe +sAU6YCGJRgMpt7F6gTNRBPLOLOH94UVQJdrrJiJVlJzCwNphiYSqh+KI0Npw9SQGcF0TYeVSuNpvI2B7IClMBsfabwVu9WtbuUq +NifngaEtFqP54Saw9DavnAtuZ61LElegMf8PgEjCxGdvdtjvDZVmdhOsagNrLjdg5gJzjuleDR/DdLC0sdrlu5glUPTHfnjdPT6p +qFxiukfyAl3sFO+BVTZgNeqHAHdjIW+0c35jsiQxETloPxG5c/S6+4+h4PV2sGGCVfmFbrJCVrzeo0GsBuyIstx3gO7L14ER1GfT +/rgbdLAOzplHax67wXLvb7s+48eQsjWsiXxhKl/sww7AjvsiLRR1j416j4qvgd7vueisims+K1HqxD7f99q2WGln+xPviOeVA1D2 +jXqslLwTlVGQ4+/C82oAAAASUVORK5CYII= +--partboundary--' +``` + +## C.4 Example HTTP multipart RecordNotification + +Content-Type: multipart/mixed; boundary=partboundary + +--partboundary + +Content-ID: recordnotification + +Content-Type: application/json; charset=UTF-8 + +``` +{"recordRef" : "...", "operationType" : "DELETED" } +``` + +--partboundary + +Content-ID: meta + +Content-Type: application/json; charset=UTF-8 + +``` +{"tags": { "ueId" : ["455345"], "supi" : ["imsi-999559807001001"] } } +``` + +--partboundary + +Content-ID: block1 + +Content-Type: application/json; charset=UTF-8 + +Content-Transfer-Encoding: binary + +``` +{"firstName": "John", "lastName": "Doe"} +``` + +--partboundary + +Content-ID: block2 + +Content-Type: image/png + +Content-Transfer-Encoding: binary + +``` + +``` + +--partboundary--' + +# Annex D (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|------|------|-----|----------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Re v | Cat | Subject/Comment | New version | +| 2019-11 | CT4#94 | C4-195489 | | | | Initial Draft. | 0.1.0 | +| 2020-03 | CT4#96 | C4-200359
C4-200360
C4-200584
C4-200585
C4-200586
C4-200654
C4-200905
C4-200920
C4-201226
C4-201230
C4-201235
C4-201236
C4-201237 | | | | Implementation of pCRs agreed at CT4#96. | 0.2.0 | +| 2020-03 | CT#87e | CP-200066 | | | | TS presented for information and approval | 1.0.0 | +| 2020-03 | CT#87e | | | | | Approved at CT#87e | 16.0.0 | +| 2020-06 | CT#88e | CP-201175 | 0001 | 4 | B | Subscribe To Notify | 16.1.0 | +| 2020-06 | CT#88e | CP-201041 | 0002 | | C | Removal of Editor's Note | 16.1.0 | +| 2020-06 | CT#88e | CP-201041 | 0003 | | C | Add supportedFeatures to RecordSearchResult | 16.1.0 | +| 2020-06 | CT#88e | CP-201041 | 0004 | | F | SearchExpression | 16.1.0 | +| 2020-06 | CT#88e | CP-201041 | 0006 | 1 | F | Miscellaneous Corrections | 16.1.0 | +| 2020-06 | CT#88e | CP-201041 | 0007 | 1 | B | Storage of YAML files in ETSI Forge | 16.1.0 | +| 2020-06 | CT#88e | CP-201041 | 0008 | | F | 204 missing in OpenAPI | 16.1.0 | +| 2020-06 | CT#88e | CP-201073 | 0009 | | F | Rel-16 API version and External doc update | 16.1.0 | +| 2020-09 | CT#89e | CP-202116 | 0010 | | F | Optionality of ProblemDetails in TS29.598 cleanup | 16.2.0 | +| 2020-12 | CT#90e | CP-203052 | 0011 | 1 | F | Misc corrections | 16.3.0 | +| 2020-12 | CT#90e | CP-203035 | 0012 | | F | Removal of the reference to ETSI Forge | 16.3.0 | +| 2020-12 | CT#90e | CP-203052 | 0013 | 1 | F | Corrections on Subscription and Notification | 16.3.0 | +| 2020-12 | CT#90e | CP-203052 | 0014 | 1 | F | Corrections on yaml of Nudsf_DataRepository OpenAPI | 16.3.0 | +| 2020-12 | CT#90e | CP-203052 | 0015 | 1 | F | Define Unsubscription to notifications service operation | 16.3.0 | +| 2020-12 | CT#90e | CP-203052 | 0016 | 1 | F | Incorrect data type | 16.3.0 | +| 2020-12 | CT#90e | CP-203052 | 0018 | | F | Resource URI problems clean up | 16.3.0 | +| 2020-12 | CT#90e | CP-203036 | 0021 | | F | 29.598 Rel-16 API version and External doc update | 16.3.0 | +| 2021-03 | CT#91e | CP-210039 | 0023 | 1 | F | Removal of paging parameters | 16.4.0 | +| 2021-03 | CT#91e | CP-210039 | 0025 | | F | BlockId clarification | 16.4.0 | +| 2021-03 | CT#91e | CP-210054 | 0030 | | F | 29.598 Rel-16 API version and External doc update | 16.4.0 | +| 2021-06 | CT#92e | CP-211065 | 0034 | | F | Nested cardinality R16 | 16.5.0 | +| 2021-06 | CT#92e | CP-211065 | 0036 | 1 | F | Monitored Resource URI | 16.5.0 | +| 2021-06 | CT#92e | CP-211061 | 0038 | | F | Content-ID | 16.5.0 | +| 2021-06 | CT#92e | CP-211073 | 0041 | | F | 29.598 Rel-16 API version and External doc update | 16.5.0 | +| 2021-09 | CT#93e | CP-212067 | 0043 | | F | Removal of enum | 16.6.0 | +| 2021-09 | CT#93e | CP-212080 | 0046 | | F | 29.598 Rel-16 API version and External doc update | 16.6.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29658/26d664119ad25250780f554633444e54_img.jpg b/marked/Rel-16/29_series/29658/26d664119ad25250780f554633444e54_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7b987347f3344bee76a430987eec237d35b49f44 --- /dev/null +++ b/marked/Rel-16/29_series/29658/26d664119ad25250780f554633444e54_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:18a30dfada6a08da79316431357426e263a6292cb8cf01c4dee765f6f2fb8599 +size 85985 diff --git a/marked/Rel-16/29_series/29658/7d3d5fb5d09c0cd35a9d637be241651e_img.jpg b/marked/Rel-16/29_series/29658/7d3d5fb5d09c0cd35a9d637be241651e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ff19372fed73ff564a01aac51ec2bf9f34823022 --- /dev/null +++ b/marked/Rel-16/29_series/29658/7d3d5fb5d09c0cd35a9d637be241651e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5d93a08da74c17ca2b76c4b884e4d67ef14293dec73b2345ad52bf2591a9f448 +size 61904 diff --git a/marked/Rel-16/29_series/29658/ae53f90bb87d6d09e2d6b5278d7c338f_img.jpg b/marked/Rel-16/29_series/29658/ae53f90bb87d6d09e2d6b5278d7c338f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..fc2e7bb89e83e67e43788e18ea0abd9a5f7508ee --- /dev/null +++ b/marked/Rel-16/29_series/29658/ae53f90bb87d6d09e2d6b5278d7c338f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ac2a59819153350122e34eeb8bd01dd916947e08cecc97fdce223535e20d577a +size 87542 diff --git a/marked/Rel-16/29_series/29658/eb03559a4d92ea9ebd63ea9be663c50a_img.jpg b/marked/Rel-16/29_series/29658/eb03559a4d92ea9ebd63ea9be663c50a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4457edd255fa7430d077c14ebe6ad6602675c772 --- /dev/null +++ b/marked/Rel-16/29_series/29658/eb03559a4d92ea9ebd63ea9be663c50a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:666b5873fada9a1c39e7a09983b544b2e76cfb8eb7d256c6aad2c089fdff3e69 +size 39539 diff --git a/marked/Rel-16/29_series/29658/raw.md b/marked/Rel-16/29_series/29658/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..db561abbd90bf2418d25ccc7e0ecfb07e153d3aa --- /dev/null +++ b/marked/Rel-16/29_series/29658/raw.md @@ -0,0 +1,1534 @@ + + + + + + +# Contents + +| | | +|-------------------------------------------------------|----| +| Foreword ..... | 6 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions and abbreviations ..... | 8 | +| 3.1 Definitions..... | 8 | +| 3.2 Abbreviations ..... | 9 | +| 4 SIP Transfer of Charging Information ..... | 9 | +| 4.1 Description ..... | 9 | +| 4.1.1 General description..... | 9 | +| 4.1.2 Network provider option ..... | 10 | +| 4.2 Coding requirements ..... | 10 | +| 4.3 Functional requirements..... | 10 | +| 4.3.1 Overall requirements ..... | 10 | +| 4.3.2 Procedures at a Charge Determination Point..... | 11 | +| 4.3.2.0 General..... | 11 | +| 4.3.2.1 Procedures during communication set-up..... | 11 | +| 4.3.2.1.1 Tariff indication..... | 11 | +| 4.3.2.1.2 Communication attempt charge ..... | 11 | +| 4.3.2.1.3 Communication set-up charge..... | 12 | +| 4.3.2.1.4 Communication charge ..... | 12 | +| 4.3.2.2 Procedures after start of charging ..... | 13 | +| 4.3.2.2.1 Change current tariff ..... | 13 | +| 4.3.2.2.2 Add-on charge ..... | 13 | +| 4.3.2.3 Subsequent Tariff indications ..... | 13 | +| 4.3.3 Procedures at the charge generation point..... | 13 | +| 4.3.3.0 General..... | 13 | +| 4.3.3.1 Procedures during communication set-up..... | 13 | +| 4.3.3.1.1 Tariff indication..... | 13 | +| 4.3.3.1.2 Communication attempt charge ..... | 14 | +| 4.3.3.1.3 Communication setup charge..... | 14 | +| 4.3.3.1.4 Communication charge ..... | 14 | +| 4.3.3.2 Procedures after start of charge ..... | 15 | +| 4.3.3.2.1 Change current tariff ..... | 15 | +| 4.3.3.2.2 Add-on Charge ..... | 16 | +| 4.3.3.3 Subsequent Tariff indications ..... | 16 | +| 4.3.4 Handling of identifiers..... | 16 | +| 4.4 Signalling requirements..... | 17 | +| 4.4.1 General ..... | 17 | +| 4.4.2 Procedures during communication set-up ..... | 17 | +| 4.4.2.1 Procedures at the CDP ..... | 17 | +| 4.4.3 Procedures after start of charging..... | 17 | +| 4.4.3.1 Procedures at the CDP ..... | 17 | +| 4.5 Interaction with other services ..... | 17 | +| 4.6 Interactions with other networks..... | 17 | +| 4.6.1 Interaction with PSTN/ISDN ..... | 17 | +| 4.6.2 Interaction with PSTN/ISDN Emulation..... | 20 | +| 4.6.3 Interaction with external IP networks..... | 20 | +| 5 Extensions within the present document..... | 20 | +| 5.1 SIP Transfer of Tariff Information XML body ..... | 20 | +| 5.1.1 General ..... | 20 | +| 5.1.2 MIME type definition..... | 20 | +| 5.1.2.1 Introduction..... | 20 | +| 5.1.2.2 Syntax ..... | 20 | +| 5.1.2.3 Operation ..... | 21 | + +| | | | +|-------------------------------|-----------------------------------------------------------|-----------| +| Annex A (informative): | Signalling flows..... | 22 | +| Annex B (informative): | SIP Transfer of Tariff Information parameters..... | 26 | +| B.1 | General..... | 26 | +| B.2 | NNI Information ..... | 26 | +| B.2.0 | General ..... | 26 | +| B.2.1 | Charge Message Type..... | 26 | +| B.2.2 | Add On Charge Information ..... | 26 | +| B.2.2.0 | General ..... | 26 | +| B.2.2.1 | Add On Charge..... | 26 | +| B.2.2.1.0 | General..... | 26 | +| B.2.2.1.1 | Add On Charge Currency ..... | 27 | +| B.2.2.1.2 | Add On Charge Pulse ..... | 27 | +| B.2.3 | Tariff Information ..... | 27 | +| B.2.3.0 | General ..... | 27 | +| B.2.3.1 | Tariff..... | 27 | +| B.2.3.1.0 | General..... | 27 | +| B.2.3.1.1 | Tariff Currency ..... | 27 | +| B.2.3.1.1.0 | General ..... | 27 | +| B.2.3.1.1.1 | Current Tariff Currency ..... | 27 | +| B.2.3.1.1.2 | Tariff Switch Currency..... | 28 | +| B.2.3.1.1.2.0 | General ..... | 28 | +| B.2.3.1.1.2.1.0 | General..... | 28 | +| B.2.3.1.1.2.1.1.0 | General..... | 28 | +| B.2.3.1.1.2.1.1.1.0 | General..... | 28 | +| B.2.3.1.2 | Tariff Pulse ..... | 28 | +| B.2.3.1.2.1 | Current Tariff Pulse..... | 28 | +| B.2.3.1.2.2 | Tariff Switch Pulse..... | 29 | +| B.3 | Common information elements/types ..... | 29 | +| B.3.1 | Identification ..... | 29 | +| B.3.1.1 | Origination identification ..... | 29 | +| B.3.1.2 | Destination identification ..... | 29 | +| B.3.1.3 | Charge reference identification ..... | 29 | +| B.3.1.4 | Network identification..... | 29 | +| B.3.1.5 | Reference ID..... | 29 | +| B.3.1.6 | Network operators ..... | 30 | +| B.3.2 | Charge ..... | 30 | +| B.3.2.1 | Charge control indicators ..... | 30 | +| B.3.2.1.0 | General..... | 30 | +| B.3.2.1.1 | Immediate change of actually applied tariff ..... | 30 | +| B.3.2.1.2 | Delay until start..... | 30 | +| B.3.2.2 | Currency ..... | 30 | +| B.3.2.3 | Currency factor scale..... | 30 | +| B.3.2.3.1 | Currency factor ..... | 30 | +| B.3.2.3.2 | Currency scale..... | 30 | +| B.3.2.4 | Pulse units type..... | 31 | +| B.3.2.5 | Communication charge currency type..... | 31 | +| B.3.2.5.1 | Tariff duration..... | 31 | +| B.3.2.5.2 | Sub tariff control ..... | 31 | +| B.3.2.6 | Tariff control iIndicators ..... | 31 | +| B.3.2.7 | Call attempt charge currency..... | 31 | +| B.3.2.8 | Call setup charge currency ..... | 32 | +| B.3.2.9 | Tariff switchover time type ..... | 32 | +| B.3.2.10 | Communication charge pulse type ..... | 32 | +| B.3.2.10.1 | Pulse units ..... | 32 | +| B.3.2.10.2 | Charge unit time interval ..... | 32 | +| B.3.2.10.3 | Tariff duration..... | 32 | +| B.3.2.11 | Tariff pulse format type..... | 32 | +| B.3.2.11.1 | Communication charge sequence pulse..... | 33 | +| B.3.2.11.2 | Call attempt charge pulse..... | 33 | + +B.3.2.11.3 Call setup charge pulse ..... 33 +B.3.2.12 Tariff duration type..... 33 +B.3.2.13 Sub tariff control type..... 33 +B.3.2.14 Charge unit time interval type ..... 33 +**Annex C (normative): SIP Transfer of Tariff Information XML schema:..... 35** +**Annex D (informative): IANA registration templates ..... 38** +D.1 IANA registry for Application Media Types..... 38 +D.1.1 IANA Registration template for application/vnd.etsi.sci+xml..... 38 +Annex E (informative): Change history..... 40 + +# --- Foreword + +This Technical Specification (TS) was been produced by ETSI Technical Committee Telecommunications and Internet converged Services and Protocols for Advanced Networking (TISPAN) and originally published as ETSI TS 183 058 [7]. It was transferred to the 3rd Generation Partnership Project (3GPP) in January 2008. + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 1 Scope + +The present document specifies the Stage 3 of the real-time transfer of Tariff Information between a Charge Determination Point (CDP) and a Charge Generation Point (CGP) by means of the Session Initiation Protocol (SIP). + +It identifies the protocol procedures and switching functions needed to support the transfer of tariff information related to IP multimedia services. The information needed to support the ISDN User part (ISUP) signalling aspects of charging (ES 201 296 [6]) for Advice of Charge information purposes is also specified, however, it can be used for other purposes as well where applicable. + +The present document is applicable to an environment where different operators are working together. It is also applicable to a single network operator environment. + +Whether the present document is applicable to a national environment and/or can be used for inter-network purposes depends on regulatory demands and/or bilateral agreements. It should be noted that there are network requirements and signalling limitations that are not covered because they are outside the scope of the present document. Examples of these are as follows: + +- the on-line provided advice of charge information may not accurately reflect the correct charging rate due to discount rates, special charging arrangements, etc. It is out of scope to ensure alignment of this information; +- complaint handling between network operators in case of incorrect advice of charge information; +- explicit encryption or special security mechanisms; +- usage of the transferred tariff information for charging purposes; +- interaction between UE and CGP for possible confirmation of provided tariffs; +- any function behind the CGP towards the UE. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +The following referenced documents are indispensable for the application of the present document. For dated references, only the edition cited applies. For non-specific references, the latest edition of the referenced document (including any amendments) applies. + +- [1] 3GPP TS 22.173: "IP Multimedia Core Network Subsystem (IMS) Multimedia Telephony Service and supplementary services; Stage 1". +- [2] IETF RFC 2976: "The SIP INFO Method". +- [3] IETF RFC 4006: "Diameter Credit-Control Application". +- [4] 3GPP TS 24.229: "Internet Protocol (IP) multimedia call control protocol based on Session Initiation Protocol (SIP) and Session Description Protocol (SDP); Stage 3". +- [5] ISO 4217: "International Organization for Standardization; Type Currency Code List". +- [6] ETSI ES 201 296 (V1.3.1): "Integrated Services Digital Network (ISDN); Signalling System No.7 (SS7); ISDN User Part (ISUP); Signalling aspects of charging". + +- [7] ETSI TS 183 058 V2.0.0: "Telecommunications and Internet Converged Services and Protocols for Advanced Networking (TISPAN); SIP Transfer of IP Multimedia Service Tariff Information; Protocol specification". +- [8] RFC 3261 (June 2002): "SIP: Session Initiation Protocol". +- [9] RFC 3023 (January 2001): "XML Media Types". +- [10] RFC 4288 (December 2005): "Media Type Specifications and Registration Procedures". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TS 22.173 [1] and the following apply: + +**absolute time:** time of the day representing GMT + +**add-on charge:** single additional charge which does not change the current tariff + +NOTE: An add-on charge can either be metered in non-monetary units (e.g. meter-pulse) or in monetary-units (e.g. currency). + +**charge:** number of charge units (for the usage of a chargeable event (telecommunication service)) + +**Charge Determination Point (CDP):** determines which tariff/add-on charge should be applied, and inserts the tariff/add-on charge information to the appropriate SIP requests or responses + +NOTE: Example of a CDP is a SIP AS at the visited IMS network providing the premium rate service. + +**Charge Generation Point (CGP):** receives the tariff/add-on charge information that was added by a CDP and transferred in the appropriate SIP requests or responses + +NOTE: Example of a CGP is an originating SIP AS at the home IMS network for advice of charge purposes. + +**charge unit:** base element for the charging process, expressed in non-monetary or monetary units + +**charging:** function within the telecommunications network and the associated OCS/BD components whereby information related to a chargeable event is collected, formatted, transferred and evaluated in order to make it possible to determine usage for which the charged party may be billed (offline charging) or the subscriber's account balance may be debited (online charging). + +**real-time:** time, typically in number of seconds, to perform the on-line mechanism used for fraud control and cost control + +**subtariff:** within a tariff sequence, a charge unit per time unit + +NOTE: Each subtariff has an individual duration and an individual charge unit. + +**tariff:** set of parameters defining the network utilization charges for the use of a particular bearer / session / service + +NOTE 1: A tariff can either be metered in non-monetary units (e.g. meter-pulse) or in monetary units (e.g. currency). + +NOTE 2: Relationship between tariff and charge units (charging) should be clarified. + +NOTE 3: A tariff consists of a tariff sequence. + +**tariff determination instance:** particular charging-related process with a corresponding communication between a charge determination point and a charge registration/charge generation point + +**tariff sequence:** list of consecutive subtariffs which has to be applied for the charging of the communication event + +NOTE: The subtariffs are applied at the start of the communication event and are applied consecutively according to the list of the subtariffs. The last subtariff may have an unlimited duration. + +## 3.2 Abbreviations + +For the purposes of the present document, the following abbreviations apply: + +| | | +|-------|---------------------------------| +| AOC | Advice Of Charge | +| AOCRG | Add-On ChaRGE information | +| ASE | Application Service Element | +| CDP | Charge Determination Point | +| CGP | Charge Generation Point | +| CRGT | ChaRGE Tariff information | +| GMT | Greenwich Mean Time | +| ID | IDentification | +| IMS | IP Multimedia Subsystem | +| IP | Internet Protocol | +| ISDN | Integrated Service Data Network | +| ISUP | ISDN User Part | +| NGN | Next Generation Network | +| PSTN | Public Switch Telephone Network | +| SIP | Session Initiation Protocol | +| UE | User Equipment | + +# --- 4 SIP Transfer of Charging Information + +## 4.1 Description + +### 4.1.1 General description + +The present document specifies the procedures for the realtime transfer of charging information in SIP between a Charge Determination Point (CDP) and a Charge Generation Point (CGP). CDP is a network function that determines which tariff/add-on charge should be applied and inserts the charging information to the appropriate SIP requests or responses, whereas the CGP is a network function that receives the tariff/add-on charge information that was added by a CDP. + +Example of CDP is a SIP AS at the visited IMS network providing the premium rate service. Example of the CGP is the originating SIP AS at the home IMS network for advice of charge purposes. + +The functionality is needed to support the tariff/add-on charge information of value added services that are charged by the operator of the originating end user, the home IMS operator, in case the operator of the originating end user has no knowledge about the tariff/add-on charge information related to these value-added services. + +A charge determination and charge generation point of the communication may be located within the network of one operator (single network operator environment) or may be located in different networks of different operators (multi-operator environment). + +The configuration of several charge determination points for one communication is possible. It is assumed that there is only one CGP for the communication. + +The transferred tariff/add-on charge information represents direct Tariff Information (no pointers to charge data), either in monetary (e.g. currency) units or non-monetary (e.g. meter-pulse) units. + +The following functionality is provided: + +- i) apply a communication attempt charge for unsuccessful communications; +- ii) apply a communication setup charge (once) at start of charging; +- (iii) apply an initial communication tariff at start of charging and an (optional) next tariff at an absolute time during the communication; + +- iv) change immediately the current tariff; +- v) apply immediately an add-on charge (either a number of non-monetary units or an amount of monetary units) during the communication. This add-on charge is additive and does not change the tariff in force; +- vi) differentiation as to whether the tariff/add-on charge information is to be used for advice of charge purposes only, or for subscriber charging purposes (which would also allow it to be used for advice of charge purposes); +- vii) perform validation (e.g. check range of parameters, check whether a request from a certain network operator can be accepted); +- viii) apply a "one time charge" (i.e. non-periodic charge/flat rate) as a minimum communication charge at start of charging; + +### 4.1.2 Network provider option + +Not applicable. + +## 4.2 Coding requirements + +CDP and CGP shall support the INFO method according to RFC 2976 [2] in support of SIP Transfer of Tariff Information. + +CDP and CGP shall support multipart MIME content. + +The SIP Transfer of Tariff Information XML schema, version 1.0, is defined in annex C. The Tariff Information XML schema shall be transported as a SIP MIME body. The MIME type for the Tariff Information is "application/vnd.etsi.sci+xml" (in accordance with subclause 5.1). Any SIP message that transports a body with Tariff Information shall identify the payload as MIME type "application/vnd.etsi.sci+xml" (in accordance with subclause 5.1). + +## 4.3 Functional requirements + +### 4.3.1 Overall requirements + +- a) CGP receives tariff information and shall not send it further, however, the received tariff information can be used for the AoC info provision to the UE. +- b) There is only one CGP per service usage and the CGP is always located within the home network of the served subscriber. +- c) CDP determines the tariff to be applied or an add on charge, and provides for transfer to the CGP. +- d) There can be one or more CDP per service usage. CDP may be located in the originating or in the terminating network. +- e) Sending of next Tariff Information. + +A determination point shall not send next Tariff Information with a switch-over time that is more than 23 h and 45 min after the current time. + +- f) Format of the Tariff Information. + +All information issued for the same communication has to be in the same format, i.e. monetary or non-monetary. This needs bilateral agreements between the network operators concerned. + +If non-monetary formats are used, the corresponding monetary value of a non-monetary unit needs bilateral agreements between the network operators concerned. + +A CDP has to encode the Tariff Information in a format that can be validated by the receiving CGP. + +### 4.3.2 Procedures at a Charge Determination Point + +#### 4.3.2.0 General + +The CDP shall assume that the UE supports version 1.0 of the MIME type associated with Tariff Information (see subclause 5.1), if support for the MIME type associated with Tariff Information in the Accept header is not indicated. If both the "sv" and "schemaversion" parameters are present, then the CDP shall ignore the value of the "schemaversion" parameter. + +If the CDP includes the SIP Transfer of Tariff Information XML body (see subclause 5.1), it shall set the Content-Type header field to MIME type associated with Tariff Information (see subclause 5.1) and shall include in its "sv" or "schemaversion" parameter's value the versions of SIP Transfer of Tariff Information XML schema that can be used to validate the SIP Transfer of Tariff Information XML body. + +#### 4.3.2.1 Procedures during communication set-up + +##### 4.3.2.1.1 Tariff indication + +When a Charge Determination Point has determined that: + +- the tariff which has to be activated immediately at start of charging; and/or +- the next tariff which has to be activated at an absolute switch-over time; and/or +- the absolute switch-over time (GMT), + +has to be transmitted to the charge generation point, the application process shall issue the Tariff indication. + +A Tariff indication may be re-issued during communication set-up phase (i.e. at any time up to the dialog confirmation), replacing previously issued information. + +If the tariff is time dependent, then the next tariff and the absolute time at which the current tariff has to be replaced by this next tariff shall be sent. It can be sent together with the current tariff in the initial Tariff indication. The next tariff and the tariff switch-over time shall always be sent together. + +The current tariff and the next tariff have the same tariff parameter structure, i.e. a Communication Attempt charge, a Communication Setup charge and a Communication charge (up to a maximum of 4 communication subtariffs). + +The tariff format used for the communication is indicated by the first Tariff indication and shall not be changed during the communication. + +The following clauses specify the procedures for some specific cases. + +##### 4.3.2.1.2 Communication attempt charge + +The communication attempt charge is a direct charge, to be charged only for unsuccessful communications. + +If a communication attempt charge is relevant to the communication, the communication attempt Tariff Information shall be included in the Tariff indication. + +To cover the scenario in the generation point where the received absolute switch-over time has already been reached at the receipt of the Tariff indication or just before start of charging, the communication attempt charge shall also be sent in the first Next Tariff parameter. + +In case of monetary-format, the charge amount is indicated by a currency factor multiplied by a currency scale. + +In case of non-monetary format, the charge amount is indicated by a number of meter-pulse units. + +##### 4.3.2.1.3 Communication set-up charge + +The communication setup charge is a direct charge, to be charged once at start of charging. + +If communication setup charge is relevant to the communication, the communication setup Tariff Information shall be included in the first Tariff indication. + +To cover the scenario in the generation point where the received absolute switch-over time has already been reached at the receipt of the Tariff indication or just before start of charging, the communication setup charge shall also be sent in the first Next Tariff parameter. + +In the case of monetary-format, the charge amount is indicated by a currency factor multiplied with a currency scale. + +In the case of non-monetary-format the charge amount is indicated by a number of meter-pulse units. + +##### 4.3.2.1.4 Communication charge + +The communication charge is a direct charge, to be applied at start of charging. + +If communication charge is relevant, this information shall be included in the first Tariff indication and before start of charging. + +###### a) Non-monetary-format. + +In case of non-monetary-format, the charge amount is indicated by a number of meter-pulse units to be applied per time unit. The Communication charge is free when its value is zero. + +###### b) Monetary-format. + +In case of monetary-format, the charge amount per time unit is indicated by a currency factor multiplied by a currency scale. The communication charging is free of charge when the product is zero. + +NOTE: With the currency-format only one fixed time unit is used. This fixed time unit is one second, according to RFC 4006 [3]. + +###### c) Communication charge sequence. + +The communication charge may be a sequence of up to 4 communication subtariffs. Except for the last subtariff, each subtariff shall be limited by its tariff duration. The last (or single) subtariff of the sequence may be either unlimited (tariff duration = 0) or limited. + +At expiry of the tariff duration timer of the last (single) communication subtariff of the communication charge sequence, the following options are possible: + +- the communication charge sequence is re-applied; or +- the communication charge sequence is not re-applied. + +The chosen option is indicated in the tariffControlIndicators. + +If a communication charge sequence is relevant to the communication, the complete sequence shall be provided. + +###### d) Absolute switch-over time. + +The absolute switch-over time is the time at which the current tariff has to be replaced by the next tariff. + +The next tariff and the tariff switch-over time shall always be provided together. + +###### e) Minimum Communication Charge at Start of Charging. + +To apply a minimum communication charge in case of non-monetary format, the first subtariff of the sequence is defined with N pulses, a duration which corresponds to the required duration and a time interval equal to zero. + +To apply a minimum communication charge in case of monetary format, the first subtariff is defined with N currency units and a duration which corresponds to the required duration. A flag in CommunicationChargeCurrency (subTariffControl) indicates whether the tariff is a "one time charge" for the minimum communication charge or not. + +#### 4.3.2.2 Procedures after start of charging + +The following clauses and clause 4.3.2.3 specify the procedures for some specific cases. + +##### 4.3.2.2.1 Change current tariff + +The current tariff can be changed by issuing a Tariff indication with the new current tariff. + +##### 4.3.2.2.2 Add-on charge + +If a charge determination point determines that a certain amount of charge has to be added, the application process issues an Add-on-charge indication. The current tariff is not changed. + +An Add-on-charge indication is allowed after start of charging only. + +The charge is either in non-monetary format or in monetary format. + +The add-on charge in non-monetary-format is a number of meter-pulse units. The add-on charge in monetary format is indicated by the currency factor multiplied by the currency scale. + +#### 4.3.2.3 Subsequent Tariff indications + +In addition to the first Tariff indication, the application process in a determination point issues subsequent Tariff indication during the communication in the following cases: + +- a) The current tariff is changed. A Tariff indication with the new current tariff t has to be issued immediately. +- b) The next tariff and its tariff switch-over time were not issued at communication setup. This exceptional case occurs when the switch-over time was more than 23 h and 45 min after the moment the communication is set-up. A Tariff indication with the next tariff and the corresponding switchover time has to be issued at least before the switchover time. + +### 4.3.3 Procedures at the charge generation point + +The following general rule applies: Currently stored information related to one network operator is replaced by information related to this operator received subsequently. + +#### 4.3.3.0 General + +The CGP shall include the Accept header field with + +- "application/vnd.etsi.sci+xml", the MIME type associated with Tariff Information (see subclause 5.1), and indicate the versions of the XML Schema for SIP Transfer of Tariff Information it supports; and +- any other MIME type the CGP is willing and capable of accepting. + +#### 4.3.3.1 Procedures during communication set-up + +##### 4.3.3.1.1 Tariff indication + +The receipt of the Tariff indication indicates: + +- the tariff which has to be activated immediately at start of charging; or +- the next tariff which has to be activated at an absolute switch-over time; or +- the absolute switch-over time. + +A Tariff indication may be received more than once during communication set-up phase (i.e. at any time up to the dialog confirmation), replacing previously received information. + +If the tariff is time dependent, then the next tariff and the absolute time at which the current tariff has to be replaced by this next tariff will be received. They can be received together with the current tariff in the initial Tariff indication. + +The current tariff and the next tariff have the same tariff parameter structure, i.e. a communication attempt charge, a communication setup charge and a communication charge (up to a maximum of 4 communication subtariffs). The tariff + +parameters have either the non-monetary format or the monetary format. The tariff-format used for the communication is indicated by the first Tariff indication and shall not be changed during the communication. + +Validation shall be performed (e.g. check of range of parameters, check of network identification). + +The following clauses specify the procedures for some specific cases. + +##### 4.3.3.1.2 Communication attempt charge + +The communication attempt charge is a direct charge, to be charged only for unsuccessful communications. + +If a communication attempt charge is relevant to the communication, the communication attempt charge information shall be included in the Tariff indication. + +In the case of monetary-format, the charge amount is indicated by a currency factor multiplied by a currency scale. The communication attempt charging shall not be performed if the product is zero or the parameter is not present. + +In the case of non-monetary-format, the charge amount is indicated by a number of meter-pulse units. The communication attempt charging shall not be performed if the value is zero or the parameter is not present. + +##### 4.3.3.1.3 Communication setup charge + +The communication setup charge is a direct charge, to be charged once at start of charging. + +If a communication setup charge is relevant to the communication, the communication setup charge information is included in the first Tariff indication. + +In the case of monetary-format, the charge amount is indicated by a currency factor multiplied with a currency scale. The communication setup charging shall not be performed when the product is zero or the parameter is not present. + +In the case of non-monetary-format the charge amount is indicated by a number of meter-pulse units. The communication setup charge shall not be performed when the number is zero or the parameter is not present. + +##### 4.3.3.1.4 Communication charge + +The communication charge is a direct charge, to be applied at start of charging. + +As part of the Current Tariff, the Communication Tariff is applied immediately at start of charging. + +As part of the Next Tariff, the Communication Tariff is applied at the absolute time indicated by the absolute switch-over time parameter. The switch procedure is a network matter. + +If the absolute switch-over time given in the Tariff indication is already passed, then the communication charge of the next tariff instead of the current tariff shall immediately be applied (see also clause 4.3.1 b). + +###### a) Non-monetary-format. + +In case of non-monetary-format, the charge amount is indicated by a number of meter-pulse units to be applied per time unit. The communication is free of charge when its value is zero. + +###### b) Monetary-format. + +In case of monetary-format, the charge amount per time unit is indicated by a currency factor multiplied by a currency scale. The communication is free of charge when the product is zero. + +NOTE: With the currency-format only one fixed time unit is used. This fixed time unit is one second, according to RFC 4006 [3]. + +###### c) Communication charge sequence. + +The communication charge may be a sequence of up to 4 communication subtariffs. Except for the last subtariff, each subtariff shall be limited by its tariff duration. The last (or single) subtariff of the sent sequence may be either unlimited (tariff duration = 0) or limited. + +Initially, charging shall use the first subtariff. At expiry of the tariff duration timer, the subsequent subtariff shall be applied. + +At expiry of the tariff duration timer of the last (single) communication subtariff of the communication charge sequence, the following options are possible: + +- the communication charge sequence is re-applied; or +- the communication charge sequence is not re-applied. + +The option to be applied is indicated in the tariffControlIndicators. + +If a communication charge sequence is relevant to the communication, the complete sequence shall be provided. + +When the communication charge sequence is not re-applied, the following network provider option exists: either the communication continues "free of charge" or the communication is released. + +###### d) Absolute switch-over time. + +The absolute switch-over time is the time at which the current tariff has to be replaced by the next tariff. In a multi-operator environment, the procedures of how the subtariffs of the next tariff are applied are subject of bilateral or multilateral agreements. + +###### e) Minimum communication charge at start of charging. + +To apply a minimum communication charge in case of pulse format, the first subtariff of the sequence shall be defined with N pulses, a duration which corresponds to the required duration and a time interval equal to zero. + +To apply a minimum communication charge in case of currency format, the first subtariff shall be defined with N currency units and a duration which corresponds to the required duration. A flag in CommunicationChargeCurrency (subTariffControl) indicates whether the tariff is a "one time charge" for the minimum communication charge or not. + +#### 4.3.3.2 Procedures after start of charge + +If the communication setup charge is applied, all following received communication attempts and communication setup charges shall be ignored. + +The following clauses and clause 4.3.2.4 specify the procedures for some specific cases. + +##### 4.3.3.2.1 Change current tariff + +###### a) On receipt of the Tariff indication with the new tariff, the current tariff shall be changed + +After successful validation (e.g. check of range of parameters, check of network identification), the new current tariff shall immediately be applied to the communication according to the following two tariff change procedures: + +- tariff change without restart of the charging process (see b)); +- tariff change with restart of the charging process (see c)). + +Which immediate tariff change procedure shall be used is indicated in the ChargingControlIndicators by "immediateChangeOfActuallyAppliedTariff": value 1 means "with restart", value 0 means "without restart". + +###### b) Tariff Change without restart of the charging process. + +The charging process for the actual communication shall be continued with the new current tariff. I.e. the tariff change procedure is the same as the one which is performed at a tariff switchover from the current to the next tariff. This means that: + +- at the change of a tariff sequence, the new applied subtariff of the new tariff sequence is retrieved via the elapsed communication duration; +- at the change of a non-periodic tariff, the new non-periodic tariff is not applied (no double counting); +- the new communication attempt and communication setup charge are not applied. + +###### c) Tariff Change with restart of the charging process. + +The charging process with the actual current tariff shall be closed and restarted with the new current tariff. This means that: + +- at the change of a tariff sequence, the charging process restarts with the first communication subtariff of the new tariff sequence; +- at the change of a non-periodic tariff, the new non-periodic tariff is applied; +- the new communication attempt and communication setup charge are not applied. + +###### d) In a multi-operator environment, the procedures of how the subtariffs of the next tariff are applied are subject of bilateral or multilateral agreements. + +##### 4.3.3.2.2 Add-on Charge + +On receipt of the Add-on-charge indication, the given amount of charge has to be added. The current tariff shall not be changed. + +An Add-on-charge indication is allowed after start of charging only. + +The charge is either in non-monetary format or in monetary format. + +The add-on charge in non-monetary-format is a number of meter-pulse units. The add-on charge in monetary format is indicated by the currency factor multiplied by the currency scale. + +#### 4.3.3.3 Subsequent Tariff indications + +In addition to the first Tariff indication, subsequent Tariff indications during the communication may be received in the following cases: + +- a) The current tariff has to be changed. A Tariff indication with the new current tariff together with the next tariff and its switch-over time will be received. +- b) The next tariff and its tariff switch-over time were not received at communication setup. A Tariff indication with the next tariff and the corresponding switchover time will be received before the switchover time. + +### 4.3.4 Handling of identifiers + +The initial indication, i.e. either a Tariff indication or an Add-on-charge indication, issued by the application process in a charge determination point shall contain the originationIdentification A. + +The initial acknowledgement (i.e. the first Tariff/Add-on-charge response) to this initial (Tariff/Add-on-charge) indication (with originationIdentification and without destinationIdentification) issued by the application process in the generation point shall contain the originationIdentification B and the destinationIdentification A in order to allow mapping between the sending and receiving direction. + +The destinationIdentification A equals the originationIdentification A, and the destinationIdentification B equals the originationIdentification B. + +All subsequent Tariff and Add-on-charge indications associated with the same tariff determination instance contain the originationIdentification A and destinationIdentification B. All subsequent Tariff and Add-on-charge responses associated with the same tariff determination instance shall contain the originationIdentification B and destinationIdentification A. + +## 4.4 Signalling requirements + +### 4.4.1 General + +When sending Tariff Information, the CDP shall encode this information according to the XML-schema defined in annex C and send it to the CGP. In addition, for this MIME body the AS: + +- shall set the Content-Type header field to "application/vnd.etsi.sci+xml" and set: + +- a) the Content-Disposition header field to "render" with the "handling" parameter set to "optional", or +- b) as an operator option, the Content-Disposition header field to "signal" with the "handling" parameter set to "required" or "optional". + +In the case the Tariff Information is transported in a message that is forwarded by CDP that contains already a content body, CDP shall generate a multipart/mixed MIME body containing two sub-parts: + +- one with the Tariff Information; the Content-Type and Content-Disposition of this sub-part should be coded as specified for non-multipart bodies; +- one with the received body; headers describing the content of the received SIP message (e.g. Content-type) should be moved into the headers of the this subpart. + +### 4.4.2 Procedures during communication set-up + +#### 4.4.2.1 Procedures at the CDP + +When an INVITE request is received, the CDP operates as a routing B2B UA as specified in clause 5.7.5 of 3GPP TS 24.229 [4] and includes the tariff information in the content body of a reliable 1xx provisional response, or in the content body of a 200 OK. + +### 4.4.3 Procedures after start of charging + +#### 4.4.3.1 Procedures at the CDP + +The CDP operates as a routing B2B UA as specified in clause 5.7.5 of 3GPP TS 24.229 [4] and may send tariff information at any moment during the active phase of the communication. When sending the tariff information, the CDP shall include the tariff information in the content body of a mid-dialog request, a mid-dialog response or in the content body of a 200 OK response forwarded by the CDP or of an INFO request generated by the CDP. + +## 4.5 Interaction with other services + +Not applicable. + +## 4.6 Interactions with other networks + +### 4.6.1 Interaction with PSTN/ISDN + +In case of interaction with networks which do not provide tariff information in the signalling system, the tariff information shall be discarded and the communication shall continue according to the basic call procedures. + +The elements and types of the SIP Transfer of Tariff Information XML schema, version 1.0 (defined in annex C), shall be mapped to/from the regarding elements and types of the Tariff Charging ASE defined in clause 8 of ES 201 296 [6], as described in table 1. When the MGCF is able to interwork the ISUP charging ASE to a XML instance, the MGCF shall send to the ISDN network an ISUP charging acknowledgment "accepted". Was the interworking not successful, the MGCF acts as described in clause 6.3.6 of ES 201 296 [6] or no acknowledgement is sent. + +###### **Table 1: Mapping of Tariff elements** + +| SIP Transfer of Tariff Information
XML schema
| ISUP Signalling aspects of Tariff
Charging ASE
| +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +|
  • - messageType
    • - crgt
    • - aocrg
|
  • - chargingMessageType
    • - crgt
    • - aocrg
| +| ChargingTariffInformationType
  • - chargingControlIndicators
  • - chargingTariff
    • - tariffCurrency
    • - tariffPulse
  • - originationIdentification
  • - destinationIdentification
  • currency
| ChargingTariffInformation
  • - chargingControlIndicators
  • - chargingTariff
    • - tariffCurrency
    • - tariffPulse
  • - originationIdentification
  • - destinationIdentification
  • currency
| +| AddOnChargeInformationType
  • - chargingControlIndicators
  • - addOnCharge
    • - addOnChargeCurrency
    • - addOnChargePulse
  • - originationIdentification
  • - destinationIdentification
  • currency
| AddOnChargeInformation
  • - chargingControlIndicators
  • - addOnCharge
    • - addOnChargeCurrency
    • - addOnChargePulse
  • - originationIdentification
  • - destinationIdentification
  • currency
| +| TariffSwitchPulseType
  • - nextTariffPulse
  • tariffSwitchOverTimer
| TariffSwitchPulse
  • - nextTariffPulse
  • tariffSwitchOverTimer
| +| CommunicationChargePulseType
  • - pulseUnits
  • - chargeUnitTimeInterval
  • TariffDuration
| CommunicationChargePulse
  • - pulseUnits
  • - chargeUnitTimeInterval
  • TariffDuration
| +| TariffPulseFormatType
  • - communicationChargeSequencePulse
  • - tariffControlIndicators
  • - callAttemptChargePulse
  • callSetupChargePulse
| TariffPulseFormat
  • - communicationChargeSequencePulse
  • - tariffControlIndicators
  • - callAttemptChargePulse
  • callSetupChargePulse
| +| CommunicationChargeCurrencyType
  • - currencyFactorScale
  • - tariffDuration
  • subTariffControl
| CommunicationChargeCurrency
  • - currencyFactorScale
  • - tariffDuration
  • subTariffControl
| +| TariffSwitchCurrencyType
  • - nextTariffCurrency
  • tariffSwitchOverTimer
| TariffSwitchCurrency
  • - nextTariffCurrency
  • tariffSwitchOverTimer
| +| TariffCurrencyFormatType
  • - communicationChargeSequence Currency
  • - tariffControlIndicators
  • - callAttemptChargeCurrency
  • callSetupChargeCurrency
| TariffCurrencyFormat
  • - communicationChargeSequence Currency
  • - tariffControlIndicators
  • - callAttemptChargeCurrency
  • callSetupChargeCurrency
| +| CurrencyFactorScaleType
  • - currencyFactor
  • currencyScale
| CurrencyFactorScale
  • - currencyFactor
  • currencyScale
| +| TariffPulseType
  • - currentTariffPulse
  • tariffSwitchPulse
| TariffPulse
  • - currentTariffPulse
  • tariffSwitchPulse
| +| TariffCurrencyType
  • - currentTariffCurrency
  • tariffSwitchCurrency
| TariffCurrency
  • - currentTariffCurrency
  • tariffSwitchCurrency
| +| ChargingControlIndicatorsType
  • - immediateChangeOfActuallyApplied Tariff
  • delayUntilStart
| ChargingControlIndicators
  • - immediateChangeOfActuallyApplied Tariff
  • delayUntilStart
| +| ChargingReferenceIdentificationType
  • - networkIdentification
  • referenceID
| ChargingReferenceIdentification
  • - networkIdentification
  • referenceID
| +| bitType | STRING | +| eightBitType | OCTET STRING (size (1)) | +| sixteenBitType | OCTET STRING (size (2)) | +| NetworkIdentificationType | NetworkIdentification | + +| SIP Transfer of Tariff Information
XML schema | ISUP Signalling aspects of Tariff
Charging ASE | +|--------------------------------------------------|----------------------------------------------------| +| CurrencyType
EUR
USD
CNY
... | Currency
Euro
uSDollar
chineseYuan
... | +| CurrencyFactorType | CurrencyFactor | +| CurrencyScaleType | CurrencyScale | +| TariffDurationType | TariffDuration | + +### 4.6.2 Interaction with PSTN/ISDN Emulation + +For Further Study. + +### 4.6.3 Interaction with external IP networks + +The procedures of 3GPP TS 24.229 [4] shall apply. + +# 5 Extensions within the present document + +## 5.1 SIP Transfer of Tariff Information XML body + +### 5.1.1 General + +This subclause contains the SIP Transfer of Tariff Information XML body in XML format. The SIP Transfer of Tariff Information XML shall be valid against the SIP Transfer of Tariff Information XML schema defined in Annex C. + +See subclause 5.1.2 for the associated MIME type definition. + +### 5.1.2 MIME type definition + +#### 5.1.2.1 Introduction + +This subclause defines the MIME type for "application/vnd.etsi.sci+xml". A SIP Transfer of Tariff Information XML Document can be identified with this media type. + +#### 5.1.2.2 Syntax + +The following optional parameters are defined: + +- "charset": the parameter has identical semantics to the charset parameter of the "application/xml" media type as specified in RFC 3023 [9]. +- "sv" or "schemaversion": the syntax for the "sv" or "schemaversion" parameter is specified in table 2: + +**Table 2: Syntax of the "sv" or "schemaversion" parameter** + +``` + +m-parameter /= ("sv" / "schemaversion") EQUAL LDQUOT [ sv-value-list ] RDQUOT +sv-value-list = sv-value-range *( "," sv-value ) +sv-value-range = sv-value [ "-" sv-value ] +sv-value = number / token +number = 1*DIGIT [ "." 1*DIGIT ] + +``` + +The BNF for m-parameter is taken from IETF RFC 3261 [8] and modified accordingly. + +#### 5.1.2.3 Operation + +The encoding considerations for "application/vnd.etsi.sci+xml" are identical to those of "application/xml" as described in RFC 3023 [9]. + +The "sv" or "schemaversion" parameter's value is used to indicate: + +- the versions of SIP Transfer of Tariff Information XML schema that can be used to validate the SIP Transfer of Tariff Information XML body (if the MIME type and parameter are present in the Content-Type header) or +- the accepted versions of the SIP Transfer of Tariff Information XML body (if the MIME type and parameter are present in the Accept header). + +If the "sv" and "schemaversion" parameter are absent, it shall be assumed that version 1.0 of the XML Schema for the SIP Transfer of Tariff Information XML body is supported. + +# Annex A (informative): Signalling flows + +NOTE: The UNI AOC messages (to the left of the CGP) are out of scope of the present document and are shown for explanation reasons. + +![Sequence diagram showing the transfer of tariff information between CGP and CDP during communication set-up.](7d3d5fb5d09c0cd35a9d637be241651e_img.jpg) + +The diagram illustrates the signalling flow between a CGP (Communication Gateway) and a CDP (Communication Domain Provider) for tariff information transfer. The sequence of messages is as follows: + +- An external **INVITE** message is received by the CGP. +- The CGP forwards the **INVITE** message to the CDP. +- The CDP responds with a **183 Session progress** message containing **Tariff Indication**: Current Tariff T1, Switch-over Time 10h00min, and Next Tariff T2. The CDP also displays **Tariff T1**. +- The CGP receives the 183 message and generates an external **183 Session progress AOC-S** message. +- The CDP sends a **200 OK** message to the CGP. +- The CGP receives the 200 OK and generates an external **200 OK** message. The CGP then displays **Tariff T1**. +- The CGP sends an **ACK** message to the CDP. +- The CDP receives the ACK and displays **10h00min**. +- The CGP generates an external **INFO AOC-S** message. +- The CGP receives another **200 OK** message from the CDP. +- At the 10h00min mark, the CGP switches to **Tariff T2**. + +Sequence diagram showing the transfer of tariff information between CGP and CDP during communication set-up. + +**Figure 1: Transfer of Tariff Information during communication set-up** + +Figure 1 gives an example for transfer of Tariff Information during the communication set-up phase. When an INVITE request is received, the CDP includes the Tariff Information in the content body of a reliable 1xx provisional response, in this example the 183 Session progress response. The Tariff Information includes the current tariff T1, the next tariff T2, and the absolute switch-over time 10 h and 00 min. + +The CGP applies T1 when the dialog is confirmed after the reception of the 200 OK. At 10 h and 00 min the CGP switches to T2. + +![Sequence diagram showing the transfer of an add-on charge between CGP and CDP. The CDP sends an INFO Add-on-charge Indication to the CGP. The CGP responds with a 200 OK and an INFO AOC-D message. Both entities have a 'Tariff T2' and an 'Add-on' charge applied.](eb03559a4d92ea9ebd63ea9be663c50a_img.jpg) + +The diagram illustrates a sequence of interactions between two entities, CGP (Charging Gateway) and CDP (Charging Data Processor). Both entities are represented by vertical lifelines. Each lifeline has a grey rectangular area labeled 'Tariff T2'. Within this area, a smaller dark grey rectangle is labeled 'Add-on'. The sequence of messages is as follows: 1. The CDP sends an 'INFO Add-on-charge Indication' message to the CGP. 2. The CGP responds with a '200 OK' message. 3. The CGP then sends an 'INFO AOC-D' message to the CDP. The 'Add-on' charge is shown being applied to the 'Tariff T2' on both the CGP and CDP lifelines. + +Sequence diagram showing the transfer of an add-on charge between CGP and CDP. The CDP sends an INFO Add-on-charge Indication to the CGP. The CGP responds with a 200 OK and an INFO AOC-D message. Both entities have a 'Tariff T2' and an 'Add-on' charge applied. + +**Figure 2: Transfer of Add-on-charge** + +Figure 2 gives an example for transfer of Add-on-charge after start of charging. The CDP includes the Tariff Information in the content body of an INFO request. + +After the reception of the INFO request the CGP applies the Add-on charge. + +![Sequence diagram showing an immediate tariff change without restart of the charging instance between CGP and CDP.](ae53f90bb87d6d09e2d6b5278d7c338f_img.jpg) + +The diagram illustrates a sequence of messages between a CGP (Charging Gateway) and a CDP (Charging Data Point). The sequence starts with an INVITE from an external source to the CGP. The CGP then sends an INVITE to the CDP. The CDP responds with a 183 Session progress message containing Tariff Indication (Current Tariff T1, Subtariffs T11 and T12). The CGP sends a 183 Session progress AOC-S response. The CDP sends a 200 OK to the CGP, which in turn sends a 200 OK to the external source. The CGP sends an ACK to the CDP. The CDP then sends an INFO message with Tariff Indication (New Current Tariff T2, Subtariffs T21 and T22, „without restart“). The CGP sends an INFO AOC-S response. The CDP sends a 200 OK to the CGP, which in turn sends a 200 OK to the external source. The diagram shows the application of Subtariff T11 (duration = 1h) and Subtariff T12 (duration = unlimited) until 16h30min. At 17h30min, the CGP switches to Subtariff T12. At 18h00min, the CDP switches to Tariffsequence T2, which includes Subtariff T21 (duration = 1h) and Subtariff T22 (duration = unlimited). The CGP applies Subtariff T22 at 19h00min. + +| Time | CGP | CDP | +|----------|----------------------------|----------------------------------------------------------| +| Start | INVITE | | +| | INVITE | Tariffsequence T1 | +| | 183 Session progress AOC-S | 183 Session progress (Tariff T1, Subtariffs T11, T12) | +| | 200 OK | 200 OK | +| | ACK | | +| | Subtariff T11 | Subtariff T11 (duration = 1h) | +| 16h30min | | Subtariff T12 (duration = unlimited) | +| 17h30min | INFO AOC-S | | +| | 200 OK | | +| | Subtariff T12 | | +| 18h00min | INFO AOC-S | INFO (Tariff T2, Subtariffs T21, T22, „without restart“) | +| | 200 OK | Tariffsequence T2 | +| | Subtariff T22 | Subtariff T21 (duration = 1h) | +| 19h00min | | Subtariff T22 (duration = unlimited) | + +Sequence diagram showing an immediate tariff change without restart of the charging instance between CGP and CDP. + +**Figure 3: Immediate tariff change without restart of the charging instance** + +Figure 3 gives an example for an immediate tariff change without a restart of the charging instance. After start of charging, the CDP includes the Tariff Information in the content body of an INFO request. The Tariff Information includes the new current tariff T2, which is a tariff sequence with the sub-tariffs T21 (duration 1 h) and T22 (duration unlimited), and the indication that no restart shall be applied. + +After the reception of the INFO request the CGP applies T22, because T22 is valid 1 h and 30 min after communication start. + +![Sequence diagram showing an immediate tariff change with a restart of the charging instance between CGP and CDP.](26d664119ad25250780f554633444e54_img.jpg) + +The diagram illustrates a sequence of messages between a CGP (Charging Gateway) and a CDP (Charging Data Processor). The interaction starts with an INVITE from an external source to the CGP. The CGP then sends an INVITE to the CDP. The CDP responds with a 183 Session progress message containing Tariff Indication (Current Tariff T1, Subtariffs T11 and T12). The CGP sends a 183 Session progress AOC-S to the external source. The CDP sends a 200 OK to the CGP, which in turn sends a 200 OK to the external source. The CGP sends an ACK to the CDP. The CDP then sends an ACK to the CGP. The CGP sends an INFO AOC-S to the external source. The CDP sends a 200 OK to the CGP, which sends a 200 OK to the external source. The CDP sends an INFO Tariff Indication (New Current Tariff T2, Subtariffs T21 and T22, „with restart“) to the CGP. The CGP sends an INFO AOC-S to the external source. The CDP sends a 200 OK to the CGP, which sends a 200 OK to the external source. The CDP sends an INFO Tariff Indication (New Current Tariff T2, Subtariffs T21 and T22, „with restart“) to the CGP. The CGP sends an INFO AOC-S to the external source. The CDP sends a 200 OK to the CGP, which sends a 200 OK to the external source. + +**Timeline and Tariff Details:** + +- 16h30min:** CDP sends 200 OK to CGP. CGP sends 200 OK to external source. CGP sends ACK to CDP. CDP sends ACK to CGP. + - CDP: Subtariff T11 duration = 1h, Subtariff T12 duration = unlimited. +- 17h30min:** CGP sends INFO AOC-S to external source. CDP sends 200 OK to CGP. CGP sends 200 OK to external source. +- 18h00min:** CDP sends INFO Tariff Indication (New Current Tariff T2, Subtariffs T21 and T22, „with restart“) to CGP. CGP sends INFO AOC-S to external source. CDP sends 200 OK to CGP. CGP sends 200 OK to external source. +- 19h00min:** CDP sends INFO Tariff Indication (New Current Tariff T2, Subtariffs T21 and T22, „with restart“) to CGP. CGP sends INFO AOC-S to external source. CDP sends 200 OK to CGP. CGP sends 200 OK to external source. + +**Tariff Sequence Details:** + +- Tariffsequence T1:** Subtariff T11 (duration = 1h), Subtariff T12 (duration = unlimited). +- Tariffsequence T2:** Subtariff T21 (duration = 1h), Subtariff T22 (duration = unlimited). + +Sequence diagram showing an immediate tariff change with a restart of the charging instance between CGP and CDP. + +**Figure 4: Immediate tariff change with restart of the charging instance** + +Figure 4 gives an example for an immediate tariff change with a restart of the charging instance. After start of charging, the CDP includes the Tariff Information in the content body of an INFO request. The Tariff Information includes the new current tariff T2, which is a tariff sequence with the sub-tariffs T21 (duration 1 h) and T22 (duration unlimited), and the indication that a restart shall be applied. + +After the reception of the INFO request the CGP restarts the charging instance and applies T21 for 1 h, and then switches to T22. + +# --- Annex B (informative): SIP Transfer of Tariff Information parameters + +## B.1 General + +This annex describes the parameters needed to transport SIP NNI information. + +## --- B.2 NNI Information + +### B.2.0 General + +For SIP Transfer of Tariff Information the regarding SIP messages shall be able to transport the following basic information: + +- Charging Message Type, see clause B.2.1. +- Add On Charge Information, see clause B.2.2. +- Charge Tariff Information, see clause B.2.3. + +### B.2.1 Charge Message Type + +The following Charge Message Types shall be applicable: + +- crgt Charge Tariff Information. +- aocrg Add On Charge Information. + +### B.2.2 Add On Charge Information + +#### B.2.2.0 General + +Add On Charge Information is used to add an amount of charge for the communication and does not alter the current tariff. The Destination Identification is not available in an initial AddOnCharge Information message, in all subsequent ones it is included. In the message the add-on charge has either the pulse or currency format. + +Add On Charge Information shall contain the following elements: + +- Charging Control Indicators (optional), see clause B.3.2.1; and +- Add On Charge, see clause B.2.2.1; and +- Origination Identification, see clause B.3.1.1; and +- Destination Identification (optional), see clause B.3.1.2; and +- Currency (optional), see clause B.3.2.2. + +#### B.2.2.1 Add On Charge + +##### B.2.2.1.0 General + +Add On Charge shall contain the following elements: + +- Add On Charge Currency, see clause B.2.2.1.1; or +- Add On Charge Pulse, see clause B.2.2.1.2. + +##### B.2.2.1.1 Add On Charge Currency + +The Add On Charge Currency element shall be coded as Currency Factor Scale type, see clause B.3.2.3. + +##### B.2.2.1.2 Add On Charge Pulse + +The Add On Charge Pulse element shall be coded as Pulse Units type, see clause B.3.2.4. + +### B.2.3 Tariff Information + +#### B.2.3.0 General + +This information is used to transfer explicit tariff data to the originating subscriber's network and the charge registration AS during communication set-up and also in the active phase of a communication. The Destination Identification is not available in an initial Tariff Information, in all subsequent ones it is included. + +Tariff Information shall contain the following elements: + +- Control Indicators, see clause B.3.2.1; and +- Tariff, see clause B.2.3.1; and +- Origination Identification, see clause B.3.1.1; and +- Destination Identification (optional), see clause B.3.2; and +- Currency, see clause B.3.2.2. + +#### B.2.3.1 Tariff + +##### B.2.3.1.0 General + +The Tariff shall contain the following elements + +- Tariff Currency, see clause B.2.3.1.1; or +- Tariff Pulse, see clause B.2.3.1.2. + +##### B.2.3.1.1 Tariff Currency + +###### B.2.3.1.1.0 General + +The Tariff Currency shall contain the following elements: + +- Current Tariff Currency (optional), see clause B.2.3.1.1.1; and +- Tariff Switch Currency (optional), see clause B.2.3.1.1.2. + +###### B.2.3.1.1.1 Current Tariff Currency + +The Current Tariff Currency shall be coded as communication charge currency type, see clause B.3.2.5. + +###### B.2.3.1.1.2 Tariff Switch Currency + +###### B.2.3.1.1.2.0 General + +The Tariff Switch Currency shall be coded as Tariff Switch Currency type, see clause B.2.3.1.1.2.1. + +###### B.2.3.1.1.2.1 Tariff Switch Currency + +###### B.2.3.1.1.2.1.0 General + +Tariff Switch Currency shall contain the following elements: + +- Next Tariff Currency, see clause B.2.3.1.1.2.1.1; and + +- Tariff Switchover Time, see clause B.2.3.1.1.2.1.2. + +###### B.2.3.1.1.2.1.1 Next Tariff Currency + +###### B.2.3.1.1.2.1.1.0 General + +Next Tariff Currency shall be coded as Tariff Currency Format type, see clause B.2.3.1.1.2.1.1.1. + +###### B.2.3.1.1.2.1.1.1 Tariff Currency Format type + +###### B.2.3.1.1.2.1.1.1.0 General + +The Tariff Currency Format type shall contain the following elements: + +- Communication Charge Sequence Currency (optional), see clause B.3.2.5; and +- Tariff Control Indicators, see clause B.3.2.6; and +- Call Attempt Charge Currency (optional), see clause B.3.2.7; and, +- Call Setup Charge Currency (optional), see clause B.3.2.8. + +###### B.2.3.1.1.2.1.1.1.1 Communication Charge Sequence Currency + +The communication charge sequence currency is a direct charge in currency per time unit. Only one fixed time unit is used. This time unit has to be agreed between all cooperating networks, e.g. one second. Being fixed, the time unit is not transferred. + +The Communication Charge Sequence Currency shall contain a sequence with 1 up to 4 elements coded as Communication Charge Currency, see clause B.3.2.5. + +###### B.2.3.1.1.2.1.2 Tariff Switchover Time + +Tariff Switchover Time shall be coded as Tariff Switchover Time type, see clause B.3.2.6. + +##### B.2.3.1.2 Tariff Pulse + +The Tariff Pulse shall contain the following elements: + +- Current Tariff Pulse (optional), see clause B.2.3.1.2.1; and +- Tariff Switch Pulse (optional), see clause B.2.3.1.2.2. + +###### B.2.3.1.2.1 Current Tariff Pulse + +Current Tariff Pulse shall be coded as Tariff Pulse Format type, see clause B.3.2.11. + +###### B.2.3.1.2.2 Tariff Switch Pulse + +Tariff Switch Pulse shall be coded as Tariff Switch Pulse type, see clause B.2.3.1.2.2.1. + +###### B.2.3.1.2.2.1 Tariff Switch Pulse Type + +The Tariff Switch Pulse type shall contain the following elements: + +- Next Tariff Pulse, see clause B.2.3.1.2.2.1.1; and +- Tariff Switchover Time, see clause B.2.3.1.2.2.1.2. + +###### B.2.3.1.2.2.1.1 Next Tariff Pulse + +Next Tariff Pulse shall be coded as Tariff Pulse Format type, see clause B.3.2.11. + +###### B.2.3.1.2.2.1.2 Tariff Switchover Time + +Tariff Switchover Time shall be coded as Tariff Switchover Time type, see clause B.3.2.9. + +## --- B.3 Common information elements/types + +### B.3.1 Identification + +#### B.3.1.1 Origination identification + +The Origination identification shall be expressed as charging reference identification, see clause B.3.1.3. + +#### B.3.1.2 Destination identification + +The destination identification shall be expressed as charging reference identification, see clause B.3.1.3. + +#### B.3.1.3 Charge reference identification + +Charge reference identification shall contain the following elements: + +- Network identification, see clause B.3.1.4; and +- Reference ID, see clause B.3.1.5. + +#### B.3.1.4 Network identification + +For the network identification the following structure of the network identification values may be used: + +{itu-t (0) administration (2) (x) network (y) element identification (z)} + +Where the value for x is the value of the national regulation authority, the value for y is under the control of the Data Country Codes (DCCs) as defined in ITU-T Rec. X.121 concerned, and the value for z is under the control of the network concerned. + +Any other valid object identifier value according to ITU-T X.660 may also be used. The last component of the object identifier value will usually identify the node creating the charging reference. + +#### B.3.1.5 Reference ID + +The reference ID element shall have INTEGER values from 0..4 294 967 295 (maximum value $2^{32} - 1$ ). + +#### B.3.1.6 Network operators + +Network operators shall be coded as network identification, see clause B.3.1.4. + +### B.3.2 Charge + +#### B.3.2.1 Charge control indicators + +##### B.3.2.1.0 General + +The charge control indicators shall contain 1 up to 8 bit-strings with the following elements: + +- Immediate change of actually applied tariff, see clause B.3.2.1.1; and +- Delay until start, see clause B.3.2.1.2. + +##### B.3.2.1.1 Immediate change of actually applied tariff + +The immediate change of actually applied tariff element shall be coded as follows: + +0 - immediate tariff change without restart. + +1 - immediate tariff change with restart. + +It is only used to change the actually applied tariff. + +##### B.3.2.1.2 Delay until start + +The delay until start element shall be coded as follows: + +- 0 - start tariffing, if it is not already started, without waiting for the 'start' signal. +- 1 - delay start of tariffing up to the receipt of the 'start' signal. + +#### B.3.2.2 Currency + +The currency element (optional) shall be coded according to ISO 4217 [5]. The absence of this element shall be interpreted as 'no indication'. + +#### B.3.2.3 Currency factor scale + +The charge amount is indicated by the currency factor multiplied with the currency scale. "no charge" indicates currency factor scale has the value 0. + +Currency factor scale shall contain the following elements: + +- Currency factor, see clause B.3.2.3.1; and +- Currency scale, see clause B.3.2.3.2. + +##### B.3.2.3.1 Currency factor + +The currency factor shall have INTEGER values from 0 to 999 999. Value 0 indicates "no charge" and is the default-value. + +##### B.3.2.3.2 Currency scale + +The currency scale shall have INTEGER values from -7 to 3. The actual value for currency scale is given by $10^x$ , where x is the value of the currency scale. The default value is 'no Scale'. + +The coding of currency scale is as follows, all other values are spare: + +- 7 (249): 0,0000001 +- 6 (250): 0,000001 +- 5 (251): 0,00001 +- 4 (252): 0,0001 +- 3 (253): 0,001 +- 2 (254): 0,01 +- 1 (255): 0,1 +- 0 : 1 +- 1 : 10 +- 2 : 100 +- 3 : 1 000 + +#### B.3.2.4 Pulse units type + +Pulse units is binary coded and has the value range from 0 to 255. + +#### B.3.2.5 Communication charge currency type + +Communication charge currency shall contain the following elements: + +- Currency factor scale, see clause B.3.2.3; and +- Tariff duration, see clause B.3.2.5.1; and +- Sub tariff control, see clause B.3.2.5.2. + +##### B.3.2.5.1 Tariff duration + +Tariff duration shall be coded as tariff duration type, see clause B.3.2.12. + +##### B.3.2.5.2 Sub tariff control + +Sub tariff control shall be coded as sub tariff control type, see clause B.3.2.13. + +#### B.3.2.6 Tariff control indicators + +The tariff control indicators shall contain a bit-string of 1 up to 8 non-cyclic tariff elements. + +The coding of the non-cyclic Tariff is as follows: + +- 0: Cyclic tariff ( at expiration of the tariff duration of the last communication tariff of the communication charge sequence, the communication charge sequence is re-applied). +- 1: Non-cyclic tariff ( at expiration of the tariff duration of the last communication tariff of the communication charge sequence, do not re-apply the communication charge sequence). + +#### B.3.2.7 Call attempt charge currency + +The call attempt charge is a direct charge, to be charged only for unsuccessful calls. + +The call attempt charge currency shall be coded as Currency Factor Scale, see clause B.3.2.3. + +#### B.3.2.8 Call setup charge currency + +The call set-up charge is a direct charge, to be charged once at start of charging. + +The call setup charge currency shall be coded as Currency Factor Scale, see clause B.3.2.3. + +#### B.3.2.9 Tariff switchover time type + +This time is the absolute time at which the next tariff has to become active. It is represented in steps of 15 min. + +The tariff switchover time shall be coded as: + +- 0 : spare. +- 1 : 0 h 15 min. +- 2 : 0 h 30 min. +- 3 : 0 h 45 min. +- 4 : 1 h 0 min. +- .. +- 96 : 24 h 0 min. +- 97-255 : spare. + +#### B.3.2.10 Communication charge pulse type + +Communication charge pulse shall contain the following elements: + +- Pulse Units, see clause B.3.2.10.1; and + +- Charge Unit Time Interval, see clause B.3.2.10.2; and +- Tariff Duration, see clause B.3.2.10.3. + +##### B.3.2.10.1 Pulse units + +Pulse units shall be coded as pulse units type, see clause B.3.2.4. + +##### B.3.2.10.2 Charge unit time interval + +Charge unit time interval shall be coded as charge unit time interval type, see clause B.3.2.14. + +##### B.3.2.10.3 Tariff duration + +Tariff duration shall be coded as tariff duration type, see clause B.3.2.12. + +#### B.3.2.11 Tariff pulse format type + +Tariff pulse format shall contain the following elements: + +- Communication charge sequence pulse (optional), see clause B.3.2.11.1; and +- Tariff control indicators, see clause B.3.2.6; and +- Call attempt charge pulse (optional), see clause B.3.2.11.2; and +- Call setup charge pulse (optional), see clause B.3.2.11.3. + +The communication charges are meter-pulse units, which are to be applied per charge unit time interval. The call attempt pulse units are to be charged only for unsuccessful calls. The call set-up pulse units are to be charged once at start of charging. + +##### B.3.2.11.1 Communication charge sequence pulse + +The communication charge sequence pulse shall contain a sequence of 1 up to 4 elements coded as communication charge pulse, see clause B.3.2.10. + +##### B.3.2.11.2 Call attempt charge pulse + +Call attempt charge pulse shall be coded as pulse units, see clause B.3.2.4. + +##### B.3.2.11.3 Call setup charge pulse + +Call setup charge pulse shall be coded as pulse units, see clause B.3.2.4. + +#### B.3.2.12 Tariff duration type + +The duration indicates for how long time the communication charge component is valid. Expiration of the tariff duration timer leads to the activation of the next communication charge (if present). In the case where there is no next communication charge in the communication charge sequence, the action to be performed is indicated by the tariff control indicators. + +Tariff duration shall have a INTEGER values form 0 to 36 000. + +Tariff duration identifies with 0 unlimited duration and else in seconds unit. + +0 = unlimited + +1 = 1 s + +2 = 2 s + +... + +36 000 = 10 h + +#### B.3.2.13 Sub tariff control type + +Sub tariff control shall contain 1 up to 8 one time charge elements. The coding of the one time charge element is as follows: + +- 0 - Periodic charge. +- 1 - One time charge. + +#### B.3.2.14 Charge unit time interval type + +The charge unit time interval is binary coded and has the value range from 0 to 35 997. It begins with 200 msec and then in steps of 50 msec. + +The LSBit is the least significant bit of the first octet. + +The MSBit is the most significant bit of the last octet. + +The coding of the ChargeUnitTimeInterval is the following: + +- 0 : no periodic metering +- 1 : 200 msec +- 2 : 250 msec +- .. +- 35 997 : 30 min + +All other values are spare. + +# Annex C (normative): SIP Transfer of Tariff Information XML schema: + +``` + + + + + XML Schema Definition for the AOC information + + + + + + + + + + + + + + + + + + + + + + + + + + + +> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +# --- Annex D (informative): IANA registration templates + +## D.1 IANA registry for Application Media Types + +### D.1.1 IANA Registration template for application/vnd.etsi.sci+xml + +NOTE 1: The information in the present Clause is for registration at IANA. RFC 4288 [10], section 9, describes the process that applies in case of changes to the registry of media types. Any future changes to the XML schema in Annex C or to the present Annex D.1.1 would require that this procedure is invoked. + +NOTE 2: The MIME type "application/vnd.etsi.sci+xml" has originally been registered at IANA based on ETSI TS 183 058 v2.0.0. The maintenance responsibility for this specification has been transferred to 3GPP. Some corrections to the syntax of the XML schema are only included in the present specification. The original IANA registration is therefore outdated. + +#### **MIME media type name:** + +application + +#### **MIME subtype name:** + +vnd.etsi.sci+xml + +#### **Required parameters:** + +None + +#### **Optional parameters:** + +"charset" the parameter has identical semantics to the charset parameter of the "application/xml" media type as specified in RFC 3023 [9]. + +"sv" or "schemaversion" the parameter's value is used to indicate: + +- the versions of the SIP Transfer of Tariff Information XML schema that can be used to validate the SIP Transfer of Tariff Information XML body (if the MIME type and parameter are present in the Content-Type header field) or +- the accepted versions of the SIP Transfer of Tariff Information XML body (if the MIME type and parameter are present in the Accept header field). + +If the "sv" and "schemaversion" parameter are absent, it shall be assumed that version 1.0 of the SIP Transfer of Tariff Information XML body is supported. + +#### **Encoding considerations:** + +Same as encoding considerations of application/xml as specified in RFC 3023 [9] + +#### **Security considerations:** + +Same as general security considerations for application/xml as specified in section 10 of RFC 3023 [9]. + +In addition, this content type provides a format for exchanging information in SIP, so the security considerations from RFC 3261 [8] apply. + +#### **Interoperability considerations:** + +Same as Interoperability considerations as specified in section 3.1 of RFC 3023 [9]. + +If both "sv" and "schemaversion" are specified, then the value of "schemaversion" is ignored. + +#### **Published specification:** + +3GPP TS 29.658, version 8.4.0: "SIP Transfer of IP Multimedia Service Tariff Information; Protocol specification" + +Available via <>. + +#### **Applications which use this media:** + +Applications that use the 3GPP IP multimedia (IM) Core Network (CN) subsystem as defined by 3GPP. + +#### **Intended usage:** + +COMMON + +#### **Additional information :** + +1. **Magic number(s)** : none +2. **File extension(s)** : none +3. **Macintosh file type code** : none +4. **Object Identifiers**: none + +# Annex E (informative): Change history + +| Change history | | | | | | | | | | +|----------------|--------|-----------|------|-----|--------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------|--|--------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | | | Old | New | +| 2008-01 | | | | | Publication as ETSI TS 183 058 | | | | 2.0.0 | +| 2008-01 | | | | | Conversion to 3GPP TS 29.458 | | | | 2.0.1 | +| 2008-01 | | | | | Technically identical copy as 3GPP TS 24.658 as basis for further development. | | | | 2.0.2 | +| 2008-05 | | | | | General corrections [C3-080721 at C3-48] | | | 2.0.2 | 2.1.0 | +| 2008-11 | | | | | Registration of MIME type with IANA [C3-081666 at C3-49] | | | 2.1.0 | 2.2.0 | +| 2008-11 | | | | | Correction in add on charging information [C3-081635 at C3-49] | | | 2.2.0 | 2.3.0 | +| 2008-11 | | | | | Network identification format for SIP Transfer of Charging Information parameters [C3-081636 at C3-49] | | | 2.2.0 | 2.3.0 | +| 2008-12 | TSG#42 | | | | v 8.0.0 was produced by MCC | | | 2.3.0 | 8.0.0 | +| 2009-03 | TSG#43 | CP-090089 | 001 | 3 | Charging terminology | | | 8.0.0 | 8.1.0 | +| 2009-03 | TSG#43 | CP-090062 | 002 | | Correction of scope | | | 8.0.0 | 8.1.0 | +| 2009-05 | TSG#44 | CP-090343 | 003 | | Invalid XML schema bug fix | | | 8.1.0 | 8.2.0 | +| 2009-09 | TSG#45 | CP-090631 | 005 | 003 | Aligning IANA registration of MIME type "application/vnd.etsi.sci+xml" | | | 8.2.0 | 8.3.0 | +| 2009-12 | TSG#46 | CP-090846 | 004 | 1 | RTTI Schema corrections | | | 8.3.0 | 8.4.0 | +| 2009-12 | TSG#46 | CP-090846 | 006 | 2 | IANA Registration template for application/vnd.etsi.sci+xml | | | 8.3.0 | 8.4.0 | +| 2009-12 | TSG#46 | | | | Automatic upgrade from previous Release | | | 8.4.0 | 9.0.0 | +| 2011-03 | TSG#51 | | | | Automatic upgrade from previous Release version 9.0.0 | | | 9.0.0 | 10.0.0 | +| 2012-06 | TSG#56 | CP-120333 | 015 | 1 | SIP Transfer of tariff XML correction | | | 10.0.0 | 10.1.0 | +| 2012-09 | TSG#57 | | | | Automatic upgrade from previous Release version 10.1.0 | | | 10.1.0 | 11.0.0 | +| 2013-06 | TSG#60 | CP-130347 | 021 | 2 | RTTI | | | 11.0.0 | 12.0.0 | +| 2015-12 | | | | | Automatic upgrade from previous Release version 12.0.0 | | | 12.0.0 | 13.0.0 | +| Change history | | | | | | | | | | +| Date | TSG # | TSG Doc. | CR | Rev | Cat | Subject/Comment | | New | | +| 2017-03 | CT#75 | | | | | Automatic upgrade from previous Release | | 14.0.0 | | +| 2018-06 | CT#80 | CP-181022 | 0022 | - | F | Correction of the NetworkIdentificationType example in the XML schema | | 15.0.0 | | +| 2020-07 | SA#88e | - | - | - | | Update to Rel-16 version (MCC) | | 16.0.0 | | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29673/053f1077d592e6622cd21dc4bb4cb366_img.jpg b/marked/Rel-16/29_series/29673/053f1077d592e6622cd21dc4bb4cb366_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9372272100398569e50b92d2e87956301fec9721 --- /dev/null +++ b/marked/Rel-16/29_series/29673/053f1077d592e6622cd21dc4bb4cb366_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8751e9c999d4648c34b3872bce266bad7160d87d792f46573158c09428de368d +size 26768 diff --git a/marked/Rel-16/29_series/29673/06da11ab76cacc38bbcd714e437797ea_img.jpg b/marked/Rel-16/29_series/29673/06da11ab76cacc38bbcd714e437797ea_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2d8317d5c48f9fcfacf3134a30f57d3d18121d78 --- /dev/null +++ b/marked/Rel-16/29_series/29673/06da11ab76cacc38bbcd714e437797ea_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:647cd553b256d2ff91494cc14c6c3477e0feb244f840af6be3e38256f2df32c1 +size 19347 diff --git a/marked/Rel-16/29_series/29673/2ba086df3506f81bae3a9b53725dcfea_img.jpg b/marked/Rel-16/29_series/29673/2ba086df3506f81bae3a9b53725dcfea_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c4a57db3b86f9b0740691361d4c47b0eda55004c --- /dev/null +++ b/marked/Rel-16/29_series/29673/2ba086df3506f81bae3a9b53725dcfea_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1647d01152ad102d78d3d9526ee1f4216ba33444707207bf4c90f2731b3b9c7c +size 28368 diff --git a/marked/Rel-16/29_series/29673/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-16/29_series/29673/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ca14378e5d46d66bc7483d510b2d07ea221465ed --- /dev/null +++ b/marked/Rel-16/29_series/29673/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2d60ce3386a40fd398bc21ba25e47a4dcac01ccf2a6b08d50b76bab74ab04b4a +size 9561 diff --git a/marked/Rel-16/29_series/29673/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-16/29_series/29673/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..fc924d1067c46172377b200ebb08ae3b53999479 --- /dev/null +++ b/marked/Rel-16/29_series/29673/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d46636e546559b79daeb84d4ea413280d0292b9209216ba9f94da5713dcf1944 +size 5894 diff --git a/marked/Rel-16/29_series/29673/75f0cb39f1cd165dfe4a6aa6c4d9388d_img.jpg b/marked/Rel-16/29_series/29673/75f0cb39f1cd165dfe4a6aa6c4d9388d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..31e51d9b83c272a050f08780832466dd9097b5f7 --- /dev/null +++ b/marked/Rel-16/29_series/29673/75f0cb39f1cd165dfe4a6aa6c4d9388d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2e88c2c23a243b1a16e7b290a9d2e62261b4a9f0689a44906d467bb6638f662f +size 30105 diff --git a/marked/Rel-16/29_series/29673/78ffccd66df9bafd96e3e081110d09dd_img.jpg b/marked/Rel-16/29_series/29673/78ffccd66df9bafd96e3e081110d09dd_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..aee072bbdc3c4e883541dec3c305244d0eeefb75 --- /dev/null +++ b/marked/Rel-16/29_series/29673/78ffccd66df9bafd96e3e081110d09dd_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:39bb5ecd2d215eaa0d031c037dfa6f770de67670a38d7b438a3387c9dc624562 +size 30600 diff --git a/marked/Rel-16/29_series/29673/8e14350b4b669119a3bdfca7869110ca_img.jpg b/marked/Rel-16/29_series/29673/8e14350b4b669119a3bdfca7869110ca_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f9f299c7f31d5d514028a5214fb9d65a484f64b7 --- /dev/null +++ b/marked/Rel-16/29_series/29673/8e14350b4b669119a3bdfca7869110ca_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:af2581aeba40763495f6bd24997f97472ca95dab4ff89a03d07416a252f8ff56 +size 32168 diff --git a/marked/Rel-16/29_series/29673/cb8dd5eca74bbf15a81e37c23263c9a8_img.jpg b/marked/Rel-16/29_series/29673/cb8dd5eca74bbf15a81e37c23263c9a8_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..909f1c8e80e2813c1c6383b7e5276aad07a67140 --- /dev/null +++ b/marked/Rel-16/29_series/29673/cb8dd5eca74bbf15a81e37c23263c9a8_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b27b3ebdee1176b9cd52cafeb5dc9bd612fefedb74efd8da9a0be4e01129ec4e +size 30181 diff --git a/marked/Rel-16/29_series/29673/fc69ceb1dee1da7e33bd6c38fc4ceab9_img.jpg b/marked/Rel-16/29_series/29673/fc69ceb1dee1da7e33bd6c38fc4ceab9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8802ee1bf5aadaa3b3e404f157481516dc29122a --- /dev/null +++ b/marked/Rel-16/29_series/29673/fc69ceb1dee1da7e33bd6c38fc4ceab9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:77be7bf2f8a3c92645159d8ea11b1d079afff52034098ca84e8e27044428d298 +size 38129 diff --git a/marked/Rel-16/29_series/29673/raw.md b/marked/Rel-16/29_series/29673/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..8bb52162a8678eea3e117a6b157e31e8926fee81 --- /dev/null +++ b/marked/Rel-16/29_series/29673/raw.md @@ -0,0 +1,2025 @@ + + +# 3GPP TS 29.673 V16.7.0 (2021-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; UE radio capability management services; Stage 3 (Release 16)** + +![5G logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The 5G logo, consisting of the text "5G" in a bold, black, sans-serif font. Above the "5G" text are three green, curved lines representing signal waves. + +5G logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, featuring the text "3GPP" in a stylized, bold, black font. Below the "3GPP" text is a red signal icon consisting of three curved lines. Below the icon, the text "A GLOBAL INITIATIVE" is written in a smaller, black, sans-serif font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + +--- + + + +# --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2021, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|--------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions of terms, symbols and abbreviations..... | 7 | +| 3.1 Terms..... | 7 | +| 3.2 Symbols..... | 7 | +| 3.3 Abbreviations ..... | 7 | +| 4 Overview..... | 7 | +| 4.1 Introduction ..... | 7 | +| 5 Services offered by the UCMF ..... | 8 | +| 5.1 Introduction ..... | 8 | +| 5.2 Nucmf_UECapabilityManagement Service..... | 8 | +| 5.2.1 Service Description ..... | 8 | +| 5.2.2 Service Operations..... | 9 | +| 5.2.2.1 Introduction..... | 9 | +| 5.2.2.2 Service Operation Resolve..... | 9 | +| 5.2.2.2.1 General ..... | 9 | +| 5.2.2.2.2 Retrieve a Dictionary Entry..... | 10 | +| 5.2.2.3 Service Operation Assign ..... | 10 | +| 5.2.2.4 Service Operation Subscribe..... | 11 | +| 5.2.2.4.1 General ..... | 11 | +| 5.2.2.5 Unsubscribe ..... | 12 | +| 5.2.2.5.1 General ..... | 12 | +| 5.2.2.6 Notify ..... | 13 | +| 5.2.2.6.1 General ..... | 13 | +| 6 API Definitions ..... | 13 | +| 6.1 Nucmf_UECapabilityManagement Service API ..... | 13 | +| 6.1.1 Introduction ..... | 13 | +| 6.1.2 Usage of HTTP..... | 14 | +| 6.1.2.1 General..... | 14 | +| 6.1.2.2 HTTP standard headers..... | 14 | +| 6.1.2.2.1 General ..... | 14 | +| 6.1.2.2.2 Content type ..... | 14 | +| 6.1.2.3 HTTP custom headers..... | 14 | +| 6.1.2.4 HTTP multipart messages..... | 14 | +| 6.1.3 Resources..... | 15 | +| 6.1.3.1 Overview..... | 15 | +| 6.1.3.2 Resource: Dictionary Entries ..... | 16 | +| 6.1.3.2.1 Description ..... | 16 | +| 6.1.3.2.2 Resource Definition..... | 16 | +| 6.1.3.2.3 Resource Standard Methods..... | 16 | +| 6.1.3.2.3.1 GET ..... | 16 | +| 6.1.3.2.3.2 POST ..... | 18 | +| 6.1.3.2.4 Resource Custom Operations..... | 19 | +| 6.1.3.3 Resource: Individual Dictionary Entry ..... | 19 | +| 6.1.3.3.1 Description ..... | 19 | +| 6.1.3.3.2 Resource Definition..... | 20 | +| 6.1.3.3.3 Resource Standard Methods..... | 20 | +| 6.1.3.3.3.1 GET ..... | 20 | +| 6.1.3.4 Resource: Subscriptions collection..... | 21 | +| 6.1.3.4.1 Description ..... | 21 | +| 6.1.3.4.2 Resource Definition..... | 21 | +| 6.1.3.4.3 Resource Standard Methods..... | 22 | + +| | | | +|-------------------------------------------------|----------------------------------------------------------------------------------|----| +| 6.1.3.4.3.1 | POST ..... | 22 | +| 6.1.3.4.4 | Resource Custom Operations ..... | 23 | +| 6.1.3.5 | Resource: Individual subscription ..... | 23 | +| 6.1.3.5.1 | Description ..... | 23 | +| 6.1.3.5.2 | Resource Definition..... | 23 | +| 6.1.3.5.3 | Resource Standard Methods..... | 23 | +| 6.1.3.5.3.2 | DELETE ..... | 23 | +| 6.1.3.5.4 | Resource Custom Operations ..... | 25 | +| 6.1.4 | Custom Operations without associated resources ..... | 25 | +| 6.1.5 | Notifications ..... | 25 | +| 6.1.5.1 | General ..... | 25 | +| 6.1.5.2 | UCMF Notification..... | 25 | +| 6.1.5.2.1 | Description ..... | 25 | +| 6.1.5.2.2 | Target URI..... | 25 | +| 6.1.5.2.3 | Standard Methods..... | 25 | +| 6.1.5.2.3.1 | POST ..... | 25 | +| 6.1.6 | Data Model ..... | 26 | +| 6.1.6.1 | General ..... | 26 | +| 6.1.6.2 | Structured data types..... | 27 | +| 6.1.6.2.1 | Introduction ..... | 27 | +| 6.1.6.2.2 | Type: DicEntryData ..... | 28 | +| 6.1.6.2.3 | Type: DicEntryCreateData..... | 29 | +| 6.1.6.2.4 | Type: DicEntryCreatedData..... | 29 | +| 6.1.6.2.5 | Type: UeRadioCapaId..... | 29 | +| 6.1.6.2.6 | Type: CreateSubscription..... | 30 | +| 6.1.6.2.7 | Type: CreatedSubscription..... | 30 | +| 6.2.6.2.8 | Type: UcmfNotification ..... | 30 | +| 6.2.6.2.9 | Type: ManAssOpRequestList..... | 31 | +| 6.1.6.3 | Simple data types and enumerations..... | 31 | +| 6.1.6.3.1 | Introduction ..... | 31 | +| 6.1.6.3.2 | Simple data types ..... | 31 | +| 6.1.6.3.3 | Enumeration: EventType..... | 31 | +| 6.1.6.3.4 | Enumeration: RacFormat ..... | 31 | +| 6.1.6.4 | Data types describing alternative data types or combinations of data types ..... | 32 | +| 6.1.6.5 | Binary data ..... | 32 | +| 6.1.6.5.2 | UE Radio Capability Information ..... | 32 | +| 6.1.7 | Error Handling ..... | 32 | +| 6.1.7.1 | General ..... | 32 | +| 6.1.7.2 | Protocol Errors ..... | 32 | +| 6.1.7.3 | Application Errors..... | 32 | +| 6.1.8 | Feature negotiation..... | 33 | +| 6.1.9 | Security..... | 33 | +| 6.1.10 | HTTP redirection..... | 33 | +| Annex A (normative):OpenAPI specification ..... | | 34 | +| A.1 | General ..... | 34 | +| A.2 | Nucmf_UECapabilityManagement API ..... | 34 | +| Annex B (informative): Change history ..... | | 43 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document specifies the stage 3 protocol and data model for the Nucmf Service Based Interface. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the Nucmf. + +The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] OpenAPI: "OpenAPI 3.0.0 Specification", . +- [7] 3GPP TR 21.900: "Technical Specification Group working methods". +- [8] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [9] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [10] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". +- [11] IETF RFC 7540: "Hypertext Transfer Protocol Version 2 (HTTP/2)". +- [12] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [13] IETF RFC 7807: "Problem Details for HTTP APIs". +- [14] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". + +- [15] 3GPP TS 38.413: "NG Radio Access Network (NG-RAN); NG Application Protocol (NGAP)". +- [16] 3GPP TS 29.274: "3GPP Evolved Packet System (EPS); Evolved General Packet Radio Service (GPRS) Tunnelling Protocol for Control plane (GTPv2-C); Stage 3". +- [17] 3GPP TS 36.413: "Evolved Universal Terrestrial Radio Access Network (E-UTRAN); S1 Application Protocol (S1AP)" + +# 3 Definitions of terms, symbols and abbreviations + +## 3.1 Terms + +void + +## 3.2 Symbols + +void + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|------|-----------------------------------------| +| MME | Mobility Management Entity | +| UCMF | UE radio Capability Management Function | + +# 4 Overview + +## 4.1 Introduction + +Within the 5GC, the UCMF offers services to the NF (e.g. AMF and MME) via the Nucmf service based interface (see 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]). + +Figure 4.1-1 provides the reference model (in service based interface representation and in reference point representation), with focus on the UCMF and the scope of the present specification. + +![Reference model diagram showing the UCMF connected to AMF, MME, NEF, and AF via Nucmf interfaces N55, N56, and N57.](06da11ab76cacc38bbcd714e437797ea_img.jpg) + +The diagram illustrates the reference model for the UCMF. On the left, four network functions (NFs) are shown: AMF, MME, NEF, and AF. The MME is at the top, connected to the UCMF via the Nucmf interface (N55). The AMF is below the MME, connected to the UCMF via the Nucmf interface (N56). The NEF is below the AMF, connected to the UCMF via the Nucmf interface (N57). The AF is at the bottom, connected to the UCMF via the Nucmf interface (N57). The UCMF is shown as a large green rectangle on the right, with a small circle on its left side labeled 'Nucmf'. + +Reference model diagram showing the UCMF connected to AMF, MME, NEF, and AF via Nucmf interfaces N55, N56, and N57. + +Figure 4.1-1: Reference model – UCMF + +The functionalities supported by the UCMF are listed in clause 6.2.5 of 3GPP TS 23.501 [2]. + +# 5 Services offered by the UCMF + +## 5.1 Introduction + +The UCMF supports the following services. + +**Table 5.1-1: NF Services provided by UCMF** + +| Service Name | Description | Example Consumer | +|------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------| +| Nucmf_UECapabilityManagement |

Allows the NF consumer to resolve UE Radio Capability ID (either Manufacturer-assigned or PLMN-assigned) into the corresponding UE radio access capability and the corresponding UE Radio Capability for Paging.

Allows the NF consumer to obtain a PLMN-assigned UE Radio Capability ID for a specific UE radio access capability.

Allows the NF consumer to subscribe or unsubscribe for notifications of UCMF dictionary entries.

Allows the NF consumer to be notified about creation and deletion of UCMF dictionary entries.

| AMF, MME | + +## 5.2 Nucmf\_UECapabilityManagement Service + +### 5.2.1 Service Description + +The Nucmf\_UECapabilityManagement service operates on the dictionary entries for the mapping between UE Radio Capability ID and UE Radio Access Capability Information. The service operations exposed by this service allow service consumer NF, e.g. an AMF: + +- to retrieve UE radio access capability information with a UE Radio Capability ID (either Manufacturer-assigned or PLMN-assigned); +- to obtain a PLMN-assigned UE Radio Capability ID for a specific UE radio access capability information; +- to subscribe or unsubscribe for notifications of UCMF dictionary entries; +- to be notified about creation and deletion of UCMF dictionary entries; + +The Nucmf\_UECapabilityManagement service supports the following service operations; + +**Table 5.2.1-1: Service operations supported by the Nucmf\_UECapabilityManagement service** + +| Service Operations | Description | Operation Semantics | Example Consumer(s) | +|--------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------|---------------------| +| Resolve | Retrieve UE radio access capability information from the dictionary entry identified by the UE Radio Capability ID (either Manufacturer-assigned or PLMN-assigned) | Request/Response | AMF, MME | +| Assign | Request to assign a UE Radio Capability ID by providing the UE Radio Capability Information. See 3GPP TS 23.502 clause 5.2.18.3.2. | Request/Response | AMF, MME | +| Subscribe | Subscribe for notifications of UCMF dictionary entries. | Subscribe/Notify | AMF, MME | +| Unsubscribe | Unsubscribe for notifications of UCMF dictionary entries. | Subscribe/Notify | AMF, MME | +| Notify | To be notified about creation and deletion of UCMF dictionary entries. | Subscribe/Notify | AMF, MME | + +### 5.2.2 Service Operations + +#### 5.2.2.1 Introduction + +See Table 5.2.1-1 for an overview of the service operations supported by the Nucmf\_UECapabilityManagement service. + +#### 5.2.2.2 Service Operation Resolve + +##### 5.2.2.2.1 General + +The Resolve service operation shall be used to retrieve UE Radio Access Capability Information from a dictionary entry stored in the UCMF, by a NF service consumer, e.g. an AMF, when: + +- it has received an unknown UE Radio Capability ID, which is either Manufacturer-assigned or PLMN-assigned; + +The NF Service Consumer (e.g. AMF) shall retrieve UE Radio Access Capability Information by using the HTTP GET method as shown in Figure 5.2.2.2.1-1. + +![Sequence diagram showing the interaction between an NF Service Consumer and the UCMF to retrieve UE Radio Access Capability Information. The consumer sends a GET request to the UCMF, and the UCMF responds with either a 200 OK (dicEntryData) or an error status (4xx/5xx or 3xx).](2ba086df3506f81bae3a9b53725dcfea_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant UCMF + Note left of NF Service Consumer: Request UE Radio Access Capability Information + NF Service Consumer->>UCMF: GET .../dic-entries ? + Note right of UCMF: Success + UCMF-->>NF Service Consumer: 2a. 200 OK (dicEntryData) + Note right of UCMF: Error + UCMF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and the UCMF to retrieve UE Radio Access Capability Information. The consumer sends a GET request to the UCMF, and the UCMF responds with either a 200 OK (dicEntryData) or an error status (4xx/5xx or 3xx). + +**Figure: 5.2.2.2.1-1 Retrieve UE Radio Access Capability Information** + +1. The NF Service Consumer, e.g. an AMF, shall send an HTTP GET request to the resource URI Dictionary Entries collection resource. The query parameters are a Manufacturer-assigned or a PLMN-assigned UE Radio Capability ID, and the Coding format (e.g. 5GS or EPS) in which UE Radio Access Capability Information needs to be provided. +- 2a. On success, "200 OK" shall be returned. The response body shall contain UE Radio Access Capability Information in the requested Coding format stored in the dictionary entry that is matching the UE Radio Capability ID in query, and may contain a PLMN-assigned UE Radio Capability ID if the query parameter is a Manufacturer-assigned UE Radio Capability ID and if the PLMN-assigned UE Radio Capability ID mechanism is used in the network. + +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.3.3.2-3 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.1.3.3.3.2-2, where applicable. + +##### 5.2.2.2.2 Retrieve a Dictionary Entry + +The Resolve service operation may be used to retrieve a dictionary entry stored in the UCMF, by a NF service consumer, e.g. an AMF, when it has the Dictionary Entry ID available. + +The NF Service Consumer (e.g. AMF) shall retrieve a Dictionary Entry by using the HTTP GET method as shown in Figure 5.2.2.2.1-1. + +![Sequence diagram for Figure 5.2.2.2.1-1: Retrieve a dictionary entry. The diagram shows an NF Service Consumer sending a GET request to a UCMF. The UCMF responds with either a 200 OK (dicEntryData) or a 4xx/5xx (ProblemDetails) or 3xx response.](053f1077d592e6622cd21dc4bb4cb366_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant UCMF + Note left of NF Service Consumer: GET ../dic-entries/{dicEntryId} + NF Service Consumer->>UCMF: Request + Note right of UCMF: 2a. 200 OK (dicEntryData) + UCMF-->>NF Service Consumer: Response 2a + Note right of UCMF: 2b. 4xx/5xx (ProblemDetails) or 3xx + UCMF-->>NF Service Consumer: Response 2b + +``` + +Sequence diagram for Figure 5.2.2.2.1-1: Retrieve a dictionary entry. The diagram shows an NF Service Consumer sending a GET request to a UCMF. The UCMF responds with either a 200 OK (dicEntryData) or a 4xx/5xx (ProblemDetails) or 3xx response. + +Figure 5.2.2.2.1-1 Retrieve a dictionary entry + +1. The NF Service Consumer, e.g. an AMF, shall send an HTTP GET request to an individual Dictionary Entry resource. The query parameter is the Coding Format (e.g. 5GS or EPS) in which UE Radio Access Capability Information needs to be provided. +- 2a. On success, "200 OK" shall be returned. The response body shall the dictionary entry information for the given Dictionary Entry ID. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.3.3.2-3 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.1.3.3.3.2-3, where applicable. + +##### 5.2.2.2.3 Service Operation Assign + +The Assign service operation shall be used by the service consumer NF (e.g. AMF) to obtain a PLMN-assigned UE Radio Capability ID from the UCMF for a specific UE radio access capability information. The UCMF shall create a new dictionary entry and assign a PLMN-assigned UE Radio Capability ID unless such dictionary entry already exists and a PLMN-assigned UE Radio Capability ID has already been assigned to the given UE radio access capability information in the UCMF. The NF service consumer, e.g. an AMF, may consume the service by providing the UE Radio Access Capability Information retrieved from the UE, and Type Allocation Code of PEI of the UE, e.g. when it hasn't received any UE Radio Capability ID. + +**The NF Service Consumer (e.g. AMF) shall obtain the PLMN Assigned UE Radio Capability ID by using the HTTP POST method as shown in Figure 5.2.2.3.1-1.** + +![Sequence diagram for Figure 5.2.2.3.1-1: Create a dictionary entry. The diagram shows an NF Service Consumer (e.g. an AMF) sending a POST request to a UCMF. The UCMF responds with either a 201 Created (DicEntryCreatedData) or a 4xx/5xx (ProblemDetails) or 3xx response.](fc69ceb1dee1da7e33bd6c38fc4ceab9_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer as NF Service Consumer +e.g. an AMF + participant UCMF + Note left of NF Service Consumer: 1. POST ../dic-entries (DicEntryCreateData) + NF Service Consumer->>UCMF: Request + Note right of UCMF: 2a. 201 Created (DicEntryCreatedData) + UCMF-->>NF Service Consumer: Response 2a + Note right of UCMF: 2b. 4xx/5xx (ProblemDetails) or 3xx + UCMF-->>NF Service Consumer: Response 2b + +``` + +Sequence diagram for Figure 5.2.2.3.1-1: Create a dictionary entry. The diagram shows an NF Service Consumer (e.g. an AMF) sending a POST request to a UCMF. The UCMF responds with either a 201 Created (DicEntryCreatedData) or a 4xx/5xx (ProblemDetails) or 3xx response. + +Figure 5.2.2.3.1-1 Create a dictionary entry + +1. The NF Service Consumer shall send a POST request to the resource representing the Dictionary Entries collection resource of the UCMF. The payload body of the POST request shall contain: + - the UE Radio Access Capability Information for the current radio configuration of the UE in 5GS format, or EPS format, or both the formats; + - the Type Allocation Code of the PEI of the UE. +- 2a. On success, the UCMF shall check whether for the provided input a dictionary entry already exists and a PLMN Assigned UE Radio Capability ID has already been assigned. If so "201 Created" shall be returned, the payload body of the POST response shall contain already assigned PLMN Assigned UE Radio Capability ID included in DicEntryCreatedData and the "Location" header shall be present and shall contain the URI of the already existing resource. Otherwise a new dictionary entry shall be created and "201 Created" shall be returned, the payload body of the POST response shall contain the newly assigned PLMN Assigned UE Radio Capability ID included in DicEntryCreatedData and the "Location" header shall be present and shall contain the URI of the newly created resource. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.2.3.2-3 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.1.3.3.2-2, where applicable. A UCMF configured to operate in Mode of Operation A (3GPPP TS 23.501, Clause 5.4.4.1a) shall reject the operation if the request does not contain UE Radio Access Capability Information in both the formats and the UCMF is not able to find match of the received UE Radio Access Capability Information in its database. + +#### 5.2.2.4 Service Operation Subscribe + +##### 5.2.2.4.1 General + +The Subscribe service operation shall be used by a NF Service Consumer, e.g. an AMF, to create a subscription in the UCMF, to get notifications for one or more new dictionary entries creation or for the deletion of one or more PLMN Assigned UE Radio Capability IDs. + +The NF Service Consumer shall request to create a new subscription by using HTTP method POST with URI of the subscriptions collection, see clause 6.1.3.4. A ucmfNotificationUri shall be provided in the CreateSubscription to be used by the UCMF to send notifications later. See Figure 5.2.2.4.1-1. + +![Sequence diagram showing the interaction between an NF Service Consumer and a UCMF to create a subscription. The NF Service Consumer sends a POST request to the UCMF. The UCMF responds with either a 201 Created status or a 4xx/5xx status with ProblemDetails or a 3xx status.](8e14350b4b669119a3bdfca7869110ca_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant UCMF + Note left of NF Service Consumer: NF Service Consumer + Note right of UCMF: UCMF + NF Service Consumer->>UCMF: 1. POST .../subscriptions (CreateSubscription) + UCMF-->>NF Service Consumer: 2a. 201 Created (CreatedSubscription) + UCMF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx- + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and a UCMF to create a subscription. The NF Service Consumer sends a POST request to the UCMF. The UCMF responds with either a 201 Created status or a 4xx/5xx status with ProblemDetails or a 3xx status. + +Figure 5.2.2.4.1-1 Create a subscription + +1. The NF Service Consumer shall send a POST request to create a subscription resource in the UCMF. The payload body of the POST request shall contain a representation of the individual subscription resource to be created. The request may contain an expiry time, suggested by the NF Service Consumer as a hint, representing the time upto which the subscription is desired to be kept active and the time after which the subscribed event(s) shall stop generating report. +- 2a. On success, the request is accepted, the UCMF shall include a HTTP Location header to provide the location of a newly created resource (subscription) together with the status code 201 indicating the requested resource is created in the response message. The UCMF may also include the highest dictionary entry ID which has been allocated. + +The response, based on operator policy and taking into account the expiry time included in the request, may contain the expiry time, as determined by the UCMF, after which the subscription becomes invalid. Once the subscription expires, if the NF Service Consumer wants to keep receiving notifications, it shall create a new + +subscription in the UCMF. The UCMF shall not provide the same expiry time for many subscriptions in order to avoid all of them expiring and recreating the subscription at the same time. If the expiry time is not included in the response, the NF Service Consumer shall consider the subscription to be valid without an expiry time. + +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.4.3.1-3 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.1.3.4.3.1-3. + +#### 5.2.2.5 Unsubscribe + +##### 5.2.2.5.1 General + +The Unsubscribe service operation is used by a NF Service Consumer, e.g. AMF, towards the UCMF, to remove an existing subscription previously created by itself at the UCMF. + +The NF Service Consumer shall unsubscribe to the subscription by using HTTP method DELETE with the URI of the individual subscription resource (see clause 6.1.3.5) to be deleted. See Figure 5.2.2.5.1-1. + +![Sequence diagram for Unsubscribe a subscription. The NF Service Consumer sends a DELETE request to the UCMF. The UCMF responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection) status code.](78ffccd66df9bafd96e3e081110d09dd_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant UCMF + Note left of NF Service Consumer: 1. DELETE .../subscriptions/{subscriptionId} + NF Service Consumer->>UCMF: 1. DELETE .../subscriptions/{subscriptionId} + Note right of UCMF: -2a. 204 No Content + UCMF-->>NF Service Consumer: -2a. 204 No Content + Note right of UCMF: -2b. 4xx/5xx (ProblemDetails) or 3xx + UCMF-->>NF Service Consumer: -2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram for Unsubscribe a subscription. The NF Service Consumer sends a DELETE request to the UCMF. The UCMF responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection) status code. + +Figure 5.2.2.5.1-1 Unsubscribe a subscription + +- The NF Service Consumer shall send a DELETE request to delete an existing subscription resource in the UCMF. +- On success, the request is accepted, the UCMF shall reply with the status code 204 indicating the resource identified by subscription ID is successfully deleted in the response message. +- On failure or redirection, one of the HTTP status code listed in Table 6.1.3.5.3.2-3 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.3.5.3.2-3. + +#### 5.2.2.6 Notify + +##### 5.2.2.6.1 General + +The Notify service operation is used by the UCMF, to send a notification, towards the notification URI, when certain event included in the subscription has taken place. + +The UCMF shall use the HTTP method POST, using the notification URI received in the subscription creation as specified in clause 5.2.2.4.1. See Figure 5.2.2.6.1-1. + +![Sequence diagram for Notify. The UCMF sends a POST request to the NF Service Consumer. The NF Service Consumer responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection) status code.](cb8dd5eca74bbf15a81e37c23263c9a8_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant UCMF + Note right of UCMF: 1. POST {UcmfNotificationUrl}(UcmfNotification) + UCMF->>NF Service Consumer: 1. POST {UcmfNotificationUrl}(UcmfNotification) + Note left of NF Service Consumer: -2a. 204 No Content + NF Service Consumer-->>UCMF: -2a. 204 No Content + Note left of NF Service Consumer: -2b. 4xx/5xx (ProblemDetails) or 3xx + NF Service Consumer-->>UCMF: -2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram for Notify. The UCMF sends a POST request to the NF Service Consumer. The NF Service Consumer responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection) status code. + +Figure 5.2.2.6.1-1 Notify + +1. The AMF shall send a POST request to send a notification. +- 2a. On success, "204 No content" shall be returned by the NF Service Consumer. +- 2b. On failure or redirection, the appropriate HTTP status code (e.g. "403 Forbidden") indicating the error shall be returned and appropriate additional error information should be returned. + +# --- 6 API Definitions + +## 6.1 Nucmf\_UECapabilityManagement Service API + +### 6.1.1 Introduction + +The Nucmf\_UECapabilityManagement service shall use the Nucmf\_UECapabilityManagement API. + +The API URI of the Nucmf\_UECapabilityManagement API shall be: + +**{apiRoot}
/** + +The request URI used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nucmf-uecm". +- The shall be "v1". +- The shall be set as described in clause 5.3. + +### 6.1.2 Usage of HTTP + +#### 6.1.2.1 General + +HTTP/2, IETF RFC 7540 [11], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +The OpenAPI [6] specification of HTTP messages and content bodies for the API is contained in Annex A. + +#### 6.1.2.2 HTTP standard headers + +##### 6.1.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers. + +##### 6.1.2.2.2 Content type + +JSON, IETF RFC 8259 [12], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [4]. The use of the JSON format shall be signalled by the content type "application/json". + +"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 7807 [13]. + +Multipart messages shall also be supported (see clause 6.1.2.4) using the content type "multipart/related", comprising: + +- one JSON body part with the "application/json" content type; and +- one or more binary body parts with 3gpp vendor specific content subtypes. + +The 3gpp vendor specific content subtypes defined in Table 6.1.2.2.2-1 shall be supported. + +**Table 6.1.2.2.2-1: 3GPP vendor specific content subtypes** + +| content subtype | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------| +| vnd.3gpp.ngap | Binary encoded payload, encoding NG Application Protocol (NGAP) IEs, as specified in clause 9.3 of 3GPP TS 38.413 [15] (ASN.1 encoded). | +| vnd.3gpp.s1ap | Binary encoded payload, encoding S1 Application Protocol (S1AP) IEs, as specified in clause 9.2 of 3GPP TS 36.413 [17] (ASN.1 encoded). | +| NOTE: Using 3GPP vendor content subtypes allows to describe the nature of the opaque payload (e.g. NGAP or 5GS NAS information) without having to rely on metadata in the JSON payload. | | + +See clause 6.1.2.4 for the binary payloads supported in the binary body part of multipart messages. + +#### 6.1.2.3 HTTP custom headers + +The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] shall be applicable. + +#### 6.1.2.4 HTTP multipart messages + +HTTP multipart messages shall be supported to transfer opaque UE Radio Access Capability Information, in the following service operations (and HTTP messages): + +- Resolve Response (GET Response); +- Assign Request (POST); + +HTTP multipart message shall include one JSON body part and one or more binary body parts comprising the OCTET STRING of the UE Radio Capability IE (i.e. excluding the IEI, Criticality and octet string length indicator, see also Annex B of 3GPP TS 29.274 [16]) as specified in clause 9.3.1.74 of 3GPP TS 38.413 [15]) and clause 9.2.1.27 of 3GPP TS 36.413 [17], or the UE Radio Access Capability for Paging IE as specified in clause 9.2.1.98 of 3GPP TS 36.413 [17] and as specified in clause 9.3.1.68 of 3GPP TS 38.413 [15]. + +The JSON body part shall be the "root" body part of the multipart message. It shall be encoded as the first body part of the multipart message. The "Start" parameter does not need to be included. + +The multipart message shall include a "type" parameter (see IETF RFC 2387 [10]) specifying the media type of the root body part, i.e. "application/json". + +NOTE: The "root" body part (or "root" object) is the first body part the application processes when receiving a multipart/related message, see IETF RFC 2387 [10]. The default root is the first body within the multipart/related message. The "Start" parameter indicates the root body part, e.g. when this is not the first body part in the message. + +For each binary body part in a HTTP multipart message, the binary body part shall include a Content-ID header (see IETF RFC 2045 [12]), and the JSON body part shall include an attribute, defined with the RefToBinaryData type, that contains the value of the Content-ID header field of the referenced binary body part. + +### 6.1.3 Resources + +#### 6.1.3.1 Overview + +![Resource URI structure diagram showing a hierarchy starting from {apiRoot}/nucmf-ucm/. It branches into /dic-entries and /subscriptions. /dic-entries further branches into /{dicEntryId}. /subscriptions further branches into /{subscriptionsId}.](75f0cb39f1cd165dfe4a6aa6c4d9388d_img.jpg) + +{apiRoot}/nucmf-ucm/ + +``` + +graph TD + Root["{apiRoot}/nucmf-ucm/"] --> DicEntries["/dic-entries"] + Root --> Subscriptions["/subscriptions"] + DicEntries --> DicEntryId["/{dicEntryId}"] + Subscriptions --> SubscriptionsId["/{subscriptionsId}"] + +``` + +Resource URI structure diagram showing a hierarchy starting from {apiRoot}/nucmf-ucm/. It branches into /dic-entries and /subscriptions. /dic-entries further branches into /{dicEntryId}. /subscriptions further branches into /{subscriptionsId}. + +**Figure 6.1.3.1-1: Resource URI structure of the Nucmf\_UECapabilityManagement API** + +Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.1.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|-------------------------------|---------------------------------|---------------------------------|------------------------------------------| +| Dictionary Entries collection | /dic-entries | POST | Nucmf_UECapabilityManagement_Assign | +| | | GET | Nucmf_UECapabilityManagement_Resolve | +| Individual Dictionary Entry | /dic-entries/{dicEntryId} | GET | Nucmf_UECapabilityManagement_Resolve | +| Subscriptions collection | /subscriptions | POST | Nucmf_UECapabilityManagement_Subscribe | +| Individual subscription | /subscriptions/{subscriptionId} | DELETE | Nucmf_UECapabilityManagement_Unsubscribe | + +#### 6.1.3.2 Resource: Dictionary Entries + +##### 6.1.3.2.1 Description + +This resource represents the collection of the individual dictionary entries created in the UCMF, where each individual dictionary entry includes the mapping information between UE Radio Capability ID and UE Radio Access Capability Information, Type Allocation Code and Software version of a PEI. + +This resource is modelled with the Collection resource archetype (see clause C.2 of 3GPP TS 29.501 [5]). + +##### 6.1.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nucmf-ucm//dic-entries + +This resource shall support the resource URI variables defined in table 6.1.3.2.2-1. + +**Table 6.1.3.2.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|------------------| +| apiRoot | See clause 6.1.1 | +| apiVersion | See clause 6.1.1 | + +##### 6.1.3.2.3 Resource Standard Methods + +###### 6.1.3.2.3.1 GET + +This operation retrieves the UE Radio Access Capability Information from a dictionary entry stored in the UCMF, by querying with a Manufacturer-assigned or PLMN-assigned UE Radio Capability ID, or the TAC and the SVN as part of the IMEI/IMEISV of the UE. + +This method shall support the URI query parameters specified in table 6.1.3.2.3.1-1. + +**Table 6.1.3.2.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------|---|-------------|---------------------------------------------------------------------------------------------------------------|---------------| +| ue-radio-capa-id | UeRadioCapaId | M | 1 | PLMN assigned or Manufacturer assigned UE Radio Capability ID used to retrieve a dictionary entry. | | +| rac-format | RacFormat | C | 0..1 | Coding format in which UE Radio Access Capability Information needs to be provided. See the clause 6.1.6.3.4. | | +| supported-features | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. | | + +This method shall support the request data structures specified in table 6.1.3.2.3.1-2 and the response data structures and response codes specified in table 6.1.3.2.3.1-3. + +**Table 6.1.3.2.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.2.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| DicEntryData | M | 1 | 200 OK | The response body contains a dictionary entry that is matching the querying parameter. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same UCMF or UCMF (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same UCMF or UCMF (service) set. | +| ProblemDetails | O | 0..1 | 400 Bad Request | The response body contains the error reason of the request message. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
  • - NO_DICTIONARY_ENTRY_FOUND
  • - OUT_DATED_VERSION_ID_IN_RAC_ID
See table 6.1.7.3-1 for the description of this error. | + +NOTE: The mandatory HTTP error status code for the GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +**Table 6.1.3.2.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same UCMF or UCMF (service) set.
Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.2.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same UCMF or UCMF (service) set.
Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +###### 6.1.3.2.3.2 POST + +This method creates an individual dictionary entry resource in the UCMF unless such dictionary entry already exists. + +This method shall support the URI query parameters specified in table 6.1.3.2.3.2-1. + +**Table 6.1.3.2.3.2-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.1.3.2.3.2-2 and the response data structures and response codes specified in table 6.1.3.2.3.2-3. + +**Table 6.1.3.2.3.2-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------|---|-------------|---------------------------------------------------------------------------| +| DicEntryCreateData | M | 1 | Contains UE Radio Access Capability Information and type Allocation Code. | + +**Table 6.1.3.2.3.2-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| DicEntryCreatedData | M | 1 | 201
Created | The response body contains the assigned UE Radio Capability ID. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same UCMF or UCMF (service) set. | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same UCMF or UCMF (service) set. | +| ProblemDetails | O | 0..1 | 400 Bad Request | The response body contains the error reason of the request message. | +| NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +**Table 6.1.3.2.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same UCMF or UCMF (service) set.
Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.2.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same UCMF or UCMF (service) set.
Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +##### 6.1.3.2.4 Resource Custom Operations + +None. + +#### 6.1.3.3 Resource: Individual Dictionary Entry + +##### 6.1.3.3.1 Description + +This resource represents an individual Dictionary Entry for the mapping information between UE Radio Capability ID(s) and UE Radio Access Capability information, identified by the Dictionary Entry ID. + +This resource is modelled as the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [5]). + +##### 6.1.3.3.2 Resource Definition + +Resource URI: {apiRoot}/nucmf-ucm//dic-entries/{dicEntryId} + +This resource shall support the resource URI variables defined in table 6.1.3.3.2-1. + +**Table 6.1.3.3.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|----------------------------------| +| apiRoot | See clause 6.1.1 | +| apiVersion | See clause 6.1.1. | +| dicEntryId | Integer with range 1-4294967295. | + +##### 6.1.3.3.3 Resource Standard Methods + +###### 6.1.3.3.3.1 GET + +This operation retrieves an individual dictionary entry resource for the mapping information between UE Radio Capability ID(s) and UE Radio Access Capability information, stored in the UCMF, identified by the dicEntryId. + +This method shall support the URI query parameters specified in table 6.1.3.3.3.1-1. + +**Table 6.1.3.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------|---|-------------|---------------------------------------------------------------------------------------------------------------|---------------| +| rac-format | RacFormat | C | 0..1 | Coding format in which UE Radio Access Capability Information needs to be provided. See the clause 6.1.6.3.4. | | +| supported-features | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. | | + +This method shall support the request data structures specified in table 6.1.3.2.3.1-2 and the response data structures and response codes specified in table 6.1.3.2.3.1-3. + +**Table 6.1.3.2.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.2.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| DicEntryData | M | 1 | 200 OK | The response body contains a dictionary entry for the given Dictionary Entry ID. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same UCMF or UCMF (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same UCMF or UCMF (service) set. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- NO_DICTIONARY_ENTRY_FOUND

See table 6.1.7.3-1 for the description of this error. | + +NOTE: The mandatory HTTP error status code for the GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +**Table 6.1.3.2.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same UCMF or UCMF (service) set.
Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.2.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same UCMF or UCMF (service) set.
Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +#### 6.1.3.4 Resource: Subscriptions collection + +##### 6.1.3.4.1 Description + +This resource represents a collection of subscriptions in the UCMF, created by NF service consumers of Nucmf\_UECapabilityManagement service. + +This resource is modelled as the Collection resource archetype (see clause C.2 of 3GPP TS 29.501 [5]). + +##### 6.1.3.4.2 Resource Definition + +Resource URI: {apiRoot}/nucmf-ucm//subscriptions + +This resource shall support the resource URI variables defined in table 6.1.3.4.2-1. + +**Table 6.1.3.4.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|-------------------| +| apiRoot | See clause 6.1.1 | +| apiVersion | See clause 6.1.1. | + +##### 6.1.3.4.3 Resource Standard Methods + +###### 6.1.3.4.3.1 POST + +This method shall support the URI query parameters specified in table 6.1.3.4.3.1-1. + +**Table 6.1.3.4.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.1.3.4.3.1-2 and the response data structures and response codes specified in table 6.1.3.4.3.1-3. + +**Table 6.1.3.4.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------|---|-------------|-----------------------------------------------------------------------| +| CreateSubscription | M | 1 | The Subscription to be created by a NF Service consumer, e.g. an AMF. | + +**Table 6.1.3.4.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|-------------|---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| CreatedSubscription | M | 1 | 201
Created | Represents successful creation of a Subscription in the UCMF | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same UCMF or UCMF (service) set. | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same UCMF or UCMF (service) set. | +| ProblemDetails | O | 0..1 | 400 Bad Request | The response body contains the error reason of the request message. | +| NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). | | | | | + +**Table 6.1.3.4.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same UCMF or UCMF (service) set.
Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.4.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same UCMF or UCMF (service) set.
Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +##### 6.1.3.4.4 Resource Custom Operations + +None. + +#### 6.1.3.5 Resource: Individual subscription + +##### 6.1.3.5.1 Description + +This resource represents an individual of subscription in the UCMF, created earlier by a NF Service Consumer of Nucmf\_UECapabilityManagement service. + +This resource is modelled as the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [5]). + +##### 6.1.3.5.2 Resource Definition + +Resource URI: {apiRoot}/nucmf-ucm//subscriptions/{subscriptionId} + +This resource shall support the resource URI variables defined in table 6.1.3.5.2-1. + +**Table 6.1.3.5.2-1: Resource URI variables for this resource** + +| Name | Definition | +|----------------|-----------------------------------------------------------| +| apiRoot | See clause 6.1.1 | +| apiVersion | See clause 6.1.1. | +| subscriptionId | String identifies an individual subscription in the UCMF. | + +##### 6.1.3.5.3 Resource Standard Methods + +###### 6.1.3.5.3.2 DELETE + +This method shall support the URI query parameters specified in table 6.1.3.5.3.2-1. + +**Table 6.1.3.5.3.2-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.1.3.5.3.2-2 and the response data structures and response codes specified in table 6.1.3.5.3.2-3. + +**Table 6.1.3.5.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.5.3.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same UCMF or UCMF (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same UCMF or UCMF (service) set. | +| ProblemDetails | O | 0..1 | 404 Not Found | Indicates the modification of subscription has failed due to application error.

The "cause" attribute may be used to indicate the following application error:
- SUBSCRIPTION NOT FOUND. | + +NOTE: The mandatory HTTP error status code for the DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +**Table 6.1.3.5.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same UCMF or UCMF (service) set.
Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.5.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same UCMF or UCMF (service) set.
Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +##### 6.1.3.5.4 Resource Custom Operations + +None. + +### 6.1.4 Custom Operations without associated resources + +None. + +### 6.1.5 Notifications + +#### 6.1.5.1 General + +Notifications shall comply to clause 6.2 of 3GPP TS 29.500 [4] and clause 4.6.2.3 of 3GPP TS 29.501 [5]. + +#### 6.1.5.2 UCMF Notification + +##### 6.1.5.2.1 Description + +The UCMF Notification is used by the UCMF to report one or several observed Events to a NF service consumer that has subscribed to such Notifications via the Individual Notification Subscription Resource. + +##### 6.1.5.2.2 Target URI + +The Callback URI "{ucmfNotificationUri}" shall be used with the callback URI variables defined in table 6.1.5.2.2-1. + +**Table 6.1.5.2.2-1: Callback URI variables for this resource** + +| Name | Definition | +|---------------------|----------------------------------------------------| +| ucmfNotificationUri | String formatted as URI with the UCMF Callback Uri | + +##### 6.1.5.2.3 Standard Methods + +###### 6.1.5.2.3.1 POST + +This method shall support the request data structures specified in table 6.1.5.2.3.1-1 and the response data structures and response codes specified in table 6.1.5.2.3.1-1. + +**Table 6.1.5.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|---------------------------------------------| +| UcmfNotification | M | 1 | Represents the notification to be delivered | + +**Table 6.1.5.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The NF service consumer shall generate a Location header field containing a URI pointing to the endpoint of the NF service consumer to which the notification should be sent. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The NF service consumer shall generate a Location header field containing a URI pointing to the endpoint of the NF service consumer to which the notification should be sent. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +**Table 6.1.5.2.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the notification is redirected | + +**Table 6.1.5.2.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the notification is redirected | + +### 6.1.6 Data Model + +#### 6.1.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.1.6.1-1 specifies the data types defined for the Nucmf\_UECapabilityManagement service based interface protocol. + +**Table 6.1.6.1-1: Nucmf\_UECapabilityManagement specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|---------------------|----------------|-------------|---------------| +| DicEntryData | 6.1.6.2.2 | | | +| DicEntryCreateData | 6.1.6.2.3 | | | +| DicEntryCreatedData | 6.1.6.2.4 | | | +| UeRadioCapId | 6.1.6.2.5 | | | +| CreateSubscription | 6.1.6.2.6 | | | +| CreatedSubscription | 6.1.6.2.7 | | | +| UcmfNotification | 6.1.6.2.8 | | | +| ManAssOpRequestList | 6.1.6.2.9 | | | +| EventType | 6.1.6.3.3 | | | +| RacFormat | 6.1.6.3.4 | | | + +Table 6.1.6.1-2 specifies data types re-used by the Nucmf\_UECapabilityManagement service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the N service based interface. + +**Table 6.1.6.1-2: Nucmf\_UECapabilityManagement re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|----------------------|---------------------|-------------------------------------------------|----------------------| +| PlmnAssiUeRadioCapId | 3GPP TS 29.571 [14] | | | +| ManAssiUeRadioCapId | 3GPP TS 29.571 [14] | | | +| TypeAllocationCode | 3GPP TS 29.571 [14] | | | +| NfInstanceId | 3GPP TS 29.571 [14] | | | +| DateTime | 3GPP TS 29.571 [14] | | | +| SupportedFeatures | 3GPP TS 29.571 [14] | Supported Features | | +| ProblemDetails | 3GPP TS 29.571 [14] | Detailed problems in failure case | | +| RedirectResponse | 3GPP TS 29.571 [14] | Response body of the redirect response message. | | + +#### 6.1.6.2 Structured data types + +##### 6.1.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.1.6.2.2 Type: DicEntryData + +Table 6.1.6.2.2-1: Definition of type DicEntryData + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| dicEntryId | DicEntryId | C | 0..1 | Identifier of the Dictionary Entry | +| plmnAssiUeRadioCapId | PlmnAssiUeRadioCapId | C | 0..1 | This IE shall include a PLMN Assigned UE Radio Capability ID if allocated in the dictionary entry. | +| manAssiUeRadioCapId | ManAssiUeRadioCapId | C | 0..1 | This IE shall include a Manufacturer Assigned UE Radio Capability ID if available in the dictionary entry. | +| typeAllocationCode | TypeAllocationCode | M | 1 | This IE shall contain the Type Allocation Code in corresponding to the UE Radio Access Capability in the dictionary entry. | +| ueRadioCapability5GS | RefToBinaryData | C | 0..1 | This IE shall be included to contain the UE Radio Access Capability Information encoded either as OCTET STRING of UE Radio Capability IE as specified in clause 9.3.1.74 of 3GPP TS 38.413 [15], when the message is sent to AMF, otherwise it may be included. | +| ueRadioCapabilityEPS | RefToBinaryData | C | 0..1 | This IE shall be included to contain the UE Radio Access Capability Information encoded as OCTET STRING of UE Radio Capability IE as specified in clause 9.2.1.27 of 3GPP TS 36.413 [x], when the message is sent to MME, otherwise it may be included. | +| ueRadioCap5GSForPaging | RefToBinaryData | O | 0..1 | May be present if ueRadioCapability5GS is present. If present it shall contain the UE Radio Access Capability Information for paging encoded as OCTET STRING of UE Radio Capability for Paging IE as specified in clause 9.3.1.68 of 3GPP TS 38.413 [15], when the message is sent to AMF | +| ueRadioCapEPSForPaging | RefToBinaryData | O | 0..1 | May be present if ueRadioCapabilityEPS is present. If present it shall contain the UE Radio Access Capability Information for paging encoded as OCTET STRING of UE Radio Capability for Paging IE as specified in clause 9.2.1.98 of 3GPP TS 36.413 [17], when the message is sent to MME, otherwise it may be included. | +| NOTE: The information in the dictionary entry which is included as the query parameter(s) or URI variable in the request message shall not be present. | | | | | + +##### 6.1.6.2.3 Type: DicEntryCreateData + +Table 6.1.6.2.3-1: Definition of type DicEntryCreateData + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------|--------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| typeAllocationCode | TypeAllocationCode | M | 1 | This IE shall contain the Type Allocation Code in corresponding to the UE Radio Access Capability in the dictionary entry. | +| ueRadioCapability5GS | RefToBinaryData | C | 0..1 | This IE shall be included to contain the UE Radio Access Capability Information encoded as OCTET STRING of UE Radio Capability IE specified in clause 9.3.1.74 of 3GPP TS 38.413 [15]. | +| ueRadioCapabilityEPS | RefToBinaryData | C | 0..1 | This IE shall be included to contain the UE Radio Access Capability Information encoded as OCTET STRING of UE Radio Capability IE specified in clause 9.2.1.27 of 3GPP TS 36.413 [17]. (NOTE) | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. | +| ueRadioCap5GSForPaging | RefToBinaryData | O | 0..1 | May be present if ueRadioCapability5GS is present. If present it shall contain the UE Radio Access Capability Information for paging encoded as OCTET STRING of UE Radio Capability for Paging IE as specified in clause 9.3.1.68 of 3GPP TS 38.413 [15]. | +| ueRadioCapEPSForPaging | RefToBinaryData | O | 0..1 | May be present if ueRadioCapabilityEPS is present. If present it shall contain the UE Radio Access Capability Information for paging encoded as OCTET STRING of UE Radio Capability for Paging IE as specified in clause 9.2.1.98 of 3GPP TS 36.413 [17]. | + +NOTE: At least one of ueRadioCapability5GS or ueRadioCapabilityEPS shall be present. + +##### 6.1.6.2.4 Type: DicEntryCreatedData + +Table 6.1.6.2.4-1: Definition of type DicEntryCreatedData + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------|----------------------|---|-------------|----------------------------------------------------------------------------| +| plmnAssiUeRadioCapId | PlmnAssiUeRadioCapId | M | 1 | This IE shall include a PLMN Assigned UE Radio Capability ID if allocated. | + +##### 6.1.6.2.5 Type: UeRadioCapId + +Table 6.1.6.2.5-1: Definition of type UeRadioCapId + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------|----------------------|---|-------------|------------------------------------------------------------------------------| +| plmnAssiUeRadioCapId | PlmnAssiUeRadioCapId | C | 0..1 | This IE shall include a PLMN Assigned UE Radio Capability ID. (NOTE) | +| manAssiUeRadioCapId | ManAssiUeRadioCapId | C | 0..1 | This IE shall include a Manufacturer Assigned UE Radio Capability ID. (NOTE) | + +NOTE: Only one of plmnAssiUeRadioCapId and manAssiUeRadioCapId shall be present during retrieving UE Radio Access Capability Information. (See clause 6.1.3.2.3.1) + +##### 6.1.6.2.6 Type: CreateSubscription + +Table 6.1.6.2.6-1: Definition of type CreateSubscription + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|-------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------| +| nflId | NflInstanceId | C | 0..1 | This IE shall contain the NF Instance ID of the service consumer, e.g. an AMF, if it is available. | +| ucmfNotificationUri | Uri | M | 1 | This IE shall contain the callback URI on which the subscribed events shall be notified. | +| suggestedExpires | DateTime | O | 0..1 | If present, indicates the point in time at which the subscription expires, which is suggested by the service consumer. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. | + +##### 6.1.6.2.7 Type: CreatedSubscription + +Table 6.1.6.2.7-1: Definition of type CreatedSubscription + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------| +| dicEntryId | DicEntryId | M | 1 | This IE shall contain the highest DicEntryId has been allocated in the UCMF. | +| confirmedExpires | DateTime | O | 0..1 | If present, indicates the point in time at which the subscription expires, which is confirmed by the service producer. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. | + +##### 6.2.6.2.8 Type: UcmfNotification + +Table 6.2.6.2.8-1: Definition of type UcmfNotification + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|---------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| dicEntryId | DicEntryId | M | 1 | This IE shall contain the highest DicEntryId has been allocated in the UCMF. | +| eventType | EventType | M | 1 | This IE shall contain the different events type included in the notification. | +| manAssOpRequestlist | ManAssOpRequestlist | C | 0..1 | This IE shall be present to contain the Manufacturer Assigned operation requested list which includes a list of PLMN Assigned UE Radio Capability IDs or a list of TACs if the event type indicates the deletion of one or more PLMN Assigned UE Radio Capability IDs as specified in 3GPP TS 23.501 [2]. | +| versionId | Uinteger | O | 0..1 | Uinteger with the range between 0 and 255.

This IE may be present if eventType indicates to notify a new version id of PLMN Assigned UE Radio Capability Id(s). | + +##### 6.2.6.2.9 Type: ManAssOpRequestList + +**Table 6.2.6.2.9-1: Definition of type DelPlmnAssiUeRadioCapIdData** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------|-----------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| plmnAssiUeRadioCapId | array(PlmnAssiUeRadioCapId) | C | 0..N | This IE shall contain one or more PLMN Assigned UE Radio Capability IDs to be deleted. (NOTE)

The UCMF shall always provide a complete list of PLMN Assigned UE Radio Capability IDs to enable the AMF to overwrite the existing list. | +| typeAllocationCode | array (TypeAllocationCode) | C | 0..N | This IE shall contain one or more Type Allocation Code in corresponding to the PLMN Assigned UE Radio Capability IDs to be deleted. (NOTE)

The UCMF shall always provide a complete list of Type Allocation Codes to enable the AMF to overwrite the existing list. | + +NOTE: Either plmnAssiUeRadioCapId or typeAllocationCode shall be present, not for both. + +#### 6.1.6.3 Simple data types and enumerations + +##### 6.1.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 6.1.6.3.2 Simple data types + +The simple data types defined in table 6.1.6.3.2-1 shall be supported. + +**Table 6.1.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|------------|-----------------|----------------------------------|---------------| +| DicEntryId | Integer | integer with range 1-4294967295. | | + +##### 6.1.6.3.3 Enumeration: EventType + +The enumeration EventType represents different type of events included in a notification from the UCMF. It shall comply with the provisions defined in table 6.1.5.3.3-1. + +**Table 6.1.6.3.3-1: Enumeration EventType** + +| Enumeration value | Description | Applicability | +|---------------------------------------|---------------------------------------------------------------------|---------------| +| "CREATION_OF_DICTIONARY_ENTRY" | New dictionary entries are created in the UCMF. | | +| "DELETION_OF_PLMN_ASSIGNED_IDS" | One or more PLMN-assigned UE Radio Capability IDs are deleted. | | +| "NEW_VERSION_ID_OF_PLMN_ASSIGNED_IDS" | Notify a new version id of PLMN Assigned UE Radio Capability Id(s). | | + +##### 6.1.6.3.4 Enumeration: RacFormat + +The enumeration RacFormat represents the encoding type of the UE's Radio Access Capability Information. + +**Table 6.1.6.3.4-1: Enumeration racFormat** + +| Enumeration value | Description | Applicability | +|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| "5GS" | This value indicates UE Radio Access Capability Information shall be encoded as OCTET STRING of UE Radio Capability IE specified in clause 9.3.1.74 of 3GPP TS 38.413 [15]. | | +| "EPS" | This value indicates UE Radio Access Capability Information shall be encoded as OCTET STRING of UE Radio Capability IE specified in clause 9.2.1.27 of 3GPP TS 36.413 [17]. | | + +#### 6.1.6.4 Data types describing alternative data types or combinations of data types + +None. + +#### 6.1.6.5 Binary data + +##### 6.1.6.5.1 Introduction + +This clause defines the binary data that shall be supported in a binary body part in an HTTP multipart message (see clauses 6.1.2.2.2 and 6.1.2.4). + +##### 6.1.6.5.2 UE Radio Capability Information + +UeRadioCapability5GS shall be encoded with the OCTET STRING of UE Radio Capability IE (i.e. excluding the IEI, Criticality and octet string length indicator, see also Annex B of 3GPP TS 29.274 [16]) as specified in clause 9.3.1.74 of 3GPP TS 38.413 [15], using the vnd.3gpp.ngap content-type. + +UeRadioCapabilityEPS shall be encoded with the OCTET STRING of UE Radio Capability IE (i.e. excluding the IEI, Criticality and octet string length indicator, see also Annex B of 3GPP TS 29.274 [16]) as specified in clause 9.2.1.27 of 3GPP TS 36.413 [17], using the vnd.3gpp.slap content-type. + +ueRadioCap5GSForPaging shall be encoded as OCTET STRING of UE Radio Capability for Paging IE as specified in clause 9.3.1.68 of 3GPP TS 38.413 [15]. + +ueRadioCapEPSForPaging shall be encoded as OCTET STRING of UE Radio Capability for Paging IE as specified in clause 9.2.1.98 of 3GPP TS 36.413 [17]. + +### 6.1.7 Error Handling + +#### 6.1.7.1 General + +For the Nucmf\_UECapabilityManagement API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [4] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [4]. + +In addition, the requirements in the following clauses are applicable for the Nucmf\_UECapabilityManagement API. + +#### 6.1.7.2 Protocol Errors + +No specific procedures for the Nucmf\_UECapabilityManagement service are specified. + +#### 6.1.7.3 Application Errors + +The application errors defined for the Nucmf\_UECapabilityManagement service are listed in Table 6.1.7.3-1. + +**Table 6.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|--------------------------------|------------------|------------------------------------------------------------------------------------| +| NO_DICTIONARY_ENTRY_FOUND | 404 | There is no dictionary entry matching the UE Radio Capability ID in query. | +| OUT_DATED_VERSION_ID_IN_RAC_ID | 404 | The version id in the requested PLMN Assigned UE Radio Capability Id is out-dated. | + +### 6.1.8 Feature negotiation + +The optional features in table 6.1.8-1 are defined for the Nucmf\_UECapabilityManagement API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.1.8-1: Supported Features** + +| Feature number | Feature Name | M/O | Description | +|----------------|--------------|-----|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | ES3XX | M | Extended Support of HTTP 307/308 redirection

An NF Service Consumer (e.g. AMF) that supports this feature shall support handling of HTTP 307/308 redirection for any service operation of the UECapabilityManagement service. An NF Service Consumer that does not support this feature does only support HTTP redirection as specified for 3GPP Release 15. | + +### 6.1.9 Security + +As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Nucmf\_UECapabilityManagement API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [9]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [10]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nucmf\_UECapabilityManagement API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [10], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nucmf\_UECapabilityManagement service. + +The Nucmf\_UECapabilityManagement API defines a single scope "nucmf\_uecapabilitymanagement" for the entire service, and it does not define any additional scopes at resource or operation level. + +### 6.1.10 HTTP redirection + +An HTTP request may be redirected to a different UCMF service instance, within the same UCMF or a different UCMF of an UCMF set, e.g. when an UCMF service instance is part of an UCMF (service) set or when using indirect communications (see 3GPP TS 29.500 [4]). See also the ES3XX feature in clause 6.1.8. + +An SCP that reselects a different UCMF producer instance will return the NF Instance ID of the new UCMF producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an UCMF within an UCMF set redirects a service request to a different UCMF of the set using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new UCMF towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +# Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex specifies the formal definition of the API(s) defined in the present specification. It consists of OpenAPI 3.0.0 specifications in YAML format. + +This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository, that uses the GitLab software version control system (see 3GPP TS 29.501 [5] clause 5.3.1 and 3GPP TR 21.900 [7] clause 5B). + +## A.2 Nucmf\_UECapabilityManagement API + +``` +openapi: 3.0.0 + +info: + title: Nucmf_UECapabilityManagement + version: 1.0.6 + description: | + Nucmf_UECapabilityManagement Service. + © 2021, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.673 V16.7.0; 5G System; UE Radio Capability Management Services + url: http://www.3gpp.org/ftp/Specs/archive/29_series/29.673/ + +servers: + - url: '{apiRoot}/nucmf-uecm/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - nucmf-uecm + +paths: + /dic-entries: + get: + summary: retrieve a dictionary entry matching query parameters + operationId: RetrieveDictionaryEntry + tags: + - Dictionary Entry (Store) + parameters: + - name: ue-radio-capa-id + in: query + required: true + description: UE Radio Capability ID, either PLMN Assigned or Manufacturer Assigned + schema: + $ref: '#/components/schemas/UeRadioCapaId' + - name: rac-format + in: query + description: Encoding format of RAC Info + schema: + $ref: '#/components/schemas/RacFormat' + - name: supported-features +``` + +``` + +in: query +description: supported features of the NF consumer +schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: + '200': + description: Expected response to a valid request + content: + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/DicEntryData' + binaryDataUeRadioCapability5GS: + type: string + format: binary + binaryDataUeRadioCapabilityEPS: + type: string + format: binary + binaryDataUeRadioCap5GSForPaging: + type: string + format: binary + binaryDataUeRadioCapEPSForPaging: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataUeRadioCapability5GS: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataUeRadioCapabilityEPS: + contentType: application/vnd.3gpp.slap + headers: + Content-Id: + schema: + type: string + binaryDataUeRadioCap5GSForPaging: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataUeRadioCapEPSForPaging: + contentType: application/vnd.3gpp.slap + headers: + Content-Id: + schema: + type: string + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +post: + summary: Create a dictionary entry in the UCMF + tags: + - a dictionary entry (Document) + operationId: CreateDictionaryEntry + requestBody: + content: + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/DicEntryCreateData' + binaryDataUeRadioCapability5GS: + type: string + format: binary + binaryDataUeRadioCapabilityEPS: + type: string + format: binary + binaryDataUeRadioCap5GSForPaging: + type: string + format: binary + binaryDataUeRadioCapEPSForPaging: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataUeRadioCapability5GS: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataUeRadioCapabilityEPS: + contentType: application/vnd.3gpp.slap + headers: + Content-Id: + schema: + type: string + binaryDataUeRadioCap5GSForPaging: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataUeRadioCapEPSForPaging: + contentType: application/vnd.3gpp.slap + headers: + Content-Id: + schema: + type: string + responses: + '201': + description: Dictionary Created + headers: + Location: + description: 'Contains the URI of the newly created resource, according to the +structure: {apiRoot}/nucmf-uecm//dic-entries/{dicEntryId}' + required: true + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/DicEntryCreatedData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + +``` + +``` + + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/dic-entries/{dicEntryId}: + get: + summary: Get an individual dictionary entry via dicEntryId + operationId: GetDicEntry + tags: + - dic Entry Id (Document) + parameters: + - name: dicEntryId + in: path + description: the ID of a dictionary entry in the UCMF + required: true + schema: + $ref: '#/components/schemas/DicEntryId' + - name: rac-format + in: query + description: Encoding format of of RAC Info + schema: + $ref: '#/components/schemas/RacFormat' + - name: supported-features + in: query + description: supported features of the NF consumer + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Expected response to a valid request + content: + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/DicEntryData' + binaryDataUeRadioCapability5GS: + type: string + format: binary + binaryDataUeRadioCapabilityEPS: + type: string + format: binary + binaryDataUeRadioCap5GSForPaging: + type: string + format: binary + binaryDataUeRadioCapEPSForPaging: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataUeRadioCapability5GS: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataUeRadioCapabilityEPS: + contentType: application/vnd.3gpp.slap + headers: + Content-Id: + schema: + +``` + +``` + + type: string + binaryDataUeRadioCap5GSForPaging: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataUeRadioCapEPSForPaging: + contentType: application/vnd.3gpp.slap + headers: + Content-Id: + schema: + type: string + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscriptions: + post: + summary: Nucmf_UECapabilityManagement Subscribe service Operation + operationId: CreateIndividualSubscription + tags: + - Subscriptions (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/CreateSubscription' + responses: + '201': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/CreatedSubscription' + headers: + Location: + description: 'Contains the URI of the newly created resource, according to the +structure: {apiRoot}/nucmf-uecm//subscriptions/{subscriptionId}' + required: true + schema: + type: string + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + callbacks: + myNotification: + '{ $request.body#/ucmfNotificationUri }': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UcmfNotification' + responses: + '204': + description: No Content, Notification was successful + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscriptions/{subscriptionId}: + delete: + summary: unsubscribe from notifications + operationId: DeleteIndividualSubscription + tags: + - IndividualSubscription (Document) + parameters: + - name: subscriptionId + in: path + description: Event Subscription ID + required: true + schema: + type: string + responses: + '204': + description: No Content. Resource was successfully deleted + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nucmf-uecm: Access to the Nucmf_UECapabilityManagement API + +schemas: + DicEntryData: + type: object + required: + - typeAllocationCode + properties: + dicEntryId: + $ref: '#/components/schemas/DicEntryId' + typeAllocationCode: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TypeAllocationCode' + plmnAssiUeRadioCapId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnAssiUeRadioCapId' + manAssiUeRadioCapId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ManAssiUeRadioCapId' + ueRadioCapability5GS: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + ueRadioCapabilityEPS: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + ueRadioCap5GSForPaging: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + ueRadioCapEPSForPaging: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + + DicEntryCreateData: + type: object + required: + - typeAllocationCode + properties: + typeAllocationCode: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TypeAllocationCode' + ueRadioCapability5GS: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + ueRadioCapabilityEPS: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + ueRadioCap5GSForPaging: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + ueRadioCapEPSForPaging: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + + DicEntryCreatedData: + type: object + required: + - plmnAssiUeRadioCapId + properties: + plmnAssiUeRadioCapId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnAssiUeRadioCapId' + +``` + +``` + +UeRadioCapId: + type: object + properties: + plmnAssiUeRadioCapId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnAssiUeRadioCapId' + manAssiUeRadioCapId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ManAssiUeRadioCapId' + +CreateSubscription: + type: object + required: + - ucmfNotificationUri + properties: + nfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + ucmfNotificationUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + suggestedExpires: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +CreatedSubscription: + type: object + required: + - dicEntryId + properties: + dicEntryId: + $ref: '#/components/schemas/DicEntryId' + confirmedExpires: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +UcmfNotification: + type: object + required: + - dicEntryId + - eventType + properties: + dicEntryId: + $ref: '#/components/schemas/DicEntryId' + eventType: + $ref: '#/components/schemas/EventType' + manAssOpRequestList: + $ref: '#/components/schemas/manAssOpRequestList' + minItems: 1 + versionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + +manAssOpRequestList: + type: object + oneOf: + - required: [plmnAssiUeRadioCapId] + - required: [typeAllocationCod] + properties: + plmnAssiUeRadioCapId: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnAssiUeRadioCapId' + minItems: 1 + typeAllocationCode: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TypeAllocationCode' + +# +# SIMPLE DATA TYPES +# +DicEntryId: + type: integer + minimum: 0 + maximum: 4294967295 + +# + +``` + +``` +# ENUMERATIONS +``` + +``` +# +``` + +``` +EventType: +``` + +``` +anyOf: +``` + +``` +- type: string +``` + +``` +enum: +``` + +``` +- CREATION_OF_DICTIONARY_ENTRY +``` + +``` +- DELETION_OF_PLMN_ASSIGNED_IDS +``` + +``` +- NEW_VERSION_ID_OF_PLMN_ASSIGNED_IDS +``` + +``` +- type: string +``` + +``` +RacFormat: +``` + +``` +anyOf: +``` + +``` +- type: string +``` + +``` +enum: +``` + +``` +- 5GS +``` + +``` +- EPS +``` + +``` +- type: string +``` + +# Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|--------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2019-09 | CT4#93 | C4-193849 | | | | Initial draft | 0.1.0 | +| 2019-10 | CT4#94 | C4-194356 | | | | Subscribe, Unsubscribe and Notify | 0.2.0 | +| 2019-10 | CT4#94 | C4-194357 | | | | Individual dictionary entry resource | 0.2.0 | +| 2019-11 | CT4#95 | C4-195436 | | | | Data type and openAPI related to Resolve, Assign | 0.3.0 | +| 2019-11 | CT4#95 | C4-195438 | | | | Data type and openAPI related to (un)Subscribe/Notify | 0.3.0 | +| 2019-12 | CT#86 | CP-193069 | | | | TS presented for information | 1.0.0 | +| 2020-03 | CT4#96e | C4-200622 | | | | UcmfNotification for deletion | 1.1.0 | +| 2020-03 | CT4#96e | C4-200623 | | | | Other alignment with stage 2 requirements | 1.1.0 | +| 2020-03 | CT#87e | CP-200067 | | | | TS presented for approval | 2.0.0 | +| 2020-03 | CT#87e | | | | | Approved at CT#87e | 16.0.0 | +| 2020-06 | CT#88e | CP-201279 | 0001 | 2 | B | Multiple RAC Coding Format Support in RACS Operation | 16.1.0 | +| 2020-06 | CT#88e | CP-201035 | 0003 | | F | Storage of YAML files in ETSI Forge | 16.1.0 | +| 2020-06 | CT#88e | CP-201035 | 0004 | | B | New application error at receiving out-dated UE RAC-ID | 16.1.0 | +| 2020-06 | CT#88e | CP-201035 | 0005 | 1 | B | Populating New Version Id via Notification | 16.1.0 | +| 2020-06 | CT#88e | CP-201187 | 0006 | | F | 3GPP TS 29.673 API version update Rel-16 | 16.1.0 | +| 2020-09 | CT#89e | CP-202108 | 0007 | | F | DicEntryId in DicEntryData | 16.2.0 | +| 2020-09 | CT#89e | CP-202108 | 0008 | | F | UE Radio Capability ID retrieval | 16.2.0 | +| 2020-09 | CT#89e | CP-202108 | 0009 | | F | Optionality of ProblemDetails in TS29.673 cleanup | 16.2.0 | +| 2020-09 | CT#89e | CP-202096 | 0010 | | F | 29.673 Rel-16 API version and External doc update | 16.2.0 | +| 2020-12 | CT#90e | CP-203047 | 0011 | 1 | F | TAC is mandatory in DicEntryData | 16.3.0 | +| 2020-12 | CT#90e | CP-203036 | 0012 | | | 29.673 Rel-16 API version and External doc update | 16.3.0 | +| 2021-03 | CT#91e | CP-210043 | 0014 | | F | Storage of YAML files | 16.4.0 | +| 2021-03 | CT#91e | CP-210037 | 0015 | 1 | F | HTTP 3xx redirection | 16.4.0 | +| 2021-03 | CT#91e | CP-210054 | 0018 | | F | 29.673 Rel-16 API version and External doc update | 16.4.0 | +| 2021-06 | CT#92e | CP-211059 | 0022 | | F | Redirect Response for Nucmf_UECapabilityManagement | 16.5.0 | +| 2021-06 | CT#92e | CP-211073 | 0025 | | F | 29.673 Rel-16 API version and External doc update | 16.5.0 | +| 2021-09 | CT#93e | CP-212065 | 0026 | 1 | F | Handling of UE Radio Capability for Paging | 16.6.0 | +| 2021-09 | CT#93e | CP-212060 | 0028 | | F | 3xx description correction for SCP | 16.6.0 | +| 2021-09 | CT#93e | CP-212080 | 0031 | | F | 29.673 Rel-16 API version and External doc update | 16.6.0 | +| 2021-12 | CT#93e | CP-213130 | 0032 | 1 | F | Binary Information for UE Radio Capability for Paging | 16.7.0 | +| 2021-12 | CT#93e | CP-213146 | 0036 | | F | 29.673 Rel-16 API version and External doc update | 16.7.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29674/24c9e038a791677ed33100667b64f7e6_img.jpg b/marked/Rel-16/29_series/29674/24c9e038a791677ed33100667b64f7e6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e8283a03c8f317a33737d89a92f3e2d1715f0e4f --- /dev/null +++ b/marked/Rel-16/29_series/29674/24c9e038a791677ed33100667b64f7e6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:762f6860c8bb390665b3430550d5dab16d95e414879de249197d0d49dda9cc6d +size 19793 diff --git a/marked/Rel-16/29_series/29674/4ba34b7c8f0b8799dc89462e0c71c52c_img.jpg b/marked/Rel-16/29_series/29674/4ba34b7c8f0b8799dc89462e0c71c52c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ed895a4f9d9fbe1a034d77b9f891200792f519eb --- /dev/null +++ b/marked/Rel-16/29_series/29674/4ba34b7c8f0b8799dc89462e0c71c52c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2422104e0fd31b7050be20e1746d0051c7b70bee2a1729c78abb86d31432d381 +size 39089 diff --git a/marked/Rel-16/29_series/29674/55136bc716146672fc680fa05989f1d2_img.jpg b/marked/Rel-16/29_series/29674/55136bc716146672fc680fa05989f1d2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..aa24a083403b742e9e0ce2250740fe6bea39160e --- /dev/null +++ b/marked/Rel-16/29_series/29674/55136bc716146672fc680fa05989f1d2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c4bbeb32959e7f245d9d31827800fac158ae5839abe58016b936c7931d124a88 +size 23151 diff --git a/marked/Rel-16/29_series/29674/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-16/29_series/29674/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..60b35b9c336bb4f4448f8902f3b92257a19533ae --- /dev/null +++ b/marked/Rel-16/29_series/29674/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e0c1b590f9462b7608eda0e26d72d36111bbb4bb36fbf70d15387f87cd45d82a +size 8213 diff --git a/marked/Rel-16/29_series/29674/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-16/29_series/29674/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..912079992e81a1cb18ee5b4a2991a97503c4345e --- /dev/null +++ b/marked/Rel-16/29_series/29674/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2e5f2e816a8c301424e4e27ca9239aaefdf87c8fd816656ad70c07e7fed97ee7 +size 5804 diff --git a/marked/Rel-16/29_series/29674/7728e2dd44c95d109debb1eb59e9b411_img.jpg b/marked/Rel-16/29_series/29674/7728e2dd44c95d109debb1eb59e9b411_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a3d035bb7c562df8c8a3fd54384a69ee0e635248 --- /dev/null +++ b/marked/Rel-16/29_series/29674/7728e2dd44c95d109debb1eb59e9b411_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1be7731709cd323370c9c36a64c586911e7e4847d86af6f872e335f1a57cc891 +size 31277 diff --git a/marked/Rel-16/29_series/29674/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg b/marked/Rel-16/29_series/29674/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..73250335b99c993419d4e77a7134cca7da78d258 --- /dev/null +++ b/marked/Rel-16/29_series/29674/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d80e58fe0850254eb2ae21b252e19d6807b304481d6a2a6525f4f368a43bdd5e +size 21582 diff --git a/marked/Rel-16/29_series/29674/ae53f90bb87d6d09e2d6b5278d7c338f_img.jpg b/marked/Rel-16/29_series/29674/ae53f90bb87d6d09e2d6b5278d7c338f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3f0bcfccf39618c8190bac3e36d0eb448259baac --- /dev/null +++ b/marked/Rel-16/29_series/29674/ae53f90bb87d6d09e2d6b5278d7c338f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:aa39612c4b7069dd39b8d459359e055defc7f7200582d5a0272e5db842ffccec +size 26965 diff --git a/marked/Rel-16/29_series/29674/cad89c017c9e7c1785bcd104fde4e737_img.jpg b/marked/Rel-16/29_series/29674/cad89c017c9e7c1785bcd104fde4e737_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3babb644e00379c571182699f371df72c64f32c0 --- /dev/null +++ b/marked/Rel-16/29_series/29674/cad89c017c9e7c1785bcd104fde4e737_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8cf70a6bde2a75fb01a50b8d00de72b57c9b582b9ef0ba78294e94ad501a43ca +size 19921 diff --git a/marked/Rel-16/29_series/29674/d48a71a2e72db63c807a4c4ea8d82d2e_img.jpg b/marked/Rel-16/29_series/29674/d48a71a2e72db63c807a4c4ea8d82d2e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6606593021e913f008d096382aa36dbe97ba2889 --- /dev/null +++ b/marked/Rel-16/29_series/29674/d48a71a2e72db63c807a4c4ea8d82d2e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2bdc9c34fccd3306c2c80b736c7903e1e64b81f0fa096256560cb8456fc50e3a +size 19436 diff --git a/marked/Rel-16/29_series/29674/f6e8acf9f931452d01688d311b5c0364_img.jpg b/marked/Rel-16/29_series/29674/f6e8acf9f931452d01688d311b5c0364_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a2a054ce23e31773fa6c2c9c0454f505bb357628 --- /dev/null +++ b/marked/Rel-16/29_series/29674/f6e8acf9f931452d01688d311b5c0364_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:69183203c2114ecae957db261ce31220562c846ba8f7d2f38108a8de141614c4 +size 43853 diff --git a/marked/Rel-16/29_series/29674/raw.md b/marked/Rel-16/29_series/29674/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..eaaced25022f8f8df86574ff0de14db2ee7584bf --- /dev/null +++ b/marked/Rel-16/29_series/29674/raw.md @@ -0,0 +1,1258 @@ + + +# 3GPP TS 29.674 V16.3.0 (2021-09) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Interface between the UE radio Capability Management Function (UCMF) and the Mobility Management Entity (MME); Stage 3 (Release 16)** + +![5G logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The 5G logo, consisting of the text "5G" in a bold, black, sans-serif font. Above the "5G" text is a green graphic element consisting of three curved lines of increasing height, resembling a signal strength indicator or a stylized wave. + +5G logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, featuring the letters "3GPP" in a bold, black, stylized font. The "3" and "G" are connected at the top by a single horizontal line. Below the "P" is a red graphic element consisting of three curved lines of increasing height, resembling a signal strength indicator or a stylized wave. To the right of the "P" is a small "TM" symbol. + +3GPP logo + +A GLOBAL INITIATIVE + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2021, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTSTM is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|--------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions of terms, symbols and abbreviations..... | 7 | +| 3.1 Terms..... | 7 | +| 3.2 Symbols..... | 7 | +| 3.3 Abbreviations ..... | 7 | +| 4 Protocol Stack ..... | 7 | +| 4.1 Introduction ..... | 7 | +| 4.2 UDP Header and Port Numbers ..... | 8 | +| 4.2.1 General ..... | 8 | +| 4.2.2 Request Message ..... | 8 | +| 4.2.3 Response Message..... | 8 | +| 4.3 IP Header and IP Addresses..... | 8 | +| 4.3.1 General ..... | 8 | +| 4.3.2 Request Message ..... | 8 | +| 4.3.3 Response Message..... | 8 | +| 5 General description ..... | 8 | +| 5.1 Introduction ..... | 8 | +| 6 Procedures..... | 9 | +| 6.1 Introduction ..... | 9 | +| 6.2 Node Related Procedures ..... | 9 | +| 6.2.1 General ..... | 9 | +| 6.2.2 Heartbeat Procedure ..... | 9 | +| 6.2.2.1 General..... | 9 | +| 6.2.2.2 Heartbeat Request..... | 9 | +| 6.2.2.3 Heartbeat Response..... | 9 | +| 6.2.3 Subscription Management Procedure..... | 9 | +| 6.2.3.1 General..... | 9 | +| 6.2.3.2 Procedures in the MME..... | 9 | +| 6.2.3.3 Procedures in the UCMF ..... | 10 | +| 6.2.4 Event Notification Procedure ..... | 10 | +| 6.2.4.1 General..... | 10 | +| 6.2.4.2 Procedures in the UCMF ..... | 10 | +| 6.2.4.3 Procedures in the MME..... | 10 | +| 6.3 Session Related Procedures..... | 11 | +| 6.3.1 General ..... | 11 | +| 6.3.2 Create Dictionary Entry Procedure..... | 11 | +| 6.3.2.1 General..... | 11 | +| 6.3.2.2 Procedures in the MME..... | 11 | +| 6.3.2.3 Procedures in the UCMF ..... | 11 | +| 6.3.3 Query Dictionary Entry Procedure ..... | 12 | +| 6.3.3.1 General..... | 12 | +| 6.3.3.2 Procedures in the MME..... | 12 | +| 6.3.3.3 Procedures in the UCMF ..... | 12 | +| 6.4 Reliable Delivery of URCMP Messages..... | 13 | +| 7 Messages and Message Formats ..... | 13 | +| 7.1 Introduction ..... | 13 | +| 7.2 Transmission Order and Bit Definitions ..... | 13 | +| 7.3 Message Format ..... | 13 | +| 7.3.1 General ..... | 13 | +| 7.3.2 Message Header..... | 14 | +| 7.3.3 Usage of the URCMP Header..... | 14 | + +| | | | +|-------------------------------|----------------------------------------------------|-----------| +| 7.3.4 | Information Elements ..... | 14 | +| 7.3.4.1 | General..... | 14 | +| 7.3.4.2 | Presence Requirements of Information Elements..... | 15 | +| 7.3.4.3 | Grouped Information Elements ..... | 16 | +| 7.2.3.4 | Information Element Type..... | 16 | +| 7.4 | Message Types..... | 16 | +| 7.5 | S17-AP Messages..... | 17 | +| 7.5.1 | URCMP Node Related Messages..... | 17 | +| 7.5.1.1 | General..... | 17 | +| 7.5.1.2 | Heartbeat Request..... | 17 | +| 7.5.1.3 | Heartbeat Response..... | 17 | +| 7.5.1.4 | Subscription Management Request ..... | 17 | +| 7.5.1.5 | Subscription Management Response ..... | 17 | +| 7.5.1.6 | Event Notification Request..... | 18 | +| 7.5.1.7 | Event Notification Response ..... | 19 | +| 7.5.2 | URCMP Session Related Messages ..... | 19 | +| 7.5.2.1 | General..... | 19 | +| 7.5.2.2 | Create Dictionary Entry Request ..... | 19 | +| 7.5.2.3 | Create Dictionary Entry Response..... | 19 | +| 7.5.2.4 | Query Dictionary Entry Request..... | 20 | +| 7.5.2.5 | Query Dictionary Entry Response ..... | 20 | +| 7.6 | Error Handling..... | 21 | +| 7.6.1 | Protocol Errors..... | 21 | +| 7.6.2 | URCMP Message of Invalid Length ..... | 21 | +| 7.6.4 | Unknown URCMP Message ..... | 21 | +| 7.6.5 | Unexpected URCMP Message ..... | 21 | +| 7.6.6 | Missing Information Elements ..... | 21 | +| 7.6.7 | Semantically incorrect Information Element..... | 22 | +| 7.6.8 | Unknown or unexpected Information Element ..... | 22 | +| 7.6.9 | Repeated Information Elements ..... | 22 | +| 8 | Information elements ..... | 23 | +| 8.1 | Information Elements Format ..... | 23 | +| 8.2 | Information Elements Types ..... | 24 | +| 8.2.0 | General ..... | 24 | +| 8.2.1 | Cause ..... | 25 | +| 8.2.2 | Type Allocation Code..... | 26 | +| 8.2.3 | PLMN Assigned UE Radio Capability ID ..... | 27 | +| 8.2.4 | Manufacturer Assigned UE Radio Capability ID..... | 27 | +| 8.2.5 | Dictionary Entry ID ..... | 27 | +| 8.2.6 | UE Radio Access Capability Information ..... | 28 | +| 8.2.7 | Subscription Management Operation Type..... | 29 | +| 8.2.8 | MME Address Information ..... | 29 | +| 8.2.9 | Subscription ID..... | 30 | +| 8.2.10 | Event Type..... | 30 | +| 8.2.11 | Recovery Time Stamp ..... | 30 | +| 8.2.12 | Version ID ..... | 31 | +| Annex A (informative): | Change history..... | 31 | + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document specifies the UE Radio Capability Management Protocol used on the interface between the MME and UCMF as specified in 3GPP TS 23.401 [2]. In the related stage 2 specifications the prefix S17 is used for these common procedures realised by URCMP. + +NOTE: As an alternative of URCMP, the MME could use SBI interface to access UCMF Services. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.401: "General Packet Radio Service (GPRS) enhancements for Evolved Universal Terrestrial Radio Access Network (E-UTRAN) access". +- [3] IETF RFC 768: "User Datagram Protocol". +- [4] IETF RFC 791: "INTERNET PROTOCOL". +- [5] IETF RFC 8200: "Internet Protocol, Version 6 (Ipv6) Specification". +- [6] 3GPP TS 23.003: "Numbering, addressing and identification". +- [7] 3GPP TS 24.301: "Non-Access-Stratum (NAS) protocol for Evolved Packet System (EPS); Stage 3". +- [8] 3GPP TS 36.413: "Evolved Universal Terrestrial Radio Access Network (E-UTRAN); S1 Application Protocol (S1AP)". +- [9] 3GPP TS 29.274: "3GPP Evolved Packet System (EPS); Evolved General Packet Radio Service (GPRS) Tunnelling Protocol for Control plane (GTPv2-C); Stage 3". +- [10] IETF RFC 5905: "Network Time Protocol Version 4: Protocol and Algorithms Specification". +- [11] 3GPP TS 38.413: "NG Radio Access Network (NG-RAN); NG Application Protocol (NGAP)". + +# 3 Definitions of terms, symbols and abbreviations + +## 3.1 Terms + +void + +## 3.2 Symbols + +void + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|-------|-----------------------------------------| +| MME | Mobility Management Entity | +| URCMP | UE Radio Capability Management Protocol | +| UCMF | UE radio Capability Management Function | + +# 4 Protocol Stack + +## 4.1 Introduction + +The protocol stack for the control plane over the S17 reference points shall be as depicted in Figure 4.1-1. Clauses 4.2 and 4.3 further specify the related UDP and IP requirements. + +![Diagram of Control Plane stack over S17 reference point showing layers URCMP, UDP, IP, L2, and L1 for both MME and UCMF.](4ba34b7c8f0b8799dc89462e0c71c52c_img.jpg) + +The diagram illustrates the control plane protocol stack over the S17 reference point. It is divided into two main sections by a vertical dashed line representing the S17 reference point. On the left side, labeled 'MME', there is a stack of five protocol layers: URCMP (top), UDP, IP, L2, and L1 (bottom). On the right side, labeled 'UCMF', there is an identical stack of five protocol layers: URCMP (top), UDP, IP, L2, and L1 (bottom). Horizontal lines connect the layers between the MME and UCMF at each level, indicating bidirectional communication. The entire diagram is enclosed in a rectangular box, with the label 'S17 reference point' centered at the bottom. + +Diagram of Control Plane stack over S17 reference point showing layers URCMP, UDP, IP, L2, and L1 for both MME and UCMF. + +Figure 4.1-1: Control Plane stack over S17 + +## 4.2 UDP Header and Port Numbers + +### 4.2.1 General + +A User Datagram Protocol (UDP) compliant with IETF RFC 768 [3] shall be used. + +### 4.2.2 Request Message + +The UDP Destination Port number for a Request message shall be the one and only one configured by the operator for a given PLMN, e.g. in the range of 49152 to 65535. + +The UDP Source Port for a Request message is a locally allocated port number at the sending entity. + +NOTE: The locally allocated source port number can be reused for multiple Request messages. + +### 4.2.3 Response Message + +The UDP Destination Port value of a Response message shall be the value of the UDP Source Port of the corresponding Request message. + +The UDP Source Port of a Response message shall be the value from the UDP Destination Port of the corresponding message. + +## 4.3 IP Header and IP Addresses + +### 4.3.1 General + +In this clause, "IP" refers either to Ipv4 as defined by IETF RFC 791 [4] or Ipv6 as defined by IETF RFC 8200 [5]. A URCMP entity shall support both Ipv4 and Ipv6. + +### 4.3.2 Request Message + +The IP Destination Address of a Request message shall be an IP address of the peer entity. + +The IP Source Address of a Request message shall be an IP address of the sending entity. + +### 4.3.3 Response Message + +The IP Destination Address of a Response message shall be copied from the IP Source Address of the corresponding Request message. + +The IP Source Address of a Response message shall be copied from the IP destination address of the corresponding Request message. + +# --- 5 General description + +## 5.1 Introduction + +This document describes the procedures, messages and information elements over the S17 reference point between the MME and the UCMF to support UE Radio Capability Signalling optimization as specified in clause 5.11.3A of 3GPP TS 23.401 [2]. + +The UE Radio Capability Management Protocol (URCMP) is used over S17 reference point. + +# 6 Procedures + +## 6.1 Introduction + +The following clauses specify the procedures supported over the S17 reference points. + +## 6.2 Node Related Procedures + +### 6.2.1 General + +The following clauses specify the node related procedures over the S17 reference points. + +### 6.2.2 Heartbeat Procedure + +#### 6.2.2.1 General + +Two messages are specified for URCMP heartbeat procedure: Heartbeat Request and Heartbeat Response. The use of these messages is further specified in clause 19B of 3GPP TS 23.007 [3] for EPC. + +#### 6.2.2.2 Heartbeat Request + +The MME or UCMF may send a Heartbeat Request on a path to the peer node to find out if it is alive. Heartbeat Request messages may be sent for each peer which is known by the sender, e.g. based on the configuration. + +An MME or a UCMF shall be prepared to receive a Heartbeat Request at any time and it shall reply with a Heartbeat Response message. + +#### 6.2.2.3 Heartbeat Response + +The message shall be sent as a response to a received Heartbeat Request message. + +### 6.2.3 Subscription Management Procedure + +#### 6.2.3.1 General + +The URCMP Subscription Management Procedure shall be used to create or delete a subscription in the UCMF, where the subscription is to get notifications for one or more new dictionary entries creation or for the deletion of one or more PLMN Assigned UE Radio Capability IDs. + +#### 6.2.3.2 Procedures in the MME + +To create or delete a subscription in the UCMF which is used to receive notifications afterwards, the MME shall initiate the Subscription Management Procedure by sending a Subscription Management Request message towards the UCMF including: + +- a "Subscription Management Operation Type" IE, which is set to either "Creation" or "Deletion"; +- the MME Address Information IE which is used to receive subsequent notifications from the UCMF if the operation type is set to "Creation". The MME address information includes an IP address; +- the Subscription ID which is used to address a subscription in the UCMF if the operation code is set to "Deletion"; + +The MME shall create only one subscription in the UCMF. + +When the MME receives the Subscription Management Response message with a successful cause for a subscription creation request, the MME function shall be prepared to receive subsequent notifications at the provided MME address. + +#### 6.2.3.3 Procedures in the UCMF + +When the UCMF receives a Subscription Management Request message, it shall reply with a Subscription Management Response message. + +On success: + +- If the operation code is set to "Creation", the UCMF shall create a new subscription together with the MME address and the timestamp of the request to create the subscription, and include the following information in the Subscription Management Response message; + - a Subscription ID; + - the current highest Dictionary Entry ID which has been allocated in the UCMF; +- If the operation code is set to "Deletion", the UCMF shall delete the subscription and include a success cause code in the Subscription Management Response message; + +On failure, the UCMF shall: + +- return an appropriate error cause value, e.g. MANDATORY\_IE\_MISSING for the creation of a subscription, or SUBSCRIPTION\_NOT\_FOUND for the deletion of a subscription, discard all the received information. + +### 6.2.4 Event Notification Procedure + +#### 6.2.4.1 General + +The URCMP Event Notification Procedure shall be used to send a notification for an event, e.g. the creation of one or more new dictionary entries, towards an MME which has a valid subscription in the UCMF. + +#### 6.2.4.2 Procedures in the UCMF + +When one or more new dictionary entries are created in the UCMF since the time of the creation of the subscription, or when a PLMN decides to switch to operate based on manufacturer-assigned UE Radio Capability ID for a particular type of UE, the UCMF shall initiate the Event Notification Procedure by sending an Event Notification Request message towards the MME including: + +- an Event Type IE, which is set to either "Creation of Dictionary Entry" or "Deletion of PLMN-assigned UE Radio Capability ID" or "NEW\_VERSION\_ID\_OF\_PLMN\_ASSIGNED\_IDS"; +- the updated highest Dictionary Entry ID if the Event Type is set to "CREATION\_OF\_DICTIONARY\_ENTRY"; +- a new Version ID if the Event Type is set to "NEW\_VERSION\_ID\_OF\_PLMN\_ASSIGNED\_IDS"; +- the Manufacturer Assigned operation requested list if the Event Type is set to "DELETION\_OF\_PLMN\_ASSIGNED\_IDS" which shall include one of the following (not both);; + - one or more PLMN Assigned UE Radio Capability IDs to be deleted; + - or, one or more Type Allocation Codes in corresponding to the PLMN Assigned UE Radio Capability IDs to be deleted. + +#### 6.2.4.3 Procedures in the MME + +When the MME receives an Event Notification Request message, it shall reply with an Event Notification Response message. + +On success, the MME: + +- may determine and then retrieve those dictionary entries which are not available yet locally using the Dictionary Entry ID if the Event Type is set to "Creation of Dictionary Entry"; +- shall retrieve affected UE contexts which are using those PLMN-assigned UE Radio Capability IDs which are to be deleted and behave as specified in clause 5.11.3a of 3GPP TS 23.401 [2] if the Event Type is set to "Deletion of PLMN-assigned UE Radio Capability ID"; +- may determine to retrieve a new PLMN Assigned UE Radio Capability ID, e.g. for a UE with signalling connection established to the MME; +- shall include a success cause code in the Event Notification Response message; + +On failure, the MME: + +- shall return an appropriate error cause value in the Event Notification Response message, e.g. MANDATORY\_IE\_MISSING, and discard all the received information. + +## 6.3 Session Related Procedures + +### 6.3.1 General + +The following clauses describe the session related procedures over the S17 reference points. A URCMP session refers to a signalling transaction addressing a dictionary entry containing the mapping information between the UE Radio Capability ID(s) and UE Radio Access Capability Information. + +### 6.3.2 Create Dictionary Entry Procedure + +#### 6.3.2.1 General + +The URCMP Create Dictionary Entry procedure shall be used to create a dictionary entry in the UCMF, and obtain a PLMN assigned UE Radio Capability ID. + +#### 6.3.2.2 Procedures in the MME + +When the UE Radio Capability ID, either PLMN-assigned or Manufacturer-assigned, is not received by the MME from a UE, or from the source MME during an inter MME mobility procedure or if the MME receives a rejection response from the UCMF with the cause code "NO\_DICTIONARY\_ENTRY\_FOUND" when it uses a Manufacturer-assigned UE Radio Capability ID to retrieve the corresponding UE Radio Access Capability Information, or if the MME receives a rejection response from the UCMF with the cause code "OUT\_DATED\_VERSION\_ID\_IN\_RAC\_ID" when it uses a PLMN-assigned UE Radio Capability ID to retrieve the corresponding UE Radio Access Capability Information, the MME shall initiate the Create Dictionary Entry Procedure by sending a Create Dictionary Entry Request message towards the UCMF including: + +- the UE Radio Access Capability Information, which is received from the eNB, encoded as specified in 3GPP TS 36.413 [8], and optionally also including information encoded as specified in 3GPP TS 38.413 [11] +- Type Allocation Code in the IMEI of the UE + +When the MME receives a Create Dictionary Entry Response message with a successful cause, the MME function shall continue with the procedure which triggered the Create Dictionary Entry procedure as specified in 3GPP TS 23.401 [2]. + +#### 6.3.2.3 Procedures in the UCMF + +When the UCMF receives a Create Dictionary Entry Request message, it shall reply with a Create Dictionary Entry Response message. + +On success, the UCMF shall check whether for the provided input a dictionary entry already exists and a PLMN Assigned UE Radio Capability ID has already been assigned. If this is not the case, the UCMF shall create a new dictionary entry with the received information and a new PLMN assigned UE Radio Capability ID. The UCMF shall include the following (already existing or newly created) information in the Create Dictionary Entry Response message; + +- a dictionary entry ID; +- a PLMN assigned UE Radio Capability ID, if PLMN is configured to use a PLMN specific UE Radio Capability ID. + +On failure, the UCMF shall: + +- return an appropriate error cause value, e.g. MANDATORY\_IE\_MISSING, discard all the received information and not create any dictionary entry. + +A UCMF configured to operate in Mode of Operation A (3GPPP TS 23.401, Clause 5.11.3a) shall reject the operation if the request does not contain UE Radio Access Capability Information in both the formats and UCMF is not able to find match of the received UE Radio Access Capability Information in its database. + +### 6.3.3 Query Dictionary Entry Procedure + +#### 6.3.3.1 General + +The URCMP Query Dictionary Entry procedure shall be used to retrieve UE Radio Access Capability Information from a dictionary entry in the UCMF. + +#### 6.3.3.2 Procedures in the MME + +When the MME receives a UE Radio Capability ID from a UE or the source MME (during an inter MME mobility procedure), which is either PLMN-assigned or Manufacturer-assigned, while there is no corresponding UE Radio Access Capability Information stored in the MME, the MME shall initiate the Query Dictionary Entry Procedure by sending a Query Dictionary Entry Request message towards the UCMF including: + +- a PLMN-assigned UE Radio Capability ID; +- or a Manufacturer-assigned UE Radio Capability ID; +- or a Dictionary Entry ID; + +When the MME receives a Query Dictionary Entry Response message with a successful cause, the MME function shall continue with the procedure which triggered the Create Dictionary Entry procedure as specified in 3GPP TS 23.401 [2]. + +#### 6.3.3.3 Procedures in the UCMF + +When the UCMF receives a Query Dictionary Entry Request message, it shall look up the dictionary entries and reply with a Query Dictionary Entry Response message. + +On success, the UCMF shall provide the information included in the dictionary entry which matches the query parameter in the Query Dictionary Entry Response message, and the following information shall be included (if available): + +- the UE Radio Access Capability Information in correspondence to the querying parameter, e.g. the UE Radio Capability ID included in the request message; +- a PLMN specific UE Radio Capability ID if allocated, e.g. when the querying UE Radio Capability ID is a Manufacturer-assigned UE Radio Capability ID and if PLMN is configured to use a PLMN specific UE Radio Capability ID; +- the dictionary entry id; +- a Manufacturer-assigned UE Radio Capability ID if available; +- the Type Allocation Code. + +NOTE: The UCMF will not provide the information in a dictionary entry which is already included as a query parameter in the request message. + +On failure, the UCMF shall: + +- return an appropriate error cause value, e.g. NO\_DICTIONARY\_ENTRY\_FOUND, OUT\_DATED\_VERSION\_ID\_IN\_RAC\_ID. + +## 6.4 Reliable Delivery of URCMP Messages + +Reliable delivery of URCMP messages is accomplished by retransmission of these messages as specified in this clause. + +A URCMP entity shall maintain, for each triplet of local IP address, local UDP port and remote peer's IP address, a sending queue with Request messages to be sent to that peer. Each message shall be sent with a Sequence Number and be held until a corresponding Response is received or until the URCMP entity ceases retransmission of that message. The Sequence Number shall be unique for each outstanding Request message sourced from the same IP/UDP endpoint. A URCMP entity may have several outstanding Requests waiting for replies. + +When sending a Request message, the sending URCMP entity shall start a timer T1. The sending entity shall consider that the Request message has been lost if a corresponding Response message has not been received before the T1 timer expires. If so, the sending entity shall retransmit the Request message, if the total number of retry attempts is less than N1 times. The setting of the T1 timer and N1 counter is implementation specific. + +A retransmitted URCMP message shall have the same message content, including the same URCMP header, UDP ports, source and destination IP addresses as the originally transmitted message. + +A Request and its Response message shall have the same Sequence Number value, i.e. the Sequence Number in the URCMP header of the Response message shall be copied from the respective Request message. A Request and its Response messages are matched based on the Sequence Number and the IP address and UDP port. + +Not counting retransmissions, a Request message shall be answered with a single Response message. Duplicated Response messages shall be discarded by the receiver. A received Response message not matching an outstanding Request message waiting for a reply should be discarded. + +The URCMP entity should inform the upper layer when detecting an unsuccessful transfer of a Request message to enable the controlling upper entity to take any appropriate measure. + +# --- 7 Messages and Message Formats + +## 7.1 Introduction + +## 7.2 Transmission Order and Bit Definitions + +URCMP messages shall be transmitted in network octet order starting with octet 1 with the most significant bit sent first. + +The most significant bit of an octet in a URCMP message is bit 8. If a field in a URCMP message spans over several octets, the most significant bit is bit 8 of the octet with the lowest number, unless specified otherwise. + +## 7.3 Message Format + +### 7.3.1 General + +The format of a URCMP message is depicted in Figure 7.3.1-1. + +![](a33da0f14e456f92539ce3e9b7d81f9a_img.jpg) + +| Octets | Bits | | | | | | | | +|----------|-------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to m | URCMP message header | | | | | | | | +| m+1 to n | Zero or more Information Element(s) | | | | | | | | + +Figure 7.3.1-1: URCMP Message Format + +A URCMP message shall contain the URCMP message header and may contain subsequent information element(s) dependent on the type of message. + +### 7.3.2 Message Header + +URCMP messages use a fixed length header. The message header length shall be a multiple of 4 octets. Figure 7.3.2.1-1 illustrates the format of the URCMP Header. + +![](f6e8acf9f931452d01688d311b5c0364_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|-----------------------------------------|---|---|-------|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Version | | | Spare | | | | | +| 2 | Message Type | | | | | | | | +| 3 | Message Length (1 st Octet) | | | | | | | | +| 4 | Message Length (2 nd Octet) | | | | | | | | +| 5 | Message Length (3 rd Octet) | | | | | | | | +| 6 | Sequence Number (1 st Octet) | | | | | | | | +| 7 | Sequence Number (2 nd Octet) | | | | | | | | +| 8 | Sequence Number (3 rd Octet) | | | | | | | | + +Figure 7.3.2-1: General format of URCMP Header + +### 7.3.3 Usage of the URCMP Header + +The format of the URCMP header is specified in clause 7.3.2. + +The usage of the URCMP header shall be as defined below. + +The first octet of the header shall be used is the following way: + +- Bit 1-5 are spare bits. The sending entity shall set it to "0" and the receiving entity shall ignore it. +- Bits 6 to 8, which represent the URCMP version, shall be set to decimal 1 ("001"). + +The usage of the fields in octets 2 - n of the header shall be as specified below. + +- Octet 2 represents the Message type field, which shall be set to the unique value for each type of control plane message. Message type values are specified in Table 7.3-1 "Message types". +- Octets 3 to 5 represent the Message Length field. This field shall indicate the length of the message in octets excluding the mandatory part of the URCMP header (the first 5 octets). The Sequence Number shall be included in the length count. The format of the Length field of information elements is specified in clause 8.2 "Information Element Format". +- Octets 6 to 8 represent URCMP Sequence Number field. + +### 7.3.4 Information Elements + +#### 7.3.4.1 General + +The format of URCMP Information Elements are defined in clause 8.2. + +#### 7.3.4.2 Presence Requirements of Information Elements + +Ies within URCMP messages shall be specified with one of the following presence requirement: + +- Mandatory: this means that the IE shall be included by the sending entity, and that the receiver diagnoses a "Mandatory IE missing" error when detecting that the IE is not present. A response including a "Mandatory IE missing" cause, shall include the type of the missing IE. +- Conditional: this means that: + - the IE shall be included by sending entity if the conditions specified are met; + - the receiver shall check the conditions as specified in the corresponding message type description, based on the parameter combination in the message and/or on the state of the receiving node, to infer if a conditional IE shall be expected. Only if a receiver has sufficient information, if a conditional IE, which is necessary for the receiving entity to complete the procedure, is missing, then the receiver shall abort the procedure. +- Conditional-Optional: this means that: + - the IE shall be included by a sending entity complying with the version of the specification, if the conditions specified in the relevant protocol specification are met. An entity, which is at an earlier version of the protocol and therefore is not up-to-date, cannot send this IE; + - the receiver need not check the presence of the IE in the message. If the receiver checks the presence of the Conditional-Optional IE, then the IE's absence shall not trigger any of the error handling procedures. The handling of an absence or erroneous such Ies shall be treated as Optional Ies as specified in clause 7.6. +- Optional: this means that: + - the IE shall be included as a service option. Therefore, the IE may be included or not in a message. The handling of an absent optional IE, or an erroneous optional IE is specified in clause 7.6. + +For conditional Ies, the clause describing the URCMP message explicitly defines the conditions under which the inclusion of each IE becomes mandatory or optional for that particular message. These conditions shall be defined so that the presence of a conditional IE only becomes mandatory if it is critical for the receiving entity. The definition might reference other protocol specifications for final terms used as part of the condition. + +For grouped Ies, the presence requirement of the embedded IE shall follow the rules: + +- If the grouped IE is Mandatory within a given message: the presence requirements of individual embedded Ies are as stated within the Mandatory grouped IE for the given message; +- if the grouped IE is Conditional within a given message: if the embedded IE in the grouped IE is Mandatory or Conditional, this embedded IE is viewed as Conditional IE by the receiver. If the embedded IE in the grouped IE is Conditional-Optional, this embedded IE is viewed as Optional IE by the receiver. If the embedded IE in the grouped IE is Optional, this embedded IE is viewed as Optional IE by the receiver; +- if the grouped IE is Conditional-Optional within a given message: if the embedded IE in the grouped IE is Mandatory or Conditional, this embedded IE is viewed as Conditional-Optional IE by the receiver. If the embedded IE in the grouped IE is Conditional-Optional, this embedded IE is viewed as Optional IE by the receiver. If the embedded IE in the grouped IE is Optional, this embedded IE is viewed as Optional IE by the receiver; +- if the grouped IE is Optional within a given message: all embedded Ies in the grouped IE are viewed as Optional Ies by the receiver. + +In all of the above cases, appropriate error handling as described in clause 7.6 shall be applied for protocol errors of the embedded Ies. + +Only the Cause IE at message level shall be included in the response if the Cause contains a value that indicates that the request is not accepted, regardless of whether there are other mandatory or conditional Ies defined for a given response message. + +#### 7.3.4.3 Grouped Information Elements + +A Grouped IE is an IE which may contain other IEs. + +Grouped IEs have a length value in the TLV encoding, which includes the added length of all the embedded IEs. Overall coding of a grouped IE with 4 octets long IE header is defined in clause 8.2. Each IE within a grouped IE also shall also contain 4 octets long IE header. + +Grouped IEs are not marked by any flag or limited to a specific range of IE type values. The clause describing an IE in this specification shall explicitly state if it is a Grouped IE. + +NOTE: Each entry into each Grouped IE creates a new scope level. Exit from the grouped IE closes the scope level. The URCMP message level is the top most scope. + +If more than one grouped IEs of the same type, but for a different purpose are sent with a message, these IEs shall have different IE types. + +If more than one grouped IEs of the same type and for the same purpose are sent with a message, these IEs shall have exactly the same IE type to represent a list. + +#### 7.2.3.4 Information Element Type + +An IE in a URCMP message or Grouped IE is identified by its IE Type and described by a specific row in the corresponding tables in clause 7. + +If several IEs with the same Type are included in a URCMP message or Grouped IE, they represent a list for the corresponding IE name. + +An IE Type value uniquely identifies a specific IE. + +One IE type value is specified for Vendor Specific IEs. + +## 7.4 Message Types + +The URCMP message types to be used over the S17 reference points are defined in Table 7.4-1. + +**Table 7.4-1: Message Types** + +| Message Type value (Decimal) | Message | +|------------------------------|---------------------------------------| +| 0 | Reserved | +| | URCMP Node related messages | +| 1 | Heartbeat Request | +| 2 | Heartbeat Response | +| 3 | Subscription Management Request | +| 4 | Subscription Management Response | +| 5 | Event Notification Request | +| 6 | Event Notification Response | +| 7 to 49 | For future use | +| | URCMP Session related messages | +| 50 | Create Dictionary Entry Request | +| 51 | Create Dictionary Entry Response | +| 52 | Query Dictionary Entry Request | +| 53 | Query Dictionary Entry Response | +| 54 to 99 | For future use | +| | Other messages | +| 100 to 255 | For future use | + +## 7.5 S17-AP Messages + +### 7.5.1 URCMP Node Related Messages + +#### 7.5.1.1 General + +This clause specifies the URCMP node related messages used over the S17 reference points. + +#### 7.5.1.2 Heartbeat Request + +**Table 7.5.1.2-1: Information Elements in Heartbeat Request** + +| Information elements | P | Condition / Comment | IE Type | +|----------------------|---|-------------------------------------------------------------------------|---------------------| +| Recovery Time Stamp | M | This IE shall contain the time stamp when the URCMP entity was started. | Recovery Time Stamp | + +#### 7.5.1.3 Heartbeat Response + +**Table 7.5.1.3-1: Information Elements in Heartbeat Response** + +| Information elements | P | Condition / Comment | IE Type | +|----------------------|---|-------------------------------------------------------------------------|---------------------| +| Recovery Time Stamp | M | This IE shall contain the time stamp when the URCMP entity was started. | Recovery Time Stamp | + +#### 7.5.1.4 Subscription Management Request + +The Subscription Management Request shall be sent over the S17 interface by the MME to the UCMF to create a subscription in the UCMF to receive the notifications, or to delete an existing subscription. + +**Table 7.5.1.4-1: Information Elements in a Subscription Management Request** + +| Information elements | P | Condition / Comment | IE Type | +|----------------------------------------|---|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------| +| MME Address Information | C | This IE shall be included to contain the MME Address Information to receive the subsequent notifications for the subscription if the Subscription Management Operation Type indicates to create a new subscription. | MME Address Information | +| Subscription Management Operation Type | M | | Subscription Management Operation Type | +| Subscription ID | C | This IE shall be included to contain the Subscription ID that allocated by the UCMF for this subscription if the Subscription Management Operation Type indicates to delete the subscription. | Subscription ID | + +#### 7.5.1.5 Subscription Management Response + +The Subscription Management Response shall be sent over the S17 interface by the UCMF to the MME as a reply to the Subscription Management Request. + +**Table 7.5.1.5-1: Information Elements in a Subscription Management Response** + +| Information elements | P | Condition / Comment | IE Type | +|----------------------|---|---------------------|---------| +| Cause | M | | Cause | + +| | | | | +|---------------------|---|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------| +| | | | | +| Dictionary Entry ID | C | This IE shall be included to contain the highest Dictionary Entry ID has been allocated in the UCMF if the cause indicates an acceptance code. | Dictionary Entry ID | +| Subscription ID | C | This IE shall be included to contain the Subscription ID that created in the UCMF for this subscription if the cause indicates an acceptance code and the request is to create a new subscription. | Subscription ID | + +#### 7.5.1.6 Event Notification Request + +The Event Notification Request shall be sent over the S17 interface by the UCMF to the MME to send a notification for the subscription created earlier by the MME. + +**Table 7.5.1.6-1: Information Elements in a Event Notification Request** + +| Information elements | P | Condition / Comment | IE Type | +|------------------------------------------------|---|-----------------------------------------------------------------------------------------------------------------------|------------------------------------------------| +| Dictionary Entry ID | M | This IE shall be included to contain the highest Dictionary Entry ID has been allocated in the UCMF. | Dictionary Entry ID | +| Event Type | M | | Event Type | +| Manufacturer Assigned Operation Requested List | C | This IE shall be present if the Event Type indicates to delete one or more PLMN assigned UE Radio Capability IDs. | Manufacturer Assigned Operation Requested List | +| Version ID | O | This IE may be present if Event Type indicates to notify a new version id of PLMN Assigned UE Radio Capability Id(s). | Version ID | + +**Table 7.5.1.6-2: Manufacturer Assigned Operation Requested List IE in a Event Notification Request** + +| Octet 1 and 2 | Deletion of PLMN Assigned UE Radio Capability ID IE
Type = 13 (decimal) | | | +|--------------------------------------|----------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------| +| Octets 3 and 4 | Length = n | | | +| Information elements | P | Condition / Comment | IE Type | +| PLMN Assigned UE Radio Capability ID | C | This IE shall be included to contain a PLMN Assigned UE Radio Capability ID to be deleted.

Several IEs with the same IE type may be present to represent a list of PLMN Assigned UE Radio Capability IDs.

The UCMF shall always provide a complete list of PLMN Assigned UE Radio Capability IDs to enable the AMF to overwrite the existing list. | PLMN Assigned UE Radio Capability ID | +| Type Allocation Code | C | This IE shall contain a Type Allocation Code in corresponding to the PLMN Assigned UE Radio Capability IDs to be deleted.

Several IEs with the same IE type may be present to represent a list of Type Allocation Codes.

The UCMF shall always provide a complete list of Type Allocation Codes to enable the AMF to overwrite the existing list. | Type Allocation Code | + +#### 7.5.1.7 Event Notification Response + +The Event Notification Response shall be sent over the S17 interface by the MME to the UCMF as a reply to the Event Notification Request. + +**Table 7.5.1.7-1: Information Elements in a Subscription Management Response** + +| Information elements | P | Condition / Comment | IE Type | +|----------------------|---|---------------------|---------| +| Cause | M | | Cause | + +### 7.5.2 URCMP Session Related Messages + +#### 7.5.2.1 General + +This clause specifies the URCMP session related messages used over the S17 interface. + +#### 7.5.2.2 Create Dictionary Entry Request + +The Create Dictionary Entry Request shall be sent over the S17 interface by the MME to create a dictionary entry in the UCMF, and then to obtain a PLMN assigned UE Radio Capability ID. + +**Table 7.5.2.2-1: Information Elements in a Create Dictionary Entry Request** + +| Information elements | P | Condition / Comment | IE Type | +|----------------------------------------|---|----------------------------------------------------------------|----------------------------------------| +| Type Allocation Code | M | This IE shall be included by the MME over S17 reference point. | Type Allocation Code | +| UE Radio Access Capability Information | M | | UE Radio Access Capability Information | + +#### 7.5.2.3 Create Dictionary Entry Response + +The Create Dictionary Entry Response shall be sent over the S17 interface by the UCMF to the MME as a reply to the Create Dictionary Entry Request. + +**Table 7.5.2.3-1: Information Elements in a Create Dictionary Entry Response** + +| Information elements | P | Condition / Comment | IE Type | +|--------------------------------------|---|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------| +| Cause | M | | Cause | +| Dictionary Entry ID | C | This IE shall be included to contain a dictionary entry identifier allocated by the UCMF for newly created dictionary entry as requested by the MME if the Cause indicates an acceptance code. | Dictionary Entry ID | +| PLMN Assigned UE Radio Capability ID | C | This IE shall be included to contain a PLMN Assigned UE Radio Capability ID allocated by the UCMF for the UE Radio Access Capability Information included in the request message if the cause indicates an acceptance code. | PLMN Assigned UE Radio Capability ID | + +#### 7.5.2.4 Query Dictionary Entry Request + +The Query Dictionary Entry Request shall be sent over the S17 interface by the MME to retrieve UE Radio Access Capability Information from a dictionary entry in the UCMF. + +**Table 7.5.2.4-1: Information Elements in a Query Dictionary Entry Request** + +| Information elements | P | Condition / Comment | IE Type | +|----------------------------------------------|---|-----------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------| +| Dictionary Entry ID | C | This IE shall be included if the MME uses a Dictionary Entry ID to retrieve a dictionary entry. (NOTE 1) | Dictionary Entry ID | +| PLMN Assigned UE Radio Capability ID | C | This IE shall be included if the MME uses a PLMN Assigned UE Radio Capability ID to retrieve a dictionary entry. (NOTE 1) | PLMN Assigned UE Radio Capability ID | +| Manufacturer Assigned UE Radio Capability ID | C | This IE shall be included if the MME uses a Manufacturer Assigned UE Radio Capability ID to retrieve a dictionary entry. (NOTE 1) | Manufacturer Assigned UE Radio Capability ID | + +NOTE 1: At least one of query parameters, Dictionary Entry ID, PLMN Assigned UE Radio Capability ID, Manufacture Assigned UE Radio Capability ID or Type Allocation Code shall be used to retrieve a dictionary entry. + +#### 7.5.2.5 Query Dictionary Entry Response + +The Query Dictionary Entry Response shall be sent over the S17 interface by the UCMF to the MME as a reply to the Query Dictionary Entry Request. + +**Table 7.5.2.5-1: Information Elements in a Query Dictionary Entry Response** + +| Information elements | P | Condition / Comment | IE Type | +|----------------------------------------------|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------| +| Cause | M | | Cause | +| Dictionary Entry ID | C | This IE shall be included to contain a dictionary entry identifier if the Cause indicates an acceptance cause. | Dictionary Entry ID | +| PLMN Assigned UE Radio Capability ID | C | This IE shall be included to contain a PLMN Assigned UE Radio Capability ID if allocated for the UE Radio Access Capability Information in the dictionary entry and if the Cause indicates an acceptance cause. | PLMN Assigned UE Radio Capability ID | +| Manufacturer Assigned UE Radio Capability ID | C | This IE shall be included to contain a Manufacturer Assigned UE Radio Capability ID if available for the UE Radio Access Capability Information in the dictionary entry and if the Cause indicates an acceptance cause. | Manufacturer Assigned UE Radio Capability ID | +| UE Radio Access Capability Information | C | This IE shall be included to provide the UE Radio Access Capability Information if the Cause indicates an acceptance cause. [NOTE] | UE Radio Access Capability Information | +| Type Allocation Code | C | This IE shall be included to provide the Type Allocation Code in corresponding to the UE Radio Access Capability in the dictionary entry if the Cause indicates an acceptance cause. | Type Allocation Code | + +NOTE: In this message, "UE Radio Access Capability Information" shall contain "UE Radio Access Capability Information (EPS)" field. "UE Radio Access Capability Information (5GS)" may be present. + +## 7.6 Error Handling + +### 7.6.1 Protocol Errors + +A protocol error is defined as a message or an Information Element received from a peer entity with an unknown type, or if it is unexpected, or if it has an erroneous content. + +The term silently discarded is used in the following clauses to mean that the receiving URCMP entity's implementation shall discard such a message without further processing or that the receiving URCMP entity discards such an IE and continues processing the message. The conditions for the receiving URCMP entity to silently discard an IE are specified in the subsequent clauses. + +The handling of unknown, unexpected or erroneous URCMP messages and IEs shall provide for the forward compatibility of URCMP. Therefore, the sending URCMP entity shall be able to safely include in a message a new conditional-optional or an optional IE. Such an IE may also have a new type value. Any legacy receiving URCMP entity shall, however, silently discard such an IE and continue processing the message. + +If a protocol error is detected by the receiving URCMP entity, it should log the event including the erroneous message and may include the error in a statistical counter. + +For Response messages containing a rejection Cause value, see clause 7.3.4.2. + +The receiving URCMP entity shall apply the error handling specified in the subsequent clauses. + +If the received erroneous message is a reply to an outstanding URCMP message, the URCMP transaction layer shall stop retransmissions and notify the URCMP application layer of the error even if the reply is silently discarded. + +### 7.6.2 URCMP Message of Invalid Length + +If a URCMP entity receives a message, which is too short to contain the respective URCMP header, the URCMP-PDU shall be silently discarded. + +If a URCMP entity receives a Request message within an IP/UDP packet of a length that is inconsistent with the value specified in the Length field of the URCMP header, then the receiving URCMP entity should log the error and shall send the Response message with Cause IE value set to "Invalid Length". + +If a URCMP entity receives a Response message within an IP/UDP packet of a length that is inconsistent with the value specified in the Length field of the URCMP header, then the receiving URCMP entity should log the error and shall silently discard the message. + +### 7.6.4 Unknown URCMP Message + +If a URCMP entity receives a message with an unknown Message Type value, it shall silently discard the message. + +### 7.6.5 Unexpected URCMP Message + +If a URCMP entity receives an unexpected request message, for example a known message that is sent over an interface for which the message is not defined, or a message that is sent over an interface for which the message is defined, but the direction is incorrect, then the URCMP entity shall silently discard the message and shall log an error. + +If a URCMP entity receives an unexpected response message which is not a request message, for example a message for which there is no corresponding outstanding request, it shall discard the message and may log an error. + +### 7.6.6 Missing Information Elements + +A URCMP entity shall check if all mandatory IEs are present in the received Request message. If one or more mandatory information elements are missing in the received Request message, the URCMP entity should log the error and shall send a Response message with Cause IE value set to "Mandatory IE missing" with the type of the missing mandatory IE. + +If a URCMP entity receives a Response message with Cause IE value set to "Mandatory IE missing", it shall notify its upper layer. + +A URCMP entity shall check if all mandatory IEs are present in the received Response message without a rejection Cause value. If one or more mandatory information elements are missing, the URCMP entity shall notify the upper layer and should log the error. + +A URCMP entity shall check if conditional information elements are present in the received Request message, if possible (i.e. if the receiving entity has sufficient information available to check if the respective conditions were met). If one or more conditional information elements are missing, a URCMP entity should log the error and shall send a Response message with Cause IE value set to "Conditional IE missing" together with the type of the missing conditional IE. + +A URCMP entity shall check if conditional information elements are present in the received Response message without a rejection Cause value, if possible (i.e. if the receiving entity has sufficient information available to check if the respective conditions were met). If one or more conditional information elements are missing, a URCMP entity shall notify the upper layer and should log the error. + +Absence of an optional information element shall not trigger any error handling. + +### 7.6.7 Semantically incorrect Information Element + +Apart from Echo Request message, the receiver of a URCMP signalling message Request including a mandatory or a verifiable conditional information element with a semantically invalid Value shall discard the request, should log the error, and shall send a response with Cause IE value set to "Mandatory IE incorrect" together with a type and instance of the offending IE. + +The receiver of a URCMP signalling message Response including a mandatory or a verifiable conditional information element with a semantically invalid Value shall notify the upper layer that a message with this sequence number has been received and should log the error. + +If a URCMP entity receives an information element with a value which is shown as reserved, it shall treat that information element as invalid and should log the error. If the invalid IE is received in a Request, and it is a mandatory IE or a verifiable conditional IE, the URCMP entity shall send a response with Cause set to "Mandatory IE incorrect" together with a type and instance of the offending IE. + +The principle is: the use of reserved values invokes error handling; the use of spare values can be silently discarded and for IEs with spare values used, processing shall be continued ignoring the spare values. + +The receiver of a URCMP signalling message including an optional information element with a Value that is not in the range defined for this information element value shall discard this IE, but shall treat the rest of the message as if this IE was absent and continue processing. The receiver shall not check the content of an information element field that is defined as "spare". + +All semantically incorrect optional information elements in a URCMP signalling message shall be treated as not present in the message. + +### 7.6.8 Unknown or unexpected Information Element + +The receiver of a URCMP message including an unexpected information element with a known Type value that is not defined for this message shall discard the IE and log an error. The receiver shall process the message. + +NOTE: An Information Element in an encoded URCMP message or grouped IE is identified by the IE Type. + +### 7.6.9 Repeated Information Elements + +An Information Element is repeated if there is more than one IE with the same IE Type in the scope of the URCMP message (or in the scope of the grouped IE). Such an IE is a member in a list. + +If an information element is repeated in a URCMP signalling message in which repetition of the information element is not specified, only the contents of the information element appearing first shall be handled and all subsequent repetitions of the information element shall be ignored. When the number of repetitions of information elements is + +specified, only the contents of specified repeated information elements shall be handled and all subsequent repetitions of the information element shall be ignored. + +# 8 Information elements + +## 8.1 Information Elements Format + +Figure 8.1-1 depicts the format of an Information Element. + +| Octets | Bits | | | | | | | | +|------------|---------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = xxx (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| p to (p+1) | Enterprise ID | | | | | | | | +| k to (n+4) | IE specific data or content of a grouped IE | | | | | | | | + +Figure 8.1-1: Information Element Format + +NOTE 1: If the Bit 8 of Octet 1 is not set, this indicates that the IE is defined by 3GPP and the Enterprise ID is absent. If Bit 8 of Octet 1 is set, this indicates that the IE is defined by a vendor and the Enterprise ID is present identified by the Enterprise ID. + +An IE has the following mandatory fields: + +- Type: this field indicates the type of the Information Element. IE type values within the range of 0 to 32767 are reserved for IE defined by 3GPP and are listed in clause 8.2. IE type values within the range of 32768 to 65535 are used for vendor-specific IE and the value allocation is controlled by the vendor. +- Length: this field contains the length of the IE excluding the first four octets, which are common for all IEs (Type and Length) and is denoted "n" in Figure 8.1-1 and in Figure 8.1-2. Bit 8 of the lowest numbered octet is the most significant bit and bit 1 of the highest numbered octet is the least significant bit. + +An IE has the following optional fields: + +- Enterprise ID: if the IE type value is within the range of 32768 to 65535, this field shall contain the IANA-assigned "SMI Network Management Private Enterprise Codes" value of the vendor defining the IE. The Enterprise ID set to "10415" (IANA-assigned "SMI Network Management Private Enterprise Codes") shall not be used for the vendor specific IEs. + +For illustration, Figure 8.1-2 depicts the format of a Information Element (IE) defined by 3GPP and is specified in this specification. For IE's defined by 3GPP, the IE type shall be within the range of 0 to 32767. + +| Octets | Bits | | | | | | | | +|------------|---------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = xxx (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to (n+4) | IE specific data or content of a grouped IE | | | | | | | | + +Figure 8.1-2: 3GPP defined Information Element Format + +NOTE 2: Bit 8 of Octet 1 is not set. This indicates that the Information Element type value has been allocated by 3GPP. + +For illustration, Figure 8.1-3 depicts the format of a vendor-specific Information Element, which content is not specified and the IE type value shall be within the range of 32768 to 65535. + +![](ae53f90bb87d6d09e2d6b5278d7c338f_img.jpg) + +| Octets | Bits | | | | | | | | +|------------|---------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = xxx (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 6 | Enterprise ID | | | | | | | | +| 7 to (n+4) | IE specific data or content of a grouped IE | | | | | | | | + +**Figure 8.1-3: Vendor-Specific Information Element Format** + +NOTE 3: Bit 8 of Octet 1 is set. This indicates that the IE type value has been allocated by the vendor identified by the Enterprise ID. The content of this IE is vendor specific and therefore out of scope of this specification. + +## 8.2 Information Elements Types + +### 8.2.0 General + +A URCMP message may contain several IEs. In order to have forward compatible type definitions for the URCMP IEs, all of them shall be TLV (Type, Length, Value) coded. URCMP IE type values are specified in the Table 8.2.0-1. The last column of this table indicates whether the IE is: + +- Fixed Length: the IE has a fixed set of fields, and a fixed number of octets; +- Variable Length: the IE has a fixed set of fields, and has a variable number of octets. +For example, the last octets may be numbered similar to "5 to (n+4)". In this example, if the value of the length field, n, is 0, then the last field is not present; +- Extendable: the IE has a variable number of fields, and has a variable number of octets. +The last fields are typically specified with the statement: "These octet(s) is/are present only if explicitly specified". The legacy receiving entity shall ignore the unknown octets. + +In order to improve the efficiency of troubleshooting, it is recommended that the IEs should be arranged in the signalling messages as well as in the grouped IEs, according to the order the IEs are listed in the message definition table or grouped IE definition table in clause 7. However the receiving entity shall be prepared to handle the messages with IEs in any order. + +Within IEs, certain fields may be described as spare. These bits shall be transmitted with the value set to 0 to allow for future features, the receiver shall not evaluate these bits. + +**Table 8.2.0-1: Information Element Types** + +| IE Type value (Decimal) | Information elements | Comment / Reference | Number of Fixed Octets | +|-------------------------|------------------------------------------------|------------------------------|------------------------| +| 0 | Reserved | | | +| 1 | Cause | Fixed Length / 8.2.1 | 1 | +| 2 | Type Allocation Code | Fixed Length / 8.2.2 | 4 | +| 3 | PLMN Assigned UE Radio Capability ID | Variable Length / 8.2.3 | Not Applicable | +| 4 | Manufacturer Assigned UE Radio Capability ID | Variable Length / 8.2.4 | Not Applicable | +| 5 | Dictionary ID | Fixed Length / 8.2.5 | 4 | +| 6 | UE Radio Access Capability Information | Extendable / 8.2.6 | 1 | +| 7 | Subscription Management Operation Type | Fixed Length / 8.2.7 | 1 | +| 8 | MME Address Information | Variable Length / 8.2.8 | Not Applicable | +| 9 | Subscription ID | Fixed Length / 8.2.9 | 4 | +| 10 | Event Type | Fixed Length / 8.2.10 | 1 | +| 11 | Recovery Time Stamp | Fixed Length / 8.2.11 | 4 | +| 12 | Manufacturer Assigned Operation Requested List | Extendable / Table 7.5.1.6-2 | Not Applicable | +| 13 | Version ID | Fixed Length / 8.2.xx | 1 | +| 14 to 65535 | Spare. For future use. | | | + +### 8.2.1 Cause + +Cause IE is coded as depicted in Figure 8.2.1-1. + +| Octets | Bits | | | | | | | | +|--------|--------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 1 (decimal) | | | | | | | | +| 3 to 4 | Length = 1 | | | | | | | | +| 5 | Cause value | | | | | | | | + +Figure 8.2.1-1: Cause + +The Cause value shall be included in a response message. In a response message, the Cause value indicates the acceptance or the rejection of the corresponding request message. The Cause value indicates the explicit reason for the rejection. + +Table 8.2.1-1: Cause values + +| Message Type | Cause value (decimal) | Meaning | Description | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------|---------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | 0 | Reserved. | Shall not be sent and if received the Cause shall be treated as an invalid IE | +| Acceptance in a response | 1 | Request accepted (success) | "Request accepted (success)" is returned when the PFCP entity has accepted a request. | +| | 2-63 | Spare. | This value range shall be used by Cause values in an acceptance response message. See NOTE 1. | +| Rejection in a response | 64 | Request rejected (reason not specified) | This cause shall be returned to report an unspecified rejection cause | +| | 65 | Mandatory IE missing | This cause shall be returned when the receiver detects that a mandatory IE is missing in a request message | +| | 66 | Conditional IE missing | This cause shall be returned when the receiver detects that a Conditional IE is missing in a request message. | +| | 67 | Invalid length | This cause shall be returned when the receiver detects that an IE with an invalid length in a request message | +| | 68 | Mandatory IE incorrect | This cause shall be returned when the receiver detects that a Mandatory IE is incorrect in a request message, e.g. the Mandatory IE is malformed or it carries an invalid or unexpected value. | +| | 69 | NO_DICTIONARY_ENTRY_FOUND | This cause shall be used by the UCMF if a dictionary entry cannot be found to match the query parameter included in the request message. | +| | 70 | SUBSCRIPTION_NOT_FOUND | This cause shall be used by the UCMF if the subscription to be deleted cannot be found. | +| | 71 | OUT_DATED_VERSION_ID_IN_RAC_ID | The version id in the requested PLMN Assigned UE Radio Capability Id is out-dated. | +| | 72 to 255 | Spare for future use in a response message. See NOTE 2. | This value range shall be used by Cause values in a rejection response message. See NOTE 2. | +| NOTE 1: This value is or may be used in future version of the specification. If the receiver cannot comprehend the value, it shall be interpreted as an unspecified acceptance cause.
Unspecified/unrecognized acceptance cause shall be treated in the same ways as the cause value 1 " Request accepted (success)". | | | | +| NOTE 2: This value is or may be used in a future version of the specification. If the receiver cannot comprehend the value, it shall be interpreted as an unspecified rejection cause.
Unspecified/unrecognized rejection cause shall be treated in the same ways as the cause value 32 "Request rejected (reason not specified)". | | | | + +### 8.2.2 Type Allocation Code + +Type Allocation Code (TAC) is the first 8 digits in an IMEI (15 decimal digits) or an IMEISV (16 decimal digits). See clause 6.2 of 3GPP TS 23.003 [6]. The Type Allocation Code shall be encoded as in Figure 8.2.2-1. + +| Octets | Bits | | | | | | | | +|--------|----------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 2 (decimal) | | | | | | | | +| 3 to 4 | Length = 4 | | | | | | | | +| 5 - 8 | Type Allocation Code | | | | | | | | + +Figure 8.2.2-1: Type Allocation Code + +Each digit of the Type Allocation Code digits is encoded with BCD coding, starting with the first digit coded in bits 4 to 1 of octet 5, the last digit coded in bits 8 to 5 of octet 8. + +### 8.2.3 PLMN Assigned UE Radio Capability ID + +The PLMN Assigned UE Radio Capability ID shall be encoded as in Figure 8.2.3-1. + +| Octets | Bits | | | | | | | | +|--------|--------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 3 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 - n | PLMN Assigned UE Radio Capability ID | | | | | | | | + +Figure 8.2.3-1: PLMN Assigned UE Radio Capability ID + +The PLMN Assigned UE Radio Capability ID field shall be encoded as the "UE radio capability ID" IE (starting from octet 3) as specified in clause 9.9.3.60 of 3GPP TS24.301 [7]. + +### 8.2.4 Manufacturer Assigned UE Radio Capability ID + +The Manufacturer Assigned UE Radio Capability ID shall be encoded as in Figure 8.2.4-1. + +| Octets | Bits | | | | | | | | +|--------|----------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 4 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 - n | Manufacturer Assigned UE Radio Capability ID | | | | | | | | + +Figure 8.2.4-1: PLMN Assigned UE Radio Capability ID + +The Manufacturer Assigned UE Radio Capability ID field shall be encoded as the "UE radio capability ID" IE (starting from octet 3) as specified in clause 9.9.3.60 of 3GPP TS24.301 [7]. + +### 8.2.5 Dictionary Entry ID + +The Dictionary Entry ID IE is coded as in Figure 8.2.5-1. The Dictionary Entry ID identifies a dictionary entry including the mapping between UE Radio Access Capability Information and UE Radio Capability ID(s), Type Allocation Code. + +| Octets | Bits | | | | | | | | +|--------|---------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 5 (decimal) | | | | | | | | +| 3 to 4 | Length = 4 | | | | | | | | +| 5 to 8 | Dictionary Entry ID | | | | | | | | + +Figure 8.2.5-1: Dictionary Entry ID + +Octets 5 to 8 shall contain the Dictionary Entry ID and shall be encoded as an Unsigned32 binary integer value. + +### 8.2.6 UE Radio Access Capability Information + +| Octets | Bits | | | | | | | | +|---------------------|------------------------------------------------------------|---|---|---|------|------|-----|-----| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 6 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | 5GSP | EPSP | 5GS | EPS | +| m to (m+2) | Length = x | | | | | | | | +| (m+3) to
(m+3+x) | UE Radio Access Capability Information (EPS) | | | | | | | | +| p to (p+2) | Length = y | | | | | | | | +| (p+3) to
(p+3+y) | UE Radio Access Capability Information (5GS) | | | | | | | | +| q to (q+2) | Length = u | | | | | | | | +| (q+3) to
(q+3+u) | UE Radio Access Capability Information for paging (EPS) | | | | | | | | +| r to (r+2) | Length = v | | | | | | | | +| (r+3) to
(r+3+v) | UE Radio Access Capability Information for paging (5GS) | | | | | | | | +| (r+3+v) to
(n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.6-1: UE Radio Access Capability Information** + +The following flags are coded within Octet 5: + +- Bit 1 – EPS: If this bit is set to "1", then the UE Radio Access Capability Information (EPS) field shall be present, otherwise the UE Radio Access Capability Information (EPS) field shall not be present. +- Bit 2 – 5GS: If this bit is set to "1", then the UE Radio Access Capability Information (5GS) field shall be present, otherwise the UE Radio Access Capability Information (5GS) field shall not be present. +- Bit 3 – EPSP: If this bit is set to "1", then the UE Radio Access Capability Information for paging (EPS) field shall be present, otherwise the UE Radio Access Capability Information for paging (EPS) field shall not be present. +- Bit 4 – 5GSP: If this bit is set to "1", then the UE Radio Access Capability Information for paging (5GS) field shall be present, otherwise the UE Radio Access Capability Information for paging (5GS) field shall not be present. +- Bit 5 to 8 Spare, for future use and set to 0. + +Octets "m to (m+2)", shall be present when EPS bit is set to 1. When present, it represents length of UE Radio Access Capability Information (EPS) field. + +The UE Radio Access Capability Information (EPS) field, when present, shall be encoded as an OctetString which contains the OCTET STRING of UE Radio Capability IE specified in clause 9.2.1.27 of 3GPP TS 36.413 [8]. + +Octets "p to (p+2)", shall be present when 5GS bit is set to 1. When present, it represents length of UE Radio Access Capability Information (5GS) field + +The UE Radio Access Capability Information (5GS) field, when present, shall be encoded as an OctetString which contains the OCTET STRING of UE Radio Capability IE specified in clause 9.3.1.74 of 3GPP TS 38.413 [11]. + +Octets "q to (q+2)", shall be present when EPSP bit is set to 1. When present, it represents length of UE Radio Access Capability Information for paging (EPS) field. + +The UE Radio Access Capability Information for paging (EPS) field, when present, shall be encoded as an OctetString which contains the OCTET STRING of UE Radio Capability IE specified in clause 9.2.1.98 of 3GPP TS 36.413 [8]. + +Octets "r to (r+2)", shall be present when 5GSP bit is set to 1. When present, it represents length of UE Radio Access Capability Information for paging (5GS) field + +The UE Radio Access Capability Information for paging (5GS) field, when present, shall be encoded as an OctetString which contains the OCTET STRING of UE Radio Capability IE specified in clause 9.3.1.68 of 3GPP TS 38.413 [11]. + +NOTE: Annex B of 3GPP TS 29.274 [9] specifies how to retrieve an OCTET STRING from a SIAP IE. + +### 8.2.7 Subscription Management Operation Type + +The Subscription Management Operation Type IE type shall be encoded as shown in Figure 8.2.7-1. The Subscription Management Operation Type indicates the intention for a Subscription Management Request message. + +![](55136bc716146672fc680fa05989f1d2_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|--------------------|---|---|---|----------------------------------------------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 7 (decimal) | | | | | | | | +| 3 to 4 | Length = 1 | | | | | | | | +| 5 | Spare | | | | Subscription Management Operation Type Value | | | | + +**Figure 8.2.7-1: Subscription Management Operation Type** + +The Subscription Management Operation Type value shall be encoded as a 4 bits binary integer as specified in Table 8.2.7-1. + +**Table 8.2.7-1: Subscription Management Operation Type value** + +| Subscription Management Operation Type | Values (Decimal) | +|----------------------------------------|------------------| +| Create a subscription | 0 | +| Delete a subscription | 1 | +| Spare | 2 to 15 | + +### 8.2.8 MME Address Information + +The MME Address Information IE type shall be encoded as shown in Figure 8.2.8-1. + +![](7728e2dd44c95d109debb1eb59e9b411_img.jpg) + +| Octets | Bits | | | | | | | | +|-------------|--------------------|---|---|---|------|----|----|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 8 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | Port | V4 | V6 | | +| m to (m+3) | IPv4 address | | | | | | | | +| p to (p+15) | IPv6 address | | | | | | | | +| q | Port Number | | | | | | | | + +**Figure 8.2.8-1: MME Address Information** + +The following flags are coded within Octet 5: + +- Bit 1 – V6: If this bit is set to "1", then the IPv6 address field shall be present, otherwise the IPv6 address field shall not be present. +- Bit 2 – V4: If this bit is set to "1", then the IPv4 address field shall be present, otherwise the IPv4 address field shall not be present. +- Bit 3 – Port: If this bit is set to "1", then the Port Number field shall be present, otherwise the IPv4 address field shall not be present. +- Bit 4 to 8 Spare, for future use and set to 0. + +Octets "m to (m+3)" or "p to (p+15)" (IPv4 address / IPv6 address fields), if present, shall contain the address value. + +Octet q, if present, shall contain the port number that the MME has allocated to receive the notifications. + +### 8.2.9 Subscription ID + +The Subscription ID IE is coded as in Figure 8.2.9-1. The Subscription ID identifies a subscription identifier created in the UCMF. + +![](24c9e038a791677ed33100667b64f7e6_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|---------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 10 (decimal) | | | | | | | | +| 3 to 4 | Length = 4 | | | | | | | | +| 5 to 8 | Subscription ID | | | | | | | | + +Figure 8.2.9-1: Subscription ID + +Octets 5 to 8 shall contain the Subscription ID and shall be encoded as an Unsigned32 binary integer value. + +### 8.2.10 Event Type + +The Event Type IE type shall be encoded as shown in Figure 8.2.10-1. The Event Type represents different type of events included in a notification from the UCMF. + +![](cad89c017c9e7c1785bcd104fde4e737_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|---------------------|---|---|---|------------------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 10 (decimal) | | | | | | | | +| 3 to 4 | Length = 1 | | | | | | | | +| 5 | Spare | | | | Event Type Value | | | | + +Figure 8.2.10-1: Event Type + +The Event Type value shall be encoded as a 4 bits binary integer as specified in Table 8.2.10-1. + +Table 8.2.10-1: Event Type value + +| Event Type Value | Values (Decimal) | +|-------------------------------------|------------------| +| CREATION_OF_DICTIONARY_ENTRY | 0 | +| DELETION_OF_PLMN_ASSIGNED_IDS | 1 | +| NEW_VERSION_ID_OF_PLMN_ASSIGNED_IDS | 3 | +| Spare | 4 to 15 | + +### 8.2.11 Recovery Time Stamp + +The Recovery Time Stamp IE is coded as shown in Figure 8.2.11-1. It indicates the UTC time when the URCMP entity started. Octets 5 to 8 are encoded in the same format as the first four octets of the 64-bit timestamp format as defined in clause 6 of IETF RFC 5905 [10]. + +NOTE: The encoding is defined as the time in seconds relative to 00:00:00 on 1 January 1900. + +![](d48a71a2e72db63c807a4c4ea8d82d2e_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|---------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 11 (decimal) | | | | | | | | +| 3 to 4 | Length = 4 | | | | | | | | +| 5 to 8 | Recovery Time Stamp value | | | | | | | | + +Figure 8.2.11-1: Recovery Time Stamp + +### 8.2.12 Version ID + +The Version ID IE is coded as in Figure 8.2.12-1. The Version Id included in a PLMN Assigned UE Radio Capability ID is specified as in clause 29.2 of 3GPP TS 23.003 [6]. + +| Octets | Bits | | | | | | | | +|--------|---------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 13 (decimal) | | | | | | | | +| 3 to 4 | Length = 1 | | | | | | | | +| 5 | Version ID | | | | | | | | + +Figure 8.2.12-1: Version Id + +Octets 5 to 8 shall contain the Version ID and shall be encoded as an Unsigned8 binary integer value. + +# Annex A (informative): Change history + +| Date | TSG # | TSG Doc. | CR | Rev | Cat | Subject/Comment | New | +|---------|---------|-----------|------|-----|-----|---------------------------------------------------------------------------------------------------|--------| +| 2019-09 | CT4#93 | C4-193850 | | | | Initial draft | 0.1.0 | +| 2019-10 | CT4#94 | C4-194243 | | | | Subscription management and Event Notification procedures | 0.2.0 | +| 2019-10 | CT4#94 | C4-194244 | | | | URCMP general protocol aspects | 0.2.0 | +| 2019-11 | CT4#95 | C4-195086 | | | | Messages and IEs for Create/Query Dictionary Entry Procedure | 0.3.0 | +| 2019-11 | CT4#95 | C4-195087 | | | | Messages and IEs for Subscription Management/Event Notification Procedure and Heartbeat procedure | 0.3.0 | +| 2019-12 | CT#86 | CP-193070 | | | | TS presented for information | 1.0.0 | +| 2019-12 | CT#86 | CP-193286 | | | | A title and abbreviation were updated/added | 1.0.1 | +| 2020-03 | CT4#96e | C4-200624 | | | | Event Notification for Deletion | 1.1.0 | +| 2020-03 | CT4#96e | C4-200625 | | | | Other alignment with stage 2 requirements and cleanup | 1.1.0 | +| 2020-03 | CT#87e | CP-200068 | | | | TS presented for approval | 2.0.0 | +| 2020-03 | CT#87e | | | | | Approved at CT#87e | 16.0.0 | +| 2020-06 | CT#88e | CP-201035 | 0001 | - | F | Destination Port used for URCMP Request messages | 16.1.0 | +| 2020-06 | CT#88e | CP-201035 | 0002 | 1 | F | Multiple Coding Formats Supports in RAC-Information | 16.1.0 | +| 2020-06 | CT#88e | CP-201035 | 0003 | - | F | New application error at receiving out-dated UE RAC-ID | 16.1.0 | +| 2020-06 | CT#88e | CP-201035 | 0004 | 1 | F | Populating New Version Id via Notification | 16.1.0 | +| 2020-09 | CT#89e | CP-202108 | 0005 | - | F | Correction to DicEntryData Retrieval | 16.2.0 | +| 2020-09 | CT#89e | CP-202108 | 0006 | - | F | UE Radio Capability ID retrieval | 16.2.0 | +| 2021-09 | CT#93e | CP-212065 | 0007 | 1 | F | Handling of UE Radio Capability for Paging | 16.3.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29675/18442e4e239480f0c3c95b547aa8fde2_img.jpg b/marked/Rel-16/29_series/29675/18442e4e239480f0c3c95b547aa8fde2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..61b0f76e35d53e148bbb6595b1f268df0404c1ba --- /dev/null +++ b/marked/Rel-16/29_series/29675/18442e4e239480f0c3c95b547aa8fde2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f703e1dd3623228d587d08d2d17223e9079b26d71ae9c8df5e92fb130199ae4b +size 32414 diff --git a/marked/Rel-16/29_series/29675/367926125450c2bc3f4bdca9d59a62ba_img.jpg b/marked/Rel-16/29_series/29675/367926125450c2bc3f4bdca9d59a62ba_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..455203128c7786b023beb8381e5011ad0e408155 --- /dev/null +++ b/marked/Rel-16/29_series/29675/367926125450c2bc3f4bdca9d59a62ba_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:903eefd62e083e5ed9fc96c6bf24c9a2543e1f69d17ae2b27caa0f8f98b912d6 +size 9832 diff --git a/marked/Rel-16/29_series/29675/63e0c22852c26699d0bd095a2d796bab_img.jpg b/marked/Rel-16/29_series/29675/63e0c22852c26699d0bd095a2d796bab_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..847f44d6bdd9a85d1b240d2afebe610db54cc0de --- /dev/null +++ b/marked/Rel-16/29_series/29675/63e0c22852c26699d0bd095a2d796bab_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:29c15d47be0db1114d463d0e67c8772e307c9523703c24e785fc4333233efa16 +size 32070 diff --git a/marked/Rel-16/29_series/29675/a26e142d3df5bef41a84a9dd099d7825_img.jpg b/marked/Rel-16/29_series/29675/a26e142d3df5bef41a84a9dd099d7825_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ab5bfc832fbbf05d48eece055a21d0ddf9263640 --- /dev/null +++ b/marked/Rel-16/29_series/29675/a26e142d3df5bef41a84a9dd099d7825_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:af4dbfc16794dd86f05c94df35ea6dbe5e461398ae08ec294856445e95fb74b6 +size 14802 diff --git a/marked/Rel-16/29_series/29675/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg b/marked/Rel-16/29_series/29675/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ffb1718f14e6477b5471c82176355f8afeef9cd0 --- /dev/null +++ b/marked/Rel-16/29_series/29675/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1bc4126633587b6bc96a914feaca35bc9f66cc246b0ad2e676f4c8ab77d9b6ea +size 10272 diff --git a/marked/Rel-16/29_series/29675/fc69ceb1dee1da7e33bd6c38fc4ceab9_img.jpg b/marked/Rel-16/29_series/29675/fc69ceb1dee1da7e33bd6c38fc4ceab9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..745776e72da0455d31523b772bcaeedf06d1dc55 --- /dev/null +++ b/marked/Rel-16/29_series/29675/fc69ceb1dee1da7e33bd6c38fc4ceab9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2c6587fac85fc8dc48099c63b9315e192add51c814736b75b04e720cab423fa4 +size 29733 diff --git a/marked/Rel-16/29_series/29675/raw.md b/marked/Rel-16/29_series/29675/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..26c590f4fc317a5a2bb0da35e15017b586f6b52d --- /dev/null +++ b/marked/Rel-16/29_series/29675/raw.md @@ -0,0 +1,1244 @@ + + + + +Error! No +text of + +Error! No text of specified style in +document. + +# Contents + +| | | +|-----------------------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions, symbols and abbreviations..... | 8 | +| 3.1 Definitions..... | 8 | +| 3.2 Symbols..... | 8 | +| 3.3 Abbreviations ..... | 8 | +| 4 UE Radio Capability Provisioning Service..... | 8 | +| 4.1 Service Description ..... | 8 | +| 4.1.1 Overview ..... | 8 | +| 4.1.2 Service Architecture ..... | 8 | +| 4.1.3 Network Functions ..... | 9 | +| 4.1.3.1 UCMF ..... | 9 | +| 4.1.3.2 NF Service Consumers ..... | 9 | +| 4.2 Service Operations ..... | 9 | +| 4.2.1 Introduction ..... | 9 | +| 4.2.2 Nucmf_Provisioning_Create service operation..... | 10 | +| 4.2.2.1 General..... | 10 | +| 4.2.2.2 Creating UE radio capability provisioning resource..... | 10 | +| 4.2.3 Nucmf_Provisioning_Update service operation..... | 11 | +| 4.2.3.1 General..... | 11 | +| 4.2.3.2 Modifying a UE radio capability provisioning resource ..... | 11 | +| 4.2.4 Nucmf_Provisioning_Delete service operation..... | 12 | +| 4.2.4.1 General..... | 12 | +| 4.2.4.2 Removing a UE radio capability provisioning resource..... | 12 | +| 5 Nucmf_Provisioning Service API..... | 13 | +| 5.1 Introduction ..... | 13 | +| 5.2 Usage of HTTP..... | 13 | +| 5.2.1 General ..... | 13 | +| 5.2.2 HTTP standard headers ..... | 13 | +| 5.2.2.1 General..... | 13 | +| 5.2.2.2 Content type ..... | 13 | +| 5.2.3 HTTP custom headers ..... | 13 | +| 5.3 Resources ..... | 14 | +| 5.3.1 Overview ..... | 14 | +| 5.3.2 Resource: UE radio capability provisionings (Collection)..... | 14 | +| 5.3.2.1 Description..... | 14 | +| 5.3.2.2 Resource Definition ..... | 14 | +| 5.3.2.3 Resource Standard Methods ..... | 14 | +| 5.3.2.3.1 POST ..... | 14 | +| 5.3.2.4 Resource Custom Operations..... | 15 | +| 5.3.3 Resource: Individual UE radio capability provisioning (Document)..... | 15 | +| 5.3.3.1 Description..... | 15 | +| 5.3.3.2 Resource Definition ..... | 15 | +| 5.3.3.3 Resource Standard Methods ..... | 16 | +| 5.3.3.3.1 GET ..... | 16 | +| 5.3.3.3.2 PUT ..... | 17 | +| 5.3.3.3.3 PATCH..... | 18 | +| 5.3.3.3.4 DELETE..... | 19 | +| 5.4 Custom Operations without associated resources ..... | 20 | +| 5.5 Notifications..... | 20 | +| 5.6 Data Model..... | 20 | +| 5.6.1 General ..... | 20 | +| 5.6.2 Structured data types ..... | 20 | +| 5.6.2.1 Introduction..... | 20 | +| 5.6.2.2 Type: RacsData..... | 20 | + +5.6.2.3 Type: RacsDataPatch..... 21 + +5.6.3 Simple data types and enumerations ..... 21 + +5.6.3.1 Introduction..... 21 + +5.6.3.2 Simple data types ..... 21 + +5.7 Error Handling..... 22 + +5.7.1 General ..... 22 + +5.7.2 Protocol Errors..... 22 + +5.7.3 Application Errors ..... 22 + +5.8 Feature negotiation..... 22 + +5.9 Security..... 22 + +**Annex A (normative): OpenAPI specification..... 23** + +A.1 General..... 23 + +A.2 Nucmf\_Provisioning API..... 23 + +Annex B (informative): Change history..... 28 + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, certain modal verbs have the following meanings: + +**shall** indicates a mandatory requirement to do something + +**shall not** indicates an interdiction (prohibition) to do something + +NOTE 1: The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +NOTE 2: The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +**should** indicates a recommendation to do something + +**should not** indicates a recommendation not to do something + +**may** indicates permission to do something + +**need not** indicates permission not to do something + +NOTE 3: The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +**can** indicates that something is possible + +**cannot** indicates that something is impossible + +NOTE 4: The constructions "can" and "cannot" shall not to be used as substitutes for "may" and "need not". + +**will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document + +**will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document + +**might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +NOTE 5: The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document specifies the stage 3 protocol and data model for the Nucmf Service Based Interface. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the UCMF. + +The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] OpenAPI: "OpenAPI 3.0.0 Specification", . +- [7] 3GPP TR 21.900: "Technical Specification Group working methods". +- [8] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [9] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [10] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". +- [11] IETF RFC 7540: "Hypertext Transfer Protocol Version 2 (HTTP/2)". +- [12] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [13] IETF RFC 7807: "Problem Details for HTTP APIs". +- [14] IETF RFC 3986: "Uniform Resource Identifier (URI): Generic Syntax". +- [15] 3GPP TS 29.122: "T8 reference point for northbound Application Programming Interfaces (APIs)". +- [16] IETF RFC 7396: "JSON Merge Patch". +- [17] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +## 3.2 Symbols + +No symbol is defined in the present document. + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|----------|--------------------------------------------| +| AF | Application Function | +| IMEI-TAC | Type Allocation Code part of an IMEI | +| NEF | Network Exposure Function | +| NF | Network Function | +| RACS | Radio Capabilities Signalling optimisation | +| UCMF | UE radio Capability Management Function | + +# --- 4 UE Radio Capability Provisioning Service + +## 4.1 Service Description + +### 4.1.1 Overview + +The UE radio capability provisioning service, as defined in 3GPP TS 23.502 [3], is provided by the UE radio Capability Management Function (UCMF). + +This service: + +- allows NF service consumers to create, update and delete UCMF dictionary entries for Manufacturer-assigned UE Radio Capability IDs. + +### 4.1.2 Service Architecture + +The Service Architecture is defined in 3GPP TS 23.501 [2]. + +The UE radio capability provisioning service (Nucmf\_Provisioning) is part of the Nucmf service-based interface exhibited by the UCMF. + +The known NF service consumers of the Nucmf\_Provisioning service are: + +- Network Exposure Function (NEF); and +- Application Function (AF). + +The Nucmf\_Provisioning service is provided by the UCMF and consumed by the NEF and the AF, as shown in figure 4.1.2-1 for the SBI representation model and in figure 4.1.2-2 for reference point representation model. + +![Nucmf_Provisioning service Architecture, SBI representation diagram](b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg) + +This diagram illustrates the SBI representation of the Nucmf\_Provisioning service architecture. At the top, a box labeled 'UCMF' contains a circle labeled 'Nucmf'. A vertical line labeled 'Nucmf\_Provisioning' descends from the 'Nucmf' circle to a horizontal line. From this horizontal line, two vertical lines descend to two separate boxes at the bottom, labeled 'AF' on the left and 'NEF' on the right. + +Nucmf\_Provisioning service Architecture, SBI representation diagram + +**Figure 4.1.2-1: Nucmf\_Provisioning service Architecture, SBI representation** + +![Nucmf_Provisioning service Architecture, reference point representation diagram](367926125450c2bc3f4bdca9d59a62ba_img.jpg) + +This diagram illustrates the reference point representation of the Nucmf\_Provisioning service architecture. At the top is a box labeled 'UCMF'. Below it are two boxes, 'AF' on the left and 'NEF' on the right. Diagonal lines connect the 'UCMF' box to both the 'AF' and 'NEF' boxes. Each diagonal line has a small horizontal tick mark near its connection to the 'AF' or 'NEF' box. + +Nucmf\_Provisioning service Architecture, reference point representation diagram + +**Figure 4.1.2-2: Nucmf\_Provisioning service Architecture, reference point representation** + +### 4.1.3 Network Functions + +#### 4.1.3.1 UCMF + +The UCMF is a functional element that provides service to the NF service consumer. + +It allows NF consumers to provision (create, update and delete) UCMF dictionary entries for Manufacturer-assigned UE Radio Capability IDs. + +#### 4.1.3.2 NF Service Consumers + +The Network Exposure Function (NEF): + +- Provision (create, update and delete) UCMF dictionary entries for Manufacturer-assigned UE Radio Capability IDs to the UCMF, if it receives the UE Radio Capability information from the untrusted AF. + +The Application Function (AF): + +- As the trusted AF, provision (create, update and delete) UCMF dictionary entries for Manufacturer-assigned UE Radio Capability IDs to the UCMF. + +## 4.2 Service Operations + +### 4.2.1 Introduction + +Service operations defined for the Nucmf\_Provisioning Service are shown in table 4.2.1-1. + +**Table 4.2.1-1: Nucmf\_Provisioning Service Operations** + +| Service Operation Name | Description | Initiated by | +|---------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------| +| Nucmf_Provisioning_Create | This service operation is used by an NF service consumer to create UE radio capability provisioning resource for Manufacturer-assigned UE Radio Capability IDs. | NF service consumer (AF, NEF) | +| Nucmf_Provisioning_Update | This service operation is used by an NF service consumer to modify UE radio capability provisioning resource for Manufacturer-assigned UE Radio Capability IDs. | NF service consumer (AF, NEF) | +| Nucmf_Provisioning_Delete | This service operation is used by an NF service consumer to remove a UE radio capability provisioning resource. | NF service consumer (AF, NEF) | + +### 4.2.2 Nucmf\_Provisioning\_Create service operation + +#### 4.2.2.1 General + +This service operation is used by an NF service consumer to create UE radio capability provisioning resource for Manufacturer-assigned UE Radio Capability IDs. + +The following procedure using the Nucmf\_Provisioning\_Create service operation is supported: + +- creating a UE radio capability provisioning resource. + +#### 4.2.2.2 Creating UE radio capability provisioning resource + +This procedure is used by the NF service consumer (e.g. NEF) to create a UE radio capability provisioning resource containing UCMF dictionary entries for Manufacturer-assigned UE Radio Capability IDs, as defined in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]. + +![Sequence diagram showing the interaction between an NF service consumer and the UCMF to create a new UE radio capability provisioning resource. Step 1: POST .../provisionings from NF service consumer to UCMF. Step 2: 201 Created response from UCMF to NF service consumer.](fc69ceb1dee1da7e33bd6c38fc4ceab9_img.jpg) + +``` + +sequenceDiagram + participant NF as NF service consumer + participant UCMF as UCMF + Note right of NF: 1. POST .../provisionings + NF->>UCMF: Request + Note left of UCMF: 2. "201 Created" + UCMF-->>NF: Response + +``` + +Sequence diagram showing the interaction between an NF service consumer and the UCMF to create a new UE radio capability provisioning resource. Step 1: POST .../provisionings from NF service consumer to UCMF. Step 2: 201 Created response from UCMF to NF service consumer. + +**Figure 4.2.2.2-1: Creating new UE radio capability provisioning resource** + +To create a UE radio capability provisioning resource, the NF service consumer shall send an HTTP POST request to the UCMF with: "{apiRoot}/nucmf-provisioning//provisionings" as request URI as shown in step 1 of figure 4.2.2.2-1, and the "RacsData" data structure as request body. The "RacsData" data type shall contain one or more RACS configurations in the "racsConfigs" attribute which include: + +- a RACS ID in the "racsId" attribute; +- UE radio capability information in the "racsParamEps" and/or "racsParam5Gs" attributes; and +- the related UE model(s) IMEI-TAC value(s) in the "imeiTacs" attribute. + +Upon reception of the HTTP POST message from the NF service consumer requesting to create UCMF dictionary entries, the UCMF shall, for each requested RACS ID, check if there is any existing dictionary entry having the same RACS ID. If yes, the UCMF shall indicate "RACS\_ID\_DUPLICATED" in the "result" attribute for the requested RACS ID; otherwise if there is no other error the UCMF shall create a UCMF dictionary entry. + +After processing all requested RACS IDs, if at least one UCMF dictionary entry is successfully provisioned, the UCMF shall create the resource "Individual UE radio capability provisioning" and respond "201 Created" as shown in step 2 of figure 4.2.2.2-1 with the successfully provisioned RACS information, the UCMF may include RACS report(s) within attribute "racsReports" with a list of RACS ID(s) and the corresponding failure code for which the provisioning has failed as specified in table 5.16.2.2.3-1 of 3GPP TS 29.122 [15] in the body of the HTTP response; otherwise the UCMF shall respond "500 Internal Server Error" and may include the RACS report(s) to indicate failure details. + +### 4.2.3 Nucmf\_Provisioning\_Update service operation + +#### 4.2.3.1 General + +This service operation is used by an NF service consumer to modify UE radio capability provisioning resource for Manufacturer-assigned UE Radio Capability IDs. + +The following procedure using the Nucmf\_Provisioning\_Update service operation is supported: + +- modifying an existing UE radio capability provisioning resource. + +#### 4.2.3.2 Modifying a UE radio capability provisioning resource + +![Sequence diagram showing the interaction between an NF service consumer and a UCMF to modify a UE radio capability provisioning resource. Step 1: The consumer sends a PUT or PATCH request to the UCMF. Step 2: The UCMF responds with a 200 OK status.](18442e4e239480f0c3c95b547aa8fde2_img.jpg) + +``` + +sequenceDiagram + participant NF as NF service consumer + participant UCMF as UCMF + Note right of NF: 1. PUT or PATCH .../provisionings/{provisioningId} + NF->>UCMF: Request + Note left of UCMF: 2. "200 OK" + UCMF-->>NF: Response + +``` + +Sequence diagram showing the interaction between an NF service consumer and a UCMF to modify a UE radio capability provisioning resource. Step 1: The consumer sends a PUT or PATCH request to the UCMF. Step 2: The UCMF responds with a 200 OK status. + +**Figure 4.2.3.2-1: Modifying a UE radio capability provisioning resource** + +In order to modify a UE radio capability provisioning resource, i.e. add new UCMF dictionary entries, update and/or remove the existing UCMF dictionary entries for one or more RACS ID(s), the NF service consumer shall send an HTTP PUT or PATCH request to the UCMF with: "{apiRoot}/nucmf-provisioning//provisionings/{provisioningId}" as request URI as shown in step 1 of figure 4.2.3.2-1, and the "RacsData" or "RacsDataPatch" data structure as request body, correspondingly. The "RacsData" or "RacsDataPatch" data type shall contain one or more RACS configurations in the "racsConfigs" attribute which include: + +- a RACS ID in the "racsId" attribute; +- UE radio capability information in the "racsParamEps" and/or "racsParam5Gs" attributes; and +- the related UE model(s) IMEI-TAC value(s) in the "imeiTacs" attribute. + +Upon reception of the HTTP PUT message from the NF service consumer, the UCMF shall start replacing the existing UE radio capability provisioning resource and update the corresponding UCMF dictionary entr(ies). + +Upon reception of the HTTP PATCH message from the NF service consumer, the UCMF shall start modifying the existing UE radio capability provisioning resource: + +- remove RACS ID and its UE radio capability information with a NULL map key value, and the corresponding UCMF dictionary entry; +- replace the UE radio capability information for any existing RACS ID in the resource, and the corresponding UCMF dictionary entry; and/or +- create a UCMF dictionary entry for any new RACS ID if there is no ID conflict with other existing resources. + +After processing all requested RACS IDs, if at least one UCMF dictionary entry is successfully provisioned, the UCMF shall respond "200 OK" as shown in step 2 of figure 4.2.3.2-1 with the successfully provisioned RACS information, the UCMF may include RACS report(s) within attribute "racsReports" with a list of RACS ID(s) and the corresponding failure code for which the provisioning has failed as specified in table 5.16.2.2.3-1 of 3GPP TS 29.122 [15] in the body of the HTTP response; otherwise the UCMF shall respond "500 Internal Server Error" and may include the RACS report(s) to indicate failure details. + +If the feature "ES3XX" is supported, and the UCMF determines the received HTTP PUT or PATCH request needs to be redirected, the UCMF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +### 4.2.4 Nucmf\_Provisioning\_Delete service operation + +#### 4.2.4.1 General + +This service operation is used by an NF service consumer to remove UE radio capability provisioning resource for Manufacturer-assigned UE Radio Capability IDs. + +The following procedure using the Nucmf\_Provisioning\_Delete service operation is supported: + +- removing an existing UE radio capability provisioning resource. + +#### 4.2.4.2 Removing a UE radio capability provisioning resource + +![Sequence diagram showing the interaction between an NF service consumer and a UCMF to remove a UE radio capability provisioning resource. Step 1: The consumer sends a DELETE request to the UCMF. Step 2: The UCMF responds with a 204 No Content status.](63e0c22852c26699d0bd095a2d796bab_img.jpg) + +``` +sequenceDiagram + participant NF as NF service consumer + participant UCMF as UCMF + Note right of NF: 1. DELETE .../provisionings/{provisioningId} + NF->>UCMF: Request + Note left of UCMF: 2. "204 No Content" + UCMF-->>NF: Response +``` + +Sequence diagram showing the interaction between an NF service consumer and a UCMF to remove a UE radio capability provisioning resource. Step 1: The consumer sends a DELETE request to the UCMF. Step 2: The UCMF responds with a 204 No Content status. + +**Figure 4.2.4.2-1: Removing a UE radio capability provisioning resource** + +In order to remove a UE radio capability provisioning resource, the NF service consumer shall send an HTTP DELETE request to the UCMF with: "{apiRoot}/nucmf-provisioning//provisionings/{provisioningId}" as request URI as shown in step 1 of figure 4.2.4.2-1. + +Upon successful reception of the HTTP DELETE, the UCMF shall remove the corresponding resource and the corresponding UCMF dictionary entries, and send an HTTP "204 No Content" response as shown in step 2 of figure 4.2.4.2-1. + +If the UCMF cannot successfully fulfil the received HTTP DELETE request due to the internal error or the error in the HTTP DELETE request, the UCMF shall send the HTTP error response as specified in clause 5.7. + +If the feature "ES3XX" is supported, and the UCMF determines the received HTTP DELETE request needs to be redirected, the UCMF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +# 5 Nucmf\_Provisioning Service API + +## 5.1 Introduction + +The UE radio capability provisioning service shall use the Nucmf\_Provisioning API. + +The API URI of the Nucmf\_Provisioning API shall be: + +**{apiRoot}
//** + +The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}//** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nucmf-provisioning". +- The shall be "v1". +- The shall be set as described in clause 5.3. + +## 5.2 Usage of HTTP + +### 5.2.1 General + +HTTP/2, IETF RFC 7540 [11], shall be used as specified in clause 5.2 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +The OpenAPI [6] specification of HTTP messages and content bodies for the Nucmf\_Provisioning API is contained in Annex A. + +### 5.2.2 HTTP standard headers + +#### 5.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers. + +#### 5.2.2.2 Content type + +JSON, IETF RFC 8259 [12], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [4]. The use of the JSON format shall be signalled by the content type "application/json". + +JSON object used in the HTTP PATCH request shall be encoded according to "JSON Merge Patch" and shall be signalled by the content type "application/merge-patch+json", as defined in IETF RFC 7396 [16]. + +"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 7807 [13]. + +### 5.2.3 HTTP custom headers + +The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] shall be applicable. + +In this Release of the specification, no specific custom headers are defined for the Nucmf\_Provisioning API. + +## 5.3 Resources + +### 5.3.1 Overview + +![Figure 5.3.1-1: Resource URI structure of the Nucmf_Provisioning API. The diagram shows a hierarchical tree structure starting with {apiRoot}/nucmf-provisioning/. A line branches down to a box containing /provisionings. From this box, another line branches down to a box containing /{provisioningId}.](a26e142d3df5bef41a84a9dd099d7825_img.jpg) + +``` + +graph TD + Root["{apiRoot}/nucmf-provisioning/"] --> Provisionings["/provisionings"] + Provisionings --> ProvisioningId["/{provisioningId}"] + +``` + +Figure 5.3.1-1: Resource URI structure of the Nucmf\_Provisioning API. The diagram shows a hierarchical tree structure starting with {apiRoot}/nucmf-provisioning/. A line branches down to a box containing /provisionings. From this box, another line branches down to a box containing /{provisioningId}. + +**Figure 5.3.1-1: Resource URI structure of the Nucmf\_Provisioning API** + +Table 5.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 5.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|---------------------------------------------|---------------------------------|---------------------------------|---------------------------------------------------------------| +| UE radio capability provisionings | /provisionings | POST | Create a UE radio capability provisioning resource. | +| Individual UE radio capability provisioning | /provisionings/{provisioningId} | GET | Read an existing UE radio capability provisioning resource. | +| | | PUT | Modify an existing UE radio capability provisioning resource. | +| | | PATCH | Modify an existing UE radio capability provisioning resource. | +| | | DELETE | Remove an existing UE radio capability provisioning resource. | + +### 5.3.2 Resource: UE radio capability provisionings (Collection) + +#### 5.3.2.1 Description + +The UE radio capability provisionings resource represents all the provisionings that exist in the UE radio capability provisioning service at a given UCMF instance. + +#### 5.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nucmf-provisioning//provisionings + +This resource shall support the resource URI variables defined in table 5.3.2.2-1. + +**Table 5.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|------------|-----------|-----------------| +| apiRoot | string | See clause 5.1. | +| apiVersion | string | See clause 5.1. | + +#### 5.3.2.3 Resource Standard Methods + +##### 5.3.2.3.1 POST + +This method shall support the URI query parameters specified in table 5.3.2.3.1-1. + +**Table 5.3.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 5.3.2.3.1-2 and the response data structures and response codes specified in table 5.3.2.3.1-3. + +**Table 5.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|---------------------------------------------------------------------------------------------------| +| RacsData | M | 1 | Contains information for the creation of an Individual UE radio capability provisioning resource. | + +**Table 5.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------------------------------------------------|---|-------------|---------------------------|-----------------------------------------------------------------------------------------------------------------------------------------| +| RacsData | M | 1 | 201 Created | The creation of an Individual UE radio capability provisioning resource is confirmed and a representation of that resource is returned. | +| array(RacsFailureReport) | M | 1..N | 500 Internal Server Error | The RACS data for all RACS IDs were not provisioned successfully. | +| NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +**Table 5.3.2.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure: {apiRoot}/nucmf-provisioning//provisionings/{provisioningId} | + +#### 5.3.2.4 Resource Custom Operations + +None. + +### 5.3.3 Resource: Individual UE radio capability provisioning (Document) + +#### 5.3.3.1 Description + +The Individual UE radio capability provisioning resource represents a single provisioning that exist in the UE radio capability provisioning service at a given UCMF instance. + +#### 5.3.3.2 Resource Definition + +Resource URI: {apiRoot}/nucmf-provisioning//provisionings/{provisioningId} + +This resource shall support the resource URI variables defined in table 5.3.3.2-1. + +**Table 5.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------------|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 5.1. | +| apiVersion | string | See clause 5.1. | +| provisioningId | string | Identifies the individual UE radio capability resource in the UCMF. To enable the value to be used as part of a URI, the string shall only contain allowed characters according to the "lower-with-hyphen" naming convention defined in clause 5.1.3 of 3GPP TS 29.501 [5] and rules for a path segment defined in IETF RFC 3986 [14]. | + +#### 5.3.3.3 Resource Standard Methods + +##### 5.3.3.3.1 GET + +This method shall support the URI query parameters specified in table 5.3.3.3.1-1. + +**Table 5.3.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 5.3.3.3.1-2 and the response data structures and response codes specified in table 5.3.3.3.1-3. + +**Table 5.3.3.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.3.3.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| RacsData | M | 1 | 200 OK | A representation of an Individual UE radio capability provisioning resource is returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative UCMF (service) instance. Applicable if the feature "ES3XX" is supported. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative UCMF (service) instance. Applicable if the feature "ES3XX" is supported. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +**Table 5.3.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative UCMF (service) instance. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the request is redirected. | + +**Table 5.3.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative UCMF (service) instance. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the request is redirected. | + +##### 5.3.3.3.2 PUT + +This method shall support the URI query parameters specified in table 5.3.3.3.2-1. + +**Table 5.3.3.3.2-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 5.3.3.3.2-2 and the response data structures and response codes specified in table 5.3.3.3.2-3. + +**Table 5.3.3.3.2-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-----------------------------------------------------------------------------------| +| RacsData | M | 1 | Contains the modification of an Individual UE radio capability provisioning data. | + +**Table 5.3.3.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------------|---|-------------|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| RacsData | M | 1 | 200 OK | The Individual UE radio capability provisioning resource is modified and a representation of that resource is returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative UCMF (service) instance.
Applicable if the feature "ES3XX" is supported. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative UCMF (service) instance.
Applicable if the feature "ES3XX" is supported. | +| array(RacsFailureReport) | M | 1..N | 500 Internal Server Error | The RACS data for all RACS IDs were not provisioned successfully. | + +NOTE: The mandatory HTTP error status codes for the PUT method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +**Table 5.3.3.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative UCMF (service) instance. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the request is redirected. | + +**Table 5.3.3.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative UCMF (service) instance. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the request is redirected. | + +##### 5.3.3.3.3 PATCH + +This method shall support the URI query parameters specified in table 5.3.3.3.3-1. + +**Table 5.3.3.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 5.3.3.3.3-2 and the response data structures and response codes specified in table 5.3.3.3.3-3. + +**Table 5.3.3.3.3-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------|---|-------------|-----------------------------------------------------------------------------------| +| RacsDataPatch | M | 1 | Contains the modification of an Individual UE radio capability provisioning data. | + +**Table 5.3.3.3.3-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------------|---|-------------|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| RacsData | M | 1 | 200 OK | The Individual UE radio capability provisioning resource is modified and a representation of that resource is returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative UCMF (service) instance.
Applicable if the feature "ES3XX" is supported. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative UCMF (service) instance.
Applicable if the feature "ES3XX" is supported. | +| array(RacsFailureReport) | M | 1..N | 500 Internal Server Error | The RACS data for all RACS IDs were not provisioned successfully. | + +NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +**Table 5.3.3.3.3-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative UCMF (service) instance. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the request is redirected. | + +**Table 5.3.3.3.3-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative UCMF (service) instance. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the request is redirected. | + +##### 5.3.3.3.4 DELETE + +This method shall support the URI query parameters specified in table 5.3.3.3.4-1. + +**Table 5.3.3.3.4-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 5.3.3.3.4-2 and the response data structures and response codes specified in table 5.3.3.3.4-3. + +**Table 5.3.3.3.4-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.3.3.3.4-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The Individual UE radio capability resource was successfully removed. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during resource removal. The response shall include a Location header field containing an alternative URI of the resource located in an alternative UCMF (service) instance. Applicable if the feature "ES3XX" is supported. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during resource removal. The response shall include a Location header field containing an alternative URI of the resource located in an alternative UCMF (service) instance. Applicable if the feature "ES3XX" is supported. | + +NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +**Table 5.3.3.3.4-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative UCMF (service) instance. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the request is redirected. | + +**Table 5.3.3.3.4-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative UCMF (service) instance. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the request is redirected. | + +## 5.4 Custom Operations without associated resources + +No custom operation is defined in this Release of the specification. + +## 5.5 Notifications + +Notifications are not applicable for the current Release. + +## 5.6 Data Model + +### 5.6.1 General + +This clause specifies the application data model supported by the API. + +Table 5.6-1 specifies the data types defined for the Nucmf\_Provisioning service based interface protocol. + +**Table 5.6-1: Nucmf\_Provisioning specific Data Types** + +| Data type | Section defined | Description | Applicability | +|---------------|-----------------|--------------------------------------------|---------------| +| RacsData | 5.6.2.2 | UE radio capability data | | +| RacsDataPatch | 5.6.2.3 | UE radio capability data for PATCH request | | + +Table 5.6-2 specifies data types re-used by the Nucmf\_Provisioning service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nucmf\_Provisioning service based interface. + +**Table 5.6-2: Nucmf\_Provisioning re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|---------------------|---------------------|---------------------------------------------------------------------------------------|----------------------| +| ProblemDetails | 3GPP TS 29.571 [17] | Used in error responses to provide more detailed information about an error. | | +| RacsConfiguration | 3GPP TS 29.122 [15] | Represents the UE radio capability data configuration. | | +| RacsConfigurationRm | 3GPP TS 29.122 [15] | Represents the UE radio capability data configuration with "nullable: true" property. | | +| RacsFailureReport | 3GPP TS 29.122 [15] | Represents the report for UE radio capability data provisioning. | | +| RedirectResponse | 3GPP TS 29.571 [17] | Contains redirection related information. | ES3XX | +| SupportedFeatures | 3GPP TS 29.571 [17] | Used to negotiate the applicability of the optional features defined in table 5.8-1. | | + +### 5.6.2 Structured data types + +#### 5.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +#### 5.6.2.2 Type: RacsData + +This type represents a UE radio capability data provided by the NF service consumer to the UCMF. + +**Table 5.6.2.2-1: Definition of type RacsData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------|------------------------|----------|--------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| suppFeat | SupportedFeatures | C | 0..1 | Used to negotiate the supported optional features of the API as described in clause 5.2.7. This attribute shall be provided in the POST request and in the response of successful resource creation. | | +| racsConfigs | map(RacsConfiguration) | M | 1..N | Identifies the configuration related to manufacturer specific UE radio capability. Each element uniquely identifies an RACS configuration for an RACS ID and is identified in the map via the RACS ID as key. The response shall include successfully provisioned RACS data. | | +| racsReports | map(RacsFailureReport) | O | 1..N | Supplied by the UCMF. Contains the RACS IDs for which the RACS data are not provisioned successfully. | | + +#### 5.6.2.3 Type: RacsDataPatch + +This type represents a UE radio capability data provided by the NF service consumer to the UCMF. + +**Table 5.6.2.3-1: Definition of type RacsDataPatch** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| racsConfigs | map(RacsConfigurationRm) | O | 1..N | Identifies the configuration related to manufacturer specific UE radio capability. Each element uniquely identifies an RACS configuration for an RACS ID and is identified in the map via the RACS ID as key. | | + +### 5.6.3 Simple data types and enumerations + +#### 5.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +#### 5.6.3.2 Simple data types + +The simple data types defined in table 5.6.3.2-1 shall be supported. + +**Table 5.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| | | | | + +## 5.7 Error Handling + +### 5.7.1 General + +For the Nucmf\_Provisioning API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [4] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [4]. + +In addition, the requirements in the following clauses are applicable for the Nucmf\_Provisioning API. + +### 5.7.2 Protocol Errors + +No specific procedures for the Nucmf\_Provisioning service are specified. + +### 5.7.3 Application Errors + +The application errors defined for the Nucmf\_Provisioning service are listed in table 5.7.3-1. + +**Table 5.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|------------------|-------------| +| | | | + +## 5.8 Feature negotiation + +The optional features in table 5.8-1 are defined for the Nucmf\_Provisioning API. They shall be negotiated using the extensibility mechanism defined in clause 6.6.2 of 3GPP TS 29.500 [4]. + +**Table 5.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | ES3XX | Extended Support for 3xx redirections. This feature indicates the support of redirection for any service operation, according to Stateless NF procedures as specified in clauses 6.5.3.2 and 6.5.3.3 of 3GPP TS 29.500 [4] and according to HTTP redirection principles for indirect communication, as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. | + +## 5.9 Security + +As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Nucmf\_Provisioning API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [9]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [10]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nucmf\_Provisioning API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [10], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nucmf\_Provisioning service. + +The Nucmf\_Provisioning API defines a single scope "nucmf-provisioning" for the entire service, and it does not define any additional scopes at resource or operation level. + +# Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex specifies the formal definition of the API(s) defined in the present specification. It consists of OpenAPI 3.0.0 specifications in YAML format. + +This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository that uses the GitLab software version control system (see clause 5B of the 3GPP TR 21.900 [7] for further information) and clause 5.3.1 of the 3GPP TS 29.501 [5]. + +## A.2 Nucmf\_Provisioning API + +``` +openapi: 3.0.0 +info: + title: Nucmf_Provisioning + version: 1.0.1 + description: | + UCMF_Provisioning Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 29.675 V16.5.0; User Equipment (UE) radio capability provisioning service; + Stage 3. + url: http://www.3gpp.org/ftp/Specs/archive/29_series/29.675/ +servers: + - url: '{apiRoot}/nucmf-provisioning/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 +security: + - {} + - oAuth2ClientCredentials: + - nucmf-provisioning +paths: + /provisionings: + post: + summary: Create an Individual UE radio capability provisioning + operationId: CreateProvisioning + tags: + - UE radio capability provisionings (Collection) + requestBody: + description: create new provisionings for a given SCS/AS. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/RacsData' + responses: + '201': + description: Created. The creation of an Individual UE radio capability provisioning + resource is confirmed and a representation of that resource is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/RacsData' + headers: + Location: + description: 'Contains the URI of the newly created resource' + required: true +``` + +``` + + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + description: The RACS data for all RACS IDs were not provisioned successfully. + content: + application/json: + schema: + type: array + items: + $ref: +'TS29122_RacsParameterProvisioning.yaml#/components/schemas/RacsFailureReport' + minItems: 1 + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + /provisionings/{provisioningId}: + parameters: + - name: provisioningId + in: path + description: Provisioning ID + required: true + schema: + type: string + get: + summary: Get an Individual UE radio capability provisioning + operationId: GetProvisioning + tags: + - Individual UE radio capability provisioning (Document) + responses: + '200': + description: OK. The provisioning information related to the request URI is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/RacsData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + patch: + +``` + +``` + +summary: Update (PATCH) an Individual UE radio capability provisioning +operationId: UpdateProvisioning +tags: + - Individual UE radio capability provisioning (Document) +requestBody: + description: update an existing parameter provisioning. + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/RacsDataPatch' +responses: + '200': + description: OK. The Individual UE radio capability provisioning resource is modified and +a representation of that resource is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/RacsData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + description: The RACS data for all RACS IDs were not provisioned successfully. + content: + application/json: + schema: + type: array + items: + $ref: 'TS29122_RacsParameterProvisioning.yaml#/components/schemas/RacsFailureReport' + minItems: 1 + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +put: + summary: Replace (PUT) an Individual UE radio capability provisioning + operationId: ReplaceProvisioning + tags: + - Individual UE radio capability provisioning (Document) + requestBody: + description: update an existing parameter provisioning. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/RacsData' + responses: + '200': + description: OK. The Individual UE radio capability provisioning resource is modified and +a representation of that resource is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/RacsData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + +``` + +``` + + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + description: The RACS data for all RACS IDs were not provisioned successfully. + content: + application/json: + schema: + type: array + items: + $ref: + 'TS29122_RacsParameterProvisioning.yaml#/components/schemas/RacsFailureReport' + minItems: 1 + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +delete: + summary: Remove an Individual UE radio capability provisioning + operationId: RemoveProvisioning + tags: + - Individual UE radio capability provisioning (Document) + responses: + '204': + description: No Content. The Individual UE radio capability resource was successfully +removed. The payload body shall be empty. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: + nucmf-provisioning: Access to the Nucmf_Provisioning API +schemas: + RacsData: + description: Represents a UE radio capability data provided by the NF service consumer. + type: object + properties: + +``` + +``` +suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +racsConfigs: + type: object + additionalProperties: + $ref: 'TS29122_RacsParameterProvisioning.yaml#/components/schemas/RacsConfiguration' + minProperties: 1 + description: Identifies the configuration related to manufacturer specific UE radio +capability. Each element uniquely identifies an RACS configuration for an RACS ID and is identified +in the map via the RACS ID as key. The response shall include successfully provisioned RACS data. +racsReports: + type: object + additionalProperties: + $ref: 'TS29122_RacsParameterProvisioning.yaml#/components/schemas/RacsFailureReport' + minProperties: 1 + description: Contains the RACS IDs for which the RACS data are not provisioned +successfully. The failure reason is also included. + readOnly: true +required: +- racsConfigs +RacsDataPatch: + description: > + Represents a modification of a UE radio capability data provided by the NF service. + type: object + properties: + racsConfigs: + type: object + additionalProperties: + $ref: 'TS29122_RacsParameterProvisioning.yaml#/components/schemas/RacsConfigurationRm' + minProperties: 1 + description: Identifies the configuration related to manufacturer specific UE radio +capability. Each element uniquely identifies an RACS configuration for an RACS ID and is identified +in the map via the RACS ID as key. +``` + +# Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2019-06 | | | | | | TS skeleton of UE Radio Capability Provisioning Service | 0.0.0 | +| 2019-09 | | | | | | Includes pCRs agreed in CT3#105:
C3-193417, C3-193594, C3-193648. | 0.1.0 | +| 2019-10 | | | | | | Includes pCRs agreed in CT3#106:
C3-194435. | 0.2.0 | +| 2019-11 | | | | | | Rapporteur changes:
- fill in the referred clause number of TS 29.122 in clauses 4.2.2.2 and 4.2.3.2.
- correct the TS version in externalDocs and step the openAPI file version. | 0.3.0 | +| 2019-12 | | | | | | Sent to plenary for information. | 1.0.0 | +| 2020-03 | | | | | | Includes pCRs agreed in CT3#108-e:
C3-201197. | 1.1.0 | +| 2020-03 | CT#87e | CP-200189 | | | | TS sent to plenary for approval | 2.0.0 | +| 2020-03 | CT#87e | CP-200189 | | | | TS approved by plenary | 16.0.0 | +| 2020-06 | CT#88e | CP-201243 | 0003 | - | F | Correcting errors in clause 5.6 | 16.1.0 | +| 2020-06 | CT#88e | CP-201244 | 0004 | 1 | F | Storage of YAML files in ETSI Forge | 16.1.0 | +| 2020-06 | CT#88e | CP-201243 | 0002 | 1 | F | Update to UE radio capability information data type | 16.1.0 | +| 2020-06 | CT#88e | CP-201189 | 0001 | 3 | F | Addition of IMEI-TAC values for RACS operations | 16.1.0 | +| 2020-06 | CT#88e | CP-201190 | 0006 | 1 | F | Avoid using the same data type for PUT and PATCH | 16.1.0 | +| 2020-06 | CT#88e | CP-201256 | 0005 | 1 | F | URI of the Nucmf_Provisioning service | 16.1.0 | +| 2020-06 | CT#88e | CP-201243 | 0007 | 1 | F | Correct OpenAPI scope | 16.1.0 | +| 2020-06 | CT#88e | CP-201243 | 0008 | 1 | F | Supported headers, Resource Data type and yaml mapping | 16.1.0 | +| 2020-06 | CT#88e | CP-201255 | 0009 | | F | Update of OpenAPI version and TS version in externalDocs field | 16.1.0 | +| 2020-09 | CT#89e | CP-202072 | 0011 | | F | Resource correction | 16.2.0 | +| 2020-12 | CT#90e | CP-203139 | 0013 | | F | Essential corrections and alignments | 16.3.0 | +| 2020-12 | CT#90e | CP-203139 | 0015 | 1 | F | Storage of YAML files in ETSI Forge | 16.3.0 | +| 2020-12 | CT#90e | CP-203136 | 0017 | | F | Correct UCMF id | 16.3.0 | +| 2021-09 | CT#93e | CP-212218 | 0026 | | F | Correcting resource definitions | 16.4.0 | +| 2023-03 | CT#99e | CP-230126 | 0035 | | F | Support of temporary and permanent redirections | 16.5.0 | +| 2023-03 | CT#99e | CP-230159 | 0038 | | F | Update of info and externalDocs fields | 16.5.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29827/1a827b10290f33d4fec04d0e8ef7a897_img.jpg b/marked/Rel-16/29_series/29827/1a827b10290f33d4fec04d0e8ef7a897_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..fad2c6af9011469ddb1eeff2190123760511d26e --- /dev/null +++ b/marked/Rel-16/29_series/29827/1a827b10290f33d4fec04d0e8ef7a897_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:efbe0464f0c877dd12e1cba15105730a6cd5c004e631c49697d2545c9fc9941b +size 70662 diff --git a/marked/Rel-16/29_series/29827/21d8ca19de468e733e521605b1890767_img.jpg b/marked/Rel-16/29_series/29827/21d8ca19de468e733e521605b1890767_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..211fd9c64b3df0b43184b221b0e519b7802fbce9 --- /dev/null +++ b/marked/Rel-16/29_series/29827/21d8ca19de468e733e521605b1890767_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8b86ebed4f37a16052cc9eab5133055b024733d5e5b9e5abea5f3dd8726827e9 +size 71048 diff --git a/marked/Rel-16/29_series/29827/26d664119ad25250780f554633444e54_img.jpg b/marked/Rel-16/29_series/29827/26d664119ad25250780f554633444e54_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3f0ffe7aadf43076e57cc0b8fd1bd0909025da57 --- /dev/null +++ b/marked/Rel-16/29_series/29827/26d664119ad25250780f554633444e54_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bfa578509bc2ea7543b5f177fa253701802ad51dcc58dfe8a38a1249ed5cf3d5 +size 69525 diff --git a/marked/Rel-16/29_series/29827/27b06ec9f42b5d727a2630f61a5f1861_img.jpg b/marked/Rel-16/29_series/29827/27b06ec9f42b5d727a2630f61a5f1861_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e81e0ad029ca9cdcbc5d5c0a9dce3556ad5869f6 --- /dev/null +++ b/marked/Rel-16/29_series/29827/27b06ec9f42b5d727a2630f61a5f1861_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3b9d0850575fd5cc1f85161437e5e1fa7444c8fbcdf74f283c406f2e8b3e2946 +size 179744 diff --git a/marked/Rel-16/29_series/29827/5a4e62bead259c258d069fd3663ea670_img.jpg b/marked/Rel-16/29_series/29827/5a4e62bead259c258d069fd3663ea670_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..cfefebc503bc8106665d415d9969b705aaad9818 --- /dev/null +++ b/marked/Rel-16/29_series/29827/5a4e62bead259c258d069fd3663ea670_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8f7a457ba57bdc8f9f9dd19ecf58fdb9b89de74858f5d83c8ae063ab45ca3786 +size 225181 diff --git a/marked/Rel-16/29_series/29827/7efae06af3af43ffe5d4b956a679cf54_img.jpg b/marked/Rel-16/29_series/29827/7efae06af3af43ffe5d4b956a679cf54_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e95d1530b14a607cbb29f7aa47f5937cfcf411fb --- /dev/null +++ b/marked/Rel-16/29_series/29827/7efae06af3af43ffe5d4b956a679cf54_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e1c95c44a79cddc08430259739f63659bf08b763e66ec8c8b8a9ab6434f39d5c +size 98193 diff --git a/marked/Rel-16/29_series/29827/81a4cbf0b3c4cbc065efdf8f800dadde_img.jpg b/marked/Rel-16/29_series/29827/81a4cbf0b3c4cbc065efdf8f800dadde_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..df5115b0f8740c1c1d44f42aa27cf8d70a0707a0 --- /dev/null +++ b/marked/Rel-16/29_series/29827/81a4cbf0b3c4cbc065efdf8f800dadde_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:88c46322d796d127f045f3f426a97f2118428d2eec67461d2c67ee92df85bcc3 +size 125853 diff --git a/marked/Rel-16/29_series/29827/8307f6b04df072c9332f9987e034272c_img.jpg b/marked/Rel-16/29_series/29827/8307f6b04df072c9332f9987e034272c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3433a6056fed1cb6bcb989f713b31401e3d9ec5b --- /dev/null +++ b/marked/Rel-16/29_series/29827/8307f6b04df072c9332f9987e034272c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a46f83b25a69a036a596e2146015fcf9d9ab59a68b808a925cb74c94fb77f1c3 +size 100858 diff --git a/marked/Rel-16/29_series/29827/8fa679f79a1bb1f527cba9f29e784e89_img.jpg b/marked/Rel-16/29_series/29827/8fa679f79a1bb1f527cba9f29e784e89_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..611229583f6023e4d9e928f831b8dcf983c160e9 --- /dev/null +++ b/marked/Rel-16/29_series/29827/8fa679f79a1bb1f527cba9f29e784e89_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7f2a59c4b837a9ce1d172fea18393b1f2c6555add99e2523fa7b47a00d0fd3b0 +size 121208 diff --git a/marked/Rel-16/29_series/29827/997233d405f0d4b89ddeb7683e047f66_img.jpg b/marked/Rel-16/29_series/29827/997233d405f0d4b89ddeb7683e047f66_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a003739b3fca02028afd5e68f65d8425afe51f84 --- /dev/null +++ b/marked/Rel-16/29_series/29827/997233d405f0d4b89ddeb7683e047f66_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1efae3f8351d63c7a7279ae554f5f063750e0b6cc7f02775bf75b96b277115f9 +size 110538 diff --git a/marked/Rel-16/29_series/29827/9c1d3678db4a12d5864cb2a4def1135d_img.jpg b/marked/Rel-16/29_series/29827/9c1d3678db4a12d5864cb2a4def1135d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..75fe415b51f3f0f0c2bacd9791ff296a769416e4 --- /dev/null +++ b/marked/Rel-16/29_series/29827/9c1d3678db4a12d5864cb2a4def1135d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ac1899658327cf086b999d4ee623883ee8ff6d8bd72be0340acd141aade03b1c +size 81620 diff --git a/marked/Rel-16/29_series/29827/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg b/marked/Rel-16/29_series/29827/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e95d1530b14a607cbb29f7aa47f5937cfcf411fb --- /dev/null +++ b/marked/Rel-16/29_series/29827/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e1c95c44a79cddc08430259739f63659bf08b763e66ec8c8b8a9ab6434f39d5c +size 98193 diff --git a/marked/Rel-16/29_series/29827/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg b/marked/Rel-16/29_series/29827/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..285f1a0c9efc5765a62c21598af71bff9aad99a6 --- /dev/null +++ b/marked/Rel-16/29_series/29827/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b53e2d085a8bd98aa019e848ae8c613a603d029b2cd45bb514b7bec60eb7ee14 +size 133416 diff --git a/marked/Rel-16/29_series/29827/cab0834804fb031b43865554cc8d06ab_img.jpg b/marked/Rel-16/29_series/29827/cab0834804fb031b43865554cc8d06ab_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..acd93fd4a75520bf79b9c88777d7499e5112812d --- /dev/null +++ b/marked/Rel-16/29_series/29827/cab0834804fb031b43865554cc8d06ab_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:62bc9b6f6f6c31c9787f1a8c9bf39a5f617d409814500e84f86851ccd0b97a79 +size 68862 diff --git a/marked/Rel-16/29_series/29827/d0abac95583b52a3b35f74a215567334_img.jpg b/marked/Rel-16/29_series/29827/d0abac95583b52a3b35f74a215567334_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5b705094cb73b56a01ae0cd7e73a8f2412125040 --- /dev/null +++ b/marked/Rel-16/29_series/29827/d0abac95583b52a3b35f74a215567334_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:65d0807e88c5abdcc264b2a7ee91046ea70b7bc5153c6daf14b2c3fe4c39323f +size 116767 diff --git a/marked/Rel-16/29_series/29827/raw.md b/marked/Rel-16/29_series/29827/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..c77b36119979c8f9529297139110da3822063a25 --- /dev/null +++ b/marked/Rel-16/29_series/29827/raw.md @@ -0,0 +1,1246 @@ + + + + + + +# --- Contents + +| | | +|--------------------------------------------------------------------------------------------|----| +| Foreword ..... | 4 | +| Introduction ..... | 4 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Definitions, symbols and abbreviations..... | 5 | +| 3.1 Definitions..... | 5 | +| 3.2 Symbols..... | 6 | +| 3.3 Abbreviations ..... | 6 | +| 4 Volume based charging scenarios..... | 6 | +| 4.1 Scenario 1 Customized Alerting Tones (CAT) scenario..... | 6 | +| 4.2 Scenario 2 3PTY conference scenario ..... | 10 | +| 4.3 Scenario 3 Communication HOLD (HOLD) scenario ..... | 12 | +| 4.4 Scenario 4 Communication Waiting (CW) scenario..... | 18 | +| 5 Requirements analysis and assumptions ..... | 21 | +| 6 Alternative solutions for CT3 ..... | 22 | +| 6.1 Solution 1: PCRF configuration solution addressing on requirement 2 and 4 for CT3..... | 22 | +| 6.1.1 Introduction ..... | 22 | +| 6.1.2 Procedure and Function Description ..... | 22 | +| 6.1.3 Analysis ..... | 23 | +| 6.2 Solution 2: PCRF configuration solution addressing on requirement 1 and 3 for CT3..... | 23 | +| 6.2.1 Introduction ..... | 23 | +| 6.2.2 Procedure and Function Description ..... | 23 | +| 6.2.3 Analysis ..... | 24 | +| 8 Conclusions and recommendations..... | 30 | +| 8.1 Conclusions and recommendations for CT3 ..... | 30 | +| 8.2 Conclusions for CT1 ..... | 31 | +| Annex A (informative): Change history..... | 32 | + +# --- Foreword + +This Technical Report has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +*This clause is optional. If it exists, it is always the second unnumbered clause.* + +# --- 1 Scope + +The present document provides the study on Policy and Charging for Volume Based Charging, which is used to investigate and evaluate possible functional enhancements. + +The study shall investigate how to separate the volume usage between different IMS based services (e.g. CAT and voice calls, 3PTY conference, Call waiting, Call Hold). + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 29.212: "Policy and Charging Control (PCC); Reference points". +- [3] 3GPP TS 29.213: "Policy and Charging Control signalling flows and Quality of Service (QoS) parameter mapping". +- [4] 3GPP TS 29.214: "Policy and Charging Control over Rx reference point". +- [5] 3GPP TS 24.182: "IP Multimedia Subsystem (IMS) Customized Alerting Tones (CAT); Protocol specification". +- [6] 3GPP TS 24.605: "Conference (CONF) using IP Multimedia (IM) Core Network (CN) subsystem; Protocol specification". +- [7] 3GPP TS 24.147: "Conferencing using the IP Multimedia (IM) Core Network (CN) subsystem; Stage 3". +- [8] 3GPP TS 32.251: "Telecommunication management; Charging management; Packet Switched (PS) domain charging". +- [9] 3GPP TS 24.610: "Communication HOLD (HOLD) using IP Multimedia (IM) Core Network (CN) subsystem; Protocol specification". +- [10] 3GPP TS 24.615: "Communication Waiting (CW) using IP Multimedia (IM) Core Network (CN) subsystem; Protocol specification". + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +## 3.2 Symbols + +For the purposes of the present document, the following symbols apply: + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|--------|------------------------------------------| +| 3PTY | Three Party | +| ARP | Allocation and Retention Priority | +| AS | Application Server | +| AVP | Attribute Value Pair | +| CAT | Customized Alerting Tones | +| CONF | Conference calling | +| CW | Communication Waiting | +| HOLD | Communication HOLD | +| MMTEL | Multimedia Telephony | +| NDUB | Network Determined User Busy | +| PCC | Policy and Charging Control | +| PCEF | Policy and Charging Enforcement Function | +| PCRF | Policy and Charging Rule Function | +| P-CSCF | Proxy-Call Session Control Function | + +# --- 4 Volume based charging scenarios + +## 4.1 Scenario 1 Customized Alerting Tones (CAT) scenario + +3GPP TS 24.182 [5] defines the usage of SIP and SDP signalling to provide Customized Alerting Tones. The CAT service is an operator specific service by which an operator enables the subscriber to customize the media which is played to the calling party during alerting of the called party. The media are inserted by an application server (AS). + +3GPP TS 24.182 [5] defines the following models to provide CAT: + +- **Forking Model:** The caller's UE will for the same SDP offer receive an SDP answer for the CAT early media and an SDP answer from the callee's UE in different SIP dialogues. (see Figure 4.1-1) +- **Early Session Model:** The caller's UE will send a SIP INVITE containing an SDP offer and receive the corresponding answer from the callee's UE for the normal media and an SIP provisional response from the AS that contains an SDP offer of the "early session" disposition type for the CAT early media. The caller's UE responds with a SIP PRACK message containing the SDP answer of the "early session" disposition type. Only one SIP dialogue is used. (see Figure 4.1-2) +- **Gateway model:** The caller's UE will send a SIP INVITE and receive an SDP answer from the AS for the CAT early media. After the callee has answered, the caller's UE will receive a new SDP offer containing an SDP offer for the media towards the callee and will reply with an SDP answer. Only one SIP dialogue is used. (see Figure 4.1-3) + +![Sequence diagram for CAT forking model showing interactions between UE#1, S-CSCF, CAT-AS, and UE#2.](997233d405f0d4b89ddeb7683e047f66_img.jpg) + +The sequence diagram illustrates the callflow for a CAT forking model involving four entities: UE#1, S-CSCF, CAT-AS, and UE#2. The process begins with UE#1 sending an INVITE (SDP\_O) to S-CSCF. S-CSCF then forwards this to CAT-AS, which triggers a 'Reserve CAT resources' action. CAT-AS sends an INVITE (SDP\_O) back to S-CSCF, which in turn sends an INVITE (SDP\_O) to UE#2. UE#2 responds with a 180 (Ringing) (D2) to CAT-AS, which is then forwarded by S-CSCF to UE#1 as a 183 (Session Progress) (SDP\_A, D1). UE#1 responds with a PRACK (D1) to S-CSCF, which is forwarded to CAT-AS. CAT-AS sends a 200 (OK) (PRACK, D1) to S-CSCF, which is then forwarded to UE#1. CAT-AS also sends a 200 (OK) (SDP\_A, D2) to S-CSCF, which is forwarded to UE#2. Following this, a 'Start CAT media' action occurs at CAT-AS. CAT-AS sends a 200 (OK) (SDP\_A, D2) to S-CSCF, which is forwarded to UE#1. Finally, a 'Stop CAT media' action occurs at CAT-AS. CAT-AS sends a 200 (OK) (SDP\_A, D2) to S-CSCF, which is forwarded to UE#1. S-CSCF then sends an ACK (D2) to UE#1, which is forwarded by CAT-AS to UE#2. + +``` +sequenceDiagram + participant UE1 as UE#1 + participant S-CSCF + participant CAT-AS + participant UE2 as UE#2 + + Note left of UE1: Resources available + UE1->>S-CSCF: 1. INVITE (SDP_O) + S-CSCF->>CAT-AS: 2. INVITE (SDP_O) + Note right of CAT-AS: Reserve CAT resources + CAT-AS->>S-CSCF: 3. INVITE (SDP_O) + S-CSCF->>UE2: 4. INVITE (SDP_O) + Note right of UE2: Resources available + UE2->>CAT-AS: 5. 180 (Ringing) (D2) + CAT-AS->>S-CSCF: 6. 180 (Ringing) (D2) + S-CSCF->>UE1: 8. 183 (Session Progress) (SDP_A, D1) + UE1->>S-CSCF: 9. PRACK (D1) + S-CSCF->>CAT-AS: 10. PRACK (D1) + Note right of CAT-AS: Start CAT media + CAT-AS->>S-CSCF: 11. 200 (OK) (PRACK, D1) + S-CSCF->>UE1: 12. 200 (OK) (PRACK, D1) + CAT-AS->>S-CSCF: 13. 200 (OK) (SDP_A, D2) + S-CSCF->>UE2: 14. 200 (OK) (SDP_A, D2) + Note right of CAT-AS: Stop CAT media + CAT-AS->>S-CSCF: 15. 200 (OK) (SDP_A, D2) + S-CSCF->>UE1: 16. 200 (OK) (SDP_A, D2) + UE1->>S-CSCF: 17. ACK (D2) + S-CSCF->>UE2: 18. ACK (D2) +``` + +Sequence diagram for CAT forking model showing interactions between UE#1, S-CSCF, CAT-AS, and UE#2. + +Figure 4.1-1. Example callflows for CAT forking model (Figure A.3.2-1 of 3GPP TS 24.182 [5]) + +![Sequence diagram showing callflow for CAT early session between UE#1, S-CSCF, CAT-AS, and UE#2. The diagram includes 18 numbered messages and internal actions like 'Reserve CAT resources', 'Start CAT media', and 'Stop CAT media'.](d0abac95583b52a3b35f74a215567334_img.jpg) + +``` +sequenceDiagram + participant UE#1 + participant S-CSCF + participant CAT-AS + participant UE#2 + + Note left of UE#1: Resources available + UE#1->>S-CSCF: 1. INVITE (SDP_O) + S-CSCF->>CAT-AS: 2. INVITE (SDP_O) + Note right of CAT-AS: Reserve CAT resources + Note right of UE#2: Resources available + CAT-AS->>S-CSCF: 3. INVITE (SDP_O) + S-CSCF->>UE#2: 4. INVITE (SDP_O) + UE#2->>CAT-AS: 5. 180 (Ringing) + CAT-AS->>S-CSCF: 6. 180 (Ringing) + S-CSCF->>CAT-AS: 7. 183 (Session Progress) (early SDP_O) + CAT-AS->>UE#1: 8. 183 (Session Progress) (early SDP_O) + UE#1->>S-CSCF: 9. PRACK (early SDP_A) + S-CSCF->>CAT-AS: 10. PRACK (early SDP_A) + Note right of CAT-AS: Start CAT media + CAT-AS->>S-CSCF: 11. 200 (OK) (PRACK) + S-CSCF->>UE#1: 12. 200 (OK) (PRACK) + UE#2->>CAT-AS: 13. 200 (OK) (SDP_A) + CAT-AS->>S-CSCF: 14. 200 (OK) (SDP_A) + Note right of CAT-AS: Stop CAT media + CAT-AS->>S-CSCF: 15. 200 (OK) (SDP_A) + S-CSCF->>UE#1: 16. 200 (OK) (SDP_A) + UE#1->>S-CSCF: 17. ACK + S-CSCF->>UE#2: 18. ACK +``` + +Sequence diagram showing callflow for CAT early session between UE#1, S-CSCF, CAT-AS, and UE#2. The diagram includes 18 numbered messages and internal actions like 'Reserve CAT resources', 'Start CAT media', and 'Stop CAT media'. + +Figure 4.1-2. Example callflows for CAT early session (Figure A.4.2-1 of 3GPP TS 24.182 [5]) + +![Sequence diagram illustrating the example callflows for the CAT gateway model. The diagram shows interactions between UE#1, S-CSCF, CAT-AS, and UE#2. The process involves INVITE, PRACK, 200 OK, UPDATE, and ACK messages, with specific SDP attributes like SDP_O, SDP_A_cat, and SDP_A_regular. Key actions include 'Resources available', 'Reserve CAT resources', 'Alert called party', 'Start CAT media', and 'Stop CAT media'.](b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg) + +``` + +sequenceDiagram + participant UE#1 + participant S-CSCF + participant CAT-AS + participant UE#2 + + Note left of UE#1: Resources available + Note right of UE#2: Resources available + + UE#1->>S-CSCF: 1. INVITE (SDP_O) + S-CSCF->>CAT-AS: 2. INVITE (SDP_O) + Note right of CAT-AS: Reserve CAT resources + CAT-AS->>S-CSCF: 3. INVITE (SDP_O) + S-CSCF->>UE#2: 4. INVITE (SDP_O) + Note right of UE#2: Alert called party + UE#2->>CAT-AS: 5. 180 (Ringing) + CAT-AS->>S-CSCF: 6. 180 (Ringing) + S-CSCF->>UE#1: 8. 180 (Ringing) (SDP_A_cat) + CAT-AS->>S-CSCF: 7. 180 (Ringing) (SDP_A_cat) + UE#1->>S-CSCF: 9. PRACK + S-CSCF->>CAT-AS: 10. PRACK + Note right of CAT-AS: Start CAT media + CAT-AS->>S-CSCF: 11. 200 (OK) (PRACK) + S-CSCF->>UE#1: 12. 200 (OK) (PRACK) + Note right of UE#2: Called party answers the call + UE#2->>CAT-AS: 13. 200 (OK) (SDP_A_regular) + CAT-AS->>S-CSCF: 14. 200 (OK) (SDP_A_regular) + Note right of CAT-AS: Stop CAT media + CAT-AS->>S-CSCF: 15. UPDATE (SDP_A_regular) + S-CSCF->>UE#1: 16. UPDATE (SDP_A_regular) + UE#1->>S-CSCF: 17. 200 (OK) (UPDATE) (SDP_O2) + S-CSCF->>CAT-AS: 18. 200 (OK) (UPDATE) (SDP_O2) + CAT-AS->>S-CSCF: 19. 200 (OK) (INVITE) + S-CSCF->>UE#1: 20. 200 (OK) (INVITE) + UE#1->>S-CSCF: 21. ACK + S-CSCF->>CAT-AS: 22. ACK + CAT-AS->>S-CSCF: 23. ACK + S-CSCF->>UE#2: 24. ACK + +``` + +Sequence diagram illustrating the example callflows for the CAT gateway model. The diagram shows interactions between UE#1, S-CSCF, CAT-AS, and UE#2. The process involves INVITE, PRACK, 200 OK, UPDATE, and ACK messages, with specific SDP attributes like SDP\_O, SDP\_A\_cat, and SDP\_A\_regular. Key actions include 'Resources available', 'Reserve CAT resources', 'Alert called party', 'Start CAT media', and 'Stop CAT media'. + +**Figure 4.1-3. Example callflows for CAT gateway model (Figure A.5.1-1 of 3GPP TS 24.182 [5])** + +For all models, the IMS Communication Service Identifier value for MMTEL will be used in the SIP signalling and CAT early media and established media cannot be distinguished based on this information. However, the CAT early media are marked with the media-level "a=content:g.3gpp.cat" SDP attribute. + +The SIP/SDP signalling for CAT will be translated by the P-CSCF into Rx signalling towards the PCRF according to the Annex A of 3GPP TS 29.214 [4] and Clause 6.2 of 3GPP TS 29.213 [3]. In particular: + +- The IMS Communication Service Identifier value for MMTEL will be provided as AF-Application-Identifier. +- The media-level "a=content:g.3gpp.cat" SDP attribute can be encapsulated within the "Codec-Data" AVP for corresponding media components. +- The forking model will be handled according to Annex A.3 of 3GPP TS 29.214 [4]. +- The early session model will be handled according to Annex A.7 of 3GPP TS 29.214 [4]. +- The gateway model will be handled according to Annex A.1 of 3GPP TS 29.214 [4]. +- For all three models a single Rx session will be used. + +The PCRF can thus recognise whether media described in the Rx service information are CAT early media or established media. + +It is desirable that the PCRF configures the PCEF over the Gx interface (see 3GPP TS 29.212 [2]) in such a manner that separate charging records are generated for the CAT early media and for the established media. + +## 4.2 Scenario 2 3PTY conference scenario + +SIP signalling for a 3PTY conference is described in 3GPP TS 24.605 [6] and 3GPP TS 24.147 [7] + +A UE invoking a 3PTY conference will establish separate SIP dialogues to the two peers and will put the media for both calls on hold using the SDP direction attribute "sendonly" or "inactive" in an SDP offer sent towards each of the peers. The UE will then establish a third SIP dialogue towards the MRF to establish a conference. After that, the UE will invite the peers to join the conference, either by sending SIP refer requests to the peers within the corresponding SIP dialogues (see Figure 4.2-1), or by tasking the MRF to send INVITE requests to the peers (see Figure 4.2-2). + +The P-CSCF serving the UE can recognise the SIP dialogue toward the MRF via the Conference-factory URI used as request URI, or via the "isfocus" parameter in the SIP contact header within the SIP response. + +The SIP/SDP signalling will be translated by the P-CSCF into Rx signalling towards the PCRF according to the Annex A of 3GPP TS 29.214 [4] and Clause 6.2 of 3GPP TS 29.213 [3]. In particular: + +- The different Rx sessions will be used +- The IMS Communication Service Identifier value for MMTEL will be provided as AF-Application-Identifier. +- The Rx session and media towards the conference server/MRF are not explicitly marked. +- Resource sharing among the media related to the different SIP dialogues can be requested as specified in subclause A.12 of 3GPP TS 29.214 [4] + +There is only a single IP CAN session and only one Gx session. As described for the bearer binding mechanism (see 3GPP TS 29.214 [4]), the Bearer Binding Function (BBF) located at the PCEF will evaluate whether it is possible to use one of the existing IP-CAN bearers that has the same QoS class identifier and ARP. + +It is desirable to enable the PCEF to request the network to generate separate CDR the usage between the UE and different parties and to recognise the media components exchanged between the served UE and the MRF. + +The PCEF provides the capability to categorise the service data flows within IP-CAN bearer data traffic by rating group or combination of the rating group and service id according to subclauses 5.2.1.3 and 5.3.1.2 of 3GPP TS 32.251 [8]. However, the PCRF could not supply different rating group or service id for the different PCC rules in this scenario. + +![Sequence diagram showing the call flow for a 3PTY conference. Lifelines: UE-1, P-CSCF, S-CSCF, AS/MRFC (with MRFP), UE-2, and UE-3. The process involves initial session setup between UE-1 and UE-2, putting UE-2 on hold, then inviting UE-3 via REFER requests from UE-1 through the CS, and finally establishing a three-way conference with media paths to all participants.](5a4e62bead259c258d069fd3663ea670_img.jpg) + +The sequence diagram illustrates the call flow for a 3PTY conference. The participants are UE-1, P-CSCF, S-CSCF, AS/MRFC (connected to MRFP), UE-2, and UE-3. The process begins with a multimedia session between UE-1 and UE-2. UE-1 then puts UE-2 on hold and sends a REFER request to P-CSCF to invite UE-3. The request propagates through S-CSCF to AS/MRFC. AS/MRFC interacts with MRFP to create the conference. UE-1 receives responses and sends NOTIFY messages. AS/MRFC sends INVITE messages to S-CSCF, which then interacts with MRFP for resources. Finally, AS/MRFC sends INVITE to UE-3, establishes media paths, and the conference is established with BYE and OK messages. + +``` + +sequenceDiagram + participant UE-1 + participant P-CSCF + participant S-CSCF + participant AS/MRFC + participant MRFP + participant UE-2 + participant UE-3 + + Note over UE-1, UE-2: 1. UE-1 and UE-2 is in a multimedia session + UE-1->>UE-2: Media Path to UE-2 + Note over UE-1, UE-2: 2. UE-1 Puts UE-2 on hold + UE-1->>P-CSCF: 3. INVITE(UE-3) + P-CSCF->>S-CSCF: 4. INVITE(UE-3) + S-CSCF->>AS/MRFC: 14. INVITE (CS) + AS/MRFC->>MRFP: 15. Interaction for creating Conference + MRFP->>AS/MRFC: 16. 200 OK (INVITE) + AS/MRFC->>S-CSCF: 17. 200 OK (INVITE) + S-CSCF->>P-CSCF: 18. 200 OK (INVITE) + P-CSCF->>UE-1: 19. ACK + UE-1->>UE-3: Media Path to UE-3 + UE-1->>P-CSCF: 12. INVITE (CS) + P-CSCF->>S-CSCF: 13. INVITE (CS) + S-CSCF->>AS/MRFC: 14. INVITE (CS) + AS/MRFC->>MRFP: 15. Interaction for creating Conference + MRFP->>AS/MRFC: 16. 200 OK (INVITE) + AS/MRFC->>S-CSCF: 17. 200 OK (INVITE) + S-CSCF->>P-CSCF: 18. 200 OK (INVITE) + P-CSCF->>UE-1: 19. ACK + UE-1->>P-CSCF: 22. REFER(UE-2) w Refer-To: CS + P-CSCF->>S-CSCF: 23. REFER(UE-2) w Refer-To: CS + S-CSCF->>AS/MRFC: 24. REFER(UE-2) w Refer-To: CS + AS/MRFC->>MRFP: 25. Interaction for creating Conference + MRFP->>AS/MRFC: 26. 202 Accepted + AS/MRFC->>S-CSCF: 27. 202 Accepted + S-CSCF->>P-CSCF: 28. 202 Accepted + P-CSCF->>UE-1: 29. NOTIFY (100 Trying) + UE-1->>P-CSCF: 30. NOTIFY (100 Trying) + P-CSCF->>S-CSCF: 31. 200 OK (NOTIFY) + S-CSCF->>AS/MRFC: 32. 200 OK (NOTIFY) + AS/MRFC->>MRFP: 33. 200 OK (NOTIFY) + MRFP->>AS/MRFC: 34. INVITE + AS/MRFC->>MRFP: 36. Interaction for resource for an additional participant + MRFP->>AS/MRFC: 37. 200 OK (INVITE) + AS/MRFC->>S-CSCF: 38. 200 OK (INVITE) + S-CSCF->>P-CSCF: 39. ACK + P-CSCF->>UE-1: 40. ACK + UE-1->>P-CSCF: 43. NOTIFY (200 OK) + P-CSCF->>S-CSCF: 42. NOTIFY (200 OK) + S-CSCF->>AS/MRFC: 41. NOTIFY (200 OK) + AS/MRFC->>MRFP: 44. 200 OK (NOTIFY) + MRFP->>AS/MRFC: 45. 200 OK (NOTIFY) + AS/MRFC->>S-CSCF: 46. 200 OK (NOTIFY) + S-CSCF->>P-CSCF: 47. BYE + P-CSCF->>UE-1: 48. BYE + UE-1->>P-CSCF: 52. 200 OK (BYE) + P-CSCF->>S-CSCF: 51. 200 OK (BYE) + S-CSCF->>AS/MRFC: 50. 200 OK (BYE) + AS/MRFC->>MRFP: 53. REFER(UE-3) w Refer-To: CS + MRFP->>AS/MRFC: 54. REFER(UE-3) w Refer-To: CS + AS/MRFC->>MRFP: 55. REFER(UE-3) w Refer-To: CS + MRFP->>AS/MRFC: 56. 202 Accepted + AS/MRFC->>S-CSCF: 57. 202 Accepted + S-CSCF->>P-CSCF: 58. 202 Accepted + P-CSCF->>UE-1: 59. NOTIFY (100 Trying) + UE-1->>P-CSCF: 60. NOTIFY (100 Trying) + P-CSCF->>S-CSCF: 61. NOTIFY (100 Trying) + S-CSCF->>AS/MRFC: 62. 200 OK (NOTIFY) + AS/MRFC->>MRFP: 63. 200 OK (NOTIFY) + MRFP->>AS/MRFC: 64. 200 OK (NOTIFY) + AS/MRFC->>MRFP: 65. INVITE + MRFP->>AS/MRFC: 67. Interaction for resource for an additional participant + MRFP->>AS/MRFC: 68. 200 OK (INVITE) + AS/MRFC->>MRFP: 69. 200 OK (INVITE) + MRFP->>AS/MRFC: 70. ACK + AS/MRFC->>MRFP: 71. ACK + AS/MRFC->>UE-3: Media to UE-3 + UE-1->>P-CSCF: 74. NOTIFY (200 OK) + P-CSCF->>S-CSCF: 73. NOTIFY (200 OK) + S-CSCF->>AS/MRFC: 72. NOTIFY (200 OK) + AS/MRFC->>MRFP: 75. 200 OK (NOTIFY) + MRFP->>AS/MRFC: 76. 200 OK (NOTIFY) + AS/MRFC->>MRFP: 77. 200 OK (NOTIFY) + AS/MRFC->>MRFP: 78. BYE + MRFP->>AS/MRFC: 79. BYE + AS/MRFC->>MRFP: 80. BYE + MRFP->>AS/MRFC: 81. 200 OK (BYE) + AS/MRFC->>S-CSCF: 82. 200 OK (BYE) + S-CSCF->>P-CSCF: 83. 200 OK (BYE) + +``` + +Sequence diagram showing the call flow for a 3PTY conference. Lifelines: UE-1, P-CSCF, S-CSCF, AS/MRFC (with MRFP), UE-2, and UE-3. The process involves initial session setup between UE-1 and UE-2, putting UE-2 on hold, then inviting UE-3 via REFER requests from UE-1 through the CS, and finally establishing a three-way conference with media paths to all participants. + +Figure 4.2-1: The Call flow for 3PTY conference by sending REFER request described in 3GPP TS 24.605 [6] + +![Sequence diagram showing the call flow for a 3PTY conference. Lifelines: UA-A, Intermediate IM CN subsystem entities, AS/MRFC (containing MRFP), UA-B incl. Intermediate entities, and UA-C incl. Intermediate entities. The diagram shows INVITE CONF AS messages, 200 OK, ACK, re-INVITE B, re-INVITE C, and media stream exchanges. A yellow box contains the XML for the recipient-list in the INVITE message.](27b06ec9f42b5d727a2630f61a5f1861_img.jpg) + +``` + +sequenceDiagram + participant UA-A + participant IMCN as Intermediate IM CN subsystem entities + subgraph AS/MRFC [AS/MRFC] + participant MRFP + end + participant UA-B as UA-B incl. Intermediate entities + participant UA-C as UA-C incl. Intermediate entities + + Note right of UA-A: INVITE CONF AS with recipient-list XML + UA-A->>IMCN: INVITE CONF AS (Call-ID: 3a) + IMCN->>MRFP: INVITE CONF AS (Call-ID: 3b) + MRFP-->>IMCN: 200 OK + IMCN-->>UA-A: 200 OK + UA-A->>IMCN: ACK + IMCN->>MRFP: ACK + + Note right of MRFP: re-INVITE B + MRFP->>UA-B: re-INVITE B (Call-ID: 1c) + UA-B-->>MRFP: 200 OK + MRFP->>UA-B: ACK + + Note right of MRFP: re-INVITE C + MRFP->>UA-C: re-INVITE C (Call-ID: 2c) + UA-C-->>MRFP: 200 OK + MRFP->>UA-C: ACK + + Note right of UA-A: Dialog state updates + UA-A-->>IMCN: Dialog 1a, on-hold + IMCN-->>MRFP: Dialog 1b, on-hold + MRFP-->>UA-B: Dialog 1c, active + UA-A-->>IMCN: Dialog 2a, on-hold + IMCN-->>MRFP: Dialog 2b, on-hold + MRFP-->>UA-C: Dialog 2c, active + UA-A-->>IMCN: Dialog 3a, active + IMCN-->>MRFP: Dialog 3b, active + + Note right of UA-A: Media stream 3a + UA-A->>MRFP: Media stream 3a + MRFP->>UA-B: Media stream 1c + MRFP->>UA-C: Media stream 2c + +``` + +``` + +INVITE CONF AS +To: CONF AS +From: A +Require: recipient-list-invite + +Content-Type: application/resource-lists+xml +Content-Disposition: recipient-list + + + + + + + + + +``` + +Sequence diagram showing the call flow for a 3PTY conference. Lifelines: UA-A, Intermediate IM CN subsystem entities, AS/MRFC (containing MRFP), UA-B incl. Intermediate entities, and UA-C incl. Intermediate entities. The diagram shows INVITE CONF AS messages, 200 OK, ACK, re-INVITE B, re-INVITE C, and media stream exchanges. A yellow box contains the XML for the recipient-list in the INVITE message. + +Figure 4.2-2: The Call flow for 3PTY conference sending INVITE request with URI list described in 3GPP TS 24.605 [6] + +If charging correlation is used, it is very hard for the charging system to correlate the PS CDR and IMS CDR. There may be one PS CDR with multiple AF-Correlation-Information. + +## 4.3 Scenario 3 Communication HOLD (HOLD) scenario + +3GPP TS 24.610 [9] defines the usage of SIP and SDP signalling to provide Communication HOLD (HOLD) service. The HOLD service enables a user to suspend the reception of media stream(s) of an established IP multimedia session, and resume the media stream(s) at a later time. The media are inserted by the communication origin or the AS. + +3GPP TS 24.610 [9] defines HOLD communication and RESUME communication to provide HOLD. + +![Sequence diagram showing callflow for HOLD communication without announcement to the held user. Lifelines: UE-A, P-CSCF A, S-CSCF, AS, P-CSCF B, UE:B. The diagram shows 12 numbered messages between these entities, with a dashed line at the top indicating RTP flow. A note 'no RTP sent' is present near the bottom center.](cab0834804fb031b43865554cc8d06ab_img.jpg) + +``` +sequenceDiagram + participant UE-A + participant P-CSCF-A as P-CSCF A + participant S-CSCF + participant AS + participant P-CSCF-B as P-CSCF B + participant UE-B as UE:B + + Note over UE-A, UE-B: RTP + UE-A->>P-CSCF-A: 1. INVITE (sendonly) + P-CSCF-A->>S-CSCF: 2. INVITE (sendonly) + S-CSCF->>AS: 3. INVITE (sendonly) + AS->>P-CSCF-B: 4. INVITE (sendonly) + P-CSCF-B->>UE-B: 5. 200 OK (recvonly) + UE-B->>AS: 6. 200 OK (recvonly) + AS->>S-CSCF: 7. 200 OK (recvonly) + S-CSCF->>P-CSCF-A: 8. 200 OK (recvonly) + P-CSCF-A->>UE-A: 9. ACK + UE-A->>S-CSCF: 10. ACK + S-CSCF->>P-CSCF-B: 11. ACK + P-CSCF-B->>UE-B: 12. ACK + Note right of S-CSCF: no RTP sent +``` + +Sequence diagram showing callflow for HOLD communication without announcement to the held user. Lifelines: UE-A, P-CSCF A, S-CSCF, AS, P-CSCF B, UE:B. The diagram shows 12 numbered messages between these entities, with a dashed line at the top indicating RTP flow. A note 'no RTP sent' is present near the bottom center. + +Figure 4.3-1. Example callflows for HOLD communication without announcement to the held user (Figure A.1.1.1 of 3GPP TS 24.610 [9]) + +![Sequence diagram showing callflow for HOLD communication with announcement to the held user. Lifelines: UE-A, P-CSCF A, S-CSCF, AS/MRF, P-CSCF B, UE-B. The diagram shows the flow of SIP messages (INVITE, 200 OK, ACK) and media streams (RTP, RTCP) between these entities. A horizontal line at the top indicates the 'Originating side' spanning from UE-A to AS/MRF.](a33da0f14e456f92539ce3e9b7d81f9a_img.jpg) + +The sequence diagram illustrates the callflow for HOLD communication with announcement to the held user. The lifelines are UE-A, P-CSCF A, S-CSCF, AS/MRF, P-CSCF B, and UE-B. A horizontal line at the top indicates the 'Originating side' spanning from UE-A to AS/MRF. + +The sequence of messages is as follows: + +- UE-A sends an INVITE (sendonly) to P-CSCF A. +- P-CSCF A sends an INVITE (sendonly) to S-CSCF. +- S-CSCF sends an INVITE (sendonly) to AS/MRF. +- AS/MRF performs a 'Reserve resources' action. +- AS/MRF sends an INVITE (sendonly) to S-CSCF. +- S-CSCF sends an INVITE (sendonly) to P-CSCF B. +- P-CSCF B sends an INVITE (sendonly) to UE-B. +- UE-B sends a 200 OK (recvonly) to P-CSCF B. +- P-CSCF B sends a 200 OK (recvonly) to S-CSCF. +- S-CSCF sends a 200 OK (recvonly) to AS/MRF. +- AS/MRF performs a 'Start playing announcement' action. +- AS/MRF sends a 200 OK (recvonly) to S-CSCF. +- S-CSCF sends a 200 OK (recvonly) to P-CSCF A. +- P-CSCF A sends a 200 OK (recvonly) to UE-A. +- UE-A sends an ACK to P-CSCF A. +- P-CSCF A sends an ACK to S-CSCF. +- S-CSCF sends an ACK to AS/MRF. +- AS/MRF sends an ACK to S-CSCF. +- S-CSCF sends an ACK to P-CSCF B. +- P-CSCF B sends an ACK to UE-B. +- UE-A sends an RTCP stream to AS/MRF. + +Sequence diagram showing callflow for HOLD communication with announcement to the held user. Lifelines: UE-A, P-CSCF A, S-CSCF, AS/MRF, P-CSCF B, UE-B. The diagram shows the flow of SIP messages (INVITE, 200 OK, ACK) and media streams (RTP, RTCP) between these entities. A horizontal line at the top indicates the 'Originating side' spanning from UE-A to AS/MRF. + +Figure 4.3-2. Example callflows for HOLD communication with announcement to the held user (Figure A.1.2.1 of 3GPP TS 24.610 [9]) + +![Sequence diagram showing callflow for HOLD communication. Lifelines: UE-A, P-CSCF A, S-CSCF, AS/MRF, P-CSCF B, UE-B. The diagram shows the flow of INVITE, 200 OK, and ACK messages, with RTP and RTCP streams indicated at the top and bottom.](7efae06af3af43ffe5d4b956a679cf54_img.jpg) + +The diagram illustrates a callflow for HOLD communication across six lifelines: UE-A, P-CSCF A, S-CSCF, AS/MRF, P-CSCF B, and UE-B. A horizontal line at the top labeled 'Originating side' spans from UE-A to AS/MRF. The sequence of messages is as follows: + +- 1. INVITE (sendonly) from UE-A to P-CSCF A +- 2. INVITE (sendonly) from P-CSCF A to S-CSCF +- 3. INVITE (sendonly) from S-CSCF to AS/MRF +- 4. Reserve resources (internal message within AS/MRF) +- 5. INVITE (sendonly) from AS/MRF to S-CSCF +- 6. INVITE (sendonly) from S-CSCF to P-CSCF B +- 7. INVITE (sendonly) from P-CSCF B to UE-B +- 8. 200 OK (recvonly) from UE-B to P-CSCF B +- 9. 200 OK (recvonly) from P-CSCF B to AS/MRF +- 10. 200 OK (recvonly) from AS/MRF to S-CSCF +- 11. Start playing announcement (internal message within AS/MRF) +- 12. 200 OK (recvonly) from S-CSCF to P-CSCF A +- 13. 200 OK (recvonly) from P-CSCF A to UE-A +- 14. 200 OK (recvonly) from UE-A to P-CSCF A +- 15. ACK from UE-A to P-CSCF A +- 16. ACK from P-CSCF A to S-CSCF +- 17. ACK from S-CSCF to AS/MRF +- 18. ACK from AS/MRF to S-CSCF +- 19. ACK from S-CSCF to P-CSCF B +- 20. ACK from P-CSCF B to UE-B +- 21. RTCP from UE-A to AS/MRF + +At the top, a red arrow labeled 'RTP' and a purple arrow labeled 'RTCP' both point from UE-A to UE-B. At the bottom, a purple arrow labeled 'RTCP' points from UE-A to AS/MRF. + +Sequence diagram showing callflow for HOLD communication. Lifelines: UE-A, P-CSCF A, S-CSCF, AS/MRF, P-CSCF B, UE-B. The diagram shows the flow of INVITE, 200 OK, and ACK messages, with RTP and RTCP streams indicated at the top and bottom. + +Figure 4.3-3. Example callflows for HOLD communication with modification of the SDP answer (Figure A.1.3.1 of 3GPP TS 24.610 [9]) + +![Sequence diagram showing callflow for RESUME communication without announcement to the held user. Lifelines: UE-A, P-CSCF A, S-CSCF, AS, P-CSCF B, UE:B. The diagram shows 12 numbered messages and a dashed RTP line.](1a827b10290f33d4fec04d0e8ef7a897_img.jpg) + +The sequence diagram illustrates the callflow for RESUME communication without announcement to the held user. The lifelines are UE-A, P-CSCF A, S-CSCF, AS, P-CSCF B, and UE:B. The sequence of messages is as follows: + +1. INVITE (sendrecv) from UE-A to P-CSCF A +2. INVITE (sendrecv) from P-CSCF A to S-CSCF +3. INVITE (sendrecv) from S-CSCF to P-CSCF B (via AS) +4. INVITE (sendrecv) from P-CSCF B to UE:B +5. 200 OK (sendrecv) from UE:B to P-CSCF B +6. 200 OK (sendrecv) from P-CSCF B to S-CSCF (via AS) +7. 200 OK (sendrecv) from S-CSCF to P-CSCF A +8. 200 OK (sendrecv) from P-CSCF A to UE-A +9. ACK from UE-A to P-CSCF A +10. ACK from P-CSCF A to S-CSCF +11. ACK from S-CSCF to P-CSCF B +12. ACK from P-CSCF B to UE:B + +A dashed line labeled "RTP" indicates the media path between UE-A and UE:B. A note "no RTP sent" is present above the AS lifeline. + +Sequence diagram showing callflow for RESUME communication without announcement to the held user. Lifelines: UE-A, P-CSCF A, S-CSCF, AS, P-CSCF B, UE:B. The diagram shows 12 numbered messages and a dashed RTP line. + +**Figure 4.3-4. Example callflows for RESUME communication without announcement to the held user +(Figure A.2.1.1 of 3GPP TS 24.610 [9])** + +![Sequence diagram showing callflows for RESUME communication with announcement to the held user. The diagram involves six entities: UE-A, P-CSCF A, S-CSCF, AS/MRF, P-CSCF B, and UE-B. The sequence starts with RTCP from UE-A to AS/MRF. Then, UE-A sends an INVITE (sendrecv) to P-CSCF A, which is forwarded by P-CSCF A to S-CSCF, then to AS/MRF. AS/MRF sends a 'Stop playing announcement' message. S-CSCF then sends an INVITE (sendrecv) to AS/MRF, which is forwarded by AS/MRF to P-CSCF B, then to UE-B. UE-B sends a 200 OK (sendrecv) to P-CSCF B, which is forwarded by P-CSCF B to AS/MRF, then to S-CSCF. S-CSCF sends a 200 OK (sendrecv) to AS/MRF, which is forwarded by AS/MRF to P-CSCF A, then to UE-A. UE-A sends an ACK to P-CSCF A, which is forwarded by P-CSCF A to S-CSCF, then to AS/MRF. AS/MRF sends an ACK to S-CSCF, which is forwarded by S-CSCF to P-CSCF B, then to UE-B. Finally, RTP and RTCP are shown as horizontal lines between UE-A and UE-B.](8307f6b04df072c9332f9987e034272c_img.jpg) + +Originating side + +``` + +sequenceDiagram + participant UE-A + participant P-CSCF A + participant S-CSCF + participant AS/MRF + participant P-CSCF B + participant UE-B + + Note left of UE-A: Originating side + + UE-A->>AS/MRF: RTCP + UE-A->>P-CSCF A: 1. INVITE (sendrecv) + P-CSCF A->>S-CSCF: 2. INVITE (sendrecv) + S-CSCF->>AS/MRF: 3. INVITE (sendrecv) + AS/MRF->>AS/MRF: 4. Stop playing announcement + S-CSCF->>AS/MRF: 5. INVITE (sendrecv) + AS/MRF->>P-CSCF B: 6. INVITE (sendrecv) + P-CSCF B->>UE-B: 7. INVITE (sendrecv) + UE-B->>P-CSCF B: 8. 200 OK (sendrecv) + P-CSCF B->>AS/MRF: 9. 200 OK (sendrecv) + AS/MRF->>S-CSCF: 10. 200 OK (sendrecv) + AS/MRF->>AS/MRF: 11. Release resources + AS/MRF->>P-CSCF A: 12. 200 OK (sendrecv) + P-CSCF A->>UE-A: 13. 200 OK (sendrecv) + UE-A->>P-CSCF A: 14. 200 OK (sendrecv) + P-CSCF A->>S-CSCF: 15. ACK + S-CSCF->>AS/MRF: 16. ACK + AS/MRF->>S-CSCF: 17. ACK + S-CSCF->>P-CSCF B: 18. ACK + P-CSCF B->>UE-B: 19. ACK + UE-B->>P-CSCF B: 20. ACK + + Note right of UE-B: RTP + Note right of UE-B: RTCP + +``` + +Sequence diagram showing callflows for RESUME communication with announcement to the held user. The diagram involves six entities: UE-A, P-CSCF A, S-CSCF, AS/MRF, P-CSCF B, and UE-B. The sequence starts with RTCP from UE-A to AS/MRF. Then, UE-A sends an INVITE (sendrecv) to P-CSCF A, which is forwarded by P-CSCF A to S-CSCF, then to AS/MRF. AS/MRF sends a 'Stop playing announcement' message. S-CSCF then sends an INVITE (sendrecv) to AS/MRF, which is forwarded by AS/MRF to P-CSCF B, then to UE-B. UE-B sends a 200 OK (sendrecv) to P-CSCF B, which is forwarded by P-CSCF B to AS/MRF, then to S-CSCF. S-CSCF sends a 200 OK (sendrecv) to AS/MRF, which is forwarded by AS/MRF to P-CSCF A, then to UE-A. UE-A sends an ACK to P-CSCF A, which is forwarded by P-CSCF A to S-CSCF, then to AS/MRF. AS/MRF sends an ACK to S-CSCF, which is forwarded by S-CSCF to P-CSCF B, then to UE-B. Finally, RTP and RTCP are shown as horizontal lines between UE-A and UE-B. + +**Figure 4.3-5. Example callflows for RESUME communication with announcement to the held user (Figure A.2.2.1 of 3GPP TS 24.610 [9])** + +For all cases, The P-CSCF serving the UE can recognise the SIP dialogue toward different SIP Call-IDs. + +The SIP/SDP signalling will be translated by the P-CSCF into Rx signalling towards the PCRF according to the Annex A of 3GPP TS 29.214 [4] and clause 6.2 of 3GPP TS 29.213 [3]. In particular: + +- The different Rx sessions will be used +- The IMS Communication Service Identifier value for MMTEL will be provided as AF-Application-Identifier. +- The Rx session and media towards different communication dialogues are not explicitly marked. +- Resource sharing among the media related to the different SIP dialogues can be requested as specified in subclause A.12 of 3GPP TS 29.214 [4] + +There is only a single IP CAN session and only one Gx session. As described for the bearer binding mechanism (see 3GPP TS 29.213 [3]), the Bearer Binding Function (BBF) located at the PCEF will evaluate whether it is possible to use one of the existing IP-CAN bearers that has the same QoS class identifier and ARP. + +It is desirable to enable the PCEF to request the network to generate separate CDR the usage between different communication dialogues and to recognise the media components exchanged between different communication dialogues. + +The PCEF provides the capability to categorise the service data flows within IP-CAN bearer data traffic by rating group or combination of the rating group and service id according to subclauses 5.2.1.3 and 5.3.1.2 of 3GPP TS 32.251 [8]. However, the PCRF could not supply different rating group or service id for the different PCC rules in this scenario. If charging correlation is used, it is very hard for the charging system to correlate the PS CDR and IMS CDR. There may be one PS CDR with multiple AF-Correlation-Information. + +## 4.4 Scenario 4 Communication Waiting (CW) scenario + +3GPP TS 24.615 [10] defines the usage of SIP and SDP signalling to provide Communication Waiting (CW) service. The CW service enables a UE to be informed that no resources are available for an incoming communication. The user then has the choice of accepting, rejecting or ignoring the incoming communication (as per basic communication procedures). The media are inserted by a different communication origin. + +3GPP TS 24.615 [10] defines the following cases to provide CW: + +- network based CW, i.e. sufficient information on the user is available at the time a communication is to be delivered to the user, the network validates the status of this user. If the status of the user is "approaching NDUB", the network presents the waiting communication to the destination user; or +- terminal based CW, the network may be informed of the communication waiting situation upon receipt from the destination user of a communication waiting indication. + +![Sequence diagram showing Network based Call Waiting (CW) using an AS. Lifelines: S-CSCF, AS, P-CSCF, UE-B. The diagram shows the flow of INVITE and 180 Ringing messages with CW indications and Alert-Info headers.](8fa679f79a1bb1f527cba9f29e784e89_img.jpg) + +``` +sequenceDiagram + participant External + participant S-CSCF + participant AS + participant P-CSCF + participant UE-B + + Note right of AS: 2a. the AS determines the 'approaching NDUB' condition and inserts a CW indication in the INVITE request + Note right of UE-B: 6a. Possibility for User B to react: release session, invoke HOLD, ...] not part of CW + Note right of AS: 8a. the AS inserts a Alert-Info header with a CW urn into the 180 Ringing response + Note right of AS: 9a. the AS has the possibility to generate a CW announcement + + External->>S-CSCF: 1. INVITE + S-CSCF->>AS: 2. INVITE + AS->>S-CSCF: 3. INVITE [CW indication] + S-CSCF->>P-CSCF: 4. INVITE [CW indication] + P-CSCF->>UE-B: 5. INVITE [CW indication] + UE-B->>P-CSCF: 6. 180 Ringing + P-CSCF->>S-CSCF: 7. 180 Ringing + S-CSCF->>AS: 8. 180 Ringing + AS->>S-CSCF: 9. 180 Ringing Alert-Info: urn:alert:service: call-waiting + S-CSCF->>External: 10. 180 Ringing Alert-Info: urn:alert:service: call-waiting + UE-B->>P-CSCF: 11. 200 OK + P-CSCF->>S-CSCF: 12. 200 OK + S-CSCF->>AS: 13. 200 OK + AS->>S-CSCF: 14. 200 OK + S-CSCF->>External: 15. 200 OK +``` + +The sequence diagram illustrates the interaction for Network based Call Waiting (CW) using an Application Server (AS). The lifelines are S-CSCF, AS, P-CSCF, and UE-B. The process starts with an INVITE from an external source to the S-CSCF. The S-CSCF forwards this to the AS. The AS determines the 'approaching NDUB' condition and inserts a CW indication in the INVITE request. The AS then sends the INVITE with the CW indication back to the S-CSCF. The S-CSCF forwards this to the P-CSCF, which in turn forwards it to the UE-B. The UE-B responds with a 180 Ringing message, which is passed back through the P-CSCF, S-CSCF, and AS. The AS inserts an Alert-Info header with a CW urn into the 180 Ringing response. The S-CSCF then sends the 180 Ringing response with the Alert-Info header to the external source. The UE-B sends a 200 OK message, which is passed back through the P-CSCF, S-CSCF, and AS. The S-CSCF sends a 200 OK message to the AS, which in turn sends a 200 OK message back to the S-CSCF. Finally, the S-CSCF sends a 200 OK message to the external source. A note indicates that the possibility for User B to react (release session, invoke HOLD, ...) is not part of CW. Another note indicates that the AS has the possibility to generate a CW announcement. + +Sequence diagram showing Network based Call Waiting (CW) using an AS. Lifelines: S-CSCF, AS, P-CSCF, UE-B. The diagram shows the flow of INVITE and 180 Ringing messages with CW indications and Alert-Info headers. + +Figure 4.4-1. Example callflows for Network based CW using an AS (Figure A.1.1 of 3GPP TS 24.615 [10]) + +![Sequence diagram showing the callflow for Terminal based CW at the terminating side, successful communication establishment. The diagram involves four main entities: S-CSCF, AS, P-CSCF, and UE-B. The process starts with an INVITE from an external source to the S-CSCF. The S-CSCF performs service control and forwards it to the AS. The AS then sends an INVITE to the P-CSCF, which in turn sends it to the UE-B. The UE-B responds with a 183 Session progress, which is forwarded back through the P-CSCF and AS to the S-CSCF. The S-CSCF then sends a 180 Ringing Alert-Info (call-waiting) to the AS, which in turn sends it to the P-CSCF and then to the UE-B. The AS also starts a CW timer. The UE-B may react by releasing the session or invoking HOLD. The AS may initiate a CW announcement. The P-CSCF sends a 200 OK to the UE-B, which is forwarded back through the AS and S-CSCF to the external source. The AS stops the CW timer. The S-CSCF sends a 200 OK to the external source.](81a4cbf0b3c4cbc065efdf8f800dadde_img.jpg) + +``` + +sequenceDiagram + participant External + participant S-CSCF + participant AS + participant P-CSCF + participant UE-B + + External->>S-CSCF: 1. INVITE + Note right of S-CSCF: 1a. Service Control, CW subscribed (Network provided) +--> forwarded to CW AS + S-CSCF->>AS: 2. INVITE + AS->>S-CSCF: 3. INVITE + S-CSCF->>P-CSCF: 4. INVITE + P-CSCF->>UE-B: 5. INVITE + UE-B->>P-CSCF: 6. 183 Session progress + P-CSCF->>AS: 7. 183 Session progress + AS->>S-CSCF: 8. 183 Session progress + S-CSCF->>AS: 9. 183 Session progress + S-CSCF->>External: 10. 183 Session progress + UE-B->>P-CSCF: 11. 180 Ringing Alert-Info: urn:alert:service:call-waiting + P-CSCF->>AS: 12. 180 Ringing Alert-Info: urn:alert:service:call-waiting + AS->>S-CSCF: 13. 180 Ringing Alert-Info: urn:alert:service:call-waiting + Note right of AS: 13a. CW timer starts + AS->>P-CSCF: 14. 180 Ringing Alert-Info: urn:alert:service:call-waiting + Note right of UE-B: [11a. Possibility for User B to react: release session, invoke HOLD, ...] +not part of CW + Note right of AS: 14a. AS may initiate CW announcement + UE-B->>P-CSCF: 16. 200 OK + P-CSCF->>AS: 17. 200 OK + AS->>S-CSCF: 18. 200 OK + Note right of AS: 18a. CW timer stops + S-CSCF->>AS: 19. 200 OK + S-CSCF->>External: 20. 200 OK + +``` + +Sequence diagram showing the callflow for Terminal based CW at the terminating side, successful communication establishment. The diagram involves four main entities: S-CSCF, AS, P-CSCF, and UE-B. The process starts with an INVITE from an external source to the S-CSCF. The S-CSCF performs service control and forwards it to the AS. The AS then sends an INVITE to the P-CSCF, which in turn sends it to the UE-B. The UE-B responds with a 183 Session progress, which is forwarded back through the P-CSCF and AS to the S-CSCF. The S-CSCF then sends a 180 Ringing Alert-Info (call-waiting) to the AS, which in turn sends it to the P-CSCF and then to the UE-B. The AS also starts a CW timer. The UE-B may react by releasing the session or invoking HOLD. The AS may initiate a CW announcement. The P-CSCF sends a 200 OK to the UE-B, which is forwarded back through the AS and S-CSCF to the external source. The AS stops the CW timer. The S-CSCF sends a 200 OK to the external source. + +**Figure 4.4-2. Example callflows for Terminal based CW at the terminating side, successful communication establishment (Figure A.2.1 of 3GPP TS 24.615 [10])** + +For all cases, The P-CSCF serving the UE can recognise the SIP dialogue toward different SIP Call-IDs. + +The SIP/SDP signalling will be translated by the P-CSCF into Rx signalling towards the PCRF according to the Annex A of 3GPP TS 29.214 [4] and clause 6.2 of 3GPP TS 29.213 [3]. In particular: + +- The different Rx sessions will be used +- The IMS Communication Service Identifier value for MMTEL will be provided as AF-Application-Identifier. +- The Rx session and media towards different communication dialogues are not explicitly marked. +- Resource sharing among the media related to the different SIP dialogues can be requested as specified in subclause A.12 of 3GPP TS 29.214 [4] + +There is only a single IP CAN session and only one Gx session. As described for the bearer binding mechanism (see 3GPP TS 29.213 [3]), the Bearer Binding Function (BBF) located at the PCEF will evaluate whether it is possible to use one of the existing IP-CAN bearers that has the same QoS class identifier and ARP. + +It is desirable to enable the PCEF to request the network to generate separate CDR the usage between different communication dialogues and to recognise the media components exchanged between different communication origins. + +The PCEF provides the capability to categorise the service data flows within IP-CAN bearer data traffic by rating group or combination of the rating group and service id according to subclauses 5.2.1.3 and 5.3.1.2 of 3GPP TS 32.251 [8]. However, the PCRF could not supply different rating group or service id for the different PCC rules in this scenario. If charging correlation is used, it is very hard for the charging system to correlate the PS CDR and IMS CDR. There may be one PS CDR with multiple AF-Correlation-Information. + +# --- 5 Requirements analysis and assumptions + +## 5.1 Requirements analysis and assumptions for CT3 + +In order to support the volume based charging for IMS, all the IMS scenarios as described in clause 4 should be supported. The requirements for CT3 have been identified: + +- 1) The PCRF shall be able to identify CAT media and normal media; +- 2) The PCRF shall be able to identify media related to different called parties; +- 3) The PCEF shall be able to separate charging records generated for CAT media and normal media; +- 4) The PCEF shall be able to separate charging records generated between the UE and different parties. + +## 5.2 Requirements analysis and assumptions for CT1 + +In order to support the volume based charging for IMS, all the IMS scenarios as described in clause 4 should be supported. The requirements for CT1 have been identified: + +- 1) The P-CSCF shall be able to identify from the SIP signalling that the CAT service is to be used so that the P-CSCF can provide a CAT service indication to PCRF; +- 2) The P-CSCF shall be able to identify from the SIP signalling that the 3PTY conference service is to be used so that the P-CSCF can provide a 3PTY conference service indication to PCRF. + +# --- 6 Alternative solutions for CT3 + +## 6.1 Solution 1: PCRF configuration solution addressing on requirement 2 and 4 for CT3 + +### 6.1.1 Introduction + +This solution addresses requirement 2 and 4 for CT3 and specifically considers how the PCRF identify media related to different called parties and how the PCEF separate charging records generated between the UE and different parties. + +### 6.1.2 Procedure and Function Description + +Addressing requirement 2 for CT3: + +The P-CSCF use Content-Type AVP within the Media-Component-Description AVP to mark the IMS content type for the PCRF to identify the conference service information. + +The Content-Type AVP determines the IMS content type of a session component. The following values are defined: + +CONFERENCE (x) + +This value is used to indicate that the content corresponding to the affected media component is the conference. + +NOTE 1: The Content-Type AVP is a new AVP and the name, the definition and the encoding can be further analysed in the normative work. + +The PCRF will be configured with a group of rating group(RG) or service ID(SID) for one service (e.g. IMS Communication Service) based on the IMS Communication Service Identifier within the AF-Application-Identifier AVP and the IMS content type within the Content-Type AVP. + +When the PCRF receives a new Rx session with the same IMS Communication Service within the "AF-Application-Identifier" AVP as a previous one and this previous Rx session still exists, the PCRF will select a different RG or SID from the PCC rule related the previous Rx session to separate the volume charging between the two Rx sessions. The PCEF will install the PCC rules with the different RG and SID. + +NOTE 2: When the new AVP is used and the indicator to identify conference service is SDP a=content media-level attribute line, the a=content media-level attribute line do not need to be included in the "Codec-Data" AVP to avoid duplication of information. Otherwise, the "Codec-Data" AVP within the Media-Component-Description AVP shall be used to mark the IMS content type for the PCRF to identify the CAT service information This could be further analysed in the normative work. + +NOTE 3: If duplicated Rx session are used, the DUPLICATED\_AF\_SESSION Permanent Failure can occur. + +NOTE 4: The number configured for a group of rating groups or service IDs for one service will limit the number that PCRF support Rx sessions when the previous Rx session with same "AF-Application-Identifier" still exists. + +Addressing requirement 4 for CT3: + +The PCEF will separate charging records generated for the UE and different parties based on the rating group(RG) or service ID(SID). + +NOTE 5: When the PCRF update the RG or service ID(SID) for the existing PCC rule, there can be some impact on the online and/or offline charging mechanism. This could be updated in the normative work. + +### 6.1.3 Analysis + +This solution can address the requirement 2 and 4 for CT3 and specifically considers how the PCRF identify media related to different called parties and how the PCEF separate charging records generated between the UE and different parties. + +There are additional requirements on the P-CSCF: + +The P-CSCF shall be able to indicate the PCRF to mark related media as the conference service. + +NOTE 1: Whether introducing a new AVP or reusing the Codec-Data AVP to indicate the conference service will be studied in the normative work. + +There are additional requirements on the PCRF: + +The PCRF shall be able to be configured with a group of rating group(RG) or service ID(SID) for one service (e.g. IMS Communication Service). + +The PCRF shall be able to update the RG or service ID(SID) for the existing PCC rule. + +There is additional requirement on the PCEF: + +The PCEF shall be able to separate charging records generated for the UE and different parties based on the rating group(RG) or service ID(SID). + +NOTE 2: When the PCRF update the RG or service ID(SID) for the existing PCC rule, there can be some impact on the online and/or offline charging mechanism. This could be further analysed in the normative work. + +## 6.2 Solution 2: PCRF configuration solution addressing on requirement 1 and 3 for CT3 + +### 6.2.1 Introduction + +This solution addresses requirement 1 and 3 for CT3 and specifically considers how the PCRF identify CAT media and normal media and how the PCEF separate charging records generated for CAT media and normal media. + +### 6.2.2 Procedure and Function Description + +Addressing requirement 1 for CT3: + +The P-CSCF use Content-Type AVP within the Media-Component-Description AVP to mark the IMS content type for the PCRF to identify the CAT service information. The Content-Type AVP determines the IMS content type of a session component. The following values are defined: + +###### NO\_CONTENT\_DETAIL (0) + +This value is used to indicate that no information about the IMS content type is being provided. This is the default value applicable if the AVP is omitted. + +###### CAT (1) + +This value is used to indicate that the content corresponding to the affected media component is CAT early media. + +NOTE 1: The Content-Type AVP is a new AVP and the name, the definition and the encoding can be updated in the normative work. + +The PCRF will be configured with a group of rating group(RG) or service ID(SID) for one service (e.g. IMS Communication Service) based on the IMS Communication Service Identifier within the AF-Application-Identifier AVP, and the IMS content type within the Content-Type AVP. + +NOTE 2: When the new AVP is used and the indicator to identify CAT early media is SDP a=content media-level attribute line, the a=content media-level attribute line do not need to be included in the "Codec-Data" AVP to avoid duplication of information. Otherwise, the "Codec-Data" AVP within the Media-Component-Description AVP shall be used to mark the IMS content type for the PCRF to identify the CAT service information This could be futher analysed in the normative work. + +Addressing requirement 3 for CT3: + +The PCEF will separate charging records generated for CAT media and normal media based on the rating group(RG) or service ID(SID). + +NOTE 3: When the PCRF update the RG or service ID(SID) for the existing PCC rule, there can be some impact on the online and/or offline charging mechanism. This could be futher analysed in the normative work. + +### 6.2.3 Analysis + +This solution can address the requirement 1 and 3 for CT3 and specifically considers how the PCRF identify CAT media and normal media and how the PCEF separate charging records generated for CAT media and normal media. + +When the feature is supported, the additional requirements are as follows. + +There is additional requirement on the P-CSCF: + +The P-CSCF shall be able to indicate the PCRF to mark the related media as the CAT service. + +NOTE 1: Whether introducing a new AVP or reusing the Codec-Data AVP to indicate the CAT service will be studied in the normative work. + +There are additional requirements on the PCRF: + +The PCRF shall be able to be configured with a group of rating group(RG) or service ID(SID) for one service (e.g. IMS Communication Service). + +The PCRF shall be able to update the RG or service ID(SID) for the existing PCC rule. + +There is additional requirement on the PCEF: + +The PCEF shall be able to separate charging records generated for CAT media and normal media based on the rating group(RG) or service ID(SID). + +NOTE 2: When the PCRF update the RG or service ID(SID) for the existing PCC rule, there can be some impact on the online and/or offline charging mechanism. This could be futher analysed in the normative work. + +# --- 7 Alternative solutions for CT1 + +## 7.1 Solution 1: Convey CAT service indication in SDP + +### 7.1.1 Introduction + +This solution addresses the requirement on P-CSCF being able to identify that the CAT service is to be used so that the P-CSCF can provide a CAT service indication to PCRF. + +The PCRF needs the CAT service indication to distinguish the media flow used for CAT service from that used for other media during the session, thus the CAT service indication should be bound to a particular media component over the Rx interface. 3GPP TS 24.182 [5] specifies the use of a=content media-level attribute with the value of "g.3gpp.cat" in the SDP which identifies the corresponding media component is used for CAT service, this media-level attribute can be used to convey CAT service indication. + +### 7.1.2 Procedure and Function Description + +#### 7.1.2.1 General + +When sending a SIP message with SDP related to the CAT media, the CAT AS includes the a=content media-level attribute line with the value of "g.3gpp.cat" under the corresponding media line. If the received SDP contains such an a=content media-level attribute line, the P-CSCF includes a CAT service indicator in the Diameter message used for initial provisioning or modification of session indication as described in subclause 6.2. + +#### 7.1.2.2 Procedure for CAT AS acting in forking model + +If the CAT AS is acting in forking model as specified in 3GPP TS 24.182 [5], the procedure of convey CAT service indication to PCRF is shown in Figure 7.1.2.2-1. + +![Sequence diagram showing the procedure of conveying CAT service indication when forking model. The diagram involves five lifelines: UE (MO), PCRF (MO), P-CSCF (MO), CAT AS, and UE (MT). The sequence starts with an INVITE (SDP_0) from UE (MO) to P-CSCF (MO), which is then forwarded to CAT AS and then to UE (MT). UE (MT) responds with 180 (Ringing) (D2) to CAT AS. CAT AS responds with 18x (SDP_CAT, g.3gpp.cat, D1) to P-CSCF (MO). P-CSCF (MO) sends an AAR (g.3gpp.cat) to PCRF (MO), which responds with AAA. P-CSCF (MO) then sends 18x (SDP_CAT, g.3gpp.cat, D1) to UE (MO). A 'Play CAT media' block occurs between P-CSCF (MO) and CAT AS. UE (MT) sends 200 (OK) (SDP_T, D2) to CAT AS, which is forwarded to P-CSCF (MO) as 10.200 (OK) (SDP_T, D2). P-CSCF (MO) sends an AAR to PCRF (MO), which responds with AAA. Finally, P-CSCF (MO) sends 200 (OK) (SDP_T, D2) to UE (MO).](26d664119ad25250780f554633444e54_img.jpg) + +``` + +sequenceDiagram + participant UE_MO as UE (MO) + participant PCRF as PCRF (MO) + participant P_CSCF as P-CSCF (MO) + participant CAT_AS as CAT AS + participant UE_MT as UE (MT) + + Note right of P_CSCF: 25 + + UE_MO->>P_CSCF: 1. INVITE (SDP_0) + P_CSCF->>CAT_AS: 2. INVITE (SDP_0) + CAT_AS->>UE_MT: 3. INVITE (SDP_0) + UE_MT-->>CAT_AS: 4. 180 (Ringing) (D2) + CAT_AS-->>P_CSCF: 5. 18x (SDP_CAT, g.3gpp.cat, D1) + P_CSCF->>PCRF: 6. AAR (g.3gpp.cat) + PCRF-->>P_CSCF: 7. AAA + P_CSCF-->>UE_MO: 8. 18x (SDP_CAT, g.3gpp.cat, D1) + + Note over P_CSCF, CAT_AS: Play CAT media + + UE_MT-->>CAT_AS: 9. 200 (OK) (SDP_T, D2) + CAT_AS-->>P_CSCF: 10. 200 (OK) (SDP_T, D2) + P_CSCF->>PCRF: 11. AAR + PCRF-->>P_CSCF: 12. AAA + P_CSCF-->>UE_MO: 13. 200 (OK) (SDP_T, D2) + +``` + +Sequence diagram showing the procedure of conveying CAT service indication when forking model. The diagram involves five lifelines: UE (MO), PCRF (MO), P-CSCF (MO), CAT AS, and UE (MT). The sequence starts with an INVITE (SDP\_0) from UE (MO) to P-CSCF (MO), which is then forwarded to CAT AS and then to UE (MT). UE (MT) responds with 180 (Ringing) (D2) to CAT AS. CAT AS responds with 18x (SDP\_CAT, g.3gpp.cat, D1) to P-CSCF (MO). P-CSCF (MO) sends an AAR (g.3gpp.cat) to PCRF (MO), which responds with AAA. P-CSCF (MO) then sends 18x (SDP\_CAT, g.3gpp.cat, D1) to UE (MO). A 'Play CAT media' block occurs between P-CSCF (MO) and CAT AS. UE (MT) sends 200 (OK) (SDP\_T, D2) to CAT AS, which is forwarded to P-CSCF (MO) as 10.200 (OK) (SDP\_T, D2). P-CSCF (MO) sends an AAR to PCRF (MO), which responds with AAA. Finally, P-CSCF (MO) sends 200 (OK) (SDP\_T, D2) to UE (MO). + +**Figure 7.1.2.2-1: procedure of convey CAT service indication when forking model** + +NOTE: The network entities and the messages which are not concerned is not shown in the figure. + +##### **1-3 INVITE request (UE(MO) to UE(MT))** + +UE(MO) sends a SIP INVITE request to UE(MT). + +##### **4 180 (Ringing) response (UE(MT) to CAT AS)** + +UE(MT) sends a SIP 180 response to CAT AS. + +##### **5 18x response (CAT AS to P-CSCF(MO))** + +CAT AS sends a SIP 18x response to the P-CSCF(MO). The SIP 18x response contains the SDP of the CAT media. An a=content attribute line with value of "g.3gpp.cat" is included in the SDP. + +##### **6 Diameter AAR (P-CSCF(MO) to PCRF)** + +P-CSCF(MO) provides the session information to the PCRF, the CAT service indication is contained in this message. + +##### **7 Diameter AAA (PCRF to P-CSCF(MO))** + +PCRF respond to P-CSCF(MO) with AAA. + +##### **8 18x response (P-CSCF(MO) to UE(MO)).** + +P-CSCF(MO) forwards the SIP 18x response to the UE(MO). + +##### **9-10 200 (OK) response (UE(MT) to P-CSCF(MO)).** + +UE(MT) sends 200 (OK) response to the initial INVITE request, the SDP of media used for the voice communication on the MT UE is included in the 200 (OK) response. + +##### **11 Diameter AAR (P-CSCF(MO) to PCRF).** + +P-CSCF(MO) modifies the session information, the CAT service indication is not included in this message. + +##### **12 Diameter AAA (PCRF to P-CSCF(MO)).** + +PCRF respond to P-CSCF(MO) with AAA. + +##### **13 200 (OK) response (P-CSCF(MO) to UE(MO)).** + +P-CSCF(MO) forwards the SIP 200 (OK) response to the UE(MO). + +#### 7.1.2.3 Procedure for CAT AS acting in early session model + +If the CAT AS is acting in early session model as specified in 3GPP TS 24.182 [5], the procedure of convey CAT service indication to PCRF is shown in Figure 7.1.2.3-1. + +![Sequence diagram showing the procedure for CAT AS acting in early session model. The diagram illustrates the interaction between UE (MO), PCRF (MO), P-CSCF (MO), CAT AS, and UE (MT).](21d8ca19de468e733e521605b1890767_img.jpg) + +``` + +sequenceDiagram + participant UE_MO as UE (MO) + participant PCRF_MO as PCRF (MO) + participant P_CSCF_MO as P-CSCF (MO) + participant CAT_AS as CAT AS + participant UE_MT as UE (MT) + + UE_MO->>P_CSCF_MO: 1. INVITE (SDP_0) + P_CSCF_MO->>CAT_AS: 2. INVITE (SDP_0) + CAT_AS->>UE_MT: 3. INVITE (SDP_0) + UE_MT->>CAT_AS: 4. 180 (Ringing) + CAT_AS->>P_CSCF_MO: 5. 18x (early session SDP_CAT, g.3gpp.cat) + P_CSCF_MO->>PCRF_MO: 6. AAR (g.3gpp.cat) + PCRF_MO->>P_CSCF_MO: 7. AAA + P_CSCF_MO->>UE_MO: 8. 18x(early session, SDP_CAT, g.3gpp.cat) + + Note over UE_MO, CAT_AS: Play CAT media + + UE_MT->>CAT_AS: 9. 200 (OK) (SDP_T) + CAT_AS->>P_CSCF_MO: 10. 200 (OK) (SDP_T) + P_CSCF_MO->>PCRF_MO: 11. AAR + PCRF_MO->>P_CSCF_MO: 12. AAA + P_CSCF_MO->>UE_MO: 13. 200 (OK) (SDP_T) + +``` + +Sequence diagram showing the procedure for CAT AS acting in early session model. The diagram illustrates the interaction between UE (MO), PCRF (MO), P-CSCF (MO), CAT AS, and UE (MT). + +**Figure 7.1.2.3-1: procedure of convey CAT service indication when early session model** + +NOTE: The network entities and the messages which are not concerned is not shown in the figure. + +##### **1-3 INVITE request (UE(MO) to UE(MT))** + +UE(MO) sends a SIP INVITE request to UE(MT). + +##### **4 180 (Ringing) response (UE(MT) to CAT AS)** + +UE(MT) sends a SIP 180 response to CAT AS. + +##### **5 18x response (CAT AS to P-CSCF(MO))** + +CAT AS sends a SIP 18x response to the P-CSCF(MO). The SIP 18x response contains the SDP of the CAT media. An a=content attribute line with value of "g.3gpp.cat" is included in the SDP. + +##### **6 Diameter AAR (P-CSCF(MO) to PCRF)** + +P-CSCF(MO) provides the session information to the PCRF, the CAT service, the CAT service indication is not included in this message. + +##### **12 Diameter AAA (PCRF to P-CSCF(MO)).** + +PCRF respond to P-CSCF(MO) with AAA. + +##### **13 200 (OK) response (P-CSCF(MO) to UE(MO)).** + +P-CSCF(MO) forwards the SIP 200 (OK) response to the UE(MO). + +#### **7.1.2.4 Procedure for CAT AS acting in Gateway model** + +If the CAT AS is acting in Gateway model as specified in 3GPP TS 24.182 [5], the procedure of convey CAT service indication to PCRF is shown in Figure 7.1.2.4-1. + +![Sequence diagram showing the procedure of convey CAT service indication when Gateway model. The diagram involves five lifelines: UE (MO), PCRF (MO), P-CSCF (MO), CAT AS, and UE (MT). The sequence starts with an INVITE (SDP_0) from UE (MO) to P-CSCF (MO), which is then forwarded by P-CSCF (MO) to CAT AS and then to UE (MT). UE (MT) responds with 180 (Ringing) to CAT AS, which is then forwarded by CAT AS to P-CSCF (MO) as 18x (SDP_CAT, g.3gpp.cat). P-CSCF (MO) sends an AAR (g.3gpp.cat) to PCRF (MO), which responds with AAA. P-CSCF (MO) then forwards the 18x response to UE (MO). A 'Play CAT media' block occurs between P-CSCF (MO) and CAT AS. UE (MT) sends a 200 (OK) (SDP_T) to CAT AS, which is forwarded by CAT AS to P-CSCF (MO) as an UPDATE (SDP_T). P-CSCF (MO) sends an UPDATE (SDP_T) to UE (MO), which responds with 200 (OK) (SDP_0). P-CSCF (MO) sends an AAR to PCRF (MO), which responds with AAA. P-CSCF (MO) sends a 200 (OK) (SDP_0) to CAT AS, which is forwarded by CAT AS to P-CSCF (MO) as a 200 (OK). Finally, P-CSCF (MO) sends a 200 (OK) to UE (MO).](9c1d3678db4a12d5864cb2a4def1135d_img.jpg) + +``` + +sequenceDiagram + participant UE_MO as UE (MO) + participant PCRF as PCRF (MO) + participant P_CSCF as P-CSCF (MO) + participant CAT_AS as CAT AS + participant UE_MT as UE (MT) + + UE_MO->>P_CSCF: 1. INVITE (SDP_0) + P_CSCF->>CAT_AS: 2. INVITE (SDP_0) + CAT_AS->>UE_MT: 3. INVITE (SDP_0) + UE_MT-->>CAT_AS: 4. 180 (Ringing) + CAT_AS-->>P_CSCF: 5. 18x (SDP_CAT, g.3gpp.cat) + P_CSCF->>PCRF: 6. AAR (g.3gpp.cat) + PCRF-->>P_CSCF: 7. AAA + P_CSCF-->>UE_MO: 8. 18x (SDP_CAT, g.3gpp.cat) + + rect rgb(255, 255, 255) + Note over UE_MO, CAT_AS: Play CAT media + end + + UE_MT-->>CAT_AS: 9. 200 (OK) (SDP_T) + CAT_AS-->>P_CSCF: 10. UPDATE (SDP_T) + P_CSCF-->>UE_MO: 11. UPDATE (SDP_T) + UE_MO-->>P_CSCF: 12. 200 (OK) (SDP_0) + P_CSCF->>PCRF: 13. AAR + PCRF-->>P_CSCF: 14. AAA + P_CSCF-->>CAT_AS: 15. 200 (OK) (SDP_0) + CAT_AS-->>P_CSCF: 16. 200 (OK) + P_CSCF-->>UE_MO: 17. 200 (OK) + +``` + +Sequence diagram showing the procedure of convey CAT service indication when Gateway model. The diagram involves five lifelines: UE (MO), PCRF (MO), P-CSCF (MO), CAT AS, and UE (MT). The sequence starts with an INVITE (SDP\_0) from UE (MO) to P-CSCF (MO), which is then forwarded by P-CSCF (MO) to CAT AS and then to UE (MT). UE (MT) responds with 180 (Ringing) to CAT AS, which is then forwarded by CAT AS to P-CSCF (MO) as 18x (SDP\_CAT, g.3gpp.cat). P-CSCF (MO) sends an AAR (g.3gpp.cat) to PCRF (MO), which responds with AAA. P-CSCF (MO) then forwards the 18x response to UE (MO). A 'Play CAT media' block occurs between P-CSCF (MO) and CAT AS. UE (MT) sends a 200 (OK) (SDP\_T) to CAT AS, which is forwarded by CAT AS to P-CSCF (MO) as an UPDATE (SDP\_T). P-CSCF (MO) sends an UPDATE (SDP\_T) to UE (MO), which responds with 200 (OK) (SDP\_0). P-CSCF (MO) sends an AAR to PCRF (MO), which responds with AAA. P-CSCF (MO) sends a 200 (OK) (SDP\_0) to CAT AS, which is forwarded by CAT AS to P-CSCF (MO) as a 200 (OK). Finally, P-CSCF (MO) sends a 200 (OK) to UE (MO). + +**Figure 7.1.2.4-1: procedure of convey CAT service indication when Gateway model** + +NOTE: The network entities and the messages which are not concerned is not shown in the figure. + +##### **1-3 INVITE request (UE(MO) to UE(MT))** + +UE(MO) sends a SIP INVITE request to UE(MT). + +##### **4 180 (Ringing) response (UE(MT) to CAT AS)** + +UE(MT) sends a SIP 180 response to CAT AS. + +##### **5 18x response (CAT AS to P-CSCF(MO))** + +CAT AS sends a SIP 18x response to the P-CSCF(MO). The SIP 18x response contains the SDP of the CAT media. An a=content attribute line with value of "g.3gpp.cat" is included in the SDP. + +###### **6 Diameter AAR (P-CSCF(MO) to PCRF)** + +P-CSCF(MO) provides the session information to the PCRF, the CAT service indication is contained in this message. + +##### **7 Diameter AAA (PCRF to P-CSCF(MO))** + +PCRF respond to P-CSCF(MO) with AAA. + +###### **8 18x response (P-CSCF(MO) to UE(MO)).** + +P-CSCF(MO) forwards the SIP 18x response to the UE(MO). + +###### **9 200 (OK) response (UE(MT) to CAT AS).** + +UE(MT) sends 200 (OK) response to the initial INVITE request, the SDP of media used for the voice communication on the MT UE is included in the 200 (OK) response. + +##### **10-11 UPDATE request (CAT AS to UE(MO)).** + +CAT AS sends SIP UPDATE request to the UE(MO) to update the SDP used for the voice communication. The a=content attribute line with value of "g.3gpp.cat" is not included in this SDP. + +###### **12 200 (OK) response (UE(MO) to P-CSCF(MO)).** + +UE(MO) responds to the UPDATE request. + +###### **13 Diameter AAR (P-CSCF(MO) to PCRF).** + +P-CSCF(MO) modifies the session information, the CAT service indication is not included in this message. + +###### **14 Diameter AAA (PCRF to P-CSCF(MO)).** + +PCRF respond to P-CSCF(MO) with AAA. + +##### **15-17 The rest of the call flow** + +### 7.1.3 Analysis + +This solution can address the requirement on P-CSCF being able to identify that the CAT service is to be used so that the P-CSCF can provide a CAT service indication to PCRF + +There is no additional requirement on IM CN subsystem functionalities which are under remit of CT1. + +## 7.2 Solution 2: Convey a conference service indication in SDP + +### 7.2.1 Introduction + +This solution addresses the requirement on P-CSCF being able to identify from the SIP signalling that the conference service is to be used so that the P-CSCF can provide a conference service indication to PCRF. + +### 7.2.2 Procedure and Function Description + +During the SDP negotiation procedure, the conference AS includes a=content media-level attribute line with value of "g.3gpp.conf" in the SDP which is related to the media component used for the conference. + +If the received SDP contains such an a=content media-level attribute line with value of "g.3gpp.conf", the P-CSCF includes a conference service indication in the Diameter message used for initial provisioning or modification of session indication as described in subclause 6.1. + +### 7.2.3 Analysis + +This solution can address the requirement on P-CSCF being able to identify from the SIP signalling that the conference service is to be used so that the P-CSCF can provide a conference service indication to PCRF. + +There is additional requirement on the conference AS to include an a=content media-level attribute line with value of "g.3gpp.conf" in the SDP related to the media flow used for conference service. + +# 8 Conclusions and recommendations + +## 8.1 Conclusions and recommendations for CT3 + +The present document investigates some functional enhancements which can be used by IMS services to separate the volume usage between different IMS based services (e.g. CAT and voice calls, 3PTY conference, Communication waiting, Communication Hold). + +When the feature is supported the following is to be standardized during CT3 normative work: + +Addressing requirement 1 for CT3: + +The P-CSCF shall indicate the PCRF to mark related media as the CAT service. + +NOTE 1: Whether introducing a new AVP or reusing the Codec-Data AVP to indicate the CAT service will be studied in the normative work. + +NOTE 2: If duplicated Rx session are used, the DUPLICATED\_AF\_SESSION Permanent Failure can occur. + +The PCRF could be configured with a group of rating groups or service IDs for one service (e.g. IMS Communication Service). The PCRF will assign a different rating group or service ID for the different identified media. The PCRF shall be able to update the RG or service ID(SID) for the existing PCC rule. + +NOTE 3: The number configured for a group of rating groups or service IDs for one service will limit the number that PCRF support Rx sessions when the previous Rx session with same "AF-Application-Identifier" still exists. Whether the PCRF reject the coming new Rx session or not when the number of group of rating groups or service IDs for one service reached the configuration will be studied in the normative work. + +Addressing requirement 2 for CT3: + +The P-CSCF shall be able to indicate the PCRF to mark related media as conference service. + +NOTE 4: Whether introducing a new AVP or reusing the Codec-Data AVP to indicate the conference service will be studied in the normative work. + +The PCRF could be configured with a group of rating groups or service IDs for one service (e.g. IMS Communication Service). The PCRF will assign a different rating group or service ID for the identified media for the different parties. The PCRF shall be able to update the RG or service ID(SID) for the existing PCC rule. + +NOTE 5: The number configured for a group of rating groups or service IDs for one service will limit the number that PCRF support Rx sessions when the previous Rx session with same "AF-Application-Identifier" still exists. Whether the PCRF reject the coming new Rx session or not when the number of group of rating groups or service IDs for one service reached the configuration will be studied in the normative work. + +Addressing requirement 3 for CT3: + +The PCEF will separate charging records generated for the UE and different parties based on the rating group(RG) or service ID(SID). + +NOTE 6: When the PCRF update the RG or service ID(SID) for the existing PCC rule, there can be some impact on the online and/or offline charging mechanism. This could be futher analysed in the normative work. + +Addressing requirement 4 for CT3: + +The PCEF will separate charging records generated for CAT media and normal media based on the rating group(RG) or service ID(SID). + +NOTE 7: When the PCRF update the RG or service ID(SID) for the existing PCC rule, there can be some impact on the online and/or offline charging mechanism. This could be further analysed in the normative work. + +## 8.2 Conclusions for CT1 + +### 8.2.1 Conclusion on the solution for convey CAT service indication + +It is concluded to standardize the solution described in subclause 7.1. + +No further normative work is needed in CT1. + +### 8.2.2 Conclusion on the solution for convey call parties information + +It is concluded to standardize the solution described in subclause 7.2. + +The following is to be standardized during CT1 normative work: + +- a) a new a=content media-level attribute line value, e.g. "g.3gpp.conf"; +- b) the conference AS shall include a=content media-level attribute line with value of "g.3gpp.conf" in the SDP used for conference media. + +# Annex A (informative): Change history + +| Change history | | | | | | | | | +|----------------|---------|-----------|----|-----|-----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|--|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | | New version | +| 2016-11 | | | | | | TS skeleton of Study on Policy and Charging for Volume Based Charging. | | 0.0.0 | +| 2017-02 | | | | | | Inclusion of documents agreed in CT3#87 C3-164214, C3-164215. Inclusion of documents agreed in CT3#88 C3-171239, C3-171283, C3-171309, C3-171310. | | 0.1.0 | +| 2017-04 | | | | | | Inclusion of documents agreed in CT3#89 C3-172208, C3-172209, C3-172210. | | 0.2.0 | +| 2017-05 | | | | | | Inclusion of documents agreed in CT3#90 C3-173327, C3-173328. | | 0.3.0 | +| 2017-10 | | | | | | Inclusion of documents agreed in CT3#92 C3-175339, and document agreed in CT1#106 C1-174477. | | 0.4.0 | +| 2017-12 | | | | | | Inclusion of documents agreed in CT3#93 C3-176290, C3-176291, C3-176292, C3-176386, C3-176387 and documents agreed in CT1#107 C1-175285, C1-175264, and C1-175265 | | 0.5.0 | +| 2017-12 | CT-78 | CP-173108 | | | | TS sent to plenary for information and approval | | 1.0.0 | +| 2017-12 | CT-78 | CP-173108 | | | | TS approved at plenary | | 15.0.0 | +| 2020-07 | SA#88e | - | - | - | - | Update to Rel-16 version (MCC) | | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29843/26d664119ad25250780f554633444e54_img.jpg b/marked/Rel-16/29_series/29843/26d664119ad25250780f554633444e54_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c378879fd8f7c2dfbd0878245b1f8c05002144ac --- /dev/null +++ b/marked/Rel-16/29_series/29843/26d664119ad25250780f554633444e54_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fb9233b4d25b92a5cc6c70f1b98b91d3e121f65bbae1499c18547e5cd445adf2 +size 114509 diff --git a/marked/Rel-16/29_series/29843/474a819357587e34949a3e110ff19b30_img.jpg b/marked/Rel-16/29_series/29843/474a819357587e34949a3e110ff19b30_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b96787109519f5b7c3dd92b423a1d41823d8d362 --- /dev/null +++ b/marked/Rel-16/29_series/29843/474a819357587e34949a3e110ff19b30_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9efc016d97ea16cf90923ed0f2fd61e643cc3012c089ac70b64859a9db971a1b +size 90516 diff --git a/marked/Rel-16/29_series/29843/4cde160bcc69b7b6c81b648dd0e4252e_img.jpg b/marked/Rel-16/29_series/29843/4cde160bcc69b7b6c81b648dd0e4252e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6cf5cee422d6fbe44434f84514e347d916a59f17 --- /dev/null +++ b/marked/Rel-16/29_series/29843/4cde160bcc69b7b6c81b648dd0e4252e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:602311f62cb336a5e0e9eb59e313a16a668b7db8e1f3c8ec83f292cf20673ebc +size 100722 diff --git a/marked/Rel-16/29_series/29843/5456ef9dc49ffc9cbb93cf1dd8052884_img.jpg b/marked/Rel-16/29_series/29843/5456ef9dc49ffc9cbb93cf1dd8052884_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..73ed9aebd4d8ac1cc774e64805cff620c4f1cd2f --- /dev/null +++ b/marked/Rel-16/29_series/29843/5456ef9dc49ffc9cbb93cf1dd8052884_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:75056bdbbb49ff8c527c7c97ce3884b387446909bb2511fa90b2a0b475608834 +size 65976 diff --git a/marked/Rel-16/29_series/29843/79e1709a7317ead45379cbb8ff3ba802_img.jpg b/marked/Rel-16/29_series/29843/79e1709a7317ead45379cbb8ff3ba802_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e2ea62a50ff36b5760a0ec5a99d9d314a9e78188 --- /dev/null +++ b/marked/Rel-16/29_series/29843/79e1709a7317ead45379cbb8ff3ba802_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2edead44b9c84c0f757646d08b85f7adc481f297f8e75b20b8647dfb3bf012fc +size 80189 diff --git a/marked/Rel-16/29_series/29843/b904ac2472cab80892d1e783e6230d6e_img.jpg b/marked/Rel-16/29_series/29843/b904ac2472cab80892d1e783e6230d6e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c0b443f282778b1c330ce33cd6d1aaae32a42184 --- /dev/null +++ b/marked/Rel-16/29_series/29843/b904ac2472cab80892d1e783e6230d6e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:04bb24c245436d07dca1d8d7ef53863200042c7886382f04ad5da359c023c0b1 +size 37239 diff --git a/marked/Rel-16/29_series/29843/d0abac95583b52a3b35f74a215567334_img.jpg b/marked/Rel-16/29_series/29843/d0abac95583b52a3b35f74a215567334_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..672d4e2404817bed9e431c132be8a0438eb31aac --- /dev/null +++ b/marked/Rel-16/29_series/29843/d0abac95583b52a3b35f74a215567334_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c7d80c10a46d8babbc287b4d7bfbb88dd7f95f2266fce6d2ea1a3a8925104185 +size 83955 diff --git a/marked/Rel-16/29_series/29843/raw.md b/marked/Rel-16/29_series/29843/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..5f1a6613345fb67e9d81c24ce7a5aea1b16b7c37 --- /dev/null +++ b/marked/Rel-16/29_series/29843/raw.md @@ -0,0 +1,1232 @@ + + +# **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Study on Load and Overload Control of 5GC Service Based Interfaces; (Release 16)** --- + +## --- **Keywords** + + + +## **3GPP** + +## --- **Postal address** + +## --- **3GPP support office address** + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +## --- **Internet** + + + +## --- **Copyright Notification** + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2019, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTSTM is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|-------------------------------------------------------------------------------------------------------------|----| +| Foreword ..... | 5 | +| Introduction ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions, symbols and abbreviations..... | 6 | +| 3.1 Definitions..... | 6 | +| 3.2 Abbreviations ..... | 6 | +| 4 Architectural Baseline..... | 7 | +| 5 Service Based Architecture Deployment Topologies ..... | 7 | +| 5.1 Introduction ..... | 7 | +| 5.2 Direct Interaction Models without Intermediaries ..... | 7 | +| 5.2.1 Direct NF to NF Interaction ..... | 7 | +| 5.2.2 NF Services as Distributed Collection ..... | 7 | +| 5.2.3 Interpretation of Overload ..... | 8 | +| 5.3 Indirect Interaction Models through Intermediaries..... | 8 | +| 5.3.1 NF Service Instances behind a Service Communication Proxy without delegated NF Service discovery..... | 8 | +| 5.3.2 NF Service Instances behind a Service Communication Proxy with delegated NF Service discovery ..... | 9 | +| 5.3.3 Interpretation of Overload ..... | 9 | +| 6 Overload Scenarios ..... | 10 | +| 6.1 Introduction ..... | 10 | +| 6.2 Overload Caused due to UE Initiated Signalling ..... | 10 | +| 6.3 Overload Caused due to Failure and Restart of Network Functions..... | 11 | +| 6.4 Overload Caused due to Notifications ..... | 11 | +| 7 Key Requirements for Load Control..... | 11 | +| 7.1 Introduction ..... | 11 | +| 7.2 Key Requirement #1: Load Information Conveyance ..... | 11 | +| 7.3 Key Requirement #2: Co-existence with Rel-15 Load Control..... | 12 | +| 7.4 Key Requirement #3: Regulation of Load Information Reception and Conveyance in the NRF..... | 12 | +| 8 Key Requirements for Overload Control..... | 12 | +| 8.1 Introduction ..... | 12 | +| 8.2 Key Requirement #1: Overload Conveyance..... | 12 | +| 8.3 Key Requirement #2: Mechanisms for avoiding and mitigating overload ..... | 13 | +| 8.4 Key Requirement #3: Overload Control ..... | 13 | +| 9 Evaluation of Release 15 Load and Overload Control ..... | 13 | +| 9.1 Introduction ..... | 13 | +| 9.2 R15 Overload Control ..... | 14 | +| 9.2.1 Behaviour ..... | 14 | +| 9.2.2 Evaluation and Conclusion..... | 15 | +| 9.3 R15 Load Control Analysis..... | 16 | +| 9.3.1 Analysis ..... | 16 | +| 9.3.2 Evaluation and Conclusion..... | 16 | +| 10 Solutions for Load Control ..... | 17 | +| 10.1 Introduction ..... | 17 | +| 10.2 Solution #1: Direct Load Information Conveyance ..... | 17 | +| 10.3 Solution #2: Load Control Co-Existence ..... | 17 | +| 10.4 Solution #3: Regulation of Load Information Change Notifications Conveyance by the NRF ..... | 18 | +| 10.5 Solution #4: Regulation of Load Information Updates Reception at the NRF ..... | 18 | +| 10.6 Evaluation and Conclusion..... | 19 | + +| | | | +|---------------|------------------------------------------------------------------------------------------|-----------| +| 11 | Solutions for Overload Control..... | 19 | +| 11.1 | Introduction ..... | 19 | +| 11.2 | Principles of Overload Control ..... | 19 | +| 11.3 | Solution #1: Conveying Overload Information via Signalling ..... | 20 | +| 11.4 | Solution #2: Explicit Overload Control Information Conveyance..... | 22 | +| 11.5 | Solution #3: Overload Control Information ..... | 22 | +| 11.6 | Solution #4: Overload Avoidance and Mitigation ..... | 24 | +| 11.7 | Solution #5: Frequency of Inclusion - Piggyback in every HTTP signalling message ..... | 26 | +| 11.8 | Solution #6: Conveying Overload Information via NRF ..... | 26 | +| 11.9 | Solution #7: Conveying OCI via Overload Control Service ..... | 28 | +| 11.10 | Solution #8: Overload Control enforcement behaviour ..... | 29 | +| 11.11 | Solution #9: Location of OCI..... | 30 | +| 11.12 | Solution#10: Overload control by redirecting requests to another NF within a NF set..... | 31 | +| 11.13 | Solution #11: Overload Control Enforcement by SCPs..... | 32 | +| 11.14 | Conveyance of Overload Information with hyperlink ..... | 32 | +| 11.15 | Evaluation and Conclusion..... | 34 | +| 11.15.1 | Evaluation of the Solutions ..... | 34 | +| 12 | Selected solutions..... | 36 | +| 12.1 | Selected solution for Overload Control..... | 36 | +| 12.2 | Solution outline and implications on SBI specifications ..... | 36 | +| 12.2.1 | Overload Conveyance - General (key requirement #1.1)..... | 36 | +| 12.2.2 | Overload Conveyance - Semantics (key requirement #1.2)..... | 36 | +| 12.2.3 | Overload Conveyance - Frequency (key requirement #1.3)..... | 37 | +| 12.2.4 | Overload Conveyance - Where to include OCI (key requirement #1.4)..... | 37 | +| 12.2.5 | Overload Conveyance - HATEOAS (key requirements #1.1 and #1.4) ..... | 37 | +| 12.2.6 | Overload - Avoiding and mitigating (key requirement #2)..... | 37 | +| 12.2.7 | Overload Control (key requirement #3) ..... | 38 | +| Annex: | Change history ..... | 39 | + +# --- Foreword + +This Technical Report has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +*This clause is optional. If it exists, it is always the second unnumbered clause.* + +# --- 1 Scope + +The present document identifies key requirements for the load and overload control on the service based interfaces, identifies the deployment topologies to consider for analysing the solutions for the load and overload control, analyses the 3GPP Release 15 overload control mechanism for the service based interfaces and identifies solutions for addressing the requirements for load and overload control on the service based interfaces. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [4] 3GPP TR 23.742: "Study on Enhancements to the Service-Based Architecture". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] 3GPP TS 29.502: "5G System; Session Management Services; Stage 3". +- [7] 3GPP TR 23.843: "Study on Core Network Overload Solutions". +- [8] 3GPP TS 23.527: "5G System; Restoration Procedures". +- [9] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in TR 21.905 [1]. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in TR 21.905 [1]. + +| | | +|-----|------------------------------| +| OCI | Overload Control Information | +| SCP | Service Communication Proxy | + +# --- 4 Architectural Baseline + +3GPP Release 15 Service Based Architecture as specified in TS 23.501 [2] and the Technical Realization of the Service Based Architecture as specified in TS 29.500 [3] shall be taken as the baseline for the study on load and overload control in service based interfaces. Further the conclusions from 3GPP release 16 FS\_eSBA study as specified in TR 23.742 [4] shall be taken into account. + +# --- 5 Service Based Architecture Deployment Topologies + +## 5.1 Introduction + +This clause identifies the various deployment models possible with Release 15 service based architecture. These deployment models are used to evaluate the various load and overload control mechanisms. + +## 5.2 Direct Interaction Models without Intermediaries + +### 5.2.1 Direct NF to NF Interaction + +In this topology, each NF and correspondingly the NF services interact directly with its peer NF and the NF services. The following are the key characteristics of this topology: + +- TCP connection is directly between the interacting NF services. +- For https scheme URIs, the TLS connection is direct between the interacting NF services. +- Detection of overload of the peer NF/NF service can be done based on the direct interaction with the peer. +- Any new overload conveyance mechanism need not be concerned about the issues related to presence of intermediaries (i.e proxies). + +### 5.2.2 NF Services as Distributed Collection + +In this topology, an NF / NF service instance can provide an API URI root which is used by the NF service consumers for initiating the creation of resources. The initial HTTP/2 messages from the NF service consumers for the creation of resources are handled by an origin server that is authoritative for this API URI, while the resource is created at a backend processing instance of the NF service instance. The authority part of the API may be changed due to this and the exact resource URI is returned in the Location header of the resource creation response. Subsequent interactions with the resource happen towards the resource URI returned in the Location header. This is illustrated in figure 5.3-1. + +![Diagram illustrating the NF Services as Distributed Collection topology. An NF Service Consumer sends a resource create request (HTTP POST) to an Initial Origin Server (part of the NF Service Producer). The Initial Origin Server creates the resource in another origin server within the same NF service instance. The Initial Origin Server then sends a response indicating the selected origin server. Subsequent HTTP/2 messages are sent to the selected origin server.](d0abac95583b52a3b35f74a215567334_img.jpg) + +``` + +sequenceDiagram + participant Consumer as NF Service Consumer + participant InitialOriginServer as NF Service Producer +Initial Origin Server + participant SelectedOriginServer as NF Service Producer +Origin Server Selected for Resource Creation + + Note left of Consumer: 1. Send resource create request (HTTP POST) to initial origin server + Consumer->>InitialOriginServer: Request + Note right of InitialOriginServer: 2. Create the resource in another origin server within the same NF service instance + InitialOriginServer->>SelectedOriginServer: Create + Note right of InitialOriginServer: 3. Send resource create response from initial origin server indicating the selected origin server where the resource is created. + InitialOriginServer-->>Consumer: Response + Note left of SelectedOriginServer: 4. Subsequent HTTP/2 messages with the origin server where the resource is created + Consumer->>SelectedOriginServer: Subsequent Request + +``` + +Diagram illustrating the NF Services as Distributed Collection topology. An NF Service Consumer sends a resource create request (HTTP POST) to an Initial Origin Server (part of the NF Service Producer). The Initial Origin Server creates the resource in another origin server within the same NF service instance. The Initial Origin Server then sends a response indicating the selected origin server. Subsequent HTTP/2 messages are sent to the selected origin server. + +**Figure 5.2.2-1: NF Services as Distributed Collection** + +This topology is specified in release 15 in TS 29.501 [5] and is currently used by the SMF services as specified in TS 29.502 [6]. The following are the key characteristics of this topology: + +- HTTP/2 connection for the initial create request terminates at the initial origin server that handles the resource create requests. +- HTTP/2 connection for the subsequent interaction (e.g update resource methods) with the created resource terminates at the origin server where the resource was created. +- The authority part of the resource URI is changed during resource creation, and hence the initial create request and subsequent requests are handled by two different origin servers. + +### 5.2.3 Interpretation of Overload + +For the direct interaction topologies specified above, the following points apply for the interpretation of the detected overload condition. + +- For the Release 15 overload detection mechanism, whether the detected overload is associated with the NF service instance or with the origin server is upto HTTP/2 client implementations. +- If the HTTP/2 client implementations associate the overload with an origin server, then for the model specified in clause 5.2.2, overload detection will happen independently for the initial origin server that handles resource create requests and the origin servers where the resources are actually created. +- Any new overload conveyance mechanism may consider associating the overload with a NF service instance instead of per origin server, if required. + +## 5.3 Indirect Interaction Models through Intermediaries + +### 5.3.1 NF Service Instances behind a Service Communication Proxy without delegated NF Service discovery + +In this deployment model, a NF Service Consumer first discovers the API endpoint (service URI) of the NF Service Producer by querying the NRF. The NF Service Consumer then routes the request to the NF Service Producer through a + +Service Communication Proxy (SCP, e.g a HTTP forward and reverse proxy). SCPs may be deployed in a distributed manner in which case, a SCP on the side of the NF Service Consumer acts as a HTTP forward proxy while a SCP on the side of the NF Service Producer acts as a HTTP reverse proxy. The SCP routes the request to appropriate instance of the NF Service Producer. This topology is specified in Annex C of TR 23.742 [4] as model C. In this deployment model, the "authority" part of the URI used by the NF service consumer to access the NF service producer may be: + +- the FQDN / IP address representing the NF service producer, if the NF service consumer does the NF service producer discovery and selection but is not aware of the number of backend instances behind the SCP in which case the SCP (acting as a HTTP reverse proxy) selects an instance; or +- the FQDN / IP address representing the NF service producer instance, if the NF service consumer does NF service producer instance discovery and selection. + +### 5.3.2 NF Service Instances behind a Service Communication Proxy with delegated NF Service discovery + +In this deployment model, a NF Service Consumer does not discover the API endpoint (service URI) of the NF Service Producer by itself. Instead, the NF Service Consumer routes the request to a SCP and the SCP based on the contents of the request URI and/or HTTP headers performs a NF service discovery either by configuration or optionally by querying the NRF that has been assigned for the set of slices or the slice instance corresponding to NF services involved in the indirect communication. SCPs may be deployed in a distributed manner in which case, a SCP on the side of the NF Service Consumer acts as a HTTP forward proxy while a SCP on the side of the NF Service Producer acts as a HTTP reverse proxy. An SCP in the communication path does the NF service producer instance selection. The SCP(s) then routes the request to a selected instance of the NF Service Producer. This topology is specified in Annex C of TR 23.742 [4] as model D. In this deployment model, the "authority" part of the URI used by the NF service consumer to access the NF service producer may be: + +- for initial requests, the FQDN representing the NF type if a deployment delegates the discovery of NF service producer instance or NF service producer set and corresponding instance within the set to the SCP (see clause 6.3.1.x of 3GPP 23.501 [2]); or +- for subsequent requests, the FQDN representing the NF service producer set if a deployment delegates NF service provider instance selection within a set to the SCP (i.e. concept of a set is visible to the consumer and the NF service consumer delegates the NF service producer instance selection within the set to the SCP and there is no binding between a NF service consumer and a particular NF service producer instance); or +- the FQDN / IP address representing the NF service producer if a deployment delegates NF service producer instance selection to the SCP (i.e. NF service consumer is not aware of the number of backend instances behind the SCP in which case the SCP acting as a HTTP reverse proxy selects an instance, and there is no binding required between a NF service consumer and a particular NF service producer instance). + +### 5.3.3 Interpretation of Overload + +For the indirect interaction topologies specified above, the following points apply for the interpretation of the detected overload condition. + +- For the Release 15 overload detection mechanism, whether the detected overload is associated with the NF service instance or the NF service instance set or the SCP depends on what the authority part of the request URI contains. +- Any new overload conveyance mechanism may consider associating the overload with a specific scope (e.g. at NF service instance level or NF service set level). + +# 6 Overload Scenarios + +## 6.1 Introduction + +3GPP has done a detailed study of scenarios leading to overload in the core network elements in 3GPP Release 12, available in TR 23.843 [7]. Many of the scenarios are applicable to 5GC as well, while some scenarios like overload due to frequent IDLE-CONNECTED state transition can be mitigated in 5GC by using solutions like RRC-INACTIVE state. The following clauses provide a list of scenarios that may lead to overload situation in the 5GC service based interfaces. + +## 6.2 Overload Caused due to UE Initiated Signalling + +The following different UE initiated and/or UE induced signalling events can cause overload in the 5GC service based interfaces. + +1. Large number of UEs performing mobility registration procedure. In densely populated areas, mass rapid transport systems transport large number of people from one location to another at high speeds. This will lead to a large number of UEs doing mobility registrations simultaneously after they move from one registration area to another. In the case of 5G this problem can be further aggravated since it is not only the smartphones that get transported along with the humans that travel, but there will be a lot of IoT devices like wearables, V2X UEs and sensors monitoring and transmitting active vehicle diagnostic information that will be generating signalling towards the core network due to rapid mobility. +2. Large number of UEs generating application signalling that induces signalling at the 3GPP 5GC elements + - An example scenario is large number of people watching a live sports event at a stadium and trying to catch the action replay videos, videos of player profiles, use of Augmented Reality (AR) glasses or headsets to get augmented information at real time related to the event and players. These scenarios can create or update or delete QoS flows which can lead to massive signalling in the 5GC service based interfaces. + - Another example is the application level heartbeat messages from large number of UEs in a region, causing frequent IDLE-CONNECTED state transitions leading to NG-RAN to AMF to SMF to UPF signalling. Though this can be mitigated in 5GC by use of RRC-INACTIVE state, such scenarios may still cause a core network overload if RRC-INACTIVE is not used. +3. Large number of UEs generating application layer broadcasts which results in signalling flood towards each member of that application layer broadcast domain. For example, when a large number of UEs is part of an Ethernet DN and they run IP above the Ethernet PDU session, ARP or IPv6 Neighbour Discovery can generate huge signalling if ARP proxying / IPv6 ND proxying are not implemented. As per TS 23.501 [2], clause 5.6.10.2 + +*NOTE 4: Entities on the LAN connected to the 5GS by the UE may have an IP address allocated by the DN but the IP layer is considered as an application layer which is not part of the Ethernet PDU Session.* + +and + +*Neither a MAC nor an IP address is allocated by the 5GC to the UE for a PDU Session.* + +Since IP address allocation to entities on the LAN (including the UE which is part of the LAN) is considered as an application layer functionality, it is possible that 3GPP 5GC NFs like UPF and SMF have no visibility into the MAC address to IP address mapping and hence ARP / IPv6 ND proxying cannot be effectively implemented. In such cases, an ARP / IPv6 Neighbour Solicitation request may result in being broadcasted to every Ethernet entity (including UEs) that are part of the DN. If many UEs are in CM-IDLE state, this will result in N11 signalling for triggering N3 tunnel setup which would further lead to massive paging and subsequent service request leading to N11 communication again. + +TS 23.501 [2], clause 5.6.10.2 specifies mechanisms to avoid overloads due to such broadcast / multicast traffic over Ethernet PDU sessions. + +## 6.3 Overload Caused due to Failure and Restart of Network Functions + +The following different scenarios related to failure and restart of network functions can cause overload in the 5GC service based interfaces. + +1. Restart of a network function, indicated by its recovery timestamp, can lead to: + - re-creation of resources at the restarted NF, if the peer NFs decide to restore the resources; or + - it can lead to clean-up of resources, which would likely lead to the deregistration or release of PDU sessions towards a large number of UEs. + +See TS 23.527 [8], clause 6. In all cases, restart of a network function can result in large number of signalling messages on the 3GPP 5GC service based interfaces within a short interval of time. +2. When the FTEID allocation is done by the UPF, upon restart of a V-UPF, then restoration of the PFCP sessions as specified in clause 4.3.4 of TS 23.527 [8], can result in large number of signalling messages on the N16 interface for Home Routed PDU sessions, if the V-UPF allocated different FTEIDs. + +## 6.4 Overload Caused due to Notifications + +The following different scenarios related to notifications can cause overload in the 5GC service based interfaces. Notifications may be at per UE level or per PDU session level or per UE group level or per NF level. + +1. Some of the 5GC NFs support EventExposure service. This allows any authorized NF to subscribe for event notifications. Depending on the type of event, some events may occur very frequently for a large number of UEs. Examples are: Location change, UE presence in an area of interest report. This can lead to a lot of event notifications on the service based interfaces leading to overload. +2. NRF supports subscribing for NF status reports at an NF type level. Any change of NF profile of NFs of the subscribed type can lead to a notification. 3GPP Release 15 has specified mechanisms to filter such notifications based on monitored and unmonitored attributes of NF profile. When such filtering mechanisms are not used, then, if there are large number of instances of a particular NF type, this may result in frequent notifications leading to overload in the service based interfaces. + +# --- 7 Key Requirements for Load Control + +## 7.1 Introduction + +This clause contains the key requirements to be addressed for load control of service based interfaces. + +## 7.2 Key Requirement #1: Load Information Conveyance + +As identified in clause 9.3.2, the release 15 load control mechanism has some limitations. Consequently solutions for conveying the load information of NF service producer to NF service consumers need to be identified. + +This key issue shall study solutions for: + +- Sub-Issue#1: Alternative mechanisms for conveying the load information of NF service producers to NF service consumers apart from the Rel-15 mechanism. +- Sub-Issue#2: Content of the conveyed load information. +- Sub-Issue#3: Frequency of inclusion / conveyance. + +- Sub-Issue#4: Where to include the conveyed load information (e.g. HTTP headers, payload) + +## 7.3 Key Requirement #2: Co-existence with Rel-15 Load Control + +Even if new mechanisms for conveying load information is agreed in Rel-16 it is expected that it has to co-exist with existing Rel-15 deployments using the Rel-15 load conveyance and control mechanism. + +This key issue shall study solutions for: + +- Sub-issue#1: How an NF service producer discovers an NF service consumer's support for new Rel-16 load conveyance mechanism. +- Sub-issue#2: Recommendations for NF service producers on the use of Rel-15 mechanism to update the load information in NRF when there are NF service consumers supporting Rel-16 mechanism. +- Sub-issue#3: How an NF service consumer discovers an NF service producer's support for new Rel-16 load conveyance mechanism. + +## 7.4 Key Requirement #3: Regulation of Load Information Reception and Conveyance in the NRF + +As highlighted in clause 9.3.2, Rel-15 load control mechanism has some limitations with regards to the frequency of load information change notifications sent by the NRF to the subscribed NFs, which might lead in some scenarios to overload situations in these NFs. In a similar way, defining a highly frequent load information update by NFs in the NRF might also lead in some cases to overloading the NRF itself, e.g. due to the associated processing load. Therefore, this key requirement aims at addressing these two identified issues and opens for potential solutions. + +This key issue shall hence study solutions for: + +- Sub-Issue#1: Defining a mechanism that enables to control and manage the frequency of load information change from the NRF to the subscribing NFs. +- Sub-Issue#2: Defining a mechanism that enables to control and manage the frequency of load information updates by NFs in the NRF. + +# --- 8 Key Requirements for Overload Control + +## 8.1 Introduction + +This clause contains the key requirements to be addressed for overload control of messages sent over the service based interfaces. + +## 8.2 Key Requirement #1: Overload Conveyance + +As identified in clause 9, the time to detect overload condition and the ease of overload situation at a NF service producer by a NF service consumer depends on the value of W and K. It is identified that low values of W would lead to false positives. Hence with larger values of W, the number of rejects taken to identify overload condition and/or the ease of overload condition increases. This requires alternate solutions to be studied for conveying the current overload situation at a NF service producer to a NF service consumer so that the NF service consumer can react immediately. + +This key issue shall study solutions for the following: + +- Sub-Issue#1: Solutions for conveying current overload situation at a NF service producer to a NF service consumer +- Sub-Issue#2: Information to be included in the conveyed overload information. Information used to associate the conveyed overload information with a particular scope (e.g. NF service level, NF service instance level, specific DNN and/or S-NSSAI level, upstream NF services like PCF, H-SMF etc.) +- Sub-Issue#3: Frequency of inclusion. +- Sub-Issue#4: Where to include the conveyed overload information (e.g. HTTP headers, payload) + +## 8.3 Key Requirement #2: Mechanisms for avoiding and mitigating overload + +Since the architecture of 5GC allows virtualized deployment of NF services, it is possible to avoid and/or mitigate overload situations by scaling the virtualized instances of the NF service in some deployments. In addition, the Release 16 eSBA architecture allows NF services to be deployed as a set allowing incoming requests to be routed to any NF service instance within a set. This mechanism also allows for horizontally scaling the number of instances within a set and avoid overload situations. + +This key issue shall study the following: + +- Mechanisms for avoiding overload scenarios at NF services; +- Mechanisms for mitigating overload situation when they arise at NF services, without impacting ongoing signalling and without any reactive behaviour from the NF Service Consumers (HTTP Clients); +- Deployment scenarios where such mechanisms are applicable. + +## 8.4 Key Requirement #3: Overload Control + +In Release-15, once a HTTP client learns that a HTTP Service is overloaded based on the "503 Service Unavailable" or "429 Too Many Requests" status codes as specified in clause 6.4 of TS 29.500 [3], the client applies an adaptive throttling mechanism as specified in Annex A of TS 29.500 [3]. + +Assuming that solutions for feeding back exact overload status of HTTP server (NF Service Producer) are identified in Release-16, this key issue shall study solutions for: + +- How an NF Service Consumer (HTTP Client) reacts based on the information received in Overload Control Information. +- How intermediaries (e.g. V-SMF, SCP) react + +# --- 9 Evaluation of Release 15 Load and Overload Control + +## 9.1 Introduction + +The release 15 overload control behaviour is based on the HTTP/2 client side doing adaptive throttling of requests based on the number of requests sent and the number requests accepted. This is specified in Annex A of TS 29.500 [3]. The following clauses analyze the behavior of release 15 mechanism. + +Release 15 also supports NF / NF service selection based on the load information provided by NRF during NF / NF service discovery procedure. This clause also analyses the Release 15 load control mechanism. + +## 9.2 R15 Overload Control + +### 9.2.1 Behaviour + +The Release 15 HTTP client determines that the HTTP server is overloaded by keeping track of the number of requests sent vs the number of requests accepted. In order to be meaningful in determining the overload condition without false positives, it is suggested to keep a window for tracking the number of requests sent vs number of requests accepted and apply the congestion detection algorithm only after the window is full. + +NOTE: If the client side overload detection is applied as soon as the first reject is received from the server even before the window is full at the client side, it will result in showing up as number of accepts vs number of requests sent as minimal triggering a false state of congestion at server even though the reject received could be just one off. + +The detection is based on the following formula as specified in Annex A of TS 29.500 [3]. + +$$\max\left(0, \frac{\text{requests} - K \times \text{accepts}}{\text{requests} + 1}\right)$$ + +where K. determines how aggressively the HTTP client detects and applies the adaptive throttling. Assuming the following: + +- Client side signalling rate is X requests per T time units; +- Window size, W, as a multiple "N" of X (where N can be integer or fractional). + +Table 9.2-1 provides a calculation of the number of rejects up to which the client can tolerate before detecting an overload condition at the server, for various values of K and N. The reject tolerance calculation formula is derived as follows: + +- $(\text{requests} - K \times \text{accepts}) > 0$ +- $\text{requests} > (K \times \text{accepts})$ +- $\text{requests} > (K \times (\text{requests} - \text{rejects}))$ +- $(\text{requests}/K) > (\text{requests} - \text{rejects})$ + +Therefore, $\text{rejects} > (\text{requests} - (\text{requests} / K))$ + +Using a window size of W, the reject tolerance point at which overload is detected can be written as: + +- $C_T = \text{Ceiling}(W - W/K)$ + +**Table 9.2-1: Reject Tolerance before Detecting Overload by HTTP Client using Release 15 Overload Control Algorithm** + +| Sl.No | Value of K | Number of requests sent within a time interval "t" - X | Client side window size multiplier N.
Window size W = N times X | Number of rejects client can tolerate until detecting overload at the server, $C_T = \text{Ceiling}(W - W/K)$ . | +|-------|------------|--------------------------------------------------------|--------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------| +| 1 | 1.2 | 1500 | 1 (= 1500) | 250 | +| 2 | 1.2 | 1500 | 2 (=3000) | 500 | +| 3 | 1.3 | 1500 | 1 (= 1500) | 347 | +| 4 | 1.3 | 1500 | 2 (=3000) | 693 | + +| | | | | | +|----|-----|------|------------|------| +| 5 | 1.4 | 1500 | 1 (= 1500) | 429 | +| 6 | 1.4 | 1500 | 2 (=3000) | 858 | +| 7 | 1.5 | 1500 | 1 (= 1500) | 500 | +| 8 | 1.5 | 1500 | 2 (=3000) | 1000 | +| 9 | 1.6 | 1500 | 1 (= 1500) | 563 | +| 10 | 1.6 | 1500 | 2 (=3000) | 1125 | +| 11 | 1.8 | 1500 | 1 (= 1500) | 667 | +| 12 | 1.8 | 1500 | 2 (=3000) | 1334 | +| 13 | 2 | 1500 | 1 (= 1500) | 750 | +| 14 | 2 | 1500 | 2 (=3000) | 1500 | +| 15 | 1.5 | 1500 | 0.01 (=15) | 5 | + +The following observations can be made from the table: + +- The larger the window size $W$ , the greater is the reject tolerance and hence greater is the time taken to detect overload; +- The larger the value of $K$ , the greater is the reject tolerance and hence greater is the time taken to detect overload; +- Very small window sizes could lead to false positives; +- Once the overload is detected, the number of rejects should fall below the tolerance point $C_T$ , in order for the client to detect that overload condition has eased and not apply any client side throttling; +- Hence the time required to detect that overload condition has eased at the server depends on $W$ and $K$ . + +Once a HTTP client detects that the number of rejects is below the tolerance point $C_T$ , the client stops throttling and allows all the request messages be sent to the server. However the server may still be in overload, albeit to a lesser degree, and will continue rejecting messages at a lesser rate. + +### 9.2.2 Evaluation and Conclusion + +The Rel-15 Overload Control Mechanism (Adaptive Throttling at the client side) as specified in clause 6.4 and Annex A of TS 29.500 [3] has the following deficiencies: + +- a) Latency for converging to optimal output traffic the server can handle, when overload increases or alleviates + +Clients have to send a certain number of requests before detecting that the server is overloaded, which causes additional load on the server. + +With a bigger $K$ value throttling is more permissive resulting in increased latency to reduce traffic when overload increases but faster convergence when overload alleviates, and vice versa. + +When the client throttling rate reaches a high value, latency may happen for client's traffic to increase when overload alleviates. + +- b) Client parameters may result in too aggressive or too permissive behaviour towards the overloaded server. +- c) The mechanism is less optimal for bursty traffic and rapid increase of traffic. When highly overloaded the server cannot request clients to stop sending requests. The mechanism does not enable server feedback for rapid adaption when traffic level increase. +- d) Clients have to keep track of traffic history (requests accepted/rejected) per API. + +- e) Different clients can behave very differently, depending on the algorithm implemented, parameters K and window size, and frequency of requests sent. This can result in unfair server resource usage by clients. +- f) Adaptive throttling parameters (e.g. K, window size) need to be configured in all clients. + +## 9.3 R15 Load Control Analysis + +### 9.3.1 Analysis + +Release 15 supports the following mechanisms for controlling the load on an NF / NF service: + +- Register an NF or NF service load percentage (0-100) and capacity with NRF (see clause 6.1.6.2.2 and 6.1.6.2.3 of TS 29.510 [9]). +- Update the dynamic load and capacity of an NF or NF service with NRF (see clause 5.2.2.3.2 of TS 29.510 [9]) using heartbeat messages or dedicated update requests. +- Notification of change of dynamic load of an NF or NF service to the consumers that are subscribed for that notification (see clause 6.1.6.2.43 of TS 29.510 [9]). +- NF / NF service instance selection based on the load information provided by NRF during NF / NF service instance discovery (see clause 6.3.2 of TS 23.501 [2]). + +The following are the characteristics of the Release 15 load control mechanism: + +- Dynamic load information of NFs / NF services are discovered via NRF. +- Any subsequent updates to the already discovered load information requires subscription to NRF for notification about NF status. +- For home routed roaming scenarios, NF service consumers (e.g. AMF) may need to subscribe for notifications about NF / NF service status from HPLMN (e.g. H-SMF). +- The NRF can take dynamic load and capacity of NFs / NF services into account when processing NF discovery requests. + +### 9.3.2 Evaluation and Conclusion + +The following are the issues identified with Rel-15 load control mechanism: + +- Learning of the current load of a NF service producer is based on notifications from NRF. This could potentially lead to a massive number of notifications in a network if all the NF service consumers subscribe for notifications about the current load of NF service producers as the load will keep changing dynamically. +- The periodicity of notifications depends on the periodicity of the heartbeat mechanism between NF service consumer and the NRF. In order to avoid stale load information in the NRF, an NF service producer has to update its NF status in the NRF more frequently using this heartbeat mechanism, thus leading to frequent large number of notifications from the NRF to all NF service consumers that have subscribed to this service producer's NF status change notifications. +- If NF service consumers wish to avoid frequent notifications by not subscribing to the NF status notifications from the NRF, then they will not be aware of the NF service producer's actual load at a given point of time. This would lead to NF service consumers incorrectly selecting an NF service producer instance that is loaded more than another lightly loaded instance. +- NRF becomes the single point of contact for learning load information of NF service producers and hence has the risk of becoming a single point of failure. High availability of the NRF is hence required. +- depends on the NRF supporting this Rel-15 load control mechanism. + +# 10 Solutions for Load Control + +## 10.1 Introduction + +## 10.2 Solution #1: Direct Load Information Conveyance + +This solution addresses key requirement#1, sub-issues #1 and #2 specified in clause 7.2. + +While in the existing Rel-15 solution load and capacity information is conveyed between NFs indirectly via the NRF, it is proposed for Rel-16 as an option (making use of the supported feature mechanism) to allow in addition to the existing Rel-15 solution also direct signalling of Load Control Information (LCI) between NFs piggybacked on existing messages. + +Information conveyed directly between NFs shall contain the identity of the LCI reporting NF/ NF service (i.e. the scope of the load information), a static capacity value, a load percentage value indicating the percentage of the static capacity that is actually not available for new requests, a timestamp or sequence number used to identify stale information. + +The conveyed LCI shall be used for load balancing among a set of candidate NF / NF service instances. + +Direct LCI conveyance piggybacked on existing messages allows clients to detect a server's current load + +- without the need for potentially massive notification traffic from the NRF; clients can avoid massive notification traffic by unsubscribing from notifications, but then they are not aware of the server's actual load. +- in a timely manner independent from heartbeat frequency; +- at a finer granularity; +- independent from NRF deployments; +- frequently, as the reporting frequency naturally increases with the NF load; +- without relying on the NRF (single point of failure) that may fail and lose information after restart. + +## 10.3 Solution #2: Load Control Co-Existence + +This solution addresses key requirement#2 specified in clause 7.3. + +It is proposed that the Supported Features mechanism specified in Rel-15 be used to discover the support of Rel-16 load control mechanism. A NF service producer may convey the load information to a NF service consumer, using a Rel-16 mechanism only if the NF service consumer has included in the Supported Features that it supports Rel-16 load conveyance / control mechanism. + +A Rel-16 NF service producer is still required to update its load information periodically to the NRF since the load information is returned in NF discovery response and based on that a NF service consumer performs the selection of NF service producer instances. + +However to avoid frequent notifications of the load from NRF to NF service consumers, it shall be possible, based on operator policy, to configure the NRF to not notify changes in the "load" parameter and subscriptions for NF status notifications be restricted only to changes in the other parameters (e.g. not allow subscriptions for "/load" attribute "monitoredAttributes" parameter, see clause 6.1.6.2.43 of TS 29.510 [9]) of the NF / NF service profile. + +**Editor's Note:** It is FFS how and when to restrict the sending of "load" parameter (e.g. not allow subscriptions for "/load" attribute "monitoredAttributes" parameter). + +It is recommended to apply such restrictions in the NRF as given below: + +- For intra PLMN cases, apply only if it is known that all NF service consumers in the PLMN support Rel-16 load conveyance / control mechanism. +- For inter PLMN cases, apply based on operator policy. + +## 10.4 Solution #3: Regulation of Load Information Change Notifications Conveyance by the NRF + +This solution addresses key requirement#3, sub-issue#1 specified in clause 7.4. + +As clearly highlighted in clause 9.3.2 and clause 7.4, it might be possible that the frequency of load information change notifications increases for some reason (e.g. a NF producer load increases rapidly in a short timeframe) in such a way that leads to overload situations in the subscribed NFs. + +This solution proposes thus to define a threshold-based mechanism to enable a NF (e.g. NF consumer) to regulate the frequency of change notifications of load information of another NF (NF consumer) it has subscribed to in order to protect itself from getting to overload situations due to a potential rapid increase of the traffic associated to these notifications. The operation of this mechanism is described hereinafter: + +- When subscribing with the NRF to notifications of changes in load information of another NF, a NF shall be able to specify a set of conditions on the frequency of reception of these notifications; +- This set of condition can consist on: + - The definition of one or several thresholds, e.g. the subscribing NF requests the NRF to send notifications only when certain specific load level(s) is/are reached and/or when the load level has increased/decreased by a certain amount, and/or; + - The specification of some periodicity parameters and/or timers, e.g. the subscribing NF requests the NRF to send notifications with respect to a certain periodicity and not systematically each time there is a change in the load information of the concerned NF, and/or; + - Any other relevant parameter, e.g. other conditions defined by the operator; +- The mechanism used to manage the logical combinations of the above mentioned conditions that control the triggering of notifications is operator specific, e.g. notifications are sent by the NRF if one of the conditions is satisfied; +- NFs shall be able to modify these conditions settings anytime in the NRF; +- If no conditions are present in the subscription to notifications request, the NRF shall behave as in Rel-15 and hence send notifications each time there is a change of load information in the concerned NF. + +## 10.5 Solution #4: Regulation of Load Information Updates Reception at the NRF + +This solution addresses key requirement#3, sub-issues#2 specified in clause 7.4. + +As clearly highlighted in clause 9.3.2 and clause 7.4, it might be possible that the frequency by which NFs update their load information in the NRF becomes high for some reason (e.g. a configuration error or NFs load increases rapidly in a short timeframe) in such a way that leads to overload situations in the NRF, e.g. due to the necessary associated processing load. + +This solution proposes thus to define a threshold-based mechanism to enable a NRF to regulate the frequency of load information updates it receives from a NF so as to protect itself from getting to overload situations due to a potential rapid increase of the traffic related to these updates. The operation of this mechanism is described hereinafter: + +- The NRF shall be able to configure and indicate to a NF a set of conditions that have to be respected for the communication of load information updates; +- This set of condition can consist on: + - The definition of one or several thresholds, e.g. the NRF requests the NF to send load information updates only when certain specific load level(s) is/are reached and/or when the load level has increased/decreased by a certain amount, and/or; + - The specification of some periodicity parameters and/or timers, e.g. the NRF requests the NF to send load information updates with respect to a certain periodicity and not systematically each time there is a change in the load information of the concerned NF, and/or; + - Any other relevant parameter, e.g. other conditions defined by the operator; +- The mechanism used to manage the logical combinations of the above mentioned conditions that control the triggering of load information updates is operator specific, e.g. load information updates are sent if one of the conditions is satisfied; +- If no conditions are set by the NRF, the NF shall behave as it is currently described in Rel-15. + +## 10.6 Evaluation and Conclusion + +As documented in clause 9.3.2, the release 15 load control mechanism has some limitations. This clause proposes an evaluation of the proposed solutions for Rel-16 load control improvements. The following recommendations are hence made as a conclusion for this study: + +- It is recommended that the solution for key issue #1 described in clause 10.2, i.e. to enable direct signalling of Load Control Information (LCI) piggybacked on existing signalling messages between NFs, will be used as a basis for further normative work. +- To avoid frequent notifications of the load from NRF to NF service consumers (key Issue #2), the following will be addressed in the normative work: + - the NF consumer supporting Rel-16 load control mechanism should unsubscribe from notifications of load information updates of a NF producer with the NRF as soon as it discovers the support of the same Rel-16 load control mechanism by this NF producer. + - the NRF and 5G NFs may also be configured, e.g. based on exchanged conditions for regulating notifications and/or on operator policy, and/or may consider the service consumer requested regulations of Load Information Change Notifications e.g. as documented in solution 10.x.1, in order to reduce regulate the frequency of traffic related to notifications of changes in the "load" parameter. + +**Editor's note:** The above bullet for reducing/regulating load change updates and notifications is ffs. + +# --- 11 Solutions for Overload Control + +## 11.1 Introduction + +This clause identifies the solutions for the key requirements identified in clause 8 for overload control. Each solution specifies the key issues and the specific aspects of those key issues it addresses. + +## 11.2 Principles of Overload Control + +Reactive overload control based on HTTP reject status codes by HTTP clients is already specified in 3GPP release 15 in TS 29.500 [3]. The high level principles of new overload control mechanisms to be adopted in Release 16 are summarized below: + +- a) Any new overload conveyance and overload control mechanism shall co-exist with release 15 mechanism; + +- b) Conveyance of overload control information by any means is optional; +- c) If a receiving NF / NF service consumer instance does not understand the conveyed overload control information it shall ignore it. The overload control adopted by such receiving NF / NF service instances shall be the release 15 mechanism; +- d) An NF / NF service producer (instance) compliant to R16 overload control mechanism, shall also return the specific HTTP status codes specified in TS 29.500 [3], clause 6.4 when the overload condition has not eased even after conveying overload control information (i.e the sending NF / NF service (instance) assumes that the receiving NF / NF service instance only supports release 15 overload control mechanism); +- e) It shall be possible to associate the conveyed overload control information with a specific scope. The scopes shall be identified as part of the study; +- f) The overload control mechanism shall allow preferential treatment of priority users (eMPS) and emergency services; +- g) It shall be possible for an NF / NF service consumer to know the overload status of an NF / NF service producer even if they are not directly interacting (i.e interacting via an intermediary). Example use cases are AMF sending a PDU session establishment request to H-SMF via a V-SMF and SMF communicating with AMF via a I-SMF. + +**Editor's Note:** Other principles, if any, are FFS. + +## 11.3 Solution #1: Conveying Overload Information via Signalling + +This solution addresses the subissue#1 in Key Issue#1 specified in clause 8.2 + +- Solutions for conveying current overload situation at a NF service producer to a NF service consumer + +In this solution, the following principles are followed + +- The NF Service Producer shall be able to provide the current overload situation via an Overload Control Information (OCI) IE in existing signaling messages; +- Generation and inclusion of Overload Control Information is implementation specific. +- The contents of the Overload Control Information are not addressed in this solution. They shall be addressed through solutions for key issue#1 subissue#2, specified in clause 8.2; +- The frequency of inclusion of the Overload Control Information is not addressed in this solution. It shall be addressed through solutions for key issue#1 subissue#3, specified in clause 8.2. +- How a NF Service Consumer that receives the OCI IE reacts is not addressed in this solution. It shall be addressed through solutions for key issue#3. Consequently aspects related to how intermediaries like HTTP proxies or SCP react to OCI shall also be addressed through solutions for key issue#3. + +The overload control information of the NF service producer is conveyed to the NF service consumer as follows: + +![Sequence diagram illustrating the interaction between an NF Service Producer and an NF Service Consumer to convey overload information.](79e1709a7317ead45379cbb8ff3ba802_img.jpg) + +``` +sequenceDiagram + participant NSP as NF Service Producer + participant NSC as NF Service Consumer + Note left of NSP: 1. NF Service Producer determines it is overloaded + NSC->>NSP: 2. HTTP request for invoking a service API + NSP->>NSC: 3. HTTP response for the API (Overload Control Information) + Note right of NSC: 4. Overload Control + Note left of NSP: 5. HTTP request for a Notification + Note right of NSC: 6. HTTP response for a Notification + Note right of NSC: 7. Overload Control +``` + +The diagram is a sequence diagram with two lifelines: 'NF Service Producer' on the left and 'NF Service Consumer' on the right. The interaction begins with a self-call on the NF Service Producer lifeline, labeled '1. NF Service Producer determines it is overloaded'. Next, an arrow labeled '2. HTTP request for invoking a service API' points from the NF Service Consumer to the NF Service Producer. A return arrow labeled '3. HTTP response for the API (Overload Control Information)' points from the NF Service Producer to the NF Service Consumer. Following this, a box labeled '4. Overload Control' is shown on the NF Service Consumer lifeline. Then, a dashed arrow labeled '5. HTTP request for a Notification' points from the NF Service Consumer to the NF Service Producer. A return dashed arrow labeled '6. HTTP response for a Notification' points from the NF Service Producer to the NF Service Consumer. Finally, a dashed box labeled '7. Overload Control' is shown on the NF Service Consumer lifeline. + +Sequence diagram illustrating the interaction between an NF Service Producer and an NF Service Consumer to convey overload information. + +**Figure 11.3-1 Conveying Overload Information via Signalling** + +1. The NF Service Producer determines that it is overloaded. +2. The NF Service Producer receives a HTTP request from the NF Service Consumer for any NF service that the NF Service Producer exposes. +3. The NF Service Producer includes an Overload Control Information (OCI) in the HTTP response. For deployments where the NF Service Consumer Instance and NF Service Producer Instance interact directly, the OCI information is provided by the NF Service Producer Instance. For deployments where the NF Service Producer instance is deployed behind a SCP and the SCP exposes the API endpoints on behalf of the NF Service Producer, the SCP shall include the OCI information after considering the overall overload situation of all the instances of the NF Service Producer that the SCP is acting on behalf. +4. The NF Service Consumer receives the OCI information and starts applying the overload control procedures specified as solutions for keyissue#3 in clause 8.x. +5. The NF Service Producer may piggyback OCI information in the notification messages (i.e., existing notification messages). +6. The NF Service Consumer responds to the notification. + +7. If the NF Service Consumer received OCI information in a notification, it shall apply the overload control mechanisms for the subsequent request message it is going to generate towards the NF Service Producer. + +## 11.4 Solution #2: Explicit Overload Control Information Conveyance + +This solution addresses Key-Requirement #1 and proposes to convey Overload Control Information (OCI) explicitly between NFs (addressing Sub-Issue#1) within 3GPP custom headers (addressing Sub-Issue#4). The OCI may be piggybacked on existing HTTP response signalling in order not to add additional signalling load to the involved NFs. + +**Editor's note:** OCI handling at the SCP is ffs. + +Addressing Sub-Issue#2, the information conveyed within the OCI shall contain the identity of the overloaded NF/ NF service, a requested traffic reduction or limitation, a validity period and a sequence number used to identify stale OCIs. + +This solution addresses Key-Requirement #3 as follows: NF service consumers shall act on received OCIs by reducing the number of API invocations according to the requested reduction or limitation metric value during the validity period, taking into account message priority considerations. + +The traffic reduction (throttling) shall rely on the Loss Algorithm with similar principles as have been defined for Diameter and GTP-C overload control. + +Support of solution #2 is proposed to be optional in Rel-16 and its use may be based on deployment/operator policy. The feature negotiation mechanism shall be used to detect/advertise support of solution #2 by NFs/NF services. + +The proposed overload control mechanism based on explicit OCI conveyance achieves the following advantages: + +- a) Clients have the accurate server overload information to determine how to throttle traffic resulting in immediate convergence of output traffic to the amount of traffic the overloaded server allows. +- b) Clients do not need to send requests that are rejected to detect the server's overload. +- c) Clients do not need to keep track of traffic history. +- d) Burst traffic is well addressed with low latency. +- e) Homogenous client behaviour results in fair usage of the overloaded server's resources. +- f) In high overload situations the overloaded server can request clients to stop traffic. + +## 11.5 Solution #3: Overload Control Information + +The following information shall be considered for inclusion in the Overload Control Information + +Table 11.5-1: Overload Control Information + +| Sl.No | Information | Type | Purpose | +|-------|---------------------------|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Overload-Reduction-Metric | enumerated |

Contains the reduction metric to be applied for the experienced overload situation. This Overload-Reduction-Metric can either be a percentage of traffic reduction (e.g. loss algorithm), a specific message traffic rate (e.g. rate algorithm), or any other relevant reduction or limitation metric type that the sender of the overload control information requests the receiver to apply.

The computation of the exact value for this parameter is left as an implementation choice at the sending node.

This IE is mandatory within the Overload-Control-Information.

| +| 2 | Period-of-Validity | DateTime |

The Period-Of-Validity indicates the time upto which, the overload condition specified by the Overload Control Information IE is to be considered valid (unless overridden by a subsequent Overload Control Information IE for the same scope).

This IE is mandatory within the Overload-Control-Information.

| +| 3 | Overload-Sequence-Number | integer |

Due to availability of multiple paths / multiple TCP connections to reach a API endpoint or to deliver notifications, it is possible that an overload control information received at once instance may be less recent than an information received at a previous instance in another path. The Overload-Sequence-Number aids in sequencing the overload information received from an overloaded NF service.

The Overload-Sequence-Number contains a value that indicates the sequence number associated with the Overload Control Information IE. This sequence number is used to differentiate two Overload Control Information IEs generated at two different instants by the same NF service for the same scope.

The sender of this information shall increment the Overload-Sequence-Number associated to a particular overload scope whenever modifying some information in the Overload-Control-Information IE. The Overload-Sequence-Number shall not be incremented otherwise.

This IE is mandatory within the Overload-Control-Information.

| +| 4 | Scope | OCIScope |

The conveyed OCI information is associated with the HTTP signalling that is in the same scope.

| + +The high level content of OCIScope is shown in table 11.5-2 below. + +Table 11.5-2: OCIScope content + +| Number | Information | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Uri | This identifies the API URI. The NF service consumer uses it to identify whether the OCI is associated with the NF it is directly communicating with (e.g. V-SMF) or with the NF it is communicating with via an intermediary (e.g. H-SMF). | +| 2 | NfInstanceId | The OCI is associated with a specific NF instance. | +| 3 | nfServiceInstanceIdList | The OCI is associated with a specific list of NF service instances. | +| 4 | Dnn list) | The OCI is associated with a specific list of DNNs. | +| 5 | sNssaiSmfInfoList | List of S-NSSAIs See 1 29.510 [9] clause 6.1.6.2.29 | +| 6 | NF Set ID | To be updated during normative phase depending on the data type chosen for NF Set ID in eSBA work. | +| NOTE: The more precise and detailed the information provided in the OCI Scope, the more precise the parts of the concerned NF for which overload control should be applied. | | | + +When scope information is not included, the overload control information conveyed shall be associated with the "authority" part of the NF service API. + +## 11.6 Solution #4: Overload Avoidance and Mitigation + +This solution addresses keyissue#2. In deployments where NF services are deployed as instances (virtual) behind an API endpoint that terminates the API URI (e.g. SCP instance), the following mechanisms can be used to avoid and mitigate overload situations: + +NOTE: For ease of understanding the entity that terminates the NF Service API endpoint is called a "Reverse Proxy" here onwards. + +![Diagram illustrating Overload Avoidance and Mitigation via OAM and Service Instance Scaling. A Router with multiple interfaces sharing an anycast IP distributes requests to a Reverse Proxy (SCP). The SCP routes requests to four Service Instances. An OAM monitor is connected to the SCP and all service instances. A shared database is also connected to the service instances.](26d664119ad25250780f554633444e54_img.jpg) + +OAM Monitors Overload +across the service instances + +The diagram shows a network architecture for overload avoidance. On the left, a router icon is labeled "Multiple interfaces having same anycast IP" and "Router distributing requests to Anycast IP". It connects to a large box labeled "Reverse Proxy (SCP)". Inside this box is a smaller icon of a proxy. To the right of the SCP are four "Service Instances" represented by server icons. Above them, a computer icon represents the "OAM Monitors Overload across the service instances". Dashed lines connect the OAM monitor to the SCP and to each of the four service instances. Solid lines connect the SCP to each service instance. A database icon on the far right is connected to all four service instances by dotted lines. A legend box at the bottom left defines the line types: dashed for OAM Path, solid for Signalling Path, and dotted for Optional Data Store Access. + +| Legend | | +|--------|----------------------------| +| ----- | OAM Path | +| _____ | Signalling Path | +| ..... | Optional Data Store Access | + +Diagram illustrating Overload Avoidance and Mitigation via OAM and Service Instance Scaling. A Router with multiple interfaces sharing an anycast IP distributes requests to a Reverse Proxy (SCP). The SCP routes requests to four Service Instances. An OAM monitor is connected to the SCP and all service instances. A shared database is also connected to the service instances. + +**Figure 11.6-1: Overload Avoidance and Mitigation via OAM and Service Instance Scaling** + +1. OAM or a monitoring entity can monitor the resource usage (e.g. CPU, memory, link utilization etc.,) of the NF Service instances. +2. If the monitored resource usage is nearing a configured threshold, the OAM system can spawn off new instances of the NF service, with the same API endpoint as the rest of the instances (e.g. API endpoint terminating at the Reverse Proxy). +3. The Reverse Proxy is made aware of the availability of new NF Service instance(s). +4. The Reverse Proxy routes subsequent new resource creation requests to lightly loaded NF Service instances. +5. When the overload situation eases, the OAM may shutdown some of the NF Service Instances, if the resource state in those NF Service instances are shared with other NF Service instances through UDSF or if the session contexts can be transferred by R16 eSBA solutions. +6. In order to avoid signaling overload of the Reverse Proxy itself, the following deployment options may be considered: + - The Reverse Proxy is deployed with multiple interfaces / IP links all having the same anycast IP address; + +- The Reverse Proxy has a large CPU pool and memory to handle signalling surges, to handle those signalling requests in parallel and to distribute them to backend NF Service instances +7. If the frequency and the quantum of signalling messages crosses beyond the capacity upto which the Reverse Proxy can handle, scaling of service instances can't help avoid / mitigate the overload. Either Release-15 based Overload control or new overload control mechanisms are required. + +## 11.7 Solution #5: Frequency of Inclusion - Piggyback in every HTTP signalling message + +This solution addresses key requirement#1, sub-issue#3 specified in clause 8.2. + +The following are the key principles of this solution: + +- NF service producer monitors its overload situation and identifies when to start communicating the overload control information to NF service consumers, depending on configured thresholds or implementation specific triggers; +- Once the NF service producer decides to include OCI towards NF service consumer, it shall piggyback it in every HTTP response message and may also piggyback it in every HTTP notification message that the NF service producer would normally send towards the NF service consumer (for the already subscribed notifications). +- The OCI information contains a sequence number. The sequence number shall be incremented whenever the overload reduction percentage value changes from a previously communicated value. +- OCI IEs carrying the same sequence number shall have the same content. +- If an NF service consumer has already received an OCI with sequence number#n it shall ignore the subsequent OCI IEs that it receives with the same or lower sequence number#n (except when there is rollover of sequence number). + +NOTE: How to avoid that a receiver uses only actual and not out of date OCI information is left to the normative work, + +### Advantages: + +- NF service producer implementation is simple as it can include the OCI information in every message without taking any additional considerations. +- Resiliency against message losses. The NF service consumer will know the current overload situation of the NF service producer even if some of the messages to NF service consumer are lost in the network. +- Since the OCI IE is included in HTTP response messages and in the notification messages for which the NF service consumer subscribed, an NF service consumer that has indicated support for Rel-16 overload control will be able to process the OCI IE. + +### Disadvantages: + +- Since OCI IE is included in every message, an unnecessary increase in the size of every message, especially considering that except the first occurrence of OCI IE with the sequence number#n, all other occurrences of the same or lower sequence number are ignored by the NF service consumer. + +## 11.8 Solution #6: Conveying Overload Information via NRF + +This solution addresses the subissue#1 in Key Issue#1 specified in clause 8.2 + +- Solutions for conveying current overload situation at a NF service producer to a NF service consumer + +In this solution, the following principles are followed + +- The NFProfile in NRF shall be able to store the Overload Control Information related to an NF Service Producer; + +- The contents of the Overload Control Information are not addressed in this solution. They shall be addressed through solutions for key issue#1 subissue#1, specified in clause 8.2; +- It shall be possible to get the Overload Control Information of an NF Service Producer through NF discovery and NF status notification procedures; + +The overload control information of the NF service producer is conveyed to the NF service consumer as follows: + +![Sequence diagram illustrating the conveyance of overload information via NRF. The diagram shows interactions between NF Service Producer, NRF, and NF Service Consumer. The sequence starts with the consumer subscribing to the producer's status via NRF. When the producer becomes overloaded, it updates the NRF. The NRF then notifies the consumer. The consumer can then request discovery information from the NRF, which includes the overload control information for instance selection.](4cde160bcc69b7b6c81b648dd0e4252e_img.jpg) + +``` + +sequenceDiagram + participant NSC as NF Service Consumer + participant NRF + participant NSP as NF Service Producer + + Note right of NSC: 7. Overload Control + Note right of NSC: 10. NF Service Producer Instance Selection + + NSC->>NRF: 1. Nnrf_NFManagement_NFStatusSubscribe Request + NRF-->>NSC: 2. Nnrf_NFManagement_NFStatusSubscribe Response + NSP->>NRF: 3. Nnrf_NFManagement_NFUpdate (Overload Control Information) + NRF-->>NSP: 4. Nnrf_NFManagement_NFUpdate Response + NRF-->>NSC: 5. Nnrf_NFManagement_NFStatusNotify + NSC-->>NRF: 6. Nnrf_NFManagement_NFStatusNotify Response + Note right of NSC: 7. Overload Control + Note right of NSC: 10. NF Service Producer Instance Selection + NSC->>NRF: 8. Nnrf_NFDiscovery_NFDiscover Request + NRF-->>NSC: 9. Nnrf_NFDiscovery_NFDiscover Response + +``` + +Sequence diagram illustrating the conveyance of overload information via NRF. The diagram shows interactions between NF Service Producer, NRF, and NF Service Consumer. The sequence starts with the consumer subscribing to the producer's status via NRF. When the producer becomes overloaded, it updates the NRF. The NRF then notifies the consumer. The consumer can then request discovery information from the NRF, which includes the overload control information for instance selection. + +**Figure 11.8-1 Conveying Overload Information via NRF** + +1. NF Service Consumers may use the Nnrf\_NFManagement\_NFStatusSubscribe service operation to subscribe for notifications on the change of overload control information of a NF Service Producer. The NotifCondition attribute as specified in clause 6.1.6.2.43 may be used to set the monitoredAttributes IE to the Overload Control Information IE. +2. The NRF creates the resource for the NF status subscription and responds to the NF Service Consumer. +3. When the NF Service Producer considers itself overloaded, it updates the Overload Control Information in the NFProfile in NRF using the Nnrf\_NFManagement\_NFUpdate service operation. The frequency of inclusion is based on operator policy. +4. NRF responds to the NF Service Producer. + +5. [Optional] If the NF Service Consumer has subscribed for NF Status notification in step 1, the NRF notifies the NF Service Consumer providing the Overload Control Information of the NF Service Producer. +6. [Optional] The NF Service Consumer responds to the notification. +7. [Conditional] If the NF Service Consumer has received the notification in step 6 and if the NF Service Consumer has active HTTP/2 signalling interaction with the NF Service Producer, it shall use the Overload Control Information received to apply overload control behaviors. + +For scenarios, where the NF service consumer has been already instructed to use a specific instance of an NF service producer but the NF service consumer has to discover the API endpoint of the AMF service: + +- If the NF Service Consumer gets NF profile of an NF Service Producer (e.g. AMF) before it communicates with the NF Service Producer and if the NF profile has Overload Control Information, then the NF Service Consumer uses the Overload Control Information to apply overload control behaviors. +8. [Conditional] If a NF Service Consumer is discovering the NF Service Producer, it requests the NRF with Nnrf\_NFDiscovery\_NFDiscover service operation. + 9. [Conditional] The NRF responds to the NF Service Consumer providing the NFProfile of the NF being discovered. The NFProfile shall contain the Overload Control Information, with the information updated in step 3. + 10. The NF Service Consumer shall consider the Overload Control Information for the NF Service Producer instance selection. If the NF Service Producer is experiencing signalling overload, it is beneficial if new resource creations, which may lead to further increased signalling later, are not sent to the overloaded NF Service Producer instance. + +In deployments using the Release-16 eSBA mechanism with delegated discovery, the role of NF Service Consumer in this solution is played by the SCP. + +## 11.9 Solution #7: Conveying OCI via Overload Control Service + +This solution addresses Key Issue#1 as documented in clause 8.2. + +This solution includes the following aspects: + +- Introduce a new NF service, Overload Control Service, which shall compliant to the requirement as specified in clause 7.1 "Network Function Service Framework" in 3GPP TS 23.501 [2], i.e. the Overload Control service shall be registered to the NRF, and discoverable and the service shall only be authorized to be used by the eligible NFs. +- The Overload Control Service may be supported by any existing 3GPP NFs. e.g. for AMF, the Overload Control Service may be supported in addition to the existing NF services, i.e. Namf\_Communication, Namf\_Eventexposure, Namf\_MT and Namf\_Location services. +- The Overload Control Service may provision an OCI on NF level and optionally on the NF Service level. +- The Service Operations supported by the Overload Control Service includes Subscribe, Unsubscribe and Notify. +- The Overload Control Service may support Subscribe-Notify communication pattern. +- Any 3GPP NF entity (e.g. an AMF, a SCP), and/or any network entity (e.g. OAM or a 3rd party service), regardless whether it is a service consumer of another service offered by an overloaded NF service producer, as long as being authorized, may subscribe to receive Overload Control Information notifications from the overloaded NF service producer. +- A NF A, if it is consuming an NF service (other than Overload Control Service) offered by a NF B, shall subscribe to the Overload Control Service if it is offered by the NF B, to receive OCI notification for NF B and/or that NF service. The NF A shall be considered as the Overload Enforcement node, i.e. shall take actions, e.g. throttling signaling traffic sent from NF A to NF B, to mitigate the Overload situation in the NF B if the NF B is overloaded. +- When subscribing to receive OCI notification, the consumer may request to be notified with certain conditions, e.g. frequency of notifications, though the Overload Control Service producer takes final decision. +- The OCI information is sent via Notifications towards all subscribed entities and included in the message body. + +The following figure illustrates the population of OCI via a new NF service - Overload Control Service. + +![Sequence diagram showing the interaction between NF A (e.g. AMF), NF B (e.g. SMF), and NRF to convey Overload Control Information (OCI).](474a819357587e34949a3e110ff19b30_img.jpg) + +``` + +sequenceDiagram + participant NF_A as NF A (e.g. AMF) + participant NF_B as NF B (e.g. SMF) + participant NRF + + Note right of NF_B: 1. Nnrf_Nfmanagement_Nfregister_Req/Resp. NF B registers its offered services including Overload Control service + NF_B->>NRF: 1. Nnrf_Nfmanagement_Nfregister_Req/Resp. NF B registers its offered services including Overload Control service + Note left of NF_A: 2. Nnrf_NFDiscovery Req./Resp. NF A selects NF B to consume a service, e.g. Nsmf_PDUSession + NF_A->>NRF: 2. Nnrf_NFDiscovery Req./Resp. NF A selects NF B to consume a service, e.g. Nsmf_PDUSession + Note left of NF_A: 3. NF A consumes a service offered by NF B, e.g. Nsmf_PDUSession service + NF_A->>NF_B: 3. NF A consumes a service offered by NF B, e.g. Nsmf_PDUSession service + Note left of NF_A: 4. NF A consumes Overload Control Service Offered by the NF B by subscribing to get OCI Notifications. + NF_A->>NF_B: 4. NF A consumes Overload Control Service Offered by the NF B by subscribing to get OCI Notifications. + Note right of NF_B: 5. If NF B/I.F service is overloaded + NF_B->>NF_A: 6. Notify OCI. + NF_B->>NF_A: 7. Notify updated OCI. + +``` + +The diagram illustrates a sequence of interactions between three Network Functions (NFs): NF A (e.g. AMF), NF B (e.g. SMF), and NRF. The sequence starts with NF B registering its offered services, including the Overload Control service, with the NRF. NF A then performs a service discovery procedure to select NF B to consume a service, such as Nsmf\_PDUSession. NF A consumes a service offered by NF B, and then consumes the Overload Control Service offered by NF B by subscribing to get OCI notifications. A decision point indicates that if NF B or its interface service is overloaded, NF B sends a notification to NF A including its OCI. If the OCI information is updated, NF B sends a further notification to NF A. + +Sequence diagram showing the interaction between NF A (e.g. AMF), NF B (e.g. SMF), and NRF to convey Overload Control Information (OCI). + +**Figure 11.9-1 Conveying OCI via Overload Control Service** + +1. The NF B (as Service Producer) register offered services including the Overload Control Service on the NRF. +2. The NF A (as Service Consumer) perform a Service Discovery procedure, and the NF B is selected. +3. The NF A consume a service (other than the Overload Control service) offered by the NF B. +4. The NF A consume the Overload Control Service offered by NF B by subscribing to get OCI notifications. +5. If the NF B or a service on NF B is overloaded, and according to the subscription. +6. The NF B sends a notification to NF A includes its OCI. +7. The NF B sends further notification if the OCI information is changed. + +## 11.10 Solution #8: Overload Control enforcement behaviour + +This solution addresses key requirement#3 specified in clause 8.4. + +The following are the key aspects of this solution to depict an NF service consumer behavior during overload situations: + +- The NF service consumer shall reduce the number of messages it would normally generate towards the NF service producer, in accordance with the overload reduction percentage requested by the NF service producer in the OCI IE. For example, if the NF service producer has requested an overload reduction percentage of 20%, then out of 100 messages that the NF service consumer generates towards the NF service producer it shall drop 20 messages. This mechanism is called message throttling. + +- Since the OCI IE is communicated end to end, the enforcement of the overload control based on overload reduction percentage shall be applied by the NF service consumer. SCPs are not expected to react on OCI IE in the scope of this solution. +- However SCPs can help mitigate overload as specified in solution#4 in clause 11.6. +- When applying message throttling, the NF service consumer shall give preference to messages related to priority users (eMPS) and emergency services and shall avoid throttling the messages related to such users / services. +- A prioritization for not throttling messages based on the system procedure the message is related to and parameters in the message (e.g. DNN, S-NSSAI) shall be employed. +- The following table provides a suggested prioritization of system procedures. Messages related to system procedures of higher priority (lower number indicates higher priority) shall be given lower preference for throttling. This priority mechanism should be used in combination with the existing 3gpp-Sbi-Message-Priority (SMP) mechanism, see TS 29.500 [3], clause 6.8. + +**Table 11.10-1: Priority of System Procedures** + +| Priority | System Procedure | Related Service Operations | Description | +|----------|------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Service Request and Handover | Nsmf_PDUSession_UpdateSMContext,request / response
Nsmf_PDUSession_Update request request / response
Nsmf_PDUSession_CreateSMContext request / response and
Nsmf_PDUSession_Create request/response for EPS to 5GS Handover Procedure | Service request and handover procedures are expected to finish under tight time deadlines (less than 20 ms) and hence messages related to those | +| 2 | PDU session release, Any procedure causing a DELETE on a HTTP resource | Any service operation using DELETE method | Resource deletions would lead to lesser number of resource related signalling and hence should be treated on priority to ease the overload situation. | +| 3 | Other procedures that don't fall under category 1, 2 and 4 | Any service operation not falling under category 1,2 and 4 (e.g. Namf_Communication service operations, Namf_EventExposure service operations, Nudm_UECM service operations etc.,) | | +| 4 | Any procedure causing new resource creation (e.g. PDU session establishment) | Any service operation using POST or PUT method to create a resource | Resource creations will result in more signalling in future on those resources leading to overload. Hence these messages should be throttled more. | + +## 11.11 Solution #9: Location of OCI + +This solution addresses key requirement#1, sub-issue#4 specified in clause 8.2. + +There are two possible locations within a HTTP message to include the Overload Control Information (OCI). + +1. Include OCI as a JSON object within the payload of HTTP messages. + - Provides flexibility to expand OCI in future releases as payloads can be larger when compared to HTTP headers. +2. Include OCI encoded within a custom HTTP header. + - Can be used on all messages (including responses carrying 204 No Content status code). + +- Does not require OpenAPI updates every time a new API / method to an existing API is added. + +## 11.12 Solution#10: Overload control by redirecting requests to another NF within a NF set + +This solution addresses the Key Issue#3 specified in clause 8.4 + +In this solution, the following principles are followed + +- The OCI includes an indication on whether the NF service Consumer can select another NF service producer from the same NF Set, if the scope of the OCI is at NF service producer level (and not at NF set level) +- If it is allowed, the NF service Consumer selects a new NF service producer from the same NF set, and send the request message to the new NF service producer instance. +- The newly selected NF service producer instance is expected to have the resource context information related to the request message. How the selected NF service producer instance gets it from the previous NF service producer instance will be addressed as part of eSBA solutions for context transfers within a NF set. +- This solution does not address SCP with delegated discovery deployment scenario. + +The overload control is handled as follows: + +![Sequence diagram illustrating overload control by redirecting requests to another NF within a NF set. The diagram shows four lifelines: NF Service Producer (left), NF Service Producer (middle-left), NRF (middle-right), and NF Service Consumer (right). The sequence of messages is: 1a. Response Message from the first NF Service Producer to the NF Service Consumer; 1b. Nnrf_NFDiscover Response or Nnrf_NFManagement_NFStatusNotify from the NRF to the NF Service Consumer; 2. Nnrf_NFDiscovery_NFDiscover Request from the NF Service Consumer to the NRF; 3. Nnrf_NFDiscovery_NFDiscover Response from the NRF to the NF Service Consumer; 4. Request Message from the NF Service Consumer to the second NF Service Producer.](5456ef9dc49ffc9cbb93cf1dd8052884_img.jpg) + +``` + +sequenceDiagram + participant NFSP1 as NF Service Producer + participant NFSP2 as NF Service Producer + participant NRF + participant NSC as NF Service Consumer + + Note right of NFSP1: 1a. Response Message + NFSP1->>NSC: 1a. Response Message + Note right of NRF: 1b. Nnrf_NFDiscover Response or Nnrf_NFManagement_NFStatusNotify + NRF->>NSC: 1b. Nnrf_NFDiscover Response or Nnrf_NFManagement_NFStatusNotify + Note right of NSC: 2. Nnrf_NFDiscovery_NFDiscover Request + NSC->>NRF: 2. Nnrf_NFDiscovery_NFDiscover Request + Note right of NRF: 3. Nnrf_NFDiscovery_NFDiscover Response + NRF->>NSC: 3. Nnrf_NFDiscovery_NFDiscover Response + Note right of NSC: 4. Request Message + NSC->>NFSP2: 4. Request Message + +``` + +Sequence diagram illustrating overload control by redirecting requests to another NF within a NF set. The diagram shows four lifelines: NF Service Producer (left), NF Service Producer (middle-left), NRF (middle-right), and NF Service Consumer (right). The sequence of messages is: 1a. Response Message from the first NF Service Producer to the NF Service Consumer; 1b. Nnrf\_NFDiscover Response or Nnrf\_NFManagement\_NFStatusNotify from the NRF to the NF Service Consumer; 2. Nnrf\_NFDiscovery\_NFDiscover Request from the NF Service Consumer to the NRF; 3. Nnrf\_NFDiscovery\_NFDiscover Response from the NRF to the NF Service Consumer; 4. Request Message from the NF Service Consumer to the second NF Service Producer. + +**Figure 11.12-1 Overload control by redirecting requests to another NF within a NF set** + +- 1a. [Optional] NF Service Consumers has received a response message which includes OCI reflecting the overload of the NF Service Producer. +- 1b. [Optional] NF Service Consumer has received Nnrf\_NFDiscover Response or Nnrf\_NFManagement\_NFStatusNotify, in which OCI is included, reflecting the overload of the NF Service Producer. + +2. [Optional] If the OCI reflects the scope at NF instance Id level or NF service instance Id level and also includes an indication saying that a new NF Service Producer from the same NF Set can be selected to replace the original NF Service Producer, the NF Service Consumer triggers Nnrf\_NFDiscovery\_NFDiscover Request (NF Set ID) to discover a new NF Service Producer from the NF Set. +3. [Optional] The NRF responds with Nnrf\_NFDiscovery\_NFDiscover Response. The Message includes a list of NF profiles of NF Instance that have no OCI in their profile from the requested NF Set. +4. The NF Service Consumer then selects one NF Service Producer from the list of NF Instances provided by NRF, and sends the request to this new NF Service Producer Instance. + +The NF Service Consumer replaces the authority part of the resource URI of the original request message with the FQDN or IP address of the new NF Service Producer Instance. + +## 11.13 Solution #11: Overload Control Enforcement by SCPs + +This solution addresses key requirement#3 specified in clause 8.4. + +The main characteristic of this solution is that the SCP is considered here as the overload control enforcement entity. SCP is considered in this solution as deployed in either option C (Indirect communication without delegated discovery) or option D (Indirect communication with delegated discovery) communication models defined in annex E of TS 23.501 [2]. In this sense, the SCP is terminating the TLS connection on both sides of the communication path. + +- At reception of OCI information from a NF producer, the SCP shall reduce the number of messages it would normally send towards the NF service producer, in accordance with the overload reduction percentage requested by the NF service producer in the OCI IE; +- When performing this throttling mechanism, the behaviour of the SCP with regards to the concerned NF service consumers is to be specified by this solution, e.g. an appropriate error message could be sent to the concerned NF consumer(s) with an error code and error details that are in accordance with the overload situation that is experienced; +- The SCP shall also be able to select another NF service producer, e.g. from the same NF Set, if it is allowed, and send the request message to the new NF service producer instance. This solution shall also specify how and when the SCP performs this reselection; +- Depending on the ongoing overload situation and the efficiency of the overload control mechanisms that are applied by the SCP and not involving upstream NFs, the SCP shall also be able to send (e.g. derived or simply relayed) upstream OCI information to the concerned NF consumer(s) if it considers it beneficial for the overall management of the overload situation; +- For example: + - If the NF service producer has requested an overload reduction percentage of 20%, then out of 100 messages that the SCP has to route to this NF service producer, only 80 messages would be maintained and the remaining 20 messages would if possible rather be routed to another NF service Producer from the same NF Set. If no NF service producer could be identified / is available e.g. from the same NF set, then the SCP shall drop the extra messages in accordance with the overload reduction percentage requested by the NF service producer in the OCI IE; +- The SCP shall apply a proper message prioritization mechanism when applying throttling, e.g. the same message prioritization mechanisms described in solution#8 in clause 11.10. + +## 11.14 Conveyance of Overload Information with hyperlink + +This solution addresses the subissue#1 and subissue#4 in Key Issue#1 specified in clause 8.2 + +- Solutions for conveying current overload situation at a NF service producer to a NF service consumer. + +- Where to include the conveyed overload information (e.g. HTTP headers, payload). + +In this solution, the following principles are followed + +- The NF service producer stores the overload control information (when necessary) in a dedicated storage, the storage may either collocate with the NF service producer or be standalone storage. The NF service producer may update the overload control information in the storage periodically or when the load status exceeds a threshold; +- The interface between NF service producer and overload information storage is not covered in this solution; +- When overload information is to be conveyed to the service consumer, the service producer includes a hyperlink in the response message and the hyperlink points the relevant overload information stored in the overload control information storage; +- Upon receiving the response containing the hyperlink described as above, the service consumer retrieves the overload control information according to the hyperlink, this mechanism is based on HATEOAS as described in clause 4.7 of TS 29.501 [5]; + +The overload control information of the NF service producer is conveyed to the NF service consumer as follows: + +![Sequence diagram illustrating the interaction between Service Consumer, Service Producer, and OCI Storage for conveying overload control information via a hyperlink.](b904ac2472cab80892d1e783e6230d6e_img.jpg) + +``` + +sequenceDiagram + participant Service Consumer + participant Service Producer + participant OCI Storage + Note right of Service Producer: 1. Store of OCI + Service Consumer->>Service Producer: 2. Service Invoking Request + Service Producer-->>Service Consumer: 3. Service Response +( href: oci-storage.com/d23sdf) + Service Consumer->>OCI Storage: 4. GET oci-storage.com/d23sdf + OCI Storage-->>Service Consumer: 5. 200 OK +( {overload info} ) + +``` + +The diagram shows a sequence of five steps: + + +- The Service Producer stores Overload Control Information (OCI) in the OCI Storage. +- The Service Consumer sends a Service Invoking Request to the Service Producer. +- The Service Producer responds with a Service Response that includes a hyperlink (href: oci-storage.com/d23sdf). +- The Service Consumer sends a GET request to the OCI Storage using the provided hyperlink. +- The OCI Storage returns a 200 OK response containing the overload information. + +Sequence diagram illustrating the interaction between Service Consumer, Service Producer, and OCI Storage for conveying overload control information via a hyperlink. + +**Figure 11.14-1 Conveying Overload Control Information via hyperlink** + +1. NF Service Producer stores its overload control information on the dedicated OCI storage. +2. The NF Service Consumer invokes service towards the NF Service Producer, the NF service Consumer shall indicate support of HATEOAS related features as described in clause 4.7.6 of TS 29.501 [5]. +3. When needed, the NF Service Producer responds to the service invoking request, in addition it includes in the response message the hyperlink pointing to its overload control information on the OCI storage. Based on overload control strategy the NF Service Producer may: + - always include the hyperlink in response messages if possible; or + - include the hyperlink in response messages when it is under overload condition. +4. If the NF Service Consumer receives a hyperlink pointing to the overload control information in step 3, then it retrieves the overload control information based on the hyperlink. + +NOTE: The NF Service Consumer retrieves the overload control information only once for each time it receives a hyperlink pointing to the overload control information. + +5. The OCI storage sends the overload control information which previously stored by the NF Service Producer to the NF Service Consumer. + +## 11.15 Evaluation and Conclusion + +### 11.15.1 Evaluation of the Solutions + +In the following, an evaluation of all the proposed solutions is made with regards to each key requirement and associated sub-issues defined in clause 8. For addressing Key Requirement #1, Sub-Issue#1: + +- A combination of Solution #1 and Solution #2 should be used. Overload control information is signaled from the concerned NF service producer to the NF service consumer either in a response or in a notification. This enables to mitigate most of the limitations identified for the Rel-15 overload control mechanism and depicted in clause 9.2.2. +- Solution #7 can also be considered as a complementary solution. Indeed, assuming that the overload control service is supported by a different service instance than the one providing the overloaded service of the NF producer, this service can be useful in case the concerned service producer instance is overloaded to a point that it cannot react to received requests (construct and send responses) or send notifications that can be used to include OCI towards NF consumers. This solution enables the overloaded service producer to signal OCI to all concerned network entities (who have subscribed) intermediately and at the same time without waiting until signalling exchanges (to consume the overloaded services) takes place. Other network entities (other than the concerned NF consumers), e.g. O&M, SCP and/or a 3rd party service can also make use of this new service to retrieve OCI information if required. However, it also implies a tight coupling in the implementation between this overload service and the other services supported by the NF service producer. +- Also alternatively, Solution #6 can be considered. However, it is to be noted that this solution can have the same limitations as the Rel-15 load control mechanism (see clause 9.3.2) in the sense that it can lead to additional overload situations in the NRF and NF consumers if there is no possibility to regulate the frequency of overload control updates (from NFs to the NRF) and notifications (from the NRF to subscribing consumer NFs). + +For addressing Key Requirement #1, Sub-Issue#2 on the content of OCI: + +- Solution #3 is advised. The information conveyed within the OCI shall contain the identity of the overloaded NF/ NF service, a requested reduction or limitation metric, a validity period, a sequence number used to identify stale OCIs and the scope of the conveyed OCI. + +For addressing Key Requirement #1, Sub-Issue#3 on the frequency of OCI conveyance: + +- Solution #5 ought to be used. OCI is included in every signalling message, HTTP response message and also notifications, sent by the NF producer to the NF consumer. +- If Solution #7 is used as described above, frequency of notifications of OCI towards subscribed NF consumers is suggested by the service consumer, and the concerned service producer takes that into account, together with its local policy when setting up this frequency. + +For addressing Key Requirement #1, Sub-Issue#4 on where to include the conveyed OCI.- 3 variants are described in the different solution on how to signal OCI information in this TR: + +- OCI is signaled by Subscription/Notification via a new service offered by the NF service producer (see clause 11.9 Solution #7) +- OCI is signaled by being piggybacked in the existing signalling messages sent between the NF producer and the NF consumer (see clause 11.11 Solution #1) +- OCI is retrieved by the service consumer using a HATEOAS links provided by the overloaded NF service producer. This solution has the following advantages: + +- a) this solution is inline with the service based architecture, with this solution the overload control component can be decoupled from the service logic component in the NF, thus more flexibility is provided for network deployments; +- b) the burden of conveying OCI can be offloaded from the server; +- c) the client is able to make the decision whether to retrieve the OCI (the client may not continue to contact that server thus the OCI may be useless), this can save the unnecessary OCI conveyance and provide more flexibility to the overall overload control solution. + +**Table 11.15-1: Comparison of the solutions on location of signalling OCI information** + +| Method | Pros | Cons | +|---------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| OCI included in HTTP messages payload | 1. Provides flexibility to expand OCI in future releases as payloads can be larger when compared to HTTP headers. | 1. Most off the shelf HTTP proxies do not have readymade solutions for inserting content into HTTP payload.
2. Some response messages (204 No Content) do not have any payload.
3. Every time a new API is added and/or a HTTP method is added to an existing API, the OCI IE needs to be included in the payload of the messages in OpenAPI. | +| OCI included in HTTP custom headers | 1. Can be used on all messages (including responses carrying 204 No Content status code).
2. Does not require OpenAPI updates every time a new API / method to an existing API is added. | 1. Headers should be generally short for better performances. Including OCI in headers would restrict the size available for OCI IE. | + +- OCI included in HTTP custom headers has the least impact on the openAPI, as it is expected that OCI information will not increase much and thus the size restriction in the header may not be an issue, given that the contents of OCI as identified in clause 11.5 are limited. +- Alternatively and in case Solution #7 is used as described above, it should hence not be precluded to use the associated notification mechanism to convey OCI. + +For addressing Key Requirement #2: + +- Solution #4 can be considered depending on the deployment scenarios. + +For addressing Key Requirement #3 on Overload Control enforcement: + +- A combination of Solution #8 and Solution #10 for Overload Control enforcement should be followed. The NF consumer is expected to take actions (throttling, reselection, etc.) taking into account the information provided by the overloaded NF producer in the OCI IE. +- Alternatively and in case an SCP is used with communication options C or D (refer to annex E of TS 23.501 [2]), Solution #y (Overload Control Enforcement by SCPs), should be used as it provides a centralized overload control management for all 5G NFs and enables to have the least impact on NF consumers and service delivery in general. Indeed, the SCP is in charge of managing the overload situation of a NF producer for all concerned NF consumers by taking into consideration all the available parameters that it has (e.g. OCI, other available NF instances, overall load distribution among NF instances, etc.). + +The following considerations should also be taken into account: + +- When applying throttling, the message prioritization scheme should be defined as described in Solution #8 and in accordance with the mechanisms already defined in Rel-15. +- Also when applying throttling, the error message type and content to be sent upstream should be defined and is hence left for the normative phase. + +# 12 Selected solutions + +## 12.1 Selected solution for Overload Control + +Based on the provisions in clause 11.15 "Evaluation and Conclusion", CT shall study how to combine the following solutions to address all requirements with one unified solution: + +- Key requirement #1.1 (meaning requirement #1, sub-issue #1): Solutions 1 and 2. +- Key requirement #1.2: Solution 3. +- Key requirement #1.3: Solution 5. +- Key requirement #1.4: Solutions 2 and 9 (solution #9 offers two alternatives, but only the second one, i.e. OCI conveyed via an HTTP custom header should be adopted). +- Key requirement #2: Solution 4. +- Key requirement #3: Solutions 8, 10 and 11. + +## 12.2 Solution outline and implications on SBI specifications + +Below is a higher level summary of the overload control solution. Potential impacts on normative SBI specs are also identified. + +### 12.2.1 Overload Conveyance - General (key requirement #1.1) + +How to meet key requirement #1.1 is defined in solution #1: + +- The overloaded NF Service Producer includes an Overload Control Information (OCI) in the HTTP response messages. +- For deployments where the NF Service Consumer Instance and the NF Service Producer Instance interact directly, the OCI information is provided by the NF Service Producer Instance. +- For deployments where the NF Service Consumer Instance and the NF Service Producer Instance do not interact directly, i.e. the NF Service Producer instance is deployed behind a SCP and the SCP exposes the API endpoints on behalf of the NF Service Producer, the SCP shall include the OCI information after considering the overall overload situation of all the instances of the NF Service Producer that the SCP is acting on behalf. +- The NF Service Producer may also piggyback OCI information in the notification messages (i.e., existing notification messages). + +**Editor's note:** This will likely impact the following 3GPP specs under CT4 responsibility: TS 29.500, 29.502-505, 29.509-511, 29.518, 29.531 and 29.572 (use this info in the new WID, when specifying the list of impacted normative specs). + +See more details in clause 11.3. + +### 12.2.2 Overload Conveyance - Semantics (key requirement #1.2) + +How to meet key requirement #1.2 is defined in solution #3. The following information shall hence be included in the Overload Control Information (OCI): + +- Overload-Reduction-Metric +- Period-of-Validity +- Overload-Sequence-Number + +- Scope + +**Editor's note:** This will likely impact at least TS 29.571 (use this info in the new WID, when specifying the list of impacted normative specs). + +See more details in clause 11.5. + +### 12.2.3 Overload Conveyance - Frequency (key requirement #1.3) + +How to meet key requirement #1.3 is defined in solution #5: + +- The NF service producer monitors its overload situation and identifies when to start communicating the overload control information to NF service consumers, depending on configured thresholds or implementation specific triggers; +- Once the NF service producer decides to include OCI towards NF service consumers, it may piggyback it in every HTTP response message (the decision is implementation dependent) and may also do the same in every HTTP notification message that the NF service producer would normally send towards upstream NF service consumers (for the already subscribed notifications). + +**Editor's note:** How to handle the absence of the OCI in subsequent messages will be addressed during the normative work. + +**Editor's note:** This will likely impact the following 3GPP specs under CT4 responsibility: TS 29.500, 29.502-505, 29.509-511, 29.518, 29.531 and 29.572 (use this info in the new WID, when specifying the list of impacted normative specs). + +See more details in clause 11.7. + +### 12.2.4 Overload Conveyance - Where to include OCI (key requirement #1.4) + +How to meet key requirement #1.4 is defined in solutions #2 and #9, which propose to convey Overload Control Information (OCI) explicitly between NFs within 3GPP custom headers (solution #9 offers two alternatives, but only the header based alternative should be adopted). + +**Editor's note:** This will likely impact the following 3GPP specs under CT4 responsibility: TS 29.500, 29.502-505, 29.509-511, 29.518, 29.531 and 29.572 (use this info in the new WID, when specifying the list of impacted normative specs). + +See more details clauses 11.4 and 11.11. + +### 12.2.5 Overload Conveyance - HATEOAS (key requirements #1.1 and #1.4) + +For deployments where HATEOAS is used, solution #12 may be used. + +**Editor's note:** Summary of the solution for HATEOAS option will be addressed by a separate pCR. + +See more details in clause 11.14. + +### 12.2.6 Overload - Avoiding and mitigating (key requirement #2) + +How to meet key requirement #2 is defined in solution #4. If NF services are deployed as virtual instances behind an API endpoint that terminates the API URI (e.g. SCP instance), the following mechanisms can be used to avoid and mitigate overload situations: + +- OAM or any other monitoring entity monitors the resource usage (e.g. CPU, memory, link utilization etc.) of the NF Service instances. +- If the monitored resource usage is nearing a configured threshold, the monitoring system initiates new instances of the NF service, with the same API endpoint, which terminates at the Reverse Proxy. + +- The Reverse Proxy routes subsequent new resource creation requests to lightly loaded NF Service instances. +- When the overload situation ceases, the OAM may shutdown some of the NF Service Instances, if the resource state in those NF Service instances are shared with other NF Service instances through UDSF or if the session contexts can be transferred by 3GPP Rel-16 eSBA solutions. + +Editor's note 1: This solution should be aligned with the outcome of the 5G\_eSBA work, which is still ongoing at SA2. + +Editor's note 2: This will likely impact the following 3GPP specs under CT4 responsibility: TS 29.500, 29.502-505, 29.509-511, 29.518, 29.531 and 29.572 (use this info in the new WID, when specifying the list of impacted normative specs). + +See more details in clause 11.6. + +### 12.2.7 Overload Control (key requirement #3) + +How to meet key requirement #3 is defined in solutions #8, 10 and 11. + +- For deployments where SCPs are not used and direct communication models are implemented: + - The NF service consumer shall reduce the number of messages it would normally generate towards the NF service producer (message throttling), in accordance with the overload reduction or limitation metric requested by the NF service producer in the OCI IE (solution #8). + - When applying message throttling, the NF service consumer shall give preference to messages related to priority users (eMPS) and emergency services and shall avoid throttling the messages related to such users / services (solution #8). This priority mechanism should be used in combination with the existing 3gpp-Sbi-Message-Priority (SMP) mechanism, see TS 29.500 [3], clause 6.8. + - The OCI may include an indication on whether the NF service consumer can select another NF service producer from the same NF Set, if the scope of the OCI is at NF service producer level (solution #10). +- For deployments where SCPs are used to implement indirect communications between NF consumers and NF producers, the SCP is the overload control enforcement entity and shall perform the following functions (solution #11): + - Message throttling; + - Message prioritization; + - If allowed by the service producer, selection of another NF service producer, e.g. from the same NF Set. + +Editor's note: This will likely impact the following 3GPP specs under CT4 responsibility: TS 29.500, 29.502-505, 29.509-511, 29.518, 29.531 and 29.572 (use this info in the new WID, when specifying the list of impacted normative specs). + +See more details in clauses 11.10, 11.12, 11.13. + +# Annex: Change history + +| Change history | | | | | | | | | +|----------------|-----------|-----------|----|-----|-----|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | | New version | +| 2018-07 | CT4#85bis | C4-185418 | | | | Skeleton of the TR | | 0.1.0 | +| 2018-10 | CT4#86bis | C4-187647 | | | | Implementation of PCRs agreed in CT4#86bis - C4-187163, C4-187527, C4-187528, C4-187601 | | 0.2.0 | +| 2018-12 | CT4#87 | C4-188697 | | | | Implementation of PCRs agreed in CT#87 - C4-188587 | | 0.3.0 | +| 2019-03 | CT4#89 | C4-190634 | | | | Implementation of PCRs agreed in CT4#89 - C4-190209, C4-190518, C4-190528, C4-190615, C4-190616, C4-190521, C4-190192, C4-190522, C4-190523, C4-190524, C4-190525 and C4-190527 | | 0.4.0 | +| 2019-03 | CT#83 | CP-190049 | | | | Presented for information | | 1.0.0 | +| 2019-04 | CT4#90 | C4-191025 | | | | General Cleanup | | 1.1.0 | +| 2019-04 | CT4#90 | C4-191460 | | | | Key Issues on Load Control | | 1.1.0 | +| 2019-04 | CT4#90 | C4-191462 | | | | Scope of OCI | | 1.1.0 | +| 2019-04 | CT4#90 | C4-191464 | | | | Evaluation of Rel-15 Load Control | | 1.1.0 | +| 2019-04 | CT4#90 | C4-191466 | | | | Solution for Frequency of OCI Inclusion | | 1.1.0 | +| 2019-04 | CT4#90 | C4-191490 | | | | Key Issue: Co-existence of load control mechanism with Rel-15 mechanism | | 1.1.0 | +| 2019-04 | CT4#90 | C4-191491 | | | | Solution for Load Control Co-Existence | | 1.1.0 | +| 2019-04 | CT4#90 | C4-191492 | | | | Solution for Conveying Overload Information via NRF | | 1.1.0 | +| 2019-04 | CT4#90 | C4-191493 | | | | Solution for populating Overload Control Information via new service | | 1.1.0 | +| 2019-04 | CT4#90 | C4-191517 | | | | Solution for Overload Control | | 1.1.0 | +| 2019-04 | CT4#90 | C4-191518 | | | | Solution for OCI Location | | 1.1.0 | +| 2019-04 | CT4#90 | C4-191538 | | | | Reselect producer instance when OCI indicates overload of original prod | | 1.1.0 | +| 2019-06 | CT4#91 | C4-192034 | | | | Key Requirement on the regulation of load information conveyance via NRF | | 1.2.0 | +| 2019-06 | CT4#91 | C4-192138 | | | | Solution for the Regulation of Load Information Change Notifications Conveyance by the NRF | | 1.2.0 | +| 2019-06 | CT4#91 | C4-192139 | | | | Solution for the Regulation of Load Information Updates Reception at the NRF | | 1.2.0 | +| 2019-06 | CT4#91 | C4-192421 | | | | Solutions for Overload Control enforcement by SCPs | | 1.2.0 | +| 2019-06 | CT4#91 | C4-192422 | | | | Clarification of the Overload Reduction Metric in the OCI IE | | 1.2.0 | +| 2019-06 | CT4#91 | C4-192528 | | | | Conveyance of OCI | | 1.2.0 | +| 2019-06 | CT4#91 | C4-192531 | | | | Load Control Evaluation and Conclusion | | 1.2.0 | +| 2019-06 | CT4#91 | C4-192532 | | | | OverLoad Control Evaluation and Conclusion | | 1.2.0 | +| 2019-09 | CT4#93 | C4-193520 | | | | Overload Control proposal | | 1.3.0 | +| 2019-09 | CT4#93 | C4-193521 | | | | Evaluation and Conclusion on hypermedia based OCI conveyance solution | | 1.3.0 | +| 2019-09 | CT#85 | CP-192204 | | | | Presented for approval | | 2.0.0 | +| 2019-09 | CT#85 | CP-192241 | | | | Presented for approval | | 2.1.0 | +| 2019-09 | CT#85 | | | | | Approved at CT#85 | | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29892/05eb72d372e4bf78e3d6a64949d77bcc_img.jpg b/marked/Rel-16/29_series/29892/05eb72d372e4bf78e3d6a64949d77bcc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e4ef62d67b723d9fc081ee67c9c748fab5c6d744 --- /dev/null +++ b/marked/Rel-16/29_series/29892/05eb72d372e4bf78e3d6a64949d77bcc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4fe92e4dd4e18f8821fddddd1183d2c7ad1d86055d80c9f2924b469ff3d2e54f +size 72633 diff --git a/marked/Rel-16/29_series/29892/19a59d6b53059ebd27b13c98793f88e0_img.jpg b/marked/Rel-16/29_series/29892/19a59d6b53059ebd27b13c98793f88e0_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c8813eb0aae17f579ca85391608c9cbee412aa90 --- /dev/null +++ b/marked/Rel-16/29_series/29892/19a59d6b53059ebd27b13c98793f88e0_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2dae0a10f870f23e2512cbfac9db89420ea38439f102d12e0317a3fff73ddc0e +size 32278 diff --git a/marked/Rel-16/29_series/29892/2ae3eae1bd80a90f192f568ae246a9a6_img.jpg b/marked/Rel-16/29_series/29892/2ae3eae1bd80a90f192f568ae246a9a6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c44c4b35baa7eeed6d771a7f4a6ba3c0bd4dff2a --- /dev/null +++ b/marked/Rel-16/29_series/29892/2ae3eae1bd80a90f192f568ae246a9a6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:06bd7cdf3efca4163882c1c2c9c935cb60cac92e9058137908a64a5ad081919a +size 49219 diff --git a/marked/Rel-16/29_series/29892/4dadfd8b8240e9d83f974e3f0fdd18df_img.jpg b/marked/Rel-16/29_series/29892/4dadfd8b8240e9d83f974e3f0fdd18df_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7b4dca925a02fe030724977d601d8bfe6615950d --- /dev/null +++ b/marked/Rel-16/29_series/29892/4dadfd8b8240e9d83f974e3f0fdd18df_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2dbe91191bd6eab6a6bf1dafd35c878e7fcf1083ecec2c24437a07cedfb401c2 +size 31489 diff --git a/marked/Rel-16/29_series/29892/5793a44ffdadd039928e2f9fe6daae06_img.jpg b/marked/Rel-16/29_series/29892/5793a44ffdadd039928e2f9fe6daae06_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1ef585e76e0cc5674e4cd5c2977e35574aa52978 --- /dev/null +++ b/marked/Rel-16/29_series/29892/5793a44ffdadd039928e2f9fe6daae06_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:af6423b119a6f141e9a3f3bcecb0a3ccabde15f79b11c765b3d80a8723021204 +size 54213 diff --git a/marked/Rel-16/29_series/29892/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-16/29_series/29892/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e283966d2b14402ede566f690afcbe396ba3ea30 --- /dev/null +++ b/marked/Rel-16/29_series/29892/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b0ecb04405fc5a6dbabead61165d449abb36a01db446d97b9b35f9c0fdc92dcf +size 9618 diff --git a/marked/Rel-16/29_series/29892/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-16/29_series/29892/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ec9cb7e09f079c150c252412c10279c54db871fd --- /dev/null +++ b/marked/Rel-16/29_series/29892/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a4e4d1dfc9b29215bb99f19a421ddd062fbe1ccbb6af64b92bf885e7c4ff0c4a +size 5766 diff --git a/marked/Rel-16/29_series/29892/6a555cff11e140861ce08db72b01a6a2_img.jpg b/marked/Rel-16/29_series/29892/6a555cff11e140861ce08db72b01a6a2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b3f94eed51bcab0cf9d98f720ce74414920d0f81 --- /dev/null +++ b/marked/Rel-16/29_series/29892/6a555cff11e140861ce08db72b01a6a2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fbb5c857aa47d0475f9130a4e17c0ec08355befcf8f46d45c2f1d48fc01966f6 +size 28705 diff --git a/marked/Rel-16/29_series/29892/759c7d62402f0b4651ddce292be5bdef_img.jpg b/marked/Rel-16/29_series/29892/759c7d62402f0b4651ddce292be5bdef_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f9713b633585a49b30f7d14578910084de2c1add --- /dev/null +++ b/marked/Rel-16/29_series/29892/759c7d62402f0b4651ddce292be5bdef_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fb0f4aaabe5ff6ab394cde3b223b7f2c003425b22626c72241cd5bbadc7d24e2 +size 49933 diff --git a/marked/Rel-16/29_series/29892/853f59c89931a666c07903b31d098277_img.jpg b/marked/Rel-16/29_series/29892/853f59c89931a666c07903b31d098277_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c2f526f977a690441a33adeb2388d251f95edb2e --- /dev/null +++ b/marked/Rel-16/29_series/29892/853f59c89931a666c07903b31d098277_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2a0c919b2ad11d3aba7b745225d84a8c10a0fdb4a0d918bcc429f5735e144bb8 +size 26423 diff --git a/marked/Rel-16/29_series/29892/90ddb84c323b956e2d50a54d3f870566_img.jpg b/marked/Rel-16/29_series/29892/90ddb84c323b956e2d50a54d3f870566_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8c0b6ae5ad0a2f0facf373485451363a46f5070a --- /dev/null +++ b/marked/Rel-16/29_series/29892/90ddb84c323b956e2d50a54d3f870566_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4eff0fbe9ecc2534061acdf0a70e1392b78d69eae7366b0892a15b9032c4f9a5 +size 38893 diff --git a/marked/Rel-16/29_series/29892/94acd33fcad85bb6f207a308f9b63191_img.jpg b/marked/Rel-16/29_series/29892/94acd33fcad85bb6f207a308f9b63191_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6afc6208941cb675da6fc22b73344bcf928c3581 --- /dev/null +++ b/marked/Rel-16/29_series/29892/94acd33fcad85bb6f207a308f9b63191_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ebc2cccaf6b3db5865b4979a9e1c1e9f80d18b20a5842cad64afd5cd3fa399e6 +size 72772 diff --git a/marked/Rel-16/29_series/29892/9a159e2112eac7be06bdb97e84a0c49a_img.jpg b/marked/Rel-16/29_series/29892/9a159e2112eac7be06bdb97e84a0c49a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e18d1719df9b7392ecf361efc7420934c01deaf7 --- /dev/null +++ b/marked/Rel-16/29_series/29892/9a159e2112eac7be06bdb97e84a0c49a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3475d791f7ce12d8a57c88a37100995baf290ab47a4326aa575a60e716068ab6 +size 65890 diff --git a/marked/Rel-16/29_series/29892/d26959f4514c26ca19c3d6f00da85956_img.jpg b/marked/Rel-16/29_series/29892/d26959f4514c26ca19c3d6f00da85956_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..897f82d270c1607ce9542ec76dbee00134398981 --- /dev/null +++ b/marked/Rel-16/29_series/29892/d26959f4514c26ca19c3d6f00da85956_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7c8b7364c83dd62f09d26cc4e5f5c8a1b9905242af0b4d47ebfacc1a0f7516fe +size 35337 diff --git a/marked/Rel-16/29_series/29892/dd380ccd5aca1151074fede04826f1a4_img.jpg b/marked/Rel-16/29_series/29892/dd380ccd5aca1151074fede04826f1a4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..dca5b42ca277a36ce4ddd3296957cbeaf85872fd --- /dev/null +++ b/marked/Rel-16/29_series/29892/dd380ccd5aca1151074fede04826f1a4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:489dac493c32f9bf415b22a56e84b096bd0d33471c256cd455311b0566e8b3c2 +size 39321 diff --git a/marked/Rel-16/29_series/29892/raw.md b/marked/Rel-16/29_series/29892/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..bf9002d70980f820058b057275c9ae0ba2fca720 --- /dev/null +++ b/marked/Rel-16/29_series/29892/raw.md @@ -0,0 +1,1607 @@ + + +# **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Study on User Plane Protocol in 5GC (Release 16)** + +![5G logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +--- + +The 5G logo, featuring a stylized '5G' in black with three green curved lines above the '5'. + +5G logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, featuring the letters '3GPP' in a stylized black font with a red signal icon below the 'P', and the text 'A GLOBAL INITIATIVE' below it. + +3GPP logo + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2019, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTSTM is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|--------------------------------------------------------|----| +| Foreword ..... | 6 | +| 1 Scope..... | 8 | +| 2 References..... | 8 | +| 3 Definitions, symbols and abbreviations ..... | 9 | +| 3.1 Definitions..... | 9 | +| 3.2 Abbreviations ..... | 10 | +| 4 Introduction..... | 10 | +| 5 User Plane Architecture in 5GC..... | 10 | +| 5.1 Architectural Requirements for User Plane ..... | 10 | +| 5.1.1 General ..... | 10 | +| 5.1.2 User Plane Functionality ..... | 13 | +| 5.1.3 Support for Error Recovery and Restoration..... | 13 | +| 5.2 Key Issues for User Plane Protocol..... | 14 | +| 5.2.1 IP Connectivity for N9 and Network Slicing ..... | 14 | +| 5.2.1.1 Description of Key Issue..... | 14 | +| 5.2.1.2 Considerations on Key Issue..... | 14 | +| 5.2.2 ..... | 15 | +| 5.2.x ..... | 15 | +| 5.2.y Summary of Key Issues..... | 15 | +| 6 Candidate User Plane Protocols..... | 15 | +| 6.1 GTP-U ..... | 15 | +| 6.1.1 Description ..... | 15 | +| 6.1.1.1 General..... | 15 | +| 6.1.1.2 IP Transport for GTP-U..... | 15 | +| 6.1.1.3 Path/Tunnel Management functions ..... | 15 | +| 6.1.1.4 Load Balancing..... | 16 | +| 6.1.1.5 Multicast ..... | 16 | +| 6.1.2 Analysis of IETF RFC 8200 Impacts ..... | 16 | +| 6.1.3 Solutions for Impacts due to IETF RFC 8200..... | 20 | +| 6.1.3.1 General..... | 20 | +| 6.1.3.2 Addressing UDP Zero Checksum Issue..... | 20 | +| 6.1.3.2.1 Solution Description..... | 20 | +| 6.1.3.2.2 Identified Impacts..... | 21 | +| 6.1.4 System Impacts..... | 21 | +| 6.2 Segment Routing IPv6 (SRv6)..... | 21 | +| 6.2.1 General SRv6 Description..... | 21 | +| 6.2.1.1 General..... | 21 | +| 6.2.1.2 Packet Processing ..... | 22 | +| 6.2.1.3 Network Programmability ..... | 23 | +| 6.2.2 Description of SRv6 solution in 5GC..... | 23 | +| 6.2.2.1 General..... | 23 | +| 6.2.2.2 Principles ..... | 23 | +| 6.2.2.3 SRv6 SID Encoding..... | 24 | +| 6.2.2.3.1 General ..... | 24 | +| 6.2.2.3.2 Discussion ..... | 24 | +| 6.2.2.4 User Plane packet flow ..... | 25 | +| 6.2.2.4.1 SRv6 in Traditional Mode..... | 25 | +| 6.2.2.4.2 SRv6 in Enhanced mode ..... | 26 | +| 6.2.2.4.2.1 Uplink..... | 27 | +| 6.2.2.4.2.2 Downlink ..... | 28 | +| 6.2.2.4.3 Hand-over..... | 28 | +| 6.2.2.5 Discovery of SRv6 supported UPF..... | 29 | +| 6.2.2.5.1 General ..... | 29 | + +| | | | +|--------------|-------------------------------------------------------------|----| +| 6.2.2.5.2 | Use PFCP protocol at N4 to pass SRv6 Capability..... | 29 | +| 6.2.2.5.3 | Use Local Configuration at SMF ..... | 30 | +| 6.2.2.5.4 | Discovery of UPF using NRF ..... | 30 | +| 6.2.2.6 | IPv4 Transport Support for SRv6 User Plane..... | 30 | +| 6.2.2.6.1 | General ..... | 30 | +| 6.2.2.6.2 | IPv4 Encapsulation and Decapsulation for IPv6 packet ..... | 30 | +| 6.2.2.6.3 | Routing IPv6 packet over IPv4 Transport Network..... | 30 | +| 6.2.2.6.4 | Mapping SRv6 User Plane IP Resource to IPv4 Transport ..... | 31 | +| 6.2.2.7 | Security Considerations for SRv6..... | 31 | +| 6.2.2.8 | Using SRH for User Plane Messages ..... | 31 | +| 6.2.2.8.1 | General ..... | 31 | +| 6.2.2.8.2 | Tag Encoding ..... | 31 | +| 6.2.2.9 | Packet forwarding between SMF and UPF..... | 32 | +| 6.2.2.10 | Roaming Support ..... | 32 | +| 6.2.2.11 | Failure Detection and Recovery ..... | 32 | +| 6.2.2.11.1 | General ..... | 32 | +| 6.2.2.11.2 | Failure Detection..... | 32 | +| 6.2.2.11.2.1 | Loss of SRv6 SID contexts..... | 32 | +| 6.2.2.11.2.2 | User Plane Path Failure ..... | 32 | +| 6.2.2.11.3 | Restoration Procedure ..... | 32 | +| 6.2.2.11.3.1 | SRv6 Error Indication received by another UPF ..... | 32 | +| 6.2.2.11.3.2 | Restoration Procedures upon User Plane Path Failure ..... | 33 | +| 6.2.2.11.4 | Restoration Procedure for User Plane Related Entities..... | 33 | +| 6.2.2.12 | SRv6 Guaranteed Packet Delivery ..... | 33 | +| 6.2.2.12.1 | General ..... | 33 | +| 6.2.2.12.2 | Redundant packet transmission for downlink traffic ..... | 33 | +| 6.2.2.12.3 | Removal of Redundant packet for uplink traffic..... | 34 | +| 6.2.2.13 | SRv6 extensibility using SRH TLVs ..... | 35 | +| 6.2.3 | System Impacts..... | 35 | +| 6.2.3.1 | General..... | 35 | +| 6.2.3.2 | Common System Impacts of SRv6..... | 35 | +| 6.2.3.2.1 | System Impact on N4 interface ..... | 35 | +| 6.2.3.2.1.1 | General ..... | 35 | +| 6.2.3.2.1.2 | Impact on PFCP procedure..... | 35 | +| 6.2.3.2.1.3 | Impact on PFCP IEs ..... | 36 | +| 6.2.3.2.2 | System Impact on N16/N16a/N38 interfaces..... | 36 | +| 6.2.3.3 | System Impacts of Traditional Mode..... | 37 | +| 6.2.3.4 | System Impacts of Enhanced Mode..... | 37 | +| 7 | Evaluations and Comparison ..... | 37 | +| 7.1 | Evaluation..... | 37 | +| 7.1.1 | Evaluation Points ..... | 37 | +| 7.1.2 | GTP-U ..... | 37 | +| 7.1.2.1 | General ..... | 37 | +| 7.1.2.2 | Architectural requirements for User Plane ..... | 37 | +| 7.1.2.3 | Key issues ..... | 37 | +| 7.1.2.4 | System impacts ..... | 38 | +| 7.1.3 | SRv6 ..... | 38 | +| 7.1.3.1 | Traditional Mode ..... | 38 | +| 7.1.3.1.1 | General ..... | 38 | +| 7.1.3.1.2 | Architectural requirements for User Plane ..... | 38 | +| 7.1.3.1.3 | Key issues..... | 38 | +| 7.1.3.1.4 | System impacts..... | 38 | +| 7.1.3.2 | Enhanced Mode ..... | 39 | +| 7.1.3.2.1 | General ..... | 39 | +| 7.1.3.2.2 | Architectural requirements for User Plane..... | 40 | +| 7.1.3.2.3 | Key issues..... | 40 | +| 7.1.3.2.4 | System impacts..... | 40 | +| 7.2 | Additional Considerations..... | 40 | +| 7.2.1 | Consideration Points..... | 40 | +| 7.2.2 | GTP-U ..... | 42 | +| 7.2.3 | SRv6 ..... | 44 | + +7.3 Comparison ..... 47 +8 Conclusion ..... 48 +8.1 General ..... 48 +8.2 GTP-U over IP-based transport (including SRv6) ..... 48 +8.3 SRv6 user plane protocol (without GTP-U)..... 49 +**Annex A: Change history ..... 50** + +# --- Foreword + +This Technical Report has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, certain modal verbs have the following meanings: + +**shall** indicates a mandatory requirement to do something + +**shall not** indicates an interdiction (prohibition) to do something + +NOTE 1: The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +NOTE 2: The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +**should** indicates a recommendation to do something + +**should not** indicates a recommendation not to do something + +**may** indicates permission to do something + +**need not** indicates permission not to do something + +NOTE 3: The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +**can** indicates that something is possible + +**cannot** indicates that something is impossible + +NOTE 4: The constructions "can" and "cannot" shall not to be used as substitutes for "may" and "need not". + +**will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document + +**will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document + +**might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +NOTE 5: The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document studies possible candidate protocols for the user plane in 5GC based on Rel-16 stage 2 requirements. + +This technical report covers the following analysis: + +- List architectural requirements and key issues; +- Identify the possible candidate protocols for user-plane including GTP-U as existing protocol, specified for Rel-15; +- Define a list of evaluation criteria based on Rel-16 stage 2 architecture and procedures to evaluate the candidate protocols; +- Evaluate the candidate solutions against the list of requirements and the potential benefits against the existing user plane solution in 5GS. + +The N3 and N6 user plane interfaces are out of the scope of this study. N3 uses GTP-U (see clause 4.3.1 of 3GPP TS 38.300 [12]). + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document in the same Release as the present document. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 29.281: "General Packet Radio System (GPRS) Tunnelling Protocol User Plane (GTPv1-U)". +- [3] IETF RFC 2460: "Internet Protocol, Version 6 (IPv6) Specification". +- [4] IETF RFC 8200: "Internet Protocol, Version 6 (IPv6) Specification". +- [5] IETF RFC 8402: "Segment Routing Architecture". +- [6] IETF draft-ietf-6man-segment-routing-header-18: "IPv6 Segment Routing Header (SRH)". +- [7] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [8] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [9] 3GPP TS 29.244: "Interface between the Control Plane and the User Plane Nodes; Stage 3". +- [10] 3GPP TS 38.415: "NG-RAN; PDU Session User Plane Protocol". +- [11] 3GPP TS 23.527: "5G System; Restoration Procedures". +- [12] 3GPP TS 38.300: "NR; NR and NG-RAN Overall Description; Stage 2". +- [13] IETF RFC 6437: "IPv6 Flow Label Specification". + +- [14] IETF draft-ali-spring-srv6-oam-01: "Operations, Administration, and Maintenance (OAM) in SRv6". +- [15] IETF RFC 1027: "Using ARP to Implement Transparent Subnet Gateways". +- [16] IETF RFC 4861: "Neighbor Discovery for IP version 6 (IPv6)". +- [17] 3GPP TS 29.060: "GPRS Tunnelling Protocol (GTP) across the Gn and Gp interface". +- [18] IETF RFC 2401: "Security Architecture for the Internet Protocol". +- [19] IETF RFC 4301: "Security Architecture for the Internet Protocol". +- [20] IETF RFC 6935: "IPv6 and UDP Checksums for Tunneled Packets". +- [21] IETF RFC 6936: "Applicability Statement for the Use of IPv6 UDP Datagrams with Zero Checksums". +- [22] 3GPP TR 23.725: "Study on enhancement of Ultra-Reliable Low-Latency Communication (URLLC) support in the 5G Core network (5GC)". +- [23] 3GPP TR 23.726: " Study on Enhancing Topology of SMF and UPF in 5G Networks". +- [24] 3GPP TS 23.214: "Architecture enhancements for control and user plane separation of EPC nodes; Stage 2". +- [25] 3GPP TS 29.510: "Network Function Repository Services, Stage 3". +- [26] IETF RFC 4213: "Basic Transition Mechanisms for IPv6 Hosts and Routers". +- [27] IETF RFC 5969: "IPv6 Rapid Deployment on IPv4 Infrastructures (6rd) Protocol Specification". +- [28] IETF draft-geng-detnet-dp-sol-srv6-00: "DetNet SRv6 Data Plane Encapsulation". +- [29] 3GPP TS 29.502: "Session Management Services, Stage 3". +- [30] IETF draft-ietf-spring-segment-routing-policy-02: "Segment Routing Policy Architecture". +- [31] IETF RFC 6438: "Using the IPv6 Flow Label for Equal Cost Multipath Routing and Link Aggregation in Tunnels". + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in TR 21.905 [1]. + +**Core network service slice:** network slice created within the 5GC as defined in TS 23.501 [7]. This does not refer to any slice in the transport network. + +**Forwarding Entity:** Any entity that is explicitly encoded in the user plane packet header to process and forward the packet. Transport layer entities that are agnostic to the user plane protocol being used in a 3GPP network are not considered as forwarding entity within the scope of this TR. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in TR 21.905 [1]. + +| | | +|-------|------------------------------------------| +| BP | Branching Point | +| I-UPF | Intermediate UPF | +| I-SMF | Intermediate SMF | +| SR | Segment Routing | +| SRv6 | Segment Routing IPv6 | +| SRH | Segment Routing Header | +| SID | Segment ID | +| DA | Destination Address | +| NPU | Network Processing Unit | +| PSA | PDU Session Anchor | +| UL CL | Uplink Classifier | +| UP | User Plane | +| UPF | User Plane Function | +| URLLC | Ultra Reliable Low Latency Communication | +| VM | Virtual Machine | + +# 4 Introduction + +# 5 User Plane Architecture in 5GC + +## 5.1 Architectural Requirements for User Plane + +### 5.1.1 General + +The system architecture requirements specified in TS 23.501 [7] and TS 23.502 [8] shall apply. + +**Editor's Note:** the stage 2 work for Rel-16 is on-going in 3GPP SA2. The following requirements are derived from the Rel-15 stage 2 specifications and the Rel-16 stage 2 requirements that are currently available. More requirements may be captured in this clause based on the outcomes of the Rel-16 stage 2 work. + +Figure 5.1.1-1 depicts the 5G System architecture, where N3, N6 and N9 are user plane interfaces, and N4 is the control plane interface to control the user plane functionalities in the UPF. + +![Figure 5.1.1-1: 5G System architecture diagram showing the flow between UE, (R)AN, UPF, and DN, with various interfaces (N1, N2, N3, N4, N6, N9) and Network Functions (NSSF, NEF, NRF, PCF, UDM, AF, AUSF, AMF, SMF) connected via Service Based Interfaces (Nnssf, Nnef, Nnrf, Npcf, Nudm, Naf, Nausf, Namf, Nsmf).](4dadfd8b8240e9d83f974e3f0fdd18df_img.jpg) + +``` + +graph TD + subgraph SBI [Service Based Interface] + direction TB + NSSF[NSSF] --- Nnssf + NEF[NEF] --- Nnef + NRF[NRF] --- Nnrf + PCF[PCF] --- Npcf + UDM[UDM] --- Nudm + AF[AF] --- Naf + AUSF[AUSF] --- Nausf + AMF[AMF] --- Namf + SMF[SMF] --- Nsmf + end + UE[UE] --- N1 --- AMF + AMF --- N2 --- RAN[(R)AN] + RAN --- N3 --- UPF[UPF] + UPF --- N6 --- DN[DN] + UPF --- N9 --- UPF + AMF --- N4 --- SMF + +``` + +Figure 5.1.1-1: 5G System architecture diagram showing the flow between UE, (R)AN, UPF, and DN, with various interfaces (N1, N2, N3, N4, N6, N9) and Network Functions (NSSF, NEF, NRF, PCF, UDM, AF, AUSF, AMF, SMF) connected via Service Based Interfaces (Nnssf, Nnef, Nnrf, Npcf, Nudm, Naf, Nausf, Namf, Nsmf). + +Figure 5.1.1-1: 5G System architecture + +Figure 5.1.1-2 depicts the 5G System architecture (non-roaming architecture) with the insertion of an I-SMF and UL-CL/BP, for PDU sessions where the SMF cannot control the UPF terminating the N3 interface and communicate via the N16a interface with an I-SMF that is inserted to control the UPF(s) that the SMF cannot directly control. + +![Figure 5.1.1-2: 5G System architecture with I-SMF insertion and UL-CL/BP. The diagram shows the following components and interfaces: UE connected to (R)AN via N1; (R)AN connected to AMF via N2; AMF connected to NSSF via N22, AUSF via N12, UDM via N8, I-SMF via N11, and UPF via N14; I-SMF connected to SMF via N16a; SMF connected to UDM via N10, PCF via N7, and UPF via N4; PCF connected to AF via N5; UPF connected to DN via N6 and N9. There are two UPFs: one connected to (R)AN via N3 and another connected to SMF via N4. The first UPF has an N16a interface to the I-SMF and an N9 interface to the second UPF. The second UPF has an N4 interface to the SMF and an N6 interface to the DN. The I-SMF also has an N38 interface to the UDM and an N15 interface to the SMF. The CHF is connected to the UDM via N40.](d26959f4514c26ca19c3d6f00da85956_img.jpg) + +Figure 5.1.1-2: 5G System architecture with I-SMF insertion and UL-CL/BP. The diagram shows the following components and interfaces: UE connected to (R)AN via N1; (R)AN connected to AMF via N2; AMF connected to NSSF via N22, AUSF via N12, UDM via N8, I-SMF via N11, and UPF via N14; I-SMF connected to SMF via N16a; SMF connected to UDM via N10, PCF via N7, and UPF via N4; PCF connected to AF via N5; UPF connected to DN via N6 and N9. There are two UPFs: one connected to (R)AN via N3 and another connected to SMF via N4. The first UPF has an N16a interface to the I-SMF and an N9 interface to the second UPF. The second UPF has an N4 interface to the SMF and an N6 interface to the DN. The I-SMF also has an N38 interface to the UDM and an N15 interface to the SMF. The CHF is connected to the UDM via N40. + +**Figure 5.1.1-2: 5G System architecture with I-SMF insertion and UL-CL/BP.** + +The following architectural requirements apply to the user plane: + +- 1) IPv4, IPv6, IPv4v6, Ethernet and Unstructured PDU sessions shall be supported. +- 2) The User Plane protocol shall be able to run over IPv4 and IPv6. +- 3) 3GPP specifications support deployments with a single UPF or multiple UPFs for a given PDU session. +- 4) A UPF that terminates a N6 interface is said to support a PDU Session Anchor (PSA) functionality. A PDU session may support one or multiple PSAs. +- 5) A UPF may be inserted to support the UL Classifier (UL CL) functionality (see clause 5.6.4.2 of TS 23.501 [7]) or the Branching Point functionality (see clause 5.6.4.3 of TS 23.501 [7]) to forward the traffic of the PDU session to/from different PSAs. It is possible for a UPF to support both the UL CL or Branching Point functionalities and PSA functionalities. +- 6) The SMF shall control the user plane functionalities in the UPF using the N4 reference point. This includes controlling all the functionalities specified in clause 5.8 of TS 23.501 [7] and in TS 29.244 [9], e.g. + - Establishing and releasing user plane tunnels; + - Detecting, forwarding, buffering, duplicating (for Lawful Interception) or dropping user plane packets; + - Enforcing PCC and QoS policies (e.g. gating control, QoS control, packet marking, traffic steering); + - Detecting and reporting user plane events (e.g. receipt of DL packets for a PDU session without user plane connectivity in 5G-AN, application start/stop, user plane inactivity); + - Measuring and reporting traffic counts for PCC or charging; + - Other functionalities (e.g. tracing, framed routing). +- 7) End Marker user plane packets shall be supported to assist packets reordering in the target RAN during mobility scenarios (see Annex A of TS 29.281 [2]), e.g. handovers, QoS flows mobility with dual connectivity. End markers may be generated in the SMF or in the UPF. End Marker user plane packets origination from an Intermediate UPF (I-UPF) and from the PSA UPF shall be supported. Transfer of End Marker user plane packets by an I-UPF shall be supported. +- 8) The PDU Session User Plane Protocol (see TS 38.415 [10]) shall be supported to transfer 5GS information over N3 and N9 (e.g. QoS Flow Identifier, Reflective QoS Indicator, Paging Policy Indicator) together with user plane packets. + +- 9) It shall be possible to detect and handle user plane path failures as specified in clause 5 of TS 23.527 [11]. +- 10) The user plane protocol shall be applicable to home routed roaming scenarios as well. +- 11) It shall be possible to detect and handle the loss of a user plane context in a peer UPF as specified in clause 5 of TS 23.527 [11]. + +NOTE: Other user plane requirements need to be supported in the RAN, e.g. to transport PDCP PDU Number or RAN Containers, but this is out of scope of this study. + +- 12) When multiple UPFs are chained, the change in RAN node shall only create N4 signaling towards its immediate next hop UPF (in scenarios where the I-UPF with the N9 interface with the PSA does not need to be changed). The anchor UPF shall not be aware of the change of RAN node. +- 13) In the case of home routed roaming, the PSA UPF in HPLMN shall not be aware of the topology of the VPLMN. In other words, the IP addresses of the RAN nodes in the VPLMN are not known to the HPLMN. +- 14) If the user plane protocol on N9 is different from the user plane protocol on N3, then interworking of user plane packets from one protocol to the other shall be well specified and have the least processing impacts. +- 15) Data forwarding shall be supported between the SMF and UPF, see clause 5.3 of TS 29.244 [9]. +- 16) For non-roaming or LBO roaming cases, and PDU sessions not using SSC mode 2 or 3, an I-SMF may be inserted to control the UPF terminating the N3 interface. Based on PCC rules received from PCF and DNAI list reported by the I-SMF, the SMF provides the I-SMF with information that allows the I-SMF to make traffic routing related decisions and I-UPF selection decisions (among others), e.g. to add, replace or remove a UPF in the data path. See TR 23.726 [23]. +- 17) Redundant transmission may be supported on N9 (and N3) via two independent tunnels associated with a single PDU session, for Ultra Reliable Low Latency Communications (URLLC). See TR 23.725 [22]. If the SMF decides to perform redundant transmission for one or more QoS flows of a PDU session, the SMF allocates two CN tunnels and indicates the UPF to perform redundant transmission of packets of the QoS flow(s) in the downlink direction, or to eliminate duplicate packets for the QoS flow(s) in the uplink direction, via the N4 interface. + +Two Intermediate UPFs (I-UPFs) between the PSA UPF and the NG-RAN may be used to support the redundant transmission based on two N3 and N9 tunnels between a single NG-RAN node and the UPF. + +![Diagram illustrating two N3 and N9 tunnels between NG-RAN and UPF for redundant transmission. The diagram shows the following components and connections: UE connected to NG-RAN; NG-RAN connected to AMF via N2 and to UPF via N3; AMF connected to SMF via N11; SMF connected to PCF via N7 and to I-UPF1 and I-UPF2 via N4; I-UPF1 and I-UPF2 connected to UPF via N9; UPF connected to DN via N6. Two parallel tunnels are shown: N3 Tunnel 1 (NG-RAN to I-UPF1) and N9 Tunnel 1 (I-UPF1 to UPF); N3 Tunnel 2 (NG-RAN to I-UPF2) and N9 Tunnel 2 (I-UPF2 to UPF).](853f59c89931a666c07903b31d098277_img.jpg) + +Diagram illustrating two N3 and N9 tunnels between NG-RAN and UPF for redundant transmission. The diagram shows the following components and connections: UE connected to NG-RAN; NG-RAN connected to AMF via N2 and to UPF via N3; AMF connected to SMF via N11; SMF connected to PCF via N7 and to I-UPF1 and I-UPF2 via N4; I-UPF1 and I-UPF2 connected to UPF via N9; UPF connected to DN via N6. Two parallel tunnels are shown: N3 Tunnel 1 (NG-RAN to I-UPF1) and N9 Tunnel 1 (I-UPF1 to UPF); N3 Tunnel 2 (NG-RAN to I-UPF2) and N9 Tunnel 2 (I-UPF2 to UPF). + +**Figure 5.1.1-3: Two N3 and N9 tunnels between NG-RAN and UPF for redundant transmission** + +The PSA UPF duplicates the downlink packet of the QoS Flow from the DN and assigns the same GTP-U sequence number to them. These duplicated packets are transmitted to I-UPF1 and I-UPF2 via N9 Tunnel 1 and N9 Tunnel 2 separately. Each I-UPF forwards the packet with the same GTP-U sequence number as received from the UPF to NG-RAN via N3 Tunnel 1 and N3 Tunnel 2 respectively. The NG-RAN eliminates the duplicated packet based on the GTP-U sequence number. For uplink traffic, the NG-RAN duplicates the packet of the QoS Flow for the UE and the UPF eliminates the duplicated packet based on the GTP-U sequence number. + +### 5.1.2 User Plane Functionality + +This clause lists the main UP functionalities required to be supported by UPF as per stage 2 specified in clause 6.2.3 of TS 23.501 [7] as following: + +- Anchor point for Intra-/Inter-RAT mobility (when applicable); +- External PDU Session point of interconnect to Data Network; +- Packet routing & forwarding (e.g. support of Uplink classifier to route traffic flows to an instance of a data network, support of Branching point to support multi-homed PDU Session); +- Packet inspection (e.g. Application detection based on service data flow template and the optional PFDs received from the SMF in addition); +- User Plane part of policy rule enforcement, e.g. Gating, Redirection, Traffic steering); +- Lawful intercept (UP collection); +- Traffic usage reporting; +- QoS handling for user plane, e.g. UL/DL rate enforcement, Reflective QoS marking in DL; +- Uplink Traffic verification (SDF to QoS Flow mapping); +- Transport level packet marking in the uplink and downlink; +- Downlink packet buffering and downlink data notification triggering; +- Sending and forwarding of one or more "end marker" to the source NG-RAN node; +- ARP proxying as specified in IETF RFC 1027 [15] and / or IPv6 Neighbour Solicitation Proxying as specified in IETF RFC 4861 [16] functionality for the Ethernet PDUs. The UPF responds to the ARP and / or the IPv6 Neighbour Solicitation Request by providing the MAC address corresponding to the IP address sent in the request; +- Packet duplication in downlink direction and elimination in uplink direction by the UP protocol. + +NOTE: Not all of the UPF functionalities are required to be supported in an instance of user plane function of a Network Slice. + +### 5.1.3 Support for Error Recovery and Restoration + +As per the 5GC architecture specified in TS 23.501 [7] and TS 23.502 [8], the packet detection and forwarding rules at the UPF are installed and controlled on a per PDU session basis over the N4 interface. This results in the creation of packet detection and forwarding state on a per PDU session basis at the UPF. 3GPP currently specifies the path failure detection, error detection and recovery mechanism when GTPU is used as the user plane protocol, in TS 23.527 [11]. + +Any user plane protocol to be used for 5GC shall then correspondingly have: + +- Mechanisms for the detection of loss of "packet forwarding state" associated with a user plane packet at the receiving UPF; +- Mechanisms for detecting loss of connectivity towards a destination UPF; +- Mechanisms for detection of loss of connectivity towards transport layer forwarding entities, if the user plane protocol explicitly encodes the transport path; +- Mechanisms for the recovery of packet detection and forwarding state after the failure of a forwarding entity that is explicitly encoded in the user plane protocol to process the packet. + +## 5.2 Key Issues for User Plane Protocol + +This clause will identify key issues which the candidate protocols can solve, or could be improved. + +### 5.2.1 IP Connectivity for N9 and Network Slicing + +#### 5.2.1.1 Description of Key Issue + +The N9 interface requires IP connectivity between UPFs. IP networking issues may affect the user plane of 3GPP system. The data path between UPFs may consist of various links and IP routing nodes so that multiple paths may be available for the N9 interface. The bandwidth, latency and reliability of those paths may differ. + +The 5GC supports the concept of network slicing. The Network Instance ID supported over N4 enables to provide information to the UPF about the network slice of the PDU session (see clause 5.6.12 of 3GPP TS 23.501 [7], which indicates that the Network Instance ID can be selected based on the S-NSSAI of the PDU session). The UPFs need to have information on the transport network slice to allow the user plane packet of PDU sessions of 5GC network slices to be sent via appropriate transport networks. There is no one to one mapping between 5GC slices and transport network slices, i.e. several 5GC slices may use the same transport network slice. + +NOTE: How network slicing is supported in transport networks is out of scope of 3GPP. + +It is proposed to study the following aspects: + +- whether there is a requirement to pass information about the network slice or the required QoS for the data path in the user plane packets. + +#### 5.2.1.2 Considerations on Key Issue + +This clause provides considerations for the Key Issue documented in clause 5.2.1.1 on whether there is a requirement to pass information about the network slice or the required QoS for the data path in user plane packets. + +The following considerations apply: + +- 1) 3GPP UP entities (UPFs for the N9 interface) get information about the core network service slice of the PDU session, via the Network Instance ID received from the SMF over N4 for UPFs, as specified in clause 5.2.1; there is thus no need to carry service slice information in UP packets, for 3GPP UP entities of the core network; +- 2) To support network slicing, 3GPP UP entities (UPFs for the N9 interface) are expected to be configured with local information to map core network service slices (Network Instance IDs) to transport links or VPNs (or "transport slices"); +- 3) There is no one to one mapping between core network service slices and transport slices, i.e. several service slices may use the same transport slice. +- 4) How network slicing is supported in transport networks to support QoS and traffic segregation is out of scope of 3GPP. It is expected that transport slicing can be implemented with any existing technologies, e.g. using different types of L2 or L3 VPNs, MPLS-based services or segment routing, relying on service level agreement with the transport network operator. + +NOTE: This is consistent with earlier conclusion at TSG SA#75 not to do any work on transport aspects, see TSG SA Reply LS ([SP-170276](#)) to SA5 LS ([SP-170173](#)) and RAN3 LS ([SP-170299](#)). + +- 5) Network slicing is already supported in 3GPP Rel-15, without any newly defined service slice or transport slice information in the user plane and relying on existing means to identify transport slices in the user plane such as VLAN tags or MPLS service labels and IP addresses. + +There is no existing 3GPP requirement to: + +- pass any new information about the service slice in UP packets; +- define and pass any new identifier in UP packets to identify transport slices or the required QoS for the data path. + +5.2.2 + +5.2.x + +5.2.y Summary of Key Issues + +# --- 6 Candidate User Plane Protocols + +This clause will describe each candidate protocol. + +## 6.1 GTP-U + +### 6.1.1 Description + +#### 6.1.1.1 General + +GTP-U is a tunneling protocol between given a pair of GTP-U tunnel endpoints. A Tunnel Endpoint ID (TEID) value allocated on each end point indicates which tunnel a particular T-PDU belongs to. That is described in clause 4.2.1 of TS 29.281 [2]. + +The receiving endpoint individually allocates the TEID and the sender tunnel endpoint encapsulates the packet from/to the UE with the TEID at the receiving endpoint in GTP-U header on top of UDP and IPv4 or IPv6. + +#### 6.1.1.2 IP Transport for GTP-U + +GTP-U supports both IPv4 and IPv6 as underlying transport layer protocol. As for IPv6, GTP-U specification refers to IETF RFC 2460 [3], which is described in clause 4.2.3 of TS 29.281 [2]. An analysis of the differences in the latest IETF RFC 8200 [4] for IPv6 and their impact on GTPU protocol is specified in clause 6.1.2. + +UDP is utilized for GTP-U encapsulation and UDP destination port is 2152 which is assigned by IANA. Allocation of UDP source port depends on sender tunnel endpoint node. + +GTP-U can be transported using transport technologies, such as L2 or L3 VPNs, MPLS-based services or segment routing (SR-MPLS or SRv6), as described in clause 5.2.1.2. + +For some specific transport protocols of GTP-U (e.g. SR-MPLS or SRv6), the intended path in the transport networks is encoded in the transport protocol header corresponding to Network Instance. + +UDP checksum can be used to detect packet corruptions, if required. + +#### 6.1.1.3 Path/Tunnel Management functions + +GTP-U supports in-band signaling for path and tunnel management. Currently GTP-U supports the following messages: + +- Echo Request; +- Echo Response; +- Supported Extension Headers Notification; +- Error Indication; +- End Marker. + +A GTP-U tunnel endpoint node sends an Echo Request message to another node for keep-alive and the receiving node sends an Echo Response message to sender node as acknowledgment. Echo Request message and Echo Response message are described in clause 7.2.1 and clause 7.2.2 of TS 29.281 [2] respectively. + +The Supported Extension Headers Notification message indicates supported extension header by the tunnel endpoint node. This message is sent only in case a tunnel endpoint node receives GTP-U packet with unsupported extension header. + +GTP-U has the Error Indication message to notify the sending endpoint that the receiving endpoint has discarded packets for which no session exists. The Error Indication message is described in clause 7.3.1 of TS 29.281 [2]. + +GTP-U has End Marker message to indicate the end of the payload stream that needs to be sent on a GTP-U tunnel. End Marker message is described in clause 7.3.2 of TS 29.281 [2]. + +#### 6.1.1.4 Load Balancing + +A GTP-U tunnel endpoint node can utilize UDP source port for load balancing purpose. The specification of this dynamic allocation is described in clause 4.4.2.0 of TS 29.281 [2]. The logic of source port number calculation is not described in the document and it depends on the implementation of GTP-U tunnel endpoint node. + +#### 6.1.1.5 Multicast + +GTP-U allows one tunnel endpoint node to send out a G-PDU to be received at multiple tunnel endpoints by utilizing IP multicast capability of underlay IP networks. It is used for MBMS (Multimedia Broadcast Multicast Service) through GTP-U tunnel that is described in clause 4.2.6 of TS 29.281 [2]. It means that GTP-U has Point-to-Multipoint (P2MP) tunneling capability. + +### 6.1.2 Analysis of IETF RFC 8200 Impacts + +IETF RFC 8200 [4], Appendix B specifies the changes in IPv6 protocol since IETF RFC 2460 [3]. Table 6.1.2-1 provides an analysis of the impact of each of these specified changes on the GTPU protocol. + +Table 6.1.2-1 Analysis of Impacts on GTPU due to IETF RFC 8200 [4] + +| SI.No | Change in IETF RFC 8200 [4] from IETF RFC 2460 [3] | Impact on GTPU | +|-------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Removed IP Next Generation from the Abstract. | Editorial correction. No impact on GTPU. | +| 2 | Added text in Clause 1 that the data transmission order is the same as IPv4 as defined in RFC 791 | This is just a clarification to resolve ambiguity. 3GPP TS 29.281 [2], clause 4.5 refers to 3GPP TS 29.060 [17], clause 5 which describes the transmission order as network byte order starting from octet 1. Hence GTPU specifications are already aligned with this clarification. | +| 3 | Clarified the text in Clause 3 about decrementing the Hop Limit. |

In IETF RFC 2460 [3] clause 3, the text read as:
"Decrement by 1 by each node that forwards the packet. The packet is discarded if Hop Limit is decremented to zero."

In IETF RFC 8200 [4] this was clarified as:
"Decrement by 1 by each node that forwards the packet. When forwarding, the packet is discarded if Hop Limit was zero when received or is decremented to zero. A node that is the destination of a packet should not discard a packet with Hop Limit equal to zero; it should process the packet normally."

Even if a legacy GTPU entity interpreted IETF RFC 2460 [3] verbatim and had dropped packets that had a hop limit of 0, upgrading that entity to support IETF RFC 8200 [4] could only make sure unnecessary packet drops are not done and would improve the overall KPI / performance of the system. Upgrading to IETF RFC 8200 [4] does not cause any specific interoperability issue with respect to this specific hop limit clarification.

Hence it is safe to update the behaviour of a GTPU entity to align with IETF RFC 8200 [4] with respect to hop limit interpretation.

| +| 4 | Clarified that extension headers (except for the Hop-by-Hop Options header) are not processed, inserted, or deleted by any node along a packet's delivery path. | 3GPP TS 29.281 [2] does not specify insertion IPv6 extension headers by GTPU entities. Hence this does not impact GTPU. | +| 5 | Changed requirement for the Hop-by-Hop Options header to a "may", and added a note to indicate what is expected regarding the Hop-by-Hop Options header. |

IETF RFC 2460 [3] required that all nodes must examine and process the Hop-by-Hop Options header. But IETF RFC 8200 [4] specifies that nodes along a packet's delivery path only examine and process the Hop-by-Hop Options header if explicitly configured to do so.

The hop-by-hop headers are a IPv6 level information. As mentioned above GTPU does not expect any hop by hop headers. So this change in the RFC does not impact the GTPU protocol specification.

| +| 6 | Added a paragraph to Clause 4 to clarify how extension headers are numbered and which are upper-layer headers. | GTPU does not use any IPv6 extension header and this clarification has no impact to GTPU. | +| 7 | Added a reference to the end of Clause 4 to the "IPv6 Extension Header Types" IANA registry. | GTPU does not use any IPv6 extension header and this clarification has no impact to GTPU. | +| 8 | Incorporated the updates from RFCs 5095 and 5871 to remove the description of RH0, that the allocations guidelines for routing headers are specified in RFC 5871, and removed RH0 from the list of required extension headers. | GTPU does not use any IPv6 extension header and this clarification has no impact to GTPU. | +| 9 | Revised Clause 4.5 on IPv6 fragmentation based on updates from RFCs 5722, 6946, 7112, and 8021. See rows below for the specific changes made. | See below. | +| 10 | Revised the text to handle the case of fragments that are whole datagrams (i.e., both the Fragment Offset field and the M flag are zero). If received, they should | This is a clarification to the IPv6 layer of the stack on how to do the fragmentation. This does not impact GTPU protocol. | + +| | | | +|----|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | be processed as a reassembled packet. Any other fragments that match should be processed independently. The revised Fragment creation process was modified to not create whole datagram fragments (Fragment Offset field and the M flag are zero). | | +| 11 | Changed the text to require that IPv6 nodes must not create overlapping fragments. Also, when reassembling an IPv6 datagram, if one or more its constituent fragments is determined to be an overlapping fragment, the entire datagram (and any constituent fragments) must be silently discarded. Includes a clarification that no ICMP error message should be sent if overlapping fragments are received. | This is a clarification to the IPv6 layer of the stack on how to do the fragmentation. This does not impact GTPU protocol. | +| 12 | Revised the text to require that all headers through the first Upper-Layer header are in the first fragment. This changed the text describing how packets are fragmented and reassembled and added a new error case. | The new error case added is about the silent discarding of overlapping fragments during re-assembly. This is a clarification to the IPv6 layer of the stack on how to do the reassembly. This does not impact GTPU protocol. | +| 13 | Added text to the Fragment header process on handling exact duplicate fragments. |

The clarification added is:
"It should be noted that fragments may be duplicated in the network. Instead of treating these exact duplicate fragments as overlapping fragments, an implementation may choose to detect this case and drop exact duplicate fragments while keeping the other fragments belonging to the same packet."

This is an IPv6 level clarification for implementation. This does not impact GTPU protocol.

| +| 14 | Updated the Fragmentation header text to correct the inclusion of an Authentication Header (AH) and noted No Next Header case. | No impact to GTPU. | +| 15 | Changed terminology in the Fragment header clause from "Unfragmentable Headers" to "Per-Fragment headers". | No impact to GTPU. | +| 16 | Removed the paragraph in Clause 5 that required including a Fragment header to outgoing packets if an ICMP Packet Too Big message reports a Next-Hop MTU less than 1280. | No impact to GTPU. | +| 17 | Changed the text to clarify MTU restriction and 8-byte restrictions, and noted the restriction on headers in the first fragment. | No impact to GTPU. | +| 18 | In Clause 4.5, added clarification noting that some fields in the IPv6 header may also vary across the fragments being reassembled, and that other specifications may provide additional instructions for how they should be reassembled. See, for example, Clause 5.3 of [RFC3168]. | No impact to GTPU. | +| 19 | Incorporated the update from RFC 6564 to add a new Clause 4.8 that describes recommendations for defining new extension headers and options. | No impact to GTPU. | +| 20 | Added text to Clause 5 to define "IPv6 minimum link MTU". | This is just a clarification. No impact to GTPU. | +| 21 | Simplified the text in Clause 6 about Flow Labels and removed what was Appendix A ("Semantics and Usage of the Flow Label Field"); instead, pointed to the current specifications of the IPv6 Flow Label field in [RFC6437] and the Traffic Class field in [RFC2474] and [RFC3168]. |

IETF RFC 2460 [3], Appendix A specified the semantics and usage of the flow label field. Current implementations of GTPU entities rely on this. This did not specify any behaviour for the IPv6 forwarding nodes on whether they are permitted to modify the flow label if it was set to zero by the source of the IPv6 packet.

However, IETF RFC 8200 [4] removed this Appendix and instead is referring to IETF RFC 6437 [13] which specifies in clause 3:

A node that forwards a flow whose flow label value in arriving packets is zero MAY change the flow label value. In that case, it is RECOMMENDED that the forwarding node sets the flow label field for

| + +| | | | +|----|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | |

a flow to a uniformly distributed value as just described for source nodes.

providing the flexibility for GTPU entities that forward user plane packets to set the flow label if the incoming packet has a zero value for the flow label.

If 3GPP TS 29.281 [2] is updated to refer to IETF RFC 8200 [4] then new implementations of GTPU entities may use this flexibility at the IPv6 level even though it does not impact GTPU protocol specification as such.

| +| 22 | Incorporated the update made by IETF RFC 6935 [20] ("IPv6 and UDP Checksums for Tunneled Packets") in Clause 8. Added an exception to the default behavior for the handling of UDP packets with zero checksums for tunnels. |

IETF RFC 2460 [3], clause 8.1 specifies

Unlike IPv4, when UDP packets are originated by an IPv6 node, the UDP checksum is not optional. That is, whenever originating a UDP packet, an IPv6 node must compute a UDP checksum over the packet and the pseudo-header, and, if that computation yields a result of zero, it must be changed to hex FFFF for placement in the UDP header. IPv6 receivers must discard UDP packets containing a zero checksum, and should log the error.

IETF RFC 8200 [4] refers to IETF RFC 6936 [21] which in turn refers to IETF RFC 6935 [20] and allows the following exceptions to the above rule:

  • - Allows tunneling protocol entities (e.g. GTPU entities) to use UDP zero checksum;
  • - Allows a receiving IPv6 tunneling protocol entity (e.g. GTPU entity) not to discard a packet with a zero UDP checksum.

Due to the addition of these exceptions, if 3GPP TS 29.281 [2] is updated to refer to IETF RFC 8200 [4] then it is possible that a IETF RFC 8200 [4] compliant GTPU entity includes UDP zero checksum while a receiving IETF RFC 8200 [4] non-compliant GTPU entity will keep rejecting the packets.

In order to avoid such inter-operability issues, a solution shall be identified to negotiate the GTPU entity's capabilities via the 3GPP control plane protocol.

Also the requirements on the usage of the zero UDP checksum specified in clause 5 of IETF RFC 6936 [21] needs to be taken into account.

| +| 23 | Added instruction to Clause 9, "IANA Considerations", to change references to IETF RFC 2460 [3] to this document. | No impact to GTPU. | +| 24 | Revised and expanded Clause 10, "Security Considerations". |

IETF RFC 2460 [3] referred to IETF RFC 2401 [18] whereas IETF RFC 8200 [4] refers to IETF RFC 4301 [19] which has updated a number of security considerations for IPSec use over IPv6. Hence if 3GPP TS 29.281 [2] is updated to refer to IETF RFC 8200 [4] then the requirements in IETF RFC 4301 [19] would apply. However this does not bring any change to the GTPU protocol specification as such.

| +| 25 | Added a paragraph to the Acknowledgments clause acknowledging the authors of the updating documents. | Editorial. No impact to GTPU. | +| 26 | Updated references to current versions and assigned references to normative and informative. | Editorial. No impact to GTPU. | + +### 6.1.3 Solutions for Impacts due to IETF RFC 8200 + +#### 6.1.3.1 General + +This clause addresses solutions for the impacts to GTP-U identified in clause 6.1.2 due to IETF RFC 8200 [4]. + +#### 6.1.3.2 Addressing UDP Zero Checksum Issue + +##### 6.1.3.2.1 Solution Description + +When a GTP-U entity is upgraded to support IETF RFC 8200 [4], then in order to use the UDP Zero Checksum capability, it has to be ensured that the path from the GTP-U entity to its peer GTP-U entity supports this capability, i.e all the on path IPv6 middleboxes should also be supporting UDP zero checksum (see IETF RFC 6936 [21]). In order to ensure that the following building block information is needed + +- When a GTP-U tunnel over IPv6 is setup between two GTP-U entities, via 3GPP control plane signaling, the 3GPP control plane entities shall signal each other that a UDP zero checksum handling capable path that ensures integrity of the packet, is available for the GTP-U tunnel over IPv6. + +The following steps provide the mechanism for a GTP-U entity to know the support for UDP zero checksum capable path towards a peer GTP-U entity. + +1. Before a GTP-U tunnel is established between two GTP-U entities, the control plane function will get to know the peer GTP-U endpoint FTEID as part of control plane signalling. It is proposed that as part of this FTEID exchange over control plane, the following information is also exchanged between the control plane entities: + +- Based on operator policies, whether a UDP zero checksum over IPv6 capable path that ensures integrity of the packet exists between the peer GTP-U entities. + +NOTE: Whether this requires signalling 2 information over N4 - the UDP zero checksum support capability by peer GTP-U entities and the allowance to use the same based on operator policies as separate IEs or whether they can be combined into a single IE / bit can be determined during the normative phase. + +2. For example, during PDU session establishment scenario, when the SMF establishes the N4 session in step 10 of the call flow specified in clause 4.3.2.2.1 of TS 23.502 [8], + +- Either the UPF shall signal to the SMF, the availability of a UDP zero checksum support capable path that ensures the integrity of the packet, from a particular outbound network interface, based on operator policies; or +- The UPF shall signal to the SMF its UDP zero checksum support capability during the PFCP Association Setup Request / Response, and the SMF, based on operator policies, determines if a UDP zero checksum over IPv6 capable path that ensures the integrity of the packet, exists between the UPF and the peer GTP-U entity. + +Then when the SMF initiates the N2 PDU session request towards the 5G-AN via the AMF in step 11, it shall include the information about the availability of a UDP zero checksum over IPv6 capable path between the UPF and the 5G-AN. This enables the 5G-AN to decide whether to send GTP-U packets with UDP zero checksum or not towards the UPF in the uplink direction. + +3. When the 5G-AN responds to the N2 request, it shall include the information about the availability of UDP zero checksum over IPv6 capable path that ensures the integrity of the packet, between the 5G-AN and the UPF, based on operator policies at the 5G-AN. The SMF will get to know of this in step 15 and will inform it to UPF in step 16. This enables the UPF to decide whether to send GTP-U packets with UDP zero checksum or not towards the 5G-AN in the downlink direction. +4. Similarly the UDP zero checksum support capability can be signalled between the NG-RAN nodes for the use of GTP-U on the Xn and F1-U interfaces as well. +5. Once a UP function entity is informed that UDP zero checksum can be used e.g. when it is allowed by operator policies and when the peer GTP-U entity supports UDP zero checksum, it should send an Echo Request to the + +GTP-U peer periodically in order to check the aliveness of the GTP-U path with UDP zero checksum, as specified in IETF RFC 6935 [20]. + +6. The support for IETF RFC 8200 [4] and consequently the support for UDP zero checksum may be restricted to 5G UP functions only in order to avoid signalling protocol changes to EUTRA and EPC entities. + +The interfaces carrying GTP-U traffic may be protected by NDS / Physical security and hence any packet corruption can be detected. Also the use of UDP zero checksum for GTP-U is controlled by operator policy and the operators can enable it, e.g. if it is known that packet corruptions between the two GTP-U entities are not possible. Correspondingly it is not required to address the requirements specified in clause 5 of IETF RFC 6936 [21] natively in GTP-U when UDP zero checksum over IPv6 is used. If NDS / Physical security is not used for the interfaces carrying GTP-U traffic and packet corruptions may occur, then the use of UDP zero checksum over IPv6 should not be enabled in the operator policy. + +##### 6.1.3.2.2 Identified Impacts + +The following are the impacts identified due to the solution proposed in clause 6.1.3.2.1. + +- Potential addition of a UDP Zero Checksum for IPv6 support bit in UP Function Features IE of TS 29.244 [9]. +- Addition of a "UDP Zero Checksum for IPv6 IE" in PFCP Session Establishment Request and PFCP Session Modification Request messages of TS 29.244 [9]. +- Addition of UDP Zero Checksum for IPv6 IE in N2 SM information exchanged between SMF and 5G-AN. +- Addition of UDP Zero Checksum for IPv6 IE in Nsmf\_PDUSession\_Create / Update request and response over N16 (between V-SMF and H-SMF) and over N16a (between I-SMF and SMF). +- Addition of UDP Zero Checksum for IPv6 IE in Xn, F1 and E1 signalling messages to indicate the support of the corresponding UP function in the NG-RAN for the UDP zero checksum capability and its use as per operator policies. This will require liaising with RAN3. +- Changes to TS 29.281 [2] to add reference to IETF RFC 8200 [4] and to specify that periodic echo request should be done to check the aliveness of the path when sending UDP zero checksum over IPv6. + +### 6.1.4 System Impacts + +GTP-U is already supported in the 5G System. + +No impacts are identified, other than those listed in clause 6.1.3.2.2 for the optional support of UDP zero checksum for GTP-U over IPv6. + +## 6.2 Segment Routing IPv6 (SRv6) + +### 6.2.1 General SRv6 Description + +#### 6.2.1.1 General + +SRv6 is the IPv6 dataplane instantiation of Segment Routing, defined in IETF RFC 8402 [5]. Segment Routing is a network architecture based on source-routing. Thus confining flow states to the ingress nodes in the SR domain. + +The SRv6 dataplane consists on leveraging the IPv6 extension headers, defined in IETF RFC 8200 [4], to include in the IPv6 header a new routing extension header called "Segment Routing Header" (SRH), defined in IETF draft-ietf-6man-segment-routing-header-15 [6]. + +SRv6 has support for IPv4, IPv6, IPv4v6, Ethernet and Unstructured PDUs. + +#### 6.2.1.2 Packet Processing + +SRv6 encodes segments (SIDs) as IPv6 addresses in the Segment List of SRH. Source SR node of the SR domain creates SRH in the outer encapsulating IPv6 packet. Figure 6.2.1.2-1 shows SRH format, defined in IETF draft-ietf- + +6man-segment-routing-header-15 [6]. The Segment Left in the SRH points an index number of the Segment List that specifies the active segment. The IPv6 Destination Address (DA) is updated with the IPv6 address of the active segment so that the packet is routed to the node which has the active segment along the shortest path in the network. + +Once the packet has reached the node, called SR Segment Endpoint Node decrements Segment Left and updates IPv6 DA with the active segment indicated by the updated Segment Left. Then the node forwards the packet along the updated DA. When the packet reaches the last segment of the Segment List, which means Segment Left becomes zero, the node pops out the SRH and forward the packet along the last segment. + +The nodes between Source SR node and SR Endpoint Nodes, called Transit Nodes, neither inspect the SRH nor process it. Thus Transit Nodes only need to be IPv6 routing and forwarding capable. + +![](5793a44ffdadd039928e2f9fe6daae06_img.jpg) + +| Octets | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|------------------|-----------------------------------------------|---|---|---|---|---|---|---| +| 1 | Next Header | | | | | | | | +| 2 | Header Extension Length = n | | | | | | | | +| 3 | Routing Type = 0x04 | | | | | | | | +| 4 | Segment Left | | | | | | | | +| 5 | Last Entry = m | | | | | | | | +| 6 | Flags | | | | | | | | +| 7 | Tag (1 st Octet) | | | | | | | | +| 8 | Tag (2 nd Octet) | | | | | | | | +| p to (p+15) | Segment List [0] (128 bits IPv6 Address) | | | | | | | | +| ... | ... | | | | | | | | +| q to (q+15) | Segment List [m] (128 bits IPv6 Address) | | | | | | | | +| (q+16) to (8n+8) | Optional Type Length Value objects (variable) | | | | | | | | + +Figure 6.2.1.2-1: IPv6 Segment Routing Extension Header Format + +where: + +- Next Header: 8-bit selector. Identifies the type of header immediately following the Routing header, defined in IETF RFC 8200 [4]; +- Header Extension Length: 8-bit unsigned integer. Length of the Routing header in 8-octet units, not including the first 8 octets, defined in IETF RFC 8200 [4]; +- Routing Type: 8-bit identifier of a particular Routing header variant. 0x04 is suggested value for Segment Routing Header; +- Segments Left: 8-bit unsigned integer. Number of route segments remaining, i.e., number of explicitly listed intermediate nodes still to be visited before reaching the final destination, defined in IETF RFC 8200 [4]; +- Last Entry: contains the index (zero based), in the Segment List, of the last element of the Segment List; +- Flags: 8 bits of flags. Currently no flags are defined; +- Tag: tag a packet as part of a class or group of packets, e.g., packets sharing the same set of properties. When tag is not used at source it MUST be set to zero on transmission. When tag is not used during SRH Processing it SHOULD be ignored. Tag is not used when processing the SID as defined in Clause 4.3.1 of IETF draft-ietf-6man-segment-routing-header-18 [6], which means the Tag value will not be touched by intermediate routers in SRv6 Enhanced mode solution; +- Segment List[n]: 128 bit IPv6 addresses representing the nth segment in the Segment List. The Segment List is encoded starting from the last segment of the SR Policy. i.e., the first element of the segment list (Segment List [0]) contains the last segment of the SR Policy, the second element contains the penultimate segment of the SR Policy and so on; +- Type Length Value (TLV) objects are optional and are described in IETF draft-ietf-6man-segment-routing-header-15 [6]. + +#### 6.2.1.3 Network Programmability + +SRv6 introduces the concept of Network Programming. This implies that an SRv6 segment can be bound to any function/service in a router or compute instance. + +An SRv6 segment is an IPv6 address, which is divided into Locator:Function:Arguments. + +The Locator routes the packet up to a given node in the network. Once the packet has arrived to this node, the Function is executed. The function might or might not take additional arguments specific to that function. + +The 128 bit SRv6 SID consist of following components: + +- Locator: routed to the node performing the function; +- Function: any possible function, either local to Network Processing Unit (NPU) or applications in Virtual Machine (VM)/Container; +- Arguments: optional argument bits to be used only by that SID. + +![Diagram of SRv6 SID Structure showing a stack of segments. A curved arrow on the left points from the top segment down to the bottom segment, indicating the order of processing. The segments are labeled 'Segments Left', 'Locator 1 Function 1', 'Locator 2 Function 2', and 'Locator 3 Function 3'.](19a59d6b53059ebd27b13c98793f88e0_img.jpg) + +| | | +|---------------|------------| +| Segments Left | | +| Locator 1 | Function 1 | +| Locator 2 | Function 2 | +| Locator 3 | Function 3 | + +Diagram of SRv6 SID Structure showing a stack of segments. A curved arrow on the left points from the top segment down to the bottom segment, indicating the order of processing. The segments are labeled 'Segments Left', 'Locator 1 Function 1', 'Locator 2 Function 2', and 'Locator 3 Function 3'. + +**Figure 6.2.1.3-1: SRv6 SID Structure** + +*Editor's Note: How Network Programmability applies for 5GS is FFS.* + +### 6.2.2 Description of SRv6 solution in 5GC + +#### 6.2.2.1 General + +This clause studies SRv6 for User Plane in 3GPP 5GC. + +It requires UPFs in 5GC to support SRv6. + +#### 6.2.2.2 Principles + +To derive the principle for SRv6 User Plane in 5GC, the following considerations apply: + +- As 128-bits IPv6 address and the capability to accumulate it in SRH, all information user plane needs could only use IPv6 header, or IPv6 with SRH. It enables IP layer only user plane (i.e, w/o UDP/GTP-U); +- The UP function follows the forwarding model defined in TS 23.214 [24]; +- The SMF controls each UPF for the user plane path per PDU Session. + +The following principles are proposed: + +- 1) No additional header other than IPv6 (Traditional mode), or IPv6 with SRH (Enhanced mode) to encapsulate all type of PDU session packet and user plane messages required to N9 interface (Traditional and Enhanced modes). +- 2) A SID of Locator:Function (see clause 6.2.1.3) shall consist of a IPv6 prefix assigned to user plane IP resource of UPF, and the Argument shall encode the identifiers of tunnel and QoS. (e.g; TEID, QFI and RQI) + +In 5GC, there is only one function defined as the UP function which all instructions shall be configured through N4. + +- 3) UPF shall lookup N4 session based on active SID as the destination address in the IPv6 header of receiving user plane packet. +- 4) SMF or UPF shall allocate a SID which enables UPF to be able to lookup the corresponding N4 session for each uplink and/or downlink. +- 5) N4 interface shall enable SMF to configure incoming and outgoing SID for a N4 session in each N9 UPF. +- 6) N4 interface shall enable UPF to notify SRv6 User Plane capability to SMF. +- 7) UPF shall be allowed to encapsulate T-PDU without SRH (i.e; Traditional mode). +- 8) UPF shall be allowed to add SIDs mapping to corresponding Network Instance into a SRH to encapsulate T-PDU (i.e; Enhanced mode). +- 9) N16/N16a/N38 interfaces shall enable V-SMF, H-SMF, I-SMF and SMF to negotiate the use of SRv6 and notify the capability of SRv6 in N9 with a SID for each corresponding PDU session. + +#### 6.2.2.3 SRv6 SID Encoding + +##### 6.2.2.3.1 General + +In 5GC, SRv6 128-bits SID encoding shall follow the principle 2. This clause discusses what SID encoding looks like for user plane in 3GPP 5G System. + +##### 6.2.2.3.2 Discussion + +SRv6 takes SID in the format of "Locator:Function:Argument" in IPv6 address as described in clause 6.2.1.3. In 5GC architecture, one UP Function has been defined while multiple user plane IP resources will be available on a UPF. To follow the 5GC architecture, the Locator:Function part can turn out to be IPv6 prefix assigned to user plane IP resource of UPF. + +The Argument bits consist of TEID, QFI and RQI bits. These bits help UPF to lookup N4 session by the active SID as the destination IP address in the IPv6 header of the receiving user plane packet. + +The argument of which those bits embedded (TEID/QFI/RQI) requires at least 39-bits in total. + +Figure 6.2.2.3.2-1 illustrates an example of SRv6 SID encoding. An IPv6 Prefix of the user plane IP resource consists of the IPv6 Prefix allocated to the UPF and some bits allocated to the IP resource. For example, an UPF allocated a prefix of 2001:db8::/32 assigns 0x39bb from 16-bits space from the user plane IP resources, 2001:db8:39:bb::/48 shall be the prefix for the IP resource. + +The length of the IPv6 Prefix for the user plane IP resource shall be shorter than (128-39) bits. And the argument may be required that would be placed right after the IP resource prefix. In case that the total length of the all IPv6 Prefix and the argument shorter than 128 bits, the SID shall be right padded. + +![Diagram illustrating the SRv6 SID Encoding for 5GC. The diagram shows a 128-bit IPv6 address structure. The top part shows the 'IPv6 Prefix allocated to UPF' and 'UP IP Resource bits'. The bottom part shows the 'IPv6 Prefix of user plane IP resource', 'TEID/QFI/RQI', and '0'. The total length is 128 bits, with the argument bits being at least 39 bits.](6a555cff11e140861ce08db72b01a6a2_img.jpg) + +| | | | +|---------------------------------------|--------------|---------------------| +| IPv6 Prefix allocated to UPF | | UP IP Resource bits | +| 0 | | >= 39 bits | +| IPv6 Prefix of user plane IP resource | TEID/QFI/RQI | 127 | +| | | 0 | + +Diagram illustrating the SRv6 SID Encoding for 5GC. The diagram shows a 128-bit IPv6 address structure. The top part shows the 'IPv6 Prefix allocated to UPF' and 'UP IP Resource bits'. The bottom part shows the 'IPv6 Prefix of user plane IP resource', 'TEID/QFI/RQI', and '0'. The total length is 128 bits, with the argument bits being at least 39 bits. + +Figure 6.2.2.3.2-1: An example of SRv6 SID Encoding for 5GC + +Editor's Note: More detail SID encoding for 5GC is FFS. + +Editor's Note: The argument is encoded in a limited number of bits. Future extensibility to support more UP features in future release is FFS. + +#### 6.2.2.4 User Plane packet flow + +##### 6.2.2.4.1 SRv6 in Traditional Mode + +SRv6 in traditional mode for 3GPP System works with a hop by hop model over N9 as follows: + +- UPFs over N9 are SRv6 capable; +- when sending a packet on one N9 hop, the UPF creates one single SID in the destination address of the outer IPv6 header, that is set to the IP address of the next UPF and the SID identifying the PDU N4 session at the next UPF, and forwards the packet. No SRH header is included to encapsulate T-PDU; +- the UPF receiving the packet on the N9 hop identifies the PDU N4 session using the SID received in the Destination Address; +- packet processing functions in each UPF are controlled by the SMF provisioning packet processing rules (PDR/FAR/QER/URR) to the UPF over N4, using existing PFCP protocol; +- for End Marker and Error Indications the SRH header will contain a single segment that is the DA. + +The Figure 6.2.2.4.1-1 shows how SRv6 in traditional mode could be used as user plane protocol over N9 with the current 5G System Architecture. + +![Diagram illustrating the uplink packet flow in SRv6 Traditional Mode. The flow starts from a UE, goes through a gNB (G) over the N3 interface, then through UPF1 (U1) over the N9 interface, and finally through UPF2 (U2) over the N6 interface to the Data Network. The diagram shows the encapsulation of the PDU at each stage. At the gNB, the PDU is encapsulated with a GTP-U header (TEID) and a UDP header (SP: 0-65535; DP: 2152). At UPF1, the GTP-U header is removed, and the PDU is encapsulated with an outer IPv6 header (SA = G::, DA = U1::). At UPF2, the outer IPv6 header is processed, and the PDU is encapsulated with a new outer IPv6 header (SA = U1::, DA = U2:2:TEID). The final PDU is then forwarded to the Data Network.](dd380ccd5aca1151074fede04826f1a4_img.jpg) + +The diagram shows the uplink packet flow in SRv6 Traditional Mode. The flow starts from a UE, goes through a gNB (G) over the N3 interface, then through UPF1 (U1) over the N9 interface, and finally through UPF2 (U2) over the N6 interface to the Data Network. The diagram shows the encapsulation of the PDU at each stage. At the gNB, the PDU is encapsulated with a GTP-U header (TEID) and a UDP header (SP: 0-65535; DP: 2152). At UPF1, the GTP-U header is removed, and the PDU is encapsulated with an outer IPv6 header (SA = G::, DA = U1::). At UPF2, the outer IPv6 header is processed, and the PDU is encapsulated with a new outer IPv6 header (SA = U1::, DA = U2:2:TEID). The final PDU is then forwarded to the Data Network. + +Diagram illustrating the uplink packet flow in SRv6 Traditional Mode. The flow starts from a UE, goes through a gNB (G) over the N3 interface, then through UPF1 (U1) over the N9 interface, and finally through UPF2 (U2) over the N6 interface to the Data Network. The diagram shows the encapsulation of the PDU at each stage. At the gNB, the PDU is encapsulated with a GTP-U header (TEID) and a UDP header (SP: 0-65535; DP: 2152). At UPF1, the GTP-U header is removed, and the PDU is encapsulated with an outer IPv6 header (SA = G::, DA = U1::). At UPF2, the outer IPv6 header is processed, and the PDU is encapsulated with a new outer IPv6 header (SA = U1::, DA = U2:2:TEID). The final PDU is then forwarded to the Data Network. + +Figure 6.2.2.4.1-1: Uplink packet flow in SRv6 Traditional Mode + +NOTE 1: UPF2 in the figure is PSA and UPF1 is I-UPF. + +The PDU arrives from the gNB in GTP-U encapsulation at UPF1. The UPF1 removes the GTP-U header and encapsulates the PDU with an outer IPv6 header and then send out the packet to UPF2, based on the rules (PDR/FAR) associated to the corresponding N4 session provisioned by the SMF in UPF1 over N4. The IPv6 Source address will be set to the U1 of UPF1 address and the IPv6 Destination Address will be set to the U2 of UPF2. + +The IPv6 Flow Label is computed as per IETF RFC 6437 [13]. + +All the PDU session types defined by TS 23.501 [7] are supported, since the original packet is encapsulated with a new IPv6 header. + +Once the packet arrives at U2, the UP functions (e.g. packet forwarding) are executed by UPF2, based on the rules (PDR/FAR/QER/URR) associated to the corresponding N4 session provisioned by the SMF in UPF2 over N4. As UPF2 behaves as PSA, the PDU is decapsulated and forwarded over the N6 interface. + +Note that the downlink packet flow is the similar, except for a simple reversal of the source for the destination IP addresses. This is shown in the Figure 6.2.2.4.1-2. + +![Diagram of Downlink Packet Flow in the SRv6 Traditional Mode. The diagram shows a UE connected to a gNB (G), which is connected to UPF1 (U1) via the N3 interface. UPF1 is connected to UPF2 (U2) via the N9 interface. UPF2 is connected to a Data Network via the N6 interface. A large blue arrow at the bottom indicates the downlink flow from the Data Network to the UE. Below the gNB, UPF1, and UPF2, there are representations of Protocol Data Units (PDUs). The PDU at the gNB shows an IPv6 header with SA = U1::, DA = G::, a UDP header with SP: 0-65535; DP: 2152, and a GTP header with TEID. The PDU at UPF1 shows an IPv6 header with SA = U2::, DA = U1:2:TEID. The PDU at UPF2 shows a standard IPv6 header. The PDU at the Data Network is a standard IPv6 header.](90ddb84c323b956e2d50a54d3f870566_img.jpg) + +Diagram of Downlink Packet Flow in the SRv6 Traditional Mode. The diagram shows a UE connected to a gNB (G), which is connected to UPF1 (U1) via the N3 interface. UPF1 is connected to UPF2 (U2) via the N9 interface. UPF2 is connected to a Data Network via the N6 interface. A large blue arrow at the bottom indicates the downlink flow from the Data Network to the UE. Below the gNB, UPF1, and UPF2, there are representations of Protocol Data Units (PDUs). The PDU at the gNB shows an IPv6 header with SA = U1::, DA = G::, a UDP header with SP: 0-65535; DP: 2152, and a GTP header with TEID. The PDU at UPF1 shows an IPv6 header with SA = U2::, DA = U1:2:TEID. The PDU at UPF2 shows a standard IPv6 header. The PDU at the Data Network is a standard IPv6 header. + +**Figure 6.2.2.4.1-2: Downlink Packet Flow in the SRv6 Traditional Mode** + +NOTE 2: UPF2 in the figure is PSA and UPF1 is I-UPF. + +##### 6.2.2.4.2 SRv6 in Enhanced mode + +SRv6 in enhanced mode works over N9 as follows: + +- UPFs over N9 are SRv6 capable; +- the N9 path may integrate transport slice of underlay network mapping to Network Instance based on local information; +- when sending a packet on N9, the UPF processes Network Instance that the packet created after FAR processing to insert one or multiple SIDs in a SRH between IPv6 header and to encapsulate T-PDU. Both packet processing are as following: + - a. During FAR processing, the IPv6 Destination Address is set as the next hop UPF address with the arguments part carrying the TEID. + - b. During Network Instance processing, the IPv6 Destination Address set by FAR is moved as the last SID in the SID list and the topmost SID in the list configured for the Network Instance is copied to the IPv6 Destination Address. + +What those SIDs represent is out of scope of 3GPP. The last SID contains the IPv6 address of the next UPF and the TEID encoded as argument identifying the PDU N4 session at the next UPF; + +- the UPF receiving the packet on the N9 hop identifies the PDU N4 session using the IPv6 address received in the Destination Address. +- as same as Traditional mode, packet processing functions in each UPF are controlled by the SMF provisioning packet processing rules (PDR/FAR/QER/URR) to the UPF over N4, using existing PFCP protocol. +- For End Marker and Error Indications an additional outer SRH header with the SIDs will be added by UPF after the processing by network instance. + +###### 6.2.2.4.2.1 Uplink + +The Figure 6.2.2.4.2.1-1 shows how SRv6 in Enhanced mode can be used as a user plane protocol over N9 uplink in the current 5G System Architecture with an end-to-end transport network slice (and an associated ultra-low-latency SLA). + +![Diagram of Uplink Packet flow using SRv6 Enhanced Mode. The diagram shows a UE connected to a gNB, which is connected to UPF U1 (UL CL, Branching point). UPF U1 is connected to node C1, which is connected to I-UPF U2 (Intra/Inter-RAT anchor). I-UPF U2 is connected to node C2, which is connected to UPF U3 (A-UPF, PSA: PDU Session Anchor). UPF U3 is connected to the Data Network. The diagram illustrates the packet flow from the UE to the Data Network, showing the encapsulation and decapsulation of PDUs at each node. The packet flow is indicated by a blue arrow at the bottom. The diagram also shows the headers added to the PDUs at each node: at the gNB, the PDU is encapsulated with an IPv6 header (SA = G::, DA = U1::), a UDP header (SP: 0-65535; DP: 2152), and a GTP header (TEID); at UPF U1, the PDU is encapsulated with an IPv6 header (SA = U1::, DA = C1:1::) and an SRH header (U:2:TEID, C1:1::) SL=1; at node C1, the PDU is encapsulated with an IPv6 header (SA = U1::, DA = U:2:TEID); at I-UPF U2, the PDU is encapsulated with an IPv6 header (SA = U2::, DA = C2:1::) and an SRH header (U:3:TEID, C2:1::) SL=1; at node C2, the PDU is encapsulated with an IPv6 header (SA = U2::, DA = U:3:TEID); and at UPF U3, the PDU is decapsulated and forwarded to the Data Network.](2ae3eae1bd80a90f192f568ae246a9a6_img.jpg) + +Diagram of Uplink Packet flow using SRv6 Enhanced Mode. The diagram shows a UE connected to a gNB, which is connected to UPF U1 (UL CL, Branching point). UPF U1 is connected to node C1, which is connected to I-UPF U2 (Intra/Inter-RAT anchor). I-UPF U2 is connected to node C2, which is connected to UPF U3 (A-UPF, PSA: PDU Session Anchor). UPF U3 is connected to the Data Network. The diagram illustrates the packet flow from the UE to the Data Network, showing the encapsulation and decapsulation of PDUs at each node. The packet flow is indicated by a blue arrow at the bottom. The diagram also shows the headers added to the PDUs at each node: at the gNB, the PDU is encapsulated with an IPv6 header (SA = G::, DA = U1::), a UDP header (SP: 0-65535; DP: 2152), and a GTP header (TEID); at UPF U1, the PDU is encapsulated with an IPv6 header (SA = U1::, DA = C1:1::) and an SRH header (U:2:TEID, C1:1::) SL=1; at node C1, the PDU is encapsulated with an IPv6 header (SA = U1::, DA = U:2:TEID); at I-UPF U2, the PDU is encapsulated with an IPv6 header (SA = U2::, DA = C2:1::) and an SRH header (U:3:TEID, C2:1::) SL=1; at node C2, the PDU is encapsulated with an IPv6 header (SA = U2::, DA = U:3:TEID); and at UPF U3, the PDU is decapsulated and forwarded to the Data Network. + +**Figure 6.2.2.4.2.1-1: Uplink Packet flow using SRv6 Enhanced Mode** + +Note: C1 and C2 in the diagram are non-3GPP functions/entities. + +The PDU arrives from the UE. The gNB encapsulates the PDU, adding an IPv6, UDP and GTP-U headers. The packet is destined towards the UPF U1. + +Upon packet arrival, the UPF U1 processes the packet, removing the IPv6, UDP and GTP headers and it will then re-encapsulate it with an outer IPv6 header based on the rules (PDR/FAR) with an SRH mapping to the Network Instance in the rules associated to the corresponding N4 session provisioned by the SMF in UPF1 over N4. + +The SRH contains the set of SIDs mapping to the provisioned Network Instance in the FAR based on local information. The last SID in the SRH shall be the SID identifying the N4 session at the next UPF, I-UPF U2. + +The IPv6 Source address will be set to the UPF U1 IP address. The IPv6 Destination Address will be set to the first SRv6 segment. The IPv6 Flow Label is computed as per IETF RFC 6437 [13]. + +One simple transport slice example here is used as an example to explain the packet flow. The packet leaves the UPF1 and is forwarded on the N9 interface up to the node C1. Once the packet arrives to C1, the function 1 is going to be executed, which is fundamental SRv6 endpoint function described in clause 6.2.1.2. The IPv6 Destination Address is updated to the next segment, U:2:TEID, the last SID in the SRH. The SRH Segment Left value is decremented, and since now the value is at zero the router pops the SRH. + +The packet is forwarded through the intended path up to the next segment U:2:TEID, which identifies the N4 session on the I-UPF U2. Once the packet arrives at U2, the UP functions are executed by U2, based on the rules (PDR/FAR/QER/URR) associated to the corresponding N4 session provisioned by the SMF in U2 over N4. Note that the I-UPF behaves as an *Intra/Inter-RAT anchor point*. + +The I-UPF U2, after packet processing based on the provisioned rules, will insert again an SRH that will contain the set of SIDs mapping to the provisioned Network Instance in the FAR based on local information. The last SID in the SRH shall be the SID identifying the N4 session at the next UPF, A-UPF U3. + +The IPv6 Source address will be set to the UPF U2 IP address. The IPv6 Destination Address will be set to the first SRv6 segment, C2 in this example. The IPv6 Flow Label is computed as per IETF RFC 6437 [13]. + +Packet is forwarded up to the node C2. Again, this node executes the function 1 which belongs to the endpoint function. The IPv6 Destination Address is updated with the next segment (U:3:TEID), the last SID in the SRH. The node pops the SRH out since the decremented Segment Left in the SRH becomes zero. + +Packet is forwarded through the intended path up to the next segment U:3:TEID, which identifies the N4 session on the UPF U3 (PSA). Once the packet arrives at U3, the UP functions are executed by U3, based on the rules (PDR/FAR/QER/URR) associated to the corresponding N4 provisioned by the SMF in U3 over N4. As the UPF U3 behaves as a PSA, the PDU is decapsulated and forwarded over the N6 interface. + +The Network Instance process of UPF will validate the intended path encoded in the SRH. IETF draft-ietf-spring-segment-routing-policy-02 [30] specifies the validation for segment routing policy of the intended path and packet steering to the path. By that, the Network Instance process of UPF should declare the intended path when the reachability for all SIDs in the path can't be resolved with the means of routing mechanisms in the SRv6 transport. + +###### 6.2.2.4.2.2 Downlink + +The downlink packet flow is depicted in the Figure 6.2.2.4.2.2-1. + +![Diagram of Downlink Packet Flow in SRv6 Enhanced Mode. It shows a path from a Data Network through UPF U3 (PSA), then through intermediate nodes C2, I-UPF U2, C1, and finally UPF U1 to a gNB and UE. Packet headers (IPv6, SRH, UDP, GTP) are shown at various points along the path, illustrating encapsulation and decapsulation steps.](759c7d62402f0b4651ddce292be5bdef_img.jpg) + +The diagram illustrates the downlink packet flow in SRv6 Enhanced Mode. The path starts from the Data Network, passing through UPF U3 (PSA: PDU Session Anchor), then through intermediate nodes C2 and C1, and I-UPF U2 (Intra/Inter-RAT anchor), and finally UPF U1. The packet is then forwarded to the gNB and UE via the N3 interface. The packet headers are shown at various points along the path, illustrating encapsulation and decapsulation steps. For example, at UPF U3, the packet is encapsulated with an outer IPv6 header (SA=U3::, DA=C2::) and an SRH. At C2, the SRH is processed. At I-UPF U2, a new SRH is added. At C1, the SRH is processed again. Finally, at UPF U1, the packet is decapsulated and forwarded to the gNB and UE. + +Diagram of Downlink Packet Flow in SRv6 Enhanced Mode. It shows a path from a Data Network through UPF U3 (PSA), then through intermediate nodes C2, I-UPF U2, C1, and finally UPF U1 to a gNB and UE. Packet headers (IPv6, SRH, UDP, GTP) are shown at various points along the path, illustrating encapsulation and decapsulation steps. + +Figure 6.2.2.4.2.2-1: Downlink Packet Flow in SRv6 Enhanced Mode + +NOTE: C1 and C2 in the diagram are non-3GPP functions/entities. + +In this case the UPF U3 (PSA), upon packet reception, classifies and encapsulates the incoming packets with an outer IPv6 header based on the rule (PDR/FAR) with a SRH mapping to the Network Instance in the rules associated to the corresponding N4 session provisioned by the SMF. The SRH contains the set of SIDs mapping to the provisioned Network Instance in the FAR based on local information. This last SID identifies the N4 session on the I-UPF. + +Nodes C1 and C2 process the packet based on the SRH as same as the uplink case. + +Upon packet reception, the I-UPF imposes a new SRH containing the SIDs up to the next UPF, U1. Upon packet reception, U1 processes the packet and forwards it over the N3 interface. + +As the N3 interface is unmodified (IPv6/GTP), the packet is IPv6, UDP, GTP. + +##### 6.2.2.4.3 Hand-over + +In mobility scenarios with a change of I-UPF, the PSA shall send one or more End-Marker packet towards the old I-UPF upon switching the user plane path. This End-Marker is configured through the Tag field in SRH (as explained in clause 6.2.1.2). The Figure 6.2.2.4.3-1 shows the hand-over packet flow. + +![Diagram of HO illustration using SRv6. It shows two scenarios: 1) Initial state where traffic from two UEs (G1, G2) is routed through I-UPF U1 to UPF U3 (PSA). 2) After handover, traffic is rerouted through I-UPF U2 to UPF U3 (PSA). End-marker packets are shown being sent from UPF U3 to the old I-UPF U1 during the transition.](9a159e2112eac7be06bdb97e84a0c49a_img.jpg) + +The diagram illustrates the hand-over process using SRv6. It is divided into two parts: 1) Initial state where traffic from two UEs (G1, G2) is routed through gNB (G1) and gNB (G2) to I-UPF U1, then through C2 to UPF U3 (PSA). 2) After handover, traffic is rerouted through I-UPF U2 to UPF U3 (PSA). End-marker packets are shown being sent from UPF U3 to the old I-UPF U1 during the transition. The packet headers are shown at various points along the path, illustrating the changes in the SRH and GTP headers during the handover. For example, in scenario 1, the End-Marker packet from UPF U3 has IPv6 Hdr (SA=U3::, DA=C2::) and SR Hdr ((U:1:TEID, C2:1::);SL=1; O=1). In scenario 2, the PDU packet from UPF U3 has IPv6 Hdr (SA=U3::, DA=C2::) and SR Hdr ((U:2:TEID, C2:1::);SL=1). + +Diagram of HO illustration using SRv6. It shows two scenarios: 1) Initial state where traffic from two UEs (G1, G2) is routed through I-UPF U1 to UPF U3 (PSA). 2) After handover, traffic is rerouted through I-UPF U2 to UPF U3 (PSA). End-marker packets are shown being sent from UPF U3 to the old I-UPF U1 during the transition. + +Figure 6.2.2.4.3-1: HO illustration using SRv6 + +Subsequent traffic is sent to the new I-UPF. This is done by simply updating the SR segment list on the PSA to match the new I-UPF location. This traffic does not have the End Marker bit set in the Segment Routing Header. + +The End-Marker based mobility procedure is unmodified. + +#### 6.2.2.5 Discovery of SRv6 supported UPF + +##### 6.2.2.5.1 General + +The SMF needs to discover the UPF which supports SRv6 before selecting the right UPF for handling SRv6 based user plane traffic. SMF can use following methods to discover the SRv6 supported UPF. + +##### 6.2.2.5.2 Use PFCP protocol at N4 to pass SRv6 Capability + +The PFCP protocol used at N4 interface can be extended to allow SMF to learn the UPF capability. Adding the SRv6 capability information in "UP function feature", clause 8.2.25 of 3GPP 29.244 [9], to indicate node level SRv6 capability and "User Plane IP Resource Information" IE, clause 8.8.82 of 3GPP 29.244 [9], to indicate interface level capability, can be used to allow SMF to learn SRv6 capability during PFCP Association Request procedure. The diagram below shows the details. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 43 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 6 | Supported-Features | | | | | | | | +| 7 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 6.2.2.5.2-1: UP Function Feature** + +The spare bits of Supported features (Octet 5 to 6) can be used to indicate SRv6. + +| Octets | Bits | | | | | | | | +|-------------|------------------------------------------------------------|---------|---------|--------|------------------|---|----|----| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 116 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | ASSO SI | ASSO NI | TEIDRI | | | V6 | V4 | +| 6 | TEID Range | | | | | | | | +| m to (m+3) | IPv4 address | | | | | | | | +| p to (p+15) | IPv6 address | | | | | | | | +| k to l | Network Instance | | | | | | | | +| r | Spare | | | | Source Interface | | | | +| s to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 6.2.2.5.2-2: User plane IP Resource Information** + +The spare bit of octet 5 can be used to indicate if UPF supports SRv6 or not. The default value 0 indicates UPF does not support SRv6 and value 1 indicates that UPF does support SRv6. + +##### 6.2.2.5.3 Use Local Configuration at SMF + +SMF may be locally configured with the information about UPF, e.g by OAM system, when a new UPF instantiated or removed. Clause 6.3.3.2 of TS 23.501 [7] mentions about UPF provisioning in SMF. + +##### 6.2.2.5.4 Discovery of UPF using NRF + +In the 5GC SBA architecture, the NRF acts as NF repository where every NF register or deregister itself. A consumer NF uses NRF Discovery Service before selecting a producer NF as mentioned in clause 5.2.7 of TS 23.502 [8]. The UPF function may indicate SRv6 capability in the NF Profile while registering with NRF. The attribute UpfInfo, clause 6.1.6.2.13 of TS 29.510 [25] can be extended to indicate SRv6 capability of UPF. SMF can then use the NRF Discovery service to know if the UPF supports SRv6 or not. This method can be used by SMF to choose UPF during PDU session creation. + +#### 6.2.2.6 IPv4 Transport Support for SRv6 User Plane + +##### 6.2.2.6.1 General + +As the architectural requirements states that the User Plane protocol shall be able to run over IPv4 and IPv6, described in clause 5.1.1. Since a SRv6 User Plane packet is an IPv6 packet with a SRH, this clause studies whether it is possible or not that SRv6 User Plane is able to run over IPv4 transport networks. + +##### 6.2.2.6.2 IPv4 Encapsulation and Decapsulation for IPv6 packet + +IPv6 in IPv4 encapsulation and forwarding manipulations (e.g., handling packet markings, checksum verification, etc.) is performed as specified in Clause 3.5 of "Basic Transition Mechanisms for IPv6 Hosts and Routers" in IETF RFC 4213 [26]. ICMPv4 errors are handled as specified in Clause 3.4 of IETF RFC 4213 [26]. By default, the IPv6 Traffic Class field MUST be copied to the IPv4 ToS (Type of Service) field. This default behavior may be overridden by configuration. Since IPv4 node shall not be expected as SRv6 node, there is no impact of SRH to that specified IPv6 over IPv4 encapsulation. + +##### 6.2.2.6.3 Routing IPv6 packet over IPv4 Transport Network + +An efficient solution for IPv6 encapsulated packets is to be routed based on the destination IPv6 address as standardized in IETF RFC 5969 [27]. + +##### 6.2.2.6.4 Mapping SRv6 User Plane IP Resource to IPv4 Transport + +As the study result in this clause, SRv6 is able to run over IPv4 transport networks. It is expected that Network Instance can be used to mapping to IPv4 Transport based on local information. How that mapping depends on local information is out of scope of 3GPP. + +#### 6.2.2.7 Security Considerations for SRv6 + +The security consideration related to SRv6 is detailed in IETF draft-ietf-6man-segment-routing-header-18 [6]. The security mechanisms described in that document only allow securing an SRv6 network within a single domain. 5GC requires security mechanisms for nodes communicating in different domains (e.g. inter-PLMN). + +In order to secure inter-domain scenarios, 3GPP extends the security requirements defined by IETF as follows: + +In the enhanced mode, for SR nodes outside of the domain HMAC can be used. Alternatively, if anti-replay protection is required, IPSec with AH can be used as a substitute of HMAC. In the traditional mode, IPSec with AH can be used. + +**Editor's Note: All the SRv6 security considerations needs to be reviewed and assessed by SA3 Group.** + +#### 6.2.2.8 Using SRH for User Plane Messages + +##### 6.2.2.8.1 General + +The Figure 6.2.1.2-1 shows the Segment Routing Header format. In the SR Extension Header there is 16 bits Tag field, which is explained in IETF draft-ietf-6man-segment-routing-header-18 [6]. IETF does not define the format or use of the Tag field. Hence the format of Tag field can be defined by 3GPP independently of IETF and only the UPF will process the Tag field in the SR Header. Tag can be used to indicate user plane messages, Echo Request, Echo Reply, End Marker and Error Indication. Any other transport router that implements SRv6 must ignore this field upon SRH processing. + +Upon presence of user plane messages, the UPF cannot encode any segment in the SRH whose function modifies the Tag value. + +##### 6.2.2.8.2 Tag Encoding + +The Tags field can be encoded as described in Figure 6.2.2.8.2-1. + +| Bit 4 of Octet [1] to Bit 7 of Octet [1] are Reserved | Bit 3 [Octet-1] Echo Reply Bit | Bit 2 [Octet-1] Echo Request Bit | Bit 1 [Octet-1] Error Indicator Bit | Bit 0 [Octet1] End Marker bit | +|-------------------------------------------------------|------------------------------------------------------------------------------------------|----------------------------------|-------------------------------------|-------------------------------| +| Octet[2] of Tag is reserved | | | | | +| Bit 0 | End Marker Bit. When set to 1, this indicates End Marker. Default value is set to 0 | | | | +| Bit 1 | Error Indicator Bit. When set to 1, this indicates Error. Default value is set to 0. | | | | +| Bit 2 | Echo Request Bit. When set to 1, this indicates Echo Request. Default value is set to 0. | | | | +| Bit 3 | Echo Reply Bit. When set to 1, this indicates Echo Reply. Default value is set to 0. | | | | +| Bit 4- Bit15 | Reserved. | | | | + +**Figure 6.2.2.8.2-1 Tags Encoding Details** + +Additional information elements for Error Indication, e.g Tunnel Endpoint Identifier Data I, GSN Address etc, can be encoded in the SRH TLV as explained in clause 6.2.2.13. + +#### 6.2.2.9 Packet forwarding between SMF and UPF + +The PFCP-u tunnel, one PFCP tunnel per UPF or PDN, as explained in clause 5.3.4 of 3GPP TS 29.281 [2], shall be used between SMF and UPF. The T-PDU packet received at UPF from N9 or N6 shall be forwarded to SMF as G-PDUs with the GTP-U header set to the IP address and TEID uniquely assigned in the SMF for the PFCP-u tunnel corresponding to the UPF or PDN. Similarly, the G-PDU packets received from the UE on N3 interface shall be forwarded to the SMF on PFCP-u tunnel with new GTP-U header. + +Even when SRv6 is used for user plane forwarding for N9, the forwarding of data between SMF and UPF still uses GTP-U. UPF will always construct a G-PDU, as defined above, from T-PDU received on N3 or N6 or N9 interface. + +#### 6.2.2.10 Roaming Support + +As home-routed roaming procedure defined in TS 23.502 [8], the following are the impacts on SMF PDU Session Service of TS 29.502 [29] over N16 (between V-SMF and H-SMF) and over N16a (between I-SMF and SMF) identified due to the principle proposed in clause 6.2.2.2. + +- Addition of "SRv6 Capable IE" in Nsmf\_PDUSession Create Request / Response. +- Addition of "SRv6 SID IE" in Nsmf\_PDUSession Create Request / Response / Update. + +Based on roaming agreement, operators may configure the UPFs to use Traditional mode or Enhanced mode. The V-SMF and H-SMF do not need to distinguish both two modes over N16 due to the both modes are configured in UPF based on local information. + +Security consideration shall be applied for the SRv6 user plane in roaming as described in clause 6.2.2.7. + +#### 6.2.2.11 Failure Detection and Recovery + +##### 6.2.2.11.1 General + +This clause describes failure detection and recovery in SRv6 user plane as per clause 5 of TS 23.527 [11] defined. + +##### 6.2.2.11.2 Failure Detection + +###### 6.2.2.11.2.1 Loss of SRv6 SID contexts + +An SRv6 user plane enabled UPF may lose its SRv6 SID contexts upon a failure or restart. + +When an UPF receives a SRv6 User Plane packet for which no corresponding SID exists, the UPF shall discard the SRv6 User Plane packet and return an Error Indication encoded in SRH to the sending UPF, as specified in clause 6.2.2.8. + +The receipt of an Error Indication in SRH is an indication for the sending UPF that the peer UPF entity cannot receive any more user plane traffic on the corresponding SID. + +###### 6.2.2.11.2.2 User Plane Path Failure + +An UPF may detect a user plane path failure by using Echo Request and Echo Response encoded in SRH, as specified in clause 6.2.2.8. + +In addition to that, when a Network Instance detects user plane path failure as per IETF draft-ietf-spring-segment-routing-policy-02 [30], the UPF with the Network Instance is able to detect the user plane path failure. + +##### 6.2.2.11.3 Restoration Procedure + +###### 6.2.2.11.3.1 SRv6 Error Indication received by another UPF + +Upon receipt of an Error Indication in SRH, the UPF shall identify the related PFCP session and send an Error Indication Report to the SMF, as specified in clause 5.10 of 3GPP TS 29.244 [9]. + +Upon receipt of an Error Indication Report from the UPF, the SMF shall identify the PDU session for which the Error Indication is received using the remote SID included in the report. + +For an Error Indication received from another UPF, the SMF shall delete the PFCP session and PDU session, unless the UPF from which the Error Indication was received is controlled by the same SMF and the SMF is able to restore the user plane connectivity of the PDU session (e.g. Error Indication received from an Intermediate UPF controlled by the same SMF). + +NOTE: The procedure for Error Indication received from 5G-AN case is out of scope of this study. + +###### 6.2.2.11.3.2 Restoration Procedures upon User Plane Path Failure + +Upon detecting a SRv6 user plane path failure as specified in clause 6.2.2.11.2, the UPF shall report the user plane path failure to the SMF, by sending a PFCP Node Report Request (see TS 29.244 [9]) including a User Plane Path Failure Report with the SID of the remote SRv6 peer(s) towards which a failure has been detected. The UPF should also notify the SRv6 user plane path failure via the Operation and Maintenance system. + +The procedure of how the SMF processes the reported failure is described in clause 5.4 of TS 23.527 [11]. + +##### 6.2.2.11.4 Restoration Procedure for User Plane Related Entities + +The restoration procedure of UPF and SMF are all identical with the GTP-U case described in clause 4.3 and 4.4 of TS 23.527 [11] except the user plane protocol is SRv6. + +#### 6.2.2.12 SRv6 Guaranteed Packet Delivery + +##### 6.2.2.12.1 General + +There is a requirement for sending redundant transmission of user plane packets on N9 (and N3). SRv6 provides mechanisms for both packet duplication and dropping the duplicate packet. This mechanism shall be applied to either only the N9 interface, or to both the N3 and N9 interface when interworking with GTP-U. + +##### 6.2.2.12.2 Redundant packet transmission for downlink traffic + +At the source UPF, the traffic associated with the ultra-low latency, jitter, and loss requirement is steered into the new type of SR-TE (SRv6 Traffic Engineering) policy called Spray Policy. The Spray policy replicates the packets over SID lists that encode a disjoint path in the network. Typically, the packets are replicated over two disjoint SR paths, but replication over more than two paths is also possible. Each packet is tagged with a flow ID and a sequence number in the SRH TLV. + +The TLV has the format defined in IETF draft-geng-detnet-dp-sol-srv6 [28]. Clause 5.1 "TLV Based SRv6 Data Plane Solution" details the data replication function. + +**NOTE:** The intermediate SRv6 routers neither process nor inspect the TLV unless explicitly instantiated to do so. clause 2.1 of IETF draft-ietf-6man-segment-routing-header-18 [6] mentions "While processing the SID defined in clause 4.3.1, all the TLVs are ignored unless local configuration indicate otherwise" + +![Diagram of Redundant downlink packet transmission for URLLC use case showing packet flow from node B to node A via UPFs and gNB.](94acd33fcad85bb6f207a308f9b63191_img.jpg) + +The diagram depicts a network topology for redundant downlink packet transmission. The flow starts at node **B** (DA=A::, SA=B::) and moves left towards node **A**. At **UPF E3::**, the packet is replicated and sent via two paths: one through **UPF E1::** and another through **UPF E2::**. Both paths converge at **gNB G**, which then delivers the packet to node **A**. The diagram highlights the transition from SRv6 N9 interface (between UPFs) to GTP-U N3 interface (between UPFs and gNB). + +**Packet Header Stacks:** + +| | +|-----------------------------| +| IPv6 Hdr SA = B::, DA = A:: | +| Payload | + +| | +|---------------------------------| +| IPv6 Hdr SA = E3::, DA = E1::55 | +| SR Hdr ( E1::55 ) SL=1 | +| SR TLV Flow: YYYY Sequence: ZZ | +| IPv6 Hdr SA = B::, DA = A:: | +| Payload | + +| | +|---------------------------------| +| IPv6 Hdr SA = E3::, DA = E2::55 | +| SR Hdr ( E2::55 ) SL=1 | +| SR TLV Flow: YYYY Sequence: ZZ | +| IPv6 Hdr SA = B::, DA = A:: | +| Payload | + +| | +|------------------------------| +| IPv6 Hdr SA = E1::, DA = G:: | +| UDP PORT | +| GTP-U TEID | +| IPv6 Hdr SA = B::, DA = A:: | +| Payload | + +| | +|------------------------------| +| IPv6 Hdr SA = E2::, DA = G:: | +| UDP PORT | +| GTP-U TEID | +| IPv6 Hdr SA = B::, DA = A:: | +| Payload | + +Diagram of Redundant downlink packet transmission for URLLC use case showing packet flow from node B to node A via UPFs and gNB. + +**Figure 6.2.2.12.2-1: Redundant downlink packet transmission for URLLC use case** + +##### 6.2.2.12.3 Removal of Redundant packet for uplink traffic + +The endpoint of the Spray policy is represented by the last SID. At the endpoint, the UPF removes duplicate packet arriving with the same SRv6 SID. + +Upon reception of a packet with active SID bounded to a duplicate removal function, the node checks whether a packet with same (SA, FlowID, SeqNumber) has been delivered. In case another replica of this packet has indeed been delivered then the current packet is dropped. Otherwise, the packet is delivered and state is recorded. + +The TLV has the format defined in IETF draft-geng-detnet-dp-sol-srv6 [28]. Clause 5.1, 'TLV Based SRv6 Data Plane Solution', details the packet elimination function. + +![Diagram illustrating the removal of redundant packets for uplink traffic for URLLC case. It shows a path from UE A through gNB G, then branching to UPF E1 and UPF E2, and finally converging at UPF E3 before reaching UE B. Packet headers are shown at various points to illustrate the encapsulation and decapsulation process. The GTP-U N3 interface is between gNB G and UPFs, and the SRv6 N9 interface is between UPFs.](05eb72d372e4bf78e3d6a64949d77bcc_img.jpg) + +The diagram shows the flow of uplink traffic from UE A to UE B. At UE A, a packet with IPv6 header (SA=A, DA=B) is sent. It is encapsulated by gNB G into a GTP-U tunnel. The tunnel splits at UPF E1 and UPF E2. At UPF E1, the packet is decapsulated and then re-encapsulated with an SRv6 header (SA=E1, DA=E3) and an SRH (E3::55, SL=1). The same process happens at UPF E2. At UPF E3, the SRv6 packets from both E1 and E2 are decapsulated, and the original IPv6 packet (SA=A, DA=B) is sent to UE B. The diagram highlights the removal of redundant packets at the UPFs. + +Diagram illustrating the removal of redundant packets for uplink traffic for URLLC case. It shows a path from UE A through gNB G, then branching to UPF E1 and UPF E2, and finally converging at UPF E3 before reaching UE B. Packet headers are shown at various points to illustrate the encapsulation and decapsulation process. The GTP-U N3 interface is between gNB G and UPFs, and the SRv6 N9 interface is between UPFs. + +Figure 6.2.2.12.3-1: Removal of Redundant packets for uplink traffic for URLLC case + +#### 6.2.2.13 SRv6 extensibility using SRH TLVs + +The SRv6 SID carries TEID, QFI and RQI bits which is explained in clause 6.2.2.3. But SRv6 SID has limited space and it cannot carry many information elements which requires additional bits. + +For sending more information element, SRv6 shall leverage the SRH TLVs, as explained in clause 6.2.1.2. This document proposes a new SRH TLV that is the "5GS container", which should be allocated by IANA. This new 3GPP specific "Type" can contain additional 3GPP IEs in the nested TLVs within the "5GS container". The number of 3GPP IEs could be one or many, depending on the use case. The diagram below shows an example with only one additional 3GPP IE. + +| Type
[IANA defined] | Length | Value | | | +|------------------------|--------|--------------|--------|-------| +| | | 3GPP IE Type | Length | Value | + +Figure 6.2.2.13-1: Using TLV to send one 3GPP specific IEs in SRH + +The diagram below shows an example with multiple additional 3GPP IEs. + +| Type
[IANA defined] | Length | Value | | | | | | +|------------------------|--------|--------------|--------|-------|--------------|--------|-------| +| | | 3GPP IE Type | Length | Value | 3GPP IE Type | Length | Value | + +Figure 6.2.2.13-2: Using TLV for sending multiple 3GPP specific IEs in SRH + +The current list of objects of PDU Session User Plane Protocol, as defined in TS 38.415 [10], are supported as parts of Argument of SRv6 user plane, except PPI which is not applicable for N9. TLV of SRH is a generic format which can be used to encode all the current list of objects of PDU Session User Plane protocol as defined in TS 38.415 [10] and it also allows encoding of any new IEs that may get added in the future. + +TS 38.415 [10] specifies that PDU session information are encoded together in user plane protocol. But SRv6 solution does not comply with the PDU definition of this user plane protocol. In SRv6 solution some of the information elements like QFI, RQI etc are encoded in SID and remaining information elements are encoded in SRH TLV, which follows SID in the SRH. + +### 6.2.3 System Impacts + +#### 6.2.3.1 General + +This clause studies SRv6 impact on 3GPP 5GC system. + +#### 6.2.3.2 Common System Impacts of SRv6 + +See clauses 7.1.3.1.4 and 7.1.3.2.4. + +##### 6.2.3.2.1 System Impact on N4 interface + +###### 6.2.3.2.1.1 General + +This clause studies the impact on PFCP protocol on N4 interface for supporting SRv6. The PFCP procedures, messages and IEs along with the PFCP protocol is defined in TR 29.244 [9]. + +###### 6.2.3.2.1.2 Impact on PFCP procedure + +The existing PFCP protocol, used for N4 interface between SMF and UPF, may be extended in case SMF wants to send some SRv6 specific information to UPF and vice versa. The table below lists the possible changes in the existing PFCP messages. + +**Table 6.2.3.2.1.2-1: Impact on N4 Procedures** + +| PFCP Procedure | | Expected Impacts | +|-----------------------------------|-----------------------|-------------------------------------------------------------------------------------------------| +| Node related procedures | Heartbeat | N/A | +| | Load Control | N/A | +| | Overload Control | N/A | +| | PFD Management | N/A | +| | Association Setup | SMF needs to be indicated about SRv6 capability of UPF. | +| | Association Update | Same as Association Setup. | +| | Association Release | N/A | +| | Node Report | N/A | +| Session Related Procedures | Session Establishment | SMF needs to indicate UPF about SRv6 session for every PDU session that is getting established. | +| | Session Modification | Same as Session Establishment. | +| | Session Deletion | N/A | +| | Session Report | UPF needs to report SMF about Error Indication for SRv6 SID context and/or user plane path. | + +**Editor's Note:** Any additional impact on N4 procedure is FFS. + +###### 6.2.3.2.1.3 Impact on PFCP IEs + +It is expected that N4 interface protocol shall be able to bring SRv6 related information in the following PFCP IEs. Note that SRv6 leverages IPv6 addresses to represent segments so that the N4 interface protocol does not need to support any new ID type for SRv6 user plane in addition to the existing IPv4 and IPv6 ID format. + +**Table 6.2.3.2.1.3-1: SRv6 Impacts on PFCP IEs** + +| PFCP IE | | Expected Impacts | +|------------------------|----------------------|--------------------------------------------------------------------------------------| +| PDR related IEs | PDI | The Local F-TEID IE and Traffic End point needs changes to indicate SRv6 capability. | +| | Outer Header Removal | Outer Header Removal ID needs changes to indicate SRv6 capability | + +| | | | +|------------------------|-------------------------|----------------------------------------------------------------------------------------------------------| +| FAR related IEs | Forwarding Parameters | The Outer Header Creation IE and Linked Traffic Endpoint ID IE need changes to indicate SRv6 capability. | +| URR related IEs | | N/A | +| QER related IEs | | N/A | +| BAR related IEs | Error Indication Report | The Remote F-TEID IE needs changes to indicate error on SRv6 SID. | + +Editor's Note: Any additional impact on PFCP IEs is FFS. + +##### 6.2.3.2.2 System Impact on N16/N16a/N38 interfaces + +The following list shows the impacts for N16, N16a and N38. + +- N16: + - impacts V-SMF and H-SMF to negotiate the use of SRv6 during PDU session establishment, and during EPS to 5GS idle mode and connected mode mobility; +- N16a: + - impacts I-SMF and SMF to negotiate the use of SRv6 during PDU session establishment, or insertion of an I-SMF to an existing PDU session; +- N16a and N38: + - impacts V-SMF or I-SMF to include support of SRv6 in SM contexts exchange, and for setting up forwarding tunnels using SRv6 upon insertion or change of V-SMF or I-SMF. + +#### 6.2.3.3 System Impacts of Traditional Mode + +See clause 7.1.3.1.4. + +#### 6.2.3.4 System Impacts of Enhanced Mode + +See clause 7.1.3.2.4. + +# 7 Evaluations and Comparison + +## 7.1 Evaluation + +### 7.1.1 Evaluation Points + +The candidate user plane protocol solutions are evaluated in this clause on the following aspects: + +- 1) Whether they fulfil the architectural requirements for User Plane specified in clause 5.1; +- 2) Key issues identified in clause 5.2; +- 3) System impacts. + +### 7.1.2 GTP-U + +#### 7.1.2.1 General + +This clause evaluates the GTP-U solution described in clause 6.1. + +#### 7.1.2.2 Architectural requirements for User Plane + +GTP-U supports all the 3GPP architectural requirements specified in clause 5.1. GTP-U supports in particular the following capabilities: + +- GTP-U can run over IPv4 and IPv6 networks; +- the PFCP protocol over N4 supports the establishment, modification and release of GTP-U tunnels; +- GTP-U supports signalling messages, such as End Marker to assist packets reordering in the target RAN during mobility scenarios; +- GTP-U extension headers can be defined to convey information together with GTP-PDU; the PDU Session User Plane Protocol (defined in TS 38.413 [10] and containing 5GS information) is conveyed in such a GTP-U extension header; +- GTP-U is supported on roaming interface between VPLMN and HPLMN since Rel-99 onwards; +- GTP-U supports error detection and error reporting capabilities, to detect and handle the loss of a user plane context in a peer UPF and to detect and handle the loss of a user plane context associated with a user plane packet at the receiving UPF. + +#### 7.1.2.3 Key issues + +Regarding IP connectivity for N9 and Network Slicing, GTP-U can use existing transport technologies, such as L2 or L3 VPNs, MPLS-based services or segment routing (SR-MPLS, SRv6), as described in clause 5.2.1.1. + +#### 7.1.2.4 System impacts + +GTP-U is already supported in the RAN and Core Network, in the 5G System, EPS and GPRS networks. + +No impacts are identified, other than those listed in clause 6.1.3.2.2 for the optional support of UDP zero checksum for GTP-U over IPv6. + +### 7.1.3 SRv6 + +#### 7.1.3.1 Traditional Mode + +##### 7.1.3.1.1 General + +This clause evaluates the SRv6 Traditional Mode solution described in clause 6.2. + +##### 7.1.3.1.2 Architectural requirements for User Plane + +SRv6 in Traditional Mode supports the 3GPP architectural requirements specified in clause 5.1, with the following limitations as per the current solution: + +- 1) Requirement 8 of clause 5.1.1: the solution does not support the PDU Session User Plane Protocol over N9 as specified in Annex A of TS 29.281 [2] and in TS 38.415 [10]: + - the solution described in clause 6.2.2.3.2 does only enable to encode the RQI and QFI, which are only two specific parameters of the PDU Session User Plane Protocol; + - the PDU Session User Plane Protocol is a protocol that defines PDU types (e.g. UL PDU SESSION INFORMATION, DL PDU SESSION INFORMATION) and parameters; more PDU types and parameters may be defined in future. + +**Editor's Note:** a solution to support the above requirement is FFS. + +- 2) Requirement 10 of clause 5.1.1: for home routed roaming, security requirements and tentative 3GPP extensions to existing IETF security requirements for use of SRv6 across SR Domain (e.g. inter-PLMN) needs to be reviewed and assessed by SA3 (see clause 6.2.2.7). + +##### 7.1.3.1.3 Key issues + +Regarding IP connectivity for N9 and Network Slicing, SRv6 in Traditional Mode does not encode any SRH header and therefore has to rely on the IPv6 transport network technologies, or underlay transport technologies such as L2 or L3 VPNs, as described in clause 5.2.1.1. + +##### 7.1.3.1.4 System impacts + +The solution impacts the following 3GPP system entities: + +- UPF: + - N9 impacts to support SRv6 as a replacement of GTP-U, including support of T-PDUs (i.e. user data packets) and GTP-U functionality parity with End Markers, Error Indication, Echo Request/Response and Sequence Number; + - N4 impacts to support use of SRv6 as a replacement of GTP-U (i.e. advertising capabilities of the UPF and establishing N4 sessions using ingress and/or egress SRv6 as replacement of GTP-U); + - support of Interworking between GTP-U and SRv6 as a replacement of GTP-U, i.e. conversion between GTP-U packets and SRv6 packets including conversion between the GTP-U PDU Session Container extension header and the PDU Session Container information in SRv6 packets; + - support of static IPv4 tunnelling or 6rd over N9, if SRv6 is run over IPv6 over IPv4; +- SMF, V-SMF, H-SMF and I-SMF: + - N4 impacts to support use of SRv6 as a replacement of GTP-U (i.e. learn capabilities of the UPF and establish N4 sessions using ingress and/or egress SRv6 as replacement of GTP-U); + - N16 impacts for the V-SMF and H-SMF to negotiate the use of SRv6 as a replacement of GTP-U during the PDU session establishment and during EPS to 5GS idle mode and connected mode mobility; + - N16a impacts for the I-SMF and SMF to negotiate the use of SRv6 as a replacement of GTP-U during the PDU session establishment or during the insertion of an I-SMF to an existing PDU session; + - N4 impacts to support Interworking between GTP-U and SRv6 as a replacement of GTP-U; + - SMF impacts for SMF constructing End Marker packets (see clause 5.8.2.9.2 of TS 23.501 [7]), requiring the SMF to support SRv6 SRH; + - N38 (between two V-SMFs or two I-SMFs) and N16a (for insertion of an I-SMF to an existing PDU session) impacts for exchange of SM contexts including support of SRv6 as a replacement of GTP-U, and for setting up forwarding tunnels using SRv6 as a replacement of GTP-U upon insertion or change of V-SMF or I-SMF; + - Impacts for discovery and selection of UPFs supporting SRv6 as a replacement of GTP-U; +- NRF: + - Impacts to the NF Management and NF Discovery APIs to support the registration and discovery of SMF and UPF supporting SRv6 as a replacement of GTP-U; + - N27 impacts (between vNRF and hNRF) for discovering a H-SMF that supports SRv6 as a replacement of GTP-U; +- AMF: + - AMF impacts for discovering and selecting SMFs supporting SRv6 as a replacement of GTP-U when not all SMFs in the serving or home PLMN support SRv6, e.g. for preferentially selecting a V-SMF and a H-SMF supporting SRv6 as a replacement of GTP-U for a Home Routed PDU session. + +The solution requires impacts to the following interfaces (see above for the description of the impacts): + +- N9 (between UPFs and between V-UPF and H-UPF); + +- N4 (between SMF and UPF); +- N16 (between V-SMF and H-SMF); +- N16a (between I-SMF and SMF); +- N38 (between two V-SMF or I-SMF); +- Nnrf (between AMF, SMF, UPF and NRF); +- N27 (between V-NRF and H-NRF). + +**Editor's Note:** the complete list of impacts is still FFS until the solution is fully described. + +**Editor's Note:** Potential impacts to Lawful Interception should be assessed by 3GPP SA3-LI. + +#### 7.1.3.2 Enhanced Mode + +##### 7.1.3.2.1 General + +This clause evaluates the SRv6 Enhanced Mode solution described in clause 6.2. + +##### 7.1.3.2.2 Architectural requirements for User Plane + +SRv6 in Enhanced Mode supports the 3GPP architectural requirements specified in clause 5.1, with the following limitations as per the current solution: + +- 1) same limitations as defined for SRv6 in Traditional Mode in clause 7.1.3.1.2; +- 2) in roaming scenarios, SIDs in SRv6 packets may be limited to segments of one PLMN since information about the transport network topology from one PLMN is not exposed to a roaming partner. + +##### 7.1.3.2.3 Key issues + +Regarding IP connectivity for N9 and Network Slicing, SRv6 in Enhanced Mode would allow to encode SRH headers to force the data path to go through intermediate SRv6 routers between two UPFs. + +##### 7.1.3.2.4 System impacts + +All the impacts to the 3GPP system entities and interfaces described in clause 7.1.3.1.4 also apply to SRv6 Enhanced Mode. The following additional impacts also apply: + +- UPF: + - configuration of SIDs per Network Instance and insertion of SIDs in egress SRv6 packets; + - the IPv6 DA set by FAR needs to be moved as the last SID in the list and the topmost SID in the SID list configured for the network instance needs to be put as the IPv6 DA of the packet. + +**Editor's Note:** the complete list of impacts is still FFS until the solution is fully described. + +## 7.2 Additional Considerations + +### 7.2.1 Consideration Points + +Additional considerations for the candidate user plane protocol solutions are identified in Table 7.2-1. + +**Table 7.2.1-1: Additional Considerations** + +| Additional Considerations | Description | +|----------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| A1. Proven technology / Time of Availability of used standards | Proven technology and the date of availability of related standards will be indicated. | +| A2. Enabling separation between 3GPP User Plane and Transport |

Mobile and transport network operators may be different. Even when the same operator operates the mobile and transport networks, both networks may be managed by different organizations and systems.

This criterion evaluates whether the solution allows to keep the mobile and transport networks separate.

| +| A3. Transport network requirements | This criterion evaluates whether the solution imposes specific requirements on the transport networks. | +| A4. Co-existence with existing User Plane solution | This criterion evaluates the coexistence with network entities implementing the existing solution. | +| A5. Interworking with RAN | This criterion evaluates how the solution interworks with the RAN. | +| A6. Interworking with EPS | This criterion evaluates how the solution interworks with the EPS. | +| A7. Impacts to GSMA GRX/IPX | This criterion evaluates whether the solution may impact GRX/IPX. | +| A8. Security |

GSMA has specified user plane security solution for GTP-U in EPC (based on GTP-U firewall). GSMA and 3GPP SA3 are further studying GTP-U security in 5G System. See Study on Security Aspects of the 5G Service Based Architecture and Inter-PLMN Communication in S3-190464.

This criterion evaluates whether the solution may impact GSMA and require SA3 work for user plane security across roaming interfaces.

| +| A9. Minimize number of protocols in network |

It is desirable to minimize the number of protocols in the network, when possible.

This criterion evaluates the impact of the solution on the resulting number of protocols in the network.

| +| A10. Reusability of existing 3GPP implementations | This criterion evaluates whether the solution allows reuses of existing 3GPP implementations, e.g. reuse of UPF. | +| A11. Protocol Extensibility | This criterion evaluates the extensibility of the User Plane protocol to support additional features in future. | +| A12. Protocol Overhead | This criterion evaluates the user plane protocol stack / overhead of the solution. | +| A13. Resource-efficiency | This criterion evaluates whether the solution allows to remove states from the UPF. | +| A14. Routing capabilities | This criterion evaluates the solution in terms of routing capabilities and whether the solution allows to support fast rerouting if a failure affects the user plane path between UPFs. | +| A15. Scalability | This criterion evaluates whether the solution meets the scalability requirements of 5G to support massive number of connected devices. Both scale in and out should be evaluated. | +| A16. Performance | This criterion evaluates whether the user plane protocol can easily meet the diverse performance requirement of different network slices. E.g the performance requirement for URLLC slice can be very different from any other slice. | +| A17. Programmability | SMF needs to handle a large number of UPFs in large deployments. This criterion evaluates how easy or difficult is to program network instructions between SMF and UPF. | +| A18. Signalling Optimisation | The current N4 interface between SMF and UPF is very chatty and there is a need to optimise the N4 interface signalling. This criterion evaluates which solution offers better signalling optimisation. | +| A19. Load Balancing | There could be multiple transport path between ingress and egress UPFs. This criterion evaluates the load balancing capability of user plane protocol among multiple paths. | + +| | | +|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| A20. Entropy support |

The transport network routers use standard fields of the IP headers to perform hashing of packets.

In the case of IPv4 based protocols, this is a standard 5-tuple based on the IP SA, DA, Transport header type, Transport header protocol source and destination.

In the case of IPv6 based protocols, this is a standard 3-tuple based on the IP SA, DA and FlowLabel. This criterion evaluates which user plane protocol is better suited for Entropy support.

| +|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +### 7.2.2 GTP-U + +Table 7.2.2-1 describes the GTP-U solution on the additional considerations defined in clause 7.2.1. + +**Table 7.2.2-1: Additional Considerations for the GTP-U solution** + +| Additional Considerations | Description | +|----------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| A1. Proven technology / Time of Availability of used standards |

GTPv1 has been specified by 3GPP from Rel-99 onwards.

GTP-U has been used extensively in the 3GPP system, in the RAN and Core Network in 5G System, EPS and earlier generation's mobile networks.

| +| A2. Enabling separation between 3GPP User Plane and Transport |

The 3GPP User Plane and Transport are decoupled, allowing different operators, organization and systems to operate the mobile and the transport networks.

The 3GPP User Plane and Transport can evolve in parallel without restricting either technology (e.g. GTP-U over IP, MPLS, SR-MPLS, SRv6).

| +| A3. Transport network requirements |

GTP-U runs over IPv4, IPv6 and existing transport network technologies.

GTP-U supports heterogenous transport network and segment optimized transport options (e.g. MPLS or SR MPLS in Backhaul, SR MPLS or SRv6 in Aggregation/Core, SR MPLS or VxLAN/GRE in Data Center).

| +| A4. Co-existence with existing User Plane solution |

This is the existing solution.

Use of UDP zero checksum over IPv6 is negotiated via control plane signalling during the setup of the GTP-U tunnel.

| +| A5. Interworking with RAN |

Same solution as supported in the RAN.

Use of UDP zero checksum over IPv6 is negotiated via control plane signalling during the setup of the GTP-U tunnel.

| +| A6. Interworking with EPS | Same solution as supported in EPS. | +| A7. Impacts to GSMA GRX/IPX | No impact. | +| A8. Security | GSMA has specified user plane security solution for GTP-U in EPC. GSMA and 3GPP SA3 are further studying GTP-U security in 5G System. | +| A9. Minimize number of protocols in network | Same protocol as in existing solution in RAN and CN in 5GS, EPS and earlier mobile network generations. | +| A10. Reusability of existing 3GPP implementations |

Existing SMF and UPF implementations can be reused, with the only optional addition of UDP zero checksum negotiation for IPv6.

Transport remains agnostic of the number of PDU sessions setup in the network (number of 5-tuple flows visible in transport layer is relatively low as PDU sessions are aggregated).

| +| A11. Protocol Extensibility |

GTP-U supports the capability to define new extension headers. This has been used in past releases to support several features, e.g. RAN containers, PDU Session Container (5GS information) over N9 and N3, Service Class Indicator, PDCP PDU numbers.

GTP-U does not place any constraint on the size of the GTP-U extension headers, and therefore allows future extensions of the PDU Session Container Protocol used over N9 and N3.

| +| A12. Protocol Overhead |

GTP-U header: 12 octets.

GTP-U Extension Header (PDU Session Container): 4 octets

UDP header: 8 octets.

| +| A13. Resource-efficiency |

Per 3GPP system architecture requirements, 3GPP user plane functionalities are controlled in UPF by the SMF over the N4 interface; the UPF shall keep states for the established PFCP associations and PFCP sessions.

A GTP-U tunnel endpoint is identified by an IP address and a TEID (4 octets).

| +| A14. Routing capabilities | Routing capabilities supported by IPv4, IPv6 or the underlying transport technologies (e.g. MPLS, SR-MPLS, SRv6). | + +| | | +|------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| |

GTP-U in addition to the basic routing capabilities supported by IPv4, IPv6 or the underlying transport technologies, exposes session and QoS flow in GTP-U header which allows to provide routing differentiation by look up of the corresponding header. Routers in 3GPP systems can support look up of GTP-U headers, but this may not be supported by basic IP routing nodes.

GTP-U supports error detection and error reporting capabilities.

MPLS Fast Reroute is supported (if MPLS is used).

| +| A15. Scalability | No difference between both solutions: UPF functionalities are controlled by the SMF over N4 and UPFs keep the same states for PFCP associations and PFCP sessions. | +| A16. Performance | No difference expected between both solutions. There is an extra UDP layer. Most implementations are expected to process 5-tuple with UDP header as standard function with negligible impact on performance. | +| A17. Programmability | No difference between both solutions: UPF functionalities are controlled by the SMF over N4. | +| A18. Signalling Optimisation | No difference between both solutions: UPF functionalities are controlled by the SMF over N4. | +| A19. Load Balancing |

Load sharing can be achieved in multiple levels:

On GTP-U protocol level, per tunnel-session based load sharing is supported as the destination IP address and Tunnel Endpoint ID is allocated by the receiver. This mechanism is complemented by lower layer load balancing mechanism. See A20 for other levels using entropy bits in protocol headers.

| +| A20. Entropy support |

On UDP/IP level, Entropy for load balancing is also permitted but not mandated by the GTP-U protocol.

Use of dynamic source UDP port for entropy support is documented in the GTP-U specification (the algorithm to set the dynamic source UDP port is implementation specific). Flow Label can also be used for entropy support with IPv6.

Additionally, when GTP-U is transported over IPv6/SRV6, entropy for load balancing is recommended using IETF RFC 6438 [31].

| + +### 7.2.3 SRv6 + +Table 7.2.3-1 describes the SRv6 Traditional Mode on the additional considerations defined in clause 7.2.1. + +Table 7.2.3-2 evaluates the SRv6 Enhanced Mode on the additional considerations defined in clause 7.2.1. + +**Table 7.2.3-1: Additional Considerations on SRv6 in Traditional Mode** + +| Additional Considerations | Description | +|----------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| A1. Proven technology / Time of Availability of used standards | IETF work on SRv6 related improvements is still in progress.
SRv6 as a replacement of GTP-U would require new 3GPP standardization work. | +| A2. Enabling separation between 3GPP User Plane and Transport | 3GPP User Plane and IP transport are collapsed/integrated, with the IP destination address encoding the IP address of the peer UPF, the TEID of the specific user plane tunnel and other 3GPP related information (e.g. QFI, RQI).

With SRv6 as a GTP-U replacement, 3GPP User Plane and Transport are tied in one technology. | +| A3. Transport network requirements | SRv6 essentially relies on IPv6. IPv4 networks might be considered but at the expense of extra signalling overhead and operational costs.

The length of the IPv6 prefix is constrained to keep enough bits to the Function and Arguments of the SID (see Figure 6.2.2.3.2.1). | +| A4. Co-existence with existing User Plane solution | Co-existence with 3GPP user plane entities supporting only GTP-U is required.

Use of SRv6 in Traditional Mode needs to be negotiated via control plane signalling during the setup of the user plane tunnel (in a backward compatible manner to take into account implementations that do not support SRv6 and corresponding negotiation signalling). | +| A5. Interworking with RAN | The solution requires interworking GTP-U over N3 and SRv6 over N9, including interworking the PDU Session User Plane Protocol (in GTP-U extension header over N3, and in the Destination IP address in SRv6 in Traditional Mode), causing impacts in UPF. | +| A6. Interworking with EPS | GTP-U is supported on user plane interfaces in the EPS.
The solution requires the UPF/PGW-U to support different user plane protocols and to switch from one to the other as the PDU session moves between EPS and 5GS. | +| A7. Impacts to GSMA GRX/IPX | GSMA would need to study the support of SRv6 in GRX/IPX as a replacement of GTP-U (including security aspects, see A8). | +| A8. Security | Due to security considerations mentioned in clause 8.2 of IETF RFC 8402 [5], packets sent over SRv6 from one PLMN to another across N9 in home routed roaming cases will be filtered/dropped. Security requirements and proposed 3GPP extensions to existing IETF security requirements for use of SRv6 across SR Domain (e.g. inter-PLMN) need to be reviewed and assessed by SA3 (see clause 6.2.2.7).

GSMA has specified user plane security solution for GTP-U in EPC (based on GTP-U firewall). GSMA and 3GPP SA3 are further studying GTP-U security in 5G System. GSMA and 3GPP SA3 would need to be involved to study SRv6 user plane security in 5G System. | +| A9. Minimize number of protocols in network | The solution would add one new 3GPP user plane protocol solution, for use over the N9 interface. Other interfaces would continue to support GTP-U, e.g. N3, N4-u, S5/S8. | +| A10. Reusability of existing 3GPP implementations | SMFs and UPFs need to be modified to implement SRv6 as a replacement of GTP-U and reproduce existing GTP-U functionalities (e.g. End Markers, PDU Session User Plane Protocol). | +| A11. Protocol Extensibility | The SRv6 extensibility is explained in clause 6.2.1.2. | +| A12. Protocol Overhead | No UDP (8 octets) and GTP-U (12 octets) headers.
If SRv6 is supported over IPv4: extra IPv6 header (40 octets). | +| A13. Resource-efficiency | Per 3GPP system architecture requirements, 3GPP user plane functionalities are controlled in UPF by the SMF over the N4 interface; the UPF shall keep states for the established PFCP associations and PFCP sessions, like for GTP-U. | +| A14. Routing capabilities | SRv6 in Traditional Mode does not encode any SRH header and therefore has to rely on the IPv6 transport network or underlay transport technologies.

SRv6 in addition to the basic routing capabilities supported by IPv6 or the underlying transport technologies, exposes session and QoS flow in IPv6 DA to IP transport to provide routing differentiation by fundamental IP forwarding mechanism (i.e. longest prefix match). The solution supports error detection and error reporting capabilities. Fast Rerouting is also supported. | +| A15. Scalability | No difference between both solutions: UPF functionalities are controlled by the SMF over N4 and UPFs keep the same states for PFCP associations and PFCP sessions. | +| A16. Performance | No difference expected between both solutions. There is no UDP layer. | + +| | | +|------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| A17. Programmability | No difference between both solutions: UPF functionalities are controlled by the SMF over N4. SRv6 network programmability is not used in the 3GPP system. | +| A18. Signalling Optimisation | No difference between both solutions: UPF functionalities are controlled by the SMF over N4. | +| A19. Load Balancing | See A20. | +| A20. Entropy support | Entropy for load balancing is mandated by the SRv6 protocol (using the Flow Label field in the IPv6 header, see clause 5.5 of IETF draft-ietf-6man-segment-routing-header-18 [6]). This is identical to GTP-U over SRv6. | + +**Table 7.2.3-2: Additional Considerations on SRv6 in Enhanced Mode** + +| Additional Considerations | Description | +|----------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| A1. Proven technology / Time of Availability of used standards | Same as for SRv6 in Traditional Mode (see Table 7.2.3-1). | +| A2. Enabling separation between 3GPP User Plane and Transport | Same as for SRv6 in Traditional Mode (see Table 7.2.3-1).

In addition, SRH headers also encode IP addresses of intermediate IP routers on the path, requiring the UPF (mobile network) to be configured with information about the SIDs and thus topology of the transport network.

This essentially assumes mobile and transport networks from a same operator. | +| A3. Transport network requirements | To use the full set of functionalities, the solution relies on IPv6 and SRv6 capable networks. | +| A4. Co-existence with existing User Plane solution | Same as for SRv6 in Traditional Mode (see Table 7.2.3-1), but with negotiating the use of SRv6 in Enhanced Mode. | +| A5. Interworking with RAN | Same as for SRv6 in Traditional Mode (see Table 7.2.3-1). | +| A6. Interworking with EPS | Same as for SRv6 in Traditional Mode (see Table 7.2.3-1). | +| A7. Impacts to GSMA GRX/IPX | Same as for SRv6 in Traditional Mode (see Table 7.2.3-1). | +| A8. Security | Same as for SRv6 in Traditional Mode (see Table 7.2.3-1). | +| A9. Minimize number of protocols in network | Same as for SRv6 in Traditional Mode (see Table 7.2.3-1). | +| A10. Reusability of existing 3GPP implementations | Same as for SRv6 in Traditional Mode (see Table 7.2.3-1). | +| A11. Protocol Extensibility | Same as for SRv6 in Traditional Mode (see Table 7.2.3-1). | +| A12. Protocol Overhead | No UDP (8 octets) and GTP-U (8 to 12 octets) headers.
Generic Routing Extension header: 4 octets
SRH header: 4 octets + 16 octets per SID + optional objects (if any)
If SRv6 is supported over IPv4: extra IPv6 header (40 octets). | +| A13. Resource-efficiency | Same as for SRv6 in Traditional Mode (see Table 7.2.3-1). | +| A14. Routing capabilities | Same as for SRv6 in Traditional Mode (see Table 7.2.3-1). However, routing differentiation by fundamental IP forwarding mechanism (i.e. longest prefix match) on intermediate routing segments is only possible if 3GPP specific information (TEID, QFI) can be embedded in the intermediate SIDs of the transport network, i.e. if the prefix length of the intermediate SIDs provide enough bits space and the encoding of the 3GPP session and QoS flow information does not collide with the structure of the intermediate SIDs (e.g. Function, Arguments).

In addition, SRv6 in Enhance Mode enables to route packets through intermediate IP routers on the path between two UPFs. | +| A15. Scalability | Same as for SRv6 in Traditional Mode (see Table 7.2.3-1). | +| A16. Performance | Same as for SRv6 in Traditional Mode (see Table 7.2.3-1). | +| A17. Programmability | Same as for SRv6 in Traditional Mode (see Table 7.2.3-1). | +| A18. Signalling Optimisation | Same as for SRv6 in Traditional Mode (see Table 7.2.3-1). | +| A19. Load Balancing | Same as for SRv6 in Traditional Mode (see Table 7.2.3-1). | +| A20. Entropy support | Same as for SRv6 in Traditional Mode (see Table 7.2.3-1). | + +## 7.3 Comparison + +| Description | GTP-U | SRv6 as a replacement of GTP-U | +|-----------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| A. Common aspects |

1) UPF functionalities are controlled by the SMF over the N4 interface (PFCP protocol), i.e. SRv6 network programmability (see clause 6.2.1.3) is not used in the 3GPP system;

2) As a result of 1), the UPF shall keep the same states for PFCP associations and PFCP sessions in both solutions;

3) User plane tunnels are established hop by hop between UPFs, i.e. source based routing of SRv6 is not used beyond the possibility for the UPF to force packets to go through intermediate routers between the 2 UPFs using the Network Instance information, in SRv6 Enhanced Mode or with GTP-U over SRv6.

| | +| B. Architectural requirements for User Plane | All requirements are supported. |

Requirements are supported with following restrictions or comments:

1) the PDU Session User Plane Protocol over N9 as specified in Annex A of 3GPP TS 29.281 [2] and in 3GPP TS 38.415 [10] is not supported;

Editor's Note: a solution to support the above requirement is FFS.

2) security requirements and proposed 3GPP extensions to existing IETF security requirements for use of SRv6 across SR Domain (e.g. inter-PLMN) need to be reviewed and assessed by SA3 (see clause 6.2.2.7).

| +| C. IP connectivity for N9 and network slicing | Not supported by the GTP-U protocol itself but supported by existing underlying transport technologies, including GTP-U over SRv6. | SRv6 in Enhanced Mode allows to encode SRH headers to force the data path to go through intermediate SRv6 routers between two UPFs, but the same can be achieved with GTP-U over SRv6. | +| D. System Impacts | No impacts are identified for GTP-U other than those identified for the optional support of UDP zero checksum for GTP-U over IPv6. |

Impacts several 3GPP system entities (UPF, SMF, V-SMF, H-SMF, I-SMF, NRF, AMF) and several interfaces (N9, N4, N16, N16a, N38, Nnrf, N27) including roaming interfaces.

Editor's Note: Potential additional impacts to lawful interception need to be assessed by SA3-LI.

| +| E. Key additional considerations |

GTP-U enables separation between 3GPP user plane and IP-based transport, e.g. when mobile and transport network are different.

GTP-U runs over existing transport network technologies and enables segment optimized transport options.

Same solution as used in RAN, EPS and Rel-15 5GC.

The protocol is fully extensible by defining

|

3GPP User Plane and IP transport are collapsed/integrated, with the IP destination address encoding the IP address of the peer UPF, the TEID of the specific user plane tunnel and other 3GPP related information (e.g. QFI, RQI).

To use the full set of functionalities, the solution relies on IPv6 and, for Enhanced Mode, on SRv6 capable networks.

Interworking required with GTP-U supported in RAN, EPS and Rel-15 5GC, causing impacts in UPF.

Editor's Note: protocol extensibility of

| + +| | | | +|--|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | new GTP-U extension headers. | the solution is FFS. | +| | Transport remains agnostic of the number of PDU sessions setup in the network (number of 5-tuple flows visible in transport layer is relatively low as PDU sessions are aggregated).

Entropy for load balancing is permitted but not mandated by the GTP-U protocol. | Number of flows visible in transport layer is function of the number of PDU sessions. | +| | Protocol overhead: 24 octets (*)
( GTP-U header + GTP-U Extension header + UDP header )

MPLS Label stack header: 4 octets per MPLS label (if SR-MPLS transport is used).

SRv6 overhead: see SRv6 solution (if SRv6 transport is used)

Protocol overhead is not an issue for CN internal interfaces.

(*) not counting IP header and transport layer headers | Protocol overhead:
- Traditional Mode: none
- Enhanced Mode: 24/40/56 octets for e.g. 1/2/3 SIDs (*).
( Generic Routing Extension header + SRH header + 16 octets per SID )

(not counting IPv6 header and transport layer headers, nor SRH optional objects, if any)

Protocol overhead is not an issue for CN internal interfaces.

(*) not counting IP header and transport layer headers | + +Table 7.3-1: Comparison of solutions + +# 8 Conclusion + +## 8.1 General + +This technical report presents the detailed analysis of the following candidate user plane protocols, based on 5GC architectural requirements, key issues, system impacts and additional considerations: + +- 1) GTP-U protocol over IP-based transport (including SRv6) - see clause 6.1; +- 2) SRv6 user plane protocol (without GTP-U) - see clause 6.2.2. + +Both solutions rely on the same 5GS architecture principles, with UPF functionalities controlled by the SMF over N4 using the PFCP protocol, with the same states in UPF for PFCP associations and PFCP sessions, and with user plane tunnels established hop by hop between UPFs. + +## 8.2 GTP-U over IP-based transport (including SRv6) + +GTP-U can run over various transports (such as IPv4, IPv6, SR-MPLS or SRv6) and enables to separate the 3GPP user plane from the transport layer as required e.g. when mobile and transport network are different. This protocol has been used over all the user plane interfaces in the 3GPP system since Rel-99 onwards, in the RAN and Core Network, in the 5GS, EPS and earlier generation's mobile networks, including roaming interfaces between VPLMN and HPLMN. It supports all the 3GPP architectural requirements for user plane specified in Rel-16. + +Existing transport technologies (e.g. SR-MPLS, SRv6) allow forcing the GTP-U traffic to go through specific intermediate routers between two UPFs by referencing a specific Network Instance, e.g. for network slicing, exactly like the SRv6 user plane protocol (without GTP-U) solution. + +GTP-U is fully extensible, by allowing new extension headers to be defined as this has been done in Rel-15 and earlier releases to support several features, e.g. RAN containers, PDU Session Container (5GS information). + +TS 29.281 [2] currently refers to IETF RFC 2460 [3] for the IPv6 protocol, which has been obsoleted by IETF RFC 8200 [4]. The analysis in clause 6.1.2 shows that the changes in IPv6 protocol in the latest RFC do not + +impact the GTP-U protocol, other than the need to negotiate the optional use of UDP zero checksum during the setup of GTP-U tunnel over IPv6 as described in clause 6.1.3.2. + +It is recommended to update the GTP-U specification in Rel-16 to: + +- update the IPv6 protocol reference to IETF RFC 8200 [4] and to enable the optional use of the UDP zero checksum over IPv6; +- recommend the use of dynamic source UDP port or the Flow Label field to ease load balancing of the traffic in the transport network. + +## 8.3 SRv6 user plane protocol (without GTP-U) + +The SRv6 user plane protocol (without GTP-U) solution proposes to remove the GTP-U/UDP headers, which saves 24-bytes, by placing 3GPP user plane information (e.g. Tunnel Endpoint Identifier, QoS Flow Identifier, Reflective QoS Indicator, Echo Request/Response, Error Indication, End Marker) within 3GPP specific extensions in the SRH header (e.g. 3GPP specific tags and TLV objects) and in the SID/IP Destination Address. + +The solution supports all the 3GPP architectural requirements for user plane specified in Rel-16, except the architectural requirement 8) from clause 5.1.1, where the solution results in splitting the contents of the PDU Session User Plane PDUs into two places of the TLV and the SID in the SRv6 packets and does not allow the PDU session user plane protocol to evolve without impacting the SRv6 user plane packets: + +- "8) The PDU Session User Plane Protocol (see TS 38.415 [10]) shall be supported to transfer 5GS information over N3 and N9 (e.g. QoS Flow Identifier, Reflective QoS Indicator, Paging Policy Indicator) together with user plane packets." + +SRv6 in Traditional Mode does not allow to force the data path to go through intermediate routers between two UPFs, e.g. for network slicing. SRv6 in Enhanced Mode allows to force the data path to go through intermediate routers between two UPFs by referencing a specific Network Instance, e.g. for network slicing, like e.g. GTP-U over SRv6 or GTP-U over SR-MPLS. + +CT4 could not reach consensus on the final assessment and conclusion for the SRv6 user plane protocol (without GTP-U) solution. A technical vote took place during CT4#93 (26-30 August 2019) with the following question and results: + +Question: Do you want to standardize SRv6 user plane protocol (w/o GTP-U) as described in clause 6.2.2 of TR 29.892? + +Results: + +YES: 13.924 % + +NO: 86.076 % + +The quorum was reached. + +It was therefore concluded to not standardize the SRv6 user plane protocol (without GTP-U) solution within the scope of this study (i.e. based on stage 2 requirements specified in Rel-16). + +# Annex A: Change history + +| Change history | | | | | | | | +|----------------|-----------|-----------|----|-----|-----|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2018-07 | CT4#85bis | C4-185497 | | | | Initial Draft | 0.1.0 | +| 2018-08 | CT4#86 | C4-186683 | | | | Implementation of C4-186502, C4-186503, C4-186504, C4-186506, C4-186507, C4-186611, C4-186612 and C4-186613 agreed in CT4#86 | 0.2.0 | +| 2018-10 | CT4#86bis | C4-187645 | | | | Implementation of C4-187522, C4-187620, C4-187621, C4-187622, C4-187623, C4-187624 and C4-187625 agreed in CT4#86bis. | 0.3.0 | +| 2018-12 | CT4#87 | C4-188696 | | | | Implementation of C4-188598, C4-188600, C4-188602, C4-188604, C4-188608, C4-188686, C4-188687 and C4-188689 agreed in CT4#87. | 0.4.0 | +| 2019-03 | CT4#89 | C4-190633 | | | | Implementation of C4-190270, C4-190542, C4-190560, C4-190566, C4-190568, C4-190569, C4-190570, C4-190592, C4-190593, C4-190596, C4-190628 and C4-190629 agreed in CT4#89. | 0.5.0 | +| 2019-03 | CT#83 | CP-190060 | | | | Presented for information | 1.0.0 | +| 2019-04 | CT4#90 | C4-191540 | | | | Implementation of C4-191013, C4-191442, C4-191445, C4-191447, C4-191449, C4-191451, C4-191453, C4-191456, C4-191458, C4-191513, C4-191514 and C4-191515 agreed in CT4#90. | 1.1.0 | +| 2019-05 | CT4#91 | C4-192482 | | | | Implementation of C4-192029, C4-192406, C4-192415 and C4-192420 agreed in CT4#91. | 1.2.0 | +| 2019-09 | CT4#93 | C4-193843 | | | | Implementation of C4-193843 agreed in CT4#93. | 1.3.0 | +| 2019-09 | CT#85 | CP-192203 | | | | Presented for approval | 2.0.0 | +| 2019-09 | CT#85 | | | | | TR was approved in CT#85. | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29893/19a59d6b53059ebd27b13c98793f88e0_img.jpg b/marked/Rel-16/29_series/29893/19a59d6b53059ebd27b13c98793f88e0_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f50bda1161e3361b6effbd25d128e8d703b4dc79 --- /dev/null +++ b/marked/Rel-16/29_series/29893/19a59d6b53059ebd27b13c98793f88e0_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3906d92f7586c9be1ef7ce8e41a2ec367981a2d8e1ea83583fdcc6ff9d71f72d +size 73286 diff --git a/marked/Rel-16/29_series/29893/79e1709a7317ead45379cbb8ff3ba802_img.jpg b/marked/Rel-16/29_series/29893/79e1709a7317ead45379cbb8ff3ba802_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..58a06e52ce0e7f02a4050188e33c40fb5815f25d --- /dev/null +++ b/marked/Rel-16/29_series/29893/79e1709a7317ead45379cbb8ff3ba802_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0d82c84686673bc15358a1ac439191e23d7bea9ad490998b7a3f9a98d85f3d9e +size 103386 diff --git a/marked/Rel-16/29_series/29893/90ddb84c323b956e2d50a54d3f870566_img.jpg b/marked/Rel-16/29_series/29893/90ddb84c323b956e2d50a54d3f870566_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2006d27d9a851c63201779d006eb9bd02ac33925 --- /dev/null +++ b/marked/Rel-16/29_series/29893/90ddb84c323b956e2d50a54d3f870566_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:398981911ddeeec75015f4a8f165df3da6ce5bbbb7ae781d0c99cc42b16e2a1a +size 72602 diff --git a/marked/Rel-16/29_series/29893/a3953dce8dbd7ef15d61a314dbef2cf9_img.jpg b/marked/Rel-16/29_series/29893/a3953dce8dbd7ef15d61a314dbef2cf9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..327fa6c6616d5c31cad3b7039b5ebce4af32ca96 --- /dev/null +++ b/marked/Rel-16/29_series/29893/a3953dce8dbd7ef15d61a314dbef2cf9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:96ead02c155a3359648447022aefcfa2a33a0036d98f04fbb476a370ea41879b +size 46622 diff --git a/marked/Rel-16/29_series/29893/e180f2b5fcbe8001554a7c0677cd3f82_img.jpg b/marked/Rel-16/29_series/29893/e180f2b5fcbe8001554a7c0677cd3f82_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..dbde01816f62c052e6baafd9756a9de2948d8bb0 --- /dev/null +++ b/marked/Rel-16/29_series/29893/e180f2b5fcbe8001554a7c0677cd3f82_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:79ab299594567b7f07ffd56550b34107da4112a45b043aa1175bf8c5755fb9c7 +size 60199 diff --git a/marked/Rel-16/29_series/29893/raw.md b/marked/Rel-16/29_series/29893/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..834276cdd30d64b14bdaed7600b51d7405d658ba --- /dev/null +++ b/marked/Rel-16/29_series/29893/raw.md @@ -0,0 +1,1133 @@ + + +# **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Study on IETF QUIC Transport for 5GC Service Based Interfaces; (Release 16)** --- --- + +## --- **Keywords** + + + +## **3GPP** + +## --- **Postal address** + +## --- **3GPP support office address** + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +## --- **Internet** + + + +## --- **Copyright Notification** + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTSTM is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|-----------------------------------------------------------------------|----| +| Foreword ..... | 5 | +| Introduction ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions, symbols and abbreviations..... | 7 | +| 3.1 Definitions..... | 7 | +| 3.2 Abbreviations ..... | 7 | +| 4 Architectural Baseline..... | 8 | +| 5 Transport Protocol Features Required For 3GPP 5GC SBI..... | 8 | +| 5.1 Introduction ..... | 8 | +| 5.2 Requirements from Transport Protocol for 3GPP 5GC SBI ..... | 8 | +| 5.3 Features of QUIC ..... | 9 | +| 5.3.1 General ..... | 9 | +| 5.3.2 Framing and Multiplexing..... | 9 | +| 5.3.3 Improved Recovery and Acknowledgement ..... | 10 | +| 5.3.4 Encrypted and Integrity Protected Transport details ..... | 10 | +| 5.3.5 Connection Setup Improvements ..... | 10 | +| 5.3.6 0-RTT Data..... | 11 | +| 5.3.7 Connection ID ..... | 11 | +| 5.3.8 Connection Migration..... | 11 | +| 5.3.9 Stream Prioritization..... | 12 | +| 5.3.10 Flow Control..... | 12 | +| 5.3.11 Protocol Versioning..... | 12 | +| 5.3.12 QUIC Extensibility ..... | 12 | +| 5.3.13 Connection Configuration ..... | 13 | +| 5.3.14 User-Land Implementations ..... | 13 | +| 5.3.15 Pluggable Sender Side Congestion Control ..... | 13 | +| 5.3.16 Checking that the QUIC connection is alive ..... | 13 | +| 5.3.17 62 bits stream identifiers ..... | 13 | +| 5.3.18 Running atop of UDP ..... | 14 | +| 5.4 Features of QUIC Applicable to 3GPP SBI..... | 14 | +| 5.4.1 General ..... | 14 | +| 5.4.2 Framing and Multiplexing..... | 14 | +| 5.4.3 Encrypted and Integrity Protected Transport details ..... | 14 | +| 5.4.4 Connection setup improvements ..... | 14 | +| 5.4.5 Connection ID and Connection Migration ..... | 15 | +| 5.4.6 Improved Recovery and Acknowledgement ..... | 15 | +| 5.5 Features of QUIC Not Applicable to 3GPP SBI..... | 15 | +| 5.5.1 General ..... | 15 | +| 5.5.2 0-RTT DATA ..... | 15 | +| 5.6 Comparison of Applicable Features with Rel-15 Transport ..... | 16 | +| 6 HTTP/3..... | 20 | +| 6.1 Introduction ..... | 20 | +| 6.2 HTTP/3 Proxies..... | 21 | +| 6.2.1 General ..... | 21 | +| 6.2.2 When NF Service Consumer Side Uses QUIC ..... | 22 | +| 6.2.2.1 Case A: Invoking http API Supporting Only TCP Transport..... | 22 | +| 6.2.2.2 Case B: Invoking http API Supporting QUIC Transport..... | 24 | +| 6.2.2.3 Case C: Invoking https API Supporting Only TCP Transport..... | 25 | +| 6.2.2.4 Case D: Invoking https API Supporting QUIC Transport..... | 26 | +| 6.2.3 When NF Service Consumer Side Uses TCP..... | 27 | +| 6.2.3.1 Invoking http API Supporting QUIC Transport ..... | 27 | +| 6.2.3.2 Invoking https API Supporting QUIC Transport..... | 27 | + +| | | | +|-----------------|---------------------------------------------------------------------------|-----------| +| 6.3 | Considerations for HTTP/3 ..... | 28 | +| 6.3.1 | General ..... | 28 | +| 6.3.2 | Connection setup and management ..... | 28 | +| 6.3.3 | Streams, framing and multiplexing ..... | 28 | +| 6.3.4 | Prioritization ..... | 29 | +| 6.3.5 | Server Push ..... | 29 | +| 6.3.6 | Compression (HPACK vs QPACK)..... | 29 | +| 7 | Key Requirements for Supporting QUIC..... | 29 | +| 7.1 | Introduction ..... | 29 | +| 7.2 | Discovery of QUIC support ..... | 29 | +| 7.3 | Discovery of NRF's Support for QUIC ..... | 30 | +| 7.4 | Migration to QUIC ..... | 30 | +| 7.5 | Support of Indirect Communication..... | 30 | +| 8 | Solutions for Key Requirements ..... | 30 | +| 8.1 | Introduction ..... | 30 | +| 8.2 | Solutions for Discovery of QUIC support..... | 31 | +| 8.2.1 | Using the Discovery Service of the NRF ..... | 31 | +| 8.2.2 | Using Alt-Svc Header..... | 31 | +| 8.2.x | Solution#x..... | 32 | +| 8.3 | Solutions for Discovery of NRF's Support for QUIC ..... | 32 | +| 8.3.1 | Providing NRF Transport Capability from NSSF ..... | 32 | +| 8.3.2 | Providing Remote PLMN NRF's Transport Capability during NF Discovery..... | 32 | +| 8.3.3 | Discovery Based On Local Configuration ..... | 32 | +| 8.4 | Solutions for Migration to QUIC ..... | 33 | +| 8.4.1 | Deployment Topologies to Introduce NF Services with QUIC Support..... | 33 | +| 8.4.2 | Steps to Follow When Introducing NF Services with QUIC Support..... | 33 | +| 8.4.3 | Use of QUIC by NF Service Consumers..... | 33 | +| 8.4.4 | Decommissioning TCP..... | 33 | +| 8.y | Evaluation and Conclusion..... | 34 | +| 9 | Impacts to Service Based Architecture ..... | 34 | +| 9.1 | Introduction ..... | 34 | +| 9.2 | HTTP Proxy Traversal ..... | 34 | +| 9.3 | QUIC's Security Mechanisms ..... | 34 | +| 9.4 | TCP Decommission in Migration Impacts Architecture..... | 34 | +| 9.5 | Transport Proxy Traversal..... | 35 | +| 9.6 | Impacts on Troubleshooting..... | 35 | +| 9.6.1 | Introduction ..... | 35 | +| 9.6.2 | QUIC keying impact ..... | 35 | +| 9.6.3 | Network level troubleshooting ..... | 35 | +| 9.6.4 | Application level troubleshooting ..... | 36 | +| 10 | Current Implementation and Maturity Status..... | 36 | +| 10.1 | Introduction ..... | 36 | +| 10.2 | Implementation maturity ..... | 37 | +| 10.3 | Hardware offload support..... | 37 | +| 10.4 | UDP Performance in Operating System..... | 37 | +| 11 | Evaluation and Conclusion ..... | 38 | +| 11.1 | Interim Evaluation..... | 38 | +| 11.1.1 | Requirements for Service Based Interfaces..... | 38 | +| 11.1.2 | Expected improvements ..... | 38 | +| 11.1.3 | Issues ..... | 38 | +| 11.1.4 | Other considerations ..... | 39 | +| 11.2 | Interim Conclusion..... | 39 | +| Annex A: | Change history ..... | 40 | + +# Foreword + +This Technical Report has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- Introduction + +*This clause is optional. If it exists, it is always the second unnumbered clause.* + +# --- 1 Scope + +The present document analyses the IETF QUIC protocol and its potential use as a transport protocol for the 5GC Service Based Interfaces. + +This technical report provides an analysis of the following aspects: + +- Features of transport protocol required for 5GC SBI; +- Features of QUIC applicable to 5GC SBI; +- Comparison of the applicable features of QUIC against TCP for the 5GC SBI; +- Key requirements for 5GC SBI in order to support QUIC as a transport protocol; +- Solutions for supporting the key requirements; +- Impacts to 5GC Service Based Interfaces due to introduction of QUIC. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] IETF draft-ietf-quic-transport-29: "QUIC: A UDP-Based Multiplexed and Secure Transport". +- [6] IETF draft-ietf-quic-tls-29: "Using Transport Layer Security (TLS) to Secure QUIC". +- [7] IETF draft-ietf-quic-http-29: "Hypertext Transfer Protocol (HTTP) over QUIC". +- [8] IETF draft-ietf-quic-recovery-29: "QUIC Loss Detection and Congestion Control". +- [9] IETF draft-ietf-quic-invariants-09: "Version-Independent Properties of QUIC" +- [10] IETF draft-ietf-quic-qpack-16: "QPACK: Header Compression for HTTP over QUIC" +- [11] IETF RFC 5246: "The Transport Layer Security (TLS) Protocol Version 1.2". +- [12] IETF RFC 8446: "The Transport Layer Security (TLS) Protocol Version 1.3". +- [13] IETF RFC 7540: "Hypertext Transfer Protocol Version 2 (HTTP/2)". +- [14] IETF RFC 7541: "HPACK: Header Compression for HTTP/2". +- [15] Void + +- [16] IETF RFC 5682: "Forward RTO-Recovery (F-RTO): An Algorithm for Detecting Spurious Retransmission Timeouts with TCP". +- [17] IETF draft-dukkipati-tcpm-tcp-loss-probe-01: "Tail Loss Probe (TLP): An Algorithm for Fast Recovery of Tail Losses". +- [18] IETF RFC 6582: "The NewReno Modification to TCP's Fast Recovery Algorithm". +- [19] 3GPP TS 29.510: "Network Function Repository Services". +- [20] IETF RFC 7838: "HTTP Alternative Services". +- [21] IETF draft-pardue-httpbis-http-network-tunnelling-01: "HTTP-initiated Network Tunnelling (HiNT)". +- [22] IETF RFC 7231: "Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content". +- [23] IETF RFC 7230: "Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing". +- [24] 3GPP TS 33.210: "3G security; Network Domain Security (NDS); IP network layer security". +- [25] GSMA NG.113: "5GS Roaming Guidelines". +- [26] IETF RFC 8312: "CUBIC for Fast Long-Distance Networks". +- [27] 3GPP TR 23.742: "Study on Enhancements to the Service-Based Architecture". +- [28] IETF RFC 8164: "Opportunistic Security for HTTP/2". +- [29] IETF RFC 7657: "Differentiated Services (Diffserv) and Real-Time Communication". +- [30] Taking a Long Look at QUIC: "". +- [31] IETF RFC 5288: "AES Galois Counter Mode (GCM) Cipher Suits for TLS". +- [32] Developing and deploying a TCP replacement for the Web: "". +- [33] Optimizing UDP for content delivery: "[http://vger.kernel.org/lpc\\_net2018\\_talks/willemdebruijn-lpc2018-udpgso-paper-DRAFT-1.pdf](http://vger.kernel.org/lpc_net2018_talks/willemdebruijn-lpc2018-udpgso-paper-DRAFT-1.pdf)". +- [34] UDP segmentation offload: "". +- [35] Multiplexed Application Substrate over QUIC Encryption (MASQUE) charter text: "" + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|-----|--------------------------| +| RTT | Round Trip Time | +| TLS | Transport Layer Security | + +# --- 4 Architectural Baseline + +3GPP Release 16 Service Based Architecture as specified in 3GPP TS 23.501 [2] and the 3GPP Release 16 Technical Realization of the Service Based Architecture as specified in 3GPP TS 29.500 [4] shall be taken as the baseline for studying QUIC's use as a transport protocol for the 5GS Service Based Interfaces. + +In particular the following architectural assumptions shall be taken into account: + +- Replacing the transport protocol from TCP to QUIC shall not lead to any change in the semantics of the NF services and shall not lead to any change in API. +- SEPP shall be used as the security protection and edge proxy even when the NF service consumer in VPLMN and the NF service consumer in HPLMN both use QUIC as the transport. +- For inter PLMN NF service communication, even if both the NF service consumer and NF service producer support QUIC, the IPX providers and intermediaries on path between the two NF's first hop and the last hop shall not be mandated to support QUIC. In other words, the NF service consumer and the NF service producer shall be able to communicate when using QUIC as transport even in the presence of TCP based IPX or intermediaries on path between the first hop and the last hop. +- A NF Service Consumer and NF Service Producer may communicate indirectly via Service Communication Proxy (SCP). The indirect communication options defined in Annex E of 3GPP TS 23.501 [2] and listed hereafter shall be permitted: + - Option C - Indirect communication without delegated discovery; + - Option D - Indirect communication with delegated discovery. + +SCPs act as HTTP proxies. SCPs require the ability to look into the HTTP message for delegated discovery and selection functionality. + +# --- 5 Transport Protocol Features Required For 3GPP 5GC SBI + +## 5.1 Introduction + +This clause will identify the requirements from transport protocol for the 3GPP 5GC service based interfaces and then subsequently highlights the features of the QUIC protocol. Among the features of QUIC, those features that are applicable for the 3GPP 5GC service based interfaces are then explicitly identified. + +## 5.2 Requirements from Transport Protocol for 3GPP 5GC SBI + +The following are the key requirements from transport layer protocols for the 3GPP 5GC service based interfaces. The 3GPP 5GC service based interfaces use HTTP/2 as the application layer protocol. As of 3GPP Release 15, TCP is used as the transport protocol for the 5GC service based interfaces. TCP suffers from Head of Line blocking issues and any new transport protocol that is considered as a replacement to TCP for the 3GPP 5GC service based interfaces shall not have the same limitation. + +- REQ#1: The transport layer protocol shall support reliable message delivery. +- REQ#2: The transport layer protocol shall support flow control and congestion control mechanisms. +- REQ#3: The transport layer protocol shall support connection semantics as required by IETF RFC 7540 [13]. +- REQ#4: The failure to deliver one message shall not block subsequent messages. +- REQ#5: The transport layer protocol shall have mechanisms to allow authentication of the peer transport endpoint and shall have mechanisms for the secure transfer of application layer messages. +- REQ#6: The transport layer protocol shall have mechanisms to allow processing of the HTTP/2 messages over it by intermediaries (e.g. proxies like SCP). +- REQ#7: The transport layer protocol should support troubleshooting and Monitoring, e.g. message trace and parse in the middlebox for the scenarios of testing, monitoring, troubleshooting and etc. +- REQ#8: The transport layer protocol, along with the upper layer application protocol shall support the distributed architecture for PNFs and VNFs, e.g. the front-end load-balancer and back-end service process-units architecture. +- REQ#9: The performance and resource efficiency (i.e. CPU, Memory and other processing requirements) shall be one of the evaluation criteria of the transport layer protocol. +- REQ#10: The complexity and cost of development and deployment of the transport layer protocol shall be one of the evaluation criteria. +- REQ#11: The transport layer protocol shall be mature enough for adoption of the protocol in the 5GC, e.g. fully standardized and has mature open source support, not only for the QUIC protocol, but also the full stack of HTTP/3 protocols. + +## 5.3 Features of QUIC + +### 5.3.1 General + +QUIC is a multiplexed and secure transport protocol that runs on top of UDP. QUIC aims to provide a flexible set of features that allow it to be a general-purpose secure transport for multiple applications. The main parts of QUIC are defined in a set of documents IETF draft-ietf-quic-transport [5], IETF draft-ietf-quic-recovery [8], IETF draft-ietf-quic-tls [6], IETF draft-ietf-quic-invariants [9]. The highly integrated HTTP/2 over QUIC specification (now called HTTP/3) IETF draft-ietf-quic-http [7] and HTTP header compression IETF draft-ietf-quic-qpack [10] are developed in parallel with the core protocol. The protocol is developed by the Internet Engineering Task Force (IETF). + +QUIC is mainly designed for the communication across insecure and untrusted internet, it integrates some features to tackle the performance, security and privacy related challenges, the applicability of applying QUIC in 5G Core shall be evaluated. + +### 5.3.2 Framing and Multiplexing + +QUIC endpoints communicate by exchanging QUIC packets in UDP datagrams. QUIC packets may have long or short headers, for packets sent prior or after the completion of version negotiation and establishment of 1-RTT keys respectively. A sender multiplexes one or more frames with same or different types into a QUIC packet. QUIC labels the boundary of each frame with an offset field, which helps to carry different messages. This is one of the differences with TCP, as TCP only provides one stream and all data therefore are delivered in order, which means multiplexing is not supported in TCP. A sender can wait for a short period of time to bundle multiple frames into the same QUIC packet, e.g. to minimize the computational costs of packets sending. + +QUIC supports multiple parallel data streams multiplexed on a single QUIC connection. Streams, which can be unidirectional or bidirectional in QUIC provide a lightweight, ordered byte-stream abstraction to an application. Packets transmitted in each stream use Authenticated Encryption with Additional Data (AEAD) to provide confidentiality and integrity protection. Streams can be long-lived, even during the lifetime of a connection to increase the reusability and limit the cost of opening stream (See IETF draft-ietf-quic-transport [5]). An endpoint of a bidirectional stream can terminate one direction and even encourage prompt termination in the opposite direction. + +For each stream QUIC now only supports reliable and in-order delivery, but the implementations may choose to offer the ability to deliver data out of order. However, the QUIC layer is capable of delivering to the higher layer each stream independently as the streams in QUIC are independent of each other, thus it avoids blocking the delivery of any of the other streams when a packet loss contains only part of a stream which would be the case for HTTP/2 over TCP. Note that to achieve this efficiency the implementation needs to pay attention to pack payload from one stream into a single QUIC packet. + +The HTTP/3 mapping for QUIC IETF draft-ietf-quic-http [7] utilizes this stream concept when realizing the different HTTP/2 (See IETF RFC 7540 [13]) streams. HTTP/3 also had to improve the HTTP header compression scheme HPACK (See IETF RFC 7541 [14]) into QPACK (See IETF draft-ietf-quic-qpack [10]). With these changes HTTP can deliver independent requests and responses in the order they are successfully delivered to endpoints, without head of line blocking between HTTP streams which would be the case for HTTP/2 over TCP. + +### 5.3.3 Improved Recovery and Acknowledgement + +The QUIC definition of its packet format and acknowledgement frame results in several improvements over TCP. The packet number is transmission-time ordered and strictly increasing. QUIC never retransmits a particular packet, only the lost data frames that need to be retransmitted. QUIC facilitates better way to calculate RTT by encoding the delay between packet reception and transmission of the acknowledgement. The QUIC acknowledgement also supports a very larger number of received and gap ranges. + +Compared to TCP, QUIC will not be limited to a three blocks of selective acknowledgement (SACK) when using the timestamp option. Each ACK Frame in QUIC can contain variable number of ACK ranges, up to 62 bits (See IETF draft-ietf-quic-transport [5]), which helps to ease network throughputs in case of sending packets frequently. The strict packet numbers and explicit acknowledgement removes ambiguity between which packet is lost and which is acknowledged. Avoiding any unnecessary retransmissions of data that have reached the receiver. QUIC also avoids the retransmission uncertainty if the received packet was a delayed or retransmitted. QUIC's RTT samples are more accurate than what TCP can provide due to no ambiguity about which packets are used in measurement as well as the receiver side delay can be taken into account. + +The congestion control algorithm of the current QUIC version is based on NewReno (See IETF RFC 6582 [18]), but implementations can use other congestion control algorithms, such as Cubic (see IETF RFC 8312 [26]), and endpoints are allowed to use different algorithms from one another. QUIC can customise different congestion control algorithms for different connections of the same application, and even alter it during the lifetime of a connection, see clause 5.3.15. QUIC provides generic congestion control signals to support different algorithms. QUIC also uses some additional modern loss recovery mechanisms by default, such as F-RTO (See IETF RFC 5682 [16]), and Tail Loss Probing (See IETF draft-dukipati-tcpm-tcp-loss-probe [17]). These improvements give QUIC a better recovery mechanism. + +### 5.3.4 Encrypted and Integrity Protected Transport details + +QUIC uses TLS 1.3 (See IETF draft-ietf-quic-tls [6], IETF RFC 8446 [12]), for key establishment, QUIC integrates the TLS 1.3 as its own encryption and integrity layer that protects the QUIC packets, but the security capability of HTTP/3 over QUIC/UDP is consistent with HTTP/2 over TLS1.3/TCP. Each QUIC packet has a packet header, using a short or a long format with a small number of fields that are unencrypted, but integrity protected. It is primarily the connection ID that is unencrypted and three reserved bits for experimentation in the short header. Even the packet number is encrypted using an independent mechanism from the payload. + +The encryption and integrity protection provide confidentiality, privacy and source authenticity for the user of QUIC. However, the protection is also intended to prevent any middlebox in the network from interfering with the protocol, nor make assumptions about what the possible values any specific bit in the UDP payload can take. Ossification of the network has prevented a lot of improvements from being applied to TCP as middleboxes would either block or remove such changes. + +Compared to TCP, this level of encryption does make certain type of network performance monitoring using middlebox basically impossible. Due to this, the QUIC short header introduces a latency spin bit (See IETF draft-ietf-quic-transport [5]) that is intended to enable middlebox to measure round-trip time between the middlebox and either endpoint of the connection if enabled by both end-points. The latency spin bit partially overcomes the drawback of impossible network performance monitoring caused by encryption in QUIC layer, but cannot support the message tracing by content inspection for the testing, monitoring and troubleshooting related scenarios. + +### 5.3.5 Connection Setup Improvements + +QUIC is capable of completing establishment of a connection between a client and a server in one and half RTT. The protocol combines TLS (See IETF RFC 8446 [12]) handshake with transport protocol level mechanisms to achieve this. A client's request to a server can be included after one RTT and be sent combined with the last step of the crypto handshake from the client to the server. + +Holding state in the server for the initial connection establishment packets prior to having verified the client's return path can expose the server to a denial of service risk. Servers that like to mitigate that risk can use the Retry packet to verify the path and not hold any state for the first round-trip. + +How big improvement this is depends on what one compares against. As 3GPP TS 33.310 makes support for TLS 1.3 (See IETF RFC 8446 [12]) mandated from Rel-15 it is reasonable to compare with both TLS 1.2 (See IETF RFC 5246 [11]) and TLS 1.3. TLS 1.2 session resumption requires that the client has talked to the server recently enough, so it still has session state stored. The below table indicates number of RTTs until the first HTTP request can be sent by the client. + +**Table 5.3.5-1: Number of RTTs until first HTTP request** + +| Protocol | New Connection | Connection State Exists | +|-------------|----------------|-------------------------| +| TCP/TLS 1.2 | 3 | 2 | +| TCP/TLS 1.3 | 2 | 1 | +| QUIC | 1 | 0 | + +QUIC can achieve faster connection establishment times until an HTTP request has been sent than existing TLS and TCP combinations. This improvement is significant when establishing a new connection, but not when clients have a long lived one to the server. + +### 5.3.6 0-RTT Data + +TLS 1.3 (IETF RFC 8446 [12]) includes support for early data or 0-RTT data, as it is also called. This is potentially usable by both HTTP/2 over TLS1.3/TCP as well as HTTP/3. This functionality can be used when client and server share a Pre-Shared Key (PSK), which can be arranged out of band or exist from an earlier connection. 0-RTT data has other security properties than for data sent after the handshake completes. Data sent as 0-RTT data will be possible to replay by an attacker that has seen the client to server exchange. Therefore, the use of 0-RTT data requires that the data is safe to replay. When using HTTP requests as 0-RTT data, the request performed must be one that is idempotent. Server may refuse to accept 0-RTT data for this reason. + +A server accepts 0-RTT data on a connection needs more processing and computation cost. Servers need to consider the probability of replay and all associated costs when accepting 0-RTT (See IETF draft-ietf-quic-tls [6], IETF RFC 8446 [12]). + +### 5.3.7 Connection ID + +QUIC uses two sets of connection IDs, one for the server and one for the client to identify a particular connection for an endpoint. During the handshake, QUIC packet with the long header is used to exchange the connection ID that each endpoint assigned. The endpoint is allowed to change the own connection ID to another available one at any time during the connection without any interruption in the transmission. This solution makes the connection not hard bound to a particular 5-tuple (Source and Destination IP, protocol, and source and destination port), instead the connection can be moved between different network interfaces on client and with some limitations on the server side. The protocol has a feature for migrating connections from using one 5-tuple to another, see clause 5.3.8. When knowingly changing the used 5-tuple a new connection ID is necessarily to be used. The peers exchange additional connection IDs when needed to ensure that the peer have one or more previously unused CIDs that can be used in case of connection migration. The middlebox is difficult to correlate the received packet to the connection as the procedure used to changing connection is in encryption. + +The length of connection ID is variable, and it provides certain flexibility in how the implementers realize network equipment architecture, e.g. front-end load-balancers, for QUIC. + +### 5.3.8 Connection Migration + +QUIC allows its connection to migrate while the HTTP/3 session progresses. This means for a client with multiple network interfaces an ongoing QUIC session can be moved to newly validated path via a newly discovered network interface, for example, in the case of a data session handover from WLAN to a 3GPP radio access technology. This is possible as QUIC sessions are identified by a set of connection IDs hence a particular QUIC session is not tightly coupled with a specific client IP address and port number. If a network interface appears with new IP addresses or an existing one disappears but the client has alternative network interfaces, the QUIC session does not need to be established again. The QUIC session can continue on a new interface after the client has validated the path to the server from the new interface address using PATH\_CHALLENGE frames, with potentially a new connection ID from the previously communicated set of connection IDs. + +NOTE: IETF draft-ietf-quic-transport [5] does not mandate a new connection ID after connection migration. However such reuse is not recommended as this allows on path observers to link multiple source IP addresses to the same connection and identify the topological relationship of clients. See clause 9.5 of IETF draft-ietf-quic-transport [5]. + +It is possible that the server also has multiple IP addresses and has some preferences on which interface it would like to serve a particular client for load balancing or other management. QUIC allows server to receive a connection request to one IP address and migrate the connection to a preferred address in connection response immediately, this achieve faster connection migration than HTTP redirect. Currently, QUIC does not support change of server IP address in the middle of an ongoing session however, the server preferred address can be conveyed to the client during the TLS handshake as "preferred\_address" transport parameter (see clause 9.6 of IETF draft-ietf-quic-transport [5]). If the new path to the preferred server address is valid then client sends all the future packets to the new server address. Here the client also uses a new connection ID for the new connection to the server's preferred address. + +### 5.3.9 Stream Prioritization + +Being a multiplexed transport protocol, QUIC supports stream prioritization for boosting the application performance. However, QUIC itself neither provides mechanism to negotiate prioritization information nor implements any strict prioritization scheme. It relies on the application to provide priority information that QUIC will follow when it comes to packet transmission or retransmission. HTTP/3 uses the same prioritization mechanism as HTTP/2. + +### 5.3.10 Flow Control + +Flow control is a mechanism to set boundaries to the senders to avoid overwhelming receiver with data that the receiver cannot process. Like TCP, QUIC deploys connection level flow control, moreover, it applies a secondary stream level flow control to prevent a particular stream from consuming the receiver buffer for a connection. As QUIC provides multiplexing, flow control from the HTTP/2 layer is moved to the QUIC layer, avoiding head of line blocking and simplifying HTTP/3. + +### 5.3.11 Protocol Versioning + +QUIC has a 32-bit version field. It can be expected that QUIC will eventually exists in a number of proprietary and standardized versions. IETF is currently working on defining version 0x00000001. There exists a mechanism for the client to ask the server to enumerate all versions it support. The client when requesting to create a connection it will indicate the version desired to use. If supported then that is what will be used, otherwise it triggers the version negotiation. Some of the non-encrypted fields are defined as not being changeable independent of version as defined by the document for invariants (See IETF draft-ietf-quic-invariants [9]). + +The QUIC versioning enables a very large degree of flexibility for future changes of QUIC. All aspects except for the invariants can be changed. This enables the tuning of QUIC to a specific use case or implementation of future improvements in transport protocol technology. This flexibility also indicates the need to be explicit about which QUIC version(s) that are to be supported by a specific SBI. Any analysis of benefits and downsides of QUIC must be explicit about which version is discussed. + +### 5.3.12 QUIC Extensibility + +QUIC payloads are consists of one or more frames. Each frame starts with frame types followed by type specific flags. All the streams with data are carried over the STREAM frame type. QUIC's current specification defines a number of essential frame types. However, new frame types can be created and can be even application specific. + +QUIC allows extensions to the protocol within the constraints of the protocol invariants (see properties of the QUIC transport protocol that are expected to remain unchanged as new versions of the protocol are developed, in IETF draft-ietf-quic-invariants [9]). Extensions can change the semantics of existing protocol components, but they need to be negotiated before being used. Permitted extensions include new frame types, new settings, error codes and uni-directional streams. This gives QUIC a unique way of to be extensible and customizable. + +The usage of new frame types does not necessarily imply using a new protocol version. A peer can use transport parameters to indicate support to the peer that it can use a new frame type. However, this has the downside that the support of a certain frame type cannot be determined before establishing the transport connection; on the other hand, using a specific protocol version can be leveraged by a peer to determine this support prior to establishing the connection. + +### 5.3.13 Connection Configuration + +QUIC allows a connection to be configured in a particular way with a set of transport parameters and frames. The transport parameters are exchanged in the cryptographic handshake. QUIC frames are used to configure how endpoints communicate. For example - the PADDING frame allow to vary the packet size, MAX\_STREAM\_ID frame indicates the maximum bidirectional or unidirectional stream ID permitted to open for the connection. Moreover, new transport parameters and frames can be added to extend the configuration. + +### 5.3.14 User-Land Implementations + +User space implementations of QUIC do not require elevated permissions. This allows application to include a QUIC implementation without any operating system changes. This simplifies deployment of QUIC, where only the application intending to use QUIC needs to be updated. This flexibility can also be used to fine tune the protocol behaviour to a particular application. However, there exists some risk with this, as even if an implementation is following the requirement of a certain QUIC version, the choices to optimize the implementation may result in poorer performance between two differently optimized implementations. Running separate QUIC applications in each application's user space has the impact on performance and resource efficiency in large-scale deployment scenario, which may not be a big problem for equipment with specific function in 5G Core. + +The implementation in user space also results in certain challenges that can affect performance. Efficiency of the API towards the UDP receive and send functions is one such case. Other complications can be access to high performance timers and operating system's scheduling granularity. + +### 5.3.15 Pluggable Sender Side Congestion Control + +As QUIC implementation can reside in an application, it allows more experiment with congestion control algorithms. QUIC can customise different congestion control algorithms for connections of the same application. Compare to TCP, pluggable sender side congestion control makes it pretty flexible and effective on updating or terminating congestion control algorithms without upgrading operation system. However, the fairness of the bandwidth competition within the same network among applications using different congestion control algorithms needs to be considered. + +Now depending on the operational environment, network and service requirement very specific congestion control algorithm can be deployed in the sender as long as the information in the acknowledgement from receiver is sufficient. + +### 5.3.16 Checking that the QUIC connection is alive + +Another difference with HTTP/2 is that each QUIC endpoint declares an idle timeout during the handshake. If the connection remains idle (no packets received) for longer than the advertised idle timeout, the peer will assume that the connection has been closed. + +HTTP clients are expected to use QUIC PING frames to keep connections open if necessary, to verify that their peers are still alive or to check reachability to the peer. Without using QUIC PING frames, an inactive connection will time out. The frequency of sending PING frames is controlled by applications. + +### 5.3.17 62 bits stream identifiers + +QUIC stream identifiers are coded as variable length integers allowing upto a length of 62 bits, instead of 31 bits with HTTP/2. Out of the available 62 bits for stream ID encoding, 2 least significant bits are used to indicate who initiates the stream (client / server) and whether the stream is unidirectional or bidirectional. Hence for client initiated bidirectional streams to carry the requests and responses of 3GPP Service Based Interfaces, the available space is $2^{60}$ stream IDs. + +**NOTE:** For variable length integer encoding the 2 MSB bits are used to derive the length of the integer. The 2 MSB bits are coded as base 2 logarithm of the total length of the variable length integer in octets. Thus for a 64 bit sized entity, the 2 MSB bits are 11 (i.e. value 3), indicating that the length of the integer is 8 octets of which only 62 bits are usable. See clause 16 and clause 2.1 of IETF draft-ietf-quic-transport [5]. + +Stream ID exhaustion becomes nearly impossible during the lifetime of a QUIC connection. This may simplify the management of connections in 5GC. + +### 5.3.18 Running atop of UDP + +QUIC protocol uses UDP for packet encapsulation, this design should not be understood to use UDP encapsulation to replace TCP in HTTP/2, and instead, the purpose is to ensure the QUIC packet passing through legacy middleboxes including OS, router, firewall and etc., transparently. However, due to DDoS attack avoidance, or other network operating consideration, network operators configure the network to limit the peak rate of UDP packets, which will heavily impact the exact performance behavior of QUIC and delay the popularity of QUIC deployment in particular districts. It could be a kind of deadlock for QUIC traffic being used in internet until HTTP/3 is wildly accepted. For SBI being used within Telco network, this will not be a big issue. + +## 5.4 Features of QUIC Applicable to 3GPP SBI + +### 5.4.1 General + +This clause reviews the features of HTTP/3 and QUIC that are applicable to 3GPP SBI and under which cases and conditions they are applicable. + +### 5.4.2 Framing and Multiplexing + +This feature allows QUIC to multiplex multiple streams in to a single connection and avoid head of line blocking. The upper layer protocols can use the QUIC transport in efficient ways to prioritize, parallelize and even cancel standing data sent or received without having to manage multiple connections. Hence, to get the most of a QUIC connection this feature is important. When it comes to SBI, there are definitely cases where one NF consumer will have number of multiple standing requests to one of the NF providers. The HTTP/3 and QUIC framing and multiplexing provides essential support to perform the task efficiently. The efficiency gain in HTTP/3 and QUIC, compared to HTTP/2 over TLS/TCP, exists only when the transport connection is subject to packet loss. This is when TCP's head of line blocking will not allow releasing received data to higher layer, even if the data is completely received for independent HTTP/2 requests or responses. + +### 5.4.3 Encrypted and Integrity Protected Transport details + +Encryption and integrity protection are a very important aspect of the whole SBI concept. 3GPP has mandated the support of TLS 1.2 or 1.3 for 5G core. The NF provider needs to be sure about the identity of the NF consumer before serving. Even though a higher layer authentication could serve the purpose of the NF consumer authentication, protection in the transport layer can be very important for a PLMN to function properly. Moreover, the SBI opens up the possibility to run packet core in a general-purpose cloud environment where the communication between inter PLMN and intra PLMN need to be secure and integrity protected. + +Having transport layer integrity and authentication mechanism the transport protocol is harden against both attacks and random corruptions that could affect the transport protocols action. For example, cryptographic integrity protection is many magnitudes better at detecting modifications of the transport protocol packet. Cryptographic integrity protection captures packet modifications of both random types, as well as hostile modifications, where checksums only have a weaker protection against random errors. This improvement prevents fouling up the transport protocol state, affecting + +performance and loss recovery. Data errors in IP/TCP packets that the TCP checksum fails to detect will result in the corrupt data being passed to TLS. TLS integrity verification of the TLS record will detect this corruption. Normally in this case, there are no alternative to terminating the TCP connection and restart it and re-issue the outstanding HTTP requests. QUIC's integrity verification will in this case only result in the individual packet being dropped, request retransmission, and not affect the connection state. + +### 5.4.4 Connection setup improvements + +QUIC can achieve faster connection establishment compared to TCP+TLS combination. The applicability of this features depends on the model is used for inter-NF communication. When long lived connection is used in between NFs which uses SBI for communication even if QUIC provides faster connection it will not impact the performance of the inter-NF communication significantly as only the initial request for a connection will see any improvement. However, if short lived connection models are used where NF-NF connection will be created for each request and response pair, QUIC will provide a faster experience of executing task via HTTP request/response as one or two RTT are saved. Overall the faster connection setup time will provide faster connection between NFs in start-up and/or recovery phase while lots of connection supposed to be made at once or in parallel. + +### 5.4.5 Connection ID and Connection Migration + +The connection ID provides certain flexibility in how the implementers realize front-end load-balancers for QUIC as the QUIC connection is not bound to 5 tuples (protocols and ports). In the case of SBI, both for cloud native implementation or bare metal implementation, this connection ID will provide the ability to establish network interface agnostic connection and move the connect between the interfaces as required without terminating the QUIC connection. + +Server-side migration is currently only specified to be done shortly after connection handshake using the Server Preferred Address mechanism discussed in Clause 9.6 of IETF draft-ietf-quic-transport [5]. This mechanism requests that the client sends the packet destined to the server to this preferred address instead of the original one. Future versions or extensions may specify mid connection server side migration. + +Client-side migration may occur at any point after the handshake has completed. This can be done intentionally by the client when another network interface has become available, where it first probes the new path from this other interface to the server, and after path verification starts using non-probing packet, thus completing the migration. It can also occur implicit, due to a NAT rebinding where the server-side observable source address and port has changed due to this rebinding. Here the use of non-probing packets results in immediate path migration to the new path, and at the same time the server initiates a path validation. + +### 5.4.6 Improved Recovery and Acknowledgement + +When the transport connection is subject to packet loss, QUIC recovery and acknowledgment mechanisms allow to optimally retransmit the lost frames and to avoid unnecessary retransmissions of data that have reached the receiver. + +## 5.5 Features of QUIC Not Applicable to 3GPP SBI + +### 5.5.1 General + +This clause reviews the features of QUIC that potentially are not applicable to 3GPP SBI and why they are not applicable. + +### 5.5.2 0-RTT DATA + +0-RTT Data has very limited applicability to 3GPP SBI for several reasons. The foremost is the security properties of 0-RTT data. As the 0-RTT data is protected using a Pre-Shared Key (PSK) and not a connection specific established state, the 0-RTT data is possible to replay by an adversary. It is also does not have full forward secrecy, i.e. if the PSK key is later compromised, then this message can be decrypted at that point. + +The possibility for replay has multiple impacts. If the HTTP request in the 0-RTT data was not idempotent then the state of the NF could be changed (so IETF draft-ietf-quic-tls [6] specifies that "0-RTT MUST NOT carry a self-contained trigger for any non-idempotent action"). Secondly, when replaying the order of requests can be changed by an + +adversary. Thus, changing the effect of them, e.g. moving a delete after a create. If multiple replays are allowed additional attacks are possible, including timing and measurement to attempt to determine other state. Overload concerns are also present both on the server side, as well as using 0-RTT as a method for amplifying the amount of data a spoofed source address attack results in. + +Due to that many 3GPP SBI requests are not idempotent the potential use of 0-RTT data is very limited. By not allowing its use at all several vulnerabilities are avoided, resulting in a safer and less complex systems as no mitigations are needed. + +In any case, given that the considerations on applicability of this feature are essentially related to security, it should be up to SA3 to determine whether it is recommended or not to use this feature in 3GPP networks; also, the recommendation may be dependent on intra vs inter -PLMN scenarios. + +## 5.6 Comparison of Applicable Features with Rel-15 Transport + +Table 5.6-1 provides a comparison of the features supported by HTTP/3 that are applicable to the 5GC SBI with HTTP/2 over TLS/TCP, based on the requirements from Transport Protocol for 3GPP 5GC SBI defined in clause 5.2 and additional evaluation criteria. + +**Table 5.6-1: Comparison of HTTP/3 and HTTP/2** + +| Requirement/ Evaluation Criterion | HTTP/2 over TLS/TCP | HTTP/3 | +|--------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| R1. Reliable message delivery | TCP supports reliable and order-of-transmission delivery of data. | QUIC supports reliable and order-of-transmission delivery of data per stream. | +| R2. Flow control and congestion control mechanism | Flow control is supported at connection and stream levels.

TCP provides end-to-end congestion control, but with significant throughput reduction in case of packet loss. | Flow control is supported at connection and stream levels.

QUIC supports advanced mechanisms for loss detection recommending TCP NewReno for congestion control. Implementations may use other algorithms.

QUIC treats a Congestion Explicit Congestion Notification (ECN) in the IP header as a signal of congestion. | +| R3. Support of connection semantics | One HTTP connection maps to one TCP connection. | One HTTP connection maps to one QUIC connection. | +| R4. Failure to deliver one message shall not block subsequent messages | Head-Of-Line (HOL) blocking occurs if TCP segments get lost, delaying the delivery of all subsequent HTTP requests/responses until the lost segments are retransmitted. | QUIC avoids blocking the delivery of data for any other streams when a packet loss contains only part of a stream.

How much benefits this brings depends on how much packet loss occurs in the network. | +| R5. Transport protocol supports mechanisms to authenticate peer endpoint and to secure transfer of application messages | Authentication and secure transfer of application messages are provided by TLS (unless security is provided by other means).

NF service access authorization relies on OAuth2 using TLS. | QUIC uses TLS 1.3 for key establishment, but it has its own encryption and integrity layer that protects the QUIC packets.

NF access authorisation is FFS. | +| A1. Framing and Multiplexing | HTTP/2 supports multiplexing multiple parallel requests in separate streams in a non-blocking fashion (at HTTP level) over the same TCP connection.

See also R4 for HOL at TCP level. | HTTP/3 supports multiplexing of multiple parallel requests in separate streams in a non-blocking fashion over the same QUIC connection. | +| A2. Connection Setup Improvements | 1 ½ RTT is required to setup the TCP connection. 1 ½ RTT is required to setup the TLS connection.

Clients can start sending HTTP requests after 1 RTT (without using TLS) or 2 RTT (with TLS). | By combining connection setup and TLS handshakes, QUIC improves connection setup latency and security allowing 0-RTT connection setup. However, the precondition of the improvement is that the NF service consumer has had an earlier connection with the NF service provider so that it can reuse the earlier learnt connection settings including the security keys for 0-RTT. When using stateless services, no earlier connection to the same service instance can be assumed. In addition, if the connection is persistent the impact of 0-RTT connection setup is minimal to the overall performance. | + +| | | | +|----------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| A3. Failover to Alternate Path |

TCP does not support multi-homing.

Failover to alternate paths can be supported by setting up additional TCP connections.

This requires the client to detect path failures (e.g. based on PING frames) and to switch to alternative TCP connection(s).
The server cannot send responses on an alternate path.

|

QUIC does not support multi-homing (like supported by SCTP).

QUIC supports client-side migration after the handshake has completed, and server-side migration shortly after the connection handshake, giving some flexibility to move the connection between interfaces without terminating the QUIC connection.

Failover to alternate paths can also be supported by using additional QUIC connections.

This requires the client to detect path failures (e.g. based on PING frames) and to migrate the connection to another network interface / local address, or to alternative QUIC connection(s).

There is no mechanism defined by QUIC that correlates heart beats and switching to failover paths; this has to be provided at the application layer.

The server cannot migrate the connection to a different network interface / local address during the lifetime of the connection.

The server cannot send responses on an alternative path, unless the client has migrated the connection on the client side.

| +| A4. Low Response Time |

Significant throughput reduction by TCP in overload and TCP head-of-line blocking are potential issues. See R4.

|

Throughput reduction due to congestion response for QUIC is similar to TCP's. QUIC based transport avoids head-of-line blocking. See R4.

| +| A5. Scalability | FFS | FFS | +| A6. Time of Availability of used standards | Already available. | Planned completion by July 2019. | +| A7. Ease of troubleshooting and Monitoring |

Many tools exist to trace/monitor HTTP REST APIs.

If TLS end-to-end encryption is used, this renders centralized logging at intermediates impossible.

An HTTP response follows the same path as its request as it is sent on the same TCP connection.

|

Many tools exist to trace/monitor HTTP REST APIs, but less widespread support for QUIC so far.

QUIC requires end-to-end encryption that would render centralized logging at intermediates impossible or much more complex. QUIC exposes a spin bit in short packet header to measure the RTT of a connection.

An HTTP response follows the same path as its request as it is sent on the same QUIC connection.

| +| A8. Ease of traversal of carrier-grade ALG/NAT/firewall |

Need to configure operator-grade firewalls to pass TCP/TLS/HTTP. For bidirectional communication, configuration for two connections may be required, but security gateways can reduce the number of required connections (see 3GPP TS 33.210 [24]).

|

Need to configure operator-grade firewalls to pass UDP/QUIC. For bidirectional communication, configuration for two connections may be required, but security gateways can reduce the number of required connections (see 3GPP TS 33.210 [24]).

| +| A9. Impacts to GSMA GRX/IPX |

Support being defined for Rel-15 (see GSMA NG 113 [25]).

| No HTTP/3 support so far. | +| A10. Use of proxies |

HTTP/2 supports the use of proxies in the path.

|

HTTP/3 Proxy functionality still at very early stage (see clause 6.2).

| + +| | | | +|--------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| A11. Idle HTTP connections | PING frames are used to test whether a connection is still alive. | PING frames are used to test whether a connection is still alive and to keep the connection alive.
QUIC endpoint declares an idle timeout during the handshake. If the connection remains idle (no packets received) for longer than the advertised idle timeout, the peer will assume that the connection has been closed. | +| A12. Availability of standard APIs (e.g. socket APIs) | Many libraries to choose from for HTTP/2. | QUIC support is not yet so widespread. | +| A.13 Stream IDs | HTTP/2 stream identifiers are coded with 31 bits. Stream IDs can exhaust during the lifetime of the HTTP/2 connection, which complexifies the management of connections. | QUIC stream identifiers are coded with 62 bits. Stream IDs exhaustion becomes nearly impossible during the lifetime of a QUIC connection, which simplifies the management of connections. | +| A14. Message Prioritization | Client and Server can set the priority of an HTTP request and response.

Multiple HTTP/2 connections between two HTTP/2 end points are necessary: one per DSCP value (see clause 6.8.8 of 3GPP TS 29.500 [4]), which complexifies the management of connections. | QUIC relies on receiving priority information from the application. QUIC frames do not allow to exchange priority information between peers.

Only the client is allowed to send HTTP/3 PRIORITY frames over the request or control stream.

There is an assumed integration between the HTTP/3 layer and QUIC to enable QUIC packet sender to prioritize the different streams based on what is configured on the HTTP/3 layer.

Multiple QUIC connections may still be necessary for messages with different SBI message priorities / DSCP to handle congestion control correctly, since using multiple DSCP on the same QUIC connection could confuse the congestion control algorithm, as it does not separate information on the different priority levels. The general problem is discussed in clause 5.1 of IETF RFC 7657 [29]. | + +# 6 HTTP/3 + +## 6.1 Introduction + +This clause will contain description about the mapping and usage of HTTP/3 including some of the not so well understood/documentated aspects. + +Figure 6.1-1 provides an overview of the HTTP/2 and HTTP/3 protocol stacks, highlighting key features of the HTTP and transport layers. See clause 5.3 for a detailed description of the QUIC features. + +![](79e1709a7317ead45379cbb8ff3ba802_img.jpg) + +| | | | | | | | | | | | | | | | | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|--------|-----|-----|----|----|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|--------|------|-----|----|----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +|

HTTP/2 layer

  • • Binary framing
  • Multiplexing (frames associated to streams)
  • • Header compression (static and dynamic tables): HPACK
  • • Stream based transfer with priority and stream concurrency control
  • • Flow control at connection and stream levels
  • • Server Push
|

HTTP/2 over TLS/TCP
(TCP connection)

Application
HTTP/2
TLS
TCP
IP
L2

HTTP/2
protocol stack

| Application | HTTP/2 | TLS | TCP | IP | L2 |

HTTP/3 over QUIC/UDP
(QUIC connection/UDP)

Application
HTTP/3
QUIC
UDP
IP
L2

HTTP/3
protocol stack

| Application | HTTP/3 | QUIC | UDP | IP | L2 |

HTTP/3 layer

  • • binary framing (modified HTTP frames)
  • • Header compression (static and dynamic tables): QPACK
  • • Server Push
  • • 1 HTTP transaction (without server push) maps to 1 QUIC stream

QUIC layer

  • • binary framing (QUIC frames)
  • Multiplexing (QUIC streams)
  • Protected transport (TLS)
  • TCP-like retransmission and congestion control
  • • Stream based transfer with priority and stream concurrency control
  • • Flow control at connection and stream levels
| +| Application | | | | | | | | | | | | | | | | +| HTTP/2 | | | | | | | | | | | | | | | | +| TLS | | | | | | | | | | | | | | | | +| TCP | | | | | | | | | | | | | | | | +| IP | | | | | | | | | | | | | | | | +| L2 | | | | | | | | | | | | | | | | +| Application | | | | | | | | | | | | | | | | +| HTTP/3 | | | | | | | | | | | | | | | | +| QUIC | | | | | | | | | | | | | | | | +| UDP | | | | | | | | | | | | | | | | +| IP | | | | | | | | | | | | | | | | +| L2 | | | | | | | | | | | | | | | | + +Figure 6.1-1 HTTP/3 vs. HTTP/2 protocol stacks + +## 6.2 HTTP/3 Proxies + +### 6.2.1 General + +HTTP clients can be configured to route their outgoing HTTP requests via a HTTP proxy. If the NF service consumer (i.e HTTP client) is configured to route its message via a HTTP proxy, the NF service consumer will try to setup a transport connection towards the proxy. If the NF service consumer knows that the proxy supports QUIC based on configuration or other offline means, the transport connection towards the HTTP proxy may use QUIC. Thereafter how the HTTP/3 proxy further communicates with the NF service producer for various scenarios are explained in the clauses below. + +![Diagram illustrating NF Service Consumer to NF Service Producer Communication with HTTP/3 Proxy on Path. The diagram shows four main components: NRF, HTTP Client – NF Service Consumer, HTTP Proxy, and HTTP Server – NF Service Producer. The NRF is at the top right. The HTTP Client is on the left, with a label 'Discover HTTP Proxy Transport Offline' above it. The HTTP Proxy is in the center, represented by a globe icon. The HTTP Server is on the right, also represented by a globe icon. Arrows show the flow: 1. HTTP Client sends 'Discover NF Service Producer Profile' to NRF. 2. HTTP Client sends 'HTTP/3' request to HTTP Proxy. 3. HTTP Proxy sends 'HTTP over TCP or QUIC?' response to HTTP Server. 4. HTTP Server sends a response back to HTTP Proxy. 5. HTTP Proxy sends a response back to HTTP Client.](e180f2b5fcbe8001554a7c0677cd3f82_img.jpg) + +``` + +graph TD + NRF[NRF] + Consumer[HTTP Client – NF Service Consumer] + Proxy[HTTP Proxy] + Server[HTTP Server – NF Service Producer] + + Consumer -- "Discover NF Service Producer Profile" --> NRF + Consumer -- "HTTP/3" --> Proxy + Proxy -- "HTTP over TCP or QUIC?" --> Server + Server --> Proxy + Proxy --> Consumer + +``` + +Diagram illustrating NF Service Consumer to NF Service Producer Communication with HTTP/3 Proxy on Path. The diagram shows four main components: NRF, HTTP Client – NF Service Consumer, HTTP Proxy, and HTTP Server – NF Service Producer. The NRF is at the top right. The HTTP Client is on the left, with a label 'Discover HTTP Proxy Transport Offline' above it. The HTTP Proxy is in the center, represented by a globe icon. The HTTP Server is on the right, also represented by a globe icon. Arrows show the flow: 1. HTTP Client sends 'Discover NF Service Producer Profile' to NRF. 2. HTTP Client sends 'HTTP/3' request to HTTP Proxy. 3. HTTP Proxy sends 'HTTP over TCP or QUIC?' response to HTTP Server. 4. HTTP Server sends a response back to HTTP Proxy. 5. HTTP Proxy sends a response back to HTTP Client. + +**Figure 6.2.1-1 NF Service Consumer to NF Service Producer Communication with HTTP/3 Proxy on Path** + +### 6.2.2 When NF Service Consumer Side Uses QUIC + +#### 6.2.2.1 Case A: Invoking http API Supporting Only TCP Transport + +This case is not described in IETF draft-ietf-quic-http [7]. + +In this scenario: + +- NF service consumer supports QUIC and has established a QUIC transport connection with its next hop HTTP proxy; +- NF service consumer discovers that NF service producer supports only TCP. +- The URI scheme of the API exposed by the NF service producer is http + +In this case, the NF service consumer has the following options: + +- Option#1: The NF service consumer uses TCP transport towards the proxy as well. This implies the proxy also supports TCP transport (which is a reasonable assumption considering that during the migration from TCP to QUIC many HTTP entities will support both transports). +- Option#2: The NF service consumer uses QUIC transport towards the HTTP proxy and the proxy uses TCP transport towards the NF service producer. The HTTP proxy discovers whether the NF service producer supports TCP or QUIC based on apriori connection setup. For example, in the case of SEPP all NFs in a PLMN connect to the SEPP and establish a HTTP/2 or HTTP/3 connection depending on what transport is supported by both the SEPP and the NF service producer. IETF draft-ietf-quic-http [7], clause 2.3 specifies that HTTP/3 clients shall indicate the target domain name during the TLS handshake of QUIC connection setup. The certificate provided at connection setup shall be valid for the target domain name. + +**Editor's Notes:** It is unclear what domain name shall be used for the target domain name when the connection is with a proxy (proxy domain name or the origin server one). + +The draft also says in clause 2.4 that a connection to a server endpoint may be reused for requests with multiple different URI authority components. The client may send any requests for which the client considers the server (the one at the existing connection endpoint) authoritative. + +**Editor's Notes:** In our case the client knows that existing QUIC connection ends at a proxy and not at a server. So it is unclear if we can reuse an existing QUIC connection to a proxy endpoint. Also it is unclear if a client can consider a proxy as an authoritative server as proxies and servers are essentially different HTTP entities. + +The draft loosely specifies in clause 2.4 how the client knows that the server at the endpoint of the reused QUIC connection (the proxy in our case) is authoritative for requests directed to other domains. It mentions that typically the client discovers that a particular server is the authoritative HTTP/3 endpoint based on the client having received Alt-Svc HTTP response header or the HTTP/2 ALTSVC frame (see IETF RFC 7838 [20]). + +**Editor's Note:** Whether other mechanisms other than use of IETF RFC 7838 [20] can be considered to discover a particular HTTP/3 endpoint is the authoritative endpoint for a URI authoritative component is FFS. + +Finally, the clients shall check that the nominated server can present a valid certificate for the Origin Server before considering it authoritative. Therefore, the HTTP proxy has to present a certificate to the HTTP/3 client on behalf of the HTTP Origin Server (NF service producer) that is valid for multiple domain names and signed by the client network's own certificate authority. In roaming, the client network owner (the VPLMN) and the origin server network owner (the HPLMN) are different authorities and such a certificate is impossible to issue by a regular certification authority (e.g. Verisign). The only possibility is that the HTTP client should be configured to trust the HTTP proxy as the certificate authority. Only then this option#2 will work. + +- Option#3: The NF service consumer uses QUIC transport towards the HTTP proxy. The proxy provides a certificate only valid for itself at QUIC connection setup. When the NF service consumer needs to send a request to an NF Service producer it first establishes a tunnel through the proxy by sending an HTTP CONNECT message in a new stream with an ":authority" pseudo-header field identifying the NF Service producer. The proxy then creates a TCP connection towards the NF service producer. Once the TCP connection is completed, a tunnel is created between the NF service consumer and producer. This tunnel is used by the NF service consumer to create a direct HTTP/2 connection (without an end to end TLS) with the NF service producer. HTTP/2 messages can now flow between the two entities. This is illustrated by the figure below. + +![Diagram showing the protocol stack and message flow for Option#3. An HTTP/3 Client connects to an HTTP/3 Proxy via UDP/QUIC. Inside the QUIC stream, an HTTP CONNECT request is sent. The proxy establishes a TCP connection to an HTTP/TCP Server. An HTTP/2 connection is then tunneled through the QUIC stream and TCP connection, carrying HTTP GET/PUT/POST/DELETE requests from the client to the server.](19a59d6b53059ebd27b13c98793f88e0_img.jpg) + +``` + +graph LR + subgraph "HTTP/3 Client" + UDP[UDP] + QTS[QUIC Transport Security] + QS[QUIC Stream] + H2C[HTTP/2 Connection] + H2S[HTTP/2 Stream] + end + + subgraph "HTTP/3 Proxy" + P[Proxy Logic] + end + + subgraph "HTTP/TCP Server" + TCP_S[TCP] + end + + UDP --- QTS + QTS --- QS + QS -- "CONNECT nf-producer.com" --> P + P -- "TCP" --> TCP_S + H2C --- H2S + H2S -- "HTTP GET/PUT/POST/DELETE" --> TCP_S + +``` + +Diagram showing the protocol stack and message flow for Option#3. An HTTP/3 Client connects to an HTTP/3 Proxy via UDP/QUIC. Inside the QUIC stream, an HTTP CONNECT request is sent. The proxy establishes a TCP connection to an HTTP/TCP Server. An HTTP/2 connection is then tunneled through the QUIC stream and TCP connection, carrying HTTP GET/PUT/POST/DELETE requests from the client to the server. + +**Figure 6.2.2.1-1: http via HTTP/3 Proxy to NF Service Producer Supporting TCP** + +NOTE 1: Option 3 is not described by IETF draft-ietf-quic-http [7] which only describes the use of the CONNECT method to setup a TLS session between an HTTP client and an Origin server. Most of the existing implementation also restricts the usage of CONNECT to https URIs. This option excludes the use of current implementations available on the market. However for 3GPP NF services, the HTTP clients will be the HTTP client libraries supported in various programming languages. One could program in such a way to use HTTP CONNECT via a proxy for http URI too. + +NOTE 2: IETF draft-ietf-quic-http [7] doesn't explicitly say if the verifications listed in clause 2.4 of the draft that authorize the reuse of an existing QUIC connection are applicable to the CONNECT method. + +#### 6.2.2.2 Case B: Invoking http API Supporting QUIC Transport + +In this scenario: + +- NF service consumer supports QUIC and has established a QUIC transport connection with its next hop HTTP proxy; +- NF service consumer discovers that NF service producer also supports QUIC. +- The URI scheme of the API exposed by the NF service producer is http + +In this case the NF service consumer uses QUIC transport towards the HTTP proxy and the HTTP proxy also uses QUIC transport towards the NF service producer. The QUIC connections on the both side of the leg of HTTP proxy are separate QUIC connections. As TLS is integrated in QUIC, this means this setup would also terminate the TLS at the proxy which is undesirable. In case of proxying with HTTP/2 only the TCP connection is terminated at the proxy but the TLS connection on top of TCP is end-to-end. + +The figure below illustrates the case where the HTTP client and server are connected with two QUIC connections through an HTTP proxy. + +The connection with the HTTP proxy would be reused for requests sent to multiple domains. When the proxy needs to forward a message to a new HTTP server, it establishes a new QUIC connection with it. The server provides a valid certificate for itself. + +![Diagram illustrating HTTP via HTTP/3 Proxy to NF Service Producer Supporting QUIC. The diagram shows an HTTP Client and HTTP Proxy within 'Domain name C'. The HTTP Client is connected to the HTTP Proxy via a red line labeled 'QUIC connections'. The HTTP Proxy is connected to four HTTP Servers: 'HTTP Server A1' and 'HTTP Server A2' within 'Domain name A', and 'HTTP Server B1' and 'HTTP Server B2' within 'Domain name B'. Each connection from the proxy to a server is a red line, indicating separate QUIC connections for each domain.](a3953dce8dbd7ef15d61a314dbef2cf9_img.jpg) + +``` +graph LR; subgraph Domain_name_C [Domain name C]; HC[HTTP Client] --- HP[HTTP Proxy]; end; HP --- A1[HTTP Server A1]; HP --- A2[HTTP Server A2]; subgraph Domain_name_A [Domain name A]; A1; A2; end; HP --- B1[HTTP Server B1]; HP --- B2[HTTP Server B2]; subgraph Domain_name_B [Domain name B]; B1; B2; end; +``` + +Diagram illustrating HTTP via HTTP/3 Proxy to NF Service Producer Supporting QUIC. The diagram shows an HTTP Client and HTTP Proxy within 'Domain name C'. The HTTP Client is connected to the HTTP Proxy via a red line labeled 'QUIC connections'. The HTTP Proxy is connected to four HTTP Servers: 'HTTP Server A1' and 'HTTP Server A2' within 'Domain name A', and 'HTTP Server B1' and 'HTTP Server B2' within 'Domain name B'. Each connection from the proxy to a server is a red line, indicating separate QUIC connections for each domain. + +**Figure 6.2.2.2-1: http via HTTP/3 Proxy to NF Service Producer Supporting QUIC** + +Case B is not described in IETF draft-ietf-quic-http [7] and the same questions regarding the QUIC connection with the proxy as specified for Case A remains open with Case B. + +As per IETF draft-ietf-quic-http [7], clause 2.4, a HTTP client MUST verify if the nominated HTTP server it is communicating with (i.e HTTP proxy in this case) can present a valid certificate for the origin before considering it authoritative. Hence in order to setup an end to end QUIC connection between the HTTP client and the HTTP server via a HTTP/3 proxy, an equivalent of HTTP CONNECT to setup a tunnel is required. Currently such an option does not exist. HTTP CONNECT is used only when the URI scheme is https and upon getting a HTTP CONNECT request a HTTP/3 proxy establishes a TCP connection with the HTTP server (and not a QUIC connection) as specified in clause 5.2 of IETF draft-ietf-quic-http [7]. + +NOTE: The use of HTTP CONNECT by HTTP clients when accessing https URI via a proxy is not mandated in IETF RFC 7231 [22]. However many browsers by default use HTTP CONNECT when accessing https URIs via a proxy. For 3GPP NF services, the HTTP clients will be the HTTP client libraries supported in various programming languages. One could program in such a way not to use HTTP CONNECT via a proxy and trust the certificates issued by the proxy effectively allowing the proxy to act as man in the middle. + +IETF draft-pardue-httpbis-http-network-tunnelling-01 [21] tries to provide a solution that permits a UDP-based HTTP/3 client behind an HTTP proxy to establish an HTTP/3 session with the origin. As the successor approach, IETF is reviewing a working group formation proposal to work on a HTTP based proxying solution for end to end encrypted traffic, named MASQUE [35]. This result of this working group will allow the end point to communicate with end to end QUIC encryption while use the proxy on the path. This means the HTTP client (consumer) will maintain a QUIC tunnelling connection towards the HTTP/3 proxy and inside that tunnel the consumer will have an end to end QUIC connection towards the HTTP server (provider). + +#### 6.2.2.3 Case C: Invoking https API Supporting Only TCP Transport + +In this scenario: + +- NF service consumer supports QUIC and has established a QUIC transport connection with its next hop HTTP proxy; +- NF service consumer discovers that NF service producer also supports only TCP. +- The URI scheme of the API exposed by the NF service producer is https + +In this case the following sequence of events happen + +- HTTP client establishes a QUIC connection with the HTTP proxy, if not setup earlier. +- HTTP client sends a HTTP CONNECT request to the proxy with ":authority" pseudo-header set to the NF service producer FQDN or IP address. +- HTTP proxy sets up a TCP connection with NF service producer (HTTP server). +- HTTP proxy sends a HTTP CONNECT response to the HTTP client. +- HTTP client does end to end TLS connection setup with the NF service producer. An encrypted tunnel between the client and the server is now setup and HTTP/2 connection can be setup on top. + +NOTE 1: The HTTP client has to do encryption twice - one for the TLS tunnel and one for the QUIC connection with proxy. + +NOTE 2: The current design of CONNECT-based tunnelling reserves an ordered byte stream (HTTP/2 and HTTP/3) for the client-to-proxy hop. This is subject to head of-line (HoL) blocking. See IETF draft-pardue-httpbis-http-network-tunnelling-01 [21] clause 3.6. + +This scenario is illustrated in the figure below + +![Diagram illustrating the tunneling of HTTP/3 traffic over TCP via an HTTP/3 Proxy. The diagram shows three main components: HTTP/3 Client, HTTP/3 Proxy, and HTTP/TCP Server. The Client sends a QUIC Stream with a CONNECT request for 'nf-producer.com' to the Proxy. The Proxy tunnels this request over a TCP connection to the Server, encapsulated in TLS and HTTP/2 Stream. The Server responds with HTTP GET/PUT/POST/DELETE.](90ddb84c323b956e2d50a54d3f870566_img.jpg) + +The diagram illustrates the network architecture for https traffic via an HTTP/3 Proxy. On the left, the **HTTP/3 Client** (blue hatched box) contains a **UDP** layer, which in turn contains **QUIC Transport Security**. Inside QUIC Transport Security is a **QUIC Stream** with a **CONNECT nf-producer.com** request. This stream is sent to the **HTTP/3 Proxy** (red hatched box). The Proxy tunnels the request over a **TCP** connection (yellow cylinder) to the **HTTP/TCP Server** (purple hatched box). The tunnel is secured with **TLS** and carries an **HTTP/2 Stream** with **HTTP GET/PUT/POST/DELETE** requests. + +Diagram illustrating the tunneling of HTTP/3 traffic over TCP via an HTTP/3 Proxy. The diagram shows three main components: HTTP/3 Client, HTTP/3 Proxy, and HTTP/TCP Server. The Client sends a QUIC Stream with a CONNECT request for 'nf-producer.com' to the Proxy. The Proxy tunnels this request over a TCP connection to the Server, encapsulated in TLS and HTTP/2 Stream. The Server responds with HTTP GET/PUT/POST/DELETE. + +**Figure 6.2.2.3-1: https via HTTP/3 Proxy to NF Service Producer Supporting TCP** + +According to RFC 7230 [23] clause 2.7.3, the client shall ensure that its connection to the origin server is secured through the use of strong encryption, end-to-end, prior to sending the first HTTP request when the https URI scheme is used. + +When an HTTP proxy is deployed, end-to-end security is ensured by setting-up a tunnel between the client and the Origin server using the HTTP CONNECT method which is then secured with TLS. + +A HTTP client implementation may decide not to enforce E2E security with TLS though the https URI scheme is used and connection to the Origin server is done via a proxy. IETF RFC 7231 [22] does not mandate the use of HTTP CONNECT for accessing https URI via a proxy. If a HTTP client decides not to use CONNECT, then it may trust the certificates issued by the HTTP/3 proxy on behalf of the HTTP/TCP server signed by the proxy's certificate authority, thus allowing the HTTP/3 proxy to act as man in the middle. This would violate the requirement for the HTTP client in RFC 7230 [23] clause 2.7.3. + +Alternatively the NF service consumer may decide to use TCP transport towards the HTTP/proxy similar to option#1 provided in clause 6.2.2.1. In this case, the NF service consumer avoids double ciphering. + +#### 6.2.2.4 Case D: Invoking https API Supporting QUIC Transport + +In this scenario: + +- NF service consumer supports QUIC and has established a QUIC transport connection with its next hop HTTP proxy; +- NF service consumer discovers that NF service producer also supports QUIC. +- The URI scheme of the API exposed by the NF service producer is https + +In this case the following sequence of events happen + +- HTTP client establishes a QUIC connection with the HTTP proxy +- HTTP client sends a HTTP CONNECT to the proxy with URI set to the NF service producer API URI. +- As specified in IETF draft-ietf-quic-http [7] clause 5.2, the proxy establishes a TCP connection to the HTTP server. However it is desirable that a mechanism is available for the HTTP/3 proxy to instruct the use of QUIC connection to a HTTP server instead of TCP. +- Currently there is no mechanism that exists in IETF draft-ietf-quic-http [7] where a HTTP/3 proxy is instructed to use a QUIC connection to a HTTP server instead of TCP. + +IETF draft-pardue-httpbis-http-network-tunnelling-01 [21] tries to provide a solution that permits a UDP-based HTTP/3 client behind an HTTP proxy to establish an HTTP/3 session with the origin. But at this moment this is an individual draft and is in very early stage. + +According to RFC 7230 [23] clause 2.7.3, the client shall ensure that its connection to the origin server is secured through the use of strong encryption, end-to-end, prior to sending the first HTTP request when the https URI scheme is used. + +A HTTP client implementation may decide not to enforce E2E security though the https URI scheme is used and connection to the Origin server is done via a proxy. IETF RFC 7231 [22] does not mandate the use of HTTP CONNECT for accessing https URI via a proxy. If a HTTP client decides not to use CONNECT, then it may trust the certificates issued by the HTTP/3 proxy on behalf of the HTTP/3 server signed by the proxy's certificate authority, thus allowing the HTTP/3 proxy to act as man in the middle. This would violate the requirement for the HTTP client in RFC 7230 [23] clause 2.7.3. + +### 6.2.3 When NF Service Consumer Side Uses TCP + +#### 6.2.3.1 Invoking http API Supporting QUIC Transport + +In this scenario: + +- NF service consumer supports only TCP and has established a TCP transport connection with its next hop HTTP proxy; +- NF service consumer discovers that NF service producer supports QUIC. +- The URI scheme of the API exposed by the NF service producer is http + +In this case the HTTP proxy has to act as a HTTP/TCP proxy on one side and as a HTTP/3 client on the other side. The proxy simply relays the message received on TCP connection to the QUIC connection. But in order for the proxy to setup a QUIC connection with the NF service producer, the proxy has to discover that the NF service producer supports QUIC. This can be achieved by using solution described in clause 8.2.2. This means the NF service producer also should support TCP. + +#### 6.2.3.2 Invoking https API Supporting QUIC Transport + +In this scenario: + +- NF service consumer supports only TCP and has established a TCP transport connection with its next hop HTTP proxy; +- NF service consumer discovers that NF service producer supports QUIC. +- The URI scheme of the API exposed by the NF service producer is https + +When https scheme is used, the HTTP client first sends a HTTP CONNECT request to the HTTP proxy. However as per IETF draft-ietf-quic-http [7], clause 5.2 and IETF RFC 7231 [22], clause 4.3.6, when a HTTP proxy receives a HTTP CONNECT method, it establishes a TCP based tunnel towards the NF service producer (the HTTP destination origin server) so that a TLS connection end to end from the HTTP client to the HTTP destination origin server can be setup. Since the semantics of HTTP CONNECT demands this, the HTTP proxy will not use QUIC towards the HTTP server (NF service producer) even if it supports QUIC. + +A HTTP client implementation may decide not to use HTTP CONNECT to access a https URI via a proxy. IETF RFC 7231 [22] does not mandate the use of HTTP CONNECT for accessing https URI via a proxy. If a HTTP client decides not to use CONNECT, then it may trust the certificates issued by the HTTP/3 proxy on behalf of the HTTP/TCP server signed by the proxy's certificate authority, thus allowing the HTTP/3 proxy to act as man in the middle. This would violate the requirement for the HTTP client in RFC 7230 [23] clause 2.7.3. + +## 6.3 Considerations for HTTP/3 + +### 6.3.1 General + +3GPP TS 29.500 [4] mandates HTTP/2 over TCP as protocols to be used for SBI. Running HTTP/3 requires special consideration as many of the HTTP/2 features can be taken care of by QUIC. HTTP/2 and QUIC contains similar features like stream, framing, multiplexing. Moving from HTTP/2 over TCP to HTTP/3 will require the application layer protocol behavior and implementation to be changed. Hence, it is important to identify the changes required both in HTTP/2 and QUIC implementations. This clause details the features and properties need special attention when HTTP/3 is used. + +### 6.3.2 Connection setup and management + +To use HTTP over QUIC requires explicit discovery of QUIC protocol support in the client and server. The server can advertise the support for the QUIC as a transport protocol then client can use some explicit information provided by the server or prior knowledge of the previous contact to the server to select QUIC as a transport protocol. Different alternatives to do the discovery of QUIC support in the NFs are discussed in clause 7.2. + +QUIC connection level settings are communicated between client and server at the crypto handshake. However, the HTTP/3 specific settings (see IETF draft-ietf-quic-http [7]) are set via SETTINGS frame sent by the client and server via the HTTP/3 control stream after QUIC connection is established. + +As QUIC allows stream multiplexing the HTTP clients can multiplex multiple HTTP/3 requests on to same QUIC connection as long as the server has the authority to serve the request. This reduces the need for multiple connections and improves performance by avoiding the time it takes to establish new connections. In case of SBI, every consuming NF will originate request to a specific provider NF. Hence, there will be one to one mapping between the server and origin. However, it is also possible to install a frontend proxy to hide a number of provider NFs that is managed by one administration. In this case the NF consumer will establish single connection towards the frontend proxy and multiplex request towards different NF providers over a single QUIC connection, treating the frontend proxy as a server endpoint. + +### 6.3.3 Streams, framing and multiplexing + +The QUIC stream number space is larger than that of HTTP/2. HTTP/3 uses a completely new framing concept. The HTTP/2 framing is completely changed, including the basic HTTP/2 Frame Header layout. Consequently HTTP/3 uses only the QUIC streams and does not have a stream Identifier in the HTTP/3 frame header.. + +Another important difference is the HTTP/3 only guarantee ordered delivery on the stream level while HTTP/2 expects absolute ordering on the frames across multiple streams. HTTP/3 will break any such ordering assumption. + +When HTTP runs over QUIC the HTTP layer does not require to do any stream multiplexing. QUIC maps each of its streams to a HTTP transaction. A stream is closed when the RESET\_STREAM is received in QUIC. In HTTP/2, a stream is half-closed when the frame with END\_STREAM bit set is received, and is closed when the RESET\_STREAM is received. The additional difference is that in the current specification, HTTP/3 does not use server initiated bidirectional stream. This means unidirectional streams are created from both the client and server with indication of the purpose of the stream as stream header at the beginning of the streams. All client initiated bidirectional streams are used for requests and responses. + +**Editor's Note:** Some aspects of connection management are still not clearly defined in the IETF drafts, such as the usage of client-initiated vs. server-initiated streams, and bi-directional vs. unidirectional streams. A more accurate description and analysis of these aspects is FFS, once the IETF drafts are further developed. + +The HTTP/3 frame type definition follows QUIC encoding concept. QUIC uses a variable length integer encoding which allows a larger number of stream IDs compared to HTTP/2 encoding. This change results in different HTTP/3 frame types and requires a mapping from HTTP/2 to HTTP/3 frame types. HTTP/3 (see IETF draft-ietf-quic-http [7]) defines this mapping of HTTP/2 over HTTP/3. + +### 6.3.4 Prioritization + +In case of HTTP/3 the clients can set stream priority as defined in IETF RFC 7540 [13], at the creation of the stream and update the priority using PRIORITY frame. However, in case of HTTP/3, only the client is allowed send PRIORITY frames over control stream. The priority clause on the HEADER frame is removed. + +### 6.3.5 Server Push + +HTTP/3 uses a different server push mechanism than what is defined for HTTP/2 in IETF RFC 7540 [13]. HTTP/3 uses two new frames to accomplish server push – a) a modified PUSH\_PROMISE frame and b) a MAX\_PUSH\_ID. The modified PUSH\_PROMISE frame does not refer to a stream as originally designed in IETF RFC 7540 [13], it uses as PUSH\_ID that uniquely identifies a server push. HTTP/3 defines the use of PUSH\_IDS in PUSH\_PROMISE frame, DUPLICATE\_PUSH frame, CANCEL\_PUSH frame and PRIORITY\_FRAME in addition to their use in Push Stream headers (a unidirectional server initiated stream) for now. The server can only push, and it can initiate pushing only one it receives a MAX\_PUSH\_ID frame from the corresponding client. Details of the modified server push mechanism is described in IETF draft-ietf-quic-http [7]. + +### 6.3.6 Compression (HPACK vs QPACK) + +The Header Compression for HTTP/2, HPACK (see IETF RFC 7541 [14]), provides compression of HTTP header fields. Significantly reducing the headers, especially for sequential HTTP/2 request responses to the same server, where repeated and redundant information is efficiently compressed. The use of HPACK in HTTP/2 is one of the more significant performance improvements compared to HTTP 1.0 or 1.1. HPACK was defined based on one important assumption, namely the TCP in-order delivery of the different HTTP/2 frame types across all the streams. Thus, the encoder knows in which order the decoder will receive and process the various frames, and how the decoder state will be updated. HTTP/3 does not provide the same deterministic and guaranteed in order delivery mechanism between different HTTP requests. HTTP/3 can avoid this head of line blocking and provide improved performance by delivering to higher layers the HTTP messages in the order they are successfully delivered to the peer. However, if one would use HPACK without modifications, this could result in the decoder blocking or producing the wrong output. Therefore, header Compression for HTTP/3, QPACK (see IETF draft-ietf-quic-qpack [10]), is being defined. + +QPACK is a redesigned version of HPACK that can support out-of-order delivery. It allows flexibility in the encoder to perform trade-offs between compression ratios and likelihood of head of line blocking due to out of order delivery. The changes in QPACK allows for much reduced head of line blocking at similar compression efficiency for a given packet loss rate. It also provides the implementation freedom to select how robust the transaction should be against packet loss. This at the cost of requiring HTTP/3 servers to implement the new QPACK mechanism, even if some reuse of the HPACK implementation is possible. + +# --- 7 Key Requirements for Supporting QUIC + +## 7.1 Introduction + +This clause contains the key requirements to be solved in order for QUIC to be considered as a transport replacement for 5GC SBI. For each of the key requirements listed below, solutions are described in clause 8. + +## 7.2 Discovery of QUIC support + +As Release 15 of 3GPP TS 29.500 [4] defines SBI implementation with protocol combination of HTTP over TCP, the deployment of QUIC as a replacement transport protocol for TCP will require a discovery method for the NF acting as HTTP client for both interoperability and backward compatibility. The discovery of a support of QUIC for a particular SBI must be done at the beginning of connection establishment and if QUIC is supported by the NF acting as server then QUIC should be used for all future communication towards that NF. + +## 7.3 Discovery of NRF's Support for QUIC + +One of the potential solutions for discovering the support of QUIC by an NF is to use the NF discovery service of the NRF (see clause 8.2.1). In order for an NF service consumer to use the NF discovery service of the NRF, the NF service consumer should know the transport protocol capability of the NRF itself. This key issue will address the following aspects: + +- How to discover the transport protocol capability of a NRF? +- How to provide the transport protocol capability of a remote PLMN NRF to a local PLMN NRF for home routed roaming scenarios? + +## 7.4 Migration to QUIC + +Since 5GC deployments based on release 15 will happen initially, any attempt to introduce NF service instances that support QUIC as transport protocol need to be carefully thought about in order to avoid interoperability issues. This key issue will study the following aspects with respect to the migration to QUIC. + +- Steps to follow when adding NF service instances that support QUIC as transport protocol, into the network. +- Deployment topologies where NF service instances that support QUIC as transport protocol can be introduced. +- When the NF service consumers can use the added NF services supporting QUIC? +- Steps to follow to decommission NF services that support TCP, when required. + +## 7.5 Support of Indirect Communication + +Indirect Communication refers to the communication between a NF Service Consumer and an NF Service Producer using a Service Communication Proxy (SCP), in the Rel-16 Service Based Architecture. + +Indirect communication may be supported (see 3GPP TS 23.501 [2]): + +- without delegated discovery (Option C): Based on query result, the consumer does the selection. The consumer sends the request to the SCP containing the address of the selected producer (e.g. an NF instance or NF Service instance set), the SCP may select an instance and it routes the request to the targeted producer instance. +- with delegated discovery (Option D). Consumers do not do any discovery or selection. The consumer adds any necessary discovery and selection parameters required to find a suitable producer to the request. The SCP uses the request address and the discovery and selection parameters in the request message to route the request to a suitable producer instance. In both options, the SCP needs to access and optionally modify the contents of the HTTP messages exchanged between the NF Service Consumer and NF Service Producer. This entails that the HTTP/3 connection cannot be established end to end between the NF Service Consumer and NF Service provider. Instead, standalone HTTP/3 connections need to be set up between the NF Service Consumer and the SCP, between the SCP and the NF Service Producer, and between SCPs if there is more than one SCP between the NF Service Consumer and NF Service Producer. + +This key issue will analyse how to support HTTP/3 for Indirect Communication. + +NOTE: See clause 6.2 for a general description of HTTP/3 in presence of proxies on the path. + +# --- 8 Solutions for Key Requirements + +## 8.1 Introduction + +This clause contains the solutions for the key requirements identified in clause 7. + +## 8.2 Solutions for Discovery of QUIC support + +### 8.2.1 Using the Discovery Service of the NRF + +Using the Discovery Service of the NF Repository Function (See 3GPP TS 29.510 [19]) is a possible solution for discovering if a NF instance's SBI supports using QUIC as transport protocol. + +When a consumer is performing service discovery of NF instances for a service, it will also learn which if any of the instance support using QUIC by having IpEndPoint definitions in the NFProfile with the transport protocol set to QUIC. + +This solution enables the NF consumer to know of the support even prior to attempting to establish a transport connection to the NF producer. The consumer has to use the NRF service discovery irrespectively of the determination of QUIC support. + +The realization of this solution requires definition of the QUIC as TransportProtocol in the NFProfile, see clause 6.1.6.3.5 of 3GPP TS 29.510 [19]. + +The solution will have to determine if this discovery should be only for a general support of QUIC independent of version or if also all the versions should be encoded in the NFProfile. + +A QUIC supporting NF can potentially support several different versions of QUIC, thus efficient enumeration of versions would be desired. + +However, assuming that at least one mandatory to implement version of QUIC will be defined for SBA, it might be sufficient to simply indicate that QUIC in general is supported and rely on the version negotiation mechanism built in in QUIC as that would also avoid any interoperability issues. + +For consumers of NF services that specifically want to determine which instances that support QUIC, extending the set of query parameters defined for the Nnrf\_NFDiscovery Service API (clause 6.2.3.2.3.1 of 3GPP TS 29.510 [19]) will be needed. + +A parameter such as transport-protocol which takes an array of protocol enumerations would solve this issue. + +Here enumerating individual QUIC versions would create some extra complexity. + +### 8.2.2 Using Alt-Svc Header + +The current QUIC working group draft on HTTP over QUIC (HTTP/3) (See IETF draft-ietf-quic-http [7]) defines a discovery method of QUIC support using Alt-Svc HTTP response header defined in IETF RFC 7838 [20]. In this case the NF as HTTP server can notify the NF as HTTP client about the support of QUIC protocol with a HTTP response header with any HTTP response. An example of such response will look like below: + +``` +HTTP/1.1 200 OK +Content-Type: text/html +Alt-Svc: h3=":50443";quic="1,labadaba" +``` + +Here, the "h3" is the ALPN token identifies HTTP/3 and "quic" is a new parameter defined to advertise the versions supported by the NF. The syntax of Alt-Svc is defined in IETF RFC 7838 [20] and the "quic" parameter for Alt-Svc header to provide the QUIC version hints, is defined in HTTP/3 IETF draft (See IETF draft-ietf-quic-http [7]). + +In this method, the HTTP client acting as NF consumer needs to start connection using TCP for the first contact with a HTTP server acting as NF provider. If the HTTP server response includes the Alt-Svc header then the HTTP client will re-establish HTTP connection over QUIC and save the protocol preference for further connection. After new QUIC connection established towards the HTTP server, the HTTP client must send all the requests over QUIC connection. The HTTP client then can terminate the previously established TCP connection. + +As described, the downside of this method is that the HTTP client for the first contact with a HTTP server has to establish TCP connection to discover the QUIC support and terminate the already established TCP connection. However, this should be only one-time event after discovering that one HTTP server supports QUIC the client must not repeat this discovery event. + +This method allows a gradual deployment of QUIC in the PLMNs and does not require extra information exchange at the NF service discovery phase. + +This solution requires that the HTTP server (NF Service Producer) can be reached over TCP in addition to QUIC, so a server supporting only QUIC would need additional mechanisms to let NF Service Consumers discover such support. + +### 8.2.x Solution#x + +## 8.3 Solutions for Discovery of NRF's Support for QUIC + +### 8.3.1 Providing NRF Transport Capability from NSSF + +When network slicing is used, the NSSF is queried during + +- Registration procedure; and/or +- PDU session establishment procedure + +to select a network slice instance for the UE / PDU session. The NSSF may optionally return the network slice instance information (NsiInformation) which contains the NRF URI to be used for that network slice instance. In this solution it is proposed to return the NRF's transport capability also as part of the NsiInformation so that the NF service consumer that gets the NRF information from the NSSF knows which transport protocol(s) can be used towards the NRF. + +The NSSF is provided the transport capability of the NRF when OAM configures the network slice instance information into the NSSF. + +### 8.3.2 Providing Remote PLMN NRF's Transport Capability during NF Discovery + +For home routed scenarios, the NRF in VPLMN contacts the NRF in HPLMN, via the SEPP. The issue of how HTTP requests over QUIC are routed when there is a proxy in between (i.e if SEPP acts as a proxy) are specified in clause 6.2.2. Irrespective of the kind of solutions available for this issue, it may be required for the NF service consumer in VPLMN to provide the transport capability of the HNRF to the VNRF. This solution proposes the following: + +- An NF service consumer in VPLMN discovers the NRF to use in VPLMN and the HPLMN for home routed scenarios by querying the NSSF or by local configuration. If the NSSF is queried, the NF service consumer obtains the transport capability of the VNRF and the HNRF from the NSSF as specified in subclause 8.3.1. + +NOTE: As specified in clause 4.3.2.2.3.3 of 3GPP TS 23.502 [3], the discovery of VSMF/VNRF and HSMF/HNRF happen as separate procedures. The Nnssf\_NSSelection\_Get service is invoked twice in this case. + +- Once the transport capability of both the VNRF and the HNRF are obtained, the NF service consumer knows which transport to use towards the VNRF. +- When the NF service consumer invokes the NF discovery service of the VNRF, it also provides as input the transport capability of the HNRF. +- The VNRF uses this information together with the information about the transport capabilities of the SEPP, taking into consideration the scenarios specified in clause 6.2.2, to decide which transport to use for contacting the HNRF. + +### 8.3.3 Discovery Based On Local Configuration + +In this solution, the transport capability of the NRF is discovered based on local configuration at the NF service consumer. This solution can be used when network slicing is not used or during scenarios where the NSSF is not involved (e.g AMF does network slice selection based on local configuration). + +## 8.4 Solutions for Migration to QUIC + +### 8.4.1 Deployment Topologies to Introduce NF Services with QUIC Support + +As identified in clause 6.2, HTTP/3 message traversal for http scheme APIs when a HTTP/3 proxy is involved on path is not yet clearly addressed in IETF. Similarly for https scheme APIs, the use of HTTP CONNECT from the HTTP client to the HTTP proxy, creates a TCP connection from the HTTP proxy to the NF service acting as HTTP server resulting in an end to end TLS connection from the HTTP client to the HTTP server. In this case also the presence of HTTP proxy on path implies that an NF service acting as server cannot use QUIC for https scheme APIs, until alternate mechanisms as discussed in IETF in IETF draft-pardue-httpbis-http-network-tunnelling-01 [21] reach some maturity. + +Considering this the following are the deployment topologies where NF services with QUIC support can be introduced into a network without causing any issues in working towards a HTTP client. + +- Intra PLMN NF service communication without any HTTP proxy as intermediaries. +- QUIC between HTTP client and HTTP proxy while TCP is used between HTTP proxy and the HTTP server (see Option#3, clause 6.2.2.1 and clause 6.2.2.3). + +**Editor's Note:** The benefit of using QUIC with HTTP proxy and TCP on the other side is FFS. + +For inter PLMN HTTP/3 messaging, SEPP is involved and the transport connection will have to terminate at SEPP. Hence an NF service consumer at VPLMN need to only consider the transport capabilities of SEPP and not the transport capabilities of the NF service producer in HPLMN. Irrespective of whether the NF service producer in HPLMN supports TCP or QUIC, as long as the NF service consumer in the VPLMN understands the API version of the NF service producer, it uses the transport protocol that it supports towards the SEPP in VPLMN. + +### 8.4.2 Steps to Follow When Introducing NF Services with QUIC Support + +The following steps have to be followed while introducing NF Services with QUIC support in a PLMN. + +- The support for QUIC of the NF services shall be discoverable using one or any of the mechanisms mentioned in clause 8.2. +- Existing, NF service consumers that are already using TCP towards other NF service providers shall continue to use TCP, until they are upgraded to support QUIC. +- NF services that support QUIC, may also support TCP in order to interwork with existing TCP based NF service consumers. + +### 8.4.3 Use of QUIC by NF Service Consumers + +An NF service consumer that supports QUIC can use QUIC towards NF service producers that support QUIC after ensuring the following: + +- The support of QUIC by the NF service producer is discoverable. +- There are no HTTP proxies on path or the HTTP proxy on path supports QUIC and HTTP CONNECT. + +### 8.4.4 Decommissioning TCP + +When all the NF services in a PLMN are upgraded to support QUIC a PLMN may consider to decommission the use of TCP transport. The following steps need to be followed while decommissioning + +- Ensure that no NF service consumer is still using TCP towards the NF service for which TCP is to be decommissioned in that PLMN. +- If TCP is to be decommissioned for use by a SEPP in a PLMN, then ensure that all the other SEPPs it is interacting with support QUIC and there are no IPX on path. + +- No NF service instance in the PLMN is using the solution described in clause 8.2.2 for the discovery of QUIC support. + +It is recommended that TCP is not decommissioned until it is identified that there is no need for it within a PLMN. + +## 8.y Evaluation and Conclusion + +# --- 9 Impacts to Service Based Architecture + +## 9.1 Introduction + +This clause identifies the impacts of introducing QUIC to service based architecture for which solutions can't be provided in 3GPP scope. + +## 9.2 HTTP Proxy Traversal + +As described in clause 6.2, IETF has not yet clearly specified how HTTP/3 works when there are proxies on path. The current drafts only define the use of HTTP CONNECT method from the client to the proxy and TCP thereafter. Hence at least until a solution for the use of hop by hop QUIC when HTTP proxies are involved is well specified in IETF, QUIC cannot be used in deployments where HTTP proxies are acting as intermediaries between NF services. + +**Editor's Note:** Other impacts are FFS. + +**Editor's Note:** Whether a specific action be sent to IETF is FFS. + +## 9.3 QUIC's Security Mechanisms + +QUIC as currently specified do not support any unencrypted mode, nor unauthenticated. This have several implications on the SBA architecture. Some of them have already been touched upon before. + +- There is a requirement (see clause 2.3 of IETF draft-ietf-quic-http [7]) of explicitly addressing the QUIC peer when establishing a connection and include the target domain in the TLS handshake using SNI or other mechanism. This prevents any type of transparent HTTP proxies, and the next hop must always be known by the client. +- Use of any HTTP proxy will require additional functionality as discussed in Clause 9.2 and where only the one type of proxying, i.e. the use HTTP Connect method to establish end-to-end TLS connections over TCP from proxy to designated target domain. The other proxy cases discussed in Clause 6 lacks mature specifications. The current implication is that to enable QUIC in Release 16 SBA Architecture needs to be capable of operating without any HTTP proxies. +- Potential use of HTTP opportunistic security (IETF RFC 8164 [28]) for any "http" scheme requests over QUIC. This requires an additional QUIC connection as "http" scheme requests and "https" scheme requests are not allowed in the same connection (see clause 2.2 of IETF RFC 8164 [28]). It also requires additional HTTP server support to indicate this capability. This could enable QUIC migrations even if there are still some SBIs that doesn't support "https" scheme requests. However, if such interfaces exist it would be seurer to upgrade them to support "https" scheme. + +To summarize, with the current version of QUIC and HTTP/3 the 3GPP SBA architecture needs to assume that all requests and SBI will only use "https" scheme requests, that they will explicitly address the target NF, and that there is no possibility to deploy HTTP Proxies or other intermediaries acting above UDP layer in between NFs. + +## 9.4 TCP Decommission in Migration Impacts Architecture + +As discussed in Clause 8.4.4 there are certain requirements to enable decommissioning of TCP in a migration to QUIC. This also have certain architectural impacts. It requires a possibility to perform the first request to any NF using QUIC. + +The current specifications in IETF are not yet addressing such use cases, instead they assume that one will start with retrieving alt-svc information using HTTP over TCP and TLS. Thus, to support TCP decommission there need to be specified how one instructs a client to use QUIC directly to query without any prior alt-svc phase, primarily to issue requests to the NRF. The NRF can then likely function as solution for learning that QUIC is required for the other NFs. + +## 9.5 Transport Proxy Traversal + +TCP transport proxies may be deployed on the path between HTTP clients and servers in order to optimize transport on heterogeneous networks (e.g. satellite networks). They operate the flows based on TCP headers information without interfering with the HTTPS layer. QUIC breaks this layering as the transport and the HTTPS parts cannot be dissociated. As such the transport optimization proxy function will not be possible with QUIC. + +## 9.6 Impacts on Troubleshooting + +### 9.6.1 Introduction + +This clause aims at highlighting the main impacts of QUIC introduction on maintenance and troubleshooting at network level and application level. + +Indeed, in order to improve end-to-end protection, TLS 1.3 and QUIC enforce the usage of ephemeral cipher suites and Perfect Forward Secrecy (PFS). The latter prevents an attacker that managed somehow to steal the private key of a server from decrypting the content of exchanges she/he captured in the past. In practice, the existing OAM (Operation And Maintenance) solutions which are designed to work for RSA cipher suites would hence not be able to troubleshoot PFS traffic. This clause also details the impacts of using QUIC-based signalling protocol stack between two 5G NFs for the cases introduced in annex E of 3GPP TS 23.501 [2]. + +The following three clauses point out the main identified impacts of QUIC on network level and HTTP/3 level troubleshooting. + +### 9.6.2 QUIC keying impact + +QUIC decryption is per design trickier than TLS, including TLS 1.3, because each QUIC connection has at least 3 keys (0-RTT key, 1-RTT key, packet number encryption key) and also because 1-RTT key may change dynamically. + +### 9.6.3 Network level troubleshooting + +The following impacts are foreseen for network level troubleshooting: + +- QUIC replaces both TLS and TCP. One of the main differences indeed is that QUIC encrypts the transport header in addition to the payload, which is highly relevant for the network level troubleshooting matters. The existing Network OAM (Operation And Maintenance) solutions which are designed to make use and act on TCP headers would hence not be able to troubleshoot QUIC traffic and even less be easily adaptable to perform this task. +- Moreover, QUIC includes an optional measurement bit, named spinbit, which allows in-path probes to measure both the round trip delay and the decomposition of the delay on both sides of symmetrical path. This is directly usable for options A and B for monitoring and troubleshooting the performance of the network between two NFs. Its usage for the options C and D though requires additionally the mapping of the observations on both legs of the SCP. +- As of version 19, QUIC specifications do not support packet loss measurements. Indeed, packet loss measurements by probes located on the path requires multiple probes and has more limited scope, which hence makes it much harder and resource demanding. Its deployability has still to be demonstrated. +- So as to enable an in depth analysis of the performance (e.g. flow control, etc.) between a consumer NF and a producer NF, the decryption of the entire QUIC message is often required in order to read the transport parameters of the QUIC packet header. Contrary to HTTP/2 over TLS, this has the side effect of decrypting and revealing application layer information to network probes. + +NOTE: QUIC level logging techniques are also possible for these purposes but are currently not mature enough and are not yet considered for inclusion in QUIC IETF specifications. + +- As already mentioned, options C and D flow control troubleshooting would also require streams identifiers mapping in order to get an end to end view. + +### 9.6.4 Application level troubleshooting + +The identified impacts on application level troubleshooting are depicted hereinafter for each one of the four communication options defined in annex E of 3GPP TS 23.501 [2]. + +- Option A - Direct communication without NRF interaction: + +Analysing the exchanges between a consumer NF and a producer NF requires the decryption of QUIC traffic. Debugging currently relies on the analysis of the exchanges captured by probes. As QUIC imposes the usage of PFS, the decryption of PFS traffic by a probe requires the communication of the set of session keys to the probe by one of the peers. This would hence increase the complexity of the OAM (Operation And Maintenance) solutions. + +NOTE: TLS 1.3 also mandates the use of PFS. However, the main difference with QUIC / HTTP/3 is that TLS usage is not mandatory in the current version of the specifications for HTTP/2. + +- Option B - Direct communication with NRF interaction; + +Same as option A. + +- Option C - Indirect communication without delegated discovery; + +In this option the signalling path is made of at least two legs and QUIC is hence on at least one side of the SCP. + +- When QUIC is used only in one leg of the communication path, the other side may be HTTP/2 in the clear, HTTP/2 encrypted over TLS or in a hop by hop tunnel like IPsec. When carried over TLS, HTTP/2 can use either TLS 1.2 or TLS 1.3 versions. + +As the signalling path is made of at least two legs, application level troubleshooting by external tools would require the support of the cypher suites in use and the credentials of the two sessions so as to be able to decrypt the messages exchanged and the mapping of QUIC and HTTP/2 stream identifiers. + +- Case where QUIC is used in both legs: + +There is only one version of HTTP/2. Versioning is a feature of QUIC though. Consequently, the application level troubleshooting tools must be able to decode, map and synchronize exchanges of different versions of QUIC. + +- Option D - Indirect communication with delegated discovery. + +Same as option C. + +# --- 10 Current Implementation and Maturity Status + +## 10.1 Introduction + +Being a newly developed transport protocol the viability of considering QUIC in 5GC service based interfaces has to be gauged by the current implementation and maturity status. This clause describes the current stats of QUIC from the best of the knowledge point of the view. + +## 10.2 Implementation maturity + +TCP implementations are very mature. Most of the features has been widely used and issues has been resolved in the implementations and standards. Right now, this cannot be said for QUIC implementations and standard. As the specification has not been finished yet, the QUIC implementations will be very new. IETF QUIC working group has given lots of emphasis on interoperability testing on QUIC features. Number of opensource projects of implementing QUIC has passed the interoperability testing. However, those opensource projects usually put emphasis on particular features of interest from the implementer hence cannot be treated as production ready or assuming to have all the featured required. It is expected that QUIC implementations will have a higher degree of issues caused by mistakes and errors in implementation. + +## 10.3 Hardware offload support + +A server's capability to handle certain amount of load can be improved by having protocol off-load function in network interfaces (NIC). For TCP, this include checksum off-loading, segmentation offloading, and crypto offloading. These functions improve the performance of the server. TCP sending operation's CPU utilization can be reduced 50 times if TCP segmentation offloading (TSO) is used compared to standard TCP configuration. While TCP offload functions are existing and available in numerous NICs, there is significant uncertainty about what functions that are possible to implement for QUIC and according to which road-maps they will be implemented in server hardware. + +When it comes to crypto acceleration via hardware offload there are both large commonalities and differences between TCP and QUIC. Both are based on TLS, but QUICs protection of its frames are using a QUIC specific format, but for modern implementations both are likely to use the same crypto primitives, i.e. most likely AES-GCM (see IETF RFC 5288 [31]) that is highly performant in a number of more capable CPUs due optimized functions. However, any more dedicated crypto off-load may be missing for QUIC. + +There has also been significant discussion in the QUIC working group mailing list about the cost of doing the packet number encryption and decryption. An encrypted packet number requires to be first decrypted before the correct initialization vector for the rest of the packet can be produced. This has been criticized in the QUIC WG for making off-load processing more difficult and require multiple stages. + +## 10.4 UDP Performance in Operating System + +The current QUIC implementation uses UDP socket APIs to send and receive QUIC traffic. Compared to TCP implementation in different operating systems, UDP implementation is not that performant. It has been reported in IETF QUIC working group mailing list that for the UDP send cost the CPU consumption could be up to 50% while crypto operation is less than 10%. Google has also reported that with possible optimization, they were able to reduce QUIC's CPU cost from 3.5 to 2 times that required for TLS/TCP when serving YouTube traffic (see "Developing and deploying a TCP replacement for the Web" [32]). + +Experiments show that a standard TCP configuration gains almost 5x speed-up over UDP in terms of cycle cost (see "Optimizing UDP for content delivery" [33]). Such gains for TCP come from the support of TCP segmentation offload (TSO) that allows the application to send larger data packet than the path Maximum Transmission Unit (MTU). TSO requires hardware support from the NICs. However, Generic Segmentation (GSO) can also perform segmentation to emulate TSO. TCP has support from both TSO and GSO. Recent experiments show promising results for UDP segmentation offloading with hardware support (see "UDP segmentation offload" [34]). UDP GSO is also available for Linux kernel and can be used via interfaces but need extensive configurations and understanding of link layer properties. The TSO operates on sender side and create a specific profile of traffic in the network. Because of that optimization can be achieved at the receiver side by consolidating multiple MTU packet side into fewer large one. Large receive offload (LRO) and generic receive offload (GRO) is used to achieve this optimization for TCP. The same is not available for UDP now. There are reports on work in progress on UDP GRO. To achieve high performance over UDP socket for SBI (some of the SBI message sizes may be large, potentially up to a maximum of 2 MB), different optimized configurations are needed and those optimizations need to be available in different operating system. + +This UDP performance issues can eventually be overcame. There are already several techniques like UDP GSO, GRO (Generic receive offload), zero copy that can help achieving performant UDP operation and networking. As these techniques are at their early stage, the UDP performance issues need to take into consideration when selecting transport protocol for service based interfaces. + +# 11 Evaluation and Conclusion + +## 11.1 Interim Evaluation + +**Editor's Note:** this is an interim evaluation at the current stage of the TR. This evaluation may be subject to changes as the study further progresses. + +### 11.1.1 Requirements for Service Based Interfaces + +QUIC fulfils the transport requirements (REQ#1 to REQ#5) identified in clause 5.2 for the 5GC Service Based Interfaces. + +Using HTTP/3 instead of HTTP/2 does not change the semantics of the NF Services and does not change the API. No changes are expected either on the OpenAPI specification to support HTTP/3. + +The study needs to proceed to define how to support Indirect Communication in the 5GC with Service Communication Proxies (SCP). + +### 11.1.2 Expected improvements + +Clause 5.4 identifies features of QUIC (HTTP/3) that would be applicable to the 5GC Service Based Interfaces; the following potential (performance) improvements are anticipated in comparison to HTTP/2: + +- 1) QUIC allows to overcome HOL blocking from which HTTP/2 is suffering if a TCP packet is lost or becomes corrupted; +- 2) loss detection mechanisms of QUIC are using more accurate means to indicate lost bytes and RTT measurements resulting in assumedly more efficient recovery mechanism; +- 3) faster connection establishment compared to TLS/TCP (1 RTT instead of 2), for short lived connections; however, when using persistent connections, this will not lead to a performance improvement; +- 4) the connection may be migrated to a different network interface or local address by the client during the lifetime of the connection or by the server during the connection establishment. + +### 11.1.3 Issues + +Following issues are identified: + +- 1) The QUIC layer is end-to-end encrypted and use of proxies between end-to-end QUIC connections is not sufficiently covered. There is no support for instance to support an end-to-end QUIC connection through a proxy using HTTP CONNECT. +- 2) The QUIC layer is end-to-end encrypted and thus allows less accurate network monitoring capabilities than TCP. +- 3) The server cannot migrate the connection to a different network interface / local address during the lifetime of the connection; this requires clients to still rely on alternate QUIC connections for failover to an alternate path; also solutions for ensuring availability and stability of connections (e.g. failover to a secondary path like supported in SCTP multi-homing) are not provided at the QUIC protocol layer but have to be implemented at the application layer similar to HTTP/2. +- 4) IETF draft-ietf-quic-recovery [8] provides recommendations on congestion control (e.g. TCP NewReno). According to IETF draft-ietf-quic-recovery [8], implementations may use other congestion control algorithms than TCP NewReno and endpoints MAY use different algorithms from one another. Some measurements have shown that QUIC can overtake TCP in terms of how much bandwidth it can take leading to unfairness even if the congestion algorithm is the same (see e.g. "Taking a Long Look at QUIC" [30]). This leads to possible concerns on how fairly QUIC traffic mixes with TCP traffic, as this would be the case e.g. during migration scenarios (see clause 8.4). The issue becomes more complicated when mixing different congestion algorithms and deserves more experimentation. + +### 11.1.4 Other considerations + +Following considerations also apply: + +- 1) QUIC (HTTP/3) requires extensive changes to the HTTP protocol stack (compared to HTTP/2), by moving and combining several features from the HTTP/3 and TLS layers into the QUIC layer. The header compression mechanism is re-designed to support out-of-order delivery. The application is also impacted, e.g. socket APIs of the HTTP layer, discovery of QUIC support, co-existence of HTTP/2 and HTTP/3 capable NFs. +- 2) QUIC (HTTP/3) security aspects need to be assessed by 3GPP SA3, e.g. options exist for connection establishment and connection migration, end to end security with proxies on the path, inter-PLMN signalling and N32 interface, use of OAuth with QUIC, etc. +- 3) The definition of HTTP/3 and QUIC is still in progress in IETF, and it is open whether the specifications would be mature enough for adoption of the protocol in the 5GC in Rel-16; +- 4) It is open when industry grade stacks (for use in 5GC) will be available. Existing implementations of QUIC are still very immature and do not have the full QUIC features available (e.g. congestion control). +- 5) Due to experimental nature of current implementations there are yet no reference API which would be required for application level interoperability. The current existing implementations allow only basic proof of concepts testing but not load or stress testing of different features. +- 6) There are no standard APIs (e.g. socket APIs) for QUIC connection setup. Though there are different open source implementations of QUIC, there is a lack of uniformity in terms of the interface they expose towards application for QUIC connection setup and hence as of now implementation portability is a concern. + +## 11.2 Interim Conclusion + +**Editor's Note: this is an interim conclusion at the current stage of the TR. This conclusion may be subject to changes as the study further progresses.** + +QUIC provides some new promising features especially in terms of performance increase for current Internet type of traffic (web-based client-server). It should be carefully checked whether those improvements can also be harvested in 5G signalling environment. Intensive testing, however, is only possible when HTTP/3 and QUIC specifications and implementations are mature enough (see clause 10 for the current implementation and maturity status). Therefore, the finalization of the work on QUIC at IETF in July 2020 can only be considered as a first step in the evaluation of the feasibility of HTTP/3 (QUIC) for 5G control plane. + +Besides, HTTP/3 (QUIC) does not fit well with the use of HTTP proxies and how to support HTTP/3 (QUIC) for indirect communications via SCP (enhanced Service Based Architecture specified in 3GPP Release 16) needs to be further studied. + +It is therefore recommended to: + +- 1) not consider HTTP/3 (QUIC) as a basis for 5GC control plane signalling in 3GPP Release 17; +- 2) pursue the study in 3GPP Release 17 to align the contents of the TR along the final IETF specifications once available, to further assess the key requirements identified in clause 7 (e.g. on how stage 2 requirements for support of indirect communications in 5GC might be fulfilled) and to finalize the evaluation of HTTP/3 (QUIC) for the 5GC; +- 3) take the final evaluation into consideration at a later stage for a possible adoption of HTTP/3 (QUIC) in 3GPP Release 18 or later. + +In the meantime, QUIC (HTTP/3) implementations need to be (performance- and load-) tested and the findings be mapped to requirements and communicated to IETF (where necessary) together with the known issues of clause 10.1.3. + +# Annex A: Change history + +| Change history | | | | | | | | +|----------------|-----------|-----------|----|-----|-----|------------------------------------------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2018-07 | CT4#85bis | C4-185419 | | | | Implementation of C4-185047 (TR skeleton), C4-185420, C4-185231, C4-185421, C4-185500 and C4-185499 | 0.1.0 | +| 2018-08 | CT4#86 | C4-186339 | | | | Implementation of C4-186508 and C4-186155 agreed in CT4#86 | 0.2.0 | +| 2018-10 | CT4#86bis | C4-187646 | | | | Implementation of C4-187530, C4-187531, C4-187602, C4-187533, C4-187603, C4-187535 and C4-187536 agreed in CT4#86bis. | 0.3.0 | +| 2018-12 | CT4#87 | C4-188698 | | | | Implementation of C4-188588 and C4-188589 agreed in CT4#87 | 0.4.0 | +| 2019-03 | CT4#89 | C4-190635 | | | | Implementation of C4-190595, C4-190511, C4-190512, C4-190513, C4-190514, C4-190515, C4-190516, C4-190204 and C4-190205 agreed in CT4#89. | 0.5.0 | +| 2019-03 | CT#83 | CP-190050 | | | | Presented for information | 1.0.0 | +| 2019-04 | CT4#90 | C4-191345 | | | | General Cleanup | 1.1.0 | +| 2019-06 | CT4#91 | C4-192375 | | | | QUIC impacts on transport proxy traversal | 1.2.0 | +| 2019-06 | CT4#91 | C4-192376 | | | | Impacts of QUIC on Troubleshooting | 1.2.0 | +| 2020-03 | CT4#96E | C4-201161 | | | | Additional requirements for Transport Protocol | 1.3.0 | +| 2020-03 | CT4#96E | C4-201164 | | | | Update of QUIC features | 1.3.0 | +| 2020-06 | CT4#98E | C4-203159 | | | | Interim Conclusion on HTTP/3 (QUIC) | 1.4.0 | +| 2020-06 | CT4#98E | C4-203532 | | | | Architectural baseline requirements update | 1.4.0 | +| 2020-06 | CT4#98E | C4-203577 | | | | MASQUE | 1.4.0 | +| 2020-09 | CT4#99E | C4-204161 | | | | Update of the references | 1.5.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29935/02d0c8a07c481d880b73a25d02050fad_img.jpg b/marked/Rel-16/29_series/29935/02d0c8a07c481d880b73a25d02050fad_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..54e2b2d31b35d7a067fa8da02069c1912d2bdebd --- /dev/null +++ b/marked/Rel-16/29_series/29935/02d0c8a07c481d880b73a25d02050fad_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f4fd58656bfe85eb287e42fa7ca11ad59c35d4f65c00ae188fbd05a08d314db9 +size 8312 diff --git a/marked/Rel-16/29_series/29935/053f1077d592e6622cd21dc4bb4cb366_img.jpg b/marked/Rel-16/29_series/29935/053f1077d592e6622cd21dc4bb4cb366_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..58b60362e32ed1826b8981a31bfec274068b9a98 --- /dev/null +++ b/marked/Rel-16/29_series/29935/053f1077d592e6622cd21dc4bb4cb366_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5c81e79939683b5a5e537b08f8f1b5b050a1e53d4482d3d2c56ae3f33f173bfe +size 66493 diff --git a/marked/Rel-16/29_series/29935/0ee9d674085524d589646a6c3fb21ec3_img.jpg b/marked/Rel-16/29_series/29935/0ee9d674085524d589646a6c3fb21ec3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1c981871d72011c3f579081259c904a0228aa8db --- /dev/null +++ b/marked/Rel-16/29_series/29935/0ee9d674085524d589646a6c3fb21ec3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c538487d06f4e4df22265df6cdba118f2ef630e11cb86f6e5171568546833dad +size 48097 diff --git a/marked/Rel-16/29_series/29935/2837ffdadcdb1e5bababa56b564e56ed_img.jpg b/marked/Rel-16/29_series/29935/2837ffdadcdb1e5bababa56b564e56ed_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..cb299d4b0405e82c0b0cb4a9d911629987537004 --- /dev/null +++ b/marked/Rel-16/29_series/29935/2837ffdadcdb1e5bababa56b564e56ed_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:aae0c39564ce9eecb78efd6e9c9e42855501ceef5c37441c36c62dab86fd00d3 +size 19412 diff --git a/marked/Rel-16/29_series/29935/5a4e62bead259c258d069fd3663ea670_img.jpg b/marked/Rel-16/29_series/29935/5a4e62bead259c258d069fd3663ea670_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8382881084f7eae8eefc2d4b522fc5fc30699d06 --- /dev/null +++ b/marked/Rel-16/29_series/29935/5a4e62bead259c258d069fd3663ea670_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a09a4d1322a49f08da2253f183a7c77eb12a576a913820c7ab62cd5209e47672 +size 73706 diff --git a/marked/Rel-16/29_series/29935/6be06b7dc72bb42afcb3465394667c3b_img.jpg b/marked/Rel-16/29_series/29935/6be06b7dc72bb42afcb3465394667c3b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5a1835d338ab53cc23248c6910f1cc0999810484 --- /dev/null +++ b/marked/Rel-16/29_series/29935/6be06b7dc72bb42afcb3465394667c3b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4d41f7967aa3fd6d6b3adacc8a7efb84fa6e570b1b1b8793032e2114a721a724 +size 15148 diff --git a/marked/Rel-16/29_series/29935/6e15fc9ea763541c5913d26f85072ae1_img.jpg b/marked/Rel-16/29_series/29935/6e15fc9ea763541c5913d26f85072ae1_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0666309c347acb0f3b0562bf5f19322d1532733d --- /dev/null +++ b/marked/Rel-16/29_series/29935/6e15fc9ea763541c5913d26f85072ae1_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7794459060eafdc21ce04ca5dd113d967d1dfe5277e8cce2cfd93b75ec9d625b +size 47263 diff --git a/marked/Rel-16/29_series/29935/78ff716475b2f65bf01c3a4d02d89fc4_img.jpg b/marked/Rel-16/29_series/29935/78ff716475b2f65bf01c3a4d02d89fc4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..72a92ad0cca8c37bffb24dd32432f8757b4e79ef --- /dev/null +++ b/marked/Rel-16/29_series/29935/78ff716475b2f65bf01c3a4d02d89fc4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e09f40edfe4da10711c5c92d95c93f63f74b7062e63cef3a49c72a6f78358abe +size 17647 diff --git a/marked/Rel-16/29_series/29935/7efae06af3af43ffe5d4b956a679cf54_img.jpg b/marked/Rel-16/29_series/29935/7efae06af3af43ffe5d4b956a679cf54_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2f7d66c233a67dfdd732c30dcc4dc87e579916bc --- /dev/null +++ b/marked/Rel-16/29_series/29935/7efae06af3af43ffe5d4b956a679cf54_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7afffe35812d1bdfc590512f4d83d9d624a26c825ee003855001af716458fd75 +size 61707 diff --git a/marked/Rel-16/29_series/29935/7f17c430b9598e4d748a8041457810b3_img.jpg b/marked/Rel-16/29_series/29935/7f17c430b9598e4d748a8041457810b3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1c435ceb841a4f9494c46c4a9918c9eadba601b3 --- /dev/null +++ b/marked/Rel-16/29_series/29935/7f17c430b9598e4d748a8041457810b3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ba251fdef7ebde74afd6d6805ea1a6d7b77d3d8d2be856a0dc1c79e3dd7b5f0d +size 64606 diff --git a/marked/Rel-16/29_series/29935/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg b/marked/Rel-16/29_series/29935/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e65696a645b9a36c7ceeee54ba5567dd4ed9bae4 --- /dev/null +++ b/marked/Rel-16/29_series/29935/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:28e354f6894dd1e963cdcc5849894e75baec6022b7904b090a6ca795bc6d77fd +size 79385 diff --git a/marked/Rel-16/29_series/29935/ac31fdfebb9751f7f10416dfe33bc872_img.jpg b/marked/Rel-16/29_series/29935/ac31fdfebb9751f7f10416dfe33bc872_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7d801c3bec9231dbd45c8d2a7a79ff3a4e0da5dd --- /dev/null +++ b/marked/Rel-16/29_series/29935/ac31fdfebb9751f7f10416dfe33bc872_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:160de014b1ad08e297ac458daa7b7cee27793bdb6388885ea99b57e25e9550e5 +size 17801 diff --git a/marked/Rel-16/29_series/29935/b51423b6c049f5b5fcde42e50b58f18b_img.jpg b/marked/Rel-16/29_series/29935/b51423b6c049f5b5fcde42e50b58f18b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5bfd997b1cd3ca62cba5c8a413e7404e85d514b2 --- /dev/null +++ b/marked/Rel-16/29_series/29935/b51423b6c049f5b5fcde42e50b58f18b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1c79ec6e121547d63a7030b01b44deda3f10a7b85a369340806caf1661c019f9 +size 53322 diff --git a/marked/Rel-16/29_series/29935/b904ac2472cab80892d1e783e6230d6e_img.jpg b/marked/Rel-16/29_series/29935/b904ac2472cab80892d1e783e6230d6e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..14570f650ed7d5c72af71a13a97e8f295333068e --- /dev/null +++ b/marked/Rel-16/29_series/29935/b904ac2472cab80892d1e783e6230d6e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c59d752765cb37424e33165d126df006cc803f19de04100dc35dec476277a37d +size 91632 diff --git a/marked/Rel-16/29_series/29935/daa4a6fa7e2ba1954258f86b4928eb32_img.jpg b/marked/Rel-16/29_series/29935/daa4a6fa7e2ba1954258f86b4928eb32_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..41d5126d3960e251d2f2dcfcf226f1465318431e --- /dev/null +++ b/marked/Rel-16/29_series/29935/daa4a6fa7e2ba1954258f86b4928eb32_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b7d3fb0a118591933d0b56de9b6273d2f509a56c79a13b79e6c73870dd715489 +size 67043 diff --git a/marked/Rel-16/29_series/29935/e05b36c0d46549e681ce6581422c66b2_img.jpg b/marked/Rel-16/29_series/29935/e05b36c0d46549e681ce6581422c66b2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e1aca05365efcbd109a89b6d7b1e43dc7e214e49 --- /dev/null +++ b/marked/Rel-16/29_series/29935/e05b36c0d46549e681ce6581422c66b2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f99984fde65af601b94fdcf2accc21e3527552d058fd55aab38b5bc2957cf305 +size 68576 diff --git a/marked/Rel-16/29_series/29935/f0b7abcb093621bb310bf61fbe0f0d2d_img.jpg b/marked/Rel-16/29_series/29935/f0b7abcb093621bb310bf61fbe0f0d2d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8c55002d49eafbe51ada765539e9e0070c6ec82c --- /dev/null +++ b/marked/Rel-16/29_series/29935/f0b7abcb093621bb310bf61fbe0f0d2d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9a83f99d70b7438447b8a54d3400b8e5d125ef66fa06c9cd855c5589cdff374d +size 87176 diff --git a/marked/Rel-16/29_series/29935/ff0952ef692c9d960ce5f6708bcc9711_img.jpg b/marked/Rel-16/29_series/29935/ff0952ef692c9d960ce5f6708bcc9711_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..467252ef654382dd8ce151714df3384ad6fd1ca5 --- /dev/null +++ b/marked/Rel-16/29_series/29935/ff0952ef692c9d960ce5f6708bcc9711_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1f40d53e550b2660392d5e6544020b92b8f9f2394854d4c93644a8c6b787c422 +size 67223 diff --git a/marked/Rel-16/29_series/29935/raw.md b/marked/Rel-16/29_series/29935/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..46adafc910f495670e0f3c80f35797977c4a68e4 --- /dev/null +++ b/marked/Rel-16/29_series/29935/raw.md @@ -0,0 +1,1210 @@ + + + + + + +# Contents + +| | | +|-----------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions, symbols and abbreviations..... | 7 | +| 3.1 Definitions..... | 7 | +| 3.2 Abbreviations ..... | 7 | +| 4 General considerations..... | 8 | +| 4.1 General syntax definitions..... | 8 | +| 4.2 MMTEL data..... | 9 | +| 4.2.1 Introduction ..... | 9 | +| 4.2.2 MMTEL data with a TAS-FE..... | 10 | +| 4.2.3 MMTEL data with an HSS-FE..... | 10 | +| 4.2.4 MMTEL Data and CS Supplementary Services data ..... | 10 | +| 4.2.5 Supplementary Services RDM principle ..... | 10 | +| 5 Identifier..... | 12 | +| 5.1 Object classes and their attributes ..... | 12 | +| 6 UDC Service Profile ..... | 12 | +| 6.1 Object classes and their attributes ..... | 12 | +| 6.2 Directory Information Tree ..... | 13 | +| 6.2.1 Alternative A ..... | 13 | +| 6.2.2 Alternative B ..... | 13 | +| 6.2.3 Alternative C ..... | 14 | +| 6.2.4 Alternative D ..... | 15 | +| 7 UDC Service Data shared by several domains ..... | 16 | +| 7.1 Object classes and their attributes ..... | 17 | +| 7.1.1 AuC Subscriber Data..... | 17 | +| 8 UDC CS Service Data..... | 17 | +| 9 UDC GPRS Service Data..... | 17 | +| 10 UDC EPS Service Data..... | 17 | +| 11 UDC IMS Service Data..... | 18 | +| 11.1 Object classes and their attributes ..... | 18 | +| 11.1.1 General ..... | 18 | +| 11.1.2 Alternative A ..... | 18 | +| 11.1.2.1 IMS Data..... | 18 | +| 11.1.2.2 Service Profile Data ..... | 19 | +| 11.1.2.2.1 Service Profile..... | 19 | +| 11.1.2.2.2 Initial Filter Criteria ..... | 19 | +| 11.1.2.3 Implicit Registration Set ..... | 20 | +| 11.1.2.4 Public Identity..... | 20 | +| 11.1.2.5 Private Identity..... | 21 | +| 11.1.3 Alternative B ..... | 21 | +| 11.1.3.1 IMS Data..... | 21 | +| 11.1.3.2 Service Profile Data ..... | 22 | +| 11.1.3.2.1 Service Profile..... | 22 | +| 11.1.3.2.2 Initial Filter Criteria ..... | 22 | +| 11.1.3.3 Implicit Registration Set Data..... | 23 | +| 11.1.3.3.1 Implicit Registration Set..... | 23 | +| 11.1.3.3.2 Alias Group ..... | 23 | +| 11.1.3.3 Public Identity..... | 23 | +| 11.1.3.4 Repository Data ..... | 24 | +| 11.1.3.5 Private Identity..... | 25 | +| 11.1.3.6 Reference Location Information ..... | 25 | + +| | | | +|----------|-------------------------------------|----| +| 11.1.4 | Alternative C ..... | 26 | +| 11.1.4.1 | IMS Subscription ..... | 26 | +| 11.1.4.2 | Service Profile..... | 26 | +| 11.1.4.3 | Initial Filter Criteria ..... | 27 | +| 11.1.4.4 | Implicit Registration Set ..... | 28 | +| 11.1.4.5 | Public Identity ..... | 28 | +| 11.1.4.6 | Repository Data ..... | 29 | +| 11.1.4.7 | Alias Group..... | 30 | +| 11.1.4.8 | Private Identity ..... | 30 | +| 11.1.5 | Alternative D ..... | 31 | +| 11.1.5.1 | IMS Private Identity ..... | 31 | +| 11.1.5.2 | IMS Public Identity ..... | 32 | +| 11.1.5.3 | IMS Service Profile ..... | 33 | +| 11.1.5.4 | Alias Group..... | 33 | +| 11.2 | Directory Information Tree ..... | 33 | +| 11.2.0 | General ..... | 33 | +| 11.2.1 | Alternative A ..... | 33 | +| 11.2.2 | Alternative B ..... | 35 | +| 11.2.3 | Alternative C ..... | 36 | +| 11.2.4 | Alternative D ..... | 37 | +| 11.3 | UML model ..... | 37 | +| 12 | Conclusion and Recommendation ..... | 40 | +| Annex A: | Change history ..... | 42 | + +# --- Foreword + +This Technical Report has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 1 Scope + +The present document analyses and evaluates the definition of a Reference Data Model (RDM) for Ud interface between Front-Ends (FEs) for the HSS application and the User Data Repository (UDR). + +The stage 3 of the Ud interface in the User Data Convergence (UDC architecture) is defined in 3GPP TS 29.335 [2]. + +The Reference Data Model (RDM) shall comply with the Common Baseline Information Model for UDC as defined in 3GPP TS 32.182 [3] and it shall follow the concepts of the Framework for Model Handling and Management as defined in 3GPP TS 32.181 [4]. + +The analysis will comprise the general considerations impacting the RDM for HSS. + +The analysis will comprise the following topics: + +- The general considerations impacting the RDM for HSS; +- Attributes definition: names, syntax, semantics; +- Object classes & Directory Information Tree: object classes names, attributes grouping, LDAP entries, Distinguished Names and Relative Distinguished Names. + +Directory information trees, object classes and attributes in this report should be considered informative since they are subject to additions and/or modification depending on the specific implementation as illustrated in the presented alternatives in this technical report. Even the assignment of attributes to object classes may be redistributed, for example, because the normalization of object classes across different domains may result in attributes being moved to a superclass. Naming is provisional. Diagrams used and naming convention are not standardized. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications" +- [2] 3GPP TS 29.335: "User Data Convergence (UDC); User Data Repository Access Protocol over the Ud interface" +- [3] 3GPP TS 32.182: "Telecommunication management; User Data Convergence (UDC); Common Baseline Information Model" +- [4] 3GPP TS 32.181: "User Data Convergence; Framework for Model Handling and Management" +- [5] 3GPP TS 23.008: "Organization of subscriber data" +- [6] IETF RFC 4517: "Syntaxes and Matching Rules" +- [7] 3GPP TS 23.003: "Numbering, addressing and identification" +- [8] IETF RFC 4291: "IP Version 6 Addressing Architecture" +- [9] 3GPP TS 29.214: "Policy and Charging Control over Rx reference point" +- [10] 3GPP TS 32.251: "Telecommunication management; Charging management; Packet Switched (PS) domain charging" + +- [11] 3GPP TS 32.298: "Telecommunication management; Charging management; Charging Data Record (CDR) parameter description" +- [12] 3GPP TS 29.272: "Evolved Packet System (EPS); Mobility Management Entity (MME) and Serving GPRS Support Node (SGSN) related interfaces based on Diameter protocol" +- [13] 3GPP TS 23.401: "General Packet Radio Service (GPRS) enhancements for Evolved Universal Terrestrial Radio Access Network (E-UTRAN) access" +- [14] 3GPP TS 23.060: "General Packet Radio Service (GPRS); Service description; Stage 2" +- [15] 3GPP TS 36.413: "Evolved Universal Terrestrial Radio Access Network (E-UTRAN); S1 Application Protocol (S1AP)" +- [16] 3GPP TS 29.212: "Policy and Charging Control over Gx reference point" +- [17] IETF RFC 1035: "DOMAIN NAMES - IMPLEMENTATION AND SPECIFICATION" +- [18] 3GPP TS 23.015: "Technical realization of Operator Determined Barring (ODB)" +- [19] 3GPP TS 29.364: "IP Multimedia Subsystem (IMS) Application Server (AS) service data descriptions for AS interoperability" +- [20] IETF RFC 3261 "SIP: Session Initiation Protocol" +- [21] IETF RFC 2396: "Uniform Resource Identifiers (URI): generic syntax" +- [22] IETF RFC 3966 "The tel URI for Telephone Numbers" +- [23] IETF RFC 4282: "The Network Access Identifier" +- [24] 3GPP TS 29.228: "IP Multimedia (IM) Subsystem Cx and Dx interface; signalling flows and message contents" +- [25] 3GPP TS 23.845: "Study on User Data Convergence (UDC) evolution" + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in TR 21.905 [1]. + +**Reference Data Model for HSS:** Reference Data Model for HSS is an Application Data Model that operations on Ud interfaces supporting HSS applications shall comply to. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in TR 21.905 [1]. + +| | | +|-------|---------------------------------------| +| CB | Call Barring | +| CDIV | Call Diversion | +| LDAP | Lightweight Directory Access Protocol | +| MMTEL | Multimedia Telephony | +| RDM | Reference Data Model | +| TAS | Telephony Application Server | +| UDC | User Data Convergence | + +# 4 General considerations + +## 4.1 General syntax definitions + +The LDAP attributes in this document are defined as having a syntax specified in IETF RFC 4517 [6] or a derived syntax that will be specified in this section. The description of a derived syntax will contain the name of the IETF RFC 4517 [6] syntax from which it was derived as well as any additional structure and value constraints. Syntax names should follow the rules set by IETF RFC 4517 [6] (mixed case with first letter of word capitalized), e.g. NumericString. + +| Derived Syntax name | Description | +|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| UInt8 | This syntax is derived from the Integer syntax [6]. The structure is further constrained to a maximum length of 1 and the values are further constrained from 0 to 255. | +| UInt16 | This syntax is derived from the Integer syntax syntax [6]. The structure is further constrained to a maximum length of 2 and the values are further constrained from 0 to 65535. | +| UInt32 | This syntax is derived from the Integer syntax syntax [6]. The structure is further constrained to a maximum length of 4 and the values are further constrained from 0 to 4294967295. | +| HexString | This syntax is derived from the PrintableString syntax [6]. The values are further constrained to the decimal digits (0 through 9), characters "a" to "f" or characters "A" to "F". | +| HexString32 | This syntax is derived from the HexString syntax. The structure is further constrained to a maximum length of 32 characters. | +| FQDN | This syntax is used to represent an Fully Qualified Domain Name (FQDN) (see IETF RFC1035 [17]) and is derived from the PrintableString syntax [6]. The structure is further constrained to a maximum length of 255 and the values are further constrained to one or more labels separated by the period (".") character. Each label consists of the decimal digits (0 through 9), characters "a" to "z", characters "A" to "Z", the hyphen ("-") character and has a maximum length of 63 characters. Caselngore | +| IPv4Address | This syntax is derived from the PrintableString syntax [6] and is used to represent IPv4 addresses formatted in dot-decimal notation without leading zeros. The structure is further constrained to a maximum length of 15 and values are further constrained to the decimal digits (0 through 9) and the period (.) character. | +| IPv6Address | This syntax is derived from the PrintableString syntax [6] and is used to represent IPv6 addresses formatted in hexadecimal colon-separated notation without leading zeros in each group and with the largest run of consecutive zero groups collapsed into a single empty group (see IETF RFC 4291 [8]). The structure is further constrained to a maximum length of 39 and the values are further constrained to the decimal digits (0 through 9), characters "a" to "f" or characters "A" to "F" and the colon (:) character. | +| IPv6Prefix | This syntax is derived from the PrintableString syntax [6] and is used to represent an IPv6 prefix formatted in CIDR (Classless Inter-domain Routing) notation, i.e. an IPv6 address (formatted in IPv6Address syntax), a slash (/) character and a decimal value indicating the size in bits of the address prefix (see IETF RFC 4291 [8]). The structure is further constrained to a maximum length of 43 and the values are further constrained to the decimal digits (0 through 9), characters "a" to "f" or characters "A" to "F", the colon (:) character and the slash (/) character. | +| Name10 | This syntax is derived from the PrintableString syntax [6]. The structure is further constrained to a maximum length of 10 characters. Caselngore. | +| String | This syntax corresponds to Printable String syntax according to IETF RFC 4517 [6]. | +| Enumerated | This syntax corresponds to Numeric String syntax according to IETF RFC 4517 [6], where the maximum length is defined by the number of included numerals. | + +Table 4.1-1 + +## 4.2 MMTEL data + +### 4.2.1 Introduction + +The specification of the MMTEL data in the Reference Data Model over Ud has to define for which Application FEs it will be applied. Two cases are identified. + +- MMTEL data specification over Ud applies to the Ud interface between a Telephony Application Server Front-end (TAS-FE) and the UDR. + +- MMTEL data specification over Ud applies to the Ud interface between a HSS-FE (supporting IMS) and the UDR. + +### 4.2.2 MMTEL data with a TAS-FE + +The Ud interface supported by a TAS is an alternative way to store its MMTEL data in a UDR instead of using the Sh interface and an HSS-FE. For this purpose another protocol (i.e. reusing Ud protocol) to centrally store MMTEL Data in addition to Sh has to be assessed and confirmed. This is out of the scope in the present release of the specifications. + +### 4.2.3 MMTEL data with an HSS-FE + +With a HSS-FE, MMTEL data are transported over a Sh interface as transparent data within repository data. Then, regarding to the storage on the UDR by the HSS-FE, two sub-cases are identified: + +- It is normally stored as transparent data in the UDR in the same way as any other transparent data coming from an AS over Sh, so not requiring a data modelling of the MMTEL data over the Ud between a HSS-FE and the UDR. +- The transparent data is analysed by the HSS-FE application logic and translated into data complying with the MMTEL RDM over Ud. In the other way, the HSS-FE application logic builds a Sh transparent data from the MMTEL data retrieved from the UDR and complying with the MMTEL RDM over Ud. It is to be noted that the concept of transparent data that still applies to Sh is no more applied on the transparent storage in the HSS in this sub-case. + +To address the second sub-case, the HSS-FE will rely on the standardisation of MMTEL Data over Sh in 3GPP TS 29.364 [19]. Two coding options are defined, a binary one and a XML one. An objective is that the same MMTEL RDM over Ud can be mapped with both options. The same MMTEL RDM should also be applicable to the case described in 4.2.2. This is out of the scope in the present release of the specifications. + +With the XML option, the data configuring each of the CDIV and CB MMTEL Services is structured in a set of multiple rules, each rule may contain multiple conditions and an action, structure that was not retained for the binary option aimed to handle the subset of MMTEL services corresponding to PSTN/ISDN and CS supplementary services. + +How the MMTEL RDM over Ud can address the configuration data for CDIV and CB services for both the XML and the binary option is out of the scope in the present release of the specifications. + +### 4.2.4 MMTEL Data and CS Supplementary Services data + +In some cases, the supplementary services execution and/or their configuration when user is in the CS domain may have to rely on the CS supplementary services and not MMTEL ones. It may drive to maintain the consistency between the MMTEL services and the CS supplementary services. Two approaches that impact RDM for Ud may be considered: + +- MMTEL Data and CS supplementary Service data are considered as separate data in the RDM for Ud, considering that their consistency will be handled by the concerned application logics. This approach may be more in line with current 3GPP specifications where CS supplementary Services and MMTEL services are defined in different 3GPP specifications. +- A subset of MMTEL data and CS supplementary service data are merged in the RDM over Ud and describe a supplementary service independently of the access (CS or PS). This approach may impact stage 1 and stage 2 specifications on supplementary services. + +Which one of the two approaches is the most relevant and if it impacts existing specifications on supplementary services (CS and MMTEL) is out of the scope in the present release of the specifications. + +### 4.2.5 Supplementary Services RDM principle + +It should be possible to define the Supplementary Services that are common to MMTEL and CS only once and not separately in the Reference Data Model. Using this approach the synchronization of common MMTEL and CS Supplementary Services is implicitly reached. At the same time, it should be possible to have separate Supplementary Services data for MMTEL and CS in order that the operators could provide differentiated services. The operator has to choose between these alternatives. The RDM specification for MMTEL and CS Supplementary services should allow these two approaches. + +Only a subset of MMTEL Supplementary Services defined in [19] is shared with the Circuit domain. + +Here are described three possible structures of the RDM. + +![Reference Data Model referring to MMTEL services diagram](daa4a6fa7e2ba1954258f86b4928eb32_img.jpg) + +This diagram illustrates the Reference Data Model (RDM) for MMTEL services. At the top, a grey box labeled 'Subscriber Id' is connected to four profile boxes: 'PS profile' (grey), 'CS profile' (green), 'MMTEL profile' (yellow), and 'IMS profile' (grey). The 'PS profile' is connected to 'GPRS domain data [1..X]' and 'EPS domain data [1..Y]'. The 'CS profile' is connected to 'CS domain data [1..A]', 'SS data common to MMTEL [1..B]' (with a red note 'NO value here, ONLY pointers'), and 'SS data specific to CS [1..C]'. The 'MMTEL profile' is connected to 'SS data common to CS [1..B]' (blue) and 'SS data specific to MMTEL [1..D]'. A red dashed line with an arrow points from the 'SS data common to MMTEL' box in the CS profile to the 'SS data common to CS' box in the MMTEL profile. + +Reference Data Model referring to MMTEL services diagram + +Figure 4.2.5-1: Reference Data Model referring to MMTEL services + +![Reference Data Model referring to CS services diagram](053f1077d592e6622cd21dc4bb4cb366_img.jpg) + +This diagram illustrates the Reference Data Model (RDM) for CS services. At the top, a grey box labeled 'Subscriber Id' is connected to four profile boxes: 'PS profile' (grey), 'CS profile' (green), 'MMTEL profile' (yellow), and 'IMS profile' (grey). The 'PS profile' is connected to 'GPRS domain data [1..X]' and 'EPS domain data [1..Y]'. The 'CS profile' is connected to 'CS domain data [1..A]', 'SS data common to MMTEL [1..B]' (blue), and 'SS data specific to CS [1..C]'. The 'MMTEL profile' is connected to 'SS data common to CS [1..B]' (yellow with a red note 'NO value here, ONLY pointers') and 'SS data specific to MMTEL [1..D]'. A red dashed line with an arrow points from the 'SS data common to CS' box in the MMTEL profile to the 'SS data common to MMTEL' box in the CS profile. + +Reference Data Model referring to CS services diagram + +Figure 4.2.5-2: Reference Data Model referring to CS services + +![Figure 4.2.5-3: Reference Data Model referring to the common services. The diagram shows a hierarchy starting with 'Subscriber Id' at the top. It branches into four profiles: 'PS profile', 'CS profile', 'MMTEL profile', and 'IMS profile'. 'PS profile' branches into 'GPRS domain data [1..X]' and 'EPS domain data [1..Y]'. 'CS profile' branches into 'CS domain data [1..A]', 'SS data common to MMTEL [1..B]' (with a note 'NO value here, ONLY pointers'), and 'SS data specific to CS [1..C]'. 'MMTEL profile' branches into 'SS data common to CS [1..B]' (with a note 'NO value here, ONLY pointers'), 'SS data specific to MMTEL [1..D]', and 'SS data common to CS and MMTEL [1..B]'. Red dashed lines connect the 'SS data common to MMTEL [1..B]' from the CS profile to the 'SS data common to CS and MMTEL [1..B]' in the MMTEL profile, and the 'SS data common to CS [1..B]' from the MMTEL profile to the 'SS data common to CS and MMTEL [1..B]' in the MMTEL profile.](5a4e62bead259c258d069fd3663ea670_img.jpg) + +Figure 4.2.5-3: Reference Data Model referring to the common services. The diagram shows a hierarchy starting with 'Subscriber Id' at the top. It branches into four profiles: 'PS profile', 'CS profile', 'MMTEL profile', and 'IMS profile'. 'PS profile' branches into 'GPRS domain data [1..X]' and 'EPS domain data [1..Y]'. 'CS profile' branches into 'CS domain data [1..A]', 'SS data common to MMTEL [1..B]' (with a note 'NO value here, ONLY pointers'), and 'SS data specific to CS [1..C]'. 'MMTEL profile' branches into 'SS data common to CS [1..B]' (with a note 'NO value here, ONLY pointers'), 'SS data specific to MMTEL [1..D]', and 'SS data common to CS and MMTEL [1..B]'. Red dashed lines connect the 'SS data common to MMTEL [1..B]' from the CS profile to the 'SS data common to CS and MMTEL [1..B]' in the MMTEL profile, and the 'SS data common to CS [1..B]' from the MMTEL profile to the 'SS data common to CS and MMTEL [1..B]' in the MMTEL profile. + +Figure 4.2.5-3: Reference Data Model referring to the common services + +Depending on the implementation any of the above data structures for MMTEL and CS SS or a combination of them can be selected for the RDM. + +# 5 Identifier + +## 5.1 Object classes and their attributes + +Table 5.1-1 + +| Derived Syntax name | Description | +|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| IMSI | This syntax is used to represent international mobile subscriber identity (IMSI) [7] and is derived from the NumericString syntax [6]. The structure is further constrained to a maximum length of 15 and the values are further constrained to decimal digits (0 through 9) only. | +| PublicIdentity | This syntax is used to represent the public identity of a user in the IMS and is derived from the PrintableString syntax [6]. The structure is further constrained to a SIP URI (with the format defined in IETF RFC 3261 [20] and IETF RFC 2396 [21]) or a TEL URI (with the format defined in IETF RFC 3966 [22]). Both SIP URI and TEL URI shall be in canonical form, as described in 3GPP TS 23.003 [7]. | +| PrivateIdentity | This syntax is used to represent the private identity of a user in the IMS and is derived from the PrintableString syntax [6]. The structure is further constrained to a NAI with the form username@realm as specified in IETF RFC 4282 [23]. | +| E164Number | This syntax is used to represent an E.164 Number and is derived from the NumericString syntax [6]. The structure is further constrained to a maximum length of 15 and the values are further constrained to decimal digits (0 through 9) only. | + +# 6 UDC Service Profile + +## 6.1 Object classes and their attributes + +Object classes and attributes for UDC Service Profile are out of scope of the present release. + +## 6.2 Directory Information Tree + +### 6.2.1 Alternative A + +![DIT Structure for UDC with alternative A](7f17c430b9598e4d748a8041457810b3_img.jpg) + +``` +graph TD; root((root)) -- "data=common" --> CommonData((CommonData)); root -- "data=individual" --> IndividualData((IndividualData)); IndividualData -- "eui=xxx" --> EndUser((EndUser)); IndividualData -- "imsi=xxx" --> IMSIAlias((IMSI Alias)); IndividualData -- "msisdn=xxx" --> MSISDNAlias((MSISDN Alias)); IndividualData -- "impi=xxx" --> IMPIAlias((IMPI Alias)); IndividualData -- "impu=xxx" --> IMPUAlias((IMPU Alias)); IMSIAlias -.-> EndUser; MSISDNAlias -.-> EndUser; IMPIAlias -.-> EndUser; IMPUAlias -.-> EndUser; EndUser -- "svcType=AuC" --> AuCData((AuC-Data)); EndUser -- "svcType=IMS" --> IMSData((IMS-Data)); EndUser -- "svcType=CS" --> CSData((CS-Data)); EndUser -- "svcType=PS" --> PSData((PS-Data)); EndUser -- "svcType=EPS" --> EPSData((EPS-Data)); +``` + +The diagram illustrates the Directory Information Tree (DIT) structure for UDC with alternative A. The tree starts with a 'root' node at the top. It branches into two nodes: 'CommonData' (labeled 'data=common') and 'IndividualData' (labeled 'data=individual'). The 'IndividualData' node branches into five nodes: 'EndUser' (labeled 'eui=xxx'), 'IMSI Alias' (labeled 'imsi=xxx'), 'MSISDN Alias' (labeled 'msisdn=xxx'), 'IMPI Alias' (labeled 'impi=xxx'), and 'IMPU Alias' (labeled 'impu=xxx'). Dashed arrows point from each of the four alias nodes to the 'EndUser' node. The 'EndUser' node branches into five nodes: 'AuC-Data' (labeled 'svcType=AuC'), 'IMS-Data' (labeled 'svcType=IMS'), 'CS-Data' (labeled 'svcType=CS'), 'PS-Data' (labeled 'svcType=PS'), and 'EPS-Data' (labeled 'svcType=EPS'). + +DIT Structure for UDC with alternative A + +**Figure 6.2.1-1: DIT Structure for UDC with alternative A** + +For definition of End User see 3GPP TS 32.182 [3]. + +### 6.2.2 Alternative B + +In this alternative, the parent of the different domain data entities is a Subscription entity. This Subscription entity may be not limited to one user, for example, IMS data belongs to a IMS subscription that, according to TS 23.228, may be multiuser. How to support subscription with several IMS users is not described in the present clause. + +It introduces privateIdentityAlias and publicIdentityAlias entities that cover Private and Public Service Identities as well as Private and Public User Identities. + +![DIT Structure for UDC with alternative B](ff0952ef692c9d960ce5f6708bcc9711_img.jpg) + +``` + +graph TD + root((root)) -- "data=common" --> CommonData((CommonData)) + root -- "data=individual" --> IndividualData((IndividualData)) + IndividualData -- "subscriptionId=xxx" --> Subscription((Subscription)) + IndividualData -- "imsi=xxx" --> IMSIAlias((IMSI Alias)) + IndividualData -- "msisdn=xxx" --> MSISDNAlias((MSISDN Alias)) + IndividualData -- "privateIdentity=xxx" --> PrivateIdentityAlias((PrivateIdentity Alias)) + IndividualData -- "publicIdentity=xxx" --> PublicIdentityAlias((PublicIdentity Alias)) + IMSIAlias -.-> Subscription + MSISDNAlias -.-> Subscription + PrivateIdentityAlias -.-> Subscription + PublicIdentityAlias -.-> Subscription + Subscription -- "svcType=AuC" --> AuCData((AuC-Data)) + Subscription -- "svcType=IMS" --> IMSData((IMS-Data)) + Subscription -- "svcType=CS" --> CSData((CS-Data)) + Subscription -- "svcType=PS" --> PSData((PS-Data)) + Subscription -- "svcType=EPS" --> EPSData((EPS-Data)) + +``` + +The diagram illustrates the DIT structure for UDC with alternative B. It starts with a 'root' node at the top, which branches into 'CommonData' (via 'data=common') and 'IndividualData' (via 'data=individual'). 'IndividualData' branches into 'Subscription' (via 'subscriptionId=xxx'), 'IMSI Alias' (via 'imsi=xxx'), 'MSISDN Alias' (via 'msisdn=xxx'), 'PrivateIdentity Alias' (via 'privateIdentity=xxx'), and 'PublicIdentity Alias' (via 'publicIdentity=xxx'). Dashed arrows point from each of these four alias nodes to the 'Subscription' node. Finally, 'Subscription' branches into five data entities based on service type: 'AuC-Data' (svcType=AuC), 'IMS-Data' (svcType=IMS), 'CS-Data' (svcType=CS), 'PS-Data' (svcType=PS), and 'EPS-Data' (svcType=EPS). + +DIT Structure for UDC with alternative B + +**Figure 6.2.2-1: DIT Structure for UDC with alternative B** + +### 6.2.3 Alternative C + +In alternative C, as for alternative B, the diagram contains Subscription, privateIdentityAlias and publicIdentityAlias entities. How to support subscription with several IMS users is not described in the present clause. + +The different domains for data are organised differently. This alternative allows attributes that are applicable to several domains to be defined once. For example: + +- an attribute that is the same in the GPRS and EPS domains should be defined in the entity PS-Data +- an attribute that is the same in the CS and PS domains should be defined in the entity Access-Data. + +The compatibility with new 3GPP releases extending the use of data defined for a domain to other domains is out of the scope of the present document. + +![DIT Structure for UDC with alternative C](a33da0f14e456f92539ce3e9b7d81f9a_img.jpg) + +``` + +graph TD + root((root)) -- "data=common" --> CommonData((CommonData)) + root -- "data=individual" --> IndividualData((IndividualData)) + IndividualData -- "subscriptionId=xxx" --> Subscription((Subscription)) + IndividualData -- "imsi=xxx" --> IMSIAlias((IMSI Alias)) + IndividualData -- "msisdn=xxx" --> MSISDNAlias((MSISDN Alias)) + IndividualData -- "privateIdentity=xxx" --> PrivateIdentityAlias((PrivateIdentity Alias)) + IndividualData -- "publicIdentity=xxx" --> PublicIdentityAlias((PublicIdentity Alias)) + IMSIAlias -.-> Subscription + MSISDNAlias -.-> Subscription + PrivateIdentityAlias -.-> Subscription + PublicIdentityAlias -.-> Subscription + Subscription -- "svcType=AuC" --> AuCData((AuC-Data)) + Subscription -- "svcType=IMS" --> IMSData((IMS-Data)) + Subscription -- "svcType=access" --> AccessData((Access-Data)) + AccessData -- "svcType=CS" --> CSData((CS-Data)) + AccessData -- "svcType=PS" --> PSData((PS-Data)) + PSData -- "svcType=GPRS" --> GPRSData((GPRS-Data)) + PSData -- "svcType=EPS" --> EPSData((EPS-Data)) + +``` + +The diagram illustrates the DIT Structure for UDC with alternative C. It starts with a 'root' node at the top. Below it, 'data=common' leads to 'CommonData' and 'data=individual' leads to 'IndividualData'. From 'IndividualData', a 'subscriptionId=xxx' attribute leads to a 'Subscription' node. Other attributes from 'IndividualData' include 'imsi=xxx' (leading to 'IMSI Alias'), 'msisdn=xxx' (leading to 'MSISDN Alias'), 'privateIdentity=xxx' (leading to 'PrivateIdentity Alias'), and 'publicIdentity=xxx' (leading to 'PublicIdentity Alias'). Dashed arrows point from each of these four Alias nodes to the 'Subscription' node. From the 'Subscription' node, three 'svcType' attributes lead to 'AuC-Data' (svcType=AuC), 'IMS-Data' (svcType=IMS), and 'Access-Data' (svcType=access). From 'Access-Data', two 'svcType' attributes lead to 'CS-Data' (svcType=CS) and 'PS-Data' (svcType=PS). Finally, from 'PS-Data', two 'svcType' attributes lead to 'GPRS-Data' (svcType=GPRS) and 'EPS-Data' (svcType=EPS). + +DIT Structure for UDC with alternative C + +**Figure 6.2.3-1: DIT Structure for UDC with alternative C** + +### 6.2.4 Alternative D + +In this alternative, the parent of the different domain data entities is a Subscription entity. This Subscription entity may not limited to one user, for example, IMS data belongs to a IMS subscription that, according to 3GPP TS 23.228, may be multiuser. + +The RDN of the Individual user data classes AuC-Data, CS-Data, PS-Data and EPS-Data is defined with the IMSI + svcType in order to allow for multiuser. + +The Alias MSISDN class, in addition to providing a reference to the Subscription object, also contain an IMSI attribute. This is done to assist in MSISDN based message processing, such as MAP Send Routing Info. i.e., such a request would have to search for the Alias MSISDN object to obtain the subscriber's IMSI prior to obtaining the specific SvcType class associated with the IMSI. + +![DIT Structure for UDC with alternative D. The diagram shows a hierarchical tree starting from 'root' at the top. 'root' branches into 'CommonData' (labeled 'data=common') and 'IndividualData' (labeled 'data=individual'). 'IndividualData' branches into 'Subscription' (labeled 'subscriptionId=xxx') and four alias nodes: 'IMSI Alias' (labeled 'imsi=xxx'), 'MSISDN Alias' (labeled 'msisdn=xxx'), 'PrivateIdentity Alias' (labeled 'privateIdentity=xxx'), and 'PublicIdentity Alias' (labeled 'publicIdentity=xxx'). Dashed arrows point from each of these four alias nodes to the 'Subscription' node. Below 'Subscription', there are five data nodes: 'AuC-Data' (labeled 'imsi=xxx+svcType=AuC'), 'IMS-Data' (labeled 'svcType=IMS'), 'CS-Data' (labeled 'imsi=xxx+svcType=CS'), 'PS-Data' (labeled 'imsi=xxx+svcType=PS'), and 'EPS-Data' (labeled 'imsi=xxx+svcType=EPS').](7efae06af3af43ffe5d4b956a679cf54_img.jpg) + +DIT Structure for UDC with alternative D. The diagram shows a hierarchical tree starting from 'root' at the top. 'root' branches into 'CommonData' (labeled 'data=common') and 'IndividualData' (labeled 'data=individual'). 'IndividualData' branches into 'Subscription' (labeled 'subscriptionId=xxx') and four alias nodes: 'IMSI Alias' (labeled 'imsi=xxx'), 'MSISDN Alias' (labeled 'msisdn=xxx'), 'PrivateIdentity Alias' (labeled 'privateIdentity=xxx'), and 'PublicIdentity Alias' (labeled 'publicIdentity=xxx'). Dashed arrows point from each of these four alias nodes to the 'Subscription' node. Below 'Subscription', there are five data nodes: 'AuC-Data' (labeled 'imsi=xxx+svcType=AuC'), 'IMS-Data' (labeled 'svcType=IMS'), 'CS-Data' (labeled 'imsi=xxx+svcType=CS'), 'PS-Data' (labeled 'imsi=xxx+svcType=PS'), and 'EPS-Data' (labeled 'imsi=xxx+svcType=EPS'). + +Figure 6.2.4-1: DIT Structure for UDC with alternative D + +# 7 UDC Service Data shared by several domains + +The data defined in this section are examples of data shared by several domains. + +Data sharing among multiple domains may impact data model and is out of the scope of the present document. + +## 7.1 Object classes and their attributes + +### 7.1.1 AuC Subscriber Data + +Table 7.1.1-1 + +| Object Class | ACSUBDATA | | | | +|----------------------|--------------------------------------------------------------------------------------|----------------------|------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Type of Object Class | tbd | | | | +| Description | This class represents the Data Container for all Subscriber Data relevant to the AuC | | | | +| Superior OCL | tbd | | | | +| Attribute Name | Type | HSS-FE access rights | Properties | Description | +| imsi | IMSI | read | Naming Attribute mandatory single-valued | International Mobile Subscriber Identity. See 3GPP TS 23.003. | +| acSubscrType | UInt8 | read | optional single-valued | Type of Subscriber. Possible values:
0 - GSM
1 - UMTS | +| acEncKey | HexString32 | read | optional single-valued | The subscriber's encrypted long term secret key. This is a hexadecimal string with fixed length of 32 bytes.
For definition of a UMTS subscriber's long term secret key K see 3GPP TS 33.102.
For definition of a GSM subscriber's long term secret key Ki see 3GPP TS 43.020. | +| acSeqNum | HexString32 | read, write | optional single-valued | Sequence Number for UMTS subscriber. This is a hexadecimal string with fixed length of 12 bytes.
For definition of a UMTS subscriber's Sequence Number SQN HE see 3GPP TS 33.102. | +| acAMF | HexString32 | read | optional single-valued | Authentication Management Field for UMTS subscriber. This is a hexadecimal string with fixed length of 4 bytes
For definition of a UMTS subscriber's Authentication Management Field AMF see 3GPP TS 33.102. | +| acKdbld | UInt16 | read | optional single-valued | The reference to the key used to encrypt the subscriber's long term secret key. tbc. | +| acAlgorithmId | UInt16 | read | optional single-valued | AC Algorithm Identifier. Specifies the algorithm used for the generation of authentication vectors. tbc. | + +# --- 8 UDC CS Service Data + +Object classes, attributes and Directory Information Tree for CS Service Data are out of scope of the present release. + +# --- 9 UDC GPRS Service Data + +Object classes, attributes and Directory Information Tree for GPRS Service Data are out of scope of the present release. + +# --- 10 UDC EPS Service Data + +Object classes, attributes and Directory Information Tree for EPS Service Data are out of scope of the present release. + +# 11 UDC IMS Service Data + +## 11.1 Object classes and their attributes + +### 11.1.1 General + +The application of the common data concept described in 3GPP TR 23.845 [25] may bring a significant optimisation and may impact the structure of the object classes described in the presented hereafter alternatives. + +In the following sub-sections more attributes of some object class may be needed and are left to implementations. Different alternatives are described in order to show how different implementations may differ. + +### 11.1.2 Alternative A + +#### 11.1.2.1 IMS Data + +Table 11.1.2.1-1 + +| Object Class | imsData | | | | +|-----------------------|---------------------------------------------------------------------------|----------------------|------------------------------------------|--------------------------------------------------| +| Description | This class represents the Data Container for subscriber-specific IMS Data | | | | +| Superior OCL | tbd | | | | +| Class Type | STRUCTURAL | | | | +| Direct Superclass(es) | tbd | | | | +| Attribute Name | Type | HSS-FE access rights | Properties | Description | +| imsDataId | UInt8 | read | Naming Attribute mandatory single-valued | Fixed "1" | +| mdtrCap | UInt32 | read | optional multi-valued | Mandatory capabilities of S-CSCF | +| optCap | UInt32 | read | optional multi-valued | Optional capabilities of S-CSCF | +| authorizedCscf | String | read | optional multi-valued | S-CSCF names that may be delivered to the I-CSCF | +| scscfName | String | read, write | optional single-valued | S-CSCF Name assigned | +| primaryChargedId | UInt16 | read | optional single-valued | Identification of the primary charging server | +| secondaryChargedId | UInt16 | read | optional single-valued | Identification of the primary charging server | +| primaryEventId | UInt16 | read | optional single-valued | Identification of the primary event server | +| SecondaryEventId | UInt16 | read | optional single-valued | Identification of the primary event server | + +#### 11.1.2.2 Service Profile Data + +##### 11.1.2.2.1 Service Profile + +**Table 11.1.2.2.1-1** + +| Object Class | ServiceProfile | | | | +|--------------------------|----------------------------------------------------------------|------------------|------------------------------------------|-----------------------------------------------------------------------------| +| Description | This class represents the Data Container for a Service Profile | | | | +| Superior OCL | ImsData | | | | +| Attribute Name | Type | FE access rights | Properties | Description | +| serviceProfileId | UInt32 | read | Naming Attribute mandatory single-valued | The service profile identification associated with the public user identity | +| subscribedMediaProfileId | String | read | optional single-valued | Subscribed media profile identification | +| serviceIdList | UInt32 | read | optional multi-valued | List of service identifications | +| sharedIfcList | UInt16 | read | optional multi-valued | List of shared IFC identifications | + +##### 11.1.2.2.2 Initial Filter Criteria + +**Table 11.1.2.2.2-1** + +| Object Class | IFC | | | | +|----------------------|-------------------------------------------------------------------------|------------------|------------------------------------------|-----------------------------------------------------------------------------------------------------------| +| Description | This class represents the Data Container for an Initial Filter Criteria | | | | +| Superior OCL | ServiceProfile | | | | +| Attribute Name | Type | FE access rights | Properties | Description | +| ifcId | UInt16 | read | Naming Attribute mandatory single-valued | IFC identification | +| asServerNameId | tbd | read | mandatory single-valued | AS identification | +| ifcPriority | UInt32 | read | mandatory single-valued | Priority of the IFC | +| profilePartIndicator | UInt8 | read | optional single-valued | Indicator of the Profile Type with 3 values according if applicable to Registered or Unregistered or both | +| tpParams | String | read | optional single-valued | Trigger Points description | +| defaultHandling | UInt8 | read | optional single-valued | Default Handling | +| svcInfo | String | read | optional single-valued | Transparent information related to the trigger points only used by the application server | + +#### 11.1.2.3 Implicit Registration Set + +**Table 11.1.2.3-1** + +| Object Class | IRSET | | | | +|--------------------|------------------------------------------------------------------------|------------------|------------------------------------------|------------------------------------------------------------------------------------| +| Description | This class represents the Data Container for Implicit Registration Set | | | | +| Superior OCL | ImsData | | | | +| Attribute Name | Type | FE access rights | Properties | Description | +| irSetId | UInt32 | read | Naming Attribute mandatory single-valued | Implicit registration set identification | +| irsPuidList | tbd | read | mandatory multi-valued | List of identifications of public identities sharing the implicit registration set | +| registrationStatus | UInt8 | read, write | mandatory single-valued | Registration status of the implicit registration set | + +#### 11.1.2.4 Public Identity + +**Table 11.1.2.4-1** + +| Object Class | PublicIdentity | | | | +|-------------------|--------------------------------------------------------------|------------------|------------------------------------------|-----------------------------------------------------------------------------------------------------------| +| Description | This class represents the Data Container for Public Identity | | | | +| Superior OCL | ImsData | | | | +| Attribute Name | Type | FE access rights | Properties | Description | +| puidId | tbd | read | Naming Attribute mandatory single-valued | Identification of the public identity | +| puidUsername | String | read | mandatory single-valued | User name part of the public identity | +| puidDomainName | String | read | optional Single-valued | Domain name part of the public identity | +| irSetId | UInt32 | read | optional Single-valued | Identification of the implicit registration set | +| puidType | UInt8 | read | mandatory single-valued | Type of the public identity. Possible values:
0: IMPU
1: PSI
2: wildcard PSI
3: wildcard IMPU | +| serviceProfileId | UInt32 | read | mandatory single-valued | Identification of the service profile associated to the public identity | +| pridList | tbd | read | mandatory multi-valued | List of the identifications of the private identities the public identity is associated with | +| barringIndication | boolean | read | optional single-valued | The barring indication of the public user identity | +| unregSvcInd | Boolean | | | Indicates whether the public user identity has in unregistered state | +| aliasGroupId | UInt8 | read | optional single-valued | Identification of the Alias Group associated to the public user identity | + +#### 11.1.2.5 Private Identity + +Table 11.1.2.5-1 + +| Object Class | PrivateIdentity | | | | +|----------------------------|---------------------------------------------------------------|------------------|------------------------------------------|-----------------------------------------------------------------------------------------------| +| Description | This class represents the Data Container for Private Identity | | | | +| Superior OCL | ImsData | | | | +| Attribute Name | Type | FE access rights | Properties | Description | +| pridId | tbd | read | Naming Attribute mandatory single-valued | Identification of the private identity | +| pridUsername | String | read | mandatory single-valued | User name part of the private identity | +| pridDomainName | String | read | optional Single-valued | Domain name part of the private identity | +| puidList | tbd | read | mandatory multi-valued | List of the identification s of the public identities the private identity is associated with | +| puidRegistrationStatusList | tbd | read, write | optional multi-valued | Registration status of a Prid Puid pair | +| authSchema | UInt8 | read | mandatory single-valued | Authentication scheme associated to the private identity | + +### 11.1.3 Alternative B + +#### 11.1.3.1 IMS Data + +Table 11.1.3.1-1 + +| Object Class | ImsData | | | | +|-----------------------|---------------------------------------------------------------------------|----------------------|------------------------------------------|---------------------------------------------------------------------| +| Description | This class represents the Data Container for subscriber-specific IMS Data | | | | +| Superior OCL | tbd | | | | +| Class Type | STRUCTURAL | | | | +| Direct Superclass(es) | tbd | | | | +| Attribute Name | Type | HSS-FE access rights | Properties | Description | +| svcType | Name10 | read | Naming Attribute mandatory single-valued | Fixed "IMS". | +| mandatoryCapabilities | UInt32 | read | optional multi-valued | Mandatory capabilities of S-CSCF used by I-CSCF to select a S-CSCF. | +| optionalCapabilities | UInt32 | read | optional multi-valued | Optional capabilities of S-CSCF used by I-CSCF to select a S-CSCF. | +| serverNames | String | read | optional multi-valued | Statically configured S-CSCF names to be selected by the I-CSCF. | +| assignedSCSCF | String | read, write | optional single-valued | Assigned S-CSCF for a user. | +| primaryECFName | FQDN | read | optional single-valued | Address of the Primary Online Charging Function. | +| secondaryECFName | FQDN | read | optional single-valued | Address of the Secondary Online Charging Function. | +| PrimaryCCFName | FQDN | read | optional single-valued | Address of the Primary Charging Data Function. | +| secondaryCCFName | FQDN | read | optional single-valued | Address of the Primary Charging Data Function. | + +#### 11.1.3.2 Service Profile Data + +##### 11.1.3.2.1 Service Profile + +**Table 11.1.3.2.1-1** + +| Object Class | ServiceProfile | | | | +|----------------------------------|----------------------------------------------------------------|------------------|------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------| +| Description | This class represents the Data Container for a Service Profile | | | | +| Superior OCL | tbd | | | | +| Attribute Name | Type | FE access rights | Properties | Description | +| serviceProfileId | UInt32 | read | Naming Attribute mandatory single-valued | The service profile Identification associated with the public user identity. | +| coreNet-SubscribedMediaProfileId | UInt32 | read | optional Single-valued | Subscribed media profile Identification which identifies a media profile in the S-CSCF for the authorization of media parameters. | +| coreNet-ServiceIdList | String | read | optional multi-valued | List of Service Ids which identify the IMS Communication Service Identifiers that the subscriber is authorized to use. | +| sharedFilterCriteriaSets | UInt32 | read | optional mandatory multi-valued | The Shared iFC Set ID ist. | + +##### 11.1.3.2.2 Initial Filter Criteria + +**Table 11.1.3.2.2-1** + +| Object Class | InitialFilterCriteria | | | | +|-------------------------|-------------------------------------------------------------------------|------------------|------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Description | This class represents the Data Container for an Initial Filter Criteria | | | | +| Superior OCL | tbd | | | | +| Attribute Name | Type | FE access rights | Properties | Description | +| initialFilterCriteriaId | UInt32 | read | Naming Attribute mandatory single-valued | The Identification of the associated initial filter criteria. | +| applicationServerName | String | read | mandatory single-valued | SIP URI of the application server to contact if the corresponding trigger points are met. | +| priority | UInt32 | read | mandatory single-valued | Priority of the IFC. | +| profilePartIndicator | UInt8 | read | optional single-valued | Indicator of the Profile Type as defined in the 3GPP TS 29.228 [24], i.e. whether the iFC is part of the registered or unregistered user profile. Possible values:
0 - UNREGISTERED
1 - REGISTERED | +| triggerPoints | String | read | optional single-valued | Trigger Points as defined in the 3GPP TS 29.228 [24]. | +| defaultHandling | UInt8 | read | optional single-valued | Default Handling as defined in the 3GPP TS 29.228 [24]. Possible values:
0 - SESSION CONTINUED
1 - SESSION TERMINATED | +| serviceInfo | String | read | optional single-valued | Transparent information related to the trigger points only used by the application server. | + +#### 11.1.3.3 Implicit Registration Set Data + +##### 11.1.3.3.1 Implicit Registration Set + +**Table 11.1.3.2.2-1** + +| Object Class | ImplicitRegistrationSet | | | | +|---------------------------|-------------------------------------------------------------------------------|-------------------------|------------------------------------------|--------------------------------------------------------------------| +| Description | This class represents the Data Container for Implicit Registration Set | | | | +| Superior OCL | Tbd | | | | +| Attribute Name | Type | FE access rights | Properties | Description | +| implicitRegistrationSetID | UInt32 | read | Naming Attribute mandatory single-valued | Identification of the corresponding Implicit Registration Set. | +| publicIdList | PublicIdentity | read | mandatory multi-valued | Public User Identities belonging to the implicit registration set. | + +##### 11.1.3.3.2 Alias Group + +**Table 11.1.3.3.2-1** + +| Object Class | AliasGroup | | | | +|-----------------------|-----------------------------------------------------------------|-------------------------|------------------------------------------|------------------------------------------------------| +| Description | This class represents the Data Container for Alias Group | | | | +| Superior OCL | Tbd | | | | +| Attribute Name | Type | FE access rights | Properties | Description | +| aliasGroupID | UInt32 | read | Naming Attribute mandatory single-valued | Identification of the corresponding Alias Group. | +| publicIdList | PublicIdentity | read | mandatory multi-valued | Public User Identities belonging to the alias group. | + +#### 11.1.3.3 Public Identity + +**Table 11.1.3.3.3-1** + +| Object Class | PublicIdentity | | | | +|---------------------------|--------------------------------------------------------------|------------------|------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------| +| Description | This class represents the Data Container for Public Identity | | | | +| Superior OCL | tbd | | | | +| Attribute Name | Type | FE access rights | Properties | Description | +| publicId | PublicIdentity | read | Naming Attribute mandatory single-valued | Public Identity of the subscriber. | +| idType | UInt8 | read | mandatory single-valued | Type of Public Identity. Possible values:
0 - IMPU
1 - PSI | +| barringIndication | UInt8 | read | optional single-valued | The Barring Indicator of the IMPU. Possible values:
0 - NOT BARRED
1 - BARRED | +| implicitRegistrationSetID | UInt32 | read | optional single-valued | Identification of the Implicit Registration Set the Public User Identity belongs to. This attribute only applies to the Public User Identity. | +| serviceProfileID | UInt32 | read | mandatory single-valued | Identification of the Service Profile the Public Identity is associated with. | +| privateIdList | PrivateIdentity | read | mandatory multi-valued | Private Identities the Public Identity is associated with. | +| registrationStatus | UInt8 | read, write | mandatory multi-valued | The registration status related to the Public Identity. Possible values:
0 - NOT REGISTERED
1 - UNREGISTERED
2 - REGISTERED | +| registeredPrivateIdList | PrivateIdentity | read, write | optional multi-valued | Private Identities the Public Identity is registered with. | +| aliasGroupID | UInt32 | read | optional single-valued | Identification of the Alias Group the public user identity belongs to. It only applies to the Public User Identity. | + +#### 11.1.3.4 Repository Data + +Table 11.1.3.3.4-1 + +| Object Class | RepositoryData | | | | +|-------------------|--------------------------------------------------------------|------------------|------------------------------------------|------------------------------------------------------------| +| Description | This class represents the Data Container for Repository Data | | | | +| Superior OCL | tbd | | | | +| Attribute Name | Type | FE access rights | Properties | Description | +| serviceIndication | String | read, write | Naming Attribute mandatory single-valued | Identifier of one set of service related transparent data. | +| sequenceNumber | UInt32 | read, write | optional single-valued | Sequence number of the Repository data updated. | +| serviceData | OctetString | read, write | optional single-valued | The corresponding service data. | + +#### 11.1.3.5 Private Identity + +**Table 11.1.3.3.5-1** + +| Object Class | PrivateIdentity | | | | +|----------------|---------------------------------------------------------------|------------------|------------------------------------------|-------------------------------------------------------------------------------------| +| Description | This class represents the Data Container for Private Identity | | | | +| Superior OCL | tbd | | | | +| Attribute Name | Type | FE access rights | Properties | Description | +| privateId | PrivateIdentity | read | Naming Attribute mandatory single-valued | Private Identity of the subscriber. | +| idType | UInt8 | read | mandatory single-valued | Type of Public Identity. Possible values:
0 - IMPI
1 - PSI | +| publicIdList | PublicIdentity | read | mandatory multi-valued | Public Identities the Private Identity is associated with. | +| pendingStatus | UInt8 | read, write | Optional single-valued | The authentication pending flag. Possible values:
0 - NOT PENDING
1 - PENDING | +| lineIdentifier | OctetString | read | optional multi-valued | Fixed broadband access line identifiers associated to the user. | +| userName | String | read | optional single-valued | The user name related to the IMPI, which is used to calculate HA1 | +| password | String | read | optional single-valued | The password related to the IMPI, which is used to calculate HA1 | +| Realm | String | read | optional single-valued | The password related to the IMPI, which is used to calculate HA1 | +| ipv4Addr | IPv4Address | read | optional single-valued | IPv4 address related to the IMPI for GIBA. | +| ipv6Prefix | IPv6Prefix | read | optional single-valued | IPv6 prefix related to the IMPI for GIBA. | +| ipv6Addr | IPv6Address | read | optional single-valued | IPv6 address related to the IMPI for GIBA. | + +#### 11.1.3.6 Reference Location Information + +**Table 11.1.3.3.6-1** + +| Object Class | ReferenceLocationInfor | | | | +|--------------------------|-----------------------------------------------------------------------------|------------------|------------------------------------------|---------------------------------------------------------------------------| +| Description | This class represents the Data Container for Reference Location Information | | | | +| Superior OCL | tbd | | | | +| Attribute Name | Type | FE access rights | Properties | Description | +| referenceLocationInforId | UInt8 | read | Naming Attribute mandatory single-valued | Identifier of one set of reference location information. | +| accessType | String | read | optional single-valued | The type of access (e.g. ADSL). | +| accessInfo | String | read | optional single-valued | The type of the access information (e.g. dsl-location). | +| accessValue | String | read | optional single-valued | The location information (e.g. line identifier in fixed access networks). | + +### 11.1.4 Alternative C + +#### 11.1.4.1 IMS Subscription + +Table 11.1.4.1-1 + +| Object Class | IMS-Subscription | | | | +|-----------------------|------------------------------------------------------------------------|----------------------|------------------------------------------|-------------------------------------------------------------------------| +| Description | This class represents the root node for IMS subscription specific data | | | | +| Superior OCL | IMS-Data | | | | +| Class Type | STRUCTURAL | | | | +| Direct Superclass(es) | top | | | | +| Attribute Name | Type | HSS-FE access rights | Properties | Description | +| subscriptionId | tbd | read | Naming Attribute mandatory single-valued | UDR-Internal identification of an IMS-Subscription. | +| sharedIFCsupport | Boolean | read, write | optional single-valued | Indicates whether the assigned S-CSCF (if any) supports shared IFCs. | +| scscfMandCap | tbd | read | optional multi-valued | Mandatory Capabilities an S-CSCF must support to serve the subscription | +| scscfOptCap | tbd | read | optional multi-valued | Optional Capabilities an S-CSCF may support to serve the subscription | +| scscfHost | FQDN | read, write | optional single valued | Diameter Identity of the assigned S-CSCF | +| scscfRealm | FQDN | read, write | optional single valued | Diameter Identity of the assigned S-CSCF | +| ccfPrim | FQDN | read | mandatory single valued | Diameter Identity of the Primary Charging Collection Function | +| ccfSec | FQDN | read | mandatory single valued | Diameter Identity of the Secondary Charging Collection Function | +| ecfPrim | FQDN | read | mandatory single valued | Diameter Identity of the Primary Event Charging Function | +| ecfSec | FQDN | read | mandatory single valued | Diameter Identity of the Secondary Event Charging Function | + +#### 11.1.4.2 Service Profile + +Table 11.1.4.2-1 + +| Object Class | ServiceProfile | | | | +|-----------------------|----------------------------------------|----------------------|------------------------------------------|-----------------------------------------------------------------| +| Description | This class represents service profiles | | | | +| Superior OCL | IMS-Subscription | | | | +| Class Type | STRUCTURAL | | | | +| Direct Superclass(es) | top | | | | +| Attribute Name | Type | HSS-FE access rights | Properties | Description | +| serviceProfileId | tbd | read | Naming Attribute mandatory single-valued | UDR-Internal identification of a Service Profile. | +| sharedFilterIDs | tbd | read | optional multi-valued | List of pointers to shared IFCs within CommonData | +| subMediaProfId | tbd | read | optional single-valued | Core Network Service Authorization: Subscribed Media Profile Id | +| serviceId | tbd | read | optional multi-valued | Core Network Service Authorization: List of Service Ids | + +#### 11.1.4.3 Initial Filter Criteria + +**Table 11.1.4.3-1** + +| Object Class | Filter | | | | +|------------------------------|---------------------------------------------------|-----------------------------|------------------------------------------------|------------------------------------------| +| Description | This class represents user specific filter | | | | +| Superior OCL | ServiceProfile | | | | +| Class Type | STRUCTURAL | | | | +| Direct Superclass(es) | top | | | | +| Attribute Name | Type | HSS-FE access rights | Properties | Description | +| initialFilterCriteriaId | tbd | read | Naming Attribute
mandatory
single-valued | UDR-Internal identification of a Filter. | +| profilePartInd | tbd | read | optional
single-valued | Profile Part Indicator | +| priority | tbd | read | optional
single-valued | Priority | +| applicationServer | tbd | read | optional
single-valued | SIP URL of the Application Server | +| serviceInfo | tbd | read | optional
single-valued | Service Information | +| triggerPoint | tbd | read | optional
single-valued | The Filter's trigger point | + +#### 11.1.4.4 Implicit Registration Set + +Table 11.1.4.4-1 + +| Object Class | | ImplicitRegistrationSet | | | +|---------------------------|---------|--------------------------------------------------|------------------------------------------|--------------------------------------------------------------| +| Description | | This class represents Implicit Registration Sets | | | +| Superior OCL | | IMS-Subscription | | | +| Class Type | | STRUCTURAL | | | +| Direct Superclass(es) | | top | | | +| Attribute Name | Type | HSS-FE access rights | Properties | Description | +| implicitRegistrationSetId | tbd | read | Naming Attribute mandatory single-valued | UDR-Internal identification of an Implicit Registration Set. | +| authenticationPENDING | Boolean | read, write | mandatory single-valued | Authentication-Pending flag | +| registrationStatus | tbd | read, write | mandatory single-valued | Registration Status | +| privateIdentity | tbd | read | mandatory multi-valued | List of Private User Identities | +| forbiddenPLMNsId | tbd | read | optional single-valued | pointer to a list of forbidden PLMNs within CommonData | + +#### 11.1.4.5 Public Identity + +Table 11.1.4.5-1 + +| Object Class | | PublicIdentity | | | +|-----------------------|---------|---------------------------------------------|------------------------------------------|----------------------------------------------------------------------------------------------------------| +| Description | | This class represents IMS Public Identities | | | +| Superior OCL | | ImplicitRegistrationSet | | | +| Class Type | | STRUCTURAL | | | +| Direct Superclass(es) | | top | | | +| Attribute Name | Type | HSS-FE access rights | Properties | Description | +| publicIdentity | tbd | read | Naming Attribute mandatory single-valued | Public User Identity or Public Service Identity | +| barredIndicator | Boolean | read | mandatory single-valued | Indicates whether the PublicIdentity is barred | +| defaultIndicator | Boolean | read | mandatory single-valued | Indicates whether the public identity is the default public identity within the implicit registrationset | +| serviceProfileId | tbd | read | optional single-valued | Name of the service profile associated to the public identity | +| displayName | tbd | read | optional single-valued | | +| aliasId | tbd | read | optional single-valued | Identifies the alias group to which the public identity belongs | +| psiIndicator | Boolean | read | mandatory single-valued | Indicates whether the public identity is a PSI | + +#### 11.1.4.6 Repository Data + +Table 11.1.4.6-1 + +| Object Class | RepositoryData | | | | +|-----------------------|---------------------------------------|----------------------|------------------------------------------|---------------------------------| +| Description | This class represents Repository Data | | | | +| Superior OCL | PublicIdentity | | | | +| Class Type | STRUCTURAL | | | | +| Direct Superclass(es) | top | | | | +| Attribute Name | Type | HSS-FE access rights | Properties | Description | +| serviceIndication | tbd | create, delete | Naming Attribute mandatory single-valued | Identifies the Transparent Data | +| version | tbd | read, write | mandatory single-valued | Version of the Transparent Data | +| data | tbd | read, write | optional single-valued | Transparent Data | + +#### 11.1.4.7 Alias Group + +Table 11.1.4.7-1 + +| Object Class | AliasGroup | | | | +|-----------------------|------------------------------------|----------------------|------------------------------------------|-----------------------------------------------------------| +| Description | This class represents Alias Groups | | | | +| Superior OCL | ImplicitRegistrationSet | | | | +| Class Type | STRUCTURAL | | | | +| Direct Superclass(es) | top | | | | +| Attribute Name | Type | HSS-FE access rights | Properties | Description | +| aliasGroupId | tbd | read | Naming Attribute mandatory single-valued | Identifies the Alias Group | +| serviceProfileId | tbd | read | mandatory single-valued | Name of the service profile associated to the alias group | + +#### 11.1.4.8 Private Identity + +Table 11.1.4.8-1 + +| Object Class | PrivateIdentity | | | | +|-----------------------|------------------------------------------|----------------------|------------------------------------------|---------------------------------| +| Description | This class represents Private Identities | | | | +| Superior OCL | IMS-Subscription | | | | +| Class Type | STRUCTURAL | | | | +| Direct Superclass(es) | top | | | | +| Attribute Name | Type | HSS-FE access rights | Properties | Description | +| privateIdentity | tbd | read | Naming Attribute mandatory single-valued | Identifies the Private Identity | +| authScheme | tbd | read | mandatory single-valued | | +| imsi | tbd | read | optional single-valued | | +| digestHa1 | tbd | read | optional single-valued | | +| | | | | | + +### 11.1.5 Alternative D + +#### 11.1.5.1 IMS Private Identity + +Table 11.1.5.1-1 + +| Object Class | Imslmpi | | | | +|------------------------------|--------------------------------------------------------------------------|-----------------------------|------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Description | This class represents the Data Container for IMS Private Identity | | | | +| Superior OCL | IMS-Data | | | | +| Class Type | tbd | | | | +| Direct Superclass(es) | tbd | | | | +| Attribute Name | Type | HSS-FE access rights | Properties | Description | +| ImsImpId | tbd | Read | Naming Attribute
Mandatory
Single-valued | This attribute identifies this Object Class. | +| ImsPassw | String | Read | Optional
Single-valued | This attribute contains the password to be used for SIP Digest authentication | +| ImsAuthSchMask | Enumerated | Read | Mandatory | This attribute indicates IMS supported authentication mechanisms. | +| ImsRoamAllow | Boolean | Read | Mandatory
Single-valued | This attribute indicates whether the user is allowed to roam.

Possible values are:

TRUE – The user is allowed to roam
FALSE – The user is not allowed to roam | + +#### 11.1.5.2 IMS Public Identity + +Table 11.1.5.2-1 + +| Object Class | ImsImpu | | | | +|-----------------------|------------------------------------------------------------------|----------------------|------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Description | This class represents the Data Container for IMS Public Identity | | | | +| Superior OCL | IMS-Data | | | | +| Class Type | tbd | | | | +| Direct Superclass(es) | tbd | | | | +| Attribute Name | Type | HSS-FE access rights | Properties | Description | +| IMPU | tbd | Read | Naming Attribute
Mandatory
Single-valued | This attribute identifies this Object Class | +| ImsAssocImpi | tbd | Read | Optional
Single-valued | This attribute indicates the Private Identity associated to this Public Identity | +| ImsServProfId | String | Read | Optional
Single-valued | This attribute indicates the Service Profile associated to this IMS Public Identity. | +| AliasGroupId | String | Read | Optional
Single-valued | This attribute identifies corresponding Alias Group, if any. | +| ImsIrs | UInt16 | Read | Mandatory
Single-valued | This attribute indicates to which implicit registration set (IRS) the IMS Public Identity belongs to. See 3GPP TS 23.008 [5], section 3.1.6.

If the Public Identity does not belong to an IRS, the value of this attribute shall be 0. | +| ImsSessBarrInd | Boolean | Read | Mandatory
Single-valued | This attribute indicates whether the IMPU is barred for session establishment. See 3GPP TS 23.008 [5], section 3.1.3.

Possible values are:

TRUE – Identity is barred
FALSE – Identity is not barred | +| ImsIsDefault | Boolean | Read | Mandatory
Single-valued | This attribute indicates whether this Public Identity is the default one within the IRS. See 3GPP TS 23.008 [5], section 3.1.7.

Possible values are:

TRUE – The identity is the default within the IRS
FALSE – The identity is not the default within the IRS | + +#### 11.1.5.3 IMS Service Profile + +Table 11.1.5.3-1 + +| Object Class | IMS ServiceProfile | | | | +|-----------------------|--------------------------------------------------------------|----------------------|------------------------------------------------|--------------------------------------------------------------| +| Description | This class represents the Data Container for Service Profile | | | | +| Superior OCL | IMS-Data | | | | +| Class Type | tbd | | | | +| Direct Superclass(es) | tbd | | | | +| Attribute Name | Type | HSS-FE access rights | Properties | Description | +| ImServProfId | String | Read | Naming Attribute
Mandatory
single-valued | This attribute identifies this Object Class | +| AliasGroupId | String | Read | Optional
Single-valued | This attribute identifies corresponding Alias Group, if any. | + +#### 11.1.5.4 Alias Group + +Table 11.1.5.4-1 + +| Object Class | AliasGroup | | | | +|-----------------------|----------------------------------------------------------|----------------------|------------------------------------------------|------------------------------------------------------------------------------| +| Description | This class represents the Data Container for Alias Group | | | | +| Superior OCL | IMS-Data | | | | +| Class Type | tbd | | | | +| Direct Superclass(es) | tbd | | | | +| Attribute Name | Type | HSS-FE access rights | Properties | Description | +| AliasGroupId | String | Read | Naming Attribute
Mandatory
Single-valued | This attribute identifies this Object Class | +| ImServProfId | String | read | Mandatory
single-valued | This attribute indicates the Service Profile associated to this Alias Group. | + +## 11.2 Directory Information Tree + +### 11.2.0 General + +In the following sub-sections more object classes may be needed and are left to implementations. Different alternatives are described in order to show how different implementations may differ. + +### 11.2.1 Alternative A + +![DIT Structure for IMS-Data with Alternative A. The diagram shows a hierarchy starting with IMS-Data at the top. IMS-Data has attributes: mdrCap, optCap, authorizedCSCF, scsfName, primaryChargeId, secondaryChargeId, primaryEventId, and secondaryEventId. It branches into four object classes: ServiceProfile, IRSET, PublicIdentity, and PrivateIdentity. ServiceProfile has attributes: subscribedMediaProfileId, serviceIdList, and sharedIfcList. It branches into IFC (attributes: asServerNameId, ifcPriority, profilePartIndicator, tpParams, defaultHandling, svcInfo) via ifcId=xxx. IRSET has attributes: irsPuidList and registrationStatus, connected via irSetId=xxx. PublicIdentity has attributes: puidUsername, puidDomainName, puidType, serviceProfileId, puidList, irSetId, barringIndication, unregSvcInd, and aliasGroupId, connected via puidId=xxx. PrivateIdentity has attributes: pridUsername, pridDomainName, pridList, pridRegistrationStatusList, and authSchema, connected via pridId=xxx. A dotted arrow points from PublicIdentity to PrivateIdentity.](e05b36c0d46549e681ce6581422c66b2_img.jpg) + +DIT Structure for IMS-Data with Alternative A. The diagram shows a hierarchy starting with IMS-Data at the top. IMS-Data has attributes: mdrCap, optCap, authorizedCSCF, scsfName, primaryChargeId, secondaryChargeId, primaryEventId, and secondaryEventId. It branches into four object classes: ServiceProfile, IRSET, PublicIdentity, and PrivateIdentity. ServiceProfile has attributes: subscribedMediaProfileId, serviceIdList, and sharedIfcList. It branches into IFC (attributes: asServerNameId, ifcPriority, profilePartIndicator, tpParams, defaultHandling, svcInfo) via ifcId=xxx. IRSET has attributes: irsPuidList and registrationStatus, connected via irSetId=xxx. PublicIdentity has attributes: puidUsername, puidDomainName, puidType, serviceProfileId, puidList, irSetId, barringIndication, unregSvcInd, and aliasGroupId, connected via puidId=xxx. PrivateIdentity has attributes: pridUsername, pridDomainName, pridList, pridRegistrationStatusList, and authSchema, connected via pridId=xxx. A dotted arrow points from PublicIdentity to PrivateIdentity. + +Figure 11.2.1-1: DIT Structure for IMS-Data with Alternative A + +The dotted arrow indicates the relationship between PublicIdentity and PrivateIdentity which is expressed by the attributes PrivateIdList and PublicIdList. + +The superior OCL description of the ImsData object class and some more detailed description of object classes and attributes are FFS. + +### 11.2.2 Alternative B + +![DIT Structure for IMS-Data with Alternative B. The diagram shows a hierarchy starting with IMS-Data at the top. IMS-Data has attributes: MandatoryCapabilities, OptionalCapabilities, ServerNames, AssignedS-CSCF, Primary-ECFName, Secondary-ECFName, Primary-CCFName, and Secondary-CCFName. It branches into four object classes: ServiceProfile, ImplicitRegistrationSet, PublicIdentity, and PrivateIdentity. ServiceProfile has attributes: CoreNet-SubscribedMediaProfileId, CoreNet-ServiceIdList, and SharedFilterCriteriaSets. It branches into InitialFilterCriteria (attributes: ApplicationServerName, Priority, ProfilePartIndicator, TriggerPoints, DefaultHandling, ServiceInfo) via initialFilterCriteriaId=xxx. ImplicitRegistrationSet has attributes: aliasGroupId=xxx, which branches into AliasGroup (attributes: PublicIdList). PublicIdentity has attributes: IdType, BarringIndication, ImplicitRegistrationSetID, ServiceProfileID, PrivateIdList, RegistrationStatus, RegisteredPrivateIdList, and AliasGroupID. It branches into RepositoryData (attributes: SequenceNumber, ServiceData) via serviceIdication=xxx. PrivateIdentity has attributes: IdType, PublicIdList, PendingStatus, LineIdentifier, UserName, password, Realm, IPv4Addr, IPv6Prefix, and IPv6Addr. It branches into ReferenceLocationInfo (attributes: refLocInfoId=xxx). A dotted arrow points from PublicIdentity to PrivateIdentity.](f0b7abcb093621bb310bf61fbe0f0d2d_img.jpg) + +DIT Structure for IMS-Data with Alternative B. The diagram shows a hierarchy starting with IMS-Data at the top. IMS-Data has attributes: MandatoryCapabilities, OptionalCapabilities, ServerNames, AssignedS-CSCF, Primary-ECFName, Secondary-ECFName, Primary-CCFName, and Secondary-CCFName. It branches into four object classes: ServiceProfile, ImplicitRegistrationSet, PublicIdentity, and PrivateIdentity. ServiceProfile has attributes: CoreNet-SubscribedMediaProfileId, CoreNet-ServiceIdList, and SharedFilterCriteriaSets. It branches into InitialFilterCriteria (attributes: ApplicationServerName, Priority, ProfilePartIndicator, TriggerPoints, DefaultHandling, ServiceInfo) via initialFilterCriteriaId=xxx. ImplicitRegistrationSet has attributes: aliasGroupId=xxx, which branches into AliasGroup (attributes: PublicIdList). PublicIdentity has attributes: IdType, BarringIndication, ImplicitRegistrationSetID, ServiceProfileID, PrivateIdList, RegistrationStatus, RegisteredPrivateIdList, and AliasGroupID. It branches into RepositoryData (attributes: SequenceNumber, ServiceData) via serviceIdication=xxx. PrivateIdentity has attributes: IdType, PublicIdList, PendingStatus, LineIdentifier, UserName, password, Realm, IPv4Addr, IPv6Prefix, and IPv6Addr. It branches into ReferenceLocationInfo (attributes: refLocInfoId=xxx). A dotted arrow points from PublicIdentity to PrivateIdentity. + +Figure 11.2.2-1: DIT Structure for IMS-Data with Alternative B + +CoreNet-SubscribedMediaProfileId, CoreNet-ServiceIdList and SharedFilterCriteriaSets are optional attributes in Service Profile entry. + +The dotted arrow indicates the relationship between PublicIdentity and PrivateIdentity which is expressed by the attributes PrivateIdList and PublicIdList. + +Multiple instances of ReferenceLocInfo (refLocInfo=xxx) is for future releases. + +### 11.2.3 Alternative C + +![DIT Structure for IMS-Data with Alternative C](b904ac2472cab80892d1e783e6230d6e_img.jpg) + +``` + +graph TD + IMSData((IMS-Data)) -- subscriptionId=xxx --> IMSSubscription((IMS-Subscription)) + IMSSubscription -- serviceProfileId=xxx --> ServiceProfile((ServiceProfile)) + IMSSubscription -- implicitRegistrationSetId=xxx --> ImplicitRegistrationSet((ImplicitRegistrationSet)) + IMSSubscription -- privateIdentity=xxx --> PrivateIdentity((PrivateIdentity)) + ServiceProfile -- initialFilterCriteriaId=xxx --> InitialFilterCriteria((InitialFilterCriteria)) + ImplicitRegistrationSet -- publicIdentity=xxx --> PublicIdentity((PublicIdentity)) + ImplicitRegistrationSet -- aliasGroupId=xxx --> AliasGroup((AliasGroup)) + PublicIdentity -- serviceIndication=xxx --> RepositoryData((RepositoryData)) + +``` + +The diagram illustrates the DIT structure for IMS-Data with Alternative C. It shows a hierarchy of objects and their relationships: + +- IMS-Data** (Root object) contains an attribute **subscriptionId=xxx**. It is connected to **IMS-Subscription**. +- IMS-Subscription** contains attributes: **sharedFCSupport**, **scsefMandCap**, **scsefOptCap**, **scsefHost**, **scsefRealm**, **ccfPrim**, **ccfSec**, **ccfPrim**, and **ccfSec**. It is connected to three objects: + - ServiceProfile** via **serviceProfileId=xxx**. + - ImplicitRegistrationSet** via **implicitRegistrationSetId=xxx**. + - PrivateIdentity** via **privateIdentity=xxx**. +- ServiceProfile** contains attributes: **sharedFilterIDs**, **subMediaProfId**, and **serviceId**. It is connected to **InitialFilterCriteria** via **initialFilterCriteriaId=xxx**. +- ImplicitRegistrationSet** contains attributes: **authenticationPending**, **registrationStatus**, **privateIdentity**, and **forbiddenPLMNsId**. It is connected to: + - PublicIdentity** via **publicIdentity=xxx**. + - AliasGroup** via **aliasGroupId=xxx**. +- PrivateIdentity** contains attributes: **authScheme**, **imsi**, and **digestHA1**. +- InitialFilterCriteria** contains attributes: **profilePartInd**, **priority**, **applicationServer**, **serviceInfo**, and **triggerPoint**. +- PublicIdentity** contains attributes: **barredIndicator**, **defaultIndicator**, **serviceProfileId**, **displayName**, **aliasGroupId**, and **pslIndicator**. It is connected to **RepositoryData** via **serviceIndication=xxx**. +- AliasGroup** contains attribute: **serviceProfileId**. +- RepositoryData** contains attributes: **version** and **data**. + +DIT Structure for IMS-Data with Alternative C + +**Figure 11.2.3-1: DIT Structure for IMS-Data with Alternative C** + +If an ImplicitRegistrationSet contains a PublicIdentity which is a PSI then it shall not contain any other PublicIdentity. + +If an ImplicitRegistrationSet contains a single PublicIdentity, this Public Identity is not implicitly registered with any other Public Identity and therefore in stage 2 terms is not considered to belong to an Implicit Registration Set. + +The concept of multiple IMS-Subscriptions within IMS-Data is not described in the present document. + +### 11.2.4 Alternative D + +![DIT Structure for IMS-Data with Alternative D. The diagram shows a central IMS-Data entity connected to PrivateIdentity, PublicIdentity, ServiceProfile, and AliasGroup. PrivateIdentity is connected to IMS-Data via privateIdentity=xxx and contains Authentication schemes. PublicIdentity is connected to IMS-Data via publicIdentity=xxx and contains IMPI Id List, ServiceProfileID, AliasGroupID, and ImplicitRegistrationSetID. ServiceProfile is connected to IMS-Data via serviceProfileId=xxx and contains aliasGroupId. AliasGroup is connected to IMS-Data via aliasGroupId=xxx and contains serviceProfileId. InitialFilterCriteria is connected to ServiceProfile via initialFilterCriteriaId=xxx.](b51423b6c049f5b5fcde42e50b58f18b_img.jpg) + +``` + +graph TD + IMSData((IMS-Data)) -- privateIdentity=xxx --> PrivateIdentity((PrivateIdentity +Authentication schemes)) + IMSData -- publicIdentity=xxx --> PublicIdentity((PublicIdentity +IMPI Id List +ServiceProfileID +AliasGroupID +ImplicitRegistrationSetID)) + IMSData -- serviceProfileId=xxx --> ServiceProfile((ServiceProfile +aliasGroupId)) + IMSData -- aliasGroupId=xxx --> AliasGroup((AliasGroup +serviceProfileId)) + ServiceProfile -- initialFilterCriteriaId=xxx --> InitialFilterCriteria((InitialFilterCriteria)) + +``` + +DIT Structure for IMS-Data with Alternative D. The diagram shows a central IMS-Data entity connected to PrivateIdentity, PublicIdentity, ServiceProfile, and AliasGroup. PrivateIdentity is connected to IMS-Data via privateIdentity=xxx and contains Authentication schemes. PublicIdentity is connected to IMS-Data via publicIdentity=xxx and contains IMPI Id List, ServiceProfileID, AliasGroupID, and ImplicitRegistrationSetID. ServiceProfile is connected to IMS-Data via serviceProfileId=xxx and contains aliasGroupId. AliasGroup is connected to IMS-Data via aliasGroupId=xxx and contains serviceProfileId. InitialFilterCriteria is connected to ServiceProfile via initialFilterCriteriaId=xxx. + +Figure 11.2.4-1: DIT Structure for IMS-Data with Alternative D + +## 11.3 UML model + +This section covers the information model for IMS Data and all its permanent data entities. The term IMS Data may also include temporary data as shown in the corresponding DITs. + +Some data entities are already defined in 3GPP TS 32.182 [3]. + +Figure 11.3-1 covers some basic IMS entities with two possible approaches: + +- Approach A: where IMPU and PSI are considered as different basic entities; +- Approach B: where a Public Identity basic IMS entity may identify a Public User Identity or a Public Service Identity and a Private Identity basic IMS entity may identify a Private User Identity or a Private Service Identity. The rational of Approach B is that Public User Identity and Public Service Identity have many common points. They have the same inheritance diagram with SIP URI or Tel URI. Public User Identity or Public Service Identity have compatible associations with other entities such as IMS Data or IMS Service profile. This modelling reduces the number of IMS basic entities and associations. Then, the differentiation between a Public User Identity and a Public Service Identity may be done by an attribute within the Public identity. + +It is left to implementation to identify the most suited approach according to the further model inputs. + +![UML Class diagram for Figure 11.3-1A showing IMS entities and their relationships.](6e15fc9ea763541c5913d26f85072ae1_img.jpg) + +``` + +classDiagram + class IMSData["IMS Data"] + class UDSubscription["UDC Subscription"] + class IMSServiceCapability["IMS service capability"] + class IMPU["IMPU"] + class IMPI["IMPI"] + class ImplicitRegistrationSet["Implicit Registration Set"] + class UDIMSServiceProfile["UDC IMS Service profile"] + + IMSData <|-- UDSubscription + IMSData "1" -- "0..n" IMSServiceCapability + IMSData "1" -- "1..n" IMPU + IMSData "1" -- "1..n" IMPI + IMSData "1" -- "0..n" ImplicitRegistrationSet + IMPU "1..n" -- "1..n" IMPI + IMPU "1..n" -- "1" ImplicitRegistrationSet + IMPU "1..n" -- "1..n" UDIMSServiceProfile + IMPI "1..n" -- "1..n" ImplicitRegistrationSet + IMPI "1..n" -- "1..n" UDIMSServiceProfile + ImplicitRegistrationSet "1" -- "1..n" UDIMSServiceProfile + +``` + +UML Class diagram for Figure 11.3-1A showing IMS entities and their relationships. + +Figure 11.3-1A Information model for some IMS entities with approach A + +![UML Class diagram for Figure 11.3-1B showing IMS entities and their relationships.](0ee9d674085524d589646a6c3fb21ec3_img.jpg) + +``` + +classDiagram + class IMSData["IMS Data"] + class UDSubscription["UDC Subscription"] + class IMSServiceCapability["IMS service capability"] + class PublicIdentity["Public Identity"] + class PrivateIdentity["Private Identity"] + class ImplicitRegistrationSet["Implicit Registration Set"] + class UDIMSServiceProfile["UDC IMS Service profile"] + + IMSData <|-- UDSubscription + IMSData "1" -- "1..n" IMSServiceCapability + IMSData "1" -- "1..n" PublicIdentity + IMSData "1" -- "1..n" PrivateIdentity + IMSData "1" -- "0..n" ImplicitRegistrationSet + PublicIdentity "1..n" -- "1..n" PrivateIdentity + PublicIdentity "1..n" -- "1" ImplicitRegistrationSet + PublicIdentity "1..n" -- "1..n" UDIMSServiceProfile + PrivateIdentity "1..n" -- "1..n" ImplicitRegistrationSet + PrivateIdentity "1..n" -- "1..n" UDIMSServiceProfile + ImplicitRegistrationSet "1" -- "1..n" UDIMSServiceProfile + +``` + +UML Class diagram for Figure 11.3-1B showing IMS entities and their relationships. + +Figure 11.3-1B Information model for some IMS entities with approach B + +Figure 11.3-2 covers IMS Public User Identity and its relationship with other IMS data entities. + +![Information model for IMS Public User Identity and some surrounding entities](2837ffdadcdb1e5bababa56b564e56ed_img.jpg) + +``` +graph BT; W_SIP[Wildcarded SIP URI] --|> SIP[SIP URL]; W_Tel[Wildcarded Tel URI] --|> Tel[Tel URL]; SIP --|> IMPU[IMPU]; Tel --|> IMPU +``` + +The diagram illustrates the inheritance hierarchy for IMS Public User Identity (IMPU). At the top is the IMPU entity. Below it, SIP URL and Tel URL are shown as sub-entities that inherit from IMPU. Further down, Wildcarded SIP URI and Wildcarded Tel URI are shown as sub-entities that inherit from SIP URL and Tel URL respectively. + +Information model for IMS Public User Identity and some surrounding entities + +**Figure 11.3-2 Information model for IMS Public User Identity and some surrounding entities** + +Figure 11.3-3 covers IMS Public Service Identity and its relationship with other IMS data entities. + +![Information model for IMS Public Service Identity and some surrounding entities](ac31fdfebb9751f7f10416dfe33bc872_img.jpg) + +``` +graph BT; W_SIP[Wildcarded SIP URI] --|> SIP[SIP URI]; W_Tel[Wildcarded Tel URI] --|> Tel[Tel URI]; SIP --|> PSI[PSI]; Tel --|> PSI +``` + +The diagram illustrates the inheritance hierarchy for IMS Public Service Identity (PSI). At the top is the PSI entity. Below it, SIP URI and Tel URI are shown as sub-entities that inherit from PSI. Further down, Wildcarded SIP URI and Wildcarded Tel URI are shown as sub-entities that inherit from SIP URI and Tel URI respectively. + +Information model for IMS Public Service Identity and some surrounding entities + +**Figure 11.3-3 Information model for IMS Public Service Identity and some surrounding entities** + +Figure 11.3-4 covers IMS Public User Identity Implicit Registration Set and its relationship with Alias Group, and IMS Public User Identity. + +NOTE: Alias Group is used as a simplification of the 3GPP TS 23.228 defined term Alias Public User Identities. In 3GPP TS 23.228 this is referred sometimes as well as Alias Public User Identity Group or Alias Public User Identity Set. + +Following constraints apply: + +- All Public User Identities of an Implicit Registration set must be associated to the same Private User Identities. +- Each IMPU can only be included in one Alias Group + +![Figure 11.3-4: Information model for IMS Public User Identity Implicit Registration Set and its relationship with IMS Public User Identity and Alias Group. The diagram shows four entities: Implicit Registration Set, IMPU, Alias Group, and I MPI. Implicit Registration Set (1) is associated with IMPU (1..n) and Alias Group (0..n). Alias Group (1) is associated with IMPU (1..n). IMPU (1..n) is associated with I MPI (1..n).](78ff716475b2f65bf01c3a4d02d89fc4_img.jpg) + +``` + +classDiagram + class IRS[Implicit Registration Set] + class IMPU[IMPU] + class AG[Alias Group] + class IMPI[I MPI] + + IRS "1" -- "1..n" IMPU + IRS "1" -- "0..n" AG + AG "1" -- "1..n" IMPU + IMPU "1..n" -- "1..n" IMPI + +``` + +Figure 11.3-4: Information model for IMS Public User Identity Implicit Registration Set and its relationship with IMS Public User Identity and Alias Group. The diagram shows four entities: Implicit Registration Set, IMPU, Alias Group, and I MPI. Implicit Registration Set (1) is associated with IMPU (1..n) and Alias Group (0..n). Alias Group (1) is associated with IMPU (1..n). IMPU (1..n) is associated with I MPI (1..n). + +**Figure 11.3-4 Information model for IMS Public User Identity Implicit Registration Set and its relationship with IMS Public User Identity and Alias Group** + +Figure 11.3-5 covers IMS Data and its relationship with Public Identity that provides coherence between approach A and approach B, since IMPU and PSI are derived entities from the more generic Public Identity + +The figure implies that a Public Identity can not exist without IMS Data. On the other hand, IMS Data is defined for IMPU(s) or PSI(s), but not for both at the same time. + +![Figure 11.3-5: Information model for Public Identity. The diagram shows IMS Data (1) associated with Public Identity (1..n) via a composition relationship. Public Identity is a general entity with two subclasses: IMPU and PSI.](6be06b7dc72bb42afcb3465394667c3b_img.jpg) + +``` + +classDiagram + class ID[Public Identity] + class IMD[IMS Data] + class IMPU[IMPU] + class PSI[PSI] + + IMD "1" *-- "1..n" ID + ID <|-- IMPU + ID <|-- PSI + +``` + +Figure 11.3-5: Information model for Public Identity. The diagram shows IMS Data (1) associated with Public Identity (1..n) via a composition relationship. Public Identity is a general entity with two subclasses: IMPU and PSI. + +**Figure 11.3-5 Information model for Public Identity** + +Figure 11.3-6 covers IMS Alias Group information model. + +![Figure 11.3-6: Information model for Alias Group. The diagram shows Alias Group (1) associated with IMPU (1..n) via a composition relationship.](02d0c8a07c481d880b73a25d02050fad_img.jpg) + +``` + +classDiagram + class AG[Alias Group] + class IMPU[IMPU] + + AG "1" *-- "1..n" IMPU + +``` + +Figure 11.3-6: Information model for Alias Group. The diagram shows Alias Group (1) associated with IMPU (1..n) via a composition relationship. + +**Figure 11.3-6 Information model for Alias Group** + +# 12 Conclusion and Recommendation + +The present study, although focused on IMS data model and not fully completed, has shown that different alternatives for UDC Service Profile (section 7) and UDC IMS Service Data (section 12) are supported in current deployments and implementations and that a common base could not be found. This is mainly due to the fact that existing FE application logics may be impacted when changing the data model and this has been evaluated as not acceptable during the work. + +For the above reasons a standardized Reference Data Model (RDM) for the Ud interface between Front-Ends for the HSS application (HSS-FEs) and the User Data Repository (UDR) is not agreeable. + +It is therefore recommended not to start normative specification work on the definition of a Reference Data Model. + +It is further recommended to add text to 3GPP TS 29.335 indicating that specifying a standardized RDM is out of scope of 3GPP specifications and hence Ud data model is proprietary. + +For multivendor interoperability between FEs and UDR specific integration projects are needed in order to accommodate data required by different vendors FEs into UDR. To this end the present document may represent a valid example of data models implementation in operator's network. + +# Annex A: Change history + +| Change history | | | | | | | | +|----------------|-------|-----------|----|-----|--------------------------------|--------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 2012-09 | CT#57 | CP-120484 | | | Presented for approval | 2.0.0 | 11.0.0 | +| 2014-09 | - | - | - | - | Update to Rel-12 version (MCC) | 11.0.0 | 12.0.0 | +| 2015-12 | - | - | - | - | Update to Rel-13 version (MCC) | 12.0.0 | 13.0.0 | +| 2017-03 | - | - | - | - | Update to Rel-14 version (MCC) | 13.0.0 | 14.0.0 | +| 2018-10 | - | - | - | - | Update to Rel-15 version (MCC) | 14.0.0 | 15.0.0 | +| 2020-07 | - | - | - | - | Update to Rel-16 version (MCC) | 15.0.0 | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29949/28d75f39a24203712ee907b32cf0bbe5_img.jpg b/marked/Rel-16/29_series/29949/28d75f39a24203712ee907b32cf0bbe5_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1609591de72d72fbbcc6e63a3803d197e009f899 --- /dev/null +++ b/marked/Rel-16/29_series/29949/28d75f39a24203712ee907b32cf0bbe5_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:061a400bffb51fbf4cdf65ef9feb6e6dcf2551795b9913a00d39fa3b809a870b +size 100106 diff --git a/marked/Rel-16/29_series/29949/32ff77da4286b58c4778033acaa10836_img.jpg b/marked/Rel-16/29_series/29949/32ff77da4286b58c4778033acaa10836_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2bc1e879bae647ebc31e78c05bf71c589a149449 --- /dev/null +++ b/marked/Rel-16/29_series/29949/32ff77da4286b58c4778033acaa10836_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:94f5e73a1b612c935e8c406982ec4d01a4ab239970018016e0ad574839fc5b95 +size 139117 diff --git a/marked/Rel-16/29_series/29949/347010b7ac06d3ae97927fde0f784d7c_img.jpg b/marked/Rel-16/29_series/29949/347010b7ac06d3ae97927fde0f784d7c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c78695dac4a74bb60b40f7dab2783833050d6442 --- /dev/null +++ b/marked/Rel-16/29_series/29949/347010b7ac06d3ae97927fde0f784d7c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a9c8a34627b1dd91f3f00c4899063bef884e2c5a26b37a2d48e5968c6e72d831 +size 160001 diff --git a/marked/Rel-16/29_series/29949/63e0c22852c26699d0bd095a2d796bab_img.jpg b/marked/Rel-16/29_series/29949/63e0c22852c26699d0bd095a2d796bab_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c7aa3974ff24dd7fd0bdc9cf446c2593ed277ea0 --- /dev/null +++ b/marked/Rel-16/29_series/29949/63e0c22852c26699d0bd095a2d796bab_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:eff09280723b298176f4df499ba7db40b95e0772d3a54c7c8e53bfbc82b531be +size 74768 diff --git a/marked/Rel-16/29_series/29949/64cda8ce20067bc360ce2f3a5c9352b7_img.jpg b/marked/Rel-16/29_series/29949/64cda8ce20067bc360ce2f3a5c9352b7_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a0a1eb3a86a189e7c8ac1f43780f4caebf70f3c0 --- /dev/null +++ b/marked/Rel-16/29_series/29949/64cda8ce20067bc360ce2f3a5c9352b7_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d9eaddf3e2d22b6c1ad375426e50397cccc5e5d6a47df89ef254446de997761b +size 121817 diff --git a/marked/Rel-16/29_series/29949/7472c67897a35ed6b67fcb47ea4c6b6c_img.jpg b/marked/Rel-16/29_series/29949/7472c67897a35ed6b67fcb47ea4c6b6c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..742e21985fc33ad0498c09ae2e9b2944a69297f7 --- /dev/null +++ b/marked/Rel-16/29_series/29949/7472c67897a35ed6b67fcb47ea4c6b6c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e98ca2e898d31edc072334d15969b5a1bed0976adfdcb3f328c2b631636ee2f7 +size 119405 diff --git a/marked/Rel-16/29_series/29949/78ff716475b2f65bf01c3a4d02d89fc4_img.jpg b/marked/Rel-16/29_series/29949/78ff716475b2f65bf01c3a4d02d89fc4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1327f42be3e276f4f7683c439ef3f6adf5382c31 --- /dev/null +++ b/marked/Rel-16/29_series/29949/78ff716475b2f65bf01c3a4d02d89fc4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:abfc4a858e584117f90fc6c9ad908dd449173d155cd6f7c986f0ee8d44110d95 +size 73562 diff --git a/marked/Rel-16/29_series/29949/886963464425186f4a465fa8155d2a3c_img.jpg b/marked/Rel-16/29_series/29949/886963464425186f4a465fa8155d2a3c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f1cf2a296ce8fc84bb940af69c6212edb66412ec --- /dev/null +++ b/marked/Rel-16/29_series/29949/886963464425186f4a465fa8155d2a3c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e1e4bf4292363bda09b1243a399e7258443939e2c3c42f6b7038bf8cc2895138 +size 113353 diff --git a/marked/Rel-16/29_series/29949/b87818c8505328b198d035761bbc3f2d_img.jpg b/marked/Rel-16/29_series/29949/b87818c8505328b198d035761bbc3f2d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5a0c342e918d701d848d444f9b08dc5fa8270a25 --- /dev/null +++ b/marked/Rel-16/29_series/29949/b87818c8505328b198d035761bbc3f2d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bbee37b14baffda51cc575228a84a448f4010e2e40983f9fa400cffc1333edb2 +size 117202 diff --git a/marked/Rel-16/29_series/29949/d0654bc33a544f31c1cb3e0cd77e0aab_img.jpg b/marked/Rel-16/29_series/29949/d0654bc33a544f31c1cb3e0cd77e0aab_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..58257252eb8acb79f094e92a3632ce2c6ad1850b --- /dev/null +++ b/marked/Rel-16/29_series/29949/d0654bc33a544f31c1cb3e0cd77e0aab_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:79027ed2be76189861b5d7806afcddff0d2be1f64af1bb3da71629732fd841a2 +size 82239 diff --git a/marked/Rel-16/29_series/29949/df1966d80c74bc127f159a48f38b13ee_img.jpg b/marked/Rel-16/29_series/29949/df1966d80c74bc127f159a48f38b13ee_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8cfb1a62d3235b7fb279c9f27b98bacb90ce65d1 --- /dev/null +++ b/marked/Rel-16/29_series/29949/df1966d80c74bc127f159a48f38b13ee_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e14fdd9b0bf1d54467a91db8c8a4ab994e9e926ea8901d00c7fd561140387540 +size 132511 diff --git a/marked/Rel-16/29_series/29949/e180f2b5fcbe8001554a7c0677cd3f82_img.jpg b/marked/Rel-16/29_series/29949/e180f2b5fcbe8001554a7c0677cd3f82_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f87387043fb55533745db85dfb91a088a0832c79 --- /dev/null +++ b/marked/Rel-16/29_series/29949/e180f2b5fcbe8001554a7c0677cd3f82_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fcd64ed31ffb4ee6b1a678cb973105a37be21d183631c0f74d5e4906ab553647 +size 72220 diff --git a/marked/Rel-16/29_series/29949/e190b6ddb7c2e64b940749a1c5612256_img.jpg b/marked/Rel-16/29_series/29949/e190b6ddb7c2e64b940749a1c5612256_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a0e76bfd08691e4204c978d433bdcabe83d20f43 --- /dev/null +++ b/marked/Rel-16/29_series/29949/e190b6ddb7c2e64b940749a1c5612256_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cac3220591522b000a0489c007ae55681981df5282673861f622c3d211ec8316 +size 39242 diff --git a/marked/Rel-16/29_series/29949/e9d825d87c5f85c8dba0664eace96ef4_img.jpg b/marked/Rel-16/29_series/29949/e9d825d87c5f85c8dba0664eace96ef4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7cf48385ed46615dba69757af49f9365d55cc2ae --- /dev/null +++ b/marked/Rel-16/29_series/29949/e9d825d87c5f85c8dba0664eace96ef4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:345f833f28afcbfe4bbb5dac1016527516cbfdb826f9594420dc0666d7dd20b2 +size 83179 diff --git a/marked/Rel-16/29_series/29949/raw.md b/marked/Rel-16/29_series/29949/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..7bceeab85df84d7a537c95a0b2dcbe1d08ac288b --- /dev/null +++ b/marked/Rel-16/29_series/29949/raw.md @@ -0,0 +1,5627 @@ + + + + + + +# Contents + +| | | +|---------------------------------------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions and abbreviations ..... | 7 | +| 3.1 Definitions..... | 7 | +| 3.2 Abbreviations ..... | 9 | +| 4 Overview..... | 10 | +| 4.1 General ..... | 10 | +| 4.2 3GPP specifications relevant for roaming architecture and procedures ..... | 10 | +| 4.3 Consideration of SIP header fields and elements..... | 11 | +| 4.3.1 Inter Operator Identifier..... | 11 | +| 4.3.1.1 Type of IOI's..... | 11 | +| 4.3.1.2 Format of IOI's..... | 12 | +| 4.3.1.3 Basic IMS roaming scenario without loopback..... | 12 | +| 4.3.1.4 Originating visited network with loopback routing scenario..... | 13 | +| 4.3.1.5 Rules for transit-ioi ..... | 14 | +| 4.3.2 Naming of URIs ..... | 16 | +| 4.3.2.1 General..... | 16 | +| 4.3.2.2 Home Network Domain..... | 16 | +| 4.3.2.3 Private user identity ..... | 16 | +| 4.3.2.4 Public user identity ..... | 16 | +| 4.3.2.5 Instance-ID..... | 17 | +| 4.4 Identifying the II-NNI traversal scenario ..... | 17 | +| 4.5 Use of preconditions in IMS networks..... | 17 | +| 4.6 Loopback-indication header field parameter..... | 17 | +| 5 Description of Scenarios ..... | 18 | +| 5.1 General ..... | 18 | +| 5.1.1 Methodology..... | 18 | +| 5.1.1.1 Key required to interpret signalling flow in message coding examples ..... | 18 | +| 5.1.1.2 Functional entities covered in example flows..... | 19 | +| 5.1.1.3 Notation conventions ..... | 19 | +| 5.1.1.3.1 Introduction ..... | 19 | +| 5.1.1.3.2 Public user Identities, public service identities and IP addresses ..... | 20 | +| 5.1.1.3.3 Network Entities..... | 20 | +| 5.1.1.3.3.1 Served user UE-A's associated entities..... | 20 | +| 5.1.1.3.3.2 Remote user's associated entities..... | 21 | +| 5.1.1.3.3.3 Interconnection networks associated entities ..... | 21 | +| 5.1.1.4 IOI values..... | 21 | +| 5.2 Registration when roaming ..... | 21 | +| 5.2.1 General ..... | 21 | +| 5.2.2 Registration via IC SIP proxies ..... | 22 | +| 5.2.3 Subscription to the registration-state event package ..... | 29 | +| 5.2.3.1 General..... | 29 | +| 5.2.3.2 The UE subscribes to the registration-state event package..... | 29 | +| 5.2.3.3 The P-CSCF subscribes to the registration-state event package..... | 37 | +| 5.3 Originating roaming without loopback ..... | 44 | +| 5.3.1 General ..... | 44 | +| 5.3.2 Call flow ..... | 44 | +| 5.4 Originating roaming with loopback ..... | 53 | +| 5.4.1 General ..... | 53 | +| 5.4.2 Call flow ..... | 53 | +| 5.5 Routing when the originating and terminating user reside in the same home network ..... | 72 | +| 5.6 Routing from originating home to terminating home network ..... | 72 | +| 5.7 Routing from originating visited network to terminating home network..... | 73 | +| 5.8 Routing in terminating home network when user resides in this network ..... | 73 | + +- 5.9 Routeing from terminating home network to the terminating visited network.....73 +- 5.10 Insertion of service related media in the originating home network.....81 + - 5.10.1 General .....81 + - 5.10.2 Insertion of service related media in the originating home network with loopback .....82 + - 5.10.3 Insertion of service related media in the originating home network without loopback .....85 +- 5.11 PS to CS SRVCC access transfer scenarios.....87 + - 5.11.1 General .....87 + - 5.11.2 PS to CS SRVCC information transfer during registration.....87 + - 5.11.3 PS to CS SRVCC access transfer for a call in the active phase without loopback .....95 + - 5.11.4 PS to CS SRVCC access transfer for a call in the active phase with loopback .....103 +- 5.12 Invocation and configuration of services during roaming in a visited network.....105 + +Annex A: Change history.....106 + +# --- Foreword + +This Technical Report has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 1 Scope + +The present document describes end-to-end use cases and signalling flows based on the roaming architecture for voice over IMS with local breakout. It summarizes the contents of existing 3GPP technical specifications which are needed for roaming use cases. The scenarios used cover the following use cases: + +- registration when roaming; +- routeing from originating visited network to originating home network; +- loopback routeing from originating home network to originating visited network; +- routeing when the originating and terminating user reside in the same home network; +- routeing from the originating home network to the terminating home network; +- routeing from the originating visited network to the terminating home network; +- routeing in terminating home network when user resides in this network; +- routeing from terminating home network to the terminating visited network; +- insertion of service related media in the originating home network; +- routeing through transit networks; and +- access transfer scenarios (SRVCC). + +Editor's note: It is ffs if the call forwarding service invocation in a Call Deflection case will be considered. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.002: "Network architecture". +- [3] 3GPP TS 23.228: "IP multimedia subsystem; Stage 2". +- [4] 3GPP TS 24.229: "IP multimedia call control protocol based on Session Initiation Protocol (SIP) and Session Description Protocol (SDP); Stage 3". +- [5] 3GPP TS 29.079: "Optimal Media Routeing within the IP Multimedia Subsystem; Stage 3". +- [6] 3GPP TS 29.165: "Inter-IMS Network to Network Interface (NNI)". +- [7] 3GPP TR 23.850: "Study on roaming architecture for voice over IP Multimedia Subsystem (IMS) with local breakout" (Release 11). +- [8] GSMA IR.92: "IMS Profile for Voice and SMS". +- [9] IETF RFC 3261: "SIP: Session Initiation Protocol". + +- [10] IETF RFC 1594: "FYI on Questions and Answers to Commonly asked "New Internet User" Questions". +- [11] Void. +- [12] 3GPP TS 23.218: "IP Multimedia (IM) Session Handling; IM call model". +- [13] IETF RFC 3263: "Session Initiation Protocol (SIP): Locating SIP Servers". +- [14] 3GPP TS 29.228: "IP Multimedia (IM) Subsystem Cx and Dx Interfaces; Signalling flows and message contents". +- [15] GSMA IR.88: "LTE Roaming Guidelines". +- [16] 3GPP TS 23.003: "Numbering, addressing and identification". +- [17] IETF RFC 4282: "The Network Access Identifier". +- [18] IETF RFC 3966: "The tel URI for Telephone Numbers". +- [19] IETF RFC 4122: "A Universally Unique Identifier (UUID) URN Namespace". +- [20] 3GPP TS 24.237: "IP Multimedia Subsystem (IMS) Service Continuity; Stage 3". +- [21] IETF RFC 6809: "Mechanism to Indicate Support of Features and Capabilities in the Session Initiation Protocol (SIP)". +- [22] 3GPP TS 24.628: "Common Basic Communication procedures using IP Multimedia (IM)". +- [23] IETF RFC 3455: "Private Header (P-Header) Extensions to the Session Initiation Protocol (SIP) for the 3rd-Generation Partnership Project (3GPP)". +- [24] IETF RFC 2782: "A DNS RR for specifying the location of services (DNS SRV)". +- [25] 3GPP TS 32.260: "Telecommunication management; Charging management; IP Multimedia Subsystem (IMS) charging". +- [26] IETF RFC 7549: "3GPP SIP URI Inter Operator Traffic Leg parameter". +- [27] IETF RFC 3323: "A Privacy Mechanism for the Session Initiation Protocol (SIP)". +- [28] IETF RFC 3325: "Private Extensions to the Session Initiation Protocol (SIP) for Asserted Identity within Trusted Networks". +- [30] 3GPP TS 29.212: "Policy and Charging Control (PCC); Reference Points". +- [31] 3GPP TS 29.214: "Policy and charging control over Rx reference Point". +- [32] IETF RFC 3262 (June 2002): "Reliability of provisional responses in Session Initiation Protocol (SIP)". +- [33] IETF RFC 3312 (October 2002): "Integration of resource management and Session Initiation Protocol (SIP)". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 24.229 [4] apply: + +**Entry point:** In the case that "border control concepts", as specified in 3GPP TS 23.228 [3], are to be applied in an IM CN subsystem, then these are to be provided by capabilities within the IBCF, and the IBCF acts as an entry point for this network (instead of the I-CSCF). In this case the IBCF and the I-CSCF can be co-located as a single physical node. If "border control concepts" are not applied, then the I-CSCF is considered as an entry point of a network. If the P-CSCF is in the home network, then the I-CSCF is considered as an entry point for this document. + +**Exit point:** If operator preference requires the application of "border control concepts" as specified in 3GPP TS 23.228 [3], then these are to be provided by capabilities within the IBCF, and requests sent towards another network are routed via a local network exit point (IBCF), which will then forward the request to the other network (discovering the entry point if necessary). + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 23.228 [3] subclauses 3.1, 4.3.3.1, 4.3.6, 4.6, 4.13, 5.2, 5.4.12.1 and 5.10 apply: + +**Border control concepts** +**Geo-local service number** +**Home local service number** +**Implicit registration set** +**Interconnection Border Control Function (IBCF)** +**Interrogating-CSCF (I-CSCF)** +**IMS Application Level Gateway (IMS-ALG)** +**IMS application reference** +**IMS Application Reference Identifier (IARI)** +**IMS communication service** +**IMS Communication Service Identifier (ICSI)** +**Local service number** +**IP-Connectivity Access Network (IP-CAN)** +**Policy and Charging Rule Function (PCRF)** +**Private user identity** +**Proxy-CSCF (P-CSCF)** +**Public Service Identity (PSI)** +**Public user identity** +**Serving-CSCF (S-CSCF)** +**Statically pre-configured PSI** + +For the purposes of the present document, the following terms and definitions given in IETF RFC 1594 [10] apply: + +**Fully-Qualified Domain Name (FQDN)** + +For the purposes of the present document, the following terms and definitions given in IETF RFC 3261 [9] apply: + +**Client** +**Dialog** +**Final response** +**Header** +**Header field** +**Loose routing** +**Method** +**Option-tag** +**Provisional response** +**Proxy, proxy server** +**Recursion** +**Redirect server** +**Registrar** +**Request** +**Response** +**Server** +**Session** +**(SIP) transaction** +**Stateful proxy** +**Stateless proxy** +**Status-code** +**Tag** + +### **Target Refresh Request** + +**User agent client (UAC)****User agent server (UAS)****User agent (UA)** + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 23.002 [2] clause 4.1.1.1 and clause 4a.7 apply: + +**Breakout Gateway Control Function (BGCF)****Call Session Control Function (CSCF)****Home Subscriber Server (HSS)****Location Retrieval Function (LRF)****Media Gateway Control Function (MGCF)****MSC Server enhanced for IMS centralized services****Multimedia Resource Function Controller (MRFC)****Multimedia Resource Function Processor (MRFP)****Subscription Locator Function (SLF)** + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 23.218 [12] clause 3.1 apply: + +**Filter criteria****Initial filter criteria****Initial request****Standalone transaction****Subsequent request** + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|----------|------------------------------------------------------| +| AS | Application Server | +| ATCF | Access Transfer Control Function | +| ATGW | Access Transfer Gateway | +| ATU-STI | Access Transfer Update – Session Transfer Identifier | +| B2BUA | Back-to-Back User Agent | +| BGCF | Breakout Gateway Control Function | +| CdPty | Called Party | +| C-MSISDN | Correlation MSISDN | +| EATF | Emergency Access Transfer Function | +| E-CSCF | Emergency CSCF | +| ENUM | E.164 telephone NUmber Mapping | +| FQDN | Fully Qualified Domain Name | +| IARI | IMS Application Reference Identifier | +| IBCF | Interconnection Border Control Function | +| IC | Interconnection | +| ICID | IM CN subsystem Charging Identifier | +| I-CSCF | Interrogating CSCF | +| ICSI | IMS Communication Service Identifier | +| IMS | IP Multimedia core network Subsystem | +| IMSI | International Mobile Subscriber Identity | +| IOI | Inter Operator Identifier | +| LIA | Location Information Answer | +| LIR | Location Information Request | +| LRF | Location Retrieval Function | +| MCC | Mobile Country Code | +| MGCF | Media Gateway Control Function | +| MMTEL | Multimedia Telephony | +| MNC | Mobile Network Code | + +| | | +|--------|------------------------------------------| +| MOC | Mobile Originating Call | +| MPS | Multimedia Priority Service | +| MRFC | Multimedia Resource Function Controller | +| MRFP | Multimedia Resource Function Processor | +| OMR | Optimal Media Routeing | +| PCRF | Policy and Charging Rules Function | +| P-CSCF | Proxy CSCF | +| PS | Packed Switched | +| PSAP | Public Safety Answering Point | +| PSI | Public Service Identity | +| SLA | Service Level Agreement | +| SLF | Subscription Locator Function | +| SCC AS | Service Centralization and Continuity AS | +| S-CSCF | Serving CSCF | +| SRVCC | Single Radio Voice Call Continuity | +| STN-SR | Session Transfer Number – Single Radio | +| TDM | Time Division Multiplex | +| TRF | Transit and Roaming Function | +| UA | User Agent | +| UAC | User Agent Client | +| UAS | User Agent Server | +| URN | Uniform Resource Name | +| VoLTE | Voice over LTE | + +# --- 4 Overview + +## 4.1 General + +This clause summarizes the contents of existing 3GPP technical specifications relevant for roaming architecture and procedures, describes how to format the Inter Operator Identifiers in the P-Charging-Vector header field, gives examples of used identities within the roaming use case and describes how to determine the II-NNI traversal scenario type. + +## 4.2 3GPP specifications relevant for roaming architecture and procedures + +This clause describes 3GPP specifications which are relevant for the implementation of VoLTE IMS roaming. + +1. 3GPP TR 23.850 [7] investigated solutions for the provision of voice over IMS in roaming scenarios that facilitate the realization of a charging model that replicates the principles of CS model. The conclusions of this study were baseline for the roaming implementation in the 3GPP specifications. This document has now informational character. +2. 3GPP TS 23.002 [2] describes the common architecture and the related interfaces. +3. 3GPP TS 23.228 [3] describes the IP multimedia subsystem. The relevant sections which describes the roaming relevant stage 2 requirements are clause 4.2.3 (support of roaming users), clause 4.15a (roaming architecture for voice over IMS with local breakout), clause 5.6.1 ((MO#1) mobile origination, roaming), clause 5.7.1 ((MT#1) mobile termination, roaming) and clause 5.7.2a ((MT#3) mobile termination, CS domain roaming). +4. 3GPP TS 24.229 [4] especially describes the SIP and SDP signalling procedures for the IMS. The whole document distinguishes within the text if the procedures are relevant for roaming or non roaming cases or generally valid. Main sections which are mentioned to be specific to roaming additions are clause 5.7.1.16 (support of roaming architecture for voice over IMS with local breakout) and annex I (additional routeing capabilities in support of transit, roaming and interconnection traffics in IM CN subsystem). +5. 3GPP TS 29.079 [5] describes the optimised media routing. Some roaming scenarios are described in clause 5.7 (roaming architecture for voice over IMS with local breakout) and in annex A different roaming scenarios with OMR are shown. Especially clause A.6 shows roaming case with loopback. + +6. 3GPP TS 29.165 [6] describes the behaviour at the Inter-IMS Network to Network Interface (II-NNI) consisting of Ici and Izi reference points between IMS networks in order to support end-to-end service interoperability. This interface is essential for roaming. +7. GSMA IR.92 [8] describes the GSMA profile between UE and network based on 3GPP specifications. +8. 3GPP TS 22.153 [29] describes the service requirements for Multimedia Priority Service (MPS). MPS allows the ability to deliver calls or complete sessions of a high priority nature from mobile to mobile networks, mobile to fixed networks, and fixed to mobile networks. For roaming, appropriate priority information (e.g., marking with the Resource-Priority header field) across various interfaces is required in IMS CN and between IMS networks in order to support end-to-end MPS calls. The stage 3 in support of MPS is specified in (but not limited to): 3GPP TS 24.229 [4], 3GPP TS 29.165 [6], 3GPP TS 29.212 [30] and 3GPP TS 29.214 [31]. In particular, 3GPP TS 24.229 [4] describes the priority mechanisms and required priority information in SIP for MPS. + +## 4.3 Consideration of SIP header fields and elements + +### 4.3.1 Inter Operator Identifier + +#### 4.3.1.1 Type of IOI's + +There are three types of IOI: + +1. type 1 IOI, between the visited network and the home network: + - between the P-CSCF and the S-CSCF; + - between the S-CSCF and the TRF; + - between the BGCF and the TRF; + - between the MSC server and the I-CSCF; and + - between the SCC AS and the ATCF; +2. type 2 IOI, between the originating network and the terminating network: + - between the S-CSCF and the S-CSCF; + - between the S-CSCF and the MGCF when a call/session is terminated at the PSTN/PLMN; + - between the MGCF and the S-CSCF of the home terminating network when a call/session is originated from the PSTN/PLMN; + +NOTE: This includes all scenarios with a PSI AS when accessed across I-CSCF. + +- between the TRF and the S-CSCF; + - between the E-CSCF and the MGCF or the IBCF where the request is routed to a PSAP; and + - between the E-CSCF and the S-CSCF or the IBCF when receiving an emergency request; and +3. type 3 IOI: + - between the S-CSCF or the I-CSCF of the home operator network and any AS; + - between the E-CSCF and the LRF; + - between the E-CSCF and the EATF; and + - between the transit function and the AS. + +#### 4.3.1.2 Format of IOI's + +According to 3GPP TS 24.229 [4] clause 7.2A.5.2.1 the SIP entity generating type 1 and type 3 IOI values express the "orig-ioi" and "term-ioi" header field parameters in the format of a quoted string as specified in IETF RFC 3455 [23] with a specific string prefix being "Type 1" and "Type 3" respectively to indicate the type of IOI. For the type 2 IOI, no + +string prefix is used. The receiving SIP entity does not perform syntactic checking of the contents of the IOI values (the IOI value is passed unmodified to the charging entities). + +The following table shows some examples how to format IOI's. + +**Table 4.3.1.2-1: Examples for the format of IOI's** + +| Example | Type of IOI | Prefix of IOI value | Example | +|------------------------------------------------------|-------------|---------------------|-----------------------| +| P-CSCF – IBCF | Type 1 | "Type 1" | "Type 1visited-A.net" | +| S-CSCF – IBCF (terminating path) | Type 2 | none | "home-A.net" | +| S-CSCF - AS | Type 3 | "Type 3" | "Type 3home-A.net" | +| originating home network to terminating home network | Type 2 | none | "home-A.net" | + +#### 4.3.1.3 Basic IMS roaming scenario without loopback + +Within this basic approach 3 traversal scenarios exist which are shown in table 4.3.1.3-1. + +**Table 4.3.1.3-1: Traversal scenarios for basic IMS roaming scenario without loopback** + +| Traversal scenario | Type of IOI | +|--------------------------------------------------------|-------------| +| Originating visited network – originating home network | Type 1 | +| Originating home network – terminating home network | Type 2 | +| Terminating home network – terminating visited network | Type 1 | + +![Diagram illustrating the IOI information exchange for the 'Basic IMS' roaming case with home routing of media. The diagram shows three network layers: Originating home network (top), Terminating home network (top), and Visited networks (middle and bottom). The flow starts from a Calling user in the Originating visited network, passing through a P-CSCF (Type 1 Orig-IOI), then an IPX proxy (Transit-IOI), then an S-CSCF in the Originating home network (Type 2 Orig-IOI). The signal then passes through another IPX proxy (Transit-IOI) to an S-CSCF in the Terminating home network (Type 2 Term-IOI). From there, it passes through another IPX proxy (Transit-IOI) to a P-CSCF in the Terminating visited network (Type 1 Term-IOI), which then reaches the Called user. The diagram uses dashed red lines for signaling paths and solid green lines for media paths.](63e0c22852c26699d0bd095a2d796bab_img.jpg) + +Diagram illustrating the IOI information exchange for the 'Basic IMS' roaming case with home routing of media. The diagram shows three network layers: Originating home network (top), Terminating home network (top), and Visited networks (middle and bottom). The flow starts from a Calling user in the Originating visited network, passing through a P-CSCF (Type 1 Orig-IOI), then an IPX proxy (Transit-IOI), then an S-CSCF in the Originating home network (Type 2 Orig-IOI). The signal then passes through another IPX proxy (Transit-IOI) to an S-CSCF in the Terminating home network (Type 2 Term-IOI). From there, it passes through another IPX proxy (Transit-IOI) to a P-CSCF in the Terminating visited network (Type 1 Term-IOI), which then reaches the Called user. The diagram uses dashed red lines for signaling paths and solid green lines for media paths. + +**Figure 4.3.1.3-1: IOI information exchange for the "Basic IMS" roaming case with home routing of media** + +In order to meet the requirements of 3GPP TS 24.229 [4] there needs to be an IOI exchange including originating IOI, transit IOIs, and terminating IOI for each of the three signalling paths crossing network boundaries. + +#### 4.3.1.4 Originating visited network with loopback routing scenario + +Within the loopback approach 4 traversal scenarios exist which are shown in table 4.3.1.4-1. + +**Table 4.3.1.4-1: Traversal scenarios for "Originating visited network with loopback routing scenario"** + +| traversal scenario | Type of IOI | +|--------------------------------------------------------|-------------| +| Originating visited network – originating home network | Type 1 | +| Originating home network – originating visited network | Type 1 | +| Originating visited network – terminating home network | Type 2 | +| Terminating home network – terminating visited network | Type 1 | + +For roaming with loopback the "Originating visited network with loopback routing scenario" introduces the case where the SIP signalling and the media are routed from the originating visited network to the destination and where the SIP signalling is first routed to the originating home network for a service execution and then back to the originating visited network to allow the originating visited network to route both SIP signalling and media to the destination. + +The complete sequence of IOI exchanges for the IMS roaming scenario with originating visited network routing option is depicted in figure 4.3.1.4-1. + +![Diagram illustrating the IOI exchange for IMS roaming with originating visited network with loopback routing. It shows the flow of SIP messages between a Calling user, Originating visited network (P-CSCF, TRF), Originating home network (S-CSCF), IPX proxies, and Terminating home network (S-CSCF) leading to a Called user. The diagram uses red dashed lines for SIP signaling and green solid lines for media. IOI types are labeled: Type 1 Orig-IOI, Type 1 Term-IOI, Type 2 Orig-IOI, Type 2 Term-IOI, and Transit-IOI.](e9d825d87c5f85c8dba0664eace96ef4_img.jpg) + +Diagram illustrating the IOI exchange for IMS roaming with originating visited network with loopback routing. It shows the flow of SIP messages between a Calling user, Originating visited network (P-CSCF, TRF), Originating home network (S-CSCF), IPX proxies, and Terminating home network (S-CSCF) leading to a Called user. The diagram uses red dashed lines for SIP signaling and green solid lines for media. IOI types are labeled: Type 1 Orig-IOI, Type 1 Term-IOI, Type 2 Orig-IOI, Type 2 Term-IOI, and Transit-IOI. + +**Figure 4.3.1.4-1: IOI exchange for IMS roaming with originating visited network with loopback routing** + +In order to meet the requirements of 3GPP TS 24.229 [4] there needs to be an IOI exchange including originating IOI, transit IOIs, and terminating IOI for each of four signalling paths crossing network boundaries. + +#### 4.3.1.5 Rules for transit-ioi + +3GPP TS 24.229 [4] describes that for transit networks based on local policy the additional routing function in the transit network adds in requests and in responses the P-Charging-Vector header field a "transit-ioi" header field parameter with an entry which identifies the operator network which the request or response is transiting or with a void entry. + +When the index is calculated then "void" entries are taken into account. + +Based on local policy the additional routing function deletes or void in requests and in responses in the P-Charging-Vector header field any received "transit-ioi" header field parameter value. + +Specific ruling may also apply to IBCF: + +##### 1. IBCF acting as entry point: + +Based on local policy, the IBCF acting as an entry point adds in requests in the P-Charging-Vector header field a "transit-ioi" header field parameter with an entry which identifies the operator network which the request is transiting or with a void entry. + +Based on local policy the IBCF deletes or void in requests in the P-Charging-Vector header field any received "transit-ioi" header field parameter value. + +Only one "transit-ioi" header field parameter entry is added per transit network. + +##### 2. IBCF acting as exit point: + +Based on local policy, the IBCF acting as an exit point adds in responses in the P-Charging-Vector header field a "transit-ioi" header field parameter with an entry which identifies the operator network which the response is transiting or with a void entry. + +Based on local policy the IBCF deletes or void in responses in the P-Charging-Vector header field any received "transit-ioi" header field parameter value. + +Considering figure 4.3.1.5-1 either the IBCF-entryA1 in combination with the IBCF-exitA1 or the transit function can do the setting of the transit-ioi. But also due to 3GPP TS 24.229 [4], subsection 4.5.4A, the transit function can control if a transit-ioi will be deleted or voided. + +![Sequence diagram titled 'IC network A' showing the IOI exchange for IMS roaming transit. The diagram features four lifelines: IBCF-entryA1, Transit function, AS, and IBCF-exitA1. The sequence of messages is: 1. INVITE from IBCF-entryA1 to Transit function; 2. INVITE from Transit function to AS; 3. INVITE from AS back to Transit function; 4. INVITE from Transit function to IBCF-exitA1; 5. 183 from IBCF-exitA1 back to Transit function; 6. 183 from Transit function to AS; 7. 183 from AS back to Transit function; 8. 183 from Transit function back to IBCF-entryA1.](e190b6ddb7c2e64b940749a1c5612256_img.jpg) + +Sequence diagram titled 'IC network A' showing the IOI exchange for IMS roaming transit. The diagram features four lifelines: IBCF-entryA1, Transit function, AS, and IBCF-exitA1. The sequence of messages is: 1. INVITE from IBCF-entryA1 to Transit function; 2. INVITE from Transit function to AS; 3. INVITE from AS back to Transit function; 4. INVITE from Transit function to IBCF-exitA1; 5. 183 from IBCF-exitA1 back to Transit function; 6. 183 from Transit function to AS; 7. 183 from AS back to Transit function; 8. 183 from Transit function back to IBCF-entryA1. + +**Figure 4.3.1.5-1: IOI exchange for IMS roaming transit** + +- 1. The IBCF-entryA1 receives an INVITE request containing the "transit-ioi" header field parameter in the P-Charging-Vector header field and sends the INVITE request towards the transit function. + +NOTE 1: If no "transit-ioi" header field parameter is included or if the included "transit-ioi" header field parameter is missing a preceeding interconnection network and the preceding network is an interconnection network, the IBCF-entryA1 can based on local policy, add the transit-ioi" header field parameter with an entry identifying the preceding interconnection network. + +2. The transit function stores and removes the "transit-ioi" header field parameter from the P-Charging-Vector header field, adds the Relayed-Charge header field with the content received in the "transit-ioi" and forwards the INVITE request to the AS. +3. The AS stores the content of the Relayed-Charge header field and sends the INVITE request to the transit function. +4. The transit function removes the Relayed-Charge header field and includes the stored "transit-ioi" header field parameter in the P-Charging-Vector header field. The transit function also appends an entry in the "transit-ioi". Based on local policy, the appended entry can identify the interconnection network or be set to void. The INVITE request is sent to the IBCF-exitA1. + +NOTE 2: Based on local policy, the transit function can also void entries in the received "transit-ioi" header field parameter. + +5. Upon receipt of a provisional response (in this case the 183 (Session Progress) response) containing the P-Charging-Vector header field, the IBCF-exitA1 sends the response to the transit function. + +NOTE 3: If no "transit-ioi" header field parameter is included or if the included "transit-ioi" header field parameter is missing a preceding interconnection network and the preceding network is an interconnection network, the IBCF-exitA1 can based on local policy, add the transit-ioi" header field parameter with an entry identifying the preceding interconnection network. + +6. The transit function stores and removes the "transit-ioi" header field parameter from the P-Charging-Vector header field, adds the Relayed-Charge header field with the content received in the "transit-ioi" and forwards the 183 (Session Progress) response to the AS. +7. The AS stores the content of the Relayed-Charge header field and sends the 183 (Session Progress) response to the transit function. +8. The transit function removes the Relayed-Charge header field and includes the stored "transit-ioi" header field parameter in the P-Charging-Vector header field. The transit function also appends an entry in the "transit-ioi". Based on local policy, the appended entry can identify the interconnection network or be set to void. The 183 (Session Progress) response is sent to the IBCF-entryA1. + +NOTE 4: Based on local policy, the transit function can also void entries in the received "transit-ioi" header field parameter. + +### 4.3.2 Naming of URIs + +#### 4.3.2.1 General + +3GPP TS 23.003 [16] defines the principal purpose and the use of International Mobile station Equipment Identities (IMEI) within the digital cellular telecommunications system and the 3GPP system. + +Within the 3GPP TS 23.003 [16] clause 13 the numbering, addressing and identification within the IP multimedia core network subsystem are described. + +This clause gives examples of used identities within the roaming use case. The normative statements in 3GPP TS 23.003 [16] apply. + +#### 4.3.2.2 Home Network Domain + +The home network domain name is in the form of an internet domain name, e.g. operator.com. + +3GPP TS 23.003 [16] clause 13.2 describes how to build the home network domain, if there is no ISIM application. + +EXAMPLE: A home network domain name is: IMSI in use with 234150999999999 results in home network domain = ims.mnc015.mcc234.3gppnetwork.org. + +#### 4.3.2.3 Private user identity + +3GPP TS 23.003 [16] clause 13.3 describes the principles how to build a private user identity. + +The NAI as specified in IETF RFC 4282 [17] clause 2.1 for 3GPP systems with ISIM application the private user identity is derived from the IMSI. + +EXAMPLE: If the IMSI is 234150999999999 (MCC = 234, MNC = 15), the private user identity then takes the form "234150999999999@ims.mnc015.mcc234.3gppnetwork.org". + +#### 4.3.2.4 Public user identity + +3GPP TS 23.003 [16] clause 13.4 describes the principles how to build a public user identity. + +The public user identity takes the form of either a SIP URI (see IETF RFC 3261 [9]) or a tel URI (see IETF RFC 3966 [18]). + +According to 3GPP TS 29.165 [6] a global number as defined in IETF RFC 3966 [18] is used in a tel URI or in the user portion of a SIP URI with the "user=phone" parameter when conveyed via a non-roaming II-NNI except when agreement exists between the operators to also allow other kinds of numbers. For a roaming II-NNI no conventions are defined currently. + +EXAMPLE 1: SIP URI: sip: +49892233445@operator.com; user=phone + +EXAMPLE 2: SIP URI: sip: +49892233445@ 192.0.2.4; user=phone + +EXAMPLE 3: SIP URI: sip: bob@operator.com + +EXAMPLE 4: SIP: tel:+4687197378 + +#### 4.3.2.5 Instance-ID + +3GPP TS 23.003 [16] clause 13.8 describes the principles how to build an instance-id. + +When an IMEI is available, the instance-id takes the form of an IMEI URN. An example of such an instance-id is as follows: + +EXAMPLE 1: urn:gsma:imei:90420156-025763-0 + +If no IMEI is available, the instance-id takes the form of a string representation of a UUID as a URN as defined in IETF RFC 4122 [19]. An example of such an instance-id is as follows: + +EXAMPLE 2: urn:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6 + +For more information on the instance-id and when it is used, see 3GPP TS 24.229 [4]. + +## 4.4 Identifying the II-NNI traversal scenario + +Dialog creating SIP request and standalone request can optionally contain an "iotl" SIP URI parameter as specified in IETF RFC 7549 [26] and 3GPP TS 24.229 [4] in a Request-URI or in a Route header field. The "iotl" SIP URI parameter can be used to identify the II-NNI traversal scenario. The "iotl" SIP URI parameter is appended to the URI that represents the destination in CDRs. + +One example on how the "iotl" SIP URI parameter is included in the Route header field by the P-CSCF in an originating visited network when sending a request towards the originating home network is shown below. + +EXAMPLE: Route: , + +If neither the Request-URI nor any of the Route header fields included in the SIP request contains the "iotl" SIP URI parameter, the II-NNI traversal scenario type can be determined by analysing the content of the SIP request or using a default II-NNI traversal scenario type. The recommended II-NNI traversal scenario type default value is "homeA-homeB". + +NOTE: How the content of the SIP request can be used to determine the II-NNI traversal scenario is implementation dependent and outside the scope of this document. + +The example use cases in this document assumes that the visited and home network supports the use of the "iotl" SIP URI parameter and the "iotl" SIP URI parameter are included in all coding examples. + +## 4.5 Use of preconditions in IMS networks + +An IMS UE can use preconditions based on local policy. The preconditions are defined within IETF RFC 3312 [33]. To process the preconditions IETF RFC 3262 [32] is needed. This IETF RFC 3262 [32] is describing the reliability of provisional responses which is needed to allow the reliable exchange of an SDP offer and SDP answer. + +All use cases in this document are assuming preconditions. The similar call flows can appear without the preconditions mechanism. + +Since 3GPP TS 24.229 [4] is stating that "100rel" option tag are used in circumstances of the use of preconditions the PRACK/200 OK is not sent in non precondition cases. Also the UPDATE/200 OK (UPDATE) is not sent since these messages are used to inform each other about the met resource reservation. + +## 4.6 Loopback-indication header field parameter + +When there is a desire to send the information that loopback has been applied to an entity, then the loopback-indication parameter in the P-Charging-Vector header field is used. This header field parameter can e.g. be evaluated when processing the P-CSCF CDR and possibly the ATCF CDR to know whether or not to attempt to locate a correlated TRF CDR even for the non-loopback scenario when no such CDR exists. + +# --- 5 Description of Scenarios + +## 5.1 General + +### 5.1.1 Methodology + +#### 5.1.1.1 Key required to interpret signalling flow in message coding examples + +Message coding examples are used to describe the contents of SIP messages. + +The message coding examples include protocol elements that are of some interest for the interconnection use cases such as: + +- a) protocol elements that contain address information (e.g. the Contact header field); +- b) protocol elements that contain routing information (e.g. the Route, Record-Route and Via header fields); +- c) protocol elements that can be used to identify the use case; and +- d) protocol elements that contain particular information of the use case. + +Protocol elements that do not fulfil the above criteria are not included in the message coding examples, even if the protocol element is mandatory to be included in the SIP message. However, for completeness one or more references to 3GPP technical specifications are included at the end of the message coding examples. + +The following key (rules) has been applied to each message coding examples to improve readability, reduce errors and increase maintainability: + +- a) where a header field in the SIP message coding examples show only the header name including colon, the contents are identical to the received request/response. The received request/response is identified as follows: + - where a request is generated as a result of a received request (as at a proxy), then the received request is that with the same method name and CSeq header; + - where a response is generated as a result of a received response (as at a proxy), then the received response is that with the same method name and CSeq header; + - where the response is generated as a result of a received request or response (as at an UA), then the received request is that with the same method name and CSeq header; and + - where the request is generated as a result of a received response (as at an UA) then the received response is that immediately previously received; + +To enhance readability an indication of the received request/response is included in the method title, should the received request/response not be the immediate preceding request/response. + +- b) the (...) sequence of characters is used to indicate that the Content-Length field needs to be filled in, with the appropriate value i.e. the number of bytes in the payload; +- c) repeated headers within a message are listed on a single line, with a comma used as delimiter. This convention is not mandatory but used in this specification for improved readability; +- d) Header fields are listed within a table in the following order: + - 1) end to end address information header fields (e.g. To and From); + - 2) header fields that do not include end to end address information (e.g. the Route, Record-Route and P-Charging-Vector header fields); and + - 3) Via header fields. + +This convention is not mandatory but used in this specification for improved readability. + +- e) UDP is always described in the Via header fields as a transport protocol even if the SIP message is actually longer than 1300 bytes. This convention is for improving readability and maintainability. + +NOTE: According to 3GPP TS 24.229 [4] clause 4.2A, if the SIP message is longer than 1300 bytes, the IM CN subsystem entities transport the SIP message using a congestion controlled transport protocol, such as TCP. + +#### 5.1.1.2 Functional entities covered in example flows + +The flows show the signalling exchanges between the following functional entities: + +- User Equipment (UE); +- Proxy-CSCF (P-CSCF); +- Interrogating-CSCF (I-CSCF); +- Serving-CSCF (S-CSCF); +- Interconnection Border Control Function (IBCF); +- Application Server (AS); +- Service Centralization and Continuity Application Server (SCC AS); +- Mobile Switching Centre (MSC); +- Access Transfer Control Function (ATCF); +- Transit and Roaming Function (TRF); +- Media Gateway Control Function (MGCF); +- Breakout Gateway Control Function (BGCF); +- Home Subscriber Server (HSS); and +- SIP proxy or SIP application level gateway (ALG) in interconnection networks. + +NOTE: The SIP proxy is assumed to have an additional routing functionality described in 3GPP TS 24.229 [4]. + +A number of the flows show a check against the filter criteria in the S-CSCF. A successful check against the filter criteria will involve the introduction of an application server into the path, operating in a number of different modes depending on the service provided. This could affect the example flows as follows: + +- by the addition of extra URLs to a number of header fields, e.g. Via, Record-Route, within the flow in which the evaluation of filter criteria occurs; + +- by the addition of extra URLs to a number of header fields, e.g. Via, Route in subsequent flows for the same dialog; and +- by the inclusion of functionality provided by the application server in this and subsequent flows. + +#### 5.1.1.3 Notation conventions + +##### 5.1.1.3.1 Introduction + +This clause details the notation conventions used in the present document. + +##### 5.1.1.3.2 Public user Identities, public service identities and IP addresses + +**Table 5.1.1.3.2-1: The public user identities, public service identities and IP addresses used in message coding examples** + +| | IP address | Public user identity / public service identities | +|-----------------------------------------------------------------------------------|-------------------------|--------------------------------------------------------------| +| UE-A | [5555::aaa:bbb:ccc:ddd] | sip:userA_public1@home-A.net
tel:+1-237-555-1111 (NOTE 1) | +| Remote UE | [5555::bbb:ccc:ddd:aaa] | tel:+4687197378 | +| P-CSCF-vA1 | [5555::ddd:aaa:ccc:bbb] | sip:p-cscf@visited-A.net | +| S-CSCF-hA1 | [5555::aaa:ccc:eee:aaa] | N/A | +| SCC AS | N/A | sip:ps2cs@sccas1.home-A.net (NOTE 2) | +| ATCF | N/A | tel:+12375553333 (NOTE 3) | +| IBCF-vA1 | [5555::aaa:bbb:ccc:dd1] | N/A | +| IC-A1 | [5555::aaa:bbb:ccc:dd2] | N/A | +| IBCF-hA1 | [5555::aaa:bbb:ccc:dd3] | N/A | +| IC-T1 | [5555::aaa:bbb:ccc:dd4] | N/A | +| NOTE 1: The tel URI is also used as the C-MSISDN. | | | +| NOTE 2: The SIP URI is used as the ATU-STI during PS to CS SRVCC access transfer. | | | +| NOTE 3: The tel URI is used as the STN-SR during PS to CS SRVCC access transfer. | | | + +##### 5.1.1.3.3 Network Entities + +###### 5.1.1.3.3.1 Served user UE-A's associated entities + +**Table 5.1.1.3.3.1-1: Domain name and FQDN used in message coding examples** + +| Network | Domain name | Entity in the network | FQDN | +|------------------------|---------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| UE-A's home network | home-A.net | S-CSCF serving UE-A | sclf-hA1.home-A.net | +| | | I-CSCF(between proxy and S-CSCF) | icscf-hA1.home-A.net | +| | | IBCF acting as an entry and exit point between the UE-A's visited network and the UE-A's home network | ibcf-hA1.home-A.net | +| | | IBCF acting as an exit point between the UE-A's home network and the remote UE's home network | ibcf-hA2.home-A.net | +| | | AS providing supplementary services | as-hA1.home-A.net | +| | | AS providing the access transfer service | sccas-hA1.home-A.net | +| UE-A's visited network | visited-A.net | P-CSCF serving UE-A | pcscf-vA1.visited-A.net | +| | | IBCF acting as an entry and exit point between the UE-A's visited network and the UE-A's home network and IBCF acting as an exit point between the UE-A's visited network and the remote UE's home network. | ibcf-vA1.visited-A.net | +| | | ATCF | atcf-vA1.visited-A.net | +| | | MSC server | msc-vA1.visited-A.net | +| | | TRF | trf-vA1.visited-A.net | + +###### 5.1.1.3.3.2 Remote user's associated entities + +**Table 5.1.1.3.3.2-1: Domain name and FQDN used in message coding examples** + +| Network | Domain name | Entity in the network | FQDN | +|--------------------------|-------------|-----------------------|------| +| Remote UE's home network | home-R.net | | | + +###### 5.1.1.3.3.3 Interconnection networks associated entities + +**Table 5.1.1.3.3.3-1: Domain name and FQDN used in message coding examples** + +| Network | Domain name | Entity in the network | FQDN | +|-----------------------------------------------------------------------------------------------------------------------------------------------|-----------------------|-----------------------|-----------------------------| +| Interconnection network between the visited network A and the home network A | interconnection-A.net | SIP proxy | ic-A1.interconnection-A.net | +| Interconnection network between the visited network A and the remote home network or between the home network A and the remote home network R | interconnection-T.net | SIP proxy | ic-T1.interconnection-T.net | + +NOTE: Interconnection networks can also be SIP-unaware networks providing only IP routing. For the transit through such networks, no SIP proxies or SIP ALGs in interconnection networks are used. SIP entities in interconnection networks are shown with dotted lines in the flows to denote that they are optional. + +#### 5.1.1.4 IOI values + +The IOI names used in the message coding examples are shown in table 5.1.1.4-1. + +**Table 5.1.1.4-1: The IOI values used in message coding examples** + +| Network | IOI name (NOTE 1, NOTE 2, NOTE 3, NOTE 4) | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------| +| Originating visited network | visited-a | +| Originating home network | home-a | +| Terminating visited network | visited-a | +| Terminating home network | home-a | +| Remote UE's home network | home-r | +| IC network A | ICa | +| IC network T | ICt | +| NOTE 1: The values for "orig-ioi" and "term-ioi" header field parameters are encoded in the format of a quoted string.
NOTE 2: The value for an entry in "transit-ioi" header field parameter contains an indexed value.
NOTE 3: The type 1 and type 3 IOIs are prefixed with specific strings (i.e. "Type1" and "Type3").
NOTE 4: Since the same UE is used as the UE in originating and terminating coding examples the IOI name between the home and visited network will have the same value. | | + +## 5.2 Registration when roaming + +### 5.2.1 General + +This clause describes the registration process of a roaming user including the traversal of transit network between the visited and the originating home network. + +### 5.2.2 Registration via IC SIP proxies + +The registration procedure between the visited network and the home network uses an IC network which provides SIP proxy nodes to relay SIP traffic between these networks. + +For the registration the UE addresses an FQDN in the home network domain which reflects the registrar (i.e. the S-CSCF of the home network). With this FQDN the IBCF acting as an exit point in the visited network chooses an IC provider and routes to a SIP proxy of the selected IC provider. + +The SIP layer signalling is served by the IC provider's SIP proxy. The SIP proxy decides on the next SIP proxy towards the home network and routes to the next SIP proxy or to the IBCF acting as an entry point in the home network, if no further SIP proxy is required. + +NOTE 1: The call flows just show scenarios with a single IC network and a single SIP proxy. + +The user A at UE-A is roaming into a visited network vA. The user A is a subscriber of operator hA. + +![Sequence diagram showing the message flow for Registration via IC SIP proxy. The diagram is divided into three network domains: Visited network vA, IC network A, and Home network hA. The entities involved are UE-A, P-CSCF-vA1, IBCF-vA1, IC-A1, IBCF-hA1, I-CSCF-hA1, and S-CSCF-hA1. The sequence of messages is as follows: 1. REGISTER from UE-A to P-CSCF-vA1; 2. REGISTER from P-CSCF-vA1 to IBCF-vA1; 3. REGISTER from IBCF-vA1 to IC-A1; 4. REGISTER from IC-A1 to IBCF-hA1; 5. REGISTER from IBCF-hA1 to I-CSCF-hA1; 6. REGISTER from I-CSCF-hA1 to S-CSCF-hA1; 7. 401 from S-CSCF-hA1 to I-CSCF-hA1; 8. 401 from I-CSCF-hA1 to IBCF-hA1; 9. 401 from IBCF-hA1 to IC-A1; 10. 401 from IC-A1 to IBCF-vA1; 11. 401 from IBCF-vA1 to P-CSCF-vA1; 12. 401 from P-CSCF-vA1 to UE-A; 13. REGISTER from UE-A to P-CSCF-vA1; 14. REGISTER from P-CSCF-vA1 to IBCF-vA1; 15. REGISTER from IBCF-vA1 to IC-A1; 16. REGISTER from IC-A1 to IBCF-hA1; 17. REGISTER from IBCF-hA1 to I-CSCF-hA1; 18. REGISTER from I-CSCF-hA1 to S-CSCF-hA1; 19. 200 from S-CSCF-hA1 to I-CSCF-hA1; 20. 200 from I-CSCF-hA1 to IBCF-hA1; 21. 200 from IBCF-hA1 to IC-A1; 22. 200 from IC-A1 to IBCF-vA1; 23. 200 from IBCF-vA1 to P-CSCF-vA1; 24. 200 from P-CSCF-vA1 to UE-A.](e180f2b5fcbe8001554a7c0677cd3f82_img.jpg) + +Sequence diagram showing the message flow for Registration via IC SIP proxy. The diagram is divided into three network domains: Visited network vA, IC network A, and Home network hA. The entities involved are UE-A, P-CSCF-vA1, IBCF-vA1, IC-A1, IBCF-hA1, I-CSCF-hA1, and S-CSCF-hA1. The sequence of messages is as follows: 1. REGISTER from UE-A to P-CSCF-vA1; 2. REGISTER from P-CSCF-vA1 to IBCF-vA1; 3. REGISTER from IBCF-vA1 to IC-A1; 4. REGISTER from IC-A1 to IBCF-hA1; 5. REGISTER from IBCF-hA1 to I-CSCF-hA1; 6. REGISTER from I-CSCF-hA1 to S-CSCF-hA1; 7. 401 from S-CSCF-hA1 to I-CSCF-hA1; 8. 401 from I-CSCF-hA1 to IBCF-hA1; 9. 401 from IBCF-hA1 to IC-A1; 10. 401 from IC-A1 to IBCF-vA1; 11. 401 from IBCF-vA1 to P-CSCF-vA1; 12. 401 from P-CSCF-vA1 to UE-A; 13. REGISTER from UE-A to P-CSCF-vA1; 14. REGISTER from P-CSCF-vA1 to IBCF-vA1; 15. REGISTER from IBCF-vA1 to IC-A1; 16. REGISTER from IC-A1 to IBCF-hA1; 17. REGISTER from IBCF-hA1 to I-CSCF-hA1; 18. REGISTER from I-CSCF-hA1 to S-CSCF-hA1; 19. 200 from S-CSCF-hA1 to I-CSCF-hA1; 20. 200 from I-CSCF-hA1 to IBCF-hA1; 21. 200 from IBCF-hA1 to IC-A1; 22. 200 from IC-A1 to IBCF-vA1; 23. 200 from IBCF-vA1 to P-CSCF-vA1; 24. 200 from P-CSCF-vA1 to UE-A. + +**Figure 5.2.2-1: Message flow for Registration via IC SIP proxy** + +#### **Call flow details:** + +#### **1. REGISTER request (UE-A to P-CSCF-vA1) - see example in table 5.2.2-1.** + +The user A at UE-A initiates registration. The UE-A sends an initial REGISTER request to the P-CSCF-vA1 according to 3GPP TS 24.229 [4]. + +**Table 5.2.2-1: REGISTER request (UE-A to P-CSCF-vA1)** + +``` +REGISTER sip:home-A.net SIP/2.0 + +P-Access-Network-Info: 3GPP-E-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 +From: ;tag=4fa3 +To: +Contact: ;reg-id=1; +sip.instance="";expires=600000 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd];branch=z9hG4bKnashds7 +CSeq: 1 REGISTER +Supported: path + +Other SIP header fields are set according to 3GPP TS 24.229 [4]. +``` + +**Request-URI:** The Request-URI `sip:home-A.net` (the URI that follows the method name, "REGISTER", in the first line) indicates the destination domain of this REGISTER request which is the home network. + +**From:** Set to the SIP URI that is the default public user identity of the user A i.e. `userA_public1@home-A.net`. + +**To:** Set to the SIP URI that is the default public user identity of the user A i.e. `userA_public1@home-A.net`. + +**Supported:** The UE-A inserts the Supported header field containing the option-tag "path". + +#### **2. REGISTER request (P-CSCF-vA1 to IBCF-vA1) - see example in table 5.2.2-2.** + +When the P-CSCF-vA1 receives the initial REGISTER request the P-CSCF-vA1 adds the P-Visited-Network-ID header field containing the identifier of the P-CSCF network. This may be the visited network domain name or any other identifier that identifies the visited network at the home network. + +The P-CSCF-vA1 needs to be in the path for all terminating requests for this user. To ensure this, the P-CSCF-vA1 adds itself to the Path header field for future requests. + +The P-CSCF-vA1 selects an IBCF (IBCF-vA1) to be the IBCF acting as an exit point towards the home network hA of the user A and sends the REGISTER request according to 3GPP TS 24.229 [4] to IBCF-vA1. + +**Table 5.2.2-2: REGISTER request (P-CSCF-vA1 to IBCF-vA1)** + +``` +REGISTER sip:home-A.net SIP/2.0 + +P-Access-Network-Info: 3GPP-E-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11, 3GPP-E-UTRAN-TDD; utran- +cell-id-3gpp=234151D0FCE11;network-provided;local-time-zone="UTC+01:00";daylight-saving-time="01" +From: +To: +Contact: +CSeq: +Supported: +Require: path +Path: +Route: +P-Visited-Network-ID: "Visited Network Number A" +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024";orig-ioi="Type 1visited-a" + +Via: SIP/2.0/UDP pcscf-vA1.visited-A.net:5060;branch=z9hG4bKnas56565, + SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd];branch=z9hG4bKnashds7 +... + +Other SIP header fields are set according to 3GPP TS 24.229 [4]. +``` + +**Route:** P-CSCF-vA1 includes the selected IBCF-vA1 URI. + +**P-Charging-Vector:** The P-CSCF-vA1 provides an ICID value and adds a type 1 "orig-ioi" header field parameter with the IOI value identifying the visited network (i.e. "visited-a"). + +**Path:** This is the address of the P-CSCF-vA1 and is included to inform the S-CSCF where to route terminating requests. The Path header field includes traffic leg information in the "iot1" SIP URI parameter according to IETF RFC 7549 [26]. + +**Require:** The P-CSCF-vA adds the Require header field containing the option-tag "path" to ensure that the recipient correctly handles the Path header field. If the recipient does not support the Path header field, a SIP response will be received with a status code of 420 and an Unsupported header field indicating the option-tag "path". Such a response indicates a wrong configuration of the routing tables and the request has been routed outside the IM CN subsystem. + +**Via:** The P-CSCF-vA1 adds a Via header field with the address to receive the response to the REGISTER request. + +**P-Access-Network-Info:** The P-CSCF-vA1 adds a network provided location, time-zone and daylight saving time. If it doesn't indicate that it is a network provided location, the P-Access-Network-Info header field containing the location provided by the UE-A is kept in the INVITE request. + +#### 3. REGISTER request (IBCF-vA1 to IC-A1) - see example in table 5.2.2-3. + +The IBCF-vA1 receives the initial REGISTER request and analyses the request line and forwards registration to preferred VoIP IC provider (i.e. to IC A). The IBCF-vA1 determines the next hop IP address from the request URI either by configured information or using a DNS query according to IETF RFC 3263 [13]. If the subsequent interconnection network is SIP-aware, the determined IP address will belong to the SIP proxy IC-A1. Otherwise the determined IP address will point to IBCF-hA1 and step 4 is skipped (not reflected in message details below). + +The IBCF-vA1 adds its own address to the Path header field. + +**Table 5.2.2-3: REGISTER request (IBCF-vA1 to IC-A1)** + +``` +REGISTER sip:home-A.net SIP/2.0 + +P-Access-Network-Info: +From: +To: +Contact: +CSeq: +``` + +``` + +Supported: +Require: +Path: , +Route: +P-Visited-Network-ID: +P-Charging-Vector: +Via: SIP/2.0/UDP ibcf-vA1.visited-A.net;branch=z9hG4bK351g45.1, + SIP/2.0/UDP pcscf-vA1.visited-A.net:5060;branch=z9hG4bKnas56565, + SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd];branch=z9hG4bKnashds7 +... + +``` + +Other SIP header fields are set according to 3GPP TS 24.229 [4]. + +**Path:** Based on topology hiding functionality the IBCF-vA1 will either forward the Path header field with: + +- one visible IBCF-vA1 entry and the remaining collected entries as one hidden entry. If the SIP URI in the bottommost hidden Path header field contains an "iotl" SIP URI parameter then IBCF-vA1 will append an "iotl" SIP URI parameter with the same value to its own SIP URI in the Path header field; or +- one IBCF-vA1 entry and the whole content of already collected entries as visible entries. + +**Route:** The IBCF-vA1 adds a Route header field identifying the selected node in the IC network A. + +**Via:** Based on topology hiding functionality the IBCF-vA1 will either forward the Via header field with: + +- one visible IBCF-vA1 entry and the remaining collected entries as one hidden entry; or +- one IBCF-vA1 entry and the whole content of already collected entries as visible entries. + +#### 4. REGISTER request (IC-A1 to IBCF-hA1) - see example in table 5.2.2-4. + +NOTE 2: If the subsequent interconnection network is SIP-unaware, step 4 is skipped (not reflected in message details below). + +The IC-A1 receives the initial REGISTER request and analyses the request line and forwards registration to the IBCF-hA1 of the home network of user A. The routing could either apply via DSN or any other routing mechanism. + +**Table 5.2.2-4: REGISTER request (IC-A1 to IBCF-hA1)** + +``` + +REGISTER sip:home-A.net SIP/2.0 + +P-Access-Network-Info: +From: +To: +CSeq: +Supported: +Require: +Contact: +Path: , , +Route: +P-Visited-Network-ID: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024"; +orig-ioi="Type lvisited-a";transit-ioi="ICa.1" +Via: SIP/2.0/UDP ic-A1.interconnection-A.net;branch=z9hG4bK351g45.2, + SIP/2.0/UDP ibcf-vA1.visited-A.net;branch=z9hG4bK351g45.1, + SIP/2.0/UDP pcscf-vA1.visited-A.net:5060;branch=z9hG4bKnas56565, + SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd];branch=z9hG4bKnashds7 +... + +``` + +Other SIP header fields are set according to 3GPP TS 24.229 [4]. + +**P-Charging-Vector:** In this example the IC-A1 adds the identity of the IC-A1 VoIP provider (i.e. "ICa") in the "transit-ioi" header field parameter. However, if the REGISTER request is routed via more than one IC VoIP provider network each IC VoIP provider receiving the REGISTER request adds a "transit-ioi" header field entry containing the IC VoIP provider identity. + +- Path:** Based on SLA between IC partners and roaming partners the address of the IC-A1 will be added or not added by IC-A1. +- Route:** The IC-A1 adds a Route header field identifying the selected entry point in the home network hA. +- Via:** The Via header field is added by each proxy in IC networks, in this example the Via header field is only added by IC-A1. + +#### 5. REGISTER request (IBCF-hA1 to I-CSCF-hA1) - see example in table 5.2.2-5. + +The IBCF-hA1 receives the initial REGISTER request and analyses the request line and forwards registration to the I-CSCF-hA1. The IBCF-hA1 adds a Route header field with the address of the I-CSCF-hA1 of the home network of user A. In this example, the IBCF-hA1 does not add any "transit-ioi" header field parameter in the P-Charging-Vector header field. However, the IBCF-hA1 adds the "transit-ioi" header field parameter based on local policy, when the "transit-ioi" identifying the preceding interconnection network is not included in the received request (e.g. when the preceding interconnection network is not an IMS transit network). + +For performance reasons this I-CSCF-hA1 could be used only for registration traffic for roaming user which is due to local policy of the home network operator. + +**Table 5.2.2-5: REGISTER request (IBCF-hA1 to I-CSCF-hA1)** + +``` +REGISTER sip:home-A.net SIP/2.0 + +P-Access-Network-Info: +From: +To: +Contact: +CSeq: +Supported: +Require: +Path: ,,, +Route: +P-Visited-Network-ID: +P-Charging-Vector: + +Via: SIP/2.0/UDP ibcf-hA1.home-A.net;branch=z9hG4bK351g45.3, +SIP/2.0/UDP ic-A1.interconnection-A.net;branch=z9hG4bK351g45.2, +SIP/2.0/UDP ibcf-vA1.visited-A.net;branch=z9hG4bK351g45.1, +SIP/2.0/UDP pcscf-vA1.visited-A.net:5060;branch=z9hG4bKnas56565, +SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd];branch=z9hG4bKnashds7 +... + +Other SIP header fields are set according to 3GPP TS 24.229 [4]. +``` + +- Path:** The IBCF-hA1 adds a Path header field with the address to receive terminating dialog creating or stand-alone requests. +- Route:** The IBCF-hA1 adds a Route header field identifying the I-CSCF-hA1 of the home network of user A. +- Via:** The IBCF-hA1 adds a Via header field. + +#### 6. REGISTER request (I-CSCF-hA1 to S-CSCF-hA1) - see example in table 5.2.2-6. + +The I-CSCF-hA1 receives the REGISTER request and makes a request for information related to the subscriber registration status by sending the private user identity, public user identity and visited domain name to the HSS. The HSS returns the S-CSCF required capabilities and the I-CSCF-hA1 uses this information to select a suitable S-CSCF. + +Due to the fact that the I-CSCF-hA1 only identifies the home S-CSCF which is responsible for the roaming user A, the I-CSCF-hA1 is not needed for future requests to be kept in the path, thus an I-CSCF entry is not needed within the Path header field. + +But for the response to the REGISTER message the I-CSCF-hA1 has to be added in the Via header field. + +**Table 5.2.2-6: REGISTER request (I-CSCF-hA1 to S-CSCF-hA1)** + +``` +REGISTER sip:home-A.net SIP/2.0 + +P-Access-Network-Info: +From: +To: +Contact: +CSeq: +Supported: +Require: +Path: +Route: +P-Visited-Network-ID: +P-Charging-Vector: + +Via: SIP/2.0/UDP icscf-hA1.home-A.net;branch=z9hG4bK351g45.4, + SIP/2.0/UDP ibcf-hA1.home-A.net;branch=z9hG4bK351g45.3, + SIP/2.0/UDP ic-A1.interconnection-A.net;branch=z9hG4bK351g45.2, + SIP/2.0/UDP ibcf-vA1.visited-A.net;branch=z9hG4bK351g45.1, + SIP/2.0/UDP pcscf-vA1.visited-A.net;5060;branch=z9hG4bKnas56565, + SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd];branch=z9hG4bKnashds7 + +... + +Other SIP header fields are set according to 3GPP TS 24.229 [4]. +``` + +**Route:** The I-CSCF-hA1 adds the address of the selected S-CSCF. + +**Via:** The I-CSCF-hA1 adds a Via header field with the address to receive the response to the REGISTER request. + +#### 7. 401 (Unauthorized) response (S-CSCF-hA1 to I-CSCF-hA1) - see example in table 5.2.2-7. + +As the REGISTER request arrived without integrity protection to the P-CSCF, the S-CSCF-hA1 shall challenge the request. For this, the S-CSCF-hA1 requires at least one authentication vector to be used in the challenge to the user. If a valid authentication vector is not available, then the S-CSCF-hA1 requests at least one authentication vector from the HSS. + +**Table 5.2.2-7: 401 (Unauthorized) response (S-CSCF-hA1 to I-CSCF-hA1)** + +``` +SIP/2.0 401 Unauthorized + +Via: SIP/2.0/UDP icscf-hA1.home-A.net;branch=z9hG4bK351g45.4, + SIP/2.0/UDP ibcf-hA1.home-A.net;branch=z9hG4bK351g45.3, + SIP/2.0/UDP ic-A1.interconnection-A.net;branch=z9hG4bK351g45.2, + SIP/2.0/UDP ibcf-vA1.visited-A.net;branch=z9hG4bK351g45.1, + SIP/2.0/UDP pcscf-vA1.visited-A.net;5060;branch=z9hG4bKnas56565, + SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd];branch=z9hG4bKnashds7 + +From: +To: ;tag=5ef4 +CSeq: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024";orig-ioi="Type 1visited- +a";term-ioi="Type 1home-a" +WWW-Authenticate: Digest realm="registrar.home-A.net", nonce="A34Cm+Fva37UYWpGNB34JP", +algorithm=AKAv1-MD5, ik="00112233445566778899aabbccddeeff", ck="ffeeddccbbaa11223344556677889900" + +Other SIP header fields are set according to 3GPP TS 24.229 [4]. +``` + +**P-Charging-Vector:** The P-Charging-Vector header field containing the "orig-ioi" header field parameter, if received in the REGISTER request and a type 1 "term-ioi" header field parameter. The S-CSCF-hA1 shall set the type 1 "term-ioi" header field parameter to a value that identifies the sending network of the response and the "orig-ioi" header field parameter is set to the previously received value of "orig-ioi" header field parameter. The "icid-value" header field parameter is set to the previously received value of "icid-value" header field parameter in the request. + +**WWW-Authenticate:** The S-CSCF-hA1 includes the WWW-Authenticate header field with: + +- the "realm" header field parameter containing a globally unique name of the S-CSCF-hA1; +- the "nonce" header field parameter containing the quoted string, base64 encoded value of the concatenation of the RANDom challenge (RAND) and Authentication Token (AUTN) parameters and optional server specific data for the UE; +- the security mechanism in the "algorithm" header field parameter; +- the Integrity Key parameter for the P-CSCF in the "ik" header field parameter; and +- the Cipher Key parameter for the P-CSCF in the "ck" header field parameter. + +NOTE 3: If the interconnection network is SIP-unaware, step 10 is skipped. + +#### 8-12. 401 (Unauthorized) response (I-CSCF-hA1 to UE-A). + +Normal response routing procedure as described within 3GPP TS 24.229 [4] applies. No specific roaming procedures apply. + +NOTE 4: If the interconnection network is SIP-unaware, step 10 is skipped. + +#### 13-17. REGISTER request (UE-A to I-CSCF-hA1). + +The authentication challenge response is calculated by the UE-A and then put into the Authorization header field and sent back to the registrar in the REGISTER request. Procedures are described within 3GPP TS 24.229 [4]. + +UE-A registers a second time with an authentication response. + +With the exception of the Authorization header field, the CSeq header field value and the ICID value in the P-Charging-Vector header field, the REGISTER message will contain the same information and the Path header fields and the Via header fields will be set as described within steps 1-5 of this call flow. + +NOTE 5: If the interconnection network is SIP-unaware, step 16 is skipped. + +#### 18. REGISTER request (I-CSCF-hA1 to S-CSCF-hA1). + +I-CSCF-hA1 queries IMS-HSS (LIR/LIA) as described within 3GPP TS 29.228 [14] and routes to the previously assigned S-CSCF-hA1. It is the same procedure as described within step 6 of this call flow. + +The Path header field will be set as described within step 6 of this call flow. + +#### 19-22. 200 OK response (S-CSCF-hA1 to IBCF-vA1) - see example in table 5.2.2-19. + +S-CSCF-hA1 confirms the registration as described within 3GPP TS 24.229 [4]. There are no roaming specific procedures that apply in addition. + +The table 5.2.2-19 shows the content of the 200 (OK) response when sent by S-CSCF-hA1. + +**Table 5.2.2-19: 200 OK response (S-CSCF-hA1 to IBCF-vA1)** + +``` +SIP/2.0 200 OK + +Via: SIP/2.0/UDP icscf-hA1.home-A.net;branch=z9hG4bK351g45.4, + SIP/2.0/UDP ibcf-hA1.home-A.net;branch=z9hG4bK351g45.3, + SIP/2.0/UDP ic-A1.interconnection-A.net;branch=z9hG4bK351g45.2, + SIP/2.0/UDP ibcf-vA1.visited-A.net;branch=z9hG4bK351g45.1, + SIP/2.0/UDP pcscf-vA1.visited-A.net:5060;branch=z9hG4bKnas56565, + SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd];branch=z9hG4bKnashds7 +From: +Service-Route: +To: +CSeq: 2 REGISTER +Contact: +P-Associated-URI: , +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024";orig-iei="Type 1visited- +a";term-iei="Type 1home-a" +Path: , + , + , + + +Other SIP header fields are set according to 3GPP TS 24.229 [4]. +``` + +- Path:** List of Path header field received in the REGISTER request will be included. (IBCF-hA1, IC-A1, IBCF-vA1, P-CSCF-vA1). +- P-Associated-URI:** Containing the list of the registered distinct public user identity and its associated set of implicitly registered distinct public user identities. The first URI in the list of public user identities supplied by the HSS to the S-CSCF will indicate the default public user identity to be used by the S-CSCF. +- Service-Route:** Contains the SIP URI identifying the S-CSCF (S-CSCF-hA1) containing an indication that subsequent requests routed via this service route (i.e. from the P-CSCF to the S-CSCF). In case network topology hiding is required by the home network, a visible SIP URI identifying the IBCF (IBCF-hA1) will be added by the IBCF acting as an entry point as the topmost entry and a hidden SIP URI identifying the S-CSCF (S-CSCF-hA1) in the bottom. The Service-Route header field includes traffic leg information in the "iotl" SIP URI parameter according to IETF RFC 7549 [26]. +- P-Charging-Vector:** The P-Charging-Vector header field containing the "orig-ioi" header field parameter, if received in the REGISTER request and a type 1 "term-ioi" header field parameter. The S-CSCF-hA1 shall set the type 1 "term-ioi" header field parameter to a value that identifies the sending network of the response and the "orig-ioi" header field parameter is set to the previously received value of "orig-ioi" header field parameter. The "icid-value" header field parameter is set to the previously received value of "icid-value" header field parameter in the request. + +#### 23. 200 OK response (IBCF-vA1 to P-CSCF-vA1). + +If topology hiding is required by the visited network and the IBCF-vA1 applied topology hiding on the Path and Via header fields contained in the REGISTER request, the IBCF-vA1 performs a decryption procedure on the received Path and Via header fields, as described in clause 5.10.4.3of 3GPP TS 24.229 [4], and inserts a "+g.3gpp.thig-path" Feature-Caps header field parameter set to the same IBCF-vA1's SIP URI value as included in the Path header field of the REGISTER request sent to the home network. + +#### 24. 200 OK response (P-CSCF-vA1 to UE-A). + +The P-CSCF-vA1 stores the value of received "+g.3gpp.thig-path" Feature-Caps header field parameter and removes the "+g.3gpp.thig-path" Feature-Caps header field parameter before forwarding the 200 (OK) response to the UE-A. + +### 5.2.3 Subscription to the registration-state event package + +#### 5.2.3.1 General + +After that the registration in clause 5.2.2 is successfully completed the UE and the P-CSCF subscribes to the registration-state event package as described in 3GPP TS 24.229 [4]. + +The difference between the UE-A subscription and the P-CSCF-vA1 subscription is that the UE-A sends the SUBSCRIBE request using the registration path while the P-CSCF-vA1 is using the NNI i.e. for the IC network A it will appear as the SUBSCRIBE request sent by the P-CSCF-vA1 is between two home networks. + +NOTE: The message flows in clause 5.2.3.2 and clause 5.2.3.3 are independent and can be done in parallel. + +#### 5.2.3.2 The UE subscribes to the registration-state event package + +After that the registration in clause 5.2.2 is successfully completed the UE subscribes to the registration-state event package as described in 3GPP TS 24.229 [4] clause 5.1.1.3. + +Figure 5.2.3.2-1 shows how the UE-A sends the SUBSCRIBE request using the registration path. + +![Sequence diagram showing the subscription process from UE-A through various network elements (P-CSCF-vA1, IBCF-vA1, IC-A1, IBCF-hA1, I-CSCF-hA1, S-CSCF-hA1) across Visited network vA, IC network A, and Home network hA. The process starts with a successful registration (step 1), followed by a SUBSCRIBE request (step 2) from UE-A to P-CSCF-vA1, which is then forwarded through the network elements (steps 3-6). Responses (200 OK) are returned from the home network back to the UE (steps 7-11). NOTIFY messages are then sent from the home network to the UE (steps 12-16), and final 200 OK responses are received (steps 17-21).](28d75f39a24203712ee907b32cf0bbe5_img.jpg) + +Sequence diagram showing the subscription process from UE-A through various network elements (P-CSCF-vA1, IBCF-vA1, IC-A1, IBCF-hA1, I-CSCF-hA1, S-CSCF-hA1) across Visited network vA, IC network A, and Home network hA. The process starts with a successful registration (step 1), followed by a SUBSCRIBE request (step 2) from UE-A to P-CSCF-vA1, which is then forwarded through the network elements (steps 3-6). Responses (200 OK) are returned from the home network back to the UE (steps 7-11). NOTIFY messages are then sent from the home network to the UE (steps 12-16), and final 200 OK responses are received (steps 17-21). + +**Figure 5.2.3.2-1: Subscription to the registration-state event package by the UE-A** + +The steps of the flow are as follows: + +1. The UE successfully registers as described in clause 5.2.2. +2. **SUBSCRIBE request (UE-A to P-CSCF-vA1) - see example in table 5.2.3.2-2.** + +The UE-A sends the SUBSCRIBE request as specified in 3GPP TS 24.229 [4] using the registration path created by the registration in clause 5.2.2. + +**Table 5.2.3.2-2: SUBSCRIBE request (UE-A to P-CSCF-vA1)** + +``` + +SUBSCRIBE sip:userA_public1@home-A.net SIP/2.0 + +From: ;tag=4fa3 +To: +Route: , +P-Preferred-Identity: +Contact: +CSeq: 1 SUBSCRIBE +Event: reg +Expires: 600000 +Accept: application/reginfo+xml +P-Access-Network-Info: 3GPP-E-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 + +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd];branch=z9hG4bKnashds7 + +Other SIP header fields are set according to 3GPP TS 24.229 [4]. + +``` + +- Request-URI:** Set to the SIP URI that is the default public user identity of the user A i.e. userA\_public1@home-A.net. +- From:** Set to the SIP URI that is the default public user identity of the user A i.e. userA\_public1@home-A.net. +- To:** Set to the SIP URI that is the default public user identity of the user A i.e. userA\_public1@home-A.net. + +- Route:** The UE-A builds a proper preloaded route set for the SUBSCRIBE dialog containing the IP address or the FQDN learnt through the P-CSCF discovery procedures and P-CSCF port based on the security mechanism in use. In addition the values received in the Service-Route header field saved from the 200 (OK) response to the last registration or re-registration of the public user identity with associated contact address are added. The content of the received Service-Route header field is due to operator policy. In this example only the S-CSCF-hA1 (including traffic leg information in the "iot1" SIP URI parameter according to IETF RFC 7549 [26]) will be included. +- P-Preferred-Identity:** Set to the SIP URI that is the default public user identity of the user A i.e. userA\_public1@home-A.net. +- Event:** The value of the Event header field is set to the value "reg" to specify the use of the registration state package. +- Accept:** The value of the Accept header field is set to "application/reginfo+xml". + +##### 3. SUBSCRIBE request (P-CSCF-vA1 to IBCF-vA1) – see example in table 5.2.3.2-3. + +When the P-CSCF-vA1 receives the SUBSCRIBE request and the P-CSCF-vA1 verifies that the resulting list of Route header fields matches the list of URIs received in the Service-Route header field (during the last successful registration or re-registration). This verification is done on a per URI basis, not as a whole string. + +The P-CSCF-vA1 selects an IBCF (IBCF-vA1) to be the exit IBCF towards the home network hA and sends the SUBSCRIBE request according to 3GPP TS 24.229 [4] to IBCF-vA1. + +**Table 5.2.3.2-3: SUBSCRIBE request (P-CSCF-vA1 to IBCF-vA1)** + +``` +SUBSCRIBE sip:userA_public1@home-A.net SIP/2.0 + +From: +To: +P-Asserted-Identity: +Route: , +Record-Route: +Contact: +CSeq: +Event: +Expires: +Accept: +P-Access-Network-Info: 3GPP-E-UTRAN-TDD;utran-cell-id-3gpp=234151D0FCE11, + 3GPP-E-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11; + network-provided;local-time-zone="UTC+01:00";daylight-saving-time="01" +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024";orig-ioi="Type 1visited-a" + +Via: SIP/2.0/UDP pcscf-vA1.visited-A.net:5060;branch=z9hG4bKnas56565 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd];branch=z9hG4bKnashds7 + +Other SIP header fields are set according to 3GPP TS 24.229 [4]. +``` + +- P-Asserted-Identity:** The value is set to the default public user identity i.e. userA\_public1@home-A.net. +- P-Charging-Vector:** The P-CSCF-vA1 adds the P-Charging-Vector header field containing a new ICID value in the "icid" header field parameter and an "orig-ioi" header field parameter. The IOI value is of type 1 and identifies the visited network vA (i.e. visited-a). +- P-Access-Network-Info:** The P-CSCF adds a network provided location and daylight saving information. If the received P-Access-Network-Info header field doesn't indicate that it is a network provided location, the P-Access-Network-Info header field containing the location provided by the UE-A is kept in the INVITE request. +- Route:** The P-CSCF adds a Route header field identifying the selected IBCF-vA1. +- Record-Route:** The P-CSCF adds a Record-Route header field. +- Via:** The P-CSCF adds a Via header field. + +##### 4. SUBSCRIBE request (IBCF-vA1 to IC-A1) – see example in table 5.2.3.2-4. + +When the IBCF-vA1 receives the SUBSCRIBE request the IBCF-vA1 selects, based on local policy, to route the SUBSCRIBE request via IC network A and sends the SUBSCRIBE request according to 3GPP TS 24.229 [4] to the IC-A1. The IBCF-vA1 determines the next hop IP address from the URI in the first Route header field entry either by configured information or using a DNS query according to IETF RFC 3263 [13]. If the subsequent interconnection network is SIP-aware, the determined IP address will belong to the SIP proxy IC-A1. Otherwise the determined IP address will point to IBCF-hA1 and step 5 is skipped (not reflected in message details below). + +**Table 5.2.3.2-4: SUBSCRIBE request (IBCF-vA1 to IC-A1)** + +``` + +SUBSCRIBE sip:userA_public1@home-A.net SIP/2.0 + +From: +To: +P-Asserted-Identity: +Route: , +Record-Route: , +Contact: +CSeq: +Event: +Expires: +Accept: +P-Access-Network-Info: +P-Charging-Vector: + +Via: SIP/2.0/UDP ibcf-vA1.visited-A.net;branch=z9hG4bK351g45.1 +Via: SIP/2.0/UDP pcscf-vA1.visited-A.net:5060;branch=z9hG4bKnas56565 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd];branch=z9hG4bKnashds7 + +Other SIP header fields are set according to 3GPP TS 24.229 [4]. + +``` + +**Route:** The IBCF-vA1 adds a Route header field identifying the selected node in the IC network A. + +**Record-Route:** Based on topology hiding functionality the IBCF-vA1 will either forward the Record-Route header field with: + +- one visible IBCF-vA1 entry and the remaining collected entries as one hidden entry; or +- an IBCF-vA1 entry and whole content of already collected entries as visible entries. + +**Via:** Based on topology hiding functionality the IBCF-vA1 will either forward the Via header field with: + +- one visible IBCF-vA1 entry and the remaining collected entries as one hidden entry; or +- an IBCF-vA1 entry and whole content of already collected entries as visible entries. + +##### 5. SUBSCRIBE request (IC-A1 to IBCF-hA1) – see example in table 5.2.3.2-5. + +NOTE 1: If the interconnection network is SIP-unaware, step 5 is skipped (not reflected in message details below). + +When the IC-A1 receives the SUBSCRIBE request the IC-A1 selects an entry point (IBCF-hA1) of the home network hA and sends the SUBSCRIBE request according to 3GPP TS 24.229 [4] to the IBCF-hA1. + +The IC-A1 can add a Route header field pointing to the entry point of the home network hA. This is shown in the example in table 5.2.3-5. + +**Table 5.2.3.2-5: SUBSCRIBE request (IC-A1 to IBCF-hA1)** + +``` + +SUBSCRIBE sip:userA_public1@home-A.net SIP/2.0 + +From: +To: +P-Asserted-Identity: +Route: , +Record-Route: , , +Contact: +CSeq: +Event: +Expires: +Accept: +P-Access-Network-Info: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024";orig-ioi="Type 1visited- +a";transit-ioi="ICa.1" + +Via: SIP/2.0/UDP ic-A1.interconnection-A.net;branch=z9hG4bK351g45.2 +Via: SIP/2.0/UDP ibcf-vA1.visited-A.net;branch=z9hG4bK351g45.1 +Via: SIP/2.0/UDP pcscf-vA1.visited-A.net:5060;branch=z9hG4bKnas56565 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd];branch=z9hG4bKnashds7 + +Other SIP header fields are set according to 3GPP TS 24.229 [4]. + +``` + +**P-Charging-Vector:** The IC-A1 adds the "transit-ioi" header field parameter identifying the interconnection network (i.e. ICa.1). + +**Route:** The IC-A1 adds a Route header field identifying the selected entry point in the home network hA. + +**Record-Route:** Based on interconnection operator SLA the IC-A1 adds an entry to the Record-Route header field or not. + +**Via:** The IC-A1 adds a Via header field. + +##### 6. SUBSCRIBE request (IBCF-hA1 to S-CSCF-hA1) – see example in table 5.2.3.2-6. + +When the IBCF-hA1 receives the SUBSCRIBE request the IBCF-hA1 sends the SUBSCRIBE request according to 3GPP TS 24.229 [4] to the S-CSCF-hA1. + +In this example, the IBCF-hA1 does not add any "transit-ioi" header field parameter in the P-Charging-Vector header field. However, the IBCF-hA1 adds the "transit-ioi" header field parameter based on local policy, when the "transit-ioi" identifying the preceding interconnection network is not included in the received request (e.g. when the preceding interconnection network is not an IMS transit network). + +**Table 5.2.3.2-6: SUBSCRIBE request (IBCF-hA1 to S-CSCF-hA1)** + +``` + +SUBSCRIBE sip:userA_public1@home-A.net SIP/2.0 + +From: +To: +P-Asserted-Identity: +Route: +Record-Route: , , , +Contact: +CSeq: +Event: +Expires: +Accept: +P-Access-Network-Info: +P-Charging-Vector: + +Via: SIP/2.0/UDP ibcf-hA1.home-A.net;branch=z9hG4bK351g45.3 +Via: SIP/2.0/UDP ic-A1.interconnection-A.net;branch=z9hG4bK351g45.2 +Via: SIP/2.0/UDP ibcf-vA1.visited-A.net;branch=z9hG4bK351g45.1 +Via: SIP/2.0/UDP pcscf-vA1.visited-A.net:5060;branch=z9hG4bKnas56565 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd];branch=z9hG4bKnashds7 + +Other SIP header fields are set according to 3GPP TS 24.229 [4]. + +``` + +**Via:** The IBCF-hA1 adds a Via header field. + +**Record-Route:** The IBCF-hA1 adds a Record-Route header field. + +#### 7-11. 200 (OK) response (S-CSCF-hA1 to UE-A). + +The S-CSCF-hA1 acknowledges a successful subscription to the registration-state event package where: + +- the S-CSCF-hA1 includes a P-Charging-Vector header field containing the same ICID value and "orig-ioi" header field parameter as received in the SUBSCRIBE request. In addition the S-CSCF-hA1 adds the "term-ioi" header field parameter with the IOI value set to a value identifying the home network A (i.e. home-a). +- the IC-A1 adds to the P-Charging-Vector header field the "transit-ioi" set to a value identifying the interconnection network (i.e. ICA.1). + +NOTE 2: If the interconnection network is SIP-unaware, step 9 is skipped. + +#### 12. NOTIFY request (S-CSCF-hA1 to IBCF-hA1) – see example in table 5.2.3.2-12. + +The S-CSCF-hA1 immediately after sending the 200 (OK) to the SUBSCRIBE request sends a NOTIFY request containing the registration-state event package in an application/reginfo+xml MIME body. + +The NOTIFY request is sent along the path created by the routes received in the Record-Route header field. + +**Table 5.2.3.2-12: NOTIFY request (S-CSCF-hA1 to IBCF-hA1)** + +``` +NOTIFY sip:[5555::aaa:bbb:ccc:ddd] SIP/2.0 +To: +From:;tag=3fa5 +Route:,,, +Call-ID:cb03a0s09a2sdfglkj490333 +CSeq:25 NOTIFY +Contact:sip:[5555::aaa:ccc:eee:aaa] +Event:reg +Subscription-State:active;expires=600000 +P-Charging-Vector:icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=45678901";orig-ioi="Type 1 home-a" + +Via: SIP/2.0/UDP scscf-hA1.home-A.net;branch=z9hG4bK23456.1 + +Content-Type:application/reginfo+xml +Content-Length: (...) + +For an example of the content of the SDP application/reginfo+xml see 3GPP TS 24.229 [4] subclause +5.4.2.1.2. + +Other SIP header fields are set according to 3GPP TS 24.229 [4]. +``` + +**Request-URI:** The S-CSCF-hA1 uses the contact address of the UE received during registration as the Request-URI. + +**Route:** The routes in the Record-Route header field are used as the route set. + +**Event:** The S-CSCF-hA1 adds the Event header field containing the "reg" value. + +**Subscription-State:** The S-CSCF-hA1 adds the Subscription-State header field set to "active" and indicates the expiration time in the "expires" header field parameter. + +**P-Charging-Vector:** The S-CSCF-hA1 adds the P-Charging-Vector header field containing a new ICID value and the "ioi-orig" header field parameter set to a type 1 IOI value (i.e. home-A). + +**Via:** The S-CSCF-hA1 adds a Via header field. + +**Content-Type:** The S-CSCF-hA1 sets the value of the Content-Type header field to "application/reginfo+xml". + +##### 13. NOTIFY request (IBCF-hA1 to IC-A1) – see example in table 5.2.3.2-13. + +The IBCF-hA1 sends the NOTIFY request according to 3GPP TS 24.229 [4] to the IC-A1. + +NOTE 3: If the subsequent interconnection network is SIP-unaware, the IBCF-hA1 sends the NOTIFY request according to 3GPP TS 24.229 [4] to the IBCF-vA1 (not reflected in message details below). + +**Table 5.2.3.2-13: NOTIFY request (IBCF-hA1 to IC-A1)** + +``` +NOTIFY sip:[5555::aaa:bbb:ccc:ddd] SIP/2.0 +To: +From: +Route:,, +Record-Route: +Call-ID: +CSeq: +Contact: +Event: +Subscription-State: +P-Charging-Vector: + +Via:SIP/2.0/UDP ibcf-hA1.home-A.net;branch=z9hG4bK23456.2 +Via:SIP/2.0/UDP scscf-hA1.home-A.net;branch=z9hG4bK23456.1 + +Content-Type: +Content-Length: (...) + +For an example of the content of the SDP application/reginfo+xml see 3GPP TS 24.229 [4] subclause +5.4.2.1.2. + +Other SIP header fields are set according to 3GPP TS 24.229 [4]. +``` + +**Record-Route:** The IBCF-hA1 adds a Record-Route header field. + +**Via:** Based on topology hiding functionality the IBCF-hA1 will either forward the Via header field with: + +- one visible IBCF-hA1 entry and the remaining collected entries as one hidden entry; or +- an IBCF-hA1 entry and whole content of already collected entries as visible entries. + +##### **14. NOTIFY request (IC-A1 to IBCF-vA1) – see example in table 5.2.3.2-14.** + +NOTE 4: If the interconnection network is SIP-unaware, step 14 is skipped (not reflected in message details below). + +The IC-A1 sends the NOTIFY request according to 3GPP TS 24.229 [4] to the IBCF-vA1. + +**Table 5.2.3.2-14: NOTIFY request (IC-A1 to IBCF-vA1)** + +``` +NOTIFY sip:[5555::aaa:bbb:ccc:ddd] SIP/2.0 +To: +From: +Route:, +Record-Route: , +Call-ID: +CSeq: +Contact: +Event: +Subscription-State: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=45678901";orig-ioi="Type 1home- +a";transit-ioi="ICa.1" + +Via: SIP/2.0/UDP ic-A1.interconnection-A.net;branch=z9hG4bK23456.3 +Via: SIP/2.0/UDP ibcf-hA1.home-A.net;branch=z9hG4bK23456.2 +Via: SIP/2.0/UDP scscf-hA1.home-A.net;branch=z9hG4bK23456.1 + +Content-Type: +Content-Length: (...) + +For an example of the content of the SDP application/reginfo+xml see 3GPP TS 24.229 [4] subclause +5.4.2.1.2. + +Other SIP header fields are set according to 3GPP TS 24.229 [4]. +``` + +**P-Charging-Vector:** The IC-A1 adds the "transit-ioi" header field parameter identifying the interconnection network (i.e. ICa.1). + +**Record-Route:** The IC-A1 adds a Record-Route header field. + +**Via:** The IC-A1 adds a Via header field. + +#### 15. NOTIFY request (IBCF-vA1 to P-CSCF-vA1) – see example in table 5.2.3.2-15. + +The IBCF-vA1 sends the NOTIFY request according to 3GPP TS 24.229 [4] to the P-CSCF-vA1. + +In this example, the IBCF-vA1 does not add any "transit-ioi" header field parameter in the P-Charging-Vector header field. However, the IBCF-vA1 adds the "transit-ioi" header field parameter based on local policy, when the "transit-ioi" identifying the preceding interconnection network is not included in the received request (e.g. when the preceding interconnection network is not an IMS transit network). + +**Table 5.2.3.2-15: NOTIFY request (IBCF-vA1 to P-CSCF-vA1)** + +``` +NOTIFY sip:[5555::aaa:bbb:ccc:ddd] SIP/2.0 +To: +From: +Route: +Record-Route:,, +Call-ID: +CSeq: +Contact: +Event: +Subscription-State: +P-Charging-Vector: + +Via: SIP/2.0/UDP ibcf-vA1.visited-A.net;branch=z9hG4bK23456.4 +Via: SIP/2.0/UDP ic-A1.interconnection-A.net;branch=z9hG4bK23456.3 +Via: SIP/2.0/UDP ibcf-hA1.home-A.net;branch=z9hG4bK23456.2 +Via: SIP/2.0/UDP scscf-hA1.home-A.net;branch=z9hG4bK23456.1 + +Content-Type: +Content-Length: (...) + +For an example of the content of the SDP application/reginfo+xml see 3GPP TS 24.229 [4] subclause +5.4.2.1.2. + +Other SIP header fields are set according to 3GPP TS 24.229 [4]. +``` + +**Record-Route:** The IBCF-vA1 adds a Record-Route header field. + +**Via:** The IBCF-vA1 adds a Via header field. + +#### 16. NOTIFY request (P-CSCF-vA1 to UE-A) – see example in table 5.2.3.2-16. + +The P-CSCF-vA1 removes the protocol elements that cannot be sent to outside the trust domain (e.g. the P-Charging-Vector) and sends the NOTIFY request according to 3GPP TS 24.229 [4] to the UE-A. + +**Table 5.2.3.2-16: NOTIFY request (P-CSCF-vA1 to UE-A)** + +``` +NOTIFY sip:[5555::aaa:bbb:ccc:ddd] SIP/2.0 +To: +From: +Record-Route:,,, +Call-ID: +CSeq: +Contact: +Event: +Subscription-State: + +Via: SIP/2.0/UDP pscf-vA1.visited-A.net;branch=z9hG4bK23456.5 +Via: SIP/2.0/UDP ibcf-vA1.visited-A.net;branch=z9hG4bK23456.4 +Via: SIP/2.0/UDP ic-A1.interconnection-A.net;branch=z9hG4bK23456.3 +Via: SIP/2.0/UDP ibcf-hA1.home-A.net;branch=z9hG4bK23456.2 +Via: SIP/2.0/UDP scscf-hA1.home-A.net;branch=z9hG4bK23456.1 + +Content-Type: +Content-Length: (...) + +For an example of the content of the SDP application/reginfo+xml see 3GPP TS 24.229 [4] subclause +5.4.2.1.2. + +Other SIP header fields are set according to 3GPP TS 24.229 [4]. +``` + +**Record-Route:** The P-CSCF-vA1 adds a Record-Route header field. + +**Via:** The P-CSCF-vA1 adds a Via header field. + +#### **17-21. 200 (OK) response (UE-A to S-CSCF-hA1).** + +The UE-A acknowledges the receipt of the NOTIFY request where: + +- the P-CSCF-vA1 includes a P-Charging-Vector header field containing the same ICID value and "orig-ioi" header field parameter as received in the NOTIFY request. In addition the P-CSCF-vA1 adds the "term-ioi" header field parameter with the IOI value set to a value identifying the visited network A (i.e. visited-a). +- the IC-A1 adds to the P-Charging-Vector header field the "transit-ioi" set to a value identifying the interconnection network (i.e. ICa.1). + +NOTE 5: If the interconnection network is SIP-unaware, step 20 is skipped. + +#### **5.2.3.3 The P-CSCF subscribes to the registration-state event package** + +After that the registration in clause 5.2.2 is successfully completed the P-CSCF-vA1 subscribes to the registration-state event package as described in 3GPP TS 24.229 [4] clause 5.2.3. + +The information received in the registration-state event package can be used by the P-CSCF to determine if a registration is still valid. + +Figure 5.2.3.3-1 shows how the P-CSCF-vA1 sends the SUBSCRIBE request without using the registration path hence it will appear as the SUBSCRIBE request is sent between two home networks. + +![Sequence diagram showing the subscription to the registration-state event package by the P-CSCF-vA1. The diagram involves three networks: Visited network vA, IC network A, and Home network hA. The entities involved are UE-A, P-CSCF-vA1, IBCF-vA1, IC-A1, IBCF-hA1, I-CSCF-hA1, and S-CSCF-hA1. The sequence starts with the UE successfully registering. Then, the P-CSCF-vA1 sends a SUBSCRIBE request to the IBCF-vA1, which is forwarded through the IC-A1 and IBCF-hA1 to the I-CSCF-hA1 and finally to the S-CSCF-hA1. The S-CSCF-hA1 sends a 200 OK response back through the I-CSCF-hA1, IBCF-hA1, IC-A1, and IBCF-vA1 to the P-CSCF-vA1. The P-CSCF-vA1 then sends a NOTIFY request to the UE-A, which responds with a 200 OK. The P-CSCF-vA1 also sends a NOTIFY request to the IBCF-vA1, which is forwarded through the IC-A1 and IBCF-hA1 to the I-CSCF-hA1 and finally to the S-CSCF-hA1. The S-CSCF-hA1 sends a 200 OK response back through the I-CSCF-hA1, IBCF-hA1, IC-A1, and IBCF-vA1 to the P-CSCF-vA1.](78ff716475b2f65bf01c3a4d02d89fc4_img.jpg) + +Sequence diagram showing the subscription to the registration-state event package by the P-CSCF-vA1. The diagram involves three networks: Visited network vA, IC network A, and Home network hA. The entities involved are UE-A, P-CSCF-vA1, IBCF-vA1, IC-A1, IBCF-hA1, I-CSCF-hA1, and S-CSCF-hA1. The sequence starts with the UE successfully registering. Then, the P-CSCF-vA1 sends a SUBSCRIBE request to the IBCF-vA1, which is forwarded through the IC-A1 and IBCF-hA1 to the I-CSCF-hA1 and finally to the S-CSCF-hA1. The S-CSCF-hA1 sends a 200 OK response back through the I-CSCF-hA1, IBCF-hA1, IC-A1, and IBCF-vA1 to the P-CSCF-vA1. The P-CSCF-vA1 then sends a NOTIFY request to the UE-A, which responds with a 200 OK. The P-CSCF-vA1 also sends a NOTIFY request to the IBCF-vA1, which is forwarded through the IC-A1 and IBCF-hA1 to the I-CSCF-hA1 and finally to the S-CSCF-hA1. The S-CSCF-hA1 sends a 200 OK response back through the I-CSCF-hA1, IBCF-hA1, IC-A1, and IBCF-vA1 to the P-CSCF-vA1. + +**Figure 5.2.3.3-1: Subscription to the registration-state event package by the P-CSCF-vA1** + +The steps of the flow are as follows: + +1. The UE successfully registers as described in clause 5.2.2. +2. **SUBSCRIBE request (P-CSCF-vA1 to IBCF-vA1) - see example in table 5.2.3.3-2.** + +When the registration is successfully completed, i.e. the 200 (OK) to the REGISTER request sent is to the UE-A) the P-CSCF-vA1 subscribes to the registration-state event package in the home network hA. + +The P-CSCF-vA1 selects an IBCF (IBCF-vA1) to be the IBCF acting as the exit point towards the home network hA and forwards a SUBSCRIBE request according to 3GPP TS 24.229 [4] to the IBCF-vA1. + +**Table 5.2.3.3-2: SUBSCRIBE request (P-CSCF-vA1 to IBCF-vA1)** + +``` +SUBSCRIBE sip:userA_public1@home-A.net;iotl=visitedA-homeA SIP/2.0 + +From:;tag=4ea2 +To: +P-Asserted-Identity: +Route: +Contact: +CSeq: 36 SUBSCRIBE +Event:reg +Expires:600000 +Accept:application/reginfo+xml +P-Access-Network-Info:3GPP-E-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11;network-provided;local- +time-zone="UTC+01:00";daylight-saving-time="01" +P-Charging-Vector: icid-value="AyretyU0dm+602IrT5tAFrbHLso=5467327";orig-ioi="Type 1visited-a" + +Via: SIP/2.0/UDP [5555::ddd:aaa:ccc:bbb];branch=z9hG4bKnas12baad + +Other SIP header fields are set according to 3GPP TS 24.229 [4]. +``` + +- Request-URI:** Set to the default public user identity of the user, i.e. userA\_public1@home-A.net. P-CSCF appends traffic leg information in the "iotl" SIP URI parameter according to IETF RFC 7549 [26]. +- From:** Set to the P-CSCF's SIP URI. +- To:** Set to the SIP URI that is the default public user identity of the user i.e. userA\_public1@home-A.net. + +- P-Asserted-Identity:** Set to the value of the received "+g.3gpp.thig-path" Feature-Caps header field parameter if the received 200 (OK) response to the REGISTER request contained a "+g.3gpp.thig-path" Feature-Caps header field parameter or otherwise, as shown in this example, to the SIP URI of the P-CSCF, which was inserted into the Path header field during the registration of the user to whose registration state the P-CSCF subscribes to. +- Event:** The value of the Event header field is set to the value "reg" to specify the use of the registration state package. +- Accept:** The value of the Accept header field is set to "application/reginfo+xml". +- P-Access-Network-Info:** The P-CSCF adds the P-Access-Network-Info header field with a network provided location and daylight saving information. +- P-Charging-Vector:** The P-CSCF-vA1 includes an ICID value and a type 1 "orig-ioi" header field parameter. The P-CSCF-vA1 shall set the type 1 "orig-ioi" header field parameter to a value that identifies the sending network of the request (i.e. visited-A). + +##### 3. SUBSCRIBE request (IBCF-vA1 to IC-A1) - see example in table 5.2.3.3-3. + +When the IBCF-vA1 receives the SUBSCRIBE request the IBCF-vA1 selects, based on local policy, to route the SUBSCRIBE request via IC network A and sends the SUBSCRIBE request according to 3GPP TS 24.229 [4] to the IC-A1. The IBCF-vA1 determines the next hop IP address from the URI in the first entry of the Route header field either by configured information or using a DNS query according to IETF RFC 3263 [13]. If the subsequent interconnection network is SIP-aware, the determined IP address will belong to the SIP proxy IC-A1. Otherwise the determined IP address will point to IBCF-hA1 and step 4 is skipped (not reflected in message details below). + +**Table 5.2.3.3-3: SUBSCRIBE request (IBCF-vA1 to IC-A1)** + +``` +SUBSCRIBE sip:userA_public1@home-A.net;iotl=visitedA-homeA SIP/2.0 + +From: +To: +P-Asserted-Identity: +Route: +Record-Route: +Contact: +CSeq: +Event: +Expires: +Accept: +P-Access-Network-Info: +P-Charging-Vector: + +Via: SIP/2.0/UDP ibcf-vA1.visited-A.net;branch=z9hG4bKnas12baad.1 +Via: SIP/2.0/UDP [5555::ddd:aaa:ccc:bbb];branch=z9hG4bKnas12baad + +Other SIP header fields are set according to 3GPP TS 24.229 [4]. +``` + +- Route:** The IBCF-vA1 adds a Route header field identifying the selected node in the IC network A. +- Record-Route:** The IBCF-vA1 adds a Record-Route header field. +- Via:** Based on topology hiding functionality the IBCF-vA1 will either forward the Via header field with: +- one visible IBCF-vA1 entry and the remaining collected entries as one hidden entry; or + - one IBCF-vA1 entry and the whole content of already collected entries as visible entries. + +##### 4. SUBSCRIBE request (IC-A1 - to IBCF-hA1) - see example in table 5.2.3.3-4. + +NOTE 1: If the interconnection network is SIP-unaware, step 4 is skipped (not reflected in message details below). + +The IC-A1 selects an entry point (IBCF-hA1) of the home network hA and sends the SUBSCRIBE request according to 3GPP TS 24.229 [4] to the IBCF-hA1. + +The IC-A1 may add a Route header field entry pointing to the entry point of home network hA. This is shown in example in table 5.3.3.3-4. + +**Table 5.2.3.3-4: SUBSCRIBE request (IC-A1 - to IBCF-hA1)** + +``` + +SUBSCRIBE sip:userA_public1@home-A.net;iotl=visitedA-homeA SIP/2.0 + +From: +To: +P-Asserted-Identity: +Route: +Record-Route:, +Contact: +CSeq: +Event: +Expires: +Accept: +P-Charging-Vector: icid-value="AyretyU0dm+602IrT5tAFrbHLso=5467327";orig-ioi="Type 1visited- +a";transit-ioi="ICa.1" +P-Charging-Vector: + +Via: SIP/2.0/UDP ic-A1.interconnection-A.net;branch=z9hG4bKnas12baad.2 +Via: SIP/2.0/UDP ibcf-vA1.visited-A.net;branch=z9hG4bKnas12baad.1 +Via: SIP/2.0/UDP [5555::ddd:aaa:ccc:bbb];branch=z9hG4bKnas12baad + +Other SIP header fields are set according to 3GPP TS 24.229 [4]. + +``` + +**P-Charging-Vector:** The IC-A1 adds the "transit-ioi" header field parameter identifying the interconnection network (i.e. ICa.1). + +**Route:** The IC-A1 adds a Route header field identifying the selected entry point in the home network hA. + +**Record-Route:** Based on interconnection operator SLA the IC-A1 adds an entry to the Record-Route header field or not. + +**Via:** The IC-A1 adds a Via header field. + +##### 5. SUBSCRIBE request (IBCF-hA1 to I-CSCF-hA1) - see example in table 5.2.3.3-5. + +The IBCF-hA1 receives the SUBSCRIBE request and analyses the request line and the request to the I-CSCF-hA1. The IBCF-hA1 adds a Route header field with the address of the I-CSCF-hA1 of the home network of user A. + +In this example, the IBCF-hA1 does not add any "transit-ioi" header field parameter in the P-Charging-Vector header field. However, the IBCF-hA1 adds the "transit-ioi" header field parameter based on local policy, when the "transit-ioi" identifying the preceding interconnection network is not included in the received request (e.g. when the preceding interconnection network is not an IMS transit network). + +**Table 5.2.3.3-5: SUBSCRIBE request (IBCF-hA1 to I-CSCF-hA1)** + +``` + +SUBSCRIBE sip:userA_public1@home-A.net;iotl=visitedA-homeA SIP/2.0 + +From: +To: +P-Asserted-Identity: +Route: +Record-Route:,, +Contact: +CSeq: +Event: +Expires: +Accept: +P-Access-Network-Info: +P-Charging-Vector: + +Via: SIP/2.0/UDP ibcf-hA1.home-A.net;branch=z9hG4bKnas12baad.3 +Via: SIP/2.0/UDP ic-A1.interconnection-A.net;branch=z9hG4bKnas12baad.2 +Via: SIP/2.0/UDP ibcf-vA1.visited-A.net;branch=z9hG4bKnas12baad.1 + +``` + +``` +Via: SIP/2.0/UDP [5555::ddd:aaa:ccc:bbb];branch=z9hG4bKnas12baad +``` + +Other SIP header fields are set according to 3GPP TS 24.229 [4]. + +- Via:** The IBCF-hA1 adds a Via header field. +- Route:** The IBCF-hA1 adds a Route header field with the address of the I-CSCF-hA1 of the home network of user A. +- Record-Route:** The IBCF-hA1 adds a Record-Route header field. + +##### 6. SUBSCRIBE request (I-CSCF-hA1 to S-CSCF-hA1) - see example in table 5.2.3.3-6. + +The I-CSCF-hA1 receives the SUBSCRIBE request and makes a request for information related to the subscriber registration status by sending the public user identity and visited domain name to the HSS. The HSS returns the S-CSCF address. + +Due to the fact that the I-CSCF-hA1 only identifies the home S-CSCF which is responsible for the roaming user A, the I-CSCF-hA1 is not needed for future requests to be kept in the path, thus an I-CSCF entry is not needed within the Record-Route header field. + +But for the response to the SUBSCRIBE request the I-CSCF-hA1 has to be added in the Via header field. + +**Table 5.2.3.3-6: SUBSCRIBE request (I-CSCF-hA1 to S-CSCF-hA1)** + +``` +SUBSCRIBE sip:userA_public1@home-A.net;iotl=visitedA-homeA SIP/2.0 + +From: +To: +P-Asserted-Identity: +Route: +Record-Route:,, +Contact: +CSeq: +Event: +Expires: +Accept: +P-Access-Network-Info: +P-Charging-Vector: + +Via: SIP/2.0/UDP icscf-hA1.home-A.net;branch=z9hG4bKnas12baad.4 +Via: SIP/2.0/UDP ibcf-hA1.home-A.net;branch=z9hG4bKnas12baad.3 +Via: SIP/2.0/UDP ic-A1.interconnection-A.net;branch=z9hG4bKnas12baad.2 +Via: SIP/2.0/UDP ibcf-vA1.visited-A.net;branch=z9hG4bKnas12baad.1 +Via: SIP/2.0/UDP [5555::ddd:aaa:ccc:bbb];branch=z9hG4bKnas12baad + +Other SIP header fields are set according to 3GPP TS 24.229 [4]. +``` + +- Route:** The I-CSCF-hA1 adds the address of the selected S-CSCF. +- Via:** The I-CSCF-hA1 adds a Via header field. + +#### 7-11. 200 (OK) response (S-CSCF to P-CSCF-vA1). + +The S-CSCF-hA1 acknowledges a successful subscription to the registration-state event package where: + +- the S-CSCF-hA1 includes a P-Charging-Vector header field containing the ICID value and "orig-ioi" header field parameter as received in the SUBSCRIBE request. In addition the S-CSCF-hA1 adds the "term-ioi" header field parameter with the IOI value set to a value identifying the home network A (i.e. home-a); and +- the IC-A1 adds to the P-Charging-Vector header field the "transit-ioi" set to a value identifying the interconnection network (i.e. "ICa.1"). + +NOTE 2: If the interconnection network is SIP-unaware, step 10 is skipped. + +#### 12. NOTIFY request (S-CSCF-hA1 to IBCF-hA1) - see example in table 5.2.3.3-12. + +The S-CSCF-hA1 immediately after sending the 200 (OK) to the SUBSCRIBE request sends a NOTIFY request containing the registration-state event package in an application/reginfo+xml MIME body. + +The NOTIFY request is sent along the path created by the routes received in the Record-Route header field. + +**Table 5.2.3.3-12: NOTIFY request (S-CSCF-hA1 to IBCF-hA1)** + +``` +NOTIFY sip:[5555::ddd:aaa:ccc:bbb] SIP/2.0 +To:;tag=4ea2 +From:;tag=3elf +Route:,, +CSeq:35 NOTIFY +Contact: + +Event:reg +Subscription-State:active;expires=600000 +P-Charging-Vector:icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=45678901";orig-ioi="Type 1home-a" + +Via: SIP/2.0/UDP [5555::aaa:ccc:eee:aaa];branch=z9hG4bK23456 + +Content-Type:application/reginfo+xml +Content-Length: (...) + +For an example of the content of the SDP application/reginfo+xml see 3GPP TS 24.229 [4] subclause +5.4.2.1.2. + +Other SIP header fields are set according to 3GPP TS 24.229 [4]. +``` + +| | | +|----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Request-URI: | Set to the contact address of the P-CSCF-vA1. | +| Route: | The routes in the Record-Route header field are used as the route set. | +| Event: | The S-CSCF-hA1 adds the Event header field containing the "reg" value. | +| Subscription-State: | The S-CSCF-hA1 adds the Subscription-State header field set to "active" and indicates the expiration time in the "expires" header field parameter. | +| P-Charging-Vector: | A new ICID value (i.e. different from the ICID value in the SUBSCRIBE request) and a type 1 "orig-ioi" header field parameter. The S-CSCF-hA1 shall set the type 1 "orig-ioi" header field parameter to a value that identifies the sending network of the request (i.e. home-A). | +| Via: | The S-CSCF-hA1 adds a Via header field. | +| Content-Type: | The S-CSCF-hA1 sets the value of the Content-Type header field to "application/reginfo+xml". | + +#### 13. NOTIFY request (IBCF-hA1 to IC-A1) - see example in table 5.2.3.3-13. + +The IBCF-hA1 sends the NOTIFY request according to 3GPP TS 24.229 [4] to the IC-A1. + +NOTE 3: If the subsequent interconnection network is SIP-unaware, the IBCF-hA1 sends the NOTIFY request according to 3GPP TS 24.229 [4] to the IBCF-vA1 (not reflected in message details below). + +**Table 5.2.3.3-13: NOTIFY request (IBCF-hA1 to IC-A1)** + +``` +NOTIFY sip:[5555::ddd:aaa:ccc:bbb] SIP/2.0 +To: +From: +Route:, +Record-Route: +CSeq: +Contact: + +Event: +Subscription-State: +P-Charging-Vector: + +Via: SIP/2.0/UDP ibcf-hA1.home-A.net;branch=z9hG4bK23456.1 +``` + +Via: SIP/2.0/UDP [5555::aaa:ccc:eee:aaa];branch=z9hG4bK23456 + +Content-Type: +Content-Length: (...) + +For an example of the content of the SDP application/reginfo+xml see 3GPP TS 24.229 [4] subclause 5.4.2.1.2. + +Other SIP header fields are set according to 3GPP TS 24.229 [4]. + +**Record-Route:** The IBCF-hA1 adds a Record-Route header field. + +**Via:** Based on topology hiding functionality the IBCF-hA1 will either forward the Via header field with: + +- one visible IBCF-hA1 entry and the remaining collected entries as one hidden entry; or +- one IBCF-hA1 entry and the whole content of already collected entries as visible entries. + +#### 14. NOTIFY request (IC-A1 to IBCF-vA1) - see example in table 5.2.3.3-14. + +NOTE 4: If the interconnection network is SIP-unaware, step 14 is skipped (not reflected in message details below). + +The IC-A1 sends the NOTIFY request according to 3GPP TS 24.229 [4] to the IBCF-vA1. + +**Table 5.2.3.3-14: NOTIFY request (IC-A1 to IBCF-vA1)** + +``` +NOTIFY sip:[5555::ddd:aaa:ccc:bbb] SIP/2.0 +To: +From: +Route: +Record-Route:, +CSeq: +Contact: +Event: +Subscription-State: +P-Charging-Vector:icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=45678901";orig-ioi="Type 1home-a";transit-ioi="ICa.1" + +Via: SIP/2.0/UDP ic-A1.interconnection-A.net;branch=z9hG4bK23456.2 +Via: SIP/2.0/UDP ibcf-hA1.home-A.net;branch=z9hG4bK23456.1 +Via: SIP/2.0/UDP [5555::aaa:ccc:eee:aaa];branch=z9hG4bK23456 + +Content-Type: +Content-Length: (...) + +For an example of the content of the SDP application/reginfo+xml see 3GPP TS 24.229 [4] subclause 5.4.2.1.2. + +Other SIP header fields are set according to 3GPP TS 24.229 [4]. +``` + +**P-Charging-Vector:** The IC-A1 adds the "transit-ioi" header field parameter identifying the interconnection network (i.e. ICa.1). + +**Record-Route:** Based on interconnection operator SLA the IC-A1 adds an entry to the Record-Route header field or not. + +**Via:** The IC-A1 adds a Via header field. + +#### 15. NOTIFY request (IBCF-vA1 to P-CSCF-vA1) - see example in table 5.2.3.3-15. + +The IBCF-vA1 sends the NOTIFY request according to 3GPP TS 24.229 [4] to the P-CSCF-vA1. + +In this example, the IBCF-vA1 does not add any "transit-ioi" header field parameter in the P-Charging-Vector header field. However, the IBCF-vA1 adds the "transit-ioi" header field parameter based on local policy, when the "transit-ioi" identifying the preceding interconnection network is not included in the received request (e.g. when the preceding interconnection network is not an IMS transit network). + +**Table 5.2.3.3-15: NOTIFY request (IBCF-vA1 to P-CSCF-vA1)** + +``` + +NOTIFY sip:[5555::ddd:aaa:ccc:bbb] SIP/2.0 +To: +From: +Record-Route:,, +CSeq: +Contact: +Event: +Subscription-State: +P-Charging-Vector: + +Via: SIP/2.0/UDP ibcf-vA1.visited-A.net;branch=z9hG4bK23456.3 +Via: SIP/2.0/UDP ic-A1.interconnection-A.net;branch=z9hG4bK23456.2 +Via: SIP/2.0/UDP ibcf-hA1.home-A.net;branch=z9hG4bK23456.1 +Via: SIP/2.0/UDP [5555::aaa:ccc:eee:aaa];branch=z9hG4bK23456 + +Content-Type: +Content-Length: (...) + +For an example of the content of the SDP application/reginfo+xml see 3GPP TS 24.229 [4] subclause +5.4.2.1.2. + +Other SIP header fields are set according to 3GPP TS 24.229 [4]. + +``` + +**Record-Route:** The IBCF-vA1 adds a Record-Route header field entry. + +**Via:** The IBCF-vA1 adds a Via header field. + +#### **16-19. 200 (OK) response (P-CSCF-vA1 to S-CSCF-hA1).** + +The P-CSCF-vA1 acknowledges the receipt of the NOTIFY request where: + +- the P-CSCF-vA1 includes a P-Charging-Vector header field containing the ICID value and "orig-ioi" header field parameter as received in the NOTIFY request. In addition the P-CSCF-vA1 adds the "term-ioi" header field parameter with the IOI value set to a value identifying the visited network A (i.e. visited-a); and +- the IC-A1 adds to the P-Charging-Vector header field the "transit-ioi" set to a value identifying the interconnection network (i.e. ICa.1). + +NOTE 5: If the interconnection network is SIP-unaware, step 18 is skipped. + +## **5.3 Originating roaming without loopback** + +### **5.3.1 General** + +This clause describes routing from the originating visited network to the originating home network including the traversal of transit network between the visited and the originating home network. + +### **5.3.2 Call flow** + +In this scenario the originating home network decides to route the media directly to the terminating home network. OMR is not executed. + +Preconditions: + +- the user A is registered to the home network hA via the visited operator vA network and the IC network A as described in clause 5.2. The IC network does not store any registration information; and +- the called user is located in another network either in PSTN or in IMS. + +![Sequence diagram for MOC without loopback showing signaling flow between Visited network vA, IC network A, and Home network hA.](32ff77da4286b58c4778033acaa10836_img.jpg) + +The diagram illustrates the signaling flow for a Mobile Originated Call (MOC) without loopback across three network domains: Visited network vA, IC network A, and Home network hA. The entities involved are UE-A, P-CSCF-vA1, IBCF-vA1, IC-A1, IBCF-hA1, I-CSCF-hA1, S-CSCF-hA1, AS-hA1, and IBCF-hA2. The flow starts with an INVITE from UE-A to P-CSCF-vA1, which is then routed through IBCF-vA1, IC-A1, IBCF-hA1, I-CSCF-hA1, and S-CSCF-hA1 to AS-hA1 and IBCF-hA2. Responses (183, 180, 200 OK) are returned through the same path. Additional messages include PRACK, Resource reservation, and UPDATE. + +``` + +sequenceDiagram + participant UE-A + participant P-CSCF-vA1 + participant IBCF-vA1 + participant IC-A1 + participant IBCF-hA1 + participant I-CSCF-hA1 + participant S-CSCF-hA1 + participant AS-hA1 + participant IBCF-hA2 + + Note left of UE-A: Resource authorization + UE-A->>P-CSCF-vA1: 1. INVITE + P-CSCF-vA1->>IBCF-vA1: 2. INVITE + IBCF-vA1->>IC-A1: 3. INVITE + IC-A1-->>IBCF-hA1: 4. INVITE + IBCF-hA1->>I-CSCF-hA1: 5. INVITE + I-CSCF-hA1->>S-CSCF-hA1: 6. INVITE + S-CSCF-hA1->>AS-hA1: 7. INVITE + AS-hA1->>IBCF-hA2: 8. INVITE + IBCF-hA2-->>S-CSCF-hA1: 9. 183 + S-CSCF-hA1-->>AS-hA1: 10. 183 + AS-hA1-->>IBCF-hA2: 11. 183 + IBCF-hA2-->>S-CSCF-hA1: 12. 183 + S-CSCF-hA1-->>I-CSCF-hA1: 13. 183 + I-CSCF-hA1-->>IC-A1: 14. 183 + IC-A1-->>IBCF-vA1: 15. 183 + IBCF-vA1-->>P-CSCF-vA1: 16. 183 + P-CSCF-vA1-->>UE-A: 17. PRACK and 200 OK PRACK + Note left of UE-A: 18. Resource reservation + UE-A->>P-CSCF-vA1: 19. UPDATE and 200 OK + P-CSCF-vA1-->>IBCF-vA1: 20. 180 + IBCF-vA1-->>IC-A1: 21. 180 + IC-A1-->>IBCF-hA1: 22. 180 + IBCF-hA1-->>I-CSCF-hA1: 23. 180 + I-CSCF-hA1-->>S-CSCF-hA1: 24. 180 + S-CSCF-hA1-->>AS-hA1: 25. 180 + AS-hA1-->>IBCF-hA2: 26. 180 + IBCF-hA2-->>S-CSCF-hA1: 27. 180 + S-CSCF-hA1-->>I-CSCF-hA1: 28. PRACK and 200 OK PRACK + I-CSCF-hA1-->>IBCF-hA1: 29. 200 OK (INVITE) + IBCF-hA1-->>IC-A1: 30. 200 OK (INVITE) + IC-A1-->>IBCF-vA1: 31. 200 OK (INVITE) + IBCF-vA1-->>P-CSCF-vA1: 32. 200 OK (INVITE) + P-CSCF-vA1-->>UE-A: 33. 200 OK (INVITE) + UE-A->>P-CSCF-vA1: 34. ACK + P-CSCF-vA1->>IBCF-vA1: 35. ACK + IBCF-vA1->>IC-A1: 36. ACK + IC-A1-->>IBCF-hA1: 37. ACK + IBCF-hA1->>I-CSCF-hA1: 38. ACK + I-CSCF-hA1->>S-CSCF-hA1: 39. ACK + S-CSCF-hA1->>AS-hA1: 40. ACK + AS-hA1->>IBCF-hA2: 41. ACK + IBCF-hA2-->>S-CSCF-hA1: 42. ACK + S-CSCF-hA1-->>AS-hA1: 43. ACK + AS-hA1-->>IBCF-hA2: 44. ACK + +``` + +Sequence diagram for MOC without loopback showing signaling flow between Visited network vA, IC network A, and Home network hA. + +NOTE: For clarity, the SIP 100 (Trying) messages are not shown in the signalling flow. + +**Figure 5.3.2-1: MOC without loopback** + +The flow is based on the assumptions that the precondition mechanism is used and that the UE-A will indicate in the SDP offer sent within the INVITE request the related local preconditions for QoS as not met. + +The steps of the flow are as follows: + +#### **1. INVITE request (UE-A to P-CSCF-vA1) - see example in table 5.3.2-1.** + +The user A at UE-A initiates a call. The UE-A sends an initial INVITE request to the P-CSCF-vA1 according to 3GPP TS 24.229 [4]. + +**Table 5.3.2-1: INVITE request (UE-A to P-CSCF-vA1)** + +``` + +INVITE tel:+4687197378 SIP/2.0 + +To: +From: ;tag=4fa3 +P-Preferred-Identity: +P-Preferred-Service: urn:urn-7:3gpp-service.ims.icsi.mmtel +Contact: +CSeq: 1 INVITE +Supported: 100rel, precondition, 199 +Route: , +P-Access-Network-Info: 3GPP-E-UTRAN-TDD;utran-cell-id-3gpp=234151D0FCE11 + +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd];branch=z9hG4bKnashds7 + +``` + +--- + + Other SIP header fields and SDP according to 3GPP TS 24.229 [4] + +- P-Preferred-Identity:** The UE-A inserts the P-Preferred-Identity header field with value set to the default public user identity i.e. userA\_public1@home-A.net. +- P-Preferred-Service:** The UE-A inserts the P-Preferred-Service header field with an ICSI value for a 3GPP defined IMS multimedia telephony communication service (MMTEL). +- Supported:** The UE-A inserts the Supported header field containing the option-tag "100rel", the option-tag "precondition" and the option-tag "199" indicating support of the reliable provisional responses, the precondition mechanism and the 199 (Early Dialog Terminated) provisional responses, respectively. +- Route:** The UE-A builds a proper preloaded route set for all new dialogs and standalone transactions containing the IP address or the FQDN learnt through the P-CSCF discovery procedures and the P-CSCF port based on the security mechanism in use. In addition the values received in the Service-Route header field saved from the 200 (OK) response to the last registration or re-registration of the public user identity with associated contact address are added (including traffic leg information in an "iotl" SIP URI parameter according to IETF RFC 7549 [26]). The content of the received Service-Route header field is due to operator policy. In this example only the S-CSCF-hA1 will be included. +- P-Access-Network-Info:** The UE-A provides the access-type and access-info, related to the serving access. +- Via:** The UE-A inserts a Via header field with the respective contact address where the UE-A expects to receive responses to the INVITE request. + +#### 2. INVITE request (P-CSCF-vA1 to IBCF-vA1) - see example in table 5.3.2-2. + +When the P-CSCF-vA1 receives the initial INVITE request and, since the user A is a roaming user, based on local policy and roaming agreement the P-CSCF-vA1 adds the Feature-Caps header field with the "g.3gpp.trf" header field parameter with the address to the TRF. + +The P-CSCF-vA1 selects an IBCF (IBCF-vA1) to be the exit IBCF towards the home IMS network hA of the user A and sends the INVITE request according to 3GPP TS 24.229 [4] to IBCF-vA1. + +The received list of URIs in the Route header field within the INVITE will be verified with the Route header field list constructed from the Service-Route header field received during the last registration procedure. + +**Table 5.3.2-2: INVITE request (P-CSCF-vA1 to IBCF-vA1)** + +``` + +INVITE tel:+4687197378 SIP/2.0 + +To: +From: +P-Asserted-Identity: +P-Preferred-Service: +Contact: +CSeq: +Supported: +Route: , +Record-Route: +Feature-Caps:*;+g.3gpp.trf="" +P-Access-Network-Info: 3GPP-E-UTRAN-TDD;utran-cell-id-3gpp=234151D0FCE11, 3GPP-E-UTRAN-TDD; utran- +cell-id-3gpp=234151D0FCE11;network-provided;local-time-zone="UTC+01:00";daylight-saving-time="01" +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024";orig-ioi="Type 1visited-a" + +Via: SIP/2.0/UDP pcscf-vA1.visited-A.net:5060;branch=z9hG4bKnas56565 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd];branch=z9hG4bKnashds7 + +Other SIP header fields and SDP according to 3GPP TS 24.229 [4]. + +``` + +- P-Asserted-Identity:** The value is set to the default public user identity i.e. userA\_public1@home-A.net. +- P-Charging-Vector:** The P-CSCF-vA1 adds the P-Charging-Vector header field containing a new ICID value in the "icid" header field parameter and an "orig-ioi" header field parameter. The IOI value is of type 1 and identifies the visited network vA (i.e. visited-a). + +- P-Access-Network-Info:** The P-CSCF-vA1 adds a network provided location and daylight saving time information. If the received P-Access-Network-Info header field doesn't indicate that it is a network provided location, the P-Access-Network-Info header field containing the location provided by the UE-A is kept in the INVITE request. +- Route:** The P-CSCF-vA1 verifies that the received route set corresponds to the route set received in the Service-Route header field and adds a Route header field identifying the selected IBCF-vA1. +- Record-Route:** The P-CSCF-vA1 adds a Record-Route header field. +- Via:** The P-CSCF-vA1 adds a Via header field. +- Feature-Caps:** The P-CSCF-vA1 adds a g.3gpp.trf feature-capability indicator in the Feature-Caps header field. The feature-capability indicator contains the address to a TRF-vA1 in the visited network and traffic leg information in an "iotl" SIP URI parameter according to IETF RFC 7549 [26]. This address is needed if the call will result in a loopback to the visited network. + +#### 3. INVITE request (IBCF-vA1 to IC-A1) - see example in table 5.3.2-3. + +When the IBCF-vA1 receives the initial INVITE request containing the "+g.3gpp.trf" header field parameter in a Feature-Caps header field, the IBCF-vA1 updates the SDP as described within 3GPP TS 29.079 [5]. + +The IBCF-vA1 selects, based on local policy, to route the INVITE request via IC network A and sends the INVITE request according to 3GPP TS 24.229 [4] to the IC-A1. The IBCF-vA1 determines the next hop IP address from the URI in the first entry of the Route header field either by configured information or using a DNS query according to IETF RFC 3263 [13]. If the subsequent interconnection network is SIP-aware, the determined IP address will belong to the SIP proxy IC-A1. Otherwise the determined IP address will point to IBCF-hA1 and step 4 is skipped (not reflected in message details below). + +**Table 5.3.2-3: INVITE request (IBCF-vA1 to IC-A1)** + +``` +INVITE tel:+4687197378 SIP/2.0 + +To: +From: +P-Asserted-Identity: +P-Preferred-Service: +Contact: +CSeq: +Supported: +Route: , +Record-Route: , +Feature-Caps: +P-Access-Network-Info: +P-Charging-Vector: + +Via: SIP/2.0/UDP ibcf-vA1.visited-A.net;branch=z9hG4bK351g45.1 +Via: SIP/2.0/UDP pcscf-vA1.visited-A.net:5060;branch=z9hG4bKnas56565 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd];branch=z9hG4bKnashds7 + +Other SIP header fields and SDP according to 3GPP TS 24.229 [4] and 3GPP TS 29.079 [5]. +``` + +- Route:** The IBCF-vA1 adds a Route header field identifying the selected node in the IC network A. +- Record-Route:** Based on topology hiding functionality the IBCF-vA1 will either forward the Record-Route header field with: +- one visible IBCF-vA1 entry and the remaining collected entries as one hidden entry; or + - an IBCF-vA1 entry and whole content of already collected entries as visible entries. +- Via:** Based on topology hiding functionality the IBCF-vA1 will either forward the Via header field with: +- one visible IBCF-vA1 entry and the remaining collected entries as one hidden entry; or + +- an IBCF-vA1 entry and whole content of already collected entries as visible entries. + +#### 4. INVITE request (IC-A1 to IBCF-hA1) - see example in table 5.3.2-4. + +NOTE 1: If the interconnection network is SIP-unaware, step 4 is skipped (not reflected in message details below). + +When the IC-A1 receives the initial INVITE request and since the IC-A1 according to local policy allows itself to be bypassed by media then the IC-A1 updates the SDP as described within 3GPP TS 29.079 [5]. + +The IC-A1 selects an entry point (IBCF-hA1) of the home IMS network hA and sends the INVITE request according to 3GPP TS 24.229 [4] to the IBCF-hA1. + +The IC-A1 may add a Route header field entry pointing to the entry point of home network hA. This is shown in example in table 5.3.2-4. + +**Table 5.3.2-4: INVITE request (IC-A1 to IBCF-hA1)** + +``` +INVITE tel:+4687197378 SIP/2.0 + +To: +From: +P-Asserted-Identity: +P-Preferred-Service: +Contact: +CSeq: +Supported: +Route: , +Record-Route: , , + +Feature-Caps: +P-Access-Network-Info: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024";orig-ioi="Type 1visited-a"; +transit-ioi="ICa.1" + +Via: SIP/2.0/UDP ic-A1.interconnection-A.net;branch=z9hG4bK351g45.2 +Via: SIP/2.0/UDP ibcf-vA1.visited-A.net;branch=z9hG4bK351g45.1 +Via: SIP/2.0/UDP pcscf-vA1.visited-A.net;5060;branch=z9hG4bKnas56565 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd];branch=z9hG4bKnashds7 + +Other SIP header fields and SDP according to 3GPP TS 24.229 [4] and +3GPP TS 29.079 [5]. +``` + +**P-Charging-Vector:** The IC-A1 adds the "transit-ioi" header field parameter identifying the interconnection network (i.e. ICa.1). + +**Route:** The IC-A1 adds a Route header field identifying the selected entry point in the home network hA. + +**Record-Route:** Based on interconnection operator SLA the IC-A1 adds an entry to the Record-Route header field or not. + +**Via:** The IC-A1 adds a Via header field. + +#### 5. INVITE request (IBCF-hA1 to S-CSCF-hA1) - see example in table 5.3.2-5. + +When the IBCF-hA1 receives the initial INVITE request containing the "+g.3gpp.trf" header field parameter in a Feature-Caps header field, the IBCF-hA1 updates the SDP as described in 3GPP TS 29.079 [5]. + +The IBCF-hA1 sends the INVITE request according to 3GPP TS 24.229 [4] to the S-CSCF-hA1. + +In this example, the IBCF-hA1 does not add any "transit-ioi" header field parameter in the P-Charging-Vector header field. However, the IBCF-hA1 adds the "transit-ioi" header field parameter based on local policy, when the "transit-ioi" identifying the preceding interconnection network is not included in the received request (e.g. when the preceding interconnection network is not an IMS transit network). + +**Table 5.3.2-5: INVITE request (IBCF-hA1 to S-CSCF-hA1)** + +``` +INVITE tel:+4687197378 SIP/2.0 + +To: +From: +``` + +``` + +P-Asserted-Identity: +P-Preferred-Service: +Contact: +CSeq: +Supported: +Route: ;iotl=visitedA-homeA> +Record-Route: ,, + , +Feature-Caps: +P-Access-Network-Info: +P-Charging-Vector: + +Via: SIP/2.0/UDP ibcf-hA1.home-A.net;branch=z9hG4bK351g45.3 +Via: SIP/2.0/UDP ic-A1.interconnection-A.net;branch=z9hG4bK351g45.2 +Via: SIP/2.0/UDP ibcf-vA1.visited-A.net;branch=z9hG4bK351g45.1 +Via: SIP/2.0/UDP pcscf-vA1.visited-A.net:5060;branch=z9hG4bKnas56565 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd];branch=z9hG4bKnashds7 + +Other SIP header fields and SDP according to 3GPP TS 24.229 [4] and 3GPP TS 29.079 [5]. + +``` + +**Via:** The IBCF-hA1 adds a Via header field. + +**Record-Route:** The IBCF-hA1 adds a Record-Route header field. + +#### 6. INVITE request (S-CSCF-hA1 to AS-hA1) - see example in table 5.3.2-6. + +The S-CSCF-hA1 applies first filter criteria that is no specific procedures due to roaming. The case where an AS needs the involvement of media function is described in clause 5.10. + +The S-CSCF-hA1 decides according to local policy that loopback routing can be used and include a Feature-Caps header field according to IETF RFC 6809 [21] with the "+g.3gpp.home-visited" header field parameter set to the identifier of the visited network received in the P-Visited-Network-ID header field in the original registration request. + +The S-CSCF-hA1 replaces the received "orig-ioi" header field parameter value in the P-Charging-Vector header field with the type 3 "orig-ioi" header field parameter with a value identifying the home network hA (i.e. "home-a"). + +If a service needs to be invoked according to the user A profile, a Route header field with an URI pointing to the AS-hA1 and the URI pointing back to the S-CSCF-hA1 is added. + +**Table 5.3.2-6: INVITE request (S-CSCF-hA1 to AS-hA1)** + +``` + +INVITE tel:+4687197378 SIP/2.0 + +To: +From: +P-Asserted-Identity: +P-Preferred-Service: urn:urn-7:3gpp-service.ims.icsi.mmtel +Contact: +CSeq: +Supported: +Route: , +Record-Route: ,, + ,, + +Feature-Caps:*;+g.3gpp.home-visited="";+g.3gpp.trf=";iotl=homeA-visitedA>" +P-Access-Network-Info: +P-Charging-Vector: icid-value="AyretyU0dm+602IrT5tAFrbHLso=023551024";orig-ioi="Type 3home-a" +Relayed-Charge: SCSCF:transit-ioi="ICa.1" + +Via: SIP/2.0/UDP scscf-hA1.home-A.net;branch=z9hG4bK351g45.4 +Via: SIP/2.0/UDP ibcf-hA1.home-A.net;branch=z9hG4bK351g45.3 +Via: SIP/2.0/UDP ic-A1.interconnection-A.net;branch=z9hG4bK351g45.2 +Via: SIP/2.0/UDP ibcf-vA1.visited-A.net;branch=z9hG4bK351g45.1 +Via: SIP/2.0/UDP pcscf-vA1.visited-A.net:5060;branch=z9hG4bKnas56565 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd];branch=z9hG4bKnashds7 + +Other SIP header fields and SDP according to 3GPP TS 24.229 [4] and 3GPP TS 29.079 [5]. + +``` + +**Route:** The S-CSCF-hA1 adds Route header field with an URI pointing to the AS-hA1 and the URI pointing back to the S-CSCF-hA1. + +- P-Charging-Vector:** The S-CSCF-hA1 replaces the type 1 IOI values received in the "orig-ioi" header field parameter with a type 3 IOI value identifying the home network hA. +- Relayed-Charge:** The S-CSCF adds the "relayed" header field parameter set to the value of the "transit-ioi" header field parameter received in the INVITE request from the IBCF-Ah1. S-CSCF is set as the source. +- Via:** The S-CSCF-hA1 adds a Via header field. +- Record-Route:** The S-CSCF-hA1 adds a Record-Route header field. +- Feature-Caps:** Since loopback is possible the S-CSCF-hA1 adds the g.3gpp.home-visited feature capability indicator in the Feature-Caps header field. + +#### 7. INVITE request (AS-hA1 to S-CSCF-hA1) - see example in table 5.3.2-7. + +AS-hA1 applies the service and removes the first Route header field entry. + +The AS-hA1 shall remove the "orig-ioi" header field parameter from the forwarded request and insert a type 3 "orig-ioi" header field parameter. The AS-hA1 shall set the type 3 "orig-ioi" header field parameter to the IOI value that identifies the service provider from which the request is sent. In this example the IOI value is the same as the home network operator identity. + +The specifics of the service provided by the AS-hA1 require access to the media and the AS-hA1 removes the "+g.3gpp.home-visited" Feature-Caps header field parameter. The absence of the "+g.3gpp.home-visited" Feature-Caps header field parameter is an indication to S-CSCF-hA1 that a loopback routing is not a viable option. + +NOTE 2: The AS can either keep the OMR attributes in SDP or remove them depending on if the AS supports OMR and local policy. In this example it is assumed that the AS removes the OMR attributes. + +All other SIP headers are set due to procedures described within 3GPP TS 24.229 [4]. + +**Table 5.3.2-7: INVITE request (AS-hA1 to S-CSCF-hA1)** + +``` + +INVITE tel:+4687197378 SIP/2.0 + +To: +From: +P-Asserted-Identity: +P-Asserted-Service: +Contact: +CSeq: +Supported: +Route: +Record-Route: , , + , , + , +Feature-Caps:*;+g.3gpp.trf="" +P-Access-Network-Info: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024";orig-ioi="Type 3home-a" +Relayed-Charge: + +Via: SIP/2.0/UDP as-hA1.home-A.net;branch=z9hG4bK351g45.5 +Via: SIP/2.0/UDP scscf-hA1.home-A.net;branch=z9hG4bK351g45.4 +Via: SIP/2.0/UDP ibcf-hA1.home-A.net;branch=z9hG4bK351g45.3 +Via: SIP/2.0/UDP ic-A1.interconnection-A.net;branch=z9hG4bK351g45.2 +Via: SIP/2.0/UDP ibcf-vA1.visited-A.net;branch=z9hG4bK351g45.1 +Via: SIP/2.0/UDP pcscf-vA1.visited-A.net:5060;branch=z9hG4bKnas56565 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd];branch=z9hG4bKnashds7 + +Other SIP header fields and SDP according to 3GPP TS 24.229 [4] and 3GPP TS 29.079 [5]. + +``` + +- P-Charging-Vector:** The AS-hA1 replaces the "orig-ioi" header field parameter. The AS-hA1 sets the type 3 "orig-ioi" header field parameter to a value that identifies the sending network (in the example the AS-hA1 belongs to the same network as the S-CSCF-hA1 and thus the value is the same as the IOI value received from S-CSCF-hA1, i.e. "home-a"). The AS has to set itself a type 3 IOI if the AS is located within another domain (i.e. a 3rd party service provider). If more than one AS is within the path the "orig-ioi" header field parameter values could be changed based on the relation between S-CSCF-hA1 and the related AS. + +**Record-Route:** The entries to this header field need to be added based on the related dip's to the AS. The AS could behave as B2BUA. In such case the AS could store the entries and setup a new Record-Route header field only with the AS URI as an entry. + +**Via:** The AS-hA1 adds a Via header field. + +#### 8. INVITE request (S-CSCF-hA1 to IBCF-hA2) - see example in table 5.3.2-8. + +When the S-CSCF-hA1 receives the initial INVITE request back from the AS-hA1 and if no further services apply then the S-CSCF-hA1 decides according to local policy if loopback routeing shall be used or not. In this use case loopback will not apply. The S-CSCF-hA1 removes the Feature-Caps header field "+;+g.3gpp.trf" from the INVITE request. + +If the domain of the called user is not the same home domain as from the calling user then the S-CSCF-hA1 has to identify the home network of the called user via ENUM/DNS as provided by local policy of the operator. + +If the ENUM/DNS request fails the call will be forwarded to the BGCF or if number portability applies and an rn parameter must be set up the call will be also forwarded to the BGCF. In the case the FQDN needs to be addressed to MGCF the INVITE request will be forwarded to the BGCF. In this use case the INVITE request is sent directly to IBCF-hA2. + +The S-CSCF-hA1 replaces the received "orig-ioi" header field parameter value in the P-Charging-Vector header field with the type 2 "orig-ioi" header field parameter value identifying the home network hA (i.e. "home-a"). + +The Relayed-Charge header field is deleted. + +**Table 5.3.2-8: INVITE request (S-CSCF-hA1 to IBCF-hA2)** + +``` +INVITE sip:+4687197378@home-R.net;user=phone;iot1=homeA-homeB SIP/2.0 + +To: +From: +P-Asserted-Identity: +P-Asserted-Service: +Contact: +CSeq: +Supported: +Route: +Record-Route: , , + , , + , , + +P-Access-Network-Info: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024";orig-ioi="home-a" + +Via: SIP/2.0/UDP scscf-hA1.home-A.net;branch=z9hG4bK351g45.6 +Via: SIP/2.0/UDP as-hA1.home-A.net;branch=z9hG4bK351g45.5 +Via: SIP/2.0/UDP scscf-hA1.home-A.net;branch=z9hG4bK351g45.4 +Via: SIP/2.0/UDP ibcf-hA1.home-A.net;branch=z9hG4bK351g45.3 +Via: SIP/2.0/UDP ic-A1.interconnection-A.net;branch=z9hG4bK351g45.2 +Via: SIP/2.0/UDP ibcf-vA1.visited-A.net;branch=z9hG4bK351g45.1 +Via: SIP/2.0/UDP pcscf-vA1.visited-A.net:5060;branch=z9hG4bKnas56565 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd];branch=z9hG4bKnashds7 + +Other SIP header fields and SDP according to 3GPP TS 24.229 [4]. +``` + +**Request-URI:** The S-CSCF converts the received tel URI to a SIP URI (e.g. by means of ENUM) and appends traffic leg information in an "iot1" SIP URI parameter according to IETF RFC 7549 [26]. + +**Route:** The S-CSCF-hA1 adds a Route header with the address of the selected IBCF-hA2. + +**Via:** The S-CSCF-hA1 adds a Via header field. + +**Record-Route:** The S-CSCF-hA1 adds a Record-Route header field. + +**P-Charging-Vector:** The S-CSCF-hA1 replaces the received type 3 IOI received from the AS-hA1 with a type 2 IOI value (i.e. home-a). + +#### 9-16. 183 (Session Progress) response (IBCF-hA2 to UE-A via S-CSCF-hA1, AS-hA1, S-CSCF-hA1, IBCF-hA1, IC-A1, IBCF-vA1 and P-CSCF-vA1) - see example in table 5.3.2-9. + +When the IBCF-hA2 receives the 183 (Session Progress) response the IBCF-hA2 sends the 183 (Session Progress) response according to 3GPP TS 24.229 [4] towards the UE-A via the S-CSCF-hA1, AS-hA1, IBCF-hA1, IC-A1, IBCF-vA1, P-CSCF-vA1 path as described within 3GPP TS 24.229 [4]. + +The table 5.3.2-9 shows the content of the 183 (Session Progress) response when sent by IBCF-hA2. + +**Table 5.3.2-9: SIP 183 (Session Progress) response (IBCF-hA2 to UE-A) in step 9** + +``` +SIP/2.0 183 Session Progress + +To: ;tag=654a +From: ;tag=4fa3 +P-Asserted-Identity: , +Contact: +CSeq: 1 INVITE +Require: 100rel, precondition + +Via: SIP/2.0/UDP scscf-hA1.home-A.net;branch=z9hG4bK351g45.6 +Via: SIP/2.0/UDP as-hA1.home-A.net;branch=z9hG4bK351g45.5 +Via: SIP/2.0/UDP scscf-hA1.home-A.net;branch=z9hG4bK351g45.4 +Via: SIP/2.0/UDP ibcf-hA1.home-A.net;branch=z9hG4bK351g45.3 +Via: SIP/2.0/UDP ic-A1.interconnection-A.net;branch=z9hG4bK351g45.2 +Via: SIP/2.0/UDP ibcf-vA1.visited-A.net;branch=z9hG4bK351g45.1 +Via: SIP/2.0/UDP pcscf-vA1.visited-A.net:5060;branch=z9hG4bKnas56565 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd];branch=z9hG4bKnashds7 + +Record-Route: , + , , + , , + , , + , +P-Charging-Vector: icid-value="AyretyU0dm+602IrT5tAFrbHLso=023551024"; orig-ioi="home-a"; transit- +ioi="ICt.1"; term-ioi="home-r" + +Other SIP header fields and SDP according to 3GPP TS 24.229 [4]. +``` + +**Require:** The Require header field contains the option-tag "100rel" indicating reliable sending of the 183 (Session Progress) response and the option-tag "precondition" indicating the usage of the precondition mechanism. + +**P-Charging-Vector:** The settings of the IOI values are important: + +- in step 9 the "term-ioi" header field parameter includes a type 2 IOI value which identifies the home network of the remote user (i.e. "home-r"). The "transit-ioi" header field parameter including one or more values identifying the transit networks passed. The "orig-ioi" header field parameter is set to the same type 2 IOI value that was included in the initial INVITE request by the home network hA (i.e. "home-a") towards the terminating user; +- in step 10 the "term-ioi" header field parameter includes a type 3 IOI value (prefix "Type 3") which identifies the S-CSCF-hA1 network. The "orig-ioi" header field parameter is set to the same type 3 IOI value that was included in the initial INVITE request from the AS-hA1 to the S-CSCF-hA1; +- in step 11 the "term-ioi" header field parameter includes a type 3 IOI value (prefix "Type 3") which identifies the AS-hA1 network. The "orig-ioi" header field parameter is set to the same type 3 IOI value that was included in the initial INVITE request from the S-CSCF-hA1 to the AS-hA1; +- in steps 12-15 the "term-ioi" header field parameter includes a type 1 IOI value (prefix "Type 1") which identifies the home network hA. The "orig-ioi" header field parameter is set to the same type 1 IOI value that was included in the initial INVITE request from the visited network vA towards the home network hA; and +- in steps 14-15 the "transit-ioi" header field parameter includes one or more values identifying the transit networks passed. + +NOTE 3: If the interconnection network is SIP-unaware, step 14 is skipped. + +- 17. PRACK requests (UE-A to IBCF-hA2 via P-CSCF-vA1, IBCF-vA1, IC-A1, IBCF-hA1, S-CSCF-hA1, AS-hA1 and S-CSCF-hA1) and SIP 200 (OK) response to the SIP PRACK request (IBCF-hA2 to UE-A via S-CSCF-hA1, AS-hA1, S-CSCF-hA1, IBCF-vA1, IC-A1, IBCF-hA1 and P-CSCF-vA1).** + +The PRACK request and the 200 (OK) response to the PRACK request are sent without any SDP offer/SDP answer between the UE-A and the IBCF-hA2 according to 3GPP TS 24.229 [4]. + +#### **18. Resource reservation.** + +- 19. UPDATE requests (UE-A to IBCF-hA2 via P-CSCF-vA1, IBCF-vA1, IC-A1, IBCF-hA1, S-CSCF-hA1, AS-hA1 and S-CSCF-hA1) and SIP 200 (OK) response to the SIP UPDATE request (IBCF-hA2 to UE-A via S-CSCF-hA1, AS-hA1, S-CSCF-hA1, IBCF-hA1, IC-A1, IBCF-vA1 and P-CSCF-vA1).** + +After a local resource reservation the UE-A sends the UPDATE request with the SDP offer containing an indication that the local preconditions for QoS are fulfilled according to 3GPP TS 24.229 [4]. + +- 20-27. 180 (Ringing) response to the SIP INVITE request (IBCF-hA2 to UE-A via S-CSCF-hA1, AS-hA1, S-CSCF-hA1, IBCF-hA1, IC-A1, IBCF-vA1 and P-CSCF-vA1).** + +NOTE 4: If the interconnection network is SIP-unaware, step 25 is skipped. + +- 28. PRACK requests (UE-A to IBCF-hA2 via P-CSCF-vA1, IBCF-vA1, IC-A1, IBCF-hA1, S-CSCF-hA1, AS-hA1 and S-CSCF-hA1) and SIP 200 (OK) response to the SIP PRACK request (IBCF-hA2 to UE-A via S-CSCF-hA1, AS-hA1, S-CSCF-hA1, IBCF-hA1, IC-A1, IBCF-vA1 and P-CSCF-vA1).** + +The PRACK request and the 200 (OK) response to the PRACK request are sent without any SDP offer/SDP answer between the UE-A and the IBCF-hA2 according to 3GPP TS 24.229 [4]. + +- 29-36. 200 (OK) response to the SIP INVITE request (IBCF-hA2 to UE-A via S-CSCF-hA1, AS-hA1, S-CSCF-hA1, IBCF-hA1, IC-A1, IBCF-vA1 and P-CSCF-vA1).** + +NOTE 5: If the interconnection network is SIP-unaware, step 34 is skipped. + +- 37-44. ACK requests (UE-A to IBCF-hA2 via P-CSCF-vA1, IBCF-vA1, IC-A1, IBCF-hA1, S-CSCF-hA1, AS-hA1 and S-CSCF-hA1).** + +The UE-A sends the ACK request, which acknowledges the 200 (OK) final response, to the IBCF-hA2 according to 3GPP TS 24.229 [4]. + +NOTE 6: If the interconnection network is SIP-unaware, step 40 is skipped. + +## **5.4 Originating roaming with loopback** + +### **5.4.1 General** + +This use case shows the loopback procedure that includes routeing from originating visited network to originating home network and loopback routeing from originating home network to originating visited network including the traversal of transit network between the visited and the originating home network. + +Signalling is prepared to skip the loopback and route directly to the terminating home network on demand of the originating home network, see the use case provided by clause 5.3. + +### **5.4.2 Call flow** + +In this scenario the originating home network decides to use loopback routeing and OMR is used. + +Preconditions: + +- the user A is registered to the home network hA via the visited operator vA network and the IC network A as described in clause 5.2. The IC network does not store any registration information; +- the called user is located in another network either in PSTN or in IMS; +- P-CSCF-vA1 and S-CSCF-hA1 support loopback routeing; + +- IBCF-vA1, IBCF-hA1 and IC-A1 supports OMR and all networks supports loopback routeing; and +- no B2BUA manipulating SDP is connected in the home operator hA network. + +SDP behaviour for loopback including OMR is described within 3GPP TS 29.079 [5]. + +![Sequence diagram showing SIP signaling for MOC with loopback across four network domains: Visited network vA, IC network A, Home network hA, and IC network T. The diagram shows the flow of INVITE, 183, PRACK, and UPDATE messages between UE-A and various network elements like P-CSCF, TRF, IBCF, IC, I-CSCF, S-CSCF, AS, and IC-T1.](df1966d80c74bc127f159a48f38b13ee_img.jpg) + +The diagram illustrates the SIP signaling flow for a Mobile Originated (MOC) call with loopback across four network domains: Visited network vA (Realm=visited-A1), IC network A (Realm=x), Home network hA (Realm=home-A1), and IC network T. The entities involved are UE-A, P-CSCF-vA1, TRF-vA1, IBCF-vA1, IC-A1 (dashed), IBCF-hA1, I-CSCF-hA1, S-CSCF-hA1, AS-hA1, and IC-T1 (dashed). The sequence of messages is as follows: + + +- UE-A sends an INVITE to P-CSCF-vA1. +- P-CSCF-vA1 sends an INVITE to TRF-vA1. +- TRF-vA1 sends an INVITE to IBCF-vA1. +- IBCF-vA1 sends an INVITE to IC-A1 (dashed). +- IC-A1 (dashed) sends an INVITE to IBCF-hA1. +- IBCF-hA1 sends an INVITE to I-CSCF-hA1. +- I-CSCF-hA1 sends an INVITE to S-CSCF-hA1. +- S-CSCF-hA1 sends an INVITE to AS-hA1. +- AS-hA1 sends an INVITE to IC-T1 (dashed). +- IC-T1 (dashed) sends an INVITE back to IBCF-hA1. +- IBCF-hA1 sends an INVITE back to IC-A1 (dashed). +- IC-A1 (dashed) sends an INVITE back to IBCF-vA1. +- IBCF-vA1 sends an INVITE back to TRF-vA1. +- TRF-vA1 sends an INVITE back to P-CSCF-vA1. +- P-CSCF-vA1 sends an INVITE back to UE-A. +- UE-A sends a 183 response to P-CSCF-vA1. +- P-CSCF-vA1 sends a 183 response to TRF-vA1. +- TRF-vA1 sends a 183 response to IBCF-vA1. +- IBCF-vA1 sends a 183 response to IC-A1 (dashed). +- IC-A1 (dashed) sends a 183 response to IBCF-hA1. +- IBCF-hA1 sends a 183 response to I-CSCF-hA1. +- I-CSCF-hA1 sends a 183 response to S-CSCF-hA1. +- S-CSCF-hA1 sends a 183 response to AS-hA1. +- AS-hA1 sends a 183 response to IC-T1 (dashed). +- IC-T1 (dashed) sends a 183 response back to IBCF-hA1. +- IBCF-hA1 sends a 183 response back to IC-A1 (dashed). +- IC-A1 (dashed) sends a 183 response back to IBCF-vA1. +- IBCF-vA1 sends a 183 response back to TRF-vA1. +- TRF-vA1 sends a 183 response back to P-CSCF-vA1. +- P-CSCF-vA1 sends a 183 response back to UE-A. +- UE-A sends a PRACK and 200 OK PRACK without an SDP offer to P-CSCF-vA1. +- P-CSCF-vA1 sends a Resource reservation message to TRF-vA1. +- TRF-vA1 sends an UPDATE and 200 OK to UPDATE with the same SDP offer as in the INVITE but preconditions for UE-A are now fulfilled, preconditions for remote UE are still not fulfilled. +- TRF-vA1 sends an UPDATE and 200 OK to UPDATE with the SDP offer as in the INVITE but preconditions for remote UE are now fulfilled. + +Sequence diagram showing SIP signaling for MOC with loopback across four network domains: Visited network vA, IC network A, Home network hA, and IC network T. The diagram shows the flow of INVITE, 183, PRACK, and UPDATE messages between UE-A and various network elements like P-CSCF, TRF, IBCF, IC, I-CSCF, S-CSCF, AS, and IC-T1. + +NOTE: For clarity, the SIP 100 (Trying) messages are not shown in the signalling flow. + +**Figure 5.4.2-1: MOC with loopback** + +The flow is based on the assumptions that the precondition mechanism is used and that the UE-A will indicate in the SDP offer sent within the INVITE request the related local preconditions for QoS as not met. + +The steps of the flow are as follows: + +#### **1. INVITE request (UE-A to P-CSCF-vA1) - see example in table 5.4.2-1.** + +The user A at UE-A initiates a call. The UE-A sends an initial INVITE request to the P-CSCF-vA1 according to 3GPP TS 24.229 [4]. + +**Table 5.4.2-1: INVITE request (UE-A to P-CSCF-vA1)** + +``` + +INVITE tel:+4687197378 SIP/2.0 + +To: +From: ;tag=4fa3 +P-Preferred-Identity: +P-Preferred-Service: urn:urn-7:3gpp-service.ims.icsi.mmtel +Contact: +CSeq: 1 INVITE +Supported: 100rel, precondition, 199 +Route: , + +``` + +``` + +P-Access-Network-Info: 3GPP-E-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11 + +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd];branch=z9hG4bKnashds7 + +Content-Type:application/sdp +Content-Length: (...) + +c=IN IP6 [5555::aaa:bbb:ccc:ddd] +m=audio 16000 RTP/AVP 97 98 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv + +``` + +Other SIP header fields and SDP according to 3GPP TS 24.229 [4]. + +**P-Preferred-Identity:** The UE-A inserts the P-Preferred-Identity header field with value set to the default public user identity i.e. userA\_public1@home-A.net. + +**P-Preferred-Service:** The UE-A inserts the P-Preferred-Service header field with an ICSI value for a 3GPP defined IMS multimedia telephony communication service (MMTEL). + +**Supported:** The UE-A inserts the Supported header field containing the option-tag "100rel", the option-tag "precondition" and the option-tag "199" indicating support of the reliable provisional responses, the precondition mechanism and the 199 (Early Dialog Terminated) provisional responses, respectively. + +**Route:** The UE-A builds a proper preloaded route set for all new dialogs and standalone transactions containing the IP address or the FQDN learnt through the P-CSCF discovery procedures and the P-CSCF port based on the security mechanism in use. In addition the values received in the Service-Route header field saved from the 200 (OK) response to the last registration or re-registration of the public user identity with associated contact address are added (including traffic leg information in an "iotl" SIP URI parameter according to IETF RFC 549 [26]). The content of the received Service-Route header field is due to operator policy. In this example only the S-CSCF-hA1 will be included. + +**P-Access-Network-Info:** The UE-A provides the access-type and access-info, related to the serving access. + +**Via:** The UE-A inserts a Via header field with the respective contact address where the UE-A expects to receive responses to the INVITE request. + +**SDP:** The UE-A add necessary information in an SDP offer. For readability reasons only the parts of the SDP that will change due to the use of OMR is shown. The rest is as described in 3GPP TS 24.229 [4]. + +#### 2. INVITE request (P-CSCF-vA1 to IBCF-vA1) - see example in table 5.4.2-2. + +When the P-CSCF-vA1 receives the initial INVITE request, the P-CSCF-vA1: + +- adds the Feature-Caps header field with the "g.3gpp.trf" header field parameter with the address to the TRF; and +- verifies that the resulting list of Route header fields matches the list of URIs received in the Service-Route header field (during the last successful registration or re-registration). This verification is done on a per URI basis, not as a whole string. + +The P-CSCF-vA1 selects an IBCF (IBCF-vA1) to be the exit IBCF towards the home IMS network hA and sends the INVITE request according to 3GPP TS 24.229 [4] to IBCF-vA1. + +NOTE 1: It is implementation dependent as to how the P-CSCF obtains the address of the IBCF exit point. + +**Table 5.4.2-2: INVITE request (P-CSCF-vA1 to IBCF-vA1)** + +``` + +INVITE tel:+4687197378 SIP/2.0 + +To: +From: +P-Asserted-Identity: + +``` + +``` + +P-Preferred-Service: +Contact: +CSeq: +Supported: +Route: , +Record-Route: +Feature-Caps:*;+g.3gpp.trf="" +P-Access-Network-Info: 3GPP-E-UTRAN-TDD;utran-cell-id-3gpp=234151D0FCE11, + 3GPP-E-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11; + network-provided;local-time-zone="UTC+01:00";daylight-saving-time="01" +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024";orig-ioi="Type 1visited-a" + +Via: SIP/2.0/UDP pcscf-vA1.visited-A.net:5060;branch=z9hG4bKnas56565 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd];branch=z9hG4bKnashds7 + +Content-Type: +Content-Length: (...) + +c= +m= +a= +a= +a= +a= + +Other SIP header fields and SDP according to 3GPP TS 24.229 [4]. + +``` + +- P-Asserted-Identity:** The value is set to the default public user identity i.e. userA\_public1@home-A.net. +- P-Charging-Vector:** The P-CSCF-vA1 adds the P-Charging-Vector header field containing a new ICID value in the "icid" header field parameter and an "orig-ioi" header field parameter. The IOI value is of type 1 and identifies the visited network vA (i.e. visited-a). +- P-Access-Network-Info:** The P-CSCF-vA1 adds a network provided location and daylight saving information. If the received P-Access-Network-Info header field doesn't indicate that it is a network provided location, the P-Access-Network-Info header field containing the location provided by the UE-A is kept in the INVITE request. +- Route:** The P-CSCF-vA1 verifies that the received route set corresponds to the route set received in the Service-Route header field and adds a Route header field identifying the selected IBCF-vA1. +- Record-Route:** The P-CSCF-vA1 adds a Record-Route header field. +- Via:** The P-CSCF-vA1 adds a Via header field. +- Feature-Caps:** The P-CSCF-vA1 adds a g.3gpp.trf feature-capability indicator in the Feature-Caps header field. The feature-capability indicator contains the address to a TRF in the visited network and traffic leg information in an "iotl" SIP URI parameter according to IETF RFC 7549 [26]. This address is needed if the call will result in a loopback to the visited network. + +#### 3. INVITE request (IBCF-vA1 to IC-A1) - see example in table 5.4.2-3. + +When the IBCF-vA1 receives the initial INVITE request containing the "+g.3gpp.trf" header field parameter in a Feature-Caps header field, the IBCF-vA1 updates the SDP as described within 3GPP TS 29.079 [5]. + +The IBCF-vA1 selects to route the INVITE request via an IC network A and sends the INVITE request according to 3GPP TS 24.229 [4] to the IC-A1. The IBCF-vA1 determines the next hop IP address from the URI in the first entry of the Route header field either by configured information or using a DNS query according to IETF RFC 3263 [13]. If the subsequent interconnection network is SIP-aware, the determined IP address will belong to the SIP proxy IC-A1. Otherwise the determined IP address will point to IBCF-hA1 and step 4 is skipped (not reflected in message details below). + +NOTE 2: If the IBCF processes a request without a pre-defined route (e.g. the subscription to "reg" event package originated by the P-CSCF), the next-hop address can be either obtained as specified in IETF RFC 3263 [13] or be provisioned in the IBCF. + +**Table 5.4.2-3: INVITE request (IBCF-vA1 to IC-A1)** + +``` + +INVITE tel:+4687197378 SIP/2.0 + +To: +From: +P-Asserted-Identity: +P-Preferred-Service: +Contact: +CSeq: +Supported: +Route: , +Record-Route: , +Feature-Caps: +P-Access-Network-Info: +P-Charging-Vector: + +Via: SIP/2.0/UDP ibcf-vA1.visited-A.net;branch=z9hG4bK351g45.1 +Via: SIP/2.0/UDP pcscf-vA1.visited-A.net:5060;branch=z9hG4bKnas56565 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd];branch=z9hG4bKnashds7 + +Content-Type: +Content-Length: (...) + +c=IN IP6 [5555::aaa:bbb:ccc:ddd] +m=audio 16002 RTP/AVP 97 98 +a= +a= +a= +a= +a=visited-realm:1 visited-A1.net IN IP6 [5555::aaa:bbb:ccc:ddd] 16000 +a=visited-realm:2 x.net IN IP6 [5555::aaa:bbb:ccc:ddd] 16002 + +Other SIP header fields and SDP according to 3GPP TS 24.229 [4] and 3GPP TS 29.079 [5]. + +``` + +**Route:** The IBCF-vA1 adds a Route header field identifying the selected node in the IC network A. + +**Record-Route:** Based on topology hiding functionality the IBCF-vA1 will either forward the Record-Route header field with: + +- one visible IBCF-vA1 entry and the P-CSCF-vA1 entry as one hidden entry; or +- an IBCF-vA1 entry and the P-CSCF-vA1 entry as visible entries. + +**Via:** Based on topology hiding functionality the IBCF-vA1 will either forward the Via header field with: + +- one visible IBCF-vA1 Via header field and the P-CSCF-vA1 Via header field as a hidden Via header field; or +- an IBCF-vA1 Via header field and the P-CSCF-vA1 Via header field as visible entries. + +**SDP:** As the first OMR capable node, the IBCF-vA1 add the "a=visited-realm:1 visited-A1.net IN IP6 [5555::aaa:bbb:ccc:ddd] 16000" representing the realm instance of the UE-A. A second realm instance "a=visited-realm:2 x.net IN IP6 [5555::aaa:bbb:ccc:ddd] 16002" is added representing the external realm of the IBCF-vA1. The c-line and the m-line are updated to reflect the resources reserved in the TrGW of IBCF-vA1. + +#### 4. INVITE request (IC-A1 to IBCF-hA1) - see example in table 5.4.2-4. + +NOTE 3: If the interconnection network is SIP-unaware, step 4 is skipped (not reflected in message details below). + +When the IC-A1 receives the initial INVITE request and since the IC-A1 according to local policy allows itself to be bypassed by media then the IC-A1 updates the SDP as described within 3GPP TS 29.079 [5]. + +The IC-A1 selects an entry IBCF-hA1 of the home IMS network hA and sends the INVITE request according to 3GPP TS 24.229 [4] to the IBCF-hA1. + +The IC-A1 may add a Route header field entry pointing to the entry point of home network hA. This is shown in example in table 5.4.2-4. + +**Table 5.4.2-4: INVITE request (IC-A1 to IBCF-hA1)** + +``` + +INVITE tel:+4687197378 SIP/2.0 + +To: +From: +P-Asserted-Identity: +P-Preferred-Service: +Contact: +CSeq: +Supported: +Route: , +Record-Route: , , + +Feature-Caps: +P-Access-Network-Info: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024";orig-ioi="Type 1visited- +a";transit-ioi="ICa.1" + +Via: SIP/2.0/UDP ic-A1.interconnection-A.net;branch=z9hG4bK351g45.2 +Via: SIP/2.0/UDP ibcf-vA1.visited-A.net;branch=z9hG4bK351g45.1 +Via: SIP/2.0/UDP pcscf-vA1.visited-A.net:5060;branch=z9hG4bKnas56565 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd];branch=z9hG4bKnashds7 + +Content-Type: +Content-Length: (...) + +c=IN IP6 [5555::aaa:bbb:ccc:dd2] +m=audio 16004 RTP/AVP 97 98 +a= +a= +a= +a= +a=visited-realm:1 visited-A1.net IN IP6 [5555::aaa:bbb:ccc:ddd] 16000 +a=visited-realm:2 x.net IN IP6 [5555::aaa:bbb:ccc:dd1] 16002 +a=visited-realm:3 x.net IN IP6 [5555::aaa:bbb:ccc:dd2] 16004 + +Other SIP header fields and SDP according to 3GPP TS 24.229 [4] and 3GPP TS 29.079 [5]. + +``` + +**P-Charging-Vector:** The IC-A1 adds the "transit-ioi" header field parameter identifying the interconnection network (i.e. ICa.1). + +**Route:** The IC-A1 adds a Route header field identifying the selected entry point in the home network hA. + +**Record-Route:** Based on interconnection operator SLA the IC-A1 adds an entry to the Record-Route header field or not. + +**Via:** The IC-A1 adds a Via header field. + +**SDP:** A third realm instance "a=visited-realm:3 x.net IN IP6 [5555::aaa:bbb:ccc:dd2] 16004" is added representing the realm of the IC-A1. The c-line and the m-line are updated to reflect the resources reserved in the IC-A1. + +#### 5. INVITE request (IBCF-hA1 to S-CSCF-hA1) - see example in table 5.4.2-5. + +When the IBCF-hA1 receives the initial INVITE request containing the "+g.3gpp.trf" header field parameter in a Feature-Caps header field, the IBCF-hA1 updates the SDP as described within 3GPP TS 29.079 [5]. + +In this example, the IBCF-hA1 does not add any "transit-ioi" header field parameter in the P-Charging-Vector header field. However, the IBCF-hA1 adds the "transit-ioi" header field parameter based on local policy, when the "transit-ioi" identifying the preceding interconnection network is not included in the received request (e.g. when the preceding interconnection network is not an IMS transit network). + +The IBCF-hA1 sends the INVITE request according to 3GPP TS 24.229 [4] to the S-CSCF-hA1. + +**Table 5.4.2-5: INVITE request (IBCF-hA1 to S-CSCF-hA1)** + +``` + +INVITE tel:+4687197378 SIP/2.0 + +To: +From: +P-Asserted-Identity: + +``` + +``` + +P-Preferred-Service: +Contact: +CSeq: +Supported: +Route: , +Record-Route: ,, +, +Feature-Caps: +P-Access-Network-Info: +P-Charging-Vector: + +Via: SIP/2.0/UDP ibcf-hA1.home-A.net;branch=z9hG4bK351g45.3 +Via: SIP/2.0/UDP ic-A1.interconnection-A.net;branch=z9hG4bK351g45.2 +Via: SIP/2.0/UDP ibcf-vA1.visited-A.net;branch=z9hG4bK351g45.1 +Via: SIP/2.0/UDP pcscf-vA1.visited-A.net:5060;branch=z9hG4bKnas56565 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd];branch=z9hG4bKnashds7 + +Content-Type: +Content-Length: (...) + +c=IN IP6 [5555::aaa:bbb:ccc:dd3] +m=audio 16006 RTP/AVP 97 98 +a= +a= +a= +a= +a=visited-realm:1 visited-A.net IN IP6 [5555::aaa:bbb:ccc:ddd] 16000 +a=visited-realm:2 x.net IN IP6 [5555::aaa:bbb:ccc:dd1] 16002 +a=visited-realm:4 home-A.net IN IP6 [5555::aaa:bbb:ccc:dd3] 16006 + +Other SIP header fields and SDP according to 3GPP TS 24.229 [4] and 3GPP TS 29.079 [5]. + +``` + +**Via:** The IBCF-hA1 adds a Via header field. + +**Record-Route:** The IBCF-hA1 adds a Record-Route header field. + +**SDP:** IBCF-hA1 detects, by inspecting the received set of OMR visited-realm attributes, that the resources in IC-A1 can be bypassed. Since the realm of the outgoing side is different than the realm of the incoming side, the IBCF-hA1 adds the realm instance 4 representing the internal realm of the IBCF-hA1 and updates the c-line and the m-line to reflect the resources reserved in the TrGW of the IBCF-hA1. + +#### 6. INVITE request (S-CSCF-hA1 to AS-hA1) - see example in table 5.3.2-6. + +The S-CSCF-hA1 applies the same procedure as in step 6 in clause 5.3.2. The OMR specific attributes are kept in the SDP as received from the IBCF-hA1. + +#### 7. INVITE request (AS-hA1 to S-CSCF-hA1) - see example in table 5.4.2-7. + +AS-hA1 applies the service of the originating user and removes the first Route header field entry. + +The AS-hA1 removes the "orig-ioi" header field parameter from the INVITE request and inserts a type 3 "orig-ioi" header field parameter set to a value that identifies the service provider from which the request is sent. In this case the IOI value is the same as the home network operator identity. + +The specifics of the service does not require access to a media and the "+g.3gpp.home-visited" Feature-Caps header field parameter is kept in the INVITE request. This is an indication to the S-CSCF-hA1 that a loopback is a viable option. + +All other SIP headers are set due to procedures described within 3GPP TS 24.229 [4]. + +*Editor's note: The behaviour of the transit-ioi value is currently discussed and needs further consideration how the S-CSCF to AS correlation is described.* + +**Table 5.4.2-7: INVITE request (AS-hA1 to S-CSCF-hA1)** + +``` + +INVITE tel:+4687197378 SIP/2.0 + +To: +From: +P-Asserted-Identity: +P-Asserted-Service: + +``` + +``` + +Contact: +CSeq: +Supported: +Route: +Record-Route: , , + , , + , +Feature-Caps: *;+g.3gpp.home-visited="";+g.3gpp.trf="" +P-Access-Network-Info: +P-Charging-Vector: icid-value="AyretyU0dm+602IrT5tAFrbHLso=023551024";orig-ioi="Type 3home-a" + +Via: SIP/2.0/UDP as-hA1.home-A.net;branch=z9hG4bK351g45.5 +Via: SIP/2.0/UDP scscf-hA1.home-A.net;branch=z9hG4bK351g45.4 +Via: SIP/2.0/UDP ibcf-hA1.home-A.net;branch=z9hG4bK351g45.3 +Via: SIP/2.0/UDP ic-A1.interconnection-A.net;branch=z9hG4bK351g45.2 +Via: SIP/2.0/UDP ibcf-vA1.visited-A.net;branch=z9hG4bK351g45.1 +Via: SIP/2.0/UDP pcscf-vA1.visited-A.net:5060;branch=z9hG4bKnas56565 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd];branch=z9hG4bKnashds7 + +Content-Type: +Content-Length: (...) + +c= +m= +a= +a= +a= +a= +a= +a= +a= + +``` + +Other SIP header fields and SDP according to 3GPP TS 24.229 [4] and 3GPP TS 29.079 [5]. + +**P-Charging-Vector:** The AS-hA1 replaces the "orig-ioi" header field parameter. The AS-hA1 sets the type 3 "orig-ioi" header field parameter to a value that identifies the sending network. In the example the AS-hA1 belongs to the same network as the S-CSCF-hA1 and thus the value is the same as the IOI value received from S-CSCF-hA1, i.e. "home-a". If the AS is provided by a 3rd Party Service Provider, the value will be different than the value received from S-CSCF-hA1. If more than one AS is within the path the "orig-ioi" header field parameter values could be changed based on the relation between S-CSCF-hA1 and the related AS. + +**Record-Route:** The entries to this header field need to be added based on the related dip's to the AS. The AS could behave as B2BUA. In such case the AS could store the entries and setup a new Record-Route header field with the AS as the only entry. + +**Via:** The AS-hA1 adds a Via header field. + +*Editor's note: The behaviour of the transit-ioi value is currently discussed and needs further consideration how the S-CSCF to AS correlation is described.* + +#### 8. INVITE request (S-CSCF-hA1 to IBCF-hA1) - see example in table 5.4.2-8. + +When the S-CSCF-hA1 receives the initial INVITE request and the "g.3gpp.home-visited" Feature-Caps header field parameter is still in the request, the S-CSCF-hA1 decides according to local policy that loopback routing will be used. + +The S-CSCF-hA1 includes: + +- the TRF URI included in the "+g.3gpp.trf" Feature-Caps header field parameter in the Route header field; +- a Feature-Caps header field with the "+g.3gpp.loopback" header field parameter to indicate that loopback routing is ongoing. The "+g.3gpp.loopback" header field parameter can optionally contain the name of the home network; and +- the "orig-ioi" header field parameter within the P-Charging-Vector header field will be replaced by a type 1 IOI which reflects the home network of user A (i.e. "home-a"). Any "transit-ioi" header field parameter for the path P-CSCF-vA1 to S-CSCF-hA1 will not be maintained after this point. + +The S-CSCF-hA1 removes the "+g.3gpp.home-visited" and "+g.3gpp.trf" Feature-Caps header field parameters. + +NOTE 4: Number normalization and ENUM translation is deferred to the visited network according to local policy. + +The INVITE request is sent according to 3GPP TS 24.229 [4] to the IBCF-hA1. + +**Table 5.4.2-8: INVITE request (S-CSCF-hA1 to IBCF-hA1)** + +``` + +INVITE tel:+4687197378 SIP/2.0 + +To: +From: +P-Asserted-Identity: +P-Asserted-Service: +Contact: +CSeq: +Supported: +Route: , +Record-Route: , , + , , + , , + +Feature-Caps:*;+g.3gpp.loopback="" +P-Access-Network-Info: +P-Charging-Vector: icid-value="AyretyU0dm+602IrT5tAFrbHLso=023551024";orig-ioi="Type 1home-a" + +Via: SIP/2.0/UDP scscf-hA1.home-A.net;branch=z9hG4bK351g45.6 +Via: SIP/2.0/UDP as-hA1.home-A.net;branch=z9hG4bK351g45.5 +Via: SIP/2.0/UDP scscf-hA1.home-A.net;branch=z9hG4bK351g45.4 +Via: SIP/2.0/UDP ibcf-hA1.home-A.net;branch=z9hG4bK351g45.3 +Via: SIP/2.0/UDP ic-A1.interconnection-A.net;branch=z9hG4bK351g45.2 +Via: SIP/2.0/UDP ibcf-vA1.visited-A.net;branch=z9hG4bK351g45.1 +Via: SIP/2.0/UDP pcscf-vA1.visited-A.net:5060;branch=z9hG4bKnas56565 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd];branch=z9hG4bKnashds7 + +Content-Type: +Content-Length: (...) + +c= +m= +a= +a= +a= +a= +a= +a= +a= + +``` + +Other SIP header fields and SDP according to 3GPP TS 24.229 [4] and 3GPP TS 29.079 [5]. + +- Route:** The S-CSCF-hA1 adds the Route header field received in the "+g.3gpp.trf" header field parameter as the bottom most Route header field (including traffic leg information in the received "iotl" SIP URI parameter). The Route header field with the address of the selected IBCF-hA2 is added at the top. +- Via:** The S-CSCF-hA1 adds a Via header field. +- Record-Route:** The S-CSCF-hA1 adds a Record-Route header field. +- Feature-Caps:** The S-CSCF-hA1 adds a Feature-Caps header field with the "+g.3gpp.loopback" header field parameter set to the identifier of the home network to indicate that loopback routing is ongoing. +- P-Charging-Vector:** The S-CSCF-hA1 replaces the type 3 IOI value received in the "orig-ioi" header field parameter from the AS-hA1 with a type 1 "orig-ioi" header field parameter identifying the sending network (i.e. home network hA). Thus the "orig-ioi" header field parameter value is now different compared with the received INVITE at the IBCF-hA1 from the visited network. + +#### 9. INVITE request (IBCF-hA1 to IC-A1) - see example in table 5.4.2-9. + +When the IBCF-hA1 receives the initial INVITE request containing the "+g.3gpp.loopback" header field parameter in a Feature-Caps header field, the IBCF-hA1 updates the SDP as defined within 3GPP TS 29.079 [5]. + +The IBCF-hA1 selects to route the INVITE request via an IC network A and sends the INVITE request according to 3GPP TS 24.229 [4] to the IC-A1. From theory it could be also another IC network but that is due to SLA and operator policy. The IBCF-vA1 determines the next hop IP address from the URI in the first entry of the Route header field either by configured information or using a DNS query according to IETF RFC 3263 [13]. If the subsequent interconnection network is SIP-aware, the determined IP address will belong to the SIP proxy IC-A1. Otherwise the determined IP address will point to IBCF-vA1 and step 10 is skipped (not reflected in message details below). + +**Table 5.4.2-9: INVITE request (IBCF-hA1 to IC-A1)** + +``` +INVITE tel:+4687197378 SIP/2.0 + +To: +From: +P-Asserted-Identity: +P-Asserted-Service: +Contact: +CSeq: +Supported: +Route: , +Record-Route: ,, + ,, + ,, + , +Feature-Caps: +P-Access-Network-Info: +P-Charging-Vector: + +Via: SIP/2.0/UDP ibcf-hA1.home-A.net;branch=z9hG4bK351g45.7 +Via: SIP/2.0/UDP scscf-hA1.home-A.net;branch=z9hG4bK351g45.6 +Via: SIP/2.0/UDP as-hA1.home-A.net;branch=z9hG4bK351g45.5 +Via: SIP/2.0/UDP scscf-hA1.home-A.net;branch=z9hG4bK351g45.4 +Via: SIP/2.0/UDP ibcf-hA1.home-A.net;branch=z9hG4bK351g45.3 +Via: SIP/2.0/UDP ic-A1.interconnection-A.net;branch=z9hG4bK351g45.2 +Via: SIP/2.0/UDP ibcf-vA1.visited-A.net;branch=z9hG4bK351g45.1 +Via: SIP/2.0/UDP pcscf-vA1.visited-A.net:5060;branch=z9hG4bKnas56565 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd];branch=z9hG4bKnashds7 + +Content-Type: +Content-Length: (...) + +c=IN IP6 [5555::aaa:bbb:ccc:ddl] +m=audio 16002 RTP/AVP 97 98 +a= +a= +a= +a= +a=visited-realm:1 visited-A1.net IN IP6 [5555::aaa:bbb:ccc:ddd] 16000 +a=visited-realm:2 x.net IN IP6 [5555::aaa:bbb:ccc:ddl] 16002 +``` + +Other SIP header fields and SDP according to 3GPP TS 24.229 [4] and 3GPP TS 29.079 [5]. + +**Route:** The IBCF-hA1 adds a Route header field with the address of the selected node in the IC network A. + +**Record-Route:** The entries to this header field need to be added based on operator policy. The example shows the possible Record-Route header field when no restriction according to the operator policy applies. Based on topology hiding functionality the IBCF-hA1 will either forward the Record-Route header field with: + +- one visible IBCF-hA1 entry and the remaining collected entries as one hidden entry; or +- an IBCF-hA1 entry and whole content of already collected entries as visible entries. + +**Via:** Based on topology hiding functionality the IBCF-hA1 will either forward the Via header field with: + +- one visible IBCF-hA1 Via header field and the remaining collected set of Via header fields as one hidden Via header field; or +- an IBCF-hA1 Via header field and the whole set of already collected Via header fields as visible entries. + +**SDP:** IBCF-hA1 detects, by inspecting the received set of OMR visited-realm attributes, that the resources in realm instance 4 (i.e. the IBCF-hA1 acting as an entry IBCF in the home network) can be bypassed and removes the "a=visited-realm:4 home-A.net IN IP6 [5555::aaa:bbb:ccc:dd3]" from the outgoing SDP offer. The c-line and the m-line are updated to be the IP address and port of the IBCF-vA1. + +#### 10. INVITE request (IC-A1 to IBCF-vA1) - see example in table 5.4.2-10. + +NOTE 5: If the interconnection network is SIP-unaware, step 10 is skipped. + +When the IC-A1 receives the initial INVITE request the IC-A1 detects that an optimal media path avoiding media to be sent through the home IMS network hA is possible. The IC-A1 updates the SDP according to 3GPP TS 29.079 [5]. + +The IC-A1 selects an entry IBCF in the visited network and sends the INVITE request according to 3GPP TS 24.229 [4] to the IBCF-vA1. Seen from principle point of view the IBCF could be any entry point (IBCF-vAx) of the visited network. + +The content of the Record-Route header field and the Via header field will be based on local policy and updated accordingly. + +IC-A1 detects that the IP address in the SDP offer is within the same realm as the on the outgoing side of IC-A1 and determines that the IC-A1 can be bypassed by media and uses the incoming SDP offer as the outgoing SDP offer. + +**Table 5.4.2-10: INVITE request (IC-A1 to IBCF-vA1)** + +``` +INVITE tel:+4687197378 SIP/2.0 + +To: +From: +P-Asserted-Identity: +P-Asserted-Service: +Contact: +CSeq: +Supported: +Route: , +Record-Route: + , , + , , + , , + , +Feature-Caps: +P-Access-Network-Info: +P-Charging-Vector:icid-value="AyretyU0dm+602IrT5tAFrbHLso=023551024";orig-ioi="Type 1home-a";transit-ioi="ICt.1" + +Via: SIP/2.0/UDP ic-A1.interconnection-A.net;branch=z9hG4bK351g45.8 +Via: SIP/2.0/UDP ibcf-hA1.home-A.net;branch=z9hG4bK351g45.7 +Via: SIP/2.0/UDP scscf-hA1.home-A.net;branch=z9hG4bK351g45.6 +Via: SIP/2.0/UDP as-hA1.home-A.net;branch=z9hG4bK351g45.5 +Via: SIP/2.0/UDP scscf-hA1.home-A.net;branch=z9hG4bK351g45.4 +Via: SIP/2.0/UDP ibcf-hA1.home-A.net;branch=z9hG4bK351g45.3 +Via: SIP/2.0/UDP ic-A1.interconnection-A.net;branch=z9hG4bK351g45.2 +Via: SIP/2.0/UDP ibcf-vA1.visited-A.net;branch=z9hG4bK351g45.1 +Via: SIP/2.0/UDP pcscf-vA1.visited-A.net:5060;branch=z9hG4bKnas56565 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd];branch=z9hG4bKnashds7 + +Content-Type: +Content-Length: (...) + +c= +m= +a= +a= +a= +a= +a= +a= +``` + +Other SIP header fields and SDP according to 3GPP TS 24.229 [4] and 3GPP TS 29.079 [5]. + +**Via:** The IC-A1 adds a Via header field. + +**Route:** The IC-A1 adds a Route header field with the address of the selected node in the visited network A. + +**Record-Route:** The IC-A1 adds a Record-Route header field. + +**P-Charging-Vector:** The IC-A1 adds the "transit-ioi" header field with a value identifying the interconnection network A (i.e. "ICt.1"). + +#### 11. INVITE request (IBCF-vA1 to TRF-vA1) - see example in table 5.4.2-11. + +When the IBCF-vA1 receives the initial INVITE request containing the "+g.3gpp.loopback" header field parameter in a Feature-Caps header field, the IBCF-vA1 searches for a possible optimal media path and detects that an optimal media path within the visited network is possible. The IBCF-vA1 updates the SDP according to 3GPP TS 29.079 [5]. + +The IBCF-vA1 sends the INVITE request according to 3GPP TS 24.229 [4] to the TRF-vA1. + +The content of the Record-Route header field and the Via header field will be based on local policy and updated accordingly. + +In this example, the IBCF-hA1 does not add any "transit-ioi" header field parameter in the P-Charging-Vector header field. However, the IBCF-hA1 adds the "transit-ioi" header field parameter based on local policy, when the "transit-ioi" identifying the preceding interconnection network is not included in the received request (e.g. when the preceding interconnection network is not an IMS transit network). + +**Table 5.4.2-11: INVITE request (IBCF-vA1 to TRF vA1)** + +``` +INVITE tel:+4687197378 SIP/2.0 + +To: +From: +P-Asserted-Identity: +P-Asserted-Service: +Contact: +CSeq: +Supported: +Route: +Record-Route: + + , , + , , + , , + , +Feature-Caps: +P-Access-Network-Info: +P-Charging-Vector: + +Via: SIP/2.0/UDP ibcf-vA1.visited-A.net;branch=z9hG4bK351g45.9 +Via: SIP/2.0/UDP ic-A1.interconnection-A.net;branch=z9hG4bK351g45.8 +Via: SIP/2.0/UDP ibcf-hA1.home-A.net;branch=z9hG4bK351g45.7 +Via: SIP/2.0/UDP scscf-hA1.home-A.net;branch=z9hG4bK351g45.6 +Via: SIP/2.0/UDP as-hA1.home-A.net;branch=z9hG4bK351g45.5 +Via: SIP/2.0/UDP scscf-hA1.home-A.net;branch=z9hG4bK351g45.4 +Via: SIP/2.0/UDP ibcf-hA1.home-A.net;branch=z9hG4bK351g45.3 +Via: SIP/2.0/UDP ic-A1.interconnection-A.net;branch=z9hG4bK351g45.2 +Via: SIP/2.0/UDP ibcf-vA1.visited-A.net;branch=z9hG4bK351g45.1 +Via: SIP/2.0/UDP pcscf-vA1.visited-A.net:5060;branch=z9hG4bKnas56565 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd];branch=z9hG4bKnashds7 + +Content-Type: +Content-Length: (...) + +c=IN IP6 5555::aaa:bbb:ccc:ddd +m=audio 16000 RTP/AVP 97 98 +a= +a= +a= +a= +a=visited-realm:1 visited-A1.net IN IP6 5555::aaa:bbb:ccc:dd1 16000 +``` + +Other SIP header fields and SDP according to 3GPP TS 24.229 [4] and 3GPP TS 29.079 [5]. + +**Via:** The IBCF-vA1 adds a Via header field. + +**Record-Route:** The IBCF-vA1 adds a Record-Route header field. + +**SDP:** IBCF-vA1 detects that the realm in the "a=visited-realm:1 visited-A1.net IN IP6 [5555::aaa:bbb:ccc:ddd] 1600" in the incoming SDP offer is the same realm as on the outgoing side of IBCF-vA1 and determines that the IBCF-vA1 "a=visited-realm:2 x.net IN IP6 [5555::aaa:bbb:ccc:dd1] 16002" can be bypassed. The c-line and the m-line are updated to be the IP address and port of the UE-A. + +#### 12. INVITE request (TRF-vA1 to IBCF-vA1). + +When the TRF-vA1 receives the initial INVITE request the TRF-vA1: + +- performs number normalization (if used by local policy) and ENUM translation and possibly updates the request-URI if necessary; +- replaces an type 1 "orig-ioi" header field parameter value in the P-Charging-Vector header field with a type 2 "orig-ioi" header field parameter value where the IOI value identifies the visited network; +- possibly adds an additional Route header field pointing to the IBCF-vA1 and also to the IC in cases where the IBCF-vA1 has no routeing decision to do; +- removes the "+g.3gpp.loopback" header field parameter from the Feature-Caps header field of the outgoing request; and +- appends the "iotl" SIP URI parameter with the value "visitedA-homeB" to the Request-URI. + +The TRF-vA1 selects an IBCF to act as an exit point and sends the INVITE request according to 3GPP TS 24.229 [4] to the IBCF-vA1 (which could be also another IBCF e.g. IBCF-vA2). + +The content of the Record-Route header field and the Via header field will be based on local policy and updated accordingly. + +The OMR specific attributes in the SDP are kept as received from the IBCF-vA1. + +#### 13. INVITE request (IBCF-vA1 to IC-T1) - see example in table 5.4.2-13. + +When the IBCF-vA1 receives the initial INVITE request the IBCF-vA1 selects the IC-T1 if not already a Route header field exists pointing to the IC-T1. The IBCF-vA1 determines the next hop IP address from the Request-URI either by configured information or using a DNS query according to IETF RFC 3263 [13]. If the subsequent interconnection network is SIP-aware, the determined IP address will belong to the SIP proxy IC-T1. Otherwise the determined IP address will point to an IBCF acting as an entry point in the remote home network (not reflected in message details below). + +Record-Route header field and Via header field will be based on local policy and updated accordingly. The example in table 5.4.2-13 shows one example of the content of the header fields and the text below the table explains other possibilities. + +The IBCF-vA1 removes all OMR specific attributes from the SDP offer. + +**Table 5.4.2-13: INVITE request (IBCF-vA1 to IC-T1)** + +``` +INVITE sip:+4687197378@home-R.net;user=phone;iotl=visitedA-homeB SIP/2.0 + +To: +From: +P-Asserted-Identity: +P-Asserted-Service: +Contact: +CSeq: +Supported: +Route: +Record-Route: , , + , , + , , + , , + , +``` + +``` + +, , +, +P-Access-Network-Info: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024";orig-ioi="visited-a" + +Via: SIP/2.0/UDP ibcf-vA1.visited-A.net;branch=z9hG4bK351g45.11 +Via: SIP/2.0/UDP trf-vA1.visited-A.net;branch=z9hG4bK351g45.10 +Via: SIP/2.0/UDP ibcf-vA1.visited-A.net;branch=z9hG4bK351g45.9 +Via: SIP/2.0/UDP ic-A1.interconnection-A.net;branch=z9hG4bK351g45.8 +Via: SIP/2.0/UDP ibcf-hA1.home-A.net;branch=z9hG4bK351g45.7 +Via: SIP/2.0/UDP scscf-hA1.home-A.net;branch=z9hG4bK351g45.6 +Via: SIP/2.0/UDP as-hA1.home-A.net;branch=z9hG4bK351g45.5 +Via: SIP/2.0/UDP scscf-hA1.home-A.net;branch=z9hG4bK351g45.4 +Via: SIP/2.0/UDP ibcf-hA1.home-A.net;branch=z9hG4bK351g45.3 +Via: SIP/2.0/UDP ic-A1.interconnection-A.net;branch=z9hG4bK351g45.2 +Via: SIP/2.0/UDP ibcf-vA1.visited-A.net;branch=z9hG4bK351g45.1 +Via: SIP/2.0/UDP pcscf-vA1.visited-A.net:5060;branch=z9hG4bKKnas56565 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd];branch=z9hG4bKnashds7 + +Content-Type: +Content-Length: (...) + +c=IN IP6 [5555::aaa:bbb:ccc:ddd] +m=audio 16016 RTP/AVP 97 98 +a= +a= +a= +a= + +``` + +Other SIP header fields and SDP according to 3GPP TS 24.229 [4] and 3GPP TS 29.079 [5]. + +**Route:** The IBCF-vA1 adds a Route header field with the address of the selected node in the IC network B. + +**Record-Route:** Based on topology hiding functionality the IBCF-vA1 will either forward the Record-Route header field with: + +- one visible IBCF-vA1 entry and the remaining collected entries as one hidden entry; or +- an IBCF-vA1 entry and whole content of already collected entries as visible entries. + +**Via:** Based on topology hiding functionality the IBCF-vA1 will either forward the Via header field with: + +- one visible IBCF-vA1 Via header field and the remaining collected set of Via header fields as one hidden Via header field; or +- an IBCF-vA1 Via header field and the whole set of already collected Via header fields as visible entries. + +**SDP:** The IBCF-vA1 anchor media and insert the IBCF-vA1 IP address and port number. + +**14. 183 (Session Progress) response (IC-T1 to IBCF-vA1) - see example in table 5.4.2-14.** + +NOTE 6: If the interconnection network is SIP-unaware, step 14 is executed between IBCF-hB and IBCF-vA1 instead. + +IC-T1 forwards the received 183 (Session Progress) response to the IBCF-vA1 based on the Via header field. + +Record-Route header field and Via header fields will be updated accordingly. The example in table 5.4.2-14 shows one example of the content of the header fields. + +**Table 5.4.2-14: SIP 183 (Session Progress) response (IC-T1 to IBCF-vA1)** + +``` + +SIP/2.0 183 Session Progress + +To: ;tag=654a +From: ;tag=4fa3 +P-Asserted-Identity: , +Contact: +CSeq: 1 INVITE +Require: 100rel, precondition +Record-Route: , + +``` + +``` + +, +, , +, , +, , +, , +, , +, +P-Access-Network-Info: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024";orig-ioi="visited-a";term- +ioi="home-r";transit-ioi="ICt.1" + +Via: SIP/2.0/UDP ibcf-vA1.visited-A.net;branch=z9hG4bK351g45.11 +Via: SIP/2.0/UDP trf-vA1.visited-A.net;branch=z9hG4bK351g45.10 +Via: SIP/2.0/UDP ibcf-vA1.visited-A.net;branch=z9hG4bK351g45.9 +Via: SIP/2.0/UDP ic-A1.interconnection-A.net;branch=z9hG4bK351g45.8 +Via: SIP/2.0/UDP ibcf-hA1.home-A.net;branch=z9hG4bK351g45.7 +Via: SIP/2.0/UDP scscf-hA1.home-A.net;branch=z9hG4bK351g45.6 +Via: SIP/2.0/UDP as-hA1.home-A.net;branch=z9hG4bK351g45.5 +Via: SIP/2.0/UDP scscf-hA1.home-A.net;branch=z9hG4bK351g45.4 +Via: SIP/2.0/UDP ibcf-hA1.home-A.net;branch=z9hG4bK351g45.3 +Via: SIP/2.0/UDP ic-A1.interconnection-A.net;branch=z9hG4bK351g45.2 +Via: SIP/2.0/UDP ibcf-vA1.visited-A.net;branch=z9hG4bK351g45.1 +Via: SIP/2.0/UDP pcscf-vA1.visited-A.net:5060;branch=z9hG4bKnas56565 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd];branch=z9hG4bKnashds7 + +Content-Type: application/sdp +Content-Length: (...) + +c=IN IP6 [5555::aaa:bbb:ccc:dd4] +m=audio 16511 RTP/AVP 97 98 +a=curr:qos local none +a=curr:qos remote none +a=des:qos mandatory local sendrecv +a=des:qos none remote sendrecv + + +Other SIP header fields and SDP according to 3GPP TS 24.229 [4]. + +``` + +**P-Charging-Vector:** The IC-T1 adds the "transit-ioi" header field parameter identifying the interconnection network (i.e. ICt.1). + +**Require:** The Require header field contains the option-tag "100rel" indicating reliable sending of the 183 (Session Progress) response and the option-tag "precondition" indicating the usage of the precondition mechanism. + +**SDP MIME body** The received SDP answer includes connection address information for the media line that is a valid IP address other than the unspecified address (i.e., IPv4: "0.0.0.0", IPv6: "invalid.invalid"). + +#### 15. 183 (Session Progress) response (IBCF-vA1 to TRF-vA1) - see example in table 5.4.2-15. + +In this example, the IBCF-vA1 does not add any "transit-ioi" header field parameter in the P-Charging-Vector header field. However, the IBCF-vA1 adds the "transit-ioi" header field parameter based on local policy, when the "transit-ioi" identifying the preceding interconnection network is not included in the received request (e.g. when the preceding interconnection network is not an IMS transit network). + +**Table 5.4.2-15: SIP 183 (Session Progress) response (IBCF-vA1 to TRF-vA1)** + +``` + +SIP/2.0 183 Session Progress + +To: +From: +P-Asserted-Identity: +Contact: +CSeq: +Require: +Record-Route: , +, +, , +, , +, , +, , +, , + +``` + +``` + +, +P-Access-Network-Info: +P-Charging-Vector: + +Via: SIP/2.0/UDP trf-vA1.visited-A.net;branch=z9hG4bK351g45.10 +Via: SIP/2.0/UDP ibcf-vA1.visited-A.net;branch=z9hG4bK351g45.9 +Via: SIP/2.0/UDP ic-A1.interconnection-A.net;branch=z9hG4bK351g45.8 +Via: SIP/2.0/UDP ibcf-hA1.home-A.net;branch=z9hG4bK351g45.7 +Via: SIP/2.0/UDP scscf-hA1.home-A.net;branch=z9hG4bK351g45.6 +Via: SIP/2.0/UDP as-hA1.home-A.net;branch=z9hG4bK351g45.5 +Via: SIP/2.0/UDP scscf-hA1.home-A.net;branch=z9hG4bK351g45.4 +Via: SIP/2.0/UDP ibcf-hA1.home-A.net;branch=z9hG4bK351g45.3 +Via: SIP/2.0/UDP ic-A1.interconnection-A.net;branch=z9hG4bK351g45.2 +Via: SIP/2.0/UDP ibcf-vA1.visited-A.net;branch=z9hG4bK351g45.1 +Via: SIP/2.0/UDP pcscf-vA1.visited-A.net:5060;branch=z9hG4bKnas56565 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd];branch=z9hG4bKnashds7 + +Content-Type: +Content-Length: (...) + +c=IN IP6 [5555::aaa:bbb:ccc:ddl] +t=0 0 +m=audio 16511 RTP/AVP 97 98 +a= +a= +a= +a= +a=visited-realm:1 visited-A1.net IN IP6 [5555::aaa:bbb:ccc:ddl] 16511 + +Other SIP header fields according to 3GPP TS 24.229 [4]. + +``` + +**SDP MIME body:** The IBCF-vA1 adds the a=visited-realm according to 3GPP TS 29.079 [5] indicating that an optimal media route has occurred and replaces the received IP address with its own IP address. + +#### 16. 183 (Session Progress) response (TRF-vA1 to IBCF-vA1) - see example in table 5.4.2-16. + +**Table 5.4.2-16: SIP 183 (Session Progress) response (TRF-vA1 to IBCF-vA1)** + +``` + +SIP/2.0 183 Session Progress + +To: +From: +P-Asserted-Identity: +Contact: +CSeq: +Require: +Record-Route: , + , + , , + , , + , , + , , + , , + , +P-Access-Network-Info: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024";orig-ioi="Type 1home-a";term- +ioi="Type 1visited-a";loopback + +Via: SIP/2.0/UDP ibcf-vA1.visited-A.net;branch=z9hG4bK351g45.9 +Via: SIP/2.0/UDP ic-A1.interconnection-A.net;branch=z9hG4bK351g45.8 +Via: SIP/2.0/UDP ibcf-hA1.home-A.net;branch=z9hG4bK351g45.7 +Via: SIP/2.0/UDP scscf-hA1.home-A.net;branch=z9hG4bK351g45.6 +Via: SIP/2.0/UDP as-hA1.home-A.net;branch=z9hG4bK351g45.5 +Via: SIP/2.0/UDP scscf-hA1.home-A.net;branch=z9hG4bK351g45.4 +Via: SIP/2.0/UDP ibcf-hA1.home-A.net;branch=z9hG4bK351g45.3 +Via: SIP/2.0/UDP ic-A1.interconnection-A.net;branch=z9hG4bK351g45.2 +Via: SIP/2.0/UDP ibcf-vA1.visited-A.net;branch=z9hG4bK351g45.1 +Via: SIP/2.0/UDP pcscf-vA1.visited-A.net:5060;branch=z9hG4bKnas56565 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd];branch=z9hG4bKnashds7 + +Content-Type: +Content-Length: (...) + +c= +m= +a= + +``` + +``` +a= +a= +a= +a= +``` + +For the content of the SDP see table 5.4.2-15. + +Other SIP header fields according to 3GPP TS 24.229 [4]. + +**P-Charging-Vector:** The TRF-vA1 removes the "transit-ioi" header field parameter and replaces the "orig-ioi" received from the IBCF-vA1 with the "orig-ioi" received from the home network in the INVITE request and replaces the "term-ioi" with the received IOI type 2 value to a IOI type 1 value identifying the visited network vA. The TRF-vA1 adds the loopback-indication header field parameter. + +#### 17. 183 (Session Progress) response (IBCF-vA1 to IC-A1) - see example in table 5.4.2-17. + +When the IBCF-vA1 receives the 183 (Session Progress) response the IBCF-vA1 updates the SDP as follows: + +- The c=IN IP4 192.0.2.4 is replaced with an invalid IPv4 address, i.e. c=IN IP4 0.0.0.0, since the IP realm on visited network side and the IC network side are not the same hence the received IP address is not valid on the IC side. The received SDP answer includes connection address information for the media line that is a valid IP address other than the unspecified address (i.e., IPv4: "0.0.0.0", IPv6: "invalid.invalid"). + +The IBCF-vA1 sends the 183 (Session Progress) response according to 3GPP TS 24.229 [4] towards the S-CSCF-hA1 via the IC-A1 and IBCF-hA1. Neither the IC-A1 nor IBCF-hA1 updates the SDP. + +NOTE 7: If the interconnection network is SIP-unaware, IC-A1 is omitted. + +**Table 5.4.2-17: SIP 183 (Session Progress) response (IBCF-vA1 to IC-A1)** + +``` +SIP/2.0 183 Session Progress + +To: +From: +P-Asserted-Identity: +Contact: +CSeq: +Require: +Record-Route: , + , + ,, + ,, + ,, + ,, + ,, + , +P-Access-Network-Info: +P-Charging-Vector: + +Via: SIP/2.0/UDP ic-A1.interconnection-A.net;branch=z9hG4bK351g45.8 +Via: SIP/2.0/UDP ibcf-hA1.home-A.net;branch=z9hG4bK351g45.7 +Via: SIP/2.0/UDP scscf-hA1.home-A.net;branch=z9hG4bK351g45.6 +Via: SIP/2.0/UDP as-hA1.home-A.net;branch=z9hG4bK351g45.5 +Via: SIP/2.0/UDP scscf-hA1.home-A.net;branch=z9hG4bK351g45.4 +Via: SIP/2.0/UDP ibcf-hA1.home-A.net;branch=z9hG4bK351g45.3 +Via: SIP/2.0/UDP ic-A1.interconnection-A.net;branch=z9hG4bK351g45.2 +Via: SIP/2.0/UDP ibcf-vA1.visited-A.net;branch=z9hG4bK351g45.1 +Via: SIP/2.0/UDP pcscf-vA1.visited-A.net;5060;branch=z9hG4bKnas56565 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd];branch=z9hG4bKnashds7 + +Content-Type: +Content-Length: (...) + +c=IN IP6 invalid.invalid +m=audio 16511 RTP/AVP 97 98 +a= +a=a= +a= +a=visited-realm:1 visited-A1.net IN IP6 [5555::aaa:bbb:ccc:ddl]16511 +``` + +Other SIP header fields and SDP according to 3GPP TS 24.229 [4]. + +**SDP MIME body:** The IBCF-vA1 detects that the realm is different towards the IC-A1 than in the "a=visited-realm" attribute and changes the IP address to c=IN IP6 invalid.invalid. + +#### **18. 183 (Session Progress) response (IC-A1 to IBCF-hA1) - see example in table 5.4.2-18.** + +NOTE 8: If the interconnection network is SIP-unaware, step 18 is skipped. + +**Table 5.4.2-18: SIP 183 (Session Progress) response (IC-A1 to IBCF-hA1)** + +``` +SIP/2.0 183 Session Progress + +To: +From: +P-Asserted-Identity: +Contact: +CSeq: +Require: +Record-Route: , + , + , , + , , + , , + , , + , , + , +P-Access-Network-Info: +P-Charging-Vector: icid-value="AyretyU0dm+602IrT5tAFrbHLso=023551024";orig-ioi="Type 1home-a";term- +ioi="Type 1visited-a";transit-ioi="ICa.1";loopback + +Via: SIP/2.0/UDP ibcf-hA1.home-A.net;branch=z9hG4bK351g45.7 +Via: SIP/2.0/UDP scscf-hA1.home-A.net;branch=z9hG4bK351g45.6 +Via: SIP/2.0/UDP as-hA1.home-A.net;branch=z9hG4bK351g45.5 +Via: SIP/2.0/UDP scscf-hA1.home-A.net;branch=z9hG4bK351g45.4 +Via: SIP/2.0/UDP ibcf-hA1.home-A.net;branch=z9hG4bK351g45.3 +Via: SIP/2.0/UDP ic-A1.interconnection-A.net;branch=z9hG4bK351g45.2 +Via: SIP/2.0/UDP ibcf-vA1.visited-A.net;branch=z9hG4bK351g45.1 +Via: SIP/2.0/UDP pcscf-vA1.visited-A.net:5060;branch=z9hG4bKnas56565 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd];branch=z9hG4bKnashds7 + +Content-Type: +Content-Length: (...) + +c= +m= +a= +a= +a= +a= +a= + +For the content of the SDP see table 5.4.2-17. + +Other SIP header fields and SDP according to 3GPP TS 24.229 [4]. +``` + +**P-Charging-Vector:** The IC-A1 adds the "transit-ioi" header field parameter identifying the interconnection network (i.e. ICa.1). + +#### **19-24. 183 (Session Progress) response (loop from IBCF-hA1 to IBCF-vA1 via S-CSCF-hA1, AS-hA1, S-CSCF-hA1, IBCF-hA1 and IC-A1) handling.** + +The procedures of 3GPP TS 24.229 [4] apply. The main changes are: + +- the deduction of Via header field; and +- the P-Charging-Vector is updated with IOI type values corresponding to the INVITE request along the signalling path (see clause 4.3.1.4). + +NOTE 9: If the interconnection network is SIP-unaware, step 24 is skipped. + +The IBCF-hA1 and the IC-A1 releases resources reserved in the media gateway. The content of the SDP answer is kept unchanged. + +#### 25. 183 (Session Progress) response (IBCF-vA1 to P-CSCF-vA1) - see example in table 5.4.2-25. + +When the IBCF-vA1 receives the 183 (Session Progress) response the IBCF- vA1 updates the SDP. + +The IBCF- vA1: + +- replaces the received invalid IPv6 address with the IP address received in the visited-realm instance 1; +- removes all OMR specific attributes since the SDP offer from P-CSCF-A did not contain any OMR specific attributes; +- releases resources reserved in the TrGW. + +The IBCF-vA1 sends the 183 (Session Progress) response according to 3GPP TS 24.229 [4] to the P-CSCF-vA1. + +**Table 5.4.2-25: SIP 183 (Session Progress) response (IBCF-vA1 to P-CSCF-vA1)** + +``` +SIP/2.0 183 Session Progress + +To: +From: +P-Asserted-Identity: +Contact: +CSeq: +Require: +Record-Route: , + , + , , + , , + , , + , , + , , + , +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024";orig-ioi="Type 1visited-a";term-ioi="Type 1home-a";transit-ioi="ICa.1";loopback + +Via: SIP/2.0/UDP pcscf-vA1.visited-A.net:5060;branch=z9hG4bKnas56565 +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd];branch=z9hG4bKnashds7 + +Content-Type: +Content-Length: (...) + +c=IN IP6 [5555::aaa:bbb:ccc:ddl] +m=audio 16511 RTP/AVP 97 98 +a= +a= +a= +a= + +Other SIP header fields and SDP according to 3GPP TS 24.229 [4]. +``` + +#### 26. 183 (Session Progress) response (P-CSCF-vA1 to UE-A) - see example in table 5.4.2-26. + +**Table 5.4.2-26: SIP 183 (Session Progress) response (P-CSCF-vA1 to UE-A)** + +``` +SIP/2.0 183 Session Progress + +To: +From: +P-Asserted-Identity: +Contact: +CSeq: +Require: +Record-Route: , + , + , , + , , + , , + , , + , , + , + +Via: SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd];branch=z9hG4bKnashds7 + +Content-Type: +``` + +Content-Length: (...) + +c= +m= +a= +a= +a= +a= + +Other SIP header fields and SDP according to 3GPP TS 24.229 [4]. + +#### **27. PRACK request (UE-A to IC-T1 via all intermediate nodes) and 200 OK response (IC-T1 to UE-A via all intermediate nodes).** + +The PRACK request and the 200 (OK) response to the PRACK request are sent without any SDP offer/SDP answer between the UE-A and the IC-T1 according to 3GPP TS 24.229 [4]. + +#### **28. Resource Reservation.** + +#### **29. UPDATE request (UE-A to IC-T1 via all intermediate nodes) and 200 OK response (IC-T1 to UE-A via all intermediate nodes).** + +The UPDATE request and the 200 (OK) response to the UPDATE request are sent with the same SDP offer and SDP answer as in the initial SIP INVITE request and the 183 (Session Progress) response but now indicating that resources are reserved at the UE-A. The SDP updates are the same as in steps 1 – 26. + +#### **30. UPDATE request (IC-T1 to UE-A via all intermediate nodes) and 200 OK response (UE-A to IC-T1 via all intermediate nodes).** + +The UPDATE request and the 200 (OK) response to the UPDATE request are sent according to the rules described in 3GPP TS 29.079 [5]. + +## 5.5 Routeing when the originating and terminating user reside in the same home network + +This clause describes routeing when the originating and terminating user reside in the same home network. + +## 5.6 Routeing from originating home to terminating home network + +The interconnection (IC) and routeing aspects of the originating home network to the terminating home network including transit networks use case do not differ from any other session set-up between any two wire-line or mobile networks. The IC might be established via CS-IC or PS-IC. The routeing might be based on the destination given by the SIP Request-URI or the Called Party Number parameter in case of CS-IC. + +## 5.7 Routeing from originating visited network to terminating home network + +This clause describes routeing from an originating remote network to the terminating home network A including transit network scenarios. + +The signalling and the media path between the originating remote network and the terminating home network A might be based on SIP/PS or CS/TDM interconnection interfaces. + +NOTE 1: This is different from some other IC scenarios discussed in this document for which SIP/PS interconnection is a mandatory pre-requisite. + +The scenario appears after the "originating roaming without loopback" according to clause 5.3 or the "originating roaming with loopback" according to clause 5.4 has taken place. I.e. the call has already been set-up from the P-CSCF in the originating visited network via IMS in the originating home network back to the TRF in the originating visited network. + +From viewpoint of the originating remote network it doesn't matter whether the call originates from an own user served by an own S-CSCF or from a roaming inbound user served by the TRF. In both cases the originating remote network will set-up an outgoing call leg via an IBCF acting as an exit point (MGCF, if CS IC applies) towards the terminating + +network A. Hereby the path might be established via IC networks. The destination (i.e. in this case the address of the terminating home network) used for routing is given by the request line provided by the originating remote network (CdPty in case of CS IC). + +From the viewpoint of the IC network and from the viewpoint of the terminating home network A the routing and call handling does not differ from calls originated in any other network. I.e. the fact that the call is originated by a roamer is neither visible nor required/used for any proceeding. + +NOTE 2: Even if a calling party identity (P-Asserted-Identity header field, From header field) is present and not within the number range of the originating visited network this does not indicate that the originating party is an inbound roamer within the originating visited network which sets up the call. Number portability and forwarding services might result in the same effect. In any case a mismatch between the calling party identity and address range of the originating visited network does not result in any deviating routing procedures within IC or terminating home network. + +## 5.8 Routeing in terminating home network when user resides in this network + +This use case does not involve any interconnection network and is out of scope of this technical report. + +## 5.9 Routeing from terminating home network to the terminating visited network + +This clause describes routeing from the terminating home network to the terminating visited network including the traversal of transit network between the terminating home network and the terminating visited network. + +Preconditions: + +- The UE-A is registered as described in clause 5.2. +- In the originating side the call can be routed either as a call without loopback as described in clause 5.3 or with loopback as described in clause 5.4. +- The coding examples assume that the originating network, the interconnection network and the terminating network are within the trust domain. + +![Sequence diagram showing a mobile terminating call flow from home network hA to visited network vA. The diagram includes lifelines for IBCF-hA2, I-CSCF-hA1, S-CSCF-hA1, AS-A1, IBCF-hA1, IC-A1, IBCF-vA1, P-CSCF-vA1, and UE-A. The flow consists of INVITE, 183, 180, PRACK, UPDATE, 200 OK, and ACK messages across these entities.](347010b7ac06d3ae97927fde0f784d7c_img.jpg) + +The sequence diagram illustrates the following message flow: + +- 1. INVITE:** IBCF-hA2 to I-CSCF-hA1 +- 2. INVITE:** I-CSCF-hA1 to S-CSCF-hA1 +- 3. INVITE:** S-CSCF-hA1 to AS-A1 +- 4. INVITE:** AS-A1 to S-CSCF-hA1 +- 5. INVITE:** S-CSCF-hA1 to IBCF-hA1 +- 6. INVITE:** IBCF-hA1 to IC-A1 +- 7. INVITE:** IC-A1 to IBCF-vA1 +- 8. INVITE:** IBCF-vA1 to P-CSCF-vA1 +- 9. INVITE:** P-CSCF-vA1 to UE-A +- 10. 183:** UE-A to P-CSCF-vA1 +- 11. 183:** P-CSCF-vA1 to IBCF-vA1 +- 12. 183:** IBCF-vA1 to IC-A1 +- 13. 183:** IC-A1 to IBCF-hA1 +- 14. 183:** IBCF-hA1 to S-CSCF-hA1 +- 15. 183:** S-CSCF-hA1 to AS-A1 +- 16. 183:** AS-A1 to S-CSCF-hA1 +- 17. 183:** S-CSCF-hA1 to I-CSCF-hA1 +- 18. 183:** I-CSCF-hA1 to IBCF-hA2 +- 19. PRACK and 200 OK PRACK without an SDP offer:** A combined message block between S-CSCF-hA1 and AS-A1. +- 20. UPDATE and 200 OK to UPDATE:** A combined message block between S-CSCF-hA1 and AS-A1. The text indicates: "with the same SDP offer as in the INVITE but preconditions for UE-A are now fulfilled preconditions for remote UE are fulfilled." +- 21. 180:** UE-A to P-CSCF-vA1 +- 22. 180:** P-CSCF-vA1 to IBCF-vA1 +- 23. 180:** IBCF-vA1 to IC-A1 +- 24. 180:** IC-A1 to IBCF-hA1 +- 25. 180:** IBCF-hA1 to S-CSCF-hA1 +- 26. 180:** S-CSCF-hA1 to AS-A1 +- 27. 180:** AS-A1 to S-CSCF-hA1 +- 28. 180:** S-CSCF-hA1 to I-CSCF-hA1 +- 29. 180:** I-CSCF-hA1 to IBCF-hA2 +- 30. PRACK and 200 OK PRACK without an SDP offer:** A combined message block between S-CSCF-hA1 and AS-A1. +- 31. 200 OK INVITE:** UE-A to P-CSCF-vA1 +- 32. 200 OK INVITE:** P-CSCF-vA1 to IBCF-vA1 +- 33. 200 OK INVITE:** IBCF-vA1 to IC-A1 +- 34. 200 OK INVITE:** IC-A1 to IBCF-hA1 +- 35. 200 OK INVITE:** IBCF-hA1 to S-CSCF-hA1 +- 36. 200 OK INVITE:** S-CSCF-hA1 to AS-A1 +- 37. 200 OK INVITE:** AS-A1 to S-CSCF-hA1 +- 38. 200 OK INVITE:** S-CSCF-hA1 to I-CSCF-hA1 +- 39. 200 OK INVITE:** I-CSCF-hA1 to IBCF-hA2 +- 40. ACK:** IBCF-hA2 to I-CSCF-hA1 +- 41. ACK:** I-CSCF-hA1 to S-CSCF-hA1 +- 42. ACK:** S-CSCF-hA1 to AS-A1 +- 43. ACK:** AS-A1 to S-CSCF-hA1 +- 44. ACK:** S-CSCF-hA1 to IBCF-hA1 +- 45. ACK:** IBCF-hA1 to IC-A1 +- 46. ACK:** IC-A1 to IBCF-vA1 +- 47. ACK:** IBCF-vA1 to P-CSCF-vA1 +- 48. ACK:** P-CSCF-vA1 to UE-A + +Sequence diagram showing a mobile terminating call flow from home network hA to visited network vA. The diagram includes lifelines for IBCF-hA2, I-CSCF-hA1, S-CSCF-hA1, AS-A1, IBCF-hA1, IC-A1, IBCF-vA1, P-CSCF-vA1, and UE-A. The flow consists of INVITE, 183, 180, PRACK, UPDATE, 200 OK, and ACK messages across these entities. + +**Figure 5.9-1: Mobile terminating call from terminating home network to terminating visited network** + +The steps of the flow are as follows: + +#### **1. INVITE request (IBCF-hA2 to I-CSCF-hA1) - see example in table 5.9-1.** + +An initial INVITE request is received by the IBCF-hA2. Due to bilateral agreement all relevant SIP header fields are included. The IBCF-hA2 removes any received Route header field pointing to itself and forwards the call to the I-CSCF-hA1 according to 3GPP TS 24.229 [4]. + +**Table 5.9-1: INVITE request (IBCF-hA2 to I-CSCF-hA1)** + +``` +INVITE sip:+12375551111@home-A.net;user=phone;iotl=homeA-homeB SIP/2.0 + +To: +From: < tel:+4687197378>;tag=4fa3 +P-Asserted-Identity: ,; +P-Asserted-Service: urn:urn-7:3gpp-service.ims.icsi.mmtel +Contact: +CSeq: 1 INVITE +Supported: 100rel,precondition +Route: +Record-Route: ,, +``` + +``` + +P-Access-Network-Info: 3GPP-E-UTRAN-TDD;utran-cell-id-3gpp=234151D0FCE22,3GPP-E-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE22;network-provided;local-time-zone="UTC+01:00";daylight-saving-time="01" +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024";orig-ioi="home-r";transit-ioi="ICt.1" + +Via: SIP/2.0/UDP ibcf-hA2.home-R.net;branch=z9hG4bK351g45.13 +Via: SIP/2.0/UDP ic-T1.interconnection-T.net;branch=z9hG4bK351g45.12 +Via: + +Other SIP header fields and SDP according to 3GPP TS 24.229 [4] + +``` + +- Request-URI:** Contains the destination address for the INVITE request. In this example a SIP URI with user=phone is used. It could be also a tel URI. The "iotl" SIP URI parameter indicates that this is call between two home networks and that the URI in the Request-URI is the destination. If the remote UE is roaming and loopback routeing is used, the "iotl" SIP URI parameter would be set to "visitedA-homeB". +- Supported:** The Supported header field contains the option-tag "100rel" indicating support of the reliable provisional responses and the option-tag "precondition" indicating support of the precondition mechanism. +- P-Charging-Vector:** The P-Charging-Vector contains the type 2 "orig-ioi" of the call which is either the remote UE's home network or the remote UE's visited network when loopback applies. In this example the "orig-ioi" contains the remote UE's home network. Contains the "transit-ioi" header field parameter identifying the interconnection network. +- Contact:** The Contact header field contains in this example the IP address of the remote UE. But due to network rules it could be also the IP address a downstream B2BUA. +- Route:** The IBCF-hA2 adds a Route header field which points to I-CSCF-hA1 in the home network hA. +- Record-Route:** Depending on the policy of the intermediate network the content of the Record-Route header field can vary. The Record-Route header field includes all entries included in the received INVITE request plus an entry of the incoming IBCF-hA2. +- Via:** The Via header field includes all entries included in the received INVITE request plus the entry of the incoming IBCF-hA2. + +### 2. INVITE request (I-CSCF-hA1 to S-CSCF-hA1) - see example in table 5.9-2. + +When the I-CSCF-hA1 receives the initial INVITE request it queries the SLF/HSS to identify the correct S-CSCF where the call has to be routed to. Due to normal routing procedures the S-CSCF will be allocated by the HSS procedures as described in 3GPP TS 24.229 [4]. + +**Table 5.9-2: INVITE request (I-CSCF-hA1 to S-CSCF-hA1)** + +``` + +INVITE tel:+12375551111 SIP/2.0 + +To: +From: +P-Asserted-Identity: +P-Asserted-Service: +Contact: +CSeq: +Supported: +Route: +Record-Route: ,, +P-Access-Network-Info: +P-Charging-Vector: +or when loopback in the originating path apply then: +P-Charging-Vector: + +Via: SIP/2.0/UDP icscf-hA1.home-A.net;branch=z9hG4bK351g45.13a +Via: SIP/2.0/UDP ibcf-hA2.home-A.net;branch=z9hG4bK351g45.13 +Via: SIP/2.0/UDP ic-T1.interconnection-T.net;branch=z9hG4bK351g45.12 +Via: + +Other SIP header fields and SDP according to 3GPP TS 24.229 [4]. + +``` + +**Request-URI:** Contains the destination address for the INVITE request. In this case the I-CSCF-hA1 changes the URI from a SIP URI user=phone to a tel URI as described in 3GPP TS 24.229 [4]. + +**Via:** The I-CSCF-hA1 adds a Via header field. + +### 3.4. INVITE request (S-CSCF-hA1 to AS-hA1 to S-CSCF-hA1). + +The S-CSCF applies the filter criteria to involve the AS for terminating services. + +**Record-Route:** The entries to this header field need to be added based on the related dip's to the AS. The AS could behave as B2BUA. In such case the AS could store the entries and setup a new Record-Route header field only with the AS URI as an entry. Both the AS-hA1 and the S-CSCF-hA1 adds Record-Route header fields. + +**P-Charging-Vector:** Towards the AS-hA1 the P-Charging-Vector header field contains the type 3 "orig-ioi" identifying the network of the S-CSCF-hA1 sending the request. Towards the S-CSCF-hA1 the P-Charging-Vector header field contains the type 3 "orig-ioi" identifying the network of the AS-hA1 sending the request. + +**Route:** The S-CSCF-hA1 adds a Route header field identifying the selected AS-hA1 and S-CSCF-hA1 for routing back. + +**Via:** Both the AS-hA1 and the S-CSCF-hA1 adds Via header fields. + +**Editor's note:** The behaviour of the transit-ioi value is currently discussed and needs further consideration how the S-CSCF to AS correlation is described. + +### 5. INVITE request (S-CSCF-hA1 to IBCF-hA1) - see example in table 5.9-5. + +Since the call is a terminating call no further specific information is needed for termination of the call. + +The S-CSCF-hA1 sends the INVITE request according to 3GPP TS 24.229 [4] to the IBCF-hA1. + +**Table 5.9-5: INVITE request (S-CSCF-hA1 to IBCF-hA1)** + +``` +INVITE sip:[5555::ddd:aaa:ccc:bbb] SIP/2.0 + +To: +From: +P-Asserted-Identity: +P-Asserted-Service: +Contact: +CSeq: +Supported: +Route:, + , + , + +Record-Route: , + , , + , , + +P-Access-Network-Info: +P-Charging-Vector: icid-value="AyretyU0dm+602IrT5tAFrbHLso=023551024";orig-ioi="Type 1home-a" + +Via: SIP/2.0/UDP scscf-hA1.home-A.net;branch=z9hG4bK351g45.16 +Via: SIP/2.0/UDP as-hA1.home-A.net;branch=z9hG4bK351g45.15 +Via: SIP/2.0/UDP scscf-hA1.home-A.net;branch=z9hG4bK351g45.14 +Via: SIP/2.0/UDP icscf-hA1.home-A.net;branch=z9hG4bK351g45.13a +Via: SIP/2.0/UDP ibcf-hA2.home-A.net;branch=z9hG4bK351g45.13 +Via: SIP/2.0/UDP ic-T1.interconnection-T.net;branch=z9hG4bK351g45.12 +Via: + +Other SIP header fields and SDP according to 3GPP TS 24.229 [4]. +``` + +**Request-URI:** The S-CSCF-hA1 replaces the received tel URI with the SIP URI received in the Contact header field from the UE-A during the registration. + +- Route:** The S-CSCF includes a Route header field with the routing information received in the Path header field during registration. +- P-Charging-Vector:** The S-CSCF-hA1 replaces the received IOI type 3 value in the "orig-ioi" header field parameter with a IOI type 1 value identifying the home network of the UE-A. +- Via:** The S-CSCF-hA1 adds a Via header field. +- Record-Route:** The S-CSCF-hA1 adds a Record-Route header field. + +### 6. INVITE request (IBCF-hA1 to IC-A1) see example in table 5.9-6. + +The IBCF-hA1 applies local policy which is dependent on the operator policy for roaming calls with that specific visited network and the intermediate transit network. Header fields can be deleted or anonymized. + +The IBCF-hA1 selects, based on the Route header field as shown table 5.9-5 or in cases where the Path header field received during registration only points to the visited network, based on local policy, to route the INVITE request via IC network A and sends the INVITE request according to 3GPP TS 24.229 [4] to the IC-A1. + +The IBCF-hA1 determines the next hop IP address from the URI in the first entry of the Route header field either by configured information or using a DNS query according to IETF RFC 3263 [13]. If the subsequent interconnection network is SIP-aware, the determined IP address will belong to the SIP proxy IC-A1. Otherwise the determined IP address will point to IBCF-vA1 and step 7 is skipped (not reflected in message details below). + +The procedures apply to 3GPP TS 24.229 [4]. + +**Table 5.9-6: INVITE request (IBCF-hA1 to IC-A1)** + +``` +INVITE sip:[5555::ddd:aaa:ccc:bbb] SIP/2.0 + +To: +From: +P-Asserted-Identity: +P-Asserted-Service: +Contact: +CSeq: +Supported: +Route:, + , + +Record-Route:, + , + , , + , , + +P-Access-Network-Info: +P-Charging-Vector: + +Via: SIP/2.0/UDP ibcf-hA1.home-A.net;branch=z9hG4bK351g45.17 +Via: SIP/2.0/UDP scscf-hA1.home-A.net;branch=z9hG4bK351g45.16 +Via: SIP/2.0/UDP as-hA1.home-A.net;branch=z9hG4bK351g45.15 +Via: SIP/2.0/UDP scscf-hA1.home-A.net;branch=z9hG4bK351g45.14 +Via: SIP/2.0/UDP icscf-hA1.home-A.net;branch=z9hG4bK351g45.13a +Via: SIP/2.0/UDP ibcf-hA2.home-A.net;branch=z9hG4bK351g45.13 +Via: SIP/2.0/UDP ic-T1.interconnection-T.net;branch=z9hG4bK351g45.12 +Via: + +Other SIP header fields and SDP according to 3GPP TS 24.229 [4]. +``` + +- Via:** The IBCF-hA1 adds a Via header field. +- Record-Route:** The IBCF-hA1 adds a Record-Route header field. + +### 7. INVITE request (IC-A1 to IBCF-vA1) - see example in table 5.9-7. + +NOTE 1: If the interconnection network is SIP-unaware, step 7 is skipped (not reflected in message details below). + +Based on the Route header field, the IC-T1 selects an entry point (IBCF-vA1) of the visited IMS network vA and sends the INVITE request according to 3GPP TS 24.229 [4] to the IBCF-vA1. + +In our example the entry point of visited network vA is already included in the received Route header field. However, the IC-A1 can add a Route header field entry pointing to the entry point of the visited network vA if the entry point is missing. + +**Table 5.9-7: INVITE request (IC-A1 to IBCF-vA1)** + +``` +INVITE sip:[5555::ddd:aaa:ccc:bbb] SIP/2.0 + +To: +From: +P-Asserted-Identity: +P-Asserted-Service: +Contact: +CSeq: +Supported: +Route: , + + +Record-Route: , + , , + , , + , , + +P-Access-Network-Info: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024";orig-ioi="Type 1home- +a";transit-ioi="ICa.1" + +Via: SIP/2.0/UDP ic-A1.interconnection-A.net;branch=z9hG4bK351g45.18 +Via: SIP/2.0/UDP ibcf-hA1.home-A.net;branch=z9hG4bK351g45.17 +Via: SIP/2.0/UDP scscf-hA1.home-A.net;branch=z9hG4bK351g45.16 +Via: SIP/2.0/UDP as-hA1.home-A.net;branch=z9hG4bK351g45.15 +Via: SIP/2.0/UDP scscf-hA1.home-A.net;branch=z9hG4bK351g45.14 +Via: SIP/2.0/UDP icscf-hA1.home-A.net;branch=z9hG4bK351g45.13a +Via: SIP/2.0/UDP ibcf-hA2.home-A.net;branch=z9hG4bK351g45.13 +Via: SIP/2.0/UDP ic-T1.interconnection-T.net;branch=z9hG4bK351g45.12 +Via: + +Other SIP header fields and SDP according to 3GPP TS 24.229 [4]. +``` + +**P-Charging-Vector:** The IC-A1 adds the "transit-ioi" header field parameter identifying the interconnection network (i.e. ICa.1). + +**Via:** The IC-A1 adds a Via header field (i.e. ic-A1.interconnection-A.net). + +**Record-Route:** The IC-A1 adds a Record-Route header field (i.e. ic-A1.interconnection-A.net). + +#### 8. INVITE request (IBCF-vA1 to P-CSCF-vA1) - see example in table 5.9-8. + +The IBCF-vA1 routes the call to the P-CSCF-vA1 as stated within the Route header field. + +IBCF-vA1 applies local policy based on trust relationship with the transit network and SLA between home network carrier and visited network carrier. + +If a "transit-ioi" header field parameter value exists within the P-Charging-Vector header field then the values can be forwarded or made void. + +In this example, the IBCF-vA1 does not add any "transit-ioi" header field parameter in the P-Charging-Vector header field. However, the IBCF-vA1 adds the "transit-ioi" header field parameter based on local policy, when the "transit-ioi" identifying the preceding interconnection network is not included in the received request (e.g. when the preceding interconnection network is not an IMS transit network). + +**Table 5.9-8: INVITE request (IBCF-vA1 to P-CSCF-vA1)** + +``` +INVITE sip:[5555::ddd:aaa:ccc:bbb] SIP/2.0 + +To: +From: +P-Asserted-Identity: +P-Asserted-Service: +Contact: +CSeq: +Supported: +``` + +``` + +Route: +Record-Route: , , + , , + , , + , + , + + +P-Access-Network-Info: +P-Charging-Vector: + +Via: SIP/2.0/UDP ibcf-vA1.visited-A.net;branch=z9hG4bK351g45.19 +Via: SIP/2.0/UDP ic-A1.interconnection-A.net;branch=z9hG4bK351g45.18 +Via: SIP/2.0/UDP ibcf-hA2.home-A.net;branch=z9hG4bK351g45.17 +Via: SIP/2.0/UDP scscf-hA1.home-A.net;branch=z9hG4bK351g45.16 +Via: SIP/2.0/UDP as-hA1.home-A.net;branch=z9hG4bK351g45.15 +Via: SIP/2.0/UDP scscf-hA1.home-A.net;branch=z9hG4bK351g45.14 +Via: SIP/2.0/UDP icscf-hA1.home-A.net;branch=z9hG4bK351g45.13a +Via: SIP/2.0/UDP ibcf-hA2.home-A.net;branch=z9hG4bK351g45.13 +Via: SIP/2.0/UDP ic-T1.interconnection-T.net;branch=z9hG4bK351g45.12 +Via: + +Other SIP header fields and SDP according to 3GPP TS 24.229 [4]. + +``` + +**Record-Route:** The IBCF-vA1 adds a Record-Route header field (i.e. IBCF-vA1). + +**Via:** The IBCF-vA1 adds a Via header field (i.e. IBCF-vA1). + +### 9. INVITE request (P-CSCF-vA1 to UE-A) - see example in table 5.9-9. + +The P-CSCF-vA1 routes the call to the UE-A as stated within Request-URI which contains the address of the UE-A. + +Based on privacy settings within the INVITE request, the P-CSCF-vA1 applies privacy according to IETF RFC 3323 [27] and IETF RFC 3325 [28]. + +The P-CSCF-vA1 applies trust domain according to 3GPP TS 24.229 [4] clause 4.4. This will result in that some header fields will be removed. In our example the P-Charging-Vector header field and the P-Access-Network-Info header field are removed from the outgoing INVITE request. + +The P-CSCF-vA1 sends the INVITE request according to 3GPP TS 24.229 [4] to the UE-A. + +**Table 5.9-9: INVITE request (P-CSCF-vA1 to UE-A)** + +``` + +INVITE sip:[5555::ddd:aaa:ccc:bbb] SIP/2.0 + +To: +From: +P-Asserted-Identity: +P-Asserted-Service: +Contact: +CSeq: +Supported: + +Record-Route: , + , , + , , + , , + , + , + + +Via: SIP/2.0/UDP pcscf-vA1.visited-A.net:5060;branch=z9hG4bKnas56565 +Via: SIP/2.0/UDP ibcf-vA1.visited-A.net;branch=z9hG4bK351g45.19 +Via: SIP/2.0/UDP ic-A1.interconnection-A.net;branch=z9hG4bK351g45.18 +Via: SIP/2.0/UDP ibcf-hA1.home-A.net;branch=z9hG4bK351g45.17 +Via: SIP/2.0/UDP scscf-hA1.home-A.net;branch=z9hG4bK351g45.16 +Via: SIP/2.0/UDP as-hA1.home-A.net;branch=z9hG4bK351g45.15 +Via: SIP/2.0/UDP scscf-hA1.home-A.net;branch=z9hG4bK351g45.14 +Via: SIP/2.0/UDP icscf-hA1.home-A.net;branch=z9hG4bK351g45.13a +Via: SIP/2.0/UDP ibcf-hA2.home-A.net;branch=z9hG4bK351g45.13 +Via: SIP/2.0/UDP ic-T1.interconnection-T.net;branch=z9hG4bK351g45.12 +Via: + +Other SIP header fields and SDP according to 3GPP TS 24.229 [4]. + +``` + +**Via:** The P-CSCF-vA1 adds a Via header field. + +**Record-Route:** The P-CSCF-vA1 adds a Record-Route header field. + +#### **10-18. 183 (Session Progress) response (UE-A to IBCF-hA2 via all intermediate nodes in the Via header fields) - see example in table 5.9-10.** + +The UE-A sends a 183 (Session Progress) response since 100rel and preconditions are supported by the remote UE. + +The routing towards the IBCF-hA2 is based on the Via header fields received by the UE-A in the initial INVITE request. + +When the IBCF-hA2 receives the 183 (Session Progress) response, the IBCF-hA2 sends the 183 (Session Progress) response according to 3GPP TS 24.229 [4] towards the remote UE as described within clause 5.3 or clause 5.4 of this document and regarding the rules defined in 3GPP TS 24.229 [4]. + +The table 5.9-10 shows the content of the 183 (Session Progress) response when sent by IBCF-hA1. + +**Table 5.9-10: SIP 183 (Session Progress) response (UE-A to IBCF-hA1) in step 14** + +``` +SIP/2.0 183 Session Progress + +To: ;tag=654a +From: ;tag=4fa3 +P-Asserted-Identity: +Contact: +CSeq: 1 INVITE +Require:100rel,precondition + +Via: SIP/2.0/UDP scscf-hA1.home-A.net;branch=z9hG4bK351g45.16 +Via: SIP/2.0/UDP as-hA1.home-A.net;branch=z9hG4bK351g45.15 +Via: SIP/2.0/UDP scscf-hA1.home-A.net;branch=z9hG4bK351g45.14 +Via: SIP/2.0/UDP icscf-hA1.home-A.net;branch=z9hG4bK351g45.13a +Via: SIP/2.0/UDP ibcf-hA2.home-A.net;branch=z9hG4bK351g45.13 +Via: SIP/2.0/UDP ic-T1.interconnection-T.net;branch=z9hG4bK351g45.12 +Via: + +Record-Route: , + , , + , , + , , + , , + + +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024";orig-ioi="Type 1home-a";transit-ioi="ICa.1";term-ioi="Type 1visited-a" + +Other SIP header fields and SDP according to 3GPP TS 24.229 [4]. +``` + +**Require:** The UE-A inserts the Require header field containing the option-tag "100rel" indicating reliable sending of the 183 (Session Progress) response and the option-tag "precondition" indicating the usage of the precondition mechanism. + +**P-Charging-Vector:** The settings of the IOI values are important: + +- in step 11 the "term-ioi" header field parameter includes a type 1 IOI value which identifies the visited network of the terminating user (i.e. "visited-a"). The "orig-ioi" header field parameter is set to the same type 1 IOI value that was included in the initial INVITE request by the home network hA (i.e. "home-a") towards the terminating user; +- in step 12 no change of ioi values; +- in step 13-14 the "transit-ioi" header field parameter includes one or more values identifying the transit networks passed between the visited network A and home network A; In our example only one value identifying the interconnect network A is included. If no "transit-ioi" header field parameter is included in step 13, the IBCF-hA1 can include a "transit-ioi" header field parameter value identifying the preceding interconnect network. + +- in step 15-16 the "term-ioi" header field parameter includes a type 3 IOI value (prefix "Type 3") which identifies the AS-hA1 network. The "orig-ioi" header field parameter is set to the same type 3 IOI value that was included in the initial INVITE request from the S-CSCF-hA1 to the AS-hA1, the "transit-ioi" is deleted by the S-CSCF based on the operator policy; and +- in steps 17-18 the "term-ioi" header field parameter includes a type 2 IOI value which identifies the home network hA. The "transit-ioi" header field parameter is not appearing. The S-CSCF removes received "transit-ioi" values, the IOI Type 1 or Type 3 in "orig-ioi" and "term-ioi" header field parameters. The "orig-ioi" header field parameter is set to the same type 2 IOI value that was included in the initial INVITE request from the remote home network or, in case of loopback, from the remote visited network. The "term-ioi" header field parameter is set to a Type 2 IOI value identifying the home network A. + +NOTE 2: If the interconnection network is SIP-unaware, step 13 is skipped. + +#### **19. PRACK requests (IBCF-hA2 to UE-A via all intermediate nodes) and SIP 200 (OK) response to the SIP PRACK request (UE-A to IBCF-hA2 via all intermediate nodes).** + +The PRACK request and the 200 (OK) response to the PRACK request are sent without any SDP offer/SDP answer between the IBCF-hA2 and the UE-A according to 3GPP TS 24.229 [4]. The messages are sent via all intermediate nodes with the exception of I-CSCF-hA1. + +#### **20. UPDATE requests (IBCF-hA2 to UE-A via all intermediate nodes) and SIP 200 (OK) response to the SIP UPDATE request (UE-A to IBCF-hA2 via all intermediate nodes).** + +When resources are reserved in the access network of the remote UE, the IBCF-hA2 receives an UPDATE request from the remote network. The IBCF-hA2 forwards the request towards the UE-A. The messages are sent via all intermediate nodes with the exception of I-CSCF-hA1. + +#### **22-30. 180 (Ringing) response to the SIP INVITE request (UE-A to IBCF-hA2 via all intermediate nodes).** + +NOTE 3: If the interconnection network is SIP-unaware, step 24 is skipped. The messages are sent via all intermediate nodes including the I-CSCF-hA1. + +#### **31. PRACK requests (IBCF-hA2 to UE-A via all intermediate nodes) and SIP 200 (OK) response to the SIP PRACK request (UE-A to IBCF-hA2 via all intermediate nodes).** + +The PRACK request and the 200 (OK) response to the PRACK request are sent without any SDP offer/SDP answer between the UE-A and the IBCF-hA2 according to 3GPP TS 24.229 [4]. The messages are sent via all intermediate nodes with the exception of I-CSCF-hA1. + +#### **32-39. 200 (OK) response to the SIP INVITE request (IBCF-hA2 to UE-A).** + +NOTE 4: If the interconnection network is SIP-unaware, step 34 is skipped. + +##### **40-48. ACK requests (IBCF-hA2 to UE-A via all intermediate nodes).** + +The IBCF-hA2 receives an ACK request which acknowledges the 200 (OK) final response, from the remote network. The IBCF-hA2 forwards the ACK request to the UE-A according to 3GPP TS 24.229 [4]. + +NOTE 5: If the interconnection network is SIP-unaware, step 46 is skipped. + +## 5.10 Insertion of service related media in the originating home network + +### 5.10.1 General + +This clause describes insertion of a service related media in the originating home network (i.e. invocation of MRFC/MRF). + +3GPP TS 24.628 [22] describes how to include announcements into the path for IMS. There are a couple of options which have to be considered for roaming. + +The following sections are showing some examples where service related media can be included. The examples will not cover all possible scenarios defined within 3GPP. + +### 5.10.2 Insertion of service related media in the originating home network with loopback + +![Sequence diagram illustrating the insertion of service related media in the originating home network with loopback. The diagram shows the interaction between UE-A, P-CSCF-vA1, TRF-vA1, IBCF-vA1, IC-A1, IBCF-hA1, S-CSCF-hA1, AS-hA1/MRFC, MRFP-hA, and IC-T1 across four network domains: Visited Network A, IC network A, Home network A, and IC network T. The process involves an INVITE request from UE-A, evaluation of filter criteria by S-CSCF-hA1, service logic decision by AS-hA1/MRFC, resource reservation by MRFP-hA, and subsequent announcement and interaction steps. The diagram also shows the return of 183 and 199 responses, and the final 180 Ringing / 200 OK / ACK response.](b87818c8505328b198d035761bbc3f2d_img.jpg) + +``` + +sequenceDiagram + participant UE-A + participant P-CSCF-vA1 + participant TRF-vA1 + participant IBCF-vA1 + participant IC-A1 + participant IBCF-hA1 + participant S-CSCF-hA1 + participant AS-hA1/MRFC + participant MRFP-hA + participant IC-T1 + + Note over Visited Network A: Visited Network A + Note over IC network A: IC network A + Note over Home network A: Home network A + Note over IC network T: IC network T + + UE-A->>P-CSCF-vA1: 1. INVITE + P-CSCF-vA1->>TRF-vA1: 2. INVITE + TRF-vA1->>IBCF-vA1: 3. INVITE + IBCF-vA1-->>IC-A1: 4. INVITE + IC-A1-->>IBCF-hA1: 5. INVITE + IBCF-hA1->>S-CSCF-hA1: 5. INVITE + S-CSCF-hA1->>AS-hA1/MRFC: 6. Evaluation of filter criteria + AS-hA1/MRFC->>MRFP-hA: 7. INVITE + MRFP-hA->>AS-hA1/MRFC: 8. Service logic decides to start announcement + AS-hA1/MRFC->>MRFP-hA: 9. Reserve resources for Announcement + MRFP-hA-->>S-CSCF-hA1: 10. 183 + S-CSCF-hA1-->>IBCF-hA1: 11. 183 + IBCF-hA1-->>IC-A1: 12. 183 + IC-A1-->>IBCF-vA1: 13. 183 + IBCF-vA1-->>TRF-vA1: 14. 183 + TRF-vA1-->>P-CSCF-vA1: 15. 183 + P-CSCF-vA1-->>UE-A: 15. 183 + Note over all: 16. PRACK / 200 OK + AS-hA1/MRFC->>MRFP-hA: 17. Interaction to start announcement + MRFP-hA-->>AS-hA1/MRFC: 18. Announcement + AS-hA1/MRFC->>MRFP-hA: 19. Interaction to indicate that announcement is sent + MRFP-hA-->>AS-hA1/MRFC: 20. Interaction to release resources reserved for announcement + MRFP-hA-->>S-CSCF-hA1: 21. 199 + S-CSCF-hA1-->>IBCF-hA1: 22. 199 + IBCF-hA1-->>IC-A1: 23. 199 + IC-A1-->>IBCF-vA1: 24. 199 + IBCF-vA1-->>TRF-vA1: 25. 199 + TRF-vA1-->>P-CSCF-vA1: 26. 199 + P-CSCF-vA1-->>UE-A: 26. 199 + AS-hA1/MRFC->>MRFP-hA: 27. INVITE + MRFP-hA-->>AS-hA1/MRFC: 28. INVITE + AS-hA1/MRFC->>S-CSCF-hA1: 29. INVITE + S-CSCF-hA1-->>IBCF-hA1: 30. INVITE + IBCF-hA1-->>IC-A1: 31. INVITE + IC-A1-->>IBCF-vA1: 32. INVITE + IBCF-vA1-->>TRF-vA1: 33. INVITE + TRF-vA1-->>P-CSCF-vA1: 34. 180 Ringing / 200 OK / ACK + P-CSCF-vA1-->>UE-A: 34. 180 Ringing / 200 OK / ACK + +``` + +Sequence diagram illustrating the insertion of service related media in the originating home network with loopback. The diagram shows the interaction between UE-A, P-CSCF-vA1, TRF-vA1, IBCF-vA1, IC-A1, IBCF-hA1, S-CSCF-hA1, AS-hA1/MRFC, MRFP-hA, and IC-T1 across four network domains: Visited Network A, IC network A, Home network A, and IC network T. The process involves an INVITE request from UE-A, evaluation of filter criteria by S-CSCF-hA1, service logic decision by AS-hA1/MRFC, resource reservation by MRFP-hA, and subsequent announcement and interaction steps. The diagram also shows the return of 183 and 199 responses, and the final 180 Ringing / 200 OK / ACK response. + +**Figure 5.10.2-1: Announcement started during the establishment of a communication** + +The calling party initiates a communication by means of an INVITE request. The INVITE request is forwarded toward the called party. + +Along the signalling path, created by the INVITE request, some service logic in an application server (AS) wants to send an announcement towards the calling party. + +The flow is based on the assumptions that the Supported header field includes the option-tag "100rel", option-tag "precondition" and option-tag "199" indicating support of the reliable provisional responses, the precondition mechanism and the 199 (Early Dialog Terminated) provisional responses, respectively. + +NOTE 1: If precondition mechanism is used, the procedures according to 3GPP TS 24.229 [4] apply. + +The steps of the signalling flow are as follows: + +#### 1-5. INVITE request (UE-A to S-CSCF-hA1 via P-CSCF-vA1, IBCF-vA1, IC-A1 and IBCF-hA1). + +The INVITE request is sent as described within clause 5.4.2. + +NOTE 2: Upon generating an initial INVITE request using the precondition mechanism, the UE-A will indicate the support for the precondition mechanism and specify it using the Supported header field mechanism. If the desired QoS resources have not been reserved at the UE-A when constructing the SDP offer, the UE-A will indicate the related local preconditions for QoS as not met. + +NOTE 3: If the interconnection network is SIP-unaware, step 4 is skipped. + +#### 6. Evaluation of initial filter criteria. + +The S-CSCF-hA1 validates the service profile of this subscriber and evaluates the initial filter criteria. For this example, assume an application server/MRFC involvement. + +#### **7. INVITE request (S-CSCF-hA1 to AS-hA1 /MRFC) - see example in table 5.3.2-6.** + +The S-CSCF-hA1 applies the same procedure as in step 6 in clause 5.3.2. + +#### **8. Service logic in AS-hA1 /MRFC.** + +Service logic in the AS-hA1 decides to send an announcement to the calling party. In such a case the AS-hA1 acts as a B2BUA. Thus an early dialog for the announcement and two dialogs will be created in the final call state one from UE-A to the AS-hA1 and one from the AS-hA1 to the terminating UE which allows end-to-end communication. + +#### **9. MRFC-MRFP interaction.** + +The MRFC interacts with the MRFP in order to reserve resources for the announcement. As part of the interaction with MRFP the AS-hA1 receives the necessary media parameters e.g. IP address and port numbers and provide the IP address and port number for the calling party to the MRFP. + +#### **10-15. 183 (Session Progress) response (AS-hA1 to UE-A via S-CSCF-hA1, IBCF-hA1, IC-A1, IBCF-vA1 and P-CSCF-vA1).** + +The AS-hA1 sends a 183 (Session progress) response to S-CSCF-hA1. The response includes: + +- a) an answer to the SDP received in the INVITE request; + +NOTE 4: The AS-hA1 will include in the 183 (Session progress) response the Require header field with the option-tag "100rel" to indicate reliable sending of the 183 (Session Progress) response. If precondition mechanism is used, the AS-hA1 will include in the SDP answer an indication that the related local preconditions for QoS are fulfilled and will include in the Require header field the option-tag "precondition" to indicate the usage of the precondition mechanism. + +- b) a P-Early-Media header field set to "sendonly" in case where only announcement will be played. For invoking an interactive voice response system a P-Early-Media header field is set to "sendrecv"; and +- c) the Require header field set to "100rel". + +NOTE 5: If the interconnection network is SIP-unaware, step 13 is skipped. + +#### **16. PRACK request /200 (OK) response to the PRACK request (UE-A to AS-hA1 / AS-hA1 to UE-A).** + +NOTE 6: If precondition mechanism is used and the UE-A indicated in the initial SDP offer the related local preconditions for QoS as not met the UE-A will include in the SDP offer sent within the PRACK request an indication that the local preconditions for QoS are fulfilled. Otherwise, if local preconditions for QoS are not fulfilled when sending the PRACK request, the UE-A will use the UPDATE request to send the SDP offer indicating that the local preconditions for QoS are fulfilled, but that case is outside the scope of the present example. + +#### **17. MRFC-MRFP interaction to start the announcement.** + +The MRFC interacts with the MRFP in order to start the announcement. + +#### **18. Announcement sending (MRFP-hA to UE-A).** + +The MRFP sends the announcement towards the calling party. + +#### **19. MRFC-MRFP interaction to stop the announcement.** + +The complete announcement is sent and the MRFP interacts with the AS-hA1/MRFC in order to inform that the announcement is terminated. + +#### **20. MRFC-MRFP interaction to release the resources used for the announcement.** + +The MRFC interacts with the MRFP in order to release the resources used for the announcement. + +#### **21-26. 199 (Early Dialog Terminated) response (AS-hA1 to UE-A via S-CSCF-hA1, IBCF-hA1, IC-A1, IBCF-vA1 and P-CSCF-vA1) (optional).** + +If the originating UE-A has indicated support of the 199 (Early Dialog Terminated) response code, the AS-hA1 sends a 199 (Early Dialog Terminated) provisional response towards the originating UE-A to terminate the early dialog between itself and the UE-A. + +NOTE 7: If the interconnection network is SIP-unaware, step 24 is skipped. + +#### **27. INVITE request (AS-hA1 to S-CSCF-hA1).** + +The AS-hA1 sends the INVITE request towards the S-CSCF-hA1. The INVITE request contains the same information as the INVITE request shown in table 5.4.2.-7, see step 7 in clause 5.4.2. + +#### **28-33. INVITE request (S-CSCF-hA1 to IC-T1 via IBCF-hA1, IC-A1, IBCF-vA1, TRF-vA1 and IBCF-vA1).** + +The S-CSCF-hA1 decides to loopback the INVITE request and forwards the call to the terminating home network via the originating visited network vA. + +The SDP contained within the INVITE will be manipulated along the signalling path as shown in the example in 3GPP TS 29.079 [5] clause A.6. + +NOTE 8: If the interconnection network is SIP-unaware, step 30 is skipped and step 33 is executed between IBCF-vA1 and IBCF-hB instead. + +#### **34. 180 (Ringing) response /200 (OK) response to the INVITE request / ACK request (IC-T1 to UE-A via IBCF-vA1, TRF-vA1, IBCF-vA1, IC-A1, IBCF-hA1, S-CSCF-hA1, AS-hA1, S-CSCF-hA1, IBCF-hA1, IC-A1, IBCF-vA1 and P-CSCF-vA1).** + +When the UE-A of the calling party receives the 200 (OK) response to the INVITE request and optional steps 21- 26 were not performed, the UE-A can regard the early dialog created for the announcement between the UE-A and the AS-hA1 as terminated. The UE-A sends the ACK request to acknowledge the reception of the 200 (OK) final response to the INVITE request. + +NOTE 9: The loopback-indication header field parameter is included in the P-Charging-Vector header field. + +### 5.10.3 Insertion of service related media in the originating home network without loopback + +![Sequence diagram illustrating the insertion of service related media in the originating home network without loopback. The diagram shows the interaction between UE-A, P-CSCF-vA1, TRF-vA1, IBCF-vA1, IC-A1, IBCF-hA1, S-CSCF-hA1, AS-hA1/MRFC, MRFP-hA, and IC-B1 across four network domains: Visited network A, IC network A, Home network A, and IC network B. The process involves INVITE request forwarding, filter criteria evaluation, service logic decision, resource reservation, announcement interaction, and final response handling.](64cda8ce20067bc360ce2f3a5c9352b7_img.jpg) + +``` + +sequenceDiagram + participant UE-A + participant P-CSCF-vA1 + participant TRF-vA1 + participant IBCF-vA1 + participant IC-A1 + participant IBCF-hA1 + participant S-CSCF-hA1 + participant AS-hA1/MRFC + participant MRFP-hA + participant IC-B1 + + Note left of UE-A: Visited network A + Note left of IBCF-vA1: IC network A + Note left of S-CSCF-hA1: Home network A + Note left of IC-B1: IC network B + + UE-A->>P-CSCF-vA1: 1. INVITE + P-CSCF-vA1->>TRF-vA1: 2. INVITE + TRF-vA1->>IBCF-vA1: 3. INVITE + IBCF-vA1->>IC-A1: 4. INVITE + IC-A1->>IBCF-hA1: 5. INVITE + IBCF-hA1->>S-CSCF-hA1: 6. Evaluation of filter criteria + S-CSCF-hA1->>AS-hA1/MRFC: 7. INVITE + AS-hA1/MRFC->>AS-hA1/MRFC: 8. Service logic decides to start announcement + AS-hA1/MRFC->>MRFP-hA: 9. Reserve resources for Announcement + AS-hA1/MRFC->>S-CSCF-hA1: 10. 183 + S-CSCF-hA1->>IBCF-hA1: 11. 183 + IBCF-hA1->>IC-A1: 12. 183 + IC-A1->>IBCF-vA1: 13. 183 + IBCF-vA1->>TRF-vA1: 14. 183 + TRF-vA1->>P-CSCF-vA1: 15. 183 + P-CSCF-vA1->>UE-A: 16. PRACK / 200 OK + AS-hA1/MRFC->>MRFP-hA: 17. Interaction to start announcement + MRFP-hA->>AS-hA1/MRFC: 18. Announcement + AS-hA1/MRFC->>MRFP-hA: 19. Interaction to indicate that announcement is sent + MRFP-hA->>AS-hA1/MRFC: 20. Interaction to release resources reserved for announcement + AS-hA1/MRFC->>S-CSCF-hA1: 21. 199 + S-CSCF-hA1->>IBCF-hA1: 22. 199 + IBCF-hA1->>IC-A1: 23. 199 + IC-A1->>IBCF-vA1: 24. 199 + IBCF-vA1->>TRF-vA1: 25. 199 + TRF-vA1->>P-CSCF-vA1: 26. 199 + P-CSCF-vA1->>UE-A: 27. INVITE + AS-hA1/MRFC->>IC-B1: 28. INVITE + AS-hA1/MRFC->>S-CSCF-hA1: 29. 180 Ringing / 200 OK / ACK + +``` + +Sequence diagram illustrating the insertion of service related media in the originating home network without loopback. The diagram shows the interaction between UE-A, P-CSCF-vA1, TRF-vA1, IBCF-vA1, IC-A1, IBCF-hA1, S-CSCF-hA1, AS-hA1/MRFC, MRFP-hA, and IC-B1 across four network domains: Visited network A, IC network A, Home network A, and IC network B. The process involves INVITE request forwarding, filter criteria evaluation, service logic decision, resource reservation, announcement interaction, and final response handling. + +**Figure 5.10.3-1: Announcement started during the establishment of a communication** + +The calling party initiates a communication by means of an INVITE request. The INVITE request is forwarded toward the called party. + +Along the signalling path, created by the INVITE request, some service logic in an application server (AS) wants to send an announcement towards the calling party. + +The flow is based on the assumptions that the Supported header field includes the option-tag "100rel", option-tag "precondition" and option-tag "199" indicating support of the reliable provisional responses, the precondition mechanism and the 199 (Early Dialog Terminated) provisional responses, respectively. + +NOTE 1: If precondition mechanism is used, the procedures according to 3GPP TS 24.229 [4] apply. + +The steps of the signalling flow are as follows: + +#### 1-5. INVITE request (UE-A to S-CSCF-hA1 via P-CSCF-vA1, IBCF-vA1, IC-A1 and IBCF-hA1). + +The INVITE request is sent as described within clause 5.3.2. + +NOTE 2: Upon generating an initial INVITE request using the precondition mechanism, the UE-A will indicate the support for the precondition mechanism and specify it using the Supported header field mechanism. If the desired QoS resources have not been reserved at the UE-A when constructing the SDP offer, the UE-A will indicate the related local preconditions for QoS as not met. + +NOTE 3: If the interconnection network is SIP-unaware, step 4 is skipped. + +#### 6. Evaluation of initial filter criteria. + +The S-CSCF-hA1 validates the service profile of this subscriber and evaluates the initial filter criteria. For this example, assume an application server/MRFC involvement. + +#### 7. INVITE request (S-CSCF-hA1 to AS-hA1 /MRFC) - see example in table 5.3.2-6. + +The S-CSCF-hA1 applies the same procedure as in step 6 in clause 5.3.2. + +#### 8. Service logic in AS-hA1 /MRFC. + +Service logic in the AS-hA1 decides to send an announcement to the calling party. In such a case the AS-hA1 acts as a B2BUA. Thus an early dialog for the announcement and two dialogs will be created in the final call state one from UE-A to the AS-hA1 and one from the AS-hA1 to the terminating UE which allows end-to-end communication. + +##### 9. MRFC-MRFP interaction. + +The MRFC interacts with the MRFP in order to reserve resources for the announcement. As part of the interaction with MRFP the AS-hA1 receives the necessary media parameters e.g. IP address and port numbers and provide the IP address and port number for the calling party to the MRFP. + +#### 10-15. 183 (Session Progress) response (AS-hA1 to UE-A via S-CSCF-hA1, IBCF-hA1, IC-A1, IBCF-vA1 and P-CSCF-vA1)). + +The AS-hA1 sends a 183 (Session progress) response to the S-CSCF-hA1. The response includes: + +- a) an answer to the SDP received in the INVITE request; + +NOTE 4: The AS-hA1 will include in the 183 (Session progress) response the Require header field with the option-tag "100rel" to indicate reliable sending of the 183 (Session Progress) response. If precondition mechanism is used, the AS-hA1 will include in the SDP answer an indication that the related local preconditions for QoS are fulfilled and will include in the Require header field the option-tag "precondition" to indicate the usage of the precondition mechanism. + +- b) a P-Early-Media header field set to "sendonly" in case where only announcement will be played. For invoking an interactive voice response system a P-Early-Media header field is set to "sendrecv"; and +- c) the Require header field set to "100rel". + +NOTE 5: If the interconnection network is SIP-unaware, step 13 is skipped. + +#### 16. PRACK request / 200 (OK) response to the PRACK request (UE-A to AS-hA1 / AS-hA1 to UE-A). + +NOTE 6: If precondition mechanism is used and the UE-A indicated in the initial SDP offer the related local preconditions for QoS as not met the UE-A will include in the SDP offer sent within the PRACK request an indication that the local preconditions for QoS are fulfilled. Otherwise, if local preconditions for QoS are not fulfilled when sending the PRACK request, the UE-A will use the UPDATE request to send the SDP offer indicating that the local preconditions for QoS are fulfilled, but that case is outside the scope of the present example. + +#### 17. MRFC-MRFP interaction to start the announcement. + +The MRFC interacts with the MRFP in order to start the announcement. + +#### 18. Announcement sending (MRFP-hA to UE-A). + +The MRFP sends the announcement towards the calling party. + +#### 19. MRFC-MRFP interaction to stop the announcement. + +The complete announcement is sent and the MRFP interacts with the AS-hA1/MRFC in order to inform that the announcement is terminated. + +#### 20. MRFC-MRFP interaction to release the resources used for the announcement. + +The MRFC interacts with the MRFP in order to release the resources used for the announcement. + +#### **21-26. 199 (Early Dialog Terminated) response (AS-hA1 to UE-A via S-CSCF-hA1, IBCF-hA1, IC-A1, IBCF-vA1 and P-CSCF-vA1) (optional).** + +If the originating UE-A has indicated support of the 199 (Early Dialog Terminated) response code, the AS-hA1 sends a 199 (Early Dialog Terminated) provisional response towards the originating UE-A to terminate the early dialog between itself and the UE-A. + +NOTE 7: If the interconnection network is SIP-unaware, step 24 is skipped. + +#### **27. INVITE request (AS-hA1 to S-CSCF-hA1).** + +The AS-hA1 sends the INVITE request towards the S-CSCF-hA1. The INVITE request contains the same information as the INVITE request shown in table 5.3.2.-7, see step 7 in clause 5.3.2. + +#### **28. INVITE request (S-CSCF-hA1 to IC-T1).** + +The S-CSCF-hA1 decides not to loopback the INVITE request and forwards the call to the remote network. + +#### **29. 180 (Ringing) response / 200 (OK) response to the INVITE request / ACK request (IC-T1 to UE-A via S-CSCF-hA1, AS-hA1, S-CSCF-hA1, IBCF-hA1, IC-A1, IBCF-vA1 and P-CSCF-vA1).** + +When the UE-A of the calling party receives the 200 (OK) response to the INVITE request and optional steps 21- 26 were not performed, the UE can regard the early dialog created for the announcement between the UE-A and the AS-hA1 as terminated. The UE-A sends the ACK request to acknowledge the reception of the 200 (OK) final response to the INVITE request. + +## 5.11 PS to CS SRVCC access transfer scenarios + +### 5.11.1 General + +This clause describes PS to CS SRVCC access transfer scenarios including the registration and the additional message flow due to PS to CS SRVCC. + +For IMS roaming PS to CS SRVCC procedure with media anchoring in the ATGW of the visited network and signalling anchored in the SCC AS of the home network is used. + +In case of PS to CS SRVCC the media path between the visited network and the home network needs to be re-established since the SIP dialogue between the ATCF in the visited network and the SCC AS in the home network is re-established. + +From viewpoint of the remote side the signalling anchors do not change due to the PS to CS SRVCC. However, the media anchors changes due to the PS to CS SRVCC in case of "originating roaming to home network without loopback" (see clause 5.3) since the CS target access leg is created using a new IBCF. + +From the viewpoint of the IC network between the visited network and the home network this results in release of one connection and establishment of other connection, whereby the IC network is not aware about any link between these two connections. However, if the same IC network is used charging correlation can be done by means of the "related-icid" header field parameter in the P-Charging-Vector header field. + +The 3GPP TS 24.237 [20] defines two types of MSC servers. One MSC server enhanced for ICS and another MSC server enhanced for SIP supporting PS to CS SRVCC. The message flows are the same if PS to CS SRVCC occurs so in the following subclauses both variants of MSC servers are referred to as "MSC server". The only difference between the two types is that when the MSC server is enhanced for ICS, the MSC server will register the user following the procedures in clause 5.2 when the PS to CS SRVCC access transfer procedure is completed. + +NOTE: Once the user is registered by the MSC server, calls initiated by the UE will look the same as described in clause 5.3 and clause 5.4. + +### 5.11.2 PS to CS SRVCC information transfer during registration + +This clause describes the PS to CS SRVCC access transfer specifics during registration. + +Preconditions to this flow are: + +- the conditions in clause 5.2.2 are fulfilled; and + +- both the visited network support PS to CS access transfer and MSC servers in the network are enhanced to use SIP signalling towards the IMS. + +Figure 5.11.2-1 shows the message flow when a UE registers in IMS over PS before SRVCC occurs as described in clause 5.11.3. + +![Sequence diagram showing SRVCC information transfer during registration. The diagram illustrates the interaction between a UE-A in the Visited network vA and various network elements in the IC network A and Home network hA. The sequence starts with the UE-A sending a REGISTER request to the P-CSCF-vA1. The request is then forwarded through the ATCF-vA1, IBCF-vA1, and IC-A1 to the IBCF-hA1, I-CSCF-hA1, S-CSCF-hA1, and finally to the SCC AS hA1. The SCC AS hA1 stores the STN-SR in the HSS. The response path follows the 200 OK messages back through the chain. A MESSAGE request is also shown being sent from the SCC AS hA1 back to the UE-A via the P-CSCF-vA1.](d0654bc33a544f31c1cb3e0cd77e0aab_img.jpg) + +Sequence diagram showing SRVCC information transfer during registration. The diagram illustrates the interaction between a UE-A in the Visited network vA and various network elements in the IC network A and Home network hA. The sequence starts with the UE-A sending a REGISTER request to the P-CSCF-vA1. The request is then forwarded through the ATCF-vA1, IBCF-vA1, and IC-A1 to the IBCF-hA1, I-CSCF-hA1, S-CSCF-hA1, and finally to the SCC AS hA1. The SCC AS hA1 stores the STN-SR in the HSS. The response path follows the 200 OK messages back through the chain. A MESSAGE request is also shown being sent from the SCC AS hA1 back to the UE-A via the P-CSCF-vA1. + +**Figure 5.11.2-1: SRVCC information transfer during registration** + +The steps of the flow are as follows: + +- 1. The UE-A registers in IMS and receives a 401 (Unauthorized) response.** + +The flow is the same as in clause 5.2.2 with the exception that the ATCF is included in the registration path. + +- 2. REGISTER request (UE-A to P-CSCF-vA1) - see example in table 5.11.2-2.** + +The UE-A sends a REGISTER request again (now with an authentication challenge response included) as described clause 5.2.2. + +**Table 5.11.2-2: REGISTER request (UE-A to P-CSCF-vA1)** + +``` +REGISTER sip:home-A.net SIP/2.0 + +From: ;tag=4fa3 +To: +P-Access-Network-Info: 3GPP-E-UTRAN-TDD;utran-cell-id-3gpp=234151D0FCE11 +Supported: path +Contact: ;reg-id=1;+sip.instance="";expires=600000;+g.3gpp.ics="principal";+g.3gpp.accesstype="cellular1" +CSeq: 10 REGISTER + +Via:SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd];branch=z9hG4bKnashds7 + +Other SIP header fields are set according to 3GPP TS 24.229 [4] and 3GPP TS 24.237 [20]. +``` + +**Request-URI:** The Request-URI sip:home-A.net (the URI that follows the method name, "REGISTER", in the first line) indicates the destination domain of this REGISTER request which is the home network. + +**From:** Set to the SIP URI that is the default public user identity of the user A i.e. userA\_public1@home-A.net. + +**To:** Set to the SIP URI that is the default public user identity of the user A i.e. userA\_public1@home-A.net. + +**Supported:** The UE-A inserts the Supported header field containing the option-tag "path". + +#### 3. REGISTER request (P-CSCF-vA1 to ATCF-vA1) - see example in table 5.11.2-3. + +When the P-CSCF-vA1 receives the REGISTER request, the P-CSCF-vA1 forwards the REGISTER request to an ATCF-vA1 according to local policy. The content of the REGISTER request is not different from the content of the REGISTER request in clause 5.2.2. + +**Table 5.11.2-3: REGISTER request (P-CSCF-vA1 to ATCF-vA1)** + +``` +REGISTER sip:home-A.net SIP/2.0 + +From: +To: +P-Access-Network-Info: 3GPP-E-UTRAN-TDD;utran-cell-id-3gpp=234151D0FCE11,3GPP-E-UTRAN-TDD; utran- +cell-id-3gpp=234151D0FCE11;network-provided;local-time-zone="UTC+01:00";daylight-saving-time="01" +Supported: +Contact: +CSeq: +Require: path +Route: +Path: +P-Visited-Network-ID: "Visited Network Number A" +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024";orig-ioi="Type 1visited-a" + +Via:SIP/2.0/UDP pcscf-vA1.visited-A.net:5060;branch=z9hG4bKnas56565 +Via:SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd];branch=z9hG4bKnashds7 + +Other SIP header fields are set according to 3GPP TS 24.229 [4]. +``` + +**P-Access-Network-Info:** The P-CSCF-vA1 adds the network provided location including the "local-time-zone" and "daylight saving time" header field parameters. The location information received from the UE-A is kept since it does not indicate that it is network provided. + +**Require:** The P-CSCF-vA1 adds the Require header field containing the option-tag "path" to ensure that the recipient correctly handles the Path header field. If the recipient does not support the Path header field, a SIP response will be received with a status code of 420 and an Unsupported header field indicating the option-tag "path". Such a response indicates a wrong configuration of the routing tables and the request has been routed outside the IM CN subsystem. + +**Route:** The P-CSCF-vA1 adds the Route header field with the address of the ATCF-vA1. + +**Path:** This is the address of the P-CSCF-vA1 and is included to inform the S-CSCF where to route terminating requests. The Path header field includes traffic leg information in the iot1 SIP URI parameter according to IETF RFC 7549 [26]. + +**P-Visited-Network-ID:** The P-CSCF-vA1 adds the P-Visited-Network-ID header field containing the identifier of the P-CSCF network. This may be the visited network domain name or any other identifier that identifies the visited network at the home network. + +**Via:** The P-CSCF-vA1 adds a Via header field in the REGISTER request. + +**P-Charging-Vector:** The P-CSCF-vA1 provides an ICID value and adds a type 1 "orig-ioi" header field parameter with the IOI value identifying the visited network (i.e. "visited-a"). + +#### 4. REGISTER request (ATCF-vA1 to IBCF-vA1) - see example in table 5.11.2-4. + +When the ATCF-vA1 receives the REGISTER request, the ATCF-vA1 updates its database for registrations and selects an IBCF according to local policy for routing the REGISTER request towards the home network. + +**Table 5.11.2-4: REGISTER request (ATCF-vA1 to IBCF-vA1)** + +``` +REGISTER sip:home-A.net SIP/2.0 + +From: +To: +P-Access-Network-Info: +Supported: +Contact: +CSeq: +Require: +Route: +``` + +``` + +Path: , +P-Visited-Network-ID: +P-Charging-Vector: +Feature-Caps:*;+g.3gpp.atcf="";+g.3gpp.atcf-mgmt-uri="";+g.3gpp.atcf-path="";+g.3gpp.mid-call;+g.3gpp.srvcc-alerting;+g.3gpp.ps2cs-srvcc-orig-pre-alerting + +Via:SIP/2.0/UDP atcf-vA1.visited-A.net:5060;branch=z9hG4bKaa3689b +Via:SIP/2.0/UDP pcscf-vA1.visited-A.net:5060;branch=z9hG4bKnas56565 +Via:SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd];branch=z9hG4bKnashds7 + +Other SIP header fields are set according to 3GPP TS 24.229 [4] and 3GPP TS 24.237 [20]. + +``` + +**Route:** The ATCF-vA1 adds the Route header field identifying the selected IBCF-vA1. + +**Path:** The ATCF-vA1 adds its address for terminating requests in the Path header field. + +**Feature-Caps:** The ATCF-vA1 adds a number of feature-capability indicators in the Feature-Caps header field. + +- The g.3gpp.atcf capability-indicator includes the STN-SR that will be used during PS to CS access transfer by the MSC server. +- The g.3gpp.atcf-mgmt-uri feature-capability indicator includes the URI that will be used by the SCC AS when sending the MESSAGE request with the PS to CS SRVCC information to the ATCF-vA1 The URI includes an "iotl" SIP URI parameter according to IETF RFC 7549 [26]. +- The g.3gpp.atcf-path feature-capability indicator is used by ATCF to identify the registration in its database for registrations and will be included by SCC AS in the MESSAGE request with the PS to CS SRVCC information sent to the ATCF-vA1. +- The g.3gpp.mid-call, g.3gpp.srvcc-alerting and g.3gpp.ps2cs-srvcc-orig-pre-alerting feature-capability indicators are included to indicate which PS to CS SRVCC features the visited network supports. + +**Via:** The ATCF-vA1 adds a Via header field in the REGISTER request. + +#### 5-8. REGISTER request (IBCF-vA1 to S-CSCF-hA1 via IC-A1, IBCF-hA1 and I-CSCF-hA1) - see example in table 5.11.2-8. + +When the IBCF-vA1 receives the REGISTER request, the IBCF-vA1 forwards the REGISTER request in the same way as in clause 5.2.2. There is no more SRVCC specific information added in the REGISTER request. + +The table 5.11.2-8 shows the content of the REGISTER request when received in the S-CSCF-hA1. + +**Table 5.11.2-8: REGISTER request (I-CSCF-hA1 to S-CSCF-hA1) in step 8** + +``` + +REGISTER sip:home-A.net SIP/2.0 + +From: +To: +P-Access-Network-Info: +Supported: +Contact: +CSeq: +Require: +Route: +Path: ,,,, +P-Visited-Network-ID: +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024";orig-ioi="Type 1visited-a";transit-ioi="ICa.1" +Feature-Caps: + +Via:SIP/2.0/UDP icscf-hA1.home-A.net;branch=z9hG4bK351g45.3 +Via:SIP/2.0/UDP ibcf-hA1.home-A.net;branch=z9hG4bK351g45.2 +Via:SIP/2.0/UDP ic-A1.interconnection-A.net;branch=z9hG4bK78a3z +Via:SIP/2.0/UDP ibcf-vA1.visited-A.net;branch=z9hG4bK351g45.1 +Via:SIP/2.0/UDP atcf-vA1.visited-A.net:5060;branch=z9hG4bKaa3689b +Via:SIP/2.0/UDP pcscf-vA1.visited-A.net:5060;branch=z9hG4bKnas56565 +Via:SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd];branch=z9hG4bKnashds7 + +Other SIP header fields are set according to 3GPP TS 24.229 [4]. + +``` + +- Path:** The address of the IBCF-vA1 acting as an exit point added by the IBCF-vA1. +Based on SLA between IC partners and roaming partners the address of the IC-A1 added by IC-A1. +The address of the IBCF-hA1 acting as an entry point added by the IBCF-hA1. +- Route:** The I-CSCF-hA1 adds the address of the selected S-CSCF. +- Via:** The IBCF-vA1 added a Via header field. +The IC-A1 added a Via header field. +The IBCF-hA1 added a Via header field. +The I-CSCF-vA1 added a Via header field. + +- P-Charging-Vector:** The "transit-ioi" header field parameter with an IOI value identifying the transit network (i.e. "ICa") added by IC-A1. + +NOTE 1: If the interconnection network is SIP-unaware, step 6 is skipped. + +#### 9-16. 200 (OK) response (S-CSCF-hA1 to UE-A). + +The S-CSCF-hA1 acknowledges the REGISTER request by means of a 200 (OK) response as described in clause 5.2.2. The 200 (OK) response does not contain any SRVCC specific information more than that the ATCF-vA1 is included in the Path header field and in the Via header field. + +NOTE 2: If the interconnection network is SIP-unaware, step 13 is skipped. + +#### 17. REGISTER request (S-CSCF-hA1 to SCC AS-hA1) - see example in table 5.11.2-17. + +The S-CSCF-hA1 checks the iFC triggers and detects that the SCC AS-hA1 is interested in registrations from this user. The S-CSCF-hA1 sends a 3rd party REGISTER request to the SCC AS-hA1. The S-CSCF-hA1 includes in the 3rd party REGISTER request the contents of the initial REGISTER request and the 200 (OK) response to the initial REGISTER request in "sip" message bodies. + +**Table 5.11.2-17: REGISTER request (S-CSCF-hA1 to SCC AS-hA1)** + +``` +REGISTER sip:sccas.home-A.net /2.0 + +To: +From: ; tag=538ya +Contact: ; expires=600000 +CSeq: 10 REGISTER +P-Charging-Vector: icid-value="AyretyU0dm+602IrT5tAFrbHLso=023551024";orig-ioi="Type 3home-a" + +Via: SIP/2.0/TCP scscf-hA1.home-A.net;branch=z9hG499ffhy + +Content-Type: multipart/mixed;boundary="boundary1" +Content-Length: (...) + +--boundary1 +Content-Type: message/sip + +REGISTER sip:home-A.net SIP/2.0 +From: ;tag=4fa3 +To: +P-Access-Network-Info: 3GPP-E-UTRAN-TDD;utran-cell-id-3gpp=234151D0FCE11,3GPP-E-UTRAN-TDD; utran-cell-id-3gpp=234151D0FCE11;network-provided;local-time-zone="UTC+01:00";daylight-saving-time="01" +Supported: path +Contact: ;reg-id=1;+sip.instance="urn:gsma:imei:90420156-025763-0";expires=600000;+g.3gpp.ics="principal";+g.3gpp.accessstype="cellular1" +CSeq: 12 REGISTER +Require: path +Path: , + , + , + , + +P-Visited-Network-ID: "Visited Network Number A" +P-Charging-Vector: icid-value="AyretyU0dm+602IrT5tAFrbHLso=023551024";orig-ioi="Type 1visited-a";transit-ioi="ICa.1" +Feature-Caps:*;+g.3gpp.atcf="tel:+1-237-555-3333";+g.3gpp.atcf-mgmt-uri="sip:atcf-vA1.visited-A.net;iotl=homeB-visitedB";+g.3gpp.atcf-path="sip:termabc@atcf-vA1.visited-A.net";+g.3gpp.mid-call;+g.3gpp.srvcc-alerting;+g.3gpp.ps2cs-srvcc-orig-pre-alerting +``` + +``` + +Via:SIP/2.0/UDP icscf-hA1.home-A.net;branch=z9hG4bK351g45.3 +Via:SIP/2.0/UDP ibcf-hA1.home-A.net;branch=z9hG4bK351g45.2 +Via:SIP/2.0/UDP ic-A1.interconnection-A.net;branch=z9hG4bK78a3z +Via:SIP/2.0/UDP ibcf-vA1.visited-A.net;branch=z9hG4bK351g45.1 +Via:SIP/2.0/UDP atcf-vA1.visited-A.net:5060;branch=z9hG4bKaa3689b +Via:SIP/2.0/UDP pcscf-vA1.visited-A.net:5060;branch=z9hG4bKnas56565 +Via:SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd];branch=z9hG4bKnashds7 + +--boundary1 +Content-Type: message/sip + +SIP/2.0 200 OK +From: ;tag=4fa3 +To: ;tag=5ef4 +CSeq: 10 REGISTER +P-Associated-URI: , +Contact: ;reg-id=1;+sip.instance="";expires=600000;+g.3gpp.ics="principal";+g.3gpp.accessstype="cellular1" +Service-Route: ;iotl=visitedA-homeA> +P-Charging-Vector: icid-value="AyretyU0dm+6O2IrT5tAFrbHLso=023551024";orig-ioi="Type 1visited-a";term-ioi="Type 1home-a" +Relayed-Charge: SCSCF:transit-ioi="ICa.1" +Path: , + , + , + , ;iotl=homeB-visitedB> + +Via:SIP/2.0/UDP icscf-hA1.home-A.net;branch=z9hG4bK351g45.3 +Via:SIP/2.0/UDP ibcf-hA1.home-A.net;branch=z9hG4bK351g45.2 +Via:SIP/2.0/UDP ic-A1.interconnection-A.net;branch=z9hG4bK78a3z +Via:SIP/2.0/UDP ibcf-vA1.visited-A.net;branch=z9hG4bK351g45.1 +Via:SIP/2.0/UDP atcf-vA1.visited-A.net:5060;branch=z9hG4bKaa3689b +Via:SIP/2.0/UDP pcscf-vA1.visited-A.net:5060;branch=z9hG4bKnas56565 +Via:SIP/2.0/UDP [5555::aaa:bbb:ccc:ddd];branch=z9hG4bKnashds7 +--boundary1 + +``` + +Other SIP header fields are set according to 3GPP TS 24.229 [4]. + +**P-Charging-Vector:** The S-CSCF-hA1 inserts the "orig-ioi" header field parameter with a type 3 IOI value identifying the home network hA. + +**Relayed-Charge:** The S-CSCF adds the Relayed-Charge header field set to the value received in the "transit-ioi" header field in the P-Charging-Vector. The S-CSCF is set as the source. + +**Via:** The S-CSCF-hA1 adds a Via header field. + +#### 18. 200 (OK) response (SCC AS-hA1 to S-CSCF-hA1). + +The SCC AS-hA1 acknowledges the REGISTER request by means of a 200 (OK) response. There is no specific SRVCC access transfer information added by SCC AS-hA1 in the 200 (OK) response. + +#### 19. The SCC AS-hA1 stores the STN-SR in HSS. + +The SCC AS-hA1 stores the STN-SR () received in the "+g.3gpp.atcf" Feature-Caps header field parameter in HSS. This information will later be transferred to the MSC server when a PS to CS SRVCC access transfer occurs as described in clause 5.11.3. + +#### 20. MESSAGE request (SCC AS-hA1 to IBCF-hA1) - see example in table 5.11.2-20. + +In order to inform about PS to CS SRVCC access transfer parameters necessary for the ATCF-vA1 during PS to CS SRVCC access transfer, the SCC AS-hA1 sends a MESSAGE request to the IBCF-hA1. + +**Table 5.11.2-20: MESSAGE request (SCC AS-hA1 to IBCF-hA1)** + +``` + +MESSAGE sip:atcf-vA1.visited-A.net;iotl=homeB-visitedB SIP/2.0 + +From: ;tag=123e5 +To: +Cseq: 100 MESSAGE +P-Asserted-Identity: +P-Charging-Vector: icid-value="BrtA76543y+403fg654tBf456fa=023551024";orig-ioi="Type 1home-a" +Content-Length: (...) + +``` + +``` +Content-Type: application/vnd.3gpp.SRVCC-info+xml +Route: + +Via: SIP/2.0/UDP sccas-hA1.home-A.net:5060;branch=z9hG4bK78956a +``` + +``` + + + + sip:sccas-hA1.home-A.net;iot1=visitedA-homeA + tel:+1-237-555-1111 + + +``` + +Other SIP header fields are set according to 3GPP TS 24.229 [4] and 3GPP TS 24.237 [20]. + +**Request-URI/To:** Contains the address received in the g.3gpp.atcf-mgmt-uri feature-capability indicator, including traffic leg information in an "iot1" SIP URI parameter according to IETF RFC 7549 [26]. + +**P-Asserted-Identity/From:** Includes the SCC AS-hA1 address. + +**P-Charging-Vector:** The SCC AS-hA1 assigns a new ICID value and includes a type 1 IOI value in the "orig-ioi" header field parameter. The type IOI value identifies the home network hA. + +**Via:** The SCC AS-hA1 adds a Via header field. + +**application/vnd.3gpp.SRVCC-info+xml:** Contains the PS to CS SRVCC specific information that will be used by the ATCF-vA1 when SRVCC occurs as described in clause 5.11.3. + +- The SRVCC-info ATCF-Path-URI identifies the registration in the ATCF-vA1. +- The ATU-STI is the address of the SCC AS where the INVITE request will be sent to in the event of a PS to CS SRVCC access transfer. The ATU-STI includes traffic leg information in an "iot1" SIP URI parameter according to IETF RFC 7549 [26]. +- C-MSISDN is the public user identity of the user that the ATCF-vA1 is using to identify the user in the event of a PS to CS SRVCC access transfer. + +#### 21. MESSAGE request (IBCF-hA1 to IC-A1) - see example in table 5.11.2-21. + +The IBCF-hA1 selects to route the MESSAGE request via an IC network and sends the MESSAGE request according to 3GPP TS 24.229 [4] to the IC-A1. The IBCF-hA1 determines the next hop IP address from the request URI either by configured information or using a DNS query according to IETF RFC 3263 [13]. If the subsequent interconnection network is SIP-aware, the determined IP address will belong to the SIP proxy IC-A1. Otherwise the determined IP address will point to IBCF-vA1 and step 22 is skipped (not reflected in message details below). + +**Table 5.11.2-21: MESSAGE request (IBCF-hA1 to IC-A1)** + +``` +MESSAGE sip:atcf-vA1.visited-A.net;iot1=homeB-visitedB SIP/2.0 + +From: +P-Asserted-Identity: +To: +CSeq: +P-Charging-Vector: +Content-Length: +Content-Type: +Route: + +Via:SIP/2.0/UDP ibcf-hA1.home-A.net:5060;branch=z9hG4bK123456 +Via:SIP/2.0/UDP sccas-hA1.home-A.net:5060;branch=z9hG4bK78956a + + + + + sip:sccas-hA1.home-A.net + tel:+1-237-555-1111 + + +``` + +Other SIP header fields are set according to 3GPP TS 24.229 [4]. + +- Route:** The IBCF-hA1 adds a Route header field identifying the selected node in the IC network A. +- Via:** The IBCF-hA1 adds a Via header field. + +#### 22. MESSAGE request (IC-A1 to IBCF-vA1) - see example in table 5.11.2-22. + +The IC-A1 selects an IBCF acting as the entry point in the visited network vA and sends the MESSAGE request according to 3GPP TS 24.229 [4] to the IBCF-vA1. + +NOTE 3: If the interconnection network is SIP-unaware, step 22 is skipped. + +**Table 5.11.2-22: MESSAGE request (IC-A1 to IBCF-vA1)** + +``` +MESSAGE sip:atcf-vA1.visited-A.net;iotl=homeB-visitedB SIP/2.0 + +From: +P-Asserted-Identity: +To: +CSeq: +P-Charging-Vector: icid-value="BrtA76543y+403fg654tBf456fa=023551024";orig-ioi="Type 1home- +a";transit-ioi="ICa.1" +Content-Length: ... +Content-Type: +Route: + +Via:SIP/2.0/UDP ic-A1.interconnection-A.net:5060;branch=z9hG4bKasdfg +Via:SIP/2.0/UDP ibcf-hA1.home-A.net:5060;branch=z9hG4bK123456 +Via:SIP/2.0/UDP sccas-hA1.home-A.net:5060;branch=z9hG4bK78956a + + + + + sip:sccas-hA1.home-A.net;iotl=visitedA-homeA + tel:+1-237-555-1111 + + +``` + +Other SIP header fields are set according to 3GPP TS 24.229 [4]. + +- P-Charging-Vector:** The IC-A1 adds the "transit-ioi" header field parameter with an IOI value identifying the transit network (i.e. "ICa"). +- Route:** The IC-A1 adds a Route header field identifying the selected entry point in the visited network vA. +- Via:** The IC-A1 adds a Via header field. + +#### 23. MESSAGE request (IBCF-vA1 to ATCF-vA1) - see example in table 5.11.2-23. + +When the IBCF-vA1 receives the MESSAGE request, the IBCF-vA1 retrieves the address of the ATCF-vA1 (e.g. by performing a DNS query or using a local database) and forwards the MESSAGE request to the ATCF-vA1. + +In this example, the IBCF-vA1 does not add any "transit-ioi" header field parameter in the P-Charging-Vector header field. However, the IBCF-vA1 adds the "transit-ioi" header field parameter based on local policy, when the "transit-ioi" identifying the preceding interconnection network is not included in the received request (e.g. when the preceding interconnection network is not an IMS transit network). + +**Table 5.11.2-23: MESSAGE request (IBCF-vA1 to ATCF-vA1)** + +``` +MESSAGE sip:atcf-vA1.visited-A.net;iotl=homeB-visitedB SIP/2.0 + +From: +P-Asserted-Identity: +To: +CSeq: +P-Charging-Vector: +Content-Length: ... +Content-Type: + +Via:SIP/2.0/UDP ibcf-vA1.visited-A.net:5060;branch=z9hG4bK1kjhg12 +``` + +``` +Via:SIP/2.0/UDP ic-A1.interconnection-A.net:5060;branch=z9hG4bKasdfg +Via:SIP/2.0/UDP ibcf-hA1.home-A.net:5060;branch=z9hG4bK123456 +Via:SIP/2.0/UDP sccas-hA1.home-A.net:5060;branch=z9hG4bK78956a + + + + + sip:sccas-hA1.home-A.net;iot1=visitedA-homeA + tel:+1-237-555-1111 + + +``` + +Other SIP header fields are set according to 3GPP TS 24.229 [4]. + +**Via:** The IBCF-vA1 adds a Via header field. + +**24-27. 200 (OK) response (ATCF-vA1 to SCC AS-hA1 via IBCF-vA1, IC-A1 and IBCF-hA1) - see example in table 5.11.2-27.** + +The ATCF-vA1 acknowledges the receipt of the MESSAGE request by means of a 200 (OK) response according to 3GPP TS 24.229 [4]. No SRVCC specific parameters are included in the 200 (OK) response. + +The table 5.11.2-27 shows the content of the 200 (OK) response when received in the SCC AS-hA1. + +**Table 5.11.2-27: 200 (OK) response (IBCF-hA1 to SCC AS-hA1) in step 27** + +``` +SIP/2.0 200 OK + +P-Charging-Vector: icid-value="BrtA76543y+403fg654tBf456fa=023551024";orig-ioi="Type 1home-a";term- +ioi="Type 1visited-a"; transit-ioi="ICa.1" +From: ;tag=123e5 +To: ;tag=678f9 +CSeq: 100 MESSAGE + +Via: SIP/2.0/UDP sccas-hA1.home-A.net:5060;branch=z9hG4bK78956a + +Other SIP header fields are set according to 3GPP TS 24.229 [4] and 3GPP TS 24.237 [20]. +``` + +**P-Charging-Vector:** The ATCF-vA1 added a P-Charging-Vector header field with the same "icid-value" and the same "orig-ioi" header field parameter value as received in the MESSAGE request and a type 1 IOI value in a "term-ioi" header field parameter identifying the visited network vA. + +The IC-A1 added the "transit-ioi" header field parameter with an IOI value identifying the transit network (i.e. "ICa"). + +NOTE 4: If the interconnection network is SIP-unaware, step 26 is skipped. + +### 5.11.3 PS to CS SRVCC access transfer for a call in the active phase without loopback + +This clause describes the PS to CS SRVCC access transfer of a call in the active phase. + +Preconditions to this call flow: + +1. a call is established between a UE-A and a remote UE as described in clause 5.3. The UE-A is attached to a 4G radio access network (E-UTRAN); +2. media is anchored in: + - a. the P-CSCF-vA1, the ATCF-vA1 and IBCF-vA1 in the visited network vA; + - b. the IC-A1 in the IC network A; and + - c. the IBCF-hA1 and the IBCF-hA2 in the home network hA; and +3. SIP signalling is anchored in SCC AS-hA1. + +NOTE 1: The signalling flow is the same for PS to CS SRVCC access transfer for a call in the active phase regardless if the UE-A or the remote UE initiated the call. + +Figure 5.11.3-1 shows the SIP message flow when PS to CS SRVCC access transfer of a call in the active phase occurs. + +![Sequence diagram showing SRVCC without loop back message flow. Lifelines: UE-A, MSC server-vA1, P-CSCF-vA1, ATCF-vA1, IBCF-vA1, IC-A1, IBCF-hA1/I-CSCF, S-CSCF-hA1, SCC AS-hA1, IBCF-hA2. The diagram is divided into three network zones: Visited network vA, IC network A, and Home network hA. The flow starts with call establishment (Step 1) and SRVCC HO occurs (Step 2). Subsequent steps (3-24) show the SIP signaling for the handover, including INVITE, 200 OK, ACK, and re-INVITE messages between the UE, MSC server, and various CSCFs and ASes. Media paths are indicated by double-headed arrows at the top and bottom of the diagram.](886963464425186f4a465fa8155d2a3c_img.jpg) + +Sequence diagram showing SRVCC without loop back message flow. Lifelines: UE-A, MSC server-vA1, P-CSCF-vA1, ATCF-vA1, IBCF-vA1, IC-A1, IBCF-hA1/I-CSCF, S-CSCF-hA1, SCC AS-hA1, IBCF-hA2. The diagram is divided into three network zones: Visited network vA, IC network A, and Home network hA. The flow starts with call establishment (Step 1) and SRVCC HO occurs (Step 2). Subsequent steps (3-24) show the SIP signaling for the handover, including INVITE, 200 OK, ACK, and re-INVITE messages between the UE, MSC server, and various CSCFs and ASes. Media paths are indicated by double-headed arrows at the top and bottom of the diagram. + +NOTE: For clarity, the SIP 100 (Trying) messages are not shown in the signalling flow. + +**Figure 5.11.3-1: SRVCC without loop back message flow** + +The steps of the flow are as follows: + +#### **1. A call is established as described in clause 5.3 between UE-A and a remote UE.** + +- The remote UE can be a UE connected to IMS or an UE connected to CS and the difference compared to the description in clause 5.3 and this PS to CS SRVCC access transfer scenario is that an ATCF in the visited originated network participated in the call establishment of the call and that the general AS-hA1 in figure 5.3.2-1 is replaced by the access transfer specific AS i.e. the SCC AS-hA1. +- The media path is UE-A – P-CSCF-vA1 – ATCF-vA1 – IBCF-vA1 – IC-A1 – IBCF-hA1 – IBCF-hA2 – remote network – remote UE. + +NOTE 2: If the interconnection network is SIP-unaware, or if IC-A1 is only a SIP proxy rather than a SIP-ALG with attached SIP-AGW, IC-A1 is not in the media path. + +#### **2. SRVCC handover occurs.** + +During the ongoing call the UE-A is performing measurements on signalling strength in neighbouring cells and sends continuously the measurement results to the core network. Due to decreasing signalling strength in the 4G radio access network the core network takes a decision that the UE shall be handed over to a 3G radio access network and sends a PS to CS SRVCC request to the MSC server-vA1. + +#### **3. INVITE request due to STN-SR (MSC server-vA1 to ATCF-vA1) - see example in table 5.11.3-3.** + +- When the MSC server-vA1 receives the PS to CS SRVCC request from the core network in the visited network, the MSC server-vA1 sends an INVITE request to the ATCF-vA1. This INVITE request is referred to as an "INVITE request due to STN-SR" in the 3GPP TS 24.237 [20]. + +**Table 5.11.3-3: INVITE request due to STN-SR (MSC server-vA1 to ATCF-vA1)** + +``` +INVITE tel:+1-237-555-3333 SIP/2.0 + +From: ;tag=171828 +To: +P-Asserted-Identity: +P-Access-Network-Info: 3GPP-UTRAN-TDD;utran-cell-id-3gpp=151234D0EAF22;network-provided;local-time- +zone="UTC+01:10";daylight-saving-time="01" +P-Charging-Vector: icid-value="023551024"; orig-ioi="Type 1visited-a";icid-generated-at="msc- +vA1.visited-A.net" +Contact: +g.3gpp.icsi-ref="urn%3Aurn-7%3A3gpp- +service.ims.icsi.mmtel";+g.3gpp.srvcc-alerting;+g.3gpp.mid-call;+ps2cs-srvss-orig-pre-alerting +CSeq: 11 INVITE +Accept: "application/vnd.3gpp.state-and-event-info+xml" +Recv-Info: g.3gpp.state-and-event +Supported:norefersub,100rel, precondition + +Via:SIP/2.0/UDP msc-vA1.visited-A.net;branch=z9hG4bk7987fe + +Other SIP header fields and SDP according to 3GPP TS 24.229 [4] and 3GPP TS 24.237 [20]. +``` + +**Request-URI /To:** The tel URI (referred to as STN-SR) identifies the ATCF-vA1. The STN-SR is stored by SCC AS-hA1 in HSS during registration of the user as described in clause 5.11.2 and sent to the MSC server-vA1 in the PS to CS SRVCC request from the core network. + +**P-Access-Network-Info:** This header field identifies the location of the UE in the 3G access network, the time-zone and daylight saving on that location. + +**P-Charging-Vector:** The MSC server-vA1 adds the P-Charging-Vector header field containing a new ICID value in the "icid", "icid-generated-at" and "orig-ioi" header field parameters. The IOI value is of type 1 and identifies the visited network vA. + +**P-Asserted-Identity/From:** The P-Asserted identity and the From header fields is the C-MSISDN and that is not necessary the same identity used in the original call. For example: In the original call the P-Asserted-Identity header field could be adam@homenetwork.net. + +**Contact:** The Contact header field can, additional to the contact address, include a number of media feature tags. In this example the g.3gpp.icsi-ref indicates that this is an MMTel call, the g.3gpp.srvcc-alerting indicates that the MSC server-vA1 supports PS to CS access transfer for call in alerting phase, the g.3gpp.mid-call indicates that the MSC server-vA1 supports transfer of held calls and conference calls and the ps2cs-srvss-orig-pre-alerting indicates that the MSC server-vA1 supports PS to CS SRVCC access transfer for calls in the originating pre-alerting phase. The media-feature tags will be used by the SCC AS-vA1 to determine which sessions to be transferred. + +**Accept:** The MSC server-vA1 adds an Accept header field containing the MIME type application/vnd.3gpp.state-and-event-info+xml. + +**Recv-Info:** The MSC server-vA1 adds a Recv-Info header field containing the g.3gpp.state-and-event package name. + +**Supported:** The MSC server indicates option tags to indicate supported feature. + +#### 4. 200 (OK) response (ATCF-vA1 to MSC server-vA1) – see example in table 5.11.3-4. + +When the ATCF-vA1 receives the INVITE due to STN-SR the ATCF-vA1 checks if there is a session that fulfils conditions for being transferred and detects that there is a call in an active phase ongoing between UE-A and a remote UE. To avoid speech gaps, the ATCF-vA1 returns a 200 (OK) response towards the MSC server-vA1 containing media parameters retrieved from the ATGW. + +The ATCF-vA1 also adds the "related-icid" header field parameter containing the "icid-value" header fields parameter used in the original call and can be used for charging correlation of generated CDR records in the visited network A (i.e. "visited-a"). + +**Table 5.11.3-4: 200 (OK) response (ATCF-vA1 to MSC server-vA1)** + +``` + +SIP/2.0 200 OK + +From: ;tag=171828 +To: ;tag=271818 +Record-Route: +P-Charging-Vector: icid-value="023551024";icid-generated-at="msc-vA1.visited-A.net";orig-ioi="Type +1visited-a";term-ioi="Type 1home-a";related-icid="AyretyU0dm+6O2IrT5tAFrbHLso=023551024" +Feature-Caps:*;+g.3gpp.srvcc-alerting,*;+g.3gpp.mid-call,*;+ps2cs-srvss-orig-pre-alerting +Contact: +CSeq: 11 INVITE +P-Asserted-Identity: , + +Via: SIP/2.0/UDP msc-vA1.visited-A.net;branch=z9hG4bk7987fe + +Other SIP header fields and SDP according to 3GPP TS 24.229 [4] and 3GPP TS 24.237 [20]. + +``` + +**Record-Route:** The ATCF adds its own address in the header field which will be used by the MSC server-vA1 for subsequent SIP requests. + +**P-Charging-Vector:** The P-Charging-Vector contains the parameters received in the INVITE due to STN-SR and the related-icid header field parameter containing the ICID value received in the session to be transferred. + +**Editor's note:** Whether the P-Charging-Vector shall contain term-ioi and/or transit-ioi or not is FFS. At the moment the term-ioi and transit-ioi is not currently specified in 3GPP TS 24.237 [20]. + +**Feature-Caps:** The feature-capability indicators as received on the home leg in the session to be transferred. + +**Contact:** The contact address of the remote UE is included. + +**P-Asserted-Identity:** The public user identity of the remote UE is included. + +#### 5. ACK request (MSC-vA1 to ATCF-vA1). + +The MSC server-vA1 sends the ACK to the ATCF-vA1 according to 3GPP TS 24.229 [4]. The ACK request does not contain any SRVCC specific information. + +#### 6. INVITE request due to ATU-STI (ATCF-vA1 to IBCF-vA1) - see example in table 5.11.3-6. + +The ATCF-vA1 creates a new dialog towards SCC AS-hA1 by sending an INVITE due to ATU-STI. Everything except the Request line and the Via header field is copied from the received INVITE due to STN-SR. + +**Table 5.11.3-6: INVITE request due to ATU-STI (ATCF-vA1 to IBCF-vA1)** + +``` + +INVITE sip:ps2cs@sccas1.home-A.net;iotl=visitedA-homeA SIP/2.0 + +From: ;tag=171828 +To: +Route: +P-Asserted-Identity: +P-Access-Network-Info: 3GPP-UTRAN-TDD;utran-cell-id-3gpp=151234D0EAF22;network-provided; +local-time-zone="UTC+01:10";daylight-saving-time="01" +P-Charging-Vector: icid-value="023551024"; orig-ioi="Type 1visited-a"; +icid-generated-at="msc-vA1.visited-A.net" +Record-Route: +Contact: ;+g.3gpp.icsi-ref="urn%3Aurn-7%3A3gpp- +service.ims.icsi.mmtel";+g.3gpp.srvcc-alerting;+g.3gpp.mid-call;+ps2cs-srvss-orig-pre-alerting +CSeq: 11 INVITE +Accept: "application/vnd.3gpp.state-and-event-info+xml" +Recv-Info: g.3gpp.state-and-event +Target-Dialog: me03a0s09a2sdfgjkl491777; remote-tag=774321; local-tag=4fa3 +Required: tdialog +Supported:norefersub + +Via: SIP/2.0/UDP atcf-vA1.visited-A.net;branch=z9hG4bk731b87 + +Other SIP header fields and SDP according to 3GPP TS 24.229 [4] and 3GPP TS 24.237 [20]. + +``` + +**Request-URI:** The SIP URI (referred to as ATU-STI) identifies the SCC AS-hA1. The ATU-STI is sent by SCC AS-hA1 to ATCF-vA1 during registration as described in clause 5.11.2. The + +Request-URI includes traffic information in an "iotl" SIP URI parameter according to IETF RFC 7549 [26]. + +**Record-Route:** The address that the ATCF-vA1 wants to receive subsequent in-dialog requests from the SCC AS-hA1. + +**Target-Dialog:** The identity of the dialog selected by ATCF-vA1. + +**Required:** The "tdialog" option tag indicates that the support for Target-Dialog header field is required. + +**Via:** The ATCF-vA1 adds a Via header field. + +#### 7. INVITE request due to ATU-STI (IBCF-vA1 to IC-A1) - see example in table 5.11.3-7. + +When the IBCF-vA1 receives the INVITE due to ATU-STI, the IBCF-vA1 updates the SDP as described within 3GPP TS 29.079 [5]. + +The IBCF-vA1 selects, based on local policy, to route the INVITE request due to ATU-STI via interconnect network A and sends the request according to 3GPP TS 24.229 [4] to the IC-A1. The IBCF-vA1 determines the next hop IP address from the SIP request URI, either by configured information or using a DNS query according to IETF RFC 3263 [13]. If the subsequent interconnection network is SIP-aware, the determined IP address will belong to the SIP proxy IC-A1. Otherwise the determined IP address will point to IBCF-vA1 and step 22 is skipped (not reflected in message details below). + +**Table 5.11.3-7: INVITE request due to ATU-STI (IBCF-vA1 to IC-A1)** + +``` +INVITE sip:ps2cs@sccas1.home-A.net;iotl=visitedA-homeA SIP/2.0 + +From: +To: +Route: +P-Access-Network-Info: +P-Charging-Vector: +Record-Route: , +P-Asserted-Identity: +Contact: +CSeq: +Accept: +Recv-Info: +Target-Dialog: +Require: +Supported: + +Via: SIP/2.0/UDP ibcf-vA1.visited-A.net;branch=z9hG4bk79c54a +Via: SIP/2.0/UDP atcf-vA1.visited-A.net;branch=z9hG4bk7987fe + +Other SIP headerfields and SDP according to 3GPP TS 24.229 [4] and 3GPP TS 29.079 [5]. +``` + +**Record-Route:** Based on topology hiding functionality the IBCF-vA1 will either forward the Record-Route header field with: + +- one visible IBCF-vA1 entry and the ATCF-vA1 entry as one hidden entry; or +- both the IBCF-vA1 entry and the ATCF-vA1 entry as visible entries. + +**Via:** Based on topology hiding functionality the IBCF-vA1 will either forward the Via header fields with: + +- one visible IBCF-vA1 entry and the ATCF-vA1 entry as one hidden entry; or +- both the IBCF-vA1 entry and the ATCF-vA1 entry as visible entries. + +NOTE 3: In the example above both the IBCF-vA1 entry and the ATCF-vA1 entry are forwarded as visible entries in the Via and Record-Route header fields. + +#### 8. INVITE request due to ATU-STI (IC-A1 to IBCF-hA1) - see example in table 5.11.3-8. + +NOTE 4: If the interconnection network is SIP-unaware, step 8 is skipped. + +When the IC-A1 receives the initial INVITE request due to ATU-STI and since the IC-A1 according to local policy allows itself to be bypassed by media then the IC-A1 updates the SDP as described within 3GPP TS 29.079 [5]. + +The IC-A1 selects an entry point (IBCF-hA1) of the home IMS network hA and sends the INVITE request according to 3GPP TS 24.229 [4] to the IBCF-hA1. + +NOTE 5: The IC-A1 can add a Route header field entry pointing to the entry point of home network hA. However, since this is not necessary for routing the call it is not shown in table 5.11.3-8. + +**Table 5.11.3-8: INVITE request due to ATU-STI (IC-A1 to IBCF-hA1)** + +``` +INVITE sip:ps2cs@sccs1.home-A.net;iotl=visitedA-homeA SIP/2.0 + +From: +To: +P-Access-Network-Info: +P-Charging-Vector: icid-value="023551024";orig-ioi="Type 1visited-a"; + icid-generated-at="msc-vA1.visited-A.net";transit-ioi="ICa.1" +Target-Dialog: +Require: +Record-Route: , , + +P-Asserted-Identity: +Contact: +CSeq: +Accept: +Recv-Info: +Supported: + +Via: SIP/2.0/UDP ic-A1.interconnection-A.net;branch=z9hG4bk73eb11 +Via: SIP/2.0/UDP ibcf-vA1.visited-A.net;branch=z9hG4bk79c54a +Via: SIP/2.0/UDP atcf-vA1.visited-A.net;branch=z9hG4bk7987fe + +Other SIP header fields and SDP according to 3GPP TS 24.229 [4] and 3GPP TS 29.079 [5]. +``` + +**P-Charging-Vector:** The IC-A1 adds the "transit-ioi" header field parameter with an IOI value identifying the transit network (i.e. "ICa"). + +**Record-Route:** Based on interconnection operator SLA the IC-A1 adds an entry to the Record-Route header field or not. + +**Via:** The IC-A1 adds a Via header field. + +#### 9. INVITE request due to ATU-STI (IBCF-hA1 to SCC AS-hA1 via I-CSCF) - see example in table 5.11.3-9. + +When the IBCF-hA1 receives the INVITE request due to ATU-STI the IBCF-hA1 updates the SDP as described in 3GPP TS 29.079 [5]. + +Since there is no Route header field guiding the IBCF-hA1 where to route the call the IBCF-hA1 selects an I-CSCF in the home network and sends the INVITE request due to ATU-STI to the selected I-CSCF according to 3GPP TS 24.229 [4]. + +In this example, the IBCF-hA1 does not add any "transit-ioi" header field parameter in the P-Charging-Vector header field. However, the IBCF-hA1 adds the "transit-ioi" header field parameter based on local policy, when the "transit-ioi" identifying the preceding interconnection network is not included in the received request (e.g. when the preceding interconnection network is not an IMS transit network). + +The I-CSCF uses PSI routing to route the call and sends the INVITE request due to ATU-STI directly to SCC AS-hA1. + +The table 5.11.3-9 shows the content of the INVITE request due to ATU-STI when received in the SCC AS-hA1. + +**Table 5.11.3-9: INVITE request due to ATU-STI (IBCF-hA1 to SCC AS-hA1 via I-CSCF)** + +``` +INVITE sip:ps2cs@sccs1.home-A.net;iotl=visitedA-homeA SIP/2.0 + +From: +To: +P-Access-Network-Info: +P-Charging-Vector: +``` + +``` + +Target-Dialog: +Require: +Record-Route: ,, +, +P-Asserted-Identity: +Contact: +CSeq: +Accept: +Recv-Info: +Supported: + +Via: SIP/2.0/UDP icscf-hA1.home-A.net;branch=z9hG4bk7e75ca1 +Via: SIP/2.0/UDP ibcf-hA1.home-A.net;branch=z9hG4bk769aff3 +Via: SIP/2.0/UDP ic-A1.interconnection-A.net;branch=z9hG4bk73eb11 +Via: SIP/2.0/UDP ibcf-vA1.visited-A.net;branch=z9hG4bk79c54a +Via: SIP/2.0/UDP atcf-vA1.visited-A.net;branch=z9hG4bk7987fe + +Other SIP header fields and SDP according to 3GPP TS 24.229 [4], 3GPP TS 24.237 [20] and 3GPP TS 29.079 [5]. + +``` + +**Record-Route:** The IBCF-hA1 adds a Record-Route header field. + +**Via:** The IBCF-hA1 adds a Via header field. +The I-CSCF-hA1 adds a Via header field. + +#### 10. INVITE request (SCC AS-hA1 to S-CSCF-hA1) - see example in table 5.11.3-10. + +When the SCC AS-hA1 receives the INVITE request due to ATU-STI the SCC AS-hA1 compares the received SDP with the SDP negotiated in the existing session. The conclusion is that it differs so the SCC AS-hA1 needs to send a re-INVITE request towards the remote UE. + +NOTE 6: The AS can either remove the OMR attributes in the SDP or keep them depending on if the AS supports OMR and local policy. In this example the OMR attributes are removed. + +NOTE 7: When a user is roaming and media is anchored in IBCF the IP addresses will be different in the SDP received in the INVITE request due to ATU-STI compared to those negotiated in the existing session towards the remote UE and that will always result in that a re-INVITE request is needed towards the remote UE. + +**Table 5.11.3-10: INVITE request (SCC AS-hA1 to S-CSCF-hA1)** + +``` + +INVITE sip:[5555::bbb:ccc:ddd:aaa] SIP/2.0 + +From: ;tag=4fa3 +To: ;tag=987651 +CSeq: 1000 INVITE +Route: ,, + +Via: SIP/2.0/UDP sccas-hA1.home-A.net;branch=z9hG4bk3a4f92 + +Other SIP header fields and updated SDP according to 3GPP TS 24.229 [4] and 3GPP TS 24.237 [20]. + +``` + +**Request-URI:** Set to the contact address of the remote UE. + +**From:** Set to the SIP URI that is the default public user identity of the user A i.e. userA\_public1@home-A.net. + +**To:** Set to the public user identity of the remote UE. + +**Via:** The SCC AS-hA1 adds a Via header field. + +#### 11. INVITE request (S-CSCF-hA1 to IBCF-hA2) - see example in table 5.11.3-11. + +The S-CSCF-hA1 forwards the re-INVITE request according to procedures in 3GPP TS 24.229 [4]. + +**Table 5.11.3-11: INVITE request (S-CSCF-hA1 to IBCF-hA2)** + +``` + +INVITE sip:[5555::bbb:ccc:ddd:aaa] SIP/2.0 + +From: +To: + +``` + +``` + +CSeq: +Route: , + +Via: SIP/2.0/UDP scscf-hA1.home-A.net;branch=z9hG4bK354321 +Via: SIP/2.0/UDP sccas-hA1.home-A.net;branch=z9hG4bK3a4f92 + +Other SIP header fields and updated SDP according to 3GPP TS 24.229 [4] and 3GPP TS 24.237 [20]. + +``` + +**Via:** The S-CSCF-hA1 adds a Via header field. + +#### 12-13. 200 (OK) response (IBCF-hA2 to SCC AS-hA1 via S-CSCF-hA1). + +When the IBCF-hA2 receives the 200 (OK) response to the re-INVITE request sent towards the remote UE, the IBCF-hA2 forwards the 200 (OK) response to SCC AS-hA1 according to 3GPP TS 24.229 [4]. The 200 (OK) response does not contain any SRVCC specific information. + +#### 14-15. ACK request (SCC AS-hA1 to IBCF-hA2 via S-CSCF-hA1). + +The SCC AS-hA1 sends the ACK to the IBCF-hA2 according to 3GPP TS 24.229 [4]. The ACK request does not contain any SRVCC specific information. + +#### 16-20. 200 (OK) response (SCC AS-hA1 to ATCF-vA1 via S-CSCF-hA1, IBCF-hA1, IC-A1 and IBCF-vA1) - see example in table 5.11.3-20. + +The SCC AS-hA1 uses the received SDP response and sends a 200 OK response to the INVITE request due to ATU-STI towards the ATCF-vA1. + +The table 5.11.3-20 shows the content of the 200 (OK) response when received in ATCF-vA1. + +**Table 5.11.3-20: 200 (OK) response (IBCF-vA1 to ATCF-vA1)** + +``` + +SIP/2.0 200 OK + +From: ;tag=171828 +To: ;tag=828171 +CSeq: 11 INVITE +Record-Route: ,,, +P-Charging-Vector: icid-value="023551024";orig-ioi="Type 1visited-a";icid-generated-at="msc-vA1.visited-A.net";term-ioi="Type 1home-a";related-icid="AyretyU0dm+6O2IrT5tAFrbHLso=023551024" + +Via: SIP/2.0/UDP atcf-vA1.visited-A.net;branch=z9hG4bk7987fe + +Other SIP header fields and SDP according to 3GPP TS 24.229 [4]. + +``` + +**P-Charging-Vector:** The SCC AS added the P-Charging-Vector with the "icid-value", the "orig-ioi" value and the "icid-generated-at" as received in the INVITE due to ATU-STI. Additionally the SCC AS-hA1 added the "related-icid" header field parameter. The "related-icid" header field parameter contains the "icid-value" header field parameter of the original call and can be used for charging correlation of generated CDR records in the interconnect network A. + +NOTE 8: If the interconnection network is SIP-unaware, step 19 is skipped. + +#### 21-24. ACK request (ATCF-vA1 to SCC AS-hA1 via IBCF-vA1, IC-A1, IBCF-hA1 and S-CSCF-hA1). + +The ATCF-vA1 sends the ACK to the SCC AS-hA1 according to 3GPP TS 24.229 [4]. The ACK request does not contain any SRVCC specific information. + +NOTE 9: If the interconnection network is SIP-unaware, step 22 is skipped. + +### 5.11.4 PS to CS SRVCC access transfer for a call in the active phase with loopback + +This clause describes the PS to CS SRVCC access transfer of a call in the active phase with loopback. + +Preconditions to this call flow: + +1. A call is established between a UE-A and a remote UE as described in clause 5.4. The UE-A is attached to a 4G radio access network (E-UTRAN); + +NOTE 1: The signalling flow is the same for PS to CS SRVCC access transfer for a call in the active phase regardless if the UE-A or the remote UE initiated the call. + +2. The media is anchored in the P-CSCF-vA1, ATCF-vA1 and IBCF-vA1 in the visited network vA); and +3. SIP signalling is anchored in SCC AS-hA1. + +Figure 5.11.4-1 shows the SIP message flow when PS to CS SRVCC access transfer of a call in the active phase occurs. + +![Sequence diagram showing SRVCC with loopback message flow between UE-A, MSC server-vA1, P-CSCF-vA1, ATCF-vA1, IBCF-vA1, TRF, IC-A1, IBCF-hA1/I-CSCF, S-CSCF-hA1, SCC AS-hA1, and IC-T1 across Visited network vA, IC network A, Home network hA, and IC network T. The diagram illustrates the SIP message exchange for SRVCC, including INVITE, 200 OK, ACK, and re-INVITE messages.](7472c67897a35ed6b67fcb47ea4c6b6c_img.jpg) + +The diagram is a sequence diagram titled 'SRVCC with loopback message flow'. It shows the interaction between various network elements across four network domains: Visited network vA, IC network A, Home network hA, and IC network T. The elements involved are: UE-A, MSC server-vA1, P-CSCF-vA1, ATCF-vA1, IBCF-vA1, TRF, IC-A1 (dashed box), IBCF-hA1/I-CSCF, S-CSCF-hA1, SCC AS-hA1, and IC-T1 (dashed box). The sequence starts with a call established between UE-A and a remote UE. The flow then shows the SRVCC process: + 1. INVITE due to STN-SR from MSC server-vA1 to ATCF-vA1. + 2. 200 OK response from ATCF-vA1 to MSC server-vA1. + 3. ACK request from MSC server-vA1 to ATCF-vA1. + 4. INVITE due to ATU-STI from ATCF-vA1 to IBCF-vA1. + 5. INVITE due to ATU-STI from IBCF-vA1 to IC-A1. + 6. INVITE due to ATU-STI from IC-A1 to IBCF-hA1/I-CSCF. + 7. INVITE due to ATU-STI from IBCF-hA1/I-CSCF to S-CSCF-hA1. + 8. INVITE due to ATU-STI from S-CSCF-hA1 to SCC AS-hA1. + 9. re-INVITE from SCC AS-hA1 to S-CSCF-hA1. + 10. re-INVITE from S-CSCF-hA1 to IBCF-hA1/I-CSCF. + 11. re-INVITE from IBCF-hA1/I-CSCF to IC-A1. + 12. re-INVITE from IC-A1 to IBCF-vA1. + 13. re-INVITE from IBCF-vA1 to ATCF-vA1. + 14. re-INVITE from ATCF-vA1 to P-CSCF-vA1. + 15. re-INVITE from P-CSCF-vA1 to MSC server-vA1. + 16. 200 OK from MSC server-vA1 to P-CSCF-vA1. + 17. 200 OK from P-CSCF-vA1 to ATCF-vA1. + 18. 200 OK from ATCF-vA1 to IBCF-vA1. + 19. 200 OK from IBCF-vA1 to IC-A1. + 20. 200 OK from IC-A1 to IBCF-hA1/I-CSCF. + 21. 200 OK from IBCF-hA1/I-CSCF to S-CSCF-hA1. + 22. 200 OK from S-CSCF-hA1 to SCC AS-hA1. + 23. ACK from SCC AS-hA1 to S-CSCF-hA1. + 24. ACK from S-CSCF-hA1 to IBCF-hA1/I-CSCF. + 25. ACK from IBCF-hA1/I-CSCF to IC-A1. + 26. ACK from IC-A1 to IBCF-vA1. + 27. ACK from IBCF-vA1 to ATCF-vA1. + 28. ACK from ATCF-vA1 to P-CSCF-vA1. + 29. ACK from P-CSCF-vA1 to MSC server-vA1. + 30. 200 OK from MSC server-vA1 to P-CSCF-vA1. + 31. 200 OK from P-CSCF-vA1 to ATCF-vA1. + 32. 200 OK from ATCF-vA1 to IBCF-vA1. + 33. 200 OK from IBCF-vA1 to IC-A1. + 34. 200 OK from IC-A1 to IBCF-hA1/I-CSCF. + 35. 200 OK from IBCF-hA1/I-CSCF to S-CSCF-hA1. + 36. 200 OK from S-CSCF-hA1 to SCC AS-hA1. + 37. ACK from SCC AS-hA1 to S-CSCF-hA1. + 38. ACK from S-CSCF-hA1 to IBCF-hA1/I-CSCF. + 39. ACK from IBCF-hA1/I-CSCF to IC-A1. + Media paths are shown at the top and bottom of the diagram, indicating the flow of media between UE-A and the remote UE through the various network elements. + +Sequence diagram showing SRVCC with loopback message flow between UE-A, MSC server-vA1, P-CSCF-vA1, ATCF-vA1, IBCF-vA1, TRF, IC-A1, IBCF-hA1/I-CSCF, S-CSCF-hA1, SCC AS-hA1, and IC-T1 across Visited network vA, IC network A, Home network hA, and IC network T. The diagram illustrates the SIP message exchange for SRVCC, including INVITE, 200 OK, ACK, and re-INVITE messages. + +NOTE: For clarity, the SIP 100 (Trying) messages are not shown in the signalling flow. + +**Figure 5.11.4-1: SRVCC with loopback message flow** + +The steps of the flow are as follows: + +#### **1. A call is established between the UE-A and a remote UE as described in clause 5.4.** + +The remote UE can be a UE connected to IMS or an UE connected to CS and the difference compared to the description in clause 5.4 and this PS to CS SRVCC access transfer scenario is that an ATCF in the visited originated network participated in the call establishment of the call and that the general AS-hA1 in figure 5.4.2-1 is replaced by the access transfer specific SCC AS-hA1. + +The media path is UE-A – P-CSCF-vA1 – ATCF-vA1 – IBCF-vA1 – IC-T1 – terminating network – remote UE. + +#### **2. INVITE request due to STN-SR (MSC server-vA1 to ATCF-vA1).** + +See step 3 in clause 5.11.3. + +#### **3. 200 (OK) response (ATCF-vA1 to MSC server-vA1).** + +See step 4 in clause 5.11.3. + +#### **4. ACK request (MSC server-vA1 to ATCF-vA1).** + +The MSC server acknowledges the receipt of the 200 (OK) response. No SRVCC specific information is added. + +#### **5-8. INVITE request due to ATU-STI (ATCF-vA1 to SCC AS-hA1 via IBCF-vA1, IC-A1, IBCF-hA1/I-CSCF and S-CSCF-hA1).** + +See steps 6-9 in clause 5.11.3. + +NOTE 2: If the interconnection network is SIP-unaware, step 7 is skipped. + +#### **9-15. INVITE request (SCC AS-hA1 to IC-T1 via S-CSCF-hA1, IBCF-hA1, IC-A1, IBCF-vA1, TRF and IBCF-vA1) - see example in table 5.11.4-9.** + +When the SCC AS-hA1 receives the INVITE request due to ATU-STI the SCC AS-hA1 compares the received SDP with the SDP negotiated in the existing session. The conclusion is that it differs so the SCC AS-hA1 needs to send a re-INVITE request towards the remote UE. + +The SCC AS-hA1 handles OMR attributes according to 3GPP TS 24.237 [20] clause 6A.4.4. + +NOTE 3: When a user is roaming and media is anchored in IBCF the IP addresses will be different in the SDP received in the INVITE request due to ATU-STI compared to those negotiated in the existing session towards the remote UE and that will always result in that a re-INVITE request is needed towards the remote UE. + +The table 5.11.4-9 shows the content of the INVITE request when sent by SCC AS-hA1. + +**Table 5.11.4-9: INVITE request (SCC AS-hA1 to IC-T1 via S-CSCF-hA1, IBCF-hA1, IC-A1, IBCF-vA1, TRF and IBCF-vA1)** + +``` +INVITE sip:[5555::bbb:ccc:ddd:aaa] SIP/2.0 + +From: ;tag=171828 +To: ;tag=987651 +CSeq: 111 INVITE +Route: , , + + +Via: SIP/2.0/UDP sccas-hA1.home-A.net;branch=z9hG4bK3a4f92 + +Other SIP header fields and updated SDP according to 3GPP TS 24.229 [4], 3GPP TS 24.237 [20] and +3GPP TS 29.079 [5]. +``` + +**Via:** Via header fields are added by SCC AS-hA1, S-CSCF-hA1, IBCF-hA1, IC-A1, IBCF-vA1, TRF and IBCF-vA1. + +NOTE 4: If the interconnection network is SIP-unaware, step 12 is skipped. + +#### **16-22. 200 (OK) response (IC-T1 to SCC AS-hA1 via IBCF-vA1, TRF, IBCF-vA1, IC-A1, IBCF-hA1 and S-CSCF-hA1).** + +When receiving a 200 (OK) response to the re-INVITE request from the remote UE the IC-T1 returns a 200 (OK) response. No SRVCC specific information is added. + +NOTE 5: If the interconnection network is SIP-unaware, step 20 is skipped. + +#### **23-29. ACK request (SCC AS-hA1 to IC-T1 via S-CSCF-hA1, IBCF-hA1, IC-A1, IBCF-vA1, TRF and IBCF-vA1).** + +The SCC AS-hA1 acknowledges the receipt of the 200 (OK) response. No SRVCC specific information is added. + +NOTE 6: If the interconnection network is SIP-unaware, step 26 is skipped. + +#### **30-34. 200 (OK) response (SCC AS-hA1 to ATCF-vA1 via S-CSCF-hA1, IBCF-hA1, IC-A1 and IBCF-vA1).** + +See steps 16-20 in clause 5.11.3. + +NOTE 7: If the interconnection network is SIP-unaware, step 33 is skipped. + +##### **35-39. ACK request (ATCF-vA1 to SCC AS-hA1 via IBCF-vA1, IC-A1, IBCF-hA1/I-CSCF and S-CSCF-hA1).** + +The ATCF-vA1 acknowledges the receipt of the 200 (OK) response. No SRVCC specific information is added. + +NOTE 8: If the interconnection network is SIP-unaware, step 37 is skipped. + +## 5.12 Invocation and configuration of services during roaming in a visited network + +This case describes how the user within a visited network invokes services via the Ut interface. + +GSMA IR.88 [15] describes that the home operator must provide an APN to be used by the UE for XCAP/Ut. For the UE details see GSMA IR.92 [8]. + +The IMS "well-known" APN must not be used as APN for XCAP/Ut as defined in Section 6.3.2 of GSMA IR.88 [15]. + +In addition GSMA IR.92 [8] describes that for XCAP requests, the UE must be preconfigured or provisioned by the home operator with the APN to be used for XCAP requests. + +**Editor's note: It needs to be clarified and described which correlation between the SIP Call Signalling and the http flows are existing.** + +**Editor's note: It needs to be clarified and described which security mechanisms are used.** + +# Annex A: Change history + +| Change history | | | | | | | | +|----------------|--------|-----------|----------|-----|--------------------------------------------------------------------------------------|-----------------------------------------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 2014-12 | CT#66 | CP-140930 | | | Approved and brought under change control | 2.0.0 | 12.0.0 | +| 2015-03 | CT#67 | CP-150113 | 1 | 1 | Reference update: draft-holmberg-dispatch-iotl | 12.0.0 | 13.0.0 | +| 2015-06 | CT#68 | CP-150349 | 000
3 | - | draft-holmberg-dispatch-iotl-parameter-04 updated to RFC 7549 | 13.0.0 | 13.1.0 | +| 2015-09 | CT#69 | CP-150478 | 000
4 | - | Applying THIG on Path header field | 13.1.0 | 13.2.0 | +| 2015-12 | CT#70 | CP-150651 | 000
6 | -1 | Loopback Indication in Responses | 13.2.0 | 13.3.0 | +| 2015-12 | CT#70 | CP-150651 | 000
7 | -2 | Correction for the format of the Feature-Caps and the Relayed-Charge | 13.2.0 | 13.3.0 | +| 2015-12 | CT#70 | CP-150651 | 001
0 | - | Removal of the P-Charging Vector header field of the SIP 183 response (P-CSCF to UE) | 13.2.0 | 13.3.0 | +| Change history | | | | | | | | +| Date | TSG # | TSG Doc. | CR | Rev | Cat | Subject/Comment | New | +| 2017-03 | CT#75 | | | | | Automatic upgrade from previous Release | 14.0.0 | +| 2018-06 | SA#80 | - | - | - | | Automatic upgrade from previous Release | 15.0.0 | +| 2020-07 | SA#88e | - | - | - | | Update to Rel-16 version (MCC) | 16.0.0 | \ No newline at end of file diff --git a/marked/Rel-16/29_series/29994/raw.md b/marked/Rel-16/29_series/29994/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..1df8431e4445782f9643133f7b85e63b3153f6f6 --- /dev/null +++ b/marked/Rel-16/29_series/29994/raw.md @@ -0,0 +1,844 @@ + + + + + + +# Contents + +| | | +|------------------------------------------------------------------------------------------------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Abbreviations ..... | 6 | +| 4 General ..... | 6 | +| 5 Specific implementation on the radio interface ..... | 6 | +| 5.1 Handovers and "Synchronisation Indication" ..... | 6 | +| 5.1.1 Justification..... | 6 | +| 5.1.2 Solution..... | 6 | +| 5.2 "Directed Retry" type Handovers..... | 7 | +| 5.2.1 Justification..... | 7 | +| 5.2.2 Solution..... | 7 | +| 5.3 Cell broadcast and frequency hopping..... | 7 | +| 5.3.1 Justification..... | 7 | +| 5.3.2 Solution..... | 7 | +| 5.4 Handling of Phase 2 and Phase 2+ BCCH Messages ..... | 8 | +| 5.4.1 Justification..... | 8 | +| 5.4.2 Solution..... | 8 | +| 5.5 Handling of Phase 2 and Phase 2+ SACCH Messages ..... | 8 | +| 5.5.1 Justification..... | 8 | +| 5.5.2 Solution..... | 8 | +| 5.6 Handling of assignment message using Mobile Allocation IE including ARFCN=0 ..... | 8 | +| 5.6.1 Justification..... | 8 | +| 5.6.2 Solution..... | 8 | +| 5.7 Hopping sequence generation including ARFCN=0..... | 9 | +| 5.7.1 Justification..... | 9 | +| 5.7.2 Solution..... | 9 | +| 5.8 QoS IE length between R97 and R99 implementations..... | 9 | +| 5.8.1 Justification..... | 9 | +| 5.8.2 Solution..... | 9 | +| 5.9 MS unable to handle the LOCATION UPDATING ACCEPT, ATTACH ACCEPT and ROUTING AREA UPDATE ACCEPT messages when the EPLMN Lists IE is included..... | 9 | +| 5.9.1 Justification..... | 9 | +| 5.9.2 Solution..... | 10 | +| 5.10 MS unable to handle messages when the truncation function is used ..... | 10 | +| 5.10.1 Justification..... | 10 | +| 5.10.2 Solution..... | 10 | +| 5.11 Roaming restrictions issues with reject cause #13 and #15 ..... | 10 | +| 5.11.1 Justification..... | 10 | +| 5.11.2 Solution..... | 11 | +| 6 Use of VAD/DTX in conjunction with frequency hopping for a speech call..... | 11 | +| 6.1 Scope ..... | 11 | +| 6.2 General ..... | 12 | +| 6.3 Implementation options to reduce the occurrence of undetected bad frames by utilising normal system features ..... | 12 | +| 6.3.1 Number of frequency hopping channels..... | 12 | +| 6.3.2 Frequency hopping type ..... | 12 | +| 6.3.3 Continuous SID frames on C0..... | 13 | +| 6.4 Implementation options to reduce the occurrence of undetected bad frames by changing normal system operation..... | 13 | +| 6.4.1 Changing the training sequence of the dummy burst to a new (ninth) training sequence..... | 13 | +| 6.4.2 Using an alternative training sequence out of the eight assigned..... | 13 | +| 6.4.3 Setting the stealing flag for the bits transmitted which are not intended to be part of the TCH ..... | 13 | +| 6.4.4 Sending partial SID frames on C0..... | 14 | +| 6.5 Tested Combinations..... | 14 | + +| | | | +|-----------------|---------------------------------------------------------------------------------------------------------------------|-----------| +| 6.5.1 | "Normal" system..... | 14 | +| 6.5.2 | New training sequence ..... | 14 | +| 6.5.3 | Alternative training sequence from the eight assigned..... | 14 | +| 6.5.4 | Setting stealing flag for unintentionally transmitted bits ..... | 15 | +| 6.5.5 | Setting stealing flag for unintentionally transmitted bits and modifying training sequence for
Dummy Bursts..... | 15 | +| 6.5.6 | Sending partial SID information on C0..... | 15 | +| Annex A: | Amendment Request 08.08 - 021 R4: Information on channel in use in HO
REQUEST .....
| 17 | +| A.3.1.5.1.1 | Generation of the HANDOVER REQUIRED message..... | 17 | +| A.3.1.5.2 | Handover Resource allocation..... | 18 | +| A.3.1.5.2.1 | Operation of the procedure..... | 18 | +| A.3.2.1.8 | HANDOVER REQUEST ..... | 19 | +| A.3.2.1.9 | HANDOVER REQUIRED..... | 20 | +| A.3.2.2.49 | CURRENT CHANNEL..... | 21 | +| Annex B: | Change History ..... | 23 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 1 Scope + +The present document clarifies recommended measures which may be adopted by 3GPP infrastructure utilising GSM or GERAN as access network to enable inter-working to be obtained between network and various User Equipment (UE) implementations of the 3GPP specification. The objective is to obtain compatibility without changing the consolidated set of specifications. The present document describes the recommended changes to the infrastructure to cater for specific faults within some types of UE. + +The lifetime of the herein described measures together with their potential impact on optimal network performance is out of the scope of the present document. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 04.08 (Phase 1): "Mobile radio interface layer 3 specification Part 1: Generic". +- [3] 3GPP TS 04.08 (Phase 2): "Mobile radio interface layer 3 specification". +- [4] 3GPP TS 04.08 (Phase 2+): "Mobile radio interface layer 3 specification". +- [5] 3GPP TS 05.05 (Phase 2): "Radio Performance Aspects". +- [6] 3GPP TS 05.05 (Phase 2+): "Radio Performance Aspects". +- [7] 3GPP TS 24.007: "Mobile radio interface signalling layer 3 General aspects". + +- [8] 3GPP TS 24.008: "Mobile radio interface layer 3 specification Core Network Protocols-Stage 3". +- [9] 3GPP TS 23.107: "Quality of Service, Concept and Architecture". +- [10] 3GPP TS 44.018: "Mobile radio interface layer 3 specification, Radio Resource Control (RRC) protocol". + +# --- 3 Abbreviations + +Abbreviations used in the present document are listed in 3GPP TR 21.905 [1]. + +# --- 4 General + +In the implementation of the standard it has been found that some aspects of the specifications have been misinterpreted by some MS manufacturers. These MSs require specific implementations of the Phase 1 standard in the infrastructure, to provide completely compatible interworking. + +It has been assumed throughout this TR that Phase 2 and later infrastructure will interwork with Phase 1 MSs in the same way as Phase 1 infrastructure. + +The remainder of this TR describes how to overcome the possible impacts of the above factors. Descriptions given are limited to specific implementations which are permissible for the Phase of the infrastructure. + +# --- 5 Specific implementation on the radio interface + +This clause deals with the choice of specific infrastructure implementation options of the protocols at the radio interface. The protocols concerned are defined in 3GPP TS 04.08 Phase 1 [2], Phase 2 [3] and Phase 2+ [4]. The corresponding protocol definitions for R99 and later releases are in 3GPP TS 24.007 [7] and 3GPP TS 24.008 [8]. + +## 5.1 Handovers and "Synchronisation Indication" + +### 5.1.1 Justification + +In the HANDOVER COMMAND message there is a mandatory part consisting of nine octets followed by several optional information elements. The first optional information element is Synchronisation Indication which is a type 1 Information Element (IE) and as such is coded, with IE Identifier (IEI), on one octet. Other optional IE follow the Synchronisation Indication IE and are used to: + +- indicate the frequency hopping sequence to use on the new channel; +- indicate the channel mode for the new channel; +- indicate a start time. + +Some types of MS do not correctly decode these following information elements if the Synchronisation Indication information element is omitted. + +### 5.1.2 Solution + +To ensure correct operation the infrastructure should always send the Synchronisation Indication IE to a Phase 1 MS. + +NOTE: In a few cases this will force an extra layer 2 segment to be sent to the MS. + +## 5.2 "Directed Retry" type Handovers + +### 5.2.1 Justification + +In the HANDOVER COMMAND message there is an optional Channel Mode Information Element. When this information element is included in the handover command the MS should go to the new channel mode when it hands over to the new channel. This information element may be used for "directed retry" type handovers where a cell has an + +MS on a control channel but has no available traffic channel for the MS to use. The network may then choose to handover the MS to a new cell with traffic channel (TCH) capacity and change the channel mode at the same time. + +Some MSs appear to accept the handover command, from Stand-alone Dedicated Control Channel (SDCCH) to TCH with speech mode, and make the required channel and mode change but do not through connect the speech path. + +### 5.2.2 Solution + +To ensure correct operation, of these MSs, the infrastructure should always initiate a channel mode change procedure according to 3GPP TS 04.08 (Phase 1) [2] clause 3.4.6 once the MS has arrived at the new channel following a handover of a Phase 1 MS involving a channel mode change to full rate speech. + +The additional channel mode change procedure shall only be performed for a directed retry handover to a full rate speech channel, and not for a data channel. First this will save performance in these cases, and secondly some MS's will release the call with this additional and unnecessary channel mode change procedure in case of fax or data calls. + +For internal intra-Base Station System (BSS) handovers, this decision to initiate channel mode modify is taken by the BSS concerned. For external intra-BSS and inter-BSS handovers, the new BSS must know that there has been a change of mode from the previous BSS and that therefore a channel mode change procedure must be executed. The communication of this information is achieved by using the "current channel" element in the HANDOVER REQUEST and HANDOVER REQUIRED message as described in the Annex A. + +In the case of external handover, the following will ensure correct operation with mobiles suffering from fault 5.2.1: + +- i) The change described in Annex A shall be implemented by the MSC and BSS concerned. +- ii) The new BSS, after receiving a HANDOVER REQUEST containing a current channel IE indicating "signalling only", and a channel type indicating full rate speech, shall behave as specified in 3GPP TS 08.08 and additionally, upon reception of the HANDOVER COMPLETE message, initiate a channel mode change procedure according to 3GPP TS 04.08 with the new mode indicating speech. + +If the new BSS receives a HANDOVER REQUEST without the current channel IE but containing a cause value "directed retry", and a channel type indicating full rate speech, it shall also behave as ii) above. + +NOTE: The performance of MSs not experiencing this problem has been checked for a sizeable subset of the MSs available in Phase 1, but it has not been possible to check all versions of all MSs. + +## 5.3 Cell broadcast and frequency hopping + +### 5.3.1 Justification + +In the SYSTEM INFORMATION TYPE 4 message there is an optional Information Element "CBCH Channel Description" used when a cell broadcast channel is configured in the network. + +Some Types of GSM 900 MSs may not obtain service whilst within reception range of a cell from any network having the CBCH configured with frequency hopping: i.e. the Hopping channel bit set to 1 in the "CBCH Channel description" information element. + +### 5.3.2 Solution + +To enable operation from the affected MS, the infrastructure could configure the CBCH on a non hopping channel: + +- In combined type of configuration: the CBCH would be distributed on the SDCCH/4 with BCCH +- In non-combined type of configuration, two types of solution are considered: + - Type 1 CBCH distributed on a non hopping SDCCH broadcasted on TSx of C0 (x=1,2,3) + - Type 2 CBCH distributed on a non hopping SDCCH broadcasted on TS0 of Cx (x≠0) + +## 5.4 Handling of Phase 2 and Phase 2+ BCCH Messages + +### 5.4.1 Justification + +Some types of Phase 1 GSM 900 MSs could fail to offer full services whilst System Information messages other than those specified in GSM 900 Phase 1 are broadcast with a L2-Pseudo Length value greater than 1. + +### 5.4.2 Solution + +In order to provide service to these existing GSM 900 MS and not disturb Phase 2 MS, the following restrictions and changes should be implemented in the P-GSM 900 band of the network. + +For System Information 2ter, the value 0 of the L2 Pseudo Length shall be used instead of 18. + +The System Information 2bis shall not be used in the P-GSM 900 band of the network. + +Therefore, the EXT-IND bit in System Information 2 in the P-GSM 900 Band of the network shall not be set to 1. + +## 5.5 Handling of Phase 2 and Phase 2+ SACCH Messages + +### 5.5.1 Justification + +Some types of Phase 1 MSs may experience performance degradation if the network sends System Information Messages other than those specified in Phase 1. + +### 5.5.2 Solution + +In order not to degrade the performance of these Phase 1 mobile stations it is recommended: + +any new messages that are not defined in Phase 1 shall not be sent to a Phase 1 MS, e.g System Information 5bis and 5ter to a Phase 1 P GSM 900 mobile station and System Information 5ter to a Phase 1 DCS 1800 mobile station. + +## 5.6 Handling of assignment message using Mobile Allocation IE including ARFCN=0 + +### 5.6.1 Justification + +Some type of Phase 2 and Phase 2+ MSs may not access the assigned channel correctly if the network sends an assigning message (Immediate Assignment, Assignment Command or Handover Command) that uses the Mobile Allocation IE to specify an RF hopping channel that includes ARFCN=0 in the hopping sequence. + +### 5.6.2 Solution + +To enable operation of all MSs, the infrastructure can avoid using RF hopping channels that include ARFCN=0 in the hopping sequence. When assigning a channel at RR connection establishment (Immediate Assignment), this solution should be used. + +When a channel resource is assigned, using either the Assignment Command or the Handover Command message, the infrastructure may use the Frequency List or the Frequency Short List IEs in the assigning message to specify an RF hopping channel that includes ARFCN=0 in the hopping sequence. + +## 5.7 Hopping sequence generation including ARFCN=0 + +### 5.7.1 Justification + +Some type of Phase 2 and Phase 2+ MSs may not access the assigned channel correctly if the network assigns an RF hopping channel that includes ARFCN=0 in the hopping sequence. + +### 5.7.2 Solution + +To enable operation of all MSs, the infrastructure can avoid using RF hopping channels that include ARFCN=0 in the hopping sequence. + +## 5.8 QoS IE length between R97 and R99 implementations + +### 5.8.1 Justification + +Quality of Service was initially defined in R97 specifications as a type 4 TLV coded IE but with fixed length of 5 octets. + +Subsequently the length of the IE was extended to maximum 13 octets in R99 and further on to 14 octets in Rel-5. + +Some types of R97 MS do not accept new length for this IE which used to be fixed in R97 reference version. Such MS will diagnose an erroneous mandatory IE and consequently reject the PDU containing the IE and send back SM status with cause #96. + +This means that such a R97 MS can not support GPRS procedures for PDP context activation or PDP context modification in R99 network. + +### 5.8.2 Solution + +To enable operation of all MSs, the infrastructure may adapt the length of the QoS IE it sends to MS according to the served MS by sending only the first 5 QoS octets to pre-R99 GSM mobiles. This can be done either based on the MS Classmark revision level or alternatively the infrastructure may check how many octets were received from the MS in the QoS IE. + +NOTE 1: The mapping between the information in the original R97/98 part of QoS and later extension part is defined in 3GPP TS 23.107. + +NOTE 2: This subclause was added to the present document in 3GPP TSGN #16. + +## 5.9 MS unable to handle the LOCATION UPDATING ACCEPT, ATTACH ACCEPT and ROUTING AREA UPDATE ACCEPT messages when the EPLMN Lists IE is included + +### 5.9.1 Justification + +The concept of EPLMN was initially defined in the R99 specifications and to provide the EPLMN list to an MS a type 4 TLV coded IE was added to the LOCATION UPDATING ACCEPT, ATTACH ACCEPT and ROUTING AREA UPDATE ACCEPT messages. + +Some types of R97/R98 MS are not able to handle these messages when the EPLMN List IE is included. Such MS ignore the messages and continually repeats the registration procedure. Consequently they never successfully register on the network and as a result fail to provide any service to the subscriber. + +This means that such a R97/R98 MS can not provide any service in a network applying the EPLMN functionality. + +### 5.9.2 Solution + +To enable operation of the affected MSs, the infrastructure may adapt the contents of the LOCATION UPDATING ACCEPT, ATTACH ACCEPT and ROUTING AREA UPDATE ACCEPT message it sends to an MS by excluding the EPLMN List IE added in the R99 version of the specifications. This can be done based on the MS Revision Level Indicator. + +NOTE 1: This subclause was added to the present document in 3GPP TSGN #25. + +## 5.10 MS unable to handle messages when the truncation function is used + +### 5.10.1 Justification + +The concept of truncation of rest octet information elements (see 3GPP TS 44.018 [10]) was introduced in the R99 version of specifications and allows the handling of situations when the number of octets in the rest octets information element is not enough to contain the complete set of components. These components can be truncated by the sender, i.e. the infrastructure, to fit into the rest octets information element. The truncation function was added to the PAGING REQUEST TYPE 1, PAGING REQUEST TYPE 2 messages and the SYSTEM INFORMATION TYPE 4 sent on BCCH. When the truncation function is used with the PAGING REQUEST TYPE 1 or PAGING REQUEST TYPE 2 messages, the receiver, i.e. the MS, assumes bits "L" for the missing components (see 3GPP TS 44.018 [10]). + +The MS that implements release version of specifications prior to R99 is not able to handle correctly the messages in which the truncation function is used. Such MS ignores the received message since the message contains mandatory information element with semantically incorrect contents. + +The MS that implements the R99 or onwards version of specifications is able to decode and act on a correctly truncated message. + +However, paging can be used to address more than one MS by means of using a single paging message as specified by 3GPP TS 44.018 [10]. Additionally, the system information impacts all MSes located in a specific area. The MSes addressed can be of different release version of 3GPP specifications. Therefore, it cannot be guaranteed that a message addressing several MSes of different release versions of the 3GPP specifications is handled correctly by all the addressed mobile stations. + +### 5.10.2 Solution + +To enable operation of the affected MS, it is advised that the infrastructure adapts the contents of any message addressing several MSes by means of excluding the use of the truncation function. + +NOTE: This subclause was added to the present document in 3GPP TSG CT #33. + +## 5.11 Roaming restrictions issues with reject cause #13 and #15 + +### 5.11.1 Justification + +Upon reception of a location updating reject cause #13 (Roaming not allowed in this Location Area) or #15 (no suitable cells in this Location Area), the LAI, TMSI, ciphering key sequence number and RAI, P-TMSI, P-TMSI signature and GPRS ciphering key sequence number are not deleted in the MS, as per CR 24.008-521r4 (R99) and the Rel-4 and Rel-5 mirror CRs. + +During an inter-VLR or inter-SGSN location update, the roaming restriction checks that may lead to reject the location updating request with the cause #13 or #15 are normally performed after the HLR update (e.g. ARD and national roaming checks), i.e. the MSC/VLR or SGSN address stored in the HLR is that of the MSC/VLR or SGSN controlling the not allowed location area. + +During an intra-VLR or intra-SGSN location update, the VLR or SGSN sets the 'LA not allowed' or 'RA not allowed' flag when rejecting the location updating request. + +The 3GPP standard was found ambiguous on whether the UE would initiate immediately a new location updating request when it comes back to its previous (allowed) location area, i.e. when it moves to a registration area that has the same identity as the one stored in the MS while being in the ROAMING NOT ALLOWED update state. + +If it does not, mobile terminated calls or mobile terminated PS activity (e.g. SMS) can no longer be delivered to the MS until the next mobile originated activity or periodic location update is initiated. + +A new security context (CKSN/KSI, Kc/CK-IK) may also have been received by the MS during the authentication procedure with the MSC/VLR or SGSN controlling the not allowed location area. If the MS is roaming to a VLR3/LA3 (allowed) after having roamed from the VLR1/LA1 (allowed) to VLR2/LA2 (not allowed), then the MS initiates a location updating request towards the VLR3: + +- with the old TMSI/LA1, which refers to a wrong previous VLR and possibly a wrong VLR1 context (VLR1 receives a Cancel Location when the MS tried to register in VLR2/LA2 and TMSI may have been re-allocated to another UE), leading to a wrong TMSI-IMSI mapping. +- with the KSI/CKSN received from the VLR2 if an authentication was performed by VLR2. If the VLR3 re-uses the current security context (Kc, CKSN)/(KSI, CK, IK) obtained from VLR1, it will not correspond to the security context stored in the UE and ciphering will fail. + +### 5.11.2 Solution + +It was clarified from 3GPP Rel-8 onwards, as per CR 23.122 – 122 (Rel-8), that a MS shall initiate a location updating request if it detects that it has entered a registration area that has the same identity as the one stored in the MS, while being in the ROAMING NOT ALLOWED update state, and the LAI or the PLMN identity is not contained in any of the lists of "forbidden LAs for roaming", "forbidden LAs for regional provision of service", "forbidden PLMNs for GPRS service" or "forbidden PLMNs" respectively. + +To enable normal operation of the affected MSs in the CS domain, the MSC/VLR may allocate a TMSI within the restricted location area before it rejects the location area with the reject cause #13 or #15, as per CR 23.012 – 29 (Rel-8). This forces the mobile station to initiate immediately a new location updating request when moving back to the location area stored in the MS; this also avoids the risk of wrong TMSI-IMSI mapping and ciphering failure. This solution is not applicable to the PS domain since a P-TMSI reallocation procedure is not allowed during a Routing Area Update procedure. + +NOTE: This subclause was added to the present document in 3GPP CT#42. + +# --- 6 Use of VAD/DTX in conjunction with frequency hopping for a speech call + +## 6.1 Scope + +The chapter six of this Technical Report is to identify limitations in the specification for phase 1 reflected in performance degradation in phase 1 terminal equipment. This report identifies possible ways of improving the service offered to subscribers using phase 1 terminals whilst using the two features - downlink DTX and frequency hopping at the same time. + +## 6.2 General + +The specification of acoustic performance of the MS when downlink DTX is implemented is in 3GPP TS 05.05 which restricts the MS performance to 1 undetected bad frame in 10s when in the presence of random RF. In reality the MS does not experience random RF exclusively when downlink DTX is implemented. + +There is a Silence Descriptor (SID) frame sent on eight bursts every 104 bursts. Due to the interleaving scheme, half of the bits of the frame preceding the SID and half of the bits of the frame following the SID are sent and there is no specific requirement covering what is sent for these bits but in most cases it is every other bit of a correctly coded frame. The MS receives these bits + +In addition, when the ARFCN used is C0, dummy bursts are sent when there is neither speech nor signalling to be transmitted. + +Finally, when frequency hopping is used as well as downlink DTX, the MS may receive random RF on some TDMA frames and dummy bursts on others (C0). + +It is possible for the MS to receive combinations of transmitted bits at high confidence and random RF at low confidence. In some cases the MS can then decode the frame as good when in fact it was never intended to have been transmitted and the resultant bad frame can give a very annoying acoustic effect known as banjo noise. The occurrence of these noises, even if no more frequent than one in 10s, is worse than one would expect from a high quality cellular system. + +The three following sections refer to ways of improving the system performance for MS approved according to the existing phase 1 specification. Section 6.3 identifies some "normal" operation configurations which would improve undetected bad frame performance for MS's with the above fault (banjo noise), section 6.4 describes aspects for + +possible changed network implementation, section 6.5 relates the results of tests performed using combinations of the implementations described in section 6.4 and whether that combination was effective or not. + +## 6.3 Implementation options to reduce the occurrence of undetected bad frames by utilising normal system features + +This section deals with a variety of options to improve the system performance which are implementable by normal system operational choices. These options typically improve matters in specific configurations and are not universal solutions for all configurations. It may be possible that some networks do not permit such configuration. + +### 6.3.1 Number of frequency hopping channels + +The number of undetected bad frames is related to the probability of getting sufficient dummy bursts transmitted to make a false good frame decision. The number of dummy bursts received depends on the number of ARFCN in the hopping list. Hence frequency hopping on 3 ARFCN gives better audio performance than frequency hopping on 2, likewise hopping on 4 ARFCN gives better performance than hopping on 3. + +In tests of the comparison between hopping on 2 ARFCN and hopping on 3, some MS have been found to improve to approximately one tenth of the occurrence of bad frames, while others have improved from a slightly annoying level when hopping on 2 ARFCN, to give no audible disruption when hopping on 3. Not all MS have been tested and it is believed that the improvement for some MS may be less noticeable. + +This solution is obviously not trivial to implement in a frequency plan, but could also be used to enable frequency hopping on cells which naturally have 3 or more ARFCN operational whilst selecting a solution for other parts of the network and operational scenarios. + +### 6.3.2 Frequency hopping type + +When utilising pseudo-random frequency hopping, it is possible to get more dummy bursts in a speech frame than when utilising cyclic frequency hopping. As an alternative to random frequency hopping, cyclic hopping may be used. It will minimise the banjo noise effect experienced by the faulty mobiles. This will however be done at the expense of a possible degradation of performance during speech activity period for all mobiles due to the absence of interferer diversity. + +In tests of the comparison between pseudo-random frequency hopping and cyclic frequency hopping, some phones were found to improve with the use of cyclic hopping to approximately one third of the occurrence of bad frames when using pseudo-random hopping, while others have improved from a slightly annoying level to give no audible disruption. Not all phones have been tested for this. + +### 6.3.3 Continuous SID frames on C0 + +At some times, a network implementing downlink DTX may hold a call on C0. In this case it would be possible for the network to send dummy bursts when it has nothing else to send. This is likely to cause a high level of unwanted noises for some MS. An alternative would be to send continuous SID frames in which case there should be no undesired effects. + +## 6.4 Implementation options to reduce the occurrence of undetected bad frames by changing normal system operation + +This section deals with implementation options which improve the audio quality of the faulty mobiles, suffering from banjo noise, by making changes to the network equipment. The solutions give varying performance improvements but not all solutions would be possible on all networks. + +### 6.4.1 Changing the training sequence of the dummy burst to a new (ninth) training sequence + +If a different training sequence code is used for all dummy bursts forming part of the TCH on C0, the MS will have difficulty training to the dummy burst frames and this would cause the bits to be received as low confidence. This would then give a performance rather more like that for random RF input and should then meet the 05.05 requirement. + +### 6.4.2 Using an alternative training sequence out of the eight assigned + +This option is similar in concept and performance to the one described in section 6.4.1. The advantage is that it may be usable in some networks where it is not easily possible to add a ninth training sequence. The following table gives a list of training sequence codes for the TCH and the preferred choice of training sequence code for the dummy burst. + +| Training sequence code for TCH | Training sequence code for dummy bursts on C0 | +|--------------------------------|-----------------------------------------------| +| 0 | 2 | +| 1 | 5 | +| 2 | 0 | +| 3 | 4 | +| 4 | 5 | +| 5 | 2 | +| 6 | 3 | +| 7 | 5 | + +### 6.4.3 Setting the stealing flag for the bits transmitted which are not intended to be part of the TCH + +When bits are transmitted which are not intended for reception in the TCH path, such as dummy bursts and the half burst before and after a discrete, wanted frame, it would be possible to set the stealing flag for these bits and so bias the decision of the majority vote on stealing flags in favour of routing the frame as control information rather than speech information. The channel protection on the control channel is much greater and the chance of getting an undetected bad control channel frame is very low. + +### 6.4.4 Sending partial SID frames on C0 + +It has been observed that improvements in the undetected bad frame rate are seen when the BTS sends partial SID frames on the otherwise unused TCH bursts on C0. This is because the high confidence bits are correctly coded for the relevant speech frame and the normal design of the MS receiver is expected to cope with such errors. This proposal works best for DCS 1800 because very early GSM models are not represented in DCS 1800. + +## 6.5 Tested Combinations + +This section identifies tests that have been performed and the results that have been obtained. The reporting of result is limited to acceptable or not acceptable and a brief additional comment is sometimes made. If the result is deemed to be acceptable, most products which suffer from the described problem have been improved to a point where extraneous noises are significantly reduced to virtually nothing and no product has got worse. No solution completely corrected all products but significant improvements have been achieved if the result is deemed acceptable. + +### 6.5.1 "Normal" system + +#### Test configuration: + +Sent on C0: + +Dummy bursts using training sequence from TCH. + +Stealing flag on C0: + +Set to 0 + +Half burst filling bits: + +Partial SID information from the SID frame otherwise scheduled for transmission. + +Half burst stealing flags: + +Set to 0 + +#### Result: + +Unacceptable; Several products exhibit frequent noises from undetected bad frames. + +### 6.5.2 New training sequence + +#### Test configuration: + +Sent on C0: + +Dummy bursts using new (ninth) training sequence. + +Stealing flag on C0: + +Set to 0 + +Half burst filling bits: + +Partial SID information from the SID frame otherwise scheduled for transmission. + +Half burst stealing flags: + +Set to 0 + +#### Result: + +Acceptable. + +### 6.5.3 Alternative training sequence from the eight assigned + +#### Test configuration: + +Sent on C0: + +Dummy bursts using alternative training sequence according to table in 6.4.2. + +Stealing flag on C0: + +Set to 0 + +Half burst filling bits: + +Partial SID information not necessarily related to the SID frame otherwise scheduled for transmission. + +Half burst stealing flags: + +Set to 0 + +#### Result: + +Acceptable. + +### 6.5.4 Setting stealing flag for unintentionally transmitted bits + +#### Test configuration: + +Sent on C0: + +Partial SID information from the two SID frames otherwise scheduled for transmission. + +Stealing flag on C0: + +Set to 1 + +Half burst filling bits: + +Partial SID information from the SID frame otherwise scheduled for transmission. + +Half burst stealing flags: + +Set to 1 + +#### Result: + +Acceptable. + +### 6.5.5 Setting stealing flag for unintentionally transmitted bits and modifying training sequence for Dummy Bursts + +#### Test configuration: + +Sent on C0: + +Dummy bursts using new (ninth) training sequence. + +Stealing flag on C0: + +Set to 1 + +Half burst filling bits: + +Dummy burst mixed bits + +Half burst stealing flags: + +Set to 1 + +#### **Result:** + +Acceptable; This configuration gave marginally the best performance of all tested. + +### 6.5.6 Sending partial SID information on C0 + +#### **Test configuration:** + +Sent on C0: + +Part SID frames + +Stealing flag on C0: + +Set to 0 + +Half burst filling bits: + +Partial SID information from the SID frame otherwise scheduled for transmission. + +Half burst stealing flags: + +Set to 0 + +#### **Result:** + +Acceptable for DCS 1800. + +# Annex A: + +# Amendment Request 08.08 - 021 R4: Information on channel in use in HO REQUEST + +NOTE: This Annex A reflects the Amendment Request 08.08 - 021 R4 which was approved by SMG#15 and is part of the 3GPP TS 08.08 version 4.9.0. + +##### A.3.1.5.1.1 Generation of the HANDOVER REQUIRED message + +Generation of the HANDOVER REQUIRED message can be for the following reasons: + +- The BSS has detected that a radio reason exists for a handover to occur. +- The MSC has initiated a handover candidate enquiry procedure, and this MS is currently a candidate. +- A cell change is required at call setup due to congestion, e.g. directed retry. + +The HANDOVER REQUIRED message contains the following information elements: + +- Message Type; +- Cause; +- Cell Identifier List (preferred). + +It should also contain the "Current channel" information element. + +Sec. 3.2.1.9. gives coding details of the above message. + +The "Cause" field indicates the reason for the HANDOVER REQUIRED message e.g. "uplink quality poor" or "response to MSC invocation" in the case of traffic reasons indicated by the MSC. + +If present the "Response Request" Information Element indicates, that the BSS requires an indication if the HANDOVER REQUIRED message does not result in a HANDOVER COMMAND message. + +If the BSS wants to change the CIC due to a channel change, the BSS sends a HANDOVER REQUIRED message with the cause "switch circuit pool" and the "circuit pool list" information element. The "circuit pool list" information element will allow the BSS to indicate to the MSC from which circuit pool or pools the new CIC should be chosen. + +The "Cell Identifier List (preferred)" shall identify "n" preferred cells. The identified cells are given in order of preference. The algorithm by which the BSS produces this list is Operator dependent and is not addressed in this Technical Specification. The "n" number of preferred cells is a parameter set by O&M and shall range from 1 to 16. If "n" number of cells cannot be identified, then only as many as are available shall be encoded and sent (as specified in section 3.2.2.27). + +It is mandatory for the BSS to be able to produce this "Cell Identifier List (preferred)". The sending of this list is controlled by the O&M parameter "n". It is mandatory for the MSC to be able to receive and interpret this Information Element. + +The HANDOVER REQUIRED message shall be updated and repeated by the BSS with a periodicity of T7 until: + +- A HANDOVER COMMAND message is received from the MSC, or; +- A RESET message is received, or; +- The reason for the original HANDOVER REQUIRED message disappears e.g. the MS transmission improves, or; +- All communication is lost with the MS as defined in Technical Specification 3GPP TS 04.08, and the transaction is abandoned, or; +- The transaction ends, e.g., call clearing. + +##### A.3.1.5.2 Handover Resource allocation + +This procedure has been defined to allow the MSC to request resources from a BSS in a manner similar to that used for the assignment case. However it does not result in the transmission of any messages over the radio interface, only in the reservation of the resource identified at the BSS, which awaits access of a MS on the reserved channel. These reserved resources are then indicated back to the MSC. + +In order to support this procedure the MSC sets up a BSSAP SCCP connection to the BSS. This connection is then used to support all BSSAP messages related to this dedicated resource. + +##### A.3.1.5.2.1 Operation of the procedure + +The correct operation of the handover resource allocation procedure is as follows: + +The MSC sends a HANDOVER REQUEST message to the new BSS (note 1) from which it requires radio resources. This message contains details of the resource that is required. If the requested resource is for speech or data it also indicates the terrestrial resource that shall be used between the MSC and the BSS. The type of channel required can be different from the type of channel in use, e.g. in the case of directed retry. The description of the resource can either specify it completely, or give the BSS some freedom in the selection. The message may also specify the channel in use. + +On receipt of this message the new BSS shall choose a suitable idle radio resource. + +The management of priority levels - relating to the Information Element "Priority" within the HANDOVER REQUEST message - is implementation dependent, under operator control. + +If queueing is managed, new requests which cannot be served immediately are put in the queueing file according to the indicated priority levels. + +(Refer to section 3.1.17 for Queueing Procedure) + +As a further operator option, the preemption indicators may (alone or along with the priority levels) be used to manage the preemption process, which may lead to the forced release or forced handover of lower priority connections. + +However, the preemption indicators (refer to section 3.2.2.18), if given in the HANDOVER REQUEST, shall be treated on a per connection basis as follows: + +- the last received "Preemption Vulnerability" indicator and priority levels shall prevail. +- if the "Preemption Capability" bit is set to 1, then this allocation request can trigger the running of the preemption procedure. +- if the "Preemption Capability" bit is set to 0, then this allocation request cannot trigger the preemption procedure. +- if the "Preemption Vulnerability" bit is set to 1, then this connection is vulnerable and shall be included in the preemption process or procedure and as such may be subject to forced release or forced handover. +- if the "Preemption Vulnerability" bit is set to 0, then this connection is not vulnerable to preemption and shall not be included in the preemption process and as such may not be subject to forced release or forced handover. +- if no Priority Information Element has been received, both "Preemption Capability" and "Preemption Vulnerability" bits shall be regarded as set to 0. + +If a radio resource is available then this will be reflected back to the MSC in a HANDOVER REQUEST ACKNOWLEDGE message. The HANDOVER REQUEST ACKNOWLEDGE message sent by the new BSS shall contain the radio interface message HANDOVER COMMAND within its "Layer 3 Information" Information Element. This "Layer 3 Information" (which is in fact the RR-Layer 3 HANDOVER COMMAND) is transferred by the controlling MSC to the old BSS using the BSSMAP message HANDOVER COMMAND also within the Information Element "Layer 3 Information" of that BSSMAP message. The old BSS then sends to the MS over the radio interface the RR-Layer 3 HANDOVER COMMAND message. Information about the appropriate new channels and a handover reference number chosen by the new BSS are contained in the HANDOVER COMMAND. Knowledge of the channel in use at the old BSS allows the new BSS to minimize the size of the HANDOVER COMMAND message (i.e. to decide whether the mode of the first channel IE need not be included in the HANDOVER COMMAND). + +NOTE: The new BSS and the old BSS may be the same. + +When several circuit pools are present on the BSS MSC interface, the "circuit pool" information field shall be included in the HANDOVER REQUEST ACKNOWLEDGE. The "circuit pool" field will indicate to the MSC the circuit pool of the CIC given in the HANDOVER REQUEST message. + +The sending of the HANDOVER REQUEST ACKNOWLEDGE by the new BSS to the MSC ends the Handover Resource Allocation procedure. The Handover Execution procedure can now proceed and this is given in section 3.1.5.3. + +The new BSS shall then take all necessary action to allow the MS to access the radio resource that the new BSS has chosen, this is detailed in the 3GPP TS 05 series of Technical Specifications. If the radio resource is a traffic channel then the new BSS shall at this point switch it through to the terrestrial resource indicated in the HANDOVER REQUEST message, and the necessary transcoding/rate adaption/encryption equipment enabled as detailed in 3GPP TS 04.08. + +The optimum procedure for switching through to the target cell at the MSC is not defined in these Technical Specifications. + +#### A.3.2.1.8 HANDOVER REQUEST + +This message is sent from the MSC to the BSS via the relevant SCCP connection to indicate that the MS is to be handed over to that BSS. + +| INFORMATION ELEMENT | REFERENCE | DIRECTION | TYPE | LEN | +|------------------------------|-----------|-----------|------|------| +| Message type | 3.2.2.1 | MSC-BSS | M | 1 | +| Channel type | 3.2.2.11 | MSC-BSS | M | 5 | +| Encryption information | 3.2.2.10 | MSC-BSS | M | 3-n | +| Classmark information 1 or | 3.2.2.30 | MSC-BSS | M# | 2 | +| Classmark information 2 | 3.2.2.19 | MSC-BSS | M# | 4-5 | +| Cell identifier (serving) | 3.2.2.17 | MSC-BSS | M | 5-10 | +| Priority | 3.2.2.18 | MSC-BSS | O | 3 | +| Circuit identity code | 3.2.2.2 | MSC-BSS | O## | 3 | +| Downlink DTX flag | 3.2.2.26 | MSC-BSS | O* | 2 | +| Cell identifier (target) | 3.2.2.17 | MSC-BSS | M | 3-10 | +| Interference band to be used | 3.2.2.21 | MSC-BSS | O | 2 | +| Cause | 3.2.2.5 | MSC-BSS | O | 3-4 | +| Classmark information 3 | 3.2.2.20 | MSC-BSS | O** | 3-14 | +| Current channel | 3.2.2.49 | MSC-BSS | O§ | 2 | + +\* This element may be included in the case of a speech TCH, and only in this case. If not included, this has no impact on the DTX function in the BSS. + +\*\* This element is included if the MSC has received such information. + +# One of these two elements is sent. + +## This element is included when the channel type Information Element indicates speech or data, and only in those cases. + +§ This element is included at least when the message is sent as a reaction to reception of a HANDOVER REQUIRED message containing a "Current channel" information element. In this case it shall be equal to the received element. + +Typical Cause values are: + +uplink quality, +uplink strength, +downlink quality, +downlink strength +distance, +better cell, +response to MSC invocation +O and M intervention, + +directed retry, +switch circuit pool. + +##### A.3.2.1.9 HANDOVER REQUIRED + +This message is sent from the BSS to the MSC to indicate that for a given MS which already has a dedicated radio resource assigned, a handover is required for the reason given by the cause element. + +The message is sent via the BSSAP SCCP connection associated with the dedicated resource. + +| INFORMATION ELEMENT | REFERENCE | DIRECTION | TYPE | LEN | +|----------------------------------|-----------|-----------|------|--------------------| +| Message type | 3.2.2.1 | BSS-MSC | M | 1 | +| Cause | 3.2.2.5 | BSS-MSC | M | 3-4 | +| Response request | 3.2.2.28 | BSS-MSC | O | 1 | +| Cell identifier list (preferred) | 3.2.2.27 | BSS-MSC | M | 2n+3
to
7n+3 | +| Circuit pool list | 3.2.2.46 | BSS-MSC | O* | V | +| Current channel | 3.2.2.49 | BSS-MSC | O** | 2 | + +\* Shall be included when cause "switch circuit pool". + +\*\* This information element should always be included. + +Typical Cause values are: + +uplink quality, +uplink strength, +downlink quality, +downlink strength, +distance, +better cell, +response to MSC invocation, +O&M intervention, +directed retry, +switch circuit pool. + +| Element Identifier Coding | Element name | Reference | +|---------------------------|------------------------------|-----------| +| 0000 0001 | Circuit identity code | 3.2.2.2. | +| 0000 0010 | Reserved | * | +| 0000 0011 | Resource available | 3.2.2.4. | +| 0000 0100 | Cause | 3.2.2.5. | +| 0000 0101 | Cell identifier | 3.2.2.17. | +| 0000 0110 | Priority | 3.2.2.18. | +| 0000 0111 | Layer 3 header information | 3.2.2.9. | +| 0000 1000 | IMSI | 3.2.2.6. | +| 0000 1001 | TMSI | 3.2.2.7. | +| 0000 1010 | Encryption information | 3.2.2.10. | +| 0000 1011 | Channel type | 3.2.2.11. | +| 0000 1100 | Periodicity | 3.2.2.12. | +| 0000 1101 | Extended resource indicator | 3.2.2.13. | +| 0000 1110 | Number of MSs | 3.2.2.8. | +| 0000 1111 | Reserved | * | +| 0001 0000 | Reserved | * | +| 0001 0001 | Reserved | * | +| 0001 0010 | Classmark information type 2 | 3.2.2.19. | +| 0001 0011 | Classmark information type 3 | 3.2.2.20. | +| 0001 0100 | Interference band to be used | 3.2.2.21. | +| 0001 0101 | RR Cause | 3.2.2.22. | +| 0001 0110 | Reserved | * | +| 0001 0111 | Layer 3 information | 3.2.2.24. | +| 0001 1000 | DLCI | 3.2.2.25. | +| 0001 1001 | Downlink DTX flag | 3.2.2.26. | +| 0001 1010 | Cell identifier list | 3.2.2.27. | +| 0001 1011 | Response request | 3.2.2.28. | +| 0001 1100 | Resource indication method | 3.2.2.29. | +| 0001 1101 | Classmark information type 1 | 3.2.2.30. | +| 0001 1110 | Circuit identity code list | 3.2.2.31. | +| 0001 1111 | Diagnostic | 3.2.2.32. | +| 0010 0000 | Layer 3 message contents | 3.2.2.35. | +| 0010 0001 | Chosen channel | 3.2.2.33. | +| 0010 0010 | Total resource accessible | 3.2.2.14. | +| 0010 0011 | Cipher response mode | 3.2.2.34. | +| 0010 0100 | Channel needed | 3.2.2.36. | +| 0010 0101 | Trace type | 3.2.2.37. | +| 0010 0110 | TriggerId | 3.2.2.38. | +| 0010 0111 | Trace reference | 3.2.2.39. | +| 0010 1000 | TransactionId | 3.2.2.40. | +| 0010 1001 | Mobile identity | 3.2.2.41. | +| 0010 1010 | OMCId | 3.2.2.42. | +| 0010 1011 | Forward indicator | 3.2.2.43. | +| 0010 1100 | Chosen encryption algorithm | 3.2.2.44. | +| 0010 1101 | Circuit pool | 3.2.2.45. | +| 0010 1110 | Circuit pool list | 3.2.2.46. | +| 0010 1111 | Time indication | 3.2.2.47. | +| 0011 0000 | Resource situation | 3.2.2.48. | +| 0011 0001 | Current channel | 3.2.2.49. | + +\* Information Element codes marked as "reserved" are reserved for use by previous versions of this interface specification. + +##### A.3.2.2.49 CURRENT CHANNEL + +This Information Element contains a description of the channel allocated to the MS. + +It is coded as follows: + +| | | | | | | | | | +|--------------------|---|---|---|---------|---|---|---|---------| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +| Element identifier | | | | | | | | octet 1 | +| Channel mode | | | | Channel | | | | octet 2 | + +--- + +The channel mode field is coded as follows: + +Bit 8765 + +- 0000 signalling only +- 0001 speech (full rate or half rate) +- 0011 data, 12.0 kbit/s radio interface rate +- 0100 data, 6.0 kbit/s radio interface rate +- 0101 data, 3.6 kbit/s radio interface rate + +All other values are reserved. + +The channel field is coded as follows: + +Bit 4321 + +- 0001 SDCCH +- 1000 Full rate TCH +- 1001 Half rate TCH + +All other values are reserved. + +# Annex B: Change History + +| Change history | | | | | | | | +|----------------|--------|----------------------|------|-----|------------------------------------------------------------------------------------------------------------------------------|--------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 09.94/29.994 | | | | | | | | +| | SMG#15 | | 001 | | Directed retry by external handover | 4.0.0 | 4.0.1 | +| | | | 002 | | Directed retry handover for fax and data | | | +| | SMG#16 | | 003 | | Editorials on chapter 6 | 4.1.0 | 4.2.0 | +| | | | 004 | | Editorials on section 5.2.2 | | | +| | SMG#19 | | A005 | 3 | Guidelines for the support of MSs affected by frequency hopping on CBCH | 4.2.0 | 4.3.0 | +| | | | A006 | 1 | Scope of GSM 09.94 | | | +| | SMG#20 | | | | upgrade to Ph2+ | 4.3.0 | 5.0.0 | +| | SMG#27 | | | | upgrade to Ph2+ R97 | 5.0.0 | 6.0.0 | +| | SMG#30 | | | | withdrawn | 5.0.0 | - | +| | SMG#30 | | | | withdrawn | 6.0.0 | - | +| | SMG#23 | | A007 | 1 | Handling of new phase 2 BCCH and SACCH messages by phase 1 MS | 4.3.0 | 4.4.0 | +| | SMG#30 | | A008 | | Change of Title, Scope and References Clauses 1 to 5) | 4.4.0 | 4.5.0 | +| | | | A009 | | Frequency Hopping using ARFCN=0 | | | +| Jun 2002 | CN#16 | conversion to 29.994 | | | | 09.94 | 29.994 | +| | | NP-020222 | A016 | 2 | QoS IE length | 4.5.0 | 5.0.0 | +| Nov 2002 | | | | | Editorial revision due to changing the title from TS to TR, and to introduce 3GPP were missing in the specification numbers. | 5.0.0 | 5.0.1 | +| Sept 2004 | CN#25 | NP-040386 | A018 | 2 | Incorrect handling, by MS, of registration acceptance messages that include R99 and later IEs | 5.0.1 | 6.0.0 | +| Sept 2006 | CT-33 | CP-060506 | A020 | 2 | Incorrect handling, by the MS, of messages in which truncation is used | 6.0.0 | 7.0.0 | +| Dec 2008 | CT-42 | CP-080873 | 0021 | 2 | Roaming restrictions issues with cause #13 or #15 | 7.0.0 | 8.0.0 | +| Dec 2009 | CT-46 | | | | Upgrade to Rel-9 | 8.0.0 | 9.0.0 | +| Mar 2011 | CT-51 | | | | Upgrade to Rel-10 | 9.0.0 | 10.0.0 | +| Sept 2012 | CT-57 | | | | Upgrade to Rel-11 | 10.0.0 | 11.0.0 | +| Sept 2014 | CT-65 | | | | Upgrade to Rel-12 | 11.0.0 | 12.0.0 | +| Dec 2015 | CT-70 | | | | Upgrade to Rel-13 | 12.0.0 | 13.0.0 | + +| Change history | | | | | | | | +|----------------|---------|------|----|-----|-----|-------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2017-03 | SA#75 | | | | | Upgrade to Rel-14 | 14.0.0 | +| 2018-06 | SA#80 | | | | | Upgrade to Rel-15 | 15.0.0 | +| 2020-06 | SA#88e | | | | | Upgrade to Rel-16 | 16.0.0 | \ No newline at end of file